… | |
… | |
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 = '3.65'; |
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_sync aio_fsync |
177 | aio_scandir aio_symlink aio_readlink aio_realpath aio_sync |
178 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
178 | aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate |
|
|
179 | aio_pathsync aio_readahead aio_fiemap |
179 | aio_rename aio_link aio_move aio_copy aio_group |
180 | aio_rename aio_link aio_move aio_copy aio_group |
180 | 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 |
181 | aio_chmod aio_utime aio_truncate |
182 | aio_chmod aio_utime aio_truncate |
182 | aio_msync aio_mtouch aio_mlock aio_mlockall |
183 | aio_msync aio_mtouch aio_mlock aio_mlockall |
183 | aio_statvfs); |
184 | aio_statvfs |
|
|
185 | aio_wd); |
184 | |
186 | |
185 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
187 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
186 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
188 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
187 | min_parallel max_parallel max_idle |
189 | min_parallel max_parallel max_idle idle_timeout |
188 | nreqs nready npending nthreads |
190 | nreqs nready npending nthreads |
189 | max_poll_time max_poll_reqs |
191 | max_poll_time max_poll_reqs |
190 | sendfile fadvise madvise |
192 | sendfile fadvise madvise |
191 | mmap munmap munlock munlockall); |
193 | mmap munmap munlock munlockall); |
192 | |
194 | |
… | |
… | |
200 | |
202 | |
201 | =head1 FUNCTIONS |
203 | =head1 FUNCTIONS |
202 | |
204 | |
203 | =head2 QUICK OVERVIEW |
205 | =head2 QUICK OVERVIEW |
204 | |
206 | |
205 | This section simply lists the prototypes of the most important functions |
207 | This section simply lists the prototypes most of the functions for |
206 | for quick reference. See the following sections for function-by-function |
208 | quick reference. See the following sections for function-by-function |
207 | documentation. |
209 | documentation. |
208 | |
210 | |
|
|
211 | aio_wd $pathname, $callback->($wd) |
209 | aio_open $pathname, $flags, $mode, $callback->($fh) |
212 | aio_open $pathname, $flags, $mode, $callback->($fh) |
210 | aio_close $fh, $callback->($status) |
213 | aio_close $fh, $callback->($status) |
|
|
214 | aio_seek $fh,$offset,$whence, $callback->($offs) |
211 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
215 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
212 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
216 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
213 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
217 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
214 | aio_readahead $fh,$offset,$length, $callback->($retval) |
218 | aio_readahead $fh,$offset,$length, $callback->($retval) |
215 | aio_stat $fh_or_path, $callback->($status) |
219 | aio_stat $fh_or_path, $callback->($status) |
216 | aio_lstat $fh, $callback->($status) |
220 | aio_lstat $fh, $callback->($status) |
217 | aio_statvfs $fh_or_path, $callback->($statvfs) |
221 | aio_statvfs $fh_or_path, $callback->($statvfs) |
218 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
222 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
219 | 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) |
220 | aio_truncate $fh_or_path, $offset, $callback->($status) |
225 | aio_truncate $fh_or_path, $offset, $callback->($status) |
221 | 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) |
222 | aio_unlink $pathname, $callback->($status) |
228 | aio_unlink $pathname, $callback->($status) |
223 | aio_mknod $path, $mode, $dev, $callback->($status) |
229 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
224 | aio_link $srcpath, $dstpath, $callback->($status) |
230 | aio_link $srcpath, $dstpath, $callback->($status) |
225 | aio_symlink $srcpath, $dstpath, $callback->($status) |
231 | aio_symlink $srcpath, $dstpath, $callback->($status) |
226 | aio_readlink $path, $callback->($link) |
232 | aio_readlink $pathname, $callback->($link) |
|
|
233 | aio_realpath $pathname, $callback->($link) |
227 | aio_rename $srcpath, $dstpath, $callback->($status) |
234 | aio_rename $srcpath, $dstpath, $callback->($status) |
228 | aio_mkdir $pathname, $mode, $callback->($status) |
235 | aio_mkdir $pathname, $mode, $callback->($status) |
229 | aio_rmdir $pathname, $callback->($status) |
236 | aio_rmdir $pathname, $callback->($status) |
230 | aio_readdir $pathname, $callback->($entries) |
237 | aio_readdir $pathname, $callback->($entries) |
231 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
238 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
232 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
239 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
233 | IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN |
240 | IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN |
|
|
241 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
234 | aio_load $path, $data, $callback->($status) |
242 | aio_load $pathname, $data, $callback->($status) |
235 | aio_copy $srcpath, $dstpath, $callback->($status) |
243 | aio_copy $srcpath, $dstpath, $callback->($status) |
236 | aio_move $srcpath, $dstpath, $callback->($status) |
244 | aio_move $srcpath, $dstpath, $callback->($status) |
237 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
|
|
238 | aio_rmtree $path, $callback->($status) |
245 | aio_rmtree $pathname, $callback->($status) |
239 | aio_sync $callback->($status) |
246 | aio_sync $callback->($status) |
|
|
247 | aio_syncfs $fh, $callback->($status) |
240 | aio_fsync $fh, $callback->($status) |
248 | aio_fsync $fh, $callback->($status) |
241 | aio_fdatasync $fh, $callback->($status) |
249 | aio_fdatasync $fh, $callback->($status) |
242 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
250 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
243 | aio_pathsync $path, $callback->($status) |
251 | aio_pathsync $pathname, $callback->($status) |
244 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
252 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
245 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
253 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
246 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
254 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
247 | aio_mlockall $flags, $callback->($status) |
255 | aio_mlockall $flags, $callback->($status) |
248 | aio_group $callback->(...) |
256 | aio_group $callback->(...) |
… | |
… | |
258 | IO::AIO::max_poll_reqs $nreqs |
266 | IO::AIO::max_poll_reqs $nreqs |
259 | IO::AIO::max_poll_time $seconds |
267 | IO::AIO::max_poll_time $seconds |
260 | IO::AIO::min_parallel $nthreads |
268 | IO::AIO::min_parallel $nthreads |
261 | IO::AIO::max_parallel $nthreads |
269 | IO::AIO::max_parallel $nthreads |
262 | IO::AIO::max_idle $nthreads |
270 | IO::AIO::max_idle $nthreads |
|
|
271 | IO::AIO::idle_timeout $seconds |
263 | IO::AIO::max_outstanding $maxreqs |
272 | IO::AIO::max_outstanding $maxreqs |
264 | IO::AIO::nreqs |
273 | IO::AIO::nreqs |
265 | IO::AIO::nready |
274 | IO::AIO::nready |
266 | IO::AIO::npending |
275 | IO::AIO::npending |
267 | |
276 | |
268 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
277 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
269 | 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 |
|
|
281 | IO::AIO::madvise $scalar, $offset, $length, $advice |
|
|
282 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
270 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
283 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
271 | IO::AIO::munlockall |
284 | IO::AIO::munlockall |
272 | |
285 | |
273 | =head2 AIO REQUEST FUNCTIONS |
286 | =head2 API NOTES |
274 | |
287 | |
275 | 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 |
276 | 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, |
277 | and they all accept an additional (and optional) C<$callback> argument |
290 | and they all accept an additional (and optional) C<$callback> argument |
278 | which must be a code reference. This code reference will get called with |
291 | which must be a code reference. This code reference will be called after |
279 | the syscall return code (e.g. most syscalls return C<-1> on error, unlike |
292 | the syscall has been executed in an asynchronous fashion. The results |
280 | perl, which usually delivers "false") as its sole argument after the given |
293 | of the request will be passed as arguments to the callback (and, if an |
281 | syscall has been executed asynchronously. |
294 | error occured, in C<$!>) - for most requests the syscall return code (e.g. |
|
|
295 | most syscalls return C<-1> on error, unlike perl, which usually delivers |
|
|
296 | "false"). |
|
|
297 | |
|
|
298 | Some requests (such as C<aio_readdir>) pass the actual results and |
|
|
299 | communicate failures by passing C<undef>. |
282 | |
300 | |
283 | All functions expecting a filehandle keep a copy of the filehandle |
301 | All functions expecting a filehandle keep a copy of the filehandle |
284 | internally until the request has finished. |
302 | internally until the request has finished. |
285 | |
303 | |
286 | All functions return request objects of type L<IO::AIO::REQ> that allow |
304 | All functions return request objects of type L<IO::AIO::REQ> that allow |
287 | further manipulation of those requests while they are in-flight. |
305 | further manipulation of those requests while they are in-flight. |
288 | |
306 | |
289 | The pathnames you pass to these routines I<must> be absolute and |
307 | The pathnames you pass to these routines I<should> be absolute. The |
290 | encoded as octets. The reason for the former is that at the time the |
308 | reason for this is that at the time the request is being executed, the |
291 | request is being executed, the current working directory could have |
309 | current working directory could have changed. Alternatively, you can |
292 | changed. Alternatively, you can make sure that you never change the |
310 | make sure that you never change the current working directory anywhere |
293 | current working directory anywhere in the program and then use relative |
311 | in the program and then use relative paths. You can also take advantage |
294 | paths. |
312 | of IO::AIOs working directory abstraction, that lets you specify paths |
|
|
313 | relative to some previously-opened "working directory object" - see the |
|
|
314 | description of the C<IO::AIO::WD> class later in this document. |
295 | |
315 | |
296 | To encode pathnames as octets, either make sure you either: a) always pass |
316 | To encode pathnames as octets, either make sure you either: a) always pass |
297 | in filenames you got from outside (command line, readdir etc.) without |
317 | in filenames you got from outside (command line, readdir etc.) without |
298 | tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode |
318 | tinkering, b) are in your native filesystem encoding, c) use the Encode |
299 | your pathnames to the locale (or other) encoding in effect in the user |
319 | module and encode your pathnames to the locale (or other) encoding in |
300 | environment, d) use Glib::filename_from_unicode on unicode filenames or e) |
320 | effect in the user environment, d) use Glib::filename_from_unicode on |
301 | use something else to ensure your scalar has the correct contents. |
321 | unicode filenames or e) use something else to ensure your scalar has the |
|
|
322 | correct contents. |
302 | |
323 | |
303 | 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 |
304 | handles correctly whether it is set or not. |
325 | handles correctly whether it is set or not. |
|
|
326 | |
|
|
327 | =head2 AIO REQUEST FUNCTIONS |
305 | |
328 | |
306 | =over 4 |
329 | =over 4 |
307 | |
330 | |
308 | =item $prev_pri = aioreq_pri [$pri] |
331 | =item $prev_pri = aioreq_pri [$pri] |
309 | |
332 | |
… | |
… | |
365 | } else { |
388 | } else { |
366 | die "open failed: $!\n"; |
389 | die "open failed: $!\n"; |
367 | } |
390 | } |
368 | }; |
391 | }; |
369 | |
392 | |
|
|
393 | In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>, |
|
|
394 | C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the |
|
|
395 | following POSIX and non-POSIX constants are available (missing ones on |
|
|
396 | your system are, as usual, C<0>): |
|
|
397 | |
|
|
398 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
|
|
399 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
|
|
400 | C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>. |
|
|
401 | |
370 | |
402 | |
371 | =item aio_close $fh, $callback->($status) |
403 | =item aio_close $fh, $callback->($status) |
372 | |
404 | |
373 | Asynchronously close a file and call the callback with the result |
405 | Asynchronously close a file and call the callback with the result |
374 | code. |
406 | code. |
… | |
… | |
382 | |
414 | |
383 | 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 |
384 | free for reuse until the perl filehandle is closed. |
416 | free for reuse until the perl filehandle is closed. |
385 | |
417 | |
386 | =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". |
387 | |
439 | |
388 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
440 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
389 | |
441 | |
390 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
442 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
391 | |
443 | |
… | |
… | |
424 | |
476 | |
425 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
477 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
426 | reading at byte offset C<$in_offset>, and starts writing at the current |
478 | reading at byte offset C<$in_offset>, and starts writing at the current |
427 | file offset of C<$out_fh>. Because of that, it is not safe to issue more |
479 | file offset of C<$out_fh>. Because of that, it is not safe to issue more |
428 | than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each |
480 | than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each |
429 | other. |
481 | other. The same C<$in_fh> works fine though, as this function does not |
|
|
482 | move or use the file offset of C<$in_fh>. |
430 | |
483 | |
|
|
484 | Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than |
|
|
485 | are written, and there is no way to find out how many more bytes have been |
|
|
486 | read from C<aio_sendfile> alone, as C<aio_sendfile> only provides the |
|
|
487 | number of bytes written to C<$out_fh>. Only if the result value equals |
|
|
488 | C<$length> one can assume that C<$length> bytes have been read. |
|
|
489 | |
|
|
490 | Unlike with other C<aio_> functions, it makes a lot of sense to use |
|
|
491 | C<aio_sendfile> on non-blocking sockets, as long as one end (typically |
|
|
492 | the C<$in_fh>) is a file - the file I/O will then be asynchronous, while |
|
|
493 | the socket I/O will be non-blocking. Note, however, that you can run |
|
|
494 | into a trap where C<aio_sendfile> reads some data with readahead, then |
|
|
495 | fails to write all data, and when the socket is ready the next time, the |
|
|
496 | data in the cache is already lost, forcing C<aio_sendfile> to again hit |
|
|
497 | the disk. Explicit C<aio_read> + C<aio_write> let's you better control |
|
|
498 | resource usage. |
|
|
499 | |
431 | This call tries to make use of a native C<sendfile> syscall to provide |
500 | This call tries to make use of a native C<sendfile>-like syscall to |
432 | zero-copy operation. For this to work, C<$out_fh> should refer to a |
501 | provide zero-copy operation. For this to work, C<$out_fh> should refer to |
433 | socket, and C<$in_fh> should refer to an mmap'able file. |
502 | a socket, and C<$in_fh> should refer to an mmap'able file. |
434 | |
503 | |
435 | If a native sendfile cannot be found or it fails with C<ENOSYS>, |
504 | If a native sendfile cannot be found or it fails with C<ENOSYS>, |
436 | C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>, |
505 | C<EINVAL>, C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or |
437 | it will be emulated, so you can call C<aio_sendfile> on any type of |
506 | C<ENOTSOCK>, it will be emulated, so you can call C<aio_sendfile> on any |
438 | filehandle regardless of the limitations of the operating system. |
507 | type of filehandle regardless of the limitations of the operating system. |
439 | |
508 | |
440 | Please note, however, that C<aio_sendfile> can read more bytes from |
509 | As native sendfile syscalls (as practically any non-POSIX interface hacked |
441 | C<$in_fh> than are written, and there is no way to find out how many |
510 | together in a hurry to improve benchmark numbers) tend to be rather buggy |
442 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
511 | on many systems, this implementation tries to work around some known bugs |
443 | provides the number of bytes written to C<$out_fh>. Only if the result |
512 | in Linux and FreeBSD kernels (probably others, too), but that might fail, |
444 | value equals C<$length> one can assume that C<$length> bytes have been |
513 | so you really really should check the return value of C<aio_sendfile> - |
445 | read. |
514 | fewre bytes than expected might have been transferred. |
446 | |
515 | |
447 | |
516 | |
448 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
517 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
449 | |
518 | |
450 | C<aio_readahead> populates the page cache with data from a file so that |
519 | C<aio_readahead> populates the page cache with data from a file so that |
… | |
… | |
472 | for an explanation. |
541 | for an explanation. |
473 | |
542 | |
474 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
543 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
475 | error when stat'ing a large file, the results will be silently truncated |
544 | error when stat'ing a large file, the results will be silently truncated |
476 | unless perl itself is compiled with large file support. |
545 | unless perl itself is compiled with large file support. |
|
|
546 | |
|
|
547 | To help interpret the mode and dev/rdev stat values, IO::AIO offers the |
|
|
548 | following constants and functions (if not implemented, the constants will |
|
|
549 | be C<0> and the functions will either C<croak> or fall back on traditional |
|
|
550 | behaviour). |
|
|
551 | |
|
|
552 | C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, |
|
|
553 | C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, |
|
|
554 | C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. |
477 | |
555 | |
478 | Example: Print the length of F</etc/passwd>: |
556 | Example: Print the length of F</etc/passwd>: |
479 | |
557 | |
480 | aio_stat "/etc/passwd", sub { |
558 | aio_stat "/etc/passwd", sub { |
481 | $_[0] and die "stat failed: $!"; |
559 | $_[0] and die "stat failed: $!"; |
… | |
… | |
562 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
640 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
563 | |
641 | |
564 | Works like truncate(2) or ftruncate(2). |
642 | Works like truncate(2) or ftruncate(2). |
565 | |
643 | |
566 | |
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>. |
|
|
659 | |
|
|
660 | |
567 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
661 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
568 | |
662 | |
569 | Works like perl's C<chmod> function. |
663 | Works like perl's C<chmod> function. |
570 | |
664 | |
571 | |
665 | |
… | |
… | |
573 | |
667 | |
574 | Asynchronously unlink (delete) a file and call the callback with the |
668 | Asynchronously unlink (delete) a file and call the callback with the |
575 | result code. |
669 | result code. |
576 | |
670 | |
577 | |
671 | |
578 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
672 | =item aio_mknod $pathname, $mode, $dev, $callback->($status) |
579 | |
673 | |
580 | [EXPERIMENTAL] |
674 | [EXPERIMENTAL] |
581 | |
675 | |
582 | Asynchronously create a device node (or fifo). See mknod(2). |
676 | Asynchronously create a device node (or fifo). See mknod(2). |
583 | |
677 | |
584 | The only (POSIX-) portable way of calling this function is: |
678 | The only (POSIX-) portable way of calling this function is: |
585 | |
679 | |
586 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
680 | aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
587 | |
681 | |
|
|
682 | See C<aio_stat> for info about some potentially helpful extra constants |
|
|
683 | and functions. |
588 | |
684 | |
589 | =item aio_link $srcpath, $dstpath, $callback->($status) |
685 | =item aio_link $srcpath, $dstpath, $callback->($status) |
590 | |
686 | |
591 | Asynchronously create a new link to the existing object at C<$srcpath> at |
687 | Asynchronously create a new link to the existing object at C<$srcpath> at |
592 | the path C<$dstpath> and call the callback with the result code. |
688 | the path C<$dstpath> and call the callback with the result code. |
… | |
… | |
596 | |
692 | |
597 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
693 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
598 | the path C<$dstpath> and call the callback with the result code. |
694 | the path C<$dstpath> and call the callback with the result code. |
599 | |
695 | |
600 | |
696 | |
601 | =item aio_readlink $path, $callback->($link) |
697 | =item aio_readlink $pathname, $callback->($link) |
602 | |
698 | |
603 | Asynchronously read the symlink specified by C<$path> and pass it to |
699 | Asynchronously read the symlink specified by C<$path> and pass it to |
604 | the callback. If an error occurs, nothing or undef gets passed to the |
700 | the callback. If an error occurs, nothing or undef gets passed to the |
605 | callback. |
701 | callback. |
606 | |
702 | |
607 | |
703 | |
|
|
704 | =item aio_realpath $pathname, $callback->($path) |
|
|
705 | |
|
|
706 | Asynchronously make the path absolute and resolve any symlinks in |
|
|
707 | C<$path>. The resulting path only consists of directories (Same as |
|
|
708 | L<Cwd::realpath>). |
|
|
709 | |
|
|
710 | This request can be used to get the absolute path of the current working |
|
|
711 | directory by passing it a path of F<.> (a single dot). |
|
|
712 | |
|
|
713 | |
608 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
714 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
609 | |
715 | |
610 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
716 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
611 | rename(2) and call the callback with the result code. |
717 | rename(2) and call the callback with the result code. |
612 | |
718 | |
… | |
… | |
634 | array-ref with the filenames. |
740 | array-ref with the filenames. |
635 | |
741 | |
636 | |
742 | |
637 | =item aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
743 | =item aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
638 | |
744 | |
639 | Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune |
745 | Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to |
640 | behaviour and output format. In case of an error, C<$entries> will be |
746 | tune behaviour and output format. In case of an error, C<$entries> will be |
641 | C<undef>. |
747 | C<undef>. |
642 | |
748 | |
643 | The flags are a combination of the following constants, ORed together (the |
749 | The flags are a combination of the following constants, ORed together (the |
644 | flags will also be passed to the callback, possibly modified): |
750 | flags will also be passed to the callback, possibly modified): |
645 | |
751 | |
646 | =over 4 |
752 | =over 4 |
647 | |
753 | |
648 | =item IO::AIO::READDIR_DENTS |
754 | =item IO::AIO::READDIR_DENTS |
649 | |
755 | |
650 | When this flag is off, then the callback gets an arrayref with of names |
756 | When this flag is off, then the callback gets an arrayref consisting of |
651 | only (as with C<aio_readdir>), otherwise it gets an arrayref with |
757 | names only (as with C<aio_readdir>), otherwise it gets an arrayref with |
652 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
758 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
653 | entry in more detail. |
759 | entry in more detail. |
654 | |
760 | |
655 | C<$name> is the name of the entry. |
761 | C<$name> is the name of the entry. |
656 | |
762 | |
… | |
… | |
669 | systems that do not deliver the inode information. |
775 | systems that do not deliver the inode information. |
670 | |
776 | |
671 | =item IO::AIO::READDIR_DIRS_FIRST |
777 | =item IO::AIO::READDIR_DIRS_FIRST |
672 | |
778 | |
673 | When this flag is set, then the names will be returned in an order where |
779 | When this flag is set, then the names will be returned in an order where |
674 | likely directories come first. This is useful when you need to quickly |
780 | likely directories come first, in optimal stat order. This is useful when |
675 | find directories, or you want to find all directories while avoiding to |
781 | you need to quickly find directories, or you want to find all directories |
676 | stat() each entry. |
782 | while avoiding to stat() each entry. |
677 | |
783 | |
678 | If the system returns type information in readdir, then this is used |
784 | If the system returns type information in readdir, then this is used |
679 | to find directories directly. Otherwise, likely directories are files |
785 | to find directories directly. Otherwise, likely directories are names |
680 | beginning with ".", or otherwise files with no dots, of which files with |
786 | beginning with ".", or otherwise names with no dots, of which names with |
681 | short names are tried first. |
787 | short names are tried first. |
682 | |
788 | |
683 | =item IO::AIO::READDIR_STAT_ORDER |
789 | =item IO::AIO::READDIR_STAT_ORDER |
684 | |
790 | |
685 | When this flag is set, then the names will be returned in an order |
791 | When this flag is set, then the names will be returned in an order |
… | |
… | |
692 | |
798 | |
693 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
799 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
694 | |
800 | |
695 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
801 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
696 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
802 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
697 | C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all |
803 | C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all |
698 | C<$type>'s are known, which can be used to speed up some algorithms. |
804 | C<$type>'s are known, which can be used to speed up some algorithms. |
699 | |
805 | |
700 | =back |
806 | =back |
701 | |
807 | |
702 | |
808 | |
703 | =item aio_load $path, $data, $callback->($status) |
809 | =item aio_load $pathname, $data, $callback->($status) |
704 | |
810 | |
705 | This is a composite request that tries to fully load the given file into |
811 | This is a composite request that tries to fully load the given file into |
706 | memory. Status is the same as with aio_read. |
812 | memory. Status is the same as with aio_read. |
707 | |
813 | |
708 | =cut |
814 | =cut |
… | |
… | |
830 | if ($_[0] && $! == EXDEV) { |
936 | if ($_[0] && $! == EXDEV) { |
831 | aioreq_pri $pri; |
937 | aioreq_pri $pri; |
832 | add $grp aio_copy $src, $dst, sub { |
938 | add $grp aio_copy $src, $dst, sub { |
833 | $grp->result ($_[0]); |
939 | $grp->result ($_[0]); |
834 | |
940 | |
835 | if (!$_[0]) { |
941 | unless ($_[0]) { |
836 | aioreq_pri $pri; |
942 | aioreq_pri $pri; |
837 | add $grp aio_unlink $src; |
943 | add $grp aio_unlink $src; |
838 | } |
944 | } |
839 | }; |
945 | }; |
840 | } else { |
946 | } else { |
… | |
… | |
843 | }; |
949 | }; |
844 | |
950 | |
845 | $grp |
951 | $grp |
846 | } |
952 | } |
847 | |
953 | |
848 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
954 | =item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
849 | |
955 | |
850 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
956 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
851 | efficiently separate the entries of directory C<$path> into two sets of |
957 | efficiently separate the entries of directory C<$path> into two sets of |
852 | names, directories you can recurse into (directories), and ones you cannot |
958 | names, directories you can recurse into (directories), and ones you cannot |
853 | recurse into (everything else, including symlinks to directories). |
959 | recurse into (everything else, including symlinks to directories). |
… | |
… | |
884 | Then entries will be sorted into likely directories a non-initial dot |
990 | Then entries will be sorted into likely directories a non-initial dot |
885 | currently) and likely non-directories (see C<aio_readdirx>). Then every |
991 | currently) and likely non-directories (see C<aio_readdirx>). Then every |
886 | entry plus an appended C</.> will be C<stat>'ed, likely directories first, |
992 | entry plus an appended C</.> will be C<stat>'ed, likely directories first, |
887 | in order of their inode numbers. If that succeeds, it assumes that the |
993 | in order of their inode numbers. If that succeeds, it assumes that the |
888 | entry is a directory or a symlink to directory (which will be checked |
994 | entry is a directory or a symlink to directory (which will be checked |
889 | seperately). This is often faster than stat'ing the entry itself because |
995 | separately). This is often faster than stat'ing the entry itself because |
890 | filesystems might detect the type of the entry without reading the inode |
996 | filesystems might detect the type of the entry without reading the inode |
891 | data (e.g. ext2fs filetype feature), even on systems that cannot return |
997 | data (e.g. ext2fs filetype feature), even on systems that cannot return |
892 | the filetype information on readdir. |
998 | the filetype information on readdir. |
893 | |
999 | |
894 | If the known number of directories (link count - 2) has been reached, the |
1000 | If the known number of directories (link count - 2) has been reached, the |
… | |
… | |
910 | |
1016 | |
911 | my $grp = aio_group $cb; |
1017 | my $grp = aio_group $cb; |
912 | |
1018 | |
913 | $maxreq = 4 if $maxreq <= 0; |
1019 | $maxreq = 4 if $maxreq <= 0; |
914 | |
1020 | |
915 | # stat once |
1021 | # get a wd object |
916 | aioreq_pri $pri; |
1022 | aioreq_pri $pri; |
917 | add $grp aio_stat $path, sub { |
1023 | add $grp aio_wd $path, sub { |
|
|
1024 | $_[0] |
918 | return $grp->result () if $_[0]; |
1025 | or return $grp->result (); |
919 | my $now = time; |
|
|
920 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
921 | |
1026 | |
922 | # read the directory entries |
1027 | my $wd = [shift, "."]; |
|
|
1028 | |
|
|
1029 | # stat once |
923 | aioreq_pri $pri; |
1030 | aioreq_pri $pri; |
924 | add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { |
1031 | add $grp aio_stat $wd, sub { |
925 | my $entries = shift |
|
|
926 | or return $grp->result (); |
1032 | return $grp->result () if $_[0]; |
|
|
1033 | my $now = time; |
|
|
1034 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
927 | |
1035 | |
928 | # stat the dir another time |
1036 | # read the directory entries |
929 | aioreq_pri $pri; |
1037 | aioreq_pri $pri; |
|
|
1038 | add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub { |
|
|
1039 | my $entries = shift |
|
|
1040 | or return $grp->result (); |
|
|
1041 | |
|
|
1042 | # stat the dir another time |
|
|
1043 | aioreq_pri $pri; |
930 | add $grp aio_stat $path, sub { |
1044 | add $grp aio_stat $wd, sub { |
931 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
1045 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
932 | |
1046 | |
933 | my $ndirs; |
1047 | my $ndirs; |
934 | |
1048 | |
935 | # take the slow route if anything looks fishy |
1049 | # take the slow route if anything looks fishy |
936 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
1050 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
937 | $ndirs = -1; |
1051 | $ndirs = -1; |
938 | } else { |
1052 | } else { |
939 | # if nlink == 2, we are finished |
1053 | # if nlink == 2, we are finished |
940 | # for non-posix-fs's, we rely on nlink < 2 |
1054 | # for non-posix-fs's, we rely on nlink < 2 |
941 | $ndirs = (stat _)[3] - 2 |
1055 | $ndirs = (stat _)[3] - 2 |
942 | or return $grp->result ([], $entries); |
1056 | or return $grp->result ([], $entries); |
943 | } |
1057 | } |
944 | |
1058 | |
945 | my (@dirs, @nondirs); |
1059 | my (@dirs, @nondirs); |
946 | |
1060 | |
947 | my $statgrp = add $grp aio_group sub { |
1061 | my $statgrp = add $grp aio_group sub { |
948 | $grp->result (\@dirs, \@nondirs); |
1062 | $grp->result (\@dirs, \@nondirs); |
949 | }; |
1063 | }; |
950 | |
1064 | |
951 | limit $statgrp $maxreq; |
1065 | limit $statgrp $maxreq; |
952 | feed $statgrp sub { |
1066 | feed $statgrp sub { |
953 | return unless @$entries; |
1067 | return unless @$entries; |
954 | my $entry = shift @$entries; |
1068 | my $entry = shift @$entries; |
955 | |
1069 | |
956 | aioreq_pri $pri; |
1070 | aioreq_pri $pri; |
|
|
1071 | $wd->[1] = "$entry/."; |
957 | add $statgrp aio_stat "$path/$entry/.", sub { |
1072 | add $statgrp aio_stat $wd, sub { |
958 | if ($_[0] < 0) { |
1073 | if ($_[0] < 0) { |
959 | push @nondirs, $entry; |
1074 | push @nondirs, $entry; |
960 | } else { |
1075 | } else { |
961 | # need to check for real directory |
1076 | # need to check for real directory |
962 | aioreq_pri $pri; |
1077 | aioreq_pri $pri; |
|
|
1078 | $wd->[1] = $entry; |
963 | add $statgrp aio_lstat "$path/$entry", sub { |
1079 | add $statgrp aio_lstat $wd, sub { |
964 | if (-d _) { |
1080 | if (-d _) { |
965 | push @dirs, $entry; |
1081 | push @dirs, $entry; |
966 | |
1082 | |
967 | unless (--$ndirs) { |
1083 | unless (--$ndirs) { |
968 | push @nondirs, @$entries; |
1084 | push @nondirs, @$entries; |
969 | feed $statgrp; |
1085 | feed $statgrp; |
|
|
1086 | } |
|
|
1087 | } else { |
|
|
1088 | push @nondirs, $entry; |
970 | } |
1089 | } |
971 | } else { |
|
|
972 | push @nondirs, $entry; |
|
|
973 | } |
1090 | } |
974 | } |
1091 | } |
975 | } |
1092 | }; |
976 | }; |
1093 | }; |
977 | }; |
1094 | }; |
978 | }; |
1095 | }; |
979 | }; |
1096 | }; |
980 | }; |
1097 | }; |
981 | |
1098 | |
982 | $grp |
1099 | $grp |
983 | } |
1100 | } |
984 | |
1101 | |
985 | =item aio_rmtree $path, $callback->($status) |
1102 | =item aio_rmtree $pathname, $callback->($status) |
986 | |
1103 | |
987 | Delete a directory tree starting (and including) C<$path>, return the |
1104 | Delete a directory tree starting (and including) C<$path>, return the |
988 | status of the final C<rmdir> only. This is a composite request that |
1105 | status of the final C<rmdir> only. This is a composite request that |
989 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
1106 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
990 | everything else. |
1107 | everything else. |
… | |
… | |
1032 | callback with the fdatasync result code. |
1149 | callback with the fdatasync result code. |
1033 | |
1150 | |
1034 | If this call isn't available because your OS lacks it or it couldn't be |
1151 | If this call isn't available because your OS lacks it or it couldn't be |
1035 | detected, it will be emulated by calling C<fsync> instead. |
1152 | detected, it will be emulated by calling C<fsync> instead. |
1036 | |
1153 | |
|
|
1154 | =item aio_syncfs $fh, $callback->($status) |
|
|
1155 | |
|
|
1156 | Asynchronously call the syncfs syscall to sync the filesystem associated |
|
|
1157 | to the given filehandle and call the callback with the syncfs result |
|
|
1158 | code. If syncfs is not available, calls sync(), but returns C<-1> and sets |
|
|
1159 | errno to C<ENOSYS> nevertheless. |
|
|
1160 | |
1037 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
1161 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
1038 | |
1162 | |
1039 | Sync the data portion of the file specified by C<$offset> and C<$length> |
1163 | Sync the data portion of the file specified by C<$offset> and C<$length> |
1040 | to disk (but NOT the metadata), by calling the Linux-specific |
1164 | to disk (but NOT the metadata), by calling the Linux-specific |
1041 | sync_file_range call. If sync_file_range is not available or it returns |
1165 | sync_file_range call. If sync_file_range is not available or it returns |
… | |
… | |
1044 | C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, |
1168 | C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, |
1045 | C<IO::AIO::SYNC_FILE_RANGE_WRITE> and |
1169 | C<IO::AIO::SYNC_FILE_RANGE_WRITE> and |
1046 | C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range |
1170 | C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range |
1047 | manpage for details. |
1171 | manpage for details. |
1048 | |
1172 | |
1049 | =item aio_pathsync $path, $callback->($status) |
1173 | =item aio_pathsync $pathname, $callback->($status) |
1050 | |
1174 | |
1051 | This request tries to open, fsync and close the given path. This is a |
1175 | This request tries to open, fsync and close the given path. This is a |
1052 | composite request intended to sync directories after directory operations |
1176 | composite request intended to sync directories after directory operations |
1053 | (E.g. rename). This might not work on all operating systems or have any |
1177 | (E.g. rename). This might not work on all operating systems or have any |
1054 | specific effect, but usually it makes sure that directory changes get |
1178 | specific effect, but usually it makes sure that directory changes get |
… | |
… | |
1151 | |
1275 | |
1152 | Example: asynchronously lock all current and future pages into memory. |
1276 | Example: asynchronously lock all current and future pages into memory. |
1153 | |
1277 | |
1154 | aio_mlockall IO::AIO::MCL_FUTURE; |
1278 | aio_mlockall IO::AIO::MCL_FUTURE; |
1155 | |
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 file. 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. |
|
|
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 | |
1156 | =item aio_group $callback->(...) |
1320 | =item aio_group $callback->(...) |
1157 | |
1321 | |
1158 | This is a very special aio request: Instead of doing something, it is a |
1322 | This is a very special aio request: Instead of doing something, it is a |
1159 | container for other aio requests, which is useful if you want to bundle |
1323 | container for other aio requests, which is useful if you want to bundle |
1160 | many requests into a single, composite, request with a definite callback |
1324 | many requests into a single, composite, request with a definite callback |
… | |
… | |
1196 | like sleep and file handle readable/writable, the overhead this creates is |
1360 | like sleep and file handle readable/writable, the overhead this creates is |
1197 | immense (it blocks a thread for a long time) so do not use this function |
1361 | immense (it blocks a thread for a long time) so do not use this function |
1198 | except to put your application under artificial I/O pressure. |
1362 | except to put your application under artificial I/O pressure. |
1199 | |
1363 | |
1200 | =back |
1364 | =back |
|
|
1365 | |
|
|
1366 | |
|
|
1367 | =head2 IO::AIO::WD - multiple working directories |
|
|
1368 | |
|
|
1369 | Your process only has one current working directory, which is used by all |
|
|
1370 | threads. This makes it hard to use relative paths (some other component |
|
|
1371 | could call C<chdir> at any time, and it is hard to control when the path |
|
|
1372 | will be used by IO::AIO). |
|
|
1373 | |
|
|
1374 | One solution for this is to always use absolute paths. This usually works, |
|
|
1375 | but can be quite slow (the kernel has to walk the whole path on every |
|
|
1376 | access), and can also be a hassle to implement. |
|
|
1377 | |
|
|
1378 | Newer POSIX systems have a number of functions (openat, fdopendir, |
|
|
1379 | futimensat and so on) that make it possible to specify working directories |
|
|
1380 | per operation. |
|
|
1381 | |
|
|
1382 | For portability, and because the clowns who "designed", or shall I write, |
|
|
1383 | perpetrated this new interface were obviously half-drunk, this abstraction |
|
|
1384 | cannot be perfect, though. |
|
|
1385 | |
|
|
1386 | IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD |
|
|
1387 | object. This object stores the canonicalised, absolute version of the |
|
|
1388 | path, and on systems that allow it, also a directory file descriptor. |
|
|
1389 | |
|
|
1390 | Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat> |
|
|
1391 | or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD |
|
|
1392 | object and a pathname instead (or the IO::AIO::WD object alone, which |
|
|
1393 | gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the |
|
|
1394 | IO::AIO::WD object is ignored, otherwise the pathname is resolved relative |
|
|
1395 | to that IO::AIO::WD object. |
|
|
1396 | |
|
|
1397 | For example, to get a wd object for F</etc> and then stat F<passwd> |
|
|
1398 | inside, you would write: |
|
|
1399 | |
|
|
1400 | aio_wd "/etc", sub { |
|
|
1401 | my $etcdir = shift; |
|
|
1402 | |
|
|
1403 | # although $etcdir can be undef on error, there is generally no reason |
|
|
1404 | # to check for errors here, as aio_stat will fail with ENOENT |
|
|
1405 | # when $etcdir is undef. |
|
|
1406 | |
|
|
1407 | aio_stat [$etcdir, "passwd"], sub { |
|
|
1408 | # yay |
|
|
1409 | }; |
|
|
1410 | }; |
|
|
1411 | |
|
|
1412 | That C<aio_wd> is a request and not a normal function shows that creating |
|
|
1413 | an IO::AIO::WD object is itself a potentially blocking operation, which is |
|
|
1414 | why it is done asynchronously. |
|
|
1415 | |
|
|
1416 | To stat the directory obtained with C<aio_wd> above, one could write |
|
|
1417 | either of the following three request calls: |
|
|
1418 | |
|
|
1419 | aio_lstat "/etc" , sub { ... # pathname as normal string |
|
|
1420 | aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself) |
|
|
1421 | aio_lstat $wd , sub { ... # shorthand for the previous |
|
|
1422 | |
|
|
1423 | As with normal pathnames, IO::AIO keeps a copy of the working directory |
|
|
1424 | object and the pathname string, so you could write the following without |
|
|
1425 | causing any issues due to C<$path> getting reused: |
|
|
1426 | |
|
|
1427 | my $path = [$wd, undef]; |
|
|
1428 | |
|
|
1429 | for my $name (qw(abc def ghi)) { |
|
|
1430 | $path->[1] = $name; |
|
|
1431 | aio_stat $path, sub { |
|
|
1432 | # ... |
|
|
1433 | }; |
|
|
1434 | } |
|
|
1435 | |
|
|
1436 | There are some caveats: when directories get renamed (or deleted), the |
|
|
1437 | pathname string doesn't change, so will point to the new directory (or |
|
|
1438 | nowhere at all), while the directory fd, if available on the system, |
|
|
1439 | will still point to the original directory. Most functions accepting a |
|
|
1440 | pathname will use the directory fd on newer systems, and the string on |
|
|
1441 | older systems. Some functions (such as realpath) will always rely on the |
|
|
1442 | string form of the pathname. |
|
|
1443 | |
|
|
1444 | So this fucntionality is mainly useful to get some protection against |
|
|
1445 | C<chdir>, to easily get an absolute path out of a relative path for future |
|
|
1446 | reference, and to speed up doing many operations in the same directory |
|
|
1447 | (e.g. when stat'ing all files in a directory). |
|
|
1448 | |
|
|
1449 | The following functions implement this working directory abstraction: |
|
|
1450 | |
|
|
1451 | =over 4 |
|
|
1452 | |
|
|
1453 | =item aio_wd $pathname, $callback->($wd) |
|
|
1454 | |
|
|
1455 | Asynchonously canonicalise the given pathname and convert it to an |
|
|
1456 | IO::AIO::WD object representing it. If possible and supported on the |
|
|
1457 | system, also open a directory fd to speed up pathname resolution relative |
|
|
1458 | to this working directory. |
|
|
1459 | |
|
|
1460 | If something goes wrong, then C<undef> is passwd to the callback instead |
|
|
1461 | of a working directory object and C<$!> is set appropriately. Since |
|
|
1462 | passing C<undef> as working directory component of a pathname fails the |
|
|
1463 | request with C<ENOENT>, there is often no need for error checking in the |
|
|
1464 | C<aio_wd> callback, as future requests using the value will fail in the |
|
|
1465 | expected way. |
|
|
1466 | |
|
|
1467 | If this call isn't available because your OS lacks it or it couldn't be |
|
|
1468 | detected, it will be emulated by calling C<fsync> instead. |
|
|
1469 | |
|
|
1470 | =item IO::AIO::CWD |
|
|
1471 | |
|
|
1472 | This is a compiletime constant (object) that represents the process |
|
|
1473 | current working directory. |
|
|
1474 | |
|
|
1475 | Specifying this object as working directory object for a pathname is as |
|
|
1476 | if the pathname would be specified directly, without a directory object, |
|
|
1477 | e.g., these calls are functionally identical: |
|
|
1478 | |
|
|
1479 | aio_stat "somefile", sub { ... }; |
|
|
1480 | aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; |
|
|
1481 | |
|
|
1482 | =back |
|
|
1483 | |
1201 | |
1484 | |
1202 | =head2 IO::AIO::REQ CLASS |
1485 | =head2 IO::AIO::REQ CLASS |
1203 | |
1486 | |
1204 | All non-aggregate C<aio_*> functions return an object of this class when |
1487 | All non-aggregate C<aio_*> functions return an object of this class when |
1205 | called in non-void context. |
1488 | called in non-void context. |
… | |
… | |
1323 | |
1606 | |
1324 | Sets a feeder/generator on this group: every group can have an attached |
1607 | Sets a feeder/generator on this group: every group can have an attached |
1325 | generator that generates requests if idle. The idea behind this is that, |
1608 | generator that generates requests if idle. The idea behind this is that, |
1326 | although you could just queue as many requests as you want in a group, |
1609 | although you could just queue as many requests as you want in a group, |
1327 | this might starve other requests for a potentially long time. For example, |
1610 | this might starve other requests for a potentially long time. For example, |
1328 | C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, |
1611 | C<aio_scandir> might generate hundreds of thousands of C<aio_stat> |
1329 | delaying any later requests for a long time. |
1612 | requests, delaying any later requests for a long time. |
1330 | |
1613 | |
1331 | To avoid this, and allow incremental generation of requests, you can |
1614 | To avoid this, and allow incremental generation of requests, you can |
1332 | instead a group and set a feeder on it that generates those requests. The |
1615 | instead a group and set a feeder on it that generates those requests. The |
1333 | feed callback will be called whenever there are few enough (see C<limit>, |
1616 | feed callback will be called whenever there are few enough (see C<limit>, |
1334 | below) requests active in the group itself and is expected to queue more |
1617 | below) requests active in the group itself and is expected to queue more |
… | |
… | |
1383 | |
1666 | |
1384 | See C<poll_cb> for an example. |
1667 | See C<poll_cb> for an example. |
1385 | |
1668 | |
1386 | =item IO::AIO::poll_cb |
1669 | =item IO::AIO::poll_cb |
1387 | |
1670 | |
1388 | Process some outstanding events on the result pipe. You have to call this |
1671 | Process some outstanding events on the result pipe. You have to call |
1389 | regularly. Returns C<0> if all events could be processed, or C<-1> if it |
1672 | this regularly. Returns C<0> if all events could be processed (or there |
1390 | returned earlier for whatever reason. Returns immediately when no events |
1673 | were no events to process), or C<-1> if it returned earlier for whatever |
1391 | are outstanding. The amount of events processed depends on the settings of |
1674 | reason. Returns immediately when no events are outstanding. The amount of |
1392 | C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1675 | events processed depends on the settings of C<IO::AIO::max_poll_req> and |
|
|
1676 | C<IO::AIO::max_poll_time>. |
1393 | |
1677 | |
1394 | If not all requests were processed for whatever reason, the filehandle |
1678 | If not all requests were processed for whatever reason, the filehandle |
1395 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1679 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1396 | do anything special to have it called later. |
1680 | do anything special to have it called later. |
|
|
1681 | |
|
|
1682 | Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes |
|
|
1683 | ready, it can be beneficial to call this function from loops which submit |
|
|
1684 | a lot of requests, to make sure the results get processed when they become |
|
|
1685 | available and not just when the loop is finished and the event loop takes |
|
|
1686 | over again. This function returns very fast when there are no outstanding |
|
|
1687 | requests. |
1397 | |
1688 | |
1398 | Example: Install an Event watcher that automatically calls |
1689 | Example: Install an Event watcher that automatically calls |
1399 | IO::AIO::poll_cb with high priority (more examples can be found in the |
1690 | IO::AIO::poll_cb with high priority (more examples can be found in the |
1400 | SYNOPSIS section, at the top of this document): |
1691 | SYNOPSIS section, at the top of this document): |
1401 | |
1692 | |
… | |
… | |
1503 | |
1794 | |
1504 | Under normal circumstances you don't need to call this function. |
1795 | Under normal circumstances you don't need to call this function. |
1505 | |
1796 | |
1506 | =item IO::AIO::max_idle $nthreads |
1797 | =item IO::AIO::max_idle $nthreads |
1507 | |
1798 | |
1508 | Limit the number of threads (default: 4) that are allowed to idle (i.e., |
1799 | Limit the number of threads (default: 4) that are allowed to idle |
1509 | threads that did not get a request to process within 10 seconds). That |
1800 | (i.e., threads that did not get a request to process within the idle |
1510 | means if a thread becomes idle while C<$nthreads> other threads are also |
1801 | timeout (default: 10 seconds). That means if a thread becomes idle while |
1511 | idle, it will free its resources and exit. |
1802 | C<$nthreads> other threads are also idle, it will free its resources and |
|
|
1803 | exit. |
1512 | |
1804 | |
1513 | This is useful when you allow a large number of threads (e.g. 100 or 1000) |
1805 | This is useful when you allow a large number of threads (e.g. 100 or 1000) |
1514 | to allow for extremely high load situations, but want to free resources |
1806 | to allow for extremely high load situations, but want to free resources |
1515 | under normal circumstances (1000 threads can easily consume 30MB of RAM). |
1807 | under normal circumstances (1000 threads can easily consume 30MB of RAM). |
1516 | |
1808 | |
1517 | The default is probably ok in most situations, especially if thread |
1809 | The default is probably ok in most situations, especially if thread |
1518 | creation is fast. If thread creation is very slow on your system you might |
1810 | creation is fast. If thread creation is very slow on your system you might |
1519 | want to use larger values. |
1811 | want to use larger values. |
1520 | |
1812 | |
|
|
1813 | =item IO::AIO::idle_timeout $seconds |
|
|
1814 | |
|
|
1815 | Sets the minimum idle timeout (default 10) after which worker threads are |
|
|
1816 | allowed to exit. SEe C<IO::AIO::max_idle>. |
|
|
1817 | |
1521 | =item IO::AIO::max_outstanding $maxreqs |
1818 | =item IO::AIO::max_outstanding $maxreqs |
|
|
1819 | |
|
|
1820 | Sets the maximum number of outstanding requests to C<$nreqs>. If |
|
|
1821 | you do queue up more than this number of requests, the next call to |
|
|
1822 | C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as |
|
|
1823 | C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no |
|
|
1824 | longer exceeded. |
|
|
1825 | |
|
|
1826 | In other words, this setting does not enforce a queue limit, but can be |
|
|
1827 | used to make poll functions block if the limit is exceeded. |
1522 | |
1828 | |
1523 | This is a very bad function to use in interactive programs because it |
1829 | This is a very bad function to use in interactive programs because it |
1524 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1830 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1525 | use an C<aio_group> together with a feed callback. |
1831 | use an C<aio_group> together with a feed callback. |
1526 | |
1832 | |
1527 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1833 | It's main use is in scripts without an event loop - when you want to stat |
1528 | do queue up more than this number of requests, the next call to the |
1834 | a lot of files, you can write somehting like this: |
1529 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
|
|
1530 | function will block until the limit is no longer exceeded. |
|
|
1531 | |
1835 | |
1532 | The default value is very large, so there is no practical limit on the |
1836 | IO::AIO::max_outstanding 32; |
1533 | number of outstanding requests. |
|
|
1534 | |
1837 | |
1535 | You can still queue as many requests as you want. Therefore, |
1838 | for my $path (...) { |
1536 | C<max_outstanding> is mainly useful in simple scripts (with low values) or |
1839 | aio_stat $path , ...; |
1537 | as a stop gap to shield against fatal memory overflow (with large values). |
1840 | IO::AIO::poll_cb; |
|
|
1841 | } |
|
|
1842 | |
|
|
1843 | IO::AIO::flush; |
|
|
1844 | |
|
|
1845 | The call to C<poll_cb> inside the loop will normally return instantly, but |
|
|
1846 | as soon as more thna C<32> reqeusts are in-flight, it will block until |
|
|
1847 | some requests have been handled. This keeps the loop from pushing a large |
|
|
1848 | number of C<aio_stat> requests onto the queue. |
|
|
1849 | |
|
|
1850 | The default value for C<max_outstanding> is very large, so there is no |
|
|
1851 | practical limit on the number of outstanding requests. |
1538 | |
1852 | |
1539 | =back |
1853 | =back |
1540 | |
1854 | |
1541 | =head3 STATISTICAL INFORMATION |
1855 | =head3 STATISTICAL INFORMATION |
1542 | |
1856 | |
… | |
… | |
1580 | |
1894 | |
1581 | Returns the number of bytes copied, or C<-1> on error. |
1895 | Returns the number of bytes copied, or C<-1> on error. |
1582 | |
1896 | |
1583 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
1897 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
1584 | |
1898 | |
1585 | Simply calls the C<posix_fadvise> function (see it's |
1899 | Simply calls the C<posix_fadvise> function (see its |
1586 | manpage for details). The following advice constants are |
1900 | manpage for details). The following advice constants are |
1587 | avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
1901 | available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
1588 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
1902 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
1589 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
1903 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
1590 | |
1904 | |
1591 | On systems that do not implement C<posix_fadvise>, this function returns |
1905 | On systems that do not implement C<posix_fadvise>, this function returns |
1592 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
1906 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
1593 | |
1907 | |
|
|
1908 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
|
|
1909 | |
|
|
1910 | Simply calls the C<posix_madvise> function (see its |
|
|
1911 | manpage for details). The following advice constants are |
|
|
1912 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
|
|
1913 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. |
|
|
1914 | |
|
|
1915 | On systems that do not implement C<posix_madvise>, this function returns |
|
|
1916 | ENOSYS, otherwise the return value of C<posix_madvise>. |
|
|
1917 | |
|
|
1918 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
|
|
1919 | |
|
|
1920 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
|
|
1921 | $scalar (see its manpage for details). The following protect |
|
|
1922 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
|
|
1923 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
|
|
1924 | |
|
|
1925 | On systems that do not implement C<mprotect>, this function returns |
|
|
1926 | ENOSYS, otherwise the return value of C<mprotect>. |
|
|
1927 | |
1594 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
1928 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
1595 | |
1929 | |
1596 | Memory-maps a file (or anonymous memory range) and attaches it to the |
1930 | Memory-maps a file (or anonymous memory range) and attaches it to the |
1597 | given C<$scalar>, which will act like a string scalar. |
1931 | given C<$scalar>, which will act like a string scalar. Returns true on |
|
|
1932 | success, and false otherwise. |
1598 | |
1933 | |
1599 | The only operations allowed on the scalar are C<substr>/C<vec> that don't |
1934 | The only operations allowed on the scalar are C<substr>/C<vec> that don't |
1600 | change the string length, and most read-only operations such as copying it |
1935 | change the string length, and most read-only operations such as copying it |
1601 | or searching it with regexes and so on. |
1936 | or searching it with regexes and so on. |
1602 | |
1937 | |
… | |
… | |
1655 | Calls the C<munlockall> function. |
1990 | Calls the C<munlockall> function. |
1656 | |
1991 | |
1657 | On systems that do not implement C<munlockall>, this function returns |
1992 | On systems that do not implement C<munlockall>, this function returns |
1658 | ENOSYS, otherwise the return value of C<munlockall>. |
1993 | ENOSYS, otherwise the return value of C<munlockall>. |
1659 | |
1994 | |
|
|
1995 | =item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
|
|
1996 | |
|
|
1997 | Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or |
|
|
1998 | C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they |
|
|
1999 | should be the file offset. |
|
|
2000 | |
|
|
2001 | C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might |
|
|
2002 | silently corrupt the data in this case. |
|
|
2003 | |
|
|
2004 | The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>, |
|
|
2005 | C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and |
|
|
2006 | C<IO::AIO::SPLICE_F_GIFT>. |
|
|
2007 | |
|
|
2008 | See the C<splice(2)> manpage for details. |
|
|
2009 | |
|
|
2010 | =item IO::AIO::tee $r_fh, $w_fh, $length, $flags |
|
|
2011 | |
|
|
2012 | Calls the GNU/Linux C<tee(2)> syscall, see it's manpage and the |
|
|
2013 | description for C<IO::AIO::splice> above for details. |
|
|
2014 | |
1660 | =back |
2015 | =back |
1661 | |
2016 | |
1662 | =cut |
2017 | =cut |
1663 | |
2018 | |
1664 | min_parallel 8; |
2019 | min_parallel 8; |
… | |
… | |
1698 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
2053 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
1699 | \&IO::AIO::poll_cb); |
2054 | \&IO::AIO::poll_cb); |
1700 | |
2055 | |
1701 | =head2 FORK BEHAVIOUR |
2056 | =head2 FORK BEHAVIOUR |
1702 | |
2057 | |
1703 | This module should do "the right thing" when the process using it forks: |
2058 | Usage of pthreads in a program changes the semantics of fork |
|
|
2059 | considerably. Specifically, only async-safe functions can be called after |
|
|
2060 | fork. Perl doesn't know about this, so in general, you cannot call fork |
|
|
2061 | with defined behaviour in perl if pthreads are involved. IO::AIO uses |
|
|
2062 | pthreads, so this applies, but many other extensions and (for inexplicable |
|
|
2063 | reasons) perl itself often is linked against pthreads, so this limitation |
|
|
2064 | applies to quite a lot of perls. |
1704 | |
2065 | |
1705 | Before the fork, IO::AIO enters a quiescent state where no requests |
2066 | This module no longer tries to fight your OS, or POSIX. That means IO::AIO |
1706 | can be added in other threads and no results will be processed. After |
2067 | only works in the process that loaded it. Forking is fully supported, but |
1707 | the fork the parent simply leaves the quiescent state and continues |
2068 | using IO::AIO in the child is not. |
1708 | request/result processing, while the child frees the request/result queue |
|
|
1709 | (so that the requests started before the fork will only be handled in the |
|
|
1710 | parent). Threads will be started on demand until the limit set in the |
|
|
1711 | parent process has been reached again. |
|
|
1712 | |
2069 | |
1713 | In short: the parent will, after a short pause, continue as if fork had |
2070 | You might get around by not I<using> IO::AIO before (or after) |
1714 | not been called, while the child will act as if IO::AIO has not been used |
2071 | forking. You could also try to call the L<IO::AIO::reinit> function in the |
1715 | yet. |
2072 | child: |
|
|
2073 | |
|
|
2074 | =over 4 |
|
|
2075 | |
|
|
2076 | =item IO::AIO::reinit |
|
|
2077 | |
|
|
2078 | Abandons all current requests and I/O threads and simply reinitialises all |
|
|
2079 | data structures. This is not an operation supported by any standards, but |
|
|
2080 | happens to work on GNU/Linux and some newer BSD systems. |
|
|
2081 | |
|
|
2082 | The only reasonable use for this function is to call it after forking, if |
|
|
2083 | C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in |
|
|
2084 | the process will result in undefined behaviour. Calling it at any time |
|
|
2085 | will also result in any undefined (by POSIX) behaviour. |
|
|
2086 | |
|
|
2087 | =back |
1716 | |
2088 | |
1717 | =head2 MEMORY USAGE |
2089 | =head2 MEMORY USAGE |
1718 | |
2090 | |
1719 | Per-request usage: |
2091 | Per-request usage: |
1720 | |
2092 | |