… | |
… | |
168 | use common::sense; |
168 | use common::sense; |
169 | |
169 | |
170 | use base 'Exporter'; |
170 | use base 'Exporter'; |
171 | |
171 | |
172 | BEGIN { |
172 | BEGIN { |
173 | our $VERSION = '4.11'; |
173 | our $VERSION = '4.15'; |
174 | |
174 | |
175 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
175 | 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 |
176 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
177 | aio_scandir aio_symlink aio_readlink aio_realpath aio_sync |
177 | aio_scandir aio_symlink aio_readlink aio_realpath aio_sync |
178 | aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate |
178 | aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate |
179 | aio_pathsync aio_readahead |
179 | aio_pathsync aio_readahead aio_fiemap |
180 | aio_rename aio_link aio_move aio_copy aio_group |
180 | aio_rename aio_link aio_move aio_copy aio_group |
181 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
181 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
182 | aio_chmod aio_utime aio_truncate |
182 | aio_chmod aio_utime aio_truncate |
183 | aio_msync aio_mtouch aio_mlock aio_mlockall |
183 | aio_msync aio_mtouch aio_mlock aio_mlockall |
184 | aio_statvfs |
184 | aio_statvfs |
… | |
… | |
202 | |
202 | |
203 | =head1 FUNCTIONS |
203 | =head1 FUNCTIONS |
204 | |
204 | |
205 | =head2 QUICK OVERVIEW |
205 | =head2 QUICK OVERVIEW |
206 | |
206 | |
207 | This section simply lists the prototypes of the most important functions |
207 | This section simply lists the prototypes most of the functions for |
208 | for quick reference. See the following sections for function-by-function |
208 | quick reference. See the following sections for function-by-function |
209 | documentation. |
209 | documentation. |
210 | |
210 | |
211 | aio_wd $pathname, $callback->($wd) |
211 | aio_wd $pathname, $callback->($wd) |
212 | aio_open $pathname, $flags, $mode, $callback->($fh) |
212 | aio_open $pathname, $flags, $mode, $callback->($fh) |
213 | aio_close $fh, $callback->($status) |
213 | aio_close $fh, $callback->($status) |
|
|
214 | aio_seek $fh,$offset,$whence, $callback->($offs) |
214 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
215 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
215 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
216 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
216 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
217 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
217 | aio_readahead $fh,$offset,$length, $callback->($retval) |
218 | aio_readahead $fh,$offset,$length, $callback->($retval) |
218 | aio_stat $fh_or_path, $callback->($status) |
219 | aio_stat $fh_or_path, $callback->($status) |
219 | aio_lstat $fh, $callback->($status) |
220 | aio_lstat $fh, $callback->($status) |
220 | aio_statvfs $fh_or_path, $callback->($statvfs) |
221 | aio_statvfs $fh_or_path, $callback->($statvfs) |
221 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
222 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
222 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
223 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
224 | aio_chmod $fh_or_path, $mode, $callback->($status) |
223 | aio_truncate $fh_or_path, $offset, $callback->($status) |
225 | aio_truncate $fh_or_path, $offset, $callback->($status) |
224 | aio_chmod $fh_or_path, $mode, $callback->($status) |
226 | aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
|
|
227 | aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) |
225 | aio_unlink $pathname, $callback->($status) |
228 | aio_unlink $pathname, $callback->($status) |
226 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
229 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
227 | aio_link $srcpath, $dstpath, $callback->($status) |
230 | aio_link $srcpath, $dstpath, $callback->($status) |
228 | aio_symlink $srcpath, $dstpath, $callback->($status) |
231 | aio_symlink $srcpath, $dstpath, $callback->($status) |
229 | aio_readlink $pathname, $callback->($link) |
232 | aio_readlink $pathname, $callback->($link) |
… | |
… | |
271 | IO::AIO::nready |
274 | IO::AIO::nready |
272 | IO::AIO::npending |
275 | IO::AIO::npending |
273 | |
276 | |
274 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
277 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
275 | IO::AIO::fadvise $fh, $offset, $len, $advice |
278 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
279 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
|
|
280 | IO::AIO::munmap $scalar |
276 | IO::AIO::madvise $scalar, $offset, $length, $advice |
281 | IO::AIO::madvise $scalar, $offset, $length, $advice |
277 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
282 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
278 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
283 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
279 | IO::AIO::munlockall |
284 | IO::AIO::munlockall |
280 | |
285 | |
281 | =head2 AIO REQUEST FUNCTIONS |
286 | =head2 API NOTES |
282 | |
287 | |
283 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
288 | 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, |
289 | 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 |
290 | 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 |
291 | which must be a code reference. This code reference will be called after |
… | |
… | |
317 | correct contents. |
322 | correct contents. |
318 | |
323 | |
319 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
324 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
320 | handles correctly whether it is set or not. |
325 | handles correctly whether it is set or not. |
321 | |
326 | |
|
|
327 | =head2 AIO REQUEST FUNCTIONS |
|
|
328 | |
322 | =over 4 |
329 | =over 4 |
323 | |
330 | |
324 | =item $prev_pri = aioreq_pri [$pri] |
331 | =item $prev_pri = aioreq_pri [$pri] |
325 | |
332 | |
326 | Returns the priority value that would be used for the next request and, if |
333 | Returns the priority value that would be used for the next request and, if |
… | |
… | |
407 | |
414 | |
408 | Or in other words: the file descriptor will be closed, but it will not be |
415 | 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. |
416 | free for reuse until the perl filehandle is closed. |
410 | |
417 | |
411 | =cut |
418 | =cut |
|
|
419 | |
|
|
420 | =item aio_seek $fh, $offset, $whence, $callback->($offs) |
|
|
421 | |
|
|
422 | Seeks the filehandle to the new C<$offset>, similarly to perl's |
|
|
423 | C<sysseek>. The C<$whence> can use the traditional values (C<0> for |
|
|
424 | C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for |
|
|
425 | C<IO::AIO::SEEK_END>). |
|
|
426 | |
|
|
427 | The resulting absolute offset will be passed to the callback, or C<-1> in |
|
|
428 | case of an error. |
|
|
429 | |
|
|
430 | In theory, the C<$whence> constants could be different than the |
|
|
431 | corresponding values from L<Fcntl>, but perl guarantees they are the same, |
|
|
432 | so don't panic. |
|
|
433 | |
|
|
434 | As a GNU/Linux (and maybe Solaris) extension, also the constants |
|
|
435 | C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they |
|
|
436 | could be found. No guarantees about suitability for use in C<aio_seek> or |
|
|
437 | Perl's C<sysseek> can be made though, although I would naively assume they |
|
|
438 | "just work". |
412 | |
439 | |
413 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
440 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
414 | |
441 | |
415 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
442 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
416 | |
443 | |
… | |
… | |
611 | |
638 | |
612 | |
639 | |
613 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
640 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
614 | |
641 | |
615 | Works like truncate(2) or ftruncate(2). |
642 | Works like truncate(2) or ftruncate(2). |
|
|
643 | |
|
|
644 | |
|
|
645 | =item aio_allocate $fh, $mode, $offset, $len, $callback->($status) |
|
|
646 | |
|
|
647 | Allocates or freed disk space according to the C<$mode> argument. See the |
|
|
648 | linux C<fallocate> docuemntation for details. |
|
|
649 | |
|
|
650 | C<$mode> can currently be C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> |
|
|
651 | to allocate space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | |
|
|
652 | IO::AIO::FALLOC_FL_KEEP_SIZE>, to deallocate a file range. |
|
|
653 | |
|
|
654 | The file system block size used by C<fallocate> is presumably the |
|
|
655 | C<f_bsize> returned by C<statvfs>. |
|
|
656 | |
|
|
657 | If C<fallocate> isn't available or cannot be emulated (currently no |
|
|
658 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
616 | |
659 | |
617 | |
660 | |
618 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
661 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
619 | |
662 | |
620 | Works like perl's C<chmod> function. |
663 | Works like perl's C<chmod> function. |
… | |
… | |
1232 | |
1275 | |
1233 | Example: asynchronously lock all current and future pages into memory. |
1276 | Example: asynchronously lock all current and future pages into memory. |
1234 | |
1277 | |
1235 | aio_mlockall IO::AIO::MCL_FUTURE; |
1278 | aio_mlockall IO::AIO::MCL_FUTURE; |
1236 | |
1279 | |
|
|
1280 | =item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents) |
|
|
1281 | |
|
|
1282 | Queries the extents of the given file (by calling the Linux FIEMAP ioctl, |
|
|
1283 | see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If the |
|
|
1284 | C<ioctl> is not available on your OS, then this request will fail with |
|
|
1285 | C<ENOSYS>. |
|
|
1286 | |
|
|
1287 | C<$start> is the starting offset to query extents for, C<$length> is the |
|
|
1288 | size of the range to query - if it is C<undef>, then the whole file will |
|
|
1289 | be queried. |
|
|
1290 | |
|
|
1291 | C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or |
|
|
1292 | C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also |
|
|
1293 | exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query |
|
|
1294 | the data portion. |
|
|
1295 | |
|
|
1296 | C<$count> is the maximum number of extent records to return. If it is |
|
|
1297 | C<undef>, then IO::AIO queries all extents of the range. As a very special |
|
|
1298 | case, if it is C<0>, then the callback receives the number of extents |
|
|
1299 | instead of the extents themselves (which is unreliable, see below). |
|
|
1300 | |
|
|
1301 | If an error occurs, the callback receives no arguments. The special |
|
|
1302 | C<errno> value C<IO::AIO::EBADR> is available to test for flag errors. |
|
|
1303 | |
|
|
1304 | Otherwise, the callback receives an array reference with extent |
|
|
1305 | structures. Each extent structure is an array reference itself, with the |
|
|
1306 | following members: |
|
|
1307 | |
|
|
1308 | [$logical, $physical, $length, $flags] |
|
|
1309 | |
|
|
1310 | Flags is any combination of the following flag values (typically either C<0> |
|
|
1311 | or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)): |
|
|
1312 | |
|
|
1313 | C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>, |
|
|
1314 | C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>, |
|
|
1315 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
|
|
1316 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
|
|
1317 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
|
|
1318 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
|
|
1319 | |
|
|
1320 | At the time of this writing (Linux 3.2), this requets is unreliable unless |
|
|
1321 | C<$count> is C<undef>, as the kernel has all sorts of bugs preventing |
|
|
1322 | it to return all extents of a range for files with large number of |
|
|
1323 | extents. The code works around all these issues if C<$count> is undef. |
|
|
1324 | |
1237 | =item aio_group $callback->(...) |
1325 | =item aio_group $callback->(...) |
1238 | |
1326 | |
1239 | This is a very special aio request: Instead of doing something, it is a |
1327 | 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 |
1328 | container for other aio requests, which is useful if you want to bundle |
1241 | many requests into a single, composite, request with a definite callback |
1329 | many requests into a single, composite, request with a definite callback |
… | |
… | |
1843 | ENOSYS, otherwise the return value of C<mprotect>. |
1931 | ENOSYS, otherwise the return value of C<mprotect>. |
1844 | |
1932 | |
1845 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
1933 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
1846 | |
1934 | |
1847 | Memory-maps a file (or anonymous memory range) and attaches it to the |
1935 | Memory-maps a file (or anonymous memory range) and attaches it to the |
1848 | given C<$scalar>, which will act like a string scalar. |
1936 | given C<$scalar>, which will act like a string scalar. Returns true on |
|
|
1937 | success, and false otherwise. |
1849 | |
1938 | |
1850 | The only operations allowed on the scalar are C<substr>/C<vec> that don't |
1939 | The only operations allowed on the scalar are C<substr>/C<vec> that don't |
1851 | change the string length, and most read-only operations such as copying it |
1940 | change the string length, and most read-only operations such as copying it |
1852 | or searching it with regexes and so on. |
1941 | or searching it with regexes and so on. |
1853 | |
1942 | |
… | |
… | |
1906 | Calls the C<munlockall> function. |
1995 | Calls the C<munlockall> function. |
1907 | |
1996 | |
1908 | On systems that do not implement C<munlockall>, this function returns |
1997 | On systems that do not implement C<munlockall>, this function returns |
1909 | ENOSYS, otherwise the return value of C<munlockall>. |
1998 | ENOSYS, otherwise the return value of C<munlockall>. |
1910 | |
1999 | |
|
|
2000 | =item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
|
|
2001 | |
|
|
2002 | Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or |
|
|
2003 | C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they |
|
|
2004 | should be the file offset. |
|
|
2005 | |
|
|
2006 | C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might |
|
|
2007 | silently corrupt the data in this case. |
|
|
2008 | |
|
|
2009 | The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>, |
|
|
2010 | C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and |
|
|
2011 | C<IO::AIO::SPLICE_F_GIFT>. |
|
|
2012 | |
|
|
2013 | See the C<splice(2)> manpage for details. |
|
|
2014 | |
|
|
2015 | =item IO::AIO::tee $r_fh, $w_fh, $length, $flags |
|
|
2016 | |
|
|
2017 | Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the |
|
|
2018 | description for C<IO::AIO::splice> above for details. |
|
|
2019 | |
1911 | =back |
2020 | =back |
1912 | |
2021 | |
1913 | =cut |
2022 | =cut |
1914 | |
2023 | |
1915 | min_parallel 8; |
2024 | min_parallel 8; |