|
0
|
1
|
|
|
2 /*
|
|
|
3 * Copyright (C) Igor Sysoev
|
|
|
4 */
|
|
|
5
|
|
|
6
|
|
|
7 #ifndef _NGX_EVENT_H_INCLUDED_
|
|
|
8 #define _NGX_EVENT_H_INCLUDED_
|
|
|
9
|
|
|
10
|
|
|
11 #include <ngx_config.h>
|
|
|
12 #include <ngx_core.h>
|
|
|
13
|
|
|
14
|
|
|
15 #define NGX_INVALID_INDEX 0xd0d0d0d0
|
|
|
16
|
|
|
17
|
|
18
|
18 #if (NGX_HAVE_IOCP)
|
|
0
|
19
|
|
|
20 typedef struct {
|
|
|
21 WSAOVERLAPPED ovlp;
|
|
|
22 ngx_event_t *event;
|
|
|
23 int error;
|
|
|
24 } ngx_event_ovlp_t;
|
|
|
25
|
|
|
26 #endif
|
|
|
27
|
|
|
28
|
|
|
29 typedef struct {
|
|
|
30 ngx_uint_t lock;
|
|
|
31
|
|
|
32 ngx_event_t *events;
|
|
|
33 ngx_event_t *last;
|
|
|
34 } ngx_event_mutex_t;
|
|
|
35
|
|
|
36
|
|
|
37 struct ngx_event_s {
|
|
|
38 void *data;
|
|
|
39
|
|
|
40 unsigned write:1;
|
|
|
41
|
|
|
42 unsigned accept:1;
|
|
|
43
|
|
|
44 unsigned oneshot:1;
|
|
|
45
|
|
|
46 /* used to detect the stale events in kqueue, rt signals and epoll */
|
|
|
47 unsigned instance:1;
|
|
|
48
|
|
|
49 /*
|
|
|
50 * the event was passed or would be passed to a kernel;
|
|
|
51 * in aio mode - operation was posted.
|
|
|
52 */
|
|
|
53 unsigned active:1;
|
|
|
54
|
|
|
55 unsigned disabled:1;
|
|
|
56
|
|
|
57 /* the ready event; in aio mode 0 means that no operation can be posted */
|
|
|
58 unsigned ready:1;
|
|
|
59
|
|
|
60 /* aio operation is complete */
|
|
|
61 unsigned complete:1;
|
|
|
62
|
|
|
63 unsigned eof:1;
|
|
|
64 unsigned error:1;
|
|
|
65
|
|
|
66 unsigned timedout:1;
|
|
|
67 unsigned timer_set:1;
|
|
|
68
|
|
|
69 unsigned delayed:1;
|
|
|
70
|
|
|
71 unsigned read_discarded:1;
|
|
|
72
|
|
|
73 unsigned unexpected_eof:1;
|
|
|
74
|
|
|
75 unsigned deferred_accept:1;
|
|
|
76
|
|
|
77 /* the pending eof reported by kqueue or in aio chain operation */
|
|
|
78 unsigned pending_eof:1;
|
|
|
79
|
|
|
80 #if !(NGX_THREADS)
|
|
|
81 unsigned posted_ready:1;
|
|
|
82 #endif
|
|
|
83
|
|
10
|
84 #if (NGX_WIN32)
|
|
0
|
85 /* setsockopt(SO_UPDATE_ACCEPT_CONTEXT) was succesfull */
|
|
|
86 unsigned accept_context_updated:1;
|
|
|
87 #endif
|
|
|
88
|
|
18
|
89 #if (NGX_HAVE_KQUEUE)
|
|
0
|
90 unsigned kq_vnode:1;
|
|
|
91
|
|
|
92 /* the pending errno reported by kqueue */
|
|
|
93 int kq_errno;
|
|
|
94 #endif
|
|
|
95
|
|
|
96 /*
|
|
|
97 * kqueue only:
|
|
|
98 * accept: number of sockets that wait to be accepted
|
|
|
99 * read: bytes to read when event is ready
|
|
|
100 * or lowat when event is set with NGX_LOWAT_EVENT flag
|
|
|
101 * write: available space in buffer when event is ready
|
|
|
102 * or lowat when event is set with NGX_LOWAT_EVENT flag
|
|
|
103 *
|
|
|
104 * iocp: TODO
|
|
|
105 *
|
|
|
106 * otherwise:
|
|
|
107 * accept: 1 if accept many, 0 otherwise
|
|
|
108 */
|
|
|
109
|
|
18
|
110 #if (NGX_HAVE_KQUEUE) || (NGX_HAVE_IOCP)
|
|
0
|
111 int available;
|
|
|
112 #else
|
|
|
113 unsigned available:1;
|
|
|
114 #endif
|
|
|
115
|
|
58
|
116 ngx_event_handler_pt handler;
|
|
0
|
117
|
|
|
118
|
|
18
|
119 #if (NGX_HAVE_AIO)
|
|
0
|
120
|
|
18
|
121 #if (NGX_HAVE_IOCP)
|
|
0
|
122 ngx_event_ovlp_t ovlp;
|
|
|
123 #else
|
|
|
124 struct aiocb aiocb;
|
|
|
125 #endif
|
|
|
126
|
|
|
127 #endif
|
|
|
128
|
|
|
129 u_int index;
|
|
|
130
|
|
|
131 ngx_log_t *log;
|
|
|
132
|
|
108
|
133 ngx_rbtree_node_t timer;
|
|
0
|
134
|
|
|
135 unsigned closed:1;
|
|
|
136
|
|
|
137 #if (NGX_THREADS)
|
|
|
138
|
|
|
139 unsigned locked:1;
|
|
|
140
|
|
|
141 unsigned posted_ready:1;
|
|
|
142 unsigned posted_timedout:1;
|
|
|
143 unsigned posted_eof:1;
|
|
|
144
|
|
18
|
145 #if (NGX_HAVE_KQUEUE)
|
|
0
|
146 /* the pending errno reported by kqueue */
|
|
|
147 int posted_errno;
|
|
|
148 #endif
|
|
|
149
|
|
18
|
150 #if (NGX_HAVE_KQUEUE) || (NGX_HAVE_IOCP)
|
|
0
|
151 int posted_available;
|
|
|
152 #else
|
|
|
153 unsigned posted_available:1;
|
|
|
154 #endif
|
|
|
155
|
|
|
156 ngx_atomic_t *lock;
|
|
|
157 ngx_atomic_t *own_lock;
|
|
|
158
|
|
|
159 #endif
|
|
|
160
|
|
|
161 /* the links of the posted queue */
|
|
|
162 ngx_event_t *next;
|
|
|
163 ngx_event_t **prev;
|
|
|
164
|
|
|
165
|
|
|
166 #if 0
|
|
|
167
|
|
|
168 /* the threads support */
|
|
|
169
|
|
|
170 /*
|
|
|
171 * the event thread context, we store it here
|
|
|
172 * if $(CC) does not understand __thread declaration
|
|
|
173 * and pthread_getspecific() is too costly
|
|
|
174 */
|
|
|
175
|
|
|
176 void *thr_ctx;
|
|
|
177
|
|
|
178 #if (NGX_EVENT_T_PADDING)
|
|
|
179
|
|
|
180 /* event should not cross cache line in SMP */
|
|
|
181
|
|
|
182 int padding[NGX_EVENT_T_PADDING];
|
|
|
183 #endif
|
|
|
184 #endif
|
|
|
185 };
|
|
|
186
|
|
|
187
|
|
|
188 typedef struct {
|
|
|
189 ngx_int_t (*add)(ngx_event_t *ev, int event, u_int flags);
|
|
|
190 ngx_int_t (*del)(ngx_event_t *ev, int event, u_int flags);
|
|
|
191
|
|
|
192 ngx_int_t (*enable)(ngx_event_t *ev, int event, u_int flags);
|
|
|
193 ngx_int_t (*disable)(ngx_event_t *ev, int event, u_int flags);
|
|
|
194
|
|
|
195 ngx_int_t (*add_conn)(ngx_connection_t *c);
|
|
|
196 ngx_int_t (*del_conn)(ngx_connection_t *c, u_int flags);
|
|
|
197
|
|
2
|
198 ngx_int_t (*process_changes)(ngx_cycle_t *cycle, ngx_uint_t nowait);
|
|
0
|
199 ngx_int_t (*process_events)(ngx_cycle_t *cycle);
|
|
|
200
|
|
|
201 ngx_int_t (*init)(ngx_cycle_t *cycle);
|
|
|
202 void (*done)(ngx_cycle_t *cycle);
|
|
|
203 } ngx_event_actions_t;
|
|
|
204
|
|
|
205
|
|
|
206 extern ngx_event_actions_t ngx_event_actions;
|
|
|
207
|
|
|
208
|
|
|
209 /*
|
|
92
|
210 * The event filter requires to read/write the whole data:
|
|
0
|
211 * select, poll, /dev/poll, kqueue, epoll.
|
|
|
212 */
|
|
|
213 #define NGX_USE_LEVEL_EVENT 0x00000001
|
|
|
214
|
|
|
215 /*
|
|
|
216 * The event filter is deleted after a notification without an additional
|
|
92
|
217 * syscall: select, poll, kqueue, epoll, Solaris 10's event ports.
|
|
0
|
218 */
|
|
|
219 #define NGX_USE_ONESHOT_EVENT 0x00000002
|
|
|
220
|
|
|
221 /*
|
|
92
|
222 * The event filter notifies only the changes and an initial level:
|
|
0
|
223 * kqueue, epoll.
|
|
|
224 */
|
|
|
225 #define NGX_USE_CLEAR_EVENT 0x00000004
|
|
|
226
|
|
|
227 /*
|
|
92
|
228 * The event filter has kqueue features: the eof flag, errno,
|
|
0
|
229 * available data, etc.
|
|
|
230 */
|
|
92
|
231 #define NGX_USE_KQUEUE_EVENT 0x00000008
|
|
0
|
232
|
|
|
233 /*
|
|
92
|
234 * The event filter supports low water mark: kqueue's NOTE_LOWAT.
|
|
0
|
235 * kqueue in FreeBSD 4.1-4.2 has no NOTE_LOWAT so we need a separate flag.
|
|
|
236 */
|
|
92
|
237 #define NGX_USE_LOWAT_EVENT 0x00000010
|
|
0
|
238
|
|
|
239 /*
|
|
92
|
240 * The event filter requires to do i/o operation until EAGAIN:
|
|
0
|
241 * epoll, rt signals.
|
|
|
242 */
|
|
92
|
243 #define NGX_USE_GREEDY_EVENT 0x00000020
|
|
0
|
244
|
|
|
245 /*
|
|
92
|
246 * The event filter is epoll.
|
|
0
|
247 */
|
|
|
248 #define NGX_USE_EPOLL_EVENT 0x00000040
|
|
|
249
|
|
|
250 /*
|
|
92
|
251 * No need to add or delete the event filters: rt signals.
|
|
0
|
252 */
|
|
|
253 #define NGX_USE_RTSIG_EVENT 0x00000080
|
|
|
254
|
|
|
255 /*
|
|
92
|
256 * No need to add or delete the event filters: overlapped, aio_read,
|
|
0
|
257 * aioread, io_submit.
|
|
|
258 */
|
|
|
259 #define NGX_USE_AIO_EVENT 0x00000100
|
|
|
260
|
|
|
261 /*
|
|
92
|
262 * Need to add socket or handle only once: i/o completion port.
|
|
18
|
263 * It also requires NGX_HAVE_AIO and NGX_USE_AIO_EVENT to be set.
|
|
0
|
264 */
|
|
|
265 #define NGX_USE_IOCP_EVENT 0x00000200
|
|
|
266
|
|
92
|
267 /*
|
|
|
268 * The event filter has no opaque data and requires file descriptors table:
|
|
|
269 * poll, /dev/poll, rt signals.
|
|
|
270 */
|
|
|
271 #define NGX_USE_FD_EVENT 0x00000400
|
|
|
272
|
|
0
|
273
|
|
|
274
|
|
|
275 /*
|
|
|
276 * The event filter is deleted before the closing file.
|
|
|
277 * Has no meaning for select, poll, epoll.
|
|
|
278 *
|
|
|
279 * kqueue: kqueue deletes event filters for file that closed
|
|
|
280 * so we need only to delete filters in user-level batch array
|
|
|
281 * /dev/poll: we need to flush POLLREMOVE event before closing file
|
|
|
282 */
|
|
|
283
|
|
|
284 #define NGX_CLOSE_EVENT 1
|
|
|
285 #define NGX_DISABLE_EVENT 2
|
|
|
286
|
|
|
287
|
|
|
288 /* these flags have a meaning only for kqueue */
|
|
|
289 #define NGX_LOWAT_EVENT 0
|
|
|
290 #define NGX_VNODE_EVENT 0
|
|
|
291
|
|
|
292
|
|
18
|
293 #if (NGX_HAVE_KQUEUE)
|
|
0
|
294
|
|
|
295 #define NGX_READ_EVENT EVFILT_READ
|
|
|
296 #define NGX_WRITE_EVENT EVFILT_WRITE
|
|
|
297
|
|
|
298 #undef NGX_VNODE_EVENT
|
|
|
299 #define NGX_VNODE_EVENT EVFILT_VNODE
|
|
|
300
|
|
|
301 /*
|
|
|
302 * NGX_CLOSE_EVENT and NGX_LOWAT_EVENT are the module flags and they would
|
|
|
303 * not go into a kernel so we need to choose the value that would not interfere
|
|
|
304 * with any existent and future kqueue flags. kqueue has such values -
|
|
|
305 * EV_FLAG1, EV_EOF and EV_ERROR. They are reserved and cleared on a kernel
|
|
|
306 * entrance.
|
|
|
307 */
|
|
|
308 #undef NGX_CLOSE_EVENT
|
|
|
309 #define NGX_CLOSE_EVENT EV_EOF
|
|
|
310
|
|
|
311 #undef NGX_LOWAT_EVENT
|
|
|
312 #define NGX_LOWAT_EVENT EV_FLAG1
|
|
|
313
|
|
|
314 #define NGX_LEVEL_EVENT 0
|
|
|
315 #define NGX_ONESHOT_EVENT EV_ONESHOT
|
|
|
316 #define NGX_CLEAR_EVENT EV_CLEAR
|
|
|
317
|
|
|
318 #undef NGX_DISABLE_EVENT
|
|
|
319 #define NGX_DISABLE_EVENT EV_DISABLE
|
|
|
320
|
|
|
321
|
|
18
|
322 #elif (NGX_HAVE_DEVPOLL)
|
|
0
|
323
|
|
|
324 #define NGX_READ_EVENT POLLIN
|
|
|
325 #define NGX_WRITE_EVENT POLLOUT
|
|
|
326
|
|
|
327 #define NGX_LEVEL_EVENT 0
|
|
|
328 #define NGX_ONESHOT_EVENT 1
|
|
|
329
|
|
|
330
|
|
18
|
331 #elif (NGX_HAVE_EPOLL)
|
|
0
|
332
|
|
|
333 #define NGX_READ_EVENT EPOLLIN
|
|
|
334 #define NGX_WRITE_EVENT EPOLLOUT
|
|
|
335
|
|
|
336 #define NGX_LEVEL_EVENT 0
|
|
|
337 #define NGX_CLEAR_EVENT EPOLLET
|
|
|
338 #define NGX_ONESHOT_EVENT 0x70000000
|
|
|
339 #if 0
|
|
|
340 #define NGX_ONESHOT_EVENT EPOLLONESHOT
|
|
|
341 #endif
|
|
|
342
|
|
|
343
|
|
18
|
344 #elif (NGX_HAVE_POLL)
|
|
0
|
345
|
|
|
346 #define NGX_READ_EVENT POLLIN
|
|
|
347 #define NGX_WRITE_EVENT POLLOUT
|
|
|
348
|
|
|
349 #define NGX_LEVEL_EVENT 0
|
|
|
350 #define NGX_ONESHOT_EVENT 1
|
|
|
351
|
|
|
352
|
|
|
353 #else /* select */
|
|
|
354
|
|
|
355 #define NGX_READ_EVENT 0
|
|
|
356 #define NGX_WRITE_EVENT 1
|
|
|
357
|
|
|
358 #define NGX_LEVEL_EVENT 0
|
|
|
359 #define NGX_ONESHOT_EVENT 1
|
|
|
360
|
|
18
|
361 #endif /* NGX_HAVE_KQUEUE */
|
|
0
|
362
|
|
|
363
|
|
18
|
364 #if (NGX_HAVE_IOCP)
|
|
0
|
365 #define NGX_IOCP_ACCEPT 0
|
|
|
366 #define NGX_IOCP_IO 1
|
|
|
367 #define NGX_IOCP_CONNECT 2
|
|
|
368 #endif
|
|
|
369
|
|
|
370
|
|
|
371 #ifndef NGX_CLEAR_EVENT
|
|
|
372 #define NGX_CLEAR_EVENT 0 /* dummy declaration */
|
|
|
373 #endif
|
|
|
374
|
|
|
375
|
|
|
376 #define ngx_process_changes ngx_event_actions.process_changes
|
|
|
377 #define ngx_process_events ngx_event_actions.process_events
|
|
|
378 #define ngx_done_events ngx_event_actions.done
|
|
|
379
|
|
|
380 #define ngx_add_event ngx_event_actions.add
|
|
|
381 #define ngx_del_event ngx_event_actions.del
|
|
|
382 #define ngx_add_conn ngx_event_actions.add_conn
|
|
|
383 #define ngx_del_conn ngx_event_actions.del_conn
|
|
|
384
|
|
|
385 #define ngx_add_timer ngx_event_add_timer
|
|
|
386 #define ngx_del_timer ngx_event_del_timer
|
|
|
387
|
|
|
388
|
|
92
|
389 extern ngx_os_io_t ngx_io;
|
|
|
390
|
|
0
|
391 #define ngx_recv ngx_io.recv
|
|
|
392 #define ngx_recv_chain ngx_io.recv_chain
|
|
|
393 #define ngx_send ngx_io.send
|
|
|
394 #define ngx_send_chain ngx_io.send_chain
|
|
|
395
|
|
|
396
|
|
|
397 #define NGX_EVENT_MODULE 0x544E5645 /* "EVNT" */
|
|
|
398 #define NGX_EVENT_CONF 0x02000000
|
|
|
399
|
|
|
400
|
|
|
401 typedef struct {
|
|
|
402 ngx_uint_t connections;
|
|
|
403 ngx_uint_t use;
|
|
|
404
|
|
|
405 ngx_flag_t multi_accept;
|
|
|
406 ngx_flag_t accept_mutex;
|
|
|
407
|
|
|
408 ngx_msec_t accept_mutex_delay;
|
|
|
409
|
|
|
410 u_char *name;
|
|
|
411
|
|
|
412 #if (NGX_DEBUG)
|
|
|
413 ngx_array_t debug_connection;
|
|
|
414 #endif
|
|
|
415 } ngx_event_conf_t;
|
|
|
416
|
|
|
417
|
|
|
418 typedef struct {
|
|
|
419 ngx_str_t *name;
|
|
|
420
|
|
|
421 void *(*create_conf)(ngx_cycle_t *cycle);
|
|
|
422 char *(*init_conf)(ngx_cycle_t *cycle, void *conf);
|
|
|
423
|
|
|
424 ngx_event_actions_t actions;
|
|
|
425 } ngx_event_module_t;
|
|
|
426
|
|
|
427
|
|
|
428 extern ngx_atomic_t *ngx_connection_counter;
|
|
|
429
|
|
|
430 extern ngx_atomic_t *ngx_accept_mutex_ptr;
|
|
|
431 extern ngx_atomic_t *ngx_accept_mutex;
|
|
|
432 extern ngx_uint_t ngx_accept_mutex_held;
|
|
|
433 extern ngx_msec_t ngx_accept_mutex_delay;
|
|
|
434 extern ngx_int_t ngx_accept_disabled;
|
|
|
435
|
|
|
436
|
|
|
437 #if (NGX_STAT_STUB)
|
|
|
438
|
|
|
439 extern ngx_atomic_t *ngx_stat_accepted;
|
|
44
|
440 extern ngx_atomic_t *ngx_stat_handled;
|
|
0
|
441 extern ngx_atomic_t *ngx_stat_requests;
|
|
|
442 extern ngx_atomic_t *ngx_stat_active;
|
|
|
443 extern ngx_atomic_t *ngx_stat_reading;
|
|
|
444 extern ngx_atomic_t *ngx_stat_writing;
|
|
|
445
|
|
|
446 #endif
|
|
|
447
|
|
|
448
|
|
|
449
|
|
|
450 #define ngx_accept_mutex_unlock() \
|
|
|
451 if (ngx_accept_mutex_held) { \
|
|
|
452 *ngx_accept_mutex = 0; \
|
|
|
453 }
|
|
|
454
|
|
|
455
|
|
|
456 extern ngx_uint_t ngx_event_flags;
|
|
|
457 extern ngx_module_t ngx_events_module;
|
|
|
458 extern ngx_module_t ngx_event_core_module;
|
|
|
459
|
|
|
460
|
|
|
461 #define ngx_event_get_conf(conf_ctx, module) \
|
|
|
462 (*(ngx_get_conf(conf_ctx, ngx_events_module))) [module.ctx_index];
|
|
|
463
|
|
|
464
|
|
|
465
|
|
|
466 void ngx_event_accept(ngx_event_t *ev);
|
|
|
467 ngx_int_t ngx_trylock_accept_mutex(ngx_cycle_t *cycle);
|
|
|
468 ngx_int_t ngx_disable_accept_events(ngx_cycle_t *cycle);
|
|
|
469 ngx_int_t ngx_enable_accept_events(ngx_cycle_t *cycle);
|
|
92
|
470 u_char *ngx_accept_log_error(ngx_log_t *log, u_char *buf, size_t len);
|
|
0
|
471
|
|
|
472
|
|
58
|
473 ngx_int_t ngx_handle_read_event(ngx_event_t *rev, u_int flags);
|
|
|
474 ngx_int_t ngx_handle_write_event(ngx_event_t *wev, size_t lowat);
|
|
|
475
|
|
|
476
|
|
10
|
477 #if (NGX_WIN32)
|
|
0
|
478 void ngx_event_acceptex(ngx_event_t *ev);
|
|
92
|
479 ngx_int_t ngx_event_post_acceptex(ngx_listening_t *ls, ngx_uint_t n);
|
|
|
480 u_char *ngx_acceptex_log_error(ngx_log_t *log, u_char *buf, size_t len);
|
|
0
|
481 #endif
|
|
|
482
|
|
|
483
|
|
2
|
484 ngx_int_t ngx_send_lowat(ngx_connection_t *c, size_t lowat);
|
|
|
485
|
|
|
486
|
|
0
|
487 /* used in ngx_log_debugX() */
|
|
|
488 #define ngx_event_ident(p) ((ngx_connection_t *) (p))->fd
|
|
|
489
|
|
|
490
|
|
|
491 #include <ngx_event_timer.h>
|
|
|
492 #include <ngx_event_posted.h>
|
|
|
493 #include <ngx_event_busy_lock.h>
|
|
|
494
|
|
10
|
495 #if (NGX_WIN32)
|
|
0
|
496 #include <ngx_iocp_module.h>
|
|
|
497 #endif
|
|
|
498
|
|
|
499
|
|
|
500 #endif /* _NGX_EVENT_H_INCLUDED_ */
|
