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.86 by root, Sat Oct 28 23:32:29 2006 UTC vs.
Revision 1.109 by root, Sun Jun 3 09:44:17 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
… …
61etc.), but can also be used to easily do operations in parallel that are 62etc.), but can also be used to easily do operations in parallel that are
62normally done sequentially, e.g. stat'ing many files, which is much faster 63normally done sequentially, e.g. stat'ing many files, which is much faster
63on a RAID volume or over NFS when you do a number of stat operations 64on a RAID volume or over NFS when you do a number of stat operations
64concurrently. 65concurrently.
65 66
66While this works on all types of file descriptors (for example sockets), 67While most of this works on all types of file descriptors (for
67using these functions on file descriptors that support nonblocking 68example sockets), using these functions on file descriptors that
68operation (again, sockets, pipes etc.) is very inefficient. Use an event 69support nonblocking operation (again, sockets, pipes etc.) is very
69loop for that (such as the L<Event|Event> module): IO::AIO will naturally 70inefficient. Use an event loop for that (such as the L<Event|Event>
70fit into such an event loop itself. 71module): IO::AIO will naturally fit into such an event loop itself.
71 72
72In this version, a number of threads are started that execute your 73In this version, a number of threads are started that execute your
73requests and signal their completion. You don't need thread support 74requests and signal their completion. You don't need thread support
74in perl, and the threads created by this module will not be visible 75in perl, and the threads created by this module will not be visible
75to perl. In the future, this module might make use of the native aio 76to perl. In the future, this module might make use of the native aio
… …
77not well-supported or restricted (GNU/Linux doesn't allow them on normal 78not well-supported or restricted (GNU/Linux doesn't allow them on normal
78files currently, for example), and they would only support aio_read and 79files currently, for example), and they would only support aio_read and
79aio_write, so the remaining functionality would have to be implemented 80aio_write, so the remaining functionality would have to be implemented
80using threads anyway. 81using threads anyway.
81 82
82Although the module will work with in the presence of other (Perl-) 83Although the module will work in the presence of other (Perl-) threads,
83threads, it is currently not reentrant in any way, so use appropriate 84it is currently not reentrant in any way, so use appropriate locking
84locking yourself, always call C<poll_cb> from within the same thread, or 85yourself, always call C<poll_cb> from within the same thread, or never
85never call C<poll_cb> (or other C<aio_> functions) recursively. 86call C<poll_cb> (or other C<aio_> functions) recursively.
86 87
87=head2 EXAMPLE 88=head2 EXAMPLE
88 89
89This is a simple example that uses the Event module and loads 90This is a simple example that uses the Event module and loads
90F</etc/passwd> asynchronously: 91F</etc/passwd> asynchronously:
… …
98 poll => 'r', 99 poll => 'r',
99 cb => \&IO::AIO::poll_cb); 100 cb => \&IO::AIO::poll_cb);
100 101
101 # queue the request to open /etc/passwd 102 # queue the request to open /etc/passwd
102 aio_open "/etc/passwd", O_RDONLY, 0, sub { 103 aio_open "/etc/passwd", O_RDONLY, 0, sub {
103 my $fh = $_[0] 104 my $fh = shift
104 or die "error while opening: $!"; 105 or die "error while opening: $!";
105 106
106 # stat'ing filehandles is generally non-blocking 107 # stat'ing filehandles is generally non-blocking
107 my $size = -s $fh; 108 my $size = -s $fh;
108 109
… …
176Request has reached the end of its lifetime and holds no resources anymore 177Request has reached the end of its lifetime and holds no resources anymore
177(except possibly for the Perl object, but its connection to the actual 178(except possibly for the Perl object, but its connection to the actual
178aio request is severed and calling its methods will either do nothing or 179aio request is severed and calling its methods will either do nothing or
179result in a runtime error). 180result in a runtime error).
180 181
182=back
183
181=cut 184=cut
182 185
183package IO::AIO; 186package IO::AIO;
184 187
185no warnings; 188no warnings;
186use strict 'vars'; 189use strict 'vars';
187 190
188use base 'Exporter'; 191use base 'Exporter';
189 192
190BEGIN { 193BEGIN {
191 our $VERSION = '2.1'; 194 our $VERSION = '2.4';
192 195
193 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 196 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
194 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 197 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
195 aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move 198 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link
199 aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir
196 aio_copy aio_group aio_nop aio_mknod); 200 aio_chown aio_chmod aio_utime);
197 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block));
198 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
199 min_parallel max_parallel max_idle 203 min_parallel max_parallel max_idle
200 nreqs nready npending nthreads 204 nreqs nready npending nthreads
201 max_poll_time max_poll_reqs); 205 max_poll_time max_poll_reqs);
202 206
… …
206 XSLoader::load ("IO::AIO", $VERSION); 210 XSLoader::load ("IO::AIO", $VERSION);
207} 211}
208 212
209=head1 FUNCTIONS 213=head1 FUNCTIONS
210 214
211=head2 AIO FUNCTIONS 215=head2 AIO REQUEST FUNCTIONS
212 216
213All 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
214with 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,
215and they all accept an additional (and optional) C<$callback> argument 219and they all accept an additional (and optional) C<$callback> argument
216which 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
… …
219syscall has been executed asynchronously. 223syscall has been executed asynchronously.
220 224
221All functions expecting a filehandle keep a copy of the filehandle 225All functions expecting a filehandle keep a copy of the filehandle
222internally until the request has finished. 226internally until the request has finished.
223 227
224All 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
225manipulation of those requests while they are in-flight. 229further manipulation of those requests while they are in-flight.
226 230
227The pathnames you pass to these routines I<must> be absolute and 231The pathnames you pass to these routines I<must> be absolute and
228encoded 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
229request is being executed, the current working directory could have 233request is being executed, the current working directory could have
230changed. Alternatively, you can make sure that you never change the 234changed. Alternatively, you can make sure that you never change the
231current working directory. 235current working directory anywhere in the program and then use relative
236paths.
232 237
233To encode pathnames to byte form, either make sure you either: a) 238To encode pathnames as octets, either make sure you either: a) always pass
234always pass in filenames you got from outside (command line, readdir 239in filenames you got from outside (command line, readdir etc.) without
235etc.), 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
236your 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
237environment, d) use Glib::filename_from_unicode on unicode filenames or e) 242environment, d) use Glib::filename_from_unicode on unicode filenames or e)
238use 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.
239 247
240=over 4 248=over 4
241 249
242=item $prev_pri = aioreq_pri [$pri] 250=item $prev_pri = aioreq_pri [$pri]
243 251
… …
263 aio_read $_[0], ..., sub { 271 aio_read $_[0], ..., sub {
264 ... 272 ...
265 }; 273 };
266 }; 274 };
267 275
276
268=item aioreq_nice $pri_adjust 277=item aioreq_nice $pri_adjust
269 278
270Similar to C<aioreq_pri>, but subtracts the given value from the current 279Similar to C<aioreq_pri>, but subtracts the given value from the current
271priority, so effects are cumulative. 280priority, so the effect is cumulative.
281
272 282
273=item aio_open $pathname, $flags, $mode, $callback->($fh) 283=item aio_open $pathname, $flags, $mode, $callback->($fh)
274 284
275Asynchronously open or create a file and call the callback with a newly 285Asynchronously open or create a file and call the callback with a newly
276created filehandle for the file. 286created filehandle for the file.
… …
282list. They are the same as used by C<sysopen>. 292list. They are the same as used by C<sysopen>.
283 293
284Likewise, C<$mode> specifies the mode of the newly created file, if it 294Likewise, C<$mode> specifies the mode of the newly created file, if it
285didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, 295didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,
286except that it is mandatory (i.e. use C<0> if you don't create new files, 296except that it is mandatory (i.e. use C<0> if you don't create new files,
287and C<0666> or C<0777> if you do). 297and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified
298by the umask in effect then the request is being executed, so better never
299change the umask.
288 300
289Example: 301Example:
290 302
291 aio_open "/etc/passwd", O_RDONLY, 0, sub { 303 aio_open "/etc/passwd", O_RDONLY, 0, sub {
292 if ($_[0]) { 304 if ($_[0]) {
… …
295 } else { 307 } else {
296 die "open failed: $!\n"; 308 die "open failed: $!\n";
297 } 309 }
298 }; 310 };
299 311
312
300=item aio_close $fh, $callback->($status) 313=item aio_close $fh, $callback->($status)
301 314
302Asynchronously close a file and call the callback with the result 315Asynchronously close a file and call the callback with the result
303code. I<WARNING:> although accepted, you should not pass in a perl 316code. I<WARNING:> although accepted, you should not pass in a perl
304filehandle here, as perl will likely close the file descriptor another 317filehandle here, as perl will likely close the file descriptor another
… …
306C<close> or just let filehandles go out of scope. 319C<close> or just let filehandles go out of scope.
307 320
308This is supposed to be a bug in the API, so that might change. It's 321This is supposed to be a bug in the API, so that might change. It's
309therefore best to avoid this function. 322therefore best to avoid this function.
310 323
324
311=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 325=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
312 326
313=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 327=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
314 328
315Reads or writes C<length> bytes from the specified C<fh> and C<offset> 329Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset>
316into the scalar given by C<data> and offset C<dataoffset> and calls the 330into the scalar given by C<$data> and offset C<$dataoffset> and calls the
317callback without the actual number of bytes read (or -1 on error, just 331callback without the actual number of bytes read (or -1 on error, just
318like the syscall). 332like the syscall).
319 333
334If C<$offset> is undefined, then the current file offset will be used (and
335updated), otherwise the file offset will not be changed by these calls.
336
337If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>.
338
339If C<$dataoffset> is less than zero, it will be counted from the end of
340C<$data>.
341
320The C<$data> scalar I<MUST NOT> be modified in any way while the request 342The C<$data> scalar I<MUST NOT> be modified in any way while the request
321is outstanding. Modifying it can result in segfaults or WW3 (if the 343is outstanding. Modifying it can result in segfaults or World War III (if
322necessary/optional hardware is installed). 344the necessary/optional hardware is installed).
323 345
324Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at 346Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
325offset C<0> within the scalar: 347offset C<0> within the scalar:
326 348
327 aio_read $fh, 7, 15, $buffer, 0, sub { 349 aio_read $fh, 7, 15, $buffer, 0, sub {
328 $_[0] > 0 or die "read error: $!"; 350 $_[0] > 0 or die "read error: $!";
329 print "read $_[0] bytes: <$buffer>\n"; 351 print "read $_[0] bytes: <$buffer>\n";
330 }; 352 };
353
331 354
332=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 355=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
333 356
334Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 357Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
335reading at byte offset C<$in_offset>, and starts writing at the current 358reading at byte offset C<$in_offset>, and starts writing at the current
… …
349C<$in_fh> than are written, and there is no way to find out how many 372C<$in_fh> than are written, and there is no way to find out how many
350bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 373bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
351provides the number of bytes written to C<$out_fh>. Only if the result 374provides the number of bytes written to C<$out_fh>. Only if the result
352value equals C<$length> one can assume that C<$length> bytes have been 375value equals C<$length> one can assume that C<$length> bytes have been
353read. 376read.
377
354 378
355=item aio_readahead $fh,$offset,$length, $callback->($retval) 379=item aio_readahead $fh,$offset,$length, $callback->($retval)
356 380
357C<aio_readahead> populates the page cache with data from a file so that 381C<aio_readahead> populates the page cache with data from a file so that
358subsequent reads from that file will not block on disk I/O. The C<$offset> 382subsequent reads from that file will not block on disk I/O. The C<$offset>
… …
364file. The current file offset of the file is left unchanged. 388file. The current file offset of the file is left unchanged.
365 389
366If that syscall doesn't exist (likely if your OS isn't Linux) it will be 390If that syscall doesn't exist (likely if your OS isn't Linux) it will be
367emulated by simply reading the data, which would have a similar effect. 391emulated by simply reading the data, which would have a similar effect.
368 392
393
369=item aio_stat $fh_or_path, $callback->($status) 394=item aio_stat $fh_or_path, $callback->($status)
370 395
371=item aio_lstat $fh, $callback->($status) 396=item aio_lstat $fh, $callback->($status)
372 397
373Works like perl's C<stat> or C<lstat> in void context. The callback will 398Works like perl's C<stat> or C<lstat> in void context. The callback will
… …
386 aio_stat "/etc/passwd", sub { 411 aio_stat "/etc/passwd", sub {
387 $_[0] and die "stat failed: $!"; 412 $_[0] and die "stat failed: $!";
388 print "size is ", -s _, "\n"; 413 print "size is ", -s _, "\n";
389 }; 414 };
390 415
416
417=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
418
419Works like perl's C<utime> function (including the special case of $atime
420and $mtime being undef). Fractional times are supported if the underlying
421syscalls support them.
422
423When called with a pathname, uses utimes(2) if available, otherwise
424utime(2). If called on a file descriptor, uses futimes(2) if available,
425otherwise returns ENOSYS, so this is not portable.
426
427Examples:
428
429 # set atime and mtime to current time (basically touch(1)):
430 aio_utime "path", undef, undef;
431 # set atime to current time and mtime to beginning of the epoch:
432 aio_utime "path", time, undef; # undef==0
433
434
435=item aio_chown $fh_or_path, $uid, $gid, $callback->($status)
436
437Works like perl's C<chown> function, except that C<undef> for either $uid
438or $gid is being interpreted as "do not change" (but -1 can also be used).
439
440Examples:
441
442 # same as "chown root path" in the shell:
443 aio_chown "path", 0, -1;
444 # same as above:
445 aio_chown "path", 0, undef;
446
447
448=item aio_chmod $fh_or_path, $mode, $callback->($status)
449
450Works like perl's C<chmod> function.
451
452
391=item aio_unlink $pathname, $callback->($status) 453=item aio_unlink $pathname, $callback->($status)
392 454
393Asynchronously unlink (delete) a file and call the callback with the 455Asynchronously unlink (delete) a file and call the callback with the
394result code. 456result code.
395 457
458
396=item aio_mknod $path, $mode, $dev, $callback->($status) 459=item aio_mknod $path, $mode, $dev, $callback->($status)
397 460
398[EXPERIMENTAL] 461[EXPERIMENTAL]
399 462
400Asynchronously create a device node (or fifo). See mknod(2). 463Asynchronously create a device node (or fifo). See mknod(2).
401 464
402The only (POSIX-) portable way of calling this function is: 465The only (POSIX-) portable way of calling this function is:
403 466
404 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 467 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
468
405 469
406=item aio_link $srcpath, $dstpath, $callback->($status) 470=item aio_link $srcpath, $dstpath, $callback->($status)
407 471
408Asynchronously create a new link to the existing object at C<$srcpath> at 472Asynchronously create a new link to the existing object at C<$srcpath> at
409the path C<$dstpath> and call the callback with the result code. 473the path C<$dstpath> and call the callback with the result code.
410 474
475
411=item aio_symlink $srcpath, $dstpath, $callback->($status) 476=item aio_symlink $srcpath, $dstpath, $callback->($status)
412 477
413Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 478Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
414the path C<$dstpath> and call the callback with the result code. 479the path C<$dstpath> and call the callback with the result code.
415 480
481
482=item aio_readlink $path, $callback->($link)
483
484Asynchronously read the symlink specified by C<$path> and pass it to
485the callback. If an error occurs, nothing or undef gets passed to the
486callback.
487
488
416=item aio_rename $srcpath, $dstpath, $callback->($status) 489=item aio_rename $srcpath, $dstpath, $callback->($status)
417 490
418Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 491Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
419rename(2) and call the callback with the result code. 492rename(2) and call the callback with the result code.
420 493
494
495=item aio_mkdir $pathname, $mode, $callback->($status)
496
497Asynchronously mkdir (create) a directory and call the callback with
498the result code. C<$mode> will be modified by the umask at the time the
499request is executed, so do not change your umask.
500
501
421=item aio_rmdir $pathname, $callback->($status) 502=item aio_rmdir $pathname, $callback->($status)
422 503
423Asynchronously rmdir (delete) a directory and call the callback with the 504Asynchronously rmdir (delete) a directory and call the callback with the
424result code. 505result code.
506
425 507
426=item aio_readdir $pathname, $callback->($entries) 508=item aio_readdir $pathname, $callback->($entries)
427 509
428Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 510Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
429directory (i.e. opendir + readdir + closedir). The entries will not be 511directory (i.e. opendir + readdir + closedir). The entries will not be
430sorted, and will B<NOT> include the C<.> and C<..> entries. 512sorted, and will B<NOT> include the C<.> and C<..> entries.
431 513
432The callback a single argument which is either C<undef> or an array-ref 514The callback a single argument which is either C<undef> or an array-ref
433with the filenames. 515with the filenames.
516
517
518=item aio_load $path, $data, $callback->($status)
519
520This is a composite request that tries to fully load the given file into
521memory. Status is the same as with aio_read.
522
523=cut
524
525sub aio_load($$;$) {
526 aio_block {
527 my ($path, undef, $cb) = @_;
528 my $data = \$_[1];
529
530 my $pri = aioreq_pri;
531 my $grp = aio_group $cb;
532
533 aioreq_pri $pri;
534 add $grp aio_open $path, O_RDONLY, 0, sub {
535 my $fh = shift
536 or return $grp->result (-1);
537
538 aioreq_pri $pri;
539 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
540 $grp->result ($_[0]);
541 };
542 };
543
544 $grp
545 }
546}
434 547
435=item aio_copy $srcpath, $dstpath, $callback->($status) 548=item aio_copy $srcpath, $dstpath, $callback->($status)
436 549
437Try to copy the I<file> (directories not supported as either source or 550Try to copy the I<file> (directories not supported as either source or
438destination) from C<$srcpath> to C<$dstpath> and call the callback with 551destination) from C<$srcpath> to C<$dstpath> and call the callback with
… …
448errors are being ignored. 561errors are being ignored.
449 562
450=cut 563=cut
451 564
452sub aio_copy($$;$) { 565sub aio_copy($$;$) {
566 aio_block {
453 my ($src, $dst, $cb) = @_; 567 my ($src, $dst, $cb) = @_;
454 568
455 my $pri = aioreq_pri; 569 my $pri = aioreq_pri;
456 my $grp = aio_group $cb; 570 my $grp = aio_group $cb;
457 571
458 aioreq_pri $pri; 572 aioreq_pri $pri;
459 add $grp aio_open $src, O_RDONLY, 0, sub { 573 add $grp aio_open $src, O_RDONLY, 0, sub {
460 if (my $src_fh = $_[0]) { 574 if (my $src_fh = $_[0]) {
461 my @stat = stat $src_fh; 575 my @stat = stat $src_fh;
462 576
463 aioreq_pri $pri; 577 aioreq_pri $pri;
464 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 578 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
465 if (my $dst_fh = $_[0]) { 579 if (my $dst_fh = $_[0]) {
466 aioreq_pri $pri; 580 aioreq_pri $pri;
467 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 581 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
468 if ($_[0] == $stat[7]) { 582 if ($_[0] == $stat[7]) {
469 $grp->result (0); 583 $grp->result (0);
470 close $src_fh; 584 close $src_fh;
471 585
472 # those should not normally block. should. should. 586 # those should not normally block. should. should.
473 utime $stat[8], $stat[9], $dst; 587 utime $stat[8], $stat[9], $dst;
474 chmod $stat[2] & 07777, $dst_fh; 588 chmod $stat[2] & 07777, $dst_fh;
475 chown $stat[4], $stat[5], $dst_fh; 589 chown $stat[4], $stat[5], $dst_fh;
476 close $dst_fh; 590 close $dst_fh;
477 } else { 591 } else {
478 $grp->result (-1); 592 $grp->result (-1);
479 close $src_fh; 593 close $src_fh;
480 close $dst_fh; 594 close $dst_fh;
481 595
482 aioreq $pri; 596 aioreq $pri;
483 add $grp aio_unlink $dst; 597 add $grp aio_unlink $dst;
598 }
484 } 599 };
600 } else {
601 $grp->result (-1);
485 }; 602 }
486 } else {
487 $grp->result (-1);
488 } 603 },
604
605 } else {
606 $grp->result (-1);
489 }, 607 }
490
491 } else {
492 $grp->result (-1);
493 } 608 };
609
610 $grp
494 }; 611 }
495
496 $grp
497} 612}
498 613
499=item aio_move $srcpath, $dstpath, $callback->($status) 614=item aio_move $srcpath, $dstpath, $callback->($status)
500 615
501Try to move the I<file> (directories not supported as either source or 616Try to move the I<file> (directories not supported as either source or
… …
507that is successful, unlinking the C<$srcpath>. 622that is successful, unlinking the C<$srcpath>.
508 623
509=cut 624=cut
510 625
511sub aio_move($$;$) { 626sub aio_move($$;$) {
627 aio_block {
512 my ($src, $dst, $cb) = @_; 628 my ($src, $dst, $cb) = @_;
513 629
514 my $pri = aioreq_pri; 630 my $pri = aioreq_pri;
515 my $grp = aio_group $cb; 631 my $grp = aio_group $cb;
516 632
517 aioreq_pri $pri; 633 aioreq_pri $pri;
518 add $grp aio_rename $src, $dst, sub { 634 add $grp aio_rename $src, $dst, sub {
519 if ($_[0] && $! == EXDEV) { 635 if ($_[0] && $! == EXDEV) {
520 aioreq_pri $pri; 636 aioreq_pri $pri;
521 add $grp aio_copy $src, $dst, sub { 637 add $grp aio_copy $src, $dst, sub {
638 $grp->result ($_[0]);
639
640 if (!$_[0]) {
641 aioreq_pri $pri;
642 add $grp aio_unlink $src;
643 }
644 };
645 } else {
522 $grp->result ($_[0]); 646 $grp->result ($_[0]);
523
524 if (!$_[0]) {
525 aioreq_pri $pri;
526 add $grp aio_unlink $src;
527 }
528 }; 647 }
529 } else {
530 $grp->result ($_[0]);
531 } 648 };
649
650 $grp
532 }; 651 }
533
534 $grp
535} 652}
536 653
537=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 654=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
538 655
539Scans a directory (similar to C<aio_readdir>) but additionally tries to 656Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
586as those tend to return 0 or 1 as link counts, which disables the 703as those tend to return 0 or 1 as link counts, which disables the
587directory counting heuristic. 704directory counting heuristic.
588 705
589=cut 706=cut
590 707
591sub aio_scandir($$$) { 708sub aio_scandir($$;$) {
709 aio_block {
592 my ($path, $maxreq, $cb) = @_; 710 my ($path, $maxreq, $cb) = @_;
593 711
594 my $pri = aioreq_pri; 712 my $pri = aioreq_pri;
595 713
596 my $grp = aio_group $cb; 714 my $grp = aio_group $cb;
597 715
598 $maxreq = 4 if $maxreq <= 0; 716 $maxreq = 4 if $maxreq <= 0;
599 717
600 # stat once 718 # stat once
601 aioreq_pri $pri;
602 add $grp aio_stat $path, sub {
603 return $grp->result () if $_[0];
604 my $now = time;
605 my $hash1 = join ":", (stat _)[0,1,3,7,9];
606
607 # read the directory entries
608 aioreq_pri $pri; 719 aioreq_pri $pri;
609 add $grp aio_readdir $path, sub { 720 add $grp aio_stat $path, sub {
610 my $entries = shift
611 or return $grp->result (); 721 return $grp->result () if $_[0];
722 my $now = time;
723 my $hash1 = join ":", (stat _)[0,1,3,7,9];
612 724
613 # stat the dir another time 725 # read the directory entries
614 aioreq_pri $pri; 726 aioreq_pri $pri;
727 add $grp aio_readdir $path, sub {
728 my $entries = shift
729 or return $grp->result ();
730
731 # stat the dir another time
732 aioreq_pri $pri;
615 add $grp aio_stat $path, sub { 733 add $grp aio_stat $path, sub {
616 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 734 my $hash2 = join ":", (stat _)[0,1,3,7,9];
617 735
618 my $ndirs; 736 my $ndirs;
619 737
620 # take the slow route if anything looks fishy 738 # take the slow route if anything looks fishy
621 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 739 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
622 $ndirs = -1; 740 $ndirs = -1;
623 } else { 741 } else {
624 # if nlink == 2, we are finished 742 # if nlink == 2, we are finished
625 # on non-posix-fs's, we rely on nlink < 2 743 # on non-posix-fs's, we rely on nlink < 2
626 $ndirs = (stat _)[3] - 2 744 $ndirs = (stat _)[3] - 2
627 or return $grp->result ([], $entries); 745 or return $grp->result ([], $entries);
628 } 746 }
629 747
630 # sort into likely dirs and likely nondirs 748 # sort into likely dirs and likely nondirs
631 # dirs == files without ".", short entries first 749 # dirs == files without ".", short entries first
632 $entries = [map $_->[0], 750 $entries = [map $_->[0],
633 sort { $b->[1] cmp $a->[1] } 751 sort { $b->[1] cmp $a->[1] }
634 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], 752 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
635 @$entries]; 753 @$entries];
636 754
637 my (@dirs, @nondirs); 755 my (@dirs, @nondirs);
638 756
639 my $statgrp = add $grp aio_group sub { 757 my $statgrp = add $grp aio_group sub {
640 $grp->result (\@dirs, \@nondirs); 758 $grp->result (\@dirs, \@nondirs);
641 }; 759 };
642 760
643 limit $statgrp $maxreq; 761 limit $statgrp $maxreq;
644 feed $statgrp sub { 762 feed $statgrp sub {
645 return unless @$entries; 763 return unless @$entries;
646 my $entry = pop @$entries; 764 my $entry = pop @$entries;
647 765
648 aioreq_pri $pri; 766 aioreq_pri $pri;
649 add $statgrp aio_stat "$path/$entry/.", sub { 767 add $statgrp aio_stat "$path/$entry/.", sub {
650 if ($_[0] < 0) { 768 if ($_[0] < 0) {
651 push @nondirs, $entry; 769 push @nondirs, $entry;
652 } else { 770 } else {
653 # need to check for real directory 771 # need to check for real directory
654 aioreq_pri $pri; 772 aioreq_pri $pri;
655 add $statgrp aio_lstat "$path/$entry", sub { 773 add $statgrp aio_lstat "$path/$entry", sub {
656 if (-d _) { 774 if (-d _) {
657 push @dirs, $entry; 775 push @dirs, $entry;
658 776
659 unless (--$ndirs) { 777 unless (--$ndirs) {
660 push @nondirs, @$entries; 778 push @nondirs, @$entries;
661 feed $statgrp; 779 feed $statgrp;
780 }
781 } else {
782 push @nondirs, $entry;
662 } 783 }
663 } else {
664 push @nondirs, $entry;
665 } 784 }
666 } 785 }
667 } 786 };
668 }; 787 };
669 }; 788 };
670 }; 789 };
671 }; 790 };
791
792 $grp
672 }; 793 }
794}
673 795
796=item aio_rmtree $path, $callback->($status)
797
798Delete a directory tree starting (and including) C<$path>, return the
799status of the final C<rmdir> only. This is a composite request that
800uses C<aio_scandir> to recurse into and rmdir directories, and unlink
801everything else.
802
803=cut
804
805sub aio_rmtree;
806sub aio_rmtree($;$) {
807 aio_block {
808 my ($path, $cb) = @_;
809
810 my $pri = aioreq_pri;
811 my $grp = aio_group $cb;
812
813 aioreq_pri $pri;
814 add $grp aio_scandir $path, 0, sub {
815 my ($dirs, $nondirs) = @_;
816
817 my $dirgrp = aio_group sub {
818 add $grp aio_rmdir $path, sub {
819 $grp->result ($_[0]);
820 };
821 };
822
823 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
824 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
825
826 add $grp $dirgrp;
827 };
828
674 $grp 829 $grp
830 }
675} 831}
676 832
677=item aio_fsync $fh, $callback->($status) 833=item aio_fsync $fh, $callback->($status)
678 834
679Asynchronously call fsync on the given filehandle and call the callback 835Asynchronously call fsync on the given filehandle and call the callback
… …
933that are being processed by C<IO::AIO::poll_cb> in one call, respectively 1089that are being processed by C<IO::AIO::poll_cb> in one call, respectively
934the maximum amount of time (default C<0>, meaning infinity) spent in 1090the maximum amount of time (default C<0>, meaning infinity) spent in
935C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount 1091C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
936of time C<poll_cb> is allowed to use). 1092of time C<poll_cb> is allowed to use).
937 1093
1094Setting C<max_poll_time> to a non-zero value creates an overhead of one
1095syscall per request processed, which is not normally a problem unless your
1096callbacks are really really fast or your OS is really really slow (I am
1097not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
1098
938Setting these is useful if you want to ensure some level of 1099Setting these is useful if you want to ensure some level of
939interactiveness when perl is not fast enough to process all requests in 1100interactiveness when perl is not fast enough to process all requests in
940time. 1101time.
941 1102
942For interactive programs, values such as C<0.01> to C<0.1> should be fine. 1103For interactive programs, values such as C<0.01> to C<0.1> should be fine.
943 1104
944Example: Install an Event watcher that automatically calls 1105Example: Install an Event watcher that automatically calls
945IO::AIO::poll_some with low priority, to ensure that other parts of the 1106IO::AIO::poll_cb with low priority, to ensure that other parts of the
946program get the CPU sometimes even under high AIO load. 1107program get the CPU sometimes even under high AIO load.
947 1108
948 # try not to spend much more than 0.1s in poll_cb 1109 # try not to spend much more than 0.1s in poll_cb
949 IO::AIO::max_poll_time 0.1; 1110 IO::AIO::max_poll_time 0.1;
950 1111
… …
953 poll => 'r', nice => 1, 1114 poll => 'r', nice => 1,
954 cb => &IO::AIO::poll_cb); 1115 cb => &IO::AIO::poll_cb);
955 1116
956=item IO::AIO::poll_wait 1117=item IO::AIO::poll_wait
957 1118
1119If there are any outstanding requests and none of them in the result
958Wait till the result filehandle becomes ready for reading (simply does a 1120phase, wait till the result filehandle becomes ready for reading (simply
959C<select> on the filehandle. This is useful if you want to synchronously 1121does a C<select> on the filehandle. This is useful if you want to
960wait for some requests to finish). 1122synchronously wait for some requests to finish).
961 1123
962See C<nreqs> for an example. 1124See C<nreqs> for an example.
963 1125
964=item IO::AIO::poll 1126=item IO::AIO::poll
965 1127
966Waits until some requests have been handled. 1128Waits until some requests have been handled.
967 1129
1130Returns the number of requests processed, but is otherwise strictly
968Strictly equivalent to: 1131equivalent to:
969 1132
970 IO::AIO::poll_wait, IO::AIO::poll_cb 1133 IO::AIO::poll_wait, IO::AIO::poll_cb
971 if IO::AIO::nreqs;
972 1134
973=item IO::AIO::flush 1135=item IO::AIO::flush
974 1136
975Wait till all outstanding AIO requests have been handled. 1137Wait till all outstanding AIO requests have been handled.
976 1138
977Strictly equivalent to: 1139Strictly equivalent to:
978 1140
979 IO::AIO::poll_wait, IO::AIO::poll_cb 1141 IO::AIO::poll_wait, IO::AIO::poll_cb
980 while IO::AIO::nreqs; 1142 while IO::AIO::nreqs;
981 1143
1144=back
1145
982=head3 CONTROLLING THE NUMBER OF THREADS 1146=head3 CONTROLLING THE NUMBER OF THREADS
1147
1148=over
983 1149
984=item IO::AIO::min_parallel $nthreads 1150=item IO::AIO::min_parallel $nthreads
985 1151
986Set the minimum number of AIO threads to C<$nthreads>. The current 1152Set the minimum number of AIO threads to C<$nthreads>. The current
987default is C<8>, which means eight asynchronous operations can execute 1153default is C<8>, which means eight asynchronous operations can execute
… …
1046 1212
1047You can still queue as many requests as you want. Therefore, 1213You can still queue as many requests as you want. Therefore,
1048C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1214C<max_oustsanding> is mainly useful in simple scripts (with low values) or
1049as a stop gap to shield against fatal memory overflow (with large values). 1215as a stop gap to shield against fatal memory overflow (with large values).
1050 1216
1217=back
1218
1051=head3 STATISTICAL INFORMATION 1219=head3 STATISTICAL INFORMATION
1220
1221=over
1052 1222
1053=item IO::AIO::nreqs 1223=item IO::AIO::nreqs
1054 1224
1055Returns the number of requests currently in the ready, execute or pending 1225Returns the number of requests currently in the ready, execute or pending
1056states (i.e. for which their callback has not been invoked yet). 1226states (i.e. for which their callback has not been invoked yet).
… …
1090 *$sym 1260 *$sym
1091} 1261}
1092 1262
1093min_parallel 8; 1263min_parallel 8;
1094 1264
1095END { 1265END { flush }
1096 min_parallel 1;
1097 flush;
1098};
1099 1266
11001; 12671;
1101 1268
1102=head2 FORK BEHAVIOUR 1269=head2 FORK BEHAVIOUR
1103 1270

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines