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