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.184 by root, Mon Nov 1 22:03:43 2010 UTC vs.
Revision 1.245 by root, Sat Jan 25 00:15:52 2014 UTC

68=head2 EXAMPLE 68=head2 EXAMPLE
69 69
70This is a simple example that uses the EV module and loads 70This is a simple example that uses the EV module and loads
71F</etc/passwd> asynchronously: 71F</etc/passwd> asynchronously:
72 72
73 use Fcntl;
74 use EV; 73 use EV;
75 use IO::AIO; 74 use IO::AIO;
76 75
77 # register the IO::AIO callback with EV 76 # register the IO::AIO callback with EV
78 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; 77 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
168use common::sense; 167use common::sense;
169 168
170use base 'Exporter'; 169use base 'Exporter';
171 170
172BEGIN { 171BEGIN {
173 our $VERSION = '3.7'; 172 our $VERSION = 4.2;
174 173
175 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close 174 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx 175 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
177 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync 176 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync
178 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead 177 aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate
178 aio_pathsync aio_readahead aio_fiemap
179 aio_rename aio_link aio_move aio_copy aio_group 179 aio_rename aio_link aio_move aio_copy aio_group
180 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 180 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
181 aio_chmod aio_utime aio_truncate 181 aio_chmod aio_utime aio_truncate
182 aio_msync aio_mtouch aio_mlock aio_mlockall 182 aio_msync aio_mtouch aio_mlock aio_mlockall
183 aio_statvfs); 183 aio_statvfs
184 aio_wd);
184 185
185 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 186 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
186 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 187 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
187 min_parallel max_parallel max_idle 188 min_parallel max_parallel max_idle idle_timeout
188 nreqs nready npending nthreads 189 nreqs nready npending nthreads
189 max_poll_time max_poll_reqs 190 max_poll_time max_poll_reqs
190 sendfile fadvise madvise 191 sendfile fadvise madvise
191 mmap munmap munlock munlockall); 192 mmap munmap munlock munlockall);
192 193
200 201
201=head1 FUNCTIONS 202=head1 FUNCTIONS
202 203
203=head2 QUICK OVERVIEW 204=head2 QUICK OVERVIEW
204 205
205This section simply lists the prototypes of the most important functions 206This section simply lists the prototypes most of the functions for
206for quick reference. See the following sections for function-by-function 207quick reference. See the following sections for function-by-function
207documentation. 208documentation.
208 209
210 aio_wd $pathname, $callback->($wd)
209 aio_open $pathname, $flags, $mode, $callback->($fh) 211 aio_open $pathname, $flags, $mode, $callback->($fh)
210 aio_close $fh, $callback->($status) 212 aio_close $fh, $callback->($status)
213 aio_seek $fh,$offset,$whence, $callback->($offs)
211 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 214 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
212 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 215 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
213 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 216 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
214 aio_readahead $fh,$offset,$length, $callback->($retval) 217 aio_readahead $fh,$offset,$length, $callback->($retval)
215 aio_stat $fh_or_path, $callback->($status) 218 aio_stat $fh_or_path, $callback->($status)
216 aio_lstat $fh, $callback->($status) 219 aio_lstat $fh, $callback->($status)
217 aio_statvfs $fh_or_path, $callback->($statvfs) 220 aio_statvfs $fh_or_path, $callback->($statvfs)
218 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 221 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
219 aio_chown $fh_or_path, $uid, $gid, $callback->($status) 222 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
223 aio_chmod $fh_or_path, $mode, $callback->($status)
220 aio_truncate $fh_or_path, $offset, $callback->($status) 224 aio_truncate $fh_or_path, $offset, $callback->($status)
221 aio_chmod $fh_or_path, $mode, $callback->($status) 225 aio_allocate $fh, $mode, $offset, $len, $callback->($status)
226 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
222 aio_unlink $pathname, $callback->($status) 227 aio_unlink $pathname, $callback->($status)
223 aio_mknod $path, $mode, $dev, $callback->($status) 228 aio_mknod $pathname, $mode, $dev, $callback->($status)
224 aio_link $srcpath, $dstpath, $callback->($status) 229 aio_link $srcpath, $dstpath, $callback->($status)
225 aio_symlink $srcpath, $dstpath, $callback->($status) 230 aio_symlink $srcpath, $dstpath, $callback->($status)
226 aio_readlink $path, $callback->($link) 231 aio_readlink $pathname, $callback->($link)
232 aio_realpath $pathname, $callback->($link)
227 aio_rename $srcpath, $dstpath, $callback->($status) 233 aio_rename $srcpath, $dstpath, $callback->($status)
228 aio_mkdir $pathname, $mode, $callback->($status) 234 aio_mkdir $pathname, $mode, $callback->($status)
229 aio_rmdir $pathname, $callback->($status) 235 aio_rmdir $pathname, $callback->($status)
230 aio_readdir $pathname, $callback->($entries) 236 aio_readdir $pathname, $callback->($entries)
231 aio_readdirx $pathname, $flags, $callback->($entries, $flags) 237 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
232 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST 238 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
233 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN 239 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
240 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
234 aio_load $path, $data, $callback->($status) 241 aio_load $pathname, $data, $callback->($status)
235 aio_copy $srcpath, $dstpath, $callback->($status) 242 aio_copy $srcpath, $dstpath, $callback->($status)
236 aio_move $srcpath, $dstpath, $callback->($status) 243 aio_move $srcpath, $dstpath, $callback->($status)
237 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
238 aio_rmtree $path, $callback->($status) 244 aio_rmtree $pathname, $callback->($status)
239 aio_sync $callback->($status) 245 aio_sync $callback->($status)
246 aio_syncfs $fh, $callback->($status)
240 aio_fsync $fh, $callback->($status) 247 aio_fsync $fh, $callback->($status)
241 aio_fdatasync $fh, $callback->($status) 248 aio_fdatasync $fh, $callback->($status)
242 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 249 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
243 aio_pathsync $path, $callback->($status) 250 aio_pathsync $pathname, $callback->($status)
244 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 251 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
245 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 252 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
246 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 253 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
247 aio_mlockall $flags, $callback->($status) 254 aio_mlockall $flags, $callback->($status)
248 aio_group $callback->(...) 255 aio_group $callback->(...)
258 IO::AIO::max_poll_reqs $nreqs 265 IO::AIO::max_poll_reqs $nreqs
259 IO::AIO::max_poll_time $seconds 266 IO::AIO::max_poll_time $seconds
260 IO::AIO::min_parallel $nthreads 267 IO::AIO::min_parallel $nthreads
261 IO::AIO::max_parallel $nthreads 268 IO::AIO::max_parallel $nthreads
262 IO::AIO::max_idle $nthreads 269 IO::AIO::max_idle $nthreads
270 IO::AIO::idle_timeout $seconds
263 IO::AIO::max_outstanding $maxreqs 271 IO::AIO::max_outstanding $maxreqs
264 IO::AIO::nreqs 272 IO::AIO::nreqs
265 IO::AIO::nready 273 IO::AIO::nready
266 IO::AIO::npending 274 IO::AIO::npending
267 275
268 IO::AIO::sendfile $ofh, $ifh, $offset, $count 276 IO::AIO::sendfile $ofh, $ifh, $offset, $count
269 IO::AIO::fadvise $fh, $offset, $len, $advice 277 IO::AIO::fadvise $fh, $offset, $len, $advice
278 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
279 IO::AIO::munmap $scalar
270 IO::AIO::madvise $scalar, $offset, $length, $advice 280 IO::AIO::madvise $scalar, $offset, $length, $advice
271 IO::AIO::mprotect $scalar, $offset, $length, $protect 281 IO::AIO::mprotect $scalar, $offset, $length, $protect
272 IO::AIO::munlock $scalar, $offset = 0, $length = undef 282 IO::AIO::munlock $scalar, $offset = 0, $length = undef
273 IO::AIO::munlockall 283 IO::AIO::munlockall
274 284
275=head2 AIO REQUEST FUNCTIONS 285=head2 API NOTES
276 286
277All the C<aio_*> calls are more or less thin wrappers around the syscall 287All the C<aio_*> calls are more or less thin wrappers around the syscall
278with the same name (sans C<aio_>). The arguments are similar or identical, 288with the same name (sans C<aio_>). The arguments are similar or identical,
279and they all accept an additional (and optional) C<$callback> argument 289and they all accept an additional (and optional) C<$callback> argument
280which must be a code reference. This code reference will get called with 290which must be a code reference. This code reference will be called after
281the syscall return code (e.g. most syscalls return C<-1> on error, unlike 291the syscall has been executed in an asynchronous fashion. The results
282perl, which usually delivers "false") as its sole argument after the given 292of the request will be passed as arguments to the callback (and, if an
283syscall has been executed asynchronously. 293error occured, in C<$!>) - for most requests the syscall return code (e.g.
294most syscalls return C<-1> on error, unlike perl, which usually delivers
295"false").
296
297Some requests (such as C<aio_readdir>) pass the actual results and
298communicate failures by passing C<undef>.
284 299
285All functions expecting a filehandle keep a copy of the filehandle 300All functions expecting a filehandle keep a copy of the filehandle
286internally until the request has finished. 301internally until the request has finished.
287 302
288All functions return request objects of type L<IO::AIO::REQ> that allow 303All functions return request objects of type L<IO::AIO::REQ> that allow
289further manipulation of those requests while they are in-flight. 304further manipulation of those requests while they are in-flight.
290 305
291The pathnames you pass to these routines I<must> be absolute and 306The pathnames you pass to these routines I<should> be absolute. The
292encoded as octets. The reason for the former is that at the time the 307reason for this is that at the time the request is being executed, the
293request is being executed, the current working directory could have 308current working directory could have changed. Alternatively, you can
294changed. Alternatively, you can make sure that you never change the 309make sure that you never change the current working directory anywhere
295current working directory anywhere in the program and then use relative 310in the program and then use relative paths. You can also take advantage
296paths. 311of IO::AIOs working directory abstraction, that lets you specify paths
312relative to some previously-opened "working directory object" - see the
313description of the C<IO::AIO::WD> class later in this document.
297 314
298To encode pathnames as octets, either make sure you either: a) always pass 315To encode pathnames as octets, either make sure you either: a) always pass
299in filenames you got from outside (command line, readdir etc.) without 316in filenames you got from outside (command line, readdir etc.) without
300tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode 317tinkering, b) are in your native filesystem encoding, c) use the Encode
301your pathnames to the locale (or other) encoding in effect in the user 318module and encode your pathnames to the locale (or other) encoding in
302environment, d) use Glib::filename_from_unicode on unicode filenames or e) 319effect in the user environment, d) use Glib::filename_from_unicode on
303use something else to ensure your scalar has the correct contents. 320unicode filenames or e) use something else to ensure your scalar has the
321correct contents.
304 322
305This works, btw. independent of the internal UTF-8 bit, which IO::AIO 323This works, btw. independent of the internal UTF-8 bit, which IO::AIO
306handles correctly whether it is set or not. 324handles correctly whether it is set or not.
325
326=head2 AIO REQUEST FUNCTIONS
307 327
308=over 4 328=over 4
309 329
310=item $prev_pri = aioreq_pri [$pri] 330=item $prev_pri = aioreq_pri [$pri]
311 331
341 361
342 362
343=item aio_open $pathname, $flags, $mode, $callback->($fh) 363=item aio_open $pathname, $flags, $mode, $callback->($fh)
344 364
345Asynchronously open or create a file and call the callback with a newly 365Asynchronously open or create a file and call the callback with a newly
346created filehandle for the file. 366created filehandle for the file (or C<undef> in case of an error).
347 367
348The pathname passed to C<aio_open> must be absolute. See API NOTES, above, 368The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
349for an explanation. 369for an explanation.
350 370
351The C<$flags> argument is a bitmask. See the C<Fcntl> module for a 371The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
367 } else { 387 } else {
368 die "open failed: $!\n"; 388 die "open failed: $!\n";
369 } 389 }
370 }; 390 };
371 391
392In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>,
393C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the
394following POSIX and non-POSIX constants are available (missing ones on
395your system are, as usual, C<0>):
396
397C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
398C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
399C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>.
400
372 401
373=item aio_close $fh, $callback->($status) 402=item aio_close $fh, $callback->($status)
374 403
375Asynchronously close a file and call the callback with the result 404Asynchronously close a file and call the callback with the result
376code. 405code.
384 413
385Or in other words: the file descriptor will be closed, but it will not be 414Or in other words: the file descriptor will be closed, but it will not be
386free for reuse until the perl filehandle is closed. 415free for reuse until the perl filehandle is closed.
387 416
388=cut 417=cut
418
419=item aio_seek $fh, $offset, $whence, $callback->($offs)
420
421Seeks the filehandle to the new C<$offset>, similarly to perl's
422C<sysseek>. The C<$whence> can use the traditional values (C<0> for
423C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
424C<IO::AIO::SEEK_END>).
425
426The resulting absolute offset will be passed to the callback, or C<-1> in
427case of an error.
428
429In theory, the C<$whence> constants could be different than the
430corresponding values from L<Fcntl>, but perl guarantees they are the same,
431so don't panic.
432
433As a GNU/Linux (and maybe Solaris) extension, also the constants
434C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
435could be found. No guarantees about suitability for use in C<aio_seek> or
436Perl's C<sysseek> can be made though, although I would naively assume they
437"just work".
389 438
390=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 439=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
391 440
392=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 441=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
393 442
426 475
427Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 476Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
428reading at byte offset C<$in_offset>, and starts writing at the current 477reading at byte offset C<$in_offset>, and starts writing at the current
429file offset of C<$out_fh>. Because of that, it is not safe to issue more 478file offset of C<$out_fh>. Because of that, it is not safe to issue more
430than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each 479than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
431other. 480other. The same C<$in_fh> works fine though, as this function does not
481move or use the file offset of C<$in_fh>.
432 482
483Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than
484are written, and there is no way to find out how many more bytes have been
485read from C<aio_sendfile> alone, as C<aio_sendfile> only provides the
486number of bytes written to C<$out_fh>. Only if the result value equals
487C<$length> one can assume that C<$length> bytes have been read.
488
489Unlike with other C<aio_> functions, it makes a lot of sense to use
490C<aio_sendfile> on non-blocking sockets, as long as one end (typically
491the C<$in_fh>) is a file - the file I/O will then be asynchronous, while
492the socket I/O will be non-blocking. Note, however, that you can run
493into a trap where C<aio_sendfile> reads some data with readahead, then
494fails to write all data, and when the socket is ready the next time, the
495data in the cache is already lost, forcing C<aio_sendfile> to again hit
496the disk. Explicit C<aio_read> + C<aio_write> let's you better control
497resource usage.
498
433This call tries to make use of a native C<sendfile> syscall to provide 499This call tries to make use of a native C<sendfile>-like syscall to
434zero-copy operation. For this to work, C<$out_fh> should refer to a 500provide zero-copy operation. For this to work, C<$out_fh> should refer to
435socket, and C<$in_fh> should refer to an mmap'able file. 501a socket, and C<$in_fh> should refer to an mmap'able file.
436 502
437If a native sendfile cannot be found or it fails with C<ENOSYS>, 503If a native sendfile cannot be found or it fails with C<ENOSYS>,
438C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>, 504C<EINVAL>, C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or
439it will be emulated, so you can call C<aio_sendfile> on any type of 505C<ENOTSOCK>, it will be emulated, so you can call C<aio_sendfile> on any
440filehandle regardless of the limitations of the operating system. 506type of filehandle regardless of the limitations of the operating system.
441 507
442Please note, however, that C<aio_sendfile> can read more bytes from 508As native sendfile syscalls (as practically any non-POSIX interface hacked
443C<$in_fh> than are written, and there is no way to find out how many 509together in a hurry to improve benchmark numbers) tend to be rather buggy
444bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 510on many systems, this implementation tries to work around some known bugs
445provides the number of bytes written to C<$out_fh>. Only if the result 511in Linux and FreeBSD kernels (probably others, too), but that might fail,
446value equals C<$length> one can assume that C<$length> bytes have been 512so you really really should check the return value of C<aio_sendfile> -
447read. 513fewre bytes than expected might have been transferred.
448 514
449 515
450=item aio_readahead $fh,$offset,$length, $callback->($retval) 516=item aio_readahead $fh,$offset,$length, $callback->($retval)
451 517
452C<aio_readahead> populates the page cache with data from a file so that 518C<aio_readahead> populates the page cache with data from a file so that
474for an explanation. 540for an explanation.
475 541
476Currently, the stats are always 64-bit-stats, i.e. instead of returning an 542Currently, the stats are always 64-bit-stats, i.e. instead of returning an
477error when stat'ing a large file, the results will be silently truncated 543error when stat'ing a large file, the results will be silently truncated
478unless perl itself is compiled with large file support. 544unless perl itself is compiled with large file support.
545
546To help interpret the mode and dev/rdev stat values, IO::AIO offers the
547following constants and functions (if not implemented, the constants will
548be C<0> and the functions will either C<croak> or fall back on traditional
549behaviour).
550
551C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
552C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
553C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
479 554
480Example: Print the length of F</etc/passwd>: 555Example: Print the length of F</etc/passwd>:
481 556
482 aio_stat "/etc/passwd", sub { 557 aio_stat "/etc/passwd", sub {
483 $_[0] and die "stat failed: $!"; 558 $_[0] and die "stat failed: $!";
527 namemax => 255, 602 namemax => 255,
528 frsize => 1024, 603 frsize => 1024,
529 fsid => 1810 604 fsid => 1810
530 } 605 }
531 606
607Here is a (likely partial - send me updates!) list of fsid values used by
608Linux - it is safe to hardcode these when C<$^O> is C<linux>:
609
610 0x0000adf5 adfs
611 0x0000adff affs
612 0x5346414f afs
613 0x09041934 anon-inode filesystem
614 0x00000187 autofs
615 0x42465331 befs
616 0x1badface bfs
617 0x42494e4d binfmt_misc
618 0x9123683e btrfs
619 0x0027e0eb cgroupfs
620 0xff534d42 cifs
621 0x73757245 coda
622 0x012ff7b7 coh
623 0x28cd3d45 cramfs
624 0x453dcd28 cramfs-wend (wrong endianness)
625 0x64626720 debugfs
626 0x00001373 devfs
627 0x00001cd1 devpts
628 0x0000f15f ecryptfs
629 0x00414a53 efs
630 0x0000137d ext
631 0x0000ef53 ext2/ext3
632 0x0000ef51 ext2
633 0x00004006 fat
634 0x65735546 fuseblk
635 0x65735543 fusectl
636 0x0bad1dea futexfs
637 0x01161970 gfs2
638 0x47504653 gpfs
639 0x00004244 hfs
640 0xf995e849 hpfs
641 0x958458f6 hugetlbfs
642 0x2bad1dea inotifyfs
643 0x00009660 isofs
644 0x000072b6 jffs2
645 0x3153464a jfs
646 0x6b414653 k-afs
647 0x0bd00bd0 lustre
648 0x0000137f minix
649 0x0000138f minix 30 char names
650 0x00002468 minix v2
651 0x00002478 minix v2 30 char names
652 0x00004d5a minix v3
653 0x19800202 mqueue
654 0x00004d44 msdos
655 0x0000564c novell
656 0x00006969 nfs
657 0x6e667364 nfsd
658 0x00003434 nilfs
659 0x5346544e ntfs
660 0x00009fa1 openprom
661 0x7461636F ocfs2
662 0x00009fa0 proc
663 0x6165676c pstorefs
664 0x0000002f qnx4
665 0x858458f6 ramfs
666 0x52654973 reiserfs
667 0x00007275 romfs
668 0x67596969 rpc_pipefs
669 0x73636673 securityfs
670 0xf97cff8c selinux
671 0x0000517b smb
672 0x534f434b sockfs
673 0x73717368 squashfs
674 0x62656572 sysfs
675 0x012ff7b6 sysv2
676 0x012ff7b5 sysv4
677 0x01021994 tmpfs
678 0x15013346 udf
679 0x00011954 ufs
680 0x54190100 ufs byteswapped
681 0x00009fa2 usbdevfs
682 0x01021997 v9fs
683 0xa501fcf5 vxfs
684 0xabba1974 xenfs
685 0x012ff7b4 xenix
686 0x58465342 xfs
687 0x012fd16d xia
532 688
533=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 689=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
534 690
535Works like perl's C<utime> function (including the special case of $atime 691Works like perl's C<utime> function (including the special case of $atime
536and $mtime being undef). Fractional times are supported if the underlying 692and $mtime being undef). Fractional times are supported if the underlying
564=item aio_truncate $fh_or_path, $offset, $callback->($status) 720=item aio_truncate $fh_or_path, $offset, $callback->($status)
565 721
566Works like truncate(2) or ftruncate(2). 722Works like truncate(2) or ftruncate(2).
567 723
568 724
725=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
726
727Allocates or freed disk space according to the C<$mode> argument. See the
728linux C<fallocate> docuemntation for details.
729
730C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE>
731to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE |
732IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.
733
734The file system block size used by C<fallocate> is presumably the
735C<f_bsize> returned by C<statvfs>.
736
737If C<fallocate> isn't available or cannot be emulated (currently no
738emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
739
740
569=item aio_chmod $fh_or_path, $mode, $callback->($status) 741=item aio_chmod $fh_or_path, $mode, $callback->($status)
570 742
571Works like perl's C<chmod> function. 743Works like perl's C<chmod> function.
572 744
573 745
575 747
576Asynchronously unlink (delete) a file and call the callback with the 748Asynchronously unlink (delete) a file and call the callback with the
577result code. 749result code.
578 750
579 751
580=item aio_mknod $path, $mode, $dev, $callback->($status) 752=item aio_mknod $pathname, $mode, $dev, $callback->($status)
581 753
582[EXPERIMENTAL] 754[EXPERIMENTAL]
583 755
584Asynchronously create a device node (or fifo). See mknod(2). 756Asynchronously create a device node (or fifo). See mknod(2).
585 757
586The only (POSIX-) portable way of calling this function is: 758The only (POSIX-) portable way of calling this function is:
587 759
588 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 760 aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
589 761
762See C<aio_stat> for info about some potentially helpful extra constants
763and functions.
590 764
591=item aio_link $srcpath, $dstpath, $callback->($status) 765=item aio_link $srcpath, $dstpath, $callback->($status)
592 766
593Asynchronously create a new link to the existing object at C<$srcpath> at 767Asynchronously create a new link to the existing object at C<$srcpath> at
594the path C<$dstpath> and call the callback with the result code. 768the path C<$dstpath> and call the callback with the result code.
598 772
599Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 773Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
600the path C<$dstpath> and call the callback with the result code. 774the path C<$dstpath> and call the callback with the result code.
601 775
602 776
603=item aio_readlink $path, $callback->($link) 777=item aio_readlink $pathname, $callback->($link)
604 778
605Asynchronously read the symlink specified by C<$path> and pass it to 779Asynchronously read the symlink specified by C<$path> and pass it to
606the callback. If an error occurs, nothing or undef gets passed to the 780the callback. If an error occurs, nothing or undef gets passed to the
607callback. 781callback.
608 782
609 783
784=item aio_realpath $pathname, $callback->($path)
785
786Asynchronously make the path absolute and resolve any symlinks in
787C<$path>. The resulting path only consists of directories (same as
788L<Cwd::realpath>).
789
790This request can be used to get the absolute path of the current working
791directory by passing it a path of F<.> (a single dot).
792
793
610=item aio_rename $srcpath, $dstpath, $callback->($status) 794=item aio_rename $srcpath, $dstpath, $callback->($status)
611 795
612Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 796Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
613rename(2) and call the callback with the result code. 797rename(2) and call the callback with the result code.
798
799On systems that support the AIO::WD working directory abstraction
800natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
801of failing, C<rename> is called on the absolute path of C<$wd>.
614 802
615 803
616=item aio_mkdir $pathname, $mode, $callback->($status) 804=item aio_mkdir $pathname, $mode, $callback->($status)
617 805
618Asynchronously mkdir (create) a directory and call the callback with 806Asynchronously mkdir (create) a directory and call the callback with
623=item aio_rmdir $pathname, $callback->($status) 811=item aio_rmdir $pathname, $callback->($status)
624 812
625Asynchronously rmdir (delete) a directory and call the callback with the 813Asynchronously rmdir (delete) a directory and call the callback with the
626result code. 814result code.
627 815
816On systems that support the AIO::WD working directory abstraction
817natively, the case C<[$wd, "."]> is specialcased - instead of failing,
818C<rmdir> is called on the absolute path of C<$wd>.
819
628 820
629=item aio_readdir $pathname, $callback->($entries) 821=item aio_readdir $pathname, $callback->($entries)
630 822
631Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 823Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
632directory (i.e. opendir + readdir + closedir). The entries will not be 824directory (i.e. opendir + readdir + closedir). The entries will not be
636array-ref with the filenames. 828array-ref with the filenames.
637 829
638 830
639=item aio_readdirx $pathname, $flags, $callback->($entries, $flags) 831=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
640 832
641Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune 833Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to
642behaviour and output format. In case of an error, C<$entries> will be 834tune behaviour and output format. In case of an error, C<$entries> will be
643C<undef>. 835C<undef>.
644 836
645The flags are a combination of the following constants, ORed together (the 837The flags are a combination of the following constants, ORed together (the
646flags will also be passed to the callback, possibly modified): 838flags will also be passed to the callback, possibly modified):
647 839
648=over 4 840=over 4
649 841
650=item IO::AIO::READDIR_DENTS 842=item IO::AIO::READDIR_DENTS
651 843
652When this flag is off, then the callback gets an arrayref with of names 844When this flag is off, then the callback gets an arrayref consisting of
653only (as with C<aio_readdir>), otherwise it gets an arrayref with 845names only (as with C<aio_readdir>), otherwise it gets an arrayref with
654C<[$name, $type, $inode]> arrayrefs, each describing a single directory 846C<[$name, $type, $inode]> arrayrefs, each describing a single directory
655entry in more detail. 847entry in more detail.
656 848
657C<$name> is the name of the entry. 849C<$name> is the name of the entry.
658 850
671systems that do not deliver the inode information. 863systems that do not deliver the inode information.
672 864
673=item IO::AIO::READDIR_DIRS_FIRST 865=item IO::AIO::READDIR_DIRS_FIRST
674 866
675When this flag is set, then the names will be returned in an order where 867When this flag is set, then the names will be returned in an order where
676likely directories come first. This is useful when you need to quickly 868likely directories come first, in optimal stat order. This is useful when
677find directories, or you want to find all directories while avoiding to 869you need to quickly find directories, or you want to find all directories
678stat() each entry. 870while avoiding to stat() each entry.
679 871
680If the system returns type information in readdir, then this is used 872If the system returns type information in readdir, then this is used
681to find directories directly. Otherwise, likely directories are files 873to find directories directly. Otherwise, likely directories are names
682beginning with ".", or otherwise files with no dots, of which files with 874beginning with ".", or otherwise names with no dots, of which names with
683short names are tried first. 875short names are tried first.
684 876
685=item IO::AIO::READDIR_STAT_ORDER 877=item IO::AIO::READDIR_STAT_ORDER
686 878
687When this flag is set, then the names will be returned in an order 879When this flag is set, then the names will be returned in an order
694 886
695=item IO::AIO::READDIR_FOUND_UNKNOWN 887=item IO::AIO::READDIR_FOUND_UNKNOWN
696 888
697This flag should not be set when calling C<aio_readdirx>. Instead, it 889This flag should not be set when calling C<aio_readdirx>. Instead, it
698is being set by C<aio_readdirx>, when any of the C<$type>'s found were 890is being set by C<aio_readdirx>, when any of the C<$type>'s found were
699C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all 891C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all
700C<$type>'s are known, which can be used to speed up some algorithms. 892C<$type>'s are known, which can be used to speed up some algorithms.
701 893
702=back 894=back
703 895
704 896
705=item aio_load $path, $data, $callback->($status) 897=item aio_load $pathname, $data, $callback->($status)
706 898
707This is a composite request that tries to fully load the given file into 899This is a composite request that tries to fully load the given file into
708memory. Status is the same as with aio_read. 900memory. Status is the same as with aio_read.
709 901
710=cut 902=cut
832 if ($_[0] && $! == EXDEV) { 1024 if ($_[0] && $! == EXDEV) {
833 aioreq_pri $pri; 1025 aioreq_pri $pri;
834 add $grp aio_copy $src, $dst, sub { 1026 add $grp aio_copy $src, $dst, sub {
835 $grp->result ($_[0]); 1027 $grp->result ($_[0]);
836 1028
837 if (!$_[0]) { 1029 unless ($_[0]) {
838 aioreq_pri $pri; 1030 aioreq_pri $pri;
839 add $grp aio_unlink $src; 1031 add $grp aio_unlink $src;
840 } 1032 }
841 }; 1033 };
842 } else { 1034 } else {
845 }; 1037 };
846 1038
847 $grp 1039 $grp
848} 1040}
849 1041
850=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 1042=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
851 1043
852Scans a directory (similar to C<aio_readdir>) but additionally tries to 1044Scans a directory (similar to C<aio_readdir>) but additionally tries to
853efficiently separate the entries of directory C<$path> into two sets of 1045efficiently separate the entries of directory C<$path> into two sets of
854names, directories you can recurse into (directories), and ones you cannot 1046names, directories you can recurse into (directories), and ones you cannot
855recurse into (everything else, including symlinks to directories). 1047recurse into (everything else, including symlinks to directories).
886Then entries will be sorted into likely directories a non-initial dot 1078Then entries will be sorted into likely directories a non-initial dot
887currently) and likely non-directories (see C<aio_readdirx>). Then every 1079currently) and likely non-directories (see C<aio_readdirx>). Then every
888entry plus an appended C</.> will be C<stat>'ed, likely directories first, 1080entry plus an appended C</.> will be C<stat>'ed, likely directories first,
889in order of their inode numbers. If that succeeds, it assumes that the 1081in order of their inode numbers. If that succeeds, it assumes that the
890entry is a directory or a symlink to directory (which will be checked 1082entry is a directory or a symlink to directory (which will be checked
891seperately). This is often faster than stat'ing the entry itself because 1083separately). This is often faster than stat'ing the entry itself because
892filesystems might detect the type of the entry without reading the inode 1084filesystems might detect the type of the entry without reading the inode
893data (e.g. ext2fs filetype feature), even on systems that cannot return 1085data (e.g. ext2fs filetype feature), even on systems that cannot return
894the filetype information on readdir. 1086the filetype information on readdir.
895 1087
896If the known number of directories (link count - 2) has been reached, the 1088If the known number of directories (link count - 2) has been reached, the
912 1104
913 my $grp = aio_group $cb; 1105 my $grp = aio_group $cb;
914 1106
915 $maxreq = 4 if $maxreq <= 0; 1107 $maxreq = 4 if $maxreq <= 0;
916 1108
917 # stat once 1109 # get a wd object
918 aioreq_pri $pri; 1110 aioreq_pri $pri;
919 add $grp aio_stat $path, sub { 1111 add $grp aio_wd $path, sub {
1112 $_[0]
920 return $grp->result () if $_[0]; 1113 or return $grp->result ();
921 my $now = time;
922 my $hash1 = join ":", (stat _)[0,1,3,7,9];
923 1114
924 # read the directory entries 1115 my $wd = [shift, "."];
1116
1117 # stat once
925 aioreq_pri $pri; 1118 aioreq_pri $pri;
926 add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { 1119 add $grp aio_stat $wd, sub {
927 my $entries = shift
928 or return $grp->result (); 1120 return $grp->result () if $_[0];
1121 my $now = time;
1122 my $hash1 = join ":", (stat _)[0,1,3,7,9];
929 1123
930 # stat the dir another time 1124 # read the directory entries
931 aioreq_pri $pri; 1125 aioreq_pri $pri;
1126 add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
1127 my $entries = shift
1128 or return $grp->result ();
1129
1130 # stat the dir another time
1131 aioreq_pri $pri;
932 add $grp aio_stat $path, sub { 1132 add $grp aio_stat $wd, sub {
933 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 1133 my $hash2 = join ":", (stat _)[0,1,3,7,9];
934 1134
935 my $ndirs; 1135 my $ndirs;
936 1136
937 # take the slow route if anything looks fishy 1137 # take the slow route if anything looks fishy
938 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 1138 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
939 $ndirs = -1; 1139 $ndirs = -1;
940 } else { 1140 } else {
941 # if nlink == 2, we are finished 1141 # if nlink == 2, we are finished
942 # for non-posix-fs's, we rely on nlink < 2 1142 # for non-posix-fs's, we rely on nlink < 2
943 $ndirs = (stat _)[3] - 2 1143 $ndirs = (stat _)[3] - 2
944 or return $grp->result ([], $entries); 1144 or return $grp->result ([], $entries);
945 } 1145 }
946 1146
947 my (@dirs, @nondirs); 1147 my (@dirs, @nondirs);
948 1148
949 my $statgrp = add $grp aio_group sub { 1149 my $statgrp = add $grp aio_group sub {
950 $grp->result (\@dirs, \@nondirs); 1150 $grp->result (\@dirs, \@nondirs);
951 }; 1151 };
952 1152
953 limit $statgrp $maxreq; 1153 limit $statgrp $maxreq;
954 feed $statgrp sub { 1154 feed $statgrp sub {
955 return unless @$entries; 1155 return unless @$entries;
956 my $entry = shift @$entries; 1156 my $entry = shift @$entries;
957 1157
958 aioreq_pri $pri; 1158 aioreq_pri $pri;
1159 $wd->[1] = "$entry/.";
959 add $statgrp aio_stat "$path/$entry/.", sub { 1160 add $statgrp aio_stat $wd, sub {
960 if ($_[0] < 0) { 1161 if ($_[0] < 0) {
961 push @nondirs, $entry; 1162 push @nondirs, $entry;
962 } else { 1163 } else {
963 # need to check for real directory 1164 # need to check for real directory
964 aioreq_pri $pri; 1165 aioreq_pri $pri;
1166 $wd->[1] = $entry;
965 add $statgrp aio_lstat "$path/$entry", sub { 1167 add $statgrp aio_lstat $wd, sub {
966 if (-d _) { 1168 if (-d _) {
967 push @dirs, $entry; 1169 push @dirs, $entry;
968 1170
969 unless (--$ndirs) { 1171 unless (--$ndirs) {
970 push @nondirs, @$entries; 1172 push @nondirs, @$entries;
971 feed $statgrp; 1173 feed $statgrp;
1174 }
1175 } else {
1176 push @nondirs, $entry;
972 } 1177 }
973 } else {
974 push @nondirs, $entry;
975 } 1178 }
976 } 1179 }
977 } 1180 };
978 }; 1181 };
979 }; 1182 };
980 }; 1183 };
981 }; 1184 };
982 }; 1185 };
983 1186
984 $grp 1187 $grp
985} 1188}
986 1189
987=item aio_rmtree $path, $callback->($status) 1190=item aio_rmtree $pathname, $callback->($status)
988 1191
989Delete a directory tree starting (and including) C<$path>, return the 1192Delete a directory tree starting (and including) C<$path>, return the
990status of the final C<rmdir> only. This is a composite request that 1193status of the final C<rmdir> only. This is a composite request that
991uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1194uses C<aio_scandir> to recurse into and rmdir directories, and unlink
992everything else. 1195everything else.
993 1196
994=cut 1197=cut
995 1198
1034callback with the fdatasync result code. 1237callback with the fdatasync result code.
1035 1238
1036If this call isn't available because your OS lacks it or it couldn't be 1239If this call isn't available because your OS lacks it or it couldn't be
1037detected, it will be emulated by calling C<fsync> instead. 1240detected, it will be emulated by calling C<fsync> instead.
1038 1241
1242=item aio_syncfs $fh, $callback->($status)
1243
1244Asynchronously call the syncfs syscall to sync the filesystem associated
1245to the given filehandle and call the callback with the syncfs result
1246code. If syncfs is not available, calls sync(), but returns C<-1> and sets
1247errno to C<ENOSYS> nevertheless.
1248
1039=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 1249=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
1040 1250
1041Sync the data portion of the file specified by C<$offset> and C<$length> 1251Sync the data portion of the file specified by C<$offset> and C<$length>
1042to disk (but NOT the metadata), by calling the Linux-specific 1252to disk (but NOT the metadata), by calling the Linux-specific
1043sync_file_range call. If sync_file_range is not available or it returns 1253sync_file_range call. If sync_file_range is not available or it returns
1046C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, 1256C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
1047C<IO::AIO::SYNC_FILE_RANGE_WRITE> and 1257C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
1048C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range 1258C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
1049manpage for details. 1259manpage for details.
1050 1260
1051=item aio_pathsync $path, $callback->($status) 1261=item aio_pathsync $pathname, $callback->($status)
1052 1262
1053This request tries to open, fsync and close the given path. This is a 1263This request tries to open, fsync and close the given path. This is a
1054composite request intended to sync directories after directory operations 1264composite request intended to sync directories after directory operations
1055(E.g. rename). This might not work on all operating systems or have any 1265(E.g. rename). This might not work on all operating systems or have any
1056specific effect, but usually it makes sure that directory changes get 1266specific effect, but usually it makes sure that directory changes get
1108 1318
1109This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1319This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1110scalars. 1320scalars.
1111 1321
1112It touches (reads or writes) all memory pages in the specified 1322It touches (reads or writes) all memory pages in the specified
1113range inside the scalar. All caveats and parameters are the same 1323range inside the scalar. All caveats and parameters are the same
1114as for C<aio_msync>, above, except for flags, which must be either 1324as for C<aio_msync>, above, except for flags, which must be either
1115C<0> (which reads all pages and ensures they are instantiated) or 1325C<0> (which reads all pages and ensures they are instantiated) or
1116C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and 1326C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1117writing an octet from it, which dirties the page). 1327writing an octet from it, which dirties the page).
1118 1328
1119=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 1329=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1120 1330
1121This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1331This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1152documented under L<MISCELLANEOUS FUNCTIONS>. 1362documented under L<MISCELLANEOUS FUNCTIONS>.
1153 1363
1154Example: asynchronously lock all current and future pages into memory. 1364Example: asynchronously lock all current and future pages into memory.
1155 1365
1156 aio_mlockall IO::AIO::MCL_FUTURE; 1366 aio_mlockall IO::AIO::MCL_FUTURE;
1367
1368=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1369
1370Queries the extents of the given file (by calling the Linux C<FIEMAP>
1371ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1372the ioctl is not available on your OS, then this request will fail with
1373C<ENOSYS>.
1374
1375C<$start> is the starting offset to query extents for, C<$length> is the
1376size of the range to query - if it is C<undef>, then the whole file will
1377be queried.
1378
1379C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
1380C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1381exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1382the data portion.
1383
1384C<$count> is the maximum number of extent records to return. If it is
1385C<undef>, then IO::AIO queries all extents of the range. As a very special
1386case, if it is C<0>, then the callback receives the number of extents
1387instead of the extents themselves (which is unreliable, see below).
1388
1389If an error occurs, the callback receives no arguments. The special
1390C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1391
1392Otherwise, the callback receives an array reference with extent
1393structures. Each extent structure is an array reference itself, with the
1394following members:
1395
1396 [$logical, $physical, $length, $flags]
1397
1398Flags is any combination of the following flag values (typically either C<0>
1399or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1400
1401C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1402C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1403C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1404C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1405C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1406C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1407
1408At the time of this writing (Linux 3.2), this requets is unreliable unless
1409C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1410it to return all extents of a range for files with large number of
1411extents. The code works around all these issues if C<$count> is undef.
1157 1412
1158=item aio_group $callback->(...) 1413=item aio_group $callback->(...)
1159 1414
1160This is a very special aio request: Instead of doing something, it is a 1415This is a very special aio request: Instead of doing something, it is a
1161container for other aio requests, which is useful if you want to bundle 1416container for other aio requests, which is useful if you want to bundle
1198like sleep and file handle readable/writable, the overhead this creates is 1453like sleep and file handle readable/writable, the overhead this creates is
1199immense (it blocks a thread for a long time) so do not use this function 1454immense (it blocks a thread for a long time) so do not use this function
1200except to put your application under artificial I/O pressure. 1455except to put your application under artificial I/O pressure.
1201 1456
1202=back 1457=back
1458
1459
1460=head2 IO::AIO::WD - multiple working directories
1461
1462Your process only has one current working directory, which is used by all
1463threads. This makes it hard to use relative paths (some other component
1464could call C<chdir> at any time, and it is hard to control when the path
1465will be used by IO::AIO).
1466
1467One solution for this is to always use absolute paths. This usually works,
1468but can be quite slow (the kernel has to walk the whole path on every
1469access), and can also be a hassle to implement.
1470
1471Newer POSIX systems have a number of functions (openat, fdopendir,
1472futimensat and so on) that make it possible to specify working directories
1473per operation.
1474
1475For portability, and because the clowns who "designed", or shall I write,
1476perpetrated this new interface were obviously half-drunk, this abstraction
1477cannot be perfect, though.
1478
1479IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
1480object. This object stores the canonicalised, absolute version of the
1481path, and on systems that allow it, also a directory file descriptor.
1482
1483Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
1484or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
1485object and a pathname instead (or the IO::AIO::WD object alone, which
1486gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
1487IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
1488to that IO::AIO::WD object.
1489
1490For example, to get a wd object for F</etc> and then stat F<passwd>
1491inside, you would write:
1492
1493 aio_wd "/etc", sub {
1494 my $etcdir = shift;
1495
1496 # although $etcdir can be undef on error, there is generally no reason
1497 # to check for errors here, as aio_stat will fail with ENOENT
1498 # when $etcdir is undef.
1499
1500 aio_stat [$etcdir, "passwd"], sub {
1501 # yay
1502 };
1503 };
1504
1505That C<aio_wd> is a request and not a normal function shows that creating
1506an IO::AIO::WD object is itself a potentially blocking operation, which is
1507why it is done asynchronously.
1508
1509To stat the directory obtained with C<aio_wd> above, one could write
1510either of the following three request calls:
1511
1512 aio_lstat "/etc" , sub { ... # pathname as normal string
1513 aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
1514 aio_lstat $wd , sub { ... # shorthand for the previous
1515
1516As with normal pathnames, IO::AIO keeps a copy of the working directory
1517object and the pathname string, so you could write the following without
1518causing any issues due to C<$path> getting reused:
1519
1520 my $path = [$wd, undef];
1521
1522 for my $name (qw(abc def ghi)) {
1523 $path->[1] = $name;
1524 aio_stat $path, sub {
1525 # ...
1526 };
1527 }
1528
1529There are some caveats: when directories get renamed (or deleted), the
1530pathname string doesn't change, so will point to the new directory (or
1531nowhere at all), while the directory fd, if available on the system,
1532will still point to the original directory. Most functions accepting a
1533pathname will use the directory fd on newer systems, and the string on
1534older systems. Some functions (such as realpath) will always rely on the
1535string form of the pathname.
1536
1537So this functionality is mainly useful to get some protection against
1538C<chdir>, to easily get an absolute path out of a relative path for future
1539reference, and to speed up doing many operations in the same directory
1540(e.g. when stat'ing all files in a directory).
1541
1542The following functions implement this working directory abstraction:
1543
1544=over 4
1545
1546=item aio_wd $pathname, $callback->($wd)
1547
1548Asynchonously canonicalise the given pathname and convert it to an
1549IO::AIO::WD object representing it. If possible and supported on the
1550system, also open a directory fd to speed up pathname resolution relative
1551to this working directory.
1552
1553If something goes wrong, then C<undef> is passwd to the callback instead
1554of a working directory object and C<$!> is set appropriately. Since
1555passing C<undef> as working directory component of a pathname fails the
1556request with C<ENOENT>, there is often no need for error checking in the
1557C<aio_wd> callback, as future requests using the value will fail in the
1558expected way.
1559
1560=item IO::AIO::CWD
1561
1562This is a compiletime constant (object) that represents the process
1563current working directory.
1564
1565Specifying this object as working directory object for a pathname is as if
1566the pathname would be specified directly, without a directory object. For
1567example, these calls are functionally identical:
1568
1569 aio_stat "somefile", sub { ... };
1570 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1571
1572=back
1573
1574To recover the path associated with an IO::AIO::WD object, you can use
1575C<aio_realpath>:
1576
1577 aio_realpath $wd, sub {
1578 warn "path is $_[0]\n";
1579 };
1580
1581Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
1582sometimes, fall back to using an absolue path.
1203 1583
1204=head2 IO::AIO::REQ CLASS 1584=head2 IO::AIO::REQ CLASS
1205 1585
1206All non-aggregate C<aio_*> functions return an object of this class when 1586All non-aggregate C<aio_*> functions return an object of this class when
1207called in non-void context. 1587called in non-void context.
1325 1705
1326Sets a feeder/generator on this group: every group can have an attached 1706Sets a feeder/generator on this group: every group can have an attached
1327generator that generates requests if idle. The idea behind this is that, 1707generator that generates requests if idle. The idea behind this is that,
1328although you could just queue as many requests as you want in a group, 1708although you could just queue as many requests as you want in a group,
1329this might starve other requests for a potentially long time. For example, 1709this might starve other requests for a potentially long time. For example,
1330C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, 1710C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1331delaying any later requests for a long time. 1711requests, delaying any later requests for a long time.
1332 1712
1333To avoid this, and allow incremental generation of requests, you can 1713To avoid this, and allow incremental generation of requests, you can
1334instead a group and set a feeder on it that generates those requests. The 1714instead a group and set a feeder on it that generates those requests. The
1335feed callback will be called whenever there are few enough (see C<limit>, 1715feed callback will be called whenever there are few enough (see C<limit>,
1336below) requests active in the group itself and is expected to queue more 1716below) requests active in the group itself and is expected to queue more
1385 1765
1386See C<poll_cb> for an example. 1766See C<poll_cb> for an example.
1387 1767
1388=item IO::AIO::poll_cb 1768=item IO::AIO::poll_cb
1389 1769
1390Process some outstanding events on the result pipe. You have to call this 1770Process some requests that have reached the result phase (i.e. they have
1391regularly. Returns C<0> if all events could be processed, or C<-1> if it 1771been executed but the results are not yet reported). You have to call
1392returned earlier for whatever reason. Returns immediately when no events 1772this "regularly" to finish outstanding requests.
1393are outstanding. The amount of events processed depends on the settings of
1394C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1395 1773
1774Returns C<0> if all events could be processed (or there were no
1775events to process), or C<-1> if it returned earlier for whatever
1776reason. Returns immediately when no events are outstanding. The amount
1777of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1778C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1779
1396If not all requests were processed for whatever reason, the filehandle 1780If not all requests were processed for whatever reason, the poll file
1397will still be ready when C<poll_cb> returns, so normally you don't have to 1781descriptor will still be ready when C<poll_cb> returns, so normally you
1398do anything special to have it called later. 1782don't have to do anything special to have it called later.
1783
1784Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1785ready, it can be beneficial to call this function from loops which submit
1786a lot of requests, to make sure the results get processed when they become
1787available and not just when the loop is finished and the event loop takes
1788over again. This function returns very fast when there are no outstanding
1789requests.
1399 1790
1400Example: Install an Event watcher that automatically calls 1791Example: Install an Event watcher that automatically calls
1401IO::AIO::poll_cb with high priority (more examples can be found in the 1792IO::AIO::poll_cb with high priority (more examples can be found in the
1402SYNOPSIS section, at the top of this document): 1793SYNOPSIS section, at the top of this document):
1403 1794
1405 poll => 'r', async => 1, 1796 poll => 'r', async => 1,
1406 cb => \&IO::AIO::poll_cb); 1797 cb => \&IO::AIO::poll_cb);
1407 1798
1408=item IO::AIO::poll_wait 1799=item IO::AIO::poll_wait
1409 1800
1410If there are any outstanding requests and none of them in the result 1801Wait until either at least one request is in the result phase or no
1411phase, wait till the result filehandle becomes ready for reading (simply 1802requests are outstanding anymore.
1412does a C<select> on the filehandle. This is useful if you want to 1803
1413synchronously wait for some requests to finish). 1804This is useful if you want to synchronously wait for some requests to
1805become ready, without actually handling them.
1414 1806
1415See C<nreqs> for an example. 1807See C<nreqs> for an example.
1416 1808
1417=item IO::AIO::poll 1809=item IO::AIO::poll
1418 1810
1505 1897
1506Under normal circumstances you don't need to call this function. 1898Under normal circumstances you don't need to call this function.
1507 1899
1508=item IO::AIO::max_idle $nthreads 1900=item IO::AIO::max_idle $nthreads
1509 1901
1510Limit the number of threads (default: 4) that are allowed to idle (i.e., 1902Limit the number of threads (default: 4) that are allowed to idle
1511threads that did not get a request to process within 10 seconds). That 1903(i.e., threads that did not get a request to process within the idle
1512means if a thread becomes idle while C<$nthreads> other threads are also 1904timeout (default: 10 seconds). That means if a thread becomes idle while
1513idle, it will free its resources and exit. 1905C<$nthreads> other threads are also idle, it will free its resources and
1906exit.
1514 1907
1515This is useful when you allow a large number of threads (e.g. 100 or 1000) 1908This is useful when you allow a large number of threads (e.g. 100 or 1000)
1516to allow for extremely high load situations, but want to free resources 1909to allow for extremely high load situations, but want to free resources
1517under normal circumstances (1000 threads can easily consume 30MB of RAM). 1910under normal circumstances (1000 threads can easily consume 30MB of RAM).
1518 1911
1519The default is probably ok in most situations, especially if thread 1912The default is probably ok in most situations, especially if thread
1520creation is fast. If thread creation is very slow on your system you might 1913creation is fast. If thread creation is very slow on your system you might
1521want to use larger values. 1914want to use larger values.
1522 1915
1916=item IO::AIO::idle_timeout $seconds
1917
1918Sets the minimum idle timeout (default 10) after which worker threads are
1919allowed to exit. SEe C<IO::AIO::max_idle>.
1920
1523=item IO::AIO::max_outstanding $maxreqs 1921=item IO::AIO::max_outstanding $maxreqs
1922
1923Sets the maximum number of outstanding requests to C<$nreqs>. If
1924you do queue up more than this number of requests, the next call to
1925C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as
1926C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no
1927longer exceeded.
1928
1929In other words, this setting does not enforce a queue limit, but can be
1930used to make poll functions block if the limit is exceeded.
1524 1931
1525This is a very bad function to use in interactive programs because it 1932This is a very bad function to use in interactive programs because it
1526blocks, and a bad way to reduce concurrency because it is inexact: Better 1933blocks, and a bad way to reduce concurrency because it is inexact: Better
1527use an C<aio_group> together with a feed callback. 1934use an C<aio_group> together with a feed callback.
1528 1935
1529Sets the maximum number of outstanding requests to C<$nreqs>. If you 1936It's main use is in scripts without an event loop - when you want to stat
1530do queue up more than this number of requests, the next call to the 1937a lot of files, you can write somehting like this:
1531C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1532function will block until the limit is no longer exceeded.
1533 1938
1534The default value is very large, so there is no practical limit on the 1939 IO::AIO::max_outstanding 32;
1535number of outstanding requests.
1536 1940
1537You can still queue as many requests as you want. Therefore, 1941 for my $path (...) {
1538C<max_outstanding> is mainly useful in simple scripts (with low values) or 1942 aio_stat $path , ...;
1539as a stop gap to shield against fatal memory overflow (with large values). 1943 IO::AIO::poll_cb;
1944 }
1945
1946 IO::AIO::flush;
1947
1948The call to C<poll_cb> inside the loop will normally return instantly, but
1949as soon as more thna C<32> reqeusts are in-flight, it will block until
1950some requests have been handled. This keeps the loop from pushing a large
1951number of C<aio_stat> requests onto the queue.
1952
1953The default value for C<max_outstanding> is very large, so there is no
1954practical limit on the number of outstanding requests.
1540 1955
1541=back 1956=back
1542 1957
1543=head3 STATISTICAL INFORMATION 1958=head3 STATISTICAL INFORMATION
1544 1959
1584 1999
1585=item IO::AIO::fadvise $fh, $offset, $len, $advice 2000=item IO::AIO::fadvise $fh, $offset, $len, $advice
1586 2001
1587Simply calls the C<posix_fadvise> function (see its 2002Simply calls the C<posix_fadvise> function (see its
1588manpage for details). The following advice constants are 2003manpage for details). The following advice constants are
1589avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, 2004available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1590C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, 2005C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1591C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. 2006C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1592 2007
1593On systems that do not implement C<posix_fadvise>, this function returns 2008On systems that do not implement C<posix_fadvise>, this function returns
1594ENOSYS, otherwise the return value of C<posix_fadvise>. 2009ENOSYS, otherwise the return value of C<posix_fadvise>.
1595 2010
1596=item IO::AIO::madvise $scalar, $offset, $len, $advice 2011=item IO::AIO::madvise $scalar, $offset, $len, $advice
1597 2012
1598Simply calls the C<posix_madvise> function (see its 2013Simply calls the C<posix_madvise> function (see its
1599manpage for details). The following advice constants are 2014manpage for details). The following advice constants are
1600avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, 2015available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1601C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. 2016C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
1602 2017
1603On systems that do not implement C<posix_madvise>, this function returns 2018On systems that do not implement C<posix_madvise>, this function returns
1604ENOSYS, otherwise the return value of C<posix_madvise>. 2019ENOSYS, otherwise the return value of C<posix_madvise>.
1605 2020
1606=item IO::AIO::mprotect $scalar, $offset, $len, $protect 2021=item IO::AIO::mprotect $scalar, $offset, $len, $protect
1607 2022
1608Simply calls the C<mprotect> function on the preferably AIO::mmap'ed 2023Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1609$scalar (see its manpage for details). The following protect 2024$scalar (see its manpage for details). The following protect
1610constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, 2025constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1611C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. 2026C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1612 2027
1613On systems that do not implement C<mprotect>, this function returns 2028On systems that do not implement C<mprotect>, this function returns
1614ENOSYS, otherwise the return value of C<mprotect>. 2029ENOSYS, otherwise the return value of C<mprotect>.
1615 2030
1616=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 2031=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1617 2032
1618Memory-maps a file (or anonymous memory range) and attaches it to the 2033Memory-maps a file (or anonymous memory range) and attaches it to the
1619given C<$scalar>, which will act like a string scalar. 2034given C<$scalar>, which will act like a string scalar. Returns true on
2035success, and false otherwise.
1620 2036
1621The only operations allowed on the scalar are C<substr>/C<vec> that don't 2037The only operations allowed on the scalar are C<substr>/C<vec> that don't
1622change the string length, and most read-only operations such as copying it 2038change the string length, and most read-only operations such as copying it
1623or searching it with regexes and so on. 2039or searching it with regexes and so on.
1624 2040
1677Calls the C<munlockall> function. 2093Calls the C<munlockall> function.
1678 2094
1679On systems that do not implement C<munlockall>, this function returns 2095On systems that do not implement C<munlockall>, this function returns
1680ENOSYS, otherwise the return value of C<munlockall>. 2096ENOSYS, otherwise the return value of C<munlockall>.
1681 2097
2098=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
2099
2100Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
2101C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
2102should be the file offset.
2103
2104C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2105silently corrupt the data in this case.
2106
2107The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
2108C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
2109C<IO::AIO::SPLICE_F_GIFT>.
2110
2111See the C<splice(2)> manpage for details.
2112
2113=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2114
2115Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
2116description for C<IO::AIO::splice> above for details.
2117
2118=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
2119
2120Attempts to query or change the pipe buffer size. Obviously works only
2121on pipes, and currently works only on GNU/Linux systems, and fails with
2122C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
2123size on other systems, drop me a note.
2124
1682=back 2125=back
1683 2126
1684=cut 2127=cut
1685 2128
1686min_parallel 8; 2129min_parallel 8;
1720 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => 2163 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
1721 \&IO::AIO::poll_cb); 2164 \&IO::AIO::poll_cb);
1722 2165
1723=head2 FORK BEHAVIOUR 2166=head2 FORK BEHAVIOUR
1724 2167
1725This module should do "the right thing" when the process using it forks: 2168Usage of pthreads in a program changes the semantics of fork
2169considerably. Specifically, only async-safe functions can be called after
2170fork. Perl doesn't know about this, so in general, you cannot call fork
2171with defined behaviour in perl if pthreads are involved. IO::AIO uses
2172pthreads, so this applies, but many other extensions and (for inexplicable
2173reasons) perl itself often is linked against pthreads, so this limitation
2174applies to quite a lot of perls.
1726 2175
1727Before the fork, IO::AIO enters a quiescent state where no requests 2176This module no longer tries to fight your OS, or POSIX. That means IO::AIO
1728can be added in other threads and no results will be processed. After 2177only works in the process that loaded it. Forking is fully supported, but
1729the fork the parent simply leaves the quiescent state and continues 2178using IO::AIO in the child is not.
1730request/result processing, while the child frees the request/result queue
1731(so that the requests started before the fork will only be handled in the
1732parent). Threads will be started on demand until the limit set in the
1733parent process has been reached again.
1734 2179
1735In short: the parent will, after a short pause, continue as if fork had 2180You might get around by not I<using> IO::AIO before (or after)
1736not been called, while the child will act as if IO::AIO has not been used 2181forking. You could also try to call the L<IO::AIO::reinit> function in the
1737yet. 2182child:
2183
2184=over 4
2185
2186=item IO::AIO::reinit
2187
2188Abandons all current requests and I/O threads and simply reinitialises all
2189data structures. This is not an operation supported by any standards, but
2190happens to work on GNU/Linux and some newer BSD systems.
2191
2192The only reasonable use for this function is to call it after forking, if
2193C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in
2194the process will result in undefined behaviour. Calling it at any time
2195will also result in any undefined (by POSIX) behaviour.
2196
2197=back
1738 2198
1739=head2 MEMORY USAGE 2199=head2 MEMORY USAGE
1740 2200
1741Per-request usage: 2201Per-request usage:
1742 2202

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines