… | |
… | |
4 | |
4 | |
5 | =head1 SYNOPSIS |
5 | =head1 SYNOPSIS |
6 | |
6 | |
7 | use IO::AIO; |
7 | use IO::AIO; |
8 | |
8 | |
9 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
9 | aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub { |
10 | my $fh = shift |
10 | my $fh = shift |
11 | or die "/etc/passwd: $!"; |
11 | or die "/etc/passwd: $!"; |
12 | ... |
12 | ... |
13 | }; |
13 | }; |
14 | |
14 | |
… | |
… | |
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 (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
|
|
32 | use AnyEvent::AIO; |
|
|
33 | |
|
|
34 | # EV integration |
|
|
35 | my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
|
|
36 | |
|
|
37 | # Event integration |
|
|
38 | Event->io (fd => IO::AIO::poll_fileno, |
|
|
39 | poll => 'r', |
|
|
40 | cb => \&IO::AIO::poll_cb); |
|
|
41 | |
|
|
42 | # Glib/Gtk2 integration |
|
|
43 | add_watch Glib::IO IO::AIO::poll_fileno, |
|
|
44 | in => sub { IO::AIO::poll_cb; 1 }; |
|
|
45 | |
|
|
46 | # Tk integration |
|
|
47 | Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", |
|
|
48 | readable => \&IO::AIO::poll_cb); |
|
|
49 | |
|
|
50 | # Danga::Socket integration |
|
|
51 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
|
|
52 | \&IO::AIO::poll_cb); |
|
|
53 | |
|
|
54 | =head1 DESCRIPTION |
31 | =head1 DESCRIPTION |
55 | |
32 | |
56 | This module implements asynchronous I/O using whatever means your |
33 | This module implements asynchronous I/O using whatever means your |
57 | operating system supports. |
34 | operating system supports. It is implemented as an interface to C<libeio> |
|
|
35 | (L<http://software.schmorp.de/pkg/libeio.html>). |
58 | |
36 | |
59 | Asynchronous means that operations that can normally block your program |
37 | Asynchronous means that operations that can normally block your program |
60 | (e.g. reading from disk) will be done asynchronously: the operation |
38 | (e.g. reading from disk) will be done asynchronously: the operation |
61 | will still block, but you can do something else in the meantime. This |
39 | will still block, but you can do something else in the meantime. This |
62 | is extremely useful for programs that need to stay interactive even |
40 | is extremely useful for programs that need to stay interactive even |
… | |
… | |
66 | on a RAID volume or over NFS when you do a number of stat operations |
44 | on a RAID volume or over NFS when you do a number of stat operations |
67 | concurrently. |
45 | concurrently. |
68 | |
46 | |
69 | While most of this works on all types of file descriptors (for |
47 | While most of this works on all types of file descriptors (for |
70 | example sockets), using these functions on file descriptors that |
48 | example sockets), using these functions on file descriptors that |
71 | support nonblocking operation (again, sockets, pipes etc.) is very |
49 | support nonblocking operation (again, sockets, pipes etc.) is |
72 | inefficient. Use an event loop for that (such as the L<Event|Event> |
50 | very inefficient. Use an event loop for that (such as the L<EV> |
73 | module): IO::AIO will naturally fit into such an event loop itself. |
51 | module): IO::AIO will naturally fit into such an event loop itself. |
74 | |
52 | |
75 | In this version, a number of threads are started that execute your |
53 | In this version, a number of threads are started that execute your |
76 | requests and signal their completion. You don't need thread support |
54 | requests and signal their completion. You don't need thread support |
77 | in perl, and the threads created by this module will not be visible |
55 | in perl, and the threads created by this module will not be visible |
… | |
… | |
87 | yourself, always call C<poll_cb> from within the same thread, or never |
65 | yourself, always call C<poll_cb> from within the same thread, or never |
88 | call C<poll_cb> (or other C<aio_> functions) recursively. |
66 | call C<poll_cb> (or other C<aio_> functions) recursively. |
89 | |
67 | |
90 | =head2 EXAMPLE |
68 | =head2 EXAMPLE |
91 | |
69 | |
92 | This is a simple example that uses the Event module and loads |
70 | This is a simple example that uses the EV module and loads |
93 | F</etc/passwd> asynchronously: |
71 | F</etc/passwd> asynchronously: |
94 | |
72 | |
95 | use Fcntl; |
73 | use Fcntl; |
96 | use Event; |
74 | use EV; |
97 | use IO::AIO; |
75 | use IO::AIO; |
98 | |
76 | |
99 | # register the IO::AIO callback with Event |
77 | # register the IO::AIO callback with EV |
100 | Event->io (fd => IO::AIO::poll_fileno, |
78 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
101 | poll => 'r', |
|
|
102 | cb => \&IO::AIO::poll_cb); |
|
|
103 | |
79 | |
104 | # queue the request to open /etc/passwd |
80 | # queue the request to open /etc/passwd |
105 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
81 | aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub { |
106 | my $fh = shift |
82 | my $fh = shift |
107 | or die "error while opening: $!"; |
83 | or die "error while opening: $!"; |
108 | |
84 | |
109 | # stat'ing filehandles is generally non-blocking |
85 | # stat'ing filehandles is generally non-blocking |
110 | my $size = -s $fh; |
86 | my $size = -s $fh; |
… | |
… | |
119 | |
95 | |
120 | # file contents now in $contents |
96 | # file contents now in $contents |
121 | print $contents; |
97 | print $contents; |
122 | |
98 | |
123 | # exit event loop and program |
99 | # exit event loop and program |
124 | Event::unloop; |
100 | EV::unloop; |
125 | }; |
101 | }; |
126 | }; |
102 | }; |
127 | |
103 | |
128 | # possibly queue up other requests, or open GUI windows, |
104 | # possibly queue up other requests, or open GUI windows, |
129 | # check for sockets etc. etc. |
105 | # check for sockets etc. etc. |
130 | |
106 | |
131 | # process events as long as there are some: |
107 | # process events as long as there are some: |
132 | Event::loop; |
108 | EV::loop; |
133 | |
109 | |
134 | =head1 REQUEST ANATOMY AND LIFETIME |
110 | =head1 REQUEST ANATOMY AND LIFETIME |
135 | |
111 | |
136 | Every C<aio_*> function creates a request. which is a C data structure not |
112 | Every C<aio_*> function creates a request. which is a C data structure not |
137 | directly visible to Perl. |
113 | directly visible to Perl. |
… | |
… | |
187 | |
163 | |
188 | package IO::AIO; |
164 | package IO::AIO; |
189 | |
165 | |
190 | use Carp (); |
166 | use Carp (); |
191 | |
167 | |
192 | no warnings; |
168 | use common::sense; |
193 | use strict 'vars'; |
|
|
194 | |
169 | |
195 | use base 'Exporter'; |
170 | use base 'Exporter'; |
196 | |
171 | |
197 | BEGIN { |
172 | BEGIN { |
198 | our $VERSION = '3.1'; |
173 | our $VERSION = '3.65'; |
199 | |
174 | |
200 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
175 | our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close |
201 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir |
176 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
202 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
177 | aio_scandir aio_symlink aio_readlink aio_sync aio_fsync |
203 | aio_fdatasync aio_pathsync aio_readahead |
178 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
204 | aio_rename aio_link aio_move aio_copy aio_group |
179 | aio_rename aio_link aio_move aio_copy aio_group |
205 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
180 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
206 | aio_chmod aio_utime aio_truncate); |
181 | aio_chmod aio_utime aio_truncate |
|
|
182 | aio_msync aio_mtouch aio_mlock aio_mlockall |
|
|
183 | aio_statvfs); |
207 | |
184 | |
208 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
185 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
209 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
186 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
210 | min_parallel max_parallel max_idle |
187 | min_parallel max_parallel max_idle |
211 | nreqs nready npending nthreads |
188 | nreqs nready npending nthreads |
212 | max_poll_time max_poll_reqs); |
189 | max_poll_time max_poll_reqs |
|
|
190 | sendfile fadvise madvise |
|
|
191 | mmap munmap munlock munlockall); |
|
|
192 | |
|
|
193 | push @AIO_REQ, qw(aio_busy); # not exported |
213 | |
194 | |
214 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
195 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
215 | |
196 | |
216 | require XSLoader; |
197 | require XSLoader; |
217 | XSLoader::load ("IO::AIO", $VERSION); |
198 | XSLoader::load ("IO::AIO", $VERSION); |
218 | } |
199 | } |
219 | |
200 | |
220 | =head1 FUNCTIONS |
201 | =head1 FUNCTIONS |
|
|
202 | |
|
|
203 | =head2 QUICK OVERVIEW |
|
|
204 | |
|
|
205 | This section simply lists the prototypes of the most important functions |
|
|
206 | for quick reference. See the following sections for function-by-function |
|
|
207 | documentation. |
|
|
208 | |
|
|
209 | aio_open $pathname, $flags, $mode, $callback->($fh) |
|
|
210 | aio_close $fh, $callback->($status) |
|
|
211 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
|
|
212 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
|
|
213 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
|
|
214 | aio_readahead $fh,$offset,$length, $callback->($retval) |
|
|
215 | aio_stat $fh_or_path, $callback->($status) |
|
|
216 | aio_lstat $fh, $callback->($status) |
|
|
217 | aio_statvfs $fh_or_path, $callback->($statvfs) |
|
|
218 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
|
|
219 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
220 | aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
221 | aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
222 | aio_unlink $pathname, $callback->($status) |
|
|
223 | aio_mknod $path, $mode, $dev, $callback->($status) |
|
|
224 | aio_link $srcpath, $dstpath, $callback->($status) |
|
|
225 | aio_symlink $srcpath, $dstpath, $callback->($status) |
|
|
226 | aio_readlink $path, $callback->($link) |
|
|
227 | aio_rename $srcpath, $dstpath, $callback->($status) |
|
|
228 | aio_mkdir $pathname, $mode, $callback->($status) |
|
|
229 | aio_rmdir $pathname, $callback->($status) |
|
|
230 | aio_readdir $pathname, $callback->($entries) |
|
|
231 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
|
|
232 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
|
|
233 | IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN |
|
|
234 | aio_load $path, $data, $callback->($status) |
|
|
235 | aio_copy $srcpath, $dstpath, $callback->($status) |
|
|
236 | aio_move $srcpath, $dstpath, $callback->($status) |
|
|
237 | aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
|
|
238 | aio_rmtree $path, $callback->($status) |
|
|
239 | aio_sync $callback->($status) |
|
|
240 | aio_fsync $fh, $callback->($status) |
|
|
241 | aio_fdatasync $fh, $callback->($status) |
|
|
242 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
|
|
243 | aio_pathsync $path, $callback->($status) |
|
|
244 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
245 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
246 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
|
|
247 | aio_mlockall $flags, $callback->($status) |
|
|
248 | aio_group $callback->(...) |
|
|
249 | aio_nop $callback->() |
|
|
250 | |
|
|
251 | $prev_pri = aioreq_pri [$pri] |
|
|
252 | aioreq_nice $pri_adjust |
|
|
253 | |
|
|
254 | IO::AIO::poll_wait |
|
|
255 | IO::AIO::poll_cb |
|
|
256 | IO::AIO::poll |
|
|
257 | IO::AIO::flush |
|
|
258 | IO::AIO::max_poll_reqs $nreqs |
|
|
259 | IO::AIO::max_poll_time $seconds |
|
|
260 | IO::AIO::min_parallel $nthreads |
|
|
261 | IO::AIO::max_parallel $nthreads |
|
|
262 | IO::AIO::max_idle $nthreads |
|
|
263 | IO::AIO::max_outstanding $maxreqs |
|
|
264 | IO::AIO::nreqs |
|
|
265 | IO::AIO::nready |
|
|
266 | IO::AIO::npending |
|
|
267 | |
|
|
268 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
|
|
269 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
270 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
|
|
271 | IO::AIO::munlockall |
221 | |
272 | |
222 | =head2 AIO REQUEST FUNCTIONS |
273 | =head2 AIO REQUEST FUNCTIONS |
223 | |
274 | |
224 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
275 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
225 | with the same name (sans C<aio_>). The arguments are similar or identical, |
276 | with the same name (sans C<aio_>). The arguments are similar or identical, |
… | |
… | |
305 | by the umask in effect then the request is being executed, so better never |
356 | by the umask in effect then the request is being executed, so better never |
306 | change the umask. |
357 | change the umask. |
307 | |
358 | |
308 | Example: |
359 | Example: |
309 | |
360 | |
310 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
361 | aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub { |
311 | if ($_[0]) { |
362 | if ($_[0]) { |
312 | print "open successful, fh is $_[0]\n"; |
363 | print "open successful, fh is $_[0]\n"; |
313 | ... |
364 | ... |
314 | } else { |
365 | } else { |
315 | die "open failed: $!\n"; |
366 | die "open failed: $!\n"; |
… | |
… | |
336 | |
387 | |
337 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
388 | =item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
338 | |
389 | |
339 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
390 | =item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
340 | |
391 | |
341 | Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> |
392 | Reads or writes C<$length> bytes from or to the specified C<$fh> and |
342 | into the scalar given by C<$data> and offset C<$dataoffset> and calls the |
393 | C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> |
343 | callback without the actual number of bytes read (or -1 on error, just |
394 | and calls the callback without the actual number of bytes read (or -1 on |
344 | like the syscall). |
395 | error, just like the syscall). |
|
|
396 | |
|
|
397 | C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to |
|
|
398 | offset plus the actual number of bytes read. |
345 | |
399 | |
346 | If C<$offset> is undefined, then the current file descriptor offset will |
400 | If C<$offset> is undefined, then the current file descriptor offset will |
347 | be used (and updated), otherwise the file descriptor offset will not be |
401 | be used (and updated), otherwise the file descriptor offset will not be |
348 | changed by these calls. |
402 | changed by these calls. |
349 | |
403 | |
350 | If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. |
404 | If C<$length> is undefined in C<aio_write>, use the remaining length of |
|
|
405 | C<$data>. |
351 | |
406 | |
352 | If C<$dataoffset> is less than zero, it will be counted from the end of |
407 | If C<$dataoffset> is less than zero, it will be counted from the end of |
353 | C<$data>. |
408 | C<$data>. |
354 | |
409 | |
355 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
410 | The C<$data> scalar I<MUST NOT> be modified in any way while the request |
… | |
… | |
373 | than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each |
428 | than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each |
374 | other. |
429 | other. |
375 | |
430 | |
376 | This call tries to make use of a native C<sendfile> syscall to provide |
431 | This call tries to make use of a native C<sendfile> syscall to provide |
377 | zero-copy operation. For this to work, C<$out_fh> should refer to a |
432 | zero-copy operation. For this to work, C<$out_fh> should refer to a |
378 | socket, and C<$in_fh> should refer to mmap'able file. |
433 | socket, and C<$in_fh> should refer to an mmap'able file. |
379 | |
434 | |
380 | If the native sendfile call fails or is not implemented, it will be |
435 | 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>, |
381 | emulated, so you can call C<aio_sendfile> on any type of filehandle |
437 | it will be emulated, so you can call C<aio_sendfile> on any type of |
382 | regardless of the limitations of the operating system. |
438 | filehandle regardless of the limitations of the operating system. |
383 | |
439 | |
384 | Please note, however, that C<aio_sendfile> can read more bytes from |
440 | Please note, however, that C<aio_sendfile> can read more bytes from |
385 | C<$in_fh> than are written, and there is no way to find out how many |
441 | C<$in_fh> than are written, and there is no way to find out how many |
386 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
442 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
387 | provides the number of bytes written to C<$out_fh>. Only if the result |
443 | provides the number of bytes written to C<$out_fh>. Only if the result |
… | |
… | |
425 | $_[0] and die "stat failed: $!"; |
481 | $_[0] and die "stat failed: $!"; |
426 | print "size is ", -s _, "\n"; |
482 | print "size is ", -s _, "\n"; |
427 | }; |
483 | }; |
428 | |
484 | |
429 | |
485 | |
|
|
486 | =item aio_statvfs $fh_or_path, $callback->($statvfs) |
|
|
487 | |
|
|
488 | Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on |
|
|
489 | whether a file handle or path was passed. |
|
|
490 | |
|
|
491 | On success, the callback is passed a hash reference with the following |
|
|
492 | members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>, |
|
|
493 | C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef> |
|
|
494 | is passed. |
|
|
495 | |
|
|
496 | The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and |
|
|
497 | C<ST_NOSUID>. |
|
|
498 | |
|
|
499 | The following non-POSIX IO::AIO::ST_* flag masks are defined to |
|
|
500 | their correct value when available, or to C<0> on systems that do |
|
|
501 | not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>, |
|
|
502 | C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>, |
|
|
503 | C<ST_NODIRATIME> and C<ST_RELATIME>. |
|
|
504 | |
|
|
505 | Example: stat C</wd> and dump out the data if successful. |
|
|
506 | |
|
|
507 | aio_statvfs "/wd", sub { |
|
|
508 | my $f = $_[0] |
|
|
509 | or die "statvfs: $!"; |
|
|
510 | |
|
|
511 | use Data::Dumper; |
|
|
512 | say Dumper $f; |
|
|
513 | }; |
|
|
514 | |
|
|
515 | # result: |
|
|
516 | { |
|
|
517 | bsize => 1024, |
|
|
518 | bfree => 4333064312, |
|
|
519 | blocks => 10253828096, |
|
|
520 | files => 2050765568, |
|
|
521 | flag => 4096, |
|
|
522 | favail => 2042092649, |
|
|
523 | bavail => 4333064312, |
|
|
524 | ffree => 2042092649, |
|
|
525 | namemax => 255, |
|
|
526 | frsize => 1024, |
|
|
527 | fsid => 1810 |
|
|
528 | } |
|
|
529 | |
|
|
530 | |
430 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
531 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
431 | |
532 | |
432 | Works like perl's C<utime> function (including the special case of $atime |
533 | Works like perl's C<utime> function (including the special case of $atime |
433 | and $mtime being undef). Fractional times are supported if the underlying |
534 | and $mtime being undef). Fractional times are supported if the underlying |
434 | syscalls support them. |
535 | syscalls support them. |
… | |
… | |
527 | |
628 | |
528 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
629 | Unlike the POSIX call of the same name, C<aio_readdir> reads an entire |
529 | directory (i.e. opendir + readdir + closedir). The entries will not be |
630 | directory (i.e. opendir + readdir + closedir). The entries will not be |
530 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
631 | sorted, and will B<NOT> include the C<.> and C<..> entries. |
531 | |
632 | |
532 | The callback a single argument which is either C<undef> or an array-ref |
633 | The callback is passed a single argument which is either C<undef> or an |
533 | with the filenames. |
634 | array-ref with the filenames. |
|
|
635 | |
|
|
636 | |
|
|
637 | =item aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
|
|
638 | |
|
|
639 | Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune |
|
|
640 | behaviour and output format. In case of an error, C<$entries> will be |
|
|
641 | C<undef>. |
|
|
642 | |
|
|
643 | The flags are a combination of the following constants, ORed together (the |
|
|
644 | flags will also be passed to the callback, possibly modified): |
|
|
645 | |
|
|
646 | =over 4 |
|
|
647 | |
|
|
648 | =item IO::AIO::READDIR_DENTS |
|
|
649 | |
|
|
650 | When this flag is off, then the callback gets an arrayref with of names |
|
|
651 | only (as with C<aio_readdir>), otherwise it gets an arrayref with |
|
|
652 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
|
|
653 | entry in more detail. |
|
|
654 | |
|
|
655 | C<$name> is the name of the entry. |
|
|
656 | |
|
|
657 | C<$type> is one of the C<IO::AIO::DT_xxx> constants: |
|
|
658 | |
|
|
659 | C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>, |
|
|
660 | C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>, |
|
|
661 | C<IO::AIO::DT_WHT>. |
|
|
662 | |
|
|
663 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to |
|
|
664 | know, you have to run stat yourself. Also, for speed reasons, the C<$type> |
|
|
665 | scalars are read-only: you can not modify them. |
|
|
666 | |
|
|
667 | C<$inode> is the inode number (which might not be exact on systems with 64 |
|
|
668 | bit inode numbers and 32 bit perls). This field has unspecified content on |
|
|
669 | systems that do not deliver the inode information. |
|
|
670 | |
|
|
671 | =item IO::AIO::READDIR_DIRS_FIRST |
|
|
672 | |
|
|
673 | 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 |
|
|
675 | find directories, or you want to find all directories while avoiding to |
|
|
676 | stat() each entry. |
|
|
677 | |
|
|
678 | If the system returns type information in readdir, then this is used |
|
|
679 | to find directories directly. Otherwise, likely directories are files |
|
|
680 | beginning with ".", or otherwise files with no dots, of which files with |
|
|
681 | short names are tried first. |
|
|
682 | |
|
|
683 | =item IO::AIO::READDIR_STAT_ORDER |
|
|
684 | |
|
|
685 | When this flag is set, then the names will be returned in an order |
|
|
686 | suitable for stat()'ing each one. That is, when you plan to stat() |
|
|
687 | all files in the given directory, then the returned order will likely |
|
|
688 | be fastest. |
|
|
689 | |
|
|
690 | If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then |
|
|
691 | the likely dirs come first, resulting in a less optimal stat order. |
|
|
692 | |
|
|
693 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
|
|
694 | |
|
|
695 | 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 |
|
|
697 | C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all |
|
|
698 | C<$type>'s are known, which can be used to speed up some algorithms. |
|
|
699 | |
|
|
700 | =back |
534 | |
701 | |
535 | |
702 | |
536 | =item aio_load $path, $data, $callback->($status) |
703 | =item aio_load $path, $data, $callback->($status) |
537 | |
704 | |
538 | This is a composite request that tries to fully load the given file into |
705 | This is a composite request that tries to fully load the given file into |
… | |
… | |
563 | |
730 | |
564 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
731 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
565 | |
732 | |
566 | Try to copy the I<file> (directories not supported as either source or |
733 | Try to copy the I<file> (directories not supported as either source or |
567 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
734 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
568 | the C<0> (error) or C<-1> ok. |
735 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
569 | |
736 | |
570 | This is a composite request that creates the destination file with |
737 | This is a composite request that creates the destination file with |
571 | mode 0200 and copies the contents of the source file into it using |
738 | mode 0200 and copies the contents of the source file into it using |
572 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
739 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
573 | uid/gid, in that order. |
740 | uid/gid, in that order. |
… | |
… | |
585 | my $grp = aio_group $cb; |
752 | my $grp = aio_group $cb; |
586 | |
753 | |
587 | aioreq_pri $pri; |
754 | aioreq_pri $pri; |
588 | add $grp aio_open $src, O_RDONLY, 0, sub { |
755 | add $grp aio_open $src, O_RDONLY, 0, sub { |
589 | if (my $src_fh = $_[0]) { |
756 | if (my $src_fh = $_[0]) { |
590 | my @stat = stat $src_fh; |
757 | my @stat = stat $src_fh; # hmm, might block over nfs? |
591 | |
758 | |
592 | aioreq_pri $pri; |
759 | aioreq_pri $pri; |
593 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
760 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
594 | if (my $dst_fh = $_[0]) { |
761 | if (my $dst_fh = $_[0]) { |
595 | aioreq_pri $pri; |
762 | aioreq_pri $pri; |
596 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
763 | add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { |
597 | if ($_[0] == $stat[7]) { |
764 | if ($_[0] == $stat[7]) { |
598 | $grp->result (0); |
765 | $grp->result (0); |
599 | close $src_fh; |
766 | close $src_fh; |
600 | |
767 | |
601 | # those should not normally block. should. should. |
768 | my $ch = sub { |
602 | utime $stat[8], $stat[9], $dst; |
769 | aioreq_pri $pri; |
603 | chmod $stat[2] & 07777, $dst_fh; |
770 | add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub { |
604 | chown $stat[4], $stat[5], $dst_fh; |
771 | aioreq_pri $pri; |
|
|
772 | add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub { |
|
|
773 | aioreq_pri $pri; |
|
|
774 | add $grp aio_close $dst_fh; |
|
|
775 | } |
|
|
776 | }; |
|
|
777 | }; |
605 | |
778 | |
606 | aioreq_pri $pri; |
779 | aioreq_pri $pri; |
607 | add $grp aio_close $dst_fh; |
780 | add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub { |
|
|
781 | if ($_[0] < 0 && $! == ENOSYS) { |
|
|
782 | aioreq_pri $pri; |
|
|
783 | add $grp aio_utime $dst, $stat[8], $stat[9], $ch; |
|
|
784 | } else { |
|
|
785 | $ch->(); |
|
|
786 | } |
|
|
787 | }; |
608 | } else { |
788 | } else { |
609 | $grp->result (-1); |
789 | $grp->result (-1); |
610 | close $src_fh; |
790 | close $src_fh; |
611 | close $dst_fh; |
791 | close $dst_fh; |
612 | |
792 | |
… | |
… | |
629 | |
809 | |
630 | =item aio_move $srcpath, $dstpath, $callback->($status) |
810 | =item aio_move $srcpath, $dstpath, $callback->($status) |
631 | |
811 | |
632 | Try to move the I<file> (directories not supported as either source or |
812 | Try to move the I<file> (directories not supported as either source or |
633 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
813 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
634 | the C<0> (error) or C<-1> ok. |
814 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
635 | |
815 | |
636 | This is a composite request that tries to rename(2) the file first; if |
816 | This is a composite request that tries to rename(2) the file first; if |
637 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
817 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
638 | that is successful, unlinks the C<$srcpath>. |
818 | that is successful, unlinks the C<$srcpath>. |
639 | |
819 | |
… | |
… | |
690 | |
870 | |
691 | Implementation notes. |
871 | Implementation notes. |
692 | |
872 | |
693 | The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. |
873 | The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. |
694 | |
874 | |
|
|
875 | If readdir returns file type information, then this is used directly to |
|
|
876 | find directories. |
|
|
877 | |
695 | After reading the directory, the modification time, size etc. of the |
878 | Otherwise, after reading the directory, the modification time, size etc. |
696 | directory before and after the readdir is checked, and if they match (and |
879 | of the directory before and after the readdir is checked, and if they |
697 | isn't the current time), the link count will be used to decide how many |
880 | match (and isn't the current time), the link count will be used to decide |
698 | entries are directories (if >= 2). Otherwise, no knowledge of the number |
881 | how many entries are directories (if >= 2). Otherwise, no knowledge of the |
699 | of subdirectories will be assumed. |
882 | number of subdirectories will be assumed. |
700 | |
883 | |
701 | Then entries will be sorted into likely directories (everything without |
884 | Then entries will be sorted into likely directories a non-initial dot |
702 | a non-initial dot currently) and likely non-directories (everything |
885 | currently) and likely non-directories (see C<aio_readdirx>). Then every |
703 | else). Then every entry plus an appended C</.> will be C<stat>'ed, |
886 | entry plus an appended C</.> will be C<stat>'ed, likely directories first, |
704 | likely directories first. If that succeeds, it assumes that the entry |
887 | in order of their inode numbers. If that succeeds, it assumes that the |
705 | is a directory or a symlink to directory (which will be checked |
888 | entry is a directory or a symlink to directory (which will be checked |
706 | seperately). This is often faster than stat'ing the entry itself because |
889 | seperately). This is often faster than stat'ing the entry itself because |
707 | filesystems might detect the type of the entry without reading the inode |
890 | filesystems might detect the type of the entry without reading the inode |
708 | data (e.g. ext2fs filetype feature). |
891 | data (e.g. ext2fs filetype feature), even on systems that cannot return |
|
|
892 | the filetype information on readdir. |
709 | |
893 | |
710 | If the known number of directories (link count - 2) has been reached, the |
894 | If the known number of directories (link count - 2) has been reached, the |
711 | rest of the entries is assumed to be non-directories. |
895 | rest of the entries is assumed to be non-directories. |
712 | |
896 | |
713 | This only works with certainty on POSIX (= UNIX) filesystems, which |
897 | This only works with certainty on POSIX (= UNIX) filesystems, which |
… | |
… | |
735 | my $now = time; |
919 | my $now = time; |
736 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
920 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
737 | |
921 | |
738 | # read the directory entries |
922 | # read the directory entries |
739 | aioreq_pri $pri; |
923 | aioreq_pri $pri; |
740 | add $grp aio_readdir $path, sub { |
924 | add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { |
741 | my $entries = shift |
925 | my $entries = shift |
742 | or return $grp->result (); |
926 | or return $grp->result (); |
743 | |
927 | |
744 | # stat the dir another time |
928 | # stat the dir another time |
745 | aioreq_pri $pri; |
929 | aioreq_pri $pri; |
… | |
… | |
751 | # take the slow route if anything looks fishy |
935 | # take the slow route if anything looks fishy |
752 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
936 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
753 | $ndirs = -1; |
937 | $ndirs = -1; |
754 | } else { |
938 | } else { |
755 | # if nlink == 2, we are finished |
939 | # if nlink == 2, we are finished |
756 | # on non-posix-fs's, we rely on nlink < 2 |
940 | # for non-posix-fs's, we rely on nlink < 2 |
757 | $ndirs = (stat _)[3] - 2 |
941 | $ndirs = (stat _)[3] - 2 |
758 | or return $grp->result ([], $entries); |
942 | or return $grp->result ([], $entries); |
759 | } |
943 | } |
760 | |
944 | |
761 | # sort into likely dirs and likely nondirs |
|
|
762 | # dirs == files without ".", short entries first |
|
|
763 | $entries = [map $_->[0], |
|
|
764 | sort { $b->[1] cmp $a->[1] } |
|
|
765 | map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length], |
|
|
766 | @$entries]; |
|
|
767 | |
|
|
768 | my (@dirs, @nondirs); |
945 | my (@dirs, @nondirs); |
769 | |
946 | |
770 | my $statgrp = add $grp aio_group sub { |
947 | my $statgrp = add $grp aio_group sub { |
771 | $grp->result (\@dirs, \@nondirs); |
948 | $grp->result (\@dirs, \@nondirs); |
772 | }; |
949 | }; |
773 | |
950 | |
774 | limit $statgrp $maxreq; |
951 | limit $statgrp $maxreq; |
775 | feed $statgrp sub { |
952 | feed $statgrp sub { |
776 | return unless @$entries; |
953 | return unless @$entries; |
777 | my $entry = pop @$entries; |
954 | my $entry = shift @$entries; |
778 | |
955 | |
779 | aioreq_pri $pri; |
956 | aioreq_pri $pri; |
780 | add $statgrp aio_stat "$path/$entry/.", sub { |
957 | add $statgrp aio_stat "$path/$entry/.", sub { |
781 | if ($_[0] < 0) { |
958 | if ($_[0] < 0) { |
782 | push @nondirs, $entry; |
959 | push @nondirs, $entry; |
… | |
… | |
855 | callback with the fdatasync result code. |
1032 | callback with the fdatasync result code. |
856 | |
1033 | |
857 | If this call isn't available because your OS lacks it or it couldn't be |
1034 | If this call isn't available because your OS lacks it or it couldn't be |
858 | detected, it will be emulated by calling C<fsync> instead. |
1035 | detected, it will be emulated by calling C<fsync> instead. |
859 | |
1036 | |
|
|
1037 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
|
|
1038 | |
|
|
1039 | 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 |
|
|
1041 | sync_file_range call. If sync_file_range is not available or it returns |
|
|
1042 | ENOSYS, then fdatasync or fsync is being substituted. |
|
|
1043 | |
|
|
1044 | C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, |
|
|
1045 | C<IO::AIO::SYNC_FILE_RANGE_WRITE> and |
|
|
1046 | C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range |
|
|
1047 | manpage for details. |
|
|
1048 | |
860 | =item aio_pathsync $path, $callback->($status) |
1049 | =item aio_pathsync $path, $callback->($status) |
861 | |
1050 | |
862 | This request tries to open, fsync and close the given path. This is a |
1051 | This request tries to open, fsync and close the given path. This is a |
863 | composite request intended to sync directories after directory operations |
1052 | composite request intended to sync directories after directory operations |
864 | (E.g. rename). This might not work on all operating systems or have any |
1053 | (E.g. rename). This might not work on all operating systems or have any |
865 | specific effect, but usually it makes sure that directory changes get |
1054 | specific effect, but usually it makes sure that directory changes get |
866 | written to disc. It works for anything that can be opened for read-only, |
1055 | written to disc. It works for anything that can be opened for read-only, |
867 | not just directories. |
1056 | not just directories. |
|
|
1057 | |
|
|
1058 | Future versions of this function might fall back to other methods when |
|
|
1059 | C<fsync> on the directory fails (such as calling C<sync>). |
868 | |
1060 | |
869 | Passes C<0> when everything went ok, and C<-1> on error. |
1061 | Passes C<0> when everything went ok, and C<-1> on error. |
870 | |
1062 | |
871 | =cut |
1063 | =cut |
872 | |
1064 | |
… | |
… | |
893 | }; |
1085 | }; |
894 | |
1086 | |
895 | $grp |
1087 | $grp |
896 | } |
1088 | } |
897 | |
1089 | |
|
|
1090 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
1091 | |
|
|
1092 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
|
|
1093 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
|
|
1094 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
|
|
1095 | scalar must only be modified in-place while an aio operation is pending on |
|
|
1096 | it). |
|
|
1097 | |
|
|
1098 | It calls the C<msync> function of your OS, if available, with the memory |
|
|
1099 | area starting at C<$offset> in the string and ending C<$length> bytes |
|
|
1100 | later. If C<$length> is negative, counts from the end, and if C<$length> |
|
|
1101 | is C<undef>, then it goes till the end of the string. The flags can be |
|
|
1102 | a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and |
|
|
1103 | C<IO::AIO::MS_SYNC>. |
|
|
1104 | |
|
|
1105 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
1106 | |
|
|
1107 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
|
|
1108 | scalars. |
|
|
1109 | |
|
|
1110 | It touches (reads or writes) all memory pages in the specified |
|
|
1111 | range inside the scalar. All caveats and parameters are the same |
|
|
1112 | as for C<aio_msync>, above, except for flags, which must be either |
|
|
1113 | C<0> (which reads all pages and ensures they are instantiated) or |
|
|
1114 | C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and |
|
|
1115 | writing an octet from it, which dirties the page). |
|
|
1116 | |
|
|
1117 | =item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
|
|
1118 | |
|
|
1119 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
|
|
1120 | scalars. |
|
|
1121 | |
|
|
1122 | It reads in all the pages of the underlying storage into memory (if any) |
|
|
1123 | and locks them, so they are not getting swapped/paged out or removed. |
|
|
1124 | |
|
|
1125 | If C<$length> is undefined, then the scalar will be locked till the end. |
|
|
1126 | |
|
|
1127 | On systems that do not implement C<mlock>, this function returns C<-1> |
|
|
1128 | and sets errno to C<ENOSYS>. |
|
|
1129 | |
|
|
1130 | Note that the corresponding C<munlock> is synchronous and is |
|
|
1131 | documented under L<MISCELLANEOUS FUNCTIONS>. |
|
|
1132 | |
|
|
1133 | Example: open a file, mmap and mlock it - both will be undone when |
|
|
1134 | C<$data> gets destroyed. |
|
|
1135 | |
|
|
1136 | open my $fh, "<", $path or die "$path: $!"; |
|
|
1137 | my $data; |
|
|
1138 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
|
|
1139 | aio_mlock $data; # mlock in background |
|
|
1140 | |
|
|
1141 | =item aio_mlockall $flags, $callback->($status) |
|
|
1142 | |
|
|
1143 | Calls the C<mlockall> function with the given C<$flags> (a combination of |
|
|
1144 | C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>). |
|
|
1145 | |
|
|
1146 | On systems that do not implement C<mlockall>, this function returns C<-1> |
|
|
1147 | and sets errno to C<ENOSYS>. |
|
|
1148 | |
|
|
1149 | Note that the corresponding C<munlockall> is synchronous and is |
|
|
1150 | documented under L<MISCELLANEOUS FUNCTIONS>. |
|
|
1151 | |
|
|
1152 | Example: asynchronously lock all current and future pages into memory. |
|
|
1153 | |
|
|
1154 | aio_mlockall IO::AIO::MCL_FUTURE; |
|
|
1155 | |
898 | =item aio_group $callback->(...) |
1156 | =item aio_group $callback->(...) |
899 | |
1157 | |
900 | This is a very special aio request: Instead of doing something, it is a |
1158 | This is a very special aio request: Instead of doing something, it is a |
901 | container for other aio requests, which is useful if you want to bundle |
1159 | container for other aio requests, which is useful if you want to bundle |
902 | many requests into a single, composite, request with a definite callback |
1160 | many requests into a single, composite, request with a definite callback |
… | |
… | |
951 | =item cancel $req |
1209 | =item cancel $req |
952 | |
1210 | |
953 | Cancels the request, if possible. Has the effect of skipping execution |
1211 | Cancels the request, if possible. Has the effect of skipping execution |
954 | when entering the B<execute> state and skipping calling the callback when |
1212 | when entering the B<execute> state and skipping calling the callback when |
955 | entering the the B<result> state, but will leave the request otherwise |
1213 | entering the the B<result> state, but will leave the request otherwise |
956 | untouched. That means that requests that currently execute will not be |
1214 | untouched (with the exception of readdir). That means that requests that |
957 | stopped and resources held by the request will not be freed prematurely. |
1215 | currently execute will not be stopped and resources held by the request |
|
|
1216 | will not be freed prematurely. |
958 | |
1217 | |
959 | =item cb $req $callback->(...) |
1218 | =item cb $req $callback->(...) |
960 | |
1219 | |
961 | Replace (or simply set) the callback registered to the request. |
1220 | Replace (or simply set) the callback registered to the request. |
962 | |
1221 | |
… | |
… | |
1036 | =item $grp->cancel_subs |
1295 | =item $grp->cancel_subs |
1037 | |
1296 | |
1038 | Cancel all subrequests and clears any feeder, but not the group request |
1297 | Cancel all subrequests and clears any feeder, but not the group request |
1039 | itself. Useful when you queued a lot of events but got a result early. |
1298 | itself. Useful when you queued a lot of events but got a result early. |
1040 | |
1299 | |
|
|
1300 | The group request will finish normally (you cannot add requests to the |
|
|
1301 | group). |
|
|
1302 | |
1041 | =item $grp->result (...) |
1303 | =item $grp->result (...) |
1042 | |
1304 | |
1043 | Set the result value(s) that will be passed to the group callback when all |
1305 | Set the result value(s) that will be passed to the group callback when all |
1044 | subrequests have finished and set the groups errno to the current value |
1306 | subrequests have finished and set the groups errno to the current value |
1045 | of errno (just like calling C<errno> without an error number). By default, |
1307 | of errno (just like calling C<errno> without an error number). By default, |
… | |
… | |
1060 | =item feed $grp $callback->($grp) |
1322 | =item feed $grp $callback->($grp) |
1061 | |
1323 | |
1062 | Sets a feeder/generator on this group: every group can have an attached |
1324 | Sets a feeder/generator on this group: every group can have an attached |
1063 | generator that generates requests if idle. The idea behind this is that, |
1325 | generator that generates requests if idle. The idea behind this is that, |
1064 | although you could just queue as many requests as you want in a group, |
1326 | although you could just queue as many requests as you want in a group, |
1065 | this might starve other requests for a potentially long time. For |
1327 | this might starve other requests for a potentially long time. For example, |
1066 | example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> |
1328 | C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests, |
1067 | requests, delaying any later requests for a long time. |
1329 | delaying any later requests for a long time. |
1068 | |
1330 | |
1069 | To avoid this, and allow incremental generation of requests, you can |
1331 | To avoid this, and allow incremental generation of requests, you can |
1070 | instead a group and set a feeder on it that generates those requests. The |
1332 | instead a group and set a feeder on it that generates those requests. The |
1071 | feed callback will be called whenever there are few enough (see C<limit>, |
1333 | feed callback will be called whenever there are few enough (see C<limit>, |
1072 | below) requests active in the group itself and is expected to queue more |
1334 | below) requests active in the group itself and is expected to queue more |
… | |
… | |
1113 | =over 4 |
1375 | =over 4 |
1114 | |
1376 | |
1115 | =item $fileno = IO::AIO::poll_fileno |
1377 | =item $fileno = IO::AIO::poll_fileno |
1116 | |
1378 | |
1117 | Return the I<request result pipe file descriptor>. This filehandle must be |
1379 | Return the I<request result pipe file descriptor>. This filehandle must be |
1118 | polled for reading by some mechanism outside this module (e.g. Event or |
1380 | polled for reading by some mechanism outside this module (e.g. EV, Glib, |
1119 | select, see below or the SYNOPSIS). If the pipe becomes readable you have |
1381 | select and so on, see below or the SYNOPSIS). If the pipe becomes readable |
1120 | to call C<poll_cb> to check the results. |
1382 | you have to call C<poll_cb> to check the results. |
1121 | |
1383 | |
1122 | See C<poll_cb> for an example. |
1384 | See C<poll_cb> for an example. |
1123 | |
1385 | |
1124 | =item IO::AIO::poll_cb |
1386 | =item IO::AIO::poll_cb |
1125 | |
1387 | |
… | |
… | |
1132 | If not all requests were processed for whatever reason, the filehandle |
1394 | If not all requests were processed for whatever reason, the filehandle |
1133 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1395 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1134 | do anything special to have it called later. |
1396 | do anything special to have it called later. |
1135 | |
1397 | |
1136 | Example: Install an Event watcher that automatically calls |
1398 | Example: Install an Event watcher that automatically calls |
1137 | IO::AIO::poll_cb with high priority: |
1399 | IO::AIO::poll_cb with high priority (more examples can be found in the |
|
|
1400 | SYNOPSIS section, at the top of this document): |
1138 | |
1401 | |
1139 | Event->io (fd => IO::AIO::poll_fileno, |
1402 | Event->io (fd => IO::AIO::poll_fileno, |
1140 | poll => 'r', async => 1, |
1403 | poll => 'r', async => 1, |
1141 | cb => \&IO::AIO::poll_cb); |
1404 | cb => \&IO::AIO::poll_cb); |
|
|
1405 | |
|
|
1406 | =item IO::AIO::poll_wait |
|
|
1407 | |
|
|
1408 | If there are any outstanding requests and none of them in the result |
|
|
1409 | phase, wait till the result filehandle becomes ready for reading (simply |
|
|
1410 | does a C<select> on the filehandle. This is useful if you want to |
|
|
1411 | synchronously wait for some requests to finish). |
|
|
1412 | |
|
|
1413 | See C<nreqs> for an example. |
|
|
1414 | |
|
|
1415 | =item IO::AIO::poll |
|
|
1416 | |
|
|
1417 | Waits until some requests have been handled. |
|
|
1418 | |
|
|
1419 | Returns the number of requests processed, but is otherwise strictly |
|
|
1420 | equivalent to: |
|
|
1421 | |
|
|
1422 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
1423 | |
|
|
1424 | =item IO::AIO::flush |
|
|
1425 | |
|
|
1426 | Wait till all outstanding AIO requests have been handled. |
|
|
1427 | |
|
|
1428 | Strictly equivalent to: |
|
|
1429 | |
|
|
1430 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
1431 | while IO::AIO::nreqs; |
1142 | |
1432 | |
1143 | =item IO::AIO::max_poll_reqs $nreqs |
1433 | =item IO::AIO::max_poll_reqs $nreqs |
1144 | |
1434 | |
1145 | =item IO::AIO::max_poll_time $seconds |
1435 | =item IO::AIO::max_poll_time $seconds |
1146 | |
1436 | |
… | |
… | |
1171 | # use a low priority so other tasks have priority |
1461 | # use a low priority so other tasks have priority |
1172 | Event->io (fd => IO::AIO::poll_fileno, |
1462 | Event->io (fd => IO::AIO::poll_fileno, |
1173 | poll => 'r', nice => 1, |
1463 | poll => 'r', nice => 1, |
1174 | cb => &IO::AIO::poll_cb); |
1464 | cb => &IO::AIO::poll_cb); |
1175 | |
1465 | |
1176 | =item IO::AIO::poll_wait |
|
|
1177 | |
|
|
1178 | If there are any outstanding requests and none of them in the result |
|
|
1179 | phase, wait till the result filehandle becomes ready for reading (simply |
|
|
1180 | does a C<select> on the filehandle. This is useful if you want to |
|
|
1181 | synchronously wait for some requests to finish). |
|
|
1182 | |
|
|
1183 | See C<nreqs> for an example. |
|
|
1184 | |
|
|
1185 | =item IO::AIO::poll |
|
|
1186 | |
|
|
1187 | Waits until some requests have been handled. |
|
|
1188 | |
|
|
1189 | Returns the number of requests processed, but is otherwise strictly |
|
|
1190 | equivalent to: |
|
|
1191 | |
|
|
1192 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
1193 | |
|
|
1194 | =item IO::AIO::flush |
|
|
1195 | |
|
|
1196 | Wait till all outstanding AIO requests have been handled. |
|
|
1197 | |
|
|
1198 | Strictly equivalent to: |
|
|
1199 | |
|
|
1200 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
1201 | while IO::AIO::nreqs; |
|
|
1202 | |
|
|
1203 | =back |
1466 | =back |
1204 | |
1467 | |
1205 | =head3 CONTROLLING THE NUMBER OF THREADS |
1468 | =head3 CONTROLLING THE NUMBER OF THREADS |
1206 | |
1469 | |
1207 | =over |
1470 | =over |
… | |
… | |
1299 | Returns the number of requests currently in the pending state (executed, |
1562 | Returns the number of requests currently in the pending state (executed, |
1300 | but not yet processed by poll_cb). |
1563 | but not yet processed by poll_cb). |
1301 | |
1564 | |
1302 | =back |
1565 | =back |
1303 | |
1566 | |
|
|
1567 | =head3 MISCELLANEOUS FUNCTIONS |
|
|
1568 | |
|
|
1569 | IO::AIO implements some functions that might be useful, but are not |
|
|
1570 | asynchronous. |
|
|
1571 | |
|
|
1572 | =over 4 |
|
|
1573 | |
|
|
1574 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
|
|
1575 | |
|
|
1576 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
|
|
1577 | but is blocking (this makes most sense if you know the input data is |
|
|
1578 | likely cached already and the output filehandle is set to non-blocking |
|
|
1579 | operations). |
|
|
1580 | |
|
|
1581 | Returns the number of bytes copied, or C<-1> on error. |
|
|
1582 | |
|
|
1583 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
1584 | |
|
|
1585 | Simply calls the C<posix_fadvise> function (see it's |
|
|
1586 | manpage for details). The following advice constants are |
|
|
1587 | avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
|
|
1588 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
|
|
1589 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
|
|
1590 | |
|
|
1591 | On systems that do not implement C<posix_fadvise>, this function returns |
|
|
1592 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
|
|
1593 | |
|
|
1594 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
|
|
1595 | |
|
|
1596 | Memory-maps a file (or anonymous memory range) and attaches it to the |
|
|
1597 | given C<$scalar>, which will act like a string scalar. |
|
|
1598 | |
|
|
1599 | 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 |
|
|
1601 | or searching it with regexes and so on. |
|
|
1602 | |
|
|
1603 | Anything else is unsafe and will, at best, result in memory leaks. |
|
|
1604 | |
|
|
1605 | The memory map associated with the C<$scalar> is automatically removed |
|
|
1606 | when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or |
|
|
1607 | C<IO::AIO::munmap> functions are called. |
|
|
1608 | |
|
|
1609 | This calls the C<mmap>(2) function internally. See your system's manual |
|
|
1610 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
|
|
1611 | |
|
|
1612 | The C<$length> must be larger than zero and smaller than the actual |
|
|
1613 | filesize. |
|
|
1614 | |
|
|
1615 | C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, |
|
|
1616 | C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, |
|
|
1617 | |
|
|
1618 | C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or |
|
|
1619 | C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when |
|
|
1620 | not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS> |
|
|
1621 | (which is set to C<MAP_ANON> if your system only provides this |
|
|
1622 | constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>, |
|
|
1623 | C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or |
|
|
1624 | C<IO::AIO::MAP_NONBLOCK> |
|
|
1625 | |
|
|
1626 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
|
|
1627 | |
|
|
1628 | C<$offset> is the offset from the start of the file - it generally must be |
|
|
1629 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
|
|
1630 | |
|
|
1631 | Example: |
|
|
1632 | |
|
|
1633 | use Digest::MD5; |
|
|
1634 | use IO::AIO; |
|
|
1635 | |
|
|
1636 | open my $fh, "<verybigfile" |
|
|
1637 | or die "$!"; |
|
|
1638 | |
|
|
1639 | IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh |
|
|
1640 | or die "verybigfile: $!"; |
|
|
1641 | |
|
|
1642 | my $fast_md5 = md5 $data; |
|
|
1643 | |
|
|
1644 | =item IO::AIO::munmap $scalar |
|
|
1645 | |
|
|
1646 | Removes a previous mmap and undefines the C<$scalar>. |
|
|
1647 | |
|
|
1648 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
|
|
1649 | |
|
|
1650 | Calls the C<munlock> function, undoing the effects of a previous |
|
|
1651 | C<aio_mlock> call (see its description for details). |
|
|
1652 | |
|
|
1653 | =item IO::AIO::munlockall |
|
|
1654 | |
|
|
1655 | Calls the C<munlockall> function. |
|
|
1656 | |
|
|
1657 | On systems that do not implement C<munlockall>, this function returns |
|
|
1658 | ENOSYS, otherwise the return value of C<munlockall>. |
|
|
1659 | |
|
|
1660 | =back |
|
|
1661 | |
1304 | =cut |
1662 | =cut |
1305 | |
1663 | |
1306 | min_parallel 8; |
1664 | min_parallel 8; |
1307 | |
1665 | |
1308 | END { flush } |
1666 | END { flush } |
1309 | |
1667 | |
1310 | 1; |
1668 | 1; |
|
|
1669 | |
|
|
1670 | =head1 EVENT LOOP INTEGRATION |
|
|
1671 | |
|
|
1672 | It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO |
|
|
1673 | automatically into many event loops: |
|
|
1674 | |
|
|
1675 | # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
|
|
1676 | use AnyEvent::AIO; |
|
|
1677 | |
|
|
1678 | You can also integrate IO::AIO manually into many event loops, here are |
|
|
1679 | some examples of how to do this: |
|
|
1680 | |
|
|
1681 | # EV integration |
|
|
1682 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
|
|
1683 | |
|
|
1684 | # Event integration |
|
|
1685 | Event->io (fd => IO::AIO::poll_fileno, |
|
|
1686 | poll => 'r', |
|
|
1687 | cb => \&IO::AIO::poll_cb); |
|
|
1688 | |
|
|
1689 | # Glib/Gtk2 integration |
|
|
1690 | add_watch Glib::IO IO::AIO::poll_fileno, |
|
|
1691 | in => sub { IO::AIO::poll_cb; 1 }; |
|
|
1692 | |
|
|
1693 | # Tk integration |
|
|
1694 | Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", |
|
|
1695 | readable => \&IO::AIO::poll_cb); |
|
|
1696 | |
|
|
1697 | # Danga::Socket integration |
|
|
1698 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
|
|
1699 | \&IO::AIO::poll_cb); |
1311 | |
1700 | |
1312 | =head2 FORK BEHAVIOUR |
1701 | =head2 FORK BEHAVIOUR |
1313 | |
1702 | |
1314 | This module should do "the right thing" when the process using it forks: |
1703 | This module should do "the right thing" when the process using it forks: |
1315 | |
1704 | |