ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
(Generate patch)

Comparing libev/ev.h (file contents):
Revision 1.90 by root, Tue Dec 25 07:05:45 2007 UTC vs.
Revision 1.101 by root, Wed May 21 23:25:21 2008 UTC

1/* 1/*
2 * libev native API header 2 * libev native API header
3 * 3 *
4 * Copyright (c) 2007 Marc Alexander Lehmann <libev@schmorp.de> 4 * Copyright (c) 2007,2008 Marc Alexander Lehmann <libev@schmorp.de>
5 * All rights reserved. 5 * All rights reserved.
6 * 6 *
7 * Redistribution and use in source and binary forms, with or without modifica- 7 * Redistribution and use in source and binary forms, with or without modifica-
8 * tion, are permitted provided that the following conditions are met: 8 * tion, are permitted provided that the following conditions are met:
9 * 9 *
… …
76 76
77#ifndef EV_EMBED_ENABLE 77#ifndef EV_EMBED_ENABLE
78# define EV_EMBED_ENABLE 1 78# define EV_EMBED_ENABLE 1
79#endif 79#endif
80 80
81#ifndef EV_ASYNC_ENABLE
82# define EV_ASYNC_ENABLE 1
83#endif
84
85#ifndef EV_ATOMIC_T
86# include <signal.h>
87# define EV_ATOMIC_T sig_atomic_t volatile
88#endif
89
81/*****************************************************************************/ 90/*****************************************************************************/
82 91
83#if EV_STAT_ENABLE 92#if EV_STAT_ENABLE
84# include <sys/stat.h> 93# include <sys/stat.h>
85#endif 94#endif
… …
89struct ev_loop; 98struct ev_loop;
90# define EV_P struct ev_loop *loop 99# define EV_P struct ev_loop *loop
91# define EV_P_ EV_P, 100# define EV_P_ EV_P,
92# define EV_A loop 101# define EV_A loop
93# define EV_A_ EV_A, 102# define EV_A_ EV_A,
103# define EV_DEFAULT_UC ev_default_loop_uc ()
104# define EV_DEFAULT_UC_ EV_DEFAULT_UC,
94# define EV_DEFAULT ev_default_loop (0) 105# define EV_DEFAULT ev_default_loop (0)
95# define EV_DEFAULT_ EV_DEFAULT, 106# define EV_DEFAULT_ EV_DEFAULT,
96#else 107#else
97# define EV_P void 108# define EV_P void
98# define EV_P_ 109# define EV_P_
99# define EV_A 110# define EV_A
100# define EV_A_ 111# define EV_A_
101# define EV_DEFAULT 112# define EV_DEFAULT
102# define EV_DEFAULT_ 113# define EV_DEFAULT_
103 114# define EV_DEFAULT_UC
115# define EV_DEFAULT_UC_
104# undef EV_EMBED_ENABLE 116# undef EV_EMBED_ENABLE
105#endif 117#endif
106 118
119#if __STDC_VERSION__ >= 199901L || __GNUC__ >= 3
120# define EV_INLINE static inline
121#else
122# define EV_INLINE static
123#endif
124
125/*****************************************************************************/
126
107/* eventmask, revents, events... */ 127/* eventmask, revents, events... */
108#define EV_UNDEF -1L /* guaranteed to be invalid */ 128#define EV_UNDEF -1 /* guaranteed to be invalid */
109#define EV_NONE 0x00L /* no events */ 129#define EV_NONE 0x00 /* no events */
110#define EV_READ 0x01L /* ev_io detected read will not block */ 130#define EV_READ 0x01 /* ev_io detected read will not block */
111#define EV_WRITE 0x02L /* ev_io detected write will not block */ 131#define EV_WRITE 0x02 /* ev_io detected write will not block */
112#define EV_IOFDSET 0x80L /* internal use only */ 132#define EV_IOFDSET 0x80 /* internal use only */
113#define EV_TIMEOUT 0x00000100L /* timer timed out */ 133#define EV_TIMEOUT 0x00000100 /* timer timed out */
114#define EV_PERIODIC 0x00000200L /* periodic timer timed out */ 134#define EV_PERIODIC 0x00000200 /* periodic timer timed out */
115#define EV_SIGNAL 0x00000400L /* signal was received */ 135#define EV_SIGNAL 0x00000400 /* signal was received */
116#define EV_CHILD 0x00000800L /* child/pid had status change */ 136#define EV_CHILD 0x00000800 /* child/pid had status change */
117#define EV_STAT 0x00001000L /* stat data changed */ 137#define EV_STAT 0x00001000 /* stat data changed */
118#define EV_IDLE 0x00002000L /* event loop is idling */ 138#define EV_IDLE 0x00002000 /* event loop is idling */
119#define EV_PREPARE 0x00004000L /* event loop about to poll */ 139#define EV_PREPARE 0x00004000 /* event loop about to poll */
120#define EV_CHECK 0x00008000L /* event loop finished poll */ 140#define EV_CHECK 0x00008000 /* event loop finished poll */
121#define EV_EMBED 0x00010000L /* embedded event loop needs sweep */ 141#define EV_EMBED 0x00010000 /* embedded event loop needs sweep */
122#define EV_FORK 0x00020000L /* event loop resumed in child */ 142#define EV_FORK 0x00020000 /* event loop resumed in child */
143#define EV_ASYNC 0x00040000 /* async intra-loop signal */
123#define EV_ERROR 0x80000000L /* sent when an error occurs */ 144#define EV_ERROR 0x80000000 /* sent when an error occurs */
124 145
125/* can be used to add custom fields to all watchers, while losing binary compatibility */ 146/* can be used to add custom fields to all watchers, while losing binary compatibility */
126#ifndef EV_COMMON 147#ifndef EV_COMMON
127# define EV_COMMON void *data; 148# define EV_COMMON void *data;
128#endif 149#endif
129#ifndef EV_PROTOTYPES 150#ifndef EV_PROTOTYPES
130# define EV_PROTOTYPES 1 151# define EV_PROTOTYPES 1
131#endif 152#endif
132 153
133#define EV_VERSION_MAJOR 2 154#define EV_VERSION_MAJOR 3
134#define EV_VERSION_MINOR 0 155#define EV_VERSION_MINOR 0
135 156
136#ifndef EV_CB_DECLARE 157#ifndef EV_CB_DECLARE
137# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents); 158# define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
138#endif 159#endif
… …
143/* 164/*
144 * struct member types: 165 * struct member types:
145 * private: you can look at them, but not change them, and they might not mean anything to you. 166 * private: you can look at them, but not change them, and they might not mean anything to you.
146 * ro: can be read anytime, but only changed when the watcher isn't active 167 * ro: can be read anytime, but only changed when the watcher isn't active
147 * rw: can be read and modified anytime, even when the watcher is active 168 * rw: can be read and modified anytime, even when the watcher is active
169 *
170 * some internal details that might be helpful for debugging:
171 *
172 * active is either 0, which means the watcher is not active,
173 * or the array index of the watcher (periodics, timers)
174 * or the array index + 1 (most other watchers)
175 * or simply 1 for watchers that aren't in some array.
176 * pending is either 0, in which case the watcher isn't,
177 * or the array index + 1 in the pendings array.
148 */ 178 */
149 179
150/* shared by all watchers */ 180/* shared by all watchers */
151#define EV_WATCHER(type) \ 181#define EV_WATCHER(type) \
152 int active; /* private */ \ 182 int active; /* private */ \
… …
225/* does not support priorities */ 255/* does not support priorities */
226typedef struct ev_child 256typedef struct ev_child
227{ 257{
228 EV_WATCHER_LIST (ev_child) 258 EV_WATCHER_LIST (ev_child)
229 259
260 int flags; /* private */
230 int pid; /* ro */ 261 int pid; /* ro */
231 int rpid; /* rw, holds the received pid */ 262 int rpid; /* rw, holds the received pid */
232 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */ 263 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
233} ev_child; 264} ev_child;
234 265
… …
304 ev_idle idle; /* unused */ 335 ev_idle idle; /* unused */
305 ev_fork fork; /* unused */ 336 ev_fork fork; /* unused */
306} ev_embed; 337} ev_embed;
307#endif 338#endif
308 339
340#if EV_ASYNC_ENABLE
341/* invoked when somebody calls ev_async_send on the watcher */
342/* revent EV_ASYNC */
343typedef struct ev_async
344{
345 EV_WATCHER (ev_async)
346
347 EV_ATOMIC_T sent; /* private */
348} ev_async;
349
350# define ev_async_pending(w) ((w)->sent + 0)
351#endif
352
309/* the presence of this union forces similar struct layout */ 353/* the presence of this union forces similar struct layout */
310union ev_any_watcher 354union ev_any_watcher
311{ 355{
312 struct ev_watcher w; 356 struct ev_watcher w;
313 struct ev_watcher_list wl; 357 struct ev_watcher_list wl;
… …
329 struct ev_fork fork; 373 struct ev_fork fork;
330#endif 374#endif
331#if EV_EMBED_ENABLE 375#if EV_EMBED_ENABLE
332 struct ev_embed embed; 376 struct ev_embed embed;
333#endif 377#endif
378#if EV_ASYNC_ENABLE
379 struct ev_async async;
380#endif
334}; 381};
335 382
336/* bits for ev_default_loop and ev_loop_new */ 383/* bits for ev_default_loop and ev_loop_new */
337/* the default */ 384/* the default */
338#define EVFLAG_AUTO 0x00000000UL /* not quite a mask */ 385#define EVFLAG_AUTO 0x00000000U /* not quite a mask */
339/* flag bits */ 386/* flag bits */
340#define EVFLAG_NOENV 0x01000000UL /* do NOT consult environment */ 387#define EVFLAG_NOENV 0x01000000U /* do NOT consult environment */
341#define EVFLAG_FORKCHECK 0x02000000UL /* check for a fork in each iteration */ 388#define EVFLAG_FORKCHECK 0x02000000U /* check for a fork in each iteration */
342/* method bits to be ored together */ 389/* method bits to be ored together */
343#define EVBACKEND_SELECT 0x00000001UL /* about anywhere */ 390#define EVBACKEND_SELECT 0x00000001U /* about anywhere */
344#define EVBACKEND_POLL 0x00000002UL /* !win */ 391#define EVBACKEND_POLL 0x00000002U /* !win */
345#define EVBACKEND_EPOLL 0x00000004UL /* linux */ 392#define EVBACKEND_EPOLL 0x00000004U /* linux */
346#define EVBACKEND_KQUEUE 0x00000008UL /* bsd */ 393#define EVBACKEND_KQUEUE 0x00000008U /* bsd */
347#define EVBACKEND_DEVPOLL 0x00000010UL /* solaris 8 */ /* NYI */ 394#define EVBACKEND_DEVPOLL 0x00000010U /* solaris 8 */ /* NYI */
348#define EVBACKEND_PORT 0x00000020UL /* solaris 10 */ 395#define EVBACKEND_PORT 0x00000020U /* solaris 10 */
349 396
350#if EV_PROTOTYPES 397#if EV_PROTOTYPES
351int ev_version_major (void); 398int ev_version_major (void);
352int ev_version_minor (void); 399int ev_version_minor (void);
353 400
… …
371 * (such as failed select, poll, epoll_wait) 418 * (such as failed select, poll, epoll_wait)
372 */ 419 */
373void ev_set_syserr_cb (void (*cb)(const char *msg)); 420void ev_set_syserr_cb (void (*cb)(const char *msg));
374 421
375# if EV_MULTIPLICITY 422# if EV_MULTIPLICITY
423EV_INLINE struct ev_loop *
424ev_default_loop_uc (void)
425{
426 extern struct ev_loop *ev_default_loop_ptr;
427
428 return ev_default_loop_ptr;
429}
430
376/* the default loop is the only one that handles signals and child watchers */ 431/* the default loop is the only one that handles signals and child watchers */
377/* you can call this as often as you like */ 432/* you can call this as often as you like */
378static struct ev_loop * 433EV_INLINE struct ev_loop *
379ev_default_loop (unsigned int flags) 434ev_default_loop (unsigned int flags)
380{ 435{
381 extern struct ev_loop *ev_default_loop_ptr; 436 struct ev_loop *loop = ev_default_loop_uc ();
437
438 if (!loop)
439 {
382 extern struct ev_loop *ev_default_loop_init (unsigned int flags); 440 extern struct ev_loop *ev_default_loop_init (unsigned int flags);
383 441
384 if (!ev_default_loop_ptr)
385 ev_default_loop_init (flags); 442 loop = ev_default_loop_init (flags);
443 }
386 444
387 return ev_default_loop_ptr; 445 return loop;
388} 446}
389 447
390/* create and destroy alternative loops that don't handle signals */ 448/* create and destroy alternative loops that don't handle signals */
391struct ev_loop *ev_loop_new (unsigned int flags); 449struct ev_loop *ev_loop_new (unsigned int flags);
392void ev_loop_destroy (EV_P); 450void ev_loop_destroy (EV_P);
… …
396 454
397# else 455# else
398 456
399int ev_default_loop (unsigned int flags); /* returns true when successful */ 457int ev_default_loop (unsigned int flags); /* returns true when successful */
400 458
401static ev_tstamp 459EV_INLINE ev_tstamp
402ev_now (void) 460ev_now (void)
403{ 461{
404 extern ev_tstamp ev_rt_now; 462 extern ev_tstamp ev_rt_now;
405 463
406 return ev_rt_now; 464 return ev_rt_now;
407} 465}
408# endif 466# endif
467
468EV_INLINE int
469ev_is_default_loop (EV_P)
470{
471#if EV_MULTIPLICITY
472 extern struct ev_loop *ev_default_loop_ptr;
473
474 return !!(EV_A == ev_default_loop_ptr);
475#else
476 return 1;
477#endif
478}
409 479
410void ev_default_destroy (void); /* destroy the default loop */ 480void ev_default_destroy (void); /* destroy the default loop */
411/* this needs to be called after fork, to duplicate the default loop */ 481/* this needs to be called after fork, to duplicate the default loop */
412/* if you create alternative loops you have to call ev_loop_fork on them */ 482/* if you create alternative loops you have to call ev_loop_fork on them */
413/* you can call it in either the parent or the child */ 483/* you can call it in either the parent or the child */
… …
452 ((ev_watcher *)(void *)(ev))->priority = 0; \ 522 ((ev_watcher *)(void *)(ev))->priority = 0; \
453 ev_set_cb ((ev), cb_); \ 523 ev_set_cb ((ev), cb_); \
454} while (0) 524} while (0)
455 525
456#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0) 526#define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_) | EV_IOFDSET; } while (0)
457#define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0) 527#define ev_timer_set(ev,after_,repeat_) do { ((ev_watcher_time *)(ev))->at = (after_); (ev)->repeat = (repeat_); } while (0)
458#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0) 528#define ev_periodic_set(ev,ofs_,ival_,res_) do { (ev)->offset = (ofs_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
459#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0) 529#define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
460#define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0) 530#define ev_child_set(ev,pid_,trace_) do { (ev)->pid = (pid_); (ev)->flags = !!(trace_); } while (0)
461#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0) 531#define ev_stat_set(ev,path_,interval_) do { (ev)->path = (path_); (ev)->interval = (interval_); (ev)->wd = -2; } while (0)
462#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */ 532#define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
463#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */ 533#define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
464#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */ 534#define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
465#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0) 535#define ev_embed_set(ev,other_) do { (ev)->other = (other_); } while (0)
466#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */ 536#define ev_fork_set(ev) /* nop, yes, this is a serious in-joke */
537#define ev_async_set(ev) do { (ev)->sent = 0; } while (0)
467 538
468#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0) 539#define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
469#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0) 540#define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
470#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0) 541#define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
471#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0) 542#define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
472#define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0) 543#define ev_child_init(ev,cb,pid,trace) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid),(trace)); } while (0)
473#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0) 544#define ev_stat_init(ev,cb,path,interval) do { ev_init ((ev), (cb)); ev_stat_set ((ev),(path),(interval)); } while (0)
474#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0) 545#define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
475#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0) 546#define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
476#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0) 547#define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
477#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0) 548#define ev_embed_init(ev,cb,other) do { ev_init ((ev), (cb)); ev_embed_set ((ev),(other)); } while (0)
478#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0) 549#define ev_fork_init(ev,cb) do { ev_init ((ev), (cb)); ev_fork_set ((ev)); } while (0)
550#define ev_async_init(ev,cb) do { ev_init ((ev), (cb)); ev_async_set ((ev)); } while (0)
479 551
480#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */ 552#define ev_is_pending(ev) (0 + ((ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
481#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */ 553#define ev_is_active(ev) (0 + ((ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
482 554
483#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0) 555#define ev_priority(ev) ((((ev_watcher *)(void *)(ev))->priority) + 0)
484#define ev_cb(ev) (ev)->cb /* rw */ 556#define ev_cb(ev) (ev)->cb /* rw */
485#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri) 557#define ev_set_priority(ev,pri) ((ev_watcher *)(void *)(ev))->priority = (pri)
558
559#define ev_periodic_at(ev) (((ev_watcher_time *)(ev))->at + 0.)
486 560
487#ifndef ev_set_cb 561#ifndef ev_set_cb
488# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_) 562# define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
489#endif 563#endif
490 564
… …
549void ev_embed_start (EV_P_ ev_embed *w); 623void ev_embed_start (EV_P_ ev_embed *w);
550void ev_embed_stop (EV_P_ ev_embed *w); 624void ev_embed_stop (EV_P_ ev_embed *w);
551void ev_embed_sweep (EV_P_ ev_embed *w); 625void ev_embed_sweep (EV_P_ ev_embed *w);
552# endif 626# endif
553 627
628# if EV_ASYNC_ENABLE
629void ev_async_start (EV_P_ ev_async *w);
630void ev_async_stop (EV_P_ ev_async *w);
631void ev_async_send (EV_P_ ev_async *w);
632# endif
633
554#endif 634#endif
555 635
556#ifdef __cplusplus 636#ifdef __cplusplus
557} 637}
558#endif 638#endif

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines