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.304 by root, Wed Apr 3 03:11:45 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.72;
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::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
309 IO::AIO::tee $r_fh, $w_fh, $length, $flags
310 $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
311 ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
312 $fh = IO::AIO::memfd_create $pathname[, $flags]
313 $fh = IO::AIO::eventfd [$initval, [$flags]]
314 $fh = IO::AIO::timerfd_create $clockid[, $flags]
315 ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
316 ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
295 317
296=head2 API NOTES 318=head2 API NOTES
297 319
298All the C<aio_*> calls are more or less thin wrappers around the syscall 320All 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, 321with 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 1308So 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, 1309(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, 1310other processes), although if you are careful and know what you are doing,
1289you still can. 1311you still can.
1290 1312
1291The following constants are available (missing ones are, as usual C<0>): 1313The following constants are available and can be used for normal C<ioctl>
1314and C<fcntl> as well (missing ones are, as usual C<0>):
1292 1315
1293C<F_DUPFD_CLOEXEC>, 1316C<F_DUPFD_CLOEXEC>,
1294 1317
1295C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, 1318C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
1296 1319
1297C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. 1320C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
1321
1322C<F_ADD_SEALS>, C<F_GET_SEALS>, C<F_SEAL_SEAL>, C<F_SEAL_SHRINK>, C<F_SEAL_GROW> and
1323C<F_SEAL_WRITE>.
1298 1324
1299C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, 1325C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
1300C<FS_IOC_FIEMAP>. 1326C<FS_IOC_FIEMAP>.
1301 1327
1302C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, 1328C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
… …
2122for times around now - see the I<nsec> function family, below, for full 2148for times around now - see the I<nsec> function family, below, for full
2123accuracy. 2149accuracy.
2124 2150
2125File birth time is only available when the OS and perl support it (on 2151File 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 2152FreeBSD 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 2153adaptive, 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 2154it). On systems where it isn't available, C<0> is currently returned, but
2129this might change to C<undef> in a future version. 2155this might change to C<undef> in a future version.
2130 2156
2131=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime 2157=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
2132 2158
… …
2423Example: create a pipe race-free w.r.t. threads and fork: 2449Example: create a pipe race-free w.r.t. threads and fork:
2424 2450
2425 my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC 2451 my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
2426 or die "pipe2: $!\n"; 2452 or die "pipe2: $!\n";
2427 2453
2454=item $fh = IO::AIO::memfd_create $pathname[, $flags]
2455
2456This is a direct interface to the Linux L<memfd_create(2)> system
2457call. The (unhelpful) default for C<$flags> is C<0>, but your default
2458should be C<IO::AIO::MFD_CLOEXEC>.
2459
2460On success, the new memfd filehandle is returned, otherwise returns
2461C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>.
2462
2463Please refer to L<memfd_create(2)> for more info on this call.
2464
2465The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>,
2466C<IO::AIO::MFD_ALLOW_SEALING> and C<IO::AIO::MFD_HUGETLB>.
2467
2468Example: create a new memfd.
2469
2470 my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC
2471 or die "m,emfd_create: $!\n";
2428=item $fh = IO::AIO::eventfd [$initval, [$flags]] 2472=item $fh = IO::AIO::eventfd [$initval, [$flags]]
2429 2473
2430This is a direct interface to the Linux L<eventfd(2)> system call. The 2474This 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. 2475(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
2432 2476
… …
2438The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, 2482The 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). 2483C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
2440 2484
2441Example: create a new eventfd filehandle: 2485Example: create a new eventfd filehandle:
2442 2486
2443 $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC 2487 $fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC
2444 or die "eventfd: $!\n"; 2488 or die "eventfd: $!\n";
2445 2489
2446=item $fh = IO::AIO::timerfd_create $clockid[, $flags] 2490=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
2447 2491
2448This is a direct interface to the Linux L<timerfd_create(2)> system call. The 2492This is a direct interface to the Linux L<timerfd_create(2)> system
2449(unhelpful) default for C<$flags> is C<0>. 2493call. The (unhelpful) default for C<$flags> is C<0>, but your default
2494should be C<IO::AIO::TFD_CLOEXEC>.
2450 2495
2451On success, the new timerfd filehandle is returned, otherwise returns 2496On success, the new timerfd filehandle is returned, otherwise returns
2452C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. 2497C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>.
2453 2498
2454Please refer to L<timerfd_create(2)> for more info on this call. 2499Please refer to L<timerfd_create(2)> for more info on this call.
2455 2500
2456The following C<$clockid> values are 2501The following C<$clockid> values are
2457available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> 2502available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
… …
2623known issue, rather than a bug. 2668known issue, rather than a bug.
2624 2669
2625=head1 SEE ALSO 2670=head1 SEE ALSO
2626 2671
2627L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a 2672L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2628more natural syntax. 2673more natural syntax and L<IO::FDPass> for file descriptor passing.
2629 2674
2630=head1 AUTHOR 2675=head1 AUTHOR
2631 2676
2632 Marc Lehmann <schmorp@schmorp.de> 2677 Marc Lehmann <schmorp@schmorp.de>
2633 http://home.schmorp.de/ 2678 http://home.schmorp.de/

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines