]> mj.ucw.cz Git - libucw.git/blob - lib/lib.h
Introduced COMPARE macro for use in sorter callbacks.
[libucw.git] / 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
21 /* Tell libc we're going to use all extensions available */
22
23 #define _GNU_SOURCE
24
25 /* Ugly structure handling macros */
26
27 #define OFFSETOF(s, i) ((unsigned int)&((s *)0)->i)
28 #define SKIP_BACK(s, i, p) ((s *)((char *)p - OFFSETOF(s, i)))
29 #define ALIGN(s, a) (((s)+a-1)&~(a-1))
30 #define UNALIGNED_PART(ptr, type) (((long) (ptr)) % sizeof(type))
31
32 /* Some other macros */
33
34 #define MIN(a,b) (((a)<(b))?(a):(b))
35 #define MAX(a,b) (((a)>(b))?(a):(b))
36 #define CLAMP(x,min,max) ({ int _t=x; (_t < min) ? min : (_t > max) ? max : _t; })
37 #define ABS(x) ((x) < 0 ? -(x) : (x))
38 #define ARRAY_SIZE(a) (sizeof(a)/sizeof(*(a)))
39 #define STRINGIFY(x) #x
40 #define GLUE(x,y) x##y
41 #define GLUE_(x,y) x##_##y
42 #define COMPARE(x,y) do { if ((x)<(y)) return -1; if ((x)>(y)) return 1; } while(0)
43
44 /* Logging */
45
46 #define L_DEBUG         'D'             /* Debugging messages */
47 #define L_INFO          'I'             /* Informational msgs, warnings and errors */
48 #define L_WARN          'W'
49 #define L_ERROR         'E'
50 #define L_INFO_R        'i'             /* Errors caused by external events */
51 #define L_WARN_R        'w'
52 #define L_ERROR_R       'e'
53 #define L_FATAL         '!'             /* die() */
54
55 extern char *log_title;                 /* NULL - print no title, default is log_progname */
56
57 void log_msg(unsigned int cat, const char *msg, ...) __attribute__((format(printf,2,3)));
58 #define log log_msg
59 void die(byte *, ...) NONRET;
60 void log_init(byte *);
61 void log_file(byte *);
62 void log_fork(void);
63
64 #ifdef DEBUG
65 void assert_failed(char *assertion, char *file, int line) NONRET;
66 #define ASSERT(x) do { if (unlikely(!(x))) assert_failed(#x, __FILE__, __LINE__); } while(0)
67 #else
68 void assert_failed(void) NONRET;
69 #define ASSERT(x) do { if (__builtin_constant_p(x) && !(x)) assert_failed(); } while(0)
70 #endif
71
72 #ifdef LOCAL_DEBUG
73 #define DBG(x,y...) log(L_DEBUG, x,##y)
74 #else
75 #define DBG(x,y...) do { } while(0)
76 #endif
77
78 /* Memory allocation */
79
80 #ifdef DEBUG_DMALLOC
81 /*
82  * The standard dmalloc macros tend to produce lots of namespace
83  * conflicts and we use only xmalloc and xfree, so we can define
84  * the stubs ourselves.
85  */
86 #define DMALLOC_DISABLE
87 #include <dmalloc.h>
88 #define xmalloc(size) _xmalloc_leap(__FILE__, __LINE__, size)
89 #define xrealloc(ptr,size) _xrealloc_leap(__FILE__, __LINE__, ptr, size)
90 #define xfree(ptr) _xfree_leap(__FILE__, __LINE__, ptr)
91 #else
92 /*
93  * Unfortunately, several libraries we might want to link to define
94  * their own xmalloc and we don't want to interfere with them, hence
95  * the renaming.
96  */
97 #define xmalloc sh_xmalloc
98 void *xmalloc(unsigned);
99 void *xrealloc(void *, unsigned);
100 #define xfree(x) free(x)
101 #endif
102
103 void *xmalloc_zero(unsigned);
104 byte *stralloc(byte *);
105
106 /* Content-Type pattern matching and filters */
107
108 int match_ct_patt(byte *, byte *);
109
110 /* log2.c */
111
112 int fls(u32);
113
114 /* wordsplit.c */
115
116 int wordsplit(byte *, byte **, uns);
117
118 /* pat(i)match.c: Matching of shell patterns */
119
120 int match_pattern(byte *, byte *);
121 int match_pattern_nocase(byte *, byte *);
122
123 /* md5hex.c */
124
125 void md5_to_hex(byte *, byte *);
126 void hex_to_md5(byte *, byte *);
127
128 #define MD5_SIZE 16
129 #define MD5_HEX_SIZE 33
130
131 /* prime.c */
132
133 int isprime(uns);
134 uns nextprime(uns);
135
136 /* timer.c */
137
138 void init_timer(void);
139 uns get_timer(void);
140
141 /* regex.c */
142
143 typedef struct regex regex;
144
145 regex *rx_compile(byte *r, int icase);
146 void rx_free(regex *r);
147 int rx_match(regex *r, byte *s);
148 int rx_subst(regex *r, byte *by, byte *src, byte *dest, uns destlen);
149
150 /* random.c */
151
152 uns random_max(uns);
153
154 /* mmap.c */
155
156 void *mmap_file(byte *name, unsigned *len, int writeable);
157 void munmap_file(void *start, unsigned len);
158
159 /* partmap.c */
160
161 struct partmap;
162 struct partmap *partmap_open(byte *name, int writeable);
163 void *partmap_map(struct partmap *p, sh_off_t offset, uns size);
164 void partmap_close(struct partmap *p);
165 sh_off_t partmap_size(struct partmap *p);
166
167 /* proctitle.c */
168
169 void setproctitle_init(int argc, char **argv);
170 void setproctitle(char *msg, ...) __attribute__((format(printf,1,2)));
171
172 /* randomkey.c */
173
174 void randomkey(byte *buf, uns size);
175
176 #endif