src/common/torlog.h

   1 /* Copyright (c) 2001, Matej Pfajfar.
   2  * Copyright (c) 2001-2004, Roger Dingledine.
   3  * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
   4  * Copyright (c) 2007-2010, The Tor Project, Inc. */
   5 /* See LICENSE for licensing information */
   6
   7 /**
   8  * \file log.h
   9  *
  10  * \brief Headers for log.c
  11  **/
  12
  13 #ifndef _TOR_LOG_H
  14
  15 #include "compat.h"
  16
  17 #ifdef HAVE_SYSLOG_H
  18 #include <syslog.h>
  19 #define LOG_WARN LOG_WARNING
  20 #if LOG_DEBUG < LOG_ERR
  21 #error "Your syslog.h thinks high numbers are more important.  " \
  22        "We aren't prepared to deal with that."
  23 #endif
  24 #else
  25 /* Note: Syslog's logging code refers to priorities, with 0 being the most
  26  * important.  Thus, all our comparisons needed to be reversed when we added
  27  * syslog support.
  28  *
  29  * The upshot of this is that comments about log levels may be messed up: for
  30  * "maximum severity" read "most severe" and "numerically *lowest* severity".
  31  */
  32
  33 /** Debug-level severity: for hyper-verbose messages of no interest to
  34  * anybody but developers. */
  35 #define LOG_DEBUG   7
  36 /** Info-level severity: for messages that appear frequently during normal
  37  * operation. */
  38 #define LOG_INFO    6
  39 /** Notice-level severity: for messages that appear infrequently
  40  * during normal operation; that the user will probably care about;
  41  * and that are not errors.
  42  */
  43 #define LOG_NOTICE  5
  44 /** Warn-level severity: for messages that only appear when something has gone
  45  * wrong. */
  46 #define LOG_WARN    4
  47 /** Error-level severity: for messages that only appear when something has gone
  48  * very wrong, and the Tor process can no longer proceed. */
  49 #define LOG_ERR     3
  50 #endif
  51
  52 /* Logging domains */
  53
  54 /** Catch-all for miscellaneous events and fatal errors. */
  55 #define LD_GENERAL  (1u<<0)
  56 /** The cryptography subsystem. */
  57 #define LD_CRYPTO   (1u<<1)
  58 /** Networking. */
  59 #define LD_NET      (1u<<2)
  60 /** Parsing and acting on our configuration. */
  61 #define LD_CONFIG   (1u<<3)
  62 /** Reading and writing from the filesystem. */
  63 #define LD_FS       (1u<<4)
  64 /** Other servers' (non)compliance with the Tor protocol. */
  65 #define LD_PROTOCOL (1u<<5)
  66 /** Memory management. */
  67 #define LD_MM       (1u<<6)
  68 /** HTTP implementation. */
  69 #define LD_HTTP     (1u<<7)
  70 /** Application (socks) requests. */
  71 #define LD_APP      (1u<<8)
  72 /** Communication via the controller protocol. */
  73 #define LD_CONTROL  (1u<<9)
  74 /** Building, using, and managing circuits. */
  75 #define LD_CIRC     (1u<<10)
  76 /** Hidden services. */
  77 #define LD_REND     (1u<<11)
  78 /** Internal errors in this Tor process. */
  79 #define LD_BUG      (1u<<12)
  80 /** Learning and using information about Tor servers. */
  81 #define LD_DIR      (1u<<13)
  82 /** Learning and using information about Tor servers. */
  83 #define LD_DIRSERV  (1u<<14)
  84 /** Onion routing protocol. */
  85 #define LD_OR       (1u<<15)
  86 /** Generic edge-connection functionality. */
  87 #define LD_EDGE     (1u<<16)
  88 #define LD_EXIT     LD_EDGE
  89 /** Bandwidth accounting. */
  90 #define LD_ACCT     (1u<<17)
  91 /** Router history */
  92 #define LD_HIST     (1u<<18)
  93 /** OR handshaking */
  94 #define LD_HANDSHAKE (1u<<19)
  95 /** Number of logging domains in the code. */
  96 #define N_LOGGING_DOMAINS 20
  97
  98 typedef uint32_t log_domain_mask_t;
  99
 100 /** Configures which severities are logged for each logging domain for a given
 101  * log target. */
 102 typedef struct log_severity_list_t {
 103   /** For each log severity, a bitmask of which domains a given logger is
 104    * logging. */
 105   log_domain_mask_t masks[LOG_DEBUG-LOG_ERR+1];
 106 } log_severity_list_t;
 107
 108 #ifdef LOG_PRIVATE
 109 /** Given a severity, yields an index into log_severity_list_t.masks to use
 110  * for that severity. */
 111 #define SEVERITY_MASK_IDX(sev) ((sev) - LOG_ERR)
 112 #endif
 113
 114 /** Callback type used for add_callback_log. */
 115 typedef void (*log_callback)(int severity, uint32_t domain, const char *msg);
 116
 117 void init_logging(void);
 118 int parse_log_level(const char *level);
 119 const char *log_level_to_string(int level);
 120 int parse_log_severity_config(const char **cfg,
 121                               log_severity_list_t *severity_out);
 122 void set_log_severity_config(int minSeverity, int maxSeverity,
 123                              log_severity_list_t *severity_out);
 124 void add_stream_log(const log_severity_list_t *severity, const char *name,
 125                     int fd);
 126 int add_file_log(const log_severity_list_t *severity, const char *filename);
 127 #ifdef HAVE_SYSLOG_H
 128 int add_syslog_log(const log_severity_list_t *severity);
 129 #endif
 130 int add_callback_log(const log_severity_list_t *severity, log_callback cb);
 131 int get_min_log_level(void);
 132 void switch_logs_debug(void);
 133 void logs_free_all(void);
 134 void add_temp_log(int min_severity);
 135 void close_temp_logs(void);
 136 void rollback_log_changes(void);
 137 void mark_logs_temp(void);
 138 void change_callback_log_severity(int loglevelMin, int loglevelMax,
 139                                   log_callback cb);
 140 void log_set_application_name(const char *name);
 141
 142 /* Outputs a message to stdout */
 143 void tor_log(int severity, log_domain_mask_t domain, const char *format, ...)
 144   CHECK_PRINTF(3,4);
 145 #define log tor_log /* hack it so we don't conflict with log() as much */
 146
 147 #ifdef __GNUC__
 148 extern int _log_global_min_severity;
 149
 150 void _log_fn(int severity, log_domain_mask_t domain,
 151              const char *funcname, const char *format, ...)
 152   CHECK_PRINTF(4,5);
 153 /** Log a message at level <b>severity</b>, using a pretty-printed version
 154  * of the current function name. */
 155 #define log_fn(severity, domain, args...)               \
 156   _log_fn(severity, domain, __PRETTY_FUNCTION__, args)
 157 #define log_debug(domain, args...)                                      \
 158   STMT_BEGIN                                                            \
 159     if (PREDICT_UNLIKELY(_log_global_min_severity == LOG_DEBUG))        \
 160       _log_fn(LOG_DEBUG, domain, __PRETTY_FUNCTION__, args);            \
 161   STMT_END
 162 #define log_info(domain, args...)                           \
 163   _log_fn(LOG_INFO, domain, __PRETTY_FUNCTION__, args)
 164 #define log_notice(domain, args...)                         \
 165   _log_fn(LOG_NOTICE, domain, __PRETTY_FUNCTION__, args)
 166 #define log_warn(domain, args...)                           \
 167   _log_fn(LOG_WARN, domain, __PRETTY_FUNCTION__, args)
 168 #define log_err(domain, args...)                            \
 169   _log_fn(LOG_ERR, domain, __PRETTY_FUNCTION__, args)
 170
 171 #else /* ! defined(__GNUC__) */
 172
 173 void _log_fn(int severity, log_domain_mask_t domain, const char *format, ...);
 174 void _log_debug(log_domain_mask_t domain, const char *format, ...);
 175 void _log_info(log_domain_mask_t domain, const char *format, ...);
 176 void _log_notice(log_domain_mask_t domain, const char *format, ...);
 177 void _log_warn(log_domain_mask_t domain, const char *format, ...);
 178 void _log_err(log_domain_mask_t domain, const char *format, ...);
 179
 180 #if defined(_MSC_VER) && _MSC_VER < 1300
 181 /* MSVC 6 and earlier don't have __func__, or even __LINE__. */
 182 #define log_fn _log_fn
 183 #define log_debug _log_debug
 184 #define log_info _log_info
 185 #define log_notice _log_notice
 186 #define log_warn _log_warn
 187 #define log_err _log_err
 188 #else
 189 /* We don't have GCC's varargs macros, so use a global variable to pass the
 190  * function name to log_fn */
 191 extern const char *_log_fn_function_name;
 192 /* We abuse the comma operator here, since we can't use the standard
 193  * do {...} while (0) trick to wrap this macro, since the macro can't take
 194  * arguments. */
 195 #define log_fn (_log_fn_function_name=__func__),_log_fn
 196 #define log_debug (_log_fn_function_name=__func__),_log_debug
 197 #define log_info (_log_fn_function_name=__func__),_log_info
 198 #define log_notice (_log_fn_function_name=__func__),_log_notice
 199 #define log_warn (_log_fn_function_name=__func__),_log_warn
 200 #define log_err (_log_fn_function_name=__func__),_log_err
 201 #endif
 202
 203 #endif /* !GNUC */
 204
 205 # define _TOR_LOG_H
 206 #endif
 207