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.81 by root, Fri Oct 27 19:17:23 2006 UTC vs.
Revision 1.147 by root, Wed Jun 3 12:24:49 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
… …
25 $req->cancel; # cancel request if still in queue 26 $req->cancel; # cancel request if still in queue
26 27
27 my $grp = aio_group sub { print "all stats done\n" }; 28 my $grp = aio_group sub { print "all stats done\n" };
28 add $grp aio_stat "..." for ...; 29 add $grp aio_stat "..." for ...;
29 30
31 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
32 use AnyEvent::AIO;
33
30 # AnyEvent integration 34 # EV integration
31 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; 35 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
32 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
33 36
34 # Event integration 37 # Event integration
35 Event->io (fd => IO::AIO::poll_fileno, 38 Event->io (fd => IO::AIO::poll_fileno,
36 poll => 'r', 39 poll => 'r',
37 cb => \&IO::AIO::poll_cb); 40 cb => \&IO::AIO::poll_cb);
… …
50 53
51=head1 DESCRIPTION 54=head1 DESCRIPTION
52 55
53This module implements asynchronous I/O using whatever means your 56This module implements asynchronous I/O using whatever means your
54operating system supports. 57operating system supports.
58
59Asynchronous means that operations that can normally block your program
60(e.g. reading from disk) will be done asynchronously: the operation
61will still block, but you can do something else in the meantime. This
62is extremely useful for programs that need to stay interactive even
63when doing heavy I/O (GUI programs, high performance network servers
64etc.), but can also be used to easily do operations in parallel that are
65normally done sequentially, e.g. stat'ing many files, which is much faster
66on a RAID volume or over NFS when you do a number of stat operations
67concurrently.
68
69While most of this works on all types of file descriptors (for
70example sockets), using these functions on file descriptors that
71support nonblocking operation (again, sockets, pipes etc.) is very
72inefficient. Use an event loop for that (such as the L<Event|Event>
73module): IO::AIO will naturally fit into such an event loop itself.
55 74
56In this version, a number of threads are started that execute your 75In this version, a number of threads are started that execute your
57requests and signal their completion. You don't need thread support 76requests and signal their completion. You don't need thread support
58in perl, and the threads created by this module will not be visible 77in perl, and the threads created by this module will not be visible
59to perl. In the future, this module might make use of the native aio 78to perl. In the future, this module might make use of the native aio
60functions available on many operating systems. However, they are often 79functions available on many operating systems. However, they are often
61not well-supported or restricted (Linux doesn't allow them on normal 80not well-supported or restricted (GNU/Linux doesn't allow them on normal
62files currently, for example), and they would only support aio_read and 81files currently, for example), and they would only support aio_read and
63aio_write, so the remaining functionality would have to be implemented 82aio_write, so the remaining functionality would have to be implemented
64using threads anyway. 83using threads anyway.
65 84
66Although the module will work with in the presence of other (Perl-) 85Although the module will work in the presence of other (Perl-) threads,
67threads, it is currently not reentrant in any way, so use appropriate 86it is currently not reentrant in any way, so use appropriate locking
68locking yourself, always call C<poll_cb> from within the same thread, or 87yourself, always call C<poll_cb> from within the same thread, or never
69never call C<poll_cb> (or other C<aio_> functions) recursively. 88call C<poll_cb> (or other C<aio_> functions) recursively.
89
90=head2 EXAMPLE
91
92This is a simple example that uses the Event module and loads
93F</etc/passwd> asynchronously:
94
95 use Fcntl;
96 use Event;
97 use IO::AIO;
98
99 # register the IO::AIO callback with Event
100 Event->io (fd => IO::AIO::poll_fileno,
101 poll => 'r',
102 cb => \&IO::AIO::poll_cb);
103
104 # queue the request to open /etc/passwd
105 aio_open "/etc/passwd", O_RDONLY, 0, sub {
106 my $fh = shift
107 or die "error while opening: $!";
108
109 # stat'ing filehandles is generally non-blocking
110 my $size = -s $fh;
111
112 # queue a request to read the file
113 my $contents;
114 aio_read $fh, 0, $size, $contents, 0, sub {
115 $_[0] == $size
116 or die "short read: $!";
117
118 close $fh;
119
120 # file contents now in $contents
121 print $contents;
122
123 # exit event loop and program
124 Event::unloop;
125 };
126 };
127
128 # possibly queue up other requests, or open GUI windows,
129 # check for sockets etc. etc.
130
131 # process events as long as there are some:
132 Event::loop;
70 133
71=head1 REQUEST ANATOMY AND LIFETIME 134=head1 REQUEST ANATOMY AND LIFETIME
72 135
73Every C<aio_*> function creates a request. which is a C data structure not 136Every C<aio_*> function creates a request. which is a C data structure not
74directly visible to Perl. 137directly visible to Perl.
… …
116Request has reached the end of its lifetime and holds no resources anymore 179Request has reached the end of its lifetime and holds no resources anymore
117(except possibly for the Perl object, but its connection to the actual 180(except possibly for the Perl object, but its connection to the actual
118aio request is severed and calling its methods will either do nothing or 181aio request is severed and calling its methods will either do nothing or
119result in a runtime error). 182result in a runtime error).
120 183
184=back
185
121=cut 186=cut
122 187
123package IO::AIO; 188package IO::AIO;
189
190use Carp ();
124 191
125no warnings; 192no warnings;
126use strict 'vars'; 193use strict 'vars';
127 194
128use base 'Exporter'; 195use base 'Exporter';
129 196
130BEGIN { 197BEGIN {
131 our $VERSION = '2.0'; 198 our $VERSION = '3.19';
132 199
133 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 200 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
134 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
135 aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move 202 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
136 aio_group aio_nop); 203 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
204 aio_rename aio_link aio_move aio_copy aio_group
205 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
206 aio_chmod aio_utime aio_truncate);
207
137 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 208 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
138 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 209 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
139 min_parallel max_parallel nreqs nready npending); 210 min_parallel max_parallel max_idle
211 nreqs nready npending nthreads
212 max_poll_time max_poll_reqs);
213
214 push @AIO_REQ, qw(aio_busy); # not exported
140 215
141 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 216 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
142 217
143 require XSLoader; 218 require XSLoader;
144 XSLoader::load ("IO::AIO", $VERSION); 219 XSLoader::load ("IO::AIO", $VERSION);
145} 220}
146 221
147=head1 FUNCTIONS 222=head1 FUNCTIONS
148 223
149=head2 AIO FUNCTIONS 224=head2 AIO REQUEST FUNCTIONS
150 225
151All the C<aio_*> calls are more or less thin wrappers around the syscall 226All the C<aio_*> calls are more or less thin wrappers around the syscall
152with the same name (sans C<aio_>). The arguments are similar or identical, 227with the same name (sans C<aio_>). The arguments are similar or identical,
153and they all accept an additional (and optional) C<$callback> argument 228and they all accept an additional (and optional) C<$callback> argument
154which must be a code reference. This code reference will get called with 229which must be a code reference. This code reference will get called with
155the syscall return code (e.g. most syscalls return C<-1> on error, unlike 230the syscall return code (e.g. most syscalls return C<-1> on error, unlike
156perl, which usually delivers "false") as it's sole argument when the given 231perl, which usually delivers "false") as its sole argument after the given
157syscall has been executed asynchronously. 232syscall has been executed asynchronously.
158 233
159All functions expecting a filehandle keep a copy of the filehandle 234All functions expecting a filehandle keep a copy of the filehandle
160internally until the request has finished. 235internally until the request has finished.
161 236
162All requests return objects of type L<IO::AIO::REQ> that allow further 237All functions return request objects of type L<IO::AIO::REQ> that allow
163manipulation of those requests while they are in-flight. 238further manipulation of those requests while they are in-flight.
164 239
165The pathnames you pass to these routines I<must> be absolute and 240The pathnames you pass to these routines I<must> be absolute and
166encoded in byte form. The reason for the former is that at the time the 241encoded as octets. The reason for the former is that at the time the
167request is being executed, the current working directory could have 242request is being executed, the current working directory could have
168changed. Alternatively, you can make sure that you never change the 243changed. Alternatively, you can make sure that you never change the
169current working directory. 244current working directory anywhere in the program and then use relative
245paths.
170 246
171To encode pathnames to byte form, either make sure you either: a) 247To encode pathnames as octets, either make sure you either: a) always pass
172always pass in filenames you got from outside (command line, readdir 248in filenames you got from outside (command line, readdir etc.) without
173etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode 249tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode
174your pathnames to the locale (or other) encoding in effect in the user 250your pathnames to the locale (or other) encoding in effect in the user
175environment, d) use Glib::filename_from_unicode on unicode filenames or e) 251environment, d) use Glib::filename_from_unicode on unicode filenames or e)
176use something else. 252use something else to ensure your scalar has the correct contents.
253
254This works, btw. independent of the internal UTF-8 bit, which IO::AIO
255handles correctly whether it is set or not.
177 256
178=over 4 257=over 4
179 258
180=item $prev_pri = aioreq_pri [$pri] 259=item $prev_pri = aioreq_pri [$pri]
181 260
… …
201 aio_read $_[0], ..., sub { 280 aio_read $_[0], ..., sub {
202 ... 281 ...
203 }; 282 };
204 }; 283 };
205 284
285
206=item aioreq_nice $pri_adjust 286=item aioreq_nice $pri_adjust
207 287
208Similar to C<aioreq_pri>, but subtracts the given value from the current 288Similar to C<aioreq_pri>, but subtracts the given value from the current
209priority, so effects are cumulative. 289priority, so the effect is cumulative.
290
210 291
211=item aio_open $pathname, $flags, $mode, $callback->($fh) 292=item aio_open $pathname, $flags, $mode, $callback->($fh)
212 293
213Asynchronously open or create a file and call the callback with a newly 294Asynchronously open or create a file and call the callback with a newly
214created filehandle for the file. 295created filehandle for the file.
… …
220list. They are the same as used by C<sysopen>. 301list. They are the same as used by C<sysopen>.
221 302
222Likewise, C<$mode> specifies the mode of the newly created file, if it 303Likewise, C<$mode> specifies the mode of the newly created file, if it
223didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, 304didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,
224except that it is mandatory (i.e. use C<0> if you don't create new files, 305except that it is mandatory (i.e. use C<0> if you don't create new files,
225and C<0666> or C<0777> if you do). 306and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified
307by the umask in effect then the request is being executed, so better never
308change the umask.
226 309
227Example: 310Example:
228 311
229 aio_open "/etc/passwd", O_RDONLY, 0, sub { 312 aio_open "/etc/passwd", O_RDONLY, 0, sub {
230 if ($_[0]) { 313 if ($_[0]) {
… …
233 } else { 316 } else {
234 die "open failed: $!\n"; 317 die "open failed: $!\n";
235 } 318 }
236 }; 319 };
237 320
321
238=item aio_close $fh, $callback->($status) 322=item aio_close $fh, $callback->($status)
239 323
240Asynchronously close a file and call the callback with the result 324Asynchronously close a file and call the callback with the result
241code. I<WARNING:> although accepted, you should not pass in a perl 325code.
242filehandle here, as perl will likely close the file descriptor another
243time when the filehandle is destroyed. Normally, you can safely call perls
244C<close> or just let filehandles go out of scope.
245 326
246This is supposed to be a bug in the API, so that might change. It's 327Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
247therefore best to avoid this function. 328closing the file descriptor associated with the filehandle itself.
329
330Therefore, C<aio_close> will not close the filehandle - instead it will
331use dup2 to overwrite the file descriptor with the write-end of a pipe
332(the pipe fd will be created on demand and will be cached).
333
334Or in other words: the file descriptor will be closed, but it will not be
335free for reuse until the perl filehandle is closed.
336
337=cut
248 338
249=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
250 340
251=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 341=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
252 342
253Reads or writes C<length> bytes from the specified C<fh> and C<offset> 343Reads or writes C<$length> bytes from or to the specified C<$fh> and
254into the scalar given by C<data> and offset C<dataoffset> and calls the 344C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
255callback without the actual number of bytes read (or -1 on error, just 345and calls the callback without the actual number of bytes read (or -1 on
256like the syscall). 346error, just like the syscall).
347
348C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
349offset plus the actual number of bytes read.
350
351If C<$offset> is undefined, then the current file descriptor offset will
352be used (and updated), otherwise the file descriptor offset will not be
353changed by these calls.
354
355If C<$length> is undefined in C<aio_write>, use the remaining length of
356C<$data>.
357
358If C<$dataoffset> is less than zero, it will be counted from the end of
359C<$data>.
257 360
258The C<$data> scalar I<MUST NOT> be modified in any way while the request 361The C<$data> scalar I<MUST NOT> be modified in any way while the request
259is outstanding. Modifying it can result in segfaults or WW3 (if the 362is outstanding. Modifying it can result in segfaults or World War III (if
260necessary/optional hardware is installed). 363the necessary/optional hardware is installed).
261 364
262Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at 365Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
263offset C<0> within the scalar: 366offset C<0> within the scalar:
264 367
265 aio_read $fh, 7, 15, $buffer, 0, sub { 368 aio_read $fh, 7, 15, $buffer, 0, sub {
266 $_[0] > 0 or die "read error: $!"; 369 $_[0] > 0 or die "read error: $!";
267 print "read $_[0] bytes: <$buffer>\n"; 370 print "read $_[0] bytes: <$buffer>\n";
268 }; 371 };
269 372
270=item aio_move $srcpath, $dstpath, $callback->($status)
271
272Try to move the I<file> (directories not supported as either source or
273destination) from C<$srcpath> to C<$dstpath> and call the callback with
274the C<0> (error) or C<-1> ok.
275
276This is a composite request that tries to rename(2) the file first. If
277rename files with C<EXDEV>, it creates the destination file with mode 0200
278and copies the contents of the source file into it using C<aio_sendfile>,
279followed by restoring atime, mtime, access mode and uid/gid, in that
280order, and unlinking the C<$srcpath>.
281
282If an error occurs, the partial destination file will be unlinked, if
283possible, except when setting atime, mtime, access mode and uid/gid, where
284errors are being ignored.
285
286=cut
287
288sub aio_move($$$) {
289 my ($src, $dst, $cb) = @_;
290
291 my $pri = aioreq_pri;
292 my $grp = aio_group $cb;
293
294 aioreq_pri $pri;
295 add $grp aio_rename $src, $dst, sub {
296 if ($_[0] && $! == EXDEV) {
297 aioreq_pri $pri;
298 add $grp aio_open $src, O_RDONLY, 0, sub {
299 if (my $src_fh = $_[0]) {
300 my @stat = stat $src_fh;
301
302 aioreq_pri $pri;
303 add $grp aio_open $dst, O_WRONLY, 0200, sub {
304 if (my $dst_fh = $_[0]) {
305 aioreq_pri $pri;
306 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
307 close $src_fh;
308
309 if ($_[0] == $stat[7]) {
310 utime $stat[8], $stat[9], $dst;
311 chmod $stat[2] & 07777, $dst_fh;
312 chown $stat[4], $stat[5], $dst_fh;
313 close $dst_fh;
314
315 aioreq_pri $pri;
316 add $grp aio_unlink $src, sub {
317 $grp->result ($_[0]);
318 };
319 } else {
320 my $errno = $!;
321 aioreq_pri $pri;
322 add $grp aio_unlink $dst, sub {
323 $! = $errno;
324 $grp->result (-1);
325 };
326 }
327 };
328 } else {
329 $grp->result (-1);
330 }
331 },
332
333 } else {
334 $grp->result (-1);
335 }
336 };
337 } else {
338 $grp->result ($_[0]);
339 }
340 };
341
342 $grp
343}
344 373
345=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 374=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
346 375
347Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 376Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
348reading at byte offset C<$in_offset>, and starts writing at the current 377reading at byte offset C<$in_offset>, and starts writing at the current
… …
362C<$in_fh> than are written, and there is no way to find out how many 391C<$in_fh> than are written, and there is no way to find out how many
363bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 392bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
364provides the number of bytes written to C<$out_fh>. Only if the result 393provides the number of bytes written to C<$out_fh>. Only if the result
365value equals C<$length> one can assume that C<$length> bytes have been 394value equals C<$length> one can assume that C<$length> bytes have been
366read. 395read.
396
367 397
368=item aio_readahead $fh,$offset,$length, $callback->($retval) 398=item aio_readahead $fh,$offset,$length, $callback->($retval)
369 399
370C<aio_readahead> populates the page cache with data from a file so that 400C<aio_readahead> populates the page cache with data from a file so that
371subsequent reads from that file will not block on disk I/O. The C<$offset> 401subsequent reads from that file will not block on disk I/O. The C<$offset>
… …
377file. The current file offset of the file is left unchanged. 407file. The current file offset of the file is left unchanged.
378 408
379If that syscall doesn't exist (likely if your OS isn't Linux) it will be 409If that syscall doesn't exist (likely if your OS isn't Linux) it will be
380emulated by simply reading the data, which would have a similar effect. 410emulated by simply reading the data, which would have a similar effect.
381 411
412
382=item aio_stat $fh_or_path, $callback->($status) 413=item aio_stat $fh_or_path, $callback->($status)
383 414
384=item aio_lstat $fh, $callback->($status) 415=item aio_lstat $fh, $callback->($status)
385 416
386Works like perl's C<stat> or C<lstat> in void context. The callback will 417Works like perl's C<stat> or C<lstat> in void context. The callback will
… …
399 aio_stat "/etc/passwd", sub { 430 aio_stat "/etc/passwd", sub {
400 $_[0] and die "stat failed: $!"; 431 $_[0] and die "stat failed: $!";
401 print "size is ", -s _, "\n"; 432 print "size is ", -s _, "\n";
402 }; 433 };
403 434
435
436=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
437
438Works like perl's C<utime> function (including the special case of $atime
439and $mtime being undef). Fractional times are supported if the underlying
440syscalls support them.
441
442When called with a pathname, uses utimes(2) if available, otherwise
443utime(2). If called on a file descriptor, uses futimes(2) if available,
444otherwise returns ENOSYS, so this is not portable.
445
446Examples:
447
448 # set atime and mtime to current time (basically touch(1)):
449 aio_utime "path", undef, undef;
450 # set atime to current time and mtime to beginning of the epoch:
451 aio_utime "path", time, undef; # undef==0
452
453
454=item aio_chown $fh_or_path, $uid, $gid, $callback->($status)
455
456Works like perl's C<chown> function, except that C<undef> for either $uid
457or $gid is being interpreted as "do not change" (but -1 can also be used).
458
459Examples:
460
461 # same as "chown root path" in the shell:
462 aio_chown "path", 0, -1;
463 # same as above:
464 aio_chown "path", 0, undef;
465
466
467=item aio_truncate $fh_or_path, $offset, $callback->($status)
468
469Works like truncate(2) or ftruncate(2).
470
471
472=item aio_chmod $fh_or_path, $mode, $callback->($status)
473
474Works like perl's C<chmod> function.
475
476
404=item aio_unlink $pathname, $callback->($status) 477=item aio_unlink $pathname, $callback->($status)
405 478
406Asynchronously unlink (delete) a file and call the callback with the 479Asynchronously unlink (delete) a file and call the callback with the
407result code. 480result code.
408 481
482
483=item aio_mknod $path, $mode, $dev, $callback->($status)
484
485[EXPERIMENTAL]
486
487Asynchronously create a device node (or fifo). See mknod(2).
488
489The only (POSIX-) portable way of calling this function is:
490
491 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
492
493
409=item aio_link $srcpath, $dstpath, $callback->($status) 494=item aio_link $srcpath, $dstpath, $callback->($status)
410 495
411Asynchronously create a new link to the existing object at C<$srcpath> at 496Asynchronously create a new link to the existing object at C<$srcpath> at
412the path C<$dstpath> and call the callback with the result code. 497the path C<$dstpath> and call the callback with the result code.
413 498
499
414=item aio_symlink $srcpath, $dstpath, $callback->($status) 500=item aio_symlink $srcpath, $dstpath, $callback->($status)
415 501
416Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 502Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
417the path C<$dstpath> and call the callback with the result code. 503the path C<$dstpath> and call the callback with the result code.
418 504
505
506=item aio_readlink $path, $callback->($link)
507
508Asynchronously read the symlink specified by C<$path> and pass it to
509the callback. If an error occurs, nothing or undef gets passed to the
510callback.
511
512
419=item aio_rename $srcpath, $dstpath, $callback->($status) 513=item aio_rename $srcpath, $dstpath, $callback->($status)
420 514
421Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 515Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
422rename(2) and call the callback with the result code. 516rename(2) and call the callback with the result code.
423 517
518
519=item aio_mkdir $pathname, $mode, $callback->($status)
520
521Asynchronously mkdir (create) a directory and call the callback with
522the result code. C<$mode> will be modified by the umask at the time the
523request is executed, so do not change your umask.
524
525
424=item aio_rmdir $pathname, $callback->($status) 526=item aio_rmdir $pathname, $callback->($status)
425 527
426Asynchronously rmdir (delete) a directory and call the callback with the 528Asynchronously rmdir (delete) a directory and call the callback with the
427result code. 529result code.
530
428 531
429=item aio_readdir $pathname, $callback->($entries) 532=item aio_readdir $pathname, $callback->($entries)
430 533
431Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 534Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
432directory (i.e. opendir + readdir + closedir). The entries will not be 535directory (i.e. opendir + readdir + closedir). The entries will not be
433sorted, and will B<NOT> include the C<.> and C<..> entries. 536sorted, and will B<NOT> include the C<.> and C<..> entries.
434 537
435The callback a single argument which is either C<undef> or an array-ref 538The callback a single argument which is either C<undef> or an array-ref
436with the filenames. 539with the filenames.
540
541
542=item aio_load $path, $data, $callback->($status)
543
544This is a composite request that tries to fully load the given file into
545memory. Status is the same as with aio_read.
546
547=cut
548
549sub aio_load($$;$) {
550 my ($path, undef, $cb) = @_;
551 my $data = \$_[1];
552
553 my $pri = aioreq_pri;
554 my $grp = aio_group $cb;
555
556 aioreq_pri $pri;
557 add $grp aio_open $path, O_RDONLY, 0, sub {
558 my $fh = shift
559 or return $grp->result (-1);
560
561 aioreq_pri $pri;
562 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
563 $grp->result ($_[0]);
564 };
565 };
566
567 $grp
568}
569
570=item aio_copy $srcpath, $dstpath, $callback->($status)
571
572Try to copy the I<file> (directories not supported as either source or
573destination) from C<$srcpath> to C<$dstpath> and call the callback with
574the C<0> (error) or C<-1> ok.
575
576This is a composite request that creates the destination file with
577mode 0200 and copies the contents of the source file into it using
578C<aio_sendfile>, followed by restoring atime, mtime, access mode and
579uid/gid, in that order.
580
581If an error occurs, the partial destination file will be unlinked, if
582possible, except when setting atime, mtime, access mode and uid/gid, where
583errors are being ignored.
584
585=cut
586
587sub aio_copy($$;$) {
588 my ($src, $dst, $cb) = @_;
589
590 my $pri = aioreq_pri;
591 my $grp = aio_group $cb;
592
593 aioreq_pri $pri;
594 add $grp aio_open $src, O_RDONLY, 0, sub {
595 if (my $src_fh = $_[0]) {
596 my @stat = stat $src_fh; # hmm, might bock over nfs?
597
598 aioreq_pri $pri;
599 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
600 if (my $dst_fh = $_[0]) {
601 aioreq_pri $pri;
602 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
603 if ($_[0] == $stat[7]) {
604 $grp->result (0);
605 close $src_fh;
606
607 my $ch = sub {
608 aioreq_pri $pri;
609 add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
610 aioreq_pri $pri;
611 add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
612 aioreq_pri $pri;
613 add $grp aio_close $dst_fh;
614 }
615 };
616 };
617
618 aioreq_pri $pri;
619 add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
620 if ($_[0] < 0 && $! == ENOSYS) {
621 aioreq_pri $pri;
622 add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
623 } else {
624 $ch->();
625 }
626 };
627 } else {
628 $grp->result (-1);
629 close $src_fh;
630 close $dst_fh;
631
632 aioreq $pri;
633 add $grp aio_unlink $dst;
634 }
635 };
636 } else {
637 $grp->result (-1);
638 }
639 },
640
641 } else {
642 $grp->result (-1);
643 }
644 };
645
646 $grp
647}
648
649=item aio_move $srcpath, $dstpath, $callback->($status)
650
651Try to move the I<file> (directories not supported as either source or
652destination) from C<$srcpath> to C<$dstpath> and call the callback with
653the C<0> (error) or C<-1> ok.
654
655This is a composite request that tries to rename(2) the file first; if
656rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
657that is successful, unlinks the C<$srcpath>.
658
659=cut
660
661sub aio_move($$;$) {
662 my ($src, $dst, $cb) = @_;
663
664 my $pri = aioreq_pri;
665 my $grp = aio_group $cb;
666
667 aioreq_pri $pri;
668 add $grp aio_rename $src, $dst, sub {
669 if ($_[0] && $! == EXDEV) {
670 aioreq_pri $pri;
671 add $grp aio_copy $src, $dst, sub {
672 $grp->result ($_[0]);
673
674 if (!$_[0]) {
675 aioreq_pri $pri;
676 add $grp aio_unlink $src;
677 }
678 };
679 } else {
680 $grp->result ($_[0]);
681 }
682 };
683
684 $grp
685}
437 686
438=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 687=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
439 688
440Scans a directory (similar to C<aio_readdir>) but additionally tries to 689Scans a directory (similar to C<aio_readdir>) but additionally tries to
441efficiently separate the entries of directory C<$path> into two sets of 690efficiently separate the entries of directory C<$path> into two sets of
… …
487as those tend to return 0 or 1 as link counts, which disables the 736as those tend to return 0 or 1 as link counts, which disables the
488directory counting heuristic. 737directory counting heuristic.
489 738
490=cut 739=cut
491 740
492sub aio_scandir($$$) { 741sub aio_scandir($$;$) {
493 my ($path, $maxreq, $cb) = @_; 742 my ($path, $maxreq, $cb) = @_;
494 743
495 my $pri = aioreq_pri; 744 my $pri = aioreq_pri;
496 745
497 my $grp = aio_group $cb; 746 my $grp = aio_group $cb;
… …
573 }; 822 };
574 823
575 $grp 824 $grp
576} 825}
577 826
827=item aio_rmtree $path, $callback->($status)
828
829Delete a directory tree starting (and including) C<$path>, return the
830status of the final C<rmdir> only. This is a composite request that
831uses C<aio_scandir> to recurse into and rmdir directories, and unlink
832everything else.
833
834=cut
835
836sub aio_rmtree;
837sub aio_rmtree($;$) {
838 my ($path, $cb) = @_;
839
840 my $pri = aioreq_pri;
841 my $grp = aio_group $cb;
842
843 aioreq_pri $pri;
844 add $grp aio_scandir $path, 0, sub {
845 my ($dirs, $nondirs) = @_;
846
847 my $dirgrp = aio_group sub {
848 add $grp aio_rmdir $path, sub {
849 $grp->result ($_[0]);
850 };
851 };
852
853 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
854 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
855
856 add $grp $dirgrp;
857 };
858
859 $grp
860}
861
862=item aio_sync $callback->($status)
863
864Asynchronously call sync and call the callback when finished.
865
578=item aio_fsync $fh, $callback->($status) 866=item aio_fsync $fh, $callback->($status)
579 867
580Asynchronously call fsync on the given filehandle and call the callback 868Asynchronously call fsync on the given filehandle and call the callback
581with the fsync result code. 869with the fsync result code.
582 870
… …
585Asynchronously call fdatasync on the given filehandle and call the 873Asynchronously call fdatasync on the given filehandle and call the
586callback with the fdatasync result code. 874callback with the fdatasync result code.
587 875
588If this call isn't available because your OS lacks it or it couldn't be 876If this call isn't available because your OS lacks it or it couldn't be
589detected, it will be emulated by calling C<fsync> instead. 877detected, it will be emulated by calling C<fsync> instead.
878
879=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
880
881Sync the data portion of the file specified by C<$offset> and C<$length>
882to disk (but NOT the metadata), by calling the Linux-specific
883sync_file_range call. If sync_file_range is not available or it returns
884ENOSYS, then fdatasync or fsync is being substituted.
885
886C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
887C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
888C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
889manpage for details.
890
891=item aio_pathsync $path, $callback->($status)
892
893This request tries to open, fsync and close the given path. This is a
894composite request intended to sync directories after directory operations
895(E.g. rename). This might not work on all operating systems or have any
896specific effect, but usually it makes sure that directory changes get
897written to disc. It works for anything that can be opened for read-only,
898not just directories.
899
900Passes C<0> when everything went ok, and C<-1> on error.
901
902=cut
903
904sub aio_pathsync($;$) {
905 my ($path, $cb) = @_;
906
907 my $pri = aioreq_pri;
908 my $grp = aio_group $cb;
909
910 aioreq_pri $pri;
911 add $grp aio_open $path, O_RDONLY, 0, sub {
912 my ($fh) = @_;
913 if ($fh) {
914 aioreq_pri $pri;
915 add $grp aio_fsync $fh, sub {
916 $grp->result ($_[0]);
917
918 aioreq_pri $pri;
919 add $grp aio_close $fh;
920 };
921 } else {
922 $grp->result (-1);
923 }
924 };
925
926 $grp
927}
590 928
591=item aio_group $callback->(...) 929=item aio_group $callback->(...)
592 930
593This is a very special aio request: Instead of doing something, it is a 931This is a very special aio request: Instead of doing something, it is a
594container for other aio requests, which is useful if you want to bundle 932container for other aio requests, which is useful if you want to bundle
… …
706Their lifetime, simplified, looks like this: when they are empty, they 1044Their lifetime, simplified, looks like this: when they are empty, they
707will finish very quickly. If they contain only requests that are in the 1045will finish very quickly. If they contain only requests that are in the
708C<done> state, they will also finish. Otherwise they will continue to 1046C<done> state, they will also finish. Otherwise they will continue to
709exist. 1047exist.
710 1048
711That means after creating a group you have some time to add requests. And 1049That means after creating a group you have some time to add requests
712in the callbacks of those requests, you can add further requests to the 1050(precisely before the callback has been invoked, which is only done within
713group. And only when all those requests have finished will the the group 1051the C<poll_cb>). And in the callbacks of those requests, you can add
714itself finish. 1052further requests to the group. And only when all those requests have
1053finished will the the group itself finish.
715 1054
716=over 4 1055=over 4
717 1056
718=item add $grp ... 1057=item add $grp ...
719 1058
… …
731itself. Useful when you queued a lot of events but got a result early. 1070itself. Useful when you queued a lot of events but got a result early.
732 1071
733=item $grp->result (...) 1072=item $grp->result (...)
734 1073
735Set the result value(s) that will be passed to the group callback when all 1074Set the result value(s) that will be passed to the group callback when all
736subrequests have finished and set thre groups errno to the current value 1075subrequests have finished and set the groups errno to the current value
737of errno (just like calling C<errno> without an error number). By default, 1076of errno (just like calling C<errno> without an error number). By default,
738no argument will be passed and errno is zero. 1077no argument will be passed and errno is zero.
739 1078
740=item $grp->errno ([$errno]) 1079=item $grp->errno ([$errno])
741 1080
… …
752=item feed $grp $callback->($grp) 1091=item feed $grp $callback->($grp)
753 1092
754Sets a feeder/generator on this group: every group can have an attached 1093Sets a feeder/generator on this group: every group can have an attached
755generator that generates requests if idle. The idea behind this is that, 1094generator that generates requests if idle. The idea behind this is that,
756although you could just queue as many requests as you want in a group, 1095although you could just queue as many requests as you want in a group,
757this might starve other requests for a potentially long time. For 1096this might starve other requests for a potentially long time. For example,
758example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1097C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
759requests, delaying any later requests for a long time. 1098delaying any later requests for a long time.
760 1099
761To avoid this, and allow incremental generation of requests, you can 1100To avoid this, and allow incremental generation of requests, you can
762instead a group and set a feeder on it that generates those requests. The 1101instead a group and set a feeder on it that generates those requests. The
763feed callback will be called whenever there are few enough (see C<limit>, 1102feed callback will be called whenever there are few enough (see C<limit>,
764below) requests active in the group itself and is expected to queue more 1103below) requests active in the group itself and is expected to queue more
… …
768not impose any limits). 1107not impose any limits).
769 1108
770If the feed does not queue more requests when called, it will be 1109If the feed does not queue more requests when called, it will be
771automatically removed from the group. 1110automatically removed from the group.
772 1111
773If the feed limit is C<0>, it will be set to C<2> automatically. 1112If the feed limit is C<0> when this method is called, it will be set to
1113C<2> automatically.
774 1114
775Example: 1115Example:
776 1116
777 # stat all files in @files, but only ever use four aio requests concurrently: 1117 # stat all files in @files, but only ever use four aio requests concurrently:
778 1118
… …
790Sets the feeder limit for the group: The feeder will be called whenever 1130Sets the feeder limit for the group: The feeder will be called whenever
791the group contains less than this many requests. 1131the group contains less than this many requests.
792 1132
793Setting the limit to C<0> will pause the feeding process. 1133Setting the limit to C<0> will pause the feeding process.
794 1134
1135The default value for the limit is C<0>, but note that setting a feeder
1136automatically bumps it up to C<2>.
1137
795=back 1138=back
796 1139
797=head2 SUPPORT FUNCTIONS 1140=head2 SUPPORT FUNCTIONS
1141
1142=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
798 1143
799=over 4 1144=over 4
800 1145
801=item $fileno = IO::AIO::poll_fileno 1146=item $fileno = IO::AIO::poll_fileno
802 1147
… …
807 1152
808See C<poll_cb> for an example. 1153See C<poll_cb> for an example.
809 1154
810=item IO::AIO::poll_cb 1155=item IO::AIO::poll_cb
811 1156
812Process all outstanding events on the result pipe. You have to call this 1157Process some outstanding events on the result pipe. You have to call this
813regularly. Returns the number of events processed. Returns immediately 1158regularly. Returns C<0> if all events could be processed, or C<-1> if it
814when no events are outstanding. 1159returned earlier for whatever reason. Returns immediately when no events
1160are outstanding. The amount of events processed depends on the settings of
1161C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
815 1162
816If not all requests were processed for whatever reason, the filehandle 1163If not all requests were processed for whatever reason, the filehandle
817will still be ready when C<poll_cb> returns. 1164will still be ready when C<poll_cb> returns, so normally you don't have to
1165do anything special to have it called later.
818 1166
819Example: Install an Event watcher that automatically calls 1167Example: Install an Event watcher that automatically calls
820IO::AIO::poll_cb with high priority: 1168IO::AIO::poll_cb with high priority:
821 1169
822 Event->io (fd => IO::AIO::poll_fileno, 1170 Event->io (fd => IO::AIO::poll_fileno,
823 poll => 'r', async => 1, 1171 poll => 'r', async => 1,
824 cb => \&IO::AIO::poll_cb); 1172 cb => \&IO::AIO::poll_cb);
825 1173
826=item IO::AIO::poll_some $max_requests 1174=item IO::AIO::max_poll_reqs $nreqs
827 1175
828Similar to C<poll_cb>, but only processes up to C<$max_requests> requests 1176=item IO::AIO::max_poll_time $seconds
829at a time.
830 1177
831Useful if you want to ensure some level of interactiveness when perl is 1178These set the maximum number of requests (default C<0>, meaning infinity)
832not fast enough to process all requests in time. 1179that are being processed by C<IO::AIO::poll_cb> in one call, respectively
1180the maximum amount of time (default C<0>, meaning infinity) spent in
1181C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
1182of time C<poll_cb> is allowed to use).
1183
1184Setting C<max_poll_time> to a non-zero value creates an overhead of one
1185syscall per request processed, which is not normally a problem unless your
1186callbacks are really really fast or your OS is really really slow (I am
1187not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
1188
1189Setting these is useful if you want to ensure some level of
1190interactiveness when perl is not fast enough to process all requests in
1191time.
1192
1193For interactive programs, values such as C<0.01> to C<0.1> should be fine.
833 1194
834Example: Install an Event watcher that automatically calls 1195Example: Install an Event watcher that automatically calls
835IO::AIO::poll_some with low priority, to ensure that other parts of the 1196IO::AIO::poll_cb with low priority, to ensure that other parts of the
836program get the CPU sometimes even under high AIO load. 1197program get the CPU sometimes even under high AIO load.
837 1198
1199 # try not to spend much more than 0.1s in poll_cb
1200 IO::AIO::max_poll_time 0.1;
1201
1202 # use a low priority so other tasks have priority
838 Event->io (fd => IO::AIO::poll_fileno, 1203 Event->io (fd => IO::AIO::poll_fileno,
839 poll => 'r', nice => 1, 1204 poll => 'r', nice => 1,
840 cb => sub { IO::AIO::poll_some 256 }); 1205 cb => &IO::AIO::poll_cb);
841 1206
842=item IO::AIO::poll_wait 1207=item IO::AIO::poll_wait
843 1208
1209If there are any outstanding requests and none of them in the result
844Wait till the result filehandle becomes ready for reading (simply does a 1210phase, wait till the result filehandle becomes ready for reading (simply
845C<select> on the filehandle. This is useful if you want to synchronously wait 1211does a C<select> on the filehandle. This is useful if you want to
846for some requests to finish). 1212synchronously wait for some requests to finish).
847 1213
848See C<nreqs> for an example. 1214See C<nreqs> for an example.
849 1215
1216=item IO::AIO::poll
1217
1218Waits until some requests have been handled.
1219
1220Returns the number of requests processed, but is otherwise strictly
1221equivalent to:
1222
1223 IO::AIO::poll_wait, IO::AIO::poll_cb
1224
850=item IO::AIO::nreqs 1225=item IO::AIO::flush
851 1226
852Returns the number of requests currently in the ready, execute or pending 1227Wait till all outstanding AIO requests have been handled.
853states (i.e. for which their callback has not been invoked yet).
854 1228
855Example: wait till there are no outstanding requests anymore: 1229Strictly equivalent to:
856 1230
857 IO::AIO::poll_wait, IO::AIO::poll_cb 1231 IO::AIO::poll_wait, IO::AIO::poll_cb
858 while IO::AIO::nreqs; 1232 while IO::AIO::nreqs;
859 1233
860=item IO::AIO::nready 1234=back
861 1235
862Returns the number of requests currently in the ready state (not yet 1236=head3 CONTROLLING THE NUMBER OF THREADS
863executed).
864 1237
865=item IO::AIO::npending 1238=over
866
867Returns the number of requests currently in the pending state (executed,
868but not yet processed by poll_cb).
869
870=item IO::AIO::flush
871
872Wait till all outstanding AIO requests have been handled.
873
874Strictly equivalent to:
875
876 IO::AIO::poll_wait, IO::AIO::poll_cb
877 while IO::AIO::nreqs;
878
879=item IO::AIO::poll
880
881Waits until some requests have been handled.
882
883Strictly equivalent to:
884
885 IO::AIO::poll_wait, IO::AIO::poll_cb
886 if IO::AIO::nreqs;
887 1239
888=item IO::AIO::min_parallel $nthreads 1240=item IO::AIO::min_parallel $nthreads
889 1241
890Set the minimum number of AIO threads to C<$nthreads>. The current 1242Set the minimum number of AIO threads to C<$nthreads>. The current
891default is C<8>, which means eight asynchronous operations can execute 1243default is C<8>, which means eight asynchronous operations can execute
892concurrently at any one time (the number of outstanding requests, 1244concurrently at any one time (the number of outstanding requests,
893however, is unlimited). 1245however, is unlimited).
894 1246
895IO::AIO starts threads only on demand, when an AIO request is queued and 1247IO::AIO starts threads only on demand, when an AIO request is queued and
896no free thread exists. 1248no free thread exists. Please note that queueing up a hundred requests can
1249create demand for a hundred threads, even if it turns out that everything
1250is in the cache and could have been processed faster by a single thread.
897 1251
898It is recommended to keep the number of threads relatively low, as some 1252It is recommended to keep the number of threads relatively low, as some
899Linux kernel versions will scale negatively with the number of threads 1253Linux kernel versions will scale negatively with the number of threads
900(higher parallelity => MUCH higher latency). With current Linux 2.6 1254(higher parallelity => MUCH higher latency). With current Linux 2.6
901versions, 4-32 threads should be fine. 1255versions, 4-32 threads should be fine.
… …
915This module automatically runs C<max_parallel 0> at program end, to ensure 1269This module automatically runs C<max_parallel 0> at program end, to ensure
916that all threads are killed and that there are no outstanding requests. 1270that all threads are killed and that there are no outstanding requests.
917 1271
918Under normal circumstances you don't need to call this function. 1272Under normal circumstances you don't need to call this function.
919 1273
1274=item IO::AIO::max_idle $nthreads
1275
1276Limit the number of threads (default: 4) that are allowed to idle (i.e.,
1277threads that did not get a request to process within 10 seconds). That
1278means if a thread becomes idle while C<$nthreads> other threads are also
1279idle, it will free its resources and exit.
1280
1281This is useful when you allow a large number of threads (e.g. 100 or 1000)
1282to allow for extremely high load situations, but want to free resources
1283under normal circumstances (1000 threads can easily consume 30MB of RAM).
1284
1285The default is probably ok in most situations, especially if thread
1286creation is fast. If thread creation is very slow on your system you might
1287want to use larger values.
1288
920=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1289=item IO::AIO::max_outstanding $maxreqs
921 1290
922This is a very bad function to use in interactive programs because it 1291This is a very bad function to use in interactive programs because it
923blocks, and a bad way to reduce concurrency because it is inexact: Better 1292blocks, and a bad way to reduce concurrency because it is inexact: Better
924use an C<aio_group> together with a feed callback. 1293use an C<aio_group> together with a feed callback.
925 1294
926Sets the maximum number of outstanding requests to C<$nreqs>. If you 1295Sets the maximum number of outstanding requests to C<$nreqs>. If you
927to queue up more than this number of requests, the next call to the 1296do queue up more than this number of requests, the next call to the
928C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) 1297C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
929function will block until the limit is no longer exceeded. 1298function will block until the limit is no longer exceeded.
930 1299
931The default value is very large, so there is no practical limit on the 1300The default value is very large, so there is no practical limit on the
932number of outstanding requests. 1301number of outstanding requests.
933 1302
934You can still queue as many requests as you want. Therefore, 1303You can still queue as many requests as you want. Therefore,
935C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1304C<max_outstanding> is mainly useful in simple scripts (with low values) or
936as a stop gap to shield against fatal memory overflow (with large values). 1305as a stop gap to shield against fatal memory overflow (with large values).
937 1306
938=back 1307=back
939 1308
1309=head3 STATISTICAL INFORMATION
1310
1311=over
1312
1313=item IO::AIO::nreqs
1314
1315Returns the number of requests currently in the ready, execute or pending
1316states (i.e. for which their callback has not been invoked yet).
1317
1318Example: wait till there are no outstanding requests anymore:
1319
1320 IO::AIO::poll_wait, IO::AIO::poll_cb
1321 while IO::AIO::nreqs;
1322
1323=item IO::AIO::nready
1324
1325Returns the number of requests currently in the ready state (not yet
1326executed).
1327
1328=item IO::AIO::npending
1329
1330Returns the number of requests currently in the pending state (executed,
1331but not yet processed by poll_cb).
1332
1333=back
1334
940=cut 1335=cut
941 1336
942# support function to convert a fd into a perl filehandle
943sub _fd2fh {
944 return undef if $_[0] < 0;
945
946 # try to generate nice filehandles
947 my $sym = "IO::AIO::fd#$_[0]";
948 local *$sym;
949
950 open *$sym, "+<&=$_[0]" # usually works under any unix
951 or open *$sym, "<&=$_[0]" # cygwin needs this
952 or open *$sym, ">&=$_[0]" # or this
953 or return undef;
954
955 *$sym
956}
957
958min_parallel 8; 1337min_parallel 8;
1338
1339END { flush }
959 1340
9601; 13411;
961 1342
962=head2 FORK BEHAVIOUR 1343=head2 FORK BEHAVIOUR
963 1344
… …
983bytes of memory. In addition, stat requests need a stat buffer (possibly 1364bytes of memory. In addition, stat requests need a stat buffer (possibly
984a few hundred bytes), readdir requires a result buffer and so on. Perl 1365a few hundred bytes), readdir requires a result buffer and so on. Perl
985scalars and other data passed into aio requests will also be locked and 1366scalars and other data passed into aio requests will also be locked and
986will consume memory till the request has entered the done state. 1367will consume memory till the request has entered the done state.
987 1368
988This is now awfully much, so queuing lots of requests is not usually a 1369This is not awfully much, so queuing lots of requests is not usually a
989problem. 1370problem.
990 1371
991Per-thread usage: 1372Per-thread usage:
992 1373
993In the execution phase, some aio requests require more memory for 1374In the execution phase, some aio requests require more memory for
… …
998 1379
999Known bugs will be fixed in the next release. 1380Known bugs will be fixed in the next release.
1000 1381
1001=head1 SEE ALSO 1382=head1 SEE ALSO
1002 1383
1003L<Coro::AIO>. 1384L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1385more natural syntax.
1004 1386
1005=head1 AUTHOR 1387=head1 AUTHOR
1006 1388
1007 Marc Lehmann <schmorp@schmorp.de> 1389 Marc Lehmann <schmorp@schmorp.de>
1008 http://home.schmorp.de/ 1390 http://home.schmorp.de/

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines