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.175 by root, Sun Jan 10 20:37:33 2010 UTC vs.
Revision 1.202 by root, Tue Jul 5 14:02:15 2011 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
76 76
77 # register the IO::AIO callback with EV 77 # register the IO::AIO callback with EV
78 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;
79 79
80 # queue the request to open /etc/passwd 80 # queue the request to open /etc/passwd
81 aio_open "/etc/passwd", O_RDONLY, 0, sub { 81 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
82 my $fh = shift 82 my $fh = shift
83 or die "error while opening: $!"; 83 or die "error while opening: $!";
84 84
85 # stat'ing filehandles is generally non-blocking 85 # stat'ing filehandles is generally non-blocking
86 my $size = -s $fh; 86 my $size = -s $fh;
168use common::sense; 168use common::sense;
169 169
170use base 'Exporter'; 170use base 'Exporter';
171 171
172BEGIN { 172BEGIN {
173 our $VERSION = '3.5'; 173 our $VERSION = '3.93';
174 174
175 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
176 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
177 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync 177 aio_scandir aio_symlink aio_readlink aio_realpath aio_sync aio_fsync
178 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead 178 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
179 aio_rename aio_link aio_move aio_copy aio_group 179 aio_rename aio_link aio_move aio_copy aio_group
180 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
181 aio_chmod aio_utime aio_truncate 181 aio_chmod aio_utime aio_truncate
182 aio_msync aio_mtouch aio_statvfs); 182 aio_msync aio_mtouch aio_mlock aio_mlockall
183 aio_statvfs);
183 184
184 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 185 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
185 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 186 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
186 min_parallel max_parallel max_idle 187 min_parallel max_parallel max_idle idle_timeout
187 nreqs nready npending nthreads 188 nreqs nready npending nthreads
188 max_poll_time max_poll_reqs 189 max_poll_time max_poll_reqs
189 sendfile fadvise); 190 sendfile fadvise madvise
191 mmap munmap munlock munlockall);
190 192
191 push @AIO_REQ, qw(aio_busy); # not exported 193 push @AIO_REQ, qw(aio_busy); # not exported
192 194
193 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 195 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
194 196
220 aio_unlink $pathname, $callback->($status) 222 aio_unlink $pathname, $callback->($status)
221 aio_mknod $path, $mode, $dev, $callback->($status) 223 aio_mknod $path, $mode, $dev, $callback->($status)
222 aio_link $srcpath, $dstpath, $callback->($status) 224 aio_link $srcpath, $dstpath, $callback->($status)
223 aio_symlink $srcpath, $dstpath, $callback->($status) 225 aio_symlink $srcpath, $dstpath, $callback->($status)
224 aio_readlink $path, $callback->($link) 226 aio_readlink $path, $callback->($link)
227 aio_realpath $path, $callback->($link)
225 aio_rename $srcpath, $dstpath, $callback->($status) 228 aio_rename $srcpath, $dstpath, $callback->($status)
226 aio_mkdir $pathname, $mode, $callback->($status) 229 aio_mkdir $pathname, $mode, $callback->($status)
227 aio_rmdir $pathname, $callback->($status) 230 aio_rmdir $pathname, $callback->($status)
228 aio_readdir $pathname, $callback->($entries) 231 aio_readdir $pathname, $callback->($entries)
229 aio_readdirx $pathname, $flags, $callback->($entries, $flags) 232 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
239 aio_fdatasync $fh, $callback->($status) 242 aio_fdatasync $fh, $callback->($status)
240 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 243 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
241 aio_pathsync $path, $callback->($status) 244 aio_pathsync $path, $callback->($status)
242 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 245 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
243 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 246 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
247 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
248 aio_mlockall $flags, $callback->($status)
244 aio_group $callback->(...) 249 aio_group $callback->(...)
245 aio_nop $callback->() 250 aio_nop $callback->()
246 251
247 $prev_pri = aioreq_pri [$pri] 252 $prev_pri = aioreq_pri [$pri]
248 aioreq_nice $pri_adjust 253 aioreq_nice $pri_adjust
254 IO::AIO::max_poll_reqs $nreqs 259 IO::AIO::max_poll_reqs $nreqs
255 IO::AIO::max_poll_time $seconds 260 IO::AIO::max_poll_time $seconds
256 IO::AIO::min_parallel $nthreads 261 IO::AIO::min_parallel $nthreads
257 IO::AIO::max_parallel $nthreads 262 IO::AIO::max_parallel $nthreads
258 IO::AIO::max_idle $nthreads 263 IO::AIO::max_idle $nthreads
264 IO::AIO::idle_timeout $seconds
259 IO::AIO::max_outstanding $maxreqs 265 IO::AIO::max_outstanding $maxreqs
260 IO::AIO::nreqs 266 IO::AIO::nreqs
261 IO::AIO::nready 267 IO::AIO::nready
262 IO::AIO::npending 268 IO::AIO::npending
263 269
264 IO::AIO::sendfile $ofh, $ifh, $offset, $count 270 IO::AIO::sendfile $ofh, $ifh, $offset, $count
265 IO::AIO::fadvise $fh, $offset, $len, $advice 271 IO::AIO::fadvise $fh, $offset, $len, $advice
266 IO::AIO::mlockall $flags 272 IO::AIO::madvise $scalar, $offset, $length, $advice
273 IO::AIO::mprotect $scalar, $offset, $length, $protect
274 IO::AIO::munlock $scalar, $offset = 0, $length = undef
267 IO::AIO::munlockall 275 IO::AIO::munlockall
268 276
269=head2 AIO REQUEST FUNCTIONS 277=head2 AIO REQUEST FUNCTIONS
270 278
271All the C<aio_*> calls are more or less thin wrappers around the syscall 279All the C<aio_*> calls are more or less thin wrappers around the syscall
352by the umask in effect then the request is being executed, so better never 360by the umask in effect then the request is being executed, so better never
353change the umask. 361change the umask.
354 362
355Example: 363Example:
356 364
357 aio_open "/etc/passwd", O_RDONLY, 0, sub { 365 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
358 if ($_[0]) { 366 if ($_[0]) {
359 print "open successful, fh is $_[0]\n"; 367 print "open successful, fh is $_[0]\n";
360 ... 368 ...
361 } else { 369 } else {
362 die "open failed: $!\n"; 370 die "open failed: $!\n";
363 } 371 }
364 }; 372 };
365 373
374In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>,
375C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the
376following POSIX and non-POSIX constants are available (missing ones on
377your system are, as usual, C<0>):
378
379C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
380C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
381C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>.
382
366 383
367=item aio_close $fh, $callback->($status) 384=item aio_close $fh, $callback->($status)
368 385
369Asynchronously close a file and call the callback with the result 386Asynchronously close a file and call the callback with the result
370code. 387code.
420 437
421Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 438Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
422reading at byte offset C<$in_offset>, and starts writing at the current 439reading at byte offset C<$in_offset>, and starts writing at the current
423file offset of C<$out_fh>. Because of that, it is not safe to issue more 440file offset of C<$out_fh>. Because of that, it is not safe to issue more
424than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each 441than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
425other. 442other. The same C<$in_fh> works fine though, as this function does not
443move or use the file offset of C<$in_fh>.
426 444
445Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than
446are written, and there is no way to find out how many more bytes have been
447read from C<aio_sendfile> alone, as C<aio_sendfile> only provides the
448number of bytes written to C<$out_fh>. Only if the result value equals
449C<$length> one can assume that C<$length> bytes have been read.
450
451Unlike with other C<aio_> functions, it makes a lot of sense to use
452C<aio_sendfile> on non-blocking sockets, as long as one end (typically
453the C<$in_fh>) is a file - the file I/O will then be asynchronous, while
454the socket I/O will be non-blocking. Note, however, that you can run
455into a trap where C<aio_sendfile> reads some data with readahead, then
456fails to write all data, and when the socket is ready the next time, the
457data in the cache is already lost, forcing C<aio_sendfile> to again hit
458the disk. Explicit C<aio_read> + C<aio_write> let's you better control
459resource usage.
460
427This call tries to make use of a native C<sendfile> syscall to provide 461This call tries to make use of a native C<sendfile>-like syscall to
428zero-copy operation. For this to work, C<$out_fh> should refer to a 462provide zero-copy operation. For this to work, C<$out_fh> should refer to
429socket, and C<$in_fh> should refer to mmap'able file. 463a socket, and C<$in_fh> should refer to an mmap'able file.
430 464
431If a native sendfile cannot be found or it fails with C<ENOSYS>, 465If a native sendfile cannot be found or it fails with C<ENOSYS>,
432C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>, 466C<EINVAL>, C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or
433it will be emulated, so you can call C<aio_sendfile> on any type of 467C<ENOTSOCK>, it will be emulated, so you can call C<aio_sendfile> on any
434filehandle regardless of the limitations of the operating system. 468type of filehandle regardless of the limitations of the operating system.
435 469
436Please note, however, that C<aio_sendfile> can read more bytes from 470As native sendfile syscalls (as practically any non-POSIX interface hacked
437C<$in_fh> than are written, and there is no way to find out how many 471together in a hurry to improve benchmark numbers) tend to be rather buggy
438bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 472on many systems, this implementation tries to work around some known bugs
439provides the number of bytes written to C<$out_fh>. Only if the result 473in Linux and FreeBSD kernels (probably others, too), but that might fail,
440value equals C<$length> one can assume that C<$length> bytes have been 474so you really really should check the return value of C<aio_sendfile> -
441read. 475fewre bytes than expected might have been transferred.
442 476
443 477
444=item aio_readahead $fh,$offset,$length, $callback->($retval) 478=item aio_readahead $fh,$offset,$length, $callback->($retval)
445 479
446C<aio_readahead> populates the page cache with data from a file so that 480C<aio_readahead> populates the page cache with data from a file so that
468for an explanation. 502for an explanation.
469 503
470Currently, the stats are always 64-bit-stats, i.e. instead of returning an 504Currently, the stats are always 64-bit-stats, i.e. instead of returning an
471error when stat'ing a large file, the results will be silently truncated 505error when stat'ing a large file, the results will be silently truncated
472unless perl itself is compiled with large file support. 506unless perl itself is compiled with large file support.
507
508To help interpret the mode and dev/rdev stat values, IO::AIO offers the
509following constants and functions (if not implemented, the constants will
510be C<0> and the functions will either C<croak> or fall back on traditional
511behaviour).
512
513C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
514C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
515C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
473 516
474Example: Print the length of F</etc/passwd>: 517Example: Print the length of F</etc/passwd>:
475 518
476 aio_stat "/etc/passwd", sub { 519 aio_stat "/etc/passwd", sub {
477 $_[0] and die "stat failed: $!"; 520 $_[0] and die "stat failed: $!";
579 622
580The only (POSIX-) portable way of calling this function is: 623The only (POSIX-) portable way of calling this function is:
581 624
582 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 625 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
583 626
627See C<aio_stat> for info about some potentially helpful extra constants
628and functions.
584 629
585=item aio_link $srcpath, $dstpath, $callback->($status) 630=item aio_link $srcpath, $dstpath, $callback->($status)
586 631
587Asynchronously create a new link to the existing object at C<$srcpath> at 632Asynchronously create a new link to the existing object at C<$srcpath> at
588the path C<$dstpath> and call the callback with the result code. 633the path C<$dstpath> and call the callback with the result code.
599Asynchronously read the symlink specified by C<$path> and pass it to 644Asynchronously read the symlink specified by C<$path> and pass it to
600the callback. If an error occurs, nothing or undef gets passed to the 645the callback. If an error occurs, nothing or undef gets passed to the
601callback. 646callback.
602 647
603 648
649=item aio_realpath $path, $callback->($path)
650
651Asynchronously make the path absolute and resolve any symlinks in
652C<$path>. The resulting path only consists of directories (Same as
653L<Cwd::realpath>).
654
655This request can be used to get the absolute path of the current working
656directory by passing it a path of F<.> (a single dot).
657
658
604=item aio_rename $srcpath, $dstpath, $callback->($status) 659=item aio_rename $srcpath, $dstpath, $callback->($status)
605 660
606Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 661Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
607rename(2) and call the callback with the result code. 662rename(2) and call the callback with the result code.
608 663
641 696
642=over 4 697=over 4
643 698
644=item IO::AIO::READDIR_DENTS 699=item IO::AIO::READDIR_DENTS
645 700
646When this flag is off, then the callback gets an arrayref with of names 701When this flag is off, then the callback gets an arrayref consisting of
647only (as with C<aio_readdir>), otherwise it gets an arrayref with 702names only (as with C<aio_readdir>), otherwise it gets an arrayref with
648C<[$name, $type, $inode]> arrayrefs, each describing a single directory 703C<[$name, $type, $inode]> arrayrefs, each describing a single directory
649entry in more detail. 704entry in more detail.
650 705
651C<$name> is the name of the entry. 706C<$name> is the name of the entry.
652 707
665systems that do not deliver the inode information. 720systems that do not deliver the inode information.
666 721
667=item IO::AIO::READDIR_DIRS_FIRST 722=item IO::AIO::READDIR_DIRS_FIRST
668 723
669When this flag is set, then the names will be returned in an order where 724When this flag is set, then the names will be returned in an order where
670likely directories come first. This is useful when you need to quickly 725likely directories come first, in optimal stat order. This is useful when
671find directories, or you want to find all directories while avoiding to 726you need to quickly find directories, or you want to find all directories
672stat() each entry. 727while avoiding to stat() each entry.
673 728
674If the system returns type information in readdir, then this is used 729If the system returns type information in readdir, then this is used
675to find directories directly. Otherwise, likely directories are files 730to find directories directly. Otherwise, likely directories are names
676beginning with ".", or otherwise files with no dots, of which files with 731beginning with ".", or otherwise names with no dots, of which names with
677short names are tried first. 732short names are tried first.
678 733
679=item IO::AIO::READDIR_STAT_ORDER 734=item IO::AIO::READDIR_STAT_ORDER
680 735
681When this flag is set, then the names will be returned in an order 736When this flag is set, then the names will be returned in an order
826 if ($_[0] && $! == EXDEV) { 881 if ($_[0] && $! == EXDEV) {
827 aioreq_pri $pri; 882 aioreq_pri $pri;
828 add $grp aio_copy $src, $dst, sub { 883 add $grp aio_copy $src, $dst, sub {
829 $grp->result ($_[0]); 884 $grp->result ($_[0]);
830 885
831 if (!$_[0]) { 886 unless ($_[0]) {
832 aioreq_pri $pri; 887 aioreq_pri $pri;
833 add $grp aio_unlink $src; 888 add $grp aio_unlink $src;
834 } 889 }
835 }; 890 };
836 } else { 891 } else {
1084} 1139}
1085 1140
1086=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 1141=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1087 1142
1088This is a rather advanced IO::AIO call, which only works on mmap(2)ed 1143This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1089scalars (see the L<Sys::Mmap> or L<Mmap> modules for details on this, note 1144scalars (see the C<IO::AIO::mmap> function, although it also works on data
1145scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1090that the scalar must only be modified in-place while an aio operation is 1146scalar must only be modified in-place while an aio operation is pending on
1091pending on it). 1147it).
1092 1148
1093It calls the C<msync> function of your OS, if available, with the memory 1149It calls the C<msync> function of your OS, if available, with the memory
1094area starting at C<$offset> in the string and ending C<$length> bytes 1150area starting at C<$offset> in the string and ending C<$length> bytes
1095later. If C<$length> is negative, counts from the end, and if C<$length> 1151later. If C<$length> is negative, counts from the end, and if C<$length>
1096is C<undef>, then it goes till the end of the string. The flags can be 1152is C<undef>, then it goes till the end of the string. The flags can be
1107as for C<aio_msync>, above, except for flags, which must be either 1163as for C<aio_msync>, above, except for flags, which must be either
1108C<0> (which reads all pages and ensures they are instantiated) or 1164C<0> (which reads all pages and ensures they are instantiated) or
1109C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and 1165C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
1110writing an octet from it, which dirties the page). 1166writing an octet from it, which dirties the page).
1111 1167
1168=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1169
1170This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1171scalars.
1172
1173It reads in all the pages of the underlying storage into memory (if any)
1174and locks them, so they are not getting swapped/paged out or removed.
1175
1176If C<$length> is undefined, then the scalar will be locked till the end.
1177
1178On systems that do not implement C<mlock>, this function returns C<-1>
1179and sets errno to C<ENOSYS>.
1180
1181Note that the corresponding C<munlock> is synchronous and is
1182documented under L<MISCELLANEOUS FUNCTIONS>.
1183
1184Example: open a file, mmap and mlock it - both will be undone when
1185C<$data> gets destroyed.
1186
1187 open my $fh, "<", $path or die "$path: $!";
1188 my $data;
1189 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1190 aio_mlock $data; # mlock in background
1191
1192=item aio_mlockall $flags, $callback->($status)
1193
1194Calls the C<mlockall> function with the given C<$flags> (a combination of
1195C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
1196
1197On systems that do not implement C<mlockall>, this function returns C<-1>
1198and sets errno to C<ENOSYS>.
1199
1200Note that the corresponding C<munlockall> is synchronous and is
1201documented under L<MISCELLANEOUS FUNCTIONS>.
1202
1203Example: asynchronously lock all current and future pages into memory.
1204
1205 aio_mlockall IO::AIO::MCL_FUTURE;
1206
1112=item aio_group $callback->(...) 1207=item aio_group $callback->(...)
1113 1208
1114This is a very special aio request: Instead of doing something, it is a 1209This is a very special aio request: Instead of doing something, it is a
1115container for other aio requests, which is useful if you want to bundle 1210container for other aio requests, which is useful if you want to bundle
1116many requests into a single, composite, request with a definite callback 1211many requests into a single, composite, request with a definite callback
1339 1434
1340See C<poll_cb> for an example. 1435See C<poll_cb> for an example.
1341 1436
1342=item IO::AIO::poll_cb 1437=item IO::AIO::poll_cb
1343 1438
1344Process some outstanding events on the result pipe. You have to call this 1439Process some outstanding events on the result pipe. You have to call
1345regularly. Returns C<0> if all events could be processed, or C<-1> if it 1440this regularly. Returns C<0> if all events could be processed (or there
1346returned earlier for whatever reason. Returns immediately when no events 1441were no events to process), or C<-1> if it returned earlier for whatever
1347are outstanding. The amount of events processed depends on the settings of 1442reason. Returns immediately when no events are outstanding. The amount of
1348C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. 1443events processed depends on the settings of C<IO::AIO::max_poll_req> and
1444C<IO::AIO::max_poll_time>.
1349 1445
1350If not all requests were processed for whatever reason, the filehandle 1446If not all requests were processed for whatever reason, the filehandle
1351will still be ready when C<poll_cb> returns, so normally you don't have to 1447will still be ready when C<poll_cb> returns, so normally you don't have to
1352do anything special to have it called later. 1448do anything special to have it called later.
1449
1450Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1451ready, it can be beneficial to call this function from loops which submit
1452a lot of requests, to make sure the results get processed when they become
1453available and not just when the loop is finished and the event loop takes
1454over again. This function returns very fast when there are no outstanding
1455requests.
1353 1456
1354Example: Install an Event watcher that automatically calls 1457Example: Install an Event watcher that automatically calls
1355IO::AIO::poll_cb with high priority (more examples can be found in the 1458IO::AIO::poll_cb with high priority (more examples can be found in the
1356SYNOPSIS section, at the top of this document): 1459SYNOPSIS section, at the top of this document):
1357 1460
1459 1562
1460Under normal circumstances you don't need to call this function. 1563Under normal circumstances you don't need to call this function.
1461 1564
1462=item IO::AIO::max_idle $nthreads 1565=item IO::AIO::max_idle $nthreads
1463 1566
1464Limit the number of threads (default: 4) that are allowed to idle (i.e., 1567Limit the number of threads (default: 4) that are allowed to idle
1465threads that did not get a request to process within 10 seconds). That 1568(i.e., threads that did not get a request to process within the idle
1466means if a thread becomes idle while C<$nthreads> other threads are also 1569timeout (default: 10 seconds). That means if a thread becomes idle while
1467idle, it will free its resources and exit. 1570C<$nthreads> other threads are also idle, it will free its resources and
1571exit.
1468 1572
1469This is useful when you allow a large number of threads (e.g. 100 or 1000) 1573This is useful when you allow a large number of threads (e.g. 100 or 1000)
1470to allow for extremely high load situations, but want to free resources 1574to allow for extremely high load situations, but want to free resources
1471under normal circumstances (1000 threads can easily consume 30MB of RAM). 1575under normal circumstances (1000 threads can easily consume 30MB of RAM).
1472 1576
1473The default is probably ok in most situations, especially if thread 1577The default is probably ok in most situations, especially if thread
1474creation is fast. If thread creation is very slow on your system you might 1578creation is fast. If thread creation is very slow on your system you might
1475want to use larger values. 1579want to use larger values.
1476 1580
1581=item IO::AIO::idle_timeout $seconds
1582
1583Sets the minimum idle timeout (default 10) after which worker threads are
1584allowed to exit. SEe C<IO::AIO::max_idle>.
1585
1477=item IO::AIO::max_outstanding $maxreqs 1586=item IO::AIO::max_outstanding $maxreqs
1587
1588Sets the maximum number of outstanding requests to C<$nreqs>. If
1589you do queue up more than this number of requests, the next call to
1590C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as
1591C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no
1592longer exceeded.
1593
1594In other words, this setting does not enforce a queue limit, but can be
1595used to make poll functions block if the limit is exceeded.
1478 1596
1479This is a very bad function to use in interactive programs because it 1597This is a very bad function to use in interactive programs because it
1480blocks, and a bad way to reduce concurrency because it is inexact: Better 1598blocks, and a bad way to reduce concurrency because it is inexact: Better
1481use an C<aio_group> together with a feed callback. 1599use an C<aio_group> together with a feed callback.
1482 1600
1483Sets the maximum number of outstanding requests to C<$nreqs>. If you 1601It's main use is in scripts without an event loop - when you want to stat
1484do queue up more than this number of requests, the next call to the 1602a lot of files, you can write somehting like this:
1485C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1486function will block until the limit is no longer exceeded.
1487 1603
1488The default value is very large, so there is no practical limit on the 1604 IO::AIO::max_outstanding 32;
1489number of outstanding requests.
1490 1605
1491You can still queue as many requests as you want. Therefore, 1606 for my $path (...) {
1492C<max_outstanding> is mainly useful in simple scripts (with low values) or 1607 aio_stat $path , ...;
1493as a stop gap to shield against fatal memory overflow (with large values). 1608 IO::AIO::poll_cb;
1609 }
1610
1611 IO::AIO::flush;
1612
1613The call to C<poll_cb> inside the loop will normally return instantly, but
1614as soon as more thna C<32> reqeusts are in-flight, it will block until
1615some requests have been handled. This keeps the loop from pushing a large
1616number of C<aio_stat> requests onto the queue.
1617
1618The default value for C<max_outstanding> is very large, so there is no
1619practical limit on the number of outstanding requests.
1494 1620
1495=back 1621=back
1496 1622
1497=head3 STATISTICAL INFORMATION 1623=head3 STATISTICAL INFORMATION
1498 1624
1536 1662
1537Returns the number of bytes copied, or C<-1> on error. 1663Returns the number of bytes copied, or C<-1> on error.
1538 1664
1539=item IO::AIO::fadvise $fh, $offset, $len, $advice 1665=item IO::AIO::fadvise $fh, $offset, $len, $advice
1540 1666
1541Simply calls the C<posix_fadvise> function (see it's 1667Simply calls the C<posix_fadvise> function (see its
1542manpage for details). The following advice constants are 1668manpage for details). The following advice constants are
1543avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, 1669avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1544C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, 1670C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1545C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. 1671C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1546 1672
1547On systems that do not implement C<posix_fadvise>, this function returns 1673On systems that do not implement C<posix_fadvise>, this function returns
1548ENOSYS, otherwise the return value of C<posix_fadvise>. 1674ENOSYS, otherwise the return value of C<posix_fadvise>.
1549 1675
1550=item IO::AIO::mlockall $flags 1676=item IO::AIO::madvise $scalar, $offset, $len, $advice
1551 1677
1552Calls the C<mlockall> function with the given C<$flags> (a combination of 1678Simply calls the C<posix_madvise> function (see its
1553C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL__FUTURE>). 1679manpage for details). The following advice constants are
1680avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1681C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
1554 1682
1683On systems that do not implement C<posix_madvise>, this function returns
1684ENOSYS, otherwise the return value of C<posix_madvise>.
1685
1686=item IO::AIO::mprotect $scalar, $offset, $len, $protect
1687
1688Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1689$scalar (see its manpage for details). The following protect
1690constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1691C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1692
1555On systems that do not implement C<mlockall>, this function returns 1693On systems that do not implement C<mprotect>, this function returns
1556ENOSYS, otherwise the return value of C<mlockall>. 1694ENOSYS, otherwise the return value of C<mprotect>.
1695
1696=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1697
1698Memory-maps a file (or anonymous memory range) and attaches it to the
1699given C<$scalar>, which will act like a string scalar.
1700
1701The only operations allowed on the scalar are C<substr>/C<vec> that don't
1702change the string length, and most read-only operations such as copying it
1703or searching it with regexes and so on.
1704
1705Anything else is unsafe and will, at best, result in memory leaks.
1706
1707The memory map associated with the C<$scalar> is automatically removed
1708when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
1709C<IO::AIO::munmap> functions are called.
1710
1711This calls the C<mmap>(2) function internally. See your system's manual
1712page for details on the C<$length>, C<$prot> and C<$flags> parameters.
1713
1714The C<$length> must be larger than zero and smaller than the actual
1715filesize.
1716
1717C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1718C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1719
1720C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
1721C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
1722not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
1723(which is set to C<MAP_ANON> if your system only provides this
1724constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
1725C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
1726C<IO::AIO::MAP_NONBLOCK>
1727
1728If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1729
1730C<$offset> is the offset from the start of the file - it generally must be
1731a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
1732
1733Example:
1734
1735 use Digest::MD5;
1736 use IO::AIO;
1737
1738 open my $fh, "<verybigfile"
1739 or die "$!";
1740
1741 IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
1742 or die "verybigfile: $!";
1743
1744 my $fast_md5 = md5 $data;
1745
1746=item IO::AIO::munmap $scalar
1747
1748Removes a previous mmap and undefines the C<$scalar>.
1749
1750=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
1751
1752Calls the C<munlock> function, undoing the effects of a previous
1753C<aio_mlock> call (see its description for details).
1557 1754
1558=item IO::AIO::munlockall 1755=item IO::AIO::munlockall
1559 1756
1560Calls the C<munlockall> function. 1757Calls the C<munlockall> function.
1561 1758
1603 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => 1800 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
1604 \&IO::AIO::poll_cb); 1801 \&IO::AIO::poll_cb);
1605 1802
1606=head2 FORK BEHAVIOUR 1803=head2 FORK BEHAVIOUR
1607 1804
1608This module should do "the right thing" when the process using it forks: 1805Usage of pthreads in a program changes the semantics of fork
1806considerably. Specifically, only async-safe functions can be called after
1807fork. Perl doesn't know about this, so in general, you cannot call fork
1808with defined behaviour in perl. IO::AIO uses pthreads, so this applies,
1809but many other extensions and (for inexplicable reasons) perl itself often
1810is linked against pthreads, so this limitation applies.
1609 1811
1610Before the fork, IO::AIO enters a quiescent state where no requests 1812Some operating systems have extensions that allow safe use of fork, and
1611can be added in other threads and no results will be processed. After 1813this module should do "the right thing" on those, and tries on others. At
1612the fork the parent simply leaves the quiescent state and continues 1814the time of this writing (2011) only GNU/Linux supports these extensions
1613request/result processing, while the child frees the request/result queue 1815to POSIX.
1614(so that the requests started before the fork will only be handled in the
1615parent). Threads will be started on demand until the limit set in the
1616parent process has been reached again.
1617
1618In short: the parent will, after a short pause, continue as if fork had
1619not been called, while the child will act as if IO::AIO has not been used
1620yet.
1621 1816
1622=head2 MEMORY USAGE 1817=head2 MEMORY USAGE
1623 1818
1624Per-request usage: 1819Per-request usage:
1625 1820

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines