1e18a033bSKonstantin Ananyev
2e18a033bSKonstantin Ananyev/*
3e18a033bSKonstantin Ananyev * Copyright (C) Roman Arutyunyan
4e18a033bSKonstantin Ananyev * Copyright (C) Nginx, Inc.
5e18a033bSKonstantin Ananyev */
6e18a033bSKonstantin Ananyev
7e18a033bSKonstantin Ananyev
8e18a033bSKonstantin Ananyev#ifndef _NGX_STREAM_H_INCLUDED_
9e18a033bSKonstantin Ananyev#define _NGX_STREAM_H_INCLUDED_
10e18a033bSKonstantin Ananyev
11e18a033bSKonstantin Ananyev
12e18a033bSKonstantin Ananyev#include <ngx_config.h>
13e18a033bSKonstantin Ananyev#include <ngx_core.h>
14e18a033bSKonstantin Ananyev
15e18a033bSKonstantin Ananyev#if (NGX_STREAM_SSL)
16e18a033bSKonstantin Ananyev#include <ngx_stream_ssl_module.h>
17e18a033bSKonstantin Ananyev#endif
18e18a033bSKonstantin Ananyev
19e18a033bSKonstantin Ananyev
20e18a033bSKonstantin Ananyevtypedef struct ngx_stream_session_s  ngx_stream_session_t;
21e18a033bSKonstantin Ananyev
22e18a033bSKonstantin Ananyev
23e18a033bSKonstantin Ananyev#include <ngx_stream_variables.h>
24e18a033bSKonstantin Ananyev#include <ngx_stream_script.h>
25e18a033bSKonstantin Ananyev#include <ngx_stream_upstream.h>
26e18a033bSKonstantin Ananyev#include <ngx_stream_upstream_round_robin.h>
27e18a033bSKonstantin Ananyev
28e18a033bSKonstantin Ananyev
29e18a033bSKonstantin Ananyev#define NGX_STREAM_OK                        200
30e18a033bSKonstantin Ananyev#define NGX_STREAM_BAD_REQUEST               400
31e18a033bSKonstantin Ananyev#define NGX_STREAM_FORBIDDEN                 403
32e18a033bSKonstantin Ananyev#define NGX_STREAM_INTERNAL_SERVER_ERROR     500
33e18a033bSKonstantin Ananyev#define NGX_STREAM_BAD_GATEWAY               502
34e18a033bSKonstantin Ananyev#define NGX_STREAM_SERVICE_UNAVAILABLE       503
35e18a033bSKonstantin Ananyev
36e18a033bSKonstantin Ananyev
37e18a033bSKonstantin Ananyevtypedef struct {
38e18a033bSKonstantin Ananyev    void                         **main_conf;
39e18a033bSKonstantin Ananyev    void                         **srv_conf;
40e18a033bSKonstantin Ananyev} ngx_stream_conf_ctx_t;
41e18a033bSKonstantin Ananyev
42e18a033bSKonstantin Ananyev
43e18a033bSKonstantin Ananyevtypedef struct {
44e18a033bSKonstantin Ananyev    ngx_sockaddr_t                 sockaddr;
45e18a033bSKonstantin Ananyev    socklen_t                      socklen;
46e18a033bSKonstantin Ananyev
47e18a033bSKonstantin Ananyev    /* server ctx */
48e18a033bSKonstantin Ananyev    ngx_stream_conf_ctx_t         *ctx;
49e18a033bSKonstantin Ananyev
50e18a033bSKonstantin Ananyev    unsigned                       bind:1;
51e18a033bSKonstantin Ananyev    unsigned                       wildcard:1;
52e18a033bSKonstantin Ananyev    unsigned                       ssl:1;
53e18a033bSKonstantin Ananyev#if (NGX_HAVE_INET6)
54e18a033bSKonstantin Ananyev    unsigned                       ipv6only:1;
55e18a033bSKonstantin Ananyev#endif
56e18a033bSKonstantin Ananyev    unsigned                       reuseport:1;
57e18a033bSKonstantin Ananyev    unsigned                       so_keepalive:2;
58e18a033bSKonstantin Ananyev    unsigned                       proxy_protocol:1;
59e18a033bSKonstantin Ananyev#if (NGX_HAVE_KEEPALIVE_TUNABLE)
60e18a033bSKonstantin Ananyev    int                            tcp_keepidle;
61e18a033bSKonstantin Ananyev    int                            tcp_keepintvl;
62e18a033bSKonstantin Ananyev    int                            tcp_keepcnt;
63e18a033bSKonstantin Ananyev#endif
64e18a033bSKonstantin Ananyev    int                            backlog;
65e18a033bSKonstantin Ananyev    int                            type;
66e18a033bSKonstantin Ananyev} ngx_stream_listen_t;
67e18a033bSKonstantin Ananyev
68e18a033bSKonstantin Ananyev
69e18a033bSKonstantin Ananyevtypedef struct {
70e18a033bSKonstantin Ananyev    ngx_stream_conf_ctx_t         *ctx;
71e18a033bSKonstantin Ananyev    ngx_str_t                      addr_text;
72e18a033bSKonstantin Ananyev    unsigned                       ssl:1;
73e18a033bSKonstantin Ananyev    unsigned                       proxy_protocol:1;
74e18a033bSKonstantin Ananyev} ngx_stream_addr_conf_t;
75e18a033bSKonstantin Ananyev
76e18a033bSKonstantin Ananyevtypedef struct {
77e18a033bSKonstantin Ananyev    in_addr_t                      addr;
78e18a033bSKonstantin Ananyev    ngx_stream_addr_conf_t         conf;
79e18a033bSKonstantin Ananyev} ngx_stream_in_addr_t;
80e18a033bSKonstantin Ananyev
81e18a033bSKonstantin Ananyev
82e18a033bSKonstantin Ananyev#if (NGX_HAVE_INET6)
83e18a033bSKonstantin Ananyev
84e18a033bSKonstantin Ananyevtypedef struct {
85e18a033bSKonstantin Ananyev    struct in6_addr                addr6;
86e18a033bSKonstantin Ananyev    ngx_stream_addr_conf_t         conf;
87e18a033bSKonstantin Ananyev} ngx_stream_in6_addr_t;
88e18a033bSKonstantin Ananyev
89e18a033bSKonstantin Ananyev#endif
90e18a033bSKonstantin Ananyev
91e18a033bSKonstantin Ananyev
92e18a033bSKonstantin Ananyevtypedef struct {
93e18a033bSKonstantin Ananyev    /* ngx_stream_in_addr_t or ngx_stream_in6_addr_t */
94e18a033bSKonstantin Ananyev    void                          *addrs;
95e18a033bSKonstantin Ananyev    ngx_uint_t                     naddrs;
96e18a033bSKonstantin Ananyev} ngx_stream_port_t;
97e18a033bSKonstantin Ananyev
98e18a033bSKonstantin Ananyev
99e18a033bSKonstantin Ananyevtypedef struct {
100e18a033bSKonstantin Ananyev    int                            family;
101e18a033bSKonstantin Ananyev    int                            type;
102e18a033bSKonstantin Ananyev    in_port_t                      port;
103e18a033bSKonstantin Ananyev    ngx_array_t                    addrs; /* array of ngx_stream_conf_addr_t */
104e18a033bSKonstantin Ananyev} ngx_stream_conf_port_t;
105e18a033bSKonstantin Ananyev
106e18a033bSKonstantin Ananyev
107e18a033bSKonstantin Ananyevtypedef struct {
108e18a033bSKonstantin Ananyev    ngx_stream_listen_t            opt;
109e18a033bSKonstantin Ananyev} ngx_stream_conf_addr_t;
110e18a033bSKonstantin Ananyev
111e18a033bSKonstantin Ananyev
112e18a033bSKonstantin Ananyevtypedef enum {
113e18a033bSKonstantin Ananyev    NGX_STREAM_POST_ACCEPT_PHASE = 0,
114e18a033bSKonstantin Ananyev    NGX_STREAM_PREACCESS_PHASE,
115e18a033bSKonstantin Ananyev    NGX_STREAM_ACCESS_PHASE,
116e18a033bSKonstantin Ananyev    NGX_STREAM_SSL_PHASE,
117e18a033bSKonstantin Ananyev    NGX_STREAM_PREREAD_PHASE,
118e18a033bSKonstantin Ananyev    NGX_STREAM_CONTENT_PHASE,
119e18a033bSKonstantin Ananyev    NGX_STREAM_LOG_PHASE
120e18a033bSKonstantin Ananyev} ngx_stream_phases;
121e18a033bSKonstantin Ananyev
122e18a033bSKonstantin Ananyev
123e18a033bSKonstantin Ananyevtypedef struct ngx_stream_phase_handler_s  ngx_stream_phase_handler_t;
124e18a033bSKonstantin Ananyev
125e18a033bSKonstantin Ananyevtypedef ngx_int_t (*ngx_stream_phase_handler_pt)(ngx_stream_session_t *s,
126e18a033bSKonstantin Ananyev    ngx_stream_phase_handler_t *ph);
127e18a033bSKonstantin Ananyevtypedef ngx_int_t (*ngx_stream_handler_pt)(ngx_stream_session_t *s);
128e18a033bSKonstantin Ananyevtypedef void (*ngx_stream_content_handler_pt)(ngx_stream_session_t *s);
129e18a033bSKonstantin Ananyev
130e18a033bSKonstantin Ananyev
131e18a033bSKonstantin Ananyevstruct ngx_stream_phase_handler_s {
132e18a033bSKonstantin Ananyev    ngx_stream_phase_handler_pt    checker;
133e18a033bSKonstantin Ananyev    ngx_stream_handler_pt          handler;
134e18a033bSKonstantin Ananyev    ngx_uint_t                     next;
135e18a033bSKonstantin Ananyev};
136e18a033bSKonstantin Ananyev
137e18a033bSKonstantin Ananyev
138e18a033bSKonstantin Ananyevtypedef struct {
139e18a033bSKonstantin Ananyev    ngx_stream_phase_handler_t    *handlers;
140e18a033bSKonstantin Ananyev} ngx_stream_phase_engine_t;
141e18a033bSKonstantin Ananyev
142e18a033bSKonstantin Ananyev
143e18a033bSKonstantin Ananyevtypedef struct {
144e18a033bSKonstantin Ananyev    ngx_array_t                    handlers;
145e18a033bSKonstantin Ananyev} ngx_stream_phase_t;
146e18a033bSKonstantin Ananyev
147e18a033bSKonstantin Ananyev
148e18a033bSKonstantin Ananyevtypedef struct {
149e18a033bSKonstantin Ananyev    ngx_array_t                    servers;     /* ngx_stream_core_srv_conf_t */
150e18a033bSKonstantin Ananyev    ngx_array_t                    listen;      /* ngx_stream_listen_t */
151e18a033bSKonstantin Ananyev
152e18a033bSKonstantin Ananyev    ngx_stream_phase_engine_t      phase_engine;
153e18a033bSKonstantin Ananyev
154e18a033bSKonstantin Ananyev    ngx_hash_t                     variables_hash;
155e18a033bSKonstantin Ananyev
156e18a033bSKonstantin Ananyev    ngx_array_t                    variables;        /* ngx_stream_variable_t */
157e18a033bSKonstantin Ananyev    ngx_array_t                    prefix_variables; /* ngx_stream_variable_t */
158e18a033bSKonstantin Ananyev    ngx_uint_t                     ncaptures;
159e18a033bSKonstantin Ananyev
160e18a033bSKonstantin Ananyev    ngx_uint_t                     variables_hash_max_size;
161e18a033bSKonstantin Ananyev    ngx_uint_t                     variables_hash_bucket_size;
162e18a033bSKonstantin Ananyev
163e18a033bSKonstantin Ananyev    ngx_hash_keys_arrays_t        *variables_keys;
164e18a033bSKonstantin Ananyev
165e18a033bSKonstantin Ananyev    ngx_stream_phase_t             phases[NGX_STREAM_LOG_PHASE + 1];
166e18a033bSKonstantin Ananyev} ngx_stream_core_main_conf_t;
167e18a033bSKonstantin Ananyev
168e18a033bSKonstantin Ananyev
169e18a033bSKonstantin Ananyevtypedef struct {
170e18a033bSKonstantin Ananyev    ngx_stream_content_handler_pt  handler;
171e18a033bSKonstantin Ananyev
172e18a033bSKonstantin Ananyev    ngx_stream_conf_ctx_t         *ctx;
173e18a033bSKonstantin Ananyev
174e18a033bSKonstantin Ananyev    u_char                        *file_name;
175e18a033bSKonstantin Ananyev    ngx_uint_t                     line;
176e18a033bSKonstantin Ananyev
177e18a033bSKonstantin Ananyev    ngx_flag_t                     tcp_nodelay;
178e18a033bSKonstantin Ananyev    size_t                         preread_buffer_size;
179e18a033bSKonstantin Ananyev    ngx_msec_t                     preread_timeout;
180e18a033bSKonstantin Ananyev
181e18a033bSKonstantin Ananyev    ngx_log_t                     *error_log;
182e18a033bSKonstantin Ananyev
183e18a033bSKonstantin Ananyev    ngx_msec_t                     resolver_timeout;
184e18a033bSKonstantin Ananyev    ngx_resolver_t                *resolver;
185e18a033bSKonstantin Ananyev
186e18a033bSKonstantin Ananyev    ngx_msec_t                     proxy_protocol_timeout;
187e18a033bSKonstantin Ananyev
188e18a033bSKonstantin Ananyev    ngx_uint_t                     listen;  /* unsigned  listen:1; */
189e18a033bSKonstantin Ananyev} ngx_stream_core_srv_conf_t;
190e18a033bSKonstantin Ananyev
191e18a033bSKonstantin Ananyev
192e18a033bSKonstantin Ananyevstruct ngx_stream_session_s {
193e18a033bSKonstantin Ananyev    uint32_t                       signature;         /* "STRM" */
194e18a033bSKonstantin Ananyev
195e18a033bSKonstantin Ananyev    ngx_connection_t              *connection;
196e18a033bSKonstantin Ananyev
197e18a033bSKonstantin Ananyev    off_t                          received;
198e18a033bSKonstantin Ananyev    time_t                         start_sec;
199e18a033bSKonstantin Ananyev    ngx_msec_t                     start_msec;
200e18a033bSKonstantin Ananyev
201e18a033bSKonstantin Ananyev    ngx_log_handler_pt             log_handler;
202e18a033bSKonstantin Ananyev
203e18a033bSKonstantin Ananyev    void                         **ctx;
204e18a033bSKonstantin Ananyev    void                         **main_conf;
205e18a033bSKonstantin Ananyev    void                         **srv_conf;
206e18a033bSKonstantin Ananyev
207e18a033bSKonstantin Ananyev    ngx_stream_upstream_t         *upstream;
208e18a033bSKonstantin Ananyev    ngx_array_t                   *upstream_states;
209e18a033bSKonstantin Ananyev                                           /* of ngx_stream_upstream_state_t */
210e18a033bSKonstantin Ananyev    ngx_stream_variable_value_t   *variables;
211e18a033bSKonstantin Ananyev
212e18a033bSKonstantin Ananyev#if (NGX_PCRE)
213e18a033bSKonstantin Ananyev    ngx_uint_t                     ncaptures;
214e18a033bSKonstantin Ananyev    int                           *captures;
215e18a033bSKonstantin Ananyev    u_char                        *captures_data;
216e18a033bSKonstantin Ananyev#endif
217e18a033bSKonstantin Ananyev
218e18a033bSKonstantin Ananyev    ngx_int_t                      phase_handler;
219e18a033bSKonstantin Ananyev    ngx_uint_t                     status;
220e18a033bSKonstantin Ananyev
221e18a033bSKonstantin Ananyev    unsigned                       ssl:1;
222e18a033bSKonstantin Ananyev
223e18a033bSKonstantin Ananyev    unsigned                       stat_processing:1;
224e18a033bSKonstantin Ananyev
225e18a033bSKonstantin Ananyev    unsigned                       health_check:1;
226e18a033bSKonstantin Ananyev};
227e18a033bSKonstantin Ananyev
228e18a033bSKonstantin Ananyev
229e18a033bSKonstantin Ananyevtypedef struct {
230e18a033bSKonstantin Ananyev    ngx_int_t                    (*preconfiguration)(ngx_conf_t *cf);
231e18a033bSKonstantin Ananyev    ngx_int_t                    (*postconfiguration)(ngx_conf_t *cf);
232e18a033bSKonstantin Ananyev
233e18a033bSKonstantin Ananyev    void                        *(*create_main_conf)(ngx_conf_t *cf);
234e18a033bSKonstantin Ananyev    char                        *(*init_main_conf)(ngx_conf_t *cf, void *conf);
235e18a033bSKonstantin Ananyev
236e18a033bSKonstantin Ananyev    void                        *(*create_srv_conf)(ngx_conf_t *cf);
237e18a033bSKonstantin Ananyev    char                        *(*merge_srv_conf)(ngx_conf_t *cf, void *prev,
238e18a033bSKonstantin Ananyev                                                   void *conf);
239e18a033bSKonstantin Ananyev} ngx_stream_module_t;
240e18a033bSKonstantin Ananyev
241e18a033bSKonstantin Ananyev
242e18a033bSKonstantin Ananyev#define NGX_STREAM_MODULE       0x4d525453     /* "STRM" */
243e18a033bSKonstantin Ananyev
244e18a033bSKonstantin Ananyev#define NGX_STREAM_MAIN_CONF    0x02000000
245e18a033bSKonstantin Ananyev#define NGX_STREAM_SRV_CONF     0x04000000
246e18a033bSKonstantin Ananyev#define NGX_STREAM_UPS_CONF     0x08000000
247e18a033bSKonstantin Ananyev
248e18a033bSKonstantin Ananyev
249e18a033bSKonstantin Ananyev#define NGX_STREAM_MAIN_CONF_OFFSET  offsetof(ngx_stream_conf_ctx_t, main_conf)
250e18a033bSKonstantin Ananyev#define NGX_STREAM_SRV_CONF_OFFSET   offsetof(ngx_stream_conf_ctx_t, srv_conf)
251e18a033bSKonstantin Ananyev
252e18a033bSKonstantin Ananyev
253e18a033bSKonstantin Ananyev#define ngx_stream_get_module_ctx(s, module)   (s)->ctx[module.ctx_index]
254e18a033bSKonstantin Ananyev#define ngx_stream_set_ctx(s, c, module)       s->ctx[module.ctx_index] = c;
255e18a033bSKonstantin Ananyev#define ngx_stream_delete_ctx(s, module)       s->ctx[module.ctx_index] = NULL;
256e18a033bSKonstantin Ananyev
257e18a033bSKonstantin Ananyev
258e18a033bSKonstantin Ananyev#define ngx_stream_get_module_main_conf(s, module)                             \
259e18a033bSKonstantin Ananyev    (s)->main_conf[module.ctx_index]
260e18a033bSKonstantin Ananyev#define ngx_stream_get_module_srv_conf(s, module)                              \
261e18a033bSKonstantin Ananyev    (s)->srv_conf[module.ctx_index]
262e18a033bSKonstantin Ananyev
263e18a033bSKonstantin Ananyev#define ngx_stream_conf_get_module_main_conf(cf, module)                       \
264e18a033bSKonstantin Ananyev    ((ngx_stream_conf_ctx_t *) cf->ctx)->main_conf[module.ctx_index]
265e18a033bSKonstantin Ananyev#define ngx_stream_conf_get_module_srv_conf(cf, module)                        \
266e18a033bSKonstantin Ananyev    ((ngx_stream_conf_ctx_t *) cf->ctx)->srv_conf[module.ctx_index]
267e18a033bSKonstantin Ananyev
268e18a033bSKonstantin Ananyev#define ngx_stream_cycle_get_module_main_conf(cycle, module)                   \
269e18a033bSKonstantin Ananyev    (cycle->conf_ctx[ngx_stream_module.index] ?                                \
270e18a033bSKonstantin Ananyev        ((ngx_stream_conf_ctx_t *) cycle->conf_ctx[ngx_stream_module.index])   \
271e18a033bSKonstantin Ananyev            ->main_conf[module.ctx_index]:                                     \
272e18a033bSKonstantin Ananyev        NULL)
273e18a033bSKonstantin Ananyev
274e18a033bSKonstantin Ananyev
275e18a033bSKonstantin Ananyev#define NGX_STREAM_WRITE_BUFFERED  0x10
276e18a033bSKonstantin Ananyev
277e18a033bSKonstantin Ananyev
278e18a033bSKonstantin Ananyevvoid ngx_stream_core_run_phases(ngx_stream_session_t *s);
279e18a033bSKonstantin Ananyevngx_int_t ngx_stream_core_generic_phase(ngx_stream_session_t *s,
280e18a033bSKonstantin Ananyev    ngx_stream_phase_handler_t *ph);
281e18a033bSKonstantin Ananyevngx_int_t ngx_stream_core_preread_phase(ngx_stream_session_t *s,
282e18a033bSKonstantin Ananyev    ngx_stream_phase_handler_t *ph);
283e18a033bSKonstantin Ananyevngx_int_t ngx_stream_core_content_phase(ngx_stream_session_t *s,
284e18a033bSKonstantin Ananyev    ngx_stream_phase_handler_t *ph);
285e18a033bSKonstantin Ananyev
286e18a033bSKonstantin Ananyev
287e18a033bSKonstantin Ananyevvoid ngx_stream_init_connection(ngx_connection_t *c);
288e18a033bSKonstantin Ananyevvoid ngx_stream_session_handler(ngx_event_t *rev);
289e18a033bSKonstantin Ananyevvoid ngx_stream_finalize_session(ngx_stream_session_t *s, ngx_uint_t rc);
290e18a033bSKonstantin Ananyev
291e18a033bSKonstantin Ananyev
292e18a033bSKonstantin Ananyevextern ngx_module_t  ngx_stream_module;
293e18a033bSKonstantin Ananyevextern ngx_uint_t    ngx_stream_max_module;
294e18a033bSKonstantin Ananyevextern ngx_module_t  ngx_stream_core_module;
295e18a033bSKonstantin Ananyev
296e18a033bSKonstantin Ananyev
297e18a033bSKonstantin Ananyevtypedef ngx_int_t (*ngx_stream_filter_pt)(ngx_stream_session_t *s,
298e18a033bSKonstantin Ananyev    ngx_chain_t *chain, ngx_uint_t from_upstream);
299e18a033bSKonstantin Ananyev
300e18a033bSKonstantin Ananyev
301e18a033bSKonstantin Ananyevextern ngx_stream_filter_pt  ngx_stream_top_filter;
302e18a033bSKonstantin Ananyev
303e18a033bSKonstantin Ananyev
304e18a033bSKonstantin Ananyev#endif /* _NGX_STREAM_H_INCLUDED_ */
305