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.1 by root, Sun Jul 10 17:07:44 2005 UTC vs.
Revision 1.87 by root, Sun Oct 29 00:52:02 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines