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.209 by root, Tue Sep 27 00:41:51 2011 UTC vs.
Revision 1.277 by root, Fri Sep 22 12:17:49 2017 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.35;
174 177
175 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close 178 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx 179 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
177 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync 180 aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
178 aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate 181 aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
179 aio_pathsync aio_readahead 182 aio_pathsync aio_readahead aio_fiemap aio_allocate
180 aio_rename aio_link aio_move aio_copy aio_group 183 aio_rename aio_rename2 aio_link aio_move aio_copy aio_group
181 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 184 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
182 aio_chmod aio_utime aio_truncate 185 aio_chmod aio_utime aio_truncate
183 aio_msync aio_mtouch aio_mlock aio_mlockall 186 aio_msync aio_mtouch aio_mlock aio_mlockall
184 aio_statvfs 187 aio_statvfs
185 aio_wd); 188 aio_wd);
202 205
203=head1 FUNCTIONS 206=head1 FUNCTIONS
204 207
205=head2 QUICK OVERVIEW 208=head2 QUICK OVERVIEW
206 209
207This section simply lists the prototypes of the most important functions 210This section simply lists the prototypes most of the functions for
208for quick reference. See the following sections for function-by-function 211quick reference. See the following sections for function-by-function
209documentation. 212documentation.
210 213
211 aio_wd $pathname, $callback->($wd) 214 aio_wd $pathname, $callback->($wd)
212 aio_open $pathname, $flags, $mode, $callback->($fh) 215 aio_open $pathname, $flags, $mode, $callback->($fh)
213 aio_close $fh, $callback->($status) 216 aio_close $fh, $callback->($status)
217 aio_seek $fh,$offset,$whence, $callback->($offs)
214 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 218 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
215 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 219 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
216 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 220 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
217 aio_readahead $fh,$offset,$length, $callback->($retval) 221 aio_readahead $fh,$offset,$length, $callback->($retval)
218 aio_stat $fh_or_path, $callback->($status) 222 aio_stat $fh_or_path, $callback->($status)
219 aio_lstat $fh, $callback->($status) 223 aio_lstat $fh, $callback->($status)
220 aio_statvfs $fh_or_path, $callback->($statvfs) 224 aio_statvfs $fh_or_path, $callback->($statvfs)
221 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 225 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
222 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)
223 aio_truncate $fh_or_path, $offset, $callback->($status) 228 aio_truncate $fh_or_path, $offset, $callback->($status)
224 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)
225 aio_unlink $pathname, $callback->($status) 231 aio_unlink $pathname, $callback->($status)
226 aio_mknod $pathname, $mode, $dev, $callback->($status) 232 aio_mknod $pathname, $mode, $dev, $callback->($status)
227 aio_link $srcpath, $dstpath, $callback->($status) 233 aio_link $srcpath, $dstpath, $callback->($status)
228 aio_symlink $srcpath, $dstpath, $callback->($status) 234 aio_symlink $srcpath, $dstpath, $callback->($status)
229 aio_readlink $pathname, $callback->($link) 235 aio_readlink $pathname, $callback->($link)
230 aio_realpath $pathname, $callback->($link) 236 aio_realpath $pathname, $callback->($path)
231 aio_rename $srcpath, $dstpath, $callback->($status) 237 aio_rename $srcpath, $dstpath, $callback->($status)
238 aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
232 aio_mkdir $pathname, $mode, $callback->($status) 239 aio_mkdir $pathname, $mode, $callback->($status)
233 aio_rmdir $pathname, $callback->($status) 240 aio_rmdir $pathname, $callback->($status)
234 aio_readdir $pathname, $callback->($entries) 241 aio_readdir $pathname, $callback->($entries)
235 aio_readdirx $pathname, $flags, $callback->($entries, $flags) 242 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
236 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST 243 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
237 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN 244 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
245 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
238 aio_load $pathname, $data, $callback->($status) 246 aio_load $pathname, $data, $callback->($status)
239 aio_copy $srcpath, $dstpath, $callback->($status) 247 aio_copy $srcpath, $dstpath, $callback->($status)
240 aio_move $srcpath, $dstpath, $callback->($status) 248 aio_move $srcpath, $dstpath, $callback->($status)
241 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
242 aio_rmtree $pathname, $callback->($status) 249 aio_rmtree $pathname, $callback->($status)
250 aio_fcntl $fh, $cmd, $arg, $callback->($status)
251 aio_ioctl $fh, $request, $buf, $callback->($status)
243 aio_sync $callback->($status) 252 aio_sync $callback->($status)
244 aio_syncfs $fh, $callback->($status) 253 aio_syncfs $fh, $callback->($status)
245 aio_fsync $fh, $callback->($status) 254 aio_fsync $fh, $callback->($status)
246 aio_fdatasync $fh, $callback->($status) 255 aio_fdatasync $fh, $callback->($status)
247 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 256 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
248 aio_pathsync $pathname, $callback->($status) 257 aio_pathsync $pathname, $callback->($status)
249 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 258 aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
250 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 259 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
251 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 260 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
252 aio_mlockall $flags, $callback->($status) 261 aio_mlockall $flags, $callback->($status)
253 aio_group $callback->(...) 262 aio_group $callback->(...)
254 aio_nop $callback->() 263 aio_nop $callback->()
268 IO::AIO::idle_timeout $seconds 277 IO::AIO::idle_timeout $seconds
269 IO::AIO::max_outstanding $maxreqs 278 IO::AIO::max_outstanding $maxreqs
270 IO::AIO::nreqs 279 IO::AIO::nreqs
271 IO::AIO::nready 280 IO::AIO::nready
272 IO::AIO::npending 281 IO::AIO::npending
282 IO::AIO::min_fdlimit $nfd;
273 283
274 IO::AIO::sendfile $ofh, $ifh, $offset, $count 284 IO::AIO::sendfile $ofh, $ifh, $offset, $count
275 IO::AIO::fadvise $fh, $offset, $len, $advice 285 IO::AIO::fadvise $fh, $offset, $len, $advice
286 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
287 IO::AIO::munmap $scalar
276 IO::AIO::madvise $scalar, $offset, $length, $advice 288 IO::AIO::madvise $scalar, $offset, $length, $advice
277 IO::AIO::mprotect $scalar, $offset, $length, $protect 289 IO::AIO::mprotect $scalar, $offset, $length, $protect
278 IO::AIO::munlock $scalar, $offset = 0, $length = undef 290 IO::AIO::munlock $scalar, $offset = 0, $length = undef
279 IO::AIO::munlockall 291 IO::AIO::munlockall
280 292
281=head2 AIO REQUEST FUNCTIONS 293=head2 API NOTES
282 294
283All the C<aio_*> calls are more or less thin wrappers around the syscall 295All the C<aio_*> calls are more or less thin wrappers around the syscall
284with the same name (sans C<aio_>). The arguments are similar or identical, 296with the same name (sans C<aio_>). The arguments are similar or identical,
285and they all accept an additional (and optional) C<$callback> argument 297and they all accept an additional (and optional) C<$callback> argument
286which must be a code reference. This code reference will get called with 298which must be a code reference. This code reference will be called after
287the syscall return code (e.g. most syscalls return C<-1> on error, unlike 299the syscall has been executed in an asynchronous fashion. The results
288perl, which usually delivers "false") as its sole argument after the given 300of the request will be passed as arguments to the callback (and, if an
289syscall has been executed asynchronously. 301error occured, in C<$!>) - for most requests the syscall return code (e.g.
302most syscalls return C<-1> on error, unlike perl, which usually delivers
303"false").
304
305Some requests (such as C<aio_readdir>) pass the actual results and
306communicate failures by passing C<undef>.
290 307
291All functions expecting a filehandle keep a copy of the filehandle 308All functions expecting a filehandle keep a copy of the filehandle
292internally until the request has finished. 309internally until the request has finished.
293 310
294All functions return request objects of type L<IO::AIO::REQ> that allow 311All functions return request objects of type L<IO::AIO::REQ> that allow
295further manipulation of those requests while they are in-flight. 312further manipulation of those requests while they are in-flight.
296 313
297The pathnames you pass to these routines I<should> be absolute. The 314The pathnames you pass to these routines I<should> be absolute. The
298reason for this is that at the time the request is being executed, the 315reason for this is that at the time the request is being executed, the
299current working directory could have changed. Alternatively, you can make 316current working directory could have changed. Alternatively, you can
300sure that you never change the current working directory anywhere in 317make sure that you never change the current working directory anywhere
301the program and then use relative paths. Lastly, you can take advantage 318in the program and then use relative paths. You can also take advantage
302of IO::AIOs working directory abstraction - see the description of the 319of IO::AIOs working directory abstraction, that lets you specify paths
320relative to some previously-opened "working directory object" - see the
303C<IO::AIO::WD> class later in this document. 321description of the C<IO::AIO::WD> class later in this document.
304 322
305To encode pathnames as octets, either make sure you either: a) always pass 323To encode pathnames as octets, either make sure you either: a) always pass
306in filenames you got from outside (command line, readdir etc.) without 324in filenames you got from outside (command line, readdir etc.) without
307tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode 325tinkering, b) are in your native filesystem encoding, c) use the Encode
308your pathnames to the locale (or other) encoding in effect in the user 326module and encode your pathnames to the locale (or other) encoding in
309environment, d) use Glib::filename_from_unicode on unicode filenames or e) 327effect in the user environment, d) use Glib::filename_from_unicode on
310use something else to ensure your scalar has the correct contents. 328unicode filenames or e) use something else to ensure your scalar has the
329correct contents.
311 330
312This works, btw. independent of the internal UTF-8 bit, which IO::AIO 331This works, btw. independent of the internal UTF-8 bit, which IO::AIO
313handles correctly whether it is set or not. 332handles correctly whether it is set or not.
333
334=head2 AIO REQUEST FUNCTIONS
314 335
315=over 4 336=over 4
316 337
317=item $prev_pri = aioreq_pri [$pri] 338=item $prev_pri = aioreq_pri [$pri]
318 339
348 369
349 370
350=item aio_open $pathname, $flags, $mode, $callback->($fh) 371=item aio_open $pathname, $flags, $mode, $callback->($fh)
351 372
352Asynchronously open or create a file and call the callback with a newly 373Asynchronously open or create a file and call the callback with a newly
353created filehandle for the file. 374created filehandle for the file (or C<undef> in case of an error).
354 375
355The pathname passed to C<aio_open> must be absolute. See API NOTES, above, 376The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
356for an explanation. 377for an explanation.
357 378
358The C<$flags> argument is a bitmask. See the C<Fcntl> module for a 379The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
381following POSIX and non-POSIX constants are available (missing ones on 402following POSIX and non-POSIX constants are available (missing ones on
382your system are, as usual, C<0>): 403your system are, as usual, C<0>):
383 404
384C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, 405C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
385C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, 406C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
386C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>. 407C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>.
387 408
388 409
389=item aio_close $fh, $callback->($status) 410=item aio_close $fh, $callback->($status)
390 411
391Asynchronously close a file and call the callback with the result 412Asynchronously close a file and call the callback with the result
401Or in other words: the file descriptor will be closed, but it will not be 422Or in other words: the file descriptor will be closed, but it will not be
402free for reuse until the perl filehandle is closed. 423free for reuse until the perl filehandle is closed.
403 424
404=cut 425=cut
405 426
427=item aio_seek $fh, $offset, $whence, $callback->($offs)
428
429Seeks the filehandle to the new C<$offset>, similarly to perl's
430C<sysseek>. The C<$whence> can use the traditional values (C<0> for
431C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
432C<IO::AIO::SEEK_END>).
433
434The resulting absolute offset will be passed to the callback, or C<-1> in
435case of an error.
436
437In theory, the C<$whence> constants could be different than the
438corresponding values from L<Fcntl>, but perl guarantees they are the same,
439so don't panic.
440
441As a GNU/Linux (and maybe Solaris) extension, also the constants
442C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
443could be found. No guarantees about suitability for use in C<aio_seek> or
444Perl's C<sysseek> can be made though, although I would naively assume they
445"just work".
446
406=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 447=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
407 448
408=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 449=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
409 450
410Reads or writes C<$length> bytes from or to the specified C<$fh> and 451Reads or writes C<$length> bytes from or to the specified C<$fh> and
411C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> 452C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and
412and calls the callback without the actual number of bytes read (or -1 on 453calls the callback with the actual number of bytes transferred (or -1 on
413error, just like the syscall). 454error, just like the syscall).
414 455
415C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to 456C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
416offset plus the actual number of bytes read. 457offset plus the actual number of bytes read.
417 458
475As native sendfile syscalls (as practically any non-POSIX interface hacked 516As native sendfile syscalls (as practically any non-POSIX interface hacked
476together in a hurry to improve benchmark numbers) tend to be rather buggy 517together in a hurry to improve benchmark numbers) tend to be rather buggy
477on many systems, this implementation tries to work around some known bugs 518on many systems, this implementation tries to work around some known bugs
478in Linux and FreeBSD kernels (probably others, too), but that might fail, 519in Linux and FreeBSD kernels (probably others, too), but that might fail,
479so you really really should check the return value of C<aio_sendfile> - 520so you really really should check the return value of C<aio_sendfile> -
480fewre bytes than expected might have been transferred. 521fewer bytes than expected might have been transferred.
481 522
482 523
483=item aio_readahead $fh,$offset,$length, $callback->($retval) 524=item aio_readahead $fh,$offset,$length, $callback->($retval)
484 525
485C<aio_readahead> populates the page cache with data from a file so that 526C<aio_readahead> populates the page cache with data from a file so that
489whole pages, so that offset is effectively rounded down to a page boundary 530whole pages, so that offset is effectively rounded down to a page boundary
490and bytes are read up to the next page boundary greater than or equal to 531and bytes are read up to the next page boundary greater than or equal to
491(off-set+length). C<aio_readahead> does not read beyond the end of the 532(off-set+length). C<aio_readahead> does not read beyond the end of the
492file. The current file offset of the file is left unchanged. 533file. The current file offset of the file is left unchanged.
493 534
494If that syscall doesn't exist (likely if your OS isn't Linux) it will be 535If that syscall doesn't exist (likely if your kernel isn't Linux) it will
495emulated by simply reading the data, which would have a similar effect. 536be emulated by simply reading the data, which would have a similar effect.
496 537
497 538
498=item aio_stat $fh_or_path, $callback->($status) 539=item aio_stat $fh_or_path, $callback->($status)
499 540
500=item aio_lstat $fh, $callback->($status) 541=item aio_lstat $fh, $callback->($status)
569 namemax => 255, 610 namemax => 255,
570 frsize => 1024, 611 frsize => 1024,
571 fsid => 1810 612 fsid => 1810
572 } 613 }
573 614
615Here is a (likely partial - send me updates!) list of fsid values used by
616Linux - it is safe to hardcode these when C<$^O> is C<linux>:
617
618 0x0000adf5 adfs
619 0x0000adff affs
620 0x5346414f afs
621 0x09041934 anon-inode filesystem
622 0x00000187 autofs
623 0x42465331 befs
624 0x1badface bfs
625 0x42494e4d binfmt_misc
626 0x9123683e btrfs
627 0x0027e0eb cgroupfs
628 0xff534d42 cifs
629 0x73757245 coda
630 0x012ff7b7 coh
631 0x28cd3d45 cramfs
632 0x453dcd28 cramfs-wend (wrong endianness)
633 0x64626720 debugfs
634 0x00001373 devfs
635 0x00001cd1 devpts
636 0x0000f15f ecryptfs
637 0x00414a53 efs
638 0x0000137d ext
639 0x0000ef53 ext2/ext3/ext4
640 0x0000ef51 ext2
641 0xf2f52010 f2fs
642 0x00004006 fat
643 0x65735546 fuseblk
644 0x65735543 fusectl
645 0x0bad1dea futexfs
646 0x01161970 gfs2
647 0x47504653 gpfs
648 0x00004244 hfs
649 0xf995e849 hpfs
650 0x00c0ffee hostfs
651 0x958458f6 hugetlbfs
652 0x2bad1dea inotifyfs
653 0x00009660 isofs
654 0x000072b6 jffs2
655 0x3153464a jfs
656 0x6b414653 k-afs
657 0x0bd00bd0 lustre
658 0x0000137f minix
659 0x0000138f minix 30 char names
660 0x00002468 minix v2
661 0x00002478 minix v2 30 char names
662 0x00004d5a minix v3
663 0x19800202 mqueue
664 0x00004d44 msdos
665 0x0000564c novell
666 0x00006969 nfs
667 0x6e667364 nfsd
668 0x00003434 nilfs
669 0x5346544e ntfs
670 0x00009fa1 openprom
671 0x7461636F ocfs2
672 0x00009fa0 proc
673 0x6165676c pstorefs
674 0x0000002f qnx4
675 0x68191122 qnx6
676 0x858458f6 ramfs
677 0x52654973 reiserfs
678 0x00007275 romfs
679 0x67596969 rpc_pipefs
680 0x73636673 securityfs
681 0xf97cff8c selinux
682 0x0000517b smb
683 0x534f434b sockfs
684 0x73717368 squashfs
685 0x62656572 sysfs
686 0x012ff7b6 sysv2
687 0x012ff7b5 sysv4
688 0x01021994 tmpfs
689 0x15013346 udf
690 0x00011954 ufs
691 0x54190100 ufs byteswapped
692 0x00009fa2 usbdevfs
693 0x01021997 v9fs
694 0xa501fcf5 vxfs
695 0xabba1974 xenfs
696 0x012ff7b4 xenix
697 0x58465342 xfs
698 0x012fd16d xia
574 699
575=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 700=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
576 701
577Works like perl's C<utime> function (including the special case of $atime 702Works like perl's C<utime> function (including the special case of $atime
578and $mtime being undef). Fractional times are supported if the underlying 703and $mtime being undef). Fractional times are supported if the underlying
606=item aio_truncate $fh_or_path, $offset, $callback->($status) 731=item aio_truncate $fh_or_path, $offset, $callback->($status)
607 732
608Works like truncate(2) or ftruncate(2). 733Works like truncate(2) or ftruncate(2).
609 734
610 735
736=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
737
738Allocates or frees disk space according to the C<$mode> argument. See the
739linux C<fallocate> documentation for details.
740
741C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
742space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>,
743to deallocate a file range.
744
745IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
746(without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range,
747C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE>
748to unshare shared blocks (see your L<fallocate(2)> manpage).
749
750The file system block size used by C<fallocate> is presumably the
751C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes
752can dictate other limitations.
753
754If C<fallocate> isn't available or cannot be emulated (currently no
755emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
756
757
611=item aio_chmod $fh_or_path, $mode, $callback->($status) 758=item aio_chmod $fh_or_path, $mode, $callback->($status)
612 759
613Works like perl's C<chmod> function. 760Works like perl's C<chmod> function.
614 761
615 762
652 799
653 800
654=item aio_realpath $pathname, $callback->($path) 801=item aio_realpath $pathname, $callback->($path)
655 802
656Asynchronously make the path absolute and resolve any symlinks in 803Asynchronously make the path absolute and resolve any symlinks in
657C<$path>. The resulting path only consists of directories (Same as 804C<$path>. The resulting path only consists of directories (same as
658L<Cwd::realpath>). 805L<Cwd::realpath>).
659 806
660This request can be used to get the absolute path of the current working 807This request can be used to get the absolute path of the current working
661directory by passing it a path of F<.> (a single dot). 808directory by passing it a path of F<.> (a single dot).
662 809
663 810
664=item aio_rename $srcpath, $dstpath, $callback->($status) 811=item aio_rename $srcpath, $dstpath, $callback->($status)
665 812
666Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 813Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
667rename(2) and call the callback with the result code. 814rename(2) and call the callback with the result code.
815
816On systems that support the AIO::WD working directory abstraction
817natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
818of failing, C<rename> is called on the absolute path of C<$wd>.
819
820
821=item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
822
823Basically a version of C<aio_rename> with an additional C<$flags>
824argument. Calling this with C<$flags=0> is the same as calling
825C<aio_rename>.
826
827Non-zero flags are currently only supported on GNU/Linux systems that
828support renameat2. Other systems fail with C<ENOSYS> in this case.
829
830The following constants are available (missing ones are, as usual C<0>),
831see renameat2(2) for details:
832
833C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE>
834and C<IO::AIO::RENAME_WHITEOUT>.
668 835
669 836
670=item aio_mkdir $pathname, $mode, $callback->($status) 837=item aio_mkdir $pathname, $mode, $callback->($status)
671 838
672Asynchronously mkdir (create) a directory and call the callback with 839Asynchronously mkdir (create) a directory and call the callback with
676 843
677=item aio_rmdir $pathname, $callback->($status) 844=item aio_rmdir $pathname, $callback->($status)
678 845
679Asynchronously rmdir (delete) a directory and call the callback with the 846Asynchronously rmdir (delete) a directory and call the callback with the
680result code. 847result code.
848
849On systems that support the AIO::WD working directory abstraction
850natively, the case C<[$wd, "."]> is specialcased - instead of failing,
851C<rmdir> is called on the absolute path of C<$wd>.
681 852
682 853
683=item aio_readdir $pathname, $callback->($entries) 854=item aio_readdir $pathname, $callback->($entries)
684 855
685Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 856Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
787=item aio_copy $srcpath, $dstpath, $callback->($status) 958=item aio_copy $srcpath, $dstpath, $callback->($status)
788 959
789Try to copy the I<file> (directories not supported as either source or 960Try to copy the I<file> (directories not supported as either source or
790destination) from C<$srcpath> to C<$dstpath> and call the callback with 961destination) from C<$srcpath> to C<$dstpath> and call the callback with
791a status of C<0> (ok) or C<-1> (error, see C<$!>). 962a status of C<0> (ok) or C<-1> (error, see C<$!>).
963
964Existing destination files will be truncated.
792 965
793This is a composite request that creates the destination file with 966This is a composite request that creates the destination file with
794mode 0200 and copies the contents of the source file into it using 967mode 0200 and copies the contents of the source file into it using
795C<aio_sendfile>, followed by restoring atime, mtime, access mode and 968C<aio_sendfile>, followed by restoring atime, mtime, access mode and
796uid/gid, in that order. 969uid/gid, in that order.
906Scans a directory (similar to C<aio_readdir>) but additionally tries to 1079Scans a directory (similar to C<aio_readdir>) but additionally tries to
907efficiently separate the entries of directory C<$path> into two sets of 1080efficiently separate the entries of directory C<$path> into two sets of
908names, directories you can recurse into (directories), and ones you cannot 1081names, directories you can recurse into (directories), and ones you cannot
909recurse into (everything else, including symlinks to directories). 1082recurse into (everything else, including symlinks to directories).
910 1083
911C<aio_scandir> is a composite request that creates of many sub requests_ 1084C<aio_scandir> is a composite request that generates many sub requests.
912C<$maxreq> specifies the maximum number of outstanding aio requests that 1085C<$maxreq> specifies the maximum number of outstanding aio requests that
913this function generates. If it is C<< <= 0 >>, then a suitable default 1086this function generates. If it is C<< <= 0 >>, then a suitable default
914will be chosen (currently 4). 1087will be chosen (currently 4).
915 1088
916On error, the callback is called without arguments, otherwise it receives 1089On error, the callback is called without arguments, otherwise it receives
966 1139
967 my $grp = aio_group $cb; 1140 my $grp = aio_group $cb;
968 1141
969 $maxreq = 4 if $maxreq <= 0; 1142 $maxreq = 4 if $maxreq <= 0;
970 1143
971 # stat once 1144 # get a wd object
972 aioreq_pri $pri; 1145 aioreq_pri $pri;
973 add $grp aio_stat $path, sub { 1146 add $grp aio_wd $path, sub {
1147 $_[0]
974 return $grp->result () if $_[0]; 1148 or return $grp->result ();
975 my $now = time;
976 my $hash1 = join ":", (stat _)[0,1,3,7,9];
977 1149
978 # read the directory entries 1150 my $wd = [shift, "."];
1151
1152 # stat once
979 aioreq_pri $pri; 1153 aioreq_pri $pri;
980 add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { 1154 add $grp aio_stat $wd, sub {
981 my $entries = shift
982 or return $grp->result (); 1155 return $grp->result () if $_[0];
1156 my $now = time;
1157 my $hash1 = join ":", (stat _)[0,1,3,7,9];
983 1158
984 # stat the dir another time 1159 # read the directory entries
985 aioreq_pri $pri; 1160 aioreq_pri $pri;
1161 add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
1162 my $entries = shift
1163 or return $grp->result ();
1164
1165 # stat the dir another time
1166 aioreq_pri $pri;
986 add $grp aio_stat $path, sub { 1167 add $grp aio_stat $wd, sub {
987 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 1168 my $hash2 = join ":", (stat _)[0,1,3,7,9];
988 1169
989 my $ndirs; 1170 my $ndirs;
990 1171
991 # take the slow route if anything looks fishy 1172 # take the slow route if anything looks fishy
992 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 1173 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
993 $ndirs = -1; 1174 $ndirs = -1;
994 } else { 1175 } else {
995 # if nlink == 2, we are finished 1176 # if nlink == 2, we are finished
996 # for non-posix-fs's, we rely on nlink < 2 1177 # for non-posix-fs's, we rely on nlink < 2
997 $ndirs = (stat _)[3] - 2 1178 $ndirs = (stat _)[3] - 2
998 or return $grp->result ([], $entries); 1179 or return $grp->result ([], $entries);
999 } 1180 }
1000 1181
1001 my (@dirs, @nondirs); 1182 my (@dirs, @nondirs);
1002 1183
1003 my $statgrp = add $grp aio_group sub { 1184 my $statgrp = add $grp aio_group sub {
1004 $grp->result (\@dirs, \@nondirs); 1185 $grp->result (\@dirs, \@nondirs);
1005 }; 1186 };
1006 1187
1007 limit $statgrp $maxreq; 1188 limit $statgrp $maxreq;
1008 feed $statgrp sub { 1189 feed $statgrp sub {
1009 return unless @$entries; 1190 return unless @$entries;
1010 my $entry = shift @$entries; 1191 my $entry = shift @$entries;
1011 1192
1012 aioreq_pri $pri; 1193 aioreq_pri $pri;
1194 $wd->[1] = "$entry/.";
1013 add $statgrp aio_stat "$path/$entry/.", sub { 1195 add $statgrp aio_stat $wd, sub {
1014 if ($_[0] < 0) { 1196 if ($_[0] < 0) {
1015 push @nondirs, $entry; 1197 push @nondirs, $entry;
1016 } else { 1198 } else {
1017 # need to check for real directory 1199 # need to check for real directory
1018 aioreq_pri $pri; 1200 aioreq_pri $pri;
1201 $wd->[1] = $entry;
1019 add $statgrp aio_lstat "$path/$entry", sub { 1202 add $statgrp aio_lstat $wd, sub {
1020 if (-d _) { 1203 if (-d _) {
1021 push @dirs, $entry; 1204 push @dirs, $entry;
1022 1205
1023 unless (--$ndirs) { 1206 unless (--$ndirs) {
1024 push @nondirs, @$entries; 1207 push @nondirs, @$entries;
1025 feed $statgrp; 1208 feed $statgrp;
1209 }
1210 } else {
1211 push @nondirs, $entry;
1026 } 1212 }
1027 } else {
1028 push @nondirs, $entry;
1029 } 1213 }
1030 } 1214 }
1031 } 1215 };
1032 }; 1216 };
1033 }; 1217 };
1034 }; 1218 };
1035 }; 1219 };
1036 }; 1220 };
1039} 1223}
1040 1224
1041=item aio_rmtree $pathname, $callback->($status) 1225=item aio_rmtree $pathname, $callback->($status)
1042 1226
1043Delete a directory tree starting (and including) C<$path>, return the 1227Delete a directory tree starting (and including) C<$path>, return the
1044status of the final C<rmdir> only. This is a composite request that 1228status of the final C<rmdir> only. This is a composite request that
1045uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1229uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1046everything else. 1230everything else.
1047 1231
1048=cut 1232=cut
1049 1233
1070 add $grp $dirgrp; 1254 add $grp $dirgrp;
1071 }; 1255 };
1072 1256
1073 $grp 1257 $grp
1074} 1258}
1259
1260=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
1261
1262=item aio_ioctl $fh, $request, $buf, $callback->($status)
1263
1264These work just like the C<fcntl> and C<ioctl> built-in functions, except
1265they execute asynchronously and pass the return value to the callback.
1266
1267Both calls can be used for a lot of things, some of which make more sense
1268to run asynchronously in their own thread, while some others make less
1269sense. For example, calls that block waiting for external events, such
1270as locking, will also lock down an I/O thread while it is waiting, which
1271can deadlock the whole I/O system. At the same time, there might be no
1272alternative to using a thread to wait.
1273
1274So in general, you should only use these calls for things that do
1275(filesystem) I/O, not for things that wait for other events (network,
1276other processes), although if you are careful and know what you are doing,
1277you still can.
1278
1279The following constants are available (missing ones are, as usual C<0>):
1280
1281C<F_DUPFD_CLOEXEC>,
1282
1283C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
1284
1285C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
1286
1287C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
1288C<FS_IOC_FIEMAP>.
1289
1290C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
1291C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
1292
1293C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
1294C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
1295C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
1296C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
1297C<FS_FL_USER_MODIFIABLE>.
1298
1299C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
1300C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
1301C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
1302C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
1075 1303
1076=item aio_sync $callback->($status) 1304=item aio_sync $callback->($status)
1077 1305
1078Asynchronously call sync and call the callback when finished. 1306Asynchronously call sync and call the callback when finished.
1079 1307
1148 }; 1376 };
1149 1377
1150 $grp 1378 $grp
1151} 1379}
1152 1380
1153=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 1381=item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
1154 1382
1155This is a rather advanced IO::AIO call, which only works on mmap(2)ed 1383This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1156scalars (see the C<IO::AIO::mmap> function, although it also works on data 1384scalars (see the C<IO::AIO::mmap> function, although it also works on data
1157scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the 1385scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1158scalar must only be modified in-place while an aio operation is pending on 1386scalar must only be modified in-place while an aio operation is pending on
1160 1388
1161It calls the C<msync> function of your OS, if available, with the memory 1389It calls the C<msync> function of your OS, if available, with the memory
1162area starting at C<$offset> in the string and ending C<$length> bytes 1390area starting at C<$offset> in the string and ending C<$length> bytes
1163later. If C<$length> is negative, counts from the end, and if C<$length> 1391later. If C<$length> is negative, counts from the end, and if C<$length>
1164is C<undef>, then it goes till the end of the string. The flags can be 1392is C<undef>, then it goes till the end of the string. The flags can be
1165a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and 1393either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional
1166C<IO::AIO::MS_SYNC>. 1394C<IO::AIO::MS_INVALIDATE>.
1167 1395
1168=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 1396=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1169 1397
1170This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1398This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1171scalars. 1399scalars.
1172 1400
1173It touches (reads or writes) all memory pages in the specified 1401It touches (reads or writes) all memory pages in the specified
1174range inside the scalar. All caveats and parameters are the same 1402range inside the scalar. All caveats and parameters are the same
1175as for C<aio_msync>, above, except for flags, which must be either 1403as for C<aio_msync>, above, except for flags, which must be either
1176C<0> (which reads all pages and ensures they are instantiated) or 1404C<0> (which reads all pages and ensures they are instantiated) or
1177C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and 1405C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1178writing an octet from it, which dirties the page). 1406writing an octet from it, which dirties the page).
1179 1407
1180=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 1408=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1181 1409
1182This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1410This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1213documented under L<MISCELLANEOUS FUNCTIONS>. 1441documented under L<MISCELLANEOUS FUNCTIONS>.
1214 1442
1215Example: asynchronously lock all current and future pages into memory. 1443Example: asynchronously lock all current and future pages into memory.
1216 1444
1217 aio_mlockall IO::AIO::MCL_FUTURE; 1445 aio_mlockall IO::AIO::MCL_FUTURE;
1446
1447=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1448
1449Queries the extents of the given file (by calling the Linux C<FIEMAP>
1450ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1451the ioctl is not available on your OS, then this request will fail with
1452C<ENOSYS>.
1453
1454C<$start> is the starting offset to query extents for, C<$length> is the
1455size of the range to query - if it is C<undef>, then the whole file will
1456be queried.
1457
1458C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
1459C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1460exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1461the data portion.
1462
1463C<$count> is the maximum number of extent records to return. If it is
1464C<undef>, then IO::AIO queries all extents of the range. As a very special
1465case, if it is C<0>, then the callback receives the number of extents
1466instead of the extents themselves (which is unreliable, see below).
1467
1468If an error occurs, the callback receives no arguments. The special
1469C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1470
1471Otherwise, the callback receives an array reference with extent
1472structures. Each extent structure is an array reference itself, with the
1473following members:
1474
1475 [$logical, $physical, $length, $flags]
1476
1477Flags is any combination of the following flag values (typically either C<0>
1478or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1479
1480C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1481C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1482C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1483C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1484C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1485C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1486
1487At the time of this writing (Linux 3.2), this requets is unreliable unless
1488C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1489it to return all extents of a range for files with large number of
1490extents. The code works around all these issues if C<$count> is undef.
1218 1491
1219=item aio_group $callback->(...) 1492=item aio_group $callback->(...)
1220 1493
1221This is a very special aio request: Instead of doing something, it is a 1494This is a very special aio request: Instead of doing something, it is a
1222container for other aio requests, which is useful if you want to bundle 1495container for other aio requests, which is useful if you want to bundle
1286object. This object stores the canonicalised, absolute version of the 1559object. This object stores the canonicalised, absolute version of the
1287path, and on systems that allow it, also a directory file descriptor. 1560path, and on systems that allow it, also a directory file descriptor.
1288 1561
1289Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat> 1562Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
1290or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD 1563or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
1291object and a pathname instead. If the pathname is absolute, the 1564object and a pathname instead (or the IO::AIO::WD object alone, which
1565gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
1292IO::AIO::WD objetc is ignored, otherwise the pathname is resolved relative 1566IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
1293to that IO::AIO::WD object. 1567to that IO::AIO::WD object.
1294 1568
1295For example, to get a wd object for F</etc> and then stat F<passwd> 1569For example, to get a wd object for F</etc> and then stat F<passwd>
1296inside, you would write: 1570inside, you would write:
1297 1571
1305 aio_stat [$etcdir, "passwd"], sub { 1579 aio_stat [$etcdir, "passwd"], sub {
1306 # yay 1580 # yay
1307 }; 1581 };
1308 }; 1582 };
1309 1583
1584The fact that C<aio_wd> is a request and not a normal function shows that
1310This shows that creating an IO::AIO::WD object is itself a potentially 1585creating an IO::AIO::WD object is itself a potentially blocking operation,
1311blocking operation, which is why it is done asynchronously. 1586which is why it is done asynchronously.
1587
1588To stat the directory obtained with C<aio_wd> above, one could write
1589either of the following three request calls:
1590
1591 aio_lstat "/etc" , sub { ... # pathname as normal string
1592 aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
1593 aio_lstat $wd , sub { ... # shorthand for the previous
1312 1594
1313As with normal pathnames, IO::AIO keeps a copy of the working directory 1595As with normal pathnames, IO::AIO keeps a copy of the working directory
1314object and the pathname string, so you could write the following without 1596object and the pathname string, so you could write the following without
1315causing any issues due to C<$path> getting reused: 1597causing any issues due to C<$path> getting reused:
1316 1598
1326There are some caveats: when directories get renamed (or deleted), the 1608There are some caveats: when directories get renamed (or deleted), the
1327pathname string doesn't change, so will point to the new directory (or 1609pathname string doesn't change, so will point to the new directory (or
1328nowhere at all), while the directory fd, if available on the system, 1610nowhere at all), while the directory fd, if available on the system,
1329will still point to the original directory. Most functions accepting a 1611will still point to the original directory. Most functions accepting a
1330pathname will use the directory fd on newer systems, and the string on 1612pathname will use the directory fd on newer systems, and the string on
1331older systems. Some functions (such as realpath) will always rely on the 1613older systems. Some functions (such as C<aio_realpath>) will always rely on
1332string form of the pathname. 1614the string form of the pathname.
1333 1615
1334So this fucntionality is mainly useful to get some protection against 1616So this functionality is mainly useful to get some protection against
1335C<chdir>, to easily get an absolute path out of a relative path for future 1617C<chdir>, to easily get an absolute path out of a relative path for future
1336reference, and to speed up doing many operations in the same directory 1618reference, and to speed up doing many operations in the same directory
1337(e.g. when stat'ing all files in a directory). 1619(e.g. when stat'ing all files in a directory).
1338 1620
1339The following functions implement this working directory abstraction: 1621The following functions implement this working directory abstraction:
1352passing C<undef> as working directory component of a pathname fails the 1634passing C<undef> as working directory component of a pathname fails the
1353request with C<ENOENT>, there is often no need for error checking in the 1635request with C<ENOENT>, there is often no need for error checking in the
1354C<aio_wd> callback, as future requests using the value will fail in the 1636C<aio_wd> callback, as future requests using the value will fail in the
1355expected way. 1637expected way.
1356 1638
1357If this call isn't available because your OS lacks it or it couldn't be
1358detected, it will be emulated by calling C<fsync> instead.
1359
1360=item IO::AIO::CWD 1639=item IO::AIO::CWD
1361 1640
1362This is a compiletime constant (object) that represents the process 1641This is a compiletime constant (object) that represents the process
1363current working directory. 1642current working directory.
1364 1643
1365Specifying this object as working directory object for a pathname is as 1644Specifying this object as working directory object for a pathname is as if
1366if the pathname would be specified directly, without a directory object, 1645the pathname would be specified directly, without a directory object. For
1367e.g., these calls are functionally identical: 1646example, these calls are functionally identical:
1368 1647
1369 aio_stat "somefile", sub { ... }; 1648 aio_stat "somefile", sub { ... };
1370 aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; 1649 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1371 1650
1372=back 1651=back
1373 1652
1653To recover the path associated with an IO::AIO::WD object, you can use
1654C<aio_realpath>:
1655
1656 aio_realpath $wd, sub {
1657 warn "path is $_[0]\n";
1658 };
1659
1660Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
1661sometimes, fall back to using an absolue path.
1374 1662
1375=head2 IO::AIO::REQ CLASS 1663=head2 IO::AIO::REQ CLASS
1376 1664
1377All non-aggregate C<aio_*> functions return an object of this class when 1665All non-aggregate C<aio_*> functions return an object of this class when
1378called in non-void context. 1666called in non-void context.
1496 1784
1497Sets a feeder/generator on this group: every group can have an attached 1785Sets a feeder/generator on this group: every group can have an attached
1498generator that generates requests if idle. The idea behind this is that, 1786generator that generates requests if idle. The idea behind this is that,
1499although you could just queue as many requests as you want in a group, 1787although you could just queue as many requests as you want in a group,
1500this might starve other requests for a potentially long time. For example, 1788this might starve other requests for a potentially long time. For example,
1501C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, 1789C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1502delaying any later requests for a long time. 1790requests, delaying any later requests for a long time.
1503 1791
1504To avoid this, and allow incremental generation of requests, you can 1792To avoid this, and allow incremental generation of requests, you can
1505instead a group and set a feeder on it that generates those requests. The 1793instead a group and set a feeder on it that generates those requests. The
1506feed callback will be called whenever there are few enough (see C<limit>, 1794feed callback will be called whenever there are few enough (see C<limit>,
1507below) requests active in the group itself and is expected to queue more 1795below) requests active in the group itself and is expected to queue more
1556 1844
1557See C<poll_cb> for an example. 1845See C<poll_cb> for an example.
1558 1846
1559=item IO::AIO::poll_cb 1847=item IO::AIO::poll_cb
1560 1848
1561Process some outstanding events on the result pipe. You have to call 1849Process some requests that have reached the result phase (i.e. they have
1850been executed but the results are not yet reported). You have to call
1851this "regularly" to finish outstanding requests.
1852
1562this regularly. Returns C<0> if all events could be processed (or there 1853Returns C<0> if all events could be processed (or there were no
1563were no events to process), or C<-1> if it returned earlier for whatever 1854events to process), or C<-1> if it returned earlier for whatever
1564reason. Returns immediately when no events are outstanding. The amount of 1855reason. Returns immediately when no events are outstanding. The amount
1565events processed depends on the settings of C<IO::AIO::max_poll_req> and 1856of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1566C<IO::AIO::max_poll_time>. 1857C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1567 1858
1568If not all requests were processed for whatever reason, the filehandle 1859If not all requests were processed for whatever reason, the poll file
1569will still be ready when C<poll_cb> returns, so normally you don't have to 1860descriptor will still be ready when C<poll_cb> returns, so normally you
1570do anything special to have it called later. 1861don't have to do anything special to have it called later.
1571 1862
1572Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes 1863Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1573ready, it can be beneficial to call this function from loops which submit 1864ready, it can be beneficial to call this function from loops which submit
1574a lot of requests, to make sure the results get processed when they become 1865a lot of requests, to make sure the results get processed when they become
1575available and not just when the loop is finished and the event loop takes 1866available and not just when the loop is finished and the event loop takes
1584 poll => 'r', async => 1, 1875 poll => 'r', async => 1,
1585 cb => \&IO::AIO::poll_cb); 1876 cb => \&IO::AIO::poll_cb);
1586 1877
1587=item IO::AIO::poll_wait 1878=item IO::AIO::poll_wait
1588 1879
1589If there are any outstanding requests and none of them in the result 1880Wait until either at least one request is in the result phase or no
1590phase, wait till the result filehandle becomes ready for reading (simply 1881requests are outstanding anymore.
1591does a C<select> on the filehandle. This is useful if you want to 1882
1592synchronously wait for some requests to finish). 1883This is useful if you want to synchronously wait for some requests to
1884become ready, without actually handling them.
1593 1885
1594See C<nreqs> for an example. 1886See C<nreqs> for an example.
1595 1887
1596=item IO::AIO::poll 1888=item IO::AIO::poll
1597 1889
1718 2010
1719This is a very bad function to use in interactive programs because it 2011This is a very bad function to use in interactive programs because it
1720blocks, and a bad way to reduce concurrency because it is inexact: Better 2012blocks, and a bad way to reduce concurrency because it is inexact: Better
1721use an C<aio_group> together with a feed callback. 2013use an C<aio_group> together with a feed callback.
1722 2014
1723It's main use is in scripts without an event loop - when you want to stat 2015Its main use is in scripts without an event loop - when you want to stat
1724a lot of files, you can write somehting like this: 2016a lot of files, you can write something like this:
1725 2017
1726 IO::AIO::max_outstanding 32; 2018 IO::AIO::max_outstanding 32;
1727 2019
1728 for my $path (...) { 2020 for my $path (...) {
1729 aio_stat $path , ...; 2021 aio_stat $path , ...;
1768 2060
1769=back 2061=back
1770 2062
1771=head3 MISCELLANEOUS FUNCTIONS 2063=head3 MISCELLANEOUS FUNCTIONS
1772 2064
1773IO::AIO implements some functions that might be useful, but are not 2065IO::AIO implements some functions that are useful when you want to use
1774asynchronous. 2066some "Advanced I/O" function not available to in Perl, without going the
2067"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
2068counterpart.
1775 2069
1776=over 4 2070=over 4
2071
2072=item $numfd = IO::AIO::get_fdlimit
2073
2074Tries to find the current file descriptor limit and returns it, or
2075C<undef> and sets C<$!> in case of an error. The limit is one larger than
2076the highest valid file descriptor number.
2077
2078=item IO::AIO::min_fdlimit [$numfd]
2079
2080Try to increase the current file descriptor limit(s) to at least C<$numfd>
2081by changing the soft or hard file descriptor resource limit. If C<$numfd>
2082is missing, it will try to set a very high limit, although this is not
2083recommended when you know the actual minimum that you require.
2084
2085If the limit cannot be raised enough, the function makes a best-effort
2086attempt to increase the limit as much as possible, using various
2087tricks, while still failing. You can query the resulting limit using
2088C<IO::AIO::get_fdlimit>.
2089
2090If an error occurs, returns C<undef> and sets C<$!>, otherwise returns
2091true.
1777 2092
1778=item IO::AIO::sendfile $ofh, $ifh, $offset, $count 2093=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1779 2094
1780Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, 2095Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
1781but is blocking (this makes most sense if you know the input data is 2096but is blocking (this makes most sense if you know the input data is
1798=item IO::AIO::madvise $scalar, $offset, $len, $advice 2113=item IO::AIO::madvise $scalar, $offset, $len, $advice
1799 2114
1800Simply calls the C<posix_madvise> function (see its 2115Simply calls the C<posix_madvise> function (see its
1801manpage for details). The following advice constants are 2116manpage for details). The following advice constants are
1802available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, 2117available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1803C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. 2118C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>,
2119C<IO::AIO::MADV_DONTNEED>.
2120
2121If C<$offset> is negative, counts from the end. If C<$length> is negative,
2122the remaining length of the C<$scalar> is used. If possible, C<$length>
2123will be reduced to fit into the C<$scalar>.
1804 2124
1805On systems that do not implement C<posix_madvise>, this function returns 2125On systems that do not implement C<posix_madvise>, this function returns
1806ENOSYS, otherwise the return value of C<posix_madvise>. 2126ENOSYS, otherwise the return value of C<posix_madvise>.
1807 2127
1808=item IO::AIO::mprotect $scalar, $offset, $len, $protect 2128=item IO::AIO::mprotect $scalar, $offset, $len, $protect
1810Simply calls the C<mprotect> function on the preferably AIO::mmap'ed 2130Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1811$scalar (see its manpage for details). The following protect 2131$scalar (see its manpage for details). The following protect
1812constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, 2132constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1813C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. 2133C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1814 2134
2135If C<$offset> is negative, counts from the end. If C<$length> is negative,
2136the remaining length of the C<$scalar> is used. If possible, C<$length>
2137will be reduced to fit into the C<$scalar>.
2138
1815On systems that do not implement C<mprotect>, this function returns 2139On systems that do not implement C<mprotect>, this function returns
1816ENOSYS, otherwise the return value of C<mprotect>. 2140ENOSYS, otherwise the return value of C<mprotect>.
1817 2141
1818=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 2142=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1819 2143
1820Memory-maps a file (or anonymous memory range) and attaches it to the 2144Memory-maps a file (or anonymous memory range) and attaches it to the
1821given C<$scalar>, which will act like a string scalar. 2145given C<$scalar>, which will act like a string scalar. Returns true on
2146success, and false otherwise.
1822 2147
2148The scalar must exist, but its contents do not matter - this means you
2149cannot use a nonexistant array or hash element. When in doubt, C<undef>
2150the scalar first.
2151
1823The only operations allowed on the scalar are C<substr>/C<vec> that don't 2152The only operations allowed on the mmapped scalar are C<substr>/C<vec>,
1824change the string length, and most read-only operations such as copying it 2153which don't change the string length, and most read-only operations such
1825or searching it with regexes and so on. 2154as copying it or searching it with regexes and so on.
1826 2155
1827Anything else is unsafe and will, at best, result in memory leaks. 2156Anything else is unsafe and will, at best, result in memory leaks.
1828 2157
1829The memory map associated with the C<$scalar> is automatically removed 2158The memory map associated with the C<$scalar> is automatically removed
1830when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or 2159when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap>
1831C<IO::AIO::munmap> functions are called. 2160or C<IO::AIO::munmap> functions are called on it.
1832 2161
1833This calls the C<mmap>(2) function internally. See your system's manual 2162This calls the C<mmap>(2) function internally. See your system's manual
1834page for details on the C<$length>, C<$prot> and C<$flags> parameters. 2163page for details on the C<$length>, C<$prot> and C<$flags> parameters.
1835 2164
1836The C<$length> must be larger than zero and smaller than the actual 2165The C<$length> must be larger than zero and smaller than the actual
1837filesize. 2166filesize.
1838 2167
1839C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, 2168C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1840C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, 2169C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1841 2170
1842C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or 2171C<$flags> can be a combination of
1843C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when 2172C<IO::AIO::MAP_SHARED> or
1844not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS> 2173C<IO::AIO::MAP_PRIVATE>,
2174or a number of system-specific flags (when not available, the are C<0>):
1845(which is set to C<MAP_ANON> if your system only provides this 2175C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
1846constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>, 2176C<IO::AIO::MAP_LOCKED>,
1847C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or 2177C<IO::AIO::MAP_NORESERVE>,
2178C<IO::AIO::MAP_POPULATE>,
1848C<IO::AIO::MAP_NONBLOCK> 2179C<IO::AIO::MAP_NONBLOCK>,
2180C<IO::AIO::MAP_FIXED>,
2181C<IO::AIO::MAP_GROWSDOWN>,
2182C<IO::AIO::MAP_32BIT>,
2183C<IO::AIO::MAP_HUGETLB> or
2184C<IO::AIO::MAP_STACK>.
1849 2185
1850If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. 2186If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1851 2187
1852C<$offset> is the offset from the start of the file - it generally must be 2188C<$offset> is the offset from the start of the file - it generally must be
1853a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. 2189a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
1878 2214
1879Calls the C<munlockall> function. 2215Calls the C<munlockall> function.
1880 2216
1881On systems that do not implement C<munlockall>, this function returns 2217On systems that do not implement C<munlockall>, this function returns
1882ENOSYS, otherwise the return value of C<munlockall>. 2218ENOSYS, otherwise the return value of C<munlockall>.
2219
2220=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
2221
2222Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
2223C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
2224should be the file offset.
2225
2226C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2227silently corrupt the data in this case.
2228
2229The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
2230C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
2231C<IO::AIO::SPLICE_F_GIFT>.
2232
2233See the C<splice(2)> manpage for details.
2234
2235=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2236
2237Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
2238description for C<IO::AIO::splice> above for details.
2239
2240=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
2241
2242Attempts to query or change the pipe buffer size. Obviously works only
2243on pipes, and currently works only on GNU/Linux systems, and fails with
2244C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
2245size on other systems, drop me a note.
2246
2247=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
2248
2249This is a direct interface to the Linux L<pipe2(2)> system call. If
2250C<$flags> is missing or C<0>, then this should be the same as a call to
2251perl's built-in C<pipe> function and create a new pipe, and works on
2252systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
2253(..., 4096, O_BINARY)>.
2254
2255If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
2256the given flags (Linux 2.6.27, glibc 2.9).
2257
2258On success, the read and write file handles are returned.
2259
2260On error, nothing will be returned. If the pipe2 syscall is missing and
2261C<$flags> is non-zero, fails with C<ENOSYS>.
2262
2263Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
2264time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
2265C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
1883 2266
1884=back 2267=back
1885 2268
1886=cut 2269=cut
1887 2270

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines