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