log.h
上传用户:awang829
上传日期:2019-07-14
资源大小:2356k
文件大小:8k
源码类别:

网络

开发平台:

Unix_Linux

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