Mercurial > hg > nginx
annotate src/stream/ngx_stream_script.h @ 8122:106328a70f4e
Added warning about redefinition of listen socket protocol options.
The "listen" directive in the http module can be used multiple times
in different server blocks. Originally, it was supposed to be specified
once with various socket options, and without any parameters in virtual
server blocks. For example:
server { listen 80 backlog=1024; server_name foo; ... }
server { listen 80; server_name bar; ... }
server { listen 80; server_name bazz; ... }
The address part of the syntax ("address[:port]" / "port" / "unix:path")
uniquely identifies the listening socket, and therefore is enough for
name-based virtual servers (to let nginx know that the virtual server
accepts requests on the listening socket in question).
To ensure that listening options do not conflict between virtual servers,
they were allowed only once. For example, the following configuration
will be rejected ("duplicate listen options for 0.0.0.0:80 in ..."):
server { listen 80 backlog=1024; server_name foo; ... }
server { listen 80 backlog=512; server_name bar; ... }
At some point it was, however, noticed, that it is sometimes convenient
to repeat some options for clarity. In nginx 0.8.51 the "ssl" parameter
was allowed to be specified multiple times, e.g.:
server { listen 443 ssl backlog=1024; server_name foo; ... }
server { listen 443 ssl; server_name bar; ... }
server { listen 443 ssl; server_name bazz; ... }
This approach makes configuration more readable, since SSL sockets are
immediately visible in the configuration. If this is not needed, just the
address can still be used.
Later, additional protocol-specific options similar to "ssl" were
introduced, notably "http2" and "proxy_protocol". With these options,
one can write:
server { listen 443 ssl backlog=1024; server_name foo; ... }
server { listen 443 http2; server_name bar; ... }
server { listen 443 proxy_protocol; server_name bazz; ... }
The resulting socket will use ssl, http2, and proxy_protocol, but this
is not really obvious from the configuration.
To emphasize such misleading configurations are discouraged, nginx now
warns as long as the "listen" directive is used with options different
from the options previously used if this is potentially confusing.
In particular, the following configurations are allowed:
server { listen 8401 ssl backlog=1024; server_name foo; }
server { listen 8401 ssl; server_name bar; }
server { listen 8401 ssl; server_name bazz; }
server { listen 8402 ssl http2 backlog=1024; server_name foo; }
server { listen 8402 ssl; server_name bar; }
server { listen 8402 ssl; server_name bazz; }
server { listen 8403 ssl; server_name bar; }
server { listen 8403 ssl; server_name bazz; }
server { listen 8403 ssl http2; server_name foo; }
server { listen 8404 ssl http2 backlog=1024; server_name foo; }
server { listen 8404 http2; server_name bar; }
server { listen 8404 http2; server_name bazz; }
server { listen 8405 ssl http2 backlog=1024; server_name foo; }
server { listen 8405 ssl http2; server_name bar; }
server { listen 8405 ssl http2; server_name bazz; }
server { listen 8406 ssl; server_name foo; }
server { listen 8406; server_name bar; }
server { listen 8406; server_name bazz; }
And the following configurations will generate warnings:
server { listen 8501 ssl http2 backlog=1024; server_name foo; }
server { listen 8501 http2; server_name bar; }
server { listen 8501 ssl; server_name bazz; }
server { listen 8502 backlog=1024; server_name foo; }
server { listen 8502 ssl; server_name bar; }
server { listen 8503 ssl; server_name foo; }
server { listen 8503 http2; server_name bar; }
server { listen 8504 ssl; server_name foo; }
server { listen 8504 http2; server_name bar; }
server { listen 8504 proxy_protocol; server_name bazz; }
server { listen 8505 ssl http2 proxy_protocol; server_name foo; }
server { listen 8505 ssl http2; server_name bar; }
server { listen 8505 ssl; server_name bazz; }
server { listen 8506 ssl http2; server_name foo; }
server { listen 8506 ssl; server_name bar; }
server { listen 8506; server_name bazz; }
server { listen 8507 ssl; server_name bar; }
server { listen 8507; server_name bazz; }
server { listen 8507 ssl http2; server_name foo; }
server { listen 8508 ssl; server_name bar; }
server { listen 8508; server_name bazz; }
server { listen 8508 ssl backlog=1024; server_name foo; }
server { listen 8509; server_name bazz; }
server { listen 8509 ssl; server_name bar; }
server { listen 8509 ssl backlog=1024; server_name foo; }
The basic idea is that at most two sets of protocol options are allowed:
the main one (with socket options, if any), and a shorter one, with options
being a subset of the main options, repeated for clarity. As long as the
shorter set of protocol options is used, all listen directives except the
main one should use it.
author | Maxim Dounin <mdounin@mdounin.ru> |
---|---|
date | Sat, 28 Jan 2023 01:29:45 +0300 |
parents | 3ab8e1e2f0f7 |
children |
rev | line source |
---|---|
6607 | 1 |
2 /* | |
3 * Copyright (C) Igor Sysoev | |
4 * Copyright (C) Nginx, Inc. | |
5 */ | |
6 | |
7 | |
8 #ifndef _NGX_STREAM_SCRIPT_H_INCLUDED_ | |
9 #define _NGX_STREAM_SCRIPT_H_INCLUDED_ | |
10 | |
11 | |
12 #include <ngx_config.h> | |
13 #include <ngx_core.h> | |
14 #include <ngx_stream.h> | |
15 | |
16 | |
17 typedef struct { | |
18 u_char *ip; | |
19 u_char *pos; | |
20 ngx_stream_variable_value_t *sp; | |
21 | |
22 ngx_str_t buf; | |
23 ngx_str_t line; | |
24 | |
25 unsigned flushed:1; | |
26 unsigned skip:1; | |
27 | |
28 ngx_stream_session_t *session; | |
29 } ngx_stream_script_engine_t; | |
30 | |
31 | |
32 typedef struct { | |
33 ngx_conf_t *cf; | |
34 ngx_str_t *source; | |
35 | |
36 ngx_array_t **flushes; | |
37 ngx_array_t **lengths; | |
38 ngx_array_t **values; | |
39 | |
40 ngx_uint_t variables; | |
41 ngx_uint_t ncaptures; | |
42 ngx_uint_t size; | |
43 | |
44 void *main; | |
45 | |
46 unsigned complete_lengths:1; | |
47 unsigned complete_values:1; | |
48 unsigned zero:1; | |
49 unsigned conf_prefix:1; | |
50 unsigned root_prefix:1; | |
51 } ngx_stream_script_compile_t; | |
52 | |
53 | |
54 typedef struct { | |
55 ngx_str_t value; | |
56 ngx_uint_t *flushes; | |
57 void *lengths; | |
58 void *values; | |
7503
b82162b8496a
Added ngx_http_set_complex_value_size_slot().
Ruslan Ermilov <ru@nginx.com>
parents:
6678
diff
changeset
|
59 |
b82162b8496a
Added ngx_http_set_complex_value_size_slot().
Ruslan Ermilov <ru@nginx.com>
parents:
6678
diff
changeset
|
60 union { |
b82162b8496a
Added ngx_http_set_complex_value_size_slot().
Ruslan Ermilov <ru@nginx.com>
parents:
6678
diff
changeset
|
61 size_t size; |
b82162b8496a
Added ngx_http_set_complex_value_size_slot().
Ruslan Ermilov <ru@nginx.com>
parents:
6678
diff
changeset
|
62 } u; |
6607 | 63 } ngx_stream_complex_value_t; |
64 | |
65 | |
66 typedef struct { | |
67 ngx_conf_t *cf; | |
68 ngx_str_t *value; | |
69 ngx_stream_complex_value_t *complex_value; | |
70 | |
71 unsigned zero:1; | |
72 unsigned conf_prefix:1; | |
73 unsigned root_prefix:1; | |
74 } ngx_stream_compile_complex_value_t; | |
75 | |
76 | |
77 typedef void (*ngx_stream_script_code_pt) (ngx_stream_script_engine_t *e); | |
78 typedef size_t (*ngx_stream_script_len_code_pt) (ngx_stream_script_engine_t *e); | |
79 | |
80 | |
81 typedef struct { | |
82 ngx_stream_script_code_pt code; | |
83 uintptr_t len; | |
84 } ngx_stream_script_copy_code_t; | |
85 | |
86 | |
87 typedef struct { | |
88 ngx_stream_script_code_pt code; | |
89 uintptr_t index; | |
90 } ngx_stream_script_var_code_t; | |
91 | |
92 | |
93 typedef struct { | |
94 ngx_stream_script_code_pt code; | |
95 uintptr_t n; | |
96 } ngx_stream_script_copy_capture_code_t; | |
97 | |
98 | |
99 typedef struct { | |
100 ngx_stream_script_code_pt code; | |
101 uintptr_t conf_prefix; | |
102 } ngx_stream_script_full_name_code_t; | |
103 | |
104 | |
105 void ngx_stream_script_flush_complex_value(ngx_stream_session_t *s, | |
106 ngx_stream_complex_value_t *val); | |
107 ngx_int_t ngx_stream_complex_value(ngx_stream_session_t *s, | |
108 ngx_stream_complex_value_t *val, ngx_str_t *value); | |
7503
b82162b8496a
Added ngx_http_set_complex_value_size_slot().
Ruslan Ermilov <ru@nginx.com>
parents:
6678
diff
changeset
|
109 size_t ngx_stream_complex_value_size(ngx_stream_session_t *s, |
b82162b8496a
Added ngx_http_set_complex_value_size_slot().
Ruslan Ermilov <ru@nginx.com>
parents:
6678
diff
changeset
|
110 ngx_stream_complex_value_t *val, size_t default_value); |
6607 | 111 ngx_int_t ngx_stream_compile_complex_value( |
112 ngx_stream_compile_complex_value_t *ccv); | |
113 char *ngx_stream_set_complex_value_slot(ngx_conf_t *cf, ngx_command_t *cmd, | |
114 void *conf); | |
7833
3ab8e1e2f0f7
Upstream: variables support in certificates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
7503
diff
changeset
|
115 char *ngx_stream_set_complex_value_zero_slot(ngx_conf_t *cf, ngx_command_t *cmd, |
3ab8e1e2f0f7
Upstream: variables support in certificates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
7503
diff
changeset
|
116 void *conf); |
7503
b82162b8496a
Added ngx_http_set_complex_value_size_slot().
Ruslan Ermilov <ru@nginx.com>
parents:
6678
diff
changeset
|
117 char *ngx_stream_set_complex_value_size_slot(ngx_conf_t *cf, ngx_command_t *cmd, |
b82162b8496a
Added ngx_http_set_complex_value_size_slot().
Ruslan Ermilov <ru@nginx.com>
parents:
6678
diff
changeset
|
118 void *conf); |
6607 | 119 |
120 | |
121 ngx_uint_t ngx_stream_script_variables_count(ngx_str_t *value); | |
122 ngx_int_t ngx_stream_script_compile(ngx_stream_script_compile_t *sc); | |
6678 | 123 u_char *ngx_stream_script_run(ngx_stream_session_t *s, ngx_str_t *value, |
124 void *code_lengths, size_t reserved, void *code_values); | |
125 void ngx_stream_script_flush_no_cacheable_variables(ngx_stream_session_t *s, | |
126 ngx_array_t *indices); | |
6607 | 127 |
128 void *ngx_stream_script_add_code(ngx_array_t *codes, size_t size, void *code); | |
129 | |
130 size_t ngx_stream_script_copy_len_code(ngx_stream_script_engine_t *e); | |
131 void ngx_stream_script_copy_code(ngx_stream_script_engine_t *e); | |
132 size_t ngx_stream_script_copy_var_len_code(ngx_stream_script_engine_t *e); | |
133 void ngx_stream_script_copy_var_code(ngx_stream_script_engine_t *e); | |
134 size_t ngx_stream_script_copy_capture_len_code(ngx_stream_script_engine_t *e); | |
135 void ngx_stream_script_copy_capture_code(ngx_stream_script_engine_t *e); | |
136 | |
137 #endif /* _NGX_STREAM_SCRIPT_H_INCLUDED_ */ |