One Level Up Top Level

src/http/modules/ngx_http_log_module.c - nginx-1.7.10

Global variables defined

Data types defined

Functions defined

Source code


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


  8. #include <ngx_config.h>
  9. #include <ngx_core.h>
  10. #include <ngx_http.h>

  12. #if (NGX_ZLIB)
  13. #include <zlib.h>
  14. #endif


  17. ‌typedef struct ngx_http_log_op_s  ngx_http_log_op_t;

  19. ‌typedef u_char *(*ngx_http_log_op_run_pt) (ngx_http_request_t *r, u_char *buf,
  20.     ngx_http_log_op_t *op);

  22. ‌typedef size_t (*ngx_http_log_op_getlen_pt) (ngx_http_request_t *r,
  23.     uintptr_t data);


  26. ‌struct ngx_http_log_op_s {
  27.     size_t                      len;
  28.     ngx_http_log_op_getlen_pt   getlen;
  29.     ngx_http_log_op_run_pt      run;
  30.     uintptr_t                   data;
  31. };


  34. typedef struct {
  35.     ngx_str_t                   name;
  36.     ngx_array_t                *flushes;
  37.     ngx_array_t                *ops;        /* array of ngx_http_log_op_t */
  38. ‌} ngx_http_log_fmt_t;


  41. typedef struct {
  42.     ngx_array_t                 formats;    /* array of ngx_http_log_fmt_t */
  43.     ngx_uint_t                  combined_used; /* unsigned  combined_used:1 */
  44. ‌} ngx_http_log_main_conf_t;


  47. typedef struct {
  48.     u_char                     *start;
  49.     u_char                     *pos;
  50.     u_char                     *last;

  52.     ngx_event_t                *event;
  53.     ngx_msec_t                  flush;
  54.     ngx_int_t                   gzip;
  55. ‌} ngx_http_log_buf_t;


  58. typedef struct {
  59.     ngx_array_t                *lengths;
  60.     ngx_array_t                *values;
  61. ‌} ngx_http_log_script_t;


  64. typedef struct {
  65.     ngx_open_file_t            *file;
  66.     ngx_http_log_script_t      *script;
  67.     time_t                      disk_full_time;
  68.     time_t                      error_log_time;
  69.     ngx_syslog_peer_t          *syslog_peer;
  70.     ngx_http_log_fmt_t         *format;
  71.     ngx_http_complex_value_t   *filter;
  72. ‌} ngx_http_log_t;


  75. typedef struct {
  76.     ngx_array_t                *logs;       /* array of ngx_http_log_t */

  78.     ngx_open_file_cache_t      *open_file_cache;
  79.     time_t                      open_file_cache_valid;
  80.     ngx_uint_t                  open_file_cache_min_uses;

  82.     ngx_uint_t                  off;        /* unsigned  off:1 */
  83. ‌} ngx_http_log_loc_conf_t;


  86. typedef struct {
  87.     ngx_str_t                   name;
  88.     size_t                      len;
  89.     ngx_http_log_op_run_pt      run;
  90. ‌} ngx_http_log_var_t;


  93. static void ngx_http_log_write(ngx_http_request_t *r, ngx_http_log_t *log,
  94.     u_char *buf, size_t len);
  95. static ssize_t ngx_http_log_script_write(ngx_http_request_t *r,
  96.     ngx_http_log_script_t *script, u_char **name, u_char *buf, size_t len);

  98. #if (NGX_ZLIB)
  99. static ssize_t ngx_http_log_gzip(ngx_fd_t fd, u_char *buf, size_t len,
  100.     ngx_int_t level, ngx_log_t *log);

  102. static void *ngx_http_log_gzip_alloc(void *opaque, u_int items, u_int size);
  103. static void ngx_http_log_gzip_free(void *opaque, void *address);
  104. #endif

  106. static void ngx_http_log_flush(ngx_open_file_t *file, ngx_log_t *log);
  107. static void ngx_http_log_flush_handler(ngx_event_t *ev);

  109. static u_char *ngx_http_log_pipe(ngx_http_request_t *r, u_char *buf,
  110.     ngx_http_log_op_t *op);
  111. static u_char *ngx_http_log_time(ngx_http_request_t *r, u_char *buf,
  112.     ngx_http_log_op_t *op);
  113. static u_char *ngx_http_log_iso8601(ngx_http_request_t *r, u_char *buf,
  114.     ngx_http_log_op_t *op);
  115. static u_char *ngx_http_log_msec(ngx_http_request_t *r, u_char *buf,
  116.     ngx_http_log_op_t *op);
  117. static u_char *ngx_http_log_request_time(ngx_http_request_t *r, u_char *buf,
  118.     ngx_http_log_op_t *op);
  119. static u_char *ngx_http_log_status(ngx_http_request_t *r, u_char *buf,
  120.     ngx_http_log_op_t *op);
  121. static u_char *ngx_http_log_bytes_sent(ngx_http_request_t *r, u_char *buf,
  122.     ngx_http_log_op_t *op);
  123. static u_char *ngx_http_log_body_bytes_sent(ngx_http_request_t *r,
  124.     u_char *buf, ngx_http_log_op_t *op);
  125. static u_char *ngx_http_log_request_length(ngx_http_request_t *r, u_char *buf,
  126.     ngx_http_log_op_t *op);

  128. static ngx_int_t ngx_http_log_variable_compile(ngx_conf_t *cf,
  129.     ngx_http_log_op_t *op, ngx_str_t *value);
  130. static size_t ngx_http_log_variable_getlen(ngx_http_request_t *r,
  131.     uintptr_t data);
  132. static u_char *ngx_http_log_variable(ngx_http_request_t *r, u_char *buf,
  133.     ngx_http_log_op_t *op);
  134. static uintptr_t ngx_http_log_escape(u_char *dst, u_char *src, size_t size);


  137. static void *ngx_http_log_create_main_conf(ngx_conf_t *cf);
  138. static void *ngx_http_log_create_loc_conf(ngx_conf_t *cf);
  139. static char *ngx_http_log_merge_loc_conf(ngx_conf_t *cf, void *parent,
  140.     void *child);
  141. static char *ngx_http_log_set_log(ngx_conf_t *cf, ngx_command_t *cmd,
  142.     void *conf);
  143. static char *ngx_http_log_set_format(ngx_conf_t *cf, ngx_command_t *cmd,
  144.     void *conf);
  145. static char *ngx_http_log_compile_format(ngx_conf_t *cf,
  146.     ngx_array_t *flushes, ngx_array_t *ops, ngx_array_t *args, ngx_uint_t s);
  147. static char *ngx_http_log_open_file_cache(ngx_conf_t *cf, ngx_command_t *cmd,
  148.     void *conf);
  149. static ngx_int_t ngx_http_log_init(ngx_conf_t *cf);


  152. ‌static ngx_command_t  ngx_http_log_commands[] = {

  154.     { ngx_string("log_format"),
  155.       NGX_HTTP_MAIN_CONF|NGX_CONF_2MORE,
  156.       ngx_http_log_set_format,
  157.       NGX_HTTP_MAIN_CONF_OFFSET,
  158.       0,
  159.       NULL },

  161.     { ngx_string("access_log"),
  162.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_HTTP_LIF_CONF
  163.                         |NGX_HTTP_LMT_CONF|NGX_CONF_1MORE,
  164.       ngx_http_log_set_log,
  165.       NGX_HTTP_LOC_CONF_OFFSET,
  166.       0,
  167.       NULL },

  169.     { ngx_string("open_log_file_cache"),
  170.       NGX_HTTP_MAIN_CONF|NGX_HTTP_SRV_CONF|NGX_HTTP_LOC_CONF|NGX_CONF_TAKE1234,
  171.       ngx_http_log_open_file_cache,
  172.       NGX_HTTP_LOC_CONF_OFFSET,
  173.       0,
  174.       NULL },

  176.       ngx_null_command
  177. };


  180. ‌static ngx_http_module_t  ngx_http_log_module_ctx = {
  181.     NULL,                                  /* preconfiguration */
  182.     ngx_http_log_init,                     /* postconfiguration */

  184.     ngx_http_log_create_main_conf,         /* create main configuration */
  185.     NULL,                                  /* init main configuration */

  187.     NULL,                                  /* create server configuration */
  188.     NULL,                                  /* merge server configuration */

  190.     ngx_http_log_create_loc_conf,          /* create location configuration */
  191.     ngx_http_log_merge_loc_conf            /* merge location configuration */
  192. };


  195. ‌ngx_module_t  ngx_http_log_module = {
  196.     NGX_MODULE_V1,
  197.     &ngx_http_log_module_ctx,              /* module context */
  198.     ngx_http_log_commands,                 /* module directives */
  199.     NGX_HTTP_MODULE,                       /* module type */
  200.     NULL,                                  /* init master */
  201.     NULL,                                  /* init module */
  202.     NULL,                                  /* init process */
  203.     NULL,                                  /* init thread */
  204.     NULL,                                  /* exit thread */
  205.     NULL,                                  /* exit process */
  206.     NULL,                                  /* exit master */
  207.     NGX_MODULE_V1_PADDING
  208. };


  211. ‌static ngx_str_t  ngx_http_access_log = ngx_string(NGX_HTTP_LOG_PATH);


  214. ‌static ngx_str_t  ngx_http_combined_fmt =
  215.     ngx_string("$remote_addr - $remote_user [$time_local] "
  216.                "\"$request\" $status $body_bytes_sent "
  217.                "\"$http_referer\" \"$http_user_agent\"");


  220. ‌static ngx_http_log_var_t  ngx_http_log_vars[] = {
  221.     { ngx_string("pipe"), 1, ngx_http_log_pipe },
  222.     { ngx_string("time_local"), sizeof("28/Sep/1970:12:00:00 +0600") - 1,
  223.                           ngx_http_log_time },
  224.     { ngx_string("time_iso8601"), sizeof("1970-09-28T12:00:00+06:00") - 1,
  225.                           ngx_http_log_iso8601 },
  226.     { ngx_string("msec"), NGX_TIME_T_LEN + 4, ngx_http_log_msec },
  227.     { ngx_string("request_time"), NGX_TIME_T_LEN + 4,
  228.                           ngx_http_log_request_time },
  229.     { ngx_string("status"), NGX_INT_T_LEN, ngx_http_log_status },
  230.     { ngx_string("bytes_sent"), NGX_OFF_T_LEN, ngx_http_log_bytes_sent },
  231.     { ngx_string("body_bytes_sent"), NGX_OFF_T_LEN,
  232.                           ngx_http_log_body_bytes_sent },
  233.     { ngx_string("request_length"), NGX_SIZE_T_LEN,
  234.                           ngx_http_log_request_length },

  236.     { ngx_null_string, 0, NULL }
  237. };


  240. static ngx_int_t
  241. ‌ngx_http_log_handler(ngx_http_request_t *r)
  242. {
  243.     u_char                   *line, *p;
  244.     size_t                    len, size;
  245.     ssize_t                   n;
  246.     ngx_str_t                 val;
  247.     ngx_uint_t                i, l;
  248.     ngx_http_log_t           *log;
  249.     ngx_http_log_op_t        *op;
  250.     ngx_http_log_buf_t       *buffer;
  251.     ngx_http_log_loc_conf_t  *lcf;

  253.     ngx_log_debug0(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
  254.                    "http log handler");

  256.     lcf = ngx_http_get_module_loc_conf(r, ngx_http_log_module);

  258.     if (lcf->off) {
  259.         return NGX_OK;
  260.     }

  262.     log = lcf->logs->elts;
  263.     for (l = 0; l < lcf->logs->nelts; l++) {

  265.         if (log[l].filter) {
  266.             if (ngx_http_complex_value(r, log[l].filter, &val) != NGX_OK) {
  267.                 return NGX_ERROR;
  268.             }

  270.             if (val.len == 0 || (val.len == 1 && val.data[0] == '0')) {
  271.                 continue;
  272.             }
  273.         }

  275.         if (ngx_time() == log[l].disk_full_time) {

  277.             /*
  278.              * on FreeBSD writing to a full filesystem with enabled softupdates
  279.              * may block process for much longer time than writing to non-full
  280.              * filesystem, so we skip writing to a log for one second
  281.              */

  283.             continue;
  284.         }

  286.         ngx_http_script_flush_no_cacheable_variables(r, log[l].format->flushes);

  288.         len = 0;
  289.         op = log[l].format->ops->elts;
  290.         for (i = 0; i < log[l].format->ops->nelts; i++) {
  291.             if (op[i].len == 0) {
  292.                 len += op[i].getlen(r, op[i].data);

  294.             } else {
  295.                 len += op[i].len;
  296.             }
  297.         }

  299.         if (log[l].syslog_peer) {

  301.             /* length of syslog's PRI and HEADER message parts */
  302.             len += sizeof("<255>Jan 01 00:00:00 ") - 1
  303.                    + ngx_cycle->hostname.len + 1
  304.                    + log[l].syslog_peer->tag.len + 2;

  306.             goto alloc_line;
  307.         }

  309.         len += NGX_LINEFEED_SIZE;

  311.         buffer = log[l].file ? log[l].file->data : NULL;

  313.         if (buffer) {

  315.             if (len > (size_t) (buffer->last - buffer->pos)) {

  317.                 ngx_http_log_write(r, &log[l], buffer->start,
  318.                                    buffer->pos - buffer->start);

  320.                 buffer->pos = buffer->start;
  321.             }

  323.             if (len <= (size_t) (buffer->last - buffer->pos)) {

  325.                 p = buffer->pos;

  327.                 if (buffer->event && p == buffer->start) {
  328.                     ngx_add_timer(buffer->event, buffer->flush);
  329.                 }

  331.                 for (i = 0; i < log[l].format->ops->nelts; i++) {
  332.                     p = op[i].run(r, p, &op[i]);
  333.                 }

  335.                 ngx_linefeed(p);

  337.                 buffer->pos = p;

  339.                 continue;
  340.             }

  342.             if (buffer->event && buffer->event->timer_set) {
  343.                 ngx_del_timer(buffer->event);
  344.             }
  345.         }

  347.     alloc_line:

  349.         line = ngx_pnalloc(r->pool, len);
  350.         if (line == NULL) {
  351.             return NGX_ERROR;
  352.         }

  354.         p = line;

  356.         if (log[l].syslog_peer) {
  357.             p = ngx_syslog_add_header(log[l].syslog_peer, line);
  358.         }

  360.         for (i = 0; i < log[l].format->ops->nelts; i++) {
  361.             p = op[i].run(r, p, &op[i]);
  362.         }

  364.         if (log[l].syslog_peer) {

  366.             size = p - line;

  368.             n = ngx_syslog_send(log[l].syslog_peer, line, size);

  370.             if (n < 0) {
  371.                 ngx_log_error(NGX_LOG_WARN, r->connection->log, 0,
  372.                               "send() to syslog failed");

  374.             } else if ((size_t) n != size) {
  375.                 ngx_log_error(NGX_LOG_WARN, r->connection->log, 0,
  376.                               "send() to syslog has written only %z of %uz",
  377.                               n, size);
  378.             }

  380.             continue;
  381.         }

  383.         ngx_linefeed(p);

  385.         ngx_http_log_write(r, &log[l], line, p - line);
  386.     }

  388.     return NGX_OK;
  389. }


  392. static void
  393. ‌ngx_http_log_write(ngx_http_request_t *r, ngx_http_log_t *log, u_char *buf,
  394.     size_t len)
  395. {
  396.     u_char              *name;
  397.     time_t               now;
  398.     ssize_t              n;
  399.     ngx_err_t            err;
  400. #if (NGX_ZLIB)
  401.     ngx_http_log_buf_t  *buffer;
  402. #endif

  404.     if (log->script == NULL) {
  405.         name = log->file->name.data;

  407. #if (NGX_ZLIB)
  408.         buffer = log->file->data;

  410.         if (buffer && buffer->gzip) {
  411.             n = ngx_http_log_gzip(log->file->fd, buf, len, buffer->gzip,
  412.                                   r->connection->log);
  413.         } else {
  414.             n = ngx_write_fd(log->file->fd, buf, len);
  415.         }
  416. #else
  417.         n = ngx_write_fd(log->file->fd, buf, len);
  418. #endif

  420.     } else {
  421.         name = NULL;
  422.         n = ngx_http_log_script_write(r, log->script, &name, buf, len);
  423.     }

  425.     if (n == (ssize_t) len) {
  426.         return;
  427.     }

  429.     now = ngx_time();

  431.     if (n == -1) {
  432.         err = ngx_errno;

  434.         if (err == NGX_ENOSPC) {
  435.             log->disk_full_time = now;
  436.         }

  438.         if (now - log->error_log_time > 59) {
  439.             ngx_log_error(NGX_LOG_ALERT, r->connection->log, err,
  440.                           ngx_write_fd_n " to \"%s\" failed", name);

  442.             log->error_log_time = now;
  443.         }

  445.         return;
  446.     }

  448.     if (now - log->error_log_time > 59) {
  449.         ngx_log_error(NGX_LOG_ALERT, r->connection->log, 0,
  450.                       ngx_write_fd_n " to \"%s\" was incomplete: %z of %uz",
  451.                       name, n, len);

  453.         log->error_log_time = now;
  454.     }
  455. }


  458. static ssize_t
  459. ‌ngx_http_log_script_write(ngx_http_request_t *r, ngx_http_log_script_t *script,
  460.     u_char **name, u_char *buf, size_t len)
  461. {
  462.     size_t                     root;
  463.     ssize_t                    n;
  464.     ngx_str_t                  log, path;
  465.     ngx_open_file_info_t       of;
  466.     ngx_http_log_loc_conf_t   *llcf;
  467.     ngx_http_core_loc_conf_t  *clcf;

  469.     clcf = ngx_http_get_module_loc_conf(r, ngx_http_core_module);

  471.     if (!r->root_tested) {

  473.         /* test root directory existence */

  475.         if (ngx_http_map_uri_to_path(r, &path, &root, 0) == NULL) {
  476.             /* simulate successful logging */
  477.             return len;
  478.         }

  480.         path.data[root] = '\0';

  482.         ngx_memzero(&of, sizeof(ngx_open_file_info_t));

  484.         of.valid = clcf->open_file_cache_valid;
  485.         of.min_uses = clcf->open_file_cache_min_uses;
  486.         of.test_dir = 1;
  487.         of.test_only = 1;
  488.         of.errors = clcf->open_file_cache_errors;
  489.         of.events = clcf->open_file_cache_events;

  491.         if (ngx_http_set_disable_symlinks(r, clcf, &path, &of) != NGX_OK) {
  492.             /* simulate successful logging */
  493.             return len;
  494.         }

  496.         if (ngx_open_cached_file(clcf->open_file_cache, &path, &of, r->pool)
  497.             != NGX_OK)
  498.         {
  499.             if (of.err == 0) {
  500.                 /* simulate successful logging */
  501.                 return len;
  502.             }

  504.             ngx_log_error(NGX_LOG_ERR, r->connection->log, of.err,
  505.                           "testing \"%s\" existence failed", path.data);

  507.             /* simulate successful logging */
  508.             return len;
  509.         }

  511.         if (!of.is_dir) {
  512.             ngx_log_error(NGX_LOG_ERR, r->connection->log, NGX_ENOTDIR,
  513.                           "testing \"%s\" existence failed", path.data);

  515.             /* simulate successful logging */
  516.             return len;
  517.         }
  518.     }

  520.     if (ngx_http_script_run(r, &log, script->lengths->elts, 1,
  521.                             script->values->elts)
  522.         == NULL)
  523.     {
  524.         /* simulate successful logging */
  525.         return len;
  526.     }

  528.     log.data[log.len - 1] = '\0';
  529.     *name = log.data;

  531.     ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
  532.                    "http log \"%s\"", log.data);

  534.     llcf = ngx_http_get_module_loc_conf(r, ngx_http_log_module);

  536.     ngx_memzero(&of, sizeof(ngx_open_file_info_t));

  538.     of.log = 1;
  539.     of.valid = llcf->open_file_cache_valid;
  540.     of.min_uses = llcf->open_file_cache_min_uses;
  541.     of.directio = NGX_OPEN_FILE_DIRECTIO_OFF;

  543.     if (ngx_http_set_disable_symlinks(r, clcf, &log, &of) != NGX_OK) {
  544.         /* simulate successful logging */
  545.         return len;
  546.     }

  548.     if (ngx_open_cached_file(llcf->open_file_cache, &log, &of, r->pool)
  549.         != NGX_OK)
  550.     {
  551.         ngx_log_error(NGX_LOG_CRIT, r->connection->log, ngx_errno,
  552.                       "%s \"%s\" failed", of.failed, log.data);
  553.         /* simulate successful logging */
  554.         return len;
  555.     }

  557.     ngx_log_debug1(NGX_LOG_DEBUG_HTTP, r->connection->log, 0,
  558.                    "http log #%d", of.fd);

  560.     n = ngx_write_fd(of.fd, buf, len);

  562.     return n;
  563. }


  566. #if (NGX_ZLIB)

  568. static ssize_t
  569. ‌ngx_http_log_gzip(ngx_fd_t fd, u_char *buf, size_t len, ngx_int_t level,
  570.     ngx_log_t *log)
  571. {
  572.     int          rc, wbits, memlevel;
  573.     u_char      *out;
  574.     size_t       size;
  575.     ssize_t      n;
  576.     z_stream     zstream;
  577.     ngx_err_t    err;
  578.     ngx_pool_t  *pool;

  580.     wbits = MAX_WBITS;
  581.     memlevel = MAX_MEM_LEVEL - 1;

  583.     while ((ssize_t) len < ((1 << (wbits - 1)) - 262)) {
  584.         wbits--;
  585.         memlevel--;
  586.     }

  588.     /*
  589.      * This is a formula from deflateBound() for conservative upper bound of
  590.      * compressed data plus 18 bytes of gzip wrapper.
  591.      */

  593.     size = len + ((len + 7) >> 3) + ((len + 63) >> 6) + 5 + 18;

  595.     ngx_memzero(&zstream, sizeof(z_stream));

  597.     pool = ngx_create_pool(256, log);
  598.     if (pool == NULL) {
  599.         /* simulate successful logging */
  600.         return len;
  601.     }

  603.     pool->log = log;

  605.     zstream.zalloc = ngx_http_log_gzip_alloc;
  606.     zstream.zfree = ngx_http_log_gzip_free;
  607.     zstream.opaque = pool;

  609.     out = ngx_pnalloc(pool, size);
  610.     if (out == NULL) {
  611.         goto done;
  612.     }

  614.     zstream.next_in = buf;
  615.     zstream.avail_in = len;
  616.     zstream.next_out = out;
  617.     zstream.avail_out = size;

  619.     rc = deflateInit2(&zstream, (int) level, Z_DEFLATED, wbits + 16, memlevel,
  620.                       Z_DEFAULT_STRATEGY);

  622.     if (rc != Z_OK) {
  623.         ngx_log_error(NGX_LOG_ALERT, log, 0, "deflateInit2() failed: %d", rc);
  624.         goto done;
  625.     }

  627.     ngx_log_debug4(NGX_LOG_DEBUG_HTTP, log, 0,
  628.                    "deflate in: ni:%p no:%p ai:%ud ao:%ud",
  629.                    zstream.next_in, zstream.next_out,
  630.                    zstream.avail_in, zstream.avail_out);

  632.     rc = deflate(&zstream, Z_FINISH);

  634.     if (rc != Z_STREAM_END) {
  635.         ngx_log_error(NGX_LOG_ALERT, log, 0,
  636.                       "deflate(Z_FINISH) failed: %d", rc);
  637.         goto done;
  638.     }

  640.     ngx_log_debug5(NGX_LOG_DEBUG_HTTP, log, 0,
  641.                    "deflate out: ni:%p no:%p ai:%ud ao:%ud rc:%d",
  642.                    zstream.next_in, zstream.next_out,
  643.                    zstream.avail_in, zstream.avail_out,
  644.                    rc);

  646.     size -= zstream.avail_out;

  648.     rc = deflateEnd(&zstream);

  650.     if (rc != Z_OK) {
  651.         ngx_log_error(NGX_LOG_ALERT, log, 0, "deflateEnd() failed: %d", rc);
  652.         goto done;
  653.     }

  655.     n = ngx_write_fd(fd, out, size);

  657.     if (n != (ssize_t) size) {
  658.         err = (n == -1) ? ngx_errno : 0;

  660.         ngx_destroy_pool(pool);

  662.         ngx_set_errno(err);
  663.         return -1;
  664.     }

  666. done:

  668.     ngx_destroy_pool(pool);

  670.     /* simulate successful logging */
  671.     return len;
  672. }


  675. static void *
  676. ‌ngx_http_log_gzip_alloc(void *opaque, u_int items, u_int size)
  677. {
  678.     ngx_pool_t *pool = opaque;

  680.     ngx_log_debug2(NGX_LOG_DEBUG_HTTP, pool->log, 0,
  681.                    "gzip alloc: n:%ud s:%ud", items, size);

  683.     return ngx_palloc(pool, items * size);
  684. }


  687. static void
  688. ‌ngx_http_log_gzip_free(void *opaque, void *address)
  689. {
  690. #if 0
  691.     ngx_pool_t *pool = opaque;

  693.     ngx_log_debug1(NGX_LOG_DEBUG_HTTP, pool->log, 0, "gzip free: %p", address);
  694. #endif
  695. }

  697. #endif


  700. static void
  701. ‌ngx_http_log_flush(ngx_open_file_t *file, ngx_log_t *log)
  702. {
  703.     size_t               len;
  704.     ssize_t              n;
  705.     ngx_http_log_buf_t  *buffer;

  707.     buffer = file->data;

  709.     len = buffer->pos - buffer->start;

  711.     if (len == 0) {
  712.         return;
  713.     }

  715. #if (NGX_ZLIB)
  716.     if (buffer->gzip) {
  717.         n = ngx_http_log_gzip(file->fd, buffer->start, len, buffer->gzip, log);
  718.     } else {
  719.         n = ngx_write_fd(file->fd, buffer->start, len);
  720.     }
  721. #else
  722.     n = ngx_write_fd(file->fd, buffer->start, len);
  723. #endif

  725.     if (n == -1) {
  726.         ngx_log_error(NGX_LOG_ALERT, log, ngx_errno,
  727.                       ngx_write_fd_n " to \"%s\" failed",
  728.                       file->name.data);

  730.     } else if ((size_t) n != len) {
  731.         ngx_log_error(NGX_LOG_ALERT, log, 0,
  732.                       ngx_write_fd_n " to \"%s\" was incomplete: %z of %uz",
  733.                       file->name.data, n, len);
  734.     }

  736.     buffer->pos = buffer->start;

  738.     if (buffer->event && buffer->event->timer_set) {
  739.         ngx_del_timer(buffer->event);
  740.     }
  741. }


  744. static void
  745. ‌ngx_http_log_flush_handler(ngx_event_t *ev)
  746. {
  747.     ngx_open_file_t     *file;
  748.     ngx_http_log_buf_t  *buffer;

  750.     ngx_log_debug0(NGX_LOG_DEBUG_EVENT, ev->log, 0,
  751.                    "http log buffer flush handler");

  753.     if (ev->timedout) {
  754.         ngx_http_log_flush(ev->data, ev->log);
  755.         return;
  756.     }

  758.     /* cancel the flush timer for graceful shutdown */

  760.     file = ev->data;
  761.     buffer = file->data;

  763.     buffer->event = NULL;
  764. }


  767. static u_char *
  768. ‌ngx_http_log_copy_short(ngx_http_request_t *r, u_char *buf,
  769.     ngx_http_log_op_t *op)
  770. {
  771.     size_t     len;
  772.     uintptr_t  data;

  774.     len = op->len;
  775.     data = op->data;

  777.     while (len--) {
  778.         *buf++ = (u_char) (data & 0xff);
  779.         data >>= 8;
  780.     }

  782.     return buf;
  783. }


  786. static u_char *
  787. ‌ngx_http_log_copy_long(ngx_http_request_t *r, u_char *buf,
  788.     ngx_http_log_op_t *op)
  789. {
  790.     return ngx_cpymem(buf, (u_char *) op->data, op->len);
  791. }


  794. static u_char *
  795. ‌ngx_http_log_pipe(ngx_http_request_t *r, u_char *buf, ngx_http_log_op_t *op)
  796. {
  797.     if (r->pipeline) {
  798.         *buf = 'p';
  799.     } else {
  800.         *buf = '.';
  801.     }

  803.     return buf + 1;
  804. }


  807. static u_char *
  808. ‌ngx_http_log_time(ngx_http_request_t *r, u_char *buf, ngx_http_log_op_t *op)
  809. {
  810.     return ngx_cpymem(buf, ngx_cached_http_log_time.data,
  811.                       ngx_cached_http_log_time.len);
  812. }

  814. static u_char *
  815. ‌ngx_http_log_iso8601(ngx_http_request_t *r, u_char *buf, ngx_http_log_op_t *op)
  816. {
  817.     return ngx_cpymem(buf, ngx_cached_http_log_iso8601.data,
  818.                       ngx_cached_http_log_iso8601.len);
  819. }

  821. static u_char *
  822. ‌ngx_http_log_msec(ngx_http_request_t *r, u_char *buf, ngx_http_log_op_t *op)
  823. {
  824.     ngx_time_t  *tp;

  826.     tp = ngx_timeofday();

  828.     return ngx_sprintf(buf, "%T.%03M", tp->sec, tp->msec);
  829. }


  832. static u_char *
  833. ‌ngx_http_log_request_time(ngx_http_request_t *r, u_char *buf,
  834.     ngx_http_log_op_t *op)
  835. {
  836.     ngx_time_t      *tp;
  837.     ngx_msec_int_t   ms;

  839.     tp = ngx_timeofday();

  841.     ms = (ngx_msec_int_t)
  842.              ((tp->sec - r->start_sec) * 1000 + (tp->msec - r->start_msec));
  843.     ms = ngx_max(ms, 0);

  845.     return ngx_sprintf(buf, "%T.%03M", (time_t) ms / 1000, ms % 1000);
  846. }


  849. static u_char *
  850. ‌ngx_http_log_status(ngx_http_request_t *r, u_char *buf, ngx_http_log_op_t *op)
  851. {
  852.     ngx_uint_t  status;

  854.     if (r->err_status) {
  855.         status = r->err_status;

  857.     } else if (r->headers_out.status) {
  858.         status = r->headers_out.status;

  860.     } else if (r->http_version == NGX_HTTP_VERSION_9) {
  861.         status = 9;

  863.     } else {
  864.         status = 0;
  865.     }

  867.     return ngx_sprintf(buf, "%03ui", status);
  868. }


  871. static u_char *
  872. ‌ngx_http_log_bytes_sent(ngx_http_request_t *r, u_char *buf,
  873.     ngx_http_log_op_t *op)
  874. {
  875.     return ngx_sprintf(buf, "%O", r->connection->sent);
  876. }


  879. /*
  880. * although there is a real $body_bytes_sent variable,
  881. * this log operation code function is more optimized for logging
  882. */

  884. static u_char *
  885. ‌ngx_http_log_body_bytes_sent(ngx_http_request_t *r, u_char *buf,
  886.     ngx_http_log_op_t *op)
  887. {
  888.     off_t  length;

  890.     length = r->connection->sent - r->header_size;

  892.     if (length > 0) {
  893.         return ngx_sprintf(buf, "%O", length);
  894.     }

  896.     *buf = '0';

  898.     return buf + 1;
  899. }


  902. static u_char *
  903. ‌ngx_http_log_request_length(ngx_http_request_t *r, u_char *buf,
  904.     ngx_http_log_op_t *op)
  905. {
  906.     return ngx_sprintf(buf, "%O", r->request_length);
  907. }


  910. static ngx_int_t
  911. ‌ngx_http_log_variable_compile(ngx_conf_t *cf, ngx_http_log_op_t *op,
  912.     ngx_str_t *value)
  913. {
  914.     ngx_int_t  index;

  916.     index = ngx_http_get_variable_index(cf, value);
  917.     if (index == NGX_ERROR) {
  918.         return NGX_ERROR;
  919.     }

  921.     op->len = 0;
  922.     op->getlen = ngx_http_log_variable_getlen;
  923.     op->run = ngx_http_log_variable;
  924.     op->data = index;

  926.     return NGX_OK;
  927. }


  930. static size_t
  931. ‌ngx_http_log_variable_getlen(ngx_http_request_t *r, uintptr_t data)
  932. {
  933.     uintptr_t                   len;
  934.     ngx_http_variable_value_t  *value;

  936.     value = ngx_http_get_indexed_variable(r, data);

  938.     if (value == NULL || value->not_found) {
  939.         return 1;
  940.     }

  942.     len = ngx_http_log_escape(NULL, value->data, value->len);

  944.     value->escape = len ? 1 : 0;

  946.     return value->len + len * 3;
  947. }


  950. static u_char *
  951. ‌ngx_http_log_variable(ngx_http_request_t *r, u_char *buf, ngx_http_log_op_t *op)
  952. {
  953.     ngx_http_variable_value_t  *value;

  955.     value = ngx_http_get_indexed_variable(r, op->data);

  957.     if (value == NULL || value->not_found) {
  958.         *buf = '-';
  959.         return buf + 1;
  960.     }

  962.     if (value->escape == 0) {
  963.         return ngx_cpymem(buf, value->data, value->len);

  965.     } else {
  966.         return (u_char *) ngx_http_log_escape(buf, value->data, value->len);
  967.     }
  968. }


  971. static uintptr_t
  972. ‌ngx_http_log_escape(u_char *dst, u_char *src, size_t size)
  973. {
  974.     ngx_uint_t      n;
  975.     static u_char   hex[] = "0123456789ABCDEF";

  977.     static uint32_t   escape[] = {
  978.         0xffffffff, /* 1111 1111 1111 1111  1111 1111 1111 1111 */

  980.                     /* ?>=< ;:98 7654 3210  /.-, +*)( '&%$ #"!  */
  981.         0x00000004, /* 0000 0000 0000 0000  0000 0000 0000 0100 */

  983.                     /* _^]\ [ZYX WVUT SRQP  ONML KJIH GFED CBA@ */
  984.         0x10000000, /* 0001 0000 0000 0000  0000 0000 0000 0000 */

  986.                     /*  ~}| {zyx wvut srqp  onml kjih gfed cba` */
  987.         0x80000000, /* 1000 0000 0000 0000  0000 0000 0000 0000 */

  989.         0xffffffff, /* 1111 1111 1111 1111  1111 1111 1111 1111 */
  990.         0xffffffff, /* 1111 1111 1111 1111  1111 1111 1111 1111 */
  991.         0xffffffff, /* 1111 1111 1111 1111  1111 1111 1111 1111 */
  992.         0xffffffff, /* 1111 1111 1111 1111  1111 1111 1111 1111 */
  993.     };


  996.     if (dst == NULL) {

  998.         /* find the number of the characters to be escaped */

  1000.         n = 0;

  1002.         while (size) {
  1003.             if (escape[*src >> 5] & (1 << (*src & 0x1f))) {
  1004.                 n++;
  1005.             }
  1006.             src++;
  1007.             size--;
  1008.         }

  1010.         return (uintptr_t) n;
  1011.     }

  1013.     while (size) {
  1014.         if (escape[*src >> 5] & (1 << (*src & 0x1f))) {
  1015.             *dst++ = '\\';
  1016.             *dst++ = 'x';
  1017.             *dst++ = hex[*src >> 4];
  1018.             *dst++ = hex[*src & 0xf];
  1019.             src++;

  1021.         } else {
  1022.             *dst++ = *src++;
  1023.         }
  1024.         size--;
  1025.     }

  1027.     return (uintptr_t) dst;
  1028. }


  1031. static void *
  1032. ‌ngx_http_log_create_main_conf(ngx_conf_t *cf)
  1033. {
  1034.     ngx_http_log_main_conf_t  *conf;

  1036.     ngx_http_log_fmt_t  *fmt;

  1038.     conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_log_main_conf_t));
  1039.     if (conf == NULL) {
  1040.         return NULL;
  1041.     }

  1043.     if (ngx_array_init(&conf->formats, cf->pool, 4, sizeof(ngx_http_log_fmt_t))
  1044.         != NGX_OK)
  1045.     {
  1046.         return NULL;
  1047.     }

  1049.     fmt = ngx_array_push(&conf->formats);
  1050.     if (fmt == NULL) {
  1051.         return NULL;
  1052.     }

  1054.     ngx_str_set(&fmt->name, "combined");

  1056.     fmt->flushes = NULL;

  1058.     fmt->ops = ngx_array_create(cf->pool, 16, sizeof(ngx_http_log_op_t));
  1059.     if (fmt->ops == NULL) {
  1060.         return NULL;
  1061.     }

  1063.     return conf;
  1064. }


  1067. static void *
  1068. ‌ngx_http_log_create_loc_conf(ngx_conf_t *cf)
  1069. {
  1070.     ngx_http_log_loc_conf_t  *conf;

  1072.     conf = ngx_pcalloc(cf->pool, sizeof(ngx_http_log_loc_conf_t));
  1073.     if (conf == NULL) {
  1074.         return NULL;
  1075.     }

  1077.     conf->open_file_cache = NGX_CONF_UNSET_PTR;

  1079.     return conf;
  1080. }


  1083. static char *
  1084. ‌ngx_http_log_merge_loc_conf(ngx_conf_t *cf, void *parent, void *child)
  1085. {
  1086.     ngx_http_log_loc_conf_t *prev = parent;
  1087.     ngx_http_log_loc_conf_t *conf = child;

  1089.     ngx_http_log_t            *log;
  1090.     ngx_http_log_fmt_t        *fmt;
  1091.     ngx_http_log_main_conf_t  *lmcf;

  1093.     if (conf->open_file_cache == NGX_CONF_UNSET_PTR) {

  1095.         conf->open_file_cache = prev->open_file_cache;
  1096.         conf->open_file_cache_valid = prev->open_file_cache_valid;
  1097.         conf->open_file_cache_min_uses = prev->open_file_cache_min_uses;

  1099.         if (conf->open_file_cache == NGX_CONF_UNSET_PTR) {
  1100.             conf->open_file_cache = NULL;
  1101.         }
  1102.     }

  1104.     if (conf->logs || conf->off) {
  1105.         return NGX_CONF_OK;
  1106.     }

  1108.     conf->logs = prev->logs;
  1109.     conf->off = prev->off;

  1111.     if (conf->logs || conf->off) {
  1112.         return NGX_CONF_OK;
  1113.     }

  1115.     conf->logs = ngx_array_create(cf->pool, 2, sizeof(ngx_http_log_t));
  1116.     if (conf->logs == NULL) {
  1117.         return NGX_CONF_ERROR;
  1118.     }

  1120.     log = ngx_array_push(conf->logs);
  1121.     if (log == NULL) {
  1122.         return NGX_CONF_ERROR;
  1123.     }

  1125.     ngx_memzero(log, sizeof(ngx_http_log_t));

  1127.     log->file = ngx_conf_open_file(cf->cycle, &ngx_http_access_log);
  1128.     if (log->file == NULL) {
  1129.         return NGX_CONF_ERROR;
  1130.     }

  1132.     lmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_log_module);
  1133.     fmt = lmcf->formats.elts;

  1135.     /* the default "combined" format */
  1136.     log->format = &fmt[0];
  1137.     lmcf->combined_used = 1;

  1139.     return NGX_CONF_OK;
  1140. }


  1143. static char *
  1144. ‌ngx_http_log_set_log(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  1145. {
  1146.     ngx_http_log_loc_conf_t *llcf = conf;

  1148.     ssize_t                            size;
  1149.     ngx_int_t                          gzip;
  1150.     ngx_uint_t                         i, n;
  1151.     ngx_msec_t                         flush;
  1152.     ngx_str_t                         *value, name, s;
  1153.     ngx_http_log_t                    *log;
  1154.     ngx_syslog_peer_t                 *peer;
  1155.     ngx_http_log_buf_t                *buffer;
  1156.     ngx_http_log_fmt_t                *fmt;
  1157.     ngx_http_log_main_conf_t          *lmcf;
  1158.     ngx_http_script_compile_t          sc;
  1159.     ngx_http_compile_complex_value_t   ccv;

  1161.     value = cf->args->elts;

  1163.     if (ngx_strcmp(value[1].data, "off") == 0) {
  1164.         llcf->off = 1;
  1165.         if (cf->args->nelts == 2) {
  1166.             return NGX_CONF_OK;
  1167.         }

  1169.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1170.                            "invalid parameter \"%V\"", &value[2]);
  1171.         return NGX_CONF_ERROR;
  1172.     }

  1174.     if (llcf->logs == NULL) {
  1175.         llcf->logs = ngx_array_create(cf->pool, 2, sizeof(ngx_http_log_t));
  1176.         if (llcf->logs == NULL) {
  1177.             return NGX_CONF_ERROR;
  1178.         }
  1179.     }

  1181.     lmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_log_module);

  1183.     log = ngx_array_push(llcf->logs);
  1184.     if (log == NULL) {
  1185.         return NGX_CONF_ERROR;
  1186.     }

  1188.     ngx_memzero(log, sizeof(ngx_http_log_t));


  1191.     if (ngx_strncmp(value[1].data, "syslog:", 7) == 0) {

  1193.         peer = ngx_pcalloc(cf->pool, sizeof(ngx_syslog_peer_t));
  1194.         if (peer == NULL) {
  1195.             return NGX_CONF_ERROR;
  1196.         }

  1198.         if (ngx_syslog_process_conf(cf, peer) != NGX_CONF_OK) {
  1199.             return NGX_CONF_ERROR;
  1200.         }

  1202.         log->syslog_peer = peer;

  1204.         goto process_formats;
  1205.     }

  1207.     n = ngx_http_script_variables_count(&value[1]);

  1209.     if (n == 0) {
  1210.         log->file = ngx_conf_open_file(cf->cycle, &value[1]);
  1211.         if (log->file == NULL) {
  1212.             return NGX_CONF_ERROR;
  1213.         }

  1215.     } else {
  1216.         if (ngx_conf_full_name(cf->cycle, &value[1], 0) != NGX_OK) {
  1217.             return NGX_CONF_ERROR;
  1218.         }

  1220.         log->script = ngx_pcalloc(cf->pool, sizeof(ngx_http_log_script_t));
  1221.         if (log->script == NULL) {
  1222.             return NGX_CONF_ERROR;
  1223.         }

  1225.         ngx_memzero(&sc, sizeof(ngx_http_script_compile_t));

  1227.         sc.cf = cf;
  1228.         sc.source = &value[1];
  1229.         sc.lengths = &log->script->lengths;
  1230.         sc.values = &log->script->values;
  1231.         sc.variables = n;
  1232.         sc.complete_lengths = 1;
  1233.         sc.complete_values = 1;

  1235.         if (ngx_http_script_compile(&sc) != NGX_OK) {
  1236.             return NGX_CONF_ERROR;
  1237.         }
  1238.     }

  1240. process_formats:

  1242.     if (cf->args->nelts >= 3) {
  1243.         name = value[2];

  1245.         if (ngx_strcmp(name.data, "combined") == 0) {
  1246.             lmcf->combined_used = 1;
  1247.         }

  1249.     } else {
  1250.         ngx_str_set(&name, "combined");
  1251.         lmcf->combined_used = 1;
  1252.     }

  1254.     fmt = lmcf->formats.elts;
  1255.     for (i = 0; i < lmcf->formats.nelts; i++) {
  1256.         if (fmt[i].name.len == name.len
  1257.             && ngx_strcasecmp(fmt[i].name.data, name.data) == 0)
  1258.         {
  1259.             log->format = &fmt[i];
  1260.             break;
  1261.         }
  1262.     }

  1264.     if (log->format == NULL) {
  1265.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1266.                            "unknown log format \"%V\"", &name);
  1267.         return NGX_CONF_ERROR;
  1268.     }

  1270.     size = 0;
  1271.     flush = 0;
  1272.     gzip = 0;

  1274.     for (i = 3; i < cf->args->nelts; i++) {

  1276.         if (ngx_strncmp(value[i].data, "buffer=", 7) == 0) {
  1277.             s.len = value[i].len - 7;
  1278.             s.data = value[i].data + 7;

  1280.             size = ngx_parse_size(&s);

  1282.             if (size == NGX_ERROR || size == 0) {
  1283.                 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1284.                                    "invalid buffer size \"%V\"", &s);
  1285.                 return NGX_CONF_ERROR;
  1286.             }

  1288.             continue;
  1289.         }

  1291.         if (ngx_strncmp(value[i].data, "flush=", 6) == 0) {
  1292.             s.len = value[i].len - 6;
  1293.             s.data = value[i].data + 6;

  1295.             flush = ngx_parse_time(&s, 0);

  1297.             if (flush == (ngx_msec_t) NGX_ERROR || flush == 0) {
  1298.                 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1299.                                    "invalid flush time \"%V\"", &s);
  1300.                 return NGX_CONF_ERROR;
  1301.             }

  1303.             continue;
  1304.         }

  1306.         if (ngx_strncmp(value[i].data, "gzip", 4) == 0
  1307.             && (value[i].len == 4 || value[i].data[4] == '='))
  1308.         {
  1309. #if (NGX_ZLIB)
  1310.             if (size == 0) {
  1311.                 size = 64 * 1024;
  1312.             }

  1314.             if (value[i].len == 4) {
  1315.                 gzip = Z_BEST_SPEED;
  1316.                 continue;
  1317.             }

  1319.             s.len = value[i].len - 5;
  1320.             s.data = value[i].data + 5;

  1322.             gzip = ngx_atoi(s.data, s.len);

  1324.             if (gzip < 1 || gzip > 9) {
  1325.                 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1326.                                    "invalid compression level \"%V\"", &s);
  1327.                 return NGX_CONF_ERROR;
  1328.             }

  1330.             continue;

  1332. #else
  1333.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1334.                                "nginx was built without zlib support");
  1335.             return NGX_CONF_ERROR;
  1336. #endif
  1337.         }

  1339.         if (ngx_strncmp(value[i].data, "if=", 3) == 0) {
  1340.             s.len = value[i].len - 3;
  1341.             s.data = value[i].data + 3;

  1343.             ngx_memzero(&ccv, sizeof(ngx_http_compile_complex_value_t));

  1345.             ccv.cf = cf;
  1346.             ccv.value = &s;
  1347.             ccv.complex_value = ngx_palloc(cf->pool,
  1348.                                            sizeof(ngx_http_complex_value_t));
  1349.             if (ccv.complex_value == NULL) {
  1350.                 return NGX_CONF_ERROR;
  1351.             }

  1353.             if (ngx_http_compile_complex_value(&ccv) != NGX_OK) {
  1354.                 return NGX_CONF_ERROR;
  1355.             }

  1357.             log->filter = ccv.complex_value;

  1359.             continue;
  1360.         }

  1362.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1363.                            "invalid parameter \"%V\"", &value[i]);
  1364.         return NGX_CONF_ERROR;
  1365.     }

  1367.     if (flush && size == 0) {
  1368.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1369.                            "no buffer is defined for access_log \"%V\"",
  1370.                            &value[1]);
  1371.         return NGX_CONF_ERROR;
  1372.     }

  1374.     if (size) {

  1376.         if (log->script) {
  1377.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1378.                                "buffered logs cannot have variables in name");
  1379.             return NGX_CONF_ERROR;
  1380.         }

  1382.         if (log->syslog_peer) {
  1383.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1384.                                "logs to syslog cannot be buffered");
  1385.             return NGX_CONF_ERROR;
  1386.         }

  1388.         if (log->file->data) {
  1389.             buffer = log->file->data;

  1391.             if (buffer->last - buffer->start != size
  1392.                 || buffer->flush != flush
  1393.                 || buffer->gzip != gzip)
  1394.             {
  1395.                 ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1396.                                    "access_log \"%V\" already defined "
  1397.                                    "with conflicting parameters",
  1398.                                    &value[1]);
  1399.                 return NGX_CONF_ERROR;
  1400.             }

  1402.             return NGX_CONF_OK;
  1403.         }

  1405.         buffer = ngx_pcalloc(cf->pool, sizeof(ngx_http_log_buf_t));
  1406.         if (buffer == NULL) {
  1407.             return NGX_CONF_ERROR;
  1408.         }

  1410.         buffer->start = ngx_pnalloc(cf->pool, size);
  1411.         if (buffer->start == NULL) {
  1412.             return NGX_CONF_ERROR;
  1413.         }

  1415.         buffer->pos = buffer->start;
  1416.         buffer->last = buffer->start + size;

  1418.         if (flush) {
  1419.             buffer->event = ngx_pcalloc(cf->pool, sizeof(ngx_event_t));
  1420.             if (buffer->event == NULL) {
  1421.                 return NGX_CONF_ERROR;
  1422.             }

  1424.             buffer->event->data = log->file;
  1425.             buffer->event->handler = ngx_http_log_flush_handler;
  1426.             buffer->event->log = &cf->cycle->new_log;
  1427.             buffer->event->cancelable = 1;

  1429.             buffer->flush = flush;
  1430.         }

  1432.         buffer->gzip = gzip;

  1434.         log->file->flush = ngx_http_log_flush;
  1435.         log->file->data = buffer;
  1436.     }

  1438.     return NGX_CONF_OK;
  1439. }


  1442. static char *
  1443. ‌ngx_http_log_set_format(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  1444. {
  1445.     ngx_http_log_main_conf_t *lmcf = conf;

  1447.     ngx_str_t           *value;
  1448.     ngx_uint_t           i;
  1449.     ngx_http_log_fmt_t  *fmt;

  1451.     value = cf->args->elts;

  1453.     fmt = lmcf->formats.elts;
  1454.     for (i = 0; i < lmcf->formats.nelts; i++) {
  1455.         if (fmt[i].name.len == value[1].len
  1456.             && ngx_strcmp(fmt[i].name.data, value[1].data) == 0)
  1457.         {
  1458.             ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1459.                                "duplicate \"log_format\" name \"%V\"",
  1460.                                &value[1]);
  1461.             return NGX_CONF_ERROR;
  1462.         }
  1463.     }

  1465.     fmt = ngx_array_push(&lmcf->formats);
  1466.     if (fmt == NULL) {
  1467.         return NGX_CONF_ERROR;
  1468.     }

  1470.     fmt->name = value[1];

  1472.     fmt->flushes = ngx_array_create(cf->pool, 4, sizeof(ngx_int_t));
  1473.     if (fmt->flushes == NULL) {
  1474.         return NGX_CONF_ERROR;
  1475.     }

  1477.     fmt->ops = ngx_array_create(cf->pool, 16, sizeof(ngx_http_log_op_t));
  1478.     if (fmt->ops == NULL) {
  1479.         return NGX_CONF_ERROR;
  1480.     }

  1482.     return ngx_http_log_compile_format(cf, fmt->flushes, fmt->ops, cf->args, 2);
  1483. }


  1486. static char *
  1487. ‌ngx_http_log_compile_format(ngx_conf_t *cf, ngx_array_t *flushes,
  1488.     ngx_array_t *ops, ngx_array_t *args, ngx_uint_t s)
  1489. {
  1490.     u_char              *data, *p, ch;
  1491.     size_t               i, len;
  1492.     ngx_str_t           *value, var;
  1493.     ngx_int_t           *flush;
  1494.     ngx_uint_t           bracket;
  1495.     ngx_http_log_op_t   *op;
  1496.     ngx_http_log_var_t  *v;

  1498.     value = args->elts;

  1500.     for ( /* void */ ; s < args->nelts; s++) {

  1502.         i = 0;

  1504.         while (i < value[s].len) {

  1506.             op = ngx_array_push(ops);
  1507.             if (op == NULL) {
  1508.                 return NGX_CONF_ERROR;
  1509.             }

  1511.             data = &value[s].data[i];

  1513.             if (value[s].data[i] == '$') {

  1515.                 if (++i == value[s].len) {
  1516.                     goto invalid;
  1517.                 }

  1519.                 if (value[s].data[i] == '{') {
  1520.                     bracket = 1;

  1522.                     if (++i == value[s].len) {
  1523.                         goto invalid;
  1524.                     }

  1526.                     var.data = &value[s].data[i];

  1528.                 } else {
  1529.                     bracket = 0;
  1530.                     var.data = &value[s].data[i];
  1531.                 }

  1533.                 for (var.len = 0; i < value[s].len; i++, var.len++) {
  1534.                     ch = value[s].data[i];

  1536.                     if (ch == '}' && bracket) {
  1537.                         i++;
  1538.                         bracket = 0;
  1539.                         break;
  1540.                     }

  1542.                     if ((ch >= 'A' && ch <= 'Z')
  1543.                         || (ch >= 'a' && ch <= 'z')
  1544.                         || (ch >= '0' && ch <= '9')
  1545.                         || ch == '_')
  1546.                     {
  1547.                         continue;
  1548.                     }

  1550.                     break;
  1551.                 }

  1553.                 if (bracket) {
  1554.                     ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1555.                                        "the closing bracket in \"%V\" "
  1556.                                        "variable is missing", &var);
  1557.                     return NGX_CONF_ERROR;
  1558.                 }

  1560.                 if (var.len == 0) {
  1561.                     goto invalid;
  1562.                 }

  1564.                 for (v = ngx_http_log_vars; v->name.len; v++) {

  1566.                     if (v->name.len == var.len
  1567.                         && ngx_strncmp(v->name.data, var.data, var.len) == 0)
  1568.                     {
  1569.                         op->len = v->len;
  1570.                         op->getlen = NULL;
  1571.                         op->run = v->run;
  1572.                         op->data = 0;

  1574.                         goto found;
  1575.                     }
  1576.                 }

  1578.                 if (ngx_http_log_variable_compile(cf, op, &var) != NGX_OK) {
  1579.                     return NGX_CONF_ERROR;
  1580.                 }

  1582.                 if (flushes) {

  1584.                     flush = ngx_array_push(flushes);
  1585.                     if (flush == NULL) {
  1586.                         return NGX_CONF_ERROR;
  1587.                     }

  1589.                     *flush = op->data; /* variable index */
  1590.                 }

  1592.             found:

  1594.                 continue;
  1595.             }

  1597.             i++;

  1599.             while (i < value[s].len && value[s].data[i] != '$') {
  1600.                 i++;
  1601.             }

  1603.             len = &value[s].data[i] - data;

  1605.             if (len) {

  1607.                 op->len = len;
  1608.                 op->getlen = NULL;

  1610.                 if (len <= sizeof(uintptr_t)) {
  1611.                     op->run = ngx_http_log_copy_short;
  1612.                     op->data = 0;

  1614.                     while (len--) {
  1615.                         op->data <<= 8;
  1616.                         op->data |= data[len];
  1617.                     }

  1619.                 } else {
  1620.                     op->run = ngx_http_log_copy_long;

  1622.                     p = ngx_pnalloc(cf->pool, len);
  1623.                     if (p == NULL) {
  1624.                         return NGX_CONF_ERROR;
  1625.                     }

  1627.                     ngx_memcpy(p, data, len);
  1628.                     op->data = (uintptr_t) p;
  1629.                 }
  1630.             }
  1631.         }
  1632.     }

  1634.     return NGX_CONF_OK;

  1636. invalid:

  1638.     ngx_conf_log_error(NGX_LOG_EMERG, cf, 0, "invalid parameter \"%s\"", data);

  1640.     return NGX_CONF_ERROR;
  1641. }


  1644. static char *
  1645. ‌ngx_http_log_open_file_cache(ngx_conf_t *cf, ngx_command_t *cmd, void *conf)
  1646. {
  1647.     ngx_http_log_loc_conf_t *llcf = conf;

  1649.     time_t       inactive, valid;
  1650.     ngx_str_t   *value, s;
  1651.     ngx_int_t    max, min_uses;
  1652.     ngx_uint_t   i;

  1654.     if (llcf->open_file_cache != NGX_CONF_UNSET_PTR) {
  1655.         return "is duplicate";
  1656.     }

  1658.     value = cf->args->elts;

  1660.     max = 0;
  1661.     inactive = 10;
  1662.     valid = 60;
  1663.     min_uses = 1;

  1665.     for (i = 1; i < cf->args->nelts; i++) {

  1667.         if (ngx_strncmp(value[i].data, "max=", 4) == 0) {

  1669.             max = ngx_atoi(value[i].data + 4, value[i].len - 4);
  1670.             if (max == NGX_ERROR) {
  1671.                 goto failed;
  1672.             }

  1674.             continue;
  1675.         }

  1677.         if (ngx_strncmp(value[i].data, "inactive=", 9) == 0) {

  1679.             s.len = value[i].len - 9;
  1680.             s.data = value[i].data + 9;

  1682.             inactive = ngx_parse_time(&s, 1);
  1683.             if (inactive == (time_t) NGX_ERROR) {
  1684.                 goto failed;
  1685.             }

  1687.             continue;
  1688.         }

  1690.         if (ngx_strncmp(value[i].data, "min_uses=", 9) == 0) {

  1692.             min_uses = ngx_atoi(value[i].data + 9, value[i].len - 9);
  1693.             if (min_uses == NGX_ERROR) {
  1694.                 goto failed;
  1695.             }

  1697.             continue;
  1698.         }

  1700.         if (ngx_strncmp(value[i].data, "valid=", 6) == 0) {

  1702.             s.len = value[i].len - 6;
  1703.             s.data = value[i].data + 6;

  1705.             valid = ngx_parse_time(&s, 1);
  1706.             if (valid == (time_t) NGX_ERROR) {
  1707.                 goto failed;
  1708.             }

  1710.             continue;
  1711.         }

  1713.         if (ngx_strcmp(value[i].data, "off") == 0) {

  1715.             llcf->open_file_cache = NULL;

  1717.             continue;
  1718.         }

  1720.     failed:

  1722.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1723.                            "invalid \"open_log_file_cache\" parameter \"%V\"",
  1724.                            &value[i]);
  1725.         return NGX_CONF_ERROR;
  1726.     }

  1728.     if (llcf->open_file_cache == NULL) {
  1729.         return NGX_CONF_OK;
  1730.     }

  1732.     if (max == 0) {
  1733.         ngx_conf_log_error(NGX_LOG_EMERG, cf, 0,
  1734.                         "\"open_log_file_cache\" must have \"max\" parameter");
  1735.         return NGX_CONF_ERROR;
  1736.     }

  1738.     llcf->open_file_cache = ngx_open_file_cache_init(cf->pool, max, inactive);

  1740.     if (llcf->open_file_cache) {

  1742.         llcf->open_file_cache_valid = valid;
  1743.         llcf->open_file_cache_min_uses = min_uses;

  1745.         return NGX_CONF_OK;
  1746.     }

  1748.     return NGX_CONF_ERROR;
  1749. }


  1752. static ngx_int_t
  1753. ‌ngx_http_log_init(ngx_conf_t *cf)
  1754. {
  1755.     ngx_str_t                  *value;
  1756.     ngx_array_t                 a;
  1757.     ngx_http_handler_pt        *h;
  1758.     ngx_http_log_fmt_t         *fmt;
  1759.     ngx_http_log_main_conf_t   *lmcf;
  1760.     ngx_http_core_main_conf_t  *cmcf;

  1762.     lmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_log_module);

  1764.     if (lmcf->combined_used) {
  1765.         if (ngx_array_init(&a, cf->pool, 1, sizeof(ngx_str_t)) != NGX_OK) {
  1766.             return NGX_ERROR;
  1767.         }

  1769.         value = ngx_array_push(&a);
  1770.         if (value == NULL) {
  1771.             return NGX_ERROR;
  1772.         }

  1774.         *value = ngx_http_combined_fmt;
  1775.         fmt = lmcf->formats.elts;

  1777.         if (ngx_http_log_compile_format(cf, NULL, fmt->ops, &a, 0)
  1778.             != NGX_CONF_OK)
  1779.         {
  1780.             return NGX_ERROR;
  1781.         }
  1782.     }

  1784.     cmcf = ngx_http_conf_get_module_main_conf(cf, ngx_http_core_module);

  1786.     h = ngx_array_push(&cmcf->phases[NGX_HTTP_LOG_PHASE].handlers);
  1787.     if (h == NULL) {
  1788.         return NGX_ERROR;
  1789.     }

  1791.     *h = ngx_http_log_handler;

  1793.     return NGX_OK;
  1794. }

One Level Up Top Level