Doc: Release dates

[libucw.git] / ucw / lib.h

diff --git a/ucw/lib.h b/ucw/lib.h
index f894d2c4271c3de3ff69082d9c4fcc9a6c6b3576..9892d9723e7c5946a1b37cdae81bd1255b01ab2d 100644 (file)
--- a/ucw/lib.h
+++ b/ucw/lib.h
@@ -1,7 +1,7 @@
 /*
  *     The UCW Library -- Miscellaneous Functions
  *
 /*
  *     The UCW Library -- Miscellaneous Functions
  *

- *     (c) 1997--2009 Martin Mares <mj@ucw.cz>
+ *     (c) 1997--2014 Martin Mares <mj@ucw.cz>

  *     (c) 2005 Tomas Valla <tom@ucw.cz>
  *     (c) 2006 Robert Spalek <robert@ucw.cz>
  *     (c) 2007 Pavel Charvat <pchar@ucw.cz>
  *     (c) 2005 Tomas Valla <tom@ucw.cz>
  *     (c) 2006 Robert Spalek <robert@ucw.cz>
  *     (c) 2007 Pavel Charvat <pchar@ucw.cz>


@@ -15,6 +15,38 @@
 
 #include <ucw/config.h>
 #include <stdarg.h>
 
 #include <ucw/config.h>
 #include <stdarg.h>

+#include <stdbool.h>
+
+#ifdef CONFIG_UCW_CLEAN_ABI
+#define assert_failed ucw_assert_failed
+#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 ***/
 
 
 /*** === Macros for handling structures, offsets and alignment ***/
 


@@ -59,6 +91,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 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 **/
 #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 **/


@@ -122,7 +155,7 @@ 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 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_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. **/


@@ -145,8 +178,14 @@ void assert_failed_noinfo(void) NONRET;
 
 #ifdef LOCAL_DEBUG
 #define DBG(x,y...) msg(L_DEBUG, x,##y)        /** If `LOCAL_DEBUG` is defined before including <ucw/lib.h>, log a debug message. Otherwise do nothing. **/
 
 #ifdef LOCAL_DEBUG
 #define DBG(x,y...) msg(L_DEBUG, x,##y)        /** If `LOCAL_DEBUG` is defined before including <ucw/lib.h>, log a debug message. Otherwise do nothing. **/

+/**
+ * If `LOCAL_DEBUG` is defined before including <ucw/lib.h>, 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)
 #else
 #define DBG(x,y...) do { } while(0)

+#define DBG_SPOT do { } while(0)

 #endif
 
 #ifdef DEBUG_ASSERTS
 #endif
 
 #ifdef DEBUG_ASSERTS