… | |
… | |
3 | |
3 | |
4 | SYNOPSIS |
4 | SYNOPSIS |
5 | use IO::AIO; |
5 | use IO::AIO; |
6 | |
6 | |
7 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
7 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
8 | my ($fh) = @_; |
8 | my $fh = shift |
|
|
9 | or die "/etc/passwd: $!"; |
9 | ... |
10 | ... |
10 | }; |
11 | }; |
11 | |
12 | |
12 | aio_unlink "/tmp/file", sub { }; |
13 | aio_unlink "/tmp/file", sub { }; |
13 | |
14 | |
… | |
… | |
60 | faster on a RAID volume or over NFS when you do a number of stat |
61 | faster on a RAID volume or over NFS when you do a number of stat |
61 | operations concurrently. |
62 | operations concurrently. |
62 | |
63 | |
63 | While most of this works on all types of file descriptors (for example |
64 | While most of this works on all types of file descriptors (for example |
64 | sockets), using these functions on file descriptors that support |
65 | sockets), using these functions on file descriptors that support |
65 | nonblocking operation (again, sockets, pipes etc.) is very inefficient |
66 | nonblocking operation (again, sockets, pipes etc.) is very inefficient. |
66 | or might not work (aio_read fails on sockets/pipes/fifos). Use an event |
|
|
67 | loop for that (such as the Event module): IO::AIO will naturally fit |
67 | Use an event loop for that (such as the Event module): IO::AIO will |
68 | into such an event loop itself. |
68 | naturally fit into such an event loop itself. |
69 | |
69 | |
70 | In this version, a number of threads are started that execute your |
70 | In this version, a number of threads are started that execute your |
71 | requests and signal their completion. You don't need thread support in |
71 | requests and signal their completion. You don't need thread support in |
72 | perl, and the threads created by this module will not be visible to |
72 | perl, and the threads created by this module will not be visible to |
73 | perl. In the future, this module might make use of the native aio |
73 | perl. In the future, this module might make use of the native aio |
… | |
… | |
75 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
75 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
76 | files currently, for example), and they would only support aio_read and |
76 | files currently, for example), and they would only support aio_read and |
77 | aio_write, so the remaining functionality would have to be implemented |
77 | aio_write, so the remaining functionality would have to be implemented |
78 | using threads anyway. |
78 | using threads anyway. |
79 | |
79 | |
80 | Although the module will work with in the presence of other (Perl-) |
80 | Although the module will work in the presence of other (Perl-) threads, |
81 | threads, it is currently not reentrant in any way, so use appropriate |
81 | it is currently not reentrant in any way, so use appropriate locking |
82 | locking yourself, always call "poll_cb" from within the same thread, or |
82 | yourself, always call "poll_cb" from within the same thread, or never |
83 | never call "poll_cb" (or other "aio_" functions) recursively. |
83 | call "poll_cb" (or other "aio_" functions) recursively. |
84 | |
84 | |
85 | EXAMPLE |
85 | EXAMPLE |
86 | This is a simple example that uses the Event module and loads |
86 | This is a simple example that uses the Event module and loads |
87 | /etc/passwd asynchronously: |
87 | /etc/passwd asynchronously: |
88 | |
88 | |
… | |
… | |
95 | poll => 'r', |
95 | poll => 'r', |
96 | cb => \&IO::AIO::poll_cb); |
96 | cb => \&IO::AIO::poll_cb); |
97 | |
97 | |
98 | # queue the request to open /etc/passwd |
98 | # queue the request to open /etc/passwd |
99 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
99 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
100 | my $fh = $_[0] |
100 | my $fh = shift |
101 | or die "error while opening: $!"; |
101 | or die "error while opening: $!"; |
102 | |
102 | |
103 | # stat'ing filehandles is generally non-blocking |
103 | # stat'ing filehandles is generally non-blocking |
104 | my $size = -s $fh; |
104 | my $size = -s $fh; |
105 | |
105 | |
… | |
… | |
241 | They are the same as used by "sysopen". |
241 | They are the same as used by "sysopen". |
242 | |
242 | |
243 | Likewise, $mode specifies the mode of the newly created file, if it |
243 | Likewise, $mode specifies the mode of the newly created file, if it |
244 | didn't exist and "O_CREAT" has been given, just like perl's |
244 | didn't exist and "O_CREAT" has been given, just like perl's |
245 | "sysopen", except that it is mandatory (i.e. use 0 if you don't |
245 | "sysopen", except that it is mandatory (i.e. use 0 if you don't |
246 | create new files, and 0666 or 0777 if you do). |
246 | create new files, and 0666 or 0777 if you do). Note that the $mode |
|
|
247 | will be modified by the umask in effect then the request is being |
|
|
248 | executed, so better never change the umask. |
247 | |
249 | |
248 | Example: |
250 | Example: |
249 | |
251 | |
250 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
252 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
251 | if ($_[0]) { |
253 | if ($_[0]) { |
… | |
… | |
256 | } |
258 | } |
257 | }; |
259 | }; |
258 | |
260 | |
259 | aio_close $fh, $callback->($status) |
261 | aio_close $fh, $callback->($status) |
260 | Asynchronously close a file and call the callback with the result |
262 | Asynchronously close a file and call the callback with the result |
261 | code. *WARNING:* although accepted, you should not pass in a perl |
263 | code. |
262 | filehandle here, as perl will likely close the file descriptor |
|
|
263 | another time when the filehandle is destroyed. Normally, you can |
|
|
264 | safely call perls "close" or just let filehandles go out of scope. |
|
|
265 | |
264 | |
266 | This is supposed to be a bug in the API, so that might change. It's |
265 | Unfortunately, you can't do this to perl. Perl *insists* very |
267 | therefore best to avoid this function. |
266 | strongly on closing the file descriptor associated with the |
|
|
267 | filehandle itself. Here is what aio_close will try: |
|
|
268 | |
|
|
269 | 1. dup()licate the fd |
|
|
270 | 2. asynchronously close() the duplicated fd |
|
|
271 | 3. dup()licate the fd once more |
|
|
272 | 4. let perl close() the filehandle |
|
|
273 | 5. asynchronously close the duplicated fd |
|
|
274 | |
|
|
275 | The idea is that the first close() flushes stuff to disk that |
|
|
276 | closing an fd will flush, so when perl closes the fd, nothing much |
|
|
277 | will need to be flushed. The second async. close() will then flush |
|
|
278 | stuff to disk that closing the last fd to the file will flush. |
|
|
279 | |
|
|
280 | Just FYI, SuSv3 has this to say on close: |
|
|
281 | |
|
|
282 | All outstanding record locks owned by the process on the file |
|
|
283 | associated with the file descriptor shall be removed. |
|
|
284 | |
|
|
285 | If fildes refers to a socket, close() shall cause the socket to be |
|
|
286 | destroyed. ... close() shall block for up to the current linger |
|
|
287 | interval until all data is transmitted. |
|
|
288 | [this actually sounds like a specification bug, but who knows] |
|
|
289 | |
|
|
290 | And at least Linux additionally actually flushes stuff on every |
|
|
291 | close, even when the file itself is still open. |
|
|
292 | |
|
|
293 | Sounds enourmously inefficient and complicated? Yes... please show |
|
|
294 | me how to nuke perl's fd out of existence... |
268 | |
295 | |
269 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
296 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
270 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
297 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
271 | Reads or writes "length" bytes from the specified "fh" and "offset" |
298 | Reads or writes $length bytes from the specified $fh and $offset |
272 | into the scalar given by "data" and offset "dataoffset" and calls |
299 | into the scalar given by $data and offset $dataoffset and calls the |
273 | the callback without the actual number of bytes read (or -1 on |
300 | callback without the actual number of bytes read (or -1 on error, |
274 | error, just like the syscall). |
301 | just like the syscall). |
|
|
302 | |
|
|
303 | If $offset is undefined, then the current file descriptor offset |
|
|
304 | will be used (and updated), otherwise the file descriptor offset |
|
|
305 | will not be changed by these calls. |
|
|
306 | |
|
|
307 | If $length is undefined in "aio_write", use the remaining length of |
|
|
308 | $data. |
|
|
309 | |
|
|
310 | If $dataoffset is less than zero, it will be counted from the end of |
|
|
311 | $data. |
275 | |
312 | |
276 | The $data scalar *MUST NOT* be modified in any way while the request |
313 | The $data scalar *MUST NOT* be modified in any way while the request |
277 | is outstanding. Modifying it can result in segfaults or WW3 (if the |
314 | is outstanding. Modifying it can result in segfaults or World War |
278 | necessary/optional hardware is installed). |
315 | III (if the necessary/optional hardware is installed). |
279 | |
316 | |
280 | Example: Read 15 bytes at offset 7 into scalar $buffer, starting at |
317 | Example: Read 15 bytes at offset 7 into scalar $buffer, starting at |
281 | offset 0 within the scalar: |
318 | offset 0 within the scalar: |
282 | |
319 | |
283 | aio_read $fh, 7, 15, $buffer, 0, sub { |
320 | aio_read $fh, 7, 15, $buffer, 0, sub { |
… | |
… | |
341 | aio_stat "/etc/passwd", sub { |
378 | aio_stat "/etc/passwd", sub { |
342 | $_[0] and die "stat failed: $!"; |
379 | $_[0] and die "stat failed: $!"; |
343 | print "size is ", -s _, "\n"; |
380 | print "size is ", -s _, "\n"; |
344 | }; |
381 | }; |
345 | |
382 | |
|
|
383 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
|
|
384 | Works like perl's "utime" function (including the special case of |
|
|
385 | $atime and $mtime being undef). Fractional times are supported if |
|
|
386 | the underlying syscalls support them. |
|
|
387 | |
|
|
388 | When called with a pathname, uses utimes(2) if available, otherwise |
|
|
389 | utime(2). If called on a file descriptor, uses futimes(2) if |
|
|
390 | available, otherwise returns ENOSYS, so this is not portable. |
|
|
391 | |
|
|
392 | Examples: |
|
|
393 | |
|
|
394 | # set atime and mtime to current time (basically touch(1)): |
|
|
395 | aio_utime "path", undef, undef; |
|
|
396 | # set atime to current time and mtime to beginning of the epoch: |
|
|
397 | aio_utime "path", time, undef; # undef==0 |
|
|
398 | |
|
|
399 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
400 | Works like perl's "chown" function, except that "undef" for either |
|
|
401 | $uid or $gid is being interpreted as "do not change" (but -1 can |
|
|
402 | also be used). |
|
|
403 | |
|
|
404 | Examples: |
|
|
405 | |
|
|
406 | # same as "chown root path" in the shell: |
|
|
407 | aio_chown "path", 0, -1; |
|
|
408 | # same as above: |
|
|
409 | aio_chown "path", 0, undef; |
|
|
410 | |
|
|
411 | aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
412 | Works like truncate(2) or ftruncate(2). |
|
|
413 | |
|
|
414 | aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
415 | Works like perl's "chmod" function. |
|
|
416 | |
346 | aio_unlink $pathname, $callback->($status) |
417 | aio_unlink $pathname, $callback->($status) |
347 | Asynchronously unlink (delete) a file and call the callback with the |
418 | Asynchronously unlink (delete) a file and call the callback with the |
348 | result code. |
419 | result code. |
349 | |
420 | |
350 | aio_mknod $path, $mode, $dev, $callback->($status) |
421 | aio_mknod $path, $mode, $dev, $callback->($status) |
… | |
… | |
372 | |
443 | |
373 | aio_rename $srcpath, $dstpath, $callback->($status) |
444 | aio_rename $srcpath, $dstpath, $callback->($status) |
374 | Asynchronously rename the object at $srcpath to $dstpath, just as |
445 | Asynchronously rename the object at $srcpath to $dstpath, just as |
375 | rename(2) and call the callback with the result code. |
446 | rename(2) and call the callback with the result code. |
376 | |
447 | |
|
|
448 | aio_mkdir $pathname, $mode, $callback->($status) |
|
|
449 | Asynchronously mkdir (create) a directory and call the callback with |
|
|
450 | the result code. $mode will be modified by the umask at the time the |
|
|
451 | request is executed, so do not change your umask. |
|
|
452 | |
377 | aio_rmdir $pathname, $callback->($status) |
453 | aio_rmdir $pathname, $callback->($status) |
378 | Asynchronously rmdir (delete) a directory and call the callback with |
454 | Asynchronously rmdir (delete) a directory and call the callback with |
379 | the result code. |
455 | the result code. |
380 | |
456 | |
381 | aio_readdir $pathname, $callback->($entries) |
457 | aio_readdir $pathname, $callback->($entries) |
… | |
… | |
383 | entire directory (i.e. opendir + readdir + closedir). The entries |
459 | entire directory (i.e. opendir + readdir + closedir). The entries |
384 | will not be sorted, and will NOT include the "." and ".." entries. |
460 | will not be sorted, and will NOT include the "." and ".." entries. |
385 | |
461 | |
386 | The callback a single argument which is either "undef" or an |
462 | The callback a single argument which is either "undef" or an |
387 | array-ref with the filenames. |
463 | array-ref with the filenames. |
|
|
464 | |
|
|
465 | aio_load $path, $data, $callback->($status) |
|
|
466 | This is a composite request that tries to fully load the given file |
|
|
467 | into memory. Status is the same as with aio_read. |
388 | |
468 | |
389 | aio_copy $srcpath, $dstpath, $callback->($status) |
469 | aio_copy $srcpath, $dstpath, $callback->($status) |
390 | Try to copy the *file* (directories not supported as either source |
470 | Try to copy the *file* (directories not supported as either source |
391 | or destination) from $srcpath to $dstpath and call the callback with |
471 | or destination) from $srcpath to $dstpath and call the callback with |
392 | the 0 (error) or -1 ok. |
472 | the 0 (error) or -1 ok. |
… | |
… | |
460 | |
540 | |
461 | It will also likely work on non-POSIX filesystems with reduced |
541 | It will also likely work on non-POSIX filesystems with reduced |
462 | efficiency as those tend to return 0 or 1 as link counts, which |
542 | efficiency as those tend to return 0 or 1 as link counts, which |
463 | disables the directory counting heuristic. |
543 | disables the directory counting heuristic. |
464 | |
544 | |
|
|
545 | aio_rmtree $path, $callback->($status) |
|
|
546 | Delete a directory tree starting (and including) $path, return the |
|
|
547 | status of the final "rmdir" only. This is a composite request that |
|
|
548 | uses "aio_scandir" to recurse into and rmdir directories, and unlink |
|
|
549 | everything else. |
|
|
550 | |
465 | aio_fsync $fh, $callback->($status) |
551 | aio_fsync $fh, $callback->($status) |
466 | Asynchronously call fsync on the given filehandle and call the |
552 | Asynchronously call fsync on the given filehandle and call the |
467 | callback with the fsync result code. |
553 | callback with the fsync result code. |
468 | |
554 | |
469 | aio_fdatasync $fh, $callback->($status) |
555 | aio_fdatasync $fh, $callback->($status) |
… | |
… | |
711 | Event->io (fd => IO::AIO::poll_fileno, |
797 | Event->io (fd => IO::AIO::poll_fileno, |
712 | poll => 'r', nice => 1, |
798 | poll => 'r', nice => 1, |
713 | cb => &IO::AIO::poll_cb); |
799 | cb => &IO::AIO::poll_cb); |
714 | |
800 | |
715 | IO::AIO::poll_wait |
801 | IO::AIO::poll_wait |
|
|
802 | If there are any outstanding requests and none of them in the result |
716 | Wait till the result filehandle becomes ready for reading (simply |
803 | phase, wait till the result filehandle becomes ready for reading |
717 | does a "select" on the filehandle. This is useful if you want to |
804 | (simply does a "select" on the filehandle. This is useful if you |
718 | synchronously wait for some requests to finish). |
805 | want to synchronously wait for some requests to finish). |
719 | |
806 | |
720 | See "nreqs" for an example. |
807 | See "nreqs" for an example. |
721 | |
808 | |
722 | IO::AIO::poll |
809 | IO::AIO::poll |
723 | Waits until some requests have been handled. |
810 | Waits until some requests have been handled. |
724 | |
811 | |
|
|
812 | Returns the number of requests processed, but is otherwise strictly |
725 | Strictly equivalent to: |
813 | equivalent to: |
726 | |
814 | |
727 | IO::AIO::poll_wait, IO::AIO::poll_cb |
815 | IO::AIO::poll_wait, IO::AIO::poll_cb |
728 | if IO::AIO::nreqs; |
|
|
729 | |
816 | |
730 | IO::AIO::flush |
817 | IO::AIO::flush |
731 | Wait till all outstanding AIO requests have been handled. |
818 | Wait till all outstanding AIO requests have been handled. |
732 | |
819 | |
733 | Strictly equivalent to: |
820 | Strictly equivalent to: |
… | |
… | |
789 | $oldmaxreqs = IO::AIO::max_outstanding $maxreqs |
876 | $oldmaxreqs = IO::AIO::max_outstanding $maxreqs |
790 | This is a very bad function to use in interactive programs because |
877 | This is a very bad function to use in interactive programs because |
791 | it blocks, and a bad way to reduce concurrency because it is |
878 | it blocks, and a bad way to reduce concurrency because it is |
792 | inexact: Better use an "aio_group" together with a feed callback. |
879 | inexact: Better use an "aio_group" together with a feed callback. |
793 | |
880 | |
794 | Sets the maximum number of outstanding requests to $nreqs. If you to |
881 | Sets the maximum number of outstanding requests to $nreqs. If you do |
795 | queue up more than this number of requests, the next call to the |
882 | queue up more than this number of requests, the next call to the |
796 | "poll_cb" (and "poll_some" and other functions calling "poll_cb") |
883 | "poll_cb" (and "poll_some" and other functions calling "poll_cb") |
797 | function will block until the limit is no longer exceeded. |
884 | function will block until the limit is no longer exceeded. |
798 | |
885 | |
799 | The default value is very large, so there is no practical limit on |
886 | The default value is very large, so there is no practical limit on |
… | |
… | |
845 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
932 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
846 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
933 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
847 | scalars and other data passed into aio requests will also be locked and |
934 | scalars and other data passed into aio requests will also be locked and |
848 | will consume memory till the request has entered the done state. |
935 | will consume memory till the request has entered the done state. |
849 | |
936 | |
850 | This is now awfully much, so queuing lots of requests is not usually a |
937 | This is not awfully much, so queuing lots of requests is not usually a |
851 | problem. |
938 | problem. |
852 | |
939 | |
853 | Per-thread usage: |
940 | Per-thread usage: |
854 | |
941 | |
855 | In the execution phase, some aio requests require more memory for |
942 | In the execution phase, some aio requests require more memory for |