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.39 by root, Sun Aug 28 11:05:50 2005 UTC vs.
Revision 1.95 by root, Sun Nov 26 18:28:37 2006 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
16 aio_read $fh, 30000, 1024, $buffer, 0, sub { 17 aio_read $fh, 30000, 1024, $buffer, 0, sub {
17 $_[0] > 0 or die "read error: $!"; 18 $_[0] > 0 or die "read error: $!";
18 }; 19 };
19 20
20 # Event 21 # version 2+ has request and group objects
22 use IO::AIO 2;
23
24 aioreq_pri 4; # give next request a very high priority
25 my $req = aio_unlink "/tmp/file", sub { };
26 $req->cancel; # cancel request if still in queue
27
28 my $grp = aio_group sub { print "all stats done\n" };
29 add $grp aio_stat "..." for ...;
30
31 # AnyEvent integration
32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34
35 # Event integration
21 Event->io (fd => IO::AIO::poll_fileno, 36 Event->io (fd => IO::AIO::poll_fileno,
22 poll => 'r', 37 poll => 'r',
23 cb => \&IO::AIO::poll_cb); 38 cb => \&IO::AIO::poll_cb);
24 39
25 # Glib/Gtk2 40 # Glib/Gtk2 integration
26 add_watch Glib::IO IO::AIO::poll_fileno, 41 add_watch Glib::IO IO::AIO::poll_fileno,
27 in => sub { IO::AIO::poll_cb; 1 }; 42 in => sub { IO::AIO::poll_cb; 1 };
28 43
29 # Tk 44 # Tk integration
30 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", 45 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
31 readable => \&IO::AIO::poll_cb); 46 readable => \&IO::AIO::poll_cb);
32 47
33 # Danga::Socket 48 # Danga::Socket integration
34 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => 49 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
35 \&IO::AIO::poll_cb); 50 \&IO::AIO::poll_cb);
36 51
37
38=head1 DESCRIPTION 52=head1 DESCRIPTION
39 53
40This module implements asynchronous I/O using whatever means your 54This module implements asynchronous I/O using whatever means your
41operating system supports. 55operating system supports.
42 56
57Asynchronous means that operations that can normally block your program
58(e.g. reading from disk) will be done asynchronously: the operation
59will still block, but you can do something else in the meantime. This
60is extremely useful for programs that need to stay interactive even
61when doing heavy I/O (GUI programs, high performance network servers
62etc.), but can also be used to easily do operations in parallel that are
63normally done sequentially, e.g. stat'ing many files, which is much faster
64on a RAID volume or over NFS when you do a number of stat operations
65concurrently.
66
67While most of this works on all types of file descriptors (for example
68sockets), using these functions on file descriptors that support
69nonblocking operation (again, sockets, pipes etc.) is very inefficient or
70might not work (aio_read fails on sockets/pipes/fifos). Use an event loop
71for that (such as the L<Event|Event> module): IO::AIO will naturally fit
72into such an event loop itself.
73
43Currently, a number of threads are started that execute your read/writes 74In this version, a number of threads are started that execute your
44and signal their completion. You don't need thread support in your libc or 75requests and signal their completion. You don't need thread support
45perl, and the threads created by this module will not be visible to the 76in perl, and the threads created by this module will not be visible
46pthreads library. In the future, this module might make use of the native 77to perl. In the future, this module might make use of the native aio
47aio functions available on many operating systems. However, they are often 78functions available on many operating systems. However, they are often
48not well-supported (Linux doesn't allow them on normal files currently, 79not well-supported or restricted (GNU/Linux doesn't allow them on normal
49for example), and they would only support aio_read and aio_write, so the 80files currently, for example), and they would only support aio_read and
50remaining functionality would have to be implemented using threads anyway. 81aio_write, so the remaining functionality would have to be implemented
82using threads anyway.
51 83
52Although the module will work with in the presence of other threads, it is 84Although the module will work with in the presence of other (Perl-)
53currently not reentrant, so use appropriate locking yourself, always call 85threads, it is currently not reentrant in any way, so use appropriate
54C<poll_cb> from within the same thread, or never call C<poll_cb> (or other 86locking yourself, always call C<poll_cb> from within the same thread, or
55C<aio_> functions) recursively. 87never call C<poll_cb> (or other C<aio_> functions) recursively.
88
89=head2 EXAMPLE
90
91This is a simple example that uses the Event module and loads
92F</etc/passwd> asynchronously:
93
94 use Fcntl;
95 use Event;
96 use IO::AIO;
97
98 # register the IO::AIO callback with Event
99 Event->io (fd => IO::AIO::poll_fileno,
100 poll => 'r',
101 cb => \&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 Event::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 Event::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
56 184
57=cut 185=cut
58 186
59package IO::AIO; 187package IO::AIO;
60 188
61no warnings; 189no warnings;
190use strict 'vars';
62 191
63use base 'Exporter'; 192use base 'Exporter';
64 193
65use Fcntl ();
66
67BEGIN { 194BEGIN {
68 $VERSION = 1.6; 195 our $VERSION = '2.2';
69 196
70 @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 197 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat
71 aio_lstat aio_unlink aio_rmdir aio_readdir aio_symlink 198 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink
72 aio_fsync aio_fdatasync aio_readahead); 199 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link
73 @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel 200 aio_move aio_copy aio_group aio_nop aio_mknod);
74 max_outstanding nreqs); 201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block));
202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
203 min_parallel max_parallel max_idle
204 nreqs nready npending nthreads
205 max_poll_time max_poll_reqs);
206
207 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
75 208
76 require XSLoader; 209 require XSLoader;
77 XSLoader::load IO::AIO, $VERSION; 210 XSLoader::load ("IO::AIO", $VERSION);
78} 211}
79 212
80=head1 FUNCTIONS 213=head1 FUNCTIONS
81 214
82=head2 AIO FUNCTIONS 215=head2 AIO REQUEST FUNCTIONS
83 216
84All the C<aio_*> calls are more or less thin wrappers around the syscall 217All the C<aio_*> calls are more or less thin wrappers around the syscall
85with the same name (sans C<aio_>). The arguments are similar or identical, 218with the same name (sans C<aio_>). The arguments are similar or identical,
86and they all accept an additional (and optional) C<$callback> argument 219and they all accept an additional (and optional) C<$callback> argument
87which must be a code reference. This code reference will get called with 220which must be a code reference. This code reference will get called with
90syscall has been executed asynchronously. 223syscall has been executed asynchronously.
91 224
92All functions expecting a filehandle keep a copy of the filehandle 225All functions expecting a filehandle keep a copy of the filehandle
93internally until the request has finished. 226internally until the request has finished.
94 227
228All functions return request objects of type L<IO::AIO::REQ> that allow
229further manipulation of those requests while they are in-flight.
230
95The pathnames you pass to these routines I<must> be absolute and 231The pathnames you pass to these routines I<must> be absolute and
96encoded in byte form. The reason for the former is that at the time the 232encoded as octets. The reason for the former is that at the time the
97request is being executed, the current working directory could have 233request is being executed, the current working directory could have
98changed. Alternatively, you can make sure that you never change the 234changed. Alternatively, you can make sure that you never change the
99current working directory. 235current working directory anywhere in the program and then use relative
236paths.
100 237
101To encode pathnames to byte form, either make sure you either: a) 238To encode pathnames as octets, either make sure you either: a) always pass
102always pass in filenames you got from outside (command line, readdir 239in filenames you got from outside (command line, readdir etc.) without
103etc.), b) are ASCII or ISO 8859-1, c) use the Encode module and encode 240tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode
104your pathnames to the locale (or other) encoding in effect in the user 241your pathnames to the locale (or other) encoding in effect in the user
105environment, d) use Glib::filename_from_unicode on unicode filenames or e) 242environment, d) use Glib::filename_from_unicode on unicode filenames or e)
106use something else. 243use something else to ensure your scalar has the correct contents.
244
245This works, btw. independent of the internal UTF-8 bit, which IO::AIO
246handles correctly wether it is set or not.
107 247
108=over 4 248=over 4
109 249
250=item $prev_pri = aioreq_pri [$pri]
251
252Returns the priority value that would be used for the next request and, if
253C<$pri> is given, sets the priority for the next aio request.
254
255The default priority is C<0>, the minimum and maximum priorities are C<-4>
256and C<4>, respectively. Requests with higher priority will be serviced
257first.
258
259The priority will be reset to C<0> after each call to one of the C<aio_*>
260functions.
261
262Example: open a file with low priority, then read something from it with
263higher priority so the read request is serviced before other low priority
264open requests (potentially spamming the cache):
265
266 aioreq_pri -3;
267 aio_open ..., sub {
268 return unless $_[0];
269
270 aioreq_pri -2;
271 aio_read $_[0], ..., sub {
272 ...
273 };
274 };
275
276=item aioreq_nice $pri_adjust
277
278Similar to C<aioreq_pri>, but subtracts the given value from the current
279priority, so the effect is cumulative.
280
110=item aio_open $pathname, $flags, $mode, $callback 281=item aio_open $pathname, $flags, $mode, $callback->($fh)
111 282
112Asynchronously open or create a file and call the callback with a newly 283Asynchronously open or create a file and call the callback with a newly
113created filehandle for the file. 284created filehandle for the file.
114 285
115The pathname passed to C<aio_open> must be absolute. See API NOTES, above, 286The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
132 } else { 303 } else {
133 die "open failed: $!\n"; 304 die "open failed: $!\n";
134 } 305 }
135 }; 306 };
136 307
137=item aio_close $fh, $callback 308=item aio_close $fh, $callback->($status)
138 309
139Asynchronously close a file and call the callback with the result 310Asynchronously close a file and call the callback with the result
140code. I<WARNING:> although accepted, you should not pass in a perl 311code. I<WARNING:> although accepted, you should not pass in a perl
141filehandle here, as perl will likely close the file descriptor another 312filehandle here, as perl will likely close the file descriptor another
142time when the filehandle is destroyed. Normally, you can safely call perls 313time when the filehandle is destroyed. Normally, you can safely call perls
143C<close> or just let filehandles go out of scope. 314C<close> or just let filehandles go out of scope.
144 315
145This is supposed to be a bug in the API, so that might change. It's 316This is supposed to be a bug in the API, so that might change. It's
146therefore best to avoid this function. 317therefore best to avoid this function.
147 318
148=item aio_read $fh,$offset,$length, $data,$dataoffset,$callback 319=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
149 320
150=item aio_write $fh,$offset,$length, $data,$dataoffset,$callback 321=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
151 322
152Reads or writes C<length> bytes from the specified C<fh> and C<offset> 323Reads or writes C<length> bytes from the specified C<fh> and C<offset>
153into the scalar given by C<data> and offset C<dataoffset> and calls the 324into the scalar given by C<data> and offset C<dataoffset> and calls the
154callback without the actual number of bytes read (or -1 on error, just 325callback without the actual number of bytes read (or -1 on error, just
155like the syscall). 326like the syscall).
164 aio_read $fh, 7, 15, $buffer, 0, sub { 335 aio_read $fh, 7, 15, $buffer, 0, sub {
165 $_[0] > 0 or die "read error: $!"; 336 $_[0] > 0 or die "read error: $!";
166 print "read $_[0] bytes: <$buffer>\n"; 337 print "read $_[0] bytes: <$buffer>\n";
167 }; 338 };
168 339
169=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback 340=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
170 341
171Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 342Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
172reading at byte offset C<$in_offset>, and starts writing at the current 343reading at byte offset C<$in_offset>, and starts writing at the current
173file offset of C<$out_fh>. Because of that, it is not safe to issue more 344file offset of C<$out_fh>. Because of that, it is not safe to issue more
174than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each 345than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
187bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 358bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
188provides the number of bytes written to C<$out_fh>. Only if the result 359provides the number of bytes written to C<$out_fh>. Only if the result
189value equals C<$length> one can assume that C<$length> bytes have been 360value equals C<$length> one can assume that C<$length> bytes have been
190read. 361read.
191 362
192=item aio_readahead $fh,$offset,$length, $callback 363=item aio_readahead $fh,$offset,$length, $callback->($retval)
193 364
194C<aio_readahead> populates the page cache with data from a file so that 365C<aio_readahead> populates the page cache with data from a file so that
195subsequent reads from that file will not block on disk I/O. The C<$offset> 366subsequent reads from that file will not block on disk I/O. The C<$offset>
196argument specifies the starting point from which data is to be read and 367argument specifies the starting point from which data is to be read and
197C<$length> specifies the number of bytes to be read. I/O is performed in 368C<$length> specifies the number of bytes to be read. I/O is performed in
201file. The current file offset of the file is left unchanged. 372file. The current file offset of the file is left unchanged.
202 373
203If that syscall doesn't exist (likely if your OS isn't Linux) it will be 374If that syscall doesn't exist (likely if your OS isn't Linux) it will be
204emulated by simply reading the data, which would have a similar effect. 375emulated by simply reading the data, which would have a similar effect.
205 376
206=item aio_stat $fh_or_path, $callback 377=item aio_stat $fh_or_path, $callback->($status)
207 378
208=item aio_lstat $fh, $callback 379=item aio_lstat $fh, $callback->($status)
209 380
210Works like perl's C<stat> or C<lstat> in void context. The callback will 381Works like perl's C<stat> or C<lstat> in void context. The callback will
211be called after the stat and the results will be available using C<stat _> 382be called after the stat and the results will be available using C<stat _>
212or C<-s _> etc... 383or C<-s _> etc...
213 384
223 aio_stat "/etc/passwd", sub { 394 aio_stat "/etc/passwd", sub {
224 $_[0] and die "stat failed: $!"; 395 $_[0] and die "stat failed: $!";
225 print "size is ", -s _, "\n"; 396 print "size is ", -s _, "\n";
226 }; 397 };
227 398
228=item aio_unlink $pathname, $callback 399=item aio_unlink $pathname, $callback->($status)
229 400
230Asynchronously unlink (delete) a file and call the callback with the 401Asynchronously unlink (delete) a file and call the callback with the
231result code. 402result code.
232 403
404=item aio_mknod $path, $mode, $dev, $callback->($status)
405
406[EXPERIMENTAL]
407
408Asynchronously create a device node (or fifo). See mknod(2).
409
410The only (POSIX-) portable way of calling this function is:
411
412 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
413
414=item aio_link $srcpath, $dstpath, $callback->($status)
415
416Asynchronously create a new link to the existing object at C<$srcpath> at
417the path C<$dstpath> and call the callback with the result code.
418
419=item aio_symlink $srcpath, $dstpath, $callback->($status)
420
421Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
422the path C<$dstpath> and call the callback with the result code.
423
424=item aio_readlink $path, $callback->($link)
425
426Asynchronously read the symlink specified by C<$path> and pass it to
427the callback. If an error occurs, nothing or undef gets passed to the
428callback.
429
430=item aio_rename $srcpath, $dstpath, $callback->($status)
431
432Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
433rename(2) and call the callback with the result code.
434
233=item aio_rmdir $pathname, $callback 435=item aio_rmdir $pathname, $callback->($status)
234 436
235Asynchronously rmdir (delete) a directory and call the callback with the 437Asynchronously rmdir (delete) a directory and call the callback with the
236result code. 438result code.
237 439
238=item aio_readdir $pathname $callback 440=item aio_readdir $pathname, $callback->($entries)
239 441
240Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 442Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
241directory (i.e. opendir + readdir + closedir). The entries will not be 443directory (i.e. opendir + readdir + closedir). The entries will not be
242sorted, and will B<NOT> include the C<.> and C<..> entries. 444sorted, and will B<NOT> include the C<.> and C<..> entries.
243 445
244The callback a single argument which is either C<undef> or an array-ref 446The callback a single argument which is either C<undef> or an array-ref
245with the filenames. 447with the filenames.
246 448
449=item aio_copy $srcpath, $dstpath, $callback->($status)
450
451Try to copy the I<file> (directories not supported as either source or
452destination) from C<$srcpath> to C<$dstpath> and call the callback with
453the C<0> (error) or C<-1> ok.
454
455This is a composite request that it creates the destination file with
456mode 0200 and copies the contents of the source file into it using
457C<aio_sendfile>, followed by restoring atime, mtime, access mode and
458uid/gid, in that order.
459
460If an error occurs, the partial destination file will be unlinked, if
461possible, except when setting atime, mtime, access mode and uid/gid, where
462errors are being ignored.
463
464=cut
465
466sub aio_copy($$;$) {
467 aio_block {
468 my ($src, $dst, $cb) = @_;
469
470 my $pri = aioreq_pri;
471 my $grp = aio_group $cb;
472
473 aioreq_pri $pri;
474 add $grp aio_open $src, O_RDONLY, 0, sub {
475 if (my $src_fh = $_[0]) {
476 my @stat = stat $src_fh;
477
478 aioreq_pri $pri;
479 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
480 if (my $dst_fh = $_[0]) {
481 aioreq_pri $pri;
482 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
483 if ($_[0] == $stat[7]) {
484 $grp->result (0);
485 close $src_fh;
486
487 # those should not normally block. should. should.
488 utime $stat[8], $stat[9], $dst;
489 chmod $stat[2] & 07777, $dst_fh;
490 chown $stat[4], $stat[5], $dst_fh;
491 close $dst_fh;
492 } else {
493 $grp->result (-1);
494 close $src_fh;
495 close $dst_fh;
496
497 aioreq $pri;
498 add $grp aio_unlink $dst;
499 }
500 };
501 } else {
502 $grp->result (-1);
503 }
504 },
505
506 } else {
507 $grp->result (-1);
508 }
509 };
510
511 $grp
512 }
513}
514
515=item aio_move $srcpath, $dstpath, $callback->($status)
516
517Try to move the I<file> (directories not supported as either source or
518destination) from C<$srcpath> to C<$dstpath> and call the callback with
519the C<0> (error) or C<-1> ok.
520
521This is a composite request that tries to rename(2) the file first. If
522rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if
523that is successful, unlinking the C<$srcpath>.
524
525=cut
526
527sub aio_move($$;$) {
528 aio_block {
529 my ($src, $dst, $cb) = @_;
530
531 my $pri = aioreq_pri;
532 my $grp = aio_group $cb;
533
534 aioreq_pri $pri;
535 add $grp aio_rename $src, $dst, sub {
536 if ($_[0] && $! == EXDEV) {
537 aioreq_pri $pri;
538 add $grp aio_copy $src, $dst, sub {
539 $grp->result ($_[0]);
540
541 if (!$_[0]) {
542 aioreq_pri $pri;
543 add $grp aio_unlink $src;
544 }
545 };
546 } else {
547 $grp->result ($_[0]);
548 }
549 };
550
551 $grp
552 }
553}
554
555=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
556
557Scans a directory (similar to C<aio_readdir>) but additionally tries to
558efficiently separate the entries of directory C<$path> into two sets of
559names, directories you can recurse into (directories), and ones you cannot
560recurse into (everything else, including symlinks to directories).
561
562C<aio_scandir> is a composite request that creates of many sub requests_
563C<$maxreq> specifies the maximum number of outstanding aio requests that
564this function generates. If it is C<< <= 0 >>, then a suitable default
565will be chosen (currently 4).
566
567On error, the callback is called without arguments, otherwise it receives
568two array-refs with path-relative entry names.
569
570Example:
571
572 aio_scandir $dir, 0, sub {
573 my ($dirs, $nondirs) = @_;
574 print "real directories: @$dirs\n";
575 print "everything else: @$nondirs\n";
576 };
577
578Implementation notes.
579
580The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
581
582After reading the directory, the modification time, size etc. of the
583directory before and after the readdir is checked, and if they match (and
584isn't the current time), the link count will be used to decide how many
585entries are directories (if >= 2). Otherwise, no knowledge of the number
586of subdirectories will be assumed.
587
588Then entries will be sorted into likely directories (everything without
589a non-initial dot currently) and likely non-directories (everything
590else). Then every entry plus an appended C</.> will be C<stat>'ed,
591likely directories first. If that succeeds, it assumes that the entry
592is a directory or a symlink to directory (which will be checked
593seperately). This is often faster than stat'ing the entry itself because
594filesystems might detect the type of the entry without reading the inode
595data (e.g. ext2fs filetype feature).
596
597If the known number of directories (link count - 2) has been reached, the
598rest of the entries is assumed to be non-directories.
599
600This only works with certainty on POSIX (= UNIX) filesystems, which
601fortunately are the vast majority of filesystems around.
602
603It will also likely work on non-POSIX filesystems with reduced efficiency
604as those tend to return 0 or 1 as link counts, which disables the
605directory counting heuristic.
606
607=cut
608
609sub aio_scandir($$$) {
610 aio_block {
611 my ($path, $maxreq, $cb) = @_;
612
613 my $pri = aioreq_pri;
614
615 my $grp = aio_group $cb;
616
617 $maxreq = 4 if $maxreq <= 0;
618
619 # stat once
620 aioreq_pri $pri;
621 add $grp aio_stat $path, sub {
622 return $grp->result () if $_[0];
623 my $now = time;
624 my $hash1 = join ":", (stat _)[0,1,3,7,9];
625
626 # read the directory entries
627 aioreq_pri $pri;
628 add $grp aio_readdir $path, sub {
629 my $entries = shift
630 or return $grp->result ();
631
632 # stat the dir another time
633 aioreq_pri $pri;
634 add $grp aio_stat $path, sub {
635 my $hash2 = join ":", (stat _)[0,1,3,7,9];
636
637 my $ndirs;
638
639 # take the slow route if anything looks fishy
640 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
641 $ndirs = -1;
642 } else {
643 # if nlink == 2, we are finished
644 # on non-posix-fs's, we rely on nlink < 2
645 $ndirs = (stat _)[3] - 2
646 or return $grp->result ([], $entries);
647 }
648
649 # sort into likely dirs and likely nondirs
650 # dirs == files without ".", short entries first
651 $entries = [map $_->[0],
652 sort { $b->[1] cmp $a->[1] }
653 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
654 @$entries];
655
656 my (@dirs, @nondirs);
657
658 my $statgrp = add $grp aio_group sub {
659 $grp->result (\@dirs, \@nondirs);
660 };
661
662 limit $statgrp $maxreq;
663 feed $statgrp sub {
664 return unless @$entries;
665 my $entry = pop @$entries;
666
667 aioreq_pri $pri;
668 add $statgrp aio_stat "$path/$entry/.", sub {
669 if ($_[0] < 0) {
670 push @nondirs, $entry;
671 } else {
672 # need to check for real directory
673 aioreq_pri $pri;
674 add $statgrp aio_lstat "$path/$entry", sub {
675 if (-d _) {
676 push @dirs, $entry;
677
678 unless (--$ndirs) {
679 push @nondirs, @$entries;
680 feed $statgrp;
681 }
682 } else {
683 push @nondirs, $entry;
684 }
685 }
686 }
687 };
688 };
689 };
690 };
691 };
692
693 $grp
694 }
695}
696
247=item aio_fsync $fh, $callback 697=item aio_fsync $fh, $callback->($status)
248 698
249Asynchronously call fsync on the given filehandle and call the callback 699Asynchronously call fsync on the given filehandle and call the callback
250with the fsync result code. 700with the fsync result code.
251 701
252=item aio_fdatasync $fh, $callback 702=item aio_fdatasync $fh, $callback->($status)
253 703
254Asynchronously call fdatasync on the given filehandle and call the 704Asynchronously call fdatasync on the given filehandle and call the
255callback with the fdatasync result code. 705callback with the fdatasync result code.
256 706
257If this call isn't available because your OS lacks it or it couldn't be 707If this call isn't available because your OS lacks it or it couldn't be
258detected, it will be emulated by calling C<fsync> instead. 708detected, it will be emulated by calling C<fsync> instead.
259 709
710=item aio_group $callback->(...)
711
712This is a very special aio request: Instead of doing something, it is a
713container for other aio requests, which is useful if you want to bundle
714many requests into a single, composite, request with a definite callback
715and the ability to cancel the whole request with its subrequests.
716
717Returns an object of class L<IO::AIO::GRP>. See its documentation below
718for more info.
719
720Example:
721
722 my $grp = aio_group sub {
723 print "all stats done\n";
724 };
725
726 add $grp
727 (aio_stat ...),
728 (aio_stat ...),
729 ...;
730
731=item aio_nop $callback->()
732
733This is a special request - it does nothing in itself and is only used for
734side effects, such as when you want to add a dummy request to a group so
735that finishing the requests in the group depends on executing the given
736code.
737
738While this request does nothing, it still goes through the execution
739phase and still requires a worker thread. Thus, the callback will not
740be executed immediately but only after other requests in the queue have
741entered their execution phase. This can be used to measure request
742latency.
743
744=item IO::AIO::aio_busy $fractional_seconds, $callback->() *NOT EXPORTED*
745
746Mainly used for debugging and benchmarking, this aio request puts one of
747the request workers to sleep for the given time.
748
749While it is theoretically handy to have simple I/O scheduling requests
750like sleep and file handle readable/writable, the overhead this creates is
751immense (it blocks a thread for a long time) so do not use this function
752except to put your application under artificial I/O pressure.
753
260=back 754=back
261 755
756=head2 IO::AIO::REQ CLASS
757
758All non-aggregate C<aio_*> functions return an object of this class when
759called in non-void context.
760
761=over 4
762
763=item cancel $req
764
765Cancels the request, if possible. Has the effect of skipping execution
766when entering the B<execute> state and skipping calling the callback when
767entering the the B<result> state, but will leave the request otherwise
768untouched. That means that requests that currently execute will not be
769stopped and resources held by the request will not be freed prematurely.
770
771=item cb $req $callback->(...)
772
773Replace (or simply set) the callback registered to the request.
774
775=back
776
777=head2 IO::AIO::GRP CLASS
778
779This class is a subclass of L<IO::AIO::REQ>, so all its methods apply to
780objects of this class, too.
781
782A IO::AIO::GRP object is a special request that can contain multiple other
783aio requests.
784
785You create one by calling the C<aio_group> constructing function with a
786callback that will be called when all contained requests have entered the
787C<done> state:
788
789 my $grp = aio_group sub {
790 print "all requests are done\n";
791 };
792
793You add requests by calling the C<add> method with one or more
794C<IO::AIO::REQ> objects:
795
796 $grp->add (aio_unlink "...");
797
798 add $grp aio_stat "...", sub {
799 $_[0] or return $grp->result ("error");
800
801 # add another request dynamically, if first succeeded
802 add $grp aio_open "...", sub {
803 $grp->result ("ok");
804 };
805 };
806
807This makes it very easy to create composite requests (see the source of
808C<aio_move> for an application) that work and feel like simple requests.
809
810=over 4
811
812=item * The IO::AIO::GRP objects will be cleaned up during calls to
813C<IO::AIO::poll_cb>, just like any other request.
814
815=item * They can be canceled like any other request. Canceling will cancel not
816only the request itself, but also all requests it contains.
817
818=item * They can also can also be added to other IO::AIO::GRP objects.
819
820=item * You must not add requests to a group from within the group callback (or
821any later time).
822
823=back
824
825Their lifetime, simplified, looks like this: when they are empty, they
826will finish very quickly. If they contain only requests that are in the
827C<done> state, they will also finish. Otherwise they will continue to
828exist.
829
830That means after creating a group you have some time to add requests. And
831in the callbacks of those requests, you can add further requests to the
832group. And only when all those requests have finished will the the group
833itself finish.
834
835=over 4
836
837=item add $grp ...
838
839=item $grp->add (...)
840
841Add one or more requests to the group. Any type of L<IO::AIO::REQ> can
842be added, including other groups, as long as you do not create circular
843dependencies.
844
845Returns all its arguments.
846
847=item $grp->cancel_subs
848
849Cancel all subrequests and clears any feeder, but not the group request
850itself. Useful when you queued a lot of events but got a result early.
851
852=item $grp->result (...)
853
854Set the result value(s) that will be passed to the group callback when all
855subrequests have finished and set thre groups errno to the current value
856of errno (just like calling C<errno> without an error number). By default,
857no argument will be passed and errno is zero.
858
859=item $grp->errno ([$errno])
860
861Sets the group errno value to C<$errno>, or the current value of errno
862when the argument is missing.
863
864Every aio request has an associated errno value that is restored when
865the callback is invoked. This method lets you change this value from its
866default (0).
867
868Calling C<result> will also set errno, so make sure you either set C<$!>
869before the call to C<result>, or call c<errno> after it.
870
871=item feed $grp $callback->($grp)
872
873Sets a feeder/generator on this group: every group can have an attached
874generator that generates requests if idle. The idea behind this is that,
875although you could just queue as many requests as you want in a group,
876this might starve other requests for a potentially long time. For
877example, C<aio_scandir> might generate hundreds of thousands C<aio_stat>
878requests, delaying any later requests for a long time.
879
880To avoid this, and allow incremental generation of requests, you can
881instead a group and set a feeder on it that generates those requests. The
882feed callback will be called whenever there are few enough (see C<limit>,
883below) requests active in the group itself and is expected to queue more
884requests.
885
886The feed callback can queue as many requests as it likes (i.e. C<add> does
887not impose any limits).
888
889If the feed does not queue more requests when called, it will be
890automatically removed from the group.
891
892If the feed limit is C<0>, it will be set to C<2> automatically.
893
894Example:
895
896 # stat all files in @files, but only ever use four aio requests concurrently:
897
898 my $grp = aio_group sub { print "finished\n" };
899 limit $grp 4;
900 feed $grp sub {
901 my $file = pop @files
902 or return;
903
904 add $grp aio_stat $file, sub { ... };
905 };
906
907=item limit $grp $num
908
909Sets the feeder limit for the group: The feeder will be called whenever
910the group contains less than this many requests.
911
912Setting the limit to C<0> will pause the feeding process.
913
914=back
915
262=head2 SUPPORT FUNCTIONS 916=head2 SUPPORT FUNCTIONS
917
918=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
263 919
264=over 4 920=over 4
265 921
266=item $fileno = IO::AIO::poll_fileno 922=item $fileno = IO::AIO::poll_fileno
267 923
272 928
273See C<poll_cb> for an example. 929See C<poll_cb> for an example.
274 930
275=item IO::AIO::poll_cb 931=item IO::AIO::poll_cb
276 932
277Process all outstanding events on the result pipe. You have to call this 933Process some outstanding events on the result pipe. You have to call this
278regularly. Returns the number of events processed. Returns immediately 934regularly. Returns the number of events processed. Returns immediately
279when no events are outstanding. 935when no events are outstanding. The amount of events processed depends on
936the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
937
938If not all requests were processed for whatever reason, the filehandle
939will still be ready when C<poll_cb> returns.
280 940
281Example: Install an Event watcher that automatically calls 941Example: Install an Event watcher that automatically calls
282IO::AIO::poll_cb with high priority: 942IO::AIO::poll_cb with high priority:
283 943
284 Event->io (fd => IO::AIO::poll_fileno, 944 Event->io (fd => IO::AIO::poll_fileno,
285 poll => 'r', async => 1, 945 poll => 'r', async => 1,
286 cb => \&IO::AIO::poll_cb); 946 cb => \&IO::AIO::poll_cb);
287 947
948=item IO::AIO::max_poll_reqs $nreqs
949
950=item IO::AIO::max_poll_time $seconds
951
952These set the maximum number of requests (default C<0>, meaning infinity)
953that are being processed by C<IO::AIO::poll_cb> in one call, respectively
954the maximum amount of time (default C<0>, meaning infinity) spent in
955C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount
956of time C<poll_cb> is allowed to use).
957
958Setting C<max_poll_time> to a non-zero value creates an overhead of one
959syscall per request processed, which is not normally a problem unless your
960callbacks are really really fast or your OS is really really slow (I am
961not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead.
962
963Setting these is useful if you want to ensure some level of
964interactiveness when perl is not fast enough to process all requests in
965time.
966
967For interactive programs, values such as C<0.01> to C<0.1> should be fine.
968
969Example: Install an Event watcher that automatically calls
970IO::AIO::poll_cb with low priority, to ensure that other parts of the
971program get the CPU sometimes even under high AIO load.
972
973 # try not to spend much more than 0.1s in poll_cb
974 IO::AIO::max_poll_time 0.1;
975
976 # use a low priority so other tasks have priority
977 Event->io (fd => IO::AIO::poll_fileno,
978 poll => 'r', nice => 1,
979 cb => &IO::AIO::poll_cb);
980
288=item IO::AIO::poll_wait 981=item IO::AIO::poll_wait
289 982
983If there are any outstanding requests and none of them in the result
290Wait till the result filehandle becomes ready for reading (simply does a 984phase, wait till the result filehandle becomes ready for reading (simply
291C<select> on the filehandle. This is useful if you want to synchronously wait 985does a C<select> on the filehandle. This is useful if you want to
292for some requests to finish). 986synchronously wait for some requests to finish).
293 987
294See C<nreqs> for an example. 988See C<nreqs> for an example.
295 989
990=item IO::AIO::poll
991
992Waits until some requests have been handled.
993
994Returns the number of requests processed, but is otherwise strictly
995equivalent to:
996
997 IO::AIO::poll_wait, IO::AIO::poll_cb
998
296=item IO::AIO::nreqs 999=item IO::AIO::flush
297 1000
298Returns the number of requests currently outstanding (i.e. for which their 1001Wait till all outstanding AIO requests have been handled.
299callback has not been invoked yet).
300 1002
301Example: wait till there are no outstanding requests anymore: 1003Strictly equivalent to:
302 1004
303 IO::AIO::poll_wait, IO::AIO::poll_cb 1005 IO::AIO::poll_wait, IO::AIO::poll_cb
304 while IO::AIO::nreqs; 1006 while IO::AIO::nreqs;
305 1007
306=item IO::AIO::flush 1008=head3 CONTROLLING THE NUMBER OF THREADS
307
308Wait till all outstanding AIO requests have been handled.
309
310Strictly equivalent to:
311
312 IO::AIO::poll_wait, IO::AIO::poll_cb
313 while IO::AIO::nreqs;
314
315=item IO::AIO::poll
316
317Waits until some requests have been handled.
318
319Strictly equivalent to:
320
321 IO::AIO::poll_wait, IO::AIO::poll_cb
322 if IO::AIO::nreqs;
323 1009
324=item IO::AIO::min_parallel $nthreads 1010=item IO::AIO::min_parallel $nthreads
325 1011
326Set the minimum number of AIO threads to C<$nthreads>. The current default 1012Set the minimum number of AIO threads to C<$nthreads>. The current
327is C<4>, which means four asynchronous operations can be done at one time 1013default is C<8>, which means eight asynchronous operations can execute
328(the number of outstanding operations, however, is unlimited). 1014concurrently at any one time (the number of outstanding requests,
1015however, is unlimited).
329 1016
330IO::AIO starts threads only on demand, when an AIO request is queued and 1017IO::AIO starts threads only on demand, when an AIO request is queued and
331no free thread exists. 1018no free thread exists. Please note that queueing up a hundred requests can
1019create demand for a hundred threads, even if it turns out that everything
1020is in the cache and could have been processed faster by a single thread.
332 1021
333It is recommended to keep the number of threads low, as some Linux 1022It is recommended to keep the number of threads relatively low, as some
334kernel versions will scale negatively with the number of threads (higher 1023Linux kernel versions will scale negatively with the number of threads
335parallelity => MUCH higher latency). With current Linux 2.6 versions, 4-32 1024(higher parallelity => MUCH higher latency). With current Linux 2.6
336threads should be fine. 1025versions, 4-32 threads should be fine.
337 1026
338Under most circumstances you don't need to call this function, as the 1027Under most circumstances you don't need to call this function, as the
339module selects a default that is suitable for low to moderate load. 1028module selects a default that is suitable for low to moderate load.
340 1029
341=item IO::AIO::max_parallel $nthreads 1030=item IO::AIO::max_parallel $nthreads
350This module automatically runs C<max_parallel 0> at program end, to ensure 1039This module automatically runs C<max_parallel 0> at program end, to ensure
351that all threads are killed and that there are no outstanding requests. 1040that all threads are killed and that there are no outstanding requests.
352 1041
353Under normal circumstances you don't need to call this function. 1042Under normal circumstances you don't need to call this function.
354 1043
1044=item IO::AIO::max_idle $nthreads
1045
1046Limit the number of threads (default: 4) that are allowed to idle (i.e.,
1047threads that did not get a request to process within 10 seconds). That
1048means if a thread becomes idle while C<$nthreads> other threads are also
1049idle, it will free its resources and exit.
1050
1051This is useful when you allow a large number of threads (e.g. 100 or 1000)
1052to allow for extremely high load situations, but want to free resources
1053under normal circumstances (1000 threads can easily consume 30MB of RAM).
1054
1055The default is probably ok in most situations, especially if thread
1056creation is fast. If thread creation is very slow on your system you might
1057want to use larger values.
1058
355=item $oldnreqs = IO::AIO::max_outstanding $nreqs 1059=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs
1060
1061This is a very bad function to use in interactive programs because it
1062blocks, and a bad way to reduce concurrency because it is inexact: Better
1063use an C<aio_group> together with a feed callback.
356 1064
357Sets the maximum number of outstanding requests to C<$nreqs>. If you 1065Sets the maximum number of outstanding requests to C<$nreqs>. If you
358try to queue up more than this number of requests, the caller will block until 1066to queue up more than this number of requests, the next call to the
359some requests have been handled. 1067C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1068function will block until the limit is no longer exceeded.
360 1069
361The default is very large, so normally there is no practical limit. If you 1070The default value is very large, so there is no practical limit on the
362queue up many requests in a loop it often improves speed if you set 1071number of outstanding requests.
363this to a relatively low number, such as C<100>.
364 1072
365Under normal circumstances you don't need to call this function. 1073You can still queue as many requests as you want. Therefore,
1074C<max_oustsanding> is mainly useful in simple scripts (with low values) or
1075as a stop gap to shield against fatal memory overflow (with large values).
1076
1077=head3 STATISTICAL INFORMATION
1078
1079=item IO::AIO::nreqs
1080
1081Returns the number of requests currently in the ready, execute or pending
1082states (i.e. for which their callback has not been invoked yet).
1083
1084Example: wait till there are no outstanding requests anymore:
1085
1086 IO::AIO::poll_wait, IO::AIO::poll_cb
1087 while IO::AIO::nreqs;
1088
1089=item IO::AIO::nready
1090
1091Returns the number of requests currently in the ready state (not yet
1092executed).
1093
1094=item IO::AIO::npending
1095
1096Returns the number of requests currently in the pending state (executed,
1097but not yet processed by poll_cb).
366 1098
367=back 1099=back
368 1100
369=cut 1101=cut
370 1102
382 or return undef; 1114 or return undef;
383 1115
384 *$sym 1116 *$sym
385} 1117}
386 1118
387min_parallel 4; 1119min_parallel 8;
388 1120
389END { 1121END { flush }
390 max_parallel 0;
391}
392 1122
3931; 11231;
394 1124
395=head2 FORK BEHAVIOUR 1125=head2 FORK BEHAVIOUR
1126
1127This module should do "the right thing" when the process using it forks:
396 1128
397Before the fork, IO::AIO enters a quiescent state where no requests 1129Before the fork, IO::AIO enters a quiescent state where no requests
398can be added in other threads and no results will be processed. After 1130can be added in other threads and no results will be processed. After
399the fork the parent simply leaves the quiescent state and continues 1131the fork the parent simply leaves the quiescent state and continues
400request/result processing, while the child clears the request/result 1132request/result processing, while the child frees the request/result queue
401queue (so the requests started before the fork will only be handled in 1133(so that the requests started before the fork will only be handled in the
402the parent). Threats will be started on demand until the limit ste in the 1134parent). Threads will be started on demand until the limit set in the
403parent process has been reached again. 1135parent process has been reached again.
404 1136
1137In short: the parent will, after a short pause, continue as if fork had
1138not been called, while the child will act as if IO::AIO has not been used
1139yet.
1140
1141=head2 MEMORY USAGE
1142
1143Per-request usage:
1144
1145Each aio request uses - depending on your architecture - around 100-200
1146bytes of memory. In addition, stat requests need a stat buffer (possibly
1147a few hundred bytes), readdir requires a result buffer and so on. Perl
1148scalars and other data passed into aio requests will also be locked and
1149will consume memory till the request has entered the done state.
1150
1151This is now awfully much, so queuing lots of requests is not usually a
1152problem.
1153
1154Per-thread usage:
1155
1156In the execution phase, some aio requests require more memory for
1157temporary buffers, and each thread requires a stack and other data
1158structures (usually around 16k-128k, depending on the OS).
1159
1160=head1 KNOWN BUGS
1161
1162Known bugs will be fixed in the next release.
1163
405=head1 SEE ALSO 1164=head1 SEE ALSO
406 1165
407L<Coro>, L<Linux::AIO>. 1166L<Coro::AIO>.
408 1167
409=head1 AUTHOR 1168=head1 AUTHOR
410 1169
411 Marc Lehmann <schmorp@schmorp.de> 1170 Marc Lehmann <schmorp@schmorp.de>
412 http://home.schmorp.de/ 1171 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines