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.136 by root, Tue Sep 30 14:07:59 2008 UTC vs.
Revision 1.147 by root, Wed Jun 3 12:24:49 2009 UTC

193use strict 'vars'; 193use strict 'vars';
194 194
195use base 'Exporter'; 195use base 'Exporter';
196 196
197BEGIN { 197BEGIN {
198 our $VERSION = '3.1'; 198 our $VERSION = '3.19';
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 201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
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_pathsync aio_readahead 203 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
204 aio_rename aio_link aio_move aio_copy aio_group 204 aio_rename aio_link aio_move aio_copy aio_group
205 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 205 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
206 aio_chmod aio_utime aio_truncate); 206 aio_chmod aio_utime aio_truncate);
207 207
208 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 208 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
209 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 209 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
210 min_parallel max_parallel max_idle 210 min_parallel max_parallel max_idle
211 nreqs nready npending nthreads 211 nreqs nready npending nthreads
212 max_poll_time max_poll_reqs); 212 max_poll_time max_poll_reqs);
213
214 push @AIO_REQ, qw(aio_busy); # not exported
213 215
214 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 216 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
215 217
216 require XSLoader; 218 require XSLoader;
217 XSLoader::load ("IO::AIO", $VERSION); 219 XSLoader::load ("IO::AIO", $VERSION);
336 338
337=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
338 340
339=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 341=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
340 342
341Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> 343Reads or writes C<$length> bytes from or to the specified C<$fh> and
342into the scalar given by C<$data> and offset C<$dataoffset> and calls the 344C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
343callback without the actual number of bytes read (or -1 on error, just 345and calls the callback without the actual number of bytes read (or -1 on
344like the syscall). 346error, just like the syscall).
347
348C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
349offset plus the actual number of bytes read.
345 350
346If C<$offset> is undefined, then the current file descriptor offset will 351If C<$offset> is undefined, then the current file descriptor offset will
347be used (and updated), otherwise the file descriptor offset will not be 352be used (and updated), otherwise the file descriptor offset will not be
348changed by these calls. 353changed by these calls.
349 354
350If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. 355If C<$length> is undefined in C<aio_write>, use the remaining length of
356C<$data>.
351 357
352If C<$dataoffset> is less than zero, it will be counted from the end of 358If C<$dataoffset> is less than zero, it will be counted from the end of
353C<$data>. 359C<$data>.
354 360
355The C<$data> scalar I<MUST NOT> be modified in any way while the request 361The C<$data> scalar I<MUST NOT> be modified in any way while the request
585 my $grp = aio_group $cb; 591 my $grp = aio_group $cb;
586 592
587 aioreq_pri $pri; 593 aioreq_pri $pri;
588 add $grp aio_open $src, O_RDONLY, 0, sub { 594 add $grp aio_open $src, O_RDONLY, 0, sub {
589 if (my $src_fh = $_[0]) { 595 if (my $src_fh = $_[0]) {
590 my @stat = stat $src_fh; 596 my @stat = stat $src_fh; # hmm, might bock over nfs?
591 597
592 aioreq_pri $pri; 598 aioreq_pri $pri;
593 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 599 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
594 if (my $dst_fh = $_[0]) { 600 if (my $dst_fh = $_[0]) {
595 aioreq_pri $pri; 601 aioreq_pri $pri;
596 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 602 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
597 if ($_[0] == $stat[7]) { 603 if ($_[0] == $stat[7]) {
598 $grp->result (0); 604 $grp->result (0);
599 close $src_fh; 605 close $src_fh;
600 606
601 # those should not normally block. should. should. 607 my $ch = sub {
602 utime $stat[8], $stat[9], $dst; 608 aioreq_pri $pri;
603 chmod $stat[2] & 07777, $dst_fh; 609 add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
604 chown $stat[4], $stat[5], $dst_fh; 610 aioreq_pri $pri;
611 add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
612 aioreq_pri $pri;
613 add $grp aio_close $dst_fh;
614 }
615 };
616 };
605 617
606 aioreq_pri $pri; 618 aioreq_pri $pri;
607 add $grp aio_close $dst_fh; 619 add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
620 if ($_[0] < 0 && $! == ENOSYS) {
621 aioreq_pri $pri;
622 add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
623 } else {
624 $ch->();
625 }
626 };
608 } else { 627 } else {
609 $grp->result (-1); 628 $grp->result (-1);
610 close $src_fh; 629 close $src_fh;
611 close $dst_fh; 630 close $dst_fh;
612 631
631 650
632Try to move the I<file> (directories not supported as either source or 651Try to move the I<file> (directories not supported as either source or
633destination) from C<$srcpath> to C<$dstpath> and call the callback with 652destination) from C<$srcpath> to C<$dstpath> and call the callback with
634the C<0> (error) or C<-1> ok. 653the C<0> (error) or C<-1> ok.
635 654
636This is a composite request that tries to rename(2) the file first. If 655This is a composite request that tries to rename(2) the file first; if
637rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if 656rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
638that is successful, unlinking the C<$srcpath>. 657that is successful, unlinks the C<$srcpath>.
639 658
640=cut 659=cut
641 660
642sub aio_move($$;$) { 661sub aio_move($$;$) {
643 my ($src, $dst, $cb) = @_; 662 my ($src, $dst, $cb) = @_;
855callback with the fdatasync result code. 874callback with the fdatasync result code.
856 875
857If this call isn't available because your OS lacks it or it couldn't be 876If this call isn't available because your OS lacks it or it couldn't be
858detected, it will be emulated by calling C<fsync> instead. 877detected, it will be emulated by calling C<fsync> instead.
859 878
879=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
880
881Sync the data portion of the file specified by C<$offset> and C<$length>
882to disk (but NOT the metadata), by calling the Linux-specific
883sync_file_range call. If sync_file_range is not available or it returns
884ENOSYS, then fdatasync or fsync is being substituted.
885
886C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
887C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
888C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
889manpage for details.
890
860=item aio_pathsync $path, $callback->($status) 891=item aio_pathsync $path, $callback->($status)
861 892
862This request tries to open, fsync and close the given path. This is a 893This request tries to open, fsync and close the given path. This is a
863composite request intended to sync directories after directory operations 894composite request intended to sync directories after directory operations
864(E.g. rename). This might not work on all operating systems or have any 895(E.g. rename). This might not work on all operating systems or have any
1060=item feed $grp $callback->($grp) 1091=item feed $grp $callback->($grp)
1061 1092
1062Sets a feeder/generator on this group: every group can have an attached 1093Sets a feeder/generator on this group: every group can have an attached
1063generator that generates requests if idle. The idea behind this is that, 1094generator that generates requests if idle. The idea behind this is that,
1064although you could just queue as many requests as you want in a group, 1095although you could just queue as many requests as you want in a group,
1065this might starve other requests for a potentially long time. For 1096this might starve other requests for a potentially long time. For example,
1066example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1097C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1067requests, delaying any later requests for a long time. 1098delaying any later requests for a long time.
1068 1099
1069To avoid this, and allow incremental generation of requests, you can 1100To avoid this, and allow incremental generation of requests, you can
1070instead a group and set a feeder on it that generates those requests. The 1101instead a group and set a feeder on it that generates those requests. The
1071feed callback will be called whenever there are few enough (see C<limit>, 1102feed callback will be called whenever there are few enough (see C<limit>,
1072below) requests active in the group itself and is expected to queue more 1103below) requests active in the group itself and is expected to queue more
1076not impose any limits). 1107not impose any limits).
1077 1108
1078If the feed does not queue more requests when called, it will be 1109If the feed does not queue more requests when called, it will be
1079automatically removed from the group. 1110automatically removed from the group.
1080 1111
1081If the feed limit is C<0>, it will be set to C<2> automatically. 1112If the feed limit is C<0> when this method is called, it will be set to
1113C<2> automatically.
1082 1114
1083Example: 1115Example:
1084 1116
1085 # stat all files in @files, but only ever use four aio requests concurrently: 1117 # stat all files in @files, but only ever use four aio requests concurrently:
1086 1118
1097 1129
1098Sets the feeder limit for the group: The feeder will be called whenever 1130Sets the feeder limit for the group: The feeder will be called whenever
1099the group contains less than this many requests. 1131the group contains less than this many requests.
1100 1132
1101Setting the limit to C<0> will pause the feeding process. 1133Setting the limit to C<0> will pause the feeding process.
1134
1135The default value for the limit is C<0>, but note that setting a feeder
1136automatically bumps it up to C<2>.
1102 1137
1103=back 1138=back
1104 1139
1105=head2 SUPPORT FUNCTIONS 1140=head2 SUPPORT FUNCTIONS
1106 1141

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines