ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/AIO.pm
(Generate patch)

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.300 by root, Sun Mar 10 12:11:46 2019 UTC vs.
Revision 1.306 by root, Wed Oct 16 09:11:35 2019 UTC

171use common::sense; 171use common::sense;
172 172
173use base 'Exporter'; 173use base 'Exporter';
174 174
175BEGIN { 175BEGIN {
176 our $VERSION = 4.71; 176 our $VERSION = 4.73;
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 [EXPERIMENTAL]
284 IO::AIO::min_fdlimit $nfd [EXPERIMENTAL] 286 IO::AIO::min_fdlimit $nfd [EXPERIMENTAL]
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
298All the C<aio_*> calls are more or less thin wrappers around the syscall 321All the C<aio_*> calls are more or less thin wrappers around the syscall
299with the same name (sans C<aio_>). The arguments are similar or identical, 322with the same name (sans C<aio_>). The arguments are similar or identical,
1286So in general, you should only use these calls for things that do 1309So 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,
1288other processes), although if you are careful and know what you are doing, 1311other processes), although if you are careful and know what you are doing,
1289you still can. 1312you still can.
1290 1313
1291The following constants are available (missing ones are, as usual C<0>): 1314The following constants are available and can be used for normal C<ioctl>
1315and C<fcntl> as well (missing ones are, as usual C<0>):
1292 1316
1293C<F_DUPFD_CLOEXEC>, 1317C<F_DUPFD_CLOEXEC>,
1294 1318
1295C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, 1319C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
1296 1320
1297C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. 1321C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
1322
1323C<F_ADD_SEALS>, C<F_GET_SEALS>, C<F_SEAL_SEAL>, C<F_SEAL_SHRINK>, C<F_SEAL_GROW> and
1324C<F_SEAL_WRITE>.
1298 1325
1299C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, 1326C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
1300C<FS_IOC_FIEMAP>. 1327C<FS_IOC_FIEMAP>.
1301 1328
1302C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, 1329C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
1652C<aio_wd> callback, as future requests using the value will fail in the 1679C<aio_wd> callback, as future requests using the value will fail in the
1653expected way. 1680expected way.
1654 1681
1655=item IO::AIO::CWD 1682=item IO::AIO::CWD
1656 1683
1657This is a compiletime constant (object) that represents the process 1684This is a compile time constant (object) that represents the process
1658current working directory. 1685current working directory.
1659 1686
1660Specifying this object as working directory object for a pathname is as if 1687Specifying this object as working directory object for a pathname is as if
1661the pathname would be specified directly, without a directory object. For 1688the pathname would be specified directly, without a directory object. For
1662example, these calls are functionally identical: 1689example, these calls are functionally identical:
2122for times around now - see the I<nsec> function family, below, for full 2149for times around now - see the I<nsec> function family, below, for full
2123accuracy. 2150accuracy.
2124 2151
2125File birth time is only available when the OS and perl support it (on 2152File birth time is only available when the OS and perl support it (on
2126FreeBSD and NetBSD at the time of this writing, although support is 2153FreeBSD and NetBSD at the time of this writing, although support is
2127adaptive, so if your OS/perl gains support, IO::AIO can take avdantage of 2154adaptive, so if your OS/perl gains support, IO::AIO can take advantage of
2128it). On systems where it isn't available, C<0> is currently returned, but 2155it). On systems where it isn't available, C<0> is currently returned, but
2129this might change to C<undef> in a future version. 2156this 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
2371Calls the C<munlockall> function. 2398Calls the C<munlockall> function.
2372 2399
2373On systems that do not implement C<munlockall>, this function returns 2400On systems that do not implement C<munlockall>, this function returns
2374ENOSYS, otherwise the return value of C<munlockall>. 2401ENOSYS, otherwise the return value of C<munlockall>.
2375 2402
2403=item $fh = IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_maxlen, $flags
2404
2405Uses the GNU/Linux C<accept4(2)> syscall, if available, to accept a socket
2406and return the new file handle on success, or sets C<$!> and returns
2407C<undef> on error.
2408
2409The remote name of the new socket will be stored in C<$sockaddr>, which
2410will be extended to allow for at least C<$sockaddr_maxlen> octets. If the
2411socket name does not fit into C<$sockaddr_maxlen> octets, this is signaled
2412by returning a longer string in C<$sockaddr>, which might or might not be
2413truncated.
2414
2415To accept name-less sockets, use C<undef> for C<$sockaddr> and C<0> for
2416C<$sockaddr_maxlen>.
2417
2418The main reasons to use this syscall rather than portable C«accept(2)>
2419are that you can specify C<SOCK_NONBLOCK> and/or C<SOCK_CLOEXEC>
2420flags and you can accept name-less sockets by specifying C<0> for
2421C<$sockaddr_maxlen>, which is sadly not possible with perl's interface to
2422C<accept>.
2423
2376=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags 2424=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
2377 2425
2378Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or 2426Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
2379C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they 2427C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
2380should be the file offset. 2428should be the file offset.
2423Example: create a pipe race-free w.r.t. threads and fork: 2471Example: create a pipe race-free w.r.t. threads and fork:
2424 2472
2425 my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC 2473 my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
2426 or die "pipe2: $!\n"; 2474 or die "pipe2: $!\n";
2427 2475
2476=item $fh = IO::AIO::memfd_create $pathname[, $flags]
2477
2478This is a direct interface to the Linux L<memfd_create(2)> system
2479call. The (unhelpful) default for C<$flags> is C<0>, but your default
2480should be C<IO::AIO::MFD_CLOEXEC>.
2481
2482On success, the new memfd filehandle is returned, otherwise returns
2483C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>.
2484
2485Please refer to L<memfd_create(2)> for more info on this call.
2486
2487The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>,
2488C<IO::AIO::MFD_ALLOW_SEALING> and C<IO::AIO::MFD_HUGETLB>.
2489
2490Example: create a new memfd.
2491
2492 my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC
2493 or die "m,emfd_create: $!\n";
2428=item $fh = IO::AIO::eventfd [$initval, [$flags]] 2494=item $fh = IO::AIO::eventfd [$initval, [$flags]]
2429 2495
2430This is a direct interface to the Linux L<eventfd(2)> system call. The 2496This 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. 2497(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
2432 2498
2438The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, 2504The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
2439C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). 2505C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
2440 2506
2441Example: create a new eventfd filehandle: 2507Example: create a new eventfd filehandle:
2442 2508
2443 $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC 2509 $fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC
2444 or die "eventfd: $!\n"; 2510 or die "eventfd: $!\n";
2445 2511
2446=item $fh = IO::AIO::timerfd_create $clockid[, $flags] 2512=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
2447 2513
2448This is a direct interface to the Linux L<timerfd_create(2)> system call. The 2514This is a direct interface to the Linux L<timerfd_create(2)> system
2449(unhelpful) default for C<$flags> is C<0>. 2515call. The (unhelpful) default for C<$flags> is C<0>, but your default
2516should be C<IO::AIO::TFD_CLOEXEC>.
2450 2517
2451On success, the new timerfd filehandle is returned, otherwise returns 2518On success, the new timerfd filehandle is returned, otherwise returns
2452C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. 2519C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>.
2453 2520
2454Please refer to L<timerfd_create(2)> for more info on this call. 2521Please refer to L<timerfd_create(2)> for more info on this call.
2455 2522
2456The following C<$clockid> values are 2523The following C<$clockid> values are
2457available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> 2524available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
2623known issue, rather than a bug. 2690known issue, rather than a bug.
2624 2691
2625=head1 SEE ALSO 2692=head1 SEE ALSO
2626 2693
2627L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a 2694L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2628more natural syntax. 2695more natural syntax and L<IO::FDPass> for file descriptor passing.
2629 2696
2630=head1 AUTHOR 2697=head1 AUTHOR
2631 2698
2632 Marc Lehmann <schmorp@schmorp.de> 2699 Marc Lehmann <schmorp@schmorp.de>
2633 http://home.schmorp.de/ 2700 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines