3 * Copyright (C) Igor Sysoev
7 #ifndef _NGX_EVENT_H_INCLUDED_
8 #define _NGX_EVENT_H_INCLUDED_
11 #include <ngx_config.h>
15 #define NGX_INVALID_INDEX 0xd0d0d0d0
44 /* used to detect the stale events in kqueue, rtsig, and epoll */
48 * the event was passed or would be passed to a kernel;
49 * in aio mode - operation was posted.
55 /* the ready event; in aio mode 0 means that no operation can be posted */
60 /* aio operation is complete */
71 unsigned read_discarded:1;
73 unsigned unexpected_eof:1;
75 unsigned deferred_accept:1;
77 /* the pending eof reported by kqueue or in aio chain operation */
78 unsigned pending_eof:1;
81 unsigned posted_ready:1;
85 /* setsockopt(SO_UPDATE_ACCEPT_CONTEXT) was succesfull */
86 unsigned accept_context_updated:1;
92 /* the pending errno reported by kqueue */
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
107 * accept: 1 if accept many, 0 otherwise
110 #if (NGX_HAVE_KQUEUE) || (NGX_HAVE_IOCP)
113 unsigned available:1;
116 ngx_event_handler_pt handler;
122 ngx_event_ovlp_t ovlp;
133 ngx_rbtree_node_t timer;
137 /* to test on worker exit */
145 unsigned posted_ready:1;
146 unsigned posted_timedout:1;
147 unsigned posted_eof:1;
149 #if (NGX_HAVE_KQUEUE)
150 /* the pending errno reported by kqueue */
154 #if (NGX_HAVE_KQUEUE) || (NGX_HAVE_IOCP)
155 int posted_available;
157 unsigned posted_available:1;
161 ngx_atomic_t *own_lock;
165 /* the links of the posted queue */
172 /* the threads support */
175 * the event thread context, we store it here
176 * if $(CC) does not understand __thread declaration
177 * and pthread_getspecific() is too costly
182 #if (NGX_EVENT_T_PADDING)
184 /* event should not cross cache line in SMP */
186 uint32_t padding[NGX_EVENT_T_PADDING];
199 ngx_int_t (*add)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags);
200 ngx_int_t (*del)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags);
202 ngx_int_t (*enable)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags);
203 ngx_int_t (*disable)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags);
205 ngx_int_t (*add_conn)(ngx_connection_t *c);
206 ngx_int_t (*del_conn)(ngx_connection_t *c, ngx_uint_t flags);
208 ngx_int_t (*process_changes)(ngx_cycle_t *cycle, ngx_uint_t nowait);
209 ngx_int_t (*process_events)(ngx_cycle_t *cycle, ngx_msec_t timer,
212 ngx_int_t (*init)(ngx_cycle_t *cycle, ngx_msec_t timer);
213 void (*done)(ngx_cycle_t *cycle);
214 } ngx_event_actions_t;
217 extern ngx_event_actions_t ngx_event_actions;
221 * The event filter requires to read/write the whole data:
222 * select, poll, /dev/poll, kqueue, epoll.
224 #define NGX_USE_LEVEL_EVENT 0x00000001
227 * The event filter is deleted after a notification without an additional
228 * syscall: kqueue, epoll.
230 #define NGX_USE_ONESHOT_EVENT 0x00000002
233 * The event filter notifies only the changes and an initial level:
236 #define NGX_USE_CLEAR_EVENT 0x00000004
239 * The event filter has kqueue features: the eof flag, errno,
240 * available data, etc.
242 #define NGX_USE_KQUEUE_EVENT 0x00000008
245 * The event filter supports low water mark: kqueue's NOTE_LOWAT.
246 * kqueue in FreeBSD 4.1-4.2 has no NOTE_LOWAT so we need a separate flag.
248 #define NGX_USE_LOWAT_EVENT 0x00000010
251 * The event filter requires to do i/o operation until EAGAIN: epoll, rtsig.
253 #define NGX_USE_GREEDY_EVENT 0x00000020
256 * The event filter is epoll.
258 #define NGX_USE_EPOLL_EVENT 0x00000040
261 * No need to add or delete the event filters: rtsig.
263 #define NGX_USE_RTSIG_EVENT 0x00000080
266 * No need to add or delete the event filters: overlapped, aio_read,
267 * aioread, io_submit.
269 #define NGX_USE_AIO_EVENT 0x00000100
272 * Need to add socket or handle only once: i/o completion port.
273 * It also requires NGX_HAVE_AIO and NGX_USE_AIO_EVENT to be set.
275 #define NGX_USE_IOCP_EVENT 0x00000200
278 * The event filter has no opaque data and requires file descriptors table:
279 * poll, /dev/poll, rtsig.
281 #define NGX_USE_FD_EVENT 0x00000400
284 * The event module handles periodic or absolute timer event by itself:
285 * kqueue in FreeBSD 4.4, NetBSD 2.0, and MacOSX 10.4, Solaris 10's event ports.
287 #define NGX_USE_TIMER_EVENT 0x00000800
290 * All event filters on file descriptor are deleted after a notification:
291 * Solaris 10's event ports.
293 #define NGX_USE_EVENTPORT_EVENT 0x00001000
296 * The event filter support vnode notifications: kqueue.
298 #define NGX_USE_VNODE_EVENT 0x00002000
302 * The event filter is deleted just before the closing file.
303 * Has no meaning for select and poll.
304 * kqueue, epoll, rtsig, eventport: allows to avoid explicit delete,
305 * because filter automatically is deleted
308 * /dev/poll: we need to flush POLLREMOVE event
309 * before closing file.
311 #define NGX_CLOSE_EVENT 1
314 * disable temporarily event filter, this may avoid locks
315 * in kernel malloc()/free(): kqueue.
317 #define NGX_DISABLE_EVENT 2
320 * event must be passed to kernel right now, do not wait until batch processing.
322 #define NGX_FLUSH_EVENT 4
325 /* these flags have a meaning only for kqueue */
326 #define NGX_LOWAT_EVENT 0
327 #define NGX_VNODE_EVENT 0
330 #if (NGX_HAVE_KQUEUE)
332 #define NGX_READ_EVENT EVFILT_READ
333 #define NGX_WRITE_EVENT EVFILT_WRITE
335 #undef NGX_VNODE_EVENT
336 #define NGX_VNODE_EVENT EVFILT_VNODE
339 * NGX_CLOSE_EVENT, NGX_LOWAT_EVENT, and NGX_FLUSH_EVENT are the module flags
340 * and they must not go into a kernel so we need to choose the value
341 * that must not interfere with any existent and future kqueue flags.
342 * kqueue has such values - EV_FLAG1, EV_EOF, and EV_ERROR:
343 * they are reserved and cleared on a kernel entrance.
345 #undef NGX_CLOSE_EVENT
346 #define NGX_CLOSE_EVENT EV_EOF
348 #undef NGX_LOWAT_EVENT
349 #define NGX_LOWAT_EVENT EV_FLAG1
351 #undef NGX_FLUSH_EVENT
352 #define NGX_FLUSH_EVENT EV_ERROR
354 #define NGX_LEVEL_EVENT 0
355 #define NGX_ONESHOT_EVENT EV_ONESHOT
356 #define NGX_CLEAR_EVENT EV_CLEAR
358 #undef NGX_DISABLE_EVENT
359 #define NGX_DISABLE_EVENT EV_DISABLE
362 #elif (NGX_HAVE_DEVPOLL || NGX_HAVE_EVENTPORT)
364 #define NGX_READ_EVENT POLLIN
365 #define NGX_WRITE_EVENT POLLOUT
367 #define NGX_LEVEL_EVENT 0
368 #define NGX_ONESHOT_EVENT 1
371 #elif (NGX_HAVE_EPOLL)
373 #define NGX_READ_EVENT EPOLLIN
374 #define NGX_WRITE_EVENT EPOLLOUT
376 #define NGX_LEVEL_EVENT 0
377 #define NGX_CLEAR_EVENT EPOLLET
378 #define NGX_ONESHOT_EVENT 0x70000000
380 #define NGX_ONESHOT_EVENT EPOLLONESHOT
384 #elif (NGX_HAVE_POLL)
386 #define NGX_READ_EVENT POLLIN
387 #define NGX_WRITE_EVENT POLLOUT
389 #define NGX_LEVEL_EVENT 0
390 #define NGX_ONESHOT_EVENT 1
395 #define NGX_READ_EVENT 0
396 #define NGX_WRITE_EVENT 1
398 #define NGX_LEVEL_EVENT 0
399 #define NGX_ONESHOT_EVENT 1
401 #endif /* NGX_HAVE_KQUEUE */
405 #define NGX_IOCP_ACCEPT 0
406 #define NGX_IOCP_IO 1
407 #define NGX_IOCP_CONNECT 2
411 #ifndef NGX_CLEAR_EVENT
412 #define NGX_CLEAR_EVENT 0 /* dummy declaration */
416 #define ngx_process_changes ngx_event_actions.process_changes
417 #define ngx_process_events ngx_event_actions.process_events
418 #define ngx_done_events ngx_event_actions.done
420 #define ngx_add_event ngx_event_actions.add
421 #define ngx_del_event ngx_event_actions.del
422 #define ngx_add_conn ngx_event_actions.add_conn
423 #define ngx_del_conn ngx_event_actions.del_conn
425 #define ngx_add_timer ngx_event_add_timer
426 #define ngx_del_timer ngx_event_del_timer
429 extern ngx_os_io_t ngx_io;
431 #define ngx_recv ngx_io.recv
432 #define ngx_recv_chain ngx_io.recv_chain
433 #define ngx_udp_recv ngx_io.udp_recv
434 #define ngx_send ngx_io.send
435 #define ngx_send_chain ngx_io.send_chain
438 #define NGX_EVENT_MODULE 0x544E5645 /* "EVNT" */
439 #define NGX_EVENT_CONF 0x02000000
443 ngx_uint_t connections;
446 ngx_flag_t multi_accept;
447 ngx_flag_t accept_mutex;
449 ngx_msec_t accept_mutex_delay;
454 ngx_array_t debug_connection;
462 void *(*create_conf)(ngx_cycle_t *cycle);
463 char *(*init_conf)(ngx_cycle_t *cycle, void *conf);
465 ngx_event_actions_t actions;
466 } ngx_event_module_t;
469 extern ngx_atomic_t *ngx_connection_counter;
471 extern ngx_atomic_t *ngx_accept_mutex_ptr;
472 extern ngx_shmtx_t ngx_accept_mutex;
473 extern ngx_uint_t ngx_use_accept_mutex;
474 extern ngx_uint_t ngx_accept_events;
475 extern ngx_uint_t ngx_accept_mutex_held;
476 extern ngx_msec_t ngx_accept_mutex_delay;
477 extern ngx_int_t ngx_accept_disabled;
482 extern ngx_atomic_t *ngx_stat_accepted;
483 extern ngx_atomic_t *ngx_stat_handled;
484 extern ngx_atomic_t *ngx_stat_requests;
485 extern ngx_atomic_t *ngx_stat_active;
486 extern ngx_atomic_t *ngx_stat_reading;
487 extern ngx_atomic_t *ngx_stat_writing;
492 #define NGX_UPDATE_TIME 1
493 #define NGX_POST_EVENTS 2
494 #define NGX_POST_THREAD_EVENTS 4
497 extern sig_atomic_t ngx_event_timer_alarm;
498 extern ngx_uint_t ngx_event_flags;
499 extern ngx_module_t ngx_events_module;
500 extern ngx_module_t ngx_event_core_module;
503 #define ngx_event_get_conf(conf_ctx, module) \
504 (*(ngx_get_conf(conf_ctx, ngx_events_module))) [module.ctx_index];
508 void ngx_event_accept(ngx_event_t *ev);
509 ngx_int_t ngx_trylock_accept_mutex(ngx_cycle_t *cycle);
510 u_char *ngx_accept_log_error(ngx_log_t *log, u_char *buf, size_t len);
513 void ngx_process_events_and_timers(ngx_cycle_t *cycle);
514 ngx_int_t ngx_handle_read_event(ngx_event_t *rev, ngx_uint_t flags);
515 ngx_int_t ngx_handle_write_event(ngx_event_t *wev, size_t lowat);
519 void ngx_event_acceptex(ngx_event_t *ev);
520 ngx_int_t ngx_event_post_acceptex(ngx_listening_t *ls, ngx_uint_t n);
521 u_char *ngx_acceptex_log_error(ngx_log_t *log, u_char *buf, size_t len);
525 ngx_int_t ngx_send_lowat(ngx_connection_t *c, size_t lowat);
528 /* used in ngx_log_debugX() */
529 #define ngx_event_ident(p) ((ngx_connection_t *) (p))->fd
532 #include <ngx_event_timer.h>
533 #include <ngx_event_posted.h>
534 #include <ngx_event_busy_lock.h>
537 #include <ngx_iocp_module.h>
541 #endif /* _NGX_EVENT_H_INCLUDED_ */