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.151 by root, Fri Jun 12 00:43:16 2009 UTC vs.
Revision 1.302 by root, Wed Apr 3 03:03:53 2019 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
9 aio_open "/etc/passwd", O_RDONLY, 0, sub { 9 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
10 my $fh = shift 10 my $fh = shift
11 or die "/etc/passwd: $!"; 11 or die "/etc/passwd: $!";
12 ... 12 ...
13 }; 13 };
14 14
26 $req->cancel; # cancel request if still in queue 26 $req->cancel; # cancel request if still in queue
27 27
28 my $grp = aio_group sub { print "all stats done\n" }; 28 my $grp = aio_group sub { print "all stats done\n" };
29 add $grp aio_stat "..." for ...; 29 add $grp aio_stat "..." for ...;
30 30
31 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
32 use AnyEvent::AIO;
33
34 # EV integration
35 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
36
37 # Event integration
38 Event->io (fd => IO::AIO::poll_fileno,
39 poll => 'r',
40 cb => \&IO::AIO::poll_cb);
41
42 # Glib/Gtk2 integration
43 add_watch Glib::IO IO::AIO::poll_fileno,
44 in => sub { IO::AIO::poll_cb; 1 };
45
46 # Tk integration
47 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
48 readable => \&IO::AIO::poll_cb);
49
50 # Danga::Socket integration
51 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
52 \&IO::AIO::poll_cb);
53
54=head1 DESCRIPTION 31=head1 DESCRIPTION
55 32
56This module implements asynchronous I/O using whatever means your 33This module implements asynchronous I/O using whatever means your
57operating system supports. 34operating system supports. It is implemented as an interface to C<libeio>
35(L<http://software.schmorp.de/pkg/libeio.html>).
58 36
59Asynchronous means that operations that can normally block your program 37Asynchronous means that operations that can normally block your program
60(e.g. reading from disk) will be done asynchronously: the operation 38(e.g. reading from disk) will be done asynchronously: the operation
61will still block, but you can do something else in the meantime. This 39will still block, but you can do something else in the meantime. This
62is extremely useful for programs that need to stay interactive even 40is extremely useful for programs that need to stay interactive even
66on a RAID volume or over NFS when you do a number of stat operations 44on a RAID volume or over NFS when you do a number of stat operations
67concurrently. 45concurrently.
68 46
69While most of this works on all types of file descriptors (for 47While most of this works on all types of file descriptors (for
70example sockets), using these functions on file descriptors that 48example sockets), using these functions on file descriptors that
71support nonblocking operation (again, sockets, pipes etc.) is very 49support nonblocking operation (again, sockets, pipes etc.) is
72inefficient. Use an event loop for that (such as the L<Event|Event> 50very inefficient. Use an event loop for that (such as the L<EV>
73module): IO::AIO will naturally fit into such an event loop itself. 51module): IO::AIO will naturally fit into such an event loop itself.
74 52
75In this version, a number of threads are started that execute your 53In this version, a number of threads are started that execute your
76requests and signal their completion. You don't need thread support 54requests and signal their completion. You don't need thread support
77in perl, and the threads created by this module will not be visible 55in perl, and the threads created by this module will not be visible
80not 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
81files currently, for example), and they would only support aio_read and 59files currently, for example), and they would only support aio_read and
82aio_write, so the remaining functionality would have to be implemented 60aio_write, so the remaining functionality would have to be implemented
83using threads anyway. 61using threads anyway.
84 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
85Although the module will work in the presence of other (Perl-) threads, 67Although the module will work in the presence of other (Perl-) threads,
86it is currently not reentrant in any way, so use appropriate locking 68it is currently not reentrant in any way, so use appropriate locking
87yourself, 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
88call C<poll_cb> (or other C<aio_> functions) recursively. 70call C<poll_cb> (or other C<aio_> functions) recursively.
89 71
90=head2 EXAMPLE 72=head2 EXAMPLE
91 73
92This is a simple example that uses the Event module and loads 74This is a simple example that uses the EV module and loads
93F</etc/passwd> asynchronously: 75F</etc/passwd> asynchronously:
94 76
95 use Fcntl;
96 use Event; 77 use EV;
97 use IO::AIO; 78 use IO::AIO;
98 79
99 # register the IO::AIO callback with Event 80 # register the IO::AIO callback with EV
100 Event->io (fd => IO::AIO::poll_fileno, 81 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
101 poll => 'r',
102 cb => \&IO::AIO::poll_cb);
103 82
104 # queue the request to open /etc/passwd 83 # queue the request to open /etc/passwd
105 aio_open "/etc/passwd", O_RDONLY, 0, sub { 84 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
106 my $fh = shift 85 my $fh = shift
107 or die "error while opening: $!"; 86 or die "error while opening: $!";
108 87
109 # stat'ing filehandles is generally non-blocking 88 # stat'ing filehandles is generally non-blocking
110 my $size = -s $fh; 89 my $size = -s $fh;
119 98
120 # file contents now in $contents 99 # file contents now in $contents
121 print $contents; 100 print $contents;
122 101
123 # exit event loop and program 102 # exit event loop and program
124 Event::unloop; 103 EV::break;
125 }; 104 };
126 }; 105 };
127 106
128 # possibly queue up other requests, or open GUI windows, 107 # possibly queue up other requests, or open GUI windows,
129 # check for sockets etc. etc. 108 # check for sockets etc. etc.
130 109
131 # process events as long as there are some: 110 # process events as long as there are some:
132 Event::loop; 111 EV::run;
133 112
134=head1 REQUEST ANATOMY AND LIFETIME 113=head1 REQUEST ANATOMY AND LIFETIME
135 114
136Every 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
137directly visible to Perl. 116directly visible to Perl.
187 166
188package IO::AIO; 167package IO::AIO;
189 168
190use Carp (); 169use Carp ();
191 170
192no warnings; 171use common::sense;
193use strict 'vars';
194 172
195use base 'Exporter'; 173use base 'Exporter';
196 174
197BEGIN { 175BEGIN {
198 our $VERSION = '3.2'; 176 our $VERSION = 4.72;
199 177
200 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
201 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
202 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync 180 aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
203 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead 181 aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
182 aio_pathsync aio_readahead aio_fiemap aio_allocate
204 aio_rename aio_link aio_move aio_copy aio_group 183 aio_rename aio_rename2 aio_link aio_move aio_copy aio_group
205 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
206 aio_chmod aio_utime aio_truncate); 185 aio_chmod aio_utime aio_truncate
186 aio_msync aio_mtouch aio_mlock aio_mlockall
187 aio_statvfs
188 aio_slurp
189 aio_wd);
207 190
208 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 191 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
209 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 192 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
210 min_parallel max_parallel max_idle 193 min_parallel max_parallel max_idle idle_timeout
211 nreqs nready npending nthreads 194 nreqs nready npending nthreads
212 max_poll_time max_poll_reqs); 195 max_poll_time max_poll_reqs
196 sendfile fadvise madvise
197 mmap munmap mremap munlock munlockall);
213 198
214 push @AIO_REQ, qw(aio_busy); # not exported 199 push @AIO_REQ, qw(aio_busy); # not exported
215 200
216 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 201 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
217 202
219 XSLoader::load ("IO::AIO", $VERSION); 204 XSLoader::load ("IO::AIO", $VERSION);
220} 205}
221 206
222=head1 FUNCTIONS 207=head1 FUNCTIONS
223 208
224=head2 AIO REQUEST FUNCTIONS 209=head2 QUICK OVERVIEW
210
211This section simply lists the prototypes most of the functions for
212quick reference. See the following sections for function-by-function
213documentation.
214
215 aio_wd $pathname, $callback->($wd)
216 aio_open $pathname, $flags, $mode, $callback->($fh)
217 aio_close $fh, $callback->($status)
218 aio_seek $fh,$offset,$whence, $callback->($offs)
219 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
220 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
221 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
222 aio_readahead $fh,$offset,$length, $callback->($retval)
223 aio_stat $fh_or_path, $callback->($status)
224 aio_lstat $fh, $callback->($status)
225 aio_statvfs $fh_or_path, $callback->($statvfs)
226 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
227 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
228 aio_chmod $fh_or_path, $mode, $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)
232 aio_unlink $pathname, $callback->($status)
233 aio_mknod $pathname, $mode, $dev, $callback->($status)
234 aio_link $srcpath, $dstpath, $callback->($status)
235 aio_symlink $srcpath, $dstpath, $callback->($status)
236 aio_readlink $pathname, $callback->($link)
237 aio_realpath $pathname, $callback->($path)
238 aio_rename $srcpath, $dstpath, $callback->($status)
239 aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
240 aio_mkdir $pathname, $mode, $callback->($status)
241 aio_rmdir $pathname, $callback->($status)
242 aio_readdir $pathname, $callback->($entries)
243 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
244 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
245 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
246 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
247 aio_load $pathname, $data, $callback->($status)
248 aio_copy $srcpath, $dstpath, $callback->($status)
249 aio_move $srcpath, $dstpath, $callback->($status)
250 aio_rmtree $pathname, $callback->($status)
251 aio_fcntl $fh, $cmd, $arg, $callback->($status)
252 aio_ioctl $fh, $request, $buf, $callback->($status)
253 aio_sync $callback->($status)
254 aio_syncfs $fh, $callback->($status)
255 aio_fsync $fh, $callback->($status)
256 aio_fdatasync $fh, $callback->($status)
257 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
258 aio_pathsync $pathname, $callback->($status)
259 aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
260 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
261 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
262 aio_mlockall $flags, $callback->($status)
263 aio_group $callback->(...)
264 aio_nop $callback->()
265
266 $prev_pri = aioreq_pri [$pri]
267 aioreq_nice $pri_adjust
268
269 IO::AIO::poll_wait
270 IO::AIO::poll_cb
271 IO::AIO::poll
272 IO::AIO::flush
273 IO::AIO::max_poll_reqs $nreqs
274 IO::AIO::max_poll_time $seconds
275 IO::AIO::min_parallel $nthreads
276 IO::AIO::max_parallel $nthreads
277 IO::AIO::max_idle $nthreads
278 IO::AIO::idle_timeout $seconds
279 IO::AIO::max_outstanding $maxreqs
280 IO::AIO::nreqs
281 IO::AIO::nready
282 IO::AIO::npending
283 IO::AIO::reinit
284
285 $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL]
286 IO::AIO::min_fdlimit $nfd [EXPERIMENTAL]
287
288 IO::AIO::sendfile $ofh, $ifh, $offset, $count
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]
294 IO::AIO::madvise $scalar, $offset, $length, $advice
295 IO::AIO::mprotect $scalar, $offset, $length, $protect
296 IO::AIO::munlock $scalar, $offset = 0, $length = undef
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::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
309 IO::AIO::tee $r_fh, $w_fh, $length, $flags
310 $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
311 ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
312 $fh = IO::AIO::memfd_create $pathname[, $flags]
313 $fh = IO::AIO::eventfd [$initval, [$flags]]
314 $fh = IO::AIO::timerfd_create $clockid[, $flags]
315 ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
316 ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
317
318=head2 API NOTES
225 319
226All the C<aio_*> calls are more or less thin wrappers around the syscall 320All the C<aio_*> calls are more or less thin wrappers around the syscall
227with the same name (sans C<aio_>). The arguments are similar or identical, 321with the same name (sans C<aio_>). The arguments are similar or identical,
228and they all accept an additional (and optional) C<$callback> argument 322and they all accept an additional (and optional) C<$callback> argument
229which must be a code reference. This code reference will get called with 323which must be a code reference. This code reference will be called after
230the syscall return code (e.g. most syscalls return C<-1> on error, unlike 324the syscall has been executed in an asynchronous fashion. The results
231perl, which usually delivers "false") as its sole argument after the given 325of the request will be passed as arguments to the callback (and, if an
232syscall has been executed asynchronously. 326error occured, in C<$!>) - for most requests the syscall return code (e.g.
327most syscalls return C<-1> on error, unlike perl, which usually delivers
328"false").
329
330Some requests (such as C<aio_readdir>) pass the actual results and
331communicate failures by passing C<undef>.
233 332
234All functions expecting a filehandle keep a copy of the filehandle 333All functions expecting a filehandle keep a copy of the filehandle
235internally until the request has finished. 334internally until the request has finished.
236 335
237All functions return request objects of type L<IO::AIO::REQ> that allow 336All functions return request objects of type L<IO::AIO::REQ> that allow
238further manipulation of those requests while they are in-flight. 337further manipulation of those requests while they are in-flight.
239 338
240The pathnames you pass to these routines I<must> be absolute and 339The pathnames you pass to these routines I<should> be absolute. The
241encoded as octets. The reason for the former is that at the time the 340reason for this is that at the time the request is being executed, the
242request is being executed, the current working directory could have 341current working directory could have changed. Alternatively, you can
243changed. Alternatively, you can make sure that you never change the 342make sure that you never change the current working directory anywhere
244current working directory anywhere in the program and then use relative 343in the program and then use relative paths. You can also take advantage
245paths. 344of IO::AIOs working directory abstraction, that lets you specify paths
345relative to some previously-opened "working directory object" - see the
346description of the C<IO::AIO::WD> class later in this document.
246 347
247To encode pathnames as octets, either make sure you either: a) always pass 348To encode pathnames as octets, either make sure you either: a) always pass
248in filenames you got from outside (command line, readdir etc.) without 349in filenames you got from outside (command line, readdir etc.) without
249tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode 350tinkering, b) are in your native filesystem encoding, c) use the Encode
250your pathnames to the locale (or other) encoding in effect in the user 351module and encode your pathnames to the locale (or other) encoding in
251environment, d) use Glib::filename_from_unicode on unicode filenames or e) 352effect in the user environment, d) use Glib::filename_from_unicode on
252use something else to ensure your scalar has the correct contents. 353unicode filenames or e) use something else to ensure your scalar has the
354correct contents.
253 355
254This works, btw. independent of the internal UTF-8 bit, which IO::AIO 356This works, btw. independent of the internal UTF-8 bit, which IO::AIO
255handles correctly whether it is set or not. 357handles correctly whether it is set or not.
358
359=head2 AIO REQUEST FUNCTIONS
256 360
257=over 4 361=over 4
258 362
259=item $prev_pri = aioreq_pri [$pri] 363=item $prev_pri = aioreq_pri [$pri]
260 364
290 394
291 395
292=item aio_open $pathname, $flags, $mode, $callback->($fh) 396=item aio_open $pathname, $flags, $mode, $callback->($fh)
293 397
294Asynchronously open or create a file and call the callback with a newly 398Asynchronously open or create a file and call the callback with a newly
295created filehandle for the file. 399created filehandle for the file (or C<undef> in case of an error).
296 400
297The pathname passed to C<aio_open> must be absolute. See API NOTES, above, 401The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
298for an explanation. 402for an explanation.
299 403
300The C<$flags> argument is a bitmask. See the C<Fcntl> module for a 404The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
307by the umask in effect then the request is being executed, so better never 411by the umask in effect then the request is being executed, so better never
308change the umask. 412change the umask.
309 413
310Example: 414Example:
311 415
312 aio_open "/etc/passwd", O_RDONLY, 0, sub { 416 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
313 if ($_[0]) { 417 if ($_[0]) {
314 print "open successful, fh is $_[0]\n"; 418 print "open successful, fh is $_[0]\n";
315 ... 419 ...
316 } else { 420 } else {
317 die "open failed: $!\n"; 421 die "open failed: $!\n";
318 } 422 }
319 }; 423 };
320 424
425In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>,
426C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the
427following POSIX and non-POSIX constants are available (missing ones on
428your system are, as usual, C<0>):
429
430C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
431C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
432C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>.
433
321 434
322=item aio_close $fh, $callback->($status) 435=item aio_close $fh, $callback->($status)
323 436
324Asynchronously close a file and call the callback with the result 437Asynchronously close a file and call the callback with the result
325code. 438code.
334Or in other words: the file descriptor will be closed, but it will not be 447Or in other words: the file descriptor will be closed, but it will not be
335free for reuse until the perl filehandle is closed. 448free for reuse until the perl filehandle is closed.
336 449
337=cut 450=cut
338 451
452=item aio_seek $fh, $offset, $whence, $callback->($offs)
453
454Seeks the filehandle to the new C<$offset>, similarly to perl's
455C<sysseek>. The C<$whence> can use the traditional values (C<0> for
456C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
457C<IO::AIO::SEEK_END>).
458
459The resulting absolute offset will be passed to the callback, or C<-1> in
460case of an error.
461
462In theory, the C<$whence> constants could be different than the
463corresponding values from L<Fcntl>, but perl guarantees they are the same,
464so don't panic.
465
466As a GNU/Linux (and maybe Solaris) extension, also the constants
467C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
468could be found. No guarantees about suitability for use in C<aio_seek> or
469Perl's C<sysseek> can be made though, although I would naively assume they
470"just work".
471
339=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 472=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
340 473
341=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 474=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
342 475
343Reads or writes C<$length> bytes from or to the specified C<$fh> and 476Reads or writes C<$length> bytes from or to the specified C<$fh> and
344C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> 477C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and
345and calls the callback without the actual number of bytes read (or -1 on 478calls the callback with the actual number of bytes transferred (or -1 on
346error, just like the syscall). 479error, just like the syscall).
347 480
348C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to 481C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
349offset plus the actual number of bytes read. 482offset plus the actual number of bytes read.
350 483
375 508
376Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 509Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
377reading at byte offset C<$in_offset>, and starts writing at the current 510reading at byte offset C<$in_offset>, and starts writing at the current
378file offset of C<$out_fh>. Because of that, it is not safe to issue more 511file offset of C<$out_fh>. Because of that, it is not safe to issue more
379than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each 512than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
380other. 513other. The same C<$in_fh> works fine though, as this function does not
514move or use the file offset of C<$in_fh>.
381 515
516Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than
517are written, and there is no way to find out how many more bytes have been
518read from C<aio_sendfile> alone, as C<aio_sendfile> only provides the
519number of bytes written to C<$out_fh>. Only if the result value equals
520C<$length> one can assume that C<$length> bytes have been read.
521
522Unlike with other C<aio_> functions, it makes a lot of sense to use
523C<aio_sendfile> on non-blocking sockets, as long as one end (typically
524the C<$in_fh>) is a file - the file I/O will then be asynchronous, while
525the socket I/O will be non-blocking. Note, however, that you can run
526into a trap where C<aio_sendfile> reads some data with readahead, then
527fails to write all data, and when the socket is ready the next time, the
528data in the cache is already lost, forcing C<aio_sendfile> to again hit
529the disk. Explicit C<aio_read> + C<aio_write> let's you better control
530resource usage.
531
382This call tries to make use of a native C<sendfile> syscall to provide 532This call tries to make use of a native C<sendfile>-like syscall to
383zero-copy operation. For this to work, C<$out_fh> should refer to a 533provide zero-copy operation. For this to work, C<$out_fh> should refer to
384socket, and C<$in_fh> should refer to mmap'able file. 534a socket, and C<$in_fh> should refer to an mmap'able file.
385 535
386If the native sendfile call fails or is not implemented, it will be 536If a native sendfile cannot be found or it fails with C<ENOSYS>,
387emulated, so you can call C<aio_sendfile> on any type of filehandle 537C<EINVAL>, C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or
538C<ENOTSOCK>, it will be emulated, so you can call C<aio_sendfile> on any
388regardless of the limitations of the operating system. 539type of filehandle regardless of the limitations of the operating system.
389 540
390Please note, however, that C<aio_sendfile> can read more bytes from 541As native sendfile syscalls (as practically any non-POSIX interface hacked
391C<$in_fh> than are written, and there is no way to find out how many 542together in a hurry to improve benchmark numbers) tend to be rather buggy
392bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 543on many systems, this implementation tries to work around some known bugs
393provides the number of bytes written to C<$out_fh>. Only if the result 544in Linux and FreeBSD kernels (probably others, too), but that might fail,
394value equals C<$length> one can assume that C<$length> bytes have been 545so you really really should check the return value of C<aio_sendfile> -
395read. 546fewer bytes than expected might have been transferred.
396 547
397 548
398=item aio_readahead $fh,$offset,$length, $callback->($retval) 549=item aio_readahead $fh,$offset,$length, $callback->($retval)
399 550
400C<aio_readahead> populates the page cache with data from a file so that 551C<aio_readahead> populates the page cache with data from a file so that
404whole pages, so that offset is effectively rounded down to a page boundary 555whole pages, so that offset is effectively rounded down to a page boundary
405and bytes are read up to the next page boundary greater than or equal to 556and bytes are read up to the next page boundary greater than or equal to
406(off-set+length). C<aio_readahead> does not read beyond the end of the 557(off-set+length). C<aio_readahead> does not read beyond the end of the
407file. The current file offset of the file is left unchanged. 558file. The current file offset of the file is left unchanged.
408 559
409If that syscall doesn't exist (likely if your OS isn't Linux) it will be 560If that syscall doesn't exist (likely if your kernel isn't Linux) it will
410emulated by simply reading the data, which would have a similar effect. 561be emulated by simply reading the data, which would have a similar effect.
411 562
412 563
413=item aio_stat $fh_or_path, $callback->($status) 564=item aio_stat $fh_or_path, $callback->($status)
414 565
415=item aio_lstat $fh, $callback->($status) 566=item aio_lstat $fh, $callback->($status)
416 567
417Works like perl's C<stat> or C<lstat> in void context. The callback will 568Works almost exactly like perl's C<stat> or C<lstat> in void context. The
418be called after the stat and the results will be available using C<stat _> 569callback will be called after the stat and the results will be available
419or C<-s _> etc... 570using C<stat _> or C<-s _> and other tests (with the exception of C<-B>
571and C<-T>).
420 572
421The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, 573The pathname passed to C<aio_stat> must be absolute. See API NOTES, above,
422for an explanation. 574for an explanation.
423 575
424Currently, the stats are always 64-bit-stats, i.e. instead of returning an 576Currently, the stats are always 64-bit-stats, i.e. instead of returning an
425error when stat'ing a large file, the results will be silently truncated 577error when stat'ing a large file, the results will be silently truncated
426unless perl itself is compiled with large file support. 578unless perl itself is compiled with large file support.
579
580To help interpret the mode and dev/rdev stat values, IO::AIO offers the
581following constants and functions (if not implemented, the constants will
582be C<0> and the functions will either C<croak> or fall back on traditional
583behaviour).
584
585C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
586C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
587C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
588
589To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME
590ACCESS>.
427 591
428Example: Print the length of F</etc/passwd>: 592Example: Print the length of F</etc/passwd>:
429 593
430 aio_stat "/etc/passwd", sub { 594 aio_stat "/etc/passwd", sub {
431 $_[0] and die "stat failed: $!"; 595 $_[0] and die "stat failed: $!";
432 print "size is ", -s _, "\n"; 596 print "size is ", -s _, "\n";
433 }; 597 };
434 598
435 599
600=item aio_statvfs $fh_or_path, $callback->($statvfs)
601
602Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
603whether a file handle or path was passed.
604
605On success, the callback is passed a hash reference with the following
606members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
607C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
608is passed.
609
610The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
611C<ST_NOSUID>.
612
613The following non-POSIX IO::AIO::ST_* flag masks are defined to
614their correct value when available, or to C<0> on systems that do
615not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
616C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
617C<ST_NODIRATIME> and C<ST_RELATIME>.
618
619Example: stat C</wd> and dump out the data if successful.
620
621 aio_statvfs "/wd", sub {
622 my $f = $_[0]
623 or die "statvfs: $!";
624
625 use Data::Dumper;
626 say Dumper $f;
627 };
628
629 # result:
630 {
631 bsize => 1024,
632 bfree => 4333064312,
633 blocks => 10253828096,
634 files => 2050765568,
635 flag => 4096,
636 favail => 2042092649,
637 bavail => 4333064312,
638 ffree => 2042092649,
639 namemax => 255,
640 frsize => 1024,
641 fsid => 1810
642 }
643
436=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 644=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
437 645
438Works like perl's C<utime> function (including the special case of $atime 646Works like perl's C<utime> function (including the special case of $atime
439and $mtime being undef). Fractional times are supported if the underlying 647and $mtime being undef). Fractional times are supported if the underlying
440syscalls support them. 648syscalls support them.
441 649
442When called with a pathname, uses utimes(2) if available, otherwise 650When called with a pathname, uses utimensat(2) or utimes(2) if available,
443utime(2). If called on a file descriptor, uses futimes(2) if available, 651otherwise utime(2). If called on a file descriptor, uses futimens(2)
444otherwise returns ENOSYS, so this is not portable. 652or futimes(2) if available, otherwise returns ENOSYS, so this is not
653portable.
445 654
446Examples: 655Examples:
447 656
448 # set atime and mtime to current time (basically touch(1)): 657 # set atime and mtime to current time (basically touch(1)):
449 aio_utime "path", undef, undef; 658 aio_utime "path", undef, undef;
467=item aio_truncate $fh_or_path, $offset, $callback->($status) 676=item aio_truncate $fh_or_path, $offset, $callback->($status)
468 677
469Works like truncate(2) or ftruncate(2). 678Works like truncate(2) or ftruncate(2).
470 679
471 680
681=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
682
683Allocates or frees disk space according to the C<$mode> argument. See the
684linux C<fallocate> documentation for details.
685
686C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
687space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>,
688to deallocate a file range.
689
690IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
691(without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range,
692C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE>
693to unshare shared blocks (see your L<fallocate(2)> manpage).
694
695The file system block size used by C<fallocate> is presumably the
696C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes
697can dictate other limitations.
698
699If C<fallocate> isn't available or cannot be emulated (currently no
700emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
701
702
472=item aio_chmod $fh_or_path, $mode, $callback->($status) 703=item aio_chmod $fh_or_path, $mode, $callback->($status)
473 704
474Works like perl's C<chmod> function. 705Works like perl's C<chmod> function.
475 706
476 707
478 709
479Asynchronously unlink (delete) a file and call the callback with the 710Asynchronously unlink (delete) a file and call the callback with the
480result code. 711result code.
481 712
482 713
483=item aio_mknod $path, $mode, $dev, $callback->($status) 714=item aio_mknod $pathname, $mode, $dev, $callback->($status)
484 715
485[EXPERIMENTAL] 716[EXPERIMENTAL]
486 717
487Asynchronously create a device node (or fifo). See mknod(2). 718Asynchronously create a device node (or fifo). See mknod(2).
488 719
489The only (POSIX-) portable way of calling this function is: 720The only (POSIX-) portable way of calling this function is:
490 721
491 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 722 aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
492 723
724See C<aio_stat> for info about some potentially helpful extra constants
725and functions.
493 726
494=item aio_link $srcpath, $dstpath, $callback->($status) 727=item aio_link $srcpath, $dstpath, $callback->($status)
495 728
496Asynchronously create a new link to the existing object at C<$srcpath> at 729Asynchronously create a new link to the existing object at C<$srcpath> at
497the path C<$dstpath> and call the callback with the result code. 730the path C<$dstpath> and call the callback with the result code.
501 734
502Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 735Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
503the path C<$dstpath> and call the callback with the result code. 736the path C<$dstpath> and call the callback with the result code.
504 737
505 738
506=item aio_readlink $path, $callback->($link) 739=item aio_readlink $pathname, $callback->($link)
507 740
508Asynchronously read the symlink specified by C<$path> and pass it to 741Asynchronously read the symlink specified by C<$path> and pass it to
509the callback. If an error occurs, nothing or undef gets passed to the 742the callback. If an error occurs, nothing or undef gets passed to the
510callback. 743callback.
511 744
512 745
746=item aio_realpath $pathname, $callback->($path)
747
748Asynchronously make the path absolute and resolve any symlinks in
749C<$path>. The resulting path only consists of directories (same as
750L<Cwd::realpath>).
751
752This request can be used to get the absolute path of the current working
753directory by passing it a path of F<.> (a single dot).
754
755
513=item aio_rename $srcpath, $dstpath, $callback->($status) 756=item aio_rename $srcpath, $dstpath, $callback->($status)
514 757
515Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 758Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
516rename(2) and call the callback with the result code. 759rename(2) and call the callback with the result code.
760
761On systems that support the AIO::WD working directory abstraction
762natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
763of failing, C<rename> is called on the absolute path of C<$wd>.
764
765
766=item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
767
768Basically a version of C<aio_rename> with an additional C<$flags>
769argument. Calling this with C<$flags=0> is the same as calling
770C<aio_rename>.
771
772Non-zero flags are currently only supported on GNU/Linux systems that
773support renameat2. Other systems fail with C<ENOSYS> in this case.
774
775The following constants are available (missing ones are, as usual C<0>),
776see renameat2(2) for details:
777
778C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE>
779and C<IO::AIO::RENAME_WHITEOUT>.
517 780
518 781
519=item aio_mkdir $pathname, $mode, $callback->($status) 782=item aio_mkdir $pathname, $mode, $callback->($status)
520 783
521Asynchronously mkdir (create) a directory and call the callback with 784Asynchronously mkdir (create) a directory and call the callback with
526=item aio_rmdir $pathname, $callback->($status) 789=item aio_rmdir $pathname, $callback->($status)
527 790
528Asynchronously rmdir (delete) a directory and call the callback with the 791Asynchronously rmdir (delete) a directory and call the callback with the
529result code. 792result code.
530 793
794On systems that support the AIO::WD working directory abstraction
795natively, the case C<[$wd, "."]> is specialcased - instead of failing,
796C<rmdir> is called on the absolute path of C<$wd>.
797
531 798
532=item aio_readdir $pathname, $callback->($entries) 799=item aio_readdir $pathname, $callback->($entries)
533 800
534Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 801Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
535directory (i.e. opendir + readdir + closedir). The entries will not be 802directory (i.e. opendir + readdir + closedir). The entries will not be
539array-ref with the filenames. 806array-ref with the filenames.
540 807
541 808
542=item aio_readdirx $pathname, $flags, $callback->($entries, $flags) 809=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
543 810
544Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune 811Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to
545behaviour and output format. In case of an error, C<$entries> will be 812tune behaviour and output format. In case of an error, C<$entries> will be
546C<undef>. 813C<undef>.
547 814
548The flags are a combination of the following constants, ORed together (the 815The flags are a combination of the following constants, ORed together (the
549flags will also be passed to the callback, possibly modified): 816flags will also be passed to the callback, possibly modified):
550 817
551=over 4 818=over 4
552 819
553=item IO::AIO::READDIR_DENTS 820=item IO::AIO::READDIR_DENTS
554 821
555When this flag is off, then the callback gets an arrayref with of names 822Normally the callback gets an arrayref consisting of names only (as
556only (as with C<aio_readdir>), otherwise it gets an arrayref with 823with C<aio_readdir>). If this flag is set, then the callback gets an
557C<[$name, $type, $inode]> arrayrefs, each describing a single directory 824arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a
558entry in more detail. 825single directory entry in more detail:
559 826
560C<$name> is the name of the entry. 827C<$name> is the name of the entry.
561 828
562C<$type> is one of the C<IO::AIO::DT_xxx> constants: 829C<$type> is one of the C<IO::AIO::DT_xxx> constants:
563 830
564C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, 831C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
565C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, 832C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
566C<IO::AIO::DT_WHT>. 833C<IO::AIO::DT_WHT>.
567 834
568C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to 835C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need
569know, you have to run stat yourself. Also, for speed reasons, the C<$type> 836to know, you have to run stat yourself. Also, for speed/memory reasons,
570scalars are read-only: you can not modify them. 837the C<$type> scalars are read-only: you must not modify them.
571 838
572C<$inode> is the inode number (which might not be exact on systems with 64 839C<$inode> is the inode number (which might not be exact on systems with 64
573bit inode numbers and 32 bit perls). On systems that do not deliver the 840bit inode numbers and 32 bit perls). This field has unspecified content on
574inode information, this will always be zero. 841systems that do not deliver the inode information.
575 842
576=item IO::AIO::READDIR_DIRS_FIRST 843=item IO::AIO::READDIR_DIRS_FIRST
577 844
578When this flag is set, then the names will be returned in an order where 845When this flag is set, then the names will be returned in an order where
579likely directories come first. This is useful when you need to quickly 846likely directories come first, in optimal stat order. This is useful when
580find directories, or you want to find all directories while avoiding to 847you need to quickly find directories, or you want to find all directories
581stat() each entry. 848while avoiding to stat() each entry.
582 849
583If the system returns type information in readdir, then this is used 850If the system returns type information in readdir, then this is used
584to find directories directly. Otherwise, likely directories are files 851to find directories directly. Otherwise, likely directories are names
585beginning with ".", or otherwise files with no dots, of which files with 852beginning with ".", or otherwise names with no dots, of which names with
586short names are tried first. 853short names are tried first.
587 854
588=item IO::AIO::READDIR_STAT_ORDER 855=item IO::AIO::READDIR_STAT_ORDER
589 856
590When this flag is set, then the names will be returned in an order 857When this flag is set, then the names will be returned in an order
591suitable for stat()'ing each one. That is, when you plan to stat() 858suitable for stat()'ing each one. That is, when you plan to stat() most or
592all files in the given directory, then the returned order will likely 859all files in the given directory, then the returned order will likely be
593be fastest. 860faster.
594 861
595If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then 862If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified,
596the likely dirs come first, resulting in a less optimal stat order. 863then the likely dirs come first, resulting in a less optimal stat order
864for stat'ing all entries, but likely a more optimal order for finding
865subdirectories.
597 866
598=item IO::AIO::READDIR_FOUND_UNKNOWN 867=item IO::AIO::READDIR_FOUND_UNKNOWN
599 868
600This flag should not be set when calling C<aio_readdirx>. Instead, it 869This flag should not be set when calling C<aio_readdirx>. Instead, it
601is being set by C<aio_readdirx>, when any of the C<$type>'s found were 870is being set by C<aio_readdirx>, when any of the C<$type>'s found were
602C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all 871C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all
603C<$type>'s are known, which can be used to speed up some algorithms. 872C<$type>'s are known, which can be used to speed up some algorithms.
604 873
605=back 874=back
606 875
607 876
877=item aio_slurp $pathname, $offset, $length, $data, $callback->($status)
878
879Opens, reads and closes the given file. The data is put into C<$data>,
880which is resized as required.
881
882If C<$offset> is negative, then it is counted from the end of the file.
883
884If C<$length> is zero, then the remaining length of the file is
885used. Also, in this case, the same limitations to modifying C<$data> apply
886as when IO::AIO::mmap is used, i.e. it must only be modified in-place
887with C<substr>. If the size of the file is known, specifying a non-zero
888C<$length> results in a performance advantage.
889
890This request is similar to the older C<aio_load> request, but since it is
891a single request, it might be more efficient to use.
892
893Example: load F</etc/passwd> into C<$passwd>.
894
895 my $passwd;
896 aio_slurp "/etc/passwd", 0, 0, $passwd, sub {
897 $_[0] >= 0
898 or die "/etc/passwd: $!\n";
899
900 printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd;
901 print $passwd;
902 };
903 IO::AIO::flush;
904
905
608=item aio_load $path, $data, $callback->($status) 906=item aio_load $pathname, $data, $callback->($status)
609 907
610This is a composite request that tries to fully load the given file into 908This is a composite request that tries to fully load the given file into
611memory. Status is the same as with aio_read. 909memory. Status is the same as with aio_read.
910
911Using C<aio_slurp> might be more efficient, as it is a single request.
612 912
613=cut 913=cut
614 914
615sub aio_load($$;$) { 915sub aio_load($$;$) {
616 my ($path, undef, $cb) = @_; 916 my ($path, undef, $cb) = @_;
635 935
636=item aio_copy $srcpath, $dstpath, $callback->($status) 936=item aio_copy $srcpath, $dstpath, $callback->($status)
637 937
638Try to copy the I<file> (directories not supported as either source or 938Try to copy the I<file> (directories not supported as either source or
639destination) from C<$srcpath> to C<$dstpath> and call the callback with 939destination) from C<$srcpath> to C<$dstpath> and call the callback with
640the C<0> (error) or C<-1> ok. 940a status of C<0> (ok) or C<-1> (error, see C<$!>).
941
942Existing destination files will be truncated.
641 943
642This is a composite request that creates the destination file with 944This is a composite request that creates the destination file with
643mode 0200 and copies the contents of the source file into it using 945mode 0200 and copies the contents of the source file into it using
644C<aio_sendfile>, followed by restoring atime, mtime, access mode and 946C<aio_sendfile>, followed by restoring atime, mtime, access mode and
645uid/gid, in that order. 947uid/gid, in that order.
657 my $grp = aio_group $cb; 959 my $grp = aio_group $cb;
658 960
659 aioreq_pri $pri; 961 aioreq_pri $pri;
660 add $grp aio_open $src, O_RDONLY, 0, sub { 962 add $grp aio_open $src, O_RDONLY, 0, sub {
661 if (my $src_fh = $_[0]) { 963 if (my $src_fh = $_[0]) {
662 my @stat = stat $src_fh; # hmm, might bock over nfs? 964 my @stat = stat $src_fh; # hmm, might block over nfs?
663 965
664 aioreq_pri $pri; 966 aioreq_pri $pri;
665 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 967 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
666 if (my $dst_fh = $_[0]) { 968 if (my $dst_fh = $_[0]) {
667 aioreq_pri $pri; 969 aioreq_pri $pri;
714 1016
715=item aio_move $srcpath, $dstpath, $callback->($status) 1017=item aio_move $srcpath, $dstpath, $callback->($status)
716 1018
717Try to move the I<file> (directories not supported as either source or 1019Try to move the I<file> (directories not supported as either source or
718destination) from C<$srcpath> to C<$dstpath> and call the callback with 1020destination) from C<$srcpath> to C<$dstpath> and call the callback with
719the C<0> (error) or C<-1> ok. 1021a status of C<0> (ok) or C<-1> (error, see C<$!>).
720 1022
721This is a composite request that tries to rename(2) the file first; if 1023This is a composite request that tries to rename(2) the file first; if
722rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if 1024rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
723that is successful, unlinks the C<$srcpath>. 1025that is successful, unlinks the C<$srcpath>.
724 1026
735 if ($_[0] && $! == EXDEV) { 1037 if ($_[0] && $! == EXDEV) {
736 aioreq_pri $pri; 1038 aioreq_pri $pri;
737 add $grp aio_copy $src, $dst, sub { 1039 add $grp aio_copy $src, $dst, sub {
738 $grp->result ($_[0]); 1040 $grp->result ($_[0]);
739 1041
740 if (!$_[0]) { 1042 unless ($_[0]) {
741 aioreq_pri $pri; 1043 aioreq_pri $pri;
742 add $grp aio_unlink $src; 1044 add $grp aio_unlink $src;
743 } 1045 }
744 }; 1046 };
745 } else { 1047 } else {
748 }; 1050 };
749 1051
750 $grp 1052 $grp
751} 1053}
752 1054
753=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 1055=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
754 1056
755Scans a directory (similar to C<aio_readdir>) but additionally tries to 1057Scans a directory (similar to C<aio_readdir>) but additionally tries to
756efficiently separate the entries of directory C<$path> into two sets of 1058efficiently separate the entries of directory C<$path> into two sets of
757names, directories you can recurse into (directories), and ones you cannot 1059names, directories you can recurse into (directories), and ones you cannot
758recurse into (everything else, including symlinks to directories). 1060recurse into (everything else, including symlinks to directories).
759 1061
760C<aio_scandir> is a composite request that creates of many sub requests_ 1062C<aio_scandir> is a composite request that generates many sub requests.
761C<$maxreq> specifies the maximum number of outstanding aio requests that 1063C<$maxreq> specifies the maximum number of outstanding aio requests that
762this function generates. If it is C<< <= 0 >>, then a suitable default 1064this function generates. If it is C<< <= 0 >>, then a suitable default
763will be chosen (currently 4). 1065will be chosen (currently 4).
764 1066
765On error, the callback is called without arguments, otherwise it receives 1067On error, the callback is called without arguments, otherwise it receives
789Then entries will be sorted into likely directories a non-initial dot 1091Then entries will be sorted into likely directories a non-initial dot
790currently) and likely non-directories (see C<aio_readdirx>). Then every 1092currently) and likely non-directories (see C<aio_readdirx>). Then every
791entry plus an appended C</.> will be C<stat>'ed, likely directories first, 1093entry plus an appended C</.> will be C<stat>'ed, likely directories first,
792in order of their inode numbers. If that succeeds, it assumes that the 1094in order of their inode numbers. If that succeeds, it assumes that the
793entry is a directory or a symlink to directory (which will be checked 1095entry is a directory or a symlink to directory (which will be checked
794seperately). This is often faster than stat'ing the entry itself because 1096separately). This is often faster than stat'ing the entry itself because
795filesystems might detect the type of the entry without reading the inode 1097filesystems might detect the type of the entry without reading the inode
796data (e.g. ext2fs filetype feature), even on systems that cannot return 1098data (e.g. ext2fs filetype feature), even on systems that cannot return
797the filetype information on readdir. 1099the filetype information on readdir.
798 1100
799If the known number of directories (link count - 2) has been reached, the 1101If the known number of directories (link count - 2) has been reached, the
815 1117
816 my $grp = aio_group $cb; 1118 my $grp = aio_group $cb;
817 1119
818 $maxreq = 4 if $maxreq <= 0; 1120 $maxreq = 4 if $maxreq <= 0;
819 1121
820 # stat once 1122 # get a wd object
821 aioreq_pri $pri; 1123 aioreq_pri $pri;
822 add $grp aio_stat $path, sub { 1124 add $grp aio_wd $path, sub {
1125 $_[0]
823 return $grp->result () if $_[0]; 1126 or return $grp->result ();
824 my $now = time;
825 my $hash1 = join ":", (stat _)[0,1,3,7,9];
826 1127
827 # read the directory entries 1128 my $wd = [shift, "."];
1129
1130 # stat once
828 aioreq_pri $pri; 1131 aioreq_pri $pri;
829 add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { 1132 add $grp aio_stat $wd, sub {
830 my $entries = shift
831 or return $grp->result (); 1133 return $grp->result () if $_[0];
1134 my $now = time;
1135 my $hash1 = join ":", (stat _)[0,1,3,7,9];
1136 my $rdxflags = READDIR_DIRS_FIRST;
832 1137
833 # stat the dir another time 1138 if ((stat _)[3] < 2) {
1139 # at least one non-POSIX filesystem exists
1140 # that returns useful DT_type values: btrfs,
1141 # so optimise for this here by requesting dents
1142 $rdxflags |= READDIR_DENTS;
1143 }
1144
1145 # read the directory entries
834 aioreq_pri $pri; 1146 aioreq_pri $pri;
835 add $grp aio_stat $path, sub { 1147 add $grp aio_readdirx $wd, $rdxflags, sub {
836 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 1148 my ($entries, $flags) = @_
1149 or return $grp->result ();
837 1150
1151 if ($rdxflags & READDIR_DENTS) {
1152 # if we requested type values, see if we can use them directly.
1153
1154 # if there were any DT_UNKNOWN entries then we assume we
1155 # don't know. alternatively, we could assume that if we get
1156 # one DT_DIR, then all directories are indeed marked with
1157 # DT_DIR, but this seems not required for btrfs, and this
1158 # is basically the "btrfs can't get it's act together" code
1159 # branch.
1160 unless ($flags & READDIR_FOUND_UNKNOWN) {
1161 # now we have valid DT_ information for all entries,
1162 # so use it as an optimisation without further stat's.
1163 # they must also all be at the beginning of @$entries
1164 # by now.
1165
838 my $ndirs; 1166 my $dirs;
839 1167
840 # take the slow route if anything looks fishy
841 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
842 $ndirs = -1;
843 } else {
844 # if nlink == 2, we are finished
845 # for non-posix-fs's, we rely on nlink < 2
846 $ndirs = (stat _)[3] - 2
847 or return $grp->result ([], $entries);
848 }
849
850 my (@dirs, @nondirs);
851
852 my $statgrp = add $grp aio_group sub {
853 $grp->result (\@dirs, \@nondirs);
854 };
855
856 limit $statgrp $maxreq;
857 feed $statgrp sub {
858 return unless @$entries;
859 my $entry = shift @$entries;
860
861 aioreq_pri $pri;
862 add $statgrp aio_stat "$path/$entry/.", sub {
863 if ($_[0] < 0) { 1168 if (@$entries) {
864 push @nondirs, $entry; 1169 for (0 .. $#$entries) {
865 } else { 1170 if ($entries->[$_][1] != DT_DIR) {
866 # need to check for real directory 1171 # splice out directories
867 aioreq_pri $pri; 1172 $dirs = [splice @$entries, 0, $_];
868 add $statgrp aio_lstat "$path/$entry", sub {
869 if (-d _) {
870 push @dirs, $entry;
871
872 unless (--$ndirs) {
873 push @nondirs, @$entries;
874 feed $statgrp;
875 } 1173 last;
876 } else {
877 push @nondirs, $entry;
878 } 1174 }
879 } 1175 }
1176
1177 # if we didn't find any non-dir, then all entries are dirs
1178 unless ($dirs) {
1179 ($dirs, $entries) = ($entries, []);
1180 }
1181 } else {
1182 # directory is empty, so there are no sbdirs
1183 $dirs = [];
880 } 1184 }
1185
1186 # either splice'd the directories out or the dir was empty.
1187 # convert dents to filenames
1188 $_ = $_->[0] for @$dirs;
1189 $_ = $_->[0] for @$entries;
1190
1191 return $grp->result ($dirs, $entries);
1192 }
1193
1194 # cannot use, so return to our old ways
1195 # by pretending we only scanned for names.
1196 $_ = $_->[0] for @$entries;
1197 }
1198
1199 # stat the dir another time
1200 aioreq_pri $pri;
1201 add $grp aio_stat $wd, sub {
1202 my $hash2 = join ":", (stat _)[0,1,3,7,9];
1203
1204 my $ndirs;
1205
1206 # take the slow route if anything looks fishy
1207 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
1208 $ndirs = -1;
1209 } else {
1210 # if nlink == 2, we are finished
1211 # for non-posix-fs's, we rely on nlink < 2
1212 $ndirs = (stat _)[3] - 2
1213 or return $grp->result ([], $entries);
1214 }
1215
1216 my (@dirs, @nondirs);
1217
1218 my $statgrp = add $grp aio_group sub {
1219 $grp->result (\@dirs, \@nondirs);
1220 };
1221
1222 limit $statgrp $maxreq;
1223 feed $statgrp sub {
1224 return unless @$entries;
1225 my $entry = shift @$entries;
1226
1227 aioreq_pri $pri;
1228 $wd->[1] = "$entry/.";
1229 add $statgrp aio_stat $wd, sub {
1230 if ($_[0] < 0) {
1231 push @nondirs, $entry;
1232 } else {
1233 # need to check for real directory
1234 aioreq_pri $pri;
1235 $wd->[1] = $entry;
1236 add $statgrp aio_lstat $wd, sub {
1237 if (-d _) {
1238 push @dirs, $entry;
1239
1240 unless (--$ndirs) {
1241 push @nondirs, @$entries;
1242 feed $statgrp;
1243 }
1244 } else {
1245 push @nondirs, $entry;
1246 }
1247 }
1248 }
1249 };
881 }; 1250 };
882 }; 1251 };
883 }; 1252 };
884 }; 1253 };
885 }; 1254 };
886 1255
887 $grp 1256 $grp
888} 1257}
889 1258
890=item aio_rmtree $path, $callback->($status) 1259=item aio_rmtree $pathname, $callback->($status)
891 1260
892Delete a directory tree starting (and including) C<$path>, return the 1261Delete a directory tree starting (and including) C<$path>, return the
893status of the final C<rmdir> only. This is a composite request that 1262status of the final C<rmdir> only. This is a composite request that
894uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1263uses C<aio_scandir> to recurse into and rmdir directories, and unlink
895everything else. 1264everything else.
896 1265
897=cut 1266=cut
898 1267
920 }; 1289 };
921 1290
922 $grp 1291 $grp
923} 1292}
924 1293
1294=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
1295
1296=item aio_ioctl $fh, $request, $buf, $callback->($status)
1297
1298These work just like the C<fcntl> and C<ioctl> built-in functions, except
1299they execute asynchronously and pass the return value to the callback.
1300
1301Both calls can be used for a lot of things, some of which make more sense
1302to run asynchronously in their own thread, while some others make less
1303sense. For example, calls that block waiting for external events, such
1304as locking, will also lock down an I/O thread while it is waiting, which
1305can deadlock the whole I/O system. At the same time, there might be no
1306alternative to using a thread to wait.
1307
1308So in general, you should only use these calls for things that do
1309(filesystem) I/O, not for things that wait for other events (network,
1310other processes), although if you are careful and know what you are doing,
1311you still can.
1312
1313The following constants are available (missing ones are, as usual C<0>):
1314
1315C<F_DUPFD_CLOEXEC>,
1316
1317C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
1318
1319C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
1320
1321C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
1322C<FS_IOC_FIEMAP>.
1323
1324C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
1325C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
1326
1327C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
1328C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
1329C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
1330C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
1331C<FS_FL_USER_MODIFIABLE>.
1332
1333C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
1334C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
1335C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
1336C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
1337
925=item aio_sync $callback->($status) 1338=item aio_sync $callback->($status)
926 1339
927Asynchronously call sync and call the callback when finished. 1340Asynchronously call sync and call the callback when finished.
928 1341
929=item aio_fsync $fh, $callback->($status) 1342=item aio_fsync $fh, $callback->($status)
936Asynchronously call fdatasync on the given filehandle and call the 1349Asynchronously call fdatasync on the given filehandle and call the
937callback with the fdatasync result code. 1350callback with the fdatasync result code.
938 1351
939If this call isn't available because your OS lacks it or it couldn't be 1352If this call isn't available because your OS lacks it or it couldn't be
940detected, it will be emulated by calling C<fsync> instead. 1353detected, it will be emulated by calling C<fsync> instead.
1354
1355=item aio_syncfs $fh, $callback->($status)
1356
1357Asynchronously call the syncfs syscall to sync the filesystem associated
1358to the given filehandle and call the callback with the syncfs result
1359code. If syncfs is not available, calls sync(), but returns C<-1> and sets
1360errno to C<ENOSYS> nevertheless.
941 1361
942=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 1362=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
943 1363
944Sync the data portion of the file specified by C<$offset> and C<$length> 1364Sync the data portion of the file specified by C<$offset> and C<$length>
945to disk (but NOT the metadata), by calling the Linux-specific 1365to disk (but NOT the metadata), by calling the Linux-specific
949C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, 1369C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
950C<IO::AIO::SYNC_FILE_RANGE_WRITE> and 1370C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
951C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range 1371C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
952manpage for details. 1372manpage for details.
953 1373
954=item aio_pathsync $path, $callback->($status) 1374=item aio_pathsync $pathname, $callback->($status)
955 1375
956This request tries to open, fsync and close the given path. This is a 1376This request tries to open, fsync and close the given path. This is a
957composite request intended to sync directories after directory operations 1377composite request intended to sync directories after directory operations
958(E.g. rename). This might not work on all operating systems or have any 1378(E.g. rename). This might not work on all operating systems or have any
959specific effect, but usually it makes sure that directory changes get 1379specific effect, but usually it makes sure that directory changes get
960written to disc. It works for anything that can be opened for read-only, 1380written to disc. It works for anything that can be opened for read-only,
961not just directories. 1381not just directories.
1382
1383Future versions of this function might fall back to other methods when
1384C<fsync> on the directory fails (such as calling C<sync>).
962 1385
963Passes C<0> when everything went ok, and C<-1> on error. 1386Passes C<0> when everything went ok, and C<-1> on error.
964 1387
965=cut 1388=cut
966 1389
987 }; 1410 };
988 1411
989 $grp 1412 $grp
990} 1413}
991 1414
1415=item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
1416
1417This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1418scalars (see the C<IO::AIO::mmap> function, although it also works on data
1419scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1420scalar must only be modified in-place while an aio operation is pending on
1421it).
1422
1423It calls the C<msync> function of your OS, if available, with the memory
1424area starting at C<$offset> in the string and ending C<$length> bytes
1425later. If C<$length> is negative, counts from the end, and if C<$length>
1426is C<undef>, then it goes till the end of the string. The flags can be
1427either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional
1428C<IO::AIO::MS_INVALIDATE>.
1429
1430=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1431
1432This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1433scalars.
1434
1435It touches (reads or writes) all memory pages in the specified
1436range inside the scalar. All caveats and parameters are the same
1437as for C<aio_msync>, above, except for flags, which must be either
1438C<0> (which reads all pages and ensures they are instantiated) or
1439C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1440writing an octet from it, which dirties the page).
1441
1442=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1443
1444This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1445scalars.
1446
1447It reads in all the pages of the underlying storage into memory (if any)
1448and locks them, so they are not getting swapped/paged out or removed.
1449
1450If C<$length> is undefined, then the scalar will be locked till the end.
1451
1452On systems that do not implement C<mlock>, this function returns C<-1>
1453and sets errno to C<ENOSYS>.
1454
1455Note that the corresponding C<munlock> is synchronous and is
1456documented under L<MISCELLANEOUS FUNCTIONS>.
1457
1458Example: open a file, mmap and mlock it - both will be undone when
1459C<$data> gets destroyed.
1460
1461 open my $fh, "<", $path or die "$path: $!";
1462 my $data;
1463 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1464 aio_mlock $data; # mlock in background
1465
1466=item aio_mlockall $flags, $callback->($status)
1467
1468Calls the C<mlockall> function with the given C<$flags> (a
1469combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and
1470C<IO::AIO::MCL_ONFAULT>).
1471
1472On systems that do not implement C<mlockall>, this function returns C<-1>
1473and sets errno to C<ENOSYS>. Similarly, flag combinations not supported
1474by the system result in a return value of C<-1> with errno being set to
1475C<EINVAL>.
1476
1477Note that the corresponding C<munlockall> is synchronous and is
1478documented under L<MISCELLANEOUS FUNCTIONS>.
1479
1480Example: asynchronously lock all current and future pages into memory.
1481
1482 aio_mlockall IO::AIO::MCL_FUTURE;
1483
1484=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1485
1486Queries the extents of the given file (by calling the Linux C<FIEMAP>
1487ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
1488the ioctl is not available on your OS, then this request will fail with
1489C<ENOSYS>.
1490
1491C<$start> is the starting offset to query extents for, C<$length> is the
1492size of the range to query - if it is C<undef>, then the whole file will
1493be queried.
1494
1495C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
1496C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1497exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1498the data portion.
1499
1500C<$count> is the maximum number of extent records to return. If it is
1501C<undef>, then IO::AIO queries all extents of the range. As a very special
1502case, if it is C<0>, then the callback receives the number of extents
1503instead of the extents themselves (which is unreliable, see below).
1504
1505If an error occurs, the callback receives no arguments. The special
1506C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1507
1508Otherwise, the callback receives an array reference with extent
1509structures. Each extent structure is an array reference itself, with the
1510following members:
1511
1512 [$logical, $physical, $length, $flags]
1513
1514Flags is any combination of the following flag values (typically either C<0>
1515or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1516
1517C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1518C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1519C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1520C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1521C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1522C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1523
1524At the time of this writing (Linux 3.2), this request is unreliable unless
1525C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1526it to return all extents of a range for files with a large number of
1527extents. The code (only) works around all these issues if C<$count> is
1528C<undef>.
1529
992=item aio_group $callback->(...) 1530=item aio_group $callback->(...)
993 1531
994This is a very special aio request: Instead of doing something, it is a 1532This is a very special aio request: Instead of doing something, it is a
995container for other aio requests, which is useful if you want to bundle 1533container for other aio requests, which is useful if you want to bundle
996many requests into a single, composite, request with a definite callback 1534many requests into a single, composite, request with a definite callback
1032like sleep and file handle readable/writable, the overhead this creates is 1570like sleep and file handle readable/writable, the overhead this creates is
1033immense (it blocks a thread for a long time) so do not use this function 1571immense (it blocks a thread for a long time) so do not use this function
1034except to put your application under artificial I/O pressure. 1572except to put your application under artificial I/O pressure.
1035 1573
1036=back 1574=back
1575
1576
1577=head2 IO::AIO::WD - multiple working directories
1578
1579Your process only has one current working directory, which is used by all
1580threads. This makes it hard to use relative paths (some other component
1581could call C<chdir> at any time, and it is hard to control when the path
1582will be used by IO::AIO).
1583
1584One solution for this is to always use absolute paths. This usually works,
1585but can be quite slow (the kernel has to walk the whole path on every
1586access), and can also be a hassle to implement.
1587
1588Newer POSIX systems have a number of functions (openat, fdopendir,
1589futimensat and so on) that make it possible to specify working directories
1590per operation.
1591
1592For portability, and because the clowns who "designed", or shall I write,
1593perpetrated this new interface were obviously half-drunk, this abstraction
1594cannot be perfect, though.
1595
1596IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
1597object. This object stores the canonicalised, absolute version of the
1598path, and on systems that allow it, also a directory file descriptor.
1599
1600Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
1601or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
1602object and a pathname instead (or the IO::AIO::WD object alone, which
1603gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
1604IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
1605to that IO::AIO::WD object.
1606
1607For example, to get a wd object for F</etc> and then stat F<passwd>
1608inside, you would write:
1609
1610 aio_wd "/etc", sub {
1611 my $etcdir = shift;
1612
1613 # although $etcdir can be undef on error, there is generally no reason
1614 # to check for errors here, as aio_stat will fail with ENOENT
1615 # when $etcdir is undef.
1616
1617 aio_stat [$etcdir, "passwd"], sub {
1618 # yay
1619 };
1620 };
1621
1622The fact that C<aio_wd> is a request and not a normal function shows that
1623creating an IO::AIO::WD object is itself a potentially blocking operation,
1624which is why it is done asynchronously.
1625
1626To stat the directory obtained with C<aio_wd> above, one could write
1627either of the following three request calls:
1628
1629 aio_lstat "/etc" , sub { ... # pathname as normal string
1630 aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
1631 aio_lstat $wd , sub { ... # shorthand for the previous
1632
1633As with normal pathnames, IO::AIO keeps a copy of the working directory
1634object and the pathname string, so you could write the following without
1635causing any issues due to C<$path> getting reused:
1636
1637 my $path = [$wd, undef];
1638
1639 for my $name (qw(abc def ghi)) {
1640 $path->[1] = $name;
1641 aio_stat $path, sub {
1642 # ...
1643 };
1644 }
1645
1646There are some caveats: when directories get renamed (or deleted), the
1647pathname string doesn't change, so will point to the new directory (or
1648nowhere at all), while the directory fd, if available on the system,
1649will still point to the original directory. Most functions accepting a
1650pathname will use the directory fd on newer systems, and the string on
1651older systems. Some functions (such as C<aio_realpath>) will always rely on
1652the string form of the pathname.
1653
1654So this functionality is mainly useful to get some protection against
1655C<chdir>, to easily get an absolute path out of a relative path for future
1656reference, and to speed up doing many operations in the same directory
1657(e.g. when stat'ing all files in a directory).
1658
1659The following functions implement this working directory abstraction:
1660
1661=over 4
1662
1663=item aio_wd $pathname, $callback->($wd)
1664
1665Asynchonously canonicalise the given pathname and convert it to an
1666IO::AIO::WD object representing it. If possible and supported on the
1667system, also open a directory fd to speed up pathname resolution relative
1668to this working directory.
1669
1670If something goes wrong, then C<undef> is passwd to the callback instead
1671of a working directory object and C<$!> is set appropriately. Since
1672passing C<undef> as working directory component of a pathname fails the
1673request with C<ENOENT>, there is often no need for error checking in the
1674C<aio_wd> callback, as future requests using the value will fail in the
1675expected way.
1676
1677=item IO::AIO::CWD
1678
1679This is a compiletime constant (object) that represents the process
1680current working directory.
1681
1682Specifying this object as working directory object for a pathname is as if
1683the pathname would be specified directly, without a directory object. For
1684example, these calls are functionally identical:
1685
1686 aio_stat "somefile", sub { ... };
1687 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1688
1689=back
1690
1691To recover the path associated with an IO::AIO::WD object, you can use
1692C<aio_realpath>:
1693
1694 aio_realpath $wd, sub {
1695 warn "path is $_[0]\n";
1696 };
1697
1698Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
1699sometimes, fall back to using an absolue path.
1037 1700
1038=head2 IO::AIO::REQ CLASS 1701=head2 IO::AIO::REQ CLASS
1039 1702
1040All non-aggregate C<aio_*> functions return an object of this class when 1703All non-aggregate C<aio_*> functions return an object of this class when
1041called in non-void context. 1704called in non-void context.
1131=item $grp->cancel_subs 1794=item $grp->cancel_subs
1132 1795
1133Cancel all subrequests and clears any feeder, but not the group request 1796Cancel all subrequests and clears any feeder, but not the group request
1134itself. Useful when you queued a lot of events but got a result early. 1797itself. Useful when you queued a lot of events but got a result early.
1135 1798
1799The group request will finish normally (you cannot add requests to the
1800group).
1801
1136=item $grp->result (...) 1802=item $grp->result (...)
1137 1803
1138Set the result value(s) that will be passed to the group callback when all 1804Set the result value(s) that will be passed to the group callback when all
1139subrequests have finished and set the groups errno to the current value 1805subrequests have finished and set the groups errno to the current value
1140of errno (just like calling C<errno> without an error number). By default, 1806of errno (just like calling C<errno> without an error number). By default,
1156 1822
1157Sets a feeder/generator on this group: every group can have an attached 1823Sets a feeder/generator on this group: every group can have an attached
1158generator that generates requests if idle. The idea behind this is that, 1824generator that generates requests if idle. The idea behind this is that,
1159although you could just queue as many requests as you want in a group, 1825although you could just queue as many requests as you want in a group,
1160this might starve other requests for a potentially long time. For example, 1826this might starve other requests for a potentially long time. For example,
1161C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, 1827C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1162delaying any later requests for a long time. 1828requests, delaying any later requests for a long time.
1163 1829
1164To avoid this, and allow incremental generation of requests, you can 1830To avoid this, and allow incremental generation of requests, you can
1165instead a group and set a feeder on it that generates those requests. The 1831instead a group and set a feeder on it that generates those requests. The
1166feed callback will be called whenever there are few enough (see C<limit>, 1832feed callback will be called whenever there are few enough (see C<limit>,
1167below) requests active in the group itself and is expected to queue more 1833below) requests active in the group itself and is expected to queue more
1199The default value for the limit is C<0>, but note that setting a feeder 1865The default value for the limit is C<0>, but note that setting a feeder
1200automatically bumps it up to C<2>. 1866automatically bumps it up to C<2>.
1201 1867
1202=back 1868=back
1203 1869
1870
1204=head2 SUPPORT FUNCTIONS 1871=head2 SUPPORT FUNCTIONS
1205 1872
1206=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1873=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1207 1874
1208=over 4 1875=over 4
1209 1876
1210=item $fileno = IO::AIO::poll_fileno 1877=item $fileno = IO::AIO::poll_fileno
1211 1878
1212Return the I<request result pipe file descriptor>. This filehandle must be 1879Return the I<request result pipe file descriptor>. This filehandle must be
1213polled for reading by some mechanism outside this module (e.g. Event or 1880polled for reading by some mechanism outside this module (e.g. EV, Glib,
1214select, see below or the SYNOPSIS). If the pipe becomes readable you have 1881select and so on, see below or the SYNOPSIS). If the pipe becomes readable
1215to call C<poll_cb> to check the results. 1882you have to call C<poll_cb> to check the results.
1216 1883
1217See C<poll_cb> for an example. 1884See C<poll_cb> for an example.
1218 1885
1219=item IO::AIO::poll_cb 1886=item IO::AIO::poll_cb
1220 1887
1221Process some outstanding events on the result pipe. You have to call this 1888Process some requests that have reached the result phase (i.e. they have
1222regularly. Returns C<0> if all events could be processed, or C<-1> if it 1889been executed but the results are not yet reported). You have to call
1223returned earlier for whatever reason. Returns immediately when no events 1890this "regularly" to finish outstanding requests.
1224are outstanding. The amount of events processed depends on the settings of
1225C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1226 1891
1892Returns C<0> if all events could be processed (or there were no
1893events to process), or C<-1> if it returned earlier for whatever
1894reason. Returns immediately when no events are outstanding. The amount
1895of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1896C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1897
1227If not all requests were processed for whatever reason, the filehandle 1898If not all requests were processed for whatever reason, the poll file
1228will still be ready when C<poll_cb> returns, so normally you don't have to 1899descriptor will still be ready when C<poll_cb> returns, so normally you
1229do anything special to have it called later. 1900don't have to do anything special to have it called later.
1901
1902Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1903ready, it can be beneficial to call this function from loops which submit
1904a lot of requests, to make sure the results get processed when they become
1905available and not just when the loop is finished and the event loop takes
1906over again. This function returns very fast when there are no outstanding
1907requests.
1230 1908
1231Example: Install an Event watcher that automatically calls 1909Example: Install an Event watcher that automatically calls
1232IO::AIO::poll_cb with high priority: 1910IO::AIO::poll_cb with high priority (more examples can be found in the
1911SYNOPSIS section, at the top of this document):
1233 1912
1234 Event->io (fd => IO::AIO::poll_fileno, 1913 Event->io (fd => IO::AIO::poll_fileno,
1235 poll => 'r', async => 1, 1914 poll => 'r', async => 1,
1236 cb => \&IO::AIO::poll_cb); 1915 cb => \&IO::AIO::poll_cb);
1916
1917=item IO::AIO::poll_wait
1918
1919Wait until either at least one request is in the result phase or no
1920requests are outstanding anymore.
1921
1922This is useful if you want to synchronously wait for some requests to
1923become ready, without actually handling them.
1924
1925See C<nreqs> for an example.
1926
1927=item IO::AIO::poll
1928
1929Waits until some requests have been handled.
1930
1931Returns the number of requests processed, but is otherwise strictly
1932equivalent to:
1933
1934 IO::AIO::poll_wait, IO::AIO::poll_cb
1935
1936=item IO::AIO::flush
1937
1938Wait till all outstanding AIO requests have been handled.
1939
1940Strictly equivalent to:
1941
1942 IO::AIO::poll_wait, IO::AIO::poll_cb
1943 while IO::AIO::nreqs;
1944
1945This function can be useful at program aborts, to make sure outstanding
1946I/O has been done (C<IO::AIO> uses an C<END> block which already calls
1947this function on normal exits), or when you are merely using C<IO::AIO>
1948for its more advanced functions, rather than for async I/O, e.g.:
1949
1950 my ($dirs, $nondirs);
1951 IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
1952 IO::AIO::flush;
1953 # $dirs, $nondirs are now set
1237 1954
1238=item IO::AIO::max_poll_reqs $nreqs 1955=item IO::AIO::max_poll_reqs $nreqs
1239 1956
1240=item IO::AIO::max_poll_time $seconds 1957=item IO::AIO::max_poll_time $seconds
1241 1958
1266 # use a low priority so other tasks have priority 1983 # use a low priority so other tasks have priority
1267 Event->io (fd => IO::AIO::poll_fileno, 1984 Event->io (fd => IO::AIO::poll_fileno,
1268 poll => 'r', nice => 1, 1985 poll => 'r', nice => 1,
1269 cb => &IO::AIO::poll_cb); 1986 cb => &IO::AIO::poll_cb);
1270 1987
1271=item IO::AIO::poll_wait
1272
1273If there are any outstanding requests and none of them in the result
1274phase, wait till the result filehandle becomes ready for reading (simply
1275does a C<select> on the filehandle. This is useful if you want to
1276synchronously wait for some requests to finish).
1277
1278See C<nreqs> for an example.
1279
1280=item IO::AIO::poll
1281
1282Waits until some requests have been handled.
1283
1284Returns the number of requests processed, but is otherwise strictly
1285equivalent to:
1286
1287 IO::AIO::poll_wait, IO::AIO::poll_cb
1288
1289=item IO::AIO::flush
1290
1291Wait till all outstanding AIO requests have been handled.
1292
1293Strictly equivalent to:
1294
1295 IO::AIO::poll_wait, IO::AIO::poll_cb
1296 while IO::AIO::nreqs;
1297
1298=back 1988=back
1989
1299 1990
1300=head3 CONTROLLING THE NUMBER OF THREADS 1991=head3 CONTROLLING THE NUMBER OF THREADS
1301 1992
1302=over 1993=over
1303 1994
1335 2026
1336Under normal circumstances you don't need to call this function. 2027Under normal circumstances you don't need to call this function.
1337 2028
1338=item IO::AIO::max_idle $nthreads 2029=item IO::AIO::max_idle $nthreads
1339 2030
1340Limit the number of threads (default: 4) that are allowed to idle (i.e., 2031Limit the number of threads (default: 4) that are allowed to idle
1341threads that did not get a request to process within 10 seconds). That 2032(i.e., threads that did not get a request to process within the idle
1342means if a thread becomes idle while C<$nthreads> other threads are also 2033timeout (default: 10 seconds). That means if a thread becomes idle while
1343idle, it will free its resources and exit. 2034C<$nthreads> other threads are also idle, it will free its resources and
2035exit.
1344 2036
1345This is useful when you allow a large number of threads (e.g. 100 or 1000) 2037This is useful when you allow a large number of threads (e.g. 100 or 1000)
1346to allow for extremely high load situations, but want to free resources 2038to allow for extremely high load situations, but want to free resources
1347under normal circumstances (1000 threads can easily consume 30MB of RAM). 2039under normal circumstances (1000 threads can easily consume 30MB of RAM).
1348 2040
1349The default is probably ok in most situations, especially if thread 2041The default is probably ok in most situations, especially if thread
1350creation is fast. If thread creation is very slow on your system you might 2042creation is fast. If thread creation is very slow on your system you might
1351want to use larger values. 2043want to use larger values.
1352 2044
2045=item IO::AIO::idle_timeout $seconds
2046
2047Sets the minimum idle timeout (default 10) after which worker threads are
2048allowed to exit. SEe C<IO::AIO::max_idle>.
2049
1353=item IO::AIO::max_outstanding $maxreqs 2050=item IO::AIO::max_outstanding $maxreqs
2051
2052Sets the maximum number of outstanding requests to C<$nreqs>. If
2053you do queue up more than this number of requests, the next call to
2054C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as
2055C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no
2056longer exceeded.
2057
2058In other words, this setting does not enforce a queue limit, but can be
2059used to make poll functions block if the limit is exceeded.
1354 2060
1355This is a very bad function to use in interactive programs because it 2061This is a very bad function to use in interactive programs because it
1356blocks, and a bad way to reduce concurrency because it is inexact: Better 2062blocks, and a bad way to reduce concurrency because it is inexact: Better
1357use an C<aio_group> together with a feed callback. 2063use an C<aio_group> together with a feed callback.
1358 2064
1359Sets the maximum number of outstanding requests to C<$nreqs>. If you 2065Its main use is in scripts without an event loop - when you want to stat
1360do queue up more than this number of requests, the next call to the 2066a lot of files, you can write something like this:
1361C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1362function will block until the limit is no longer exceeded.
1363 2067
1364The default value is very large, so there is no practical limit on the 2068 IO::AIO::max_outstanding 32;
1365number of outstanding requests.
1366 2069
1367You can still queue as many requests as you want. Therefore, 2070 for my $path (...) {
1368C<max_outstanding> is mainly useful in simple scripts (with low values) or 2071 aio_stat $path , ...;
1369as a stop gap to shield against fatal memory overflow (with large values). 2072 IO::AIO::poll_cb;
2073 }
2074
2075 IO::AIO::flush;
2076
2077The call to C<poll_cb> inside the loop will normally return instantly, but
2078as soon as more thna C<32> reqeusts are in-flight, it will block until
2079some requests have been handled. This keeps the loop from pushing a large
2080number of C<aio_stat> requests onto the queue.
2081
2082The default value for C<max_outstanding> is very large, so there is no
2083practical limit on the number of outstanding requests.
1370 2084
1371=back 2085=back
2086
1372 2087
1373=head3 STATISTICAL INFORMATION 2088=head3 STATISTICAL INFORMATION
1374 2089
1375=over 2090=over
1376 2091
1394Returns the number of requests currently in the pending state (executed, 2109Returns the number of requests currently in the pending state (executed,
1395but not yet processed by poll_cb). 2110but not yet processed by poll_cb).
1396 2111
1397=back 2112=back
1398 2113
2114
2115=head3 SUBSECOND STAT TIME ACCESS
2116
2117Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can
2118generally find access/modification and change times with subsecond time
2119accuracy of the system supports it, but perl's built-in functions only
2120return the integer part.
2121
2122The following functions return the timestamps of the most recent
2123stat with subsecond precision on most systems and work both after
2124C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return
2125value is only meaningful after a successful C<stat>/C<lstat> call, or
2126during/after a successful C<aio_stat>/C<aio_lstat> callback.
2127
2128This is similar to the L<Time::HiRes> C<stat> functions, but can return
2129full resolution without rounding and work with standard perl C<stat>,
2130alleviating the need to call the special C<Time::HiRes> functions, which
2131do not act like their perl counterparts.
2132
2133On operating systems or file systems where subsecond time resolution is
2134not supported or could not be detected, a fractional part of C<0> is
2135returned, so it is always safe to call these functions.
2136
2137=over 4
2138
2139=item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
2140
2141Return the access, modication, change or birth time, respectively,
2142including fractional part. Due to the limited precision of floating point,
2143the accuracy on most platforms is only a bit better than milliseconds
2144for times around now - see the I<nsec> function family, below, for full
2145accuracy.
2146
2147File birth time is only available when the OS and perl support it (on
2148FreeBSD and NetBSD at the time of this writing, although support is
2149adaptive, so if your OS/perl gains support, IO::AIO can take advantage of
2150it). On systems where it isn't available, C<0> is currently returned, but
2151this might change to C<undef> in a future version.
2152
2153=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
2154
2155Returns access, modification, change and birth time all in one go, and
2156maybe more times in the future version.
2157
2158=item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
2159
2160Return the fractional access, modifcation, change or birth time, in nanoseconds,
2161as an integer in the range C<0> to C<999999999>.
2162
2163Note that no accessors are provided for access, modification and
2164change times - you need to get those from C<stat _> if required (C<int
2165IO::AIO::st_atime> and so on will I<not> generally give you the correct
2166value).
2167
2168=item $seconds = IO::AIO::st_btimesec
2169
2170The (integral) seconds part of the file birth time, if available.
2171
2172=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
2173
2174Like the functions above, but returns all four times in one go (and maybe
2175more in future versions).
2176
2177=item $counter = IO::AIO::st_gen
2178
2179Returns the generation counter (in practice this is just a random number)
2180of the file. This is only available on platforms which have this member in
2181their C<struct stat> (most BSDs at the time of this writing) and generally
2182only to the root usert. If unsupported, C<0> is returned, but this might
2183change to C<undef> in a future version.
2184
2185=back
2186
2187Example: print the high resolution modification time of F</etc>, using
2188C<stat>, and C<IO::AIO::aio_stat>.
2189
2190 if (stat "/etc") {
2191 printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
2192 }
2193
2194 IO::AIO::aio_stat "/etc", sub {
2195 $_[0]
2196 and return;
2197
2198 printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
2199 };
2200
2201 IO::AIO::flush;
2202
2203Output of the awbove on my system, showing reduced and full accuracy:
2204
2205 stat(/etc) mtime: 1534043702.020808
2206 aio_stat(/etc) mtime: 1534043702.020807792
2207
2208
2209=head3 MISCELLANEOUS FUNCTIONS
2210
2211IO::AIO implements some functions that are useful when you want to use
2212some "Advanced I/O" function not available to in Perl, without going the
2213"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
2214counterpart.
2215
2216=over 4
2217
2218=item $numfd = IO::AIO::get_fdlimit
2219
2220This function is I<EXPERIMENTAL> and subject to change.
2221
2222Tries to find the current file descriptor limit and returns it, or
2223C<undef> and sets C<$!> in case of an error. The limit is one larger than
2224the highest valid file descriptor number.
2225
2226=item IO::AIO::min_fdlimit [$numfd]
2227
2228This function is I<EXPERIMENTAL> and subject to change.
2229
2230Try to increase the current file descriptor limit(s) to at least C<$numfd>
2231by changing the soft or hard file descriptor resource limit. If C<$numfd>
2232is missing, it will try to set a very high limit, although this is not
2233recommended when you know the actual minimum that you require.
2234
2235If the limit cannot be raised enough, the function makes a best-effort
2236attempt to increase the limit as much as possible, using various
2237tricks, while still failing. You can query the resulting limit using
2238C<IO::AIO::get_fdlimit>.
2239
2240If an error occurs, returns C<undef> and sets C<$!>, otherwise returns
2241true.
2242
2243=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
2244
2245Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
2246but is blocking (this makes most sense if you know the input data is
2247likely cached already and the output filehandle is set to non-blocking
2248operations).
2249
2250Returns the number of bytes copied, or C<-1> on error.
2251
2252=item IO::AIO::fadvise $fh, $offset, $len, $advice
2253
2254Simply calls the C<posix_fadvise> function (see its
2255manpage for details). The following advice constants are
2256available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
2257C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
2258C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
2259
2260On systems that do not implement C<posix_fadvise>, this function returns
2261ENOSYS, otherwise the return value of C<posix_fadvise>.
2262
2263=item IO::AIO::madvise $scalar, $offset, $len, $advice
2264
2265Simply calls the C<posix_madvise> function (see its
2266manpage for details). The following advice constants are
2267available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
2268C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>,
2269C<IO::AIO::MADV_DONTNEED>.
2270
2271If C<$offset> is negative, counts from the end. If C<$length> is negative,
2272the remaining length of the C<$scalar> is used. If possible, C<$length>
2273will be reduced to fit into the C<$scalar>.
2274
2275On systems that do not implement C<posix_madvise>, this function returns
2276ENOSYS, otherwise the return value of C<posix_madvise>.
2277
2278=item IO::AIO::mprotect $scalar, $offset, $len, $protect
2279
2280Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
2281$scalar (see its manpage for details). The following protect
2282constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
2283C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
2284
2285If C<$offset> is negative, counts from the end. If C<$length> is negative,
2286the remaining length of the C<$scalar> is used. If possible, C<$length>
2287will be reduced to fit into the C<$scalar>.
2288
2289On systems that do not implement C<mprotect>, this function returns
2290ENOSYS, otherwise the return value of C<mprotect>.
2291
2292=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
2293
2294Memory-maps a file (or anonymous memory range) and attaches it to the
2295given C<$scalar>, which will act like a string scalar. Returns true on
2296success, and false otherwise.
2297
2298The scalar must exist, but its contents do not matter - this means you
2299cannot use a nonexistant array or hash element. When in doubt, C<undef>
2300the scalar first.
2301
2302The only operations allowed on the mmapped scalar are C<substr>/C<vec>,
2303which don't change the string length, and most read-only operations such
2304as copying it or searching it with regexes and so on.
2305
2306Anything else is unsafe and will, at best, result in memory leaks.
2307
2308The memory map associated with the C<$scalar> is automatically removed
2309when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap>
2310or C<IO::AIO::munmap> functions are called on it.
2311
2312This calls the C<mmap>(2) function internally. See your system's manual
2313page for details on the C<$length>, C<$prot> and C<$flags> parameters.
2314
2315The C<$length> must be larger than zero and smaller than the actual
2316filesize.
2317
2318C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
2319C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
2320
2321C<$flags> can be a combination of
2322C<IO::AIO::MAP_SHARED> or
2323C<IO::AIO::MAP_PRIVATE>,
2324or a number of system-specific flags (when not available, the are C<0>):
2325C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
2326C<IO::AIO::MAP_LOCKED>,
2327C<IO::AIO::MAP_NORESERVE>,
2328C<IO::AIO::MAP_POPULATE>,
2329C<IO::AIO::MAP_NONBLOCK>,
2330C<IO::AIO::MAP_FIXED>,
2331C<IO::AIO::MAP_GROWSDOWN>,
2332C<IO::AIO::MAP_32BIT>,
2333C<IO::AIO::MAP_HUGETLB> or
2334C<IO::AIO::MAP_STACK>.
2335
2336If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
2337
2338C<$offset> is the offset from the start of the file - it generally must be
2339a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
2340
2341Example:
2342
2343 use Digest::MD5;
2344 use IO::AIO;
2345
2346 open my $fh, "<verybigfile"
2347 or die "$!";
2348
2349 IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
2350 or die "verybigfile: $!";
2351
2352 my $fast_md5 = md5 $data;
2353
2354=item IO::AIO::munmap $scalar
2355
2356Removes a previous mmap and undefines the C<$scalar>.
2357
2358=item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0]
2359
2360Calls the Linux-specific mremap(2) system call. The C<$scalar> must have
2361been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be
2362C<0> or C<IO::AIO::MREMAP_MAYMOVE>.
2363
2364Returns true if successful, and false otherwise. If the underlying mmapped
2365region has changed address, then the true value has the numerical value
2366C<1>, otherwise it has the numerical value C<0>:
2367
2368 my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
2369 or die "mremap: $!";
2370
2371 if ($success*1) {
2372 warn "scalar has chanegd address in memory\n";
2373 }
2374
2375C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently
2376implemented, but not supported and might go away in a future version.
2377
2378On systems where this call is not supported or is not emulated, this call
2379returns falls and sets C<$!> to C<ENOSYS>.
2380
2381=item IO::AIO::mlockall $flags
2382
2383Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>,
2384but is blocking.
2385
2386=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
2387
2388Calls the C<munlock> function, undoing the effects of a previous
2389C<aio_mlock> call (see its description for details).
2390
2391=item IO::AIO::munlockall
2392
2393Calls the C<munlockall> function.
2394
2395On systems that do not implement C<munlockall>, this function returns
2396ENOSYS, otherwise the return value of C<munlockall>.
2397
2398=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
2399
2400Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
2401C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
2402should be the file offset.
2403
2404C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2405silently corrupt the data in this case.
2406
2407The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
2408C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
2409C<IO::AIO::SPLICE_F_GIFT>.
2410
2411See the C<splice(2)> manpage for details.
2412
2413=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2414
2415Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
2416description for C<IO::AIO::splice> above for details.
2417
2418=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
2419
2420Attempts to query or change the pipe buffer size. Obviously works only
2421on pipes, and currently works only on GNU/Linux systems, and fails with
2422C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
2423size on other systems, drop me a note.
2424
2425=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
2426
2427This is a direct interface to the Linux L<pipe2(2)> system call. If
2428C<$flags> is missing or C<0>, then this should be the same as a call to
2429perl's built-in C<pipe> function and create a new pipe, and works on
2430systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
2431(..., 4096, O_BINARY)>.
2432
2433If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
2434the given flags (Linux 2.6.27, glibc 2.9).
2435
2436On success, the read and write file handles are returned.
2437
2438On error, nothing will be returned. If the pipe2 syscall is missing and
2439C<$flags> is non-zero, fails with C<ENOSYS>.
2440
2441Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
2442time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
2443C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
2444
2445Example: create a pipe race-free w.r.t. threads and fork:
2446
2447 my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
2448 or die "pipe2: $!\n";
2449
2450=item $fh = IO::AIO::memfd_create $pathname[, $flags]
2451
2452This is a direct interface to the Linux L<memfd_create(2)> system
2453call. The (unhelpful) default for C<$flags> is C<0>, but your default
2454should be C<IO::AIO::MFD_CLOEXEC>.
2455
2456On success, the new memfd filehandle is returned, otherwise returns
2457C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>.
2458
2459Please refer to L<memfd_create(2)> for more info on this call.
2460
2461The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>,
2462C<IO::AIO::MFD_ALLOW_SEALING> and C<IO::AIO::MFD_HUGETLB>.
2463
2464Example: create a new memfd.
2465
2466 my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC
2467 or die "m,emfd_create: $!\n";
2468=item $fh = IO::AIO::eventfd [$initval, [$flags]]
2469
2470This is a direct interface to the Linux L<eventfd(2)> system call. The
2471(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
2472
2473On success, the new eventfd filehandle is returned, otherwise returns
2474C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
2475
2476Please refer to L<eventfd(2)> for more info on this call.
2477
2478The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
2479C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
2480
2481Example: create a new eventfd filehandle:
2482
2483 $fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC
2484 or die "eventfd: $!\n";
2485
2486=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
2487
2488This is a direct interface to the Linux L<timerfd_create(2)> system
2489call. The (unhelpful) default for C<$flags> is C<0>, but your default
2490should be C<IO::AIO::TFD_CLOEXEC>.
2491
2492On success, the new timerfd filehandle is returned, otherwise returns
2493C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>.
2494
2495Please refer to L<timerfd_create(2)> for more info on this call.
2496
2497The following C<$clockid> values are
2498available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
2499C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15)
2500C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and
2501C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11).
2502
2503The following C<$flags> values are available (Linux
25042.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>.
2505
2506Example: create a new timerfd and set it to one-second repeated alarms,
2507then wait for two alarms:
2508
2509 my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC
2510 or die "timerfd_create: $!\n";
2511
2512 defined IO::AIO::timerfd_settime $fh, 0, 1, 1
2513 or die "timerfd_settime: $!\n";
2514
2515 for (1..2) {
2516 8 == sysread $fh, my $buf, 8
2517 or die "timerfd read failure\n";
2518
2519 printf "number of expirations (likely 1): %d\n",
2520 unpack "Q", $buf;
2521 }
2522
2523=item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
2524
2525This is a direct interface to the Linux L<timerfd_settime(2)> system
2526call. Please refer to its manpage for more info on this call.
2527
2528The new itimerspec is specified using two (possibly fractional) second
2529values, C<$new_interval> and C<$new_value>).
2530
2531On success, the current interval and value are returned (as per
2532C<timerfd_gettime>). On failure, the empty list is returned.
2533
2534The following C<$flags> values are
2535available: C<IO::AIO::TFD_TIMER_ABSTIME> and
2536C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>.
2537
2538See C<IO::AIO::timerfd_create> for a full example.
2539
2540=item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
2541
2542This is a direct interface to the Linux L<timerfd_gettime(2)> system
2543call. Please refer to its manpage for more info on this call.
2544
2545On success, returns the current values of interval and value for the given
2546timerfd (as potentially fractional second values). On failure, the empty
2547list is returned.
2548
2549=back
2550
1399=cut 2551=cut
1400 2552
1401min_parallel 8; 2553min_parallel 8;
1402 2554
1403END { flush } 2555END { flush }
1404 2556
14051; 25571;
1406 2558
2559=head1 EVENT LOOP INTEGRATION
2560
2561It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
2562automatically into many event loops:
2563
2564 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
2565 use AnyEvent::AIO;
2566
2567You can also integrate IO::AIO manually into many event loops, here are
2568some examples of how to do this:
2569
2570 # EV integration
2571 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
2572
2573 # Event integration
2574 Event->io (fd => IO::AIO::poll_fileno,
2575 poll => 'r',
2576 cb => \&IO::AIO::poll_cb);
2577
2578 # Glib/Gtk2 integration
2579 add_watch Glib::IO IO::AIO::poll_fileno,
2580 in => sub { IO::AIO::poll_cb; 1 };
2581
2582 # Tk integration
2583 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
2584 readable => \&IO::AIO::poll_cb);
2585
2586 # Danga::Socket integration
2587 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
2588 \&IO::AIO::poll_cb);
2589
1407=head2 FORK BEHAVIOUR 2590=head2 FORK BEHAVIOUR
1408 2591
1409This module should do "the right thing" when the process using it forks: 2592Usage of pthreads in a program changes the semantics of fork
2593considerably. Specifically, only async-safe functions can be called after
2594fork. Perl doesn't know about this, so in general, you cannot call fork
2595with defined behaviour in perl if pthreads are involved. IO::AIO uses
2596pthreads, so this applies, but many other extensions and (for inexplicable
2597reasons) perl itself often is linked against pthreads, so this limitation
2598applies to quite a lot of perls.
1410 2599
1411Before the fork, IO::AIO enters a quiescent state where no requests 2600This module no longer tries to fight your OS, or POSIX. That means IO::AIO
1412can be added in other threads and no results will be processed. After 2601only works in the process that loaded it. Forking is fully supported, but
1413the fork the parent simply leaves the quiescent state and continues 2602using IO::AIO in the child is not.
1414request/result processing, while the child frees the request/result queue
1415(so that the requests started before the fork will only be handled in the
1416parent). Threads will be started on demand until the limit set in the
1417parent process has been reached again.
1418 2603
1419In short: the parent will, after a short pause, continue as if fork had 2604You might get around by not I<using> IO::AIO before (or after)
1420not been called, while the child will act as if IO::AIO has not been used 2605forking. You could also try to call the L<IO::AIO::reinit> function in the
1421yet. 2606child:
2607
2608=over 4
2609
2610=item IO::AIO::reinit
2611
2612Abandons all current requests and I/O threads and simply reinitialises all
2613data structures. This is not an operation supported by any standards, but
2614happens to work on GNU/Linux and some newer BSD systems.
2615
2616The only reasonable use for this function is to call it after forking, if
2617C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in
2618the process will result in undefined behaviour. Calling it at any time
2619will also result in any undefined (by POSIX) behaviour.
2620
2621=back
2622
2623=head2 LINUX-SPECIFIC CALLS
2624
2625When a call is documented as "linux-specific" then this means it
2626originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the
2627availability and compatibility of such calls regardless of the platform
2628it is compiled on, so platforms such as FreeBSD which often implement
2629these calls will work. When in doubt, call them and see if they fail wth
2630C<ENOSYS>.
1422 2631
1423=head2 MEMORY USAGE 2632=head2 MEMORY USAGE
1424 2633
1425Per-request usage: 2634Per-request usage:
1426 2635
1439temporary buffers, and each thread requires a stack and other data 2648temporary buffers, and each thread requires a stack and other data
1440structures (usually around 16k-128k, depending on the OS). 2649structures (usually around 16k-128k, depending on the OS).
1441 2650
1442=head1 KNOWN BUGS 2651=head1 KNOWN BUGS
1443 2652
1444Known bugs will be fixed in the next release. 2653Known bugs will be fixed in the next release :)
2654
2655=head1 KNOWN ISSUES
2656
2657Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap>
2658or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as
2659non-created hash slots or other scalars I didn't think of. It's best to
2660avoid such and either use scalar variables or making sure that the scalar
2661exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied).
2662
2663I am not sure anything can be done about this, so this is considered a
2664known issue, rather than a bug.
1445 2665
1446=head1 SEE ALSO 2666=head1 SEE ALSO
1447 2667
1448L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a 2668L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1449more natural syntax. 2669more natural syntax.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines