123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422 |
- /* Copyright 2001,2002,2003 Roger Dingledine, Matej Pfajfar. */
- /* See LICENSE for licensing information */
- /* $Id$ */
- /**
- * \file log.c
- *
- * \brief Functions to send messages to log files or the console.
- */
- #include <stdarg.h>
- #include <assert.h>
- #include <stdlib.h>
- #include <string.h>
- #include "orconfig.h"
- #include "./util.h"
- #include "./log.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. */
- FILE *file; /**< Stream to receive log messages. */
- int needs_close; /**< Boolean: true if the stream gets closed on shutdown. */
- int loglevel; /**< Lowest severity level to send to this stream. */
- int max_loglevel; /**< Highest severity level to send to this stream. */
- 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. */
- } logfile_t;
- /** 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: assert(0); return "UNKNOWN";
- }
- }
- /** Linked list of logfile_t. */
- static logfile_t *logfiles = NULL;
- #ifdef HAVE_SYSLOG_H
- static int syslog_count = 0;
- #endif
- static void delete_log(logfile_t *victim);
- static void close_log(logfile_t *victim);
- static int reset_log(logfile_t *lf);
- static INLINE size_t
- _log_prefix(char *buf, size_t buf_len, int severity)
- {
- time_t t;
- struct timeval now;
- size_t n;
- int r;
- tor_gettimeofday(&now);
- t = (time_t)now.tv_sec;
- n = strftime(buf, buf_len, "%b %d %H:%M:%S", localtime(&t));
- r = tor_snprintf(buf+n, buf_len-n,
- ".%.3ld [%s] ",
- (long)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. **/
- static void 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;
- if (lf->is_temporary)
- /* If it's temporary, it isn't really a file. */
- return;
- is_new = (ftell(lf->file) == 0);
- if (reset && !is_new)
- /* We are resetting, but we aren't at the start of the file; no
- * need to log again. */
- return;
- n = _log_prefix(buf, sizeof(buf), LOG_NOTICE);
- tor_snprintf(buf+n, sizeof(buf)-n,
- "Tor %s opening %slog file.\n", VERSION, is_new?"new ":"");
- fputs(buf, lf->file);
- }
- /** 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,
- int severity, const char *funcname,
- const char *format, va_list ap)
- {
- size_t n;
- int r;
- char *end_of_prefix;
- 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) {
- r = tor_snprintf(buf+n, buf_len-n, "%s(): ", funcname);
- if (r<0)
- n = strlen(buf);
- else
- n += r;
- }
- r = tor_vsnprintf(buf+n,buf_len-n,format,ap);
- if(r < 0) {
- n = buf_len-2;
- strlcpy(buf+buf_len-TRUNCATED_STR_LEN-1, TRUNCATED_STR,
- buf_len-(buf_len-TRUNCATED_STR_LEN-1));
- } else {
- n += r;
- }
- buf[n]='\n';
- buf[n+1]='\0';
- 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, const char *funcname, const char *format, va_list ap)
- {
- char buf[10024];
- int formatted = 0;
- logfile_t *lf;
- char *end_of_prefix=NULL;
- assert(format);
- lf = logfiles;
- while(lf) {
- if (severity > lf->loglevel || severity < lf->max_loglevel) {
- lf = lf->next;
- continue;
- }
- if (! (lf->file || lf->is_syslog || lf->callback)) {
- lf = lf->next;
- continue;
- }
- if (!formatted) {
- end_of_prefix =
- format_msg(buf, sizeof(buf), severity, funcname, format, ap);
- formatted = 1;
- }
- if (lf->is_syslog) {
- #ifdef HAVE_SYSLOG_H
- syslog(severity, "%s", end_of_prefix);
- #endif
- lf = lf->next;
- continue;
- } else if (lf->callback) {
- lf->callback(severity, end_of_prefix);
- lf = lf->next;
- continue;
- }
- if(fputs(buf, lf->file) == EOF ||
- fflush(lf->file) == EOF) { /* error */
- /* don't log the error! Blow away this log entry and continue. */
- logfile_t *victim = lf;
- lf = victim->next;
- delete_log(victim);
- } else {
- lf = lf->next;
- }
- }
- }
- /** Output a message to the log. */
- void _log(int severity, const char *format, ...)
- {
- va_list ap;
- va_start(ap,format);
- logv(severity, NULL, format, ap);
- va_end(ap);
- }
- /** Output a message to the log, prefixed with a function name <b>fn</b>. */
- void _log_fn(int severity, const char *fn, const char *format, ...)
- {
- va_list ap;
- va_start(ap,format);
- logv(severity, fn, format, ap);
- va_end(ap);
- }
- /** Close all open log files. */
- void close_logs()
- {
- logfile_t *victim;
- while(logfiles) {
- victim = logfiles;
- logfiles = logfiles->next;
- close_log(victim);
- tor_free(victim->filename);
- tor_free(victim);
- }
- }
- /** Close and re-open all log files; used to rotate logs on SIGHUP. */
- void reset_logs()
- {
- logfile_t *lf = logfiles;
- while(lf) {
- if (reset_log(lf)) {
- /* error. don't log it. delete the log entry and continue. */
- logfile_t *victim = lf;
- lf = victim->next;
- delete_log(victim);
- continue;
- }
- lf = lf->next;
- }
- }
- /** Remove and free the log entry <b>victim</b> from the linked-list
- * logfiles (it must be present in the list when this function is
- * called). After this function is called, the caller shouldn't refer
- * to <b>victim</b> anymore.
- */
- 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);
- tmpl->next = victim->next;
- }
- tor_free(victim->filename);
- tor_free(victim);
- }
- static void close_log(logfile_t *victim)
- {
- if (victim->needs_close && victim->file) {
- fclose(victim->file);
- } else if (victim->is_syslog) {
- #ifdef HAVE_SYSLOG_H
- if (--syslog_count == 0)
- /* There are no other syslogs; close the logging facility. */
- closelog();
- #endif
- }
- }
- static int reset_log(logfile_t *lf)
- {
- if (lf->needs_close) {
- if(fclose(lf->file)==EOF ||
- !(lf->file = fopen(lf->filename, "a"))) {
- return -1;
- } else {
- log_tor_version(lf, 1);
- }
- }
- return 0;
- }
- /** Add a log handler to send all messages of severity <b>loglevel</b>
- * or higher to <b>stream</b>. */
- void add_stream_log(int loglevelMin, int loglevelMax, const char *name, FILE *stream)
- {
- logfile_t *lf;
- lf = tor_malloc_zero(sizeof(logfile_t));
- lf->filename = tor_strdup(name);
- lf->loglevel = loglevelMin;
- lf->max_loglevel = loglevelMax;
- lf->file = stream;
- lf->next = logfiles;
- logfiles = lf;
- }
- /** Add a log handler to receive messages during startup (before the real
- * logs are initialized).
- */
- void add_temp_log(void)
- {
- add_stream_log(LOG_INFO, LOG_ERR, "<temp>", stdout);
- logfiles->is_temporary = 1;
- }
- int add_callback_log(int loglevelMin, int loglevelMax, log_callback cb)
- {
- logfile_t *lf;
- lf = tor_malloc_zero(sizeof(logfile_t));
- lf->loglevel = loglevelMin;
- lf->max_loglevel = loglevelMax;
- lf->filename = tor_strdup("<callback>");
- lf->callback = cb;
- lf->next = logfiles;
- logfiles = lf;
- return 0;
- }
- /** Close any log handlers added by add_temp_log or marked by mark_logs_temp */
- void close_temp_logs(void)
- {
- logfile_t *lf, **p;
- for (p = &logfiles; *p; ) {
- if ((*p)->is_temporary) {
- lf = *p;
- *p = (*p)->next;
- close_log(lf);
- tor_free(lf->filename);
- tor_free(lf);
- } else {
- p = &((*p)->next);
- }
- }
- }
- /** Configure all log handles to be closed by close_temp_logs */
- void mark_logs_temp(void)
- {
- logfile_t *lf;
- for (lf = logfiles; lf; lf = lf->next)
- lf->is_temporary = 1;
- }
- /**
- * 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 fopen).
- */
- int add_file_log(int loglevelMin, int loglevelMax, const char *filename)
- {
- FILE *f;
- f = fopen(filename, "a");
- if (!f) return -1;
- add_stream_log(loglevelMin, loglevelMax, filename, f);
- logfiles->needs_close = 1;
- log_tor_version(logfiles, 0);
- return 0;
- }
- #ifdef HAVE_SYSLOG_H
- /**
- * Add a log handler to send messages to they system log facility.
- */
- int add_syslog_log(int loglevelMin, int loglevelMax)
- {
- logfile_t *lf;
- if (syslog_count++ == 0)
- /* This is the first syslog. */
- openlog("Tor", LOG_NDELAY, LOG_DAEMON);
- lf = tor_malloc_zero(sizeof(logfile_t));
- lf->loglevel = loglevelMin;
- lf->filename = tor_strdup("<syslog>");
- lf->max_loglevel = loglevelMax;
- lf->is_syslog = 1;
- lf->next = logfiles;
- logfiles = lf;
- 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;
- }
- const char *log_level_to_string(int level)
- {
- return sev_to_string(level);
- }
- int get_min_log_level(void)
- {
- logfile_t *lf;
- int min = LOG_ERR;
- for (lf = logfiles; lf; lf = lf->next) {
- if (lf->loglevel > min)
- min = lf->loglevel;
- }
- return min;
- }
- /*
- Local Variables:
- mode:c
- indent-tabs-mode:nil
- c-basic-offset:2
- End:
- */
|