1 | NAME |
1 | NAME |
2 | IO::AIO - Asynchronous Input/Output |
2 | IO::AIO - Asynchronous/Advanced Input/Output |
3 | |
3 | |
4 | SYNOPSIS |
4 | SYNOPSIS |
5 | use IO::AIO; |
5 | use IO::AIO; |
6 | |
6 | |
7 | aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub { |
7 | aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub { |
… | |
… | |
54 | functions available on many operating systems. However, they are often |
54 | functions available on many operating systems. However, they are often |
55 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
55 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
56 | files currently, for example), and they would only support aio_read and |
56 | files currently, for example), and they would only support aio_read and |
57 | aio_write, so the remaining functionality would have to be implemented |
57 | aio_write, so the remaining functionality would have to be implemented |
58 | using threads anyway. |
58 | using threads anyway. |
|
|
59 | |
|
|
60 | In addition to asynchronous I/O, this module also exports some rather |
|
|
61 | arcane interfaces, such as "madvise" or linux's "splice" system call, |
|
|
62 | which is why the "A" in "AIO" can also mean *advanced*. |
59 | |
63 | |
60 | Although the module will work in the presence of other (Perl-) threads, |
64 | Although the module will work in the presence of other (Perl-) threads, |
61 | it is currently not reentrant in any way, so use appropriate locking |
65 | it is currently not reentrant in any way, so use appropriate locking |
62 | yourself, always call "poll_cb" from within the same thread, or never |
66 | yourself, always call "poll_cb" from within the same thread, or never |
63 | call "poll_cb" (or other "aio_" functions) recursively. |
67 | call "poll_cb" (or other "aio_" functions) recursively. |
… | |
… | |
173 | aio_link $srcpath, $dstpath, $callback->($status) |
177 | aio_link $srcpath, $dstpath, $callback->($status) |
174 | aio_symlink $srcpath, $dstpath, $callback->($status) |
178 | aio_symlink $srcpath, $dstpath, $callback->($status) |
175 | aio_readlink $pathname, $callback->($link) |
179 | aio_readlink $pathname, $callback->($link) |
176 | aio_realpath $pathname, $callback->($path) |
180 | aio_realpath $pathname, $callback->($path) |
177 | aio_rename $srcpath, $dstpath, $callback->($status) |
181 | aio_rename $srcpath, $dstpath, $callback->($status) |
|
|
182 | aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
178 | aio_mkdir $pathname, $mode, $callback->($status) |
183 | aio_mkdir $pathname, $mode, $callback->($status) |
179 | aio_rmdir $pathname, $callback->($status) |
184 | aio_rmdir $pathname, $callback->($status) |
180 | aio_readdir $pathname, $callback->($entries) |
185 | aio_readdir $pathname, $callback->($entries) |
181 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
186 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
182 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
187 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
… | |
… | |
192 | aio_syncfs $fh, $callback->($status) |
197 | aio_syncfs $fh, $callback->($status) |
193 | aio_fsync $fh, $callback->($status) |
198 | aio_fsync $fh, $callback->($status) |
194 | aio_fdatasync $fh, $callback->($status) |
199 | aio_fdatasync $fh, $callback->($status) |
195 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
200 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
196 | aio_pathsync $pathname, $callback->($status) |
201 | aio_pathsync $pathname, $callback->($status) |
197 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
202 | aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
198 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
203 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
199 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
204 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
200 | aio_mlockall $flags, $callback->($status) |
205 | aio_mlockall $flags, $callback->($status) |
201 | aio_group $callback->(...) |
206 | aio_group $callback->(...) |
202 | aio_nop $callback->() |
207 | aio_nop $callback->() |
… | |
… | |
216 | IO::AIO::idle_timeout $seconds |
221 | IO::AIO::idle_timeout $seconds |
217 | IO::AIO::max_outstanding $maxreqs |
222 | IO::AIO::max_outstanding $maxreqs |
218 | IO::AIO::nreqs |
223 | IO::AIO::nreqs |
219 | IO::AIO::nready |
224 | IO::AIO::nready |
220 | IO::AIO::npending |
225 | IO::AIO::npending |
|
|
226 | IO::AIO::reinit |
|
|
227 | |
|
|
228 | $nfd = IO::AIO::get_fdlimit |
|
|
229 | IO::AIO::min_fdlimit $nfd |
221 | |
230 | |
222 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
231 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
223 | IO::AIO::fadvise $fh, $offset, $len, $advice |
232 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
233 | IO::AIO::fexecve $fh, $argv, $envp |
|
|
234 | |
224 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
235 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
225 | IO::AIO::munmap $scalar |
236 | IO::AIO::munmap $scalar |
|
|
237 | IO::AIO::mremap $scalar, $new_length, $flags[, $new_address] |
226 | IO::AIO::madvise $scalar, $offset, $length, $advice |
238 | IO::AIO::madvise $scalar, $offset, $length, $advice |
227 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
239 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
228 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
240 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
229 | IO::AIO::munlockall |
241 | IO::AIO::munlockall |
|
|
242 | |
|
|
243 | # stat extensions |
|
|
244 | $counter = IO::AIO::st_gen |
|
|
245 | $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime |
|
|
246 | ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
|
|
247 | $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec |
|
|
248 | $seconds = IO::AIO::st_btimesec |
|
|
249 | ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec |
|
|
250 | |
|
|
251 | # very much unportable syscalls |
|
|
252 | IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_len, $flags |
|
|
253 | IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
|
|
254 | IO::AIO::tee $r_fh, $w_fh, $length, $flags |
|
|
255 | |
|
|
256 | $actual_size = IO::AIO::pipesize $r_fh[, $new_size] |
|
|
257 | ($rfh, $wfh) = IO::AIO::pipe2 [$flags] |
|
|
258 | |
|
|
259 | $fh = IO::AIO::eventfd [$initval, [$flags]] |
|
|
260 | $fh = IO::AIO::memfd_create $pathname[, $flags] |
|
|
261 | |
|
|
262 | $fh = IO::AIO::timerfd_create $clockid[, $flags] |
|
|
263 | ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value |
|
|
264 | ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh |
|
|
265 | |
|
|
266 | $fh = IO::AIO::pidfd_open $pid[, $flags] |
|
|
267 | $status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[, $flags]] |
|
|
268 | $fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags] |
|
|
269 | |
|
|
270 | $retval = IO::AIO::mount $special, $path, $fstype, $flags = 0, $data = undef |
|
|
271 | $retval = IO::AIO::umount $path, $flags = 0 |
230 | |
272 | |
231 | API NOTES |
273 | API NOTES |
232 | All the "aio_*" calls are more or less thin wrappers around the syscall |
274 | All the "aio_*" calls are more or less thin wrappers around the syscall |
233 | with the same name (sans "aio_"). The arguments are similar or |
275 | with the same name (sans "aio_"). The arguments are similar or |
234 | identical, and they all accept an additional (and optional) $callback |
276 | identical, and they all accept an additional (and optional) $callback |
… | |
… | |
332 | "O_APPEND"), the following POSIX and non-POSIX constants are |
374 | "O_APPEND"), the following POSIX and non-POSIX constants are |
333 | available (missing ones on your system are, as usual, 0): |
375 | available (missing ones on your system are, as usual, 0): |
334 | |
376 | |
335 | "O_ASYNC", "O_DIRECT", "O_NOATIME", "O_CLOEXEC", "O_NOCTTY", |
377 | "O_ASYNC", "O_DIRECT", "O_NOATIME", "O_CLOEXEC", "O_NOCTTY", |
336 | "O_NOFOLLOW", "O_NONBLOCK", "O_EXEC", "O_SEARCH", "O_DIRECTORY", |
378 | "O_NOFOLLOW", "O_NONBLOCK", "O_EXEC", "O_SEARCH", "O_DIRECTORY", |
337 | "O_DSYNC", "O_RSYNC", "O_SYNC", "O_PATH", "O_TMPFILE", and |
379 | "O_DSYNC", "O_RSYNC", "O_SYNC", "O_PATH", "O_TMPFILE", "O_TTY_INIT" |
338 | "O_TTY_INIT". |
380 | and "O_ACCMODE". |
339 | |
381 | |
340 | aio_close $fh, $callback->($status) |
382 | aio_close $fh, $callback->($status) |
341 | Asynchronously close a file and call the callback with the result |
383 | Asynchronously close a file and call the callback with the result |
342 | code. |
384 | code. |
343 | |
385 | |
… | |
… | |
373 | |
415 | |
374 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
416 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
375 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
417 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
376 | Reads or writes $length bytes from or to the specified $fh and |
418 | Reads or writes $length bytes from or to the specified $fh and |
377 | $offset into the scalar given by $data and offset $dataoffset and |
419 | $offset into the scalar given by $data and offset $dataoffset and |
378 | calls the callback without the actual number of bytes read (or -1 on |
420 | calls the callback with the actual number of bytes transferred (or |
379 | error, just like the syscall). |
421 | -1 on error, just like the syscall). |
380 | |
422 | |
381 | "aio_read" will, like "sysread", shrink or grow the $data scalar to |
423 | "aio_read" will, like "sysread", shrink or grow the $data scalar to |
382 | offset plus the actual number of bytes read. |
424 | offset plus the actual number of bytes read. |
383 | |
425 | |
384 | If $offset is undefined, then the current file descriptor offset |
426 | If $offset is undefined, then the current file descriptor offset |
… | |
… | |
441 | As native sendfile syscalls (as practically any non-POSIX interface |
483 | As native sendfile syscalls (as practically any non-POSIX interface |
442 | hacked together in a hurry to improve benchmark numbers) tend to be |
484 | hacked together in a hurry to improve benchmark numbers) tend to be |
443 | rather buggy on many systems, this implementation tries to work |
485 | rather buggy on many systems, this implementation tries to work |
444 | around some known bugs in Linux and FreeBSD kernels (probably |
486 | around some known bugs in Linux and FreeBSD kernels (probably |
445 | others, too), but that might fail, so you really really should check |
487 | others, too), but that might fail, so you really really should check |
446 | the return value of "aio_sendfile" - fewre bytes than expected might |
488 | the return value of "aio_sendfile" - fewer bytes than expected might |
447 | have been transferred. |
489 | have been transferred. |
448 | |
490 | |
449 | aio_readahead $fh,$offset,$length, $callback->($retval) |
491 | aio_readahead $fh,$offset,$length, $callback->($retval) |
450 | "aio_readahead" populates the page cache with data from a file so |
492 | "aio_readahead" populates the page cache with data from a file so |
451 | that subsequent reads from that file will not block on disk I/O. The |
493 | that subsequent reads from that file will not block on disk I/O. The |
… | |
… | |
455 | to a page boundary and bytes are read up to the next page boundary |
497 | to a page boundary and bytes are read up to the next page boundary |
456 | greater than or equal to (off-set+length). "aio_readahead" does not |
498 | greater than or equal to (off-set+length). "aio_readahead" does not |
457 | read beyond the end of the file. The current file offset of the file |
499 | read beyond the end of the file. The current file offset of the file |
458 | is left unchanged. |
500 | is left unchanged. |
459 | |
501 | |
460 | If that syscall doesn't exist (likely if your OS isn't Linux) it |
502 | If that syscall doesn't exist (likely if your kernel isn't Linux) it |
461 | will be emulated by simply reading the data, which would have a |
503 | will be emulated by simply reading the data, which would have a |
462 | similar effect. |
504 | similar effect. |
463 | |
505 | |
464 | aio_stat $fh_or_path, $callback->($status) |
506 | aio_stat $fh_or_path, $callback->($status) |
465 | aio_lstat $fh, $callback->($status) |
507 | aio_lstat $fh, $callback->($status) |
466 | Works like perl's "stat" or "lstat" in void context. The callback |
508 | Works almost exactly like perl's "stat" or "lstat" in void context. |
467 | will be called after the stat and the results will be available |
509 | The callback will be called after the stat and the results will be |
468 | using "stat _" or "-s _" etc... |
510 | available using "stat _" or "-s _" and other tests (with the |
|
|
511 | exception of "-B" and "-T"). |
469 | |
512 | |
470 | The pathname passed to "aio_stat" must be absolute. See API NOTES, |
513 | The pathname passed to "aio_stat" must be absolute. See API NOTES, |
471 | above, for an explanation. |
514 | above, for an explanation. |
472 | |
515 | |
473 | Currently, the stats are always 64-bit-stats, i.e. instead of |
516 | Currently, the stats are always 64-bit-stats, i.e. instead of |
… | |
… | |
481 | back on traditional behaviour). |
524 | back on traditional behaviour). |
482 | |
525 | |
483 | "S_IFMT", "S_IFIFO", "S_IFCHR", "S_IFBLK", "S_IFLNK", "S_IFREG", |
526 | "S_IFMT", "S_IFIFO", "S_IFCHR", "S_IFBLK", "S_IFLNK", "S_IFREG", |
484 | "S_IFDIR", "S_IFWHT", "S_IFSOCK", "IO::AIO::major $dev_t", |
527 | "S_IFDIR", "S_IFWHT", "S_IFSOCK", "IO::AIO::major $dev_t", |
485 | "IO::AIO::minor $dev_t", "IO::AIO::makedev $major, $minor". |
528 | "IO::AIO::minor $dev_t", "IO::AIO::makedev $major, $minor". |
|
|
529 | |
|
|
530 | To access higher resolution stat timestamps, see "SUBSECOND STAT |
|
|
531 | TIME ACCESS". |
486 | |
532 | |
487 | Example: Print the length of /etc/passwd: |
533 | Example: Print the length of /etc/passwd: |
488 | |
534 | |
489 | aio_stat "/etc/passwd", sub { |
535 | aio_stat "/etc/passwd", sub { |
490 | $_[0] and die "stat failed: $!"; |
536 | $_[0] and die "stat failed: $!"; |
… | |
… | |
532 | namemax => 255, |
578 | namemax => 255, |
533 | frsize => 1024, |
579 | frsize => 1024, |
534 | fsid => 1810 |
580 | fsid => 1810 |
535 | } |
581 | } |
536 | |
582 | |
537 | Here is a (likely partial - send me updates!) list of fsid values |
|
|
538 | used by Linux - it is safe to hardcode these when $^O is "linux": |
|
|
539 | |
|
|
540 | 0x0000adf5 adfs |
|
|
541 | 0x0000adff affs |
|
|
542 | 0x5346414f afs |
|
|
543 | 0x09041934 anon-inode filesystem |
|
|
544 | 0x00000187 autofs |
|
|
545 | 0x42465331 befs |
|
|
546 | 0x1badface bfs |
|
|
547 | 0x42494e4d binfmt_misc |
|
|
548 | 0x9123683e btrfs |
|
|
549 | 0x0027e0eb cgroupfs |
|
|
550 | 0xff534d42 cifs |
|
|
551 | 0x73757245 coda |
|
|
552 | 0x012ff7b7 coh |
|
|
553 | 0x28cd3d45 cramfs |
|
|
554 | 0x453dcd28 cramfs-wend (wrong endianness) |
|
|
555 | 0x64626720 debugfs |
|
|
556 | 0x00001373 devfs |
|
|
557 | 0x00001cd1 devpts |
|
|
558 | 0x0000f15f ecryptfs |
|
|
559 | 0x00414a53 efs |
|
|
560 | 0x0000137d ext |
|
|
561 | 0x0000ef53 ext2/ext3/ext4 |
|
|
562 | 0x0000ef51 ext2 |
|
|
563 | 0xf2f52010 f2fs |
|
|
564 | 0x00004006 fat |
|
|
565 | 0x65735546 fuseblk |
|
|
566 | 0x65735543 fusectl |
|
|
567 | 0x0bad1dea futexfs |
|
|
568 | 0x01161970 gfs2 |
|
|
569 | 0x47504653 gpfs |
|
|
570 | 0x00004244 hfs |
|
|
571 | 0xf995e849 hpfs |
|
|
572 | 0x00c0ffee hostfs |
|
|
573 | 0x958458f6 hugetlbfs |
|
|
574 | 0x2bad1dea inotifyfs |
|
|
575 | 0x00009660 isofs |
|
|
576 | 0x000072b6 jffs2 |
|
|
577 | 0x3153464a jfs |
|
|
578 | 0x6b414653 k-afs |
|
|
579 | 0x0bd00bd0 lustre |
|
|
580 | 0x0000137f minix |
|
|
581 | 0x0000138f minix 30 char names |
|
|
582 | 0x00002468 minix v2 |
|
|
583 | 0x00002478 minix v2 30 char names |
|
|
584 | 0x00004d5a minix v3 |
|
|
585 | 0x19800202 mqueue |
|
|
586 | 0x00004d44 msdos |
|
|
587 | 0x0000564c novell |
|
|
588 | 0x00006969 nfs |
|
|
589 | 0x6e667364 nfsd |
|
|
590 | 0x00003434 nilfs |
|
|
591 | 0x5346544e ntfs |
|
|
592 | 0x00009fa1 openprom |
|
|
593 | 0x7461636F ocfs2 |
|
|
594 | 0x00009fa0 proc |
|
|
595 | 0x6165676c pstorefs |
|
|
596 | 0x0000002f qnx4 |
|
|
597 | 0x68191122 qnx6 |
|
|
598 | 0x858458f6 ramfs |
|
|
599 | 0x52654973 reiserfs |
|
|
600 | 0x00007275 romfs |
|
|
601 | 0x67596969 rpc_pipefs |
|
|
602 | 0x73636673 securityfs |
|
|
603 | 0xf97cff8c selinux |
|
|
604 | 0x0000517b smb |
|
|
605 | 0x534f434b sockfs |
|
|
606 | 0x73717368 squashfs |
|
|
607 | 0x62656572 sysfs |
|
|
608 | 0x012ff7b6 sysv2 |
|
|
609 | 0x012ff7b5 sysv4 |
|
|
610 | 0x01021994 tmpfs |
|
|
611 | 0x15013346 udf |
|
|
612 | 0x00011954 ufs |
|
|
613 | 0x54190100 ufs byteswapped |
|
|
614 | 0x00009fa2 usbdevfs |
|
|
615 | 0x01021997 v9fs |
|
|
616 | 0xa501fcf5 vxfs |
|
|
617 | 0xabba1974 xenfs |
|
|
618 | 0x012ff7b4 xenix |
|
|
619 | 0x58465342 xfs |
|
|
620 | 0x012fd16d xia |
|
|
621 | |
|
|
622 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
583 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
623 | Works like perl's "utime" function (including the special case of |
584 | Works like perl's "utime" function (including the special case of |
624 | $atime and $mtime being undef). Fractional times are supported if |
585 | $atime and $mtime being undef). Fractional times are supported if |
625 | the underlying syscalls support them. |
586 | the underlying syscalls support them. |
626 | |
587 | |
627 | When called with a pathname, uses utimes(2) if available, otherwise |
588 | When called with a pathname, uses utimensat(2) or utimes(2) if |
628 | utime(2). If called on a file descriptor, uses futimes(2) if |
589 | available, otherwise utime(2). If called on a file descriptor, uses |
629 | available, otherwise returns ENOSYS, so this is not portable. |
590 | futimens(2) or futimes(2) if available, otherwise returns ENOSYS, so |
|
|
591 | this is not portable. |
630 | |
592 | |
631 | Examples: |
593 | Examples: |
632 | |
594 | |
633 | # set atime and mtime to current time (basically touch(1)): |
595 | # set atime and mtime to current time (basically touch(1)): |
634 | aio_utime "path", undef, undef; |
596 | aio_utime "path", undef, undef; |
… | |
… | |
657 | $mode is usually 0 or "IO::AIO::FALLOC_FL_KEEP_SIZE" to allocate |
619 | $mode is usually 0 or "IO::AIO::FALLOC_FL_KEEP_SIZE" to allocate |
658 | space, or "IO::AIO::FALLOC_FL_PUNCH_HOLE | |
620 | space, or "IO::AIO::FALLOC_FL_PUNCH_HOLE | |
659 | IO::AIO::FALLOC_FL_KEEP_SIZE", to deallocate a file range. |
621 | IO::AIO::FALLOC_FL_KEEP_SIZE", to deallocate a file range. |
660 | |
622 | |
661 | IO::AIO also supports "FALLOC_FL_COLLAPSE_RANGE", to remove a range |
623 | IO::AIO also supports "FALLOC_FL_COLLAPSE_RANGE", to remove a range |
662 | (without leaving a hole) and "FALLOC_FL_ZERO_RANGE", to zero a range |
624 | (without leaving a hole), "FALLOC_FL_ZERO_RANGE", to zero a range, |
|
|
625 | "FALLOC_FL_INSERT_RANGE" to insert a range and |
|
|
626 | "FALLOC_FL_UNSHARE_RANGE" to unshare shared blocks (see your |
663 | (see your fallocate(2) manpage). |
627 | fallocate(2) manpage). |
664 | |
628 | |
665 | The file system block size used by "fallocate" is presumably the |
629 | The file system block size used by "fallocate" is presumably the |
666 | "f_bsize" returned by "statvfs". |
630 | "f_bsize" returned by "statvfs", but different filesystems and |
|
|
631 | filetypes can dictate other limitations. |
667 | |
632 | |
668 | If "fallocate" isn't available or cannot be emulated (currently no |
633 | If "fallocate" isn't available or cannot be emulated (currently no |
669 | emulation will be attempted), passes -1 and sets $! to "ENOSYS". |
634 | emulation will be attempted), passes -1 and sets $! to "ENOSYS". |
670 | |
635 | |
671 | aio_chmod $fh_or_path, $mode, $callback->($status) |
636 | aio_chmod $fh_or_path, $mode, $callback->($status) |
… | |
… | |
715 | |
680 | |
716 | On systems that support the AIO::WD working directory abstraction |
681 | On systems that support the AIO::WD working directory abstraction |
717 | natively, the case "[$wd, "."]" as $srcpath is specialcased - |
682 | natively, the case "[$wd, "."]" as $srcpath is specialcased - |
718 | instead of failing, "rename" is called on the absolute path of $wd. |
683 | instead of failing, "rename" is called on the absolute path of $wd. |
719 | |
684 | |
|
|
685 | aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
|
|
686 | Basically a version of "aio_rename" with an additional $flags |
|
|
687 | argument. Calling this with "$flags=0" is the same as calling |
|
|
688 | "aio_rename". |
|
|
689 | |
|
|
690 | Non-zero flags are currently only supported on GNU/Linux systems |
|
|
691 | that support renameat2. Other systems fail with "ENOSYS" in this |
|
|
692 | case. |
|
|
693 | |
|
|
694 | The following constants are available (missing ones are, as usual |
|
|
695 | 0), see renameat2(2) for details: |
|
|
696 | |
|
|
697 | "IO::AIO::RENAME_NOREPLACE", "IO::AIO::RENAME_EXCHANGE" and |
|
|
698 | "IO::AIO::RENAME_WHITEOUT". |
|
|
699 | |
720 | aio_mkdir $pathname, $mode, $callback->($status) |
700 | aio_mkdir $pathname, $mode, $callback->($status) |
721 | Asynchronously mkdir (create) a directory and call the callback with |
701 | Asynchronously mkdir (create) a directory and call the callback with |
722 | the result code. $mode will be modified by the umask at the time the |
702 | the result code. $mode will be modified by the umask at the time the |
723 | request is executed, so do not change your umask. |
703 | request is executed, so do not change your umask. |
724 | |
704 | |
… | |
… | |
746 | The flags are a combination of the following constants, ORed |
726 | The flags are a combination of the following constants, ORed |
747 | together (the flags will also be passed to the callback, possibly |
727 | together (the flags will also be passed to the callback, possibly |
748 | modified): |
728 | modified): |
749 | |
729 | |
750 | IO::AIO::READDIR_DENTS |
730 | IO::AIO::READDIR_DENTS |
751 | When this flag is off, then the callback gets an arrayref |
731 | Normally the callback gets an arrayref consisting of names only |
752 | consisting of names only (as with "aio_readdir"), otherwise it |
732 | (as with "aio_readdir"). If this flag is set, then the callback |
753 | gets an arrayref with "[$name, $type, $inode]" arrayrefs, each |
733 | gets an arrayref with "[$name, $type, $inode]" arrayrefs, each |
754 | describing a single directory entry in more detail. |
734 | describing a single directory entry in more detail: |
755 | |
735 | |
756 | $name is the name of the entry. |
736 | $name is the name of the entry. |
757 | |
737 | |
758 | $type is one of the "IO::AIO::DT_xxx" constants: |
738 | $type is one of the "IO::AIO::DT_xxx" constants: |
759 | |
739 | |
760 | "IO::AIO::DT_UNKNOWN", "IO::AIO::DT_FIFO", "IO::AIO::DT_CHR", |
740 | "IO::AIO::DT_UNKNOWN", "IO::AIO::DT_FIFO", "IO::AIO::DT_CHR", |
761 | "IO::AIO::DT_DIR", "IO::AIO::DT_BLK", "IO::AIO::DT_REG", |
741 | "IO::AIO::DT_DIR", "IO::AIO::DT_BLK", "IO::AIO::DT_REG", |
762 | "IO::AIO::DT_LNK", "IO::AIO::DT_SOCK", "IO::AIO::DT_WHT". |
742 | "IO::AIO::DT_LNK", "IO::AIO::DT_SOCK", "IO::AIO::DT_WHT". |
763 | |
743 | |
764 | "IO::AIO::DT_UNKNOWN" means just that: readdir does not know. If |
744 | "IO::AIO::DT_UNKNOWN" means just that: readdir does not know. If |
765 | you need to know, you have to run stat yourself. Also, for speed |
745 | you need to know, you have to run stat yourself. Also, for |
766 | reasons, the $type scalars are read-only: you can not modify |
746 | speed/memory reasons, the $type scalars are read-only: you must |
767 | them. |
747 | not modify them. |
768 | |
748 | |
769 | $inode is the inode number (which might not be exact on systems |
749 | $inode is the inode number (which might not be exact on systems |
770 | with 64 bit inode numbers and 32 bit perls). This field has |
750 | with 64 bit inode numbers and 32 bit perls). This field has |
771 | unspecified content on systems that do not deliver the inode |
751 | unspecified content on systems that do not deliver the inode |
772 | information. |
752 | information. |
… | |
… | |
784 | of which names with short names are tried first. |
764 | of which names with short names are tried first. |
785 | |
765 | |
786 | IO::AIO::READDIR_STAT_ORDER |
766 | IO::AIO::READDIR_STAT_ORDER |
787 | When this flag is set, then the names will be returned in an |
767 | When this flag is set, then the names will be returned in an |
788 | order suitable for stat()'ing each one. That is, when you plan |
768 | order suitable for stat()'ing each one. That is, when you plan |
789 | to stat() all files in the given directory, then the returned |
769 | to stat() most or all files in the given directory, then the |
790 | order will likely be fastest. |
770 | returned order will likely be faster. |
791 | |
771 | |
792 | If both this flag and "IO::AIO::READDIR_DIRS_FIRST" are |
772 | If both this flag and "IO::AIO::READDIR_DIRS_FIRST" are |
793 | specified, then the likely dirs come first, resulting in a less |
773 | specified, then the likely dirs come first, resulting in a less |
794 | optimal stat order. |
774 | optimal stat order for stat'ing all entries, but likely a more |
|
|
775 | optimal order for finding subdirectories. |
795 | |
776 | |
796 | IO::AIO::READDIR_FOUND_UNKNOWN |
777 | IO::AIO::READDIR_FOUND_UNKNOWN |
797 | This flag should not be set when calling "aio_readdirx". |
778 | This flag should not be set when calling "aio_readdirx". |
798 | Instead, it is being set by "aio_readdirx", when any of the |
779 | Instead, it is being set by "aio_readdirx", when any of the |
799 | $type's found were "IO::AIO::DT_UNKNOWN". The absence of this |
780 | $type's found were "IO::AIO::DT_UNKNOWN". The absence of this |
800 | flag therefore indicates that all $type's are known, which can |
781 | flag therefore indicates that all $type's are known, which can |
801 | be used to speed up some algorithms. |
782 | be used to speed up some algorithms. |
802 | |
783 | |
|
|
784 | aio_slurp $pathname, $offset, $length, $data, $callback->($status) |
|
|
785 | Opens, reads and closes the given file. The data is put into $data, |
|
|
786 | which is resized as required. |
|
|
787 | |
|
|
788 | If $offset is negative, then it is counted from the end of the file. |
|
|
789 | |
|
|
790 | If $length is zero, then the remaining length of the file is used. |
|
|
791 | Also, in this case, the same limitations to modifying $data apply as |
|
|
792 | when IO::AIO::mmap is used, i.e. it must only be modified in-place |
|
|
793 | with "substr". If the size of the file is known, specifying a |
|
|
794 | non-zero $length results in a performance advantage. |
|
|
795 | |
|
|
796 | This request is similar to the older "aio_load" request, but since |
|
|
797 | it is a single request, it might be more efficient to use. |
|
|
798 | |
|
|
799 | Example: load /etc/passwd into $passwd. |
|
|
800 | |
|
|
801 | my $passwd; |
|
|
802 | aio_slurp "/etc/passwd", 0, 0, $passwd, sub { |
|
|
803 | $_[0] >= 0 |
|
|
804 | or die "/etc/passwd: $!\n"; |
|
|
805 | |
|
|
806 | printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd; |
|
|
807 | print $passwd; |
|
|
808 | }; |
|
|
809 | IO::AIO::flush; |
|
|
810 | |
803 | aio_load $pathname, $data, $callback->($status) |
811 | aio_load $pathname, $data, $callback->($status) |
804 | This is a composite request that tries to fully load the given file |
812 | This is a composite request that tries to fully load the given file |
805 | into memory. Status is the same as with aio_read. |
813 | into memory. Status is the same as with aio_read. |
|
|
814 | |
|
|
815 | Using "aio_slurp" might be more efficient, as it is a single |
|
|
816 | request. |
806 | |
817 | |
807 | aio_copy $srcpath, $dstpath, $callback->($status) |
818 | aio_copy $srcpath, $dstpath, $callback->($status) |
808 | Try to copy the *file* (directories not supported as either source |
819 | Try to copy the *file* (directories not supported as either source |
809 | or destination) from $srcpath to $dstpath and call the callback with |
820 | or destination) from $srcpath to $dstpath and call the callback with |
810 | a status of 0 (ok) or -1 (error, see $!). |
821 | a status of 0 (ok) or -1 (error, see $!). |
|
|
822 | |
|
|
823 | Existing destination files will be truncated. |
811 | |
824 | |
812 | This is a composite request that creates the destination file with |
825 | This is a composite request that creates the destination file with |
813 | mode 0200 and copies the contents of the source file into it using |
826 | mode 0200 and copies the contents of the source file into it using |
814 | "aio_sendfile", followed by restoring atime, mtime, access mode and |
827 | "aio_sendfile", followed by restoring atime, mtime, access mode and |
815 | uid/gid, in that order. |
828 | uid/gid, in that order. |
… | |
… | |
832 | to efficiently separate the entries of directory $path into two sets |
845 | to efficiently separate the entries of directory $path into two sets |
833 | of names, directories you can recurse into (directories), and ones |
846 | of names, directories you can recurse into (directories), and ones |
834 | you cannot recurse into (everything else, including symlinks to |
847 | you cannot recurse into (everything else, including symlinks to |
835 | directories). |
848 | directories). |
836 | |
849 | |
837 | "aio_scandir" is a composite request that creates of many sub |
850 | "aio_scandir" is a composite request that generates many sub |
838 | requests_ $maxreq specifies the maximum number of outstanding aio |
851 | requests. $maxreq specifies the maximum number of outstanding aio |
839 | requests that this function generates. If it is "<= 0", then a |
852 | requests that this function generates. If it is "<= 0", then a |
840 | suitable default will be chosen (currently 4). |
853 | suitable default will be chosen (currently 4). |
841 | |
854 | |
842 | On error, the callback is called without arguments, otherwise it |
855 | On error, the callback is called without arguments, otherwise it |
843 | receives two array-refs with path-relative entry names. |
856 | receives two array-refs with path-relative entry names. |
… | |
… | |
908 | So in general, you should only use these calls for things that do |
921 | So in general, you should only use these calls for things that do |
909 | (filesystem) I/O, not for things that wait for other events |
922 | (filesystem) I/O, not for things that wait for other events |
910 | (network, other processes), although if you are careful and know |
923 | (network, other processes), although if you are careful and know |
911 | what you are doing, you still can. |
924 | what you are doing, you still can. |
912 | |
925 | |
|
|
926 | The following constants are available and can be used for normal |
|
|
927 | "ioctl" and "fcntl" as well (missing ones are, as usual 0): |
|
|
928 | |
|
|
929 | "F_DUPFD_CLOEXEC", |
|
|
930 | |
|
|
931 | "F_OFD_GETLK", "F_OFD_SETLK", "F_OFD_GETLKW", |
|
|
932 | |
|
|
933 | "FIFREEZE", "FITHAW", "FITRIM", "FICLONE", "FICLONERANGE", |
|
|
934 | "FIDEDUPERANGE". |
|
|
935 | |
|
|
936 | "F_ADD_SEALS", "F_GET_SEALS", "F_SEAL_SEAL", "F_SEAL_SHRINK", |
|
|
937 | "F_SEAL_GROW" and "F_SEAL_WRITE". |
|
|
938 | |
|
|
939 | "FS_IOC_GETFLAGS", "FS_IOC_SETFLAGS", "FS_IOC_GETVERSION", |
|
|
940 | "FS_IOC_SETVERSION", "FS_IOC_FIEMAP". |
|
|
941 | |
|
|
942 | "FS_IOC_FSGETXATTR", "FS_IOC_FSSETXATTR", |
|
|
943 | "FS_IOC_SET_ENCRYPTION_POLICY", "FS_IOC_GET_ENCRYPTION_PWSALT", |
|
|
944 | "FS_IOC_GET_ENCRYPTION_POLICY", "FS_KEY_DESCRIPTOR_SIZE". |
|
|
945 | |
|
|
946 | "FS_SECRM_FL", "FS_UNRM_FL", "FS_COMPR_FL", "FS_SYNC_FL", |
|
|
947 | "FS_IMMUTABLE_FL", "FS_APPEND_FL", "FS_NODUMP_FL", "FS_NOATIME_FL", |
|
|
948 | "FS_DIRTY_FL", "FS_COMPRBLK_FL", "FS_NOCOMP_FL", "FS_ENCRYPT_FL", |
|
|
949 | "FS_BTREE_FL", "FS_INDEX_FL", "FS_JOURNAL_DATA_FL", "FS_NOTAIL_FL", |
|
|
950 | "FS_DIRSYNC_FL", "FS_TOPDIR_FL", "FS_FL_USER_MODIFIABLE". |
|
|
951 | |
|
|
952 | "FS_XFLAG_REALTIME", "FS_XFLAG_PREALLOC", "FS_XFLAG_IMMUTABLE", |
|
|
953 | "FS_XFLAG_APPEND", "FS_XFLAG_SYNC", "FS_XFLAG_NOATIME", |
|
|
954 | "FS_XFLAG_NODUMP", "FS_XFLAG_RTINHERIT", "FS_XFLAG_PROJINHERIT", |
|
|
955 | "FS_XFLAG_NOSYMLINKS", "FS_XFLAG_EXTSIZE", "FS_XFLAG_EXTSZINHERIT", |
|
|
956 | "FS_XFLAG_NODEFRAG", "FS_XFLAG_FILESTREAM", "FS_XFLAG_DAX", |
|
|
957 | "FS_XFLAG_HASATTR", |
|
|
958 | |
|
|
959 | "BLKROSET", "BLKROGET", "BLKRRPART", "BLKGETSIZE", "BLKFLSBUF", |
|
|
960 | "BLKRASET", "BLKRAGET", "BLKFRASET", "BLKFRAGET", "BLKSECTSET", |
|
|
961 | "BLKSECTGET", "BLKSSZGET", "BLKBSZGET", "BLKBSZSET", "BLKGETSIZE64", |
|
|
962 | |
913 | aio_sync $callback->($status) |
963 | aio_sync $callback->($status) |
914 | Asynchronously call sync and call the callback when finished. |
964 | Asynchronously call sync and call the callback when finished. |
915 | |
965 | |
916 | aio_fsync $fh, $callback->($status) |
966 | aio_fsync $fh, $callback->($status) |
917 | Asynchronously call fsync on the given filehandle and call the |
967 | Asynchronously call fsync on the given filehandle and call the |
… | |
… | |
953 | Future versions of this function might fall back to other methods |
1003 | Future versions of this function might fall back to other methods |
954 | when "fsync" on the directory fails (such as calling "sync"). |
1004 | when "fsync" on the directory fails (such as calling "sync"). |
955 | |
1005 | |
956 | Passes 0 when everything went ok, and -1 on error. |
1006 | Passes 0 when everything went ok, and -1 on error. |
957 | |
1007 | |
958 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, |
1008 | aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, |
959 | $callback->($status) |
1009 | $callback->($status) |
960 | This is a rather advanced IO::AIO call, which only works on |
1010 | This is a rather advanced IO::AIO call, which only works on |
961 | mmap(2)ed scalars (see the "IO::AIO::mmap" function, although it |
1011 | mmap(2)ed scalars (see the "IO::AIO::mmap" function, although it |
962 | also works on data scalars managed by the Sys::Mmap or Mmap modules, |
1012 | also works on data scalars managed by the Sys::Mmap or Mmap modules, |
963 | note that the scalar must only be modified in-place while an aio |
1013 | note that the scalar must only be modified in-place while an aio |
… | |
… | |
965 | |
1015 | |
966 | It calls the "msync" function of your OS, if available, with the |
1016 | It calls the "msync" function of your OS, if available, with the |
967 | memory area starting at $offset in the string and ending $length |
1017 | memory area starting at $offset in the string and ending $length |
968 | bytes later. If $length is negative, counts from the end, and if |
1018 | bytes later. If $length is negative, counts from the end, and if |
969 | $length is "undef", then it goes till the end of the string. The |
1019 | $length is "undef", then it goes till the end of the string. The |
970 | flags can be a combination of "IO::AIO::MS_ASYNC", |
1020 | flags can be either "IO::AIO::MS_ASYNC" or "IO::AIO::MS_SYNC", plus |
971 | "IO::AIO::MS_INVALIDATE" and "IO::AIO::MS_SYNC". |
1021 | an optional "IO::AIO::MS_INVALIDATE". |
972 | |
1022 | |
973 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, |
1023 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, |
974 | $callback->($status) |
1024 | $callback->($status) |
975 | This is a rather advanced IO::AIO call, which works best on |
1025 | This is a rather advanced IO::AIO call, which works best on |
976 | mmap(2)ed scalars. |
1026 | mmap(2)ed scalars. |
… | |
… | |
1007 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1057 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1008 | aio_mlock $data; # mlock in background |
1058 | aio_mlock $data; # mlock in background |
1009 | |
1059 | |
1010 | aio_mlockall $flags, $callback->($status) |
1060 | aio_mlockall $flags, $callback->($status) |
1011 | Calls the "mlockall" function with the given $flags (a combination |
1061 | Calls the "mlockall" function with the given $flags (a combination |
1012 | of "IO::AIO::MCL_CURRENT" and "IO::AIO::MCL_FUTURE"). |
1062 | of "IO::AIO::MCL_CURRENT", "IO::AIO::MCL_FUTURE" and |
|
|
1063 | "IO::AIO::MCL_ONFAULT"). |
1013 | |
1064 | |
1014 | On systems that do not implement "mlockall", this function returns |
1065 | On systems that do not implement "mlockall", this function returns |
1015 | -1 and sets errno to "ENOSYS". |
1066 | -1 and sets errno to "ENOSYS". Similarly, flag combinations not |
|
|
1067 | supported by the system result in a return value of -1 with errno |
|
|
1068 | being set to "EINVAL". |
1016 | |
1069 | |
1017 | Note that the corresponding "munlockall" is synchronous and is |
1070 | Note that the corresponding "munlockall" is synchronous and is |
1018 | documented under "MISCELLANEOUS FUNCTIONS". |
1071 | documented under "MISCELLANEOUS FUNCTIONS". |
1019 | |
1072 | |
1020 | Example: asynchronously lock all current and future pages into |
1073 | Example: asynchronously lock all current and future pages into |
… | |
… | |
1062 | "IO::AIO::FIEMAP_EXTENT_DATA_INLINE", |
1115 | "IO::AIO::FIEMAP_EXTENT_DATA_INLINE", |
1063 | "IO::AIO::FIEMAP_EXTENT_DATA_TAIL", |
1116 | "IO::AIO::FIEMAP_EXTENT_DATA_TAIL", |
1064 | "IO::AIO::FIEMAP_EXTENT_UNWRITTEN", "IO::AIO::FIEMAP_EXTENT_MERGED" |
1117 | "IO::AIO::FIEMAP_EXTENT_UNWRITTEN", "IO::AIO::FIEMAP_EXTENT_MERGED" |
1065 | or "IO::AIO::FIEMAP_EXTENT_SHARED". |
1118 | or "IO::AIO::FIEMAP_EXTENT_SHARED". |
1066 | |
1119 | |
1067 | At the time of this writing (Linux 3.2), this requets is unreliable |
1120 | At the time of this writing (Linux 3.2), this request is unreliable |
1068 | unless $count is "undef", as the kernel has all sorts of bugs |
1121 | unless $count is "undef", as the kernel has all sorts of bugs |
1069 | preventing it to return all extents of a range for files with large |
1122 | preventing it to return all extents of a range for files with a |
1070 | number of extents. The code works around all these issues if $count |
1123 | large number of extents. The code (only) works around all these |
1071 | is undef. |
1124 | issues if $count is "undef". |
1072 | |
1125 | |
1073 | aio_group $callback->(...) |
1126 | aio_group $callback->(...) |
1074 | This is a very special aio request: Instead of doing something, it |
1127 | This is a very special aio request: Instead of doing something, it |
1075 | is a container for other aio requests, which is useful if you want |
1128 | is a container for other aio requests, which is useful if you want |
1076 | to bundle many requests into a single, composite, request with a |
1129 | to bundle many requests into a single, composite, request with a |
… | |
… | |
1185 | There are some caveats: when directories get renamed (or deleted), the |
1238 | There are some caveats: when directories get renamed (or deleted), the |
1186 | pathname string doesn't change, so will point to the new directory (or |
1239 | pathname string doesn't change, so will point to the new directory (or |
1187 | nowhere at all), while the directory fd, if available on the system, |
1240 | nowhere at all), while the directory fd, if available on the system, |
1188 | will still point to the original directory. Most functions accepting a |
1241 | will still point to the original directory. Most functions accepting a |
1189 | pathname will use the directory fd on newer systems, and the string on |
1242 | pathname will use the directory fd on newer systems, and the string on |
1190 | older systems. Some functions (such as realpath) will always rely on the |
1243 | older systems. Some functions (such as "aio_realpath") will always rely |
1191 | string form of the pathname. |
1244 | on the string form of the pathname. |
1192 | |
1245 | |
1193 | So this functionality is mainly useful to get some protection against |
1246 | So this functionality is mainly useful to get some protection against |
1194 | "chdir", to easily get an absolute path out of a relative path for |
1247 | "chdir", to easily get an absolute path out of a relative path for |
1195 | future reference, and to speed up doing many operations in the same |
1248 | future reference, and to speed up doing many operations in the same |
1196 | directory (e.g. when stat'ing all files in a directory). |
1249 | directory (e.g. when stat'ing all files in a directory). |
… | |
… | |
1209 | fails the request with "ENOENT", there is often no need for error |
1262 | fails the request with "ENOENT", there is often no need for error |
1210 | checking in the "aio_wd" callback, as future requests using the |
1263 | checking in the "aio_wd" callback, as future requests using the |
1211 | value will fail in the expected way. |
1264 | value will fail in the expected way. |
1212 | |
1265 | |
1213 | IO::AIO::CWD |
1266 | IO::AIO::CWD |
1214 | This is a compiletime constant (object) that represents the process |
1267 | This is a compile time constant (object) that represents the process |
1215 | current working directory. |
1268 | current working directory. |
1216 | |
1269 | |
1217 | Specifying this object as working directory object for a pathname is |
1270 | Specifying this object as working directory object for a pathname is |
1218 | as if the pathname would be specified directly, without a directory |
1271 | as if the pathname would be specified directly, without a directory |
1219 | object. For example, these calls are functionally identical: |
1272 | object. For example, these calls are functionally identical: |
… | |
… | |
1444 | Strictly equivalent to: |
1497 | Strictly equivalent to: |
1445 | |
1498 | |
1446 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1499 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1447 | while IO::AIO::nreqs; |
1500 | while IO::AIO::nreqs; |
1448 | |
1501 | |
|
|
1502 | This function can be useful at program aborts, to make sure |
|
|
1503 | outstanding I/O has been done ("IO::AIO" uses an "END" block which |
|
|
1504 | already calls this function on normal exits), or when you are merely |
|
|
1505 | using "IO::AIO" for its more advanced functions, rather than for |
|
|
1506 | async I/O, e.g.: |
|
|
1507 | |
|
|
1508 | my ($dirs, $nondirs); |
|
|
1509 | IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ }; |
|
|
1510 | IO::AIO::flush; |
|
|
1511 | # $dirs, $nondirs are now set |
|
|
1512 | |
1449 | IO::AIO::max_poll_reqs $nreqs |
1513 | IO::AIO::max_poll_reqs $nreqs |
1450 | IO::AIO::max_poll_time $seconds |
1514 | IO::AIO::max_poll_time $seconds |
1451 | These set the maximum number of requests (default 0, meaning |
1515 | These set the maximum number of requests (default 0, meaning |
1452 | infinity) that are being processed by "IO::AIO::poll_cb" in one |
1516 | infinity) that are being processed by "IO::AIO::poll_cb" in one |
1453 | call, respectively the maximum amount of time (default 0, meaning |
1517 | call, respectively the maximum amount of time (default 0, meaning |
… | |
… | |
1542 | no longer exceeded. |
1606 | no longer exceeded. |
1543 | |
1607 | |
1544 | In other words, this setting does not enforce a queue limit, but can |
1608 | In other words, this setting does not enforce a queue limit, but can |
1545 | be used to make poll functions block if the limit is exceeded. |
1609 | be used to make poll functions block if the limit is exceeded. |
1546 | |
1610 | |
1547 | This is a very bad function to use in interactive programs because |
1611 | This is a bad function to use in interactive programs because it |
1548 | it blocks, and a bad way to reduce concurrency because it is |
1612 | blocks, and a bad way to reduce concurrency because it is inexact. |
1549 | inexact: Better use an "aio_group" together with a feed callback. |
1613 | If you need to issue many requests without being able to call a poll |
|
|
1614 | function on demand, it is better to use an "aio_group" together with |
|
|
1615 | a feed callback. |
1550 | |
1616 | |
1551 | Its main use is in scripts without an event loop - when you want to |
1617 | Its main use is in scripts without an event loop - when you want to |
1552 | stat a lot of files, you can write somehting like this: |
1618 | stat a lot of files, you can write something like this: |
1553 | |
1619 | |
1554 | IO::AIO::max_outstanding 32; |
1620 | IO::AIO::max_outstanding 32; |
1555 | |
1621 | |
1556 | for my $path (...) { |
1622 | for my $path (...) { |
1557 | aio_stat $path , ...; |
1623 | aio_stat $path , ...; |
… | |
… | |
1559 | } |
1625 | } |
1560 | |
1626 | |
1561 | IO::AIO::flush; |
1627 | IO::AIO::flush; |
1562 | |
1628 | |
1563 | The call to "poll_cb" inside the loop will normally return |
1629 | The call to "poll_cb" inside the loop will normally return |
1564 | instantly, but as soon as more thna 32 reqeusts are in-flight, it |
1630 | instantly, allowing the loop to progress, but as soon as more than |
1565 | will block until some requests have been handled. This keeps the |
1631 | 32 requests are in-flight, it will block until some requests have |
1566 | loop from pushing a large number of "aio_stat" requests onto the |
1632 | been handled. This keeps the loop from pushing a large number of |
1567 | queue. |
1633 | "aio_stat" requests onto the queue (which, with many paths to stat, |
|
|
1634 | can use up a lot of memory). |
1568 | |
1635 | |
1569 | The default value for "max_outstanding" is very large, so there is |
1636 | The default value for "max_outstanding" is very large, so there is |
1570 | no practical limit on the number of outstanding requests. |
1637 | no practical limit on the number of outstanding requests. |
1571 | |
1638 | |
1572 | STATISTICAL INFORMATION |
1639 | STATISTICAL INFORMATION |
… | |
… | |
1586 | |
1653 | |
1587 | IO::AIO::npending |
1654 | IO::AIO::npending |
1588 | Returns the number of requests currently in the pending state |
1655 | Returns the number of requests currently in the pending state |
1589 | (executed, but not yet processed by poll_cb). |
1656 | (executed, but not yet processed by poll_cb). |
1590 | |
1657 | |
|
|
1658 | SUBSECOND STAT TIME ACCESS |
|
|
1659 | Both "aio_stat"/"aio_lstat" and perl's "stat"/"lstat" functions can |
|
|
1660 | generally find access/modification and change times with subsecond time |
|
|
1661 | accuracy of the system supports it, but perl's built-in functions only |
|
|
1662 | return the integer part. |
|
|
1663 | |
|
|
1664 | The following functions return the timestamps of the most recent stat |
|
|
1665 | with subsecond precision on most systems and work both after |
|
|
1666 | "aio_stat"/"aio_lstat" and perl's "stat"/"lstat" calls. Their return |
|
|
1667 | value is only meaningful after a successful "stat"/"lstat" call, or |
|
|
1668 | during/after a successful "aio_stat"/"aio_lstat" callback. |
|
|
1669 | |
|
|
1670 | This is similar to the Time::HiRes "stat" functions, but can return full |
|
|
1671 | resolution without rounding and work with standard perl "stat", |
|
|
1672 | alleviating the need to call the special "Time::HiRes" functions, which |
|
|
1673 | do not act like their perl counterparts. |
|
|
1674 | |
|
|
1675 | On operating systems or file systems where subsecond time resolution is |
|
|
1676 | not supported or could not be detected, a fractional part of 0 is |
|
|
1677 | returned, so it is always safe to call these functions. |
|
|
1678 | |
|
|
1679 | $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, |
|
|
1680 | IO::AIO::st_btime |
|
|
1681 | Return the access, modication, change or birth time, respectively, |
|
|
1682 | including fractional part. Due to the limited precision of floating |
|
|
1683 | point, the accuracy on most platforms is only a bit better than |
|
|
1684 | milliseconds for times around now - see the *nsec* function family, |
|
|
1685 | below, for full accuracy. |
|
|
1686 | |
|
|
1687 | File birth time is only available when the OS and perl support it |
|
|
1688 | (on FreeBSD and NetBSD at the time of this writing, although support |
|
|
1689 | is adaptive, so if your OS/perl gains support, IO::AIO can take |
|
|
1690 | advantage of it). On systems where it isn't available, 0 is |
|
|
1691 | currently returned, but this might change to "undef" in a future |
|
|
1692 | version. |
|
|
1693 | |
|
|
1694 | ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
|
|
1695 | Returns access, modification, change and birth time all in one go, |
|
|
1696 | and maybe more times in the future version. |
|
|
1697 | |
|
|
1698 | $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, |
|
|
1699 | IO::AIO::st_ctimensec, IO::AIO::st_btimensec |
|
|
1700 | Return the fractional access, modifcation, change or birth time, in |
|
|
1701 | nanoseconds, as an integer in the range 0 to 999999999. |
|
|
1702 | |
|
|
1703 | Note that no accessors are provided for access, modification and |
|
|
1704 | change times - you need to get those from "stat _" if required ("int |
|
|
1705 | IO::AIO::st_atime" and so on will *not* generally give you the |
|
|
1706 | correct value). |
|
|
1707 | |
|
|
1708 | $seconds = IO::AIO::st_btimesec |
|
|
1709 | The (integral) seconds part of the file birth time, if available. |
|
|
1710 | |
|
|
1711 | ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec |
|
|
1712 | Like the functions above, but returns all four times in one go (and |
|
|
1713 | maybe more in future versions). |
|
|
1714 | |
|
|
1715 | $counter = IO::AIO::st_gen |
|
|
1716 | Returns the generation counter (in practice this is just a random |
|
|
1717 | number) of the file. This is only available on platforms which have |
|
|
1718 | this member in their "struct stat" (most BSDs at the time of this |
|
|
1719 | writing) and generally only to the root usert. If unsupported, 0 is |
|
|
1720 | returned, but this might change to "undef" in a future version. |
|
|
1721 | |
|
|
1722 | Example: print the high resolution modification time of /etc, using |
|
|
1723 | "stat", and "IO::AIO::aio_stat". |
|
|
1724 | |
|
|
1725 | if (stat "/etc") { |
|
|
1726 | printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime; |
|
|
1727 | } |
|
|
1728 | |
|
|
1729 | IO::AIO::aio_stat "/etc", sub { |
|
|
1730 | $_[0] |
|
|
1731 | and return; |
|
|
1732 | |
|
|
1733 | printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec; |
|
|
1734 | }; |
|
|
1735 | |
|
|
1736 | IO::AIO::flush; |
|
|
1737 | |
|
|
1738 | Output of the awbove on my system, showing reduced and full accuracy: |
|
|
1739 | |
|
|
1740 | stat(/etc) mtime: 1534043702.020808 |
|
|
1741 | aio_stat(/etc) mtime: 1534043702.020807792 |
|
|
1742 | |
1591 | MISCELLANEOUS FUNCTIONS |
1743 | MISCELLANEOUS FUNCTIONS |
1592 | IO::AIO implements some functions that are useful when you want to use |
1744 | IO::AIO implements some functions that are useful when you want to use |
1593 | some "Advanced I/O" function not available to in Perl, without going the |
1745 | some "Advanced I/O" function not available to in Perl, without going the |
1594 | "Asynchronous I/O" route. Many of these have an asynchronous "aio_*" |
1746 | "Asynchronous I/O" route. Many of these have an asynchronous "aio_*" |
1595 | counterpart. |
1747 | counterpart. |
|
|
1748 | |
|
|
1749 | $retval = IO::AIO::fexecve $fh, $argv, $envp |
|
|
1750 | A more-or-less direct equivalent to the POSIX "fexecve" functions, |
|
|
1751 | which allows you to specify the program to be executed via a file |
|
|
1752 | descriptor (or handle). Returns -1 and sets errno to "ENOSYS" if not |
|
|
1753 | available. |
|
|
1754 | |
|
|
1755 | $retval = IO::AIO::mount $special, $path, $fstype, $flags = 0, $data = |
|
|
1756 | undef |
|
|
1757 | Calls the GNU/Linux mount syscall with the given arguments. All |
|
|
1758 | except $flags are strings, and if $data is "undef", a "NULL" will be |
|
|
1759 | passed. |
|
|
1760 | |
|
|
1761 | The following values for $flags are available: |
|
|
1762 | |
|
|
1763 | "IO::AIO::MS_RDONLY", "IO::AIO::MS_NOSUID", "IO::AIO::MS_NODEV", |
|
|
1764 | "IO::AIO::MS_NOEXEC", "IO::AIO::MS_SYNCHRONOUS", |
|
|
1765 | "IO::AIO::MS_REMOUNT", "IO::AIO::MS_MANDLOCK", |
|
|
1766 | "IO::AIO::MS_DIRSYNC", "IO::AIO::MS_NOATIME", |
|
|
1767 | "IO::AIO::MS_NODIRATIME", "IO::AIO::MS_BIND", "IO::AIO::MS_MOVE", |
|
|
1768 | "IO::AIO::MS_REC", "IO::AIO::MS_SILENT", "IO::AIO::MS_POSIXACL", |
|
|
1769 | "IO::AIO::MS_UNBINDABLE", "IO::AIO::MS_PRIVATE", |
|
|
1770 | "IO::AIO::MS_SLAVE", "IO::AIO::MS_SHARED", "IO::AIO::MS_RELATIME", |
|
|
1771 | "IO::AIO::MS_KERNMOUNT", "IO::AIO::MS_I_VERSION", |
|
|
1772 | "IO::AIO::MS_STRICTATIME", "IO::AIO::MS_LAZYTIME", |
|
|
1773 | "IO::AIO::MS_ACTIVE", "IO::AIO::MS_NOUSER", "IO::AIO::MS_RMT_MASK", |
|
|
1774 | "IO::AIO::MS_MGC_VAL" and "IO::AIO::MS_MGC_MSK". |
|
|
1775 | |
|
|
1776 | $retval = IO::AIO::umount $path, $flags = 0 |
|
|
1777 | Invokes the GNU/Linux "umount" or "umount2" syscalls. Always calls |
|
|
1778 | "umount" if $flags is 0, otherwqise always tries to call "umount2". |
|
|
1779 | |
|
|
1780 | The following $flags are available: |
|
|
1781 | |
|
|
1782 | "IO::AIO::MNT_FORCE", "IO::AIO::MNT_DETACH", "IO::AIO::MNT_EXPIRE" |
|
|
1783 | and "IO::AIO::UMOUNT_NOFOLLOW". |
|
|
1784 | |
|
|
1785 | $numfd = IO::AIO::get_fdlimit |
|
|
1786 | Tries to find the current file descriptor limit and returns it, or |
|
|
1787 | "undef" and sets $! in case of an error. The limit is one larger |
|
|
1788 | than the highest valid file descriptor number. |
|
|
1789 | |
|
|
1790 | IO::AIO::min_fdlimit [$numfd] |
|
|
1791 | Try to increase the current file descriptor limit(s) to at least |
|
|
1792 | $numfd by changing the soft or hard file descriptor resource limit. |
|
|
1793 | If $numfd is missing, it will try to set a very high limit, although |
|
|
1794 | this is not recommended when you know the actual minimum that you |
|
|
1795 | require. |
|
|
1796 | |
|
|
1797 | If the limit cannot be raised enough, the function makes a |
|
|
1798 | best-effort attempt to increase the limit as much as possible, using |
|
|
1799 | various tricks, while still failing. You can query the resulting |
|
|
1800 | limit using "IO::AIO::get_fdlimit". |
|
|
1801 | |
|
|
1802 | If an error occurs, returns "undef" and sets $!, otherwise returns |
|
|
1803 | true. |
1596 | |
1804 | |
1597 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
1805 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
1598 | Calls the "eio_sendfile_sync" function, which is like |
1806 | Calls the "eio_sendfile_sync" function, which is like |
1599 | "aio_sendfile", but is blocking (this makes most sense if you know |
1807 | "aio_sendfile", but is blocking (this makes most sense if you know |
1600 | the input data is likely cached already and the output filehandle is |
1808 | the input data is likely cached already and the output filehandle is |
… | |
… | |
1617 | details). The following advice constants are available: |
1825 | details). The following advice constants are available: |
1618 | "IO::AIO::MADV_NORMAL", "IO::AIO::MADV_SEQUENTIAL", |
1826 | "IO::AIO::MADV_NORMAL", "IO::AIO::MADV_SEQUENTIAL", |
1619 | "IO::AIO::MADV_RANDOM", "IO::AIO::MADV_WILLNEED", |
1827 | "IO::AIO::MADV_RANDOM", "IO::AIO::MADV_WILLNEED", |
1620 | "IO::AIO::MADV_DONTNEED". |
1828 | "IO::AIO::MADV_DONTNEED". |
1621 | |
1829 | |
|
|
1830 | If $offset is negative, counts from the end. If $length is negative, |
|
|
1831 | the remaining length of the $scalar is used. If possible, $length |
|
|
1832 | will be reduced to fit into the $scalar. |
|
|
1833 | |
1622 | On systems that do not implement "posix_madvise", this function |
1834 | On systems that do not implement "posix_madvise", this function |
1623 | returns ENOSYS, otherwise the return value of "posix_madvise". |
1835 | returns ENOSYS, otherwise the return value of "posix_madvise". |
1624 | |
1836 | |
1625 | IO::AIO::mprotect $scalar, $offset, $len, $protect |
1837 | IO::AIO::mprotect $scalar, $offset, $len, $protect |
1626 | Simply calls the "mprotect" function on the preferably AIO::mmap'ed |
1838 | Simply calls the "mprotect" function on the preferably AIO::mmap'ed |
1627 | $scalar (see its manpage for details). The following protect |
1839 | $scalar (see its manpage for details). The following protect |
1628 | constants are available: "IO::AIO::PROT_NONE", "IO::AIO::PROT_READ", |
1840 | constants are available: "IO::AIO::PROT_NONE", "IO::AIO::PROT_READ", |
1629 | "IO::AIO::PROT_WRITE", "IO::AIO::PROT_EXEC". |
1841 | "IO::AIO::PROT_WRITE", "IO::AIO::PROT_EXEC". |
1630 | |
1842 | |
|
|
1843 | If $offset is negative, counts from the end. If $length is negative, |
|
|
1844 | the remaining length of the $scalar is used. If possible, $length |
|
|
1845 | will be reduced to fit into the $scalar. |
|
|
1846 | |
1631 | On systems that do not implement "mprotect", this function returns |
1847 | On systems that do not implement "mprotect", this function returns |
1632 | ENOSYS, otherwise the return value of "mprotect". |
1848 | ENOSYS, otherwise the return value of "mprotect". |
1633 | |
1849 | |
1634 | IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
1850 | IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
1635 | Memory-maps a file (or anonymous memory range) and attaches it to |
1851 | Memory-maps a file (or anonymous memory range) and attaches it to |
1636 | the given $scalar, which will act like a string scalar. Returns true |
1852 | the given $scalar, which will act like a string scalar. Returns true |
1637 | on success, and false otherwise. |
1853 | on success, and false otherwise. |
1638 | |
1854 | |
|
|
1855 | The scalar must exist, but its contents do not matter - this means |
|
|
1856 | you cannot use a nonexistant array or hash element. When in doubt, |
|
|
1857 | "undef" the scalar first. |
|
|
1858 | |
1639 | The only operations allowed on the scalar are "substr"/"vec" that |
1859 | The only operations allowed on the mmapped scalar are |
1640 | don't change the string length, and most read-only operations such |
1860 | "substr"/"vec", which don't change the string length, and most |
1641 | as copying it or searching it with regexes and so on. |
1861 | read-only operations such as copying it or searching it with regexes |
|
|
1862 | and so on. |
1642 | |
1863 | |
1643 | Anything else is unsafe and will, at best, result in memory leaks. |
1864 | Anything else is unsafe and will, at best, result in memory leaks. |
1644 | |
1865 | |
1645 | The memory map associated with the $scalar is automatically removed |
1866 | The memory map associated with the $scalar is automatically removed |
1646 | when the $scalar is destroyed, or when the "IO::AIO::mmap" or |
1867 | when the $scalar is undef'd or destroyed, or when the |
1647 | "IO::AIO::munmap" functions are called. |
1868 | "IO::AIO::mmap" or "IO::AIO::munmap" functions are called on it. |
1648 | |
1869 | |
1649 | This calls the "mmap"(2) function internally. See your system's |
1870 | This calls the "mmap"(2) function internally. See your system's |
1650 | manual page for details on the $length, $prot and $flags parameters. |
1871 | manual page for details on the $length, $prot and $flags parameters. |
1651 | |
1872 | |
1652 | The $length must be larger than zero and smaller than the actual |
1873 | The $length must be larger than zero and smaller than the actual |
… | |
… | |
1661 | not available, the are 0): "IO::AIO::MAP_ANONYMOUS" (which is set to |
1882 | not available, the are 0): "IO::AIO::MAP_ANONYMOUS" (which is set to |
1662 | "MAP_ANON" if your system only provides this constant), |
1883 | "MAP_ANON" if your system only provides this constant), |
1663 | "IO::AIO::MAP_LOCKED", "IO::AIO::MAP_NORESERVE", |
1884 | "IO::AIO::MAP_LOCKED", "IO::AIO::MAP_NORESERVE", |
1664 | "IO::AIO::MAP_POPULATE", "IO::AIO::MAP_NONBLOCK", |
1885 | "IO::AIO::MAP_POPULATE", "IO::AIO::MAP_NONBLOCK", |
1665 | "IO::AIO::MAP_FIXED", "IO::AIO::MAP_GROWSDOWN", |
1886 | "IO::AIO::MAP_FIXED", "IO::AIO::MAP_GROWSDOWN", |
1666 | "IO::AIO::MAP_32BIT", "IO::AIO::MAP_HUGETLB" or |
1887 | "IO::AIO::MAP_32BIT", "IO::AIO::MAP_HUGETLB", "IO::AIO::MAP_STACK", |
1667 | "IO::AIO::MAP_STACK". |
1888 | "IO::AIO::MAP_FIXED_NOREPLACE", "IO::AIO::MAP_SHARED_VALIDATE", |
|
|
1889 | "IO::AIO::MAP_SYNC" or "IO::AIO::MAP_UNINITIALIZED". |
1668 | |
1890 | |
1669 | If $fh is "undef", then a file descriptor of -1 is passed. |
1891 | If $fh is "undef", then a file descriptor of -1 is passed. |
1670 | |
1892 | |
1671 | $offset is the offset from the start of the file - it generally must |
1893 | $offset is the offset from the start of the file - it generally must |
1672 | be a multiple of "IO::AIO::PAGESIZE" and defaults to 0. |
1894 | be a multiple of "IO::AIO::PAGESIZE" and defaults to 0. |
… | |
… | |
1684 | |
1906 | |
1685 | my $fast_md5 = md5 $data; |
1907 | my $fast_md5 = md5 $data; |
1686 | |
1908 | |
1687 | IO::AIO::munmap $scalar |
1909 | IO::AIO::munmap $scalar |
1688 | Removes a previous mmap and undefines the $scalar. |
1910 | Removes a previous mmap and undefines the $scalar. |
|
|
1911 | |
|
|
1912 | IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, |
|
|
1913 | $new_address = 0] |
|
|
1914 | Calls the Linux-specific mremap(2) system call. The $scalar must |
|
|
1915 | have been mapped by "IO::AIO::mmap", and $flags must currently |
|
|
1916 | either be 0 or "IO::AIO::MREMAP_MAYMOVE". |
|
|
1917 | |
|
|
1918 | Returns true if successful, and false otherwise. If the underlying |
|
|
1919 | mmapped region has changed address, then the true value has the |
|
|
1920 | numerical value 1, otherwise it has the numerical value 0: |
|
|
1921 | |
|
|
1922 | my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE |
|
|
1923 | or die "mremap: $!"; |
|
|
1924 | |
|
|
1925 | if ($success*1) { |
|
|
1926 | warn "scalar has chanegd address in memory\n"; |
|
|
1927 | } |
|
|
1928 | |
|
|
1929 | "IO::AIO::MREMAP_FIXED" and the $new_address argument are currently |
|
|
1930 | implemented, but not supported and might go away in a future |
|
|
1931 | version. |
|
|
1932 | |
|
|
1933 | On systems where this call is not supported or is not emulated, this |
|
|
1934 | call returns falls and sets $! to "ENOSYS". |
|
|
1935 | |
|
|
1936 | IO::AIO::mlockall $flags |
|
|
1937 | Calls the "eio_mlockall_sync" function, which is like |
|
|
1938 | "aio_mlockall", but is blocking. |
1689 | |
1939 | |
1690 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
1940 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
1691 | Calls the "munlock" function, undoing the effects of a previous |
1941 | Calls the "munlock" function, undoing the effects of a previous |
1692 | "aio_mlock" call (see its description for details). |
1942 | "aio_mlock" call (see its description for details). |
1693 | |
1943 | |
1694 | IO::AIO::munlockall |
1944 | IO::AIO::munlockall |
1695 | Calls the "munlockall" function. |
1945 | Calls the "munlockall" function. |
1696 | |
1946 | |
1697 | On systems that do not implement "munlockall", this function returns |
1947 | On systems that do not implement "munlockall", this function returns |
1698 | ENOSYS, otherwise the return value of "munlockall". |
1948 | ENOSYS, otherwise the return value of "munlockall". |
|
|
1949 | |
|
|
1950 | $fh = IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_maxlen, $flags |
|
|
1951 | Uses the GNU/Linux accept4(2) syscall, if available, to accept a |
|
|
1952 | socket and return the new file handle on success, or sets $! and |
|
|
1953 | returns "undef" on error. |
|
|
1954 | |
|
|
1955 | The remote name of the new socket will be stored in $sockaddr, which |
|
|
1956 | will be extended to allow for at least $sockaddr_maxlen octets. If |
|
|
1957 | the socket name does not fit into $sockaddr_maxlen octets, this is |
|
|
1958 | signaled by returning a longer string in $sockaddr, which might or |
|
|
1959 | might not be truncated. |
|
|
1960 | |
|
|
1961 | To accept name-less sockets, use "undef" for $sockaddr and 0 for |
|
|
1962 | $sockaddr_maxlen. |
|
|
1963 | |
|
|
1964 | The main reasons to use this syscall rather than portable accept(2) |
|
|
1965 | are that you can specify "SOCK_NONBLOCK" and/or "SOCK_CLOEXEC" flags |
|
|
1966 | and you can accept name-less sockets by specifying 0 for |
|
|
1967 | $sockaddr_maxlen, which is sadly not possible with perl's interface |
|
|
1968 | to "accept". |
1699 | |
1969 | |
1700 | IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
1970 | IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
1701 | Calls the GNU/Linux splice(2) syscall, if available. If $r_off or |
1971 | Calls the GNU/Linux splice(2) syscall, if available. If $r_off or |
1702 | $w_off are "undef", then "NULL" is passed for these, otherwise they |
1972 | $w_off are "undef", then "NULL" is passed for these, otherwise they |
1703 | should be the file offset. |
1973 | should be the file offset. |
… | |
… | |
1738 | |
2008 | |
1739 | Please refer to pipe2(2) for more info on the $flags, but at the |
2009 | Please refer to pipe2(2) for more info on the $flags, but at the |
1740 | time of this writing, "IO::AIO::O_CLOEXEC", "IO::AIO::O_NONBLOCK" |
2010 | time of this writing, "IO::AIO::O_CLOEXEC", "IO::AIO::O_NONBLOCK" |
1741 | and "IO::AIO::O_DIRECT" (Linux 3.4, for packet-based pipes) were |
2011 | and "IO::AIO::O_DIRECT" (Linux 3.4, for packet-based pipes) were |
1742 | supported. |
2012 | supported. |
|
|
2013 | |
|
|
2014 | Example: create a pipe race-free w.r.t. threads and fork: |
|
|
2015 | |
|
|
2016 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
|
|
2017 | or die "pipe2: $!\n"; |
|
|
2018 | |
|
|
2019 | $fh = IO::AIO::memfd_create $pathname[, $flags] |
|
|
2020 | This is a direct interface to the Linux memfd_create(2) system call. |
|
|
2021 | The (unhelpful) default for $flags is 0, but your default should be |
|
|
2022 | "IO::AIO::MFD_CLOEXEC". |
|
|
2023 | |
|
|
2024 | On success, the new memfd filehandle is returned, otherwise returns |
|
|
2025 | "undef". If the memfd_create syscall is missing, fails with |
|
|
2026 | "ENOSYS". |
|
|
2027 | |
|
|
2028 | Please refer to memfd_create(2) for more info on this call. |
|
|
2029 | |
|
|
2030 | The following $flags values are available: "IO::AIO::MFD_CLOEXEC", |
|
|
2031 | "IO::AIO::MFD_ALLOW_SEALING", "IO::AIO::MFD_HUGETLB", |
|
|
2032 | "IO::AIO::MFD_HUGETLB_2MB" and "IO::AIO::MFD_HUGETLB_1GB". |
|
|
2033 | |
|
|
2034 | Example: create a new memfd. |
|
|
2035 | |
|
|
2036 | my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC |
|
|
2037 | or die "memfd_create: $!\n"; |
|
|
2038 | |
|
|
2039 | $fh = IO::AIO::pidfd_open $pid[, $flags] |
|
|
2040 | This is an interface to the Linux pidfd_open(2) system call. The |
|
|
2041 | default for $flags is 0. |
|
|
2042 | |
|
|
2043 | On success, a new pidfd filehandle is returned (that is already set |
|
|
2044 | to close-on-exec), otherwise returns "undef". If the syscall is |
|
|
2045 | missing, fails with "ENOSYS". |
|
|
2046 | |
|
|
2047 | Example: open pid 6341 as pidfd. |
|
|
2048 | |
|
|
2049 | my $fh = IO::AIO::pidfd_open 6341 |
|
|
2050 | or die "pidfd_open: $!\n"; |
|
|
2051 | |
|
|
2052 | $status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[, |
|
|
2053 | $flags]] |
|
|
2054 | This is an interface to the Linux pidfd_send_signal system call. The |
|
|
2055 | default for $siginfo is "undef" and the default for $flags is 0. |
|
|
2056 | |
|
|
2057 | Returns the system call status. If the syscall is missing, fails |
|
|
2058 | with "ENOSYS". |
|
|
2059 | |
|
|
2060 | When specified, $siginfo must be a reference to a hash with one or |
|
|
2061 | more of the following members: |
|
|
2062 | |
|
|
2063 | code - the "si_code" member |
|
|
2064 | pid - the "si_pid" member |
|
|
2065 | uid - the "si_uid" member |
|
|
2066 | value_int - the "si_value.sival_int" member |
|
|
2067 | value_ptr - the "si_value.sival_ptr" member, specified as an integer |
|
|
2068 | |
|
|
2069 | Example: send a SIGKILL to the specified process. |
|
|
2070 | |
|
|
2071 | my $status = IO::AIO::pidfd_send_signal $pidfh, 9, undef |
|
|
2072 | and die "pidfd_send_signal: $!\n"; |
|
|
2073 | |
|
|
2074 | Example: send a SIGKILL to the specified process with extra data. |
|
|
2075 | |
|
|
2076 | my $status = IO::AIO::pidfd_send_signal $pidfh, 9, { code => -1, value_int => 7 } |
|
|
2077 | and die "pidfd_send_signal: $!\n"; |
|
|
2078 | |
|
|
2079 | $fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags] |
|
|
2080 | This is an interface to the Linux pidfd_getfd system call. The |
|
|
2081 | default for $flags is 0. |
|
|
2082 | |
|
|
2083 | On success, returns a dup'ed copy of the target file descriptor |
|
|
2084 | (specified as an integer) returned (that is already set to |
|
|
2085 | close-on-exec), otherwise returns "undef". If the syscall is |
|
|
2086 | missing, fails with "ENOSYS". |
|
|
2087 | |
|
|
2088 | Example: get a copy of standard error of another process and print |
|
|
2089 | soemthing to it. |
|
|
2090 | |
|
|
2091 | my $errfh = IO::AIO::pidfd_getfd $pidfh, 2 |
|
|
2092 | or die "pidfd_getfd: $!\n"; |
|
|
2093 | print $errfh "stderr\n"; |
|
|
2094 | |
|
|
2095 | $fh = IO::AIO::eventfd [$initval, [$flags]] |
|
|
2096 | This is a direct interface to the Linux eventfd(2) system call. The |
|
|
2097 | (unhelpful) defaults for $initval and $flags are 0 for both. |
|
|
2098 | |
|
|
2099 | On success, the new eventfd filehandle is returned, otherwise |
|
|
2100 | returns "undef". If the eventfd syscall is missing, fails with |
|
|
2101 | "ENOSYS". |
|
|
2102 | |
|
|
2103 | Please refer to eventfd(2) for more info on this call. |
|
|
2104 | |
|
|
2105 | The following symbol flag values are available: |
|
|
2106 | "IO::AIO::EFD_CLOEXEC", "IO::AIO::EFD_NONBLOCK" and |
|
|
2107 | "IO::AIO::EFD_SEMAPHORE" (Linux 2.6.30). |
|
|
2108 | |
|
|
2109 | Example: create a new eventfd filehandle: |
|
|
2110 | |
|
|
2111 | $fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC |
|
|
2112 | or die "eventfd: $!\n"; |
|
|
2113 | |
|
|
2114 | $fh = IO::AIO::timerfd_create $clockid[, $flags] |
|
|
2115 | This is a direct interface to the Linux timerfd_create(2) system |
|
|
2116 | call. The (unhelpful) default for $flags is 0, but your default |
|
|
2117 | should be "IO::AIO::TFD_CLOEXEC". |
|
|
2118 | |
|
|
2119 | On success, the new timerfd filehandle is returned, otherwise |
|
|
2120 | returns "undef". If the timerfd_create syscall is missing, fails |
|
|
2121 | with "ENOSYS". |
|
|
2122 | |
|
|
2123 | Please refer to timerfd_create(2) for more info on this call. |
|
|
2124 | |
|
|
2125 | The following $clockid values are available: |
|
|
2126 | "IO::AIO::CLOCK_REALTIME", "IO::AIO::CLOCK_MONOTONIC" |
|
|
2127 | "IO::AIO::CLOCK_CLOCK_BOOTTIME" (Linux 3.15) |
|
|
2128 | "IO::AIO::CLOCK_CLOCK_REALTIME_ALARM" (Linux 3.11) and |
|
|
2129 | "IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM" (Linux 3.11). |
|
|
2130 | |
|
|
2131 | The following $flags values are available (Linux 2.6.27): |
|
|
2132 | "IO::AIO::TFD_NONBLOCK" and "IO::AIO::TFD_CLOEXEC". |
|
|
2133 | |
|
|
2134 | Example: create a new timerfd and set it to one-second repeated |
|
|
2135 | alarms, then wait for two alarms: |
|
|
2136 | |
|
|
2137 | my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC |
|
|
2138 | or die "timerfd_create: $!\n"; |
|
|
2139 | |
|
|
2140 | defined IO::AIO::timerfd_settime $fh, 0, 1, 1 |
|
|
2141 | or die "timerfd_settime: $!\n"; |
|
|
2142 | |
|
|
2143 | for (1..2) { |
|
|
2144 | 8 == sysread $fh, my $buf, 8 |
|
|
2145 | or die "timerfd read failure\n"; |
|
|
2146 | |
|
|
2147 | printf "number of expirations (likely 1): %d\n", |
|
|
2148 | unpack "Q", $buf; |
|
|
2149 | } |
|
|
2150 | |
|
|
2151 | ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, |
|
|
2152 | $new_interval, $nbw_value |
|
|
2153 | This is a direct interface to the Linux timerfd_settime(2) system |
|
|
2154 | call. Please refer to its manpage for more info on this call. |
|
|
2155 | |
|
|
2156 | The new itimerspec is specified using two (possibly fractional) |
|
|
2157 | second values, $new_interval and $new_value). |
|
|
2158 | |
|
|
2159 | On success, the current interval and value are returned (as per |
|
|
2160 | "timerfd_gettime"). On failure, the empty list is returned. |
|
|
2161 | |
|
|
2162 | The following $flags values are available: |
|
|
2163 | "IO::AIO::TFD_TIMER_ABSTIME" and "IO::AIO::TFD_TIMER_CANCEL_ON_SET". |
|
|
2164 | |
|
|
2165 | See "IO::AIO::timerfd_create" for a full example. |
|
|
2166 | |
|
|
2167 | ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh |
|
|
2168 | This is a direct interface to the Linux timerfd_gettime(2) system |
|
|
2169 | call. Please refer to its manpage for more info on this call. |
|
|
2170 | |
|
|
2171 | On success, returns the current values of interval and value for the |
|
|
2172 | given timerfd (as potentially fractional second values). On failure, |
|
|
2173 | the empty list is returned. |
1743 | |
2174 | |
1744 | EVENT LOOP INTEGRATION |
2175 | EVENT LOOP INTEGRATION |
1745 | It is recommended to use AnyEvent::AIO to integrate IO::AIO |
2176 | It is recommended to use AnyEvent::AIO to integrate IO::AIO |
1746 | automatically into many event loops: |
2177 | automatically into many event loops: |
1747 | |
2178 | |
… | |
… | |
1797 | forking, if "IO::AIO" was used in the parent. Calling it while |
2228 | forking, if "IO::AIO" was used in the parent. Calling it while |
1798 | IO::AIO is active in the process will result in undefined behaviour. |
2229 | IO::AIO is active in the process will result in undefined behaviour. |
1799 | Calling it at any time will also result in any undefined (by POSIX) |
2230 | Calling it at any time will also result in any undefined (by POSIX) |
1800 | behaviour. |
2231 | behaviour. |
1801 | |
2232 | |
|
|
2233 | LINUX-SPECIFIC CALLS |
|
|
2234 | When a call is documented as "linux-specific" then this means it |
|
|
2235 | originated on GNU/Linux. "IO::AIO" will usually try to autodetect the |
|
|
2236 | availability and compatibility of such calls regardless of the platform |
|
|
2237 | it is compiled on, so platforms such as FreeBSD which often implement |
|
|
2238 | these calls will work. When in doubt, call them and see if they fail wth |
|
|
2239 | "ENOSYS". |
|
|
2240 | |
1802 | MEMORY USAGE |
2241 | MEMORY USAGE |
1803 | Per-request usage: |
2242 | Per-request usage: |
1804 | |
2243 | |
1805 | Each aio request uses - depending on your architecture - around 100-200 |
2244 | Each aio request uses - depending on your architecture - around 100-200 |
1806 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
2245 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
… | |
… | |
1816 | In the execution phase, some aio requests require more memory for |
2255 | In the execution phase, some aio requests require more memory for |
1817 | temporary buffers, and each thread requires a stack and other data |
2256 | temporary buffers, and each thread requires a stack and other data |
1818 | structures (usually around 16k-128k, depending on the OS). |
2257 | structures (usually around 16k-128k, depending on the OS). |
1819 | |
2258 | |
1820 | KNOWN BUGS |
2259 | KNOWN BUGS |
1821 | Known bugs will be fixed in the next release. |
2260 | Known bugs will be fixed in the next release :) |
|
|
2261 | |
|
|
2262 | KNOWN ISSUES |
|
|
2263 | Calls that try to "import" foreign memory areas (such as "IO::AIO::mmap" |
|
|
2264 | or "IO::AIO::aio_slurp") do not work with generic lvalues, such as |
|
|
2265 | non-created hash slots or other scalars I didn't think of. It's best to |
|
|
2266 | avoid such and either use scalar variables or making sure that the |
|
|
2267 | scalar exists (e.g. by storing "undef") and isn't "funny" (e.g. tied). |
|
|
2268 | |
|
|
2269 | I am not sure anything can be done about this, so this is considered a |
|
|
2270 | known issue, rather than a bug. |
1822 | |
2271 | |
1823 | SEE ALSO |
2272 | SEE ALSO |
1824 | AnyEvent::AIO for easy integration into event loops, Coro::AIO for a |
2273 | AnyEvent::AIO for easy integration into event loops, Coro::AIO for a |
1825 | more natural syntax. |
2274 | more natural syntax and IO::FDPass for file descriptor passing. |
1826 | |
2275 | |
1827 | AUTHOR |
2276 | AUTHOR |
1828 | Marc Lehmann <schmorp@schmorp.de> |
2277 | Marc Lehmann <schmorp@schmorp.de> |
1829 | http://home.schmorp.de/ |
2278 | http://home.schmorp.de/ |
1830 | |
2279 | |