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.13'; |
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_fallocate |
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_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 |
… | |
… | |
202 | |
205 | |
203 | =head1 FUNCTIONS |
206 | =head1 FUNCTIONS |
204 | |
207 | |
205 | =head2 QUICK OVERVIEW |
208 | =head2 QUICK OVERVIEW |
206 | |
209 | |
207 | This section simply lists the prototypes of the most important functions |
210 | This section simply lists the prototypes most of the functions for |
208 | for quick reference. See the following sections for function-by-function |
211 | quick reference. See the following sections for function-by-function |
209 | documentation. |
212 | documentation. |
210 | |
213 | |
211 | aio_wd $pathname, $callback->($wd) |
214 | aio_wd $pathname, $callback->($wd) |
212 | aio_open $pathname, $flags, $mode, $callback->($fh) |
215 | aio_open $pathname, $flags, $mode, $callback->($fh) |
213 | aio_close $fh, $callback->($status) |
216 | aio_close $fh, $callback->($status) |
… | |
… | |
221 | aio_statvfs $fh_or_path, $callback->($statvfs) |
224 | aio_statvfs $fh_or_path, $callback->($statvfs) |
222 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
225 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
223 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
226 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
224 | aio_chmod $fh_or_path, $mode, $callback->($status) |
227 | aio_chmod $fh_or_path, $mode, $callback->($status) |
225 | aio_truncate $fh_or_path, $offset, $callback->($status) |
228 | aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
229 | aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
|
|
230 | aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) |
226 | aio_unlink $pathname, $callback->($status) |
231 | aio_unlink $pathname, $callback->($status) |
227 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
232 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
228 | aio_link $srcpath, $dstpath, $callback->($status) |
233 | aio_link $srcpath, $dstpath, $callback->($status) |
229 | aio_symlink $srcpath, $dstpath, $callback->($status) |
234 | aio_symlink $srcpath, $dstpath, $callback->($status) |
230 | aio_readlink $pathname, $callback->($link) |
235 | aio_readlink $pathname, $callback->($link) |
231 | aio_realpath $pathname, $callback->($link) |
236 | aio_realpath $pathname, $callback->($path) |
232 | aio_rename $srcpath, $dstpath, $callback->($status) |
237 | aio_rename $srcpath, $dstpath, $callback->($status) |
233 | aio_mkdir $pathname, $mode, $callback->($status) |
238 | aio_mkdir $pathname, $mode, $callback->($status) |
234 | aio_rmdir $pathname, $callback->($status) |
239 | aio_rmdir $pathname, $callback->($status) |
235 | aio_readdir $pathname, $callback->($entries) |
240 | aio_readdir $pathname, $callback->($entries) |
236 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
241 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
… | |
… | |
239 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
244 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
240 | aio_load $pathname, $data, $callback->($status) |
245 | aio_load $pathname, $data, $callback->($status) |
241 | aio_copy $srcpath, $dstpath, $callback->($status) |
246 | aio_copy $srcpath, $dstpath, $callback->($status) |
242 | aio_move $srcpath, $dstpath, $callback->($status) |
247 | aio_move $srcpath, $dstpath, $callback->($status) |
243 | aio_rmtree $pathname, $callback->($status) |
248 | aio_rmtree $pathname, $callback->($status) |
|
|
249 | aio_fcntl $fh, $cmd, $arg, $callback->($status) |
|
|
250 | aio_ioctl $fh, $request, $buf, $callback->($status) |
244 | aio_sync $callback->($status) |
251 | aio_sync $callback->($status) |
245 | aio_syncfs $fh, $callback->($status) |
252 | aio_syncfs $fh, $callback->($status) |
246 | aio_fsync $fh, $callback->($status) |
253 | aio_fsync $fh, $callback->($status) |
247 | aio_fdatasync $fh, $callback->($status) |
254 | aio_fdatasync $fh, $callback->($status) |
248 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
255 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
249 | aio_pathsync $pathname, $callback->($status) |
256 | aio_pathsync $pathname, $callback->($status) |
250 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
257 | aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
251 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
258 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
252 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
259 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
253 | aio_mlockall $flags, $callback->($status) |
260 | aio_mlockall $flags, $callback->($status) |
254 | aio_group $callback->(...) |
261 | aio_group $callback->(...) |
255 | aio_nop $callback->() |
262 | aio_nop $callback->() |
… | |
… | |
272 | IO::AIO::nready |
279 | IO::AIO::nready |
273 | IO::AIO::npending |
280 | IO::AIO::npending |
274 | |
281 | |
275 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
282 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
276 | IO::AIO::fadvise $fh, $offset, $len, $advice |
283 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
284 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
|
|
285 | IO::AIO::munmap $scalar |
277 | IO::AIO::madvise $scalar, $offset, $length, $advice |
286 | IO::AIO::madvise $scalar, $offset, $length, $advice |
278 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
287 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
279 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
288 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
280 | IO::AIO::munlockall |
289 | IO::AIO::munlockall |
281 | |
290 | |
… | |
… | |
358 | |
367 | |
359 | |
368 | |
360 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
369 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
361 | |
370 | |
362 | Asynchronously open or create a file and call the callback with a newly |
371 | Asynchronously open or create a file and call the callback with a newly |
363 | created filehandle for the file. |
372 | created filehandle for the file (or C<undef> in case of an error). |
364 | |
373 | |
365 | The pathname passed to C<aio_open> must be absolute. See API NOTES, above, |
374 | The pathname passed to C<aio_open> must be absolute. See API NOTES, above, |
366 | for an explanation. |
375 | for an explanation. |
367 | |
376 | |
368 | The C<$flags> argument is a bitmask. See the C<Fcntl> module for a |
377 | The C<$flags> argument is a bitmask. See the C<Fcntl> module for a |
… | |
… | |
391 | following POSIX and non-POSIX constants are available (missing ones on |
400 | following POSIX and non-POSIX constants are available (missing ones on |
392 | your system are, as usual, C<0>): |
401 | your system are, as usual, C<0>): |
393 | |
402 | |
394 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
403 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
395 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
404 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
396 | C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>. |
405 | C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>. |
397 | |
406 | |
398 | |
407 | |
399 | =item aio_close $fh, $callback->($status) |
408 | =item aio_close $fh, $callback->($status) |
400 | |
409 | |
401 | Asynchronously close a file and call the callback with the result |
410 | Asynchronously close a file and call the callback with the result |
… | |
… | |
425 | |
434 | |
426 | In theory, the C<$whence> constants could be different than the |
435 | In theory, the C<$whence> constants could be different than the |
427 | corresponding values from L<Fcntl>, but perl guarantees they are the same, |
436 | corresponding values from L<Fcntl>, but perl guarantees they are the same, |
428 | so don't panic. |
437 | so don't panic. |
429 | |
438 | |
|
|
439 | As a GNU/Linux (and maybe Solaris) extension, also the constants |
|
|
440 | C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they |
|
|
441 | could be found. No guarantees about suitability for use in C<aio_seek> or |
|
|
442 | Perl's C<sysseek> can be made though, although I would naively assume they |
|
|
443 | "just work". |
|
|
444 | |
430 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
445 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
431 | |
446 | |
432 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
447 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
433 | |
448 | |
434 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
449 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
435 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> |
450 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and |
436 | and calls the callback without the actual number of bytes read (or -1 on |
451 | calls the callback with the actual number of bytes transferred (or -1 on |
437 | error, just like the syscall). |
452 | error, just like the syscall). |
438 | |
453 | |
439 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
454 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
440 | offset plus the actual number of bytes read. |
455 | offset plus the actual number of bytes read. |
441 | |
456 | |
… | |
… | |
499 | As native sendfile syscalls (as practically any non-POSIX interface hacked |
514 | As native sendfile syscalls (as practically any non-POSIX interface hacked |
500 | together in a hurry to improve benchmark numbers) tend to be rather buggy |
515 | together in a hurry to improve benchmark numbers) tend to be rather buggy |
501 | on many systems, this implementation tries to work around some known bugs |
516 | on many systems, this implementation tries to work around some known bugs |
502 | in Linux and FreeBSD kernels (probably others, too), but that might fail, |
517 | in Linux and FreeBSD kernels (probably others, too), but that might fail, |
503 | so you really really should check the return value of C<aio_sendfile> - |
518 | so you really really should check the return value of C<aio_sendfile> - |
504 | fewre bytes than expected might have been transferred. |
519 | fewer bytes than expected might have been transferred. |
505 | |
520 | |
506 | |
521 | |
507 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
522 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
508 | |
523 | |
509 | C<aio_readahead> populates the page cache with data from a file so that |
524 | C<aio_readahead> populates the page cache with data from a file so that |
… | |
… | |
513 | whole pages, so that offset is effectively rounded down to a page boundary |
528 | whole pages, so that offset is effectively rounded down to a page boundary |
514 | and bytes are read up to the next page boundary greater than or equal to |
529 | and bytes are read up to the next page boundary greater than or equal to |
515 | (off-set+length). C<aio_readahead> does not read beyond the end of the |
530 | (off-set+length). C<aio_readahead> does not read beyond the end of the |
516 | file. The current file offset of the file is left unchanged. |
531 | file. The current file offset of the file is left unchanged. |
517 | |
532 | |
518 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
533 | If that syscall doesn't exist (likely if your kernel isn't Linux) it will |
519 | emulated by simply reading the data, which would have a similar effect. |
534 | be emulated by simply reading the data, which would have a similar effect. |
520 | |
535 | |
521 | |
536 | |
522 | =item aio_stat $fh_or_path, $callback->($status) |
537 | =item aio_stat $fh_or_path, $callback->($status) |
523 | |
538 | |
524 | =item aio_lstat $fh, $callback->($status) |
539 | =item aio_lstat $fh, $callback->($status) |
… | |
… | |
593 | namemax => 255, |
608 | namemax => 255, |
594 | frsize => 1024, |
609 | frsize => 1024, |
595 | fsid => 1810 |
610 | fsid => 1810 |
596 | } |
611 | } |
597 | |
612 | |
|
|
613 | Here is a (likely partial - send me updates!) list of fsid values used by |
|
|
614 | Linux - it is safe to hardcode these when C<$^O> is C<linux>: |
|
|
615 | |
|
|
616 | 0x0000adf5 adfs |
|
|
617 | 0x0000adff affs |
|
|
618 | 0x5346414f afs |
|
|
619 | 0x09041934 anon-inode filesystem |
|
|
620 | 0x00000187 autofs |
|
|
621 | 0x42465331 befs |
|
|
622 | 0x1badface bfs |
|
|
623 | 0x42494e4d binfmt_misc |
|
|
624 | 0x9123683e btrfs |
|
|
625 | 0x0027e0eb cgroupfs |
|
|
626 | 0xff534d42 cifs |
|
|
627 | 0x73757245 coda |
|
|
628 | 0x012ff7b7 coh |
|
|
629 | 0x28cd3d45 cramfs |
|
|
630 | 0x453dcd28 cramfs-wend (wrong endianness) |
|
|
631 | 0x64626720 debugfs |
|
|
632 | 0x00001373 devfs |
|
|
633 | 0x00001cd1 devpts |
|
|
634 | 0x0000f15f ecryptfs |
|
|
635 | 0x00414a53 efs |
|
|
636 | 0x0000137d ext |
|
|
637 | 0x0000ef53 ext2/ext3/ext4 |
|
|
638 | 0x0000ef51 ext2 |
|
|
639 | 0xf2f52010 f2fs |
|
|
640 | 0x00004006 fat |
|
|
641 | 0x65735546 fuseblk |
|
|
642 | 0x65735543 fusectl |
|
|
643 | 0x0bad1dea futexfs |
|
|
644 | 0x01161970 gfs2 |
|
|
645 | 0x47504653 gpfs |
|
|
646 | 0x00004244 hfs |
|
|
647 | 0xf995e849 hpfs |
|
|
648 | 0x00c0ffee hostfs |
|
|
649 | 0x958458f6 hugetlbfs |
|
|
650 | 0x2bad1dea inotifyfs |
|
|
651 | 0x00009660 isofs |
|
|
652 | 0x000072b6 jffs2 |
|
|
653 | 0x3153464a jfs |
|
|
654 | 0x6b414653 k-afs |
|
|
655 | 0x0bd00bd0 lustre |
|
|
656 | 0x0000137f minix |
|
|
657 | 0x0000138f minix 30 char names |
|
|
658 | 0x00002468 minix v2 |
|
|
659 | 0x00002478 minix v2 30 char names |
|
|
660 | 0x00004d5a minix v3 |
|
|
661 | 0x19800202 mqueue |
|
|
662 | 0x00004d44 msdos |
|
|
663 | 0x0000564c novell |
|
|
664 | 0x00006969 nfs |
|
|
665 | 0x6e667364 nfsd |
|
|
666 | 0x00003434 nilfs |
|
|
667 | 0x5346544e ntfs |
|
|
668 | 0x00009fa1 openprom |
|
|
669 | 0x7461636F ocfs2 |
|
|
670 | 0x00009fa0 proc |
|
|
671 | 0x6165676c pstorefs |
|
|
672 | 0x0000002f qnx4 |
|
|
673 | 0x68191122 qnx6 |
|
|
674 | 0x858458f6 ramfs |
|
|
675 | 0x52654973 reiserfs |
|
|
676 | 0x00007275 romfs |
|
|
677 | 0x67596969 rpc_pipefs |
|
|
678 | 0x73636673 securityfs |
|
|
679 | 0xf97cff8c selinux |
|
|
680 | 0x0000517b smb |
|
|
681 | 0x534f434b sockfs |
|
|
682 | 0x73717368 squashfs |
|
|
683 | 0x62656572 sysfs |
|
|
684 | 0x012ff7b6 sysv2 |
|
|
685 | 0x012ff7b5 sysv4 |
|
|
686 | 0x01021994 tmpfs |
|
|
687 | 0x15013346 udf |
|
|
688 | 0x00011954 ufs |
|
|
689 | 0x54190100 ufs byteswapped |
|
|
690 | 0x00009fa2 usbdevfs |
|
|
691 | 0x01021997 v9fs |
|
|
692 | 0xa501fcf5 vxfs |
|
|
693 | 0xabba1974 xenfs |
|
|
694 | 0x012ff7b4 xenix |
|
|
695 | 0x58465342 xfs |
|
|
696 | 0x012fd16d xia |
598 | |
697 | |
599 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
698 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
600 | |
699 | |
601 | Works like perl's C<utime> function (including the special case of $atime |
700 | Works like perl's C<utime> function (including the special case of $atime |
602 | and $mtime being undef). Fractional times are supported if the underlying |
701 | and $mtime being undef). Fractional times are supported if the underlying |
… | |
… | |
630 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
729 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
631 | |
730 | |
632 | Works like truncate(2) or ftruncate(2). |
731 | Works like truncate(2) or ftruncate(2). |
633 | |
732 | |
634 | |
733 | |
|
|
734 | =item aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
|
|
735 | |
|
|
736 | Allocates or frees disk space according to the C<$mode> argument. See the |
|
|
737 | linux C<fallocate> documentation for details. |
|
|
738 | |
|
|
739 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
|
|
740 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
|
|
741 | to deallocate a file range. |
|
|
742 | |
|
|
743 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
|
|
744 | (without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see |
|
|
745 | your L<fallocate(2)> manpage). |
|
|
746 | |
|
|
747 | The file system block size used by C<fallocate> is presumably the |
|
|
748 | C<f_bsize> returned by C<statvfs>. |
|
|
749 | |
|
|
750 | If C<fallocate> isn't available or cannot be emulated (currently no |
|
|
751 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
|
|
752 | |
|
|
753 | |
635 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
754 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
636 | |
755 | |
637 | Works like perl's C<chmod> function. |
756 | Works like perl's C<chmod> function. |
638 | |
757 | |
639 | |
758 | |
… | |
… | |
676 | |
795 | |
677 | |
796 | |
678 | =item aio_realpath $pathname, $callback->($path) |
797 | =item aio_realpath $pathname, $callback->($path) |
679 | |
798 | |
680 | Asynchronously make the path absolute and resolve any symlinks in |
799 | Asynchronously make the path absolute and resolve any symlinks in |
681 | C<$path>. The resulting path only consists of directories (Same as |
800 | C<$path>. The resulting path only consists of directories (same as |
682 | L<Cwd::realpath>). |
801 | L<Cwd::realpath>). |
683 | |
802 | |
684 | This request can be used to get the absolute path of the current working |
803 | This request can be used to get the absolute path of the current working |
685 | directory by passing it a path of F<.> (a single dot). |
804 | directory by passing it a path of F<.> (a single dot). |
686 | |
805 | |
687 | |
806 | |
688 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
807 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
689 | |
808 | |
690 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
809 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
691 | rename(2) and call the callback with the result code. |
810 | rename(2) and call the callback with the result code. |
|
|
811 | |
|
|
812 | On systems that support the AIO::WD working directory abstraction |
|
|
813 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
|
|
814 | of failing, C<rename> is called on the absolute path of C<$wd>. |
692 | |
815 | |
693 | |
816 | |
694 | =item aio_mkdir $pathname, $mode, $callback->($status) |
817 | =item aio_mkdir $pathname, $mode, $callback->($status) |
695 | |
818 | |
696 | Asynchronously mkdir (create) a directory and call the callback with |
819 | Asynchronously mkdir (create) a directory and call the callback with |
… | |
… | |
700 | |
823 | |
701 | =item aio_rmdir $pathname, $callback->($status) |
824 | =item aio_rmdir $pathname, $callback->($status) |
702 | |
825 | |
703 | Asynchronously rmdir (delete) a directory and call the callback with the |
826 | Asynchronously rmdir (delete) a directory and call the callback with the |
704 | result code. |
827 | result code. |
|
|
828 | |
|
|
829 | On systems that support the AIO::WD working directory abstraction |
|
|
830 | natively, the case C<[$wd, "."]> is specialcased - instead of failing, |
|
|
831 | C<rmdir> is called on the absolute path of C<$wd>. |
705 | |
832 | |
706 | |
833 | |
707 | =item aio_readdir $pathname, $callback->($entries) |
834 | =item aio_readdir $pathname, $callback->($entries) |
708 | |
835 | |
709 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
836 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
… | |
… | |
1074 | } |
1201 | } |
1075 | |
1202 | |
1076 | =item aio_rmtree $pathname, $callback->($status) |
1203 | =item aio_rmtree $pathname, $callback->($status) |
1077 | |
1204 | |
1078 | Delete a directory tree starting (and including) C<$path>, return the |
1205 | Delete a directory tree starting (and including) C<$path>, return the |
1079 | status of the final C<rmdir> only. This is a composite request that |
1206 | status of the final C<rmdir> only. This is a composite request that |
1080 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
1207 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
1081 | everything else. |
1208 | everything else. |
1082 | |
1209 | |
1083 | =cut |
1210 | =cut |
1084 | |
1211 | |
… | |
… | |
1105 | add $grp $dirgrp; |
1232 | add $grp $dirgrp; |
1106 | }; |
1233 | }; |
1107 | |
1234 | |
1108 | $grp |
1235 | $grp |
1109 | } |
1236 | } |
|
|
1237 | |
|
|
1238 | =item aio_fcntl $fh, $cmd, $arg, $callback->($status) |
|
|
1239 | |
|
|
1240 | =item aio_ioctl $fh, $request, $buf, $callback->($status) |
|
|
1241 | |
|
|
1242 | These work just like the C<fcntl> and C<ioctl> built-in functions, except |
|
|
1243 | they execute asynchronously and pass the return value to the callback. |
|
|
1244 | |
|
|
1245 | Both calls can be used for a lot of things, some of which make more sense |
|
|
1246 | to run asynchronously in their own thread, while some others make less |
|
|
1247 | sense. For example, calls that block waiting for external events, such |
|
|
1248 | as locking, will also lock down an I/O thread while it is waiting, which |
|
|
1249 | can deadlock the whole I/O system. At the same time, there might be no |
|
|
1250 | alternative to using a thread to wait. |
|
|
1251 | |
|
|
1252 | So in general, you should only use these calls for things that do |
|
|
1253 | (filesystem) I/O, not for things that wait for other events (network, |
|
|
1254 | other processes), although if you are careful and know what you are doing, |
|
|
1255 | you still can. |
|
|
1256 | |
|
|
1257 | The following constants are available (missing ones are, as usual C<0>): |
|
|
1258 | |
|
|
1259 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
|
|
1260 | |
|
|
1261 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
|
|
1262 | C<FS_IOC_FIEMAP>. |
|
|
1263 | |
|
|
1264 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
|
|
1265 | C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>. |
|
|
1266 | |
|
|
1267 | C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>, |
|
|
1268 | C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>, |
|
|
1269 | C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>, |
|
|
1270 | C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>, |
|
|
1271 | C<FS_FL_USER_MODIFIABLE>. |
|
|
1272 | |
|
|
1273 | C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>, |
|
|
1274 | C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>, |
|
|
1275 | C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>, |
|
|
1276 | C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>, |
1110 | |
1277 | |
1111 | =item aio_sync $callback->($status) |
1278 | =item aio_sync $callback->($status) |
1112 | |
1279 | |
1113 | Asynchronously call sync and call the callback when finished. |
1280 | Asynchronously call sync and call the callback when finished. |
1114 | |
1281 | |
… | |
… | |
1183 | }; |
1350 | }; |
1184 | |
1351 | |
1185 | $grp |
1352 | $grp |
1186 | } |
1353 | } |
1187 | |
1354 | |
1188 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1355 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
1189 | |
1356 | |
1190 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
1357 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
1191 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
1358 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
1192 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
1359 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
1193 | scalar must only be modified in-place while an aio operation is pending on |
1360 | scalar must only be modified in-place while an aio operation is pending on |
… | |
… | |
1195 | |
1362 | |
1196 | It calls the C<msync> function of your OS, if available, with the memory |
1363 | It calls the C<msync> function of your OS, if available, with the memory |
1197 | area starting at C<$offset> in the string and ending C<$length> bytes |
1364 | area starting at C<$offset> in the string and ending C<$length> bytes |
1198 | later. If C<$length> is negative, counts from the end, and if C<$length> |
1365 | later. If C<$length> is negative, counts from the end, and if C<$length> |
1199 | is C<undef>, then it goes till the end of the string. The flags can be |
1366 | is C<undef>, then it goes till the end of the string. The flags can be |
1200 | a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and |
1367 | either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional |
1201 | C<IO::AIO::MS_SYNC>. |
1368 | C<IO::AIO::MS_INVALIDATE>. |
1202 | |
1369 | |
1203 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1370 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1204 | |
1371 | |
1205 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1372 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1206 | scalars. |
1373 | scalars. |
1207 | |
1374 | |
1208 | It touches (reads or writes) all memory pages in the specified |
1375 | It touches (reads or writes) all memory pages in the specified |
1209 | range inside the scalar. All caveats and parameters are the same |
1376 | range inside the scalar. All caveats and parameters are the same |
1210 | as for C<aio_msync>, above, except for flags, which must be either |
1377 | as for C<aio_msync>, above, except for flags, which must be either |
1211 | C<0> (which reads all pages and ensures they are instantiated) or |
1378 | C<0> (which reads all pages and ensures they are instantiated) or |
1212 | C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and |
1379 | C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and |
1213 | writing an octet from it, which dirties the page). |
1380 | writing an octet from it, which dirties the page). |
1214 | |
1381 | |
1215 | =item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
1382 | =item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
1216 | |
1383 | |
1217 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1384 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
… | |
… | |
1251 | |
1418 | |
1252 | aio_mlockall IO::AIO::MCL_FUTURE; |
1419 | aio_mlockall IO::AIO::MCL_FUTURE; |
1253 | |
1420 | |
1254 | =item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) |
1421 | =item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) |
1255 | |
1422 | |
1256 | Queries the extents of the given file (by calling the Linux FIEMAP ioctl, |
1423 | Queries the extents of the given file (by calling the Linux C<FIEMAP> |
1257 | see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the |
1424 | ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If |
1258 | C<ioctl> is not available on your OS, then this rquiest will fail with |
1425 | the ioctl is not available on your OS, then this request will fail with |
1259 | C<ENOSYS>. |
1426 | C<ENOSYS>. |
1260 | |
1427 | |
1261 | C<$start> is the starting offset to query extents for, C<$length> is the |
1428 | C<$start> is the starting offset to query extents for, C<$length> is the |
1262 | size of the range to query - if it is C<undef>, then the whole file will |
1429 | size of the range to query - if it is C<undef>, then the whole file will |
1263 | be queried. |
1430 | be queried. |
… | |
… | |
1266 | C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also |
1433 | C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also |
1267 | exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query |
1434 | exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query |
1268 | the data portion. |
1435 | the data portion. |
1269 | |
1436 | |
1270 | C<$count> is the maximum number of extent records to return. If it is |
1437 | C<$count> is the maximum number of extent records to return. If it is |
1271 | C<undef>, then IO::AIO queries all extents of the file. As a very special |
1438 | C<undef>, then IO::AIO queries all extents of the range. As a very special |
1272 | case, if it is C<0>, then the callback receives the number of extents |
1439 | case, if it is C<0>, then the callback receives the number of extents |
1273 | instead of the extents themselves. |
1440 | instead of the extents themselves (which is unreliable, see below). |
1274 | |
1441 | |
1275 | If an error occurs, the callback receives no arguments. The special |
1442 | If an error occurs, the callback receives no arguments. The special |
1276 | C<errno> value C<IO::AIO::EBADR> is available to test for flag errors. |
1443 | C<errno> value C<IO::AIO::EBADR> is available to test for flag errors. |
1277 | |
1444 | |
1278 | Otherwise, the callback receives an array reference with extent |
1445 | Otherwise, the callback receives an array reference with extent |
… | |
… | |
1280 | following members: |
1447 | following members: |
1281 | |
1448 | |
1282 | [$logical, $physical, $length, $flags] |
1449 | [$logical, $physical, $length, $flags] |
1283 | |
1450 | |
1284 | Flags is any combination of the following flag values (typically either C<0> |
1451 | Flags is any combination of the following flag values (typically either C<0> |
1285 | or C<IO::AIO::FIEMAP_EXTENT_LAST>): |
1452 | or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)): |
1286 | |
1453 | |
1287 | C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>, |
1454 | C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>, |
1288 | C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>, |
1455 | C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>, |
1289 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
1456 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
1290 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
1457 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
1291 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
1458 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
1292 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1459 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1293 | |
1460 | |
|
|
1461 | At the time of this writing (Linux 3.2), this requets is unreliable unless |
|
|
1462 | C<$count> is C<undef>, as the kernel has all sorts of bugs preventing |
|
|
1463 | it to return all extents of a range for files with large number of |
|
|
1464 | extents. The code works around all these issues if C<$count> is undef. |
|
|
1465 | |
1294 | =item aio_group $callback->(...) |
1466 | =item aio_group $callback->(...) |
1295 | |
1467 | |
1296 | This is a very special aio request: Instead of doing something, it is a |
1468 | This is a very special aio request: Instead of doing something, it is a |
1297 | container for other aio requests, which is useful if you want to bundle |
1469 | container for other aio requests, which is useful if you want to bundle |
1298 | many requests into a single, composite, request with a definite callback |
1470 | many requests into a single, composite, request with a definite callback |
… | |
… | |
1381 | aio_stat [$etcdir, "passwd"], sub { |
1553 | aio_stat [$etcdir, "passwd"], sub { |
1382 | # yay |
1554 | # yay |
1383 | }; |
1555 | }; |
1384 | }; |
1556 | }; |
1385 | |
1557 | |
1386 | That C<aio_wd> is a request and not a normal function shows that creating |
1558 | The fact that C<aio_wd> is a request and not a normal function shows that |
1387 | an IO::AIO::WD object is itself a potentially blocking operation, which is |
1559 | creating an IO::AIO::WD object is itself a potentially blocking operation, |
1388 | why it is done asynchronously. |
1560 | which is why it is done asynchronously. |
1389 | |
1561 | |
1390 | To stat the directory obtained with C<aio_wd> above, one could write |
1562 | To stat the directory obtained with C<aio_wd> above, one could write |
1391 | either of the following three request calls: |
1563 | either of the following three request calls: |
1392 | |
1564 | |
1393 | aio_lstat "/etc" , sub { ... # pathname as normal string |
1565 | aio_lstat "/etc" , sub { ... # pathname as normal string |
… | |
… | |
1413 | will still point to the original directory. Most functions accepting a |
1585 | will still point to the original directory. Most functions accepting a |
1414 | pathname will use the directory fd on newer systems, and the string on |
1586 | pathname will use the directory fd on newer systems, and the string on |
1415 | older systems. Some functions (such as realpath) will always rely on the |
1587 | older systems. Some functions (such as realpath) will always rely on the |
1416 | string form of the pathname. |
1588 | string form of the pathname. |
1417 | |
1589 | |
1418 | So this fucntionality is mainly useful to get some protection against |
1590 | So this functionality is mainly useful to get some protection against |
1419 | C<chdir>, to easily get an absolute path out of a relative path for future |
1591 | C<chdir>, to easily get an absolute path out of a relative path for future |
1420 | reference, and to speed up doing many operations in the same directory |
1592 | reference, and to speed up doing many operations in the same directory |
1421 | (e.g. when stat'ing all files in a directory). |
1593 | (e.g. when stat'ing all files in a directory). |
1422 | |
1594 | |
1423 | The following functions implement this working directory abstraction: |
1595 | The following functions implement this working directory abstraction: |
… | |
… | |
1436 | passing C<undef> as working directory component of a pathname fails the |
1608 | passing C<undef> as working directory component of a pathname fails the |
1437 | request with C<ENOENT>, there is often no need for error checking in the |
1609 | request with C<ENOENT>, there is often no need for error checking in the |
1438 | C<aio_wd> callback, as future requests using the value will fail in the |
1610 | C<aio_wd> callback, as future requests using the value will fail in the |
1439 | expected way. |
1611 | expected way. |
1440 | |
1612 | |
1441 | If this call isn't available because your OS lacks it or it couldn't be |
|
|
1442 | detected, it will be emulated by calling C<fsync> instead. |
|
|
1443 | |
|
|
1444 | =item IO::AIO::CWD |
1613 | =item IO::AIO::CWD |
1445 | |
1614 | |
1446 | This is a compiletime constant (object) that represents the process |
1615 | This is a compiletime constant (object) that represents the process |
1447 | current working directory. |
1616 | current working directory. |
1448 | |
1617 | |
1449 | Specifying this object as working directory object for a pathname is as |
1618 | Specifying this object as working directory object for a pathname is as if |
1450 | if the pathname would be specified directly, without a directory object, |
1619 | the pathname would be specified directly, without a directory object. For |
1451 | e.g., these calls are functionally identical: |
1620 | example, these calls are functionally identical: |
1452 | |
1621 | |
1453 | aio_stat "somefile", sub { ... }; |
1622 | aio_stat "somefile", sub { ... }; |
1454 | aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; |
1623 | aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; |
1455 | |
1624 | |
1456 | =back |
1625 | =back |
1457 | |
1626 | |
|
|
1627 | To recover the path associated with an IO::AIO::WD object, you can use |
|
|
1628 | C<aio_realpath>: |
|
|
1629 | |
|
|
1630 | aio_realpath $wd, sub { |
|
|
1631 | warn "path is $_[0]\n"; |
|
|
1632 | }; |
|
|
1633 | |
|
|
1634 | Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir> |
|
|
1635 | sometimes, fall back to using an absolue path. |
1458 | |
1636 | |
1459 | =head2 IO::AIO::REQ CLASS |
1637 | =head2 IO::AIO::REQ CLASS |
1460 | |
1638 | |
1461 | All non-aggregate C<aio_*> functions return an object of this class when |
1639 | All non-aggregate C<aio_*> functions return an object of this class when |
1462 | called in non-void context. |
1640 | called in non-void context. |
… | |
… | |
1640 | |
1818 | |
1641 | See C<poll_cb> for an example. |
1819 | See C<poll_cb> for an example. |
1642 | |
1820 | |
1643 | =item IO::AIO::poll_cb |
1821 | =item IO::AIO::poll_cb |
1644 | |
1822 | |
1645 | Process some outstanding events on the result pipe. You have to call |
1823 | Process some requests that have reached the result phase (i.e. they have |
|
|
1824 | been executed but the results are not yet reported). You have to call |
|
|
1825 | this "regularly" to finish outstanding requests. |
|
|
1826 | |
1646 | this regularly. Returns C<0> if all events could be processed (or there |
1827 | Returns C<0> if all events could be processed (or there were no |
1647 | were no events to process), or C<-1> if it returned earlier for whatever |
1828 | events to process), or C<-1> if it returned earlier for whatever |
1648 | reason. Returns immediately when no events are outstanding. The amount of |
1829 | reason. Returns immediately when no events are outstanding. The amount |
1649 | events processed depends on the settings of C<IO::AIO::max_poll_req> and |
1830 | of events processed depends on the settings of C<IO::AIO::max_poll_req>, |
1650 | C<IO::AIO::max_poll_time>. |
1831 | C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>. |
1651 | |
1832 | |
1652 | If not all requests were processed for whatever reason, the filehandle |
1833 | If not all requests were processed for whatever reason, the poll file |
1653 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1834 | descriptor will still be ready when C<poll_cb> returns, so normally you |
1654 | do anything special to have it called later. |
1835 | don't have to do anything special to have it called later. |
1655 | |
1836 | |
1656 | Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes |
1837 | Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes |
1657 | ready, it can be beneficial to call this function from loops which submit |
1838 | ready, it can be beneficial to call this function from loops which submit |
1658 | a lot of requests, to make sure the results get processed when they become |
1839 | a lot of requests, to make sure the results get processed when they become |
1659 | available and not just when the loop is finished and the event loop takes |
1840 | available and not just when the loop is finished and the event loop takes |
… | |
… | |
1668 | poll => 'r', async => 1, |
1849 | poll => 'r', async => 1, |
1669 | cb => \&IO::AIO::poll_cb); |
1850 | cb => \&IO::AIO::poll_cb); |
1670 | |
1851 | |
1671 | =item IO::AIO::poll_wait |
1852 | =item IO::AIO::poll_wait |
1672 | |
1853 | |
1673 | If there are any outstanding requests and none of them in the result |
1854 | Wait until either at least one request is in the result phase or no |
1674 | phase, wait till the result filehandle becomes ready for reading (simply |
1855 | requests are outstanding anymore. |
1675 | does a C<select> on the filehandle. This is useful if you want to |
1856 | |
1676 | synchronously wait for some requests to finish). |
1857 | This is useful if you want to synchronously wait for some requests to |
|
|
1858 | become ready, without actually handling them. |
1677 | |
1859 | |
1678 | See C<nreqs> for an example. |
1860 | See C<nreqs> for an example. |
1679 | |
1861 | |
1680 | =item IO::AIO::poll |
1862 | =item IO::AIO::poll |
1681 | |
1863 | |
… | |
… | |
1802 | |
1984 | |
1803 | This is a very bad function to use in interactive programs because it |
1985 | This is a very bad function to use in interactive programs because it |
1804 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1986 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1805 | use an C<aio_group> together with a feed callback. |
1987 | use an C<aio_group> together with a feed callback. |
1806 | |
1988 | |
1807 | It's main use is in scripts without an event loop - when you want to stat |
1989 | Its main use is in scripts without an event loop - when you want to stat |
1808 | a lot of files, you can write somehting like this: |
1990 | a lot of files, you can write somehting like this: |
1809 | |
1991 | |
1810 | IO::AIO::max_outstanding 32; |
1992 | IO::AIO::max_outstanding 32; |
1811 | |
1993 | |
1812 | for my $path (...) { |
1994 | for my $path (...) { |
… | |
… | |
1852 | |
2034 | |
1853 | =back |
2035 | =back |
1854 | |
2036 | |
1855 | =head3 MISCELLANEOUS FUNCTIONS |
2037 | =head3 MISCELLANEOUS FUNCTIONS |
1856 | |
2038 | |
1857 | IO::AIO implements some functions that might be useful, but are not |
2039 | IO::AIO implements some functions that are useful when you want to use |
1858 | asynchronous. |
2040 | some "Advanced I/O" function not available to in Perl, without going the |
|
|
2041 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
|
|
2042 | counterpart. |
1859 | |
2043 | |
1860 | =over 4 |
2044 | =over 4 |
1861 | |
2045 | |
1862 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2046 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
1863 | |
2047 | |
… | |
… | |
1882 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2066 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
1883 | |
2067 | |
1884 | Simply calls the C<posix_madvise> function (see its |
2068 | Simply calls the C<posix_madvise> function (see its |
1885 | manpage for details). The following advice constants are |
2069 | manpage for details). The following advice constants are |
1886 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2070 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
1887 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. |
2071 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>, |
|
|
2072 | C<IO::AIO::MADV_FREE>. |
|
|
2073 | |
|
|
2074 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2075 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2076 | will be reduced to fit into the C<$scalar>. |
1888 | |
2077 | |
1889 | On systems that do not implement C<posix_madvise>, this function returns |
2078 | On systems that do not implement C<posix_madvise>, this function returns |
1890 | ENOSYS, otherwise the return value of C<posix_madvise>. |
2079 | ENOSYS, otherwise the return value of C<posix_madvise>. |
1891 | |
2080 | |
1892 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
2081 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
… | |
… | |
1894 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
2083 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
1895 | $scalar (see its manpage for details). The following protect |
2084 | $scalar (see its manpage for details). The following protect |
1896 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
2085 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
1897 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
2086 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
1898 | |
2087 | |
|
|
2088 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2089 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2090 | will be reduced to fit into the C<$scalar>. |
|
|
2091 | |
1899 | On systems that do not implement C<mprotect>, this function returns |
2092 | On systems that do not implement C<mprotect>, this function returns |
1900 | ENOSYS, otherwise the return value of C<mprotect>. |
2093 | ENOSYS, otherwise the return value of C<mprotect>. |
1901 | |
2094 | |
1902 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
2095 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
1903 | |
2096 | |
1904 | Memory-maps a file (or anonymous memory range) and attaches it to the |
2097 | Memory-maps a file (or anonymous memory range) and attaches it to the |
1905 | given C<$scalar>, which will act like a string scalar. |
2098 | given C<$scalar>, which will act like a string scalar. Returns true on |
|
|
2099 | success, and false otherwise. |
1906 | |
2100 | |
|
|
2101 | The scalar must exist, but its contents do not matter - this means you |
|
|
2102 | cannot use a nonexistant array or hash element. When in doubt, C<undef> |
|
|
2103 | the scalar first. |
|
|
2104 | |
1907 | The only operations allowed on the scalar are C<substr>/C<vec> that don't |
2105 | The only operations allowed on the mmapped scalar are C<substr>/C<vec>, |
1908 | change the string length, and most read-only operations such as copying it |
2106 | which don't change the string length, and most read-only operations such |
1909 | or searching it with regexes and so on. |
2107 | as copying it or searching it with regexes and so on. |
1910 | |
2108 | |
1911 | Anything else is unsafe and will, at best, result in memory leaks. |
2109 | Anything else is unsafe and will, at best, result in memory leaks. |
1912 | |
2110 | |
1913 | The memory map associated with the C<$scalar> is automatically removed |
2111 | The memory map associated with the C<$scalar> is automatically removed |
1914 | when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or |
2112 | when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap> |
1915 | C<IO::AIO::munmap> functions are called. |
2113 | or C<IO::AIO::munmap> functions are called on it. |
1916 | |
2114 | |
1917 | This calls the C<mmap>(2) function internally. See your system's manual |
2115 | This calls the C<mmap>(2) function internally. See your system's manual |
1918 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
2116 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
1919 | |
2117 | |
1920 | The C<$length> must be larger than zero and smaller than the actual |
2118 | The C<$length> must be larger than zero and smaller than the actual |
1921 | filesize. |
2119 | filesize. |
1922 | |
2120 | |
1923 | C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, |
2121 | C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, |
1924 | C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, |
2122 | C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, |
1925 | |
2123 | |
1926 | C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or |
2124 | C<$flags> can be a combination of |
1927 | C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when |
2125 | C<IO::AIO::MAP_SHARED> or |
1928 | not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS> |
2126 | C<IO::AIO::MAP_PRIVATE>, |
|
|
2127 | or a number of system-specific flags (when not available, the are C<0>): |
1929 | (which is set to C<MAP_ANON> if your system only provides this |
2128 | C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant), |
1930 | constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>, |
2129 | C<IO::AIO::MAP_LOCKED>, |
1931 | C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or |
2130 | C<IO::AIO::MAP_NORESERVE>, |
|
|
2131 | C<IO::AIO::MAP_POPULATE>, |
1932 | C<IO::AIO::MAP_NONBLOCK> |
2132 | C<IO::AIO::MAP_NONBLOCK>, |
|
|
2133 | C<IO::AIO::MAP_FIXED>, |
|
|
2134 | C<IO::AIO::MAP_GROWSDOWN>, |
|
|
2135 | C<IO::AIO::MAP_32BIT>, |
|
|
2136 | C<IO::AIO::MAP_HUGETLB> or |
|
|
2137 | C<IO::AIO::MAP_STACK>. |
1933 | |
2138 | |
1934 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
2139 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
1935 | |
2140 | |
1936 | C<$offset> is the offset from the start of the file - it generally must be |
2141 | C<$offset> is the offset from the start of the file - it generally must be |
1937 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
2142 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
… | |
… | |
1962 | |
2167 | |
1963 | Calls the C<munlockall> function. |
2168 | Calls the C<munlockall> function. |
1964 | |
2169 | |
1965 | On systems that do not implement C<munlockall>, this function returns |
2170 | On systems that do not implement C<munlockall>, this function returns |
1966 | ENOSYS, otherwise the return value of C<munlockall>. |
2171 | ENOSYS, otherwise the return value of C<munlockall>. |
|
|
2172 | |
|
|
2173 | =item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
|
|
2174 | |
|
|
2175 | Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or |
|
|
2176 | C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they |
|
|
2177 | should be the file offset. |
|
|
2178 | |
|
|
2179 | C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might |
|
|
2180 | silently corrupt the data in this case. |
|
|
2181 | |
|
|
2182 | The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>, |
|
|
2183 | C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and |
|
|
2184 | C<IO::AIO::SPLICE_F_GIFT>. |
|
|
2185 | |
|
|
2186 | See the C<splice(2)> manpage for details. |
|
|
2187 | |
|
|
2188 | =item IO::AIO::tee $r_fh, $w_fh, $length, $flags |
|
|
2189 | |
|
|
2190 | Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the |
|
|
2191 | description for C<IO::AIO::splice> above for details. |
|
|
2192 | |
|
|
2193 | =item $actual_size = IO::AIO::pipesize $r_fh[, $new_size] |
|
|
2194 | |
|
|
2195 | Attempts to query or change the pipe buffer size. Obviously works only |
|
|
2196 | on pipes, and currently works only on GNU/Linux systems, and fails with |
|
|
2197 | C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer |
|
|
2198 | size on other systems, drop me a note. |
|
|
2199 | |
|
|
2200 | =item ($rfh, $wfh) = IO::AIO::pipe2 [$flags] |
|
|
2201 | |
|
|
2202 | This is a direct interface to the Linux L<pipe2(2)> system call. If |
|
|
2203 | C<$flags> is missing or C<0>, then this should be the same as a call to |
|
|
2204 | perl's built-in C<pipe> function and create a new pipe, and works on |
|
|
2205 | systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe |
|
|
2206 | (..., 4096, O_BINARY)>. |
|
|
2207 | |
|
|
2208 | If C<$flags> is non-zero, it tries to invoke the pipe2 system call with |
|
|
2209 | the given flags (Linux 2.6.27, glibc 2.9). |
|
|
2210 | |
|
|
2211 | On success, the read and write file handles are returned. |
|
|
2212 | |
|
|
2213 | On error, nothing will be returned. If the pipe2 syscall is missing and |
|
|
2214 | C<$flags> is non-zero, fails with C<ENOSYS>. |
|
|
2215 | |
|
|
2216 | Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the |
|
|
2217 | time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and |
|
|
2218 | C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. |
1967 | |
2219 | |
1968 | =back |
2220 | =back |
1969 | |
2221 | |
1970 | =cut |
2222 | =cut |
1971 | |
2223 | |