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.208 by root, Mon Sep 26 20:19:08 2011 UTC vs.
Revision 1.295 by root, Sat Aug 25 19:59:18 2018 UTC

1=head1 NAME 1=head1 NAME
2 2
3IO::AIO - Asynchronous Input/Output 3IO::AIO - Asynchronous/Advanced Input/Output
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use IO::AIO; 7 use IO::AIO;
8 8
58not well-supported or restricted (GNU/Linux doesn't allow them on normal 58not well-supported or restricted (GNU/Linux doesn't allow them on normal
59files currently, for example), and they would only support aio_read and 59files currently, for example), and they would only support aio_read and
60aio_write, so the remaining functionality would have to be implemented 60aio_write, so the remaining functionality would have to be implemented
61using threads anyway. 61using threads anyway.
62 62
63In addition to asynchronous I/O, this module also exports some rather
64arcane interfaces, such as C<madvise> or linux's C<splice> system call,
65which is why the C<A> in C<AIO> can also mean I<advanced>.
66
63Although the module will work in the presence of other (Perl-) threads, 67Although the module will work in the presence of other (Perl-) threads,
64it is currently not reentrant in any way, so use appropriate locking 68it is currently not reentrant in any way, so use appropriate locking
65yourself, always call C<poll_cb> from within the same thread, or never 69yourself, always call C<poll_cb> from within the same thread, or never
66call C<poll_cb> (or other C<aio_> functions) recursively. 70call C<poll_cb> (or other C<aio_> functions) recursively.
67 71
68=head2 EXAMPLE 72=head2 EXAMPLE
69 73
70This is a simple example that uses the EV module and loads 74This is a simple example that uses the EV module and loads
71F</etc/passwd> asynchronously: 75F</etc/passwd> asynchronously:
72 76
73 use Fcntl;
74 use EV; 77 use EV;
75 use IO::AIO; 78 use IO::AIO;
76 79
77 # register the IO::AIO callback with EV 80 # register the IO::AIO callback with EV
78 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; 81 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
95 98
96 # file contents now in $contents 99 # file contents now in $contents
97 print $contents; 100 print $contents;
98 101
99 # exit event loop and program 102 # exit event loop and program
100 EV::unloop; 103 EV::break;
101 }; 104 };
102 }; 105 };
103 106
104 # possibly queue up other requests, or open GUI windows, 107 # possibly queue up other requests, or open GUI windows,
105 # check for sockets etc. etc. 108 # check for sockets etc. etc.
106 109
107 # process events as long as there are some: 110 # process events as long as there are some:
108 EV::loop; 111 EV::run;
109 112
110=head1 REQUEST ANATOMY AND LIFETIME 113=head1 REQUEST ANATOMY AND LIFETIME
111 114
112Every C<aio_*> function creates a request. which is a C data structure not 115Every C<aio_*> function creates a request. which is a C data structure not
113directly visible to Perl. 116directly visible to Perl.
168use common::sense; 171use common::sense;
169 172
170use base 'Exporter'; 173use base 'Exporter';
171 174
172BEGIN { 175BEGIN {
173 our $VERSION = '4.0'; 176 our $VERSION = 4.6;
174 177
175 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close 178 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx 179 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
177 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync 180 aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
178 aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate 181 aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
179 aio_pathsync aio_readahead 182 aio_pathsync aio_readahead aio_fiemap aio_allocate
180 aio_rename aio_link aio_move aio_copy aio_group 183 aio_rename aio_rename2 aio_link aio_move aio_copy aio_group
181 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 184 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
182 aio_chmod aio_utime aio_truncate 185 aio_chmod aio_utime aio_truncate
183 aio_msync aio_mtouch aio_mlock aio_mlockall 186 aio_msync aio_mtouch aio_mlock aio_mlockall
184 aio_statvfs 187 aio_statvfs
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)
218 aio_seek $fh,$offset,$whence, $callback->($offs)
214 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 219 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
215 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 220 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
216 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 221 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
217 aio_readahead $fh,$offset,$length, $callback->($retval) 222 aio_readahead $fh,$offset,$length, $callback->($retval)
218 aio_stat $fh_or_path, $callback->($status) 223 aio_stat $fh_or_path, $callback->($status)
219 aio_lstat $fh, $callback->($status) 224 aio_lstat $fh, $callback->($status)
220 aio_statvfs $fh_or_path, $callback->($statvfs) 225 aio_statvfs $fh_or_path, $callback->($statvfs)
221 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 226 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
222 aio_chown $fh_or_path, $uid, $gid, $callback->($status) 227 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
228 aio_chmod $fh_or_path, $mode, $callback->($status)
223 aio_truncate $fh_or_path, $offset, $callback->($status) 229 aio_truncate $fh_or_path, $offset, $callback->($status)
224 aio_chmod $fh_or_path, $mode, $callback->($status) 230 aio_allocate $fh, $mode, $offset, $len, $callback->($status)
231 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
225 aio_unlink $pathname, $callback->($status) 232 aio_unlink $pathname, $callback->($status)
226 aio_mknod $path, $mode, $dev, $callback->($status) 233 aio_mknod $pathname, $mode, $dev, $callback->($status)
227 aio_link $srcpath, $dstpath, $callback->($status) 234 aio_link $srcpath, $dstpath, $callback->($status)
228 aio_symlink $srcpath, $dstpath, $callback->($status) 235 aio_symlink $srcpath, $dstpath, $callback->($status)
229 aio_readlink $path, $callback->($link) 236 aio_readlink $pathname, $callback->($link)
230 aio_realpath $path, $callback->($link) 237 aio_realpath $pathname, $callback->($path)
231 aio_rename $srcpath, $dstpath, $callback->($status) 238 aio_rename $srcpath, $dstpath, $callback->($status)
239 aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
232 aio_mkdir $pathname, $mode, $callback->($status) 240 aio_mkdir $pathname, $mode, $callback->($status)
233 aio_rmdir $pathname, $callback->($status) 241 aio_rmdir $pathname, $callback->($status)
234 aio_readdir $pathname, $callback->($entries) 242 aio_readdir $pathname, $callback->($entries)
235 aio_readdirx $pathname, $flags, $callback->($entries, $flags) 243 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
236 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST 244 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
237 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN 245 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
246 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
238 aio_load $path, $data, $callback->($status) 247 aio_load $pathname, $data, $callback->($status)
239 aio_copy $srcpath, $dstpath, $callback->($status) 248 aio_copy $srcpath, $dstpath, $callback->($status)
240 aio_move $srcpath, $dstpath, $callback->($status) 249 aio_move $srcpath, $dstpath, $callback->($status)
241 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
242 aio_rmtree $path, $callback->($status) 250 aio_rmtree $pathname, $callback->($status)
251 aio_fcntl $fh, $cmd, $arg, $callback->($status)
252 aio_ioctl $fh, $request, $buf, $callback->($status)
243 aio_sync $callback->($status) 253 aio_sync $callback->($status)
244 aio_syncfs $fh, $callback->($status) 254 aio_syncfs $fh, $callback->($status)
245 aio_fsync $fh, $callback->($status) 255 aio_fsync $fh, $callback->($status)
246 aio_fdatasync $fh, $callback->($status) 256 aio_fdatasync $fh, $callback->($status)
247 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 257 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
248 aio_pathsync $path, $callback->($status) 258 aio_pathsync $pathname, $callback->($status)
249 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 259 aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
250 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 260 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
251 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 261 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
252 aio_mlockall $flags, $callback->($status) 262 aio_mlockall $flags, $callback->($status)
253 aio_group $callback->(...) 263 aio_group $callback->(...)
254 aio_nop $callback->() 264 aio_nop $callback->()
268 IO::AIO::idle_timeout $seconds 278 IO::AIO::idle_timeout $seconds
269 IO::AIO::max_outstanding $maxreqs 279 IO::AIO::max_outstanding $maxreqs
270 IO::AIO::nreqs 280 IO::AIO::nreqs
271 IO::AIO::nready 281 IO::AIO::nready
272 IO::AIO::npending 282 IO::AIO::npending
283 $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL]
284 IO::AIO::min_fdlimit $nfd [EXPERIMENTAL]
273 285
274 IO::AIO::sendfile $ofh, $ifh, $offset, $count 286 IO::AIO::sendfile $ofh, $ifh, $offset, $count
275 IO::AIO::fadvise $fh, $offset, $len, $advice 287 IO::AIO::fadvise $fh, $offset, $len, $advice
288 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
289 IO::AIO::munmap $scalar
290 IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]
276 IO::AIO::madvise $scalar, $offset, $length, $advice 291 IO::AIO::madvise $scalar, $offset, $length, $advice
277 IO::AIO::mprotect $scalar, $offset, $length, $protect 292 IO::AIO::mprotect $scalar, $offset, $length, $protect
278 IO::AIO::munlock $scalar, $offset = 0, $length = undef 293 IO::AIO::munlock $scalar, $offset = 0, $length = undef
279 IO::AIO::munlockall 294 IO::AIO::munlockall
280 295
281=head2 AIO REQUEST FUNCTIONS 296=head2 API NOTES
282 297
283All the C<aio_*> calls are more or less thin wrappers around the syscall 298All the C<aio_*> calls are more or less thin wrappers around the syscall
284with the same name (sans C<aio_>). The arguments are similar or identical, 299with the same name (sans C<aio_>). The arguments are similar or identical,
285and they all accept an additional (and optional) C<$callback> argument 300and they all accept an additional (and optional) C<$callback> argument
286which must be a code reference. This code reference will get called with 301which must be a code reference. This code reference will be called after
287the syscall return code (e.g. most syscalls return C<-1> on error, unlike 302the syscall has been executed in an asynchronous fashion. The results
288perl, which usually delivers "false") as its sole argument after the given 303of the request will be passed as arguments to the callback (and, if an
289syscall has been executed asynchronously. 304error occured, in C<$!>) - for most requests the syscall return code (e.g.
305most syscalls return C<-1> on error, unlike perl, which usually delivers
306"false").
307
308Some requests (such as C<aio_readdir>) pass the actual results and
309communicate failures by passing C<undef>.
290 310
291All functions expecting a filehandle keep a copy of the filehandle 311All functions expecting a filehandle keep a copy of the filehandle
292internally until the request has finished. 312internally until the request has finished.
293 313
294All functions return request objects of type L<IO::AIO::REQ> that allow 314All functions return request objects of type L<IO::AIO::REQ> that allow
295further manipulation of those requests while they are in-flight. 315further manipulation of those requests while they are in-flight.
296 316
297The pathnames you pass to these routines I<must> be absolute and 317The pathnames you pass to these routines I<should> be absolute. The
298encoded as octets. The reason for the former is that at the time the 318reason for this is that at the time the request is being executed, the
299request is being executed, the current working directory could have 319current working directory could have changed. Alternatively, you can
300changed. Alternatively, you can make sure that you never change the 320make sure that you never change the current working directory anywhere
301current working directory anywhere in the program and then use relative 321in the program and then use relative paths. You can also take advantage
302paths. 322of IO::AIOs working directory abstraction, that lets you specify paths
323relative to some previously-opened "working directory object" - see the
324description of the C<IO::AIO::WD> class later in this document.
303 325
304To encode pathnames as octets, either make sure you either: a) always pass 326To encode pathnames as octets, either make sure you either: a) always pass
305in filenames you got from outside (command line, readdir etc.) without 327in filenames you got from outside (command line, readdir etc.) without
306tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode 328tinkering, b) are in your native filesystem encoding, c) use the Encode
307your pathnames to the locale (or other) encoding in effect in the user 329module and encode your pathnames to the locale (or other) encoding in
308environment, d) use Glib::filename_from_unicode on unicode filenames or e) 330effect in the user environment, d) use Glib::filename_from_unicode on
309use something else to ensure your scalar has the correct contents. 331unicode filenames or e) use something else to ensure your scalar has the
332correct contents.
310 333
311This works, btw. independent of the internal UTF-8 bit, which IO::AIO 334This works, btw. independent of the internal UTF-8 bit, which IO::AIO
312handles correctly whether it is set or not. 335handles correctly whether it is set or not.
336
337=head2 AIO REQUEST FUNCTIONS
313 338
314=over 4 339=over 4
315 340
316=item $prev_pri = aioreq_pri [$pri] 341=item $prev_pri = aioreq_pri [$pri]
317 342
347 372
348 373
349=item aio_open $pathname, $flags, $mode, $callback->($fh) 374=item aio_open $pathname, $flags, $mode, $callback->($fh)
350 375
351Asynchronously open or create a file and call the callback with a newly 376Asynchronously open or create a file and call the callback with a newly
352created filehandle for the file. 377created filehandle for the file (or C<undef> in case of an error).
353 378
354The pathname passed to C<aio_open> must be absolute. See API NOTES, above, 379The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
355for an explanation. 380for an explanation.
356 381
357The C<$flags> argument is a bitmask. See the C<Fcntl> module for a 382The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
380following POSIX and non-POSIX constants are available (missing ones on 405following POSIX and non-POSIX constants are available (missing ones on
381your system are, as usual, C<0>): 406your system are, as usual, C<0>):
382 407
383C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, 408C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
384C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, 409C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
385C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>. 410C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>.
386 411
387 412
388=item aio_close $fh, $callback->($status) 413=item aio_close $fh, $callback->($status)
389 414
390Asynchronously close a file and call the callback with the result 415Asynchronously close a file and call the callback with the result
400Or in other words: the file descriptor will be closed, but it will not be 425Or in other words: the file descriptor will be closed, but it will not be
401free for reuse until the perl filehandle is closed. 426free for reuse until the perl filehandle is closed.
402 427
403=cut 428=cut
404 429
430=item aio_seek $fh, $offset, $whence, $callback->($offs)
431
432Seeks the filehandle to the new C<$offset>, similarly to perl's
433C<sysseek>. The C<$whence> can use the traditional values (C<0> for
434C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
435C<IO::AIO::SEEK_END>).
436
437The resulting absolute offset will be passed to the callback, or C<-1> in
438case of an error.
439
440In theory, the C<$whence> constants could be different than the
441corresponding values from L<Fcntl>, but perl guarantees they are the same,
442so don't panic.
443
444As a GNU/Linux (and maybe Solaris) extension, also the constants
445C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
446could be found. No guarantees about suitability for use in C<aio_seek> or
447Perl's C<sysseek> can be made though, although I would naively assume they
448"just work".
449
405=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 450=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
406 451
407=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 452=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
408 453
409Reads or writes C<$length> bytes from or to the specified C<$fh> and 454Reads or writes C<$length> bytes from or to the specified C<$fh> and
410C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> 455C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and
411and calls the callback without the actual number of bytes read (or -1 on 456calls the callback with the actual number of bytes transferred (or -1 on
412error, just like the syscall). 457error, just like the syscall).
413 458
414C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to 459C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
415offset plus the actual number of bytes read. 460offset plus the actual number of bytes read.
416 461
474As native sendfile syscalls (as practically any non-POSIX interface hacked 519As native sendfile syscalls (as practically any non-POSIX interface hacked
475together in a hurry to improve benchmark numbers) tend to be rather buggy 520together in a hurry to improve benchmark numbers) tend to be rather buggy
476on many systems, this implementation tries to work around some known bugs 521on many systems, this implementation tries to work around some known bugs
477in Linux and FreeBSD kernels (probably others, too), but that might fail, 522in Linux and FreeBSD kernels (probably others, too), but that might fail,
478so you really really should check the return value of C<aio_sendfile> - 523so you really really should check the return value of C<aio_sendfile> -
479fewre bytes than expected might have been transferred. 524fewer bytes than expected might have been transferred.
480 525
481 526
482=item aio_readahead $fh,$offset,$length, $callback->($retval) 527=item aio_readahead $fh,$offset,$length, $callback->($retval)
483 528
484C<aio_readahead> populates the page cache with data from a file so that 529C<aio_readahead> populates the page cache with data from a file so that
488whole pages, so that offset is effectively rounded down to a page boundary 533whole pages, so that offset is effectively rounded down to a page boundary
489and bytes are read up to the next page boundary greater than or equal to 534and bytes are read up to the next page boundary greater than or equal to
490(off-set+length). C<aio_readahead> does not read beyond the end of the 535(off-set+length). C<aio_readahead> does not read beyond the end of the
491file. The current file offset of the file is left unchanged. 536file. The current file offset of the file is left unchanged.
492 537
493If that syscall doesn't exist (likely if your OS isn't Linux) it will be 538If that syscall doesn't exist (likely if your kernel isn't Linux) it will
494emulated by simply reading the data, which would have a similar effect. 539be emulated by simply reading the data, which would have a similar effect.
495 540
496 541
497=item aio_stat $fh_or_path, $callback->($status) 542=item aio_stat $fh_or_path, $callback->($status)
498 543
499=item aio_lstat $fh, $callback->($status) 544=item aio_lstat $fh, $callback->($status)
500 545
501Works like perl's C<stat> or C<lstat> in void context. The callback will 546Works almost exactly like perl's C<stat> or C<lstat> in void context. The
502be called after the stat and the results will be available using C<stat _> 547callback will be called after the stat and the results will be available
503or C<-s _> etc... 548using C<stat _> or C<-s _> and other tests (with the exception of C<-B>
549and C<-T>).
504 550
505The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, 551The pathname passed to C<aio_stat> must be absolute. See API NOTES, above,
506for an explanation. 552for an explanation.
507 553
508Currently, the stats are always 64-bit-stats, i.e. instead of returning an 554Currently, the stats are always 64-bit-stats, i.e. instead of returning an
515behaviour). 561behaviour).
516 562
517C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, 563C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
518C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, 564C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
519C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. 565C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
566
567To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME
568ACCESS>.
520 569
521Example: Print the length of F</etc/passwd>: 570Example: Print the length of F</etc/passwd>:
522 571
523 aio_stat "/etc/passwd", sub { 572 aio_stat "/etc/passwd", sub {
524 $_[0] and die "stat failed: $!"; 573 $_[0] and die "stat failed: $!";
568 namemax => 255, 617 namemax => 255,
569 frsize => 1024, 618 frsize => 1024,
570 fsid => 1810 619 fsid => 1810
571 } 620 }
572 621
573
574=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 622=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
575 623
576Works like perl's C<utime> function (including the special case of $atime 624Works like perl's C<utime> function (including the special case of $atime
577and $mtime being undef). Fractional times are supported if the underlying 625and $mtime being undef). Fractional times are supported if the underlying
578syscalls support them. 626syscalls support them.
579 627
580When called with a pathname, uses utimes(2) if available, otherwise 628When called with a pathname, uses utimensat(2) or utimes(2) if available,
581utime(2). If called on a file descriptor, uses futimes(2) if available, 629otherwise utime(2). If called on a file descriptor, uses futimens(2)
582otherwise returns ENOSYS, so this is not portable. 630or futimes(2) if available, otherwise returns ENOSYS, so this is not
631portable.
583 632
584Examples: 633Examples:
585 634
586 # set atime and mtime to current time (basically touch(1)): 635 # set atime and mtime to current time (basically touch(1)):
587 aio_utime "path", undef, undef; 636 aio_utime "path", undef, undef;
605=item aio_truncate $fh_or_path, $offset, $callback->($status) 654=item aio_truncate $fh_or_path, $offset, $callback->($status)
606 655
607Works like truncate(2) or ftruncate(2). 656Works like truncate(2) or ftruncate(2).
608 657
609 658
659=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
660
661Allocates or frees disk space according to the C<$mode> argument. See the
662linux C<fallocate> documentation for details.
663
664C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
665space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>,
666to deallocate a file range.
667
668IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
669(without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range,
670C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE>
671to unshare shared blocks (see your L<fallocate(2)> manpage).
672
673The file system block size used by C<fallocate> is presumably the
674C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes
675can dictate other limitations.
676
677If C<fallocate> isn't available or cannot be emulated (currently no
678emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
679
680
610=item aio_chmod $fh_or_path, $mode, $callback->($status) 681=item aio_chmod $fh_or_path, $mode, $callback->($status)
611 682
612Works like perl's C<chmod> function. 683Works like perl's C<chmod> function.
613 684
614 685
616 687
617Asynchronously unlink (delete) a file and call the callback with the 688Asynchronously unlink (delete) a file and call the callback with the
618result code. 689result code.
619 690
620 691
621=item aio_mknod $path, $mode, $dev, $callback->($status) 692=item aio_mknod $pathname, $mode, $dev, $callback->($status)
622 693
623[EXPERIMENTAL] 694[EXPERIMENTAL]
624 695
625Asynchronously create a device node (or fifo). See mknod(2). 696Asynchronously create a device node (or fifo). See mknod(2).
626 697
627The only (POSIX-) portable way of calling this function is: 698The only (POSIX-) portable way of calling this function is:
628 699
629 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 700 aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
630 701
631See C<aio_stat> for info about some potentially helpful extra constants 702See C<aio_stat> for info about some potentially helpful extra constants
632and functions. 703and functions.
633 704
634=item aio_link $srcpath, $dstpath, $callback->($status) 705=item aio_link $srcpath, $dstpath, $callback->($status)
641 712
642Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 713Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
643the path C<$dstpath> and call the callback with the result code. 714the path C<$dstpath> and call the callback with the result code.
644 715
645 716
646=item aio_readlink $path, $callback->($link) 717=item aio_readlink $pathname, $callback->($link)
647 718
648Asynchronously read the symlink specified by C<$path> and pass it to 719Asynchronously read the symlink specified by C<$path> and pass it to
649the callback. If an error occurs, nothing or undef gets passed to the 720the callback. If an error occurs, nothing or undef gets passed to the
650callback. 721callback.
651 722
652 723
653=item aio_realpath $path, $callback->($path) 724=item aio_realpath $pathname, $callback->($path)
654 725
655Asynchronously make the path absolute and resolve any symlinks in 726Asynchronously make the path absolute and resolve any symlinks in
656C<$path>. The resulting path only consists of directories (Same as 727C<$path>. The resulting path only consists of directories (same as
657L<Cwd::realpath>). 728L<Cwd::realpath>).
658 729
659This request can be used to get the absolute path of the current working 730This request can be used to get the absolute path of the current working
660directory by passing it a path of F<.> (a single dot). 731directory by passing it a path of F<.> (a single dot).
661 732
662 733
663=item aio_rename $srcpath, $dstpath, $callback->($status) 734=item aio_rename $srcpath, $dstpath, $callback->($status)
664 735
665Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 736Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
666rename(2) and call the callback with the result code. 737rename(2) and call the callback with the result code.
738
739On systems that support the AIO::WD working directory abstraction
740natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
741of failing, C<rename> is called on the absolute path of C<$wd>.
742
743
744=item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
745
746Basically a version of C<aio_rename> with an additional C<$flags>
747argument. Calling this with C<$flags=0> is the same as calling
748C<aio_rename>.
749
750Non-zero flags are currently only supported on GNU/Linux systems that
751support renameat2. Other systems fail with C<ENOSYS> in this case.
752
753The following constants are available (missing ones are, as usual C<0>),
754see renameat2(2) for details:
755
756C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE>
757and C<IO::AIO::RENAME_WHITEOUT>.
667 758
668 759
669=item aio_mkdir $pathname, $mode, $callback->($status) 760=item aio_mkdir $pathname, $mode, $callback->($status)
670 761
671Asynchronously mkdir (create) a directory and call the callback with 762Asynchronously mkdir (create) a directory and call the callback with
676=item aio_rmdir $pathname, $callback->($status) 767=item aio_rmdir $pathname, $callback->($status)
677 768
678Asynchronously rmdir (delete) a directory and call the callback with the 769Asynchronously rmdir (delete) a directory and call the callback with the
679result code. 770result code.
680 771
772On systems that support the AIO::WD working directory abstraction
773natively, the case C<[$wd, "."]> is specialcased - instead of failing,
774C<rmdir> is called on the absolute path of C<$wd>.
775
681 776
682=item aio_readdir $pathname, $callback->($entries) 777=item aio_readdir $pathname, $callback->($entries)
683 778
684Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 779Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
685directory (i.e. opendir + readdir + closedir). The entries will not be 780directory (i.e. opendir + readdir + closedir). The entries will not be
700 795
701=over 4 796=over 4
702 797
703=item IO::AIO::READDIR_DENTS 798=item IO::AIO::READDIR_DENTS
704 799
705When this flag is off, then the callback gets an arrayref consisting of 800Normally the callback gets an arrayref consisting of names only (as
706names only (as with C<aio_readdir>), otherwise it gets an arrayref with 801with C<aio_readdir>). If this flag is set, then the callback gets an
707C<[$name, $type, $inode]> arrayrefs, each describing a single directory 802arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a
708entry in more detail. 803single directory entry in more detail:
709 804
710C<$name> is the name of the entry. 805C<$name> is the name of the entry.
711 806
712C<$type> is one of the C<IO::AIO::DT_xxx> constants: 807C<$type> is one of the C<IO::AIO::DT_xxx> constants:
713 808
714C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, 809C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
715C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, 810C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
716C<IO::AIO::DT_WHT>. 811C<IO::AIO::DT_WHT>.
717 812
718C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to 813C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need
719know, you have to run stat yourself. Also, for speed reasons, the C<$type> 814to know, you have to run stat yourself. Also, for speed/memory reasons,
720scalars are read-only: you can not modify them. 815the C<$type> scalars are read-only: you must not modify them.
721 816
722C<$inode> is the inode number (which might not be exact on systems with 64 817C<$inode> is the inode number (which might not be exact on systems with 64
723bit inode numbers and 32 bit perls). This field has unspecified content on 818bit inode numbers and 32 bit perls). This field has unspecified content on
724systems that do not deliver the inode information. 819systems that do not deliver the inode information.
725 820
736short names are tried first. 831short names are tried first.
737 832
738=item IO::AIO::READDIR_STAT_ORDER 833=item IO::AIO::READDIR_STAT_ORDER
739 834
740When this flag is set, then the names will be returned in an order 835When this flag is set, then the names will be returned in an order
741suitable for stat()'ing each one. That is, when you plan to stat() 836suitable for stat()'ing each one. That is, when you plan to stat() most or
742all files in the given directory, then the returned order will likely 837all files in the given directory, then the returned order will likely be
743be fastest. 838faster.
744 839
745If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then 840If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified,
746the likely dirs come first, resulting in a less optimal stat order. 841then the likely dirs come first, resulting in a less optimal stat order
842for stat'ing all entries, but likely a more optimal order for finding
843subdirectories.
747 844
748=item IO::AIO::READDIR_FOUND_UNKNOWN 845=item IO::AIO::READDIR_FOUND_UNKNOWN
749 846
750This flag should not be set when calling C<aio_readdirx>. Instead, it 847This flag should not be set when calling C<aio_readdirx>. Instead, it
751is being set by C<aio_readdirx>, when any of the C<$type>'s found were 848is being set by C<aio_readdirx>, when any of the C<$type>'s found were
753C<$type>'s are known, which can be used to speed up some algorithms. 850C<$type>'s are known, which can be used to speed up some algorithms.
754 851
755=back 852=back
756 853
757 854
855=item aio_slurp $pathname, $offset, $length, $data, $callback->($status)
856
857Opens, reads and closes the given file. The data is put into C<$data>,
858which is resized as required.
859
860If C<$offset> is negative, then it is counted from the end of the file.
861
862If C<$length> is zero, then the remaining length of the file is
863used. Also, in this case, the same limitations to modifying C<$data> apply
864as when IO::AIO::mmap is used, i.e. it must only be modified in-place
865with C<substr>. If the size of the file is known, specifying a non-zero
866C<$length> results in a performance advantage.
867
868This request is similar to the older C<aio_load> request, but since it is
869a single request, it might be more efficient to use.
870
871Example: load F</etc/passwd> into C<$passwd>.
872
873 my $passwd;
874 aio_slurp "/etc/passwd", 0, 0, $passwd, sub {
875 $_[0] >= 0
876 or die "/etc/passwd: $!\n";
877
878 printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd;
879 print $passwd;
880 };
881 IO::AIO::flush;
882
883
758=item aio_load $path, $data, $callback->($status) 884=item aio_load $pathname, $data, $callback->($status)
759 885
760This is a composite request that tries to fully load the given file into 886This is a composite request that tries to fully load the given file into
761memory. Status is the same as with aio_read. 887memory. Status is the same as with aio_read.
888
889Using C<aio_slurp> might be more efficient, as it is a single request.
762 890
763=cut 891=cut
764 892
765sub aio_load($$;$) { 893sub aio_load($$;$) {
766 my ($path, undef, $cb) = @_; 894 my ($path, undef, $cb) = @_;
786=item aio_copy $srcpath, $dstpath, $callback->($status) 914=item aio_copy $srcpath, $dstpath, $callback->($status)
787 915
788Try to copy the I<file> (directories not supported as either source or 916Try to copy the I<file> (directories not supported as either source or
789destination) from C<$srcpath> to C<$dstpath> and call the callback with 917destination) from C<$srcpath> to C<$dstpath> and call the callback with
790a status of C<0> (ok) or C<-1> (error, see C<$!>). 918a status of C<0> (ok) or C<-1> (error, see C<$!>).
919
920Existing destination files will be truncated.
791 921
792This is a composite request that creates the destination file with 922This is a composite request that creates the destination file with
793mode 0200 and copies the contents of the source file into it using 923mode 0200 and copies the contents of the source file into it using
794C<aio_sendfile>, followed by restoring atime, mtime, access mode and 924C<aio_sendfile>, followed by restoring atime, mtime, access mode and
795uid/gid, in that order. 925uid/gid, in that order.
898 }; 1028 };
899 1029
900 $grp 1030 $grp
901} 1031}
902 1032
903=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 1033=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
904 1034
905Scans a directory (similar to C<aio_readdir>) but additionally tries to 1035Scans a directory (similar to C<aio_readdir>) but additionally tries to
906efficiently separate the entries of directory C<$path> into two sets of 1036efficiently separate the entries of directory C<$path> into two sets of
907names, directories you can recurse into (directories), and ones you cannot 1037names, directories you can recurse into (directories), and ones you cannot
908recurse into (everything else, including symlinks to directories). 1038recurse into (everything else, including symlinks to directories).
909 1039
910C<aio_scandir> is a composite request that creates of many sub requests_ 1040C<aio_scandir> is a composite request that generates many sub requests.
911C<$maxreq> specifies the maximum number of outstanding aio requests that 1041C<$maxreq> specifies the maximum number of outstanding aio requests that
912this function generates. If it is C<< <= 0 >>, then a suitable default 1042this function generates. If it is C<< <= 0 >>, then a suitable default
913will be chosen (currently 4). 1043will be chosen (currently 4).
914 1044
915On error, the callback is called without arguments, otherwise it receives 1045On error, the callback is called without arguments, otherwise it receives
965 1095
966 my $grp = aio_group $cb; 1096 my $grp = aio_group $cb;
967 1097
968 $maxreq = 4 if $maxreq <= 0; 1098 $maxreq = 4 if $maxreq <= 0;
969 1099
970 # stat once 1100 # get a wd object
971 aioreq_pri $pri; 1101 aioreq_pri $pri;
972 add $grp aio_stat $path, sub { 1102 add $grp aio_wd $path, sub {
1103 $_[0]
973 return $grp->result () if $_[0]; 1104 or return $grp->result ();
974 my $now = time;
975 my $hash1 = join ":", (stat _)[0,1,3,7,9];
976 1105
977 # read the directory entries 1106 my $wd = [shift, "."];
1107
1108 # stat once
978 aioreq_pri $pri; 1109 aioreq_pri $pri;
979 add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { 1110 add $grp aio_stat $wd, sub {
980 my $entries = shift
981 or return $grp->result (); 1111 return $grp->result () if $_[0];
1112 my $now = time;
1113 my $hash1 = join ":", (stat _)[0,1,3,7,9];
982 1114
983 # stat the dir another time 1115 # read the directory entries
984 aioreq_pri $pri; 1116 aioreq_pri $pri;
1117 add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
1118 my $entries = shift
1119 or return $grp->result ();
1120
1121 # stat the dir another time
1122 aioreq_pri $pri;
985 add $grp aio_stat $path, sub { 1123 add $grp aio_stat $wd, sub {
986 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 1124 my $hash2 = join ":", (stat _)[0,1,3,7,9];
987 1125
988 my $ndirs; 1126 my $ndirs;
989 1127
990 # take the slow route if anything looks fishy 1128 # take the slow route if anything looks fishy
991 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 1129 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
992 $ndirs = -1; 1130 $ndirs = -1;
993 } else { 1131 } else {
994 # if nlink == 2, we are finished 1132 # if nlink == 2, we are finished
995 # for non-posix-fs's, we rely on nlink < 2 1133 # for non-posix-fs's, we rely on nlink < 2
996 $ndirs = (stat _)[3] - 2 1134 $ndirs = (stat _)[3] - 2
997 or return $grp->result ([], $entries); 1135 or return $grp->result ([], $entries);
998 } 1136 }
999 1137
1000 my (@dirs, @nondirs); 1138 my (@dirs, @nondirs);
1001 1139
1002 my $statgrp = add $grp aio_group sub { 1140 my $statgrp = add $grp aio_group sub {
1003 $grp->result (\@dirs, \@nondirs); 1141 $grp->result (\@dirs, \@nondirs);
1004 }; 1142 };
1005 1143
1006 limit $statgrp $maxreq; 1144 limit $statgrp $maxreq;
1007 feed $statgrp sub { 1145 feed $statgrp sub {
1008 return unless @$entries; 1146 return unless @$entries;
1009 my $entry = shift @$entries; 1147 my $entry = shift @$entries;
1010 1148
1011 aioreq_pri $pri; 1149 aioreq_pri $pri;
1150 $wd->[1] = "$entry/.";
1012 add $statgrp aio_stat "$path/$entry/.", sub { 1151 add $statgrp aio_stat $wd, sub {
1013 if ($_[0] < 0) { 1152 if ($_[0] < 0) {
1014 push @nondirs, $entry; 1153 push @nondirs, $entry;
1015 } else { 1154 } else {
1016 # need to check for real directory 1155 # need to check for real directory
1017 aioreq_pri $pri; 1156 aioreq_pri $pri;
1157 $wd->[1] = $entry;
1018 add $statgrp aio_lstat "$path/$entry", sub { 1158 add $statgrp aio_lstat $wd, sub {
1019 if (-d _) { 1159 if (-d _) {
1020 push @dirs, $entry; 1160 push @dirs, $entry;
1021 1161
1022 unless (--$ndirs) { 1162 unless (--$ndirs) {
1023 push @nondirs, @$entries; 1163 push @nondirs, @$entries;
1024 feed $statgrp; 1164 feed $statgrp;
1165 }
1166 } else {
1167 push @nondirs, $entry;
1025 } 1168 }
1026 } else {
1027 push @nondirs, $entry;
1028 } 1169 }
1029 } 1170 }
1030 } 1171 };
1031 }; 1172 };
1032 }; 1173 };
1033 }; 1174 };
1034 }; 1175 };
1035 }; 1176 };
1036 1177
1037 $grp 1178 $grp
1038} 1179}
1039 1180
1040=item aio_rmtree $path, $callback->($status) 1181=item aio_rmtree $pathname, $callback->($status)
1041 1182
1042Delete a directory tree starting (and including) C<$path>, return the 1183Delete a directory tree starting (and including) C<$path>, return the
1043status of the final C<rmdir> only. This is a composite request that 1184status of the final C<rmdir> only. This is a composite request that
1044uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1185uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1045everything else. 1186everything else.
1046 1187
1047=cut 1188=cut
1048 1189
1070 }; 1211 };
1071 1212
1072 $grp 1213 $grp
1073} 1214}
1074 1215
1216=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
1217
1218=item aio_ioctl $fh, $request, $buf, $callback->($status)
1219
1220These work just like the C<fcntl> and C<ioctl> built-in functions, except
1221they execute asynchronously and pass the return value to the callback.
1222
1223Both calls can be used for a lot of things, some of which make more sense
1224to run asynchronously in their own thread, while some others make less
1225sense. For example, calls that block waiting for external events, such
1226as locking, will also lock down an I/O thread while it is waiting, which
1227can deadlock the whole I/O system. At the same time, there might be no
1228alternative to using a thread to wait.
1229
1230So in general, you should only use these calls for things that do
1231(filesystem) I/O, not for things that wait for other events (network,
1232other processes), although if you are careful and know what you are doing,
1233you still can.
1234
1235The following constants are available (missing ones are, as usual C<0>):
1236
1237C<F_DUPFD_CLOEXEC>,
1238
1239C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
1240
1241C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
1242
1243C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
1244C<FS_IOC_FIEMAP>.
1245
1246C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
1247C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
1248
1249C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
1250C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
1251C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
1252C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
1253C<FS_FL_USER_MODIFIABLE>.
1254
1255C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
1256C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
1257C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
1258C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
1259
1075=item aio_sync $callback->($status) 1260=item aio_sync $callback->($status)
1076 1261
1077Asynchronously call sync and call the callback when finished. 1262Asynchronously call sync and call the callback when finished.
1078 1263
1079=item aio_fsync $fh, $callback->($status) 1264=item aio_fsync $fh, $callback->($status)
1106C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, 1291C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
1107C<IO::AIO::SYNC_FILE_RANGE_WRITE> and 1292C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
1108C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range 1293C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
1109manpage for details. 1294manpage for details.
1110 1295
1111=item aio_pathsync $path, $callback->($status) 1296=item aio_pathsync $pathname, $callback->($status)
1112 1297
1113This request tries to open, fsync and close the given path. This is a 1298This request tries to open, fsync and close the given path. This is a
1114composite request intended to sync directories after directory operations 1299composite request intended to sync directories after directory operations
1115(E.g. rename). This might not work on all operating systems or have any 1300(E.g. rename). This might not work on all operating systems or have any
1116specific effect, but usually it makes sure that directory changes get 1301specific effect, but usually it makes sure that directory changes get
1147 }; 1332 };
1148 1333
1149 $grp 1334 $grp
1150} 1335}
1151 1336
1152=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 1337=item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
1153 1338
1154This is a rather advanced IO::AIO call, which only works on mmap(2)ed 1339This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1155scalars (see the C<IO::AIO::mmap> function, although it also works on data 1340scalars (see the C<IO::AIO::mmap> function, although it also works on data
1156scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the 1341scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1157scalar must only be modified in-place while an aio operation is pending on 1342scalar must only be modified in-place while an aio operation is pending on
1159 1344
1160It calls the C<msync> function of your OS, if available, with the memory 1345It calls the C<msync> function of your OS, if available, with the memory
1161area starting at C<$offset> in the string and ending C<$length> bytes 1346area starting at C<$offset> in the string and ending C<$length> bytes
1162later. If C<$length> is negative, counts from the end, and if C<$length> 1347later. If C<$length> is negative, counts from the end, and if C<$length>
1163is C<undef>, then it goes till the end of the string. The flags can be 1348is C<undef>, then it goes till the end of the string. The flags can be
1164a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and 1349either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional
1165C<IO::AIO::MS_SYNC>. 1350C<IO::AIO::MS_INVALIDATE>.
1166 1351
1167=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 1352=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1168 1353
1169This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1354This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1170scalars. 1355scalars.
1171 1356
1172It touches (reads or writes) all memory pages in the specified 1357It touches (reads or writes) all memory pages in the specified
1173range inside the scalar. All caveats and parameters are the same 1358range inside the scalar. All caveats and parameters are the same
1174as for C<aio_msync>, above, except for flags, which must be either 1359as for C<aio_msync>, above, except for flags, which must be either
1175C<0> (which reads all pages and ensures they are instantiated) or 1360C<0> (which reads all pages and ensures they are instantiated) or
1176C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and 1361C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1177writing an octet from it, which dirties the page). 1362writing an octet from it, which dirties the page).
1178 1363
1179=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 1364=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1180 1365
1181This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1366This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1212documented under L<MISCELLANEOUS FUNCTIONS>. 1397documented under L<MISCELLANEOUS FUNCTIONS>.
1213 1398
1214Example: asynchronously lock all current and future pages into memory. 1399Example: asynchronously lock all current and future pages into memory.
1215 1400
1216 aio_mlockall IO::AIO::MCL_FUTURE; 1401 aio_mlockall IO::AIO::MCL_FUTURE;
1402
1403=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1404
1405Queries the extents of the given file (by calling the Linux C<FIEMAP>
1406ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1407the ioctl is not available on your OS, then this request will fail with
1408C<ENOSYS>.
1409
1410C<$start> is the starting offset to query extents for, C<$length> is the
1411size of the range to query - if it is C<undef>, then the whole file will
1412be queried.
1413
1414C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
1415C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1416exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1417the data portion.
1418
1419C<$count> is the maximum number of extent records to return. If it is
1420C<undef>, then IO::AIO queries all extents of the range. As a very special
1421case, if it is C<0>, then the callback receives the number of extents
1422instead of the extents themselves (which is unreliable, see below).
1423
1424If an error occurs, the callback receives no arguments. The special
1425C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1426
1427Otherwise, the callback receives an array reference with extent
1428structures. Each extent structure is an array reference itself, with the
1429following members:
1430
1431 [$logical, $physical, $length, $flags]
1432
1433Flags is any combination of the following flag values (typically either C<0>
1434or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1435
1436C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1437C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1438C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1439C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1440C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1441C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1442
1443At the time of this writing (Linux 3.2), this request is unreliable unless
1444C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1445it to return all extents of a range for files with a large number of
1446extents. The code (only) works around all these issues if C<$count> is
1447C<undef>.
1217 1448
1218=item aio_group $callback->(...) 1449=item aio_group $callback->(...)
1219 1450
1220This is a very special aio request: Instead of doing something, it is a 1451This is a very special aio request: Instead of doing something, it is a
1221container for other aio requests, which is useful if you want to bundle 1452container for other aio requests, which is useful if you want to bundle
1258like sleep and file handle readable/writable, the overhead this creates is 1489like sleep and file handle readable/writable, the overhead this creates is
1259immense (it blocks a thread for a long time) so do not use this function 1490immense (it blocks a thread for a long time) so do not use this function
1260except to put your application under artificial I/O pressure. 1491except to put your application under artificial I/O pressure.
1261 1492
1262=back 1493=back
1494
1495
1496=head2 IO::AIO::WD - multiple working directories
1497
1498Your process only has one current working directory, which is used by all
1499threads. This makes it hard to use relative paths (some other component
1500could call C<chdir> at any time, and it is hard to control when the path
1501will be used by IO::AIO).
1502
1503One solution for this is to always use absolute paths. This usually works,
1504but can be quite slow (the kernel has to walk the whole path on every
1505access), and can also be a hassle to implement.
1506
1507Newer POSIX systems have a number of functions (openat, fdopendir,
1508futimensat and so on) that make it possible to specify working directories
1509per operation.
1510
1511For portability, and because the clowns who "designed", or shall I write,
1512perpetrated this new interface were obviously half-drunk, this abstraction
1513cannot be perfect, though.
1514
1515IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
1516object. This object stores the canonicalised, absolute version of the
1517path, and on systems that allow it, also a directory file descriptor.
1518
1519Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
1520or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
1521object and a pathname instead (or the IO::AIO::WD object alone, which
1522gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
1523IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
1524to that IO::AIO::WD object.
1525
1526For example, to get a wd object for F</etc> and then stat F<passwd>
1527inside, you would write:
1528
1529 aio_wd "/etc", sub {
1530 my $etcdir = shift;
1531
1532 # although $etcdir can be undef on error, there is generally no reason
1533 # to check for errors here, as aio_stat will fail with ENOENT
1534 # when $etcdir is undef.
1535
1536 aio_stat [$etcdir, "passwd"], sub {
1537 # yay
1538 };
1539 };
1540
1541The fact that C<aio_wd> is a request and not a normal function shows that
1542creating an IO::AIO::WD object is itself a potentially blocking operation,
1543which is why it is done asynchronously.
1544
1545To stat the directory obtained with C<aio_wd> above, one could write
1546either of the following three request calls:
1547
1548 aio_lstat "/etc" , sub { ... # pathname as normal string
1549 aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
1550 aio_lstat $wd , sub { ... # shorthand for the previous
1551
1552As with normal pathnames, IO::AIO keeps a copy of the working directory
1553object and the pathname string, so you could write the following without
1554causing any issues due to C<$path> getting reused:
1555
1556 my $path = [$wd, undef];
1557
1558 for my $name (qw(abc def ghi)) {
1559 $path->[1] = $name;
1560 aio_stat $path, sub {
1561 # ...
1562 };
1563 }
1564
1565There are some caveats: when directories get renamed (or deleted), the
1566pathname string doesn't change, so will point to the new directory (or
1567nowhere at all), while the directory fd, if available on the system,
1568will still point to the original directory. Most functions accepting a
1569pathname will use the directory fd on newer systems, and the string on
1570older systems. Some functions (such as C<aio_realpath>) will always rely on
1571the string form of the pathname.
1572
1573So this functionality is mainly useful to get some protection against
1574C<chdir>, to easily get an absolute path out of a relative path for future
1575reference, and to speed up doing many operations in the same directory
1576(e.g. when stat'ing all files in a directory).
1577
1578The following functions implement this working directory abstraction:
1579
1580=over 4
1581
1582=item aio_wd $pathname, $callback->($wd)
1583
1584Asynchonously canonicalise the given pathname and convert it to an
1585IO::AIO::WD object representing it. If possible and supported on the
1586system, also open a directory fd to speed up pathname resolution relative
1587to this working directory.
1588
1589If something goes wrong, then C<undef> is passwd to the callback instead
1590of a working directory object and C<$!> is set appropriately. Since
1591passing C<undef> as working directory component of a pathname fails the
1592request with C<ENOENT>, there is often no need for error checking in the
1593C<aio_wd> callback, as future requests using the value will fail in the
1594expected way.
1595
1596=item IO::AIO::CWD
1597
1598This is a compiletime constant (object) that represents the process
1599current working directory.
1600
1601Specifying this object as working directory object for a pathname is as if
1602the pathname would be specified directly, without a directory object. For
1603example, these calls are functionally identical:
1604
1605 aio_stat "somefile", sub { ... };
1606 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1607
1608=back
1609
1610To recover the path associated with an IO::AIO::WD object, you can use
1611C<aio_realpath>:
1612
1613 aio_realpath $wd, sub {
1614 warn "path is $_[0]\n";
1615 };
1616
1617Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
1618sometimes, fall back to using an absolue path.
1263 1619
1264=head2 IO::AIO::REQ CLASS 1620=head2 IO::AIO::REQ CLASS
1265 1621
1266All non-aggregate C<aio_*> functions return an object of this class when 1622All non-aggregate C<aio_*> functions return an object of this class when
1267called in non-void context. 1623called in non-void context.
1385 1741
1386Sets a feeder/generator on this group: every group can have an attached 1742Sets a feeder/generator on this group: every group can have an attached
1387generator that generates requests if idle. The idea behind this is that, 1743generator that generates requests if idle. The idea behind this is that,
1388although you could just queue as many requests as you want in a group, 1744although you could just queue as many requests as you want in a group,
1389this might starve other requests for a potentially long time. For example, 1745this might starve other requests for a potentially long time. For example,
1390C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, 1746C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1391delaying any later requests for a long time. 1747requests, delaying any later requests for a long time.
1392 1748
1393To avoid this, and allow incremental generation of requests, you can 1749To avoid this, and allow incremental generation of requests, you can
1394instead a group and set a feeder on it that generates those requests. The 1750instead a group and set a feeder on it that generates those requests. The
1395feed callback will be called whenever there are few enough (see C<limit>, 1751feed callback will be called whenever there are few enough (see C<limit>,
1396below) requests active in the group itself and is expected to queue more 1752below) requests active in the group itself and is expected to queue more
1428The default value for the limit is C<0>, but note that setting a feeder 1784The default value for the limit is C<0>, but note that setting a feeder
1429automatically bumps it up to C<2>. 1785automatically bumps it up to C<2>.
1430 1786
1431=back 1787=back
1432 1788
1789
1433=head2 SUPPORT FUNCTIONS 1790=head2 SUPPORT FUNCTIONS
1434 1791
1435=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1792=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1436 1793
1437=over 4 1794=over 4
1445 1802
1446See C<poll_cb> for an example. 1803See C<poll_cb> for an example.
1447 1804
1448=item IO::AIO::poll_cb 1805=item IO::AIO::poll_cb
1449 1806
1450Process some outstanding events on the result pipe. You have to call 1807Process some requests that have reached the result phase (i.e. they have
1808been executed but the results are not yet reported). You have to call
1809this "regularly" to finish outstanding requests.
1810
1451this regularly. Returns C<0> if all events could be processed (or there 1811Returns C<0> if all events could be processed (or there were no
1452were no events to process), or C<-1> if it returned earlier for whatever 1812events to process), or C<-1> if it returned earlier for whatever
1453reason. Returns immediately when no events are outstanding. The amount of 1813reason. Returns immediately when no events are outstanding. The amount
1454events processed depends on the settings of C<IO::AIO::max_poll_req> and 1814of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1455C<IO::AIO::max_poll_time>. 1815C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1456 1816
1457If not all requests were processed for whatever reason, the filehandle 1817If not all requests were processed for whatever reason, the poll file
1458will still be ready when C<poll_cb> returns, so normally you don't have to 1818descriptor will still be ready when C<poll_cb> returns, so normally you
1459do anything special to have it called later. 1819don't have to do anything special to have it called later.
1460 1820
1461Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes 1821Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1462ready, it can be beneficial to call this function from loops which submit 1822ready, it can be beneficial to call this function from loops which submit
1463a lot of requests, to make sure the results get processed when they become 1823a lot of requests, to make sure the results get processed when they become
1464available and not just when the loop is finished and the event loop takes 1824available and not just when the loop is finished and the event loop takes
1473 poll => 'r', async => 1, 1833 poll => 'r', async => 1,
1474 cb => \&IO::AIO::poll_cb); 1834 cb => \&IO::AIO::poll_cb);
1475 1835
1476=item IO::AIO::poll_wait 1836=item IO::AIO::poll_wait
1477 1837
1478If there are any outstanding requests and none of them in the result 1838Wait until either at least one request is in the result phase or no
1479phase, wait till the result filehandle becomes ready for reading (simply 1839requests are outstanding anymore.
1480does a C<select> on the filehandle. This is useful if you want to 1840
1481synchronously wait for some requests to finish). 1841This is useful if you want to synchronously wait for some requests to
1842become ready, without actually handling them.
1482 1843
1483See C<nreqs> for an example. 1844See C<nreqs> for an example.
1484 1845
1485=item IO::AIO::poll 1846=item IO::AIO::poll
1486 1847
1497 1858
1498Strictly equivalent to: 1859Strictly equivalent to:
1499 1860
1500 IO::AIO::poll_wait, IO::AIO::poll_cb 1861 IO::AIO::poll_wait, IO::AIO::poll_cb
1501 while IO::AIO::nreqs; 1862 while IO::AIO::nreqs;
1863
1864This function can be useful at program aborts, to make sure outstanding
1865I/O has been done (C<IO::AIO> uses an C<END> block which already calls
1866this function on normal exits), or when you are merely using C<IO::AIO>
1867for its more advanced functions, rather than for async I/O, e.g.:
1868
1869 my ($dirs, $nondirs);
1870 IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
1871 IO::AIO::flush;
1872 # $dirs, $nondirs are now set
1502 1873
1503=item IO::AIO::max_poll_reqs $nreqs 1874=item IO::AIO::max_poll_reqs $nreqs
1504 1875
1505=item IO::AIO::max_poll_time $seconds 1876=item IO::AIO::max_poll_time $seconds
1506 1877
1533 poll => 'r', nice => 1, 1904 poll => 'r', nice => 1,
1534 cb => &IO::AIO::poll_cb); 1905 cb => &IO::AIO::poll_cb);
1535 1906
1536=back 1907=back
1537 1908
1909
1538=head3 CONTROLLING THE NUMBER OF THREADS 1910=head3 CONTROLLING THE NUMBER OF THREADS
1539 1911
1540=over 1912=over
1541 1913
1542=item IO::AIO::min_parallel $nthreads 1914=item IO::AIO::min_parallel $nthreads
1607 1979
1608This is a very bad function to use in interactive programs because it 1980This is a very bad function to use in interactive programs because it
1609blocks, and a bad way to reduce concurrency because it is inexact: Better 1981blocks, and a bad way to reduce concurrency because it is inexact: Better
1610use an C<aio_group> together with a feed callback. 1982use an C<aio_group> together with a feed callback.
1611 1983
1612It's main use is in scripts without an event loop - when you want to stat 1984Its main use is in scripts without an event loop - when you want to stat
1613a lot of files, you can write somehting like this: 1985a lot of files, you can write something like this:
1614 1986
1615 IO::AIO::max_outstanding 32; 1987 IO::AIO::max_outstanding 32;
1616 1988
1617 for my $path (...) { 1989 for my $path (...) {
1618 aio_stat $path , ...; 1990 aio_stat $path , ...;
1629The default value for C<max_outstanding> is very large, so there is no 2001The default value for C<max_outstanding> is very large, so there is no
1630practical limit on the number of outstanding requests. 2002practical limit on the number of outstanding requests.
1631 2003
1632=back 2004=back
1633 2005
2006
1634=head3 STATISTICAL INFORMATION 2007=head3 STATISTICAL INFORMATION
1635 2008
1636=over 2009=over
1637 2010
1638=item IO::AIO::nreqs 2011=item IO::AIO::nreqs
1655Returns the number of requests currently in the pending state (executed, 2028Returns the number of requests currently in the pending state (executed,
1656but not yet processed by poll_cb). 2029but not yet processed by poll_cb).
1657 2030
1658=back 2031=back
1659 2032
2033
2034=head3 SUBSECOND STAT TIME ACCESS
2035
2036Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can
2037generally find access/modification and change times with subsecond time
2038accuracy of the system supports it, but perl's built-in functions only
2039return the integer part.
2040
2041The following functions return the timestamps of the most recent
2042stat with subsecond precision on most systems and work both after
2043C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return
2044value is only meaningful after a successful C<stat>/C<lstat> call, or
2045during/after a successful C<aio_stat>/C<aio_lstat> callback.
2046
2047This is similar to the L<Time::HiRes> C<stat> functions, but can return
2048full resolution without rounding and work with standard perl C<stat>,
2049alleviating the need to call the special C<Time::HiRes> functions, which
2050do not act like their perl counterparts.
2051
2052On operating systems or file systems where subsecond time resolution is
2053not supported or could not be detected, a fractional part of C<0> is
2054returned, so it is always safe to call these functions.
2055
2056=over 4
2057
2058=item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
2059
2060Return the access, modication, change or birth time, respectively,
2061including fractional part. Due to the limited precision of floating point,
2062the accuracy on most platforms is only a bit better than milliseconds
2063for times around now - see the I<nsec> function family, below, for full
2064accuracy.
2065
2066File birth time is only available when the OS and perl support it (on
2067FreeBSD and NetBSD at the time of this writing, although support is
2068adaptive, so if your OS/perl gains support, IO::AIO can take avdantage of
2069it). On systems where it isn't available, C<0> is currently returned, but
2070this might change to C<undef> in a future version.
2071
2072=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
2073
2074Returns access, modification, change and birth time all in one go, and
2075maybe more times in the future version.
2076
2077=item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
2078
2079Return the fractional access, modifcation, change or birth time, in nanoseconds,
2080as an integer in the range C<0> to C<999999999>.
2081
2082Note that no accessors are provided for access, modification and
2083change times - you need to get those from C<stat _> if required (C<int
2084IO::AIO::st_atime> and so on will I<not> generally give you the correct
2085value).
2086
2087=item $seconds = IO::AIO::st_btimesec
2088
2089The (integral) seconds part of the file birth time, if available.
2090
2091=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
2092
2093Like the functions above, but returns all four times in one go (and maybe
2094more in future versions).
2095
2096=item $counter = IO::AIO::st_gen
2097
2098Returns the generation counter of the file. This is only available on
2099platforms which have this member in their C<struct stat> (most BSDs
2100at the time of this writing) and generally only to the root usert. If
2101unsupported, C<0> is returned, but this might change to C<undef> in a
2102future version.
2103
2104=back
2105
2106Example: print the high resolution modification time of F</etc>, using
2107C<stat>, and C<IO::AIO::aio_stat>.
2108
2109 if (stat "/etc") {
2110 printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
2111 }
2112
2113 IO::AIO::aio_stat "/etc", sub {
2114 $_[0]
2115 and return;
2116
2117 printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
2118 };
2119
2120 IO::AIO::flush;
2121
2122Output of the awbove on my system, showing reduced and full accuracy:
2123
2124 stat(/etc) mtime: 1534043702.020808
2125 aio_stat(/etc) mtime: 1534043702.020807792
2126
2127
1660=head3 MISCELLANEOUS FUNCTIONS 2128=head3 MISCELLANEOUS FUNCTIONS
1661 2129
1662IO::AIO implements some functions that might be useful, but are not 2130IO::AIO implements some functions that are useful when you want to use
1663asynchronous. 2131some "Advanced I/O" function not available to in Perl, without going the
2132"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
2133counterpart.
1664 2134
1665=over 4 2135=over 4
2136
2137=item $numfd = IO::AIO::get_fdlimit
2138
2139This function is I<EXPERIMENTAL> and subject to change.
2140
2141Tries to find the current file descriptor limit and returns it, or
2142C<undef> and sets C<$!> in case of an error. The limit is one larger than
2143the highest valid file descriptor number.
2144
2145=item IO::AIO::min_fdlimit [$numfd]
2146
2147This function is I<EXPERIMENTAL> and subject to change.
2148
2149Try to increase the current file descriptor limit(s) to at least C<$numfd>
2150by changing the soft or hard file descriptor resource limit. If C<$numfd>
2151is missing, it will try to set a very high limit, although this is not
2152recommended when you know the actual minimum that you require.
2153
2154If the limit cannot be raised enough, the function makes a best-effort
2155attempt to increase the limit as much as possible, using various
2156tricks, while still failing. You can query the resulting limit using
2157C<IO::AIO::get_fdlimit>.
2158
2159If an error occurs, returns C<undef> and sets C<$!>, otherwise returns
2160true.
1666 2161
1667=item IO::AIO::sendfile $ofh, $ifh, $offset, $count 2162=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1668 2163
1669Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, 2164Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
1670but is blocking (this makes most sense if you know the input data is 2165but is blocking (this makes most sense if you know the input data is
1687=item IO::AIO::madvise $scalar, $offset, $len, $advice 2182=item IO::AIO::madvise $scalar, $offset, $len, $advice
1688 2183
1689Simply calls the C<posix_madvise> function (see its 2184Simply calls the C<posix_madvise> function (see its
1690manpage for details). The following advice constants are 2185manpage for details). The following advice constants are
1691available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, 2186available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1692C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. 2187C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>,
2188C<IO::AIO::MADV_DONTNEED>.
2189
2190If C<$offset> is negative, counts from the end. If C<$length> is negative,
2191the remaining length of the C<$scalar> is used. If possible, C<$length>
2192will be reduced to fit into the C<$scalar>.
1693 2193
1694On systems that do not implement C<posix_madvise>, this function returns 2194On systems that do not implement C<posix_madvise>, this function returns
1695ENOSYS, otherwise the return value of C<posix_madvise>. 2195ENOSYS, otherwise the return value of C<posix_madvise>.
1696 2196
1697=item IO::AIO::mprotect $scalar, $offset, $len, $protect 2197=item IO::AIO::mprotect $scalar, $offset, $len, $protect
1699Simply calls the C<mprotect> function on the preferably AIO::mmap'ed 2199Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1700$scalar (see its manpage for details). The following protect 2200$scalar (see its manpage for details). The following protect
1701constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, 2201constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1702C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. 2202C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1703 2203
2204If C<$offset> is negative, counts from the end. If C<$length> is negative,
2205the remaining length of the C<$scalar> is used. If possible, C<$length>
2206will be reduced to fit into the C<$scalar>.
2207
1704On systems that do not implement C<mprotect>, this function returns 2208On systems that do not implement C<mprotect>, this function returns
1705ENOSYS, otherwise the return value of C<mprotect>. 2209ENOSYS, otherwise the return value of C<mprotect>.
1706 2210
1707=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 2211=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1708 2212
1709Memory-maps a file (or anonymous memory range) and attaches it to the 2213Memory-maps a file (or anonymous memory range) and attaches it to the
1710given C<$scalar>, which will act like a string scalar. 2214given C<$scalar>, which will act like a string scalar. Returns true on
2215success, and false otherwise.
1711 2216
2217The scalar must exist, but its contents do not matter - this means you
2218cannot use a nonexistant array or hash element. When in doubt, C<undef>
2219the scalar first.
2220
1712The only operations allowed on the scalar are C<substr>/C<vec> that don't 2221The only operations allowed on the mmapped scalar are C<substr>/C<vec>,
1713change the string length, and most read-only operations such as copying it 2222which don't change the string length, and most read-only operations such
1714or searching it with regexes and so on. 2223as copying it or searching it with regexes and so on.
1715 2224
1716Anything else is unsafe and will, at best, result in memory leaks. 2225Anything else is unsafe and will, at best, result in memory leaks.
1717 2226
1718The memory map associated with the C<$scalar> is automatically removed 2227The memory map associated with the C<$scalar> is automatically removed
1719when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or 2228when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap>
1720C<IO::AIO::munmap> functions are called. 2229or C<IO::AIO::munmap> functions are called on it.
1721 2230
1722This calls the C<mmap>(2) function internally. See your system's manual 2231This calls the C<mmap>(2) function internally. See your system's manual
1723page for details on the C<$length>, C<$prot> and C<$flags> parameters. 2232page for details on the C<$length>, C<$prot> and C<$flags> parameters.
1724 2233
1725The C<$length> must be larger than zero and smaller than the actual 2234The C<$length> must be larger than zero and smaller than the actual
1726filesize. 2235filesize.
1727 2236
1728C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, 2237C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1729C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, 2238C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1730 2239
1731C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or 2240C<$flags> can be a combination of
1732C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when 2241C<IO::AIO::MAP_SHARED> or
1733not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS> 2242C<IO::AIO::MAP_PRIVATE>,
2243or a number of system-specific flags (when not available, the are C<0>):
1734(which is set to C<MAP_ANON> if your system only provides this 2244C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
1735constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>, 2245C<IO::AIO::MAP_LOCKED>,
1736C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or 2246C<IO::AIO::MAP_NORESERVE>,
2247C<IO::AIO::MAP_POPULATE>,
1737C<IO::AIO::MAP_NONBLOCK> 2248C<IO::AIO::MAP_NONBLOCK>,
2249C<IO::AIO::MAP_FIXED>,
2250C<IO::AIO::MAP_GROWSDOWN>,
2251C<IO::AIO::MAP_32BIT>,
2252C<IO::AIO::MAP_HUGETLB> or
2253C<IO::AIO::MAP_STACK>.
1738 2254
1739If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. 2255If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1740 2256
1741C<$offset> is the offset from the start of the file - it generally must be 2257C<$offset> is the offset from the start of the file - it generally must be
1742a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. 2258a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
1756 2272
1757=item IO::AIO::munmap $scalar 2273=item IO::AIO::munmap $scalar
1758 2274
1759Removes a previous mmap and undefines the C<$scalar>. 2275Removes a previous mmap and undefines the C<$scalar>.
1760 2276
2277=item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0]
2278
2279Calls the Linux-specific mremap(2) system call. The C<$scalar> must have
2280been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be
2281C<0> or C<IO::AIO::MREMAP_MAYMOVE>.
2282
2283Returns true if successful, and false otherwise. If the underlying mmapped
2284region has changed address, then the true value has the numerical value
2285C<1>, otherwise it has the numerical value C<0>:
2286
2287 my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
2288 or die "mremap: $!";
2289
2290 if ($success*1) {
2291 warn "scalar has chanegd address in memory\n";
2292 }
2293
2294C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently
2295implemented, but not supported and might go away in a future version.
2296
2297On systems where this call is not supported or is not emulated, this call
2298returns falls and sets C<$!> to C<ENOSYS>.
2299
1761=item IO::AIO::munlock $scalar, $offset = 0, $length = undef 2300=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
1762 2301
1763Calls the C<munlock> function, undoing the effects of a previous 2302Calls the C<munlock> function, undoing the effects of a previous
1764C<aio_mlock> call (see its description for details). 2303C<aio_mlock> call (see its description for details).
1765 2304
1767 2306
1768Calls the C<munlockall> function. 2307Calls the C<munlockall> function.
1769 2308
1770On systems that do not implement C<munlockall>, this function returns 2309On systems that do not implement C<munlockall>, this function returns
1771ENOSYS, otherwise the return value of C<munlockall>. 2310ENOSYS, otherwise the return value of C<munlockall>.
2311
2312=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
2313
2314Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
2315C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
2316should be the file offset.
2317
2318C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2319silently corrupt the data in this case.
2320
2321The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
2322C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
2323C<IO::AIO::SPLICE_F_GIFT>.
2324
2325See the C<splice(2)> manpage for details.
2326
2327=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2328
2329Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
2330description for C<IO::AIO::splice> above for details.
2331
2332=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
2333
2334Attempts to query or change the pipe buffer size. Obviously works only
2335on pipes, and currently works only on GNU/Linux systems, and fails with
2336C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
2337size on other systems, drop me a note.
2338
2339=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
2340
2341This is a direct interface to the Linux L<pipe2(2)> system call. If
2342C<$flags> is missing or C<0>, then this should be the same as a call to
2343perl's built-in C<pipe> function and create a new pipe, and works on
2344systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
2345(..., 4096, O_BINARY)>.
2346
2347If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
2348the given flags (Linux 2.6.27, glibc 2.9).
2349
2350On success, the read and write file handles are returned.
2351
2352On error, nothing will be returned. If the pipe2 syscall is missing and
2353C<$flags> is non-zero, fails with C<ENOSYS>.
2354
2355Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
2356time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
2357C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
2358
2359Example: create a pipe race-free w.r.t. threads and fork:
2360
2361 my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
2362 or die "pipe2: $!\n";
2363
2364=item $fh = IO::AIO::eventfd [$initval, [$flags]]
2365
2366This is a direct interface to the Linux L<eventfd(2)> system call. The
2367(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
2368
2369On success, the new eventfd filehandle is returned, otherwise returns
2370C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
2371
2372Please refer to L<eventfd(2)> for more info on this call.
2373
2374The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
2375C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
2376
2377Example: create a new eventfd filehandle:
2378
2379 $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC
2380 or die "eventfd: $!\n";
2381
2382=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
2383
2384This is a direct interface to the Linux L<timerfd_create(2)> system call. The
2385(unhelpful) default for C<$flags> is C<0>.
2386
2387On success, the new timerfd filehandle is returned, otherwise returns
2388C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
2389
2390Please refer to L<timerfd_create(2)> for more info on this call.
2391
2392The following C<$clockid> values are
2393available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
2394C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15)
2395C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and
2396C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11).
2397
2398The following C<$flags> values are available (Linux
23992.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>.
2400
2401Example: create a new timerfd and set it to one-second repeated alarms,
2402then wait for two alarms:
2403
2404 my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC
2405 or die "timerfd_create: $!\n";
2406
2407 defined IO::AIO::timerfd_settime $fh, 0, 1, 1
2408 or die "timerfd_settime: $!\n";
2409
2410 for (1..2) {
2411 8 == sysread $fh, my $buf, 8
2412 or die "timerfd read failure\n";
2413
2414 printf "number of expirations (likely 1): %d\n",
2415 unpack "Q", $buf;
2416 }
2417
2418=item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
2419
2420This is a direct interface to the Linux L<timerfd_settime(2)> system
2421call. Please refer to its manpage for more info on this call.
2422
2423The new itimerspec is specified using two (possibly fractional) second
2424values, C<$new_interval> and C<$new_value>).
2425
2426On success, the current interval and value are returned (as per
2427C<timerfd_gettime>). On failure, the empty list is returned.
2428
2429The following C<$flags> values are
2430available: C<IO::AIO::TFD_TIMER_ABSTIME> and
2431C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>.
2432
2433See C<IO::AIO::timerfd_create> for a full example.
2434
2435=item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
2436
2437This is a direct interface to the Linux L<timerfd_gettime(2)> system
2438call. Please refer to its manpage for more info on this call.
2439
2440On success, returns the current values of interval and value for the given
2441timerfd (as potentially fractional second values). On failure, the empty
2442list is returned.
1772 2443
1773=back 2444=back
1774 2445
1775=cut 2446=cut
1776 2447
1842the process will result in undefined behaviour. Calling it at any time 2513the process will result in undefined behaviour. Calling it at any time
1843will also result in any undefined (by POSIX) behaviour. 2514will also result in any undefined (by POSIX) behaviour.
1844 2515
1845=back 2516=back
1846 2517
2518=head2 LINUX-SPECIFIC CALLS
2519
2520When a call is documented as "linux-specific" then this means it
2521originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the
2522availability and compatibility of such calls regardless of the platform
2523it is compiled on, so platforms such as FreeBSD which often implement
2524these calls will work. When in doubt, call them and see if they fail wth
2525C<ENOSYS>.
2526
1847=head2 MEMORY USAGE 2527=head2 MEMORY USAGE
1848 2528
1849Per-request usage: 2529Per-request usage:
1850 2530
1851Each aio request uses - depending on your architecture - around 100-200 2531Each aio request uses - depending on your architecture - around 100-200
1863temporary buffers, and each thread requires a stack and other data 2543temporary buffers, and each thread requires a stack and other data
1864structures (usually around 16k-128k, depending on the OS). 2544structures (usually around 16k-128k, depending on the OS).
1865 2545
1866=head1 KNOWN BUGS 2546=head1 KNOWN BUGS
1867 2547
1868Known bugs will be fixed in the next release. 2548Known bugs will be fixed in the next release :)
2549
2550=head1 KNOWN ISSUES
2551
2552Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap>
2553or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as
2554non-created hash slots or other scalars I didn't think of. It's best to
2555avoid such and either use scalar variables or making sure that the scalar
2556exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied).
2557
2558I am not sure anything can be done about this, so this is considered a
2559known issue, rather than a bug.
1869 2560
1870=head1 SEE ALSO 2561=head1 SEE ALSO
1871 2562
1872L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a 2563L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1873more natural syntax. 2564more natural syntax.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines