X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=lib%2Flib.h;h=27a7511b1308260c67196a23dc87a48fee16bc96;hb=116954d49373438c669eadd764e03ee8ac4211bb;hp=39ee0de69874dce4cb3939bb03e58e342c387187;hpb=f5cb619eb24ba3501a1b1a1c3edd93689714b1f6;p=libucw.git diff --git a/lib/lib.h b/lib/lib.h index 39ee0de6..27a7511b 100644 --- a/lib/lib.h +++ b/lib/lib.h @@ -1,34 +1,35 @@ /* - * Sherlock Library -- Miscellaneous Functions + * The UCW Library -- Miscellaneous Functions * - * (c) 1997--2004 Martin Mares + * (c) 1997--2006 Martin Mares + * (c) 2005 Tomas Valla + * (c) 2006 Robert Spalek * * This software may be freely distributed and used according to the terms * of the GNU Lesser General Public License. */ -/* - * This file should be included as the very first include in all - * source files, especially before all OS includes since it sets - * up libc feature macros. - */ - -#ifndef _SHERLOCK_LIB_H -#define _SHERLOCK_LIB_H +#ifndef _UCW_LIB_H +#define _UCW_LIB_H #include "lib/config.h" #include /* Tell libc we're going to use all extensions available */ +#ifndef _GNU_SOURCE #define _GNU_SOURCE +#endif -/* Ugly structure handling macros */ +/* Macros for handling structurues, offsets and alignment */ -#define OFFSETOF(s, i) ((unsigned int)&((s *)0)->i) +#define CHECK_PTR_TYPE(x, type) ((x)-(type)(x) + (type)(x)) +#define PTR_TO(s, i) &((s*)0)->i +#define OFFSETOF(s, i) ((unsigned int) PTR_TO(s, i)) #define SKIP_BACK(s, i, p) ((s *)((char *)p - OFFSETOF(s, i))) -#define ALIGN(s, a) (((s)+a-1)&~(a-1)) -#define UNALIGNED_PART(ptr, type) (((long) (ptr)) % sizeof(type)) +#define ALIGN_TO(s, a) (((s)+a-1)&~(a-1)) +#define ALIGN_PTR(p, s) ((addr_int_t)(p) % (s) ? (typeof(p))((addr_int_t)(p) + (s) - (addr_int_t)(p) % (s)) : (p)) +#define UNALIGNED_PART(ptr, type) (((addr_int_t) (ptr)) % sizeof(type)) /* Some other macros */ @@ -38,10 +39,50 @@ #define ABS(x) ((x) < 0 ? -(x) : (x)) #define ARRAY_SIZE(a) (sizeof(a)/sizeof(*(a))) #define STRINGIFY(x) #x +#define STRINGIFY_EXPANDED(x) STRINGIFY(x) #define GLUE(x,y) x##y #define GLUE_(x,y) x##_##y + #define COMPARE(x,y) do { if ((x)<(y)) return -1; if ((x)>(y)) return 1; } while(0) #define REV_COMPARE(x,y) COMPARE(y,x) +#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)) | ((x) >> (sizeof(uns)*8 - (bits)))) /* Bitwise rotation of an uns to the left */ + +/* GCC Extensions */ + +#ifdef __GNUC__ + +#undef inline +#define NONRET __attribute__((noreturn)) +#define UNUSED __attribute__((unused)) +#define CONSTRUCTOR __attribute__((constructor)) +#define PACKED __attribute__((packed)) +#define CONST __attribute__((const)) +#define PURE __attribute__((pure)) +#define FORMAT_CHECK(x,y,z) __attribute__((format(x,y,z))) +#define likely(x) __builtin_expect((x),1) +#define unlikely(x) __builtin_expect((x),0) + +#if __GNUC__ >= 4 || __GNUC__ == 3 && __GNUC_MINOR__ >= 3 +#define ALWAYS_INLINE inline __attribute__((always_inline)) +#define NO_INLINE __attribute__((noinline)) +#else +#define ALWAYS_INLINE inline +#endif + +#if __GNUC__ >= 4 +#define LIKE_MALLOC __attribute__((malloc)) +#define SENTINEL_CHECK __attribute__((sentinel)) +#else +#define LIKE_MALLOC +#define SENTINEL_CHECK +#endif + +#else +#error This program requires the GNU C compiler. +#endif /* Logging */ @@ -56,27 +97,29 @@ extern char *log_title; /* NULL - print no title, default is log_progname */ extern char *log_filename; /* Expanded name of the current log file */ -extern int log_switch_nest; /* log_switch() nesting counter, increment to disable automatic switches */ +extern volatile int log_switch_nest; /* log_switch() nesting counter, increment to disable automatic switches */ extern int log_pid; /* 0 if shouldn't be logged */ +extern int log_precise_timings; /* Include microsecond timestamps in log messages */ extern void (*log_die_hook)(void); struct tm; extern void (*log_switch_hook)(struct tm *tm); -void log_msg(unsigned int cat, const char *msg, ...) __attribute__((format(printf,2,3))); +void log_msg(unsigned int cat, const char *msg, ...) FORMAT_CHECK(printf,2,3); #define log log_msg void vlog_msg(unsigned int cat, const char *msg, va_list args); -void die(byte *, ...) NONRET; +void die(const char *, ...) NONRET FORMAT_CHECK(printf,1,2); void log_init(byte *argv0); void log_file(byte *name); void log_fork(void); -void log_switch(void); +int log_switch(void); -#ifdef DEBUG void assert_failed(char *assertion, char *file, int line) NONRET; +void assert_failed_noinfo(void) NONRET; + +#ifdef DEBUG_ASSERTS #define ASSERT(x) do { if (unlikely(!(x))) assert_failed(#x, __FILE__, __LINE__); } while(0) #else -void assert_failed(void) NONRET; -#define ASSERT(x) do { if (__builtin_constant_p(x) && !(x)) assert_failed(); } while(0) +#define ASSERT(x) do { if (__builtin_constant_p(x) && !(x)) assert_failed_noinfo(); } while(0) #endif #define COMPILE_ASSERT(name,x) typedef char _COMPILE_ASSERT_##name[!!(x)-1] @@ -92,6 +135,10 @@ static inline void log_switch_enable(void) { ASSERT(log_switch_nest); log_switch /* Memory allocation */ +#define xmalloc sh_xmalloc +#define xrealloc sh_xrealloc +#define xfree sh_xfree + #ifdef DEBUG_DMALLOC /* * The standard dmalloc macros tend to produce lots of namespace @@ -100,34 +147,30 @@ static inline void log_switch_enable(void) { ASSERT(log_switch_nest); log_switch */ #define DMALLOC_DISABLE #include -#define xmalloc(size) _xmalloc_leap(__FILE__, __LINE__, size) -#define xrealloc(ptr,size) _xrealloc_leap(__FILE__, __LINE__, ptr, size) -#define xfree(ptr) _xfree_leap(__FILE__, __LINE__, ptr) +#define sh_xmalloc(size) _xmalloc_leap(__FILE__, __LINE__, size) +#define sh_xrealloc(ptr,size) _xrealloc_leap(__FILE__, __LINE__, ptr, size) +#define sh_xfree(ptr) _xfree_leap(__FILE__, __LINE__, ptr) #else /* * Unfortunately, several libraries we might want to link to define * their own xmalloc and we don't want to interfere with them, hence * the renaming. */ -#define xmalloc sh_xmalloc -void *xmalloc(unsigned); +void *xmalloc(unsigned) LIKE_MALLOC; void *xrealloc(void *, unsigned); -#define xfree(x) free(x) +void xfree(void *); #endif -void *xmalloc_zero(unsigned); -byte *xstrdup(byte *); +void *xmalloc_zero(unsigned) LIKE_MALLOC; +byte *xstrdup(byte *) LIKE_MALLOC; /* Content-Type pattern matching and filters */ int match_ct_patt(byte *, byte *); -/* log2.c */ - -int fls(u32); - /* wordsplit.c */ +int sepsplit(byte *str, byte sep, byte **rec, uns max); int wordsplit(byte *, byte **, uns); /* pat(i)match.c: Matching of shell patterns */ @@ -148,10 +191,18 @@ void hex_to_md5(byte *, byte *); int isprime(uns); uns nextprime(uns); +/* primetable.c */ + +uns next_table_prime(uns x); +uns prev_table_prime(uns x); + /* timer.c */ +struct timeval; + void init_timer(void); uns get_timer(void); +void get_last_timeval(struct timeval *tv); /* regex.c */ @@ -164,25 +215,20 @@ int rx_subst(regex *r, byte *by, byte *src, byte *dest, uns destlen); /* random.c */ -uns random_max(uns); +uns random_max(uns max); +u64 random_u64(void); +u64 random_max_u64(u64 max); /* mmap.c */ void *mmap_file(byte *name, unsigned *len, int writeable); void munmap_file(void *start, unsigned len); -/* partmap.c */ - -struct partmap; -struct partmap *partmap_open(byte *name, int writeable); -void *partmap_map(struct partmap *p, sh_off_t offset, uns size); -void partmap_close(struct partmap *p); -sh_off_t partmap_size(struct partmap *p); - /* proctitle.c */ void setproctitle_init(int argc, char **argv); -void setproctitle(char *msg, ...) __attribute__((format(printf,1,2))); +void setproctitle(char *msg, ...) FORMAT_CHECK(printf,1,2); +char *getproctitle(void); /* randomkey.c */ @@ -207,10 +253,25 @@ void echo_command_v(byte *buf, int size, byte *cmd, va_list args); int careful_read(int fd, void *buf, int len); int careful_write(int fd, void *buf, int len); +/* sync.c */ + +void sync_dir(byte *name); + /* sighandler.c */ -typedef void (*my_sighandler_t)(void); -extern my_sighandler_t signal_handler[]; -void *handle_signal(int signum); +typedef int (*sh_sighandler_t)(int); // gets signum, returns nonzero if abort() should be called + +void handle_signal(int signum); +void unhandle_signal(int signum); +sh_sighandler_t set_signal_handler(int signum, sh_sighandler_t new); + +/* string.c */ + +byte *str_unesc(byte *dest, byte *src); + +/* bigalloc.c */ + +void *big_alloc(unsigned int len); +void big_free(void *start, unsigned int len); #endif