… | |
… | |
26 | $req->cancel; # cancel request if still in queue |
26 | $req->cancel; # cancel request if still in queue |
27 | |
27 | |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
29 | add $grp aio_stat "..." for ...; |
29 | add $grp aio_stat "..." for ...; |
30 | |
30 | |
31 | # AnyEvent integration |
31 | # AnyEvent integration (EV, Event, Glib, Tk, urxvt, pureperl...) |
32 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
32 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
33 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
33 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
|
|
34 | |
|
|
35 | # EV integration |
|
|
36 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
34 | |
37 | |
35 | # Event integration |
38 | # Event integration |
36 | Event->io (fd => IO::AIO::poll_fileno, |
39 | Event->io (fd => IO::AIO::poll_fileno, |
37 | poll => 'r', |
40 | poll => 'r', |
38 | cb => \&IO::AIO::poll_cb); |
41 | cb => \&IO::AIO::poll_cb); |
… | |
… | |
62 | etc.), but can also be used to easily do operations in parallel that are |
65 | 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 |
66 | 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 |
67 | on a RAID volume or over NFS when you do a number of stat operations |
65 | concurrently. |
68 | concurrently. |
66 | |
69 | |
67 | While most of this works on all types of file descriptors (for example |
70 | While most of this works on all types of file descriptors (for |
68 | sockets), using these functions on file descriptors that support |
71 | example sockets), using these functions on file descriptors that |
69 | nonblocking operation (again, sockets, pipes etc.) is very inefficient or |
72 | support nonblocking operation (again, sockets, pipes etc.) is very |
70 | might not work (aio_read fails on sockets/pipes/fifos). Use an event loop |
73 | 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 |
74 | module): IO::AIO will naturally fit into such an event loop itself. |
72 | into such an event loop itself. |
|
|
73 | |
75 | |
74 | In this version, a number of threads are started that execute your |
76 | In this version, a number of threads are started that execute your |
75 | requests and signal their completion. You don't need thread support |
77 | 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 |
78 | 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 |
79 | 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 |
81 | 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 |
82 | files currently, for example), and they would only support aio_read and |
81 | aio_write, so the remaining functionality would have to be implemented |
83 | aio_write, so the remaining functionality would have to be implemented |
82 | using threads anyway. |
84 | using threads anyway. |
83 | |
85 | |
84 | Although the module will work with in the presence of other (Perl-) |
86 | 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 |
87 | 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 |
88 | 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. |
89 | call C<poll_cb> (or other C<aio_> functions) recursively. |
88 | |
90 | |
89 | =head2 EXAMPLE |
91 | =head2 EXAMPLE |
90 | |
92 | |
91 | This is a simple example that uses the Event module and loads |
93 | This is a simple example that uses the Event module and loads |
92 | F</etc/passwd> asynchronously: |
94 | F</etc/passwd> asynchronously: |
… | |
… | |
184 | |
186 | |
185 | =cut |
187 | =cut |
186 | |
188 | |
187 | package IO::AIO; |
189 | package IO::AIO; |
188 | |
190 | |
|
|
191 | use Carp (); |
|
|
192 | |
189 | no warnings; |
193 | no warnings; |
190 | use strict 'vars'; |
194 | use strict 'vars'; |
191 | |
195 | |
192 | use base 'Exporter'; |
196 | use base 'Exporter'; |
193 | |
197 | |
194 | BEGIN { |
198 | BEGIN { |
195 | our $VERSION = '2.32'; |
199 | our $VERSION = '2.6'; |
196 | |
200 | |
197 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
201 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
198 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
202 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
199 | aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link |
203 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
200 | aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree); |
204 | aio_fdatasync aio_pathsync aio_readahead |
|
|
205 | aio_rename aio_link aio_move aio_copy aio_group |
|
|
206 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
|
|
207 | aio_chmod aio_utime aio_truncate); |
|
|
208 | |
201 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
209 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
202 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
210 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
203 | min_parallel max_parallel max_idle |
211 | min_parallel max_parallel max_idle |
204 | nreqs nready npending nthreads |
212 | nreqs nready npending nthreads |
205 | max_poll_time max_poll_reqs); |
213 | max_poll_time max_poll_reqs); |
… | |
… | |
271 | aio_read $_[0], ..., sub { |
279 | aio_read $_[0], ..., sub { |
272 | ... |
280 | ... |
273 | }; |
281 | }; |
274 | }; |
282 | }; |
275 | |
283 | |
|
|
284 | |
276 | =item aioreq_nice $pri_adjust |
285 | =item aioreq_nice $pri_adjust |
277 | |
286 | |
278 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
287 | Similar to C<aioreq_pri>, but subtracts the given value from the current |
279 | priority, so the effect is cumulative. |
288 | priority, so the effect is cumulative. |
|
|
289 | |
280 | |
290 | |
281 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
291 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
282 | |
292 | |
283 | Asynchronously open or create a file and call the callback with a newly |
293 | Asynchronously open or create a file and call the callback with a newly |
284 | created filehandle for the file. |
294 | created filehandle for the file. |
… | |
… | |
290 | list. They are the same as used by C<sysopen>. |
300 | list. They are the same as used by C<sysopen>. |
291 | |
301 | |
292 | Likewise, C<$mode> specifies the mode of the newly created file, if it |
302 | 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>, |
303 | 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, |
304 | 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). |
305 | and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified |
|
|
306 | by the umask in effect then the request is being executed, so better never |
|
|
307 | change the umask. |
296 | |
308 | |
297 | Example: |
309 | Example: |
298 | |
310 | |
299 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
311 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
300 | if ($_[0]) { |
312 | if ($_[0]) { |
… | |
… | |
303 | } else { |
315 | } else { |
304 | die "open failed: $!\n"; |
316 | die "open failed: $!\n"; |
305 | } |
317 | } |
306 | }; |
318 | }; |
307 | |
319 | |
|
|
320 | |
308 | =item aio_close $fh, $callback->($status) |
321 | =item aio_close $fh, $callback->($status) |
309 | |
322 | |
310 | Asynchronously close a file and call the callback with the result |
323 | Asynchronously close a file and call the callback with the result |
311 | code. I<WARNING:> although accepted, you should not pass in a perl |
324 | 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 | |
325 | |
316 | This is supposed to be a bug in the API, so that might change. It's |
326 | Unfortunately, you can't do this to perl. Perl I<insists> very strongly on |
317 | therefore best to avoid this function. |
327 | closing the file descriptor associated with the filehandle itself. Here is |
|
|
328 | what aio_close will try: |
|
|
329 | |
|
|
330 | 1. dup()licate the fd |
|
|
331 | 2. asynchronously close() the duplicated fd |
|
|
332 | 3. dup()licate the fd once more |
|
|
333 | 4. let perl close() the filehandle |
|
|
334 | 5. asynchronously close the duplicated fd |
|
|
335 | |
|
|
336 | The idea is that the first close() flushes stuff to disk that closing an |
|
|
337 | fd will flush, so when perl closes the fd, nothing much will need to be |
|
|
338 | flushed. The second async. close() will then flush stuff to disk that |
|
|
339 | closing the last fd to the file will flush. |
|
|
340 | |
|
|
341 | Just FYI, SuSv3 has this to say on close: |
|
|
342 | |
|
|
343 | All outstanding record locks owned by the process on the file |
|
|
344 | associated with the file descriptor shall be removed. |
|
|
345 | |
|
|
346 | If fildes refers to a socket, close() shall cause the socket to be |
|
|
347 | destroyed. ... close() shall block for up to the current linger |
|
|
348 | interval until all data is transmitted. |
|
|
349 | [this actually sounds like a specification bug, but who knows] |
|
|
350 | |
|
|
351 | And at least Linux additionally actually flushes stuff on every close, |
|
|
352 | even when the file itself is still open. |
|
|
353 | |
|
|
354 | Sounds enourmously inefficient and complicated? Yes... please show me how |
|
|
355 | to nuke perl's fd out of existence... |
|
|
356 | |
|
|
357 | =cut |
|
|
358 | |
|
|
359 | sub aio_close($;$) { |
|
|
360 | aio_block { |
|
|
361 | my ($fh, $cb) = @_; |
|
|
362 | |
|
|
363 | my $pri = aioreq_pri; |
|
|
364 | my $grp = aio_group $cb; |
|
|
365 | |
|
|
366 | my $fd = fileno $fh; |
|
|
367 | |
|
|
368 | defined $fd or Carp::croak "aio_close called with fd-less filehandle"; |
|
|
369 | |
|
|
370 | # if the dups fail we will simply get EBADF |
|
|
371 | my $fd2 = _dup $fd; |
|
|
372 | aioreq_pri $pri; |
|
|
373 | add $grp _aio_close $fd2, sub { |
|
|
374 | my $fd2 = _dup $fd; |
|
|
375 | close $fh; |
|
|
376 | aioreq_pri $pri; |
|
|
377 | add $grp _aio_close $fd2, sub { |
|
|
378 | $grp->result ($_[0]); |
|
|
379 | }; |
|
|
380 | }; |
|
|
381 | |
|
|
382 | $grp |
|
|
383 | } |
|
|
384 | } |
|
|
385 | |
318 | |
386 | |
319 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
387 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
320 | |
388 | |
321 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
389 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
322 | |
390 | |
323 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
391 | 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 |
392 | 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 |
393 | callback without the actual number of bytes read (or -1 on error, just |
326 | like the syscall). |
394 | like the syscall). |
327 | |
395 | |
|
|
396 | If C<$offset> is undefined, then the current file descriptor offset will |
|
|
397 | be used (and updated), otherwise the file descriptor offset will not be |
|
|
398 | changed by these calls. |
|
|
399 | |
|
|
400 | If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. |
|
|
401 | |
|
|
402 | If C<$dataoffset> is less than zero, it will be counted from the end of |
|
|
403 | C<$data>. |
|
|
404 | |
328 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
405 | 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 |
406 | is outstanding. Modifying it can result in segfaults or World War III (if |
330 | necessary/optional hardware is installed). |
407 | the necessary/optional hardware is installed). |
331 | |
408 | |
332 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
409 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
333 | offset C<0> within the scalar: |
410 | offset C<0> within the scalar: |
334 | |
411 | |
335 | aio_read $fh, 7, 15, $buffer, 0, sub { |
412 | aio_read $fh, 7, 15, $buffer, 0, sub { |
336 | $_[0] > 0 or die "read error: $!"; |
413 | $_[0] > 0 or die "read error: $!"; |
337 | print "read $_[0] bytes: <$buffer>\n"; |
414 | print "read $_[0] bytes: <$buffer>\n"; |
338 | }; |
415 | }; |
|
|
416 | |
339 | |
417 | |
340 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
418 | =item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
341 | |
419 | |
342 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
420 | 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 |
421 | 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 |
435 | 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 |
436 | 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 |
437 | 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 |
438 | value equals C<$length> one can assume that C<$length> bytes have been |
361 | read. |
439 | read. |
|
|
440 | |
362 | |
441 | |
363 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
442 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
364 | |
443 | |
365 | C<aio_readahead> populates the page cache with data from a file so that |
444 | 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> |
445 | 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. |
451 | file. The current file offset of the file is left unchanged. |
373 | |
452 | |
374 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
453 | 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. |
454 | emulated by simply reading the data, which would have a similar effect. |
376 | |
455 | |
|
|
456 | |
377 | =item aio_stat $fh_or_path, $callback->($status) |
457 | =item aio_stat $fh_or_path, $callback->($status) |
378 | |
458 | |
379 | =item aio_lstat $fh, $callback->($status) |
459 | =item aio_lstat $fh, $callback->($status) |
380 | |
460 | |
381 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
461 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
… | |
… | |
394 | aio_stat "/etc/passwd", sub { |
474 | aio_stat "/etc/passwd", sub { |
395 | $_[0] and die "stat failed: $!"; |
475 | $_[0] and die "stat failed: $!"; |
396 | print "size is ", -s _, "\n"; |
476 | print "size is ", -s _, "\n"; |
397 | }; |
477 | }; |
398 | |
478 | |
|
|
479 | |
|
|
480 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
|
|
481 | |
|
|
482 | Works like perl's C<utime> function (including the special case of $atime |
|
|
483 | and $mtime being undef). Fractional times are supported if the underlying |
|
|
484 | syscalls support them. |
|
|
485 | |
|
|
486 | When called with a pathname, uses utimes(2) if available, otherwise |
|
|
487 | utime(2). If called on a file descriptor, uses futimes(2) if available, |
|
|
488 | otherwise returns ENOSYS, so this is not portable. |
|
|
489 | |
|
|
490 | Examples: |
|
|
491 | |
|
|
492 | # set atime and mtime to current time (basically touch(1)): |
|
|
493 | aio_utime "path", undef, undef; |
|
|
494 | # set atime to current time and mtime to beginning of the epoch: |
|
|
495 | aio_utime "path", time, undef; # undef==0 |
|
|
496 | |
|
|
497 | |
|
|
498 | =item aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
499 | |
|
|
500 | Works like perl's C<chown> function, except that C<undef> for either $uid |
|
|
501 | or $gid is being interpreted as "do not change" (but -1 can also be used). |
|
|
502 | |
|
|
503 | Examples: |
|
|
504 | |
|
|
505 | # same as "chown root path" in the shell: |
|
|
506 | aio_chown "path", 0, -1; |
|
|
507 | # same as above: |
|
|
508 | aio_chown "path", 0, undef; |
|
|
509 | |
|
|
510 | |
|
|
511 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
512 | |
|
|
513 | Works like truncate(2) or ftruncate(2). |
|
|
514 | |
|
|
515 | |
|
|
516 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
517 | |
|
|
518 | Works like perl's C<chmod> function. |
|
|
519 | |
|
|
520 | |
399 | =item aio_unlink $pathname, $callback->($status) |
521 | =item aio_unlink $pathname, $callback->($status) |
400 | |
522 | |
401 | Asynchronously unlink (delete) a file and call the callback with the |
523 | Asynchronously unlink (delete) a file and call the callback with the |
402 | result code. |
524 | result code. |
403 | |
525 | |
|
|
526 | |
404 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
527 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
405 | |
528 | |
406 | [EXPERIMENTAL] |
529 | [EXPERIMENTAL] |
407 | |
530 | |
408 | Asynchronously create a device node (or fifo). See mknod(2). |
531 | Asynchronously create a device node (or fifo). See mknod(2). |
409 | |
532 | |
410 | The only (POSIX-) portable way of calling this function is: |
533 | The only (POSIX-) portable way of calling this function is: |
411 | |
534 | |
412 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
535 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
|
|
536 | |
413 | |
537 | |
414 | =item aio_link $srcpath, $dstpath, $callback->($status) |
538 | =item aio_link $srcpath, $dstpath, $callback->($status) |
415 | |
539 | |
416 | Asynchronously create a new link to the existing object at C<$srcpath> at |
540 | 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. |
541 | the path C<$dstpath> and call the callback with the result code. |
418 | |
542 | |
|
|
543 | |
419 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
544 | =item aio_symlink $srcpath, $dstpath, $callback->($status) |
420 | |
545 | |
421 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
546 | 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. |
547 | the path C<$dstpath> and call the callback with the result code. |
|
|
548 | |
423 | |
549 | |
424 | =item aio_readlink $path, $callback->($link) |
550 | =item aio_readlink $path, $callback->($link) |
425 | |
551 | |
426 | Asynchronously read the symlink specified by C<$path> and pass it to |
552 | 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 |
553 | the callback. If an error occurs, nothing or undef gets passed to the |
428 | callback. |
554 | callback. |
429 | |
555 | |
|
|
556 | |
430 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
557 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
431 | |
558 | |
432 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
559 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
433 | rename(2) and call the callback with the result code. |
560 | rename(2) and call the callback with the result code. |
434 | |
561 | |
|
|
562 | |
|
|
563 | =item aio_mkdir $pathname, $mode, $callback->($status) |
|
|
564 | |
|
|
565 | Asynchronously mkdir (create) a directory and call the callback with |
|
|
566 | the result code. C<$mode> will be modified by the umask at the time the |
|
|
567 | request is executed, so do not change your umask. |
|
|
568 | |
|
|
569 | |
435 | =item aio_rmdir $pathname, $callback->($status) |
570 | =item aio_rmdir $pathname, $callback->($status) |
436 | |
571 | |
437 | Asynchronously rmdir (delete) a directory and call the callback with the |
572 | Asynchronously rmdir (delete) a directory and call the callback with the |
438 | result code. |
573 | result code. |
|
|
574 | |
439 | |
575 | |
440 | =item aio_readdir $pathname, $callback->($entries) |
576 | =item aio_readdir $pathname, $callback->($entries) |
441 | |
577 | |
442 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
578 | 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 |
579 | directory (i.e. opendir + readdir + closedir). The entries will not be |
444 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
580 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
445 | |
581 | |
446 | The callback a single argument which is either C<undef> or an array-ref |
582 | The callback a single argument which is either C<undef> or an array-ref |
447 | with the filenames. |
583 | with the filenames. |
|
|
584 | |
448 | |
585 | |
449 | =item aio_load $path, $data, $callback->($status) |
586 | =item aio_load $path, $data, $callback->($status) |
450 | |
587 | |
451 | This is a composite request that tries to fully load the given file into |
588 | This is a composite request that tries to fully load the given file into |
452 | memory. Status is the same as with aio_read. |
589 | memory. Status is the same as with aio_read. |
… | |
… | |
461 | my $pri = aioreq_pri; |
598 | my $pri = aioreq_pri; |
462 | my $grp = aio_group $cb; |
599 | my $grp = aio_group $cb; |
463 | |
600 | |
464 | aioreq_pri $pri; |
601 | aioreq_pri $pri; |
465 | add $grp aio_open $path, O_RDONLY, 0, sub { |
602 | add $grp aio_open $path, O_RDONLY, 0, sub { |
466 | my ($fh) = @_ |
603 | my $fh = shift |
467 | or return $grp->result (-1); |
604 | or return $grp->result (-1); |
468 | |
605 | |
469 | aioreq_pri $pri; |
606 | aioreq_pri $pri; |
470 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
607 | add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub { |
471 | $grp->result ($_[0]); |
608 | $grp->result ($_[0]); |
… | |
… | |
516 | |
653 | |
517 | # those should not normally block. should. should. |
654 | # those should not normally block. should. should. |
518 | utime $stat[8], $stat[9], $dst; |
655 | utime $stat[8], $stat[9], $dst; |
519 | chmod $stat[2] & 07777, $dst_fh; |
656 | chmod $stat[2] & 07777, $dst_fh; |
520 | chown $stat[4], $stat[5], $dst_fh; |
657 | chown $stat[4], $stat[5], $dst_fh; |
|
|
658 | |
|
|
659 | aioreq_pri $pri; |
521 | close $dst_fh; |
660 | add $grp aio_close $dst_fh; |
522 | } else { |
661 | } else { |
523 | $grp->result (-1); |
662 | $grp->result (-1); |
524 | close $src_fh; |
663 | close $src_fh; |
525 | close $dst_fh; |
664 | close $dst_fh; |
526 | |
665 | |
… | |
… | |
759 | |
898 | |
760 | $grp |
899 | $grp |
761 | } |
900 | } |
762 | } |
901 | } |
763 | |
902 | |
|
|
903 | =item aio_sync $callback->($status) |
|
|
904 | |
|
|
905 | Asynchronously call sync and call the callback when finished. |
|
|
906 | |
764 | =item aio_fsync $fh, $callback->($status) |
907 | =item aio_fsync $fh, $callback->($status) |
765 | |
908 | |
766 | Asynchronously call fsync on the given filehandle and call the callback |
909 | Asynchronously call fsync on the given filehandle and call the callback |
767 | with the fsync result code. |
910 | with the fsync result code. |
768 | |
911 | |
… | |
… | |
771 | Asynchronously call fdatasync on the given filehandle and call the |
914 | Asynchronously call fdatasync on the given filehandle and call the |
772 | callback with the fdatasync result code. |
915 | callback with the fdatasync result code. |
773 | |
916 | |
774 | If this call isn't available because your OS lacks it or it couldn't be |
917 | If this call isn't available because your OS lacks it or it couldn't be |
775 | detected, it will be emulated by calling C<fsync> instead. |
918 | detected, it will be emulated by calling C<fsync> instead. |
|
|
919 | |
|
|
920 | =item aio_pathsync $path, $callback->($status) |
|
|
921 | |
|
|
922 | This request tries to open, fsync and close the given path. This is a |
|
|
923 | composite request intended tosync directories after directory operations |
|
|
924 | (E.g. rename). This might not work on all operating systems or have any |
|
|
925 | specific effect, but usually it makes sure that directory changes get |
|
|
926 | written to disc. It works for anything that can be opened for read-only, |
|
|
927 | not just directories. |
|
|
928 | |
|
|
929 | Passes C<0> when everything went ok, and C<-1> on error. |
|
|
930 | |
|
|
931 | =cut |
|
|
932 | |
|
|
933 | sub aio_pathsync($;$) { |
|
|
934 | aio_block { |
|
|
935 | my ($path, $cb) = @_; |
|
|
936 | |
|
|
937 | my $pri = aioreq_pri; |
|
|
938 | my $grp = aio_group $cb; |
|
|
939 | |
|
|
940 | aioreq_pri $pri; |
|
|
941 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
942 | my ($fh) = @_; |
|
|
943 | if ($fh) { |
|
|
944 | aioreq_pri $pri; |
|
|
945 | add $grp aio_fsync $fh, sub { |
|
|
946 | $grp->result ($_[0]); |
|
|
947 | |
|
|
948 | aioreq_pri $pri; |
|
|
949 | add $grp aio_close $fh; |
|
|
950 | }; |
|
|
951 | } else { |
|
|
952 | $grp->result (-1); |
|
|
953 | } |
|
|
954 | }; |
|
|
955 | |
|
|
956 | $grp |
|
|
957 | } |
|
|
958 | } |
776 | |
959 | |
777 | =item aio_group $callback->(...) |
960 | =item aio_group $callback->(...) |
778 | |
961 | |
779 | This is a very special aio request: Instead of doing something, it is a |
962 | This is a very special aio request: Instead of doing something, it is a |
780 | container for other aio requests, which is useful if you want to bundle |
963 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
917 | itself. Useful when you queued a lot of events but got a result early. |
1100 | itself. Useful when you queued a lot of events but got a result early. |
918 | |
1101 | |
919 | =item $grp->result (...) |
1102 | =item $grp->result (...) |
920 | |
1103 | |
921 | Set the result value(s) that will be passed to the group callback when all |
1104 | Set the result value(s) that will be passed to the group callback when all |
922 | subrequests have finished and set thre groups errno to the current value |
1105 | subrequests have finished and set the groups errno to the current value |
923 | of errno (just like calling C<errno> without an error number). By default, |
1106 | of errno (just like calling C<errno> without an error number). By default, |
924 | no argument will be passed and errno is zero. |
1107 | no argument will be passed and errno is zero. |
925 | |
1108 | |
926 | =item $grp->errno ([$errno]) |
1109 | =item $grp->errno ([$errno]) |
927 | |
1110 | |
… | |
… | |
1070 | Strictly equivalent to: |
1253 | Strictly equivalent to: |
1071 | |
1254 | |
1072 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1255 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1073 | while IO::AIO::nreqs; |
1256 | while IO::AIO::nreqs; |
1074 | |
1257 | |
|
|
1258 | =back |
|
|
1259 | |
1075 | =head3 CONTROLLING THE NUMBER OF THREADS |
1260 | =head3 CONTROLLING THE NUMBER OF THREADS |
|
|
1261 | |
|
|
1262 | =over |
1076 | |
1263 | |
1077 | =item IO::AIO::min_parallel $nthreads |
1264 | =item IO::AIO::min_parallel $nthreads |
1078 | |
1265 | |
1079 | Set the minimum number of AIO threads to C<$nthreads>. The current |
1266 | Set the minimum number of AIO threads to C<$nthreads>. The current |
1080 | default is C<8>, which means eight asynchronous operations can execute |
1267 | default is C<8>, which means eight asynchronous operations can execute |
… | |
… | |
1128 | This is a very bad function to use in interactive programs because it |
1315 | This is a very bad function to use in interactive programs because it |
1129 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1316 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1130 | use an C<aio_group> together with a feed callback. |
1317 | use an C<aio_group> together with a feed callback. |
1131 | |
1318 | |
1132 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1319 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1133 | to queue up more than this number of requests, the next call to the |
1320 | do queue up more than this number of requests, the next call to the |
1134 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1321 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1135 | function will block until the limit is no longer exceeded. |
1322 | function will block until the limit is no longer exceeded. |
1136 | |
1323 | |
1137 | The default value is very large, so there is no practical limit on the |
1324 | The default value is very large, so there is no practical limit on the |
1138 | number of outstanding requests. |
1325 | number of outstanding requests. |
1139 | |
1326 | |
1140 | You can still queue as many requests as you want. Therefore, |
1327 | 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 |
1328 | 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). |
1329 | as a stop gap to shield against fatal memory overflow (with large values). |
1143 | |
1330 | |
|
|
1331 | =back |
|
|
1332 | |
1144 | =head3 STATISTICAL INFORMATION |
1333 | =head3 STATISTICAL INFORMATION |
|
|
1334 | |
|
|
1335 | =over |
1145 | |
1336 | |
1146 | =item IO::AIO::nreqs |
1337 | =item IO::AIO::nreqs |
1147 | |
1338 | |
1148 | Returns the number of requests currently in the ready, execute or pending |
1339 | 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). |
1340 | states (i.e. for which their callback has not been invoked yet). |
… | |
… | |
1164 | but not yet processed by poll_cb). |
1355 | but not yet processed by poll_cb). |
1165 | |
1356 | |
1166 | =back |
1357 | =back |
1167 | |
1358 | |
1168 | =cut |
1359 | =cut |
1169 | |
|
|
1170 | # support function to convert a fd into a perl filehandle |
|
|
1171 | sub _fd2fh { |
|
|
1172 | return undef if $_[0] < 0; |
|
|
1173 | |
|
|
1174 | # try to generate nice filehandles |
|
|
1175 | my $sym = "IO::AIO::fd#$_[0]"; |
|
|
1176 | local *$sym; |
|
|
1177 | |
|
|
1178 | open *$sym, "+<&=$_[0]" # usually works under any unix |
|
|
1179 | or open *$sym, "<&=$_[0]" # cygwin needs this |
|
|
1180 | or open *$sym, ">&=$_[0]" # or this |
|
|
1181 | or return undef; |
|
|
1182 | |
|
|
1183 | *$sym |
|
|
1184 | } |
|
|
1185 | |
1360 | |
1186 | min_parallel 8; |
1361 | min_parallel 8; |
1187 | |
1362 | |
1188 | END { flush } |
1363 | END { flush } |
1189 | |
1364 | |
… | |
… | |
1213 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1388 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1214 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1389 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1215 | scalars and other data passed into aio requests will also be locked and |
1390 | scalars and other data passed into aio requests will also be locked and |
1216 | will consume memory till the request has entered the done state. |
1391 | will consume memory till the request has entered the done state. |
1217 | |
1392 | |
1218 | This is now awfully much, so queuing lots of requests is not usually a |
1393 | This is not awfully much, so queuing lots of requests is not usually a |
1219 | problem. |
1394 | problem. |
1220 | |
1395 | |
1221 | Per-thread usage: |
1396 | Per-thread usage: |
1222 | |
1397 | |
1223 | In the execution phase, some aio requests require more memory for |
1398 | In the execution phase, some aio requests require more memory for |