|
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 /* used to detect the stale events in kqueue, rt signals and epoll */
|
|
|
45 unsigned instance:1;
|
|
|
46
|
|
|
47 /*
|
|
|
48 * the event was passed or would be passed to a kernel;
|
|
|
49 * in aio mode - operation was posted.
|
|
|
50 */
|
|
|
51 unsigned active:1;
|
|
|
52
|
|
|
53 unsigned disabled:1;
|
|
|
54
|
|
|
55 /* the ready event; in aio mode 0 means that no operation can be posted */
|
|
|
56 unsigned ready:1;
|
|
|
57
|
|
236
|
58 unsigned oneshot:1;
|
|
|
59
|
|
0
|
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
|
|
112
|
137 /* to test on worker exit */
|
|
|
138 unsigned channel:1;
|
|
|
139
|
|
0
|
140 #if (NGX_THREADS)
|
|
|
141
|
|
|
142 unsigned locked:1;
|
|
|
143
|
|
|
144 unsigned posted_ready:1;
|
|
|
145 unsigned posted_timedout:1;
|
|
|
146 unsigned posted_eof:1;
|
|
|
147
|
|
18
|
148 #if (NGX_HAVE_KQUEUE)
|
|
0
|
149 /* the pending errno reported by kqueue */
|
|
|
150 int posted_errno;
|
|
|
151 #endif
|
|
|
152
|
|
18
|
153 #if (NGX_HAVE_KQUEUE) || (NGX_HAVE_IOCP)
|
|
0
|
154 int posted_available;
|
|
|
155 #else
|
|
|
156 unsigned posted_available:1;
|
|
|
157 #endif
|
|
|
158
|
|
|
159 ngx_atomic_t *lock;
|
|
|
160 ngx_atomic_t *own_lock;
|
|
|
161
|
|
|
162 #endif
|
|
|
163
|
|
|
164 /* the links of the posted queue */
|
|
|
165 ngx_event_t *next;
|
|
|
166 ngx_event_t **prev;
|
|
|
167
|
|
|
168
|
|
|
169 #if 0
|
|
|
170
|
|
|
171 /* the threads support */
|
|
|
172
|
|
|
173 /*
|
|
|
174 * the event thread context, we store it here
|
|
|
175 * if $(CC) does not understand __thread declaration
|
|
|
176 * and pthread_getspecific() is too costly
|
|
|
177 */
|
|
|
178
|
|
|
179 void *thr_ctx;
|
|
|
180
|
|
|
181 #if (NGX_EVENT_T_PADDING)
|
|
|
182
|
|
|
183 /* event should not cross cache line in SMP */
|
|
|
184
|
|
|
185 int padding[NGX_EVENT_T_PADDING];
|
|
|
186 #endif
|
|
|
187 #endif
|
|
|
188 };
|
|
|
189
|
|
|
190
|
|
|
191 typedef struct {
|
|
214
|
192 in_addr_t mask;
|
|
|
193 in_addr_t addr;
|
|
|
194 } ngx_event_debug_t;
|
|
|
195
|
|
|
196
|
|
|
197 typedef struct {
|
|
0
|
198 ngx_int_t (*add)(ngx_event_t *ev, int event, u_int flags);
|
|
|
199 ngx_int_t (*del)(ngx_event_t *ev, int event, u_int flags);
|
|
|
200
|
|
|
201 ngx_int_t (*enable)(ngx_event_t *ev, int event, u_int flags);
|
|
|
202 ngx_int_t (*disable)(ngx_event_t *ev, int event, u_int flags);
|
|
|
203
|
|
|
204 ngx_int_t (*add_conn)(ngx_connection_t *c);
|
|
|
205 ngx_int_t (*del_conn)(ngx_connection_t *c, u_int flags);
|
|
|
206
|
|
2
|
207 ngx_int_t (*process_changes)(ngx_cycle_t *cycle, ngx_uint_t nowait);
|
|
112
|
208 ngx_int_t (*process_events)(ngx_cycle_t *cycle, ngx_msec_t timer,
|
|
|
209 ngx_uint_t flags);
|
|
0
|
210
|
|
112
|
211 ngx_int_t (*init)(ngx_cycle_t *cycle, ngx_msec_t timer);
|
|
0
|
212 void (*done)(ngx_cycle_t *cycle);
|
|
|
213 } ngx_event_actions_t;
|
|
|
214
|
|
|
215
|
|
|
216 extern ngx_event_actions_t ngx_event_actions;
|
|
|
217
|
|
|
218
|
|
|
219 /*
|
|
92
|
220 * The event filter requires to read/write the whole data:
|
|
0
|
221 * select, poll, /dev/poll, kqueue, epoll.
|
|
|
222 */
|
|
|
223 #define NGX_USE_LEVEL_EVENT 0x00000001
|
|
|
224
|
|
|
225 /*
|
|
|
226 * The event filter is deleted after a notification without an additional
|
|
236
|
227 * syscall: kqueue, epoll.
|
|
0
|
228 */
|
|
|
229 #define NGX_USE_ONESHOT_EVENT 0x00000002
|
|
|
230
|
|
|
231 /*
|
|
92
|
232 * The event filter notifies only the changes and an initial level:
|
|
0
|
233 * kqueue, epoll.
|
|
|
234 */
|
|
|
235 #define NGX_USE_CLEAR_EVENT 0x00000004
|
|
|
236
|
|
|
237 /*
|
|
92
|
238 * The event filter has kqueue features: the eof flag, errno,
|
|
0
|
239 * available data, etc.
|
|
|
240 */
|
|
92
|
241 #define NGX_USE_KQUEUE_EVENT 0x00000008
|
|
0
|
242
|
|
|
243 /*
|
|
92
|
244 * The event filter supports low water mark: kqueue's NOTE_LOWAT.
|
|
0
|
245 * kqueue in FreeBSD 4.1-4.2 has no NOTE_LOWAT so we need a separate flag.
|
|
|
246 */
|
|
92
|
247 #define NGX_USE_LOWAT_EVENT 0x00000010
|
|
0
|
248
|
|
|
249 /*
|
|
92
|
250 * The event filter requires to do i/o operation until EAGAIN:
|
|
0
|
251 * epoll, rt signals.
|
|
|
252 */
|
|
92
|
253 #define NGX_USE_GREEDY_EVENT 0x00000020
|
|
0
|
254
|
|
|
255 /*
|
|
92
|
256 * The event filter is epoll.
|
|
0
|
257 */
|
|
|
258 #define NGX_USE_EPOLL_EVENT 0x00000040
|
|
|
259
|
|
|
260 /*
|
|
92
|
261 * No need to add or delete the event filters: rt signals.
|
|
0
|
262 */
|
|
|
263 #define NGX_USE_RTSIG_EVENT 0x00000080
|
|
|
264
|
|
|
265 /*
|
|
92
|
266 * No need to add or delete the event filters: overlapped, aio_read,
|
|
0
|
267 * aioread, io_submit.
|
|
|
268 */
|
|
|
269 #define NGX_USE_AIO_EVENT 0x00000100
|
|
|
270
|
|
|
271 /*
|
|
92
|
272 * Need to add socket or handle only once: i/o completion port.
|
|
18
|
273 * It also requires NGX_HAVE_AIO and NGX_USE_AIO_EVENT to be set.
|
|
0
|
274 */
|
|
|
275 #define NGX_USE_IOCP_EVENT 0x00000200
|
|
|
276
|
|
92
|
277 /*
|
|
|
278 * The event filter has no opaque data and requires file descriptors table:
|
|
|
279 * poll, /dev/poll, rt signals.
|
|
|
280 */
|
|
|
281 #define NGX_USE_FD_EVENT 0x00000400
|
|
|
282
|
|
112
|
283 /*
|
|
|
284 * The event module handles periodic or absolute timer event by itself:
|
|
|
285 * kqueue in FreeBSD 4.4 and NetBSD 2.0, Solaris 10's event ports.
|
|
|
286 */
|
|
|
287 #define NGX_USE_TIMER_EVENT 0x00000800
|
|
|
288
|
|
236
|
289 /*
|
|
|
290 * All event filters on file descriptor are deleted after a notification:
|
|
|
291 * Solaris 10's event ports.
|
|
|
292 */
|
|
|
293 #define NGX_USE_EVENTPORT_EVENT 0x00001000
|
|
|
294
|
|
0
|
295
|
|
|
296
|
|
|
297 /*
|
|
|
298 * The event filter is deleted before the closing file.
|
|
236
|
299 * Has no meaning for select, poll, kqueue, epoll.
|
|
0
|
300 * /dev/poll: we need to flush POLLREMOVE event before closing file
|
|
|
301 */
|
|
|
302
|
|
|
303 #define NGX_CLOSE_EVENT 1
|
|
|
304 #define NGX_DISABLE_EVENT 2
|
|
|
305
|
|
|
306
|
|
|
307 /* these flags have a meaning only for kqueue */
|
|
|
308 #define NGX_LOWAT_EVENT 0
|
|
|
309 #define NGX_VNODE_EVENT 0
|
|
|
310
|
|
|
311
|
|
18
|
312 #if (NGX_HAVE_KQUEUE)
|
|
0
|
313
|
|
|
314 #define NGX_READ_EVENT EVFILT_READ
|
|
|
315 #define NGX_WRITE_EVENT EVFILT_WRITE
|
|
|
316
|
|
|
317 #undef NGX_VNODE_EVENT
|
|
|
318 #define NGX_VNODE_EVENT EVFILT_VNODE
|
|
|
319
|
|
|
320 /*
|
|
|
321 * NGX_CLOSE_EVENT and NGX_LOWAT_EVENT are the module flags and they would
|
|
|
322 * not go into a kernel so we need to choose the value that would not interfere
|
|
|
323 * with any existent and future kqueue flags. kqueue has such values -
|
|
|
324 * EV_FLAG1, EV_EOF and EV_ERROR. They are reserved and cleared on a kernel
|
|
|
325 * entrance.
|
|
|
326 */
|
|
|
327 #undef NGX_CLOSE_EVENT
|
|
|
328 #define NGX_CLOSE_EVENT EV_EOF
|
|
|
329
|
|
|
330 #undef NGX_LOWAT_EVENT
|
|
|
331 #define NGX_LOWAT_EVENT EV_FLAG1
|
|
|
332
|
|
|
333 #define NGX_LEVEL_EVENT 0
|
|
|
334 #define NGX_ONESHOT_EVENT EV_ONESHOT
|
|
|
335 #define NGX_CLEAR_EVENT EV_CLEAR
|
|
|
336
|
|
|
337 #undef NGX_DISABLE_EVENT
|
|
|
338 #define NGX_DISABLE_EVENT EV_DISABLE
|
|
|
339
|
|
|
340
|
|
236
|
341 #elif (NGX_HAVE_DEVPOLL || NGX_HAVE_EVENTPORT)
|
|
0
|
342
|
|
|
343 #define NGX_READ_EVENT POLLIN
|
|
|
344 #define NGX_WRITE_EVENT POLLOUT
|
|
|
345
|
|
|
346 #define NGX_LEVEL_EVENT 0
|
|
|
347 #define NGX_ONESHOT_EVENT 1
|
|
|
348
|
|
|
349
|
|
18
|
350 #elif (NGX_HAVE_EPOLL)
|
|
0
|
351
|
|
|
352 #define NGX_READ_EVENT EPOLLIN
|
|
|
353 #define NGX_WRITE_EVENT EPOLLOUT
|
|
|
354
|
|
|
355 #define NGX_LEVEL_EVENT 0
|
|
|
356 #define NGX_CLEAR_EVENT EPOLLET
|
|
|
357 #define NGX_ONESHOT_EVENT 0x70000000
|
|
|
358 #if 0
|
|
|
359 #define NGX_ONESHOT_EVENT EPOLLONESHOT
|
|
|
360 #endif
|
|
|
361
|
|
|
362
|
|
18
|
363 #elif (NGX_HAVE_POLL)
|
|
0
|
364
|
|
|
365 #define NGX_READ_EVENT POLLIN
|
|
|
366 #define NGX_WRITE_EVENT POLLOUT
|
|
|
367
|
|
|
368 #define NGX_LEVEL_EVENT 0
|
|
|
369 #define NGX_ONESHOT_EVENT 1
|
|
|
370
|
|
|
371
|
|
|
372 #else /* select */
|
|
|
373
|
|
|
374 #define NGX_READ_EVENT 0
|
|
|
375 #define NGX_WRITE_EVENT 1
|
|
|
376
|
|
|
377 #define NGX_LEVEL_EVENT 0
|
|
|
378 #define NGX_ONESHOT_EVENT 1
|
|
|
379
|
|
18
|
380 #endif /* NGX_HAVE_KQUEUE */
|
|
0
|
381
|
|
|
382
|
|
18
|
383 #if (NGX_HAVE_IOCP)
|
|
0
|
384 #define NGX_IOCP_ACCEPT 0
|
|
|
385 #define NGX_IOCP_IO 1
|
|
|
386 #define NGX_IOCP_CONNECT 2
|
|
|
387 #endif
|
|
|
388
|
|
|
389
|
|
|
390 #ifndef NGX_CLEAR_EVENT
|
|
|
391 #define NGX_CLEAR_EVENT 0 /* dummy declaration */
|
|
|
392 #endif
|
|
|
393
|
|
|
394
|
|
|
395 #define ngx_process_changes ngx_event_actions.process_changes
|
|
|
396 #define ngx_process_events ngx_event_actions.process_events
|
|
|
397 #define ngx_done_events ngx_event_actions.done
|
|
|
398
|
|
|
399 #define ngx_add_event ngx_event_actions.add
|
|
|
400 #define ngx_del_event ngx_event_actions.del
|
|
|
401 #define ngx_add_conn ngx_event_actions.add_conn
|
|
|
402 #define ngx_del_conn ngx_event_actions.del_conn
|
|
|
403
|
|
|
404 #define ngx_add_timer ngx_event_add_timer
|
|
|
405 #define ngx_del_timer ngx_event_del_timer
|
|
|
406
|
|
|
407
|
|
92
|
408 extern ngx_os_io_t ngx_io;
|
|
|
409
|
|
0
|
410 #define ngx_recv ngx_io.recv
|
|
|
411 #define ngx_recv_chain ngx_io.recv_chain
|
|
|
412 #define ngx_send ngx_io.send
|
|
|
413 #define ngx_send_chain ngx_io.send_chain
|
|
|
414
|
|
|
415
|
|
|
416 #define NGX_EVENT_MODULE 0x544E5645 /* "EVNT" */
|
|
|
417 #define NGX_EVENT_CONF 0x02000000
|
|
|
418
|
|
|
419
|
|
|
420 typedef struct {
|
|
|
421 ngx_uint_t connections;
|
|
|
422 ngx_uint_t use;
|
|
|
423
|
|
|
424 ngx_flag_t multi_accept;
|
|
|
425 ngx_flag_t accept_mutex;
|
|
|
426
|
|
|
427 ngx_msec_t accept_mutex_delay;
|
|
|
428
|
|
|
429 u_char *name;
|
|
|
430
|
|
|
431 #if (NGX_DEBUG)
|
|
|
432 ngx_array_t debug_connection;
|
|
|
433 #endif
|
|
|
434 } ngx_event_conf_t;
|
|
|
435
|
|
|
436
|
|
|
437 typedef struct {
|
|
|
438 ngx_str_t *name;
|
|
|
439
|
|
|
440 void *(*create_conf)(ngx_cycle_t *cycle);
|
|
|
441 char *(*init_conf)(ngx_cycle_t *cycle, void *conf);
|
|
|
442
|
|
|
443 ngx_event_actions_t actions;
|
|
|
444 } ngx_event_module_t;
|
|
|
445
|
|
|
446
|
|
|
447 extern ngx_atomic_t *ngx_connection_counter;
|
|
|
448
|
|
|
449 extern ngx_atomic_t *ngx_accept_mutex_ptr;
|
|
160
|
450 extern ngx_shmtx_t ngx_accept_mutex;
|
|
|
451 extern ngx_uint_t ngx_use_accept_mutex;
|
|
236
|
452 extern ngx_uint_t ngx_accept_events;
|
|
0
|
453 extern ngx_uint_t ngx_accept_mutex_held;
|
|
|
454 extern ngx_msec_t ngx_accept_mutex_delay;
|
|
|
455 extern ngx_int_t ngx_accept_disabled;
|
|
|
456
|
|
|
457
|
|
|
458 #if (NGX_STAT_STUB)
|
|
|
459
|
|
|
460 extern ngx_atomic_t *ngx_stat_accepted;
|
|
44
|
461 extern ngx_atomic_t *ngx_stat_handled;
|
|
0
|
462 extern ngx_atomic_t *ngx_stat_requests;
|
|
|
463 extern ngx_atomic_t *ngx_stat_active;
|
|
|
464 extern ngx_atomic_t *ngx_stat_reading;
|
|
|
465 extern ngx_atomic_t *ngx_stat_writing;
|
|
|
466
|
|
|
467 #endif
|
|
|
468
|
|
|
469
|
|
112
|
470 #define NGX_UPDATE_TIME 1
|
|
|
471 #define NGX_POST_EVENTS 2
|
|
|
472 #define NGX_POST_THREAD_EVENTS 4
|
|
0
|
473
|
|
|
474
|
|
112
|
475 extern sig_atomic_t ngx_event_timer_alarm;
|
|
0
|
476 extern ngx_uint_t ngx_event_flags;
|
|
|
477 extern ngx_module_t ngx_events_module;
|
|
|
478 extern ngx_module_t ngx_event_core_module;
|
|
|
479
|
|
|
480
|
|
|
481 #define ngx_event_get_conf(conf_ctx, module) \
|
|
|
482 (*(ngx_get_conf(conf_ctx, ngx_events_module))) [module.ctx_index];
|
|
|
483
|
|
|
484
|
|
|
485
|
|
|
486 void ngx_event_accept(ngx_event_t *ev);
|
|
|
487 ngx_int_t ngx_trylock_accept_mutex(ngx_cycle_t *cycle);
|
|
92
|
488 u_char *ngx_accept_log_error(ngx_log_t *log, u_char *buf, size_t len);
|
|
0
|
489
|
|
|
490
|
|
112
|
491 void ngx_process_events_and_timers(ngx_cycle_t *cycle);
|
|
58
|
492 ngx_int_t ngx_handle_read_event(ngx_event_t *rev, u_int flags);
|
|
|
493 ngx_int_t ngx_handle_write_event(ngx_event_t *wev, size_t lowat);
|
|
|
494
|
|
|
495
|
|
10
|
496 #if (NGX_WIN32)
|
|
0
|
497 void ngx_event_acceptex(ngx_event_t *ev);
|
|
92
|
498 ngx_int_t ngx_event_post_acceptex(ngx_listening_t *ls, ngx_uint_t n);
|
|
|
499 u_char *ngx_acceptex_log_error(ngx_log_t *log, u_char *buf, size_t len);
|
|
0
|
500 #endif
|
|
|
501
|
|
|
502
|
|
2
|
503 ngx_int_t ngx_send_lowat(ngx_connection_t *c, size_t lowat);
|
|
|
504
|
|
|
505
|
|
0
|
506 /* used in ngx_log_debugX() */
|
|
|
507 #define ngx_event_ident(p) ((ngx_connection_t *) (p))->fd
|
|
|
508
|
|
|
509
|
|
|
510 #include <ngx_event_timer.h>
|
|
|
511 #include <ngx_event_posted.h>
|
|
|
512 #include <ngx_event_busy_lock.h>
|
|
|
513
|
|
10
|
514 #if (NGX_WIN32)
|
|
0
|
515 #include <ngx_iocp_module.h>
|
|
|
516 #endif
|
|
|
517
|
|
|
518
|
|
|
519 #endif /* _NGX_EVENT_H_INCLUDED_ */
|
