… | |
… | |
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.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 |
… | |
… | |
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) |
|
|
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 | |
283 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
284 | 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, |
285 | 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 |
286 | and they all accept an additional (and optional) C<$callback> argument |
286 | which must be a code reference. This code reference will get called with |
287 | which must be a code reference. This code reference will be called after |
287 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
288 | the syscall has been executed in an asynchronous fashion. The results |
288 | perl, which usually delivers "false") as its sole argument after the given |
289 | of the request will be passed as arguments to the callback (and, if an |
289 | syscall has been executed asynchronously. |
290 | error occured, in C<$!>) - for most requests the syscall return code (e.g. |
|
|
291 | most syscalls return C<-1> on error, unlike perl, which usually delivers |
|
|
292 | "false"). |
|
|
293 | |
|
|
294 | Some requests (such as C<aio_readdir>) pass the actual results and |
|
|
295 | communicate failures by passing C<undef>. |
290 | |
296 | |
291 | All functions expecting a filehandle keep a copy of the filehandle |
297 | All functions expecting a filehandle keep a copy of the filehandle |
292 | internally until the request has finished. |
298 | internally until the request has finished. |
293 | |
299 | |
294 | All functions return request objects of type L<IO::AIO::REQ> that allow |
300 | All functions return request objects of type L<IO::AIO::REQ> that allow |
295 | further manipulation of those requests while they are in-flight. |
301 | further manipulation of those requests while they are in-flight. |
296 | |
302 | |
297 | The pathnames you pass to these routines I<should> be absolute. The |
303 | The pathnames you pass to these routines I<should> be absolute. The |
298 | reason for this is that at the time the request is being executed, the |
304 | reason for this is that at the time the request is being executed, the |
299 | current working directory could have changed. Alternatively, you can make |
305 | current working directory could have changed. Alternatively, you can |
300 | sure that you never change the current working directory anywhere in |
306 | make sure that you never change the current working directory anywhere |
301 | the program and then use relative paths. Lastly, you can take advantage |
307 | in the program and then use relative paths. You can also take advantage |
302 | of IO::AIOs working directory abstraction - see the description of the |
308 | of IO::AIOs working directory abstraction, that lets you specify paths |
|
|
309 | relative to some previously-opened "working directory object" - see the |
303 | C<IO::AIO::WD> class later in this document. |
310 | description of the C<IO::AIO::WD> class later in this document. |
304 | |
311 | |
305 | To encode pathnames as octets, either make sure you either: a) always pass |
312 | To encode pathnames as octets, either make sure you either: a) always pass |
306 | in filenames you got from outside (command line, readdir etc.) without |
313 | in filenames you got from outside (command line, readdir etc.) without |
307 | tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode |
314 | tinkering, b) are in your native filesystem encoding, c) use the Encode |
308 | your pathnames to the locale (or other) encoding in effect in the user |
315 | module and encode your pathnames to the locale (or other) encoding in |
309 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
316 | effect in the user environment, d) use Glib::filename_from_unicode on |
310 | use something else to ensure your scalar has the correct contents. |
317 | unicode filenames or e) use something else to ensure your scalar has the |
|
|
318 | correct contents. |
311 | |
319 | |
312 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
320 | This works, btw. independent of the internal UTF-8 bit, which IO::AIO |
313 | handles correctly whether it is set or not. |
321 | handles correctly whether it is set or not. |
|
|
322 | |
|
|
323 | =head2 AIO REQUEST FUNCTIONS |
314 | |
324 | |
315 | =over 4 |
325 | =over 4 |
316 | |
326 | |
317 | =item $prev_pri = aioreq_pri [$pri] |
327 | =item $prev_pri = aioreq_pri [$pri] |
318 | |
328 | |
… | |
… | |
400 | |
410 | |
401 | Or in other words: the file descriptor will be closed, but it will not be |
411 | Or in other words: the file descriptor will be closed, but it will not be |
402 | free for reuse until the perl filehandle is closed. |
412 | free for reuse until the perl filehandle is closed. |
403 | |
413 | |
404 | =cut |
414 | =cut |
|
|
415 | |
|
|
416 | =item aio_seek $fh, $offset, $whence, $callback->($offs) |
|
|
417 | |
|
|
418 | Seeks the filehandle to the new C<$offset>, similarly to perl's |
|
|
419 | C<sysseek>. The C<$whence> can use the traditional values (C<0> for |
|
|
420 | C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for |
|
|
421 | C<IO::AIO::SEEK_END>). |
|
|
422 | |
|
|
423 | The resulting absolute offset will be passed to the callback, or C<-1> in |
|
|
424 | case of an error. |
|
|
425 | |
|
|
426 | In theory, the C<$whence> constants could be different than the |
|
|
427 | corresponding values from L<Fcntl>, but perl guarantees they are the same, |
|
|
428 | so don't panic. |
405 | |
429 | |
406 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
430 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
407 | |
431 | |
408 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
432 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
409 | |
433 | |
… | |
… | |
967 | my $grp = aio_group $cb; |
991 | my $grp = aio_group $cb; |
968 | |
992 | |
969 | $maxreq = 4 if $maxreq <= 0; |
993 | $maxreq = 4 if $maxreq <= 0; |
970 | |
994 | |
971 | # get a wd object |
995 | # get a wd object |
972 | |
|
|
973 | aioreq_pri $pri; |
996 | aioreq_pri $pri; |
974 | add $grp aio_wd $path, sub { |
997 | add $grp aio_wd $path, sub { |
|
|
998 | $_[0] |
|
|
999 | or return $grp->result (); |
|
|
1000 | |
975 | my $wd = [shift, "."]; |
1001 | my $wd = [shift, "."]; |
976 | |
1002 | |
977 | # stat once |
1003 | # stat once |
978 | aioreq_pri $pri; |
1004 | aioreq_pri $pri; |
979 | add $grp aio_stat $wd, sub { |
1005 | add $grp aio_stat $wd, sub { |
… | |
… | |
1295 | object. This object stores the canonicalised, absolute version of the |
1321 | object. This object stores the canonicalised, absolute version of the |
1296 | path, and on systems that allow it, also a directory file descriptor. |
1322 | path, and on systems that allow it, also a directory file descriptor. |
1297 | |
1323 | |
1298 | Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat> |
1324 | Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat> |
1299 | or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD |
1325 | or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD |
1300 | object and a pathname instead. If the pathname is absolute, the |
1326 | object and a pathname instead (or the IO::AIO::WD object alone, which |
|
|
1327 | gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the |
1301 | IO::AIO::WD objetc is ignored, otherwise the pathname is resolved relative |
1328 | IO::AIO::WD object is ignored, otherwise the pathname is resolved relative |
1302 | to that IO::AIO::WD object. |
1329 | to that IO::AIO::WD object. |
1303 | |
1330 | |
1304 | For example, to get a wd object for F</etc> and then stat F<passwd> |
1331 | For example, to get a wd object for F</etc> and then stat F<passwd> |
1305 | inside, you would write: |
1332 | inside, you would write: |
1306 | |
1333 | |
… | |
… | |
1314 | aio_stat [$etcdir, "passwd"], sub { |
1341 | aio_stat [$etcdir, "passwd"], sub { |
1315 | # yay |
1342 | # yay |
1316 | }; |
1343 | }; |
1317 | }; |
1344 | }; |
1318 | |
1345 | |
1319 | This shows that creating an IO::AIO::WD object is itself a potentially |
1346 | That C<aio_wd> is a request and not a normal function shows that creating |
1320 | blocking operation, which is why it is done asynchronously. |
1347 | an IO::AIO::WD object is itself a potentially blocking operation, which is |
|
|
1348 | why it is done asynchronously. |
|
|
1349 | |
|
|
1350 | To stat the directory obtained with C<aio_wd> above, one could write |
|
|
1351 | either 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 |
1321 | |
1356 | |
1322 | As with normal pathnames, IO::AIO keeps a copy of the working directory |
1357 | As with normal pathnames, IO::AIO keeps a copy of the working directory |
1323 | object and the pathname string, so you could write the following without |
1358 | object and the pathname string, so you could write the following without |
1324 | causing any issues due to C<$path> getting reused: |
1359 | causing any issues due to C<$path> getting reused: |
1325 | |
1360 | |
… | |
… | |
1505 | |
1540 | |
1506 | Sets a feeder/generator on this group: every group can have an attached |
1541 | Sets a feeder/generator on this group: every group can have an attached |
1507 | generator that generates requests if idle. The idea behind this is that, |
1542 | generator that generates requests if idle. The idea behind this is that, |
1508 | although you could just queue as many requests as you want in a group, |
1543 | although you could just queue as many requests as you want in a group, |
1509 | this might starve other requests for a potentially long time. For example, |
1544 | this might starve other requests for a potentially long time. For example, |
1510 | C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, |
1545 | C<aio_scandir> might generate hundreds of thousands of C<aio_stat> |
1511 | delaying any later requests for a long time. |
1546 | requests, delaying any later requests for a long time. |
1512 | |
1547 | |
1513 | To avoid this, and allow incremental generation of requests, you can |
1548 | To avoid this, and allow incremental generation of requests, you can |
1514 | instead a group and set a feeder on it that generates those requests. The |
1549 | instead a group and set a feeder on it that generates those requests. The |
1515 | feed callback will be called whenever there are few enough (see C<limit>, |
1550 | feed callback will be called whenever there are few enough (see C<limit>, |
1516 | below) requests active in the group itself and is expected to queue more |
1551 | below) requests active in the group itself and is expected to queue more |