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