src/event/modules/ngx_select_module.c - nginx-1.31.4 nginx/ @ 8d9666701

Global variables defined

Functions defined

Source code


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


  5. #include <ngx_config.h>
  6. #include <ngx_core.h>
  7. #include <ngx_event.h>


  8. static ngx_int_t ngx_select_init(ngx_cycle_t *cycle, ngx_msec_t timer);
  9. static void ngx_select_done(ngx_cycle_t *cycle);
  10. static ngx_int_t ngx_select_add_event(ngx_event_t *ev, ngx_int_t event,
  11.     ngx_uint_t flags);
  12. static ngx_int_t ngx_select_del_event(ngx_event_t *ev, ngx_int_t event,
  13.     ngx_uint_t flags);
  14. static ngx_int_t ngx_select_process_events(ngx_cycle_t *cycle, ngx_msec_t timer,
  15.     ngx_uint_t flags);
  16. static void ngx_select_repair_fd_sets(ngx_cycle_t *cycle);
  17. static char *ngx_select_init_conf(ngx_cycle_t *cycle, void *conf);


  18. static fd_set         master_read_fd_set;
  19. static fd_set         master_write_fd_set;
  20. static fd_set         work_read_fd_set;
  21. static fd_set         work_write_fd_set;

  22. static ngx_int_t      max_fd;
  23. static ngx_uint_t     nevents;

  24. static ngx_event_t  **event_index;


  25. static ngx_str_t           select_name = ngx_string("select");

  26. static ngx_event_module_t  ngx_select_module_ctx = {
  27.     &select_name,
  28.     NULL,                                  /* create configuration */
  29.     ngx_select_init_conf,                  /* init configuration */

  30.     {
  31.         ngx_select_add_event,              /* add an event */
  32.         ngx_select_del_event,              /* delete an event */
  33.         ngx_select_add_event,              /* enable an event */
  34.         ngx_select_del_event,              /* disable an event */
  35.         NULL,                              /* add an connection */
  36.         NULL,                              /* delete an connection */
  37.         NULL,                              /* trigger a notify */
  38.         ngx_select_process_events,         /* process the events */
  39.         ngx_select_init,                   /* init the events */
  40.         ngx_select_done                    /* done the events */
  41.     }

  42. };

  43. ngx_module_t  ngx_select_module = {
  44.     NGX_MODULE_V1,
  45.     &ngx_select_module_ctx,                /* module context */
  46.     NULL,                                  /* module directives */
  47.     NGX_EVENT_MODULE,                      /* module type */
  48.     NULL,                                  /* init master */
  49.     NULL,                                  /* init module */
  50.     NULL,                                  /* init process */
  51.     NULL,                                  /* init thread */
  52.     NULL,                                  /* exit thread */
  53.     NULL,                                  /* exit process */
  54.     NULL,                                  /* exit master */
  55.     NGX_MODULE_V1_PADDING
  56. };


  57. static ngx_int_t
  58. ngx_select_init(ngx_cycle_t *cycle, ngx_msec_t timer)
  59. {
  60.     ngx_event_t  **index;

  61.     if (event_index == NULL) {
  62.         FD_ZERO(&master_read_fd_set);
  63.         FD_ZERO(&master_write_fd_set);
  64.         nevents = 0;
  65.     }

  66.     if (ngx_process >= NGX_PROCESS_WORKER
  67.         || cycle->old_cycle == NULL
  68.         || cycle->old_cycle->connection_n < cycle->connection_n)
  69.     {
  70.         index = ngx_alloc(sizeof(ngx_event_t *) * 2 * cycle->connection_n,
  71.                           cycle->log);
  72.         if (index == NULL) {
  73.             return NGX_ERROR;
  74.         }

  75.         if (event_index) {
  76.             ngx_memcpy(index, event_index, sizeof(ngx_event_t *) * nevents);
  77.             ngx_free(event_index);
  78.         }

  79.         event_index = index;
  80.     }

  81.     ngx_io = ngx_os_io;

  82.     ngx_event_actions = ngx_select_module_ctx.actions;

  83.     ngx_event_flags = NGX_USE_LEVEL_EVENT;

  84.     max_fd = -1;

  85.     return NGX_OK;
  86. }


  87. static void
  88. ngx_select_done(ngx_cycle_t *cycle)
  89. {
  90.     ngx_free(event_index);

  91.     event_index = NULL;
  92. }


  93. static ngx_int_t
  94. ngx_select_add_event(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags)
  95. {
  96.     ngx_connection_t  *c;

  97.     c = ev->data;

  98.     ngx_log_debug2(NGX_LOG_DEBUG_EVENT, ev->log, 0,
  99.                    "select add event fd:%d ev:%i", c->fd, event);

  100.     if (ev->index != NGX_INVALID_INDEX) {
  101.         ngx_log_error(NGX_LOG_ALERT, ev->log, 0,
  102.                       "select event fd:%d ev:%i is already set", c->fd, event);
  103.         return NGX_OK;
  104.     }

  105.     if ((event == NGX_READ_EVENT && ev->write)
  106.         || (event == NGX_WRITE_EVENT && !ev->write))
  107.     {
  108.         ngx_log_error(NGX_LOG_ALERT, ev->log, 0,
  109.                       "invalid select %s event fd:%d ev:%i",
  110.                       ev->write ? "write" : "read", c->fd, event);
  111.         return NGX_ERROR;
  112.     }

  113.     /* disable warning: the default FD_SETSIZE is 1024U in FreeBSD 5.x-10.x */

  114.     if ((event == NGX_READ_EVENT || event == NGX_WRITE_EVENT)
  115.         && (unsigned) c->fd >= FD_SETSIZE)
  116.     {
  117.         ngx_log_error(NGX_LOG_ERR, ev->log, 0,
  118.                       "maximum number of descriptors "
  119.                       "supported by select() is %ud", FD_SETSIZE);
  120.         return NGX_ERROR;
  121.     }

  122.     if (event == NGX_READ_EVENT) {
  123.         FD_SET(c->fd, &master_read_fd_set);

  124.     } else if (event == NGX_WRITE_EVENT) {
  125.         FD_SET(c->fd, &master_write_fd_set);
  126.     }

  127.     if (max_fd != -1 && max_fd < c->fd) {
  128.         max_fd = c->fd;
  129.     }

  130.     ev->active = 1;

  131.     event_index[nevents] = ev;
  132.     ev->index = nevents;
  133.     nevents++;

  134.     return NGX_OK;
  135. }


  136. static ngx_int_t
  137. ngx_select_del_event(ngx_event_t *ev, ngx_int_t event, ngx_uint_t flags)
  138. {
  139.     ngx_event_t       *e;
  140.     ngx_connection_t  *c;

  141.     c = ev->data;

  142.     ev->active = 0;

  143.     if (ev->index == NGX_INVALID_INDEX) {
  144.         return NGX_OK;
  145.     }

  146.     ngx_log_debug2(NGX_LOG_DEBUG_EVENT, ev->log, 0,
  147.                    "select del event fd:%d ev:%i", c->fd, event);

  148.     if (event == NGX_READ_EVENT) {
  149.         FD_CLR(c->fd, &master_read_fd_set);

  150.     } else if (event == NGX_WRITE_EVENT) {
  151.         FD_CLR(c->fd, &master_write_fd_set);
  152.     }

  153.     if (max_fd == c->fd) {
  154.         max_fd = -1;
  155.     }

  156.     if (ev->index < --nevents) {
  157.         e = event_index[nevents];
  158.         event_index[ev->index] = e;
  159.         e->index = ev->index;
  160.     }

  161.     ev->index = NGX_INVALID_INDEX;

  162.     return NGX_OK;
  163. }


  164. static ngx_int_t
  165. ngx_select_process_events(ngx_cycle_t *cycle, ngx_msec_t timer,
  166.     ngx_uint_t flags)
  167. {
  168.     int                ready, nready;
  169.     ngx_err_t          err;
  170.     ngx_uint_t         i, found;
  171.     ngx_event_t       *ev;
  172.     ngx_queue_t       *queue;
  173.     struct timeval     tv, *tp;
  174.     ngx_connection_t  *c;

  175.     if (max_fd == -1) {
  176.         for (i = 0; i < nevents; i++) {
  177.             c = event_index[i]->data;
  178.             if (max_fd < c->fd) {
  179.                 max_fd = c->fd;
  180.             }
  181.         }

  182.         ngx_log_debug1(NGX_LOG_DEBUG_EVENT, cycle->log, 0,
  183.                        "change max_fd: %i", max_fd);
  184.     }

  185. #if (NGX_DEBUG)
  186.     if (cycle->log->log_level & NGX_LOG_DEBUG_ALL) {
  187.         for (i = 0; i < nevents; i++) {
  188.             ev = event_index[i];
  189.             c = ev->data;
  190.             ngx_log_debug2(NGX_LOG_DEBUG_EVENT, cycle->log, 0,
  191.                            "select event: fd:%d wr:%d", c->fd, ev->write);
  192.         }

  193.         ngx_log_debug1(NGX_LOG_DEBUG_EVENT, cycle->log, 0,
  194.                        "max_fd: %i", max_fd);
  195.     }
  196. #endif

  197.     if (timer == NGX_TIMER_INFINITE) {
  198.         tp = NULL;

  199.     } else {
  200.         tv.tv_sec = (long) (timer / 1000);
  201.         tv.tv_usec = (long) ((timer % 1000) * 1000);
  202.         tp = &tv;
  203.     }

  204.     ngx_log_debug1(NGX_LOG_DEBUG_EVENT, cycle->log, 0,
  205.                    "select timer: %M", timer);

  206.     work_read_fd_set = master_read_fd_set;
  207.     work_write_fd_set = master_write_fd_set;

  208.     ready = select(max_fd + 1, &work_read_fd_set, &work_write_fd_set, NULL, tp);

  209.     err = (ready == -1) ? ngx_errno : 0;

  210.     if (flags & NGX_UPDATE_TIME || ngx_event_timer_alarm) {
  211.         ngx_time_update();
  212.     }

  213.     ngx_log_debug1(NGX_LOG_DEBUG_EVENT, cycle->log, 0,
  214.                    "select ready %d", ready);

  215.     if (err) {
  216.         ngx_uint_t  level;

  217.         if (err == NGX_EINTR) {

  218.             if (ngx_event_timer_alarm) {
  219.                 ngx_event_timer_alarm = 0;
  220.                 return NGX_OK;
  221.             }

  222.             level = NGX_LOG_INFO;

  223.         } else {
  224.             level = NGX_LOG_ALERT;
  225.         }

  226.         ngx_log_error(level, cycle->log, err, "select() failed");

  227.         if (err == NGX_EBADF) {
  228.             ngx_select_repair_fd_sets(cycle);
  229.         }

  230.         return NGX_ERROR;
  231.     }

  232.     if (ready == 0) {
  233.         if (timer != NGX_TIMER_INFINITE) {
  234.             return NGX_OK;
  235.         }

  236.         ngx_log_error(NGX_LOG_ALERT, cycle->log, 0,
  237.                       "select() returned no events without timeout");
  238.         return NGX_ERROR;
  239.     }

  240.     nready = 0;

  241.     for (i = 0; i < nevents; i++) {
  242.         ev = event_index[i];
  243.         c = ev->data;
  244.         found = 0;

  245.         if (ev->write) {
  246.             if (FD_ISSET(c->fd, &work_write_fd_set)) {
  247.                 found = 1;
  248.                 ngx_log_debug1(NGX_LOG_DEBUG_EVENT, cycle->log, 0,
  249.                                "select write %d", c->fd);
  250.             }

  251.         } else {
  252.             if (FD_ISSET(c->fd, &work_read_fd_set)) {
  253.                 found = 1;
  254.                 ngx_log_debug1(NGX_LOG_DEBUG_EVENT, cycle->log, 0,
  255.                                "select read %d", c->fd);
  256.             }
  257.         }

  258.         if (found) {
  259.             ev->ready = 1;
  260.             ev->available = -1;

  261.             queue = ev->accept ? &ngx_posted_accept_events
  262.                                : &ngx_posted_events;

  263.             ngx_post_event(ev, queue);

  264.             nready++;
  265.         }
  266.     }

  267.     if (ready != nready) {
  268.         ngx_log_error(NGX_LOG_ALERT, cycle->log, 0,
  269.                       "select ready != events: %d:%d", ready, nready);

  270.         ngx_select_repair_fd_sets(cycle);
  271.     }

  272.     return NGX_OK;
  273. }


  274. static void
  275. ngx_select_repair_fd_sets(ngx_cycle_t *cycle)
  276. {
  277.     int           n;
  278.     socklen_t     len;
  279.     ngx_err_t     err;
  280.     ngx_socket_t  s;

  281.     for (s = 0; s <= max_fd; s++) {

  282.         if (FD_ISSET(s, &master_read_fd_set) == 0) {
  283.             continue;
  284.         }

  285.         len = sizeof(int);

  286.         if (getsockopt(s, SOL_SOCKET, SO_TYPE, &n, &len) == -1) {
  287.             err = ngx_socket_errno;

  288.             ngx_log_error(NGX_LOG_ALERT, cycle->log, err,
  289.                           "invalid descriptor #%d in read fd_set", s);

  290.             FD_CLR(s, &master_read_fd_set);
  291.         }
  292.     }

  293.     for (s = 0; s <= max_fd; s++) {

  294.         if (FD_ISSET(s, &master_write_fd_set) == 0) {
  295.             continue;
  296.         }

  297.         len = sizeof(int);

  298.         if (getsockopt(s, SOL_SOCKET, SO_TYPE, &n, &len) == -1) {
  299.             err = ngx_socket_errno;

  300.             ngx_log_error(NGX_LOG_ALERT, cycle->log, err,
  301.                           "invalid descriptor #%d in write fd_set", s);

  302.             FD_CLR(s, &master_write_fd_set);
  303.         }
  304.     }

  305.     max_fd = -1;
  306. }


  307. static char *
  308. ngx_select_init_conf(ngx_cycle_t *cycle, void *conf)
  309. {
  310.     ngx_event_conf_t  *ecf;

  311.     ecf = ngx_event_get_conf(cycle->conf_ctx, ngx_event_core_module);

  312.     if (ecf->use != ngx_select_module.ctx_index) {
  313.         return NGX_CONF_OK;
  314.     }

  315.     if (cycle->connection_n > FD_SETSIZE) {
  316.         ngx_log_error(NGX_LOG_EMERG, cycle->log, 0,
  317.                       "the maximum number of files "
  318.                       "supported by select() is %ud", FD_SETSIZE);
  319.         return NGX_CONF_ERROR;
  320.     }

  321.     return NGX_CONF_OK;
  322. }