Opt: Documented opt and its interaction with conf

[libucw.git] / ucw / lib.h

diff --git a/ucw/lib.h b/ucw/lib.h
index ebb6d32a86868fdbc157e0e54dcac935c06c6f5e..302f19ed447ae2c7b3dac37c3dda44b7336b4e71 100644 (file)
--- a/ucw/lib.h
+++ b/ucw/lib.h
@@ -1,7 +1,7 @@
 /*
  *     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>
@@ -13,8 +13,40 @@
 #ifndef _UCW_LIB_H
 #define _UCW_LIB_H
 
-#include "ucw/config.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 ***/
 
@@ -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 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 **/
@@ -118,6 +151,7 @@ enum log_levels {                   /** The available log levels to pass to msg() and friends. *
 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. **/
@@ -144,8 +178,28 @@ 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. **/
+/**
+ * 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)
+#define DBG_SPOT do { } while(0)
+#endif
+
+#ifdef DEBUG_ASSERTS
+/**
+ * Sometimes, we may want to check that a pointer points to a valid memory
+ * location before we start using it for anything more complicated. This
+ * macro checks pointer validity by reading the byte it points to.
+ **/
+#define ASSERT_READABLE(ptr) ({ volatile char *__p = (ptr); *__p; })
+/** Like the previous macro, but it checks writeability, too. **/
+#define ASSERT_WRITEABLE(ptr) ({ volatile char *__p = (ptr); *__p = *__p; })
+#else
+#define ASSERT_READABLE(ptr) do { } while(0)
+#define ASSERT_WRITEABLE(ptr) do { } while(0)
 #endif
 
 /*** === Memory allocation ***/
@@ -177,14 +231,6 @@ void *big_alloc(u64 len) LIKE_MALLOC;              /** Allocate a large memory block in the
 void *big_alloc_zero(u64 len) LIKE_MALLOC;     /** Allocate and clear a large memory block. **/
 void big_free(void *start, u64 len);           /** Free block allocated by @big_alloc() or @big_alloc_zero(). **/
 
-/*** === Trivial timers (timer.c) ***/
-
-timestamp_t get_timestamp(void);               /** Get current time as a millisecond timestamp. **/
-
-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 numbers (random.c) ***/
 
 uns random_u32(void);                          /** Return a pseudorandom 32-bit number. **/