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.54 by root, Sun Oct 22 00:19:05 2006 UTC vs.
Revision 1.169 by root, Sat Jan 2 13:02:20 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines