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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines