… | |
… | |
62 | 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 |
63 | 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 |
64 | 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 |
65 | concurrently. |
65 | concurrently. |
66 | |
66 | |
67 | 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 |
68 | sockets), using these functions on file descriptors that support |
68 | example sockets), using these functions on file descriptors that |
69 | nonblocking operation (again, sockets, pipes etc.) is very inefficient or |
69 | support nonblocking operation (again, sockets, pipes etc.) is very |
70 | 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> |
71 | 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. |
72 | into such an event loop itself. |
|
|
73 | |
72 | |
74 | 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 |
75 | requests and signal their completion. You don't need thread support |
74 | requests and signal their completion. You don't need thread support |
76 | in perl, and the threads created by this module will not be visible |
75 | in perl, and the threads created by this module will not be visible |
77 | to perl. In the future, this module might make use of the native aio |
76 | to perl. In the future, this module might make use of the native aio |
… | |
… | |
79 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
78 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
80 | files currently, for example), and they would only support aio_read and |
79 | files currently, for example), and they would only support aio_read and |
81 | aio_write, so the remaining functionality would have to be implemented |
80 | aio_write, so the remaining functionality would have to be implemented |
82 | using threads anyway. |
81 | using threads anyway. |
83 | |
82 | |
84 | 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, |
85 | 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 |
86 | 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 |
87 | never call C<poll_cb> (or other C<aio_> functions) recursively. |
86 | call C<poll_cb> (or other C<aio_> functions) recursively. |
88 | |
87 | |
89 | =head2 EXAMPLE |
88 | =head2 EXAMPLE |
90 | |
89 | |
91 | 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 |
92 | F</etc/passwd> asynchronously: |
91 | F</etc/passwd> asynchronously: |
… | |
… | |
184 | |
183 | |
185 | =cut |
184 | =cut |
186 | |
185 | |
187 | package IO::AIO; |
186 | package IO::AIO; |
188 | |
187 | |
|
|
188 | use Carp (); |
|
|
189 | |
189 | no warnings; |
190 | no warnings; |
190 | use strict 'vars'; |
191 | use strict 'vars'; |
191 | |
192 | |
192 | use base 'Exporter'; |
193 | use base 'Exporter'; |
193 | |
194 | |
194 | BEGIN { |
195 | BEGIN { |
195 | our $VERSION = '2.31'; |
196 | our $VERSION = '2.51'; |
196 | |
197 | |
197 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
198 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
198 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
199 | 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 |
200 | 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); |
201 | aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir |
|
|
202 | aio_chown aio_chmod aio_utime aio_truncate); |
201 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
203 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
202 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
204 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
203 | min_parallel max_parallel max_idle |
205 | min_parallel max_parallel max_idle |
204 | nreqs nready npending nthreads |
206 | nreqs nready npending nthreads |
205 | max_poll_time max_poll_reqs); |
207 | max_poll_time max_poll_reqs); |
… | |
… | |
271 | aio_read $_[0], ..., sub { |
273 | aio_read $_[0], ..., sub { |
272 | ... |
274 | ... |
273 | }; |
275 | }; |
274 | }; |
276 | }; |
275 | |
277 | |
|
|
278 | |
276 | =item aioreq_nice $pri_adjust |
279 | =item aioreq_nice $pri_adjust |
277 | |
280 | |
278 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
281 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
279 | priority, so the effect is cumulative. |
282 | priority, so the effect is cumulative. |
|
|
283 | |
280 | |
284 | |
281 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
285 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
282 | |
286 | |
283 | Asynchronously open or create a file and call the callback with a newly |
287 | Asynchronously open or create a file and call the callback with a newly |
284 | created filehandle for the file. |
288 | created filehandle for the file. |
… | |
… | |
290 | list. They are the same as used by C<sysopen>. |
294 | list. They are the same as used by C<sysopen>. |
291 | |
295 | |
292 | Likewise, C<$mode> specifies the mode of the newly created file, if it |
296 | 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>, |
297 | 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, |
298 | 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). |
299 | and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified |
|
|
300 | by the umask in effect then the request is being executed, so better never |
|
|
301 | change the umask. |
296 | |
302 | |
297 | Example: |
303 | Example: |
298 | |
304 | |
299 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
305 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
300 | if ($_[0]) { |
306 | if ($_[0]) { |
… | |
… | |
303 | } else { |
309 | } else { |
304 | die "open failed: $!\n"; |
310 | die "open failed: $!\n"; |
305 | } |
311 | } |
306 | }; |
312 | }; |
307 | |
313 | |
|
|
314 | |
308 | =item aio_close $fh, $callback->($status) |
315 | =item aio_close $fh, $callback->($status) |
309 | |
316 | |
310 | Asynchronously close a file and call the callback with the result |
317 | Asynchronously close a file and call the callback with the result |
311 | code. I<WARNING:> although accepted, you should not pass in a perl |
318 | code. |
312 | filehandle here, as perl will likely close the file descriptor another |
|
|
313 | time when the filehandle is destroyed. Normally, you can safely call perls |
|
|
314 | C<close> or just let filehandles go out of scope. |
|
|
315 | |
319 | |
316 | This is supposed to be a bug in the API, so that might change. It's |
320 | Unfortunately, you can't do this to perl. Perl I<insists> very strongly on |
317 | therefore best to avoid this function. |
321 | closing the file descriptor associated with the filehandle itself. Here is |
|
|
322 | what aio_close will try: |
|
|
323 | |
|
|
324 | 1. dup()licate the fd |
|
|
325 | 2. asynchronously close() the duplicated fd |
|
|
326 | 3. dup()licate the fd once more |
|
|
327 | 4. let perl close() the filehandle |
|
|
328 | 5. asynchronously close the duplicated fd |
|
|
329 | |
|
|
330 | The idea is that the first close() flushes stuff to disk that closing an |
|
|
331 | fd will flush, so when perl closes the fd, nothing much will need to be |
|
|
332 | flushed. The second async. close() will then flush stuff to disk that |
|
|
333 | closing the last fd to the file will flush. |
|
|
334 | |
|
|
335 | Just FYI, SuSv3 has this to say on close: |
|
|
336 | |
|
|
337 | All outstanding record locks owned by the process on the file |
|
|
338 | associated with the file descriptor shall be removed. |
|
|
339 | |
|
|
340 | If fildes refers to a socket, close() shall cause the socket to be |
|
|
341 | destroyed. ... close() shall block for up to the current linger |
|
|
342 | interval until all data is transmitted. |
|
|
343 | [this actually sounds like a specification bug, but who knows] |
|
|
344 | |
|
|
345 | And at least Linux additionally actually flushes stuff on every close, |
|
|
346 | even when the file itself is still open. |
|
|
347 | |
|
|
348 | Sounds enourmously inefficient and complicated? Yes... please show me how |
|
|
349 | to nuke perl's fd out of existence... |
|
|
350 | |
|
|
351 | =cut |
|
|
352 | |
|
|
353 | sub aio_close($;$) { |
|
|
354 | aio_block { |
|
|
355 | my ($fh, $cb) = @_; |
|
|
356 | |
|
|
357 | my $pri = aioreq_pri; |
|
|
358 | my $grp = aio_group $cb; |
|
|
359 | |
|
|
360 | my $fd = fileno $fh; |
|
|
361 | |
|
|
362 | defined $fd or Carp::croak "aio_close called with fd-less filehandle"; |
|
|
363 | |
|
|
364 | # if the dups fail we will simply get EBADF |
|
|
365 | my $fd2 = _dup $fd; |
|
|
366 | aioreq_pri $pri; |
|
|
367 | add $grp _aio_close $fd2, sub { |
|
|
368 | my $fd2 = _dup $fd; |
|
|
369 | close $fh; |
|
|
370 | aioreq_pri $pri; |
|
|
371 | add $grp _aio_close $fd2, sub { |
|
|
372 | $grp->result ($_[0]); |
|
|
373 | }; |
|
|
374 | }; |
|
|
375 | |
|
|
376 | $grp |
|
|
377 | } |
|
|
378 | } |
|
|
379 | |
318 | |
380 | |
319 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
381 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
320 | |
382 | |
321 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
383 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
322 | |
384 | |
323 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
385 | Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> |
324 | into the scalar given by C<data> and offset C<dataoffset> and calls the |
386 | into the scalar given by C<$data> and offset C<$dataoffset> and calls the |
325 | callback without the actual number of bytes read (or -1 on error, just |
387 | callback without the actual number of bytes read (or -1 on error, just |
326 | like the syscall). |
388 | like the syscall). |
327 | |
389 | |
|
|
390 | If C<$offset> is undefined, then the current file descriptor offset will |
|
|
391 | be used (and updated), otherwise the file descriptor offset will not be |
|
|
392 | changed by these calls. |
|
|
393 | |
|
|
394 | If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. |
|
|
395 | |
|
|
396 | If C<$dataoffset> is less than zero, it will be counted from the end of |
|
|
397 | C<$data>. |
|
|
398 | |
328 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
399 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
329 | is outstanding. Modifying it can result in segfaults or WW3 (if the |
400 | is outstanding. Modifying it can result in segfaults or World War III (if |
330 | necessary/optional hardware is installed). |
401 | the necessary/optional hardware is installed). |
331 | |
402 | |
332 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
403 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
333 | offset C<0> within the scalar: |
404 | offset C<0> within the scalar: |
334 | |
405 | |
335 | aio_read $fh, 7, 15, $buffer, 0, sub { |
406 | aio_read $fh, 7, 15, $buffer, 0, sub { |
336 | $_[0] > 0 or die "read error: $!"; |
407 | $_[0] > 0 or die "read error: $!"; |
337 | print "read $_[0] bytes: <$buffer>\n"; |
408 | print "read $_[0] bytes: <$buffer>\n"; |
338 | }; |
409 | }; |
|
|
410 | |
339 | |
411 | |
340 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
412 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
341 | |
413 | |
342 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
414 | 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 |
415 | 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 |
429 | 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 |
430 | 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 |
431 | 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 |
432 | value equals C<$length> one can assume that C<$length> bytes have been |
361 | read. |
433 | read. |
|
|
434 | |
362 | |
435 | |
363 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
436 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
364 | |
437 | |
365 | C<aio_readahead> populates the page cache with data from a file so that |
438 | 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> |
439 | 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. |
445 | file. The current file offset of the file is left unchanged. |
373 | |
446 | |
374 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
447 | 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. |
448 | emulated by simply reading the data, which would have a similar effect. |
376 | |
449 | |
|
|
450 | |
377 | =item aio_stat $fh_or_path, $callback->($status) |
451 | =item aio_stat $fh_or_path, $callback->($status) |
378 | |
452 | |
379 | =item aio_lstat $fh, $callback->($status) |
453 | =item aio_lstat $fh, $callback->($status) |
380 | |
454 | |
381 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
455 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
… | |
… | |
394 | aio_stat "/etc/passwd", sub { |
468 | aio_stat "/etc/passwd", sub { |
395 | $_[0] and die "stat failed: $!"; |
469 | $_[0] and die "stat failed: $!"; |
396 | print "size is ", -s _, "\n"; |
470 | print "size is ", -s _, "\n"; |
397 | }; |
471 | }; |
398 | |
472 | |
|
|
473 | |
|
|
474 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
|
|
475 | |
|
|
476 | Works like perl's C<utime> function (including the special case of $atime |
|
|
477 | and $mtime being undef). Fractional times are supported if the underlying |
|
|
478 | syscalls support them. |
|
|
479 | |
|
|
480 | When called with a pathname, uses utimes(2) if available, otherwise |
|
|
481 | utime(2). If called on a file descriptor, uses futimes(2) if available, |
|
|
482 | otherwise returns ENOSYS, so this is not portable. |
|
|
483 | |
|
|
484 | Examples: |
|
|
485 | |
|
|
486 | # set atime and mtime to current time (basically touch(1)): |
|
|
487 | aio_utime "path", undef, undef; |
|
|
488 | # set atime to current time and mtime to beginning of the epoch: |
|
|
489 | aio_utime "path", time, undef; # undef==0 |
|
|
490 | |
|
|
491 | |
|
|
492 | =item aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
493 | |
|
|
494 | Works like perl's C<chown> function, except that C<undef> for either $uid |
|
|
495 | or $gid is being interpreted as "do not change" (but -1 can also be used). |
|
|
496 | |
|
|
497 | Examples: |
|
|
498 | |
|
|
499 | # same as "chown root path" in the shell: |
|
|
500 | aio_chown "path", 0, -1; |
|
|
501 | # same as above: |
|
|
502 | aio_chown "path", 0, undef; |
|
|
503 | |
|
|
504 | |
|
|
505 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
506 | |
|
|
507 | Works like truncate(2) or ftruncate(2). |
|
|
508 | |
|
|
509 | |
|
|
510 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
511 | |
|
|
512 | Works like perl's C<chmod> function. |
|
|
513 | |
|
|
514 | |
399 | =item aio_unlink $pathname, $callback->($status) |
515 | =item aio_unlink $pathname, $callback->($status) |
400 | |
516 | |
401 | Asynchronously unlink (delete) a file and call the callback with the |
517 | Asynchronously unlink (delete) a file and call the callback with the |
402 | result code. |
518 | result code. |
403 | |
519 | |
|
|
520 | |
404 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
521 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
405 | |
522 | |
406 | [EXPERIMENTAL] |
523 | [EXPERIMENTAL] |
407 | |
524 | |
408 | Asynchronously create a device node (or fifo). See mknod(2). |
525 | Asynchronously create a device node (or fifo). See mknod(2). |
409 | |
526 | |
410 | The only (POSIX-) portable way of calling this function is: |
527 | The only (POSIX-) portable way of calling this function is: |
411 | |
528 | |
412 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
529 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
|
|
530 | |
413 | |
531 | |
414 | =item aio_link $srcpath, $dstpath, $callback->($status) |
532 | =item aio_link $srcpath, $dstpath, $callback->($status) |
415 | |
533 | |
416 | Asynchronously create a new link to the existing object at C<$srcpath> at |
534 | 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. |
535 | the path C<$dstpath> and call the callback with the result code. |
418 | |
536 | |
|
|
537 | |
419 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
538 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
420 | |
539 | |
421 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
540 | 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. |
541 | the path C<$dstpath> and call the callback with the result code. |
|
|
542 | |
423 | |
543 | |
424 | =item aio_readlink $path, $callback->($link) |
544 | =item aio_readlink $path, $callback->($link) |
425 | |
545 | |
426 | Asynchronously read the symlink specified by C<$path> and pass it to |
546 | 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 |
547 | the callback. If an error occurs, nothing or undef gets passed to the |
428 | callback. |
548 | callback. |
429 | |
549 | |
|
|
550 | |
430 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
551 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
431 | |
552 | |
432 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
553 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
433 | rename(2) and call the callback with the result code. |
554 | rename(2) and call the callback with the result code. |
434 | |
555 | |
|
|
556 | |
|
|
557 | =item aio_mkdir $pathname, $mode, $callback->($status) |
|
|
558 | |
|
|
559 | Asynchronously mkdir (create) a directory and call the callback with |
|
|
560 | the result code. C<$mode> will be modified by the umask at the time the |
|
|
561 | request is executed, so do not change your umask. |
|
|
562 | |
|
|
563 | |
435 | =item aio_rmdir $pathname, $callback->($status) |
564 | =item aio_rmdir $pathname, $callback->($status) |
436 | |
565 | |
437 | Asynchronously rmdir (delete) a directory and call the callback with the |
566 | Asynchronously rmdir (delete) a directory and call the callback with the |
438 | result code. |
567 | result code. |
|
|
568 | |
439 | |
569 | |
440 | =item aio_readdir $pathname, $callback->($entries) |
570 | =item aio_readdir $pathname, $callback->($entries) |
441 | |
571 | |
442 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
572 | 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 |
573 | directory (i.e. opendir + readdir + closedir). The entries will not be |
444 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
574 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
445 | |
575 | |
446 | The callback a single argument which is either C<undef> or an array-ref |
576 | The callback a single argument which is either C<undef> or an array-ref |
447 | with the filenames. |
577 | with the filenames. |
|
|
578 | |
448 | |
579 | |
449 | =item aio_load $path, $data, $callback->($status) |
580 | =item aio_load $path, $data, $callback->($status) |
450 | |
581 | |
451 | This is a composite request that tries to fully load the given file into |
582 | This is a composite request that tries to fully load the given file into |
452 | memory. Status is the same as with aio_read. |
583 | memory. Status is the same as with aio_read. |
… | |
… | |
461 | my $pri = aioreq_pri; |
592 | my $pri = aioreq_pri; |
462 | my $grp = aio_group $cb; |
593 | my $grp = aio_group $cb; |
463 | |
594 | |
464 | aioreq_pri $pri; |
595 | aioreq_pri $pri; |
465 | add $grp aio_open $path, O_RDONLY, 0, sub { |
596 | add $grp aio_open $path, O_RDONLY, 0, sub { |
466 | my ($fh) = @_ |
597 | my $fh = shift |
467 | or return $grp->result (-1); |
598 | or return $grp->result (-1); |
468 | |
599 | |
469 | aioreq_pri $pri; |
600 | aioreq_pri $pri; |
470 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
601 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
471 | $grp->result ($_[0]); |
602 | $grp->result ($_[0]); |
… | |
… | |
634 | as those tend to return 0 or 1 as link counts, which disables the |
765 | as those tend to return 0 or 1 as link counts, which disables the |
635 | directory counting heuristic. |
766 | directory counting heuristic. |
636 | |
767 | |
637 | =cut |
768 | =cut |
638 | |
769 | |
639 | sub aio_scandir($$$) { |
770 | sub aio_scandir($$;$) { |
640 | aio_block { |
771 | aio_block { |
641 | my ($path, $maxreq, $cb) = @_; |
772 | my ($path, $maxreq, $cb) = @_; |
642 | |
773 | |
643 | my $pri = aioreq_pri; |
774 | my $pri = aioreq_pri; |
644 | |
775 | |
… | |
… | |
722 | |
853 | |
723 | $grp |
854 | $grp |
724 | } |
855 | } |
725 | } |
856 | } |
726 | |
857 | |
|
|
858 | =item aio_rmtree $path, $callback->($status) |
|
|
859 | |
|
|
860 | Delete a directory tree starting (and including) C<$path>, return the |
|
|
861 | status of the final C<rmdir> only. This is a composite request that |
|
|
862 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
|
|
863 | everything else. |
|
|
864 | |
|
|
865 | =cut |
|
|
866 | |
|
|
867 | sub aio_rmtree; |
|
|
868 | sub aio_rmtree($;$) { |
|
|
869 | aio_block { |
|
|
870 | my ($path, $cb) = @_; |
|
|
871 | |
|
|
872 | my $pri = aioreq_pri; |
|
|
873 | my $grp = aio_group $cb; |
|
|
874 | |
|
|
875 | aioreq_pri $pri; |
|
|
876 | add $grp aio_scandir $path, 0, sub { |
|
|
877 | my ($dirs, $nondirs) = @_; |
|
|
878 | |
|
|
879 | my $dirgrp = aio_group sub { |
|
|
880 | add $grp aio_rmdir $path, sub { |
|
|
881 | $grp->result ($_[0]); |
|
|
882 | }; |
|
|
883 | }; |
|
|
884 | |
|
|
885 | (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs; |
|
|
886 | (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs; |
|
|
887 | |
|
|
888 | add $grp $dirgrp; |
|
|
889 | }; |
|
|
890 | |
|
|
891 | $grp |
|
|
892 | } |
|
|
893 | } |
|
|
894 | |
727 | =item aio_fsync $fh, $callback->($status) |
895 | =item aio_fsync $fh, $callback->($status) |
728 | |
896 | |
729 | Asynchronously call fsync on the given filehandle and call the callback |
897 | Asynchronously call fsync on the given filehandle and call the callback |
730 | with the fsync result code. |
898 | with the fsync result code. |
731 | |
899 | |
… | |
… | |
1033 | Strictly equivalent to: |
1201 | Strictly equivalent to: |
1034 | |
1202 | |
1035 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1203 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1036 | while IO::AIO::nreqs; |
1204 | while IO::AIO::nreqs; |
1037 | |
1205 | |
|
|
1206 | =back |
|
|
1207 | |
1038 | =head3 CONTROLLING THE NUMBER OF THREADS |
1208 | =head3 CONTROLLING THE NUMBER OF THREADS |
|
|
1209 | |
|
|
1210 | =over |
1039 | |
1211 | |
1040 | =item IO::AIO::min_parallel $nthreads |
1212 | =item IO::AIO::min_parallel $nthreads |
1041 | |
1213 | |
1042 | Set the minimum number of AIO threads to C<$nthreads>. The current |
1214 | Set the minimum number of AIO threads to C<$nthreads>. The current |
1043 | default is C<8>, which means eight asynchronous operations can execute |
1215 | default is C<8>, which means eight asynchronous operations can execute |
… | |
… | |
1091 | This is a very bad function to use in interactive programs because it |
1263 | This is a very bad function to use in interactive programs because it |
1092 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1264 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1093 | use an C<aio_group> together with a feed callback. |
1265 | use an C<aio_group> together with a feed callback. |
1094 | |
1266 | |
1095 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1267 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1096 | to queue up more than this number of requests, the next call to the |
1268 | do queue up more than this number of requests, the next call to the |
1097 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1269 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1098 | function will block until the limit is no longer exceeded. |
1270 | function will block until the limit is no longer exceeded. |
1099 | |
1271 | |
1100 | The default value is very large, so there is no practical limit on the |
1272 | The default value is very large, so there is no practical limit on the |
1101 | number of outstanding requests. |
1273 | number of outstanding requests. |
1102 | |
1274 | |
1103 | You can still queue as many requests as you want. Therefore, |
1275 | You can still queue as many requests as you want. Therefore, |
1104 | C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
1276 | C<max_oustsanding> is mainly useful in simple scripts (with low values) or |
1105 | as a stop gap to shield against fatal memory overflow (with large values). |
1277 | as a stop gap to shield against fatal memory overflow (with large values). |
1106 | |
1278 | |
|
|
1279 | =back |
|
|
1280 | |
1107 | =head3 STATISTICAL INFORMATION |
1281 | =head3 STATISTICAL INFORMATION |
|
|
1282 | |
|
|
1283 | =over |
1108 | |
1284 | |
1109 | =item IO::AIO::nreqs |
1285 | =item IO::AIO::nreqs |
1110 | |
1286 | |
1111 | Returns the number of requests currently in the ready, execute or pending |
1287 | Returns the number of requests currently in the ready, execute or pending |
1112 | states (i.e. for which their callback has not been invoked yet). |
1288 | states (i.e. for which their callback has not been invoked yet). |
… | |
… | |
1127 | but not yet processed by poll_cb). |
1303 | but not yet processed by poll_cb). |
1128 | |
1304 | |
1129 | =back |
1305 | =back |
1130 | |
1306 | |
1131 | =cut |
1307 | =cut |
1132 | |
|
|
1133 | # support function to convert a fd into a perl filehandle |
|
|
1134 | sub _fd2fh { |
|
|
1135 | return undef if $_[0] < 0; |
|
|
1136 | |
|
|
1137 | # try to generate nice filehandles |
|
|
1138 | my $sym = "IO::AIO::fd#$_[0]"; |
|
|
1139 | local *$sym; |
|
|
1140 | |
|
|
1141 | open *$sym, "+<&=$_[0]" # usually works under any unix |
|
|
1142 | or open *$sym, "<&=$_[0]" # cygwin needs this |
|
|
1143 | or open *$sym, ">&=$_[0]" # or this |
|
|
1144 | or return undef; |
|
|
1145 | |
|
|
1146 | *$sym |
|
|
1147 | } |
|
|
1148 | |
1308 | |
1149 | min_parallel 8; |
1309 | min_parallel 8; |
1150 | |
1310 | |
1151 | END { flush } |
1311 | END { flush } |
1152 | |
1312 | |
… | |
… | |
1176 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1336 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1177 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1337 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1178 | scalars and other data passed into aio requests will also be locked and |
1338 | scalars and other data passed into aio requests will also be locked and |
1179 | will consume memory till the request has entered the done state. |
1339 | will consume memory till the request has entered the done state. |
1180 | |
1340 | |
1181 | This is now awfully much, so queuing lots of requests is not usually a |
1341 | This is not awfully much, so queuing lots of requests is not usually a |
1182 | problem. |
1342 | problem. |
1183 | |
1343 | |
1184 | Per-thread usage: |
1344 | Per-thread usage: |
1185 | |
1345 | |
1186 | In the execution phase, some aio requests require more memory for |
1346 | In the execution phase, some aio requests require more memory for |