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.55 by root, Sun Oct 22 00:49:29 2006 UTC vs.
Revision 1.168 by root, Mon Nov 30 22:22:13 2009 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines