torlog.h 9.2 KB

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