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.185 by root, Sat Dec 11 19:06:07 2010 UTC vs.
Revision 1.241 by root, Fri Dec 28 07:33:41 2012 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines