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.119 by root, Sun Dec 2 20:54:33 2007 UTC vs.
Revision 1.171 by root, Sat Jan 2 14:24:32 2010 UTC

… …
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 30
31 # AnyEvent integration (EV, Event, Glib, Tk, urxvt, pureperl...) 31 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; 32 use AnyEvent::AIO;
33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34 33
35 # EV integration 34 # EV integration
36 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; 35 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
37 36
38 # Event integration 37 # Event integration
39 Event->io (fd => IO::AIO::poll_fileno, 38 Event->io (fd => IO::AIO::poll_fileno,
40 poll => 'r', 39 poll => 'r',
41 cb => \&IO::AIO::poll_cb); 40 cb => \&IO::AIO::poll_cb);
… …
53 \&IO::AIO::poll_cb); 52 \&IO::AIO::poll_cb);
54 53
55=head1 DESCRIPTION 54=head1 DESCRIPTION
56 55
57This module implements asynchronous I/O using whatever means your 56This module implements asynchronous I/O using whatever means your
58operating system supports. 57operating system supports. It is implemented as an interface to C<libeio>
58(L<http://software.schmorp.de/pkg/libeio.html>).
59 59
60Asynchronous means that operations that can normally block your program 60Asynchronous means that operations that can normally block your program
61(e.g. reading from disk) will be done asynchronously: the operation 61(e.g. reading from disk) will be done asynchronously: the operation
62will still block, but you can do something else in the meantime. This 62will still block, but you can do something else in the meantime. This
63is extremely useful for programs that need to stay interactive even 63is extremely useful for programs that need to stay interactive even
… …
67on a RAID volume or over NFS when you do a number of stat operations 67on a RAID volume or over NFS when you do a number of stat operations
68concurrently. 68concurrently.
69 69
70While most of this works on all types of file descriptors (for 70While most of this works on all types of file descriptors (for
71example sockets), using these functions on file descriptors that 71example sockets), using these functions on file descriptors that
72support nonblocking operation (again, sockets, pipes etc.) is very 72support nonblocking operation (again, sockets, pipes etc.) is
73inefficient. Use an event loop for that (such as the L<Event|Event> 73very inefficient. Use an event loop for that (such as the L<EV>
74module): IO::AIO will naturally fit into such an event loop itself. 74module): IO::AIO will naturally fit into such an event loop itself.
75 75
76In this version, a number of threads are started that execute your 76In this version, a number of threads are started that execute your
77requests and signal their completion. You don't need thread support 77requests and signal their completion. You don't need thread support
78in perl, and the threads created by this module will not be visible 78in perl, and the threads created by this module will not be visible
… …
88yourself, always call C<poll_cb> from within the same thread, or never 88yourself, always call C<poll_cb> from within the same thread, or never
89call C<poll_cb> (or other C<aio_> functions) recursively. 89call C<poll_cb> (or other C<aio_> functions) recursively.
90 90
91=head2 EXAMPLE 91=head2 EXAMPLE
92 92
93This is a simple example that uses the Event module and loads 93This is a simple example that uses the EV module and loads
94F</etc/passwd> asynchronously: 94F</etc/passwd> asynchronously:
95 95
96 use Fcntl; 96 use Fcntl;
97 use Event; 97 use EV;
98 use IO::AIO; 98 use IO::AIO;
99 99
100 # register the IO::AIO callback with Event 100 # register the IO::AIO callback with EV
101 Event->io (fd => IO::AIO::poll_fileno, 101 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
102 poll => 'r',
103 cb => \&IO::AIO::poll_cb);
104 102
105 # queue the request to open /etc/passwd 103 # queue the request to open /etc/passwd
106 aio_open "/etc/passwd", O_RDONLY, 0, sub { 104 aio_open "/etc/passwd", O_RDONLY, 0, sub {
107 my $fh = shift 105 my $fh = shift
108 or die "error while opening: $!"; 106 or die "error while opening: $!";
… …
120 118
121 # file contents now in $contents 119 # file contents now in $contents
122 print $contents; 120 print $contents;
123 121
124 # exit event loop and program 122 # exit event loop and program
125 Event::unloop; 123 EV::unloop;
126 }; 124 };
127 }; 125 };
128 126
129 # possibly queue up other requests, or open GUI windows, 127 # possibly queue up other requests, or open GUI windows,
130 # check for sockets etc. etc. 128 # check for sockets etc. etc.
131 129
132 # process events as long as there are some: 130 # process events as long as there are some:
133 Event::loop; 131 EV::loop;
134 132
135=head1 REQUEST ANATOMY AND LIFETIME 133=head1 REQUEST ANATOMY AND LIFETIME
136 134
137Every C<aio_*> function creates a request. which is a C data structure not 135Every C<aio_*> function creates a request. which is a C data structure not
138directly visible to Perl. 136directly visible to Perl.
… …
188 186
189package IO::AIO; 187package IO::AIO;
190 188
191use Carp (); 189use Carp ();
192 190
193no warnings; 191use common::sense;
194use strict 'vars';
195 192
196use base 'Exporter'; 193use base 'Exporter';
197 194
198BEGIN { 195BEGIN {
199 our $VERSION = '2.6'; 196 our $VERSION = '3.4';
200 197
201 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 198 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
202 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 199 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
203 aio_readlink aio_sync aio_fsync aio_fdatasync aio_readahead aio_rename aio_link 200 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
201 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
202 aio_rename aio_link aio_move aio_copy aio_group
204 aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir 203 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
205 aio_chown aio_chmod aio_utime aio_truncate); 204 aio_chmod aio_utime aio_truncate
205 aio_msync aio_mtouch);
206
206 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 207 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
207 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 208 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
208 min_parallel max_parallel max_idle 209 min_parallel max_parallel max_idle
209 nreqs nready npending nthreads 210 nreqs nready npending nthreads
210 max_poll_time max_poll_reqs); 211 max_poll_time max_poll_reqs
212 sendfile fadvise);
213
214 push @AIO_REQ, qw(aio_busy); # not exported
211 215
212 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 216 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
213 217
214 require XSLoader; 218 require XSLoader;
215 XSLoader::load ("IO::AIO", $VERSION); 219 XSLoader::load ("IO::AIO", $VERSION);
… …
222All the C<aio_*> calls are more or less thin wrappers around the syscall 226All the C<aio_*> calls are more or less thin wrappers around the syscall
223with the same name (sans C<aio_>). The arguments are similar or identical, 227with the same name (sans C<aio_>). The arguments are similar or identical,
224and they all accept an additional (and optional) C<$callback> argument 228and they all accept an additional (and optional) C<$callback> argument
225which must be a code reference. This code reference will get called with 229which must be a code reference. This code reference will get called with
226the syscall return code (e.g. most syscalls return C<-1> on error, unlike 230the syscall return code (e.g. most syscalls return C<-1> on error, unlike
227perl, which usually delivers "false") as it's sole argument when the given 231perl, which usually delivers "false") as its sole argument after the given
228syscall has been executed asynchronously. 232syscall has been executed asynchronously.
229 233
230All functions expecting a filehandle keep a copy of the filehandle 234All functions expecting a filehandle keep a copy of the filehandle
231internally until the request has finished. 235internally until the request has finished.
232 236
… …
246your pathnames to the locale (or other) encoding in effect in the user 250your pathnames to the locale (or other) encoding in effect in the user
247environment, d) use Glib::filename_from_unicode on unicode filenames or e) 251environment, d) use Glib::filename_from_unicode on unicode filenames or e)
248use something else to ensure your scalar has the correct contents. 252use something else to ensure your scalar has the correct contents.
249 253
250This works, btw. independent of the internal UTF-8 bit, which IO::AIO 254This works, btw. independent of the internal UTF-8 bit, which IO::AIO
251handles correctly wether it is set or not. 255handles correctly whether it is set or not.
252 256
253=over 4 257=over 4
254 258
255=item $prev_pri = aioreq_pri [$pri] 259=item $prev_pri = aioreq_pri [$pri]
256 260
… …
319 323
320Asynchronously close a file and call the callback with the result 324Asynchronously close a file and call the callback with the result
321code. 325code.
322 326
323Unfortunately, you can't do this to perl. Perl I<insists> very strongly on 327Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
324closing the file descriptor associated with the filehandle itself. Here is 328closing the file descriptor associated with the filehandle itself.
325what aio_close will try:
326 329
327 1. dup()licate the fd 330Therefore, C<aio_close> will not close the filehandle - instead it will
328 2. asynchronously close() the duplicated fd 331use dup2 to overwrite the file descriptor with the write-end of a pipe
329 3. dup()licate the fd once more 332(the pipe fd will be created on demand and will be cached).
330 4. let perl close() the filehandle
331 5. asynchronously close the duplicated fd
332 333
333The idea is that the first close() flushes stuff to disk that closing an 334Or in other words: the file descriptor will be closed, but it will not be
334fd will flush, so when perl closes the fd, nothing much will need to be 335free for reuse until the perl filehandle is closed.
335flushed. The second async. close() will then flush stuff to disk that
336closing the last fd to the file will flush.
337
338Just FYI, SuSv3 has this to say on close:
339
340 All outstanding record locks owned by the process on the file
341 associated with the file descriptor shall be removed.
342
343 If fildes refers to a socket, close() shall cause the socket to be
344 destroyed. ... close() shall block for up to the current linger
345 interval until all data is transmitted.
346 [this actually sounds like a specification bug, but who knows]
347
348And at least Linux additionally actually flushes stuff on every close,
349even when the file itself is still open.
350
351Sounds enourmously inefficient and complicated? Yes... please show me how
352to nuke perl's fd out of existence...
353 336
354=cut 337=cut
355 338
356sub aio_close($;$) {
357 aio_block {
358 my ($fh, $cb) = @_;
359
360 my $pri = aioreq_pri;
361 my $grp = aio_group $cb;
362
363 my $fd = fileno $fh;
364
365 defined $fd or Carp::croak "aio_close called with fd-less filehandle";
366
367 # if the dups fail we will simply get EBADF
368 my $fd2 = _dup $fd;
369 aioreq_pri $pri;
370 add $grp _aio_close $fd2, sub {
371 my $fd2 = _dup $fd;
372 close $fh;
373 aioreq_pri $pri;
374 add $grp _aio_close $fd2, sub {
375 $grp->result ($_[0]);
376 };
377 };
378
379 $grp
380 }
381}
382
383
384=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
385 340
386=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 341=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
387 342
388Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> 343Reads or writes C<$length> bytes from or to the specified C<$fh> and
389into the scalar given by C<$data> and offset C<$dataoffset> and calls the 344C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
390callback without the actual number of bytes read (or -1 on error, just 345and calls the callback without the actual number of bytes read (or -1 on
391like the syscall). 346error, just like the syscall).
347
348C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
349offset plus the actual number of bytes read.
392 350
393If C<$offset> is undefined, then the current file descriptor offset will 351If C<$offset> is undefined, then the current file descriptor offset will
394be used (and updated), otherwise the file descriptor offset will not be 352be used (and updated), otherwise the file descriptor offset will not be
395changed by these calls. 353changed by these calls.
396 354
397If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. 355If C<$length> is undefined in C<aio_write>, use the remaining length of
356C<$data>.
398 357
399If C<$dataoffset> is less than zero, it will be counted from the end of 358If C<$dataoffset> is less than zero, it will be counted from the end of
400C<$data>. 359C<$data>.
401 360
402The C<$data> scalar I<MUST NOT> be modified in any way while the request 361The C<$data> scalar I<MUST NOT> be modified in any way while the request
… …
422 381
423This call tries to make use of a native C<sendfile> syscall to provide 382This call tries to make use of a native C<sendfile> syscall to provide
424zero-copy operation. For this to work, C<$out_fh> should refer to a 383zero-copy operation. For this to work, C<$out_fh> should refer to a
425socket, and C<$in_fh> should refer to mmap'able file. 384socket, and C<$in_fh> should refer to mmap'able file.
426 385
427If the native sendfile call fails or is not implemented, it will be 386If a native sendfile cannot be found or it fails with C<ENOSYS>,
387C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>,
428emulated, so you can call C<aio_sendfile> on any type of filehandle 388it will be emulated, so you can call C<aio_sendfile> on any type of
429regardless of the limitations of the operating system. 389filehandle regardless of the limitations of the operating system.
430 390
431Please note, however, that C<aio_sendfile> can read more bytes from 391Please note, however, that C<aio_sendfile> can read more bytes from
432C<$in_fh> than are written, and there is no way to find out how many 392C<$in_fh> than are written, and there is no way to find out how many
433bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 393bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
434provides the number of bytes written to C<$out_fh>. Only if the result 394provides the number of bytes written to C<$out_fh>. Only if the result
… …
574 534
575Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 535Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
576directory (i.e. opendir + readdir + closedir). The entries will not be 536directory (i.e. opendir + readdir + closedir). The entries will not be
577sorted, and will B<NOT> include the C<.> and C<..> entries. 537sorted, and will B<NOT> include the C<.> and C<..> entries.
578 538
579The callback a single argument which is either C<undef> or an array-ref 539The callback is passed a single argument which is either C<undef> or an
580with the filenames. 540array-ref with the filenames.
541
542
543=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
544
545Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune
546behaviour and output format. In case of an error, C<$entries> will be
547C<undef>.
548
549The flags are a combination of the following constants, ORed together (the
550flags will also be passed to the callback, possibly modified):
551
552=over 4
553
554=item IO::AIO::READDIR_DENTS
555
556When this flag is off, then the callback gets an arrayref with of names
557only (as with C<aio_readdir>), otherwise it gets an arrayref with
558C<[$name, $type, $inode]> arrayrefs, each describing a single directory
559entry in more detail.
560
561C<$name> is the name of the entry.
562
563C<$type> is one of the C<IO::AIO::DT_xxx> constants:
564
565C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
566C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
567C<IO::AIO::DT_WHT>.
568
569C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to
570know, you have to run stat yourself. Also, for speed reasons, the C<$type>
571scalars are read-only: you can not modify them.
572
573C<$inode> is the inode number (which might not be exact on systems with 64
574bit inode numbers and 32 bit perls). This field has unspecified content on
575systems that do not deliver the inode information.
576
577=item IO::AIO::READDIR_DIRS_FIRST
578
579When this flag is set, then the names will be returned in an order where
580likely directories come first. This is useful when you need to quickly
581find directories, or you want to find all directories while avoiding to
582stat() each entry.
583
584If the system returns type information in readdir, then this is used
585to find directories directly. Otherwise, likely directories are files
586beginning with ".", or otherwise files with no dots, of which files with
587short names are tried first.
588
589=item IO::AIO::READDIR_STAT_ORDER
590
591When this flag is set, then the names will be returned in an order
592suitable for stat()'ing each one. That is, when you plan to stat()
593all files in the given directory, then the returned order will likely
594be fastest.
595
596If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then
597the likely dirs come first, resulting in a less optimal stat order.
598
599=item IO::AIO::READDIR_FOUND_UNKNOWN
600
601This flag should not be set when calling C<aio_readdirx>. Instead, it
602is being set by C<aio_readdirx>, when any of the C<$type>'s found were
603C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all
604C<$type>'s are known, which can be used to speed up some algorithms.
605
606=back
581 607
582 608
583=item aio_load $path, $data, $callback->($status) 609=item aio_load $path, $data, $callback->($status)
584 610
585This is a composite request that tries to fully load the given file into 611This is a composite request that tries to fully load the given file into
586memory. Status is the same as with aio_read. 612memory. Status is the same as with aio_read.
587 613
588=cut 614=cut
589 615
590sub aio_load($$;$) { 616sub aio_load($$;$) {
591 aio_block {
592 my ($path, undef, $cb) = @_; 617 my ($path, undef, $cb) = @_;
593 my $data = \$_[1]; 618 my $data = \$_[1];
594 619
595 my $pri = aioreq_pri; 620 my $pri = aioreq_pri;
596 my $grp = aio_group $cb; 621 my $grp = aio_group $cb;
622
623 aioreq_pri $pri;
624 add $grp aio_open $path, O_RDONLY, 0, sub {
625 my $fh = shift
626 or return $grp->result (-1);
597 627
598 aioreq_pri $pri; 628 aioreq_pri $pri;
599 add $grp aio_open $path, O_RDONLY, 0, sub {
600 my $fh = shift
601 or return $grp->result (-1);
602
603 aioreq_pri $pri;
604 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 629 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
605 $grp->result ($_[0]); 630 $grp->result ($_[0]);
606 };
607 }; 631 };
608
609 $grp
610 } 632 };
633
634 $grp
611} 635}
612 636
613=item aio_copy $srcpath, $dstpath, $callback->($status) 637=item aio_copy $srcpath, $dstpath, $callback->($status)
614 638
615Try to copy the I<file> (directories not supported as either source or 639Try to copy the I<file> (directories not supported as either source or
616destination) from C<$srcpath> to C<$dstpath> and call the callback with 640destination) from C<$srcpath> to C<$dstpath> and call the callback with
617the C<0> (error) or C<-1> ok. 641a status of C<0> (ok) or C<-1> (error, see C<$!>).
618 642
619This is a composite request that it creates the destination file with 643This is a composite request that creates the destination file with
620mode 0200 and copies the contents of the source file into it using 644mode 0200 and copies the contents of the source file into it using
621C<aio_sendfile>, followed by restoring atime, mtime, access mode and 645C<aio_sendfile>, followed by restoring atime, mtime, access mode and
622uid/gid, in that order. 646uid/gid, in that order.
623 647
624If an error occurs, the partial destination file will be unlinked, if 648If an error occurs, the partial destination file will be unlinked, if
… …
626errors are being ignored. 650errors are being ignored.
627 651
628=cut 652=cut
629 653
630sub aio_copy($$;$) { 654sub aio_copy($$;$) {
631 aio_block {
632 my ($src, $dst, $cb) = @_; 655 my ($src, $dst, $cb) = @_;
633 656
634 my $pri = aioreq_pri; 657 my $pri = aioreq_pri;
635 my $grp = aio_group $cb; 658 my $grp = aio_group $cb;
636 659
637 aioreq_pri $pri; 660 aioreq_pri $pri;
638 add $grp aio_open $src, O_RDONLY, 0, sub { 661 add $grp aio_open $src, O_RDONLY, 0, sub {
639 if (my $src_fh = $_[0]) { 662 if (my $src_fh = $_[0]) {
640 my @stat = stat $src_fh; 663 my @stat = stat $src_fh; # hmm, might block over nfs?
641 664
642 aioreq_pri $pri; 665 aioreq_pri $pri;
643 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 666 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
644 if (my $dst_fh = $_[0]) { 667 if (my $dst_fh = $_[0]) {
645 aioreq_pri $pri; 668 aioreq_pri $pri;
646 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 669 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
647 if ($_[0] == $stat[7]) { 670 if ($_[0] == $stat[7]) {
648 $grp->result (0); 671 $grp->result (0);
649 close $src_fh; 672 close $src_fh;
650 673
651 # those should not normally block. should. should.
652 utime $stat[8], $stat[9], $dst;
653 chmod $stat[2] & 07777, $dst_fh;
654 chown $stat[4], $stat[5], $dst_fh;
655 close $dst_fh;
656 } else { 674 my $ch = sub {
657 $grp->result (-1);
658 close $src_fh;
659 close $dst_fh;
660
661 aioreq $pri; 675 aioreq_pri $pri;
676 add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
677 aioreq_pri $pri;
678 add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
679 aioreq_pri $pri;
662 add $grp aio_unlink $dst; 680 add $grp aio_close $dst_fh;
681 }
682 };
663 } 683 };
684
685 aioreq_pri $pri;
686 add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
687 if ($_[0] < 0 && $! == ENOSYS) {
688 aioreq_pri $pri;
689 add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
690 } else {
691 $ch->();
692 }
693 };
694 } else {
695 $grp->result (-1);
696 close $src_fh;
697 close $dst_fh;
698
699 aioreq $pri;
700 add $grp aio_unlink $dst;
664 }; 701 }
665 } else {
666 $grp->result (-1);
667 } 702 };
703 } else {
704 $grp->result (-1);
668 }, 705 }
669
670 } else {
671 $grp->result (-1);
672 } 706 },
707
708 } else {
709 $grp->result (-1);
673 }; 710 }
674
675 $grp
676 } 711 };
712
713 $grp
677} 714}
678 715
679=item aio_move $srcpath, $dstpath, $callback->($status) 716=item aio_move $srcpath, $dstpath, $callback->($status)
680 717
681Try to move the I<file> (directories not supported as either source or 718Try to move the I<file> (directories not supported as either source or
682destination) from C<$srcpath> to C<$dstpath> and call the callback with 719destination) from C<$srcpath> to C<$dstpath> and call the callback with
683the C<0> (error) or C<-1> ok. 720a status of C<0> (ok) or C<-1> (error, see C<$!>).
684 721
685This is a composite request that tries to rename(2) the file first. If 722This is a composite request that tries to rename(2) the file first; if
686rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if 723rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
687that is successful, unlinking the C<$srcpath>. 724that is successful, unlinks the C<$srcpath>.
688 725
689=cut 726=cut
690 727
691sub aio_move($$;$) { 728sub aio_move($$;$) {
692 aio_block {
693 my ($src, $dst, $cb) = @_; 729 my ($src, $dst, $cb) = @_;
694 730
695 my $pri = aioreq_pri; 731 my $pri = aioreq_pri;
696 my $grp = aio_group $cb; 732 my $grp = aio_group $cb;
697 733
698 aioreq_pri $pri; 734 aioreq_pri $pri;
699 add $grp aio_rename $src, $dst, sub { 735 add $grp aio_rename $src, $dst, sub {
700 if ($_[0] && $! == EXDEV) { 736 if ($_[0] && $! == EXDEV) {
701 aioreq_pri $pri; 737 aioreq_pri $pri;
702 add $grp aio_copy $src, $dst, sub { 738 add $grp aio_copy $src, $dst, sub {
703 $grp->result ($_[0]);
704
705 if (!$_[0]) {
706 aioreq_pri $pri;
707 add $grp aio_unlink $src;
708 }
709 };
710 } else {
711 $grp->result ($_[0]); 739 $grp->result ($_[0]);
740
741 if (!$_[0]) {
742 aioreq_pri $pri;
743 add $grp aio_unlink $src;
744 }
712 } 745 };
746 } else {
747 $grp->result ($_[0]);
713 }; 748 }
714
715 $grp
716 } 749 };
750
751 $grp
717} 752}
718 753
719=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 754=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
720 755
721Scans a directory (similar to C<aio_readdir>) but additionally tries to 756Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
741 776
742Implementation notes. 777Implementation notes.
743 778
744The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. 779The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
745 780
781If readdir returns file type information, then this is used directly to
782find directories.
783
746After reading the directory, the modification time, size etc. of the 784Otherwise, after reading the directory, the modification time, size etc.
747directory before and after the readdir is checked, and if they match (and 785of the directory before and after the readdir is checked, and if they
748isn't the current time), the link count will be used to decide how many 786match (and isn't the current time), the link count will be used to decide
749entries are directories (if >= 2). Otherwise, no knowledge of the number 787how many entries are directories (if >= 2). Otherwise, no knowledge of the
750of subdirectories will be assumed. 788number of subdirectories will be assumed.
751 789
752Then entries will be sorted into likely directories (everything without 790Then entries will be sorted into likely directories a non-initial dot
753a non-initial dot currently) and likely non-directories (everything 791currently) and likely non-directories (see C<aio_readdirx>). Then every
754else). Then every entry plus an appended C</.> will be C<stat>'ed, 792entry plus an appended C</.> will be C<stat>'ed, likely directories first,
755likely directories first. If that succeeds, it assumes that the entry 793in order of their inode numbers. If that succeeds, it assumes that the
756is a directory or a symlink to directory (which will be checked 794entry is a directory or a symlink to directory (which will be checked
757seperately). This is often faster than stat'ing the entry itself because 795seperately). This is often faster than stat'ing the entry itself because
758filesystems might detect the type of the entry without reading the inode 796filesystems might detect the type of the entry without reading the inode
759data (e.g. ext2fs filetype feature). 797data (e.g. ext2fs filetype feature), even on systems that cannot return
798the filetype information on readdir.
760 799
761If the known number of directories (link count - 2) has been reached, the 800If the known number of directories (link count - 2) has been reached, the
762rest of the entries is assumed to be non-directories. 801rest of the entries is assumed to be non-directories.
763 802
764This only works with certainty on POSIX (= UNIX) filesystems, which 803This only works with certainty on POSIX (= UNIX) filesystems, which
… …
769directory counting heuristic. 808directory counting heuristic.
770 809
771=cut 810=cut
772 811
773sub aio_scandir($$;$) { 812sub aio_scandir($$;$) {
774 aio_block {
775 my ($path, $maxreq, $cb) = @_; 813 my ($path, $maxreq, $cb) = @_;
776 814
777 my $pri = aioreq_pri; 815 my $pri = aioreq_pri;
778 816
779 my $grp = aio_group $cb; 817 my $grp = aio_group $cb;
780 818
781 $maxreq = 4 if $maxreq <= 0; 819 $maxreq = 4 if $maxreq <= 0;
782 820
783 # stat once 821 # stat once
822 aioreq_pri $pri;
823 add $grp aio_stat $path, sub {
824 return $grp->result () if $_[0];
825 my $now = time;
826 my $hash1 = join ":", (stat _)[0,1,3,7,9];
827
828 # read the directory entries
784 aioreq_pri $pri; 829 aioreq_pri $pri;
785 add $grp aio_stat $path, sub { 830 add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub {
831 my $entries = shift
786 return $grp->result () if $_[0]; 832 or return $grp->result ();
787 my $now = time;
788 my $hash1 = join ":", (stat _)[0,1,3,7,9];
789 833
790 # read the directory entries 834 # stat the dir another time
791 aioreq_pri $pri; 835 aioreq_pri $pri;
792 add $grp aio_readdir $path, sub {
793 my $entries = shift
794 or return $grp->result ();
795
796 # stat the dir another time
797 aioreq_pri $pri;
798 add $grp aio_stat $path, sub { 836 add $grp aio_stat $path, sub {
799 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 837 my $hash2 = join ":", (stat _)[0,1,3,7,9];
800 838
801 my $ndirs; 839 my $ndirs;
802 840
803 # take the slow route if anything looks fishy 841 # take the slow route if anything looks fishy
804 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 842 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
805 $ndirs = -1; 843 $ndirs = -1;
806 } else { 844 } else {
807 # if nlink == 2, we are finished 845 # if nlink == 2, we are finished
808 # on non-posix-fs's, we rely on nlink < 2 846 # for non-posix-fs's, we rely on nlink < 2
809 $ndirs = (stat _)[3] - 2 847 $ndirs = (stat _)[3] - 2
810 or return $grp->result ([], $entries); 848 or return $grp->result ([], $entries);
811 } 849 }
812 850
813 # sort into likely dirs and likely nondirs
814 # dirs == files without ".", short entries first
815 $entries = [map $_->[0],
816 sort { $b->[1] cmp $a->[1] }
817 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
818 @$entries];
819
820 my (@dirs, @nondirs); 851 my (@dirs, @nondirs);
821 852
822 my $statgrp = add $grp aio_group sub { 853 my $statgrp = add $grp aio_group sub {
823 $grp->result (\@dirs, \@nondirs); 854 $grp->result (\@dirs, \@nondirs);
824 }; 855 };
825 856
826 limit $statgrp $maxreq; 857 limit $statgrp $maxreq;
827 feed $statgrp sub { 858 feed $statgrp sub {
828 return unless @$entries; 859 return unless @$entries;
829 my $entry = pop @$entries; 860 my $entry = shift @$entries;
830 861
831 aioreq_pri $pri; 862 aioreq_pri $pri;
832 add $statgrp aio_stat "$path/$entry/.", sub { 863 add $statgrp aio_stat "$path/$entry/.", sub {
833 if ($_[0] < 0) { 864 if ($_[0] < 0) {
834 push @nondirs, $entry; 865 push @nondirs, $entry;
835 } else { 866 } else {
836 # need to check for real directory 867 # need to check for real directory
837 aioreq_pri $pri; 868 aioreq_pri $pri;
838 add $statgrp aio_lstat "$path/$entry", sub { 869 add $statgrp aio_lstat "$path/$entry", sub {
839 if (-d _) { 870 if (-d _) {
840 push @dirs, $entry; 871 push @dirs, $entry;
841 872
842 unless (--$ndirs) { 873 unless (--$ndirs) {
843 push @nondirs, @$entries; 874 push @nondirs, @$entries;
844 feed $statgrp; 875 feed $statgrp;
845 }
846 } else {
847 push @nondirs, $entry;
848 } 876 }
877 } else {
878 push @nondirs, $entry;
849 } 879 }
850 } 880 }
851 }; 881 }
852 }; 882 };
853 }; 883 };
854 }; 884 };
855 }; 885 };
856
857 $grp
858 } 886 };
887
888 $grp
859} 889}
860 890
861=item aio_rmtree $path, $callback->($status) 891=item aio_rmtree $path, $callback->($status)
862 892
863Delete a directory tree starting (and including) C<$path>, return the 893Delete a directory tree starting (and including) C<$path>, return the
… …
867 897
868=cut 898=cut
869 899
870sub aio_rmtree; 900sub aio_rmtree;
871sub aio_rmtree($;$) { 901sub aio_rmtree($;$) {
872 aio_block {
873 my ($path, $cb) = @_; 902 my ($path, $cb) = @_;
874 903
875 my $pri = aioreq_pri; 904 my $pri = aioreq_pri;
876 my $grp = aio_group $cb; 905 my $grp = aio_group $cb;
877 906
878 aioreq_pri $pri; 907 aioreq_pri $pri;
879 add $grp aio_scandir $path, 0, sub { 908 add $grp aio_scandir $path, 0, sub {
880 my ($dirs, $nondirs) = @_; 909 my ($dirs, $nondirs) = @_;
881 910
882 my $dirgrp = aio_group sub { 911 my $dirgrp = aio_group sub {
883 add $grp aio_rmdir $path, sub { 912 add $grp aio_rmdir $path, sub {
884 $grp->result ($_[0]); 913 $grp->result ($_[0]);
885 };
886 }; 914 };
887
888 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
889 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
890
891 add $grp $dirgrp;
892 }; 915 };
893 916
894 $grp 917 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
918 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
919
920 add $grp $dirgrp;
895 } 921 };
922
923 $grp
896} 924}
897 925
898=item aio_sync $callback->($status) 926=item aio_sync $callback->($status)
899 927
900Asynchronously call sync and call the callback when finished. 928Asynchronously call sync and call the callback when finished.
… …
909Asynchronously call fdatasync on the given filehandle and call the 937Asynchronously call fdatasync on the given filehandle and call the
910callback with the fdatasync result code. 938callback with the fdatasync result code.
911 939
912If this call isn't available because your OS lacks it or it couldn't be 940If this call isn't available because your OS lacks it or it couldn't be
913detected, it will be emulated by calling C<fsync> instead. 941detected, it will be emulated by calling C<fsync> instead.
942
943=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
944
945Sync the data portion of the file specified by C<$offset> and C<$length>
946to disk (but NOT the metadata), by calling the Linux-specific
947sync_file_range call. If sync_file_range is not available or it returns
948ENOSYS, then fdatasync or fsync is being substituted.
949
950C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
951C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
952C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
953manpage for details.
954
955=item aio_pathsync $path, $callback->($status)
956
957This request tries to open, fsync and close the given path. This is a
958composite request intended to sync directories after directory operations
959(E.g. rename). This might not work on all operating systems or have any
960specific effect, but usually it makes sure that directory changes get
961written to disc. It works for anything that can be opened for read-only,
962not just directories.
963
964Future versions of this function might fall back to other methods when
965C<fsync> on the directory fails (such as calling C<sync>).
966
967Passes C<0> when everything went ok, and C<-1> on error.
968
969=cut
970
971sub aio_pathsync($;$) {
972 my ($path, $cb) = @_;
973
974 my $pri = aioreq_pri;
975 my $grp = aio_group $cb;
976
977 aioreq_pri $pri;
978 add $grp aio_open $path, O_RDONLY, 0, sub {
979 my ($fh) = @_;
980 if ($fh) {
981 aioreq_pri $pri;
982 add $grp aio_fsync $fh, sub {
983 $grp->result ($_[0]);
984
985 aioreq_pri $pri;
986 add $grp aio_close $fh;
987 };
988 } else {
989 $grp->result (-1);
990 }
991 };
992
993 $grp
994}
995
996=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
997
998This is a rather advanced IO::AIO call, which only works on mmap(2)ed
999scalars (see the L<Sys::Mmap> or L<Mmap> modules for details on this, note
1000that the scalar must only be modified in-place while an aio operation is
1001pending on it).
1002
1003It calls the C<msync> function of your OS, if available, with the memory
1004area starting at C<$offset> in the string and ending C<$length> bytes
1005later. If C<$length> is negative, counts from the end, and if C<$length>
1006is C<undef>, then it goes till the end of the string. The flags can be
1007a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
1008C<IO::AIO::MS_SYNC>.
1009
1010=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1011
1012This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1013scalars.
1014
1015It touches (reads or writes) all memory pages in the specified
1016range inside the scalar. All caveats and parameters are the same
1017as for C<aio_msync>, above, except for flags, which must be either
1018C<0> (which reads all pages and ensures they are instantiated) or
1019C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
1020writing an octet from it, which dirties the page).
914 1021
915=item aio_group $callback->(...) 1022=item aio_group $callback->(...)
916 1023
917This is a very special aio request: Instead of doing something, it is a 1024This is a very special aio request: Instead of doing something, it is a
918container for other aio requests, which is useful if you want to bundle 1025container for other aio requests, which is useful if you want to bundle
… …
968=item cancel $req 1075=item cancel $req
969 1076
970Cancels the request, if possible. Has the effect of skipping execution 1077Cancels the request, if possible. Has the effect of skipping execution
971when entering the B<execute> state and skipping calling the callback when 1078when entering the B<execute> state and skipping calling the callback when
972entering the the B<result> state, but will leave the request otherwise 1079entering the the B<result> state, but will leave the request otherwise
973untouched. That means that requests that currently execute will not be 1080untouched (with the exception of readdir). That means that requests that
974stopped and resources held by the request will not be freed prematurely. 1081currently execute will not be stopped and resources held by the request
1082will not be freed prematurely.
975 1083
976=item cb $req $callback->(...) 1084=item cb $req $callback->(...)
977 1085
978Replace (or simply set) the callback registered to the request. 1086Replace (or simply set) the callback registered to the request.
979 1087
… …
1030Their lifetime, simplified, looks like this: when they are empty, they 1138Their lifetime, simplified, looks like this: when they are empty, they
1031will finish very quickly. If they contain only requests that are in the 1139will finish very quickly. If they contain only requests that are in the
1032C<done> state, they will also finish. Otherwise they will continue to 1140C<done> state, they will also finish. Otherwise they will continue to
1033exist. 1141exist.
1034 1142
1035That means after creating a group you have some time to add requests. And 1143That means after creating a group you have some time to add requests
1036in the callbacks of those requests, you can add further requests to the 1144(precisely before the callback has been invoked, which is only done within
1037group. And only when all those requests have finished will the the group 1145the C<poll_cb>). And in the callbacks of those requests, you can add
1038itself finish. 1146further requests to the group. And only when all those requests have
1147finished will the the group itself finish.
1039 1148
1040=over 4 1149=over 4
1041 1150
1042=item add $grp ... 1151=item add $grp ...
1043 1152
… …
1052=item $grp->cancel_subs 1161=item $grp->cancel_subs
1053 1162
1054Cancel all subrequests and clears any feeder, but not the group request 1163Cancel all subrequests and clears any feeder, but not the group request
1055itself. Useful when you queued a lot of events but got a result early. 1164itself. Useful when you queued a lot of events but got a result early.
1056 1165
1166The group request will finish normally (you cannot add requests to the
1167group).
1168
1057=item $grp->result (...) 1169=item $grp->result (...)
1058 1170
1059Set the result value(s) that will be passed to the group callback when all 1171Set the result value(s) that will be passed to the group callback when all
1060subrequests have finished and set thre groups errno to the current value 1172subrequests have finished and set the groups errno to the current value
1061of errno (just like calling C<errno> without an error number). By default, 1173of errno (just like calling C<errno> without an error number). By default,
1062no argument will be passed and errno is zero. 1174no argument will be passed and errno is zero.
1063 1175
1064=item $grp->errno ([$errno]) 1176=item $grp->errno ([$errno])
1065 1177
… …
1076=item feed $grp $callback->($grp) 1188=item feed $grp $callback->($grp)
1077 1189
1078Sets a feeder/generator on this group: every group can have an attached 1190Sets a feeder/generator on this group: every group can have an attached
1079generator that generates requests if idle. The idea behind this is that, 1191generator that generates requests if idle. The idea behind this is that,
1080although you could just queue as many requests as you want in a group, 1192although you could just queue as many requests as you want in a group,
1081this might starve other requests for a potentially long time. For 1193this might starve other requests for a potentially long time. For example,
1082example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1194C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1083requests, delaying any later requests for a long time. 1195delaying any later requests for a long time.
1084 1196
1085To avoid this, and allow incremental generation of requests, you can 1197To avoid this, and allow incremental generation of requests, you can
1086instead a group and set a feeder on it that generates those requests. The 1198instead a group and set a feeder on it that generates those requests. The
1087feed callback will be called whenever there are few enough (see C<limit>, 1199feed callback will be called whenever there are few enough (see C<limit>,
1088below) requests active in the group itself and is expected to queue more 1200below) requests active in the group itself and is expected to queue more
… …
1092not impose any limits). 1204not impose any limits).
1093 1205
1094If the feed does not queue more requests when called, it will be 1206If the feed does not queue more requests when called, it will be
1095automatically removed from the group. 1207automatically removed from the group.
1096 1208
1097If the feed limit is C<0>, it will be set to C<2> automatically. 1209If the feed limit is C<0> when this method is called, it will be set to
1210C<2> automatically.
1098 1211
1099Example: 1212Example:
1100 1213
1101 # stat all files in @files, but only ever use four aio requests concurrently: 1214 # stat all files in @files, but only ever use four aio requests concurrently:
1102 1215
… …
1114Sets the feeder limit for the group: The feeder will be called whenever 1227Sets the feeder limit for the group: The feeder will be called whenever
1115the group contains less than this many requests. 1228the group contains less than this many requests.
1116 1229
1117Setting the limit to C<0> will pause the feeding process. 1230Setting the limit to C<0> will pause the feeding process.
1118 1231
1232The default value for the limit is C<0>, but note that setting a feeder
1233automatically bumps it up to C<2>.
1234
1119=back 1235=back
1120 1236
1121=head2 SUPPORT FUNCTIONS 1237=head2 SUPPORT FUNCTIONS
1122 1238
1123=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1239=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
… …
1125=over 4 1241=over 4
1126 1242
1127=item $fileno = IO::AIO::poll_fileno 1243=item $fileno = IO::AIO::poll_fileno
1128 1244
1129Return the I<request result pipe file descriptor>. This filehandle must be 1245Return the I<request result pipe file descriptor>. This filehandle must be
1130polled for reading by some mechanism outside this module (e.g. Event or 1246polled for reading by some mechanism outside this module (e.g. EV, Glib,
1131select, see below or the SYNOPSIS). If the pipe becomes readable you have 1247select and so on, see below or the SYNOPSIS). If the pipe becomes readable
1132to call C<poll_cb> to check the results. 1248you have to call C<poll_cb> to check the results.
1133 1249
1134See C<poll_cb> for an example. 1250See C<poll_cb> for an example.
1135 1251
1136=item IO::AIO::poll_cb 1252=item IO::AIO::poll_cb
1137 1253
1138Process some outstanding events on the result pipe. You have to call this 1254Process some outstanding events on the result pipe. You have to call this
1139regularly. Returns the number of events processed. Returns immediately 1255regularly. Returns C<0> if all events could be processed, or C<-1> if it
1256returned earlier for whatever reason. Returns immediately when no events
1140when no events are outstanding. The amount of events processed depends on 1257are outstanding. The amount of events processed depends on the settings of
1141the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. 1258C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1142 1259
1143If not all requests were processed for whatever reason, the filehandle 1260If not all requests were processed for whatever reason, the filehandle
1144will still be ready when C<poll_cb> returns. 1261will still be ready when C<poll_cb> returns, so normally you don't have to
1262do anything special to have it called later.
1145 1263
1146Example: Install an Event watcher that automatically calls 1264Example: Install an Event watcher that automatically calls
1147IO::AIO::poll_cb with high priority: 1265IO::AIO::poll_cb with high priority (more examples can be found in the
1266SYNOPSIS section, at the top of this document):
1148 1267
1149 Event->io (fd => IO::AIO::poll_fileno, 1268 Event->io (fd => IO::AIO::poll_fileno,
1150 poll => 'r', async => 1, 1269 poll => 'r', async => 1,
1151 cb => \&IO::AIO::poll_cb); 1270 cb => \&IO::AIO::poll_cb);
1152 1271
… …
1263 1382
1264The default is probably ok in most situations, especially if thread 1383The default is probably ok in most situations, especially if thread
1265creation is fast. If thread creation is very slow on your system you might 1384creation is fast. If thread creation is very slow on your system you might
1266want to use larger values. 1385want to use larger values.
1267 1386
1268=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1387=item IO::AIO::max_outstanding $maxreqs
1269 1388
1270This is a very bad function to use in interactive programs because it 1389This is a very bad function to use in interactive programs because it
1271blocks, and a bad way to reduce concurrency because it is inexact: Better 1390blocks, and a bad way to reduce concurrency because it is inexact: Better
1272use an C<aio_group> together with a feed callback. 1391use an C<aio_group> together with a feed callback.
1273 1392
… …
1278 1397
1279The default value is very large, so there is no practical limit on the 1398The default value is very large, so there is no practical limit on the
1280number of outstanding requests. 1399number of outstanding requests.
1281 1400
1282You can still queue as many requests as you want. Therefore, 1401You can still queue as many requests as you want. Therefore,
1283C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1402C<max_outstanding> is mainly useful in simple scripts (with low values) or
1284as a stop gap to shield against fatal memory overflow (with large values). 1403as a stop gap to shield against fatal memory overflow (with large values).
1285 1404
1286=back 1405=back
1287 1406
1288=head3 STATISTICAL INFORMATION 1407=head3 STATISTICAL INFORMATION
… …
1306 1425
1307=item IO::AIO::npending 1426=item IO::AIO::npending
1308 1427
1309Returns the number of requests currently in the pending state (executed, 1428Returns the number of requests currently in the pending state (executed,
1310but not yet processed by poll_cb). 1429but not yet processed by poll_cb).
1430
1431=back
1432
1433=head3 MISCELLANEOUS FUNCTIONS
1434
1435IO::AIO implements some functions that might be useful, but are not
1436asynchronous.
1437
1438=over 4
1439
1440=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1441
1442Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
1443but is blocking (this makes most sense if you know the input data is
1444likely cached already and the output filehandle is set to non-blocking
1445operations).
1446
1447Returns the number of bytes copied, or C<-1> on error.
1448
1449=item IO::AIO::fadvise $fh, $offset, $len, $advice
1450
1451Simply calls the C<posix_fadvise> function (see it's
1452manpage for details). The following advice constants are
1453avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1454C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1455C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1456
1457On systems that do not implement C<posix_fadvise>, this function returns
1458ENOSYS, otherwise the return value of C<posix_fadvise>.
1311 1459
1312=back 1460=back
1313 1461
1314=cut 1462=cut
1315 1463
… …
1358 1506
1359Known bugs will be fixed in the next release. 1507Known bugs will be fixed in the next release.
1360 1508
1361=head1 SEE ALSO 1509=head1 SEE ALSO
1362 1510
1363L<Coro::AIO>. 1511L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1512more natural syntax.
1364 1513
1365=head1 AUTHOR 1514=head1 AUTHOR
1366 1515
1367 Marc Lehmann <schmorp@schmorp.de> 1516 Marc Lehmann <schmorp@schmorp.de>
1368 http://home.schmorp.de/ 1517 http://home.schmorp.de/

Diff Legend

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