forked from laocai/tcp-nginx-module
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ngx_tcp.h
314 lines (219 loc) · 8.22 KB
/
ngx_tcp.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
#ifndef _NGX_TCP_H_INCLUDED_
#define _NGX_TCP_H_INCLUDED_
#include <ngx_config.h>
#include <ngx_core.h>
#include <ngx_event.h>
#include <ngx_event_connect.h>
#include <ngx_tcp_cmdso.h>
#if (NGX_TCP_SSL)
#include <ngx_tcp_ssl_module.h>
#endif
typedef struct {
void **main_conf;
void **srv_conf;
} ngx_tcp_conf_ctx_t;
typedef struct {
u_char sockaddr[NGX_SOCKADDRLEN];
socklen_t socklen;
/* server ctx */
ngx_tcp_conf_ctx_t *ctx;
unsigned bind:1;
unsigned wildcard:1;
#if (NGX_TCP_SSL)
unsigned ssl:1;
#endif
#if (NGX_HAVE_INET6 && defined IPV6_V6ONLY)
unsigned ipv6only:1;
#endif
unsigned so_keepalive:2;
#if (NGX_HAVE_KEEPALIVE_TUNABLE)
int tcp_keepidle;
int tcp_keepintvl;
int tcp_keepcnt;
#endif
} ngx_tcp_listen_t;
typedef struct {
ngx_tcp_conf_ctx_t *ctx;
ngx_str_t addr_text;
#if (NGX_TCP_SSL)
ngx_uint_t ssl; /* unsigned ssl:1; */
#endif
} ngx_tcp_addr_conf_t;
typedef struct {
in_addr_t addr;
ngx_tcp_addr_conf_t conf;
} ngx_tcp_in_addr_t;
#if (NGX_HAVE_INET6)
typedef struct {
struct in6_addr addr6;
ngx_tcp_addr_conf_t conf;
} ngx_tcp_in6_addr_t;
#endif
typedef struct {
/* ngx_tcp_in_addr_t or ngx_tcp_in6_addr_t */
void *addrs;
ngx_uint_t naddrs;
} ngx_tcp_port_t;
typedef struct {
int family;
in_port_t port;
ngx_array_t addrs; /* array of ngx_tcp_conf_addr_t */
} ngx_tcp_conf_port_t;
typedef struct {
struct sockaddr *sockaddr;
socklen_t socklen;
ngx_tcp_conf_ctx_t *ctx;
unsigned bind:1;
unsigned wildcard:1;
#if (NGX_TCP_SSL)
unsigned ssl:1;
#endif
#if (NGX_HAVE_INET6 && defined IPV6_V6ONLY)
unsigned ipv6only:1;
#endif
unsigned so_keepalive:2;
#if (NGX_HAVE_KEEPALIVE_TUNABLE)
int tcp_keepidle;
int tcp_keepintvl;
int tcp_keepcnt;
#endif
} ngx_tcp_conf_addr_t;
/* sizeof(struct sockaddr_un) less than 255 */
#define MAX_UNIX_URL_LEN 255
typedef struct {
u_char len;
u_char unix_url[MAX_UNIX_URL_LEN];
} unix_listening_info_t;
typedef void * socketfd_info_tag;
typedef struct {
/* work process unix-listening info index is ngx_process_slot */
ngx_int_t listening_unix_info_i;
socketfd_info_tag tag;
} socketfd_info_t;
/* All the address is shm. */
typedef struct {
/* Array of socketfd_info_t. Array index is socketfd. */
socketfd_info_t *socketfd_info;
/* Array of unix listening info. */
unix_listening_info_t *listening_unix_info;
} socketfd_shm_info_t;
typedef struct {
ngx_path_t *path;
ngx_msec_t last;
ngx_slab_pool_t *shpool;
ngx_shm_zone_t *shm_zone;
/* point to ngx_tcp_core_main_conf_t's max_socketfd */
ngx_int_t *max_socketfd_value;
socketfd_shm_info_t *info;
} socketfd_shm_t ;
typedef struct {
ngx_array_t servers; /* ngx_tcp_core_srv_conf_t */
ngx_array_t listen; /* ngx_tcp_listen_t */
ngx_str_t unix_url; /* work process unix-listening-path */
ngx_listening_t *ls;
/* max value of socket fd */
ngx_int_t max_socketfd_value;
socketfd_shm_t *socketfd_shm;
ngx_log_t *error_log;
} ngx_tcp_core_main_conf_t;
#define NGX_TCP_CMD_PROTOCOL 0
typedef struct ngx_tcp_protocol_s ngx_tcp_protocol_t;
typedef struct {
ngx_tcp_protocol_t *protocol;
ngx_msec_t timeout;
ngx_msec_t resolver_timeout;
ngx_flag_t so_keepalive;
ngx_str_t server_name;
u_char *file_name;
ngx_int_t line;
ngx_resolver_t *resolver;
size_t connection_pool_size;
/* server ctx */
ngx_tcp_conf_ctx_t *ctx;
} ngx_tcp_core_srv_conf_t;
typedef struct {
ngx_peer_connection_t upstream;
ngx_buf_t *buffer;
} ngx_tcp_proxy_ctx_t;
typedef struct {
uint32_t signature; /* "TCP" */
ngx_tcp_ctx_t tcp_ctx;
ngx_connection_t *connection;
ngx_buf_t *buffer; /* recv buf */
ngx_chain_t *output_buffer_chain;
ngx_output_chain_ctx_t *output_ctx; /* send buf chain context */
void **ctx;
void **main_conf;
void **srv_conf;
unsigned protocol:3;
unsigned blocked:1;
ngx_str_t *addr_text;
} ngx_tcp_session_t;
typedef struct {
ngx_str_t *client;
ngx_tcp_session_t *session;
} ngx_tcp_log_ctx_t;
#define NGX_TCP_PARSE_INVALID_COMMAND 20
typedef ngx_tcp_session_t *(*ngx_tcp_create_session_pt)(ngx_connection_t *c);
typedef void
(*ngx_tcp_init_session_pt)(ngx_tcp_session_t *s, ngx_connection_t *c);
typedef void (*ngx_tcp_finit_session_pt)(ngx_tcp_session_t *s);
typedef void (*ngx_tcp_init_protocol_pt)(ngx_event_t *rev);
typedef ngx_int_t (*ngx_tcp_parse_pkg_pt)(ngx_tcp_session_t *s);
ngx_chain_t *
ngx_tcp_chain_get_free_buf(ngx_output_chain_ctx_t *ctx, size_t total_size);
ngx_int_t ngx_tcp_open_listening_socket(ngx_listening_t *ls);
ngx_int_t ngx_tcp_chain_writer(void *data, ngx_chain_t *in);
struct ngx_tcp_protocol_s {
ngx_str_t name;
in_port_t port[4];
ngx_uint_t type;
ngx_tcp_create_session_pt create_session;
ngx_tcp_init_session_pt init_session;
ngx_tcp_finit_session_pt finit_session;
ngx_tcp_init_protocol_pt init_protocol;
ngx_tcp_parse_pkg_pt parse_command;
ngx_str_t internal_server_error;
};
ngx_tcp_session_t *ngx_tcp_create_session(ngx_connection_t *c);
extern ngx_module_t ngx_tcp_module;
typedef struct {
ngx_tcp_protocol_t *protocol;
void *(*create_main_conf)(ngx_conf_t *cf);
char *(*init_main_conf)(ngx_conf_t *cf, void *conf);
void *(*create_srv_conf)(ngx_conf_t *cf);
char *(*merge_srv_conf)(ngx_conf_t *cf, void *prev, void *conf);
} ngx_tcp_module_t;
#define NGX_TCP_MODULE 0x504354 /* "TCP" */
#define NGX_TCP_MAIN_CONF 0x02000000
#define NGX_TCP_SRV_CONF 0x04000000
#define NGX_TCP_MAIN_CONF_OFFSET offsetof(ngx_tcp_conf_ctx_t, main_conf)
#define NGX_TCP_SRV_CONF_OFFSET offsetof(ngx_tcp_conf_ctx_t, srv_conf)
#define ngx_tcp_get_module_ctx(s, module) (s)->ctx[module.ctx_index]
#define ngx_tcp_set_ctx(s, c, module) s->ctx[module.ctx_index] = c;
#define ngx_tcp_delete_ctx(s, module) s->ctx[module.ctx_index] = NULL;
#define ngx_tcp_get_module_main_conf(s, module) \
(s)->main_conf[module.ctx_index]
#define ngx_tcp_get_module_srv_conf(s, module) \
(s)->srv_conf[module.ctx_index]
#define ngx_tcp_conf_get_module_main_conf(cf, module) \
((ngx_tcp_conf_ctx_t *) cf->ctx)->main_conf[module.ctx_index]
#define ngx_tcp_conf_get_module_srv_conf(cf, module) \
((ngx_tcp_conf_ctx_t *) cf->ctx)->srv_conf[module.ctx_index]
#if (NGX_TCP_SSL)
void ngx_tcp_starttls_handler(ngx_event_t *rev);
ngx_int_t
ngx_tcp_starttls_only(ngx_tcp_session_t *s, ngx_connection_t *c);
#endif
void ngx_tcp_init_connection(ngx_connection_t *c);
void ngx_tcp_send(ngx_event_t *wev);
long ngx_tcp_send_data(ngx_tcp_ctx_t *ctx, const u_char *data, int len);
void ngx_tcp_close_connection(ngx_connection_t *c);
void ngx_tcp_session_internal_server_error(ngx_tcp_session_t *s);
u_char *ngx_tcp_log_error_msg(ngx_log_t *log, u_char *buf, size_t len);
/* STUB */
void ngx_tcp_proxy_init(ngx_tcp_session_t *s, ngx_addr_t *peer);
/**/
extern ngx_uint_t ngx_tcp_max_module;
extern ngx_module_t ngx_tcp_core_module;
#endif /* _NGX_TCP_H_INCLUDED_ */