xref: /unit/src/nxt_router.h (revision 1709:1fe93c17d23f)
1 
2 /*
3  * Copyright (C) Igor Sysoev
4  * Copyright (C) NGINX, Inc.
5  */
6 
7 #ifndef _NXT_ROUTER_H_INCLUDED_
8 #define _NXT_ROUTER_H_INCLUDED_
9 
10 
11 #include <nxt_main.h>
12 #include <nxt_runtime.h>
13 #include <nxt_main_process.h>
14 
15 typedef struct nxt_http_request_s  nxt_http_request_t;
16 #include <nxt_application.h>
17 
18 
19 typedef struct nxt_http_action_s        nxt_http_action_t;
20 typedef struct nxt_http_routes_s        nxt_http_routes_t;
21 typedef struct nxt_upstream_s           nxt_upstream_t;
22 typedef struct nxt_upstreams_s          nxt_upstreams_t;
23 typedef struct nxt_router_access_log_s  nxt_router_access_log_t;
24 
25 
26 #define NXT_HTTP_ACTION_ERROR  ((nxt_http_action_t *) -1)
27 
28 
29 typedef struct {
30     nxt_thread_spinlock_t    lock;
31     nxt_queue_t              engines;
32 
33     nxt_queue_t              sockets;  /* of nxt_socket_conf_t */
34     nxt_queue_t              apps;     /* of nxt_app_t */
35 
36     nxt_router_access_log_t  *access_log;
37 } nxt_router_t;
38 
39 
40 typedef struct {
41     uint32_t                 count;
42     uint32_t                 threads;
43 
44     nxt_mp_t                 *mem_pool;
45 
46     nxt_router_t             *router;
47     nxt_http_routes_t        *routes;
48     nxt_upstreams_t          *upstreams;
49 
50     nxt_lvlhsh_t             mtypes_hash;
51     nxt_lvlhsh_t             apps_hash;
52 
53     nxt_router_access_log_t  *access_log;
54 } nxt_router_conf_t;
55 
56 
57 typedef struct {
58     nxt_event_engine_t     *engine;
59     nxt_work_t             *jobs;
60 
61     enum {
62         NXT_ROUTER_ENGINE_KEEP = 0,
63         NXT_ROUTER_ENGINE_ADD,
64         NXT_ROUTER_ENGINE_DELETE,
65     }                      action;
66 } nxt_router_engine_conf_t;
67 
68 
69 typedef struct {
70 #if (NXT_TLS)
71     nxt_queue_t            tls;        /* of nxt_router_tlssock_t */
72 #endif
73 
74     nxt_queue_t            apps;       /* of nxt_app_t */
75     nxt_queue_t            previous;   /* of nxt_app_t */
76 
77     uint32_t               new_threads;
78     uint32_t               stream;
79     uint32_t               count;
80 
81     nxt_event_engine_t     *engine;
82     nxt_port_t             *port;
83     nxt_array_t            *engines;
84     nxt_router_conf_t      *router_conf;
85     nxt_mp_t               *mem_pool;
86 } nxt_router_temp_conf_t;
87 
88 
89 typedef struct {
90     nxt_task_t              task;
91     nxt_work_t              work;
92     nxt_router_temp_conf_t  *tmcf;
93 } nxt_joint_job_t;
94 
95 
96 typedef struct {
97     uint32_t               use_count;
98     nxt_app_t              *app;
99     nxt_timer_t            idle_timer;
100     nxt_work_t             free_app_work;
101 } nxt_app_joint_t;
102 
103 
104 struct nxt_app_s {
105     nxt_thread_mutex_t     mutex;       /* Protects ports queue. */
106     nxt_queue_t            ports;       /* of nxt_port_t.app_link */
107     nxt_lvlhsh_t           port_hash;   /* of nxt_port_t */
108 
109     nxt_queue_t            spare_ports; /* of nxt_port_t.idle_link */
110     nxt_queue_t            idle_ports;  /* of nxt_port_t.idle_link */
111     nxt_work_t             adjust_idle_work;
112     nxt_event_engine_t     *engine;
113 
114     nxt_str_t              name;
115 
116     uint32_t               port_hash_count;
117 
118     uint32_t               active_requests;
119     uint32_t               pending_processes;
120     uint32_t               processes;
121     uint32_t               idle_processes;
122 
123     uint32_t               max_processes;
124     uint32_t               spare_processes;
125     uint32_t               max_pending_processes;
126     uint32_t               max_requests;
127 
128     nxt_msec_t             timeout;
129     nxt_msec_t             idle_timeout;
130 
131     nxt_str_t              *targets;
132 
133     nxt_app_type_t         type:8;
134 
135     nxt_mp_t               *mem_pool;
136     nxt_queue_link_t       link;
137 
138     nxt_str_t              conf;
139 
140     nxt_atomic_t           use_count;
141     nxt_queue_t            ack_waiting_req; /* of nxt_http_request_t.app_link */
142 
143     nxt_app_joint_t        *joint;
144     nxt_port_t             *shared_port;
145 
146     nxt_port_mmaps_t       outgoing;
147 };
148 
149 
150 typedef struct {
151     size_t                 max_frame_size;
152     nxt_msec_t             read_timeout;
153     nxt_msec_t             keepalive_interval;
154 } nxt_websocket_conf_t;
155 
156 
157 typedef struct {
158     uint32_t               count;
159     nxt_queue_link_t       link;
160     nxt_router_conf_t      *router_conf;
161 
162     nxt_http_action_t      *action;
163 
164     /*
165      * A listen socket time can be shorter than socket configuration life
166      * time, so a copy of the non-wildcard socket sockaddr is stored here
167      * to be used as a local sockaddr in connections.
168      */
169     nxt_sockaddr_t         *sockaddr;
170 
171     nxt_listen_socket_t    *listen;
172 
173     size_t                 header_buffer_size;
174     size_t                 large_header_buffer_size;
175     size_t                 large_header_buffers;
176     size_t                 body_buffer_size;
177     size_t                 max_body_size;
178     size_t                 proxy_header_buffer_size;
179     size_t                 proxy_buffer_size;
180     size_t                 proxy_buffers;
181 
182     nxt_msec_t             idle_timeout;
183     nxt_msec_t             header_read_timeout;
184     nxt_msec_t             body_read_timeout;
185     nxt_msec_t             send_timeout;
186     nxt_msec_t             proxy_timeout;
187     nxt_msec_t             proxy_send_timeout;
188     nxt_msec_t             proxy_read_timeout;
189 
190     nxt_websocket_conf_t   websocket_conf;
191 
192     nxt_str_t              body_temp_path;
193 
194     uint8_t                discard_unsafe_fields;  /* 1 bit */
195 
196 #if (NXT_TLS)
197     nxt_tls_conf_t         *tls;
198 #endif
199 } nxt_socket_conf_t;
200 
201 
202 typedef struct {
203     uint32_t               count;
204     nxt_queue_link_t       link;
205     nxt_event_engine_t     *engine;
206     nxt_socket_conf_t      *socket_conf;
207 
208     nxt_upstream_t         **upstreams;
209 
210     /* Modules configuraitons. */
211 } nxt_socket_conf_joint_t;
212 
213 
214 struct nxt_router_access_log_s {
215     void                   (*handler)(nxt_task_t *task, nxt_http_request_t *r,
216                                       nxt_router_access_log_t *access_log);
217     nxt_fd_t               fd;
218     nxt_str_t              path;
219     uint32_t               count;
220 };
221 
222 
223 void nxt_router_process_http_request(nxt_task_t *task, nxt_http_request_t *r,
224     nxt_app_t *app);
225 void nxt_router_app_port_close(nxt_task_t *task, nxt_port_t *port);
226 nxt_int_t nxt_router_listener_application(nxt_router_conf_t *rtcf,
227     nxt_str_t *name, nxt_http_action_t *action);
228 void nxt_router_listen_event_release(nxt_task_t *task, nxt_listen_event_t *lev,
229     nxt_socket_conf_joint_t *joint);
230 void nxt_router_conf_release(nxt_task_t *task, nxt_socket_conf_joint_t *joint);
231 
232 
233 #endif  /* _NXT_ROUTER_H_INCLUDED_ */
234