… | |
… | |
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 = '3.72'; |
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_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 |
… | |
… | |
182 | aio_msync aio_mtouch aio_mlock aio_mlockall |
182 | aio_msync aio_mtouch aio_mlock aio_mlockall |
183 | aio_statvfs); |
183 | aio_statvfs); |
184 | |
184 | |
185 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
185 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
186 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
186 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
187 | min_parallel max_parallel max_idle |
187 | min_parallel max_parallel max_idle idle_timeout |
188 | nreqs nready npending nthreads |
188 | nreqs nready npending nthreads |
189 | max_poll_time max_poll_reqs |
189 | max_poll_time max_poll_reqs |
190 | sendfile fadvise madvise |
190 | sendfile fadvise madvise |
191 | mmap munmap munlock munlockall); |
191 | mmap munmap munlock munlockall); |
192 | |
192 | |
… | |
… | |
258 | IO::AIO::max_poll_reqs $nreqs |
258 | IO::AIO::max_poll_reqs $nreqs |
259 | IO::AIO::max_poll_time $seconds |
259 | IO::AIO::max_poll_time $seconds |
260 | IO::AIO::min_parallel $nthreads |
260 | IO::AIO::min_parallel $nthreads |
261 | IO::AIO::max_parallel $nthreads |
261 | IO::AIO::max_parallel $nthreads |
262 | IO::AIO::max_idle $nthreads |
262 | IO::AIO::max_idle $nthreads |
|
|
263 | IO::AIO::idle_timeout $seconds |
263 | IO::AIO::max_outstanding $maxreqs |
264 | IO::AIO::max_outstanding $maxreqs |
264 | IO::AIO::nreqs |
265 | IO::AIO::nreqs |
265 | IO::AIO::nready |
266 | IO::AIO::nready |
266 | IO::AIO::npending |
267 | IO::AIO::npending |
267 | |
268 | |
268 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
269 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
269 | IO::AIO::fadvise $fh, $offset, $len, $advice |
270 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
271 | IO::AIO::madvise $scalar, $offset, $length, $advice |
|
|
272 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
270 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
273 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
271 | IO::AIO::munlockall |
274 | IO::AIO::munlockall |
272 | |
275 | |
273 | =head2 AIO REQUEST FUNCTIONS |
276 | =head2 AIO REQUEST FUNCTIONS |
274 | |
277 | |
… | |
… | |
426 | reading at byte offset C<$in_offset>, and starts writing at the current |
429 | 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 |
430 | 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 |
431 | than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each |
429 | other. |
432 | other. |
430 | |
433 | |
|
|
434 | Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than |
|
|
435 | are written, and there is no way to find out how many bytes have been read |
|
|
436 | from C<aio_sendfile> alone, as C<aio_sendfile> only provides the number of |
|
|
437 | bytes written to C<$out_fh>. Only if the result value equals C<$length> |
|
|
438 | one can assume that C<$length> bytes have been read. |
|
|
439 | |
|
|
440 | Unlike with other C<aio_> functions, it makes a lot of sense to use |
|
|
441 | C<aio_sendfile> on non-blocking sockets, as long as one end (typically |
|
|
442 | the C<$in_fh>) is a file - the file I/O will then be asynchronous, while |
|
|
443 | the socket I/O will be non-blocking. Note, however, that you can run into |
|
|
444 | a trap where C<aio_sendfile> reads some data with readahead, then fails |
|
|
445 | to write all data, and when the socket is ready the next time, the data |
|
|
446 | in the cache is already lost, forcing C<aio_sendfile> to again hit the |
|
|
447 | disk. Explicit C<aio_read> + C<aio_write> let's you control resource usage |
|
|
448 | much better. |
|
|
449 | |
431 | This call tries to make use of a native C<sendfile> syscall to provide |
450 | This call tries to make use of a native C<sendfile> syscall to provide |
432 | zero-copy operation. For this to work, C<$out_fh> should refer to a |
451 | zero-copy operation. For this to work, C<$out_fh> should refer to a |
433 | socket, and C<$in_fh> should refer to an mmap'able file. |
452 | socket, and C<$in_fh> should refer to an mmap'able file. |
434 | |
453 | |
435 | If a native sendfile cannot be found or it fails with C<ENOSYS>, |
454 | 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>, |
455 | C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>, |
437 | it will be emulated, so you can call C<aio_sendfile> on any type of |
456 | it will be emulated, so you can call C<aio_sendfile> on any type of |
438 | filehandle regardless of the limitations of the operating system. |
457 | filehandle regardless of the limitations of the operating system. |
439 | |
|
|
440 | Please note, however, that C<aio_sendfile> can read more bytes from |
|
|
441 | C<$in_fh> than are written, and there is no way to find out how many |
|
|
442 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
|
|
443 | provides the number of bytes written to C<$out_fh>. Only if the result |
|
|
444 | value equals C<$length> one can assume that C<$length> bytes have been |
|
|
445 | read. |
|
|
446 | |
458 | |
447 | |
459 | |
448 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
460 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
449 | |
461 | |
450 | C<aio_readahead> populates the page cache with data from a file so that |
462 | C<aio_readahead> populates the page cache with data from a file so that |
… | |
… | |
472 | for an explanation. |
484 | for an explanation. |
473 | |
485 | |
474 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
486 | 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 |
487 | error when stat'ing a large file, the results will be silently truncated |
476 | unless perl itself is compiled with large file support. |
488 | unless perl itself is compiled with large file support. |
|
|
489 | |
|
|
490 | To help interpret the mode and dev/rdev stat values, IO::AIO offers the |
|
|
491 | following constants and functions (if not implemented, the constants will |
|
|
492 | be C<0> and the functions will either C<croak> or fall back on traditional |
|
|
493 | behaviour). |
|
|
494 | |
|
|
495 | C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, |
|
|
496 | C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, |
|
|
497 | C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. |
477 | |
498 | |
478 | Example: Print the length of F</etc/passwd>: |
499 | Example: Print the length of F</etc/passwd>: |
479 | |
500 | |
480 | aio_stat "/etc/passwd", sub { |
501 | aio_stat "/etc/passwd", sub { |
481 | $_[0] and die "stat failed: $!"; |
502 | $_[0] and die "stat failed: $!"; |
… | |
… | |
583 | |
604 | |
584 | The only (POSIX-) portable way of calling this function is: |
605 | The only (POSIX-) portable way of calling this function is: |
585 | |
606 | |
586 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
607 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
587 | |
608 | |
|
|
609 | See C<aio_stat> for info about some potentially helpful extra constants |
|
|
610 | and functions. |
588 | |
611 | |
589 | =item aio_link $srcpath, $dstpath, $callback->($status) |
612 | =item aio_link $srcpath, $dstpath, $callback->($status) |
590 | |
613 | |
591 | Asynchronously create a new link to the existing object at C<$srcpath> at |
614 | 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. |
615 | the path C<$dstpath> and call the callback with the result code. |
… | |
… | |
1503 | |
1526 | |
1504 | Under normal circumstances you don't need to call this function. |
1527 | Under normal circumstances you don't need to call this function. |
1505 | |
1528 | |
1506 | =item IO::AIO::max_idle $nthreads |
1529 | =item IO::AIO::max_idle $nthreads |
1507 | |
1530 | |
1508 | Limit the number of threads (default: 4) that are allowed to idle (i.e., |
1531 | Limit the number of threads (default: 4) that are allowed to idle |
1509 | threads that did not get a request to process within 10 seconds). That |
1532 | (i.e., threads that did not get a request to process within the idle |
1510 | means if a thread becomes idle while C<$nthreads> other threads are also |
1533 | timeout (default: 10 seconds). That means if a thread becomes idle while |
1511 | idle, it will free its resources and exit. |
1534 | C<$nthreads> other threads are also idle, it will free its resources and |
|
|
1535 | exit. |
1512 | |
1536 | |
1513 | This is useful when you allow a large number of threads (e.g. 100 or 1000) |
1537 | This is useful when you allow a large number of threads (e.g. 100 or 1000) |
1514 | to allow for extremely high load situations, but want to free resources |
1538 | to allow for extremely high load situations, but want to free resources |
1515 | under normal circumstances (1000 threads can easily consume 30MB of RAM). |
1539 | under normal circumstances (1000 threads can easily consume 30MB of RAM). |
1516 | |
1540 | |
1517 | The default is probably ok in most situations, especially if thread |
1541 | The default is probably ok in most situations, especially if thread |
1518 | creation is fast. If thread creation is very slow on your system you might |
1542 | creation is fast. If thread creation is very slow on your system you might |
1519 | want to use larger values. |
1543 | want to use larger values. |
|
|
1544 | |
|
|
1545 | =item IO::AIO::idle_timeout $seconds |
|
|
1546 | |
|
|
1547 | Sets the minimum idle timeout (default 10) after which worker threads are |
|
|
1548 | allowed to exit. SEe C<IO::AIO::max_idle>. |
1520 | |
1549 | |
1521 | =item IO::AIO::max_outstanding $maxreqs |
1550 | =item IO::AIO::max_outstanding $maxreqs |
1522 | |
1551 | |
1523 | This is a very bad function to use in interactive programs because it |
1552 | This is a very bad function to use in interactive programs because it |
1524 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1553 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
… | |
… | |
1580 | |
1609 | |
1581 | Returns the number of bytes copied, or C<-1> on error. |
1610 | Returns the number of bytes copied, or C<-1> on error. |
1582 | |
1611 | |
1583 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
1612 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
1584 | |
1613 | |
1585 | Simply calls the C<posix_fadvise> function (see it's |
1614 | Simply calls the C<posix_fadvise> function (see its |
1586 | manpage for details). The following advice constants are |
1615 | manpage for details). The following advice constants are |
1587 | avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
1616 | avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
1588 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
1617 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
1589 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
1618 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
1590 | |
1619 | |
1591 | On systems that do not implement C<posix_fadvise>, this function returns |
1620 | On systems that do not implement C<posix_fadvise>, this function returns |
1592 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
1621 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
|
|
1622 | |
|
|
1623 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
|
|
1624 | |
|
|
1625 | Simply calls the C<posix_madvise> function (see its |
|
|
1626 | manpage for details). The following advice constants are |
|
|
1627 | avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
|
|
1628 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. |
|
|
1629 | |
|
|
1630 | On systems that do not implement C<posix_madvise>, this function returns |
|
|
1631 | ENOSYS, otherwise the return value of C<posix_madvise>. |
|
|
1632 | |
|
|
1633 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
|
|
1634 | |
|
|
1635 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
|
|
1636 | $scalar (see its manpage for details). The following protect |
|
|
1637 | constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
|
|
1638 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
|
|
1639 | |
|
|
1640 | On systems that do not implement C<mprotect>, this function returns |
|
|
1641 | ENOSYS, otherwise the return value of C<mprotect>. |
1593 | |
1642 | |
1594 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
1643 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
1595 | |
1644 | |
1596 | Memory-maps a file (or anonymous memory range) and attaches it to the |
1645 | Memory-maps a file (or anonymous memory range) and attaches it to the |
1597 | given C<$scalar>, which will act like a string scalar. |
1646 | given C<$scalar>, which will act like a string scalar. |