… | |
… | |
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 | |
… | |
… | |
92 | syscall has been executed asynchronously. |
97 | syscall has been executed asynchronously. |
93 | |
98 | |
94 | All functions expecting a filehandle keep a copy of the filehandle |
99 | All functions expecting a filehandle keep a copy of the filehandle |
95 | internally until the request has finished. |
100 | internally until the request has finished. |
96 | |
101 | |
|
|
102 | All non-composite requests (requests that are not broken down into |
|
|
103 | multiple requests) return objects of type L<IO::AIO::REQ> that allow |
|
|
104 | further manipulation of running requests. |
|
|
105 | |
97 | The pathnames you pass to these routines I<must> be absolute and |
106 | 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 |
107 | 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 |
108 | request is being executed, the current working directory could have |
100 | changed. Alternatively, you can make sure that you never change the |
109 | changed. Alternatively, you can make sure that you never change the |
101 | current working directory. |
110 | current working directory. |
… | |
… | |
168 | print "read $_[0] bytes: <$buffer>\n"; |
177 | print "read $_[0] bytes: <$buffer>\n"; |
169 | }; |
178 | }; |
170 | |
179 | |
171 | =item aio_move $srcpath, $dstpath, $callback->($status) |
180 | =item aio_move $srcpath, $dstpath, $callback->($status) |
172 | |
181 | |
173 | [EXPERIMENTAL] |
|
|
174 | |
|
|
175 | Try to move the I<file> (directories not supported as either source or destination) |
182 | 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. |
183 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
|
|
184 | the C<0> (error) or C<-1> ok. |
177 | |
185 | |
178 | This is a composite request that tries to rename(2) the file first. If |
186 | 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 |
187 | 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>, |
188 | 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 |
189 | 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 |
334 | The callback a single argument which is either C<undef> or an array-ref |
327 | with the filenames. |
335 | with the filenames. |
328 | |
336 | |
329 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
337 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
330 | |
338 | |
331 | Scans a directory (similar to C<aio_readdir>) and tries to separate the |
339 | 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 |
340 | separate the entries of directory C<$path> into two sets of names, ones |
333 | into (directories), and ones you cannot recurse into (everything else). |
341 | you can recurse into (directories or links to them), and ones you cannot |
|
|
342 | recurse into (everything else). |
334 | |
343 | |
335 | C<aio_scandir> is a composite request that consists of many |
344 | C<aio_scandir> is a composite request that consists of many sub |
336 | aio-primitives. C<$maxreq> specifies the maximum number of outstanding |
345 | requests. C<$maxreq> specifies the maximum number of outstanding aio |
337 | aio requests that this function generates. If it is C<< <= 0 >>, then a |
346 | requests that this function generates. If it is C<< <= 0 >>, then a |
338 | suitable default will be chosen (currently 8). |
347 | suitable default will be chosen (currently 8). |
339 | |
348 | |
340 | On error, the callback is called without arguments, otherwise it receives |
349 | On error, the callback is called without arguments, otherwise it receives |
341 | two array-refs with path-relative entry names. |
350 | two array-refs with path-relative entry names. |
342 | |
351 | |
… | |
… | |
351 | Implementation notes. |
360 | Implementation notes. |
352 | |
361 | |
353 | The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. |
362 | The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. |
354 | |
363 | |
355 | After reading the directory, the modification time, size etc. of the |
364 | 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 |
365 | 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 |
366 | 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 |
367 | entries are directories (if >= 2). Otherwise, no knowledge of the number |
359 | assumed. |
368 | of subdirectories will be assumed. |
360 | |
369 | |
361 | Then entires will be sorted into likely directories (everything without a |
370 | Then entries will be sorted into likely directories (everything without |
362 | non-initial dot) and likely non-directories (everything else). Then every |
371 | a non-initial dot currently) and likely non-directories (everything |
363 | entry + C</.> will be C<stat>'ed, likely directories first. This is often |
372 | else). Then every entry plus an appended C</.> will be C<stat>'ed, |
|
|
373 | likely directories first. If that succeeds, it assumes that the entry |
|
|
374 | is a directory or a symlink to directory (which will be checked |
|
|
375 | seperately). This is often faster than stat'ing the entry itself because |
364 | faster because filesystems might detect the type of the entry without |
376 | 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, |
377 | 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 | |
378 | |
369 | If the known number of directories has been reached, the rest of the |
379 | If the known number of directories (link count - 2) has been reached, the |
370 | entries is assumed to be non-directories. |
380 | rest of the entries is assumed to be non-directories. |
|
|
381 | |
|
|
382 | This only works with certainty on POSIX (= UNIX) filesystems, which |
|
|
383 | fortunately are the vast majority of filesystems around. |
|
|
384 | |
|
|
385 | It will also likely work on non-POSIX filesystems with reduced efficiency |
|
|
386 | as those tend to return 0 or 1 as link counts, which disables the |
|
|
387 | directory counting heuristic. |
371 | |
388 | |
372 | =cut |
389 | =cut |
373 | |
390 | |
374 | sub aio_scandir($$$) { |
391 | sub aio_scandir($$$) { |
375 | my ($path, $maxreq, $cb) = @_; |
392 | my ($path, $maxreq, $cb) = @_; |
… | |
… | |
377 | $maxreq = 8 if $maxreq <= 0; |
394 | $maxreq = 8 if $maxreq <= 0; |
378 | |
395 | |
379 | # stat once |
396 | # stat once |
380 | aio_stat $path, sub { |
397 | aio_stat $path, sub { |
381 | return $cb->() if $_[0]; |
398 | return $cb->() if $_[0]; |
|
|
399 | my $now = time; |
382 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
400 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
383 | |
401 | |
384 | # read the directory entries |
402 | # read the directory entries |
385 | aio_readdir $path, sub { |
403 | aio_readdir $path, sub { |
386 | my $entries = shift |
404 | my $entries = shift |
… | |
… | |
391 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
409 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
392 | |
410 | |
393 | my $ndirs; |
411 | my $ndirs; |
394 | |
412 | |
395 | # take the slow route if anything looks fishy |
413 | # take the slow route if anything looks fishy |
396 | if ($hash1 ne $hash2) { |
414 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
397 | $ndirs = -1; |
415 | $ndirs = -1; |
398 | } else { |
416 | } else { |
399 | # if nlink == 2, we are finished |
417 | # if nlink == 2, we are finished |
400 | # on non-posix-fs's, we rely on nlink < 2 |
418 | # on non-posix-fs's, we rely on nlink < 2 |
401 | $ndirs = (stat _)[3] - 2 |
419 | $ndirs = (stat _)[3] - 2 |
… | |
… | |
476 | If this call isn't available because your OS lacks it or it couldn't be |
494 | 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. |
495 | detected, it will be emulated by calling C<fsync> instead. |
478 | |
496 | |
479 | =back |
497 | =back |
480 | |
498 | |
|
|
499 | =head2 IO::AIO::CB CLASS |
|
|
500 | |
|
|
501 | All non-aggregate C<aio_*> functions return an object of this class when |
|
|
502 | called in non-void context. |
|
|
503 | |
|
|
504 | A request always moves through the following five states in its lifetime, |
|
|
505 | in order: B<ready> (request has been created, but has not been executed |
|
|
506 | yet), B<execute> (request is currently being executed), B<pending> |
|
|
507 | (request has been executed but callback has not been called yet), |
|
|
508 | B<result> (results are being processed synchronously, includes calling the |
|
|
509 | callback) and B<done> (request has reached the end of its lifetime and |
|
|
510 | holds no resources anymore). |
|
|
511 | |
|
|
512 | =over 4 |
|
|
513 | |
|
|
514 | =item $req->cancel |
|
|
515 | |
|
|
516 | Cancels the request, if possible. Has the effect of skipping execution |
|
|
517 | when entering the B<execute> state and skipping calling the callback when |
|
|
518 | entering the the B<result> state, but will leave the request otherwise |
|
|
519 | untouched. That means that requests that currently execute will not be |
|
|
520 | stopped and resources held by the request will not be freed prematurely. |
|
|
521 | |
|
|
522 | =back |
|
|
523 | |
481 | =head2 SUPPORT FUNCTIONS |
524 | =head2 SUPPORT FUNCTIONS |
482 | |
525 | |
483 | =over 4 |
526 | =over 4 |
484 | |
527 | |
485 | =item $fileno = IO::AIO::poll_fileno |
528 | =item $fileno = IO::AIO::poll_fileno |
… | |
… | |
610 | } |
653 | } |
611 | |
654 | |
612 | 1; |
655 | 1; |
613 | |
656 | |
614 | =head2 FORK BEHAVIOUR |
657 | =head2 FORK BEHAVIOUR |
|
|
658 | |
|
|
659 | This module should do "the right thing" when the process using it forks: |
615 | |
660 | |
616 | Before the fork, IO::AIO enters a quiescent state where no requests |
661 | 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 |
662 | 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 |
663 | the fork the parent simply leaves the quiescent state and continues |
619 | request/result processing, while the child clears the request/result |
664 | request/result processing, while the child clears the request/result |
620 | queue (so the requests started before the fork will only be handled in |
665 | 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 |
666 | the parent). Threads will be started on demand until the limit ste in the |
622 | parent process has been reached again. |
667 | parent process has been reached again. |
623 | |
668 | |
|
|
669 | In short: the parent will, after a short pause, continue as if fork had |
|
|
670 | not been called, while the child will act as if IO::AIO has not been used |
|
|
671 | yet. |
|
|
672 | |
624 | =head1 SEE ALSO |
673 | =head1 SEE ALSO |
625 | |
674 | |
626 | L<Coro>, L<Linux::AIO>. |
675 | L<Coro>, L<Linux::AIO> (obsolete). |
627 | |
676 | |
628 | =head1 AUTHOR |
677 | =head1 AUTHOR |
629 | |
678 | |
630 | Marc Lehmann <schmorp@schmorp.de> |
679 | Marc Lehmann <schmorp@schmorp.de> |
631 | http://home.schmorp.de/ |
680 | http://home.schmorp.de/ |