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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines