ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.84
Committed: Wed Dec 12 05:11:56 2007 UTC (16 years, 5 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-1_81
Changes since 1.83: +2 -1 lines
Log Message:
remember wether the fd was new or not

File Contents

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