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

Comparing libev/ev.pod (file contents):
Revision 1.198 by root, Thu Oct 23 06:30:48 2008 UTC vs.
Revision 1.205 by root, Mon Oct 27 12:20:32 2008 UTC

10 10
11 // a single header file is required 11 // a single header file is required
12 #include <ev.h> 12 #include <ev.h>
13 13
14 // every watcher type has its own typedef'd struct 14 // every watcher type has its own typedef'd struct
15 // with the name ev_<type> 15 // with the name ev_TYPE
16 ev_io stdin_watcher; 16 ev_io stdin_watcher;
17 ev_timer timeout_watcher; 17 ev_timer timeout_watcher;
18 18
19 // all watcher callbacks have a similar signature 19 // all watcher callbacks have a similar signature
20 // this callback is called when data is readable on stdin 20 // this callback is called when data is readable on stdin
276 276
277=back 277=back
278 278
279=head1 FUNCTIONS CONTROLLING THE EVENT LOOP 279=head1 FUNCTIONS CONTROLLING THE EVENT LOOP
280 280
281An event loop is described by a C<ev_loop *>. The library knows two 281An event loop is described by a C<struct ev_loop *> (the C<struct>
282types of such loops, the I<default> loop, which supports signals and child 282is I<not> optional in this case, as there is also an C<ev_loop>
283events, and dynamically created loops which do not. 283I<function>).
284
285The library knows two types of such loops, the I<default> loop, which
286supports signals and child events, and dynamically created loops which do
287not.
284 288
285=over 4 289=over 4
286 290
287=item struct ev_loop *ev_default_loop (unsigned int flags) 291=item struct ev_loop *ev_default_loop (unsigned int flags)
288 292
380=item C<EVBACKEND_EPOLL> (value 4, Linux) 384=item C<EVBACKEND_EPOLL> (value 4, Linux)
381 385
382For few fds, this backend is a bit little slower than poll and select, 386For few fds, this backend is a bit little slower than poll and select,
383but it scales phenomenally better. While poll and select usually scale 387but it scales phenomenally better. While poll and select usually scale
384like O(total_fds) where n is the total number of fds (or the highest fd), 388like O(total_fds) where n is the total number of fds (or the highest fd),
385epoll scales either O(1) or O(active_fds). The epoll design has a number 389epoll scales either O(1) or O(active_fds).
386of shortcomings, such as silently dropping events in some hard-to-detect 390
387cases and requiring a system call per fd change, no fork support and bad 391The epoll syscalls are the most misdesigned of the more advanced
388support for dup. 392event mechanisms: probelsm include silently dropping events in some
393hard-to-detect cases, requiring a system call per fd change, no fork
394support, problems with dup and so on.
395
396Epoll is also notoriously buggy - embedding epoll fds should work, but
397of course doesn't, and epoll just loves to report events for totally
398I<different> file descriptors (even already closed ones, so one cannot
399even remove them from the set) than registered in the set (especially
400on SMP systems). Libev tries to counter these spurious notifications by
401employing an additional generation counter and comparing that against the
402events to filter out spurious ones.
389 403
390While stopping, setting and starting an I/O watcher in the same iteration 404While stopping, setting and starting an I/O watcher in the same iteration
391will result in some caching, there is still a system call per such incident 405will result in some caching, there is still a system call per such incident
392(because the fd could point to a different file description now), so its 406(because the fd could point to a different file description now), so its
393best to avoid that. Also, C<dup ()>'ed file descriptors might not work 407best to avoid that. Also, C<dup ()>'ed file descriptors might not work
394very well if you register events for both fds. 408very well if you register events for both fds.
395
396Please note that epoll sometimes generates spurious notifications, so you
397need to use non-blocking I/O or other means to avoid blocking when no data
398(or space) is available.
399 409
400Best performance from this backend is achieved by not unregistering all 410Best performance from this backend is achieved by not unregistering all
401watchers for a file descriptor until it has been closed, if possible, 411watchers for a file descriptor until it has been closed, if possible,
402i.e. keep at least one watcher active per fd at all times. Stopping and 412i.e. keep at least one watcher active per fd at all times. Stopping and
403starting a watcher (without re-setting it) also usually doesn't cause 413starting a watcher (without re-setting it) also usually doesn't cause
527responsibility to either stop all watchers cleanly yourself I<before> 537responsibility to either stop all watchers cleanly yourself I<before>
528calling this function, or cope with the fact afterwards (which is usually 538calling this function, or cope with the fact afterwards (which is usually
529the easiest thing, you can just ignore the watchers and/or C<free ()> them 539the easiest thing, you can just ignore the watchers and/or C<free ()> them
530for example). 540for example).
531 541
532Note that certain global state, such as signal state, will not be freed by 542Note that certain global state, such as signal state (and installed signal
533this function, and related watchers (such as signal and child watchers) 543handlers), will not be freed by this function, and related watchers (such
534would need to be stopped manually. 544as signal and child watchers) would need to be stopped manually.
535 545
536In general it is not advisable to call this function except in the 546In general it is not advisable to call this function except in the
537rare occasion where you really need to free e.g. the signal handling 547rare occasion where you really need to free e.g. the signal handling
538pipe fds. If you need dynamically allocated loops it is better to use 548pipe fds. If you need dynamically allocated loops it is better to use
539C<ev_loop_new> and C<ev_loop_destroy>). 549C<ev_loop_new> and C<ev_loop_destroy>).
768they fire on, say, one-second boundaries only. 778they fire on, say, one-second boundaries only.
769 779
770=item ev_loop_verify (loop) 780=item ev_loop_verify (loop)
771 781
772This function only does something when C<EV_VERIFY> support has been 782This function only does something when C<EV_VERIFY> support has been
773compiled in. which is the default for non-minimal builds. It tries to go 783compiled in, which is the default for non-minimal builds. It tries to go
774through all internal structures and checks them for validity. If anything 784through all internal structures and checks them for validity. If anything
775is found to be inconsistent, it will print an error message to standard 785is found to be inconsistent, it will print an error message to standard
776error and call C<abort ()>. 786error and call C<abort ()>.
777 787
778This can be used to catch bugs inside libev itself: under normal 788This can be used to catch bugs inside libev itself: under normal
781 791
782=back 792=back
783 793
784 794
785=head1 ANATOMY OF A WATCHER 795=head1 ANATOMY OF A WATCHER
796
797In the following description, uppercase C<TYPE> in names stands for the
798watcher type, e.g. C<ev_TYPE_start> can mean C<ev_timer_start> for timer
799watchers and C<ev_io_start> for I/O watchers.
786 800
787A watcher is a structure that you create and register to record your 801A watcher is a structure that you create and register to record your
788interest in some event. For instance, if you want to wait for STDIN to 802interest in some event. For instance, if you want to wait for STDIN to
789become readable, you would create an C<ev_io> watcher for that: 803become readable, you would create an C<ev_io> watcher for that:
790 804
793 ev_io_stop (w); 807 ev_io_stop (w);
794 ev_unloop (loop, EVUNLOOP_ALL); 808 ev_unloop (loop, EVUNLOOP_ALL);
795 } 809 }
796 810
797 struct ev_loop *loop = ev_default_loop (0); 811 struct ev_loop *loop = ev_default_loop (0);
812
798 ev_io stdin_watcher; 813 ev_io stdin_watcher;
814
799 ev_init (&stdin_watcher, my_cb); 815 ev_init (&stdin_watcher, my_cb);
800 ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ); 816 ev_io_set (&stdin_watcher, STDIN_FILENO, EV_READ);
801 ev_io_start (loop, &stdin_watcher); 817 ev_io_start (loop, &stdin_watcher);
818
802 ev_loop (loop, 0); 819 ev_loop (loop, 0);
803 820
804As you can see, you are responsible for allocating the memory for your 821As you can see, you are responsible for allocating the memory for your
805watcher structures (and it is usually a bad idea to do this on the stack, 822watcher structures (and it is I<usually> a bad idea to do this on the
806although this can sometimes be quite valid). 823stack).
824
825Each watcher has an associated watcher structure (called C<struct ev_TYPE>
826or simply C<ev_TYPE>, as typedefs are provided for all watcher structs).
807 827
808Each watcher structure must be initialised by a call to C<ev_init 828Each watcher structure must be initialised by a call to C<ev_init
809(watcher *, callback)>, which expects a callback to be provided. This 829(watcher *, callback)>, which expects a callback to be provided. This
810callback gets invoked each time the event occurs (or, in the case of I/O 830callback gets invoked each time the event occurs (or, in the case of I/O
811watchers, each time the event loop detects that the file descriptor given 831watchers, each time the event loop detects that the file descriptor given
812is readable and/or writable). 832is readable and/or writable).
813 833
814Each watcher type has its own C<< ev_<type>_set (watcher *, ...) >> macro 834Each watcher type further has its own C<< ev_TYPE_set (watcher *, ...) >>
815with arguments specific to this watcher type. There is also a macro 835macro to configure it, with arguments specific to the watcher type. There
816to combine initialisation and setting in one call: C<< ev_<type>_init 836is also a macro to combine initialisation and setting in one call: C<<
817(watcher *, callback, ...) >>. 837ev_TYPE_init (watcher *, callback, ...) >>.
818 838
819To make the watcher actually watch out for events, you have to start it 839To make the watcher actually watch out for events, you have to start it
820with a watcher-specific start function (C<< ev_<type>_start (loop, watcher 840with a watcher-specific start function (C<< ev_TYPE_start (loop, watcher
821*) >>), and you can stop watching for events at any time by calling the 841*) >>), and you can stop watching for events at any time by calling the
822corresponding stop function (C<< ev_<type>_stop (loop, watcher *) >>. 842corresponding stop function (C<< ev_TYPE_stop (loop, watcher *) >>.
823 843
824As long as your watcher is active (has been started but not stopped) you 844As long as your watcher is active (has been started but not stopped) you
825must not touch the values stored in it. Most specifically you must never 845must not touch the values stored in it. Most specifically you must never
826reinitialise it or call its C<set> macro. 846reinitialise it or call its C<ev_TYPE_set> macro.
827 847
828Each and every callback receives the event loop pointer as first, the 848Each and every callback receives the event loop pointer as first, the
829registered watcher structure as second, and a bitset of received events as 849registered watcher structure as second, and a bitset of received events as
830third argument. 850third argument.
831 851
912 932
913=back 933=back
914 934
915=head2 GENERIC WATCHER FUNCTIONS 935=head2 GENERIC WATCHER FUNCTIONS
916 936
917In the following description, C<TYPE> stands for the watcher type,
918e.g. C<timer> for C<ev_timer> watchers and C<io> for C<ev_io> watchers.
919
920=over 4 937=over 4
921 938
922=item C<ev_init> (ev_TYPE *watcher, callback) 939=item C<ev_init> (ev_TYPE *watcher, callback)
923 940
924This macro initialises the generic portion of a watcher. The contents 941This macro initialises the generic portion of a watcher. The contents
1032The default priority used by watchers when no priority has been set is 1049The default priority used by watchers when no priority has been set is
1033always C<0>, which is supposed to not be too high and not be too low :). 1050always C<0>, which is supposed to not be too high and not be too low :).
1034 1051
1035Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is 1052Setting a priority outside the range of C<EV_MINPRI> to C<EV_MAXPRI> is
1036fine, as long as you do not mind that the priority value you query might 1053fine, as long as you do not mind that the priority value you query might
1037or might not have been adjusted to be within valid range. 1054or might not have been clamped to the valid range.
1038 1055
1039=item ev_invoke (loop, ev_TYPE *watcher, int revents) 1056=item ev_invoke (loop, ev_TYPE *watcher, int revents)
1040 1057
1041Invoke the C<watcher> with the given C<loop> and C<revents>. Neither 1058Invoke the C<watcher> with the given C<loop> and C<revents>. Neither
1042C<loop> nor C<revents> need to be valid as long as the watcher callback 1059C<loop> nor C<revents> need to be valid as long as the watcher callback
1288passed, but if multiple timers become ready during the same loop iteration 1305passed, but if multiple timers become ready during the same loop iteration
1289then order of execution is undefined. 1306then order of execution is undefined.
1290 1307
1291=head3 Be smart about timeouts 1308=head3 Be smart about timeouts
1292 1309
1293Many real-world problems invole some kind of time-out, usually for error 1310Many real-world problems involve some kind of timeout, usually for error
1294recovery. A typical example is an HTTP request - if the other side hangs, 1311recovery. A typical example is an HTTP request - if the other side hangs,
1295you want to raise some error after a while. 1312you want to raise some error after a while.
1296 1313
1297Here are some ways on how to handle this problem, from simple and 1314What follows are some ways to handle this problem, from obvious and
1298inefficient to very efficient. 1315inefficient to smart and efficient.
1299 1316
1300In the following examples a 60 second activity timeout is assumed - a 1317In the following, a 60 second activity timeout is assumed - a timeout that
1301timeout that gets reset to 60 seconds each time some data ("a lifesign") 1318gets reset to 60 seconds each time there is activity (e.g. each time some
1302was received. 1319data or other life sign was received).
1303 1320
1304=over 4 1321=over 4
1305 1322
1306=item 1. Use a timer and stop, reinitialise, start it on activity. 1323=item 1. Use a timer and stop, reinitialise and start it on activity.
1307 1324
1308This is the most obvious, but not the most simple way: In the beginning, 1325This is the most obvious, but not the most simple way: In the beginning,
1309start the watcher: 1326start the watcher:
1310 1327
1311 ev_timer_init (timer, callback, 60., 0.); 1328 ev_timer_init (timer, callback, 60., 0.);
1312 ev_timer_start (loop, timer); 1329 ev_timer_start (loop, timer);
1313 1330
1314Then, each time there is some activity, C<ev_timer_stop> the timer, 1331Then, each time there is some activity, C<ev_timer_stop> it, initialise it
1315initialise it again, and start it: 1332and start it again:
1316 1333
1317 ev_timer_stop (loop, timer); 1334 ev_timer_stop (loop, timer);
1318 ev_timer_set (timer, 60., 0.); 1335 ev_timer_set (timer, 60., 0.);
1319 ev_timer_start (loop, timer); 1336 ev_timer_start (loop, timer);
1320 1337
1321This is relatively simple to implement, but means that each time there 1338This is relatively simple to implement, but means that each time there is
1322is some activity, libev will first have to remove the timer from it's 1339some activity, libev will first have to remove the timer from its internal
1323internal data strcuture and then add it again. 1340data structure and then add it again. Libev tries to be fast, but it's
1341still not a constant-time operation.
1324 1342
1325=item 2. Use a timer and re-start it with C<ev_timer_again> inactivity. 1343=item 2. Use a timer and re-start it with C<ev_timer_again> inactivity.
1326 1344
1327This is the easiest way, and involves using C<ev_timer_again> instead of 1345This is the easiest way, and involves using C<ev_timer_again> instead of
1328C<ev_timer_start>. 1346C<ev_timer_start>.
1329 1347
1330For this, configure an C<ev_timer> with a C<repeat> value of C<60> and 1348To implement this, configure an C<ev_timer> with a C<repeat> value
1331then call C<ev_timer_again> at start and each time you successfully read 1349of C<60> and then call C<ev_timer_again> at start and each time you
1332or write some data. If you go into an idle state where you do not expect 1350successfully read or write some data. If you go into an idle state where
1333data to travel on the socket, you can C<ev_timer_stop> the timer, and 1351you do not expect data to travel on the socket, you can C<ev_timer_stop>
1334C<ev_timer_again> will automatically restart it if need be. 1352the timer, and C<ev_timer_again> will automatically restart it if need be.
1335 1353
1336That means you can ignore the C<after> value and C<ev_timer_start> 1354That means you can ignore both the C<ev_timer_start> function and the
1337altogether and only ever use the C<repeat> value and C<ev_timer_again>. 1355C<after> argument to C<ev_timer_set>, and only ever use the C<repeat>
1356member and C<ev_timer_again>.
1338 1357
1339At start: 1358At start:
1340 1359
1341 ev_timer_init (timer, callback, 0., 60.); 1360 ev_timer_init (timer, callback);
1361 timer->repeat = 60.;
1342 ev_timer_again (loop, timer); 1362 ev_timer_again (loop, timer);
1343 1363
1344Each time you receive some data: 1364Each time there is some activity:
1345 1365
1346 ev_timer_again (loop, timer); 1366 ev_timer_again (loop, timer);
1347 1367
1348It is even possible to change the time-out on the fly: 1368It is even possible to change the time-out on the fly, regardless of
1369whether the watcher is active or not:
1349 1370
1350 timer->repeat = 30.; 1371 timer->repeat = 30.;
1351 ev_timer_again (loop, timer); 1372 ev_timer_again (loop, timer);
1352 1373
1353This is slightly more efficient then stopping/starting the timer each time 1374This is slightly more efficient then stopping/starting the timer each time
1354you want to modify its timeout value, as libev does not have to completely 1375you want to modify its timeout value, as libev does not have to completely
1355remove and re-insert the timer from/into it's internal data structure. 1376remove and re-insert the timer from/into its internal data structure.
1377
1378It is, however, even simpler than the "obvious" way to do it.
1356 1379
1357=item 3. Let the timer time out, but then re-arm it as required. 1380=item 3. Let the timer time out, but then re-arm it as required.
1358 1381
1359This method is more tricky, but usually most efficient: Most timeouts are 1382This method is more tricky, but usually most efficient: Most timeouts are
1360relatively long compared to the loop iteration time - in our example, 1383relatively long compared to the intervals between other activity - in
1361within 60 seconds, there are usually many I/O events with associated 1384our example, within 60 seconds, there are usually many I/O events with
1362activity resets. 1385associated activity resets.
1363 1386
1364In this case, it would be more efficient to leave the C<ev_timer> alone, 1387In this case, it would be more efficient to leave the C<ev_timer> alone,
1365but remember the time of last activity, and check for a real timeout only 1388but remember the time of last activity, and check for a real timeout only
1366within the callback: 1389within the callback:
1367 1390
1368 ev_tstamp last_activity; // time of last activity 1391 ev_tstamp last_activity; // time of last activity
1369 1392
1370 static void 1393 static void
1371 callback (EV_P_ ev_timer *w, int revents) 1394 callback (EV_P_ ev_timer *w, int revents)
1372 { 1395 {
1373 ev_tstamp now = ev_now (EV_A); 1396 ev_tstamp now = ev_now (EV_A);
1374 ev_tstamp timeout = last_activity + 60.; 1397 ev_tstamp timeout = last_activity + 60.;
1375 1398
1376 // if last_activity is older than now - timeout, we did time out 1399 // if last_activity + 60. is older than now, we did time out
1377 if (timeout < now) 1400 if (timeout < now)
1378 { 1401 {
1379 // timeout occured, take action 1402 // timeout occured, take action
1380 } 1403 }
1381 else 1404 else
1382 { 1405 {
1383 // callback was invoked, but there was some activity, re-arm 1406 // callback was invoked, but there was some activity, re-arm
1384 // to fire in last_activity + 60. 1407 // the watcher to fire in last_activity + 60, which is
1408 // guaranteed to be in the future, so "again" is positive:
1385 w->again = timeout - now; 1409 w->again = timeout - now;
1386 ev_timer_again (EV_A_ w); 1410 ev_timer_again (EV_A_ w);
1387 } 1411 }
1388 } 1412 }
1389 1413
1390To summarise the callback: first calculate the real time-out (defined as 1414To summarise the callback: first calculate the real timeout (defined
1391"60 seconds after the last activity"), then check if that time has been 1415as "60 seconds after the last activity"), then check if that time has
1392reached, which means there was a real timeout. Otherwise the callback was 1416been reached, which means something I<did>, in fact, time out. Otherwise
1393invoked too early (timeout is in the future), so re-schedule the timer to 1417the callback was invoked too early (C<timeout> is in the future), so
1394fire at that future time. 1418re-schedule the timer to fire at that future time, to see if maybe we have
1419a timeout then.
1395 1420
1396Note how C<ev_timer_again> is used, taking advantage of the 1421Note how C<ev_timer_again> is used, taking advantage of the
1397C<ev_timer_again> optimisation when the timer is already running. 1422C<ev_timer_again> optimisation when the timer is already running.
1398 1423
1399This scheme causes more callback invocations (about one every 60 seconds), 1424This scheme causes more callback invocations (about one every 60 seconds
1400but virtually no calls to libev to change the timeout. 1425minus half the average time between activity), but virtually no calls to
1426libev to change the timeout.
1401 1427
1402To start the timer, simply intiialise the watcher and C<last_activity>, 1428To start the timer, simply initialise the watcher and set C<last_activity>
1403then call the callback: 1429to the current time (meaning we just have some activity :), then call the
1430callback, which will "do the right thing" and start the timer:
1404 1431
1405 ev_timer_init (timer, callback); 1432 ev_timer_init (timer, callback);
1406 last_activity = ev_now (loop); 1433 last_activity = ev_now (loop);
1407 callback (loop, timer, EV_TIMEOUT); 1434 callback (loop, timer, EV_TIMEOUT);
1408 1435
1409And when there is some activity, simply remember the time in 1436And when there is some activity, simply store the current time in
1410C<last_activity>: 1437C<last_activity>, no libev calls at all:
1411 1438
1412 last_actiivty = ev_now (loop); 1439 last_actiivty = ev_now (loop);
1413 1440
1414This technique is slightly more complex, but in most cases where the 1441This technique is slightly more complex, but in most cases where the
1415time-out is unlikely to be triggered, much more efficient. 1442time-out is unlikely to be triggered, much more efficient.
1416 1443
1444Changing the timeout is trivial as well (if it isn't hard-coded in the
1445callback :) - just change the timeout and invoke the callback, which will
1446fix things for you.
1447
1448=item 4. Wee, just use a double-linked list for your timeouts.
1449
1450If there is not one request, but many thousands (millions...), all
1451employing some kind of timeout with the same timeout value, then one can
1452do even better:
1453
1454When starting the timeout, calculate the timeout value and put the timeout
1455at the I<end> of the list.
1456
1457Then use an C<ev_timer> to fire when the timeout at the I<beginning> of
1458the list is expected to fire (for example, using the technique #3).
1459
1460When there is some activity, remove the timer from the list, recalculate
1461the timeout, append it to the end of the list again, and make sure to
1462update the C<ev_timer> if it was taken from the beginning of the list.
1463
1464This way, one can manage an unlimited number of timeouts in O(1) time for
1465starting, stopping and updating the timers, at the expense of a major
1466complication, and having to use a constant timeout. The constant timeout
1467ensures that the list stays sorted.
1468
1417=back 1469=back
1470
1471So which method the best?
1472
1473Method #2 is a simple no-brain-required solution that is adequate in most
1474situations. Method #3 requires a bit more thinking, but handles many cases
1475better, and isn't very complicated either. In most case, choosing either
1476one is fine, with #3 being better in typical situations.
1477
1478Method #1 is almost always a bad idea, and buys you nothing. Method #4 is
1479rather complicated, but extremely efficient, something that really pays
1480off after the first million or so of active timers, i.e. it's usually
1481overkill :)
1418 1482
1419=head3 The special problem of time updates 1483=head3 The special problem of time updates
1420 1484
1421Establishing the current time is a costly operation (it usually takes at 1485Establishing the current time is a costly operation (it usually takes at
1422least two system calls): EV therefore updates its idea of the current 1486least two system calls): EV therefore updates its idea of the current
2900=item D 2964=item D
2901 2965
2902Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to 2966Leandro Lucarella has written a D language binding (F<ev.d>) for libev, to
2903be found at L<http://proj.llucax.com.ar/wiki/evd>. 2967be found at L<http://proj.llucax.com.ar/wiki/evd>.
2904 2968
2969=item Ocaml
2970
2971Erkki Seppala has written Ocaml bindings for libev, to be found at
2972L<http://modeemi.cs.tut.fi/~flux/software/ocaml-ev/>.
2973
2905=back 2974=back
2906 2975
2907 2976
2908=head1 MACRO MAGIC 2977=head1 MACRO MAGIC
2909 2978

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines