ev.h

   1 /*
   2  * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  *       notice, this list of conditions and the following disclaimer.
  11  *
  12  *     * Redistributions in binary form must reproduce the above
  13  *       copyright notice, this list of conditions and the following
  14  *       disclaimer in the documentation and/or other materials provided
  15  *       with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef EV_H__
  31 #define EV_H__
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 typedef double ev_tstamp;
  38
  39 /* these priorities are inclusive, higher priorities will be called earlier */
  40 #ifndef EV_MINPRI
  41 # define EV_MINPRI -2
  42 #endif
  43 #ifndef EV_MAXPRI
  44 # define EV_MAXPRI +2
  45 #endif
  46
  47 #ifndef EV_MULTIPLICITY
  48 # define EV_MULTIPLICITY 1
  49 #endif
  50
  51 #ifndef EV_PERIODICS
  52 # define EV_PERIODICS 1
  53 #endif
  54
  55 /* support multiple event loops? */
  56 #if EV_MULTIPLICITY
  57 struct ev_loop;
  58 # define EV_P struct ev_loop *loop
  59 # define EV_P_ EV_P,
  60 # define EV_A loop
  61 # define EV_A_ EV_A,
  62 # define EV_DEFAULT_A ev_default_loop (0)
  63 # define EV_DEFAULT_A_ EV_DEFAULT_A,
  64 #else
  65 # define EV_P void
  66 # define EV_P_
  67 # define EV_A
  68 # define EV_A_
  69 # define EV_DEFAULT_A
  70 # define EV_DEFAULT_A_
  71 #endif
  72
  73 /* eventmask, revents, events... */
  74 #define EV_UNDEF          -1L /* guaranteed to be invalid */
  75 #define EV_NONE         0x00L
  76 #define EV_READ         0x01L /* io only */
  77 #define EV_WRITE        0x02L /* io only */
  78 #define EV_TIMEOUT  0x000100L /* timer only */
  79 #define EV_PERIODIC 0x000200L /* periodic timer only */
  80 #define EV_SIGNAL   0x000400L /* signal only */
  81 #define EV_IDLE     0x000800L /* idle only */
  82 #define EV_CHECK    0x001000L /* check only */
  83 #define EV_PREPARE  0x002000L /* prepare only */
  84 #define EV_CHILD    0x004000L /* child/pid only */
  85 #define EV_EMBED    0x008000L /* embedded event loop */
  86 #define EV_ERROR    0x800000L /* sent when an error occurs */
  87
  88 /* can be used to add custom fields to all watchers, while losing binary compatibility */
  89 #ifndef EV_COMMON
  90 # define EV_COMMON void *data;
  91 #endif
  92 #ifndef EV_PROTOTYPES
  93 # define EV_PROTOTYPES 1
  94 #endif
  95
  96 #define EV_VERSION_MAJOR 1
  97 #define EV_VERSION_MINOR 1
  98
  99 #ifndef EV_CB_DECLARE
 100 # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
 101 #endif
 102 #ifndef EV_CB_INVOKE
 103 # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
 104 #endif
 105
 106 /*
 107  * struct member types:
 108  * private: you can look at them, but not change them, and they might not mean anything to you.
 109  * ro: can be read anytime, but only changed when the watcher isn't active
 110  * rw: can be read and modified anytime, even when the watcher is active
 111  */
 112
 113 /* shared by all watchers */
 114 #define EV_WATCHER(type)                        \
 115   int active; /* private */                     \
 116   int pending; /* private */                    \
 117   int priority; /* private */                   \
 118   EV_COMMON /* rw */                            \
 119   EV_CB_DECLARE (type) /* private */
 120
 121 #define EV_WATCHER_LIST(type)                   \
 122   EV_WATCHER (type)                             \
 123   struct ev_watcher_list *next; /* private */
 124
 125 #define EV_WATCHER_TIME(type)                   \
 126   EV_WATCHER (type)                             \
 127   ev_tstamp at;     /* private */
 128
 129 /* base class, nothing to see here unless you subclass */
 130 typedef struct ev_watcher
 131 {
 132   EV_WATCHER (ev_watcher)
 133 } ev_watcher;
 134
 135 /* base class, nothing to see here unless you subclass */
 136 typedef struct ev_watcher_list
 137 {
 138   EV_WATCHER_LIST (ev_watcher_list)
 139 } ev_watcher_list;
 140
 141 /* base class, nothing to see here unless you subclass */
 142 typedef struct ev_watcher_time
 143 {
 144   EV_WATCHER_TIME (ev_watcher_time)
 145 } ev_watcher_time;
 146
 147 /* invoked after a specific time, repeatable (based on monotonic clock) */
 148 /* revent EV_TIMEOUT */
 149 typedef struct ev_timer
 150 {
 151   EV_WATCHER_TIME (ev_timer)
 152
 153   ev_tstamp repeat; /* rw */
 154 } ev_timer;
 155
 156 /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
 157 /* revent EV_PERIODIC */
 158 typedef struct ev_periodic
 159 {
 160   EV_WATCHER_TIME (ev_periodic)
 161
 162   ev_tstamp interval; /* rw */
 163   ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
 164 } ev_periodic;
 165
 166 /* invoked when fd is either EV_READable or EV_WRITEable */
 167 /* revent EV_READ, EV_WRITE */
 168 typedef struct ev_io
 169 {
 170   EV_WATCHER_LIST (ev_io)
 171
 172   int fd;     /* ro */
 173   int events; /* ro */
 174 } ev_io;
 175
 176 /* invoked when the given signal has been received */
 177 /* revent EV_SIGNAL */
 178 typedef struct ev_signal
 179 {
 180   EV_WATCHER_LIST (ev_signal)
 181
 182   int signum; /* ro */
 183 } ev_signal;
 184
 185 /* invoked when the nothing else needs to be done, keeps the process from blocking */
 186 /* revent EV_IDLE */
 187 typedef struct ev_idle
 188 {
 189   EV_WATCHER (ev_idle)
 190 } ev_idle;
 191
 192 /* invoked for each run of the mainloop, just before the blocking call */
 193 /* you can still change events in any way you like */
 194 /* revent EV_PREPARE */
 195 typedef struct ev_prepare
 196 {
 197   EV_WATCHER (ev_prepare)
 198 } ev_prepare;
 199
 200 /* invoked for each run of the mainloop, just after the blocking call */
 201 /* revent EV_CHECK */
 202 typedef struct ev_check
 203 {
 204   EV_WATCHER (ev_check)
 205 } ev_check;
 206
 207 /* invoked when sigchld is received and waitpid indicates the given pid */
 208 /* revent EV_CHILD */
 209 /* does not support priorities */
 210 typedef struct ev_child
 211 {
 212   EV_WATCHER_LIST (ev_child)
 213
 214   int pid;     /* ro */
 215   int rpid;    /* rw, holds the received pid */
 216   int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
 217 } ev_child;
 218
 219 #if EV_MULTIPLICITY
 220 /* used to embed an event loop inside another */
 221 /* the callback gets invoked when the event loop has handled events, and can be 0 */
 222 typedef struct ev_embed
 223 {
 224   EV_WATCHER (ev_embed)
 225
 226   ev_io io; /* private */
 227   struct ev_loop *loop; /* ro */
 228 } ev_embed;
 229 #endif
 230
 231 /* the presence of this union forces similar struct layout */
 232 union ev_any_watcher
 233 {
 234   struct ev_watcher w;
 235   struct ev_watcher_list wl;
 236
 237   struct ev_io io;
 238   struct ev_timer timer;
 239   struct ev_periodic periodic;
 240   struct ev_idle idle;
 241   struct ev_prepare prepare;
 242   struct ev_check check;
 243   struct ev_signal signal;
 244   struct ev_child child;
 245 #if EV_MULTIPLICITY
 246   struct ev_embed embed;
 247 #endif
 248 };
 249
 250 /* bits for ev_default_loop and ev_loop_new */
 251 /* the default */
 252 #define EVFLAG_AUTO       0x00000000UL /* not quite a mask */
 253 /* flag bits */
 254 #define EVFLAG_NOENV      0x01000000UL /* do NOT consult environment */
 255 /* method bits to be ored together */
 256 #define EVBACKEND_SELECT  0x00000001UL /* about anywhere */
 257 #define EVBACKEND_POLL    0x00000002UL /* !win */
 258 #define EVBACKEND_EPOLL   0x00000004UL /* linux */
 259 #define EVBACKEND_KQUEUE  0x00000008UL /* bsd */
 260 #define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */
 261 #define EVBACKEND_PORT    0x00000020UL /* solaris 10 */
 262
 263 #if EV_PROTOTYPES
 264 int ev_version_major (void);
 265 int ev_version_minor (void);
 266
 267 unsigned int ev_supported_backends (void);
 268 unsigned int ev_recommended_backends (void);
 269 unsigned int ev_embeddable_backends (void);
 270
 271 ev_tstamp ev_time (void);
 272
 273 /* Sets the allocation function to use, works like realloc.
 274  * It is used to allocate and free memory.
 275  * If it returns zero when memory needs to be allocated, the library might abort
 276  * or take some potentially destructive action.
 277  * The default is your system realloc function.
 278  */
 279 void ev_set_allocator (void *(*cb)(void *ptr, long size));
 280
 281 /* set the callback function to call on a
 282  * retryable syscall error
 283  * (such as failed select, poll, epoll_wait)
 284  */
 285 void ev_set_syserr_cb (void (*cb)(const char *msg));
 286
 287 # if EV_MULTIPLICITY
 288 /* the default loop is the only one that handles signals and child watchers */
 289 /* you can call this as often as you like */
 290 static struct ev_loop *
 291 ev_default_loop (unsigned int flags)
 292 {
 293   extern struct ev_loop *ev_default_loop_ptr;
 294   extern struct ev_loop *ev_default_loop_init (unsigned int flags);
 295
 296   if (!ev_default_loop_ptr)
 297     ev_default_loop_init (flags);
 298
 299   return ev_default_loop_ptr;
 300 }
 301
 302 /* create and destroy alternative loops that don't handle signals */
 303 struct ev_loop *ev_loop_new (unsigned int flags);
 304 void ev_loop_destroy (EV_P);
 305 void ev_loop_fork (EV_P);
 306
 307 ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
 308
 309 # else
 310
 311 int ev_default_loop (unsigned int flags); /* returns true when successful */
 312
 313 static ev_tstamp
 314 ev_now (void)
 315 {
 316   extern ev_tstamp ev_rt_now;
 317
 318   return ev_rt_now;
 319 }
 320 # endif
 321
 322 void ev_default_destroy (void); /* destroy the default loop */
 323 /* this needs to be called after fork, to duplicate the default loop */
 324 /* if you create alternative loops you have to call ev_loop_fork on them */
 325 /* you can call it in either the parent or the child */
 326 /* you can actually call it at any time, anywhere :) */
 327 void ev_default_fork (void);
 328
 329 unsigned int ev_backend (EV_P);
 330 #endif
 331
 332 #define EVLOOP_NONBLOCK 1 /* do not block/wait */
 333 #define EVLOOP_ONESHOT  2 /* block *once* only */
 334 #define EVUNLOOP_CANCEL 0 /* undo unloop */
 335 #define EVUNLOOP_ONE    1 /* unloop once */
 336 #define EVUNLOOP_ALL    2 /* unloop all loops */
 337
 338 #if EV_PROTOTYPES
 339 void ev_loop (EV_P_ int flags);
 340 void ev_unloop (EV_P_ int how); /* set to 1 to break out of event loop, set to 2 to break out of all event loops */
 341
 342 /*
 343  * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
 344  * keeps one reference. if you have a long-runing watcher you never unregister that
 345  * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
 346  */
 347 void ev_ref   (EV_P);
 348 void ev_unref (EV_P);
 349
 350 /* convinience function, wait for a single event, without registering an event watcher */
 351 /* if timeout is < 0, do wait indefinitely */
 352 void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
 353 #endif
 354
 355 /* these may evaluate ev multiple times, and the other arguments at most once */
 356 /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
 357 #define ev_init(ev,cb_) do {                            \
 358   ((ev_watcher *)(void *)(ev))->active   =      \
 359   ((ev_watcher *)(void *)(ev))->pending  =      \
 360   ((ev_watcher *)(void *)(ev))->priority = 0;   \
 361   ev_set_cb ((ev), cb_);                                        \
 362 } while (0)
 363
 364 #define ev_io_set(ev,fd_,events_)           do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
 365 #define ev_timer_set(ev,after_,repeat_)     do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
 366 #define ev_periodic_set(ev,at_,ival_,res_)  do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
 367 #define ev_signal_set(ev,signum_)           do { (ev)->signum = (signum_); } while (0)
 368 #define ev_idle_set(ev)                     /* nop, yes, this is a serious in-joke */
 369 #define ev_prepare_set(ev)                  /* nop, yes, this is a serious in-joke */
 370 #define ev_check_set(ev)                    /* nop, yes, this is a serious in-joke */
 371 #define ev_child_set(ev,pid_)               do { (ev)->pid = (pid_); } while (0)
 372 #define ev_embed_set(ev,loop_)              do { (ev)->loop = (loop_); } while (0)
 373
 374 #define ev_io_init(ev,cb,fd,events)         do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
 375 #define ev_timer_init(ev,cb,after,repeat)   do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
 376 #define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
 377 #define ev_signal_init(ev,cb,signum)        do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
 378 #define ev_idle_init(ev,cb)                 do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
 379 #define ev_prepare_init(ev,cb)              do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
 380 #define ev_check_init(ev,cb)                do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
 381 #define ev_child_init(ev,cb,pid)            do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
 382 #define ev_embed_init(ev,cb,loop)           do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0)
 383
 384 #define ev_is_pending(ev)                   (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
 385 #define ev_is_active(ev)                    (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
 386
 387 #define ev_priority(ev)                     ((ev_watcher *)(void *)(ev))->priority /* rw */
 388 #define ev_cb(ev)                           (ev)->cb /* rw */
 389 #define ev_set_priority(ev,pri)             ev_priority (ev) = (pri)
 390
 391 #ifndef ev_set_cb
 392 # define ev_set_cb(ev,cb_)                  ev_cb (ev) = (cb_)
 393 #endif
 394
 395 /* stopping (enabling, adding) a watcher does nothing if it is already running */
 396 /* stopping (disabling, deleting) a watcher does nothing unless its already running */
 397 #if EV_PROTOTYPES
 398
 399 /* feeds an event into a watcher as if the event actually occured */
 400 /* accepts any ev_watcher type */
 401 void ev_feed_event     (EV_P_ void *w, int revents);
 402 void ev_feed_fd_event  (EV_P_ int fd, int revents);
 403 void ev_feed_signal_event (EV_P_ int signum);
 404
 405 void ev_io_start       (EV_P_ ev_io *w);
 406 void ev_io_stop        (EV_P_ ev_io *w);
 407
 408 void ev_timer_start    (EV_P_ ev_timer *w);
 409 void ev_timer_stop     (EV_P_ ev_timer *w);
 410 /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
 411 void ev_timer_again    (EV_P_ ev_timer *w);
 412
 413 #if EV_PERIODICS
 414 void ev_periodic_start (EV_P_ ev_periodic *w);
 415 void ev_periodic_stop  (EV_P_ ev_periodic *w);
 416 void ev_periodic_again (EV_P_ ev_periodic *w);
 417 #endif
 418
 419 void ev_idle_start     (EV_P_ ev_idle *w);
 420 void ev_idle_stop      (EV_P_ ev_idle *w);
 421
 422 void ev_prepare_start  (EV_P_ ev_prepare *w);
 423 void ev_prepare_stop   (EV_P_ ev_prepare *w);
 424
 425 void ev_check_start    (EV_P_ ev_check *w);
 426 void ev_check_stop     (EV_P_ ev_check *w);
 427
 428 /* only supported in the default loop */
 429 void ev_signal_start   (EV_P_ ev_signal *w);
 430 void ev_signal_stop    (EV_P_ ev_signal *w);
 431
 432 /* only supported in the default loop */
 433 void ev_child_start    (EV_P_ ev_child *w);
 434 void ev_child_stop     (EV_P_ ev_child *w);
 435
 436 # if EV_MULTIPLICITY
 437 /* only supported when loop to be embedded is in fact embeddable */
 438 void ev_embed_start    (EV_P_ ev_embed *w);
 439 void ev_embed_stop     (EV_P_ ev_embed *w);
 440 void ev_embed_sweep    (EV_P_ ev_embed *w);
 441 # endif
 442
 443 #endif
 444
 445 #ifdef __cplusplus
 446 }
 447 #endif
 448
 449 #endif
 450