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

Comparing libev/ev.pod (file contents):
Revision 1.117 by root, Wed Jan 9 04:15:39 2008 UTC vs.
Revision 1.144 by root, Mon Apr 7 12:33:29 2008 UTC

6 6
7 #include <ev.h> 7 #include <ev.h>
8 8
9=head2 EXAMPLE PROGRAM 9=head2 EXAMPLE PROGRAM
10 10
11 // a single header file is required
11 #include <ev.h> 12 #include <ev.h>
12 13
14 // every watcher type has its own typedef'd struct
15 // with the name ev_<type>
13 ev_io stdin_watcher; 16 ev_io stdin_watcher;
14 ev_timer timeout_watcher; 17 ev_timer timeout_watcher;
15 18
19 // all watcher callbacks have a similar signature
16 /* called when data readable on stdin */ 20 // this callback is called when data is readable on stdin
17 static void 21 static void
18 stdin_cb (EV_P_ struct ev_io *w, int revents) 22 stdin_cb (EV_P_ struct ev_io *w, int revents)
19 { 23 {
20 /* puts ("stdin ready"); */ 24 puts ("stdin ready");
21 ev_io_stop (EV_A_ w); /* just a syntax example */ 25 // for one-shot events, one must manually stop the watcher
22 ev_unloop (EV_A_ EVUNLOOP_ALL); /* leave all loop calls */ 26 // with its corresponding stop function.
27 ev_io_stop (EV_A_ w);
28
29 // this causes all nested ev_loop's to stop iterating
30 ev_unloop (EV_A_ EVUNLOOP_ALL);
23 } 31 }
24 32
33 // another callback, this time for a time-out
25 static void 34 static void
26 timeout_cb (EV_P_ struct ev_timer *w, int revents) 35 timeout_cb (EV_P_ struct ev_timer *w, int revents)
27 { 36 {
28 /* puts ("timeout"); */ 37 puts ("timeout");
29 ev_unloop (EV_A_ EVUNLOOP_ONE); /* leave one loop call */ 38 // this causes the innermost ev_loop to stop iterating
39 ev_unloop (EV_A_ EVUNLOOP_ONE);
30 } 40 }
31 41
32 int 42 int
33 main (void) 43 main (void)
34 { 44 {
45 // use the default event loop unless you have special needs
35 struct ev_loop *loop = ev_default_loop (0); 46 struct ev_loop *loop = ev_default_loop (0);
36 47
37 /* initialise an io watcher, then start it */ 48 // initialise an io watcher, then start it
49 // this one will watch for stdin to become readable
38 ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ); 50 ev_io_init (&stdin_watcher, stdin_cb, /*STDIN_FILENO*/ 0, EV_READ);
39 ev_io_start (loop, &stdin_watcher); 51 ev_io_start (loop, &stdin_watcher);
40 52
53 // initialise a timer watcher, then start it
41 /* simple non-repeating 5.5 second timeout */ 54 // simple non-repeating 5.5 second timeout
42 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.); 55 ev_timer_init (&timeout_watcher, timeout_cb, 5.5, 0.);
43 ev_timer_start (loop, &timeout_watcher); 56 ev_timer_start (loop, &timeout_watcher);
44 57
45 /* loop till timeout or data ready */ 58 // now wait for events to arrive
46 ev_loop (loop, 0); 59 ev_loop (loop, 0);
47 60
61 // unloop was called, so exit
48 return 0; 62 return 0;
49 } 63 }
50 64
51=head1 DESCRIPTION 65=head1 DESCRIPTION
52 66
53The newest version of this document is also available as a html-formatted 67The newest version of this document is also available as an html-formatted
54web page you might find easier to navigate when reading it for the first 68web page you might find easier to navigate when reading it for the first
55time: L<http://cvs.schmorp.de/libev/ev.html>. 69time: L<http://cvs.schmorp.de/libev/ev.html>.
56 70
57Libev is an event loop: you register interest in certain events (such as a 71Libev is an event loop: you register interest in certain events (such as a
58file descriptor being readable or a timeout occurring), and it will manage 72file descriptor being readable or a timeout occurring), and it will manage
84L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent 98L<benchmark|http://libev.schmorp.de/bench.html> comparing it to libevent
85for example). 99for example).
86 100
87=head2 CONVENTIONS 101=head2 CONVENTIONS
88 102
89Libev is very configurable. In this manual the default configuration will 103Libev is very configurable. In this manual the default (and most common)
90be described, which supports multiple event loops. For more info about 104configuration will be described, which supports multiple event loops. For
91various configuration options please have a look at B<EMBED> section in 105more info about various configuration options please have a look at
92this manual. If libev was configured without support for multiple event 106B<EMBED> section in this manual. If libev was configured without support
93loops, then all functions taking an initial argument of name C<loop> 107for multiple event loops, then all functions taking an initial argument of
94(which is always of type C<struct ev_loop *>) will not have this argument. 108name C<loop> (which is always of type C<struct ev_loop *>) will not have
109this argument.
95 110
96=head2 TIME REPRESENTATION 111=head2 TIME REPRESENTATION
97 112
98Libev represents time as a single floating point number, representing the 113Libev represents time as a single floating point number, representing the
99(fractional) number of seconds since the (POSIX) epoch (somewhere near 114(fractional) number of seconds since the (POSIX) epoch (somewhere near
241 256
242An event loop is described by a C<struct ev_loop *>. The library knows two 257An event loop is described by a C<struct ev_loop *>. The library knows two
243types of such loops, the I<default> loop, which supports signals and child 258types of such loops, the I<default> loop, which supports signals and child
244events, and dynamically created loops which do not. 259events, and dynamically created loops which do not.
245 260
246If you use threads, a common model is to run the default event loop
247in your main thread (or in a separate thread) and for each thread you
248create, you also create another event loop. Libev itself does no locking
249whatsoever, so if you mix calls to the same event loop in different
250threads, make sure you lock (this is usually a bad idea, though, even if
251done correctly, because it's hideous and inefficient).
252
253=over 4 261=over 4
254 262
255=item struct ev_loop *ev_default_loop (unsigned int flags) 263=item struct ev_loop *ev_default_loop (unsigned int flags)
256 264
257This will initialise the default event loop if it hasn't been initialised 265This will initialise the default event loop if it hasn't been initialised
259false. If it already was initialised it simply returns it (and ignores the 267false. If it already was initialised it simply returns it (and ignores the
260flags. If that is troubling you, check C<ev_backend ()> afterwards). 268flags. If that is troubling you, check C<ev_backend ()> afterwards).
261 269
262If you don't know what event loop to use, use the one returned from this 270If you don't know what event loop to use, use the one returned from this
263function. 271function.
272
273Note that this function is I<not> thread-safe, so if you want to use it
274from multiple threads, you have to lock (note also that this is unlikely,
275as loops cannot bes hared easily between threads anyway).
276
277The default loop is the only loop that can handle C<ev_signal> and
278C<ev_child> watchers, and to do this, it always registers a handler
279for C<SIGCHLD>. If this is a problem for your app you can either
280create a dynamic loop with C<ev_loop_new> that doesn't do that, or you
281can simply overwrite the C<SIGCHLD> signal handler I<after> calling
282C<ev_default_init>.
264 283
265The flags argument can be used to specify special behaviour or specific 284The flags argument can be used to specify special behaviour or specific
266backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>). 285backends to use, and is usually specified as C<0> (or C<EVFLAG_AUTO>).
267 286
268The following flags are supported: 287The following flags are supported:
290enabling this flag. 309enabling this flag.
291 310
292This works by calling C<getpid ()> on every iteration of the loop, 311This works by calling C<getpid ()> on every iteration of the loop,
293and thus this might slow down your event loop if you do a lot of loop 312and thus this might slow down your event loop if you do a lot of loop
294iterations and little real work, but is usually not noticeable (on my 313iterations and little real work, but is usually not noticeable (on my
295Linux system for example, C<getpid> is actually a simple 5-insn sequence 314GNU/Linux system for example, C<getpid> is actually a simple 5-insn sequence
296without a syscall and thus I<very> fast, but my Linux system also has 315without a syscall and thus I<very> fast, but my GNU/Linux system also has
297C<pthread_atfork> which is even faster). 316C<pthread_atfork> which is even faster).
298 317
299The big advantage of this flag is that you can forget about fork (and 318The big advantage of this flag is that you can forget about fork (and
300forget about forgetting to tell libev about forking) when you use this 319forget about forgetting to tell libev about forking) when you use this
301flag. 320flag.
332For few fds, this backend is a bit little slower than poll and select, 351For few fds, this backend is a bit little slower than poll and select,
333but it scales phenomenally better. While poll and select usually scale 352but it scales phenomenally better. While poll and select usually scale
334like O(total_fds) where n is the total number of fds (or the highest fd), 353like O(total_fds) where n is the total number of fds (or the highest fd),
335epoll scales either O(1) or O(active_fds). The epoll design has a number 354epoll scales either O(1) or O(active_fds). The epoll design has a number
336of shortcomings, such as silently dropping events in some hard-to-detect 355of shortcomings, such as silently dropping events in some hard-to-detect
337cases and rewiring a syscall per fd change, no fork support and bad 356cases and requiring a syscall per fd change, no fork support and bad
338support for dup. 357support for dup.
339 358
340While stopping, setting and starting an I/O watcher in the same iteration 359While stopping, setting and starting an I/O watcher in the same iteration
341will result in some caching, there is still a syscall per such incident 360will result in some caching, there is still a syscall per such incident
342(because the fd could point to a different file description now), so its 361(because the fd could point to a different file description now), so its
444Similar to C<ev_default_loop>, but always creates a new event loop that is 463Similar to C<ev_default_loop>, but always creates a new event loop that is
445always distinct from the default loop. Unlike the default loop, it cannot 464always distinct from the default loop. Unlike the default loop, it cannot
446handle signal and child watchers, and attempts to do so will be greeted by 465handle signal and child watchers, and attempts to do so will be greeted by
447undefined behaviour (or a failed assertion if assertions are enabled). 466undefined behaviour (or a failed assertion if assertions are enabled).
448 467
468Note that this function I<is> thread-safe, and the recommended way to use
469libev with threads is indeed to create one loop per thread, and using the
470default loop in the "main" or "initial" thread.
471
449Example: Try to create a event loop that uses epoll and nothing else. 472Example: Try to create a event loop that uses epoll and nothing else.
450 473
451 struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV); 474 struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
452 if (!epoller) 475 if (!epoller)
453 fatal ("no epoll found here, maybe it hides under your chair"); 476 fatal ("no epoll found here, maybe it hides under your chair");
476Like C<ev_default_destroy>, but destroys an event loop created by an 499Like C<ev_default_destroy>, but destroys an event loop created by an
477earlier call to C<ev_loop_new>. 500earlier call to C<ev_loop_new>.
478 501
479=item ev_default_fork () 502=item ev_default_fork ()
480 503
504This function sets a flag that causes subsequent C<ev_loop> iterations
481This function reinitialises the kernel state for backends that have 505to reinitialise the kernel state for backends that have one. Despite the
482one. Despite the name, you can call it anytime, but it makes most sense 506name, you can call it anytime, but it makes most sense after forking, in
483after forking, in either the parent or child process (or both, but that 507the child process (or both child and parent, but that again makes little
484again makes little sense). 508sense). You I<must> call it in the child before using any of the libev
509functions, and it will only take effect at the next C<ev_loop> iteration.
485 510
486You I<must> call this function in the child process after forking if and 511On the other hand, you only need to call this function in the child
487only if you want to use the event library in both processes. If you just 512process if and only if you want to use the event library in the child. If
488fork+exec, you don't have to call it. 513you just fork+exec, you don't have to call it at all.
489 514
490The function itself is quite fast and it's usually not a problem to call 515The function itself is quite fast and it's usually not a problem to call
491it just in case after a fork. To make this easy, the function will fit in 516it just in case after a fork. To make this easy, the function will fit in
492quite nicely into a call to C<pthread_atfork>: 517quite nicely into a call to C<pthread_atfork>:
493 518
494 pthread_atfork (0, 0, ev_default_fork); 519 pthread_atfork (0, 0, ev_default_fork);
495 520
496At the moment, C<EVBACKEND_SELECT> and C<EVBACKEND_POLL> are safe to use
497without calling this function, so if you force one of those backends you
498do not need to care.
499
500=item ev_loop_fork (loop) 521=item ev_loop_fork (loop)
501 522
502Like C<ev_default_fork>, but acts on an event loop created by 523Like C<ev_default_fork>, but acts on an event loop created by
503C<ev_loop_new>. Yes, you have to call this on every allocated event loop 524C<ev_loop_new>. Yes, you have to call this on every allocated event loop
504after fork, and how you do this is entirely your own problem. 525after fork, and how you do this is entirely your own problem.
526
527=item int ev_is_default_loop (loop)
528
529Returns true when the given loop actually is the default loop, false otherwise.
505 530
506=item unsigned int ev_loop_count (loop) 531=item unsigned int ev_loop_count (loop)
507 532
508Returns the count of loop iterations for the loop, which is identical to 533Returns the count of loop iterations for the loop, which is identical to
509the number of times libev did poll for new events. It starts at C<0> and 534the number of times libev did poll for new events. It starts at C<0> and
769=item C<EV_FORK> 794=item C<EV_FORK>
770 795
771The event loop has been resumed in the child process after fork (see 796The event loop has been resumed in the child process after fork (see
772C<ev_fork>). 797C<ev_fork>).
773 798
799=item C<EV_ASYNC>
800
801The given async watcher has been asynchronously notified (see C<ev_async>).
802
774=item C<EV_ERROR> 803=item C<EV_ERROR>
775 804
776An unspecified error has occured, the watcher has been stopped. This might 805An unspecified error has occured, the watcher has been stopped. This might
777happen because the watcher could not be properly started because libev 806happen because the watcher could not be properly started because libev
778ran out of memory, a file descriptor was found to be closed or any other 807ran out of memory, a file descriptor was found to be closed or any other
1057To support fork in your programs, you either have to call 1086To support fork in your programs, you either have to call
1058C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child, 1087C<ev_default_fork ()> or C<ev_loop_fork ()> after a fork in the child,
1059enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or 1088enable C<EVFLAG_FORKCHECK>, or resort to C<EVBACKEND_SELECT> or
1060C<EVBACKEND_POLL>. 1089C<EVBACKEND_POLL>.
1061 1090
1091=head3 The special problem of SIGPIPE
1092
1093While not really specific to libev, it is easy to forget about SIGPIPE:
1094when reading from a pipe whose other end has been closed, your program
1095gets send a SIGPIPE, which, by default, aborts your program. For most
1096programs this is sensible behaviour, for daemons, this is usually
1097undesirable.
1098
1099So when you encounter spurious, unexplained daemon exits, make sure you
1100ignore SIGPIPE (and maybe make sure you log the exit status of your daemon
1101somewhere, as that would have given you a big clue).
1102
1062 1103
1063=head3 Watcher-Specific Functions 1104=head3 Watcher-Specific Functions
1064 1105
1065=over 4 1106=over 4
1066 1107
1143configure a timer to trigger every 10 seconds, then it will trigger at 1184configure a timer to trigger every 10 seconds, then it will trigger at
1144exactly 10 second intervals. If, however, your program cannot keep up with 1185exactly 10 second intervals. If, however, your program cannot keep up with
1145the timer (because it takes longer than those 10 seconds to do stuff) the 1186the timer (because it takes longer than those 10 seconds to do stuff) the
1146timer will not fire more than once per event loop iteration. 1187timer will not fire more than once per event loop iteration.
1147 1188
1148=item ev_timer_again (loop) 1189=item ev_timer_again (loop, ev_timer *)
1149 1190
1150This will act as if the timer timed out and restart it again if it is 1191This will act as if the timer timed out and restart it again if it is
1151repeating. The exact semantics are: 1192repeating. The exact semantics are:
1152 1193
1153If the timer is pending, its pending status is cleared. 1194If the timer is pending, its pending status is cleared.
1262In this configuration the watcher triggers an event at the wallclock time 1303In this configuration the watcher triggers an event at the wallclock time
1263C<at> and doesn't repeat. It will not adjust when a time jump occurs, 1304C<at> and doesn't repeat. It will not adjust when a time jump occurs,
1264that is, if it is to be run at January 1st 2011 then it will run when the 1305that is, if it is to be run at January 1st 2011 then it will run when the
1265system time reaches or surpasses this time. 1306system time reaches or surpasses this time.
1266 1307
1267=item * non-repeating interval timer (at = offset, interval > 0, reschedule_cb = 0) 1308=item * repeating interval timer (at = offset, interval > 0, reschedule_cb = 0)
1268 1309
1269In this mode the watcher will always be scheduled to time out at the next 1310In this mode the watcher will always be scheduled to time out at the next
1270C<at + N * interval> time (for some integer N, which can also be negative) 1311C<at + N * interval> time (for some integer N, which can also be negative)
1271and then repeat, regardless of any time jumps. 1312and then repeat, regardless of any time jumps.
1272 1313
1406with the kernel (thus it coexists with your own signal handlers as long 1447with the kernel (thus it coexists with your own signal handlers as long
1407as you don't register any with libev). Similarly, when the last signal 1448as you don't register any with libev). Similarly, when the last signal
1408watcher for a signal is stopped libev will reset the signal handler to 1449watcher for a signal is stopped libev will reset the signal handler to
1409SIG_DFL (regardless of what it was set to before). 1450SIG_DFL (regardless of what it was set to before).
1410 1451
1452If possible and supported, libev will install its handlers with
1453C<SA_RESTART> behaviour enabled, so syscalls should not be unduly
1454interrupted. If you have a problem with syscalls getting interrupted by
1455signals you can block all signals in an C<ev_check> watcher and unblock
1456them in an C<ev_prepare> watcher.
1457
1411=head3 Watcher-Specific Functions and Data Members 1458=head3 Watcher-Specific Functions and Data Members
1412 1459
1413=over 4 1460=over 4
1414 1461
1415=item ev_signal_init (ev_signal *, callback, int signum) 1462=item ev_signal_init (ev_signal *, callback, int signum)
1423 1470
1424The signal the watcher watches out for. 1471The signal the watcher watches out for.
1425 1472
1426=back 1473=back
1427 1474
1475=head3 Examples
1476
1477Example: Try to exit cleanly on SIGINT and SIGTERM.
1478
1479 static void
1480 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
1481 {
1482 ev_unloop (loop, EVUNLOOP_ALL);
1483 }
1484
1485 struct ev_signal signal_watcher;
1486 ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
1487 ev_signal_start (loop, &sigint_cb);
1488
1428 1489
1429=head2 C<ev_child> - watch out for process status changes 1490=head2 C<ev_child> - watch out for process status changes
1430 1491
1431Child watchers trigger when your process receives a SIGCHLD in response to 1492Child watchers trigger when your process receives a SIGCHLD in response to
1432some child status changes (most typically when a child of yours dies). 1493some child status changes (most typically when a child of yours dies). It
1494is permissible to install a child watcher I<after> the child has been
1495forked (which implies it might have already exited), as long as the event
1496loop isn't entered (or is continued from a watcher).
1497
1498Only the default event loop is capable of handling signals, and therefore
1499you can only rgeister child watchers in the default event loop.
1500
1501=head3 Process Interaction
1502
1503Libev grabs C<SIGCHLD> as soon as the default event loop is
1504initialised. This is necessary to guarantee proper behaviour even if
1505the first child watcher is started after the child exits. The occurance
1506of C<SIGCHLD> is recorded asynchronously, but child reaping is done
1507synchronously as part of the event loop processing. Libev always reaps all
1508children, even ones not watched.
1509
1510=head3 Overriding the Built-In Processing
1511
1512Libev offers no special support for overriding the built-in child
1513processing, but if your application collides with libev's default child
1514handler, you can override it easily by installing your own handler for
1515C<SIGCHLD> after initialising the default loop, and making sure the
1516default loop never gets destroyed. You are encouraged, however, to use an
1517event-based approach to child reaping and thus use libev's support for
1518that, so other libev users can use C<ev_child> watchers freely.
1433 1519
1434=head3 Watcher-Specific Functions and Data Members 1520=head3 Watcher-Specific Functions and Data Members
1435 1521
1436=over 4 1522=over 4
1437 1523
1438=item ev_child_init (ev_child *, callback, int pid) 1524=item ev_child_init (ev_child *, callback, int pid, int trace)
1439 1525
1440=item ev_child_set (ev_child *, int pid) 1526=item ev_child_set (ev_child *, int pid, int trace)
1441 1527
1442Configures the watcher to wait for status changes of process C<pid> (or 1528Configures the watcher to wait for status changes of process C<pid> (or
1443I<any> process if C<pid> is specified as C<0>). The callback can look 1529I<any> process if C<pid> is specified as C<0>). The callback can look
1444at the C<rstatus> member of the C<ev_child> watcher structure to see 1530at the C<rstatus> member of the C<ev_child> watcher structure to see
1445the status word (use the macros from C<sys/wait.h> and see your systems 1531the status word (use the macros from C<sys/wait.h> and see your systems
1446C<waitpid> documentation). The C<rpid> member contains the pid of the 1532C<waitpid> documentation). The C<rpid> member contains the pid of the
1447process causing the status change. 1533process causing the status change. C<trace> must be either C<0> (only
1534activate the watcher when the process terminates) or C<1> (additionally
1535activate the watcher when the process is stopped or continued).
1448 1536
1449=item int pid [read-only] 1537=item int pid [read-only]
1450 1538
1451The process id this watcher watches out for, or C<0>, meaning any process id. 1539The process id this watcher watches out for, or C<0>, meaning any process id.
1452 1540
1461 1549
1462=back 1550=back
1463 1551
1464=head3 Examples 1552=head3 Examples
1465 1553
1466Example: Try to exit cleanly on SIGINT and SIGTERM. 1554Example: C<fork()> a new process and install a child handler to wait for
1555its completion.
1556
1557 ev_child cw;
1467 1558
1468 static void 1559 static void
1469 sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents) 1560 child_cb (EV_P_ struct ev_child *w, int revents)
1470 { 1561 {
1471 ev_unloop (loop, EVUNLOOP_ALL); 1562 ev_child_stop (EV_A_ w);
1563 printf ("process %d exited with status %x\n", w->rpid, w->rstatus);
1472 } 1564 }
1473 1565
1474 struct ev_signal signal_watcher; 1566 pid_t pid = fork ();
1475 ev_signal_init (&signal_watcher, sigint_cb, SIGINT); 1567
1476 ev_signal_start (loop, &sigint_cb); 1568 if (pid < 0)
1569 // error
1570 else if (pid == 0)
1571 {
1572 // the forked child executes here
1573 exit (1);
1574 }
1575 else
1576 {
1577 ev_child_init (&cw, child_cb, pid, 0);
1578 ev_child_start (EV_DEFAULT_ &cw);
1579 }
1477 1580
1478 1581
1479=head2 C<ev_stat> - did the file attributes just change? 1582=head2 C<ev_stat> - did the file attributes just change?
1480 1583
1481This watches a filesystem path for attribute changes. That is, it calls 1584This watches a filesystem path for attribute changes. That is, it calls
1510semantics of C<ev_stat> watchers, which means that libev sometimes needs 1613semantics of C<ev_stat> watchers, which means that libev sometimes needs
1511to fall back to regular polling again even with inotify, but changes are 1614to fall back to regular polling again even with inotify, but changes are
1512usually detected immediately, and if the file exists there will be no 1615usually detected immediately, and if the file exists there will be no
1513polling. 1616polling.
1514 1617
1618=head3 ABI Issues (Largefile Support)
1619
1620Libev by default (unless the user overrides this) uses the default
1621compilation environment, which means that on systems with optionally
1622disabled large file support, you get the 32 bit version of the stat
1623structure. When using the library from programs that change the ABI to
1624use 64 bit file offsets the programs will fail. In that case you have to
1625compile libev with the same flags to get binary compatibility. This is
1626obviously the case with any flags that change the ABI, but the problem is
1627most noticably with ev_stat and largefile support.
1628
1515=head3 Inotify 1629=head3 Inotify
1516 1630
1517When C<inotify (7)> support has been compiled into libev (generally only 1631When C<inotify (7)> support has been compiled into libev (generally only
1518available on Linux) and present at runtime, it will be used to speed up 1632available on Linux) and present at runtime, it will be used to speed up
1519change detection where possible. The inotify descriptor will be created lazily 1633change detection where possible. The inotify descriptor will be created lazily
1561 1675
1562The callback will be receive C<EV_STAT> when a change was detected, 1676The callback will be receive C<EV_STAT> when a change was detected,
1563relative to the attributes at the time the watcher was started (or the 1677relative to the attributes at the time the watcher was started (or the
1564last change was detected). 1678last change was detected).
1565 1679
1566=item ev_stat_stat (ev_stat *) 1680=item ev_stat_stat (loop, ev_stat *)
1567 1681
1568Updates the stat buffer immediately with new values. If you change the 1682Updates the stat buffer immediately with new values. If you change the
1569watched path in your callback, you could call this fucntion to avoid 1683watched path in your callback, you could call this fucntion to avoid
1570detecting this change (while introducing a race condition). Can also be 1684detecting this change (while introducing a race condition). Can also be
1571useful simply to find out the new values. 1685useful simply to find out the new values.
1688 static void 1802 static void
1689 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents) 1803 idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
1690 { 1804 {
1691 free (w); 1805 free (w);
1692 // now do something you wanted to do when the program has 1806 // now do something you wanted to do when the program has
1693 // no longer asnything immediate to do. 1807 // no longer anything immediate to do.
1694 } 1808 }
1695 1809
1696 struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle)); 1810 struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
1697 ev_idle_init (idle_watcher, idle_cb); 1811 ev_idle_init (idle_watcher, idle_cb);
1698 ev_idle_start (loop, idle_cb); 1812 ev_idle_start (loop, idle_cb);
2039believe me. 2153believe me.
2040 2154
2041=back 2155=back
2042 2156
2043 2157
2158=head2 C<ev_async> - how to wake up another event loop
2159
2160In general, you cannot use an C<ev_loop> from multiple threads or other
2161asynchronous sources such as signal handlers (as opposed to multiple event
2162loops - those are of course safe to use in different threads).
2163
2164Sometimes, however, you need to wake up another event loop you do not
2165control, for example because it belongs to another thread. This is what
2166C<ev_async> watchers do: as long as the C<ev_async> watcher is active, you
2167can signal it by calling C<ev_async_send>, which is thread- and signal
2168safe.
2169
2170This functionality is very similar to C<ev_signal> watchers, as signals,
2171too, are asynchronous in nature, and signals, too, will be compressed
2172(i.e. the number of callback invocations may be less than the number of
2173C<ev_async_sent> calls).
2174
2175Unlike C<ev_signal> watchers, C<ev_async> works with any event loop, not
2176just the default loop.
2177
2178=head3 Queueing
2179
2180C<ev_async> does not support queueing of data in any way. The reason
2181is that the author does not know of a simple (or any) algorithm for a
2182multiple-writer-single-reader queue that works in all cases and doesn't
2183need elaborate support such as pthreads.
2184
2185That means that if you want to queue data, you have to provide your own
2186queue. But at least I can tell you would implement locking around your
2187queue:
2188
2189=over 4
2190
2191=item queueing from a signal handler context
2192
2193To implement race-free queueing, you simply add to the queue in the signal
2194handler but you block the signal handler in the watcher callback. Here is an example that does that for
2195some fictitiuous SIGUSR1 handler:
2196
2197 static ev_async mysig;
2198
2199 static void
2200 sigusr1_handler (void)
2201 {
2202 sometype data;
2203
2204 // no locking etc.
2205 queue_put (data);
2206 ev_async_send (EV_DEFAULT_ &mysig);
2207 }
2208
2209 static void
2210 mysig_cb (EV_P_ ev_async *w, int revents)
2211 {
2212 sometype data;
2213 sigset_t block, prev;
2214
2215 sigemptyset (&block);
2216 sigaddset (&block, SIGUSR1);
2217 sigprocmask (SIG_BLOCK, &block, &prev);
2218
2219 while (queue_get (&data))
2220 process (data);
2221
2222 if (sigismember (&prev, SIGUSR1)
2223 sigprocmask (SIG_UNBLOCK, &block, 0);
2224 }
2225
2226(Note: pthreads in theory requires you to use C<pthread_setmask>
2227instead of C<sigprocmask> when you use threads, but libev doesn't do it
2228either...).
2229
2230=item queueing from a thread context
2231
2232The strategy for threads is different, as you cannot (easily) block
2233threads but you can easily preempt them, so to queue safely you need to
2234employ a traditional mutex lock, such as in this pthread example:
2235
2236 static ev_async mysig;
2237 static pthread_mutex_t mymutex = PTHREAD_MUTEX_INITIALIZER;
2238
2239 static void
2240 otherthread (void)
2241 {
2242 // only need to lock the actual queueing operation
2243 pthread_mutex_lock (&mymutex);
2244 queue_put (data);
2245 pthread_mutex_unlock (&mymutex);
2246
2247 ev_async_send (EV_DEFAULT_ &mysig);
2248 }
2249
2250 static void
2251 mysig_cb (EV_P_ ev_async *w, int revents)
2252 {
2253 pthread_mutex_lock (&mymutex);
2254
2255 while (queue_get (&data))
2256 process (data);
2257
2258 pthread_mutex_unlock (&mymutex);
2259 }
2260
2261=back
2262
2263
2264=head3 Watcher-Specific Functions and Data Members
2265
2266=over 4
2267
2268=item ev_async_init (ev_async *, callback)
2269
2270Initialises and configures the async watcher - it has no parameters of any
2271kind. There is a C<ev_asynd_set> macro, but using it is utterly pointless,
2272believe me.
2273
2274=item ev_async_send (loop, ev_async *)
2275
2276Sends/signals/activates the given C<ev_async> watcher, that is, feeds
2277an C<EV_ASYNC> event on the watcher into the event loop. Unlike
2278C<ev_feed_event>, this call is safe to do in other threads, signal or
2279similar contexts (see the dicusssion of C<EV_ATOMIC_T> in the embedding
2280section below on what exactly this means).
2281
2282This call incurs the overhead of a syscall only once per loop iteration,
2283so while the overhead might be noticable, it doesn't apply to repeated
2284calls to C<ev_async_send>.
2285
2286=item bool = ev_async_pending (ev_async *)
2287
2288Returns a non-zero value when C<ev_async_send> has been called on the
2289watcher but the event has not yet been processed (or even noted) by the
2290event loop.
2291
2292C<ev_async_send> sets a flag in the watcher and wakes up the loop. When
2293the loop iterates next and checks for the watcher to have become active,
2294it will reset the flag again. C<ev_async_pending> can be used to very
2295quickly check wether invoking the loop might be a good idea.
2296
2297Not that this does I<not> check wether the watcher itself is pending, only
2298wether it has been requested to make this watcher pending.
2299
2300=back
2301
2302
2044=head1 OTHER FUNCTIONS 2303=head1 OTHER FUNCTIONS
2045 2304
2046There are some other functions of possible interest. Described. Here. Now. 2305There are some other functions of possible interest. Described. Here. Now.
2047 2306
2048=over 4 2307=over 4
2275Example: Define a class with an IO and idle watcher, start one of them in 2534Example: Define a class with an IO and idle watcher, start one of them in
2276the constructor. 2535the constructor.
2277 2536
2278 class myclass 2537 class myclass
2279 { 2538 {
2280 ev_io io; void io_cb (ev::io &w, int revents); 2539 ev::io io; void io_cb (ev::io &w, int revents);
2281 ev_idle idle void idle_cb (ev::idle &w, int revents); 2540 ev:idle idle void idle_cb (ev::idle &w, int revents);
2282 2541
2283 myclass (); 2542 myclass (int fd)
2284 }
2285
2286 myclass::myclass (int fd)
2287 { 2543 {
2288 io .set <myclass, &myclass::io_cb > (this); 2544 io .set <myclass, &myclass::io_cb > (this);
2289 idle.set <myclass, &myclass::idle_cb> (this); 2545 idle.set <myclass, &myclass::idle_cb> (this);
2290 2546
2291 io.start (fd, ev::READ); 2547 io.start (fd, ev::READ);
2548 }
2292 } 2549 };
2550
2551
2552=head1 OTHER LANGUAGE BINDINGS
2553
2554Libev does not offer other language bindings itself, but bindings for a
2555numbe rof languages exist in the form of third-party packages. If you know
2556any interesting language binding in addition to the ones listed here, drop
2557me a note.
2558
2559=over 4
2560
2561=item Perl
2562
2563The EV module implements the full libev API and is actually used to test
2564libev. EV is developed together with libev. Apart from the EV core module,
2565there are additional modules that implement libev-compatible interfaces
2566to C<libadns> (C<EV::ADNS>), C<Net::SNMP> (C<Net::SNMP::EV>) and the
2567C<libglib> event core (C<Glib::EV> and C<EV::Glib>).
2568
2569It can be found and installed via CPAN, its homepage is found at
2570L<http://software.schmorp.de/pkg/EV>.
2571
2572=item Ruby
2573
2574Tony Arcieri has written a ruby extension that offers access to a subset
2575of the libev API and adds filehandle abstractions, asynchronous DNS and
2576more on top of it. It can be found via gem servers. Its homepage is at
2577L<http://rev.rubyforge.org/>.
2578
2579=item D
2580
2581Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
2582be found at L<http://git.llucax.com.ar/?p=software/ev.d.git;a=summary>.
2583
2584=back
2293 2585
2294 2586
2295=head1 MACRO MAGIC 2587=head1 MACRO MAGIC
2296 2588
2297Libev can be compiled with a variety of options, the most fundamantal 2589Libev can be compiled with a variety of options, the most fundamantal
2333 2625
2334=item C<EV_DEFAULT>, C<EV_DEFAULT_> 2626=item C<EV_DEFAULT>, C<EV_DEFAULT_>
2335 2627
2336Similar to the other two macros, this gives you the value of the default 2628Similar to the other two macros, this gives you the value of the default
2337loop, if multiple loops are supported ("ev loop default"). 2629loop, if multiple loops are supported ("ev loop default").
2630
2631=item C<EV_DEFAULT_UC>, C<EV_DEFAULT_UC_>
2632
2633Usage identical to C<EV_DEFAULT> and C<EV_DEFAULT_>, but requires that the
2634default loop has been initialised (C<UC> == unchecked). Their behaviour
2635is undefined when the default loop has not been initialised by a previous
2636execution of C<EV_DEFAULT>, C<EV_DEFAULT_> or C<ev_default_init (...)>.
2637
2638It is often prudent to use C<EV_DEFAULT> when initialising the first
2639watcher in a function but use C<EV_DEFAULT_UC> afterwards.
2338 2640
2339=back 2641=back
2340 2642
2341Example: Declare and initialise a check watcher, utilising the above 2643Example: Declare and initialise a check watcher, utilising the above
2342macros so it will work regardless of whether multiple loops are supported 2644macros so it will work regardless of whether multiple loops are supported
2438 2740
2439 libev.m4 2741 libev.m4
2440 2742
2441=head2 PREPROCESSOR SYMBOLS/MACROS 2743=head2 PREPROCESSOR SYMBOLS/MACROS
2442 2744
2443Libev can be configured via a variety of preprocessor symbols you have to define 2745Libev can be configured via a variety of preprocessor symbols you have to
2444before including any of its files. The default is not to build for multiplicity 2746define before including any of its files. The default in the absense of
2445and only include the select backend. 2747autoconf is noted for every option.
2446 2748
2447=over 4 2749=over 4
2448 2750
2449=item EV_STANDALONE 2751=item EV_STANDALONE
2450 2752
2476=item EV_USE_NANOSLEEP 2778=item EV_USE_NANOSLEEP
2477 2779
2478If defined to be C<1>, libev will assume that C<nanosleep ()> is available 2780If defined to be C<1>, libev will assume that C<nanosleep ()> is available
2479and will use it for delays. Otherwise it will use C<select ()>. 2781and will use it for delays. Otherwise it will use C<select ()>.
2480 2782
2783=item EV_USE_EVENTFD
2784
2785If defined to be C<1>, then libev will assume that C<eventfd ()> is
2786available and will probe for kernel support at runtime. This will improve
2787C<ev_signal> and C<ev_async> performance and reduce resource consumption.
2788If undefined, it will be enabled if the headers indicate GNU/Linux + Glibc
27892.7 or newer, otherwise disabled.
2790
2481=item EV_USE_SELECT 2791=item EV_USE_SELECT
2482 2792
2483If undefined or defined to be C<1>, libev will compile in support for the 2793If undefined or defined to be C<1>, libev will compile in support for the
2484C<select>(2) backend. No attempt at autodetection will be done: if no 2794C<select>(2) backend. No attempt at autodetection will be done: if no
2485other method takes over, select will be it. Otherwise the select backend 2795other method takes over, select will be it. Otherwise the select backend
2521 2831
2522=item EV_USE_EPOLL 2832=item EV_USE_EPOLL
2523 2833
2524If defined to be C<1>, libev will compile in support for the Linux 2834If defined to be C<1>, libev will compile in support for the Linux
2525C<epoll>(7) backend. Its availability will be detected at runtime, 2835C<epoll>(7) backend. Its availability will be detected at runtime,
2526otherwise another method will be used as fallback. This is the 2836otherwise another method will be used as fallback. This is the preferred
2527preferred backend for GNU/Linux systems. 2837backend for GNU/Linux systems. If undefined, it will be enabled if the
2838headers indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2528 2839
2529=item EV_USE_KQUEUE 2840=item EV_USE_KQUEUE
2530 2841
2531If defined to be C<1>, libev will compile in support for the BSD style 2842If defined to be C<1>, libev will compile in support for the BSD style
2532C<kqueue>(2) backend. Its actual availability will be detected at runtime, 2843C<kqueue>(2) backend. Its actual availability will be detected at runtime,
2551 2862
2552=item EV_USE_INOTIFY 2863=item EV_USE_INOTIFY
2553 2864
2554If defined to be C<1>, libev will compile in support for the Linux inotify 2865If defined to be C<1>, libev will compile in support for the Linux inotify
2555interface to speed up C<ev_stat> watchers. Its actual availability will 2866interface to speed up C<ev_stat> watchers. Its actual availability will
2556be detected at runtime. 2867be detected at runtime. If undefined, it will be enabled if the headers
2868indicate GNU/Linux + Glibc 2.4 or newer, otherwise disabled.
2869
2870=item EV_ATOMIC_T
2871
2872Libev requires an integer type (suitable for storing C<0> or C<1>) whose
2873access is atomic with respect to other threads or signal contexts. No such
2874type is easily found in the C language, so you can provide your own type
2875that you know is safe for your purposes. It is used both for signal handler "locking"
2876as well as for signal and thread safety in C<ev_async> watchers.
2877
2878In the absense of this define, libev will use C<sig_atomic_t volatile>
2879(from F<signal.h>), which is usually good enough on most platforms.
2557 2880
2558=item EV_H 2881=item EV_H
2559 2882
2560The name of the F<ev.h> header file used to include it. The default if 2883The name of the F<ev.h> header file used to include it. The default if
2561undefined is C<"ev.h"> in F<event.h> and F<ev.c>. This can be used to 2884undefined is C<"ev.h"> in F<event.h>, F<ev.c> and F<ev++.h>. This can be
2562virtually rename the F<ev.h> header file in case of conflicts. 2885used to virtually rename the F<ev.h> header file in case of conflicts.
2563 2886
2564=item EV_CONFIG_H 2887=item EV_CONFIG_H
2565 2888
2566If C<EV_STANDALONE> isn't C<1>, this variable can be used to override 2889If C<EV_STANDALONE> isn't C<1>, this variable can be used to override
2567F<ev.c>'s idea of where to find the F<config.h> file, similarly to 2890F<ev.c>'s idea of where to find the F<config.h> file, similarly to
2568C<EV_H>, above. 2891C<EV_H>, above.
2569 2892
2570=item EV_EVENT_H 2893=item EV_EVENT_H
2571 2894
2572Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea 2895Similarly to C<EV_H>, this macro can be used to override F<event.c>'s idea
2573of how the F<event.h> header can be found, the dfeault is C<"event.h">. 2896of how the F<event.h> header can be found, the default is C<"event.h">.
2574 2897
2575=item EV_PROTOTYPES 2898=item EV_PROTOTYPES
2576 2899
2577If defined to be C<0>, then F<ev.h> will not define any function 2900If defined to be C<0>, then F<ev.h> will not define any function
2578prototypes, but still define all the structs and other symbols. This is 2901prototypes, but still define all the structs and other symbols. This is
2627defined to be C<0>, then they are not. 2950defined to be C<0>, then they are not.
2628 2951
2629=item EV_FORK_ENABLE 2952=item EV_FORK_ENABLE
2630 2953
2631If undefined or defined to be C<1>, then fork watchers are supported. If 2954If undefined or defined to be C<1>, then fork watchers are supported. If
2955defined to be C<0>, then they are not.
2956
2957=item EV_ASYNC_ENABLE
2958
2959If undefined or defined to be C<1>, then async watchers are supported. If
2632defined to be C<0>, then they are not. 2960defined to be C<0>, then they are not.
2633 2961
2634=item EV_MINIMAL 2962=item EV_MINIMAL
2635 2963
2636If you need to shave off some kilobytes of code at the expense of some 2964If you need to shave off some kilobytes of code at the expense of some
2732 3060
2733 #include "ev_cpp.h" 3061 #include "ev_cpp.h"
2734 #include "ev.c" 3062 #include "ev.c"
2735 3063
2736 3064
3065=head1 THREADS AND COROUTINES
3066
3067=head2 THREADS
3068
3069Libev itself is completely threadsafe, but it uses no locking. This
3070means that you can use as many loops as you want in parallel, as long as
3071only one thread ever calls into one libev function with the same loop
3072parameter.
3073
3074Or put differently: calls with different loop parameters can be done in
3075parallel from multiple threads, calls with the same loop parameter must be
3076done serially (but can be done from different threads, as long as only one
3077thread ever is inside a call at any point in time, e.g. by using a mutex
3078per loop).
3079
3080If you want to know which design is best for your problem, then I cannot
3081help you but by giving some generic advice:
3082
3083=over 4
3084
3085=item * most applications have a main thread: use the default libev loop
3086in that thread, or create a seperate thread running only the default loop.
3087
3088This helps integrating other libraries or software modules that use libev
3089themselves and don't care/know about threading.
3090
3091=item * one loop per thread is usually a good model.
3092
3093Doing this is almost never wrong, sometimes a better-performance model
3094exists, but it is always a good start.
3095
3096=item * other models exist, such as the leader/follower pattern, where one
3097loop is handed through multiple threads in a kind of round-robbin fashion.
3098
3099Chosing a model is hard - look around, learn, know that usually you cna do
3100better than you currently do :-)
3101
3102=item * often you need to talk to some other thread which blocks in the
3103event loop - C<ev_async> watchers can be used to wake them up from other
3104threads safely (or from signal contexts...).
3105
3106=back
3107
3108=head2 COROUTINES
3109
3110Libev is much more accomodating to coroutines ("cooperative threads"):
3111libev fully supports nesting calls to it's functions from different
3112coroutines (e.g. you can call C<ev_loop> on the same loop from two
3113different coroutines and switch freely between both coroutines running the
3114loop, as long as you don't confuse yourself). The only exception is that
3115you must not do this from C<ev_periodic> reschedule callbacks.
3116
3117Care has been invested into making sure that libev does not keep local
3118state inside C<ev_loop>, and other calls do not usually allow coroutine
3119switches.
3120
3121
2737=head1 COMPLEXITIES 3122=head1 COMPLEXITIES
2738 3123
2739In this section the complexities of (many of) the algorithms used inside 3124In this section the complexities of (many of) the algorithms used inside
2740libev will be explained. For complexity discussions about backends see the 3125libev will be explained. For complexity discussions about backends see the
2741documentation for C<ev_default_init>. 3126documentation for C<ev_default_init>.
2757=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers) 3142=item Changing timer/periodic watchers (by autorepeat or calling again): O(log skipped_other_timers)
2758 3143
2759That means that changing a timer costs less than removing/adding them 3144That means that changing a timer costs less than removing/adding them
2760as only the relative motion in the event queue has to be paid for. 3145as only the relative motion in the event queue has to be paid for.
2761 3146
2762=item Starting io/check/prepare/idle/signal/child watchers: O(1) 3147=item Starting io/check/prepare/idle/signal/child/fork/async watchers: O(1)
2763 3148
2764These just add the watcher into an array or at the head of a list. 3149These just add the watcher into an array or at the head of a list.
2765 3150
2766=item Stopping check/prepare/idle watchers: O(1) 3151=item Stopping check/prepare/idle/fork/async watchers: O(1)
2767 3152
2768=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE)) 3153=item Stopping an io/signal/child watcher: O(number_of_watchers_for_this_(fd/signal/pid % EV_PID_HASHSIZE))
2769 3154
2770These watchers are stored in lists then need to be walked to find the 3155These watchers are stored in lists then need to be walked to find the
2771correct watcher to remove. The lists are usually short (you don't usually 3156correct watcher to remove. The lists are usually short (you don't usually
2787=item Priority handling: O(number_of_priorities) 3172=item Priority handling: O(number_of_priorities)
2788 3173
2789Priorities are implemented by allocating some space for each 3174Priorities are implemented by allocating some space for each
2790priority. When doing priority-based operations, libev usually has to 3175priority. When doing priority-based operations, libev usually has to
2791linearly search all the priorities, but starting/stopping and activating 3176linearly search all the priorities, but starting/stopping and activating
2792watchers becomes O(1) w.r.t. prioritiy handling. 3177watchers becomes O(1) w.r.t. priority handling.
3178
3179=item Sending an ev_async: O(1)
3180
3181=item Processing ev_async_send: O(number_of_async_watchers)
3182
3183=item Processing signals: O(max_signal_number)
3184
3185Sending involves a syscall I<iff> there were no other C<ev_async_send>
3186calls in the current loop iteration. Checking for async and signal events
3187involves iterating over all running async watchers or all signal numbers.
2793 3188
2794=back 3189=back
2795 3190
2796 3191
2797=head1 Win32 platform limitations and workarounds 3192=head1 Win32 platform limitations and workarounds

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines