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 | |
68 | =head2 EXAMPLE |
72 | =head2 EXAMPLE |
69 | |
73 | |
70 | This is a simple example that uses the EV module and loads |
74 | This is a simple example that uses the EV module and loads |
71 | F</etc/passwd> asynchronously: |
75 | F</etc/passwd> asynchronously: |
72 | |
76 | |
73 | use Fcntl; |
|
|
74 | use EV; |
77 | use EV; |
75 | use IO::AIO; |
78 | use IO::AIO; |
76 | |
79 | |
77 | # register the IO::AIO callback with EV |
80 | # register the IO::AIO callback with EV |
78 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
81 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
… | |
… | |
95 | |
98 | |
96 | # file contents now in $contents |
99 | # file contents now in $contents |
97 | print $contents; |
100 | print $contents; |
98 | |
101 | |
99 | # exit event loop and program |
102 | # exit event loop and program |
100 | EV::unloop; |
103 | EV::break; |
101 | }; |
104 | }; |
102 | }; |
105 | }; |
103 | |
106 | |
104 | # possibly queue up other requests, or open GUI windows, |
107 | # possibly queue up other requests, or open GUI windows, |
105 | # check for sockets etc. etc. |
108 | # check for sockets etc. etc. |
106 | |
109 | |
107 | # process events as long as there are some: |
110 | # process events as long as there are some: |
108 | EV::loop; |
111 | EV::run; |
109 | |
112 | |
110 | =head1 REQUEST ANATOMY AND LIFETIME |
113 | =head1 REQUEST ANATOMY AND LIFETIME |
111 | |
114 | |
112 | 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 |
113 | directly visible to Perl. |
116 | directly visible to Perl. |
… | |
… | |
168 | use common::sense; |
171 | use common::sense; |
169 | |
172 | |
170 | use base 'Exporter'; |
173 | use base 'Exporter'; |
171 | |
174 | |
172 | BEGIN { |
175 | BEGIN { |
173 | our $VERSION = '4.19'; |
176 | our $VERSION = 4.35; |
174 | |
177 | |
175 | 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 |
176 | 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 |
177 | aio_scandir aio_symlink aio_readlink aio_realpath aio_sync |
180 | aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl |
178 | 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 |
179 | aio_pathsync aio_readahead aio_fiemap |
182 | aio_pathsync aio_readahead aio_fiemap aio_allocate |
180 | aio_rename aio_link aio_move aio_copy aio_group |
183 | aio_rename aio_rename2 aio_link aio_move aio_copy aio_group |
181 | 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 |
182 | aio_chmod aio_utime aio_truncate |
185 | aio_chmod aio_utime aio_truncate |
183 | aio_msync aio_mtouch aio_mlock aio_mlockall |
186 | aio_msync aio_mtouch aio_mlock aio_mlockall |
184 | aio_statvfs |
187 | aio_statvfs |
185 | aio_wd); |
188 | aio_wd); |
… | |
… | |
228 | aio_unlink $pathname, $callback->($status) |
231 | aio_unlink $pathname, $callback->($status) |
229 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
232 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
230 | aio_link $srcpath, $dstpath, $callback->($status) |
233 | aio_link $srcpath, $dstpath, $callback->($status) |
231 | aio_symlink $srcpath, $dstpath, $callback->($status) |
234 | aio_symlink $srcpath, $dstpath, $callback->($status) |
232 | aio_readlink $pathname, $callback->($link) |
235 | aio_readlink $pathname, $callback->($link) |
233 | aio_realpath $pathname, $callback->($link) |
236 | aio_realpath $pathname, $callback->($path) |
234 | aio_rename $srcpath, $dstpath, $callback->($status) |
237 | aio_rename $srcpath, $dstpath, $callback->($status) |
|
|
238 | aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
235 | aio_mkdir $pathname, $mode, $callback->($status) |
239 | aio_mkdir $pathname, $mode, $callback->($status) |
236 | aio_rmdir $pathname, $callback->($status) |
240 | aio_rmdir $pathname, $callback->($status) |
237 | aio_readdir $pathname, $callback->($entries) |
241 | aio_readdir $pathname, $callback->($entries) |
238 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
242 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
239 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
243 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
… | |
… | |
241 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
245 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
242 | aio_load $pathname, $data, $callback->($status) |
246 | aio_load $pathname, $data, $callback->($status) |
243 | aio_copy $srcpath, $dstpath, $callback->($status) |
247 | aio_copy $srcpath, $dstpath, $callback->($status) |
244 | aio_move $srcpath, $dstpath, $callback->($status) |
248 | aio_move $srcpath, $dstpath, $callback->($status) |
245 | aio_rmtree $pathname, $callback->($status) |
249 | aio_rmtree $pathname, $callback->($status) |
|
|
250 | aio_fcntl $fh, $cmd, $arg, $callback->($status) |
|
|
251 | aio_ioctl $fh, $request, $buf, $callback->($status) |
246 | aio_sync $callback->($status) |
252 | aio_sync $callback->($status) |
247 | aio_syncfs $fh, $callback->($status) |
253 | aio_syncfs $fh, $callback->($status) |
248 | aio_fsync $fh, $callback->($status) |
254 | aio_fsync $fh, $callback->($status) |
249 | aio_fdatasync $fh, $callback->($status) |
255 | aio_fdatasync $fh, $callback->($status) |
250 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
256 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
251 | aio_pathsync $pathname, $callback->($status) |
257 | aio_pathsync $pathname, $callback->($status) |
252 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
258 | aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
253 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
259 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
254 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
260 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
255 | aio_mlockall $flags, $callback->($status) |
261 | aio_mlockall $flags, $callback->($status) |
256 | aio_group $callback->(...) |
262 | aio_group $callback->(...) |
257 | aio_nop $callback->() |
263 | aio_nop $callback->() |
… | |
… | |
271 | IO::AIO::idle_timeout $seconds |
277 | IO::AIO::idle_timeout $seconds |
272 | IO::AIO::max_outstanding $maxreqs |
278 | IO::AIO::max_outstanding $maxreqs |
273 | IO::AIO::nreqs |
279 | IO::AIO::nreqs |
274 | IO::AIO::nready |
280 | IO::AIO::nready |
275 | IO::AIO::npending |
281 | IO::AIO::npending |
|
|
282 | IO::AIO::min_fdlimit $nfd; |
276 | |
283 | |
277 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
284 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
278 | IO::AIO::fadvise $fh, $offset, $len, $advice |
285 | IO::AIO::fadvise $fh, $offset, $len, $advice |
279 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
286 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
280 | IO::AIO::munmap $scalar |
287 | IO::AIO::munmap $scalar |
… | |
… | |
395 | following POSIX and non-POSIX constants are available (missing ones on |
402 | following POSIX and non-POSIX constants are available (missing ones on |
396 | your system are, as usual, C<0>): |
403 | your system are, as usual, C<0>): |
397 | |
404 | |
398 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
405 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
399 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
406 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
400 | C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>. |
407 | C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>. |
401 | |
408 | |
402 | |
409 | |
403 | =item aio_close $fh, $callback->($status) |
410 | =item aio_close $fh, $callback->($status) |
404 | |
411 | |
405 | Asynchronously close a file and call the callback with the result |
412 | Asynchronously close a file and call the callback with the result |
… | |
… | |
440 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
447 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
441 | |
448 | |
442 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
449 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
443 | |
450 | |
444 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
451 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
445 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> |
452 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and |
446 | and calls the callback without the actual number of bytes read (or -1 on |
453 | calls the callback with the actual number of bytes transferred (or -1 on |
447 | error, just like the syscall). |
454 | error, just like the syscall). |
448 | |
455 | |
449 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
456 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
450 | offset plus the actual number of bytes read. |
457 | offset plus the actual number of bytes read. |
451 | |
458 | |
… | |
… | |
509 | As native sendfile syscalls (as practically any non-POSIX interface hacked |
516 | As native sendfile syscalls (as practically any non-POSIX interface hacked |
510 | together in a hurry to improve benchmark numbers) tend to be rather buggy |
517 | together in a hurry to improve benchmark numbers) tend to be rather buggy |
511 | on many systems, this implementation tries to work around some known bugs |
518 | on many systems, this implementation tries to work around some known bugs |
512 | in Linux and FreeBSD kernels (probably others, too), but that might fail, |
519 | in Linux and FreeBSD kernels (probably others, too), but that might fail, |
513 | so you really really should check the return value of C<aio_sendfile> - |
520 | so you really really should check the return value of C<aio_sendfile> - |
514 | fewre bytes than expected might have been transferred. |
521 | fewer bytes than expected might have been transferred. |
515 | |
522 | |
516 | |
523 | |
517 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
524 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
518 | |
525 | |
519 | C<aio_readahead> populates the page cache with data from a file so that |
526 | C<aio_readahead> populates the page cache with data from a file so that |
… | |
… | |
523 | whole pages, so that offset is effectively rounded down to a page boundary |
530 | whole pages, so that offset is effectively rounded down to a page boundary |
524 | and bytes are read up to the next page boundary greater than or equal to |
531 | and bytes are read up to the next page boundary greater than or equal to |
525 | (off-set+length). C<aio_readahead> does not read beyond the end of the |
532 | (off-set+length). C<aio_readahead> does not read beyond the end of the |
526 | file. The current file offset of the file is left unchanged. |
533 | file. The current file offset of the file is left unchanged. |
527 | |
534 | |
528 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
535 | If that syscall doesn't exist (likely if your kernel isn't Linux) it will |
529 | emulated by simply reading the data, which would have a similar effect. |
536 | be emulated by simply reading the data, which would have a similar effect. |
530 | |
537 | |
531 | |
538 | |
532 | =item aio_stat $fh_or_path, $callback->($status) |
539 | =item aio_stat $fh_or_path, $callback->($status) |
533 | |
540 | |
534 | =item aio_lstat $fh, $callback->($status) |
541 | =item aio_lstat $fh, $callback->($status) |
… | |
… | |
603 | namemax => 255, |
610 | namemax => 255, |
604 | frsize => 1024, |
611 | frsize => 1024, |
605 | fsid => 1810 |
612 | fsid => 1810 |
606 | } |
613 | } |
607 | |
614 | |
608 | Here is a (likely partial) list of fsid values used by Linux - it is safe |
615 | Here is a (likely partial - send me updates!) list of fsid values used by |
609 | to hardcode these when the $^O is C<linux>: |
616 | Linux - it is safe to hardcode these when C<$^O> is C<linux>: |
610 | |
617 | |
611 | 0x0000adf5 adfs |
618 | 0x0000adf5 adfs |
612 | 0x0000adff affs |
619 | 0x0000adff affs |
613 | 0x5346414f afs |
620 | 0x5346414f afs |
614 | 0x09041934 anon-inode filesystem |
621 | 0x09041934 anon-inode filesystem |
… | |
… | |
627 | 0x00001373 devfs |
634 | 0x00001373 devfs |
628 | 0x00001cd1 devpts |
635 | 0x00001cd1 devpts |
629 | 0x0000f15f ecryptfs |
636 | 0x0000f15f ecryptfs |
630 | 0x00414a53 efs |
637 | 0x00414a53 efs |
631 | 0x0000137d ext |
638 | 0x0000137d ext |
632 | 0x0000ef53 ext2/ext3 |
639 | 0x0000ef53 ext2/ext3/ext4 |
633 | 0x0000ef51 ext2 |
640 | 0x0000ef51 ext2 |
|
|
641 | 0xf2f52010 f2fs |
634 | 0x00004006 fat |
642 | 0x00004006 fat |
635 | 0x65735546 fuseblk |
643 | 0x65735546 fuseblk |
636 | 0x65735543 fusectl |
644 | 0x65735543 fusectl |
637 | 0x0bad1dea futexfs |
645 | 0x0bad1dea futexfs |
638 | 0x01161970 gfs2 |
646 | 0x01161970 gfs2 |
639 | 0x47504653 gpfs |
647 | 0x47504653 gpfs |
640 | 0x00004244 hfs |
648 | 0x00004244 hfs |
641 | 0xf995e849 hpfs |
649 | 0xf995e849 hpfs |
|
|
650 | 0x00c0ffee hostfs |
642 | 0x958458f6 hugetlbfs |
651 | 0x958458f6 hugetlbfs |
643 | 0x2bad1dea inotifyfs |
652 | 0x2bad1dea inotifyfs |
644 | 0x00009660 isofs |
653 | 0x00009660 isofs |
645 | 0x000072b6 jffs2 |
654 | 0x000072b6 jffs2 |
646 | 0x3153464a jfs |
655 | 0x3153464a jfs |
… | |
… | |
661 | 0x00009fa1 openprom |
670 | 0x00009fa1 openprom |
662 | 0x7461636F ocfs2 |
671 | 0x7461636F ocfs2 |
663 | 0x00009fa0 proc |
672 | 0x00009fa0 proc |
664 | 0x6165676c pstorefs |
673 | 0x6165676c pstorefs |
665 | 0x0000002f qnx4 |
674 | 0x0000002f qnx4 |
|
|
675 | 0x68191122 qnx6 |
666 | 0x858458f6 ramfs |
676 | 0x858458f6 ramfs |
667 | 0x52654973 reiserfs |
677 | 0x52654973 reiserfs |
668 | 0x00007275 romfs |
678 | 0x00007275 romfs |
669 | 0x67596969 rpc_pipefs |
679 | 0x67596969 rpc_pipefs |
670 | 0x73636673 securityfs |
680 | 0x73636673 securityfs |
… | |
… | |
723 | Works like truncate(2) or ftruncate(2). |
733 | Works like truncate(2) or ftruncate(2). |
724 | |
734 | |
725 | |
735 | |
726 | =item aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
736 | =item aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
727 | |
737 | |
728 | Allocates or freed disk space according to the C<$mode> argument. See the |
738 | Allocates or frees disk space according to the C<$mode> argument. See the |
729 | linux C<fallocate> docuemntation for details. |
739 | linux C<fallocate> documentation for details. |
730 | |
740 | |
731 | C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> |
741 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
732 | to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | |
742 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
733 | IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range. |
743 | to deallocate a file range. |
|
|
744 | |
|
|
745 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
|
|
746 | (without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range, |
|
|
747 | C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE> |
|
|
748 | to unshare shared blocks (see your L<fallocate(2)> manpage). |
734 | |
749 | |
735 | The file system block size used by C<fallocate> is presumably the |
750 | The file system block size used by C<fallocate> is presumably the |
736 | C<f_bsize> returned by C<statvfs>. |
751 | C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes |
|
|
752 | can dictate other limitations. |
737 | |
753 | |
738 | If C<fallocate> isn't available or cannot be emulated (currently no |
754 | If C<fallocate> isn't available or cannot be emulated (currently no |
739 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
755 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
740 | |
756 | |
741 | |
757 | |
… | |
… | |
798 | rename(2) and call the callback with the result code. |
814 | rename(2) and call the callback with the result code. |
799 | |
815 | |
800 | On systems that support the AIO::WD working directory abstraction |
816 | On systems that support the AIO::WD working directory abstraction |
801 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
817 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
802 | of failing, C<rename> is called on the absolute path of C<$wd>. |
818 | of failing, C<rename> is called on the absolute path of C<$wd>. |
|
|
819 | |
|
|
820 | |
|
|
821 | =item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
|
|
822 | |
|
|
823 | Basically a version of C<aio_rename> with an additional C<$flags> |
|
|
824 | argument. Calling this with C<$flags=0> is the same as calling |
|
|
825 | C<aio_rename>. |
|
|
826 | |
|
|
827 | Non-zero flags are currently only supported on GNU/Linux systems that |
|
|
828 | support renameat2. Other systems fail with C<ENOSYS> in this case. |
|
|
829 | |
|
|
830 | The following constants are available (missing ones are, as usual C<0>), |
|
|
831 | see renameat2(2) for details: |
|
|
832 | |
|
|
833 | C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE> |
|
|
834 | and C<IO::AIO::RENAME_WHITEOUT>. |
803 | |
835 | |
804 | |
836 | |
805 | =item aio_mkdir $pathname, $mode, $callback->($status) |
837 | =item aio_mkdir $pathname, $mode, $callback->($status) |
806 | |
838 | |
807 | Asynchronously mkdir (create) a directory and call the callback with |
839 | Asynchronously mkdir (create) a directory and call the callback with |
… | |
… | |
926 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
958 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
927 | |
959 | |
928 | Try to copy the I<file> (directories not supported as either source or |
960 | Try to copy the I<file> (directories not supported as either source or |
929 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
961 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
930 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
962 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
|
|
963 | |
|
|
964 | Existing destination files will be truncated. |
931 | |
965 | |
932 | This is a composite request that creates the destination file with |
966 | This is a composite request that creates the destination file with |
933 | mode 0200 and copies the contents of the source file into it using |
967 | mode 0200 and copies the contents of the source file into it using |
934 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
968 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
935 | uid/gid, in that order. |
969 | uid/gid, in that order. |
… | |
… | |
1221 | }; |
1255 | }; |
1222 | |
1256 | |
1223 | $grp |
1257 | $grp |
1224 | } |
1258 | } |
1225 | |
1259 | |
|
|
1260 | =item aio_fcntl $fh, $cmd, $arg, $callback->($status) |
|
|
1261 | |
|
|
1262 | =item aio_ioctl $fh, $request, $buf, $callback->($status) |
|
|
1263 | |
|
|
1264 | These work just like the C<fcntl> and C<ioctl> built-in functions, except |
|
|
1265 | they execute asynchronously and pass the return value to the callback. |
|
|
1266 | |
|
|
1267 | Both calls can be used for a lot of things, some of which make more sense |
|
|
1268 | to run asynchronously in their own thread, while some others make less |
|
|
1269 | sense. For example, calls that block waiting for external events, such |
|
|
1270 | as locking, will also lock down an I/O thread while it is waiting, which |
|
|
1271 | can deadlock the whole I/O system. At the same time, there might be no |
|
|
1272 | alternative to using a thread to wait. |
|
|
1273 | |
|
|
1274 | So in general, you should only use these calls for things that do |
|
|
1275 | (filesystem) I/O, not for things that wait for other events (network, |
|
|
1276 | other processes), although if you are careful and know what you are doing, |
|
|
1277 | you still can. |
|
|
1278 | |
|
|
1279 | The following constants are available (missing ones are, as usual C<0>): |
|
|
1280 | |
|
|
1281 | C<F_DUPFD_CLOEXEC>, |
|
|
1282 | |
|
|
1283 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
|
|
1284 | |
|
|
1285 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
|
|
1286 | |
|
|
1287 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
|
|
1288 | C<FS_IOC_FIEMAP>. |
|
|
1289 | |
|
|
1290 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
|
|
1291 | C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>. |
|
|
1292 | |
|
|
1293 | C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>, |
|
|
1294 | C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>, |
|
|
1295 | C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>, |
|
|
1296 | C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>, |
|
|
1297 | C<FS_FL_USER_MODIFIABLE>. |
|
|
1298 | |
|
|
1299 | C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>, |
|
|
1300 | C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>, |
|
|
1301 | C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>, |
|
|
1302 | C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>, |
|
|
1303 | |
1226 | =item aio_sync $callback->($status) |
1304 | =item aio_sync $callback->($status) |
1227 | |
1305 | |
1228 | Asynchronously call sync and call the callback when finished. |
1306 | Asynchronously call sync and call the callback when finished. |
1229 | |
1307 | |
1230 | =item aio_fsync $fh, $callback->($status) |
1308 | =item aio_fsync $fh, $callback->($status) |
… | |
… | |
1298 | }; |
1376 | }; |
1299 | |
1377 | |
1300 | $grp |
1378 | $grp |
1301 | } |
1379 | } |
1302 | |
1380 | |
1303 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1381 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
1304 | |
1382 | |
1305 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
1383 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
1306 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
1384 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
1307 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
1385 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
1308 | scalar must only be modified in-place while an aio operation is pending on |
1386 | scalar must only be modified in-place while an aio operation is pending on |
… | |
… | |
1310 | |
1388 | |
1311 | It calls the C<msync> function of your OS, if available, with the memory |
1389 | It calls the C<msync> function of your OS, if available, with the memory |
1312 | area starting at C<$offset> in the string and ending C<$length> bytes |
1390 | area starting at C<$offset> in the string and ending C<$length> bytes |
1313 | later. If C<$length> is negative, counts from the end, and if C<$length> |
1391 | later. If C<$length> is negative, counts from the end, and if C<$length> |
1314 | is C<undef>, then it goes till the end of the string. The flags can be |
1392 | is C<undef>, then it goes till the end of the string. The flags can be |
1315 | a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and |
1393 | either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional |
1316 | C<IO::AIO::MS_SYNC>. |
1394 | C<IO::AIO::MS_INVALIDATE>. |
1317 | |
1395 | |
1318 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1396 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1319 | |
1397 | |
1320 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1398 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1321 | scalars. |
1399 | scalars. |
… | |
… | |
1501 | aio_stat [$etcdir, "passwd"], sub { |
1579 | aio_stat [$etcdir, "passwd"], sub { |
1502 | # yay |
1580 | # yay |
1503 | }; |
1581 | }; |
1504 | }; |
1582 | }; |
1505 | |
1583 | |
1506 | That C<aio_wd> is a request and not a normal function shows that creating |
1584 | The fact that C<aio_wd> is a request and not a normal function shows that |
1507 | an IO::AIO::WD object is itself a potentially blocking operation, which is |
1585 | creating an IO::AIO::WD object is itself a potentially blocking operation, |
1508 | why it is done asynchronously. |
1586 | which is why it is done asynchronously. |
1509 | |
1587 | |
1510 | To stat the directory obtained with C<aio_wd> above, one could write |
1588 | To stat the directory obtained with C<aio_wd> above, one could write |
1511 | either of the following three request calls: |
1589 | either of the following three request calls: |
1512 | |
1590 | |
1513 | aio_lstat "/etc" , sub { ... # pathname as normal string |
1591 | aio_lstat "/etc" , sub { ... # pathname as normal string |
… | |
… | |
1556 | passing C<undef> as working directory component of a pathname fails the |
1634 | passing C<undef> as working directory component of a pathname fails the |
1557 | request with C<ENOENT>, there is often no need for error checking in the |
1635 | request with C<ENOENT>, there is often no need for error checking in the |
1558 | C<aio_wd> callback, as future requests using the value will fail in the |
1636 | C<aio_wd> callback, as future requests using the value will fail in the |
1559 | expected way. |
1637 | expected way. |
1560 | |
1638 | |
1561 | If this call isn't available because your OS lacks it or it couldn't be |
|
|
1562 | detected, it will be emulated by calling C<fsync> instead. |
|
|
1563 | |
|
|
1564 | =item IO::AIO::CWD |
1639 | =item IO::AIO::CWD |
1565 | |
1640 | |
1566 | This is a compiletime constant (object) that represents the process |
1641 | This is a compiletime constant (object) that represents the process |
1567 | current working directory. |
1642 | current working directory. |
1568 | |
1643 | |
… | |
… | |
1935 | |
2010 | |
1936 | This is a very bad function to use in interactive programs because it |
2011 | This is a very bad function to use in interactive programs because it |
1937 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
2012 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1938 | use an C<aio_group> together with a feed callback. |
2013 | use an C<aio_group> together with a feed callback. |
1939 | |
2014 | |
1940 | It's main use is in scripts without an event loop - when you want to stat |
2015 | Its main use is in scripts without an event loop - when you want to stat |
1941 | a lot of files, you can write somehting like this: |
2016 | a lot of files, you can write something like this: |
1942 | |
2017 | |
1943 | IO::AIO::max_outstanding 32; |
2018 | IO::AIO::max_outstanding 32; |
1944 | |
2019 | |
1945 | for my $path (...) { |
2020 | for my $path (...) { |
1946 | aio_stat $path , ...; |
2021 | aio_stat $path , ...; |
… | |
… | |
1985 | |
2060 | |
1986 | =back |
2061 | =back |
1987 | |
2062 | |
1988 | =head3 MISCELLANEOUS FUNCTIONS |
2063 | =head3 MISCELLANEOUS FUNCTIONS |
1989 | |
2064 | |
1990 | IO::AIO implements some functions that might be useful, but are not |
2065 | IO::AIO implements some functions that are useful when you want to use |
1991 | asynchronous. |
2066 | some "Advanced I/O" function not available to in Perl, without going the |
|
|
2067 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
|
|
2068 | counterpart. |
1992 | |
2069 | |
1993 | =over 4 |
2070 | =over 4 |
|
|
2071 | |
|
|
2072 | =item $numfd = IO::AIO::get_fdlimit |
|
|
2073 | |
|
|
2074 | Tries to find the current file descriptor limit and returns it, or |
|
|
2075 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
|
|
2076 | the highest valid file descriptor number. |
|
|
2077 | |
|
|
2078 | =item IO::AIO::min_fdlimit [$numfd] |
|
|
2079 | |
|
|
2080 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
|
|
2081 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
|
|
2082 | is missing, it will try to set a very high limit, although this is not |
|
|
2083 | recommended when you know the actual minimum that you require. |
|
|
2084 | |
|
|
2085 | If the limit cannot be raised enough, the function makes a best-effort |
|
|
2086 | attempt to increase the limit as much as possible, using various |
|
|
2087 | tricks, while still failing. You can query the resulting limit using |
|
|
2088 | C<IO::AIO::get_fdlimit>. |
|
|
2089 | |
|
|
2090 | If an error occurs, returns C<undef> and sets C<$!>. |
1994 | |
2091 | |
1995 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2092 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
1996 | |
2093 | |
1997 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
2094 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
1998 | but is blocking (this makes most sense if you know the input data is |
2095 | but is blocking (this makes most sense if you know the input data is |
… | |
… | |
2015 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2112 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2016 | |
2113 | |
2017 | Simply calls the C<posix_madvise> function (see its |
2114 | Simply calls the C<posix_madvise> function (see its |
2018 | manpage for details). The following advice constants are |
2115 | manpage for details). The following advice constants are |
2019 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2116 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2020 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. |
2117 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, |
|
|
2118 | C<IO::AIO::MADV_DONTNEED>. |
|
|
2119 | |
|
|
2120 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2121 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2122 | will be reduced to fit into the C<$scalar>. |
2021 | |
2123 | |
2022 | On systems that do not implement C<posix_madvise>, this function returns |
2124 | On systems that do not implement C<posix_madvise>, this function returns |
2023 | ENOSYS, otherwise the return value of C<posix_madvise>. |
2125 | ENOSYS, otherwise the return value of C<posix_madvise>. |
2024 | |
2126 | |
2025 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
2127 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
… | |
… | |
2027 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
2129 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
2028 | $scalar (see its manpage for details). The following protect |
2130 | $scalar (see its manpage for details). The following protect |
2029 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
2131 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
2030 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
2132 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
2031 | |
2133 | |
|
|
2134 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2135 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2136 | will be reduced to fit into the C<$scalar>. |
|
|
2137 | |
2032 | On systems that do not implement C<mprotect>, this function returns |
2138 | On systems that do not implement C<mprotect>, this function returns |
2033 | ENOSYS, otherwise the return value of C<mprotect>. |
2139 | ENOSYS, otherwise the return value of C<mprotect>. |
2034 | |
2140 | |
2035 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
2141 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
2036 | |
2142 | |
2037 | Memory-maps a file (or anonymous memory range) and attaches it to the |
2143 | Memory-maps a file (or anonymous memory range) and attaches it to the |
2038 | given C<$scalar>, which will act like a string scalar. Returns true on |
2144 | given C<$scalar>, which will act like a string scalar. Returns true on |
2039 | success, and false otherwise. |
2145 | success, and false otherwise. |
2040 | |
2146 | |
|
|
2147 | The scalar must exist, but its contents do not matter - this means you |
|
|
2148 | cannot use a nonexistant array or hash element. When in doubt, C<undef> |
|
|
2149 | the scalar first. |
|
|
2150 | |
2041 | The only operations allowed on the scalar are C<substr>/C<vec> that don't |
2151 | The only operations allowed on the mmapped scalar are C<substr>/C<vec>, |
2042 | change the string length, and most read-only operations such as copying it |
2152 | which don't change the string length, and most read-only operations such |
2043 | or searching it with regexes and so on. |
2153 | as copying it or searching it with regexes and so on. |
2044 | |
2154 | |
2045 | Anything else is unsafe and will, at best, result in memory leaks. |
2155 | Anything else is unsafe and will, at best, result in memory leaks. |
2046 | |
2156 | |
2047 | The memory map associated with the C<$scalar> is automatically removed |
2157 | The memory map associated with the C<$scalar> is automatically removed |
2048 | when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or |
2158 | when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap> |
2049 | C<IO::AIO::munmap> functions are called. |
2159 | or C<IO::AIO::munmap> functions are called on it. |
2050 | |
2160 | |
2051 | This calls the C<mmap>(2) function internally. See your system's manual |
2161 | This calls the C<mmap>(2) function internally. See your system's manual |
2052 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
2162 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
2053 | |
2163 | |
2054 | The C<$length> must be larger than zero and smaller than the actual |
2164 | The C<$length> must be larger than zero and smaller than the actual |
2055 | filesize. |
2165 | filesize. |
2056 | |
2166 | |
2057 | C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, |
2167 | C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, |
2058 | C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, |
2168 | C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, |
2059 | |
2169 | |
2060 | C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or |
2170 | C<$flags> can be a combination of |
2061 | C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when |
2171 | C<IO::AIO::MAP_SHARED> or |
2062 | not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS> |
2172 | C<IO::AIO::MAP_PRIVATE>, |
|
|
2173 | or a number of system-specific flags (when not available, the are C<0>): |
2063 | (which is set to C<MAP_ANON> if your system only provides this |
2174 | C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant), |
2064 | constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>, |
2175 | C<IO::AIO::MAP_LOCKED>, |
2065 | C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or |
2176 | C<IO::AIO::MAP_NORESERVE>, |
|
|
2177 | C<IO::AIO::MAP_POPULATE>, |
2066 | C<IO::AIO::MAP_NONBLOCK> |
2178 | C<IO::AIO::MAP_NONBLOCK>, |
|
|
2179 | C<IO::AIO::MAP_FIXED>, |
|
|
2180 | C<IO::AIO::MAP_GROWSDOWN>, |
|
|
2181 | C<IO::AIO::MAP_32BIT>, |
|
|
2182 | C<IO::AIO::MAP_HUGETLB> or |
|
|
2183 | C<IO::AIO::MAP_STACK>. |
2067 | |
2184 | |
2068 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
2185 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
2069 | |
2186 | |
2070 | C<$offset> is the offset from the start of the file - it generally must be |
2187 | C<$offset> is the offset from the start of the file - it generally must be |
2071 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
2188 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
… | |
… | |
2114 | |
2231 | |
2115 | See the C<splice(2)> manpage for details. |
2232 | See the C<splice(2)> manpage for details. |
2116 | |
2233 | |
2117 | =item IO::AIO::tee $r_fh, $w_fh, $length, $flags |
2234 | =item IO::AIO::tee $r_fh, $w_fh, $length, $flags |
2118 | |
2235 | |
2119 | Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the |
2236 | Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the |
2120 | description for C<IO::AIO::splice> above for details. |
2237 | description for C<IO::AIO::splice> above for details. |
|
|
2238 | |
|
|
2239 | =item $actual_size = IO::AIO::pipesize $r_fh[, $new_size] |
|
|
2240 | |
|
|
2241 | Attempts to query or change the pipe buffer size. Obviously works only |
|
|
2242 | on pipes, and currently works only on GNU/Linux systems, and fails with |
|
|
2243 | C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer |
|
|
2244 | size on other systems, drop me a note. |
|
|
2245 | |
|
|
2246 | =item ($rfh, $wfh) = IO::AIO::pipe2 [$flags] |
|
|
2247 | |
|
|
2248 | This is a direct interface to the Linux L<pipe2(2)> system call. If |
|
|
2249 | C<$flags> is missing or C<0>, then this should be the same as a call to |
|
|
2250 | perl's built-in C<pipe> function and create a new pipe, and works on |
|
|
2251 | systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe |
|
|
2252 | (..., 4096, O_BINARY)>. |
|
|
2253 | |
|
|
2254 | If C<$flags> is non-zero, it tries to invoke the pipe2 system call with |
|
|
2255 | the given flags (Linux 2.6.27, glibc 2.9). |
|
|
2256 | |
|
|
2257 | On success, the read and write file handles are returned. |
|
|
2258 | |
|
|
2259 | On error, nothing will be returned. If the pipe2 syscall is missing and |
|
|
2260 | C<$flags> is non-zero, fails with C<ENOSYS>. |
|
|
2261 | |
|
|
2262 | Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the |
|
|
2263 | time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and |
|
|
2264 | C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. |
2121 | |
2265 | |
2122 | =back |
2266 | =back |
2123 | |
2267 | |
2124 | =cut |
2268 | =cut |
2125 | |
2269 | |