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.156 by root, Tue Jun 16 23:41:59 2009 UTC vs.
Revision 1.210 by root, Tue Sep 27 01:43:03 2011 UTC

… …
4 4
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", IO::AIO::O_RDONLY, 0, sub {
10 my $fh = shift 10 my $fh = shift
11 or die "/etc/passwd: $!"; 11 or die "/etc/passwd: $!";
12 ... 12 ...
13 }; 13 };
14 14
… …
25 my $req = aio_unlink "/tmp/file", sub { }; 25 my $req = aio_unlink "/tmp/file", sub { };
26 $req->cancel; # cancel request if still in queue 26 $req->cancel; # cancel request if still in queue
27 27
28 my $grp = aio_group sub { print "all stats done\n" }; 28 my $grp = aio_group sub { print "all stats done\n" };
29 add $grp aio_stat "..." for ...; 29 add $grp aio_stat "..." for ...;
30
31 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
32 use AnyEvent::AIO;
33
34 # EV integration
35 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
36
37 # Event integration
38 Event->io (fd => IO::AIO::poll_fileno,
39 poll => 'r',
40 cb => \&IO::AIO::poll_cb);
41
42 # Glib/Gtk2 integration
43 add_watch Glib::IO IO::AIO::poll_fileno,
44 in => sub { IO::AIO::poll_cb; 1 };
45
46 # Tk integration
47 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
48 readable => \&IO::AIO::poll_cb);
49
50 # Danga::Socket integration
51 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
52 \&IO::AIO::poll_cb);
53 30
54=head1 DESCRIPTION 31=head1 DESCRIPTION
55 32
56This module implements asynchronous I/O using whatever means your 33This module implements asynchronous I/O using whatever means your
57operating system supports. It is implemented as an interface to C<libeio> 34operating system supports. It is implemented as an interface to C<libeio>
… …
99 76
100 # register the IO::AIO callback with EV 77 # register the IO::AIO callback with EV
101 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; 78 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
102 79
103 # queue the request to open /etc/passwd 80 # queue the request to open /etc/passwd
104 aio_open "/etc/passwd", O_RDONLY, 0, sub { 81 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
105 my $fh = shift 82 my $fh = shift
106 or die "error while opening: $!"; 83 or die "error while opening: $!";
107 84
108 # stat'ing filehandles is generally non-blocking 85 # stat'ing filehandles is generally non-blocking
109 my $size = -s $fh; 86 my $size = -s $fh;
… …
186 163
187package IO::AIO; 164package IO::AIO;
188 165
189use Carp (); 166use Carp ();
190 167
191no warnings; 168use common::sense;
192use strict 'vars';
193 169
194use base 'Exporter'; 170use base 'Exporter';
195 171
196BEGIN { 172BEGIN {
197 our $VERSION = '3.23'; 173 our $VERSION = '4.0';
198 174
199 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close 175 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
200 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx 176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
201 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync 177 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync
202 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead 178 aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate
179 aio_pathsync aio_readahead
203 aio_rename aio_link aio_move aio_copy aio_group 180 aio_rename aio_link aio_move aio_copy aio_group
204 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 181 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
205 aio_chmod aio_utime aio_truncate); 182 aio_chmod aio_utime aio_truncate
183 aio_msync aio_mtouch aio_mlock aio_mlockall
184 aio_statvfs
185 aio_wd);
206 186
207 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 187 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
208 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 188 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
209 min_parallel max_parallel max_idle 189 min_parallel max_parallel max_idle idle_timeout
210 nreqs nready npending nthreads 190 nreqs nready npending nthreads
211 max_poll_time max_poll_reqs); 191 max_poll_time max_poll_reqs
192 sendfile fadvise madvise
193 mmap munmap munlock munlockall);
212 194
213 push @AIO_REQ, qw(aio_busy); # not exported 195 push @AIO_REQ, qw(aio_busy); # not exported
214 196
215 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 197 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
216 198
217 require XSLoader; 199 require XSLoader;
218 XSLoader::load ("IO::AIO", $VERSION); 200 XSLoader::load ("IO::AIO", $VERSION);
219} 201}
220 202
221=head1 FUNCTIONS 203=head1 FUNCTIONS
204
205=head2 QUICK OVERVIEW
206
207This section simply lists the prototypes of the most important functions
208for quick reference. See the following sections for function-by-function
209documentation.
210
211 aio_wd $pathname, $callback->($wd)
212 aio_open $pathname, $flags, $mode, $callback->($fh)
213 aio_close $fh, $callback->($status)
214 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
215 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
216 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
217 aio_readahead $fh,$offset,$length, $callback->($retval)
218 aio_stat $fh_or_path, $callback->($status)
219 aio_lstat $fh, $callback->($status)
220 aio_statvfs $fh_or_path, $callback->($statvfs)
221 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
222 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
223 aio_truncate $fh_or_path, $offset, $callback->($status)
224 aio_chmod $fh_or_path, $mode, $callback->($status)
225 aio_unlink $pathname, $callback->($status)
226 aio_mknod $pathname, $mode, $dev, $callback->($status)
227 aio_link $srcpath, $dstpath, $callback->($status)
228 aio_symlink $srcpath, $dstpath, $callback->($status)
229 aio_readlink $pathname, $callback->($link)
230 aio_realpath $pathname, $callback->($link)
231 aio_rename $srcpath, $dstpath, $callback->($status)
232 aio_mkdir $pathname, $mode, $callback->($status)
233 aio_rmdir $pathname, $callback->($status)
234 aio_readdir $pathname, $callback->($entries)
235 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
236 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
237 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
238 aio_load $pathname, $data, $callback->($status)
239 aio_copy $srcpath, $dstpath, $callback->($status)
240 aio_move $srcpath, $dstpath, $callback->($status)
241 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
242 aio_rmtree $pathname, $callback->($status)
243 aio_sync $callback->($status)
244 aio_syncfs $fh, $callback->($status)
245 aio_fsync $fh, $callback->($status)
246 aio_fdatasync $fh, $callback->($status)
247 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
248 aio_pathsync $pathname, $callback->($status)
249 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
250 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
251 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
252 aio_mlockall $flags, $callback->($status)
253 aio_group $callback->(...)
254 aio_nop $callback->()
255
256 $prev_pri = aioreq_pri [$pri]
257 aioreq_nice $pri_adjust
258
259 IO::AIO::poll_wait
260 IO::AIO::poll_cb
261 IO::AIO::poll
262 IO::AIO::flush
263 IO::AIO::max_poll_reqs $nreqs
264 IO::AIO::max_poll_time $seconds
265 IO::AIO::min_parallel $nthreads
266 IO::AIO::max_parallel $nthreads
267 IO::AIO::max_idle $nthreads
268 IO::AIO::idle_timeout $seconds
269 IO::AIO::max_outstanding $maxreqs
270 IO::AIO::nreqs
271 IO::AIO::nready
272 IO::AIO::npending
273
274 IO::AIO::sendfile $ofh, $ifh, $offset, $count
275 IO::AIO::fadvise $fh, $offset, $len, $advice
276 IO::AIO::madvise $scalar, $offset, $length, $advice
277 IO::AIO::mprotect $scalar, $offset, $length, $protect
278 IO::AIO::munlock $scalar, $offset = 0, $length = undef
279 IO::AIO::munlockall
222 280
223=head2 AIO REQUEST FUNCTIONS 281=head2 AIO REQUEST FUNCTIONS
224 282
225All the C<aio_*> calls are more or less thin wrappers around the syscall 283All the C<aio_*> calls are more or less thin wrappers around the syscall
226with the same name (sans C<aio_>). The arguments are similar or identical, 284with the same name (sans C<aio_>). The arguments are similar or identical,
… …
234internally until the request has finished. 292internally until the request has finished.
235 293
236All functions return request objects of type L<IO::AIO::REQ> that allow 294All functions return request objects of type L<IO::AIO::REQ> that allow
237further manipulation of those requests while they are in-flight. 295further manipulation of those requests while they are in-flight.
238 296
239The pathnames you pass to these routines I<must> be absolute and 297The pathnames you pass to these routines I<should> be absolute. The
240encoded as octets. The reason for the former is that at the time the 298reason for this is that at the time the request is being executed, the
241request is being executed, the current working directory could have 299current working directory could have changed. Alternatively, you can make
242changed. Alternatively, you can make sure that you never change the 300sure that you never change the current working directory anywhere in
243current working directory anywhere in the program and then use relative 301the program and then use relative paths. Lastly, you can take advantage
244paths. 302of IO::AIOs working directory abstraction - see the description of the
303C<IO::AIO::WD> class later in this document.
245 304
246To encode pathnames as octets, either make sure you either: a) always pass 305To encode pathnames as octets, either make sure you either: a) always pass
247in filenames you got from outside (command line, readdir etc.) without 306in filenames you got from outside (command line, readdir etc.) without
248tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode 307tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode
249your pathnames to the locale (or other) encoding in effect in the user 308your pathnames to the locale (or other) encoding in effect in the user
… …
306by the umask in effect then the request is being executed, so better never 365by the umask in effect then the request is being executed, so better never
307change the umask. 366change the umask.
308 367
309Example: 368Example:
310 369
311 aio_open "/etc/passwd", O_RDONLY, 0, sub { 370 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
312 if ($_[0]) { 371 if ($_[0]) {
313 print "open successful, fh is $_[0]\n"; 372 print "open successful, fh is $_[0]\n";
314 ... 373 ...
315 } else { 374 } else {
316 die "open failed: $!\n"; 375 die "open failed: $!\n";
317 } 376 }
318 }; 377 };
319 378
379In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>,
380C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the
381following POSIX and non-POSIX constants are available (missing ones on
382your system are, as usual, C<0>):
383
384C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
385C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
386C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>.
387
320 388
321=item aio_close $fh, $callback->($status) 389=item aio_close $fh, $callback->($status)
322 390
323Asynchronously close a file and call the callback with the result 391Asynchronously close a file and call the callback with the result
324code. 392code.
… …
374 442
375Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 443Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
376reading at byte offset C<$in_offset>, and starts writing at the current 444reading at byte offset C<$in_offset>, and starts writing at the current
377file offset of C<$out_fh>. Because of that, it is not safe to issue more 445file offset of C<$out_fh>. Because of that, it is not safe to issue more
378than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each 446than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
379other. 447other. The same C<$in_fh> works fine though, as this function does not
448move or use the file offset of C<$in_fh>.
380 449
450Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than
451are written, and there is no way to find out how many more bytes have been
452read from C<aio_sendfile> alone, as C<aio_sendfile> only provides the
453number of bytes written to C<$out_fh>. Only if the result value equals
454C<$length> one can assume that C<$length> bytes have been read.
455
456Unlike with other C<aio_> functions, it makes a lot of sense to use
457C<aio_sendfile> on non-blocking sockets, as long as one end (typically
458the C<$in_fh>) is a file - the file I/O will then be asynchronous, while
459the socket I/O will be non-blocking. Note, however, that you can run
460into a trap where C<aio_sendfile> reads some data with readahead, then
461fails to write all data, and when the socket is ready the next time, the
462data in the cache is already lost, forcing C<aio_sendfile> to again hit
463the disk. Explicit C<aio_read> + C<aio_write> let's you better control
464resource usage.
465
381This call tries to make use of a native C<sendfile> syscall to provide 466This call tries to make use of a native C<sendfile>-like syscall to
382zero-copy operation. For this to work, C<$out_fh> should refer to a 467provide zero-copy operation. For this to work, C<$out_fh> should refer to
383socket, and C<$in_fh> should refer to mmap'able file. 468a socket, and C<$in_fh> should refer to an mmap'able file.
384 469
385If the native sendfile call fails or is not implemented, it will be 470If a native sendfile cannot be found or it fails with C<ENOSYS>,
386emulated, so you can call C<aio_sendfile> on any type of filehandle 471C<EINVAL>, C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or
472C<ENOTSOCK>, it will be emulated, so you can call C<aio_sendfile> on any
387regardless of the limitations of the operating system. 473type of filehandle regardless of the limitations of the operating system.
388 474
389Please note, however, that C<aio_sendfile> can read more bytes from 475As native sendfile syscalls (as practically any non-POSIX interface hacked
390C<$in_fh> than are written, and there is no way to find out how many 476together in a hurry to improve benchmark numbers) tend to be rather buggy
391bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 477on many systems, this implementation tries to work around some known bugs
392provides the number of bytes written to C<$out_fh>. Only if the result 478in Linux and FreeBSD kernels (probably others, too), but that might fail,
393value equals C<$length> one can assume that C<$length> bytes have been 479so you really really should check the return value of C<aio_sendfile> -
394read. 480fewre bytes than expected might have been transferred.
395 481
396 482
397=item aio_readahead $fh,$offset,$length, $callback->($retval) 483=item aio_readahead $fh,$offset,$length, $callback->($retval)
398 484
399C<aio_readahead> populates the page cache with data from a file so that 485C<aio_readahead> populates the page cache with data from a file so that
… …
422 508
423Currently, the stats are always 64-bit-stats, i.e. instead of returning an 509Currently, the stats are always 64-bit-stats, i.e. instead of returning an
424error when stat'ing a large file, the results will be silently truncated 510error when stat'ing a large file, the results will be silently truncated
425unless perl itself is compiled with large file support. 511unless perl itself is compiled with large file support.
426 512
513To help interpret the mode and dev/rdev stat values, IO::AIO offers the
514following constants and functions (if not implemented, the constants will
515be C<0> and the functions will either C<croak> or fall back on traditional
516behaviour).
517
518C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
519C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
520C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
521
427Example: Print the length of F</etc/passwd>: 522Example: Print the length of F</etc/passwd>:
428 523
429 aio_stat "/etc/passwd", sub { 524 aio_stat "/etc/passwd", sub {
430 $_[0] and die "stat failed: $!"; 525 $_[0] and die "stat failed: $!";
431 print "size is ", -s _, "\n"; 526 print "size is ", -s _, "\n";
432 }; 527 };
433 528
434 529
530=item aio_statvfs $fh_or_path, $callback->($statvfs)
531
532Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
533whether a file handle or path was passed.
534
535On success, the callback is passed a hash reference with the following
536members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
537C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
538is passed.
539
540The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
541C<ST_NOSUID>.
542
543The following non-POSIX IO::AIO::ST_* flag masks are defined to
544their correct value when available, or to C<0> on systems that do
545not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
546C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
547C<ST_NODIRATIME> and C<ST_RELATIME>.
548
549Example: stat C</wd> and dump out the data if successful.
550
551 aio_statvfs "/wd", sub {
552 my $f = $_[0]
553 or die "statvfs: $!";
554
555 use Data::Dumper;
556 say Dumper $f;
557 };
558
559 # result:
560 {
561 bsize => 1024,
562 bfree => 4333064312,
563 blocks => 10253828096,
564 files => 2050765568,
565 flag => 4096,
566 favail => 2042092649,
567 bavail => 4333064312,
568 ffree => 2042092649,
569 namemax => 255,
570 frsize => 1024,
571 fsid => 1810
572 }
573
574
435=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 575=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
436 576
437Works like perl's C<utime> function (including the special case of $atime 577Works like perl's C<utime> function (including the special case of $atime
438and $mtime being undef). Fractional times are supported if the underlying 578and $mtime being undef). Fractional times are supported if the underlying
439syscalls support them. 579syscalls support them.
… …
477 617
478Asynchronously unlink (delete) a file and call the callback with the 618Asynchronously unlink (delete) a file and call the callback with the
479result code. 619result code.
480 620
481 621
482=item aio_mknod $path, $mode, $dev, $callback->($status) 622=item aio_mknod $pathname, $mode, $dev, $callback->($status)
483 623
484[EXPERIMENTAL] 624[EXPERIMENTAL]
485 625
486Asynchronously create a device node (or fifo). See mknod(2). 626Asynchronously create a device node (or fifo). See mknod(2).
487 627
488The only (POSIX-) portable way of calling this function is: 628The only (POSIX-) portable way of calling this function is:
489 629
490 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 630 aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
491 631
632See C<aio_stat> for info about some potentially helpful extra constants
633and functions.
492 634
493=item aio_link $srcpath, $dstpath, $callback->($status) 635=item aio_link $srcpath, $dstpath, $callback->($status)
494 636
495Asynchronously create a new link to the existing object at C<$srcpath> at 637Asynchronously create a new link to the existing object at C<$srcpath> at
496the path C<$dstpath> and call the callback with the result code. 638the path C<$dstpath> and call the callback with the result code.
… …
500 642
501Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 643Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
502the path C<$dstpath> and call the callback with the result code. 644the path C<$dstpath> and call the callback with the result code.
503 645
504 646
505=item aio_readlink $path, $callback->($link) 647=item aio_readlink $pathname, $callback->($link)
506 648
507Asynchronously read the symlink specified by C<$path> and pass it to 649Asynchronously read the symlink specified by C<$path> and pass it to
508the callback. If an error occurs, nothing or undef gets passed to the 650the callback. If an error occurs, nothing or undef gets passed to the
509callback. 651callback.
510 652
511 653
654=item aio_realpath $pathname, $callback->($path)
655
656Asynchronously make the path absolute and resolve any symlinks in
657C<$path>. The resulting path only consists of directories (Same as
658L<Cwd::realpath>).
659
660This request can be used to get the absolute path of the current working
661directory by passing it a path of F<.> (a single dot).
662
663
512=item aio_rename $srcpath, $dstpath, $callback->($status) 664=item aio_rename $srcpath, $dstpath, $callback->($status)
513 665
514Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 666Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
515rename(2) and call the callback with the result code. 667rename(2) and call the callback with the result code.
516 668
… …
538array-ref with the filenames. 690array-ref with the filenames.
539 691
540 692
541=item aio_readdirx $pathname, $flags, $callback->($entries, $flags) 693=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
542 694
543Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune 695Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to
544behaviour and output format. In case of an error, C<$entries> will be 696tune behaviour and output format. In case of an error, C<$entries> will be
545C<undef>. 697C<undef>.
546 698
547The flags are a combination of the following constants, ORed together (the 699The flags are a combination of the following constants, ORed together (the
548flags will also be passed to the callback, possibly modified): 700flags will also be passed to the callback, possibly modified):
549 701
550=over 4 702=over 4
551 703
552=item IO::AIO::READDIR_DENTS 704=item IO::AIO::READDIR_DENTS
553 705
554When this flag is off, then the callback gets an arrayref with of names 706When this flag is off, then the callback gets an arrayref consisting of
555only (as with C<aio_readdir>), otherwise it gets an arrayref with 707names only (as with C<aio_readdir>), otherwise it gets an arrayref with
556C<[$name, $type, $inode]> arrayrefs, each describing a single directory 708C<[$name, $type, $inode]> arrayrefs, each describing a single directory
557entry in more detail. 709entry in more detail.
558 710
559C<$name> is the name of the entry. 711C<$name> is the name of the entry.
560 712
… …
573systems that do not deliver the inode information. 725systems that do not deliver the inode information.
574 726
575=item IO::AIO::READDIR_DIRS_FIRST 727=item IO::AIO::READDIR_DIRS_FIRST
576 728
577When this flag is set, then the names will be returned in an order where 729When this flag is set, then the names will be returned in an order where
578likely directories come first. This is useful when you need to quickly 730likely directories come first, in optimal stat order. This is useful when
579find directories, or you want to find all directories while avoiding to 731you need to quickly find directories, or you want to find all directories
580stat() each entry. 732while avoiding to stat() each entry.
581 733
582If the system returns type information in readdir, then this is used 734If the system returns type information in readdir, then this is used
583to find directories directly. Otherwise, likely directories are files 735to find directories directly. Otherwise, likely directories are names
584beginning with ".", or otherwise files with no dots, of which files with 736beginning with ".", or otherwise names with no dots, of which names with
585short names are tried first. 737short names are tried first.
586 738
587=item IO::AIO::READDIR_STAT_ORDER 739=item IO::AIO::READDIR_STAT_ORDER
588 740
589When this flag is set, then the names will be returned in an order 741When this flag is set, then the names will be returned in an order
… …
596 748
597=item IO::AIO::READDIR_FOUND_UNKNOWN 749=item IO::AIO::READDIR_FOUND_UNKNOWN
598 750
599This flag should not be set when calling C<aio_readdirx>. Instead, it 751This flag should not be set when calling C<aio_readdirx>. Instead, it
600is being set by C<aio_readdirx>, when any of the C<$type>'s found were 752is being set by C<aio_readdirx>, when any of the C<$type>'s found were
601C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all 753C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all
602C<$type>'s are known, which can be used to speed up some algorithms. 754C<$type>'s are known, which can be used to speed up some algorithms.
603 755
604=back 756=back
605 757
606 758
607=item aio_load $path, $data, $callback->($status) 759=item aio_load $pathname, $data, $callback->($status)
608 760
609This is a composite request that tries to fully load the given file into 761This is a composite request that tries to fully load the given file into
610memory. Status is the same as with aio_read. 762memory. Status is the same as with aio_read.
611 763
612=cut 764=cut
… …
634 786
635=item aio_copy $srcpath, $dstpath, $callback->($status) 787=item aio_copy $srcpath, $dstpath, $callback->($status)
636 788
637Try to copy the I<file> (directories not supported as either source or 789Try to copy the I<file> (directories not supported as either source or
638destination) from C<$srcpath> to C<$dstpath> and call the callback with 790destination) from C<$srcpath> to C<$dstpath> and call the callback with
639the C<0> (error) or C<-1> ok. 791a status of C<0> (ok) or C<-1> (error, see C<$!>).
640 792
641This is a composite request that creates the destination file with 793This is a composite request that creates the destination file with
642mode 0200 and copies the contents of the source file into it using 794mode 0200 and copies the contents of the source file into it using
643C<aio_sendfile>, followed by restoring atime, mtime, access mode and 795C<aio_sendfile>, followed by restoring atime, mtime, access mode and
644uid/gid, in that order. 796uid/gid, in that order.
… …
656 my $grp = aio_group $cb; 808 my $grp = aio_group $cb;
657 809
658 aioreq_pri $pri; 810 aioreq_pri $pri;
659 add $grp aio_open $src, O_RDONLY, 0, sub { 811 add $grp aio_open $src, O_RDONLY, 0, sub {
660 if (my $src_fh = $_[0]) { 812 if (my $src_fh = $_[0]) {
661 my @stat = stat $src_fh; # hmm, might bock over nfs? 813 my @stat = stat $src_fh; # hmm, might block over nfs?
662 814
663 aioreq_pri $pri; 815 aioreq_pri $pri;
664 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 816 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
665 if (my $dst_fh = $_[0]) { 817 if (my $dst_fh = $_[0]) {
666 aioreq_pri $pri; 818 aioreq_pri $pri;
… …
713 865
714=item aio_move $srcpath, $dstpath, $callback->($status) 866=item aio_move $srcpath, $dstpath, $callback->($status)
715 867
716Try to move the I<file> (directories not supported as either source or 868Try to move the I<file> (directories not supported as either source or
717destination) from C<$srcpath> to C<$dstpath> and call the callback with 869destination) from C<$srcpath> to C<$dstpath> and call the callback with
718the C<0> (error) or C<-1> ok. 870a status of C<0> (ok) or C<-1> (error, see C<$!>).
719 871
720This is a composite request that tries to rename(2) the file first; if 872This is a composite request that tries to rename(2) the file first; if
721rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if 873rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
722that is successful, unlinks the C<$srcpath>. 874that is successful, unlinks the C<$srcpath>.
723 875
… …
734 if ($_[0] && $! == EXDEV) { 886 if ($_[0] && $! == EXDEV) {
735 aioreq_pri $pri; 887 aioreq_pri $pri;
736 add $grp aio_copy $src, $dst, sub { 888 add $grp aio_copy $src, $dst, sub {
737 $grp->result ($_[0]); 889 $grp->result ($_[0]);
738 890
739 if (!$_[0]) { 891 unless ($_[0]) {
740 aioreq_pri $pri; 892 aioreq_pri $pri;
741 add $grp aio_unlink $src; 893 add $grp aio_unlink $src;
742 } 894 }
743 }; 895 };
744 } else { 896 } else {
… …
747 }; 899 };
748 900
749 $grp 901 $grp
750} 902}
751 903
752=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 904=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
753 905
754Scans a directory (similar to C<aio_readdir>) but additionally tries to 906Scans a directory (similar to C<aio_readdir>) but additionally tries to
755efficiently separate the entries of directory C<$path> into two sets of 907efficiently separate the entries of directory C<$path> into two sets of
756names, directories you can recurse into (directories), and ones you cannot 908names, directories you can recurse into (directories), and ones you cannot
757recurse into (everything else, including symlinks to directories). 909recurse into (everything else, including symlinks to directories).
… …
788Then entries will be sorted into likely directories a non-initial dot 940Then entries will be sorted into likely directories a non-initial dot
789currently) and likely non-directories (see C<aio_readdirx>). Then every 941currently) and likely non-directories (see C<aio_readdirx>). Then every
790entry plus an appended C</.> will be C<stat>'ed, likely directories first, 942entry plus an appended C</.> will be C<stat>'ed, likely directories first,
791in order of their inode numbers. If that succeeds, it assumes that the 943in order of their inode numbers. If that succeeds, it assumes that the
792entry is a directory or a symlink to directory (which will be checked 944entry is a directory or a symlink to directory (which will be checked
793seperately). This is often faster than stat'ing the entry itself because 945separately). This is often faster than stat'ing the entry itself because
794filesystems might detect the type of the entry without reading the inode 946filesystems might detect the type of the entry without reading the inode
795data (e.g. ext2fs filetype feature), even on systems that cannot return 947data (e.g. ext2fs filetype feature), even on systems that cannot return
796the filetype information on readdir. 948the filetype information on readdir.
797 949
798If the known number of directories (link count - 2) has been reached, the 950If the known number of directories (link count - 2) has been reached, the
… …
814 966
815 my $grp = aio_group $cb; 967 my $grp = aio_group $cb;
816 968
817 $maxreq = 4 if $maxreq <= 0; 969 $maxreq = 4 if $maxreq <= 0;
818 970
819 # stat once 971 # get a wd object
972
820 aioreq_pri $pri; 973 aioreq_pri $pri;
821 add $grp aio_stat $path, sub { 974 add $grp aio_wd $path, sub {
822 return $grp->result () if $_[0]; 975 my $wd = [shift, "."];
823 my $now = time;
824 my $hash1 = join ":", (stat _)[0,1,3,7,9];
825 976
826 # read the directory entries 977 # stat once
827 aioreq_pri $pri; 978 aioreq_pri $pri;
828 add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { 979 add $grp aio_stat $wd, sub {
829 my $entries = shift
830 or return $grp->result (); 980 return $grp->result () if $_[0];
981 my $now = time;
982 my $hash1 = join ":", (stat _)[0,1,3,7,9];
831 983
832 # stat the dir another time 984 # read the directory entries
833 aioreq_pri $pri; 985 aioreq_pri $pri;
986 add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
987 my $entries = shift
988 or return $grp->result ();
989
990 # stat the dir another time
991 aioreq_pri $pri;
834 add $grp aio_stat $path, sub { 992 add $grp aio_stat $wd, sub {
835 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 993 my $hash2 = join ":", (stat _)[0,1,3,7,9];
836 994
837 my $ndirs; 995 my $ndirs;
838 996
839 # take the slow route if anything looks fishy 997 # take the slow route if anything looks fishy
840 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 998 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
841 $ndirs = -1; 999 $ndirs = -1;
842 } else { 1000 } else {
843 # if nlink == 2, we are finished 1001 # if nlink == 2, we are finished
844 # for non-posix-fs's, we rely on nlink < 2 1002 # for non-posix-fs's, we rely on nlink < 2
845 $ndirs = (stat _)[3] - 2 1003 $ndirs = (stat _)[3] - 2
846 or return $grp->result ([], $entries); 1004 or return $grp->result ([], $entries);
847 } 1005 }
848 1006
849 my (@dirs, @nondirs); 1007 my (@dirs, @nondirs);
850 1008
851 my $statgrp = add $grp aio_group sub { 1009 my $statgrp = add $grp aio_group sub {
852 $grp->result (\@dirs, \@nondirs); 1010 $grp->result (\@dirs, \@nondirs);
853 }; 1011 };
854 1012
855 limit $statgrp $maxreq; 1013 limit $statgrp $maxreq;
856 feed $statgrp sub { 1014 feed $statgrp sub {
857 return unless @$entries; 1015 return unless @$entries;
858 my $entry = shift @$entries; 1016 my $entry = shift @$entries;
859 1017
860 aioreq_pri $pri; 1018 aioreq_pri $pri;
1019 $wd->[1] = "$entry/.";
861 add $statgrp aio_stat "$path/$entry/.", sub { 1020 add $statgrp aio_stat $wd, sub {
862 if ($_[0] < 0) { 1021 if ($_[0] < 0) {
863 push @nondirs, $entry; 1022 push @nondirs, $entry;
864 } else { 1023 } else {
865 # need to check for real directory 1024 # need to check for real directory
866 aioreq_pri $pri; 1025 aioreq_pri $pri;
1026 $wd->[1] = $entry;
867 add $statgrp aio_lstat "$path/$entry", sub { 1027 add $statgrp aio_lstat $wd, sub {
868 if (-d _) { 1028 if (-d _) {
869 push @dirs, $entry; 1029 push @dirs, $entry;
870 1030
871 unless (--$ndirs) { 1031 unless (--$ndirs) {
872 push @nondirs, @$entries; 1032 push @nondirs, @$entries;
873 feed $statgrp; 1033 feed $statgrp;
1034 }
1035 } else {
1036 push @nondirs, $entry;
874 } 1037 }
875 } else {
876 push @nondirs, $entry;
877 } 1038 }
878 } 1039 }
879 } 1040 };
880 }; 1041 };
881 }; 1042 };
882 }; 1043 };
883 }; 1044 };
884 }; 1045 };
885 1046
886 $grp 1047 $grp
887} 1048}
888 1049
889=item aio_rmtree $path, $callback->($status) 1050=item aio_rmtree $pathname, $callback->($status)
890 1051
891Delete a directory tree starting (and including) C<$path>, return the 1052Delete a directory tree starting (and including) C<$path>, return the
892status of the final C<rmdir> only. This is a composite request that 1053status of the final C<rmdir> only. This is a composite request that
893uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1054uses C<aio_scandir> to recurse into and rmdir directories, and unlink
894everything else. 1055everything else.
… …
936callback with the fdatasync result code. 1097callback with the fdatasync result code.
937 1098
938If this call isn't available because your OS lacks it or it couldn't be 1099If this call isn't available because your OS lacks it or it couldn't be
939detected, it will be emulated by calling C<fsync> instead. 1100detected, it will be emulated by calling C<fsync> instead.
940 1101
1102=item aio_syncfs $fh, $callback->($status)
1103
1104Asynchronously call the syncfs syscall to sync the filesystem associated
1105to the given filehandle and call the callback with the syncfs result
1106code. If syncfs is not available, calls sync(), but returns C<-1> and sets
1107errno to C<ENOSYS> nevertheless.
1108
941=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 1109=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
942 1110
943Sync the data portion of the file specified by C<$offset> and C<$length> 1111Sync the data portion of the file specified by C<$offset> and C<$length>
944to disk (but NOT the metadata), by calling the Linux-specific 1112to disk (but NOT the metadata), by calling the Linux-specific
945sync_file_range call. If sync_file_range is not available or it returns 1113sync_file_range call. If sync_file_range is not available or it returns
… …
948C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, 1116C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
949C<IO::AIO::SYNC_FILE_RANGE_WRITE> and 1117C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
950C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range 1118C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
951manpage for details. 1119manpage for details.
952 1120
953=item aio_pathsync $path, $callback->($status) 1121=item aio_pathsync $pathname, $callback->($status)
954 1122
955This request tries to open, fsync and close the given path. This is a 1123This request tries to open, fsync and close the given path. This is a
956composite request intended to sync directories after directory operations 1124composite request intended to sync directories after directory operations
957(E.g. rename). This might not work on all operating systems or have any 1125(E.g. rename). This might not work on all operating systems or have any
958specific effect, but usually it makes sure that directory changes get 1126specific effect, but usually it makes sure that directory changes get
959written to disc. It works for anything that can be opened for read-only, 1127written to disc. It works for anything that can be opened for read-only,
960not just directories. 1128not just directories.
1129
1130Future versions of this function might fall back to other methods when
1131C<fsync> on the directory fails (such as calling C<sync>).
961 1132
962Passes C<0> when everything went ok, and C<-1> on error. 1133Passes C<0> when everything went ok, and C<-1> on error.
963 1134
964=cut 1135=cut
965 1136
… …
986 }; 1157 };
987 1158
988 $grp 1159 $grp
989} 1160}
990 1161
1162=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1163
1164This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1165scalars (see the C<IO::AIO::mmap> function, although it also works on data
1166scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1167scalar must only be modified in-place while an aio operation is pending on
1168it).
1169
1170It calls the C<msync> function of your OS, if available, with the memory
1171area starting at C<$offset> in the string and ending C<$length> bytes
1172later. If C<$length> is negative, counts from the end, and if C<$length>
1173is C<undef>, then it goes till the end of the string. The flags can be
1174a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
1175C<IO::AIO::MS_SYNC>.
1176
1177=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1178
1179This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1180scalars.
1181
1182It touches (reads or writes) all memory pages in the specified
1183range inside the scalar. All caveats and parameters are the same
1184as for C<aio_msync>, above, except for flags, which must be either
1185C<0> (which reads all pages and ensures they are instantiated) or
1186C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
1187writing an octet from it, which dirties the page).
1188
1189=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1190
1191This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1192scalars.
1193
1194It reads in all the pages of the underlying storage into memory (if any)
1195and locks them, so they are not getting swapped/paged out or removed.
1196
1197If C<$length> is undefined, then the scalar will be locked till the end.
1198
1199On systems that do not implement C<mlock>, this function returns C<-1>
1200and sets errno to C<ENOSYS>.
1201
1202Note that the corresponding C<munlock> is synchronous and is
1203documented under L<MISCELLANEOUS FUNCTIONS>.
1204
1205Example: open a file, mmap and mlock it - both will be undone when
1206C<$data> gets destroyed.
1207
1208 open my $fh, "<", $path or die "$path: $!";
1209 my $data;
1210 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1211 aio_mlock $data; # mlock in background
1212
1213=item aio_mlockall $flags, $callback->($status)
1214
1215Calls the C<mlockall> function with the given C<$flags> (a combination of
1216C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
1217
1218On systems that do not implement C<mlockall>, this function returns C<-1>
1219and sets errno to C<ENOSYS>.
1220
1221Note that the corresponding C<munlockall> is synchronous and is
1222documented under L<MISCELLANEOUS FUNCTIONS>.
1223
1224Example: asynchronously lock all current and future pages into memory.
1225
1226 aio_mlockall IO::AIO::MCL_FUTURE;
1227
991=item aio_group $callback->(...) 1228=item aio_group $callback->(...)
992 1229
993This is a very special aio request: Instead of doing something, it is a 1230This is a very special aio request: Instead of doing something, it is a
994container for other aio requests, which is useful if you want to bundle 1231container for other aio requests, which is useful if you want to bundle
995many requests into a single, composite, request with a definite callback 1232many requests into a single, composite, request with a definite callback
… …
1031like sleep and file handle readable/writable, the overhead this creates is 1268like sleep and file handle readable/writable, the overhead this creates is
1032immense (it blocks a thread for a long time) so do not use this function 1269immense (it blocks a thread for a long time) so do not use this function
1033except to put your application under artificial I/O pressure. 1270except to put your application under artificial I/O pressure.
1034 1271
1035=back 1272=back
1273
1274
1275=head2 IO::AIO::WD - multiple working directories
1276
1277Your process only has one current working directory, which is used by all
1278threads. This makes it hard to use relative paths (some other component
1279could call C<chdir> at any time, and it is hard to control when the path
1280will be used by IO::AIO).
1281
1282One solution for this is to always use absolute paths. This usually works,
1283but can be quite slow (the kernel has to walk the whole path on every
1284access), and can also be a hassle to implement.
1285
1286Newer POSIX systems have a number of functions (openat, fdopendir,
1287futimensat and so on) that make it possible to specify working directories
1288per operation.
1289
1290For portability, and because the clowns who "designed", or shall I write,
1291perpetrated this new interface were obviously half-drunk, this abstraction
1292cannot be perfect, though.
1293
1294IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
1295object. This object stores the canonicalised, absolute version of the
1296path, and on systems that allow it, also a directory file descriptor.
1297
1298Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
1299or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
1300object and a pathname instead. If the pathname is absolute, the
1301IO::AIO::WD objetc is ignored, otherwise the pathname is resolved relative
1302to that IO::AIO::WD object.
1303
1304For example, to get a wd object for F</etc> and then stat F<passwd>
1305inside, you would write:
1306
1307 aio_wd "/etc", sub {
1308 my $etcdir = shift;
1309
1310 # although $etcdir can be undef on error, there is generally no reason
1311 # to check for errors here, as aio_stat will fail with ENOENT
1312 # when $etcdir is undef.
1313
1314 aio_stat [$etcdir, "passwd"], sub {
1315 # yay
1316 };
1317 };
1318
1319This shows that creating an IO::AIO::WD object is itself a potentially
1320blocking operation, which is why it is done asynchronously.
1321
1322As with normal pathnames, IO::AIO keeps a copy of the working directory
1323object and the pathname string, so you could write the following without
1324causing any issues due to C<$path> getting reused:
1325
1326 my $path = [$wd, undef];
1327
1328 for my $name (qw(abc def ghi)) {
1329 $path->[1] = $name;
1330 aio_stat $path, sub {
1331 # ...
1332 };
1333 }
1334
1335There are some caveats: when directories get renamed (or deleted), the
1336pathname string doesn't change, so will point to the new directory (or
1337nowhere at all), while the directory fd, if available on the system,
1338will still point to the original directory. Most functions accepting a
1339pathname will use the directory fd on newer systems, and the string on
1340older systems. Some functions (such as realpath) will always rely on the
1341string form of the pathname.
1342
1343So this fucntionality is mainly useful to get some protection against
1344C<chdir>, to easily get an absolute path out of a relative path for future
1345reference, and to speed up doing many operations in the same directory
1346(e.g. when stat'ing all files in a directory).
1347
1348The following functions implement this working directory abstraction:
1349
1350=over 4
1351
1352=item aio_wd $pathname, $callback->($wd)
1353
1354Asynchonously canonicalise the given pathname and convert it to an
1355IO::AIO::WD object representing it. If possible and supported on the
1356system, also open a directory fd to speed up pathname resolution relative
1357to this working directory.
1358
1359If something goes wrong, then C<undef> is passwd to the callback instead
1360of a working directory object and C<$!> is set appropriately. Since
1361passing C<undef> as working directory component of a pathname fails the
1362request with C<ENOENT>, there is often no need for error checking in the
1363C<aio_wd> callback, as future requests using the value will fail in the
1364expected way.
1365
1366If this call isn't available because your OS lacks it or it couldn't be
1367detected, it will be emulated by calling C<fsync> instead.
1368
1369=item IO::AIO::CWD
1370
1371This is a compiletime constant (object) that represents the process
1372current working directory.
1373
1374Specifying this object as working directory object for a pathname is as
1375if the pathname would be specified directly, without a directory object,
1376e.g., these calls are functionally identical:
1377
1378 aio_stat "somefile", sub { ... };
1379 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1380
1381=back
1382
1036 1383
1037=head2 IO::AIO::REQ CLASS 1384=head2 IO::AIO::REQ CLASS
1038 1385
1039All non-aggregate C<aio_*> functions return an object of this class when 1386All non-aggregate C<aio_*> functions return an object of this class when
1040called in non-void context. 1387called in non-void context.
… …
1130=item $grp->cancel_subs 1477=item $grp->cancel_subs
1131 1478
1132Cancel all subrequests and clears any feeder, but not the group request 1479Cancel all subrequests and clears any feeder, but not the group request
1133itself. Useful when you queued a lot of events but got a result early. 1480itself. Useful when you queued a lot of events but got a result early.
1134 1481
1482The group request will finish normally (you cannot add requests to the
1483group).
1484
1135=item $grp->result (...) 1485=item $grp->result (...)
1136 1486
1137Set the result value(s) that will be passed to the group callback when all 1487Set the result value(s) that will be passed to the group callback when all
1138subrequests have finished and set the groups errno to the current value 1488subrequests have finished and set the groups errno to the current value
1139of errno (just like calling C<errno> without an error number). By default, 1489of errno (just like calling C<errno> without an error number). By default,
… …
1215 1565
1216See C<poll_cb> for an example. 1566See C<poll_cb> for an example.
1217 1567
1218=item IO::AIO::poll_cb 1568=item IO::AIO::poll_cb
1219 1569
1220Process some outstanding events on the result pipe. You have to call this 1570Process some outstanding events on the result pipe. You have to call
1221regularly. Returns C<0> if all events could be processed, or C<-1> if it 1571this regularly. Returns C<0> if all events could be processed (or there
1222returned earlier for whatever reason. Returns immediately when no events 1572were no events to process), or C<-1> if it returned earlier for whatever
1223are outstanding. The amount of events processed depends on the settings of 1573reason. Returns immediately when no events are outstanding. The amount of
1224C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. 1574events processed depends on the settings of C<IO::AIO::max_poll_req> and
1575C<IO::AIO::max_poll_time>.
1225 1576
1226If not all requests were processed for whatever reason, the filehandle 1577If not all requests were processed for whatever reason, the filehandle
1227will still be ready when C<poll_cb> returns, so normally you don't have to 1578will still be ready when C<poll_cb> returns, so normally you don't have to
1228do anything special to have it called later. 1579do anything special to have it called later.
1229 1580
1581Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1582ready, it can be beneficial to call this function from loops which submit
1583a lot of requests, to make sure the results get processed when they become
1584available and not just when the loop is finished and the event loop takes
1585over again. This function returns very fast when there are no outstanding
1586requests.
1587
1230Example: Install an Event watcher that automatically calls 1588Example: Install an Event watcher that automatically calls
1231IO::AIO::poll_cb with high priority (more examples can be found in the 1589IO::AIO::poll_cb with high priority (more examples can be found in the
1232SYNOPSIS section, at the top of this document): 1590SYNOPSIS section, at the top of this document):
1233 1591
1234 Event->io (fd => IO::AIO::poll_fileno, 1592 Event->io (fd => IO::AIO::poll_fileno,
1235 poll => 'r', async => 1, 1593 poll => 'r', async => 1,
1236 cb => \&IO::AIO::poll_cb); 1594 cb => \&IO::AIO::poll_cb);
1595
1596=item IO::AIO::poll_wait
1597
1598If there are any outstanding requests and none of them in the result
1599phase, wait till the result filehandle becomes ready for reading (simply
1600does a C<select> on the filehandle. This is useful if you want to
1601synchronously wait for some requests to finish).
1602
1603See C<nreqs> for an example.
1604
1605=item IO::AIO::poll
1606
1607Waits until some requests have been handled.
1608
1609Returns the number of requests processed, but is otherwise strictly
1610equivalent to:
1611
1612 IO::AIO::poll_wait, IO::AIO::poll_cb
1613
1614=item IO::AIO::flush
1615
1616Wait till all outstanding AIO requests have been handled.
1617
1618Strictly equivalent to:
1619
1620 IO::AIO::poll_wait, IO::AIO::poll_cb
1621 while IO::AIO::nreqs;
1237 1622
1238=item IO::AIO::max_poll_reqs $nreqs 1623=item IO::AIO::max_poll_reqs $nreqs
1239 1624
1240=item IO::AIO::max_poll_time $seconds 1625=item IO::AIO::max_poll_time $seconds
1241 1626
… …
1266 # use a low priority so other tasks have priority 1651 # use a low priority so other tasks have priority
1267 Event->io (fd => IO::AIO::poll_fileno, 1652 Event->io (fd => IO::AIO::poll_fileno,
1268 poll => 'r', nice => 1, 1653 poll => 'r', nice => 1,
1269 cb => &IO::AIO::poll_cb); 1654 cb => &IO::AIO::poll_cb);
1270 1655
1271=item IO::AIO::poll_wait
1272
1273If there are any outstanding requests and none of them in the result
1274phase, wait till the result filehandle becomes ready for reading (simply
1275does a C<select> on the filehandle. This is useful if you want to
1276synchronously wait for some requests to finish).
1277
1278See C<nreqs> for an example.
1279
1280=item IO::AIO::poll
1281
1282Waits until some requests have been handled.
1283
1284Returns the number of requests processed, but is otherwise strictly
1285equivalent to:
1286
1287 IO::AIO::poll_wait, IO::AIO::poll_cb
1288
1289=item IO::AIO::flush
1290
1291Wait till all outstanding AIO requests have been handled.
1292
1293Strictly equivalent to:
1294
1295 IO::AIO::poll_wait, IO::AIO::poll_cb
1296 while IO::AIO::nreqs;
1297
1298=back 1656=back
1299 1657
1300=head3 CONTROLLING THE NUMBER OF THREADS 1658=head3 CONTROLLING THE NUMBER OF THREADS
1301 1659
1302=over 1660=over
… …
1335 1693
1336Under normal circumstances you don't need to call this function. 1694Under normal circumstances you don't need to call this function.
1337 1695
1338=item IO::AIO::max_idle $nthreads 1696=item IO::AIO::max_idle $nthreads
1339 1697
1340Limit the number of threads (default: 4) that are allowed to idle (i.e., 1698Limit the number of threads (default: 4) that are allowed to idle
1341threads that did not get a request to process within 10 seconds). That 1699(i.e., threads that did not get a request to process within the idle
1342means if a thread becomes idle while C<$nthreads> other threads are also 1700timeout (default: 10 seconds). That means if a thread becomes idle while
1343idle, it will free its resources and exit. 1701C<$nthreads> other threads are also idle, it will free its resources and
1702exit.
1344 1703
1345This is useful when you allow a large number of threads (e.g. 100 or 1000) 1704This is useful when you allow a large number of threads (e.g. 100 or 1000)
1346to allow for extremely high load situations, but want to free resources 1705to allow for extremely high load situations, but want to free resources
1347under normal circumstances (1000 threads can easily consume 30MB of RAM). 1706under normal circumstances (1000 threads can easily consume 30MB of RAM).
1348 1707
1349The default is probably ok in most situations, especially if thread 1708The default is probably ok in most situations, especially if thread
1350creation is fast. If thread creation is very slow on your system you might 1709creation is fast. If thread creation is very slow on your system you might
1351want to use larger values. 1710want to use larger values.
1352 1711
1712=item IO::AIO::idle_timeout $seconds
1713
1714Sets the minimum idle timeout (default 10) after which worker threads are
1715allowed to exit. SEe C<IO::AIO::max_idle>.
1716
1353=item IO::AIO::max_outstanding $maxreqs 1717=item IO::AIO::max_outstanding $maxreqs
1718
1719Sets the maximum number of outstanding requests to C<$nreqs>. If
1720you do queue up more than this number of requests, the next call to
1721C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as
1722C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no
1723longer exceeded.
1724
1725In other words, this setting does not enforce a queue limit, but can be
1726used to make poll functions block if the limit is exceeded.
1354 1727
1355This is a very bad function to use in interactive programs because it 1728This is a very bad function to use in interactive programs because it
1356blocks, and a bad way to reduce concurrency because it is inexact: Better 1729blocks, and a bad way to reduce concurrency because it is inexact: Better
1357use an C<aio_group> together with a feed callback. 1730use an C<aio_group> together with a feed callback.
1358 1731
1359Sets the maximum number of outstanding requests to C<$nreqs>. If you 1732It's main use is in scripts without an event loop - when you want to stat
1360do queue up more than this number of requests, the next call to the 1733a lot of files, you can write somehting like this:
1361C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1362function will block until the limit is no longer exceeded.
1363 1734
1364The default value is very large, so there is no practical limit on the 1735 IO::AIO::max_outstanding 32;
1365number of outstanding requests.
1366 1736
1367You can still queue as many requests as you want. Therefore, 1737 for my $path (...) {
1368C<max_outstanding> is mainly useful in simple scripts (with low values) or 1738 aio_stat $path , ...;
1369as a stop gap to shield against fatal memory overflow (with large values). 1739 IO::AIO::poll_cb;
1740 }
1741
1742 IO::AIO::flush;
1743
1744The call to C<poll_cb> inside the loop will normally return instantly, but
1745as soon as more thna C<32> reqeusts are in-flight, it will block until
1746some requests have been handled. This keeps the loop from pushing a large
1747number of C<aio_stat> requests onto the queue.
1748
1749The default value for C<max_outstanding> is very large, so there is no
1750practical limit on the number of outstanding requests.
1370 1751
1371=back 1752=back
1372 1753
1373=head3 STATISTICAL INFORMATION 1754=head3 STATISTICAL INFORMATION
1374 1755
… …
1394Returns the number of requests currently in the pending state (executed, 1775Returns the number of requests currently in the pending state (executed,
1395but not yet processed by poll_cb). 1776but not yet processed by poll_cb).
1396 1777
1397=back 1778=back
1398 1779
1780=head3 MISCELLANEOUS FUNCTIONS
1781
1782IO::AIO implements some functions that might be useful, but are not
1783asynchronous.
1784
1785=over 4
1786
1787=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1788
1789Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
1790but is blocking (this makes most sense if you know the input data is
1791likely cached already and the output filehandle is set to non-blocking
1792operations).
1793
1794Returns the number of bytes copied, or C<-1> on error.
1795
1796=item IO::AIO::fadvise $fh, $offset, $len, $advice
1797
1798Simply calls the C<posix_fadvise> function (see its
1799manpage for details). The following advice constants are
1800available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1801C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1802C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1803
1804On systems that do not implement C<posix_fadvise>, this function returns
1805ENOSYS, otherwise the return value of C<posix_fadvise>.
1806
1807=item IO::AIO::madvise $scalar, $offset, $len, $advice
1808
1809Simply calls the C<posix_madvise> function (see its
1810manpage for details). The following advice constants are
1811available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1812C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
1813
1814On systems that do not implement C<posix_madvise>, this function returns
1815ENOSYS, otherwise the return value of C<posix_madvise>.
1816
1817=item IO::AIO::mprotect $scalar, $offset, $len, $protect
1818
1819Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1820$scalar (see its manpage for details). The following protect
1821constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1822C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1823
1824On systems that do not implement C<mprotect>, this function returns
1825ENOSYS, otherwise the return value of C<mprotect>.
1826
1827=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1828
1829Memory-maps a file (or anonymous memory range) and attaches it to the
1830given C<$scalar>, which will act like a string scalar.
1831
1832The only operations allowed on the scalar are C<substr>/C<vec> that don't
1833change the string length, and most read-only operations such as copying it
1834or searching it with regexes and so on.
1835
1836Anything else is unsafe and will, at best, result in memory leaks.
1837
1838The memory map associated with the C<$scalar> is automatically removed
1839when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
1840C<IO::AIO::munmap> functions are called.
1841
1842This calls the C<mmap>(2) function internally. See your system's manual
1843page for details on the C<$length>, C<$prot> and C<$flags> parameters.
1844
1845The C<$length> must be larger than zero and smaller than the actual
1846filesize.
1847
1848C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1849C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1850
1851C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
1852C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
1853not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
1854(which is set to C<MAP_ANON> if your system only provides this
1855constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
1856C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
1857C<IO::AIO::MAP_NONBLOCK>
1858
1859If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1860
1861C<$offset> is the offset from the start of the file - it generally must be
1862a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
1863
1864Example:
1865
1866 use Digest::MD5;
1867 use IO::AIO;
1868
1869 open my $fh, "<verybigfile"
1870 or die "$!";
1871
1872 IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
1873 or die "verybigfile: $!";
1874
1875 my $fast_md5 = md5 $data;
1876
1877=item IO::AIO::munmap $scalar
1878
1879Removes a previous mmap and undefines the C<$scalar>.
1880
1881=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
1882
1883Calls the C<munlock> function, undoing the effects of a previous
1884C<aio_mlock> call (see its description for details).
1885
1886=item IO::AIO::munlockall
1887
1888Calls the C<munlockall> function.
1889
1890On systems that do not implement C<munlockall>, this function returns
1891ENOSYS, otherwise the return value of C<munlockall>.
1892
1893=back
1894
1399=cut 1895=cut
1400 1896
1401min_parallel 8; 1897min_parallel 8;
1402 1898
1403END { flush } 1899END { flush }
1404 1900
14051; 19011;
1406 1902
1903=head1 EVENT LOOP INTEGRATION
1904
1905It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
1906automatically into many event loops:
1907
1908 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
1909 use AnyEvent::AIO;
1910
1911You can also integrate IO::AIO manually into many event loops, here are
1912some examples of how to do this:
1913
1914 # EV integration
1915 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
1916
1917 # Event integration
1918 Event->io (fd => IO::AIO::poll_fileno,
1919 poll => 'r',
1920 cb => \&IO::AIO::poll_cb);
1921
1922 # Glib/Gtk2 integration
1923 add_watch Glib::IO IO::AIO::poll_fileno,
1924 in => sub { IO::AIO::poll_cb; 1 };
1925
1926 # Tk integration
1927 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
1928 readable => \&IO::AIO::poll_cb);
1929
1930 # Danga::Socket integration
1931 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
1932 \&IO::AIO::poll_cb);
1933
1407=head2 FORK BEHAVIOUR 1934=head2 FORK BEHAVIOUR
1408 1935
1409This module should do "the right thing" when the process using it forks: 1936Usage of pthreads in a program changes the semantics of fork
1937considerably. Specifically, only async-safe functions can be called after
1938fork. Perl doesn't know about this, so in general, you cannot call fork
1939with defined behaviour in perl if pthreads are involved. IO::AIO uses
1940pthreads, so this applies, but many other extensions and (for inexplicable
1941reasons) perl itself often is linked against pthreads, so this limitation
1942applies to quite a lot of perls.
1410 1943
1411Before the fork, IO::AIO enters a quiescent state where no requests 1944This module no longer tries to fight your OS, or POSIX. That means IO::AIO
1412can be added in other threads and no results will be processed. After 1945only works in the process that loaded it. Forking is fully supported, but
1413the fork the parent simply leaves the quiescent state and continues 1946using IO::AIO in the child is not.
1414request/result processing, while the child frees the request/result queue
1415(so that the requests started before the fork will only be handled in the
1416parent). Threads will be started on demand until the limit set in the
1417parent process has been reached again.
1418 1947
1419In short: the parent will, after a short pause, continue as if fork had 1948You might get around by not I<using> IO::AIO before (or after)
1420not been called, while the child will act as if IO::AIO has not been used 1949forking. You could also try to call the L<IO::AIO::reinit> function in the
1421yet. 1950child:
1951
1952=over 4
1953
1954=item IO::AIO::reinit
1955
1956Abandons all current requests and I/O threads and simply reinitialises all
1957data structures. This is not an operation supported by any standards, but
1958happens to work on GNU/Linux and some newer BSD systems.
1959
1960The only reasonable use for this function is to call it after forking, if
1961C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in
1962the process will result in undefined behaviour. Calling it at any time
1963will also result in any undefined (by POSIX) behaviour.
1964
1965=back
1422 1966
1423=head2 MEMORY USAGE 1967=head2 MEMORY USAGE
1424 1968
1425Per-request usage: 1969Per-request usage:
1426 1970

Diff Legend

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