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.169 by root, Sat Jan 2 13:02:20 2010 UTC vs.
Revision 1.173 by root, Thu Jan 7 20:25:57 2010 UTC

… …
191use common::sense; 191use common::sense;
192 192
193use base 'Exporter'; 193use base 'Exporter';
194 194
195BEGIN { 195BEGIN {
196 our $VERSION = '3.31'; 196 our $VERSION = '3.5';
197 197
198 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close 198 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
199 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx 199 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
200 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync 200 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
201 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead 201 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
202 aio_rename aio_link aio_move aio_copy aio_group 202 aio_rename aio_link aio_move aio_copy aio_group
203 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 203 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
204 aio_chmod aio_utime aio_truncate); 204 aio_chmod aio_utime aio_truncate
205 aio_msync aio_mtouch aio_statvfs);
205 206
206 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 207 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
207 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 208 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
208 min_parallel max_parallel max_idle 209 min_parallel max_parallel max_idle
209 nreqs nready npending nthreads 210 nreqs nready npending nthreads
… …
380 381
381This call tries to make use of a native C<sendfile> syscall to provide 382This call tries to make use of a native C<sendfile> syscall to provide
382zero-copy operation. For this to work, C<$out_fh> should refer to a 383zero-copy operation. For this to work, C<$out_fh> should refer to a
383socket, and C<$in_fh> should refer to mmap'able file. 384socket, and C<$in_fh> should refer to mmap'able file.
384 385
385If the native sendfile call fails with C<ENOSYS>, C<ENOTSUP>, 386If a native sendfile cannot be found or it fails with C<ENOSYS>,
386C<EOPNOTSUPP> or C<ENOTSOCK>, or is not implemented, it will be emulated, 387C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>,
387so you can call C<aio_sendfile> on any type of filehandle regardless of 388it will be emulated, so you can call C<aio_sendfile> on any type of
388the limitations of the operating system. 389filehandle regardless of the limitations of the operating system.
389 390
390Please note, however, that C<aio_sendfile> can read more bytes from 391Please note, however, that C<aio_sendfile> can read more bytes from
391C<$in_fh> than are written, and there is no way to find out how many 392C<$in_fh> than are written, and there is no way to find out how many
392bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 393bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
393provides the number of bytes written to C<$out_fh>. Only if the result 394provides the number of bytes written to C<$out_fh>. Only if the result
… …
429 430
430 aio_stat "/etc/passwd", sub { 431 aio_stat "/etc/passwd", sub {
431 $_[0] and die "stat failed: $!"; 432 $_[0] and die "stat failed: $!";
432 print "size is ", -s _, "\n"; 433 print "size is ", -s _, "\n";
433 }; 434 };
435
436
437=item aio_statvfs $fh_or_path, $callback->($statvfs)
438
439Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
440whether a file handle or path was passed.
441
442On success, the callback is passed a hash reference with the following
443members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
444C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
445is passed.
446
447The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
448C<ST_NOSUID>.
449
450The following non-POSIX IO::AIO::ST_* flag masks are defined to
451their correct value when available, or to C<0> on systems that do
452not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
453C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
454C<ST_NODIRATIME> and C<ST_RELATIME>.
455
456Example: stat C</wd> and dump out the data if successful.
457
458 aio_statvfs "/wd", sub {
459 my $f = $_[0]
460 or die "statvfs: $!";
461
462 use Data::Dumper;
463 say Dumper $f;
464 };
465
466 # result:
467 {
468 bsize => 1024,
469 bfree => 4333064312,
470 blocks => 10253828096,
471 files => 2050765568,
472 flag => 4096,
473 favail => 2042092649,
474 bavail => 4333064312,
475 ffree => 2042092649,
476 namemax => 255,
477 frsize => 1024,
478 fsid => 1810
479 }
434 480
435 481
436=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 482=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
437 483
438Works like perl's C<utime> function (including the special case of $atime 484Works like perl's C<utime> function (including the special case of $atime
… …
990 }; 1036 };
991 1037
992 $grp 1038 $grp
993} 1039}
994 1040
1041=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1042
1043This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1044scalars (see the L<Sys::Mmap> or L<Mmap> modules for details on this, note
1045that the scalar must only be modified in-place while an aio operation is
1046pending on it).
1047
1048It calls the C<msync> function of your OS, if available, with the memory
1049area starting at C<$offset> in the string and ending C<$length> bytes
1050later. If C<$length> is negative, counts from the end, and if C<$length>
1051is C<undef>, then it goes till the end of the string. The flags can be
1052a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
1053C<IO::AIO::MS_SYNC>.
1054
1055=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1056
1057This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1058scalars.
1059
1060It touches (reads or writes) all memory pages in the specified
1061range inside the scalar. All caveats and parameters are the same
1062as for C<aio_msync>, above, except for flags, which must be either
1063C<0> (which reads all pages and ensures they are instantiated) or
1064C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
1065writing an octet from it, which dirties the page).
1066
995=item aio_group $callback->(...) 1067=item aio_group $callback->(...)
996 1068
997This is a very special aio request: Instead of doing something, it is a 1069This is a very special aio request: Instead of doing something, it is a
998container for other aio requests, which is useful if you want to bundle 1070container for other aio requests, which is useful if you want to bundle
999many requests into a single, composite, request with a definite callback 1071many requests into a single, composite, request with a definite callback

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines