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.19'; |
176 | our $VERSION = 4.35; |
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 |
184 | aio_wd); |
188 | aio_wd); |
… | |
… | |
227 | aio_unlink $pathname, $callback->($status) |
231 | aio_unlink $pathname, $callback->($status) |
228 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
232 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
229 | aio_link $srcpath, $dstpath, $callback->($status) |
233 | aio_link $srcpath, $dstpath, $callback->($status) |
230 | aio_symlink $srcpath, $dstpath, $callback->($status) |
234 | aio_symlink $srcpath, $dstpath, $callback->($status) |
231 | aio_readlink $pathname, $callback->($link) |
235 | aio_readlink $pathname, $callback->($link) |
232 | aio_realpath $pathname, $callback->($link) |
236 | aio_realpath $pathname, $callback->($path) |
233 | aio_rename $srcpath, $dstpath, $callback->($status) |
237 | aio_rename $srcpath, $dstpath, $callback->($status) |
|
|
238 | aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
234 | aio_mkdir $pathname, $mode, $callback->($status) |
239 | aio_mkdir $pathname, $mode, $callback->($status) |
235 | aio_rmdir $pathname, $callback->($status) |
240 | aio_rmdir $pathname, $callback->($status) |
236 | aio_readdir $pathname, $callback->($entries) |
241 | aio_readdir $pathname, $callback->($entries) |
237 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
242 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
238 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
243 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
… | |
… | |
240 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
245 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
241 | aio_load $pathname, $data, $callback->($status) |
246 | aio_load $pathname, $data, $callback->($status) |
242 | aio_copy $srcpath, $dstpath, $callback->($status) |
247 | aio_copy $srcpath, $dstpath, $callback->($status) |
243 | aio_move $srcpath, $dstpath, $callback->($status) |
248 | aio_move $srcpath, $dstpath, $callback->($status) |
244 | 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) |
245 | aio_sync $callback->($status) |
252 | aio_sync $callback->($status) |
246 | aio_syncfs $fh, $callback->($status) |
253 | aio_syncfs $fh, $callback->($status) |
247 | aio_fsync $fh, $callback->($status) |
254 | aio_fsync $fh, $callback->($status) |
248 | aio_fdatasync $fh, $callback->($status) |
255 | aio_fdatasync $fh, $callback->($status) |
249 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
256 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
250 | aio_pathsync $pathname, $callback->($status) |
257 | aio_pathsync $pathname, $callback->($status) |
251 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
258 | aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
252 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
259 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
253 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
260 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
254 | aio_mlockall $flags, $callback->($status) |
261 | aio_mlockall $flags, $callback->($status) |
255 | aio_group $callback->(...) |
262 | aio_group $callback->(...) |
256 | aio_nop $callback->() |
263 | aio_nop $callback->() |
… | |
… | |
394 | following POSIX and non-POSIX constants are available (missing ones on |
401 | following POSIX and non-POSIX constants are available (missing ones on |
395 | your system are, as usual, C<0>): |
402 | your system are, as usual, C<0>): |
396 | |
403 | |
397 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
404 | 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>, |
405 | 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>. |
406 | C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>. |
400 | |
407 | |
401 | |
408 | |
402 | =item aio_close $fh, $callback->($status) |
409 | =item aio_close $fh, $callback->($status) |
403 | |
410 | |
404 | Asynchronously close a file and call the callback with the result |
411 | Asynchronously close a file and call the callback with the result |
… | |
… | |
439 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
446 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
440 | |
447 | |
441 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
448 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
442 | |
449 | |
443 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
450 | 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> |
451 | 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 |
452 | calls the callback with the actual number of bytes transferred (or -1 on |
446 | error, just like the syscall). |
453 | error, just like the syscall). |
447 | |
454 | |
448 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
455 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
449 | offset plus the actual number of bytes read. |
456 | offset plus the actual number of bytes read. |
450 | |
457 | |
… | |
… | |
508 | As native sendfile syscalls (as practically any non-POSIX interface hacked |
515 | 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 |
516 | 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 |
517 | 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, |
518 | 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> - |
519 | so you really really should check the return value of C<aio_sendfile> - |
513 | fewre bytes than expected might have been transferred. |
520 | fewer bytes than expected might have been transferred. |
514 | |
521 | |
515 | |
522 | |
516 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
523 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
517 | |
524 | |
518 | C<aio_readahead> populates the page cache with data from a file so that |
525 | 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 |
529 | 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 |
530 | 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 |
531 | (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. |
532 | file. The current file offset of the file is left unchanged. |
526 | |
533 | |
527 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
534 | 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. |
535 | be emulated by simply reading the data, which would have a similar effect. |
529 | |
536 | |
530 | |
537 | |
531 | =item aio_stat $fh_or_path, $callback->($status) |
538 | =item aio_stat $fh_or_path, $callback->($status) |
532 | |
539 | |
533 | =item aio_lstat $fh, $callback->($status) |
540 | =item aio_lstat $fh, $callback->($status) |
… | |
… | |
626 | 0x00001373 devfs |
633 | 0x00001373 devfs |
627 | 0x00001cd1 devpts |
634 | 0x00001cd1 devpts |
628 | 0x0000f15f ecryptfs |
635 | 0x0000f15f ecryptfs |
629 | 0x00414a53 efs |
636 | 0x00414a53 efs |
630 | 0x0000137d ext |
637 | 0x0000137d ext |
631 | 0x0000ef53 ext2/ext3 |
638 | 0x0000ef53 ext2/ext3/ext4 |
632 | 0x0000ef51 ext2 |
639 | 0x0000ef51 ext2 |
|
|
640 | 0xf2f52010 f2fs |
633 | 0x00004006 fat |
641 | 0x00004006 fat |
634 | 0x65735546 fuseblk |
642 | 0x65735546 fuseblk |
635 | 0x65735543 fusectl |
643 | 0x65735543 fusectl |
636 | 0x0bad1dea futexfs |
644 | 0x0bad1dea futexfs |
637 | 0x01161970 gfs2 |
645 | 0x01161970 gfs2 |
638 | 0x47504653 gpfs |
646 | 0x47504653 gpfs |
639 | 0x00004244 hfs |
647 | 0x00004244 hfs |
640 | 0xf995e849 hpfs |
648 | 0xf995e849 hpfs |
|
|
649 | 0x00c0ffee hostfs |
641 | 0x958458f6 hugetlbfs |
650 | 0x958458f6 hugetlbfs |
642 | 0x2bad1dea inotifyfs |
651 | 0x2bad1dea inotifyfs |
643 | 0x00009660 isofs |
652 | 0x00009660 isofs |
644 | 0x000072b6 jffs2 |
653 | 0x000072b6 jffs2 |
645 | 0x3153464a jfs |
654 | 0x3153464a jfs |
… | |
… | |
660 | 0x00009fa1 openprom |
669 | 0x00009fa1 openprom |
661 | 0x7461636F ocfs2 |
670 | 0x7461636F ocfs2 |
662 | 0x00009fa0 proc |
671 | 0x00009fa0 proc |
663 | 0x6165676c pstorefs |
672 | 0x6165676c pstorefs |
664 | 0x0000002f qnx4 |
673 | 0x0000002f qnx4 |
|
|
674 | 0x68191122 qnx6 |
665 | 0x858458f6 ramfs |
675 | 0x858458f6 ramfs |
666 | 0x52654973 reiserfs |
676 | 0x52654973 reiserfs |
667 | 0x00007275 romfs |
677 | 0x00007275 romfs |
668 | 0x67596969 rpc_pipefs |
678 | 0x67596969 rpc_pipefs |
669 | 0x73636673 securityfs |
679 | 0x73636673 securityfs |
… | |
… | |
722 | Works like truncate(2) or ftruncate(2). |
732 | Works like truncate(2) or ftruncate(2). |
723 | |
733 | |
724 | |
734 | |
725 | =item aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
735 | =item aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
726 | |
736 | |
727 | Allocates or freed disk space according to the C<$mode> argument. See the |
737 | Allocates or frees disk space according to the C<$mode> argument. See the |
728 | linux C<fallocate> docuemntation for details. |
738 | linux C<fallocate> documentation for details. |
729 | |
739 | |
730 | C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> |
740 | 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 | |
741 | 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. |
742 | to deallocate a file range. |
|
|
743 | |
|
|
744 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
|
|
745 | (without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see |
|
|
746 | your L<fallocate(2)> manpage). |
733 | |
747 | |
734 | The file system block size used by C<fallocate> is presumably the |
748 | The file system block size used by C<fallocate> is presumably the |
735 | C<f_bsize> returned by C<statvfs>. |
749 | C<f_bsize> returned by C<statvfs>. |
736 | |
750 | |
737 | If C<fallocate> isn't available or cannot be emulated (currently no |
751 | If C<fallocate> isn't available or cannot be emulated (currently no |
… | |
… | |
797 | rename(2) and call the callback with the result code. |
811 | rename(2) and call the callback with the result code. |
798 | |
812 | |
799 | On systems that support the AIO::WD working directory abstraction |
813 | On systems that support the AIO::WD working directory abstraction |
800 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
814 | 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>. |
815 | of failing, C<rename> is called on the absolute path of C<$wd>. |
|
|
816 | |
|
|
817 | |
|
|
818 | =item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
|
|
819 | |
|
|
820 | Basically a version of C<aio_rename> with an additional C<$flags> |
|
|
821 | argument. Calling this with C<$flags=0> is the same as calling |
|
|
822 | C<aio_rename>. |
|
|
823 | |
|
|
824 | Non-zero flags are currently only supported on GNU/Linux systems that |
|
|
825 | support renameat2. Other systems fail with C<ENOSYS> in this case. |
|
|
826 | |
|
|
827 | The following constants are available (missing ones are, as usual C<0>), |
|
|
828 | see renameat2(2) for details: |
|
|
829 | |
|
|
830 | C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE> |
|
|
831 | and C<IO::AIO::RENAME_WHITEOUT>. |
802 | |
832 | |
803 | |
833 | |
804 | =item aio_mkdir $pathname, $mode, $callback->($status) |
834 | =item aio_mkdir $pathname, $mode, $callback->($status) |
805 | |
835 | |
806 | Asynchronously mkdir (create) a directory and call the callback with |
836 | Asynchronously mkdir (create) a directory and call the callback with |
… | |
… | |
1220 | }; |
1250 | }; |
1221 | |
1251 | |
1222 | $grp |
1252 | $grp |
1223 | } |
1253 | } |
1224 | |
1254 | |
|
|
1255 | =item aio_fcntl $fh, $cmd, $arg, $callback->($status) |
|
|
1256 | |
|
|
1257 | =item aio_ioctl $fh, $request, $buf, $callback->($status) |
|
|
1258 | |
|
|
1259 | These work just like the C<fcntl> and C<ioctl> built-in functions, except |
|
|
1260 | they execute asynchronously and pass the return value to the callback. |
|
|
1261 | |
|
|
1262 | Both calls can be used for a lot of things, some of which make more sense |
|
|
1263 | to run asynchronously in their own thread, while some others make less |
|
|
1264 | sense. For example, calls that block waiting for external events, such |
|
|
1265 | as locking, will also lock down an I/O thread while it is waiting, which |
|
|
1266 | can deadlock the whole I/O system. At the same time, there might be no |
|
|
1267 | alternative to using a thread to wait. |
|
|
1268 | |
|
|
1269 | So in general, you should only use these calls for things that do |
|
|
1270 | (filesystem) I/O, not for things that wait for other events (network, |
|
|
1271 | other processes), although if you are careful and know what you are doing, |
|
|
1272 | you still can. |
|
|
1273 | |
|
|
1274 | The following constants are available (missing ones are, as usual C<0>): |
|
|
1275 | |
|
|
1276 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
|
|
1277 | |
|
|
1278 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
|
|
1279 | C<FS_IOC_FIEMAP>. |
|
|
1280 | |
|
|
1281 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
|
|
1282 | C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>. |
|
|
1283 | |
|
|
1284 | C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>, |
|
|
1285 | C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>, |
|
|
1286 | C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>, |
|
|
1287 | C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>, |
|
|
1288 | C<FS_FL_USER_MODIFIABLE>. |
|
|
1289 | |
|
|
1290 | C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>, |
|
|
1291 | C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>, |
|
|
1292 | C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>, |
|
|
1293 | C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>, |
|
|
1294 | |
1225 | =item aio_sync $callback->($status) |
1295 | =item aio_sync $callback->($status) |
1226 | |
1296 | |
1227 | Asynchronously call sync and call the callback when finished. |
1297 | Asynchronously call sync and call the callback when finished. |
1228 | |
1298 | |
1229 | =item aio_fsync $fh, $callback->($status) |
1299 | =item aio_fsync $fh, $callback->($status) |
… | |
… | |
1297 | }; |
1367 | }; |
1298 | |
1368 | |
1299 | $grp |
1369 | $grp |
1300 | } |
1370 | } |
1301 | |
1371 | |
1302 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1372 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
1303 | |
1373 | |
1304 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
1374 | 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 |
1375 | 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 |
1376 | 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 |
1377 | scalar must only be modified in-place while an aio operation is pending on |
… | |
… | |
1309 | |
1379 | |
1310 | It calls the C<msync> function of your OS, if available, with the memory |
1380 | 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 |
1381 | 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> |
1382 | 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 |
1383 | 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 |
1384 | either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional |
1315 | C<IO::AIO::MS_SYNC>. |
1385 | C<IO::AIO::MS_INVALIDATE>. |
1316 | |
1386 | |
1317 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1387 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1318 | |
1388 | |
1319 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1389 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1320 | scalars. |
1390 | scalars. |
… | |
… | |
1500 | aio_stat [$etcdir, "passwd"], sub { |
1570 | aio_stat [$etcdir, "passwd"], sub { |
1501 | # yay |
1571 | # yay |
1502 | }; |
1572 | }; |
1503 | }; |
1573 | }; |
1504 | |
1574 | |
1505 | That C<aio_wd> is a request and not a normal function shows that creating |
1575 | 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 |
1576 | creating an IO::AIO::WD object is itself a potentially blocking operation, |
1507 | why it is done asynchronously. |
1577 | which is why it is done asynchronously. |
1508 | |
1578 | |
1509 | To stat the directory obtained with C<aio_wd> above, one could write |
1579 | To stat the directory obtained with C<aio_wd> above, one could write |
1510 | either of the following three request calls: |
1580 | either of the following three request calls: |
1511 | |
1581 | |
1512 | aio_lstat "/etc" , sub { ... # pathname as normal string |
1582 | aio_lstat "/etc" , sub { ... # pathname as normal string |
… | |
… | |
1555 | passing C<undef> as working directory component of a pathname fails the |
1625 | passing C<undef> as working directory component of a pathname fails the |
1556 | request with C<ENOENT>, there is often no need for error checking in the |
1626 | request with C<ENOENT>, there is often no need for error checking in the |
1557 | C<aio_wd> callback, as future requests using the value will fail in the |
1627 | C<aio_wd> callback, as future requests using the value will fail in the |
1558 | expected way. |
1628 | expected way. |
1559 | |
1629 | |
1560 | If this call isn't available because your OS lacks it or it couldn't be |
|
|
1561 | detected, it will be emulated by calling C<fsync> instead. |
|
|
1562 | |
|
|
1563 | =item IO::AIO::CWD |
1630 | =item IO::AIO::CWD |
1564 | |
1631 | |
1565 | This is a compiletime constant (object) that represents the process |
1632 | This is a compiletime constant (object) that represents the process |
1566 | current working directory. |
1633 | current working directory. |
1567 | |
1634 | |
… | |
… | |
1934 | |
2001 | |
1935 | This is a very bad function to use in interactive programs because it |
2002 | This is a very bad function to use in interactive programs because it |
1936 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
2003 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1937 | use an C<aio_group> together with a feed callback. |
2004 | use an C<aio_group> together with a feed callback. |
1938 | |
2005 | |
1939 | It's main use is in scripts without an event loop - when you want to stat |
2006 | Its main use is in scripts without an event loop - when you want to stat |
1940 | a lot of files, you can write somehting like this: |
2007 | a lot of files, you can write somehting like this: |
1941 | |
2008 | |
1942 | IO::AIO::max_outstanding 32; |
2009 | IO::AIO::max_outstanding 32; |
1943 | |
2010 | |
1944 | for my $path (...) { |
2011 | for my $path (...) { |
… | |
… | |
1984 | |
2051 | |
1985 | =back |
2052 | =back |
1986 | |
2053 | |
1987 | =head3 MISCELLANEOUS FUNCTIONS |
2054 | =head3 MISCELLANEOUS FUNCTIONS |
1988 | |
2055 | |
1989 | IO::AIO implements some functions that might be useful, but are not |
2056 | IO::AIO implements some functions that are useful when you want to use |
1990 | asynchronous. |
2057 | some "Advanced I/O" function not available to in Perl, without going the |
|
|
2058 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
|
|
2059 | counterpart. |
1991 | |
2060 | |
1992 | =over 4 |
2061 | =over 4 |
1993 | |
2062 | |
1994 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2063 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
1995 | |
2064 | |
… | |
… | |
2014 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2083 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2015 | |
2084 | |
2016 | Simply calls the C<posix_madvise> function (see its |
2085 | Simply calls the C<posix_madvise> function (see its |
2017 | manpage for details). The following advice constants are |
2086 | manpage for details). The following advice constants are |
2018 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2087 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2019 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. |
2088 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>, |
|
|
2089 | C<IO::AIO::MADV_FREE>. |
|
|
2090 | |
|
|
2091 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2092 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2093 | will be reduced to fit into the C<$scalar>. |
2020 | |
2094 | |
2021 | On systems that do not implement C<posix_madvise>, this function returns |
2095 | On systems that do not implement C<posix_madvise>, this function returns |
2022 | ENOSYS, otherwise the return value of C<posix_madvise>. |
2096 | ENOSYS, otherwise the return value of C<posix_madvise>. |
2023 | |
2097 | |
2024 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
2098 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
… | |
… | |
2026 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
2100 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
2027 | $scalar (see its manpage for details). The following protect |
2101 | $scalar (see its manpage for details). The following protect |
2028 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
2102 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
2029 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
2103 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
2030 | |
2104 | |
|
|
2105 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2106 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2107 | will be reduced to fit into the C<$scalar>. |
|
|
2108 | |
2031 | On systems that do not implement C<mprotect>, this function returns |
2109 | On systems that do not implement C<mprotect>, this function returns |
2032 | ENOSYS, otherwise the return value of C<mprotect>. |
2110 | ENOSYS, otherwise the return value of C<mprotect>. |
2033 | |
2111 | |
2034 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
2112 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
2035 | |
2113 | |
2036 | Memory-maps a file (or anonymous memory range) and attaches it to the |
2114 | Memory-maps a file (or anonymous memory range) and attaches it to the |
2037 | given C<$scalar>, which will act like a string scalar. Returns true on |
2115 | given C<$scalar>, which will act like a string scalar. Returns true on |
2038 | success, and false otherwise. |
2116 | success, and false otherwise. |
2039 | |
2117 | |
|
|
2118 | The scalar must exist, but its contents do not matter - this means you |
|
|
2119 | cannot use a nonexistant array or hash element. When in doubt, C<undef> |
|
|
2120 | the scalar first. |
|
|
2121 | |
2040 | The only operations allowed on the scalar are C<substr>/C<vec> that don't |
2122 | The only operations allowed on the mmapped scalar are C<substr>/C<vec>, |
2041 | change the string length, and most read-only operations such as copying it |
2123 | which don't change the string length, and most read-only operations such |
2042 | or searching it with regexes and so on. |
2124 | as copying it or searching it with regexes and so on. |
2043 | |
2125 | |
2044 | Anything else is unsafe and will, at best, result in memory leaks. |
2126 | Anything else is unsafe and will, at best, result in memory leaks. |
2045 | |
2127 | |
2046 | The memory map associated with the C<$scalar> is automatically removed |
2128 | The memory map associated with the C<$scalar> is automatically removed |
2047 | when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or |
2129 | when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap> |
2048 | C<IO::AIO::munmap> functions are called. |
2130 | or C<IO::AIO::munmap> functions are called on it. |
2049 | |
2131 | |
2050 | This calls the C<mmap>(2) function internally. See your system's manual |
2132 | This calls the C<mmap>(2) function internally. See your system's manual |
2051 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
2133 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
2052 | |
2134 | |
2053 | The C<$length> must be larger than zero and smaller than the actual |
2135 | The C<$length> must be larger than zero and smaller than the actual |
2054 | filesize. |
2136 | filesize. |
2055 | |
2137 | |
2056 | C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, |
2138 | C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, |
2057 | C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, |
2139 | C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, |
2058 | |
2140 | |
2059 | C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or |
2141 | C<$flags> can be a combination of |
2060 | C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when |
2142 | C<IO::AIO::MAP_SHARED> or |
2061 | not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS> |
2143 | C<IO::AIO::MAP_PRIVATE>, |
|
|
2144 | or a number of system-specific flags (when not available, the are C<0>): |
2062 | (which is set to C<MAP_ANON> if your system only provides this |
2145 | C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant), |
2063 | constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>, |
2146 | C<IO::AIO::MAP_LOCKED>, |
2064 | C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or |
2147 | C<IO::AIO::MAP_NORESERVE>, |
|
|
2148 | C<IO::AIO::MAP_POPULATE>, |
2065 | C<IO::AIO::MAP_NONBLOCK> |
2149 | C<IO::AIO::MAP_NONBLOCK>, |
|
|
2150 | C<IO::AIO::MAP_FIXED>, |
|
|
2151 | C<IO::AIO::MAP_GROWSDOWN>, |
|
|
2152 | C<IO::AIO::MAP_32BIT>, |
|
|
2153 | C<IO::AIO::MAP_HUGETLB> or |
|
|
2154 | C<IO::AIO::MAP_STACK>. |
2066 | |
2155 | |
2067 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
2156 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
2068 | |
2157 | |
2069 | C<$offset> is the offset from the start of the file - it generally must be |
2158 | C<$offset> is the offset from the start of the file - it generally must be |
2070 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
2159 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
… | |
… | |
2113 | |
2202 | |
2114 | See the C<splice(2)> manpage for details. |
2203 | See the C<splice(2)> manpage for details. |
2115 | |
2204 | |
2116 | =item IO::AIO::tee $r_fh, $w_fh, $length, $flags |
2205 | =item IO::AIO::tee $r_fh, $w_fh, $length, $flags |
2117 | |
2206 | |
2118 | Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the |
2207 | Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the |
2119 | description for C<IO::AIO::splice> above for details. |
2208 | description for C<IO::AIO::splice> above for details. |
2120 | |
2209 | |
2121 | =item $actual_size = IO::AIO::pipesize $r_fh[, $new_size] |
2210 | =item $actual_size = IO::AIO::pipesize $r_fh[, $new_size] |
2122 | |
2211 | |
2123 | Attempts to query or change the pipe buffer size. Obviously works only |
2212 | Attempts to query or change the pipe buffer size. Obviously works only |
2124 | on pipes, and currently works only on GNU/Linux systems, and fails with |
2213 | on pipes, and currently works only on GNU/Linux systems, and fails with |
2125 | C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer |
2214 | C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer |
2126 | size on other systems, drop me a note. |
2215 | size on other systems, drop me a note. |
|
|
2216 | |
|
|
2217 | =item ($rfh, $wfh) = IO::AIO::pipe2 [$flags] |
|
|
2218 | |
|
|
2219 | This is a direct interface to the Linux L<pipe2(2)> system call. If |
|
|
2220 | C<$flags> is missing or C<0>, then this should be the same as a call to |
|
|
2221 | perl's built-in C<pipe> function and create a new pipe, and works on |
|
|
2222 | systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe |
|
|
2223 | (..., 4096, O_BINARY)>. |
|
|
2224 | |
|
|
2225 | If C<$flags> is non-zero, it tries to invoke the pipe2 system call with |
|
|
2226 | the given flags (Linux 2.6.27, glibc 2.9). |
|
|
2227 | |
|
|
2228 | On success, the read and write file handles are returned. |
|
|
2229 | |
|
|
2230 | On error, nothing will be returned. If the pipe2 syscall is missing and |
|
|
2231 | C<$flags> is non-zero, fails with C<ENOSYS>. |
|
|
2232 | |
|
|
2233 | Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the |
|
|
2234 | time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and |
|
|
2235 | C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. |
2127 | |
2236 | |
2128 | =back |
2237 | =back |
2129 | |
2238 | |
2130 | =cut |
2239 | =cut |
2131 | |
2240 | |