lib/lib.h

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