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.121 by root, Wed Apr 16 16:45:18 2008 UTC vs.
Revision 1.232 by root, Mon Jul 30 16:46:30 2012 UTC

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, urxvt, pureperl...)
32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34
35 # EV integration
36 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
37
38 # Event integration
39 Event->io (fd => IO::AIO::poll_fileno,
40 poll => 'r',
41 cb => \&IO::AIO::poll_cb);
42
43 # Glib/Gtk2 integration
44 add_watch Glib::IO IO::AIO::poll_fileno,
45 in => sub { IO::AIO::poll_cb; 1 };
46
47 # Tk integration
48 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
49 readable => \&IO::AIO::poll_cb);
50
51 # Danga::Socket integration
52 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
53 \&IO::AIO::poll_cb);
54
55=head1 DESCRIPTION 31=head1 DESCRIPTION
56 32
57This module implements asynchronous I/O using whatever means your 33This module implements asynchronous I/O using whatever means your
58operating system supports. 34operating system supports. It is implemented as an interface to C<libeio>
35(L<http://software.schmorp.de/pkg/libeio.html>).
59 36
60Asynchronous means that operations that can normally block your program 37Asynchronous means that operations that can normally block your program
61(e.g. reading from disk) will be done asynchronously: the operation 38(e.g. reading from disk) will be done asynchronously: the operation
62will 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
63is extremely useful for programs that need to stay interactive even 40is extremely useful for programs that need to stay interactive even
67on 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
68concurrently. 45concurrently.
69 46
70While most of this works on all types of file descriptors (for 47While most of this works on all types of file descriptors (for
71example sockets), using these functions on file descriptors that 48example sockets), using these functions on file descriptors that
72support nonblocking operation (again, sockets, pipes etc.) is very 49support nonblocking operation (again, sockets, pipes etc.) is
73inefficient. 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>
74module): IO::AIO will naturally fit into such an event loop itself. 51module): IO::AIO will naturally fit into such an event loop itself.
75 52
76In this version, a number of threads are started that execute your 53In this version, a number of threads are started that execute your
77requests and signal their completion. You don't need thread support 54requests and signal their completion. You don't need thread support
78in 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
88yourself, always call C<poll_cb> from within the same thread, or never 65yourself, always call C<poll_cb> from within the same thread, or never
89call C<poll_cb> (or other C<aio_> functions) recursively. 66call C<poll_cb> (or other C<aio_> functions) recursively.
90 67
91=head2 EXAMPLE 68=head2 EXAMPLE
92 69
93This is a simple example that uses the Event module and loads 70This is a simple example that uses the EV module and loads
94F</etc/passwd> asynchronously: 71F</etc/passwd> asynchronously:
95 72
96 use Fcntl; 73 use Fcntl;
97 use Event; 74 use EV;
98 use IO::AIO; 75 use IO::AIO;
99 76
100 # register the IO::AIO callback with Event 77 # register the IO::AIO callback with EV
101 Event->io (fd => IO::AIO::poll_fileno, 78 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
102 poll => 'r',
103 cb => \&IO::AIO::poll_cb);
104 79
105 # queue the request to open /etc/passwd 80 # queue the request to open /etc/passwd
106 aio_open "/etc/passwd", O_RDONLY, 0, sub { 81 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
107 my $fh = shift 82 my $fh = shift
108 or die "error while opening: $!"; 83 or die "error while opening: $!";
109 84
110 # stat'ing filehandles is generally non-blocking 85 # stat'ing filehandles is generally non-blocking
111 my $size = -s $fh; 86 my $size = -s $fh;
120 95
121 # file contents now in $contents 96 # file contents now in $contents
122 print $contents; 97 print $contents;
123 98
124 # exit event loop and program 99 # exit event loop and program
125 Event::unloop; 100 EV::unloop;
126 }; 101 };
127 }; 102 };
128 103
129 # possibly queue up other requests, or open GUI windows, 104 # possibly queue up other requests, or open GUI windows,
130 # check for sockets etc. etc. 105 # check for sockets etc. etc.
131 106
132 # process events as long as there are some: 107 # process events as long as there are some:
133 Event::loop; 108 EV::loop;
134 109
135=head1 REQUEST ANATOMY AND LIFETIME 110=head1 REQUEST ANATOMY AND LIFETIME
136 111
137Every C<aio_*> function creates a request. which is a C data structure not 112Every C<aio_*> function creates a request. which is a C data structure not
138directly visible to Perl. 113directly visible to Perl.
188 163
189package IO::AIO; 164package IO::AIO;
190 165
191use Carp (); 166use Carp ();
192 167
193no warnings; 168use common::sense;
194use strict 'vars';
195 169
196use base 'Exporter'; 170use base 'Exporter';
197 171
198BEGIN { 172BEGIN {
199 our $VERSION = '2.61'; 173 our $VERSION = '4.15';
200 174
201 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close 175 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
202 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir 176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
203 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync 177 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync
178 aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate
204 aio_fdatasync aio_pathsync aio_readahead 179 aio_pathsync aio_readahead aio_fiemap
205 aio_rename aio_link aio_move aio_copy aio_group 180 aio_rename aio_link aio_move aio_copy aio_group
206 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 181 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
207 aio_chmod aio_utime aio_truncate); 182 aio_chmod aio_utime aio_truncate
183 aio_msync aio_mtouch aio_mlock aio_mlockall
184 aio_statvfs
185 aio_wd);
208 186
209 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 187 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
210 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 188 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
211 min_parallel max_parallel max_idle 189 min_parallel max_parallel max_idle idle_timeout
212 nreqs nready npending nthreads 190 nreqs nready npending nthreads
213 max_poll_time max_poll_reqs); 191 max_poll_time max_poll_reqs
192 sendfile fadvise madvise
193 mmap munmap munlock munlockall);
194
195 push @AIO_REQ, qw(aio_busy); # not exported
214 196
215 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 197 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
216 198
217 require XSLoader; 199 require XSLoader;
218 XSLoader::load ("IO::AIO", $VERSION); 200 XSLoader::load ("IO::AIO", $VERSION);
219} 201}
220 202
221=head1 FUNCTIONS 203=head1 FUNCTIONS
222 204
223=head2 AIO REQUEST FUNCTIONS 205=head2 QUICK OVERVIEW
206
207This section simply lists the prototypes most of the functions for
208quick reference. See the following sections for function-by-function
209documentation.
210
211 aio_wd $pathname, $callback->($wd)
212 aio_open $pathname, $flags, $mode, $callback->($fh)
213 aio_close $fh, $callback->($status)
214 aio_seek $fh,$offset,$whence, $callback->($offs)
215 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
216 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
217 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
218 aio_readahead $fh,$offset,$length, $callback->($retval)
219 aio_stat $fh_or_path, $callback->($status)
220 aio_lstat $fh, $callback->($status)
221 aio_statvfs $fh_or_path, $callback->($statvfs)
222 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
223 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
224 aio_chmod $fh_or_path, $mode, $callback->($status)
225 aio_truncate $fh_or_path, $offset, $callback->($status)
226 aio_allocate $fh, $mode, $offset, $len, $callback->($status)
227 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
228 aio_unlink $pathname, $callback->($status)
229 aio_mknod $pathname, $mode, $dev, $callback->($status)
230 aio_link $srcpath, $dstpath, $callback->($status)
231 aio_symlink $srcpath, $dstpath, $callback->($status)
232 aio_readlink $pathname, $callback->($link)
233 aio_realpath $pathname, $callback->($link)
234 aio_rename $srcpath, $dstpath, $callback->($status)
235 aio_mkdir $pathname, $mode, $callback->($status)
236 aio_rmdir $pathname, $callback->($status)
237 aio_readdir $pathname, $callback->($entries)
238 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
239 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
240 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
241 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
242 aio_load $pathname, $data, $callback->($status)
243 aio_copy $srcpath, $dstpath, $callback->($status)
244 aio_move $srcpath, $dstpath, $callback->($status)
245 aio_rmtree $pathname, $callback->($status)
246 aio_sync $callback->($status)
247 aio_syncfs $fh, $callback->($status)
248 aio_fsync $fh, $callback->($status)
249 aio_fdatasync $fh, $callback->($status)
250 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
251 aio_pathsync $pathname, $callback->($status)
252 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
253 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
254 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
255 aio_mlockall $flags, $callback->($status)
256 aio_group $callback->(...)
257 aio_nop $callback->()
258
259 $prev_pri = aioreq_pri [$pri]
260 aioreq_nice $pri_adjust
261
262 IO::AIO::poll_wait
263 IO::AIO::poll_cb
264 IO::AIO::poll
265 IO::AIO::flush
266 IO::AIO::max_poll_reqs $nreqs
267 IO::AIO::max_poll_time $seconds
268 IO::AIO::min_parallel $nthreads
269 IO::AIO::max_parallel $nthreads
270 IO::AIO::max_idle $nthreads
271 IO::AIO::idle_timeout $seconds
272 IO::AIO::max_outstanding $maxreqs
273 IO::AIO::nreqs
274 IO::AIO::nready
275 IO::AIO::npending
276
277 IO::AIO::sendfile $ofh, $ifh, $offset, $count
278 IO::AIO::fadvise $fh, $offset, $len, $advice
279 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
280 IO::AIO::munmap $scalar
281 IO::AIO::madvise $scalar, $offset, $length, $advice
282 IO::AIO::mprotect $scalar, $offset, $length, $protect
283 IO::AIO::munlock $scalar, $offset = 0, $length = undef
284 IO::AIO::munlockall
285
286=head2 API NOTES
224 287
225All the C<aio_*> calls are more or less thin wrappers around the syscall 288All the C<aio_*> calls are more or less thin wrappers around the syscall
226with the same name (sans C<aio_>). The arguments are similar or identical, 289with the same name (sans C<aio_>). The arguments are similar or identical,
227and they all accept an additional (and optional) C<$callback> argument 290and they all accept an additional (and optional) C<$callback> argument
228which must be a code reference. This code reference will get called with 291which must be a code reference. This code reference will be called after
229the syscall return code (e.g. most syscalls return C<-1> on error, unlike 292the syscall has been executed in an asynchronous fashion. The results
230perl, which usually delivers "false") as it's sole argument when the given 293of the request will be passed as arguments to the callback (and, if an
231syscall has been executed asynchronously. 294error occured, in C<$!>) - for most requests the syscall return code (e.g.
295most syscalls return C<-1> on error, unlike perl, which usually delivers
296"false").
297
298Some requests (such as C<aio_readdir>) pass the actual results and
299communicate failures by passing C<undef>.
232 300
233All functions expecting a filehandle keep a copy of the filehandle 301All functions expecting a filehandle keep a copy of the filehandle
234internally until the request has finished. 302internally until the request has finished.
235 303
236All functions return request objects of type L<IO::AIO::REQ> that allow 304All functions return request objects of type L<IO::AIO::REQ> that allow
237further manipulation of those requests while they are in-flight. 305further manipulation of those requests while they are in-flight.
238 306
239The pathnames you pass to these routines I<must> be absolute and 307The pathnames you pass to these routines I<should> be absolute. The
240encoded as octets. The reason for the former is that at the time the 308reason for this is that at the time the request is being executed, the
241request is being executed, the current working directory could have 309current working directory could have changed. Alternatively, you can
242changed. Alternatively, you can make sure that you never change the 310make sure that you never change the current working directory anywhere
243current working directory anywhere in the program and then use relative 311in the program and then use relative paths. You can also take advantage
244paths. 312of IO::AIOs working directory abstraction, that lets you specify paths
313relative to some previously-opened "working directory object" - see the
314description of the C<IO::AIO::WD> class later in this document.
245 315
246To encode pathnames as octets, either make sure you either: a) always pass 316To encode pathnames as octets, either make sure you either: a) always pass
247in filenames you got from outside (command line, readdir etc.) without 317in filenames you got from outside (command line, readdir etc.) without
248tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode 318tinkering, b) are in your native filesystem encoding, c) use the Encode
249your pathnames to the locale (or other) encoding in effect in the user 319module and encode your pathnames to the locale (or other) encoding in
250environment, d) use Glib::filename_from_unicode on unicode filenames or e) 320effect in the user environment, d) use Glib::filename_from_unicode on
251use something else to ensure your scalar has the correct contents. 321unicode filenames or e) use something else to ensure your scalar has the
322correct contents.
252 323
253This works, btw. independent of the internal UTF-8 bit, which IO::AIO 324This works, btw. independent of the internal UTF-8 bit, which IO::AIO
254handles correctly wether it is set or not. 325handles correctly whether it is set or not.
326
327=head2 AIO REQUEST FUNCTIONS
255 328
256=over 4 329=over 4
257 330
258=item $prev_pri = aioreq_pri [$pri] 331=item $prev_pri = aioreq_pri [$pri]
259 332
306by the umask in effect then the request is being executed, so better never 379by the umask in effect then the request is being executed, so better never
307change the umask. 380change the umask.
308 381
309Example: 382Example:
310 383
311 aio_open "/etc/passwd", O_RDONLY, 0, sub { 384 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
312 if ($_[0]) { 385 if ($_[0]) {
313 print "open successful, fh is $_[0]\n"; 386 print "open successful, fh is $_[0]\n";
314 ... 387 ...
315 } else { 388 } else {
316 die "open failed: $!\n"; 389 die "open failed: $!\n";
317 } 390 }
318 }; 391 };
319 392
393In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>,
394C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the
395following POSIX and non-POSIX constants are available (missing ones on
396your system are, as usual, C<0>):
397
398C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
399C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
400C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>.
401
320 402
321=item aio_close $fh, $callback->($status) 403=item aio_close $fh, $callback->($status)
322 404
323Asynchronously close a file and call the callback with the result 405Asynchronously close a file and call the callback with the result
324code. 406code.
333Or in other words: the file descriptor will be closed, but it will not be 415Or in other words: the file descriptor will be closed, but it will not be
334free for reuse until the perl filehandle is closed. 416free for reuse until the perl filehandle is closed.
335 417
336=cut 418=cut
337 419
420=item aio_seek $fh, $offset, $whence, $callback->($offs)
421
422Seeks the filehandle to the new C<$offset>, similarly to perl's
423C<sysseek>. The C<$whence> can use the traditional values (C<0> for
424C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
425C<IO::AIO::SEEK_END>).
426
427The resulting absolute offset will be passed to the callback, or C<-1> in
428case of an error.
429
430In theory, the C<$whence> constants could be different than the
431corresponding values from L<Fcntl>, but perl guarantees they are the same,
432so don't panic.
433
434As a GNU/Linux (and maybe Solaris) extension, also the constants
435C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
436could be found. No guarantees about suitability for use in C<aio_seek> or
437Perl's C<sysseek> can be made though, although I would naively assume they
438"just work".
439
338=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 440=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
339 441
340=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 442=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
341 443
342Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> 444Reads or writes C<$length> bytes from or to the specified C<$fh> and
343into the scalar given by C<$data> and offset C<$dataoffset> and calls the 445C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
344callback without the actual number of bytes read (or -1 on error, just 446and calls the callback without the actual number of bytes read (or -1 on
345like the syscall). 447error, just like the syscall).
448
449C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
450offset plus the actual number of bytes read.
346 451
347If C<$offset> is undefined, then the current file descriptor offset will 452If C<$offset> is undefined, then the current file descriptor offset will
348be used (and updated), otherwise the file descriptor offset will not be 453be used (and updated), otherwise the file descriptor offset will not be
349changed by these calls. 454changed by these calls.
350 455
351If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. 456If C<$length> is undefined in C<aio_write>, use the remaining length of
457C<$data>.
352 458
353If C<$dataoffset> is less than zero, it will be counted from the end of 459If C<$dataoffset> is less than zero, it will be counted from the end of
354C<$data>. 460C<$data>.
355 461
356The C<$data> scalar I<MUST NOT> be modified in any way while the request 462The C<$data> scalar I<MUST NOT> be modified in any way while the request
370 476
371Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 477Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
372reading at byte offset C<$in_offset>, and starts writing at the current 478reading at byte offset C<$in_offset>, and starts writing at the current
373file offset of C<$out_fh>. Because of that, it is not safe to issue more 479file offset of C<$out_fh>. Because of that, it is not safe to issue more
374than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each 480than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
375other. 481other. The same C<$in_fh> works fine though, as this function does not
482move or use the file offset of C<$in_fh>.
376 483
484Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than
485are written, and there is no way to find out how many more bytes have been
486read from C<aio_sendfile> alone, as C<aio_sendfile> only provides the
487number of bytes written to C<$out_fh>. Only if the result value equals
488C<$length> one can assume that C<$length> bytes have been read.
489
490Unlike with other C<aio_> functions, it makes a lot of sense to use
491C<aio_sendfile> on non-blocking sockets, as long as one end (typically
492the C<$in_fh>) is a file - the file I/O will then be asynchronous, while
493the socket I/O will be non-blocking. Note, however, that you can run
494into a trap where C<aio_sendfile> reads some data with readahead, then
495fails to write all data, and when the socket is ready the next time, the
496data in the cache is already lost, forcing C<aio_sendfile> to again hit
497the disk. Explicit C<aio_read> + C<aio_write> let's you better control
498resource usage.
499
377This call tries to make use of a native C<sendfile> syscall to provide 500This call tries to make use of a native C<sendfile>-like syscall to
378zero-copy operation. For this to work, C<$out_fh> should refer to a 501provide zero-copy operation. For this to work, C<$out_fh> should refer to
379socket, and C<$in_fh> should refer to mmap'able file. 502a socket, and C<$in_fh> should refer to an mmap'able file.
380 503
381If the native sendfile call fails or is not implemented, it will be 504If a native sendfile cannot be found or it fails with C<ENOSYS>,
382emulated, so you can call C<aio_sendfile> on any type of filehandle 505C<EINVAL>, C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or
506C<ENOTSOCK>, it will be emulated, so you can call C<aio_sendfile> on any
383regardless of the limitations of the operating system. 507type of filehandle regardless of the limitations of the operating system.
384 508
385Please note, however, that C<aio_sendfile> can read more bytes from 509As native sendfile syscalls (as practically any non-POSIX interface hacked
386C<$in_fh> than are written, and there is no way to find out how many 510together in a hurry to improve benchmark numbers) tend to be rather buggy
387bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 511on many systems, this implementation tries to work around some known bugs
388provides the number of bytes written to C<$out_fh>. Only if the result 512in Linux and FreeBSD kernels (probably others, too), but that might fail,
389value equals C<$length> one can assume that C<$length> bytes have been 513so you really really should check the return value of C<aio_sendfile> -
390read. 514fewre bytes than expected might have been transferred.
391 515
392 516
393=item aio_readahead $fh,$offset,$length, $callback->($retval) 517=item aio_readahead $fh,$offset,$length, $callback->($retval)
394 518
395C<aio_readahead> populates the page cache with data from a file so that 519C<aio_readahead> populates the page cache with data from a file so that
418 542
419Currently, the stats are always 64-bit-stats, i.e. instead of returning an 543Currently, the stats are always 64-bit-stats, i.e. instead of returning an
420error when stat'ing a large file, the results will be silently truncated 544error when stat'ing a large file, the results will be silently truncated
421unless perl itself is compiled with large file support. 545unless perl itself is compiled with large file support.
422 546
547To help interpret the mode and dev/rdev stat values, IO::AIO offers the
548following constants and functions (if not implemented, the constants will
549be C<0> and the functions will either C<croak> or fall back on traditional
550behaviour).
551
552C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
553C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
554C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
555
423Example: Print the length of F</etc/passwd>: 556Example: Print the length of F</etc/passwd>:
424 557
425 aio_stat "/etc/passwd", sub { 558 aio_stat "/etc/passwd", sub {
426 $_[0] and die "stat failed: $!"; 559 $_[0] and die "stat failed: $!";
427 print "size is ", -s _, "\n"; 560 print "size is ", -s _, "\n";
428 }; 561 };
429 562
430 563
564=item aio_statvfs $fh_or_path, $callback->($statvfs)
565
566Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
567whether a file handle or path was passed.
568
569On success, the callback is passed a hash reference with the following
570members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
571C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
572is passed.
573
574The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
575C<ST_NOSUID>.
576
577The following non-POSIX IO::AIO::ST_* flag masks are defined to
578their correct value when available, or to C<0> on systems that do
579not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
580C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
581C<ST_NODIRATIME> and C<ST_RELATIME>.
582
583Example: stat C</wd> and dump out the data if successful.
584
585 aio_statvfs "/wd", sub {
586 my $f = $_[0]
587 or die "statvfs: $!";
588
589 use Data::Dumper;
590 say Dumper $f;
591 };
592
593 # result:
594 {
595 bsize => 1024,
596 bfree => 4333064312,
597 blocks => 10253828096,
598 files => 2050765568,
599 flag => 4096,
600 favail => 2042092649,
601 bavail => 4333064312,
602 ffree => 2042092649,
603 namemax => 255,
604 frsize => 1024,
605 fsid => 1810
606 }
607
608
431=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 609=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
432 610
433Works like perl's C<utime> function (including the special case of $atime 611Works like perl's C<utime> function (including the special case of $atime
434and $mtime being undef). Fractional times are supported if the underlying 612and $mtime being undef). Fractional times are supported if the underlying
435syscalls support them. 613syscalls support them.
462=item aio_truncate $fh_or_path, $offset, $callback->($status) 640=item aio_truncate $fh_or_path, $offset, $callback->($status)
463 641
464Works like truncate(2) or ftruncate(2). 642Works like truncate(2) or ftruncate(2).
465 643
466 644
645=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
646
647Allocates or freed disk space according to the C<$mode> argument. See the
648linux C<fallocate> docuemntation for details.
649
650C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE>
651to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE |
652IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range.
653
654The file system block size used by C<fallocate> is presumably the
655C<f_bsize> returned by C<statvfs>.
656
657If C<fallocate> isn't available or cannot be emulated (currently no
658emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
659
660
467=item aio_chmod $fh_or_path, $mode, $callback->($status) 661=item aio_chmod $fh_or_path, $mode, $callback->($status)
468 662
469Works like perl's C<chmod> function. 663Works like perl's C<chmod> function.
470 664
471 665
473 667
474Asynchronously unlink (delete) a file and call the callback with the 668Asynchronously unlink (delete) a file and call the callback with the
475result code. 669result code.
476 670
477 671
478=item aio_mknod $path, $mode, $dev, $callback->($status) 672=item aio_mknod $pathname, $mode, $dev, $callback->($status)
479 673
480[EXPERIMENTAL] 674[EXPERIMENTAL]
481 675
482Asynchronously create a device node (or fifo). See mknod(2). 676Asynchronously create a device node (or fifo). See mknod(2).
483 677
484The only (POSIX-) portable way of calling this function is: 678The only (POSIX-) portable way of calling this function is:
485 679
486 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 680 aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
487 681
682See C<aio_stat> for info about some potentially helpful extra constants
683and functions.
488 684
489=item aio_link $srcpath, $dstpath, $callback->($status) 685=item aio_link $srcpath, $dstpath, $callback->($status)
490 686
491Asynchronously create a new link to the existing object at C<$srcpath> at 687Asynchronously create a new link to the existing object at C<$srcpath> at
492the path C<$dstpath> and call the callback with the result code. 688the path C<$dstpath> and call the callback with the result code.
496 692
497Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 693Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
498the path C<$dstpath> and call the callback with the result code. 694the path C<$dstpath> and call the callback with the result code.
499 695
500 696
501=item aio_readlink $path, $callback->($link) 697=item aio_readlink $pathname, $callback->($link)
502 698
503Asynchronously read the symlink specified by C<$path> and pass it to 699Asynchronously read the symlink specified by C<$path> and pass it to
504the callback. If an error occurs, nothing or undef gets passed to the 700the callback. If an error occurs, nothing or undef gets passed to the
505callback. 701callback.
506 702
507 703
704=item aio_realpath $pathname, $callback->($path)
705
706Asynchronously make the path absolute and resolve any symlinks in
707C<$path>. The resulting path only consists of directories (Same as
708L<Cwd::realpath>).
709
710This request can be used to get the absolute path of the current working
711directory by passing it a path of F<.> (a single dot).
712
713
508=item aio_rename $srcpath, $dstpath, $callback->($status) 714=item aio_rename $srcpath, $dstpath, $callback->($status)
509 715
510Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 716Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
511rename(2) and call the callback with the result code. 717rename(2) and call the callback with the result code.
512 718
528 734
529Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 735Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
530directory (i.e. opendir + readdir + closedir). The entries will not be 736directory (i.e. opendir + readdir + closedir). The entries will not be
531sorted, and will B<NOT> include the C<.> and C<..> entries. 737sorted, and will B<NOT> include the C<.> and C<..> entries.
532 738
533The callback a single argument which is either C<undef> or an array-ref 739The callback is passed a single argument which is either C<undef> or an
534with the filenames. 740array-ref with the filenames.
535 741
536 742
743=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
744
745Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to
746tune behaviour and output format. In case of an error, C<$entries> will be
747C<undef>.
748
749The flags are a combination of the following constants, ORed together (the
750flags will also be passed to the callback, possibly modified):
751
752=over 4
753
754=item IO::AIO::READDIR_DENTS
755
756When this flag is off, then the callback gets an arrayref consisting of
757names only (as with C<aio_readdir>), otherwise it gets an arrayref with
758C<[$name, $type, $inode]> arrayrefs, each describing a single directory
759entry in more detail.
760
761C<$name> is the name of the entry.
762
763C<$type> is one of the C<IO::AIO::DT_xxx> constants:
764
765C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
766C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
767C<IO::AIO::DT_WHT>.
768
769C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to
770know, you have to run stat yourself. Also, for speed reasons, the C<$type>
771scalars are read-only: you can not modify them.
772
773C<$inode> is the inode number (which might not be exact on systems with 64
774bit inode numbers and 32 bit perls). This field has unspecified content on
775systems that do not deliver the inode information.
776
777=item IO::AIO::READDIR_DIRS_FIRST
778
779When this flag is set, then the names will be returned in an order where
780likely directories come first, in optimal stat order. This is useful when
781you need to quickly find directories, or you want to find all directories
782while avoiding to stat() each entry.
783
784If the system returns type information in readdir, then this is used
785to find directories directly. Otherwise, likely directories are names
786beginning with ".", or otherwise names with no dots, of which names with
787short names are tried first.
788
789=item IO::AIO::READDIR_STAT_ORDER
790
791When this flag is set, then the names will be returned in an order
792suitable for stat()'ing each one. That is, when you plan to stat()
793all files in the given directory, then the returned order will likely
794be fastest.
795
796If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then
797the likely dirs come first, resulting in a less optimal stat order.
798
799=item IO::AIO::READDIR_FOUND_UNKNOWN
800
801This flag should not be set when calling C<aio_readdirx>. Instead, it
802is being set by C<aio_readdirx>, when any of the C<$type>'s found were
803C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all
804C<$type>'s are known, which can be used to speed up some algorithms.
805
806=back
807
808
537=item aio_load $path, $data, $callback->($status) 809=item aio_load $pathname, $data, $callback->($status)
538 810
539This is a composite request that tries to fully load the given file into 811This is a composite request that tries to fully load the given file into
540memory. Status is the same as with aio_read. 812memory. Status is the same as with aio_read.
541 813
542=cut 814=cut
543 815
544sub aio_load($$;$) { 816sub aio_load($$;$) {
545 aio_block {
546 my ($path, undef, $cb) = @_; 817 my ($path, undef, $cb) = @_;
547 my $data = \$_[1]; 818 my $data = \$_[1];
548 819
549 my $pri = aioreq_pri; 820 my $pri = aioreq_pri;
550 my $grp = aio_group $cb; 821 my $grp = aio_group $cb;
822
823 aioreq_pri $pri;
824 add $grp aio_open $path, O_RDONLY, 0, sub {
825 my $fh = shift
826 or return $grp->result (-1);
551 827
552 aioreq_pri $pri; 828 aioreq_pri $pri;
553 add $grp aio_open $path, O_RDONLY, 0, sub {
554 my $fh = shift
555 or return $grp->result (-1);
556
557 aioreq_pri $pri;
558 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 829 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
559 $grp->result ($_[0]); 830 $grp->result ($_[0]);
560 };
561 }; 831 };
562
563 $grp
564 } 832 };
833
834 $grp
565} 835}
566 836
567=item aio_copy $srcpath, $dstpath, $callback->($status) 837=item aio_copy $srcpath, $dstpath, $callback->($status)
568 838
569Try to copy the I<file> (directories not supported as either source or 839Try to copy the I<file> (directories not supported as either source or
570destination) from C<$srcpath> to C<$dstpath> and call the callback with 840destination) from C<$srcpath> to C<$dstpath> and call the callback with
571the C<0> (error) or C<-1> ok. 841a status of C<0> (ok) or C<-1> (error, see C<$!>).
572 842
573This is a composite request that it creates the destination file with 843This is a composite request that creates the destination file with
574mode 0200 and copies the contents of the source file into it using 844mode 0200 and copies the contents of the source file into it using
575C<aio_sendfile>, followed by restoring atime, mtime, access mode and 845C<aio_sendfile>, followed by restoring atime, mtime, access mode and
576uid/gid, in that order. 846uid/gid, in that order.
577 847
578If an error occurs, the partial destination file will be unlinked, if 848If an error occurs, the partial destination file will be unlinked, if
580errors are being ignored. 850errors are being ignored.
581 851
582=cut 852=cut
583 853
584sub aio_copy($$;$) { 854sub aio_copy($$;$) {
585 aio_block {
586 my ($src, $dst, $cb) = @_; 855 my ($src, $dst, $cb) = @_;
587 856
588 my $pri = aioreq_pri; 857 my $pri = aioreq_pri;
589 my $grp = aio_group $cb; 858 my $grp = aio_group $cb;
590 859
591 aioreq_pri $pri; 860 aioreq_pri $pri;
592 add $grp aio_open $src, O_RDONLY, 0, sub { 861 add $grp aio_open $src, O_RDONLY, 0, sub {
593 if (my $src_fh = $_[0]) { 862 if (my $src_fh = $_[0]) {
594 my @stat = stat $src_fh; 863 my @stat = stat $src_fh; # hmm, might block over nfs?
595 864
596 aioreq_pri $pri; 865 aioreq_pri $pri;
597 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 866 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
598 if (my $dst_fh = $_[0]) { 867 if (my $dst_fh = $_[0]) {
599 aioreq_pri $pri; 868 aioreq_pri $pri;
600 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 869 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
601 if ($_[0] == $stat[7]) { 870 if ($_[0] == $stat[7]) {
602 $grp->result (0); 871 $grp->result (0);
603 close $src_fh; 872 close $src_fh;
604 873
605 # those should not normally block. should. should. 874 my $ch = sub {
606 utime $stat[8], $stat[9], $dst;
607 chmod $stat[2] & 07777, $dst_fh;
608 chown $stat[4], $stat[5], $dst_fh;
609
610 aioreq_pri $pri; 875 aioreq_pri $pri;
876 add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
877 aioreq_pri $pri;
878 add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
879 aioreq_pri $pri;
611 add $grp aio_close $dst_fh; 880 add $grp aio_close $dst_fh;
612 } else { 881 }
613 $grp->result (-1);
614 close $src_fh;
615 close $dst_fh;
616
617 aioreq $pri; 882 };
618 add $grp aio_unlink $dst;
619 } 883 };
884
885 aioreq_pri $pri;
886 add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
887 if ($_[0] < 0 && $! == ENOSYS) {
888 aioreq_pri $pri;
889 add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
890 } else {
891 $ch->();
892 }
893 };
894 } else {
895 $grp->result (-1);
896 close $src_fh;
897 close $dst_fh;
898
899 aioreq $pri;
900 add $grp aio_unlink $dst;
620 }; 901 }
621 } else {
622 $grp->result (-1);
623 } 902 };
903 } else {
904 $grp->result (-1);
624 }, 905 }
625
626 } else {
627 $grp->result (-1);
628 } 906 },
907
908 } else {
909 $grp->result (-1);
629 }; 910 }
630
631 $grp
632 } 911 };
912
913 $grp
633} 914}
634 915
635=item aio_move $srcpath, $dstpath, $callback->($status) 916=item aio_move $srcpath, $dstpath, $callback->($status)
636 917
637Try to move the I<file> (directories not supported as either source or 918Try to move the I<file> (directories not supported as either source or
638destination) from C<$srcpath> to C<$dstpath> and call the callback with 919destination) from C<$srcpath> to C<$dstpath> and call the callback with
639the C<0> (error) or C<-1> ok. 920a status of C<0> (ok) or C<-1> (error, see C<$!>).
640 921
641This is a composite request that tries to rename(2) the file first. If 922This is a composite request that tries to rename(2) the file first; if
642rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if 923rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
643that is successful, unlinking the C<$srcpath>. 924that is successful, unlinks the C<$srcpath>.
644 925
645=cut 926=cut
646 927
647sub aio_move($$;$) { 928sub aio_move($$;$) {
648 aio_block {
649 my ($src, $dst, $cb) = @_; 929 my ($src, $dst, $cb) = @_;
650 930
651 my $pri = aioreq_pri; 931 my $pri = aioreq_pri;
652 my $grp = aio_group $cb; 932 my $grp = aio_group $cb;
653 933
654 aioreq_pri $pri; 934 aioreq_pri $pri;
655 add $grp aio_rename $src, $dst, sub { 935 add $grp aio_rename $src, $dst, sub {
656 if ($_[0] && $! == EXDEV) { 936 if ($_[0] && $! == EXDEV) {
657 aioreq_pri $pri; 937 aioreq_pri $pri;
658 add $grp aio_copy $src, $dst, sub { 938 add $grp aio_copy $src, $dst, sub {
659 $grp->result ($_[0]);
660
661 if (!$_[0]) {
662 aioreq_pri $pri;
663 add $grp aio_unlink $src;
664 }
665 };
666 } else {
667 $grp->result ($_[0]); 939 $grp->result ($_[0]);
940
941 unless ($_[0]) {
942 aioreq_pri $pri;
943 add $grp aio_unlink $src;
944 }
668 } 945 };
946 } else {
947 $grp->result ($_[0]);
669 }; 948 }
670
671 $grp
672 } 949 };
950
951 $grp
673} 952}
674 953
675=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 954=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
676 955
677Scans a directory (similar to C<aio_readdir>) but additionally tries to 956Scans a directory (similar to C<aio_readdir>) but additionally tries to
678efficiently separate the entries of directory C<$path> into two sets of 957efficiently separate the entries of directory C<$path> into two sets of
679names, directories you can recurse into (directories), and ones you cannot 958names, directories you can recurse into (directories), and ones you cannot
680recurse into (everything else, including symlinks to directories). 959recurse into (everything else, including symlinks to directories).
697 976
698Implementation notes. 977Implementation notes.
699 978
700The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. 979The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
701 980
981If readdir returns file type information, then this is used directly to
982find directories.
983
702After reading the directory, the modification time, size etc. of the 984Otherwise, after reading the directory, the modification time, size etc.
703directory before and after the readdir is checked, and if they match (and 985of the directory before and after the readdir is checked, and if they
704isn't the current time), the link count will be used to decide how many 986match (and isn't the current time), the link count will be used to decide
705entries are directories (if >= 2). Otherwise, no knowledge of the number 987how many entries are directories (if >= 2). Otherwise, no knowledge of the
706of subdirectories will be assumed. 988number of subdirectories will be assumed.
707 989
708Then entries will be sorted into likely directories (everything without 990Then entries will be sorted into likely directories a non-initial dot
709a non-initial dot currently) and likely non-directories (everything 991currently) and likely non-directories (see C<aio_readdirx>). Then every
710else). Then every entry plus an appended C</.> will be C<stat>'ed, 992entry plus an appended C</.> will be C<stat>'ed, likely directories first,
711likely directories first. If that succeeds, it assumes that the entry 993in order of their inode numbers. If that succeeds, it assumes that the
712is a directory or a symlink to directory (which will be checked 994entry is a directory or a symlink to directory (which will be checked
713seperately). This is often faster than stat'ing the entry itself because 995separately). This is often faster than stat'ing the entry itself because
714filesystems might detect the type of the entry without reading the inode 996filesystems might detect the type of the entry without reading the inode
715data (e.g. ext2fs filetype feature). 997data (e.g. ext2fs filetype feature), even on systems that cannot return
998the filetype information on readdir.
716 999
717If the known number of directories (link count - 2) has been reached, the 1000If the known number of directories (link count - 2) has been reached, the
718rest of the entries is assumed to be non-directories. 1001rest of the entries is assumed to be non-directories.
719 1002
720This only works with certainty on POSIX (= UNIX) filesystems, which 1003This only works with certainty on POSIX (= UNIX) filesystems, which
725directory counting heuristic. 1008directory counting heuristic.
726 1009
727=cut 1010=cut
728 1011
729sub aio_scandir($$;$) { 1012sub aio_scandir($$;$) {
730 aio_block {
731 my ($path, $maxreq, $cb) = @_; 1013 my ($path, $maxreq, $cb) = @_;
732 1014
733 my $pri = aioreq_pri; 1015 my $pri = aioreq_pri;
734 1016
735 my $grp = aio_group $cb; 1017 my $grp = aio_group $cb;
736 1018
737 $maxreq = 4 if $maxreq <= 0; 1019 $maxreq = 4 if $maxreq <= 0;
1020
1021 # get a wd object
1022 aioreq_pri $pri;
1023 add $grp aio_wd $path, sub {
1024 $_[0]
1025 or return $grp->result ();
1026
1027 my $wd = [shift, "."];
738 1028
739 # stat once 1029 # stat once
740 aioreq_pri $pri; 1030 aioreq_pri $pri;
741 add $grp aio_stat $path, sub { 1031 add $grp aio_stat $wd, sub {
742 return $grp->result () if $_[0]; 1032 return $grp->result () if $_[0];
743 my $now = time; 1033 my $now = time;
744 my $hash1 = join ":", (stat _)[0,1,3,7,9]; 1034 my $hash1 = join ":", (stat _)[0,1,3,7,9];
745 1035
746 # read the directory entries 1036 # read the directory entries
747 aioreq_pri $pri; 1037 aioreq_pri $pri;
748 add $grp aio_readdir $path, sub { 1038 add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
749 my $entries = shift 1039 my $entries = shift
750 or return $grp->result (); 1040 or return $grp->result ();
751 1041
752 # stat the dir another time 1042 # stat the dir another time
753 aioreq_pri $pri; 1043 aioreq_pri $pri;
754 add $grp aio_stat $path, sub { 1044 add $grp aio_stat $wd, sub {
755 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 1045 my $hash2 = join ":", (stat _)[0,1,3,7,9];
756 1046
757 my $ndirs; 1047 my $ndirs;
758 1048
759 # take the slow route if anything looks fishy 1049 # take the slow route if anything looks fishy
760 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 1050 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
761 $ndirs = -1; 1051 $ndirs = -1;
762 } else { 1052 } else {
763 # if nlink == 2, we are finished 1053 # if nlink == 2, we are finished
764 # on non-posix-fs's, we rely on nlink < 2 1054 # for non-posix-fs's, we rely on nlink < 2
765 $ndirs = (stat _)[3] - 2 1055 $ndirs = (stat _)[3] - 2
766 or return $grp->result ([], $entries); 1056 or return $grp->result ([], $entries);
767 } 1057 }
768 1058
769 # sort into likely dirs and likely nondirs
770 # dirs == files without ".", short entries first
771 $entries = [map $_->[0],
772 sort { $b->[1] cmp $a->[1] }
773 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
774 @$entries];
775
776 my (@dirs, @nondirs); 1059 my (@dirs, @nondirs);
777 1060
778 my $statgrp = add $grp aio_group sub { 1061 my $statgrp = add $grp aio_group sub {
779 $grp->result (\@dirs, \@nondirs); 1062 $grp->result (\@dirs, \@nondirs);
780 }; 1063 };
781 1064
782 limit $statgrp $maxreq; 1065 limit $statgrp $maxreq;
783 feed $statgrp sub { 1066 feed $statgrp sub {
784 return unless @$entries; 1067 return unless @$entries;
785 my $entry = pop @$entries; 1068 my $entry = shift @$entries;
786 1069
787 aioreq_pri $pri; 1070 aioreq_pri $pri;
1071 $wd->[1] = "$entry/.";
788 add $statgrp aio_stat "$path/$entry/.", sub { 1072 add $statgrp aio_stat $wd, sub {
789 if ($_[0] < 0) { 1073 if ($_[0] < 0) {
790 push @nondirs, $entry; 1074 push @nondirs, $entry;
791 } else { 1075 } else {
792 # need to check for real directory 1076 # need to check for real directory
793 aioreq_pri $pri; 1077 aioreq_pri $pri;
1078 $wd->[1] = $entry;
794 add $statgrp aio_lstat "$path/$entry", sub { 1079 add $statgrp aio_lstat $wd, sub {
795 if (-d _) { 1080 if (-d _) {
796 push @dirs, $entry; 1081 push @dirs, $entry;
797 1082
798 unless (--$ndirs) { 1083 unless (--$ndirs) {
799 push @nondirs, @$entries; 1084 push @nondirs, @$entries;
807 }; 1092 };
808 }; 1093 };
809 }; 1094 };
810 }; 1095 };
811 }; 1096 };
812
813 $grp
814 } 1097 };
1098
1099 $grp
815} 1100}
816 1101
817=item aio_rmtree $path, $callback->($status) 1102=item aio_rmtree $pathname, $callback->($status)
818 1103
819Delete a directory tree starting (and including) C<$path>, return the 1104Delete a directory tree starting (and including) C<$path>, return the
820status of the final C<rmdir> only. This is a composite request that 1105status of the final C<rmdir> only. This is a composite request that
821uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1106uses C<aio_scandir> to recurse into and rmdir directories, and unlink
822everything else. 1107everything else.
823 1108
824=cut 1109=cut
825 1110
826sub aio_rmtree; 1111sub aio_rmtree;
827sub aio_rmtree($;$) { 1112sub aio_rmtree($;$) {
828 aio_block {
829 my ($path, $cb) = @_; 1113 my ($path, $cb) = @_;
830 1114
831 my $pri = aioreq_pri; 1115 my $pri = aioreq_pri;
832 my $grp = aio_group $cb; 1116 my $grp = aio_group $cb;
833 1117
834 aioreq_pri $pri; 1118 aioreq_pri $pri;
835 add $grp aio_scandir $path, 0, sub { 1119 add $grp aio_scandir $path, 0, sub {
836 my ($dirs, $nondirs) = @_; 1120 my ($dirs, $nondirs) = @_;
837 1121
838 my $dirgrp = aio_group sub { 1122 my $dirgrp = aio_group sub {
839 add $grp aio_rmdir $path, sub { 1123 add $grp aio_rmdir $path, sub {
840 $grp->result ($_[0]); 1124 $grp->result ($_[0]);
841 };
842 }; 1125 };
843
844 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
845 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
846
847 add $grp $dirgrp;
848 }; 1126 };
849 1127
850 $grp 1128 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
1129 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
1130
1131 add $grp $dirgrp;
851 } 1132 };
1133
1134 $grp
852} 1135}
853 1136
854=item aio_sync $callback->($status) 1137=item aio_sync $callback->($status)
855 1138
856Asynchronously call sync and call the callback when finished. 1139Asynchronously call sync and call the callback when finished.
866callback with the fdatasync result code. 1149callback with the fdatasync result code.
867 1150
868If this call isn't available because your OS lacks it or it couldn't be 1151If this call isn't available because your OS lacks it or it couldn't be
869detected, it will be emulated by calling C<fsync> instead. 1152detected, it will be emulated by calling C<fsync> instead.
870 1153
1154=item aio_syncfs $fh, $callback->($status)
1155
1156Asynchronously call the syncfs syscall to sync the filesystem associated
1157to the given filehandle and call the callback with the syncfs result
1158code. If syncfs is not available, calls sync(), but returns C<-1> and sets
1159errno to C<ENOSYS> nevertheless.
1160
1161=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
1162
1163Sync the data portion of the file specified by C<$offset> and C<$length>
1164to disk (but NOT the metadata), by calling the Linux-specific
1165sync_file_range call. If sync_file_range is not available or it returns
1166ENOSYS, then fdatasync or fsync is being substituted.
1167
1168C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
1169C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
1170C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
1171manpage for details.
1172
871=item aio_pathsync $path, $callback->($status) 1173=item aio_pathsync $pathname, $callback->($status)
872 1174
873This request tries to open, fsync and close the given path. This is a 1175This request tries to open, fsync and close the given path. This is a
874composite request intended tosync directories after directory operations 1176composite request intended to sync directories after directory operations
875(E.g. rename). This might not work on all operating systems or have any 1177(E.g. rename). This might not work on all operating systems or have any
876specific effect, but usually it makes sure that directory changes get 1178specific effect, but usually it makes sure that directory changes get
877written to disc. It works for anything that can be opened for read-only, 1179written to disc. It works for anything that can be opened for read-only,
878not just directories. 1180not just directories.
879 1181
1182Future versions of this function might fall back to other methods when
1183C<fsync> on the directory fails (such as calling C<sync>).
1184
880Passes C<0> when everything went ok, and C<-1> on error. 1185Passes C<0> when everything went ok, and C<-1> on error.
881 1186
882=cut 1187=cut
883 1188
884sub aio_pathsync($;$) { 1189sub aio_pathsync($;$) {
885 aio_block {
886 my ($path, $cb) = @_; 1190 my ($path, $cb) = @_;
887 1191
888 my $pri = aioreq_pri; 1192 my $pri = aioreq_pri;
889 my $grp = aio_group $cb; 1193 my $grp = aio_group $cb;
890 1194
891 aioreq_pri $pri; 1195 aioreq_pri $pri;
892 add $grp aio_open $path, O_RDONLY, 0, sub { 1196 add $grp aio_open $path, O_RDONLY, 0, sub {
893 my ($fh) = @_; 1197 my ($fh) = @_;
894 if ($fh) { 1198 if ($fh) {
1199 aioreq_pri $pri;
1200 add $grp aio_fsync $fh, sub {
1201 $grp->result ($_[0]);
1202
895 aioreq_pri $pri; 1203 aioreq_pri $pri;
896 add $grp aio_fsync $fh, sub {
897 $grp->result ($_[0]);
898
899 aioreq_pri $pri;
900 add $grp aio_close $fh; 1204 add $grp aio_close $fh;
901 };
902 } else {
903 $grp->result (-1);
904 } 1205 };
1206 } else {
1207 $grp->result (-1);
905 }; 1208 }
906
907 $grp
908 } 1209 };
1210
1211 $grp
909} 1212}
1213
1214=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1215
1216This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1217scalars (see the C<IO::AIO::mmap> function, although it also works on data
1218scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1219scalar must only be modified in-place while an aio operation is pending on
1220it).
1221
1222It calls the C<msync> function of your OS, if available, with the memory
1223area starting at C<$offset> in the string and ending C<$length> bytes
1224later. If C<$length> is negative, counts from the end, and if C<$length>
1225is C<undef>, then it goes till the end of the string. The flags can be
1226a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
1227C<IO::AIO::MS_SYNC>.
1228
1229=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1230
1231This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1232scalars.
1233
1234It touches (reads or writes) all memory pages in the specified
1235range inside the scalar. All caveats and parameters are the same
1236as for C<aio_msync>, above, except for flags, which must be either
1237C<0> (which reads all pages and ensures they are instantiated) or
1238C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
1239writing an octet from it, which dirties the page).
1240
1241=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1242
1243This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1244scalars.
1245
1246It reads in all the pages of the underlying storage into memory (if any)
1247and locks them, so they are not getting swapped/paged out or removed.
1248
1249If C<$length> is undefined, then the scalar will be locked till the end.
1250
1251On systems that do not implement C<mlock>, this function returns C<-1>
1252and sets errno to C<ENOSYS>.
1253
1254Note that the corresponding C<munlock> is synchronous and is
1255documented under L<MISCELLANEOUS FUNCTIONS>.
1256
1257Example: open a file, mmap and mlock it - both will be undone when
1258C<$data> gets destroyed.
1259
1260 open my $fh, "<", $path or die "$path: $!";
1261 my $data;
1262 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1263 aio_mlock $data; # mlock in background
1264
1265=item aio_mlockall $flags, $callback->($status)
1266
1267Calls the C<mlockall> function with the given C<$flags> (a combination of
1268C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
1269
1270On systems that do not implement C<mlockall>, this function returns C<-1>
1271and sets errno to C<ENOSYS>.
1272
1273Note that the corresponding C<munlockall> is synchronous and is
1274documented under L<MISCELLANEOUS FUNCTIONS>.
1275
1276Example: asynchronously lock all current and future pages into memory.
1277
1278 aio_mlockall IO::AIO::MCL_FUTURE;
1279
1280=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1281
1282Queries the extents of the given file (by calling the Linux FIEMAP ioctl,
1283see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the
1284C<ioctl> is not available on your OS, then this request will fail with
1285C<ENOSYS>.
1286
1287C<$start> is the starting offset to query extents for, C<$length> is the
1288size of the range to query - if it is C<undef>, then the whole file will
1289be queried.
1290
1291C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
1292C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
1293exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
1294the data portion.
1295
1296C<$count> is the maximum number of extent records to return. If it is
1297C<undef>, then IO::AIO queries all extents of the range. As a very special
1298case, if it is C<0>, then the callback receives the number of extents
1299instead of the extents themselves (which is unreliable, see below).
1300
1301If an error occurs, the callback receives no arguments. The special
1302C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
1303
1304Otherwise, the callback receives an array reference with extent
1305structures. Each extent structure is an array reference itself, with the
1306following members:
1307
1308 [$logical, $physical, $length, $flags]
1309
1310Flags is any combination of the following flag values (typically either C<0>
1311or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
1312
1313C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
1314C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
1315C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1316C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1317C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1318C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1319
1320At the time of this writing (Linux 3.2), this requets is unreliable unless
1321C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1322it to return all extents of a range for files with large number of
1323extents. The code works around all these issues if C<$count> is undef.
910 1324
911=item aio_group $callback->(...) 1325=item aio_group $callback->(...)
912 1326
913This is a very special aio request: Instead of doing something, it is a 1327This is a very special aio request: Instead of doing something, it is a
914container for other aio requests, which is useful if you want to bundle 1328container for other aio requests, which is useful if you want to bundle
952immense (it blocks a thread for a long time) so do not use this function 1366immense (it blocks a thread for a long time) so do not use this function
953except to put your application under artificial I/O pressure. 1367except to put your application under artificial I/O pressure.
954 1368
955=back 1369=back
956 1370
1371
1372=head2 IO::AIO::WD - multiple working directories
1373
1374Your process only has one current working directory, which is used by all
1375threads. This makes it hard to use relative paths (some other component
1376could call C<chdir> at any time, and it is hard to control when the path
1377will be used by IO::AIO).
1378
1379One solution for this is to always use absolute paths. This usually works,
1380but can be quite slow (the kernel has to walk the whole path on every
1381access), and can also be a hassle to implement.
1382
1383Newer POSIX systems have a number of functions (openat, fdopendir,
1384futimensat and so on) that make it possible to specify working directories
1385per operation.
1386
1387For portability, and because the clowns who "designed", or shall I write,
1388perpetrated this new interface were obviously half-drunk, this abstraction
1389cannot be perfect, though.
1390
1391IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
1392object. This object stores the canonicalised, absolute version of the
1393path, and on systems that allow it, also a directory file descriptor.
1394
1395Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
1396or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
1397object and a pathname instead (or the IO::AIO::WD object alone, which
1398gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
1399IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
1400to that IO::AIO::WD object.
1401
1402For example, to get a wd object for F</etc> and then stat F<passwd>
1403inside, you would write:
1404
1405 aio_wd "/etc", sub {
1406 my $etcdir = shift;
1407
1408 # although $etcdir can be undef on error, there is generally no reason
1409 # to check for errors here, as aio_stat will fail with ENOENT
1410 # when $etcdir is undef.
1411
1412 aio_stat [$etcdir, "passwd"], sub {
1413 # yay
1414 };
1415 };
1416
1417That C<aio_wd> is a request and not a normal function shows that creating
1418an IO::AIO::WD object is itself a potentially blocking operation, which is
1419why it is done asynchronously.
1420
1421To stat the directory obtained with C<aio_wd> above, one could write
1422either of the following three request calls:
1423
1424 aio_lstat "/etc" , sub { ... # pathname as normal string
1425 aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
1426 aio_lstat $wd , sub { ... # shorthand for the previous
1427
1428As with normal pathnames, IO::AIO keeps a copy of the working directory
1429object and the pathname string, so you could write the following without
1430causing any issues due to C<$path> getting reused:
1431
1432 my $path = [$wd, undef];
1433
1434 for my $name (qw(abc def ghi)) {
1435 $path->[1] = $name;
1436 aio_stat $path, sub {
1437 # ...
1438 };
1439 }
1440
1441There are some caveats: when directories get renamed (or deleted), the
1442pathname string doesn't change, so will point to the new directory (or
1443nowhere at all), while the directory fd, if available on the system,
1444will still point to the original directory. Most functions accepting a
1445pathname will use the directory fd on newer systems, and the string on
1446older systems. Some functions (such as realpath) will always rely on the
1447string form of the pathname.
1448
1449So this fucntionality is mainly useful to get some protection against
1450C<chdir>, to easily get an absolute path out of a relative path for future
1451reference, and to speed up doing many operations in the same directory
1452(e.g. when stat'ing all files in a directory).
1453
1454The following functions implement this working directory abstraction:
1455
1456=over 4
1457
1458=item aio_wd $pathname, $callback->($wd)
1459
1460Asynchonously canonicalise the given pathname and convert it to an
1461IO::AIO::WD object representing it. If possible and supported on the
1462system, also open a directory fd to speed up pathname resolution relative
1463to this working directory.
1464
1465If something goes wrong, then C<undef> is passwd to the callback instead
1466of a working directory object and C<$!> is set appropriately. Since
1467passing C<undef> as working directory component of a pathname fails the
1468request with C<ENOENT>, there is often no need for error checking in the
1469C<aio_wd> callback, as future requests using the value will fail in the
1470expected way.
1471
1472If this call isn't available because your OS lacks it or it couldn't be
1473detected, it will be emulated by calling C<fsync> instead.
1474
1475=item IO::AIO::CWD
1476
1477This is a compiletime constant (object) that represents the process
1478current working directory.
1479
1480Specifying this object as working directory object for a pathname is as
1481if the pathname would be specified directly, without a directory object,
1482e.g., these calls are functionally identical:
1483
1484 aio_stat "somefile", sub { ... };
1485 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1486
1487=back
1488
1489
957=head2 IO::AIO::REQ CLASS 1490=head2 IO::AIO::REQ CLASS
958 1491
959All non-aggregate C<aio_*> functions return an object of this class when 1492All non-aggregate C<aio_*> functions return an object of this class when
960called in non-void context. 1493called in non-void context.
961 1494
964=item cancel $req 1497=item cancel $req
965 1498
966Cancels the request, if possible. Has the effect of skipping execution 1499Cancels the request, if possible. Has the effect of skipping execution
967when entering the B<execute> state and skipping calling the callback when 1500when entering the B<execute> state and skipping calling the callback when
968entering the the B<result> state, but will leave the request otherwise 1501entering the the B<result> state, but will leave the request otherwise
969untouched. That means that requests that currently execute will not be 1502untouched (with the exception of readdir). That means that requests that
970stopped and resources held by the request will not be freed prematurely. 1503currently execute will not be stopped and resources held by the request
1504will not be freed prematurely.
971 1505
972=item cb $req $callback->(...) 1506=item cb $req $callback->(...)
973 1507
974Replace (or simply set) the callback registered to the request. 1508Replace (or simply set) the callback registered to the request.
975 1509
1026Their lifetime, simplified, looks like this: when they are empty, they 1560Their lifetime, simplified, looks like this: when they are empty, they
1027will finish very quickly. If they contain only requests that are in the 1561will finish very quickly. If they contain only requests that are in the
1028C<done> state, they will also finish. Otherwise they will continue to 1562C<done> state, they will also finish. Otherwise they will continue to
1029exist. 1563exist.
1030 1564
1031That means after creating a group you have some time to add requests. And 1565That means after creating a group you have some time to add requests
1032in the callbacks of those requests, you can add further requests to the 1566(precisely before the callback has been invoked, which is only done within
1033group. And only when all those requests have finished will the the group 1567the C<poll_cb>). And in the callbacks of those requests, you can add
1034itself finish. 1568further requests to the group. And only when all those requests have
1569finished will the the group itself finish.
1035 1570
1036=over 4 1571=over 4
1037 1572
1038=item add $grp ... 1573=item add $grp ...
1039 1574
1047 1582
1048=item $grp->cancel_subs 1583=item $grp->cancel_subs
1049 1584
1050Cancel all subrequests and clears any feeder, but not the group request 1585Cancel all subrequests and clears any feeder, but not the group request
1051itself. Useful when you queued a lot of events but got a result early. 1586itself. Useful when you queued a lot of events but got a result early.
1587
1588The group request will finish normally (you cannot add requests to the
1589group).
1052 1590
1053=item $grp->result (...) 1591=item $grp->result (...)
1054 1592
1055Set the result value(s) that will be passed to the group callback when all 1593Set the result value(s) that will be passed to the group callback when all
1056subrequests have finished and set the groups errno to the current value 1594subrequests have finished and set the groups errno to the current value
1072=item feed $grp $callback->($grp) 1610=item feed $grp $callback->($grp)
1073 1611
1074Sets a feeder/generator on this group: every group can have an attached 1612Sets a feeder/generator on this group: every group can have an attached
1075generator that generates requests if idle. The idea behind this is that, 1613generator that generates requests if idle. The idea behind this is that,
1076although you could just queue as many requests as you want in a group, 1614although you could just queue as many requests as you want in a group,
1077this might starve other requests for a potentially long time. For 1615this might starve other requests for a potentially long time. For example,
1078example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1616C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1079requests, delaying any later requests for a long time. 1617requests, delaying any later requests for a long time.
1080 1618
1081To avoid this, and allow incremental generation of requests, you can 1619To avoid this, and allow incremental generation of requests, you can
1082instead a group and set a feeder on it that generates those requests. The 1620instead a group and set a feeder on it that generates those requests. The
1083feed callback will be called whenever there are few enough (see C<limit>, 1621feed callback will be called whenever there are few enough (see C<limit>,
1088not impose any limits). 1626not impose any limits).
1089 1627
1090If the feed does not queue more requests when called, it will be 1628If the feed does not queue more requests when called, it will be
1091automatically removed from the group. 1629automatically removed from the group.
1092 1630
1093If the feed limit is C<0>, it will be set to C<2> automatically. 1631If the feed limit is C<0> when this method is called, it will be set to
1632C<2> automatically.
1094 1633
1095Example: 1634Example:
1096 1635
1097 # stat all files in @files, but only ever use four aio requests concurrently: 1636 # stat all files in @files, but only ever use four aio requests concurrently:
1098 1637
1110Sets the feeder limit for the group: The feeder will be called whenever 1649Sets the feeder limit for the group: The feeder will be called whenever
1111the group contains less than this many requests. 1650the group contains less than this many requests.
1112 1651
1113Setting the limit to C<0> will pause the feeding process. 1652Setting the limit to C<0> will pause the feeding process.
1114 1653
1654The default value for the limit is C<0>, but note that setting a feeder
1655automatically bumps it up to C<2>.
1656
1115=back 1657=back
1116 1658
1117=head2 SUPPORT FUNCTIONS 1659=head2 SUPPORT FUNCTIONS
1118 1660
1119=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1661=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1121=over 4 1663=over 4
1122 1664
1123=item $fileno = IO::AIO::poll_fileno 1665=item $fileno = IO::AIO::poll_fileno
1124 1666
1125Return the I<request result pipe file descriptor>. This filehandle must be 1667Return the I<request result pipe file descriptor>. This filehandle must be
1126polled for reading by some mechanism outside this module (e.g. Event or 1668polled for reading by some mechanism outside this module (e.g. EV, Glib,
1127select, see below or the SYNOPSIS). If the pipe becomes readable you have 1669select and so on, see below or the SYNOPSIS). If the pipe becomes readable
1128to call C<poll_cb> to check the results. 1670you have to call C<poll_cb> to check the results.
1129 1671
1130See C<poll_cb> for an example. 1672See C<poll_cb> for an example.
1131 1673
1132=item IO::AIO::poll_cb 1674=item IO::AIO::poll_cb
1133 1675
1134Process some outstanding events on the result pipe. You have to call this 1676Process some outstanding events on the result pipe. You have to call
1135regularly. Returns the number of events processed. Returns immediately 1677this regularly. Returns C<0> if all events could be processed (or there
1136when no events are outstanding. The amount of events processed depends on 1678were no events to process), or C<-1> if it returned earlier for whatever
1137the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. 1679reason. Returns immediately when no events are outstanding. The amount of
1680events processed depends on the settings of C<IO::AIO::max_poll_req> and
1681C<IO::AIO::max_poll_time>.
1138 1682
1139If not all requests were processed for whatever reason, the filehandle 1683If not all requests were processed for whatever reason, the filehandle
1140will still be ready when C<poll_cb> returns. 1684will still be ready when C<poll_cb> returns, so normally you don't have to
1685do anything special to have it called later.
1686
1687Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1688ready, it can be beneficial to call this function from loops which submit
1689a lot of requests, to make sure the results get processed when they become
1690available and not just when the loop is finished and the event loop takes
1691over again. This function returns very fast when there are no outstanding
1692requests.
1141 1693
1142Example: Install an Event watcher that automatically calls 1694Example: Install an Event watcher that automatically calls
1143IO::AIO::poll_cb with high priority: 1695IO::AIO::poll_cb with high priority (more examples can be found in the
1696SYNOPSIS section, at the top of this document):
1144 1697
1145 Event->io (fd => IO::AIO::poll_fileno, 1698 Event->io (fd => IO::AIO::poll_fileno,
1146 poll => 'r', async => 1, 1699 poll => 'r', async => 1,
1147 cb => \&IO::AIO::poll_cb); 1700 cb => \&IO::AIO::poll_cb);
1701
1702=item IO::AIO::poll_wait
1703
1704If there are any outstanding requests and none of them in the result
1705phase, wait till the result filehandle becomes ready for reading (simply
1706does a C<select> on the filehandle. This is useful if you want to
1707synchronously wait for some requests to finish).
1708
1709See C<nreqs> for an example.
1710
1711=item IO::AIO::poll
1712
1713Waits until some requests have been handled.
1714
1715Returns the number of requests processed, but is otherwise strictly
1716equivalent to:
1717
1718 IO::AIO::poll_wait, IO::AIO::poll_cb
1719
1720=item IO::AIO::flush
1721
1722Wait till all outstanding AIO requests have been handled.
1723
1724Strictly equivalent to:
1725
1726 IO::AIO::poll_wait, IO::AIO::poll_cb
1727 while IO::AIO::nreqs;
1148 1728
1149=item IO::AIO::max_poll_reqs $nreqs 1729=item IO::AIO::max_poll_reqs $nreqs
1150 1730
1151=item IO::AIO::max_poll_time $seconds 1731=item IO::AIO::max_poll_time $seconds
1152 1732
1177 # use a low priority so other tasks have priority 1757 # use a low priority so other tasks have priority
1178 Event->io (fd => IO::AIO::poll_fileno, 1758 Event->io (fd => IO::AIO::poll_fileno,
1179 poll => 'r', nice => 1, 1759 poll => 'r', nice => 1,
1180 cb => &IO::AIO::poll_cb); 1760 cb => &IO::AIO::poll_cb);
1181 1761
1182=item IO::AIO::poll_wait
1183
1184If there are any outstanding requests and none of them in the result
1185phase, wait till the result filehandle becomes ready for reading (simply
1186does a C<select> on the filehandle. This is useful if you want to
1187synchronously wait for some requests to finish).
1188
1189See C<nreqs> for an example.
1190
1191=item IO::AIO::poll
1192
1193Waits until some requests have been handled.
1194
1195Returns the number of requests processed, but is otherwise strictly
1196equivalent to:
1197
1198 IO::AIO::poll_wait, IO::AIO::poll_cb
1199
1200=item IO::AIO::flush
1201
1202Wait till all outstanding AIO requests have been handled.
1203
1204Strictly equivalent to:
1205
1206 IO::AIO::poll_wait, IO::AIO::poll_cb
1207 while IO::AIO::nreqs;
1208
1209=back 1762=back
1210 1763
1211=head3 CONTROLLING THE NUMBER OF THREADS 1764=head3 CONTROLLING THE NUMBER OF THREADS
1212 1765
1213=over 1766=over
1246 1799
1247Under normal circumstances you don't need to call this function. 1800Under normal circumstances you don't need to call this function.
1248 1801
1249=item IO::AIO::max_idle $nthreads 1802=item IO::AIO::max_idle $nthreads
1250 1803
1251Limit the number of threads (default: 4) that are allowed to idle (i.e., 1804Limit the number of threads (default: 4) that are allowed to idle
1252threads that did not get a request to process within 10 seconds). That 1805(i.e., threads that did not get a request to process within the idle
1253means if a thread becomes idle while C<$nthreads> other threads are also 1806timeout (default: 10 seconds). That means if a thread becomes idle while
1254idle, it will free its resources and exit. 1807C<$nthreads> other threads are also idle, it will free its resources and
1808exit.
1255 1809
1256This is useful when you allow a large number of threads (e.g. 100 or 1000) 1810This is useful when you allow a large number of threads (e.g. 100 or 1000)
1257to allow for extremely high load situations, but want to free resources 1811to allow for extremely high load situations, but want to free resources
1258under normal circumstances (1000 threads can easily consume 30MB of RAM). 1812under normal circumstances (1000 threads can easily consume 30MB of RAM).
1259 1813
1260The default is probably ok in most situations, especially if thread 1814The default is probably ok in most situations, especially if thread
1261creation is fast. If thread creation is very slow on your system you might 1815creation is fast. If thread creation is very slow on your system you might
1262want to use larger values. 1816want to use larger values.
1263 1817
1818=item IO::AIO::idle_timeout $seconds
1819
1820Sets the minimum idle timeout (default 10) after which worker threads are
1821allowed to exit. SEe C<IO::AIO::max_idle>.
1822
1264=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1823=item IO::AIO::max_outstanding $maxreqs
1824
1825Sets the maximum number of outstanding requests to C<$nreqs>. If
1826you do queue up more than this number of requests, the next call to
1827C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as
1828C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no
1829longer exceeded.
1830
1831In other words, this setting does not enforce a queue limit, but can be
1832used to make poll functions block if the limit is exceeded.
1265 1833
1266This is a very bad function to use in interactive programs because it 1834This is a very bad function to use in interactive programs because it
1267blocks, and a bad way to reduce concurrency because it is inexact: Better 1835blocks, and a bad way to reduce concurrency because it is inexact: Better
1268use an C<aio_group> together with a feed callback. 1836use an C<aio_group> together with a feed callback.
1269 1837
1270Sets the maximum number of outstanding requests to C<$nreqs>. If you 1838It's main use is in scripts without an event loop - when you want to stat
1271do queue up more than this number of requests, the next call to the 1839a lot of files, you can write somehting like this:
1272C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1273function will block until the limit is no longer exceeded.
1274 1840
1275The default value is very large, so there is no practical limit on the 1841 IO::AIO::max_outstanding 32;
1276number of outstanding requests.
1277 1842
1278You can still queue as many requests as you want. Therefore, 1843 for my $path (...) {
1279C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1844 aio_stat $path , ...;
1280as a stop gap to shield against fatal memory overflow (with large values). 1845 IO::AIO::poll_cb;
1846 }
1847
1848 IO::AIO::flush;
1849
1850The call to C<poll_cb> inside the loop will normally return instantly, but
1851as soon as more thna C<32> reqeusts are in-flight, it will block until
1852some requests have been handled. This keeps the loop from pushing a large
1853number of C<aio_stat> requests onto the queue.
1854
1855The default value for C<max_outstanding> is very large, so there is no
1856practical limit on the number of outstanding requests.
1281 1857
1282=back 1858=back
1283 1859
1284=head3 STATISTICAL INFORMATION 1860=head3 STATISTICAL INFORMATION
1285 1861
1305Returns the number of requests currently in the pending state (executed, 1881Returns the number of requests currently in the pending state (executed,
1306but not yet processed by poll_cb). 1882but not yet processed by poll_cb).
1307 1883
1308=back 1884=back
1309 1885
1886=head3 MISCELLANEOUS FUNCTIONS
1887
1888IO::AIO implements some functions that might be useful, but are not
1889asynchronous.
1890
1891=over 4
1892
1893=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1894
1895Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
1896but is blocking (this makes most sense if you know the input data is
1897likely cached already and the output filehandle is set to non-blocking
1898operations).
1899
1900Returns the number of bytes copied, or C<-1> on error.
1901
1902=item IO::AIO::fadvise $fh, $offset, $len, $advice
1903
1904Simply calls the C<posix_fadvise> function (see its
1905manpage for details). The following advice constants are
1906available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1907C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1908C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1909
1910On systems that do not implement C<posix_fadvise>, this function returns
1911ENOSYS, otherwise the return value of C<posix_fadvise>.
1912
1913=item IO::AIO::madvise $scalar, $offset, $len, $advice
1914
1915Simply calls the C<posix_madvise> function (see its
1916manpage for details). The following advice constants are
1917available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1918C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
1919
1920On systems that do not implement C<posix_madvise>, this function returns
1921ENOSYS, otherwise the return value of C<posix_madvise>.
1922
1923=item IO::AIO::mprotect $scalar, $offset, $len, $protect
1924
1925Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1926$scalar (see its manpage for details). The following protect
1927constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1928C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1929
1930On systems that do not implement C<mprotect>, this function returns
1931ENOSYS, otherwise the return value of C<mprotect>.
1932
1933=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1934
1935Memory-maps a file (or anonymous memory range) and attaches it to the
1936given C<$scalar>, which will act like a string scalar. Returns true on
1937success, and false otherwise.
1938
1939The only operations allowed on the scalar are C<substr>/C<vec> that don't
1940change the string length, and most read-only operations such as copying it
1941or searching it with regexes and so on.
1942
1943Anything else is unsafe and will, at best, result in memory leaks.
1944
1945The memory map associated with the C<$scalar> is automatically removed
1946when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
1947C<IO::AIO::munmap> functions are called.
1948
1949This calls the C<mmap>(2) function internally. See your system's manual
1950page for details on the C<$length>, C<$prot> and C<$flags> parameters.
1951
1952The C<$length> must be larger than zero and smaller than the actual
1953filesize.
1954
1955C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1956C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1957
1958C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
1959C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
1960not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
1961(which is set to C<MAP_ANON> if your system only provides this
1962constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
1963C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
1964C<IO::AIO::MAP_NONBLOCK>
1965
1966If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1967
1968C<$offset> is the offset from the start of the file - it generally must be
1969a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
1970
1971Example:
1972
1973 use Digest::MD5;
1974 use IO::AIO;
1975
1976 open my $fh, "<verybigfile"
1977 or die "$!";
1978
1979 IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
1980 or die "verybigfile: $!";
1981
1982 my $fast_md5 = md5 $data;
1983
1984=item IO::AIO::munmap $scalar
1985
1986Removes a previous mmap and undefines the C<$scalar>.
1987
1988=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
1989
1990Calls the C<munlock> function, undoing the effects of a previous
1991C<aio_mlock> call (see its description for details).
1992
1993=item IO::AIO::munlockall
1994
1995Calls the C<munlockall> function.
1996
1997On systems that do not implement C<munlockall>, this function returns
1998ENOSYS, otherwise the return value of C<munlockall>.
1999
2000=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
2001
2002Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
2003C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
2004should be the file offset.
2005
2006C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2007silently corrupt the data in this case.
2008
2009The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
2010C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
2011C<IO::AIO::SPLICE_F_GIFT>.
2012
2013See the C<splice(2)> manpage for details.
2014
2015=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2016
2017Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
2018description for C<IO::AIO::splice> above for details.
2019
2020=back
2021
1310=cut 2022=cut
1311 2023
1312min_parallel 8; 2024min_parallel 8;
1313 2025
1314END { flush } 2026END { flush }
1315 2027
13161; 20281;
1317 2029
2030=head1 EVENT LOOP INTEGRATION
2031
2032It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
2033automatically into many event loops:
2034
2035 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
2036 use AnyEvent::AIO;
2037
2038You can also integrate IO::AIO manually into many event loops, here are
2039some examples of how to do this:
2040
2041 # EV integration
2042 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
2043
2044 # Event integration
2045 Event->io (fd => IO::AIO::poll_fileno,
2046 poll => 'r',
2047 cb => \&IO::AIO::poll_cb);
2048
2049 # Glib/Gtk2 integration
2050 add_watch Glib::IO IO::AIO::poll_fileno,
2051 in => sub { IO::AIO::poll_cb; 1 };
2052
2053 # Tk integration
2054 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
2055 readable => \&IO::AIO::poll_cb);
2056
2057 # Danga::Socket integration
2058 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
2059 \&IO::AIO::poll_cb);
2060
1318=head2 FORK BEHAVIOUR 2061=head2 FORK BEHAVIOUR
1319 2062
1320This module should do "the right thing" when the process using it forks: 2063Usage of pthreads in a program changes the semantics of fork
2064considerably. Specifically, only async-safe functions can be called after
2065fork. Perl doesn't know about this, so in general, you cannot call fork
2066with defined behaviour in perl if pthreads are involved. IO::AIO uses
2067pthreads, so this applies, but many other extensions and (for inexplicable
2068reasons) perl itself often is linked against pthreads, so this limitation
2069applies to quite a lot of perls.
1321 2070
1322Before the fork, IO::AIO enters a quiescent state where no requests 2071This module no longer tries to fight your OS, or POSIX. That means IO::AIO
1323can be added in other threads and no results will be processed. After 2072only works in the process that loaded it. Forking is fully supported, but
1324the fork the parent simply leaves the quiescent state and continues 2073using IO::AIO in the child is not.
1325request/result processing, while the child frees the request/result queue
1326(so that the requests started before the fork will only be handled in the
1327parent). Threads will be started on demand until the limit set in the
1328parent process has been reached again.
1329 2074
1330In short: the parent will, after a short pause, continue as if fork had 2075You might get around by not I<using> IO::AIO before (or after)
1331not been called, while the child will act as if IO::AIO has not been used 2076forking. You could also try to call the L<IO::AIO::reinit> function in the
1332yet. 2077child:
2078
2079=over 4
2080
2081=item IO::AIO::reinit
2082
2083Abandons all current requests and I/O threads and simply reinitialises all
2084data structures. This is not an operation supported by any standards, but
2085happens to work on GNU/Linux and some newer BSD systems.
2086
2087The only reasonable use for this function is to call it after forking, if
2088C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in
2089the process will result in undefined behaviour. Calling it at any time
2090will also result in any undefined (by POSIX) behaviour.
2091
2092=back
1333 2093
1334=head2 MEMORY USAGE 2094=head2 MEMORY USAGE
1335 2095
1336Per-request usage: 2096Per-request usage:
1337 2097
1354 2114
1355Known bugs will be fixed in the next release. 2115Known bugs will be fixed in the next release.
1356 2116
1357=head1 SEE ALSO 2117=head1 SEE ALSO
1358 2118
1359L<Coro::AIO>. 2119L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2120more natural syntax.
1360 2121
1361=head1 AUTHOR 2122=head1 AUTHOR
1362 2123
1363 Marc Lehmann <schmorp@schmorp.de> 2124 Marc Lehmann <schmorp@schmorp.de>
1364 http://home.schmorp.de/ 2125 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines