Blame ell/util.h

Packit Service 8264ee
/*
Packit Service 8264ee
 *
Packit Service 8264ee
 *  Embedded Linux library
Packit Service 8264ee
 *
Packit Service 8264ee
 *  Copyright (C) 2011-2014  Intel Corporation. All rights reserved.
Packit Service 8264ee
 *
Packit Service 8264ee
 *  This library is free software; you can redistribute it and/or
Packit Service 8264ee
 *  modify it under the terms of the GNU Lesser General Public
Packit Service 8264ee
 *  License as published by the Free Software Foundation; either
Packit Service 8264ee
 *  version 2.1 of the License, or (at your option) any later version.
Packit Service 8264ee
 *
Packit Service 8264ee
 *  This library is distributed in the hope that it will be useful,
Packit Service 8264ee
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service 8264ee
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit Service 8264ee
 *  Lesser General Public License for more details.
Packit Service 8264ee
 *
Packit Service 8264ee
 *  You should have received a copy of the GNU Lesser General Public
Packit Service 8264ee
 *  License along with this library; if not, write to the Free Software
Packit Service 8264ee
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
Packit Service 8264ee
 *
Packit Service 8264ee
 */
Packit Service 8264ee
Packit Service 8264ee
#ifndef __ELL_UTIL_H
Packit Service 8264ee
#define __ELL_UTIL_H
Packit Service 8264ee
Packit Service 8264ee
#include <string.h>
Packit Service 8264ee
#include <stdbool.h>
Packit Service 8264ee
#include <stdarg.h>
Packit Service 8264ee
#include <inttypes.h>
Packit Service 8264ee
#include <endian.h>
Packit Service 8264ee
#include <byteswap.h>
Packit Service 8264ee
#include <sys/uio.h>
Packit Service 8264ee
Packit Service 8264ee
#ifdef __cplusplus
Packit Service 8264ee
extern "C" {
Packit Service 8264ee
#endif
Packit Service 8264ee
Packit Service 8264ee
#define l_container_of(ptr, type, member) ({				\
Packit Service 8264ee
		const __typeof__(((type *) 0)->member) *__mptr = (ptr);	\
Packit Service 8264ee
		(type *)((char *) __mptr - offsetof(type, member));	\
Packit Service 8264ee
	})
Packit Service 8264ee
Packit Service 8264ee
#define likely(x)   __builtin_expect(!!(x), 1)
Packit Service 8264ee
#define unlikely(x) __builtin_expect(!!(x), 0)
Packit Service 8264ee
Packit Service 8264ee
#define L_STRINGIFY(val) L_STRINGIFY_ARG(val)
Packit Service 8264ee
#define L_STRINGIFY_ARG(contents) #contents
Packit Service 8264ee
Packit Service 8264ee
#define L_WARN_ON(condition) __extension__ ({				\
Packit Service 8264ee
		bool r = !!(condition);					\
Packit Service 8264ee
		if (unlikely(r))					\
Packit Service 8264ee
			l_warn("WARNING: %s:%s() condition %s failed",	\
Packit Service 8264ee
				__FILE__, __func__,			\
Packit Service 8264ee
				#condition);				\
Packit Service 8264ee
		unlikely(r);						\
Packit Service 8264ee
	})
