… | |
… | |
61 | 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 |
62 | operations concurrently. |
62 | operations concurrently. |
63 | |
63 | |
64 | 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 |
65 | sockets), using these functions on file descriptors that support |
65 | sockets), using these functions on file descriptors that support |
66 | nonblocking operation (again, sockets, pipes etc.) is very inefficient |
66 | nonblocking operation (again, sockets, pipes etc.) is very inefficient. |
67 | or might not work (aio_read fails on sockets/pipes/fifos). Use an event |
|
|
68 | 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 |
69 | into such an event loop itself. |
68 | naturally fit into such an event loop itself. |
70 | |
69 | |
71 | 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 |
72 | 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 |
73 | 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 |
74 | 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 |
… | |
… | |
76 | 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 |
77 | 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 |
78 | aio_write, so the remaining functionality would have to be implemented |
77 | aio_write, so the remaining functionality would have to be implemented |
79 | using threads anyway. |
78 | using threads anyway. |
80 | |
79 | |
81 | 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, |
82 | 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 |
83 | 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 |
84 | never call "poll_cb" (or other "aio_" functions) recursively. |
83 | call "poll_cb" (or other "aio_" functions) recursively. |
85 | |
84 | |
86 | EXAMPLE |
85 | EXAMPLE |
87 | 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 |
88 | /etc/passwd asynchronously: |
87 | /etc/passwd asynchronously: |
89 | |
88 | |
… | |
… | |
259 | } |
258 | } |
260 | }; |
259 | }; |
261 | |
260 | |
262 | aio_close $fh, $callback->($status) |
261 | aio_close $fh, $callback->($status) |
263 | Asynchronously close a file and call the callback with the result |
262 | Asynchronously close a file and call the callback with the result |
264 | code. *WARNING:* although accepted, you should not pass in a perl |
263 | code. |
265 | filehandle here, as perl will likely close the file descriptor |
|
|
266 | another time when the filehandle is destroyed. Normally, you can |
|
|
267 | safely call perls "close" or just let filehandles go out of scope. |
|
|
268 | |
264 | |
269 | 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 |
270 | 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... |
271 | |
295 | |
272 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
296 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
273 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
297 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
274 | Reads or writes "length" bytes from the specified "fh" and "offset" |
298 | Reads or writes $length bytes from the specified $fh and $offset |
275 | into the scalar given by "data" and offset "dataoffset" and calls |
299 | into the scalar given by $data and offset $dataoffset and calls the |
276 | 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, |
277 | 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. |
278 | |
312 | |
279 | 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 |
280 | is outstanding. Modifying it can result in segfaults or WW3 (if the |
314 | is outstanding. Modifying it can result in segfaults or World War |
281 | necessary/optional hardware is installed). |
315 | III (if the necessary/optional hardware is installed). |
282 | |
316 | |
283 | 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 |
284 | offset 0 within the scalar: |
318 | offset 0 within the scalar: |
285 | |
319 | |
286 | aio_read $fh, 7, 15, $buffer, 0, sub { |
320 | aio_read $fh, 7, 15, $buffer, 0, sub { |
… | |
… | |
344 | aio_stat "/etc/passwd", sub { |
378 | aio_stat "/etc/passwd", sub { |
345 | $_[0] and die "stat failed: $!"; |
379 | $_[0] and die "stat failed: $!"; |
346 | print "size is ", -s _, "\n"; |
380 | print "size is ", -s _, "\n"; |
347 | }; |
381 | }; |
348 | |
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 | |
349 | aio_unlink $pathname, $callback->($status) |
417 | aio_unlink $pathname, $callback->($status) |
350 | Asynchronously unlink (delete) a file and call the callback with the |
418 | Asynchronously unlink (delete) a file and call the callback with the |
351 | result code. |
419 | result code. |
352 | |
420 | |
353 | aio_mknod $path, $mode, $dev, $callback->($status) |
421 | aio_mknod $path, $mode, $dev, $callback->($status) |
… | |
… | |
808 | $oldmaxreqs = IO::AIO::max_outstanding $maxreqs |
876 | $oldmaxreqs = IO::AIO::max_outstanding $maxreqs |
809 | 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 |
810 | 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 |
811 | inexact: Better use an "aio_group" together with a feed callback. |
879 | inexact: Better use an "aio_group" together with a feed callback. |
812 | |
880 | |
813 | 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 |
814 | 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 |
815 | "poll_cb" (and "poll_some" and other functions calling "poll_cb") |
883 | "poll_cb" (and "poll_some" and other functions calling "poll_cb") |
816 | function will block until the limit is no longer exceeded. |
884 | function will block until the limit is no longer exceeded. |
817 | |
885 | |
818 | 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 |
… | |
… | |
864 | 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 |
865 | 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 |
866 | 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 |
867 | will consume memory till the request has entered the done state. |
935 | will consume memory till the request has entered the done state. |
868 | |
936 | |
869 | 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 |
870 | problem. |
938 | problem. |
871 | |
939 | |
872 | Per-thread usage: |
940 | Per-thread usage: |
873 | |
941 | |
874 | In the execution phase, some aio requests require more memory for |
942 | In the execution phase, some aio requests require more memory for |