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.148 by root, Sat Jun 6 17:25:13 2009 UTC vs.
Revision 1.155 by root, Sun Jun 14 20:36:59 2009 UTC

193use strict 'vars'; 193use strict 'vars';
194 194
195use base 'Exporter'; 195use base 'Exporter';
196 196
197BEGIN { 197BEGIN {
198 our $VERSION = '3.19'; 198 our $VERSION = '3.23';
199 199
200 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close 200 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx 201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
202 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync 202 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
203 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead 203 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
548The flags are a combination of the following constants, ORed together (the 548The flags are a combination of the following constants, ORed together (the
549flags will also be passed to the callback, possibly modified): 549flags will also be passed to the callback, possibly modified):
550 550
551=over 4 551=over 4
552 552
553=item AIO::READDIR_DENTS 553=item IO::AIO::READDIR_DENTS
554 554
555When this flag is off, then the callback gets an arrayref with of names 555When this flag is off, then the callback gets an arrayref with of names
556only (as with C<aio_readdir>), otherwise it gets an arrayref with 556only (as with C<aio_readdir>), otherwise it gets an arrayref with
557C<[$name, $inode, $type]> arrayrefs, each describing a single directory 557C<[$name, $type, $inode]> arrayrefs, each describing a single directory
558entry in more detail. 558entry in more detail.
559 559
560C<$name> is the name of the entry. 560C<$name> is the name of the entry.
561 561
562C<$inode> is the inode number (which might not be exact on systems with 64
563bit inode numbers and 32 bit perls). On systems that do not deliver the
564inode information, this will always be zero.
565
566C<$type> is one of the C<AIO::DT_xxx> constants: 562C<$type> is one of the C<IO::AIO::DT_xxx> constants:
567 563
568C<AIO::DT_UNKNOWN>, C<AIO::DT_FIFO>, C<AIO::DT_CHR>, C<AIO::DT_DIR>, 564C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
569C<AIO::DT_BLK>, C<AIO::DT_REG>, C<AIO::DT_LNK>, C<AIO::DT_SOCK>, 565C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
570C<AIO::DT_WHT>. 566C<IO::AIO::DT_WHT>.
571 567
572C<AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to 568C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to
573know, you have to run stat yourself. Also, for speed reasons, the C<$type> 569know, you have to run stat yourself. Also, for speed reasons, the C<$type>
574scalars are read-only: you can not modify them. 570scalars are read-only: you can not modify them.
575 571
572C<$inode> is the inode number (which might not be exact on systems with 64
573bit inode numbers and 32 bit perls). This field has unspecified content on
574systems that do not deliver the inode information.
575
576=item AIO::READDIR_DIRS_FIRST 576=item IO::AIO::READDIR_DIRS_FIRST
577 577
578When this flag is set, then the names will be returned in an order where 578When this flag is set, then the names will be returned in an order where
579likely directories come first. This is useful when you need to quickly 579likely directories come first. This is useful when you need to quickly
580find directories, or you want to find all directories while avoiding to 580find directories, or you want to find all directories while avoiding to
581stat() each entry. 581stat() each entry.
582 582
583If the system returns type information in readdir, then this is used
584to find directories directly. Otherwise, likely directories are files
585beginning with ".", or otherwise files with no dots, of which files with
586short names are tried first.
587
583=item AIO::READDIR_STAT_ORDER 588=item IO::AIO::READDIR_STAT_ORDER
584 589
585When this flag is set, then the names will be returned in an order 590When this flag is set, then the names will be returned in an order
586suitable for stat()'ing each one. That is, when you plan to stat() 591suitable for stat()'ing each one. That is, when you plan to stat()
587all files in the given directory, then the returned order will likely 592all files in the given directory, then the returned order will likely
588be fastest. 593be fastest.
589 594
590If both this flag and IO::READDIR_DIRS_FIRST are specified, then the 595If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then
591likely dirs come first, resulting in a less optimal stat order. 596the likely dirs come first, resulting in a less optimal stat order.
592 597
593=item AIO::READDIR_FOUND_UNKNOWN 598=item IO::AIO::READDIR_FOUND_UNKNOWN
594 599
595This flag should not be set when calling C<aio_readdirx>. Instead, it 600This flag should not be set when calling C<aio_readdirx>. Instead, it
596is being set by C<aio_readdirx>, when any of the C<$type>'s found were 601is being set by C<aio_readdirx>, when any of the C<$type>'s found were
597C<AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all 602C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all
598C<$type>'s are known, which can be used to speed up some algorithms. 603C<$type>'s are known, which can be used to speed up some algorithms.
599 604
600=back 605=back
601 606
602 607
770 775
771Implementation notes. 776Implementation notes.
772 777
773The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. 778The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
774 779
780If readdir returns file type information, then this is used directly to
781find directories.
782
775After reading the directory, the modification time, size etc. of the 783Otherwise, after reading the directory, the modification time, size etc.
776directory before and after the readdir is checked, and if they match (and 784of the directory before and after the readdir is checked, and if they
777isn't the current time), the link count will be used to decide how many 785match (and isn't the current time), the link count will be used to decide
778entries are directories (if >= 2). Otherwise, no knowledge of the number 786how many entries are directories (if >= 2). Otherwise, no knowledge of the
779of subdirectories will be assumed. 787number of subdirectories will be assumed.
780 788
781Then entries will be sorted into likely directories (everything without 789Then entries will be sorted into likely directories a non-initial dot
782a non-initial dot currently) and likely non-directories (everything 790currently) and likely non-directories (see C<aio_readdirx>). Then every
783else). Then every entry plus an appended C</.> will be C<stat>'ed, 791entry plus an appended C</.> will be C<stat>'ed, likely directories first,
784likely directories first. If that succeeds, it assumes that the entry 792in order of their inode numbers. If that succeeds, it assumes that the
785is a directory or a symlink to directory (which will be checked 793entry is a directory or a symlink to directory (which will be checked
786seperately). This is often faster than stat'ing the entry itself because 794seperately). This is often faster than stat'ing the entry itself because
787filesystems might detect the type of the entry without reading the inode 795filesystems might detect the type of the entry without reading the inode
788data (e.g. ext2fs filetype feature). 796data (e.g. ext2fs filetype feature), even on systems that cannot return
797the filetype information on readdir.
789 798
790If the known number of directories (link count - 2) has been reached, the 799If the known number of directories (link count - 2) has been reached, the
791rest of the entries is assumed to be non-directories. 800rest of the entries is assumed to be non-directories.
792 801
793This only works with certainty on POSIX (= UNIX) filesystems, which 802This only works with certainty on POSIX (= UNIX) filesystems, which
831 # take the slow route if anything looks fishy 840 # take the slow route if anything looks fishy
832 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 841 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
833 $ndirs = -1; 842 $ndirs = -1;
834 } else { 843 } else {
835 # if nlink == 2, we are finished 844 # if nlink == 2, we are finished
836 # on non-posix-fs's, we rely on nlink < 2 845 # for non-posix-fs's, we rely on nlink < 2
837 $ndirs = (stat _)[3] - 2 846 $ndirs = (stat _)[3] - 2
838 or return $grp->result ([], $entries); 847 or return $grp->result ([], $entries);
839 } 848 }
840 849
841 # sort into likely dirs and likely nondirs
842 # dirs == files without ".", short entries first
843 $entries = [map $_->[0],
844 sort { $b->[1] cmp $a->[1] }
845 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
846 @$entries];
847
848 my (@dirs, @nondirs); 850 my (@dirs, @nondirs);
849 851
850 my $statgrp = add $grp aio_group sub { 852 my $statgrp = add $grp aio_group sub {
851 $grp->result (\@dirs, \@nondirs); 853 $grp->result (\@dirs, \@nondirs);
852 }; 854 };
853 855
854 limit $statgrp $maxreq; 856 limit $statgrp $maxreq;
855 feed $statgrp sub { 857 feed $statgrp sub {
856 return unless @$entries; 858 return unless @$entries;
857 my $entry = pop @$entries; 859 my $entry = shift @$entries;
858 860
859 aioreq_pri $pri; 861 aioreq_pri $pri;
860 add $statgrp aio_stat "$path/$entry/.", sub { 862 add $statgrp aio_stat "$path/$entry/.", sub {
861 if ($_[0] < 0) { 863 if ($_[0] < 0) {
862 push @nondirs, $entry; 864 push @nondirs, $entry;
1043=item cancel $req 1045=item cancel $req
1044 1046
1045Cancels the request, if possible. Has the effect of skipping execution 1047Cancels the request, if possible. Has the effect of skipping execution
1046when entering the B<execute> state and skipping calling the callback when 1048when entering the B<execute> state and skipping calling the callback when
1047entering the the B<result> state, but will leave the request otherwise 1049entering the the B<result> state, but will leave the request otherwise
1048untouched. That means that requests that currently execute will not be 1050untouched (with the exception of readdir). That means that requests that
1049stopped and resources held by the request will not be freed prematurely. 1051currently execute will not be stopped and resources held by the request
1052will not be freed prematurely.
1050 1053
1051=item cb $req $callback->(...) 1054=item cb $req $callback->(...)
1052 1055
1053Replace (or simply set) the callback registered to the request. 1056Replace (or simply set) the callback registered to the request.
1054 1057

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines