One Level Up Top Level

src/event/ngx_event.h - nginx-1.31.9 nginx/ @ 2a3a19c6f

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. ‌struct ngx_event_s {
  20.     void            *data;

  22.     unsigned         write:1;

  24.     unsigned         accept:1;

  26.     /* used to detect the stale events in kqueue and epoll */
  27.     unsigned         instance:1;

  29.     /*
  30.      * the event was passed or would be passed to a kernel;
  31.      * in aio mode - operation was posted.
  32.      */
  33.     unsigned         active:1;

  35.     unsigned         disabled:1;

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

  40.     unsigned         oneshot:1;

  42.     /* aio operation is complete */
  43.     unsigned         complete:1;

  45.     unsigned         eof:1;
  46.     unsigned         error:1;

  48.     unsigned         timedout:1;
  49.     unsigned         timer_set:1;

  51.     unsigned         delayed:1;

  53.     unsigned         deferred_accept:1;

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

  58.     unsigned         posted:1;

  60.     unsigned         closed:1;

  62.     /* to test on worker exit */
  63.     unsigned         channel:1;
  64.     unsigned         resolver:1;
  65.     unsigned         quic:1;

  67.     unsigned         cancelable:1;

  69. #if (NGX_HAVE_KQUEUE)
  70.     unsigned         kq_vnode:1;

  72.     /* the pending errno reported by kqueue */
  73.     int              kq_errno;
  74. #endif

  76.     /*
  77.      * kqueue only:
  78.      *   accept:     number of sockets that wait to be accepted
  79.      *   read:       bytes to read when event is ready
  80.      *               or lowat when event is set with NGX_LOWAT_EVENT flag
  81.      *   write:      available space in buffer when event is ready
  82.      *               or lowat when event is set with NGX_LOWAT_EVENT flag
  83.      *
  84.      * otherwise:
  85.      *   accept:     1 if accept many, 0 otherwise
  86.      *   read:       bytes to read when event is ready, -1 if not known
  87.      */

  89.     int              available;

  91.     ngx_event_handler_pt  handler;

  93.     ngx_uint_t       index;

  95.     ngx_log_t       *log;

  97.     ngx_rbtree_node_t   timer;

  99.     /* the posted queue */
  100.     ngx_queue_t      queue;

  102. #if 0

  104.     /* the threads support */

  106.     /*
  107.      * the event thread context, we store it here
  108.      * if $(CC) does not understand __thread declaration
  109.      * and pthread_getspecific() is too costly
  110.      */

  112.     void            *thr_ctx;

  114. #if (NGX_EVENT_T_PADDING)

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

  118.     uint32_t         padding[NGX_EVENT_T_PADDING];
  119. #endif
  120. #endif
  121. };


  124. #if (NGX_HAVE_FILE_AIO)

  126. ‌struct ngx_event_aio_s {
  127.     void                      *data;
  128.     ngx_event_handler_pt       handler;
  129.     ngx_file_t                *file;

  131.     ngx_fd_t                   fd;

  133. #if (NGX_HAVE_EVENTFD)
  134.     int64_t                    res;
  135. #endif

  137. #if !(NGX_HAVE_EVENTFD) || (NGX_TEST_BUILD_EPOLL)
  138.     ngx_err_t                  err;
  139.     size_t                     nbytes;
  140. #endif

  142.     ngx_aiocb_t                aiocb;
  143.     ngx_event_t                event;
  144. };

  146. #endif


  149. ‌typedef struct {
  150.     ngx_int_t  (*add)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags);
  151.     ngx_int_t  (*del)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags);

  153.     ngx_int_t  (*enable)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags);
  154.     ngx_int_t  (*disable)(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags);

  156.     ngx_int_t  (*add_conn)(ngx_connection_t *c);
  157.     ngx_int_t  (*del_conn)(ngx_connection_t *c, ngx_uint_t flags);

  159.     ngx_int_t  (*notify)(ngx_event_handler_pt handler);

  161.     ngx_int_t  (*process_events)(ngx_cycle_t *cycle, ngx_msec_t timer,
  162.                                  ngx_uint_t flags);

  164.     ngx_int_t  (*init)(ngx_cycle_t *cycle, ngx_msec_t timer);
  165.     void       (*done)(ngx_cycle_t *cycle);
  166. ‌} ngx_event_actions_t;


  169. extern ngx_event_actions_t   ngx_event_actions;
  170. #if (NGX_HAVE_EPOLLRDHUP)
  171. extern ngx_uint_t            ngx_use_epoll_rdhup;
  172. #endif


  175. /*
  176. * The event filter requires to read/write the whole data:
  177. * select, poll, /dev/poll, kqueue, epoll.
  178. */
  179. ‌#define NGX_USE_LEVEL_EVENT      0x00000001

  181. /*
  182. * The event filter is deleted after a notification without an additional
  183. * syscall: kqueue, epoll.
  184. */
  185. ‌#define NGX_USE_ONESHOT_EVENT    0x00000002

  187. /*
  188. * The event filter notifies only the changes and an initial level:
  189. * kqueue, epoll.
  190. */
  191. ‌#define NGX_USE_CLEAR_EVENT      0x00000004

  193. /*
  194. * The event filter has kqueue features: the eof flag, errno,
  195. * available data, etc.
  196. */
  197. ‌#define NGX_USE_KQUEUE_EVENT     0x00000008

  199. /*
  200. * The event filter supports low water mark: kqueue's NOTE_LOWAT.
  201. * kqueue in FreeBSD 4.1-4.2 has no NOTE_LOWAT so we need a separate flag.
  202. */
  203. ‌#define NGX_USE_LOWAT_EVENT      0x00000010

  205. /*
  206. * The event filter requires to do i/o operation until EAGAIN: epoll.
  207. */
  208. ‌#define NGX_USE_GREEDY_EVENT     0x00000020

  210. /*
  211. * The event filter is epoll.
  212. */
  213. ‌#define NGX_USE_EPOLL_EVENT      0x00000040

  215. /*
  216. * Obsolete.
  217. */
  218. ‌#define NGX_USE_RTSIG_EVENT      0x00000080

  220. /*
  221. * Obsolete.
  222. */
  223. ‌#define NGX_USE_AIO_EVENT        0x00000100

  225. /*
  226. * The event filter has no opaque data and requires file descriptors table:
  227. * poll, /dev/poll.
  228. */
  229. ‌#define NGX_USE_FD_EVENT         0x00000400

  231. /*
  232. * The event module handles periodic or absolute timer event by itself:
  233. * kqueue in FreeBSD 4.4, NetBSD 2.0, and MacOSX 10.4, Solaris 10's event ports.
  234. */
  235. ‌#define NGX_USE_TIMER_EVENT      0x00000800

  237. /*
  238. * All event filters on file descriptor are deleted after a notification:
  239. * Solaris 10's event ports.
  240. */
  241. ‌#define NGX_USE_EVENTPORT_EVENT  0x00001000

  243. /*
  244. * The event filter support vnode notifications: kqueue.
  245. */
  246. ‌#define NGX_USE_VNODE_EVENT      0x00002000


  249. /*
  250. * The event filter is deleted just before the closing file.
  251. * Has no meaning for select and poll.
  252. * kqueue, epoll, eventport:         allows to avoid explicit delete,
  253. *                                   because filter automatically is deleted
  254. *                                   on file close,
  255. *
  256. * /dev/poll:                        we need to flush POLLREMOVE event
  257. *                                   before closing file.
  258. */
  259. ‌#define NGX_CLOSE_EVENT    1

  261. /*
  262. * disable temporarily event filter, this may avoid locks
  263. * in kernel malloc()/free(): kqueue.
  264. */
  265. ‌#define NGX_DISABLE_EVENT  2

  267. /*
  268. * event must be passed to kernel right now, do not wait until batch processing.
  269. */
  270. ‌#define NGX_FLUSH_EVENT    4


  273. /* these flags have a meaning only for kqueue */
  274. ‌#define NGX_LOWAT_EVENT    0
  275. ‌#define NGX_VNODE_EVENT    0


  278. #if (NGX_HAVE_EPOLL) && !(NGX_HAVE_EPOLLRDHUP)
  279. ‌#define EPOLLRDHUP         0
  280. #endif


  283. #if (NGX_HAVE_KQUEUE)

  285. ‌#define NGX_READ_EVENT     EVFILT_READ
  286. ‌#define NGX_WRITE_EVENT    EVFILT_WRITE

  288. #undef  NGX_VNODE_EVENT
  289. ‌#define NGX_VNODE_EVENT    EVFILT_VNODE

  291. /*
  292. * NGX_CLOSE_EVENT, NGX_LOWAT_EVENT, and NGX_FLUSH_EVENT are the module flags
  293. * and they must not go into a kernel so we need to choose the value
  294. * that must not interfere with any existent and future kqueue flags.
  295. * kqueue has such values - EV_FLAG1, EV_EOF, and EV_ERROR:
  296. * they are reserved and cleared on a kernel entrance.
  297. */
  298. #undef  NGX_CLOSE_EVENT
  299. ‌#define NGX_CLOSE_EVENT    EV_EOF

  301. #undef  NGX_LOWAT_EVENT
  302. ‌#define NGX_LOWAT_EVENT    EV_FLAG1

  304. #undef  NGX_FLUSH_EVENT
  305. ‌#define NGX_FLUSH_EVENT    EV_ERROR

  307. ‌#define NGX_LEVEL_EVENT    0
  308. ‌#define NGX_ONESHOT_EVENT  EV_ONESHOT
  309. ‌#define NGX_CLEAR_EVENT    EV_CLEAR

  311. #undef  NGX_DISABLE_EVENT
  312. ‌#define NGX_DISABLE_EVENT  EV_DISABLE


  315. #elif (NGX_HAVE_DEVPOLL && !(NGX_TEST_BUILD_DEVPOLL)) \
  316.       || (NGX_HAVE_EVENTPORT && !(NGX_TEST_BUILD_EVENTPORT))

  318. ‌#define NGX_READ_EVENT     POLLIN
  319. ‌#define NGX_WRITE_EVENT    POLLOUT

  321. ‌#define NGX_LEVEL_EVENT    0
  322. ‌#define NGX_ONESHOT_EVENT  1


  325. #elif (NGX_HAVE_EPOLL) && !(NGX_TEST_BUILD_EPOLL)

  327. ‌#define NGX_READ_EVENT     (EPOLLIN|EPOLLRDHUP)
  328. ‌#define NGX_WRITE_EVENT    EPOLLOUT

  330. ‌#define NGX_LEVEL_EVENT    0
  331. ‌#define NGX_CLEAR_EVENT    EPOLLET
  332. ‌#define NGX_ONESHOT_EVENT  0x70000000
  333. #if 0
  334. #define NGX_ONESHOT_EVENT  EPOLLONESHOT
  335. #endif

  337. #if (NGX_HAVE_EPOLLEXCLUSIVE)
  338. ‌#define NGX_EXCLUSIVE_EVENT  EPOLLEXCLUSIVE
  339. #endif

  341. #elif (NGX_HAVE_POLL)

  343. ‌#define NGX_READ_EVENT     POLLIN
  344. ‌#define NGX_WRITE_EVENT    POLLOUT

  346. ‌#define NGX_LEVEL_EVENT    0
  347. ‌#define NGX_ONESHOT_EVENT  1


  350. #else /* select */

  352. ‌#define NGX_READ_EVENT     0
  353. ‌#define NGX_WRITE_EVENT    1

  355. ‌#define NGX_LEVEL_EVENT    0
  356. ‌#define NGX_ONESHOT_EVENT  1

  358. #endif /* NGX_HAVE_KQUEUE */


  361. #if (NGX_TEST_BUILD_EPOLL)
  362. ‌#define NGX_EXCLUSIVE_EVENT  0
  363. #endif


  366. #ifndef NGX_CLEAR_EVENT
  367. ‌#define NGX_CLEAR_EVENT    0    /* dummy declaration */
  368. #endif


  371. ‌#define ngx_process_events   ngx_event_actions.process_events
  372. ‌#define ngx_done_events      ngx_event_actions.done

  374. ‌#define ngx_add_event        ngx_event_actions.add
  375. ‌#define ngx_del_event        ngx_event_actions.del
  376. ‌#define ngx_add_conn         ngx_event_actions.add_conn
  377. ‌#define ngx_del_conn         ngx_event_actions.del_conn

  379. ‌#define ngx_notify           ngx_event_actions.notify

  381. ‌#define ngx_add_timer        ngx_event_add_timer
  382. ‌#define ngx_del_timer        ngx_event_del_timer


  385. extern ngx_os_io_t  ngx_io;

  387. ‌#define ngx_recv             ngx_io.recv
  388. ‌#define ngx_recv_chain       ngx_io.recv_chain
  389. ‌#define ngx_udp_recv         ngx_io.udp_recv
  390. ‌#define ngx_send             ngx_io.send
  391. ‌#define ngx_send_chain       ngx_io.send_chain
  392. ‌#define ngx_udp_send         ngx_io.udp_send
  393. ‌#define ngx_udp_send_chain   ngx_io.udp_send_chain


  396. ‌#define NGX_EVENT_MODULE      0x544E5645  /* "EVNT" */
  397. ‌#define NGX_EVENT_CONF        0x02000000


  400. ‌typedef struct {
  401.     ngx_uint_t    connections;
  402.     ngx_uint_t    use;

  404.     ngx_flag_t    multi_accept;
  405.     ngx_flag_t    accept_mutex;

  407.     ngx_msec_t    accept_mutex_delay;

  409.     u_char       *name;

  411. #if (NGX_DEBUG)
  412.     ngx_array_t   debug_connection;
  413. #endif
  414. ‌} ngx_event_conf_t;


  417. ‌typedef struct {
  418.     ngx_str_t              *name;

  420.     void                 *(*create_conf)(ngx_cycle_t *cycle);
  421.     char                 *(*init_conf)(ngx_cycle_t *cycle, void *conf);

  423.     ngx_event_actions_t     actions;
  424. ‌} ngx_event_module_t;


  427. extern ngx_atomic_t          *ngx_connection_counter;

  429. extern ngx_atomic_t          *ngx_accept_mutex_ptr;
  430. extern ngx_shmtx_t            ngx_accept_mutex;
  431. extern ngx_uint_t             ngx_use_accept_mutex;
  432. extern ngx_uint_t             ngx_accept_events;
  433. extern ngx_uint_t             ngx_accept_mutex_held;
  434. extern ngx_msec_t             ngx_accept_mutex_delay;
  435. extern ngx_int_t              ngx_accept_disabled;
  436. extern ngx_uint_t             ngx_use_exclusive_accept;


  439. #if (NGX_STAT_STUB)

  441. extern ngx_atomic_t  *ngx_stat_accepted;
  442. extern ngx_atomic_t  *ngx_stat_handled;
  443. extern ngx_atomic_t  *ngx_stat_requests;
  444. extern ngx_atomic_t  *ngx_stat_active;
  445. extern ngx_atomic_t  *ngx_stat_reading;
  446. extern ngx_atomic_t  *ngx_stat_writing;
  447. extern ngx_atomic_t  *ngx_stat_waiting;

  449. #endif


  452. ‌#define NGX_UPDATE_TIME         1
  453. ‌#define NGX_POST_EVENTS         2


  456. extern sig_atomic_t           ngx_event_timer_alarm;
  457. extern ngx_uint_t             ngx_event_flags;
  458. extern ngx_module_t           ngx_events_module;
  459. extern ngx_module_t           ngx_event_core_module;


  462. ‌#define ngx_event_get_conf(conf_ctx, module)                                  \
  463.              (*(ngx_get_conf(conf_ctx, ngx_events_module))) [module.ctx_index]



  467. void ngx_event_accept(ngx_event_t *ev);
  468. ngx_int_t ngx_trylock_accept_mutex(ngx_cycle_t *cycle);
  469. ngx_int_t ngx_enable_accept_events(ngx_cycle_t *cycle);
  470. u_char *ngx_accept_log_error(ngx_log_t *log, u_char *buf, size_t len);
  471. #if (NGX_DEBUG)
  472. void ngx_debug_accepted_connection(ngx_event_conf_t *ecf, ngx_connection_t *c);
  473. #endif


  476. void ngx_process_events_and_timers(ngx_cycle_t *cycle);
  477. ngx_int_t ngx_handle_read_event(ngx_event_t *rev, ngx_uint_t flags);
  478. ngx_int_t ngx_handle_write_event(ngx_event_t *wev, size_t lowat);


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


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


  488. #include <ngx_event_timer.h>
  489. #include <ngx_event_posted.h>
  490. #include <ngx_event_udp.h>


  493. #endif /* _NGX_EVENT_H_INCLUDED_ */

One Level Up Top Level