X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=ucw%2Flib.h;h=f114dbe978587e6036ad96f11cf32c677a8251bd;hb=0f88062c8973258611a8cba9a0e9668d1c688030;hp=c063e01658e3ccd377bb8549bb3eb32dc9cc2370;hpb=1a3bce799001b4fe9cdc77df5d5126fcf6e14072;p=libucw.git diff --git a/ucw/lib.h b/ucw/lib.h index c063e016..f114dbe9 100644 --- a/ucw/lib.h +++ b/ucw/lib.h @@ -1,7 +1,7 @@ /* * The UCW Library -- Miscellaneous Functions * - * (c) 1997--2008 Martin Mares + * (c) 1997--2009 Martin Mares * (c) 2005 Tomas Valla * (c) 2006 Robert Spalek * (c) 2007 Pavel Charvat @@ -16,61 +16,66 @@ #include "ucw/config.h" #include -/* Macros for handling structurues, offsets and alignment */ +/*** === Macros for handling structures, offsets and alignment ***/ -#define CHECK_PTR_TYPE(x, type) ((x)-(type)(x) + (type)(x)) -#define PTR_TO(s, i) &((s*)0)->i -#define OFFSETOF(s, i) ((unsigned int) (uintptr_t) PTR_TO(s, i)) -#define SKIP_BACK(s, i, p) ((s *)((char *)p - OFFSETOF(s, i))) +#define CHECK_PTR_TYPE(x, type) ((x)-(type)(x) + (type)(x)) /** Check that a pointer @x is of type @type. Fail compilation if not. **/ +#define PTR_TO(s, i) &((s*)0)->i /** Return OFFSETOF() in form of a pointer. **/ +#define OFFSETOF(s, i) ((uns)offsetof(s, i)) /** Offset of item @i from the start of structure @s **/ +#define SKIP_BACK(s, i, p) ((s *)((char *)p - OFFSETOF(s, i))) /** Given a pointer @p to item @i of structure @s, return a pointer to the start of the struct. **/ + +/** Align an integer @s to the nearest higher multiple of @a (which should be a power of two) **/ #define ALIGN_TO(s, a) (((s)+a-1)&~(a-1)) + +/** Align a pointer @p to the nearest higher multiple of @s. **/ #define ALIGN_PTR(p, s) ((uintptr_t)(p) % (s) ? (typeof(p))((uintptr_t)(p) + (s) - (uintptr_t)(p) % (s)) : (p)) + #define UNALIGNED_PART(ptr, type) (((uintptr_t) (ptr)) % sizeof(type)) -/* Some other macros */ +/*** === Other utility macros ***/ -#define MIN(a,b) (((a)<(b))?(a):(b)) -#define MAX(a,b) (((a)>(b))?(a):(b)) -#define CLAMP(x,min,max) ({ int _t=x; (_t < min) ? min : (_t > max) ? max : _t; }) -#define ABS(x) ((x) < 0 ? -(x) : (x)) -#define ARRAY_SIZE(a) (sizeof(a)/sizeof(*(a))) -#define STRINGIFY(x) #x -#define STRINGIFY_EXPANDED(x) STRINGIFY(x) -#define GLUE(x,y) x##y -#define GLUE_(x,y) x##_##y +#define MIN(a,b) (((a)<(b))?(a):(b)) /** Minimum of two numbers **/ +#define MAX(a,b) (((a)>(b))?(a):(b)) /** Maximum of two numbers **/ +#define CLAMP(x,min,max) ({ int _t=x; (_t < min) ? min : (_t > max) ? max : _t; }) /** Clip a number @x to interval [@min,@max] **/ +#define ABS(x) ((x) < 0 ? -(x) : (x)) /** Absolute value **/ +#define ARRAY_SIZE(a) (sizeof(a)/sizeof(*(a))) /** The number of elements of an array **/ +#define STRINGIFY(x) #x /** Convert macro parameter to a string **/ +#define STRINGIFY_EXPANDED(x) STRINGIFY(x) /** Convert an expanded macro parameter to a string **/ +#define GLUE(x,y) x##y /** Glue two tokens together **/ +#define GLUE_(x,y) x##_##y /** Glue two tokens together, separating them by an underscore **/ -#define COMPARE(x,y) do { if ((x)<(y)) return -1; if ((x)>(y)) return 1; } while(0) -#define REV_COMPARE(x,y) COMPARE(y,x) +#define COMPARE(x,y) do { if ((x)<(y)) return -1; if ((x)>(y)) return 1; } while(0) /** Numeric comparison function for qsort() **/ +#define REV_COMPARE(x,y) COMPARE(y,x) /** Reverse numeric comparison **/ #define COMPARE_LT(x,y) do { if ((x)<(y)) return 1; if ((x)>(y)) return 0; } while(0) #define COMPARE_GT(x,y) COMPARE_LT(y,x) -#define ROL(x, bits) (((x) << (bits)) | ((uns)(x) >> (sizeof(uns)*8 - (bits)))) /* Bitwise rotation of an uns to the left */ -#define ROR(x, bits) (((uns)(x) >> (bits)) | ((x) << (sizeof(uns)*8 - (bits)))) +#define ROL(x, bits) (((x) << (bits)) | ((uns)(x) >> (sizeof(uns)*8 - (bits)))) /** Bitwise rotation of an unsigned int to the left **/ +#define ROR(x, bits) (((uns)(x) >> (bits)) | ((x) << (sizeof(uns)*8 - (bits)))) /** Bitwise rotation of an unsigned int to the right **/ -/* GCC Extensions */ +/*** === Shortcuts for GCC Extensions ***/ #ifdef __GNUC__ #undef inline -#define NONRET __attribute__((noreturn)) -#define UNUSED __attribute__((unused)) -#define CONSTRUCTOR __attribute__((constructor)) -#define PACKED __attribute__((packed)) -#define CONST __attribute__((const)) -#define PURE __attribute__((pure)) -#define FORMAT_CHECK(x,y,z) __attribute__((format(x,y,z))) -#define likely(x) __builtin_expect((x),1) -#define unlikely(x) __builtin_expect((x),0) +#define NONRET __attribute__((noreturn)) /** Function does not return **/ +#define UNUSED __attribute__((unused)) /** Variable/parameter is knowingly unused **/ +#define CONSTRUCTOR __attribute__((constructor)) /** Call function upon start of program **/ +#define PACKED __attribute__((packed)) /** Structure should be packed **/ +#define CONST __attribute__((const)) /** Function depends only on arguments **/ +#define PURE __attribute__((pure)) /** Function depends only on arguments and global vars **/ +#define FORMAT_CHECK(x,y,z) __attribute__((format(x,y,z))) /** Checking of printf-like format strings **/ +#define likely(x) __builtin_expect((x),1) /** Use `if (likely(@x))` if @x is almost always true **/ +#define unlikely(x) __builtin_expect((x),0) /** Use `if (unlikely(@x))` to hint that @x is almost always false **/ #if __GNUC__ >= 4 || __GNUC__ == 3 && __GNUC_MINOR__ >= 3 -#define ALWAYS_INLINE inline __attribute__((always_inline)) -#define NO_INLINE __attribute__((noinline)) +#define ALWAYS_INLINE inline __attribute__((always_inline)) /** Forcibly inline **/ +#define NO_INLINE __attribute__((noinline)) /** Forcibly uninline **/ #else #define ALWAYS_INLINE inline #endif #if __GNUC__ >= 4 -#define LIKE_MALLOC __attribute__((malloc)) -#define SENTINEL_CHECK __attribute__((sentinel)) +#define LIKE_MALLOC __attribute__((malloc)) /** Function returns a "new" pointer **/ +#define SENTINEL_CHECK __attribute__((sentinel)) /** The last argument must be NULL **/ #else #define LIKE_MALLOC #define SENTINEL_CHECK @@ -95,17 +100,25 @@ enum log_levels { /** The available log levels to pass to msg() and friends. * L_WARN_R, // 'w' (e.g., a packet received via network) L_ERROR_R, // 'e' L_FATAL, // '!' - Fatal error + L_MAX }; -#define L_SIGHANDLER 0x80000000 /** Avoid operations that are unsafe in signal handlers **/ +#define LOG_LEVEL_NAMES P(DEBUG) P(INFO) P(WARN) P(ERROR) P(INFO_R) P(WARN_R) P(ERROR_R) P(FATAL) + +// Return the letter associated with a given severity level +#define LS_LEVEL_LETTER(level) ("DIWEiwe!###"[( level )]) + +#define L_SIGHANDLER 0x80000000 /** Avoid operations that are unsafe in signal handlers **/ +#define L_LOGGER_ERR 0x40000000 /** Used internally to avoid infinite reporting of logging errors **/ /** * This is the basic printf-like function for logging a message. - * The @flags contain the log level and possibly other flag bits (like @L_SIGHANDLER). + * The @flags contain the log level and possibly other flag bits (like `L_SIGHANDLER`). **/ void msg(uns flags, const char *fmt, ...) FORMAT_CHECK(printf,2,3); void vmsg(uns flags, const char *fmt, va_list args); /** A vararg version of msg(). **/ void die(const char *, ...) NONRET FORMAT_CHECK(printf,1,2); /** Log a fatal error message and exit the program. **/ +void vdie(const char *fmt, va_list args) NONRET; /** va_list version of die() **/ extern char *log_title; /** An optional log message title. Set to program name by log_init(). **/ extern int log_pid; /** An optional PID printed in each log message. Set to 0 if it shouldn't be logged. **/ @@ -121,7 +134,7 @@ void assert_failed_noinfo(void) NONRET; #ifdef DEBUG_ASSERTS /** * Check an assertion. If the condition @x is false, stop the program with a fatal error. - * These checks are compiled only when @DEBUG_ASSERTS is defined. + * Assertion checks are compiled only when `DEBUG_ASSERTS` is defined. **/ #define ASSERT(x) ({ if (unlikely(!(x))) assert_failed(#x, __FILE__, __LINE__); 1; }) #else @@ -131,43 +144,43 @@ void assert_failed_noinfo(void) NONRET; #define COMPILE_ASSERT(name,x) typedef char _COMPILE_ASSERT_##name[!!(x)-1] #ifdef LOCAL_DEBUG -#define DBG(x,y...) msg(L_DEBUG, x,##y) /** If @LOCAL_DEBUG is defined before including , log a debug message. Otherwise do nothing. **/ +#define DBG(x,y...) msg(L_DEBUG, x,##y) /** If `LOCAL_DEBUG` is defined before including , log a debug message. Otherwise do nothing. **/ #else #define DBG(x,y...) do { } while(0) #endif -/* Memory allocation */ - -#define xmalloc ucw_xmalloc -#define xrealloc ucw_xrealloc -#define xfree ucw_xfree +/*** === Memory allocation ***/ /* * Unfortunately, several libraries we might want to link to define * their own xmalloc and we don't want to interfere with them, hence * the renaming. */ -void *xmalloc(uns) LIKE_MALLOC; -void *xrealloc(void *, uns); -void xfree(void *); +#define xmalloc ucw_xmalloc +#define xrealloc ucw_xrealloc +#define xfree ucw_xfree + +void *xmalloc(size_t) LIKE_MALLOC; /** Allocate memory and die() if there is none. **/ +void *xrealloc(void *, size_t); /** Reallocate memory and die() if there is none. **/ +void xfree(void *); /** Free memory allocated by xmalloc() or xrealloc(). **/ -void *xmalloc_zero(uns) LIKE_MALLOC; -char *xstrdup(const char *) LIKE_MALLOC; +void *xmalloc_zero(size_t) LIKE_MALLOC; /** Allocate memory and fill it by zeroes. **/ +char *xstrdup(const char *) LIKE_MALLOC; /** Make a xmalloc()'ed copy of a string. Returns NULL for NULL string. **/ -/* timer.c */ +/*** === Trivial timers (timer.c) ***/ -timestamp_t get_timestamp(void); +timestamp_t get_timestamp(void); /** Get current time as a millisecond timestamp. **/ -void init_timer(timestamp_t *timer); -uns get_timer(timestamp_t *timer); -uns switch_timer(timestamp_t *oldt, timestamp_t *newt); +void init_timer(timestamp_t *timer); /** Initialize a timer. **/ +uns get_timer(timestamp_t *timer); /** Get the number of milliseconds since last init/get of a timer. **/ +uns switch_timer(timestamp_t *oldt, timestamp_t *newt); /** Stop ticking of one timer and resume another. **/ -/* random.c */ +/*** === Random numbers (random.c) ***/ -uns random_u32(void); -uns random_max(uns max); -u64 random_u64(void); -u64 random_max_u64(u64 max); +uns random_u32(void); /** Return a pseudorandom 32-bit number. **/ +uns random_max(uns max); /** Return a pseudorandom 32-bit number in range [0,@max). **/ +u64 random_u64(void); /** Return a pseudorandom 64-bit number. **/ +u64 random_max_u64(u64 max); /** Return a pseudorandom 64-bit number in range [0,@max). **/ /* mmap.c */