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.181 by root, Tue May 4 21:14:01 2010 UTC

4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use IO::AIO; 7 use IO::AIO;
8 8
9 aio_open "/etc/passwd", O_RDONLY, 0, sub { 9 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
10 my $fh = shift 10 my $fh = shift
11 or die "/etc/passwd: $!"; 11 or die "/etc/passwd: $!";
12 ... 12 ...
13 }; 13 };
14 14
25 my $req = aio_unlink "/tmp/file", sub { }; 25 my $req = aio_unlink "/tmp/file", sub { };
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
31 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
32 use AnyEvent::AIO;
33
34 # EV integration
35 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
36
37 # Event integration
38 Event->io (fd => IO::AIO::poll_fileno,
39 poll => 'r',
40 cb => \&IO::AIO::poll_cb);
41
42 # Glib/Gtk2 integration
43 add_watch Glib::IO IO::AIO::poll_fileno,
44 in => sub { IO::AIO::poll_cb; 1 };
45
46 # Tk integration
47 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
48 readable => \&IO::AIO::poll_cb);
49
50 # Danga::Socket integration
51 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
52 \&IO::AIO::poll_cb);
53 30
54=head1 DESCRIPTION 31=head1 DESCRIPTION
55 32
56This module implements asynchronous I/O using whatever means your 33This module implements asynchronous I/O using whatever means your
57operating system supports. It is implemented as an interface to C<libeio> 34operating system supports. It is implemented as an interface to C<libeio>
99 76
100 # register the IO::AIO callback with EV 77 # register the IO::AIO callback with EV
101 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; 78 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
102 79
103 # queue the request to open /etc/passwd 80 # queue the request to open /etc/passwd
104 aio_open "/etc/passwd", O_RDONLY, 0, sub { 81 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
105 my $fh = shift 82 my $fh = shift
106 or die "error while opening: $!"; 83 or die "error while opening: $!";
107 84
108 # stat'ing filehandles is generally non-blocking 85 # stat'ing filehandles is generally non-blocking
109 my $size = -s $fh; 86 my $size = -s $fh;
191use common::sense; 168use common::sense;
192 169
193use base 'Exporter'; 170use base 'Exporter';
194 171
195BEGIN { 172BEGIN {
196 our $VERSION = '3.31'; 173 our $VERSION = '3.65';
197 174
198 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close 175 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 176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
200 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync 177 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
201 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead 178 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
202 aio_rename aio_link aio_move aio_copy aio_group 179 aio_rename aio_link aio_move aio_copy aio_group
203 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 180 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
204 aio_chmod aio_utime aio_truncate); 181 aio_chmod aio_utime aio_truncate
182 aio_msync aio_mtouch aio_statvfs);
205 183
206 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 184 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
207 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 185 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
208 min_parallel max_parallel max_idle 186 min_parallel max_parallel max_idle
209 nreqs nready npending nthreads 187 nreqs nready npending nthreads
217 require XSLoader; 195 require XSLoader;
218 XSLoader::load ("IO::AIO", $VERSION); 196 XSLoader::load ("IO::AIO", $VERSION);
219} 197}
220 198
221=head1 FUNCTIONS 199=head1 FUNCTIONS
200
201=head2 QUICK OVERVIEW
202
203This section simply lists the prototypes of the most important functions
204for quick reference. See the following sections for function-by-function
205documentation.
206
207 aio_open $pathname, $flags, $mode, $callback->($fh)
208 aio_close $fh, $callback->($status)
209 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
210 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
211 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
212 aio_readahead $fh,$offset,$length, $callback->($retval)
213 aio_stat $fh_or_path, $callback->($status)
214 aio_lstat $fh, $callback->($status)
215 aio_statvfs $fh_or_path, $callback->($statvfs)
216 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
217 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
218 aio_truncate $fh_or_path, $offset, $callback->($status)
219 aio_chmod $fh_or_path, $mode, $callback->($status)
220 aio_unlink $pathname, $callback->($status)
221 aio_mknod $path, $mode, $dev, $callback->($status)
222 aio_link $srcpath, $dstpath, $callback->($status)
223 aio_symlink $srcpath, $dstpath, $callback->($status)
224 aio_readlink $path, $callback->($link)
225 aio_rename $srcpath, $dstpath, $callback->($status)
226 aio_mkdir $pathname, $mode, $callback->($status)
227 aio_rmdir $pathname, $callback->($status)
228 aio_readdir $pathname, $callback->($entries)
229 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
230 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
231 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
232 aio_load $path, $data, $callback->($status)
233 aio_copy $srcpath, $dstpath, $callback->($status)
234 aio_move $srcpath, $dstpath, $callback->($status)
235 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
236 aio_rmtree $path, $callback->($status)
237 aio_sync $callback->($status)
238 aio_fsync $fh, $callback->($status)
239 aio_fdatasync $fh, $callback->($status)
240 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
241 aio_pathsync $path, $callback->($status)
242 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
243 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
244 aio_group $callback->(...)
245 aio_nop $callback->()
246
247 $prev_pri = aioreq_pri [$pri]
248 aioreq_nice $pri_adjust
249
250 IO::AIO::poll_wait
251 IO::AIO::poll_cb
252 IO::AIO::poll
253 IO::AIO::flush
254 IO::AIO::max_poll_reqs $nreqs
255 IO::AIO::max_poll_time $seconds
256 IO::AIO::min_parallel $nthreads
257 IO::AIO::max_parallel $nthreads
258 IO::AIO::max_idle $nthreads
259 IO::AIO::max_outstanding $maxreqs
260 IO::AIO::nreqs
261 IO::AIO::nready
262 IO::AIO::npending
263
264 IO::AIO::sendfile $ofh, $ifh, $offset, $count
265 IO::AIO::fadvise $fh, $offset, $len, $advice
266 IO::AIO::mlockall $flags
267 IO::AIO::munlockall
222 268
223=head2 AIO REQUEST FUNCTIONS 269=head2 AIO REQUEST FUNCTIONS
224 270
225All the C<aio_*> calls are more or less thin wrappers around the syscall 271All the C<aio_*> calls are more or less thin wrappers around the syscall
226with the same name (sans C<aio_>). The arguments are similar or identical, 272with the same name (sans C<aio_>). The arguments are similar or identical,
306by the umask in effect then the request is being executed, so better never 352by the umask in effect then the request is being executed, so better never
307change the umask. 353change the umask.
308 354
309Example: 355Example:
310 356
311 aio_open "/etc/passwd", O_RDONLY, 0, sub { 357 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
312 if ($_[0]) { 358 if ($_[0]) {
313 print "open successful, fh is $_[0]\n"; 359 print "open successful, fh is $_[0]\n";
314 ... 360 ...
315 } else { 361 } else {
316 die "open failed: $!\n"; 362 die "open failed: $!\n";
378than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each 424than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
379other. 425other.
380 426
381This call tries to make use of a native C<sendfile> syscall to provide 427This 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 428zero-copy operation. For this to work, C<$out_fh> should refer to a
383socket, and C<$in_fh> should refer to mmap'able file. 429socket, and C<$in_fh> should refer to an mmap'able file.
384 430
385If the native sendfile call fails with C<ENOSYS>, C<ENOTSUP>, 431If 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, 432C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>,
387so you can call C<aio_sendfile> on any type of filehandle regardless of 433it will be emulated, so you can call C<aio_sendfile> on any type of
388the limitations of the operating system. 434filehandle regardless of the limitations of the operating system.
389 435
390Please note, however, that C<aio_sendfile> can read more bytes from 436Please 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 437C<$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 438bytes 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 439provides the number of bytes written to C<$out_fh>. Only if the result
429 475
430 aio_stat "/etc/passwd", sub { 476 aio_stat "/etc/passwd", sub {
431 $_[0] and die "stat failed: $!"; 477 $_[0] and die "stat failed: $!";
432 print "size is ", -s _, "\n"; 478 print "size is ", -s _, "\n";
433 }; 479 };
480
481
482=item aio_statvfs $fh_or_path, $callback->($statvfs)
483
484Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
485whether a file handle or path was passed.
486
487On success, the callback is passed a hash reference with the following
488members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
489C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
490is passed.
491
492The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
493C<ST_NOSUID>.
494
495The following non-POSIX IO::AIO::ST_* flag masks are defined to
496their correct value when available, or to C<0> on systems that do
497not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
498C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
499C<ST_NODIRATIME> and C<ST_RELATIME>.
500
501Example: stat C</wd> and dump out the data if successful.
502
503 aio_statvfs "/wd", sub {
504 my $f = $_[0]
505 or die "statvfs: $!";
506
507 use Data::Dumper;
508 say Dumper $f;
509 };
510
511 # result:
512 {
513 bsize => 1024,
514 bfree => 4333064312,
515 blocks => 10253828096,
516 files => 2050765568,
517 flag => 4096,
518 favail => 2042092649,
519 bavail => 4333064312,
520 ffree => 2042092649,
521 namemax => 255,
522 frsize => 1024,
523 fsid => 1810
524 }
434 525
435 526
436=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 527=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
437 528
438Works like perl's C<utime> function (including the special case of $atime 529Works like perl's C<utime> function (including the special case of $atime
990 }; 1081 };
991 1082
992 $grp 1083 $grp
993} 1084}
994 1085
1086=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1087
1088This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1089scalars (see the C<IO::AIO::mmap> function, although it also works on data
1090scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1091scalar must only be modified in-place while an aio operation is pending on
1092it).
1093
1094It calls the C<msync> function of your OS, if available, with the memory
1095area starting at C<$offset> in the string and ending C<$length> bytes
1096later. If C<$length> is negative, counts from the end, and if C<$length>
1097is C<undef>, then it goes till the end of the string. The flags can be
1098a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
1099C<IO::AIO::MS_SYNC>.
1100
1101=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1102
1103This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1104scalars.
1105
1106It touches (reads or writes) all memory pages in the specified
1107range inside the scalar. All caveats and parameters are the same
1108as for C<aio_msync>, above, except for flags, which must be either
1109C<0> (which reads all pages and ensures they are instantiated) or
1110C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
1111writing an octet from it, which dirties the page).
1112
995=item aio_group $callback->(...) 1113=item aio_group $callback->(...)
996 1114
997This is a very special aio request: Instead of doing something, it is a 1115This 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 1116container for other aio requests, which is useful if you want to bundle
999many requests into a single, composite, request with a definite callback 1117many requests into a single, composite, request with a definite callback
1240 1358
1241 Event->io (fd => IO::AIO::poll_fileno, 1359 Event->io (fd => IO::AIO::poll_fileno,
1242 poll => 'r', async => 1, 1360 poll => 'r', async => 1,
1243 cb => \&IO::AIO::poll_cb); 1361 cb => \&IO::AIO::poll_cb);
1244 1362
1363=item IO::AIO::poll_wait
1364
1365If there are any outstanding requests and none of them in the result
1366phase, wait till the result filehandle becomes ready for reading (simply
1367does a C<select> on the filehandle. This is useful if you want to
1368synchronously wait for some requests to finish).
1369
1370See C<nreqs> for an example.
1371
1372=item IO::AIO::poll
1373
1374Waits until some requests have been handled.
1375
1376Returns the number of requests processed, but is otherwise strictly
1377equivalent to:
1378
1379 IO::AIO::poll_wait, IO::AIO::poll_cb
1380
1381=item IO::AIO::flush
1382
1383Wait till all outstanding AIO requests have been handled.
1384
1385Strictly equivalent to:
1386
1387 IO::AIO::poll_wait, IO::AIO::poll_cb
1388 while IO::AIO::nreqs;
1389
1245=item IO::AIO::max_poll_reqs $nreqs 1390=item IO::AIO::max_poll_reqs $nreqs
1246 1391
1247=item IO::AIO::max_poll_time $seconds 1392=item IO::AIO::max_poll_time $seconds
1248 1393
1249These set the maximum number of requests (default C<0>, meaning infinity) 1394These set the maximum number of requests (default C<0>, meaning infinity)
1273 # use a low priority so other tasks have priority 1418 # use a low priority so other tasks have priority
1274 Event->io (fd => IO::AIO::poll_fileno, 1419 Event->io (fd => IO::AIO::poll_fileno,
1275 poll => 'r', nice => 1, 1420 poll => 'r', nice => 1,
1276 cb => &IO::AIO::poll_cb); 1421 cb => &IO::AIO::poll_cb);
1277 1422
1278=item IO::AIO::poll_wait
1279
1280If there are any outstanding requests and none of them in the result
1281phase, wait till the result filehandle becomes ready for reading (simply
1282does a C<select> on the filehandle. This is useful if you want to
1283synchronously wait for some requests to finish).
1284
1285See C<nreqs> for an example.
1286
1287=item IO::AIO::poll
1288
1289Waits until some requests have been handled.
1290
1291Returns the number of requests processed, but is otherwise strictly
1292equivalent to:
1293
1294 IO::AIO::poll_wait, IO::AIO::poll_cb
1295
1296=item IO::AIO::flush
1297
1298Wait till all outstanding AIO requests have been handled.
1299
1300Strictly equivalent to:
1301
1302 IO::AIO::poll_wait, IO::AIO::poll_cb
1303 while IO::AIO::nreqs;
1304
1305=back 1423=back
1306 1424
1307=head3 CONTROLLING THE NUMBER OF THREADS 1425=head3 CONTROLLING THE NUMBER OF THREADS
1308 1426
1309=over 1427=over
1428C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. 1546C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1429 1547
1430On systems that do not implement C<posix_fadvise>, this function returns 1548On systems that do not implement C<posix_fadvise>, this function returns
1431ENOSYS, otherwise the return value of C<posix_fadvise>. 1549ENOSYS, otherwise the return value of C<posix_fadvise>.
1432 1550
1551=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1552
1553Memory-maps a file (or anonymous memory range) and attaches it to the
1554given C<$scalar>, which will act like a string scalar.
1555
1556The only operations allowed on the scalar are C<substr>/C<vec> that don't
1557change the string length, and most read-only operations such as copying it
1558or searching it with regexes and so on.
1559
1560Anything else is unsafe and will, at best, result in memory leaks.
1561
1562The memory map associated with the C<$scalar> is automatically removed
1563when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
1564C<IO::AIO::munmap> functions are called.
1565
1566This calls the C<mmap>(2) function internally. See your system's manual
1567page for details on the C<$length>, C<$prot> and C<$flags> parameters.
1568
1569The C<$length> must be larger than zero and smaller than the actual
1570filesize.
1571
1572C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1573C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1574
1575C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
1576C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
1577not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
1578(which is set to C<MAP_ANON> if your system only provides this
1579constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
1580C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
1581C<IO::AIO::MAP_NONBLOCK>
1582
1583If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1584
1585C<$offset> is the offset from the start of the file - it generally must be
1586a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
1587
1588Example:
1589
1590 use Digest::MD5;
1591 use IO::AIO;
1592
1593 open my $fh, "<verybigfile"
1594 or die "$!";
1595
1596 IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
1597 or die "verybigfile: $!";
1598
1599 my $fast_md5 = md5 $data;
1600
1601=item IO::AIO::munmap $scalar
1602
1603Removes a previous mmap and undefines the C<$scalar>.
1604
1605=item IO::AIO::mlockall $flags
1606
1607Calls the C<mlockall> function with the given C<$flags> (a combination of
1608C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL__FUTURE>).
1609
1610On systems that do not implement C<mlockall>, this function returns
1611ENOSYS, otherwise the return value of C<mlockall>.
1612
1613=item IO::AIO::munlockall
1614
1615Calls the C<munlockall> function.
1616
1617On systems that do not implement C<munlockall>, this function returns
1618ENOSYS, otherwise the return value of C<munlockall>.
1619
1433=back 1620=back
1434 1621
1435=cut 1622=cut
1436 1623
1437min_parallel 8; 1624min_parallel 8;
1438 1625
1439END { flush } 1626END { flush }
1440 1627
14411; 16281;
1629
1630=head1 EVENT LOOP INTEGRATION
1631
1632It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
1633automatically into many event loops:
1634
1635 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
1636 use AnyEvent::AIO;
1637
1638You can also integrate IO::AIO manually into many event loops, here are
1639some examples of how to do this:
1640
1641 # EV integration
1642 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
1643
1644 # Event integration
1645 Event->io (fd => IO::AIO::poll_fileno,
1646 poll => 'r',
1647 cb => \&IO::AIO::poll_cb);
1648
1649 # Glib/Gtk2 integration
1650 add_watch Glib::IO IO::AIO::poll_fileno,
1651 in => sub { IO::AIO::poll_cb; 1 };
1652
1653 # Tk integration
1654 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
1655 readable => \&IO::AIO::poll_cb);
1656
1657 # Danga::Socket integration
1658 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
1659 \&IO::AIO::poll_cb);
1442 1660
1443=head2 FORK BEHAVIOUR 1661=head2 FORK BEHAVIOUR
1444 1662
1445This module should do "the right thing" when the process using it forks: 1663This module should do "the right thing" when the process using it forks:
1446 1664

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines