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.119 by root, Sun Dec 2 20:54:33 2007 UTC vs.
Revision 1.230 by root, Fri Jul 27 17:24:06 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.6'; 173 our $VERSION = '4.15';
200 174
201 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 175 our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close
202 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
203 aio_readlink aio_sync aio_fsync aio_fdatasync aio_readahead aio_rename aio_link 177 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync
178 aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate
179 aio_pathsync aio_readahead aio_fiemap
180 aio_rename aio_link aio_move aio_copy aio_group
204 aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir 181 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
205 aio_chown 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);
186
206 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 187 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
207 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 188 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
208 min_parallel max_parallel max_idle 189 min_parallel max_parallel max_idle idle_timeout
209 nreqs nready npending nthreads 190 nreqs nready npending nthreads
210 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
211 196
212 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 197 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
213 198
214 require XSLoader; 199 require XSLoader;
215 XSLoader::load ("IO::AIO", $VERSION); 200 XSLoader::load ("IO::AIO", $VERSION);
216} 201}
217 202
218=head1 FUNCTIONS 203=head1 FUNCTIONS
219 204
220=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
221 287
222All 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
223with 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,
224and they all accept an additional (and optional) C<$callback> argument 290and they all accept an additional (and optional) C<$callback> argument
225which 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
226the syscall return code (e.g. most syscalls return C<-1> on error, unlike 292the syscall has been executed in an asynchronous fashion. The results
227perl, 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
228syscall 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>.
229 300
230All functions expecting a filehandle keep a copy of the filehandle 301All functions expecting a filehandle keep a copy of the filehandle
231internally until the request has finished. 302internally until the request has finished.
232 303
233All 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
234further manipulation of those requests while they are in-flight. 305further manipulation of those requests while they are in-flight.
235 306
236The pathnames you pass to these routines I<must> be absolute and 307The pathnames you pass to these routines I<should> be absolute. The
237encoded 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
238request is being executed, the current working directory could have 309current working directory could have changed. Alternatively, you can
239changed. Alternatively, you can make sure that you never change the 310make sure that you never change the current working directory anywhere
240current working directory anywhere in the program and then use relative 311in the program and then use relative paths. You can also take advantage
241paths. 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.
242 315
243To 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
244in filenames you got from outside (command line, readdir etc.) without 317in filenames you got from outside (command line, readdir etc.) without
245tinkering, 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
246your pathnames to the locale (or other) encoding in effect in the user 319module and encode your pathnames to the locale (or other) encoding in
247environment, d) use Glib::filename_from_unicode on unicode filenames or e) 320effect in the user environment, d) use Glib::filename_from_unicode on
248use 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.
249 323
250This 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
251handles correctly wether it is set or not. 325handles correctly whether it is set or not.
326
327=head2 AIO REQUEST FUNCTIONS
252 328
253=over 4 329=over 4
254 330
255=item $prev_pri = aioreq_pri [$pri] 331=item $prev_pri = aioreq_pri [$pri]
256 332
303by 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
304change the umask. 380change the umask.
305 381
306Example: 382Example:
307 383
308 aio_open "/etc/passwd", O_RDONLY, 0, sub { 384 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
309 if ($_[0]) { 385 if ($_[0]) {
310 print "open successful, fh is $_[0]\n"; 386 print "open successful, fh is $_[0]\n";
311 ... 387 ...
312 } else { 388 } else {
313 die "open failed: $!\n"; 389 die "open failed: $!\n";
314 } 390 }
315 }; 391 };
316 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
317 402
318=item aio_close $fh, $callback->($status) 403=item aio_close $fh, $callback->($status)
319 404
320Asynchronously close a file and call the callback with the result 405Asynchronously close a file and call the callback with the result
321code. 406code.
322 407
323Unfortunately, you can't do this to perl. Perl I<insists> very strongly on 408Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
324closing the file descriptor associated with the filehandle itself. Here is 409closing the file descriptor associated with the filehandle itself.
325what aio_close will try:
326 410
327 1. dup()licate the fd 411Therefore, C<aio_close> will not close the filehandle - instead it will
328 2. asynchronously close() the duplicated fd 412use dup2 to overwrite the file descriptor with the write-end of a pipe
329 3. dup()licate the fd once more 413(the pipe fd will be created on demand and will be cached).
330 4. let perl close() the filehandle
331 5. asynchronously close the duplicated fd
332 414
333The idea is that the first close() flushes stuff to disk that closing an 415Or in other words: the file descriptor will be closed, but it will not be
334fd will flush, so when perl closes the fd, nothing much will need to be 416free for reuse until the perl filehandle is closed.
335flushed. The second async. close() will then flush stuff to disk that
336closing the last fd to the file will flush.
337
338Just FYI, SuSv3 has this to say on close:
339
340 All outstanding record locks owned by the process on the file
341 associated with the file descriptor shall be removed.
342
343 If fildes refers to a socket, close() shall cause the socket to be
344 destroyed. ... close() shall block for up to the current linger
345 interval until all data is transmitted.
346 [this actually sounds like a specification bug, but who knows]
347
348And at least Linux additionally actually flushes stuff on every close,
349even when the file itself is still open.
350
351Sounds enourmously inefficient and complicated? Yes... please show me how
352to nuke perl's fd out of existence...
353 417
354=cut 418=cut
355 419
356sub aio_close($;$) { 420=item aio_seek $fh, $offset, $whence, $callback->($offs)
357 aio_block {
358 my ($fh, $cb) = @_;
359 421
360 my $pri = aioreq_pri; 422Seeks the filehandle to the new C<$offset>, similarly to perl's
361 my $grp = aio_group $cb; 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>).
362 426
363 my $fd = fileno $fh; 427The resulting absolute offset will be passed to the callback, or C<-1> in
428case of an error.
364 429
365 defined $fd or Carp::croak "aio_close called with fd-less filehandle"; 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.
366 433
367 # if the dups fail we will simply get EBADF 434As a GNU/Linux (and maybe Solaris) extension, also the constants
368 my $fd2 = _dup $fd; 435C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
369 aioreq_pri $pri; 436could be found. No guarantees about suitability for use in C<aio_seek> or
370 add $grp _aio_close $fd2, sub { 437Perl's C<sysseek> can be made though, although I would naively assume they
371 my $fd2 = _dup $fd; 438"just work".
372 close $fh;
373 aioreq_pri $pri;
374 add $grp _aio_close $fd2, sub {
375 $grp->result ($_[0]);
376 };
377 };
378
379 $grp
380 }
381}
382
383 439
384=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 440=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
385 441
386=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 442=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
387 443
388Reads 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
389into 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>
390callback 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
391like 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.
392 451
393If C<$offset> is undefined, then the current file descriptor offset will 452If C<$offset> is undefined, then the current file descriptor offset will
394be used (and updated), otherwise the file descriptor offset will not be 453be used (and updated), otherwise the file descriptor offset will not be
395changed by these calls. 454changed by these calls.
396 455
397If 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>.
398 458
399If 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
400C<$data>. 460C<$data>.
401 461
402The 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
416 476
417Tries 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
418reading 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
419file 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
420than 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
421other. 481other. The same C<$in_fh> works fine though, as this function does not
482move or use the file offset of C<$in_fh>.
422 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
423This 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
424zero-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
425socket, and C<$in_fh> should refer to mmap'able file. 502a socket, and C<$in_fh> should refer to an mmap'able file.
426 503
427If 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>,
428emulated, 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
429regardless of the limitations of the operating system. 507type of filehandle regardless of the limitations of the operating system.
430 508
431Please note, however, that C<aio_sendfile> can read more bytes from 509As native sendfile syscalls (as practically any non-POSIX interface hacked
432C<$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
433bytes 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
434provides 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,
435value 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> -
436read. 514fewre bytes than expected might have been transferred.
437 515
438 516
439=item aio_readahead $fh,$offset,$length, $callback->($retval) 517=item aio_readahead $fh,$offset,$length, $callback->($retval)
440 518
441C<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
464 542
465Currently, 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
466error 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
467unless perl itself is compiled with large file support. 545unless perl itself is compiled with large file support.
468 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
469Example: Print the length of F</etc/passwd>: 556Example: Print the length of F</etc/passwd>:
470 557
471 aio_stat "/etc/passwd", sub { 558 aio_stat "/etc/passwd", sub {
472 $_[0] and die "stat failed: $!"; 559 $_[0] and die "stat failed: $!";
473 print "size is ", -s _, "\n"; 560 print "size is ", -s _, "\n";
474 }; 561 };
475 562
476 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
477=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 609=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
478 610
479Works 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
480and $mtime being undef). Fractional times are supported if the underlying 612and $mtime being undef). Fractional times are supported if the underlying
481syscalls support them. 613syscalls support them.
508=item aio_truncate $fh_or_path, $offset, $callback->($status) 640=item aio_truncate $fh_or_path, $offset, $callback->($status)
509 641
510Works like truncate(2) or ftruncate(2). 642Works like truncate(2) or ftruncate(2).
511 643
512 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
513=item aio_chmod $fh_or_path, $mode, $callback->($status) 661=item aio_chmod $fh_or_path, $mode, $callback->($status)
514 662
515Works like perl's C<chmod> function. 663Works like perl's C<chmod> function.
516 664
517 665
519 667
520Asynchronously unlink (delete) a file and call the callback with the 668Asynchronously unlink (delete) a file and call the callback with the
521result code. 669result code.
522 670
523 671
524=item aio_mknod $path, $mode, $dev, $callback->($status) 672=item aio_mknod $pathname, $mode, $dev, $callback->($status)
525 673
526[EXPERIMENTAL] 674[EXPERIMENTAL]
527 675
528Asynchronously create a device node (or fifo). See mknod(2). 676Asynchronously create a device node (or fifo). See mknod(2).
529 677
530The only (POSIX-) portable way of calling this function is: 678The only (POSIX-) portable way of calling this function is:
531 679
532 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 680 aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
533 681
682See C<aio_stat> for info about some potentially helpful extra constants
683and functions.
534 684
535=item aio_link $srcpath, $dstpath, $callback->($status) 685=item aio_link $srcpath, $dstpath, $callback->($status)
536 686
537Asynchronously 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
538the path C<$dstpath> and call the callback with the result code. 688the path C<$dstpath> and call the callback with the result code.
542 692
543Asynchronously 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
544the path C<$dstpath> and call the callback with the result code. 694the path C<$dstpath> and call the callback with the result code.
545 695
546 696
547=item aio_readlink $path, $callback->($link) 697=item aio_readlink $pathname, $callback->($link)
548 698
549Asynchronously read the symlink specified by C<$path> and pass it to 699Asynchronously read the symlink specified by C<$path> and pass it to
550the 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
551callback. 701callback.
552 702
553 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
554=item aio_rename $srcpath, $dstpath, $callback->($status) 714=item aio_rename $srcpath, $dstpath, $callback->($status)
555 715
556Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 716Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
557rename(2) and call the callback with the result code. 717rename(2) and call the callback with the result code.
558 718
574 734
575Unlike 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
576directory (i.e. opendir + readdir + closedir). The entries will not be 736directory (i.e. opendir + readdir + closedir). The entries will not be
577sorted, and will B<NOT> include the C<.> and C<..> entries. 737sorted, and will B<NOT> include the C<.> and C<..> entries.
578 738
579The 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
580with the filenames. 740array-ref with the filenames.
581 741
582 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
583=item aio_load $path, $data, $callback->($status) 809=item aio_load $pathname, $data, $callback->($status)
584 810
585This 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
586memory. Status is the same as with aio_read. 812memory. Status is the same as with aio_read.
587 813
588=cut 814=cut
589 815
590sub aio_load($$;$) { 816sub aio_load($$;$) {
591 aio_block {
592 my ($path, undef, $cb) = @_; 817 my ($path, undef, $cb) = @_;
593 my $data = \$_[1]; 818 my $data = \$_[1];
594 819
595 my $pri = aioreq_pri; 820 my $pri = aioreq_pri;
596 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);
597 827
598 aioreq_pri $pri; 828 aioreq_pri $pri;
599 add $grp aio_open $path, O_RDONLY, 0, sub {
600 my $fh = shift
601 or return $grp->result (-1);
602
603 aioreq_pri $pri;
604 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { 829 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
605 $grp->result ($_[0]); 830 $grp->result ($_[0]);
606 };
607 }; 831 };
608
609 $grp
610 } 832 };
833
834 $grp
611} 835}
612 836
613=item aio_copy $srcpath, $dstpath, $callback->($status) 837=item aio_copy $srcpath, $dstpath, $callback->($status)
614 838
615Try 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
616destination) from C<$srcpath> to C<$dstpath> and call the callback with 840destination) from C<$srcpath> to C<$dstpath> and call the callback with
617the C<0> (error) or C<-1> ok. 841a status of C<0> (ok) or C<-1> (error, see C<$!>).
618 842
619This is a composite request that it creates the destination file with 843This is a composite request that creates the destination file with
620mode 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
621C<aio_sendfile>, followed by restoring atime, mtime, access mode and 845C<aio_sendfile>, followed by restoring atime, mtime, access mode and
622uid/gid, in that order. 846uid/gid, in that order.
623 847
624If an error occurs, the partial destination file will be unlinked, if 848If an error occurs, the partial destination file will be unlinked, if
626errors are being ignored. 850errors are being ignored.
627 851
628=cut 852=cut
629 853
630sub aio_copy($$;$) { 854sub aio_copy($$;$) {
631 aio_block {
632 my ($src, $dst, $cb) = @_; 855 my ($src, $dst, $cb) = @_;
633 856
634 my $pri = aioreq_pri; 857 my $pri = aioreq_pri;
635 my $grp = aio_group $cb; 858 my $grp = aio_group $cb;
636 859
637 aioreq_pri $pri; 860 aioreq_pri $pri;
638 add $grp aio_open $src, O_RDONLY, 0, sub { 861 add $grp aio_open $src, O_RDONLY, 0, sub {
639 if (my $src_fh = $_[0]) { 862 if (my $src_fh = $_[0]) {
640 my @stat = stat $src_fh; 863 my @stat = stat $src_fh; # hmm, might block over nfs?
641 864
642 aioreq_pri $pri; 865 aioreq_pri $pri;
643 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 {
644 if (my $dst_fh = $_[0]) { 867 if (my $dst_fh = $_[0]) {
645 aioreq_pri $pri; 868 aioreq_pri $pri;
646 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 {
647 if ($_[0] == $stat[7]) { 870 if ($_[0] == $stat[7]) {
648 $grp->result (0); 871 $grp->result (0);
649 close $src_fh; 872 close $src_fh;
650 873
651 # those should not normally block. should. should.
652 utime $stat[8], $stat[9], $dst;
653 chmod $stat[2] & 07777, $dst_fh;
654 chown $stat[4], $stat[5], $dst_fh;
655 close $dst_fh;
656 } else { 874 my $ch = sub {
657 $grp->result (-1);
658 close $src_fh;
659 close $dst_fh;
660
661 aioreq $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;
662 add $grp aio_unlink $dst; 880 add $grp aio_close $dst_fh;
881 }
882 };
663 } 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;
664 }; 901 }
665 } else {
666 $grp->result (-1);
667 } 902 };
903 } else {
904 $grp->result (-1);
668 }, 905 }
669
670 } else {
671 $grp->result (-1);
672 } 906 },
907
908 } else {
909 $grp->result (-1);
673 }; 910 }
674
675 $grp
676 } 911 };
912
913 $grp
677} 914}
678 915
679=item aio_move $srcpath, $dstpath, $callback->($status) 916=item aio_move $srcpath, $dstpath, $callback->($status)
680 917
681Try 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
682destination) from C<$srcpath> to C<$dstpath> and call the callback with 919destination) from C<$srcpath> to C<$dstpath> and call the callback with
683the C<0> (error) or C<-1> ok. 920a status of C<0> (ok) or C<-1> (error, see C<$!>).
684 921
685This 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
686rename 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
687that is successful, unlinking the C<$srcpath>. 924that is successful, unlinks the C<$srcpath>.
688 925
689=cut 926=cut
690 927
691sub aio_move($$;$) { 928sub aio_move($$;$) {
692 aio_block {
693 my ($src, $dst, $cb) = @_; 929 my ($src, $dst, $cb) = @_;
694 930
695 my $pri = aioreq_pri; 931 my $pri = aioreq_pri;
696 my $grp = aio_group $cb; 932 my $grp = aio_group $cb;
697 933
698 aioreq_pri $pri; 934 aioreq_pri $pri;
699 add $grp aio_rename $src, $dst, sub { 935 add $grp aio_rename $src, $dst, sub {
700 if ($_[0] && $! == EXDEV) { 936 if ($_[0] && $! == EXDEV) {
701 aioreq_pri $pri; 937 aioreq_pri $pri;
702 add $grp aio_copy $src, $dst, sub { 938 add $grp aio_copy $src, $dst, sub {
703 $grp->result ($_[0]);
704
705 if (!$_[0]) {
706 aioreq_pri $pri;
707 add $grp aio_unlink $src;
708 }
709 };
710 } else {
711 $grp->result ($_[0]); 939 $grp->result ($_[0]);
940
941 unless ($_[0]) {
942 aioreq_pri $pri;
943 add $grp aio_unlink $src;
944 }
712 } 945 };
946 } else {
947 $grp->result ($_[0]);
713 }; 948 }
714
715 $grp
716 } 949 };
950
951 $grp
717} 952}
718 953
719=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 954=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
720 955
721Scans a directory (similar to C<aio_readdir>) but additionally tries to 956Scans a directory (similar to C<aio_readdir>) but additionally tries to
722efficiently separate the entries of directory C<$path> into two sets of 957efficiently separate the entries of directory C<$path> into two sets of
723names, directories you can recurse into (directories), and ones you cannot 958names, directories you can recurse into (directories), and ones you cannot
724recurse into (everything else, including symlinks to directories). 959recurse into (everything else, including symlinks to directories).
741 976
742Implementation notes. 977Implementation notes.
743 978
744The 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.
745 980
981If readdir returns file type information, then this is used directly to
982find directories.
983
746After reading the directory, the modification time, size etc. of the 984Otherwise, after reading the directory, the modification time, size etc.
747directory 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
748isn'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
749entries are directories (if >= 2). Otherwise, no knowledge of the number 987how many entries are directories (if >= 2). Otherwise, no knowledge of the
750of subdirectories will be assumed. 988number of subdirectories will be assumed.
751 989
752Then entries will be sorted into likely directories (everything without 990Then entries will be sorted into likely directories a non-initial dot
753a non-initial dot currently) and likely non-directories (everything 991currently) and likely non-directories (see C<aio_readdirx>). Then every
754else). 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,
755likely directories first. If that succeeds, it assumes that the entry 993in order of their inode numbers. If that succeeds, it assumes that the
756is a directory or a symlink to directory (which will be checked 994entry is a directory or a symlink to directory (which will be checked
757seperately). This is often faster than stat'ing the entry itself because 995separately). This is often faster than stat'ing the entry itself because
758filesystems might detect the type of the entry without reading the inode 996filesystems might detect the type of the entry without reading the inode
759data (e.g. ext2fs filetype feature). 997data (e.g. ext2fs filetype feature), even on systems that cannot return
998the filetype information on readdir.
760 999
761If 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
762rest of the entries is assumed to be non-directories. 1001rest of the entries is assumed to be non-directories.
763 1002
764This only works with certainty on POSIX (= UNIX) filesystems, which 1003This only works with certainty on POSIX (= UNIX) filesystems, which
769directory counting heuristic. 1008directory counting heuristic.
770 1009
771=cut 1010=cut
772 1011
773sub aio_scandir($$;$) { 1012sub aio_scandir($$;$) {
774 aio_block {
775 my ($path, $maxreq, $cb) = @_; 1013 my ($path, $maxreq, $cb) = @_;
776 1014
777 my $pri = aioreq_pri; 1015 my $pri = aioreq_pri;
778 1016
779 my $grp = aio_group $cb; 1017 my $grp = aio_group $cb;
780 1018
781 $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, "."];
782 1028
783 # stat once 1029 # stat once
784 aioreq_pri $pri; 1030 aioreq_pri $pri;
785 add $grp aio_stat $path, sub { 1031 add $grp aio_stat $wd, sub {
786 return $grp->result () if $_[0]; 1032 return $grp->result () if $_[0];
787 my $now = time; 1033 my $now = time;
788 my $hash1 = join ":", (stat _)[0,1,3,7,9]; 1034 my $hash1 = join ":", (stat _)[0,1,3,7,9];
789 1035
790 # read the directory entries 1036 # read the directory entries
791 aioreq_pri $pri; 1037 aioreq_pri $pri;
792 add $grp aio_readdir $path, sub { 1038 add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
793 my $entries = shift 1039 my $entries = shift
794 or return $grp->result (); 1040 or return $grp->result ();
795 1041
796 # stat the dir another time 1042 # stat the dir another time
797 aioreq_pri $pri; 1043 aioreq_pri $pri;
798 add $grp aio_stat $path, sub { 1044 add $grp aio_stat $wd, sub {
799 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 1045 my $hash2 = join ":", (stat _)[0,1,3,7,9];
800 1046
801 my $ndirs; 1047 my $ndirs;
802 1048
803 # take the slow route if anything looks fishy 1049 # take the slow route if anything looks fishy
804 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 1050 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
805 $ndirs = -1; 1051 $ndirs = -1;
806 } else { 1052 } else {
807 # if nlink == 2, we are finished 1053 # if nlink == 2, we are finished
808 # on non-posix-fs's, we rely on nlink < 2 1054 # for non-posix-fs's, we rely on nlink < 2
809 $ndirs = (stat _)[3] - 2 1055 $ndirs = (stat _)[3] - 2
810 or return $grp->result ([], $entries); 1056 or return $grp->result ([], $entries);
811 } 1057 }
812 1058
813 # sort into likely dirs and likely nondirs
814 # dirs == files without ".", short entries first
815 $entries = [map $_->[0],
816 sort { $b->[1] cmp $a->[1] }
817 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
818 @$entries];
819
820 my (@dirs, @nondirs); 1059 my (@dirs, @nondirs);
821 1060
822 my $statgrp = add $grp aio_group sub { 1061 my $statgrp = add $grp aio_group sub {
823 $grp->result (\@dirs, \@nondirs); 1062 $grp->result (\@dirs, \@nondirs);
824 }; 1063 };
825 1064
826 limit $statgrp $maxreq; 1065 limit $statgrp $maxreq;
827 feed $statgrp sub { 1066 feed $statgrp sub {
828 return unless @$entries; 1067 return unless @$entries;
829 my $entry = pop @$entries; 1068 my $entry = shift @$entries;
830 1069
831 aioreq_pri $pri; 1070 aioreq_pri $pri;
1071 $wd->[1] = "$entry/.";
832 add $statgrp aio_stat "$path/$entry/.", sub { 1072 add $statgrp aio_stat $wd, sub {
833 if ($_[0] < 0) { 1073 if ($_[0] < 0) {
834 push @nondirs, $entry; 1074 push @nondirs, $entry;
835 } else { 1075 } else {
836 # need to check for real directory 1076 # need to check for real directory
837 aioreq_pri $pri; 1077 aioreq_pri $pri;
1078 $wd->[1] = $entry;
838 add $statgrp aio_lstat "$path/$entry", sub { 1079 add $statgrp aio_lstat $wd, sub {
839 if (-d _) { 1080 if (-d _) {
840 push @dirs, $entry; 1081 push @dirs, $entry;
841 1082
842 unless (--$ndirs) { 1083 unless (--$ndirs) {
843 push @nondirs, @$entries; 1084 push @nondirs, @$entries;
851 }; 1092 };
852 }; 1093 };
853 }; 1094 };
854 }; 1095 };
855 }; 1096 };
856
857 $grp
858 } 1097 };
1098
1099 $grp
859} 1100}
860 1101
861=item aio_rmtree $path, $callback->($status) 1102=item aio_rmtree $pathname, $callback->($status)
862 1103
863Delete a directory tree starting (and including) C<$path>, return the 1104Delete a directory tree starting (and including) C<$path>, return the
864status 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
865uses C<aio_scandir> to recurse into and rmdir directories, and unlink 1106uses C<aio_scandir> to recurse into and rmdir directories, and unlink
866everything else. 1107everything else.
867 1108
868=cut 1109=cut
869 1110
870sub aio_rmtree; 1111sub aio_rmtree;
871sub aio_rmtree($;$) { 1112sub aio_rmtree($;$) {
872 aio_block {
873 my ($path, $cb) = @_; 1113 my ($path, $cb) = @_;
874 1114
875 my $pri = aioreq_pri; 1115 my $pri = aioreq_pri;
876 my $grp = aio_group $cb; 1116 my $grp = aio_group $cb;
877 1117
878 aioreq_pri $pri; 1118 aioreq_pri $pri;
879 add $grp aio_scandir $path, 0, sub { 1119 add $grp aio_scandir $path, 0, sub {
880 my ($dirs, $nondirs) = @_; 1120 my ($dirs, $nondirs) = @_;
881 1121
882 my $dirgrp = aio_group sub { 1122 my $dirgrp = aio_group sub {
883 add $grp aio_rmdir $path, sub { 1123 add $grp aio_rmdir $path, sub {
884 $grp->result ($_[0]); 1124 $grp->result ($_[0]);
885 };
886 }; 1125 };
887
888 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
889 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
890
891 add $grp $dirgrp;
892 }; 1126 };
893 1127
894 $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;
895 } 1132 };
1133
1134 $grp
896} 1135}
897 1136
898=item aio_sync $callback->($status) 1137=item aio_sync $callback->($status)
899 1138
900Asynchronously call sync and call the callback when finished. 1139Asynchronously call sync and call the callback when finished.
909Asynchronously call fdatasync on the given filehandle and call the 1148Asynchronously call fdatasync on the given filehandle and call the
910callback with the fdatasync result code. 1149callback with the fdatasync result code.
911 1150
912If 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
913detected, it will be emulated by calling C<fsync> instead. 1152detected, it will be emulated by calling C<fsync> instead.
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
1173=item aio_pathsync $pathname, $callback->($status)
1174
1175This request tries to open, fsync and close the given path. This is a
1176composite request intended to sync directories after directory operations
1177(E.g. rename). This might not work on all operating systems or have any
1178specific effect, but usually it makes sure that directory changes get
1179written to disc. It works for anything that can be opened for read-only,
1180not just directories.
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
1185Passes C<0> when everything went ok, and C<-1> on error.
1186
1187=cut
1188
1189sub aio_pathsync($;$) {
1190 my ($path, $cb) = @_;
1191
1192 my $pri = aioreq_pri;
1193 my $grp = aio_group $cb;
1194
1195 aioreq_pri $pri;
1196 add $grp aio_open $path, O_RDONLY, 0, sub {
1197 my ($fh) = @_;
1198 if ($fh) {
1199 aioreq_pri $pri;
1200 add $grp aio_fsync $fh, sub {
1201 $grp->result ($_[0]);
1202
1203 aioreq_pri $pri;
1204 add $grp aio_close $fh;
1205 };
1206 } else {
1207 $grp->result (-1);
1208 }
1209 };
1210
1211 $grp
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 file. As a very special
1298case, if it is C<0>, then the callback receives the number of extents
1299instead of the extents themselves.
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>):
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>.
914 1319
915=item aio_group $callback->(...) 1320=item aio_group $callback->(...)
916 1321
917This is a very special aio request: Instead of doing something, it is a 1322This is a very special aio request: Instead of doing something, it is a
918container for other aio requests, which is useful if you want to bundle 1323container for other aio requests, which is useful if you want to bundle
956immense (it blocks a thread for a long time) so do not use this function 1361immense (it blocks a thread for a long time) so do not use this function
957except to put your application under artificial I/O pressure. 1362except to put your application under artificial I/O pressure.
958 1363
959=back 1364=back
960 1365
1366
1367=head2 IO::AIO::WD - multiple working directories
1368
1369Your process only has one current working directory, which is used by all
1370threads. This makes it hard to use relative paths (some other component
1371could call C<chdir> at any time, and it is hard to control when the path
1372will be used by IO::AIO).
1373
1374One solution for this is to always use absolute paths. This usually works,
1375but can be quite slow (the kernel has to walk the whole path on every
1376access), and can also be a hassle to implement.
1377
1378Newer POSIX systems have a number of functions (openat, fdopendir,
1379futimensat and so on) that make it possible to specify working directories
1380per operation.
1381
1382For portability, and because the clowns who "designed", or shall I write,
1383perpetrated this new interface were obviously half-drunk, this abstraction
1384cannot be perfect, though.
1385
1386IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
1387object. This object stores the canonicalised, absolute version of the
1388path, and on systems that allow it, also a directory file descriptor.
1389
1390Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
1391or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
1392object and a pathname instead (or the IO::AIO::WD object alone, which
1393gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
1394IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
1395to that IO::AIO::WD object.
1396
1397For example, to get a wd object for F</etc> and then stat F<passwd>
1398inside, you would write:
1399
1400 aio_wd "/etc", sub {
1401 my $etcdir = shift;
1402
1403 # although $etcdir can be undef on error, there is generally no reason
1404 # to check for errors here, as aio_stat will fail with ENOENT
1405 # when $etcdir is undef.
1406
1407 aio_stat [$etcdir, "passwd"], sub {
1408 # yay
1409 };
1410 };
1411
1412That C<aio_wd> is a request and not a normal function shows that creating
1413an IO::AIO::WD object is itself a potentially blocking operation, which is
1414why it is done asynchronously.
1415
1416To stat the directory obtained with C<aio_wd> above, one could write
1417either of the following three request calls:
1418
1419 aio_lstat "/etc" , sub { ... # pathname as normal string
1420 aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
1421 aio_lstat $wd , sub { ... # shorthand for the previous
1422
1423As with normal pathnames, IO::AIO keeps a copy of the working directory
1424object and the pathname string, so you could write the following without
1425causing any issues due to C<$path> getting reused:
1426
1427 my $path = [$wd, undef];
1428
1429 for my $name (qw(abc def ghi)) {
1430 $path->[1] = $name;
1431 aio_stat $path, sub {
1432 # ...
1433 };
1434 }
1435
1436There are some caveats: when directories get renamed (or deleted), the
1437pathname string doesn't change, so will point to the new directory (or
1438nowhere at all), while the directory fd, if available on the system,
1439will still point to the original directory. Most functions accepting a
1440pathname will use the directory fd on newer systems, and the string on
1441older systems. Some functions (such as realpath) will always rely on the
1442string form of the pathname.
1443
1444So this fucntionality is mainly useful to get some protection against
1445C<chdir>, to easily get an absolute path out of a relative path for future
1446reference, and to speed up doing many operations in the same directory
1447(e.g. when stat'ing all files in a directory).
1448
1449The following functions implement this working directory abstraction:
1450
1451=over 4
1452
1453=item aio_wd $pathname, $callback->($wd)
1454
1455Asynchonously canonicalise the given pathname and convert it to an
1456IO::AIO::WD object representing it. If possible and supported on the
1457system, also open a directory fd to speed up pathname resolution relative
1458to this working directory.
1459
1460If something goes wrong, then C<undef> is passwd to the callback instead
1461of a working directory object and C<$!> is set appropriately. Since
1462passing C<undef> as working directory component of a pathname fails the
1463request with C<ENOENT>, there is often no need for error checking in the
1464C<aio_wd> callback, as future requests using the value will fail in the
1465expected way.
1466
1467If this call isn't available because your OS lacks it or it couldn't be
1468detected, it will be emulated by calling C<fsync> instead.
1469
1470=item IO::AIO::CWD
1471
1472This is a compiletime constant (object) that represents the process
1473current working directory.
1474
1475Specifying this object as working directory object for a pathname is as
1476if the pathname would be specified directly, without a directory object,
1477e.g., these calls are functionally identical:
1478
1479 aio_stat "somefile", sub { ... };
1480 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1481
1482=back
1483
1484
961=head2 IO::AIO::REQ CLASS 1485=head2 IO::AIO::REQ CLASS
962 1486
963All non-aggregate C<aio_*> functions return an object of this class when 1487All non-aggregate C<aio_*> functions return an object of this class when
964called in non-void context. 1488called in non-void context.
965 1489
968=item cancel $req 1492=item cancel $req
969 1493
970Cancels the request, if possible. Has the effect of skipping execution 1494Cancels the request, if possible. Has the effect of skipping execution
971when entering the B<execute> state and skipping calling the callback when 1495when entering the B<execute> state and skipping calling the callback when
972entering the the B<result> state, but will leave the request otherwise 1496entering the the B<result> state, but will leave the request otherwise
973untouched. That means that requests that currently execute will not be 1497untouched (with the exception of readdir). That means that requests that
974stopped and resources held by the request will not be freed prematurely. 1498currently execute will not be stopped and resources held by the request
1499will not be freed prematurely.
975 1500
976=item cb $req $callback->(...) 1501=item cb $req $callback->(...)
977 1502
978Replace (or simply set) the callback registered to the request. 1503Replace (or simply set) the callback registered to the request.
979 1504
1030Their lifetime, simplified, looks like this: when they are empty, they 1555Their lifetime, simplified, looks like this: when they are empty, they
1031will finish very quickly. If they contain only requests that are in the 1556will finish very quickly. If they contain only requests that are in the
1032C<done> state, they will also finish. Otherwise they will continue to 1557C<done> state, they will also finish. Otherwise they will continue to
1033exist. 1558exist.
1034 1559
1035That means after creating a group you have some time to add requests. And 1560That means after creating a group you have some time to add requests
1036in the callbacks of those requests, you can add further requests to the 1561(precisely before the callback has been invoked, which is only done within
1037group. And only when all those requests have finished will the the group 1562the C<poll_cb>). And in the callbacks of those requests, you can add
1038itself finish. 1563further requests to the group. And only when all those requests have
1564finished will the the group itself finish.
1039 1565
1040=over 4 1566=over 4
1041 1567
1042=item add $grp ... 1568=item add $grp ...
1043 1569
1052=item $grp->cancel_subs 1578=item $grp->cancel_subs
1053 1579
1054Cancel all subrequests and clears any feeder, but not the group request 1580Cancel all subrequests and clears any feeder, but not the group request
1055itself. Useful when you queued a lot of events but got a result early. 1581itself. Useful when you queued a lot of events but got a result early.
1056 1582
1583The group request will finish normally (you cannot add requests to the
1584group).
1585
1057=item $grp->result (...) 1586=item $grp->result (...)
1058 1587
1059Set the result value(s) that will be passed to the group callback when all 1588Set the result value(s) that will be passed to the group callback when all
1060subrequests have finished and set thre groups errno to the current value 1589subrequests have finished and set the groups errno to the current value
1061of errno (just like calling C<errno> without an error number). By default, 1590of errno (just like calling C<errno> without an error number). By default,
1062no argument will be passed and errno is zero. 1591no argument will be passed and errno is zero.
1063 1592
1064=item $grp->errno ([$errno]) 1593=item $grp->errno ([$errno])
1065 1594
1076=item feed $grp $callback->($grp) 1605=item feed $grp $callback->($grp)
1077 1606
1078Sets a feeder/generator on this group: every group can have an attached 1607Sets a feeder/generator on this group: every group can have an attached
1079generator that generates requests if idle. The idea behind this is that, 1608generator that generates requests if idle. The idea behind this is that,
1080although you could just queue as many requests as you want in a group, 1609although you could just queue as many requests as you want in a group,
1081this might starve other requests for a potentially long time. For 1610this might starve other requests for a potentially long time. For example,
1082example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1611C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1083requests, delaying any later requests for a long time. 1612requests, delaying any later requests for a long time.
1084 1613
1085To avoid this, and allow incremental generation of requests, you can 1614To avoid this, and allow incremental generation of requests, you can
1086instead a group and set a feeder on it that generates those requests. The 1615instead a group and set a feeder on it that generates those requests. The
1087feed callback will be called whenever there are few enough (see C<limit>, 1616feed callback will be called whenever there are few enough (see C<limit>,
1092not impose any limits). 1621not impose any limits).
1093 1622
1094If the feed does not queue more requests when called, it will be 1623If the feed does not queue more requests when called, it will be
1095automatically removed from the group. 1624automatically removed from the group.
1096 1625
1097If the feed limit is C<0>, it will be set to C<2> automatically. 1626If the feed limit is C<0> when this method is called, it will be set to
1627C<2> automatically.
1098 1628
1099Example: 1629Example:
1100 1630
1101 # stat all files in @files, but only ever use four aio requests concurrently: 1631 # stat all files in @files, but only ever use four aio requests concurrently:
1102 1632
1114Sets the feeder limit for the group: The feeder will be called whenever 1644Sets the feeder limit for the group: The feeder will be called whenever
1115the group contains less than this many requests. 1645the group contains less than this many requests.
1116 1646
1117Setting the limit to C<0> will pause the feeding process. 1647Setting the limit to C<0> will pause the feeding process.
1118 1648
1649The default value for the limit is C<0>, but note that setting a feeder
1650automatically bumps it up to C<2>.
1651
1119=back 1652=back
1120 1653
1121=head2 SUPPORT FUNCTIONS 1654=head2 SUPPORT FUNCTIONS
1122 1655
1123=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1656=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1125=over 4 1658=over 4
1126 1659
1127=item $fileno = IO::AIO::poll_fileno 1660=item $fileno = IO::AIO::poll_fileno
1128 1661
1129Return the I<request result pipe file descriptor>. This filehandle must be 1662Return the I<request result pipe file descriptor>. This filehandle must be
1130polled for reading by some mechanism outside this module (e.g. Event or 1663polled for reading by some mechanism outside this module (e.g. EV, Glib,
1131select, see below or the SYNOPSIS). If the pipe becomes readable you have 1664select and so on, see below or the SYNOPSIS). If the pipe becomes readable
1132to call C<poll_cb> to check the results. 1665you have to call C<poll_cb> to check the results.
1133 1666
1134See C<poll_cb> for an example. 1667See C<poll_cb> for an example.
1135 1668
1136=item IO::AIO::poll_cb 1669=item IO::AIO::poll_cb
1137 1670
1138Process some outstanding events on the result pipe. You have to call this 1671Process some outstanding events on the result pipe. You have to call
1139regularly. Returns the number of events processed. Returns immediately 1672this regularly. Returns C<0> if all events could be processed (or there
1140when no events are outstanding. The amount of events processed depends on 1673were no events to process), or C<-1> if it returned earlier for whatever
1141the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. 1674reason. Returns immediately when no events are outstanding. The amount of
1675events processed depends on the settings of C<IO::AIO::max_poll_req> and
1676C<IO::AIO::max_poll_time>.
1142 1677
1143If not all requests were processed for whatever reason, the filehandle 1678If not all requests were processed for whatever reason, the filehandle
1144will still be ready when C<poll_cb> returns. 1679will still be ready when C<poll_cb> returns, so normally you don't have to
1680do anything special to have it called later.
1681
1682Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1683ready, it can be beneficial to call this function from loops which submit
1684a lot of requests, to make sure the results get processed when they become
1685available and not just when the loop is finished and the event loop takes
1686over again. This function returns very fast when there are no outstanding
1687requests.
1145 1688
1146Example: Install an Event watcher that automatically calls 1689Example: Install an Event watcher that automatically calls
1147IO::AIO::poll_cb with high priority: 1690IO::AIO::poll_cb with high priority (more examples can be found in the
1691SYNOPSIS section, at the top of this document):
1148 1692
1149 Event->io (fd => IO::AIO::poll_fileno, 1693 Event->io (fd => IO::AIO::poll_fileno,
1150 poll => 'r', async => 1, 1694 poll => 'r', async => 1,
1151 cb => \&IO::AIO::poll_cb); 1695 cb => \&IO::AIO::poll_cb);
1696
1697=item IO::AIO::poll_wait
1698
1699If there are any outstanding requests and none of them in the result
1700phase, wait till the result filehandle becomes ready for reading (simply
1701does a C<select> on the filehandle. This is useful if you want to
1702synchronously wait for some requests to finish).
1703
1704See C<nreqs> for an example.
1705
1706=item IO::AIO::poll
1707
1708Waits until some requests have been handled.
1709
1710Returns the number of requests processed, but is otherwise strictly
1711equivalent to:
1712
1713 IO::AIO::poll_wait, IO::AIO::poll_cb
1714
1715=item IO::AIO::flush
1716
1717Wait till all outstanding AIO requests have been handled.
1718
1719Strictly equivalent to:
1720
1721 IO::AIO::poll_wait, IO::AIO::poll_cb
1722 while IO::AIO::nreqs;
1152 1723
1153=item IO::AIO::max_poll_reqs $nreqs 1724=item IO::AIO::max_poll_reqs $nreqs
1154 1725
1155=item IO::AIO::max_poll_time $seconds 1726=item IO::AIO::max_poll_time $seconds
1156 1727
1181 # use a low priority so other tasks have priority 1752 # use a low priority so other tasks have priority
1182 Event->io (fd => IO::AIO::poll_fileno, 1753 Event->io (fd => IO::AIO::poll_fileno,
1183 poll => 'r', nice => 1, 1754 poll => 'r', nice => 1,
1184 cb => &IO::AIO::poll_cb); 1755 cb => &IO::AIO::poll_cb);
1185 1756
1186=item IO::AIO::poll_wait
1187
1188If there are any outstanding requests and none of them in the result
1189phase, wait till the result filehandle becomes ready for reading (simply
1190does a C<select> on the filehandle. This is useful if you want to
1191synchronously wait for some requests to finish).
1192
1193See C<nreqs> for an example.
1194
1195=item IO::AIO::poll
1196
1197Waits until some requests have been handled.
1198
1199Returns the number of requests processed, but is otherwise strictly
1200equivalent to:
1201
1202 IO::AIO::poll_wait, IO::AIO::poll_cb
1203
1204=item IO::AIO::flush
1205
1206Wait till all outstanding AIO requests have been handled.
1207
1208Strictly equivalent to:
1209
1210 IO::AIO::poll_wait, IO::AIO::poll_cb
1211 while IO::AIO::nreqs;
1212
1213=back 1757=back
1214 1758
1215=head3 CONTROLLING THE NUMBER OF THREADS 1759=head3 CONTROLLING THE NUMBER OF THREADS
1216 1760
1217=over 1761=over
1250 1794
1251Under normal circumstances you don't need to call this function. 1795Under normal circumstances you don't need to call this function.
1252 1796
1253=item IO::AIO::max_idle $nthreads 1797=item IO::AIO::max_idle $nthreads
1254 1798
1255Limit the number of threads (default: 4) that are allowed to idle (i.e., 1799Limit the number of threads (default: 4) that are allowed to idle
1256threads that did not get a request to process within 10 seconds). That 1800(i.e., threads that did not get a request to process within the idle
1257means if a thread becomes idle while C<$nthreads> other threads are also 1801timeout (default: 10 seconds). That means if a thread becomes idle while
1258idle, it will free its resources and exit. 1802C<$nthreads> other threads are also idle, it will free its resources and
1803exit.
1259 1804
1260This is useful when you allow a large number of threads (e.g. 100 or 1000) 1805This is useful when you allow a large number of threads (e.g. 100 or 1000)
1261to allow for extremely high load situations, but want to free resources 1806to allow for extremely high load situations, but want to free resources
1262under normal circumstances (1000 threads can easily consume 30MB of RAM). 1807under normal circumstances (1000 threads can easily consume 30MB of RAM).
1263 1808
1264The default is probably ok in most situations, especially if thread 1809The default is probably ok in most situations, especially if thread
1265creation is fast. If thread creation is very slow on your system you might 1810creation is fast. If thread creation is very slow on your system you might
1266want to use larger values. 1811want to use larger values.
1267 1812
1813=item IO::AIO::idle_timeout $seconds
1814
1815Sets the minimum idle timeout (default 10) after which worker threads are
1816allowed to exit. SEe C<IO::AIO::max_idle>.
1817
1268=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1818=item IO::AIO::max_outstanding $maxreqs
1819
1820Sets the maximum number of outstanding requests to C<$nreqs>. If
1821you do queue up more than this number of requests, the next call to
1822C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as
1823C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no
1824longer exceeded.
1825
1826In other words, this setting does not enforce a queue limit, but can be
1827used to make poll functions block if the limit is exceeded.
1269 1828
1270This is a very bad function to use in interactive programs because it 1829This is a very bad function to use in interactive programs because it
1271blocks, and a bad way to reduce concurrency because it is inexact: Better 1830blocks, and a bad way to reduce concurrency because it is inexact: Better
1272use an C<aio_group> together with a feed callback. 1831use an C<aio_group> together with a feed callback.
1273 1832
1274Sets the maximum number of outstanding requests to C<$nreqs>. If you 1833It's main use is in scripts without an event loop - when you want to stat
1275do queue up more than this number of requests, the next call to the 1834a lot of files, you can write somehting like this:
1276C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1277function will block until the limit is no longer exceeded.
1278 1835
1279The default value is very large, so there is no practical limit on the 1836 IO::AIO::max_outstanding 32;
1280number of outstanding requests.
1281 1837
1282You can still queue as many requests as you want. Therefore, 1838 for my $path (...) {
1283C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1839 aio_stat $path , ...;
1284as a stop gap to shield against fatal memory overflow (with large values). 1840 IO::AIO::poll_cb;
1841 }
1842
1843 IO::AIO::flush;
1844
1845The call to C<poll_cb> inside the loop will normally return instantly, but
1846as soon as more thna C<32> reqeusts are in-flight, it will block until
1847some requests have been handled. This keeps the loop from pushing a large
1848number of C<aio_stat> requests onto the queue.
1849
1850The default value for C<max_outstanding> is very large, so there is no
1851practical limit on the number of outstanding requests.
1285 1852
1286=back 1853=back
1287 1854
1288=head3 STATISTICAL INFORMATION 1855=head3 STATISTICAL INFORMATION
1289 1856
1309Returns the number of requests currently in the pending state (executed, 1876Returns the number of requests currently in the pending state (executed,
1310but not yet processed by poll_cb). 1877but not yet processed by poll_cb).
1311 1878
1312=back 1879=back
1313 1880
1881=head3 MISCELLANEOUS FUNCTIONS
1882
1883IO::AIO implements some functions that might be useful, but are not
1884asynchronous.
1885
1886=over 4
1887
1888=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1889
1890Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
1891but is blocking (this makes most sense if you know the input data is
1892likely cached already and the output filehandle is set to non-blocking
1893operations).
1894
1895Returns the number of bytes copied, or C<-1> on error.
1896
1897=item IO::AIO::fadvise $fh, $offset, $len, $advice
1898
1899Simply calls the C<posix_fadvise> function (see its
1900manpage for details). The following advice constants are
1901available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1902C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1903C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1904
1905On systems that do not implement C<posix_fadvise>, this function returns
1906ENOSYS, otherwise the return value of C<posix_fadvise>.
1907
1908=item IO::AIO::madvise $scalar, $offset, $len, $advice
1909
1910Simply calls the C<posix_madvise> function (see its
1911manpage for details). The following advice constants are
1912available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1913C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
1914
1915On systems that do not implement C<posix_madvise>, this function returns
1916ENOSYS, otherwise the return value of C<posix_madvise>.
1917
1918=item IO::AIO::mprotect $scalar, $offset, $len, $protect
1919
1920Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1921$scalar (see its manpage for details). The following protect
1922constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1923C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1924
1925On systems that do not implement C<mprotect>, this function returns
1926ENOSYS, otherwise the return value of C<mprotect>.
1927
1928=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1929
1930Memory-maps a file (or anonymous memory range) and attaches it to the
1931given C<$scalar>, which will act like a string scalar. Returns true on
1932success, and false otherwise.
1933
1934The only operations allowed on the scalar are C<substr>/C<vec> that don't
1935change the string length, and most read-only operations such as copying it
1936or searching it with regexes and so on.
1937
1938Anything else is unsafe and will, at best, result in memory leaks.
1939
1940The memory map associated with the C<$scalar> is automatically removed
1941when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
1942C<IO::AIO::munmap> functions are called.
1943
1944This calls the C<mmap>(2) function internally. See your system's manual
1945page for details on the C<$length>, C<$prot> and C<$flags> parameters.
1946
1947The C<$length> must be larger than zero and smaller than the actual
1948filesize.
1949
1950C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1951C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1952
1953C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
1954C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
1955not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
1956(which is set to C<MAP_ANON> if your system only provides this
1957constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
1958C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
1959C<IO::AIO::MAP_NONBLOCK>
1960
1961If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1962
1963C<$offset> is the offset from the start of the file - it generally must be
1964a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
1965
1966Example:
1967
1968 use Digest::MD5;
1969 use IO::AIO;
1970
1971 open my $fh, "<verybigfile"
1972 or die "$!";
1973
1974 IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
1975 or die "verybigfile: $!";
1976
1977 my $fast_md5 = md5 $data;
1978
1979=item IO::AIO::munmap $scalar
1980
1981Removes a previous mmap and undefines the C<$scalar>.
1982
1983=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
1984
1985Calls the C<munlock> function, undoing the effects of a previous
1986C<aio_mlock> call (see its description for details).
1987
1988=item IO::AIO::munlockall
1989
1990Calls the C<munlockall> function.
1991
1992On systems that do not implement C<munlockall>, this function returns
1993ENOSYS, otherwise the return value of C<munlockall>.
1994
1995=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
1996
1997Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
1998C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
1999should be the file offset.
2000
2001C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
2002silently corrupt the data in this case.
2003
2004The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
2005C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
2006C<IO::AIO::SPLICE_F_GIFT>.
2007
2008See the C<splice(2)> manpage for details.
2009
2010=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
2011
2012Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the
2013description for C<IO::AIO::splice> above for details.
2014
2015=back
2016
1314=cut 2017=cut
1315 2018
1316min_parallel 8; 2019min_parallel 8;
1317 2020
1318END { flush } 2021END { flush }
1319 2022
13201; 20231;
1321 2024
2025=head1 EVENT LOOP INTEGRATION
2026
2027It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
2028automatically into many event loops:
2029
2030 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
2031 use AnyEvent::AIO;
2032
2033You can also integrate IO::AIO manually into many event loops, here are
2034some examples of how to do this:
2035
2036 # EV integration
2037 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
2038
2039 # Event integration
2040 Event->io (fd => IO::AIO::poll_fileno,
2041 poll => 'r',
2042 cb => \&IO::AIO::poll_cb);
2043
2044 # Glib/Gtk2 integration
2045 add_watch Glib::IO IO::AIO::poll_fileno,
2046 in => sub { IO::AIO::poll_cb; 1 };
2047
2048 # Tk integration
2049 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
2050 readable => \&IO::AIO::poll_cb);
2051
2052 # Danga::Socket integration
2053 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
2054 \&IO::AIO::poll_cb);
2055
1322=head2 FORK BEHAVIOUR 2056=head2 FORK BEHAVIOUR
1323 2057
1324This module should do "the right thing" when the process using it forks: 2058Usage of pthreads in a program changes the semantics of fork
2059considerably. Specifically, only async-safe functions can be called after
2060fork. Perl doesn't know about this, so in general, you cannot call fork
2061with defined behaviour in perl if pthreads are involved. IO::AIO uses
2062pthreads, so this applies, but many other extensions and (for inexplicable
2063reasons) perl itself often is linked against pthreads, so this limitation
2064applies to quite a lot of perls.
1325 2065
1326Before the fork, IO::AIO enters a quiescent state where no requests 2066This module no longer tries to fight your OS, or POSIX. That means IO::AIO
1327can be added in other threads and no results will be processed. After 2067only works in the process that loaded it. Forking is fully supported, but
1328the fork the parent simply leaves the quiescent state and continues 2068using IO::AIO in the child is not.
1329request/result processing, while the child frees the request/result queue
1330(so that the requests started before the fork will only be handled in the
1331parent). Threads will be started on demand until the limit set in the
1332parent process has been reached again.
1333 2069
1334In short: the parent will, after a short pause, continue as if fork had 2070You might get around by not I<using> IO::AIO before (or after)
1335not been called, while the child will act as if IO::AIO has not been used 2071forking. You could also try to call the L<IO::AIO::reinit> function in the
1336yet. 2072child:
2073
2074=over 4
2075
2076=item IO::AIO::reinit
2077
2078Abandons all current requests and I/O threads and simply reinitialises all
2079data structures. This is not an operation supported by any standards, but
2080happens to work on GNU/Linux and some newer BSD systems.
2081
2082The only reasonable use for this function is to call it after forking, if
2083C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in
2084the process will result in undefined behaviour. Calling it at any time
2085will also result in any undefined (by POSIX) behaviour.
2086
2087=back
1337 2088
1338=head2 MEMORY USAGE 2089=head2 MEMORY USAGE
1339 2090
1340Per-request usage: 2091Per-request usage:
1341 2092
1358 2109
1359Known bugs will be fixed in the next release. 2110Known bugs will be fixed in the next release.
1360 2111
1361=head1 SEE ALSO 2112=head1 SEE ALSO
1362 2113
1363L<Coro::AIO>. 2114L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2115more natural syntax.
1364 2116
1365=head1 AUTHOR 2117=head1 AUTHOR
1366 2118
1367 Marc Lehmann <schmorp@schmorp.de> 2119 Marc Lehmann <schmorp@schmorp.de>
1368 http://home.schmorp.de/ 2120 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines