… | |
… | |
171 | use common::sense; |
171 | use common::sense; |
172 | |
172 | |
173 | use base 'Exporter'; |
173 | use base 'Exporter'; |
174 | |
174 | |
175 | BEGIN { |
175 | BEGIN { |
176 | our $VERSION = 4.71; |
176 | our $VERSION = 4.75; |
177 | |
177 | |
178 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
178 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
179 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
179 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
180 | aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl |
180 | aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl |
181 | aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range |
181 | aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range |
… | |
… | |
278 | IO::AIO::idle_timeout $seconds |
278 | IO::AIO::idle_timeout $seconds |
279 | IO::AIO::max_outstanding $maxreqs |
279 | IO::AIO::max_outstanding $maxreqs |
280 | IO::AIO::nreqs |
280 | IO::AIO::nreqs |
281 | IO::AIO::nready |
281 | IO::AIO::nready |
282 | IO::AIO::npending |
282 | IO::AIO::npending |
|
|
283 | IO::AIO::reinit |
|
|
284 | |
283 | $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL] |
285 | $nfd = IO::AIO::get_fdlimit |
284 | IO::AIO::min_fdlimit $nfd [EXPERIMENTAL] |
286 | IO::AIO::min_fdlimit $nfd |
285 | |
287 | |
286 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
288 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
287 | IO::AIO::fadvise $fh, $offset, $len, $advice |
289 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
290 | |
288 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
291 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
289 | IO::AIO::munmap $scalar |
292 | IO::AIO::munmap $scalar |
290 | IO::AIO::mremap $scalar, $new_length, $flags[, $new_address] |
293 | IO::AIO::mremap $scalar, $new_length, $flags[, $new_address] |
291 | IO::AIO::madvise $scalar, $offset, $length, $advice |
294 | IO::AIO::madvise $scalar, $offset, $length, $advice |
292 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
295 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
293 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
296 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
294 | IO::AIO::munlockall |
297 | IO::AIO::munlockall |
|
|
298 | |
|
|
299 | # stat extensions |
|
|
300 | $counter = IO::AIO::st_gen |
|
|
301 | $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime |
|
|
302 | ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
|
|
303 | $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec |
|
|
304 | $seconds = IO::AIO::st_btimesec |
|
|
305 | ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec |
|
|
306 | |
|
|
307 | # very much unportable syscalls |
|
|
308 | IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_len, $flags |
|
|
309 | IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
|
|
310 | IO::AIO::tee $r_fh, $w_fh, $length, $flags |
|
|
311 | $actual_size = IO::AIO::pipesize $r_fh[, $new_size] |
|
|
312 | ($rfh, $wfh) = IO::AIO::pipe2 [$flags] |
|
|
313 | $fh = IO::AIO::memfd_create $pathname[, $flags] |
|
|
314 | $fh = IO::AIO::eventfd [$initval, [$flags]] |
|
|
315 | $fh = IO::AIO::timerfd_create $clockid[, $flags] |
|
|
316 | ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value |
|
|
317 | ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh |
295 | |
318 | |
296 | =head2 API NOTES |
319 | =head2 API NOTES |
297 | |
320 | |
298 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
321 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
299 | with the same name (sans C<aio_>). The arguments are similar or identical, |
322 | with the same name (sans C<aio_>). The arguments are similar or identical, |
… | |
… | |
1286 | So in general, you should only use these calls for things that do |
1309 | So in general, you should only use these calls for things that do |
1287 | (filesystem) I/O, not for things that wait for other events (network, |
1310 | (filesystem) I/O, not for things that wait for other events (network, |
1288 | other processes), although if you are careful and know what you are doing, |
1311 | other processes), although if you are careful and know what you are doing, |
1289 | you still can. |
1312 | you still can. |
1290 | |
1313 | |
1291 | The following constants are available (missing ones are, as usual C<0>): |
1314 | The following constants are available and can be used for normal C<ioctl> |
|
|
1315 | and C<fcntl> as well (missing ones are, as usual C<0>): |
1292 | |
1316 | |
1293 | C<F_DUPFD_CLOEXEC>, |
1317 | C<F_DUPFD_CLOEXEC>, |
1294 | |
1318 | |
1295 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
1319 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
1296 | |
1320 | |
1297 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
1321 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
|
|
1322 | |
|
|
1323 | C<F_ADD_SEALS>, C<F_GET_SEALS>, C<F_SEAL_SEAL>, C<F_SEAL_SHRINK>, C<F_SEAL_GROW> and |
|
|
1324 | C<F_SEAL_WRITE>. |
1298 | |
1325 | |
1299 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
1326 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
1300 | C<FS_IOC_FIEMAP>. |
1327 | C<FS_IOC_FIEMAP>. |
1301 | |
1328 | |
1302 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
1329 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
… | |
… | |
1652 | C<aio_wd> callback, as future requests using the value will fail in the |
1679 | C<aio_wd> callback, as future requests using the value will fail in the |
1653 | expected way. |
1680 | expected way. |
1654 | |
1681 | |
1655 | =item IO::AIO::CWD |
1682 | =item IO::AIO::CWD |
1656 | |
1683 | |
1657 | This is a compiletime constant (object) that represents the process |
1684 | This is a compile time constant (object) that represents the process |
1658 | current working directory. |
1685 | current working directory. |
1659 | |
1686 | |
1660 | Specifying this object as working directory object for a pathname is as if |
1687 | Specifying this object as working directory object for a pathname is as if |
1661 | the pathname would be specified directly, without a directory object. For |
1688 | the pathname would be specified directly, without a directory object. For |
1662 | example, these calls are functionally identical: |
1689 | example, these calls are functionally identical: |
… | |
… | |
2122 | for times around now - see the I<nsec> function family, below, for full |
2149 | for times around now - see the I<nsec> function family, below, for full |
2123 | accuracy. |
2150 | accuracy. |
2124 | |
2151 | |
2125 | File birth time is only available when the OS and perl support it (on |
2152 | File birth time is only available when the OS and perl support it (on |
2126 | FreeBSD and NetBSD at the time of this writing, although support is |
2153 | FreeBSD and NetBSD at the time of this writing, although support is |
2127 | adaptive, so if your OS/perl gains support, IO::AIO can take avdantage of |
2154 | adaptive, so if your OS/perl gains support, IO::AIO can take advantage of |
2128 | it). On systems where it isn't available, C<0> is currently returned, but |
2155 | it). On systems where it isn't available, C<0> is currently returned, but |
2129 | this might change to C<undef> in a future version. |
2156 | this might change to C<undef> in a future version. |
2130 | |
2157 | |
2131 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
2158 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
2132 | |
2159 | |
… | |
… | |
2193 | |
2220 | |
2194 | =over 4 |
2221 | =over 4 |
2195 | |
2222 | |
2196 | =item $numfd = IO::AIO::get_fdlimit |
2223 | =item $numfd = IO::AIO::get_fdlimit |
2197 | |
2224 | |
2198 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2199 | |
|
|
2200 | Tries to find the current file descriptor limit and returns it, or |
2225 | Tries to find the current file descriptor limit and returns it, or |
2201 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
2226 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
2202 | the highest valid file descriptor number. |
2227 | the highest valid file descriptor number. |
2203 | |
2228 | |
2204 | =item IO::AIO::min_fdlimit [$numfd] |
2229 | =item IO::AIO::min_fdlimit [$numfd] |
2205 | |
|
|
2206 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2207 | |
2230 | |
2208 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
2231 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
2209 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
2232 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
2210 | is missing, it will try to set a very high limit, although this is not |
2233 | is missing, it will try to set a very high limit, although this is not |
2211 | recommended when you know the actual minimum that you require. |
2234 | recommended when you know the actual minimum that you require. |
… | |
… | |
2371 | Calls the C<munlockall> function. |
2394 | Calls the C<munlockall> function. |
2372 | |
2395 | |
2373 | On systems that do not implement C<munlockall>, this function returns |
2396 | On systems that do not implement C<munlockall>, this function returns |
2374 | ENOSYS, otherwise the return value of C<munlockall>. |
2397 | ENOSYS, otherwise the return value of C<munlockall>. |
2375 | |
2398 | |
|
|
2399 | =item $fh = IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_maxlen, $flags |
|
|
2400 | |
|
|
2401 | Uses the GNU/Linux C<accept4(2)> syscall, if available, to accept a socket |
|
|
2402 | and return the new file handle on success, or sets C<$!> and returns |
|
|
2403 | C<undef> on error. |
|
|
2404 | |
|
|
2405 | The remote name of the new socket will be stored in C<$sockaddr>, which |
|
|
2406 | will be extended to allow for at least C<$sockaddr_maxlen> octets. If the |
|
|
2407 | socket name does not fit into C<$sockaddr_maxlen> octets, this is signaled |
|
|
2408 | by returning a longer string in C<$sockaddr>, which might or might not be |
|
|
2409 | truncated. |
|
|
2410 | |
|
|
2411 | To accept name-less sockets, use C<undef> for C<$sockaddr> and C<0> for |
|
|
2412 | C<$sockaddr_maxlen>. |
|
|
2413 | |
|
|
2414 | The main reasons to use this syscall rather than portable C<accept(2)> |
|
|
2415 | are that you can specify C<SOCK_NONBLOCK> and/or C<SOCK_CLOEXEC> |
|
|
2416 | flags and you can accept name-less sockets by specifying C<0> for |
|
|
2417 | C<$sockaddr_maxlen>, which is sadly not possible with perl's interface to |
|
|
2418 | C<accept>. |
|
|
2419 | |
2376 | =item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
2420 | =item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
2377 | |
2421 | |
2378 | Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or |
2422 | Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or |
2379 | C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they |
2423 | C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they |
2380 | should be the file offset. |
2424 | should be the file offset. |
… | |
… | |
2423 | Example: create a pipe race-free w.r.t. threads and fork: |
2467 | Example: create a pipe race-free w.r.t. threads and fork: |
2424 | |
2468 | |
2425 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
2469 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
2426 | or die "pipe2: $!\n"; |
2470 | or die "pipe2: $!\n"; |
2427 | |
2471 | |
|
|
2472 | =item $fh = IO::AIO::memfd_create $pathname[, $flags] |
|
|
2473 | |
|
|
2474 | This is a direct interface to the Linux L<memfd_create(2)> system |
|
|
2475 | call. The (unhelpful) default for C<$flags> is C<0>, but your default |
|
|
2476 | should be C<IO::AIO::MFD_CLOEXEC>. |
|
|
2477 | |
|
|
2478 | On success, the new memfd filehandle is returned, otherwise returns |
|
|
2479 | C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>. |
|
|
2480 | |
|
|
2481 | Please refer to L<memfd_create(2)> for more info on this call. |
|
|
2482 | |
|
|
2483 | The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>, |
|
|
2484 | C<IO::AIO::MFD_ALLOW_SEALING> and C<IO::AIO::MFD_HUGETLB>. |
|
|
2485 | |
|
|
2486 | Example: create a new memfd. |
|
|
2487 | |
|
|
2488 | my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC |
|
|
2489 | or die "memfd_create: $!\n"; |
|
|
2490 | |
|
|
2491 | =item $fh = IO::AIO::pidfd_open $pid[, $flags] |
|
|
2492 | |
|
|
2493 | This is an interface to the Linux L<pidfd_open(2)> system call. The |
|
|
2494 | default for C<$flags> is C<0>. |
|
|
2495 | |
|
|
2496 | On success, a new pidfd filehandle is returned (that is already set to |
|
|
2497 | close-on-exec), otherwise returns C<undef>. If the syscall is missing, |
|
|
2498 | fails with C<ENOSYS>. |
|
|
2499 | |
|
|
2500 | Example: open pid 6341 as pidfd. |
|
|
2501 | |
|
|
2502 | my $fh = IO::AIO::pidfd_open 6341 |
|
|
2503 | or die "pidfd_open: $!\n"; |
|
|
2504 | |
|
|
2505 | =item $status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[, $flags]] |
|
|
2506 | |
|
|
2507 | This is an interface to the Linux L<pidfd_send_signal> system call. The |
|
|
2508 | default for C<$siginfo> is C<undef> and the default for C<$flags> is C<0>. |
|
|
2509 | |
|
|
2510 | Returns the system call status. If the syscall is missing, fails with |
|
|
2511 | C<ENOSYS>. |
|
|
2512 | |
|
|
2513 | When specified, C<$siginfo> must be a reference to a hash with one or more |
|
|
2514 | of the following members: |
|
|
2515 | |
|
|
2516 | =over |
|
|
2517 | |
|
|
2518 | =item code - the C<si_code> member |
|
|
2519 | |
|
|
2520 | =item pid - the C<si_pid> member |
|
|
2521 | |
|
|
2522 | =item uid - the C<si_uid> member |
|
|
2523 | |
|
|
2524 | =item value_int - the C<si_value.sival_int> member |
|
|
2525 | |
|
|
2526 | =item value_ptr - the C<si_value.sival_ptr> member, specified as an integer |
|
|
2527 | |
|
|
2528 | =back |
|
|
2529 | |
|
|
2530 | Example: send a SIGKILL to the specified process. |
|
|
2531 | |
|
|
2532 | my $status = IO::AIO::pidfd_send_signal $pidfh, 9, undef |
|
|
2533 | and die "pidfd_send_signal: $!\n"; |
|
|
2534 | |
|
|
2535 | Example: send a SIGKILL to the specified process with extra data. |
|
|
2536 | |
|
|
2537 | my $status = IO::AIO::pidfd_send_signal $pidfh, 9, { code => -1, value_int => 7 } |
|
|
2538 | and die "pidfd_send_signal: $!\n"; |
|
|
2539 | |
|
|
2540 | =item $fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags] |
|
|
2541 | |
|
|
2542 | This is an interface to the Linux L<pidfd_getfd> system call. The default |
|
|
2543 | for C<$flags> is C<0>. |
|
|
2544 | |
|
|
2545 | On success, returns a dup'ed copy of the target file descriptor (specified |
|
|
2546 | as an integer) returned (that is already set to close-on-exec), otherwise |
|
|
2547 | returns C<undef>. If the syscall is missing, fails with C<ENOSYS>. |
|
|
2548 | |
|
|
2549 | Example: get a copy of standard error of another process and print soemthing to it. |
|
|
2550 | |
|
|
2551 | my $errfh = IO::AIO::pidfd_getfd $pidfh, 2 |
|
|
2552 | or die "pidfd_getfd: $!\n"; |
|
|
2553 | print $errfh "stderr\n"; |
|
|
2554 | |
2428 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
2555 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
2429 | |
2556 | |
2430 | This is a direct interface to the Linux L<eventfd(2)> system call. The |
2557 | This is a direct interface to the Linux L<eventfd(2)> system call. The |
2431 | (unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both. |
2558 | (unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both. |
2432 | |
2559 | |
… | |
… | |
2438 | The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, |
2565 | The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, |
2439 | C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). |
2566 | C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). |
2440 | |
2567 | |
2441 | Example: create a new eventfd filehandle: |
2568 | Example: create a new eventfd filehandle: |
2442 | |
2569 | |
2443 | $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC |
2570 | $fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC |
2444 | or die "eventfd: $!\n"; |
2571 | or die "eventfd: $!\n"; |
2445 | |
2572 | |
2446 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
2573 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
2447 | |
2574 | |
2448 | This is a direct interface to the Linux L<timerfd_create(2)> system call. The |
2575 | This is a direct interface to the Linux L<timerfd_create(2)> system |
2449 | (unhelpful) default for C<$flags> is C<0>. |
2576 | call. The (unhelpful) default for C<$flags> is C<0>, but your default |
|
|
2577 | should be C<IO::AIO::TFD_CLOEXEC>. |
2450 | |
2578 | |
2451 | On success, the new timerfd filehandle is returned, otherwise returns |
2579 | On success, the new timerfd filehandle is returned, otherwise returns |
2452 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
2580 | C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>. |
2453 | |
2581 | |
2454 | Please refer to L<timerfd_create(2)> for more info on this call. |
2582 | Please refer to L<timerfd_create(2)> for more info on this call. |
2455 | |
2583 | |
2456 | The following C<$clockid> values are |
2584 | The following C<$clockid> values are |
2457 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |
2585 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |
… | |
… | |
2623 | known issue, rather than a bug. |
2751 | known issue, rather than a bug. |
2624 | |
2752 | |
2625 | =head1 SEE ALSO |
2753 | =head1 SEE ALSO |
2626 | |
2754 | |
2627 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2755 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2628 | more natural syntax. |
2756 | more natural syntax and L<IO::FDPass> for file descriptor passing. |
2629 | |
2757 | |
2630 | =head1 AUTHOR |
2758 | =head1 AUTHOR |
2631 | |
2759 | |
2632 | Marc Lehmann <schmorp@schmorp.de> |
2760 | Marc Lehmann <schmorp@schmorp.de> |
2633 | http://home.schmorp.de/ |
2761 | http://home.schmorp.de/ |