X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=ucw%2Flib.h;h=c673fb7bc7e1e09d51a4676b24c549ea0e44bf78;hb=5959916922193dea72ec0f74fa0a5211ca68f9c4;hp=29c2d236c9346f3088aea0dae05a11cb9fb7b23f;hpb=45201a4c724923aae01ed891be9e125b229ad189;p=libucw.git

diff --git a/ucw/lib.h b/ucw/lib.h
index 29c2d236..c673fb7b 100644
--- a/ucw/lib.h
+++ b/ucw/lib.h
@@ -13,7 +13,7 @@
 #ifndef _UCW_LIB_H
 #define _UCW_LIB_H
 
-#include "ucw/config.h"
+#include <ucw/config.h>
 #include <stdarg.h>
 
 /*** === Macros for handling structures, offsets and alignment ***/
@@ -59,6 +59,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 +119,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 +146,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 ***/
@@ -166,13 +188,16 @@ void xfree(void *);				/** Free memory allocated by xmalloc() or xrealloc(). **/
 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. **/
 
-/*** === Trivial timers (timer.c) ***/
+/* bigalloc.c */
 
-timestamp_t get_timestamp(void);		/** Get current time as a millisecond timestamp. **/
+void *page_alloc(u64 len) LIKE_MALLOC;		// Internal: allocates a multiple of CPU_PAGE_SIZE bytes with mmap
+void *page_alloc_zero(u64 len) LIKE_MALLOC;
+void page_free(void *start, u64 len);
+void *page_realloc(void *start, u64 old_len, u64 new_len);
 
-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. **/
+void *big_alloc(u64 len) LIKE_MALLOC;		/** Allocate a large memory block in the most efficient way available. **/
+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(). **/
 
 /*** === Random numbers (random.c) ***/
 
@@ -181,23 +206,4 @@ uns random_max(uns max);			/** Return a pseudorandom 32-bit number in range [0,@
 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). **/
 
-/* sighandler.c */
-
-typedef int (*ucw_sighandler_t)(int);	// gets signum, returns nonzero if abort() should be called
-
-void handle_signal(int signum);
-void unhandle_signal(int signum);
-ucw_sighandler_t set_signal_handler(int signum, ucw_sighandler_t newh);
-
-/* bigalloc.c */
-
-void *page_alloc(u64 len) LIKE_MALLOC; // allocates a multiple of CPU_PAGE_SIZE bytes with mmap
-void *page_alloc_zero(u64 len) LIKE_MALLOC;
-void page_free(void *start, u64 len);
-void *page_realloc(void *start, u64 old_len, u64 new_len);
-
-void *big_alloc(u64 len) LIKE_MALLOC; // allocate a large memory block in the most efficient way available
-void *big_alloc_zero(u64 len) LIKE_MALLOC;
-void big_free(void *start, u64 len);
-
 #endif