lib/lib.h

   1 /*
   2  *      Sherlock Library -- Miscellaneous Functions
   3  *
   4  *      (c) 1997--2001 Martin Mares <mj@ucw.cz>
   5  */
   6
   7 /*
   8  *  This file should be included as the very first include in all
   9  *  source files, especially before all OS includes since it sets
  10  *  up libc feature macros.
  11  */
  12
  13 #ifndef _SHERLOCK_LIB_H
  14 #define _SHERLOCK_LIB_H
  15
  16 #include "lib/config.h"
  17
  18 /* Tell libc we're going to use all extensions available */
  19
  20 #define _GNU_SOURCE
  21
  22 /* Ugly structure handling macros */
  23
  24 #define OFFSETOF(s, i) ((unsigned int)&((s *)0)->i)
  25 #define SKIP_BACK(s, i, p) ((s *)((char *)p - OFFSETOF(s, i)))
  26 #define ALIGN(s, a) (((s)+a-1)&~(a-1))
  27 #define UNALIGNED_PART(ptr, type) (((long) (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
  37 /* Logging */
  38
  39 #define L_DEBUG         'D'             /* Debugging messages */
  40 #define L_INFO          'I'             /* Informational msgs, warnings and errors */
  41 #define L_WARN          'W'
  42 #define L_ERROR         'E'
  43 #define L_INFO_R        'i'             /* Errors caused by external events */
  44 #define L_WARN_R        'w'
  45 #define L_ERROR_R       'e'
  46 #define L_FATAL         '!'             /* die() */
  47
  48 void log(unsigned int cat, const char *msg, ...) __attribute__((format(printf,2,3)));
  49 void die(byte *, ...) NONRET;
  50 void log_init(byte *);
  51 void log_file(byte *);
  52 void log_fork(void);
  53
  54 #ifdef DEBUG
  55 #define ASSERT(x) do { if (!(x)) die("Assertion `%s' failed at %s:%d", #x, __FILE__, __LINE__); } while(0)
  56 #else
  57 #define ASSERT(x) do { } while(0)
  58 #endif
  59
  60 #ifdef LOCAL_DEBUG
  61 #define DBG(x,y...) log(L_DEBUG, x,##y)
  62 #else
  63 #define DBG(x,y...) do { } while(0)
  64 #endif
  65
  66 /* Memory allocation */
  67
  68 #ifdef DMALLOC
  69 /*
  70  * The standard dmalloc macros tend to produce lots of namespace
  71  * conflicts and we use only xmalloc and xfree, so we can define
  72  * the stubs ourselves.
  73  */
  74 #define DMALLOC_DISABLE
  75 #include <dmalloc.h>
  76 #define xmalloc(size) _xmalloc_leap(__FILE__, __LINE__, size)
  77 #define xrealloc(ptr,size) _xrealloc_leap(__FILE__, __LINE__, ptr, size)
  78 #define xfree(ptr) _xfree_leap(__FILE__, __LINE__, ptr)
  79 #else
  80 /*
  81  * Unfortunately, several libraries we might want to link to define
  82  * their own xmalloc and we don't want to interfere with them, hence
  83  * the renaming.
  84  */
  85 #define xmalloc sh_xmalloc
  86 void *xmalloc(unsigned);
  87 void *xmalloc_zero(unsigned);
  88 void *xrealloc(void *, unsigned);
  89 #define xfree(x) free(x)
  90 #endif
  91
  92 byte *stralloc(byte *);
  93
  94 /* Objects */
  95
  96 struct fastbuf;
  97
  98 struct odes {                           /* Object description */
  99   struct oattr *attrs;
 100   struct mempool *pool, *local_pool;
 101 };
 102
 103 struct oattr {                          /* Object attribute */
 104   struct oattr *next, *same, *last_same;
 105   byte attr;
 106   byte val[1];
 107 };
 108
 109 void obj_dump(struct odes *);
 110 struct odes *obj_new(struct mempool *);
 111 void obj_free(struct odes *);
 112 int obj_read(struct fastbuf *, struct odes *);
 113 void obj_write(struct fastbuf *, struct odes *);
 114 struct oattr *obj_find_attr(struct odes *, uns);
 115 struct oattr *obj_find_attr_last(struct odes *, uns);
 116 uns obj_del_attr(struct odes *, struct oattr *);
 117 byte *obj_find_aval(struct odes *, uns);
 118 struct oattr *obj_set_attr(struct odes *, uns, byte *);
 119 struct oattr *obj_set_attr_num(struct odes *, uns, uns);
 120 struct oattr *obj_add_attr(struct odes *, struct oattr *, uns, byte *);
 121
 122 /* Content-Type pattern matching and filters */
 123
 124 int match_ct_patt(byte *, byte *);
 125
 126 /* log2.c */
 127
 128 int log2(u32);
 129
 130 /* wordsplit.c */
 131
 132 int wordsplit(byte *, byte **, uns);
 133
 134 /* pat(i)match.c: Matching of shell patterns */
 135
 136 int match_pattern(byte *, byte *);
 137 int match_pattern_nocase(byte *, byte *);
 138
 139 /* md5hex.c */
 140
 141 void md5_to_hex(byte *, byte *);
 142 void hex_to_md5(byte *, byte *);
 143
 144 #define MD5_SIZE 16
 145 #define MD5_HEX_SIZE 33
 146
 147 /* prime.c */
 148
 149 int isprime(uns);
 150 uns nextprime(uns);
 151
 152 /* timer.c */
 153
 154 void init_timer(void);
 155 uns get_timer(void);
 156
 157 /* regex.c */
 158
 159 typedef struct regex regex;
 160
 161 regex *rx_compile(byte *r, int icase);
 162 void rx_free(regex *r);
 163 int rx_match(regex *r, byte *s);
 164 int rx_subst(regex *r, byte *by, byte *src, byte *dest, uns destlen);
 165
 166 /* random.c */
 167
 168 uns random_max(uns);
 169
 170 /* mmap.c */
 171
 172 void *mmap_file(byte *name, unsigned *len, int writeable);
 173 void munmap_file(void *start, unsigned len);
 174
 175 /* proctitle.c */
 176
 177 void setproctitle_init(int argc, char **argv);
 178 void setproctitle(char *msg, ...) __attribute__((format(printf,1,2)));
 179
 180 /* randomkey.c */
 181
 182 void randomkey(byte *buf, uns size);
 183
 184 #endif