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.71 by root, Tue Oct 24 11:57:30 2006 UTC vs.
Revision 1.105 by root, Sun Mar 25 00:20:27 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
51=head1 DESCRIPTION 52=head1 DESCRIPTION
52 53
53This module implements asynchronous I/O using whatever means your 54This module implements asynchronous I/O using whatever means your
54operating system supports. 55operating system supports.
55 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
56Currently, a number of threads are started that execute your read/writes 74In this version, a number of threads are started that execute your
57and signal their completion. You don't need thread support in perl, and 75requests and signal their completion. You don't need thread support
58the threads created by this module will not be visible to perl. In the 76in perl, and the threads created by this module will not be visible
59future, this module might make use of the native aio functions available 77to perl. In the future, this module might make use of the native aio
60on many operating systems. However, they are often not well-supported 78functions available on many operating systems. However, they are often
61(Linux doesn't allow them on normal files currently, for example), 79not well-supported or restricted (GNU/Linux doesn't allow them on normal
62and they would only support aio_read and aio_write, so the remaining 80files currently, for example), and they would only support aio_read and
63functionality would have to be implemented using threads anyway. 81aio_write, so the remaining functionality would have to be implemented
82using threads anyway.
64 83
65Although the module will work with in the presence of other threads, 84Although the module will work with in the presence of other (Perl-)
66it is currently not reentrant in any way, so use appropriate locking 85threads, it is currently not reentrant in any way, so use appropriate
67yourself, always call C<poll_cb> from within the same thread, or never 86locking yourself, always call C<poll_cb> from within the same thread, or
68call C<poll_cb> (or other C<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
69 184
70=cut 185=cut
71 186
72package IO::AIO; 187package IO::AIO;
73 188
75use strict 'vars'; 190use strict 'vars';
76 191
77use base 'Exporter'; 192use base 'Exporter';
78 193
79BEGIN { 194BEGIN {
80 our $VERSION = '2.0'; 195 our $VERSION = '2.33';
81 196
82 our @AIO_REQ = 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
83 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
84 aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move 199 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link
85 aio_group aio_nop); 200 aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir);
86 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block));
87 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
88 min_parallel max_parallel max_outstanding nreqs); 203 min_parallel max_parallel max_idle
204 nreqs nready npending nthreads
205 max_poll_time max_poll_reqs);
89 206
90 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 207 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
91 208
92 require XSLoader; 209 require XSLoader;
93 XSLoader::load ("IO::AIO", $VERSION); 210 XSLoader::load ("IO::AIO", $VERSION);
94} 211}
95 212
96=head1 FUNCTIONS 213=head1 FUNCTIONS
97 214
98=head2 AIO FUNCTIONS 215=head2 AIO REQUEST FUNCTIONS
99 216
100All 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
101with 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,
102and they all accept an additional (and optional) C<$callback> argument 219and they all accept an additional (and optional) C<$callback> argument
103which 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
106syscall has been executed asynchronously. 223syscall has been executed asynchronously.
107 224
108All functions expecting a filehandle keep a copy of the filehandle 225All functions expecting a filehandle keep a copy of the filehandle
109internally until the request has finished. 226internally until the request has finished.
110 227
111All requests return objects of type L<IO::AIO::REQ> that allow further 228All functions return request objects of type L<IO::AIO::REQ> that allow
112manipulation of those requests while they are in-flight. 229further manipulation of those requests while they are in-flight.
113 230
114The pathnames you pass to these routines I<must> be absolute and 231The pathnames you pass to these routines I<must> be absolute and
115encoded 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
116request is being executed, the current working directory could have 233request is being executed, the current working directory could have
117changed. Alternatively, you can make sure that you never change the 234changed. Alternatively, you can make sure that you never change the
118current working directory. 235current working directory anywhere in the program and then use relative
236paths.
119 237
120To encode pathnames to byte form, either make sure you either: a) 238To encode pathnames as octets, either make sure you either: a) always pass
121always pass in filenames you got from outside (command line, readdir 239in filenames you got from outside (command line, readdir etc.) without
122etc.), 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
123your 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
124environment, d) use Glib::filename_from_unicode on unicode filenames or e) 242environment, d) use Glib::filename_from_unicode on unicode filenames or e)
125use 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.
126 247
127=over 4 248=over 4
128 249
129=item aioreq_pri $pri 250=item $prev_pri = aioreq_pri [$pri]
130 251
131Sets the priority for the next aio request. The default priority 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
132is C<0>, the minimum and maximum priorities are C<-4> and C<4>, 255The default priority is C<0>, the minimum and maximum priorities are C<-4>
133respectively. Requests with higher priority will be serviced first. 256and C<4>, respectively. Requests with higher priority will be serviced
257first.
134 258
135The priority will be reset to C<0> after each call to one of the C<aio_> 259The priority will be reset to C<0> after each call to one of the C<aio_*>
136functions. 260functions.
137 261
138Example: open a file with low priority, then read something from it with 262Example: open a file with low priority, then read something from it with
139higher priority so the read request is serviced before other low priority 263higher priority so the read request is serviced before other low priority
140open requests (potentially spamming the cache): 264open requests (potentially spamming the cache):
150 }; 274 };
151 275
152=item aioreq_nice $pri_adjust 276=item aioreq_nice $pri_adjust
153 277
154Similar to C<aioreq_pri>, but subtracts the given value from the current 278Similar to C<aioreq_pri>, but subtracts the given value from the current
155priority, so effects are cumulative. 279priority, so the effect is cumulative.
156 280
157=item aio_open $pathname, $flags, $mode, $callback->($fh) 281=item aio_open $pathname, $flags, $mode, $callback->($fh)
158 282
159Asynchronously 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
160created filehandle for the file. 284created filehandle for the file.
166list. They are the same as used by C<sysopen>. 290list. They are the same as used by C<sysopen>.
167 291
168Likewise, C<$mode> specifies the mode of the newly created file, if it 292Likewise, C<$mode> specifies the mode of the newly created file, if it
169didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, 293didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,
170except that it is mandatory (i.e. use C<0> if you don't create new files, 294except that it is mandatory (i.e. use C<0> if you don't create new files,
171and C<0666> or C<0777> if you do). 295and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified
296by the umask in effect then the request is being executed, so better never
297change the umask.
172 298
173Example: 299Example:
174 300
175 aio_open "/etc/passwd", O_RDONLY, 0, sub { 301 aio_open "/etc/passwd", O_RDONLY, 0, sub {
176 if ($_[0]) { 302 if ($_[0]) {
211 aio_read $fh, 7, 15, $buffer, 0, sub { 337 aio_read $fh, 7, 15, $buffer, 0, sub {
212 $_[0] > 0 or die "read error: $!"; 338 $_[0] > 0 or die "read error: $!";
213 print "read $_[0] bytes: <$buffer>\n"; 339 print "read $_[0] bytes: <$buffer>\n";
214 }; 340 };
215 341
216=item aio_move $srcpath, $dstpath, $callback->($status)
217
218Try to move the I<file> (directories not supported as either source or
219destination) from C<$srcpath> to C<$dstpath> and call the callback with
220the C<0> (error) or C<-1> ok.
221
222This is a composite request that tries to rename(2) the file first. If
223rename files with C<EXDEV>, it creates the destination file with mode 0200
224and copies the contents of the source file into it using C<aio_sendfile>,
225followed by restoring atime, mtime, access mode and uid/gid, in that
226order, and unlinking the C<$srcpath>.
227
228If an error occurs, the partial destination file will be unlinked, if
229possible, except when setting atime, mtime, access mode and uid/gid, where
230errors are being ignored.
231
232=cut
233
234sub aio_move($$$) {
235 my ($src, $dst, $cb) = @_;
236
237 my $grp = aio_group $cb;
238
239 add $grp aio_rename $src, $dst, sub {
240 if ($_[0] && $! == EXDEV) {
241 add $grp aio_open $src, O_RDONLY, 0, sub {
242 if (my $src_fh = $_[0]) {
243 my @stat = stat $src_fh;
244
245 add $grp aio_open $dst, O_WRONLY, 0200, sub {
246 if (my $dst_fh = $_[0]) {
247 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
248 close $src_fh;
249
250 if ($_[0] == $stat[7]) {
251 utime $stat[8], $stat[9], $dst;
252 chmod $stat[2] & 07777, $dst_fh;
253 chown $stat[4], $stat[5], $dst_fh;
254 close $dst_fh;
255
256 add $grp aio_unlink $src, sub {
257 $grp->result ($_[0]);
258 };
259 } else {
260 my $errno = $!;
261 add $grp aio_unlink $dst, sub {
262 $! = $errno;
263 $grp->result (-1);
264 };
265 }
266 };
267 } else {
268 $grp->result (-1);
269 }
270 },
271
272 } else {
273 $grp->result (-1);
274 }
275 };
276 } else {
277 $grp->result ($_[0]);
278 }
279 };
280
281 $grp
282}
283
284=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 342=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
285 343
286Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 344Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
287reading at byte offset C<$in_offset>, and starts writing at the current 345reading at byte offset C<$in_offset>, and starts writing at the current
288file offset of C<$out_fh>. Because of that, it is not safe to issue more 346file offset of C<$out_fh>. Because of that, it is not safe to issue more
343=item aio_unlink $pathname, $callback->($status) 401=item aio_unlink $pathname, $callback->($status)
344 402
345Asynchronously unlink (delete) a file and call the callback with the 403Asynchronously unlink (delete) a file and call the callback with the
346result code. 404result code.
347 405
406=item aio_mknod $path, $mode, $dev, $callback->($status)
407
408[EXPERIMENTAL]
409
410Asynchronously create a device node (or fifo). See mknod(2).
411
412The only (POSIX-) portable way of calling this function is:
413
414 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
415
348=item aio_link $srcpath, $dstpath, $callback->($status) 416=item aio_link $srcpath, $dstpath, $callback->($status)
349 417
350Asynchronously create a new link to the existing object at C<$srcpath> at 418Asynchronously create a new link to the existing object at C<$srcpath> at
351the path C<$dstpath> and call the callback with the result code. 419the path C<$dstpath> and call the callback with the result code.
352 420
353=item aio_symlink $srcpath, $dstpath, $callback->($status) 421=item aio_symlink $srcpath, $dstpath, $callback->($status)
354 422
355Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 423Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
356the path C<$dstpath> and call the callback with the result code. 424the path C<$dstpath> and call the callback with the result code.
357 425
426=item aio_readlink $path, $callback->($link)
427
428Asynchronously read the symlink specified by C<$path> and pass it to
429the callback. If an error occurs, nothing or undef gets passed to the
430callback.
431
358=item aio_rename $srcpath, $dstpath, $callback->($status) 432=item aio_rename $srcpath, $dstpath, $callback->($status)
359 433
360Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 434Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
361rename(2) and call the callback with the result code. 435rename(2) and call the callback with the result code.
436
437=item aio_mkdir $pathname, $mode, $callback->($status)
438
439Asynchronously mkdir (create) a directory and call the callback with
440the result code. C<$mode> will be modified by the umask at the time the
441request is executed, so do not change your umask.
362 442
363=item aio_rmdir $pathname, $callback->($status) 443=item aio_rmdir $pathname, $callback->($status)
364 444
365Asynchronously rmdir (delete) a directory and call the callback with the 445Asynchronously rmdir (delete) a directory and call the callback with the
366result code. 446result code.
372sorted, and will B<NOT> include the C<.> and C<..> entries. 452sorted, and will B<NOT> include the C<.> and C<..> entries.
373 453
374The callback a single argument which is either C<undef> or an array-ref 454The callback a single argument which is either C<undef> or an array-ref
375with the filenames. 455with the filenames.
376 456
457=item aio_load $path, $data, $callback->($status)
458
459This is a composite request that tries to fully load the given file into
460memory. Status is the same as with aio_read.
461
462=cut
463
464sub aio_load($$;$) {
465 aio_block {
466 my ($path, undef, $cb) = @_;
467 my $data = \$_[1];
468
469 my $pri = aioreq_pri;
470 my $grp = aio_group $cb;
471
472 aioreq_pri $pri;
473 add $grp aio_open $path, O_RDONLY, 0, sub {
474 my $fh = shift
475 or return $grp->result (-1);
476
477 aioreq_pri $pri;
478 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
479 $grp->result ($_[0]);
480 };
481 };
482
483 $grp
484 }
485}
486
487=item aio_copy $srcpath, $dstpath, $callback->($status)
488
489Try to copy the I<file> (directories not supported as either source or
490destination) from C<$srcpath> to C<$dstpath> and call the callback with
491the C<0> (error) or C<-1> ok.
492
493This is a composite request that it creates the destination file with
494mode 0200 and copies the contents of the source file into it using
495C<aio_sendfile>, followed by restoring atime, mtime, access mode and
496uid/gid, in that order.
497
498If an error occurs, the partial destination file will be unlinked, if
499possible, except when setting atime, mtime, access mode and uid/gid, where
500errors are being ignored.
501
502=cut
503
504sub aio_copy($$;$) {
505 aio_block {
506 my ($src, $dst, $cb) = @_;
507
508 my $pri = aioreq_pri;
509 my $grp = aio_group $cb;
510
511 aioreq_pri $pri;
512 add $grp aio_open $src, O_RDONLY, 0, sub {
513 if (my $src_fh = $_[0]) {
514 my @stat = stat $src_fh;
515
516 aioreq_pri $pri;
517 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
518 if (my $dst_fh = $_[0]) {
519 aioreq_pri $pri;
520 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
521 if ($_[0] == $stat[7]) {
522 $grp->result (0);
523 close $src_fh;
524
525 # those should not normally block. should. should.
526 utime $stat[8], $stat[9], $dst;
527 chmod $stat[2] & 07777, $dst_fh;
528 chown $stat[4], $stat[5], $dst_fh;
529 close $dst_fh;
530 } else {
531 $grp->result (-1);
532 close $src_fh;
533 close $dst_fh;
534
535 aioreq $pri;
536 add $grp aio_unlink $dst;
537 }
538 };
539 } else {
540 $grp->result (-1);
541 }
542 },
543
544 } else {
545 $grp->result (-1);
546 }
547 };
548
549 $grp
550 }
551}
552
553=item aio_move $srcpath, $dstpath, $callback->($status)
554
555Try to move the I<file> (directories not supported as either source or
556destination) from C<$srcpath> to C<$dstpath> and call the callback with
557the C<0> (error) or C<-1> ok.
558
559This is a composite request that tries to rename(2) the file first. If
560rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if
561that is successful, unlinking the C<$srcpath>.
562
563=cut
564
565sub aio_move($$;$) {
566 aio_block {
567 my ($src, $dst, $cb) = @_;
568
569 my $pri = aioreq_pri;
570 my $grp = aio_group $cb;
571
572 aioreq_pri $pri;
573 add $grp aio_rename $src, $dst, sub {
574 if ($_[0] && $! == EXDEV) {
575 aioreq_pri $pri;
576 add $grp aio_copy $src, $dst, sub {
577 $grp->result ($_[0]);
578
579 if (!$_[0]) {
580 aioreq_pri $pri;
581 add $grp aio_unlink $src;
582 }
583 };
584 } else {
585 $grp->result ($_[0]);
586 }
587 };
588
589 $grp
590 }
591}
592
377=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 593=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
378 594
379Scans a directory (similar to C<aio_readdir>) but additionally tries to 595Scans a directory (similar to C<aio_readdir>) but additionally tries to
380separate the entries of directory C<$path> into two sets of names, ones 596efficiently separate the entries of directory C<$path> into two sets of
381you can recurse into (directories or links to them), and ones you cannot 597names, directories you can recurse into (directories), and ones you cannot
382recurse into (everything else). 598recurse into (everything else, including symlinks to directories).
383 599
384C<aio_scandir> is a composite request that creates of many sub requests_ 600C<aio_scandir> is a composite request that creates of many sub requests_
385C<$maxreq> specifies the maximum number of outstanding aio requests that 601C<$maxreq> specifies the maximum number of outstanding aio requests that
386this function generates. If it is C<< <= 0 >>, then a suitable default 602this function generates. If it is C<< <= 0 >>, then a suitable default
387will be chosen (currently 6). 603will be chosen (currently 4).
388 604
389On error, the callback is called without arguments, otherwise it receives 605On error, the callback is called without arguments, otherwise it receives
390two array-refs with path-relative entry names. 606two array-refs with path-relative entry names.
391 607
392Example: 608Example:
426as those tend to return 0 or 1 as link counts, which disables the 642as those tend to return 0 or 1 as link counts, which disables the
427directory counting heuristic. 643directory counting heuristic.
428 644
429=cut 645=cut
430 646
431sub aio_scandir($$$) { 647sub aio_scandir($$;$) {
648 aio_block {
432 my ($path, $maxreq, $cb) = @_; 649 my ($path, $maxreq, $cb) = @_;
433 650
651 my $pri = aioreq_pri;
652
434 my $grp = aio_group $cb; 653 my $grp = aio_group $cb;
435 654
436 $maxreq = 6 if $maxreq <= 0; 655 $maxreq = 4 if $maxreq <= 0;
437 656
438 # stat once 657 # stat once
658 aioreq_pri $pri;
439 add $grp aio_stat $path, sub { 659 add $grp aio_stat $path, sub {
440 return $grp->result () if $_[0]; 660 return $grp->result () if $_[0];
441 my $now = time; 661 my $now = time;
442 my $hash1 = join ":", (stat _)[0,1,3,7,9]; 662 my $hash1 = join ":", (stat _)[0,1,3,7,9];
443 663
444 # read the directory entries 664 # read the directory entries
665 aioreq_pri $pri;
445 add $grp aio_readdir $path, sub { 666 add $grp aio_readdir $path, sub {
446 my $entries = shift 667 my $entries = shift
447 or return $grp->result (); 668 or return $grp->result ();
448 669
449 # stat the dir another time 670 # stat the dir another time
671 aioreq_pri $pri;
450 add $grp aio_stat $path, sub { 672 add $grp aio_stat $path, sub {
451 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 673 my $hash2 = join ":", (stat _)[0,1,3,7,9];
452 674
453 my $ndirs; 675 my $ndirs;
454 676
455 # take the slow route if anything looks fishy 677 # take the slow route if anything looks fishy
456 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 678 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
457 $ndirs = -1; 679 $ndirs = -1;
458 } else { 680 } else {
459 # if nlink == 2, we are finished 681 # if nlink == 2, we are finished
460 # on non-posix-fs's, we rely on nlink < 2 682 # on non-posix-fs's, we rely on nlink < 2
461 $ndirs = (stat _)[3] - 2 683 $ndirs = (stat _)[3] - 2
462 or return $grp->result ([], $entries); 684 or return $grp->result ([], $entries);
463 } 685 }
464 686
465 # sort into likely dirs and likely nondirs 687 # sort into likely dirs and likely nondirs
466 # dirs == files without ".", short entries first 688 # dirs == files without ".", short entries first
467 $entries = [map $_->[0], 689 $entries = [map $_->[0],
468 sort { $b->[1] cmp $a->[1] } 690 sort { $b->[1] cmp $a->[1] }
469 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 691 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
470 @$entries]; 692 @$entries];
471 693
472 my (@dirs, @nondirs); 694 my (@dirs, @nondirs);
473 695
474 my ($statcb, $schedcb);
475 my $nreq = 0;
476
477 my $statgrp = add $grp aio_group; 696 my $statgrp = add $grp aio_group sub {
478
479 $schedcb = sub {
480 if (@$entries) {
481 if ($nreq < $maxreq) {
482 my $ent = pop @$entries;
483 $nreq++;
484 add $statgrp aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
485 }
486 } elsif (!$nreq) {
487 # finished
488 $statgrp->cancel;
489 undef $statcb;
490 undef $schedcb;
491 $grp->result (\@dirs, \@nondirs); 697 $grp->result (\@dirs, \@nondirs);
492 } 698 };
699
700 limit $statgrp $maxreq;
701 feed $statgrp sub {
702 return unless @$entries;
703 my $entry = pop @$entries;
704
705 aioreq_pri $pri;
706 add $statgrp aio_stat "$path/$entry/.", sub {
707 if ($_[0] < 0) {
708 push @nondirs, $entry;
709 } else {
710 # need to check for real directory
711 aioreq_pri $pri;
712 add $statgrp aio_lstat "$path/$entry", sub {
713 if (-d _) {
714 push @dirs, $entry;
715
716 unless (--$ndirs) {
717 push @nondirs, @$entries;
718 feed $statgrp;
719 }
720 } else {
721 push @nondirs, $entry;
722 }
723 }
724 }
725 };
726 };
493 }; 727 };
494 $statcb = sub {
495 my ($status, $entry) = @_;
496
497 if ($status < 0) {
498 $nreq--;
499 push @nondirs, $entry;
500 &$schedcb;
501 } else {
502 # need to check for real directory
503 add $grp aio_lstat "$path/$entry", sub {
504 $nreq--;
505
506 if (-d _) {
507 push @dirs, $entry;
508
509 if (!--$ndirs) {
510 push @nondirs, @$entries;
511 $entries = [];
512 }
513 } else {
514 push @nondirs, $entry;
515 }
516
517 &$schedcb;
518 }
519 }
520 };
521
522 &$schedcb while @$entries && $nreq < $maxreq;
523 }; 728 };
524 }; 729 };
730
731 $grp
525 }; 732 }
733}
526 734
735=item aio_rmtree $path, $callback->($status)
736
737Delete a directory tree starting (and including) C<$path>, return the
738status of the final C<rmdir> only. This is a composite request that
739uses C<aio_scandir> to recurse into and rmdir directories, and unlink
740everything else.
741
742=cut
743
744sub aio_rmtree;
745sub aio_rmtree($;$) {
746 aio_block {
747 my ($path, $cb) = @_;
748
749 my $pri = aioreq_pri;
750 my $grp = aio_group $cb;
751
752 aioreq_pri $pri;
753 add $grp aio_scandir $path, 0, sub {
754 my ($dirs, $nondirs) = @_;
755
756 my $dirgrp = aio_group sub {
757 add $grp aio_rmdir $path, sub {
758 $grp->result ($_[0]);
759 };
760 };
761
762 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
763 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
764
765 add $grp $dirgrp;
766 };
767
527 $grp 768 $grp
769 }
528} 770}
529 771
530=item aio_fsync $fh, $callback->($status) 772=item aio_fsync $fh, $callback->($status)
531 773
532Asynchronously call fsync on the given filehandle and call the callback 774Asynchronously call fsync on the given filehandle and call the callback
539 781
540If this call isn't available because your OS lacks it or it couldn't be 782If this call isn't available because your OS lacks it or it couldn't be
541detected, it will be emulated by calling C<fsync> instead. 783detected, it will be emulated by calling C<fsync> instead.
542 784
543=item aio_group $callback->(...) 785=item aio_group $callback->(...)
544
545[EXPERIMENTAL]
546 786
547This is a very special aio request: Instead of doing something, it is a 787This is a very special aio request: Instead of doing something, it is a
548container for other aio requests, which is useful if you want to bundle 788container for other aio requests, which is useful if you want to bundle
549many requests into a single, composite, request with a definite callback 789many requests into a single, composite, request with a definite callback
550and the ability to cancel the whole request with its subrequests. 790and the ability to cancel the whole request with its subrequests.
591=head2 IO::AIO::REQ CLASS 831=head2 IO::AIO::REQ CLASS
592 832
593All non-aggregate C<aio_*> functions return an object of this class when 833All non-aggregate C<aio_*> functions return an object of this class when
594called in non-void context. 834called in non-void context.
595 835
596A request always moves through the following five states in its lifetime,
597in order: B<ready> (request has been created, but has not been executed
598yet), B<execute> (request is currently being executed), B<pending>
599(request has been executed but callback has not been called yet),
600B<result> (results are being processed synchronously, includes calling the
601callback) and B<done> (request has reached the end of its lifetime and
602holds no resources anymore).
603
604=over 4 836=over 4
605 837
606=item cancel $req 838=item cancel $req
607 839
608Cancels the request, if possible. Has the effect of skipping execution 840Cancels the request, if possible. Has the effect of skipping execution
661=item * They can also can also be added to other IO::AIO::GRP objects. 893=item * They can also can also be added to other IO::AIO::GRP objects.
662 894
663=item * You must not add requests to a group from within the group callback (or 895=item * You must not add requests to a group from within the group callback (or
664any later time). 896any later time).
665 897
666=item * This does not harmonise well with C<max_outstanding>, so best do
667not combine C<aio_group> with it. Groups and feeders are recommended for
668this kind of concurrency-limiting.
669
670=back 898=back
671 899
672Their lifetime, simplified, looks like this: when they are empty, they 900Their lifetime, simplified, looks like this: when they are empty, they
673will finish very quickly. If they contain only requests that are in the 901will finish very quickly. If they contain only requests that are in the
674C<done> state, they will also finish. Otherwise they will continue to 902C<done> state, they will also finish. Otherwise they will continue to
689be added, including other groups, as long as you do not create circular 917be added, including other groups, as long as you do not create circular
690dependencies. 918dependencies.
691 919
692Returns all its arguments. 920Returns all its arguments.
693 921
922=item $grp->cancel_subs
923
924Cancel all subrequests and clears any feeder, but not the group request
925itself. Useful when you queued a lot of events but got a result early.
926
694=item $grp->result (...) 927=item $grp->result (...)
695 928
696Set the result value(s) that will be passed to the group callback when all 929Set the result value(s) that will be passed to the group callback when all
697subrequests have finished. By default, no argument will be passed. 930subrequests have finished and set thre groups errno to the current value
931of errno (just like calling C<errno> without an error number). By default,
932no argument will be passed and errno is zero.
933
934=item $grp->errno ([$errno])
935
936Sets the group errno value to C<$errno>, or the current value of errno
937when the argument is missing.
938
939Every aio request has an associated errno value that is restored when
940the callback is invoked. This method lets you change this value from its
941default (0).
942
943Calling C<result> will also set errno, so make sure you either set C<$!>
944before the call to C<result>, or call c<errno> after it.
698 945
699=item feed $grp $callback->($grp) 946=item feed $grp $callback->($grp)
700
701[VERY EXPERIMENTAL]
702 947
703Sets a feeder/generator on this group: every group can have an attached 948Sets a feeder/generator on this group: every group can have an attached
704generator that generates requests if idle. The idea behind this is that, 949generator that generates requests if idle. The idea behind this is that,
705although you could just queue as many requests as you want in a group, 950although you could just queue as many requests as you want in a group,
706this might starve other requests for a potentially long time. For 951this might starve other requests for a potentially long time. For
743 988
744=back 989=back
745 990
746=head2 SUPPORT FUNCTIONS 991=head2 SUPPORT FUNCTIONS
747 992
993=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
994
748=over 4 995=over 4
749 996
750=item $fileno = IO::AIO::poll_fileno 997=item $fileno = IO::AIO::poll_fileno
751 998
752Return the I<request result pipe file descriptor>. This filehandle must be 999Return the I<request result pipe file descriptor>. This filehandle must be
756 1003
757See C<poll_cb> for an example. 1004See C<poll_cb> for an example.
758 1005
759=item IO::AIO::poll_cb 1006=item IO::AIO::poll_cb
760 1007
761Process all outstanding events on the result pipe. You have to call this 1008Process some outstanding events on the result pipe. You have to call this
762regularly. Returns the number of events processed. Returns immediately 1009regularly. Returns the number of events processed. Returns immediately
763when no events are outstanding. 1010when no events are outstanding. The amount of events processed depends on
1011the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1012
1013If not all requests were processed for whatever reason, the filehandle
1014will still be ready when C<poll_cb> returns.
764 1015
765Example: Install an Event watcher that automatically calls 1016Example: Install an Event watcher that automatically calls
766IO::AIO::poll_cb with high priority: 1017IO::AIO::poll_cb with high priority:
767 1018
768 Event->io (fd => IO::AIO::poll_fileno, 1019 Event->io (fd => IO::AIO::poll_fileno,
769 poll => 'r', async => 1, 1020 poll => 'r', async => 1,
770 cb => \&IO::AIO::poll_cb); 1021 cb => \&IO::AIO::poll_cb);
771 1022
1023=item IO::AIO::max_poll_reqs $nreqs
1024
1025=item IO::AIO::max_poll_time $seconds
1026
1027These set the maximum number of requests (default C<0>, meaning infinity)
1028that are being processed by C<IO::AIO::poll_cb> in one call, respectively
1029the maximum amount of time (default C<0>, meaning infinity) spent in
1030C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
1031of time C<poll_cb> is allowed to use).
1032
1033Setting C<max_poll_time> to a non-zero value creates an overhead of one
1034syscall per request processed, which is not normally a problem unless your
1035callbacks are really really fast or your OS is really really slow (I am
1036not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
1037
1038Setting these is useful if you want to ensure some level of
1039interactiveness when perl is not fast enough to process all requests in
1040time.
1041
1042For interactive programs, values such as C<0.01> to C<0.1> should be fine.
1043
1044Example: Install an Event watcher that automatically calls
1045IO::AIO::poll_cb with low priority, to ensure that other parts of the
1046program get the CPU sometimes even under high AIO load.
1047
1048 # try not to spend much more than 0.1s in poll_cb
1049 IO::AIO::max_poll_time 0.1;
1050
1051 # use a low priority so other tasks have priority
1052 Event->io (fd => IO::AIO::poll_fileno,
1053 poll => 'r', nice => 1,
1054 cb => &IO::AIO::poll_cb);
1055
772=item IO::AIO::poll_wait 1056=item IO::AIO::poll_wait
773 1057
1058If there are any outstanding requests and none of them in the result
774Wait till the result filehandle becomes ready for reading (simply does a 1059phase, wait till the result filehandle becomes ready for reading (simply
775C<select> on the filehandle. This is useful if you want to synchronously wait 1060does a C<select> on the filehandle. This is useful if you want to
776for some requests to finish). 1061synchronously wait for some requests to finish).
777 1062
778See C<nreqs> for an example. 1063See C<nreqs> for an example.
779 1064
1065=item IO::AIO::poll
1066
1067Waits until some requests have been handled.
1068
1069Returns the number of requests processed, but is otherwise strictly
1070equivalent to:
1071
1072 IO::AIO::poll_wait, IO::AIO::poll_cb
1073
780=item IO::AIO::nreqs 1074=item IO::AIO::flush
781 1075
782Returns the number of requests currently outstanding (i.e. for which their 1076Wait till all outstanding AIO requests have been handled.
783callback has not been invoked yet).
784 1077
785Example: wait till there are no outstanding requests anymore: 1078Strictly equivalent to:
786 1079
787 IO::AIO::poll_wait, IO::AIO::poll_cb 1080 IO::AIO::poll_wait, IO::AIO::poll_cb
788 while IO::AIO::nreqs; 1081 while IO::AIO::nreqs;
789 1082
790=item IO::AIO::flush 1083=back
791 1084
792Wait till all outstanding AIO requests have been handled. 1085=head3 CONTROLLING THE NUMBER OF THREADS
793 1086
794Strictly equivalent to: 1087=over
795
796 IO::AIO::poll_wait, IO::AIO::poll_cb
797 while IO::AIO::nreqs;
798
799=item IO::AIO::poll
800
801Waits until some requests have been handled.
802
803Strictly equivalent to:
804
805 IO::AIO::poll_wait, IO::AIO::poll_cb
806 if IO::AIO::nreqs;
807 1088
808=item IO::AIO::min_parallel $nthreads 1089=item IO::AIO::min_parallel $nthreads
809 1090
810Set the minimum number of AIO threads to C<$nthreads>. The current 1091Set the minimum number of AIO threads to C<$nthreads>. The current
811default is C<8>, which means eight asynchronous operations can execute 1092default is C<8>, which means eight asynchronous operations can execute
812concurrently at any one time (the number of outstanding requests, 1093concurrently at any one time (the number of outstanding requests,
813however, is unlimited). 1094however, is unlimited).
814 1095
815IO::AIO starts threads only on demand, when an AIO request is queued and 1096IO::AIO starts threads only on demand, when an AIO request is queued and
816no free thread exists. 1097no free thread exists. Please note that queueing up a hundred requests can
1098create demand for a hundred threads, even if it turns out that everything
1099is in the cache and could have been processed faster by a single thread.
817 1100
818It is recommended to keep the number of threads relatively low, as some 1101It is recommended to keep the number of threads relatively low, as some
819Linux kernel versions will scale negatively with the number of threads 1102Linux kernel versions will scale negatively with the number of threads
820(higher parallelity => MUCH higher latency). With current Linux 2.6 1103(higher parallelity => MUCH higher latency). With current Linux 2.6
821versions, 4-32 threads should be fine. 1104versions, 4-32 threads should be fine.
835This module automatically runs C<max_parallel 0> at program end, to ensure 1118This module automatically runs C<max_parallel 0> at program end, to ensure
836that all threads are killed and that there are no outstanding requests. 1119that all threads are killed and that there are no outstanding requests.
837 1120
838Under normal circumstances you don't need to call this function. 1121Under normal circumstances you don't need to call this function.
839 1122
1123=item IO::AIO::max_idle $nthreads
1124
1125Limit the number of threads (default: 4) that are allowed to idle (i.e.,
1126threads that did not get a request to process within 10 seconds). That
1127means if a thread becomes idle while C<$nthreads> other threads are also
1128idle, it will free its resources and exit.
1129
1130This is useful when you allow a large number of threads (e.g. 100 or 1000)
1131to allow for extremely high load situations, but want to free resources
1132under normal circumstances (1000 threads can easily consume 30MB of RAM).
1133
1134The default is probably ok in most situations, especially if thread
1135creation is fast. If thread creation is very slow on your system you might
1136want to use larger values.
1137
840=item $oldnreqs = IO::AIO::max_outstanding $nreqs 1138=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs
841 1139
842[DEPRECATED] 1140This is a very bad function to use in interactive programs because it
1141blocks, and a bad way to reduce concurrency because it is inexact: Better
1142use an C<aio_group> together with a feed callback.
843 1143
844Sets the maximum number of outstanding requests to C<$nreqs>. If you 1144Sets the maximum number of outstanding requests to C<$nreqs>. If you
845try to queue up more than this number of requests, the caller will block until 1145to queue up more than this number of requests, the next call to the
846some requests have been handled. 1146C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1147function will block until the limit is no longer exceeded.
847 1148
848The default is very large, so normally there is no practical limit. If you 1149The default value is very large, so there is no practical limit on the
849queue up many requests in a loop it often improves speed if you set 1150number of outstanding requests.
850this to a relatively low number, such as C<100>.
851 1151
852This function does not work well together with C<aio_group>'s, and their 1152You can still queue as many requests as you want. Therefore,
853feeder interface is better suited to limiting concurrency, so do not use 1153C<max_oustsanding> is mainly useful in simple scripts (with low values) or
854this function. 1154as a stop gap to shield against fatal memory overflow (with large values).
855 1155
856Under normal circumstances you don't need to call this function. 1156=back
1157
1158=head3 STATISTICAL INFORMATION
1159
1160=over
1161
1162=item IO::AIO::nreqs
1163
1164Returns the number of requests currently in the ready, execute or pending
1165states (i.e. for which their callback has not been invoked yet).
1166
1167Example: wait till there are no outstanding requests anymore:
1168
1169 IO::AIO::poll_wait, IO::AIO::poll_cb
1170 while IO::AIO::nreqs;
1171
1172=item IO::AIO::nready
1173
1174Returns the number of requests currently in the ready state (not yet
1175executed).
1176
1177=item IO::AIO::npending
1178
1179Returns the number of requests currently in the pending state (executed,
1180but not yet processed by poll_cb).
857 1181
858=back 1182=back
859 1183
860=cut 1184=cut
861 1185
875 *$sym 1199 *$sym
876} 1200}
877 1201
878min_parallel 8; 1202min_parallel 8;
879 1203
880END { 1204END { flush }
881 max_parallel 0;
882}
883 1205
8841; 12061;
885 1207
886=head2 FORK BEHAVIOUR 1208=head2 FORK BEHAVIOUR
887 1209
888This module should do "the right thing" when the process using it forks: 1210This module should do "the right thing" when the process using it forks:
889 1211
890Before the fork, IO::AIO enters a quiescent state where no requests 1212Before the fork, IO::AIO enters a quiescent state where no requests
891can be added in other threads and no results will be processed. After 1213can be added in other threads and no results will be processed. After
892the fork the parent simply leaves the quiescent state and continues 1214the fork the parent simply leaves the quiescent state and continues
893request/result processing, while the child clears the request/result 1215request/result processing, while the child frees the request/result queue
894queue (so the requests started before the fork will only be handled in 1216(so that the requests started before the fork will only be handled in the
895the parent). Threads will be started on demand until the limit ste in the 1217parent). Threads will be started on demand until the limit set in the
896parent process has been reached again. 1218parent process has been reached again.
897 1219
898In short: the parent will, after a short pause, continue as if fork had 1220In short: the parent will, after a short pause, continue as if fork had
899not been called, while the child will act as if IO::AIO has not been used 1221not been called, while the child will act as if IO::AIO has not been used
900yet. 1222yet.
901 1223
902=head2 MEMORY USAGE 1224=head2 MEMORY USAGE
903 1225
1226Per-request usage:
1227
904Each aio request uses - depending on your architecture - around 128 bytes 1228Each aio request uses - depending on your architecture - around 100-200
905of memory. In addition, stat requests need a stat buffer (possibly a few 1229bytes of memory. In addition, stat requests need a stat buffer (possibly
906hundred bytes). Perl scalars and other data passed into aio requests will 1230a few hundred bytes), readdir requires a result buffer and so on. Perl
907also be locked. 1231scalars and other data passed into aio requests will also be locked and
1232will consume memory till the request has entered the done state.
908 1233
909This is now awfully much, so queuing lots of requests is not usually a 1234This is now awfully much, so queuing lots of requests is not usually a
910problem. 1235problem.
911 1236
912Each thread needs a stack area which is usually around 16k, sometimes much 1237Per-thread usage:
913larger, depending on the OS. 1238
1239In the execution phase, some aio requests require more memory for
1240temporary buffers, and each thread requires a stack and other data
1241structures (usually around 16k-128k, depending on the OS).
1242
1243=head1 KNOWN BUGS
1244
1245Known bugs will be fixed in the next release.
914 1246
915=head1 SEE ALSO 1247=head1 SEE ALSO
916 1248
917L<Coro::AIO>. 1249L<Coro::AIO>.
918 1250

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines