src/openvpn/event.h

   1 /*
   2  *  OpenVPN -- An application to securely tunnel IP networks
   3  *             over a single TCP/UDP port, with support for SSL/TLS-based
   4  *             session authentication and key exchange,
   5  *             packet encryption, packet authentication, and
   6  *             packet compression.
   7  *
   8  *  Copyright (C) 2002-2005 OpenVPN Solutions LLC <info@openvpn.net>
   9  *
  10  *  This program is free software; you can redistribute it and/or modify
  11  *  it under the terms of the GNU General Public License version 2
  12  *  as published by the Free Software Foundation.
  13  *
  14  *  This program is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *  GNU General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License
  20  *  along with this program (see the file COPYING included with this
  21  *  distribution); if not, write to the Free Software Foundation, Inc.,
  22  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  */
  24
  25 #ifndef EVENT_H
  26 #define EVENT_H
  27
  28 #include "win32.h"
  29 #include "sig.h"
  30 #include "perf.h"
  31
  32 /*
  33  * rwflags passed to event_ctl and returned by
  34  * struct event_set_return.
  35  */
  36 #define EVENT_READ     (1<<0)
  37 #define EVENT_WRITE    (1<<1)
  38
  39 /*
  40  * Initialization flags passed to event_set_init
  41  */
  42 #define EVENT_METHOD_US_TIMEOUT   (1<<0)
  43 #define EVENT_METHOD_FAST         (1<<1)
  44
  45 #ifdef WIN32
  46
  47 typedef const struct rw_handle *event_t;
  48
  49 #define UNDEFINED_EVENT (NULL)
  50
  51 #else
  52
  53 typedef int event_t;
  54
  55 #define UNDEFINED_EVENT (-1)
  56
  57 #endif
  58
  59 struct event_set;
  60 struct event_set_return;
  61
  62 struct event_set_functions
  63 {
  64   void (*free)(struct event_set *es);
  65   void (*reset)(struct event_set *es);
  66   void (*del)(struct event_set *es, event_t event);
  67   void (*ctl)(struct event_set *es, event_t event, unsigned int rwflags, void *arg);
  68
  69   /*
  70    * Return status for wait:
  71    * -1 on signal or error
  72    * 0 on timeout
  73    * length of event_set_return if at least 1 event is returned
  74    */
  75   int  (*wait)(struct event_set *es, const struct timeval *tv, struct event_set_return *out, int outlen);
  76 };
  77
  78 struct event_set_return
  79 {
  80   unsigned int rwflags;
  81   void *arg;
  82 };
  83
  84 struct event_set
  85 {
  86   struct event_set_functions func;
  87 };
  88
  89 /*
  90  * maxevents on input:  desired max number of event_t descriptors
  91  *                      simultaneously set with event_ctl
  92  * maxevents on output: may be modified down, depending on limitations
  93  *                      of underlying API
  94  * flags:               EVENT_METHOD_x flags
  95  */
  96 struct event_set *event_set_init (int *maxevents, unsigned int flags);
  97
  98 static inline void
  99 event_free (struct event_set *es)
 100 {
 101   (*es->func.free)(es);
 102 }
 103
 104 static inline void
 105 event_reset (struct event_set *es)
 106 {
 107   (*es->func.reset)(es);
 108 }
 109
 110 static inline void
 111 event_del (struct event_set *es, event_t event)
 112 {
 113   (*es->func.del)(es, event);
 114 }
 115
 116 static inline void
 117 event_ctl (struct event_set *es, event_t event, unsigned int rwflags, void *arg)
 118 {
 119   (*es->func.ctl)(es, event, rwflags, arg);
 120 }
 121
 122 static inline int
 123 event_wait (struct event_set *es, const struct timeval *tv, struct event_set_return *out, int outlen)
 124 {
 125   int ret;
 126   perf_push (PERF_IO_WAIT);
 127   ret = (*es->func.wait)(es, tv, out, outlen);
 128   perf_pop ();
 129   return ret;
 130 }
 131
 132 static inline void
 133 event_set_return_init (struct event_set_return *esr)
 134 {
 135   esr->rwflags = 0;
 136   esr->arg = NULL;
 137 }
 138
 139 #ifdef WIN32
 140
 141 static inline void
 142 wait_signal (struct event_set *es, void *arg)
 143 {
 144   if (HANDLE_DEFINED (win32_signal.in.read))
 145     event_ctl (es, &win32_signal.in, EVENT_READ, arg);
 146 }
 147
 148 #else
 149
 150 static inline void
 151 wait_signal (struct event_set *es, void *arg)
 152 {
 153 }
 154
 155 #endif
 156
 157 #endif