X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=ucw%2Flib.h;h=dffccba4a876a1dc2e244d3db185d3d2f9fe798e;hb=f1155256f7a168f5e2c0097cb4e7197b79c4f041;hp=f894d2c4271c3de3ff69082d9c4fcc9a6c6b3576;hpb=69cdec0eb3eff9fcafaacb4b06e43519dfe3a1fb;p=libucw.git diff --git a/ucw/lib.h b/ucw/lib.h index f894d2c4..dffccba4 100644 --- a/ucw/lib.h +++ b/ucw/lib.h @@ -1,8 +1,8 @@ /* * The UCW Library -- Miscellaneous Functions * - * (c) 1997--2009 Martin Mares - * (c) 2005 Tomas Valla + * (c) 1997--2014 Martin Mares + * (c) 2005--2014 Tomas Valla * (c) 2006 Robert Spalek * (c) 2007 Pavel Charvat * @@ -15,12 +15,45 @@ #include #include +#include + +#ifdef CONFIG_UCW_CLEAN_ABI +#define assert_failed ucw_assert_failed +#define assert_failed_msg ucw_assert_failed_msg +#define assert_failed_noinfo ucw_assert_failed_noinfo +#define big_alloc ucw_big_alloc +#define big_alloc_zero ucw_big_alloc_zero +#define big_free ucw_big_free +#define die ucw_die +#define log_die_hook ucw_log_die_hook +#define log_file ucw_log_file +#define log_fork ucw_log_fork +#define log_init ucw_log_init +#define log_pid ucw_log_pid +#define log_title ucw_log_title +#define msg ucw_msg +#define page_alloc ucw_page_alloc +#define page_alloc_zero ucw_page_alloc_zero +#define page_free ucw_page_free +#define page_realloc ucw_page_realloc +#define random_max ucw_random_max +#define random_max_u64 ucw_random_max_u64 +#define random_u32 ucw_random_u32 +#define random_u64 ucw_random_u64 +#define vdie ucw_vdie +#define vmsg ucw_vmsg +#define xfree ucw_xfree +#define xmalloc ucw_xmalloc +#define xmalloc_zero ucw_xmalloc_zero +#define xrealloc ucw_xrealloc +#define xstrdup ucw_xstrdup +#endif /*** === Macros for handling structures, offsets and alignment ***/ #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 OFFSETOF(s, i) ((uint)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) **/ @@ -48,8 +81,8 @@ #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 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 **/ +#define ROL(x, bits) (((x) << (bits)) | ((uint)(x) >> (sizeof(uint)*8 - (bits)))) /** Bitwise rotation of an unsigned int to the left **/ +#define ROR(x, bits) (((uint)(x) >> (bits)) | ((x) << (sizeof(uint)*8 - (bits)))) /** Bitwise rotation of an unsigned int to the right **/ /*** === Shortcuts for GCC Extensions ***/ @@ -59,6 +92,7 @@ #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 CONSTRUCTOR_WITH_PRIORITY(p) __attribute__((constructor(p))) /** Define constructor with a given priority **/ #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 **/ @@ -115,20 +149,21 @@ enum log_levels { /** The available log levels to pass to msg() and friends. * * 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`). **/ -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 msg(uint flags, const char *fmt, ...) FORMAT_CHECK(printf,2,3); +void vmsg(uint 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. **/ -extern void (*log_die_hook)(void); /** An optional function called just before die() exists. **/ +extern void (*log_die_hook)(void); /** An optional function called just before die() exists. **/ // API: log_die_hook void log_init(const char *argv0); /** Set @log_title to the program name extracted from @argv[0]. **/ void log_fork(void); /** Call after fork() to update @log_pid. **/ void log_file(const char *name); /** Establish logging to the named file. Also redirect stderr there. **/ void assert_failed(const char *assertion, const char *file, int line) NONRET; +void assert_failed_msg(const char *assertion, const char *file, int line, const char *fmt, ...) NONRET FORMAT_CHECK(printf,4,5); void assert_failed_noinfo(void) NONRET; #ifdef DEBUG_ASSERTS @@ -137,16 +172,31 @@ void assert_failed_noinfo(void) NONRET; * Assertion checks are compiled only when `DEBUG_ASSERTS` is defined. **/ #define ASSERT(x) ({ if (unlikely(!(x))) assert_failed(#x, __FILE__, __LINE__); 1; }) + +/** + * Check an assertion with a debug message. If the condition @cond is false, + * print the message and stop the program with fatal error. + * Assertion checks are compiled only when `DEBUG_ASSERTS` is defined. + **/ +#define ASSERT_MSG(cond,str,x...) ({ if (unlikely(!(cond))) assert_failed_msg(#cond, __FILE__, __LINE__, str,##x); 1; }) + #else #define ASSERT(x) ({ if (__builtin_constant_p(x) && !(x)) assert_failed_noinfo(); 1; }) +#define ASSERT_MSG(cond,str,x...) ASSERT(cond) #endif #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. **/ +/** + * If `LOCAL_DEBUG` is defined before including , log current + * file name and line number. Otherwise do nothing. + **/ +#define DBG_SPOT msg(L_DEBUG, "%s:%d (%s)", __FILE__, __LINE__, __func__) #else #define DBG(x,y...) do { } while(0) +#define DBG_SPOT do { } while(0) #endif #ifdef DEBUG_ASSERTS @@ -194,8 +244,8 @@ void big_free(void *start, u64 len); /** Free block allocated by @big_alloc() o /*** === Random numbers (random.c) ***/ -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). **/ +uint random_u32(void); /** Return a pseudorandom 32-bit number. **/ +uint random_max(uint 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). **/