One Level Up Top Level

src/event/ngx_event.h - nginx-1.7.10

Data types defined

Macros defined

Source code


  2. /*
  3. * Copyright (C) Igor Sysoev
  4. * Copyright (C) Nginx, Inc.
  5. */


  8. #ifndef _NGX_EVENT_H_INCLUDED_
  9. ‌#define _NGX_EVENT_H_INCLUDED_


  12. #include <ngx_config.h>
  13. #include <ngx_core.h>


  16. ‌#define NGX_INVALID_INDEX  0xd0d0d0d0


  19. #if (NGX_HAVE_IOCP)

  21. typedef struct {
  22.     WSAOVERLAPPED    ovlp;
  23.     ngx_event_t     *event;
  24.     int              error;
  25. ‌} ngx_event_ovlp_t;

  27. #endif


  30. typedef struct {
  31.     ngx_uint_t       lock;

  33.     ngx_event_t     *events;
  34.     ngx_event_t     *last;
  35. ‌} ngx_event_mutex_t;


  38. ‌struct ngx_event_s {
  39.     void            *data;

  41.     unsigned         write:1;

  43.     unsigned         accept:1;

  45.     /* used to detect the stale events in kqueue, rtsig, and epoll */
  46.     unsigned         instance:1;

  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;

  54.     unsigned         disabled:1;

  56.     /* the ready event; in aio mode 0 means that no operation can be posted */
  57.     unsigned         ready:1;

  59.     unsigned         oneshot:1;

  61.     /* aio operation is complete */
  62.     unsigned         complete:1;

  64.     unsigned         eof:1;
  65.     unsigned         error:1;

  67.     unsigned         timedout:1;
  68.     unsigned         timer_set:1;

  70.     unsigned         delayed:1;

  72.     unsigned         deferred_accept:1;

  74.     /* the pending eof reported by kqueue, epoll or in aio chain operation */
  75.     unsigned         pending_eof:1;

  77.     unsigned         posted:1;

  79. #if (NGX_WIN32)
  80.     /* setsockopt(SO_UPDATE_ACCEPT_CONTEXT) was successful */
  81.     unsigned         accept_context_updated:1;
  82. #endif

  84. #if (NGX_HAVE_KQUEUE)
  85.     unsigned         kq_vnode:1;

  87.     /* the pending errno reported by kqueue */
  88.     int              kq_errno;
  89. #endif

  91.     /*
  92.      * kqueue only:
  93.      *   accept:     number of sockets that wait to be accepted
  94.      *   read:       bytes to read when event is ready
  95.      *               or lowat when event is set with NGX_LOWAT_EVENT flag
  96.      *   write:      available space in buffer when event is ready
  97.      *               or lowat when event is set with NGX_LOWAT_EVENT flag
  98.      *
  99.      * iocp: TODO
  100.      *
  101.      * otherwise:
  102.      *   accept:     1 if accept many, 0 otherwise
  103.      */

  105. #if (NGX_HAVE_KQUEUE) || (NGX_HAVE_IOCP)
  106.     int              available;
  107. #else
  108.     unsigned         available:1;
  109. #endif

  111.     ngx_event_handler_pt  handler;


  114. #if (NGX_HAVE_AIO)

  116. #if (NGX_HAVE_IOCP)
  117.     ngx_event_ovlp_t ovlp;
  118. #else
  119.     struct aiocb     aiocb;
  120. #endif

  122. #endif

  124.     ngx_uint_t       index;

  126.     ngx_log_t       *log;

  128.     ngx_rbtree_node_t   timer;

  130.     /* the posted queue */
  131.     ngx_queue_t      queue;

  133.     unsigned         closed:1;

  135.     /* to test on worker exit */
  136.     unsigned         channel:1;
  137.     unsigned         resolver:1;

  139.     unsigned         cancelable:1;


  142. #if 0

  144.     /* the threads support */

  146.     /*
  147.      * the event thread context, we store it here
  148.      * if $(CC) does not understand __thread declaration
  149.      * and pthread_getspecific() is too costly
  150.      */

  152.     void            *thr_ctx;

  154. #if (NGX_EVENT_T_PADDING)

  156.     /* event should not cross cache line in SMP */

  158.     uint32_t         padding[NGX_EVENT_T_PADDING];
  159. #endif
  160. #endif
  161. };


  164. #if (NGX_HAVE_FILE_AIO)

  166. ‌struct ngx_event_aio_s {
  167.     void                      *data;
  168.     ngx_event_handler_pt       handler;
  169.     ngx_file_t                *file;

  171.     ngx_fd_t                   fd;

  173. #if (NGX_HAVE_EVENTFD)
  174.     int64_t                    res;
  175. #if (NGX_TEST_BUILD_EPOLL)
  176.     ngx_err_t                  err;
  177.     size_t                     nbytes;
  178. #endif
  179. #else
  180.     ngx_err_t                  err;
  181.     size_t                     nbytes;
  182. #endif

  184. #if (NGX_HAVE_AIO_SENDFILE)
  185.     off_t                      last_offset;
  186. #endif

  188.     ngx_aiocb_t                aiocb;
  189.     ngx_event_t                event;
  190. };

  192. #endif


  195. typedef struct {
  196.     ngx_int_t  (*add)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags);
  197.     ngx_int_t  (*del)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags);

  199.     ngx_int_t  (*enable)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags);
  200.     ngx_int_t  (*disable)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags);

  202.     ngx_int_t  (*add_conn)(ngx_connection_t *c);
  203.     ngx_int_t  (*del_conn)(ngx_connection_t *c, ngx_uint_t flags);

  205.     ngx_int_t  (*process_changes)(ngx_cycle_t *cycle, ngx_uint_t nowait);
  206.     ngx_int_t  (*process_events)(ngx_cycle_t *cycle, ngx_msec_t timer,
  207.                    ngx_uint_t flags);

  209.     ngx_int_t  (*init)(ngx_cycle_t *cycle, ngx_msec_t timer);
  210.     void       (*done)(ngx_cycle_t *cycle);
  211. ‌} ngx_event_actions_t;


  214. extern ngx_event_actions_t   ngx_event_actions;


  217. /*
  218. * The event filter requires to read/write the whole data:
  219. * select, poll, /dev/poll, kqueue, epoll.
  220. */
  221. ‌#define NGX_USE_LEVEL_EVENT      0x00000001

  223. /*
  224. * The event filter is deleted after a notification without an additional
  225. * syscall: kqueue, epoll.
  226. */
  227. ‌#define NGX_USE_ONESHOT_EVENT    0x00000002

  229. /*
  230. * The event filter notifies only the changes and an initial level:
  231. * kqueue, epoll.
  232. */
  233. ‌#define NGX_USE_CLEAR_EVENT      0x00000004

  235. /*
  236. * The event filter has kqueue features: the eof flag, errno,
  237. * available data, etc.
  238. */
  239. ‌#define NGX_USE_KQUEUE_EVENT     0x00000008

  241. /*
  242. * The event filter supports low water mark: kqueue's NOTE_LOWAT.
  243. * kqueue in FreeBSD 4.1-4.2 has no NOTE_LOWAT so we need a separate flag.
  244. */
  245. ‌#define NGX_USE_LOWAT_EVENT      0x00000010

  247. /*
  248. * The event filter requires to do i/o operation until EAGAIN: epoll, rtsig.
  249. */
  250. ‌#define NGX_USE_GREEDY_EVENT     0x00000020

  252. /*
  253. * The event filter is epoll.
  254. */
  255. ‌#define NGX_USE_EPOLL_EVENT      0x00000040

  257. /*
  258. * No need to add or delete the event filters: rtsig.
  259. */
  260. ‌#define NGX_USE_RTSIG_EVENT      0x00000080

  262. /*
  263. * No need to add or delete the event filters: overlapped, aio_read,
  264. * aioread, io_submit.
  265. */
  266. ‌#define NGX_USE_AIO_EVENT        0x00000100

  268. /*
  269. * Need to add socket or handle only once: i/o completion port.
  270. * It also requires NGX_HAVE_AIO and NGX_USE_AIO_EVENT to be set.
  271. */
  272. ‌#define NGX_USE_IOCP_EVENT       0x00000200

  274. /*
  275. * The event filter has no opaque data and requires file descriptors table:
  276. * poll, /dev/poll, rtsig.
  277. */
  278. ‌#define NGX_USE_FD_EVENT         0x00000400

  280. /*
  281. * The event module handles periodic or absolute timer event by itself:
  282. * kqueue in FreeBSD 4.4, NetBSD 2.0, and MacOSX 10.4, Solaris 10's event ports.
  283. */
  284. ‌#define NGX_USE_TIMER_EVENT      0x00000800

  286. /*
  287. * All event filters on file descriptor are deleted after a notification:
  288. * Solaris 10's event ports.
  289. */
  290. ‌#define NGX_USE_EVENTPORT_EVENT  0x00001000

  292. /*
  293. * The event filter support vnode notifications: kqueue.
  294. */
  295. ‌#define NGX_USE_VNODE_EVENT      0x00002000


  298. /*
  299. * The event filter is deleted just before the closing file.
  300. * Has no meaning for select and poll.
  301. * kqueue, epoll, rtsig, eventport:  allows to avoid explicit delete,
  302. *                                   because filter automatically is deleted
  303. *                                   on file close,
  304. *
  305. * /dev/poll:                        we need to flush POLLREMOVE event
  306. *                                   before closing file.
  307. */
  308. ‌#define NGX_CLOSE_EVENT    1

  310. /*
  311. * disable temporarily event filter, this may avoid locks
  312. * in kernel malloc()/free(): kqueue.
  313. */
  314. ‌#define NGX_DISABLE_EVENT  2

  316. /*
  317. * event must be passed to kernel right now, do not wait until batch processing.
  318. */
  319. ‌#define NGX_FLUSH_EVENT    4


  322. /* these flags have a meaning only for kqueue */
  323. ‌#define NGX_LOWAT_EVENT    0
  324. ‌#define NGX_VNODE_EVENT    0


  327. #if (NGX_HAVE_EPOLL) && !(NGX_HAVE_EPOLLRDHUP)
  328. ‌#define EPOLLRDHUP         0
  329. #endif


  332. #if (NGX_HAVE_KQUEUE)

  334. ‌#define NGX_READ_EVENT     EVFILT_READ
  335. ‌#define NGX_WRITE_EVENT    EVFILT_WRITE

  337. ‌#undef  NGX_VNODE_EVENT
  338. ‌#define NGX_VNODE_EVENT    EVFILT_VNODE

  340. /*
  341. * NGX_CLOSE_EVENT, NGX_LOWAT_EVENT, and NGX_FLUSH_EVENT are the module flags
  342. * and they must not go into a kernel so we need to choose the value
  343. * that must not interfere with any existent and future kqueue flags.
  344. * kqueue has such values - EV_FLAG1, EV_EOF, and EV_ERROR:
  345. * they are reserved and cleared on a kernel entrance.
  346. */
  347. ‌#undef  NGX_CLOSE_EVENT
  348. ‌#define NGX_CLOSE_EVENT    EV_EOF

  350. ‌#undef  NGX_LOWAT_EVENT
  351. ‌#define NGX_LOWAT_EVENT    EV_FLAG1

  353. ‌#undef  NGX_FLUSH_EVENT
  354. ‌#define NGX_FLUSH_EVENT    EV_ERROR

  356. ‌#define NGX_LEVEL_EVENT    0
  357. ‌#define NGX_ONESHOT_EVENT  EV_ONESHOT
  358. ‌#define NGX_CLEAR_EVENT    EV_CLEAR

  360. ‌#undef  NGX_DISABLE_EVENT
  361. ‌#define NGX_DISABLE_EVENT  EV_DISABLE


  364. #elif (NGX_HAVE_DEVPOLL || NGX_HAVE_EVENTPORT)

  366. ‌#define NGX_READ_EVENT     POLLIN
  367. ‌#define NGX_WRITE_EVENT    POLLOUT

  369. ‌#define NGX_LEVEL_EVENT    0
  370. ‌#define NGX_ONESHOT_EVENT  1


  373. #elif (NGX_HAVE_EPOLL)

  375. ‌#define NGX_READ_EVENT     (EPOLLIN|EPOLLRDHUP)
  376. ‌#define NGX_WRITE_EVENT    EPOLLOUT

  378. ‌#define NGX_LEVEL_EVENT    0
  379. ‌#define NGX_CLEAR_EVENT    EPOLLET
  380. ‌#define NGX_ONESHOT_EVENT  0x70000000
  381. #if 0
  382. #define NGX_ONESHOT_EVENT  EPOLLONESHOT
  383. #endif


  386. #elif (NGX_HAVE_POLL)

  388. ‌#define NGX_READ_EVENT     POLLIN
  389. ‌#define NGX_WRITE_EVENT    POLLOUT

  391. ‌#define NGX_LEVEL_EVENT    0
  392. ‌#define NGX_ONESHOT_EVENT  1


  395. #else /* select */

  397. ‌#define NGX_READ_EVENT     0
  398. ‌#define NGX_WRITE_EVENT    1

  400. ‌#define NGX_LEVEL_EVENT    0
  401. ‌#define NGX_ONESHOT_EVENT  1

  403. #endif /* NGX_HAVE_KQUEUE */


  406. #if (NGX_HAVE_IOCP)
  407. ‌#define NGX_IOCP_ACCEPT      0
  408. ‌#define NGX_IOCP_IO          1
  409. ‌#define NGX_IOCP_CONNECT     2
  410. #endif


  413. #ifndef NGX_CLEAR_EVENT
  414. ‌#define NGX_CLEAR_EVENT    0    /* dummy declaration */
  415. #endif


  418. ‌#define ngx_process_changes  ngx_event_actions.process_changes
  419. ‌#define ngx_process_events   ngx_event_actions.process_events
  420. ‌#define ngx_done_events      ngx_event_actions.done

  422. ‌#define ngx_add_event        ngx_event_actions.add
  423. ‌#define ngx_del_event        ngx_event_actions.del
  424. ‌#define ngx_add_conn         ngx_event_actions.add_conn
  425. ‌#define ngx_del_conn         ngx_event_actions.del_conn

  427. ‌#define ngx_add_timer        ngx_event_add_timer
  428. ‌#define ngx_del_timer        ngx_event_del_timer


  431. extern ngx_os_io_t  ngx_io;

  433. ‌#define ngx_recv             ngx_io.recv
  434. ‌#define ngx_recv_chain       ngx_io.recv_chain
  435. ‌#define ngx_udp_recv         ngx_io.udp_recv
  436. ‌#define ngx_send             ngx_io.send
  437. ‌#define ngx_send_chain       ngx_io.send_chain


  440. ‌#define NGX_EVENT_MODULE      0x544E5645  /* "EVNT" */
  441. ‌#define NGX_EVENT_CONF        0x02000000


  444. typedef struct {
  445.     ngx_uint_t    connections;
  446.     ngx_uint_t    use;

  448.     ngx_flag_t    multi_accept;
  449.     ngx_flag_t    accept_mutex;

  451.     ngx_msec_t    accept_mutex_delay;

  453.     u_char       *name;

  455. #if (NGX_DEBUG)
  456.     ngx_array_t   debug_connection;
  457. #endif
  458. ‌} ngx_event_conf_t;


  461. typedef struct {
  462.     ngx_str_t              *name;

  464.     void                 *(*create_conf)(ngx_cycle_t *cycle);
  465.     char                 *(*init_conf)(ngx_cycle_t *cycle, void *conf);

  467.     ngx_event_actions_t     actions;
  468. ‌} ngx_event_module_t;


  471. extern ngx_atomic_t          *ngx_connection_counter;

  473. extern ngx_atomic_t          *ngx_accept_mutex_ptr;
  474. extern ngx_shmtx_t            ngx_accept_mutex;
  475. extern ngx_uint_t             ngx_use_accept_mutex;
  476. extern ngx_uint_t             ngx_accept_events;
  477. extern ngx_uint_t             ngx_accept_mutex_held;
  478. extern ngx_msec_t             ngx_accept_mutex_delay;
  479. extern ngx_int_t              ngx_accept_disabled;


  482. #if (NGX_STAT_STUB)

  484. extern ngx_atomic_t  *ngx_stat_accepted;
  485. extern ngx_atomic_t  *ngx_stat_handled;
  486. extern ngx_atomic_t  *ngx_stat_requests;
  487. extern ngx_atomic_t  *ngx_stat_active;
  488. extern ngx_atomic_t  *ngx_stat_reading;
  489. extern ngx_atomic_t  *ngx_stat_writing;
  490. extern ngx_atomic_t  *ngx_stat_waiting;

  492. #endif


  495. ‌#define NGX_UPDATE_TIME         1
  496. ‌#define NGX_POST_EVENTS         2


  499. extern sig_atomic_t           ngx_event_timer_alarm;
  500. extern ngx_uint_t             ngx_event_flags;
  501. extern ngx_module_t           ngx_events_module;
  502. extern ngx_module_t           ngx_event_core_module;


  505. ‌#define ngx_event_get_conf(conf_ctx, module)                                  \
  506.              (*(ngx_get_conf(conf_ctx, ngx_events_module))) [module.ctx_index];



  510. void ngx_event_accept(ngx_event_t *ev);
  511. ngx_int_t ngx_trylock_accept_mutex(ngx_cycle_t *cycle);
  512. u_char *ngx_accept_log_error(ngx_log_t *log, u_char *buf, size_t len);


  515. void ngx_process_events_and_timers(ngx_cycle_t *cycle);
  516. ngx_int_t ngx_handle_read_event(ngx_event_t *rev, ngx_uint_t flags);
  517. ngx_int_t ngx_handle_write_event(ngx_event_t *wev, size_t lowat);


  520. #if (NGX_WIN32)
  521. void ngx_event_acceptex(ngx_event_t *ev);
  522. ngx_int_t ngx_event_post_acceptex(ngx_listening_t *ls, ngx_uint_t n);
  523. u_char *ngx_acceptex_log_error(ngx_log_t *log, u_char *buf, size_t len);
  524. #endif


  527. ngx_int_t ngx_send_lowat(ngx_connection_t *c, size_t lowat);


  530. /* used in ngx_log_debugX() */
  531. ‌#define ngx_event_ident(p)  ((ngx_connection_t *) (p))->fd


  534. #include <ngx_event_timer.h>
  535. #include <ngx_event_posted.h>
  536. #include <ngx_event_busy_lock.h>

  538. #if (NGX_WIN32)
  539. #include <ngx_iocp_module.h>
  540. #endif


  543. #endif /* _NGX_EVENT_H_INCLUDED_ */

One Level Up Top Level