… | |
… | |
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.6; |
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 | |
298 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
320 | 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, |
321 | with the same name (sans C<aio_>). The arguments are similar or identical, |
… | |
… | |
1109 | aioreq_pri $pri; |
1131 | aioreq_pri $pri; |
1110 | add $grp aio_stat $wd, sub { |
1132 | add $grp aio_stat $wd, sub { |
1111 | return $grp->result () if $_[0]; |
1133 | return $grp->result () if $_[0]; |
1112 | my $now = time; |
1134 | my $now = time; |
1113 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
1135 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
1136 | my $rdxflags = READDIR_DIRS_FIRST; |
|
|
1137 | |
|
|
1138 | if ((stat _)[3] < 2) { |
|
|
1139 | # at least one non-POSIX filesystem exists |
|
|
1140 | # that returns useful DT_type values: btrfs, |
|
|
1141 | # so optimise for this here by requesting dents |
|
|
1142 | $rdxflags |= READDIR_DENTS; |
|
|
1143 | } |
1114 | |
1144 | |
1115 | # read the directory entries |
1145 | # read the directory entries |
1116 | aioreq_pri $pri; |
1146 | aioreq_pri $pri; |
1117 | add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub { |
1147 | add $grp aio_readdirx $wd, $rdxflags, sub { |
1118 | my $entries = shift |
1148 | my ($entries, $flags) = @_ |
1119 | or return $grp->result (); |
1149 | or return $grp->result (); |
|
|
1150 | |
|
|
1151 | if ($rdxflags & READDIR_DENTS) { |
|
|
1152 | # if we requested type values, see if we can use them directly. |
|
|
1153 | |
|
|
1154 | # if there were any DT_UNKNOWN entries then we assume we |
|
|
1155 | # don't know. alternatively, we could assume that if we get |
|
|
1156 | # one DT_DIR, then all directories are indeed marked with |
|
|
1157 | # DT_DIR, but this seems not required for btrfs, and this |
|
|
1158 | # is basically the "btrfs can't get it's act together" code |
|
|
1159 | # branch. |
|
|
1160 | unless ($flags & READDIR_FOUND_UNKNOWN) { |
|
|
1161 | # now we have valid DT_ information for all entries, |
|
|
1162 | # so use it as an optimisation without further stat's. |
|
|
1163 | # they must also all be at the beginning of @$entries |
|
|
1164 | # by now. |
|
|
1165 | |
|
|
1166 | my $dirs; |
|
|
1167 | |
|
|
1168 | if (@$entries) { |
|
|
1169 | for (0 .. $#$entries) { |
|
|
1170 | if ($entries->[$_][1] != DT_DIR) { |
|
|
1171 | # splice out directories |
|
|
1172 | $dirs = [splice @$entries, 0, $_]; |
|
|
1173 | last; |
|
|
1174 | } |
|
|
1175 | } |
|
|
1176 | |
|
|
1177 | # if we didn't find any non-dir, then all entries are dirs |
|
|
1178 | unless ($dirs) { |
|
|
1179 | ($dirs, $entries) = ($entries, []); |
|
|
1180 | } |
|
|
1181 | } else { |
|
|
1182 | # directory is empty, so there are no sbdirs |
|
|
1183 | $dirs = []; |
|
|
1184 | } |
|
|
1185 | |
|
|
1186 | # either splice'd the directories out or the dir was empty. |
|
|
1187 | # convert dents to filenames |
|
|
1188 | $_ = $_->[0] for @$dirs; |
|
|
1189 | $_ = $_->[0] for @$entries; |
|
|
1190 | |
|
|
1191 | return $grp->result ($dirs, $entries); |
|
|
1192 | } |
|
|
1193 | |
|
|
1194 | # cannot use, so return to our old ways |
|
|
1195 | # by pretending we only scanned for names. |
|
|
1196 | $_ = $_->[0] for @$entries; |
|
|
1197 | } |
1120 | |
1198 | |
1121 | # stat the dir another time |
1199 | # stat the dir another time |
1122 | aioreq_pri $pri; |
1200 | aioreq_pri $pri; |
1123 | add $grp aio_stat $wd, sub { |
1201 | add $grp aio_stat $wd, sub { |
1124 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
1202 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
… | |
… | |
1230 | So in general, you should only use these calls for things that do |
1308 | So in general, you should only use these calls for things that do |
1231 | (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, |
1232 | other processes), although if you are careful and know what you are doing, |
1310 | other processes), although if you are careful and know what you are doing, |
1233 | you still can. |
1311 | you still can. |
1234 | |
1312 | |
1235 | The following constants are available (missing ones are, as usual C<0>): |
1313 | The following constants are available and can be used for normal C<ioctl> |
|
|
1314 | and C<fcntl> as well (missing ones are, as usual C<0>): |
1236 | |
1315 | |
1237 | C<F_DUPFD_CLOEXEC>, |
1316 | C<F_DUPFD_CLOEXEC>, |
1238 | |
1317 | |
1239 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
1318 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
1240 | |
1319 | |
1241 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
1320 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
|
|
1321 | |
|
|
1322 | C<F_ADD_SEALS>, C<F_GET_SEALS>, C<F_SEAL_SEAL>, C<F_SEAL_SHRINK>, C<F_SEAL_GROW> and |
|
|
1323 | C<F_SEAL_WRITE>. |
1242 | |
1324 | |
1243 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
1325 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
1244 | C<FS_IOC_FIEMAP>. |
1326 | C<FS_IOC_FIEMAP>. |
1245 | |
1327 | |
1246 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
1328 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
… | |
… | |
1385 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1467 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1386 | aio_mlock $data; # mlock in background |
1468 | aio_mlock $data; # mlock in background |
1387 | |
1469 | |
1388 | =item aio_mlockall $flags, $callback->($status) |
1470 | =item aio_mlockall $flags, $callback->($status) |
1389 | |
1471 | |
1390 | Calls the C<mlockall> function with the given C<$flags> (a combination of |
1472 | Calls the C<mlockall> function with the given C<$flags> (a |
1391 | C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>). |
1473 | combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and |
|
|
1474 | C<IO::AIO::MCL_ONFAULT>). |
1392 | |
1475 | |
1393 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1476 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1394 | and sets errno to C<ENOSYS>. |
1477 | and sets errno to C<ENOSYS>. Similarly, flag combinations not supported |
|
|
1478 | by the system result in a return value of C<-1> with errno being set to |
|
|
1479 | C<EINVAL>. |
1395 | |
1480 | |
1396 | Note that the corresponding C<munlockall> is synchronous and is |
1481 | Note that the corresponding C<munlockall> is synchronous and is |
1397 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1482 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1398 | |
1483 | |
1399 | Example: asynchronously lock all current and future pages into memory. |
1484 | Example: asynchronously lock all current and future pages into memory. |
… | |
… | |
2063 | for times around now - see the I<nsec> function family, below, for full |
2148 | for times around now - see the I<nsec> function family, below, for full |
2064 | accuracy. |
2149 | accuracy. |
2065 | |
2150 | |
2066 | File birth time is only available when the OS and perl support it (on |
2151 | File birth time is only available when the OS and perl support it (on |
2067 | FreeBSD and NetBSD at the time of this writing, although support is |
2152 | FreeBSD and NetBSD at the time of this writing, although support is |
2068 | adaptive, so if your OS/perl gains support, IO::AIO can take avdantage of |
2153 | adaptive, so if your OS/perl gains support, IO::AIO can take advantage of |
2069 | it). On systems where it isn't available, C<0> is currently returned, but |
2154 | it). On systems where it isn't available, C<0> is currently returned, but |
2070 | this might change to C<undef> in a future version. |
2155 | this might change to C<undef> in a future version. |
2071 | |
2156 | |
2072 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
2157 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
2073 | |
2158 | |
… | |
… | |
2295 | implemented, but not supported and might go away in a future version. |
2380 | implemented, but not supported and might go away in a future version. |
2296 | |
2381 | |
2297 | On systems where this call is not supported or is not emulated, this call |
2382 | On systems where this call is not supported or is not emulated, this call |
2298 | returns falls and sets C<$!> to C<ENOSYS>. |
2383 | returns falls and sets C<$!> to C<ENOSYS>. |
2299 | |
2384 | |
|
|
2385 | =item IO::AIO::mlockall $flags |
|
|
2386 | |
|
|
2387 | Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>, |
|
|
2388 | but is blocking. |
|
|
2389 | |
2300 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2390 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2301 | |
2391 | |
2302 | Calls the C<munlock> function, undoing the effects of a previous |
2392 | Calls the C<munlock> function, undoing the effects of a previous |
2303 | C<aio_mlock> call (see its description for details). |
2393 | C<aio_mlock> call (see its description for details). |
2304 | |
2394 | |
… | |
… | |
2359 | Example: create a pipe race-free w.r.t. threads and fork: |
2449 | Example: create a pipe race-free w.r.t. threads and fork: |
2360 | |
2450 | |
2361 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
2451 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
2362 | or die "pipe2: $!\n"; |
2452 | or die "pipe2: $!\n"; |
2363 | |
2453 | |
|
|
2454 | =item $fh = IO::AIO::memfd_create $pathname[, $flags] |
|
|
2455 | |
|
|
2456 | This is a direct interface to the Linux L<memfd_create(2)> system |
|
|
2457 | call. The (unhelpful) default for C<$flags> is C<0>, but your default |
|
|
2458 | should be C<IO::AIO::MFD_CLOEXEC>. |
|
|
2459 | |
|
|
2460 | On success, the new memfd filehandle is returned, otherwise returns |
|
|
2461 | C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>. |
|
|
2462 | |
|
|
2463 | Please refer to L<memfd_create(2)> for more info on this call. |
|
|
2464 | |
|
|
2465 | The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>, |
|
|
2466 | C<IO::AIO::MFD_ALLOW_SEALING> and C<IO::AIO::MFD_HUGETLB>. |
|
|
2467 | |
|
|
2468 | Example: create a new memfd. |
|
|
2469 | |
|
|
2470 | my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC |
|
|
2471 | or die "m,emfd_create: $!\n"; |
2364 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
2472 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
2365 | |
2473 | |
2366 | This is a direct interface to the Linux L<eventfd(2)> system call. The |
2474 | This is a direct interface to the Linux L<eventfd(2)> system call. The |
2367 | (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. |
2368 | |
2476 | |
… | |
… | |
2374 | The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, |
2482 | The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, |
2375 | C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). |
2483 | C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). |
2376 | |
2484 | |
2377 | Example: create a new eventfd filehandle: |
2485 | Example: create a new eventfd filehandle: |
2378 | |
2486 | |
2379 | $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC |
2487 | $fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC |
2380 | or die "eventfd: $!\n"; |
2488 | or die "eventfd: $!\n"; |
2381 | |
2489 | |
2382 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
2490 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
2383 | |
2491 | |
2384 | This is a direct interface to the Linux L<timerfd_create(2)> system call. The |
2492 | This is a direct interface to the Linux L<timerfd_create(2)> system |
2385 | (unhelpful) default for C<$flags> is C<0>. |
2493 | call. The (unhelpful) default for C<$flags> is C<0>, but your default |
|
|
2494 | should be C<IO::AIO::TFD_CLOEXEC>. |
2386 | |
2495 | |
2387 | On success, the new timerfd filehandle is returned, otherwise returns |
2496 | On success, the new timerfd filehandle is returned, otherwise returns |
2388 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
2497 | C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>. |
2389 | |
2498 | |
2390 | Please refer to L<timerfd_create(2)> for more info on this call. |
2499 | Please refer to L<timerfd_create(2)> for more info on this call. |
2391 | |
2500 | |
2392 | The following C<$clockid> values are |
2501 | The following C<$clockid> values are |
2393 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |
2502 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |
… | |
… | |
2559 | known issue, rather than a bug. |
2668 | known issue, rather than a bug. |
2560 | |
2669 | |
2561 | =head1 SEE ALSO |
2670 | =head1 SEE ALSO |
2562 | |
2671 | |
2563 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2672 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2564 | more natural syntax. |
2673 | more natural syntax and L<IO::FDPass> for file descriptor passing. |
2565 | |
2674 | |
2566 | =head1 AUTHOR |
2675 | =head1 AUTHOR |
2567 | |
2676 | |
2568 | Marc Lehmann <schmorp@schmorp.de> |
2677 | Marc Lehmann <schmorp@schmorp.de> |
2569 | http://home.schmorp.de/ |
2678 | http://home.schmorp.de/ |