ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/AIO.pm
(Generate patch)

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.208 by root, Mon Sep 26 20:19:08 2011 UTC vs.
Revision 1.225 by root, Tue Apr 10 05:01:33 2012 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines