… | |
… | |
14 | aio_unlink "/tmp/file", sub { }; |
14 | aio_unlink "/tmp/file", sub { }; |
15 | |
15 | |
16 | aio_read $fh, 30000, 1024, $buffer, 0, sub { |
16 | aio_read $fh, 30000, 1024, $buffer, 0, sub { |
17 | $_[0] > 0 or die "read error: $!"; |
17 | $_[0] > 0 or die "read error: $!"; |
18 | }; |
18 | }; |
|
|
19 | |
|
|
20 | use IO::AIO 2; # version has aio objects |
|
|
21 | |
|
|
22 | my $req = aio_unlink "/tmp/file", sub { }; |
|
|
23 | $req->cancel; # cancel request if still in queue |
19 | |
24 | |
20 | # AnyEvent |
25 | # AnyEvent |
21 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
26 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
22 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
27 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
23 | |
28 | |
… | |
… | |
66 | use strict 'vars'; |
71 | use strict 'vars'; |
67 | |
72 | |
68 | use base 'Exporter'; |
73 | use base 'Exporter'; |
69 | |
74 | |
70 | BEGIN { |
75 | BEGIN { |
71 | our $VERSION = '1.8'; |
76 | our $VERSION = '1.99'; |
72 | |
77 | |
73 | our @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
78 | our @EXPORT = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
74 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
79 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
75 | aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move); |
80 | aio_fsync aio_fdatasync aio_readahead aio_rename aio_link aio_move |
|
|
81 | aio_group); |
76 | our @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs); |
82 | our @EXPORT_OK = qw(poll_fileno poll_cb min_parallel max_parallel max_outstanding nreqs); |
|
|
83 | |
|
|
84 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
77 | |
85 | |
78 | require XSLoader; |
86 | require XSLoader; |
79 | XSLoader::load ("IO::AIO", $VERSION); |
87 | XSLoader::load ("IO::AIO", $VERSION); |
80 | } |
88 | } |
81 | |
89 | |
… | |
… | |
91 | perl, which usually delivers "false") as it's sole argument when the given |
99 | perl, which usually delivers "false") as it's sole argument when the given |
92 | syscall has been executed asynchronously. |
100 | syscall has been executed asynchronously. |
93 | |
101 | |
94 | All functions expecting a filehandle keep a copy of the filehandle |
102 | All functions expecting a filehandle keep a copy of the filehandle |
95 | internally until the request has finished. |
103 | internally until the request has finished. |
|
|
104 | |
|
|
105 | All non-composite requests (requests that are not broken down into |
|
|
106 | multiple requests) return objects of type L<IO::AIO::REQ> that allow |
|
|
107 | further manipulation of running requests. |
96 | |
108 | |
97 | The pathnames you pass to these routines I<must> be absolute and |
109 | The pathnames you pass to these routines I<must> be absolute and |
98 | encoded in byte form. The reason for the former is that at the time the |
110 | encoded in byte form. The reason for the former is that at the time the |
99 | request is being executed, the current working directory could have |
111 | request is being executed, the current working directory could have |
100 | changed. Alternatively, you can make sure that you never change the |
112 | changed. Alternatively, you can make sure that you never change the |
… | |
… | |
168 | print "read $_[0] bytes: <$buffer>\n"; |
180 | print "read $_[0] bytes: <$buffer>\n"; |
169 | }; |
181 | }; |
170 | |
182 | |
171 | =item aio_move $srcpath, $dstpath, $callback->($status) |
183 | =item aio_move $srcpath, $dstpath, $callback->($status) |
172 | |
184 | |
173 | [EXPERIMENTAL] |
|
|
174 | |
|
|
175 | Try to move the I<file> (directories not supported as either source or destination) |
185 | Try to move the I<file> (directories not supported as either source or |
176 | from C<$srcpath> to C<$dstpath> and call the callback with the C<0> (error) or C<-1> ok. |
186 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
|
|
187 | the C<0> (error) or C<-1> ok. |
177 | |
188 | |
178 | This is a composite request that tries to rename(2) the file first. If |
189 | This is a composite request that tries to rename(2) the file first. If |
179 | rename files with C<EXDEV>, it creates the destination file with mode 0200 |
190 | rename files with C<EXDEV>, it creates the destination file with mode 0200 |
180 | and copies the contents of the source file into it using C<aio_sendfile>, |
191 | and copies the contents of the source file into it using C<aio_sendfile>, |
181 | followed by restoring atime, mtime, access mode and uid/gid, in that |
192 | followed by restoring atime, mtime, access mode and uid/gid, in that |
… | |
… | |
326 | The callback a single argument which is either C<undef> or an array-ref |
337 | The callback a single argument which is either C<undef> or an array-ref |
327 | with the filenames. |
338 | with the filenames. |
328 | |
339 | |
329 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
340 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
330 | |
341 | |
331 | Scans a directory (similar to C<aio_readdir>) and tries to separate the |
342 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
332 | entries of directory C<$path> into two sets of names, ones you can recurse |
343 | separate the entries of directory C<$path> into two sets of names, ones |
333 | into (directories), and ones you cannot recurse into (everything else). |
344 | you can recurse into (directories or links to them), and ones you cannot |
|
|
345 | recurse into (everything else). |
334 | |
346 | |
335 | C<aio_scandir> is a composite request that consists of many |
347 | C<aio_scandir> is a composite request that consists of many sub |
336 | aio-primitives. C<$maxreq> specifies the maximum number of outstanding |
348 | requests. C<$maxreq> specifies the maximum number of outstanding aio |
337 | aio requests that this function generates. If it is C<< <= 0 >>, then a |
349 | requests that this function generates. If it is C<< <= 0 >>, then a |
338 | suitable default will be chosen (currently 8). |
350 | suitable default will be chosen (currently 8). |
339 | |
351 | |
340 | On error, the callback is called without arguments, otherwise it receives |
352 | On error, the callback is called without arguments, otherwise it receives |
341 | two array-refs with path-relative entry names. |
353 | two array-refs with path-relative entry names. |
342 | |
354 | |
… | |
… | |
351 | Implementation notes. |
363 | Implementation notes. |
352 | |
364 | |
353 | The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. |
365 | The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. |
354 | |
366 | |
355 | After reading the directory, the modification time, size etc. of the |
367 | After reading the directory, the modification time, size etc. of the |
356 | directory before and after the readdir is checked, and if they match, the |
368 | directory before and after the readdir is checked, and if they match (and |
357 | link count will be used to decide how many entries are directories (if |
369 | isn't the current time), the link count will be used to decide how many |
358 | >= 2). Otherwise, no knowledge of the number of subdirectories will be |
370 | entries are directories (if >= 2). Otherwise, no knowledge of the number |
359 | assumed. |
371 | of subdirectories will be assumed. |
360 | |
372 | |
361 | Then entires will be sorted into likely directories (everything without a |
373 | Then entries will be sorted into likely directories (everything without |
362 | non-initial dot) and likely non-directories (everything else). Then every |
374 | a non-initial dot currently) and likely non-directories (everything |
363 | entry + C</.> will be C<stat>'ed, likely directories first. This is often |
375 | else). Then every entry plus an appended C</.> will be C<stat>'ed, |
|
|
376 | likely directories first. If that succeeds, it assumes that the entry |
|
|
377 | is a directory or a symlink to directory (which will be checked |
|
|
378 | seperately). This is often faster than stat'ing the entry itself because |
364 | faster because filesystems might detect the type of the entry without |
379 | filesystems might detect the type of the entry without reading the inode |
365 | reading the inode data (e.g. ext2fs filetype feature). If that succeeds, |
380 | data (e.g. ext2fs filetype feature). |
366 | it assumes that the entry is a directory or a symlink to directory (which |
|
|
367 | will be checked seperately). |
|
|
368 | |
381 | |
369 | If the known number of directories has been reached, the rest of the |
382 | If the known number of directories (link count - 2) has been reached, the |
370 | entries is assumed to be non-directories. |
383 | rest of the entries is assumed to be non-directories. |
|
|
384 | |
|
|
385 | This only works with certainty on POSIX (= UNIX) filesystems, which |
|
|
386 | fortunately are the vast majority of filesystems around. |
|
|
387 | |
|
|
388 | It will also likely work on non-POSIX filesystems with reduced efficiency |
|
|
389 | as those tend to return 0 or 1 as link counts, which disables the |
|
|
390 | directory counting heuristic. |
371 | |
391 | |
372 | =cut |
392 | =cut |
373 | |
393 | |
374 | sub aio_scandir($$$) { |
394 | sub aio_scandir($$$) { |
375 | my ($path, $maxreq, $cb) = @_; |
395 | my ($path, $maxreq, $cb) = @_; |
… | |
… | |
377 | $maxreq = 8 if $maxreq <= 0; |
397 | $maxreq = 8 if $maxreq <= 0; |
378 | |
398 | |
379 | # stat once |
399 | # stat once |
380 | aio_stat $path, sub { |
400 | aio_stat $path, sub { |
381 | return $cb->() if $_[0]; |
401 | return $cb->() if $_[0]; |
|
|
402 | my $now = time; |
382 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
403 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
383 | |
404 | |
384 | # read the directory entries |
405 | # read the directory entries |
385 | aio_readdir $path, sub { |
406 | aio_readdir $path, sub { |
386 | my $entries = shift |
407 | my $entries = shift |
… | |
… | |
391 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
412 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
392 | |
413 | |
393 | my $ndirs; |
414 | my $ndirs; |
394 | |
415 | |
395 | # take the slow route if anything looks fishy |
416 | # take the slow route if anything looks fishy |
396 | if ($hash1 ne $hash2) { |
417 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
397 | $ndirs = -1; |
418 | $ndirs = -1; |
398 | } else { |
419 | } else { |
399 | # if nlink == 2, we are finished |
420 | # if nlink == 2, we are finished |
400 | # on non-posix-fs's, we rely on nlink < 2 |
421 | # on non-posix-fs's, we rely on nlink < 2 |
401 | $ndirs = (stat _)[3] - 2 |
422 | $ndirs = (stat _)[3] - 2 |
… | |
… | |
474 | callback with the fdatasync result code. |
495 | callback with the fdatasync result code. |
475 | |
496 | |
476 | If this call isn't available because your OS lacks it or it couldn't be |
497 | If this call isn't available because your OS lacks it or it couldn't be |
477 | detected, it will be emulated by calling C<fsync> instead. |
498 | detected, it will be emulated by calling C<fsync> instead. |
478 | |
499 | |
|
|
500 | =item aio_group $callback->() |
|
|
501 | |
|
|
502 | =item aio_sleep $fractional_seconds, $callback->() *NOT EXPORTED* |
|
|
503 | |
|
|
504 | Mainly used for debugging and benchmarking, this aio request puts one of |
|
|
505 | the request workers to sleep for the given time. |
|
|
506 | |
|
|
507 | =back |
|
|
508 | |
|
|
509 | =head2 IO::AIO::REQ CLASS |
|
|
510 | |
|
|
511 | All non-aggregate C<aio_*> functions return an object of this class when |
|
|
512 | called in non-void context. |
|
|
513 | |
|
|
514 | A request always moves through the following five states in its lifetime, |
|
|
515 | in order: B<ready> (request has been created, but has not been executed |
|
|
516 | yet), B<execute> (request is currently being executed), B<pending> |
|
|
517 | (request has been executed but callback has not been called yet), |
|
|
518 | B<result> (results are being processed synchronously, includes calling the |
|
|
519 | callback) and B<done> (request has reached the end of its lifetime and |
|
|
520 | holds no resources anymore). |
|
|
521 | |
|
|
522 | =over 4 |
|
|
523 | |
|
|
524 | =item $req->cancel |
|
|
525 | |
|
|
526 | Cancels the request, if possible. Has the effect of skipping execution |
|
|
527 | when entering the B<execute> state and skipping calling the callback when |
|
|
528 | entering the the B<result> state, but will leave the request otherwise |
|
|
529 | untouched. That means that requests that currently execute will not be |
|
|
530 | stopped and resources held by the request will not be freed prematurely. |
|
|
531 | |
479 | =back |
532 | =back |
480 | |
533 | |
481 | =head2 SUPPORT FUNCTIONS |
534 | =head2 SUPPORT FUNCTIONS |
482 | |
535 | |
483 | =over 4 |
536 | =over 4 |
… | |
… | |
610 | } |
663 | } |
611 | |
664 | |
612 | 1; |
665 | 1; |
613 | |
666 | |
614 | =head2 FORK BEHAVIOUR |
667 | =head2 FORK BEHAVIOUR |
|
|
668 | |
|
|
669 | This module should do "the right thing" when the process using it forks: |
615 | |
670 | |
616 | Before the fork, IO::AIO enters a quiescent state where no requests |
671 | Before the fork, IO::AIO enters a quiescent state where no requests |
617 | can be added in other threads and no results will be processed. After |
672 | can be added in other threads and no results will be processed. After |
618 | the fork the parent simply leaves the quiescent state and continues |
673 | the fork the parent simply leaves the quiescent state and continues |
619 | request/result processing, while the child clears the request/result |
674 | request/result processing, while the child clears the request/result |
620 | queue (so the requests started before the fork will only be handled in |
675 | queue (so the requests started before the fork will only be handled in |
621 | the parent). Threats will be started on demand until the limit ste in the |
676 | the parent). Threads will be started on demand until the limit ste in the |
622 | parent process has been reached again. |
677 | parent process has been reached again. |
623 | |
678 | |
|
|
679 | In short: the parent will, after a short pause, continue as if fork had |
|
|
680 | not been called, while the child will act as if IO::AIO has not been used |
|
|
681 | yet. |
|
|
682 | |
624 | =head1 SEE ALSO |
683 | =head1 SEE ALSO |
625 | |
684 | |
626 | L<Coro>, L<Linux::AIO>. |
685 | L<Coro>, L<Linux::AIO> (obsolete). |
627 | |
686 | |
628 | =head1 AUTHOR |
687 | =head1 AUTHOR |
629 | |
688 | |
630 | Marc Lehmann <schmorp@schmorp.de> |
689 | Marc Lehmann <schmorp@schmorp.de> |
631 | http://home.schmorp.de/ |
690 | http://home.schmorp.de/ |