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.62 by root, Sun Oct 22 21:13:47 2006 UTC vs.
Revision 1.157 by root, Wed Jun 17 01:14:48 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines