… | |
… | |
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.61'; |
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. |
324 | |
328 | |
|
|
329 | Therefore, C<aio_close> will not close the filehandle - instead it will |
|
|
330 | use dup2 to overwrite the file descriptor with the write-end of a pipe |
|
|
331 | (the pipe fd will be created on demand and will be cached). |
|
|
332 | |
|
|
333 | Or in other words: the file descriptor will be closed, but it will not be |
|
|
334 | free for reuse until the perl filehandle is closed. |
|
|
335 | |
|
|
336 | =cut |
325 | |
337 | |
326 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
338 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
327 | |
339 | |
328 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
340 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
329 | |
341 | |
330 | Reads or writes C<length> bytes from the specified C<fh> and C<offset> |
342 | 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 |
343 | 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 |
344 | callback without the actual number of bytes read (or -1 on error, just |
333 | like the syscall). |
345 | like the syscall). |
334 | |
346 | |
|
|
347 | If C<$offset> is undefined, then the current file descriptor offset will |
|
|
348 | be used (and updated), otherwise the file descriptor offset will not be |
|
|
349 | changed by these calls. |
|
|
350 | |
|
|
351 | If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. |
|
|
352 | |
|
|
353 | If C<$dataoffset> is less than zero, it will be counted from the end of |
|
|
354 | C<$data>. |
|
|
355 | |
335 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
356 | 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 |
357 | is outstanding. Modifying it can result in segfaults or World War III (if |
337 | necessary/optional hardware is installed). |
358 | the necessary/optional hardware is installed). |
338 | |
359 | |
339 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
360 | Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at |
340 | offset C<0> within the scalar: |
361 | offset C<0> within the scalar: |
341 | |
362 | |
342 | aio_read $fh, 7, 15, $buffer, 0, sub { |
363 | aio_read $fh, 7, 15, $buffer, 0, sub { |
… | |
… | |
436 | aio_chown "path", 0, -1; |
457 | aio_chown "path", 0, -1; |
437 | # same as above: |
458 | # same as above: |
438 | aio_chown "path", 0, undef; |
459 | aio_chown "path", 0, undef; |
439 | |
460 | |
440 | |
461 | |
|
|
462 | =item aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
463 | |
|
|
464 | Works like truncate(2) or ftruncate(2). |
|
|
465 | |
|
|
466 | |
441 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
467 | =item aio_chmod $fh_or_path, $mode, $callback->($status) |
442 | |
468 | |
443 | Works like perl's C<chmod> function. |
469 | Works like perl's C<chmod> function. |
444 | |
470 | |
445 | |
471 | |
… | |
… | |
578 | |
604 | |
579 | # those should not normally block. should. should. |
605 | # those should not normally block. should. should. |
580 | utime $stat[8], $stat[9], $dst; |
606 | utime $stat[8], $stat[9], $dst; |
581 | chmod $stat[2] & 07777, $dst_fh; |
607 | chmod $stat[2] & 07777, $dst_fh; |
582 | chown $stat[4], $stat[5], $dst_fh; |
608 | chown $stat[4], $stat[5], $dst_fh; |
|
|
609 | |
|
|
610 | aioreq_pri $pri; |
583 | close $dst_fh; |
611 | add $grp aio_close $dst_fh; |
584 | } else { |
612 | } else { |
585 | $grp->result (-1); |
613 | $grp->result (-1); |
586 | close $src_fh; |
614 | close $src_fh; |
587 | close $dst_fh; |
615 | close $dst_fh; |
588 | |
616 | |
… | |
… | |
821 | |
849 | |
822 | $grp |
850 | $grp |
823 | } |
851 | } |
824 | } |
852 | } |
825 | |
853 | |
|
|
854 | =item aio_sync $callback->($status) |
|
|
855 | |
|
|
856 | Asynchronously call sync and call the callback when finished. |
|
|
857 | |
826 | =item aio_fsync $fh, $callback->($status) |
858 | =item aio_fsync $fh, $callback->($status) |
827 | |
859 | |
828 | Asynchronously call fsync on the given filehandle and call the callback |
860 | Asynchronously call fsync on the given filehandle and call the callback |
829 | with the fsync result code. |
861 | with the fsync result code. |
830 | |
862 | |
… | |
… | |
833 | Asynchronously call fdatasync on the given filehandle and call the |
865 | Asynchronously call fdatasync on the given filehandle and call the |
834 | callback with the fdatasync result code. |
866 | callback with the fdatasync result code. |
835 | |
867 | |
836 | If this call isn't available because your OS lacks it or it couldn't be |
868 | 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. |
869 | detected, it will be emulated by calling C<fsync> instead. |
|
|
870 | |
|
|
871 | =item aio_pathsync $path, $callback->($status) |
|
|
872 | |
|
|
873 | This request tries to open, fsync and close the given path. This is a |
|
|
874 | composite request intended tosync directories after directory operations |
|
|
875 | (E.g. rename). This might not work on all operating systems or have any |
|
|
876 | specific effect, but usually it makes sure that directory changes get |
|
|
877 | written to disc. It works for anything that can be opened for read-only, |
|
|
878 | not just directories. |
|
|
879 | |
|
|
880 | Passes C<0> when everything went ok, and C<-1> on error. |
|
|
881 | |
|
|
882 | =cut |
|
|
883 | |
|
|
884 | sub aio_pathsync($;$) { |
|
|
885 | aio_block { |
|
|
886 | my ($path, $cb) = @_; |
|
|
887 | |
|
|
888 | my $pri = aioreq_pri; |
|
|
889 | my $grp = aio_group $cb; |
|
|
890 | |
|
|
891 | aioreq_pri $pri; |
|
|
892 | add $grp aio_open $path, O_RDONLY, 0, sub { |
|
|
893 | my ($fh) = @_; |
|
|
894 | if ($fh) { |
|
|
895 | aioreq_pri $pri; |
|
|
896 | add $grp aio_fsync $fh, sub { |
|
|
897 | $grp->result ($_[0]); |
|
|
898 | |
|
|
899 | aioreq_pri $pri; |
|
|
900 | add $grp aio_close $fh; |
|
|
901 | }; |
|
|
902 | } else { |
|
|
903 | $grp->result (-1); |
|
|
904 | } |
|
|
905 | }; |
|
|
906 | |
|
|
907 | $grp |
|
|
908 | } |
|
|
909 | } |
838 | |
910 | |
839 | =item aio_group $callback->(...) |
911 | =item aio_group $callback->(...) |
840 | |
912 | |
841 | This is a very special aio request: Instead of doing something, it is a |
913 | 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 |
914 | 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. |
1051 | itself. Useful when you queued a lot of events but got a result early. |
980 | |
1052 | |
981 | =item $grp->result (...) |
1053 | =item $grp->result (...) |
982 | |
1054 | |
983 | Set the result value(s) that will be passed to the group callback when all |
1055 | 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 |
1056 | 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, |
1057 | of errno (just like calling C<errno> without an error number). By default, |
986 | no argument will be passed and errno is zero. |
1058 | no argument will be passed and errno is zero. |
987 | |
1059 | |
988 | =item $grp->errno ([$errno]) |
1060 | =item $grp->errno ([$errno]) |
989 | |
1061 | |
… | |
… | |
1194 | This is a very bad function to use in interactive programs because it |
1266 | 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 |
1267 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1196 | use an C<aio_group> together with a feed callback. |
1268 | use an C<aio_group> together with a feed callback. |
1197 | |
1269 | |
1198 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1270 | 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 |
1271 | 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>) |
1272 | 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. |
1273 | function will block until the limit is no longer exceeded. |
1202 | |
1274 | |
1203 | The default value is very large, so there is no practical limit on the |
1275 | The default value is very large, so there is no practical limit on the |
1204 | number of outstanding requests. |
1276 | number of outstanding requests. |
… | |
… | |
1234 | but not yet processed by poll_cb). |
1306 | but not yet processed by poll_cb). |
1235 | |
1307 | |
1236 | =back |
1308 | =back |
1237 | |
1309 | |
1238 | =cut |
1310 | =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 | |
1311 | |
1256 | min_parallel 8; |
1312 | min_parallel 8; |
1257 | |
1313 | |
1258 | END { flush } |
1314 | END { flush } |
1259 | |
1315 | |
… | |
… | |
1283 | bytes of memory. In addition, stat requests need a stat buffer (possibly |
1339 | 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 |
1340 | 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 |
1341 | 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. |
1342 | will consume memory till the request has entered the done state. |
1287 | |
1343 | |
1288 | This is now awfully much, so queuing lots of requests is not usually a |
1344 | This is not awfully much, so queuing lots of requests is not usually a |
1289 | problem. |
1345 | problem. |
1290 | |
1346 | |
1291 | Per-thread usage: |
1347 | Per-thread usage: |
1292 | |
1348 | |
1293 | In the execution phase, some aio requests require more memory for |
1349 | In the execution phase, some aio requests require more memory for |