X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=lib%2Flib.h;h=c58d83da573283fa5385a6a4dab61123bc789be9;hb=fa390094c968bc3b07f7af64edaddb7e773c3b04;hp=2fb56d95e552a8a6a2beba1e9e3c5507a8174da1;hpb=1571781022499a9d0c32d249f89945d034d1cbff;p=libucw.git

diff --git a/lib/lib.h b/lib/lib.h
index 2fb56d95..c58d83da 100644
--- a/lib/lib.h
+++ b/lib/lib.h
@@ -1,7 +1,10 @@
 /*
  *	Sherlock Library -- Miscellaneous Functions
  *
- *	(c) 1997--2000 Martin Mares <mj@ucw.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.
  */
 
 /*
@@ -14,83 +17,120 @@
 #define _SHERLOCK_LIB_H
 
 #include "lib/config.h"
+#include <stdarg.h>
 
 /* Tell libc we're going to use all extensions available */
 
 #define _GNU_SOURCE
 
-#ifndef NULL
-#define NULL ((void *)0)
-#endif
-
 /* Ugly structure handling macros */
 
 #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))
 
-/* Temporary Files */
+/* Some other macros */
 
-#define TMP_DIR "tmp"
-#define TMP_DIR_LEN 3
+#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 tempfile {
-  int fh;
-  byte name[32];
-};
+/* Logging */
 
-void open_temp(struct tempfile *, byte *);
-void delete_temp(struct tempfile *);
-u32 temprand(uns);
+#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 log_init(byte *argv0);
+void log_file(byte *name);
+void log_fork(void);
+void log_switch(void);
 
-/* FIXME: Remove? */
-#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"
+#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]
 
-/* FIXME: Define new logging mechanism? */
+#ifdef LOCAL_DEBUG
+#define DBG(x,y...) log(L_DEBUG, x,##y)
+#else
+#define DBG(x,y...) do { } while(0)
+#endif
 
-#define L_DEBUG "<0>"
-#define L_INFO "<2>"
-#define L_WARN "<4>"
-#define L_ERROR "<6>"
-#define L_FATAL "<9>"
+static inline void log_switch_disable(void) { log_switch_nest++; }
+static inline void log_switch_enable(void) { ASSERT(log_switch_nest); log_switch_nest--; }
 
-void log(byte *, ...);
-void die(byte *, ...) NONRET;
-void initlog(byte *);
-void open_log_file(byte *);
+/* Memory allocation */
 
-#ifdef DEBUG
-#define ASSERT(x) do { if (!(x)) die("Assertion `%s' failed at %s:%d", #x, __FILE__, __LINE__); } while(0)
+#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
-#define ASSERT(x) do { } while(0)
+/*
+ * 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
 
-/* Allocation */
-
-void *xmalloc(uns);
-void *xrealloc(void *, uns);
-byte *stralloc(byte *);
+void *xmalloc_zero(unsigned);
+byte *xstrdup(byte *);
 
 /* Content-Type pattern matching and filters */
 
 int match_ct_patt(byte *, byte *);
 
-/* Binary log */
+/* log2.c */
 
-int log2(u32);
+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 *);
@@ -117,7 +157,7 @@ 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);
@@ -128,6 +168,53 @@ 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);
+
+/* 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