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