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.117 by root, Sat Oct 6 14:05:19 2007 UTC vs.
Revision 1.172 by root, Thu Jan 7 18:08:21 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, POE, urxvt, pureperl...)
32 use AnyEvent::AIO;
33
31 # AnyEvent integration 34 # EV integration
32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; 35 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34 36
35 # Event integration 37 # Event integration
36 Event->io (fd => IO::AIO::poll_fileno, 38 Event->io (fd => IO::AIO::poll_fileno,
37 poll => 'r', 39 poll => 'r',
38 cb => \&IO::AIO::poll_cb); 40 cb => \&IO::AIO::poll_cb);
… …
50 \&IO::AIO::poll_cb); 52 \&IO::AIO::poll_cb);
51 53
52=head1 DESCRIPTION 54=head1 DESCRIPTION
53 55
54This module implements asynchronous I/O using whatever means your 56This module implements asynchronous I/O using whatever means your
55operating system supports. 57operating system supports. It is implemented as an interface to C<libeio>
58(L<http://software.schmorp.de/pkg/libeio.html>).
56 59
57Asynchronous means that operations that can normally block your program 60Asynchronous means that operations that can normally block your program
58(e.g. reading from disk) will be done asynchronously: the operation 61(e.g. reading from disk) will be done asynchronously: the operation
59will 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
60is extremely useful for programs that need to stay interactive even 63is extremely useful for programs that need to stay interactive even
… …
64on 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
65concurrently. 68concurrently.
66 69
67While most of this works on all types of file descriptors (for 70While most of this works on all types of file descriptors (for
68example sockets), using these functions on file descriptors that 71example sockets), using these functions on file descriptors that
69support nonblocking operation (again, sockets, pipes etc.) is very 72support nonblocking operation (again, sockets, pipes etc.) is
70inefficient. 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>
71module): IO::AIO will naturally fit into such an event loop itself. 74module): IO::AIO will naturally fit into such an event loop itself.
72 75
73In this version, a number of threads are started that execute your 76In this version, a number of threads are started that execute your
74requests and signal their completion. You don't need thread support 77requests and signal their completion. You don't need thread support
75in 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
… …
85yourself, 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
86call C<poll_cb> (or other C<aio_> functions) recursively. 89call C<poll_cb> (or other C<aio_> functions) recursively.
87 90
88=head2 EXAMPLE 91=head2 EXAMPLE
89 92
90This is a simple example that uses the Event module and loads 93This is a simple example that uses the EV module and loads
91F</etc/passwd> asynchronously: 94F</etc/passwd> asynchronously:
92 95
93 use Fcntl; 96 use Fcntl;
94 use Event; 97 use EV;
95 use IO::AIO; 98 use IO::AIO;
96 99
97 # register the IO::AIO callback with Event 100 # register the IO::AIO callback with EV
98 Event->io (fd => IO::AIO::poll_fileno, 101 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
99 poll => 'r',
100 cb => \&IO::AIO::poll_cb);
101 102
102 # queue the request to open /etc/passwd 103 # queue the request to open /etc/passwd
103 aio_open "/etc/passwd", O_RDONLY, 0, sub { 104 aio_open "/etc/passwd", O_RDONLY, 0, sub {
104 my $fh = shift 105 my $fh = shift
105 or die "error while opening: $!"; 106 or die "error while opening: $!";
… …
117 118
118 # file contents now in $contents 119 # file contents now in $contents
119 print $contents; 120 print $contents;
120 121
121 # exit event loop and program 122 # exit event loop and program
122 Event::unloop; 123 EV::unloop;
123 }; 124 };
124 }; 125 };
125 126
126 # possibly queue up other requests, or open GUI windows, 127 # possibly queue up other requests, or open GUI windows,
127 # check for sockets etc. etc. 128 # check for sockets etc. etc.
128 129
129 # process events as long as there are some: 130 # process events as long as there are some:
130 Event::loop; 131 EV::loop;
131 132
132=head1 REQUEST ANATOMY AND LIFETIME 133=head1 REQUEST ANATOMY AND LIFETIME
133 134
134Every 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
135directly visible to Perl. 136directly visible to Perl.
… …
185 186
186package IO::AIO; 187package IO::AIO;
187 188
188use Carp (); 189use Carp ();
189 190
190no warnings; 191use common::sense;
191use strict 'vars';
192 192
193use base 'Exporter'; 193use base 'Exporter';
194 194
195BEGIN { 195BEGIN {
196 our $VERSION = '2.51'; 196 our $VERSION = '3.4';
197 197
198 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
199 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
200 aio_readlink 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
201 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
202 aio_chown aio_chmod aio_utime aio_truncate); 204 aio_chmod aio_utime aio_truncate
205 aio_msync aio_mtouch aio_statvfs);
206
203 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 207 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
204 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 208 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
205 min_parallel max_parallel max_idle 209 min_parallel max_parallel max_idle
206 nreqs nready npending nthreads 210 nreqs nready npending nthreads
207 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
208 215
209 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 216 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
210 217
211 require XSLoader; 218 require XSLoader;
212 XSLoader::load ("IO::AIO", $VERSION); 219 XSLoader::load ("IO::AIO", $VERSION);
… …
219All 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
220with 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,
221and they all accept an additional (and optional) C<$callback> argument 228and they all accept an additional (and optional) C<$callback> argument
222which 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
223the 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
224perl, which usually delivers "false") as it's sole argument when the given 231perl, which usually delivers "false") as its sole argument after the given
225syscall has been executed asynchronously. 232syscall has been executed asynchronously.
226 233
227All functions expecting a filehandle keep a copy of the filehandle 234All functions expecting a filehandle keep a copy of the filehandle
228internally until the request has finished. 235internally until the request has finished.
229 236
… …
243your 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
244environment, d) use Glib::filename_from_unicode on unicode filenames or e) 251environment, d) use Glib::filename_from_unicode on unicode filenames or e)
245use something else to ensure your scalar has the correct contents. 252use something else to ensure your scalar has the correct contents.
246 253
247This 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
248handles correctly wether it is set or not. 255handles correctly whether it is set or not.
249 256
250=over 4 257=over 4
251 258
252=item $prev_pri = aioreq_pri [$pri] 259=item $prev_pri = aioreq_pri [$pri]
253 260
… …
316 323
317Asynchronously close a file and call the callback with the result 324Asynchronously close a file and call the callback with the result
318code. 325code.
319 326
320Unfortunately, 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
321closing the file descriptor associated with the filehandle itself. Here is 328closing the file descriptor associated with the filehandle itself.
322what aio_close will try:
323 329
324 1. dup()licate the fd 330Therefore, C<aio_close> will not close the filehandle - instead it will
325 2. asynchronously close() the duplicated fd 331use dup2 to overwrite the file descriptor with the write-end of a pipe
326 3. dup()licate the fd once more 332(the pipe fd will be created on demand and will be cached).
327 4. let perl close() the filehandle
328 5. asynchronously close the duplicated fd
329 333
330The 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
331fd will flush, so when perl closes the fd, nothing much will need to be 335free for reuse until the perl filehandle is closed.
332flushed. The second async. close() will then flush stuff to disk that
333closing the last fd to the file will flush.
334
335Just FYI, SuSv3 has this to say on close:
336
337 All outstanding record locks owned by the process on the file
338 associated with the file descriptor shall be removed.
339
340 If fildes refers to a socket, close() shall cause the socket to be
341 destroyed. ... close() shall block for up to the current linger
342 interval until all data is transmitted.
343 [this actually sounds like a specification bug, but who knows]
344
345And at least Linux additionally actually flushes stuff on every close,
346even when the file itself is still open.
347
348Sounds enourmously inefficient and complicated? Yes... please show me how
349to nuke perl's fd out of existence...
350 336
351=cut 337=cut
352 338
353sub aio_close($;$) {
354 aio_block {
355 my ($fh, $cb) = @_;
356
357 my $pri = aioreq_pri;
358 my $grp = aio_group $cb;
359
360 my $fd = fileno $fh;
361
362 defined $fd or Carp::croak "aio_close called with fd-less filehandle";
363
364 # if the dups fail we will simply get EBADF
365 my $fd2 = _dup $fd;
366 aioreq_pri $pri;
367 add $grp _aio_close $fd2, sub {
368 my $fd2 = _dup $fd;
369 close $fh;
370 aioreq_pri $pri;
371 add $grp _aio_close $fd2, sub {
372 $grp->result ($_[0]);
373 };
374 };
375
376 $grp
377 }
378}
379
380
381=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
382 340
383=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 341=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
384 342
385Reads 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
386into 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>
387callback 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
388like 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.
389 350
390If C<$offset> is undefined, then the current file descriptor offset will 351If C<$offset> is undefined, then the current file descriptor offset will
391be used (and updated), otherwise the file descriptor offset will not be 352be used (and updated), otherwise the file descriptor offset will not be
392changed by these calls. 353changed by these calls.
393 354
394If 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>.
395 357
396If 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
397C<$data>. 359C<$data>.
398 360
399The 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
… …
419 381
420This 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
421zero-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
422socket, and C<$in_fh> should refer to mmap'able file. 384socket, and C<$in_fh> should refer to mmap'able file.
423 385
424If 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>,
425emulated, 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
426regardless of the limitations of the operating system. 389filehandle regardless of the limitations of the operating system.
427 390
428Please note, however, that C<aio_sendfile> can read more bytes from 391Please note, however, that C<aio_sendfile> can read more bytes from
429C<$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
430bytes 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
431provides 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
… …
469 $_[0] and die "stat failed: $!"; 432 $_[0] and die "stat failed: $!";
470 print "size is ", -s _, "\n"; 433 print "size is ", -s _, "\n";
471 }; 434 };
472 435
473 436
437=item aio_statvfs $fh_or_path, $callback->($statvfs)
438
439Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
440whether a file handle or path was passed.
441
442On success, the callback is passed a hash reference with the following
443members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
444C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
445is passed.
446
447The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
448C<ST_NOSUID>.
449
450The following non-POSIX IO::AIO::ST_* flag masks are defined to
451their correct value when available, or to C<0> on systems that do
452not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
453C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
454C<ST_NODIRATIME> and C<ST_RELATIME>.
455
456Example: stat C</wd> and dump out the data if successful.
457
458 aio_statvfs "/wd", sub {
459 my $f = $_[0]
460 or die "statvfs: $!";
461
462 use Data::Dumper;
463 say Dumper $f;
464 };
465
466 # result:
467 {
468 bsize => 1024,
469 bfree => 4333064312,
470 blocks => 10253828096,
471 files => 2050765568,
472 flag => 4096,
473 favail => 2042092649,
474 bavail => 4333064312,
475 ffree => 2042092649,
476 namemax => 255,
477 frsize => 1024,
478 fsid => 1810
479 }
480
481
474=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 482=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
475 483
476Works like perl's C<utime> function (including the special case of $atime 484Works like perl's C<utime> function (including the special case of $atime
477and $mtime being undef). Fractional times are supported if the underlying 485and $mtime being undef). Fractional times are supported if the underlying
478syscalls support them. 486syscalls support them.
… …
571 579
572Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 580Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
573directory (i.e. opendir + readdir + closedir). The entries will not be 581directory (i.e. opendir + readdir + closedir). The entries will not be
574sorted, and will B<NOT> include the C<.> and C<..> entries. 582sorted, and will B<NOT> include the C<.> and C<..> entries.
575 583
576The callback a single argument which is either C<undef> or an array-ref 584The callback is passed a single argument which is either C<undef> or an
577with the filenames. 585array-ref with the filenames.
586
587
588=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
589
590Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune
591behaviour and output format. In case of an error, C<$entries> will be
592C<undef>.
593
594The flags are a combination of the following constants, ORed together (the
595flags will also be passed to the callback, possibly modified):
596
597=over 4
598
599=item IO::AIO::READDIR_DENTS
600
601When this flag is off, then the callback gets an arrayref with of names
602only (as with C<aio_readdir>), otherwise it gets an arrayref with
603C<[$name, $type, $inode]> arrayrefs, each describing a single directory
604entry in more detail.
605
606C<$name> is the name of the entry.
607
608C<$type> is one of the C<IO::AIO::DT_xxx> constants:
609
610C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
611C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
612C<IO::AIO::DT_WHT>.
613
614C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to
615know, you have to run stat yourself. Also, for speed reasons, the C<$type>
616scalars are read-only: you can not modify them.
617
618C<$inode> is the inode number (which might not be exact on systems with 64
619bit inode numbers and 32 bit perls). This field has unspecified content on
620systems that do not deliver the inode information.
621
622=item IO::AIO::READDIR_DIRS_FIRST
623
624When this flag is set, then the names will be returned in an order where
625likely directories come first. This is useful when you need to quickly
626find directories, or you want to find all directories while avoiding to
627stat() each entry.
628
629If the system returns type information in readdir, then this is used
630to find directories directly. Otherwise, likely directories are files
631beginning with ".", or otherwise files with no dots, of which files with
632short names are tried first.
633
634=item IO::AIO::READDIR_STAT_ORDER
635
636When this flag is set, then the names will be returned in an order
637suitable for stat()'ing each one. That is, when you plan to stat()
638all files in the given directory, then the returned order will likely
639be fastest.
640
641If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then
642the likely dirs come first, resulting in a less optimal stat order.
643
644=item IO::AIO::READDIR_FOUND_UNKNOWN
645
646This flag should not be set when calling C<aio_readdirx>. Instead, it
647is being set by C<aio_readdirx>, when any of the C<$type>'s found were
648C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all
649C<$type>'s are known, which can be used to speed up some algorithms.
650
651=back
578 652
579 653
580=item aio_load $path, $data, $callback->($status) 654=item aio_load $path, $data, $callback->($status)
581 655
582This is a composite request that tries to fully load the given file into 656This is a composite request that tries to fully load the given file into
583memory. Status is the same as with aio_read. 657memory. Status is the same as with aio_read.
584 658
585=cut 659=cut
586 660
587sub aio_load($$;$) { 661sub aio_load($$;$) {
588 aio_block {
589 my ($path, undef, $cb) = @_; 662 my ($path, undef, $cb) = @_;
590 my $data = \$_[1]; 663 my $data = \$_[1];
591 664
592 my $pri = aioreq_pri; 665 my $pri = aioreq_pri;
593 my $grp = aio_group $cb; 666 my $grp = aio_group $cb;
667
668 aioreq_pri $pri;
669 add $grp aio_open $path, O_RDONLY, 0, sub {
670 my $fh = shift
671 or return $grp->result (-1);
594 672
595 aioreq_pri $pri; 673 aioreq_pri $pri;
596 add $grp aio_open $path, O_RDONLY, 0, sub {
597 my $fh = shift
598 or return $grp->result (-1);
599
600 aioreq_pri $pri;
601 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 674 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
602 $grp->result ($_[0]); 675 $grp->result ($_[0]);
603 };
604 }; 676 };
605
606 $grp
607 } 677 };
678
679 $grp
608} 680}
609 681
610=item aio_copy $srcpath, $dstpath, $callback->($status) 682=item aio_copy $srcpath, $dstpath, $callback->($status)
611 683
612Try to copy the I<file> (directories not supported as either source or 684Try to copy the I<file> (directories not supported as either source or
613destination) from C<$srcpath> to C<$dstpath> and call the callback with 685destination) from C<$srcpath> to C<$dstpath> and call the callback with
614the C<0> (error) or C<-1> ok. 686a status of C<0> (ok) or C<-1> (error, see C<$!>).
615 687
616This is a composite request that it creates the destination file with 688This is a composite request that creates the destination file with
617mode 0200 and copies the contents of the source file into it using 689mode 0200 and copies the contents of the source file into it using
618C<aio_sendfile>, followed by restoring atime, mtime, access mode and 690C<aio_sendfile>, followed by restoring atime, mtime, access mode and
619uid/gid, in that order. 691uid/gid, in that order.
620 692
621If an error occurs, the partial destination file will be unlinked, if 693If an error occurs, the partial destination file will be unlinked, if
… …
623errors are being ignored. 695errors are being ignored.
624 696
625=cut 697=cut
626 698
627sub aio_copy($$;$) { 699sub aio_copy($$;$) {
628 aio_block {
629 my ($src, $dst, $cb) = @_; 700 my ($src, $dst, $cb) = @_;
630 701
631 my $pri = aioreq_pri; 702 my $pri = aioreq_pri;
632 my $grp = aio_group $cb; 703 my $grp = aio_group $cb;
633 704
634 aioreq_pri $pri; 705 aioreq_pri $pri;
635 add $grp aio_open $src, O_RDONLY, 0, sub { 706 add $grp aio_open $src, O_RDONLY, 0, sub {
636 if (my $src_fh = $_[0]) { 707 if (my $src_fh = $_[0]) {
637 my @stat = stat $src_fh; 708 my @stat = stat $src_fh; # hmm, might block over nfs?
638 709
639 aioreq_pri $pri; 710 aioreq_pri $pri;
640 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 711 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
641 if (my $dst_fh = $_[0]) { 712 if (my $dst_fh = $_[0]) {
642 aioreq_pri $pri; 713 aioreq_pri $pri;
643 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 714 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
644 if ($_[0] == $stat[7]) { 715 if ($_[0] == $stat[7]) {
645 $grp->result (0); 716 $grp->result (0);
646 close $src_fh; 717 close $src_fh;
647 718
648 # those should not normally block. should. should.
649 utime $stat[8], $stat[9], $dst;
650 chmod $stat[2] & 07777, $dst_fh;
651 chown $stat[4], $stat[5], $dst_fh;
652 close $dst_fh;
653 } else { 719 my $ch = sub {
654 $grp->result (-1);
655 close $src_fh;
656 close $dst_fh;
657
658 aioreq $pri; 720 aioreq_pri $pri;
721 add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
722 aioreq_pri $pri;
723 add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
724 aioreq_pri $pri;
659 add $grp aio_unlink $dst; 725 add $grp aio_close $dst_fh;
726 }
727 };
660 } 728 };
729
730 aioreq_pri $pri;
731 add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
732 if ($_[0] < 0 && $! == ENOSYS) {
733 aioreq_pri $pri;
734 add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
735 } else {
736 $ch->();
737 }
738 };
739 } else {
740 $grp->result (-1);
741 close $src_fh;
742 close $dst_fh;
743
744 aioreq $pri;
745 add $grp aio_unlink $dst;
661 }; 746 }
662 } else {
663 $grp->result (-1);
664 } 747 };
748 } else {
749 $grp->result (-1);
665 }, 750 }
666
667 } else {
668 $grp->result (-1);
669 } 751 },
752
753 } else {
754 $grp->result (-1);
670 }; 755 }
671
672 $grp
673 } 756 };
757
758 $grp
674} 759}
675 760
676=item aio_move $srcpath, $dstpath, $callback->($status) 761=item aio_move $srcpath, $dstpath, $callback->($status)
677 762
678Try to move the I<file> (directories not supported as either source or 763Try to move the I<file> (directories not supported as either source or
679destination) from C<$srcpath> to C<$dstpath> and call the callback with 764destination) from C<$srcpath> to C<$dstpath> and call the callback with
680the C<0> (error) or C<-1> ok. 765a status of C<0> (ok) or C<-1> (error, see C<$!>).
681 766
682This is a composite request that tries to rename(2) the file first. If 767This is a composite request that tries to rename(2) the file first; if
683rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if 768rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
684that is successful, unlinking the C<$srcpath>. 769that is successful, unlinks the C<$srcpath>.
685 770
686=cut 771=cut
687 772
688sub aio_move($$;$) { 773sub aio_move($$;$) {
689 aio_block {
690 my ($src, $dst, $cb) = @_; 774 my ($src, $dst, $cb) = @_;
691 775
692 my $pri = aioreq_pri; 776 my $pri = aioreq_pri;
693 my $grp = aio_group $cb; 777 my $grp = aio_group $cb;
694 778
695 aioreq_pri $pri; 779 aioreq_pri $pri;
696 add $grp aio_rename $src, $dst, sub { 780 add $grp aio_rename $src, $dst, sub {
697 if ($_[0] && $! == EXDEV) { 781 if ($_[0] && $! == EXDEV) {
698 aioreq_pri $pri; 782 aioreq_pri $pri;
699 add $grp aio_copy $src, $dst, sub { 783 add $grp aio_copy $src, $dst, sub {
700 $grp->result ($_[0]);
701
702 if (!$_[0]) {
703 aioreq_pri $pri;
704 add $grp aio_unlink $src;
705 }
706 };
707 } else {
708 $grp->result ($_[0]); 784 $grp->result ($_[0]);
785
786 if (!$_[0]) {
787 aioreq_pri $pri;
788 add $grp aio_unlink $src;
789 }
709 } 790 };
791 } else {
792 $grp->result ($_[0]);
710 }; 793 }
711
712 $grp
713 } 794 };
795
796 $grp
714} 797}
715 798
716=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 799=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
717 800
718Scans a directory (similar to C<aio_readdir>) but additionally tries to 801Scans a directory (similar to C<aio_readdir>) but additionally tries to
… …
738 821
739Implementation notes. 822Implementation notes.
740 823
741The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. 824The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
742 825
826If readdir returns file type information, then this is used directly to
827find directories.
828
743After reading the directory, the modification time, size etc. of the 829Otherwise, after reading the directory, the modification time, size etc.
744directory before and after the readdir is checked, and if they match (and 830of the directory before and after the readdir is checked, and if they
745isn't the current time), the link count will be used to decide how many 831match (and isn't the current time), the link count will be used to decide
746entries are directories (if >= 2). Otherwise, no knowledge of the number 832how many entries are directories (if >= 2). Otherwise, no knowledge of the
747of subdirectories will be assumed. 833number of subdirectories will be assumed.
748 834
749Then entries will be sorted into likely directories (everything without 835Then entries will be sorted into likely directories a non-initial dot
750a non-initial dot currently) and likely non-directories (everything 836currently) and likely non-directories (see C<aio_readdirx>). Then every
751else). Then every entry plus an appended C</.> will be C<stat>'ed, 837entry plus an appended C</.> will be C<stat>'ed, likely directories first,
752likely directories first. If that succeeds, it assumes that the entry 838in order of their inode numbers. If that succeeds, it assumes that the
753is a directory or a symlink to directory (which will be checked 839entry is a directory or a symlink to directory (which will be checked
754seperately). This is often faster than stat'ing the entry itself because 840seperately). This is often faster than stat'ing the entry itself because
755filesystems might detect the type of the entry without reading the inode 841filesystems might detect the type of the entry without reading the inode
756data (e.g. ext2fs filetype feature). 842data (e.g. ext2fs filetype feature), even on systems that cannot return
843the filetype information on readdir.
757 844
758If the known number of directories (link count - 2) has been reached, the 845If the known number of directories (link count - 2) has been reached, the
759rest of the entries is assumed to be non-directories. 846rest of the entries is assumed to be non-directories.
760 847
761This only works with certainty on POSIX (= UNIX) filesystems, which 848This only works with certainty on POSIX (= UNIX) filesystems, which
… …
766directory counting heuristic. 853directory counting heuristic.
767 854
768=cut 855=cut
769 856
770sub aio_scandir($$;$) { 857sub aio_scandir($$;$) {
771 aio_block {
772 my ($path, $maxreq, $cb) = @_; 858 my ($path, $maxreq, $cb) = @_;
773 859
774 my $pri = aioreq_pri; 860 my $pri = aioreq_pri;
775 861
776 my $grp = aio_group $cb; 862 my $grp = aio_group $cb;
777 863
778 $maxreq = 4 if $maxreq <= 0; 864 $maxreq = 4 if $maxreq <= 0;
779 865
780 # stat once 866 # stat once
867 aioreq_pri $pri;
868 add $grp aio_stat $path, sub {
869 return $grp->result () if $_[0];
870 my $now = time;
871 my $hash1 = join ":", (stat _)[0,1,3,7,9];
872
873 # read the directory entries
781 aioreq_pri $pri; 874 aioreq_pri $pri;
782 add $grp aio_stat $path, sub { 875 add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub {
876 my $entries = shift
783 return $grp->result () if $_[0]; 877 or return $grp->result ();
784 my $now = time;
785 my $hash1 = join ":", (stat _)[0,1,3,7,9];
786 878
787 # read the directory entries 879 # stat the dir another time
788 aioreq_pri $pri; 880 aioreq_pri $pri;
789 add $grp aio_readdir $path, sub {
790 my $entries = shift
791 or return $grp->result ();
792
793 # stat the dir another time
794 aioreq_pri $pri;
795 add $grp aio_stat $path, sub { 881 add $grp aio_stat $path, sub {
796 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 882 my $hash2 = join ":", (stat _)[0,1,3,7,9];
797 883
798 my $ndirs; 884 my $ndirs;
799 885
800 # take the slow route if anything looks fishy 886 # take the slow route if anything looks fishy
801 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 887 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
802 $ndirs = -1; 888 $ndirs = -1;
803 } else { 889 } else {
804 # if nlink == 2, we are finished 890 # if nlink == 2, we are finished
805 # on non-posix-fs's, we rely on nlink < 2 891 # for non-posix-fs's, we rely on nlink < 2
806 $ndirs = (stat _)[3] - 2 892 $ndirs = (stat _)[3] - 2
807 or return $grp->result ([], $entries); 893 or return $grp->result ([], $entries);
808 } 894 }
809 895
810 # sort into likely dirs and likely nondirs
811 # dirs == files without ".", short entries first
812 $entries = [map $_->[0],
813 sort { $b->[1] cmp $a->[1] }
814 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
815 @$entries];
816
817 my (@dirs, @nondirs); 896 my (@dirs, @nondirs);
818 897
819 my $statgrp = add $grp aio_group sub { 898 my $statgrp = add $grp aio_group sub {
820 $grp->result (\@dirs, \@nondirs); 899 $grp->result (\@dirs, \@nondirs);
821 }; 900 };
822 901
823 limit $statgrp $maxreq; 902 limit $statgrp $maxreq;
824 feed $statgrp sub { 903 feed $statgrp sub {
825 return unless @$entries; 904 return unless @$entries;
826 my $entry = pop @$entries; 905 my $entry = shift @$entries;
827 906
828 aioreq_pri $pri; 907 aioreq_pri $pri;
829 add $statgrp aio_stat "$path/$entry/.", sub { 908 add $statgrp aio_stat "$path/$entry/.", sub {
830 if ($_[0] < 0) { 909 if ($_[0] < 0) {
831 push @nondirs, $entry; 910 push @nondirs, $entry;
832 } else { 911 } else {
833 # need to check for real directory 912 # need to check for real directory
834 aioreq_pri $pri; 913 aioreq_pri $pri;
835 add $statgrp aio_lstat "$path/$entry", sub { 914 add $statgrp aio_lstat "$path/$entry", sub {
836 if (-d _) { 915 if (-d _) {
837 push @dirs, $entry; 916 push @dirs, $entry;
838 917
839 unless (--$ndirs) { 918 unless (--$ndirs) {
840 push @nondirs, @$entries; 919 push @nondirs, @$entries;
841 feed $statgrp; 920 feed $statgrp;
842 }
843 } else {
844 push @nondirs, $entry;
845 } 921 }
922 } else {
923 push @nondirs, $entry;
846 } 924 }
847 } 925 }
848 }; 926 }
849 }; 927 };
850 }; 928 };
851 }; 929 };
852 }; 930 };
853
854 $grp
855 } 931 };
932
933 $grp
856} 934}
857 935
858=item aio_rmtree $path, $callback->($status) 936=item aio_rmtree $path, $callback->($status)
859 937
860Delete a directory tree starting (and including) C<$path>, return the 938Delete a directory tree starting (and including) C<$path>, return the
… …
864 942
865=cut 943=cut
866 944
867sub aio_rmtree; 945sub aio_rmtree;
868sub aio_rmtree($;$) { 946sub aio_rmtree($;$) {
869 aio_block {
870 my ($path, $cb) = @_; 947 my ($path, $cb) = @_;
871 948
872 my $pri = aioreq_pri; 949 my $pri = aioreq_pri;
873 my $grp = aio_group $cb; 950 my $grp = aio_group $cb;
874 951
875 aioreq_pri $pri; 952 aioreq_pri $pri;
876 add $grp aio_scandir $path, 0, sub { 953 add $grp aio_scandir $path, 0, sub {
877 my ($dirs, $nondirs) = @_; 954 my ($dirs, $nondirs) = @_;
878 955
879 my $dirgrp = aio_group sub { 956 my $dirgrp = aio_group sub {
880 add $grp aio_rmdir $path, sub { 957 add $grp aio_rmdir $path, sub {
881 $grp->result ($_[0]); 958 $grp->result ($_[0]);
882 };
883 }; 959 };
884
885 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
886 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
887
888 add $grp $dirgrp;
889 }; 960 };
890 961
891 $grp 962 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
963 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
964
965 add $grp $dirgrp;
892 } 966 };
967
968 $grp
893} 969}
970
971=item aio_sync $callback->($status)
972
973Asynchronously call sync and call the callback when finished.
894 974
895=item aio_fsync $fh, $callback->($status) 975=item aio_fsync $fh, $callback->($status)
896 976
897Asynchronously call fsync on the given filehandle and call the callback 977Asynchronously call fsync on the given filehandle and call the callback
898with the fsync result code. 978with the fsync result code.
… …
902Asynchronously call fdatasync on the given filehandle and call the 982Asynchronously call fdatasync on the given filehandle and call the
903callback with the fdatasync result code. 983callback with the fdatasync result code.
904 984
905If this call isn't available because your OS lacks it or it couldn't be 985If this call isn't available because your OS lacks it or it couldn't be
906detected, it will be emulated by calling C<fsync> instead. 986detected, it will be emulated by calling C<fsync> instead.
987
988=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
989
990Sync the data portion of the file specified by C<$offset> and C<$length>
991to disk (but NOT the metadata), by calling the Linux-specific
992sync_file_range call. If sync_file_range is not available or it returns
993ENOSYS, then fdatasync or fsync is being substituted.
994
995C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
996C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
997C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
998manpage for details.
999
1000=item aio_pathsync $path, $callback->($status)
1001
1002This request tries to open, fsync and close the given path. This is a
1003composite request intended to sync directories after directory operations
1004(E.g. rename). This might not work on all operating systems or have any
1005specific effect, but usually it makes sure that directory changes get
1006written to disc. It works for anything that can be opened for read-only,
1007not just directories.
1008
1009Future versions of this function might fall back to other methods when
1010C<fsync> on the directory fails (such as calling C<sync>).
1011
1012Passes C<0> when everything went ok, and C<-1> on error.
1013
1014=cut
1015
1016sub aio_pathsync($;$) {
1017 my ($path, $cb) = @_;
1018
1019 my $pri = aioreq_pri;
1020 my $grp = aio_group $cb;
1021
1022 aioreq_pri $pri;
1023 add $grp aio_open $path, O_RDONLY, 0, sub {
1024 my ($fh) = @_;
1025 if ($fh) {
1026 aioreq_pri $pri;
1027 add $grp aio_fsync $fh, sub {
1028 $grp->result ($_[0]);
1029
1030 aioreq_pri $pri;
1031 add $grp aio_close $fh;
1032 };
1033 } else {
1034 $grp->result (-1);
1035 }
1036 };
1037
1038 $grp
1039}
1040
1041=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1042
1043This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1044scalars (see the L<Sys::Mmap> or L<Mmap> modules for details on this, note
1045that the scalar must only be modified in-place while an aio operation is
1046pending on it).
1047
1048It calls the C<msync> function of your OS, if available, with the memory
1049area starting at C<$offset> in the string and ending C<$length> bytes
1050later. If C<$length> is negative, counts from the end, and if C<$length>
1051is C<undef>, then it goes till the end of the string. The flags can be
1052a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
1053C<IO::AIO::MS_SYNC>.
1054
1055=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1056
1057This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1058scalars.
1059
1060It touches (reads or writes) all memory pages in the specified
1061range inside the scalar. All caveats and parameters are the same
1062as for C<aio_msync>, above, except for flags, which must be either
1063C<0> (which reads all pages and ensures they are instantiated) or
1064C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
1065writing an octet from it, which dirties the page).
907 1066
908=item aio_group $callback->(...) 1067=item aio_group $callback->(...)
909 1068
910This is a very special aio request: Instead of doing something, it is a 1069This is a very special aio request: Instead of doing something, it is a
911container for other aio requests, which is useful if you want to bundle 1070container for other aio requests, which is useful if you want to bundle
… …
961=item cancel $req 1120=item cancel $req
962 1121
963Cancels the request, if possible. Has the effect of skipping execution 1122Cancels the request, if possible. Has the effect of skipping execution
964when entering the B<execute> state and skipping calling the callback when 1123when entering the B<execute> state and skipping calling the callback when
965entering the the B<result> state, but will leave the request otherwise 1124entering the the B<result> state, but will leave the request otherwise
966untouched. That means that requests that currently execute will not be 1125untouched (with the exception of readdir). That means that requests that
967stopped and resources held by the request will not be freed prematurely. 1126currently execute will not be stopped and resources held by the request
1127will not be freed prematurely.
968 1128
969=item cb $req $callback->(...) 1129=item cb $req $callback->(...)
970 1130
971Replace (or simply set) the callback registered to the request. 1131Replace (or simply set) the callback registered to the request.
972 1132
… …
1023Their lifetime, simplified, looks like this: when they are empty, they 1183Their lifetime, simplified, looks like this: when they are empty, they
1024will finish very quickly. If they contain only requests that are in the 1184will finish very quickly. If they contain only requests that are in the
1025C<done> state, they will also finish. Otherwise they will continue to 1185C<done> state, they will also finish. Otherwise they will continue to
1026exist. 1186exist.
1027 1187
1028That means after creating a group you have some time to add requests. And 1188That means after creating a group you have some time to add requests
1029in the callbacks of those requests, you can add further requests to the 1189(precisely before the callback has been invoked, which is only done within
1030group. And only when all those requests have finished will the the group 1190the C<poll_cb>). And in the callbacks of those requests, you can add
1031itself finish. 1191further requests to the group. And only when all those requests have
1192finished will the the group itself finish.
1032 1193
1033=over 4 1194=over 4
1034 1195
1035=item add $grp ... 1196=item add $grp ...
1036 1197
… …
1045=item $grp->cancel_subs 1206=item $grp->cancel_subs
1046 1207
1047Cancel all subrequests and clears any feeder, but not the group request 1208Cancel all subrequests and clears any feeder, but not the group request
1048itself. Useful when you queued a lot of events but got a result early. 1209itself. Useful when you queued a lot of events but got a result early.
1049 1210
1211The group request will finish normally (you cannot add requests to the
1212group).
1213
1050=item $grp->result (...) 1214=item $grp->result (...)
1051 1215
1052Set the result value(s) that will be passed to the group callback when all 1216Set the result value(s) that will be passed to the group callback when all
1053subrequests have finished and set thre groups errno to the current value 1217subrequests have finished and set the groups errno to the current value
1054of errno (just like calling C<errno> without an error number). By default, 1218of errno (just like calling C<errno> without an error number). By default,
1055no argument will be passed and errno is zero. 1219no argument will be passed and errno is zero.
1056 1220
1057=item $grp->errno ([$errno]) 1221=item $grp->errno ([$errno])
1058 1222
… …
1069=item feed $grp $callback->($grp) 1233=item feed $grp $callback->($grp)
1070 1234
1071Sets a feeder/generator on this group: every group can have an attached 1235Sets a feeder/generator on this group: every group can have an attached
1072generator that generates requests if idle. The idea behind this is that, 1236generator that generates requests if idle. The idea behind this is that,
1073although you could just queue as many requests as you want in a group, 1237although you could just queue as many requests as you want in a group,
1074this might starve other requests for a potentially long time. For 1238this might starve other requests for a potentially long time. For example,
1075example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1239C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1076requests, delaying any later requests for a long time. 1240delaying any later requests for a long time.
1077 1241
1078To avoid this, and allow incremental generation of requests, you can 1242To avoid this, and allow incremental generation of requests, you can
1079instead a group and set a feeder on it that generates those requests. The 1243instead a group and set a feeder on it that generates those requests. The
1080feed callback will be called whenever there are few enough (see C<limit>, 1244feed callback will be called whenever there are few enough (see C<limit>,
1081below) requests active in the group itself and is expected to queue more 1245below) requests active in the group itself and is expected to queue more
… …
1085not impose any limits). 1249not impose any limits).
1086 1250
1087If the feed does not queue more requests when called, it will be 1251If the feed does not queue more requests when called, it will be
1088automatically removed from the group. 1252automatically removed from the group.
1089 1253
1090If the feed limit is C<0>, it will be set to C<2> automatically. 1254If the feed limit is C<0> when this method is called, it will be set to
1255C<2> automatically.
1091 1256
1092Example: 1257Example:
1093 1258
1094 # stat all files in @files, but only ever use four aio requests concurrently: 1259 # stat all files in @files, but only ever use four aio requests concurrently:
1095 1260
… …
1107Sets the feeder limit for the group: The feeder will be called whenever 1272Sets the feeder limit for the group: The feeder will be called whenever
1108the group contains less than this many requests. 1273the group contains less than this many requests.
1109 1274
1110Setting the limit to C<0> will pause the feeding process. 1275Setting the limit to C<0> will pause the feeding process.
1111 1276
1277The default value for the limit is C<0>, but note that setting a feeder
1278automatically bumps it up to C<2>.
1279
1112=back 1280=back
1113 1281
1114=head2 SUPPORT FUNCTIONS 1282=head2 SUPPORT FUNCTIONS
1115 1283
1116=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1284=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
… …
1118=over 4 1286=over 4
1119 1287
1120=item $fileno = IO::AIO::poll_fileno 1288=item $fileno = IO::AIO::poll_fileno
1121 1289
1122Return the I<request result pipe file descriptor>. This filehandle must be 1290Return the I<request result pipe file descriptor>. This filehandle must be
1123polled for reading by some mechanism outside this module (e.g. Event or 1291polled for reading by some mechanism outside this module (e.g. EV, Glib,
1124select, see below or the SYNOPSIS). If the pipe becomes readable you have 1292select and so on, see below or the SYNOPSIS). If the pipe becomes readable
1125to call C<poll_cb> to check the results. 1293you have to call C<poll_cb> to check the results.
1126 1294
1127See C<poll_cb> for an example. 1295See C<poll_cb> for an example.
1128 1296
1129=item IO::AIO::poll_cb 1297=item IO::AIO::poll_cb
1130 1298
1131Process some outstanding events on the result pipe. You have to call this 1299Process some outstanding events on the result pipe. You have to call this
1132regularly. Returns the number of events processed. Returns immediately 1300regularly. Returns C<0> if all events could be processed, or C<-1> if it
1301returned earlier for whatever reason. Returns immediately when no events
1133when no events are outstanding. The amount of events processed depends on 1302are outstanding. The amount of events processed depends on the settings of
1134the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. 1303C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1135 1304
1136If not all requests were processed for whatever reason, the filehandle 1305If not all requests were processed for whatever reason, the filehandle
1137will still be ready when C<poll_cb> returns. 1306will still be ready when C<poll_cb> returns, so normally you don't have to
1307do anything special to have it called later.
1138 1308
1139Example: Install an Event watcher that automatically calls 1309Example: Install an Event watcher that automatically calls
1140IO::AIO::poll_cb with high priority: 1310IO::AIO::poll_cb with high priority (more examples can be found in the
1311SYNOPSIS section, at the top of this document):
1141 1312
1142 Event->io (fd => IO::AIO::poll_fileno, 1313 Event->io (fd => IO::AIO::poll_fileno,
1143 poll => 'r', async => 1, 1314 poll => 'r', async => 1,
1144 cb => \&IO::AIO::poll_cb); 1315 cb => \&IO::AIO::poll_cb);
1145 1316
… …
1256 1427
1257The default is probably ok in most situations, especially if thread 1428The default is probably ok in most situations, especially if thread
1258creation is fast. If thread creation is very slow on your system you might 1429creation is fast. If thread creation is very slow on your system you might
1259want to use larger values. 1430want to use larger values.
1260 1431
1261=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1432=item IO::AIO::max_outstanding $maxreqs
1262 1433
1263This is a very bad function to use in interactive programs because it 1434This is a very bad function to use in interactive programs because it
1264blocks, and a bad way to reduce concurrency because it is inexact: Better 1435blocks, and a bad way to reduce concurrency because it is inexact: Better
1265use an C<aio_group> together with a feed callback. 1436use an C<aio_group> together with a feed callback.
1266 1437
… …
1271 1442
1272The default value is very large, so there is no practical limit on the 1443The default value is very large, so there is no practical limit on the
1273number of outstanding requests. 1444number of outstanding requests.
1274 1445
1275You can still queue as many requests as you want. Therefore, 1446You can still queue as many requests as you want. Therefore,
1276C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1447C<max_outstanding> is mainly useful in simple scripts (with low values) or
1277as a stop gap to shield against fatal memory overflow (with large values). 1448as a stop gap to shield against fatal memory overflow (with large values).
1278 1449
1279=back 1450=back
1280 1451
1281=head3 STATISTICAL INFORMATION 1452=head3 STATISTICAL INFORMATION
… …
1299 1470
1300=item IO::AIO::npending 1471=item IO::AIO::npending
1301 1472
1302Returns the number of requests currently in the pending state (executed, 1473Returns the number of requests currently in the pending state (executed,
1303but not yet processed by poll_cb). 1474but not yet processed by poll_cb).
1475
1476=back
1477
1478=head3 MISCELLANEOUS FUNCTIONS
1479
1480IO::AIO implements some functions that might be useful, but are not
1481asynchronous.
1482
1483=over 4
1484
1485=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1486
1487Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
1488but is blocking (this makes most sense if you know the input data is
1489likely cached already and the output filehandle is set to non-blocking
1490operations).
1491
1492Returns the number of bytes copied, or C<-1> on error.
1493
1494=item IO::AIO::fadvise $fh, $offset, $len, $advice
1495
1496Simply calls the C<posix_fadvise> function (see it's
1497manpage for details). The following advice constants are
1498avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1499C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1500C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1501
1502On systems that do not implement C<posix_fadvise>, this function returns
1503ENOSYS, otherwise the return value of C<posix_fadvise>.
1304 1504
1305=back 1505=back
1306 1506
1307=cut 1507=cut
1308 1508
… …
1351 1551
1352Known bugs will be fixed in the next release. 1552Known bugs will be fixed in the next release.
1353 1553
1354=head1 SEE ALSO 1554=head1 SEE ALSO
1355 1555
1356L<Coro::AIO>. 1556L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1557more natural syntax.
1357 1558
1358=head1 AUTHOR 1559=head1 AUTHOR
1359 1560
1360 Marc Lehmann <schmorp@schmorp.de> 1561 Marc Lehmann <schmorp@schmorp.de>
1361 http://home.schmorp.de/ 1562 http://home.schmorp.de/

Diff Legend

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