contrib/bind/lib/bind/isc/eventlib_p.h

   1 /*
   2  * Copyright (c) 2005 by Internet Systems Consortium, Inc. ("ISC")
   3  * Copyright (c) 1995-1999 by Internet Software Consortium
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
  15  * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17
  18 /*! \file
  19  * \brief private interfaces for eventlib
  20  * \author vix 09sep95 [initial]
  21  *
  22  * $Id: eventlib_p.h,v 1.9 2006/03/09 23:57:56 marka Exp $
  23  */
  24
  25 #ifndef _EVENTLIB_P_H
  26 #define _EVENTLIB_P_H
  27
  28 #include <sys/param.h>
  29 #include <sys/types.h>
  30 #include <sys/socket.h>
  31 #include <netinet/in.h>
  32 #include <sys/un.h>
  33
  34 #define EVENTLIB_DEBUG 1
  35
  36 #include <errno.h>
  37 #include <fcntl.h>
  38 #include <stdio.h>
  39 #include <stdlib.h>
  40 #include <string.h>
  41
  42 #ifndef _LIBC
  43 #include <isc/heap.h>
  44 #include <isc/list.h>
  45 #include <isc/memcluster.h>
  46 #endif
  47
  48 #define EV_MASK_ALL     (EV_READ | EV_WRITE | EV_EXCEPT)
  49 #define EV_ERR(e)               return (errno = (e), -1)
  50 #define OK(x)           if ((x) < 0) EV_ERR(errno); else (void)NULL
  51 #define OKFREE(x, y)    if ((x) < 0) { FREE((y)); EV_ERR(errno); } \
  52                         else (void)NULL
  53
  54 #define NEW(p)          if (((p) = memget(sizeof *(p))) != NULL) \
  55                                 FILL(p); \
  56                         else \
  57                                 (void)NULL;
  58 #define OKNEW(p)        if (!((p) = memget(sizeof *(p)))) { \
  59                                 errno = ENOMEM; \
  60                                 return (-1); \
  61                         } else \
  62                                 FILL(p)
  63 #define FREE(p)         memput((p), sizeof *(p))
  64
  65 #if EVENTLIB_DEBUG
  66 #define FILL(p)         memset((p), 0xF5, sizeof *(p))
  67 #else
  68 #define FILL(p)
  69 #endif
  70
  71 #ifdef USE_POLL
  72 #ifdef HAVE_STROPTS_H
  73 #include <stropts.h>
  74 #endif
  75 #include <poll.h>
  76 #endif /* USE_POLL */
  77
  78 typedef struct evConn {
  79         evConnFunc      func;
  80         void *          uap;
  81         int             fd;
  82         int             flags;
  83 #define EV_CONN_LISTEN          0x0001          /*%< Connection is a listener. */
  84 #define EV_CONN_SELECTED        0x0002          /*%< evSelectFD(conn->file). */
  85 #define EV_CONN_BLOCK           0x0004          /*%< Listener fd was blocking. */
  86         evFileID        file;
  87         struct evConn * prev;
  88         struct evConn * next;
  89 } evConn;
  90
  91 #ifndef _LIBC
  92 typedef struct evAccept {
  93         int             fd;
  94         union {
  95                 struct sockaddr         sa;
  96                 struct sockaddr_in      in;
  97 #ifndef NO_SOCKADDR_UN
  98                 struct sockaddr_un      un;
  99 #endif
 100         }               la;
 101         ISC_SOCKLEN_T   lalen;
 102         union {
 103                 struct sockaddr         sa;
 104                 struct sockaddr_in      in;
 105 #ifndef NO_SOCKADDR_UN
 106                 struct sockaddr_un      un;
 107 #endif
 108         }               ra;
 109         ISC_SOCKLEN_T   ralen;
 110         int             ioErrno;
 111         evConn *        conn;
 112         LINK(struct evAccept) link;
 113 } evAccept;
 114
 115 typedef struct evFile {
 116         evFileFunc      func;
 117         void *          uap;
 118         int             fd;
 119         int             eventmask;
 120         int             preemptive;
 121         struct evFile * prev;
 122         struct evFile * next;
 123         struct evFile * fdprev;
 124         struct evFile * fdnext;
 125 } evFile;
 126
 127 typedef struct evStream {
 128         evStreamFunc    func;
 129         void *          uap;
 130         evFileID        file;
 131         evTimerID       timer;
 132         int             flags;
 133 #define EV_STR_TIMEROK  0x0001  /*%< IFF timer valid. */
 134         int             fd;
 135         struct iovec *  iovOrig;
 136         int             iovOrigCount;
 137         struct iovec *  iovCur;
 138         int             iovCurCount;
 139         int             ioTotal;
 140         int             ioDone;
 141         int             ioErrno;
 142         struct evStream *prevDone, *nextDone;
 143         struct evStream *prev, *next;
 144 } evStream;
 145
 146 typedef struct evTimer {
 147         evTimerFunc     func;
 148         void *          uap;
 149         struct timespec due, inter;
 150         int             index;
 151         int             mode;
 152 #define EV_TMR_RATE     1
 153 } evTimer;
 154
 155 typedef struct evWait {
 156         evWaitFunc      func;
 157         void *          uap;
 158         const void *    tag;
 159         struct evWait * next;
 160 } evWait;
 161
 162 typedef struct evWaitList {
 163         evWait *                first;
 164         evWait *                last;
 165         struct evWaitList *     prev;
 166         struct evWaitList *     next;
 167 } evWaitList;
 168
 169 typedef struct evEvent_p {
 170         enum {  Accept, File, Stream, Timer, Wait, Free, Null  } type;
 171         union {
 172                 struct {  evAccept *this;  }                    accept;
 173                 struct {  evFile *this; int eventmask;  }       file;
 174                 struct {  evStream *this;  }                    stream;
 175                 struct {  evTimer *this;  }                     timer;
 176                 struct {  evWait *this;  }                      wait;
 177                 struct {  struct evEvent_p *next;  }            free;
 178                 struct {  const void *placeholder;  }           null;
 179         } u;
 180 } evEvent_p;
 181 #endif /* !_LIBC */
 182
 183 #ifdef USE_POLL
 184 typedef struct {
 185         void            *ctx;   /* pointer to the evContext_p   */
 186         uint32_t        type;   /* READ, WRITE, EXCEPT, nonblk  */
 187         uint32_t        result; /* 1 => revents, 0 => events    */
 188 } __evEmulMask;
 189
 190 #define emulMaskInit(ctx, field, ev, lastnext) \
 191         ctx->field.ctx = ctx; \
 192         ctx->field.type = ev; \
 193         ctx->field.result = lastnext;
 194
 195 extern short    *__fd_eventfield(int fd, __evEmulMask *maskp);
 196 extern short    __poll_event(__evEmulMask *maskp);
 197 extern void             __fd_clr(int fd, __evEmulMask *maskp);
 198 extern void             __fd_set(int fd, __evEmulMask *maskp);
 199
 200 #undef  FD_ZERO
 201 #define FD_ZERO(maskp)
 202
 203 #undef  FD_SET
 204 #define FD_SET(fd, maskp) \
 205         __fd_set(fd, maskp)
 206
 207 #undef  FD_CLR
 208 #define FD_CLR(fd, maskp) \
 209         __fd_clr(fd, maskp)
 210
 211 #undef  FD_ISSET
 212 #define FD_ISSET(fd, maskp) \
 213         ((*__fd_eventfield(fd, maskp) & __poll_event(maskp)) != 0)
 214
 215 #endif /* USE_POLL */
 216
 217 #ifndef _LIBC
 218 typedef struct {
 219         /* Global. */
 220         const evEvent_p *cur;
 221         /* Debugging. */
 222         int             debug;
 223         FILE            *output;
 224         /* Connections. */
 225         evConn          *conns;
 226         LIST(evAccept)  accepts;
 227         /* Files. */
 228         evFile          *files, *fdNext;
 229 #ifndef USE_POLL
 230         fd_set          rdLast, rdNext;
 231         fd_set          wrLast, wrNext;
 232         fd_set          exLast, exNext;
 233         fd_set          nonblockBefore;
 234         int             fdMax, fdCount, highestFD;
 235         evFile          *fdTable[FD_SETSIZE];
 236 #else
 237         struct pollfd   *pollfds;       /* Allocated as needed  */
 238         evFile          **fdTable;      /* Ditto                */
 239         int             maxnfds;        /* # elements in above  */
 240         int             firstfd;        /* First active fd      */
 241         int             fdMax;          /* Last active fd       */
 242         int             fdCount;        /* # fd:s with I/O      */
 243         int             highestFD;      /* max fd allowed by OS */
 244         __evEmulMask    rdLast, rdNext;
 245         __evEmulMask    wrLast, wrNext;
 246         __evEmulMask    exLast, exNext;
 247         __evEmulMask    nonblockBefore;
 248 #endif /* USE_POLL */
 249 #ifdef EVENTLIB_TIME_CHECKS
 250         struct timespec lastSelectTime;
 251         int             lastFdCount;
 252 #endif
 253         /* Streams. */
 254         evStream        *streams;
 255         evStream        *strDone, *strLast;
 256         /* Timers. */
 257         struct timespec lastEventTime;
 258         heap_context    timers;
 259         /* Waits. */
 260         evWaitList      *waitLists;
 261         evWaitList      waitDone;
 262 } evContext_p;
 263
 264 /* eventlib.c */
 265 #define evPrintf __evPrintf
 266 void evPrintf(const evContext_p *ctx, int level, const char *fmt, ...)
 267      ISC_FORMAT_PRINTF(3, 4);
 268
 269 #ifdef USE_POLL
 270 extern int evPollfdRealloc(evContext_p *ctx, int pollfd_chunk_size, int fd);
 271 #endif /* USE_POLL */
 272
 273 /* ev_timers.c */
 274 #define evCreateTimers __evCreateTimers
 275 heap_context evCreateTimers(const evContext_p *);
 276 #define evDestroyTimers __evDestroyTimers
 277 void evDestroyTimers(const evContext_p *);
 278
 279 /* ev_waits.c */
 280 #define evFreeWait __evFreeWait
 281 evWait *evFreeWait(evContext_p *ctx, evWait *old);
 282 #endif /* !_LIBC */
 283
 284 /* Global options */
 285 #ifndef _LIBC
 286 extern int      __evOptMonoTime;
 287 #endif /* !_LIBC */
 288
 289 #endif /*_EVENTLIB_P_H*/