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.212 by root, Thu Sep 29 22:42:15 2011 UTC vs.
Revision 1.220 by root, Sun Apr 1 17:46:02 2012 UTC

… …
168use common::sense; 168use common::sense;
169 169
170use base 'Exporter'; 170use base 'Exporter';
171 171
172BEGIN { 172BEGIN {
173 our $VERSION = '4.0'; 173 our $VERSION = '4.13';
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
180 aio_rename aio_link aio_move aio_copy aio_group 180 aio_rename aio_link aio_move aio_copy aio_group
… …
209documentation. 209documentation.
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)
225 aio_unlink $pathname, $callback->($status) 226 aio_unlink $pathname, $callback->($status)
226 aio_mknod $pathname, $mode, $dev, $callback->($status) 227 aio_mknod $pathname, $mode, $dev, $callback->($status)
227 aio_link $srcpath, $dstpath, $callback->($status) 228 aio_link $srcpath, $dstpath, $callback->($status)
228 aio_symlink $srcpath, $dstpath, $callback->($status) 229 aio_symlink $srcpath, $dstpath, $callback->($status)
229 aio_readlink $pathname, $callback->($link) 230 aio_readlink $pathname, $callback->($link)
… …
233 aio_rmdir $pathname, $callback->($status) 234 aio_rmdir $pathname, $callback->($status)
234 aio_readdir $pathname, $callback->($entries) 235 aio_readdir $pathname, $callback->($entries)
235 aio_readdirx $pathname, $flags, $callback->($entries, $flags) 236 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
236 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST 237 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
237 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN 238 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
239 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
238 aio_load $pathname, $data, $callback->($status) 240 aio_load $pathname, $data, $callback->($status)
239 aio_copy $srcpath, $dstpath, $callback->($status) 241 aio_copy $srcpath, $dstpath, $callback->($status)
240 aio_move $srcpath, $dstpath, $callback->($status) 242 aio_move $srcpath, $dstpath, $callback->($status)
241 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
242 aio_rmtree $pathname, $callback->($status) 243 aio_rmtree $pathname, $callback->($status)
243 aio_sync $callback->($status) 244 aio_sync $callback->($status)
244 aio_syncfs $fh, $callback->($status) 245 aio_syncfs $fh, $callback->($status)
245 aio_fsync $fh, $callback->($status) 246 aio_fsync $fh, $callback->($status)
246 aio_fdatasync $fh, $callback->($status) 247 aio_fdatasync $fh, $callback->($status)
… …
276 IO::AIO::madvise $scalar, $offset, $length, $advice 277 IO::AIO::madvise $scalar, $offset, $length, $advice
277 IO::AIO::mprotect $scalar, $offset, $length, $protect 278 IO::AIO::mprotect $scalar, $offset, $length, $protect
278 IO::AIO::munlock $scalar, $offset = 0, $length = undef 279 IO::AIO::munlock $scalar, $offset = 0, $length = undef
279 IO::AIO::munlockall 280 IO::AIO::munlockall
280 281
281=head2 AIO REQUEST FUNCTIONS 282=head2 API NOTES
282 283
283All the C<aio_*> calls are more or less thin wrappers around the syscall 284All the C<aio_*> calls are more or less thin wrappers around the syscall
284with the same name (sans C<aio_>). The arguments are similar or identical, 285with the same name (sans C<aio_>). The arguments are similar or identical,
285and they all accept an additional (and optional) C<$callback> argument 286and they all accept an additional (and optional) C<$callback> argument
286which must be a code reference. This code reference will be called after 287which must be a code reference. This code reference will be called after
… …
317correct contents. 318correct contents.
318 319
319This works, btw. independent of the internal UTF-8 bit, which IO::AIO 320This works, btw. independent of the internal UTF-8 bit, which IO::AIO
320handles correctly whether it is set or not. 321handles correctly whether it is set or not.
321 322
323=head2 AIO REQUEST FUNCTIONS
324
322=over 4 325=over 4
323 326
324=item $prev_pri = aioreq_pri [$pri] 327=item $prev_pri = aioreq_pri [$pri]
325 328
326Returns the priority value that would be used for the next request and, if 329Returns the priority value that would be used for the next request and, if
… …
407 410
408Or in other words: the file descriptor will be closed, but it will not be 411Or in other words: the file descriptor will be closed, but it will not be
409free for reuse until the perl filehandle is closed. 412free for reuse until the perl filehandle is closed.
410 413
411=cut 414=cut
415
416=item aio_seek $fh, $offset, $whence, $callback->($offs)
417
418Seeks the filehandle to the new C<$offset>, similarly to perl'S
419C<sysseek>. The C<$whence> can use the traditional values (C<0> for
420C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
421C<IO::AIO::SEEK_END>).
422
423The resulting absolute offset will be passed to the callback, or C<-1> in
424case of an error.
425
426In theory, the C<$whence> constants could be different than the
427corresponding values from L<Fcntl>, but perl guarantees they are the same,
428so don't panic.
412 429
413=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 430=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
414 431
415=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 432=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
416 433
… …
1304object. This object stores the canonicalised, absolute version of the 1321object. This object stores the canonicalised, absolute version of the
1305path, and on systems that allow it, also a directory file descriptor. 1322path, and on systems that allow it, also a directory file descriptor.
1306 1323
1307Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat> 1324Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
1308or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD 1325or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
1309object and a pathname instead. If the pathname is absolute, the 1326object and a pathname instead (or the IO::AIO::WD object alone, which
1327gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
1310IO::AIO::WD objetc is ignored, otherwise the pathname is resolved relative 1328IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
1311to that IO::AIO::WD object. 1329to that IO::AIO::WD object.
1312 1330
1313For example, to get a wd object for F</etc> and then stat F<passwd> 1331For example, to get a wd object for F</etc> and then stat F<passwd>
1314inside, you would write: 1332inside, you would write:
1315 1333
… …
1323 aio_stat [$etcdir, "passwd"], sub { 1341 aio_stat [$etcdir, "passwd"], sub {
1324 # yay 1342 # yay
1325 }; 1343 };
1326 }; 1344 };
1327 1345
1328This shows that creating an IO::AIO::WD object is itself a potentially 1346That C<aio_wd> is a request and not a normal function shows that creating
1329blocking operation, which is why it is done asynchronously. 1347an IO::AIO::WD object is itself a potentially blocking operation, which is
1348why it is done asynchronously.
1349
1350To stat the directory obtained with C<aio_wd> above, one could write
1351either of the following three request calls:
1352
1353 aio_lstat "/etc" , sub { ... # pathname as normal string
1354 aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
1355 aio_lstat $wd , sub { ... # shorthand for the previous
1330 1356
1331As with normal pathnames, IO::AIO keeps a copy of the working directory 1357As with normal pathnames, IO::AIO keeps a copy of the working directory
1332object and the pathname string, so you could write the following without 1358object and the pathname string, so you could write the following without
1333causing any issues due to C<$path> getting reused: 1359causing any issues due to C<$path> getting reused:
1334 1360

Diff Legend

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