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.225 by root, Tue Apr 10 05:01:33 2012 UTC vs.
Revision 1.310 by root, Wed Dec 30 07:45:32 2020 UTC

1=head1 NAME 1=head1 NAME
2 2
3IO::AIO - Asynchronous Input/Output 3IO::AIO - Asynchronous/Advanced Input/Output
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use IO::AIO; 7 use IO::AIO;
8 8
58not well-supported or restricted (GNU/Linux doesn't allow them on normal 58not well-supported or restricted (GNU/Linux doesn't allow them on normal
59files currently, for example), and they would only support aio_read and 59files currently, for example), and they would only support aio_read and
60aio_write, so the remaining functionality would have to be implemented 60aio_write, so the remaining functionality would have to be implemented
61using threads anyway. 61using threads anyway.
62 62
63In addition to asynchronous I/O, this module also exports some rather
64arcane interfaces, such as C<madvise> or linux's C<splice> system call,
65which is why the C<A> in C<AIO> can also mean I<advanced>.
66
63Although the module will work in the presence of other (Perl-) threads, 67Although the module will work in the presence of other (Perl-) threads,
64it is currently not reentrant in any way, so use appropriate locking 68it is currently not reentrant in any way, so use appropriate locking
65yourself, always call C<poll_cb> from within the same thread, or never 69yourself, always call C<poll_cb> from within the same thread, or never
66call C<poll_cb> (or other C<aio_> functions) recursively. 70call C<poll_cb> (or other C<aio_> functions) recursively.
67 71
68=head2 EXAMPLE 72=head2 EXAMPLE
69 73
70This is a simple example that uses the EV module and loads 74This is a simple example that uses the EV module and loads
71F</etc/passwd> asynchronously: 75F</etc/passwd> asynchronously:
72 76
73 use Fcntl;
74 use EV; 77 use EV;
75 use IO::AIO; 78 use IO::AIO;
76 79
77 # register the IO::AIO callback with EV 80 # register the IO::AIO callback with EV
78 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; 81 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
95 98
96 # file contents now in $contents 99 # file contents now in $contents
97 print $contents; 100 print $contents;
98 101
99 # exit event loop and program 102 # exit event loop and program
100 EV::unloop; 103 EV::break;
101 }; 104 };
102 }; 105 };
103 106
104 # possibly queue up other requests, or open GUI windows, 107 # possibly queue up other requests, or open GUI windows,
105 # check for sockets etc. etc. 108 # check for sockets etc. etc.
106 109
107 # process events as long as there are some: 110 # process events as long as there are some:
108 EV::loop; 111 EV::run;
109 112
110=head1 REQUEST ANATOMY AND LIFETIME 113=head1 REQUEST ANATOMY AND LIFETIME
111 114
112Every C<aio_*> function creates a request. which is a C data structure not 115Every C<aio_*> function creates a request. which is a C data structure not
113directly visible to Perl. 116directly visible to Perl.
168use common::sense; 171use common::sense;
169 172
170use base 'Exporter'; 173use base 'Exporter';
171 174
172BEGIN { 175BEGIN {
173 our $VERSION = '4.15'; 176 our $VERSION = 4.75;
174 177
175 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close 178 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx 179 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
177 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync 180 aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
178 aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate 181 aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
179 aio_pathsync aio_readahead aio_fiemap 182 aio_pathsync aio_readahead aio_fiemap aio_allocate
180 aio_rename aio_link aio_move aio_copy aio_group 183 aio_rename aio_rename2 aio_link aio_move aio_copy aio_group
181 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 184 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
182 aio_chmod aio_utime aio_truncate 185 aio_chmod aio_utime aio_truncate
183 aio_msync aio_mtouch aio_mlock aio_mlockall 186 aio_msync aio_mtouch aio_mlock aio_mlockall
184 aio_statvfs 187 aio_statvfs
188 aio_slurp
185 aio_wd); 189 aio_wd);
186 190
187 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 191 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
188 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 192 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
189 min_parallel max_parallel max_idle idle_timeout 193 min_parallel max_parallel max_idle idle_timeout
190 nreqs nready npending nthreads 194 nreqs nready npending nthreads
191 max_poll_time max_poll_reqs 195 max_poll_time max_poll_reqs
192 sendfile fadvise madvise 196 sendfile fadvise madvise
193 mmap munmap munlock munlockall); 197 mmap munmap mremap munlock munlockall);
194 198
195 push @AIO_REQ, qw(aio_busy); # not exported 199 push @AIO_REQ, qw(aio_busy); # not exported
196 200
197 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 201 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
198 202
202 206
203=head1 FUNCTIONS 207=head1 FUNCTIONS
204 208
205=head2 QUICK OVERVIEW 209=head2 QUICK OVERVIEW
206 210
207This section simply lists the prototypes of the most important functions 211This section simply lists the prototypes most of the functions for
208for quick reference. See the following sections for function-by-function 212quick reference. See the following sections for function-by-function
209documentation. 213documentation.
210 214
211 aio_wd $pathname, $callback->($wd) 215 aio_wd $pathname, $callback->($wd)
212 aio_open $pathname, $flags, $mode, $callback->($fh) 216 aio_open $pathname, $flags, $mode, $callback->($fh)
213 aio_close $fh, $callback->($status) 217 aio_close $fh, $callback->($status)
221 aio_statvfs $fh_or_path, $callback->($statvfs) 225 aio_statvfs $fh_or_path, $callback->($statvfs)
222 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 226 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
223 aio_chown $fh_or_path, $uid, $gid, $callback->($status) 227 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
224 aio_chmod $fh_or_path, $mode, $callback->($status) 228 aio_chmod $fh_or_path, $mode, $callback->($status)
225 aio_truncate $fh_or_path, $offset, $callback->($status) 229 aio_truncate $fh_or_path, $offset, $callback->($status)
230 aio_allocate $fh, $mode, $offset, $len, $callback->($status)
231 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
226 aio_unlink $pathname, $callback->($status) 232 aio_unlink $pathname, $callback->($status)
227 aio_mknod $pathname, $mode, $dev, $callback->($status) 233 aio_mknod $pathname, $mode, $dev, $callback->($status)
228 aio_link $srcpath, $dstpath, $callback->($status) 234 aio_link $srcpath, $dstpath, $callback->($status)
229 aio_symlink $srcpath, $dstpath, $callback->($status) 235 aio_symlink $srcpath, $dstpath, $callback->($status)
230 aio_readlink $pathname, $callback->($link) 236 aio_readlink $pathname, $callback->($link)
231 aio_realpath $pathname, $callback->($link) 237 aio_realpath $pathname, $callback->($path)
232 aio_rename $srcpath, $dstpath, $callback->($status) 238 aio_rename $srcpath, $dstpath, $callback->($status)
239 aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
233 aio_mkdir $pathname, $mode, $callback->($status) 240 aio_mkdir $pathname, $mode, $callback->($status)
234 aio_rmdir $pathname, $callback->($status) 241 aio_rmdir $pathname, $callback->($status)
235 aio_readdir $pathname, $callback->($entries) 242 aio_readdir $pathname, $callback->($entries)
236 aio_readdirx $pathname, $flags, $callback->($entries, $flags) 243 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
237 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST 244 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
239 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) 246 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
240 aio_load $pathname, $data, $callback->($status) 247 aio_load $pathname, $data, $callback->($status)
241 aio_copy $srcpath, $dstpath, $callback->($status) 248 aio_copy $srcpath, $dstpath, $callback->($status)
242 aio_move $srcpath, $dstpath, $callback->($status) 249 aio_move $srcpath, $dstpath, $callback->($status)
243 aio_rmtree $pathname, $callback->($status) 250 aio_rmtree $pathname, $callback->($status)
251 aio_fcntl $fh, $cmd, $arg, $callback->($status)
252 aio_ioctl $fh, $request, $buf, $callback->($status)
244 aio_sync $callback->($status) 253 aio_sync $callback->($status)
245 aio_syncfs $fh, $callback->($status) 254 aio_syncfs $fh, $callback->($status)
246 aio_fsync $fh, $callback->($status) 255 aio_fsync $fh, $callback->($status)
247 aio_fdatasync $fh, $callback->($status) 256 aio_fdatasync $fh, $callback->($status)
248 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 257 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
249 aio_pathsync $pathname, $callback->($status) 258 aio_pathsync $pathname, $callback->($status)
250 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 259 aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
251 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 260 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
252 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 261 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
253 aio_mlockall $flags, $callback->($status) 262 aio_mlockall $flags, $callback->($status)
254 aio_group $callback->(...) 263 aio_group $callback->(...)
255 aio_nop $callback->() 264 aio_nop $callback->()
269 IO::AIO::idle_timeout $seconds 278 IO::AIO::idle_timeout $seconds
270 IO::AIO::max_outstanding $maxreqs 279 IO::AIO::max_outstanding $maxreqs
271 IO::AIO::nreqs 280 IO::AIO::nreqs
272 IO::AIO::nready 281 IO::AIO::nready
273 IO::AIO::npending 282 IO::AIO::npending
283 IO::AIO::reinit
284
285 $nfd = IO::AIO::get_fdlimit
286 IO::AIO::min_fdlimit $nfd
274 287
275 IO::AIO::sendfile $ofh, $ifh, $offset, $count 288 IO::AIO::sendfile $ofh, $ifh, $offset, $count
276 IO::AIO::fadvise $fh, $offset, $len, $advice 289 IO::AIO::fadvise $fh, $offset, $len, $advice
290
291 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
292 IO::AIO::munmap $scalar
293 IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]
277 IO::AIO::madvise $scalar, $offset, $length, $advice 294 IO::AIO::madvise $scalar, $offset, $length, $advice
278 IO::AIO::mprotect $scalar, $offset, $length, $protect 295 IO::AIO::mprotect $scalar, $offset, $length, $protect
279 IO::AIO::munlock $scalar, $offset = 0, $length = undef 296 IO::AIO::munlock $scalar, $offset = 0, $length = undef
280 IO::AIO::munlockall 297 IO::AIO::munlockall
298
299 # stat extensions
300 $counter = IO::AIO::st_gen
301 $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
302 ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
303 $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
304 $seconds = IO::AIO::st_btimesec
305 ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
306
307 # very much unportable syscalls
308 IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_len, $flags
309 IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
310 IO::AIO::tee $r_fh, $w_fh, $length, $flags
311 $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
312 ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
313 $fh = IO::AIO::memfd_create $pathname[, $flags]
314 $fh = IO::AIO::eventfd [$initval, [$flags]]
315 $fh = IO::AIO::timerfd_create $clockid[, $flags]
316 ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
317 ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
281 318
282=head2 API NOTES 319=head2 API NOTES
283 320
284All the C<aio_*> calls are more or less thin wrappers around the syscall 321All the C<aio_*> calls are more or less thin wrappers around the syscall
285with the same name (sans C<aio_>). The arguments are similar or identical, 322with the same name (sans C<aio_>). The arguments are similar or identical,
358 395
359 396
360=item aio_open $pathname, $flags, $mode, $callback->($fh) 397=item aio_open $pathname, $flags, $mode, $callback->($fh)
361 398
362Asynchronously open or create a file and call the callback with a newly 399Asynchronously open or create a file and call the callback with a newly
363created filehandle for the file. 400created filehandle for the file (or C<undef> in case of an error).
364 401
365The pathname passed to C<aio_open> must be absolute. See API NOTES, above, 402The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
366for an explanation. 403for an explanation.
367 404
368The C<$flags> argument is a bitmask. See the C<Fcntl> module for a 405The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
391following POSIX and non-POSIX constants are available (missing ones on 428following POSIX and non-POSIX constants are available (missing ones on
392your system are, as usual, C<0>): 429your system are, as usual, C<0>):
393 430
394C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, 431C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
395C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, 432C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
396C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>. 433C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>.
397 434
398 435
399=item aio_close $fh, $callback->($status) 436=item aio_close $fh, $callback->($status)
400 437
401Asynchronously close a file and call the callback with the result 438Asynchronously close a file and call the callback with the result
436=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 473=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
437 474
438=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 475=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
439 476
440Reads or writes C<$length> bytes from or to the specified C<$fh> and 477Reads or writes C<$length> bytes from or to the specified C<$fh> and
441C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> 478C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and
442and calls the callback without the actual number of bytes read (or -1 on 479calls the callback with the actual number of bytes transferred (or -1 on
443error, just like the syscall). 480error, just like the syscall).
444 481
445C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to 482C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
446offset plus the actual number of bytes read. 483offset plus the actual number of bytes read.
447 484
505As native sendfile syscalls (as practically any non-POSIX interface hacked 542As native sendfile syscalls (as practically any non-POSIX interface hacked
506together in a hurry to improve benchmark numbers) tend to be rather buggy 543together in a hurry to improve benchmark numbers) tend to be rather buggy
507on many systems, this implementation tries to work around some known bugs 544on many systems, this implementation tries to work around some known bugs
508in Linux and FreeBSD kernels (probably others, too), but that might fail, 545in Linux and FreeBSD kernels (probably others, too), but that might fail,
509so you really really should check the return value of C<aio_sendfile> - 546so you really really should check the return value of C<aio_sendfile> -
510fewre bytes than expected might have been transferred. 547fewer bytes than expected might have been transferred.
511 548
512 549
513=item aio_readahead $fh,$offset,$length, $callback->($retval) 550=item aio_readahead $fh,$offset,$length, $callback->($retval)
514 551
515C<aio_readahead> populates the page cache with data from a file so that 552C<aio_readahead> populates the page cache with data from a file so that
519whole pages, so that offset is effectively rounded down to a page boundary 556whole pages, so that offset is effectively rounded down to a page boundary
520and bytes are read up to the next page boundary greater than or equal to 557and bytes are read up to the next page boundary greater than or equal to
521(off-set+length). C<aio_readahead> does not read beyond the end of the 558(off-set+length). C<aio_readahead> does not read beyond the end of the
522file. The current file offset of the file is left unchanged. 559file. The current file offset of the file is left unchanged.
523 560
524If that syscall doesn't exist (likely if your OS isn't Linux) it will be 561If that syscall doesn't exist (likely if your kernel isn't Linux) it will
525emulated by simply reading the data, which would have a similar effect. 562be emulated by simply reading the data, which would have a similar effect.
526 563
527 564
528=item aio_stat $fh_or_path, $callback->($status) 565=item aio_stat $fh_or_path, $callback->($status)
529 566
530=item aio_lstat $fh, $callback->($status) 567=item aio_lstat $fh, $callback->($status)
531 568
532Works like perl's C<stat> or C<lstat> in void context. The callback will 569Works almost exactly like perl's C<stat> or C<lstat> in void context. The
533be called after the stat and the results will be available using C<stat _> 570callback will be called after the stat and the results will be available
534or C<-s _> etc... 571using C<stat _> or C<-s _> and other tests (with the exception of C<-B>
572and C<-T>).
535 573
536The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, 574The pathname passed to C<aio_stat> must be absolute. See API NOTES, above,
537for an explanation. 575for an explanation.
538 576
539Currently, the stats are always 64-bit-stats, i.e. instead of returning an 577Currently, the stats are always 64-bit-stats, i.e. instead of returning an
546behaviour). 584behaviour).
547 585
548C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, 586C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
549C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, 587C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
550C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. 588C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
589
590To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME
591ACCESS>.
551 592
552Example: Print the length of F</etc/passwd>: 593Example: Print the length of F</etc/passwd>:
553 594
554 aio_stat "/etc/passwd", sub { 595 aio_stat "/etc/passwd", sub {
555 $_[0] and die "stat failed: $!"; 596 $_[0] and die "stat failed: $!";
599 namemax => 255, 640 namemax => 255,
600 frsize => 1024, 641 frsize => 1024,
601 fsid => 1810 642 fsid => 1810
602 } 643 }
603 644
604
605=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 645=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
606 646
607Works like perl's C<utime> function (including the special case of $atime 647Works like perl's C<utime> function (including the special case of $atime
608and $mtime being undef). Fractional times are supported if the underlying 648and $mtime being undef). Fractional times are supported if the underlying
609syscalls support them. 649syscalls support them.
610 650
611When called with a pathname, uses utimes(2) if available, otherwise 651When called with a pathname, uses utimensat(2) or utimes(2) if available,
612utime(2). If called on a file descriptor, uses futimes(2) if available, 652otherwise utime(2). If called on a file descriptor, uses futimens(2)
613otherwise returns ENOSYS, so this is not portable. 653or futimes(2) if available, otherwise returns ENOSYS, so this is not
654portable.
614 655
615Examples: 656Examples:
616 657
617 # set atime and mtime to current time (basically touch(1)): 658 # set atime and mtime to current time (basically touch(1)):
618 aio_utime "path", undef, undef; 659 aio_utime "path", undef, undef;
636=item aio_truncate $fh_or_path, $offset, $callback->($status) 677=item aio_truncate $fh_or_path, $offset, $callback->($status)
637 678
638Works like truncate(2) or ftruncate(2). 679Works like truncate(2) or ftruncate(2).
639 680
640 681
682=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
683
684Allocates or frees disk space according to the C<$mode> argument. See the
685linux C<fallocate> documentation for details.
686
687C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
688space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>,
689to deallocate a file range.
690
691IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
692(without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range,
693C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE>
694to unshare shared blocks (see your L<fallocate(2)> manpage).
695
696The file system block size used by C<fallocate> is presumably the
697C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes
698can dictate other limitations.
699
700If C<fallocate> isn't available or cannot be emulated (currently no
701emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
702
703
641=item aio_chmod $fh_or_path, $mode, $callback->($status) 704=item aio_chmod $fh_or_path, $mode, $callback->($status)
642 705
643Works like perl's C<chmod> function. 706Works like perl's C<chmod> function.
644 707
645 708
682 745
683 746
684=item aio_realpath $pathname, $callback->($path) 747=item aio_realpath $pathname, $callback->($path)
685 748
686Asynchronously make the path absolute and resolve any symlinks in 749Asynchronously make the path absolute and resolve any symlinks in
687C<$path>. The resulting path only consists of directories (Same as 750C<$path>. The resulting path only consists of directories (same as
688L<Cwd::realpath>). 751L<Cwd::realpath>).
689 752
690This request can be used to get the absolute path of the current working 753This request can be used to get the absolute path of the current working
691directory by passing it a path of F<.> (a single dot). 754directory by passing it a path of F<.> (a single dot).
692 755
693 756
694=item aio_rename $srcpath, $dstpath, $callback->($status) 757=item aio_rename $srcpath, $dstpath, $callback->($status)
695 758
696Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 759Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
697rename(2) and call the callback with the result code. 760rename(2) and call the callback with the result code.
761
762On systems that support the AIO::WD working directory abstraction
763natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
764of failing, C<rename> is called on the absolute path of C<$wd>.
765
766
767=item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
768
769Basically a version of C<aio_rename> with an additional C<$flags>
770argument. Calling this with C<$flags=0> is the same as calling
771C<aio_rename>.
772
773Non-zero flags are currently only supported on GNU/Linux systems that
774support renameat2. Other systems fail with C<ENOSYS> in this case.
775
776The following constants are available (missing ones are, as usual C<0>),
777see renameat2(2) for details:
778
779C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE>
780and C<IO::AIO::RENAME_WHITEOUT>.
698 781
699 782
700=item aio_mkdir $pathname, $mode, $callback->($status) 783=item aio_mkdir $pathname, $mode, $callback->($status)
701 784
702Asynchronously mkdir (create) a directory and call the callback with 785Asynchronously mkdir (create) a directory and call the callback with
707=item aio_rmdir $pathname, $callback->($status) 790=item aio_rmdir $pathname, $callback->($status)
708 791
709Asynchronously rmdir (delete) a directory and call the callback with the 792Asynchronously rmdir (delete) a directory and call the callback with the
710result code. 793result code.
711 794
795On systems that support the AIO::WD working directory abstraction
796natively, the case C<[$wd, "."]> is specialcased - instead of failing,
797C<rmdir> is called on the absolute path of C<$wd>.
798
712 799
713=item aio_readdir $pathname, $callback->($entries) 800=item aio_readdir $pathname, $callback->($entries)
714 801
715Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 802Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
716directory (i.e. opendir + readdir + closedir). The entries will not be 803directory (i.e. opendir + readdir + closedir). The entries will not be
731 818
732=over 4 819=over 4
733 820
734=item IO::AIO::READDIR_DENTS 821=item IO::AIO::READDIR_DENTS
735 822
736When this flag is off, then the callback gets an arrayref consisting of 823Normally the callback gets an arrayref consisting of names only (as
737names only (as with C<aio_readdir>), otherwise it gets an arrayref with 824with C<aio_readdir>). If this flag is set, then the callback gets an
738C<[$name, $type, $inode]> arrayrefs, each describing a single directory 825arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a
739entry in more detail. 826single directory entry in more detail:
740 827
741C<$name> is the name of the entry. 828C<$name> is the name of the entry.
742 829
743C<$type> is one of the C<IO::AIO::DT_xxx> constants: 830C<$type> is one of the C<IO::AIO::DT_xxx> constants:
744 831
745C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, 832C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
746C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, 833C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
747C<IO::AIO::DT_WHT>. 834C<IO::AIO::DT_WHT>.
748 835
749C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to 836C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need
750know, you have to run stat yourself. Also, for speed reasons, the C<$type> 837to know, you have to run stat yourself. Also, for speed/memory reasons,
751scalars are read-only: you can not modify them. 838the C<$type> scalars are read-only: you must not modify them.
752 839
753C<$inode> is the inode number (which might not be exact on systems with 64 840C<$inode> is the inode number (which might not be exact on systems with 64
754bit inode numbers and 32 bit perls). This field has unspecified content on 841bit inode numbers and 32 bit perls). This field has unspecified content on
755systems that do not deliver the inode information. 842systems that do not deliver the inode information.
756 843
767short names are tried first. 854short names are tried first.
768 855
769=item IO::AIO::READDIR_STAT_ORDER 856=item IO::AIO::READDIR_STAT_ORDER
770 857
771When this flag is set, then the names will be returned in an order 858When this flag is set, then the names will be returned in an order
772suitable for stat()'ing each one. That is, when you plan to stat() 859suitable for stat()'ing each one. That is, when you plan to stat() most or
773all files in the given directory, then the returned order will likely 860all files in the given directory, then the returned order will likely be
774be fastest. 861faster.
775 862
776If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then 863If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified,
777the likely dirs come first, resulting in a less optimal stat order. 864then the likely dirs come first, resulting in a less optimal stat order
865for stat'ing all entries, but likely a more optimal order for finding
866subdirectories.
778 867
779=item IO::AIO::READDIR_FOUND_UNKNOWN 868=item IO::AIO::READDIR_FOUND_UNKNOWN
780 869
781This flag should not be set when calling C<aio_readdirx>. Instead, it 870This flag should not be set when calling C<aio_readdirx>. Instead, it
782is being set by C<aio_readdirx>, when any of the C<$type>'s found were 871is being set by C<aio_readdirx>, when any of the C<$type>'s found were
784C<$type>'s are known, which can be used to speed up some algorithms. 873C<$type>'s are known, which can be used to speed up some algorithms.
785 874
786=back 875=back
787 876
788 877
878=item aio_slurp $pathname, $offset, $length, $data, $callback->($status)
879
880Opens, reads and closes the given file. The data is put into C<$data>,
881which is resized as required.
882
883If C<$offset> is negative, then it is counted from the end of the file.
884
885If C<$length> is zero, then the remaining length of the file is
886used. Also, in this case, the same limitations to modifying C<$data> apply
887as when IO::AIO::mmap is used, i.e. it must only be modified in-place
888with C<substr>. If the size of the file is known, specifying a non-zero
889C<$length> results in a performance advantage.
890
891This request is similar to the older C<aio_load> request, but since it is
892a single request, it might be more efficient to use.
893
894Example: load F</etc/passwd> into C<$passwd>.
895
896 my $passwd;
897 aio_slurp "/etc/passwd", 0, 0, $passwd, sub {
898 $_[0] >= 0
899 or die "/etc/passwd: $!\n";
900
901 printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd;
902 print $passwd;
903 };
904 IO::AIO::flush;
905
906
789=item aio_load $pathname, $data, $callback->($status) 907=item aio_load $pathname, $data, $callback->($status)
790 908
791This is a composite request that tries to fully load the given file into 909This is a composite request that tries to fully load the given file into
792memory. Status is the same as with aio_read. 910memory. Status is the same as with aio_read.
911
912Using C<aio_slurp> might be more efficient, as it is a single request.
793 913
794=cut 914=cut
795 915
796sub aio_load($$;$) { 916sub aio_load($$;$) {
797 my ($path, undef, $cb) = @_; 917 my ($path, undef, $cb) = @_;
817=item aio_copy $srcpath, $dstpath, $callback->($status) 937=item aio_copy $srcpath, $dstpath, $callback->($status)
818 938
819Try to copy the I<file> (directories not supported as either source or 939Try to copy the I<file> (directories not supported as either source or
820destination) from C<$srcpath> to C<$dstpath> and call the callback with 940destination) from C<$srcpath> to C<$dstpath> and call the callback with
821a status of C<0> (ok) or C<-1> (error, see C<$!>). 941a status of C<0> (ok) or C<-1> (error, see C<$!>).
942
943Existing destination files will be truncated.
822 944
823This is a composite request that creates the destination file with 945This is a composite request that creates the destination file with
824mode 0200 and copies the contents of the source file into it using 946mode 0200 and copies the contents of the source file into it using
825C<aio_sendfile>, followed by restoring atime, mtime, access mode and 947C<aio_sendfile>, followed by restoring atime, mtime, access mode and
826uid/gid, in that order. 948uid/gid, in that order.
936Scans a directory (similar to C<aio_readdir>) but additionally tries to 1058Scans a directory (similar to C<aio_readdir>) but additionally tries to
937efficiently separate the entries of directory C<$path> into two sets of 1059efficiently separate the entries of directory C<$path> into two sets of
938names, directories you can recurse into (directories), and ones you cannot 1060names, directories you can recurse into (directories), and ones you cannot
939recurse into (everything else, including symlinks to directories). 1061recurse into (everything else, including symlinks to directories).
940 1062
941C<aio_scandir> is a composite request that creates of many sub requests_ 1063C<aio_scandir> is a composite request that generates many sub requests.
942C<$maxreq> specifies the maximum number of outstanding aio requests that 1064C<$maxreq> specifies the maximum number of outstanding aio requests that
943this function generates. If it is C<< <= 0 >>, then a suitable default 1065this function generates. If it is C<< <= 0 >>, then a suitable default
944will be chosen (currently 4). 1066will be chosen (currently 4).
945 1067
946On error, the callback is called without arguments, otherwise it receives 1068On error, the callback is called without arguments, otherwise it receives
1010 aioreq_pri $pri; 1132 aioreq_pri $pri;
1011 add $grp aio_stat $wd, sub { 1133 add $grp aio_stat $wd, sub {
1012 return $grp->result () if $_[0]; 1134 return $grp->result () if $_[0];
1013 my $now = time; 1135 my $now = time;
1014 my $hash1 = join ":", (stat _)[0,1,3,7,9]; 1136 my $hash1 = join ":", (stat _)[0,1,3,7,9];
1137 my $rdxflags = READDIR_DIRS_FIRST;
1138
1139 if ((stat _)[3] < 2) {
1140 # at least one non-POSIX filesystem exists
1141 # that returns useful DT_type values: btrfs,
1142 # so optimise for this here by requesting dents
1143 $rdxflags |= READDIR_DENTS;
1144 }
1015 1145
1016 # read the directory entries 1146 # read the directory entries
1017 aioreq_pri $pri; 1147 aioreq_pri $pri;
1018 add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub { 1148 add $grp aio_readdirx $wd, $rdxflags, sub {
1019 my $entries = shift 1149 my ($entries, $flags) = @_
1020 or return $grp->result (); 1150 or return $grp->result ();
1151
1152 if ($rdxflags & READDIR_DENTS) {
1153 # if we requested type values, see if we can use them directly.
1154
1155 # if there were any DT_UNKNOWN entries then we assume we
1156 # don't know. alternatively, we could assume that if we get
1157 # one DT_DIR, then all directories are indeed marked with
1158 # DT_DIR, but this seems not required for btrfs, and this
1159 # is basically the "btrfs can't get it's act together" code
1160 # branch.
1161 unless ($flags & READDIR_FOUND_UNKNOWN) {
1162 # now we have valid DT_ information for all entries,
1163 # so use it as an optimisation without further stat's.
1164 # they must also all be at the beginning of @$entries
1165 # by now.
1166
1167 my $dirs;
1168
1169 if (@$entries) {
1170 for (0 .. $#$entries) {
1171 if ($entries->[$_][1] != DT_DIR) {
1172 # splice out directories
1173 $dirs = [splice @$entries, 0, $_];
1174 last;
1175 }
1176 }
1177
1178 # if we didn't find any non-dir, then all entries are dirs
1179 unless ($dirs) {
1180 ($dirs, $entries) = ($entries, []);
1181 }
1182 } else {
1183 # directory is empty, so there are no sbdirs
1184 $dirs = [];
1185 }
1186
1187 # either splice'd the directories out or the dir was empty.
1188 # convert dents to filenames
1189 $_ = $_->[0] for @$dirs;
1190 $_ = $_->[0] for @$entries;
1191
1192 return $grp->result ($dirs, $entries);
1193 }
1194
1195 # cannot use, so return to our old ways
1196 # by pretending we only scanned for names.
1197 $_ = $_->[0] for @$entries;
1198 }
1021 1199
1022 # stat the dir another time 1200 # stat the dir another time
1023 aioreq_pri $pri; 1201 aioreq_pri $pri;
1024 add $grp aio_stat $wd, sub { 1202 add $grp aio_stat $wd, sub {
1025 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 1203 my $hash2 = join ":", (stat _)[0,1,3,7,9];
1080} 1258}
1081 1259
1082=item aio_rmtree $pathname, $callback->($status) 1260=item aio_rmtree $pathname, $callback->($status)
1083 1261
1084Delete a directory tree starting (and including) C<$path>, return the 1262Delete a directory tree starting (and including) C<$path>, return the
1085status of the final C<rmdir> only. This is a composite request that 1263status of the final C<rmdir> only. This is a composite request that
1086uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1264uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1087everything else. 1265everything else.
1088 1266
1089=cut 1267=cut
1090 1268
1111 add $grp $dirgrp; 1289 add $grp $dirgrp;
1112 }; 1290 };
1113 1291
1114 $grp 1292 $grp
1115} 1293}
1294
1295=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
1296
1297=item aio_ioctl $fh, $request, $buf, $callback->($status)
1298
1299These work just like the C<fcntl> and C<ioctl> built-in functions, except
1300they execute asynchronously and pass the return value to the callback.
1301
1302Both calls can be used for a lot of things, some of which make more sense
1303to run asynchronously in their own thread, while some others make less
1304sense. For example, calls that block waiting for external events, such
1305as locking, will also lock down an I/O thread while it is waiting, which
1306can deadlock the whole I/O system. At the same time, there might be no
1307alternative to using a thread to wait.
1308
1309So in general, you should only use these calls for things that do
1310(filesystem) I/O, not for things that wait for other events (network,
1311other processes), although if you are careful and know what you are doing,
1312you still can.
1313
1314The following constants are available and can be used for normal C<ioctl>
1315and C<fcntl> as well (missing ones are, as usual C<0>):
1316
1317C<F_DUPFD_CLOEXEC>,
1318
1319C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
1320
1321C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
1322
1323C<F_ADD_SEALS>, C<F_GET_SEALS>, C<F_SEAL_SEAL>, C<F_SEAL_SHRINK>, C<F_SEAL_GROW> and
1324C<F_SEAL_WRITE>.
1325
1326C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
1327C<FS_IOC_FIEMAP>.
1328
1329C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
1330C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
1331
1332C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
1333C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
1334C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
1335C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
1336C<FS_FL_USER_MODIFIABLE>.
1337
1338C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
1339C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
1340C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
1341C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
1116 1342
1117=item aio_sync $callback->($status) 1343=item aio_sync $callback->($status)
1118 1344
1119Asynchronously call sync and call the callback when finished. 1345Asynchronously call sync and call the callback when finished.
1120 1346
1189 }; 1415 };
1190 1416
1191 $grp 1417 $grp
1192} 1418}
1193 1419
1194=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 1420=item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
1195 1421
1196This is a rather advanced IO::AIO call, which only works on mmap(2)ed 1422This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1197scalars (see the C<IO::AIO::mmap> function, although it also works on data 1423scalars (see the C<IO::AIO::mmap> function, although it also works on data
1198scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the 1424scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1199scalar must only be modified in-place while an aio operation is pending on 1425scalar must only be modified in-place while an aio operation is pending on
1201 1427
1202It calls the C<msync> function of your OS, if available, with the memory 1428It calls the C<msync> function of your OS, if available, with the memory
1203area starting at C<$offset> in the string and ending C<$length> bytes 1429area starting at C<$offset> in the string and ending C<$length> bytes
1204later. If C<$length> is negative, counts from the end, and if C<$length> 1430later. If C<$length> is negative, counts from the end, and if C<$length>
1205is C<undef>, then it goes till the end of the string. The flags can be 1431is C<undef>, then it goes till the end of the string. The flags can be
1206a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and 1432either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional
1207C<IO::AIO::MS_SYNC>. 1433C<IO::AIO::MS_INVALIDATE>.
1208 1434
1209=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 1435=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1210 1436
1211This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1437This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1212scalars. 1438scalars.
1213 1439
1214It touches (reads or writes) all memory pages in the specified 1440It touches (reads or writes) all memory pages in the specified
1215range inside the scalar. All caveats and parameters are the same 1441range inside the scalar. All caveats and parameters are the same
1216as for C<aio_msync>, above, except for flags, which must be either 1442as for C<aio_msync>, above, except for flags, which must be either
1217C<0> (which reads all pages and ensures they are instantiated) or 1443C<0> (which reads all pages and ensures they are instantiated) or
1218C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and 1444C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1219writing an octet from it, which dirties the page). 1445writing an octet from it, which dirties the page).
1220 1446
1221=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 1447=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1222 1448
1223This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1449This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1242 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; 1468 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1243 aio_mlock $data; # mlock in background 1469 aio_mlock $data; # mlock in background
1244 1470
1245=item aio_mlockall $flags, $callback->($status) 1471=item aio_mlockall $flags, $callback->($status)
1246 1472
1247Calls the C<mlockall> function with the given C<$flags> (a combination of 1473Calls the C<mlockall> function with the given C<$flags> (a
1248C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>). 1474combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and
1475C<IO::AIO::MCL_ONFAULT>).
1249 1476
1250On systems that do not implement C<mlockall>, this function returns C<-1> 1477On systems that do not implement C<mlockall>, this function returns C<-1>
1251and sets errno to C<ENOSYS>. 1478and sets errno to C<ENOSYS>. Similarly, flag combinations not supported
1479by the system result in a return value of C<-1> with errno being set to
1480C<EINVAL>.
1252 1481
1253Note that the corresponding C<munlockall> is synchronous and is 1482Note that the corresponding C<munlockall> is synchronous and is
1254documented under L<MISCELLANEOUS FUNCTIONS>. 1483documented under L<MISCELLANEOUS FUNCTIONS>.
1255 1484
1256Example: asynchronously lock all current and future pages into memory. 1485Example: asynchronously lock all current and future pages into memory.
1257 1486
1258 aio_mlockall IO::AIO::MCL_FUTURE; 1487 aio_mlockall IO::AIO::MCL_FUTURE;
1259 1488
1260=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) 1489=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1261 1490
1262Queries the extents of the given file (by calling the Linux FIEMAP ioctl, 1491Queries the extents of the given file (by calling the Linux C<FIEMAP>
1263see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the 1492ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1264C<ioctl> is not available on your OS, then this rquiest will fail with 1493the ioctl is not available on your OS, then this request will fail with
1265C<ENOSYS>. 1494C<ENOSYS>.
1266 1495
1267C<$start> is the starting offset to query extents for, C<$length> is the 1496C<$start> is the starting offset to query extents for, C<$length> is the
1268size of the range to query - if it is C<undef>, then the whole file will 1497size of the range to query - if it is C<undef>, then the whole file will
1269be queried. 1498be queried.
1272C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also 1501C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1273exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query 1502exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1274the data portion. 1503the data portion.
1275 1504
1276C<$count> is the maximum number of extent records to return. If it is 1505C<$count> is the maximum number of extent records to return. If it is
1277C<undef>, then IO::AIO queries all extents of the file. As a very special 1506C<undef>, then IO::AIO queries all extents of the range. As a very special
1278case, if it is C<0>, then the callback receives the number of extents 1507case, if it is C<0>, then the callback receives the number of extents
1279instead of the extents themselves. 1508instead of the extents themselves (which is unreliable, see below).
1280 1509
1281If an error occurs, the callback receives no arguments. The special 1510If an error occurs, the callback receives no arguments. The special
1282C<errno> value C<IO::AIO::EBADR> is available to test for flag errors. 1511C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1283 1512
1284Otherwise, the callback receives an array reference with extent 1513Otherwise, the callback receives an array reference with extent
1286following members: 1515following members:
1287 1516
1288 [$logical, $physical, $length, $flags] 1517 [$logical, $physical, $length, $flags]
1289 1518
1290Flags is any combination of the following flag values (typically either C<0> 1519Flags is any combination of the following flag values (typically either C<0>
1291or C<IO::AIO::FIEMAP_EXTENT_LAST>): 1520or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1292 1521
1293C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>, 1522C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1294C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>, 1523C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1295C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, 1524C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1296C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, 1525C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1297C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or 1526C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1298C<IO::AIO::FIEMAP_EXTENT_SHARED>. 1527C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1299 1528
1529At the time of this writing (Linux 3.2), this request is unreliable unless
1530C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1531it to return all extents of a range for files with a large number of
1532extents. The code (only) works around all these issues if C<$count> is
1533C<undef>.
1534
1300=item aio_group $callback->(...) 1535=item aio_group $callback->(...)
1301 1536
1302This is a very special aio request: Instead of doing something, it is a 1537This is a very special aio request: Instead of doing something, it is a
1303container for other aio requests, which is useful if you want to bundle 1538container for other aio requests, which is useful if you want to bundle
1304many requests into a single, composite, request with a definite callback 1539many requests into a single, composite, request with a definite callback
1387 aio_stat [$etcdir, "passwd"], sub { 1622 aio_stat [$etcdir, "passwd"], sub {
1388 # yay 1623 # yay
1389 }; 1624 };
1390 }; 1625 };
1391 1626
1392That C<aio_wd> is a request and not a normal function shows that creating 1627The fact that C<aio_wd> is a request and not a normal function shows that
1393an IO::AIO::WD object is itself a potentially blocking operation, which is 1628creating an IO::AIO::WD object is itself a potentially blocking operation,
1394why it is done asynchronously. 1629which is why it is done asynchronously.
1395 1630
1396To stat the directory obtained with C<aio_wd> above, one could write 1631To stat the directory obtained with C<aio_wd> above, one could write
1397either of the following three request calls: 1632either of the following three request calls:
1398 1633
1399 aio_lstat "/etc" , sub { ... # pathname as normal string 1634 aio_lstat "/etc" , sub { ... # pathname as normal string
1416There are some caveats: when directories get renamed (or deleted), the 1651There are some caveats: when directories get renamed (or deleted), the
1417pathname string doesn't change, so will point to the new directory (or 1652pathname string doesn't change, so will point to the new directory (or
1418nowhere at all), while the directory fd, if available on the system, 1653nowhere at all), while the directory fd, if available on the system,
1419will still point to the original directory. Most functions accepting a 1654will still point to the original directory. Most functions accepting a
1420pathname will use the directory fd on newer systems, and the string on 1655pathname will use the directory fd on newer systems, and the string on
1421older systems. Some functions (such as realpath) will always rely on the 1656older systems. Some functions (such as C<aio_realpath>) will always rely on
1422string form of the pathname. 1657the string form of the pathname.
1423 1658
1424So this fucntionality is mainly useful to get some protection against 1659So this functionality is mainly useful to get some protection against
1425C<chdir>, to easily get an absolute path out of a relative path for future 1660C<chdir>, to easily get an absolute path out of a relative path for future
1426reference, and to speed up doing many operations in the same directory 1661reference, and to speed up doing many operations in the same directory
1427(e.g. when stat'ing all files in a directory). 1662(e.g. when stat'ing all files in a directory).
1428 1663
1429The following functions implement this working directory abstraction: 1664The following functions implement this working directory abstraction:
1442passing C<undef> as working directory component of a pathname fails the 1677passing C<undef> as working directory component of a pathname fails the
1443request with C<ENOENT>, there is often no need for error checking in the 1678request with C<ENOENT>, there is often no need for error checking in the
1444C<aio_wd> callback, as future requests using the value will fail in the 1679C<aio_wd> callback, as future requests using the value will fail in the
1445expected way. 1680expected way.
1446 1681
1447If this call isn't available because your OS lacks it or it couldn't be
1448detected, it will be emulated by calling C<fsync> instead.
1449
1450=item IO::AIO::CWD 1682=item IO::AIO::CWD
1451 1683
1452This is a compiletime constant (object) that represents the process 1684This is a compile time constant (object) that represents the process
1453current working directory. 1685current working directory.
1454 1686
1455Specifying this object as working directory object for a pathname is as 1687Specifying this object as working directory object for a pathname is as if
1456if the pathname would be specified directly, without a directory object, 1688the pathname would be specified directly, without a directory object. For
1457e.g., these calls are functionally identical: 1689example, these calls are functionally identical:
1458 1690
1459 aio_stat "somefile", sub { ... }; 1691 aio_stat "somefile", sub { ... };
1460 aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; 1692 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1461 1693
1462=back 1694=back
1463 1695
1696To recover the path associated with an IO::AIO::WD object, you can use
1697C<aio_realpath>:
1698
1699 aio_realpath $wd, sub {
1700 warn "path is $_[0]\n";
1701 };
1702
1703Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
1704sometimes, fall back to using an absolue path.
1464 1705
1465=head2 IO::AIO::REQ CLASS 1706=head2 IO::AIO::REQ CLASS
1466 1707
1467All non-aggregate C<aio_*> functions return an object of this class when 1708All non-aggregate C<aio_*> functions return an object of this class when
1468called in non-void context. 1709called in non-void context.
1629The default value for the limit is C<0>, but note that setting a feeder 1870The default value for the limit is C<0>, but note that setting a feeder
1630automatically bumps it up to C<2>. 1871automatically bumps it up to C<2>.
1631 1872
1632=back 1873=back
1633 1874
1875
1634=head2 SUPPORT FUNCTIONS 1876=head2 SUPPORT FUNCTIONS
1635 1877
1636=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1878=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1637 1879
1638=over 4 1880=over 4
1646 1888
1647See C<poll_cb> for an example. 1889See C<poll_cb> for an example.
1648 1890
1649=item IO::AIO::poll_cb 1891=item IO::AIO::poll_cb
1650 1892
1651Process some outstanding events on the result pipe. You have to call 1893Process some requests that have reached the result phase (i.e. they have
1894been executed but the results are not yet reported). You have to call
1895this "regularly" to finish outstanding requests.
1896
1652this regularly. Returns C<0> if all events could be processed (or there 1897Returns C<0> if all events could be processed (or there were no
1653were no events to process), or C<-1> if it returned earlier for whatever 1898events to process), or C<-1> if it returned earlier for whatever
1654reason. Returns immediately when no events are outstanding. The amount of 1899reason. Returns immediately when no events are outstanding. The amount
1655events processed depends on the settings of C<IO::AIO::max_poll_req> and 1900of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1656C<IO::AIO::max_poll_time>. 1901C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1657 1902
1658If not all requests were processed for whatever reason, the filehandle 1903If not all requests were processed for whatever reason, the poll file
1659will still be ready when C<poll_cb> returns, so normally you don't have to 1904descriptor will still be ready when C<poll_cb> returns, so normally you
1660do anything special to have it called later. 1905don't have to do anything special to have it called later.
1661 1906
1662Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes 1907Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1663ready, it can be beneficial to call this function from loops which submit 1908ready, it can be beneficial to call this function from loops which submit
1664a lot of requests, to make sure the results get processed when they become 1909a lot of requests, to make sure the results get processed when they become
1665available and not just when the loop is finished and the event loop takes 1910available and not just when the loop is finished and the event loop takes
1674 poll => 'r', async => 1, 1919 poll => 'r', async => 1,
1675 cb => \&IO::AIO::poll_cb); 1920 cb => \&IO::AIO::poll_cb);
1676 1921
1677=item IO::AIO::poll_wait 1922=item IO::AIO::poll_wait
1678 1923
1679If there are any outstanding requests and none of them in the result 1924Wait until either at least one request is in the result phase or no
1680phase, wait till the result filehandle becomes ready for reading (simply 1925requests are outstanding anymore.
1681does a C<select> on the filehandle. This is useful if you want to 1926
1682synchronously wait for some requests to finish). 1927This is useful if you want to synchronously wait for some requests to
1928become ready, without actually handling them.
1683 1929
1684See C<nreqs> for an example. 1930See C<nreqs> for an example.
1685 1931
1686=item IO::AIO::poll 1932=item IO::AIO::poll
1687 1933
1698 1944
1699Strictly equivalent to: 1945Strictly equivalent to:
1700 1946
1701 IO::AIO::poll_wait, IO::AIO::poll_cb 1947 IO::AIO::poll_wait, IO::AIO::poll_cb
1702 while IO::AIO::nreqs; 1948 while IO::AIO::nreqs;
1949
1950This function can be useful at program aborts, to make sure outstanding
1951I/O has been done (C<IO::AIO> uses an C<END> block which already calls
1952this function on normal exits), or when you are merely using C<IO::AIO>
1953for its more advanced functions, rather than for async I/O, e.g.:
1954
1955 my ($dirs, $nondirs);
1956 IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
1957 IO::AIO::flush;
1958 # $dirs, $nondirs are now set
1703 1959
1704=item IO::AIO::max_poll_reqs $nreqs 1960=item IO::AIO::max_poll_reqs $nreqs
1705 1961
1706=item IO::AIO::max_poll_time $seconds 1962=item IO::AIO::max_poll_time $seconds
1707 1963
1734 poll => 'r', nice => 1, 1990 poll => 'r', nice => 1,
1735 cb => &IO::AIO::poll_cb); 1991 cb => &IO::AIO::poll_cb);
1736 1992
1737=back 1993=back
1738 1994
1995
1739=head3 CONTROLLING THE NUMBER OF THREADS 1996=head3 CONTROLLING THE NUMBER OF THREADS
1740 1997
1741=over 1998=over
1742 1999
1743=item IO::AIO::min_parallel $nthreads 2000=item IO::AIO::min_parallel $nthreads
1808 2065
1809This is a very bad function to use in interactive programs because it 2066This is a very bad function to use in interactive programs because it
1810blocks, and a bad way to reduce concurrency because it is inexact: Better 2067blocks, and a bad way to reduce concurrency because it is inexact: Better
1811use an C<aio_group> together with a feed callback. 2068use an C<aio_group> together with a feed callback.
1812 2069
1813It's main use is in scripts without an event loop - when you want to stat 2070Its main use is in scripts without an event loop - when you want to stat
1814a lot of files, you can write somehting like this: 2071a lot of files, you can write something like this:
1815 2072
1816 IO::AIO::max_outstanding 32; 2073 IO::AIO::max_outstanding 32;
1817 2074
1818 for my $path (...) { 2075 for my $path (...) {
1819 aio_stat $path , ...; 2076 aio_stat $path , ...;
1830The default value for C<max_outstanding> is very large, so there is no 2087The default value for C<max_outstanding> is very large, so there is no
1831practical limit on the number of outstanding requests. 2088practical limit on the number of outstanding requests.
1832 2089
1833=back 2090=back
1834 2091
2092
1835=head3 STATISTICAL INFORMATION 2093=head3 STATISTICAL INFORMATION
1836 2094
1837=over 2095=over
1838 2096
1839=item IO::AIO::nreqs 2097=item IO::AIO::nreqs
1856Returns the number of requests currently in the pending state (executed, 2114Returns the number of requests currently in the pending state (executed,
1857but not yet processed by poll_cb). 2115but not yet processed by poll_cb).
1858 2116
1859=back 2117=back
1860 2118
2119
2120=head3 SUBSECOND STAT TIME ACCESS
2121
2122Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can
2123generally find access/modification and change times with subsecond time
2124accuracy of the system supports it, but perl's built-in functions only
2125return the integer part.
2126
2127The following functions return the timestamps of the most recent
2128stat with subsecond precision on most systems and work both after
2129C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return
2130value is only meaningful after a successful C<stat>/C<lstat> call, or
2131during/after a successful C<aio_stat>/C<aio_lstat> callback.
2132
2133This is similar to the L<Time::HiRes> C<stat> functions, but can return
2134full resolution without rounding and work with standard perl C<stat>,
2135alleviating the need to call the special C<Time::HiRes> functions, which
2136do not act like their perl counterparts.
2137
2138On operating systems or file systems where subsecond time resolution is
2139not supported or could not be detected, a fractional part of C<0> is
2140returned, so it is always safe to call these functions.
2141
2142=over 4
2143
2144=item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
2145
2146Return the access, modication, change or birth time, respectively,
2147including fractional part. Due to the limited precision of floating point,
2148the accuracy on most platforms is only a bit better than milliseconds
2149for times around now - see the I<nsec> function family, below, for full
2150accuracy.
2151
2152File birth time is only available when the OS and perl support it (on
2153FreeBSD and NetBSD at the time of this writing, although support is
2154adaptive, so if your OS/perl gains support, IO::AIO can take advantage of
2155it). On systems where it isn't available, C<0> is currently returned, but
2156this might change to C<undef> in a future version.
2157
2158=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
2159
2160Returns access, modification, change and birth time all in one go, and
2161maybe more times in the future version.
2162
2163=item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
2164
2165Return the fractional access, modifcation, change or birth time, in nanoseconds,
2166as an integer in the range C<0> to C<999999999>.
2167
2168Note that no accessors are provided for access, modification and
2169change times - you need to get those from C<stat _> if required (C<int
2170IO::AIO::st_atime> and so on will I<not> generally give you the correct
2171value).
2172
2173=item $seconds = IO::AIO::st_btimesec
2174
2175The (integral) seconds part of the file birth time, if available.
2176
2177=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
2178
2179Like the functions above, but returns all four times in one go (and maybe
2180more in future versions).
2181
2182=item $counter = IO::AIO::st_gen
2183
2184Returns the generation counter (in practice this is just a random number)
2185of the file. This is only available on platforms which have this member in
2186their C<struct stat> (most BSDs at the time of this writing) and generally
2187only to the root usert. If unsupported, C<0> is returned, but this might
2188change to C<undef> in a future version.
2189
2190=back
2191
2192Example: print the high resolution modification time of F</etc>, using
2193C<stat>, and C<IO::AIO::aio_stat>.
2194
2195 if (stat "/etc") {
2196 printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
2197 }
2198
2199 IO::AIO::aio_stat "/etc", sub {
2200 $_[0]
2201 and return;
2202
2203 printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
2204 };
2205
2206 IO::AIO::flush;
2207
2208Output of the awbove on my system, showing reduced and full accuracy:
2209
2210 stat(/etc) mtime: 1534043702.020808
2211 aio_stat(/etc) mtime: 1534043702.020807792
2212
2213
1861=head3 MISCELLANEOUS FUNCTIONS 2214=head3 MISCELLANEOUS FUNCTIONS
1862 2215
1863IO::AIO implements some functions that might be useful, but are not 2216IO::AIO implements some functions that are useful when you want to use
1864asynchronous. 2217some "Advanced I/O" function not available to in Perl, without going the
2218"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
2219counterpart.
1865 2220
1866=over 4 2221=over 4
2222
2223=item $numfd = IO::AIO::get_fdlimit
2224
2225Tries to find the current file descriptor limit and returns it, or
2226C<undef> and sets C<$!> in case of an error. The limit is one larger than
2227the highest valid file descriptor number.
2228
2229=item IO::AIO::min_fdlimit [$numfd]
2230
2231Try to increase the current file descriptor limit(s) to at least C<$numfd>
2232by changing the soft or hard file descriptor resource limit. If C<$numfd>
2233is missing, it will try to set a very high limit, although this is not
2234recommended when you know the actual minimum that you require.
2235
2236If the limit cannot be raised enough, the function makes a best-effort
2237attempt to increase the limit as much as possible, using various
2238tricks, while still failing. You can query the resulting limit using
2239C<IO::AIO::get_fdlimit>.
2240
2241If an error occurs, returns C<undef> and sets C<$!>, otherwise returns
2242true.
1867 2243
1868=item IO::AIO::sendfile $ofh, $ifh, $offset, $count 2244=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1869 2245
1870Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, 2246Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
1871but is blocking (this makes most sense if you know the input data is 2247but is blocking (this makes most sense if you know the input data is
1888=item IO::AIO::madvise $scalar, $offset, $len, $advice 2264=item IO::AIO::madvise $scalar, $offset, $len, $advice
1889 2265
1890Simply calls the C<posix_madvise> function (see its 2266Simply calls the C<posix_madvise> function (see its
1891manpage for details). The following advice constants are 2267manpage for details). The following advice constants are
1892available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, 2268available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1893C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. 2269C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>,
2270C<IO::AIO::MADV_DONTNEED>.
2271
2272If C<$offset> is negative, counts from the end. If C<$length> is negative,
2273the remaining length of the C<$scalar> is used. If possible, C<$length>
2274will be reduced to fit into the C<$scalar>.
1894 2275
1895On systems that do not implement C<posix_madvise>, this function returns 2276On systems that do not implement C<posix_madvise>, this function returns
1896ENOSYS, otherwise the return value of C<posix_madvise>. 2277ENOSYS, otherwise the return value of C<posix_madvise>.
1897 2278
1898=item IO::AIO::mprotect $scalar, $offset, $len, $protect 2279=item IO::AIO::mprotect $scalar, $offset, $len, $protect
1900Simply calls the C<mprotect> function on the preferably AIO::mmap'ed 2281Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1901$scalar (see its manpage for details). The following protect 2282$scalar (see its manpage for details). The following protect
1902constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, 2283constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1903C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. 2284C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1904 2285
2286If C<$offset> is negative, counts from the end. If C<$length> is negative,
2287the remaining length of the C<$scalar> is used. If possible, C<$length>
2288will be reduced to fit into the C<$scalar>.
2289
1905On systems that do not implement C<mprotect>, this function returns 2290On systems that do not implement C<mprotect>, this function returns
1906ENOSYS, otherwise the return value of C<mprotect>. 2291ENOSYS, otherwise the return value of C<mprotect>.
1907 2292
1908=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 2293=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1909 2294
1910Memory-maps a file (or anonymous memory range) and attaches it to the 2295Memory-maps a file (or anonymous memory range) and attaches it to the
1911given C<$scalar>, which will act like a string scalar. 2296given C<$scalar>, which will act like a string scalar. Returns true on
2297success, and false otherwise.
1912 2298
2299The scalar must exist, but its contents do not matter - this means you
2300cannot use a nonexistant array or hash element. When in doubt, C<undef>
2301the scalar first.
2302
1913The only operations allowed on the scalar are C<substr>/C<vec> that don't 2303The only operations allowed on the mmapped scalar are C<substr>/C<vec>,
1914change the string length, and most read-only operations such as copying it 2304which don't change the string length, and most read-only operations such
1915or searching it with regexes and so on. 2305as copying it or searching it with regexes and so on.
1916 2306
1917Anything else is unsafe and will, at best, result in memory leaks. 2307Anything else is unsafe and will, at best, result in memory leaks.
1918 2308
1919The memory map associated with the C<$scalar> is automatically removed 2309The memory map associated with the C<$scalar> is automatically removed
1920when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or 2310when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap>
1921C<IO::AIO::munmap> functions are called. 2311or C<IO::AIO::munmap> functions are called on it.
1922 2312
1923This calls the C<mmap>(2) function internally. See your system's manual 2313This calls the C<mmap>(2) function internally. See your system's manual
1924page for details on the C<$length>, C<$prot> and C<$flags> parameters. 2314page for details on the C<$length>, C<$prot> and C<$flags> parameters.
1925 2315
1926The C<$length> must be larger than zero and smaller than the actual 2316The C<$length> must be larger than zero and smaller than the actual
1927filesize. 2317filesize.
1928 2318
1929C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, 2319C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1930C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, 2320C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1931 2321
1932C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or 2322C<$flags> can be a combination of
1933C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when 2323C<IO::AIO::MAP_SHARED> or
1934not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS> 2324C<IO::AIO::MAP_PRIVATE>,
2325or a number of system-specific flags (when not available, the are C<0>):
1935(which is set to C<MAP_ANON> if your system only provides this 2326C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
1936constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>, 2327C<IO::AIO::MAP_LOCKED>,
1937C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or 2328C<IO::AIO::MAP_NORESERVE>,
2329C<IO::AIO::MAP_POPULATE>,
1938C<IO::AIO::MAP_NONBLOCK> 2330C<IO::AIO::MAP_NONBLOCK>,
2331C<IO::AIO::MAP_FIXED>,
2332C<IO::AIO::MAP_GROWSDOWN>,
2333C<IO::AIO::MAP_32BIT>,
2334C<IO::AIO::MAP_HUGETLB> or
2335C<IO::AIO::MAP_STACK>.
1939 2336
1940If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. 2337If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1941 2338
1942C<$offset> is the offset from the start of the file - it generally must be 2339C<$offset> is the offset from the start of the file - it generally must be
1943a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. 2340a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
1957 2354
1958=item IO::AIO::munmap $scalar 2355=item IO::AIO::munmap $scalar
1959 2356
1960Removes a previous mmap and undefines the C<$scalar>. 2357Removes a previous mmap and undefines the C<$scalar>.
1961 2358
2359=item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0]
2360
2361Calls the Linux-specific mremap(2) system call. The C<$scalar> must have
2362been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be
2363C<0> or C<IO::AIO::MREMAP_MAYMOVE>.
2364
2365Returns true if successful, and false otherwise. If the underlying mmapped
2366region has changed address, then the true value has the numerical value
2367C<1>, otherwise it has the numerical value C<0>:
2368
2369 my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
2370 or die "mremap: $!";
2371
2372 if ($success*1) {
2373 warn "scalar has chanegd address in memory\n";
2374 }
2375
2376C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently
2377implemented, but not supported and might go away in a future version.
2378
2379On systems where this call is not supported or is not emulated, this call
2380returns falls and sets C<$!> to C<ENOSYS>.
2381
2382=item IO::AIO::mlockall $flags
2383
2384Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>,
2385but is blocking.
2386
1962=item IO::AIO::munlock $scalar, $offset = 0, $length = undef 2387=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
1963 2388
1964Calls the C<munlock> function, undoing the effects of a previous 2389Calls the C<munlock> function, undoing the effects of a previous
1965C<aio_mlock> call (see its description for details). 2390C<aio_mlock> call (see its description for details).
1966 2391
1968 2393
1969Calls the C<munlockall> function. 2394Calls the C<munlockall> function.
1970 2395
1971On systems that do not implement C<munlockall>, this function returns 2396On systems that do not implement C<munlockall>, this function returns
1972ENOSYS, otherwise the return value of C<munlockall>. 2397ENOSYS, otherwise the return value of C<munlockall>.
2398
2399=item $fh = IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_maxlen, $flags
2400
2401Uses the GNU/Linux C<accept4(2)> syscall, if available, to accept a socket
2402and return the new file handle on success, or sets C<$!> and returns
2403C<undef> on error.
2404
2405The remote name of the new socket will be stored in C<$sockaddr>, which
2406will be extended to allow for at least C<$sockaddr_maxlen> octets. If the
2407socket name does not fit into C<$sockaddr_maxlen> octets, this is signaled
2408by returning a longer string in C<$sockaddr>, which might or might not be
2409truncated.
2410
2411To accept name-less sockets, use C<undef> for C<$sockaddr> and C<0> for
2412C<$sockaddr_maxlen>.
2413
2414The main reasons to use this syscall rather than portable C<accept(2)>
2415are that you can specify C<SOCK_NONBLOCK> and/or C<SOCK_CLOEXEC>
2416flags and you can accept name-less sockets by specifying C<0> for
2417C<$sockaddr_maxlen>, which is sadly not possible with perl's interface to
2418C<accept>.
1973 2419
1974=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags 2420=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
1975 2421
1976Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or 2422Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
1977C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they 2423C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
1978should be the file offset. 2424should be the file offset.
1979 2425
2426C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2427silently corrupt the data in this case.
2428
1980The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>, 2429The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
1981C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and 2430C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
1982C<IO::AIO::SPLICE_F_GIFT>. 2431C<IO::AIO::SPLICE_F_GIFT>.
1983 2432
1984See the C<splice(2)> manpage for details. 2433See the C<splice(2)> manpage for details.
1985 2434
1986=item IO::AIO::tee $r_fh, $w_fh, $length, $flags 2435=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
1987 2436
1988Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the 2437Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
1989description for C<IO::AIO::splice> above for details. 2438description for C<IO::AIO::splice> above for details.
2439
2440=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
2441
2442Attempts to query or change the pipe buffer size. Obviously works only
2443on pipes, and currently works only on GNU/Linux systems, and fails with
2444C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
2445size on other systems, drop me a note.
2446
2447=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
2448
2449This is a direct interface to the Linux L<pipe2(2)> system call. If
2450C<$flags> is missing or C<0>, then this should be the same as a call to
2451perl's built-in C<pipe> function and create a new pipe, and works on
2452systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
2453(..., 4096, O_BINARY)>.
2454
2455If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
2456the given flags (Linux 2.6.27, glibc 2.9).
2457
2458On success, the read and write file handles are returned.
2459
2460On error, nothing will be returned. If the pipe2 syscall is missing and
2461C<$flags> is non-zero, fails with C<ENOSYS>.
2462
2463Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
2464time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
2465C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
2466
2467Example: create a pipe race-free w.r.t. threads and fork:
2468
2469 my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
2470 or die "pipe2: $!\n";
2471
2472=item $fh = IO::AIO::memfd_create $pathname[, $flags]
2473
2474This is a direct interface to the Linux L<memfd_create(2)> system
2475call. The (unhelpful) default for C<$flags> is C<0>, but your default
2476should be C<IO::AIO::MFD_CLOEXEC>.
2477
2478On success, the new memfd filehandle is returned, otherwise returns
2479C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>.
2480
2481Please refer to L<memfd_create(2)> for more info on this call.
2482
2483The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>,
2484C<IO::AIO::MFD_ALLOW_SEALING> and C<IO::AIO::MFD_HUGETLB>.
2485
2486Example: create a new memfd.
2487
2488 my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC
2489 or die "memfd_create: $!\n";
2490
2491=item $fh = IO::AIO::pidfd_open $pid[, $flags]
2492
2493This is an interface to the Linux L<pidfd_open(2)> system call. The
2494default for C<$flags> is C<0>.
2495
2496On success, a new pidfd filehandle is returned (that is already set to
2497close-on-exec), otherwise returns C<undef>. If the syscall is missing,
2498fails with C<ENOSYS>.
2499
2500Example: open pid 6341 as pidfd.
2501
2502 my $fh = IO::AIO::pidfd_open 6341
2503 or die "pidfd_open: $!\n";
2504
2505=item $status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[, $flags]]
2506
2507This is an interface to the Linux L<pidfd_send_signal> system call. The
2508default for C<$siginfo> is C<undef> and the default for C<$flags> is C<0>.
2509
2510Returns the system call status. If the syscall is missing, fails with
2511C<ENOSYS>.
2512
2513When specified, C<$siginfo> must be a reference to a hash with one or more
2514of the following members:
2515
2516=over
2517
2518=item code - the C<si_code> member
2519
2520=item pid - the C<si_pid> member
2521
2522=item uid - the C<si_uid> member
2523
2524=item value_int - the C<si_value.sival_int> member
2525
2526=item value_ptr - the C<si_value.sival_ptr> member, specified as an integer
2527
2528=back
2529
2530Example: send a SIGKILL to the specified process.
2531
2532 my $status = IO::AIO::pidfd_send_signal $pidfh, 9, undef
2533 and die "pidfd_send_signal: $!\n";
2534
2535Example: send a SIGKILL to the specified process with extra data.
2536
2537 my $status = IO::AIO::pidfd_send_signal $pidfh, 9, { code => -1, value_int => 7 }
2538 and die "pidfd_send_signal: $!\n";
2539
2540=item $fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags]
2541
2542This is an interface to the Linux L<pidfd_getfd> system call. The default
2543for C<$flags> is C<0>.
2544
2545On success, returns a dup'ed copy of the target file descriptor (specified
2546as an integer) returned (that is already set to close-on-exec), otherwise
2547returns C<undef>. If the syscall is missing, fails with C<ENOSYS>.
2548
2549Example: get a copy of standard error of another process and print soemthing to it.
2550
2551 my $errfh = IO::AIO::pidfd_getfd $pidfh, 2
2552 or die "pidfd_getfd: $!\n";
2553 print $errfh "stderr\n";
2554
2555=item $fh = IO::AIO::eventfd [$initval, [$flags]]
2556
2557This is a direct interface to the Linux L<eventfd(2)> system call. The
2558(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
2559
2560On success, the new eventfd filehandle is returned, otherwise returns
2561C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
2562
2563Please refer to L<eventfd(2)> for more info on this call.
2564
2565The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
2566C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
2567
2568Example: create a new eventfd filehandle:
2569
2570 $fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC
2571 or die "eventfd: $!\n";
2572
2573=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
2574
2575This is a direct interface to the Linux L<timerfd_create(2)> system
2576call. The (unhelpful) default for C<$flags> is C<0>, but your default
2577should be C<IO::AIO::TFD_CLOEXEC>.
2578
2579On success, the new timerfd filehandle is returned, otherwise returns
2580C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>.
2581
2582Please refer to L<timerfd_create(2)> for more info on this call.
2583
2584The following C<$clockid> values are
2585available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
2586C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15)
2587C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and
2588C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11).
2589
2590The following C<$flags> values are available (Linux
25912.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>.
2592
2593Example: create a new timerfd and set it to one-second repeated alarms,
2594then wait for two alarms:
2595
2596 my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC
2597 or die "timerfd_create: $!\n";
2598
2599 defined IO::AIO::timerfd_settime $fh, 0, 1, 1
2600 or die "timerfd_settime: $!\n";
2601
2602 for (1..2) {
2603 8 == sysread $fh, my $buf, 8
2604 or die "timerfd read failure\n";
2605
2606 printf "number of expirations (likely 1): %d\n",
2607 unpack "Q", $buf;
2608 }
2609
2610=item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
2611
2612This is a direct interface to the Linux L<timerfd_settime(2)> system
2613call. Please refer to its manpage for more info on this call.
2614
2615The new itimerspec is specified using two (possibly fractional) second
2616values, C<$new_interval> and C<$new_value>).
2617
2618On success, the current interval and value are returned (as per
2619C<timerfd_gettime>). On failure, the empty list is returned.
2620
2621The following C<$flags> values are
2622available: C<IO::AIO::TFD_TIMER_ABSTIME> and
2623C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>.
2624
2625See C<IO::AIO::timerfd_create> for a full example.
2626
2627=item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
2628
2629This is a direct interface to the Linux L<timerfd_gettime(2)> system
2630call. Please refer to its manpage for more info on this call.
2631
2632On success, returns the current values of interval and value for the given
2633timerfd (as potentially fractional second values). On failure, the empty
2634list is returned.
1990 2635
1991=back 2636=back
1992 2637
1993=cut 2638=cut
1994 2639
2060the process will result in undefined behaviour. Calling it at any time 2705the process will result in undefined behaviour. Calling it at any time
2061will also result in any undefined (by POSIX) behaviour. 2706will also result in any undefined (by POSIX) behaviour.
2062 2707
2063=back 2708=back
2064 2709
2710=head2 LINUX-SPECIFIC CALLS
2711
2712When a call is documented as "linux-specific" then this means it
2713originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the
2714availability and compatibility of such calls regardless of the platform
2715it is compiled on, so platforms such as FreeBSD which often implement
2716these calls will work. When in doubt, call them and see if they fail wth
2717C<ENOSYS>.
2718
2065=head2 MEMORY USAGE 2719=head2 MEMORY USAGE
2066 2720
2067Per-request usage: 2721Per-request usage:
2068 2722
2069Each aio request uses - depending on your architecture - around 100-200 2723Each aio request uses - depending on your architecture - around 100-200
2081temporary buffers, and each thread requires a stack and other data 2735temporary buffers, and each thread requires a stack and other data
2082structures (usually around 16k-128k, depending on the OS). 2736structures (usually around 16k-128k, depending on the OS).
2083 2737
2084=head1 KNOWN BUGS 2738=head1 KNOWN BUGS
2085 2739
2086Known bugs will be fixed in the next release. 2740Known bugs will be fixed in the next release :)
2741
2742=head1 KNOWN ISSUES
2743
2744Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap>
2745or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as
2746non-created hash slots or other scalars I didn't think of. It's best to
2747avoid such and either use scalar variables or making sure that the scalar
2748exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied).
2749
2750I am not sure anything can be done about this, so this is considered a
2751known issue, rather than a bug.
2087 2752
2088=head1 SEE ALSO 2753=head1 SEE ALSO
2089 2754
2090L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a 2755L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2091more natural syntax. 2756more natural syntax and L<IO::FDPass> for file descriptor passing.
2092 2757
2093=head1 AUTHOR 2758=head1 AUTHOR
2094 2759
2095 Marc Lehmann <schmorp@schmorp.de> 2760 Marc Lehmann <schmorp@schmorp.de>
2096 http://home.schmorp.de/ 2761 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines