… | |
… | |
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.71'; |
173 | our $VERSION = '3.9'; |
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 | |
… | |
… | |
367 | } else { |
368 | } else { |
368 | die "open failed: $!\n"; |
369 | die "open failed: $!\n"; |
369 | } |
370 | } |
370 | }; |
371 | }; |
371 | |
372 | |
|
|
373 | In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>, |
|
|
374 | C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the |
|
|
375 | following POSIX and non-POSIX constants are available (missing ones on |
|
|
376 | your system are, as usual, C<0>): |
|
|
377 | |
|
|
378 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
|
|
379 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
|
|
380 | C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>. |
|
|
381 | |
372 | |
382 | |
373 | =item aio_close $fh, $callback->($status) |
383 | =item aio_close $fh, $callback->($status) |
374 | |
384 | |
375 | Asynchronously close a file and call the callback with the result |
385 | Asynchronously close a file and call the callback with the result |
376 | code. |
386 | code. |
… | |
… | |
426 | |
436 | |
427 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
437 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
428 | reading at byte offset C<$in_offset>, and starts writing at the current |
438 | reading at byte offset C<$in_offset>, and starts writing at the current |
429 | file offset of C<$out_fh>. Because of that, it is not safe to issue more |
439 | file offset of C<$out_fh>. Because of that, it is not safe to issue more |
430 | than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each |
440 | than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each |
431 | other. |
441 | other. The same C<$in_fh> works fine though, as this function does not |
|
|
442 | move or use the file offset of C<$in_fh>. |
432 | |
443 | |
433 | Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than |
444 | Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than |
434 | are written, and there is no way to find out how many bytes have been read |
445 | are written, and there is no way to find out how many more bytes have been |
435 | from C<aio_sendfile> alone, as C<aio_sendfile> only provides the number of |
446 | read from C<aio_sendfile> alone, as C<aio_sendfile> only provides the |
436 | bytes written to C<$out_fh>. Only if the result value equals C<$length> |
447 | number of bytes written to C<$out_fh>. Only if the result value equals |
437 | one can assume that C<$length> bytes have been read. |
448 | C<$length> one can assume that C<$length> bytes have been read. |
438 | |
449 | |
439 | Unlike with other C<aio_> functions, it makes a lot of sense to use |
450 | Unlike with other C<aio_> functions, it makes a lot of sense to use |
440 | C<aio_sendfile> on non-blocking sockets, as long as one end (typically |
451 | C<aio_sendfile> on non-blocking sockets, as long as one end (typically |
441 | the C<$in_fh>) is a file - the file I/O will then be asynchronous, while |
452 | the C<$in_fh>) is a file - the file I/O will then be asynchronous, while |
442 | the socket I/O will be non-blocking. Note, however, that you can run into |
453 | the socket I/O will be non-blocking. Note, however, that you can run |
443 | a trap where C<aio_sendfile> reads some data with readahead, then fails |
454 | into a trap where C<aio_sendfile> reads some data with readahead, then |
444 | to write all data, and when the socket is ready the next time, the data |
455 | fails to write all data, and when the socket is ready the next time, the |
445 | in the cache is already lost, forcing C<aio_sendfile> to again hit the |
456 | data in the cache is already lost, forcing C<aio_sendfile> to again hit |
446 | disk. Explicit C<aio_read> + C<aio_write> let's you control resource usage |
457 | the disk. Explicit C<aio_read> + C<aio_write> let's you better control |
447 | much better. |
458 | resource usage. |
448 | |
459 | |
449 | This call tries to make use of a native C<sendfile> syscall to provide |
460 | This call tries to make use of a native C<sendfile>-like syscall to |
450 | zero-copy operation. For this to work, C<$out_fh> should refer to a |
461 | provide zero-copy operation. For this to work, C<$out_fh> should refer to |
451 | socket, and C<$in_fh> should refer to an mmap'able file. |
462 | a socket, and C<$in_fh> should refer to an mmap'able file. |
452 | |
463 | |
453 | If a native sendfile cannot be found or it fails with C<ENOSYS>, |
464 | If a native sendfile cannot be found or it fails with C<ENOSYS>, |
454 | C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>, |
465 | C<EINVAL>, C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or |
455 | it will be emulated, so you can call C<aio_sendfile> on any type of |
466 | C<ENOTSOCK>, it will be emulated, so you can call C<aio_sendfile> on any |
456 | filehandle regardless of the limitations of the operating system. |
467 | type of filehandle regardless of the limitations of the operating system. |
|
|
468 | |
|
|
469 | As native sendfile syscalls (as practically any non-POSIX interface hacked |
|
|
470 | together in a hurry to improve benchmark numbers) tend to be rather buggy |
|
|
471 | on many systems, this implementation tries to work around some known bugs |
|
|
472 | in Linux and FreeBSD kernels (probably others, too), but that might fail, |
|
|
473 | so you really really should check the return value of C<aio_sendfile> - |
|
|
474 | fewre bytes than expected might have been transferred. |
457 | |
475 | |
458 | |
476 | |
459 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
477 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
460 | |
478 | |
461 | C<aio_readahead> populates the page cache with data from a file so that |
479 | C<aio_readahead> populates the page cache with data from a file so that |
… | |
… | |
483 | for an explanation. |
501 | for an explanation. |
484 | |
502 | |
485 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
503 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
486 | error when stat'ing a large file, the results will be silently truncated |
504 | error when stat'ing a large file, the results will be silently truncated |
487 | unless perl itself is compiled with large file support. |
505 | unless perl itself is compiled with large file support. |
|
|
506 | |
|
|
507 | To help interpret the mode and dev/rdev stat values, IO::AIO offers the |
|
|
508 | following constants and functions (if not implemented, the constants will |
|
|
509 | be C<0> and the functions will either C<croak> or fall back on traditional |
|
|
510 | behaviour). |
|
|
511 | |
|
|
512 | C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, |
|
|
513 | C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, |
|
|
514 | C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. |
488 | |
515 | |
489 | Example: Print the length of F</etc/passwd>: |
516 | Example: Print the length of F</etc/passwd>: |
490 | |
517 | |
491 | aio_stat "/etc/passwd", sub { |
518 | aio_stat "/etc/passwd", sub { |
492 | $_[0] and die "stat failed: $!"; |
519 | $_[0] and die "stat failed: $!"; |
… | |
… | |
594 | |
621 | |
595 | The only (POSIX-) portable way of calling this function is: |
622 | The only (POSIX-) portable way of calling this function is: |
596 | |
623 | |
597 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
624 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
598 | |
625 | |
|
|
626 | See C<aio_stat> for info about some potentially helpful extra constants |
|
|
627 | and functions. |
599 | |
628 | |
600 | =item aio_link $srcpath, $dstpath, $callback->($status) |
629 | =item aio_link $srcpath, $dstpath, $callback->($status) |
601 | |
630 | |
602 | Asynchronously create a new link to the existing object at C<$srcpath> at |
631 | Asynchronously create a new link to the existing object at C<$srcpath> at |
603 | the path C<$dstpath> and call the callback with the result code. |
632 | the path C<$dstpath> and call the callback with the result code. |
… | |
… | |
656 | |
685 | |
657 | =over 4 |
686 | =over 4 |
658 | |
687 | |
659 | =item IO::AIO::READDIR_DENTS |
688 | =item IO::AIO::READDIR_DENTS |
660 | |
689 | |
661 | When this flag is off, then the callback gets an arrayref with of names |
690 | When this flag is off, then the callback gets an arrayref consisting of |
662 | only (as with C<aio_readdir>), otherwise it gets an arrayref with |
691 | names only (as with C<aio_readdir>), otherwise it gets an arrayref with |
663 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
692 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
664 | entry in more detail. |
693 | entry in more detail. |
665 | |
694 | |
666 | C<$name> is the name of the entry. |
695 | C<$name> is the name of the entry. |
667 | |
696 | |
… | |
… | |
680 | systems that do not deliver the inode information. |
709 | systems that do not deliver the inode information. |
681 | |
710 | |
682 | =item IO::AIO::READDIR_DIRS_FIRST |
711 | =item IO::AIO::READDIR_DIRS_FIRST |
683 | |
712 | |
684 | When this flag is set, then the names will be returned in an order where |
713 | When this flag is set, then the names will be returned in an order where |
685 | likely directories come first. This is useful when you need to quickly |
714 | likely directories come first, in optimal stat order. This is useful when |
686 | find directories, or you want to find all directories while avoiding to |
715 | you need to quickly find directories, or you want to find all directories |
687 | stat() each entry. |
716 | while avoiding to stat() each entry. |
688 | |
717 | |
689 | If the system returns type information in readdir, then this is used |
718 | If the system returns type information in readdir, then this is used |
690 | to find directories directly. Otherwise, likely directories are files |
719 | to find directories directly. Otherwise, likely directories are names |
691 | beginning with ".", or otherwise files with no dots, of which files with |
720 | beginning with ".", or otherwise names with no dots, of which names with |
692 | short names are tried first. |
721 | short names are tried first. |
693 | |
722 | |
694 | =item IO::AIO::READDIR_STAT_ORDER |
723 | =item IO::AIO::READDIR_STAT_ORDER |
695 | |
724 | |
696 | When this flag is set, then the names will be returned in an order |
725 | When this flag is set, then the names will be returned in an order |
… | |
… | |
841 | if ($_[0] && $! == EXDEV) { |
870 | if ($_[0] && $! == EXDEV) { |
842 | aioreq_pri $pri; |
871 | aioreq_pri $pri; |
843 | add $grp aio_copy $src, $dst, sub { |
872 | add $grp aio_copy $src, $dst, sub { |
844 | $grp->result ($_[0]); |
873 | $grp->result ($_[0]); |
845 | |
874 | |
846 | if (!$_[0]) { |
875 | unless ($_[0]) { |
847 | aioreq_pri $pri; |
876 | aioreq_pri $pri; |
848 | add $grp aio_unlink $src; |
877 | add $grp aio_unlink $src; |
849 | } |
878 | } |
850 | }; |
879 | }; |
851 | } else { |
880 | } else { |
… | |
… | |
1394 | |
1423 | |
1395 | See C<poll_cb> for an example. |
1424 | See C<poll_cb> for an example. |
1396 | |
1425 | |
1397 | =item IO::AIO::poll_cb |
1426 | =item IO::AIO::poll_cb |
1398 | |
1427 | |
1399 | Process some outstanding events on the result pipe. You have to call this |
1428 | Process some outstanding events on the result pipe. You have to call |
1400 | regularly. Returns C<0> if all events could be processed, or C<-1> if it |
1429 | this regularly. Returns C<0> if all events could be processed (or there |
1401 | returned earlier for whatever reason. Returns immediately when no events |
1430 | were no events to process), or C<-1> if it returned earlier for whatever |
1402 | are outstanding. The amount of events processed depends on the settings of |
1431 | reason. Returns immediately when no events are outstanding. The amount of |
1403 | C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1432 | events processed depends on the settings of C<IO::AIO::max_poll_req> and |
|
|
1433 | C<IO::AIO::max_poll_time>. |
1404 | |
1434 | |
1405 | If not all requests were processed for whatever reason, the filehandle |
1435 | If not all requests were processed for whatever reason, the filehandle |
1406 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1436 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1407 | do anything special to have it called later. |
1437 | do anything special to have it called later. |
|
|
1438 | |
|
|
1439 | Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes |
|
|
1440 | ready, it can be beneficial to call this function from loops which submit |
|
|
1441 | a lot of requests, to make sure the results get processed when they become |
|
|
1442 | available and not just when the loop is finished and the event loop takes |
|
|
1443 | over again. This function returns very fast when there are no outstanding |
|
|
1444 | requests. |
1408 | |
1445 | |
1409 | Example: Install an Event watcher that automatically calls |
1446 | Example: Install an Event watcher that automatically calls |
1410 | IO::AIO::poll_cb with high priority (more examples can be found in the |
1447 | IO::AIO::poll_cb with high priority (more examples can be found in the |
1411 | SYNOPSIS section, at the top of this document): |
1448 | SYNOPSIS section, at the top of this document): |
1412 | |
1449 | |
… | |
… | |
1514 | |
1551 | |
1515 | Under normal circumstances you don't need to call this function. |
1552 | Under normal circumstances you don't need to call this function. |
1516 | |
1553 | |
1517 | =item IO::AIO::max_idle $nthreads |
1554 | =item IO::AIO::max_idle $nthreads |
1518 | |
1555 | |
1519 | Limit the number of threads (default: 4) that are allowed to idle (i.e., |
1556 | Limit the number of threads (default: 4) that are allowed to idle |
1520 | threads that did not get a request to process within 10 seconds). That |
1557 | (i.e., threads that did not get a request to process within the idle |
1521 | means if a thread becomes idle while C<$nthreads> other threads are also |
1558 | timeout (default: 10 seconds). That means if a thread becomes idle while |
1522 | idle, it will free its resources and exit. |
1559 | C<$nthreads> other threads are also idle, it will free its resources and |
|
|
1560 | exit. |
1523 | |
1561 | |
1524 | This is useful when you allow a large number of threads (e.g. 100 or 1000) |
1562 | This is useful when you allow a large number of threads (e.g. 100 or 1000) |
1525 | to allow for extremely high load situations, but want to free resources |
1563 | to allow for extremely high load situations, but want to free resources |
1526 | under normal circumstances (1000 threads can easily consume 30MB of RAM). |
1564 | under normal circumstances (1000 threads can easily consume 30MB of RAM). |
1527 | |
1565 | |
1528 | The default is probably ok in most situations, especially if thread |
1566 | The default is probably ok in most situations, especially if thread |
1529 | creation is fast. If thread creation is very slow on your system you might |
1567 | creation is fast. If thread creation is very slow on your system you might |
1530 | want to use larger values. |
1568 | want to use larger values. |
1531 | |
1569 | |
|
|
1570 | =item IO::AIO::idle_timeout $seconds |
|
|
1571 | |
|
|
1572 | Sets the minimum idle timeout (default 10) after which worker threads are |
|
|
1573 | allowed to exit. SEe C<IO::AIO::max_idle>. |
|
|
1574 | |
1532 | =item IO::AIO::max_outstanding $maxreqs |
1575 | =item IO::AIO::max_outstanding $maxreqs |
|
|
1576 | |
|
|
1577 | Sets the maximum number of outstanding requests to C<$nreqs>. If |
|
|
1578 | you do queue up more than this number of requests, the next call to |
|
|
1579 | C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as |
|
|
1580 | C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no |
|
|
1581 | longer exceeded. |
|
|
1582 | |
|
|
1583 | In other words, this setting does not enforce a queue limit, but can be |
|
|
1584 | used to make poll functions block if the limit is exceeded. |
1533 | |
1585 | |
1534 | This is a very bad function to use in interactive programs because it |
1586 | This is a very bad function to use in interactive programs because it |
1535 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1587 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1536 | use an C<aio_group> together with a feed callback. |
1588 | use an C<aio_group> together with a feed callback. |
1537 | |
1589 | |
1538 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1590 | It's main use is in scripts without an event loop - when you want to stat |
1539 | do queue up more than this number of requests, the next call to the |
1591 | a lot of files, you can write somehting like this: |
1540 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
|
|
1541 | function will block until the limit is no longer exceeded. |
|
|
1542 | |
1592 | |
1543 | The default value is very large, so there is no practical limit on the |
1593 | IO::AIO::max_outstanding 32; |
1544 | number of outstanding requests. |
|
|
1545 | |
1594 | |
1546 | You can still queue as many requests as you want. Therefore, |
1595 | for my $path (...) { |
1547 | C<max_outstanding> is mainly useful in simple scripts (with low values) or |
1596 | aio_stat $path , ...; |
1548 | as a stop gap to shield against fatal memory overflow (with large values). |
1597 | IO::AIO::poll_cb; |
|
|
1598 | } |
|
|
1599 | |
|
|
1600 | IO::AIO::flush; |
|
|
1601 | |
|
|
1602 | The call to C<poll_cb> inside the loop will normally return instantly, but |
|
|
1603 | as soon as more thna C<32> reqeusts are in-flight, it will block until |
|
|
1604 | some requests have been handled. This keeps the loop from pushing a large |
|
|
1605 | number of C<aio_stat> requests onto the queue. |
|
|
1606 | |
|
|
1607 | The default value for C<max_outstanding> is very large, so there is no |
|
|
1608 | practical limit on the number of outstanding requests. |
1549 | |
1609 | |
1550 | =back |
1610 | =back |
1551 | |
1611 | |
1552 | =head3 STATISTICAL INFORMATION |
1612 | =head3 STATISTICAL INFORMATION |
1553 | |
1613 | |