… | |
… | |
168 | use common::sense; |
168 | use common::sense; |
169 | |
169 | |
170 | use base 'Exporter'; |
170 | use base 'Exporter'; |
171 | |
171 | |
172 | BEGIN { |
172 | BEGIN { |
173 | our $VERSION = '4.0'; |
173 | our $VERSION = '4.15'; |
174 | |
174 | |
175 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
175 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
176 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
176 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
177 | aio_scandir aio_symlink aio_readlink aio_realpath aio_sync |
177 | aio_scandir aio_symlink aio_readlink aio_realpath aio_sync |
178 | aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate |
178 | aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate |
179 | aio_pathsync aio_readahead |
179 | aio_pathsync aio_readahead aio_fiemap |
180 | aio_rename aio_link aio_move aio_copy aio_group |
180 | aio_rename aio_link aio_move aio_copy aio_group |
181 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
181 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
182 | aio_chmod aio_utime aio_truncate |
182 | aio_chmod aio_utime aio_truncate |
183 | aio_msync aio_mtouch aio_mlock aio_mlockall |
183 | aio_msync aio_mtouch aio_mlock aio_mlockall |
184 | aio_statvfs |
184 | aio_statvfs |
… | |
… | |
209 | documentation. |
209 | documentation. |
210 | |
210 | |
211 | aio_wd $pathname, $callback->($wd) |
211 | aio_wd $pathname, $callback->($wd) |
212 | aio_open $pathname, $flags, $mode, $callback->($fh) |
212 | aio_open $pathname, $flags, $mode, $callback->($fh) |
213 | aio_close $fh, $callback->($status) |
213 | aio_close $fh, $callback->($status) |
|
|
214 | aio_seek $fh,$offset,$whence, $callback->($offs) |
214 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
215 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
215 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
216 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
216 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
217 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
217 | aio_readahead $fh,$offset,$length, $callback->($retval) |
218 | aio_readahead $fh,$offset,$length, $callback->($retval) |
218 | aio_stat $fh_or_path, $callback->($status) |
219 | aio_stat $fh_or_path, $callback->($status) |
219 | aio_lstat $fh, $callback->($status) |
220 | aio_lstat $fh, $callback->($status) |
220 | aio_statvfs $fh_or_path, $callback->($statvfs) |
221 | aio_statvfs $fh_or_path, $callback->($statvfs) |
221 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
222 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
222 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
223 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
224 | aio_chmod $fh_or_path, $mode, $callback->($status) |
223 | aio_truncate $fh_or_path, $offset, $callback->($status) |
225 | aio_truncate $fh_or_path, $offset, $callback->($status) |
224 | aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
225 | aio_unlink $pathname, $callback->($status) |
226 | aio_unlink $pathname, $callback->($status) |
226 | aio_mknod $path, $mode, $dev, $callback->($status) |
227 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
227 | aio_link $srcpath, $dstpath, $callback->($status) |
228 | aio_link $srcpath, $dstpath, $callback->($status) |
228 | aio_symlink $srcpath, $dstpath, $callback->($status) |
229 | aio_symlink $srcpath, $dstpath, $callback->($status) |
229 | aio_readlink $path, $callback->($link) |
230 | aio_readlink $pathname, $callback->($link) |
230 | aio_realpath $path, $callback->($link) |
231 | aio_realpath $pathname, $callback->($link) |
231 | aio_rename $srcpath, $dstpath, $callback->($status) |
232 | aio_rename $srcpath, $dstpath, $callback->($status) |
232 | aio_mkdir $pathname, $mode, $callback->($status) |
233 | aio_mkdir $pathname, $mode, $callback->($status) |
233 | aio_rmdir $pathname, $callback->($status) |
234 | aio_rmdir $pathname, $callback->($status) |
234 | aio_readdir $pathname, $callback->($entries) |
235 | aio_readdir $pathname, $callback->($entries) |
235 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
236 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
236 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
237 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
237 | IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN |
238 | IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN |
|
|
239 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
238 | aio_load $path, $data, $callback->($status) |
240 | aio_load $pathname, $data, $callback->($status) |
239 | aio_copy $srcpath, $dstpath, $callback->($status) |
241 | aio_copy $srcpath, $dstpath, $callback->($status) |
240 | aio_move $srcpath, $dstpath, $callback->($status) |
242 | aio_move $srcpath, $dstpath, $callback->($status) |
241 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
|
|
242 | aio_rmtree $path, $callback->($status) |
243 | aio_rmtree $pathname, $callback->($status) |
243 | aio_sync $callback->($status) |
244 | aio_sync $callback->($status) |
244 | aio_syncfs $fh, $callback->($status) |
245 | aio_syncfs $fh, $callback->($status) |
245 | aio_fsync $fh, $callback->($status) |
246 | aio_fsync $fh, $callback->($status) |
246 | aio_fdatasync $fh, $callback->($status) |
247 | aio_fdatasync $fh, $callback->($status) |
247 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
248 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
248 | aio_pathsync $path, $callback->($status) |
249 | aio_pathsync $pathname, $callback->($status) |
249 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
250 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
250 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
251 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
251 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
252 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
252 | aio_mlockall $flags, $callback->($status) |
253 | aio_mlockall $flags, $callback->($status) |
253 | aio_group $callback->(...) |
254 | aio_group $callback->(...) |
… | |
… | |
271 | IO::AIO::nready |
272 | IO::AIO::nready |
272 | IO::AIO::npending |
273 | IO::AIO::npending |
273 | |
274 | |
274 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
275 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
275 | IO::AIO::fadvise $fh, $offset, $len, $advice |
276 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
277 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
|
|
278 | IO::AIO::munmap $scalar |
276 | IO::AIO::madvise $scalar, $offset, $length, $advice |
279 | IO::AIO::madvise $scalar, $offset, $length, $advice |
277 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
280 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
278 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
281 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
279 | IO::AIO::munlockall |
282 | IO::AIO::munlockall |
280 | |
283 | |
281 | =head2 AIO REQUEST FUNCTIONS |
284 | =head2 API NOTES |
282 | |
285 | |
283 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
286 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
284 | with the same name (sans C<aio_>). The arguments are similar or identical, |
287 | with the same name (sans C<aio_>). The arguments are similar or identical, |
285 | and they all accept an additional (and optional) C<$callback> argument |
288 | and they all accept an additional (and optional) C<$callback> argument |
286 | which must be a code reference. This code reference will get called with |
289 | which must be a code reference. This code reference will be called after |
287 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
290 | the syscall has been executed in an asynchronous fashion. The results |
288 | perl, which usually delivers "false") as its sole argument after the given |
291 | of the request will be passed as arguments to the callback (and, if an |
289 | syscall has been executed asynchronously. |
292 | error occured, in C<$!>) - for most requests the syscall return code (e.g. |
|
|
293 | most syscalls return C<-1> on error, unlike perl, which usually delivers |
|
|
294 | "false"). |
|
|
295 | |
|
|
296 | Some requests (such as C<aio_readdir>) pass the actual results and |
|
|
297 | communicate failures by passing C<undef>. |
290 | |
298 | |
291 | All functions expecting a filehandle keep a copy of the filehandle |
299 | All functions expecting a filehandle keep a copy of the filehandle |
292 | internally until the request has finished. |
300 | internally until the request has finished. |
293 | |
301 | |
294 | All functions return request objects of type L<IO::AIO::REQ> that allow |
302 | All functions return request objects of type L<IO::AIO::REQ> that allow |
295 | further manipulation of those requests while they are in-flight. |
303 | further manipulation of those requests while they are in-flight. |
296 | |
304 | |
297 | The pathnames you pass to these routines I<must> be absolute and |
305 | The pathnames you pass to these routines I<should> be absolute. The |
298 | encoded as octets. The reason for the former is that at the time the |
306 | reason for this is that at the time the request is being executed, the |
299 | request is being executed, the current working directory could have |
307 | current working directory could have changed. Alternatively, you can |
300 | changed. Alternatively, you can make sure that you never change the |
308 | make sure that you never change the current working directory anywhere |
301 | current working directory anywhere in the program and then use relative |
309 | in the program and then use relative paths. You can also take advantage |
302 | paths. |
310 | of IO::AIOs working directory abstraction, that lets you specify paths |
|
|
311 | relative to some previously-opened "working directory object" - see the |
|
|
312 | description of the C<IO::AIO::WD> class later in this document. |
303 | |
313 | |
304 | To encode pathnames as octets, either make sure you either: a) always pass |
314 | To encode pathnames as octets, either make sure you either: a) always pass |
305 | in filenames you got from outside (command line, readdir etc.) without |
315 | in filenames you got from outside (command line, readdir etc.) without |
306 | tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode |
316 | tinkering, b) are in your native filesystem encoding, c) use the Encode |
307 | your pathnames to the locale (or other) encoding in effect in the user |
317 | module and encode your pathnames to the locale (or other) encoding in |
308 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
318 | effect in the user environment, d) use Glib::filename_from_unicode on |
309 | use something else to ensure your scalar has the correct contents. |
319 | unicode filenames or e) use something else to ensure your scalar has the |
|
|
320 | correct contents. |
310 | |
321 | |
311 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
322 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
312 | handles correctly whether it is set or not. |
323 | handles correctly whether it is set or not. |
|
|
324 | |
|
|
325 | =head2 AIO REQUEST FUNCTIONS |
313 | |
326 | |
314 | =over 4 |
327 | =over 4 |
315 | |
328 | |
316 | =item $prev_pri = aioreq_pri [$pri] |
329 | =item $prev_pri = aioreq_pri [$pri] |
317 | |
330 | |
… | |
… | |
399 | |
412 | |
400 | Or in other words: the file descriptor will be closed, but it will not be |
413 | Or in other words: the file descriptor will be closed, but it will not be |
401 | free for reuse until the perl filehandle is closed. |
414 | free for reuse until the perl filehandle is closed. |
402 | |
415 | |
403 | =cut |
416 | =cut |
|
|
417 | |
|
|
418 | =item aio_seek $fh, $offset, $whence, $callback->($offs) |
|
|
419 | |
|
|
420 | Seeks the filehandle to the new C<$offset>, similarly to perl's |
|
|
421 | C<sysseek>. The C<$whence> can use the traditional values (C<0> for |
|
|
422 | C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for |
|
|
423 | C<IO::AIO::SEEK_END>). |
|
|
424 | |
|
|
425 | The resulting absolute offset will be passed to the callback, or C<-1> in |
|
|
426 | case of an error. |
|
|
427 | |
|
|
428 | In theory, the C<$whence> constants could be different than the |
|
|
429 | corresponding values from L<Fcntl>, but perl guarantees they are the same, |
|
|
430 | so don't panic. |
|
|
431 | |
|
|
432 | As a GNU/Linux (and maybe Solaris) extension, also the constants |
|
|
433 | C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they |
|
|
434 | could be found. No guarantees about suitability for use in C<aio_seek> or |
|
|
435 | Perl's C<sysseek> can be made though, although I would naively assume they |
|
|
436 | "just work". |
404 | |
437 | |
405 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
438 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
406 | |
439 | |
407 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
440 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
408 | |
441 | |
… | |
… | |
616 | |
649 | |
617 | Asynchronously unlink (delete) a file and call the callback with the |
650 | Asynchronously unlink (delete) a file and call the callback with the |
618 | result code. |
651 | result code. |
619 | |
652 | |
620 | |
653 | |
621 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
654 | =item aio_mknod $pathname, $mode, $dev, $callback->($status) |
622 | |
655 | |
623 | [EXPERIMENTAL] |
656 | [EXPERIMENTAL] |
624 | |
657 | |
625 | Asynchronously create a device node (or fifo). See mknod(2). |
658 | Asynchronously create a device node (or fifo). See mknod(2). |
626 | |
659 | |
627 | The only (POSIX-) portable way of calling this function is: |
660 | The only (POSIX-) portable way of calling this function is: |
628 | |
661 | |
629 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
662 | aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
630 | |
663 | |
631 | See C<aio_stat> for info about some potentially helpful extra constants |
664 | See C<aio_stat> for info about some potentially helpful extra constants |
632 | and functions. |
665 | and functions. |
633 | |
666 | |
634 | =item aio_link $srcpath, $dstpath, $callback->($status) |
667 | =item aio_link $srcpath, $dstpath, $callback->($status) |
… | |
… | |
641 | |
674 | |
642 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
675 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
643 | the path C<$dstpath> and call the callback with the result code. |
676 | the path C<$dstpath> and call the callback with the result code. |
644 | |
677 | |
645 | |
678 | |
646 | =item aio_readlink $path, $callback->($link) |
679 | =item aio_readlink $pathname, $callback->($link) |
647 | |
680 | |
648 | Asynchronously read the symlink specified by C<$path> and pass it to |
681 | Asynchronously read the symlink specified by C<$path> and pass it to |
649 | the callback. If an error occurs, nothing or undef gets passed to the |
682 | the callback. If an error occurs, nothing or undef gets passed to the |
650 | callback. |
683 | callback. |
651 | |
684 | |
652 | |
685 | |
653 | =item aio_realpath $path, $callback->($path) |
686 | =item aio_realpath $pathname, $callback->($path) |
654 | |
687 | |
655 | Asynchronously make the path absolute and resolve any symlinks in |
688 | Asynchronously make the path absolute and resolve any symlinks in |
656 | C<$path>. The resulting path only consists of directories (Same as |
689 | C<$path>. The resulting path only consists of directories (Same as |
657 | L<Cwd::realpath>). |
690 | L<Cwd::realpath>). |
658 | |
691 | |
… | |
… | |
753 | C<$type>'s are known, which can be used to speed up some algorithms. |
786 | C<$type>'s are known, which can be used to speed up some algorithms. |
754 | |
787 | |
755 | =back |
788 | =back |
756 | |
789 | |
757 | |
790 | |
758 | =item aio_load $path, $data, $callback->($status) |
791 | =item aio_load $pathname, $data, $callback->($status) |
759 | |
792 | |
760 | This is a composite request that tries to fully load the given file into |
793 | This is a composite request that tries to fully load the given file into |
761 | memory. Status is the same as with aio_read. |
794 | memory. Status is the same as with aio_read. |
762 | |
795 | |
763 | =cut |
796 | =cut |
… | |
… | |
898 | }; |
931 | }; |
899 | |
932 | |
900 | $grp |
933 | $grp |
901 | } |
934 | } |
902 | |
935 | |
903 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
936 | =item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
904 | |
937 | |
905 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
938 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
906 | efficiently separate the entries of directory C<$path> into two sets of |
939 | efficiently separate the entries of directory C<$path> into two sets of |
907 | names, directories you can recurse into (directories), and ones you cannot |
940 | names, directories you can recurse into (directories), and ones you cannot |
908 | recurse into (everything else, including symlinks to directories). |
941 | recurse into (everything else, including symlinks to directories). |
… | |
… | |
965 | |
998 | |
966 | my $grp = aio_group $cb; |
999 | my $grp = aio_group $cb; |
967 | |
1000 | |
968 | $maxreq = 4 if $maxreq <= 0; |
1001 | $maxreq = 4 if $maxreq <= 0; |
969 | |
1002 | |
970 | # stat once |
1003 | # get a wd object |
971 | aioreq_pri $pri; |
1004 | aioreq_pri $pri; |
972 | add $grp aio_stat $path, sub { |
1005 | add $grp aio_wd $path, sub { |
|
|
1006 | $_[0] |
973 | return $grp->result () if $_[0]; |
1007 | or return $grp->result (); |
974 | my $now = time; |
|
|
975 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
976 | |
1008 | |
977 | # read the directory entries |
1009 | my $wd = [shift, "."]; |
|
|
1010 | |
|
|
1011 | # stat once |
978 | aioreq_pri $pri; |
1012 | aioreq_pri $pri; |
979 | add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { |
1013 | add $grp aio_stat $wd, sub { |
980 | my $entries = shift |
|
|
981 | or return $grp->result (); |
1014 | return $grp->result () if $_[0]; |
|
|
1015 | my $now = time; |
|
|
1016 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
982 | |
1017 | |
983 | # stat the dir another time |
1018 | # read the directory entries |
984 | aioreq_pri $pri; |
1019 | aioreq_pri $pri; |
|
|
1020 | add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub { |
|
|
1021 | my $entries = shift |
|
|
1022 | or return $grp->result (); |
|
|
1023 | |
|
|
1024 | # stat the dir another time |
|
|
1025 | aioreq_pri $pri; |
985 | add $grp aio_stat $path, sub { |
1026 | add $grp aio_stat $wd, sub { |
986 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
1027 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
987 | |
1028 | |
988 | my $ndirs; |
1029 | my $ndirs; |
989 | |
1030 | |
990 | # take the slow route if anything looks fishy |
1031 | # take the slow route if anything looks fishy |
991 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
1032 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
992 | $ndirs = -1; |
1033 | $ndirs = -1; |
993 | } else { |
1034 | } else { |
994 | # if nlink == 2, we are finished |
1035 | # if nlink == 2, we are finished |
995 | # for non-posix-fs's, we rely on nlink < 2 |
1036 | # for non-posix-fs's, we rely on nlink < 2 |
996 | $ndirs = (stat _)[3] - 2 |
1037 | $ndirs = (stat _)[3] - 2 |
997 | or return $grp->result ([], $entries); |
1038 | or return $grp->result ([], $entries); |
998 | } |
1039 | } |
999 | |
1040 | |
1000 | my (@dirs, @nondirs); |
1041 | my (@dirs, @nondirs); |
1001 | |
1042 | |
1002 | my $statgrp = add $grp aio_group sub { |
1043 | my $statgrp = add $grp aio_group sub { |
1003 | $grp->result (\@dirs, \@nondirs); |
1044 | $grp->result (\@dirs, \@nondirs); |
1004 | }; |
1045 | }; |
1005 | |
1046 | |
1006 | limit $statgrp $maxreq; |
1047 | limit $statgrp $maxreq; |
1007 | feed $statgrp sub { |
1048 | feed $statgrp sub { |
1008 | return unless @$entries; |
1049 | return unless @$entries; |
1009 | my $entry = shift @$entries; |
1050 | my $entry = shift @$entries; |
1010 | |
1051 | |
1011 | aioreq_pri $pri; |
1052 | aioreq_pri $pri; |
|
|
1053 | $wd->[1] = "$entry/."; |
1012 | add $statgrp aio_stat "$path/$entry/.", sub { |
1054 | add $statgrp aio_stat $wd, sub { |
1013 | if ($_[0] < 0) { |
1055 | if ($_[0] < 0) { |
1014 | push @nondirs, $entry; |
1056 | push @nondirs, $entry; |
1015 | } else { |
1057 | } else { |
1016 | # need to check for real directory |
1058 | # need to check for real directory |
1017 | aioreq_pri $pri; |
1059 | aioreq_pri $pri; |
|
|
1060 | $wd->[1] = $entry; |
1018 | add $statgrp aio_lstat "$path/$entry", sub { |
1061 | add $statgrp aio_lstat $wd, sub { |
1019 | if (-d _) { |
1062 | if (-d _) { |
1020 | push @dirs, $entry; |
1063 | push @dirs, $entry; |
1021 | |
1064 | |
1022 | unless (--$ndirs) { |
1065 | unless (--$ndirs) { |
1023 | push @nondirs, @$entries; |
1066 | push @nondirs, @$entries; |
1024 | feed $statgrp; |
1067 | feed $statgrp; |
|
|
1068 | } |
|
|
1069 | } else { |
|
|
1070 | push @nondirs, $entry; |
1025 | } |
1071 | } |
1026 | } else { |
|
|
1027 | push @nondirs, $entry; |
|
|
1028 | } |
1072 | } |
1029 | } |
1073 | } |
1030 | } |
1074 | }; |
1031 | }; |
1075 | }; |
1032 | }; |
1076 | }; |
1033 | }; |
1077 | }; |
1034 | }; |
1078 | }; |
1035 | }; |
1079 | }; |
1036 | |
1080 | |
1037 | $grp |
1081 | $grp |
1038 | } |
1082 | } |
1039 | |
1083 | |
1040 | =item aio_rmtree $path, $callback->($status) |
1084 | =item aio_rmtree $pathname, $callback->($status) |
1041 | |
1085 | |
1042 | Delete a directory tree starting (and including) C<$path>, return the |
1086 | Delete a directory tree starting (and including) C<$path>, return the |
1043 | status of the final C<rmdir> only. This is a composite request that |
1087 | status of the final C<rmdir> only. This is a composite request that |
1044 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
1088 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
1045 | everything else. |
1089 | everything else. |
… | |
… | |
1106 | C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, |
1150 | C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, |
1107 | C<IO::AIO::SYNC_FILE_RANGE_WRITE> and |
1151 | C<IO::AIO::SYNC_FILE_RANGE_WRITE> and |
1108 | C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range |
1152 | C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range |
1109 | manpage for details. |
1153 | manpage for details. |
1110 | |
1154 | |
1111 | =item aio_pathsync $path, $callback->($status) |
1155 | =item aio_pathsync $pathname, $callback->($status) |
1112 | |
1156 | |
1113 | This request tries to open, fsync and close the given path. This is a |
1157 | This request tries to open, fsync and close the given path. This is a |
1114 | composite request intended to sync directories after directory operations |
1158 | composite request intended to sync directories after directory operations |
1115 | (E.g. rename). This might not work on all operating systems or have any |
1159 | (E.g. rename). This might not work on all operating systems or have any |
1116 | specific effect, but usually it makes sure that directory changes get |
1160 | specific effect, but usually it makes sure that directory changes get |
… | |
… | |
1213 | |
1257 | |
1214 | Example: asynchronously lock all current and future pages into memory. |
1258 | Example: asynchronously lock all current and future pages into memory. |
1215 | |
1259 | |
1216 | aio_mlockall IO::AIO::MCL_FUTURE; |
1260 | aio_mlockall IO::AIO::MCL_FUTURE; |
1217 | |
1261 | |
|
|
1262 | =item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) |
|
|
1263 | |
|
|
1264 | Queries the extents of the given file (by calling the Linux FIEMAP ioctl, |
|
|
1265 | see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the |
|
|
1266 | C<ioctl> is not available on your OS, then this rquiest will fail with |
|
|
1267 | C<ENOSYS>. |
|
|
1268 | |
|
|
1269 | C<$start> is the starting offset to query extents for, C<$length> is the |
|
|
1270 | size of the range to query - if it is C<undef>, then the whole file will |
|
|
1271 | be queried. |
|
|
1272 | |
|
|
1273 | C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or |
|
|
1274 | C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also |
|
|
1275 | exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query |
|
|
1276 | the data portion. |
|
|
1277 | |
|
|
1278 | C<$count> is the maximum number of extent records to return. If it is |
|
|
1279 | C<undef>, then IO::AIO queries all extents of the file. As a very special |
|
|
1280 | case, if it is C<0>, then the callback receives the number of extents |
|
|
1281 | instead of the extents themselves. |
|
|
1282 | |
|
|
1283 | If an error occurs, the callback receives no arguments. The special |
|
|
1284 | C<errno> value C<IO::AIO::EBADR> is available to test for flag errors. |
|
|
1285 | |
|
|
1286 | Otherwise, the callback receives an array reference with extent |
|
|
1287 | structures. Each extent structure is an array reference itself, with the |
|
|
1288 | following members: |
|
|
1289 | |
|
|
1290 | [$logical, $physical, $length, $flags] |
|
|
1291 | |
|
|
1292 | Flags is any combination of the following flag values (typically either C<0> |
|
|
1293 | or C<IO::AIO::FIEMAP_EXTENT_LAST>): |
|
|
1294 | |
|
|
1295 | C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>, |
|
|
1296 | C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>, |
|
|
1297 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
|
|
1298 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
|
|
1299 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
|
|
1300 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
|
|
1301 | |
1218 | =item aio_group $callback->(...) |
1302 | =item aio_group $callback->(...) |
1219 | |
1303 | |
1220 | This is a very special aio request: Instead of doing something, it is a |
1304 | This is a very special aio request: Instead of doing something, it is a |
1221 | container for other aio requests, which is useful if you want to bundle |
1305 | container for other aio requests, which is useful if you want to bundle |
1222 | many requests into a single, composite, request with a definite callback |
1306 | many requests into a single, composite, request with a definite callback |
… | |
… | |
1258 | like sleep and file handle readable/writable, the overhead this creates is |
1342 | like sleep and file handle readable/writable, the overhead this creates is |
1259 | immense (it blocks a thread for a long time) so do not use this function |
1343 | immense (it blocks a thread for a long time) so do not use this function |
1260 | except to put your application under artificial I/O pressure. |
1344 | except to put your application under artificial I/O pressure. |
1261 | |
1345 | |
1262 | =back |
1346 | =back |
|
|
1347 | |
|
|
1348 | |
|
|
1349 | =head2 IO::AIO::WD - multiple working directories |
|
|
1350 | |
|
|
1351 | Your process only has one current working directory, which is used by all |
|
|
1352 | threads. This makes it hard to use relative paths (some other component |
|
|
1353 | could call C<chdir> at any time, and it is hard to control when the path |
|
|
1354 | will be used by IO::AIO). |
|
|
1355 | |
|
|
1356 | One solution for this is to always use absolute paths. This usually works, |
|
|
1357 | but can be quite slow (the kernel has to walk the whole path on every |
|
|
1358 | access), and can also be a hassle to implement. |
|
|
1359 | |
|
|
1360 | Newer POSIX systems have a number of functions (openat, fdopendir, |
|
|
1361 | futimensat and so on) that make it possible to specify working directories |
|
|
1362 | per operation. |
|
|
1363 | |
|
|
1364 | For portability, and because the clowns who "designed", or shall I write, |
|
|
1365 | perpetrated this new interface were obviously half-drunk, this abstraction |
|
|
1366 | cannot be perfect, though. |
|
|
1367 | |
|
|
1368 | IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD |
|
|
1369 | object. This object stores the canonicalised, absolute version of the |
|
|
1370 | path, and on systems that allow it, also a directory file descriptor. |
|
|
1371 | |
|
|
1372 | Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat> |
|
|
1373 | or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD |
|
|
1374 | object and a pathname instead (or the IO::AIO::WD object alone, which |
|
|
1375 | gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the |
|
|
1376 | IO::AIO::WD object is ignored, otherwise the pathname is resolved relative |
|
|
1377 | to that IO::AIO::WD object. |
|
|
1378 | |
|
|
1379 | For example, to get a wd object for F</etc> and then stat F<passwd> |
|
|
1380 | inside, you would write: |
|
|
1381 | |
|
|
1382 | aio_wd "/etc", sub { |
|
|
1383 | my $etcdir = shift; |
|
|
1384 | |
|
|
1385 | # although $etcdir can be undef on error, there is generally no reason |
|
|
1386 | # to check for errors here, as aio_stat will fail with ENOENT |
|
|
1387 | # when $etcdir is undef. |
|
|
1388 | |
|
|
1389 | aio_stat [$etcdir, "passwd"], sub { |
|
|
1390 | # yay |
|
|
1391 | }; |
|
|
1392 | }; |
|
|
1393 | |
|
|
1394 | That C<aio_wd> is a request and not a normal function shows that creating |
|
|
1395 | an IO::AIO::WD object is itself a potentially blocking operation, which is |
|
|
1396 | why it is done asynchronously. |
|
|
1397 | |
|
|
1398 | To stat the directory obtained with C<aio_wd> above, one could write |
|
|
1399 | either of the following three request calls: |
|
|
1400 | |
|
|
1401 | aio_lstat "/etc" , sub { ... # pathname as normal string |
|
|
1402 | aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself) |
|
|
1403 | aio_lstat $wd , sub { ... # shorthand for the previous |
|
|
1404 | |
|
|
1405 | As with normal pathnames, IO::AIO keeps a copy of the working directory |
|
|
1406 | object and the pathname string, so you could write the following without |
|
|
1407 | causing any issues due to C<$path> getting reused: |
|
|
1408 | |
|
|
1409 | my $path = [$wd, undef]; |
|
|
1410 | |
|
|
1411 | for my $name (qw(abc def ghi)) { |
|
|
1412 | $path->[1] = $name; |
|
|
1413 | aio_stat $path, sub { |
|
|
1414 | # ... |
|
|
1415 | }; |
|
|
1416 | } |
|
|
1417 | |
|
|
1418 | There are some caveats: when directories get renamed (or deleted), the |
|
|
1419 | pathname string doesn't change, so will point to the new directory (or |
|
|
1420 | nowhere at all), while the directory fd, if available on the system, |
|
|
1421 | will still point to the original directory. Most functions accepting a |
|
|
1422 | pathname will use the directory fd on newer systems, and the string on |
|
|
1423 | older systems. Some functions (such as realpath) will always rely on the |
|
|
1424 | string form of the pathname. |
|
|
1425 | |
|
|
1426 | So this fucntionality is mainly useful to get some protection against |
|
|
1427 | C<chdir>, to easily get an absolute path out of a relative path for future |
|
|
1428 | reference, and to speed up doing many operations in the same directory |
|
|
1429 | (e.g. when stat'ing all files in a directory). |
|
|
1430 | |
|
|
1431 | The following functions implement this working directory abstraction: |
|
|
1432 | |
|
|
1433 | =over 4 |
|
|
1434 | |
|
|
1435 | =item aio_wd $pathname, $callback->($wd) |
|
|
1436 | |
|
|
1437 | Asynchonously canonicalise the given pathname and convert it to an |
|
|
1438 | IO::AIO::WD object representing it. If possible and supported on the |
|
|
1439 | system, also open a directory fd to speed up pathname resolution relative |
|
|
1440 | to this working directory. |
|
|
1441 | |
|
|
1442 | If something goes wrong, then C<undef> is passwd to the callback instead |
|
|
1443 | of a working directory object and C<$!> is set appropriately. Since |
|
|
1444 | passing C<undef> as working directory component of a pathname fails the |
|
|
1445 | request with C<ENOENT>, there is often no need for error checking in the |
|
|
1446 | C<aio_wd> callback, as future requests using the value will fail in the |
|
|
1447 | expected way. |
|
|
1448 | |
|
|
1449 | If this call isn't available because your OS lacks it or it couldn't be |
|
|
1450 | detected, it will be emulated by calling C<fsync> instead. |
|
|
1451 | |
|
|
1452 | =item IO::AIO::CWD |
|
|
1453 | |
|
|
1454 | This is a compiletime constant (object) that represents the process |
|
|
1455 | current working directory. |
|
|
1456 | |
|
|
1457 | Specifying this object as working directory object for a pathname is as |
|
|
1458 | if the pathname would be specified directly, without a directory object, |
|
|
1459 | e.g., these calls are functionally identical: |
|
|
1460 | |
|
|
1461 | aio_stat "somefile", sub { ... }; |
|
|
1462 | aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; |
|
|
1463 | |
|
|
1464 | =back |
|
|
1465 | |
1263 | |
1466 | |
1264 | =head2 IO::AIO::REQ CLASS |
1467 | =head2 IO::AIO::REQ CLASS |
1265 | |
1468 | |
1266 | All non-aggregate C<aio_*> functions return an object of this class when |
1469 | All non-aggregate C<aio_*> functions return an object of this class when |
1267 | called in non-void context. |
1470 | called in non-void context. |
… | |
… | |
1385 | |
1588 | |
1386 | Sets a feeder/generator on this group: every group can have an attached |
1589 | Sets a feeder/generator on this group: every group can have an attached |
1387 | generator that generates requests if idle. The idea behind this is that, |
1590 | generator that generates requests if idle. The idea behind this is that, |
1388 | although you could just queue as many requests as you want in a group, |
1591 | although you could just queue as many requests as you want in a group, |
1389 | this might starve other requests for a potentially long time. For example, |
1592 | this might starve other requests for a potentially long time. For example, |
1390 | C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, |
1593 | C<aio_scandir> might generate hundreds of thousands of C<aio_stat> |
1391 | delaying any later requests for a long time. |
1594 | requests, delaying any later requests for a long time. |
1392 | |
1595 | |
1393 | To avoid this, and allow incremental generation of requests, you can |
1596 | To avoid this, and allow incremental generation of requests, you can |
1394 | instead a group and set a feeder on it that generates those requests. The |
1597 | instead a group and set a feeder on it that generates those requests. The |
1395 | feed callback will be called whenever there are few enough (see C<limit>, |
1598 | feed callback will be called whenever there are few enough (see C<limit>, |
1396 | below) requests active in the group itself and is expected to queue more |
1599 | below) requests active in the group itself and is expected to queue more |
… | |
… | |
1705 | ENOSYS, otherwise the return value of C<mprotect>. |
1908 | ENOSYS, otherwise the return value of C<mprotect>. |
1706 | |
1909 | |
1707 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
1910 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
1708 | |
1911 | |
1709 | Memory-maps a file (or anonymous memory range) and attaches it to the |
1912 | Memory-maps a file (or anonymous memory range) and attaches it to the |
1710 | given C<$scalar>, which will act like a string scalar. |
1913 | given C<$scalar>, which will act like a string scalar. Returns true on |
|
|
1914 | success, and false otherwise. |
1711 | |
1915 | |
1712 | The only operations allowed on the scalar are C<substr>/C<vec> that don't |
1916 | The only operations allowed on the scalar are C<substr>/C<vec> that don't |
1713 | change the string length, and most read-only operations such as copying it |
1917 | change the string length, and most read-only operations such as copying it |
1714 | or searching it with regexes and so on. |
1918 | or searching it with regexes and so on. |
1715 | |
1919 | |
… | |
… | |
1768 | Calls the C<munlockall> function. |
1972 | Calls the C<munlockall> function. |
1769 | |
1973 | |
1770 | On systems that do not implement C<munlockall>, this function returns |
1974 | On systems that do not implement C<munlockall>, this function returns |
1771 | ENOSYS, otherwise the return value of C<munlockall>. |
1975 | ENOSYS, otherwise the return value of C<munlockall>. |
1772 | |
1976 | |
|
|
1977 | =item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
|
|
1978 | |
|
|
1979 | Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or |
|
|
1980 | C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they |
|
|
1981 | should be the file offset. |
|
|
1982 | |
|
|
1983 | C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might |
|
|
1984 | silently corrupt the data in this case. |
|
|
1985 | |
|
|
1986 | The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>, |
|
|
1987 | C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and |
|
|
1988 | C<IO::AIO::SPLICE_F_GIFT>. |
|
|
1989 | |
|
|
1990 | See the C<splice(2)> manpage for details. |
|
|
1991 | |
|
|
1992 | =item IO::AIO::tee $r_fh, $w_fh, $length, $flags |
|
|
1993 | |
|
|
1994 | Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the |
|
|
1995 | description for C<IO::AIO::splice> above for details. |
|
|
1996 | |
1773 | =back |
1997 | =back |
1774 | |
1998 | |
1775 | =cut |
1999 | =cut |
1776 | |
2000 | |
1777 | min_parallel 8; |
2001 | min_parallel 8; |