1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | IO::AIO - Asynchronous Input/Output |
3 | IO::AIO - Asynchronous/Advanced Input/Output |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use IO::AIO; |
7 | use IO::AIO; |
8 | |
8 | |
… | |
… | |
58 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
58 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
59 | files currently, for example), and they would only support aio_read and |
59 | files currently, for example), and they would only support aio_read and |
60 | aio_write, so the remaining functionality would have to be implemented |
60 | aio_write, so the remaining functionality would have to be implemented |
61 | using threads anyway. |
61 | using threads anyway. |
62 | |
62 | |
|
|
63 | In addition to asynchronous I/O, this module also exports some rather |
|
|
64 | arcane interfaces, such as C<madvise> or linux's C<splice> system call, |
|
|
65 | which is why the C<A> in C<AIO> can also mean I<advanced>. |
|
|
66 | |
63 | Although the module will work in the presence of other (Perl-) threads, |
67 | Although the module will work in the presence of other (Perl-) threads, |
64 | it is currently not reentrant in any way, so use appropriate locking |
68 | it is currently not reentrant in any way, so use appropriate locking |
65 | yourself, always call C<poll_cb> from within the same thread, or never |
69 | yourself, always call C<poll_cb> from within the same thread, or never |
66 | call C<poll_cb> (or other C<aio_> functions) recursively. |
70 | call C<poll_cb> (or other C<aio_> functions) recursively. |
67 | |
71 | |
… | |
… | |
94 | |
98 | |
95 | # file contents now in $contents |
99 | # file contents now in $contents |
96 | print $contents; |
100 | print $contents; |
97 | |
101 | |
98 | # exit event loop and program |
102 | # exit event loop and program |
99 | EV::unloop; |
103 | EV::break; |
100 | }; |
104 | }; |
101 | }; |
105 | }; |
102 | |
106 | |
103 | # possibly queue up other requests, or open GUI windows, |
107 | # possibly queue up other requests, or open GUI windows, |
104 | # check for sockets etc. etc. |
108 | # check for sockets etc. etc. |
105 | |
109 | |
106 | # process events as long as there are some: |
110 | # process events as long as there are some: |
107 | EV::loop; |
111 | EV::run; |
108 | |
112 | |
109 | =head1 REQUEST ANATOMY AND LIFETIME |
113 | =head1 REQUEST ANATOMY AND LIFETIME |
110 | |
114 | |
111 | Every C<aio_*> function creates a request. which is a C data structure not |
115 | Every C<aio_*> function creates a request. which is a C data structure not |
112 | directly visible to Perl. |
116 | directly visible to Perl. |
… | |
… | |
167 | use common::sense; |
171 | use common::sense; |
168 | |
172 | |
169 | use base 'Exporter'; |
173 | use base 'Exporter'; |
170 | |
174 | |
171 | BEGIN { |
175 | BEGIN { |
172 | our $VERSION = 4.2; |
176 | our $VERSION = 4.7; |
173 | |
177 | |
174 | 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 |
175 | 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 |
176 | aio_scandir aio_symlink aio_readlink aio_realpath aio_sync |
180 | aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl |
177 | aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_allocate |
181 | aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range |
178 | aio_pathsync aio_readahead aio_fiemap |
182 | aio_pathsync aio_readahead aio_fiemap aio_allocate |
179 | aio_rename aio_link aio_move aio_copy aio_group |
183 | aio_rename aio_rename2 aio_link aio_move aio_copy aio_group |
180 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
184 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
181 | aio_chmod aio_utime aio_truncate |
185 | aio_chmod aio_utime aio_truncate |
182 | aio_msync aio_mtouch aio_mlock aio_mlockall |
186 | aio_msync aio_mtouch aio_mlock aio_mlockall |
183 | aio_statvfs |
187 | aio_statvfs |
|
|
188 | aio_slurp |
184 | aio_wd); |
189 | aio_wd); |
185 | |
190 | |
186 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
191 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
187 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
192 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
188 | min_parallel max_parallel max_idle idle_timeout |
193 | min_parallel max_parallel max_idle idle_timeout |
189 | nreqs nready npending nthreads |
194 | nreqs nready npending nthreads |
190 | max_poll_time max_poll_reqs |
195 | max_poll_time max_poll_reqs |
191 | sendfile fadvise madvise |
196 | sendfile fadvise madvise |
192 | mmap munmap munlock munlockall); |
197 | mmap munmap mremap munlock munlockall); |
193 | |
198 | |
194 | push @AIO_REQ, qw(aio_busy); # not exported |
199 | push @AIO_REQ, qw(aio_busy); # not exported |
195 | |
200 | |
196 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
201 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
197 | |
202 | |
… | |
… | |
227 | aio_unlink $pathname, $callback->($status) |
232 | aio_unlink $pathname, $callback->($status) |
228 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
233 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
229 | aio_link $srcpath, $dstpath, $callback->($status) |
234 | aio_link $srcpath, $dstpath, $callback->($status) |
230 | aio_symlink $srcpath, $dstpath, $callback->($status) |
235 | aio_symlink $srcpath, $dstpath, $callback->($status) |
231 | aio_readlink $pathname, $callback->($link) |
236 | aio_readlink $pathname, $callback->($link) |
232 | aio_realpath $pathname, $callback->($link) |
237 | aio_realpath $pathname, $callback->($path) |
233 | aio_rename $srcpath, $dstpath, $callback->($status) |
238 | aio_rename $srcpath, $dstpath, $callback->($status) |
|
|
239 | aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
234 | aio_mkdir $pathname, $mode, $callback->($status) |
240 | aio_mkdir $pathname, $mode, $callback->($status) |
235 | aio_rmdir $pathname, $callback->($status) |
241 | aio_rmdir $pathname, $callback->($status) |
236 | aio_readdir $pathname, $callback->($entries) |
242 | aio_readdir $pathname, $callback->($entries) |
237 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
243 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
238 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
244 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
… | |
… | |
240 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
246 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
241 | aio_load $pathname, $data, $callback->($status) |
247 | aio_load $pathname, $data, $callback->($status) |
242 | aio_copy $srcpath, $dstpath, $callback->($status) |
248 | aio_copy $srcpath, $dstpath, $callback->($status) |
243 | aio_move $srcpath, $dstpath, $callback->($status) |
249 | aio_move $srcpath, $dstpath, $callback->($status) |
244 | aio_rmtree $pathname, $callback->($status) |
250 | aio_rmtree $pathname, $callback->($status) |
|
|
251 | aio_fcntl $fh, $cmd, $arg, $callback->($status) |
|
|
252 | aio_ioctl $fh, $request, $buf, $callback->($status) |
245 | aio_sync $callback->($status) |
253 | aio_sync $callback->($status) |
246 | aio_syncfs $fh, $callback->($status) |
254 | aio_syncfs $fh, $callback->($status) |
247 | aio_fsync $fh, $callback->($status) |
255 | aio_fsync $fh, $callback->($status) |
248 | aio_fdatasync $fh, $callback->($status) |
256 | aio_fdatasync $fh, $callback->($status) |
249 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
257 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
250 | aio_pathsync $pathname, $callback->($status) |
258 | aio_pathsync $pathname, $callback->($status) |
251 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
259 | aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
252 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
260 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
253 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
261 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
254 | aio_mlockall $flags, $callback->($status) |
262 | aio_mlockall $flags, $callback->($status) |
255 | aio_group $callback->(...) |
263 | aio_group $callback->(...) |
256 | aio_nop $callback->() |
264 | aio_nop $callback->() |
… | |
… | |
270 | IO::AIO::idle_timeout $seconds |
278 | IO::AIO::idle_timeout $seconds |
271 | IO::AIO::max_outstanding $maxreqs |
279 | IO::AIO::max_outstanding $maxreqs |
272 | IO::AIO::nreqs |
280 | IO::AIO::nreqs |
273 | IO::AIO::nready |
281 | IO::AIO::nready |
274 | IO::AIO::npending |
282 | IO::AIO::npending |
|
|
283 | $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL] |
|
|
284 | IO::AIO::min_fdlimit $nfd [EXPERIMENTAL] |
275 | |
285 | |
276 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
286 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
277 | IO::AIO::fadvise $fh, $offset, $len, $advice |
287 | IO::AIO::fadvise $fh, $offset, $len, $advice |
278 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
288 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
279 | IO::AIO::munmap $scalar |
289 | IO::AIO::munmap $scalar |
|
|
290 | IO::AIO::mremap $scalar, $new_length, $flags[, $new_address] |
280 | IO::AIO::madvise $scalar, $offset, $length, $advice |
291 | IO::AIO::madvise $scalar, $offset, $length, $advice |
281 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
292 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
282 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
293 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
283 | IO::AIO::munlockall |
294 | IO::AIO::munlockall |
284 | |
295 | |
… | |
… | |
394 | following POSIX and non-POSIX constants are available (missing ones on |
405 | following POSIX and non-POSIX constants are available (missing ones on |
395 | your system are, as usual, C<0>): |
406 | your system are, as usual, C<0>): |
396 | |
407 | |
397 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
408 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
398 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
409 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
399 | C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>. |
410 | C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>. |
400 | |
411 | |
401 | |
412 | |
402 | =item aio_close $fh, $callback->($status) |
413 | =item aio_close $fh, $callback->($status) |
403 | |
414 | |
404 | Asynchronously close a file and call the callback with the result |
415 | Asynchronously close a file and call the callback with the result |
… | |
… | |
439 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
450 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
440 | |
451 | |
441 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
452 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
442 | |
453 | |
443 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
454 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
444 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> |
455 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and |
445 | and calls the callback without the actual number of bytes read (or -1 on |
456 | calls the callback with the actual number of bytes transferred (or -1 on |
446 | error, just like the syscall). |
457 | error, just like the syscall). |
447 | |
458 | |
448 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
459 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
449 | offset plus the actual number of bytes read. |
460 | offset plus the actual number of bytes read. |
450 | |
461 | |
… | |
… | |
508 | As native sendfile syscalls (as practically any non-POSIX interface hacked |
519 | As native sendfile syscalls (as practically any non-POSIX interface hacked |
509 | together in a hurry to improve benchmark numbers) tend to be rather buggy |
520 | together in a hurry to improve benchmark numbers) tend to be rather buggy |
510 | on many systems, this implementation tries to work around some known bugs |
521 | on many systems, this implementation tries to work around some known bugs |
511 | in Linux and FreeBSD kernels (probably others, too), but that might fail, |
522 | in Linux and FreeBSD kernels (probably others, too), but that might fail, |
512 | so you really really should check the return value of C<aio_sendfile> - |
523 | so you really really should check the return value of C<aio_sendfile> - |
513 | fewre bytes than expected might have been transferred. |
524 | fewer bytes than expected might have been transferred. |
514 | |
525 | |
515 | |
526 | |
516 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
527 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
517 | |
528 | |
518 | C<aio_readahead> populates the page cache with data from a file so that |
529 | C<aio_readahead> populates the page cache with data from a file so that |
… | |
… | |
522 | whole pages, so that offset is effectively rounded down to a page boundary |
533 | whole pages, so that offset is effectively rounded down to a page boundary |
523 | and bytes are read up to the next page boundary greater than or equal to |
534 | and bytes are read up to the next page boundary greater than or equal to |
524 | (off-set+length). C<aio_readahead> does not read beyond the end of the |
535 | (off-set+length). C<aio_readahead> does not read beyond the end of the |
525 | file. The current file offset of the file is left unchanged. |
536 | file. The current file offset of the file is left unchanged. |
526 | |
537 | |
527 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
538 | If that syscall doesn't exist (likely if your kernel isn't Linux) it will |
528 | emulated by simply reading the data, which would have a similar effect. |
539 | be emulated by simply reading the data, which would have a similar effect. |
529 | |
540 | |
530 | |
541 | |
531 | =item aio_stat $fh_or_path, $callback->($status) |
542 | =item aio_stat $fh_or_path, $callback->($status) |
532 | |
543 | |
533 | =item aio_lstat $fh, $callback->($status) |
544 | =item aio_lstat $fh, $callback->($status) |
534 | |
545 | |
535 | Works like perl's C<stat> or C<lstat> in void context. The callback will |
546 | Works almost exactly like perl's C<stat> or C<lstat> in void context. The |
536 | be called after the stat and the results will be available using C<stat _> |
547 | callback will be called after the stat and the results will be available |
537 | or C<-s _> etc... |
548 | using C<stat _> or C<-s _> and other tests (with the exception of C<-B> |
|
|
549 | and C<-T>). |
538 | |
550 | |
539 | The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, |
551 | The pathname passed to C<aio_stat> must be absolute. See API NOTES, above, |
540 | for an explanation. |
552 | for an explanation. |
541 | |
553 | |
542 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
554 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
… | |
… | |
549 | behaviour). |
561 | behaviour). |
550 | |
562 | |
551 | C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, |
563 | C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, |
552 | C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, |
564 | C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, |
553 | C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. |
565 | C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. |
|
|
566 | |
|
|
567 | To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME |
|
|
568 | ACCESS>. |
554 | |
569 | |
555 | Example: Print the length of F</etc/passwd>: |
570 | Example: Print the length of F</etc/passwd>: |
556 | |
571 | |
557 | aio_stat "/etc/passwd", sub { |
572 | aio_stat "/etc/passwd", sub { |
558 | $_[0] and die "stat failed: $!"; |
573 | $_[0] and die "stat failed: $!"; |
… | |
… | |
602 | namemax => 255, |
617 | namemax => 255, |
603 | frsize => 1024, |
618 | frsize => 1024, |
604 | fsid => 1810 |
619 | fsid => 1810 |
605 | } |
620 | } |
606 | |
621 | |
607 | Here is a (likely partial - send me updates!) list of fsid values used by |
|
|
608 | Linux - it is safe to hardcode these when C<$^O> is C<linux>: |
|
|
609 | |
|
|
610 | 0x0000adf5 adfs |
|
|
611 | 0x0000adff affs |
|
|
612 | 0x5346414f afs |
|
|
613 | 0x09041934 anon-inode filesystem |
|
|
614 | 0x00000187 autofs |
|
|
615 | 0x42465331 befs |
|
|
616 | 0x1badface bfs |
|
|
617 | 0x42494e4d binfmt_misc |
|
|
618 | 0x9123683e btrfs |
|
|
619 | 0x0027e0eb cgroupfs |
|
|
620 | 0xff534d42 cifs |
|
|
621 | 0x73757245 coda |
|
|
622 | 0x012ff7b7 coh |
|
|
623 | 0x28cd3d45 cramfs |
|
|
624 | 0x453dcd28 cramfs-wend (wrong endianness) |
|
|
625 | 0x64626720 debugfs |
|
|
626 | 0x00001373 devfs |
|
|
627 | 0x00001cd1 devpts |
|
|
628 | 0x0000f15f ecryptfs |
|
|
629 | 0x00414a53 efs |
|
|
630 | 0x0000137d ext |
|
|
631 | 0x0000ef53 ext2/ext3 |
|
|
632 | 0x0000ef51 ext2 |
|
|
633 | 0x00004006 fat |
|
|
634 | 0x65735546 fuseblk |
|
|
635 | 0x65735543 fusectl |
|
|
636 | 0x0bad1dea futexfs |
|
|
637 | 0x01161970 gfs2 |
|
|
638 | 0x47504653 gpfs |
|
|
639 | 0x00004244 hfs |
|
|
640 | 0xf995e849 hpfs |
|
|
641 | 0x958458f6 hugetlbfs |
|
|
642 | 0x2bad1dea inotifyfs |
|
|
643 | 0x00009660 isofs |
|
|
644 | 0x000072b6 jffs2 |
|
|
645 | 0x3153464a jfs |
|
|
646 | 0x6b414653 k-afs |
|
|
647 | 0x0bd00bd0 lustre |
|
|
648 | 0x0000137f minix |
|
|
649 | 0x0000138f minix 30 char names |
|
|
650 | 0x00002468 minix v2 |
|
|
651 | 0x00002478 minix v2 30 char names |
|
|
652 | 0x00004d5a minix v3 |
|
|
653 | 0x19800202 mqueue |
|
|
654 | 0x00004d44 msdos |
|
|
655 | 0x0000564c novell |
|
|
656 | 0x00006969 nfs |
|
|
657 | 0x6e667364 nfsd |
|
|
658 | 0x00003434 nilfs |
|
|
659 | 0x5346544e ntfs |
|
|
660 | 0x00009fa1 openprom |
|
|
661 | 0x7461636F ocfs2 |
|
|
662 | 0x00009fa0 proc |
|
|
663 | 0x6165676c pstorefs |
|
|
664 | 0x0000002f qnx4 |
|
|
665 | 0x858458f6 ramfs |
|
|
666 | 0x52654973 reiserfs |
|
|
667 | 0x00007275 romfs |
|
|
668 | 0x67596969 rpc_pipefs |
|
|
669 | 0x73636673 securityfs |
|
|
670 | 0xf97cff8c selinux |
|
|
671 | 0x0000517b smb |
|
|
672 | 0x534f434b sockfs |
|
|
673 | 0x73717368 squashfs |
|
|
674 | 0x62656572 sysfs |
|
|
675 | 0x012ff7b6 sysv2 |
|
|
676 | 0x012ff7b5 sysv4 |
|
|
677 | 0x01021994 tmpfs |
|
|
678 | 0x15013346 udf |
|
|
679 | 0x00011954 ufs |
|
|
680 | 0x54190100 ufs byteswapped |
|
|
681 | 0x00009fa2 usbdevfs |
|
|
682 | 0x01021997 v9fs |
|
|
683 | 0xa501fcf5 vxfs |
|
|
684 | 0xabba1974 xenfs |
|
|
685 | 0x012ff7b4 xenix |
|
|
686 | 0x58465342 xfs |
|
|
687 | 0x012fd16d xia |
|
|
688 | |
|
|
689 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
622 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
690 | |
623 | |
691 | Works like perl's C<utime> function (including the special case of $atime |
624 | Works like perl's C<utime> function (including the special case of $atime |
692 | and $mtime being undef). Fractional times are supported if the underlying |
625 | and $mtime being undef). Fractional times are supported if the underlying |
693 | syscalls support them. |
626 | syscalls support them. |
694 | |
627 | |
695 | When called with a pathname, uses utimes(2) if available, otherwise |
628 | When called with a pathname, uses utimensat(2) or utimes(2) if available, |
696 | utime(2). If called on a file descriptor, uses futimes(2) if available, |
629 | otherwise utime(2). If called on a file descriptor, uses futimens(2) |
697 | otherwise returns ENOSYS, so this is not portable. |
630 | or futimes(2) if available, otherwise returns ENOSYS, so this is not |
|
|
631 | portable. |
698 | |
632 | |
699 | Examples: |
633 | Examples: |
700 | |
634 | |
701 | # set atime and mtime to current time (basically touch(1)): |
635 | # set atime and mtime to current time (basically touch(1)): |
702 | aio_utime "path", undef, undef; |
636 | aio_utime "path", undef, undef; |
… | |
… | |
722 | Works like truncate(2) or ftruncate(2). |
656 | Works like truncate(2) or ftruncate(2). |
723 | |
657 | |
724 | |
658 | |
725 | =item aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
659 | =item aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
726 | |
660 | |
727 | Allocates or freed disk space according to the C<$mode> argument. See the |
661 | Allocates or frees disk space according to the C<$mode> argument. See the |
728 | linux C<fallocate> docuemntation for details. |
662 | linux C<fallocate> documentation for details. |
729 | |
663 | |
730 | C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> |
664 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
731 | to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | |
665 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
732 | IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range. |
666 | to deallocate a file range. |
|
|
667 | |
|
|
668 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
|
|
669 | (without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range, |
|
|
670 | C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE> |
|
|
671 | to unshare shared blocks (see your L<fallocate(2)> manpage). |
733 | |
672 | |
734 | The file system block size used by C<fallocate> is presumably the |
673 | The file system block size used by C<fallocate> is presumably the |
735 | C<f_bsize> returned by C<statvfs>. |
674 | C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes |
|
|
675 | can dictate other limitations. |
736 | |
676 | |
737 | If C<fallocate> isn't available or cannot be emulated (currently no |
677 | If C<fallocate> isn't available or cannot be emulated (currently no |
738 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
678 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
739 | |
679 | |
740 | |
680 | |
… | |
… | |
799 | On systems that support the AIO::WD working directory abstraction |
739 | On systems that support the AIO::WD working directory abstraction |
800 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
740 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
801 | of failing, C<rename> is called on the absolute path of C<$wd>. |
741 | of failing, C<rename> is called on the absolute path of C<$wd>. |
802 | |
742 | |
803 | |
743 | |
|
|
744 | =item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
|
|
745 | |
|
|
746 | Basically a version of C<aio_rename> with an additional C<$flags> |
|
|
747 | argument. Calling this with C<$flags=0> is the same as calling |
|
|
748 | C<aio_rename>. |
|
|
749 | |
|
|
750 | Non-zero flags are currently only supported on GNU/Linux systems that |
|
|
751 | support renameat2. Other systems fail with C<ENOSYS> in this case. |
|
|
752 | |
|
|
753 | The following constants are available (missing ones are, as usual C<0>), |
|
|
754 | see renameat2(2) for details: |
|
|
755 | |
|
|
756 | C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE> |
|
|
757 | and C<IO::AIO::RENAME_WHITEOUT>. |
|
|
758 | |
|
|
759 | |
804 | =item aio_mkdir $pathname, $mode, $callback->($status) |
760 | =item aio_mkdir $pathname, $mode, $callback->($status) |
805 | |
761 | |
806 | Asynchronously mkdir (create) a directory and call the callback with |
762 | Asynchronously mkdir (create) a directory and call the callback with |
807 | the result code. C<$mode> will be modified by the umask at the time the |
763 | the result code. C<$mode> will be modified by the umask at the time the |
808 | request is executed, so do not change your umask. |
764 | request is executed, so do not change your umask. |
… | |
… | |
839 | |
795 | |
840 | =over 4 |
796 | =over 4 |
841 | |
797 | |
842 | =item IO::AIO::READDIR_DENTS |
798 | =item IO::AIO::READDIR_DENTS |
843 | |
799 | |
844 | When this flag is off, then the callback gets an arrayref consisting of |
800 | Normally the callback gets an arrayref consisting of names only (as |
845 | names only (as with C<aio_readdir>), otherwise it gets an arrayref with |
801 | with C<aio_readdir>). If this flag is set, then the callback gets an |
846 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
802 | arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a |
847 | entry in more detail. |
803 | single directory entry in more detail: |
848 | |
804 | |
849 | C<$name> is the name of the entry. |
805 | C<$name> is the name of the entry. |
850 | |
806 | |
851 | C<$type> is one of the C<IO::AIO::DT_xxx> constants: |
807 | C<$type> is one of the C<IO::AIO::DT_xxx> constants: |
852 | |
808 | |
853 | C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, |
809 | C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, |
854 | C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, |
810 | C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, |
855 | C<IO::AIO::DT_WHT>. |
811 | C<IO::AIO::DT_WHT>. |
856 | |
812 | |
857 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to |
813 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need |
858 | know, you have to run stat yourself. Also, for speed reasons, the C<$type> |
814 | to know, you have to run stat yourself. Also, for speed/memory reasons, |
859 | scalars are read-only: you can not modify them. |
815 | the C<$type> scalars are read-only: you must not modify them. |
860 | |
816 | |
861 | C<$inode> is the inode number (which might not be exact on systems with 64 |
817 | C<$inode> is the inode number (which might not be exact on systems with 64 |
862 | bit inode numbers and 32 bit perls). This field has unspecified content on |
818 | bit inode numbers and 32 bit perls). This field has unspecified content on |
863 | systems that do not deliver the inode information. |
819 | systems that do not deliver the inode information. |
864 | |
820 | |
… | |
… | |
875 | short names are tried first. |
831 | short names are tried first. |
876 | |
832 | |
877 | =item IO::AIO::READDIR_STAT_ORDER |
833 | =item IO::AIO::READDIR_STAT_ORDER |
878 | |
834 | |
879 | When this flag is set, then the names will be returned in an order |
835 | When this flag is set, then the names will be returned in an order |
880 | suitable for stat()'ing each one. That is, when you plan to stat() |
836 | suitable for stat()'ing each one. That is, when you plan to stat() most or |
881 | all files in the given directory, then the returned order will likely |
837 | all files in the given directory, then the returned order will likely be |
882 | be fastest. |
838 | faster. |
883 | |
839 | |
884 | If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then |
840 | If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, |
885 | the likely dirs come first, resulting in a less optimal stat order. |
841 | then the likely dirs come first, resulting in a less optimal stat order |
|
|
842 | for stat'ing all entries, but likely a more optimal order for finding |
|
|
843 | subdirectories. |
886 | |
844 | |
887 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
845 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
888 | |
846 | |
889 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
847 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
890 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
848 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
… | |
… | |
892 | C<$type>'s are known, which can be used to speed up some algorithms. |
850 | C<$type>'s are known, which can be used to speed up some algorithms. |
893 | |
851 | |
894 | =back |
852 | =back |
895 | |
853 | |
896 | |
854 | |
|
|
855 | =item aio_slurp $pathname, $offset, $length, $data, $callback->($status) |
|
|
856 | |
|
|
857 | Opens, reads and closes the given file. The data is put into C<$data>, |
|
|
858 | which is resized as required. |
|
|
859 | |
|
|
860 | If C<$offset> is negative, then it is counted from the end of the file. |
|
|
861 | |
|
|
862 | If C<$length> is zero, then the remaining length of the file is |
|
|
863 | used. Also, in this case, the same limitations to modifying C<$data> apply |
|
|
864 | as when IO::AIO::mmap is used, i.e. it must only be modified in-place |
|
|
865 | with C<substr>. If the size of the file is known, specifying a non-zero |
|
|
866 | C<$length> results in a performance advantage. |
|
|
867 | |
|
|
868 | This request is similar to the older C<aio_load> request, but since it is |
|
|
869 | a single request, it might be more efficient to use. |
|
|
870 | |
|
|
871 | Example: load F</etc/passwd> into C<$passwd>. |
|
|
872 | |
|
|
873 | my $passwd; |
|
|
874 | aio_slurp "/etc/passwd", 0, 0, $passwd, sub { |
|
|
875 | $_[0] >= 0 |
|
|
876 | or die "/etc/passwd: $!\n"; |
|
|
877 | |
|
|
878 | printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd; |
|
|
879 | print $passwd; |
|
|
880 | }; |
|
|
881 | IO::AIO::flush; |
|
|
882 | |
|
|
883 | |
897 | =item aio_load $pathname, $data, $callback->($status) |
884 | =item aio_load $pathname, $data, $callback->($status) |
898 | |
885 | |
899 | This is a composite request that tries to fully load the given file into |
886 | This is a composite request that tries to fully load the given file into |
900 | memory. Status is the same as with aio_read. |
887 | memory. Status is the same as with aio_read. |
|
|
888 | |
|
|
889 | Using C<aio_slurp> might be more efficient, as it is a single request. |
901 | |
890 | |
902 | =cut |
891 | =cut |
903 | |
892 | |
904 | sub aio_load($$;$) { |
893 | sub aio_load($$;$) { |
905 | my ($path, undef, $cb) = @_; |
894 | my ($path, undef, $cb) = @_; |
… | |
… | |
925 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
914 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
926 | |
915 | |
927 | Try to copy the I<file> (directories not supported as either source or |
916 | Try to copy the I<file> (directories not supported as either source or |
928 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
917 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
929 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
918 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
|
|
919 | |
|
|
920 | Existing destination files will be truncated. |
930 | |
921 | |
931 | This is a composite request that creates the destination file with |
922 | This is a composite request that creates the destination file with |
932 | mode 0200 and copies the contents of the source file into it using |
923 | mode 0200 and copies the contents of the source file into it using |
933 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
924 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
934 | uid/gid, in that order. |
925 | uid/gid, in that order. |
… | |
… | |
1044 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
1035 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
1045 | efficiently separate the entries of directory C<$path> into two sets of |
1036 | efficiently separate the entries of directory C<$path> into two sets of |
1046 | names, directories you can recurse into (directories), and ones you cannot |
1037 | names, directories you can recurse into (directories), and ones you cannot |
1047 | recurse into (everything else, including symlinks to directories). |
1038 | recurse into (everything else, including symlinks to directories). |
1048 | |
1039 | |
1049 | C<aio_scandir> is a composite request that creates of many sub requests_ |
1040 | C<aio_scandir> is a composite request that generates many sub requests. |
1050 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
1041 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
1051 | this function generates. If it is C<< <= 0 >>, then a suitable default |
1042 | this function generates. If it is C<< <= 0 >>, then a suitable default |
1052 | will be chosen (currently 4). |
1043 | will be chosen (currently 4). |
1053 | |
1044 | |
1054 | On error, the callback is called without arguments, otherwise it receives |
1045 | On error, the callback is called without arguments, otherwise it receives |
… | |
… | |
1118 | aioreq_pri $pri; |
1109 | aioreq_pri $pri; |
1119 | add $grp aio_stat $wd, sub { |
1110 | add $grp aio_stat $wd, sub { |
1120 | return $grp->result () if $_[0]; |
1111 | return $grp->result () if $_[0]; |
1121 | my $now = time; |
1112 | my $now = time; |
1122 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
1113 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
1114 | my $rdxflags = READDIR_DIRS_FIRST; |
|
|
1115 | |
|
|
1116 | if ((stat _)[3] < 2) { |
|
|
1117 | # at least one non-POSIX filesystem exists |
|
|
1118 | # that returns useful DT_type values: btrfs, |
|
|
1119 | # so optimise for this here by requesting dents |
|
|
1120 | $rdxflags |= READDIR_DENTS; |
|
|
1121 | } |
1123 | |
1122 | |
1124 | # read the directory entries |
1123 | # read the directory entries |
1125 | aioreq_pri $pri; |
1124 | aioreq_pri $pri; |
1126 | add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub { |
1125 | add $grp aio_readdirx $wd, $rdxflags, sub { |
1127 | my $entries = shift |
1126 | my ($entries, $flags) = @_ |
1128 | or return $grp->result (); |
1127 | or return $grp->result (); |
|
|
1128 | |
|
|
1129 | if ($rdxflags & READDIR_DENTS) { |
|
|
1130 | # if we requested type values, see if we can use them directly. |
|
|
1131 | |
|
|
1132 | # if there were any DT_UNKNOWN entries then we assume we |
|
|
1133 | # don't know. alternatively, we could assume that if we get |
|
|
1134 | # one DT_DIR, then all directories are indeed marked with |
|
|
1135 | # DT_DIR, but this seems not required for btrfs, and this |
|
|
1136 | # is basically the "btrfs can't get it's act together" code |
|
|
1137 | # branch. |
|
|
1138 | unless ($flags & READDIR_FOUND_UNKNOWN) { |
|
|
1139 | # now we have valid DT_ information for all entries, |
|
|
1140 | # so use it as an optimisation without further stat's. |
|
|
1141 | # they must also all be at the beginning of @$entries |
|
|
1142 | # by now. |
|
|
1143 | |
|
|
1144 | my $dirs; |
|
|
1145 | |
|
|
1146 | if (@$entries) { |
|
|
1147 | for (0 .. $#$entries) { |
|
|
1148 | if ($entries->[$_][1] != DT_DIR) { |
|
|
1149 | # splice out directories |
|
|
1150 | $dirs = [splice @$entries, 0, $_]; |
|
|
1151 | last; |
|
|
1152 | } |
|
|
1153 | } |
|
|
1154 | |
|
|
1155 | # if we didn't find any non-dir, then all entries are dirs |
|
|
1156 | unless ($dirs) { |
|
|
1157 | ($dirs, $entries) = ($entries, []); |
|
|
1158 | } |
|
|
1159 | } else { |
|
|
1160 | # directory is empty, so there are no sbdirs |
|
|
1161 | $dirs = []; |
|
|
1162 | } |
|
|
1163 | |
|
|
1164 | # either splice'd the directories out or the dir was empty. |
|
|
1165 | # convert dents to filenames |
|
|
1166 | $_ = $_->[0] for @$dirs; |
|
|
1167 | $_ = $_->[0] for @$entries; |
|
|
1168 | |
|
|
1169 | return $grp->result ($dirs, $entries); |
|
|
1170 | } |
|
|
1171 | |
|
|
1172 | # cannot use, so return to our old ways |
|
|
1173 | # by pretending we only scanned for names. |
|
|
1174 | $_ = $_->[0] for @$entries; |
|
|
1175 | } |
1129 | |
1176 | |
1130 | # stat the dir another time |
1177 | # stat the dir another time |
1131 | aioreq_pri $pri; |
1178 | aioreq_pri $pri; |
1132 | add $grp aio_stat $wd, sub { |
1179 | add $grp aio_stat $wd, sub { |
1133 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
1180 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
… | |
… | |
1220 | }; |
1267 | }; |
1221 | |
1268 | |
1222 | $grp |
1269 | $grp |
1223 | } |
1270 | } |
1224 | |
1271 | |
|
|
1272 | =item aio_fcntl $fh, $cmd, $arg, $callback->($status) |
|
|
1273 | |
|
|
1274 | =item aio_ioctl $fh, $request, $buf, $callback->($status) |
|
|
1275 | |
|
|
1276 | These work just like the C<fcntl> and C<ioctl> built-in functions, except |
|
|
1277 | they execute asynchronously and pass the return value to the callback. |
|
|
1278 | |
|
|
1279 | Both calls can be used for a lot of things, some of which make more sense |
|
|
1280 | to run asynchronously in their own thread, while some others make less |
|
|
1281 | sense. For example, calls that block waiting for external events, such |
|
|
1282 | as locking, will also lock down an I/O thread while it is waiting, which |
|
|
1283 | can deadlock the whole I/O system. At the same time, there might be no |
|
|
1284 | alternative to using a thread to wait. |
|
|
1285 | |
|
|
1286 | So in general, you should only use these calls for things that do |
|
|
1287 | (filesystem) I/O, not for things that wait for other events (network, |
|
|
1288 | other processes), although if you are careful and know what you are doing, |
|
|
1289 | you still can. |
|
|
1290 | |
|
|
1291 | The following constants are available (missing ones are, as usual C<0>): |
|
|
1292 | |
|
|
1293 | C<F_DUPFD_CLOEXEC>, |
|
|
1294 | |
|
|
1295 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
|
|
1296 | |
|
|
1297 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
|
|
1298 | |
|
|
1299 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
|
|
1300 | C<FS_IOC_FIEMAP>. |
|
|
1301 | |
|
|
1302 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
|
|
1303 | C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>. |
|
|
1304 | |
|
|
1305 | C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>, |
|
|
1306 | C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>, |
|
|
1307 | C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>, |
|
|
1308 | C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>, |
|
|
1309 | C<FS_FL_USER_MODIFIABLE>. |
|
|
1310 | |
|
|
1311 | C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>, |
|
|
1312 | C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>, |
|
|
1313 | C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>, |
|
|
1314 | C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>, |
|
|
1315 | |
1225 | =item aio_sync $callback->($status) |
1316 | =item aio_sync $callback->($status) |
1226 | |
1317 | |
1227 | Asynchronously call sync and call the callback when finished. |
1318 | Asynchronously call sync and call the callback when finished. |
1228 | |
1319 | |
1229 | =item aio_fsync $fh, $callback->($status) |
1320 | =item aio_fsync $fh, $callback->($status) |
… | |
… | |
1297 | }; |
1388 | }; |
1298 | |
1389 | |
1299 | $grp |
1390 | $grp |
1300 | } |
1391 | } |
1301 | |
1392 | |
1302 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1393 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
1303 | |
1394 | |
1304 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
1395 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
1305 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
1396 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
1306 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
1397 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
1307 | scalar must only be modified in-place while an aio operation is pending on |
1398 | scalar must only be modified in-place while an aio operation is pending on |
… | |
… | |
1309 | |
1400 | |
1310 | It calls the C<msync> function of your OS, if available, with the memory |
1401 | It calls the C<msync> function of your OS, if available, with the memory |
1311 | area starting at C<$offset> in the string and ending C<$length> bytes |
1402 | area starting at C<$offset> in the string and ending C<$length> bytes |
1312 | later. If C<$length> is negative, counts from the end, and if C<$length> |
1403 | later. If C<$length> is negative, counts from the end, and if C<$length> |
1313 | is C<undef>, then it goes till the end of the string. The flags can be |
1404 | is C<undef>, then it goes till the end of the string. The flags can be |
1314 | a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and |
1405 | either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional |
1315 | C<IO::AIO::MS_SYNC>. |
1406 | C<IO::AIO::MS_INVALIDATE>. |
1316 | |
1407 | |
1317 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1408 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1318 | |
1409 | |
1319 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1410 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1320 | scalars. |
1411 | scalars. |
… | |
… | |
1350 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1441 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1351 | aio_mlock $data; # mlock in background |
1442 | aio_mlock $data; # mlock in background |
1352 | |
1443 | |
1353 | =item aio_mlockall $flags, $callback->($status) |
1444 | =item aio_mlockall $flags, $callback->($status) |
1354 | |
1445 | |
1355 | Calls the C<mlockall> function with the given C<$flags> (a combination of |
1446 | Calls the C<mlockall> function with the given C<$flags> (a |
1356 | C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>). |
1447 | combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and |
|
|
1448 | C<IO::AIO::MCL_ONFAULT>). |
1357 | |
1449 | |
1358 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1450 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1359 | and sets errno to C<ENOSYS>. |
1451 | and sets errno to C<ENOSYS>. Similarly, flag combinations not supported |
|
|
1452 | by the system result in a return value of C<-1> with errno being set to |
|
|
1453 | C<EINVAL>. |
1360 | |
1454 | |
1361 | Note that the corresponding C<munlockall> is synchronous and is |
1455 | Note that the corresponding C<munlockall> is synchronous and is |
1362 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1456 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1363 | |
1457 | |
1364 | Example: asynchronously lock all current and future pages into memory. |
1458 | Example: asynchronously lock all current and future pages into memory. |
… | |
… | |
1403 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
1497 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
1404 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
1498 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
1405 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
1499 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
1406 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1500 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1407 | |
1501 | |
1408 | At the time of this writing (Linux 3.2), this requets is unreliable unless |
1502 | At the time of this writing (Linux 3.2), this request is unreliable unless |
1409 | C<$count> is C<undef>, as the kernel has all sorts of bugs preventing |
1503 | C<$count> is C<undef>, as the kernel has all sorts of bugs preventing |
1410 | it to return all extents of a range for files with large number of |
1504 | it to return all extents of a range for files with a large number of |
1411 | extents. The code works around all these issues if C<$count> is undef. |
1505 | extents. The code (only) works around all these issues if C<$count> is |
|
|
1506 | C<undef>. |
1412 | |
1507 | |
1413 | =item aio_group $callback->(...) |
1508 | =item aio_group $callback->(...) |
1414 | |
1509 | |
1415 | This is a very special aio request: Instead of doing something, it is a |
1510 | This is a very special aio request: Instead of doing something, it is a |
1416 | container for other aio requests, which is useful if you want to bundle |
1511 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
1500 | aio_stat [$etcdir, "passwd"], sub { |
1595 | aio_stat [$etcdir, "passwd"], sub { |
1501 | # yay |
1596 | # yay |
1502 | }; |
1597 | }; |
1503 | }; |
1598 | }; |
1504 | |
1599 | |
1505 | That C<aio_wd> is a request and not a normal function shows that creating |
1600 | The fact that C<aio_wd> is a request and not a normal function shows that |
1506 | an IO::AIO::WD object is itself a potentially blocking operation, which is |
1601 | creating an IO::AIO::WD object is itself a potentially blocking operation, |
1507 | why it is done asynchronously. |
1602 | which is why it is done asynchronously. |
1508 | |
1603 | |
1509 | To stat the directory obtained with C<aio_wd> above, one could write |
1604 | To stat the directory obtained with C<aio_wd> above, one could write |
1510 | either of the following three request calls: |
1605 | either of the following three request calls: |
1511 | |
1606 | |
1512 | aio_lstat "/etc" , sub { ... # pathname as normal string |
1607 | aio_lstat "/etc" , sub { ... # pathname as normal string |
… | |
… | |
1529 | There are some caveats: when directories get renamed (or deleted), the |
1624 | There are some caveats: when directories get renamed (or deleted), the |
1530 | pathname string doesn't change, so will point to the new directory (or |
1625 | pathname string doesn't change, so will point to the new directory (or |
1531 | nowhere at all), while the directory fd, if available on the system, |
1626 | nowhere at all), while the directory fd, if available on the system, |
1532 | will still point to the original directory. Most functions accepting a |
1627 | will still point to the original directory. Most functions accepting a |
1533 | pathname will use the directory fd on newer systems, and the string on |
1628 | pathname will use the directory fd on newer systems, and the string on |
1534 | older systems. Some functions (such as realpath) will always rely on the |
1629 | older systems. Some functions (such as C<aio_realpath>) will always rely on |
1535 | string form of the pathname. |
1630 | the string form of the pathname. |
1536 | |
1631 | |
1537 | So this functionality is mainly useful to get some protection against |
1632 | So this functionality is mainly useful to get some protection against |
1538 | C<chdir>, to easily get an absolute path out of a relative path for future |
1633 | C<chdir>, to easily get an absolute path out of a relative path for future |
1539 | reference, and to speed up doing many operations in the same directory |
1634 | reference, and to speed up doing many operations in the same directory |
1540 | (e.g. when stat'ing all files in a directory). |
1635 | (e.g. when stat'ing all files in a directory). |
… | |
… | |
1748 | The default value for the limit is C<0>, but note that setting a feeder |
1843 | The default value for the limit is C<0>, but note that setting a feeder |
1749 | automatically bumps it up to C<2>. |
1844 | automatically bumps it up to C<2>. |
1750 | |
1845 | |
1751 | =back |
1846 | =back |
1752 | |
1847 | |
|
|
1848 | |
1753 | =head2 SUPPORT FUNCTIONS |
1849 | =head2 SUPPORT FUNCTIONS |
1754 | |
1850 | |
1755 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1851 | =head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION |
1756 | |
1852 | |
1757 | =over 4 |
1853 | =over 4 |
… | |
… | |
1822 | Strictly equivalent to: |
1918 | Strictly equivalent to: |
1823 | |
1919 | |
1824 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1920 | IO::AIO::poll_wait, IO::AIO::poll_cb |
1825 | while IO::AIO::nreqs; |
1921 | while IO::AIO::nreqs; |
1826 | |
1922 | |
|
|
1923 | This function can be useful at program aborts, to make sure outstanding |
|
|
1924 | I/O has been done (C<IO::AIO> uses an C<END> block which already calls |
|
|
1925 | this function on normal exits), or when you are merely using C<IO::AIO> |
|
|
1926 | for its more advanced functions, rather than for async I/O, e.g.: |
|
|
1927 | |
|
|
1928 | my ($dirs, $nondirs); |
|
|
1929 | IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ }; |
|
|
1930 | IO::AIO::flush; |
|
|
1931 | # $dirs, $nondirs are now set |
|
|
1932 | |
1827 | =item IO::AIO::max_poll_reqs $nreqs |
1933 | =item IO::AIO::max_poll_reqs $nreqs |
1828 | |
1934 | |
1829 | =item IO::AIO::max_poll_time $seconds |
1935 | =item IO::AIO::max_poll_time $seconds |
1830 | |
1936 | |
1831 | These set the maximum number of requests (default C<0>, meaning infinity) |
1937 | These set the maximum number of requests (default C<0>, meaning infinity) |
… | |
… | |
1857 | poll => 'r', nice => 1, |
1963 | poll => 'r', nice => 1, |
1858 | cb => &IO::AIO::poll_cb); |
1964 | cb => &IO::AIO::poll_cb); |
1859 | |
1965 | |
1860 | =back |
1966 | =back |
1861 | |
1967 | |
|
|
1968 | |
1862 | =head3 CONTROLLING THE NUMBER OF THREADS |
1969 | =head3 CONTROLLING THE NUMBER OF THREADS |
1863 | |
1970 | |
1864 | =over |
1971 | =over |
1865 | |
1972 | |
1866 | =item IO::AIO::min_parallel $nthreads |
1973 | =item IO::AIO::min_parallel $nthreads |
… | |
… | |
1931 | |
2038 | |
1932 | This is a very bad function to use in interactive programs because it |
2039 | This is a very bad function to use in interactive programs because it |
1933 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
2040 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1934 | use an C<aio_group> together with a feed callback. |
2041 | use an C<aio_group> together with a feed callback. |
1935 | |
2042 | |
1936 | It's main use is in scripts without an event loop - when you want to stat |
2043 | Its main use is in scripts without an event loop - when you want to stat |
1937 | a lot of files, you can write somehting like this: |
2044 | a lot of files, you can write something like this: |
1938 | |
2045 | |
1939 | IO::AIO::max_outstanding 32; |
2046 | IO::AIO::max_outstanding 32; |
1940 | |
2047 | |
1941 | for my $path (...) { |
2048 | for my $path (...) { |
1942 | aio_stat $path , ...; |
2049 | aio_stat $path , ...; |
… | |
… | |
1953 | The default value for C<max_outstanding> is very large, so there is no |
2060 | The default value for C<max_outstanding> is very large, so there is no |
1954 | practical limit on the number of outstanding requests. |
2061 | practical limit on the number of outstanding requests. |
1955 | |
2062 | |
1956 | =back |
2063 | =back |
1957 | |
2064 | |
|
|
2065 | |
1958 | =head3 STATISTICAL INFORMATION |
2066 | =head3 STATISTICAL INFORMATION |
1959 | |
2067 | |
1960 | =over |
2068 | =over |
1961 | |
2069 | |
1962 | =item IO::AIO::nreqs |
2070 | =item IO::AIO::nreqs |
… | |
… | |
1979 | Returns the number of requests currently in the pending state (executed, |
2087 | Returns the number of requests currently in the pending state (executed, |
1980 | but not yet processed by poll_cb). |
2088 | but not yet processed by poll_cb). |
1981 | |
2089 | |
1982 | =back |
2090 | =back |
1983 | |
2091 | |
|
|
2092 | |
|
|
2093 | =head3 SUBSECOND STAT TIME ACCESS |
|
|
2094 | |
|
|
2095 | Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can |
|
|
2096 | generally find access/modification and change times with subsecond time |
|
|
2097 | accuracy of the system supports it, but perl's built-in functions only |
|
|
2098 | return the integer part. |
|
|
2099 | |
|
|
2100 | The following functions return the timestamps of the most recent |
|
|
2101 | stat with subsecond precision on most systems and work both after |
|
|
2102 | C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return |
|
|
2103 | value is only meaningful after a successful C<stat>/C<lstat> call, or |
|
|
2104 | during/after a successful C<aio_stat>/C<aio_lstat> callback. |
|
|
2105 | |
|
|
2106 | This is similar to the L<Time::HiRes> C<stat> functions, but can return |
|
|
2107 | full resolution without rounding and work with standard perl C<stat>, |
|
|
2108 | alleviating the need to call the special C<Time::HiRes> functions, which |
|
|
2109 | do not act like their perl counterparts. |
|
|
2110 | |
|
|
2111 | On operating systems or file systems where subsecond time resolution is |
|
|
2112 | not supported or could not be detected, a fractional part of C<0> is |
|
|
2113 | returned, so it is always safe to call these functions. |
|
|
2114 | |
|
|
2115 | =over 4 |
|
|
2116 | |
|
|
2117 | =item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime |
|
|
2118 | |
|
|
2119 | Return the access, modication, change or birth time, respectively, |
|
|
2120 | including fractional part. Due to the limited precision of floating point, |
|
|
2121 | the accuracy on most platforms is only a bit better than milliseconds |
|
|
2122 | for times around now - see the I<nsec> function family, below, for full |
|
|
2123 | accuracy. |
|
|
2124 | |
|
|
2125 | File birth time is only available when the OS and perl support it (on |
|
|
2126 | FreeBSD and NetBSD at the time of this writing, although support is |
|
|
2127 | adaptive, so if your OS/perl gains support, IO::AIO can take avdantage of |
|
|
2128 | it). On systems where it isn't available, C<0> is currently returned, but |
|
|
2129 | this might change to C<undef> in a future version. |
|
|
2130 | |
|
|
2131 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
|
|
2132 | |
|
|
2133 | Returns access, modification, change and birth time all in one go, and |
|
|
2134 | maybe more times in the future version. |
|
|
2135 | |
|
|
2136 | =item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec |
|
|
2137 | |
|
|
2138 | Return the fractional access, modifcation, change or birth time, in nanoseconds, |
|
|
2139 | as an integer in the range C<0> to C<999999999>. |
|
|
2140 | |
|
|
2141 | Note that no accessors are provided for access, modification and |
|
|
2142 | change times - you need to get those from C<stat _> if required (C<int |
|
|
2143 | IO::AIO::st_atime> and so on will I<not> generally give you the correct |
|
|
2144 | value). |
|
|
2145 | |
|
|
2146 | =item $seconds = IO::AIO::st_btimesec |
|
|
2147 | |
|
|
2148 | The (integral) seconds part of the file birth time, if available. |
|
|
2149 | |
|
|
2150 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec |
|
|
2151 | |
|
|
2152 | Like the functions above, but returns all four times in one go (and maybe |
|
|
2153 | more in future versions). |
|
|
2154 | |
|
|
2155 | =item $counter = IO::AIO::st_gen |
|
|
2156 | |
|
|
2157 | Returns the generation counter (in practice this is just a random number) |
|
|
2158 | of the file. This is only available on platforms which have this member in |
|
|
2159 | their C<struct stat> (most BSDs at the time of this writing) and generally |
|
|
2160 | only to the root usert. If unsupported, C<0> is returned, but this might |
|
|
2161 | change to C<undef> in a future version. |
|
|
2162 | |
|
|
2163 | =back |
|
|
2164 | |
|
|
2165 | Example: print the high resolution modification time of F</etc>, using |
|
|
2166 | C<stat>, and C<IO::AIO::aio_stat>. |
|
|
2167 | |
|
|
2168 | if (stat "/etc") { |
|
|
2169 | printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime; |
|
|
2170 | } |
|
|
2171 | |
|
|
2172 | IO::AIO::aio_stat "/etc", sub { |
|
|
2173 | $_[0] |
|
|
2174 | and return; |
|
|
2175 | |
|
|
2176 | printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec; |
|
|
2177 | }; |
|
|
2178 | |
|
|
2179 | IO::AIO::flush; |
|
|
2180 | |
|
|
2181 | Output of the awbove on my system, showing reduced and full accuracy: |
|
|
2182 | |
|
|
2183 | stat(/etc) mtime: 1534043702.020808 |
|
|
2184 | aio_stat(/etc) mtime: 1534043702.020807792 |
|
|
2185 | |
|
|
2186 | |
1984 | =head3 MISCELLANEOUS FUNCTIONS |
2187 | =head3 MISCELLANEOUS FUNCTIONS |
1985 | |
2188 | |
1986 | IO::AIO implements some functions that might be useful, but are not |
2189 | IO::AIO implements some functions that are useful when you want to use |
1987 | asynchronous. |
2190 | some "Advanced I/O" function not available to in Perl, without going the |
|
|
2191 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
|
|
2192 | counterpart. |
1988 | |
2193 | |
1989 | =over 4 |
2194 | =over 4 |
|
|
2195 | |
|
|
2196 | =item $numfd = IO::AIO::get_fdlimit |
|
|
2197 | |
|
|
2198 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2199 | |
|
|
2200 | Tries to find the current file descriptor limit and returns it, or |
|
|
2201 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
|
|
2202 | the highest valid file descriptor number. |
|
|
2203 | |
|
|
2204 | =item IO::AIO::min_fdlimit [$numfd] |
|
|
2205 | |
|
|
2206 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2207 | |
|
|
2208 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
|
|
2209 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
|
|
2210 | is missing, it will try to set a very high limit, although this is not |
|
|
2211 | recommended when you know the actual minimum that you require. |
|
|
2212 | |
|
|
2213 | If the limit cannot be raised enough, the function makes a best-effort |
|
|
2214 | attempt to increase the limit as much as possible, using various |
|
|
2215 | tricks, while still failing. You can query the resulting limit using |
|
|
2216 | C<IO::AIO::get_fdlimit>. |
|
|
2217 | |
|
|
2218 | If an error occurs, returns C<undef> and sets C<$!>, otherwise returns |
|
|
2219 | true. |
1990 | |
2220 | |
1991 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2221 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
1992 | |
2222 | |
1993 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
2223 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
1994 | but is blocking (this makes most sense if you know the input data is |
2224 | but is blocking (this makes most sense if you know the input data is |
… | |
… | |
2011 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2241 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2012 | |
2242 | |
2013 | Simply calls the C<posix_madvise> function (see its |
2243 | Simply calls the C<posix_madvise> function (see its |
2014 | manpage for details). The following advice constants are |
2244 | manpage for details). The following advice constants are |
2015 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2245 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2016 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. |
2246 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, |
|
|
2247 | C<IO::AIO::MADV_DONTNEED>. |
|
|
2248 | |
|
|
2249 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2250 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2251 | will be reduced to fit into the C<$scalar>. |
2017 | |
2252 | |
2018 | On systems that do not implement C<posix_madvise>, this function returns |
2253 | On systems that do not implement C<posix_madvise>, this function returns |
2019 | ENOSYS, otherwise the return value of C<posix_madvise>. |
2254 | ENOSYS, otherwise the return value of C<posix_madvise>. |
2020 | |
2255 | |
2021 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
2256 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
… | |
… | |
2023 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
2258 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
2024 | $scalar (see its manpage for details). The following protect |
2259 | $scalar (see its manpage for details). The following protect |
2025 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
2260 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
2026 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
2261 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
2027 | |
2262 | |
|
|
2263 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2264 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2265 | will be reduced to fit into the C<$scalar>. |
|
|
2266 | |
2028 | On systems that do not implement C<mprotect>, this function returns |
2267 | On systems that do not implement C<mprotect>, this function returns |
2029 | ENOSYS, otherwise the return value of C<mprotect>. |
2268 | ENOSYS, otherwise the return value of C<mprotect>. |
2030 | |
2269 | |
2031 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
2270 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
2032 | |
2271 | |
2033 | Memory-maps a file (or anonymous memory range) and attaches it to the |
2272 | Memory-maps a file (or anonymous memory range) and attaches it to the |
2034 | given C<$scalar>, which will act like a string scalar. Returns true on |
2273 | given C<$scalar>, which will act like a string scalar. Returns true on |
2035 | success, and false otherwise. |
2274 | success, and false otherwise. |
2036 | |
2275 | |
|
|
2276 | The scalar must exist, but its contents do not matter - this means you |
|
|
2277 | cannot use a nonexistant array or hash element. When in doubt, C<undef> |
|
|
2278 | the scalar first. |
|
|
2279 | |
2037 | The only operations allowed on the scalar are C<substr>/C<vec> that don't |
2280 | The only operations allowed on the mmapped scalar are C<substr>/C<vec>, |
2038 | change the string length, and most read-only operations such as copying it |
2281 | which don't change the string length, and most read-only operations such |
2039 | or searching it with regexes and so on. |
2282 | as copying it or searching it with regexes and so on. |
2040 | |
2283 | |
2041 | Anything else is unsafe and will, at best, result in memory leaks. |
2284 | Anything else is unsafe and will, at best, result in memory leaks. |
2042 | |
2285 | |
2043 | The memory map associated with the C<$scalar> is automatically removed |
2286 | The memory map associated with the C<$scalar> is automatically removed |
2044 | when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or |
2287 | when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap> |
2045 | C<IO::AIO::munmap> functions are called. |
2288 | or C<IO::AIO::munmap> functions are called on it. |
2046 | |
2289 | |
2047 | This calls the C<mmap>(2) function internally. See your system's manual |
2290 | This calls the C<mmap>(2) function internally. See your system's manual |
2048 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
2291 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
2049 | |
2292 | |
2050 | The C<$length> must be larger than zero and smaller than the actual |
2293 | The C<$length> must be larger than zero and smaller than the actual |
2051 | filesize. |
2294 | filesize. |
2052 | |
2295 | |
2053 | C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, |
2296 | C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, |
2054 | C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, |
2297 | C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, |
2055 | |
2298 | |
2056 | C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or |
2299 | C<$flags> can be a combination of |
2057 | C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when |
2300 | C<IO::AIO::MAP_SHARED> or |
2058 | not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS> |
2301 | C<IO::AIO::MAP_PRIVATE>, |
|
|
2302 | or a number of system-specific flags (when not available, the are C<0>): |
2059 | (which is set to C<MAP_ANON> if your system only provides this |
2303 | C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant), |
2060 | constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>, |
2304 | C<IO::AIO::MAP_LOCKED>, |
2061 | C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or |
2305 | C<IO::AIO::MAP_NORESERVE>, |
|
|
2306 | C<IO::AIO::MAP_POPULATE>, |
2062 | C<IO::AIO::MAP_NONBLOCK> |
2307 | C<IO::AIO::MAP_NONBLOCK>, |
|
|
2308 | C<IO::AIO::MAP_FIXED>, |
|
|
2309 | C<IO::AIO::MAP_GROWSDOWN>, |
|
|
2310 | C<IO::AIO::MAP_32BIT>, |
|
|
2311 | C<IO::AIO::MAP_HUGETLB> or |
|
|
2312 | C<IO::AIO::MAP_STACK>. |
2063 | |
2313 | |
2064 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
2314 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
2065 | |
2315 | |
2066 | C<$offset> is the offset from the start of the file - it generally must be |
2316 | C<$offset> is the offset from the start of the file - it generally must be |
2067 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
2317 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
… | |
… | |
2080 | my $fast_md5 = md5 $data; |
2330 | my $fast_md5 = md5 $data; |
2081 | |
2331 | |
2082 | =item IO::AIO::munmap $scalar |
2332 | =item IO::AIO::munmap $scalar |
2083 | |
2333 | |
2084 | Removes a previous mmap and undefines the C<$scalar>. |
2334 | Removes a previous mmap and undefines the C<$scalar>. |
|
|
2335 | |
|
|
2336 | =item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0] |
|
|
2337 | |
|
|
2338 | Calls the Linux-specific mremap(2) system call. The C<$scalar> must have |
|
|
2339 | been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be |
|
|
2340 | C<0> or C<IO::AIO::MREMAP_MAYMOVE>. |
|
|
2341 | |
|
|
2342 | Returns true if successful, and false otherwise. If the underlying mmapped |
|
|
2343 | region has changed address, then the true value has the numerical value |
|
|
2344 | C<1>, otherwise it has the numerical value C<0>: |
|
|
2345 | |
|
|
2346 | my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE |
|
|
2347 | or die "mremap: $!"; |
|
|
2348 | |
|
|
2349 | if ($success*1) { |
|
|
2350 | warn "scalar has chanegd address in memory\n"; |
|
|
2351 | } |
|
|
2352 | |
|
|
2353 | C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently |
|
|
2354 | implemented, but not supported and might go away in a future version. |
|
|
2355 | |
|
|
2356 | On systems where this call is not supported or is not emulated, this call |
|
|
2357 | returns falls and sets C<$!> to C<ENOSYS>. |
|
|
2358 | |
|
|
2359 | =item IO::AIO::mlockall $flags |
|
|
2360 | |
|
|
2361 | Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>, |
|
|
2362 | but is blocking. |
2085 | |
2363 | |
2086 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2364 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2087 | |
2365 | |
2088 | Calls the C<munlock> function, undoing the effects of a previous |
2366 | Calls the C<munlock> function, undoing the effects of a previous |
2089 | C<aio_mlock> call (see its description for details). |
2367 | C<aio_mlock> call (see its description for details). |
… | |
… | |
2110 | |
2388 | |
2111 | See the C<splice(2)> manpage for details. |
2389 | See the C<splice(2)> manpage for details. |
2112 | |
2390 | |
2113 | =item IO::AIO::tee $r_fh, $w_fh, $length, $flags |
2391 | =item IO::AIO::tee $r_fh, $w_fh, $length, $flags |
2114 | |
2392 | |
2115 | Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the |
2393 | Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the |
2116 | description for C<IO::AIO::splice> above for details. |
2394 | description for C<IO::AIO::splice> above for details. |
2117 | |
2395 | |
2118 | =item $actual_size = IO::AIO::pipesize $r_fh[, $new_size] |
2396 | =item $actual_size = IO::AIO::pipesize $r_fh[, $new_size] |
2119 | |
2397 | |
2120 | Attempts to query or change the pipe buffer size. Obviously works only |
2398 | Attempts to query or change the pipe buffer size. Obviously works only |
2121 | on pipes, and currently works only on GNU/Linux systems, and fails with |
2399 | on pipes, and currently works only on GNU/Linux systems, and fails with |
2122 | C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer |
2400 | C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer |
2123 | size on other systems, drop me a note. |
2401 | size on other systems, drop me a note. |
|
|
2402 | |
|
|
2403 | =item ($rfh, $wfh) = IO::AIO::pipe2 [$flags] |
|
|
2404 | |
|
|
2405 | This is a direct interface to the Linux L<pipe2(2)> system call. If |
|
|
2406 | C<$flags> is missing or C<0>, then this should be the same as a call to |
|
|
2407 | perl's built-in C<pipe> function and create a new pipe, and works on |
|
|
2408 | systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe |
|
|
2409 | (..., 4096, O_BINARY)>. |
|
|
2410 | |
|
|
2411 | If C<$flags> is non-zero, it tries to invoke the pipe2 system call with |
|
|
2412 | the given flags (Linux 2.6.27, glibc 2.9). |
|
|
2413 | |
|
|
2414 | On success, the read and write file handles are returned. |
|
|
2415 | |
|
|
2416 | On error, nothing will be returned. If the pipe2 syscall is missing and |
|
|
2417 | C<$flags> is non-zero, fails with C<ENOSYS>. |
|
|
2418 | |
|
|
2419 | Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the |
|
|
2420 | time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and |
|
|
2421 | C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. |
|
|
2422 | |
|
|
2423 | Example: create a pipe race-free w.r.t. threads and fork: |
|
|
2424 | |
|
|
2425 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
|
|
2426 | or die "pipe2: $!\n"; |
|
|
2427 | |
|
|
2428 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
|
|
2429 | |
|
|
2430 | This is a direct interface to the Linux L<eventfd(2)> system call. The |
|
|
2431 | (unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both. |
|
|
2432 | |
|
|
2433 | On success, the new eventfd filehandle is returned, otherwise returns |
|
|
2434 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
|
|
2435 | |
|
|
2436 | Please refer to L<eventfd(2)> for more info on this call. |
|
|
2437 | |
|
|
2438 | The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, |
|
|
2439 | C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). |
|
|
2440 | |
|
|
2441 | Example: create a new eventfd filehandle: |
|
|
2442 | |
|
|
2443 | $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC |
|
|
2444 | or die "eventfd: $!\n"; |
|
|
2445 | |
|
|
2446 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
|
|
2447 | |
|
|
2448 | This is a direct interface to the Linux L<timerfd_create(2)> system call. The |
|
|
2449 | (unhelpful) default for C<$flags> is C<0>. |
|
|
2450 | |
|
|
2451 | On success, the new timerfd filehandle is returned, otherwise returns |
|
|
2452 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
|
|
2453 | |
|
|
2454 | Please refer to L<timerfd_create(2)> for more info on this call. |
|
|
2455 | |
|
|
2456 | The following C<$clockid> values are |
|
|
2457 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |
|
|
2458 | C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15) |
|
|
2459 | C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and |
|
|
2460 | C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11). |
|
|
2461 | |
|
|
2462 | The following C<$flags> values are available (Linux |
|
|
2463 | 2.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>. |
|
|
2464 | |
|
|
2465 | Example: create a new timerfd and set it to one-second repeated alarms, |
|
|
2466 | then wait for two alarms: |
|
|
2467 | |
|
|
2468 | my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC |
|
|
2469 | or die "timerfd_create: $!\n"; |
|
|
2470 | |
|
|
2471 | defined IO::AIO::timerfd_settime $fh, 0, 1, 1 |
|
|
2472 | or die "timerfd_settime: $!\n"; |
|
|
2473 | |
|
|
2474 | for (1..2) { |
|
|
2475 | 8 == sysread $fh, my $buf, 8 |
|
|
2476 | or die "timerfd read failure\n"; |
|
|
2477 | |
|
|
2478 | printf "number of expirations (likely 1): %d\n", |
|
|
2479 | unpack "Q", $buf; |
|
|
2480 | } |
|
|
2481 | |
|
|
2482 | =item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value |
|
|
2483 | |
|
|
2484 | This is a direct interface to the Linux L<timerfd_settime(2)> system |
|
|
2485 | call. Please refer to its manpage for more info on this call. |
|
|
2486 | |
|
|
2487 | The new itimerspec is specified using two (possibly fractional) second |
|
|
2488 | values, C<$new_interval> and C<$new_value>). |
|
|
2489 | |
|
|
2490 | On success, the current interval and value are returned (as per |
|
|
2491 | C<timerfd_gettime>). On failure, the empty list is returned. |
|
|
2492 | |
|
|
2493 | The following C<$flags> values are |
|
|
2494 | available: C<IO::AIO::TFD_TIMER_ABSTIME> and |
|
|
2495 | C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>. |
|
|
2496 | |
|
|
2497 | See C<IO::AIO::timerfd_create> for a full example. |
|
|
2498 | |
|
|
2499 | =item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh |
|
|
2500 | |
|
|
2501 | This is a direct interface to the Linux L<timerfd_gettime(2)> system |
|
|
2502 | call. Please refer to its manpage for more info on this call. |
|
|
2503 | |
|
|
2504 | On success, returns the current values of interval and value for the given |
|
|
2505 | timerfd (as potentially fractional second values). On failure, the empty |
|
|
2506 | list is returned. |
2124 | |
2507 | |
2125 | =back |
2508 | =back |
2126 | |
2509 | |
2127 | =cut |
2510 | =cut |
2128 | |
2511 | |
… | |
… | |
2194 | the process will result in undefined behaviour. Calling it at any time |
2577 | the process will result in undefined behaviour. Calling it at any time |
2195 | will also result in any undefined (by POSIX) behaviour. |
2578 | will also result in any undefined (by POSIX) behaviour. |
2196 | |
2579 | |
2197 | =back |
2580 | =back |
2198 | |
2581 | |
|
|
2582 | =head2 LINUX-SPECIFIC CALLS |
|
|
2583 | |
|
|
2584 | When a call is documented as "linux-specific" then this means it |
|
|
2585 | originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the |
|
|
2586 | availability and compatibility of such calls regardless of the platform |
|
|
2587 | it is compiled on, so platforms such as FreeBSD which often implement |
|
|
2588 | these calls will work. When in doubt, call them and see if they fail wth |
|
|
2589 | C<ENOSYS>. |
|
|
2590 | |
2199 | =head2 MEMORY USAGE |
2591 | =head2 MEMORY USAGE |
2200 | |
2592 | |
2201 | Per-request usage: |
2593 | Per-request usage: |
2202 | |
2594 | |
2203 | Each aio request uses - depending on your architecture - around 100-200 |
2595 | Each aio request uses - depending on your architecture - around 100-200 |
… | |
… | |
2215 | temporary buffers, and each thread requires a stack and other data |
2607 | temporary buffers, and each thread requires a stack and other data |
2216 | structures (usually around 16k-128k, depending on the OS). |
2608 | structures (usually around 16k-128k, depending on the OS). |
2217 | |
2609 | |
2218 | =head1 KNOWN BUGS |
2610 | =head1 KNOWN BUGS |
2219 | |
2611 | |
2220 | Known bugs will be fixed in the next release. |
2612 | Known bugs will be fixed in the next release :) |
|
|
2613 | |
|
|
2614 | =head1 KNOWN ISSUES |
|
|
2615 | |
|
|
2616 | Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap> |
|
|
2617 | or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as |
|
|
2618 | non-created hash slots or other scalars I didn't think of. It's best to |
|
|
2619 | avoid such and either use scalar variables or making sure that the scalar |
|
|
2620 | exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied). |
|
|
2621 | |
|
|
2622 | I am not sure anything can be done about this, so this is considered a |
|
|
2623 | known issue, rather than a bug. |
2221 | |
2624 | |
2222 | =head1 SEE ALSO |
2625 | =head1 SEE ALSO |
2223 | |
2626 | |
2224 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2627 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2225 | more natural syntax. |
2628 | more natural syntax. |