ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/AIO.pm
(Generate patch)

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.42 by root, Mon Dec 26 18:15:23 2005 UTC vs.
Revision 1.99 by root, Sun Jan 7 21:32:20 2007 UTC

5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use IO::AIO; 7 use IO::AIO;
8 8
9 aio_open "/etc/passwd", O_RDONLY, 0, sub { 9 aio_open "/etc/passwd", O_RDONLY, 0, sub {
10 my ($fh) = @_; 10 my $fh = shift
11 or die "/etc/passwd: $!";
11 ... 12 ...
12 }; 13 };
13 14
14 aio_unlink "/tmp/file", sub { }; 15 aio_unlink "/tmp/file", sub { };
15 16
16 aio_read $fh, 30000, 1024, $buffer, 0, sub { 17 aio_read $fh, 30000, 1024, $buffer, 0, sub {
17 $_[0] > 0 or die "read error: $!"; 18 $_[0] > 0 or die "read error: $!";
18 }; 19 };
19 20
20 # AnyEvent 21 # version 2+ has request and group objects
22 use IO::AIO 2;
23
24 aioreq_pri 4; # give next request a very high priority
25 my $req = aio_unlink "/tmp/file", sub { };
26 $req->cancel; # cancel request if still in queue
27
28 my $grp = aio_group sub { print "all stats done\n" };
29 add $grp aio_stat "..." for ...;
30
31 # AnyEvent integration
21 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; 32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
22 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); 33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
23 34
24 # Event 35 # Event integration
25 Event->io (fd => IO::AIO::poll_fileno, 36 Event->io (fd => IO::AIO::poll_fileno,
26 poll => 'r', 37 poll => 'r',
27 cb => \&IO::AIO::poll_cb); 38 cb => \&IO::AIO::poll_cb);
28 39
29 # Glib/Gtk2 40 # Glib/Gtk2 integration
30 add_watch Glib::IO IO::AIO::poll_fileno, 41 add_watch Glib::IO IO::AIO::poll_fileno,
31 in => sub { IO::AIO::poll_cb; 1 }; 42 in => sub { IO::AIO::poll_cb; 1 };
32 43
33 # Tk 44 # Tk integration
34 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", 45 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
35 readable => \&IO::AIO::poll_cb); 46 readable => \&IO::AIO::poll_cb);
36 47
37 # Danga::Socket 48 # Danga::Socket integration
38 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => 49 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
39 \&IO::AIO::poll_cb); 50 \&IO::AIO::poll_cb);
40 51
41
42=head1 DESCRIPTION 52=head1 DESCRIPTION
43 53
44This module implements asynchronous I/O using whatever means your 54This module implements asynchronous I/O using whatever means your
45operating system supports. 55operating system supports.
46 56
57Asynchronous means that operations that can normally block your program
58(e.g. reading from disk) will be done asynchronously: the operation
59will still block, but you can do something else in the meantime. This
60is extremely useful for programs that need to stay interactive even
61when doing heavy I/O (GUI programs, high performance network servers
62etc.), but can also be used to easily do operations in parallel that are
63normally done sequentially, e.g. stat'ing many files, which is much faster
64on a RAID volume or over NFS when you do a number of stat operations
65concurrently.
66
67While most of this works on all types of file descriptors (for example
68sockets), using these functions on file descriptors that support
69nonblocking operation (again, sockets, pipes etc.) is very inefficient or
70might not work (aio_read fails on sockets/pipes/fifos). Use an event loop
71for that (such as the L<Event|Event> module): IO::AIO will naturally fit
72into such an event loop itself.
73
47Currently, a number of threads are started that execute your read/writes 74In this version, a number of threads are started that execute your
48and signal their completion. You don't need thread support in your libc or 75requests and signal their completion. You don't need thread support
49perl, and the threads created by this module will not be visible to the 76in perl, and the threads created by this module will not be visible
50pthreads library. In the future, this module might make use of the native 77to perl. In the future, this module might make use of the native aio
51aio functions available on many operating systems. However, they are often 78functions available on many operating systems. However, they are often
52not well-supported (Linux doesn't allow them on normal files currently, 79not well-supported or restricted (GNU/Linux doesn't allow them on normal
53for example), and they would only support aio_read and aio_write, so the 80files currently, for example), and they would only support aio_read and
54remaining functionality would have to be implemented using threads anyway. 81aio_write, so the remaining functionality would have to be implemented
82using threads anyway.
55 83
56Although the module will work with in the presence of other threads, it is 84Although the module will work with in the presence of other (Perl-)
57currently not reentrant, so use appropriate locking yourself, always call 85threads, it is currently not reentrant in any way, so use appropriate
58C<poll_cb> from within the same thread, or never call C<poll_cb> (or other 86locking yourself, always call C<poll_cb> from within the same thread, or
59C<aio_> functions) recursively. 87never call C<poll_cb> (or other C<aio_> functions) recursively.
88
89=head2 EXAMPLE
90
91This is a simple example that uses the Event module and loads
92F</etc/passwd> asynchronously:
93
94 use Fcntl;
95 use Event;
96 use IO::AIO;
97
98 # register the IO::AIO callback with Event
99 Event->io (fd => IO::AIO::poll_fileno,
100 poll => 'r',
101 cb => \&IO::AIO::poll_cb);
102
103 # queue the request to open /etc/passwd
104 aio_open "/etc/passwd", O_RDONLY, 0, sub {
105 my $fh = shift
106 or die "error while opening: $!";
107
108 # stat'ing filehandles is generally non-blocking
109 my $size = -s $fh;
110
111 # queue a request to read the file
112 my $contents;
113 aio_read $fh, 0, $size, $contents, 0, sub {
114 $_[0] == $size
115 or die "short read: $!";
116
117 close $fh;
118
119 # file contents now in $contents
120 print $contents;
121
122 # exit event loop and program
123 Event::unloop;
124 };
125 };
126
127 # possibly queue up other requests, or open GUI windows,
128 # check for sockets etc. etc.
129
130 # process events as long as there are some:
131 Event::loop;
132
133=head1 REQUEST ANATOMY AND LIFETIME
134
135Every C<aio_*> function creates a request. which is a C data structure not
136directly visible to Perl.
137
138If called in non-void context, every request function returns a Perl
139object representing the request. In void context, nothing is returned,
140which saves a bit of memory.
141
142The perl object is a fairly standard ref-to-hash object. The hash contents
143are not used by IO::AIO so you are free to store anything you like in it.
144
145During their existance, aio requests travel through the following states,
146in order:
147
148=over 4
149
150=item ready
151
152Immediately after a request is created it is put into the ready state,
153waiting for a thread to execute it.
154
155=item execute
156
157A thread has accepted the request for processing and is currently
158executing it (e.g. blocking in read).
159
160=item pending
161
162The request has been executed and is waiting for result processing.
163
164While request submission and execution is fully asynchronous, result
165processing is not and relies on the perl interpreter calling C<poll_cb>
166(or another function with the same effect).
167
168=item result
169
170The request results are processed synchronously by C<poll_cb>.
171
172The C<poll_cb> function will process all outstanding aio requests by
173calling their callbacks, freeing memory associated with them and managing
174any groups they are contained in.
175
176=item done
177
178Request has reached the end of its lifetime and holds no resources anymore
179(except possibly for the Perl object, but its connection to the actual
180aio request is severed and calling its methods will either do nothing or
181result in a runtime error).
182
183=back
60 184
61=cut 185=cut
62 186
63package IO::AIO; 187package IO::AIO;
64 188
65no warnings; 189no warnings;
190use strict 'vars';
66 191
67use base 'Exporter'; 192use base 'Exporter';
68 193
69use Fcntl ();
70
71BEGIN { 194BEGIN {
72 $VERSION = '1.61'; 195 our $VERSION = '2.32';
73 196
74 @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 197 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
75 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 198 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
76 aio_fsync aio_fdatasync aio_readahead); 199 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link
77 @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel 200 aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree);
78 max_outstanding nreqs); 201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block));
202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
203 min_parallel max_parallel max_idle
204 nreqs nready npending nthreads
205 max_poll_time max_poll_reqs);
206
207 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
79 208
80 require XSLoader; 209 require XSLoader;
81 XSLoader::load IO::AIO, $VERSION; 210 XSLoader::load ("IO::AIO", $VERSION);
82} 211}
83 212
84=head1 FUNCTIONS 213=head1 FUNCTIONS
85 214
86=head2 AIO FUNCTIONS 215=head2 AIO REQUEST FUNCTIONS
87 216
88All the C<aio_*> calls are more or less thin wrappers around the syscall 217All the C<aio_*> calls are more or less thin wrappers around the syscall
89with the same name (sans C<aio_>). The arguments are similar or identical, 218with the same name (sans C<aio_>). The arguments are similar or identical,
90and they all accept an additional (and optional) C<$callback> argument 219and they all accept an additional (and optional) C<$callback> argument
91which must be a code reference. This code reference will get called with 220which must be a code reference. This code reference will get called with
94syscall has been executed asynchronously. 223syscall has been executed asynchronously.
95 224
96All functions expecting a filehandle keep a copy of the filehandle 225All functions expecting a filehandle keep a copy of the filehandle
97internally until the request has finished. 226internally until the request has finished.
98 227
228All functions return request objects of type L<IO::AIO::REQ> that allow
229further manipulation of those requests while they are in-flight.
230
99The pathnames you pass to these routines I<must> be absolute and 231The pathnames you pass to these routines I<must> be absolute and
100encoded in byte form. The reason for the former is that at the time the 232encoded as octets. The reason for the former is that at the time the
101request is being executed, the current working directory could have 233request is being executed, the current working directory could have
102changed. Alternatively, you can make sure that you never change the 234changed. Alternatively, you can make sure that you never change the
103current working directory. 235current working directory anywhere in the program and then use relative
236paths.
104 237
105To encode pathnames to byte form, either make sure you either: a) 238To encode pathnames as octets, either make sure you either: a) always pass
106always pass in filenames you got from outside (command line, readdir 239in filenames you got from outside (command line, readdir etc.) without
107etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode 240tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode
108your pathnames to the locale (or other) encoding in effect in the user 241your pathnames to the locale (or other) encoding in effect in the user
109environment, d) use Glib::filename_from_unicode on unicode filenames or e) 242environment, d) use Glib::filename_from_unicode on unicode filenames or e)
110use something else. 243use something else to ensure your scalar has the correct contents.
244
245This works, btw. independent of the internal UTF-8 bit, which IO::AIO
246handles correctly wether it is set or not.
111 247
112=over 4 248=over 4
249
250=item $prev_pri = aioreq_pri [$pri]
251
252Returns the priority value that would be used for the next request and, if
253C<$pri> is given, sets the priority for the next aio request.
254
255The default priority is C<0>, the minimum and maximum priorities are C<-4>
256and C<4>, respectively. Requests with higher priority will be serviced
257first.
258
259The priority will be reset to C<0> after each call to one of the C<aio_*>
260functions.
261
262Example: open a file with low priority, then read something from it with
263higher priority so the read request is serviced before other low priority
264open requests (potentially spamming the cache):
265
266 aioreq_pri -3;
267 aio_open ..., sub {
268 return unless $_[0];
269
270 aioreq_pri -2;
271 aio_read $_[0], ..., sub {
272 ...
273 };
274 };
275
276=item aioreq_nice $pri_adjust
277
278Similar to C<aioreq_pri>, but subtracts the given value from the current
279priority, so the effect is cumulative.
113 280
114=item aio_open $pathname, $flags, $mode, $callback->($fh) 281=item aio_open $pathname, $flags, $mode, $callback->($fh)
115 282
116Asynchronously open or create a file and call the callback with a newly 283Asynchronously open or create a file and call the callback with a newly
117created filehandle for the file. 284created filehandle for the file.
232=item aio_unlink $pathname, $callback->($status) 399=item aio_unlink $pathname, $callback->($status)
233 400
234Asynchronously unlink (delete) a file and call the callback with the 401Asynchronously unlink (delete) a file and call the callback with the
235result code. 402result code.
236 403
404=item aio_mknod $path, $mode, $dev, $callback->($status)
405
406[EXPERIMENTAL]
407
408Asynchronously create a device node (or fifo). See mknod(2).
409
410The only (POSIX-) portable way of calling this function is:
411
412 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
413
414=item aio_link $srcpath, $dstpath, $callback->($status)
415
416Asynchronously create a new link to the existing object at C<$srcpath> at
417the path C<$dstpath> and call the callback with the result code.
418
419=item aio_symlink $srcpath, $dstpath, $callback->($status)
420
421Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
422the path C<$dstpath> and call the callback with the result code.
423
424=item aio_readlink $path, $callback->($link)
425
426Asynchronously read the symlink specified by C<$path> and pass it to
427the callback. If an error occurs, nothing or undef gets passed to the
428callback.
429
430=item aio_rename $srcpath, $dstpath, $callback->($status)
431
432Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
433rename(2) and call the callback with the result code.
434
237=item aio_rmdir $pathname, $callback->($status) 435=item aio_rmdir $pathname, $callback->($status)
238 436
239Asynchronously rmdir (delete) a directory and call the callback with the 437Asynchronously rmdir (delete) a directory and call the callback with the
240result code. 438result code.
241 439
242=item aio_readdir $pathname $callback->($entries) 440=item aio_readdir $pathname, $callback->($entries)
243 441
244Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 442Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
245directory (i.e. opendir + readdir + closedir). The entries will not be 443directory (i.e. opendir + readdir + closedir). The entries will not be
246sorted, and will B<NOT> include the C<.> and C<..> entries. 444sorted, and will B<NOT> include the C<.> and C<..> entries.
247 445
248The callback a single argument which is either C<undef> or an array-ref 446The callback a single argument which is either C<undef> or an array-ref
249with the filenames. 447with the filenames.
250 448
449=item aio_load $path, $data, $callback->($status)
450
451This is a composite request that tries to fully load the given file into
452memory. Status is the same as with aio_read.
453
454=cut
455
456sub aio_load($$;$) {
457 aio_block {
458 my ($path, undef, $cb) = @_;
459 my $data = \$_[1];
460
461 my $pri = aioreq_pri;
462 my $grp = aio_group $cb;
463
464 aioreq_pri $pri;
465 add $grp aio_open $path, O_RDONLY, 0, sub {
466 my ($fh) = @_
467 or return $grp->result (-1);
468
469 aioreq_pri $pri;
470 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
471 $grp->result ($_[0]);
472 };
473 };
474
475 $grp
476 }
477}
478
479=item aio_copy $srcpath, $dstpath, $callback->($status)
480
481Try to copy the I<file> (directories not supported as either source or
482destination) from C<$srcpath> to C<$dstpath> and call the callback with
483the C<0> (error) or C<-1> ok.
484
485This is a composite request that it creates the destination file with
486mode 0200 and copies the contents of the source file into it using
487C<aio_sendfile>, followed by restoring atime, mtime, access mode and
488uid/gid, in that order.
489
490If an error occurs, the partial destination file will be unlinked, if
491possible, except when setting atime, mtime, access mode and uid/gid, where
492errors are being ignored.
493
494=cut
495
496sub aio_copy($$;$) {
497 aio_block {
498 my ($src, $dst, $cb) = @_;
499
500 my $pri = aioreq_pri;
501 my $grp = aio_group $cb;
502
503 aioreq_pri $pri;
504 add $grp aio_open $src, O_RDONLY, 0, sub {
505 if (my $src_fh = $_[0]) {
506 my @stat = stat $src_fh;
507
508 aioreq_pri $pri;
509 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
510 if (my $dst_fh = $_[0]) {
511 aioreq_pri $pri;
512 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
513 if ($_[0] == $stat[7]) {
514 $grp->result (0);
515 close $src_fh;
516
517 # those should not normally block. should. should.
518 utime $stat[8], $stat[9], $dst;
519 chmod $stat[2] & 07777, $dst_fh;
520 chown $stat[4], $stat[5], $dst_fh;
521 close $dst_fh;
522 } else {
523 $grp->result (-1);
524 close $src_fh;
525 close $dst_fh;
526
527 aioreq $pri;
528 add $grp aio_unlink $dst;
529 }
530 };
531 } else {
532 $grp->result (-1);
533 }
534 },
535
536 } else {
537 $grp->result (-1);
538 }
539 };
540
541 $grp
542 }
543}
544
545=item aio_move $srcpath, $dstpath, $callback->($status)
546
547Try to move the I<file> (directories not supported as either source or
548destination) from C<$srcpath> to C<$dstpath> and call the callback with
549the C<0> (error) or C<-1> ok.
550
551This is a composite request that tries to rename(2) the file first. If
552rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if
553that is successful, unlinking the C<$srcpath>.
554
555=cut
556
557sub aio_move($$;$) {
558 aio_block {
559 my ($src, $dst, $cb) = @_;
560
561 my $pri = aioreq_pri;
562 my $grp = aio_group $cb;
563
564 aioreq_pri $pri;
565 add $grp aio_rename $src, $dst, sub {
566 if ($_[0] && $! == EXDEV) {
567 aioreq_pri $pri;
568 add $grp aio_copy $src, $dst, sub {
569 $grp->result ($_[0]);
570
571 if (!$_[0]) {
572 aioreq_pri $pri;
573 add $grp aio_unlink $src;
574 }
575 };
576 } else {
577 $grp->result ($_[0]);
578 }
579 };
580
581 $grp
582 }
583}
584
251=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 585=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
252 586
253Scans a directory (similar to C<aio_readdir>) and tries to separate the 587Scans a directory (similar to C<aio_readdir>) but additionally tries to
254entries of directory C<$path> into two sets of names, ones you can recurse 588efficiently separate the entries of directory C<$path> into two sets of
255into (directories), and ones you cannot recurse into (everything else). 589names, directories you can recurse into (directories), and ones you cannot
590recurse into (everything else, including symlinks to directories).
256 591
257C<aio_scandir> is a composite request that consists of many 592C<aio_scandir> is a composite request that creates of many sub requests_
258aio-primitives. C<$maxreq> specifies the maximum number of outstanding 593C<$maxreq> specifies the maximum number of outstanding aio requests that
259aio requests that this function generates. If it is C<< <= 0 >>, then a 594this function generates. If it is C<< <= 0 >>, then a suitable default
260suitable default will be chosen (currently 8). 595will be chosen (currently 4).
261 596
262On error, the callback is called without arguments, otherwise it receives 597On error, the callback is called without arguments, otherwise it receives
263two array-refs with path-relative entry names. 598two array-refs with path-relative entry names.
264 599
265Example: 600Example:
273Implementation notes. 608Implementation notes.
274 609
275The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. 610The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
276 611
277After reading the directory, the modification time, size etc. of the 612After reading the directory, the modification time, size etc. of the
278directory before and after the readdir is checked, and if they match, the 613directory before and after the readdir is checked, and if they match (and
279link count will be used to decide how many entries are directories (if 614isn't the current time), the link count will be used to decide how many
280>= 2). Otherwise, no knowledge of the number of subdirectories will be 615entries are directories (if >= 2). Otherwise, no knowledge of the number
281assumed. 616of subdirectories will be assumed.
282 617
283Then entires will be sorted into likely directories (everything without a 618Then entries will be sorted into likely directories (everything without
284non-initial dot) and likely non-directories (everything else). Then every 619a non-initial dot currently) and likely non-directories (everything
285entry + C</.> will be C<stat>'ed, likely directories first. This is often 620else). Then every entry plus an appended C</.> will be C<stat>'ed,
621likely directories first. If that succeeds, it assumes that the entry
622is a directory or a symlink to directory (which will be checked
623seperately). This is often faster than stat'ing the entry itself because
286faster because filesystems might detect the type of the entry without 624filesystems might detect the type of the entry without reading the inode
287reading the inode data (e.g. ext2s filetype feature). If that succeeds, 625data (e.g. ext2fs filetype feature).
288it assumes that the entry is a directory or a symlink to directory (which
289will be checked seperately).
290 626
291If the known number of directories has been reached, the rest of the 627If the known number of directories (link count - 2) has been reached, the
292entries is assumed to be non-directories. 628rest of the entries is assumed to be non-directories.
629
630This only works with certainty on POSIX (= UNIX) filesystems, which
631fortunately are the vast majority of filesystems around.
632
633It will also likely work on non-POSIX filesystems with reduced efficiency
634as those tend to return 0 or 1 as link counts, which disables the
635directory counting heuristic.
293 636
294=cut 637=cut
295 638
296sub aio_scandir($$$) { 639sub aio_scandir($$$) {
640 aio_block {
297 my ($path, $maxreq, $cb) = @_; 641 my ($path, $maxreq, $cb) = @_;
298 642
643 my $pri = aioreq_pri;
644
645 my $grp = aio_group $cb;
646
299 $maxreq = 8 if $maxreq <= 0; 647 $maxreq = 4 if $maxreq <= 0;
300 648
301 # stat once 649 # stat once
650 aioreq_pri $pri;
302 aio_stat $path, sub { 651 add $grp aio_stat $path, sub {
303 $cb->() if $_[0]; 652 return $grp->result () if $_[0];
653 my $now = time;
304 my $hash1 = join ":", (stat _)[0,1,3,7,9]; 654 my $hash1 = join ":", (stat _)[0,1,3,7,9];
305 655
306 # read the directory entries 656 # read the directory entries
657 aioreq_pri $pri;
307 aio_readdir $path, sub { 658 add $grp aio_readdir $path, sub {
308 my $entries = shift 659 my $entries = shift
309 or return $cb->(); 660 or return $grp->result ();
310 661
311 # stat the dir another time 662 # stat the dir another time
663 aioreq_pri $pri;
312 aio_stat $path, sub { 664 add $grp aio_stat $path, sub {
313 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 665 my $hash2 = join ":", (stat _)[0,1,3,7,9];
314 666
315 my $ndirs; 667 my $ndirs;
316 668
317 # take the slow route if anything looks fishy 669 # take the slow route if anything looks fishy
318 if ($hash1 ne $hash2) { 670 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
319 $ndirs = -1; 671 $ndirs = -1;
320 } else { 672 } else {
321 # if nlink == 2, we are finished 673 # if nlink == 2, we are finished
322 # on non-posix-fs's, we rely on nlink < 2 674 # on non-posix-fs's, we rely on nlink < 2
323 $ndirs = (stat _)[3] - 2 675 $ndirs = (stat _)[3] - 2
324 or $cb->([], $entries); 676 or return $grp->result ([], $entries);
325 }
326
327 # sort into likely dirs and likely nondirs
328 # dirs == files without ".", short entries first
329 $entries = [map $_->[0],
330 sort { $b->[1] cmp $a->[1] }
331 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
332 @$entries];
333
334 my (@dirs, @nondirs);
335
336 my ($statcb, $schedcb);
337 my $nreq = 0;
338
339 $schedcb = sub {
340 if (@$entries) {
341 if ($nreq < $maxreq) {
342 my $ent = pop @$entries;
343 $nreq++;
344 aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
345 }
346 } elsif (!$nreq) {
347 # finished
348 undef $statcb;
349 undef $schedcb;
350 $cb->(\@dirs, \@nondirs);
351 undef $cb;
352 } 677 }
678
679 # sort into likely dirs and likely nondirs
680 # dirs == files without ".", short entries first
681 $entries = [map $_->[0],
682 sort { $b->[1] cmp $a->[1] }
683 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
684 @$entries];
685
686 my (@dirs, @nondirs);
687
688 my $statgrp = add $grp aio_group sub {
689 $grp->result (\@dirs, \@nondirs);
690 };
691
692 limit $statgrp $maxreq;
693 feed $statgrp sub {
694 return unless @$entries;
695 my $entry = pop @$entries;
696
697 aioreq_pri $pri;
698 add $statgrp aio_stat "$path/$entry/.", sub {
699 if ($_[0] < 0) {
700 push @nondirs, $entry;
701 } else {
702 # need to check for real directory
703 aioreq_pri $pri;
704 add $statgrp aio_lstat "$path/$entry", sub {
705 if (-d _) {
706 push @dirs, $entry;
707
708 unless (--$ndirs) {
709 push @nondirs, @$entries;
710 feed $statgrp;
711 }
712 } else {
713 push @nondirs, $entry;
714 }
715 }
716 }
717 };
718 };
353 }; 719 };
354 $statcb = sub {
355 my ($status, $entry) = @_;
356
357 if ($status < 0) {
358 $nreq--;
359 push @nondirs, $entry;
360 &$schedcb;
361 } else {
362 # need to check for real directory
363 aio_lstat "$path/$entry", sub {
364 $nreq--;
365
366 if (-d _) {
367 push @dirs, $entry;
368
369 if (!--$ndirs) {
370 push @nondirs, @$entries;
371 $entries = [];
372 }
373 } else {
374 push @nondirs, $entry;
375 }
376
377 &$schedcb;
378 }
379 }
380 };
381
382 &$schedcb while @$entries && $nreq < $maxreq;
383 }; 720 };
384 }; 721 };
722
723 $grp
385 }; 724 }
725}
726
727=item aio_rmtree $path, $callback->($status)
728
729Delete a directory tree starting (and including) C<$path>, return the status of the final C<rmdir> only.
730This is a composite request that uses C<aio_scandir> to recurse into and rmdir directories, and
731unlink everything else.
732
733=cut
734
735sub aio_rmtree;
736sub aio_rmtree {
737 aio_block {
738 my ($path, $cb) = @_;
739
740 my $pri = aioreq_pri;
741 my $grp = aio_group $cb;
742
743 aioreq_pri $pri;
744 add $grp aio_scandir $path, 0, sub {
745 my ($dirs, $nondirs) = @_;
746
747 my $dirgrp = aio_group sub {
748 add $grp aio_rmdir $path, sub {
749 $grp->result ($_[0]);
750 };
751 };
752
753 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
754 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
755
756 add $grp $dirgrp;
757 };
758
759 $grp
760 }
386} 761}
387 762
388=item aio_fsync $fh, $callback->($status) 763=item aio_fsync $fh, $callback->($status)
389 764
390Asynchronously call fsync on the given filehandle and call the callback 765Asynchronously call fsync on the given filehandle and call the callback
396callback with the fdatasync result code. 771callback with the fdatasync result code.
397 772
398If this call isn't available because your OS lacks it or it couldn't be 773If this call isn't available because your OS lacks it or it couldn't be
399detected, it will be emulated by calling C<fsync> instead. 774detected, it will be emulated by calling C<fsync> instead.
400 775
776=item aio_group $callback->(...)
777
778This is a very special aio request: Instead of doing something, it is a
779container for other aio requests, which is useful if you want to bundle
780many requests into a single, composite, request with a definite callback
781and the ability to cancel the whole request with its subrequests.
782
783Returns an object of class L<IO::AIO::GRP>. See its documentation below
784for more info.
785
786Example:
787
788 my $grp = aio_group sub {
789 print "all stats done\n";
790 };
791
792 add $grp
793 (aio_stat ...),
794 (aio_stat ...),
795 ...;
796
797=item aio_nop $callback->()
798
799This is a special request - it does nothing in itself and is only used for
800side effects, such as when you want to add a dummy request to a group so
801that finishing the requests in the group depends on executing the given
802code.
803
804While this request does nothing, it still goes through the execution
805phase and still requires a worker thread. Thus, the callback will not
806be executed immediately but only after other requests in the queue have
807entered their execution phase. This can be used to measure request
808latency.
809
810=item IO::AIO::aio_busy $fractional_seconds, $callback->() *NOT EXPORTED*
811
812Mainly used for debugging and benchmarking, this aio request puts one of
813the request workers to sleep for the given time.
814
815While it is theoretically handy to have simple I/O scheduling requests
816like sleep and file handle readable/writable, the overhead this creates is
817immense (it blocks a thread for a long time) so do not use this function
818except to put your application under artificial I/O pressure.
819
401=back 820=back
402 821
822=head2 IO::AIO::REQ CLASS
823
824All non-aggregate C<aio_*> functions return an object of this class when
825called in non-void context.
826
827=over 4
828
829=item cancel $req
830
831Cancels the request, if possible. Has the effect of skipping execution
832when entering the B<execute> state and skipping calling the callback when
833entering the the B<result> state, but will leave the request otherwise
834untouched. That means that requests that currently execute will not be
835stopped and resources held by the request will not be freed prematurely.
836
837=item cb $req $callback->(...)
838
839Replace (or simply set) the callback registered to the request.
840
841=back
842
843=head2 IO::AIO::GRP CLASS
844
845This class is a subclass of L<IO::AIO::REQ>, so all its methods apply to
846objects of this class, too.
847
848A IO::AIO::GRP object is a special request that can contain multiple other
849aio requests.
850
851You create one by calling the C<aio_group> constructing function with a
852callback that will be called when all contained requests have entered the
853C<done> state:
854
855 my $grp = aio_group sub {
856 print "all requests are done\n";
857 };
858
859You add requests by calling the C<add> method with one or more
860C<IO::AIO::REQ> objects:
861
862 $grp->add (aio_unlink "...");
863
864 add $grp aio_stat "...", sub {
865 $_[0] or return $grp->result ("error");
866
867 # add another request dynamically, if first succeeded
868 add $grp aio_open "...", sub {
869 $grp->result ("ok");
870 };
871 };
872
873This makes it very easy to create composite requests (see the source of
874C<aio_move> for an application) that work and feel like simple requests.
875
876=over 4
877
878=item * The IO::AIO::GRP objects will be cleaned up during calls to
879C<IO::AIO::poll_cb>, just like any other request.
880
881=item * They can be canceled like any other request. Canceling will cancel not
882only the request itself, but also all requests it contains.
883
884=item * They can also can also be added to other IO::AIO::GRP objects.
885
886=item * You must not add requests to a group from within the group callback (or
887any later time).
888
889=back
890
891Their lifetime, simplified, looks like this: when they are empty, they
892will finish very quickly. If they contain only requests that are in the
893C<done> state, they will also finish. Otherwise they will continue to
894exist.
895
896That means after creating a group you have some time to add requests. And
897in the callbacks of those requests, you can add further requests to the
898group. And only when all those requests have finished will the the group
899itself finish.
900
901=over 4
902
903=item add $grp ...
904
905=item $grp->add (...)
906
907Add one or more requests to the group. Any type of L<IO::AIO::REQ> can
908be added, including other groups, as long as you do not create circular
909dependencies.
910
911Returns all its arguments.
912
913=item $grp->cancel_subs
914
915Cancel all subrequests and clears any feeder, but not the group request
916itself. Useful when you queued a lot of events but got a result early.
917
918=item $grp->result (...)
919
920Set the result value(s) that will be passed to the group callback when all
921subrequests have finished and set thre groups errno to the current value
922of errno (just like calling C<errno> without an error number). By default,
923no argument will be passed and errno is zero.
924
925=item $grp->errno ([$errno])
926
927Sets the group errno value to C<$errno>, or the current value of errno
928when the argument is missing.
929
930Every aio request has an associated errno value that is restored when
931the callback is invoked. This method lets you change this value from its
932default (0).
933
934Calling C<result> will also set errno, so make sure you either set C<$!>
935before the call to C<result>, or call c<errno> after it.
936
937=item feed $grp $callback->($grp)
938
939Sets a feeder/generator on this group: every group can have an attached
940generator that generates requests if idle. The idea behind this is that,
941although you could just queue as many requests as you want in a group,
942this might starve other requests for a potentially long time. For
943example, C<aio_scandir> might generate hundreds of thousands C<aio_stat>
944requests, delaying any later requests for a long time.
945
946To avoid this, and allow incremental generation of requests, you can
947instead a group and set a feeder on it that generates those requests. The
948feed callback will be called whenever there are few enough (see C<limit>,
949below) requests active in the group itself and is expected to queue more
950requests.
951
952The feed callback can queue as many requests as it likes (i.e. C<add> does
953not impose any limits).
954
955If the feed does not queue more requests when called, it will be
956automatically removed from the group.
957
958If the feed limit is C<0>, it will be set to C<2> automatically.
959
960Example:
961
962 # stat all files in @files, but only ever use four aio requests concurrently:
963
964 my $grp = aio_group sub { print "finished\n" };
965 limit $grp 4;
966 feed $grp sub {
967 my $file = pop @files
968 or return;
969
970 add $grp aio_stat $file, sub { ... };
971 };
972
973=item limit $grp $num
974
975Sets the feeder limit for the group: The feeder will be called whenever
976the group contains less than this many requests.
977
978Setting the limit to C<0> will pause the feeding process.
979
980=back
981
403=head2 SUPPORT FUNCTIONS 982=head2 SUPPORT FUNCTIONS
983
984=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
404 985
405=over 4 986=over 4
406 987
407=item $fileno = IO::AIO::poll_fileno 988=item $fileno = IO::AIO::poll_fileno
408 989
413 994
414See C<poll_cb> for an example. 995See C<poll_cb> for an example.
415 996
416=item IO::AIO::poll_cb 997=item IO::AIO::poll_cb
417 998
418Process all outstanding events on the result pipe. You have to call this 999Process some outstanding events on the result pipe. You have to call this
419regularly. Returns the number of events processed. Returns immediately 1000regularly. Returns the number of events processed. Returns immediately
420when no events are outstanding. 1001when no events are outstanding. The amount of events processed depends on
1002the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1003
1004If not all requests were processed for whatever reason, the filehandle
1005will still be ready when C<poll_cb> returns.
421 1006
422Example: Install an Event watcher that automatically calls 1007Example: Install an Event watcher that automatically calls
423IO::AIO::poll_cb with high priority: 1008IO::AIO::poll_cb with high priority:
424 1009
425 Event->io (fd => IO::AIO::poll_fileno, 1010 Event->io (fd => IO::AIO::poll_fileno,
426 poll => 'r', async => 1, 1011 poll => 'r', async => 1,
427 cb => \&IO::AIO::poll_cb); 1012 cb => \&IO::AIO::poll_cb);
428 1013
1014=item IO::AIO::max_poll_reqs $nreqs
1015
1016=item IO::AIO::max_poll_time $seconds
1017
1018These set the maximum number of requests (default C<0>, meaning infinity)
1019that are being processed by C<IO::AIO::poll_cb> in one call, respectively
1020the maximum amount of time (default C<0>, meaning infinity) spent in
1021C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
1022of time C<poll_cb> is allowed to use).
1023
1024Setting C<max_poll_time> to a non-zero value creates an overhead of one
1025syscall per request processed, which is not normally a problem unless your
1026callbacks are really really fast or your OS is really really slow (I am
1027not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
1028
1029Setting these is useful if you want to ensure some level of
1030interactiveness when perl is not fast enough to process all requests in
1031time.
1032
1033For interactive programs, values such as C<0.01> to C<0.1> should be fine.
1034
1035Example: Install an Event watcher that automatically calls
1036IO::AIO::poll_cb with low priority, to ensure that other parts of the
1037program get the CPU sometimes even under high AIO load.
1038
1039 # try not to spend much more than 0.1s in poll_cb
1040 IO::AIO::max_poll_time 0.1;
1041
1042 # use a low priority so other tasks have priority
1043 Event->io (fd => IO::AIO::poll_fileno,
1044 poll => 'r', nice => 1,
1045 cb => &IO::AIO::poll_cb);
1046
429=item IO::AIO::poll_wait 1047=item IO::AIO::poll_wait
430 1048
1049If there are any outstanding requests and none of them in the result
431Wait till the result filehandle becomes ready for reading (simply does a 1050phase, wait till the result filehandle becomes ready for reading (simply
432C<select> on the filehandle. This is useful if you want to synchronously wait 1051does a C<select> on the filehandle. This is useful if you want to
433for some requests to finish). 1052synchronously wait for some requests to finish).
434 1053
435See C<nreqs> for an example. 1054See C<nreqs> for an example.
436 1055
1056=item IO::AIO::poll
1057
1058Waits until some requests have been handled.
1059
1060Returns the number of requests processed, but is otherwise strictly
1061equivalent to:
1062
1063 IO::AIO::poll_wait, IO::AIO::poll_cb
1064
437=item IO::AIO::nreqs 1065=item IO::AIO::flush
438 1066
439Returns the number of requests currently outstanding (i.e. for which their 1067Wait till all outstanding AIO requests have been handled.
440callback has not been invoked yet).
441 1068
442Example: wait till there are no outstanding requests anymore: 1069Strictly equivalent to:
443 1070
444 IO::AIO::poll_wait, IO::AIO::poll_cb 1071 IO::AIO::poll_wait, IO::AIO::poll_cb
445 while IO::AIO::nreqs; 1072 while IO::AIO::nreqs;
446 1073
447=item IO::AIO::flush 1074=head3 CONTROLLING THE NUMBER OF THREADS
448
449Wait till all outstanding AIO requests have been handled.
450
451Strictly equivalent to:
452
453 IO::AIO::poll_wait, IO::AIO::poll_cb
454 while IO::AIO::nreqs;
455
456=item IO::AIO::poll
457
458Waits until some requests have been handled.
459
460Strictly equivalent to:
461
462 IO::AIO::poll_wait, IO::AIO::poll_cb
463 if IO::AIO::nreqs;
464 1075
465=item IO::AIO::min_parallel $nthreads 1076=item IO::AIO::min_parallel $nthreads
466 1077
467Set the minimum number of AIO threads to C<$nthreads>. The current default 1078Set the minimum number of AIO threads to C<$nthreads>. The current
468is C<4>, which means four asynchronous operations can be done at one time 1079default is C<8>, which means eight asynchronous operations can execute
469(the number of outstanding operations, however, is unlimited). 1080concurrently at any one time (the number of outstanding requests,
1081however, is unlimited).
470 1082
471IO::AIO starts threads only on demand, when an AIO request is queued and 1083IO::AIO starts threads only on demand, when an AIO request is queued and
472no free thread exists. 1084no free thread exists. Please note that queueing up a hundred requests can
1085create demand for a hundred threads, even if it turns out that everything
1086is in the cache and could have been processed faster by a single thread.
473 1087
474It is recommended to keep the number of threads low, as some Linux 1088It is recommended to keep the number of threads relatively low, as some
475kernel versions will scale negatively with the number of threads (higher 1089Linux kernel versions will scale negatively with the number of threads
476parallelity => MUCH higher latency). With current Linux 2.6 versions, 4-32 1090(higher parallelity => MUCH higher latency). With current Linux 2.6
477threads should be fine. 1091versions, 4-32 threads should be fine.
478 1092
479Under most circumstances you don't need to call this function, as the 1093Under most circumstances you don't need to call this function, as the
480module selects a default that is suitable for low to moderate load. 1094module selects a default that is suitable for low to moderate load.
481 1095
482=item IO::AIO::max_parallel $nthreads 1096=item IO::AIO::max_parallel $nthreads
491This module automatically runs C<max_parallel 0> at program end, to ensure 1105This module automatically runs C<max_parallel 0> at program end, to ensure
492that all threads are killed and that there are no outstanding requests. 1106that all threads are killed and that there are no outstanding requests.
493 1107
494Under normal circumstances you don't need to call this function. 1108Under normal circumstances you don't need to call this function.
495 1109
1110=item IO::AIO::max_idle $nthreads
1111
1112Limit the number of threads (default: 4) that are allowed to idle (i.e.,
1113threads that did not get a request to process within 10 seconds). That
1114means if a thread becomes idle while C<$nthreads> other threads are also
1115idle, it will free its resources and exit.
1116
1117This is useful when you allow a large number of threads (e.g. 100 or 1000)
1118to allow for extremely high load situations, but want to free resources
1119under normal circumstances (1000 threads can easily consume 30MB of RAM).
1120
1121The default is probably ok in most situations, especially if thread
1122creation is fast. If thread creation is very slow on your system you might
1123want to use larger values.
1124
496=item $oldnreqs = IO::AIO::max_outstanding $nreqs 1125=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs
1126
1127This is a very bad function to use in interactive programs because it
1128blocks, and a bad way to reduce concurrency because it is inexact: Better
1129use an C<aio_group> together with a feed callback.
497 1130
498Sets the maximum number of outstanding requests to C<$nreqs>. If you 1131Sets the maximum number of outstanding requests to C<$nreqs>. If you
499try to queue up more than this number of requests, the caller will block until 1132to queue up more than this number of requests, the next call to the
500some requests have been handled. 1133C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1134function will block until the limit is no longer exceeded.
501 1135
502The default is very large, so normally there is no practical limit. If you 1136The default value is very large, so there is no practical limit on the
503queue up many requests in a loop it often improves speed if you set 1137number of outstanding requests.
504this to a relatively low number, such as C<100>.
505 1138
506Under normal circumstances you don't need to call this function. 1139You can still queue as many requests as you want. Therefore,
1140C<max_oustsanding> is mainly useful in simple scripts (with low values) or
1141as a stop gap to shield against fatal memory overflow (with large values).
1142
1143=head3 STATISTICAL INFORMATION
1144
1145=item IO::AIO::nreqs
1146
1147Returns the number of requests currently in the ready, execute or pending
1148states (i.e. for which their callback has not been invoked yet).
1149
1150Example: wait till there are no outstanding requests anymore:
1151
1152 IO::AIO::poll_wait, IO::AIO::poll_cb
1153 while IO::AIO::nreqs;
1154
1155=item IO::AIO::nready
1156
1157Returns the number of requests currently in the ready state (not yet
1158executed).
1159
1160=item IO::AIO::npending
1161
1162Returns the number of requests currently in the pending state (executed,
1163but not yet processed by poll_cb).
507 1164
508=back 1165=back
509 1166
510=cut 1167=cut
511 1168
523 or return undef; 1180 or return undef;
524 1181
525 *$sym 1182 *$sym
526} 1183}
527 1184
528min_parallel 4; 1185min_parallel 8;
529 1186
530END { 1187END { flush }
531 max_parallel 0;
532}
533 1188
5341; 11891;
535 1190
536=head2 FORK BEHAVIOUR 1191=head2 FORK BEHAVIOUR
1192
1193This module should do "the right thing" when the process using it forks:
537 1194
538Before the fork, IO::AIO enters a quiescent state where no requests 1195Before the fork, IO::AIO enters a quiescent state where no requests
539can be added in other threads and no results will be processed. After 1196can be added in other threads and no results will be processed. After
540the fork the parent simply leaves the quiescent state and continues 1197the fork the parent simply leaves the quiescent state and continues
541request/result processing, while the child clears the request/result 1198request/result processing, while the child frees the request/result queue
542queue (so the requests started before the fork will only be handled in 1199(so that the requests started before the fork will only be handled in the
543the parent). Threats will be started on demand until the limit ste in the 1200parent). Threads will be started on demand until the limit set in the
544parent process has been reached again. 1201parent process has been reached again.
545 1202
1203In short: the parent will, after a short pause, continue as if fork had
1204not been called, while the child will act as if IO::AIO has not been used
1205yet.
1206
1207=head2 MEMORY USAGE
1208
1209Per-request usage:
1210
1211Each aio request uses - depending on your architecture - around 100-200
1212bytes of memory. In addition, stat requests need a stat buffer (possibly
1213a few hundred bytes), readdir requires a result buffer and so on. Perl
1214scalars and other data passed into aio requests will also be locked and
1215will consume memory till the request has entered the done state.
1216
1217This is now awfully much, so queuing lots of requests is not usually a
1218problem.
1219
1220Per-thread usage:
1221
1222In the execution phase, some aio requests require more memory for
1223temporary buffers, and each thread requires a stack and other data
1224structures (usually around 16k-128k, depending on the OS).
1225
1226=head1 KNOWN BUGS
1227
1228Known bugs will be fixed in the next release.
1229
546=head1 SEE ALSO 1230=head1 SEE ALSO
547 1231
548L<Coro>, L<Linux::AIO>. 1232L<Coro::AIO>.
549 1233
550=head1 AUTHOR 1234=head1 AUTHOR
551 1235
552 Marc Lehmann <schmorp@schmorp.de> 1236 Marc Lehmann <schmorp@schmorp.de>
553 http://home.schmorp.de/ 1237 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines