… | |
… | |
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.80; |
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 |
… | |
… | |
192 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
192 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
193 | min_parallel max_parallel max_idle idle_timeout |
193 | min_parallel max_parallel max_idle idle_timeout |
194 | nreqs nready npending nthreads |
194 | nreqs nready npending nthreads |
195 | max_poll_time max_poll_reqs |
195 | max_poll_time max_poll_reqs |
196 | sendfile fadvise madvise |
196 | sendfile fadvise madvise |
197 | mmap munmap mremap munlock munlockall); |
197 | mmap munmap mremap munlock munlockall |
|
|
198 | |
|
|
199 | accept4 tee splice pipe2 pipesize |
|
|
200 | fexecve mount umount memfd_create eventfd |
|
|
201 | timerfd_create timerfd_settime timerfd_gettime |
|
|
202 | pidfd_open pidfd_send_signal pidfd_getfd); |
198 | |
203 | |
199 | push @AIO_REQ, qw(aio_busy); # not exported |
204 | push @AIO_REQ, qw(aio_busy); # not exported |
200 | |
205 | |
201 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
206 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
202 | |
207 | |
… | |
… | |
278 | IO::AIO::idle_timeout $seconds |
283 | IO::AIO::idle_timeout $seconds |
279 | IO::AIO::max_outstanding $maxreqs |
284 | IO::AIO::max_outstanding $maxreqs |
280 | IO::AIO::nreqs |
285 | IO::AIO::nreqs |
281 | IO::AIO::nready |
286 | IO::AIO::nready |
282 | IO::AIO::npending |
287 | IO::AIO::npending |
|
|
288 | IO::AIO::reinit |
|
|
289 | |
283 | $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL] |
290 | $nfd = IO::AIO::get_fdlimit |
284 | IO::AIO::min_fdlimit $nfd [EXPERIMENTAL] |
291 | IO::AIO::min_fdlimit $nfd |
285 | |
292 | |
286 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
293 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
287 | IO::AIO::fadvise $fh, $offset, $len, $advice |
294 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
295 | IO::AIO::fexecve $fh, $argv, $envp |
|
|
296 | |
288 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
297 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
289 | IO::AIO::munmap $scalar |
298 | IO::AIO::munmap $scalar |
290 | IO::AIO::mremap $scalar, $new_length, $flags[, $new_address] |
299 | IO::AIO::mremap $scalar, $new_length, $flags[, $new_address] |
291 | IO::AIO::madvise $scalar, $offset, $length, $advice |
300 | IO::AIO::madvise $scalar, $offset, $length, $advice |
292 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
301 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
293 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
302 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
294 | IO::AIO::munlockall |
303 | IO::AIO::munlockall |
|
|
304 | |
|
|
305 | # stat extensions |
|
|
306 | $counter = IO::AIO::st_gen |
|
|
307 | $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime |
|
|
308 | ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
|
|
309 | $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec |
|
|
310 | $seconds = IO::AIO::st_btimesec |
|
|
311 | ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec |
|
|
312 | |
|
|
313 | # very much unportable syscalls |
|
|
314 | IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_len, $flags |
|
|
315 | IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
|
|
316 | IO::AIO::tee $r_fh, $w_fh, $length, $flags |
|
|
317 | |
|
|
318 | $actual_size = IO::AIO::pipesize $r_fh[, $new_size] |
|
|
319 | ($rfh, $wfh) = IO::AIO::pipe2 [$flags] |
|
|
320 | |
|
|
321 | $fh = IO::AIO::eventfd [$initval, [$flags]] |
|
|
322 | $fh = IO::AIO::memfd_create $pathname[, $flags] |
|
|
323 | |
|
|
324 | $fh = IO::AIO::timerfd_create $clockid[, $flags] |
|
|
325 | ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value |
|
|
326 | ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh |
|
|
327 | |
|
|
328 | $fh = IO::AIO::pidfd_open $pid[, $flags] |
|
|
329 | $status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[, $flags]] |
|
|
330 | $fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags] |
|
|
331 | |
|
|
332 | $retval = IO::AIO::mount $special, $path, $fstype, $flags = 0, $data = undef |
|
|
333 | $retval = IO::AIO::umount $path, $flags = 0 |
295 | |
334 | |
296 | =head2 API NOTES |
335 | =head2 API NOTES |
297 | |
336 | |
298 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
337 | 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, |
338 | with the same name (sans C<aio_>). The arguments are similar or identical, |
… | |
… | |
374 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
413 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
375 | |
414 | |
376 | Asynchronously open or create a file and call the callback with a newly |
415 | Asynchronously open or create a file and call the callback with a newly |
377 | created filehandle for the file (or C<undef> in case of an error). |
416 | created filehandle for the file (or C<undef> in case of an error). |
378 | |
417 | |
379 | The pathname passed to C<aio_open> must be absolute. See API NOTES, above, |
|
|
380 | for an explanation. |
|
|
381 | |
|
|
382 | The C<$flags> argument is a bitmask. See the C<Fcntl> module for a |
418 | The C<$flags> argument is a bitmask. See the C<Fcntl> module for a |
383 | list. They are the same as used by C<sysopen>. |
419 | list. They are the same as used by C<sysopen>. |
384 | |
420 | |
385 | Likewise, C<$mode> specifies the mode of the newly created file, if it |
421 | Likewise, C<$mode> specifies the mode of the newly created file, if it |
386 | didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, |
422 | didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, |
… | |
… | |
545 | |
581 | |
546 | Works almost exactly like perl's C<stat> or C<lstat> in void context. The |
582 | Works almost exactly like perl's C<stat> or C<lstat> in void context. The |
547 | callback will be called after the stat and the results will be available |
583 | callback will be called after the stat and the results will be available |
548 | using C<stat _> or C<-s _> and other tests (with the exception of C<-B> |
584 | using C<stat _> or C<-s _> and other tests (with the exception of C<-B> |
549 | and C<-T>). |
585 | and C<-T>). |
550 | |
|
|
551 | The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, |
|
|
552 | for an explanation. |
|
|
553 | |
586 | |
554 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
587 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
555 | error when stat'ing a large file, the results will be silently truncated |
588 | error when stat'ing a large file, the results will be silently truncated |
556 | unless perl itself is compiled with large file support. |
589 | unless perl itself is compiled with large file support. |
557 | |
590 | |
… | |
… | |
942 | my @stat = stat $src_fh; # hmm, might block over nfs? |
975 | my @stat = stat $src_fh; # hmm, might block over nfs? |
943 | |
976 | |
944 | aioreq_pri $pri; |
977 | aioreq_pri $pri; |
945 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
978 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
946 | if (my $dst_fh = $_[0]) { |
979 | if (my $dst_fh = $_[0]) { |
|
|
980 | |
|
|
981 | # best-effort preallocate |
|
|
982 | aioreq_pri $pri; |
|
|
983 | add $grp aio_allocate $dst_fh, IO::AIO::FALLOC_FL_KEEP_SIZE, 0, $stat[7], sub { }; |
|
|
984 | |
947 | aioreq_pri $pri; |
985 | aioreq_pri $pri; |
948 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
986 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
949 | if ($_[0] == $stat[7]) { |
987 | if ($_[0] == $stat[7]) { |
950 | $grp->result (0); |
988 | $grp->result (0); |
951 | close $src_fh; |
989 | close $src_fh; |
… | |
… | |
1109 | aioreq_pri $pri; |
1147 | aioreq_pri $pri; |
1110 | add $grp aio_stat $wd, sub { |
1148 | add $grp aio_stat $wd, sub { |
1111 | return $grp->result () if $_[0]; |
1149 | return $grp->result () if $_[0]; |
1112 | my $now = time; |
1150 | my $now = time; |
1113 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
1151 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
1152 | my $rdxflags = READDIR_DIRS_FIRST; |
|
|
1153 | |
|
|
1154 | if ((stat _)[3] < 2) { |
|
|
1155 | # at least one non-POSIX filesystem exists |
|
|
1156 | # that returns useful DT_type values: btrfs, |
|
|
1157 | # so optimise for this here by requesting dents |
|
|
1158 | $rdxflags |= READDIR_DENTS; |
|
|
1159 | } |
1114 | |
1160 | |
1115 | # read the directory entries |
1161 | # read the directory entries |
1116 | aioreq_pri $pri; |
1162 | aioreq_pri $pri; |
1117 | add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub { |
1163 | add $grp aio_readdirx $wd, $rdxflags, sub { |
1118 | my $entries = shift |
1164 | my ($entries, $flags) = @_ |
1119 | or return $grp->result (); |
1165 | or return $grp->result (); |
|
|
1166 | |
|
|
1167 | if ($rdxflags & READDIR_DENTS) { |
|
|
1168 | # if we requested type values, see if we can use them directly. |
|
|
1169 | |
|
|
1170 | # if there were any DT_UNKNOWN entries then we assume we |
|
|
1171 | # don't know. alternatively, we could assume that if we get |
|
|
1172 | # one DT_DIR, then all directories are indeed marked with |
|
|
1173 | # DT_DIR, but this seems not required for btrfs, and this |
|
|
1174 | # is basically the "btrfs can't get it's act together" code |
|
|
1175 | # branch. |
|
|
1176 | unless ($flags & READDIR_FOUND_UNKNOWN) { |
|
|
1177 | # now we have valid DT_ information for all entries, |
|
|
1178 | # so use it as an optimisation without further stat's. |
|
|
1179 | # they must also all be at the beginning of @$entries |
|
|
1180 | # by now. |
|
|
1181 | |
|
|
1182 | my $dirs; |
|
|
1183 | |
|
|
1184 | if (@$entries) { |
|
|
1185 | for (0 .. $#$entries) { |
|
|
1186 | if ($entries->[$_][1] != DT_DIR) { |
|
|
1187 | # splice out directories |
|
|
1188 | $dirs = [splice @$entries, 0, $_]; |
|
|
1189 | last; |
|
|
1190 | } |
|
|
1191 | } |
|
|
1192 | |
|
|
1193 | # if we didn't find any non-dir, then all entries are dirs |
|
|
1194 | unless ($dirs) { |
|
|
1195 | ($dirs, $entries) = ($entries, []); |
|
|
1196 | } |
|
|
1197 | } else { |
|
|
1198 | # directory is empty, so there are no sbdirs |
|
|
1199 | $dirs = []; |
|
|
1200 | } |
|
|
1201 | |
|
|
1202 | # either splice'd the directories out or the dir was empty. |
|
|
1203 | # convert dents to filenames |
|
|
1204 | $_ = $_->[0] for @$dirs; |
|
|
1205 | $_ = $_->[0] for @$entries; |
|
|
1206 | |
|
|
1207 | return $grp->result ($dirs, $entries); |
|
|
1208 | } |
|
|
1209 | |
|
|
1210 | # cannot use, so return to our old ways |
|
|
1211 | # by pretending we only scanned for names. |
|
|
1212 | $_ = $_->[0] for @$entries; |
|
|
1213 | } |
1120 | |
1214 | |
1121 | # stat the dir another time |
1215 | # stat the dir another time |
1122 | aioreq_pri $pri; |
1216 | aioreq_pri $pri; |
1123 | add $grp aio_stat $wd, sub { |
1217 | add $grp aio_stat $wd, sub { |
1124 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
1218 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
… | |
… | |
1230 | So in general, you should only use these calls for things that do |
1324 | 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, |
1325 | (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, |
1326 | other processes), although if you are careful and know what you are doing, |
1233 | you still can. |
1327 | you still can. |
1234 | |
1328 | |
1235 | The following constants are available (missing ones are, as usual C<0>): |
1329 | The following constants are available and can be used for normal C<ioctl> |
|
|
1330 | and C<fcntl> as well (missing ones are, as usual C<0>): |
1236 | |
1331 | |
1237 | C<F_DUPFD_CLOEXEC>, |
1332 | C<F_DUPFD_CLOEXEC>, |
1238 | |
1333 | |
1239 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
1334 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
1240 | |
1335 | |
1241 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
1336 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
|
|
1337 | |
|
|
1338 | C<F_ADD_SEALS>, C<F_GET_SEALS>, C<F_SEAL_SEAL>, C<F_SEAL_SHRINK>, C<F_SEAL_GROW> and |
|
|
1339 | C<F_SEAL_WRITE>. |
1242 | |
1340 | |
1243 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
1341 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
1244 | C<FS_IOC_FIEMAP>. |
1342 | C<FS_IOC_FIEMAP>. |
1245 | |
1343 | |
1246 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
1344 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
… | |
… | |
1254 | |
1352 | |
1255 | C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>, |
1353 | C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>, |
1256 | C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>, |
1354 | C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>, |
1257 | C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>, |
1355 | C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>, |
1258 | C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>, |
1356 | C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>, |
|
|
1357 | |
|
|
1358 | C<BLKROSET>, C<BLKROGET>, C<BLKRRPART>, C<BLKGETSIZE>, C<BLKFLSBUF>, C<BLKRASET>, |
|
|
1359 | C<BLKRAGET>, C<BLKFRASET>, C<BLKFRAGET>, C<BLKSECTSET>, C<BLKSECTGET>, C<BLKSSZGET>, |
|
|
1360 | C<BLKBSZGET>, C<BLKBSZSET>, C<BLKGETSIZE64>, |
|
|
1361 | |
1259 | |
1362 | |
1260 | =item aio_sync $callback->($status) |
1363 | =item aio_sync $callback->($status) |
1261 | |
1364 | |
1262 | Asynchronously call sync and call the callback when finished. |
1365 | Asynchronously call sync and call the callback when finished. |
1263 | |
1366 | |
… | |
… | |
1385 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1488 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1386 | aio_mlock $data; # mlock in background |
1489 | aio_mlock $data; # mlock in background |
1387 | |
1490 | |
1388 | =item aio_mlockall $flags, $callback->($status) |
1491 | =item aio_mlockall $flags, $callback->($status) |
1389 | |
1492 | |
1390 | Calls the C<mlockall> function with the given C<$flags> (a combination of |
1493 | Calls the C<mlockall> function with the given C<$flags> (a |
1391 | C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>). |
1494 | combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and |
|
|
1495 | C<IO::AIO::MCL_ONFAULT>). |
1392 | |
1496 | |
1393 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1497 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1394 | and sets errno to C<ENOSYS>. |
1498 | and sets errno to C<ENOSYS>. Similarly, flag combinations not supported |
|
|
1499 | by the system result in a return value of C<-1> with errno being set to |
|
|
1500 | C<EINVAL>. |
1395 | |
1501 | |
1396 | Note that the corresponding C<munlockall> is synchronous and is |
1502 | Note that the corresponding C<munlockall> is synchronous and is |
1397 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1503 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1398 | |
1504 | |
1399 | Example: asynchronously lock all current and future pages into memory. |
1505 | Example: asynchronously lock all current and future pages into memory. |
… | |
… | |
1593 | C<aio_wd> callback, as future requests using the value will fail in the |
1699 | C<aio_wd> callback, as future requests using the value will fail in the |
1594 | expected way. |
1700 | expected way. |
1595 | |
1701 | |
1596 | =item IO::AIO::CWD |
1702 | =item IO::AIO::CWD |
1597 | |
1703 | |
1598 | This is a compiletime constant (object) that represents the process |
1704 | This is a compile time constant (object) that represents the process |
1599 | current working directory. |
1705 | current working directory. |
1600 | |
1706 | |
1601 | Specifying this object as working directory object for a pathname is as if |
1707 | Specifying this object as working directory object for a pathname is as if |
1602 | the pathname would be specified directly, without a directory object. For |
1708 | the pathname would be specified directly, without a directory object. For |
1603 | example, these calls are functionally identical: |
1709 | example, these calls are functionally identical: |
… | |
… | |
1975 | longer exceeded. |
2081 | longer exceeded. |
1976 | |
2082 | |
1977 | In other words, this setting does not enforce a queue limit, but can be |
2083 | In other words, this setting does not enforce a queue limit, but can be |
1978 | used to make poll functions block if the limit is exceeded. |
2084 | used to make poll functions block if the limit is exceeded. |
1979 | |
2085 | |
1980 | This is a very bad function to use in interactive programs because it |
2086 | This is a bad function to use in interactive programs because it blocks, |
1981 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
2087 | and a bad way to reduce concurrency because it is inexact. If you need to |
|
|
2088 | issue many requests without being able to call a poll function on demand, |
1982 | use an C<aio_group> together with a feed callback. |
2089 | it is better to use an C<aio_group> together with a feed callback. |
1983 | |
2090 | |
1984 | Its main use is in scripts without an event loop - when you want to stat |
2091 | Its main use is in scripts without an event loop - when you want to stat a |
1985 | a lot of files, you can write something like this: |
2092 | lot of files, you can write something like this: |
1986 | |
2093 | |
1987 | IO::AIO::max_outstanding 32; |
2094 | IO::AIO::max_outstanding 32; |
1988 | |
2095 | |
1989 | for my $path (...) { |
2096 | for my $path (...) { |
1990 | aio_stat $path , ...; |
2097 | aio_stat $path , ...; |
1991 | IO::AIO::poll_cb; |
2098 | IO::AIO::poll_cb; |
1992 | } |
2099 | } |
1993 | |
2100 | |
1994 | IO::AIO::flush; |
2101 | IO::AIO::flush; |
1995 | |
2102 | |
1996 | The call to C<poll_cb> inside the loop will normally return instantly, but |
2103 | The call to C<poll_cb> inside the loop will normally return instantly, |
1997 | as soon as more thna C<32> reqeusts are in-flight, it will block until |
2104 | allowing the loop to progress, but as soon as more than C<32> requests |
1998 | some requests have been handled. This keeps the loop from pushing a large |
2105 | are in-flight, it will block until some requests have been handled. This |
1999 | number of C<aio_stat> requests onto the queue. |
2106 | keeps the loop from pushing a large number of C<aio_stat> requests onto |
|
|
2107 | the queue (which, with many paths to stat, can use up a lot of memory). |
2000 | |
2108 | |
2001 | The default value for C<max_outstanding> is very large, so there is no |
2109 | The default value for C<max_outstanding> is very large, so there is no |
2002 | practical limit on the number of outstanding requests. |
2110 | practical limit on the number of outstanding requests. |
2003 | |
2111 | |
2004 | =back |
2112 | =back |
… | |
… | |
2063 | for times around now - see the I<nsec> function family, below, for full |
2171 | for times around now - see the I<nsec> function family, below, for full |
2064 | accuracy. |
2172 | accuracy. |
2065 | |
2173 | |
2066 | File birth time is only available when the OS and perl support it (on |
2174 | 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 |
2175 | 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 |
2176 | 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 |
2177 | 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. |
2178 | this might change to C<undef> in a future version. |
2071 | |
2179 | |
2072 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
2180 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
2073 | |
2181 | |
… | |
… | |
2093 | Like the functions above, but returns all four times in one go (and maybe |
2201 | Like the functions above, but returns all four times in one go (and maybe |
2094 | more in future versions). |
2202 | more in future versions). |
2095 | |
2203 | |
2096 | =item $counter = IO::AIO::st_gen |
2204 | =item $counter = IO::AIO::st_gen |
2097 | |
2205 | |
2098 | Returns the generation counter of the file. This is only available on |
2206 | Returns the generation counter (in practice this is just a random number) |
2099 | platforms which have this member in their C<struct stat> (most BSDs |
2207 | of the file. This is only available on platforms which have this member in |
2100 | at the time of this writing) and generally only to the root usert. If |
2208 | their C<struct stat> (most BSDs at the time of this writing) and generally |
2101 | unsupported, C<0> is returned, but this might change to C<undef> in a |
2209 | only to the root usert. If unsupported, C<0> is returned, but this might |
2102 | future version. |
2210 | change to C<undef> in a future version. |
2103 | |
2211 | |
2104 | =back |
2212 | =back |
2105 | |
2213 | |
2106 | Example: print the high resolution modification time of F</etc>, using |
2214 | Example: print the high resolution modification time of F</etc>, using |
2107 | C<stat>, and C<IO::AIO::aio_stat>. |
2215 | C<stat>, and C<IO::AIO::aio_stat>. |
… | |
… | |
2132 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
2240 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
2133 | counterpart. |
2241 | counterpart. |
2134 | |
2242 | |
2135 | =over 4 |
2243 | =over 4 |
2136 | |
2244 | |
|
|
2245 | =item $retval = IO::AIO::fexecve $fh, $argv, $envp |
|
|
2246 | |
|
|
2247 | A more-or-less direct equivalent to the POSIX C<fexecve> functions, which |
|
|
2248 | allows you to specify the program to be executed via a file descriptor (or |
|
|
2249 | handle). Returns C<-1> and sets errno to C<ENOSYS> if not available. |
|
|
2250 | |
|
|
2251 | =item $retval = IO::AIO::mount $special, $path, $fstype, $flags = 0, $data = undef |
|
|
2252 | |
|
|
2253 | Calls the GNU/Linux mount syscall with the given arguments. All except |
|
|
2254 | C<$flags> are strings, and if C<$data> is C<undef>, a C<NULL> will be |
|
|
2255 | passed. |
|
|
2256 | |
|
|
2257 | The following values for C<$flags> are available: |
|
|
2258 | |
|
|
2259 | C<IO::AIO::MS_RDONLY>, C<IO::AIO::MS_NOSUID>, C<IO::AIO::MS_NODEV>, C<IO::AIO::MS_NOEXEC>, C<IO::AIO::MS_SYNCHRONOUS>, |
|
|
2260 | C<IO::AIO::MS_REMOUNT>, C<IO::AIO::MS_MANDLOCK>, C<IO::AIO::MS_DIRSYNC>, C<IO::AIO::MS_NOATIME>, |
|
|
2261 | C<IO::AIO::MS_NODIRATIME>, C<IO::AIO::MS_BIND>, C<IO::AIO::MS_MOVE>, C<IO::AIO::MS_REC>, C<IO::AIO::MS_SILENT>, |
|
|
2262 | C<IO::AIO::MS_POSIXACL>, C<IO::AIO::MS_UNBINDABLE>, C<IO::AIO::MS_PRIVATE>, C<IO::AIO::MS_SLAVE>, C<IO::AIO::MS_SHARED>, |
|
|
2263 | C<IO::AIO::MS_RELATIME>, C<IO::AIO::MS_KERNMOUNT>, C<IO::AIO::MS_I_VERSION>, C<IO::AIO::MS_STRICTATIME>, |
|
|
2264 | C<IO::AIO::MS_LAZYTIME>, C<IO::AIO::MS_ACTIVE>, C<IO::AIO::MS_NOUSER>, C<IO::AIO::MS_RMT_MASK>, C<IO::AIO::MS_MGC_VAL> and |
|
|
2265 | C<IO::AIO::MS_MGC_MSK>. |
|
|
2266 | |
|
|
2267 | =item $retval = IO::AIO::umount $path, $flags = 0 |
|
|
2268 | |
|
|
2269 | Invokes the GNU/Linux C<umount> or C<umount2> syscalls. Always calls |
|
|
2270 | C<umount> if C<$flags> is C<0>, otherwqise always tries to call |
|
|
2271 | C<umount2>. |
|
|
2272 | |
|
|
2273 | The following C<$flags> are available: |
|
|
2274 | |
|
|
2275 | C<IO::AIO::MNT_FORCE>, C<IO::AIO::MNT_DETACH>, C<IO::AIO::MNT_EXPIRE> and C<IO::AIO::UMOUNT_NOFOLLOW>. |
|
|
2276 | |
2137 | =item $numfd = IO::AIO::get_fdlimit |
2277 | =item $numfd = IO::AIO::get_fdlimit |
2138 | |
|
|
2139 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2140 | |
2278 | |
2141 | Tries to find the current file descriptor limit and returns it, or |
2279 | Tries to find the current file descriptor limit and returns it, or |
2142 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
2280 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
2143 | the highest valid file descriptor number. |
2281 | the highest valid file descriptor number. |
2144 | |
2282 | |
2145 | =item IO::AIO::min_fdlimit [$numfd] |
2283 | =item IO::AIO::min_fdlimit [$numfd] |
2146 | |
|
|
2147 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2148 | |
2284 | |
2149 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
2285 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
2150 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
2286 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
2151 | is missing, it will try to set a very high limit, although this is not |
2287 | is missing, it will try to set a very high limit, although this is not |
2152 | recommended when you know the actual minimum that you require. |
2288 | recommended when you know the actual minimum that you require. |
… | |
… | |
2247 | C<IO::AIO::MAP_POPULATE>, |
2383 | C<IO::AIO::MAP_POPULATE>, |
2248 | C<IO::AIO::MAP_NONBLOCK>, |
2384 | C<IO::AIO::MAP_NONBLOCK>, |
2249 | C<IO::AIO::MAP_FIXED>, |
2385 | C<IO::AIO::MAP_FIXED>, |
2250 | C<IO::AIO::MAP_GROWSDOWN>, |
2386 | C<IO::AIO::MAP_GROWSDOWN>, |
2251 | C<IO::AIO::MAP_32BIT>, |
2387 | C<IO::AIO::MAP_32BIT>, |
2252 | C<IO::AIO::MAP_HUGETLB> or |
2388 | C<IO::AIO::MAP_HUGETLB>, |
2253 | C<IO::AIO::MAP_STACK>. |
2389 | C<IO::AIO::MAP_STACK>, |
|
|
2390 | C<IO::AIO::MAP_FIXED_NOREPLACE>, |
|
|
2391 | C<IO::AIO::MAP_SHARED_VALIDATE>, |
|
|
2392 | C<IO::AIO::MAP_SYNC> or |
|
|
2393 | C<IO::AIO::MAP_UNINITIALIZED>. |
2254 | |
2394 | |
2255 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
2395 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
2256 | |
2396 | |
2257 | C<$offset> is the offset from the start of the file - it generally must be |
2397 | C<$offset> is the offset from the start of the file - it generally must be |
2258 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
2398 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
… | |
… | |
2295 | implemented, but not supported and might go away in a future version. |
2435 | implemented, but not supported and might go away in a future version. |
2296 | |
2436 | |
2297 | On systems where this call is not supported or is not emulated, this call |
2437 | On systems where this call is not supported or is not emulated, this call |
2298 | returns falls and sets C<$!> to C<ENOSYS>. |
2438 | returns falls and sets C<$!> to C<ENOSYS>. |
2299 | |
2439 | |
|
|
2440 | =item IO::AIO::mlockall $flags |
|
|
2441 | |
|
|
2442 | Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>, |
|
|
2443 | but is blocking. |
|
|
2444 | |
2300 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2445 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2301 | |
2446 | |
2302 | Calls the C<munlock> function, undoing the effects of a previous |
2447 | Calls the C<munlock> function, undoing the effects of a previous |
2303 | C<aio_mlock> call (see its description for details). |
2448 | C<aio_mlock> call (see its description for details). |
2304 | |
2449 | |
… | |
… | |
2306 | |
2451 | |
2307 | Calls the C<munlockall> function. |
2452 | Calls the C<munlockall> function. |
2308 | |
2453 | |
2309 | On systems that do not implement C<munlockall>, this function returns |
2454 | On systems that do not implement C<munlockall>, this function returns |
2310 | ENOSYS, otherwise the return value of C<munlockall>. |
2455 | ENOSYS, otherwise the return value of C<munlockall>. |
|
|
2456 | |
|
|
2457 | =item $fh = IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_maxlen, $flags |
|
|
2458 | |
|
|
2459 | Uses the GNU/Linux C<accept4(2)> syscall, if available, to accept a socket |
|
|
2460 | and return the new file handle on success, or sets C<$!> and returns |
|
|
2461 | C<undef> on error. |
|
|
2462 | |
|
|
2463 | The remote name of the new socket will be stored in C<$sockaddr>, which |
|
|
2464 | will be extended to allow for at least C<$sockaddr_maxlen> octets. If the |
|
|
2465 | socket name does not fit into C<$sockaddr_maxlen> octets, this is signaled |
|
|
2466 | by returning a longer string in C<$sockaddr>, which might or might not be |
|
|
2467 | truncated. |
|
|
2468 | |
|
|
2469 | To accept name-less sockets, use C<undef> for C<$sockaddr> and C<0> for |
|
|
2470 | C<$sockaddr_maxlen>. |
|
|
2471 | |
|
|
2472 | The main reasons to use this syscall rather than portable C<accept(2)> |
|
|
2473 | are that you can specify C<SOCK_NONBLOCK> and/or C<SOCK_CLOEXEC> |
|
|
2474 | flags and you can accept name-less sockets by specifying C<0> for |
|
|
2475 | C<$sockaddr_maxlen>, which is sadly not possible with perl's interface to |
|
|
2476 | C<accept>. |
2311 | |
2477 | |
2312 | =item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
2478 | =item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
2313 | |
2479 | |
2314 | Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or |
2480 | Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or |
2315 | C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they |
2481 | C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they |
… | |
… | |
2359 | Example: create a pipe race-free w.r.t. threads and fork: |
2525 | Example: create a pipe race-free w.r.t. threads and fork: |
2360 | |
2526 | |
2361 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
2527 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
2362 | or die "pipe2: $!\n"; |
2528 | or die "pipe2: $!\n"; |
2363 | |
2529 | |
|
|
2530 | =item $fh = IO::AIO::memfd_create $pathname[, $flags] |
|
|
2531 | |
|
|
2532 | This is a direct interface to the Linux L<memfd_create(2)> system |
|
|
2533 | call. The (unhelpful) default for C<$flags> is C<0>, but your default |
|
|
2534 | should be C<IO::AIO::MFD_CLOEXEC>. |
|
|
2535 | |
|
|
2536 | On success, the new memfd filehandle is returned, otherwise returns |
|
|
2537 | C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>. |
|
|
2538 | |
|
|
2539 | Please refer to L<memfd_create(2)> for more info on this call. |
|
|
2540 | |
|
|
2541 | The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>, |
|
|
2542 | C<IO::AIO::MFD_ALLOW_SEALING>, C<IO::AIO::MFD_HUGETLB>, |
|
|
2543 | C<IO::AIO::MFD_HUGETLB_2MB> and C<IO::AIO::MFD_HUGETLB_1GB>. |
|
|
2544 | |
|
|
2545 | Example: create a new memfd. |
|
|
2546 | |
|
|
2547 | my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC |
|
|
2548 | or die "memfd_create: $!\n"; |
|
|
2549 | |
|
|
2550 | =item $fh = IO::AIO::pidfd_open $pid[, $flags] |
|
|
2551 | |
|
|
2552 | This is an interface to the Linux L<pidfd_open(2)> system call. The |
|
|
2553 | default for C<$flags> is C<0>. |
|
|
2554 | |
|
|
2555 | On success, a new pidfd filehandle is returned (that is already set to |
|
|
2556 | close-on-exec), otherwise returns C<undef>. If the syscall is missing, |
|
|
2557 | fails with C<ENOSYS>. |
|
|
2558 | |
|
|
2559 | Example: open pid 6341 as pidfd. |
|
|
2560 | |
|
|
2561 | my $fh = IO::AIO::pidfd_open 6341 |
|
|
2562 | or die "pidfd_open: $!\n"; |
|
|
2563 | |
|
|
2564 | =item $status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[, $flags]] |
|
|
2565 | |
|
|
2566 | This is an interface to the Linux L<pidfd_send_signal> system call. The |
|
|
2567 | default for C<$siginfo> is C<undef> and the default for C<$flags> is C<0>. |
|
|
2568 | |
|
|
2569 | Returns the system call status. If the syscall is missing, fails with |
|
|
2570 | C<ENOSYS>. |
|
|
2571 | |
|
|
2572 | When specified, C<$siginfo> must be a reference to a hash with one or more |
|
|
2573 | of the following members: |
|
|
2574 | |
|
|
2575 | =over |
|
|
2576 | |
|
|
2577 | =item code - the C<si_code> member |
|
|
2578 | |
|
|
2579 | =item pid - the C<si_pid> member |
|
|
2580 | |
|
|
2581 | =item uid - the C<si_uid> member |
|
|
2582 | |
|
|
2583 | =item value_int - the C<si_value.sival_int> member |
|
|
2584 | |
|
|
2585 | =item value_ptr - the C<si_value.sival_ptr> member, specified as an integer |
|
|
2586 | |
|
|
2587 | =back |
|
|
2588 | |
|
|
2589 | Example: send a SIGKILL to the specified process. |
|
|
2590 | |
|
|
2591 | my $status = IO::AIO::pidfd_send_signal $pidfh, 9, undef |
|
|
2592 | and die "pidfd_send_signal: $!\n"; |
|
|
2593 | |
|
|
2594 | Example: send a SIGKILL to the specified process with extra data. |
|
|
2595 | |
|
|
2596 | my $status = IO::AIO::pidfd_send_signal $pidfh, 9, { code => -1, value_int => 7 } |
|
|
2597 | and die "pidfd_send_signal: $!\n"; |
|
|
2598 | |
|
|
2599 | =item $fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags] |
|
|
2600 | |
|
|
2601 | This is an interface to the Linux L<pidfd_getfd> system call. The default |
|
|
2602 | for C<$flags> is C<0>. |
|
|
2603 | |
|
|
2604 | On success, returns a dup'ed copy of the target file descriptor (specified |
|
|
2605 | as an integer) returned (that is already set to close-on-exec), otherwise |
|
|
2606 | returns C<undef>. If the syscall is missing, fails with C<ENOSYS>. |
|
|
2607 | |
|
|
2608 | Example: get a copy of standard error of another process and print soemthing to it. |
|
|
2609 | |
|
|
2610 | my $errfh = IO::AIO::pidfd_getfd $pidfh, 2 |
|
|
2611 | or die "pidfd_getfd: $!\n"; |
|
|
2612 | print $errfh "stderr\n"; |
|
|
2613 | |
2364 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
2614 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
2365 | |
2615 | |
2366 | This is a direct interface to the Linux L<eventfd(2)> system call. The |
2616 | 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. |
2617 | (unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both. |
2368 | |
2618 | |
… | |
… | |
2374 | The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, |
2624 | 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). |
2625 | C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). |
2376 | |
2626 | |
2377 | Example: create a new eventfd filehandle: |
2627 | Example: create a new eventfd filehandle: |
2378 | |
2628 | |
2379 | $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC |
2629 | $fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC |
2380 | or die "eventfd: $!\n"; |
2630 | or die "eventfd: $!\n"; |
2381 | |
2631 | |
2382 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
2632 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
2383 | |
2633 | |
2384 | This is a direct interface to the Linux L<timerfd_create(2)> system call. The |
2634 | This is a direct interface to the Linux L<timerfd_create(2)> system |
2385 | (unhelpful) default for C<$flags> is C<0>. |
2635 | call. The (unhelpful) default for C<$flags> is C<0>, but your default |
|
|
2636 | should be C<IO::AIO::TFD_CLOEXEC>. |
2386 | |
2637 | |
2387 | On success, the new timerfd filehandle is returned, otherwise returns |
2638 | On success, the new timerfd filehandle is returned, otherwise returns |
2388 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
2639 | C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>. |
2389 | |
2640 | |
2390 | Please refer to L<timerfd_create(2)> for more info on this call. |
2641 | Please refer to L<timerfd_create(2)> for more info on this call. |
2391 | |
2642 | |
2392 | The following C<$clockid> values are |
2643 | The following C<$clockid> values are |
2393 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |
2644 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |
… | |
… | |
2559 | known issue, rather than a bug. |
2810 | known issue, rather than a bug. |
2560 | |
2811 | |
2561 | =head1 SEE ALSO |
2812 | =head1 SEE ALSO |
2562 | |
2813 | |
2563 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2814 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2564 | more natural syntax. |
2815 | more natural syntax and L<IO::FDPass> for file descriptor passing. |
2565 | |
2816 | |
2566 | =head1 AUTHOR |
2817 | =head1 AUTHOR |
2567 | |
2818 | |
2568 | Marc Lehmann <schmorp@schmorp.de> |
2819 | Marc Lehmann <schmorp@schmorp.de> |
2569 | http://home.schmorp.de/ |
2820 | http://home.schmorp.de/ |