… | |
… | |
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 | |
… | |
… | |
61 | etc.), but can also be used to easily do operations in parallel that are |
62 | 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 |
63 | 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 |
64 | on a RAID volume or over NFS when you do a number of stat operations |
64 | concurrently. |
65 | concurrently. |
65 | |
66 | |
66 | While this works on all types of file descriptors (for example sockets), |
67 | While most of this works on all types of file descriptors (for |
67 | using these functions on file descriptors that support nonblocking |
68 | example sockets), using these functions on file descriptors that |
68 | operation (again, sockets, pipes etc.) is very inefficient. Use an event |
69 | support nonblocking operation (again, sockets, pipes etc.) is very |
69 | loop for that (such as the L<Event|Event> module): IO::AIO will naturally |
70 | inefficient. Use an event loop for that (such as the L<Event|Event> |
70 | fit into such an event loop itself. |
71 | module): IO::AIO will naturally fit into such an event loop itself. |
71 | |
72 | |
72 | In this version, a number of threads are started that execute your |
73 | In this version, a number of threads are started that execute your |
73 | requests and signal their completion. You don't need thread support |
74 | 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 |
75 | 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 |
76 | 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 |
78 | 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 |
79 | files currently, for example), and they would only support aio_read and |
79 | aio_write, so the remaining functionality would have to be implemented |
80 | aio_write, so the remaining functionality would have to be implemented |
80 | using threads anyway. |
81 | using threads anyway. |
81 | |
82 | |
82 | Although the module will work with in the presence of other (Perl-) |
83 | 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 |
84 | 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 |
85 | 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. |
86 | call C<poll_cb> (or other C<aio_> functions) recursively. |
86 | |
87 | |
87 | =head2 EXAMPLE |
88 | =head2 EXAMPLE |
88 | |
89 | |
89 | This is a simple example that uses the Event module and loads |
90 | This is a simple example that uses the Event module and loads |
90 | F</etc/passwd> asynchronously: |
91 | F</etc/passwd> asynchronously: |
… | |
… | |
98 | poll => 'r', |
99 | poll => 'r', |
99 | cb => \&IO::AIO::poll_cb); |
100 | cb => \&IO::AIO::poll_cb); |
100 | |
101 | |
101 | # queue the request to open /etc/passwd |
102 | # queue the request to open /etc/passwd |
102 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
103 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
103 | my $fh = $_[0] |
104 | my $fh = shift |
104 | or die "error while opening: $!"; |
105 | or die "error while opening: $!"; |
105 | |
106 | |
106 | # stat'ing filehandles is generally non-blocking |
107 | # stat'ing filehandles is generally non-blocking |
107 | my $size = -s $fh; |
108 | my $size = -s $fh; |
108 | |
109 | |
… | |
… | |
188 | use strict 'vars'; |
189 | use strict 'vars'; |
189 | |
190 | |
190 | use base 'Exporter'; |
191 | use base 'Exporter'; |
191 | |
192 | |
192 | BEGIN { |
193 | BEGIN { |
193 | our $VERSION = '2.1'; |
194 | our $VERSION = '2.4'; |
194 | |
195 | |
195 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
196 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
196 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
197 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
197 | aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move |
198 | aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link |
198 | aio_copy aio_group aio_nop aio_mknod); |
199 | aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir |
|
|
200 | aio_chown aio_chmod aio_utime aio_truncate); |
199 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
201 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
200 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
202 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
201 | min_parallel max_parallel max_idle |
203 | min_parallel max_parallel max_idle |
202 | nreqs nready npending nthreads |
204 | nreqs nready npending nthreads |
203 | max_poll_time max_poll_reqs); |
205 | max_poll_time max_poll_reqs); |
204 | |
206 | |
… | |
… | |
269 | aio_read $_[0], ..., sub { |
271 | aio_read $_[0], ..., sub { |
270 | ... |
272 | ... |
271 | }; |
273 | }; |
272 | }; |
274 | }; |
273 | |
275 | |
|
|
276 | |
274 | =item aioreq_nice $pri_adjust |
277 | =item aioreq_nice $pri_adjust |
275 | |
278 | |
276 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
279 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
277 | priority, so the effect is cumulative. |
280 | priority, so the effect is cumulative. |
|
|
281 | |
278 | |
282 | |
279 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
283 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
280 | |
284 | |
281 | Asynchronously open or create a file and call the callback with a newly |
285 | Asynchronously open or create a file and call the callback with a newly |
282 | created filehandle for the file. |
286 | created filehandle for the file. |
… | |
… | |
288 | list. They are the same as used by C<sysopen>. |
292 | list. They are the same as used by C<sysopen>. |
289 | |
293 | |
290 | Likewise, C<$mode> specifies the mode of the newly created file, if it |
294 | 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>, |
295 | 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, |
296 | 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). |
297 | and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified |
|
|
298 | by the umask in effect then the request is being executed, so better never |
|
|
299 | change the umask. |
294 | |
300 | |
295 | Example: |
301 | Example: |
296 | |
302 | |
297 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
303 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
298 | if ($_[0]) { |
304 | if ($_[0]) { |
… | |
… | |
301 | } else { |
307 | } else { |
302 | die "open failed: $!\n"; |
308 | die "open failed: $!\n"; |
303 | } |
309 | } |
304 | }; |
310 | }; |
305 | |
311 | |
|
|
312 | |
306 | =item aio_close $fh, $callback->($status) |
313 | =item aio_close $fh, $callback->($status) |
307 | |
314 | |
308 | Asynchronously close a file and call the callback with the result |
315 | Asynchronously close a file and call the callback with the result |
309 | code. I<WARNING:> although accepted, you should not pass in a perl |
316 | code. I<WARNING:> although accepted, you should not pass in a perl |
310 | filehandle here, as perl will likely close the file descriptor another |
317 | filehandle here, as perl will likely close the file descriptor another |
… | |
… | |
312 | C<close> or just let filehandles go out of scope. |
319 | C<close> or just let filehandles go out of scope. |
313 | |
320 | |
314 | This is supposed to be a bug in the API, so that might change. It's |
321 | This is supposed to be a bug in the API, so that might change. It's |
315 | therefore best to avoid this function. |
322 | therefore best to avoid this function. |
316 | |
323 | |
|
|
324 | |
317 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
325 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
318 | |
326 | |
319 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
327 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
320 | |
328 | |
321 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
329 | Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> |
322 | into the scalar given by C<data> and offset C<dataoffset> and calls the |
330 | into the scalar given by C<$data> and offset C<$dataoffset> and calls the |
323 | callback without the actual number of bytes read (or -1 on error, just |
331 | callback without the actual number of bytes read (or -1 on error, just |
324 | like the syscall). |
332 | like the syscall). |
325 | |
333 | |
|
|
334 | If C<$offset> is undefined, then the current file descriptor offset will |
|
|
335 | be used (and updated), otherwise the file descriptor offset will not be |
|
|
336 | changed by these calls. |
|
|
337 | |
|
|
338 | If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. |
|
|
339 | |
|
|
340 | If C<$dataoffset> is less than zero, it will be counted from the end of |
|
|
341 | C<$data>. |
|
|
342 | |
326 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
343 | 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 |
344 | is outstanding. Modifying it can result in segfaults or World War III (if |
328 | necessary/optional hardware is installed). |
345 | the necessary/optional hardware is installed). |
329 | |
346 | |
330 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
347 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
331 | offset C<0> within the scalar: |
348 | offset C<0> within the scalar: |
332 | |
349 | |
333 | aio_read $fh, 7, 15, $buffer, 0, sub { |
350 | aio_read $fh, 7, 15, $buffer, 0, sub { |
334 | $_[0] > 0 or die "read error: $!"; |
351 | $_[0] > 0 or die "read error: $!"; |
335 | print "read $_[0] bytes: <$buffer>\n"; |
352 | print "read $_[0] bytes: <$buffer>\n"; |
336 | }; |
353 | }; |
|
|
354 | |
337 | |
355 | |
338 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
356 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
339 | |
357 | |
340 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
358 | 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 |
359 | 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 |
373 | 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 |
374 | 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 |
375 | 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 |
376 | value equals C<$length> one can assume that C<$length> bytes have been |
359 | read. |
377 | read. |
|
|
378 | |
360 | |
379 | |
361 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
380 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
362 | |
381 | |
363 | C<aio_readahead> populates the page cache with data from a file so that |
382 | 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> |
383 | 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. |
389 | file. The current file offset of the file is left unchanged. |
371 | |
390 | |
372 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
391 | 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. |
392 | emulated by simply reading the data, which would have a similar effect. |
374 | |
393 | |
|
|
394 | |
375 | =item aio_stat $fh_or_path, $callback->($status) |
395 | =item aio_stat $fh_or_path, $callback->($status) |
376 | |
396 | |
377 | =item aio_lstat $fh, $callback->($status) |
397 | =item aio_lstat $fh, $callback->($status) |
378 | |
398 | |
379 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
399 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
… | |
… | |
392 | aio_stat "/etc/passwd", sub { |
412 | aio_stat "/etc/passwd", sub { |
393 | $_[0] and die "stat failed: $!"; |
413 | $_[0] and die "stat failed: $!"; |
394 | print "size is ", -s _, "\n"; |
414 | print "size is ", -s _, "\n"; |
395 | }; |
415 | }; |
396 | |
416 | |
|
|
417 | |
|
|
418 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
|
|
419 | |
|
|
420 | Works like perl's C<utime> function (including the special case of $atime |
|
|
421 | and $mtime being undef). Fractional times are supported if the underlying |
|
|
422 | syscalls support them. |
|
|
423 | |
|
|
424 | When called with a pathname, uses utimes(2) if available, otherwise |
|
|
425 | utime(2). If called on a file descriptor, uses futimes(2) if available, |
|
|
426 | otherwise returns ENOSYS, so this is not portable. |
|
|
427 | |
|
|
428 | Examples: |
|
|
429 | |
|
|
430 | # set atime and mtime to current time (basically touch(1)): |
|
|
431 | aio_utime "path", undef, undef; |
|
|
432 | # set atime to current time and mtime to beginning of the epoch: |
|
|
433 | aio_utime "path", time, undef; # undef==0 |
|
|
434 | |
|
|
435 | |
|
|
436 | =item aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
437 | |
|
|
438 | Works like perl's C<chown> function, except that C<undef> for either $uid |
|
|
439 | or $gid is being interpreted as "do not change" (but -1 can also be used). |
|
|
440 | |
|
|
441 | Examples: |
|
|
442 | |
|
|
443 | # same as "chown root path" in the shell: |
|
|
444 | aio_chown "path", 0, -1; |
|
|
445 | # same as above: |
|
|
446 | aio_chown "path", 0, undef; |
|
|
447 | |
|
|
448 | |
|
|
449 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
450 | |
|
|
451 | Works like truncate(2) or ftruncate(2). |
|
|
452 | |
|
|
453 | |
|
|
454 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
455 | |
|
|
456 | Works like perl's C<chmod> function. |
|
|
457 | |
|
|
458 | |
397 | =item aio_unlink $pathname, $callback->($status) |
459 | =item aio_unlink $pathname, $callback->($status) |
398 | |
460 | |
399 | Asynchronously unlink (delete) a file and call the callback with the |
461 | Asynchronously unlink (delete) a file and call the callback with the |
400 | result code. |
462 | result code. |
401 | |
463 | |
|
|
464 | |
402 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
465 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
403 | |
466 | |
404 | [EXPERIMENTAL] |
467 | [EXPERIMENTAL] |
405 | |
468 | |
406 | Asynchronously create a device node (or fifo). See mknod(2). |
469 | Asynchronously create a device node (or fifo). See mknod(2). |
407 | |
470 | |
408 | The only (POSIX-) portable way of calling this function is: |
471 | The only (POSIX-) portable way of calling this function is: |
409 | |
472 | |
410 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
473 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
|
|
474 | |
411 | |
475 | |
412 | =item aio_link $srcpath, $dstpath, $callback->($status) |
476 | =item aio_link $srcpath, $dstpath, $callback->($status) |
413 | |
477 | |
414 | Asynchronously create a new link to the existing object at C<$srcpath> at |
478 | 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. |
479 | the path C<$dstpath> and call the callback with the result code. |
416 | |
480 | |
|
|
481 | |
417 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
482 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
418 | |
483 | |
419 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
484 | 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. |
485 | the path C<$dstpath> and call the callback with the result code. |
421 | |
486 | |
|
|
487 | |
|
|
488 | =item aio_readlink $path, $callback->($link) |
|
|
489 | |
|
|
490 | Asynchronously read the symlink specified by C<$path> and pass it to |
|
|
491 | the callback. If an error occurs, nothing or undef gets passed to the |
|
|
492 | callback. |
|
|
493 | |
|
|
494 | |
422 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
495 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
423 | |
496 | |
424 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
497 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
425 | rename(2) and call the callback with the result code. |
498 | rename(2) and call the callback with the result code. |
426 | |
499 | |
|
|
500 | |
|
|
501 | =item aio_mkdir $pathname, $mode, $callback->($status) |
|
|
502 | |
|
|
503 | Asynchronously mkdir (create) a directory and call the callback with |
|
|
504 | the result code. C<$mode> will be modified by the umask at the time the |
|
|
505 | request is executed, so do not change your umask. |
|
|
506 | |
|
|
507 | |
427 | =item aio_rmdir $pathname, $callback->($status) |
508 | =item aio_rmdir $pathname, $callback->($status) |
428 | |
509 | |
429 | Asynchronously rmdir (delete) a directory and call the callback with the |
510 | Asynchronously rmdir (delete) a directory and call the callback with the |
430 | result code. |
511 | result code. |
|
|
512 | |
431 | |
513 | |
432 | =item aio_readdir $pathname, $callback->($entries) |
514 | =item aio_readdir $pathname, $callback->($entries) |
433 | |
515 | |
434 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
516 | 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 |
517 | directory (i.e. opendir + readdir + closedir). The entries will not be |
436 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
518 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
437 | |
519 | |
438 | The callback a single argument which is either C<undef> or an array-ref |
520 | The callback a single argument which is either C<undef> or an array-ref |
439 | with the filenames. |
521 | with the filenames. |
|
|
522 | |
|
|
523 | |
|
|
524 | =item aio_load $path, $data, $callback->($status) |
|
|
525 | |
|
|
526 | This is a composite request that tries to fully load the given file into |
|
|
527 | memory. Status is the same as with aio_read. |
|
|
528 | |
|
|
529 | =cut |
|
|
530 | |
|
|
531 | sub aio_load($$;$) { |
|
|
532 | aio_block { |
|
|
533 | my ($path, undef, $cb) = @_; |
|
|
534 | my $data = \$_[1]; |
|
|
535 | |
|
|
536 | my $pri = aioreq_pri; |
|
|
537 | my $grp = aio_group $cb; |
|
|
538 | |
|
|
539 | aioreq_pri $pri; |
|
|
540 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
541 | my $fh = shift |
|
|
542 | or return $grp->result (-1); |
|
|
543 | |
|
|
544 | aioreq_pri $pri; |
|
|
545 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
|
|
546 | $grp->result ($_[0]); |
|
|
547 | }; |
|
|
548 | }; |
|
|
549 | |
|
|
550 | $grp |
|
|
551 | } |
|
|
552 | } |
440 | |
553 | |
441 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
554 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
442 | |
555 | |
443 | Try to copy the I<file> (directories not supported as either source or |
556 | 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 |
557 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
… | |
… | |
454 | errors are being ignored. |
567 | errors are being ignored. |
455 | |
568 | |
456 | =cut |
569 | =cut |
457 | |
570 | |
458 | sub aio_copy($$;$) { |
571 | sub aio_copy($$;$) { |
|
|
572 | aio_block { |
459 | my ($src, $dst, $cb) = @_; |
573 | my ($src, $dst, $cb) = @_; |
460 | |
574 | |
461 | my $pri = aioreq_pri; |
575 | my $pri = aioreq_pri; |
462 | my $grp = aio_group $cb; |
576 | my $grp = aio_group $cb; |
463 | |
577 | |
464 | aioreq_pri $pri; |
578 | aioreq_pri $pri; |
465 | add $grp aio_open $src, O_RDONLY, 0, sub { |
579 | add $grp aio_open $src, O_RDONLY, 0, sub { |
466 | if (my $src_fh = $_[0]) { |
580 | if (my $src_fh = $_[0]) { |
467 | my @stat = stat $src_fh; |
581 | my @stat = stat $src_fh; |
468 | |
582 | |
469 | aioreq_pri $pri; |
583 | aioreq_pri $pri; |
470 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
584 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
471 | if (my $dst_fh = $_[0]) { |
585 | if (my $dst_fh = $_[0]) { |
472 | aioreq_pri $pri; |
586 | aioreq_pri $pri; |
473 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
587 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
474 | if ($_[0] == $stat[7]) { |
588 | if ($_[0] == $stat[7]) { |
475 | $grp->result (0); |
589 | $grp->result (0); |
476 | close $src_fh; |
590 | close $src_fh; |
477 | |
591 | |
478 | # those should not normally block. should. should. |
592 | # those should not normally block. should. should. |
479 | utime $stat[8], $stat[9], $dst; |
593 | utime $stat[8], $stat[9], $dst; |
480 | chmod $stat[2] & 07777, $dst_fh; |
594 | chmod $stat[2] & 07777, $dst_fh; |
481 | chown $stat[4], $stat[5], $dst_fh; |
595 | chown $stat[4], $stat[5], $dst_fh; |
482 | close $dst_fh; |
596 | close $dst_fh; |
483 | } else { |
597 | } else { |
484 | $grp->result (-1); |
598 | $grp->result (-1); |
485 | close $src_fh; |
599 | close $src_fh; |
486 | close $dst_fh; |
600 | close $dst_fh; |
487 | |
601 | |
488 | aioreq $pri; |
602 | aioreq $pri; |
489 | add $grp aio_unlink $dst; |
603 | add $grp aio_unlink $dst; |
|
|
604 | } |
490 | } |
605 | }; |
|
|
606 | } else { |
|
|
607 | $grp->result (-1); |
491 | }; |
608 | } |
492 | } else { |
|
|
493 | $grp->result (-1); |
|
|
494 | } |
609 | }, |
|
|
610 | |
|
|
611 | } else { |
|
|
612 | $grp->result (-1); |
495 | }, |
613 | } |
496 | |
|
|
497 | } else { |
|
|
498 | $grp->result (-1); |
|
|
499 | } |
614 | }; |
|
|
615 | |
|
|
616 | $grp |
500 | }; |
617 | } |
501 | |
|
|
502 | $grp |
|
|
503 | } |
618 | } |
504 | |
619 | |
505 | =item aio_move $srcpath, $dstpath, $callback->($status) |
620 | =item aio_move $srcpath, $dstpath, $callback->($status) |
506 | |
621 | |
507 | Try to move the I<file> (directories not supported as either source or |
622 | Try to move the I<file> (directories not supported as either source or |
… | |
… | |
513 | that is successful, unlinking the C<$srcpath>. |
628 | that is successful, unlinking the C<$srcpath>. |
514 | |
629 | |
515 | =cut |
630 | =cut |
516 | |
631 | |
517 | sub aio_move($$;$) { |
632 | sub aio_move($$;$) { |
|
|
633 | aio_block { |
518 | my ($src, $dst, $cb) = @_; |
634 | my ($src, $dst, $cb) = @_; |
519 | |
635 | |
520 | my $pri = aioreq_pri; |
636 | my $pri = aioreq_pri; |
521 | my $grp = aio_group $cb; |
637 | my $grp = aio_group $cb; |
522 | |
638 | |
523 | aioreq_pri $pri; |
639 | aioreq_pri $pri; |
524 | add $grp aio_rename $src, $dst, sub { |
640 | add $grp aio_rename $src, $dst, sub { |
525 | if ($_[0] && $! == EXDEV) { |
641 | if ($_[0] && $! == EXDEV) { |
526 | aioreq_pri $pri; |
642 | aioreq_pri $pri; |
527 | add $grp aio_copy $src, $dst, sub { |
643 | add $grp aio_copy $src, $dst, sub { |
|
|
644 | $grp->result ($_[0]); |
|
|
645 | |
|
|
646 | if (!$_[0]) { |
|
|
647 | aioreq_pri $pri; |
|
|
648 | add $grp aio_unlink $src; |
|
|
649 | } |
|
|
650 | }; |
|
|
651 | } else { |
528 | $grp->result ($_[0]); |
652 | $grp->result ($_[0]); |
529 | |
|
|
530 | if (!$_[0]) { |
|
|
531 | aioreq_pri $pri; |
|
|
532 | add $grp aio_unlink $src; |
|
|
533 | } |
|
|
534 | }; |
653 | } |
535 | } else { |
|
|
536 | $grp->result ($_[0]); |
|
|
537 | } |
654 | }; |
|
|
655 | |
|
|
656 | $grp |
538 | }; |
657 | } |
539 | |
|
|
540 | $grp |
|
|
541 | } |
658 | } |
542 | |
659 | |
543 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
660 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
544 | |
661 | |
545 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
662 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
… | |
… | |
592 | as those tend to return 0 or 1 as link counts, which disables the |
709 | as those tend to return 0 or 1 as link counts, which disables the |
593 | directory counting heuristic. |
710 | directory counting heuristic. |
594 | |
711 | |
595 | =cut |
712 | =cut |
596 | |
713 | |
597 | sub aio_scandir($$$) { |
714 | sub aio_scandir($$;$) { |
|
|
715 | aio_block { |
598 | my ($path, $maxreq, $cb) = @_; |
716 | my ($path, $maxreq, $cb) = @_; |
599 | |
717 | |
600 | my $pri = aioreq_pri; |
718 | my $pri = aioreq_pri; |
601 | |
719 | |
602 | my $grp = aio_group $cb; |
720 | my $grp = aio_group $cb; |
603 | |
721 | |
604 | $maxreq = 4 if $maxreq <= 0; |
722 | $maxreq = 4 if $maxreq <= 0; |
605 | |
723 | |
606 | # stat once |
724 | # stat once |
607 | aioreq_pri $pri; |
|
|
608 | add $grp aio_stat $path, sub { |
|
|
609 | return $grp->result () if $_[0]; |
|
|
610 | my $now = time; |
|
|
611 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
612 | |
|
|
613 | # read the directory entries |
|
|
614 | aioreq_pri $pri; |
725 | aioreq_pri $pri; |
615 | add $grp aio_readdir $path, sub { |
726 | add $grp aio_stat $path, sub { |
616 | my $entries = shift |
|
|
617 | or return $grp->result (); |
727 | return $grp->result () if $_[0]; |
|
|
728 | my $now = time; |
|
|
729 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
618 | |
730 | |
619 | # stat the dir another time |
731 | # read the directory entries |
620 | aioreq_pri $pri; |
732 | aioreq_pri $pri; |
|
|
733 | add $grp aio_readdir $path, sub { |
|
|
734 | my $entries = shift |
|
|
735 | or return $grp->result (); |
|
|
736 | |
|
|
737 | # stat the dir another time |
|
|
738 | aioreq_pri $pri; |
621 | add $grp aio_stat $path, sub { |
739 | add $grp aio_stat $path, sub { |
622 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
740 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
623 | |
741 | |
624 | my $ndirs; |
742 | my $ndirs; |
625 | |
743 | |
626 | # take the slow route if anything looks fishy |
744 | # take the slow route if anything looks fishy |
627 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
745 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
628 | $ndirs = -1; |
746 | $ndirs = -1; |
629 | } else { |
747 | } else { |
630 | # if nlink == 2, we are finished |
748 | # if nlink == 2, we are finished |
631 | # on non-posix-fs's, we rely on nlink < 2 |
749 | # on non-posix-fs's, we rely on nlink < 2 |
632 | $ndirs = (stat _)[3] - 2 |
750 | $ndirs = (stat _)[3] - 2 |
633 | or return $grp->result ([], $entries); |
751 | or return $grp->result ([], $entries); |
634 | } |
752 | } |
635 | |
753 | |
636 | # sort into likely dirs and likely nondirs |
754 | # sort into likely dirs and likely nondirs |
637 | # dirs == files without ".", short entries first |
755 | # dirs == files without ".", short entries first |
638 | $entries = [map $_->[0], |
756 | $entries = [map $_->[0], |
639 | sort { $b->[1] cmp $a->[1] } |
757 | sort { $b->[1] cmp $a->[1] } |
640 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
758 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
641 | @$entries]; |
759 | @$entries]; |
642 | |
760 | |
643 | my (@dirs, @nondirs); |
761 | my (@dirs, @nondirs); |
644 | |
762 | |
645 | my $statgrp = add $grp aio_group sub { |
763 | my $statgrp = add $grp aio_group sub { |
646 | $grp->result (\@dirs, \@nondirs); |
764 | $grp->result (\@dirs, \@nondirs); |
647 | }; |
765 | }; |
648 | |
766 | |
649 | limit $statgrp $maxreq; |
767 | limit $statgrp $maxreq; |
650 | feed $statgrp sub { |
768 | feed $statgrp sub { |
651 | return unless @$entries; |
769 | return unless @$entries; |
652 | my $entry = pop @$entries; |
770 | my $entry = pop @$entries; |
653 | |
771 | |
654 | aioreq_pri $pri; |
772 | aioreq_pri $pri; |
655 | add $statgrp aio_stat "$path/$entry/.", sub { |
773 | add $statgrp aio_stat "$path/$entry/.", sub { |
656 | if ($_[0] < 0) { |
774 | if ($_[0] < 0) { |
657 | push @nondirs, $entry; |
775 | push @nondirs, $entry; |
658 | } else { |
776 | } else { |
659 | # need to check for real directory |
777 | # need to check for real directory |
660 | aioreq_pri $pri; |
778 | aioreq_pri $pri; |
661 | add $statgrp aio_lstat "$path/$entry", sub { |
779 | add $statgrp aio_lstat "$path/$entry", sub { |
662 | if (-d _) { |
780 | if (-d _) { |
663 | push @dirs, $entry; |
781 | push @dirs, $entry; |
664 | |
782 | |
665 | unless (--$ndirs) { |
783 | unless (--$ndirs) { |
666 | push @nondirs, @$entries; |
784 | push @nondirs, @$entries; |
667 | feed $statgrp; |
785 | feed $statgrp; |
|
|
786 | } |
|
|
787 | } else { |
|
|
788 | push @nondirs, $entry; |
668 | } |
789 | } |
669 | } else { |
|
|
670 | push @nondirs, $entry; |
|
|
671 | } |
790 | } |
672 | } |
791 | } |
673 | } |
792 | }; |
674 | }; |
793 | }; |
675 | }; |
794 | }; |
676 | }; |
795 | }; |
677 | }; |
796 | }; |
|
|
797 | |
|
|
798 | $grp |
678 | }; |
799 | } |
|
|
800 | } |
679 | |
801 | |
|
|
802 | =item aio_rmtree $path, $callback->($status) |
|
|
803 | |
|
|
804 | Delete a directory tree starting (and including) C<$path>, return the |
|
|
805 | status of the final C<rmdir> only. This is a composite request that |
|
|
806 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
|
|
807 | everything else. |
|
|
808 | |
|
|
809 | =cut |
|
|
810 | |
|
|
811 | sub aio_rmtree; |
|
|
812 | sub aio_rmtree($;$) { |
|
|
813 | aio_block { |
|
|
814 | my ($path, $cb) = @_; |
|
|
815 | |
|
|
816 | my $pri = aioreq_pri; |
|
|
817 | my $grp = aio_group $cb; |
|
|
818 | |
|
|
819 | aioreq_pri $pri; |
|
|
820 | add $grp aio_scandir $path, 0, sub { |
|
|
821 | my ($dirs, $nondirs) = @_; |
|
|
822 | |
|
|
823 | my $dirgrp = aio_group sub { |
|
|
824 | add $grp aio_rmdir $path, sub { |
|
|
825 | $grp->result ($_[0]); |
|
|
826 | }; |
|
|
827 | }; |
|
|
828 | |
|
|
829 | (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs; |
|
|
830 | (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs; |
|
|
831 | |
|
|
832 | add $grp $dirgrp; |
|
|
833 | }; |
|
|
834 | |
680 | $grp |
835 | $grp |
|
|
836 | } |
681 | } |
837 | } |
682 | |
838 | |
683 | =item aio_fsync $fh, $callback->($status) |
839 | =item aio_fsync $fh, $callback->($status) |
684 | |
840 | |
685 | Asynchronously call fsync on the given filehandle and call the callback |
841 | Asynchronously call fsync on the given filehandle and call the callback |
… | |
… | |
939 | that are being processed by C<IO::AIO::poll_cb> in one call, respectively |
1095 | 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 |
1096 | 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 |
1097 | C<IO::AIO::poll_cb> to process requests (more correctly the mininum amount |
942 | of time C<poll_cb> is allowed to use). |
1098 | of time C<poll_cb> is allowed to use). |
943 | |
1099 | |
|
|
1100 | Setting C<max_poll_time> to a non-zero value creates an overhead of one |
|
|
1101 | syscall per request processed, which is not normally a problem unless your |
|
|
1102 | callbacks are really really fast or your OS is really really slow (I am |
|
|
1103 | not mentioning Solaris here). Using C<max_poll_reqs> incurs no overhead. |
|
|
1104 | |
944 | Setting these is useful if you want to ensure some level of |
1105 | 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 |
1106 | interactiveness when perl is not fast enough to process all requests in |
946 | time. |
1107 | time. |
947 | |
1108 | |
948 | For interactive programs, values such as C<0.01> to C<0.1> should be fine. |
1109 | For interactive programs, values such as C<0.01> to C<0.1> should be fine. |
949 | |
1110 | |
950 | Example: Install an Event watcher that automatically calls |
1111 | Example: Install an Event watcher that automatically calls |
951 | IO::AIO::poll_some with low priority, to ensure that other parts of the |
1112 | 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. |
1113 | program get the CPU sometimes even under high AIO load. |
953 | |
1114 | |
954 | # try not to spend much more than 0.1s in poll_cb |
1115 | # try not to spend much more than 0.1s in poll_cb |
955 | IO::AIO::max_poll_time 0.1; |
1116 | IO::AIO::max_poll_time 0.1; |
956 | |
1117 | |
… | |
… | |
959 | poll => 'r', nice => 1, |
1120 | poll => 'r', nice => 1, |
960 | cb => &IO::AIO::poll_cb); |
1121 | cb => &IO::AIO::poll_cb); |
961 | |
1122 | |
962 | =item IO::AIO::poll_wait |
1123 | =item IO::AIO::poll_wait |
963 | |
1124 | |
|
|
1125 | 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 |
1126 | 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 |
1127 | does a C<select> on the filehandle. This is useful if you want to |
966 | wait for some requests to finish). |
1128 | synchronously wait for some requests to finish). |
967 | |
1129 | |
968 | See C<nreqs> for an example. |
1130 | See C<nreqs> for an example. |
969 | |
1131 | |
970 | =item IO::AIO::poll |
1132 | =item IO::AIO::poll |
971 | |
1133 | |
972 | Waits until some requests have been handled. |
1134 | Waits until some requests have been handled. |
973 | |
1135 | |
|
|
1136 | Returns the number of requests processed, but is otherwise strictly |
974 | Strictly equivalent to: |
1137 | equivalent to: |
975 | |
1138 | |
976 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1139 | IO::AIO::poll_wait, IO::AIO::poll_cb |
977 | if IO::AIO::nreqs; |
|
|
978 | |
1140 | |
979 | =item IO::AIO::flush |
1141 | =item IO::AIO::flush |
980 | |
1142 | |
981 | Wait till all outstanding AIO requests have been handled. |
1143 | Wait till all outstanding AIO requests have been handled. |
982 | |
1144 | |
983 | Strictly equivalent to: |
1145 | Strictly equivalent to: |
984 | |
1146 | |
985 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1147 | IO::AIO::poll_wait, IO::AIO::poll_cb |
986 | while IO::AIO::nreqs; |
1148 | while IO::AIO::nreqs; |
987 | |
1149 | |
|
|
1150 | =back |
|
|
1151 | |
988 | =head3 CONTROLLING THE NUMBER OF THREADS |
1152 | =head3 CONTROLLING THE NUMBER OF THREADS |
|
|
1153 | |
|
|
1154 | =over |
989 | |
1155 | |
990 | =item IO::AIO::min_parallel $nthreads |
1156 | =item IO::AIO::min_parallel $nthreads |
991 | |
1157 | |
992 | Set the minimum number of AIO threads to C<$nthreads>. The current |
1158 | Set the minimum number of AIO threads to C<$nthreads>. The current |
993 | default is C<8>, which means eight asynchronous operations can execute |
1159 | default is C<8>, which means eight asynchronous operations can execute |
… | |
… | |
1052 | |
1218 | |
1053 | You can still queue as many requests as you want. Therefore, |
1219 | 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 |
1220 | C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
1055 | as a stop gap to shield against fatal memory overflow (with large values). |
1221 | as a stop gap to shield against fatal memory overflow (with large values). |
1056 | |
1222 | |
|
|
1223 | =back |
|
|
1224 | |
1057 | =head3 STATISTICAL INFORMATION |
1225 | =head3 STATISTICAL INFORMATION |
|
|
1226 | |
|
|
1227 | =over |
1058 | |
1228 | |
1059 | =item IO::AIO::nreqs |
1229 | =item IO::AIO::nreqs |
1060 | |
1230 | |
1061 | Returns the number of requests currently in the ready, execute or pending |
1231 | 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). |
1232 | states (i.e. for which their callback has not been invoked yet). |
… | |
… | |
1096 | *$sym |
1266 | *$sym |
1097 | } |
1267 | } |
1098 | |
1268 | |
1099 | min_parallel 8; |
1269 | min_parallel 8; |
1100 | |
1270 | |
1101 | END { |
1271 | END { flush } |
1102 | min_parallel 1; |
|
|
1103 | flush; |
|
|
1104 | }; |
|
|
1105 | |
1272 | |
1106 | 1; |
1273 | 1; |
1107 | |
1274 | |
1108 | =head2 FORK BEHAVIOUR |
1275 | =head2 FORK BEHAVIOUR |
1109 | |
1276 | |
… | |
… | |
1129 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1296 | 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 |
1297 | 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 |
1298 | 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. |
1299 | will consume memory till the request has entered the done state. |
1133 | |
1300 | |
1134 | This is now awfully much, so queuing lots of requests is not usually a |
1301 | This is not awfully much, so queuing lots of requests is not usually a |
1135 | problem. |
1302 | problem. |
1136 | |
1303 | |
1137 | Per-thread usage: |
1304 | Per-thread usage: |
1138 | |
1305 | |
1139 | In the execution phase, some aio requests require more memory for |
1306 | In the execution phase, some aio requests require more memory for |