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