lib/lib.h

   1 /*
   2  *      The UCW Library -- Miscellaneous Functions
   3  *
   4  *      (c) 1997--2008 Martin Mares <mj@ucw.cz>
   5  *      (c) 2005 Tomas Valla <tom@ucw.cz>
   6  *      (c) 2006 Robert Spalek <robert@ucw.cz>
   7  *      (c) 2007 Pavel Charvat <pchar@ucw.cz>
   8  *
   9  *      This software may be freely distributed and used according to the terms
  10  *      of the GNU Lesser General Public License.
  11  */
  12
  13 #ifndef _UCW_LIB_H
  14 #define _UCW_LIB_H
  15
  16 #include "lib/config.h"
  17 #include <stdarg.h>
  18
  19 /* Macros for handling structurues, offsets and alignment */
  20
  21 #define CHECK_PTR_TYPE(x, type) ((x)-(type)(x) + (type)(x))
  22 #define PTR_TO(s, i) &((s*)0)->i
  23 #define OFFSETOF(s, i) ((unsigned int) PTR_TO(s, i))
  24 #define SKIP_BACK(s, i, p) ((s *)((char *)p - OFFSETOF(s, i)))
  25 #define ALIGN_TO(s, a) (((s)+a-1)&~(a-1))
  26 #define ALIGN_PTR(p, s) ((uintptr_t)(p) % (s) ? (typeof(p))((uintptr_t)(p) + (s) - (uintptr_t)(p) % (s)) : (p))
  27 #define UNALIGNED_PART(ptr, type) (((uintptr_t) (ptr)) % sizeof(type))
  28
  29 /* Some other macros */
  30
  31 #define MIN(a,b) (((a)<(b))?(a):(b))
  32 #define MAX(a,b) (((a)>(b))?(a):(b))
  33 #define CLAMP(x,min,max) ({ int _t=x; (_t < min) ? min : (_t > max) ? max : _t; })
  34 #define ABS(x) ((x) < 0 ? -(x) : (x))
  35 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(*(a)))
  36 #define STRINGIFY(x) #x
  37 #define STRINGIFY_EXPANDED(x) STRINGIFY(x)
  38 #define GLUE(x,y) x##y
  39 #define GLUE_(x,y) x##_##y
  40
  41 #define COMPARE(x,y) do { if ((x)<(y)) return -1; if ((x)>(y)) return 1; } while(0)
  42 #define REV_COMPARE(x,y) COMPARE(y,x)
  43 #define COMPARE_LT(x,y) do { if ((x)<(y)) return 1; if ((x)>(y)) return 0; } while(0)
  44 #define COMPARE_GT(x,y) COMPARE_LT(y,x)
  45
  46 #define ROL(x, bits) (((x) << (bits)) | ((x) >> (sizeof(uns)*8 - (bits))))      /* Bitwise rotation of an uns to the left */
  47
  48 /* GCC Extensions */
  49
  50 #ifdef __GNUC__
  51
  52 #undef inline
  53 #define NONRET __attribute__((noreturn))
  54 #define UNUSED __attribute__((unused))
  55 #define CONSTRUCTOR __attribute__((constructor))
  56 #define PACKED __attribute__((packed))
  57 #define CONST __attribute__((const))
  58 #define PURE __attribute__((pure))
  59 #define FORMAT_CHECK(x,y,z) __attribute__((format(x,y,z)))
  60 #define likely(x) __builtin_expect((x),1)
  61 #define unlikely(x) __builtin_expect((x),0)
  62
  63 #if __GNUC__ >= 4 || __GNUC__ == 3 && __GNUC_MINOR__ >= 3
  64 #define ALWAYS_INLINE inline __attribute__((always_inline))
  65 #define NO_INLINE __attribute__((noinline))
  66 #else
  67 #define ALWAYS_INLINE inline
  68 #endif
  69
  70 #if __GNUC__ >= 4
  71 #define LIKE_MALLOC __attribute__((malloc))
  72 #define SENTINEL_CHECK __attribute__((sentinel))
  73 #else
  74 #define LIKE_MALLOC
  75 #define SENTINEL_CHECK
  76 #endif
  77
  78 #else
  79 #error This program requires the GNU C compiler.
  80 #endif
  81
  82 /* Logging */
  83
  84 #define L_DEBUG         'D'             /* Debugging messages */
  85 #define L_INFO          'I'             /* Informational msgs, warnings and errors */
  86 #define L_WARN          'W'
  87 #define L_ERROR         'E'
  88 #define L_INFO_R        'i'             /* Errors caused by external events */
  89 #define L_WARN_R        'w'
  90 #define L_ERROR_R       'e'
  91 #define L_FATAL         '!'             /* die() */
  92
  93 #define L_SIGHANDLER    0x10000         /* Avoid things which are unsafe in signal handlers */
  94
  95 extern char *log_title;                 /* NULL - print no title, default is log_progname */
  96 extern char *log_filename;              /* Expanded name of the current log file */
  97 extern volatile int log_switch_nest;    /* log_switch() nesting counter, increment to disable automatic switches */
  98 extern int log_pid;                     /* 0 if shouldn't be logged */
  99 extern int log_precise_timings;         /* Include microsecond timestamps in log messages */
 100 extern void (*log_die_hook)(void);
 101 struct tm;
 102 extern void (*log_switch_hook)(struct tm *tm);
 103
 104 void msg(uns cat, const char *fmt, ...) FORMAT_CHECK(printf,2,3);
 105 void vmsg(uns cat, const char *fmt, va_list args);
 106 void die(const char *, ...) NONRET FORMAT_CHECK(printf,1,2);
 107 void log_init(const char *argv0);
 108 void log_file(const char *name);
 109 void log_fork(void);
 110 int log_switch(void);
 111
 112 void assert_failed(const char *assertion, const char *file, int line) NONRET;
 113 void assert_failed_noinfo(void) NONRET;
 114
 115 #ifdef DEBUG_ASSERTS
 116 #define ASSERT(x) ({ if (unlikely(!(x))) assert_failed(#x, __FILE__, __LINE__); 1; })
 117 #else
 118 #define ASSERT(x) ({ if (__builtin_constant_p(x) && !(x)) assert_failed_noinfo(); 1; })
 119 #endif
 120
 121 #define COMPILE_ASSERT(name,x) typedef char _COMPILE_ASSERT_##name[!!(x)-1]
 122
 123 #ifdef LOCAL_DEBUG
 124 #define DBG(x,y...) msg(L_DEBUG, x,##y)
 125 #else
 126 #define DBG(x,y...) do { } while(0)
 127 #endif
 128
 129 static inline void log_switch_disable(void) { log_switch_nest++; }
 130 static inline void log_switch_enable(void) { ASSERT(log_switch_nest); log_switch_nest--; }
 131
 132 /* Memory allocation */
 133
 134 #define xmalloc sh_xmalloc
 135 #define xrealloc sh_xrealloc
 136 #define xfree sh_xfree
 137
 138 #ifdef DEBUG_DMALLOC
 139 /*
 140  * The standard dmalloc macros tend to produce lots of namespace
 141  * conflicts and we use only xmalloc and xfree, so we can define
 142  * the stubs ourselves.
 143  */
 144 #define DMALLOC_DISABLE
 145 #include <dmalloc.h>
 146 #define sh_xmalloc(size) _xmalloc_leap(__FILE__, __LINE__, size)
 147 #define sh_xrealloc(ptr,size) _xrealloc_leap(__FILE__, __LINE__, ptr, size)
 148 #define sh_xfree(ptr) _xfree_leap(__FILE__, __LINE__, ptr)
 149 #else
 150 /*
 151  * Unfortunately, several libraries we might want to link to define
 152  * their own xmalloc and we don't want to interfere with them, hence
 153  * the renaming.
 154  */
 155 void *xmalloc(uns) LIKE_MALLOC;
 156 void *xrealloc(void *, uns);
 157 void xfree(void *);
 158 #endif
 159
 160 void *xmalloc_zero(uns) LIKE_MALLOC;
 161 char *xstrdup(const char *) LIKE_MALLOC;
 162
 163 /* Content-Type pattern matching and filters */
 164
 165 int match_ct_patt(const char *, const char *);
 166
 167 /* wordsplit.c */
 168
 169 int sepsplit(char *str, uns sep, char **rec, uns max);
 170 int wordsplit(char *str, char **rec, uns max);
 171
 172 /* pat(i)match.c: Matching of shell patterns */
 173
 174 int match_pattern(const char *patt, const char *str);
 175 int match_pattern_nocase(const char *patt, const char *str);
 176
 177 /* md5hex.c */
 178
 179 void md5_to_hex(const byte *s, char *d);
 180 void hex_to_md5(const char *s, byte *d);
 181
 182 #define MD5_SIZE 16
 183 #define MD5_HEX_SIZE 33
 184
 185 /* prime.c */
 186
 187 int isprime(uns x);
 188 uns nextprime(uns x);
 189
 190 /* primetable.c */
 191
 192 uns next_table_prime(uns x);
 193 uns prev_table_prime(uns x);
 194
 195 /* timer.c */
 196
 197 timestamp_t get_timestamp(void);
 198
 199 void init_timer(timestamp_t *timer);
 200 uns get_timer(timestamp_t *timer);
 201 uns switch_timer(timestamp_t *old, timestamp_t *new);
 202
 203 /* regex.c */
 204
 205 typedef struct regex regex;
 206
 207 regex *rx_compile(const char *r, int icase);
 208 void rx_free(regex *r);
 209 int rx_match(regex *r, const char *s);
 210 int rx_subst(regex *r, const char *by, const char *src, char *dest, uns destlen);
 211
 212 /* random.c */
 213
 214 uns random_u32(void);
 215 uns random_max(uns max);
 216 u64 random_u64(void);
 217 u64 random_max_u64(u64 max);
 218
 219 /* mmap.c */
 220
 221 void *mmap_file(const char *name, unsigned *len, int writeable);
 222 void munmap_file(void *start, unsigned len);
 223
 224 /* proctitle.c */
 225
 226 void setproctitle_init(int argc, char **argv);
 227 void setproctitle(const char *msg, ...) FORMAT_CHECK(printf,1,2);
 228 char *getproctitle(void);
 229
 230 /* randomkey.c */
 231
 232 void randomkey(byte *buf, uns size);
 233
 234 /* exitstatus.c */
 235
 236 #define EXIT_STATUS_MSG_SIZE 32
 237 int format_exit_status(char *msg, int stat);
 238
 239 /* runcmd.c */
 240
 241 int run_command(const char *cmd, ...);
 242 void NONRET exec_command(const char *cmd, ...);
 243 void echo_command(char *buf, int size, const char *cmd, ...);
 244 int run_command_v(const char *cmd, va_list args);
 245 void NONRET exec_command_v(const char *cmd, va_list args);
 246 void echo_command_v(char *buf, int size, const char *cmd, va_list args);
 247
 248 /* carefulio.c */
 249
 250 int careful_read(int fd, void *buf, int len);
 251 int careful_write(int fd, const void *buf, int len);
 252
 253 /* sync.c */
 254
 255 void sync_dir(const char *name);
 256
 257 /* sighandler.c */
 258
 259 typedef int (*sh_sighandler_t)(int);    // gets signum, returns nonzero if abort() should be called
 260
 261 void handle_signal(int signum);
 262 void unhandle_signal(int signum);
 263 sh_sighandler_t set_signal_handler(int signum, sh_sighandler_t new);
 264
 265 /* string.c */
 266
 267 char *str_unesc(char *dest, const char *src);
 268 char *str_format_flags(char *dest, const char *fmt, uns flags);
 269
 270 /* bigalloc.c */
 271
 272 void *page_alloc(u64 len) LIKE_MALLOC; // allocates a multiple of CPU_PAGE_SIZE bytes with mmap
 273 void *page_alloc_zero(u64 len) LIKE_MALLOC;
 274 void page_free(void *start, u64 len);
 275 void *page_realloc(void *start, u64 old_len, u64 new_len);
 276
 277 void *big_alloc(u64 len) LIKE_MALLOC; // allocate a large memory block in the most efficient way available
 278 void *big_alloc_zero(u64 len) LIKE_MALLOC;
 279 void big_free(void *start, u64 len);
 280
 281 #endif