ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev.h
Revision: 1.58
Committed: Thu Nov 15 09:19:43 2007 UTC (16 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.57: +11 -1 lines
Log Message:
optimise ev_default_loop

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_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 -1 /* guaranteed to be invalid */
75 #define EV_NONE 0x00
76 #define EV_READ 0x01 /* io only */
77 #define EV_WRITE 0x02 /* io only */
78 #define EV_TIMEOUT 0x000100 /* timer only */
79 #define EV_PERIODIC 0x000200 /* periodic timer only */
80 #define EV_SIGNAL 0x000400 /* signal only */
81 #define EV_IDLE 0x000800 /* idle only */
82 #define EV_CHECK 0x001000 /* check only */
83 #define EV_PREPARE 0x002000 /* prepare only */
84 #define EV_CHILD 0x004000 /* child/pid only */
85 #define EV_ERROR 0x800000 /* sent when an error occurs */
86
87 /* can be used to add custom fields to all watchers, while losing binary compatibility */
88 #ifndef EV_COMMON
89 # define EV_COMMON void *data;
90 #endif
91 #ifndef EV_PROTOTYPES
92 # define EV_PROTOTYPES 1
93 #endif
94
95 #define EV_VERSION_MAJOR 1
96 #define EV_VERSION_MINOR 1
97
98 #ifndef EV_CB_DECLARE
99 # define EV_CB_DECLARE(type) void (*cb)(EV_P_ struct type *w, int revents);
100 #endif
101 #ifndef EV_CB_INVOKE
102 # define EV_CB_INVOKE(watcher,revents) (watcher)->cb (EV_A_ (watcher), (revents))
103 #endif
104
105 /*
106 * struct member types:
107 * private: you can look at them, but not change them, and they might not mean anything to you.
108 * ro: can be read anytime, but only changed when the watcher isn't active
109 * rw: can be read and modified anytime, even when the watcher is active
110 */
111
112 /* shared by all watchers */
113 #define EV_WATCHER(type) \
114 int active; /* private */ \
115 int pending; /* private */ \
116 int priority; /* private */ \
117 EV_COMMON /* rw */ \
118 EV_CB_DECLARE (type) /* private */
119
120 #define EV_WATCHER_LIST(type) \
121 EV_WATCHER (type) \
122 struct ev_watcher_list *next; /* private */
123
124 #define EV_WATCHER_TIME(type) \
125 EV_WATCHER (type) \
126 ev_tstamp at; /* private */
127
128 /* base class, nothing to see here unless you subclass */
129 struct ev_watcher
130 {
131 EV_WATCHER (ev_watcher)
132 };
133
134 /* base class, nothing to see here unless you subclass */
135 struct ev_watcher_list
136 {
137 EV_WATCHER_LIST (ev_watcher_list)
138 };
139
140 /* base class, nothing to see here unless you subclass */
141 struct ev_watcher_time
142 {
143 EV_WATCHER_TIME (ev_watcher_time)
144 };
145
146 /* invoked after a specific time, repeatable (based on monotonic clock) */
147 /* revent EV_TIMEOUT */
148 struct ev_timer
149 {
150 EV_WATCHER_TIME (ev_timer)
151
152 ev_tstamp repeat; /* rw */
153 };
154
155 /* invoked at some specific time, possibly repeating at regular intervals (based on UTC) */
156 /* revent EV_PERIODIC */
157 struct ev_periodic
158 {
159 EV_WATCHER_TIME (ev_periodic)
160
161 ev_tstamp interval; /* rw */
162 ev_tstamp (*reschedule_cb)(struct ev_periodic *w, ev_tstamp now); /* rw */
163 };
164
165 /* invoked when fd is either EV_READable or EV_WRITEable */
166 /* revent EV_READ, EV_WRITE */
167 struct ev_io
168 {
169 EV_WATCHER_LIST (ev_io)
170
171 int fd; /* ro */
172 int events; /* ro */
173 };
174
175 /* invoked when the given signal has been received */
176 /* revent EV_SIGNAL */
177 struct ev_signal
178 {
179 EV_WATCHER_LIST (ev_signal)
180
181 int signum; /* ro */
182 };
183
184 /* invoked when the nothing else needs to be done, keeps the process from blocking */
185 /* revent EV_IDLE */
186 struct ev_idle
187 {
188 EV_WATCHER (ev_idle)
189 };
190
191 /* invoked for each run of the mainloop, just before the blocking call */
192 /* you can still change events in any way you like */
193 /* revent EV_PREPARE */
194 struct ev_prepare
195 {
196 EV_WATCHER (ev_prepare)
197 };
198
199 /* invoked for each run of the mainloop, just after the blocking call */
200 /* revent EV_CHECK */
201 struct ev_check
202 {
203 EV_WATCHER (ev_check)
204 };
205
206 /* invoked when sigchld is received and waitpid indicates the given pid */
207 /* revent EV_CHILD */
208 /* does not support priorities */
209 struct ev_child
210 {
211 EV_WATCHER_LIST (ev_child)
212
213 int pid; /* ro */
214 int rpid; /* rw, holds the received pid */
215 int rstatus; /* rw, holds the exit status, use the macros from sys/wait.h */
216 };
217
218 /* the presence of this union forces similar struct layout */
219 union ev_any_watcher
220 {
221 struct ev_watcher w;
222 struct ev_watcher_list wl;
223
224 struct ev_io io;
225 struct ev_timer timer;
226 struct ev_periodic periodic;
227 struct ev_idle idle;
228 struct ev_prepare prepare;
229 struct ev_check check;
230 struct ev_signal signal;
231 struct ev_child child;
232 };
233
234 /* bits for ev_default_loop and ev_loop_new */
235 /* the default */
236 #define EVFLAG_AUTO 0x00000000 /* not quite a mask */
237
238 /* method bits to be ored together */
239 #define EVMETHOD_SELECT 0x00000001 /* about anywhere */
240 #define EVMETHOD_POLL 0x00000002 /* !win */
241 #define EVMETHOD_EPOLL 0x00000004 /* linux */
242 #define EVMETHOD_KQUEUE 0x00000008 /* bsd */
243 #define EVMETHOD_DEVPOLL 0x00000010 /* solaris 8 */ /* NYI */
244 #define EVMETHOD_PORT 0x00000020 /* solaris 10 */ /* NYI */
245
246 /* flag bits */
247 #define EVFLAG_NOENV 0x01000000 /* do NOT consult environment */
248
249 #if EV_PROTOTYPES
250 int ev_version_major (void);
251 int ev_version_minor (void);
252
253 ev_tstamp ev_time (void);
254
255 /* Sets the allocation function to use, works like realloc.
256 * It is used to allocate and free memory.
257 * If it returns zero when memory needs to be allocated, the library might abort
258 * or take some potentially destructive action.
259 * The default is your system realloc function.
260 */
261 void ev_set_allocator (void *(*cb)(void *ptr, long size));
262
263 /* set the callback function to call on a
264 * retryable syscall error
265 * (such as failed select, poll, epoll_wait)
266 */
267 void ev_set_syserr_cb (void (*cb)(const char *msg));
268
269 # if EV_MULTIPLICITY
270 /* the default loop is the only one that handles signals and child watchers */
271 /* you can call this as often as you like */
272 static struct ev_loop *
273 ev_default_loop (unsigned int flags)
274 {
275 extern struct ev_loop *ev_default_loop_ptr;
276 extern struct ev_loop *ev_default_loop_ (unsigned int flags);
277
278 if (!ev_default_loop_ptr)
279 ev_default_loop_ (flags);
280
281 return ev_default_loop_ptr;
282 }
283
284 /* create and destroy alternative loops that don't handle signals */
285 struct ev_loop *ev_loop_new (unsigned int flags);
286 void ev_loop_destroy (EV_P);
287 void ev_loop_fork (EV_P);
288
289 ev_tstamp ev_now (EV_P); /* time w.r.t. timers and the eventloop, updated after each poll */
290
291 # else
292
293 int ev_default_loop (unsigned int flags); /* returns true when successful */
294
295 static ev_tstamp
296 ev_now (void)
297 {
298 extern ev_tstamp ev_rt_now;
299
300 return ev_rt_now;
301 }
302 # endif
303
304 void ev_default_destroy (void); /* destroy the default loop */
305 /* this needs to be called after fork, to duplicate the default loop */
306 /* if you create alternative loops you have to call ev_loop_fork on them */
307 /* you can call it in either the parent or the child */
308 /* you can actually call it at any time, anywhere :) */
309 void ev_default_fork (void);
310
311 unsigned int ev_method (EV_P);
312 #endif
313
314 #define EVLOOP_NONBLOCK 1 /* do not block/wait */
315 #define EVLOOP_ONESHOT 2 /* block *once* only */
316 #define EVUNLOOP_ONE 1 /* unloop once */
317 #define EVUNLOOP_ALL 2 /* unloop all loops */
318
319 #if EV_PROTOTYPES
320 void ev_loop (EV_P_ int flags);
321 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 */
322
323 /*
324 * ref/unref can be used to add or remove a refcount on the mainloop. every watcher
325 * keeps one reference. if you have a long-runing watcher you never unregister that
326 * should not keep ev_loop from running, unref() after starting, and ref() before stopping.
327 */
328 void ev_ref (EV_P);
329 void ev_unref (EV_P);
330
331 /* convinience function, wait for a single event, without registering an event watcher */
332 /* if timeout is < 0, do wait indefinitely */
333 void ev_once (EV_P_ int fd, int events, ev_tstamp timeout, void (*cb)(int revents, void *arg), void *arg);
334 #endif
335
336 /* these may evaluate ev multiple times, and the other arguments at most once */
337 /* either use ev_init + ev_TYPE_set, or the ev_TYPE_init macro, below, to first initialise a watcher */
338 #define ev_init(ev,cb_) do { \
339 ((struct ev_watcher *)(void *)(ev))->active = \
340 ((struct ev_watcher *)(void *)(ev))->pending = \
341 ((struct ev_watcher *)(void *)(ev))->priority = 0; \
342 ev_set_cb ((ev), cb_); \
343 } while (0)
344
345 #define ev_io_set(ev,fd_,events_) do { (ev)->fd = (fd_); (ev)->events = (events_); } while (0)
346 #define ev_timer_set(ev,after_,repeat_) do { (ev)->at = (after_); (ev)->repeat = (repeat_); } while (0)
347 #define ev_periodic_set(ev,at_,ival_,res_) do { (ev)->at = (at_); (ev)->interval = (ival_); (ev)->reschedule_cb= (res_); } while (0)
348 #define ev_signal_set(ev,signum_) do { (ev)->signum = (signum_); } while (0)
349 #define ev_idle_set(ev) /* nop, yes, this is a serious in-joke */
350 #define ev_prepare_set(ev) /* nop, yes, this is a serious in-joke */
351 #define ev_check_set(ev) /* nop, yes, this is a serious in-joke */
352 #define ev_child_set(ev,pid_) do { (ev)->pid = (pid_); } while (0)
353
354 #define ev_io_init(ev,cb,fd,events) do { ev_init ((ev), (cb)); ev_io_set ((ev),(fd),(events)); } while (0)
355 #define ev_timer_init(ev,cb,after,repeat) do { ev_init ((ev), (cb)); ev_timer_set ((ev),(after),(repeat)); } while (0)
356 #define ev_periodic_init(ev,cb,at,ival,res) do { ev_init ((ev), (cb)); ev_periodic_set ((ev),(at),(ival),(res)); } while (0)
357 #define ev_signal_init(ev,cb,signum) do { ev_init ((ev), (cb)); ev_signal_set ((ev), (signum)); } while (0)
358 #define ev_idle_init(ev,cb) do { ev_init ((ev), (cb)); ev_idle_set ((ev)); } while (0)
359 #define ev_prepare_init(ev,cb) do { ev_init ((ev), (cb)); ev_prepare_set ((ev)); } while (0)
360 #define ev_check_init(ev,cb) do { ev_init ((ev), (cb)); ev_check_set ((ev)); } while (0)
361 #define ev_child_init(ev,cb,pid) do { ev_init ((ev), (cb)); ev_child_set ((ev),(pid)); } while (0)
362
363 #define ev_is_pending(ev) (0 + ((struct ev_watcher *)(void *)(ev))->pending) /* ro, true when watcher is waiting for callback invocation */
364 #define ev_is_active(ev) (0 + ((struct ev_watcher *)(void *)(ev))->active) /* ro, true when the watcher has been started */
365
366 #define ev_priority(ev) ((struct ev_watcher *)(void *)(ev))->priority /* rw */
367 #define ev_cb(ev) (ev)->cb /* rw */
368 #define ev_set_priority(ev,pri) ev_priority (ev) = (pri)
369
370 #ifndef ev_set_cb
371 # define ev_set_cb(ev,cb_) ev_cb (ev) = (cb_)
372 #endif
373
374 /* stopping (enabling, adding) a watcher does nothing if it is already running */
375 /* stopping (disabling, deleting) a watcher does nothing unless its already running */
376 #if EV_PROTOTYPES
377
378 /* feeds an event into a watcher as if the event actually occured */
379 /* accepts any ev_watcher type */
380 void ev_feed_event (EV_P_ void *w, int revents);
381 void ev_feed_fd_event (EV_P_ int fd, int revents);
382 void ev_feed_signal_event (EV_P_ int signum);
383
384 void ev_io_start (EV_P_ struct ev_io *w);
385 void ev_io_stop (EV_P_ struct ev_io *w);
386
387 void ev_timer_start (EV_P_ struct ev_timer *w);
388 void ev_timer_stop (EV_P_ struct ev_timer *w);
389 /* stops if active and no repeat, restarts if active and repeating, starts if inactive and repeating */
390 void ev_timer_again (EV_P_ struct ev_timer *w);
391
392 #if EV_PERIODICS
393 void ev_periodic_start (EV_P_ struct ev_periodic *w);
394 void ev_periodic_stop (EV_P_ struct ev_periodic *w);
395 void ev_periodic_again (EV_P_ struct ev_periodic *w);
396 #endif
397
398 void ev_idle_start (EV_P_ struct ev_idle *w);
399 void ev_idle_stop (EV_P_ struct ev_idle *w);
400
401 void ev_prepare_start (EV_P_ struct ev_prepare *w);
402 void ev_prepare_stop (EV_P_ struct ev_prepare *w);
403
404 void ev_check_start (EV_P_ struct ev_check *w);
405 void ev_check_stop (EV_P_ struct ev_check *w);
406
407 /* only supported in the default loop */
408 void ev_signal_start (EV_P_ struct ev_signal *w);
409 void ev_signal_stop (EV_P_ struct ev_signal *w);
410
411 /* only supported in the default loop */
412 void ev_child_start (EV_P_ struct ev_child *w);
413 void ev_child_stop (EV_P_ struct ev_child *w);
414 #endif
415
416 #ifdef __cplusplus
417 }
418 #endif
419
420 #endif
421