… | |
… | |
171 | use common::sense; |
171 | use common::sense; |
172 | |
172 | |
173 | use base 'Exporter'; |
173 | use base 'Exporter'; |
174 | |
174 | |
175 | BEGIN { |
175 | BEGIN { |
176 | our $VERSION = 4.34; |
176 | our $VERSION = 4.35; |
177 | |
177 | |
178 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
178 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
179 | 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 |
180 | aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl |
180 | aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl |
181 | aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range |
181 | aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range |
182 | aio_pathsync aio_readahead aio_fiemap aio_allocate |
182 | aio_pathsync aio_readahead aio_fiemap aio_allocate |
183 | aio_rename aio_link aio_move aio_copy aio_group |
183 | aio_rename aio_rename2 aio_link aio_move aio_copy aio_group |
184 | 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 |
185 | aio_chmod aio_utime aio_truncate |
185 | aio_chmod aio_utime aio_truncate |
186 | aio_msync aio_mtouch aio_mlock aio_mlockall |
186 | aio_msync aio_mtouch aio_mlock aio_mlockall |
187 | aio_statvfs |
187 | aio_statvfs |
188 | aio_wd); |
188 | aio_wd); |
… | |
… | |
233 | aio_link $srcpath, $dstpath, $callback->($status) |
233 | aio_link $srcpath, $dstpath, $callback->($status) |
234 | aio_symlink $srcpath, $dstpath, $callback->($status) |
234 | aio_symlink $srcpath, $dstpath, $callback->($status) |
235 | aio_readlink $pathname, $callback->($link) |
235 | aio_readlink $pathname, $callback->($link) |
236 | aio_realpath $pathname, $callback->($path) |
236 | aio_realpath $pathname, $callback->($path) |
237 | aio_rename $srcpath, $dstpath, $callback->($status) |
237 | aio_rename $srcpath, $dstpath, $callback->($status) |
|
|
238 | aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
238 | aio_mkdir $pathname, $mode, $callback->($status) |
239 | aio_mkdir $pathname, $mode, $callback->($status) |
239 | aio_rmdir $pathname, $callback->($status) |
240 | aio_rmdir $pathname, $callback->($status) |
240 | aio_readdir $pathname, $callback->($entries) |
241 | aio_readdir $pathname, $callback->($entries) |
241 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
242 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
242 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
243 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
… | |
… | |
252 | aio_syncfs $fh, $callback->($status) |
253 | aio_syncfs $fh, $callback->($status) |
253 | aio_fsync $fh, $callback->($status) |
254 | aio_fsync $fh, $callback->($status) |
254 | aio_fdatasync $fh, $callback->($status) |
255 | aio_fdatasync $fh, $callback->($status) |
255 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
256 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
256 | aio_pathsync $pathname, $callback->($status) |
257 | aio_pathsync $pathname, $callback->($status) |
257 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
258 | aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
258 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
259 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
259 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
260 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
260 | aio_mlockall $flags, $callback->($status) |
261 | aio_mlockall $flags, $callback->($status) |
261 | aio_group $callback->(...) |
262 | aio_group $callback->(...) |
262 | aio_nop $callback->() |
263 | aio_nop $callback->() |
… | |
… | |
276 | IO::AIO::idle_timeout $seconds |
277 | IO::AIO::idle_timeout $seconds |
277 | IO::AIO::max_outstanding $maxreqs |
278 | IO::AIO::max_outstanding $maxreqs |
278 | IO::AIO::nreqs |
279 | IO::AIO::nreqs |
279 | IO::AIO::nready |
280 | IO::AIO::nready |
280 | IO::AIO::npending |
281 | IO::AIO::npending |
|
|
282 | $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL] |
|
|
283 | IO::AIO::min_fdlimit $nfd [EXPERIMENTAL] |
281 | |
284 | |
282 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
285 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
283 | IO::AIO::fadvise $fh, $offset, $len, $advice |
286 | IO::AIO::fadvise $fh, $offset, $len, $advice |
284 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
287 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
285 | IO::AIO::munmap $scalar |
288 | IO::AIO::munmap $scalar |
… | |
… | |
445 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
448 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
446 | |
449 | |
447 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
450 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
448 | |
451 | |
449 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
452 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
450 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> |
453 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and |
451 | and calls the callback without the actual number of bytes read (or -1 on |
454 | calls the callback with the actual number of bytes transferred (or -1 on |
452 | error, just like the syscall). |
455 | error, just like the syscall). |
453 | |
456 | |
454 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
457 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
455 | offset plus the actual number of bytes read. |
458 | offset plus the actual number of bytes read. |
456 | |
459 | |
… | |
… | |
739 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
742 | C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate |
740 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
743 | space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE | IO::AIO::FALLOC_FL_KEEP_SIZE>, |
741 | to deallocate a file range. |
744 | to deallocate a file range. |
742 | |
745 | |
743 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
746 | IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range |
744 | (without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see |
747 | (without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range, |
745 | your L<fallocate(2)> manpage). |
748 | C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE> |
|
|
749 | to unshare shared blocks (see your L<fallocate(2)> manpage). |
746 | |
750 | |
747 | The file system block size used by C<fallocate> is presumably the |
751 | The file system block size used by C<fallocate> is presumably the |
748 | C<f_bsize> returned by C<statvfs>. |
752 | C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes |
|
|
753 | can dictate other limitations. |
749 | |
754 | |
750 | If C<fallocate> isn't available or cannot be emulated (currently no |
755 | If C<fallocate> isn't available or cannot be emulated (currently no |
751 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
756 | emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>. |
752 | |
757 | |
753 | |
758 | |
… | |
… | |
810 | rename(2) and call the callback with the result code. |
815 | rename(2) and call the callback with the result code. |
811 | |
816 | |
812 | On systems that support the AIO::WD working directory abstraction |
817 | On systems that support the AIO::WD working directory abstraction |
813 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
818 | natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead |
814 | of failing, C<rename> is called on the absolute path of C<$wd>. |
819 | of failing, C<rename> is called on the absolute path of C<$wd>. |
|
|
820 | |
|
|
821 | |
|
|
822 | =item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status) |
|
|
823 | |
|
|
824 | Basically a version of C<aio_rename> with an additional C<$flags> |
|
|
825 | argument. Calling this with C<$flags=0> is the same as calling |
|
|
826 | C<aio_rename>. |
|
|
827 | |
|
|
828 | Non-zero flags are currently only supported on GNU/Linux systems that |
|
|
829 | support renameat2. Other systems fail with C<ENOSYS> in this case. |
|
|
830 | |
|
|
831 | The following constants are available (missing ones are, as usual C<0>), |
|
|
832 | see renameat2(2) for details: |
|
|
833 | |
|
|
834 | C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE> |
|
|
835 | and C<IO::AIO::RENAME_WHITEOUT>. |
815 | |
836 | |
816 | |
837 | |
817 | =item aio_mkdir $pathname, $mode, $callback->($status) |
838 | =item aio_mkdir $pathname, $mode, $callback->($status) |
818 | |
839 | |
819 | Asynchronously mkdir (create) a directory and call the callback with |
840 | Asynchronously mkdir (create) a directory and call the callback with |
… | |
… | |
938 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
959 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
939 | |
960 | |
940 | Try to copy the I<file> (directories not supported as either source or |
961 | Try to copy the I<file> (directories not supported as either source or |
941 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
962 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
942 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
963 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
|
|
964 | |
|
|
965 | Existing destination files will be truncated. |
943 | |
966 | |
944 | This is a composite request that creates the destination file with |
967 | This is a composite request that creates the destination file with |
945 | mode 0200 and copies the contents of the source file into it using |
968 | mode 0200 and copies the contents of the source file into it using |
946 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
969 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
947 | uid/gid, in that order. |
970 | uid/gid, in that order. |
… | |
… | |
1057 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
1080 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
1058 | efficiently separate the entries of directory C<$path> into two sets of |
1081 | efficiently separate the entries of directory C<$path> into two sets of |
1059 | names, directories you can recurse into (directories), and ones you cannot |
1082 | names, directories you can recurse into (directories), and ones you cannot |
1060 | recurse into (everything else, including symlinks to directories). |
1083 | recurse into (everything else, including symlinks to directories). |
1061 | |
1084 | |
1062 | C<aio_scandir> is a composite request that creates of many sub requests_ |
1085 | C<aio_scandir> is a composite request that generates many sub requests. |
1063 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
1086 | C<$maxreq> specifies the maximum number of outstanding aio requests that |
1064 | this function generates. If it is C<< <= 0 >>, then a suitable default |
1087 | this function generates. If it is C<< <= 0 >>, then a suitable default |
1065 | will be chosen (currently 4). |
1088 | will be chosen (currently 4). |
1066 | |
1089 | |
1067 | On error, the callback is called without arguments, otherwise it receives |
1090 | On error, the callback is called without arguments, otherwise it receives |
… | |
… | |
1254 | other processes), although if you are careful and know what you are doing, |
1277 | other processes), although if you are careful and know what you are doing, |
1255 | you still can. |
1278 | you still can. |
1256 | |
1279 | |
1257 | The following constants are available (missing ones are, as usual C<0>): |
1280 | The following constants are available (missing ones are, as usual C<0>): |
1258 | |
1281 | |
|
|
1282 | C<F_DUPFD_CLOEXEC>, |
|
|
1283 | |
|
|
1284 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
|
|
1285 | |
1259 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
1286 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
1260 | |
1287 | |
1261 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
1288 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
1262 | C<FS_IOC_FIEMAP>. |
1289 | C<FS_IOC_FIEMAP>. |
1263 | |
1290 | |
… | |
… | |
1350 | }; |
1377 | }; |
1351 | |
1378 | |
1352 | $grp |
1379 | $grp |
1353 | } |
1380 | } |
1354 | |
1381 | |
1355 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1382 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status) |
1356 | |
1383 | |
1357 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
1384 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
1358 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
1385 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
1359 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
1386 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
1360 | scalar must only be modified in-place while an aio operation is pending on |
1387 | scalar must only be modified in-place while an aio operation is pending on |
… | |
… | |
1362 | |
1389 | |
1363 | It calls the C<msync> function of your OS, if available, with the memory |
1390 | It calls the C<msync> function of your OS, if available, with the memory |
1364 | area starting at C<$offset> in the string and ending C<$length> bytes |
1391 | area starting at C<$offset> in the string and ending C<$length> bytes |
1365 | later. If C<$length> is negative, counts from the end, and if C<$length> |
1392 | later. If C<$length> is negative, counts from the end, and if C<$length> |
1366 | is C<undef>, then it goes till the end of the string. The flags can be |
1393 | is C<undef>, then it goes till the end of the string. The flags can be |
1367 | a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and |
1394 | either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional |
1368 | C<IO::AIO::MS_SYNC>. |
1395 | C<IO::AIO::MS_INVALIDATE>. |
1369 | |
1396 | |
1370 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1397 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
1371 | |
1398 | |
1372 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1399 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
1373 | scalars. |
1400 | scalars. |
… | |
… | |
1456 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
1483 | C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>, |
1457 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
1484 | C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>, |
1458 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
1485 | C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or |
1459 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1486 | C<IO::AIO::FIEMAP_EXTENT_SHARED>. |
1460 | |
1487 | |
1461 | At the time of this writing (Linux 3.2), this requets is unreliable unless |
1488 | At the time of this writing (Linux 3.2), this request is unreliable unless |
1462 | C<$count> is C<undef>, as the kernel has all sorts of bugs preventing |
1489 | C<$count> is C<undef>, as the kernel has all sorts of bugs preventing |
1463 | it to return all extents of a range for files with large number of |
1490 | it to return all extents of a range for files with a large number of |
1464 | extents. The code works around all these issues if C<$count> is undef. |
1491 | extents. The code (only) works around all these issues if C<$count> is |
|
|
1492 | C<undef>. |
1465 | |
1493 | |
1466 | =item aio_group $callback->(...) |
1494 | =item aio_group $callback->(...) |
1467 | |
1495 | |
1468 | This is a very special aio request: Instead of doing something, it is a |
1496 | This is a very special aio request: Instead of doing something, it is a |
1469 | container for other aio requests, which is useful if you want to bundle |
1497 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
1582 | There are some caveats: when directories get renamed (or deleted), the |
1610 | There are some caveats: when directories get renamed (or deleted), the |
1583 | pathname string doesn't change, so will point to the new directory (or |
1611 | pathname string doesn't change, so will point to the new directory (or |
1584 | nowhere at all), while the directory fd, if available on the system, |
1612 | nowhere at all), while the directory fd, if available on the system, |
1585 | will still point to the original directory. Most functions accepting a |
1613 | will still point to the original directory. Most functions accepting a |
1586 | pathname will use the directory fd on newer systems, and the string on |
1614 | pathname will use the directory fd on newer systems, and the string on |
1587 | older systems. Some functions (such as realpath) will always rely on the |
1615 | older systems. Some functions (such as C<aio_realpath>) will always rely on |
1588 | string form of the pathname. |
1616 | the string form of the pathname. |
1589 | |
1617 | |
1590 | So this functionality is mainly useful to get some protection against |
1618 | So this functionality is mainly useful to get some protection against |
1591 | C<chdir>, to easily get an absolute path out of a relative path for future |
1619 | C<chdir>, to easily get an absolute path out of a relative path for future |
1592 | reference, and to speed up doing many operations in the same directory |
1620 | reference, and to speed up doing many operations in the same directory |
1593 | (e.g. when stat'ing all files in a directory). |
1621 | (e.g. when stat'ing all files in a directory). |
… | |
… | |
1985 | This is a very bad function to use in interactive programs because it |
2013 | This is a very bad function to use in interactive programs because it |
1986 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
2014 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1987 | use an C<aio_group> together with a feed callback. |
2015 | use an C<aio_group> together with a feed callback. |
1988 | |
2016 | |
1989 | Its main use is in scripts without an event loop - when you want to stat |
2017 | Its main use is in scripts without an event loop - when you want to stat |
1990 | a lot of files, you can write somehting like this: |
2018 | a lot of files, you can write something like this: |
1991 | |
2019 | |
1992 | IO::AIO::max_outstanding 32; |
2020 | IO::AIO::max_outstanding 32; |
1993 | |
2021 | |
1994 | for my $path (...) { |
2022 | for my $path (...) { |
1995 | aio_stat $path , ...; |
2023 | aio_stat $path , ...; |
… | |
… | |
2040 | some "Advanced I/O" function not available to in Perl, without going the |
2068 | some "Advanced I/O" function not available to in Perl, without going the |
2041 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
2069 | "Asynchronous I/O" route. Many of these have an asynchronous C<aio_*> |
2042 | counterpart. |
2070 | counterpart. |
2043 | |
2071 | |
2044 | =over 4 |
2072 | =over 4 |
|
|
2073 | |
|
|
2074 | =item $numfd = IO::AIO::get_fdlimit |
|
|
2075 | |
|
|
2076 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2077 | |
|
|
2078 | Tries to find the current file descriptor limit and returns it, or |
|
|
2079 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
|
|
2080 | the highest valid file descriptor number. |
|
|
2081 | |
|
|
2082 | =item IO::AIO::min_fdlimit [$numfd] |
|
|
2083 | |
|
|
2084 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2085 | |
|
|
2086 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
|
|
2087 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
|
|
2088 | is missing, it will try to set a very high limit, although this is not |
|
|
2089 | recommended when you know the actual minimum that you require. |
|
|
2090 | |
|
|
2091 | If the limit cannot be raised enough, the function makes a best-effort |
|
|
2092 | attempt to increase the limit as much as possible, using various |
|
|
2093 | tricks, while still failing. You can query the resulting limit using |
|
|
2094 | C<IO::AIO::get_fdlimit>. |
|
|
2095 | |
|
|
2096 | If an error occurs, returns C<undef> and sets C<$!>, otherwise returns |
|
|
2097 | true. |
2045 | |
2098 | |
2046 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2099 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
2047 | |
2100 | |
2048 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
2101 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
2049 | but is blocking (this makes most sense if you know the input data is |
2102 | but is blocking (this makes most sense if you know the input data is |
… | |
… | |
2066 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2119 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
2067 | |
2120 | |
2068 | Simply calls the C<posix_madvise> function (see its |
2121 | Simply calls the C<posix_madvise> function (see its |
2069 | manpage for details). The following advice constants are |
2122 | manpage for details). The following advice constants are |
2070 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2123 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
2071 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>, |
2124 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, |
2072 | C<IO::AIO::MADV_FREE>. |
2125 | C<IO::AIO::MADV_DONTNEED>. |
|
|
2126 | |
|
|
2127 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2128 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2129 | will be reduced to fit into the C<$scalar>. |
2073 | |
2130 | |
2074 | On systems that do not implement C<posix_madvise>, this function returns |
2131 | On systems that do not implement C<posix_madvise>, this function returns |
2075 | ENOSYS, otherwise the return value of C<posix_madvise>. |
2132 | ENOSYS, otherwise the return value of C<posix_madvise>. |
2076 | |
2133 | |
2077 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
2134 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
… | |
… | |
2079 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
2136 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
2080 | $scalar (see its manpage for details). The following protect |
2137 | $scalar (see its manpage for details). The following protect |
2081 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
2138 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
2082 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
2139 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
2083 | |
2140 | |
|
|
2141 | If C<$offset> is negative, counts from the end. If C<$length> is negative, |
|
|
2142 | the remaining length of the C<$scalar> is used. If possible, C<$length> |
|
|
2143 | will be reduced to fit into the C<$scalar>. |
|
|
2144 | |
2084 | On systems that do not implement C<mprotect>, this function returns |
2145 | On systems that do not implement C<mprotect>, this function returns |
2085 | ENOSYS, otherwise the return value of C<mprotect>. |
2146 | ENOSYS, otherwise the return value of C<mprotect>. |
2086 | |
2147 | |
2087 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
2148 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
2088 | |
2149 | |
2089 | Memory-maps a file (or anonymous memory range) and attaches it to the |
2150 | Memory-maps a file (or anonymous memory range) and attaches it to the |
2090 | given C<$scalar>, which will act like a string scalar. Returns true on |
2151 | given C<$scalar>, which will act like a string scalar. Returns true on |
2091 | success, and false otherwise. |
2152 | success, and false otherwise. |
2092 | |
2153 | |
|
|
2154 | The scalar must exist, but its contents do not matter - this means you |
|
|
2155 | cannot use a nonexistant array or hash element. When in doubt, C<undef> |
|
|
2156 | the scalar first. |
|
|
2157 | |
2093 | The only operations allowed on the scalar are C<substr>/C<vec> that don't |
2158 | The only operations allowed on the mmapped scalar are C<substr>/C<vec>, |
2094 | change the string length, and most read-only operations such as copying it |
2159 | which don't change the string length, and most read-only operations such |
2095 | or searching it with regexes and so on. |
2160 | as copying it or searching it with regexes and so on. |
2096 | |
2161 | |
2097 | Anything else is unsafe and will, at best, result in memory leaks. |
2162 | Anything else is unsafe and will, at best, result in memory leaks. |
2098 | |
2163 | |
2099 | The memory map associated with the C<$scalar> is automatically removed |
2164 | The memory map associated with the C<$scalar> is automatically removed |
2100 | when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or |
2165 | when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap> |
2101 | C<IO::AIO::munmap> functions are called. |
2166 | or C<IO::AIO::munmap> functions are called on it. |
2102 | |
2167 | |
2103 | This calls the C<mmap>(2) function internally. See your system's manual |
2168 | This calls the C<mmap>(2) function internally. See your system's manual |
2104 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
2169 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
2105 | |
2170 | |
2106 | The C<$length> must be larger than zero and smaller than the actual |
2171 | The C<$length> must be larger than zero and smaller than the actual |