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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines