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_PERIODIC_ENABLE
  52 # define EV_PERIODIC_ENABLE 1
  53 #endif
  54
  55 #ifndef EV_STAT_ENABLE
  56 # define EV_STAT_ENABLE 1
  57 #endif
  58
  59 #ifndef EV_EMBED_ENABLE
  60 # define EV_EMBED_ENABLE 1
  61 #endif
  62
  63 /*****************************************************************************/
  64
  65 #if EV_STAT_ENABLE
  66 # include <sys/stat.h>
  67 #endif
  68
  69 /* support multiple event loops? */
  70 #if EV_MULTIPLICITY
  71 struct ev_loop;
  72 # define EV_P struct ev_loop *loop
  73 # define EV_P_ EV_P,
  74 # define EV_A loop
  75 # define EV_A_ EV_A,
  76 # define EV_DEFAULT_A ev_default_loop (0)
  77 # define EV_DEFAULT_A_ EV_DEFAULT_A,
  78 #else
  79 # define EV_P void
  80 # define EV_P_
  81 # define EV_A
  82 # define EV_A_
  83 # define EV_DEFAULT_A
  84 # define EV_DEFAULT_A_
  85
  86 # undef EV_EMBED_ENABLE
  87 #endif
  88
  89 /* eventmask, revents, events... */
  90 #define EV_UNDEF            -1L /* guaranteed to be invalid */
  91 #define EV_NONE           0x00L /* no events */
  92 #define EV_READ           0x01L /* ev_io detected read will not block */
  93 #define EV_WRITE          0x02L /* ev_io detected write will not block */
  94 #define EV_TIMEOUT  0x00000100L /* timer timed out */
  95 #define EV_PERIODIC 0x00000200L /* periodic timer timed out */
  96 #define EV_SIGNAL   0x00000400L /* signal was received */
  97 #define EV_IDLE     0x00000800L /* event loop is idling */
  98 #define EV_PREPARE  0x00001000L /* event loop about to poll */
  99 #define EV_CHECK    0x00002000L /* event loop finished poll */
 100 #define EV_CHILD    0x00004000L /* child/pid had status change */
 101 #define EV_EMBED    0x00008000L /* embedded event loop needs sweep */
 102 #define EV_STAT     0x00010000L /* stat data changed */
 103 #define EV_ERROR    0x80000000L /* sent when an error occurs */
 104
 105 /* can be used to add custom fields to all watchers, while losing binary compatibility */
 106 #ifndef EV_COMMON
 107 # define EV_COMMON void *data;
 108 #endif
 109 #ifndef EV_PROTOTYPES
 110 # define EV_PROTOTYPES 1
 111 #endif
 112
 113 #define EV_VERSION_MAJOR 1
 114 #define EV_VERSION_MINOR 1
 115
 116 #ifndef EV_CB_DECLARE
 117 # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
 118 #endif
 119 #ifndef EV_CB_INVOKE
 120 # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
 121 #endif
 122
 123 /*
 124  * struct member types:
 125  * private: you can look at them, but not change them, and they might not mean anything to you.
 126  * ro: can be read anytime, but only changed when the watcher isn't active
 127  * rw: can be read and modified anytime, even when the watcher is active
 128  */
 129
 130 /* shared by all watchers */
 131 #define EV_WATCHER(type)                        \
 132   int active; /* private */                     \
 133   int pending; /* private */                    \
 134   int priority; /* private */                   \
 135   EV_COMMON /* rw */                            \
 136   EV_CB_DECLARE (type) /* private */
 137
 138 #define EV_WATCHER_LIST(type)                   \
 139   EV_WATCHER (type)                             \
 140   struct ev_watcher_list *next; /* private */
 141
 142 #define EV_WATCHER_TIME(type)                   \
 143   EV_WATCHER (type)                             \
 144   ev_tstamp at;     /* private */
 145
 146 /* base class, nothing to see here unless you subclass */
 147 typedef struct ev_watcher
 148 {
 149   EV_WATCHER (ev_watcher)
 150 } ev_watcher;
 151
 152 /* base class, nothing to see here unless you subclass */
 153 typedef struct ev_watcher_list
 154 {
 155   EV_WATCHER_LIST (ev_watcher_list)
 156 } ev_watcher_list;
 157
 158 /* base class, nothing to see here unless you subclass */
 159 typedef struct ev_watcher_time
 160 {
 161   EV_WATCHER_TIME (ev_watcher_time)
 162 } ev_watcher_time;
 163
 164 /* invoked after a specific time, repeatable (based on monotonic clock) */
 165 /* revent EV_TIMEOUT */
 166 typedef struct ev_timer
 167 {
 168   EV_WATCHER_TIME (ev_timer)
 169
 170   ev_tstamp repeat; /* rw */
 171 } ev_timer;
 172
 173 /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
 174 /* revent EV_PERIODIC */
 175 typedef struct ev_periodic
 176 {
 177   EV_WATCHER_TIME (ev_periodic)
 178
 179   ev_tstamp interval; /* rw */
 180   ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
 181 } ev_periodic;
 182
 183 /* invoked when fd is either EV_READable or EV_WRITEable */
 184 /* revent EV_READ, EV_WRITE */
 185 typedef struct ev_io
 186 {
 187   EV_WATCHER_LIST (ev_io)
 188
 189   int fd;     /* ro */
 190   int events; /* ro */
 191 } ev_io;
 192
 193 /* invoked when the given signal has been received */
 194 /* revent EV_SIGNAL */
 195 typedef struct ev_signal
 196 {
 197   EV_WATCHER_LIST (ev_signal)
 198
 199   int signum; /* ro */
 200 } ev_signal;
 201
 202 /* invoked when the nothing else needs to be done, keeps the process from blocking */
 203 /* revent EV_IDLE */
 204 typedef struct ev_idle
 205 {
 206   EV_WATCHER (ev_idle)
 207 } ev_idle;
 208
 209 /* invoked for each run of the mainloop, just before the blocking call */
 210 /* you can still change events in any way you like */
 211 /* revent EV_PREPARE */
 212 typedef struct ev_prepare
 213 {
 214   EV_WATCHER (ev_prepare)
 215 } ev_prepare;
 216
 217 /* invoked for each run of the mainloop, just after the blocking call */
 218 /* revent EV_CHECK */
 219 typedef struct ev_check
 220 {
 221   EV_WATCHER (ev_check)
 222 } ev_check;
 223
 224 /* invoked when sigchld is received and waitpid indicates the given pid */
 225 /* revent EV_CHILD */
 226 /* does not support priorities */
 227 typedef struct ev_child
 228 {
 229   EV_WATCHER_LIST (ev_child)
 230
 231   int pid;     /* ro */
 232   int rpid;    /* rw, holds the received pid */
 233   int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
 234 } ev_child;
 235
 236 #if EV_EMBED_ENABLE
 237 /* used to embed an event loop inside another */
 238 /* the callback gets invoked when the event loop has handled events, and can be 0 */
 239 typedef struct ev_embed
 240 {
 241   EV_WATCHER (ev_embed)
 242
 243   ev_io io; /* private */
 244   struct ev_loop *loop; /* ro */
 245 } ev_embed;
 246 #endif
 247
 248 #if EV_STAT_ENABLE
 249 /* st_nlink = 0 means missing file or other error */
 250 typedef struct stat ev_statdata;
 251
 252 /* invoked each time the stat data changes for a given path */
 253 /* revent EV_STAT */
 254 typedef struct ev_stat
 255 {
 256   EV_WATCHER (ev_stat)
 257
 258   ev_timer timer;     /* private */
 259   ev_tstamp interval; /* rw */
 260   const char *path;   /* ro */
 261   ev_statdata prev;   /* ro */
 262   ev_statdata attr;   /* ro */
 263 } ev_stat;
 264 #endif
 265
 266 /* the presence of this union forces similar struct layout */
 267 union ev_any_watcher
 268 {
 269   struct ev_watcher w;
 270   struct ev_watcher_list wl;
 271
 272   struct ev_io io;
 273   struct ev_timer timer;
 274   struct ev_periodic periodic;
 275   struct ev_idle idle;
 276   struct ev_prepare prepare;
 277   struct ev_check check;
 278   struct ev_signal signal;
 279   struct ev_child child;
 280 #if EV_EMBED_ENABLE
 281   struct ev_embed embed;
 282 #endif
 283 #if EV_STAT_ENABLE
 284   struct ev_stat stat;
 285 #endif
 286 };
 287
 288 /* bits for ev_default_loop and ev_loop_new */
 289 /* the default */
 290 #define EVFLAG_AUTO       0x00000000UL /* not quite a mask */
 291 /* flag bits */
 292 #define EVFLAG_NOENV      0x01000000UL /* do NOT consult environment */
 293 /* method bits to be ored together */
 294 #define EVBACKEND_SELECT  0x00000001UL /* about anywhere */
 295 #define EVBACKEND_POLL    0x00000002UL /* !win */
 296 #define EVBACKEND_EPOLL   0x00000004UL /* linux */
 297 #define EVBACKEND_KQUEUE  0x00000008UL /* bsd */
 298 #define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */
 299 #define EVBACKEND_PORT    0x00000020UL /* solaris 10 */
 300
 301 #if EV_PROTOTYPES
 302 int ev_version_major (void);
 303 int ev_version_minor (void);
 304
 305 unsigned int ev_supported_backends (void);
 306 unsigned int ev_recommended_backends (void);
 307 unsigned int ev_embeddable_backends (void);
 308
 309 ev_tstamp ev_time (void);
 310
 311 /* Sets the allocation function to use, works like realloc.
 312  * It is used to allocate and free memory.
 313  * If it returns zero when memory needs to be allocated, the library might abort
 314  * or take some potentially destructive action.
 315  * The default is your system realloc function.
 316  */
 317 void ev_set_allocator (void *(*cb)(void *ptr, long size));
 318
 319 /* set the callback function to call on a
 320  * retryable syscall error
 321  * (such as failed select, poll, epoll_wait)
 322  */
 323 void ev_set_syserr_cb (void (*cb)(const char *msg));
 324
 325 # if EV_MULTIPLICITY
 326 /* the default loop is the only one that handles signals and child watchers */
 327 /* you can call this as often as you like */
 328 static struct ev_loop *
 329 ev_default_loop (unsigned int flags)
 330 {
 331   extern struct ev_loop *ev_default_loop_ptr;
 332   extern struct ev_loop *ev_default_loop_init (unsigned int flags);
 333
 334   if (!ev_default_loop_ptr)
 335     ev_default_loop_init (flags);
 336
 337   return ev_default_loop_ptr;
 338 }
 339
 340 /* create and destroy alternative loops that don't handle signals */
 341 struct ev_loop *ev_loop_new (unsigned int flags);
 342 void ev_loop_destroy (EV_P);
 343 void ev_loop_fork (EV_P);
 344
 345 ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
 346
 347 # else
 348
 349 int ev_default_loop (unsigned int flags); /* returns true when successful */
 350
 351 static ev_tstamp
 352 ev_now (void)
 353 {
 354   extern ev_tstamp ev_rt_now;
 355
 356   return ev_rt_now;
 357 }
 358 # endif
 359
 360 void ev_default_destroy (void); /* destroy the default loop */
 361 /* this needs to be called after fork, to duplicate the default loop */
 362 /* if you create alternative loops you have to call ev_loop_fork on them */
 363 /* you can call it in either the parent or the child */
 364 /* you can actually call it at any time, anywhere :) */
 365 void ev_default_fork (void);
 366
 367 unsigned int ev_backend (EV_P);
 368 #endif
 369
 370 #define EVLOOP_NONBLOCK 1 /* do not block/wait */
 371 #define EVLOOP_ONESHOT  2 /* block *once* only */
 372 #define EVUNLOOP_CANCEL 0 /* undo unloop */
 373 #define EVUNLOOP_ONE    1 /* unloop once */
 374 #define EVUNLOOP_ALL    2 /* unloop all loops */
 375
 376 #if EV_PROTOTYPES
 377 void ev_loop (EV_P_ int flags);
 378 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 */
 379
 380 /*
 381  * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
 382  * keeps one reference. if you have a long-runing watcher you never unregister that
 383  * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
 384  */
 385 void ev_ref   (EV_P);
 386 void ev_unref (EV_P);
 387
 388 /* convinience function, wait for a single event, without registering an event watcher */
 389 /* if timeout is < 0, do wait indefinitely */
 390 void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
 391 #endif
 392
 393 /* these may evaluate ev multiple times, and the other arguments at most once */
 394 /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
 395 #define ev_init(ev,cb_) do {                            \
 396   ((ev_watcher *)(void *)(ev))->active   =      \
 397   ((ev_watcher *)(void *)(ev))->pending  =      \
 398   ((ev_watcher *)(void *)(ev))->priority = 0;   \
 399   ev_set_cb ((ev), cb_);                                        \
 400 } while (0)
 401
 402 #define ev_io_set(ev,fd_,events_)           do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
 403 #define ev_timer_set(ev,after_,repeat_)     do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
 404 #define ev_periodic_set(ev,at_,ival_,res_)  do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
 405 #define ev_signal_set(ev,signum_)           do { (ev)->signum = (signum_); } while (0)
 406 #define ev_idle_set(ev)                     /* nop, yes, this is a serious in-joke */
 407 #define ev_prepare_set(ev)                  /* nop, yes, this is a serious in-joke */
 408 #define ev_check_set(ev)                    /* nop, yes, this is a serious in-joke */
 409 #define ev_child_set(ev,pid_)               do { (ev)->pid = (pid_); } while (0)
 410 #define ev_embed_set(ev,loop_)              do { (ev)->loop = (loop_); } while (0)
 411 #define ev_stat_set(ev,path_,interval_)     do { (ev)->path = (path_); (ev)->interval = (interval_); } while (0)
 412
 413 #define ev_io_init(ev,cb,fd,events)         do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
 414 #define ev_timer_init(ev,cb,after,repeat)   do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
 415 #define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
 416 #define ev_signal_init(ev,cb,signum)        do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
 417 #define ev_idle_init(ev,cb)                 do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
 418 #define ev_prepare_init(ev,cb)              do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
 419 #define ev_check_init(ev,cb)                do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
 420 #define ev_child_init(ev,cb,pid)            do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
 421 #define ev_embed_init(ev,cb,loop)           do { ev_init ((ev), (cb)); ev_embed_set ((ev),(loop)); } while (0)
 422 #define ev_stat_init(ev,cb,path,interval)   do { ev_init ((ev), (cb)); ev_path_set ((ev),(path),(interval)); } while (0)
 423
 424 #define ev_is_pending(ev)                   (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
 425 #define ev_is_active(ev)                    (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
 426
 427 #define ev_priority(ev)                     ((ev_watcher *)(void *)(ev))->priority /* rw */
 428 #define ev_cb(ev)                           (ev)->cb /* rw */
 429 #define ev_set_priority(ev,pri)             ev_priority (ev) = (pri)
 430
 431 #ifndef ev_set_cb
 432 # define ev_set_cb(ev,cb_)                  ev_cb (ev) = (cb_)
 433 #endif
 434
 435 /* stopping (enabling, adding) a watcher does nothing if it is already running */
 436 /* stopping (disabling, deleting) a watcher does nothing unless its already running */
 437 #if EV_PROTOTYPES
 438
 439 /* feeds an event into a watcher as if the event actually occured */
 440 /* accepts any ev_watcher type */
 441 void ev_feed_event     (EV_P_ void *w, int revents);
 442 void ev_feed_fd_event  (EV_P_ int fd, int revents);
 443 void ev_feed_signal_event (EV_P_ int signum);
 444
 445 void ev_io_start       (EV_P_ ev_io *w);
 446 void ev_io_stop        (EV_P_ ev_io *w);
 447
 448 void ev_timer_start    (EV_P_ ev_timer *w);
 449 void ev_timer_stop     (EV_P_ ev_timer *w);
 450 /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
 451 void ev_timer_again    (EV_P_ ev_timer *w);
 452
 453 #if EV_PERIODIC_ENABLE
 454 void ev_periodic_start (EV_P_ ev_periodic *w);
 455 void ev_periodic_stop  (EV_P_ ev_periodic *w);
 456 void ev_periodic_again (EV_P_ ev_periodic *w);
 457 #endif
 458
 459 void ev_idle_start     (EV_P_ ev_idle *w);
 460 void ev_idle_stop      (EV_P_ ev_idle *w);
 461
 462 void ev_prepare_start  (EV_P_ ev_prepare *w);
 463 void ev_prepare_stop   (EV_P_ ev_prepare *w);
 464
 465 void ev_check_start    (EV_P_ ev_check *w);
 466 void ev_check_stop     (EV_P_ ev_check *w);
 467
 468 /* only supported in the default loop */
 469 void ev_signal_start   (EV_P_ ev_signal *w);
 470 void ev_signal_stop    (EV_P_ ev_signal *w);
 471
 472 /* only supported in the default loop */
 473 void ev_child_start    (EV_P_ ev_child *w);
 474 void ev_child_stop     (EV_P_ ev_child *w);
 475
 476 # if EV_EMBED_ENABLE
 477 /* only supported when loop to be embedded is in fact embeddable */
 478 void ev_embed_start    (EV_P_ ev_embed *w);
 479 void ev_embed_stop     (EV_P_ ev_embed *w);
 480 void ev_embed_sweep    (EV_P_ ev_embed *w);
 481 # endif
 482
 483 # if EV_STAT_ENABLE
 484 void ev_stat_start     (EV_P_ ev_stat *w);
 485 void ev_stat_stop      (EV_P_ ev_stat *w);
 486 void ev_stat_stat      (EV_P_ ev_stat *w);
 487 # endif
 488
 489 #endif
 490
 491 #ifdef __cplusplus
 492 }
 493 #endif
 494
 495 #endif
 496