1e18a033bSKonstantin Ananyev
2e18a033bSKonstantin Ananyev/*
3e18a033bSKonstantin Ananyev * Copyright (C) Igor Sysoev
4e18a033bSKonstantin Ananyev * Copyright (C) Nginx, Inc.
5e18a033bSKonstantin Ananyev */
6e18a033bSKonstantin Ananyev
7e18a033bSKonstantin Ananyev
8e18a033bSKonstantin Ananyev#ifndef _NGX_CONF_FILE_H_INCLUDED_
9e18a033bSKonstantin Ananyev#define _NGX_CONF_FILE_H_INCLUDED_
10e18a033bSKonstantin Ananyev
11e18a033bSKonstantin Ananyev
12e18a033bSKonstantin Ananyev#include <ngx_config.h>
13e18a033bSKonstantin Ananyev#include <ngx_core.h>
14e18a033bSKonstantin Ananyev
15e18a033bSKonstantin Ananyev
16e18a033bSKonstantin Ananyev/*
17e18a033bSKonstantin Ananyev *        AAAA  number of arguments
18e18a033bSKonstantin Ananyev *      FF      command flags
19e18a033bSKonstantin Ananyev *    TT        command type, i.e. HTTP "location" or "server" command
20e18a033bSKonstantin Ananyev */
21e18a033bSKonstantin Ananyev
22e18a033bSKonstantin Ananyev#define NGX_CONF_NOARGS      0x00000001
23e18a033bSKonstantin Ananyev#define NGX_CONF_TAKE1       0x00000002
24e18a033bSKonstantin Ananyev#define NGX_CONF_TAKE2       0x00000004
25e18a033bSKonstantin Ananyev#define NGX_CONF_TAKE3       0x00000008
26e18a033bSKonstantin Ananyev#define NGX_CONF_TAKE4       0x00000010
27e18a033bSKonstantin Ananyev#define NGX_CONF_TAKE5       0x00000020
28e18a033bSKonstantin Ananyev#define NGX_CONF_TAKE6       0x00000040
29e18a033bSKonstantin Ananyev#define NGX_CONF_TAKE7       0x00000080
30e18a033bSKonstantin Ananyev
31e18a033bSKonstantin Ananyev#define NGX_CONF_MAX_ARGS    8
32e18a033bSKonstantin Ananyev
33e18a033bSKonstantin Ananyev#define NGX_CONF_TAKE12      (NGX_CONF_TAKE1|NGX_CONF_TAKE2)
34e18a033bSKonstantin Ananyev#define NGX_CONF_TAKE13      (NGX_CONF_TAKE1|NGX_CONF_TAKE3)
35e18a033bSKonstantin Ananyev
36e18a033bSKonstantin Ananyev#define NGX_CONF_TAKE23      (NGX_CONF_TAKE2|NGX_CONF_TAKE3)
37e18a033bSKonstantin Ananyev
38e18a033bSKonstantin Ananyev#define NGX_CONF_TAKE123     (NGX_CONF_TAKE1|NGX_CONF_TAKE2|NGX_CONF_TAKE3)
39e18a033bSKonstantin Ananyev#define NGX_CONF_TAKE1234    (NGX_CONF_TAKE1|NGX_CONF_TAKE2|NGX_CONF_TAKE3   \
40e18a033bSKonstantin Ananyev                              |NGX_CONF_TAKE4)
41e18a033bSKonstantin Ananyev
42e18a033bSKonstantin Ananyev#define NGX_CONF_ARGS_NUMBER 0x000000ff
43e18a033bSKonstantin Ananyev#define NGX_CONF_BLOCK       0x00000100
44e18a033bSKonstantin Ananyev#define NGX_CONF_FLAG        0x00000200
45e18a033bSKonstantin Ananyev#define NGX_CONF_ANY         0x00000400
46e18a033bSKonstantin Ananyev#define NGX_CONF_1MORE       0x00000800
47e18a033bSKonstantin Ananyev#define NGX_CONF_2MORE       0x00001000
48e18a033bSKonstantin Ananyev
49e18a033bSKonstantin Ananyev#define NGX_DIRECT_CONF      0x00010000
50e18a033bSKonstantin Ananyev
51e18a033bSKonstantin Ananyev#define NGX_MAIN_CONF        0x01000000
52e18a033bSKonstantin Ananyev#define NGX_ANY_CONF         0x1F000000
53e18a033bSKonstantin Ananyev
54e18a033bSKonstantin Ananyev
55e18a033bSKonstantin Ananyev
56e18a033bSKonstantin Ananyev#define NGX_CONF_UNSET       -1
57e18a033bSKonstantin Ananyev#define NGX_CONF_UNSET_UINT  (ngx_uint_t) -1
58e18a033bSKonstantin Ananyev#define NGX_CONF_UNSET_PTR   (void *) -1
59e18a033bSKonstantin Ananyev#define NGX_CONF_UNSET_SIZE  (size_t) -1
60e18a033bSKonstantin Ananyev#define NGX_CONF_UNSET_MSEC  (ngx_msec_t) -1
61e18a033bSKonstantin Ananyev
62e18a033bSKonstantin Ananyev
63e18a033bSKonstantin Ananyev#define NGX_CONF_OK          NULL
64e18a033bSKonstantin Ananyev#define NGX_CONF_ERROR       (void *) -1
65e18a033bSKonstantin Ananyev
66e18a033bSKonstantin Ananyev#define NGX_CONF_BLOCK_START 1
67e18a033bSKonstantin Ananyev#define NGX_CONF_BLOCK_DONE  2
68e18a033bSKonstantin Ananyev#define NGX_CONF_FILE_DONE   3
69e18a033bSKonstantin Ananyev
70e18a033bSKonstantin Ananyev#define NGX_CORE_MODULE      0x45524F43  /* "CORE" */
71e18a033bSKonstantin Ananyev#define NGX_CONF_MODULE      0x464E4F43  /* "CONF" */
72e18a033bSKonstantin Ananyev
73e18a033bSKonstantin Ananyev
74e18a033bSKonstantin Ananyev#define NGX_MAX_CONF_ERRSTR  1024
75e18a033bSKonstantin Ananyev
76e18a033bSKonstantin Ananyev
77e18a033bSKonstantin Ananyevstruct ngx_command_s {
78e18a033bSKonstantin Ananyev    ngx_str_t             name;
79e18a033bSKonstantin Ananyev    ngx_uint_t            type;
80e18a033bSKonstantin Ananyev    char               *(*set)(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
81e18a033bSKonstantin Ananyev    ngx_uint_t            conf;
82e18a033bSKonstantin Ananyev    ngx_uint_t            offset;
83e18a033bSKonstantin Ananyev    void                 *post;
84e18a033bSKonstantin Ananyev};
85e18a033bSKonstantin Ananyev
86e18a033bSKonstantin Ananyev#define ngx_null_command  { ngx_null_string, 0, NULL, 0, 0, NULL }
87e18a033bSKonstantin Ananyev
88e18a033bSKonstantin Ananyev
89e18a033bSKonstantin Ananyevstruct ngx_open_file_s {
90e18a033bSKonstantin Ananyev    ngx_fd_t              fd;
91e18a033bSKonstantin Ananyev    ngx_str_t             name;
92e18a033bSKonstantin Ananyev
93e18a033bSKonstantin Ananyev    void                (*flush)(ngx_open_file_t *file, ngx_log_t *log);
94e18a033bSKonstantin Ananyev    void                 *data;
95e18a033bSKonstantin Ananyev};
96e18a033bSKonstantin Ananyev
97e18a033bSKonstantin Ananyev
98e18a033bSKonstantin Ananyevtypedef struct {
99e18a033bSKonstantin Ananyev    ngx_file_t            file;
100e18a033bSKonstantin Ananyev    ngx_buf_t            *buffer;
101e18a033bSKonstantin Ananyev    ngx_buf_t            *dump;
102e18a033bSKonstantin Ananyev    ngx_uint_t            line;
103e18a033bSKonstantin Ananyev} ngx_conf_file_t;
104e18a033bSKonstantin Ananyev
105e18a033bSKonstantin Ananyev
106e18a033bSKonstantin Ananyevtypedef struct {
107e18a033bSKonstantin Ananyev    ngx_str_t             name;
108e18a033bSKonstantin Ananyev    ngx_buf_t            *buffer;
109e18a033bSKonstantin Ananyev} ngx_conf_dump_t;
110e18a033bSKonstantin Ananyev
111e18a033bSKonstantin Ananyev
112e18a033bSKonstantin Ananyevtypedef char *(*ngx_conf_handler_pt)(ngx_conf_t *cf,
113e18a033bSKonstantin Ananyev    ngx_command_t *dummy, void *conf);
114e18a033bSKonstantin Ananyev
115e18a033bSKonstantin Ananyev
116e18a033bSKonstantin Ananyevstruct ngx_conf_s {
117e18a033bSKonstantin Ananyev    char                 *name;
118e18a033bSKonstantin Ananyev    ngx_array_t          *args;
119e18a033bSKonstantin Ananyev
120e18a033bSKonstantin Ananyev    ngx_cycle_t          *cycle;
121e18a033bSKonstantin Ananyev    ngx_pool_t           *pool;
122e18a033bSKonstantin Ananyev    ngx_pool_t           *temp_pool;
123e18a033bSKonstantin Ananyev    ngx_conf_file_t      *conf_file;
124e18a033bSKonstantin Ananyev    ngx_log_t            *log;
125e18a033bSKonstantin Ananyev
126e18a033bSKonstantin Ananyev    void                 *ctx;
127e18a033bSKonstantin Ananyev    ngx_uint_t            module_type;
128e18a033bSKonstantin Ananyev    ngx_uint_t            cmd_type;
129e18a033bSKonstantin Ananyev
130e18a033bSKonstantin Ananyev    ngx_conf_handler_pt   handler;
131e18a033bSKonstantin Ananyev    char                 *handler_conf;
132e18a033bSKonstantin Ananyev};
133e18a033bSKonstantin Ananyev
134e18a033bSKonstantin Ananyev
135e18a033bSKonstantin Ananyevtypedef char *(*ngx_conf_post_handler_pt) (ngx_conf_t *cf,
136e18a033bSKonstantin Ananyev    void *data, void *conf);
137e18a033bSKonstantin Ananyev
138e18a033bSKonstantin Ananyevtypedef struct {
139e18a033bSKonstantin Ananyev    ngx_conf_post_handler_pt  post_handler;
140e18a033bSKonstantin Ananyev} ngx_conf_post_t;
141e18a033bSKonstantin Ananyev
142e18a033bSKonstantin Ananyev
143e18a033bSKonstantin Ananyevtypedef struct {
144e18a033bSKonstantin Ananyev    ngx_conf_post_handler_pt  post_handler;
145e18a033bSKonstantin Ananyev    char                     *old_name;
146e18a033bSKonstantin Ananyev    char                     *new_name;
147e18a033bSKonstantin Ananyev} ngx_conf_deprecated_t;
148e18a033bSKonstantin Ananyev
149e18a033bSKonstantin Ananyev
150e18a033bSKonstantin Ananyevtypedef struct {
151e18a033bSKonstantin Ananyev    ngx_conf_post_handler_pt  post_handler;
152e18a033bSKonstantin Ananyev    ngx_int_t                 low;
153e18a033bSKonstantin Ananyev    ngx_int_t                 high;
154e18a033bSKonstantin Ananyev} ngx_conf_num_bounds_t;
155e18a033bSKonstantin Ananyev
156e18a033bSKonstantin Ananyev
157e18a033bSKonstantin Ananyevtypedef struct {
158e18a033bSKonstantin Ananyev    ngx_str_t                 name;
159e18a033bSKonstantin Ananyev    ngx_uint_t                value;
160e18a033bSKonstantin Ananyev} ngx_conf_enum_t;
161e18a033bSKonstantin Ananyev
162e18a033bSKonstantin Ananyev
163e18a033bSKonstantin Ananyev#define NGX_CONF_BITMASK_SET  1
164e18a033bSKonstantin Ananyev
165e18a033bSKonstantin Ananyevtypedef struct {
166e18a033bSKonstantin Ananyev    ngx_str_t                 name;
167e18a033bSKonstantin Ananyev    ngx_uint_t                mask;
168e18a033bSKonstantin Ananyev} ngx_conf_bitmask_t;
169e18a033bSKonstantin Ananyev
170e18a033bSKonstantin Ananyev
171e18a033bSKonstantin Ananyev
172e18a033bSKonstantin Ananyevchar * ngx_conf_deprecated(ngx_conf_t *cf, void *post, void *data);
173e18a033bSKonstantin Ananyevchar *ngx_conf_check_num_bounds(ngx_conf_t *cf, void *post, void *data);
174e18a033bSKonstantin Ananyev
175e18a033bSKonstantin Ananyev
176e18a033bSKonstantin Ananyev#define ngx_get_conf(conf_ctx, module)  conf_ctx[module.index]
177e18a033bSKonstantin Ananyev
178e18a033bSKonstantin Ananyev
179e18a033bSKonstantin Ananyev
180e18a033bSKonstantin Ananyev#define ngx_conf_init_value(conf, default)                                   \
181e18a033bSKonstantin Ananyev    if (conf == NGX_CONF_UNSET) {                                            \
182e18a033bSKonstantin Ananyev        conf = default;                                                      \
183e18a033bSKonstantin Ananyev    }
184e18a033bSKonstantin Ananyev
185e18a033bSKonstantin Ananyev#define ngx_conf_init_ptr_value(conf, default)                               \
186e18a033bSKonstantin Ananyev    if (conf == NGX_CONF_UNSET_PTR) {                                        \
187e18a033bSKonstantin Ananyev        conf = default;                                                      \
188e18a033bSKonstantin Ananyev    }
189e18a033bSKonstantin Ananyev
190e18a033bSKonstantin Ananyev#define ngx_conf_init_uint_value(conf, default)                              \
191e18a033bSKonstantin Ananyev    if (conf == NGX_CONF_UNSET_UINT) {                                       \
192e18a033bSKonstantin Ananyev        conf = default;                                                      \
193e18a033bSKonstantin Ananyev    }
194e18a033bSKonstantin Ananyev
195e18a033bSKonstantin Ananyev#define ngx_conf_init_size_value(conf, default)                              \
196e18a033bSKonstantin Ananyev    if (conf == NGX_CONF_UNSET_SIZE) {                                       \
197e18a033bSKonstantin Ananyev        conf = default;                                                      \
198e18a033bSKonstantin Ananyev    }
199e18a033bSKonstantin Ananyev
200e18a033bSKonstantin Ananyev#define ngx_conf_init_msec_value(conf, default)                              \
201e18a033bSKonstantin Ananyev    if (conf == NGX_CONF_UNSET_MSEC) {                                       \
202e18a033bSKonstantin Ananyev        conf = default;                                                      \
203e18a033bSKonstantin Ananyev    }
204e18a033bSKonstantin Ananyev
205e18a033bSKonstantin Ananyev#define ngx_conf_merge_value(conf, prev, default)                            \
206e18a033bSKonstantin Ananyev    if (conf == NGX_CONF_UNSET) {                                            \
207e18a033bSKonstantin Ananyev        conf = (prev == NGX_CONF_UNSET) ? default : prev;                    \
208e18a033bSKonstantin Ananyev    }
209e18a033bSKonstantin Ananyev
210e18a033bSKonstantin Ananyev#define ngx_conf_merge_ptr_value(conf, prev, default)                        \
211e18a033bSKonstantin Ananyev    if (conf == NGX_CONF_UNSET_PTR) {                                        \
212e18a033bSKonstantin Ananyev        conf = (prev == NGX_CONF_UNSET_PTR) ? default : prev;                \
213e18a033bSKonstantin Ananyev    }
214e18a033bSKonstantin Ananyev
215e18a033bSKonstantin Ananyev#define ngx_conf_merge_uint_value(conf, prev, default)                       \
216e18a033bSKonstantin Ananyev    if (conf == NGX_CONF_UNSET_UINT) {                                       \
217e18a033bSKonstantin Ananyev        conf = (prev == NGX_CONF_UNSET_UINT) ? default : prev;               \
218e18a033bSKonstantin Ananyev    }
219e18a033bSKonstantin Ananyev
220e18a033bSKonstantin Ananyev#define ngx_conf_merge_msec_value(conf, prev, default)                       \
221e18a033bSKonstantin Ananyev    if (conf == NGX_CONF_UNSET_MSEC) {                                       \
222e18a033bSKonstantin Ananyev        conf = (prev == NGX_CONF_UNSET_MSEC) ? default : prev;               \
223e18a033bSKonstantin Ananyev    }
224e18a033bSKonstantin Ananyev
225e18a033bSKonstantin Ananyev#define ngx_conf_merge_sec_value(conf, prev, default)                        \
226e18a033bSKonstantin Ananyev    if (conf == NGX_CONF_UNSET) {                                            \
227e18a033bSKonstantin Ananyev        conf = (prev == NGX_CONF_UNSET) ? default : prev;                    \
228e18a033bSKonstantin Ananyev    }
229e18a033bSKonstantin Ananyev
230e18a033bSKonstantin Ananyev#define ngx_conf_merge_size_value(conf, prev, default)                       \
231e18a033bSKonstantin Ananyev    if (conf == NGX_CONF_UNSET_SIZE) {                                       \
232e18a033bSKonstantin Ananyev        conf = (prev == NGX_CONF_UNSET_SIZE) ? default : prev;               \
233e18a033bSKonstantin Ananyev    }
234e18a033bSKonstantin Ananyev
235e18a033bSKonstantin Ananyev#define ngx_conf_merge_off_value(conf, prev, default)                        \
236e18a033bSKonstantin Ananyev    if (conf == NGX_CONF_UNSET) {                                            \
237e18a033bSKonstantin Ananyev        conf = (prev == NGX_CONF_UNSET) ? default : prev;                    \
238e18a033bSKonstantin Ananyev    }
239e18a033bSKonstantin Ananyev
240e18a033bSKonstantin Ananyev#define ngx_conf_merge_str_value(conf, prev, default)                        \
241e18a033bSKonstantin Ananyev    if (conf.data == NULL) {                                                 \
242e18a033bSKonstantin Ananyev        if (prev.data) {                                                     \
243e18a033bSKonstantin Ananyev            conf.len = prev.len;                                             \
244e18a033bSKonstantin Ananyev            conf.data = prev.data;                                           \
245e18a033bSKonstantin Ananyev        } else {                                                             \
246e18a033bSKonstantin Ananyev            conf.len = sizeof(default) - 1;                                  \
247e18a033bSKonstantin Ananyev            conf.data = (u_char *) default;                                  \
248e18a033bSKonstantin Ananyev        }                                                                    \
249e18a033bSKonstantin Ananyev    }
250e18a033bSKonstantin Ananyev
251e18a033bSKonstantin Ananyev#define ngx_conf_merge_bufs_value(conf, prev, default_num, default_size)     \
252e18a033bSKonstantin Ananyev    if (conf.num == 0) {                                                     \
253e18a033bSKonstantin Ananyev        if (prev.num) {                                                      \
254e18a033bSKonstantin Ananyev            conf.num = prev.num;                                             \
255e18a033bSKonstantin Ananyev            conf.size = prev.size;                                           \
256e18a033bSKonstantin Ananyev        } else {                                                             \
257e18a033bSKonstantin Ananyev            conf.num = default_num;                                          \
258e18a033bSKonstantin Ananyev            conf.size = default_size;                                        \
259e18a033bSKonstantin Ananyev        }                                                                    \
260e18a033bSKonstantin Ananyev    }
261e18a033bSKonstantin Ananyev
262e18a033bSKonstantin Ananyev#define ngx_conf_merge_bitmask_value(conf, prev, default)                    \
263e18a033bSKonstantin Ananyev    if (conf == 0) {                                                         \
264e18a033bSKonstantin Ananyev        conf = (prev == 0) ? default : prev;                                 \
265e18a033bSKonstantin Ananyev    }
266e18a033bSKonstantin Ananyev
267e18a033bSKonstantin Ananyev
268e18a033bSKonstantin Ananyevchar *ngx_conf_param(ngx_conf_t *cf);
269e18a033bSKonstantin Ananyevchar *ngx_conf_parse(ngx_conf_t *cf, ngx_str_t *filename);
270e18a033bSKonstantin Ananyevchar *ngx_conf_include(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
271e18a033bSKonstantin Ananyev
272e18a033bSKonstantin Ananyev
273e18a033bSKonstantin Ananyevngx_int_t ngx_conf_full_name(ngx_cycle_t *cycle, ngx_str_t *name,
274e18a033bSKonstantin Ananyev    ngx_uint_t conf_prefix);
275e18a033bSKonstantin Ananyevngx_open_file_t *ngx_conf_open_file(ngx_cycle_t *cycle, ngx_str_t *name);
276e18a033bSKonstantin Ananyevvoid ngx_cdecl ngx_conf_log_error(ngx_uint_t level, ngx_conf_t *cf,
277e18a033bSKonstantin Ananyev    ngx_err_t err, const char *fmt, ...);
278e18a033bSKonstantin Ananyev
279e18a033bSKonstantin Ananyev
280e18a033bSKonstantin Ananyevchar *ngx_conf_set_flag_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
281e18a033bSKonstantin Ananyevchar *ngx_conf_set_str_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
282e18a033bSKonstantin Ananyevchar *ngx_conf_set_str_array_slot(ngx_conf_t *cf, ngx_command_t *cmd,
283e18a033bSKonstantin Ananyev    void *conf);
284e18a033bSKonstantin Ananyevchar *ngx_conf_set_keyval_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
285e18a033bSKonstantin Ananyevchar *ngx_conf_set_num_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
286e18a033bSKonstantin Ananyevchar *ngx_conf_set_size_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
287e18a033bSKonstantin Ananyevchar *ngx_conf_set_off_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
288e18a033bSKonstantin Ananyevchar *ngx_conf_set_msec_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
289e18a033bSKonstantin Ananyevchar *ngx_conf_set_sec_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
290e18a033bSKonstantin Ananyevchar *ngx_conf_set_bufs_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
291e18a033bSKonstantin Ananyevchar *ngx_conf_set_enum_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
292e18a033bSKonstantin Ananyevchar *ngx_conf_set_bitmask_slot(ngx_conf_t *cf, ngx_command_t *cmd, void *conf);
293e18a033bSKonstantin Ananyev
294e18a033bSKonstantin Ananyev
295e18a033bSKonstantin Ananyev#endif /* _NGX_CONF_FILE_H_INCLUDED_ */
296