One Level Up Top Level

src/core/ngx_log.h - nginx

Data types defined

Functions defined

Macros defined

Source code


  2. /*
  3. * Copyright (C) Igor Sysoev
  4. * Copyright (C) Nginx, Inc.
  5. */


  8. #ifndef _NGX_LOG_H_INCLUDED_
  9. ‌#define _NGX_LOG_H_INCLUDED_


  12. #include <ngx_config.h>
  13. #include <ngx_core.h>


  16. ‌#define NGX_LOG_STDERR            0
  17. ‌#define NGX_LOG_EMERG             1
  18. ‌#define NGX_LOG_ALERT             2
  19. ‌#define NGX_LOG_CRIT              3
  20. ‌#define NGX_LOG_ERR               4
  21. ‌#define NGX_LOG_WARN              5
  22. ‌#define NGX_LOG_NOTICE            6
  23. ‌#define NGX_LOG_INFO              7
  24. ‌#define NGX_LOG_DEBUG             8

  26. ‌#define NGX_LOG_DEBUG_CORE        0x010
  27. ‌#define NGX_LOG_DEBUG_ALLOC       0x020
  28. ‌#define NGX_LOG_DEBUG_MUTEX       0x040
  29. ‌#define NGX_LOG_DEBUG_EVENT       0x080
  30. ‌#define NGX_LOG_DEBUG_HTTP        0x100
  31. ‌#define NGX_LOG_DEBUG_MAIL        0x200
  32. ‌#define NGX_LOG_DEBUG_STREAM      0x400

  34. /*
  35. * do not forget to update debug_levels[] in src/core/ngx_log.c
  36. * after the adding a new debug level
  37. */

  39. ‌#define NGX_LOG_DEBUG_FIRST       NGX_LOG_DEBUG_CORE
  40. ‌#define NGX_LOG_DEBUG_LAST        NGX_LOG_DEBUG_STREAM
  41. ‌#define NGX_LOG_DEBUG_CONNECTION  0x80000000
  42. ‌#define NGX_LOG_DEBUG_ALL         0x7ffffff0


  45. ‌typedef u_char *(*ngx_log_handler_pt) (ngx_log_t *log, u_char *buf, size_t len);
  46. ‌typedef void (*ngx_log_writer_pt) (ngx_log_t *log, ngx_uint_t level,
  47.     u_char *buf, size_t len);


  50. ‌struct ngx_log_s {
  51.     ngx_uint_t           log_level;
  52.     ngx_open_file_t     *file;

  54.     ngx_atomic_uint_t    connection;

  56.     time_t               disk_full_time;

  58.     ngx_log_handler_pt   handler;
  59.     void                *data;

  61.     ngx_log_writer_pt    writer;
  62.     void                *wdata;

  64.     /*
  65.      * we declare "action" as "char *" because the actions are usually
  66.      * the static strings and in the "u_char *" case we have to override
  67.      * their types all the time
  68.      */

  70.     char                *action;

  72.     ngx_log_t           *next;

  74.     NGX_COMPAT_BEGIN(5)
  75.     NGX_COMPAT_END
  76. };


  79. ‌#define NGX_MAX_ERROR_STR   2048


  82. /*********************************/

  84. #if (NGX_HAVE_C99_VARIADIC_MACROS)

  86. ‌#define NGX_HAVE_VARIADIC_MACROS  1

  88. ‌#define ngx_log_error(level, log, ...)                                        \
  89.     if ((log)->log_level >= level) ngx_log_error_core(level, log, __VA_ARGS__)

  91. void ngx_log_error_core(ngx_uint_t level, ngx_log_t *log, ngx_err_t err,
  92.     const char *fmt, ...);

  94. ‌#define ngx_log_debug(level, log, ...)                                        \
  95.     if ((log)->log_level & level)                                             \
  96.         ngx_log_error_core(NGX_LOG_DEBUG, log, __VA_ARGS__)

  98. /*********************************/

  100. #elif (NGX_HAVE_GCC_VARIADIC_MACROS)

  102. ‌#define NGX_HAVE_VARIADIC_MACROS  1

  104. ‌#define ngx_log_error(level, log, args...)                                    \
  105.     if ((log)->log_level >= level) ngx_log_error_core(level, log, args)

  107. void ngx_log_error_core(ngx_uint_t level, ngx_log_t *log, ngx_err_t err,
  108.     const char *fmt, ...);

  110. ‌#define ngx_log_debug(level, log, args...)                                    \
  111.     if ((log)->log_level & level)                                             \
  112.         ngx_log_error_core(NGX_LOG_DEBUG, log, args)

  114. /*********************************/

  116. #else /* no variadic macros */

  118. ‌#define NGX_HAVE_VARIADIC_MACROS  0

  120. void ngx_cdecl ngx_log_error(ngx_uint_t level, ngx_log_t *log, ngx_err_t err,
  121.     const char *fmt, ...);
  122. void ngx_log_error_core(ngx_uint_t level, ngx_log_t *log, ngx_err_t err,
  123.     const char *fmt, va_list args);
  124. void ngx_cdecl ngx_log_debug_core(ngx_log_t *log, ngx_err_t err,
  125.     const char *fmt, ...);


  128. #endif /* variadic macros */


  131. /*********************************/

  133. #if (NGX_DEBUG)

  135. #if (NGX_HAVE_VARIADIC_MACROS)

  137. ‌#define ngx_log_debug0(level, log, err, fmt)                                  \
  138.         ngx_log_debug(level, log, err, fmt)

  140. ‌#define ngx_log_debug1(level, log, err, fmt, arg1)                            \
  141.         ngx_log_debug(level, log, err, fmt, arg1)

  143. ‌#define ngx_log_debug2(level, log, err, fmt, arg1, arg2)                      \
  144.         ngx_log_debug(level, log, err, fmt, arg1, arg2)

  146. ‌#define ngx_log_debug3(level, log, err, fmt, arg1, arg2, arg3)                \
  147.         ngx_log_debug(level, log, err, fmt, arg1, arg2, arg3)

  149. ‌#define ngx_log_debug4(level, log, err, fmt, arg1, arg2, arg3, arg4)          \
  150.         ngx_log_debug(level, log, err, fmt, arg1, arg2, arg3, arg4)

  152. ‌#define ngx_log_debug5(level, log, err, fmt, arg1, arg2, arg3, arg4, arg5)    \
  153.         ngx_log_debug(level, log, err, fmt, arg1, arg2, arg3, arg4, arg5)

  155. ‌#define ngx_log_debug6(level, log, err, fmt,                                  \
  156.                        arg1, arg2, arg3, arg4, arg5, arg6)                    \
  157.         ngx_log_debug(level, log, err, fmt,                                   \
  158.                        arg1, arg2, arg3, arg4, arg5, arg6)

  160. ‌#define ngx_log_debug7(level, log, err, fmt,                                  \
  161.                        arg1, arg2, arg3, arg4, arg5, arg6, arg7)              \
  162.         ngx_log_debug(level, log, err, fmt,                                   \
  163.                        arg1, arg2, arg3, arg4, arg5, arg6, arg7)

  165. ‌#define ngx_log_debug8(level, log, err, fmt,                                  \
  166.                        arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8)        \
  167.         ngx_log_debug(level, log, err, fmt,                                   \
  168.                        arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8)


  171. #else /* no variadic macros */

  173. ‌#define ngx_log_debug0(level, log, err, fmt)                                  \
  174.     if ((log)->log_level & level)                                             \
  175.         ngx_log_debug_core(log, err, fmt)

  177. ‌#define ngx_log_debug1(level, log, err, fmt, arg1)                            \
  178.     if ((log)->log_level & level)                                             \
  179.         ngx_log_debug_core(log, err, fmt, arg1)

  181. ‌#define ngx_log_debug2(level, log, err, fmt, arg1, arg2)                      \
  182.     if ((log)->log_level & level)                                             \
  183.         ngx_log_debug_core(log, err, fmt, arg1, arg2)

  185. ‌#define ngx_log_debug3(level, log, err, fmt, arg1, arg2, arg3)                \
  186.     if ((log)->log_level & level)                                             \
  187.         ngx_log_debug_core(log, err, fmt, arg1, arg2, arg3)

  189. ‌#define ngx_log_debug4(level, log, err, fmt, arg1, arg2, arg3, arg4)          \
  190.     if ((log)->log_level & level)                                             \
  191.         ngx_log_debug_core(log, err, fmt, arg1, arg2, arg3, arg4)

  193. ‌#define ngx_log_debug5(level, log, err, fmt, arg1, arg2, arg3, arg4, arg5)    \
  194.     if ((log)->log_level & level)                                             \
  195.         ngx_log_debug_core(log, err, fmt, arg1, arg2, arg3, arg4, arg5)

  197. ‌#define ngx_log_debug6(level, log, err, fmt,                                  \
  198.                        arg1, arg2, arg3, arg4, arg5, arg6)                    \
  199.     if ((log)->log_level & level)                                             \
  200.         ngx_log_debug_core(log, err, fmt, arg1, arg2, arg3, arg4, arg5, arg6)

  202. ‌#define ngx_log_debug7(level, log, err, fmt,                                  \
  203.                        arg1, arg2, arg3, arg4, arg5, arg6, arg7)              \
  204.     if ((log)->log_level & level)                                             \
  205.         ngx_log_debug_core(log, err, fmt,                                     \
  206.                        arg1, arg2, arg3, arg4, arg5, arg6, arg7)

  208. ‌#define ngx_log_debug8(level, log, err, fmt,                                  \
  209.                        arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8)        \
  210.     if ((log)->log_level & level)                                             \
  211.         ngx_log_debug_core(log, err, fmt,                                     \
  212.                        arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8)

  214. #endif

  216. #else /* !NGX_DEBUG */

  218. ‌#define ngx_log_debug0(level, log, err, fmt)
  219. ‌#define ngx_log_debug1(level, log, err, fmt, arg1)
  220. ‌#define ngx_log_debug2(level, log, err, fmt, arg1, arg2)
  221. ‌#define ngx_log_debug3(level, log, err, fmt, arg1, arg2, arg3)
  222. ‌#define ngx_log_debug4(level, log, err, fmt, arg1, arg2, arg3, arg4)
  223. ‌#define ngx_log_debug5(level, log, err, fmt, arg1, arg2, arg3, arg4, arg5)
  224. ‌#define ngx_log_debug6(level, log, err, fmt, arg1, arg2, arg3, arg4, arg5, arg6)
  225. ‌#define ngx_log_debug7(level, log, err, fmt, arg1, arg2, arg3, arg4, arg5,    \
  226.                        arg6, arg7)
  227. ‌#define ngx_log_debug8(level, log, err, fmt, arg1, arg2, arg3, arg4, arg5,    \
  228.                        arg6, arg7, arg8)

  230. #endif

  232. /*********************************/

  234. ngx_log_t *ngx_log_init(u_char *prefix, u_char *error_log);
  235. void ngx_cdecl ngx_log_abort(ngx_err_t err, const char *fmt, ...);
  236. void ngx_cdecl ngx_log_stderr(ngx_err_t err, const char *fmt, ...);
  237. u_char *ngx_log_errno(u_char *buf, u_char *last, ngx_err_t err);
  238. ngx_int_t ngx_log_open_default(ngx_cycle_t *cycle);
  239. ngx_int_t ngx_log_redirect_stderr(ngx_cycle_t *cycle);
  240. ngx_log_t *ngx_log_get_file_log(ngx_log_t *head);
  241. char *ngx_log_set_log(ngx_conf_t *cf, ngx_log_t **head);


  244. /*
  245. * ngx_write_stderr() cannot be implemented as macro, since
  246. * MSVC does not allow to use #ifdef inside macro parameters.
  247. *
  248. * ngx_write_fd() is used instead of ngx_write_console(), since
  249. * CharToOemBuff() inside ngx_write_console() cannot be used with
  250. * read only buffer as destination and CharToOemBuff() is not needed
  251. * for ngx_write_stderr() anyway.
  252. */
  253. static ngx_inline void
  254. ‌ngx_write_stderr(char *text)
  255. {
  256.     (void) ngx_write_fd(ngx_stderr, text, ngx_strlen(text));
  257. }


  260. static ngx_inline void
  261. ‌ngx_write_stdout(char *text)
  262. {
  263.     (void) ngx_write_fd(ngx_stdout, text, ngx_strlen(text));
  264. }


  267. extern ngx_module_t  ngx_errlog_module;
  268. extern ngx_uint_t    ngx_use_stderr;


  271. #endif /* _NGX_LOG_H_INCLUDED_ */

One Level Up Top Level