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.219 by root, Tue Mar 27 18:54:45 2012 UTC vs.
Revision 1.287 by root, Tue Jul 24 04:58:59 2018 UTC

1=head1 NAME 1=head1 NAME
2 2
3IO::AIO - Asynchronous Input/Output 3IO::AIO - Asynchronous/Advanced Input/Output
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use IO::AIO; 7 use IO::AIO;
8 8
58not well-supported or restricted (GNU/Linux doesn't allow them on normal 58not well-supported or restricted (GNU/Linux doesn't allow them on normal
59files currently, for example), and they would only support aio_read and 59files currently, for example), and they would only support aio_read and
60aio_write, so the remaining functionality would have to be implemented 60aio_write, so the remaining functionality would have to be implemented
61using threads anyway. 61using threads anyway.
62 62
63In addition to asynchronous I/O, this module also exports some rather
64arcane interfaces, such as C<madvise> or linux's C<splice> system call,
65which is why the C<A> in C<AIO> can also mean I<advanced>.
66
63Although the module will work in the presence of other (Perl-) threads, 67Although the module will work in the presence of other (Perl-) threads,
64it is currently not reentrant in any way, so use appropriate locking 68it is currently not reentrant in any way, so use appropriate locking
65yourself, always call C<poll_cb> from within the same thread, or never 69yourself, always call C<poll_cb> from within the same thread, or never
66call C<poll_cb> (or other C<aio_> functions) recursively. 70call C<poll_cb> (or other C<aio_> functions) recursively.
67 71
68=head2 EXAMPLE 72=head2 EXAMPLE
69 73
70This is a simple example that uses the EV module and loads 74This is a simple example that uses the EV module and loads
71F</etc/passwd> asynchronously: 75F</etc/passwd> asynchronously:
72 76
73 use Fcntl;
74 use EV; 77 use EV;
75 use IO::AIO; 78 use IO::AIO;
76 79
77 # register the IO::AIO callback with EV 80 # register the IO::AIO callback with EV
78 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; 81 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
95 98
96 # file contents now in $contents 99 # file contents now in $contents
97 print $contents; 100 print $contents;
98 101
99 # exit event loop and program 102 # exit event loop and program
100 EV::unloop; 103 EV::break;
101 }; 104 };
102 }; 105 };
103 106
104 # possibly queue up other requests, or open GUI windows, 107 # possibly queue up other requests, or open GUI windows,
105 # check for sockets etc. etc. 108 # check for sockets etc. etc.
106 109
107 # process events as long as there are some: 110 # process events as long as there are some:
108 EV::loop; 111 EV::run;
109 112
110=head1 REQUEST ANATOMY AND LIFETIME 113=head1 REQUEST ANATOMY AND LIFETIME
111 114
112Every C<aio_*> function creates a request. which is a C data structure not 115Every C<aio_*> function creates a request. which is a C data structure not
113directly visible to Perl. 116directly visible to Perl.
168use common::sense; 171use common::sense;
169 172
170use base 'Exporter'; 173use base 'Exporter';
171 174
172BEGIN { 175BEGIN {
173 our $VERSION = '4.12'; 176 our $VERSION = 4.42;
174 177
175 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close 178 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx 179 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
177 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync 180 aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
178 aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate 181 aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
179 aio_pathsync aio_readahead 182 aio_pathsync aio_readahead aio_fiemap aio_allocate
180 aio_rename aio_link aio_move aio_copy aio_group 183 aio_rename aio_rename2 aio_link aio_move aio_copy aio_group
181 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 184 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
182 aio_chmod aio_utime aio_truncate 185 aio_chmod aio_utime aio_truncate
183 aio_msync aio_mtouch aio_mlock aio_mlockall 186 aio_msync aio_mtouch aio_mlock aio_mlockall
184 aio_statvfs 187 aio_statvfs
188 aio_slurp
185 aio_wd); 189 aio_wd);
186 190
187 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 191 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
188 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 192 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
189 min_parallel max_parallel max_idle idle_timeout 193 min_parallel max_parallel max_idle idle_timeout
190 nreqs nready npending nthreads 194 nreqs nready npending nthreads
191 max_poll_time max_poll_reqs 195 max_poll_time max_poll_reqs
192 sendfile fadvise madvise 196 sendfile fadvise madvise
193 mmap munmap munlock munlockall); 197 mmap munmap mremap munlock munlockall);
194 198
195 push @AIO_REQ, qw(aio_busy); # not exported 199 push @AIO_REQ, qw(aio_busy); # not exported
196 200
197 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 201 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
198 202
202 206
203=head1 FUNCTIONS 207=head1 FUNCTIONS
204 208
205=head2 QUICK OVERVIEW 209=head2 QUICK OVERVIEW
206 210
207This section simply lists the prototypes of the most important functions 211This section simply lists the prototypes most of the functions for
208for quick reference. See the following sections for function-by-function 212quick reference. See the following sections for function-by-function
209documentation. 213documentation.
210 214
211 aio_wd $pathname, $callback->($wd) 215 aio_wd $pathname, $callback->($wd)
212 aio_open $pathname, $flags, $mode, $callback->($fh) 216 aio_open $pathname, $flags, $mode, $callback->($fh)
213 aio_close $fh, $callback->($status) 217 aio_close $fh, $callback->($status)
218 aio_seek $fh,$offset,$whence, $callback->($offs)
214 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 219 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
215 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 220 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
216 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 221 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
217 aio_readahead $fh,$offset,$length, $callback->($retval) 222 aio_readahead $fh,$offset,$length, $callback->($retval)
218 aio_stat $fh_or_path, $callback->($status) 223 aio_stat $fh_or_path, $callback->($status)
219 aio_lstat $fh, $callback->($status) 224 aio_lstat $fh, $callback->($status)
220 aio_statvfs $fh_or_path, $callback->($statvfs) 225 aio_statvfs $fh_or_path, $callback->($statvfs)
221 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 226 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
222 aio_chown $fh_or_path, $uid, $gid, $callback->($status) 227 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
228 aio_chmod $fh_or_path, $mode, $callback->($status)
223 aio_truncate $fh_or_path, $offset, $callback->($status) 229 aio_truncate $fh_or_path, $offset, $callback->($status)
224 aio_chmod $fh_or_path, $mode, $callback->($status) 230 aio_allocate $fh, $mode, $offset, $len, $callback->($status)
231 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
225 aio_unlink $pathname, $callback->($status) 232 aio_unlink $pathname, $callback->($status)
226 aio_mknod $pathname, $mode, $dev, $callback->($status) 233 aio_mknod $pathname, $mode, $dev, $callback->($status)
227 aio_link $srcpath, $dstpath, $callback->($status) 234 aio_link $srcpath, $dstpath, $callback->($status)
228 aio_symlink $srcpath, $dstpath, $callback->($status) 235 aio_symlink $srcpath, $dstpath, $callback->($status)
229 aio_readlink $pathname, $callback->($link) 236 aio_readlink $pathname, $callback->($link)
230 aio_realpath $pathname, $callback->($link) 237 aio_realpath $pathname, $callback->($path)
231 aio_rename $srcpath, $dstpath, $callback->($status) 238 aio_rename $srcpath, $dstpath, $callback->($status)
239 aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
232 aio_mkdir $pathname, $mode, $callback->($status) 240 aio_mkdir $pathname, $mode, $callback->($status)
233 aio_rmdir $pathname, $callback->($status) 241 aio_rmdir $pathname, $callback->($status)
234 aio_readdir $pathname, $callback->($entries) 242 aio_readdir $pathname, $callback->($entries)
235 aio_readdirx $pathname, $flags, $callback->($entries, $flags) 243 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
236 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST 244 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
238 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) 246 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
239 aio_load $pathname, $data, $callback->($status) 247 aio_load $pathname, $data, $callback->($status)
240 aio_copy $srcpath, $dstpath, $callback->($status) 248 aio_copy $srcpath, $dstpath, $callback->($status)
241 aio_move $srcpath, $dstpath, $callback->($status) 249 aio_move $srcpath, $dstpath, $callback->($status)
242 aio_rmtree $pathname, $callback->($status) 250 aio_rmtree $pathname, $callback->($status)
251 aio_fcntl $fh, $cmd, $arg, $callback->($status)
252 aio_ioctl $fh, $request, $buf, $callback->($status)
243 aio_sync $callback->($status) 253 aio_sync $callback->($status)
244 aio_syncfs $fh, $callback->($status) 254 aio_syncfs $fh, $callback->($status)
245 aio_fsync $fh, $callback->($status) 255 aio_fsync $fh, $callback->($status)
246 aio_fdatasync $fh, $callback->($status) 256 aio_fdatasync $fh, $callback->($status)
247 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 257 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
248 aio_pathsync $pathname, $callback->($status) 258 aio_pathsync $pathname, $callback->($status)
249 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 259 aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
250 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 260 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
251 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 261 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
252 aio_mlockall $flags, $callback->($status) 262 aio_mlockall $flags, $callback->($status)
253 aio_group $callback->(...) 263 aio_group $callback->(...)
254 aio_nop $callback->() 264 aio_nop $callback->()
268 IO::AIO::idle_timeout $seconds 278 IO::AIO::idle_timeout $seconds
269 IO::AIO::max_outstanding $maxreqs 279 IO::AIO::max_outstanding $maxreqs
270 IO::AIO::nreqs 280 IO::AIO::nreqs
271 IO::AIO::nready 281 IO::AIO::nready
272 IO::AIO::npending 282 IO::AIO::npending
283 $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL]
284 IO::AIO::min_fdlimit $nfd [EXPERIMENTAL]
273 285
274 IO::AIO::sendfile $ofh, $ifh, $offset, $count 286 IO::AIO::sendfile $ofh, $ifh, $offset, $count
275 IO::AIO::fadvise $fh, $offset, $len, $advice 287 IO::AIO::fadvise $fh, $offset, $len, $advice
288 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
289 IO::AIO::munmap $scalar
290 IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]
276 IO::AIO::madvise $scalar, $offset, $length, $advice 291 IO::AIO::madvise $scalar, $offset, $length, $advice
277 IO::AIO::mprotect $scalar, $offset, $length, $protect 292 IO::AIO::mprotect $scalar, $offset, $length, $protect
278 IO::AIO::munlock $scalar, $offset = 0, $length = undef 293 IO::AIO::munlock $scalar, $offset = 0, $length = undef
279 IO::AIO::munlockall 294 IO::AIO::munlockall
280 295
357 372
358 373
359=item aio_open $pathname, $flags, $mode, $callback->($fh) 374=item aio_open $pathname, $flags, $mode, $callback->($fh)
360 375
361Asynchronously open or create a file and call the callback with a newly 376Asynchronously open or create a file and call the callback with a newly
362created filehandle for the file. 377created filehandle for the file (or C<undef> in case of an error).
363 378
364The pathname passed to C<aio_open> must be absolute. See API NOTES, above, 379The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
365for an explanation. 380for an explanation.
366 381
367The C<$flags> argument is a bitmask. See the C<Fcntl> module for a 382The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
390following POSIX and non-POSIX constants are available (missing ones on 405following POSIX and non-POSIX constants are available (missing ones on
391your system are, as usual, C<0>): 406your system are, as usual, C<0>):
392 407
393C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, 408C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
394C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, 409C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
395C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>. 410C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>.
396 411
397 412
398=item aio_close $fh, $callback->($status) 413=item aio_close $fh, $callback->($status)
399 414
400Asynchronously close a file and call the callback with the result 415Asynchronously close a file and call the callback with the result
410Or in other words: the file descriptor will be closed, but it will not be 425Or in other words: the file descriptor will be closed, but it will not be
411free for reuse until the perl filehandle is closed. 426free for reuse until the perl filehandle is closed.
412 427
413=cut 428=cut
414 429
430=item aio_seek $fh, $offset, $whence, $callback->($offs)
431
432Seeks the filehandle to the new C<$offset>, similarly to perl's
433C<sysseek>. The C<$whence> can use the traditional values (C<0> for
434C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
435C<IO::AIO::SEEK_END>).
436
437The resulting absolute offset will be passed to the callback, or C<-1> in
438case of an error.
439
440In theory, the C<$whence> constants could be different than the
441corresponding values from L<Fcntl>, but perl guarantees they are the same,
442so don't panic.
443
444As a GNU/Linux (and maybe Solaris) extension, also the constants
445C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
446could be found. No guarantees about suitability for use in C<aio_seek> or
447Perl's C<sysseek> can be made though, although I would naively assume they
448"just work".
449
415=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 450=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
416 451
417=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 452=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
418 453
419Reads or writes C<$length> bytes from or to the specified C<$fh> and 454Reads or writes C<$length> bytes from or to the specified C<$fh> and
420C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> 455C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and
421and calls the callback without the actual number of bytes read (or -1 on 456calls the callback with the actual number of bytes transferred (or -1 on
422error, just like the syscall). 457error, just like the syscall).
423 458
424C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to 459C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
425offset plus the actual number of bytes read. 460offset plus the actual number of bytes read.
426 461
484As native sendfile syscalls (as practically any non-POSIX interface hacked 519As native sendfile syscalls (as practically any non-POSIX interface hacked
485together in a hurry to improve benchmark numbers) tend to be rather buggy 520together in a hurry to improve benchmark numbers) tend to be rather buggy
486on many systems, this implementation tries to work around some known bugs 521on many systems, this implementation tries to work around some known bugs
487in Linux and FreeBSD kernels (probably others, too), but that might fail, 522in Linux and FreeBSD kernels (probably others, too), but that might fail,
488so you really really should check the return value of C<aio_sendfile> - 523so you really really should check the return value of C<aio_sendfile> -
489fewre bytes than expected might have been transferred. 524fewer bytes than expected might have been transferred.
490 525
491 526
492=item aio_readahead $fh,$offset,$length, $callback->($retval) 527=item aio_readahead $fh,$offset,$length, $callback->($retval)
493 528
494C<aio_readahead> populates the page cache with data from a file so that 529C<aio_readahead> populates the page cache with data from a file so that
498whole pages, so that offset is effectively rounded down to a page boundary 533whole pages, so that offset is effectively rounded down to a page boundary
499and bytes are read up to the next page boundary greater than or equal to 534and bytes are read up to the next page boundary greater than or equal to
500(off-set+length). C<aio_readahead> does not read beyond the end of the 535(off-set+length). C<aio_readahead> does not read beyond the end of the
501file. The current file offset of the file is left unchanged. 536file. The current file offset of the file is left unchanged.
502 537
503If that syscall doesn't exist (likely if your OS isn't Linux) it will be 538If that syscall doesn't exist (likely if your kernel isn't Linux) it will
504emulated by simply reading the data, which would have a similar effect. 539be emulated by simply reading the data, which would have a similar effect.
505 540
506 541
507=item aio_stat $fh_or_path, $callback->($status) 542=item aio_stat $fh_or_path, $callback->($status)
508 543
509=item aio_lstat $fh, $callback->($status) 544=item aio_lstat $fh, $callback->($status)
578 namemax => 255, 613 namemax => 255,
579 frsize => 1024, 614 frsize => 1024,
580 fsid => 1810 615 fsid => 1810
581 } 616 }
582 617
583
584=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 618=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
585 619
586Works like perl's C<utime> function (including the special case of $atime 620Works like perl's C<utime> function (including the special case of $atime
587and $mtime being undef). Fractional times are supported if the underlying 621and $mtime being undef). Fractional times are supported if the underlying
588syscalls support them. 622syscalls support them.
615=item aio_truncate $fh_or_path, $offset, $callback->($status) 649=item aio_truncate $fh_or_path, $offset, $callback->($status)
616 650
617Works like truncate(2) or ftruncate(2). 651Works like truncate(2) or ftruncate(2).
618 652
619 653
654=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
655
656Allocates or frees disk space according to the C<$mode> argument. See the
657linux C<fallocate> documentation for details.
658
659C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
660space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>,
661to deallocate a file range.
662
663IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
664(without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range,
665C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE>
666to unshare shared blocks (see your L<fallocate(2)> manpage).
667
668The file system block size used by C<fallocate> is presumably the
669C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes
670can dictate other limitations.
671
672If C<fallocate> isn't available or cannot be emulated (currently no
673emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
674
675
620=item aio_chmod $fh_or_path, $mode, $callback->($status) 676=item aio_chmod $fh_or_path, $mode, $callback->($status)
621 677
622Works like perl's C<chmod> function. 678Works like perl's C<chmod> function.
623 679
624 680
661 717
662 718
663=item aio_realpath $pathname, $callback->($path) 719=item aio_realpath $pathname, $callback->($path)
664 720
665Asynchronously make the path absolute and resolve any symlinks in 721Asynchronously make the path absolute and resolve any symlinks in
666C<$path>. The resulting path only consists of directories (Same as 722C<$path>. The resulting path only consists of directories (same as
667L<Cwd::realpath>). 723L<Cwd::realpath>).
668 724
669This request can be used to get the absolute path of the current working 725This request can be used to get the absolute path of the current working
670directory by passing it a path of F<.> (a single dot). 726directory by passing it a path of F<.> (a single dot).
671 727
672 728
673=item aio_rename $srcpath, $dstpath, $callback->($status) 729=item aio_rename $srcpath, $dstpath, $callback->($status)
674 730
675Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 731Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
676rename(2) and call the callback with the result code. 732rename(2) and call the callback with the result code.
733
734On systems that support the AIO::WD working directory abstraction
735natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
736of failing, C<rename> is called on the absolute path of C<$wd>.
737
738
739=item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
740
741Basically a version of C<aio_rename> with an additional C<$flags>
742argument. Calling this with C<$flags=0> is the same as calling
743C<aio_rename>.
744
745Non-zero flags are currently only supported on GNU/Linux systems that
746support renameat2. Other systems fail with C<ENOSYS> in this case.
747
748The following constants are available (missing ones are, as usual C<0>),
749see renameat2(2) for details:
750
751C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE>
752and C<IO::AIO::RENAME_WHITEOUT>.
677 753
678 754
679=item aio_mkdir $pathname, $mode, $callback->($status) 755=item aio_mkdir $pathname, $mode, $callback->($status)
680 756
681Asynchronously mkdir (create) a directory and call the callback with 757Asynchronously mkdir (create) a directory and call the callback with
686=item aio_rmdir $pathname, $callback->($status) 762=item aio_rmdir $pathname, $callback->($status)
687 763
688Asynchronously rmdir (delete) a directory and call the callback with the 764Asynchronously rmdir (delete) a directory and call the callback with the
689result code. 765result code.
690 766
767On systems that support the AIO::WD working directory abstraction
768natively, the case C<[$wd, "."]> is specialcased - instead of failing,
769C<rmdir> is called on the absolute path of C<$wd>.
770
691 771
692=item aio_readdir $pathname, $callback->($entries) 772=item aio_readdir $pathname, $callback->($entries)
693 773
694Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 774Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
695directory (i.e. opendir + readdir + closedir). The entries will not be 775directory (i.e. opendir + readdir + closedir). The entries will not be
710 790
711=over 4 791=over 4
712 792
713=item IO::AIO::READDIR_DENTS 793=item IO::AIO::READDIR_DENTS
714 794
715When this flag is off, then the callback gets an arrayref consisting of 795Normally the callback gets an arrayref consisting of names only (as
716names only (as with C<aio_readdir>), otherwise it gets an arrayref with 796with C<aio_readdir>). If this flag is set, then the callback gets an
717C<[$name, $type, $inode]> arrayrefs, each describing a single directory 797arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a
718entry in more detail. 798single directory entry in more detail:
719 799
720C<$name> is the name of the entry. 800C<$name> is the name of the entry.
721 801
722C<$type> is one of the C<IO::AIO::DT_xxx> constants: 802C<$type> is one of the C<IO::AIO::DT_xxx> constants:
723 803
724C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, 804C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
725C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, 805C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
726C<IO::AIO::DT_WHT>. 806C<IO::AIO::DT_WHT>.
727 807
728C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to 808C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need
729know, you have to run stat yourself. Also, for speed reasons, the C<$type> 809to know, you have to run stat yourself. Also, for speed/memory reasons,
730scalars are read-only: you can not modify them. 810the C<$type> scalars are read-only: you must not modify them.
731 811
732C<$inode> is the inode number (which might not be exact on systems with 64 812C<$inode> is the inode number (which might not be exact on systems with 64
733bit inode numbers and 32 bit perls). This field has unspecified content on 813bit inode numbers and 32 bit perls). This field has unspecified content on
734systems that do not deliver the inode information. 814systems that do not deliver the inode information.
735 815
746short names are tried first. 826short names are tried first.
747 827
748=item IO::AIO::READDIR_STAT_ORDER 828=item IO::AIO::READDIR_STAT_ORDER
749 829
750When this flag is set, then the names will be returned in an order 830When this flag is set, then the names will be returned in an order
751suitable for stat()'ing each one. That is, when you plan to stat() 831suitable for stat()'ing each one. That is, when you plan to stat() most or
752all files in the given directory, then the returned order will likely 832all files in the given directory, then the returned order will likely be
753be fastest. 833faster.
754 834
755If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then 835If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified,
756the likely dirs come first, resulting in a less optimal stat order. 836then the likely dirs come first, resulting in a less optimal stat order
837for stat'ing all entries, but likely a more optimal order for finding
838subdirectories.
757 839
758=item IO::AIO::READDIR_FOUND_UNKNOWN 840=item IO::AIO::READDIR_FOUND_UNKNOWN
759 841
760This flag should not be set when calling C<aio_readdirx>. Instead, it 842This flag should not be set when calling C<aio_readdirx>. Instead, it
761is being set by C<aio_readdirx>, when any of the C<$type>'s found were 843is being set by C<aio_readdirx>, when any of the C<$type>'s found were
763C<$type>'s are known, which can be used to speed up some algorithms. 845C<$type>'s are known, which can be used to speed up some algorithms.
764 846
765=back 847=back
766 848
767 849
850=item aio_slurp $pathname, $offset, $length, $data, $callback->($status)
851
852Opens, reads and closes the given file. The data is put into C<$data>,
853which is resized as required.
854
855If C<$offset> is negative, then it is counted from the end of the file.
856
857If C<$length> is zero, then the remaining length of the file is
858used. Also, in this case, the same limitations to modifying C<$data> apply
859as when IO::AIO::mmap is used, i.e. it must only be modified in-place
860with C<substr>. If the size of the file is known, specifying a non-zero
861C<$length> results in a performance advantage.
862
863This request is similar to the older C<aio_load> request, but since it is
864a single request, it might be more efficient to use.
865
866Example: load F</etc/passwd> into C<$passwd>.
867
868 my $passwd;
869 aio_slurp "/etc/passwd", 0, 0, $passwd, sub {
870 $_[0] >= 0
871 or die "/etc/passwd: $!\n";
872
873 printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd;
874 print $passwd;
875 };
876 IO::AIO::flush;
877
878
768=item aio_load $pathname, $data, $callback->($status) 879=item aio_load $pathname, $data, $callback->($status)
769 880
770This is a composite request that tries to fully load the given file into 881This is a composite request that tries to fully load the given file into
771memory. Status is the same as with aio_read. 882memory. Status is the same as with aio_read.
883
884Using C<aio_slurp> might be more efficient, as it is a single request.
772 885
773=cut 886=cut
774 887
775sub aio_load($$;$) { 888sub aio_load($$;$) {
776 my ($path, undef, $cb) = @_; 889 my ($path, undef, $cb) = @_;
796=item aio_copy $srcpath, $dstpath, $callback->($status) 909=item aio_copy $srcpath, $dstpath, $callback->($status)
797 910
798Try to copy the I<file> (directories not supported as either source or 911Try to copy the I<file> (directories not supported as either source or
799destination) from C<$srcpath> to C<$dstpath> and call the callback with 912destination) from C<$srcpath> to C<$dstpath> and call the callback with
800a status of C<0> (ok) or C<-1> (error, see C<$!>). 913a status of C<0> (ok) or C<-1> (error, see C<$!>).
914
915Existing destination files will be truncated.
801 916
802This is a composite request that creates the destination file with 917This is a composite request that creates the destination file with
803mode 0200 and copies the contents of the source file into it using 918mode 0200 and copies the contents of the source file into it using
804C<aio_sendfile>, followed by restoring atime, mtime, access mode and 919C<aio_sendfile>, followed by restoring atime, mtime, access mode and
805uid/gid, in that order. 920uid/gid, in that order.
915Scans a directory (similar to C<aio_readdir>) but additionally tries to 1030Scans a directory (similar to C<aio_readdir>) but additionally tries to
916efficiently separate the entries of directory C<$path> into two sets of 1031efficiently separate the entries of directory C<$path> into two sets of
917names, directories you can recurse into (directories), and ones you cannot 1032names, directories you can recurse into (directories), and ones you cannot
918recurse into (everything else, including symlinks to directories). 1033recurse into (everything else, including symlinks to directories).
919 1034
920C<aio_scandir> is a composite request that creates of many sub requests_ 1035C<aio_scandir> is a composite request that generates many sub requests.
921C<$maxreq> specifies the maximum number of outstanding aio requests that 1036C<$maxreq> specifies the maximum number of outstanding aio requests that
922this function generates. If it is C<< <= 0 >>, then a suitable default 1037this function generates. If it is C<< <= 0 >>, then a suitable default
923will be chosen (currently 4). 1038will be chosen (currently 4).
924 1039
925On error, the callback is called without arguments, otherwise it receives 1040On error, the callback is called without arguments, otherwise it receives
1059} 1174}
1060 1175
1061=item aio_rmtree $pathname, $callback->($status) 1176=item aio_rmtree $pathname, $callback->($status)
1062 1177
1063Delete a directory tree starting (and including) C<$path>, return the 1178Delete a directory tree starting (and including) C<$path>, return the
1064status of the final C<rmdir> only. This is a composite request that 1179status of the final C<rmdir> only. This is a composite request that
1065uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1180uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1066everything else. 1181everything else.
1067 1182
1068=cut 1183=cut
1069 1184
1090 add $grp $dirgrp; 1205 add $grp $dirgrp;
1091 }; 1206 };
1092 1207
1093 $grp 1208 $grp
1094} 1209}
1210
1211=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
1212
1213=item aio_ioctl $fh, $request, $buf, $callback->($status)
1214
1215These work just like the C<fcntl> and C<ioctl> built-in functions, except
1216they execute asynchronously and pass the return value to the callback.
1217
1218Both calls can be used for a lot of things, some of which make more sense
1219to run asynchronously in their own thread, while some others make less
1220sense. For example, calls that block waiting for external events, such
1221as locking, will also lock down an I/O thread while it is waiting, which
1222can deadlock the whole I/O system. At the same time, there might be no
1223alternative to using a thread to wait.
1224
1225So in general, you should only use these calls for things that do
1226(filesystem) I/O, not for things that wait for other events (network,
1227other processes), although if you are careful and know what you are doing,
1228you still can.
1229
1230The following constants are available (missing ones are, as usual C<0>):
1231
1232C<F_DUPFD_CLOEXEC>,
1233
1234C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
1235
1236C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
1237
1238C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
1239C<FS_IOC_FIEMAP>.
1240
1241C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
1242C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
1243
1244C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
1245C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
1246C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
1247C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
1248C<FS_FL_USER_MODIFIABLE>.
1249
1250C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
1251C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
1252C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
1253C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
1095 1254
1096=item aio_sync $callback->($status) 1255=item aio_sync $callback->($status)
1097 1256
1098Asynchronously call sync and call the callback when finished. 1257Asynchronously call sync and call the callback when finished.
1099 1258
1168 }; 1327 };
1169 1328
1170 $grp 1329 $grp
1171} 1330}
1172 1331
1173=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 1332=item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
1174 1333
1175This is a rather advanced IO::AIO call, which only works on mmap(2)ed 1334This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1176scalars (see the C<IO::AIO::mmap> function, although it also works on data 1335scalars (see the C<IO::AIO::mmap> function, although it also works on data
1177scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the 1336scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1178scalar must only be modified in-place while an aio operation is pending on 1337scalar must only be modified in-place while an aio operation is pending on
1180 1339
1181It calls the C<msync> function of your OS, if available, with the memory 1340It calls the C<msync> function of your OS, if available, with the memory
1182area starting at C<$offset> in the string and ending C<$length> bytes 1341area starting at C<$offset> in the string and ending C<$length> bytes
1183later. If C<$length> is negative, counts from the end, and if C<$length> 1342later. If C<$length> is negative, counts from the end, and if C<$length>
1184is C<undef>, then it goes till the end of the string. The flags can be 1343is C<undef>, then it goes till the end of the string. The flags can be
1185a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and 1344either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional
1186C<IO::AIO::MS_SYNC>. 1345C<IO::AIO::MS_INVALIDATE>.
1187 1346
1188=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 1347=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1189 1348
1190This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1349This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1191scalars. 1350scalars.
1192 1351
1193It touches (reads or writes) all memory pages in the specified 1352It touches (reads or writes) all memory pages in the specified
1194range inside the scalar. All caveats and parameters are the same 1353range inside the scalar. All caveats and parameters are the same
1195as for C<aio_msync>, above, except for flags, which must be either 1354as for C<aio_msync>, above, except for flags, which must be either
1196C<0> (which reads all pages and ensures they are instantiated) or 1355C<0> (which reads all pages and ensures they are instantiated) or
1197C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and 1356C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1198writing an octet from it, which dirties the page). 1357writing an octet from it, which dirties the page).
1199 1358
1200=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 1359=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1201 1360
1202This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1361This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1233documented under L<MISCELLANEOUS FUNCTIONS>. 1392documented under L<MISCELLANEOUS FUNCTIONS>.
1234 1393
1235Example: asynchronously lock all current and future pages into memory. 1394Example: asynchronously lock all current and future pages into memory.
1236 1395
1237 aio_mlockall IO::AIO::MCL_FUTURE; 1396 aio_mlockall IO::AIO::MCL_FUTURE;
1397
1398=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1399
1400Queries the extents of the given file (by calling the Linux C<FIEMAP>
1401ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1402the ioctl is not available on your OS, then this request will fail with
1403C<ENOSYS>.
1404
1405C<$start> is the starting offset to query extents for, C<$length> is the
1406size of the range to query - if it is C<undef>, then the whole file will
1407be queried.
1408
1409C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
1410C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1411exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1412the data portion.
1413
1414C<$count> is the maximum number of extent records to return. If it is
1415C<undef>, then IO::AIO queries all extents of the range. As a very special
1416case, if it is C<0>, then the callback receives the number of extents
1417instead of the extents themselves (which is unreliable, see below).
1418
1419If an error occurs, the callback receives no arguments. The special
1420C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1421
1422Otherwise, the callback receives an array reference with extent
1423structures. Each extent structure is an array reference itself, with the
1424following members:
1425
1426 [$logical, $physical, $length, $flags]
1427
1428Flags is any combination of the following flag values (typically either C<0>
1429or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1430
1431C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1432C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1433C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1434C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1435C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1436C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1437
1438At the time of this writing (Linux 3.2), this request is unreliable unless
1439C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1440it to return all extents of a range for files with a large number of
1441extents. The code (only) works around all these issues if C<$count> is
1442C<undef>.
1238 1443
1239=item aio_group $callback->(...) 1444=item aio_group $callback->(...)
1240 1445
1241This is a very special aio request: Instead of doing something, it is a 1446This is a very special aio request: Instead of doing something, it is a
1242container for other aio requests, which is useful if you want to bundle 1447container for other aio requests, which is useful if you want to bundle
1326 aio_stat [$etcdir, "passwd"], sub { 1531 aio_stat [$etcdir, "passwd"], sub {
1327 # yay 1532 # yay
1328 }; 1533 };
1329 }; 1534 };
1330 1535
1331That C<aio_wd> is a request and not a normal function shows that creating 1536The fact that C<aio_wd> is a request and not a normal function shows that
1332an IO::AIO::WD object is itself a potentially blocking operation, which is 1537creating an IO::AIO::WD object is itself a potentially blocking operation,
1333why it is done asynchronously. 1538which is why it is done asynchronously.
1334 1539
1335To stat the directory obtained with C<aio_wd> above, one could write 1540To stat the directory obtained with C<aio_wd> above, one could write
1336either of the following three request calls: 1541either of the following three request calls:
1337 1542
1338 aio_lstat "/etc" , sub { ... # pathname as normal string 1543 aio_lstat "/etc" , sub { ... # pathname as normal string
1355There are some caveats: when directories get renamed (or deleted), the 1560There are some caveats: when directories get renamed (or deleted), the
1356pathname string doesn't change, so will point to the new directory (or 1561pathname string doesn't change, so will point to the new directory (or
1357nowhere at all), while the directory fd, if available on the system, 1562nowhere at all), while the directory fd, if available on the system,
1358will still point to the original directory. Most functions accepting a 1563will still point to the original directory. Most functions accepting a
1359pathname will use the directory fd on newer systems, and the string on 1564pathname will use the directory fd on newer systems, and the string on
1360older systems. Some functions (such as realpath) will always rely on the 1565older systems. Some functions (such as C<aio_realpath>) will always rely on
1361string form of the pathname. 1566the string form of the pathname.
1362 1567
1363So this fucntionality is mainly useful to get some protection against 1568So this functionality is mainly useful to get some protection against
1364C<chdir>, to easily get an absolute path out of a relative path for future 1569C<chdir>, to easily get an absolute path out of a relative path for future
1365reference, and to speed up doing many operations in the same directory 1570reference, and to speed up doing many operations in the same directory
1366(e.g. when stat'ing all files in a directory). 1571(e.g. when stat'ing all files in a directory).
1367 1572
1368The following functions implement this working directory abstraction: 1573The following functions implement this working directory abstraction:
1381passing C<undef> as working directory component of a pathname fails the 1586passing C<undef> as working directory component of a pathname fails the
1382request with C<ENOENT>, there is often no need for error checking in the 1587request with C<ENOENT>, there is often no need for error checking in the
1383C<aio_wd> callback, as future requests using the value will fail in the 1588C<aio_wd> callback, as future requests using the value will fail in the
1384expected way. 1589expected way.
1385 1590
1386If this call isn't available because your OS lacks it or it couldn't be
1387detected, it will be emulated by calling C<fsync> instead.
1388
1389=item IO::AIO::CWD 1591=item IO::AIO::CWD
1390 1592
1391This is a compiletime constant (object) that represents the process 1593This is a compiletime constant (object) that represents the process
1392current working directory. 1594current working directory.
1393 1595
1394Specifying this object as working directory object for a pathname is as 1596Specifying this object as working directory object for a pathname is as if
1395if the pathname would be specified directly, without a directory object, 1597the pathname would be specified directly, without a directory object. For
1396e.g., these calls are functionally identical: 1598example, these calls are functionally identical:
1397 1599
1398 aio_stat "somefile", sub { ... }; 1600 aio_stat "somefile", sub { ... };
1399 aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; 1601 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1400 1602
1401=back 1603=back
1402 1604
1605To recover the path associated with an IO::AIO::WD object, you can use
1606C<aio_realpath>:
1607
1608 aio_realpath $wd, sub {
1609 warn "path is $_[0]\n";
1610 };
1611
1612Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
1613sometimes, fall back to using an absolue path.
1403 1614
1404=head2 IO::AIO::REQ CLASS 1615=head2 IO::AIO::REQ CLASS
1405 1616
1406All non-aggregate C<aio_*> functions return an object of this class when 1617All non-aggregate C<aio_*> functions return an object of this class when
1407called in non-void context. 1618called in non-void context.
1585 1796
1586See C<poll_cb> for an example. 1797See C<poll_cb> for an example.
1587 1798
1588=item IO::AIO::poll_cb 1799=item IO::AIO::poll_cb
1589 1800
1590Process some outstanding events on the result pipe. You have to call 1801Process some requests that have reached the result phase (i.e. they have
1802been executed but the results are not yet reported). You have to call
1803this "regularly" to finish outstanding requests.
1804
1591this regularly. Returns C<0> if all events could be processed (or there 1805Returns C<0> if all events could be processed (or there were no
1592were no events to process), or C<-1> if it returned earlier for whatever 1806events to process), or C<-1> if it returned earlier for whatever
1593reason. Returns immediately when no events are outstanding. The amount of 1807reason. Returns immediately when no events are outstanding. The amount
1594events processed depends on the settings of C<IO::AIO::max_poll_req> and 1808of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1595C<IO::AIO::max_poll_time>. 1809C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1596 1810
1597If not all requests were processed for whatever reason, the filehandle 1811If not all requests were processed for whatever reason, the poll file
1598will still be ready when C<poll_cb> returns, so normally you don't have to 1812descriptor will still be ready when C<poll_cb> returns, so normally you
1599do anything special to have it called later. 1813don't have to do anything special to have it called later.
1600 1814
1601Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes 1815Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1602ready, it can be beneficial to call this function from loops which submit 1816ready, it can be beneficial to call this function from loops which submit
1603a lot of requests, to make sure the results get processed when they become 1817a lot of requests, to make sure the results get processed when they become
1604available and not just when the loop is finished and the event loop takes 1818available and not just when the loop is finished and the event loop takes
1613 poll => 'r', async => 1, 1827 poll => 'r', async => 1,
1614 cb => \&IO::AIO::poll_cb); 1828 cb => \&IO::AIO::poll_cb);
1615 1829
1616=item IO::AIO::poll_wait 1830=item IO::AIO::poll_wait
1617 1831
1618If there are any outstanding requests and none of them in the result 1832Wait until either at least one request is in the result phase or no
1619phase, wait till the result filehandle becomes ready for reading (simply 1833requests are outstanding anymore.
1620does a C<select> on the filehandle. This is useful if you want to 1834
1621synchronously wait for some requests to finish). 1835This is useful if you want to synchronously wait for some requests to
1836become ready, without actually handling them.
1622 1837
1623See C<nreqs> for an example. 1838See C<nreqs> for an example.
1624 1839
1625=item IO::AIO::poll 1840=item IO::AIO::poll
1626 1841
1747 1962
1748This is a very bad function to use in interactive programs because it 1963This is a very bad function to use in interactive programs because it
1749blocks, and a bad way to reduce concurrency because it is inexact: Better 1964blocks, and a bad way to reduce concurrency because it is inexact: Better
1750use an C<aio_group> together with a feed callback. 1965use an C<aio_group> together with a feed callback.
1751 1966
1752It's main use is in scripts without an event loop - when you want to stat 1967Its main use is in scripts without an event loop - when you want to stat
1753a lot of files, you can write somehting like this: 1968a lot of files, you can write something like this:
1754 1969
1755 IO::AIO::max_outstanding 32; 1970 IO::AIO::max_outstanding 32;
1756 1971
1757 for my $path (...) { 1972 for my $path (...) {
1758 aio_stat $path , ...; 1973 aio_stat $path , ...;
1797 2012
1798=back 2013=back
1799 2014
1800=head3 MISCELLANEOUS FUNCTIONS 2015=head3 MISCELLANEOUS FUNCTIONS
1801 2016
1802IO::AIO implements some functions that might be useful, but are not 2017IO::AIO implements some functions that are useful when you want to use
1803asynchronous. 2018some "Advanced I/O" function not available to in Perl, without going the
2019"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
2020counterpart.
1804 2021
1805=over 4 2022=over 4
2023
2024=item $numfd = IO::AIO::get_fdlimit
2025
2026This function is I<EXPERIMENTAL> and subject to change.
2027
2028Tries to find the current file descriptor limit and returns it, or
2029C<undef> and sets C<$!> in case of an error. The limit is one larger than
2030the highest valid file descriptor number.
2031
2032=item IO::AIO::min_fdlimit [$numfd]
2033
2034This function is I<EXPERIMENTAL> and subject to change.
2035
2036Try to increase the current file descriptor limit(s) to at least C<$numfd>
2037by changing the soft or hard file descriptor resource limit. If C<$numfd>
2038is missing, it will try to set a very high limit, although this is not
2039recommended when you know the actual minimum that you require.
2040
2041If the limit cannot be raised enough, the function makes a best-effort
2042attempt to increase the limit as much as possible, using various
2043tricks, while still failing. You can query the resulting limit using
2044C<IO::AIO::get_fdlimit>.
2045
2046If an error occurs, returns C<undef> and sets C<$!>, otherwise returns
2047true.
1806 2048
1807=item IO::AIO::sendfile $ofh, $ifh, $offset, $count 2049=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1808 2050
1809Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, 2051Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
1810but is blocking (this makes most sense if you know the input data is 2052but is blocking (this makes most sense if you know the input data is
1827=item IO::AIO::madvise $scalar, $offset, $len, $advice 2069=item IO::AIO::madvise $scalar, $offset, $len, $advice
1828 2070
1829Simply calls the C<posix_madvise> function (see its 2071Simply calls the C<posix_madvise> function (see its
1830manpage for details). The following advice constants are 2072manpage for details). The following advice constants are
1831available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, 2073available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1832C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. 2074C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>,
2075C<IO::AIO::MADV_DONTNEED>.
2076
2077If C<$offset> is negative, counts from the end. If C<$length> is negative,
2078the remaining length of the C<$scalar> is used. If possible, C<$length>
2079will be reduced to fit into the C<$scalar>.
1833 2080
1834On systems that do not implement C<posix_madvise>, this function returns 2081On systems that do not implement C<posix_madvise>, this function returns
1835ENOSYS, otherwise the return value of C<posix_madvise>. 2082ENOSYS, otherwise the return value of C<posix_madvise>.
1836 2083
1837=item IO::AIO::mprotect $scalar, $offset, $len, $protect 2084=item IO::AIO::mprotect $scalar, $offset, $len, $protect
1839Simply calls the C<mprotect> function on the preferably AIO::mmap'ed 2086Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1840$scalar (see its manpage for details). The following protect 2087$scalar (see its manpage for details). The following protect
1841constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, 2088constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1842C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. 2089C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1843 2090
2091If C<$offset> is negative, counts from the end. If C<$length> is negative,
2092the remaining length of the C<$scalar> is used. If possible, C<$length>
2093will be reduced to fit into the C<$scalar>.
2094
1844On systems that do not implement C<mprotect>, this function returns 2095On systems that do not implement C<mprotect>, this function returns
1845ENOSYS, otherwise the return value of C<mprotect>. 2096ENOSYS, otherwise the return value of C<mprotect>.
1846 2097
1847=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 2098=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1848 2099
1849Memory-maps a file (or anonymous memory range) and attaches it to the 2100Memory-maps a file (or anonymous memory range) and attaches it to the
1850given C<$scalar>, which will act like a string scalar. 2101given C<$scalar>, which will act like a string scalar. Returns true on
2102success, and false otherwise.
1851 2103
2104The scalar must exist, but its contents do not matter - this means you
2105cannot use a nonexistant array or hash element. When in doubt, C<undef>
2106the scalar first.
2107
1852The only operations allowed on the scalar are C<substr>/C<vec> that don't 2108The only operations allowed on the mmapped scalar are C<substr>/C<vec>,
1853change the string length, and most read-only operations such as copying it 2109which don't change the string length, and most read-only operations such
1854or searching it with regexes and so on. 2110as copying it or searching it with regexes and so on.
1855 2111
1856Anything else is unsafe and will, at best, result in memory leaks. 2112Anything else is unsafe and will, at best, result in memory leaks.
1857 2113
1858The memory map associated with the C<$scalar> is automatically removed 2114The memory map associated with the C<$scalar> is automatically removed
1859when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or 2115when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap>
1860C<IO::AIO::munmap> functions are called. 2116or C<IO::AIO::munmap> functions are called on it.
1861 2117
1862This calls the C<mmap>(2) function internally. See your system's manual 2118This calls the C<mmap>(2) function internally. See your system's manual
1863page for details on the C<$length>, C<$prot> and C<$flags> parameters. 2119page for details on the C<$length>, C<$prot> and C<$flags> parameters.
1864 2120
1865The C<$length> must be larger than zero and smaller than the actual 2121The C<$length> must be larger than zero and smaller than the actual
1866filesize. 2122filesize.
1867 2123
1868C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, 2124C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1869C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, 2125C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1870 2126
1871C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or 2127C<$flags> can be a combination of
1872C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when 2128C<IO::AIO::MAP_SHARED> or
1873not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS> 2129C<IO::AIO::MAP_PRIVATE>,
2130or a number of system-specific flags (when not available, the are C<0>):
1874(which is set to C<MAP_ANON> if your system only provides this 2131C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
1875constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>, 2132C<IO::AIO::MAP_LOCKED>,
1876C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or 2133C<IO::AIO::MAP_NORESERVE>,
2134C<IO::AIO::MAP_POPULATE>,
1877C<IO::AIO::MAP_NONBLOCK> 2135C<IO::AIO::MAP_NONBLOCK>,
2136C<IO::AIO::MAP_FIXED>,
2137C<IO::AIO::MAP_GROWSDOWN>,
2138C<IO::AIO::MAP_32BIT>,
2139C<IO::AIO::MAP_HUGETLB> or
2140C<IO::AIO::MAP_STACK>.
1878 2141
1879If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. 2142If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1880 2143
1881C<$offset> is the offset from the start of the file - it generally must be 2144C<$offset> is the offset from the start of the file - it generally must be
1882a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. 2145a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
1896 2159
1897=item IO::AIO::munmap $scalar 2160=item IO::AIO::munmap $scalar
1898 2161
1899Removes a previous mmap and undefines the C<$scalar>. 2162Removes a previous mmap and undefines the C<$scalar>.
1900 2163
2164=item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0]
2165
2166Calls the Linux-specific mremap(2) system call. The C<$scalar> must have
2167been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be
2168C<0> or C<IO::AIO::MREMAP_MAYMOVE>.
2169
2170Returns true if successful, and false otherwise. If the underlying mmapped
2171region has changed address, then the true value has the numerical value
2172C<1>, otherwise it has the numerical value C<0>:
2173
2174 my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
2175 or die "mremap: $!";
2176
2177 if ($success*1) {
2178 warn "scalar has chanegd address in memory\n";
2179 }
2180
2181C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently
2182implemented, but not supported and might go away in a future version.
2183
2184On systems where this call is not supported or is not emulated, this call
2185returns falls and sets C<$!> to C<ENOSYS>.
2186
1901=item IO::AIO::munlock $scalar, $offset = 0, $length = undef 2187=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
1902 2188
1903Calls the C<munlock> function, undoing the effects of a previous 2189Calls the C<munlock> function, undoing the effects of a previous
1904C<aio_mlock> call (see its description for details). 2190C<aio_mlock> call (see its description for details).
1905 2191
1907 2193
1908Calls the C<munlockall> function. 2194Calls the C<munlockall> function.
1909 2195
1910On systems that do not implement C<munlockall>, this function returns 2196On systems that do not implement C<munlockall>, this function returns
1911ENOSYS, otherwise the return value of C<munlockall>. 2197ENOSYS, otherwise the return value of C<munlockall>.
2198
2199=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
2200
2201Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
2202C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
2203should be the file offset.
2204
2205C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2206silently corrupt the data in this case.
2207
2208The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
2209C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
2210C<IO::AIO::SPLICE_F_GIFT>.
2211
2212See the C<splice(2)> manpage for details.
2213
2214=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2215
2216Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
2217description for C<IO::AIO::splice> above for details.
2218
2219=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
2220
2221Attempts to query or change the pipe buffer size. Obviously works only
2222on pipes, and currently works only on GNU/Linux systems, and fails with
2223C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
2224size on other systems, drop me a note.
2225
2226=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
2227
2228This is a direct interface to the Linux L<pipe2(2)> system call. If
2229C<$flags> is missing or C<0>, then this should be the same as a call to
2230perl's built-in C<pipe> function and create a new pipe, and works on
2231systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
2232(..., 4096, O_BINARY)>.
2233
2234If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
2235the given flags (Linux 2.6.27, glibc 2.9).
2236
2237On success, the read and write file handles are returned.
2238
2239On error, nothing will be returned. If the pipe2 syscall is missing and
2240C<$flags> is non-zero, fails with C<ENOSYS>.
2241
2242Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
2243time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
2244C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
2245
2246Example: create a pipe race-free w.r.t. threads and fork:
2247
2248 my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
2249 or die "pipe2: $!\n";
2250
2251=item $fh = IO::AIO::eventfd [$initval, [$flags]]
2252
2253This is a direct interface to the Linux L<eventfd(2)> system call. The
2254(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
2255
2256On success, the new eventfd filehandle is returned, otherwise returns
2257C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
2258
2259Please refer to L<eventfd(2)> for more info on this call.
2260
2261The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
2262C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
2263
2264Example: create a new eventfd filehandle:
2265
2266 $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC
2267 or die "eventfd: $!\n";
2268
2269=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
2270
2271This is a direct interface to the Linux L<timerfd_create(2)> system call. The
2272(unhelpful) default for C<$flags> is C<0>.
2273
2274On success, the new timerfd filehandle is returned, otherwise returns
2275C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
2276
2277Please refer to L<timerfd_create(2)> for more info on this call.
2278
2279The following C<$clockid> values are
2280available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
2281C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15)
2282C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and
2283C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11).
2284
2285The following C<$flags> values are available (Linux
22862.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>.
2287
2288Example: create a new timerfd and set it to one-second repeated alarms,
2289then wait for two alarms:
2290
2291 my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC
2292 or die "timerfd_create: $!\n";
2293
2294 defined IO::AIO::timerfd_settime $fh, 0, 1, 1
2295 or die "timerfd_settime: $!\n";
2296
2297 for (1..2) {
2298 8 == sysread $fh, my $buf, 8
2299 or die "timerfd read failure\n";
2300
2301 printf "number of expirations (likely 1): %d\n",
2302 unpack "Q", $buf;
2303 }
2304
2305=item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
2306
2307This is a direct interface to the Linux L<timerfd_settime(2)> system
2308call. Please refer to its manpage for more info on this call.
2309
2310The new itimerspec is specified using two (possibly fractional) second
2311values, C<$new_interval> and C<$new_value>).
2312
2313On success, the current interval and value are returned (as per
2314C<timerfd_gettime>). On failure, the empty list is returned.
2315
2316The following C<$flags> values are
2317available: C<IO::AIO::TFD_TIMER_ABSTIME> and
2318C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>.
2319
2320See C<IO::AIO::timerfd_create> for a full example.
2321
2322=item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
2323
2324This is a direct interface to the Linux L<timerfd_gettime(2)> system
2325call. Please refer to its manpage for more info on this call.
2326
2327On success, returns the current values of interval and value for the given
2328timerfd (as potentially fractional second values). On failure, the empty
2329list is returned.
1912 2330
1913=back 2331=back
1914 2332
1915=cut 2333=cut
1916 2334
1982the process will result in undefined behaviour. Calling it at any time 2400the process will result in undefined behaviour. Calling it at any time
1983will also result in any undefined (by POSIX) behaviour. 2401will also result in any undefined (by POSIX) behaviour.
1984 2402
1985=back 2403=back
1986 2404
2405=head2 LINUX-SPECIFIC CALLS
2406
2407When a call is documented as "linux-specific" then this means it
2408originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the
2409availability and compatibility of such calls regardless of the platform
2410it is compiled on, so platforms such as FreeBSD which often implement
2411these calls will work. When in doubt, call them and see if they fail wth
2412C<ENOSYS>.
2413
1987=head2 MEMORY USAGE 2414=head2 MEMORY USAGE
1988 2415
1989Per-request usage: 2416Per-request usage:
1990 2417
1991Each aio request uses - depending on your architecture - around 100-200 2418Each aio request uses - depending on your architecture - around 100-200
2003temporary buffers, and each thread requires a stack and other data 2430temporary buffers, and each thread requires a stack and other data
2004structures (usually around 16k-128k, depending on the OS). 2431structures (usually around 16k-128k, depending on the OS).
2005 2432
2006=head1 KNOWN BUGS 2433=head1 KNOWN BUGS
2007 2434
2008Known bugs will be fixed in the next release. 2435Known bugs will be fixed in the next release :)
2436
2437=head1 KNOWN ISSUES
2438
2439Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap>
2440or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as
2441non-created hash slots or other scalars I didn't think of. It's best to
2442avoid such and either use scalar variables or making sure that the scalar
2443exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied).
2444
2445I am not sure anything can be done about this, so this is considered a
2446known issue, rather than a bug.
2009 2447
2010=head1 SEE ALSO 2448=head1 SEE ALSO
2011 2449
2012L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a 2450L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2013more natural syntax. 2451more natural syntax.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines