X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=lib%2Flib.h;h=c2ec50b03d8516ca8f004ec5922a03e9c7a1b51d;hb=5d26aed3953fe00d6d394f9767b4a029406eeeea;hp=9b169d7a6255718c02ed518d2a5ae2f0388cb060;hpb=b8d8a4e155bcb5d793450b3e6002ea6d41786513;p=libucw.git diff --git a/lib/lib.h b/lib/lib.h index 9b169d7a..c2ec50b0 100644 --- a/lib/lib.h +++ b/lib/lib.h @@ -1,128 +1,141 @@ /* * Sherlock Library -- Miscellaneous Functions * - * (c) 1997 Martin Mares, + * (c) 1997--2004 Martin Mares + * + * This software may be freely distributed and used according to the terms + * of the GNU Lesser General Public License. + */ + +/* + * This file should be included as the very first include in all + * source files, especially before all OS includes since it sets + * up libc feature macros. */ #ifndef _SHERLOCK_LIB_H #define _SHERLOCK_LIB_H -#include - -/* Temporary Files */ - -#define TMP_DIR "tmp" -#define TMP_DIR_LEN 3 +#include "lib/config.h" +#include -struct tempfile { - int fh; - byte name[32]; -}; +/* Tell libc we're going to use all extensions available */ -void open_temp(struct tempfile *, byte *); -void delete_temp(struct tempfile *); -u32 temprand(uns); +#define _GNU_SOURCE -#define TF_GENERIC "t" -#define TF_QUEUE_CONTROL "c" -#define TF_QUEUE_DATA "d" -#define TF_DECODE "x" -#define TF_TRANSFORM "s" -#define TF_OBJECT "o" +/* Ugly structure handling macros */ -/* Config Files */ +#define OFFSETOF(s, i) ((unsigned int)&((s *)0)->i) +#define SKIP_BACK(s, i, p) ((s *)((char *)p - OFFSETOF(s, i))) +#define ALIGN(s, a) (((s)+a-1)&~(a-1)) +#define UNALIGNED_PART(ptr, type) (((long) (ptr)) % sizeof(type)) -struct cfitem { - byte *name; - int type; - void *var; -}; +/* Some other macros */ -#define CI_STOP 0 -#define CI_INT 1 -#define CI_STRING 2 -#define CI_FUNCTION 3 - -typedef byte *(*ci_func)(struct cfitem *, byte *); - -void cf_read(byte *, struct cfitem *); -int cf_read_err(byte *, struct cfitem *); /* Read with possible error, 1 = succeeded */ +#define MIN(a,b) (((a)<(b))?(a):(b)) +#define MAX(a,b) (((a)>(b))?(a):(b)) +#define CLAMP(x,min,max) ({ int _t=x; (_t < min) ? min : (_t > max) ? max : _t; }) +#define ABS(x) ((x) < 0 ? -(x) : (x)) +#define ARRAY_SIZE(a) (sizeof(a)/sizeof(*(a))) +#define STRINGIFY(x) #x +#define GLUE(x,y) x##y +#define GLUE_(x,y) x##_##y +#define COMPARE(x,y) do { if ((x)<(y)) return -1; if ((x)>(y)) return 1; } while(0) +#define REV_COMPARE(x,y) COMPARE(y,x) /* Logging */ -#define L_DEBUG "<0>" -#define L_INFO "<2>" -#define L_WARN "<4>" -#define L_ERROR "<6>" -#define L_FATAL "<9>" - -void log(byte *, ...); +#define L_DEBUG 'D' /* Debugging messages */ +#define L_INFO 'I' /* Informational msgs, warnings and errors */ +#define L_WARN 'W' +#define L_ERROR 'E' +#define L_INFO_R 'i' /* Errors caused by external events */ +#define L_WARN_R 'w' +#define L_ERROR_R 'e' +#define L_FATAL '!' /* die() */ + +extern char *log_title; /* NULL - print no title, default is log_progname */ +extern char *log_filename; /* Expanded name of the current log file */ +extern int log_switch_nest; /* log_switch() nesting counter, increment to disable automatic switches */ +extern int log_pid; /* 0 if shouldn't be logged */ +extern void (*log_die_hook)(void); +struct tm; +extern void (*log_switch_hook)(struct tm *tm); + +void log_msg(unsigned int cat, const char *msg, ...) __attribute__((format(printf,2,3))); +#define log log_msg +void vlog_msg(unsigned int cat, const char *msg, va_list args); void die(byte *, ...) NONRET; -void initlog(byte *); -void open_log_file(byte *); - -/* Allocation */ - -void *xmalloc(uns); -void *xrealloc(void *, uns); -byte *stralloc(byte *); - -/* Content-Type pattern matching and filters */ - -struct ct_filter; +void log_init(byte *argv0); +void log_file(byte *name); +void log_fork(void); +void log_switch(void); + +void assert_failed(char *assertion, char *file, int line) NONRET; +void assert_failed_noinfo(void) NONRET; + +#ifdef DEBUG_ASSERTS +#define ASSERT(x) do { if (unlikely(!(x))) assert_failed(#x, __FILE__, __LINE__); } while(0) +#else +#define ASSERT(x) do { if (__builtin_constant_p(x) && !(x)) assert_failed_noinfo(); } while(0) +#endif -int match_ct_patt(byte *, byte *); +#define COMPILE_ASSERT(name,x) typedef char _COMPILE_ASSERT_##name[!!(x)-1] -struct ct_filter *new_ct_filter(void); -byte *add_ct_filter(struct ct_filter *, byte *); -int match_ct_filter(struct ct_filter *, byte *); +#ifdef LOCAL_DEBUG +#define DBG(x,y...) log(L_DEBUG, x,##y) +#else +#define DBG(x,y...) do { } while(0) +#endif -/* Binary log */ +static inline void log_switch_disable(void) { log_switch_nest++; } +static inline void log_switch_enable(void) { ASSERT(log_switch_nest); log_switch_nest--; } -int log2(u32); +/* Memory allocation */ -/* obj.c */ +#define xmalloc sh_xmalloc +#define xrealloc sh_xrealloc +#define xfree sh_xfree -struct odes { /* Object description */ - struct oattr *attrs; - struct mempool *pool; -}; +#ifdef DEBUG_DMALLOC +/* + * The standard dmalloc macros tend to produce lots of namespace + * conflicts and we use only xmalloc and xfree, so we can define + * the stubs ourselves. + */ +#define DMALLOC_DISABLE +#include +#define sh_xmalloc(size) _xmalloc_leap(__FILE__, __LINE__, size) +#define sh_xrealloc(ptr,size) _xrealloc_leap(__FILE__, __LINE__, ptr, size) +#define sh_xfree(ptr) _xfree_leap(__FILE__, __LINE__, ptr) +#else +/* + * Unfortunately, several libraries we might want to link to define + * their own xmalloc and we don't want to interfere with them, hence + * the renaming. + */ +void *xmalloc(unsigned); +void *xrealloc(void *, unsigned); +#define sh_xfree(x) free(x) +#endif -struct oattr { /* Object attribute */ - struct oattr *next, *same; - byte attr; - byte val[1]; -}; +void *xmalloc_zero(unsigned); +byte *xstrdup(byte *); -void obj_dump(struct odes *); -struct odes *obj_fload(FILE *, byte *); -struct odes *obj_new(void); -struct odes *obj_load(byte *); -void obj_fwrite(FILE *, struct odes *); -void obj_write(byte *, struct odes *); -void obj_free(struct odes *); -struct oattr *find_attr(struct odes *, uns); -struct oattr *find_attr_last(struct odes *, uns); -uns del_attr(struct odes *, struct oattr *); -byte *find_aval(struct odes *, uns); -struct oattr *set_attr(struct odes *, uns, byte *); -struct oattr *set_attr_num(struct odes *, uns, uns); -struct oattr *add_attr(struct odes *, struct oattr *, uns, byte *); -struct oattr *prepend_attr(struct odes *, uns, byte *); +/* Content-Type pattern matching and filters */ -/* oname.c */ +int match_ct_patt(byte *, byte *); -#define OID_MIN 0x10000 /* Values less than this have special meaning */ +/* log2.c */ -oid_t new_oid(uns); -void mk_obj_name(byte *, oid_t, byte *); -int dump_obj_to_file(byte *, oid_t, struct odes *, int); +int fls(u32); /* wordsplit.c */ +int sepsplit(byte *str, byte sep, byte **rec, uns max); int wordsplit(byte *, byte **, uns); -/* pat(i)match.c */ +/* pat(i)match.c: Matching of shell patterns */ int match_pattern(byte *, byte *); int match_pattern_nocase(byte *, byte *); @@ -149,21 +162,68 @@ uns get_timer(void); typedef struct regex regex; -regex *rx_compile(byte *r); +regex *rx_compile(byte *r, int icase); void rx_free(regex *r); int rx_match(regex *r, byte *s); int rx_subst(regex *r, byte *by, byte *src, byte *dest, uns destlen); -/* objwalk.c */ - -void scan_obj_tree(byte *, void (*)(oid_t, byte *)); - /* random.c */ uns random_max(uns); /* mmap.c */ -void *mmap_file(byte *name, unsigned *len); +void *mmap_file(byte *name, unsigned *len, int writeable); +void munmap_file(void *start, unsigned len); + +/* partmap.c */ + +struct partmap; +struct partmap *partmap_open(byte *name, int writeable); +void *partmap_map(struct partmap *p, sh_off_t offset, uns size); +void partmap_close(struct partmap *p); +sh_off_t partmap_size(struct partmap *p); + +/* proctitle.c */ + +void setproctitle_init(int argc, char **argv); +void setproctitle(char *msg, ...) __attribute__((format(printf,1,2))); + +/* randomkey.c */ + +void randomkey(byte *buf, uns size); + +/* exitstatus.c */ + +#define EXIT_STATUS_MSG_SIZE 32 +int format_exit_status(byte *msg, int stat); + +/* runcmd.c */ + +int run_command(byte *cmd, ...); +void NONRET exec_command(byte *cmd, ...); +void echo_command(byte *buf, int size, byte *cmd, ...); +int run_command_v(byte *cmd, va_list args); +void NONRET exec_command_v(byte *cmd, va_list args); +void echo_command_v(byte *buf, int size, byte *cmd, va_list args); + +/* carefulio.c */ + +int careful_read(int fd, void *buf, int len); +int careful_write(int fd, void *buf, int len); + +/* sync.c */ + +void sync_dir(byte *name); + +/* sighandler.c */ + +typedef int (*sh_sighandler_t)(int); + /* obtains signum, returns nonzero if abort() should be called */ +extern sh_sighandler_t signal_handler[]; + +struct sigaction; +void handle_signal(int signum, struct sigaction *oldact); +void unhandle_signal(int signum, struct sigaction *oldact); #endif