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.111 by root, Mon Aug 13 12:08:13 2007 UTC vs.
Revision 1.122 by root, Sat Apr 26 12:00:23 2008 UTC

26 $req->cancel; # cancel request if still in queue 26 $req->cancel; # cancel request if still in queue
27 27
28 my $grp = aio_group sub { print "all stats done\n" }; 28 my $grp = aio_group sub { print "all stats done\n" };
29 add $grp aio_stat "..." for ...; 29 add $grp aio_stat "..." for ...;
30 30
31 # AnyEvent integration 31 # AnyEvent integration (EV, Event, Glib, Tk, urxvt, pureperl...)
32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; 32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); 33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34
35 # EV integration
36 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
34 37
35 # Event integration 38 # Event integration
36 Event->io (fd => IO::AIO::poll_fileno, 39 Event->io (fd => IO::AIO::poll_fileno,
37 poll => 'r', 40 poll => 'r',
38 cb => \&IO::AIO::poll_cb); 41 cb => \&IO::AIO::poll_cb);
183 186
184=cut 187=cut
185 188
186package IO::AIO; 189package IO::AIO;
187 190
191use Carp ();
192
188no warnings; 193no warnings;
189use strict 'vars'; 194use strict 'vars';
190 195
191use base 'Exporter'; 196use base 'Exporter';
192 197
193BEGIN { 198BEGIN {
194 our $VERSION = '2.4'; 199 our $VERSION = '2.62';
195 200
196 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 201 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
197 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 202 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
198 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link 203 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
204 aio_fdatasync aio_pathsync aio_readahead
205 aio_rename aio_link aio_move aio_copy aio_group
199 aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir 206 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
200 aio_chown aio_chmod aio_utime aio_truncate); 207 aio_chmod aio_utime aio_truncate);
208
201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); 209 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block));
202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 210 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
203 min_parallel max_parallel max_idle 211 min_parallel max_parallel max_idle
204 nreqs nready npending nthreads 212 nreqs nready npending nthreads
205 max_poll_time max_poll_reqs); 213 max_poll_time max_poll_reqs);
311 319
312 320
313=item aio_close $fh, $callback->($status) 321=item aio_close $fh, $callback->($status)
314 322
315Asynchronously close a file and call the callback with the result 323Asynchronously close a file and call the callback with the result
316code. I<WARNING:> although accepted, you should not pass in a perl 324code.
317filehandle here, as perl will likely close the file descriptor another
318time when the filehandle is destroyed. Normally, you can safely call perls
319C<close> or just let filehandles go out of scope.
320 325
321This is supposed to be a bug in the API, so that might change. It's 326Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
322therefore best to avoid this function. 327closing the file descriptor associated with the filehandle itself.
323 328
329Therefore, C<aio_close> will not close the filehandle - instead it will
330use dup2 to overwrite the file descriptor with the write-end of a pipe
331(the pipe fd will be created on demand and will be cached).
332
333Or in other words: the file descriptor will be closed, but it will not be
334free for reuse until the perl filehandle is closed.
335
336=cut
324 337
325=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 338=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
326 339
327=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 340=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
328 341
329Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> 342Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset>
330into the scalar given by C<$data> and offset C<$dataoffset> and calls the 343into the scalar given by C<$data> and offset C<$dataoffset> and calls the
331callback without the actual number of bytes read (or -1 on error, just 344callback without the actual number of bytes read (or -1 on error, just
332like the syscall). 345like the syscall).
333 346
334If C<$offset> is undefined, then the current file offset will be used (and 347If C<$offset> is undefined, then the current file descriptor offset will
335updated), otherwise the file offset will not be changed by these calls. 348be used (and updated), otherwise the file descriptor offset will not be
349changed by these calls.
336 350
337If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. 351If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>.
338 352
339If C<$dataoffset> is less than zero, it will be counted from the end of 353If C<$dataoffset> is less than zero, it will be counted from the end of
340C<$data>. 354C<$data>.
341 355
342The C<$data> scalar I<MUST NOT> be modified in any way while the request 356The C<$data> scalar I<MUST NOT> be modified in any way while the request
590 604
591 # those should not normally block. should. should. 605 # those should not normally block. should. should.
592 utime $stat[8], $stat[9], $dst; 606 utime $stat[8], $stat[9], $dst;
593 chmod $stat[2] & 07777, $dst_fh; 607 chmod $stat[2] & 07777, $dst_fh;
594 chown $stat[4], $stat[5], $dst_fh; 608 chown $stat[4], $stat[5], $dst_fh;
609
610 aioreq_pri $pri;
595 close $dst_fh; 611 add $grp aio_close $dst_fh;
596 } else { 612 } else {
597 $grp->result (-1); 613 $grp->result (-1);
598 close $src_fh; 614 close $src_fh;
599 close $dst_fh; 615 close $dst_fh;
600 616
833 849
834 $grp 850 $grp
835 } 851 }
836} 852}
837 853
854=item aio_sync $callback->($status)
855
856Asynchronously call sync and call the callback when finished.
857
838=item aio_fsync $fh, $callback->($status) 858=item aio_fsync $fh, $callback->($status)
839 859
840Asynchronously call fsync on the given filehandle and call the callback 860Asynchronously call fsync on the given filehandle and call the callback
841with the fsync result code. 861with the fsync result code.
842 862
845Asynchronously call fdatasync on the given filehandle and call the 865Asynchronously call fdatasync on the given filehandle and call the
846callback with the fdatasync result code. 866callback with the fdatasync result code.
847 867
848If this call isn't available because your OS lacks it or it couldn't be 868If this call isn't available because your OS lacks it or it couldn't be
849detected, it will be emulated by calling C<fsync> instead. 869detected, it will be emulated by calling C<fsync> instead.
870
871=item aio_pathsync $path, $callback->($status)
872
873This request tries to open, fsync and close the given path. This is a
874composite request intended tosync directories after directory operations
875(E.g. rename). This might not work on all operating systems or have any
876specific effect, but usually it makes sure that directory changes get
877written to disc. It works for anything that can be opened for read-only,
878not just directories.
879
880Passes C<0> when everything went ok, and C<-1> on error.
881
882=cut
883
884sub aio_pathsync($;$) {
885 aio_block {
886 my ($path, $cb) = @_;
887
888 my $pri = aioreq_pri;
889 my $grp = aio_group $cb;
890
891 aioreq_pri $pri;
892 add $grp aio_open $path, O_RDONLY, 0, sub {
893 my ($fh) = @_;
894 if ($fh) {
895 aioreq_pri $pri;
896 add $grp aio_fsync $fh, sub {
897 $grp->result ($_[0]);
898
899 aioreq_pri $pri;
900 add $grp aio_close $fh;
901 };
902 } else {
903 $grp->result (-1);
904 }
905 };
906
907 $grp
908 }
909}
850 910
851=item aio_group $callback->(...) 911=item aio_group $callback->(...)
852 912
853This is a very special aio request: Instead of doing something, it is a 913This is a very special aio request: Instead of doing something, it is a
854container for other aio requests, which is useful if you want to bundle 914container for other aio requests, which is useful if you want to bundle
991itself. Useful when you queued a lot of events but got a result early. 1051itself. Useful when you queued a lot of events but got a result early.
992 1052
993=item $grp->result (...) 1053=item $grp->result (...)
994 1054
995Set the result value(s) that will be passed to the group callback when all 1055Set the result value(s) that will be passed to the group callback when all
996subrequests have finished and set thre groups errno to the current value 1056subrequests have finished and set the groups errno to the current value
997of errno (just like calling C<errno> without an error number). By default, 1057of errno (just like calling C<errno> without an error number). By default,
998no argument will be passed and errno is zero. 1058no argument will be passed and errno is zero.
999 1059
1000=item $grp->errno ([$errno]) 1060=item $grp->errno ([$errno])
1001 1061
1206This is a very bad function to use in interactive programs because it 1266This is a very bad function to use in interactive programs because it
1207blocks, and a bad way to reduce concurrency because it is inexact: Better 1267blocks, and a bad way to reduce concurrency because it is inexact: Better
1208use an C<aio_group> together with a feed callback. 1268use an C<aio_group> together with a feed callback.
1209 1269
1210Sets the maximum number of outstanding requests to C<$nreqs>. If you 1270Sets the maximum number of outstanding requests to C<$nreqs>. If you
1211to queue up more than this number of requests, the next call to the 1271do queue up more than this number of requests, the next call to the
1212C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) 1272C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1213function will block until the limit is no longer exceeded. 1273function will block until the limit is no longer exceeded.
1214 1274
1215The default value is very large, so there is no practical limit on the 1275The default value is very large, so there is no practical limit on the
1216number of outstanding requests. 1276number of outstanding requests.
1246but not yet processed by poll_cb). 1306but not yet processed by poll_cb).
1247 1307
1248=back 1308=back
1249 1309
1250=cut 1310=cut
1251
1252# support function to convert a fd into a perl filehandle
1253sub _fd2fh {
1254 return undef if $_[0] < 0;
1255
1256 # try to generate nice filehandles
1257 my $sym = "IO::AIO::fd#$_[0]";
1258 local *$sym;
1259
1260 open *$sym, "+<&=$_[0]" # usually works under any unix
1261 or open *$sym, "<&=$_[0]" # cygwin needs this
1262 or open *$sym, ">&=$_[0]" # or this
1263 or return undef;
1264
1265 *$sym
1266}
1267 1311
1268min_parallel 8; 1312min_parallel 8;
1269 1313
1270END { flush } 1314END { flush }
1271 1315

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines