ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/AIO.pm
(Generate patch)

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.267 by root, Tue Aug 9 11:39:17 2016 UTC vs.
Revision 1.270 by root, Fri Jun 23 03:23:19 2017 UTC

… …
171use common::sense; 171use common::sense;
172 172
173use base 'Exporter'; 173use base 'Exporter';
174 174
175BEGIN { 175BEGIN {
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->()
… …
812On systems that support the AIO::WD working directory abstraction 813On systems that support the AIO::WD working directory abstraction
813natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead 814natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
814of failing, C<rename> is called on the absolute path of C<$wd>. 815of failing, C<rename> is called on the absolute path of C<$wd>.
815 816
816 817
818=item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
819
820Basically a version of C<aio_rename> with an additional C<$flags>
821argument. Calling this with C<$flags=0> is the same as calling
822C<aio_rename>.
823
824Non-zero flags are currently only supported on GNU/Linux systems that
825support renameat2. Other systems fail with C<ENOSYS> in this case.
826
827The following constants are available (missing ones are, as usual C<0>),
828see renameat2(2) for details:
829
830C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE>
831and C<IO::AIO::RENAME_WHITEOUT>.
832
833
817=item aio_mkdir $pathname, $mode, $callback->($status) 834=item aio_mkdir $pathname, $mode, $callback->($status)
818 835
819Asynchronously mkdir (create) a directory and call the callback with 836Asynchronously mkdir (create) a directory and call the callback with
820the result code. C<$mode> will be modified by the umask at the time the 837the result code. C<$mode> will be modified by the umask at the time the
821request is executed, so do not change your umask. 838request is executed, so do not change your umask.
… …
1350 }; 1367 };
1351 1368
1352 $grp 1369 $grp
1353} 1370}
1354 1371
1355=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 1372=item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
1356 1373
1357This is a rather advanced IO::AIO call, which only works on mmap(2)ed 1374This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1358scalars (see the C<IO::AIO::mmap> function, although it also works on data 1375scalars (see the C<IO::AIO::mmap> function, although it also works on data
1359scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the 1376scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1360scalar must only be modified in-place while an aio operation is pending on 1377scalar must only be modified in-place while an aio operation is pending on
… …
1362 1379
1363It calls the C<msync> function of your OS, if available, with the memory 1380It calls the C<msync> function of your OS, if available, with the memory
1364area starting at C<$offset> in the string and ending C<$length> bytes 1381area starting at C<$offset> in the string and ending C<$length> bytes
1365later. If C<$length> is negative, counts from the end, and if C<$length> 1382later. If C<$length> is negative, counts from the end, and if C<$length>
1366is C<undef>, then it goes till the end of the string. The flags can be 1383is C<undef>, then it goes till the end of the string. The flags can be
1367a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and 1384either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional
1368C<IO::AIO::MS_SYNC>. 1385C<IO::AIO::MS_INVALIDATE>.
1369 1386
1370=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 1387=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1371 1388
1372This is a rather advanced IO::AIO call, which works best on mmap(2)ed 1389This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1373scalars. 1390scalars.
… …
2069manpage for details). The following advice constants are 2086manpage for details). The following advice constants are
2070available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, 2087available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
2071C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>, 2088C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>,
2072C<IO::AIO::MADV_FREE>. 2089C<IO::AIO::MADV_FREE>.
2073 2090
2091If C<$offset> is negative, counts from the end. If C<$length> is negative,
2092the remaining length of the C<$scalar> is used. If possible, C<$length>
2093will be reduced to fit into the C<$scalar>.
2094
2074On systems that do not implement C<posix_madvise>, this function returns 2095On systems that do not implement C<posix_madvise>, this function returns
2075ENOSYS, otherwise the return value of C<posix_madvise>. 2096ENOSYS, otherwise the return value of C<posix_madvise>.
2076 2097
2077=item IO::AIO::mprotect $scalar, $offset, $len, $protect 2098=item IO::AIO::mprotect $scalar, $offset, $len, $protect
2078 2099
2079Simply calls the C<mprotect> function on the preferably AIO::mmap'ed 2100Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
2080$scalar (see its manpage for details). The following protect 2101$scalar (see its manpage for details). The following protect
2081constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, 2102constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
2082C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. 2103C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
2083 2104
2105If C<$offset> is negative, counts from the end. If C<$length> is negative,
2106the remaining length of the C<$scalar> is used. If possible, C<$length>
2107will be reduced to fit into the C<$scalar>.
2108
2084On systems that do not implement C<mprotect>, this function returns 2109On systems that do not implement C<mprotect>, this function returns
2085ENOSYS, otherwise the return value of C<mprotect>. 2110ENOSYS, otherwise the return value of C<mprotect>.
2086 2111
2087=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 2112=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
2088 2113
2089Memory-maps a file (or anonymous memory range) and attaches it to the 2114Memory-maps a file (or anonymous memory range) and attaches it to the
2090given C<$scalar>, which will act like a string scalar. Returns true on 2115given C<$scalar>, which will act like a string scalar. Returns true on
2091success, and false otherwise. 2116success, and false otherwise.
2092 2117
2118The scalar must exist, but its contents do not matter - this means you
2119cannot use a nonexistant array or hash element. When in doubt, C<undef>
2120the scalar first.
2121
2093The only operations allowed on the scalar are C<substr>/C<vec> that don't 2122The only operations allowed on the mmapped scalar are C<substr>/C<vec>,
2094change the string length, and most read-only operations such as copying it 2123which don't change the string length, and most read-only operations such
2095or searching it with regexes and so on. 2124as copying it or searching it with regexes and so on.
2096 2125
2097Anything else is unsafe and will, at best, result in memory leaks. 2126Anything else is unsafe and will, at best, result in memory leaks.
2098 2127
2099The memory map associated with the C<$scalar> is automatically removed 2128The memory map associated with the C<$scalar> is automatically removed
2100when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or 2129when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap>
2101C<IO::AIO::munmap> functions are called. 2130or C<IO::AIO::munmap> functions are called on it.
2102 2131
2103This calls the C<mmap>(2) function internally. See your system's manual 2132This calls the C<mmap>(2) function internally. See your system's manual
2104page for details on the C<$length>, C<$prot> and C<$flags> parameters. 2133page for details on the C<$length>, C<$prot> and C<$flags> parameters.
2105 2134
2106The C<$length> must be larger than zero and smaller than the actual 2135The C<$length> must be larger than zero and smaller than the actual

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines