src/fdevent.h

   1 #ifndef _FDEVENT_H_
   2 #define _FDEVENT_H_
   3 #include "first.h"
   4
   5 #include "settings.h"
   6
   7 #if defined HAVE_STDINT_H
   8 # include <stdint.h>
   9 #elif defined HAVE_INTTYPES_H
  10 # include <inttypes.h>
  11 #endif
  12
  13 #include <sys/types.h>
  14
  15 /* select event-system */
  16
  17 #if defined(HAVE_EPOLL_CTL) && defined(HAVE_SYS_EPOLL_H)
  18 # define USE_LINUX_EPOLL
  19 struct epoll_event;     /* declaration */
  20 #endif
  21
  22 /* MacOS 10.3.x has poll.h under /usr/include/, all other unixes
  23  * under /usr/include/sys/ */
  24 #if defined HAVE_POLL && (defined(HAVE_SYS_POLL_H) || defined(HAVE_POLL_H))
  25 # define USE_POLL
  26 struct pollfd;          /* declaration */
  27 #endif
  28
  29 #if defined HAVE_SELECT
  30 # ifdef __WIN32
  31 #  include <winsock2.h>
  32 # endif
  33 # define USE_SELECT
  34 # ifdef HAVE_SYS_SELECT_H
  35 #  include <sys/select.h>
  36 # endif
  37 #endif
  38
  39 #if defined HAVE_SYS_DEVPOLL_H && defined(__sun)
  40 # define USE_SOLARIS_DEVPOLL
  41 struct pollfd;          /* declaration */
  42 #endif
  43
  44 #if defined HAVE_PORT_H && defined HAVE_PORT_CREATE && defined(__sun)
  45 # define USE_SOLARIS_PORT
  46 # include <port.h>
  47 #endif
  48
  49 #if defined HAVE_SYS_EVENT_H && defined HAVE_KQUEUE
  50 # define USE_FREEBSD_KQUEUE
  51 struct kevent;          /* declaration */
  52 #endif
  53
  54 #if defined HAVE_LIBEV
  55 # define USE_LIBEV
  56 struct ev_loop;         /* declaration */
  57 #endif
  58
  59 struct server;          /* declaration */
  60
  61 typedef handler_t (*fdevent_handler)(struct server *srv, void *ctx, int revents);
  62
  63 /* these are the POLL* values from <bits/poll.h> (linux poll)
  64  */
  65
  66 #define FDEVENT_IN     BV(0)
  67 #define FDEVENT_PRI    BV(1)
  68 #define FDEVENT_OUT    BV(2)
  69 #define FDEVENT_ERR    BV(3)
  70 #define FDEVENT_HUP    BV(4)
  71 #define FDEVENT_NVAL   BV(5)
  72
  73 #define FDEVENT_STREAM_REQUEST          BV(0)
  74 #define FDEVENT_STREAM_REQUEST_BUFMIN   BV(1)
  75 #define FDEVENT_STREAM_REQUEST_POLLIN   BV(15)
  76
  77 #define FDEVENT_STREAM_RESPONSE         BV(0)
  78 #define FDEVENT_STREAM_RESPONSE_BUFMIN  BV(1)
  79
  80 typedef enum { FD_EVENT_TYPE_UNSET = -1,
  81                 FD_EVENT_TYPE_CONNECTION,
  82                 FD_EVENT_TYPE_FCGI_CONNECTION,
  83                 FD_EVENT_TYPE_DIRWATCH,
  84                 FD_EVENT_TYPE_CGI_CONNECTION
  85 } fd_event_t;
  86
  87 typedef enum { FDEVENT_HANDLER_UNSET,
  88                 FDEVENT_HANDLER_SELECT,
  89                 FDEVENT_HANDLER_POLL,
  90                 FDEVENT_HANDLER_LINUX_SYSEPOLL,
  91                 FDEVENT_HANDLER_SOLARIS_DEVPOLL,
  92                 FDEVENT_HANDLER_SOLARIS_PORT,
  93                 FDEVENT_HANDLER_FREEBSD_KQUEUE,
  94                 FDEVENT_HANDLER_LIBEV
  95 } fdevent_handler_t;
  96
  97
  98 typedef struct _fdnode {
  99         fdevent_handler handler;
 100         void *ctx;
 101         void *handler_ctx;
 102         int fd;
 103         int events;
 104 } fdnode;
 105
 106 /**
 107  * array of unused fd's
 108  *
 109  */
 110
 111 typedef struct {
 112         int *ptr;
 113
 114         size_t used;
 115         size_t size;
 116 } buffer_int;
 117
 118 /**
 119  * fd-event handler for select(), poll() and rt-signals on Linux 2.4
 120  *
 121  */
 122 typedef struct fdevents {
 123         struct server *srv;
 124         fdevent_handler_t type;
 125
 126         fdnode **fdarray;
 127         size_t maxfds;
 128         int highfd;
 129
 130 #ifdef USE_LINUX_EPOLL
 131         int epoll_fd;
 132         struct epoll_event *epoll_events;
 133 #endif
 134 #ifdef USE_POLL
 135         struct pollfd *pollfds;
 136
 137         size_t size;
 138         size_t used;
 139
 140         buffer_int unused;
 141 #endif
 142 #ifdef USE_SELECT
 143         fd_set select_read;
 144         fd_set select_write;
 145         fd_set select_error;
 146
 147         fd_set select_set_read;
 148         fd_set select_set_write;
 149         fd_set select_set_error;
 150
 151         int select_max_fd;
 152 #endif
 153 #ifdef USE_SOLARIS_DEVPOLL
 154         int devpoll_fd;
 155         struct pollfd *devpollfds;
 156 #endif
 157 #ifdef USE_SOLARIS_PORT
 158         port_event_t *port_events;
 159 #endif
 160 #ifdef USE_FREEBSD_KQUEUE
 161         int kq_fd;
 162         struct kevent *kq_results;
 163 #endif
 164 #ifdef USE_SOLARIS_PORT
 165         int port_fd;
 166 #endif
 167 #ifdef USE_LIBEV
 168         struct ev_loop *libev_loop;
 169 #endif
 170         int (*reset)(struct fdevents *ev);
 171         void (*free)(struct fdevents *ev);
 172
 173         int (*event_set)(struct fdevents *ev, int fde_ndx, int fd, int events);
 174         int (*event_del)(struct fdevents *ev, int fde_ndx, int fd);
 175         int (*event_get_revent)(struct fdevents *ev, size_t ndx);
 176         int (*event_get_fd)(struct fdevents *ev, size_t ndx);
 177
 178         int (*event_next_fdndx)(struct fdevents *ev, int ndx);
 179
 180         int (*poll)(struct fdevents *ev, int timeout_ms);
 181
 182         int (*fcntl_set)(struct fdevents *ev, int fd);
 183 } fdevents;
 184
 185 fdevents *fdevent_init(struct server *srv, size_t maxfds, fdevent_handler_t type);
 186 int fdevent_reset(fdevents *ev); /* "init" after fork() */
 187 void fdevent_free(fdevents *ev);
 188
 189 #define fdevent_event_get_interest(ev, fd) \
 190         ((fd) >= 0 ? (ev)->fdarray[(fd)]->events : 0)
 191 void fdevent_event_set(fdevents *ev, int *fde_ndx, int fd, int events); /* events can be FDEVENT_IN, FDEVENT_OUT or FDEVENT_IN | FDEVENT_OUT */
 192 void fdevent_event_add(fdevents *ev, int *fde_ndx, int fd, int event); /* events can be FDEVENT_IN or FDEVENT_OUT */
 193 void fdevent_event_clr(fdevents *ev, int *fde_ndx, int fd, int event); /* events can be FDEVENT_IN or FDEVENT_OUT */
 194 void fdevent_event_del(fdevents *ev, int *fde_ndx, int fd);
 195 int fdevent_event_get_revent(fdevents *ev, size_t ndx);
 196 int fdevent_event_get_fd(fdevents *ev, size_t ndx);
 197 fdevent_handler fdevent_get_handler(fdevents *ev, int fd);
 198 void * fdevent_get_context(fdevents *ev, int fd);
 199
 200 int fdevent_event_next_fdndx(fdevents *ev, int ndx);
 201
 202 int fdevent_poll(fdevents *ev, int timeout_ms);
 203
 204 int fdevent_register(fdevents *ev, int fd, fdevent_handler handler, void *ctx);
 205 int fdevent_unregister(fdevents *ev, int fd);
 206 void fdevent_sched_close(fdevents *ev, int fd, int issock);
 207 void fdevent_sched_run(struct server *srv, fdevents *ev);
 208
 209 void fd_close_on_exec(int fd);
 210 int fdevent_fcntl_set(fdevents *ev, int fd);
 211 int fdevent_fcntl_set_nb(fdevents *ev, int fd);
 212 int fdevent_fcntl_set_nb_cloexec(fdevents *ev, int fd);
 213 int fdevent_fcntl_set_nb_cloexec_sock(fdevents *ev, int fd);
 214 int fdevent_socket_cloexec(int domain, int type, int protocol);
 215 int fdevent_socket_nb_cloexec(int domain, int type, int protocol);
 216 int fdevent_open_cloexec(const char *pathname, int flags, mode_t mode);
 217
 218 int fdevent_select_init(fdevents *ev);
 219 int fdevent_poll_init(fdevents *ev);
 220 int fdevent_linux_sysepoll_init(fdevents *ev);
 221 int fdevent_solaris_devpoll_init(fdevents *ev);
 222 int fdevent_solaris_port_init(fdevents *ev);
 223 int fdevent_freebsd_kqueue_init(fdevents *ev);
 224 int fdevent_libev_init(fdevents *ev);
 225
 226 /* fd must be TCP socket (AF_INET, AF_INET6), end-of-stream recv() 0 bytes */
 227 int fdevent_is_tcp_half_closed(int fd);
 228
 229 #endif