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.67 by root, Tue Oct 24 02:25:16 2006 UTC vs.
Revision 1.162 by root, Sun Jul 26 08:28:36 2009 UTC

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", O_RDONLY, 0, sub {
10 my ($fh) = @_; 10 my $fh = shift
11 or die "/etc/passwd: $!";
11 ... 12 ...
12 }; 13 };
13 14
14 aio_unlink "/tmp/file", sub { }; 15 aio_unlink "/tmp/file", sub { };
15 16
18 }; 19 };
19 20
20 # version 2+ has request and group objects 21 # version 2+ has request and group objects
21 use IO::AIO 2; 22 use IO::AIO 2;
22 23
24 aioreq_pri 4; # give next request a very high priority
23 my $req = aio_unlink "/tmp/file", sub { }; 25 my $req = aio_unlink "/tmp/file", sub { };
24 $req->cancel; # cancel request if still in queue 26 $req->cancel; # cancel request if still in queue
25 27
26 my $grp = aio_group sub { print "all stats done\n" }; 28 my $grp = aio_group sub { print "all stats done\n" };
27 add $grp aio_stat "..." for ...; 29 add $grp aio_stat "..." for ...;
28 30
31 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
32 use AnyEvent::AIO;
33
29 # AnyEvent integration 34 # EV integration
30 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; 35 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
31 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
32 36
33 # Event integration 37 # Event integration
34 Event->io (fd => IO::AIO::poll_fileno, 38 Event->io (fd => IO::AIO::poll_fileno,
35 poll => 'r', 39 poll => 'r',
36 cb => \&IO::AIO::poll_cb); 40 cb => \&IO::AIO::poll_cb);
48 \&IO::AIO::poll_cb); 52 \&IO::AIO::poll_cb);
49 53
50=head1 DESCRIPTION 54=head1 DESCRIPTION
51 55
52This module implements asynchronous I/O using whatever means your 56This module implements asynchronous I/O using whatever means your
53operating system supports. 57operating system supports. It is implemented as an interface to C<libeio>
58(L<http://software.schmorp.de/pkg/libeio.html>).
54 59
60Asynchronous means that operations that can normally block your program
61(e.g. reading from disk) will be done asynchronously: the operation
62will still block, but you can do something else in the meantime. This
63is extremely useful for programs that need to stay interactive even
64when doing heavy I/O (GUI programs, high performance network servers
65etc.), but can also be used to easily do operations in parallel that are
66normally done sequentially, e.g. stat'ing many files, which is much faster
67on a RAID volume or over NFS when you do a number of stat operations
68concurrently.
69
70While most of this works on all types of file descriptors (for
71example sockets), using these functions on file descriptors that
72support nonblocking operation (again, sockets, pipes etc.) is
73very inefficient. Use an event loop for that (such as the L<EV>
74module): IO::AIO will naturally fit into such an event loop itself.
75
55Currently, a number of threads are started that execute your read/writes 76In this version, a number of threads are started that execute your
56and signal their completion. You don't need thread support in perl, and 77requests and signal their completion. You don't need thread support
57the threads created by this module will not be visible to perl. In the 78in perl, and the threads created by this module will not be visible
58future, this module might make use of the native aio functions available 79to perl. In the future, this module might make use of the native aio
59on many operating systems. However, they are often not well-supported 80functions available on many operating systems. However, they are often
60(Linux doesn't allow them on normal files currently, for example), 81not well-supported or restricted (GNU/Linux doesn't allow them on normal
61and they would only support aio_read and aio_write, so the remaining 82files currently, for example), and they would only support aio_read and
62functionality would have to be implemented using threads anyway. 83aio_write, so the remaining functionality would have to be implemented
84using threads anyway.
63 85
64Although the module will work with in the presence of other threads, it is 86Although the module will work in the presence of other (Perl-) threads,
65currently not reentrant, so use appropriate locking yourself, always call 87it is currently not reentrant in any way, so use appropriate locking
66C<poll_cb> from within the same thread, or never call C<poll_cb> (or other 88yourself, always call C<poll_cb> from within the same thread, or never
67C<aio_> functions) recursively. 89call C<poll_cb> (or other C<aio_> functions) recursively.
90
91=head2 EXAMPLE
92
93This is a simple example that uses the EV module and loads
94F</etc/passwd> asynchronously:
95
96 use Fcntl;
97 use EV;
98 use IO::AIO;
99
100 # register the IO::AIO callback with EV
101 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
102
103 # queue the request to open /etc/passwd
104 aio_open "/etc/passwd", O_RDONLY, 0, sub {
105 my $fh = shift
106 or die "error while opening: $!";
107
108 # stat'ing filehandles is generally non-blocking
109 my $size = -s $fh;
110
111 # queue a request to read the file
112 my $contents;
113 aio_read $fh, 0, $size, $contents, 0, sub {
114 $_[0] == $size
115 or die "short read: $!";
116
117 close $fh;
118
119 # file contents now in $contents
120 print $contents;
121
122 # exit event loop and program
123 EV::unloop;
124 };
125 };
126
127 # possibly queue up other requests, or open GUI windows,
128 # check for sockets etc. etc.
129
130 # process events as long as there are some:
131 EV::loop;
132
133=head1 REQUEST ANATOMY AND LIFETIME
134
135Every C<aio_*> function creates a request. which is a C data structure not
136directly visible to Perl.
137
138If called in non-void context, every request function returns a Perl
139object representing the request. In void context, nothing is returned,
140which saves a bit of memory.
141
142The perl object is a fairly standard ref-to-hash object. The hash contents
143are not used by IO::AIO so you are free to store anything you like in it.
144
145During their existance, aio requests travel through the following states,
146in order:
147
148=over 4
149
150=item ready
151
152Immediately after a request is created it is put into the ready state,
153waiting for a thread to execute it.
154
155=item execute
156
157A thread has accepted the request for processing and is currently
158executing it (e.g. blocking in read).
159
160=item pending
161
162The request has been executed and is waiting for result processing.
163
164While request submission and execution is fully asynchronous, result
165processing is not and relies on the perl interpreter calling C<poll_cb>
166(or another function with the same effect).
167
168=item result
169
170The request results are processed synchronously by C<poll_cb>.
171
172The C<poll_cb> function will process all outstanding aio requests by
173calling their callbacks, freeing memory associated with them and managing
174any groups they are contained in.
175
176=item done
177
178Request has reached the end of its lifetime and holds no resources anymore
179(except possibly for the Perl object, but its connection to the actual
180aio request is severed and calling its methods will either do nothing or
181result in a runtime error).
182
183=back
68 184
69=cut 185=cut
70 186
71package IO::AIO; 187package IO::AIO;
72 188
73no warnings; 189use Carp ();
74use strict 'vars'; 190
191use common::sense;
75 192
76use base 'Exporter'; 193use base 'Exporter';
77 194
78BEGIN { 195BEGIN {
79 our $VERSION = '2.0'; 196 our $VERSION = '3.261';
80 197
81 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 198 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
82 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 199 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
83 aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move 200 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
84 aio_group aio_nop); 201 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
202 aio_rename aio_link aio_move aio_copy aio_group
203 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
204 aio_chmod aio_utime aio_truncate);
205
85 our @EXPORT = (@AIO_REQ, qw(aioreq_pri)); 206 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
86 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 207 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
87 min_parallel max_parallel max_outstanding nreqs); 208 min_parallel max_parallel max_idle
209 nreqs nready npending nthreads
210 max_poll_time max_poll_reqs
211 sendfile fadvise);
212
213 push @AIO_REQ, qw(aio_busy); # not exported
88 214
89 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 215 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
90 216
91 require XSLoader; 217 require XSLoader;
92 XSLoader::load ("IO::AIO", $VERSION); 218 XSLoader::load ("IO::AIO", $VERSION);
93} 219}
94 220
95=head1 FUNCTIONS 221=head1 FUNCTIONS
96 222
97=head2 AIO FUNCTIONS 223=head2 AIO REQUEST FUNCTIONS
98 224
99All the C<aio_*> calls are more or less thin wrappers around the syscall 225All the C<aio_*> calls are more or less thin wrappers around the syscall
100with the same name (sans C<aio_>). The arguments are similar or identical, 226with the same name (sans C<aio_>). The arguments are similar or identical,
101and they all accept an additional (and optional) C<$callback> argument 227and they all accept an additional (and optional) C<$callback> argument
102which must be a code reference. This code reference will get called with 228which must be a code reference. This code reference will get called with
103the syscall return code (e.g. most syscalls return C<-1> on error, unlike 229the syscall return code (e.g. most syscalls return C<-1> on error, unlike
104perl, which usually delivers "false") as it's sole argument when the given 230perl, which usually delivers "false") as its sole argument after the given
105syscall has been executed asynchronously. 231syscall has been executed asynchronously.
106 232
107All functions expecting a filehandle keep a copy of the filehandle 233All functions expecting a filehandle keep a copy of the filehandle
108internally until the request has finished. 234internally until the request has finished.
109 235
110All requests return objects of type L<IO::AIO::REQ> that allow further 236All functions return request objects of type L<IO::AIO::REQ> that allow
111manipulation of those requests while they are in-flight. 237further manipulation of those requests while they are in-flight.
112 238
113The pathnames you pass to these routines I<must> be absolute and 239The pathnames you pass to these routines I<must> be absolute and
114encoded in byte form. The reason for the former is that at the time the 240encoded as octets. The reason for the former is that at the time the
115request is being executed, the current working directory could have 241request is being executed, the current working directory could have
116changed. Alternatively, you can make sure that you never change the 242changed. Alternatively, you can make sure that you never change the
117current working directory. 243current working directory anywhere in the program and then use relative
244paths.
118 245
119To encode pathnames to byte form, either make sure you either: a) 246To encode pathnames as octets, either make sure you either: a) always pass
120always pass in filenames you got from outside (command line, readdir 247in filenames you got from outside (command line, readdir etc.) without
121etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode 248tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode
122your pathnames to the locale (or other) encoding in effect in the user 249your pathnames to the locale (or other) encoding in effect in the user
123environment, d) use Glib::filename_from_unicode on unicode filenames or e) 250environment, d) use Glib::filename_from_unicode on unicode filenames or e)
124use something else. 251use something else to ensure your scalar has the correct contents.
252
253This works, btw. independent of the internal UTF-8 bit, which IO::AIO
254handles correctly whether it is set or not.
125 255
126=over 4 256=over 4
257
258=item $prev_pri = aioreq_pri [$pri]
259
260Returns the priority value that would be used for the next request and, if
261C<$pri> is given, sets the priority for the next aio request.
262
263The default priority is C<0>, the minimum and maximum priorities are C<-4>
264and C<4>, respectively. Requests with higher priority will be serviced
265first.
266
267The priority will be reset to C<0> after each call to one of the C<aio_*>
268functions.
269
270Example: open a file with low priority, then read something from it with
271higher priority so the read request is serviced before other low priority
272open requests (potentially spamming the cache):
273
274 aioreq_pri -3;
275 aio_open ..., sub {
276 return unless $_[0];
277
278 aioreq_pri -2;
279 aio_read $_[0], ..., sub {
280 ...
281 };
282 };
283
284
285=item aioreq_nice $pri_adjust
286
287Similar to C<aioreq_pri>, but subtracts the given value from the current
288priority, so the effect is cumulative.
289
127 290
128=item aio_open $pathname, $flags, $mode, $callback->($fh) 291=item aio_open $pathname, $flags, $mode, $callback->($fh)
129 292
130Asynchronously open or create a file and call the callback with a newly 293Asynchronously open or create a file and call the callback with a newly
131created filehandle for the file. 294created filehandle for the file.
137list. They are the same as used by C<sysopen>. 300list. They are the same as used by C<sysopen>.
138 301
139Likewise, C<$mode> specifies the mode of the newly created file, if it 302Likewise, C<$mode> specifies the mode of the newly created file, if it
140didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, 303didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,
141except that it is mandatory (i.e. use C<0> if you don't create new files, 304except that it is mandatory (i.e. use C<0> if you don't create new files,
142and C<0666> or C<0777> if you do). 305and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified
306by the umask in effect then the request is being executed, so better never
307change the umask.
143 308
144Example: 309Example:
145 310
146 aio_open "/etc/passwd", O_RDONLY, 0, sub { 311 aio_open "/etc/passwd", O_RDONLY, 0, sub {
147 if ($_[0]) { 312 if ($_[0]) {
150 } else { 315 } else {
151 die "open failed: $!\n"; 316 die "open failed: $!\n";
152 } 317 }
153 }; 318 };
154 319
320
155=item aio_close $fh, $callback->($status) 321=item aio_close $fh, $callback->($status)
156 322
157Asynchronously close a file and call the callback with the result 323Asynchronously close a file and call the callback with the result
158code. I<WARNING:> although accepted, you should not pass in a perl 324code.
159filehandle here, as perl will likely close the file descriptor another
160time when the filehandle is destroyed. Normally, you can safely call perls
161C<close> or just let filehandles go out of scope.
162 325
163This is supposed to be a bug in the API, so that might change. It's 326Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
164therefore best to avoid this function. 327closing the file descriptor associated with the filehandle itself.
328
329Therefore, C<aio_close> will not close the filehandle - instead it will
330use dup2 to overwrite the file descriptor with the write-end of a pipe
331(the pipe fd will be created on demand and will be cached).
332
333Or in other words: the file descriptor will be closed, but it will not be
334free for reuse until the perl filehandle is closed.
335
336=cut
165 337
166=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 338=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
167 339
168=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 340=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
169 341
170Reads or writes C<length> bytes from the specified C<fh> and C<offset> 342Reads or writes C<$length> bytes from or to the specified C<$fh> and
171into the scalar given by C<data> and offset C<dataoffset> and calls the 343C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
172callback without the actual number of bytes read (or -1 on error, just 344and calls the callback without the actual number of bytes read (or -1 on
173like the syscall). 345error, just like the syscall).
346
347C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
348offset plus the actual number of bytes read.
349
350If C<$offset> is undefined, then the current file descriptor offset will
351be used (and updated), otherwise the file descriptor offset will not be
352changed by these calls.
353
354If C<$length> is undefined in C<aio_write>, use the remaining length of
355C<$data>.
356
357If C<$dataoffset> is less than zero, it will be counted from the end of
358C<$data>.
174 359
175The C<$data> scalar I<MUST NOT> be modified in any way while the request 360The C<$data> scalar I<MUST NOT> be modified in any way while the request
176is outstanding. Modifying it can result in segfaults or WW3 (if the 361is outstanding. Modifying it can result in segfaults or World War III (if
177necessary/optional hardware is installed). 362the necessary/optional hardware is installed).
178 363
179Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at 364Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
180offset C<0> within the scalar: 365offset C<0> within the scalar:
181 366
182 aio_read $fh, 7, 15, $buffer, 0, sub { 367 aio_read $fh, 7, 15, $buffer, 0, sub {
183 $_[0] > 0 or die "read error: $!"; 368 $_[0] > 0 or die "read error: $!";
184 print "read $_[0] bytes: <$buffer>\n"; 369 print "read $_[0] bytes: <$buffer>\n";
185 }; 370 };
186 371
187=item aio_move $srcpath, $dstpath, $callback->($status)
188
189[EXPERIMENTAL due to internal aio_group use]
190
191Try to move the I<file> (directories not supported as either source or
192destination) from C<$srcpath> to C<$dstpath> and call the callback with
193the C<0> (error) or C<-1> ok.
194
195This is a composite request that tries to rename(2) the file first. If
196rename files with C<EXDEV>, it creates the destination file with mode 0200
197and copies the contents of the source file into it using C<aio_sendfile>,
198followed by restoring atime, mtime, access mode and uid/gid, in that
199order, and unlinking the C<$srcpath>.
200
201If an error occurs, the partial destination file will be unlinked, if
202possible, except when setting atime, mtime, access mode and uid/gid, where
203errors are being ignored.
204
205=cut
206
207sub aio_move($$$) {
208 my ($src, $dst, $cb) = @_;
209
210 my $grp = aio_group $cb;
211
212 add $grp aio_rename $src, $dst, sub {
213 if ($_[0] && $! == EXDEV) {
214 add $grp aio_open $src, O_RDONLY, 0, sub {
215 if (my $src_fh = $_[0]) {
216 my @stat = stat $src_fh;
217
218 add $grp aio_open $dst, O_WRONLY, 0200, sub {
219 if (my $dst_fh = $_[0]) {
220 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
221 close $src_fh;
222
223 if ($_[0] == $stat[7]) {
224 utime $stat[8], $stat[9], $dst;
225 chmod $stat[2] & 07777, $dst_fh;
226 chown $stat[4], $stat[5], $dst_fh;
227 close $dst_fh;
228
229 add $grp aio_unlink $src, sub {
230 $grp->result ($_[0]);
231 };
232 } else {
233 my $errno = $!;
234 add $grp aio_unlink $dst, sub {
235 $! = $errno;
236 $grp->result (-1);
237 };
238 }
239 };
240 } else {
241 $grp->result (-1);
242 }
243 },
244
245 } else {
246 $grp->result (-1);
247 }
248 };
249 } else {
250 $grp->result ($_[0]);
251 }
252 };
253
254 $grp
255}
256 372
257=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 373=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
258 374
259Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 375Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
260reading at byte offset C<$in_offset>, and starts writing at the current 376reading at byte offset C<$in_offset>, and starts writing at the current
274C<$in_fh> than are written, and there is no way to find out how many 390C<$in_fh> than are written, and there is no way to find out how many
275bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 391bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
276provides the number of bytes written to C<$out_fh>. Only if the result 392provides the number of bytes written to C<$out_fh>. Only if the result
277value equals C<$length> one can assume that C<$length> bytes have been 393value equals C<$length> one can assume that C<$length> bytes have been
278read. 394read.
395
279 396
280=item aio_readahead $fh,$offset,$length, $callback->($retval) 397=item aio_readahead $fh,$offset,$length, $callback->($retval)
281 398
282C<aio_readahead> populates the page cache with data from a file so that 399C<aio_readahead> populates the page cache with data from a file so that
283subsequent reads from that file will not block on disk I/O. The C<$offset> 400subsequent reads from that file will not block on disk I/O. The C<$offset>
289file. The current file offset of the file is left unchanged. 406file. The current file offset of the file is left unchanged.
290 407
291If that syscall doesn't exist (likely if your OS isn't Linux) it will be 408If that syscall doesn't exist (likely if your OS isn't Linux) it will be
292emulated by simply reading the data, which would have a similar effect. 409emulated by simply reading the data, which would have a similar effect.
293 410
411
294=item aio_stat $fh_or_path, $callback->($status) 412=item aio_stat $fh_or_path, $callback->($status)
295 413
296=item aio_lstat $fh, $callback->($status) 414=item aio_lstat $fh, $callback->($status)
297 415
298Works like perl's C<stat> or C<lstat> in void context. The callback will 416Works like perl's C<stat> or C<lstat> in void context. The callback will
311 aio_stat "/etc/passwd", sub { 429 aio_stat "/etc/passwd", sub {
312 $_[0] and die "stat failed: $!"; 430 $_[0] and die "stat failed: $!";
313 print "size is ", -s _, "\n"; 431 print "size is ", -s _, "\n";
314 }; 432 };
315 433
434
435=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
436
437Works like perl's C<utime> function (including the special case of $atime
438and $mtime being undef). Fractional times are supported if the underlying
439syscalls support them.
440
441When called with a pathname, uses utimes(2) if available, otherwise
442utime(2). If called on a file descriptor, uses futimes(2) if available,
443otherwise returns ENOSYS, so this is not portable.
444
445Examples:
446
447 # set atime and mtime to current time (basically touch(1)):
448 aio_utime "path", undef, undef;
449 # set atime to current time and mtime to beginning of the epoch:
450 aio_utime "path", time, undef; # undef==0
451
452
453=item aio_chown $fh_or_path, $uid, $gid, $callback->($status)
454
455Works like perl's C<chown> function, except that C<undef> for either $uid
456or $gid is being interpreted as "do not change" (but -1 can also be used).
457
458Examples:
459
460 # same as "chown root path" in the shell:
461 aio_chown "path", 0, -1;
462 # same as above:
463 aio_chown "path", 0, undef;
464
465
466=item aio_truncate $fh_or_path, $offset, $callback->($status)
467
468Works like truncate(2) or ftruncate(2).
469
470
471=item aio_chmod $fh_or_path, $mode, $callback->($status)
472
473Works like perl's C<chmod> function.
474
475
316=item aio_unlink $pathname, $callback->($status) 476=item aio_unlink $pathname, $callback->($status)
317 477
318Asynchronously unlink (delete) a file and call the callback with the 478Asynchronously unlink (delete) a file and call the callback with the
319result code. 479result code.
320 480
481
482=item aio_mknod $path, $mode, $dev, $callback->($status)
483
484[EXPERIMENTAL]
485
486Asynchronously create a device node (or fifo). See mknod(2).
487
488The only (POSIX-) portable way of calling this function is:
489
490 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
491
492
321=item aio_link $srcpath, $dstpath, $callback->($status) 493=item aio_link $srcpath, $dstpath, $callback->($status)
322 494
323Asynchronously create a new link to the existing object at C<$srcpath> at 495Asynchronously create a new link to the existing object at C<$srcpath> at
324the path C<$dstpath> and call the callback with the result code. 496the path C<$dstpath> and call the callback with the result code.
325 497
498
326=item aio_symlink $srcpath, $dstpath, $callback->($status) 499=item aio_symlink $srcpath, $dstpath, $callback->($status)
327 500
328Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 501Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
329the path C<$dstpath> and call the callback with the result code. 502the path C<$dstpath> and call the callback with the result code.
330 503
504
505=item aio_readlink $path, $callback->($link)
506
507Asynchronously read the symlink specified by C<$path> and pass it to
508the callback. If an error occurs, nothing or undef gets passed to the
509callback.
510
511
331=item aio_rename $srcpath, $dstpath, $callback->($status) 512=item aio_rename $srcpath, $dstpath, $callback->($status)
332 513
333Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 514Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
334rename(2) and call the callback with the result code. 515rename(2) and call the callback with the result code.
335 516
517
518=item aio_mkdir $pathname, $mode, $callback->($status)
519
520Asynchronously mkdir (create) a directory and call the callback with
521the result code. C<$mode> will be modified by the umask at the time the
522request is executed, so do not change your umask.
523
524
336=item aio_rmdir $pathname, $callback->($status) 525=item aio_rmdir $pathname, $callback->($status)
337 526
338Asynchronously rmdir (delete) a directory and call the callback with the 527Asynchronously rmdir (delete) a directory and call the callback with the
339result code. 528result code.
529
340 530
341=item aio_readdir $pathname, $callback->($entries) 531=item aio_readdir $pathname, $callback->($entries)
342 532
343Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 533Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
344directory (i.e. opendir + readdir + closedir). The entries will not be 534directory (i.e. opendir + readdir + closedir). The entries will not be
345sorted, and will B<NOT> include the C<.> and C<..> entries. 535sorted, and will B<NOT> include the C<.> and C<..> entries.
346 536
347The callback a single argument which is either C<undef> or an array-ref 537The callback is passed a single argument which is either C<undef> or an
348with the filenames. 538array-ref with the filenames.
539
540
541=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
542
543Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune
544behaviour and output format. In case of an error, C<$entries> will be
545C<undef>.
546
547The flags are a combination of the following constants, ORed together (the
548flags will also be passed to the callback, possibly modified):
549
550=over 4
551
552=item IO::AIO::READDIR_DENTS
553
554When this flag is off, then the callback gets an arrayref with of names
555only (as with C<aio_readdir>), otherwise it gets an arrayref with
556C<[$name, $type, $inode]> arrayrefs, each describing a single directory
557entry in more detail.
558
559C<$name> is the name of the entry.
560
561C<$type> is one of the C<IO::AIO::DT_xxx> constants:
562
563C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
564C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
565C<IO::AIO::DT_WHT>.
566
567C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to
568know, you have to run stat yourself. Also, for speed reasons, the C<$type>
569scalars are read-only: you can not modify them.
570
571C<$inode> is the inode number (which might not be exact on systems with 64
572bit inode numbers and 32 bit perls). This field has unspecified content on
573systems that do not deliver the inode information.
574
575=item IO::AIO::READDIR_DIRS_FIRST
576
577When this flag is set, then the names will be returned in an order where
578likely directories come first. This is useful when you need to quickly
579find directories, or you want to find all directories while avoiding to
580stat() each entry.
581
582If the system returns type information in readdir, then this is used
583to find directories directly. Otherwise, likely directories are files
584beginning with ".", or otherwise files with no dots, of which files with
585short names are tried first.
586
587=item IO::AIO::READDIR_STAT_ORDER
588
589When this flag is set, then the names will be returned in an order
590suitable for stat()'ing each one. That is, when you plan to stat()
591all files in the given directory, then the returned order will likely
592be fastest.
593
594If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then
595the likely dirs come first, resulting in a less optimal stat order.
596
597=item IO::AIO::READDIR_FOUND_UNKNOWN
598
599This flag should not be set when calling C<aio_readdirx>. Instead, it
600is being set by C<aio_readdirx>, when any of the C<$type>'s found were
601C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all
602C<$type>'s are known, which can be used to speed up some algorithms.
603
604=back
605
606
607=item aio_load $path, $data, $callback->($status)
608
609This is a composite request that tries to fully load the given file into
610memory. Status is the same as with aio_read.
611
612=cut
613
614sub aio_load($$;$) {
615 my ($path, undef, $cb) = @_;
616 my $data = \$_[1];
617
618 my $pri = aioreq_pri;
619 my $grp = aio_group $cb;
620
621 aioreq_pri $pri;
622 add $grp aio_open $path, O_RDONLY, 0, sub {
623 my $fh = shift
624 or return $grp->result (-1);
625
626 aioreq_pri $pri;
627 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
628 $grp->result ($_[0]);
629 };
630 };
631
632 $grp
633}
634
635=item aio_copy $srcpath, $dstpath, $callback->($status)
636
637Try to copy the I<file> (directories not supported as either source or
638destination) from C<$srcpath> to C<$dstpath> and call the callback with
639the C<0> (error) or C<-1> ok.
640
641This is a composite request that creates the destination file with
642mode 0200 and copies the contents of the source file into it using
643C<aio_sendfile>, followed by restoring atime, mtime, access mode and
644uid/gid, in that order.
645
646If an error occurs, the partial destination file will be unlinked, if
647possible, except when setting atime, mtime, access mode and uid/gid, where
648errors are being ignored.
649
650=cut
651
652sub aio_copy($$;$) {
653 my ($src, $dst, $cb) = @_;
654
655 my $pri = aioreq_pri;
656 my $grp = aio_group $cb;
657
658 aioreq_pri $pri;
659 add $grp aio_open $src, O_RDONLY, 0, sub {
660 if (my $src_fh = $_[0]) {
661 my @stat = stat $src_fh; # hmm, might bock over nfs?
662
663 aioreq_pri $pri;
664 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
665 if (my $dst_fh = $_[0]) {
666 aioreq_pri $pri;
667 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
668 if ($_[0] == $stat[7]) {
669 $grp->result (0);
670 close $src_fh;
671
672 my $ch = sub {
673 aioreq_pri $pri;
674 add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
675 aioreq_pri $pri;
676 add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
677 aioreq_pri $pri;
678 add $grp aio_close $dst_fh;
679 }
680 };
681 };
682
683 aioreq_pri $pri;
684 add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
685 if ($_[0] < 0 && $! == ENOSYS) {
686 aioreq_pri $pri;
687 add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
688 } else {
689 $ch->();
690 }
691 };
692 } else {
693 $grp->result (-1);
694 close $src_fh;
695 close $dst_fh;
696
697 aioreq $pri;
698 add $grp aio_unlink $dst;
699 }
700 };
701 } else {
702 $grp->result (-1);
703 }
704 },
705
706 } else {
707 $grp->result (-1);
708 }
709 };
710
711 $grp
712}
713
714=item aio_move $srcpath, $dstpath, $callback->($status)
715
716Try to move the I<file> (directories not supported as either source or
717destination) from C<$srcpath> to C<$dstpath> and call the callback with
718the C<0> (error) or C<-1> ok.
719
720This is a composite request that tries to rename(2) the file first; if
721rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
722that is successful, unlinks the C<$srcpath>.
723
724=cut
725
726sub aio_move($$;$) {
727 my ($src, $dst, $cb) = @_;
728
729 my $pri = aioreq_pri;
730 my $grp = aio_group $cb;
731
732 aioreq_pri $pri;
733 add $grp aio_rename $src, $dst, sub {
734 if ($_[0] && $! == EXDEV) {
735 aioreq_pri $pri;
736 add $grp aio_copy $src, $dst, sub {
737 $grp->result ($_[0]);
738
739 if (!$_[0]) {
740 aioreq_pri $pri;
741 add $grp aio_unlink $src;
742 }
743 };
744 } else {
745 $grp->result ($_[0]);
746 }
747 };
748
749 $grp
750}
349 751
350=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 752=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
351 753
352[EXPERIMENTAL due to internal aio_group use]
353
354Scans a directory (similar to C<aio_readdir>) but additionally tries to 754Scans a directory (similar to C<aio_readdir>) but additionally tries to
355separate the entries of directory C<$path> into two sets of names, ones 755efficiently separate the entries of directory C<$path> into two sets of
356you can recurse into (directories or links to them), and ones you cannot 756names, directories you can recurse into (directories), and ones you cannot
357recurse into (everything else). 757recurse into (everything else, including symlinks to directories).
358 758
359C<aio_scandir> is a composite request that creates of many sub requests_ 759C<aio_scandir> is a composite request that creates of many sub requests_
360C<$maxreq> specifies the maximum number of outstanding aio requests that 760C<$maxreq> specifies the maximum number of outstanding aio requests that
361this function generates. If it is C<< <= 0 >>, then a suitable default 761this function generates. If it is C<< <= 0 >>, then a suitable default
362will be chosen (currently 6). 762will be chosen (currently 4).
363 763
364On error, the callback is called without arguments, otherwise it receives 764On error, the callback is called without arguments, otherwise it receives
365two array-refs with path-relative entry names. 765two array-refs with path-relative entry names.
366 766
367Example: 767Example:
374 774
375Implementation notes. 775Implementation notes.
376 776
377The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. 777The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
378 778
779If readdir returns file type information, then this is used directly to
780find directories.
781
379After reading the directory, the modification time, size etc. of the 782Otherwise, after reading the directory, the modification time, size etc.
380directory before and after the readdir is checked, and if they match (and 783of the directory before and after the readdir is checked, and if they
381isn't the current time), the link count will be used to decide how many 784match (and isn't the current time), the link count will be used to decide
382entries are directories (if >= 2). Otherwise, no knowledge of the number 785how many entries are directories (if >= 2). Otherwise, no knowledge of the
383of subdirectories will be assumed. 786number of subdirectories will be assumed.
384 787
385Then entries will be sorted into likely directories (everything without 788Then entries will be sorted into likely directories a non-initial dot
386a non-initial dot currently) and likely non-directories (everything 789currently) and likely non-directories (see C<aio_readdirx>). Then every
387else). Then every entry plus an appended C</.> will be C<stat>'ed, 790entry plus an appended C</.> will be C<stat>'ed, likely directories first,
388likely directories first. If that succeeds, it assumes that the entry 791in order of their inode numbers. If that succeeds, it assumes that the
389is a directory or a symlink to directory (which will be checked 792entry is a directory or a symlink to directory (which will be checked
390seperately). This is often faster than stat'ing the entry itself because 793seperately). This is often faster than stat'ing the entry itself because
391filesystems might detect the type of the entry without reading the inode 794filesystems might detect the type of the entry without reading the inode
392data (e.g. ext2fs filetype feature). 795data (e.g. ext2fs filetype feature), even on systems that cannot return
796the filetype information on readdir.
393 797
394If the known number of directories (link count - 2) has been reached, the 798If the known number of directories (link count - 2) has been reached, the
395rest of the entries is assumed to be non-directories. 799rest of the entries is assumed to be non-directories.
396 800
397This only works with certainty on POSIX (= UNIX) filesystems, which 801This only works with certainty on POSIX (= UNIX) filesystems, which
401as those tend to return 0 or 1 as link counts, which disables the 805as those tend to return 0 or 1 as link counts, which disables the
402directory counting heuristic. 806directory counting heuristic.
403 807
404=cut 808=cut
405 809
406sub aio_scandir($$$) { 810sub aio_scandir($$;$) {
407 my ($path, $maxreq, $cb) = @_; 811 my ($path, $maxreq, $cb) = @_;
408 812
813 my $pri = aioreq_pri;
814
409 my $grp = aio_group $cb; 815 my $grp = aio_group $cb;
410 816
411 $maxreq = 6 if $maxreq <= 0; 817 $maxreq = 4 if $maxreq <= 0;
412 818
413 # stat once 819 # stat once
820 aioreq_pri $pri;
414 add $grp aio_stat $path, sub { 821 add $grp aio_stat $path, sub {
415 return $grp->result () if $_[0]; 822 return $grp->result () if $_[0];
416 my $now = time; 823 my $now = time;
417 my $hash1 = join ":", (stat _)[0,1,3,7,9]; 824 my $hash1 = join ":", (stat _)[0,1,3,7,9];
418 825
419 # read the directory entries 826 # read the directory entries
827 aioreq_pri $pri;
420 add $grp aio_readdir $path, sub { 828 add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub {
421 my $entries = shift 829 my $entries = shift
422 or return $grp->result (); 830 or return $grp->result ();
423 831
424 # stat the dir another time 832 # stat the dir another time
833 aioreq_pri $pri;
425 add $grp aio_stat $path, sub { 834 add $grp aio_stat $path, sub {
426 my $hash2 = join ":", (stat _)[0,1,3,7,9]; 835 my $hash2 = join ":", (stat _)[0,1,3,7,9];
427 836
428 my $ndirs; 837 my $ndirs;
429 838
430 # take the slow route if anything looks fishy 839 # take the slow route if anything looks fishy
431 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 840 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
432 $ndirs = -1; 841 $ndirs = -1;
433 } else { 842 } else {
434 # if nlink == 2, we are finished 843 # if nlink == 2, we are finished
435 # on non-posix-fs's, we rely on nlink < 2 844 # for non-posix-fs's, we rely on nlink < 2
436 $ndirs = (stat _)[3] - 2 845 $ndirs = (stat _)[3] - 2
437 or return $grp->result ([], $entries); 846 or return $grp->result ([], $entries);
438 } 847 }
439 848
440 # sort into likely dirs and likely nondirs
441 # dirs == files without ".", short entries first
442 $entries = [map $_->[0],
443 sort { $b->[1] cmp $a->[1] }
444 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
445 @$entries];
446
447 my (@dirs, @nondirs); 849 my (@dirs, @nondirs);
448 850
449 my ($statcb, $schedcb);
450 my $nreq = 0;
451
452 my $statgrp = add $grp aio_group; 851 my $statgrp = add $grp aio_group sub {
852 $grp->result (\@dirs, \@nondirs);
853 };
453 854
454 $schedcb = sub { 855 limit $statgrp $maxreq;
455 if (@$entries) { 856 feed $statgrp sub {
456 if ($nreq < $maxreq) { 857 return unless @$entries;
457 my $ent = pop @$entries; 858 my $entry = shift @$entries;
859
860 aioreq_pri $pri;
861 add $statgrp aio_stat "$path/$entry/.", sub {
862 if ($_[0] < 0) {
863 push @nondirs, $entry;
864 } else {
865 # need to check for real directory
866 aioreq_pri $pri;
867 add $statgrp aio_lstat "$path/$entry", sub {
868 if (-d _) {
869 push @dirs, $entry;
870
871 unless (--$ndirs) {
872 push @nondirs, @$entries;
873 feed $statgrp;
874 }
875 } else {
876 push @nondirs, $entry;
877 }
458 $nreq++; 878 }
459 add $statgrp aio_stat "$path/$ent/.", sub { $statcb->($_[0], $ent) };
460 } 879 }
461 } elsif (!$nreq) {
462 # finished
463 $statgrp->cancel;
464 undef $statcb;
465 undef $schedcb;
466 $grp->result (\@dirs, \@nondirs);
467 } 880 };
468 }; 881 };
469 $statcb = sub {
470 my ($status, $entry) = @_;
471
472 if ($status < 0) {
473 $nreq--;
474 push @nondirs, $entry;
475 &$schedcb;
476 } else {
477 # need to check for real directory
478 add $grp aio_lstat "$path/$entry", sub {
479 $nreq--;
480
481 if (-d _) {
482 push @dirs, $entry;
483
484 if (!--$ndirs) {
485 push @nondirs, @$entries;
486 $entries = [];
487 }
488 } else {
489 push @nondirs, $entry;
490 }
491
492 &$schedcb;
493 }
494 }
495 };
496
497 &$schedcb while @$entries && $nreq < $maxreq;
498 }; 882 };
499 }; 883 };
500 }; 884 };
501 885
502 $grp 886 $grp
503} 887}
504 888
889=item aio_rmtree $path, $callback->($status)
890
891Delete a directory tree starting (and including) C<$path>, return the
892status of the final C<rmdir> only. This is a composite request that
893uses C<aio_scandir> to recurse into and rmdir directories, and unlink
894everything else.
895
896=cut
897
898sub aio_rmtree;
899sub aio_rmtree($;$) {
900 my ($path, $cb) = @_;
901
902 my $pri = aioreq_pri;
903 my $grp = aio_group $cb;
904
905 aioreq_pri $pri;
906 add $grp aio_scandir $path, 0, sub {
907 my ($dirs, $nondirs) = @_;
908
909 my $dirgrp = aio_group sub {
910 add $grp aio_rmdir $path, sub {
911 $grp->result ($_[0]);
912 };
913 };
914
915 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
916 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
917
918 add $grp $dirgrp;
919 };
920
921 $grp
922}
923
924=item aio_sync $callback->($status)
925
926Asynchronously call sync and call the callback when finished.
927
505=item aio_fsync $fh, $callback->($status) 928=item aio_fsync $fh, $callback->($status)
506 929
507Asynchronously call fsync on the given filehandle and call the callback 930Asynchronously call fsync on the given filehandle and call the callback
508with the fsync result code. 931with the fsync result code.
509 932
513callback with the fdatasync result code. 936callback with the fdatasync result code.
514 937
515If this call isn't available because your OS lacks it or it couldn't be 938If this call isn't available because your OS lacks it or it couldn't be
516detected, it will be emulated by calling C<fsync> instead. 939detected, it will be emulated by calling C<fsync> instead.
517 940
941=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
942
943Sync the data portion of the file specified by C<$offset> and C<$length>
944to disk (but NOT the metadata), by calling the Linux-specific
945sync_file_range call. If sync_file_range is not available or it returns
946ENOSYS, then fdatasync or fsync is being substituted.
947
948C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
949C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
950C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
951manpage for details.
952
953=item aio_pathsync $path, $callback->($status)
954
955This request tries to open, fsync and close the given path. This is a
956composite request intended to sync directories after directory operations
957(E.g. rename). This might not work on all operating systems or have any
958specific effect, but usually it makes sure that directory changes get
959written to disc. It works for anything that can be opened for read-only,
960not just directories.
961
962Future versions of this function might fall back to other methods when
963C<fsync> on the directory fails (such as calling C<sync>).
964
965Passes C<0> when everything went ok, and C<-1> on error.
966
967=cut
968
969sub aio_pathsync($;$) {
970 my ($path, $cb) = @_;
971
972 my $pri = aioreq_pri;
973 my $grp = aio_group $cb;
974
975 aioreq_pri $pri;
976 add $grp aio_open $path, O_RDONLY, 0, sub {
977 my ($fh) = @_;
978 if ($fh) {
979 aioreq_pri $pri;
980 add $grp aio_fsync $fh, sub {
981 $grp->result ($_[0]);
982
983 aioreq_pri $pri;
984 add $grp aio_close $fh;
985 };
986 } else {
987 $grp->result (-1);
988 }
989 };
990
991 $grp
992}
993
518=item aio_group $callback->(...) 994=item aio_group $callback->(...)
519
520[EXPERIMENTAL]
521 995
522This is a very special aio request: Instead of doing something, it is a 996This is a very special aio request: Instead of doing something, it is a
523container for other aio requests, which is useful if you want to bundle 997container for other aio requests, which is useful if you want to bundle
524many requests into a single, composite, request. 998many requests into a single, composite, request with a definite callback
999and the ability to cancel the whole request with its subrequests.
525 1000
526Returns an object of class L<IO::AIO::GRP>. See its documentation below 1001Returns an object of class L<IO::AIO::GRP>. See its documentation below
527for more info. 1002for more info.
528 1003
529Example: 1004Example:
548phase and still requires a worker thread. Thus, the callback will not 1023phase and still requires a worker thread. Thus, the callback will not
549be executed immediately but only after other requests in the queue have 1024be executed immediately but only after other requests in the queue have
550entered their execution phase. This can be used to measure request 1025entered their execution phase. This can be used to measure request
551latency. 1026latency.
552 1027
553=item IO::AIO::aio_sleep $fractional_seconds, $callback->() *NOT EXPORTED* 1028=item IO::AIO::aio_busy $fractional_seconds, $callback->() *NOT EXPORTED*
554 1029
555Mainly used for debugging and benchmarking, this aio request puts one of 1030Mainly used for debugging and benchmarking, this aio request puts one of
556the request workers to sleep for the given time. 1031the request workers to sleep for the given time.
557 1032
558While it is theoretically handy to have simple I/O scheduling requests 1033While it is theoretically handy to have simple I/O scheduling requests
559like sleep and file handle readable/writable, the overhead this creates 1034like sleep and file handle readable/writable, the overhead this creates is
560is immense, so do not use this function except to put your application 1035immense (it blocks a thread for a long time) so do not use this function
561under artificial I/O pressure. 1036except to put your application under artificial I/O pressure.
562 1037
563=back 1038=back
564 1039
565=head2 IO::AIO::REQ CLASS 1040=head2 IO::AIO::REQ CLASS
566 1041
567All non-aggregate C<aio_*> functions return an object of this class when 1042All non-aggregate C<aio_*> functions return an object of this class when
568called in non-void context. 1043called in non-void context.
569
570A request always moves through the following five states in its lifetime,
571in order: B<ready> (request has been created, but has not been executed
572yet), B<execute> (request is currently being executed), B<pending>
573(request has been executed but callback has not been called yet),
574B<result> (results are being processed synchronously, includes calling the
575callback) and B<done> (request has reached the end of its lifetime and
576holds no resources anymore).
577 1044
578=over 4 1045=over 4
579 1046
580=item cancel $req 1047=item cancel $req
581 1048
582Cancels the request, if possible. Has the effect of skipping execution 1049Cancels the request, if possible. Has the effect of skipping execution
583when entering the B<execute> state and skipping calling the callback when 1050when entering the B<execute> state and skipping calling the callback when
584entering the the B<result> state, but will leave the request otherwise 1051entering the the B<result> state, but will leave the request otherwise
585untouched. That means that requests that currently execute will not be 1052untouched (with the exception of readdir). That means that requests that
586stopped and resources held by the request will not be freed prematurely. 1053currently execute will not be stopped and resources held by the request
1054will not be freed prematurely.
587 1055
588=item cb $req $callback->(...) 1056=item cb $req $callback->(...)
589 1057
590Replace (or simply set) the callback registered to the request. 1058Replace (or simply set) the callback registered to the request.
591 1059
635=item * They can also can also be added to other IO::AIO::GRP objects. 1103=item * They can also can also be added to other IO::AIO::GRP objects.
636 1104
637=item * You must not add requests to a group from within the group callback (or 1105=item * You must not add requests to a group from within the group callback (or
638any later time). 1106any later time).
639 1107
640=item * This does not harmonise well with C<max_outstanding>, so best do
641not combine C<aio_group> with it. Groups and feeders are recommended for
642this kind of concurrency-limiting.
643
644=back 1108=back
645 1109
646Their lifetime, simplified, looks like this: when they are empty, they 1110Their lifetime, simplified, looks like this: when they are empty, they
647will finish very quickly. If they contain only requests that are in the 1111will finish very quickly. If they contain only requests that are in the
648C<done> state, they will also finish. Otherwise they will continue to 1112C<done> state, they will also finish. Otherwise they will continue to
649exist. 1113exist.
650 1114
651That means after creating a group you have some time to add requests. And 1115That means after creating a group you have some time to add requests
652in the callbacks of those requests, you can add further requests to the 1116(precisely before the callback has been invoked, which is only done within
653group. And only when all those requests have finished will the the group 1117the C<poll_cb>). And in the callbacks of those requests, you can add
654itself finish. 1118further requests to the group. And only when all those requests have
1119finished will the the group itself finish.
655 1120
656=over 4 1121=over 4
657 1122
658=item add $grp ... 1123=item add $grp ...
659 1124
663be added, including other groups, as long as you do not create circular 1128be added, including other groups, as long as you do not create circular
664dependencies. 1129dependencies.
665 1130
666Returns all its arguments. 1131Returns all its arguments.
667 1132
1133=item $grp->cancel_subs
1134
1135Cancel all subrequests and clears any feeder, but not the group request
1136itself. Useful when you queued a lot of events but got a result early.
1137
668=item $grp->result (...) 1138=item $grp->result (...)
669 1139
670Set the result value(s) that will be passed to the group callback when all 1140Set the result value(s) that will be passed to the group callback when all
671subrequests have finished. By default, no argument will be passed. 1141subrequests have finished and set the groups errno to the current value
1142of errno (just like calling C<errno> without an error number). By default,
1143no argument will be passed and errno is zero.
1144
1145=item $grp->errno ([$errno])
1146
1147Sets the group errno value to C<$errno>, or the current value of errno
1148when the argument is missing.
1149
1150Every aio request has an associated errno value that is restored when
1151the callback is invoked. This method lets you change this value from its
1152default (0).
1153
1154Calling C<result> will also set errno, so make sure you either set C<$!>
1155before the call to C<result>, or call c<errno> after it.
672 1156
673=item feed $grp $callback->($grp) 1157=item feed $grp $callback->($grp)
674
675[VERY EXPERIMENTAL]
676 1158
677Sets a feeder/generator on this group: every group can have an attached 1159Sets a feeder/generator on this group: every group can have an attached
678generator that generates requests if idle. The idea behind this is that, 1160generator that generates requests if idle. The idea behind this is that,
679although you could just queue as many requests as you want in a group, 1161although you could just queue as many requests as you want in a group,
680this might starve other requests for a potentially long time. For 1162this might starve other requests for a potentially long time. For example,
681example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1163C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
682requests, delaying any later requests for a long time. 1164delaying any later requests for a long time.
683 1165
684To avoid this, and allow incremental generation of requests, you can 1166To avoid this, and allow incremental generation of requests, you can
685instead a group and set a feeder on it that generates those requests. The 1167instead a group and set a feeder on it that generates those requests. The
686feed callback will be called whenever there are few enough (see C<feed_limit>, 1168feed callback will be called whenever there are few enough (see C<limit>,
687below) requests active in the group itself and is expected to queue more 1169below) requests active in the group itself and is expected to queue more
688requests. 1170requests.
689 1171
690The feed can queue as many requests as it likes (i.e. C<add> does not 1172The feed callback can queue as many requests as it likes (i.e. C<add> does
691impose any limits). 1173not impose any limits).
692 1174
693If the feed does not queue more requests when called, it will be 1175If the feed does not queue more requests when called, it will be
694automatically removed from the group. 1176automatically removed from the group.
695 1177
696If the feed limit is C<0>, it will be set to C<2> automatically. 1178If the feed limit is C<0> when this method is called, it will be set to
1179C<2> automatically.
697 1180
698Example: 1181Example:
699 1182
700 # stat all files in @files, but only ever use four aio requests concurrently: 1183 # stat all files in @files, but only ever use four aio requests concurrently:
701 1184
702 my $grp = aio_group sub { print "finished\n" }; 1185 my $grp = aio_group sub { print "finished\n" };
703 feed_limit $grp 4; 1186 limit $grp 4;
704 feed $grp sub { 1187 feed $grp sub {
705 my $file = pop @files 1188 my $file = pop @files
706 or return; 1189 or return;
707 1190
708 add $grp aio_stat $file, sub { ... }; 1191 add $grp aio_stat $file, sub { ... };
709 }; 1192 };
710 1193
711=item feed_limit $grp $num 1194=item limit $grp $num
712 1195
713Sets the feeder limit for the group: The feeder will be called whenever 1196Sets the feeder limit for the group: The feeder will be called whenever
714the group contains less than this many requests. 1197the group contains less than this many requests.
715 1198
716Setting the limit to C<0> will pause the feeding process. 1199Setting the limit to C<0> will pause the feeding process.
717 1200
1201The default value for the limit is C<0>, but note that setting a feeder
1202automatically bumps it up to C<2>.
1203
718=back 1204=back
719 1205
720=head2 SUPPORT FUNCTIONS 1206=head2 SUPPORT FUNCTIONS
721 1207
1208=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1209
722=over 4 1210=over 4
723 1211
724=item $fileno = IO::AIO::poll_fileno 1212=item $fileno = IO::AIO::poll_fileno
725 1213
726Return the I<request result pipe file descriptor>. This filehandle must be 1214Return the I<request result pipe file descriptor>. This filehandle must be
727polled for reading by some mechanism outside this module (e.g. Event or 1215polled for reading by some mechanism outside this module (e.g. EV, Glib,
728select, see below or the SYNOPSIS). If the pipe becomes readable you have 1216select and so on, see below or the SYNOPSIS). If the pipe becomes readable
729to call C<poll_cb> to check the results. 1217you have to call C<poll_cb> to check the results.
730 1218
731See C<poll_cb> for an example. 1219See C<poll_cb> for an example.
732 1220
733=item IO::AIO::poll_cb 1221=item IO::AIO::poll_cb
734 1222
735Process all outstanding events on the result pipe. You have to call this 1223Process some outstanding events on the result pipe. You have to call this
736regularly. Returns the number of events processed. Returns immediately 1224regularly. Returns C<0> if all events could be processed, or C<-1> if it
737when no events are outstanding. 1225returned earlier for whatever reason. Returns immediately when no events
1226are outstanding. The amount of events processed depends on the settings of
1227C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1228
1229If not all requests were processed for whatever reason, the filehandle
1230will still be ready when C<poll_cb> returns, so normally you don't have to
1231do anything special to have it called later.
738 1232
739Example: Install an Event watcher that automatically calls 1233Example: Install an Event watcher that automatically calls
740IO::AIO::poll_cb with high priority: 1234IO::AIO::poll_cb with high priority (more examples can be found in the
1235SYNOPSIS section, at the top of this document):
741 1236
742 Event->io (fd => IO::AIO::poll_fileno, 1237 Event->io (fd => IO::AIO::poll_fileno,
743 poll => 'r', async => 1, 1238 poll => 'r', async => 1,
744 cb => \&IO::AIO::poll_cb); 1239 cb => \&IO::AIO::poll_cb);
745 1240
1241=item IO::AIO::max_poll_reqs $nreqs
1242
1243=item IO::AIO::max_poll_time $seconds
1244
1245These set the maximum number of requests (default C<0>, meaning infinity)
1246that are being processed by C<IO::AIO::poll_cb> in one call, respectively
1247the maximum amount of time (default C<0>, meaning infinity) spent in
1248C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
1249of time C<poll_cb> is allowed to use).
1250
1251Setting C<max_poll_time> to a non-zero value creates an overhead of one
1252syscall per request processed, which is not normally a problem unless your
1253callbacks are really really fast or your OS is really really slow (I am
1254not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
1255
1256Setting these is useful if you want to ensure some level of
1257interactiveness when perl is not fast enough to process all requests in
1258time.
1259
1260For interactive programs, values such as C<0.01> to C<0.1> should be fine.
1261
1262Example: Install an Event watcher that automatically calls
1263IO::AIO::poll_cb with low priority, to ensure that other parts of the
1264program get the CPU sometimes even under high AIO load.
1265
1266 # try not to spend much more than 0.1s in poll_cb
1267 IO::AIO::max_poll_time 0.1;
1268
1269 # use a low priority so other tasks have priority
1270 Event->io (fd => IO::AIO::poll_fileno,
1271 poll => 'r', nice => 1,
1272 cb => &IO::AIO::poll_cb);
1273
746=item IO::AIO::poll_wait 1274=item IO::AIO::poll_wait
747 1275
1276If there are any outstanding requests and none of them in the result
748Wait till the result filehandle becomes ready for reading (simply does a 1277phase, wait till the result filehandle becomes ready for reading (simply
749C<select> on the filehandle. This is useful if you want to synchronously wait 1278does a C<select> on the filehandle. This is useful if you want to
750for some requests to finish). 1279synchronously wait for some requests to finish).
751 1280
752See C<nreqs> for an example. 1281See C<nreqs> for an example.
753 1282
1283=item IO::AIO::poll
1284
1285Waits until some requests have been handled.
1286
1287Returns the number of requests processed, but is otherwise strictly
1288equivalent to:
1289
1290 IO::AIO::poll_wait, IO::AIO::poll_cb
1291
754=item IO::AIO::nreqs 1292=item IO::AIO::flush
755 1293
756Returns the number of requests currently outstanding (i.e. for which their 1294Wait till all outstanding AIO requests have been handled.
757callback has not been invoked yet).
758 1295
759Example: wait till there are no outstanding requests anymore: 1296Strictly equivalent to:
760 1297
761 IO::AIO::poll_wait, IO::AIO::poll_cb 1298 IO::AIO::poll_wait, IO::AIO::poll_cb
762 while IO::AIO::nreqs; 1299 while IO::AIO::nreqs;
763 1300
764=item IO::AIO::flush 1301=back
765 1302
766Wait till all outstanding AIO requests have been handled. 1303=head3 CONTROLLING THE NUMBER OF THREADS
767 1304
768Strictly equivalent to: 1305=over
769
770 IO::AIO::poll_wait, IO::AIO::poll_cb
771 while IO::AIO::nreqs;
772
773=item IO::AIO::poll
774
775Waits until some requests have been handled.
776
777Strictly equivalent to:
778
779 IO::AIO::poll_wait, IO::AIO::poll_cb
780 if IO::AIO::nreqs;
781 1306
782=item IO::AIO::min_parallel $nthreads 1307=item IO::AIO::min_parallel $nthreads
783 1308
784Set the minimum number of AIO threads to C<$nthreads>. The current 1309Set the minimum number of AIO threads to C<$nthreads>. The current
785default is C<8>, which means eight asynchronous operations can execute 1310default is C<8>, which means eight asynchronous operations can execute
786concurrently at any one time (the number of outstanding requests, 1311concurrently at any one time (the number of outstanding requests,
787however, is unlimited). 1312however, is unlimited).
788 1313
789IO::AIO starts threads only on demand, when an AIO request is queued and 1314IO::AIO starts threads only on demand, when an AIO request is queued and
790no free thread exists. 1315no free thread exists. Please note that queueing up a hundred requests can
1316create demand for a hundred threads, even if it turns out that everything
1317is in the cache and could have been processed faster by a single thread.
791 1318
792It is recommended to keep the number of threads relatively low, as some 1319It is recommended to keep the number of threads relatively low, as some
793Linux kernel versions will scale negatively with the number of threads 1320Linux kernel versions will scale negatively with the number of threads
794(higher parallelity => MUCH higher latency). With current Linux 2.6 1321(higher parallelity => MUCH higher latency). With current Linux 2.6
795versions, 4-32 threads should be fine. 1322versions, 4-32 threads should be fine.
809This module automatically runs C<max_parallel 0> at program end, to ensure 1336This module automatically runs C<max_parallel 0> at program end, to ensure
810that all threads are killed and that there are no outstanding requests. 1337that all threads are killed and that there are no outstanding requests.
811 1338
812Under normal circumstances you don't need to call this function. 1339Under normal circumstances you don't need to call this function.
813 1340
1341=item IO::AIO::max_idle $nthreads
1342
1343Limit the number of threads (default: 4) that are allowed to idle (i.e.,
1344threads that did not get a request to process within 10 seconds). That
1345means if a thread becomes idle while C<$nthreads> other threads are also
1346idle, it will free its resources and exit.
1347
1348This is useful when you allow a large number of threads (e.g. 100 or 1000)
1349to allow for extremely high load situations, but want to free resources
1350under normal circumstances (1000 threads can easily consume 30MB of RAM).
1351
1352The default is probably ok in most situations, especially if thread
1353creation is fast. If thread creation is very slow on your system you might
1354want to use larger values.
1355
814=item $oldnreqs = IO::AIO::max_outstanding $nreqs 1356=item IO::AIO::max_outstanding $maxreqs
815 1357
816[DEPRECATED] 1358This is a very bad function to use in interactive programs because it
1359blocks, and a bad way to reduce concurrency because it is inexact: Better
1360use an C<aio_group> together with a feed callback.
817 1361
818Sets the maximum number of outstanding requests to C<$nreqs>. If you 1362Sets the maximum number of outstanding requests to C<$nreqs>. If you
819try to queue up more than this number of requests, the caller will block until 1363do queue up more than this number of requests, the next call to the
820some requests have been handled. 1364C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1365function will block until the limit is no longer exceeded.
821 1366
822The default is very large, so normally there is no practical limit. If you 1367The default value is very large, so there is no practical limit on the
823queue up many requests in a loop it often improves speed if you set 1368number of outstanding requests.
824this to a relatively low number, such as C<100>.
825 1369
826This function does not work well together with C<aio_group>'s, and their 1370You can still queue as many requests as you want. Therefore,
827feeder interface is better suited to limiting concurrency, so do not use 1371C<max_outstanding> is mainly useful in simple scripts (with low values) or
828this function. 1372as a stop gap to shield against fatal memory overflow (with large values).
829
830Under normal circumstances you don't need to call this function.
831 1373
832=back 1374=back
833 1375
1376=head3 STATISTICAL INFORMATION
1377
1378=over
1379
1380=item IO::AIO::nreqs
1381
1382Returns the number of requests currently in the ready, execute or pending
1383states (i.e. for which their callback has not been invoked yet).
1384
1385Example: wait till there are no outstanding requests anymore:
1386
1387 IO::AIO::poll_wait, IO::AIO::poll_cb
1388 while IO::AIO::nreqs;
1389
1390=item IO::AIO::nready
1391
1392Returns the number of requests currently in the ready state (not yet
1393executed).
1394
1395=item IO::AIO::npending
1396
1397Returns the number of requests currently in the pending state (executed,
1398but not yet processed by poll_cb).
1399
1400=back
1401
1402=head3 MISCELLANEOUS FUNCTIONS
1403
1404IO::AIO implements some functions that might be useful, but are not
1405asynchronous.
1406
1407=over 4
1408
1409=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1410
1411Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
1412but is blocking (this makes most sense if you know the input data is
1413likely cached already and the output filehandle is set to non-blocking
1414operations).
1415
1416Returns the number of bytes copied, or C<-1> on error.
1417
1418=item IO::AIO::fadvise $fh, $offset, $len, $advice
1419
1420Simply calls the C<posix_fadvise> function (see it's
1421manpage for details). The following advice constants are
1422avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1423C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1424C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1425
1426On systems that do not implement C<posix_fadvise>, this function returns
1427ENOSYS, otherwise the return value of C<posix_fadvise>.
1428
1429=back
1430
834=cut 1431=cut
835 1432
836# support function to convert a fd into a perl filehandle
837sub _fd2fh {
838 return undef if $_[0] < 0;
839
840 # try to generate nice filehandles
841 my $sym = "IO::AIO::fd#$_[0]";
842 local *$sym;
843
844 open *$sym, "+<&=$_[0]" # usually works under any unix
845 or open *$sym, "<&=$_[0]" # cygwin needs this
846 or open *$sym, ">&=$_[0]" # or this
847 or return undef;
848
849 *$sym
850}
851
852min_parallel 8; 1433min_parallel 8;
853 1434
854END { 1435END { flush }
855 max_parallel 0;
856}
857 1436
8581; 14371;
859 1438
860=head2 FORK BEHAVIOUR 1439=head2 FORK BEHAVIOUR
861 1440
862This module should do "the right thing" when the process using it forks: 1441This module should do "the right thing" when the process using it forks:
863 1442
864Before the fork, IO::AIO enters a quiescent state where no requests 1443Before the fork, IO::AIO enters a quiescent state where no requests
865can be added in other threads and no results will be processed. After 1444can be added in other threads and no results will be processed. After
866the fork the parent simply leaves the quiescent state and continues 1445the fork the parent simply leaves the quiescent state and continues
867request/result processing, while the child clears the request/result 1446request/result processing, while the child frees the request/result queue
868queue (so the requests started before the fork will only be handled in 1447(so that the requests started before the fork will only be handled in the
869the parent). Threads will be started on demand until the limit ste in the 1448parent). Threads will be started on demand until the limit set in the
870parent process has been reached again. 1449parent process has been reached again.
871 1450
872In short: the parent will, after a short pause, continue as if fork had 1451In short: the parent will, after a short pause, continue as if fork had
873not been called, while the child will act as if IO::AIO has not been used 1452not been called, while the child will act as if IO::AIO has not been used
874yet. 1453yet.
875 1454
876=head2 MEMORY USAGE 1455=head2 MEMORY USAGE
877 1456
1457Per-request usage:
1458
878Each aio request uses - depending on your architecture - around 128 bytes 1459Each aio request uses - depending on your architecture - around 100-200
879of memory. In addition, stat requests need a stat buffer (possibly a few 1460bytes of memory. In addition, stat requests need a stat buffer (possibly
880hundred bytes). Perl scalars and other data passed into aio requests will 1461a few hundred bytes), readdir requires a result buffer and so on. Perl
881also be locked. 1462scalars and other data passed into aio requests will also be locked and
1463will consume memory till the request has entered the done state.
882 1464
883This is now awfully much, so queuing lots of requests is not usually a 1465This is not awfully much, so queuing lots of requests is not usually a
884problem. 1466problem.
885 1467
886Each thread needs a stack area which is usually around 16k, sometimes much 1468Per-thread usage:
887larger, depending on the OS. 1469
1470In the execution phase, some aio requests require more memory for
1471temporary buffers, and each thread requires a stack and other data
1472structures (usually around 16k-128k, depending on the OS).
1473
1474=head1 KNOWN BUGS
1475
1476Known bugs will be fixed in the next release.
888 1477
889=head1 SEE ALSO 1478=head1 SEE ALSO
890 1479
891L<Coro>, L<Linux::AIO> (obsolete). 1480L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1481more natural syntax.
892 1482
893=head1 AUTHOR 1483=head1 AUTHOR
894 1484
895 Marc Lehmann <schmorp@schmorp.de> 1485 Marc Lehmann <schmorp@schmorp.de>
896 http://home.schmorp.de/ 1486 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines