… | |
… | |
190 | use strict 'vars'; |
190 | use strict 'vars'; |
191 | |
191 | |
192 | use base 'Exporter'; |
192 | use base 'Exporter'; |
193 | |
193 | |
194 | BEGIN { |
194 | BEGIN { |
195 | our $VERSION = '2.32'; |
195 | our $VERSION = '2.4'; |
196 | |
196 | |
197 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
197 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
198 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
198 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
199 | aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link |
199 | aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link |
200 | aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree); |
200 | aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir |
|
|
201 | aio_chown aio_chmod aio_utime); |
201 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
202 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
202 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
203 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
203 | min_parallel max_parallel max_idle |
204 | min_parallel max_parallel max_idle |
204 | nreqs nready npending nthreads |
205 | nreqs nready npending nthreads |
205 | max_poll_time max_poll_reqs); |
206 | max_poll_time max_poll_reqs); |
… | |
… | |
271 | aio_read $_[0], ..., sub { |
272 | aio_read $_[0], ..., sub { |
272 | ... |
273 | ... |
273 | }; |
274 | }; |
274 | }; |
275 | }; |
275 | |
276 | |
|
|
277 | |
276 | =item aioreq_nice $pri_adjust |
278 | =item aioreq_nice $pri_adjust |
277 | |
279 | |
278 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
280 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
279 | priority, so the effect is cumulative. |
281 | priority, so the effect is cumulative. |
|
|
282 | |
280 | |
283 | |
281 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
284 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
282 | |
285 | |
283 | Asynchronously open or create a file and call the callback with a newly |
286 | Asynchronously open or create a file and call the callback with a newly |
284 | created filehandle for the file. |
287 | created filehandle for the file. |
… | |
… | |
290 | list. They are the same as used by C<sysopen>. |
293 | list. They are the same as used by C<sysopen>. |
291 | |
294 | |
292 | Likewise, C<$mode> specifies the mode of the newly created file, if it |
295 | 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>, |
296 | 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, |
297 | 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). |
298 | and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified |
|
|
299 | by the umask in effect then the request is being executed, so better never |
|
|
300 | change the umask. |
296 | |
301 | |
297 | Example: |
302 | Example: |
298 | |
303 | |
299 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
304 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
300 | if ($_[0]) { |
305 | if ($_[0]) { |
… | |
… | |
303 | } else { |
308 | } else { |
304 | die "open failed: $!\n"; |
309 | die "open failed: $!\n"; |
305 | } |
310 | } |
306 | }; |
311 | }; |
307 | |
312 | |
|
|
313 | |
308 | =item aio_close $fh, $callback->($status) |
314 | =item aio_close $fh, $callback->($status) |
309 | |
315 | |
310 | Asynchronously close a file and call the callback with the result |
316 | Asynchronously close a file and call the callback with the result |
311 | code. I<WARNING:> although accepted, you should not pass in a perl |
317 | code. I<WARNING:> although accepted, you should not pass in a perl |
312 | filehandle here, as perl will likely close the file descriptor another |
318 | filehandle here, as perl will likely close the file descriptor another |
… | |
… | |
314 | C<close> or just let filehandles go out of scope. |
320 | C<close> or just let filehandles go out of scope. |
315 | |
321 | |
316 | This is supposed to be a bug in the API, so that might change. It's |
322 | This is supposed to be a bug in the API, so that might change. It's |
317 | therefore best to avoid this function. |
323 | therefore best to avoid this function. |
318 | |
324 | |
|
|
325 | |
319 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
326 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
320 | |
327 | |
321 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
328 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
322 | |
329 | |
323 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
330 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
… | |
… | |
334 | |
341 | |
335 | aio_read $fh, 7, 15, $buffer, 0, sub { |
342 | aio_read $fh, 7, 15, $buffer, 0, sub { |
336 | $_[0] > 0 or die "read error: $!"; |
343 | $_[0] > 0 or die "read error: $!"; |
337 | print "read $_[0] bytes: <$buffer>\n"; |
344 | print "read $_[0] bytes: <$buffer>\n"; |
338 | }; |
345 | }; |
|
|
346 | |
339 | |
347 | |
340 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
348 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
341 | |
349 | |
342 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
350 | 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 |
351 | 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 |
365 | 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 |
366 | 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 |
367 | 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 |
368 | value equals C<$length> one can assume that C<$length> bytes have been |
361 | read. |
369 | read. |
|
|
370 | |
362 | |
371 | |
363 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
372 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
364 | |
373 | |
365 | C<aio_readahead> populates the page cache with data from a file so that |
374 | 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> |
375 | 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. |
381 | file. The current file offset of the file is left unchanged. |
373 | |
382 | |
374 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
383 | 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. |
384 | emulated by simply reading the data, which would have a similar effect. |
376 | |
385 | |
|
|
386 | |
377 | =item aio_stat $fh_or_path, $callback->($status) |
387 | =item aio_stat $fh_or_path, $callback->($status) |
378 | |
388 | |
379 | =item aio_lstat $fh, $callback->($status) |
389 | =item aio_lstat $fh, $callback->($status) |
380 | |
390 | |
381 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
391 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
… | |
… | |
394 | aio_stat "/etc/passwd", sub { |
404 | aio_stat "/etc/passwd", sub { |
395 | $_[0] and die "stat failed: $!"; |
405 | $_[0] and die "stat failed: $!"; |
396 | print "size is ", -s _, "\n"; |
406 | print "size is ", -s _, "\n"; |
397 | }; |
407 | }; |
398 | |
408 | |
|
|
409 | |
|
|
410 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
|
|
411 | |
|
|
412 | Works like perl's C<utime> function (including the special case of $atime |
|
|
413 | and $mtime being undef). Fractional times are supported if the underlying |
|
|
414 | syscalls support them. |
|
|
415 | |
|
|
416 | When called with a pathname, uses utimes(2) if available, otherwise |
|
|
417 | utime(2). If called on a file descriptor, uses futimes(2) if available, |
|
|
418 | otherwise returns ENOSYS, so this is not portable. |
|
|
419 | |
|
|
420 | Examples: |
|
|
421 | |
|
|
422 | # set atime and mtime to current time: |
|
|
423 | aio_utime "path", undef, undef; |
|
|
424 | # set atime to current time and mtime to beginning of the epoch: |
|
|
425 | aio_utime "path", time, undef; # undef==0 |
|
|
426 | |
|
|
427 | |
|
|
428 | =item aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
429 | |
|
|
430 | Works like perl's C<chown> function, except that C<undef> for either $uid |
|
|
431 | or $gid is being interpreted as "do not change" (but -1 can also be used). |
|
|
432 | |
|
|
433 | Examples: |
|
|
434 | |
|
|
435 | # same as "chown root path" in the shell: |
|
|
436 | aio_chown "path", 0, -1; |
|
|
437 | # same as above: |
|
|
438 | aio_chown "path", 0, undef; |
|
|
439 | |
|
|
440 | |
|
|
441 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
442 | |
|
|
443 | Works like perl's C<chmod> function. |
|
|
444 | |
|
|
445 | |
399 | =item aio_unlink $pathname, $callback->($status) |
446 | =item aio_unlink $pathname, $callback->($status) |
400 | |
447 | |
401 | Asynchronously unlink (delete) a file and call the callback with the |
448 | Asynchronously unlink (delete) a file and call the callback with the |
402 | result code. |
449 | result code. |
403 | |
450 | |
|
|
451 | |
404 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
452 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
405 | |
453 | |
406 | [EXPERIMENTAL] |
454 | [EXPERIMENTAL] |
407 | |
455 | |
408 | Asynchronously create a device node (or fifo). See mknod(2). |
456 | Asynchronously create a device node (or fifo). See mknod(2). |
409 | |
457 | |
410 | The only (POSIX-) portable way of calling this function is: |
458 | The only (POSIX-) portable way of calling this function is: |
411 | |
459 | |
412 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
460 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
|
|
461 | |
413 | |
462 | |
414 | =item aio_link $srcpath, $dstpath, $callback->($status) |
463 | =item aio_link $srcpath, $dstpath, $callback->($status) |
415 | |
464 | |
416 | Asynchronously create a new link to the existing object at C<$srcpath> at |
465 | 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. |
466 | the path C<$dstpath> and call the callback with the result code. |
418 | |
467 | |
|
|
468 | |
419 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
469 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
420 | |
470 | |
421 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
471 | 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. |
472 | the path C<$dstpath> and call the callback with the result code. |
|
|
473 | |
423 | |
474 | |
424 | =item aio_readlink $path, $callback->($link) |
475 | =item aio_readlink $path, $callback->($link) |
425 | |
476 | |
426 | Asynchronously read the symlink specified by C<$path> and pass it to |
477 | 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 |
478 | the callback. If an error occurs, nothing or undef gets passed to the |
428 | callback. |
479 | callback. |
429 | |
480 | |
|
|
481 | |
430 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
482 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
431 | |
483 | |
432 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
484 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
433 | rename(2) and call the callback with the result code. |
485 | rename(2) and call the callback with the result code. |
434 | |
486 | |
|
|
487 | |
|
|
488 | =item aio_mkdir $pathname, $mode, $callback->($status) |
|
|
489 | |
|
|
490 | Asynchronously mkdir (create) a directory and call the callback with |
|
|
491 | the result code. C<$mode> will be modified by the umask at the time the |
|
|
492 | request is executed, so do not change your umask. |
|
|
493 | |
|
|
494 | |
435 | =item aio_rmdir $pathname, $callback->($status) |
495 | =item aio_rmdir $pathname, $callback->($status) |
436 | |
496 | |
437 | Asynchronously rmdir (delete) a directory and call the callback with the |
497 | Asynchronously rmdir (delete) a directory and call the callback with the |
438 | result code. |
498 | result code. |
|
|
499 | |
439 | |
500 | |
440 | =item aio_readdir $pathname, $callback->($entries) |
501 | =item aio_readdir $pathname, $callback->($entries) |
441 | |
502 | |
442 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
503 | 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 |
504 | directory (i.e. opendir + readdir + closedir). The entries will not be |
444 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
505 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
445 | |
506 | |
446 | The callback a single argument which is either C<undef> or an array-ref |
507 | The callback a single argument which is either C<undef> or an array-ref |
447 | with the filenames. |
508 | with the filenames. |
|
|
509 | |
448 | |
510 | |
449 | =item aio_load $path, $data, $callback->($status) |
511 | =item aio_load $path, $data, $callback->($status) |
450 | |
512 | |
451 | This is a composite request that tries to fully load the given file into |
513 | This is a composite request that tries to fully load the given file into |
452 | memory. Status is the same as with aio_read. |
514 | memory. Status is the same as with aio_read. |
… | |
… | |
461 | my $pri = aioreq_pri; |
523 | my $pri = aioreq_pri; |
462 | my $grp = aio_group $cb; |
524 | my $grp = aio_group $cb; |
463 | |
525 | |
464 | aioreq_pri $pri; |
526 | aioreq_pri $pri; |
465 | add $grp aio_open $path, O_RDONLY, 0, sub { |
527 | add $grp aio_open $path, O_RDONLY, 0, sub { |
466 | my ($fh) = @_ |
528 | my $fh = shift |
467 | or return $grp->result (-1); |
529 | or return $grp->result (-1); |
468 | |
530 | |
469 | aioreq_pri $pri; |
531 | aioreq_pri $pri; |
470 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
532 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
471 | $grp->result ($_[0]); |
533 | $grp->result ($_[0]); |
… | |
… | |
1070 | Strictly equivalent to: |
1132 | Strictly equivalent to: |
1071 | |
1133 | |
1072 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1134 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1073 | while IO::AIO::nreqs; |
1135 | while IO::AIO::nreqs; |
1074 | |
1136 | |
|
|
1137 | =back |
|
|
1138 | |
1075 | =head3 CONTROLLING THE NUMBER OF THREADS |
1139 | =head3 CONTROLLING THE NUMBER OF THREADS |
|
|
1140 | |
|
|
1141 | =over |
1076 | |
1142 | |
1077 | =item IO::AIO::min_parallel $nthreads |
1143 | =item IO::AIO::min_parallel $nthreads |
1078 | |
1144 | |
1079 | Set the minimum number of AIO threads to C<$nthreads>. The current |
1145 | Set the minimum number of AIO threads to C<$nthreads>. The current |
1080 | default is C<8>, which means eight asynchronous operations can execute |
1146 | default is C<8>, which means eight asynchronous operations can execute |
… | |
… | |
1139 | |
1205 | |
1140 | You can still queue as many requests as you want. Therefore, |
1206 | You can still queue as many requests as you want. Therefore, |
1141 | C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
1207 | C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
1142 | as a stop gap to shield against fatal memory overflow (with large values). |
1208 | as a stop gap to shield against fatal memory overflow (with large values). |
1143 | |
1209 | |
|
|
1210 | =back |
|
|
1211 | |
1144 | =head3 STATISTICAL INFORMATION |
1212 | =head3 STATISTICAL INFORMATION |
|
|
1213 | |
|
|
1214 | =over |
1145 | |
1215 | |
1146 | =item IO::AIO::nreqs |
1216 | =item IO::AIO::nreqs |
1147 | |
1217 | |
1148 | Returns the number of requests currently in the ready, execute or pending |
1218 | Returns the number of requests currently in the ready, execute or pending |
1149 | states (i.e. for which their callback has not been invoked yet). |
1219 | states (i.e. for which their callback has not been invoked yet). |