X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=ucw%2Flib.h;h=302f19ed447ae2c7b3dac37c3dda44b7336b4e71;hb=0db6e10eac28f38bfc3b325b13ad95107c58ce1e;hp=9612e6c711148a6e184df95a89920339e4dc1765;hpb=e6688eeb82d349a202a30a243a59079bdc4c212d;p=libucw.git diff --git a/ucw/lib.h b/ucw/lib.h index 9612e6c7..302f19ed 100644 --- a/ucw/lib.h +++ b/ucw/lib.h @@ -1,7 +1,7 @@ /* * The UCW Library -- Miscellaneous Functions * - * (c) 1997--2009 Martin Mares + * (c) 1997--2014 Martin Mares * (c) 2005 Tomas Valla * (c) 2006 Robert Spalek * (c) 2007 Pavel Charvat @@ -13,14 +13,46 @@ #ifndef _UCW_LIB_H #define _UCW_LIB_H -#include "ucw/config.h" +#include #include +#include + +#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 ***/ #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) ((unsigned int) (uintptr_t) PTR_TO(s, i)) /** Offset of item @i from the start of structure @s **/ +#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) **/ @@ -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 , 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 +/** + * 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 ***/ @@ -163,16 +217,19 @@ void *xmalloc(size_t) LIKE_MALLOC; /** Allocate memory and die() if there is no 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; /** Allocate memory and fill it by zeroes. **/ +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,61 +238,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). **/ -/* mmap.c */ - -void *mmap_file(const char *name, unsigned *len, int writeable); -void munmap_file(void *start, unsigned len); - -/* proctitle.c */ - -void setproctitle_init(int argc, char **argv); -void setproctitle(const char *msg, ...) FORMAT_CHECK(printf,1,2); -char *getproctitle(void); - -/* randomkey.c */ - -void randomkey(byte *buf, uns size); - -/* exitstatus.c */ - -#define EXIT_STATUS_MSG_SIZE 32 -int format_exit_status(char *msg, int stat); - -/* runcmd.c */ - -int run_command(const char *cmd, ...); -void NONRET exec_command(const char *cmd, ...); -void echo_command(char *buf, int size, const char *cmd, ...); -int run_command_v(const char *cmd, va_list args); -void NONRET exec_command_v(const char *cmd, va_list args); -void echo_command_v(char *buf, int size, const char *cmd, va_list args); - -/* carefulio.c */ - -int careful_read(int fd, void *buf, int len); -int careful_write(int fd, const void *buf, int len); - -/* sync.c */ - -void sync_dir(const char *name); - -/* 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