… | |
… | |
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.7'; |
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 | |
… | |
… | |
366 | ... |
367 | ... |
367 | } else { |
368 | } else { |
368 | die "open failed: $!\n"; |
369 | die "open failed: $!\n"; |
369 | } |
370 | } |
370 | }; |
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>. |
371 | |
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 |
… | |
… | |
483 | for an explanation. |
493 | for an explanation. |
484 | |
494 | |
485 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
495 | 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 |
496 | error when stat'ing a large file, the results will be silently truncated |
487 | unless perl itself is compiled with large file support. |
497 | unless perl itself is compiled with large file support. |
|
|
498 | |
|
|
499 | To help interpret the mode and dev/rdev stat values, IO::AIO offers the |
|
|
500 | following constants and functions (if not implemented, the constants will |
|
|
501 | be C<0> and the functions will either C<croak> or fall back on traditional |
|
|
502 | behaviour). |
|
|
503 | |
|
|
504 | C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, |
|
|
505 | C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, |
|
|
506 | C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. |
488 | |
507 | |
489 | Example: Print the length of F</etc/passwd>: |
508 | Example: Print the length of F</etc/passwd>: |
490 | |
509 | |
491 | aio_stat "/etc/passwd", sub { |
510 | aio_stat "/etc/passwd", sub { |
492 | $_[0] and die "stat failed: $!"; |
511 | $_[0] and die "stat failed: $!"; |
… | |
… | |
594 | |
613 | |
595 | The only (POSIX-) portable way of calling this function is: |
614 | The only (POSIX-) portable way of calling this function is: |
596 | |
615 | |
597 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
616 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
598 | |
617 | |
|
|
618 | See C<aio_stat> for info about some potentially helpful extra constants |
|
|
619 | and functions. |
599 | |
620 | |
600 | =item aio_link $srcpath, $dstpath, $callback->($status) |
621 | =item aio_link $srcpath, $dstpath, $callback->($status) |
601 | |
622 | |
602 | Asynchronously create a new link to the existing object at C<$srcpath> at |
623 | 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. |
624 | the path C<$dstpath> and call the callback with the result code. |
… | |
… | |
656 | |
677 | |
657 | =over 4 |
678 | =over 4 |
658 | |
679 | |
659 | =item IO::AIO::READDIR_DENTS |
680 | =item IO::AIO::READDIR_DENTS |
660 | |
681 | |
661 | When this flag is off, then the callback gets an arrayref with of names |
682 | 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 |
683 | names only (as with C<aio_readdir>), otherwise it gets an arrayref with |
663 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
684 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
664 | entry in more detail. |
685 | entry in more detail. |
665 | |
686 | |
666 | C<$name> is the name of the entry. |
687 | C<$name> is the name of the entry. |
667 | |
688 | |
… | |
… | |
680 | systems that do not deliver the inode information. |
701 | systems that do not deliver the inode information. |
681 | |
702 | |
682 | =item IO::AIO::READDIR_DIRS_FIRST |
703 | =item IO::AIO::READDIR_DIRS_FIRST |
683 | |
704 | |
684 | When this flag is set, then the names will be returned in an order where |
705 | 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 |
706 | 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 |
707 | you need to quickly find directories, or you want to find all directories |
687 | stat() each entry. |
708 | while avoiding to stat() each entry. |
688 | |
709 | |
689 | If the system returns type information in readdir, then this is used |
710 | If the system returns type information in readdir, then this is used |
690 | to find directories directly. Otherwise, likely directories are files |
711 | to find directories directly. Otherwise, likely directories are names |
691 | beginning with ".", or otherwise files with no dots, of which files with |
712 | beginning with ".", or otherwise names with no dots, of which names with |
692 | short names are tried first. |
713 | short names are tried first. |
693 | |
714 | |
694 | =item IO::AIO::READDIR_STAT_ORDER |
715 | =item IO::AIO::READDIR_STAT_ORDER |
695 | |
716 | |
696 | When this flag is set, then the names will be returned in an order |
717 | When this flag is set, then the names will be returned in an order |
… | |
… | |
1394 | |
1415 | |
1395 | See C<poll_cb> for an example. |
1416 | See C<poll_cb> for an example. |
1396 | |
1417 | |
1397 | =item IO::AIO::poll_cb |
1418 | =item IO::AIO::poll_cb |
1398 | |
1419 | |
1399 | Process some outstanding events on the result pipe. You have to call this |
1420 | 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 |
1421 | this regularly. Returns C<0> if all events could be processed (or there |
1401 | returned earlier for whatever reason. Returns immediately when no events |
1422 | 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 |
1423 | 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>. |
1424 | events processed depends on the settings of C<IO::AIO::max_poll_req> and |
|
|
1425 | C<IO::AIO::max_poll_time>. |
1404 | |
1426 | |
1405 | If not all requests were processed for whatever reason, the filehandle |
1427 | 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 |
1428 | 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. |
1429 | do anything special to have it called later. |
|
|
1430 | |
|
|
1431 | Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes |
|
|
1432 | ready, it can be beneficial to call this function from loops which submit |
|
|
1433 | a lot of requests, to make sure the results get processed when they become |
|
|
1434 | available and not just when the loop is finished and the event loop takes |
|
|
1435 | over again. This function returns very fast when there are no outstanding |
|
|
1436 | requests. |
1408 | |
1437 | |
1409 | Example: Install an Event watcher that automatically calls |
1438 | Example: Install an Event watcher that automatically calls |
1410 | IO::AIO::poll_cb with high priority (more examples can be found in the |
1439 | IO::AIO::poll_cb with high priority (more examples can be found in the |
1411 | SYNOPSIS section, at the top of this document): |
1440 | SYNOPSIS section, at the top of this document): |
1412 | |
1441 | |
… | |
… | |
1514 | |
1543 | |
1515 | Under normal circumstances you don't need to call this function. |
1544 | Under normal circumstances you don't need to call this function. |
1516 | |
1545 | |
1517 | =item IO::AIO::max_idle $nthreads |
1546 | =item IO::AIO::max_idle $nthreads |
1518 | |
1547 | |
1519 | Limit the number of threads (default: 4) that are allowed to idle (i.e., |
1548 | 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 |
1549 | (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 |
1550 | timeout (default: 10 seconds). That means if a thread becomes idle while |
1522 | idle, it will free its resources and exit. |
1551 | C<$nthreads> other threads are also idle, it will free its resources and |
|
|
1552 | exit. |
1523 | |
1553 | |
1524 | This is useful when you allow a large number of threads (e.g. 100 or 1000) |
1554 | 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 |
1555 | to allow for extremely high load situations, but want to free resources |
1526 | under normal circumstances (1000 threads can easily consume 30MB of RAM). |
1556 | under normal circumstances (1000 threads can easily consume 30MB of RAM). |
1527 | |
1557 | |
1528 | The default is probably ok in most situations, especially if thread |
1558 | 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 |
1559 | creation is fast. If thread creation is very slow on your system you might |
1530 | want to use larger values. |
1560 | want to use larger values. |
1531 | |
1561 | |
|
|
1562 | =item IO::AIO::idle_timeout $seconds |
|
|
1563 | |
|
|
1564 | Sets the minimum idle timeout (default 10) after which worker threads are |
|
|
1565 | allowed to exit. SEe C<IO::AIO::max_idle>. |
|
|
1566 | |
1532 | =item IO::AIO::max_outstanding $maxreqs |
1567 | =item IO::AIO::max_outstanding $maxreqs |
|
|
1568 | |
|
|
1569 | Sets the maximum number of outstanding requests to C<$nreqs>. If |
|
|
1570 | you do queue up more than this number of requests, the next call to |
|
|
1571 | C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as |
|
|
1572 | C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no |
|
|
1573 | longer exceeded. |
|
|
1574 | |
|
|
1575 | In other words, this setting does not enforce a queue limit, but can be |
|
|
1576 | used to make poll functions block if the limit is exceeded. |
1533 | |
1577 | |
1534 | This is a very bad function to use in interactive programs because it |
1578 | 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 |
1579 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1536 | use an C<aio_group> together with a feed callback. |
1580 | use an C<aio_group> together with a feed callback. |
1537 | |
1581 | |
1538 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1582 | 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 |
1583 | 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 | |
1584 | |
1543 | The default value is very large, so there is no practical limit on the |
1585 | IO::AIO::max_outstanding 32; |
1544 | number of outstanding requests. |
|
|
1545 | |
1586 | |
1546 | You can still queue as many requests as you want. Therefore, |
1587 | for my $path (...) { |
1547 | C<max_outstanding> is mainly useful in simple scripts (with low values) or |
1588 | aio_stat $path , ...; |
1548 | as a stop gap to shield against fatal memory overflow (with large values). |
1589 | IO::AIO::poll_cb; |
|
|
1590 | } |
|
|
1591 | |
|
|
1592 | IO::AIO::flush; |
|
|
1593 | |
|
|
1594 | The call to C<poll_cb> inside the loop will normally return instantly, but |
|
|
1595 | as soon as more thna C<32> reqeusts are in-flight, it will block until |
|
|
1596 | some requests have been handled. This keeps the loop from pushing a large |
|
|
1597 | number of C<aio_stat> requests onto the queue. |
|
|
1598 | |
|
|
1599 | The default value for C<max_outstanding> is very large, so there is no |
|
|
1600 | practical limit on the number of outstanding requests. |
1549 | |
1601 | |
1550 | =back |
1602 | =back |
1551 | |
1603 | |
1552 | =head3 STATISTICAL INFORMATION |
1604 | =head3 STATISTICAL INFORMATION |
1553 | |
1605 | |