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.1'; |
176 | our $VERSION = 4.52; |
174 | |
177 | |
175 | our @AIO_REQ = qw(aio_sendfile 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 |
182 | aio_pathsync aio_readahead aio_fiemap aio_allocate |
180 | aio_rename aio_link aio_move aio_copy aio_group |
183 | aio_rename aio_rename2 aio_link aio_move aio_copy aio_group |
181 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
184 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
182 | aio_chmod aio_utime aio_truncate |
185 | aio_chmod aio_utime aio_truncate |
183 | aio_msync aio_mtouch aio_mlock aio_mlockall |
186 | aio_msync aio_mtouch aio_mlock aio_mlockall |
184 | aio_statvfs |
187 | aio_statvfs |
|
|
188 | aio_slurp |
185 | aio_wd); |
189 | aio_wd); |
186 | |
190 | |
187 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
191 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
188 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
192 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
189 | min_parallel max_parallel max_idle idle_timeout |
193 | min_parallel max_parallel max_idle idle_timeout |
190 | nreqs nready npending nthreads |
194 | nreqs nready npending nthreads |
191 | max_poll_time max_poll_reqs |
195 | max_poll_time max_poll_reqs |
192 | sendfile fadvise madvise |
196 | sendfile fadvise madvise |
193 | mmap munmap munlock munlockall); |
197 | mmap munmap mremap munlock munlockall); |
194 | |
198 | |
195 | push @AIO_REQ, qw(aio_busy); # not exported |
199 | push @AIO_REQ, qw(aio_busy); # not exported |
196 | |
200 | |
197 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
201 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
198 | |
202 | |
… | |
… | |
202 | |
206 | |
203 | =head1 FUNCTIONS |
207 | =head1 FUNCTIONS |
204 | |
208 | |
205 | =head2 QUICK OVERVIEW |
209 | =head2 QUICK OVERVIEW |
206 | |
210 | |
207 | This section simply lists the prototypes of the most important functions |
211 | This section simply lists the prototypes most of the functions for |
208 | for quick reference. See the following sections for function-by-function |
212 | quick reference. See the following sections for function-by-function |
209 | documentation. |
213 | documentation. |
210 | |
214 | |
211 | aio_wd $pathname, $callback->($wd) |
215 | aio_wd $pathname, $callback->($wd) |
212 | aio_open $pathname, $flags, $mode, $callback->($fh) |
216 | aio_open $pathname, $flags, $mode, $callback->($fh) |
213 | aio_close $fh, $callback->($status) |
217 | aio_close $fh, $callback->($status) |
|
|
218 | aio_seek $fh,$offset,$whence, $callback->($offs) |
214 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
219 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
215 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
220 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
216 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
221 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
217 | aio_readahead $fh,$offset,$length, $callback->($retval) |
222 | aio_readahead $fh,$offset,$length, $callback->($retval) |
218 | aio_stat $fh_or_path, $callback->($status) |
223 | aio_stat $fh_or_path, $callback->($status) |
219 | aio_lstat $fh, $callback->($status) |
224 | aio_lstat $fh, $callback->($status) |
220 | aio_statvfs $fh_or_path, $callback->($statvfs) |
225 | aio_statvfs $fh_or_path, $callback->($statvfs) |
221 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
226 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
222 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
227 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
228 | aio_chmod $fh_or_path, $mode, $callback->($status) |
223 | aio_truncate $fh_or_path, $offset, $callback->($status) |
229 | aio_truncate $fh_or_path, $offset, $callback->($status) |
224 | aio_chmod $fh_or_path, $mode, $callback->($status) |
230 | aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
|
|
231 | aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) |
225 | aio_unlink $pathname, $callback->($status) |
232 | aio_unlink $pathname, $callback->($status) |
226 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
233 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
227 | aio_link $srcpath, $dstpath, $callback->($status) |
234 | aio_link $srcpath, $dstpath, $callback->($status) |
228 | aio_symlink $srcpath, $dstpath, $callback->($status) |
235 | aio_symlink $srcpath, $dstpath, $callback->($status) |
229 | aio_readlink $pathname, $callback->($link) |
236 | aio_readlink $pathname, $callback->($link) |
230 | aio_realpath $pathname, $callback->($link) |
237 | aio_realpath $pathname, $callback->($path) |
231 | aio_rename $srcpath, $dstpath, $callback->($status) |
238 | aio_rename $srcpath, $dstpath, $callback->($status) |
|
|
239 | aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
232 | aio_mkdir $pathname, $mode, $callback->($status) |
240 | aio_mkdir $pathname, $mode, $callback->($status) |
233 | aio_rmdir $pathname, $callback->($status) |
241 | aio_rmdir $pathname, $callback->($status) |
234 | aio_readdir $pathname, $callback->($entries) |
242 | aio_readdir $pathname, $callback->($entries) |
235 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
243 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
236 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
244 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
… | |
… | |
238 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
246 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
239 | aio_load $pathname, $data, $callback->($status) |
247 | aio_load $pathname, $data, $callback->($status) |
240 | aio_copy $srcpath, $dstpath, $callback->($status) |
248 | aio_copy $srcpath, $dstpath, $callback->($status) |
241 | aio_move $srcpath, $dstpath, $callback->($status) |
249 | aio_move $srcpath, $dstpath, $callback->($status) |
242 | aio_rmtree $pathname, $callback->($status) |
250 | aio_rmtree $pathname, $callback->($status) |
|
|
251 | aio_fcntl $fh, $cmd, $arg, $callback->($status) |
|
|
252 | aio_ioctl $fh, $request, $buf, $callback->($status) |
243 | aio_sync $callback->($status) |
253 | aio_sync $callback->($status) |
244 | aio_syncfs $fh, $callback->($status) |
254 | aio_syncfs $fh, $callback->($status) |
245 | aio_fsync $fh, $callback->($status) |
255 | aio_fsync $fh, $callback->($status) |
246 | aio_fdatasync $fh, $callback->($status) |
256 | aio_fdatasync $fh, $callback->($status) |
247 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
257 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
248 | aio_pathsync $pathname, $callback->($status) |
258 | aio_pathsync $pathname, $callback->($status) |
249 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
259 | aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
250 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
260 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
251 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
261 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
252 | aio_mlockall $flags, $callback->($status) |
262 | aio_mlockall $flags, $callback->($status) |
253 | aio_group $callback->(...) |
263 | aio_group $callback->(...) |
254 | aio_nop $callback->() |
264 | aio_nop $callback->() |
… | |
… | |
268 | IO::AIO::idle_timeout $seconds |
278 | IO::AIO::idle_timeout $seconds |
269 | IO::AIO::max_outstanding $maxreqs |
279 | IO::AIO::max_outstanding $maxreqs |
270 | IO::AIO::nreqs |
280 | IO::AIO::nreqs |
271 | IO::AIO::nready |
281 | IO::AIO::nready |
272 | IO::AIO::npending |
282 | IO::AIO::npending |
|
|
283 | $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL] |
|
|
284 | IO::AIO::min_fdlimit $nfd [EXPERIMENTAL] |
273 | |
285 | |
274 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
286 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
275 | IO::AIO::fadvise $fh, $offset, $len, $advice |
287 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
288 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
|
|
289 | IO::AIO::munmap $scalar |
|
|
290 | IO::AIO::mremap $scalar, $new_length, $flags[, $new_address] |
276 | IO::AIO::madvise $scalar, $offset, $length, $advice |
291 | IO::AIO::madvise $scalar, $offset, $length, $advice |
277 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
292 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
278 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
293 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
279 | IO::AIO::munlockall |
294 | IO::AIO::munlockall |
280 | |
295 | |
281 | =head2 AIO REQUEST FUNCTIONS |
296 | =head2 API NOTES |
282 | |
297 | |
283 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
298 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
284 | with the same name (sans C<aio_>). The arguments are similar or identical, |
299 | with the same name (sans C<aio_>). The arguments are similar or identical, |
285 | and they all accept an additional (and optional) C<$callback> argument |
300 | and they all accept an additional (and optional) C<$callback> argument |
286 | which must be a code reference. This code reference will be called after |
301 | which must be a code reference. This code reference will be called after |
… | |
… | |
317 | correct contents. |
332 | correct contents. |
318 | |
333 | |
319 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
334 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
320 | handles correctly whether it is set or not. |
335 | handles correctly whether it is set or not. |
321 | |
336 | |
|
|
337 | =head2 AIO REQUEST FUNCTIONS |
|
|
338 | |
322 | =over 4 |
339 | =over 4 |
323 | |
340 | |
324 | =item $prev_pri = aioreq_pri [$pri] |
341 | =item $prev_pri = aioreq_pri [$pri] |
325 | |
342 | |
326 | Returns the priority value that would be used for the next request and, if |
343 | Returns the priority value that would be used for the next request and, if |
… | |
… | |
355 | |
372 | |
356 | |
373 | |
357 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
374 | =item aio_open $pathname, $flags, $mode, $callback->($fh) |
358 | |
375 | |
359 | Asynchronously open or create a file and call the callback with a newly |
376 | Asynchronously open or create a file and call the callback with a newly |
360 | created filehandle for the file. |
377 | created filehandle for the file (or C<undef> in case of an error). |
361 | |
378 | |
362 | The pathname passed to C<aio_open> must be absolute. See API NOTES, above, |
379 | The pathname passed to C<aio_open> must be absolute. See API NOTES, above, |
363 | for an explanation. |
380 | for an explanation. |
364 | |
381 | |
365 | The C<$flags> argument is a bitmask. See the C<Fcntl> module for a |
382 | The C<$flags> argument is a bitmask. See the C<Fcntl> module for a |
… | |
… | |
388 | following POSIX and non-POSIX constants are available (missing ones on |
405 | following POSIX and non-POSIX constants are available (missing ones on |
389 | your system are, as usual, C<0>): |
406 | your system are, as usual, C<0>): |
390 | |
407 | |
391 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
408 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
392 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
409 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
393 | C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>. |
410 | C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>. |
394 | |
411 | |
395 | |
412 | |
396 | =item aio_close $fh, $callback->($status) |
413 | =item aio_close $fh, $callback->($status) |
397 | |
414 | |
398 | Asynchronously close a file and call the callback with the result |
415 | Asynchronously close a file and call the callback with the result |
… | |
… | |
408 | Or in other words: the file descriptor will be closed, but it will not be |
425 | Or in other words: the file descriptor will be closed, but it will not be |
409 | free for reuse until the perl filehandle is closed. |
426 | free for reuse until the perl filehandle is closed. |
410 | |
427 | |
411 | =cut |
428 | =cut |
412 | |
429 | |
|
|
430 | =item aio_seek $fh, $offset, $whence, $callback->($offs) |
|
|
431 | |
|
|
432 | Seeks the filehandle to the new C<$offset>, similarly to perl's |
|
|
433 | C<sysseek>. The C<$whence> can use the traditional values (C<0> for |
|
|
434 | C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for |
|
|
435 | C<IO::AIO::SEEK_END>). |
|
|
436 | |
|
|
437 | The resulting absolute offset will be passed to the callback, or C<-1> in |
|
|
438 | case of an error. |
|
|
439 | |
|
|
440 | In theory, the C<$whence> constants could be different than the |
|
|
441 | corresponding values from L<Fcntl>, but perl guarantees they are the same, |
|
|
442 | so don't panic. |
|
|
443 | |
|
|
444 | As a GNU/Linux (and maybe Solaris) extension, also the constants |
|
|
445 | C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they |
|
|
446 | could be found. No guarantees about suitability for use in C<aio_seek> or |
|
|
447 | Perl's C<sysseek> can be made though, although I would naively assume they |
|
|
448 | "just work". |
|
|
449 | |
413 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
450 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
414 | |
451 | |
415 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
452 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
416 | |
453 | |
417 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
454 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
418 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> |
455 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and |
419 | and calls the callback without the actual number of bytes read (or -1 on |
456 | calls the callback with the actual number of bytes transferred (or -1 on |
420 | error, just like the syscall). |
457 | error, just like the syscall). |
421 | |
458 | |
422 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
459 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
423 | offset plus the actual number of bytes read. |
460 | offset plus the actual number of bytes read. |
424 | |
461 | |
… | |
… | |
482 | As native sendfile syscalls (as practically any non-POSIX interface hacked |
519 | As native sendfile syscalls (as practically any non-POSIX interface hacked |
483 | together in a hurry to improve benchmark numbers) tend to be rather buggy |
520 | together in a hurry to improve benchmark numbers) tend to be rather buggy |
484 | on many systems, this implementation tries to work around some known bugs |
521 | on many systems, this implementation tries to work around some known bugs |
485 | in Linux and FreeBSD kernels (probably others, too), but that might fail, |
522 | in Linux and FreeBSD kernels (probably others, too), but that might fail, |
486 | so you really really should check the return value of C<aio_sendfile> - |
523 | so you really really should check the return value of C<aio_sendfile> - |
487 | fewre bytes than expected might have been transferred. |
524 | fewer bytes than expected might have been transferred. |
488 | |
525 | |
489 | |
526 | |
490 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
527 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
491 | |
528 | |
492 | C<aio_readahead> populates the page cache with data from a file so that |
529 | C<aio_readahead> populates the page cache with data from a file so that |
… | |
… | |
496 | whole pages, so that offset is effectively rounded down to a page boundary |
533 | whole pages, so that offset is effectively rounded down to a page boundary |
497 | and bytes are read up to the next page boundary greater than or equal to |
534 | and bytes are read up to the next page boundary greater than or equal to |
498 | (off-set+length). C<aio_readahead> does not read beyond the end of the |
535 | (off-set+length). C<aio_readahead> does not read beyond the end of the |
499 | file. The current file offset of the file is left unchanged. |
536 | file. The current file offset of the file is left unchanged. |
500 | |
537 | |
501 | If that syscall doesn't exist (likely if your OS isn't Linux) it will be |
538 | If that syscall doesn't exist (likely if your kernel isn't Linux) it will |
502 | emulated by simply reading the data, which would have a similar effect. |
539 | be emulated by simply reading the data, which would have a similar effect. |
503 | |
540 | |
504 | |
541 | |
505 | =item aio_stat $fh_or_path, $callback->($status) |
542 | =item aio_stat $fh_or_path, $callback->($status) |
506 | |
543 | |
507 | =item aio_lstat $fh, $callback->($status) |
544 | =item aio_lstat $fh, $callback->($status) |
… | |
… | |
523 | behaviour). |
560 | behaviour). |
524 | |
561 | |
525 | C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, |
562 | C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, |
526 | C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, |
563 | C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, |
527 | C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. |
564 | C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. |
|
|
565 | |
|
|
566 | To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME |
|
|
567 | ACCESS>. |
528 | |
568 | |
529 | Example: Print the length of F</etc/passwd>: |
569 | Example: Print the length of F</etc/passwd>: |
530 | |
570 | |
531 | aio_stat "/etc/passwd", sub { |
571 | aio_stat "/etc/passwd", sub { |
532 | $_[0] and die "stat failed: $!"; |
572 | $_[0] and die "stat failed: $!"; |
… | |
… | |
576 | namemax => 255, |
616 | namemax => 255, |
577 | frsize => 1024, |
617 | frsize => 1024, |
578 | fsid => 1810 |
618 | fsid => 1810 |
579 | } |
619 | } |
580 | |
620 | |
581 | |
|
|
582 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
621 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
583 | |
622 | |
584 | Works like perl's C<utime> function (including the special case of $atime |
623 | Works like perl's C<utime> function (including the special case of $atime |
585 | and $mtime being undef). Fractional times are supported if the underlying |
624 | and $mtime being undef). Fractional times are supported if the underlying |
586 | syscalls support them. |
625 | syscalls support them. |
… | |
… | |
613 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
652 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
614 | |
653 | |
615 | Works like truncate(2) or ftruncate(2). |
654 | Works like truncate(2) or ftruncate(2). |
616 | |
655 | |
617 | |
656 | |
|
|
657 | =item aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
|
|
658 | |
|
|
659 | Allocates or frees disk space according to the C<$mode> argument. See the |
|
|
660 | linux C<fallocate> documentation for details. |
|
|
661 | |
|
|
662 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
|
|
663 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
|
|
664 | to deallocate a file range. |
|
|
665 | |
|
|
666 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
|
|
667 | (without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range, |
|
|
668 | C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE> |
|
|
669 | to unshare shared blocks (see your L<fallocate(2)> manpage). |
|
|
670 | |
|
|
671 | The file system block size used by C<fallocate> is presumably the |
|
|
672 | C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes |
|
|
673 | can dictate other limitations. |
|
|
674 | |
|
|
675 | If C<fallocate> isn't available or cannot be emulated (currently no |
|
|
676 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
|
|
677 | |
|
|
678 | |
618 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
679 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
619 | |
680 | |
620 | Works like perl's C<chmod> function. |
681 | Works like perl's C<chmod> function. |
621 | |
682 | |
622 | |
683 | |
… | |
… | |
659 | |
720 | |
660 | |
721 | |
661 | =item aio_realpath $pathname, $callback->($path) |
722 | =item aio_realpath $pathname, $callback->($path) |
662 | |
723 | |
663 | Asynchronously make the path absolute and resolve any symlinks in |
724 | Asynchronously make the path absolute and resolve any symlinks in |
664 | C<$path>. The resulting path only consists of directories (Same as |
725 | C<$path>. The resulting path only consists of directories (same as |
665 | L<Cwd::realpath>). |
726 | L<Cwd::realpath>). |
666 | |
727 | |
667 | This request can be used to get the absolute path of the current working |
728 | This request can be used to get the absolute path of the current working |
668 | directory by passing it a path of F<.> (a single dot). |
729 | directory by passing it a path of F<.> (a single dot). |
669 | |
730 | |
670 | |
731 | |
671 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
732 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
672 | |
733 | |
673 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
734 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
674 | rename(2) and call the callback with the result code. |
735 | rename(2) and call the callback with the result code. |
|
|
736 | |
|
|
737 | On systems that support the AIO::WD working directory abstraction |
|
|
738 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
|
|
739 | of failing, C<rename> is called on the absolute path of C<$wd>. |
|
|
740 | |
|
|
741 | |
|
|
742 | =item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
|
|
743 | |
|
|
744 | Basically a version of C<aio_rename> with an additional C<$flags> |
|
|
745 | argument. Calling this with C<$flags=0> is the same as calling |
|
|
746 | C<aio_rename>. |
|
|
747 | |
|
|
748 | Non-zero flags are currently only supported on GNU/Linux systems that |
|
|
749 | support renameat2. Other systems fail with C<ENOSYS> in this case. |
|
|
750 | |
|
|
751 | The following constants are available (missing ones are, as usual C<0>), |
|
|
752 | see renameat2(2) for details: |
|
|
753 | |
|
|
754 | C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE> |
|
|
755 | and C<IO::AIO::RENAME_WHITEOUT>. |
675 | |
756 | |
676 | |
757 | |
677 | =item aio_mkdir $pathname, $mode, $callback->($status) |
758 | =item aio_mkdir $pathname, $mode, $callback->($status) |
678 | |
759 | |
679 | Asynchronously mkdir (create) a directory and call the callback with |
760 | Asynchronously mkdir (create) a directory and call the callback with |
… | |
… | |
684 | =item aio_rmdir $pathname, $callback->($status) |
765 | =item aio_rmdir $pathname, $callback->($status) |
685 | |
766 | |
686 | Asynchronously rmdir (delete) a directory and call the callback with the |
767 | Asynchronously rmdir (delete) a directory and call the callback with the |
687 | result code. |
768 | result code. |
688 | |
769 | |
|
|
770 | On systems that support the AIO::WD working directory abstraction |
|
|
771 | natively, the case C<[$wd, "."]> is specialcased - instead of failing, |
|
|
772 | C<rmdir> is called on the absolute path of C<$wd>. |
|
|
773 | |
689 | |
774 | |
690 | =item aio_readdir $pathname, $callback->($entries) |
775 | =item aio_readdir $pathname, $callback->($entries) |
691 | |
776 | |
692 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
777 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
693 | directory (i.e. opendir + readdir + closedir). The entries will not be |
778 | directory (i.e. opendir + readdir + closedir). The entries will not be |
… | |
… | |
708 | |
793 | |
709 | =over 4 |
794 | =over 4 |
710 | |
795 | |
711 | =item IO::AIO::READDIR_DENTS |
796 | =item IO::AIO::READDIR_DENTS |
712 | |
797 | |
713 | When this flag is off, then the callback gets an arrayref consisting of |
798 | Normally the callback gets an arrayref consisting of names only (as |
714 | names only (as with C<aio_readdir>), otherwise it gets an arrayref with |
799 | with C<aio_readdir>). If this flag is set, then the callback gets an |
715 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
800 | arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a |
716 | entry in more detail. |
801 | single directory entry in more detail: |
717 | |
802 | |
718 | C<$name> is the name of the entry. |
803 | C<$name> is the name of the entry. |
719 | |
804 | |
720 | C<$type> is one of the C<IO::AIO::DT_xxx> constants: |
805 | C<$type> is one of the C<IO::AIO::DT_xxx> constants: |
721 | |
806 | |
722 | C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, |
807 | C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, |
723 | C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, |
808 | C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, |
724 | C<IO::AIO::DT_WHT>. |
809 | C<IO::AIO::DT_WHT>. |
725 | |
810 | |
726 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to |
811 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need |
727 | know, you have to run stat yourself. Also, for speed reasons, the C<$type> |
812 | to know, you have to run stat yourself. Also, for speed/memory reasons, |
728 | scalars are read-only: you can not modify them. |
813 | the C<$type> scalars are read-only: you must not modify them. |
729 | |
814 | |
730 | C<$inode> is the inode number (which might not be exact on systems with 64 |
815 | C<$inode> is the inode number (which might not be exact on systems with 64 |
731 | bit inode numbers and 32 bit perls). This field has unspecified content on |
816 | bit inode numbers and 32 bit perls). This field has unspecified content on |
732 | systems that do not deliver the inode information. |
817 | systems that do not deliver the inode information. |
733 | |
818 | |
… | |
… | |
744 | short names are tried first. |
829 | short names are tried first. |
745 | |
830 | |
746 | =item IO::AIO::READDIR_STAT_ORDER |
831 | =item IO::AIO::READDIR_STAT_ORDER |
747 | |
832 | |
748 | When this flag is set, then the names will be returned in an order |
833 | When this flag is set, then the names will be returned in an order |
749 | suitable for stat()'ing each one. That is, when you plan to stat() |
834 | suitable for stat()'ing each one. That is, when you plan to stat() most or |
750 | all files in the given directory, then the returned order will likely |
835 | all files in the given directory, then the returned order will likely be |
751 | be fastest. |
836 | faster. |
752 | |
837 | |
753 | If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then |
838 | If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, |
754 | the likely dirs come first, resulting in a less optimal stat order. |
839 | then the likely dirs come first, resulting in a less optimal stat order |
|
|
840 | for stat'ing all entries, but likely a more optimal order for finding |
|
|
841 | subdirectories. |
755 | |
842 | |
756 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
843 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
757 | |
844 | |
758 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
845 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
759 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
846 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
… | |
… | |
761 | C<$type>'s are known, which can be used to speed up some algorithms. |
848 | C<$type>'s are known, which can be used to speed up some algorithms. |
762 | |
849 | |
763 | =back |
850 | =back |
764 | |
851 | |
765 | |
852 | |
|
|
853 | =item aio_slurp $pathname, $offset, $length, $data, $callback->($status) |
|
|
854 | |
|
|
855 | Opens, reads and closes the given file. The data is put into C<$data>, |
|
|
856 | which is resized as required. |
|
|
857 | |
|
|
858 | If C<$offset> is negative, then it is counted from the end of the file. |
|
|
859 | |
|
|
860 | If C<$length> is zero, then the remaining length of the file is |
|
|
861 | used. Also, in this case, the same limitations to modifying C<$data> apply |
|
|
862 | as when IO::AIO::mmap is used, i.e. it must only be modified in-place |
|
|
863 | with C<substr>. If the size of the file is known, specifying a non-zero |
|
|
864 | C<$length> results in a performance advantage. |
|
|
865 | |
|
|
866 | This request is similar to the older C<aio_load> request, but since it is |
|
|
867 | a single request, it might be more efficient to use. |
|
|
868 | |
|
|
869 | Example: load F</etc/passwd> into C<$passwd>. |
|
|
870 | |
|
|
871 | my $passwd; |
|
|
872 | aio_slurp "/etc/passwd", 0, 0, $passwd, sub { |
|
|
873 | $_[0] >= 0 |
|
|
874 | or die "/etc/passwd: $!\n"; |
|
|
875 | |
|
|
876 | printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd; |
|
|
877 | print $passwd; |
|
|
878 | }; |
|
|
879 | IO::AIO::flush; |
|
|
880 | |
|
|
881 | |
766 | =item aio_load $pathname, $data, $callback->($status) |
882 | =item aio_load $pathname, $data, $callback->($status) |
767 | |
883 | |
768 | This is a composite request that tries to fully load the given file into |
884 | This is a composite request that tries to fully load the given file into |
769 | memory. Status is the same as with aio_read. |
885 | memory. Status is the same as with aio_read. |
|
|
886 | |
|
|
887 | Using C<aio_slurp> might be more efficient, as it is a single request. |
770 | |
888 | |
771 | =cut |
889 | =cut |
772 | |
890 | |
773 | sub aio_load($$;$) { |
891 | sub aio_load($$;$) { |
774 | my ($path, undef, $cb) = @_; |
892 | my ($path, undef, $cb) = @_; |
… | |
… | |
794 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
912 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
795 | |
913 | |
796 | Try to copy the I<file> (directories not supported as either source or |
914 | Try to copy the I<file> (directories not supported as either source or |
797 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
915 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
798 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
916 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
|
|
917 | |
|
|
918 | Existing destination files will be truncated. |
799 | |
919 | |
800 | This is a composite request that creates the destination file with |
920 | This is a composite request that creates the destination file with |
801 | mode 0200 and copies the contents of the source file into it using |
921 | mode 0200 and copies the contents of the source file into it using |
802 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
922 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
803 | uid/gid, in that order. |
923 | uid/gid, in that order. |
… | |
… | |
913 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
1033 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
914 | efficiently separate the entries of directory C<$path> into two sets of |
1034 | efficiently separate the entries of directory C<$path> into two sets of |
915 | names, directories you can recurse into (directories), and ones you cannot |
1035 | names, directories you can recurse into (directories), and ones you cannot |
916 | recurse into (everything else, including symlinks to directories). |
1036 | recurse into (everything else, including symlinks to directories). |
917 | |
1037 | |
918 | C<aio_scandir> is a composite request that creates of many sub requests_ |
1038 | C<aio_scandir> is a composite request that generates many sub requests. |
919 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
1039 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
920 | this function generates. If it is C<< <= 0 >>, then a suitable default |
1040 | this function generates. If it is C<< <= 0 >>, then a suitable default |
921 | will be chosen (currently 4). |
1041 | will be chosen (currently 4). |
922 | |
1042 | |
923 | On error, the callback is called without arguments, otherwise it receives |
1043 | On error, the callback is called without arguments, otherwise it receives |
… | |
… | |
1057 | } |
1177 | } |
1058 | |
1178 | |
1059 | =item aio_rmtree $pathname, $callback->($status) |
1179 | =item aio_rmtree $pathname, $callback->($status) |
1060 | |
1180 | |
1061 | Delete a directory tree starting (and including) C<$path>, return the |
1181 | Delete a directory tree starting (and including) C<$path>, return the |
1062 | status of the final C<rmdir> only. This is a composite request that |
1182 | status of the final C<rmdir> only. This is a composite request that |
1063 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
1183 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
1064 | everything else. |
1184 | everything else. |
1065 | |
1185 | |
1066 | =cut |
1186 | =cut |
1067 | |
1187 | |
… | |
… | |
1088 | add $grp $dirgrp; |
1208 | add $grp $dirgrp; |
1089 | }; |
1209 | }; |
1090 | |
1210 | |
1091 | $grp |
1211 | $grp |
1092 | } |
1212 | } |
|
|
1213 | |
|
|
1214 | =item aio_fcntl $fh, $cmd, $arg, $callback->($status) |
|
|
1215 | |
|
|
1216 | =item aio_ioctl $fh, $request, $buf, $callback->($status) |
|
|
1217 | |
|
|
1218 | These work just like the C<fcntl> and C<ioctl> built-in functions, except |
|
|
1219 | they execute asynchronously and pass the return value to the callback. |
|
|
1220 | |
|
|
1221 | Both calls can be used for a lot of things, some of which make more sense |
|
|
1222 | to run asynchronously in their own thread, while some others make less |
|
|
1223 | sense. For example, calls that block waiting for external events, such |
|
|
1224 | as locking, will also lock down an I/O thread while it is waiting, which |
|
|
1225 | can deadlock the whole I/O system. At the same time, there might be no |
|
|
1226 | alternative to using a thread to wait. |
|
|
1227 | |
|
|
1228 | So in general, you should only use these calls for things that do |
|
|
1229 | (filesystem) I/O, not for things that wait for other events (network, |
|
|
1230 | other processes), although if you are careful and know what you are doing, |
|
|
1231 | you still can. |
|
|
1232 | |
|
|
1233 | The following constants are available (missing ones are, as usual C<0>): |
|
|
1234 | |
|
|
1235 | C<F_DUPFD_CLOEXEC>, |
|
|
1236 | |
|
|
1237 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
|
|
1238 | |
|
|
1239 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
|
|
1240 | |
|
|
1241 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
|
|
1242 | C<FS_IOC_FIEMAP>. |
|
|
1243 | |
|
|
1244 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
|
|
1245 | C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>. |
|
|
1246 | |
|
|
1247 | C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>, |
|
|
1248 | C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>, |
|
|
1249 | C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>, |
|
|
1250 | C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>, |
|
|
1251 | C<FS_FL_USER_MODIFIABLE>. |
|
|
1252 | |
|
|
1253 | C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>, |
|
|
1254 | C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>, |
|
|
1255 | C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>, |
|
|
1256 | C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>, |
1093 | |
1257 | |
1094 | =item aio_sync $callback->($status) |
1258 | =item aio_sync $callback->($status) |
1095 | |
1259 | |
1096 | Asynchronously call sync and call the callback when finished. |
1260 | Asynchronously call sync and call the callback when finished. |
1097 | |
1261 | |
… | |
… | |
1166 | }; |
1330 | }; |
1167 | |
1331 | |
1168 | $grp |
1332 | $grp |
1169 | } |
1333 | } |
1170 | |
1334 | |
1171 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1335 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
1172 | |
1336 | |
1173 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
1337 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
1174 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
1338 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
1175 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
1339 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
1176 | scalar must only be modified in-place while an aio operation is pending on |
1340 | scalar must only be modified in-place while an aio operation is pending on |
… | |
… | |
1178 | |
1342 | |
1179 | It calls the C<msync> function of your OS, if available, with the memory |
1343 | It calls the C<msync> function of your OS, if available, with the memory |
1180 | area starting at C<$offset> in the string and ending C<$length> bytes |
1344 | area starting at C<$offset> in the string and ending C<$length> bytes |
1181 | later. If C<$length> is negative, counts from the end, and if C<$length> |
1345 | later. If C<$length> is negative, counts from the end, and if C<$length> |
1182 | is C<undef>, then it goes till the end of the string. The flags can be |
1346 | is C<undef>, then it goes till the end of the string. The flags can be |
1183 | a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and |
1347 | either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional |
1184 | C<IO::AIO::MS_SYNC>. |
1348 | C<IO::AIO::MS_INVALIDATE>. |
1185 | |
1349 | |
1186 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1350 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1187 | |
1351 | |
1188 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1352 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1189 | scalars. |
1353 | scalars. |
1190 | |
1354 | |
1191 | It touches (reads or writes) all memory pages in the specified |
1355 | It touches (reads or writes) all memory pages in the specified |
1192 | range inside the scalar. All caveats and parameters are the same |
1356 | range inside the scalar. All caveats and parameters are the same |
1193 | as for C<aio_msync>, above, except for flags, which must be either |
1357 | as for C<aio_msync>, above, except for flags, which must be either |
1194 | C<0> (which reads all pages and ensures they are instantiated) or |
1358 | C<0> (which reads all pages and ensures they are instantiated) or |
1195 | C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and |
1359 | C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and |
1196 | writing an octet from it, which dirties the page). |
1360 | writing an octet from it, which dirties the page). |
1197 | |
1361 | |
1198 | =item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
1362 | =item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
1199 | |
1363 | |
1200 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1364 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
… | |
… | |
1231 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1395 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1232 | |
1396 | |
1233 | Example: asynchronously lock all current and future pages into memory. |
1397 | Example: asynchronously lock all current and future pages into memory. |
1234 | |
1398 | |
1235 | aio_mlockall IO::AIO::MCL_FUTURE; |
1399 | aio_mlockall IO::AIO::MCL_FUTURE; |
|
|
1400 | |
|
|
1401 | =item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) |
|
|
1402 | |
|
|
1403 | Queries the extents of the given file (by calling the Linux C<FIEMAP> |
|
|
1404 | ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If |
|
|
1405 | the ioctl is not available on your OS, then this request will fail with |
|
|
1406 | C<ENOSYS>. |
|
|
1407 | |
|
|
1408 | C<$start> is the starting offset to query extents for, C<$length> is the |
|
|
1409 | size of the range to query - if it is C<undef>, then the whole file will |
|
|
1410 | be queried. |
|
|
1411 | |
|
|
1412 | C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or |
|
|
1413 | C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also |
|
|
1414 | exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query |
|
|
1415 | the data portion. |
|
|
1416 | |
|
|
1417 | C<$count> is the maximum number of extent records to return. If it is |
|
|
1418 | C<undef>, then IO::AIO queries all extents of the range. As a very special |
|
|
1419 | case, if it is C<0>, then the callback receives the number of extents |
|
|
1420 | instead of the extents themselves (which is unreliable, see below). |
|
|
1421 | |
|
|
1422 | If an error occurs, the callback receives no arguments. The special |
|
|
1423 | C<errno> value C<IO::AIO::EBADR> is available to test for flag errors. |
|
|
1424 | |
|
|
1425 | Otherwise, the callback receives an array reference with extent |
|
|
1426 | structures. Each extent structure is an array reference itself, with the |
|
|
1427 | following members: |
|
|
1428 | |
|
|
1429 | [$logical, $physical, $length, $flags] |
|
|
1430 | |
|
|
1431 | Flags is any combination of the following flag values (typically either C<0> |
|
|
1432 | or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)): |
|
|
1433 | |
|
|
1434 | C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>, |
|
|
1435 | C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>, |
|
|
1436 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
|
|
1437 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
|
|
1438 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
|
|
1439 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
|
|
1440 | |
|
|
1441 | At the time of this writing (Linux 3.2), this request is unreliable unless |
|
|
1442 | C<$count> is C<undef>, as the kernel has all sorts of bugs preventing |
|
|
1443 | it to return all extents of a range for files with a large number of |
|
|
1444 | extents. The code (only) works around all these issues if C<$count> is |
|
|
1445 | C<undef>. |
1236 | |
1446 | |
1237 | =item aio_group $callback->(...) |
1447 | =item aio_group $callback->(...) |
1238 | |
1448 | |
1239 | This is a very special aio request: Instead of doing something, it is a |
1449 | This is a very special aio request: Instead of doing something, it is a |
1240 | container for other aio requests, which is useful if you want to bundle |
1450 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
1324 | aio_stat [$etcdir, "passwd"], sub { |
1534 | aio_stat [$etcdir, "passwd"], sub { |
1325 | # yay |
1535 | # yay |
1326 | }; |
1536 | }; |
1327 | }; |
1537 | }; |
1328 | |
1538 | |
1329 | That C<aio_wd> is a request and not a normal function shows that creating |
1539 | The fact that C<aio_wd> is a request and not a normal function shows that |
1330 | an IO::AIO::WD object is itself a potentially blocking operation, which is |
1540 | creating an IO::AIO::WD object is itself a potentially blocking operation, |
1331 | why it is done asynchronously. |
1541 | which is why it is done asynchronously. |
1332 | |
1542 | |
1333 | To stat the directory obtained with C<aio_wd> above, one could write |
1543 | To stat the directory obtained with C<aio_wd> above, one could write |
1334 | either of the following three request calls: |
1544 | either of the following three request calls: |
1335 | |
1545 | |
1336 | aio_lstat "/etc" , sub { ... # pathname as normal string |
1546 | aio_lstat "/etc" , sub { ... # pathname as normal string |
… | |
… | |
1353 | There are some caveats: when directories get renamed (or deleted), the |
1563 | There are some caveats: when directories get renamed (or deleted), the |
1354 | pathname string doesn't change, so will point to the new directory (or |
1564 | pathname string doesn't change, so will point to the new directory (or |
1355 | nowhere at all), while the directory fd, if available on the system, |
1565 | nowhere at all), while the directory fd, if available on the system, |
1356 | will still point to the original directory. Most functions accepting a |
1566 | will still point to the original directory. Most functions accepting a |
1357 | pathname will use the directory fd on newer systems, and the string on |
1567 | pathname will use the directory fd on newer systems, and the string on |
1358 | older systems. Some functions (such as realpath) will always rely on the |
1568 | older systems. Some functions (such as C<aio_realpath>) will always rely on |
1359 | string form of the pathname. |
1569 | the string form of the pathname. |
1360 | |
1570 | |
1361 | So this fucntionality is mainly useful to get some protection against |
1571 | So this functionality is mainly useful to get some protection against |
1362 | C<chdir>, to easily get an absolute path out of a relative path for future |
1572 | C<chdir>, to easily get an absolute path out of a relative path for future |
1363 | reference, and to speed up doing many operations in the same directory |
1573 | reference, and to speed up doing many operations in the same directory |
1364 | (e.g. when stat'ing all files in a directory). |
1574 | (e.g. when stat'ing all files in a directory). |
1365 | |
1575 | |
1366 | The following functions implement this working directory abstraction: |
1576 | The following functions implement this working directory abstraction: |
… | |
… | |
1379 | passing C<undef> as working directory component of a pathname fails the |
1589 | passing C<undef> as working directory component of a pathname fails the |
1380 | request with C<ENOENT>, there is often no need for error checking in the |
1590 | request with C<ENOENT>, there is often no need for error checking in the |
1381 | C<aio_wd> callback, as future requests using the value will fail in the |
1591 | C<aio_wd> callback, as future requests using the value will fail in the |
1382 | expected way. |
1592 | expected way. |
1383 | |
1593 | |
1384 | If this call isn't available because your OS lacks it or it couldn't be |
|
|
1385 | detected, it will be emulated by calling C<fsync> instead. |
|
|
1386 | |
|
|
1387 | =item IO::AIO::CWD |
1594 | =item IO::AIO::CWD |
1388 | |
1595 | |
1389 | This is a compiletime constant (object) that represents the process |
1596 | This is a compiletime constant (object) that represents the process |
1390 | current working directory. |
1597 | current working directory. |
1391 | |
1598 | |
1392 | Specifying this object as working directory object for a pathname is as |
1599 | Specifying this object as working directory object for a pathname is as if |
1393 | if the pathname would be specified directly, without a directory object, |
1600 | the pathname would be specified directly, without a directory object. For |
1394 | e.g., these calls are functionally identical: |
1601 | example, these calls are functionally identical: |
1395 | |
1602 | |
1396 | aio_stat "somefile", sub { ... }; |
1603 | aio_stat "somefile", sub { ... }; |
1397 | aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; |
1604 | aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; |
1398 | |
1605 | |
1399 | =back |
1606 | =back |
1400 | |
1607 | |
|
|
1608 | To recover the path associated with an IO::AIO::WD object, you can use |
|
|
1609 | C<aio_realpath>: |
|
|
1610 | |
|
|
1611 | aio_realpath $wd, sub { |
|
|
1612 | warn "path is $_[0]\n"; |
|
|
1613 | }; |
|
|
1614 | |
|
|
1615 | Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir> |
|
|
1616 | sometimes, fall back to using an absolue path. |
1401 | |
1617 | |
1402 | =head2 IO::AIO::REQ CLASS |
1618 | =head2 IO::AIO::REQ CLASS |
1403 | |
1619 | |
1404 | All non-aggregate C<aio_*> functions return an object of this class when |
1620 | All non-aggregate C<aio_*> functions return an object of this class when |
1405 | called in non-void context. |
1621 | called in non-void context. |
… | |
… | |
1583 | |
1799 | |
1584 | See C<poll_cb> for an example. |
1800 | See C<poll_cb> for an example. |
1585 | |
1801 | |
1586 | =item IO::AIO::poll_cb |
1802 | =item IO::AIO::poll_cb |
1587 | |
1803 | |
1588 | Process some outstanding events on the result pipe. You have to call |
1804 | Process some requests that have reached the result phase (i.e. they have |
|
|
1805 | been executed but the results are not yet reported). You have to call |
|
|
1806 | this "regularly" to finish outstanding requests. |
|
|
1807 | |
1589 | this regularly. Returns C<0> if all events could be processed (or there |
1808 | Returns C<0> if all events could be processed (or there were no |
1590 | were no events to process), or C<-1> if it returned earlier for whatever |
1809 | events to process), or C<-1> if it returned earlier for whatever |
1591 | reason. Returns immediately when no events are outstanding. The amount of |
1810 | reason. Returns immediately when no events are outstanding. The amount |
1592 | events processed depends on the settings of C<IO::AIO::max_poll_req> and |
1811 | of events processed depends on the settings of C<IO::AIO::max_poll_req>, |
1593 | C<IO::AIO::max_poll_time>. |
1812 | C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>. |
1594 | |
1813 | |
1595 | If not all requests were processed for whatever reason, the filehandle |
1814 | If not all requests were processed for whatever reason, the poll file |
1596 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1815 | descriptor will still be ready when C<poll_cb> returns, so normally you |
1597 | do anything special to have it called later. |
1816 | don't have to do anything special to have it called later. |
1598 | |
1817 | |
1599 | Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes |
1818 | Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes |
1600 | ready, it can be beneficial to call this function from loops which submit |
1819 | ready, it can be beneficial to call this function from loops which submit |
1601 | a lot of requests, to make sure the results get processed when they become |
1820 | a lot of requests, to make sure the results get processed when they become |
1602 | available and not just when the loop is finished and the event loop takes |
1821 | available and not just when the loop is finished and the event loop takes |
… | |
… | |
1611 | poll => 'r', async => 1, |
1830 | poll => 'r', async => 1, |
1612 | cb => \&IO::AIO::poll_cb); |
1831 | cb => \&IO::AIO::poll_cb); |
1613 | |
1832 | |
1614 | =item IO::AIO::poll_wait |
1833 | =item IO::AIO::poll_wait |
1615 | |
1834 | |
1616 | If there are any outstanding requests and none of them in the result |
1835 | Wait until either at least one request is in the result phase or no |
1617 | phase, wait till the result filehandle becomes ready for reading (simply |
1836 | requests are outstanding anymore. |
1618 | does a C<select> on the filehandle. This is useful if you want to |
1837 | |
1619 | synchronously wait for some requests to finish). |
1838 | This is useful if you want to synchronously wait for some requests to |
|
|
1839 | become ready, without actually handling them. |
1620 | |
1840 | |
1621 | See C<nreqs> for an example. |
1841 | See C<nreqs> for an example. |
1622 | |
1842 | |
1623 | =item IO::AIO::poll |
1843 | =item IO::AIO::poll |
1624 | |
1844 | |
… | |
… | |
1745 | |
1965 | |
1746 | This is a very bad function to use in interactive programs because it |
1966 | This is a very bad function to use in interactive programs because it |
1747 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1967 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1748 | use an C<aio_group> together with a feed callback. |
1968 | use an C<aio_group> together with a feed callback. |
1749 | |
1969 | |
1750 | It's main use is in scripts without an event loop - when you want to stat |
1970 | Its main use is in scripts without an event loop - when you want to stat |
1751 | a lot of files, you can write somehting like this: |
1971 | a lot of files, you can write something like this: |
1752 | |
1972 | |
1753 | IO::AIO::max_outstanding 32; |
1973 | IO::AIO::max_outstanding 32; |
1754 | |
1974 | |
1755 | for my $path (...) { |
1975 | for my $path (...) { |
1756 | aio_stat $path , ...; |
1976 | aio_stat $path , ...; |
… | |
… | |
1793 | Returns the number of requests currently in the pending state (executed, |
2013 | Returns the number of requests currently in the pending state (executed, |
1794 | but not yet processed by poll_cb). |
2014 | but not yet processed by poll_cb). |
1795 | |
2015 | |
1796 | =back |
2016 | =back |
1797 | |
2017 | |
|
|
2018 | =head3 SUBSECOND STAT TIME ACCESS |
|
|
2019 | |
|
|
2020 | Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can |
|
|
2021 | generally find access/modification and change times with subsecond time |
|
|
2022 | accuracy of the system supports it, but perl's built-in functions only |
|
|
2023 | return the integer part. |
|
|
2024 | |
|
|
2025 | The following functions return the timestamps of the most recent |
|
|
2026 | stat with subsecond precision on most systems and work both after |
|
|
2027 | C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return |
|
|
2028 | value is only meaningful after a successful C<stat>/C<lstat> call, or |
|
|
2029 | during/after a successful C<aio_stat>/C<aio_lstat> callback. |
|
|
2030 | |
|
|
2031 | This is similar to the L<Time::HiRes> C<stat> functions, but can return |
|
|
2032 | full resolution without rounding and work with standard perl C<stat>, |
|
|
2033 | alleviating the need to call the special C<Time::HiRes> functions, which |
|
|
2034 | do not act like their perl counterparts. |
|
|
2035 | |
|
|
2036 | On operating systems or file systems where subsecond time resolution is |
|
|
2037 | not supported or could not be detected, a fractional part of C<0> is |
|
|
2038 | returned, so it is always safe to call these functions. |
|
|
2039 | |
|
|
2040 | =over 4 |
|
|
2041 | |
|
|
2042 | =item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime |
|
|
2043 | |
|
|
2044 | Return the access, modication or change time, respectively, including |
|
|
2045 | fractional part. Due to the limited precision of floating point, the |
|
|
2046 | accuracy on most platforms is only a bit better than milliseconds for |
|
|
2047 | times around now - see the I<nsec> function family, below, for full |
|
|
2048 | accuracy. |
|
|
2049 | |
|
|
2050 | =item ($atime, $mtime, $ctime, ...) = IO::AIO::st_xtime |
|
|
2051 | |
|
|
2052 | Returns access, modification and change time all in one go, and maybe more |
|
|
2053 | times in the future version. |
|
|
2054 | |
|
|
2055 | =item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec |
|
|
2056 | |
|
|
2057 | Return the fractional access, modifcation or change time, in nanoseconds, |
|
|
2058 | as an integer in the range C<0> to C<999999999>. |
|
|
2059 | |
|
|
2060 | =item ($atime, $mtime, $ctime, ...) = IO::AIO::st_xtimensec |
|
|
2061 | |
|
|
2062 | Like the functions above, but returns all three times in one go (and maybe |
|
|
2063 | more in future versions). |
|
|
2064 | |
|
|
2065 | =back |
|
|
2066 | |
|
|
2067 | Example: print the high resolution modification time of F</etc>, using |
|
|
2068 | C<stat>, and C<IO::AIO::aio_stat>. |
|
|
2069 | |
|
|
2070 | if (stat "/etc") { |
|
|
2071 | printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime; |
|
|
2072 | } |
|
|
2073 | |
|
|
2074 | IO::AIO::aio_stat "/etc", sub { |
|
|
2075 | $_[0] |
|
|
2076 | and return; |
|
|
2077 | |
|
|
2078 | printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec; |
|
|
2079 | }; |
|
|
2080 | |
|
|
2081 | IO::AIO::flush; |
|
|
2082 | |
|
|
2083 | Output of the awbove on my system, showing reduced and full accuracy: |
|
|
2084 | |
|
|
2085 | stat(/etc) mtime: 1534043702.020808 |
|
|
2086 | aio_stat(/etc) mtime: 1534043702.020807792 |
|
|
2087 | |
1798 | =head3 MISCELLANEOUS FUNCTIONS |
2088 | =head3 MISCELLANEOUS FUNCTIONS |
1799 | |
2089 | |
1800 | IO::AIO implements some functions that might be useful, but are not |
2090 | IO::AIO implements some functions that are useful when you want to use |
1801 | asynchronous. |
2091 | some "Advanced I/O" function not available to in Perl, without going the |
|
|
2092 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
|
|
2093 | counterpart. |
1802 | |
2094 | |
1803 | =over 4 |
2095 | =over 4 |
|
|
2096 | |
|
|
2097 | =item $numfd = IO::AIO::get_fdlimit |
|
|
2098 | |
|
|
2099 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2100 | |
|
|
2101 | Tries to find the current file descriptor limit and returns it, or |
|
|
2102 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
|
|
2103 | the highest valid file descriptor number. |
|
|
2104 | |
|
|
2105 | =item IO::AIO::min_fdlimit [$numfd] |
|
|
2106 | |
|
|
2107 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2108 | |
|
|
2109 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
|
|
2110 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
|
|
2111 | is missing, it will try to set a very high limit, although this is not |
|
|
2112 | recommended when you know the actual minimum that you require. |
|
|
2113 | |
|
|
2114 | If the limit cannot be raised enough, the function makes a best-effort |
|
|
2115 | attempt to increase the limit as much as possible, using various |
|
|
2116 | tricks, while still failing. You can query the resulting limit using |
|
|
2117 | C<IO::AIO::get_fdlimit>. |
|
|
2118 | |
|
|
2119 | If an error occurs, returns C<undef> and sets C<$!>, otherwise returns |
|
|
2120 | true. |
1804 | |
2121 | |
1805 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2122 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
1806 | |
2123 | |
1807 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
2124 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
1808 | but is blocking (this makes most sense if you know the input data is |
2125 | but is blocking (this makes most sense if you know the input data is |
… | |
… | |
1825 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2142 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
1826 | |
2143 | |
1827 | Simply calls the C<posix_madvise> function (see its |
2144 | Simply calls the C<posix_madvise> function (see its |
1828 | manpage for details). The following advice constants are |
2145 | manpage for details). The following advice constants are |
1829 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2146 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
1830 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. |
2147 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, |
|
|
2148 | C<IO::AIO::MADV_DONTNEED>. |
|
|
2149 | |
|
|
2150 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2151 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2152 | will be reduced to fit into the C<$scalar>. |
1831 | |
2153 | |
1832 | On systems that do not implement C<posix_madvise>, this function returns |
2154 | On systems that do not implement C<posix_madvise>, this function returns |
1833 | ENOSYS, otherwise the return value of C<posix_madvise>. |
2155 | ENOSYS, otherwise the return value of C<posix_madvise>. |
1834 | |
2156 | |
1835 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
2157 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
… | |
… | |
1837 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
2159 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
1838 | $scalar (see its manpage for details). The following protect |
2160 | $scalar (see its manpage for details). The following protect |
1839 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
2161 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
1840 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
2162 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
1841 | |
2163 | |
|
|
2164 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2165 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2166 | will be reduced to fit into the C<$scalar>. |
|
|
2167 | |
1842 | On systems that do not implement C<mprotect>, this function returns |
2168 | On systems that do not implement C<mprotect>, this function returns |
1843 | ENOSYS, otherwise the return value of C<mprotect>. |
2169 | ENOSYS, otherwise the return value of C<mprotect>. |
1844 | |
2170 | |
1845 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
2171 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
1846 | |
2172 | |
1847 | Memory-maps a file (or anonymous memory range) and attaches it to the |
2173 | Memory-maps a file (or anonymous memory range) and attaches it to the |
1848 | given C<$scalar>, which will act like a string scalar. |
2174 | given C<$scalar>, which will act like a string scalar. Returns true on |
|
|
2175 | success, and false otherwise. |
1849 | |
2176 | |
|
|
2177 | The scalar must exist, but its contents do not matter - this means you |
|
|
2178 | cannot use a nonexistant array or hash element. When in doubt, C<undef> |
|
|
2179 | the scalar first. |
|
|
2180 | |
1850 | The only operations allowed on the scalar are C<substr>/C<vec> that don't |
2181 | The only operations allowed on the mmapped scalar are C<substr>/C<vec>, |
1851 | change the string length, and most read-only operations such as copying it |
2182 | which don't change the string length, and most read-only operations such |
1852 | or searching it with regexes and so on. |
2183 | as copying it or searching it with regexes and so on. |
1853 | |
2184 | |
1854 | Anything else is unsafe and will, at best, result in memory leaks. |
2185 | Anything else is unsafe and will, at best, result in memory leaks. |
1855 | |
2186 | |
1856 | The memory map associated with the C<$scalar> is automatically removed |
2187 | The memory map associated with the C<$scalar> is automatically removed |
1857 | when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or |
2188 | when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap> |
1858 | C<IO::AIO::munmap> functions are called. |
2189 | or C<IO::AIO::munmap> functions are called on it. |
1859 | |
2190 | |
1860 | This calls the C<mmap>(2) function internally. See your system's manual |
2191 | This calls the C<mmap>(2) function internally. See your system's manual |
1861 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
2192 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
1862 | |
2193 | |
1863 | The C<$length> must be larger than zero and smaller than the actual |
2194 | The C<$length> must be larger than zero and smaller than the actual |
1864 | filesize. |
2195 | filesize. |
1865 | |
2196 | |
1866 | C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, |
2197 | C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, |
1867 | C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, |
2198 | C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, |
1868 | |
2199 | |
1869 | C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or |
2200 | C<$flags> can be a combination of |
1870 | C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when |
2201 | C<IO::AIO::MAP_SHARED> or |
1871 | not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS> |
2202 | C<IO::AIO::MAP_PRIVATE>, |
|
|
2203 | or a number of system-specific flags (when not available, the are C<0>): |
1872 | (which is set to C<MAP_ANON> if your system only provides this |
2204 | C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant), |
1873 | constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>, |
2205 | C<IO::AIO::MAP_LOCKED>, |
1874 | C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or |
2206 | C<IO::AIO::MAP_NORESERVE>, |
|
|
2207 | C<IO::AIO::MAP_POPULATE>, |
1875 | C<IO::AIO::MAP_NONBLOCK> |
2208 | C<IO::AIO::MAP_NONBLOCK>, |
|
|
2209 | C<IO::AIO::MAP_FIXED>, |
|
|
2210 | C<IO::AIO::MAP_GROWSDOWN>, |
|
|
2211 | C<IO::AIO::MAP_32BIT>, |
|
|
2212 | C<IO::AIO::MAP_HUGETLB> or |
|
|
2213 | C<IO::AIO::MAP_STACK>. |
1876 | |
2214 | |
1877 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
2215 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
1878 | |
2216 | |
1879 | C<$offset> is the offset from the start of the file - it generally must be |
2217 | C<$offset> is the offset from the start of the file - it generally must be |
1880 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
2218 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
… | |
… | |
1894 | |
2232 | |
1895 | =item IO::AIO::munmap $scalar |
2233 | =item IO::AIO::munmap $scalar |
1896 | |
2234 | |
1897 | Removes a previous mmap and undefines the C<$scalar>. |
2235 | Removes a previous mmap and undefines the C<$scalar>. |
1898 | |
2236 | |
|
|
2237 | =item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0] |
|
|
2238 | |
|
|
2239 | Calls the Linux-specific mremap(2) system call. The C<$scalar> must have |
|
|
2240 | been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be |
|
|
2241 | C<0> or C<IO::AIO::MREMAP_MAYMOVE>. |
|
|
2242 | |
|
|
2243 | Returns true if successful, and false otherwise. If the underlying mmapped |
|
|
2244 | region has changed address, then the true value has the numerical value |
|
|
2245 | C<1>, otherwise it has the numerical value C<0>: |
|
|
2246 | |
|
|
2247 | my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE |
|
|
2248 | or die "mremap: $!"; |
|
|
2249 | |
|
|
2250 | if ($success*1) { |
|
|
2251 | warn "scalar has chanegd address in memory\n"; |
|
|
2252 | } |
|
|
2253 | |
|
|
2254 | C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently |
|
|
2255 | implemented, but not supported and might go away in a future version. |
|
|
2256 | |
|
|
2257 | On systems where this call is not supported or is not emulated, this call |
|
|
2258 | returns falls and sets C<$!> to C<ENOSYS>. |
|
|
2259 | |
1899 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2260 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
1900 | |
2261 | |
1901 | Calls the C<munlock> function, undoing the effects of a previous |
2262 | Calls the C<munlock> function, undoing the effects of a previous |
1902 | C<aio_mlock> call (see its description for details). |
2263 | C<aio_mlock> call (see its description for details). |
1903 | |
2264 | |
… | |
… | |
1905 | |
2266 | |
1906 | Calls the C<munlockall> function. |
2267 | Calls the C<munlockall> function. |
1907 | |
2268 | |
1908 | On systems that do not implement C<munlockall>, this function returns |
2269 | On systems that do not implement C<munlockall>, this function returns |
1909 | ENOSYS, otherwise the return value of C<munlockall>. |
2270 | ENOSYS, otherwise the return value of C<munlockall>. |
|
|
2271 | |
|
|
2272 | =item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
|
|
2273 | |
|
|
2274 | Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or |
|
|
2275 | C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they |
|
|
2276 | should be the file offset. |
|
|
2277 | |
|
|
2278 | C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might |
|
|
2279 | silently corrupt the data in this case. |
|
|
2280 | |
|
|
2281 | The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>, |
|
|
2282 | C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and |
|
|
2283 | C<IO::AIO::SPLICE_F_GIFT>. |
|
|
2284 | |
|
|
2285 | See the C<splice(2)> manpage for details. |
|
|
2286 | |
|
|
2287 | =item IO::AIO::tee $r_fh, $w_fh, $length, $flags |
|
|
2288 | |
|
|
2289 | Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the |
|
|
2290 | description for C<IO::AIO::splice> above for details. |
|
|
2291 | |
|
|
2292 | =item $actual_size = IO::AIO::pipesize $r_fh[, $new_size] |
|
|
2293 | |
|
|
2294 | Attempts to query or change the pipe buffer size. Obviously works only |
|
|
2295 | on pipes, and currently works only on GNU/Linux systems, and fails with |
|
|
2296 | C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer |
|
|
2297 | size on other systems, drop me a note. |
|
|
2298 | |
|
|
2299 | =item ($rfh, $wfh) = IO::AIO::pipe2 [$flags] |
|
|
2300 | |
|
|
2301 | This is a direct interface to the Linux L<pipe2(2)> system call. If |
|
|
2302 | C<$flags> is missing or C<0>, then this should be the same as a call to |
|
|
2303 | perl's built-in C<pipe> function and create a new pipe, and works on |
|
|
2304 | systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe |
|
|
2305 | (..., 4096, O_BINARY)>. |
|
|
2306 | |
|
|
2307 | If C<$flags> is non-zero, it tries to invoke the pipe2 system call with |
|
|
2308 | the given flags (Linux 2.6.27, glibc 2.9). |
|
|
2309 | |
|
|
2310 | On success, the read and write file handles are returned. |
|
|
2311 | |
|
|
2312 | On error, nothing will be returned. If the pipe2 syscall is missing and |
|
|
2313 | C<$flags> is non-zero, fails with C<ENOSYS>. |
|
|
2314 | |
|
|
2315 | Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the |
|
|
2316 | time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and |
|
|
2317 | C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported. |
|
|
2318 | |
|
|
2319 | Example: create a pipe race-free w.r.t. threads and fork: |
|
|
2320 | |
|
|
2321 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
|
|
2322 | or die "pipe2: $!\n"; |
|
|
2323 | |
|
|
2324 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
|
|
2325 | |
|
|
2326 | This is a direct interface to the Linux L<eventfd(2)> system call. The |
|
|
2327 | (unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both. |
|
|
2328 | |
|
|
2329 | On success, the new eventfd filehandle is returned, otherwise returns |
|
|
2330 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
|
|
2331 | |
|
|
2332 | Please refer to L<eventfd(2)> for more info on this call. |
|
|
2333 | |
|
|
2334 | The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, |
|
|
2335 | C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). |
|
|
2336 | |
|
|
2337 | Example: create a new eventfd filehandle: |
|
|
2338 | |
|
|
2339 | $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC |
|
|
2340 | or die "eventfd: $!\n"; |
|
|
2341 | |
|
|
2342 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
|
|
2343 | |
|
|
2344 | This is a direct interface to the Linux L<timerfd_create(2)> system call. The |
|
|
2345 | (unhelpful) default for C<$flags> is C<0>. |
|
|
2346 | |
|
|
2347 | On success, the new timerfd filehandle is returned, otherwise returns |
|
|
2348 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
|
|
2349 | |
|
|
2350 | Please refer to L<timerfd_create(2)> for more info on this call. |
|
|
2351 | |
|
|
2352 | The following C<$clockid> values are |
|
|
2353 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |
|
|
2354 | C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15) |
|
|
2355 | C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and |
|
|
2356 | C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11). |
|
|
2357 | |
|
|
2358 | The following C<$flags> values are available (Linux |
|
|
2359 | 2.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>. |
|
|
2360 | |
|
|
2361 | Example: create a new timerfd and set it to one-second repeated alarms, |
|
|
2362 | then wait for two alarms: |
|
|
2363 | |
|
|
2364 | my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC |
|
|
2365 | or die "timerfd_create: $!\n"; |
|
|
2366 | |
|
|
2367 | defined IO::AIO::timerfd_settime $fh, 0, 1, 1 |
|
|
2368 | or die "timerfd_settime: $!\n"; |
|
|
2369 | |
|
|
2370 | for (1..2) { |
|
|
2371 | 8 == sysread $fh, my $buf, 8 |
|
|
2372 | or die "timerfd read failure\n"; |
|
|
2373 | |
|
|
2374 | printf "number of expirations (likely 1): %d\n", |
|
|
2375 | unpack "Q", $buf; |
|
|
2376 | } |
|
|
2377 | |
|
|
2378 | =item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value |
|
|
2379 | |
|
|
2380 | This is a direct interface to the Linux L<timerfd_settime(2)> system |
|
|
2381 | call. Please refer to its manpage for more info on this call. |
|
|
2382 | |
|
|
2383 | The new itimerspec is specified using two (possibly fractional) second |
|
|
2384 | values, C<$new_interval> and C<$new_value>). |
|
|
2385 | |
|
|
2386 | On success, the current interval and value are returned (as per |
|
|
2387 | C<timerfd_gettime>). On failure, the empty list is returned. |
|
|
2388 | |
|
|
2389 | The following C<$flags> values are |
|
|
2390 | available: C<IO::AIO::TFD_TIMER_ABSTIME> and |
|
|
2391 | C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>. |
|
|
2392 | |
|
|
2393 | See C<IO::AIO::timerfd_create> for a full example. |
|
|
2394 | |
|
|
2395 | =item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh |
|
|
2396 | |
|
|
2397 | This is a direct interface to the Linux L<timerfd_gettime(2)> system |
|
|
2398 | call. Please refer to its manpage for more info on this call. |
|
|
2399 | |
|
|
2400 | On success, returns the current values of interval and value for the given |
|
|
2401 | timerfd (as potentially fractional second values). On failure, the empty |
|
|
2402 | list is returned. |
1910 | |
2403 | |
1911 | =back |
2404 | =back |
1912 | |
2405 | |
1913 | =cut |
2406 | =cut |
1914 | |
2407 | |
… | |
… | |
1980 | the process will result in undefined behaviour. Calling it at any time |
2473 | the process will result in undefined behaviour. Calling it at any time |
1981 | will also result in any undefined (by POSIX) behaviour. |
2474 | will also result in any undefined (by POSIX) behaviour. |
1982 | |
2475 | |
1983 | =back |
2476 | =back |
1984 | |
2477 | |
|
|
2478 | =head2 LINUX-SPECIFIC CALLS |
|
|
2479 | |
|
|
2480 | When a call is documented as "linux-specific" then this means it |
|
|
2481 | originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the |
|
|
2482 | availability and compatibility of such calls regardless of the platform |
|
|
2483 | it is compiled on, so platforms such as FreeBSD which often implement |
|
|
2484 | these calls will work. When in doubt, call them and see if they fail wth |
|
|
2485 | C<ENOSYS>. |
|
|
2486 | |
1985 | =head2 MEMORY USAGE |
2487 | =head2 MEMORY USAGE |
1986 | |
2488 | |
1987 | Per-request usage: |
2489 | Per-request usage: |
1988 | |
2490 | |
1989 | Each aio request uses - depending on your architecture - around 100-200 |
2491 | Each aio request uses - depending on your architecture - around 100-200 |
… | |
… | |
2001 | temporary buffers, and each thread requires a stack and other data |
2503 | temporary buffers, and each thread requires a stack and other data |
2002 | structures (usually around 16k-128k, depending on the OS). |
2504 | structures (usually around 16k-128k, depending on the OS). |
2003 | |
2505 | |
2004 | =head1 KNOWN BUGS |
2506 | =head1 KNOWN BUGS |
2005 | |
2507 | |
2006 | Known bugs will be fixed in the next release. |
2508 | Known bugs will be fixed in the next release :) |
|
|
2509 | |
|
|
2510 | =head1 KNOWN ISSUES |
|
|
2511 | |
|
|
2512 | Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap> |
|
|
2513 | or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as |
|
|
2514 | non-created hash slots or other scalars I didn't think of. It's best to |
|
|
2515 | avoid such and either use scalar variables or making sure that the scalar |
|
|
2516 | exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied). |
|
|
2517 | |
|
|
2518 | I am not sure anything can be done about this, so this is considered a |
|
|
2519 | known issue, rather than a bug. |
2007 | |
2520 | |
2008 | =head1 SEE ALSO |
2521 | =head1 SEE ALSO |
2009 | |
2522 | |
2010 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2523 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2011 | more natural syntax. |
2524 | more natural syntax. |