log.h 11 KB

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