/*
* Sherlock Library -- Miscellaneous Functions
*
- * (c) 1997 Martin Mares, <mj@atrey.karlin.mff.cuni.cz>
+ * (c) 1997--2004 Martin Mares <mj@ucw.cz>
+ *
+ * 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 <lib/config.h>
+#include "lib/config.h"
-/* Temporary Files */
+/* Tell libc we're going to use all extensions available */
-#define TMP_DIR "tmp"
-#define TMP_DIR_LEN 3
+#define _GNU_SOURCE
-struct tempfile {
- int fh;
- byte name[32];
-};
+/* Ugly structure handling macros */
-void open_temp(struct tempfile *, byte *);
-void delete_temp(struct tempfile *);
-u32 temprand(uns);
+#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))
-#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"
+/* Some other macros */
-/* Config Files */
+#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)
-struct cfitem {
- byte *name;
- int type;
- void *var;
-};
+/* Logging */
-#define CI_STOP 0
-#define CI_INT 1
-#define CI_STRING 2
-#define CI_FUNCTION 3
+#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() */
-typedef byte *(*ci_func)(struct cfitem *, byte *);
+extern char *log_title; /* NULL - print no title, default is log_progname */
-void cf_read(byte *, struct cfitem *);
-int cf_read_err(byte *, struct cfitem *); /* Read with possible error, 1 = succeeded */
+void log_msg(unsigned int cat, const char *msg, ...) __attribute__((format(printf,2,3)));
+#define log log_msg
+void die(byte *, ...) NONRET;
+void log_init(byte *);
+void log_file(byte *);
+void log_fork(void);
+
+#ifdef DEBUG
+void assert_failed(char *assertion, char *file, int line) NONRET;
+#define ASSERT(x) do { if (unlikely(!(x))) assert_failed(#x, __FILE__, __LINE__); } while(0)
+#else
+void assert_failed(void) NONRET;
+#define ASSERT(x) do { if (__builtin_constant_p(x) && !(x)) assert_failed(); } while(0)
+#endif
-/* Logging */
+#define COMPILE_ASSERT(name,x) typedef char _COMPILE_ASSERT_##name[!!(x)-1]
-#define L_DEBUG "<0>"
-#define L_INFO "<2>"
-#define L_WARN "<4>"
-#define L_ERROR "<6>"
-#define L_FATAL "<9>"
+#ifdef LOCAL_DEBUG
+#define DBG(x,y...) log(L_DEBUG, x,##y)
+#else
+#define DBG(x,y...) do { } while(0)
+#endif
-void log(byte *, ...);
-void die(byte *, ...) NONRET;
-void initlog(byte *);
-void open_log_file(byte *);
+/* Memory allocation */
-/* Allocation */
+#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 <dmalloc.h>
+#define xmalloc(size) _xmalloc_leap(__FILE__, __LINE__, size)
+#define xrealloc(ptr,size) _xrealloc_leap(__FILE__, __LINE__, ptr, size)
+#define 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.
+ */
+#define xmalloc sh_xmalloc
+void *xmalloc(unsigned);
+void *xrealloc(void *, unsigned);
+#define xfree(x) free(x)
+#endif
-void *xmalloc(uns);
-void *xrealloc(void *, uns);
+void *xmalloc_zero(unsigned);
byte *stralloc(byte *);
/* Content-Type pattern matching and filters */
-struct ct_filter;
-
int match_ct_patt(byte *, byte *);
-struct ct_filter *new_ct_filter(void);
-byte *add_ct_filter(struct ct_filter *, byte *);
-int match_ct_filter(struct ct_filter *, byte *);
+/* log2.c */
-/* Binary log */
-
-int log2(u32);
-
-/* obj.c */
-
-struct odes { /* Object description */
- struct oattr *attrs;
- struct mempool *pool;
-};
-
-struct oattr { /* Object attribute */
- struct oattr *next, *same;
- byte attr;
- byte val[1];
-};
-
-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 *);
-
-/* oname.c */
-
-#define OID_MIN 0x10000 /* Values less than this have special meaning */
-
-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 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 *);
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);
#endif