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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines