X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=ucw%2Flog.c;h=31252c9ee2b0f1f083d6eb2bfb29d3b06c9a8e17;hb=31316f76dd68a03b803f51931d6e1fff2c60c5d1;hp=44be63023fe36da9964725f0e14bec6d737cd711;hpb=464a5c3067d1fbed8e2f9899e8e3459e7948e07e;p=libucw.git diff --git a/ucw/log.c b/ucw/log.c index 44be6302..31252c9e 100644 --- a/ucw/log.c +++ b/ucw/log.c @@ -10,6 +10,7 @@ #include "ucw/lib.h" #include "ucw/log.h" +#include "ucw/log-internal.h" #include "ucw/simple-lists.h" #include @@ -21,227 +22,305 @@ #include #include -static char log_progname[32]; char *log_title; int log_pid; void (*log_die_hook)(void); -// FIXME: duplicate? -static int ls_default_handler(struct log_stream* ls, const char *m, u32 cat UNUSED) +static void NONRET do_die(void); + +/*** The default log stream, which logs to stderr ***/ + +static int default_log_handler(struct log_stream *ls UNUSED, struct log_msg *m) { - int len = strlen(m); - int r = write(ls->idata, m, len); - /* TODO: check the errors here? */ - if (r!=len) - return errno; + // This is a completely bare version of the log-file module. Errors are ignored. + write(2, m->m, m->m_len); return 0; } -/* the default logger */ -const struct log_stream ls_default_log={ - .name = "fd2", .idata = 2, .pdata = NULL, .regnum = 0, - .handler = ls_default_handler, - .levels = LS_ALL_LEVELS, +struct log_stream log_stream_default = { + .name = "stderr", + .use_count = 1000000, + .handler = default_log_handler, + .levels = ~0U, + .types = ~0U, .msgfmt = LSFMT_DEFAULT, - // empty clist - .substreams.head.next = (cnode *) &ls_default_log.substreams.head, - .substreams.head.prev = (cnode *) &ls_default_log.substreams.head, + // an empty clist + .substreams.head = { + .next = (cnode *) &log_stream_default.substreams.head, + .prev = (cnode *) &log_stream_default.substreams.head, + }, }; /*** Registry of streams and their identifiers ***/ -/* The growing array of pointers to log_streams. */ -struct lsbuf_t log_streams; +struct lsbuf_t log_streams; /* A growing array of pointers to log_streams */ +int log_streams_after = 0; /* The first never-used index in log_streams.ptr */ -/* the first never-used index in ls_streams.ptr */ -int log_streams_after = 0; +/* + * Find a stream by its identifier given as LS_SET_STRNUM(flags). + * Returns NULL if the stream doesn't exist or it's invalid. + * + * If the log-stream machinery has not been initialized (which is normal for programs + * with no fancy logging), the log_streams gbuf is empty and this function only + * translates stream #0 to the static log_stream_default. + */ -/* get a stream by its LS_SET_STRNUM() */ -/* returns NULL for free/invalid numbers */ -/* defaults to ls_default_stream when stream number 0 closed */ -struct log_stream *log_stream_by_flags(uns flags) +struct log_stream * +log_stream_by_flags(uns flags) { - /* get the real number */ int n = LS_GET_STRNUM(flags); - if ((n<0) || (n>=log_streams_after) || (log_streams.ptr[n]->regnum==-1) ) - { - if (n==0) - return (struct log_stream *)&ls_default_log; - else - return NULL; - } + if (n < 0 || n >= log_streams_after || log_streams.ptr[n]->regnum == -1) + return (n ? NULL : &log_stream_default); return log_streams.ptr[n]; } +/*** Known message types ***/ + +char **log_type_names; + +char * +log_type_name(uns flags) +{ + uns type = LS_GET_TYPE(flags); + + if (!log_type_names || !log_type_names[type]) + return "default"; + else + return log_type_names[type]; +} + /*** Logging ***/ -void vmsg(unsigned int cat, const char *fmt, va_list args) +void +vmsg(uns cat, const char *fmt, va_list args) { struct timeval tv; - int have_tm = 0; struct tm tm; va_list args2; char stime[24]; char sutime[12]; - char *buf,*p; + char msgbuf[256]; + char *p; int len; - struct log_stream *ls=log_stream_by_flags(cat); - - /* Check the stream existence */ - if(!ls) + uns sighandler = cat & L_SIGHANDLER; + struct log_stream *ls; + struct log_msg m = { .flags = cat }; + + /* Find the destination stream */ + if (sighandler) + ls = &log_stream_default; + else if (!(ls = log_stream_by_flags(cat))) { - msg((LS_INTERNAL_MASK&cat)|L_WARN, "No log_stream with number %d! Logging to the default log.", - LS_GET_STRNUM(cat)); - ls=(struct log_stream *)&ls_default_log; + msg((LS_CTRL_MASK&cat)|L_WARN, "No log_stream with number %d! Logging to the default log.", LS_GET_STRNUM(cat)); + ls = &log_stream_default; } - /* get the time */ - if (!(cat&LSFLAG_SIGHANDLER)) + /* Get the current time */ + if (!sighandler) { /* CAVEAT: These calls are not safe in signal handlers. */ gettimeofday(&tv, NULL); + m.tv = &tv; if (localtime_r(&tv.tv_sec, &tm)) - have_tm = 1; + m.tm = &tm; } - /* generate time strings */ - if (have_tm) + /* Generate time strings */ + if (m.tm) { - strftime(stime, 24, "%Y-%m-%d %H:%M:%S", &tm); - snprintf(sutime, 12, ".%06d", (int)tv.tv_usec); + strftime(stime, sizeof(stime), "%Y-%m-%d %H:%M:%S", &tm); + snprintf(sutime, sizeof(sutime), ".%06d", (int)tv.tv_usec); + m.stime = stime; + m.sutime = sutime; } else { - snprintf(stime, 24, "\?\?\?\?-\?\?-\?\? \?\?:\?\?:\?\?"); - snprintf(sutime, 12, ".\?\?\?\?\?\?"); + m.stime = "\?\?\?\?-\?\?-\?\? \?\?:\?\?:\?\?"; + m.sutime = ".\?\?\?\?\?\?"; } - /* generate the message string */ + /* Generate the message string */ va_copy(args2, args); - /* WARN: this may be C99 specefic */ - len = vsnprintf(NULL, 0, fmt, args2); + len = vsnprintf(msgbuf, sizeof(msgbuf), fmt, args2); va_end(args2); - buf = xmalloc(len+2); - vsnprintf(buf, len+1, fmt, args); + if (len < (int) sizeof(msgbuf) || sighandler) + m.raw_msg = msgbuf; + else + { + m.raw_msg = xmalloc(len+1); + vsnprintf(m.raw_msg, len+1, fmt, args); + } - /* remove non-printable characters and newlines */ - p=buf; + /* Remove non-printable characters and newlines */ + p = m.raw_msg; while (*p) { - if (*p < 0x20 && *p != '\t') + if (*p >= 0 && *p < 0x20 && *p != '\t') *p = 0x7f; p++; } - /* pass the message to the log_stream */ - if(ls_passmsg(0, ls, stime, sutime, buf, cat)) + /* Pass the message to the log_stream */ + if (log_pass_msg(0, ls, &m)) { - /* error (such as looping) occured */ - ls_passmsg(0, (struct log_stream *)&ls_default_log, stime, sutime, buf, cat); + /* Error (such as infinite loop) occurred */ + log_pass_msg(0, &log_stream_default, &m); } - xfree(buf); + if (m.raw_msg != msgbuf) + xfree(m.raw_msg); } -/* process a message (string) */ -/* depth prevents undetected looping */ -/* returns 1 in case of loop detection or other fatal error - * 0 otherwise */ -int ls_passmsg(int depth, struct log_stream *ls, const char *stime, const char *sutime, const char *m, u32 cat) +static void +log_report_err(struct log_stream *ls, struct log_msg *m, int err) +{ + if (m->flags & L_LOGGER_ERR) + return; + if (ls->stream_flags & LSFLAG_ERR_REPORTED) + return; + ls->stream_flags |= LSFLAG_ERR_REPORTED; + + struct log_msg errm = *m; + char errbuf[128]; + char *name = (ls->name ? : ""); + + errm.flags = ((ls->stream_flags & LSFLAG_ERR_IS_FATAL) ? L_FATAL : L_ERROR); + errm.flags |= L_LOGGER_ERR | (m->flags & LS_CTRL_MASK); + errm.raw_msg = errbuf; + if (err == EDEADLK) + snprintf(errbuf, sizeof(errbuf), "Error logging to %s: Maximum nesting level of log streams exceeded", name); + else + { + errno = err; + snprintf(errbuf, sizeof(errbuf), "Error logging to %s: %m", name); + } + log_pass_msg(0, &log_stream_default, &errm); + + if (ls->stream_flags & LSFLAG_ERR_IS_FATAL) + do_die(); +} + +/* Maximal depth of log_pass_msg recursion */ +#define LS_MAX_DEPTH 64 + +int +log_pass_msg(int depth, struct log_stream *ls, struct log_msg *m) { ASSERT(ls); /* Check recursion depth */ - if( depth > LS_MAX_DEPTH ) + if (depth > LS_MAX_DEPTH) { - ls_passmsg(0, (struct log_stream *)&ls_default_log, stime, sutime, - "Loop in the log_stream system detected.", L_ERROR | (cat&LS_INTERNAL_MASK) ); + log_report_err(ls, m, EDEADLK); return 1; } - /* Filter by level and filter hook */ - if(!( (1<levels )) return 0; - if( ls->filter ) - if( ls->filter(ls, m, cat) != 0 ) return 0; + /* Filter by level, type and hook function */ + if (!((1 << LS_GET_LEVEL(m->flags)) & ls->levels) || + !((1 << LS_GET_TYPE(m->flags)) & ls->types) || + ls->filter && ls->filter(ls, m)) + return 0; - /* pass message to substreams */ + /* Pass the message to substreams */ CLIST_FOR_EACH(simp_node *, s, ls->substreams) + if (log_pass_msg(depth+1, s->p, m)) + return 1; + + /* Will pass to the handler of this stream... is there any? */ + if (!ls->handler) + return 0; + + /* Will print a message type? */ + char *type = NULL; + if ((ls->msgfmt & LSFMT_TYPE) && LS_GET_TYPE(m->flags)) + type = log_type_name(m->flags); + + /* Upper bound on message length */ + int len = strlen(m->raw_msg) + strlen(m->stime) + strlen(m->sutime) + 32; + if (log_title) + len += strlen(log_title); + if (ls->name) + len += strlen(ls->name); + if (type) + len += strlen(type) + 3; + + /* Get a buffer and format the message */ + char *free_buf = NULL; + if (len <= 256 || (m->flags & L_SIGHANDLER)) + m->m = alloca(len); + else + m->m = free_buf = xmalloc(len); + char *p = m->m; + + /* Level (2 chars) */ + if (ls->msgfmt & LSFMT_LEVEL) { - if (ls_passmsg(depth+1, (struct log_stream*)(s->p), stime, sutime, m, cat)) - return 1; + *p++ = LS_LEVEL_LETTER(LS_GET_LEVEL(m->flags)); + *p++ = ' '; } - /* Prepare for handler */ - if(ls->handler) + /* Time (|stime| + |sutime| + 1 chars) */ + if (ls->msgfmt & LSFMT_TIME) { - int len = strlen(m) + strlen(stime) + strlen(sutime) + 32; - /* SHOULD be enough for all information, but beware */ - if (log_title) len += strlen(log_title); - if (ls->name) len += strlen(ls->name); - char *buf=xmalloc(len); - char *p=buf; - - /* Level (2 chars) */ - if(ls->msgfmt & LSFMT_LEVEL) - { - *p++=LS_LEVEL_LETTER(LS_GET_LEVEL(cat)); - *p++=' '; - } - - /* Time (|stime| + |sutime| + 1 chars) */ - if(ls->msgfmt & LSFMT_TIME) + const char *q = m->stime; + while (*q) + *p++ = *q++; + if (ls->msgfmt & LSFMT_USEC) { - char *q = (char *)stime; - - while(*q) - *p++=*q++; - if(ls->msgfmt & LSFMT_USEC) - { - q = (char *)sutime; - while(*q) - *p++=*q++; - } - *p++=' '; + q = m->sutime; + while (*q) + *p++ = *q++; } + *p++ = ' '; + } - /* process name, PID ( |log_title| + 6 + (|PID|<=10) chars ) */ - if((ls->msgfmt & LSFMT_TITLE) && log_title) - { - if(ls->msgfmt & LSFMT_PID) - p += sprintf(p, "[%s (%d)] ", log_title, getpid()); - else - p += sprintf(p, "[%s] ", log_title); - } + /* Process name, PID ( |log_title| + 6 + (|PID|<=10) chars ) */ + if ((ls->msgfmt & LSFMT_TITLE) && log_title) + { + if ((ls->msgfmt & LSFMT_PID) && log_pid) + p += sprintf(p, "[%s (%d)] ", log_title, log_pid); else - { - if(ls->msgfmt & LSFMT_PID) - p += sprintf(p, "[%d] ", getpid()); - } + p += sprintf(p, "[%s] ", log_title); + } + else + { + if ((ls->msgfmt & LSFMT_PID) && log_pid) + p += sprintf(p, "[%d] ", log_pid); + } - /* log_stream name ( |ls->name| + 4 chars ) */ - if(ls->msgfmt & LSFMT_LOGNAME) - { - if(ls->name) - p += sprintf(p, "<%s> ", ls->name); - else - p += sprintf(p, " "); - } + /* log_stream name ( |ls->name| + 4 chars ) */ + if (ls->msgfmt & LSFMT_LOGNAME) + { + if (ls->name) + p += sprintf(p, "<%s> ", ls->name); + else + p += sprintf(p, " "); + } - /* finish the string and call the handler ( |m| + 1 chars ) */ - { - char *q = (char *)m; + /* Message type ( |type| + 3 chars ) */ + if (type) + p += sprintf(p, "{%s} ", type); - while(*q) - *p++=*q++; - *p++ = '\n'; - *p++ = '\0'; - ls->handler(ls, buf, cat); - } - xfree(buf); + /* The message itself ( |m| + 1 chars ) */ + { + const char *q = m->raw_msg; + while (*q) + *p++ = *q++; + *p++ = '\n'; + *p = '\0'; + m->m_len = p - m->m; + int err = ls->handler(ls, m); + if (err) + log_report_err(ls, m, err); } + + if (free_buf) + xfree(free_buf); return 0; } +/*** Utility functions ***/ + void msg(unsigned int cat, const char *fmt, ...) { @@ -252,16 +331,9 @@ msg(unsigned int cat, const char *fmt, ...) va_end(args); } -void -die(const char *fmt, ...) +static void NONRET +do_die(void) { - va_list args; - - va_start(args, fmt); - vmsg(L_FATAL, fmt, args); - va_end(args); - if (log_die_hook) - log_die_hook(); #ifdef DEBUG_DIE_BY_ABORT abort(); #else @@ -269,6 +341,23 @@ die(const char *fmt, ...) #endif } +void +vdie(const char *fmt, va_list args) +{ + vmsg(L_FATAL, fmt, args); + if (log_die_hook) + log_die_hook(); + do_die(); +} + +void +die(const char *fmt, ...) +{ + va_list args; + va_start(args, fmt); + vdie(fmt, args); +} + void assert_failed(const char *assertion, const char *file, int line) { @@ -298,18 +387,38 @@ log_init(const char *argv0) { if (argv0) { + static char log_progname[32]; strncpy(log_progname, log_basename(argv0), sizeof(log_progname)-1); log_progname[sizeof(log_progname)-1] = 0; log_title = log_progname; } } +void +log_fork(void) +{ + log_pid = getpid(); +} + #ifdef TEST +#include + int main(void) { - // ls_default_log.msgfmt |= LSFMT_USEC; - msg(L_INFO, "Brum!"); + int type = log_find_type("foo"); + ASSERT(type < 0); + type = log_register_type("foo"); + + struct log_stream *ls = log_new_syslog("local3", 0); +#if 0 + log_add_substream(ls, ls); + ls->stream_flags |= LSFLAG_ERR_IS_FATAL; +#endif + msg(L_INFO | ls->regnum, "Brum <%300s>", ":-)"); + log_set_format(log_default_stream(), ~0U, LSFMT_USEC | LSFMT_TYPE); + msg(L_INFO | type, "Brum <%300s>", ":-)"); + log_close_all(); return 0; }