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.145 by root, Sun Apr 19 19:20:10 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.18';
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).
345 347
346If C<$offset> is undefined, then the current file descriptor offset will 348If C<$offset> is undefined, then the current file descriptor offset will
347be used (and updated), otherwise the file descriptor offset will not be 349be used (and updated), otherwise the file descriptor offset will not be
348changed by these calls. 350changed by these calls.
349 351
350If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. 352If C<$length> is undefined in C<aio_write>, use the remaining length of
353C<$data>.
351 354
352If C<$dataoffset> is less than zero, it will be counted from the end of 355If C<$dataoffset> is less than zero, it will be counted from the end of
353C<$data>. 356C<$data>.
354 357
355The C<$data> scalar I<MUST NOT> be modified in any way while the request 358The C<$data> scalar I<MUST NOT> be modified in any way while the request
631 634
632Try to move the I<file> (directories not supported as either source or 635Try to move the I<file> (directories not supported as either source or
633destination) from C<$srcpath> to C<$dstpath> and call the callback with 636destination) from C<$srcpath> to C<$dstpath> and call the callback with
634the C<0> (error) or C<-1> ok. 637the C<0> (error) or C<-1> ok.
635 638
636This is a composite request that tries to rename(2) the file first. If 639This 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 640rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
638that is successful, unlinking the C<$srcpath>. 641that is successful, unlinks the C<$srcpath>.
639 642
640=cut 643=cut
641 644
642sub aio_move($$;$) { 645sub aio_move($$;$) {
643 my ($src, $dst, $cb) = @_; 646 my ($src, $dst, $cb) = @_;
855callback with the fdatasync result code. 858callback with the fdatasync result code.
856 859
857If this call isn't available because your OS lacks it or it couldn't be 860If 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. 861detected, it will be emulated by calling C<fsync> instead.
859 862
863=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
864
865Sync the data portion of the file specified by C<$offset> and C<$length>
866to disk (but NOT the metadata), by calling the Linux-specific
867sync_file_range call. If sync_file_range is not available or it returns
868ENOSYS, then fdatasync or fsync is being substituted.
869
870C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
871C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
872C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
873manpage for details.
874
860=item aio_pathsync $path, $callback->($status) 875=item aio_pathsync $path, $callback->($status)
861 876
862This request tries to open, fsync and close the given path. This is a 877This request tries to open, fsync and close the given path. This is a
863composite request intended to sync directories after directory operations 878composite request intended to sync directories after directory operations
864(E.g. rename). This might not work on all operating systems or have any 879(E.g. rename). This might not work on all operating systems or have any
1060=item feed $grp $callback->($grp) 1075=item feed $grp $callback->($grp)
1061 1076
1062Sets a feeder/generator on this group: every group can have an attached 1077Sets a feeder/generator on this group: every group can have an attached
1063generator that generates requests if idle. The idea behind this is that, 1078generator 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, 1079although you could just queue as many requests as you want in a group,
1065this might starve other requests for a potentially long time. For 1080this might starve other requests for a potentially long time. For example,
1066example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1081C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1067requests, delaying any later requests for a long time. 1082delaying any later requests for a long time.
1068 1083
1069To avoid this, and allow incremental generation of requests, you can 1084To avoid this, and allow incremental generation of requests, you can
1070instead a group and set a feeder on it that generates those requests. The 1085instead 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>, 1086feed 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 1087below) requests active in the group itself and is expected to queue more
1076not impose any limits). 1091not impose any limits).
1077 1092
1078If the feed does not queue more requests when called, it will be 1093If the feed does not queue more requests when called, it will be
1079automatically removed from the group. 1094automatically removed from the group.
1080 1095
1081If the feed limit is C<0>, it will be set to C<2> automatically. 1096If the feed limit is C<0> when this method is called, it will be set to
1097C<2> automatically.
1082 1098
1083Example: 1099Example:
1084 1100
1085 # stat all files in @files, but only ever use four aio requests concurrently: 1101 # stat all files in @files, but only ever use four aio requests concurrently:
1086 1102
1097 1113
1098Sets the feeder limit for the group: The feeder will be called whenever 1114Sets the feeder limit for the group: The feeder will be called whenever
1099the group contains less than this many requests. 1115the group contains less than this many requests.
1100 1116
1101Setting the limit to C<0> will pause the feeding process. 1117Setting the limit to C<0> will pause the feeding process.
1118
1119The default value for the limit is C<0>, but note that setting a feeder
1120automatically bumps it up to C<2>.
1102 1121
1103=back 1122=back
1104 1123
1105=head2 SUPPORT FUNCTIONS 1124=head2 SUPPORT FUNCTIONS
1106 1125

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines