lib/lib.h

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