… | |
… | |
26 | $req->cancel; # cancel request if still in queue |
26 | $req->cancel; # cancel request if still in queue |
27 | |
27 | |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
29 | add $grp aio_stat "..." for ...; |
29 | add $grp aio_stat "..." for ...; |
30 | |
30 | |
|
|
31 | # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
|
|
32 | use AnyEvent::AIO; |
|
|
33 | |
31 | # AnyEvent integration |
34 | # EV integration |
32 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
35 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
33 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
|
|
34 | |
36 | |
35 | # Event integration |
37 | # Event integration |
36 | Event->io (fd => IO::AIO::poll_fileno, |
38 | Event->io (fd => IO::AIO::poll_fileno, |
37 | poll => 'r', |
39 | poll => 'r', |
38 | cb => \&IO::AIO::poll_cb); |
40 | cb => \&IO::AIO::poll_cb); |
… | |
… | |
62 | etc.), but can also be used to easily do operations in parallel that are |
64 | etc.), but can also be used to easily do operations in parallel that are |
63 | normally done sequentially, e.g. stat'ing many files, which is much faster |
65 | normally done sequentially, e.g. stat'ing many files, which is much faster |
64 | on a RAID volume or over NFS when you do a number of stat operations |
66 | on a RAID volume or over NFS when you do a number of stat operations |
65 | concurrently. |
67 | concurrently. |
66 | |
68 | |
67 | While most of this works on all types of file descriptors (for example |
69 | While most of this works on all types of file descriptors (for |
68 | sockets), using these functions on file descriptors that support |
70 | example sockets), using these functions on file descriptors that |
69 | nonblocking operation (again, sockets, pipes etc.) is very inefficient or |
71 | support nonblocking operation (again, sockets, pipes etc.) is very |
70 | might not work (aio_read fails on sockets/pipes/fifos). Use an event loop |
72 | inefficient. Use an event loop for that (such as the L<Event|Event> |
71 | for that (such as the L<Event|Event> module): IO::AIO will naturally fit |
73 | module): IO::AIO will naturally fit into such an event loop itself. |
72 | into such an event loop itself. |
|
|
73 | |
74 | |
74 | In this version, a number of threads are started that execute your |
75 | In this version, a number of threads are started that execute your |
75 | requests and signal their completion. You don't need thread support |
76 | requests and signal their completion. You don't need thread support |
76 | in perl, and the threads created by this module will not be visible |
77 | in perl, and the threads created by this module will not be visible |
77 | to perl. In the future, this module might make use of the native aio |
78 | to perl. In the future, this module might make use of the native aio |
… | |
… | |
79 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
80 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
80 | files currently, for example), and they would only support aio_read and |
81 | files currently, for example), and they would only support aio_read and |
81 | aio_write, so the remaining functionality would have to be implemented |
82 | aio_write, so the remaining functionality would have to be implemented |
82 | using threads anyway. |
83 | using threads anyway. |
83 | |
84 | |
84 | Although the module will work with in the presence of other (Perl-) |
85 | Although the module will work in the presence of other (Perl-) threads, |
85 | threads, it is currently not reentrant in any way, so use appropriate |
86 | it is currently not reentrant in any way, so use appropriate locking |
86 | locking yourself, always call C<poll_cb> from within the same thread, or |
87 | yourself, always call C<poll_cb> from within the same thread, or never |
87 | never call C<poll_cb> (or other C<aio_> functions) recursively. |
88 | call C<poll_cb> (or other C<aio_> functions) recursively. |
88 | |
89 | |
89 | =head2 EXAMPLE |
90 | =head2 EXAMPLE |
90 | |
91 | |
91 | This is a simple example that uses the Event module and loads |
92 | This is a simple example that uses the Event module and loads |
92 | F</etc/passwd> asynchronously: |
93 | F</etc/passwd> asynchronously: |
… | |
… | |
184 | |
185 | |
185 | =cut |
186 | =cut |
186 | |
187 | |
187 | package IO::AIO; |
188 | package IO::AIO; |
188 | |
189 | |
|
|
190 | use Carp (); |
|
|
191 | |
189 | no warnings; |
192 | no warnings; |
190 | use strict 'vars'; |
193 | use strict 'vars'; |
191 | |
194 | |
192 | use base 'Exporter'; |
195 | use base 'Exporter'; |
193 | |
196 | |
194 | BEGIN { |
197 | BEGIN { |
195 | our $VERSION = '2.31'; |
198 | our $VERSION = '3.19'; |
196 | |
199 | |
197 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
200 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
198 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
201 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
199 | aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link |
202 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
200 | aio_move aio_copy aio_group aio_nop aio_mknod aio_load); |
203 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
|
|
204 | aio_rename aio_link aio_move aio_copy aio_group |
|
|
205 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
|
|
206 | aio_chmod aio_utime aio_truncate); |
|
|
207 | |
201 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
208 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
202 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
209 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
203 | min_parallel max_parallel max_idle |
210 | min_parallel max_parallel max_idle |
204 | nreqs nready npending nthreads |
211 | nreqs nready npending nthreads |
205 | max_poll_time max_poll_reqs); |
212 | max_poll_time max_poll_reqs); |
|
|
213 | |
|
|
214 | push @AIO_REQ, qw(aio_busy); # not exported |
206 | |
215 | |
207 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
216 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
208 | |
217 | |
209 | require XSLoader; |
218 | require XSLoader; |
210 | XSLoader::load ("IO::AIO", $VERSION); |
219 | XSLoader::load ("IO::AIO", $VERSION); |
… | |
… | |
217 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
226 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
218 | with the same name (sans C<aio_>). The arguments are similar or identical, |
227 | with the same name (sans C<aio_>). The arguments are similar or identical, |
219 | and they all accept an additional (and optional) C<$callback> argument |
228 | and they all accept an additional (and optional) C<$callback> argument |
220 | which must be a code reference. This code reference will get called with |
229 | which must be a code reference. This code reference will get called with |
221 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
230 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
222 | perl, which usually delivers "false") as it's sole argument when the given |
231 | perl, which usually delivers "false") as its sole argument after the given |
223 | syscall has been executed asynchronously. |
232 | syscall has been executed asynchronously. |
224 | |
233 | |
225 | All functions expecting a filehandle keep a copy of the filehandle |
234 | All functions expecting a filehandle keep a copy of the filehandle |
226 | internally until the request has finished. |
235 | internally until the request has finished. |
227 | |
236 | |
… | |
… | |
241 | your pathnames to the locale (or other) encoding in effect in the user |
250 | your pathnames to the locale (or other) encoding in effect in the user |
242 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
251 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
243 | use something else to ensure your scalar has the correct contents. |
252 | use something else to ensure your scalar has the correct contents. |
244 | |
253 | |
245 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
254 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
246 | handles correctly wether it is set or not. |
255 | handles correctly whether it is set or not. |
247 | |
256 | |
248 | =over 4 |
257 | =over 4 |
249 | |
258 | |
250 | =item $prev_pri = aioreq_pri [$pri] |
259 | =item $prev_pri = aioreq_pri [$pri] |
251 | |
260 | |
… | |
… | |
271 | aio_read $_[0], ..., sub { |
280 | aio_read $_[0], ..., sub { |
272 | ... |
281 | ... |
273 | }; |
282 | }; |
274 | }; |
283 | }; |
275 | |
284 | |
|
|
285 | |
276 | =item aioreq_nice $pri_adjust |
286 | =item aioreq_nice $pri_adjust |
277 | |
287 | |
278 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
288 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
279 | priority, so the effect is cumulative. |
289 | priority, so the effect is cumulative. |
|
|
290 | |
280 | |
291 | |
281 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
292 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
282 | |
293 | |
283 | Asynchronously open or create a file and call the callback with a newly |
294 | Asynchronously open or create a file and call the callback with a newly |
284 | created filehandle for the file. |
295 | created filehandle for the file. |
… | |
… | |
290 | list. They are the same as used by C<sysopen>. |
301 | list. They are the same as used by C<sysopen>. |
291 | |
302 | |
292 | Likewise, C<$mode> specifies the mode of the newly created file, if it |
303 | Likewise, C<$mode> specifies the mode of the newly created file, if it |
293 | didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, |
304 | didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, |
294 | except that it is mandatory (i.e. use C<0> if you don't create new files, |
305 | except that it is mandatory (i.e. use C<0> if you don't create new files, |
295 | and C<0666> or C<0777> if you do). |
306 | and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified |
|
|
307 | by the umask in effect then the request is being executed, so better never |
|
|
308 | change the umask. |
296 | |
309 | |
297 | Example: |
310 | Example: |
298 | |
311 | |
299 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
312 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
300 | if ($_[0]) { |
313 | if ($_[0]) { |
… | |
… | |
303 | } else { |
316 | } else { |
304 | die "open failed: $!\n"; |
317 | die "open failed: $!\n"; |
305 | } |
318 | } |
306 | }; |
319 | }; |
307 | |
320 | |
|
|
321 | |
308 | =item aio_close $fh, $callback->($status) |
322 | =item aio_close $fh, $callback->($status) |
309 | |
323 | |
310 | Asynchronously close a file and call the callback with the result |
324 | Asynchronously close a file and call the callback with the result |
311 | code. I<WARNING:> although accepted, you should not pass in a perl |
325 | code. |
312 | filehandle here, as perl will likely close the file descriptor another |
|
|
313 | time when the filehandle is destroyed. Normally, you can safely call perls |
|
|
314 | C<close> or just let filehandles go out of scope. |
|
|
315 | |
326 | |
316 | This is supposed to be a bug in the API, so that might change. It's |
327 | Unfortunately, you can't do this to perl. Perl I<insists> very strongly on |
317 | therefore best to avoid this function. |
328 | closing the file descriptor associated with the filehandle itself. |
|
|
329 | |
|
|
330 | Therefore, C<aio_close> will not close the filehandle - instead it will |
|
|
331 | use dup2 to overwrite the file descriptor with the write-end of a pipe |
|
|
332 | (the pipe fd will be created on demand and will be cached). |
|
|
333 | |
|
|
334 | Or in other words: the file descriptor will be closed, but it will not be |
|
|
335 | free for reuse until the perl filehandle is closed. |
|
|
336 | |
|
|
337 | =cut |
318 | |
338 | |
319 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
339 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
320 | |
340 | |
321 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
341 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
322 | |
342 | |
323 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
343 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
324 | into the scalar given by C<data> and offset C<dataoffset> and calls the |
344 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> |
325 | callback without the actual number of bytes read (or -1 on error, just |
345 | and calls the callback without the actual number of bytes read (or -1 on |
326 | like the syscall). |
346 | error, just like the syscall). |
|
|
347 | |
|
|
348 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
|
|
349 | offset plus the actual number of bytes read. |
|
|
350 | |
|
|
351 | If C<$offset> is undefined, then the current file descriptor offset will |
|
|
352 | be used (and updated), otherwise the file descriptor offset will not be |
|
|
353 | changed by these calls. |
|
|
354 | |
|
|
355 | If C<$length> is undefined in C<aio_write>, use the remaining length of |
|
|
356 | C<$data>. |
|
|
357 | |
|
|
358 | If C<$dataoffset> is less than zero, it will be counted from the end of |
|
|
359 | C<$data>. |
327 | |
360 | |
328 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
361 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
329 | is outstanding. Modifying it can result in segfaults or WW3 (if the |
362 | is outstanding. Modifying it can result in segfaults or World War III (if |
330 | necessary/optional hardware is installed). |
363 | the necessary/optional hardware is installed). |
331 | |
364 | |
332 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
365 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
333 | offset C<0> within the scalar: |
366 | offset C<0> within the scalar: |
334 | |
367 | |
335 | aio_read $fh, 7, 15, $buffer, 0, sub { |
368 | aio_read $fh, 7, 15, $buffer, 0, sub { |
336 | $_[0] > 0 or die "read error: $!"; |
369 | $_[0] > 0 or die "read error: $!"; |
337 | print "read $_[0] bytes: <$buffer>\n"; |
370 | print "read $_[0] bytes: <$buffer>\n"; |
338 | }; |
371 | }; |
|
|
372 | |
339 | |
373 | |
340 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
374 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
341 | |
375 | |
342 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
376 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
343 | reading at byte offset C<$in_offset>, and starts writing at the current |
377 | reading at byte offset C<$in_offset>, and starts writing at the current |
… | |
… | |
357 | C<$in_fh> than are written, and there is no way to find out how many |
391 | C<$in_fh> than are written, and there is no way to find out how many |
358 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
392 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
359 | provides the number of bytes written to C<$out_fh>. Only if the result |
393 | provides the number of bytes written to C<$out_fh>. Only if the result |
360 | value equals C<$length> one can assume that C<$length> bytes have been |
394 | value equals C<$length> one can assume that C<$length> bytes have been |
361 | read. |
395 | read. |
|
|
396 | |
362 | |
397 | |
363 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
398 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
364 | |
399 | |
365 | C<aio_readahead> populates the page cache with data from a file so that |
400 | C<aio_readahead> populates the page cache with data from a file so that |
366 | subsequent reads from that file will not block on disk I/O. The C<$offset> |
401 | subsequent reads from that file will not block on disk I/O. The C<$offset> |
… | |
… | |
372 | file. The current file offset of the file is left unchanged. |
407 | file. The current file offset of the file is left unchanged. |
373 | |
408 | |
374 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
409 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
375 | emulated by simply reading the data, which would have a similar effect. |
410 | emulated by simply reading the data, which would have a similar effect. |
376 | |
411 | |
|
|
412 | |
377 | =item aio_stat $fh_or_path, $callback->($status) |
413 | =item aio_stat $fh_or_path, $callback->($status) |
378 | |
414 | |
379 | =item aio_lstat $fh, $callback->($status) |
415 | =item aio_lstat $fh, $callback->($status) |
380 | |
416 | |
381 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
417 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
… | |
… | |
394 | aio_stat "/etc/passwd", sub { |
430 | aio_stat "/etc/passwd", sub { |
395 | $_[0] and die "stat failed: $!"; |
431 | $_[0] and die "stat failed: $!"; |
396 | print "size is ", -s _, "\n"; |
432 | print "size is ", -s _, "\n"; |
397 | }; |
433 | }; |
398 | |
434 | |
|
|
435 | |
|
|
436 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
|
|
437 | |
|
|
438 | Works like perl's C<utime> function (including the special case of $atime |
|
|
439 | and $mtime being undef). Fractional times are supported if the underlying |
|
|
440 | syscalls support them. |
|
|
441 | |
|
|
442 | When called with a pathname, uses utimes(2) if available, otherwise |
|
|
443 | utime(2). If called on a file descriptor, uses futimes(2) if available, |
|
|
444 | otherwise returns ENOSYS, so this is not portable. |
|
|
445 | |
|
|
446 | Examples: |
|
|
447 | |
|
|
448 | # set atime and mtime to current time (basically touch(1)): |
|
|
449 | aio_utime "path", undef, undef; |
|
|
450 | # set atime to current time and mtime to beginning of the epoch: |
|
|
451 | aio_utime "path", time, undef; # undef==0 |
|
|
452 | |
|
|
453 | |
|
|
454 | =item aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
455 | |
|
|
456 | Works like perl's C<chown> function, except that C<undef> for either $uid |
|
|
457 | or $gid is being interpreted as "do not change" (but -1 can also be used). |
|
|
458 | |
|
|
459 | Examples: |
|
|
460 | |
|
|
461 | # same as "chown root path" in the shell: |
|
|
462 | aio_chown "path", 0, -1; |
|
|
463 | # same as above: |
|
|
464 | aio_chown "path", 0, undef; |
|
|
465 | |
|
|
466 | |
|
|
467 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
468 | |
|
|
469 | Works like truncate(2) or ftruncate(2). |
|
|
470 | |
|
|
471 | |
|
|
472 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
473 | |
|
|
474 | Works like perl's C<chmod> function. |
|
|
475 | |
|
|
476 | |
399 | =item aio_unlink $pathname, $callback->($status) |
477 | =item aio_unlink $pathname, $callback->($status) |
400 | |
478 | |
401 | Asynchronously unlink (delete) a file and call the callback with the |
479 | Asynchronously unlink (delete) a file and call the callback with the |
402 | result code. |
480 | result code. |
403 | |
481 | |
|
|
482 | |
404 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
483 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
405 | |
484 | |
406 | [EXPERIMENTAL] |
485 | [EXPERIMENTAL] |
407 | |
486 | |
408 | Asynchronously create a device node (or fifo). See mknod(2). |
487 | Asynchronously create a device node (or fifo). See mknod(2). |
409 | |
488 | |
410 | The only (POSIX-) portable way of calling this function is: |
489 | The only (POSIX-) portable way of calling this function is: |
411 | |
490 | |
412 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
491 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
|
|
492 | |
413 | |
493 | |
414 | =item aio_link $srcpath, $dstpath, $callback->($status) |
494 | =item aio_link $srcpath, $dstpath, $callback->($status) |
415 | |
495 | |
416 | Asynchronously create a new link to the existing object at C<$srcpath> at |
496 | Asynchronously create a new link to the existing object at C<$srcpath> at |
417 | the path C<$dstpath> and call the callback with the result code. |
497 | the path C<$dstpath> and call the callback with the result code. |
418 | |
498 | |
|
|
499 | |
419 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
500 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
420 | |
501 | |
421 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
502 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
422 | the path C<$dstpath> and call the callback with the result code. |
503 | the path C<$dstpath> and call the callback with the result code. |
|
|
504 | |
423 | |
505 | |
424 | =item aio_readlink $path, $callback->($link) |
506 | =item aio_readlink $path, $callback->($link) |
425 | |
507 | |
426 | Asynchronously read the symlink specified by C<$path> and pass it to |
508 | Asynchronously read the symlink specified by C<$path> and pass it to |
427 | the callback. If an error occurs, nothing or undef gets passed to the |
509 | the callback. If an error occurs, nothing or undef gets passed to the |
428 | callback. |
510 | callback. |
429 | |
511 | |
|
|
512 | |
430 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
513 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
431 | |
514 | |
432 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
515 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
433 | rename(2) and call the callback with the result code. |
516 | rename(2) and call the callback with the result code. |
434 | |
517 | |
|
|
518 | |
|
|
519 | =item aio_mkdir $pathname, $mode, $callback->($status) |
|
|
520 | |
|
|
521 | Asynchronously mkdir (create) a directory and call the callback with |
|
|
522 | the result code. C<$mode> will be modified by the umask at the time the |
|
|
523 | request is executed, so do not change your umask. |
|
|
524 | |
|
|
525 | |
435 | =item aio_rmdir $pathname, $callback->($status) |
526 | =item aio_rmdir $pathname, $callback->($status) |
436 | |
527 | |
437 | Asynchronously rmdir (delete) a directory and call the callback with the |
528 | Asynchronously rmdir (delete) a directory and call the callback with the |
438 | result code. |
529 | result code. |
|
|
530 | |
439 | |
531 | |
440 | =item aio_readdir $pathname, $callback->($entries) |
532 | =item aio_readdir $pathname, $callback->($entries) |
441 | |
533 | |
442 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
534 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
443 | directory (i.e. opendir + readdir + closedir). The entries will not be |
535 | directory (i.e. opendir + readdir + closedir). The entries will not be |
444 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
536 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
445 | |
537 | |
446 | The callback a single argument which is either C<undef> or an array-ref |
538 | The callback a single argument which is either C<undef> or an array-ref |
447 | with the filenames. |
539 | with the filenames. |
448 | |
540 | |
|
|
541 | |
449 | =item aio_load $path, $data, $callback->($status) |
542 | =item aio_load $path, $data, $callback->($status) |
450 | |
543 | |
451 | This is a composite request that tries to fully load the given file into |
544 | This is a composite request that tries to fully load the given file into |
452 | memory. Status is the same as with aio_read. |
545 | memory. Status is the same as with aio_read. |
453 | |
546 | |
454 | =cut |
547 | =cut |
455 | |
548 | |
456 | sub aio_load($$;$) { |
549 | sub aio_load($$;$) { |
457 | aio_block { |
|
|
458 | my ($path, undef, $cb) = @_; |
550 | my ($path, undef, $cb) = @_; |
459 | my $data = \$_[1]; |
551 | my $data = \$_[1]; |
460 | |
552 | |
461 | my $pri = aioreq_pri; |
553 | my $pri = aioreq_pri; |
462 | my $grp = aio_group $cb; |
554 | my $grp = aio_group $cb; |
|
|
555 | |
|
|
556 | aioreq_pri $pri; |
|
|
557 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
558 | my $fh = shift |
|
|
559 | or return $grp->result (-1); |
463 | |
560 | |
464 | aioreq_pri $pri; |
561 | aioreq_pri $pri; |
465 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
466 | my ($fh) = @_ |
|
|
467 | or return $grp->result (-1); |
|
|
468 | |
|
|
469 | aioreq_pri $pri; |
|
|
470 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
562 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
471 | $grp->result ($_[0]); |
563 | $grp->result ($_[0]); |
472 | }; |
|
|
473 | }; |
564 | }; |
474 | |
|
|
475 | $grp |
|
|
476 | } |
565 | }; |
|
|
566 | |
|
|
567 | $grp |
477 | } |
568 | } |
478 | |
569 | |
479 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
570 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
480 | |
571 | |
481 | Try to copy the I<file> (directories not supported as either source or |
572 | Try to copy the I<file> (directories not supported as either source or |
482 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
573 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
483 | the C<0> (error) or C<-1> ok. |
574 | the C<0> (error) or C<-1> ok. |
484 | |
575 | |
485 | This is a composite request that it creates the destination file with |
576 | This is a composite request that creates the destination file with |
486 | mode 0200 and copies the contents of the source file into it using |
577 | mode 0200 and copies the contents of the source file into it using |
487 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
578 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
488 | uid/gid, in that order. |
579 | uid/gid, in that order. |
489 | |
580 | |
490 | If an error occurs, the partial destination file will be unlinked, if |
581 | If an error occurs, the partial destination file will be unlinked, if |
… | |
… | |
492 | errors are being ignored. |
583 | errors are being ignored. |
493 | |
584 | |
494 | =cut |
585 | =cut |
495 | |
586 | |
496 | sub aio_copy($$;$) { |
587 | sub aio_copy($$;$) { |
497 | aio_block { |
|
|
498 | my ($src, $dst, $cb) = @_; |
588 | my ($src, $dst, $cb) = @_; |
499 | |
589 | |
500 | my $pri = aioreq_pri; |
590 | my $pri = aioreq_pri; |
501 | my $grp = aio_group $cb; |
591 | my $grp = aio_group $cb; |
502 | |
592 | |
503 | aioreq_pri $pri; |
593 | aioreq_pri $pri; |
504 | add $grp aio_open $src, O_RDONLY, 0, sub { |
594 | add $grp aio_open $src, O_RDONLY, 0, sub { |
505 | if (my $src_fh = $_[0]) { |
595 | if (my $src_fh = $_[0]) { |
506 | my @stat = stat $src_fh; |
596 | my @stat = stat $src_fh; # hmm, might bock over nfs? |
507 | |
597 | |
508 | aioreq_pri $pri; |
598 | aioreq_pri $pri; |
509 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
599 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
510 | if (my $dst_fh = $_[0]) { |
600 | if (my $dst_fh = $_[0]) { |
511 | aioreq_pri $pri; |
601 | aioreq_pri $pri; |
512 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
602 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
513 | if ($_[0] == $stat[7]) { |
603 | if ($_[0] == $stat[7]) { |
514 | $grp->result (0); |
604 | $grp->result (0); |
515 | close $src_fh; |
605 | close $src_fh; |
516 | |
606 | |
517 | # those should not normally block. should. should. |
|
|
518 | utime $stat[8], $stat[9], $dst; |
|
|
519 | chmod $stat[2] & 07777, $dst_fh; |
|
|
520 | chown $stat[4], $stat[5], $dst_fh; |
|
|
521 | close $dst_fh; |
|
|
522 | } else { |
607 | my $ch = sub { |
523 | $grp->result (-1); |
|
|
524 | close $src_fh; |
|
|
525 | close $dst_fh; |
|
|
526 | |
|
|
527 | aioreq $pri; |
608 | aioreq_pri $pri; |
|
|
609 | add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub { |
|
|
610 | aioreq_pri $pri; |
|
|
611 | add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub { |
|
|
612 | aioreq_pri $pri; |
528 | add $grp aio_unlink $dst; |
613 | add $grp aio_close $dst_fh; |
|
|
614 | } |
|
|
615 | }; |
529 | } |
616 | }; |
|
|
617 | |
|
|
618 | aioreq_pri $pri; |
|
|
619 | add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub { |
|
|
620 | if ($_[0] < 0 && $! == ENOSYS) { |
|
|
621 | aioreq_pri $pri; |
|
|
622 | add $grp aio_utime $dst, $stat[8], $stat[9], $ch; |
|
|
623 | } else { |
|
|
624 | $ch->(); |
|
|
625 | } |
|
|
626 | }; |
|
|
627 | } else { |
|
|
628 | $grp->result (-1); |
|
|
629 | close $src_fh; |
|
|
630 | close $dst_fh; |
|
|
631 | |
|
|
632 | aioreq $pri; |
|
|
633 | add $grp aio_unlink $dst; |
530 | }; |
634 | } |
531 | } else { |
|
|
532 | $grp->result (-1); |
|
|
533 | } |
635 | }; |
|
|
636 | } else { |
|
|
637 | $grp->result (-1); |
534 | }, |
638 | } |
535 | |
|
|
536 | } else { |
|
|
537 | $grp->result (-1); |
|
|
538 | } |
639 | }, |
|
|
640 | |
|
|
641 | } else { |
|
|
642 | $grp->result (-1); |
539 | }; |
643 | } |
540 | |
|
|
541 | $grp |
|
|
542 | } |
644 | }; |
|
|
645 | |
|
|
646 | $grp |
543 | } |
647 | } |
544 | |
648 | |
545 | =item aio_move $srcpath, $dstpath, $callback->($status) |
649 | =item aio_move $srcpath, $dstpath, $callback->($status) |
546 | |
650 | |
547 | Try to move the I<file> (directories not supported as either source or |
651 | Try to move the I<file> (directories not supported as either source or |
548 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
652 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
549 | the C<0> (error) or C<-1> ok. |
653 | the C<0> (error) or C<-1> ok. |
550 | |
654 | |
551 | This is a composite request that tries to rename(2) the file first. If |
655 | This is a composite request that tries to rename(2) the file first; if |
552 | rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if |
656 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
553 | that is successful, unlinking the C<$srcpath>. |
657 | that is successful, unlinks the C<$srcpath>. |
554 | |
658 | |
555 | =cut |
659 | =cut |
556 | |
660 | |
557 | sub aio_move($$;$) { |
661 | sub aio_move($$;$) { |
558 | aio_block { |
|
|
559 | my ($src, $dst, $cb) = @_; |
662 | my ($src, $dst, $cb) = @_; |
560 | |
663 | |
561 | my $pri = aioreq_pri; |
664 | my $pri = aioreq_pri; |
562 | my $grp = aio_group $cb; |
665 | my $grp = aio_group $cb; |
563 | |
666 | |
564 | aioreq_pri $pri; |
667 | aioreq_pri $pri; |
565 | add $grp aio_rename $src, $dst, sub { |
668 | add $grp aio_rename $src, $dst, sub { |
566 | if ($_[0] && $! == EXDEV) { |
669 | if ($_[0] && $! == EXDEV) { |
567 | aioreq_pri $pri; |
670 | aioreq_pri $pri; |
568 | add $grp aio_copy $src, $dst, sub { |
671 | add $grp aio_copy $src, $dst, sub { |
569 | $grp->result ($_[0]); |
|
|
570 | |
|
|
571 | if (!$_[0]) { |
|
|
572 | aioreq_pri $pri; |
|
|
573 | add $grp aio_unlink $src; |
|
|
574 | } |
|
|
575 | }; |
|
|
576 | } else { |
|
|
577 | $grp->result ($_[0]); |
672 | $grp->result ($_[0]); |
|
|
673 | |
|
|
674 | if (!$_[0]) { |
|
|
675 | aioreq_pri $pri; |
|
|
676 | add $grp aio_unlink $src; |
|
|
677 | } |
578 | } |
678 | }; |
|
|
679 | } else { |
|
|
680 | $grp->result ($_[0]); |
579 | }; |
681 | } |
580 | |
|
|
581 | $grp |
|
|
582 | } |
682 | }; |
|
|
683 | |
|
|
684 | $grp |
583 | } |
685 | } |
584 | |
686 | |
585 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
687 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
586 | |
688 | |
587 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
689 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
… | |
… | |
634 | as those tend to return 0 or 1 as link counts, which disables the |
736 | as those tend to return 0 or 1 as link counts, which disables the |
635 | directory counting heuristic. |
737 | directory counting heuristic. |
636 | |
738 | |
637 | =cut |
739 | =cut |
638 | |
740 | |
639 | sub aio_scandir($$$) { |
741 | sub aio_scandir($$;$) { |
640 | aio_block { |
|
|
641 | my ($path, $maxreq, $cb) = @_; |
742 | my ($path, $maxreq, $cb) = @_; |
642 | |
743 | |
643 | my $pri = aioreq_pri; |
744 | my $pri = aioreq_pri; |
644 | |
745 | |
645 | my $grp = aio_group $cb; |
746 | my $grp = aio_group $cb; |
646 | |
747 | |
647 | $maxreq = 4 if $maxreq <= 0; |
748 | $maxreq = 4 if $maxreq <= 0; |
648 | |
749 | |
649 | # stat once |
750 | # stat once |
|
|
751 | aioreq_pri $pri; |
|
|
752 | add $grp aio_stat $path, sub { |
|
|
753 | return $grp->result () if $_[0]; |
|
|
754 | my $now = time; |
|
|
755 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
756 | |
|
|
757 | # read the directory entries |
650 | aioreq_pri $pri; |
758 | aioreq_pri $pri; |
651 | add $grp aio_stat $path, sub { |
759 | add $grp aio_readdir $path, sub { |
|
|
760 | my $entries = shift |
652 | return $grp->result () if $_[0]; |
761 | or return $grp->result (); |
653 | my $now = time; |
|
|
654 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
655 | |
762 | |
656 | # read the directory entries |
763 | # stat the dir another time |
657 | aioreq_pri $pri; |
764 | aioreq_pri $pri; |
658 | add $grp aio_readdir $path, sub { |
|
|
659 | my $entries = shift |
|
|
660 | or return $grp->result (); |
|
|
661 | |
|
|
662 | # stat the dir another time |
|
|
663 | aioreq_pri $pri; |
|
|
664 | add $grp aio_stat $path, sub { |
765 | add $grp aio_stat $path, sub { |
665 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
766 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
666 | |
767 | |
667 | my $ndirs; |
768 | my $ndirs; |
668 | |
769 | |
669 | # take the slow route if anything looks fishy |
770 | # take the slow route if anything looks fishy |
670 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
771 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
671 | $ndirs = -1; |
772 | $ndirs = -1; |
672 | } else { |
773 | } else { |
673 | # if nlink == 2, we are finished |
774 | # if nlink == 2, we are finished |
674 | # on non-posix-fs's, we rely on nlink < 2 |
775 | # on non-posix-fs's, we rely on nlink < 2 |
675 | $ndirs = (stat _)[3] - 2 |
776 | $ndirs = (stat _)[3] - 2 |
676 | or return $grp->result ([], $entries); |
777 | or return $grp->result ([], $entries); |
677 | } |
778 | } |
678 | |
779 | |
679 | # sort into likely dirs and likely nondirs |
780 | # sort into likely dirs and likely nondirs |
680 | # dirs == files without ".", short entries first |
781 | # dirs == files without ".", short entries first |
681 | $entries = [map $_->[0], |
782 | $entries = [map $_->[0], |
682 | sort { $b->[1] cmp $a->[1] } |
783 | sort { $b->[1] cmp $a->[1] } |
683 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
784 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
684 | @$entries]; |
785 | @$entries]; |
685 | |
786 | |
686 | my (@dirs, @nondirs); |
787 | my (@dirs, @nondirs); |
687 | |
788 | |
688 | my $statgrp = add $grp aio_group sub { |
789 | my $statgrp = add $grp aio_group sub { |
689 | $grp->result (\@dirs, \@nondirs); |
790 | $grp->result (\@dirs, \@nondirs); |
690 | }; |
791 | }; |
691 | |
792 | |
692 | limit $statgrp $maxreq; |
793 | limit $statgrp $maxreq; |
693 | feed $statgrp sub { |
794 | feed $statgrp sub { |
694 | return unless @$entries; |
795 | return unless @$entries; |
695 | my $entry = pop @$entries; |
796 | my $entry = pop @$entries; |
696 | |
797 | |
697 | aioreq_pri $pri; |
798 | aioreq_pri $pri; |
698 | add $statgrp aio_stat "$path/$entry/.", sub { |
799 | add $statgrp aio_stat "$path/$entry/.", sub { |
699 | if ($_[0] < 0) { |
800 | if ($_[0] < 0) { |
700 | push @nondirs, $entry; |
801 | push @nondirs, $entry; |
701 | } else { |
802 | } else { |
702 | # need to check for real directory |
803 | # need to check for real directory |
703 | aioreq_pri $pri; |
804 | aioreq_pri $pri; |
704 | add $statgrp aio_lstat "$path/$entry", sub { |
805 | add $statgrp aio_lstat "$path/$entry", sub { |
705 | if (-d _) { |
806 | if (-d _) { |
706 | push @dirs, $entry; |
807 | push @dirs, $entry; |
707 | |
808 | |
708 | unless (--$ndirs) { |
809 | unless (--$ndirs) { |
709 | push @nondirs, @$entries; |
810 | push @nondirs, @$entries; |
710 | feed $statgrp; |
811 | feed $statgrp; |
711 | } |
|
|
712 | } else { |
|
|
713 | push @nondirs, $entry; |
|
|
714 | } |
812 | } |
|
|
813 | } else { |
|
|
814 | push @nondirs, $entry; |
715 | } |
815 | } |
716 | } |
816 | } |
717 | }; |
817 | } |
718 | }; |
818 | }; |
719 | }; |
819 | }; |
720 | }; |
820 | }; |
721 | }; |
821 | }; |
722 | |
|
|
723 | $grp |
|
|
724 | } |
822 | }; |
|
|
823 | |
|
|
824 | $grp |
725 | } |
825 | } |
|
|
826 | |
|
|
827 | =item aio_rmtree $path, $callback->($status) |
|
|
828 | |
|
|
829 | Delete a directory tree starting (and including) C<$path>, return the |
|
|
830 | status of the final C<rmdir> only. This is a composite request that |
|
|
831 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
|
|
832 | everything else. |
|
|
833 | |
|
|
834 | =cut |
|
|
835 | |
|
|
836 | sub aio_rmtree; |
|
|
837 | sub aio_rmtree($;$) { |
|
|
838 | my ($path, $cb) = @_; |
|
|
839 | |
|
|
840 | my $pri = aioreq_pri; |
|
|
841 | my $grp = aio_group $cb; |
|
|
842 | |
|
|
843 | aioreq_pri $pri; |
|
|
844 | add $grp aio_scandir $path, 0, sub { |
|
|
845 | my ($dirs, $nondirs) = @_; |
|
|
846 | |
|
|
847 | my $dirgrp = aio_group sub { |
|
|
848 | add $grp aio_rmdir $path, sub { |
|
|
849 | $grp->result ($_[0]); |
|
|
850 | }; |
|
|
851 | }; |
|
|
852 | |
|
|
853 | (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs; |
|
|
854 | (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs; |
|
|
855 | |
|
|
856 | add $grp $dirgrp; |
|
|
857 | }; |
|
|
858 | |
|
|
859 | $grp |
|
|
860 | } |
|
|
861 | |
|
|
862 | =item aio_sync $callback->($status) |
|
|
863 | |
|
|
864 | Asynchronously call sync and call the callback when finished. |
726 | |
865 | |
727 | =item aio_fsync $fh, $callback->($status) |
866 | =item aio_fsync $fh, $callback->($status) |
728 | |
867 | |
729 | Asynchronously call fsync on the given filehandle and call the callback |
868 | Asynchronously call fsync on the given filehandle and call the callback |
730 | with the fsync result code. |
869 | with the fsync result code. |
… | |
… | |
734 | Asynchronously call fdatasync on the given filehandle and call the |
873 | Asynchronously call fdatasync on the given filehandle and call the |
735 | callback with the fdatasync result code. |
874 | callback with the fdatasync result code. |
736 | |
875 | |
737 | If this call isn't available because your OS lacks it or it couldn't be |
876 | If this call isn't available because your OS lacks it or it couldn't be |
738 | detected, it will be emulated by calling C<fsync> instead. |
877 | detected, it will be emulated by calling C<fsync> instead. |
|
|
878 | |
|
|
879 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
|
|
880 | |
|
|
881 | Sync the data portion of the file specified by C<$offset> and C<$length> |
|
|
882 | to disk (but NOT the metadata), by calling the Linux-specific |
|
|
883 | sync_file_range call. If sync_file_range is not available or it returns |
|
|
884 | ENOSYS, then fdatasync or fsync is being substituted. |
|
|
885 | |
|
|
886 | C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, |
|
|
887 | C<IO::AIO::SYNC_FILE_RANGE_WRITE> and |
|
|
888 | C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range |
|
|
889 | manpage for details. |
|
|
890 | |
|
|
891 | =item aio_pathsync $path, $callback->($status) |
|
|
892 | |
|
|
893 | This request tries to open, fsync and close the given path. This is a |
|
|
894 | composite request intended to sync directories after directory operations |
|
|
895 | (E.g. rename). This might not work on all operating systems or have any |
|
|
896 | specific effect, but usually it makes sure that directory changes get |
|
|
897 | written to disc. It works for anything that can be opened for read-only, |
|
|
898 | not just directories. |
|
|
899 | |
|
|
900 | Passes C<0> when everything went ok, and C<-1> on error. |
|
|
901 | |
|
|
902 | =cut |
|
|
903 | |
|
|
904 | sub aio_pathsync($;$) { |
|
|
905 | my ($path, $cb) = @_; |
|
|
906 | |
|
|
907 | my $pri = aioreq_pri; |
|
|
908 | my $grp = aio_group $cb; |
|
|
909 | |
|
|
910 | aioreq_pri $pri; |
|
|
911 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
912 | my ($fh) = @_; |
|
|
913 | if ($fh) { |
|
|
914 | aioreq_pri $pri; |
|
|
915 | add $grp aio_fsync $fh, sub { |
|
|
916 | $grp->result ($_[0]); |
|
|
917 | |
|
|
918 | aioreq_pri $pri; |
|
|
919 | add $grp aio_close $fh; |
|
|
920 | }; |
|
|
921 | } else { |
|
|
922 | $grp->result (-1); |
|
|
923 | } |
|
|
924 | }; |
|
|
925 | |
|
|
926 | $grp |
|
|
927 | } |
739 | |
928 | |
740 | =item aio_group $callback->(...) |
929 | =item aio_group $callback->(...) |
741 | |
930 | |
742 | This is a very special aio request: Instead of doing something, it is a |
931 | This is a very special aio request: Instead of doing something, it is a |
743 | container for other aio requests, which is useful if you want to bundle |
932 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
855 | Their lifetime, simplified, looks like this: when they are empty, they |
1044 | Their lifetime, simplified, looks like this: when they are empty, they |
856 | will finish very quickly. If they contain only requests that are in the |
1045 | will finish very quickly. If they contain only requests that are in the |
857 | C<done> state, they will also finish. Otherwise they will continue to |
1046 | C<done> state, they will also finish. Otherwise they will continue to |
858 | exist. |
1047 | exist. |
859 | |
1048 | |
860 | That means after creating a group you have some time to add requests. And |
1049 | That means after creating a group you have some time to add requests |
861 | in the callbacks of those requests, you can add further requests to the |
1050 | (precisely before the callback has been invoked, which is only done within |
862 | group. And only when all those requests have finished will the the group |
1051 | the C<poll_cb>). And in the callbacks of those requests, you can add |
863 | itself finish. |
1052 | further requests to the group. And only when all those requests have |
|
|
1053 | finished will the the group itself finish. |
864 | |
1054 | |
865 | =over 4 |
1055 | =over 4 |
866 | |
1056 | |
867 | =item add $grp ... |
1057 | =item add $grp ... |
868 | |
1058 | |
… | |
… | |
880 | itself. Useful when you queued a lot of events but got a result early. |
1070 | itself. Useful when you queued a lot of events but got a result early. |
881 | |
1071 | |
882 | =item $grp->result (...) |
1072 | =item $grp->result (...) |
883 | |
1073 | |
884 | Set the result value(s) that will be passed to the group callback when all |
1074 | Set the result value(s) that will be passed to the group callback when all |
885 | subrequests have finished and set thre groups errno to the current value |
1075 | subrequests have finished and set the groups errno to the current value |
886 | of errno (just like calling C<errno> without an error number). By default, |
1076 | of errno (just like calling C<errno> without an error number). By default, |
887 | no argument will be passed and errno is zero. |
1077 | no argument will be passed and errno is zero. |
888 | |
1078 | |
889 | =item $grp->errno ([$errno]) |
1079 | =item $grp->errno ([$errno]) |
890 | |
1080 | |
… | |
… | |
901 | =item feed $grp $callback->($grp) |
1091 | =item feed $grp $callback->($grp) |
902 | |
1092 | |
903 | Sets a feeder/generator on this group: every group can have an attached |
1093 | Sets a feeder/generator on this group: every group can have an attached |
904 | generator that generates requests if idle. The idea behind this is that, |
1094 | generator that generates requests if idle. The idea behind this is that, |
905 | although you could just queue as many requests as you want in a group, |
1095 | although you could just queue as many requests as you want in a group, |
906 | this might starve other requests for a potentially long time. For |
1096 | this might starve other requests for a potentially long time. For example, |
907 | example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> |
1097 | C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, |
908 | requests, delaying any later requests for a long time. |
1098 | delaying any later requests for a long time. |
909 | |
1099 | |
910 | To avoid this, and allow incremental generation of requests, you can |
1100 | To avoid this, and allow incremental generation of requests, you can |
911 | instead a group and set a feeder on it that generates those requests. The |
1101 | instead a group and set a feeder on it that generates those requests. The |
912 | feed callback will be called whenever there are few enough (see C<limit>, |
1102 | feed callback will be called whenever there are few enough (see C<limit>, |
913 | below) requests active in the group itself and is expected to queue more |
1103 | below) requests active in the group itself and is expected to queue more |
… | |
… | |
917 | not impose any limits). |
1107 | not impose any limits). |
918 | |
1108 | |
919 | If the feed does not queue more requests when called, it will be |
1109 | If the feed does not queue more requests when called, it will be |
920 | automatically removed from the group. |
1110 | automatically removed from the group. |
921 | |
1111 | |
922 | If the feed limit is C<0>, it will be set to C<2> automatically. |
1112 | If the feed limit is C<0> when this method is called, it will be set to |
|
|
1113 | C<2> automatically. |
923 | |
1114 | |
924 | Example: |
1115 | Example: |
925 | |
1116 | |
926 | # stat all files in @files, but only ever use four aio requests concurrently: |
1117 | # stat all files in @files, but only ever use four aio requests concurrently: |
927 | |
1118 | |
… | |
… | |
939 | Sets the feeder limit for the group: The feeder will be called whenever |
1130 | Sets the feeder limit for the group: The feeder will be called whenever |
940 | the group contains less than this many requests. |
1131 | the group contains less than this many requests. |
941 | |
1132 | |
942 | Setting the limit to C<0> will pause the feeding process. |
1133 | Setting the limit to C<0> will pause the feeding process. |
943 | |
1134 | |
|
|
1135 | The default value for the limit is C<0>, but note that setting a feeder |
|
|
1136 | automatically bumps it up to C<2>. |
|
|
1137 | |
944 | =back |
1138 | =back |
945 | |
1139 | |
946 | =head2 SUPPORT FUNCTIONS |
1140 | =head2 SUPPORT FUNCTIONS |
947 | |
1141 | |
948 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1142 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
… | |
… | |
959 | See C<poll_cb> for an example. |
1153 | See C<poll_cb> for an example. |
960 | |
1154 | |
961 | =item IO::AIO::poll_cb |
1155 | =item IO::AIO::poll_cb |
962 | |
1156 | |
963 | Process some outstanding events on the result pipe. You have to call this |
1157 | Process some outstanding events on the result pipe. You have to call this |
964 | regularly. Returns the number of events processed. Returns immediately |
1158 | regularly. Returns C<0> if all events could be processed, or C<-1> if it |
|
|
1159 | returned earlier for whatever reason. Returns immediately when no events |
965 | when no events are outstanding. The amount of events processed depends on |
1160 | are outstanding. The amount of events processed depends on the settings of |
966 | the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1161 | C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
967 | |
1162 | |
968 | If not all requests were processed for whatever reason, the filehandle |
1163 | If not all requests were processed for whatever reason, the filehandle |
969 | will still be ready when C<poll_cb> returns. |
1164 | will still be ready when C<poll_cb> returns, so normally you don't have to |
|
|
1165 | do anything special to have it called later. |
970 | |
1166 | |
971 | Example: Install an Event watcher that automatically calls |
1167 | Example: Install an Event watcher that automatically calls |
972 | IO::AIO::poll_cb with high priority: |
1168 | IO::AIO::poll_cb with high priority: |
973 | |
1169 | |
974 | Event->io (fd => IO::AIO::poll_fileno, |
1170 | Event->io (fd => IO::AIO::poll_fileno, |
… | |
… | |
1033 | Strictly equivalent to: |
1229 | Strictly equivalent to: |
1034 | |
1230 | |
1035 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1231 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1036 | while IO::AIO::nreqs; |
1232 | while IO::AIO::nreqs; |
1037 | |
1233 | |
|
|
1234 | =back |
|
|
1235 | |
1038 | =head3 CONTROLLING THE NUMBER OF THREADS |
1236 | =head3 CONTROLLING THE NUMBER OF THREADS |
|
|
1237 | |
|
|
1238 | =over |
1039 | |
1239 | |
1040 | =item IO::AIO::min_parallel $nthreads |
1240 | =item IO::AIO::min_parallel $nthreads |
1041 | |
1241 | |
1042 | Set the minimum number of AIO threads to C<$nthreads>. The current |
1242 | Set the minimum number of AIO threads to C<$nthreads>. The current |
1043 | default is C<8>, which means eight asynchronous operations can execute |
1243 | default is C<8>, which means eight asynchronous operations can execute |
… | |
… | |
1084 | |
1284 | |
1085 | The default is probably ok in most situations, especially if thread |
1285 | The default is probably ok in most situations, especially if thread |
1086 | creation is fast. If thread creation is very slow on your system you might |
1286 | creation is fast. If thread creation is very slow on your system you might |
1087 | want to use larger values. |
1287 | want to use larger values. |
1088 | |
1288 | |
1089 | =item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs |
1289 | =item IO::AIO::max_outstanding $maxreqs |
1090 | |
1290 | |
1091 | This is a very bad function to use in interactive programs because it |
1291 | This is a very bad function to use in interactive programs because it |
1092 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1292 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1093 | use an C<aio_group> together with a feed callback. |
1293 | use an C<aio_group> together with a feed callback. |
1094 | |
1294 | |
1095 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1295 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1096 | to queue up more than this number of requests, the next call to the |
1296 | do queue up more than this number of requests, the next call to the |
1097 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1297 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1098 | function will block until the limit is no longer exceeded. |
1298 | function will block until the limit is no longer exceeded. |
1099 | |
1299 | |
1100 | The default value is very large, so there is no practical limit on the |
1300 | The default value is very large, so there is no practical limit on the |
1101 | number of outstanding requests. |
1301 | number of outstanding requests. |
1102 | |
1302 | |
1103 | You can still queue as many requests as you want. Therefore, |
1303 | You can still queue as many requests as you want. Therefore, |
1104 | C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
1304 | C<max_outstanding> is mainly useful in simple scripts (with low values) or |
1105 | as a stop gap to shield against fatal memory overflow (with large values). |
1305 | as a stop gap to shield against fatal memory overflow (with large values). |
1106 | |
1306 | |
|
|
1307 | =back |
|
|
1308 | |
1107 | =head3 STATISTICAL INFORMATION |
1309 | =head3 STATISTICAL INFORMATION |
|
|
1310 | |
|
|
1311 | =over |
1108 | |
1312 | |
1109 | =item IO::AIO::nreqs |
1313 | =item IO::AIO::nreqs |
1110 | |
1314 | |
1111 | Returns the number of requests currently in the ready, execute or pending |
1315 | Returns the number of requests currently in the ready, execute or pending |
1112 | states (i.e. for which their callback has not been invoked yet). |
1316 | states (i.e. for which their callback has not been invoked yet). |
… | |
… | |
1127 | but not yet processed by poll_cb). |
1331 | but not yet processed by poll_cb). |
1128 | |
1332 | |
1129 | =back |
1333 | =back |
1130 | |
1334 | |
1131 | =cut |
1335 | =cut |
1132 | |
|
|
1133 | # support function to convert a fd into a perl filehandle |
|
|
1134 | sub _fd2fh { |
|
|
1135 | return undef if $_[0] < 0; |
|
|
1136 | |
|
|
1137 | # try to generate nice filehandles |
|
|
1138 | my $sym = "IO::AIO::fd#$_[0]"; |
|
|
1139 | local *$sym; |
|
|
1140 | |
|
|
1141 | open *$sym, "+<&=$_[0]" # usually works under any unix |
|
|
1142 | or open *$sym, "<&=$_[0]" # cygwin needs this |
|
|
1143 | or open *$sym, ">&=$_[0]" # or this |
|
|
1144 | or return undef; |
|
|
1145 | |
|
|
1146 | *$sym |
|
|
1147 | } |
|
|
1148 | |
1336 | |
1149 | min_parallel 8; |
1337 | min_parallel 8; |
1150 | |
1338 | |
1151 | END { flush } |
1339 | END { flush } |
1152 | |
1340 | |
… | |
… | |
1176 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1364 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1177 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1365 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1178 | scalars and other data passed into aio requests will also be locked and |
1366 | scalars and other data passed into aio requests will also be locked and |
1179 | will consume memory till the request has entered the done state. |
1367 | will consume memory till the request has entered the done state. |
1180 | |
1368 | |
1181 | This is now awfully much, so queuing lots of requests is not usually a |
1369 | This is not awfully much, so queuing lots of requests is not usually a |
1182 | problem. |
1370 | problem. |
1183 | |
1371 | |
1184 | Per-thread usage: |
1372 | Per-thread usage: |
1185 | |
1373 | |
1186 | In the execution phase, some aio requests require more memory for |
1374 | In the execution phase, some aio requests require more memory for |
… | |
… | |
1191 | |
1379 | |
1192 | Known bugs will be fixed in the next release. |
1380 | Known bugs will be fixed in the next release. |
1193 | |
1381 | |
1194 | =head1 SEE ALSO |
1382 | =head1 SEE ALSO |
1195 | |
1383 | |
1196 | L<Coro::AIO>. |
1384 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
|
|
1385 | more natural syntax. |
1197 | |
1386 | |
1198 | =head1 AUTHOR |
1387 | =head1 AUTHOR |
1199 | |
1388 | |
1200 | Marc Lehmann <schmorp@schmorp.de> |
1389 | Marc Lehmann <schmorp@schmorp.de> |
1201 | http://home.schmorp.de/ |
1390 | http://home.schmorp.de/ |