… | |
… | |
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.22'; |
173 | our $VERSION = '4.0'; |
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 aio_readdirx |
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_realpath aio_sync |
203 | aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead |
178 | aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate |
|
|
179 | aio_pathsync aio_readahead |
204 | aio_rename aio_link aio_move aio_copy aio_group |
180 | aio_rename aio_link aio_move aio_copy aio_group |
205 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
181 | aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown |
206 | aio_chmod aio_utime aio_truncate); |
182 | aio_chmod aio_utime aio_truncate |
|
|
183 | aio_msync aio_mtouch aio_mlock aio_mlockall |
|
|
184 | aio_statvfs |
|
|
185 | aio_wd); |
207 | |
186 | |
208 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
187 | our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); |
209 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
188 | our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush |
210 | min_parallel max_parallel max_idle |
189 | min_parallel max_parallel max_idle idle_timeout |
211 | nreqs nready npending nthreads |
190 | nreqs nready npending nthreads |
212 | max_poll_time max_poll_reqs); |
191 | max_poll_time max_poll_reqs |
|
|
192 | sendfile fadvise madvise |
|
|
193 | mmap munmap munlock munlockall); |
213 | |
194 | |
214 | push @AIO_REQ, qw(aio_busy); # not exported |
195 | push @AIO_REQ, qw(aio_busy); # not exported |
215 | |
196 | |
216 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
197 | @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; |
217 | |
198 | |
218 | require XSLoader; |
199 | require XSLoader; |
219 | XSLoader::load ("IO::AIO", $VERSION); |
200 | XSLoader::load ("IO::AIO", $VERSION); |
220 | } |
201 | } |
221 | |
202 | |
222 | =head1 FUNCTIONS |
203 | =head1 FUNCTIONS |
|
|
204 | |
|
|
205 | =head2 QUICK OVERVIEW |
|
|
206 | |
|
|
207 | This section simply lists the prototypes of the most important functions |
|
|
208 | for quick reference. See the following sections for function-by-function |
|
|
209 | documentation. |
|
|
210 | |
|
|
211 | aio_wd $pathname, $callback->($wd) |
|
|
212 | aio_open $pathname, $flags, $mode, $callback->($fh) |
|
|
213 | aio_close $fh, $callback->($status) |
|
|
214 | aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
|
|
215 | aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) |
|
|
216 | aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) |
|
|
217 | aio_readahead $fh,$offset,$length, $callback->($retval) |
|
|
218 | aio_stat $fh_or_path, $callback->($status) |
|
|
219 | aio_lstat $fh, $callback->($status) |
|
|
220 | aio_statvfs $fh_or_path, $callback->($statvfs) |
|
|
221 | aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
|
|
222 | aio_chown $fh_or_path, $uid, $gid, $callback->($status) |
|
|
223 | aio_truncate $fh_or_path, $offset, $callback->($status) |
|
|
224 | aio_chmod $fh_or_path, $mode, $callback->($status) |
|
|
225 | aio_unlink $pathname, $callback->($status) |
|
|
226 | aio_mknod $pathname, $mode, $dev, $callback->($status) |
|
|
227 | aio_link $srcpath, $dstpath, $callback->($status) |
|
|
228 | aio_symlink $srcpath, $dstpath, $callback->($status) |
|
|
229 | aio_readlink $pathname, $callback->($link) |
|
|
230 | aio_realpath $pathname, $callback->($link) |
|
|
231 | aio_rename $srcpath, $dstpath, $callback->($status) |
|
|
232 | aio_mkdir $pathname, $mode, $callback->($status) |
|
|
233 | aio_rmdir $pathname, $callback->($status) |
|
|
234 | aio_readdir $pathname, $callback->($entries) |
|
|
235 | aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
|
|
236 | IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST |
|
|
237 | IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN |
|
|
238 | aio_load $pathname, $data, $callback->($status) |
|
|
239 | aio_copy $srcpath, $dstpath, $callback->($status) |
|
|
240 | aio_move $srcpath, $dstpath, $callback->($status) |
|
|
241 | aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
|
|
242 | aio_rmtree $pathname, $callback->($status) |
|
|
243 | aio_sync $callback->($status) |
|
|
244 | aio_syncfs $fh, $callback->($status) |
|
|
245 | aio_fsync $fh, $callback->($status) |
|
|
246 | aio_fdatasync $fh, $callback->($status) |
|
|
247 | aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
|
|
248 | aio_pathsync $pathname, $callback->($status) |
|
|
249 | aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
250 | aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
251 | aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
|
|
252 | aio_mlockall $flags, $callback->($status) |
|
|
253 | aio_group $callback->(...) |
|
|
254 | aio_nop $callback->() |
|
|
255 | |
|
|
256 | $prev_pri = aioreq_pri [$pri] |
|
|
257 | aioreq_nice $pri_adjust |
|
|
258 | |
|
|
259 | IO::AIO::poll_wait |
|
|
260 | IO::AIO::poll_cb |
|
|
261 | IO::AIO::poll |
|
|
262 | IO::AIO::flush |
|
|
263 | IO::AIO::max_poll_reqs $nreqs |
|
|
264 | IO::AIO::max_poll_time $seconds |
|
|
265 | IO::AIO::min_parallel $nthreads |
|
|
266 | IO::AIO::max_parallel $nthreads |
|
|
267 | IO::AIO::max_idle $nthreads |
|
|
268 | IO::AIO::idle_timeout $seconds |
|
|
269 | IO::AIO::max_outstanding $maxreqs |
|
|
270 | IO::AIO::nreqs |
|
|
271 | IO::AIO::nready |
|
|
272 | IO::AIO::npending |
|
|
273 | |
|
|
274 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
|
|
275 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
276 | IO::AIO::madvise $scalar, $offset, $length, $advice |
|
|
277 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
|
|
278 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
|
|
279 | IO::AIO::munlockall |
223 | |
280 | |
224 | =head2 AIO REQUEST FUNCTIONS |
281 | =head2 AIO REQUEST FUNCTIONS |
225 | |
282 | |
226 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
283 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
227 | with the same name (sans C<aio_>). The arguments are similar or identical, |
284 | with the same name (sans C<aio_>). The arguments are similar or identical, |
… | |
… | |
235 | internally until the request has finished. |
292 | internally until the request has finished. |
236 | |
293 | |
237 | All functions return request objects of type L<IO::AIO::REQ> that allow |
294 | All functions return request objects of type L<IO::AIO::REQ> that allow |
238 | further manipulation of those requests while they are in-flight. |
295 | further manipulation of those requests while they are in-flight. |
239 | |
296 | |
240 | The pathnames you pass to these routines I<must> be absolute and |
297 | The pathnames you pass to these routines I<should> be absolute. The |
241 | encoded as octets. The reason for the former is that at the time the |
298 | reason for this is that at the time the request is being executed, the |
242 | request is being executed, the current working directory could have |
299 | current working directory could have changed. Alternatively, you can make |
243 | changed. Alternatively, you can make sure that you never change the |
300 | sure that you never change the current working directory anywhere in |
244 | current working directory anywhere in the program and then use relative |
301 | the program and then use relative paths. Lastly, you can take advantage |
245 | paths. |
302 | of IO::AIOs working directory abstraction - see the description of the |
|
|
303 | C<IO::AIO::WD> class later in this document. |
246 | |
304 | |
247 | To encode pathnames as octets, either make sure you either: a) always pass |
305 | To encode pathnames as octets, either make sure you either: a) always pass |
248 | in filenames you got from outside (command line, readdir etc.) without |
306 | in filenames you got from outside (command line, readdir etc.) without |
249 | tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode |
307 | tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode |
250 | your pathnames to the locale (or other) encoding in effect in the user |
308 | your pathnames to the locale (or other) encoding in effect in the user |
… | |
… | |
307 | by the umask in effect then the request is being executed, so better never |
365 | by the umask in effect then the request is being executed, so better never |
308 | change the umask. |
366 | change the umask. |
309 | |
367 | |
310 | Example: |
368 | Example: |
311 | |
369 | |
312 | aio_open "/etc/passwd", O_RDONLY, 0, sub { |
370 | aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub { |
313 | if ($_[0]) { |
371 | if ($_[0]) { |
314 | print "open successful, fh is $_[0]\n"; |
372 | print "open successful, fh is $_[0]\n"; |
315 | ... |
373 | ... |
316 | } else { |
374 | } else { |
317 | die "open failed: $!\n"; |
375 | die "open failed: $!\n"; |
318 | } |
376 | } |
319 | }; |
377 | }; |
320 | |
378 | |
|
|
379 | In addition to all the common open modes/flags (C<O_RDONLY>, C<O_WRONLY>, |
|
|
380 | C<O_RDWR>, C<O_CREAT>, C<O_TRUNC>, C<O_EXCL> and C<O_APPEND>), the |
|
|
381 | following POSIX and non-POSIX constants are available (missing ones on |
|
|
382 | your system are, as usual, C<0>): |
|
|
383 | |
|
|
384 | C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>, |
|
|
385 | C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>, |
|
|
386 | C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>. |
|
|
387 | |
321 | |
388 | |
322 | =item aio_close $fh, $callback->($status) |
389 | =item aio_close $fh, $callback->($status) |
323 | |
390 | |
324 | Asynchronously close a file and call the callback with the result |
391 | Asynchronously close a file and call the callback with the result |
325 | code. |
392 | code. |
… | |
… | |
375 | |
442 | |
376 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
443 | Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts |
377 | reading at byte offset C<$in_offset>, and starts writing at the current |
444 | reading at byte offset C<$in_offset>, and starts writing at the current |
378 | file offset of C<$out_fh>. Because of that, it is not safe to issue more |
445 | file offset of C<$out_fh>. Because of that, it is not safe to issue more |
379 | than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each |
446 | than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each |
380 | other. |
447 | other. The same C<$in_fh> works fine though, as this function does not |
|
|
448 | move or use the file offset of C<$in_fh>. |
381 | |
449 | |
|
|
450 | Please note that C<aio_sendfile> can read more bytes from C<$in_fh> than |
|
|
451 | are written, and there is no way to find out how many more bytes have been |
|
|
452 | read from C<aio_sendfile> alone, as C<aio_sendfile> only provides the |
|
|
453 | number of bytes written to C<$out_fh>. Only if the result value equals |
|
|
454 | C<$length> one can assume that C<$length> bytes have been read. |
|
|
455 | |
|
|
456 | Unlike with other C<aio_> functions, it makes a lot of sense to use |
|
|
457 | C<aio_sendfile> on non-blocking sockets, as long as one end (typically |
|
|
458 | the C<$in_fh>) is a file - the file I/O will then be asynchronous, while |
|
|
459 | the socket I/O will be non-blocking. Note, however, that you can run |
|
|
460 | into a trap where C<aio_sendfile> reads some data with readahead, then |
|
|
461 | fails to write all data, and when the socket is ready the next time, the |
|
|
462 | data in the cache is already lost, forcing C<aio_sendfile> to again hit |
|
|
463 | the disk. Explicit C<aio_read> + C<aio_write> let's you better control |
|
|
464 | resource usage. |
|
|
465 | |
382 | This call tries to make use of a native C<sendfile> syscall to provide |
466 | This call tries to make use of a native C<sendfile>-like syscall to |
383 | zero-copy operation. For this to work, C<$out_fh> should refer to a |
467 | provide zero-copy operation. For this to work, C<$out_fh> should refer to |
384 | socket, and C<$in_fh> should refer to mmap'able file. |
468 | a socket, and C<$in_fh> should refer to an mmap'able file. |
385 | |
469 | |
386 | If the native sendfile call fails or is not implemented, it will be |
470 | If a native sendfile cannot be found or it fails with C<ENOSYS>, |
387 | emulated, so you can call C<aio_sendfile> on any type of filehandle |
471 | C<EINVAL>, C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or |
|
|
472 | C<ENOTSOCK>, it will be emulated, so you can call C<aio_sendfile> on any |
388 | regardless of the limitations of the operating system. |
473 | type of filehandle regardless of the limitations of the operating system. |
389 | |
474 | |
390 | Please note, however, that C<aio_sendfile> can read more bytes from |
475 | As native sendfile syscalls (as practically any non-POSIX interface hacked |
391 | C<$in_fh> than are written, and there is no way to find out how many |
476 | together in a hurry to improve benchmark numbers) tend to be rather buggy |
392 | bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only |
477 | on many systems, this implementation tries to work around some known bugs |
393 | provides the number of bytes written to C<$out_fh>. Only if the result |
478 | in Linux and FreeBSD kernels (probably others, too), but that might fail, |
394 | value equals C<$length> one can assume that C<$length> bytes have been |
479 | so you really really should check the return value of C<aio_sendfile> - |
395 | read. |
480 | fewre bytes than expected might have been transferred. |
396 | |
481 | |
397 | |
482 | |
398 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
483 | =item aio_readahead $fh,$offset,$length, $callback->($retval) |
399 | |
484 | |
400 | C<aio_readahead> populates the page cache with data from a file so that |
485 | C<aio_readahead> populates the page cache with data from a file so that |
… | |
… | |
423 | |
508 | |
424 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
509 | Currently, the stats are always 64-bit-stats, i.e. instead of returning an |
425 | error when stat'ing a large file, the results will be silently truncated |
510 | error when stat'ing a large file, the results will be silently truncated |
426 | unless perl itself is compiled with large file support. |
511 | unless perl itself is compiled with large file support. |
427 | |
512 | |
|
|
513 | To help interpret the mode and dev/rdev stat values, IO::AIO offers the |
|
|
514 | following constants and functions (if not implemented, the constants will |
|
|
515 | be C<0> and the functions will either C<croak> or fall back on traditional |
|
|
516 | behaviour). |
|
|
517 | |
|
|
518 | C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>, |
|
|
519 | C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>, |
|
|
520 | C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>. |
|
|
521 | |
428 | Example: Print the length of F</etc/passwd>: |
522 | Example: Print the length of F</etc/passwd>: |
429 | |
523 | |
430 | aio_stat "/etc/passwd", sub { |
524 | aio_stat "/etc/passwd", sub { |
431 | $_[0] and die "stat failed: $!"; |
525 | $_[0] and die "stat failed: $!"; |
432 | print "size is ", -s _, "\n"; |
526 | print "size is ", -s _, "\n"; |
433 | }; |
527 | }; |
434 | |
528 | |
435 | |
529 | |
|
|
530 | =item aio_statvfs $fh_or_path, $callback->($statvfs) |
|
|
531 | |
|
|
532 | Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on |
|
|
533 | whether a file handle or path was passed. |
|
|
534 | |
|
|
535 | On success, the callback is passed a hash reference with the following |
|
|
536 | members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>, |
|
|
537 | C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef> |
|
|
538 | is passed. |
|
|
539 | |
|
|
540 | The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and |
|
|
541 | C<ST_NOSUID>. |
|
|
542 | |
|
|
543 | The following non-POSIX IO::AIO::ST_* flag masks are defined to |
|
|
544 | their correct value when available, or to C<0> on systems that do |
|
|
545 | not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>, |
|
|
546 | C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>, |
|
|
547 | C<ST_NODIRATIME> and C<ST_RELATIME>. |
|
|
548 | |
|
|
549 | Example: stat C</wd> and dump out the data if successful. |
|
|
550 | |
|
|
551 | aio_statvfs "/wd", sub { |
|
|
552 | my $f = $_[0] |
|
|
553 | or die "statvfs: $!"; |
|
|
554 | |
|
|
555 | use Data::Dumper; |
|
|
556 | say Dumper $f; |
|
|
557 | }; |
|
|
558 | |
|
|
559 | # result: |
|
|
560 | { |
|
|
561 | bsize => 1024, |
|
|
562 | bfree => 4333064312, |
|
|
563 | blocks => 10253828096, |
|
|
564 | files => 2050765568, |
|
|
565 | flag => 4096, |
|
|
566 | favail => 2042092649, |
|
|
567 | bavail => 4333064312, |
|
|
568 | ffree => 2042092649, |
|
|
569 | namemax => 255, |
|
|
570 | frsize => 1024, |
|
|
571 | fsid => 1810 |
|
|
572 | } |
|
|
573 | |
|
|
574 | |
436 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
575 | =item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) |
437 | |
576 | |
438 | Works like perl's C<utime> function (including the special case of $atime |
577 | Works like perl's C<utime> function (including the special case of $atime |
439 | and $mtime being undef). Fractional times are supported if the underlying |
578 | and $mtime being undef). Fractional times are supported if the underlying |
440 | syscalls support them. |
579 | syscalls support them. |
… | |
… | |
478 | |
617 | |
479 | Asynchronously unlink (delete) a file and call the callback with the |
618 | Asynchronously unlink (delete) a file and call the callback with the |
480 | result code. |
619 | result code. |
481 | |
620 | |
482 | |
621 | |
483 | =item aio_mknod $path, $mode, $dev, $callback->($status) |
622 | =item aio_mknod $pathname, $mode, $dev, $callback->($status) |
484 | |
623 | |
485 | [EXPERIMENTAL] |
624 | [EXPERIMENTAL] |
486 | |
625 | |
487 | Asynchronously create a device node (or fifo). See mknod(2). |
626 | Asynchronously create a device node (or fifo). See mknod(2). |
488 | |
627 | |
489 | The only (POSIX-) portable way of calling this function is: |
628 | The only (POSIX-) portable way of calling this function is: |
490 | |
629 | |
491 | aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
630 | aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ... |
492 | |
631 | |
|
|
632 | See C<aio_stat> for info about some potentially helpful extra constants |
|
|
633 | and functions. |
493 | |
634 | |
494 | =item aio_link $srcpath, $dstpath, $callback->($status) |
635 | =item aio_link $srcpath, $dstpath, $callback->($status) |
495 | |
636 | |
496 | Asynchronously create a new link to the existing object at C<$srcpath> at |
637 | Asynchronously create a new link to the existing object at C<$srcpath> at |
497 | the path C<$dstpath> and call the callback with the result code. |
638 | the path C<$dstpath> and call the callback with the result code. |
… | |
… | |
501 | |
642 | |
502 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
643 | Asynchronously create a new symbolic link to the existing object at C<$srcpath> at |
503 | the path C<$dstpath> and call the callback with the result code. |
644 | the path C<$dstpath> and call the callback with the result code. |
504 | |
645 | |
505 | |
646 | |
506 | =item aio_readlink $path, $callback->($link) |
647 | =item aio_readlink $pathname, $callback->($link) |
507 | |
648 | |
508 | Asynchronously read the symlink specified by C<$path> and pass it to |
649 | Asynchronously read the symlink specified by C<$path> and pass it to |
509 | the callback. If an error occurs, nothing or undef gets passed to the |
650 | the callback. If an error occurs, nothing or undef gets passed to the |
510 | callback. |
651 | callback. |
511 | |
652 | |
512 | |
653 | |
|
|
654 | =item aio_realpath $pathname, $callback->($path) |
|
|
655 | |
|
|
656 | Asynchronously make the path absolute and resolve any symlinks in |
|
|
657 | C<$path>. The resulting path only consists of directories (Same as |
|
|
658 | L<Cwd::realpath>). |
|
|
659 | |
|
|
660 | This request can be used to get the absolute path of the current working |
|
|
661 | directory by passing it a path of F<.> (a single dot). |
|
|
662 | |
|
|
663 | |
513 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
664 | =item aio_rename $srcpath, $dstpath, $callback->($status) |
514 | |
665 | |
515 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
666 | Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as |
516 | rename(2) and call the callback with the result code. |
667 | rename(2) and call the callback with the result code. |
517 | |
668 | |
… | |
… | |
539 | array-ref with the filenames. |
690 | array-ref with the filenames. |
540 | |
691 | |
541 | |
692 | |
542 | =item aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
693 | =item aio_readdirx $pathname, $flags, $callback->($entries, $flags) |
543 | |
694 | |
544 | Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune |
695 | Quite similar to C<aio_readdir>, but the C<$flags> argument allows one to |
545 | behaviour and output format. In case of an error, C<$entries> will be |
696 | tune behaviour and output format. In case of an error, C<$entries> will be |
546 | C<undef>. |
697 | C<undef>. |
547 | |
698 | |
548 | The flags are a combination of the following constants, ORed together (the |
699 | The flags are a combination of the following constants, ORed together (the |
549 | flags will also be passed to the callback, possibly modified): |
700 | flags will also be passed to the callback, possibly modified): |
550 | |
701 | |
551 | =over 4 |
702 | =over 4 |
552 | |
703 | |
553 | =item IO::AIO::READDIR_DENTS |
704 | =item IO::AIO::READDIR_DENTS |
554 | |
705 | |
555 | When this flag is off, then the callback gets an arrayref with of names |
706 | When this flag is off, then the callback gets an arrayref consisting of |
556 | only (as with C<aio_readdir>), otherwise it gets an arrayref with |
707 | names only (as with C<aio_readdir>), otherwise it gets an arrayref with |
557 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
708 | C<[$name, $type, $inode]> arrayrefs, each describing a single directory |
558 | entry in more detail. |
709 | entry in more detail. |
559 | |
710 | |
560 | C<$name> is the name of the entry. |
711 | C<$name> is the name of the entry. |
561 | |
712 | |
… | |
… | |
568 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to |
719 | C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to |
569 | know, you have to run stat yourself. Also, for speed reasons, the C<$type> |
720 | know, you have to run stat yourself. Also, for speed reasons, the C<$type> |
570 | scalars are read-only: you can not modify them. |
721 | scalars are read-only: you can not modify them. |
571 | |
722 | |
572 | C<$inode> is the inode number (which might not be exact on systems with 64 |
723 | C<$inode> is the inode number (which might not be exact on systems with 64 |
573 | bit inode numbers and 32 bit perls). On systems that do not deliver the |
724 | bit inode numbers and 32 bit perls). This field has unspecified content on |
574 | inode information, this will always be zero. |
725 | systems that do not deliver the inode information. |
575 | |
726 | |
576 | =item IO::AIO::READDIR_DIRS_FIRST |
727 | =item IO::AIO::READDIR_DIRS_FIRST |
577 | |
728 | |
578 | When this flag is set, then the names will be returned in an order where |
729 | When this flag is set, then the names will be returned in an order where |
579 | likely directories come first. This is useful when you need to quickly |
730 | likely directories come first, in optimal stat order. This is useful when |
580 | find directories, or you want to find all directories while avoiding to |
731 | you need to quickly find directories, or you want to find all directories |
581 | stat() each entry. |
732 | while avoiding to stat() each entry. |
582 | |
733 | |
583 | If the system returns type information in readdir, then this is used |
734 | If the system returns type information in readdir, then this is used |
584 | to find directories directly. Otherwise, likely directories are files |
735 | to find directories directly. Otherwise, likely directories are names |
585 | beginning with ".", or otherwise files with no dots, of which files with |
736 | beginning with ".", or otherwise names with no dots, of which names with |
586 | short names are tried first. |
737 | short names are tried first. |
587 | |
738 | |
588 | =item IO::AIO::READDIR_STAT_ORDER |
739 | =item IO::AIO::READDIR_STAT_ORDER |
589 | |
740 | |
590 | When this flag is set, then the names will be returned in an order |
741 | When this flag is set, then the names will be returned in an order |
… | |
… | |
597 | |
748 | |
598 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
749 | =item IO::AIO::READDIR_FOUND_UNKNOWN |
599 | |
750 | |
600 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
751 | This flag should not be set when calling C<aio_readdirx>. Instead, it |
601 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
752 | is being set by C<aio_readdirx>, when any of the C<$type>'s found were |
602 | C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all |
753 | C<IO::AIO::DT_UNKNOWN>. The absence of this flag therefore indicates that all |
603 | C<$type>'s are known, which can be used to speed up some algorithms. |
754 | C<$type>'s are known, which can be used to speed up some algorithms. |
604 | |
755 | |
605 | =back |
756 | =back |
606 | |
757 | |
607 | |
758 | |
608 | =item aio_load $path, $data, $callback->($status) |
759 | =item aio_load $pathname, $data, $callback->($status) |
609 | |
760 | |
610 | This is a composite request that tries to fully load the given file into |
761 | This is a composite request that tries to fully load the given file into |
611 | memory. Status is the same as with aio_read. |
762 | memory. Status is the same as with aio_read. |
612 | |
763 | |
613 | =cut |
764 | =cut |
… | |
… | |
635 | |
786 | |
636 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
787 | =item aio_copy $srcpath, $dstpath, $callback->($status) |
637 | |
788 | |
638 | Try to copy the I<file> (directories not supported as either source or |
789 | Try to copy the I<file> (directories not supported as either source or |
639 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
790 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
640 | the C<0> (error) or C<-1> ok. |
791 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
641 | |
792 | |
642 | This is a composite request that creates the destination file with |
793 | This is a composite request that creates the destination file with |
643 | mode 0200 and copies the contents of the source file into it using |
794 | mode 0200 and copies the contents of the source file into it using |
644 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
795 | C<aio_sendfile>, followed by restoring atime, mtime, access mode and |
645 | uid/gid, in that order. |
796 | uid/gid, in that order. |
… | |
… | |
657 | my $grp = aio_group $cb; |
808 | my $grp = aio_group $cb; |
658 | |
809 | |
659 | aioreq_pri $pri; |
810 | aioreq_pri $pri; |
660 | add $grp aio_open $src, O_RDONLY, 0, sub { |
811 | add $grp aio_open $src, O_RDONLY, 0, sub { |
661 | if (my $src_fh = $_[0]) { |
812 | if (my $src_fh = $_[0]) { |
662 | my @stat = stat $src_fh; # hmm, might bock over nfs? |
813 | my @stat = stat $src_fh; # hmm, might block over nfs? |
663 | |
814 | |
664 | aioreq_pri $pri; |
815 | aioreq_pri $pri; |
665 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
816 | add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { |
666 | if (my $dst_fh = $_[0]) { |
817 | if (my $dst_fh = $_[0]) { |
667 | aioreq_pri $pri; |
818 | aioreq_pri $pri; |
… | |
… | |
714 | |
865 | |
715 | =item aio_move $srcpath, $dstpath, $callback->($status) |
866 | =item aio_move $srcpath, $dstpath, $callback->($status) |
716 | |
867 | |
717 | Try to move the I<file> (directories not supported as either source or |
868 | Try to move the I<file> (directories not supported as either source or |
718 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
869 | destination) from C<$srcpath> to C<$dstpath> and call the callback with |
719 | the C<0> (error) or C<-1> ok. |
870 | a status of C<0> (ok) or C<-1> (error, see C<$!>). |
720 | |
871 | |
721 | This is a composite request that tries to rename(2) the file first; if |
872 | This is a composite request that tries to rename(2) the file first; if |
722 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
873 | rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if |
723 | that is successful, unlinks the C<$srcpath>. |
874 | that is successful, unlinks the C<$srcpath>. |
724 | |
875 | |
… | |
… | |
735 | if ($_[0] && $! == EXDEV) { |
886 | if ($_[0] && $! == EXDEV) { |
736 | aioreq_pri $pri; |
887 | aioreq_pri $pri; |
737 | add $grp aio_copy $src, $dst, sub { |
888 | add $grp aio_copy $src, $dst, sub { |
738 | $grp->result ($_[0]); |
889 | $grp->result ($_[0]); |
739 | |
890 | |
740 | if (!$_[0]) { |
891 | unless ($_[0]) { |
741 | aioreq_pri $pri; |
892 | aioreq_pri $pri; |
742 | add $grp aio_unlink $src; |
893 | add $grp aio_unlink $src; |
743 | } |
894 | } |
744 | }; |
895 | }; |
745 | } else { |
896 | } else { |
… | |
… | |
748 | }; |
899 | }; |
749 | |
900 | |
750 | $grp |
901 | $grp |
751 | } |
902 | } |
752 | |
903 | |
753 | =item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) |
904 | =item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs) |
754 | |
905 | |
755 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
906 | Scans a directory (similar to C<aio_readdir>) but additionally tries to |
756 | efficiently separate the entries of directory C<$path> into two sets of |
907 | efficiently separate the entries of directory C<$path> into two sets of |
757 | names, directories you can recurse into (directories), and ones you cannot |
908 | names, directories you can recurse into (directories), and ones you cannot |
758 | recurse into (everything else, including symlinks to directories). |
909 | recurse into (everything else, including symlinks to directories). |
… | |
… | |
789 | Then entries will be sorted into likely directories a non-initial dot |
940 | Then entries will be sorted into likely directories a non-initial dot |
790 | currently) and likely non-directories (see C<aio_readdirx>). Then every |
941 | currently) and likely non-directories (see C<aio_readdirx>). Then every |
791 | entry plus an appended C</.> will be C<stat>'ed, likely directories first, |
942 | entry plus an appended C</.> will be C<stat>'ed, likely directories first, |
792 | in order of their inode numbers. If that succeeds, it assumes that the |
943 | in order of their inode numbers. If that succeeds, it assumes that the |
793 | entry is a directory or a symlink to directory (which will be checked |
944 | entry is a directory or a symlink to directory (which will be checked |
794 | seperately). This is often faster than stat'ing the entry itself because |
945 | separately). This is often faster than stat'ing the entry itself because |
795 | filesystems might detect the type of the entry without reading the inode |
946 | filesystems might detect the type of the entry without reading the inode |
796 | data (e.g. ext2fs filetype feature), even on systems that cannot return |
947 | data (e.g. ext2fs filetype feature), even on systems that cannot return |
797 | the filetype information on readdir. |
948 | the filetype information on readdir. |
798 | |
949 | |
799 | If the known number of directories (link count - 2) has been reached, the |
950 | If the known number of directories (link count - 2) has been reached, the |
… | |
… | |
815 | |
966 | |
816 | my $grp = aio_group $cb; |
967 | my $grp = aio_group $cb; |
817 | |
968 | |
818 | $maxreq = 4 if $maxreq <= 0; |
969 | $maxreq = 4 if $maxreq <= 0; |
819 | |
970 | |
820 | # stat once |
971 | # get a wd object |
|
|
972 | |
821 | aioreq_pri $pri; |
973 | aioreq_pri $pri; |
822 | add $grp aio_stat $path, sub { |
974 | add $grp aio_wd $path, sub { |
823 | return $grp->result () if $_[0]; |
975 | my $wd = [shift, "."]; |
824 | my $now = time; |
|
|
825 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
826 | |
976 | |
827 | # read the directory entries |
977 | # stat once |
828 | aioreq_pri $pri; |
978 | aioreq_pri $pri; |
829 | add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub { |
979 | add $grp aio_stat $wd, sub { |
830 | my $entries = shift |
|
|
831 | or return $grp->result (); |
980 | return $grp->result () if $_[0]; |
|
|
981 | my $now = time; |
|
|
982 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
832 | |
983 | |
833 | # stat the dir another time |
984 | # read the directory entries |
834 | aioreq_pri $pri; |
985 | aioreq_pri $pri; |
|
|
986 | add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub { |
|
|
987 | my $entries = shift |
|
|
988 | or return $grp->result (); |
|
|
989 | |
|
|
990 | # stat the dir another time |
|
|
991 | aioreq_pri $pri; |
835 | add $grp aio_stat $path, sub { |
992 | add $grp aio_stat $wd, sub { |
836 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
993 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
837 | |
994 | |
838 | my $ndirs; |
995 | my $ndirs; |
839 | |
996 | |
840 | # take the slow route if anything looks fishy |
997 | # take the slow route if anything looks fishy |
841 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
998 | if ($hash1 ne $hash2 or (stat _)[9] == $now) { |
842 | $ndirs = -1; |
999 | $ndirs = -1; |
843 | } else { |
1000 | } else { |
844 | # if nlink == 2, we are finished |
1001 | # if nlink == 2, we are finished |
845 | # for non-posix-fs's, we rely on nlink < 2 |
1002 | # for non-posix-fs's, we rely on nlink < 2 |
846 | $ndirs = (stat _)[3] - 2 |
1003 | $ndirs = (stat _)[3] - 2 |
847 | or return $grp->result ([], $entries); |
1004 | or return $grp->result ([], $entries); |
848 | } |
1005 | } |
849 | |
1006 | |
850 | my (@dirs, @nondirs); |
1007 | my (@dirs, @nondirs); |
851 | |
1008 | |
852 | my $statgrp = add $grp aio_group sub { |
1009 | my $statgrp = add $grp aio_group sub { |
853 | $grp->result (\@dirs, \@nondirs); |
1010 | $grp->result (\@dirs, \@nondirs); |
854 | }; |
1011 | }; |
855 | |
1012 | |
856 | limit $statgrp $maxreq; |
1013 | limit $statgrp $maxreq; |
857 | feed $statgrp sub { |
1014 | feed $statgrp sub { |
858 | return unless @$entries; |
1015 | return unless @$entries; |
859 | my $entry = shift @$entries; |
1016 | my $entry = shift @$entries; |
860 | |
1017 | |
861 | aioreq_pri $pri; |
1018 | aioreq_pri $pri; |
|
|
1019 | $wd->[1] = "$entry/."; |
862 | add $statgrp aio_stat "$path/$entry/.", sub { |
1020 | add $statgrp aio_stat $wd, sub { |
863 | if ($_[0] < 0) { |
1021 | if ($_[0] < 0) { |
864 | push @nondirs, $entry; |
1022 | push @nondirs, $entry; |
865 | } else { |
1023 | } else { |
866 | # need to check for real directory |
1024 | # need to check for real directory |
867 | aioreq_pri $pri; |
1025 | aioreq_pri $pri; |
|
|
1026 | $wd->[1] = $entry; |
868 | add $statgrp aio_lstat "$path/$entry", sub { |
1027 | add $statgrp aio_lstat $wd, sub { |
869 | if (-d _) { |
1028 | if (-d _) { |
870 | push @dirs, $entry; |
1029 | push @dirs, $entry; |
871 | |
1030 | |
872 | unless (--$ndirs) { |
1031 | unless (--$ndirs) { |
873 | push @nondirs, @$entries; |
1032 | push @nondirs, @$entries; |
874 | feed $statgrp; |
1033 | feed $statgrp; |
|
|
1034 | } |
|
|
1035 | } else { |
|
|
1036 | push @nondirs, $entry; |
875 | } |
1037 | } |
876 | } else { |
|
|
877 | push @nondirs, $entry; |
|
|
878 | } |
1038 | } |
879 | } |
1039 | } |
880 | } |
1040 | }; |
881 | }; |
1041 | }; |
882 | }; |
1042 | }; |
883 | }; |
1043 | }; |
884 | }; |
1044 | }; |
885 | }; |
1045 | }; |
886 | |
1046 | |
887 | $grp |
1047 | $grp |
888 | } |
1048 | } |
889 | |
1049 | |
890 | =item aio_rmtree $path, $callback->($status) |
1050 | =item aio_rmtree $pathname, $callback->($status) |
891 | |
1051 | |
892 | Delete a directory tree starting (and including) C<$path>, return the |
1052 | Delete a directory tree starting (and including) C<$path>, return the |
893 | status of the final C<rmdir> only. This is a composite request that |
1053 | status of the final C<rmdir> only. This is a composite request that |
894 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
1054 | uses C<aio_scandir> to recurse into and rmdir directories, and unlink |
895 | everything else. |
1055 | everything else. |
… | |
… | |
937 | callback with the fdatasync result code. |
1097 | callback with the fdatasync result code. |
938 | |
1098 | |
939 | If this call isn't available because your OS lacks it or it couldn't be |
1099 | If this call isn't available because your OS lacks it or it couldn't be |
940 | detected, it will be emulated by calling C<fsync> instead. |
1100 | detected, it will be emulated by calling C<fsync> instead. |
941 | |
1101 | |
|
|
1102 | =item aio_syncfs $fh, $callback->($status) |
|
|
1103 | |
|
|
1104 | Asynchronously call the syncfs syscall to sync the filesystem associated |
|
|
1105 | to the given filehandle and call the callback with the syncfs result |
|
|
1106 | code. If syncfs is not available, calls sync(), but returns C<-1> and sets |
|
|
1107 | errno to C<ENOSYS> nevertheless. |
|
|
1108 | |
942 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
1109 | =item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) |
943 | |
1110 | |
944 | Sync the data portion of the file specified by C<$offset> and C<$length> |
1111 | Sync the data portion of the file specified by C<$offset> and C<$length> |
945 | to disk (but NOT the metadata), by calling the Linux-specific |
1112 | to disk (but NOT the metadata), by calling the Linux-specific |
946 | sync_file_range call. If sync_file_range is not available or it returns |
1113 | sync_file_range call. If sync_file_range is not available or it returns |
… | |
… | |
949 | C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, |
1116 | C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>, |
950 | C<IO::AIO::SYNC_FILE_RANGE_WRITE> and |
1117 | C<IO::AIO::SYNC_FILE_RANGE_WRITE> and |
951 | C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range |
1118 | C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range |
952 | manpage for details. |
1119 | manpage for details. |
953 | |
1120 | |
954 | =item aio_pathsync $path, $callback->($status) |
1121 | =item aio_pathsync $pathname, $callback->($status) |
955 | |
1122 | |
956 | This request tries to open, fsync and close the given path. This is a |
1123 | This request tries to open, fsync and close the given path. This is a |
957 | composite request intended to sync directories after directory operations |
1124 | composite request intended to sync directories after directory operations |
958 | (E.g. rename). This might not work on all operating systems or have any |
1125 | (E.g. rename). This might not work on all operating systems or have any |
959 | specific effect, but usually it makes sure that directory changes get |
1126 | specific effect, but usually it makes sure that directory changes get |
960 | written to disc. It works for anything that can be opened for read-only, |
1127 | written to disc. It works for anything that can be opened for read-only, |
961 | not just directories. |
1128 | not just directories. |
|
|
1129 | |
|
|
1130 | Future versions of this function might fall back to other methods when |
|
|
1131 | C<fsync> on the directory fails (such as calling C<sync>). |
962 | |
1132 | |
963 | Passes C<0> when everything went ok, and C<-1> on error. |
1133 | Passes C<0> when everything went ok, and C<-1> on error. |
964 | |
1134 | |
965 | =cut |
1135 | =cut |
966 | |
1136 | |
… | |
… | |
987 | }; |
1157 | }; |
988 | |
1158 | |
989 | $grp |
1159 | $grp |
990 | } |
1160 | } |
991 | |
1161 | |
|
|
1162 | =item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
1163 | |
|
|
1164 | This is a rather advanced IO::AIO call, which only works on mmap(2)ed |
|
|
1165 | scalars (see the C<IO::AIO::mmap> function, although it also works on data |
|
|
1166 | scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the |
|
|
1167 | scalar must only be modified in-place while an aio operation is pending on |
|
|
1168 | it). |
|
|
1169 | |
|
|
1170 | It calls the C<msync> function of your OS, if available, with the memory |
|
|
1171 | area starting at C<$offset> in the string and ending C<$length> bytes |
|
|
1172 | later. If C<$length> is negative, counts from the end, and if C<$length> |
|
|
1173 | is C<undef>, then it goes till the end of the string. The flags can be |
|
|
1174 | a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and |
|
|
1175 | C<IO::AIO::MS_SYNC>. |
|
|
1176 | |
|
|
1177 | =item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) |
|
|
1178 | |
|
|
1179 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
|
|
1180 | scalars. |
|
|
1181 | |
|
|
1182 | It touches (reads or writes) all memory pages in the specified |
|
|
1183 | range inside the scalar. All caveats and parameters are the same |
|
|
1184 | as for C<aio_msync>, above, except for flags, which must be either |
|
|
1185 | C<0> (which reads all pages and ensures they are instantiated) or |
|
|
1186 | C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and |
|
|
1187 | writing an octet from it, which dirties the page). |
|
|
1188 | |
|
|
1189 | =item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) |
|
|
1190 | |
|
|
1191 | This is a rather advanced IO::AIO call, which works best on mmap(2)ed |
|
|
1192 | scalars. |
|
|
1193 | |
|
|
1194 | It reads in all the pages of the underlying storage into memory (if any) |
|
|
1195 | and locks them, so they are not getting swapped/paged out or removed. |
|
|
1196 | |
|
|
1197 | If C<$length> is undefined, then the scalar will be locked till the end. |
|
|
1198 | |
|
|
1199 | On systems that do not implement C<mlock>, this function returns C<-1> |
|
|
1200 | and sets errno to C<ENOSYS>. |
|
|
1201 | |
|
|
1202 | Note that the corresponding C<munlock> is synchronous and is |
|
|
1203 | documented under L<MISCELLANEOUS FUNCTIONS>. |
|
|
1204 | |
|
|
1205 | Example: open a file, mmap and mlock it - both will be undone when |
|
|
1206 | C<$data> gets destroyed. |
|
|
1207 | |
|
|
1208 | open my $fh, "<", $path or die "$path: $!"; |
|
|
1209 | my $data; |
|
|
1210 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
|
|
1211 | aio_mlock $data; # mlock in background |
|
|
1212 | |
|
|
1213 | =item aio_mlockall $flags, $callback->($status) |
|
|
1214 | |
|
|
1215 | Calls the C<mlockall> function with the given C<$flags> (a combination of |
|
|
1216 | C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>). |
|
|
1217 | |
|
|
1218 | On systems that do not implement C<mlockall>, this function returns C<-1> |
|
|
1219 | and sets errno to C<ENOSYS>. |
|
|
1220 | |
|
|
1221 | Note that the corresponding C<munlockall> is synchronous and is |
|
|
1222 | documented under L<MISCELLANEOUS FUNCTIONS>. |
|
|
1223 | |
|
|
1224 | Example: asynchronously lock all current and future pages into memory. |
|
|
1225 | |
|
|
1226 | aio_mlockall IO::AIO::MCL_FUTURE; |
|
|
1227 | |
992 | =item aio_group $callback->(...) |
1228 | =item aio_group $callback->(...) |
993 | |
1229 | |
994 | This is a very special aio request: Instead of doing something, it is a |
1230 | This is a very special aio request: Instead of doing something, it is a |
995 | container for other aio requests, which is useful if you want to bundle |
1231 | container for other aio requests, which is useful if you want to bundle |
996 | many requests into a single, composite, request with a definite callback |
1232 | many requests into a single, composite, request with a definite callback |
… | |
… | |
1032 | like sleep and file handle readable/writable, the overhead this creates is |
1268 | like sleep and file handle readable/writable, the overhead this creates is |
1033 | immense (it blocks a thread for a long time) so do not use this function |
1269 | immense (it blocks a thread for a long time) so do not use this function |
1034 | except to put your application under artificial I/O pressure. |
1270 | except to put your application under artificial I/O pressure. |
1035 | |
1271 | |
1036 | =back |
1272 | =back |
|
|
1273 | |
|
|
1274 | |
|
|
1275 | =head2 IO::AIO::WD - multiple working directories |
|
|
1276 | |
|
|
1277 | Your process only has one current working directory, which is used by all |
|
|
1278 | threads. This makes it hard to use relative paths (some other component |
|
|
1279 | could call C<chdir> at any time, and it is hard to control when the path |
|
|
1280 | will be used by IO::AIO). |
|
|
1281 | |
|
|
1282 | One solution for this is to always use absolute paths. This usually works, |
|
|
1283 | but can be quite slow (the kernel has to walk the whole path on every |
|
|
1284 | access), and can also be a hassle to implement. |
|
|
1285 | |
|
|
1286 | Newer POSIX systems have a number of functions (openat, fdopendir, |
|
|
1287 | futimensat and so on) that make it possible to specify working directories |
|
|
1288 | per operation. |
|
|
1289 | |
|
|
1290 | For portability, and because the clowns who "designed", or shall I write, |
|
|
1291 | perpetrated this new interface were obviously half-drunk, this abstraction |
|
|
1292 | cannot be perfect, though. |
|
|
1293 | |
|
|
1294 | IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD |
|
|
1295 | object. This object stores the canonicalised, absolute version of the |
|
|
1296 | path, and on systems that allow it, also a directory file descriptor. |
|
|
1297 | |
|
|
1298 | Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat> |
|
|
1299 | or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD |
|
|
1300 | object and a pathname instead. If the pathname is absolute, the |
|
|
1301 | IO::AIO::WD objetc is ignored, otherwise the pathname is resolved relative |
|
|
1302 | to that IO::AIO::WD object. |
|
|
1303 | |
|
|
1304 | For example, to get a wd object for F</etc> and then stat F<passwd> |
|
|
1305 | inside, you would write: |
|
|
1306 | |
|
|
1307 | aio_wd "/etc", sub { |
|
|
1308 | my $etcdir = shift; |
|
|
1309 | |
|
|
1310 | # although $etcdir can be undef on error, there is generally no reason |
|
|
1311 | # to check for errors here, as aio_stat will fail with ENOENT |
|
|
1312 | # when $etcdir is undef. |
|
|
1313 | |
|
|
1314 | aio_stat [$etcdir, "passwd"], sub { |
|
|
1315 | # yay |
|
|
1316 | }; |
|
|
1317 | }; |
|
|
1318 | |
|
|
1319 | This shows that creating an IO::AIO::WD object is itself a potentially |
|
|
1320 | blocking operation, which is why it is done asynchronously. |
|
|
1321 | |
|
|
1322 | As with normal pathnames, IO::AIO keeps a copy of the working directory |
|
|
1323 | object and the pathname string, so you could write the following without |
|
|
1324 | causing any issues due to C<$path> getting reused: |
|
|
1325 | |
|
|
1326 | my $path = [$wd, undef]; |
|
|
1327 | |
|
|
1328 | for my $name (qw(abc def ghi)) { |
|
|
1329 | $path->[1] = $name; |
|
|
1330 | aio_stat $path, sub { |
|
|
1331 | # ... |
|
|
1332 | }; |
|
|
1333 | } |
|
|
1334 | |
|
|
1335 | There are some caveats: when directories get renamed (or deleted), the |
|
|
1336 | pathname string doesn't change, so will point to the new directory (or |
|
|
1337 | nowhere at all), while the directory fd, if available on the system, |
|
|
1338 | will still point to the original directory. Most functions accepting a |
|
|
1339 | pathname will use the directory fd on newer systems, and the string on |
|
|
1340 | older systems. Some functions (such as realpath) will always rely on the |
|
|
1341 | string form of the pathname. |
|
|
1342 | |
|
|
1343 | So this fucntionality is mainly useful to get some protection against |
|
|
1344 | C<chdir>, to easily get an absolute path out of a relative path for future |
|
|
1345 | reference, and to speed up doing many operations in the same directory |
|
|
1346 | (e.g. when stat'ing all files in a directory). |
|
|
1347 | |
|
|
1348 | The following functions implement this working directory abstraction: |
|
|
1349 | |
|
|
1350 | =over 4 |
|
|
1351 | |
|
|
1352 | =item aio_wd $pathname, $callback->($wd) |
|
|
1353 | |
|
|
1354 | Asynchonously canonicalise the given pathname and convert it to an |
|
|
1355 | IO::AIO::WD object representing it. If possible and supported on the |
|
|
1356 | system, also open a directory fd to speed up pathname resolution relative |
|
|
1357 | to this working directory. |
|
|
1358 | |
|
|
1359 | If something goes wrong, then C<undef> is passwd to the callback instead |
|
|
1360 | of a working directory object and C<$!> is set appropriately. Since |
|
|
1361 | passing C<undef> as working directory component of a pathname fails the |
|
|
1362 | request with C<ENOENT>, there is often no need for error checking in the |
|
|
1363 | C<aio_wd> callback, as future requests using the value will fail in the |
|
|
1364 | expected way. |
|
|
1365 | |
|
|
1366 | If this call isn't available because your OS lacks it or it couldn't be |
|
|
1367 | detected, it will be emulated by calling C<fsync> instead. |
|
|
1368 | |
|
|
1369 | =item IO::AIO::CWD |
|
|
1370 | |
|
|
1371 | This is a compiletime constant (object) that represents the process |
|
|
1372 | current working directory. |
|
|
1373 | |
|
|
1374 | Specifying this object as working directory object for a pathname is as |
|
|
1375 | if the pathname would be specified directly, without a directory object, |
|
|
1376 | e.g., these calls are functionally identical: |
|
|
1377 | |
|
|
1378 | aio_stat "somefile", sub { ... }; |
|
|
1379 | aio_stat [IO::AIO::CWD, "somefile"], sub { ... }; |
|
|
1380 | |
|
|
1381 | =back |
|
|
1382 | |
1037 | |
1383 | |
1038 | =head2 IO::AIO::REQ CLASS |
1384 | =head2 IO::AIO::REQ CLASS |
1039 | |
1385 | |
1040 | All non-aggregate C<aio_*> functions return an object of this class when |
1386 | All non-aggregate C<aio_*> functions return an object of this class when |
1041 | called in non-void context. |
1387 | called in non-void context. |
… | |
… | |
1131 | =item $grp->cancel_subs |
1477 | =item $grp->cancel_subs |
1132 | |
1478 | |
1133 | Cancel all subrequests and clears any feeder, but not the group request |
1479 | Cancel all subrequests and clears any feeder, but not the group request |
1134 | itself. Useful when you queued a lot of events but got a result early. |
1480 | itself. Useful when you queued a lot of events but got a result early. |
1135 | |
1481 | |
|
|
1482 | The group request will finish normally (you cannot add requests to the |
|
|
1483 | group). |
|
|
1484 | |
1136 | =item $grp->result (...) |
1485 | =item $grp->result (...) |
1137 | |
1486 | |
1138 | Set the result value(s) that will be passed to the group callback when all |
1487 | Set the result value(s) that will be passed to the group callback when all |
1139 | subrequests have finished and set the groups errno to the current value |
1488 | subrequests have finished and set the groups errno to the current value |
1140 | of errno (just like calling C<errno> without an error number). By default, |
1489 | of errno (just like calling C<errno> without an error number). By default, |
… | |
… | |
1208 | =over 4 |
1557 | =over 4 |
1209 | |
1558 | |
1210 | =item $fileno = IO::AIO::poll_fileno |
1559 | =item $fileno = IO::AIO::poll_fileno |
1211 | |
1560 | |
1212 | Return the I<request result pipe file descriptor>. This filehandle must be |
1561 | Return the I<request result pipe file descriptor>. This filehandle must be |
1213 | polled for reading by some mechanism outside this module (e.g. Event or |
1562 | polled for reading by some mechanism outside this module (e.g. EV, Glib, |
1214 | select, see below or the SYNOPSIS). If the pipe becomes readable you have |
1563 | select and so on, see below or the SYNOPSIS). If the pipe becomes readable |
1215 | to call C<poll_cb> to check the results. |
1564 | you have to call C<poll_cb> to check the results. |
1216 | |
1565 | |
1217 | See C<poll_cb> for an example. |
1566 | See C<poll_cb> for an example. |
1218 | |
1567 | |
1219 | =item IO::AIO::poll_cb |
1568 | =item IO::AIO::poll_cb |
1220 | |
1569 | |
1221 | Process some outstanding events on the result pipe. You have to call this |
1570 | Process some outstanding events on the result pipe. You have to call |
1222 | regularly. Returns C<0> if all events could be processed, or C<-1> if it |
1571 | this regularly. Returns C<0> if all events could be processed (or there |
1223 | returned earlier for whatever reason. Returns immediately when no events |
1572 | were no events to process), or C<-1> if it returned earlier for whatever |
1224 | are outstanding. The amount of events processed depends on the settings of |
1573 | reason. Returns immediately when no events are outstanding. The amount of |
1225 | C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. |
1574 | events processed depends on the settings of C<IO::AIO::max_poll_req> and |
|
|
1575 | C<IO::AIO::max_poll_time>. |
1226 | |
1576 | |
1227 | If not all requests were processed for whatever reason, the filehandle |
1577 | If not all requests were processed for whatever reason, the filehandle |
1228 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1578 | will still be ready when C<poll_cb> returns, so normally you don't have to |
1229 | do anything special to have it called later. |
1579 | do anything special to have it called later. |
1230 | |
1580 | |
|
|
1581 | Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes |
|
|
1582 | ready, it can be beneficial to call this function from loops which submit |
|
|
1583 | a lot of requests, to make sure the results get processed when they become |
|
|
1584 | available and not just when the loop is finished and the event loop takes |
|
|
1585 | over again. This function returns very fast when there are no outstanding |
|
|
1586 | requests. |
|
|
1587 | |
1231 | Example: Install an Event watcher that automatically calls |
1588 | Example: Install an Event watcher that automatically calls |
1232 | IO::AIO::poll_cb with high priority: |
1589 | IO::AIO::poll_cb with high priority (more examples can be found in the |
|
|
1590 | SYNOPSIS section, at the top of this document): |
1233 | |
1591 | |
1234 | Event->io (fd => IO::AIO::poll_fileno, |
1592 | Event->io (fd => IO::AIO::poll_fileno, |
1235 | poll => 'r', async => 1, |
1593 | poll => 'r', async => 1, |
1236 | cb => \&IO::AIO::poll_cb); |
1594 | cb => \&IO::AIO::poll_cb); |
|
|
1595 | |
|
|
1596 | =item IO::AIO::poll_wait |
|
|
1597 | |
|
|
1598 | If there are any outstanding requests and none of them in the result |
|
|
1599 | phase, wait till the result filehandle becomes ready for reading (simply |
|
|
1600 | does a C<select> on the filehandle. This is useful if you want to |
|
|
1601 | synchronously wait for some requests to finish). |
|
|
1602 | |
|
|
1603 | See C<nreqs> for an example. |
|
|
1604 | |
|
|
1605 | =item IO::AIO::poll |
|
|
1606 | |
|
|
1607 | Waits until some requests have been handled. |
|
|
1608 | |
|
|
1609 | Returns the number of requests processed, but is otherwise strictly |
|
|
1610 | equivalent to: |
|
|
1611 | |
|
|
1612 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
1613 | |
|
|
1614 | =item IO::AIO::flush |
|
|
1615 | |
|
|
1616 | Wait till all outstanding AIO requests have been handled. |
|
|
1617 | |
|
|
1618 | Strictly equivalent to: |
|
|
1619 | |
|
|
1620 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
1621 | while IO::AIO::nreqs; |
1237 | |
1622 | |
1238 | =item IO::AIO::max_poll_reqs $nreqs |
1623 | =item IO::AIO::max_poll_reqs $nreqs |
1239 | |
1624 | |
1240 | =item IO::AIO::max_poll_time $seconds |
1625 | =item IO::AIO::max_poll_time $seconds |
1241 | |
1626 | |
… | |
… | |
1266 | # use a low priority so other tasks have priority |
1651 | # use a low priority so other tasks have priority |
1267 | Event->io (fd => IO::AIO::poll_fileno, |
1652 | Event->io (fd => IO::AIO::poll_fileno, |
1268 | poll => 'r', nice => 1, |
1653 | poll => 'r', nice => 1, |
1269 | cb => &IO::AIO::poll_cb); |
1654 | cb => &IO::AIO::poll_cb); |
1270 | |
1655 | |
1271 | =item IO::AIO::poll_wait |
|
|
1272 | |
|
|
1273 | If there are any outstanding requests and none of them in the result |
|
|
1274 | phase, wait till the result filehandle becomes ready for reading (simply |
|
|
1275 | does a C<select> on the filehandle. This is useful if you want to |
|
|
1276 | synchronously wait for some requests to finish). |
|
|
1277 | |
|
|
1278 | See C<nreqs> for an example. |
|
|
1279 | |
|
|
1280 | =item IO::AIO::poll |
|
|
1281 | |
|
|
1282 | Waits until some requests have been handled. |
|
|
1283 | |
|
|
1284 | Returns the number of requests processed, but is otherwise strictly |
|
|
1285 | equivalent to: |
|
|
1286 | |
|
|
1287 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
1288 | |
|
|
1289 | =item IO::AIO::flush |
|
|
1290 | |
|
|
1291 | Wait till all outstanding AIO requests have been handled. |
|
|
1292 | |
|
|
1293 | Strictly equivalent to: |
|
|
1294 | |
|
|
1295 | IO::AIO::poll_wait, IO::AIO::poll_cb |
|
|
1296 | while IO::AIO::nreqs; |
|
|
1297 | |
|
|
1298 | =back |
1656 | =back |
1299 | |
1657 | |
1300 | =head3 CONTROLLING THE NUMBER OF THREADS |
1658 | =head3 CONTROLLING THE NUMBER OF THREADS |
1301 | |
1659 | |
1302 | =over |
1660 | =over |
… | |
… | |
1335 | |
1693 | |
1336 | Under normal circumstances you don't need to call this function. |
1694 | Under normal circumstances you don't need to call this function. |
1337 | |
1695 | |
1338 | =item IO::AIO::max_idle $nthreads |
1696 | =item IO::AIO::max_idle $nthreads |
1339 | |
1697 | |
1340 | Limit the number of threads (default: 4) that are allowed to idle (i.e., |
1698 | Limit the number of threads (default: 4) that are allowed to idle |
1341 | threads that did not get a request to process within 10 seconds). That |
1699 | (i.e., threads that did not get a request to process within the idle |
1342 | means if a thread becomes idle while C<$nthreads> other threads are also |
1700 | timeout (default: 10 seconds). That means if a thread becomes idle while |
1343 | idle, it will free its resources and exit. |
1701 | C<$nthreads> other threads are also idle, it will free its resources and |
|
|
1702 | exit. |
1344 | |
1703 | |
1345 | This is useful when you allow a large number of threads (e.g. 100 or 1000) |
1704 | This is useful when you allow a large number of threads (e.g. 100 or 1000) |
1346 | to allow for extremely high load situations, but want to free resources |
1705 | to allow for extremely high load situations, but want to free resources |
1347 | under normal circumstances (1000 threads can easily consume 30MB of RAM). |
1706 | under normal circumstances (1000 threads can easily consume 30MB of RAM). |
1348 | |
1707 | |
1349 | The default is probably ok in most situations, especially if thread |
1708 | The default is probably ok in most situations, especially if thread |
1350 | creation is fast. If thread creation is very slow on your system you might |
1709 | creation is fast. If thread creation is very slow on your system you might |
1351 | want to use larger values. |
1710 | want to use larger values. |
1352 | |
1711 | |
|
|
1712 | =item IO::AIO::idle_timeout $seconds |
|
|
1713 | |
|
|
1714 | Sets the minimum idle timeout (default 10) after which worker threads are |
|
|
1715 | allowed to exit. SEe C<IO::AIO::max_idle>. |
|
|
1716 | |
1353 | =item IO::AIO::max_outstanding $maxreqs |
1717 | =item IO::AIO::max_outstanding $maxreqs |
|
|
1718 | |
|
|
1719 | Sets the maximum number of outstanding requests to C<$nreqs>. If |
|
|
1720 | you do queue up more than this number of requests, the next call to |
|
|
1721 | C<IO::AIO::poll_cb> (and other functions calling C<poll_cb>, such as |
|
|
1722 | C<IO::AIO::flush> or C<IO::AIO::poll>) will block until the limit is no |
|
|
1723 | longer exceeded. |
|
|
1724 | |
|
|
1725 | In other words, this setting does not enforce a queue limit, but can be |
|
|
1726 | used to make poll functions block if the limit is exceeded. |
1354 | |
1727 | |
1355 | This is a very bad function to use in interactive programs because it |
1728 | This is a very bad function to use in interactive programs because it |
1356 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1729 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
1357 | use an C<aio_group> together with a feed callback. |
1730 | use an C<aio_group> together with a feed callback. |
1358 | |
1731 | |
1359 | Sets the maximum number of outstanding requests to C<$nreqs>. If you |
1732 | It's main use is in scripts without an event loop - when you want to stat |
1360 | do queue up more than this number of requests, the next call to the |
1733 | a lot of files, you can write somehting like this: |
1361 | C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) |
|
|
1362 | function will block until the limit is no longer exceeded. |
|
|
1363 | |
1734 | |
1364 | The default value is very large, so there is no practical limit on the |
1735 | IO::AIO::max_outstanding 32; |
1365 | number of outstanding requests. |
|
|
1366 | |
1736 | |
1367 | You can still queue as many requests as you want. Therefore, |
1737 | for my $path (...) { |
1368 | C<max_outstanding> is mainly useful in simple scripts (with low values) or |
1738 | aio_stat $path , ...; |
1369 | as a stop gap to shield against fatal memory overflow (with large values). |
1739 | IO::AIO::poll_cb; |
|
|
1740 | } |
|
|
1741 | |
|
|
1742 | IO::AIO::flush; |
|
|
1743 | |
|
|
1744 | The call to C<poll_cb> inside the loop will normally return instantly, but |
|
|
1745 | as soon as more thna C<32> reqeusts are in-flight, it will block until |
|
|
1746 | some requests have been handled. This keeps the loop from pushing a large |
|
|
1747 | number of C<aio_stat> requests onto the queue. |
|
|
1748 | |
|
|
1749 | The default value for C<max_outstanding> is very large, so there is no |
|
|
1750 | practical limit on the number of outstanding requests. |
1370 | |
1751 | |
1371 | =back |
1752 | =back |
1372 | |
1753 | |
1373 | =head3 STATISTICAL INFORMATION |
1754 | =head3 STATISTICAL INFORMATION |
1374 | |
1755 | |
… | |
… | |
1394 | Returns the number of requests currently in the pending state (executed, |
1775 | Returns the number of requests currently in the pending state (executed, |
1395 | but not yet processed by poll_cb). |
1776 | but not yet processed by poll_cb). |
1396 | |
1777 | |
1397 | =back |
1778 | =back |
1398 | |
1779 | |
|
|
1780 | =head3 MISCELLANEOUS FUNCTIONS |
|
|
1781 | |
|
|
1782 | IO::AIO implements some functions that might be useful, but are not |
|
|
1783 | asynchronous. |
|
|
1784 | |
|
|
1785 | =over 4 |
|
|
1786 | |
|
|
1787 | =item IO::AIO::sendfile $ofh, $ifh, $offset, $count |
|
|
1788 | |
|
|
1789 | Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>, |
|
|
1790 | but is blocking (this makes most sense if you know the input data is |
|
|
1791 | likely cached already and the output filehandle is set to non-blocking |
|
|
1792 | operations). |
|
|
1793 | |
|
|
1794 | Returns the number of bytes copied, or C<-1> on error. |
|
|
1795 | |
|
|
1796 | =item IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
1797 | |
|
|
1798 | Simply calls the C<posix_fadvise> function (see its |
|
|
1799 | manpage for details). The following advice constants are |
|
|
1800 | available: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, |
|
|
1801 | C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, |
|
|
1802 | C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. |
|
|
1803 | |
|
|
1804 | On systems that do not implement C<posix_fadvise>, this function returns |
|
|
1805 | ENOSYS, otherwise the return value of C<posix_fadvise>. |
|
|
1806 | |
|
|
1807 | =item IO::AIO::madvise $scalar, $offset, $len, $advice |
|
|
1808 | |
|
|
1809 | Simply calls the C<posix_madvise> function (see its |
|
|
1810 | manpage for details). The following advice constants are |
|
|
1811 | available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>, |
|
|
1812 | C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>. |
|
|
1813 | |
|
|
1814 | On systems that do not implement C<posix_madvise>, this function returns |
|
|
1815 | ENOSYS, otherwise the return value of C<posix_madvise>. |
|
|
1816 | |
|
|
1817 | =item IO::AIO::mprotect $scalar, $offset, $len, $protect |
|
|
1818 | |
|
|
1819 | Simply calls the C<mprotect> function on the preferably AIO::mmap'ed |
|
|
1820 | $scalar (see its manpage for details). The following protect |
|
|
1821 | constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>, |
|
|
1822 | C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>. |
|
|
1823 | |
|
|
1824 | On systems that do not implement C<mprotect>, this function returns |
|
|
1825 | ENOSYS, otherwise the return value of C<mprotect>. |
|
|
1826 | |
|
|
1827 | =item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] |
|
|
1828 | |
|
|
1829 | Memory-maps a file (or anonymous memory range) and attaches it to the |
|
|
1830 | given C<$scalar>, which will act like a string scalar. |
|
|
1831 | |
|
|
1832 | The only operations allowed on the scalar are C<substr>/C<vec> that don't |
|
|
1833 | change the string length, and most read-only operations such as copying it |
|
|
1834 | or searching it with regexes and so on. |
|
|
1835 | |
|
|
1836 | Anything else is unsafe and will, at best, result in memory leaks. |
|
|
1837 | |
|
|
1838 | The memory map associated with the C<$scalar> is automatically removed |
|
|
1839 | when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or |
|
|
1840 | C<IO::AIO::munmap> functions are called. |
|
|
1841 | |
|
|
1842 | This calls the C<mmap>(2) function internally. See your system's manual |
|
|
1843 | page for details on the C<$length>, C<$prot> and C<$flags> parameters. |
|
|
1844 | |
|
|
1845 | The C<$length> must be larger than zero and smaller than the actual |
|
|
1846 | filesize. |
|
|
1847 | |
|
|
1848 | C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>, |
|
|
1849 | C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>, |
|
|
1850 | |
|
|
1851 | C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or |
|
|
1852 | C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when |
|
|
1853 | not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS> |
|
|
1854 | (which is set to C<MAP_ANON> if your system only provides this |
|
|
1855 | constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>, |
|
|
1856 | C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or |
|
|
1857 | C<IO::AIO::MAP_NONBLOCK> |
|
|
1858 | |
|
|
1859 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
|
|
1860 | |
|
|
1861 | C<$offset> is the offset from the start of the file - it generally must be |
|
|
1862 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
|
|
1863 | |
|
|
1864 | Example: |
|
|
1865 | |
|
|
1866 | use Digest::MD5; |
|
|
1867 | use IO::AIO; |
|
|
1868 | |
|
|
1869 | open my $fh, "<verybigfile" |
|
|
1870 | or die "$!"; |
|
|
1871 | |
|
|
1872 | IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh |
|
|
1873 | or die "verybigfile: $!"; |
|
|
1874 | |
|
|
1875 | my $fast_md5 = md5 $data; |
|
|
1876 | |
|
|
1877 | =item IO::AIO::munmap $scalar |
|
|
1878 | |
|
|
1879 | Removes a previous mmap and undefines the C<$scalar>. |
|
|
1880 | |
|
|
1881 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
|
|
1882 | |
|
|
1883 | Calls the C<munlock> function, undoing the effects of a previous |
|
|
1884 | C<aio_mlock> call (see its description for details). |
|
|
1885 | |
|
|
1886 | =item IO::AIO::munlockall |
|
|
1887 | |
|
|
1888 | Calls the C<munlockall> function. |
|
|
1889 | |
|
|
1890 | On systems that do not implement C<munlockall>, this function returns |
|
|
1891 | ENOSYS, otherwise the return value of C<munlockall>. |
|
|
1892 | |
|
|
1893 | =back |
|
|
1894 | |
1399 | =cut |
1895 | =cut |
1400 | |
1896 | |
1401 | min_parallel 8; |
1897 | min_parallel 8; |
1402 | |
1898 | |
1403 | END { flush } |
1899 | END { flush } |
1404 | |
1900 | |
1405 | 1; |
1901 | 1; |
1406 | |
1902 | |
|
|
1903 | =head1 EVENT LOOP INTEGRATION |
|
|
1904 | |
|
|
1905 | It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO |
|
|
1906 | automatically into many event loops: |
|
|
1907 | |
|
|
1908 | # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...) |
|
|
1909 | use AnyEvent::AIO; |
|
|
1910 | |
|
|
1911 | You can also integrate IO::AIO manually into many event loops, here are |
|
|
1912 | some examples of how to do this: |
|
|
1913 | |
|
|
1914 | # EV integration |
|
|
1915 | my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; |
|
|
1916 | |
|
|
1917 | # Event integration |
|
|
1918 | Event->io (fd => IO::AIO::poll_fileno, |
|
|
1919 | poll => 'r', |
|
|
1920 | cb => \&IO::AIO::poll_cb); |
|
|
1921 | |
|
|
1922 | # Glib/Gtk2 integration |
|
|
1923 | add_watch Glib::IO IO::AIO::poll_fileno, |
|
|
1924 | in => sub { IO::AIO::poll_cb; 1 }; |
|
|
1925 | |
|
|
1926 | # Tk integration |
|
|
1927 | Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "", |
|
|
1928 | readable => \&IO::AIO::poll_cb); |
|
|
1929 | |
|
|
1930 | # Danga::Socket integration |
|
|
1931 | Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => |
|
|
1932 | \&IO::AIO::poll_cb); |
|
|
1933 | |
1407 | =head2 FORK BEHAVIOUR |
1934 | =head2 FORK BEHAVIOUR |
1408 | |
1935 | |
1409 | This module should do "the right thing" when the process using it forks: |
1936 | Usage of pthreads in a program changes the semantics of fork |
|
|
1937 | considerably. Specifically, only async-safe functions can be called after |
|
|
1938 | fork. Perl doesn't know about this, so in general, you cannot call fork |
|
|
1939 | with defined behaviour in perl if pthreads are involved. IO::AIO uses |
|
|
1940 | pthreads, so this applies, but many other extensions and (for inexplicable |
|
|
1941 | reasons) perl itself often is linked against pthreads, so this limitation |
|
|
1942 | applies to quite a lot of perls. |
1410 | |
1943 | |
1411 | Before the fork, IO::AIO enters a quiescent state where no requests |
1944 | This module no longer tries to fight your OS, or POSIX. That means IO::AIO |
1412 | can be added in other threads and no results will be processed. After |
1945 | only works in the process that loaded it. Forking is fully supported, but |
1413 | the fork the parent simply leaves the quiescent state and continues |
1946 | using IO::AIO in the child is not. |
1414 | request/result processing, while the child frees the request/result queue |
|
|
1415 | (so that the requests started before the fork will only be handled in the |
|
|
1416 | parent). Threads will be started on demand until the limit set in the |
|
|
1417 | parent process has been reached again. |
|
|
1418 | |
1947 | |
1419 | In short: the parent will, after a short pause, continue as if fork had |
1948 | You might get around by not I<using> IO::AIO before (or after) |
1420 | not been called, while the child will act as if IO::AIO has not been used |
1949 | forking. You could also try to call the L<IO::AIO::reinit> function in the |
1421 | yet. |
1950 | child: |
|
|
1951 | |
|
|
1952 | =over 4 |
|
|
1953 | |
|
|
1954 | =item IO::AIO::reinit |
|
|
1955 | |
|
|
1956 | Abandons all current requests and I/O threads and simply reinitialises all |
|
|
1957 | data structures. This is not an operation supported by any standards, but |
|
|
1958 | happens to work on GNU/Linux and some newer BSD systems. |
|
|
1959 | |
|
|
1960 | The only reasonable use for this function is to call it after forking, if |
|
|
1961 | C<IO::AIO> was used in the parent. Calling it while IO::AIO is active in |
|
|
1962 | the process will result in undefined behaviour. Calling it at any time |
|
|
1963 | will also result in any undefined (by POSIX) behaviour. |
|
|
1964 | |
|
|
1965 | =back |
1422 | |
1966 | |
1423 | =head2 MEMORY USAGE |
1967 | =head2 MEMORY USAGE |
1424 | |
1968 | |
1425 | Per-request usage: |
1969 | Per-request usage: |
1426 | |
1970 | |