… | |
… | |
26 | $req->cancel; # cancel request if still in queue |
26 | $req->cancel; # cancel request if still in queue |
27 | |
27 | |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
28 | my $grp = aio_group sub { print "all stats done\n" }; |
29 | add $grp aio_stat "..." for ...; |
29 | add $grp aio_stat "..." for ...; |
30 | |
30 | |
31 | # AnyEvent integration |
31 | # AnyEvent integration (EV, Event, Glib, Tk, urxvt, pureperl...) |
32 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
32 | open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; |
33 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
33 | my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb }); |
|
|
34 | |
|
|
35 | # EV integration |
|
|
36 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
34 | |
37 | |
35 | # Event integration |
38 | # Event integration |
36 | Event->io (fd => IO::AIO::poll_fileno, |
39 | Event->io (fd => IO::AIO::poll_fileno, |
37 | poll => 'r', |
40 | poll => 'r', |
38 | cb => \&IO::AIO::poll_cb); |
41 | cb => \&IO::AIO::poll_cb); |
… | |
… | |
62 | etc.), but can also be used to easily do operations in parallel that are |
65 | etc.), but can also be used to easily do operations in parallel that are |
63 | normally done sequentially, e.g. stat'ing many files, which is much faster |
66 | normally done sequentially, e.g. stat'ing many files, which is much faster |
64 | on a RAID volume or over NFS when you do a number of stat operations |
67 | on a RAID volume or over NFS when you do a number of stat operations |
65 | concurrently. |
68 | concurrently. |
66 | |
69 | |
67 | While most of this works on all types of file descriptors (for example |
70 | While most of this works on all types of file descriptors (for |
68 | sockets), using these functions on file descriptors that support |
71 | example sockets), using these functions on file descriptors that |
69 | nonblocking operation (again, sockets, pipes etc.) is very inefficient or |
72 | support nonblocking operation (again, sockets, pipes etc.) is very |
70 | might not work (aio_read fails on sockets/pipes/fifos). Use an event loop |
73 | inefficient. Use an event loop for that (such as the L<Event|Event> |
71 | for that (such as the L<Event|Event> module): IO::AIO will naturally fit |
74 | module): IO::AIO will naturally fit into such an event loop itself. |
72 | into such an event loop itself. |
|
|
73 | |
75 | |
74 | In this version, a number of threads are started that execute your |
76 | In this version, a number of threads are started that execute your |
75 | requests and signal their completion. You don't need thread support |
77 | requests and signal their completion. You don't need thread support |
76 | in perl, and the threads created by this module will not be visible |
78 | in perl, and the threads created by this module will not be visible |
77 | to perl. In the future, this module might make use of the native aio |
79 | to perl. In the future, this module might make use of the native aio |
… | |
… | |
79 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
81 | not well-supported or restricted (GNU/Linux doesn't allow them on normal |
80 | files currently, for example), and they would only support aio_read and |
82 | files currently, for example), and they would only support aio_read and |
81 | aio_write, so the remaining functionality would have to be implemented |
83 | aio_write, so the remaining functionality would have to be implemented |
82 | using threads anyway. |
84 | using threads anyway. |
83 | |
85 | |
84 | Although the module will work with in the presence of other (Perl-) |
86 | Although the module will work in the presence of other (Perl-) threads, |
85 | threads, it is currently not reentrant in any way, so use appropriate |
87 | it is currently not reentrant in any way, so use appropriate locking |
86 | locking yourself, always call C<poll_cb> from within the same thread, or |
88 | yourself, always call C<poll_cb> from within the same thread, or never |
87 | never call C<poll_cb> (or other C<aio_> functions) recursively. |
89 | call C<poll_cb> (or other C<aio_> functions) recursively. |
88 | |
90 | |
89 | =head2 EXAMPLE |
91 | =head2 EXAMPLE |
90 | |
92 | |
91 | This is a simple example that uses the Event module and loads |
93 | This is a simple example that uses the Event module and loads |
92 | F</etc/passwd> asynchronously: |
94 | F</etc/passwd> asynchronously: |
… | |
… | |
184 | |
186 | |
185 | =cut |
187 | =cut |
186 | |
188 | |
187 | package IO::AIO; |
189 | package IO::AIO; |
188 | |
190 | |
|
|
191 | use Carp (); |
|
|
192 | |
189 | no warnings; |
193 | no warnings; |
190 | use strict 'vars'; |
194 | use strict 'vars'; |
191 | |
195 | |
192 | use base 'Exporter'; |
196 | use base 'Exporter'; |
193 | |
197 | |
194 | BEGIN { |
198 | BEGIN { |
195 | our $VERSION = '2.4'; |
199 | our $VERSION = '2.6'; |
196 | |
200 | |
197 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat |
201 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
198 | aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink |
202 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
199 | aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link |
203 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
|
|
204 | aio_fdatasync aio_pathsync aio_readahead |
|
|
205 | aio_rename aio_link aio_move aio_copy aio_group |
200 | aio_move aio_copy aio_group aio_nop aio_mknod aio_load aio_rmtree aio_mkdir |
206 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
201 | aio_chown aio_chmod aio_utime); |
207 | aio_chmod aio_utime aio_truncate); |
|
|
208 | |
202 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
209 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice aio_block)); |
203 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
210 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
204 | min_parallel max_parallel max_idle |
211 | min_parallel max_parallel max_idle |
205 | nreqs nready npending nthreads |
212 | nreqs nready npending nthreads |
206 | max_poll_time max_poll_reqs); |
213 | max_poll_time max_poll_reqs); |
… | |
… | |
312 | |
319 | |
313 | |
320 | |
314 | =item aio_close $fh, $callback->($status) |
321 | =item aio_close $fh, $callback->($status) |
315 | |
322 | |
316 | Asynchronously close a file and call the callback with the result |
323 | Asynchronously close a file and call the callback with the result |
317 | code. I<WARNING:> although accepted, you should not pass in a perl |
324 | code. |
318 | filehandle here, as perl will likely close the file descriptor another |
|
|
319 | time when the filehandle is destroyed. Normally, you can safely call perls |
|
|
320 | C<close> or just let filehandles go out of scope. |
|
|
321 | |
325 | |
322 | This is supposed to be a bug in the API, so that might change. It's |
326 | Unfortunately, you can't do this to perl. Perl I<insists> very strongly on |
323 | therefore best to avoid this function. |
327 | closing the file descriptor associated with the filehandle itself. Here is |
|
|
328 | what aio_close will try: |
|
|
329 | |
|
|
330 | 1. dup()licate the fd |
|
|
331 | 2. asynchronously close() the duplicated fd |
|
|
332 | 3. dup()licate the fd once more |
|
|
333 | 4. let perl close() the filehandle |
|
|
334 | 5. asynchronously close the duplicated fd |
|
|
335 | |
|
|
336 | The idea is that the first close() flushes stuff to disk that closing an |
|
|
337 | fd will flush, so when perl closes the fd, nothing much will need to be |
|
|
338 | flushed. The second async. close() will then flush stuff to disk that |
|
|
339 | closing the last fd to the file will flush. |
|
|
340 | |
|
|
341 | Just FYI, SuSv3 has this to say on close: |
|
|
342 | |
|
|
343 | All outstanding record locks owned by the process on the file |
|
|
344 | associated with the file descriptor shall be removed. |
|
|
345 | |
|
|
346 | If fildes refers to a socket, close() shall cause the socket to be |
|
|
347 | destroyed. ... close() shall block for up to the current linger |
|
|
348 | interval until all data is transmitted. |
|
|
349 | [this actually sounds like a specification bug, but who knows] |
|
|
350 | |
|
|
351 | And at least Linux additionally actually flushes stuff on every close, |
|
|
352 | even when the file itself is still open. |
|
|
353 | |
|
|
354 | Sounds enourmously inefficient and complicated? Yes... please show me how |
|
|
355 | to nuke perl's fd out of existence... |
|
|
356 | |
|
|
357 | =cut |
|
|
358 | |
|
|
359 | sub aio_close($;$) { |
|
|
360 | aio_block { |
|
|
361 | my ($fh, $cb) = @_; |
|
|
362 | |
|
|
363 | my $pri = aioreq_pri; |
|
|
364 | my $grp = aio_group $cb; |
|
|
365 | |
|
|
366 | my $fd = fileno $fh; |
|
|
367 | |
|
|
368 | defined $fd or Carp::croak "aio_close called with fd-less filehandle"; |
|
|
369 | |
|
|
370 | # if the dups fail we will simply get EBADF |
|
|
371 | my $fd2 = _dup $fd; |
|
|
372 | aioreq_pri $pri; |
|
|
373 | add $grp _aio_close $fd2, sub { |
|
|
374 | my $fd2 = _dup $fd; |
|
|
375 | close $fh; |
|
|
376 | aioreq_pri $pri; |
|
|
377 | add $grp _aio_close $fd2, sub { |
|
|
378 | $grp->result ($_[0]); |
|
|
379 | }; |
|
|
380 | }; |
|
|
381 | |
|
|
382 | $grp |
|
|
383 | } |
|
|
384 | } |
324 | |
385 | |
325 | |
386 | |
326 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
387 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
327 | |
388 | |
328 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
389 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
329 | |
390 | |
330 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
391 | Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> |
331 | into the scalar given by C<data> and offset C<dataoffset> and calls the |
392 | into the scalar given by C<$data> and offset C<$dataoffset> and calls the |
332 | callback without the actual number of bytes read (or -1 on error, just |
393 | callback without the actual number of bytes read (or -1 on error, just |
333 | like the syscall). |
394 | like the syscall). |
334 | |
395 | |
|
|
396 | If C<$offset> is undefined, then the current file descriptor offset will |
|
|
397 | be used (and updated), otherwise the file descriptor offset will not be |
|
|
398 | changed by these calls. |
|
|
399 | |
|
|
400 | If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. |
|
|
401 | |
|
|
402 | If C<$dataoffset> is less than zero, it will be counted from the end of |
|
|
403 | C<$data>. |
|
|
404 | |
335 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
405 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
336 | is outstanding. Modifying it can result in segfaults or WW3 (if the |
406 | is outstanding. Modifying it can result in segfaults or World War III (if |
337 | necessary/optional hardware is installed). |
407 | the necessary/optional hardware is installed). |
338 | |
408 | |
339 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
409 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
340 | offset C<0> within the scalar: |
410 | offset C<0> within the scalar: |
341 | |
411 | |
342 | aio_read $fh, 7, 15, $buffer, 0, sub { |
412 | aio_read $fh, 7, 15, $buffer, 0, sub { |
… | |
… | |
417 | utime(2). If called on a file descriptor, uses futimes(2) if available, |
487 | utime(2). If called on a file descriptor, uses futimes(2) if available, |
418 | otherwise returns ENOSYS, so this is not portable. |
488 | otherwise returns ENOSYS, so this is not portable. |
419 | |
489 | |
420 | Examples: |
490 | Examples: |
421 | |
491 | |
422 | # set atime and mtime to current time: |
492 | # set atime and mtime to current time (basically touch(1)): |
423 | aio_utime "path", undef, undef; |
493 | aio_utime "path", undef, undef; |
424 | # set atime to current time and mtime to beginning of the epoch: |
494 | # set atime to current time and mtime to beginning of the epoch: |
425 | aio_utime "path", time, undef; # undef==0 |
495 | aio_utime "path", time, undef; # undef==0 |
426 | |
496 | |
427 | |
497 | |
… | |
… | |
434 | |
504 | |
435 | # same as "chown root path" in the shell: |
505 | # same as "chown root path" in the shell: |
436 | aio_chown "path", 0, -1; |
506 | aio_chown "path", 0, -1; |
437 | # same as above: |
507 | # same as above: |
438 | aio_chown "path", 0, undef; |
508 | aio_chown "path", 0, undef; |
|
|
509 | |
|
|
510 | |
|
|
511 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
512 | |
|
|
513 | Works like truncate(2) or ftruncate(2). |
439 | |
514 | |
440 | |
515 | |
441 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
516 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
442 | |
517 | |
443 | Works like perl's C<chmod> function. |
518 | Works like perl's C<chmod> function. |
… | |
… | |
578 | |
653 | |
579 | # those should not normally block. should. should. |
654 | # those should not normally block. should. should. |
580 | utime $stat[8], $stat[9], $dst; |
655 | utime $stat[8], $stat[9], $dst; |
581 | chmod $stat[2] & 07777, $dst_fh; |
656 | chmod $stat[2] & 07777, $dst_fh; |
582 | chown $stat[4], $stat[5], $dst_fh; |
657 | chown $stat[4], $stat[5], $dst_fh; |
|
|
658 | |
|
|
659 | aioreq_pri $pri; |
583 | close $dst_fh; |
660 | add $grp aio_close $dst_fh; |
584 | } else { |
661 | } else { |
585 | $grp->result (-1); |
662 | $grp->result (-1); |
586 | close $src_fh; |
663 | close $src_fh; |
587 | close $dst_fh; |
664 | close $dst_fh; |
588 | |
665 | |
… | |
… | |
821 | |
898 | |
822 | $grp |
899 | $grp |
823 | } |
900 | } |
824 | } |
901 | } |
825 | |
902 | |
|
|
903 | =item aio_sync $callback->($status) |
|
|
904 | |
|
|
905 | Asynchronously call sync and call the callback when finished. |
|
|
906 | |
826 | =item aio_fsync $fh, $callback->($status) |
907 | =item aio_fsync $fh, $callback->($status) |
827 | |
908 | |
828 | Asynchronously call fsync on the given filehandle and call the callback |
909 | Asynchronously call fsync on the given filehandle and call the callback |
829 | with the fsync result code. |
910 | with the fsync result code. |
830 | |
911 | |
… | |
… | |
833 | Asynchronously call fdatasync on the given filehandle and call the |
914 | Asynchronously call fdatasync on the given filehandle and call the |
834 | callback with the fdatasync result code. |
915 | callback with the fdatasync result code. |
835 | |
916 | |
836 | If this call isn't available because your OS lacks it or it couldn't be |
917 | If this call isn't available because your OS lacks it or it couldn't be |
837 | detected, it will be emulated by calling C<fsync> instead. |
918 | detected, it will be emulated by calling C<fsync> instead. |
|
|
919 | |
|
|
920 | =item aio_pathsync $path, $callback->($status) |
|
|
921 | |
|
|
922 | This request tries to open, fsync and close the given path. This is a |
|
|
923 | composite request intended tosync directories after directory operations |
|
|
924 | (E.g. rename). This might not work on all operating systems or have any |
|
|
925 | specific effect, but usually it makes sure that directory changes get |
|
|
926 | written to disc. It works for anything that can be opened for read-only, |
|
|
927 | not just directories. |
|
|
928 | |
|
|
929 | Passes C<0> when everything went ok, and C<-1> on error. |
|
|
930 | |
|
|
931 | =cut |
|
|
932 | |
|
|
933 | sub aio_pathsync($;$) { |
|
|
934 | aio_block { |
|
|
935 | my ($path, $cb) = @_; |
|
|
936 | |
|
|
937 | my $pri = aioreq_pri; |
|
|
938 | my $grp = aio_group $cb; |
|
|
939 | |
|
|
940 | aioreq_pri $pri; |
|
|
941 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
942 | my ($fh) = @_; |
|
|
943 | if ($fh) { |
|
|
944 | aioreq_pri $pri; |
|
|
945 | add $grp aio_fsync $fh, sub { |
|
|
946 | $grp->result ($_[0]); |
|
|
947 | |
|
|
948 | aioreq_pri $pri; |
|
|
949 | add $grp aio_close $fh; |
|
|
950 | }; |
|
|
951 | } else { |
|
|
952 | $grp->result (-1); |
|
|
953 | } |
|
|
954 | }; |
|
|
955 | |
|
|
956 | $grp |
|
|
957 | } |
|
|
958 | } |
838 | |
959 | |
839 | =item aio_group $callback->(...) |
960 | =item aio_group $callback->(...) |
840 | |
961 | |
841 | This is a very special aio request: Instead of doing something, it is a |
962 | This is a very special aio request: Instead of doing something, it is a |
842 | container for other aio requests, which is useful if you want to bundle |
963 | container for other aio requests, which is useful if you want to bundle |
… | |
… | |
979 | itself. Useful when you queued a lot of events but got a result early. |
1100 | itself. Useful when you queued a lot of events but got a result early. |
980 | |
1101 | |
981 | =item $grp->result (...) |
1102 | =item $grp->result (...) |
982 | |
1103 | |
983 | Set the result value(s) that will be passed to the group callback when all |
1104 | Set the result value(s) that will be passed to the group callback when all |
984 | subrequests have finished and set thre groups errno to the current value |
1105 | subrequests have finished and set the groups errno to the current value |
985 | of errno (just like calling C<errno> without an error number). By default, |
1106 | of errno (just like calling C<errno> without an error number). By default, |
986 | no argument will be passed and errno is zero. |
1107 | no argument will be passed and errno is zero. |
987 | |
1108 | |
988 | =item $grp->errno ([$errno]) |
1109 | =item $grp->errno ([$errno]) |
989 | |
1110 | |
… | |
… | |
1194 | This is a very bad function to use in interactive programs because it |
1315 | This is a very bad function to use in interactive programs because it |
1195 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1316 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1196 | use an C<aio_group> together with a feed callback. |
1317 | use an C<aio_group> together with a feed callback. |
1197 | |
1318 | |
1198 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1319 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1199 | to queue up more than this number of requests, the next call to the |
1320 | do queue up more than this number of requests, the next call to the |
1200 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1321 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
1201 | function will block until the limit is no longer exceeded. |
1322 | function will block until the limit is no longer exceeded. |
1202 | |
1323 | |
1203 | The default value is very large, so there is no practical limit on the |
1324 | The default value is very large, so there is no practical limit on the |
1204 | number of outstanding requests. |
1325 | number of outstanding requests. |
… | |
… | |
1234 | but not yet processed by poll_cb). |
1355 | but not yet processed by poll_cb). |
1235 | |
1356 | |
1236 | =back |
1357 | =back |
1237 | |
1358 | |
1238 | =cut |
1359 | =cut |
1239 | |
|
|
1240 | # support function to convert a fd into a perl filehandle |
|
|
1241 | sub _fd2fh { |
|
|
1242 | return undef if $_[0] < 0; |
|
|
1243 | |
|
|
1244 | # try to generate nice filehandles |
|
|
1245 | my $sym = "IO::AIO::fd#$_[0]"; |
|
|
1246 | local *$sym; |
|
|
1247 | |
|
|
1248 | open *$sym, "+<&=$_[0]" # usually works under any unix |
|
|
1249 | or open *$sym, "<&=$_[0]" # cygwin needs this |
|
|
1250 | or open *$sym, ">&=$_[0]" # or this |
|
|
1251 | or return undef; |
|
|
1252 | |
|
|
1253 | *$sym |
|
|
1254 | } |
|
|
1255 | |
1360 | |
1256 | min_parallel 8; |
1361 | min_parallel 8; |
1257 | |
1362 | |
1258 | END { flush } |
1363 | END { flush } |
1259 | |
1364 | |
… | |
… | |
1283 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1388 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1284 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1389 | a few hundred bytes), readdir requires a result buffer and so on. Perl |
1285 | scalars and other data passed into aio requests will also be locked and |
1390 | scalars and other data passed into aio requests will also be locked and |
1286 | will consume memory till the request has entered the done state. |
1391 | will consume memory till the request has entered the done state. |
1287 | |
1392 | |
1288 | This is now awfully much, so queuing lots of requests is not usually a |
1393 | This is not awfully much, so queuing lots of requests is not usually a |
1289 | problem. |
1394 | problem. |
1290 | |
1395 | |
1291 | Per-thread usage: |
1396 | Per-thread usage: |
1292 | |
1397 | |
1293 | In the execution phase, some aio requests require more memory for |
1398 | In the execution phase, some aio requests require more memory for |