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.199 by root, Wed Jun 29 12:46:36 2011 UTC vs.
Revision 1.264 by root, Mon Jul 18 07:48:01 2016 UTC

68=head2 EXAMPLE 68=head2 EXAMPLE
69 69
70This is a simple example that uses the EV module and loads 70This is a simple example that uses the EV module and loads
71F</etc/passwd> asynchronously: 71F</etc/passwd> asynchronously:
72 72
73 use Fcntl;
74 use EV; 73 use EV;
75 use IO::AIO; 74 use IO::AIO;
76 75
77 # register the IO::AIO callback with EV 76 # register the IO::AIO callback with EV
78 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; 77 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
95 94
96 # file contents now in $contents 95 # file contents now in $contents
97 print $contents; 96 print $contents;
98 97
99 # exit event loop and program 98 # exit event loop and program
100 EV::unloop; 99 EV::break;
101 }; 100 };
102 }; 101 };
103 102
104 # possibly queue up other requests, or open GUI windows, 103 # possibly queue up other requests, or open GUI windows,
105 # check for sockets etc. etc. 104 # check for sockets etc. etc.
106 105
107 # process events as long as there are some: 106 # process events as long as there are some:
108 EV::loop; 107 EV::run;
109 108
110=head1 REQUEST ANATOMY AND LIFETIME 109=head1 REQUEST ANATOMY AND LIFETIME
111 110
112Every C<aio_*> function creates a request. which is a C data structure not 111Every C<aio_*> function creates a request. which is a C data structure not
113directly visible to Perl. 112directly visible to Perl.
168use common::sense; 167use common::sense;
169 168
170use base 'Exporter'; 169use base 'Exporter';
171 170
172BEGIN { 171BEGIN {
173 our $VERSION = '3.92'; 172 our $VERSION = 4.34;
174 173
175 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close 174 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 175 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
177 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync 176 aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
178 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead 177 aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
178 aio_pathsync aio_readahead aio_fiemap aio_allocate
179 aio_rename aio_link aio_move aio_copy aio_group 179 aio_rename aio_link aio_move aio_copy aio_group
180 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 180 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
181 aio_chmod aio_utime aio_truncate 181 aio_chmod aio_utime aio_truncate
182 aio_msync aio_mtouch aio_mlock aio_mlockall 182 aio_msync aio_mtouch aio_mlock aio_mlockall
183 aio_statvfs); 183 aio_statvfs
184 aio_wd);
184 185
185 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 186 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
186 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 187 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
187 min_parallel max_parallel max_idle idle_timeout 188 min_parallel max_parallel max_idle idle_timeout
188 nreqs nready npending nthreads 189 nreqs nready npending nthreads
200 201
201=head1 FUNCTIONS 202=head1 FUNCTIONS
202 203
203=head2 QUICK OVERVIEW 204=head2 QUICK OVERVIEW
204 205
205This section simply lists the prototypes of the most important functions 206This section simply lists the prototypes most of the functions for
206for quick reference. See the following sections for function-by-function 207quick reference. See the following sections for function-by-function
207documentation. 208documentation.
208 209
210 aio_wd $pathname, $callback->($wd)
209 aio_open $pathname, $flags, $mode, $callback->($fh) 211 aio_open $pathname, $flags, $mode, $callback->($fh)
210 aio_close $fh, $callback->($status) 212 aio_close $fh, $callback->($status)
213 aio_seek $fh,$offset,$whence, $callback->($offs)
211 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 214 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
212 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 215 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
213 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 216 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
214 aio_readahead $fh,$offset,$length, $callback->($retval) 217 aio_readahead $fh,$offset,$length, $callback->($retval)
215 aio_stat $fh_or_path, $callback->($status) 218 aio_stat $fh_or_path, $callback->($status)
216 aio_lstat $fh, $callback->($status) 219 aio_lstat $fh, $callback->($status)
217 aio_statvfs $fh_or_path, $callback->($statvfs) 220 aio_statvfs $fh_or_path, $callback->($statvfs)
218 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 221 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
219 aio_chown $fh_or_path, $uid, $gid, $callback->($status) 222 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
223 aio_chmod $fh_or_path, $mode, $callback->($status)
220 aio_truncate $fh_or_path, $offset, $callback->($status) 224 aio_truncate $fh_or_path, $offset, $callback->($status)
221 aio_chmod $fh_or_path, $mode, $callback->($status) 225 aio_allocate $fh, $mode, $offset, $len, $callback->($status)
226 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
222 aio_unlink $pathname, $callback->($status) 227 aio_unlink $pathname, $callback->($status)
223 aio_mknod $path, $mode, $dev, $callback->($status) 228 aio_mknod $pathname, $mode, $dev, $callback->($status)
224 aio_link $srcpath, $dstpath, $callback->($status) 229 aio_link $srcpath, $dstpath, $callback->($status)
225 aio_symlink $srcpath, $dstpath, $callback->($status) 230 aio_symlink $srcpath, $dstpath, $callback->($status)
226 aio_readlink $path, $callback->($link) 231 aio_readlink $pathname, $callback->($link)
232 aio_realpath $pathname, $callback->($path)
227 aio_rename $srcpath, $dstpath, $callback->($status) 233 aio_rename $srcpath, $dstpath, $callback->($status)
228 aio_mkdir $pathname, $mode, $callback->($status) 234 aio_mkdir $pathname, $mode, $callback->($status)
229 aio_rmdir $pathname, $callback->($status) 235 aio_rmdir $pathname, $callback->($status)
230 aio_readdir $pathname, $callback->($entries) 236 aio_readdir $pathname, $callback->($entries)
231 aio_readdirx $pathname, $flags, $callback->($entries, $flags) 237 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
232 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST 238 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
233 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN 239 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
240 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
234 aio_load $path, $data, $callback->($status) 241 aio_load $pathname, $data, $callback->($status)
235 aio_copy $srcpath, $dstpath, $callback->($status) 242 aio_copy $srcpath, $dstpath, $callback->($status)
236 aio_move $srcpath, $dstpath, $callback->($status) 243 aio_move $srcpath, $dstpath, $callback->($status)
237 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
238 aio_rmtree $path, $callback->($status) 244 aio_rmtree $pathname, $callback->($status)
245 aio_fcntl $fh, $cmd, $arg, $callback->($status)
246 aio_ioctl $fh, $request, $buf, $callback->($status)
239 aio_sync $callback->($status) 247 aio_sync $callback->($status)
248 aio_syncfs $fh, $callback->($status)
240 aio_fsync $fh, $callback->($status) 249 aio_fsync $fh, $callback->($status)
241 aio_fdatasync $fh, $callback->($status) 250 aio_fdatasync $fh, $callback->($status)
242 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 251 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
243 aio_pathsync $path, $callback->($status) 252 aio_pathsync $pathname, $callback->($status)
244 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 253 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
245 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 254 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
246 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 255 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
247 aio_mlockall $flags, $callback->($status) 256 aio_mlockall $flags, $callback->($status)
248 aio_group $callback->(...) 257 aio_group $callback->(...)
266 IO::AIO::nready 275 IO::AIO::nready
267 IO::AIO::npending 276 IO::AIO::npending
268 277
269 IO::AIO::sendfile $ofh, $ifh, $offset, $count 278 IO::AIO::sendfile $ofh, $ifh, $offset, $count
270 IO::AIO::fadvise $fh, $offset, $len, $advice 279 IO::AIO::fadvise $fh, $offset, $len, $advice
280 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
281 IO::AIO::munmap $scalar
271 IO::AIO::madvise $scalar, $offset, $length, $advice 282 IO::AIO::madvise $scalar, $offset, $length, $advice
272 IO::AIO::mprotect $scalar, $offset, $length, $protect 283 IO::AIO::mprotect $scalar, $offset, $length, $protect
273 IO::AIO::munlock $scalar, $offset = 0, $length = undef 284 IO::AIO::munlock $scalar, $offset = 0, $length = undef
274 IO::AIO::munlockall 285 IO::AIO::munlockall
275 286
276=head2 AIO REQUEST FUNCTIONS 287=head2 API NOTES
277 288
278All the C<aio_*> calls are more or less thin wrappers around the syscall 289All the C<aio_*> calls are more or less thin wrappers around the syscall
279with the same name (sans C<aio_>). The arguments are similar or identical, 290with the same name (sans C<aio_>). The arguments are similar or identical,
280and they all accept an additional (and optional) C<$callback> argument 291and they all accept an additional (and optional) C<$callback> argument
281which must be a code reference. This code reference will get called with 292which must be a code reference. This code reference will be called after
282the syscall return code (e.g. most syscalls return C<-1> on error, unlike 293the syscall has been executed in an asynchronous fashion. The results
283perl, which usually delivers "false") as its sole argument after the given 294of the request will be passed as arguments to the callback (and, if an
284syscall has been executed asynchronously. 295error occured, in C<$!>) - for most requests the syscall return code (e.g.
296most syscalls return C<-1> on error, unlike perl, which usually delivers
297"false").
298
299Some requests (such as C<aio_readdir>) pass the actual results and
300communicate failures by passing C<undef>.
285 301
286All functions expecting a filehandle keep a copy of the filehandle 302All functions expecting a filehandle keep a copy of the filehandle
287internally until the request has finished. 303internally until the request has finished.
288 304
289All functions return request objects of type L<IO::AIO::REQ> that allow 305All functions return request objects of type L<IO::AIO::REQ> that allow
290further manipulation of those requests while they are in-flight. 306further manipulation of those requests while they are in-flight.
291 307
292The pathnames you pass to these routines I<must> be absolute and 308The pathnames you pass to these routines I<should> be absolute. The
293encoded as octets. The reason for the former is that at the time the 309reason for this is that at the time the request is being executed, the
294request is being executed, the current working directory could have 310current working directory could have changed. Alternatively, you can
295changed. Alternatively, you can make sure that you never change the 311make sure that you never change the current working directory anywhere
296current working directory anywhere in the program and then use relative 312in the program and then use relative paths. You can also take advantage
297paths. 313of IO::AIOs working directory abstraction, that lets you specify paths
314relative to some previously-opened "working directory object" - see the
315description of the C<IO::AIO::WD> class later in this document.
298 316
299To encode pathnames as octets, either make sure you either: a) always pass 317To encode pathnames as octets, either make sure you either: a) always pass
300in filenames you got from outside (command line, readdir etc.) without 318in filenames you got from outside (command line, readdir etc.) without
301tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode 319tinkering, b) are in your native filesystem encoding, c) use the Encode
302your pathnames to the locale (or other) encoding in effect in the user 320module and encode your pathnames to the locale (or other) encoding in
303environment, d) use Glib::filename_from_unicode on unicode filenames or e) 321effect in the user environment, d) use Glib::filename_from_unicode on
304use something else to ensure your scalar has the correct contents. 322unicode filenames or e) use something else to ensure your scalar has the
323correct contents.
305 324
306This works, btw. independent of the internal UTF-8 bit, which IO::AIO 325This works, btw. independent of the internal UTF-8 bit, which IO::AIO
307handles correctly whether it is set or not. 326handles correctly whether it is set or not.
327
328=head2 AIO REQUEST FUNCTIONS
308 329
309=over 4 330=over 4
310 331
311=item $prev_pri = aioreq_pri [$pri] 332=item $prev_pri = aioreq_pri [$pri]
312 333
342 363
343 364
344=item aio_open $pathname, $flags, $mode, $callback->($fh) 365=item aio_open $pathname, $flags, $mode, $callback->($fh)
345 366
346Asynchronously open or create a file and call the callback with a newly 367Asynchronously open or create a file and call the callback with a newly
347created filehandle for the file. 368created filehandle for the file (or C<undef> in case of an error).
348 369
349The pathname passed to C<aio_open> must be absolute. See API NOTES, above, 370The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
350for an explanation. 371for an explanation.
351 372
352The C<$flags> argument is a bitmask. See the C<Fcntl> module for a 373The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
375following POSIX and non-POSIX constants are available (missing ones on 396following POSIX and non-POSIX constants are available (missing ones on
376your system are, as usual, C<0>): 397your system are, as usual, C<0>):
377 398
378C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, 399C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
379C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, 400C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
380C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>. 401C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>.
381 402
382 403
383=item aio_close $fh, $callback->($status) 404=item aio_close $fh, $callback->($status)
384 405
385Asynchronously close a file and call the callback with the result 406Asynchronously close a file and call the callback with the result
394 415
395Or in other words: the file descriptor will be closed, but it will not be 416Or in other words: the file descriptor will be closed, but it will not be
396free for reuse until the perl filehandle is closed. 417free for reuse until the perl filehandle is closed.
397 418
398=cut 419=cut
420
421=item aio_seek $fh, $offset, $whence, $callback->($offs)
422
423Seeks the filehandle to the new C<$offset>, similarly to perl's
424C<sysseek>. The C<$whence> can use the traditional values (C<0> for
425C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
426C<IO::AIO::SEEK_END>).
427
428The resulting absolute offset will be passed to the callback, or C<-1> in
429case of an error.
430
431In theory, the C<$whence> constants could be different than the
432corresponding values from L<Fcntl>, but perl guarantees they are the same,
433so don't panic.
434
435As a GNU/Linux (and maybe Solaris) extension, also the constants
436C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
437could be found. No guarantees about suitability for use in C<aio_seek> or
438Perl's C<sysseek> can be made though, although I would naively assume they
439"just work".
399 440
400=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 441=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
401 442
402=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 443=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
403 444
469As native sendfile syscalls (as practically any non-POSIX interface hacked 510As native sendfile syscalls (as practically any non-POSIX interface hacked
470together in a hurry to improve benchmark numbers) tend to be rather buggy 511together in a hurry to improve benchmark numbers) tend to be rather buggy
471on many systems, this implementation tries to work around some known bugs 512on many systems, this implementation tries to work around some known bugs
472in Linux and FreeBSD kernels (probably others, too), but that might fail, 513in Linux and FreeBSD kernels (probably others, too), but that might fail,
473so you really really should check the return value of C<aio_sendfile> - 514so you really really should check the return value of C<aio_sendfile> -
474fewre bytes than expected might have been transferred. 515fewer bytes than expected might have been transferred.
475 516
476 517
477=item aio_readahead $fh,$offset,$length, $callback->($retval) 518=item aio_readahead $fh,$offset,$length, $callback->($retval)
478 519
479C<aio_readahead> populates the page cache with data from a file so that 520C<aio_readahead> populates the page cache with data from a file so that
483whole pages, so that offset is effectively rounded down to a page boundary 524whole pages, so that offset is effectively rounded down to a page boundary
484and bytes are read up to the next page boundary greater than or equal to 525and bytes are read up to the next page boundary greater than or equal to
485(off-set+length). C<aio_readahead> does not read beyond the end of the 526(off-set+length). C<aio_readahead> does not read beyond the end of the
486file. The current file offset of the file is left unchanged. 527file. The current file offset of the file is left unchanged.
487 528
488If that syscall doesn't exist (likely if your OS isn't Linux) it will be 529If that syscall doesn't exist (likely if your kernel isn't Linux) it will
489emulated by simply reading the data, which would have a similar effect. 530be emulated by simply reading the data, which would have a similar effect.
490 531
491 532
492=item aio_stat $fh_or_path, $callback->($status) 533=item aio_stat $fh_or_path, $callback->($status)
493 534
494=item aio_lstat $fh, $callback->($status) 535=item aio_lstat $fh, $callback->($status)
563 namemax => 255, 604 namemax => 255,
564 frsize => 1024, 605 frsize => 1024,
565 fsid => 1810 606 fsid => 1810
566 } 607 }
567 608
609Here is a (likely partial - send me updates!) list of fsid values used by
610Linux - it is safe to hardcode these when C<$^O> is C<linux>:
611
612 0x0000adf5 adfs
613 0x0000adff affs
614 0x5346414f afs
615 0x09041934 anon-inode filesystem
616 0x00000187 autofs
617 0x42465331 befs
618 0x1badface bfs
619 0x42494e4d binfmt_misc
620 0x9123683e btrfs
621 0x0027e0eb cgroupfs
622 0xff534d42 cifs
623 0x73757245 coda
624 0x012ff7b7 coh
625 0x28cd3d45 cramfs
626 0x453dcd28 cramfs-wend (wrong endianness)
627 0x64626720 debugfs
628 0x00001373 devfs
629 0x00001cd1 devpts
630 0x0000f15f ecryptfs
631 0x00414a53 efs
632 0x0000137d ext
633 0x0000ef53 ext2/ext3/ext4
634 0x0000ef51 ext2
635 0xf2f52010 f2fs
636 0x00004006 fat
637 0x65735546 fuseblk
638 0x65735543 fusectl
639 0x0bad1dea futexfs
640 0x01161970 gfs2
641 0x47504653 gpfs
642 0x00004244 hfs
643 0xf995e849 hpfs
644 0x00c0ffee hostfs
645 0x958458f6 hugetlbfs
646 0x2bad1dea inotifyfs
647 0x00009660 isofs
648 0x000072b6 jffs2
649 0x3153464a jfs
650 0x6b414653 k-afs
651 0x0bd00bd0 lustre
652 0x0000137f minix
653 0x0000138f minix 30 char names
654 0x00002468 minix v2
655 0x00002478 minix v2 30 char names
656 0x00004d5a minix v3
657 0x19800202 mqueue
658 0x00004d44 msdos
659 0x0000564c novell
660 0x00006969 nfs
661 0x6e667364 nfsd
662 0x00003434 nilfs
663 0x5346544e ntfs
664 0x00009fa1 openprom
665 0x7461636F ocfs2
666 0x00009fa0 proc
667 0x6165676c pstorefs
668 0x0000002f qnx4
669 0x68191122 qnx6
670 0x858458f6 ramfs
671 0x52654973 reiserfs
672 0x00007275 romfs
673 0x67596969 rpc_pipefs
674 0x73636673 securityfs
675 0xf97cff8c selinux
676 0x0000517b smb
677 0x534f434b sockfs
678 0x73717368 squashfs
679 0x62656572 sysfs
680 0x012ff7b6 sysv2
681 0x012ff7b5 sysv4
682 0x01021994 tmpfs
683 0x15013346 udf
684 0x00011954 ufs
685 0x54190100 ufs byteswapped
686 0x00009fa2 usbdevfs
687 0x01021997 v9fs
688 0xa501fcf5 vxfs
689 0xabba1974 xenfs
690 0x012ff7b4 xenix
691 0x58465342 xfs
692 0x012fd16d xia
568 693
569=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 694=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
570 695
571Works like perl's C<utime> function (including the special case of $atime 696Works like perl's C<utime> function (including the special case of $atime
572and $mtime being undef). Fractional times are supported if the underlying 697and $mtime being undef). Fractional times are supported if the underlying
600=item aio_truncate $fh_or_path, $offset, $callback->($status) 725=item aio_truncate $fh_or_path, $offset, $callback->($status)
601 726
602Works like truncate(2) or ftruncate(2). 727Works like truncate(2) or ftruncate(2).
603 728
604 729
730=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
731
732Allocates or frees disk space according to the C<$mode> argument. See the
733linux C<fallocate> documentation for details.
734
735C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
736space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>,
737to deallocate a file range.
738
739IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
740(without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see
741your L<fallocate(2)> manpage).
742
743The file system block size used by C<fallocate> is presumably the
744C<f_bsize> returned by C<statvfs>.
745
746If C<fallocate> isn't available or cannot be emulated (currently no
747emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
748
749
605=item aio_chmod $fh_or_path, $mode, $callback->($status) 750=item aio_chmod $fh_or_path, $mode, $callback->($status)
606 751
607Works like perl's C<chmod> function. 752Works like perl's C<chmod> function.
608 753
609 754
611 756
612Asynchronously unlink (delete) a file and call the callback with the 757Asynchronously unlink (delete) a file and call the callback with the
613result code. 758result code.
614 759
615 760
616=item aio_mknod $path, $mode, $dev, $callback->($status) 761=item aio_mknod $pathname, $mode, $dev, $callback->($status)
617 762
618[EXPERIMENTAL] 763[EXPERIMENTAL]
619 764
620Asynchronously create a device node (or fifo). See mknod(2). 765Asynchronously create a device node (or fifo). See mknod(2).
621 766
622The only (POSIX-) portable way of calling this function is: 767The only (POSIX-) portable way of calling this function is:
623 768
624 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 769 aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
625 770
626See C<aio_stat> for info about some potentially helpful extra constants 771See C<aio_stat> for info about some potentially helpful extra constants
627and functions. 772and functions.
628 773
629=item aio_link $srcpath, $dstpath, $callback->($status) 774=item aio_link $srcpath, $dstpath, $callback->($status)
636 781
637Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 782Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
638the path C<$dstpath> and call the callback with the result code. 783the path C<$dstpath> and call the callback with the result code.
639 784
640 785
641=item aio_readlink $path, $callback->($link) 786=item aio_readlink $pathname, $callback->($link)
642 787
643Asynchronously read the symlink specified by C<$path> and pass it to 788Asynchronously read the symlink specified by C<$path> and pass it to
644the callback. If an error occurs, nothing or undef gets passed to the 789the callback. If an error occurs, nothing or undef gets passed to the
645callback. 790callback.
646 791
647 792
793=item aio_realpath $pathname, $callback->($path)
794
795Asynchronously make the path absolute and resolve any symlinks in
796C<$path>. The resulting path only consists of directories (same as
797L<Cwd::realpath>).
798
799This request can be used to get the absolute path of the current working
800directory by passing it a path of F<.> (a single dot).
801
802
648=item aio_rename $srcpath, $dstpath, $callback->($status) 803=item aio_rename $srcpath, $dstpath, $callback->($status)
649 804
650Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 805Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
651rename(2) and call the callback with the result code. 806rename(2) and call the callback with the result code.
807
808On systems that support the AIO::WD working directory abstraction
809natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
810of failing, C<rename> is called on the absolute path of C<$wd>.
652 811
653 812
654=item aio_mkdir $pathname, $mode, $callback->($status) 813=item aio_mkdir $pathname, $mode, $callback->($status)
655 814
656Asynchronously mkdir (create) a directory and call the callback with 815Asynchronously mkdir (create) a directory and call the callback with
661=item aio_rmdir $pathname, $callback->($status) 820=item aio_rmdir $pathname, $callback->($status)
662 821
663Asynchronously rmdir (delete) a directory and call the callback with the 822Asynchronously rmdir (delete) a directory and call the callback with the
664result code. 823result code.
665 824
825On systems that support the AIO::WD working directory abstraction
826natively, the case C<[$wd, "."]> is specialcased - instead of failing,
827C<rmdir> is called on the absolute path of C<$wd>.
828
666 829
667=item aio_readdir $pathname, $callback->($entries) 830=item aio_readdir $pathname, $callback->($entries)
668 831
669Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 832Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
670directory (i.e. opendir + readdir + closedir). The entries will not be 833directory (i.e. opendir + readdir + closedir). The entries will not be
674array-ref with the filenames. 837array-ref with the filenames.
675 838
676 839
677=item aio_readdirx $pathname, $flags, $callback->($entries, $flags) 840=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
678 841
679Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune 842Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to
680behaviour and output format. In case of an error, C<$entries> will be 843tune behaviour and output format. In case of an error, C<$entries> will be
681C<undef>. 844C<undef>.
682 845
683The flags are a combination of the following constants, ORed together (the 846The flags are a combination of the following constants, ORed together (the
684flags will also be passed to the callback, possibly modified): 847flags will also be passed to the callback, possibly modified):
685 848
732 895
733=item IO::AIO::READDIR_FOUND_UNKNOWN 896=item IO::AIO::READDIR_FOUND_UNKNOWN
734 897
735This flag should not be set when calling C<aio_readdirx>. Instead, it 898This flag should not be set when calling C<aio_readdirx>. Instead, it
736is being set by C<aio_readdirx>, when any of the C<$type>'s found were 899is being set by C<aio_readdirx>, when any of the C<$type>'s found were
737C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all 900C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all
738C<$type>'s are known, which can be used to speed up some algorithms. 901C<$type>'s are known, which can be used to speed up some algorithms.
739 902
740=back 903=back
741 904
742 905
743=item aio_load $path, $data, $callback->($status) 906=item aio_load $pathname, $data, $callback->($status)
744 907
745This is a composite request that tries to fully load the given file into 908This is a composite request that tries to fully load the given file into
746memory. Status is the same as with aio_read. 909memory. Status is the same as with aio_read.
747 910
748=cut 911=cut
883 }; 1046 };
884 1047
885 $grp 1048 $grp
886} 1049}
887 1050
888=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 1051=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
889 1052
890Scans a directory (similar to C<aio_readdir>) but additionally tries to 1053Scans a directory (similar to C<aio_readdir>) but additionally tries to
891efficiently separate the entries of directory C<$path> into two sets of 1054efficiently separate the entries of directory C<$path> into two sets of
892names, directories you can recurse into (directories), and ones you cannot 1055names, directories you can recurse into (directories), and ones you cannot
893recurse into (everything else, including symlinks to directories). 1056recurse into (everything else, including symlinks to directories).
924Then entries will be sorted into likely directories a non-initial dot 1087Then entries will be sorted into likely directories a non-initial dot
925currently) and likely non-directories (see C<aio_readdirx>). Then every 1088currently) and likely non-directories (see C<aio_readdirx>). Then every
926entry plus an appended C</.> will be C<stat>'ed, likely directories first, 1089entry plus an appended C</.> will be C<stat>'ed, likely directories first,
927in order of their inode numbers. If that succeeds, it assumes that the 1090in order of their inode numbers. If that succeeds, it assumes that the
928entry is a directory or a symlink to directory (which will be checked 1091entry is a directory or a symlink to directory (which will be checked
929seperately). This is often faster than stat'ing the entry itself because 1092separately). This is often faster than stat'ing the entry itself because
930filesystems might detect the type of the entry without reading the inode 1093filesystems might detect the type of the entry without reading the inode
931data (e.g. ext2fs filetype feature), even on systems that cannot return 1094data (e.g. ext2fs filetype feature), even on systems that cannot return
932the filetype information on readdir. 1095the filetype information on readdir.
933 1096
934If the known number of directories (link count - 2) has been reached, the 1097If the known number of directories (link count - 2) has been reached, the
950 1113
951 my $grp = aio_group $cb; 1114 my $grp = aio_group $cb;
952 1115
953 $maxreq = 4 if $maxreq <= 0; 1116 $maxreq = 4 if $maxreq <= 0;
954 1117
955 # stat once 1118 # get a wd object
956 aioreq_pri $pri; 1119 aioreq_pri $pri;
957 add $grp aio_stat $path, sub { 1120 add $grp aio_wd $path, sub {
1121 $_[0]
958 return $grp->result () if $_[0]; 1122 or return $grp->result ();
959 my $now = time;
960 my $hash1 = join ":", (stat _)[0,1,3,7,9];
961 1123
962 # read the directory entries 1124 my $wd = [shift, "."];
1125
1126 # stat once
963 aioreq_pri $pri; 1127 aioreq_pri $pri;
964 add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { 1128 add $grp aio_stat $wd, sub {
965 my $entries = shift
966 or return $grp->result (); 1129 return $grp->result () if $_[0];
1130 my $now = time;
1131 my $hash1 = join ":", (stat _)[0,1,3,7,9];
967 1132
968 # stat the dir another time 1133 # read the directory entries
969 aioreq_pri $pri; 1134 aioreq_pri $pri;
1135 add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
1136 my $entries = shift
1137 or return $grp->result ();
1138
1139 # stat the dir another time
1140 aioreq_pri $pri;
970 add $grp aio_stat $path, sub { 1141 add $grp aio_stat $wd, sub {
971 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 1142 my $hash2 = join ":", (stat _)[0,1,3,7,9];
972 1143
973 my $ndirs; 1144 my $ndirs;
974 1145
975 # take the slow route if anything looks fishy 1146 # take the slow route if anything looks fishy
976 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 1147 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
977 $ndirs = -1; 1148 $ndirs = -1;
978 } else { 1149 } else {
979 # if nlink == 2, we are finished 1150 # if nlink == 2, we are finished
980 # for non-posix-fs's, we rely on nlink < 2 1151 # for non-posix-fs's, we rely on nlink < 2
981 $ndirs = (stat _)[3] - 2 1152 $ndirs = (stat _)[3] - 2
982 or return $grp->result ([], $entries); 1153 or return $grp->result ([], $entries);
983 } 1154 }
984 1155
985 my (@dirs, @nondirs); 1156 my (@dirs, @nondirs);
986 1157
987 my $statgrp = add $grp aio_group sub { 1158 my $statgrp = add $grp aio_group sub {
988 $grp->result (\@dirs, \@nondirs); 1159 $grp->result (\@dirs, \@nondirs);
989 }; 1160 };
990 1161
991 limit $statgrp $maxreq; 1162 limit $statgrp $maxreq;
992 feed $statgrp sub { 1163 feed $statgrp sub {
993 return unless @$entries; 1164 return unless @$entries;
994 my $entry = shift @$entries; 1165 my $entry = shift @$entries;
995 1166
996 aioreq_pri $pri; 1167 aioreq_pri $pri;
1168 $wd->[1] = "$entry/.";
997 add $statgrp aio_stat "$path/$entry/.", sub { 1169 add $statgrp aio_stat $wd, sub {
998 if ($_[0] < 0) { 1170 if ($_[0] < 0) {
999 push @nondirs, $entry; 1171 push @nondirs, $entry;
1000 } else { 1172 } else {
1001 # need to check for real directory 1173 # need to check for real directory
1002 aioreq_pri $pri; 1174 aioreq_pri $pri;
1175 $wd->[1] = $entry;
1003 add $statgrp aio_lstat "$path/$entry", sub { 1176 add $statgrp aio_lstat $wd, sub {
1004 if (-d _) { 1177 if (-d _) {
1005 push @dirs, $entry; 1178 push @dirs, $entry;
1006 1179
1007 unless (--$ndirs) { 1180 unless (--$ndirs) {
1008 push @nondirs, @$entries; 1181 push @nondirs, @$entries;
1009 feed $statgrp; 1182 feed $statgrp;
1183 }
1184 } else {
1185 push @nondirs, $entry;
1010 } 1186 }
1011 } else {
1012 push @nondirs, $entry;
1013 } 1187 }
1014 } 1188 }
1015 } 1189 };
1016 }; 1190 };
1017 }; 1191 };
1018 }; 1192 };
1019 }; 1193 };
1020 }; 1194 };
1021 1195
1022 $grp 1196 $grp
1023} 1197}
1024 1198
1025=item aio_rmtree $path, $callback->($status) 1199=item aio_rmtree $pathname, $callback->($status)
1026 1200
1027Delete a directory tree starting (and including) C<$path>, return the 1201Delete a directory tree starting (and including) C<$path>, return the
1028status of the final C<rmdir> only. This is a composite request that 1202status of the final C<rmdir> only. This is a composite request that
1029uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1203uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1030everything else. 1204everything else.
1031 1205
1032=cut 1206=cut
1033 1207
1055 }; 1229 };
1056 1230
1057 $grp 1231 $grp
1058} 1232}
1059 1233
1234=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
1235
1236=item aio_ioctl $fh, $request, $buf, $callback->($status)
1237
1238These work just like the C<fcntl> and C<ioctl> built-in functions, except
1239they execute asynchronously and pass the return value to the callback.
1240
1241Both calls can be used for a lot of things, some of which make more sense
1242to run asynchronously in their own thread, while some others make less
1243sense. For example, calls that block waiting for external events, such
1244as locking, will also lock down an I/O thread while it is waiting, which
1245can deadlock the whole I/O system. At the same time, there might be no
1246alternative to using a thread to wait.
1247
1248So in general, you should only use these calls for things that do
1249(filesystem) I/O, not for things that wait for other events (network,
1250other processes), although if you are careful and know what you are doing,
1251you still can.
1252
1253The following constants are available (missing ones are, as usual C<0>):
1254
1255C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
1256
1257C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
1258C<FS_IOC_FIEMAP>.
1259
1260C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
1261C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
1262
1263C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
1264C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
1265C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
1266C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
1267C<FS_FL_USER_MODIFIABLE>.
1268
1269C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
1270C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
1271C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
1272C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
1273
1060=item aio_sync $callback->($status) 1274=item aio_sync $callback->($status)
1061 1275
1062Asynchronously call sync and call the callback when finished. 1276Asynchronously call sync and call the callback when finished.
1063 1277
1064=item aio_fsync $fh, $callback->($status) 1278=item aio_fsync $fh, $callback->($status)
1071Asynchronously call fdatasync on the given filehandle and call the 1285Asynchronously call fdatasync on the given filehandle and call the
1072callback with the fdatasync result code. 1286callback with the fdatasync result code.
1073 1287
1074If this call isn't available because your OS lacks it or it couldn't be 1288If this call isn't available because your OS lacks it or it couldn't be
1075detected, it will be emulated by calling C<fsync> instead. 1289detected, it will be emulated by calling C<fsync> instead.
1290
1291=item aio_syncfs $fh, $callback->($status)
1292
1293Asynchronously call the syncfs syscall to sync the filesystem associated
1294to the given filehandle and call the callback with the syncfs result
1295code. If syncfs is not available, calls sync(), but returns C<-1> and sets
1296errno to C<ENOSYS> nevertheless.
1076 1297
1077=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 1298=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
1078 1299
1079Sync the data portion of the file specified by C<$offset> and C<$length> 1300Sync the data portion of the file specified by C<$offset> and C<$length>
1080to disk (but NOT the metadata), by calling the Linux-specific 1301to disk (but NOT the metadata), by calling the Linux-specific
1084C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, 1305C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
1085C<IO::AIO::SYNC_FILE_RANGE_WRITE> and 1306C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
1086C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range 1307C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
1087manpage for details. 1308manpage for details.
1088 1309
1089=item aio_pathsync $path, $callback->($status) 1310=item aio_pathsync $pathname, $callback->($status)
1090 1311
1091This request tries to open, fsync and close the given path. This is a 1312This request tries to open, fsync and close the given path. This is a
1092composite request intended to sync directories after directory operations 1313composite request intended to sync directories after directory operations
1093(E.g. rename). This might not work on all operating systems or have any 1314(E.g. rename). This might not work on all operating systems or have any
1094specific effect, but usually it makes sure that directory changes get 1315specific effect, but usually it makes sure that directory changes get
1146 1367
1147This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1368This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1148scalars. 1369scalars.
1149 1370
1150It touches (reads or writes) all memory pages in the specified 1371It touches (reads or writes) all memory pages in the specified
1151range inside the scalar. All caveats and parameters are the same 1372range inside the scalar. All caveats and parameters are the same
1152as for C<aio_msync>, above, except for flags, which must be either 1373as for C<aio_msync>, above, except for flags, which must be either
1153C<0> (which reads all pages and ensures they are instantiated) or 1374C<0> (which reads all pages and ensures they are instantiated) or
1154C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and 1375C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1155writing an octet from it, which dirties the page). 1376writing an octet from it, which dirties the page).
1156 1377
1157=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 1378=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1158 1379
1159This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1380This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1190documented under L<MISCELLANEOUS FUNCTIONS>. 1411documented under L<MISCELLANEOUS FUNCTIONS>.
1191 1412
1192Example: asynchronously lock all current and future pages into memory. 1413Example: asynchronously lock all current and future pages into memory.
1193 1414
1194 aio_mlockall IO::AIO::MCL_FUTURE; 1415 aio_mlockall IO::AIO::MCL_FUTURE;
1416
1417=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1418
1419Queries the extents of the given file (by calling the Linux C<FIEMAP>
1420ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1421the ioctl is not available on your OS, then this request will fail with
1422C<ENOSYS>.
1423
1424C<$start> is the starting offset to query extents for, C<$length> is the
1425size of the range to query - if it is C<undef>, then the whole file will
1426be queried.
1427
1428C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
1429C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1430exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1431the data portion.
1432
1433C<$count> is the maximum number of extent records to return. If it is
1434C<undef>, then IO::AIO queries all extents of the range. As a very special
1435case, if it is C<0>, then the callback receives the number of extents
1436instead of the extents themselves (which is unreliable, see below).
1437
1438If an error occurs, the callback receives no arguments. The special
1439C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1440
1441Otherwise, the callback receives an array reference with extent
1442structures. Each extent structure is an array reference itself, with the
1443following members:
1444
1445 [$logical, $physical, $length, $flags]
1446
1447Flags is any combination of the following flag values (typically either C<0>
1448or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1449
1450C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1451C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1452C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1453C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1454C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1455C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1456
1457At the time of this writing (Linux 3.2), this requets is unreliable unless
1458C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1459it to return all extents of a range for files with large number of
1460extents. The code works around all these issues if C<$count> is undef.
1195 1461
1196=item aio_group $callback->(...) 1462=item aio_group $callback->(...)
1197 1463
1198This is a very special aio request: Instead of doing something, it is a 1464This is a very special aio request: Instead of doing something, it is a
1199container for other aio requests, which is useful if you want to bundle 1465container for other aio requests, which is useful if you want to bundle
1236like sleep and file handle readable/writable, the overhead this creates is 1502like sleep and file handle readable/writable, the overhead this creates is
1237immense (it blocks a thread for a long time) so do not use this function 1503immense (it blocks a thread for a long time) so do not use this function
1238except to put your application under artificial I/O pressure. 1504except to put your application under artificial I/O pressure.
1239 1505
1240=back 1506=back
1507
1508
1509=head2 IO::AIO::WD - multiple working directories
1510
1511Your process only has one current working directory, which is used by all
1512threads. This makes it hard to use relative paths (some other component
1513could call C<chdir> at any time, and it is hard to control when the path
1514will be used by IO::AIO).
1515
1516One solution for this is to always use absolute paths. This usually works,
1517but can be quite slow (the kernel has to walk the whole path on every
1518access), and can also be a hassle to implement.
1519
1520Newer POSIX systems have a number of functions (openat, fdopendir,
1521futimensat and so on) that make it possible to specify working directories
1522per operation.
1523
1524For portability, and because the clowns who "designed", or shall I write,
1525perpetrated this new interface were obviously half-drunk, this abstraction
1526cannot be perfect, though.
1527
1528IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
1529object. This object stores the canonicalised, absolute version of the
1530path, and on systems that allow it, also a directory file descriptor.
1531
1532Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
1533or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
1534object and a pathname instead (or the IO::AIO::WD object alone, which
1535gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
1536IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
1537to that IO::AIO::WD object.
1538
1539For example, to get a wd object for F</etc> and then stat F<passwd>
1540inside, you would write:
1541
1542 aio_wd "/etc", sub {
1543 my $etcdir = shift;
1544
1545 # although $etcdir can be undef on error, there is generally no reason
1546 # to check for errors here, as aio_stat will fail with ENOENT
1547 # when $etcdir is undef.
1548
1549 aio_stat [$etcdir, "passwd"], sub {
1550 # yay
1551 };
1552 };
1553
1554The fact that C<aio_wd> is a request and not a normal function shows that
1555creating an IO::AIO::WD object is itself a potentially blocking operation,
1556which is why it is done asynchronously.
1557
1558To stat the directory obtained with C<aio_wd> above, one could write
1559either of the following three request calls:
1560
1561 aio_lstat "/etc" , sub { ... # pathname as normal string
1562 aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
1563 aio_lstat $wd , sub { ... # shorthand for the previous
1564
1565As with normal pathnames, IO::AIO keeps a copy of the working directory
1566object and the pathname string, so you could write the following without
1567causing any issues due to C<$path> getting reused:
1568
1569 my $path = [$wd, undef];
1570
1571 for my $name (qw(abc def ghi)) {
1572 $path->[1] = $name;
1573 aio_stat $path, sub {
1574 # ...
1575 };
1576 }
1577
1578There are some caveats: when directories get renamed (or deleted), the
1579pathname string doesn't change, so will point to the new directory (or
1580nowhere at all), while the directory fd, if available on the system,
1581will still point to the original directory. Most functions accepting a
1582pathname will use the directory fd on newer systems, and the string on
1583older systems. Some functions (such as realpath) will always rely on the
1584string form of the pathname.
1585
1586So this functionality is mainly useful to get some protection against
1587C<chdir>, to easily get an absolute path out of a relative path for future
1588reference, and to speed up doing many operations in the same directory
1589(e.g. when stat'ing all files in a directory).
1590
1591The following functions implement this working directory abstraction:
1592
1593=over 4
1594
1595=item aio_wd $pathname, $callback->($wd)
1596
1597Asynchonously canonicalise the given pathname and convert it to an
1598IO::AIO::WD object representing it. If possible and supported on the
1599system, also open a directory fd to speed up pathname resolution relative
1600to this working directory.
1601
1602If something goes wrong, then C<undef> is passwd to the callback instead
1603of a working directory object and C<$!> is set appropriately. Since
1604passing C<undef> as working directory component of a pathname fails the
1605request with C<ENOENT>, there is often no need for error checking in the
1606C<aio_wd> callback, as future requests using the value will fail in the
1607expected way.
1608
1609=item IO::AIO::CWD
1610
1611This is a compiletime constant (object) that represents the process
1612current working directory.
1613
1614Specifying this object as working directory object for a pathname is as if
1615the pathname would be specified directly, without a directory object. For
1616example, these calls are functionally identical:
1617
1618 aio_stat "somefile", sub { ... };
1619 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1620
1621=back
1622
1623To recover the path associated with an IO::AIO::WD object, you can use
1624C<aio_realpath>:
1625
1626 aio_realpath $wd, sub {
1627 warn "path is $_[0]\n";
1628 };
1629
1630Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
1631sometimes, fall back to using an absolue path.
1241 1632
1242=head2 IO::AIO::REQ CLASS 1633=head2 IO::AIO::REQ CLASS
1243 1634
1244All non-aggregate C<aio_*> functions return an object of this class when 1635All non-aggregate C<aio_*> functions return an object of this class when
1245called in non-void context. 1636called in non-void context.
1363 1754
1364Sets a feeder/generator on this group: every group can have an attached 1755Sets a feeder/generator on this group: every group can have an attached
1365generator that generates requests if idle. The idea behind this is that, 1756generator that generates requests if idle. The idea behind this is that,
1366although you could just queue as many requests as you want in a group, 1757although you could just queue as many requests as you want in a group,
1367this might starve other requests for a potentially long time. For example, 1758this might starve other requests for a potentially long time. For example,
1368C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, 1759C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1369delaying any later requests for a long time. 1760requests, delaying any later requests for a long time.
1370 1761
1371To avoid this, and allow incremental generation of requests, you can 1762To avoid this, and allow incremental generation of requests, you can
1372instead a group and set a feeder on it that generates those requests. The 1763instead a group and set a feeder on it that generates those requests. The
1373feed callback will be called whenever there are few enough (see C<limit>, 1764feed callback will be called whenever there are few enough (see C<limit>,
1374below) requests active in the group itself and is expected to queue more 1765below) requests active in the group itself and is expected to queue more
1423 1814
1424See C<poll_cb> for an example. 1815See C<poll_cb> for an example.
1425 1816
1426=item IO::AIO::poll_cb 1817=item IO::AIO::poll_cb
1427 1818
1428Process some outstanding events on the result pipe. You have to call 1819Process some requests that have reached the result phase (i.e. they have
1820been executed but the results are not yet reported). You have to call
1821this "regularly" to finish outstanding requests.
1822
1429this regularly. Returns C<0> if all events could be processed (or there 1823Returns C<0> if all events could be processed (or there were no
1430were no events to process), or C<-1> if it returned earlier for whatever 1824events to process), or C<-1> if it returned earlier for whatever
1431reason. Returns immediately when no events are outstanding. The amount of 1825reason. Returns immediately when no events are outstanding. The amount
1432events processed depends on the settings of C<IO::AIO::max_poll_req> and 1826of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1433C<IO::AIO::max_poll_time>. 1827C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1434 1828
1435If not all requests were processed for whatever reason, the filehandle 1829If not all requests were processed for whatever reason, the poll file
1436will still be ready when C<poll_cb> returns, so normally you don't have to 1830descriptor will still be ready when C<poll_cb> returns, so normally you
1437do anything special to have it called later. 1831don't have to do anything special to have it called later.
1438 1832
1439Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes 1833Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1440ready, it can be beneficial to call this function from loops which submit 1834ready, it can be beneficial to call this function from loops which submit
1441a lot of requests, to make sure the results get processed when they become 1835a lot of requests, to make sure the results get processed when they become
1442available and not just when the loop is finished and the event loop takes 1836available and not just when the loop is finished and the event loop takes
1451 poll => 'r', async => 1, 1845 poll => 'r', async => 1,
1452 cb => \&IO::AIO::poll_cb); 1846 cb => \&IO::AIO::poll_cb);
1453 1847
1454=item IO::AIO::poll_wait 1848=item IO::AIO::poll_wait
1455 1849
1456If there are any outstanding requests and none of them in the result 1850Wait until either at least one request is in the result phase or no
1457phase, wait till the result filehandle becomes ready for reading (simply 1851requests are outstanding anymore.
1458does a C<select> on the filehandle. This is useful if you want to 1852
1459synchronously wait for some requests to finish). 1853This is useful if you want to synchronously wait for some requests to
1854become ready, without actually handling them.
1460 1855
1461See C<nreqs> for an example. 1856See C<nreqs> for an example.
1462 1857
1463=item IO::AIO::poll 1858=item IO::AIO::poll
1464 1859
1585 1980
1586This is a very bad function to use in interactive programs because it 1981This is a very bad function to use in interactive programs because it
1587blocks, and a bad way to reduce concurrency because it is inexact: Better 1982blocks, and a bad way to reduce concurrency because it is inexact: Better
1588use an C<aio_group> together with a feed callback. 1983use an C<aio_group> together with a feed callback.
1589 1984
1590It's main use is in scripts without an event loop - when you want to stat 1985Its main use is in scripts without an event loop - when you want to stat
1591a lot of files, you can write somehting like this: 1986a lot of files, you can write somehting like this:
1592 1987
1593 IO::AIO::max_outstanding 32; 1988 IO::AIO::max_outstanding 32;
1594 1989
1595 for my $path (...) { 1990 for my $path (...) {
1635 2030
1636=back 2031=back
1637 2032
1638=head3 MISCELLANEOUS FUNCTIONS 2033=head3 MISCELLANEOUS FUNCTIONS
1639 2034
1640IO::AIO implements some functions that might be useful, but are not 2035IO::AIO implements some functions that are useful when you want to use
1641asynchronous. 2036some "Advanced I/O" function not available to in Perl, without going the
2037"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
2038counterpart.
1642 2039
1643=over 4 2040=over 4
1644 2041
1645=item IO::AIO::sendfile $ofh, $ifh, $offset, $count 2042=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1646 2043
1653 2050
1654=item IO::AIO::fadvise $fh, $offset, $len, $advice 2051=item IO::AIO::fadvise $fh, $offset, $len, $advice
1655 2052
1656Simply calls the C<posix_fadvise> function (see its 2053Simply calls the C<posix_fadvise> function (see its
1657manpage for details). The following advice constants are 2054manpage for details). The following advice constants are
1658avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, 2055available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1659C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, 2056C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1660C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. 2057C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1661 2058
1662On systems that do not implement C<posix_fadvise>, this function returns 2059On systems that do not implement C<posix_fadvise>, this function returns
1663ENOSYS, otherwise the return value of C<posix_fadvise>. 2060ENOSYS, otherwise the return value of C<posix_fadvise>.
1664 2061
1665=item IO::AIO::madvise $scalar, $offset, $len, $advice 2062=item IO::AIO::madvise $scalar, $offset, $len, $advice
1666 2063
1667Simply calls the C<posix_madvise> function (see its 2064Simply calls the C<posix_madvise> function (see its
1668manpage for details). The following advice constants are 2065manpage for details). The following advice constants are
1669avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, 2066available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1670C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. 2067C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>,
2068C<IO::AIO::MADV_FREE>.
1671 2069
1672On systems that do not implement C<posix_madvise>, this function returns 2070On systems that do not implement C<posix_madvise>, this function returns
1673ENOSYS, otherwise the return value of C<posix_madvise>. 2071ENOSYS, otherwise the return value of C<posix_madvise>.
1674 2072
1675=item IO::AIO::mprotect $scalar, $offset, $len, $protect 2073=item IO::AIO::mprotect $scalar, $offset, $len, $protect
1676 2074
1677Simply calls the C<mprotect> function on the preferably AIO::mmap'ed 2075Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1678$scalar (see its manpage for details). The following protect 2076$scalar (see its manpage for details). The following protect
1679constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, 2077constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1680C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. 2078C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1681 2079
1682On systems that do not implement C<mprotect>, this function returns 2080On systems that do not implement C<mprotect>, this function returns
1683ENOSYS, otherwise the return value of C<mprotect>. 2081ENOSYS, otherwise the return value of C<mprotect>.
1684 2082
1685=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 2083=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1686 2084
1687Memory-maps a file (or anonymous memory range) and attaches it to the 2085Memory-maps a file (or anonymous memory range) and attaches it to the
1688given C<$scalar>, which will act like a string scalar. 2086given C<$scalar>, which will act like a string scalar. Returns true on
2087success, and false otherwise.
1689 2088
1690The only operations allowed on the scalar are C<substr>/C<vec> that don't 2089The only operations allowed on the scalar are C<substr>/C<vec> that don't
1691change the string length, and most read-only operations such as copying it 2090change the string length, and most read-only operations such as copying it
1692or searching it with regexes and so on. 2091or searching it with regexes and so on.
1693 2092
1704filesize. 2103filesize.
1705 2104
1706C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, 2105C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1707C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, 2106C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1708 2107
1709C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or 2108C<$flags> can be a combination of
1710C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when 2109C<IO::AIO::MAP_SHARED> or
1711not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS> 2110C<IO::AIO::MAP_PRIVATE>,
2111or a number of system-specific flags (when not available, the are C<0>):
1712(which is set to C<MAP_ANON> if your system only provides this 2112C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
1713constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>, 2113C<IO::AIO::MAP_LOCKED>,
1714C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or 2114C<IO::AIO::MAP_NORESERVE>,
2115C<IO::AIO::MAP_POPULATE>,
1715C<IO::AIO::MAP_NONBLOCK> 2116C<IO::AIO::MAP_NONBLOCK>,
2117C<IO::AIO::MAP_FIXED>,
2118C<IO::AIO::MAP_GROWSDOWN>,
2119C<IO::AIO::MAP_32BIT>,
2120C<IO::AIO::MAP_HUGETLB> or
2121C<IO::AIO::MAP_STACK>.
1716 2122
1717If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. 2123If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1718 2124
1719C<$offset> is the offset from the start of the file - it generally must be 2125C<$offset> is the offset from the start of the file - it generally must be
1720a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. 2126a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
1745 2151
1746Calls the C<munlockall> function. 2152Calls the C<munlockall> function.
1747 2153
1748On systems that do not implement C<munlockall>, this function returns 2154On systems that do not implement C<munlockall>, this function returns
1749ENOSYS, otherwise the return value of C<munlockall>. 2155ENOSYS, otherwise the return value of C<munlockall>.
2156
2157=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
2158
2159Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
2160C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
2161should be the file offset.
2162
2163C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2164silently corrupt the data in this case.
2165
2166The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
2167C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
2168C<IO::AIO::SPLICE_F_GIFT>.
2169
2170See the C<splice(2)> manpage for details.
2171
2172=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2173
2174Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
2175description for C<IO::AIO::splice> above for details.
2176
2177=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
2178
2179Attempts to query or change the pipe buffer size. Obviously works only
2180on pipes, and currently works only on GNU/Linux systems, and fails with
2181C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
2182size on other systems, drop me a note.
2183
2184=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
2185
2186This is a direct interface to the Linux L<pipe2(2)> system call. If
2187C<$flags> is missing or C<0>, then this should be the same as a call to
2188perl's built-in C<pipe> function and create a new pipe, and works on
2189systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
2190(..., 4096, O_BINARY)>.
2191
2192If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
2193the given flags (Linux 2.6.27, glibc 2.9).
2194
2195On success, the read and write file handles are returned.
2196
2197On error, nothing will be returned. If the pipe2 syscall is missing and
2198C<$flags> is non-zero, fails with C<ENOSYS>.
2199
2200Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
2201time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
2202C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
1750 2203
1751=back 2204=back
1752 2205
1753=cut 2206=cut
1754 2207
1792=head2 FORK BEHAVIOUR 2245=head2 FORK BEHAVIOUR
1793 2246
1794Usage of pthreads in a program changes the semantics of fork 2247Usage of pthreads in a program changes the semantics of fork
1795considerably. Specifically, only async-safe functions can be called after 2248considerably. Specifically, only async-safe functions can be called after
1796fork. Perl doesn't know about this, so in general, you cannot call fork 2249fork. Perl doesn't know about this, so in general, you cannot call fork
1797with defined behaviour in perl. IO::AIO uses pthreads, so this applies, 2250with defined behaviour in perl if pthreads are involved. IO::AIO uses
1798but many other extensions and (for inexplicable reasons) perl itself often 2251pthreads, so this applies, but many other extensions and (for inexplicable
1799is linked against pthreads, so this limitation applies. 2252reasons) perl itself often is linked against pthreads, so this limitation
2253applies to quite a lot of perls.
1800 2254
1801Some operating systems have extensions that allow safe use of fork, and 2255This module no longer tries to fight your OS, or POSIX. That means IO::AIO
1802this module should do "the right thing" on those, and tries on others. At 2256only works in the process that loaded it. Forking is fully supported, but
1803the time of this writing (2011) only GNU/Linux supports these extensions 2257using IO::AIO in the child is not.
1804to POSIX. 2258
2259You might get around by not I<using> IO::AIO before (or after)
2260forking. You could also try to call the L<IO::AIO::reinit> function in the
2261child:
2262
2263=over 4
2264
2265=item IO::AIO::reinit
2266
2267Abandons all current requests and I/O threads and simply reinitialises all
2268data structures. This is not an operation supported by any standards, but
2269happens to work on GNU/Linux and some newer BSD systems.
2270
2271The only reasonable use for this function is to call it after forking, if
2272C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in
2273the process will result in undefined behaviour. Calling it at any time
2274will also result in any undefined (by POSIX) behaviour.
2275
2276=back
1805 2277
1806=head2 MEMORY USAGE 2278=head2 MEMORY USAGE
1807 2279
1808Per-request usage: 2280Per-request usage:
1809 2281

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines