2 * The UCW Library -- Miscellaneous Functions
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>
9 * This software may be freely distributed and used according to the terms
10 * of the GNU Lesser General Public License.
16 #include "lib/config.h"
19 /* Macros for handling structurues, offsets and alignment */
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))
29 /* Some other macros */
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
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)
46 #define ROL(x, bits) (((x) << (bits)) | ((x) >> (sizeof(uns)*8 - (bits)))) /* Bitwise rotation of an uns to the left */
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)
63 #if __GNUC__ >= 4 || __GNUC__ == 3 && __GNUC_MINOR__ >= 3
64 #define ALWAYS_INLINE inline __attribute__((always_inline))
65 #define NO_INLINE __attribute__((noinline))
67 #define ALWAYS_INLINE inline
71 #define LIKE_MALLOC __attribute__((malloc))
72 #define SENTINEL_CHECK __attribute__((sentinel))
75 #define SENTINEL_CHECK
79 #error This program requires the GNU C compiler.
84 #define L_DEBUG 'D' /* Debugging messages */
85 #define L_INFO 'I' /* Informational msgs, warnings and errors */
88 #define L_INFO_R 'i' /* Errors caused by external events */
91 #define L_FATAL '!' /* die() */
93 #define L_SIGHANDLER 0x10000 /* Avoid operations that are unsafe in signal handlers */
95 extern char *log_title; /* NULL - print no title, default is program name given to log_init() */
96 extern char *log_filename; /* Expanded name of the current log file */
97 extern int log_pid; /* 0 if shouldn't be logged */
98 extern int log_precise_timings; /* Include microsecond timestamps in log messages */
99 extern void (*log_die_hook)(void);
101 extern void (*log_switch_hook)(struct tm *tm);
103 void msg(uns cat, const char *fmt, ...) FORMAT_CHECK(printf,2,3);
104 void vmsg(uns cat, const char *fmt, va_list args);
105 void die(const char *, ...) NONRET FORMAT_CHECK(printf,1,2);
106 void log_init(const char *argv0);
107 void log_file(const char *name);
108 void log_fork(void); /* Call after fork() to update log_pid */
110 /* If the log name contains metacharacters for date and time, we switch the logs
111 * automatically whenever the name changes. You can disable it and switch explicitly. */
112 int log_switch(void);
113 void log_switch_disable(void);
114 void log_switch_enable(void);
116 void assert_failed(const char *assertion, const char *file, int line) NONRET;
117 void assert_failed_noinfo(void) NONRET;
120 #define ASSERT(x) ({ if (unlikely(!(x))) assert_failed(#x, __FILE__, __LINE__); 1; })
122 #define ASSERT(x) ({ if (__builtin_constant_p(x) && !(x)) assert_failed_noinfo(); 1; })
125 #define COMPILE_ASSERT(name,x) typedef char _COMPILE_ASSERT_##name[!!(x)-1]
128 #define DBG(x,y...) msg(L_DEBUG, x,##y)
130 #define DBG(x,y...) do { } while(0)
133 /* Memory allocation */
135 #define xmalloc sh_xmalloc
136 #define xrealloc sh_xrealloc
137 #define xfree sh_xfree
141 * The standard dmalloc macros tend to produce lots of namespace
142 * conflicts and we use only xmalloc and xfree, so we can define
143 * the stubs ourselves.
145 #define DMALLOC_DISABLE
147 #define sh_xmalloc(size) _xmalloc_leap(__FILE__, __LINE__, size)
148 #define sh_xrealloc(ptr,size) _xrealloc_leap(__FILE__, __LINE__, ptr, size)
149 #define sh_xfree(ptr) _xfree_leap(__FILE__, __LINE__, ptr)
152 * Unfortunately, several libraries we might want to link to define
153 * their own xmalloc and we don't want to interfere with them, hence
156 void *xmalloc(uns) LIKE_MALLOC;
157 void *xrealloc(void *, uns);
161 void *xmalloc_zero(uns) LIKE_MALLOC;
162 char *xstrdup(const char *) LIKE_MALLOC;
164 /* Content-Type pattern matching and filters */
166 int match_ct_patt(const char *, const char *);
170 int sepsplit(char *str, uns sep, char **rec, uns max);
171 int wordsplit(char *str, char **rec, uns max);
173 /* pat(i)match.c: Matching of shell patterns */
175 int match_pattern(const char *patt, const char *str);
176 int match_pattern_nocase(const char *patt, const char *str);
180 void md5_to_hex(const byte *s, char *d);
181 void hex_to_md5(const char *s, byte *d);
184 #define MD5_HEX_SIZE 33
189 uns nextprime(uns x);
193 uns next_table_prime(uns x);
194 uns prev_table_prime(uns x);
198 timestamp_t get_timestamp(void);
200 void init_timer(timestamp_t *timer);
201 uns get_timer(timestamp_t *timer);
202 uns switch_timer(timestamp_t *old, timestamp_t *new);
206 typedef struct regex regex;
208 regex *rx_compile(const char *r, int icase);
209 void rx_free(regex *r);
210 int rx_match(regex *r, const char *s);
211 int rx_subst(regex *r, const char *by, const char *src, char *dest, uns destlen);
215 uns random_u32(void);
216 uns random_max(uns max);
217 u64 random_u64(void);
218 u64 random_max_u64(u64 max);
222 void *mmap_file(const char *name, unsigned *len, int writeable);
223 void munmap_file(void *start, unsigned len);
227 void setproctitle_init(int argc, char **argv);
228 void setproctitle(const char *msg, ...) FORMAT_CHECK(printf,1,2);
229 char *getproctitle(void);
233 void randomkey(byte *buf, uns size);
237 #define EXIT_STATUS_MSG_SIZE 32
238 int format_exit_status(char *msg, int stat);
242 int run_command(const char *cmd, ...);
243 void NONRET exec_command(const char *cmd, ...);
244 void echo_command(char *buf, int size, const char *cmd, ...);
245 int run_command_v(const char *cmd, va_list args);
246 void NONRET exec_command_v(const char *cmd, va_list args);
247 void echo_command_v(char *buf, int size, const char *cmd, va_list args);
251 int careful_read(int fd, void *buf, int len);
252 int careful_write(int fd, const void *buf, int len);
256 void sync_dir(const char *name);
260 typedef int (*sh_sighandler_t)(int); // gets signum, returns nonzero if abort() should be called
262 void handle_signal(int signum);
263 void unhandle_signal(int signum);
264 sh_sighandler_t set_signal_handler(int signum, sh_sighandler_t new);
268 void *page_alloc(u64 len) LIKE_MALLOC; // allocates a multiple of CPU_PAGE_SIZE bytes with mmap
269 void *page_alloc_zero(u64 len) LIKE_MALLOC;
270 void page_free(void *start, u64 len);
271 void *page_realloc(void *start, u64 old_len, u64 new_len);
273 void *big_alloc(u64 len) LIKE_MALLOC; // allocate a large memory block in the most efficient way available
274 void *big_alloc_zero(u64 len) LIKE_MALLOC;
275 void big_free(void *start, u64 len);