torlog.h 9.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  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-2017, 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 /* !(defined(HAVE_SYSLOG_H)) */
  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 /* defined(HAVE_SYSLOG_H) */
  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. /** Guard nodes */
  96. #define LD_GUARD (1u<<23)
  97. /** Generation and application of consensus diffs. */
  98. #define LD_CONSDIFF (1u<<24)
  99. /** Denial of Service mitigation. */
  100. #define LD_DOS (1u<<25)
  101. /** Number of logging domains in the code. */
  102. #define N_LOGGING_DOMAINS 26
  103. /** This log message is not safe to send to a callback-based logger
  104. * immediately. Used as a flag, not a log domain. */
  105. #define LD_NOCB (1u<<31)
  106. /** This log message should not include a function name, even if it otherwise
  107. * would. Used as a flag, not a log domain. */
  108. #define LD_NOFUNCNAME (1u<<30)
  109. #ifdef TOR_UNIT_TESTS
  110. /** This log message should not be intercepted by mock_saving_logv */
  111. #define LD_NO_MOCK (1u<<29)
  112. #endif
  113. /** Mask of zero or more log domains, OR'd together. */
  114. typedef uint32_t log_domain_mask_t;
  115. /** Configures which severities are logged for each logging domain for a given
  116. * log target. */
  117. typedef struct log_severity_list_t {
  118. /** For each log severity, a bitmask of which domains a given logger is
  119. * logging. */
  120. log_domain_mask_t masks[LOG_DEBUG-LOG_ERR+1];
  121. } log_severity_list_t;
  122. /** Callback type used for add_callback_log. */
  123. typedef void (*log_callback)(int severity, uint32_t domain, const char *msg);
  124. void init_logging(int disable_startup_queue);
  125. int parse_log_level(const char *level);
  126. const char *log_level_to_string(int level);
  127. int parse_log_severity_config(const char **cfg,
  128. log_severity_list_t *severity_out);
  129. void set_log_severity_config(int minSeverity, int maxSeverity,
  130. log_severity_list_t *severity_out);
  131. void add_stream_log(const log_severity_list_t *severity, const char *name,
  132. int fd);
  133. int add_file_log(const log_severity_list_t *severity, const char *filename,
  134. const int truncate);
  135. #ifdef HAVE_SYSLOG_H
  136. int add_syslog_log(const log_severity_list_t *severity,
  137. const char* syslog_identity_tag);
  138. #endif // HAVE_SYSLOG_H.
  139. #ifdef HAVE_ANDROID_LOG_H
  140. int add_android_log(const log_severity_list_t *severity,
  141. const char *android_identity_tag);
  142. #endif // HAVE_ANDROID_LOG_H.
  143. int add_callback_log(const log_severity_list_t *severity, log_callback cb);
  144. void logs_set_domain_logging(int enabled);
  145. int get_min_log_level(void);
  146. void switch_logs_debug(void);
  147. void logs_free_all(void);
  148. void add_temp_log(int min_severity);
  149. void close_temp_logs(void);
  150. void rollback_log_changes(void);
  151. void mark_logs_temp(void);
  152. void change_callback_log_severity(int loglevelMin, int loglevelMax,
  153. log_callback cb);
  154. void flush_pending_log_callbacks(void);
  155. void flush_log_messages_from_startup(void);
  156. void log_set_application_name(const char *name);
  157. void set_log_time_granularity(int granularity_msec);
  158. void truncate_logs(void);
  159. void tor_log(int severity, log_domain_mask_t domain, const char *format, ...)
  160. CHECK_PRINTF(3,4);
  161. void tor_log_err_sigsafe(const char *m, ...);
  162. int tor_log_get_sigsafe_err_fds(const int **out);
  163. void tor_log_update_sigsafe_err_fds(void);
  164. struct smartlist_t;
  165. void tor_log_get_logfile_names(struct smartlist_t *out);
  166. extern int log_global_min_severity_;
  167. void log_fn_(int severity, log_domain_mask_t domain,
  168. const char *funcname, const char *format, ...)
  169. CHECK_PRINTF(4,5);
  170. struct ratelim_t;
  171. void log_fn_ratelim_(struct ratelim_t *ratelim, int severity,
  172. log_domain_mask_t domain, const char *funcname,
  173. const char *format, ...)
  174. CHECK_PRINTF(5,6);
  175. #if defined(__GNUC__) && __GNUC__ <= 3
  176. /* These are the GCC varidaic macros, so that older versions of GCC don't
  177. * break. */
  178. /** Log a message at level <b>severity</b>, using a pretty-printed version
  179. * of the current function name. */
  180. #define log_fn(severity, domain, args...) \
  181. log_fn_(severity, domain, __FUNCTION__, args)
  182. /** As log_fn, but use <b>ratelim</b> (an instance of ratelim_t) to control
  183. * the frequency at which messages can appear.
  184. */
  185. #define log_fn_ratelim(ratelim, severity, domain, args...) \
  186. log_fn_ratelim_(ratelim, severity, domain, __FUNCTION__, args)
  187. #define log_debug(domain, args...) \
  188. STMT_BEGIN \
  189. if (PREDICT_UNLIKELY(log_global_min_severity_ == LOG_DEBUG)) \
  190. log_fn_(LOG_DEBUG, domain, __FUNCTION__, args); \
  191. STMT_END
  192. #define log_info(domain, args...) \
  193. log_fn_(LOG_INFO, domain, __FUNCTION__, args)
  194. #define log_notice(domain, args...) \
  195. log_fn_(LOG_NOTICE, domain, __FUNCTION__, args)
  196. #define log_warn(domain, args...) \
  197. log_fn_(LOG_WARN, domain, __FUNCTION__, args)
  198. #define log_err(domain, args...) \
  199. log_fn_(LOG_ERR, domain, __FUNCTION__, args)
  200. #else /* !(defined(__GNUC__) && __GNUC__ <= 3) */
  201. /* Here are the c99 variadic macros, to work with non-GCC compilers */
  202. #define log_debug(domain, args, ...) \
  203. STMT_BEGIN \
  204. if (PREDICT_UNLIKELY(log_global_min_severity_ == LOG_DEBUG)) \
  205. log_fn_(LOG_DEBUG, domain, __FUNCTION__, args, ##__VA_ARGS__); \
  206. STMT_END
  207. #define log_info(domain, args,...) \
  208. log_fn_(LOG_INFO, domain, __FUNCTION__, args, ##__VA_ARGS__)
  209. #define log_notice(domain, args,...) \
  210. log_fn_(LOG_NOTICE, domain, __FUNCTION__, args, ##__VA_ARGS__)
  211. #define log_warn(domain, args,...) \
  212. log_fn_(LOG_WARN, domain, __FUNCTION__, args, ##__VA_ARGS__)
  213. #define log_err(domain, args,...) \
  214. log_fn_(LOG_ERR, domain, __FUNCTION__, args, ##__VA_ARGS__)
  215. /** Log a message at level <b>severity</b>, using a pretty-printed version
  216. * of the current function name. */
  217. #define log_fn(severity, domain, args,...) \
  218. log_fn_(severity, domain, __FUNCTION__, args, ##__VA_ARGS__)
  219. /** As log_fn, but use <b>ratelim</b> (an instance of ratelim_t) to control
  220. * the frequency at which messages can appear.
  221. */
  222. #define log_fn_ratelim(ratelim, severity, domain, args,...) \
  223. log_fn_ratelim_(ratelim, severity, domain, __FUNCTION__, \
  224. args, ##__VA_ARGS__)
  225. #endif /* defined(__GNUC__) && __GNUC__ <= 3 */
  226. #ifdef LOG_PRIVATE
  227. MOCK_DECL(STATIC void, logv, (int severity, log_domain_mask_t domain,
  228. const char *funcname, const char *suffix, const char *format,
  229. va_list ap) CHECK_PRINTF(5,0));
  230. #endif
  231. # define TOR_TORLOG_H
  232. #endif /* !defined(TOR_TORLOG_H) */