… | |
… | |
168 | use common::sense; |
168 | use common::sense; |
169 | |
169 | |
170 | use base 'Exporter'; |
170 | use base 'Exporter'; |
171 | |
171 | |
172 | BEGIN { |
172 | BEGIN { |
173 | our $VERSION = '3.65'; |
173 | our $VERSION = '4.0'; |
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 |
178 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
178 | aio_fsync aio_syncfs 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_mlock aio_mlockall |
183 | aio_msync aio_mtouch aio_mlock aio_mlockall |
183 | aio_statvfs); |
184 | aio_statvfs |
|
|
185 | aio_wd); |
184 | |
186 | |
185 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
187 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
186 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
188 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
187 | min_parallel max_parallel max_idle |
189 | min_parallel max_parallel max_idle idle_timeout |
188 | nreqs nready npending nthreads |
190 | nreqs nready npending nthreads |
189 | max_poll_time max_poll_reqs |
191 | max_poll_time max_poll_reqs |
190 | sendfile fadvise madvise |
192 | sendfile fadvise madvise |
191 | mmap munmap munlock munlockall); |
193 | mmap munmap munlock munlockall); |
192 | |
194 | |
… | |
… | |
204 | |
206 | |
205 | This section simply lists the prototypes of the most important functions |
207 | This section simply lists the prototypes of the most important functions |
206 | for quick reference. See the following sections for function-by-function |
208 | for quick reference. See the following sections for function-by-function |
207 | documentation. |
209 | documentation. |
208 | |
210 | |
|
|
211 | aio_wd $pathname, $callback->($wd) |
209 | aio_open $pathname, $flags, $mode, $callback->($fh) |
212 | aio_open $pathname, $flags, $mode, $callback->($fh) |
210 | aio_close $fh, $callback->($status) |
213 | aio_close $fh, $callback->($status) |
211 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
214 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
212 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
215 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
213 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
216 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
… | |
… | |
222 | aio_unlink $pathname, $callback->($status) |
225 | aio_unlink $pathname, $callback->($status) |
223 | aio_mknod $path, $mode, $dev, $callback->($status) |
226 | aio_mknod $path, $mode, $dev, $callback->($status) |
224 | aio_link $srcpath, $dstpath, $callback->($status) |
227 | aio_link $srcpath, $dstpath, $callback->($status) |
225 | aio_symlink $srcpath, $dstpath, $callback->($status) |
228 | aio_symlink $srcpath, $dstpath, $callback->($status) |
226 | aio_readlink $path, $callback->($link) |
229 | aio_readlink $path, $callback->($link) |
|
|
230 | aio_realpath $path, $callback->($link) |
227 | aio_rename $srcpath, $dstpath, $callback->($status) |
231 | aio_rename $srcpath, $dstpath, $callback->($status) |
228 | aio_mkdir $pathname, $mode, $callback->($status) |
232 | aio_mkdir $pathname, $mode, $callback->($status) |
229 | aio_rmdir $pathname, $callback->($status) |
233 | aio_rmdir $pathname, $callback->($status) |
230 | aio_readdir $pathname, $callback->($entries) |
234 | aio_readdir $pathname, $callback->($entries) |
231 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
235 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
… | |
… | |
235 | aio_copy $srcpath, $dstpath, $callback->($status) |
239 | aio_copy $srcpath, $dstpath, $callback->($status) |
236 | aio_move $srcpath, $dstpath, $callback->($status) |
240 | aio_move $srcpath, $dstpath, $callback->($status) |
237 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
241 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
238 | aio_rmtree $path, $callback->($status) |
242 | aio_rmtree $path, $callback->($status) |
239 | aio_sync $callback->($status) |
243 | aio_sync $callback->($status) |
|
|
244 | aio_syncfs $fh, $callback->($status) |
240 | aio_fsync $fh, $callback->($status) |
245 | aio_fsync $fh, $callback->($status) |
241 | aio_fdatasync $fh, $callback->($status) |
246 | aio_fdatasync $fh, $callback->($status) |
242 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
247 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
243 | aio_pathsync $path, $callback->($status) |
248 | aio_pathsync $path, $callback->($status) |
244 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
249 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
… | |
… | |
258 | IO::AIO::max_poll_reqs $nreqs |
263 | IO::AIO::max_poll_reqs $nreqs |
259 | IO::AIO::max_poll_time $seconds |
264 | IO::AIO::max_poll_time $seconds |
260 | IO::AIO::min_parallel $nthreads |
265 | IO::AIO::min_parallel $nthreads |
261 | IO::AIO::max_parallel $nthreads |
266 | IO::AIO::max_parallel $nthreads |
262 | IO::AIO::max_idle $nthreads |
267 | IO::AIO::max_idle $nthreads |
|
|
268 | IO::AIO::idle_timeout $seconds |
263 | IO::AIO::max_outstanding $maxreqs |
269 | IO::AIO::max_outstanding $maxreqs |
264 | IO::AIO::nreqs |
270 | IO::AIO::nreqs |
265 | IO::AIO::nready |
271 | IO::AIO::nready |
266 | IO::AIO::npending |
272 | IO::AIO::npending |
267 | |
273 | |
268 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
274 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
269 | IO::AIO::fadvise $fh, $offset, $len, $advice |
275 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
276 | IO::AIO::madvise $scalar, $offset, $length, $advice |
|
|
277 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
270 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
278 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
271 | IO::AIO::munlockall |
279 | IO::AIO::munlockall |
272 | |
280 | |
273 | =head2 AIO REQUEST FUNCTIONS |
281 | =head2 AIO REQUEST FUNCTIONS |
274 | |
282 | |
… | |
… | |
365 | } else { |
373 | } else { |
366 | die "open failed: $!\n"; |
374 | die "open failed: $!\n"; |
367 | } |
375 | } |
368 | }; |
376 | }; |
369 | |
377 | |
|
|
378 | In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>, |
|
|
379 | C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the |
|
|
380 | following POSIX and non-POSIX constants are available (missing ones on |
|
|
381 | your system are, as usual, C<0>): |
|
|
382 | |
|
|
383 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
|
|
384 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
|
|
385 | C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>. |
|
|
386 | |
370 | |
387 | |
371 | =item aio_close $fh, $callback->($status) |
388 | =item aio_close $fh, $callback->($status) |
372 | |
389 | |
373 | Asynchronously close a file and call the callback with the result |
390 | Asynchronously close a file and call the callback with the result |
374 | code. |
391 | code. |
… | |
… | |
424 | |
441 | |
425 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
442 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
426 | reading at byte offset C<$in_offset>, and starts writing at the current |
443 | reading at byte offset C<$in_offset>, and starts writing at the current |
427 | file offset of C<$out_fh>. Because of that, it is not safe to issue more |
444 | file offset of C<$out_fh>. Because of that, it is not safe to issue more |
428 | than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each |
445 | than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each |
429 | other. |
446 | other. The same C<$in_fh> works fine though, as this function does not |
|
|
447 | move or use the file offset of C<$in_fh>. |
430 | |
448 | |
|
|
449 | Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than |
|
|
450 | are written, and there is no way to find out how many more bytes have been |
|
|
451 | read from C<aio_sendfile> alone, as C<aio_sendfile> only provides the |
|
|
452 | number of bytes written to C<$out_fh>. Only if the result value equals |
|
|
453 | C<$length> one can assume that C<$length> bytes have been read. |
|
|
454 | |
|
|
455 | Unlike with other C<aio_> functions, it makes a lot of sense to use |
|
|
456 | C<aio_sendfile> on non-blocking sockets, as long as one end (typically |
|
|
457 | the C<$in_fh>) is a file - the file I/O will then be asynchronous, while |
|
|
458 | the socket I/O will be non-blocking. Note, however, that you can run |
|
|
459 | into a trap where C<aio_sendfile> reads some data with readahead, then |
|
|
460 | fails to write all data, and when the socket is ready the next time, the |
|
|
461 | data in the cache is already lost, forcing C<aio_sendfile> to again hit |
|
|
462 | the disk. Explicit C<aio_read> + C<aio_write> let's you better control |
|
|
463 | resource usage. |
|
|
464 | |
431 | This call tries to make use of a native C<sendfile> syscall to provide |
465 | This call tries to make use of a native C<sendfile>-like syscall to |
432 | zero-copy operation. For this to work, C<$out_fh> should refer to a |
466 | provide zero-copy operation. For this to work, C<$out_fh> should refer to |
433 | socket, and C<$in_fh> should refer to an mmap'able file. |
467 | a socket, and C<$in_fh> should refer to an mmap'able file. |
434 | |
468 | |
435 | If a native sendfile cannot be found or it fails with C<ENOSYS>, |
469 | If a native sendfile cannot be found or it fails with C<ENOSYS>, |
436 | C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>, |
470 | C<EINVAL>, C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or |
437 | it will be emulated, so you can call C<aio_sendfile> on any type of |
471 | C<ENOTSOCK>, it will be emulated, so you can call C<aio_sendfile> on any |
438 | filehandle regardless of the limitations of the operating system. |
472 | type of filehandle regardless of the limitations of the operating system. |
439 | |
473 | |
440 | Please note, however, that C<aio_sendfile> can read more bytes from |
474 | As native sendfile syscalls (as practically any non-POSIX interface hacked |
441 | C<$in_fh> than are written, and there is no way to find out how many |
475 | together in a hurry to improve benchmark numbers) tend to be rather buggy |
442 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
476 | on many systems, this implementation tries to work around some known bugs |
443 | provides the number of bytes written to C<$out_fh>. Only if the result |
477 | in Linux and FreeBSD kernels (probably others, too), but that might fail, |
444 | value equals C<$length> one can assume that C<$length> bytes have been |
478 | so you really really should check the return value of C<aio_sendfile> - |
445 | read. |
479 | fewre bytes than expected might have been transferred. |
446 | |
480 | |
447 | |
481 | |
448 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
482 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
449 | |
483 | |
450 | C<aio_readahead> populates the page cache with data from a file so that |
484 | C<aio_readahead> populates the page cache with data from a file so that |
… | |
… | |
472 | for an explanation. |
506 | for an explanation. |
473 | |
507 | |
474 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
508 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
475 | error when stat'ing a large file, the results will be silently truncated |
509 | error when stat'ing a large file, the results will be silently truncated |
476 | unless perl itself is compiled with large file support. |
510 | unless perl itself is compiled with large file support. |
|
|
511 | |
|
|
512 | To help interpret the mode and dev/rdev stat values, IO::AIO offers the |
|
|
513 | following constants and functions (if not implemented, the constants will |
|
|
514 | be C<0> and the functions will either C<croak> or fall back on traditional |
|
|
515 | behaviour). |
|
|
516 | |
|
|
517 | C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, |
|
|
518 | C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, |
|
|
519 | C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. |
477 | |
520 | |
478 | Example: Print the length of F</etc/passwd>: |
521 | Example: Print the length of F</etc/passwd>: |
479 | |
522 | |
480 | aio_stat "/etc/passwd", sub { |
523 | aio_stat "/etc/passwd", sub { |
481 | $_[0] and die "stat failed: $!"; |
524 | $_[0] and die "stat failed: $!"; |
… | |
… | |
583 | |
626 | |
584 | The only (POSIX-) portable way of calling this function is: |
627 | The only (POSIX-) portable way of calling this function is: |
585 | |
628 | |
586 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
629 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
587 | |
630 | |
|
|
631 | See C<aio_stat> for info about some potentially helpful extra constants |
|
|
632 | and functions. |
588 | |
633 | |
589 | =item aio_link $srcpath, $dstpath, $callback->($status) |
634 | =item aio_link $srcpath, $dstpath, $callback->($status) |
590 | |
635 | |
591 | Asynchronously create a new link to the existing object at C<$srcpath> at |
636 | Asynchronously create a new link to the existing object at C<$srcpath> at |
592 | the path C<$dstpath> and call the callback with the result code. |
637 | the path C<$dstpath> and call the callback with the result code. |
… | |
… | |
603 | Asynchronously read the symlink specified by C<$path> and pass it to |
648 | Asynchronously read the symlink specified by C<$path> and pass it to |
604 | the callback. If an error occurs, nothing or undef gets passed to the |
649 | the callback. If an error occurs, nothing or undef gets passed to the |
605 | callback. |
650 | callback. |
606 | |
651 | |
607 | |
652 | |
|
|
653 | =item aio_realpath $path, $callback->($path) |
|
|
654 | |
|
|
655 | Asynchronously make the path absolute and resolve any symlinks in |
|
|
656 | C<$path>. The resulting path only consists of directories (Same as |
|
|
657 | L<Cwd::realpath>). |
|
|
658 | |
|
|
659 | This request can be used to get the absolute path of the current working |
|
|
660 | directory by passing it a path of F<.> (a single dot). |
|
|
661 | |
|
|
662 | |
608 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
663 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
609 | |
664 | |
610 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
665 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
611 | rename(2) and call the callback with the result code. |
666 | rename(2) and call the callback with the result code. |
612 | |
667 | |
… | |
… | |
634 | array-ref with the filenames. |
689 | array-ref with the filenames. |
635 | |
690 | |
636 | |
691 | |
637 | =item aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
692 | =item aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
638 | |
693 | |
639 | Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune |
694 | Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to |
640 | behaviour and output format. In case of an error, C<$entries> will be |
695 | tune behaviour and output format. In case of an error, C<$entries> will be |
641 | C<undef>. |
696 | C<undef>. |
642 | |
697 | |
643 | The flags are a combination of the following constants, ORed together (the |
698 | The flags are a combination of the following constants, ORed together (the |
644 | flags will also be passed to the callback, possibly modified): |
699 | flags will also be passed to the callback, possibly modified): |
645 | |
700 | |
646 | =over 4 |
701 | =over 4 |
647 | |
702 | |
648 | =item IO::AIO::READDIR_DENTS |
703 | =item IO::AIO::READDIR_DENTS |
649 | |
704 | |
650 | When this flag is off, then the callback gets an arrayref with of names |
705 | When this flag is off, then the callback gets an arrayref consisting of |
651 | only (as with C<aio_readdir>), otherwise it gets an arrayref with |
706 | names only (as with C<aio_readdir>), otherwise it gets an arrayref with |
652 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
707 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
653 | entry in more detail. |
708 | entry in more detail. |
654 | |
709 | |
655 | C<$name> is the name of the entry. |
710 | C<$name> is the name of the entry. |
656 | |
711 | |
… | |
… | |
669 | systems that do not deliver the inode information. |
724 | systems that do not deliver the inode information. |
670 | |
725 | |
671 | =item IO::AIO::READDIR_DIRS_FIRST |
726 | =item IO::AIO::READDIR_DIRS_FIRST |
672 | |
727 | |
673 | When this flag is set, then the names will be returned in an order where |
728 | When this flag is set, then the names will be returned in an order where |
674 | likely directories come first. This is useful when you need to quickly |
729 | likely directories come first, in optimal stat order. This is useful when |
675 | find directories, or you want to find all directories while avoiding to |
730 | you need to quickly find directories, or you want to find all directories |
676 | stat() each entry. |
731 | while avoiding to stat() each entry. |
677 | |
732 | |
678 | If the system returns type information in readdir, then this is used |
733 | If the system returns type information in readdir, then this is used |
679 | to find directories directly. Otherwise, likely directories are files |
734 | to find directories directly. Otherwise, likely directories are names |
680 | beginning with ".", or otherwise files with no dots, of which files with |
735 | beginning with ".", or otherwise names with no dots, of which names with |
681 | short names are tried first. |
736 | short names are tried first. |
682 | |
737 | |
683 | =item IO::AIO::READDIR_STAT_ORDER |
738 | =item IO::AIO::READDIR_STAT_ORDER |
684 | |
739 | |
685 | When this flag is set, then the names will be returned in an order |
740 | When this flag is set, then the names will be returned in an order |
… | |
… | |
692 | |
747 | |
693 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
748 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
694 | |
749 | |
695 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
750 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
696 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
751 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
697 | C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all |
752 | C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all |
698 | C<$type>'s are known, which can be used to speed up some algorithms. |
753 | C<$type>'s are known, which can be used to speed up some algorithms. |
699 | |
754 | |
700 | =back |
755 | =back |
701 | |
756 | |
702 | |
757 | |
… | |
… | |
830 | if ($_[0] && $! == EXDEV) { |
885 | if ($_[0] && $! == EXDEV) { |
831 | aioreq_pri $pri; |
886 | aioreq_pri $pri; |
832 | add $grp aio_copy $src, $dst, sub { |
887 | add $grp aio_copy $src, $dst, sub { |
833 | $grp->result ($_[0]); |
888 | $grp->result ($_[0]); |
834 | |
889 | |
835 | if (!$_[0]) { |
890 | unless ($_[0]) { |
836 | aioreq_pri $pri; |
891 | aioreq_pri $pri; |
837 | add $grp aio_unlink $src; |
892 | add $grp aio_unlink $src; |
838 | } |
893 | } |
839 | }; |
894 | }; |
840 | } else { |
895 | } else { |
… | |
… | |
884 | Then entries will be sorted into likely directories a non-initial dot |
939 | Then entries will be sorted into likely directories a non-initial dot |
885 | currently) and likely non-directories (see C<aio_readdirx>). Then every |
940 | currently) and likely non-directories (see C<aio_readdirx>). Then every |
886 | entry plus an appended C</.> will be C<stat>'ed, likely directories first, |
941 | entry plus an appended C</.> will be C<stat>'ed, likely directories first, |
887 | in order of their inode numbers. If that succeeds, it assumes that the |
942 | in order of their inode numbers. If that succeeds, it assumes that the |
888 | entry is a directory or a symlink to directory (which will be checked |
943 | entry is a directory or a symlink to directory (which will be checked |
889 | seperately). This is often faster than stat'ing the entry itself because |
944 | separately). This is often faster than stat'ing the entry itself because |
890 | filesystems might detect the type of the entry without reading the inode |
945 | filesystems might detect the type of the entry without reading the inode |
891 | data (e.g. ext2fs filetype feature), even on systems that cannot return |
946 | data (e.g. ext2fs filetype feature), even on systems that cannot return |
892 | the filetype information on readdir. |
947 | the filetype information on readdir. |
893 | |
948 | |
894 | If the known number of directories (link count - 2) has been reached, the |
949 | If the known number of directories (link count - 2) has been reached, the |
… | |
… | |
1032 | callback with the fdatasync result code. |
1087 | callback with the fdatasync result code. |
1033 | |
1088 | |
1034 | If this call isn't available because your OS lacks it or it couldn't be |
1089 | If this call isn't available because your OS lacks it or it couldn't be |
1035 | detected, it will be emulated by calling C<fsync> instead. |
1090 | detected, it will be emulated by calling C<fsync> instead. |
1036 | |
1091 | |
|
|
1092 | =item aio_syncfs $fh, $callback->($status) |
|
|
1093 | |
|
|
1094 | Asynchronously call the syncfs syscall to sync the filesystem associated |
|
|
1095 | to the given filehandle and call the callback with the syncfs result |
|
|
1096 | code. If syncfs is not available, calls sync(), but returns C<-1> and sets |
|
|
1097 | errno to C<ENOSYS> nevertheless. |
|
|
1098 | |
1037 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
1099 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
1038 | |
1100 | |
1039 | Sync the data portion of the file specified by C<$offset> and C<$length> |
1101 | Sync the data portion of the file specified by C<$offset> and C<$length> |
1040 | to disk (but NOT the metadata), by calling the Linux-specific |
1102 | to disk (but NOT the metadata), by calling the Linux-specific |
1041 | sync_file_range call. If sync_file_range is not available or it returns |
1103 | sync_file_range call. If sync_file_range is not available or it returns |
… | |
… | |
1128 | and sets errno to C<ENOSYS>. |
1190 | and sets errno to C<ENOSYS>. |
1129 | |
1191 | |
1130 | Note that the corresponding C<munlock> is synchronous and is |
1192 | Note that the corresponding C<munlock> is synchronous and is |
1131 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1193 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1132 | |
1194 | |
|
|
1195 | Example: open a file, mmap and mlock it - both will be undone when |
|
|
1196 | C<$data> gets destroyed. |
|
|
1197 | |
|
|
1198 | open my $fh, "<", $path or die "$path: $!"; |
|
|
1199 | my $data; |
|
|
1200 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
|
|
1201 | aio_mlock $data; # mlock in background |
|
|
1202 | |
1133 | =item aio_mlockall $flags, $callback->($status) |
1203 | =item aio_mlockall $flags, $callback->($status) |
1134 | |
1204 | |
1135 | Calls the C<mlockall> function with the given C<$flags> (a combination of |
1205 | Calls the C<mlockall> function with the given C<$flags> (a combination of |
1136 | C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>). |
1206 | C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>). |
1137 | |
1207 | |
1138 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1208 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1139 | and sets errno to C<ENOSYS>. |
1209 | and sets errno to C<ENOSYS>. |
1140 | |
1210 | |
1141 | Note that the corresponding C<munlockall> is synchronous and is |
1211 | Note that the corresponding C<munlockall> is synchronous and is |
1142 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1212 | documented under L<MISCELLANEOUS FUNCTIONS>. |
|
|
1213 | |
|
|
1214 | Example: asynchronously lock all current and future pages into memory. |
|
|
1215 | |
|
|
1216 | aio_mlockall IO::AIO::MCL_FUTURE; |
1143 | |
1217 | |
1144 | =item aio_group $callback->(...) |
1218 | =item aio_group $callback->(...) |
1145 | |
1219 | |
1146 | This is a very special aio request: Instead of doing something, it is a |
1220 | This is a very special aio request: Instead of doing something, it is a |
1147 | container for other aio requests, which is useful if you want to bundle |
1221 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
1371 | |
1445 | |
1372 | See C<poll_cb> for an example. |
1446 | See C<poll_cb> for an example. |
1373 | |
1447 | |
1374 | =item IO::AIO::poll_cb |
1448 | =item IO::AIO::poll_cb |
1375 | |
1449 | |
1376 | Process some outstanding events on the result pipe. You have to call this |
1450 | Process some outstanding events on the result pipe. You have to call |
1377 | regularly. Returns C<0> if all events could be processed, or C<-1> if it |
1451 | this regularly. Returns C<0> if all events could be processed (or there |
1378 | returned earlier for whatever reason. Returns immediately when no events |
1452 | were no events to process), or C<-1> if it returned earlier for whatever |
1379 | are outstanding. The amount of events processed depends on the settings of |
1453 | reason. Returns immediately when no events are outstanding. The amount of |
1380 | C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1454 | events processed depends on the settings of C<IO::AIO::max_poll_req> and |
|
|
1455 | C<IO::AIO::max_poll_time>. |
1381 | |
1456 | |
1382 | If not all requests were processed for whatever reason, the filehandle |
1457 | If not all requests were processed for whatever reason, the filehandle |
1383 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1458 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1384 | do anything special to have it called later. |
1459 | do anything special to have it called later. |
|
|
1460 | |
|
|
1461 | Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes |
|
|
1462 | ready, it can be beneficial to call this function from loops which submit |
|
|
1463 | a lot of requests, to make sure the results get processed when they become |
|
|
1464 | available and not just when the loop is finished and the event loop takes |
|
|
1465 | over again. This function returns very fast when there are no outstanding |
|
|
1466 | requests. |
1385 | |
1467 | |
1386 | Example: Install an Event watcher that automatically calls |
1468 | Example: Install an Event watcher that automatically calls |
1387 | IO::AIO::poll_cb with high priority (more examples can be found in the |
1469 | IO::AIO::poll_cb with high priority (more examples can be found in the |
1388 | SYNOPSIS section, at the top of this document): |
1470 | SYNOPSIS section, at the top of this document): |
1389 | |
1471 | |
… | |
… | |
1491 | |
1573 | |
1492 | Under normal circumstances you don't need to call this function. |
1574 | Under normal circumstances you don't need to call this function. |
1493 | |
1575 | |
1494 | =item IO::AIO::max_idle $nthreads |
1576 | =item IO::AIO::max_idle $nthreads |
1495 | |
1577 | |
1496 | Limit the number of threads (default: 4) that are allowed to idle (i.e., |
1578 | Limit the number of threads (default: 4) that are allowed to idle |
1497 | threads that did not get a request to process within 10 seconds). That |
1579 | (i.e., threads that did not get a request to process within the idle |
1498 | means if a thread becomes idle while C<$nthreads> other threads are also |
1580 | timeout (default: 10 seconds). That means if a thread becomes idle while |
1499 | idle, it will free its resources and exit. |
1581 | C<$nthreads> other threads are also idle, it will free its resources and |
|
|
1582 | exit. |
1500 | |
1583 | |
1501 | This is useful when you allow a large number of threads (e.g. 100 or 1000) |
1584 | This is useful when you allow a large number of threads (e.g. 100 or 1000) |
1502 | to allow for extremely high load situations, but want to free resources |
1585 | to allow for extremely high load situations, but want to free resources |
1503 | under normal circumstances (1000 threads can easily consume 30MB of RAM). |
1586 | under normal circumstances (1000 threads can easily consume 30MB of RAM). |
1504 | |
1587 | |
1505 | The default is probably ok in most situations, especially if thread |
1588 | The default is probably ok in most situations, especially if thread |
1506 | creation is fast. If thread creation is very slow on your system you might |
1589 | creation is fast. If thread creation is very slow on your system you might |
1507 | want to use larger values. |
1590 | want to use larger values. |
1508 | |
1591 | |
|
|
1592 | =item IO::AIO::idle_timeout $seconds |
|
|
1593 | |
|
|
1594 | Sets the minimum idle timeout (default 10) after which worker threads are |
|
|
1595 | allowed to exit. SEe C<IO::AIO::max_idle>. |
|
|
1596 | |
1509 | =item IO::AIO::max_outstanding $maxreqs |
1597 | =item IO::AIO::max_outstanding $maxreqs |
|
|
1598 | |
|
|
1599 | Sets the maximum number of outstanding requests to C<$nreqs>. If |
|
|
1600 | you do queue up more than this number of requests, the next call to |
|
|
1601 | C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as |
|
|
1602 | C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no |
|
|
1603 | longer exceeded. |
|
|
1604 | |
|
|
1605 | In other words, this setting does not enforce a queue limit, but can be |
|
|
1606 | used to make poll functions block if the limit is exceeded. |
1510 | |
1607 | |
1511 | This is a very bad function to use in interactive programs because it |
1608 | This is a very bad function to use in interactive programs because it |
1512 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1609 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1513 | use an C<aio_group> together with a feed callback. |
1610 | use an C<aio_group> together with a feed callback. |
1514 | |
1611 | |
1515 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1612 | It's main use is in scripts without an event loop - when you want to stat |
1516 | do queue up more than this number of requests, the next call to the |
1613 | a lot of files, you can write somehting like this: |
1517 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
|
|
1518 | function will block until the limit is no longer exceeded. |
|
|
1519 | |
1614 | |
1520 | The default value is very large, so there is no practical limit on the |
1615 | IO::AIO::max_outstanding 32; |
1521 | number of outstanding requests. |
|
|
1522 | |
1616 | |
1523 | You can still queue as many requests as you want. Therefore, |
1617 | for my $path (...) { |
1524 | C<max_outstanding> is mainly useful in simple scripts (with low values) or |
1618 | aio_stat $path , ...; |
1525 | as a stop gap to shield against fatal memory overflow (with large values). |
1619 | IO::AIO::poll_cb; |
|
|
1620 | } |
|
|
1621 | |
|
|
1622 | IO::AIO::flush; |
|
|
1623 | |
|
|
1624 | The call to C<poll_cb> inside the loop will normally return instantly, but |
|
|
1625 | as soon as more thna C<32> reqeusts are in-flight, it will block until |
|
|
1626 | some requests have been handled. This keeps the loop from pushing a large |
|
|
1627 | number of C<aio_stat> requests onto the queue. |
|
|
1628 | |
|
|
1629 | The default value for C<max_outstanding> is very large, so there is no |
|
|
1630 | practical limit on the number of outstanding requests. |
1526 | |
1631 | |
1527 | =back |
1632 | =back |
1528 | |
1633 | |
1529 | =head3 STATISTICAL INFORMATION |
1634 | =head3 STATISTICAL INFORMATION |
1530 | |
1635 | |
… | |
… | |
1568 | |
1673 | |
1569 | Returns the number of bytes copied, or C<-1> on error. |
1674 | Returns the number of bytes copied, or C<-1> on error. |
1570 | |
1675 | |
1571 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
1676 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
1572 | |
1677 | |
1573 | Simply calls the C<posix_fadvise> function (see it's |
1678 | Simply calls the C<posix_fadvise> function (see its |
1574 | manpage for details). The following advice constants are |
1679 | manpage for details). The following advice constants are |
1575 | avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
1680 | available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
1576 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
1681 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
1577 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
1682 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
1578 | |
1683 | |
1579 | On systems that do not implement C<posix_fadvise>, this function returns |
1684 | On systems that do not implement C<posix_fadvise>, this function returns |
1580 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
1685 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
|
|
1686 | |
|
|
1687 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
|
|
1688 | |
|
|
1689 | Simply calls the C<posix_madvise> function (see its |
|
|
1690 | manpage for details). The following advice constants are |
|
|
1691 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
|
|
1692 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. |
|
|
1693 | |
|
|
1694 | On systems that do not implement C<posix_madvise>, this function returns |
|
|
1695 | ENOSYS, otherwise the return value of C<posix_madvise>. |
|
|
1696 | |
|
|
1697 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
|
|
1698 | |
|
|
1699 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
|
|
1700 | $scalar (see its manpage for details). The following protect |
|
|
1701 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
|
|
1702 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
|
|
1703 | |
|
|
1704 | On systems that do not implement C<mprotect>, this function returns |
|
|
1705 | ENOSYS, otherwise the return value of C<mprotect>. |
1581 | |
1706 | |
1582 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
1707 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
1583 | |
1708 | |
1584 | Memory-maps a file (or anonymous memory range) and attaches it to the |
1709 | Memory-maps a file (or anonymous memory range) and attaches it to the |
1585 | given C<$scalar>, which will act like a string scalar. |
1710 | given C<$scalar>, which will act like a string scalar. |
… | |
… | |
1686 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
1811 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
1687 | \&IO::AIO::poll_cb); |
1812 | \&IO::AIO::poll_cb); |
1688 | |
1813 | |
1689 | =head2 FORK BEHAVIOUR |
1814 | =head2 FORK BEHAVIOUR |
1690 | |
1815 | |
1691 | This module should do "the right thing" when the process using it forks: |
1816 | Usage of pthreads in a program changes the semantics of fork |
|
|
1817 | considerably. Specifically, only async-safe functions can be called after |
|
|
1818 | fork. Perl doesn't know about this, so in general, you cannot call fork |
|
|
1819 | with defined behaviour in perl if pthreads are involved. IO::AIO uses |
|
|
1820 | pthreads, so this applies, but many other extensions and (for inexplicable |
|
|
1821 | reasons) perl itself often is linked against pthreads, so this limitation |
|
|
1822 | applies to quite a lot of perls. |
1692 | |
1823 | |
1693 | Before the fork, IO::AIO enters a quiescent state where no requests |
1824 | This module no longer tries to fight your OS, or POSIX. That means IO::AIO |
1694 | can be added in other threads and no results will be processed. After |
1825 | only works in the process that loaded it. Forking is fully supported, but |
1695 | the fork the parent simply leaves the quiescent state and continues |
1826 | using IO::AIO in the child is not. |
1696 | request/result processing, while the child frees the request/result queue |
|
|
1697 | (so that the requests started before the fork will only be handled in the |
|
|
1698 | parent). Threads will be started on demand until the limit set in the |
|
|
1699 | parent process has been reached again. |
|
|
1700 | |
1827 | |
1701 | In short: the parent will, after a short pause, continue as if fork had |
1828 | You might get around by not I<using> IO::AIO before (or after) |
1702 | not been called, while the child will act as if IO::AIO has not been used |
1829 | forking. You could also try to call the L<IO::AIO::reinit> function in the |
1703 | yet. |
1830 | child: |
|
|
1831 | |
|
|
1832 | =over 4 |
|
|
1833 | |
|
|
1834 | =item IO::AIO::reinit |
|
|
1835 | |
|
|
1836 | Abandons all current requests and I/O threads and simply reinitialises all |
|
|
1837 | data structures. This is not an operation supported by any standards, but |
|
|
1838 | happens to work on GNU/Linux and some newer BSD systems. |
|
|
1839 | |
|
|
1840 | The only reasonable use for this function is to call it after forking, if |
|
|
1841 | C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in |
|
|
1842 | the process will result in undefined behaviour. Calling it at any time |
|
|
1843 | will also result in any undefined (by POSIX) behaviour. |
|
|
1844 | |
|
|
1845 | =back |
1704 | |
1846 | |
1705 | =head2 MEMORY USAGE |
1847 | =head2 MEMORY USAGE |
1706 | |
1848 | |
1707 | Per-request usage: |
1849 | Per-request usage: |
1708 | |
1850 | |