Packit Service 8264ee
Packit Service 8264ee
#define L_PTR_TO_UINT(p) ((unsigned int) ((uintptr_t) (p)))
Packit Service 8264ee
#define L_UINT_TO_PTR(u) ((void *) ((uintptr_t) (u)))
Packit Service 8264ee
Packit Service 8264ee
#define L_PTR_TO_INT(p) ((int) ((intptr_t) (p)))
Packit Service 8264ee
#define L_INT_TO_PTR(u) ((void *) ((intptr_t) (u)))
Packit Service 8264ee
Packit Service 8264ee
#define L_GET_UNALIGNED(ptr) __extension__	\
Packit Service 8264ee
({						\
Packit Service 8264ee
	struct __attribute__((packed)) {	\
Packit Service 8264ee
            __typeof__(*(ptr)) __v;		\
Packit Service 8264ee
	} *__p = (__typeof__(__p)) (ptr);	\
Packit Service 8264ee
	__p->__v;				\
Packit Service 8264ee
})
Packit Service 8264ee
Packit Service 8264ee
#define L_PUT_UNALIGNED(val, ptr)		\
Packit Service 8264ee
do {						\
Packit Service 8264ee
	struct __attribute__((packed)) {	\
Packit Service 8264ee
		__typeof__(*(ptr)) __v;		\
Packit Service 8264ee
	} *__p = (__typeof__(__p)) (ptr);	\
Packit Service 8264ee
	__p->__v = (val);			\
Packit Service 8264ee
} while(0)
Packit Service 8264ee
Packit Service 8264ee
#if __BYTE_ORDER == __LITTLE_ENDIAN
Packit Service 8264ee
#define L_LE16_TO_CPU(val) (val)
Packit Service 8264ee
#define L_LE32_TO_CPU(val) (val)
Packit Service 8264ee
#define L_LE64_TO_CPU(val) (val)
Packit Service 8264ee
#define L_CPU_TO_LE16(val) (val)
Packit Service 8264ee
#define L_CPU_TO_LE32(val) (val)
Packit Service 8264ee
#define L_CPU_TO_LE64(val) (val)
Packit Service 8264ee
#define L_BE16_TO_CPU(val) bswap_16(val)
Packit Service 8264ee
#define L_BE32_TO_CPU(val) bswap_32(val)
Packit Service 8264ee
#define L_BE64_TO_CPU(val) bswap_64(val)
Packit Service 8264ee
#define L_CPU_TO_BE16(val) bswap_16(val)
Packit Service 8264ee
#define L_CPU_TO_BE32(val) bswap_32(val)
Packit Service 8264ee
#define L_CPU_TO_BE64(val) bswap_64(val)
Packit Service 8264ee
#elif __BYTE_ORDER == __BIG_ENDIAN
Packit Service 8264ee
#define L_LE16_TO_CPU(val) bswap_16(val)
Packit Service 8264ee
#define L_LE32_TO_CPU(val) bswap_32(val)
Packit Service 8264ee
#define L_LE64_TO_CPU(val) bswap_64(val)
Packit Service 8264ee
#define L_CPU_TO_LE16(val) bswap_16(val)
Packit Service 8264ee
#define L_CPU_TO_LE32(val) bswap_32(val)
Packit Service 8264ee
#define L_CPU_TO_LE64(val) bswap_64(val)
Packit Service 8264ee
#define L_BE16_TO_CPU(val) (val)
Packit Service 8264ee
#define L_BE32_TO_CPU(val) (val)
Packit Service 8264ee
#define L_BE64_TO_CPU(val) (val)
Packit Service 8264ee
#define L_CPU_TO_BE16(val) (val)
Packit Service 8264ee
#define L_CPU_TO_BE32(val) (val)
Packit Service 8264ee
#define L_CPU_TO_BE64(val) (val)
Packit Service 8264ee
#else
Packit Service 8264ee
#error "Unknown byte order"
Packit Service 8264ee
#endif
Packit Service 8264ee
Packit Service 8264ee
#if __STDC_VERSION__ <= 199409L
Packit Service 8264ee
#define inline __inline__
Packit Service 8264ee
#endif
Packit Service 8264ee
Packit Service 8264ee
static inline uint8_t l_get_u8(const void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	return *((const uint8_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline void l_put_u8(uint8_t val, void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	*((uint8_t *) ptr) = val;
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline uint16_t l_get_u16(const void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	return L_GET_UNALIGNED((const uint16_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline void l_put_u16(uint16_t val, void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	L_PUT_UNALIGNED(val, (uint16_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline uint32_t l_get_u32(const void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	return L_GET_UNALIGNED((const uint32_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline void l_put_u32(uint32_t val, void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	L_PUT_UNALIGNED(val, (uint32_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline uint64_t l_get_u64(const void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	return L_GET_UNALIGNED((const uint64_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline void l_put_u64(uint64_t val, void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	L_PUT_UNALIGNED(val, (uint64_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline int16_t l_get_s16(const void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	return L_GET_UNALIGNED((const int16_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline int32_t l_get_s32(const void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	return L_GET_UNALIGNED((const int32_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline int64_t l_get_s64(const void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	return L_GET_UNALIGNED((const int64_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline uint16_t l_get_le16(const void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	return L_LE16_TO_CPU(L_GET_UNALIGNED((const uint16_t *) ptr));
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline uint16_t l_get_be16(const void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	return L_BE16_TO_CPU(L_GET_UNALIGNED((const uint16_t *) ptr));
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline uint32_t l_get_le32(const void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	return L_LE32_TO_CPU(L_GET_UNALIGNED((const uint32_t *) ptr));
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline uint32_t l_get_be32(const void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	return L_BE32_TO_CPU(L_GET_UNALIGNED((const uint32_t *) ptr));
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline uint64_t l_get_le64(const void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	return L_LE64_TO_CPU(L_GET_UNALIGNED((const uint64_t *) ptr));
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline uint64_t l_get_be64(const void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	return L_BE64_TO_CPU(L_GET_UNALIGNED((const uint64_t *) ptr));
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline void l_put_le16(uint16_t val, void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	L_PUT_UNALIGNED(L_CPU_TO_LE16(val), (uint16_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline void l_put_be16(uint16_t val, const void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	L_PUT_UNALIGNED(L_CPU_TO_BE16(val), (uint16_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline void l_put_le32(uint32_t val, void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	L_PUT_UNALIGNED(L_CPU_TO_LE32(val), (uint32_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline void l_put_be32(uint32_t val, void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	L_PUT_UNALIGNED(L_CPU_TO_BE32(val), (uint32_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline void l_put_le64(uint64_t val, void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	L_PUT_UNALIGNED(L_CPU_TO_LE64(val), (uint64_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline void l_put_be64(uint64_t val, void *ptr)
Packit Service 8264ee
{
Packit Service 8264ee
	L_PUT_UNALIGNED(L_CPU_TO_BE64(val), (uint64_t *) ptr);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
#define L_AUTO_CLEANUP_VAR(vartype,varname,destroy) \
Packit Service 8264ee
	vartype varname __attribute__((cleanup(destroy)))
Packit Service 8264ee
Packit Service 8264ee
#define L_AUTO_FREE_VAR(vartype,varname) \
Packit Service 8264ee
	vartype varname __attribute__((cleanup(auto_free)))
Packit Service 8264ee
Packit Service 8264ee
#define L_ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
Packit Service 8264ee
Packit Service 8264ee
void *l_malloc(size_t size) __attribute__ ((warn_unused_result, malloc));
Packit Service 8264ee
void *l_memdup(const void *mem, size_t size)
Packit Service 8264ee
			__attribute__ ((warn_unused_result, malloc));
Packit Service 8264ee
void l_free(void *ptr);
Packit Service 8264ee
Packit Service 8264ee
void *l_realloc(void *mem, size_t size)
Packit Service 8264ee
			__attribute__ ((warn_unused_result, malloc));
Packit Service 8264ee
Packit Service 8264ee
static inline void auto_free(void *a)
Packit Service 8264ee
{
Packit Service 8264ee
	void **p = (void **)a;
Packit Service 8264ee
	l_free(*p);
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
static inline size_t minsize(size_t a, size_t b)
Packit Service 8264ee
{
Packit Service 8264ee
	if (a <= b)
Packit Service 8264ee
		return a;
Packit Service 8264ee
Packit Service 8264ee
	return b;
Packit Service 8264ee
}
Packit Service 8264ee
Packit Service 8264ee
/**
Packit Service 8264ee
 * l_new:
Packit Service 8264ee
 * @type: type of structure
Packit Service 8264ee
 * @count: amount of structures
Packit Service 8264ee
 *
Packit Service 8264ee
 * Returns: pointer to allocated memory
Packit Service 8264ee
 **/
Packit Service 8264ee
#define l_new(type, count)			\
Packit Service 8264ee
	(type *) (__extension__ ({		\
Packit Service 8264ee
		size_t __n = (size_t) (count);	\
Packit Service 8264ee
		size_t __s = sizeof(type);	\
Packit Service 8264ee
		void *__p;			\
Packit Service 8264ee
		__p = l_malloc(__n * __s);	\
Packit Service 8264ee
		memset(__p, 0, __n * __s);	\
Packit Service 8264ee
		__p;				\
Packit Service 8264ee
	}))
Packit Service 8264ee
Packit Service 8264ee
char *l_strdup(const char *str);
Packit Service 8264ee
char *l_strndup(const char *str, size_t max);
Packit Service 8264ee
char *l_strdup_printf(const char *format, ...)
Packit Service 8264ee
			__attribute__((format(printf, 1, 2)));
Packit Service 8264ee
char *l_strdup_vprintf(const char *format, va_list args);
Packit Service 8264ee
Packit Service 8264ee
size_t l_strlcpy(char* dst, const char *src, size_t len);
Packit Service 8264ee
Packit Service 8264ee
bool l_str_has_prefix(const char *str, const char *prefix);
Packit Service 8264ee
bool l_str_has_suffix(const char *str, const char *suffix);
Packit Service 8264ee
Packit Service 8264ee
char *l_util_hexstring(const unsigned char *buf, size_t len);
Packit Service 8264ee
char *l_util_hexstring_upper(const unsigned char *buf, size_t len);
Packit Service 8264ee
unsigned char *l_util_from_hexstring(const char *str, size_t *out_len);
Packit Service 8264ee
Packit Service 8264ee
typedef void (*l_util_hexdump_func_t) (const char *str, void *user_data);
Packit Service 8264ee
Packit Service 8264ee
void l_util_hexdump(bool in, const void *buf, size_t len,
Packit Service 8264ee
			l_util_hexdump_func_t function, void *user_data);
Packit Service 8264ee
void l_util_hexdump_two(bool in, const void *buf1, size_t len1,
Packit Service 8264ee
			const void *buf2, size_t len2,
Packit Service 8264ee
			l_util_hexdump_func_t function, void *user_data);
Packit Service 8264ee
void l_util_hexdumpv(bool in, const struct iovec *iov, size_t n_iov,
Packit Service 8264ee
					l_util_hexdump_func_t function,
Packit Service 8264ee
					void *user_data);
Packit Service 8264ee
void l_util_debug(l_util_hexdump_func_t function, void *user_data,
Packit Service 8264ee
						const char *format, ...)
Packit Service 8264ee
			__attribute__((format(printf, 3, 4)));
Packit Service 8264ee
Packit Service 8264ee
const char *l_util_get_debugfs_path(void);
Packit Service 8264ee
Packit Service 8264ee
#define L_TFR(expression)                          \
Packit Service 8264ee
  (__extension__                                   \
Packit Service 8264ee
    ({ long int __result;                          \
Packit Service 8264ee
       do __result = (long int) (expression);      \
Packit Service 8264ee
       while (__result == -1L && errno == EINTR);  \
Packit Service 8264ee
       __result; }))
Packit Service 8264ee
Packit Service 8264ee
#ifdef __cplusplus
Packit Service 8264ee
}
Packit Service 8264ee
#endif
Packit Service 8264ee
Packit Service 8264ee
#endif /* __ELL_UTIL_H */