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.108 by root, Fri Jun 1 13:25:50 2007 UTC vs.
Revision 1.121 by root, Wed Apr 16 16:45:18 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.61';
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); 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
345like the syscall).
346
332like the syscall). If C<offset> is undefined, then the current file offset 347If C<$offset> is undefined, then the current file descriptor offset will
333will be used (and updated), otherwise the file offset will not be changed 348be used (and updated), otherwise the file descriptor offset will not be
334by these calls. 349changed by these calls.
350
351If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>.
352
353If C<$dataoffset> is less than zero, it will be counted from the end of
354C<$data>.
335 355
336The 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
337is outstanding. Modifying it can result in segfaults or World War III (if 357is outstanding. Modifying it can result in segfaults or World War III (if
338the necessary/optional hardware is installed). 358the necessary/optional hardware is installed).
339 359
437 aio_chown "path", 0, -1; 457 aio_chown "path", 0, -1;
438 # same as above: 458 # same as above:
439 aio_chown "path", 0, undef; 459 aio_chown "path", 0, undef;
440 460
441 461
462=item aio_truncate $fh_or_path, $offset, $callback->($status)
463
464Works like truncate(2) or ftruncate(2).
465
466
442=item aio_chmod $fh_or_path, $mode, $callback->($status) 467=item aio_chmod $fh_or_path, $mode, $callback->($status)
443 468
444Works like perl's C<chmod> function. 469Works like perl's C<chmod> function.
445 470
446 471
579 604
580 # those should not normally block. should. should. 605 # those should not normally block. should. should.
581 utime $stat[8], $stat[9], $dst; 606 utime $stat[8], $stat[9], $dst;
582 chmod $stat[2] & 07777, $dst_fh; 607 chmod $stat[2] & 07777, $dst_fh;
583 chown $stat[4], $stat[5], $dst_fh; 608 chown $stat[4], $stat[5], $dst_fh;
609
610 aioreq_pri $pri;
584 close $dst_fh; 611 add $grp aio_close $dst_fh;
585 } else { 612 } else {
586 $grp->result (-1); 613 $grp->result (-1);
587 close $src_fh; 614 close $src_fh;
588 close $dst_fh; 615 close $dst_fh;
589 616
822 849
823 $grp 850 $grp
824 } 851 }
825} 852}
826 853
854=item aio_sync $callback->($status)
855
856Asynchronously call sync and call the callback when finished.
857
827=item aio_fsync $fh, $callback->($status) 858=item aio_fsync $fh, $callback->($status)
828 859
829Asynchronously call fsync on the given filehandle and call the callback 860Asynchronously call fsync on the given filehandle and call the callback
830with the fsync result code. 861with the fsync result code.
831 862
834Asynchronously call fdatasync on the given filehandle and call the 865Asynchronously call fdatasync on the given filehandle and call the
835callback with the fdatasync result code. 866callback with the fdatasync result code.
836 867
837If 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
838detected, 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}
839 910
840=item aio_group $callback->(...) 911=item aio_group $callback->(...)
841 912
842This 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
843container 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
980itself. 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.
981 1052
982=item $grp->result (...) 1053=item $grp->result (...)
983 1054
984Set 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
985subrequests have finished and set thre groups errno to the current value 1056subrequests have finished and set the groups errno to the current value
986of 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,
987no argument will be passed and errno is zero. 1058no argument will be passed and errno is zero.
988 1059
989=item $grp->errno ([$errno]) 1060=item $grp->errno ([$errno])
990 1061
1195This 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
1196blocks, 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
1197use an C<aio_group> together with a feed callback. 1268use an C<aio_group> together with a feed callback.
1198 1269
1199Sets the maximum number of outstanding requests to C<$nreqs>. If you 1270Sets the maximum number of outstanding requests to C<$nreqs>. If you
1200to 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
1201C<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>)
1202function will block until the limit is no longer exceeded. 1273function will block until the limit is no longer exceeded.
1203 1274
1204The 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
1205number of outstanding requests. 1276number of outstanding requests.
1235but not yet processed by poll_cb). 1306but not yet processed by poll_cb).
1236 1307
1237=back 1308=back
1238 1309
1239=cut 1310=cut
1240
1241# support function to convert a fd into a perl filehandle
1242sub _fd2fh {
1243 return undef if $_[0] < 0;
1244
1245 # try to generate nice filehandles
1246 my $sym = "IO::AIO::fd#$_[0]";
1247 local *$sym;
1248
1249 open *$sym, "+<&=$_[0]" # usually works under any unix
1250 or open *$sym, "<&=$_[0]" # cygwin needs this
1251 or open *$sym, ">&=$_[0]" # or this
1252 or return undef;
1253
1254 *$sym
1255}
1256 1311
1257min_parallel 8; 1312min_parallel 8;
1258 1313
1259END { flush } 1314END { flush }
1260 1315
1284bytes of memory. In addition, stat requests need a stat buffer (possibly 1339bytes of memory. In addition, stat requests need a stat buffer (possibly
1285a few hundred bytes), readdir requires a result buffer and so on. Perl 1340a few hundred bytes), readdir requires a result buffer and so on. Perl
1286scalars and other data passed into aio requests will also be locked and 1341scalars and other data passed into aio requests will also be locked and
1287will consume memory till the request has entered the done state. 1342will consume memory till the request has entered the done state.
1288 1343
1289This is now awfully much, so queuing lots of requests is not usually a 1344This is not awfully much, so queuing lots of requests is not usually a
1290problem. 1345problem.
1291 1346
1292Per-thread usage: 1347Per-thread usage:
1293 1348
1294In the execution phase, some aio requests require more memory for 1349In the execution phase, some aio requests require more memory for

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines