| … | |
… | |
| 150 | QUICK OVERVIEW |
150 | QUICK OVERVIEW |
| 151 | This section simply lists the prototypes of the most important functions |
151 | This section simply lists the prototypes of the most important functions |
| 152 | for quick reference. See the following sections for function-by-function |
152 | for quick reference. See the following sections for function-by-function |
| 153 | documentation. |
153 | documentation. |
| 154 | |
154 | |
|
|
155 | aio_wd $pathname, $callback->($wd) |
| 155 | aio_open $pathname, $flags, $mode, $callback->($fh) |
156 | aio_open $pathname, $flags, $mode, $callback->($fh) |
| 156 | aio_close $fh, $callback->($status) |
157 | aio_close $fh, $callback->($status) |
|
|
158 | aio_seek $fh,$offset,$whence, $callback->($offs) |
| 157 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
159 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
| 158 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
160 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
| 159 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
161 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
| 160 | aio_readahead $fh,$offset,$length, $callback->($retval) |
162 | aio_readahead $fh,$offset,$length, $callback->($retval) |
| 161 | aio_stat $fh_or_path, $callback->($status) |
163 | aio_stat $fh_or_path, $callback->($status) |
| 162 | aio_lstat $fh, $callback->($status) |
164 | aio_lstat $fh, $callback->($status) |
| 163 | aio_statvfs $fh_or_path, $callback->($statvfs) |
165 | aio_statvfs $fh_or_path, $callback->($statvfs) |
| 164 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
166 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
| 165 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
167 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
168 | aio_chmod $fh_or_path, $mode, $callback->($status) |
| 166 | aio_truncate $fh_or_path, $offset, $callback->($status) |
169 | aio_truncate $fh_or_path, $offset, $callback->($status) |
| 167 | aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
| 168 | aio_unlink $pathname, $callback->($status) |
170 | aio_unlink $pathname, $callback->($status) |
| 169 | aio_mknod $path, $mode, $dev, $callback->($status) |
171 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
| 170 | aio_link $srcpath, $dstpath, $callback->($status) |
172 | aio_link $srcpath, $dstpath, $callback->($status) |
| 171 | aio_symlink $srcpath, $dstpath, $callback->($status) |
173 | aio_symlink $srcpath, $dstpath, $callback->($status) |
| 172 | aio_readlink $path, $callback->($link) |
174 | aio_readlink $pathname, $callback->($link) |
|
|
175 | aio_realpath $pathname, $callback->($link) |
| 173 | aio_rename $srcpath, $dstpath, $callback->($status) |
176 | aio_rename $srcpath, $dstpath, $callback->($status) |
| 174 | aio_mkdir $pathname, $mode, $callback->($status) |
177 | aio_mkdir $pathname, $mode, $callback->($status) |
| 175 | aio_rmdir $pathname, $callback->($status) |
178 | aio_rmdir $pathname, $callback->($status) |
| 176 | aio_readdir $pathname, $callback->($entries) |
179 | aio_readdir $pathname, $callback->($entries) |
| 177 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
180 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
| 178 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
181 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
| 179 | IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN |
182 | IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN |
|
|
183 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
| 180 | aio_load $path, $data, $callback->($status) |
184 | aio_load $pathname, $data, $callback->($status) |
| 181 | aio_copy $srcpath, $dstpath, $callback->($status) |
185 | aio_copy $srcpath, $dstpath, $callback->($status) |
| 182 | aio_move $srcpath, $dstpath, $callback->($status) |
186 | aio_move $srcpath, $dstpath, $callback->($status) |
| 183 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
|
|
| 184 | aio_rmtree $path, $callback->($status) |
187 | aio_rmtree $pathname, $callback->($status) |
| 185 | aio_sync $callback->($status) |
188 | aio_sync $callback->($status) |
|
|
189 | aio_syncfs $fh, $callback->($status) |
| 186 | aio_fsync $fh, $callback->($status) |
190 | aio_fsync $fh, $callback->($status) |
| 187 | aio_fdatasync $fh, $callback->($status) |
191 | aio_fdatasync $fh, $callback->($status) |
| 188 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
192 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
| 189 | aio_pathsync $path, $callback->($status) |
193 | aio_pathsync $pathname, $callback->($status) |
| 190 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
194 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
| 191 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
195 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
| 192 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
196 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
| 193 | aio_mlockall $flags, $callback->($status) |
197 | aio_mlockall $flags, $callback->($status) |
| 194 | aio_group $callback->(...) |
198 | aio_group $callback->(...) |
| … | |
… | |
| 217 | IO::AIO::madvise $scalar, $offset, $length, $advice |
221 | IO::AIO::madvise $scalar, $offset, $length, $advice |
| 218 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
222 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
| 219 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
223 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
| 220 | IO::AIO::munlockall |
224 | IO::AIO::munlockall |
| 221 | |
225 | |
| 222 | AIO REQUEST FUNCTIONS |
226 | API NOTES |
| 223 | All the "aio_*" calls are more or less thin wrappers around the syscall |
227 | All the "aio_*" calls are more or less thin wrappers around the syscall |
| 224 | with the same name (sans "aio_"). The arguments are similar or |
228 | with the same name (sans "aio_"). The arguments are similar or |
| 225 | identical, and they all accept an additional (and optional) $callback |
229 | identical, and they all accept an additional (and optional) $callback |
| 226 | argument which must be a code reference. This code reference will get |
230 | argument which must be a code reference. This code reference will be |
| 227 | called with the syscall return code (e.g. most syscalls return -1 on |
|
|
| 228 | error, unlike perl, which usually delivers "false") as its sole argument |
|
|
| 229 | after the given syscall has been executed asynchronously. |
231 | called after the syscall has been executed in an asynchronous fashion. |
|
|
232 | The results of the request will be passed as arguments to the callback |
|
|
233 | (and, if an error occured, in $!) - for most requests the syscall return |
|
|
234 | code (e.g. most syscalls return -1 on error, unlike perl, which usually |
|
|
235 | delivers "false"). |
|
|
236 | |
|
|
237 | Some requests (such as "aio_readdir") pass the actual results and |
|
|
238 | communicate failures by passing "undef". |
| 230 | |
239 | |
| 231 | All functions expecting a filehandle keep a copy of the filehandle |
240 | All functions expecting a filehandle keep a copy of the filehandle |
| 232 | internally until the request has finished. |
241 | internally until the request has finished. |
| 233 | |
242 | |
| 234 | All functions return request objects of type IO::AIO::REQ that allow |
243 | All functions return request objects of type IO::AIO::REQ that allow |
| 235 | further manipulation of those requests while they are in-flight. |
244 | further manipulation of those requests while they are in-flight. |
| 236 | |
245 | |
| 237 | The pathnames you pass to these routines *must* be absolute and encoded |
246 | The pathnames you pass to these routines *should* be absolute. The |
| 238 | as octets. The reason for the former is that at the time the request is |
247 | reason for this is that at the time the request is being executed, the |
| 239 | being executed, the current working directory could have changed. |
248 | current working directory could have changed. Alternatively, you can |
| 240 | Alternatively, you can make sure that you never change the current |
249 | make sure that you never change the current working directory anywhere |
| 241 | working directory anywhere in the program and then use relative paths. |
250 | in the program and then use relative paths. You can also take advantage |
|
|
251 | of IO::AIOs working directory abstraction, that lets you specify paths |
|
|
252 | relative to some previously-opened "working directory object" - see the |
|
|
253 | description of the "IO::AIO::WD" class later in this document. |
| 242 | |
254 | |
| 243 | To encode pathnames as octets, either make sure you either: a) always |
255 | To encode pathnames as octets, either make sure you either: a) always |
| 244 | pass in filenames you got from outside (command line, readdir etc.) |
256 | pass in filenames you got from outside (command line, readdir etc.) |
| 245 | without tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module |
257 | without tinkering, b) are in your native filesystem encoding, c) use the |
| 246 | and encode your pathnames to the locale (or other) encoding in effect in |
258 | Encode module and encode your pathnames to the locale (or other) |
| 247 | the user environment, d) use Glib::filename_from_unicode on unicode |
259 | encoding in effect in the user environment, d) use |
| 248 | filenames or e) use something else to ensure your scalar has the correct |
260 | Glib::filename_from_unicode on unicode filenames or e) use something |
| 249 | contents. |
261 | else to ensure your scalar has the correct contents. |
| 250 | |
262 | |
| 251 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
263 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
| 252 | handles correctly whether it is set or not. |
264 | handles correctly whether it is set or not. |
| 253 | |
265 | |
|
|
266 | AIO REQUEST FUNCTIONS |
| 254 | $prev_pri = aioreq_pri [$pri] |
267 | $prev_pri = aioreq_pri [$pri] |
| 255 | Returns the priority value that would be used for the next request |
268 | Returns the priority value that would be used for the next request |
| 256 | and, if $pri is given, sets the priority for the next aio request. |
269 | and, if $pri is given, sets the priority for the next aio request. |
| 257 | |
270 | |
| 258 | The default priority is 0, the minimum and maximum priorities are -4 |
271 | The default priority is 0, the minimum and maximum priorities are -4 |
| … | |
… | |
| 329 | will use dup2 to overwrite the file descriptor with the write-end of |
342 | will use dup2 to overwrite the file descriptor with the write-end of |
| 330 | a pipe (the pipe fd will be created on demand and will be cached). |
343 | a pipe (the pipe fd will be created on demand and will be cached). |
| 331 | |
344 | |
| 332 | Or in other words: the file descriptor will be closed, but it will |
345 | Or in other words: the file descriptor will be closed, but it will |
| 333 | not be free for reuse until the perl filehandle is closed. |
346 | not be free for reuse until the perl filehandle is closed. |
|
|
347 | |
|
|
348 | aio_seek $fh, $offset, $whence, $callback->($offs) |
|
|
349 | Seeks the filehandle to the new $offset, similarly to perl's |
|
|
350 | "sysseek". The $whence can use the traditional values (0 for |
|
|
351 | "IO::AIO::SEEK_SET", 1 for "IO::AIO::SEEK_CUR" or 2 for |
|
|
352 | "IO::AIO::SEEK_END"). |
|
|
353 | |
|
|
354 | The resulting absolute offset will be passed to the callback, or -1 |
|
|
355 | in case of an error. |
|
|
356 | |
|
|
357 | In theory, the $whence constants could be different than the |
|
|
358 | corresponding values from Fcntl, but perl guarantees they are the |
|
|
359 | same, so don't panic. |
| 334 | |
360 | |
| 335 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
361 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
| 336 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
362 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
| 337 | Reads or writes $length bytes from or to the specified $fh and |
363 | Reads or writes $length bytes from or to the specified $fh and |
| 338 | $offset into the scalar given by $data and offset $dataoffset and |
364 | $offset into the scalar given by $data and offset $dataoffset and |
| … | |
… | |
| 531 | |
557 | |
| 532 | aio_unlink $pathname, $callback->($status) |
558 | aio_unlink $pathname, $callback->($status) |
| 533 | Asynchronously unlink (delete) a file and call the callback with the |
559 | Asynchronously unlink (delete) a file and call the callback with the |
| 534 | result code. |
560 | result code. |
| 535 | |
561 | |
| 536 | aio_mknod $path, $mode, $dev, $callback->($status) |
562 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
| 537 | [EXPERIMENTAL] |
563 | [EXPERIMENTAL] |
| 538 | |
564 | |
| 539 | Asynchronously create a device node (or fifo). See mknod(2). |
565 | Asynchronously create a device node (or fifo). See mknod(2). |
| 540 | |
566 | |
| 541 | The only (POSIX-) portable way of calling this function is: |
567 | The only (POSIX-) portable way of calling this function is: |
| 542 | |
568 | |
| 543 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
569 | aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
| 544 | |
570 | |
| 545 | See "aio_stat" for info about some potentially helpful extra |
571 | See "aio_stat" for info about some potentially helpful extra |
| 546 | constants and functions. |
572 | constants and functions. |
| 547 | |
573 | |
| 548 | aio_link $srcpath, $dstpath, $callback->($status) |
574 | aio_link $srcpath, $dstpath, $callback->($status) |
| … | |
… | |
| 552 | aio_symlink $srcpath, $dstpath, $callback->($status) |
578 | aio_symlink $srcpath, $dstpath, $callback->($status) |
| 553 | Asynchronously create a new symbolic link to the existing object at |
579 | Asynchronously create a new symbolic link to the existing object at |
| 554 | $srcpath at the path $dstpath and call the callback with the result |
580 | $srcpath at the path $dstpath and call the callback with the result |
| 555 | code. |
581 | code. |
| 556 | |
582 | |
| 557 | aio_readlink $path, $callback->($link) |
583 | aio_readlink $pathname, $callback->($link) |
| 558 | Asynchronously read the symlink specified by $path and pass it to |
584 | Asynchronously read the symlink specified by $path and pass it to |
| 559 | the callback. If an error occurs, nothing or undef gets passed to |
585 | the callback. If an error occurs, nothing or undef gets passed to |
| 560 | the callback. |
586 | the callback. |
|
|
587 | |
|
|
588 | aio_realpath $pathname, $callback->($path) |
|
|
589 | Asynchronously make the path absolute and resolve any symlinks in |
|
|
590 | $path. The resulting path only consists of directories (Same as |
|
|
591 | Cwd::realpath). |
|
|
592 | |
|
|
593 | This request can be used to get the absolute path of the current |
|
|
594 | working directory by passing it a path of . (a single dot). |
| 561 | |
595 | |
| 562 | aio_rename $srcpath, $dstpath, $callback->($status) |
596 | aio_rename $srcpath, $dstpath, $callback->($status) |
| 563 | Asynchronously rename the object at $srcpath to $dstpath, just as |
597 | Asynchronously rename the object at $srcpath to $dstpath, just as |
| 564 | rename(2) and call the callback with the result code. |
598 | rename(2) and call the callback with the result code. |
| 565 | |
599 | |
| … | |
… | |
| 579 | |
613 | |
| 580 | The callback is passed a single argument which is either "undef" or |
614 | The callback is passed a single argument which is either "undef" or |
| 581 | an array-ref with the filenames. |
615 | an array-ref with the filenames. |
| 582 | |
616 | |
| 583 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
617 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
| 584 | Quite similar to "aio_readdir", but the $flags argument allows to |
618 | Quite similar to "aio_readdir", but the $flags argument allows one |
| 585 | tune behaviour and output format. In case of an error, $entries will |
619 | to tune behaviour and output format. In case of an error, $entries |
| 586 | be "undef". |
620 | will be "undef". |
| 587 | |
621 | |
| 588 | The flags are a combination of the following constants, ORed |
622 | The flags are a combination of the following constants, ORed |
| 589 | together (the flags will also be passed to the callback, possibly |
623 | together (the flags will also be passed to the callback, possibly |
| 590 | modified): |
624 | modified): |
| 591 | |
625 | |
| … | |
… | |
| 636 | optimal stat order. |
670 | optimal stat order. |
| 637 | |
671 | |
| 638 | IO::AIO::READDIR_FOUND_UNKNOWN |
672 | IO::AIO::READDIR_FOUND_UNKNOWN |
| 639 | This flag should not be set when calling "aio_readdirx". |
673 | This flag should not be set when calling "aio_readdirx". |
| 640 | Instead, it is being set by "aio_readdirx", when any of the |
674 | Instead, it is being set by "aio_readdirx", when any of the |
| 641 | $type's found were "IO::AIO::DT_UNKNOWN". The absense of this |
675 | $type's found were "IO::AIO::DT_UNKNOWN". The absence of this |
| 642 | flag therefore indicates that all $type's are known, which can |
676 | flag therefore indicates that all $type's are known, which can |
| 643 | be used to speed up some algorithms. |
677 | be used to speed up some algorithms. |
| 644 | |
678 | |
| 645 | aio_load $path, $data, $callback->($status) |
679 | aio_load $pathname, $data, $callback->($status) |
| 646 | This is a composite request that tries to fully load the given file |
680 | This is a composite request that tries to fully load the given file |
| 647 | into memory. Status is the same as with aio_read. |
681 | into memory. Status is the same as with aio_read. |
| 648 | |
682 | |
| 649 | aio_copy $srcpath, $dstpath, $callback->($status) |
683 | aio_copy $srcpath, $dstpath, $callback->($status) |
| 650 | Try to copy the *file* (directories not supported as either source |
684 | Try to copy the *file* (directories not supported as either source |
| … | |
… | |
| 667 | |
701 | |
| 668 | This is a composite request that tries to rename(2) the file first; |
702 | This is a composite request that tries to rename(2) the file first; |
| 669 | if rename fails with "EXDEV", it copies the file with "aio_copy" |
703 | if rename fails with "EXDEV", it copies the file with "aio_copy" |
| 670 | and, if that is successful, unlinks the $srcpath. |
704 | and, if that is successful, unlinks the $srcpath. |
| 671 | |
705 | |
| 672 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
706 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
| 673 | Scans a directory (similar to "aio_readdir") but additionally tries |
707 | Scans a directory (similar to "aio_readdir") but additionally tries |
| 674 | to efficiently separate the entries of directory $path into two sets |
708 | to efficiently separate the entries of directory $path into two sets |
| 675 | of names, directories you can recurse into (directories), and ones |
709 | of names, directories you can recurse into (directories), and ones |
| 676 | you cannot recurse into (everything else, including symlinks to |
710 | you cannot recurse into (everything else, including symlinks to |
| 677 | directories). |
711 | directories). |
| … | |
… | |
| 710 | Then entries will be sorted into likely directories a non-initial |
744 | Then entries will be sorted into likely directories a non-initial |
| 711 | dot currently) and likely non-directories (see "aio_readdirx"). Then |
745 | dot currently) and likely non-directories (see "aio_readdirx"). Then |
| 712 | every entry plus an appended "/." will be "stat"'ed, likely |
746 | every entry plus an appended "/." will be "stat"'ed, likely |
| 713 | directories first, in order of their inode numbers. If that |
747 | directories first, in order of their inode numbers. If that |
| 714 | succeeds, it assumes that the entry is a directory or a symlink to |
748 | succeeds, it assumes that the entry is a directory or a symlink to |
| 715 | directory (which will be checked seperately). This is often faster |
749 | directory (which will be checked separately). This is often faster |
| 716 | than stat'ing the entry itself because filesystems might detect the |
750 | than stat'ing the entry itself because filesystems might detect the |
| 717 | type of the entry without reading the inode data (e.g. ext2fs |
751 | type of the entry without reading the inode data (e.g. ext2fs |
| 718 | filetype feature), even on systems that cannot return the filetype |
752 | filetype feature), even on systems that cannot return the filetype |
| 719 | information on readdir. |
753 | information on readdir. |
| 720 | |
754 | |
| … | |
… | |
| 726 | |
760 | |
| 727 | It will also likely work on non-POSIX filesystems with reduced |
761 | It will also likely work on non-POSIX filesystems with reduced |
| 728 | efficiency as those tend to return 0 or 1 as link counts, which |
762 | efficiency as those tend to return 0 or 1 as link counts, which |
| 729 | disables the directory counting heuristic. |
763 | disables the directory counting heuristic. |
| 730 | |
764 | |
| 731 | aio_rmtree $path, $callback->($status) |
765 | aio_rmtree $pathname, $callback->($status) |
| 732 | Delete a directory tree starting (and including) $path, return the |
766 | Delete a directory tree starting (and including) $path, return the |
| 733 | status of the final "rmdir" only. This is a composite request that |
767 | status of the final "rmdir" only. This is a composite request that |
| 734 | uses "aio_scandir" to recurse into and rmdir directories, and unlink |
768 | uses "aio_scandir" to recurse into and rmdir directories, and unlink |
| 735 | everything else. |
769 | everything else. |
| 736 | |
770 | |
| … | |
… | |
| 745 | Asynchronously call fdatasync on the given filehandle and call the |
779 | Asynchronously call fdatasync on the given filehandle and call the |
| 746 | callback with the fdatasync result code. |
780 | callback with the fdatasync result code. |
| 747 | |
781 | |
| 748 | If this call isn't available because your OS lacks it or it couldn't |
782 | If this call isn't available because your OS lacks it or it couldn't |
| 749 | be detected, it will be emulated by calling "fsync" instead. |
783 | be detected, it will be emulated by calling "fsync" instead. |
|
|
784 | |
|
|
785 | aio_syncfs $fh, $callback->($status) |
|
|
786 | Asynchronously call the syncfs syscall to sync the filesystem |
|
|
787 | associated to the given filehandle and call the callback with the |
|
|
788 | syncfs result code. If syncfs is not available, calls sync(), but |
|
|
789 | returns -1 and sets errno to "ENOSYS" nevertheless. |
| 750 | |
790 | |
| 751 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
791 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
| 752 | Sync the data portion of the file specified by $offset and $length |
792 | Sync the data portion of the file specified by $offset and $length |
| 753 | to disk (but NOT the metadata), by calling the Linux-specific |
793 | to disk (but NOT the metadata), by calling the Linux-specific |
| 754 | sync_file_range call. If sync_file_range is not available or it |
794 | sync_file_range call. If sync_file_range is not available or it |
| … | |
… | |
| 758 | "IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE", |
798 | "IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE", |
| 759 | "IO::AIO::SYNC_FILE_RANGE_WRITE" and |
799 | "IO::AIO::SYNC_FILE_RANGE_WRITE" and |
| 760 | "IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER": refer to the sync_file_range |
800 | "IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER": refer to the sync_file_range |
| 761 | manpage for details. |
801 | manpage for details. |
| 762 | |
802 | |
| 763 | aio_pathsync $path, $callback->($status) |
803 | aio_pathsync $pathname, $callback->($status) |
| 764 | This request tries to open, fsync and close the given path. This is |
804 | This request tries to open, fsync and close the given path. This is |
| 765 | a composite request intended to sync directories after directory |
805 | a composite request intended to sync directories after directory |
| 766 | operations (E.g. rename). This might not work on all operating |
806 | operations (E.g. rename). This might not work on all operating |
| 767 | systems or have any specific effect, but usually it makes sure that |
807 | systems or have any specific effect, but usually it makes sure that |
| 768 | directory changes get written to disc. It works for anything that |
808 | directory changes get written to disc. It works for anything that |
| … | |
… | |
| 838 | Example: asynchronously lock all current and future pages into |
878 | Example: asynchronously lock all current and future pages into |
| 839 | memory. |
879 | memory. |
| 840 | |
880 | |
| 841 | aio_mlockall IO::AIO::MCL_FUTURE; |
881 | aio_mlockall IO::AIO::MCL_FUTURE; |
| 842 | |
882 | |
|
|
883 | aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) |
|
|
884 | Queries the extents of the given file (by calling the Linux FIEMAP |
|
|
885 | ioctl, see <http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for |
|
|
886 | details). If the "ioctl" is not available on your OS, then this |
|
|
887 | rquiest will fail with "ENOSYS". |
|
|
888 | |
|
|
889 | $start is the starting offset to query extents for, $length is the |
|
|
890 | size of the range to query - if it is "undef", then the whole file |
|
|
891 | will be queried. |
|
|
892 | |
|
|
893 | $flags is a combination of flags ("IO::AIO::FIEMAP_FLAG_SYNC" or |
|
|
894 | "IO::AIO::FIEMAP_FLAG_XATTR" - "IO::AIO::FIEMAP_FLAGS_COMPAT" is |
|
|
895 | also exported), and is normally 0 or "IO::AIO::FIEMAP_FLAG_SYNC" to |
|
|
896 | query the data portion. |
|
|
897 | |
|
|
898 | $count is the maximum number of extent records to return. If it is |
|
|
899 | "undef", then IO::AIO queries all extents of the file. As a very |
|
|
900 | special case, if it is 0, then the callback receives the number of |
|
|
901 | extents instead of the extents themselves. |
|
|
902 | |
|
|
903 | If an error occurs, the callback receives no arguments. The special |
|
|
904 | "errno" value "IO::AIO::EBADR" is available to test for flag errors. |
|
|
905 | |
|
|
906 | Otherwise, the callback receives an array reference with extent |
|
|
907 | structures. Each extent structure is an array reference itself, with |
|
|
908 | the following members: |
|
|
909 | |
|
|
910 | [$logical, $physical, $length, $flags] |
|
|
911 | |
|
|
912 | Flags is any combination of the following flag values (typically |
|
|
913 | either 0 or "IO::AIO::FIEMAP_EXTENT_LAST"): |
|
|
914 | |
|
|
915 | "IO::AIO::FIEMAP_EXTENT_LAST", "IO::AIO::FIEMAP_EXTENT_UNKNOWN", |
|
|
916 | "IO::AIO::FIEMAP_EXTENT_DELALLOC", "IO::AIO::FIEMAP_EXTENT_ENCODED", |
|
|
917 | "IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED", |
|
|
918 | "IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED", |
|
|
919 | "IO::AIO::FIEMAP_EXTENT_DATA_INLINE", |
|
|
920 | "IO::AIO::FIEMAP_EXTENT_DATA_TAIL", |
|
|
921 | "IO::AIO::FIEMAP_EXTENT_UNWRITTEN", "IO::AIO::FIEMAP_EXTENT_MERGED" |
|
|
922 | or "IO::AIO::FIEMAP_EXTENT_SHARED". |
|
|
923 | |
| 843 | aio_group $callback->(...) |
924 | aio_group $callback->(...) |
| 844 | This is a very special aio request: Instead of doing something, it |
925 | This is a very special aio request: Instead of doing something, it |
| 845 | is a container for other aio requests, which is useful if you want |
926 | is a container for other aio requests, which is useful if you want |
| 846 | to bundle many requests into a single, composite, request with a |
927 | to bundle many requests into a single, composite, request with a |
| 847 | definite callback and the ability to cancel the whole request with |
928 | definite callback and the ability to cancel the whole request with |
| … | |
… | |
| 880 | While it is theoretically handy to have simple I/O scheduling |
961 | While it is theoretically handy to have simple I/O scheduling |
| 881 | requests like sleep and file handle readable/writable, the overhead |
962 | requests like sleep and file handle readable/writable, the overhead |
| 882 | this creates is immense (it blocks a thread for a long time) so do |
963 | this creates is immense (it blocks a thread for a long time) so do |
| 883 | not use this function except to put your application under |
964 | not use this function except to put your application under |
| 884 | artificial I/O pressure. |
965 | artificial I/O pressure. |
|
|
966 | |
|
|
967 | IO::AIO::WD - multiple working directories |
|
|
968 | Your process only has one current working directory, which is used by |
|
|
969 | all threads. This makes it hard to use relative paths (some other |
|
|
970 | component could call "chdir" at any time, and it is hard to control when |
|
|
971 | the path will be used by IO::AIO). |
|
|
972 | |
|
|
973 | One solution for this is to always use absolute paths. This usually |
|
|
974 | works, but can be quite slow (the kernel has to walk the whole path on |
|
|
975 | every access), and can also be a hassle to implement. |
|
|
976 | |
|
|
977 | Newer POSIX systems have a number of functions (openat, fdopendir, |
|
|
978 | futimensat and so on) that make it possible to specify working |
|
|
979 | directories per operation. |
|
|
980 | |
|
|
981 | For portability, and because the clowns who "designed", or shall I |
|
|
982 | write, perpetrated this new interface were obviously half-drunk, this |
|
|
983 | abstraction cannot be perfect, though. |
|
|
984 | |
|
|
985 | IO::AIO allows you to convert directory paths into a so-called |
|
|
986 | IO::AIO::WD object. This object stores the canonicalised, absolute |
|
|
987 | version of the path, and on systems that allow it, also a directory file |
|
|
988 | descriptor. |
|
|
989 | |
|
|
990 | Everywhere where a pathname is accepted by IO::AIO (e.g. in "aio_stat" |
|
|
991 | or "aio_unlink"), one can specify an array reference with an IO::AIO::WD |
|
|
992 | object and a pathname instead (or the IO::AIO::WD object alone, which |
|
|
993 | gets interpreted as "[$wd, "."]"). If the pathname is absolute, the |
|
|
994 | IO::AIO::WD object is ignored, otherwise the pathname is resolved |
|
|
995 | relative to that IO::AIO::WD object. |
|
|
996 | |
|
|
997 | For example, to get a wd object for /etc and then stat passwd inside, |
|
|
998 | you would write: |
|
|
999 | |
|
|
1000 | aio_wd "/etc", sub { |
|
|
1001 | my $etcdir = shift; |
|
|
1002 | |
|
|
1003 | # although $etcdir can be undef on error, there is generally no reason |
|
|
1004 | # to check for errors here, as aio_stat will fail with ENOENT |
|
|
1005 | # when $etcdir is undef. |
|
|
1006 | |
|
|
1007 | aio_stat [$etcdir, "passwd"], sub { |
|
|
1008 | # yay |
|
|
1009 | }; |
|
|
1010 | }; |
|
|
1011 | |
|
|
1012 | That "aio_wd" is a request and not a normal function shows that creating |
|
|
1013 | an IO::AIO::WD object is itself a potentially blocking operation, which |
|
|
1014 | is why it is done asynchronously. |
|
|
1015 | |
|
|
1016 | To stat the directory obtained with "aio_wd" above, one could write |
|
|
1017 | either of the following three request calls: |
|
|
1018 | |
|
|
1019 | aio_lstat "/etc" , sub { ... # pathname as normal string |
|
|
1020 | aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself) |
|
|
1021 | aio_lstat $wd , sub { ... # shorthand for the previous |
|
|
1022 | |
|
|
1023 | As with normal pathnames, IO::AIO keeps a copy of the working directory |
|
|
1024 | object and the pathname string, so you could write the following without |
|
|
1025 | causing any issues due to $path getting reused: |
|
|
1026 | |
|
|
1027 | my $path = [$wd, undef]; |
|
|
1028 | |
|
|
1029 | for my $name (qw(abc def ghi)) { |
|
|
1030 | $path->[1] = $name; |
|
|
1031 | aio_stat $path, sub { |
|
|
1032 | # ... |
|
|
1033 | }; |
|
|
1034 | } |
|
|
1035 | |
|
|
1036 | There are some caveats: when directories get renamed (or deleted), the |
|
|
1037 | pathname string doesn't change, so will point to the new directory (or |
|
|
1038 | nowhere at all), while the directory fd, if available on the system, |
|
|
1039 | will still point to the original directory. Most functions accepting a |
|
|
1040 | pathname will use the directory fd on newer systems, and the string on |
|
|
1041 | older systems. Some functions (such as realpath) will always rely on the |
|
|
1042 | string form of the pathname. |
|
|
1043 | |
|
|
1044 | So this fucntionality is mainly useful to get some protection against |
|
|
1045 | "chdir", to easily get an absolute path out of a relative path for |
|
|
1046 | future reference, and to speed up doing many operations in the same |
|
|
1047 | directory (e.g. when stat'ing all files in a directory). |
|
|
1048 | |
|
|
1049 | The following functions implement this working directory abstraction: |
|
|
1050 | |
|
|
1051 | aio_wd $pathname, $callback->($wd) |
|
|
1052 | Asynchonously canonicalise the given pathname and convert it to an |
|
|
1053 | IO::AIO::WD object representing it. If possible and supported on the |
|
|
1054 | system, also open a directory fd to speed up pathname resolution |
|
|
1055 | relative to this working directory. |
|
|
1056 | |
|
|
1057 | If something goes wrong, then "undef" is passwd to the callback |
|
|
1058 | instead of a working directory object and $! is set appropriately. |
|
|
1059 | Since passing "undef" as working directory component of a pathname |
|
|
1060 | fails the request with "ENOENT", there is often no need for error |
|
|
1061 | checking in the "aio_wd" callback, as future requests using the |
|
|
1062 | value will fail in the expected way. |
|
|
1063 | |
|
|
1064 | If this call isn't available because your OS lacks it or it couldn't |
|
|
1065 | be detected, it will be emulated by calling "fsync" instead. |
|
|
1066 | |
|
|
1067 | IO::AIO::CWD |
|
|
1068 | This is a compiletime constant (object) that represents the process |
|
|
1069 | current working directory. |
|
|
1070 | |
|
|
1071 | Specifying this object as working directory object for a pathname is |
|
|
1072 | as if the pathname would be specified directly, without a directory |
|
|
1073 | object, e.g., these calls are functionally identical: |
|
|
1074 | |
|
|
1075 | aio_stat "somefile", sub { ... }; |
|
|
1076 | aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; |
| 885 | |
1077 | |
| 886 | IO::AIO::REQ CLASS |
1078 | IO::AIO::REQ CLASS |
| 887 | All non-aggregate "aio_*" functions return an object of this class when |
1079 | All non-aggregate "aio_*" functions return an object of this class when |
| 888 | called in non-void context. |
1080 | called in non-void context. |
| 889 | |
1081 | |
| … | |
… | |
| 989 | Sets a feeder/generator on this group: every group can have an |
1181 | Sets a feeder/generator on this group: every group can have an |
| 990 | attached generator that generates requests if idle. The idea behind |
1182 | attached generator that generates requests if idle. The idea behind |
| 991 | this is that, although you could just queue as many requests as you |
1183 | this is that, although you could just queue as many requests as you |
| 992 | want in a group, this might starve other requests for a potentially |
1184 | want in a group, this might starve other requests for a potentially |
| 993 | long time. For example, "aio_scandir" might generate hundreds of |
1185 | long time. For example, "aio_scandir" might generate hundreds of |
| 994 | thousands "aio_stat" requests, delaying any later requests for a |
1186 | thousands of "aio_stat" requests, delaying any later requests for a |
| 995 | long time. |
1187 | long time. |
| 996 | |
1188 | |
| 997 | To avoid this, and allow incremental generation of requests, you can |
1189 | To avoid this, and allow incremental generation of requests, you can |
| 998 | instead a group and set a feeder on it that generates those |
1190 | instead a group and set a feeder on it that generates those |
| 999 | requests. The feed callback will be called whenever there are few |
1191 | requests. The feed callback will be called whenever there are few |
| … | |
… | |
| 1247 | |
1439 | |
| 1248 | Returns the number of bytes copied, or -1 on error. |
1440 | Returns the number of bytes copied, or -1 on error. |
| 1249 | |
1441 | |
| 1250 | IO::AIO::fadvise $fh, $offset, $len, $advice |
1442 | IO::AIO::fadvise $fh, $offset, $len, $advice |
| 1251 | Simply calls the "posix_fadvise" function (see its manpage for |
1443 | Simply calls the "posix_fadvise" function (see its manpage for |
| 1252 | details). The following advice constants are avaiable: |
1444 | details). The following advice constants are available: |
| 1253 | "IO::AIO::FADV_NORMAL", "IO::AIO::FADV_SEQUENTIAL", |
1445 | "IO::AIO::FADV_NORMAL", "IO::AIO::FADV_SEQUENTIAL", |
| 1254 | "IO::AIO::FADV_RANDOM", "IO::AIO::FADV_NOREUSE", |
1446 | "IO::AIO::FADV_RANDOM", "IO::AIO::FADV_NOREUSE", |
| 1255 | "IO::AIO::FADV_WILLNEED", "IO::AIO::FADV_DONTNEED". |
1447 | "IO::AIO::FADV_WILLNEED", "IO::AIO::FADV_DONTNEED". |
| 1256 | |
1448 | |
| 1257 | On systems that do not implement "posix_fadvise", this function |
1449 | On systems that do not implement "posix_fadvise", this function |
| 1258 | returns ENOSYS, otherwise the return value of "posix_fadvise". |
1450 | returns ENOSYS, otherwise the return value of "posix_fadvise". |
| 1259 | |
1451 | |
| 1260 | IO::AIO::madvise $scalar, $offset, $len, $advice |
1452 | IO::AIO::madvise $scalar, $offset, $len, $advice |
| 1261 | Simply calls the "posix_madvise" function (see its manpage for |
1453 | Simply calls the "posix_madvise" function (see its manpage for |
| 1262 | details). The following advice constants are avaiable: |
1454 | details). The following advice constants are available: |
| 1263 | "IO::AIO::MADV_NORMAL", "IO::AIO::MADV_SEQUENTIAL", |
1455 | "IO::AIO::MADV_NORMAL", "IO::AIO::MADV_SEQUENTIAL", |
| 1264 | "IO::AIO::MADV_RANDOM", "IO::AIO::MADV_WILLNEED", |
1456 | "IO::AIO::MADV_RANDOM", "IO::AIO::MADV_WILLNEED", |
| 1265 | "IO::AIO::MADV_DONTNEED". |
1457 | "IO::AIO::MADV_DONTNEED". |
| 1266 | |
1458 | |
| 1267 | On systems that do not implement "posix_madvise", this function |
1459 | On systems that do not implement "posix_madvise", this function |
| 1268 | returns ENOSYS, otherwise the return value of "posix_madvise". |
1460 | returns ENOSYS, otherwise the return value of "posix_madvise". |
| 1269 | |
1461 | |
| 1270 | IO::AIO::mprotect $scalar, $offset, $len, $protect |
1462 | IO::AIO::mprotect $scalar, $offset, $len, $protect |
| 1271 | Simply calls the "mprotect" function on the preferably AIO::mmap'ed |
1463 | Simply calls the "mprotect" function on the preferably AIO::mmap'ed |
| 1272 | $scalar (see its manpage for details). The following protect |
1464 | $scalar (see its manpage for details). The following protect |
| 1273 | constants are avaiable: "IO::AIO::PROT_NONE", "IO::AIO::PROT_READ", |
1465 | constants are available: "IO::AIO::PROT_NONE", "IO::AIO::PROT_READ", |
| 1274 | "IO::AIO::PROT_WRITE", "IO::AIO::PROT_EXEC". |
1466 | "IO::AIO::PROT_WRITE", "IO::AIO::PROT_EXEC". |
| 1275 | |
1467 | |
| 1276 | On systems that do not implement "mprotect", this function returns |
1468 | On systems that do not implement "mprotect", this function returns |
| 1277 | ENOSYS, otherwise the return value of "mprotect". |
1469 | ENOSYS, otherwise the return value of "mprotect". |
| 1278 | |
1470 | |
| … | |
… | |
| 1371 | |
1563 | |
| 1372 | FORK BEHAVIOUR |
1564 | FORK BEHAVIOUR |
| 1373 | Usage of pthreads in a program changes the semantics of fork |
1565 | Usage of pthreads in a program changes the semantics of fork |
| 1374 | considerably. Specifically, only async-safe functions can be called |
1566 | considerably. Specifically, only async-safe functions can be called |
| 1375 | after fork. Perl doesn't know about this, so in general, you cannot call |
1567 | after fork. Perl doesn't know about this, so in general, you cannot call |
| 1376 | fork with defined behaviour in perl. IO::AIO uses pthreads, so this |
1568 | fork with defined behaviour in perl if pthreads are involved. IO::AIO |
| 1377 | applies, but many other extensions and (for inexplicable reasons) perl |
1569 | uses pthreads, so this applies, but many other extensions and (for |
| 1378 | itself often is linked against pthreads, so this limitation applies. |
1570 | inexplicable reasons) perl itself often is linked against pthreads, so |
|
|
1571 | this limitation applies to quite a lot of perls. |
| 1379 | |
1572 | |
| 1380 | Some operating systems have extensions that allow safe use of fork, and |
1573 | This module no longer tries to fight your OS, or POSIX. That means |
| 1381 | this module should do "the right thing" on those, and tries on others. |
1574 | IO::AIO only works in the process that loaded it. Forking is fully |
| 1382 | At the time of this writing (2011) only GNU/Linux supports these |
1575 | supported, but using IO::AIO in the child is not. |
| 1383 | extensions to POSIX. |
1576 | |
|
|
1577 | You might get around by not *using* IO::AIO before (or after) forking. |
|
|
1578 | You could also try to call the IO::AIO::reinit function in the child: |
|
|
1579 | |
|
|
1580 | IO::AIO::reinit |
|
|
1581 | Abandons all current requests and I/O threads and simply |
|
|
1582 | reinitialises all data structures. This is not an operation |
|
|
1583 | supported by any standards, but happens to work on GNU/Linux and |
|
|
1584 | some newer BSD systems. |
|
|
1585 | |
|
|
1586 | The only reasonable use for this function is to call it after |
|
|
1587 | forking, if "IO::AIO" was used in the parent. Calling it while |
|
|
1588 | IO::AIO is active in the process will result in undefined behaviour. |
|
|
1589 | Calling it at any time will also result in any undefined (by POSIX) |
|
|
1590 | behaviour. |
| 1384 | |
1591 | |
| 1385 | MEMORY USAGE |
1592 | MEMORY USAGE |
| 1386 | Per-request usage: |
1593 | Per-request usage: |
| 1387 | |
1594 | |
| 1388 | Each aio request uses - depending on your architecture - around 100-200 |
1595 | Each aio request uses - depending on your architecture - around 100-200 |
