… | |
… | |
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 | |
53 | This module implements asynchronous I/O using whatever means your |
56 | This module implements asynchronous I/O using whatever means your |
54 | operating system supports. |
57 | operating system supports. It is implemented as an interface to C<libeio> |
|
|
58 | (L<http://software.schmorp.de/pkg/libeio.html>). |
55 | |
59 | |
56 | Asynchronous means that operations that can normally block your program |
60 | Asynchronous means that operations that can normally block your program |
57 | (e.g. reading from disk) will be done asynchronously: the operation |
61 | (e.g. reading from disk) will be done asynchronously: the operation |
58 | will still block, but you can do something else in the meantime. This |
62 | will still block, but you can do something else in the meantime. This |
59 | is extremely useful for programs that need to stay interactive even |
63 | is extremely useful for programs that need to stay interactive even |
… | |
… | |
61 | etc.), but can also be used to easily do operations in parallel that are |
65 | etc.), but can also be used to easily do operations in parallel that are |
62 | normally done sequentially, e.g. stat'ing many files, which is much faster |
66 | normally done sequentially, e.g. stat'ing many files, which is much faster |
63 | on a RAID volume or over NFS when you do a number of stat operations |
67 | on a RAID volume or over NFS when you do a number of stat operations |
64 | concurrently. |
68 | concurrently. |
65 | |
69 | |
66 | While this works on all types of file descriptors (for example sockets), |
70 | While most of this works on all types of file descriptors (for |
67 | using these functions on file descriptors that support nonblocking |
71 | example sockets), using these functions on file descriptors that |
68 | operation (again, sockets, pipes etc.) is very inefficient. Use an event |
72 | support nonblocking operation (again, sockets, pipes etc.) is |
69 | loop for that (such as the L<Event|Event> module): IO::AIO will naturally |
73 | very inefficient. Use an event loop for that (such as the L<EV> |
70 | fit into such an event loop itself. |
74 | module): IO::AIO will naturally fit into such an event loop itself. |
71 | |
75 | |
72 | In this version, a number of threads are started that execute your |
76 | In this version, a number of threads are started that execute your |
73 | requests and signal their completion. You don't need thread support |
77 | requests and signal their completion. You don't need thread support |
74 | in perl, and the threads created by this module will not be visible |
78 | in perl, and the threads created by this module will not be visible |
75 | to perl. In the future, this module might make use of the native aio |
79 | to perl. In the future, this module might make use of the native aio |
… | |
… | |
77 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
81 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
78 | files currently, for example), and they would only support aio_read and |
82 | files currently, for example), and they would only support aio_read and |
79 | aio_write, so the remaining functionality would have to be implemented |
83 | aio_write, so the remaining functionality would have to be implemented |
80 | using threads anyway. |
84 | using threads anyway. |
81 | |
85 | |
82 | Although the module will work with in the presence of other (Perl-) |
86 | Although the module will work in the presence of other (Perl-) threads, |
83 | threads, it is currently not reentrant in any way, so use appropriate |
87 | it is currently not reentrant in any way, so use appropriate locking |
84 | locking yourself, always call C<poll_cb> from within the same thread, or |
88 | yourself, always call C<poll_cb> from within the same thread, or never |
85 | never call C<poll_cb> (or other C<aio_> functions) recursively. |
89 | call C<poll_cb> (or other C<aio_> functions) recursively. |
86 | |
90 | |
87 | =head2 EXAMPLE |
91 | =head2 EXAMPLE |
88 | |
92 | |
89 | This is a simple example that uses the Event module and loads |
93 | This is a simple example that uses the EV module and loads |
90 | F</etc/passwd> asynchronously: |
94 | F</etc/passwd> asynchronously: |
91 | |
95 | |
92 | use Fcntl; |
96 | use Fcntl; |
93 | use Event; |
97 | use EV; |
94 | use IO::AIO; |
98 | use IO::AIO; |
95 | |
99 | |
96 | # register the IO::AIO callback with Event |
100 | # register the IO::AIO callback with EV |
97 | Event->io (fd => IO::AIO::poll_fileno, |
101 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
98 | poll => 'r', |
|
|
99 | cb => \&IO::AIO::poll_cb); |
|
|
100 | |
102 | |
101 | # queue the request to open /etc/passwd |
103 | # queue the request to open /etc/passwd |
102 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
104 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
103 | my $fh = $_[0] |
105 | my $fh = shift |
104 | or die "error while opening: $!"; |
106 | or die "error while opening: $!"; |
105 | |
107 | |
106 | # stat'ing filehandles is generally non-blocking |
108 | # stat'ing filehandles is generally non-blocking |
107 | my $size = -s $fh; |
109 | my $size = -s $fh; |
108 | |
110 | |
… | |
… | |
116 | |
118 | |
117 | # file contents now in $contents |
119 | # file contents now in $contents |
118 | print $contents; |
120 | print $contents; |
119 | |
121 | |
120 | # exit event loop and program |
122 | # exit event loop and program |
121 | Event::unloop; |
123 | EV::unloop; |
122 | }; |
124 | }; |
123 | }; |
125 | }; |
124 | |
126 | |
125 | # possibly queue up other requests, or open GUI windows, |
127 | # possibly queue up other requests, or open GUI windows, |
126 | # check for sockets etc. etc. |
128 | # check for sockets etc. etc. |
127 | |
129 | |
128 | # process events as long as there are some: |
130 | # process events as long as there are some: |
129 | Event::loop; |
131 | EV::loop; |
130 | |
132 | |
131 | =head1 REQUEST ANATOMY AND LIFETIME |
133 | =head1 REQUEST ANATOMY AND LIFETIME |
132 | |
134 | |
133 | Every C<aio_*> function creates a request. which is a C data structure not |
135 | Every C<aio_*> function creates a request. which is a C data structure not |
134 | directly visible to Perl. |
136 | directly visible to Perl. |
… | |
… | |
182 | |
184 | |
183 | =cut |
185 | =cut |
184 | |
186 | |
185 | package IO::AIO; |
187 | package IO::AIO; |
186 | |
188 | |
187 | no warnings; |
189 | use Carp (); |
188 | use strict 'vars'; |
190 | |
|
|
191 | use common::sense; |
189 | |
192 | |
190 | use base 'Exporter'; |
193 | use base 'Exporter'; |
191 | |
194 | |
192 | BEGIN { |
195 | BEGIN { |
193 | our $VERSION = '2.1'; |
196 | our $VERSION = '3.261'; |
194 | |
197 | |
195 | 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 |
196 | 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 |
197 | aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move |
200 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
198 | aio_copy aio_group aio_nop aio_mknod); |
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); |
|
|
205 | |
199 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
206 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
200 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
207 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
201 | min_parallel max_parallel max_idle |
208 | min_parallel max_parallel max_idle |
202 | nreqs nready npending nthreads |
209 | nreqs nready npending nthreads |
203 | max_poll_time max_poll_reqs); |
210 | max_poll_time max_poll_reqs |
|
|
211 | sendfile fadvise); |
|
|
212 | |
|
|
213 | push @AIO_REQ, qw(aio_busy); # not exported |
204 | |
214 | |
205 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
215 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
206 | |
216 | |
207 | require XSLoader; |
217 | require XSLoader; |
208 | XSLoader::load ("IO::AIO", $VERSION); |
218 | XSLoader::load ("IO::AIO", $VERSION); |
… | |
… | |
215 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
225 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
216 | with the same name (sans C<aio_>). The arguments are similar or identical, |
226 | with the same name (sans C<aio_>). The arguments are similar or identical, |
217 | and they all accept an additional (and optional) C<$callback> argument |
227 | and they all accept an additional (and optional) C<$callback> argument |
218 | which must be a code reference. This code reference will get called with |
228 | which must be a code reference. This code reference will get called with |
219 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
229 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
220 | perl, which usually delivers "false") as it's sole argument when the given |
230 | perl, which usually delivers "false") as its sole argument after the given |
221 | syscall has been executed asynchronously. |
231 | syscall has been executed asynchronously. |
222 | |
232 | |
223 | All functions expecting a filehandle keep a copy of the filehandle |
233 | All functions expecting a filehandle keep a copy of the filehandle |
224 | internally until the request has finished. |
234 | internally until the request has finished. |
225 | |
235 | |
… | |
… | |
239 | your pathnames to the locale (or other) encoding in effect in the user |
249 | your pathnames to the locale (or other) encoding in effect in the user |
240 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
250 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
241 | use something else to ensure your scalar has the correct contents. |
251 | use something else to ensure your scalar has the correct contents. |
242 | |
252 | |
243 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
253 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
244 | handles correctly wether it is set or not. |
254 | handles correctly whether it is set or not. |
245 | |
255 | |
246 | =over 4 |
256 | =over 4 |
247 | |
257 | |
248 | =item $prev_pri = aioreq_pri [$pri] |
258 | =item $prev_pri = aioreq_pri [$pri] |
249 | |
259 | |
… | |
… | |
269 | aio_read $_[0], ..., sub { |
279 | aio_read $_[0], ..., sub { |
270 | ... |
280 | ... |
271 | }; |
281 | }; |
272 | }; |
282 | }; |
273 | |
283 | |
|
|
284 | |
274 | =item aioreq_nice $pri_adjust |
285 | =item aioreq_nice $pri_adjust |
275 | |
286 | |
276 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
287 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
277 | priority, so the effect is cumulative. |
288 | priority, so the effect is cumulative. |
|
|
289 | |
278 | |
290 | |
279 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
291 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
280 | |
292 | |
281 | Asynchronously open or create a file and call the callback with a newly |
293 | Asynchronously open or create a file and call the callback with a newly |
282 | created filehandle for the file. |
294 | created filehandle for the file. |
… | |
… | |
288 | list. They are the same as used by C<sysopen>. |
300 | list. They are the same as used by C<sysopen>. |
289 | |
301 | |
290 | Likewise, C<$mode> specifies the mode of the newly created file, if it |
302 | Likewise, C<$mode> specifies the mode of the newly created file, if it |
291 | didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, |
303 | didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, |
292 | except that it is mandatory (i.e. use C<0> if you don't create new files, |
304 | except that it is mandatory (i.e. use C<0> if you don't create new files, |
293 | and C<0666> or C<0777> if you do). |
305 | and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified |
|
|
306 | by the umask in effect then the request is being executed, so better never |
|
|
307 | change the umask. |
294 | |
308 | |
295 | Example: |
309 | Example: |
296 | |
310 | |
297 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
311 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
298 | if ($_[0]) { |
312 | if ($_[0]) { |
… | |
… | |
301 | } else { |
315 | } else { |
302 | die "open failed: $!\n"; |
316 | die "open failed: $!\n"; |
303 | } |
317 | } |
304 | }; |
318 | }; |
305 | |
319 | |
|
|
320 | |
306 | =item aio_close $fh, $callback->($status) |
321 | =item aio_close $fh, $callback->($status) |
307 | |
322 | |
308 | Asynchronously close a file and call the callback with the result |
323 | Asynchronously close a file and call the callback with the result |
309 | code. I<WARNING:> although accepted, you should not pass in a perl |
324 | code. |
310 | filehandle here, as perl will likely close the file descriptor another |
|
|
311 | time when the filehandle is destroyed. Normally, you can safely call perls |
|
|
312 | C<close> or just let filehandles go out of scope. |
|
|
313 | |
325 | |
314 | This is supposed to be a bug in the API, so that might change. It's |
326 | Unfortunately, you can't do this to perl. Perl I<insists> very strongly on |
315 | therefore best to avoid this function. |
327 | closing the file descriptor associated with the filehandle itself. |
|
|
328 | |
|
|
329 | Therefore, C<aio_close> will not close the filehandle - instead it will |
|
|
330 | use 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 | |
|
|
333 | Or in other words: the file descriptor will be closed, but it will not be |
|
|
334 | free for reuse until the perl filehandle is closed. |
|
|
335 | |
|
|
336 | =cut |
316 | |
337 | |
317 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
338 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
318 | |
339 | |
319 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
340 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
320 | |
341 | |
321 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
342 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
322 | into the scalar given by C<data> and offset C<dataoffset> and calls the |
343 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> |
323 | callback without the actual number of bytes read (or -1 on error, just |
344 | and calls the callback without the actual number of bytes read (or -1 on |
324 | like the syscall). |
345 | error, just like the syscall). |
|
|
346 | |
|
|
347 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
|
|
348 | offset plus the actual number of bytes read. |
|
|
349 | |
|
|
350 | If C<$offset> is undefined, then the current file descriptor offset will |
|
|
351 | be used (and updated), otherwise the file descriptor offset will not be |
|
|
352 | changed by these calls. |
|
|
353 | |
|
|
354 | If C<$length> is undefined in C<aio_write>, use the remaining length of |
|
|
355 | C<$data>. |
|
|
356 | |
|
|
357 | If C<$dataoffset> is less than zero, it will be counted from the end of |
|
|
358 | C<$data>. |
325 | |
359 | |
326 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
360 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
327 | is outstanding. Modifying it can result in segfaults or WW3 (if the |
361 | is outstanding. Modifying it can result in segfaults or World War III (if |
328 | necessary/optional hardware is installed). |
362 | the necessary/optional hardware is installed). |
329 | |
363 | |
330 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
364 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
331 | offset C<0> within the scalar: |
365 | offset C<0> within the scalar: |
332 | |
366 | |
333 | aio_read $fh, 7, 15, $buffer, 0, sub { |
367 | aio_read $fh, 7, 15, $buffer, 0, sub { |
334 | $_[0] > 0 or die "read error: $!"; |
368 | $_[0] > 0 or die "read error: $!"; |
335 | print "read $_[0] bytes: <$buffer>\n"; |
369 | print "read $_[0] bytes: <$buffer>\n"; |
336 | }; |
370 | }; |
|
|
371 | |
337 | |
372 | |
338 | =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) |
339 | |
374 | |
340 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
375 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
341 | reading at byte offset C<$in_offset>, and starts writing at the current |
376 | reading at byte offset C<$in_offset>, and starts writing at the current |
… | |
… | |
355 | C<$in_fh> than are written, and there is no way to find out how many |
390 | C<$in_fh> than are written, and there is no way to find out how many |
356 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
391 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
357 | provides the number of bytes written to C<$out_fh>. Only if the result |
392 | provides the number of bytes written to C<$out_fh>. Only if the result |
358 | value equals C<$length> one can assume that C<$length> bytes have been |
393 | value equals C<$length> one can assume that C<$length> bytes have been |
359 | read. |
394 | read. |
|
|
395 | |
360 | |
396 | |
361 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
397 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
362 | |
398 | |
363 | C<aio_readahead> populates the page cache with data from a file so that |
399 | C<aio_readahead> populates the page cache with data from a file so that |
364 | subsequent reads from that file will not block on disk I/O. The C<$offset> |
400 | subsequent reads from that file will not block on disk I/O. The C<$offset> |
… | |
… | |
370 | file. The current file offset of the file is left unchanged. |
406 | file. The current file offset of the file is left unchanged. |
371 | |
407 | |
372 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
408 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
373 | emulated by simply reading the data, which would have a similar effect. |
409 | emulated by simply reading the data, which would have a similar effect. |
374 | |
410 | |
|
|
411 | |
375 | =item aio_stat $fh_or_path, $callback->($status) |
412 | =item aio_stat $fh_or_path, $callback->($status) |
376 | |
413 | |
377 | =item aio_lstat $fh, $callback->($status) |
414 | =item aio_lstat $fh, $callback->($status) |
378 | |
415 | |
379 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
416 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
… | |
… | |
392 | aio_stat "/etc/passwd", sub { |
429 | aio_stat "/etc/passwd", sub { |
393 | $_[0] and die "stat failed: $!"; |
430 | $_[0] and die "stat failed: $!"; |
394 | print "size is ", -s _, "\n"; |
431 | print "size is ", -s _, "\n"; |
395 | }; |
432 | }; |
396 | |
433 | |
|
|
434 | |
|
|
435 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
|
|
436 | |
|
|
437 | Works like perl's C<utime> function (including the special case of $atime |
|
|
438 | and $mtime being undef). Fractional times are supported if the underlying |
|
|
439 | syscalls support them. |
|
|
440 | |
|
|
441 | When called with a pathname, uses utimes(2) if available, otherwise |
|
|
442 | utime(2). If called on a file descriptor, uses futimes(2) if available, |
|
|
443 | otherwise returns ENOSYS, so this is not portable. |
|
|
444 | |
|
|
445 | Examples: |
|
|
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 | |
|
|
455 | Works like perl's C<chown> function, except that C<undef> for either $uid |
|
|
456 | or $gid is being interpreted as "do not change" (but -1 can also be used). |
|
|
457 | |
|
|
458 | Examples: |
|
|
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 | |
|
|
468 | Works like truncate(2) or ftruncate(2). |
|
|
469 | |
|
|
470 | |
|
|
471 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
472 | |
|
|
473 | Works like perl's C<chmod> function. |
|
|
474 | |
|
|
475 | |
397 | =item aio_unlink $pathname, $callback->($status) |
476 | =item aio_unlink $pathname, $callback->($status) |
398 | |
477 | |
399 | Asynchronously unlink (delete) a file and call the callback with the |
478 | Asynchronously unlink (delete) a file and call the callback with the |
400 | result code. |
479 | result code. |
401 | |
480 | |
|
|
481 | |
402 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
482 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
403 | |
483 | |
404 | [EXPERIMENTAL] |
484 | [EXPERIMENTAL] |
405 | |
485 | |
406 | Asynchronously create a device node (or fifo). See mknod(2). |
486 | Asynchronously create a device node (or fifo). See mknod(2). |
407 | |
487 | |
408 | The only (POSIX-) portable way of calling this function is: |
488 | The only (POSIX-) portable way of calling this function is: |
409 | |
489 | |
410 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
490 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
|
|
491 | |
411 | |
492 | |
412 | =item aio_link $srcpath, $dstpath, $callback->($status) |
493 | =item aio_link $srcpath, $dstpath, $callback->($status) |
413 | |
494 | |
414 | Asynchronously create a new link to the existing object at C<$srcpath> at |
495 | Asynchronously create a new link to the existing object at C<$srcpath> at |
415 | the path C<$dstpath> and call the callback with the result code. |
496 | the path C<$dstpath> and call the callback with the result code. |
416 | |
497 | |
|
|
498 | |
417 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
499 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
418 | |
500 | |
419 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
501 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
420 | the path C<$dstpath> and call the callback with the result code. |
502 | the path C<$dstpath> and call the callback with the result code. |
421 | |
503 | |
|
|
504 | |
|
|
505 | =item aio_readlink $path, $callback->($link) |
|
|
506 | |
|
|
507 | Asynchronously read the symlink specified by C<$path> and pass it to |
|
|
508 | the callback. If an error occurs, nothing or undef gets passed to the |
|
|
509 | callback. |
|
|
510 | |
|
|
511 | |
422 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
512 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
423 | |
513 | |
424 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
514 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
425 | rename(2) and call the callback with the result code. |
515 | rename(2) and call the callback with the result code. |
426 | |
516 | |
|
|
517 | |
|
|
518 | =item aio_mkdir $pathname, $mode, $callback->($status) |
|
|
519 | |
|
|
520 | Asynchronously mkdir (create) a directory and call the callback with |
|
|
521 | the result code. C<$mode> will be modified by the umask at the time the |
|
|
522 | request is executed, so do not change your umask. |
|
|
523 | |
|
|
524 | |
427 | =item aio_rmdir $pathname, $callback->($status) |
525 | =item aio_rmdir $pathname, $callback->($status) |
428 | |
526 | |
429 | Asynchronously rmdir (delete) a directory and call the callback with the |
527 | Asynchronously rmdir (delete) a directory and call the callback with the |
430 | result code. |
528 | result code. |
|
|
529 | |
431 | |
530 | |
432 | =item aio_readdir $pathname, $callback->($entries) |
531 | =item aio_readdir $pathname, $callback->($entries) |
433 | |
532 | |
434 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
533 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
435 | directory (i.e. opendir + readdir + closedir). The entries will not be |
534 | directory (i.e. opendir + readdir + closedir). The entries will not be |
436 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
535 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
437 | |
536 | |
438 | The callback a single argument which is either C<undef> or an array-ref |
537 | The callback is passed a single argument which is either C<undef> or an |
439 | with the filenames. |
538 | array-ref with the filenames. |
|
|
539 | |
|
|
540 | |
|
|
541 | =item aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
|
|
542 | |
|
|
543 | Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune |
|
|
544 | behaviour and output format. In case of an error, C<$entries> will be |
|
|
545 | C<undef>. |
|
|
546 | |
|
|
547 | The flags are a combination of the following constants, ORed together (the |
|
|
548 | flags will also be passed to the callback, possibly modified): |
|
|
549 | |
|
|
550 | =over 4 |
|
|
551 | |
|
|
552 | =item IO::AIO::READDIR_DENTS |
|
|
553 | |
|
|
554 | When this flag is off, then the callback gets an arrayref with of names |
|
|
555 | only (as with C<aio_readdir>), otherwise it gets an arrayref with |
|
|
556 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
|
|
557 | entry in more detail. |
|
|
558 | |
|
|
559 | C<$name> is the name of the entry. |
|
|
560 | |
|
|
561 | C<$type> is one of the C<IO::AIO::DT_xxx> constants: |
|
|
562 | |
|
|
563 | C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, |
|
|
564 | C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, |
|
|
565 | C<IO::AIO::DT_WHT>. |
|
|
566 | |
|
|
567 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to |
|
|
568 | know, you have to run stat yourself. Also, for speed reasons, the C<$type> |
|
|
569 | scalars are read-only: you can not modify them. |
|
|
570 | |
|
|
571 | C<$inode> is the inode number (which might not be exact on systems with 64 |
|
|
572 | bit inode numbers and 32 bit perls). This field has unspecified content on |
|
|
573 | systems that do not deliver the inode information. |
|
|
574 | |
|
|
575 | =item IO::AIO::READDIR_DIRS_FIRST |
|
|
576 | |
|
|
577 | When this flag is set, then the names will be returned in an order where |
|
|
578 | likely directories come first. This is useful when you need to quickly |
|
|
579 | find directories, or you want to find all directories while avoiding to |
|
|
580 | stat() each entry. |
|
|
581 | |
|
|
582 | If the system returns type information in readdir, then this is used |
|
|
583 | to find directories directly. Otherwise, likely directories are files |
|
|
584 | beginning with ".", or otherwise files with no dots, of which files with |
|
|
585 | short names are tried first. |
|
|
586 | |
|
|
587 | =item IO::AIO::READDIR_STAT_ORDER |
|
|
588 | |
|
|
589 | When this flag is set, then the names will be returned in an order |
|
|
590 | suitable for stat()'ing each one. That is, when you plan to stat() |
|
|
591 | all files in the given directory, then the returned order will likely |
|
|
592 | be fastest. |
|
|
593 | |
|
|
594 | If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then |
|
|
595 | the likely dirs come first, resulting in a less optimal stat order. |
|
|
596 | |
|
|
597 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
|
|
598 | |
|
|
599 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
|
|
600 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
|
|
601 | C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all |
|
|
602 | C<$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 | |
|
|
609 | This is a composite request that tries to fully load the given file into |
|
|
610 | memory. Status is the same as with aio_read. |
|
|
611 | |
|
|
612 | =cut |
|
|
613 | |
|
|
614 | sub 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 | } |
440 | |
634 | |
441 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
635 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
442 | |
636 | |
443 | Try to copy the I<file> (directories not supported as either source or |
637 | Try to copy the I<file> (directories not supported as either source or |
444 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
638 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
445 | the C<0> (error) or C<-1> ok. |
639 | the C<0> (error) or C<-1> ok. |
446 | |
640 | |
447 | This is a composite request that it creates the destination file with |
641 | This is a composite request that creates the destination file with |
448 | mode 0200 and copies the contents of the source file into it using |
642 | mode 0200 and copies the contents of the source file into it using |
449 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
643 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
450 | uid/gid, in that order. |
644 | uid/gid, in that order. |
451 | |
645 | |
452 | If an error occurs, the partial destination file will be unlinked, if |
646 | If an error occurs, the partial destination file will be unlinked, if |
… | |
… | |
462 | my $grp = aio_group $cb; |
656 | my $grp = aio_group $cb; |
463 | |
657 | |
464 | aioreq_pri $pri; |
658 | aioreq_pri $pri; |
465 | add $grp aio_open $src, O_RDONLY, 0, sub { |
659 | add $grp aio_open $src, O_RDONLY, 0, sub { |
466 | if (my $src_fh = $_[0]) { |
660 | if (my $src_fh = $_[0]) { |
467 | my @stat = stat $src_fh; |
661 | my @stat = stat $src_fh; # hmm, might bock over nfs? |
468 | |
662 | |
469 | aioreq_pri $pri; |
663 | aioreq_pri $pri; |
470 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
664 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
471 | if (my $dst_fh = $_[0]) { |
665 | if (my $dst_fh = $_[0]) { |
472 | aioreq_pri $pri; |
666 | aioreq_pri $pri; |
473 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
667 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
474 | if ($_[0] == $stat[7]) { |
668 | if ($_[0] == $stat[7]) { |
475 | $grp->result (0); |
669 | $grp->result (0); |
476 | close $src_fh; |
670 | close $src_fh; |
477 | |
671 | |
478 | # those should not normally block. should. should. |
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; |
479 | utime $stat[8], $stat[9], $dst; |
687 | add $grp aio_utime $dst, $stat[8], $stat[9], $ch; |
480 | chmod $stat[2] & 07777, $dst_fh; |
688 | } else { |
481 | chown $stat[4], $stat[5], $dst_fh; |
689 | $ch->(); |
|
|
690 | } |
482 | close $dst_fh; |
691 | }; |
483 | } else { |
692 | } else { |
484 | $grp->result (-1); |
693 | $grp->result (-1); |
485 | close $src_fh; |
694 | close $src_fh; |
486 | close $dst_fh; |
695 | close $dst_fh; |
487 | |
696 | |
… | |
… | |
506 | |
715 | |
507 | Try to move the I<file> (directories not supported as either source or |
716 | Try to move the I<file> (directories not supported as either source or |
508 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
717 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
509 | the C<0> (error) or C<-1> ok. |
718 | the C<0> (error) or C<-1> ok. |
510 | |
719 | |
511 | This is a composite request that tries to rename(2) the file first. If |
720 | This is a composite request that tries to rename(2) the file first; if |
512 | rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if |
721 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
513 | that is successful, unlinking the C<$srcpath>. |
722 | that is successful, unlinks the C<$srcpath>. |
514 | |
723 | |
515 | =cut |
724 | =cut |
516 | |
725 | |
517 | sub aio_move($$;$) { |
726 | sub aio_move($$;$) { |
518 | my ($src, $dst, $cb) = @_; |
727 | my ($src, $dst, $cb) = @_; |
… | |
… | |
565 | |
774 | |
566 | Implementation notes. |
775 | Implementation notes. |
567 | |
776 | |
568 | The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. |
777 | The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. |
569 | |
778 | |
|
|
779 | If readdir returns file type information, then this is used directly to |
|
|
780 | find directories. |
|
|
781 | |
570 | After reading the directory, the modification time, size etc. of the |
782 | Otherwise, after reading the directory, the modification time, size etc. |
571 | directory before and after the readdir is checked, and if they match (and |
783 | of the directory before and after the readdir is checked, and if they |
572 | isn't the current time), the link count will be used to decide how many |
784 | match (and isn't the current time), the link count will be used to decide |
573 | entries are directories (if >= 2). Otherwise, no knowledge of the number |
785 | how many entries are directories (if >= 2). Otherwise, no knowledge of the |
574 | of subdirectories will be assumed. |
786 | number of subdirectories will be assumed. |
575 | |
787 | |
576 | Then entries will be sorted into likely directories (everything without |
788 | Then entries will be sorted into likely directories a non-initial dot |
577 | a non-initial dot currently) and likely non-directories (everything |
789 | currently) and likely non-directories (see C<aio_readdirx>). Then every |
578 | else). Then every entry plus an appended C</.> will be C<stat>'ed, |
790 | entry plus an appended C</.> will be C<stat>'ed, likely directories first, |
579 | likely directories first. If that succeeds, it assumes that the entry |
791 | in order of their inode numbers. If that succeeds, it assumes that the |
580 | is a directory or a symlink to directory (which will be checked |
792 | entry is a directory or a symlink to directory (which will be checked |
581 | seperately). This is often faster than stat'ing the entry itself because |
793 | seperately). This is often faster than stat'ing the entry itself because |
582 | filesystems might detect the type of the entry without reading the inode |
794 | filesystems might detect the type of the entry without reading the inode |
583 | data (e.g. ext2fs filetype feature). |
795 | data (e.g. ext2fs filetype feature), even on systems that cannot return |
|
|
796 | the filetype information on readdir. |
584 | |
797 | |
585 | If the known number of directories (link count - 2) has been reached, the |
798 | If the known number of directories (link count - 2) has been reached, the |
586 | rest of the entries is assumed to be non-directories. |
799 | rest of the entries is assumed to be non-directories. |
587 | |
800 | |
588 | This only works with certainty on POSIX (= UNIX) filesystems, which |
801 | This only works with certainty on POSIX (= UNIX) filesystems, which |
… | |
… | |
592 | as those tend to return 0 or 1 as link counts, which disables the |
805 | as those tend to return 0 or 1 as link counts, which disables the |
593 | directory counting heuristic. |
806 | directory counting heuristic. |
594 | |
807 | |
595 | =cut |
808 | =cut |
596 | |
809 | |
597 | sub aio_scandir($$$) { |
810 | sub aio_scandir($$;$) { |
598 | my ($path, $maxreq, $cb) = @_; |
811 | my ($path, $maxreq, $cb) = @_; |
599 | |
812 | |
600 | my $pri = aioreq_pri; |
813 | my $pri = aioreq_pri; |
601 | |
814 | |
602 | my $grp = aio_group $cb; |
815 | my $grp = aio_group $cb; |
… | |
… | |
610 | my $now = time; |
823 | my $now = time; |
611 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
824 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
612 | |
825 | |
613 | # read the directory entries |
826 | # read the directory entries |
614 | aioreq_pri $pri; |
827 | aioreq_pri $pri; |
615 | add $grp aio_readdir $path, sub { |
828 | add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { |
616 | my $entries = shift |
829 | my $entries = shift |
617 | or return $grp->result (); |
830 | or return $grp->result (); |
618 | |
831 | |
619 | # stat the dir another time |
832 | # stat the dir another time |
620 | aioreq_pri $pri; |
833 | aioreq_pri $pri; |
… | |
… | |
626 | # take the slow route if anything looks fishy |
839 | # take the slow route if anything looks fishy |
627 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
840 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
628 | $ndirs = -1; |
841 | $ndirs = -1; |
629 | } else { |
842 | } else { |
630 | # if nlink == 2, we are finished |
843 | # if nlink == 2, we are finished |
631 | # on non-posix-fs's, we rely on nlink < 2 |
844 | # for non-posix-fs's, we rely on nlink < 2 |
632 | $ndirs = (stat _)[3] - 2 |
845 | $ndirs = (stat _)[3] - 2 |
633 | or return $grp->result ([], $entries); |
846 | or return $grp->result ([], $entries); |
634 | } |
847 | } |
635 | |
848 | |
636 | # sort into likely dirs and likely nondirs |
|
|
637 | # dirs == files without ".", short entries first |
|
|
638 | $entries = [map $_->[0], |
|
|
639 | sort { $b->[1] cmp $a->[1] } |
|
|
640 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
|
|
641 | @$entries]; |
|
|
642 | |
|
|
643 | my (@dirs, @nondirs); |
849 | my (@dirs, @nondirs); |
644 | |
850 | |
645 | my $statgrp = add $grp aio_group sub { |
851 | my $statgrp = add $grp aio_group sub { |
646 | $grp->result (\@dirs, \@nondirs); |
852 | $grp->result (\@dirs, \@nondirs); |
647 | }; |
853 | }; |
648 | |
854 | |
649 | limit $statgrp $maxreq; |
855 | limit $statgrp $maxreq; |
650 | feed $statgrp sub { |
856 | feed $statgrp sub { |
651 | return unless @$entries; |
857 | return unless @$entries; |
652 | my $entry = pop @$entries; |
858 | my $entry = shift @$entries; |
653 | |
859 | |
654 | aioreq_pri $pri; |
860 | aioreq_pri $pri; |
655 | add $statgrp aio_stat "$path/$entry/.", sub { |
861 | add $statgrp aio_stat "$path/$entry/.", sub { |
656 | if ($_[0] < 0) { |
862 | if ($_[0] < 0) { |
657 | push @nondirs, $entry; |
863 | push @nondirs, $entry; |
… | |
… | |
678 | }; |
884 | }; |
679 | |
885 | |
680 | $grp |
886 | $grp |
681 | } |
887 | } |
682 | |
888 | |
|
|
889 | =item aio_rmtree $path, $callback->($status) |
|
|
890 | |
|
|
891 | Delete a directory tree starting (and including) C<$path>, return the |
|
|
892 | status of the final C<rmdir> only. This is a composite request that |
|
|
893 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
|
|
894 | everything else. |
|
|
895 | |
|
|
896 | =cut |
|
|
897 | |
|
|
898 | sub aio_rmtree; |
|
|
899 | sub 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 | |
|
|
926 | Asynchronously call sync and call the callback when finished. |
|
|
927 | |
683 | =item aio_fsync $fh, $callback->($status) |
928 | =item aio_fsync $fh, $callback->($status) |
684 | |
929 | |
685 | Asynchronously call fsync on the given filehandle and call the callback |
930 | Asynchronously call fsync on the given filehandle and call the callback |
686 | with the fsync result code. |
931 | with the fsync result code. |
687 | |
932 | |
… | |
… | |
690 | Asynchronously call fdatasync on the given filehandle and call the |
935 | Asynchronously call fdatasync on the given filehandle and call the |
691 | callback with the fdatasync result code. |
936 | callback with the fdatasync result code. |
692 | |
937 | |
693 | If this call isn't available because your OS lacks it or it couldn't be |
938 | If this call isn't available because your OS lacks it or it couldn't be |
694 | detected, it will be emulated by calling C<fsync> instead. |
939 | detected, it will be emulated by calling C<fsync> instead. |
|
|
940 | |
|
|
941 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
|
|
942 | |
|
|
943 | Sync the data portion of the file specified by C<$offset> and C<$length> |
|
|
944 | to disk (but NOT the metadata), by calling the Linux-specific |
|
|
945 | sync_file_range call. If sync_file_range is not available or it returns |
|
|
946 | ENOSYS, then fdatasync or fsync is being substituted. |
|
|
947 | |
|
|
948 | C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, |
|
|
949 | C<IO::AIO::SYNC_FILE_RANGE_WRITE> and |
|
|
950 | C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range |
|
|
951 | manpage for details. |
|
|
952 | |
|
|
953 | =item aio_pathsync $path, $callback->($status) |
|
|
954 | |
|
|
955 | This request tries to open, fsync and close the given path. This is a |
|
|
956 | composite request intended to sync directories after directory operations |
|
|
957 | (E.g. rename). This might not work on all operating systems or have any |
|
|
958 | specific effect, but usually it makes sure that directory changes get |
|
|
959 | written to disc. It works for anything that can be opened for read-only, |
|
|
960 | not just directories. |
|
|
961 | |
|
|
962 | Passes C<0> when everything went ok, and C<-1> on error. |
|
|
963 | |
|
|
964 | =cut |
|
|
965 | |
|
|
966 | sub aio_pathsync($;$) { |
|
|
967 | my ($path, $cb) = @_; |
|
|
968 | |
|
|
969 | my $pri = aioreq_pri; |
|
|
970 | my $grp = aio_group $cb; |
|
|
971 | |
|
|
972 | aioreq_pri $pri; |
|
|
973 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
974 | my ($fh) = @_; |
|
|
975 | if ($fh) { |
|
|
976 | aioreq_pri $pri; |
|
|
977 | add $grp aio_fsync $fh, sub { |
|
|
978 | $grp->result ($_[0]); |
|
|
979 | |
|
|
980 | aioreq_pri $pri; |
|
|
981 | add $grp aio_close $fh; |
|
|
982 | }; |
|
|
983 | } else { |
|
|
984 | $grp->result (-1); |
|
|
985 | } |
|
|
986 | }; |
|
|
987 | |
|
|
988 | $grp |
|
|
989 | } |
695 | |
990 | |
696 | =item aio_group $callback->(...) |
991 | =item aio_group $callback->(...) |
697 | |
992 | |
698 | This is a very special aio request: Instead of doing something, it is a |
993 | This is a very special aio request: Instead of doing something, it is a |
699 | container for other aio requests, which is useful if you want to bundle |
994 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
749 | =item cancel $req |
1044 | =item cancel $req |
750 | |
1045 | |
751 | Cancels the request, if possible. Has the effect of skipping execution |
1046 | Cancels the request, if possible. Has the effect of skipping execution |
752 | when entering the B<execute> state and skipping calling the callback when |
1047 | when entering the B<execute> state and skipping calling the callback when |
753 | entering the the B<result> state, but will leave the request otherwise |
1048 | entering the the B<result> state, but will leave the request otherwise |
754 | untouched. That means that requests that currently execute will not be |
1049 | untouched (with the exception of readdir). That means that requests that |
755 | stopped and resources held by the request will not be freed prematurely. |
1050 | currently execute will not be stopped and resources held by the request |
|
|
1051 | will not be freed prematurely. |
756 | |
1052 | |
757 | =item cb $req $callback->(...) |
1053 | =item cb $req $callback->(...) |
758 | |
1054 | |
759 | Replace (or simply set) the callback registered to the request. |
1055 | Replace (or simply set) the callback registered to the request. |
760 | |
1056 | |
… | |
… | |
811 | Their lifetime, simplified, looks like this: when they are empty, they |
1107 | Their lifetime, simplified, looks like this: when they are empty, they |
812 | will finish very quickly. If they contain only requests that are in the |
1108 | will finish very quickly. If they contain only requests that are in the |
813 | C<done> state, they will also finish. Otherwise they will continue to |
1109 | C<done> state, they will also finish. Otherwise they will continue to |
814 | exist. |
1110 | exist. |
815 | |
1111 | |
816 | That means after creating a group you have some time to add requests. And |
1112 | That means after creating a group you have some time to add requests |
817 | in the callbacks of those requests, you can add further requests to the |
1113 | (precisely before the callback has been invoked, which is only done within |
818 | group. And only when all those requests have finished will the the group |
1114 | the C<poll_cb>). And in the callbacks of those requests, you can add |
819 | itself finish. |
1115 | further requests to the group. And only when all those requests have |
|
|
1116 | finished will the the group itself finish. |
820 | |
1117 | |
821 | =over 4 |
1118 | =over 4 |
822 | |
1119 | |
823 | =item add $grp ... |
1120 | =item add $grp ... |
824 | |
1121 | |
… | |
… | |
836 | itself. Useful when you queued a lot of events but got a result early. |
1133 | itself. Useful when you queued a lot of events but got a result early. |
837 | |
1134 | |
838 | =item $grp->result (...) |
1135 | =item $grp->result (...) |
839 | |
1136 | |
840 | Set the result value(s) that will be passed to the group callback when all |
1137 | Set the result value(s) that will be passed to the group callback when all |
841 | subrequests have finished and set thre groups errno to the current value |
1138 | subrequests have finished and set the groups errno to the current value |
842 | of errno (just like calling C<errno> without an error number). By default, |
1139 | of errno (just like calling C<errno> without an error number). By default, |
843 | no argument will be passed and errno is zero. |
1140 | no argument will be passed and errno is zero. |
844 | |
1141 | |
845 | =item $grp->errno ([$errno]) |
1142 | =item $grp->errno ([$errno]) |
846 | |
1143 | |
… | |
… | |
857 | =item feed $grp $callback->($grp) |
1154 | =item feed $grp $callback->($grp) |
858 | |
1155 | |
859 | Sets a feeder/generator on this group: every group can have an attached |
1156 | Sets a feeder/generator on this group: every group can have an attached |
860 | generator that generates requests if idle. The idea behind this is that, |
1157 | generator that generates requests if idle. The idea behind this is that, |
861 | although you could just queue as many requests as you want in a group, |
1158 | although you could just queue as many requests as you want in a group, |
862 | this might starve other requests for a potentially long time. For |
1159 | this might starve other requests for a potentially long time. For example, |
863 | example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> |
1160 | C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, |
864 | requests, delaying any later requests for a long time. |
1161 | delaying any later requests for a long time. |
865 | |
1162 | |
866 | To avoid this, and allow incremental generation of requests, you can |
1163 | To avoid this, and allow incremental generation of requests, you can |
867 | instead a group and set a feeder on it that generates those requests. The |
1164 | instead a group and set a feeder on it that generates those requests. The |
868 | feed callback will be called whenever there are few enough (see C<limit>, |
1165 | feed callback will be called whenever there are few enough (see C<limit>, |
869 | below) requests active in the group itself and is expected to queue more |
1166 | below) requests active in the group itself and is expected to queue more |
… | |
… | |
873 | not impose any limits). |
1170 | not impose any limits). |
874 | |
1171 | |
875 | If the feed does not queue more requests when called, it will be |
1172 | If the feed does not queue more requests when called, it will be |
876 | automatically removed from the group. |
1173 | automatically removed from the group. |
877 | |
1174 | |
878 | If the feed limit is C<0>, it will be set to C<2> automatically. |
1175 | If the feed limit is C<0> when this method is called, it will be set to |
|
|
1176 | C<2> automatically. |
879 | |
1177 | |
880 | Example: |
1178 | Example: |
881 | |
1179 | |
882 | # stat all files in @files, but only ever use four aio requests concurrently: |
1180 | # stat all files in @files, but only ever use four aio requests concurrently: |
883 | |
1181 | |
… | |
… | |
895 | Sets the feeder limit for the group: The feeder will be called whenever |
1193 | Sets the feeder limit for the group: The feeder will be called whenever |
896 | the group contains less than this many requests. |
1194 | the group contains less than this many requests. |
897 | |
1195 | |
898 | Setting the limit to C<0> will pause the feeding process. |
1196 | Setting the limit to C<0> will pause the feeding process. |
899 | |
1197 | |
|
|
1198 | The default value for the limit is C<0>, but note that setting a feeder |
|
|
1199 | automatically bumps it up to C<2>. |
|
|
1200 | |
900 | =back |
1201 | =back |
901 | |
1202 | |
902 | =head2 SUPPORT FUNCTIONS |
1203 | =head2 SUPPORT FUNCTIONS |
903 | |
1204 | |
904 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1205 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
… | |
… | |
906 | =over 4 |
1207 | =over 4 |
907 | |
1208 | |
908 | =item $fileno = IO::AIO::poll_fileno |
1209 | =item $fileno = IO::AIO::poll_fileno |
909 | |
1210 | |
910 | Return the I<request result pipe file descriptor>. This filehandle must be |
1211 | Return the I<request result pipe file descriptor>. This filehandle must be |
911 | polled for reading by some mechanism outside this module (e.g. Event or |
1212 | polled for reading by some mechanism outside this module (e.g. EV, Glib, |
912 | select, see below or the SYNOPSIS). If the pipe becomes readable you have |
1213 | select and so on, see below or the SYNOPSIS). If the pipe becomes readable |
913 | to call C<poll_cb> to check the results. |
1214 | you have to call C<poll_cb> to check the results. |
914 | |
1215 | |
915 | See C<poll_cb> for an example. |
1216 | See C<poll_cb> for an example. |
916 | |
1217 | |
917 | =item IO::AIO::poll_cb |
1218 | =item IO::AIO::poll_cb |
918 | |
1219 | |
919 | Process some outstanding events on the result pipe. You have to call this |
1220 | Process some outstanding events on the result pipe. You have to call this |
920 | regularly. Returns the number of events processed. Returns immediately |
1221 | regularly. Returns C<0> if all events could be processed, or C<-1> if it |
|
|
1222 | returned earlier for whatever reason. Returns immediately when no events |
921 | when no events are outstanding. The amount of events processed depends on |
1223 | are outstanding. The amount of events processed depends on the settings of |
922 | the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1224 | C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
923 | |
1225 | |
924 | If not all requests were processed for whatever reason, the filehandle |
1226 | If not all requests were processed for whatever reason, the filehandle |
925 | will still be ready when C<poll_cb> returns. |
1227 | will still be ready when C<poll_cb> returns, so normally you don't have to |
|
|
1228 | do anything special to have it called later. |
926 | |
1229 | |
927 | Example: Install an Event watcher that automatically calls |
1230 | Example: Install an Event watcher that automatically calls |
928 | IO::AIO::poll_cb with high priority: |
1231 | IO::AIO::poll_cb with high priority (more examples can be found in the |
|
|
1232 | SYNOPSIS section, at the top of this document): |
929 | |
1233 | |
930 | Event->io (fd => IO::AIO::poll_fileno, |
1234 | Event->io (fd => IO::AIO::poll_fileno, |
931 | poll => 'r', async => 1, |
1235 | poll => 'r', async => 1, |
932 | cb => \&IO::AIO::poll_cb); |
1236 | cb => \&IO::AIO::poll_cb); |
933 | |
1237 | |
… | |
… | |
939 | that are being processed by C<IO::AIO::poll_cb> in one call, respectively |
1243 | that are being processed by C<IO::AIO::poll_cb> in one call, respectively |
940 | the maximum amount of time (default C<0>, meaning infinity) spent in |
1244 | the maximum amount of time (default C<0>, meaning infinity) spent in |
941 | C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount |
1245 | C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount |
942 | of time C<poll_cb> is allowed to use). |
1246 | of time C<poll_cb> is allowed to use). |
943 | |
1247 | |
|
|
1248 | Setting C<max_poll_time> to a non-zero value creates an overhead of one |
|
|
1249 | syscall per request processed, which is not normally a problem unless your |
|
|
1250 | callbacks are really really fast or your OS is really really slow (I am |
|
|
1251 | not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead. |
|
|
1252 | |
944 | Setting these is useful if you want to ensure some level of |
1253 | Setting these is useful if you want to ensure some level of |
945 | interactiveness when perl is not fast enough to process all requests in |
1254 | interactiveness when perl is not fast enough to process all requests in |
946 | time. |
1255 | time. |
947 | |
1256 | |
948 | For interactive programs, values such as C<0.01> to C<0.1> should be fine. |
1257 | For interactive programs, values such as C<0.01> to C<0.1> should be fine. |
949 | |
1258 | |
950 | Example: Install an Event watcher that automatically calls |
1259 | Example: Install an Event watcher that automatically calls |
951 | IO::AIO::poll_some with low priority, to ensure that other parts of the |
1260 | IO::AIO::poll_cb with low priority, to ensure that other parts of the |
952 | program get the CPU sometimes even under high AIO load. |
1261 | program get the CPU sometimes even under high AIO load. |
953 | |
1262 | |
954 | # try not to spend much more than 0.1s in poll_cb |
1263 | # try not to spend much more than 0.1s in poll_cb |
955 | IO::AIO::max_poll_time 0.1; |
1264 | IO::AIO::max_poll_time 0.1; |
956 | |
1265 | |
… | |
… | |
959 | poll => 'r', nice => 1, |
1268 | poll => 'r', nice => 1, |
960 | cb => &IO::AIO::poll_cb); |
1269 | cb => &IO::AIO::poll_cb); |
961 | |
1270 | |
962 | =item IO::AIO::poll_wait |
1271 | =item IO::AIO::poll_wait |
963 | |
1272 | |
|
|
1273 | If there are any outstanding requests and none of them in the result |
964 | Wait till the result filehandle becomes ready for reading (simply does a |
1274 | phase, wait till the result filehandle becomes ready for reading (simply |
965 | C<select> on the filehandle. This is useful if you want to synchronously |
1275 | does a C<select> on the filehandle. This is useful if you want to |
966 | wait for some requests to finish). |
1276 | synchronously wait for some requests to finish). |
967 | |
1277 | |
968 | See C<nreqs> for an example. |
1278 | See C<nreqs> for an example. |
969 | |
1279 | |
970 | =item IO::AIO::poll |
1280 | =item IO::AIO::poll |
971 | |
1281 | |
972 | Waits until some requests have been handled. |
1282 | Waits until some requests have been handled. |
973 | |
1283 | |
|
|
1284 | Returns the number of requests processed, but is otherwise strictly |
974 | Strictly equivalent to: |
1285 | equivalent to: |
975 | |
1286 | |
976 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1287 | IO::AIO::poll_wait, IO::AIO::poll_cb |
977 | if IO::AIO::nreqs; |
|
|
978 | |
1288 | |
979 | =item IO::AIO::flush |
1289 | =item IO::AIO::flush |
980 | |
1290 | |
981 | Wait till all outstanding AIO requests have been handled. |
1291 | Wait till all outstanding AIO requests have been handled. |
982 | |
1292 | |
983 | Strictly equivalent to: |
1293 | Strictly equivalent to: |
984 | |
1294 | |
985 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1295 | IO::AIO::poll_wait, IO::AIO::poll_cb |
986 | while IO::AIO::nreqs; |
1296 | while IO::AIO::nreqs; |
987 | |
1297 | |
|
|
1298 | =back |
|
|
1299 | |
988 | =head3 CONTROLLING THE NUMBER OF THREADS |
1300 | =head3 CONTROLLING THE NUMBER OF THREADS |
|
|
1301 | |
|
|
1302 | =over |
989 | |
1303 | |
990 | =item IO::AIO::min_parallel $nthreads |
1304 | =item IO::AIO::min_parallel $nthreads |
991 | |
1305 | |
992 | Set the minimum number of AIO threads to C<$nthreads>. The current |
1306 | Set the minimum number of AIO threads to C<$nthreads>. The current |
993 | default is C<8>, which means eight asynchronous operations can execute |
1307 | default is C<8>, which means eight asynchronous operations can execute |
… | |
… | |
1034 | |
1348 | |
1035 | The default is probably ok in most situations, especially if thread |
1349 | The default is probably ok in most situations, especially if thread |
1036 | creation is fast. If thread creation is very slow on your system you might |
1350 | creation is fast. If thread creation is very slow on your system you might |
1037 | want to use larger values. |
1351 | want to use larger values. |
1038 | |
1352 | |
1039 | =item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs |
1353 | =item IO::AIO::max_outstanding $maxreqs |
1040 | |
1354 | |
1041 | This is a very bad function to use in interactive programs because it |
1355 | This is a very bad function to use in interactive programs because it |
1042 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1356 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1043 | use an C<aio_group> together with a feed callback. |
1357 | use an C<aio_group> together with a feed callback. |
1044 | |
1358 | |
1045 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1359 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1046 | to queue up more than this number of requests, the next call to the |
1360 | do queue up more than this number of requests, the next call to the |
1047 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1361 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1048 | function will block until the limit is no longer exceeded. |
1362 | function will block until the limit is no longer exceeded. |
1049 | |
1363 | |
1050 | The default value is very large, so there is no practical limit on the |
1364 | The default value is very large, so there is no practical limit on the |
1051 | number of outstanding requests. |
1365 | number of outstanding requests. |
1052 | |
1366 | |
1053 | You can still queue as many requests as you want. Therefore, |
1367 | You can still queue as many requests as you want. Therefore, |
1054 | C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
1368 | C<max_outstanding> is mainly useful in simple scripts (with low values) or |
1055 | as a stop gap to shield against fatal memory overflow (with large values). |
1369 | as a stop gap to shield against fatal memory overflow (with large values). |
1056 | |
1370 | |
|
|
1371 | =back |
|
|
1372 | |
1057 | =head3 STATISTICAL INFORMATION |
1373 | =head3 STATISTICAL INFORMATION |
|
|
1374 | |
|
|
1375 | =over |
1058 | |
1376 | |
1059 | =item IO::AIO::nreqs |
1377 | =item IO::AIO::nreqs |
1060 | |
1378 | |
1061 | Returns the number of requests currently in the ready, execute or pending |
1379 | Returns the number of requests currently in the ready, execute or pending |
1062 | states (i.e. for which their callback has not been invoked yet). |
1380 | states (i.e. for which their callback has not been invoked yet). |
… | |
… | |
1076 | Returns the number of requests currently in the pending state (executed, |
1394 | Returns the number of requests currently in the pending state (executed, |
1077 | but not yet processed by poll_cb). |
1395 | but not yet processed by poll_cb). |
1078 | |
1396 | |
1079 | =back |
1397 | =back |
1080 | |
1398 | |
|
|
1399 | =head3 MISCELLANEOUS FUNCTIONS |
|
|
1400 | |
|
|
1401 | IO::AIO implements some functions that might be useful, but are not |
|
|
1402 | asynchronous. |
|
|
1403 | |
|
|
1404 | =over 4 |
|
|
1405 | |
|
|
1406 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
|
|
1407 | |
|
|
1408 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
|
|
1409 | but is blocking (this makes most sense if you know the input data is |
|
|
1410 | likely cached already and the output filehandle is set to non-blocking |
|
|
1411 | operations). |
|
|
1412 | |
|
|
1413 | Returns the number of bytes copied, or C<-1> on error. |
|
|
1414 | |
|
|
1415 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
1416 | |
|
|
1417 | Simply calls the C<posix_fadvise> function (see it's |
|
|
1418 | manpage for details). The following advice constants are |
|
|
1419 | avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
|
|
1420 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
|
|
1421 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
|
|
1422 | |
|
|
1423 | On systems that do not implement C<posix_fadvise>, this function returns |
|
|
1424 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
|
|
1425 | |
|
|
1426 | =back |
|
|
1427 | |
1081 | =cut |
1428 | =cut |
1082 | |
1429 | |
1083 | # support function to convert a fd into a perl filehandle |
|
|
1084 | sub _fd2fh { |
|
|
1085 | return undef if $_[0] < 0; |
|
|
1086 | |
|
|
1087 | # try to generate nice filehandles |
|
|
1088 | my $sym = "IO::AIO::fd#$_[0]"; |
|
|
1089 | local *$sym; |
|
|
1090 | |
|
|
1091 | open *$sym, "+<&=$_[0]" # usually works under any unix |
|
|
1092 | or open *$sym, "<&=$_[0]" # cygwin needs this |
|
|
1093 | or open *$sym, ">&=$_[0]" # or this |
|
|
1094 | or return undef; |
|
|
1095 | |
|
|
1096 | *$sym |
|
|
1097 | } |
|
|
1098 | |
|
|
1099 | min_parallel 8; |
1430 | min_parallel 8; |
1100 | |
1431 | |
1101 | END { |
1432 | END { flush } |
1102 | min_parallel 1; |
|
|
1103 | flush; |
|
|
1104 | }; |
|
|
1105 | |
1433 | |
1106 | 1; |
1434 | 1; |
1107 | |
1435 | |
1108 | =head2 FORK BEHAVIOUR |
1436 | =head2 FORK BEHAVIOUR |
1109 | |
1437 | |
… | |
… | |
1129 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1457 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1130 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1458 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1131 | scalars and other data passed into aio requests will also be locked and |
1459 | scalars and other data passed into aio requests will also be locked and |
1132 | will consume memory till the request has entered the done state. |
1460 | will consume memory till the request has entered the done state. |
1133 | |
1461 | |
1134 | This is now awfully much, so queuing lots of requests is not usually a |
1462 | This is not awfully much, so queuing lots of requests is not usually a |
1135 | problem. |
1463 | problem. |
1136 | |
1464 | |
1137 | Per-thread usage: |
1465 | Per-thread usage: |
1138 | |
1466 | |
1139 | In the execution phase, some aio requests require more memory for |
1467 | In the execution phase, some aio requests require more memory for |
… | |
… | |
1144 | |
1472 | |
1145 | Known bugs will be fixed in the next release. |
1473 | Known bugs will be fixed in the next release. |
1146 | |
1474 | |
1147 | =head1 SEE ALSO |
1475 | =head1 SEE ALSO |
1148 | |
1476 | |
1149 | L<Coro::AIO>. |
1477 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
|
|
1478 | more natural syntax. |
1150 | |
1479 | |
1151 | =head1 AUTHOR |
1480 | =head1 AUTHOR |
1152 | |
1481 | |
1153 | Marc Lehmann <schmorp@schmorp.de> |
1482 | Marc Lehmann <schmorp@schmorp.de> |
1154 | http://home.schmorp.de/ |
1483 | http://home.schmorp.de/ |