123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960 |
- /* Copyright (c) 2001, Matej Pfajfar.
- * Copyright (c) 2001-2004, Roger Dingledine.
- * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
- * Copyright (c) 2007-2010, The Tor Project, Inc. */
- /* See LICENSE for licensing information */
- /**
- * \file log.c
- * \brief Functions to send messages to log files or the console.
- **/
- #include "orconfig.h"
- #include <stdarg.h>
- #include <assert.h>
- // #include <stdio.h>
- #include <stdlib.h>
- #include <string.h>
- #ifdef HAVE_SYS_TIME_H
- #include <sys/time.h>
- #endif
- #ifdef HAVE_TIME_H
- #include <time.h>
- #endif
- #ifdef HAVE_UNISTD_H
- #include <unistd.h>
- #endif
- #ifdef HAVE_SYS_TYPES_H
- #include <sys/types.h>
- #endif
- #ifdef HAVE_FCNTL_H
- #include <fcntl.h>
- #endif
- #include "compat.h"
- #include "util.h"
- #define LOG_PRIVATE
- #include "torlog.h"
- #include "container.h"
- #define TRUNCATED_STR "[...truncated]"
- #define TRUNCATED_STR_LEN 14
- /** Information for a single logfile; only used in log.c */
- typedef struct logfile_t {
- struct logfile_t *next; /**< Next logfile_t in the linked list. */
- char *filename; /**< Filename to open. */
- int fd; /**< fd to receive log messages, or -1 for none. */
- int seems_dead; /**< Boolean: true if the stream seems to be kaput. */
- int needs_close; /**< Boolean: true if the stream gets closed on shutdown. */
- int is_temporary; /**< Boolean: close after initializing logging subsystem.*/
- int is_syslog; /**< Boolean: send messages to syslog. */
- log_callback callback; /**< If not NULL, send messages to this function. */
- log_severity_list_t *severities; /**< Which severity of messages should we
- * log for each log domain? */
- } logfile_t;
- static void log_free(logfile_t *victim);
- /** Helper: map a log severity to descriptive string. */
- static INLINE const char *
- sev_to_string(int severity)
- {
- switch (severity) {
- case LOG_DEBUG: return "debug";
- case LOG_INFO: return "info";
- case LOG_NOTICE: return "notice";
- case LOG_WARN: return "warn";
- case LOG_ERR: return "err";
- default: /* Call assert, not tor_assert, since tor_assert
- * calls log on failure. */
- assert(0); return "UNKNOWN";
- }
- }
- /** Helper: decide whether to include the function name in the log message. */
- static INLINE int
- should_log_function_name(log_domain_mask_t domain, int severity)
- {
- switch (severity) {
- case LOG_DEBUG:
- case LOG_INFO:
- /* All debugging messages occur in interesting places. */
- return 1;
- case LOG_NOTICE:
- case LOG_WARN:
- case LOG_ERR:
- /* We care about places where bugs occur. */
- return (domain == LD_BUG);
- default:
- /* Call assert, not tor_assert, since tor_assert calls log on failure. */
- assert(0); return 0;
- }
- }
- /** A mutex to guard changes to logfiles and logging. */
- static tor_mutex_t log_mutex;
- static int log_mutex_initialized = 0;
- /** Linked list of logfile_t. */
- static logfile_t *logfiles = NULL;
- #ifdef HAVE_SYSLOG_H
- /** The number of open syslog log handlers that we have. When this reaches 0,
- * we can close our connection to the syslog facility. */
- static int syslog_count = 0;
- #endif
- #define LOCK_LOGS() STMT_BEGIN \
- tor_mutex_acquire(&log_mutex); \
- STMT_END
- #define UNLOCK_LOGS() STMT_BEGIN tor_mutex_release(&log_mutex); STMT_END
- /** What's the lowest log level anybody cares about? Checking this lets us
- * bail out early from log_debug if we aren't debugging. */
- int _log_global_min_severity = LOG_NOTICE;
- static void delete_log(logfile_t *victim);
- static void close_log(logfile_t *victim);
- /** Name of the application: used to generate the message we write at the
- * start of each new log. */
- static char *appname = NULL;
- /** Set the "application name" for the logs to <b>name</b>: we'll use this
- * name in the message we write when starting up, and at the start of each new
- * log.
- *
- * Tor uses this string to write the version number to the log file. */
- void
- log_set_application_name(const char *name)
- {
- tor_free(appname);
- appname = name ? tor_strdup(name) : NULL;
- }
- /** Helper: Write the standard prefix for log lines to a
- * <b>buf_len</b> character buffer in <b>buf</b>.
- */
- static INLINE size_t
- _log_prefix(char *buf, size_t buf_len, int severity)
- {
- time_t t;
- struct timeval now;
- struct tm tm;
- size_t n;
- int r;
- tor_gettimeofday(&now);
- t = (time_t)now.tv_sec;
- n = strftime(buf, buf_len, "%b %d %H:%M:%S", tor_localtime_r(&t, &tm));
- r = tor_snprintf(buf+n, buf_len-n, ".%.3i [%s] ",
- (int)now.tv_usec / 1000, sev_to_string(severity));
- if (r<0)
- return buf_len-1;
- else
- return n+r;
- }
- /** If lf refers to an actual file that we have just opened, and the file
- * contains no data, log an "opening new logfile" message at the top.
- *
- * Return -1 if the log is broken and needs to be deleted, else return 0.
- */
- static int
- log_tor_version(logfile_t *lf, int reset)
- {
- char buf[256];
- size_t n;
- int is_new;
- if (!lf->needs_close)
- /* If it doesn't get closed, it isn't really a file. */
- return 0;
- if (lf->is_temporary)
- /* If it's temporary, it isn't really a file. */
- return 0;
- is_new = lf->fd >= 0 && tor_fd_getpos(lf->fd) == 0;
- if (reset && !is_new)
- /* We are resetting, but we aren't at the start of the file; no
- * need to log again. */
- return 0;
- n = _log_prefix(buf, sizeof(buf), LOG_NOTICE);
- if (appname) {
- tor_snprintf(buf+n, sizeof(buf)-n,
- "%s opening %slog file.\n", appname, is_new?"new ":"");
- } else {
- tor_snprintf(buf+n, sizeof(buf)-n,
- "Tor %s opening %slog file.\n", VERSION, is_new?"new ":"");
- }
- if (write_all(lf->fd, buf, strlen(buf), 0) < 0) /* error */
- return -1; /* failed */
- return 0;
- }
- /** Helper: Format a log message into a fixed-sized buffer. (This is
- * factored out of <b>logv</b> so that we never format a message more
- * than once.) Return a pointer to the first character of the message
- * portion of the formatted string.
- */
- static INLINE char *
- format_msg(char *buf, size_t buf_len,
- log_domain_mask_t domain, int severity, const char *funcname,
- const char *format, va_list ap, size_t *msg_len_out)
- {
- size_t n;
- int r;
- char *end_of_prefix;
- assert(buf_len >= 2); /* prevent integer underflow */
- buf_len -= 2; /* subtract 2 characters so we have room for \n\0 */
- n = _log_prefix(buf, buf_len, severity);
- end_of_prefix = buf+n;
- if (funcname && should_log_function_name(domain, severity)) {
- r = tor_snprintf(buf+n, buf_len-n, "%s(): ", funcname);
- if (r<0)
- n = strlen(buf);
- else
- n += r;
- }
- if (domain == LD_BUG && buf_len-n > 6) {
- memcpy(buf+n, "Bug: ", 6);
- n += 5;
- }
- r = tor_vsnprintf(buf+n,buf_len-n,format,ap);
- if (r < 0) {
- /* The message was too long; overwrite the end of the buffer with
- * "[...truncated]" */
- if (buf_len >= TRUNCATED_STR_LEN) {
- size_t offset = buf_len-TRUNCATED_STR_LEN;
- /* We have an extra 2 characters after buf_len to hold the \n\0,
- * so it's safe to add 1 to the size here. */
- strlcpy(buf+offset, TRUNCATED_STR, buf_len-offset+1);
- }
- /* Set 'n' to the end of the buffer, where we'll be writing \n\0.
- * Since we already subtracted 2 from buf_len, this is safe.*/
- n = buf_len;
- } else {
- n += r;
- }
- buf[n]='\n';
- buf[n+1]='\0';
- *msg_len_out = n+1;
- return end_of_prefix;
- }
- /** Helper: sends a message to the appropriate logfiles, at loglevel
- * <b>severity</b>. If provided, <b>funcname</b> is prepended to the
- * message. The actual message is derived as from tor_snprintf(format,ap).
- */
- static void
- logv(int severity, log_domain_mask_t domain, const char *funcname,
- const char *format, va_list ap)
- {
- char buf[10024];
- size_t msg_len = 0;
- int formatted = 0;
- logfile_t *lf;
- char *end_of_prefix=NULL;
- /* Call assert, not tor_assert, since tor_assert calls log on failure. */
- assert(format);
- /* check that severity is sane. Overrunning the masks array leads to
- * interesting and hard to diagnose effects */
- assert(severity >= LOG_ERR && severity <= LOG_DEBUG);
- LOCK_LOGS();
- lf = logfiles;
- while (lf) {
- if (! (lf->severities->masks[SEVERITY_MASK_IDX(severity)] & domain)) {
- lf = lf->next;
- continue;
- }
- if (! (lf->fd >= 0 || lf->is_syslog || lf->callback)) {
- lf = lf->next;
- continue;
- }
- if (lf->seems_dead) {
- lf = lf->next;
- continue;
- }
- if (!formatted) {
- end_of_prefix =
- format_msg(buf, sizeof(buf), domain, severity, funcname, format, ap,
- &msg_len);
- formatted = 1;
- }
- if (lf->is_syslog) {
- #ifdef HAVE_SYSLOG_H
- char *m = end_of_prefix;
- #ifdef MAXLINE
- /* Some syslog implementations have limits on the length of what you can
- * pass them, and some very old ones do not detect overflow so well.
- * Regrettably, they call their maximum line length MAXLINE. */
- #if MAXLINE < 64
- #warn "MAXLINE is a very low number; it might not be from syslog.h after all"
- #endif
- if (msg_len >= MAXLINE)
- m = tor_strndup(end_of_prefix, MAXLINE-1);
- #endif
- syslog(severity, "%s", m);
- #ifdef MAXLINE
- if (m != end_of_prefix) {
- tor_free(m);
- }
- #endif
- #endif
- lf = lf->next;
- continue;
- } else if (lf->callback) {
- lf->callback(severity, domain, end_of_prefix);
- lf = lf->next;
- continue;
- }
- if (write_all(lf->fd, buf, msg_len, 0) < 0) { /* error */
- /* don't log the error! mark this log entry to be blown away, and
- * continue. */
- lf->seems_dead = 1;
- }
- lf = lf->next;
- }
- UNLOCK_LOGS();
- }
- /** Output a message to the log. */
- void
- tor_log(int severity, log_domain_mask_t domain, const char *format, ...)
- {
- va_list ap;
- if (severity > _log_global_min_severity)
- return;
- va_start(ap,format);
- logv(severity, domain, NULL, format, ap);
- va_end(ap);
- }
- /** Output a message to the log, prefixed with a function name <b>fn</b>. */
- #ifdef __GNUC__
- void
- _log_fn(int severity, log_domain_mask_t domain, const char *fn,
- const char *format, ...)
- {
- va_list ap;
- if (severity > _log_global_min_severity)
- return;
- va_start(ap,format);
- logv(severity, domain, fn, format, ap);
- va_end(ap);
- }
- #else
- const char *_log_fn_function_name=NULL;
- void
- _log_fn(int severity, log_domain_mask_t domain, const char *format, ...)
- {
- va_list ap;
- if (severity > _log_global_min_severity)
- return;
- va_start(ap,format);
- logv(severity, domain, _log_fn_function_name, format, ap);
- va_end(ap);
- _log_fn_function_name = NULL;
- }
- void
- _log_debug(log_domain_mask_t domain, const char *format, ...)
- {
- va_list ap;
- /* For GCC we do this check in the macro. */
- if (PREDICT_LIKELY(LOG_DEBUG > _log_global_min_severity))
- return;
- va_start(ap,format);
- logv(LOG_DEBUG, domain, _log_fn_function_name, format, ap);
- va_end(ap);
- _log_fn_function_name = NULL;
- }
- void
- _log_info(log_domain_mask_t domain, const char *format, ...)
- {
- va_list ap;
- if (LOG_INFO > _log_global_min_severity)
- return;
- va_start(ap,format);
- logv(LOG_INFO, domain, _log_fn_function_name, format, ap);
- va_end(ap);
- _log_fn_function_name = NULL;
- }
- void
- _log_notice(log_domain_mask_t domain, const char *format, ...)
- {
- va_list ap;
- if (LOG_NOTICE > _log_global_min_severity)
- return;
- va_start(ap,format);
- logv(LOG_NOTICE, domain, _log_fn_function_name, format, ap);
- va_end(ap);
- _log_fn_function_name = NULL;
- }
- void
- _log_warn(log_domain_mask_t domain, const char *format, ...)
- {
- va_list ap;
- if (LOG_WARN > _log_global_min_severity)
- return;
- va_start(ap,format);
- logv(LOG_WARN, domain, _log_fn_function_name, format, ap);
- va_end(ap);
- _log_fn_function_name = NULL;
- }
- void
- _log_err(log_domain_mask_t domain, const char *format, ...)
- {
- va_list ap;
- if (LOG_ERR > _log_global_min_severity)
- return;
- va_start(ap,format);
- logv(LOG_ERR, domain, _log_fn_function_name, format, ap);
- va_end(ap);
- _log_fn_function_name = NULL;
- }
- #endif
- /** Free all storage held by <b>victim</b>. */
- static void
- log_free(logfile_t *victim)
- {
- if (!victim)
- return;
- tor_free(victim->severities);
- tor_free(victim->filename);
- tor_free(victim);
- }
- /** Close all open log files, and free other static memory. */
- void
- logs_free_all(void)
- {
- logfile_t *victim, *next;
- LOCK_LOGS();
- next = logfiles;
- logfiles = NULL;
- UNLOCK_LOGS();
- while (next) {
- victim = next;
- next = next->next;
- close_log(victim);
- log_free(victim);
- }
- tor_free(appname);
- /* We _could_ destroy the log mutex here, but that would screw up any logs
- * that happened between here and the end of execution. */
- }
- /** Remove and free the log entry <b>victim</b> from the linked-list
- * logfiles (it is probably present, but it might not be due to thread
- * racing issues). After this function is called, the caller shouldn't
- * refer to <b>victim</b> anymore.
- *
- * Long-term, we need to do something about races in the log subsystem
- * in general. See bug 222 for more details.
- */
- static void
- delete_log(logfile_t *victim)
- {
- logfile_t *tmpl;
- if (victim == logfiles)
- logfiles = victim->next;
- else {
- for (tmpl = logfiles; tmpl && tmpl->next != victim; tmpl=tmpl->next) ;
- // tor_assert(tmpl);
- // tor_assert(tmpl->next == victim);
- if (!tmpl)
- return;
- tmpl->next = victim->next;
- }
- log_free(victim);
- }
- /** Helper: release system resources (but not memory) held by a single
- * logfile_t. */
- static void
- close_log(logfile_t *victim)
- {
- if (victim->needs_close && victim->fd >= 0) {
- close(victim->fd);
- victim->fd = -1;
- } else if (victim->is_syslog) {
- #ifdef HAVE_SYSLOG_H
- if (--syslog_count == 0) {
- /* There are no other syslogs; close the logging facility. */
- closelog();
- }
- #endif
- }
- }
- /** Adjust a log severity configuration in <b>severity_out</b> to contain
- * every domain between <b>loglevelMin</b> and <b>loglevelMax</b>, inclusive.
- */
- void
- set_log_severity_config(int loglevelMin, int loglevelMax,
- log_severity_list_t *severity_out)
- {
- int i;
- tor_assert(loglevelMin >= loglevelMax);
- tor_assert(loglevelMin >= LOG_ERR && loglevelMin <= LOG_DEBUG);
- tor_assert(loglevelMax >= LOG_ERR && loglevelMax <= LOG_DEBUG);
- memset(severity_out, 0, sizeof(log_severity_list_t));
- for (i = loglevelMin; i >= loglevelMax; --i) {
- severity_out->masks[SEVERITY_MASK_IDX(i)] = ~0u;
- }
- }
- /** Add a log handler named <b>name</b> to send all messages in <b>severity</b>
- * to <b>fd</b>. Copies <b>severity</b>. Helper: does no locking. */
- static void
- add_stream_log_impl(const log_severity_list_t *severity,
- const char *name, int fd)
- {
- logfile_t *lf;
- lf = tor_malloc_zero(sizeof(logfile_t));
- lf->fd = fd;
- lf->filename = tor_strdup(name);
- lf->severities = tor_memdup(severity, sizeof(log_severity_list_t));
- lf->next = logfiles;
- logfiles = lf;
- _log_global_min_severity = get_min_log_level();
- }
- /** Add a log handler named <b>name</b> to send all messages in <b>severity</b>
- * to <b>fd</b>. Steals a reference to <b>severity</b>; the caller must
- * not use it after calling this function. */
- void
- add_stream_log(const log_severity_list_t *severity,
- const char *name, int fd)
- {
- LOCK_LOGS();
- add_stream_log_impl(severity, name, fd);
- UNLOCK_LOGS();
- }
- /** Initialize the global logging facility */
- void
- init_logging(void)
- {
- if (!log_mutex_initialized) {
- tor_mutex_init(&log_mutex);
- log_mutex_initialized = 1;
- }
- }
- /** Add a log handler to receive messages during startup (before the real
- * logs are initialized).
- */
- void
- add_temp_log(int min_severity)
- {
- log_severity_list_t *s = tor_malloc_zero(sizeof(log_severity_list_t));
- set_log_severity_config(min_severity, LOG_ERR, s);
- LOCK_LOGS();
- add_stream_log_impl(s, "<temp>", fileno(stdout));
- tor_free(s);
- logfiles->is_temporary = 1;
- UNLOCK_LOGS();
- }
- /**
- * Add a log handler to send messages in <b>severity</b>
- * to the function <b>cb</b>.
- */
- int
- add_callback_log(const log_severity_list_t *severity, log_callback cb)
- {
- logfile_t *lf;
- lf = tor_malloc_zero(sizeof(logfile_t));
- lf->fd = -1;
- lf->severities = tor_memdup(severity, sizeof(log_severity_list_t));
- lf->filename = tor_strdup("<callback>");
- lf->callback = cb;
- lf->next = logfiles;
- LOCK_LOGS();
- logfiles = lf;
- _log_global_min_severity = get_min_log_level();
- UNLOCK_LOGS();
- return 0;
- }
- /** Adjust the configured severity of any logs whose callback function is
- * <b>cb</b>. */
- void
- change_callback_log_severity(int loglevelMin, int loglevelMax,
- log_callback cb)
- {
- logfile_t *lf;
- log_severity_list_t severities;
- set_log_severity_config(loglevelMin, loglevelMax, &severities);
- LOCK_LOGS();
- for (lf = logfiles; lf; lf = lf->next) {
- if (lf->callback == cb) {
- memcpy(lf->severities, &severities, sizeof(severities));
- }
- }
- _log_global_min_severity = get_min_log_level();
- UNLOCK_LOGS();
- }
- /** Close any log handlers added by add_temp_log() or marked by
- * mark_logs_temp(). */
- void
- close_temp_logs(void)
- {
- logfile_t *lf, **p;
- LOCK_LOGS();
- for (p = &logfiles; *p; ) {
- if ((*p)->is_temporary) {
- lf = *p;
- /* we use *p here to handle the edge case of the head of the list */
- *p = (*p)->next;
- close_log(lf);
- log_free(lf);
- } else {
- p = &((*p)->next);
- }
- }
- _log_global_min_severity = get_min_log_level();
- UNLOCK_LOGS();
- }
- /** Make all currently temporary logs (set to be closed by close_temp_logs)
- * live again, and close all non-temporary logs. */
- void
- rollback_log_changes(void)
- {
- logfile_t *lf;
- LOCK_LOGS();
- for (lf = logfiles; lf; lf = lf->next)
- lf->is_temporary = ! lf->is_temporary;
- UNLOCK_LOGS();
- close_temp_logs();
- }
- /** Configure all log handles to be closed by close_temp_logs(). */
- void
- mark_logs_temp(void)
- {
- logfile_t *lf;
- LOCK_LOGS();
- for (lf = logfiles; lf; lf = lf->next)
- lf->is_temporary = 1;
- UNLOCK_LOGS();
- }
- /**
- * Add a log handler to send messages to <b>filename</b>. If opening the
- * logfile fails, -1 is returned and errno is set appropriately (by open(2)).
- */
- int
- add_file_log(const log_severity_list_t *severity, const char *filename)
- {
- int fd;
- logfile_t *lf;
- fd = open(filename, O_WRONLY|O_CREAT|O_APPEND, 0644);
- if (fd<0)
- return -1;
- if (tor_fd_seekend(fd)<0)
- return -1;
- LOCK_LOGS();
- add_stream_log_impl(severity, filename, fd);
- logfiles->needs_close = 1;
- lf = logfiles;
- _log_global_min_severity = get_min_log_level();
- if (log_tor_version(lf, 0) < 0) {
- delete_log(lf);
- }
- UNLOCK_LOGS();
- return 0;
- }
- #ifdef HAVE_SYSLOG_H
- /**
- * Add a log handler to send messages to they system log facility.
- */
- int
- add_syslog_log(const log_severity_list_t *severity)
- {
- logfile_t *lf;
- if (syslog_count++ == 0)
- /* This is the first syslog. */
- openlog("Tor", LOG_PID | LOG_NDELAY, LOGFACILITY);
- lf = tor_malloc_zero(sizeof(logfile_t));
- lf->fd = -1;
- lf->severities = tor_memdup(severity, sizeof(log_severity_list_t));
- lf->filename = tor_strdup("<syslog>");
- lf->is_syslog = 1;
- LOCK_LOGS();
- lf->next = logfiles;
- logfiles = lf;
- _log_global_min_severity = get_min_log_level();
- UNLOCK_LOGS();
- return 0;
- }
- #endif
- /** If <b>level</b> is a valid log severity, return the corresponding
- * numeric value. Otherwise, return -1. */
- int
- parse_log_level(const char *level)
- {
- if (!strcasecmp(level, "err"))
- return LOG_ERR;
- if (!strcasecmp(level, "warn"))
- return LOG_WARN;
- if (!strcasecmp(level, "notice"))
- return LOG_NOTICE;
- if (!strcasecmp(level, "info"))
- return LOG_INFO;
- if (!strcasecmp(level, "debug"))
- return LOG_DEBUG;
- return -1;
- }
- /** Return the string equivalent of a given log level. */
- const char *
- log_level_to_string(int level)
- {
- return sev_to_string(level);
- }
- /** NULL-terminated array of names for log domains such that domain_list[dom]
- * is a description of <b>dom</b>. */
- static const char *domain_list[] = {
- "GENERAL", "CRYPTO", "NET", "CONFIG", "FS", "PROTOCOL", "MM",
- "HTTP", "APP", "CONTROL", "CIRC", "REND", "BUG", "DIR", "DIRSERV",
- "OR", "EDGE", "ACCT", "HIST", "HANDSHAKE", NULL
- };
- /** Return a bitmask for the log domain for which <b>domain</b> is the name,
- * or 0 if there is no such name. */
- static log_domain_mask_t
- parse_log_domain(const char *domain)
- {
- int i;
- for (i=0; domain_list[i]; ++i) {
- if (!strcasecmp(domain, domain_list[i]))
- return (1u<<i);
- }
- return 0;
- }
- #if 0
- /** Translate a bitmask of log domains to a string, or NULL if the bitmask
- * is undecodable. */
- static const char *
- domain_to_string(log_domain_mask_t domain)
- {
- int bit = tor_log2(domain);
- if ((bit == 0 && domain == 0) || bit >= N_LOGGING_DOMAINS)
- return NULL;
- return domain_list[bit];
- }
- #endif
- /** Parse a log severity pattern in *<b>cfg_ptr</b>. Advance cfg_ptr after
- * the end of the severityPattern. Set the value of <b>severity_out</b> to
- * the parsed pattern. Return 0 on success, -1 on failure.
- *
- * The syntax for a SeverityPattern is:
- * <pre>
- * SeverityPattern = *(DomainSeverity SP)* DomainSeverity
- * DomainSeverity = (DomainList SP)? SeverityRange
- * SeverityRange = MinSeverity ("-" MaxSeverity )?
- * DomainList = "[" (SP? DomainSpec SP? ",") SP? DomainSpec "]"
- * DomainSpec = "*" | Domain | "~" Domain
- * </pre>
- * A missing MaxSeverity defaults to ERR. Severities and domains are
- * case-insensitive. "~" indicates negation for a domain; negation happens
- * last inside a DomainList. Only one SeverityRange without a DomainList is
- * allowed per line.
- */
- int
- parse_log_severity_config(const char **cfg_ptr,
- log_severity_list_t *severity_out)
- {
- const char *cfg = *cfg_ptr;
- int got_anything = 0;
- int got_an_unqualified_range = 0;
- memset(severity_out, 0, sizeof(*severity_out));
- cfg = eat_whitespace(cfg);
- while (*cfg) {
- const char *dash, *space;
- char *sev_lo, *sev_hi;
- int low, high, i;
- log_domain_mask_t domains = ~0u;
- if (*cfg == '[') {
- int err = 0;
- char *domains_str;
- smartlist_t *domains_list;
- log_domain_mask_t neg_domains = 0;
- const char *closebracket = strchr(cfg, ']');
- if (!closebracket)
- return -1;
- domains = 0;
- domains_str = tor_strndup(cfg+1, closebracket-cfg-1);
- domains_list = smartlist_create();
- smartlist_split_string(domains_list, domains_str, ",", SPLIT_SKIP_SPACE,
- -1);
- tor_free(domains_str);
- SMARTLIST_FOREACH(domains_list, const char *, domain,
- {
- if (!strcmp(domain, "*")) {
- domains = ~0u;
- } else {
- int d;
- int negate=0;
- if (*domain == '~') {
- negate = 1;
- ++domain;
- }
- d = parse_log_domain(domain);
- if (!d) {
- log_warn(LD_CONFIG, "No such logging domain as %s", domain);
- err = 1;
- } else {
- if (negate)
- neg_domains |= d;
- else
- domains |= d;
- }
- }
- });
- SMARTLIST_FOREACH(domains_list, char *, d, tor_free(d));
- smartlist_free(domains_list);
- if (err)
- return -1;
- domains &= ~neg_domains;
- cfg = eat_whitespace(closebracket+1);
- } else {
- ++got_an_unqualified_range;
- }
- if (!strcasecmpstart(cfg, "file") ||
- !strcasecmpstart(cfg, "stderr") ||
- !strcasecmpstart(cfg, "stdout") ||
- !strcasecmpstart(cfg, "syslog")) {
- goto done;
- }
- if (got_an_unqualified_range > 1)
- return -1;
- space = strchr(cfg, ' ');
- dash = strchr(cfg, '-');
- if (!space)
- space = strchr(cfg, '\0');
- if (dash && dash < space) {
- sev_lo = tor_strndup(cfg, dash-cfg);
- sev_hi = tor_strndup(dash+1, space-(dash+1));
- } else {
- sev_lo = tor_strndup(cfg, space-cfg);
- sev_hi = tor_strdup("ERR");
- }
- low = parse_log_level(sev_lo);
- high = parse_log_level(sev_hi);
- tor_free(sev_lo);
- tor_free(sev_hi);
- if (low == -1)
- return -1;
- if (high == -1)
- return -1;
- got_anything = 1;
- for (i=low; i >= high; --i)
- severity_out->masks[SEVERITY_MASK_IDX(i)] |= domains;
- cfg = eat_whitespace(space);
- }
- done:
- *cfg_ptr = cfg;
- return got_anything ? 0 : -1;
- }
- /** Return the least severe log level that any current log is interested in. */
- int
- get_min_log_level(void)
- {
- logfile_t *lf;
- int i;
- int min = LOG_ERR;
- for (lf = logfiles; lf; lf = lf->next) {
- for (i = LOG_DEBUG; i > min; --i)
- if (lf->severities->masks[SEVERITY_MASK_IDX(i)])
- min = i;
- }
- return min;
- }
- /** Switch all logs to output at most verbose level. */
- void
- switch_logs_debug(void)
- {
- logfile_t *lf;
- int i;
- LOCK_LOGS();
- for (lf = logfiles; lf; lf=lf->next) {
- for (i = LOG_DEBUG; i >= LOG_ERR; --i)
- lf->severities->masks[SEVERITY_MASK_IDX(i)] = ~0u;
- }
- _log_global_min_severity = get_min_log_level();
- UNLOCK_LOGS();
- }
- #if 0
- static void
- dump_log_info(logfile_t *lf)
- {
- const char *tp;
- if (lf->filename) {
- printf("=== log into \"%s\" (%s-%s) (%stemporary)\n", lf->filename,
- sev_to_string(lf->min_loglevel),
- sev_to_string(lf->max_loglevel),
- lf->is_temporary?"":"not ");
- } else if (lf->is_syslog) {
- printf("=== syslog (%s-%s) (%stemporary)\n",
- sev_to_string(lf->min_loglevel),
- sev_to_string(lf->max_loglevel),
- lf->is_temporary?"":"not ");
- } else {
- printf("=== log (%s-%s) (%stemporary)\n",
- sev_to_string(lf->min_loglevel),
- sev_to_string(lf->max_loglevel),
- lf->is_temporary?"":"not ");
- }
- }
- void
- describe_logs(void)
- {
- logfile_t *lf;
- printf("==== BEGIN LOGS ====\n");
- for (lf = logfiles; lf; lf = lf->next)
- dump_log_info(lf);
- printf("==== END LOGS ====\n");
- }
- #endif
|