ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/IO-AIO/README
(Generate patch)

Comparing IO-AIO/README (file contents):
Revision 1.24 by root, Sun Aug 5 16:45:54 2007 UTC vs.
Revision 1.54 by root, Sun Jan 6 11:48:14 2013 UTC

… …
2 IO::AIO - Asynchronous Input/Output 2 IO::AIO - Asynchronous Input/Output
3 3
4SYNOPSIS 4SYNOPSIS
5 use IO::AIO; 5 use IO::AIO;
6 6
7 aio_open "/etc/passwd", O_RDONLY, 0, sub { 7 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
8 my $fh = shift 8 my $fh = shift
9 or die "/etc/passwd: $!"; 9 or die "/etc/passwd: $!";
10 ... 10 ...
11 }; 11 };
12 12
… …
24 $req->cancel; # cancel request if still in queue 24 $req->cancel; # cancel request if still in queue
25 25
26 my $grp = aio_group sub { print "all stats done\n" }; 26 my $grp = aio_group sub { print "all stats done\n" };
27 add $grp aio_stat "..." for ...; 27 add $grp aio_stat "..." for ...;
28 28
29 # AnyEvent integration
30 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
31 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
32
33 # Event integration
34 Event->io (fd => IO::AIO::poll_fileno,
35 poll => 'r',
36 cb => \&IO::AIO::poll_cb);
37
38 # Glib/Gtk2 integration
39 add_watch Glib::IO IO::AIO::poll_fileno,
40 in => sub { IO::AIO::poll_cb; 1 };
41
42 # Tk integration
43 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
44 readable => \&IO::AIO::poll_cb);
45
46 # Danga::Socket integration
47 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
48 \&IO::AIO::poll_cb);
49
50DESCRIPTION 29DESCRIPTION
51 This module implements asynchronous I/O using whatever means your 30 This module implements asynchronous I/O using whatever means your
52 operating system supports. 31 operating system supports. It is implemented as an interface to "libeio"
32 (<http://software.schmorp.de/pkg/libeio.html>).
53 33
54 Asynchronous means that operations that can normally block your program 34 Asynchronous means that operations that can normally block your program
55 (e.g. reading from disk) will be done asynchronously: the operation will 35 (e.g. reading from disk) will be done asynchronously: the operation will
56 still block, but you can do something else in the meantime. This is 36 still block, but you can do something else in the meantime. This is
57 extremely useful for programs that need to stay interactive even when 37 extremely useful for programs that need to stay interactive even when
… …
62 operations concurrently. 42 operations concurrently.
63 43
64 While most of this works on all types of file descriptors (for example 44 While most of this works on all types of file descriptors (for example
65 sockets), using these functions on file descriptors that support 45 sockets), using these functions on file descriptors that support
66 nonblocking operation (again, sockets, pipes etc.) is very inefficient. 46 nonblocking operation (again, sockets, pipes etc.) is very inefficient.
67 Use an event loop for that (such as the Event module): IO::AIO will 47 Use an event loop for that (such as the EV module): IO::AIO will
68 naturally fit into such an event loop itself. 48 naturally fit into such an event loop itself.
69 49
70 In this version, a number of threads are started that execute your 50 In this version, a number of threads are started that execute your
71 requests and signal their completion. You don't need thread support in 51 requests and signal their completion. You don't need thread support in
72 perl, and the threads created by this module will not be visible to 52 perl, and the threads created by this module will not be visible to
… …
81 it is currently not reentrant in any way, so use appropriate locking 61 it is currently not reentrant in any way, so use appropriate locking
82 yourself, always call "poll_cb" from within the same thread, or never 62 yourself, always call "poll_cb" from within the same thread, or never
83 call "poll_cb" (or other "aio_" functions) recursively. 63 call "poll_cb" (or other "aio_" functions) recursively.
84 64
85 EXAMPLE 65 EXAMPLE
86 This is a simple example that uses the Event module and loads 66 This is a simple example that uses the EV module and loads /etc/passwd
87 /etc/passwd asynchronously: 67 asynchronously:
88 68
89 use Fcntl; 69 use Fcntl;
90 use Event; 70 use EV;
91 use IO::AIO; 71 use IO::AIO;
92 72
93 # register the IO::AIO callback with Event 73 # register the IO::AIO callback with EV
94 Event->io (fd => IO::AIO::poll_fileno, 74 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
95 poll => 'r',
96 cb => \&IO::AIO::poll_cb);
97 75
98 # queue the request to open /etc/passwd 76 # queue the request to open /etc/passwd
99 aio_open "/etc/passwd", O_RDONLY, 0, sub { 77 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
100 my $fh = shift 78 my $fh = shift
101 or die "error while opening: $!"; 79 or die "error while opening: $!";
102 80
103 # stat'ing filehandles is generally non-blocking 81 # stat'ing filehandles is generally non-blocking
104 my $size = -s $fh; 82 my $size = -s $fh;
… …
113 91
114 # file contents now in $contents 92 # file contents now in $contents
115 print $contents; 93 print $contents;
116 94
117 # exit event loop and program 95 # exit event loop and program
118 Event::unloop; 96 EV::unloop;
119 }; 97 };
120 }; 98 };
121 99
122 # possibly queue up other requests, or open GUI windows, 100 # possibly queue up other requests, or open GUI windows,
123 # check for sockets etc. etc. 101 # check for sockets etc. etc.
124 102
125 # process events as long as there are some: 103 # process events as long as there are some:
126 Event::loop; 104 EV::loop;
127 105
128REQUEST ANATOMY AND LIFETIME 106REQUEST ANATOMY AND LIFETIME
129 Every "aio_*" function creates a request. which is a C data structure 107 Every "aio_*" function creates a request. which is a C data structure
130 not directly visible to Perl. 108 not directly visible to Perl.
131 109
… …
167 anymore (except possibly for the Perl object, but its connection to 145 anymore (except possibly for the Perl object, but its connection to
168 the actual aio request is severed and calling its methods will 146 the actual aio request is severed and calling its methods will
169 either do nothing or result in a runtime error). 147 either do nothing or result in a runtime error).
170 148
171FUNCTIONS 149FUNCTIONS
172 AIO REQUEST FUNCTIONS 150 QUICK OVERVIEW
151 This section simply lists the prototypes most of the functions for quick
152 reference. See the following sections for function-by-function
153 documentation.
154
155 aio_wd $pathname, $callback->($wd)
156 aio_open $pathname, $flags, $mode, $callback->($fh)
157 aio_close $fh, $callback->($status)
158 aio_seek $fh,$offset,$whence, $callback->($offs)
159 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
160 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
161 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
162 aio_readahead $fh,$offset,$length, $callback->($retval)
163 aio_stat $fh_or_path, $callback->($status)
164 aio_lstat $fh, $callback->($status)
165 aio_statvfs $fh_or_path, $callback->($statvfs)
166 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
167 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
168 aio_chmod $fh_or_path, $mode, $callback->($status)
169 aio_truncate $fh_or_path, $offset, $callback->($status)
170 aio_allocate $fh, $mode, $offset, $len, $callback->($status)
171 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
172 aio_unlink $pathname, $callback->($status)
173 aio_mknod $pathname, $mode, $dev, $callback->($status)
174 aio_link $srcpath, $dstpath, $callback->($status)
175 aio_symlink $srcpath, $dstpath, $callback->($status)
176 aio_readlink $pathname, $callback->($link)
177 aio_realpath $pathname, $callback->($link)
178 aio_rename $srcpath, $dstpath, $callback->($status)
179 aio_mkdir $pathname, $mode, $callback->($status)
180 aio_rmdir $pathname, $callback->($status)
181 aio_readdir $pathname, $callback->($entries)
182 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
183 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
184 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
185 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
186 aio_load $pathname, $data, $callback->($status)
187 aio_copy $srcpath, $dstpath, $callback->($status)
188 aio_move $srcpath, $dstpath, $callback->($status)
189 aio_rmtree $pathname, $callback->($status)
190 aio_sync $callback->($status)
191 aio_syncfs $fh, $callback->($status)
192 aio_fsync $fh, $callback->($status)
193 aio_fdatasync $fh, $callback->($status)
194 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
195 aio_pathsync $pathname, $callback->($status)
196 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
197 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
198 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
199 aio_mlockall $flags, $callback->($status)
200 aio_group $callback->(...)
201 aio_nop $callback->()
202
203 $prev_pri = aioreq_pri [$pri]
204 aioreq_nice $pri_adjust
205
206 IO::AIO::poll_wait
207 IO::AIO::poll_cb
208 IO::AIO::poll
209 IO::AIO::flush
210 IO::AIO::max_poll_reqs $nreqs
211 IO::AIO::max_poll_time $seconds
212 IO::AIO::min_parallel $nthreads
213 IO::AIO::max_parallel $nthreads
214 IO::AIO::max_idle $nthreads
215 IO::AIO::idle_timeout $seconds
216 IO::AIO::max_outstanding $maxreqs
217 IO::AIO::nreqs
218 IO::AIO::nready
219 IO::AIO::npending
220
221 IO::AIO::sendfile $ofh, $ifh, $offset, $count
222 IO::AIO::fadvise $fh, $offset, $len, $advice
223 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
224 IO::AIO::munmap $scalar
225 IO::AIO::madvise $scalar, $offset, $length, $advice
226 IO::AIO::mprotect $scalar, $offset, $length, $protect
227 IO::AIO::munlock $scalar, $offset = 0, $length = undef
228 IO::AIO::munlockall
229
230 API NOTES
173 All the "aio_*" calls are more or less thin wrappers around the syscall 231 All the "aio_*" calls are more or less thin wrappers around the syscall
174 with the same name (sans "aio_"). The arguments are similar or 232 with the same name (sans "aio_"). The arguments are similar or
175 identical, and they all accept an additional (and optional) $callback 233 identical, and they all accept an additional (and optional) $callback
176 argument which must be a code reference. This code reference will get 234 argument which must be a code reference. This code reference will be
177 called with the syscall return code (e.g. most syscalls return -1 on 235 called after the syscall has been executed in an asynchronous fashion.
178 error, unlike perl, which usually delivers "false") as it's sole 236 The results of the request will be passed as arguments to the callback
179 argument when the given syscall has been executed asynchronously. 237 (and, if an error occured, in $!) - for most requests the syscall return
238 code (e.g. most syscalls return -1 on error, unlike perl, which usually
239 delivers "false").
240
241 Some requests (such as "aio_readdir") pass the actual results and
242 communicate failures by passing "undef".
180 243
181 All functions expecting a filehandle keep a copy of the filehandle 244 All functions expecting a filehandle keep a copy of the filehandle
182 internally until the request has finished. 245 internally until the request has finished.
183 246
184 All functions return request objects of type IO::AIO::REQ that allow 247 All functions return request objects of type IO::AIO::REQ that allow
185 further manipulation of those requests while they are in-flight. 248 further manipulation of those requests while they are in-flight.
186 249
187 The pathnames you pass to these routines *must* be absolute and encoded 250 The pathnames you pass to these routines *should* be absolute. The
188 as octets. The reason for the former is that at the time the request is 251 reason for this is that at the time the request is being executed, the
189 being executed, the current working directory could have changed. 252 current working directory could have changed. Alternatively, you can
190 Alternatively, you can make sure that you never change the current 253 make sure that you never change the current working directory anywhere
191 working directory anywhere in the program and then use relative paths. 254 in the program and then use relative paths. You can also take advantage
255 of IO::AIOs working directory abstraction, that lets you specify paths
256 relative to some previously-opened "working directory object" - see the
257 description of the "IO::AIO::WD" class later in this document.
192 258
193 To encode pathnames as octets, either make sure you either: a) always 259 To encode pathnames as octets, either make sure you either: a) always
194 pass in filenames you got from outside (command line, readdir etc.) 260 pass in filenames you got from outside (command line, readdir etc.)
195 without tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module 261 without tinkering, b) are in your native filesystem encoding, c) use the
196 and encode your pathnames to the locale (or other) encoding in effect in 262 Encode module and encode your pathnames to the locale (or other)
197 the user environment, d) use Glib::filename_from_unicode on unicode 263 encoding in effect in the user environment, d) use
198 filenames or e) use something else to ensure your scalar has the correct 264 Glib::filename_from_unicode on unicode filenames or e) use something
199 contents. 265 else to ensure your scalar has the correct contents.
200 266
201 This works, btw. independent of the internal UTF-8 bit, which IO::AIO 267 This works, btw. independent of the internal UTF-8 bit, which IO::AIO
202 handles correctly wether it is set or not. 268 handles correctly whether it is set or not.
203 269
270 AIO REQUEST FUNCTIONS
204 $prev_pri = aioreq_pri [$pri] 271 $prev_pri = aioreq_pri [$pri]
205 Returns the priority value that would be used for the next request 272 Returns the priority value that would be used for the next request
206 and, if $pri is given, sets the priority for the next aio request. 273 and, if $pri is given, sets the priority for the next aio request.
207 274
208 The default priority is 0, the minimum and maximum priorities are -4 275 The default priority is 0, the minimum and maximum priorities are -4
… …
230 Similar to "aioreq_pri", but subtracts the given value from the 297 Similar to "aioreq_pri", but subtracts the given value from the
231 current priority, so the effect is cumulative. 298 current priority, so the effect is cumulative.
232 299
233 aio_open $pathname, $flags, $mode, $callback->($fh) 300 aio_open $pathname, $flags, $mode, $callback->($fh)
234 Asynchronously open or create a file and call the callback with a 301 Asynchronously open or create a file and call the callback with a
235 newly created filehandle for the file. 302 newly created filehandle for the file (or "undef" in case of an
303 error).
236 304
237 The pathname passed to "aio_open" must be absolute. See API NOTES, 305 The pathname passed to "aio_open" must be absolute. See API NOTES,
238 above, for an explanation. 306 above, for an explanation.
239 307
240 The $flags argument is a bitmask. See the "Fcntl" module for a list. 308 The $flags argument is a bitmask. See the "Fcntl" module for a list.
… …
247 will be modified by the umask in effect then the request is being 315 will be modified by the umask in effect then the request is being
248 executed, so better never change the umask. 316 executed, so better never change the umask.
249 317
250 Example: 318 Example:
251 319
252 aio_open "/etc/passwd", O_RDONLY, 0, sub { 320 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
253 if ($_[0]) { 321 if ($_[0]) {
254 print "open successful, fh is $_[0]\n"; 322 print "open successful, fh is $_[0]\n";
255 ... 323 ...
256 } else { 324 } else {
257 die "open failed: $!\n"; 325 die "open failed: $!\n";
258 } 326 }
259 }; 327 };
260 328
329 In addition to all the common open modes/flags ("O_RDONLY",
330 "O_WRONLY", "O_RDWR", "O_CREAT", "O_TRUNC", "O_EXCL" and
331 "O_APPEND"), the following POSIX and non-POSIX constants are
332 available (missing ones on your system are, as usual, 0):
333
334 "O_ASYNC", "O_DIRECT", "O_NOATIME", "O_CLOEXEC", "O_NOCTTY",
335 "O_NOFOLLOW", "O_NONBLOCK", "O_EXEC", "O_SEARCH", "O_DIRECTORY",
336 "O_DSYNC", "O_RSYNC", "O_SYNC" and "O_TTY_INIT".
337
261 aio_close $fh, $callback->($status) 338 aio_close $fh, $callback->($status)
262 Asynchronously close a file and call the callback with the result 339 Asynchronously close a file and call the callback with the result
263 code. *WARNING:* although accepted, you should not pass in a perl 340 code.
264 filehandle here, as perl will likely close the file descriptor
265 another time when the filehandle is destroyed. Normally, you can
266 safely call perls "close" or just let filehandles go out of scope.
267 341
268 This is supposed to be a bug in the API, so that might change. It's 342 Unfortunately, you can't do this to perl. Perl *insists* very
269 therefore best to avoid this function. 343 strongly on closing the file descriptor associated with the
344 filehandle itself.
345
346 Therefore, "aio_close" will not close the filehandle - instead it
347 will use dup2 to overwrite the file descriptor with the write-end of
348 a pipe (the pipe fd will be created on demand and will be cached).
349
350 Or in other words: the file descriptor will be closed, but it will
351 not be free for reuse until the perl filehandle is closed.
352
353 aio_seek $fh, $offset, $whence, $callback->($offs)
354 Seeks the filehandle to the new $offset, similarly to perl's
355 "sysseek". The $whence can use the traditional values (0 for
356 "IO::AIO::SEEK_SET", 1 for "IO::AIO::SEEK_CUR" or 2 for
357 "IO::AIO::SEEK_END").
358
359 The resulting absolute offset will be passed to the callback, or -1
360 in case of an error.
361
362 In theory, the $whence constants could be different than the
363 corresponding values from Fcntl, but perl guarantees they are the
364 same, so don't panic.
365
366 As a GNU/Linux (and maybe Solaris) extension, also the constants
367 "IO::AIO::SEEK_DATA" and "IO::AIO::SEEK_HOLE" are available, if they
368 could be found. No guarantees about suitability for use in
369 "aio_seek" or Perl's "sysseek" can be made though, although I would
370 naively assume they "just work".
270 371
271 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 372 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
272 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 373 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
273 Reads or writes $length bytes from the specified $fh and $offset 374 Reads or writes $length bytes from or to the specified $fh and
274 into the scalar given by $data and offset $dataoffset and calls the 375 $offset into the scalar given by $data and offset $dataoffset and
275 callback without the actual number of bytes read (or -1 on error, 376 calls the callback without the actual number of bytes read (or -1 on
276 just like the syscall). 377 error, just like the syscall).
277 378
379 "aio_read" will, like "sysread", shrink or grow the $data scalar to
380 offset plus the actual number of bytes read.
381
278 If $offset is undefined, then the current file offset will be used 382 If $offset is undefined, then the current file descriptor offset
279 (and updated), otherwise the file offset will not be changed by 383 will be used (and updated), otherwise the file descriptor offset
280 these calls. 384 will not be changed by these calls.
281 385
282 If $length is undefined in "aio_write", use the remaining length of 386 If $length is undefined in "aio_write", use the remaining length of
283 $data. 387 $data.
284 388
285 If $dataoffset is less than zero, it will be counted from the end of 389 If $dataoffset is less than zero, it will be counted from the end of
… …
300 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 404 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
301 Tries to copy $length bytes from $in_fh to $out_fh. It starts 405 Tries to copy $length bytes from $in_fh to $out_fh. It starts
302 reading at byte offset $in_offset, and starts writing at the current 406 reading at byte offset $in_offset, and starts writing at the current
303 file offset of $out_fh. Because of that, it is not safe to issue 407 file offset of $out_fh. Because of that, it is not safe to issue
304 more than one "aio_sendfile" per $out_fh, as they will interfere 408 more than one "aio_sendfile" per $out_fh, as they will interfere
305 with each other. 409 with each other. The same $in_fh works fine though, as this function
410 does not move or use the file offset of $in_fh.
306 411
412 Please note that "aio_sendfile" can read more bytes from $in_fh than
413 are written, and there is no way to find out how many more bytes
414 have been read from "aio_sendfile" alone, as "aio_sendfile" only
415 provides the number of bytes written to $out_fh. Only if the result
416 value equals $length one can assume that $length bytes have been
417 read.
418
419 Unlike with other "aio_" functions, it makes a lot of sense to use
420 "aio_sendfile" on non-blocking sockets, as long as one end
421 (typically the $in_fh) is a file - the file I/O will then be
422 asynchronous, while the socket I/O will be non-blocking. Note,
423 however, that you can run into a trap where "aio_sendfile" reads
424 some data with readahead, then fails to write all data, and when the
425 socket is ready the next time, the data in the cache is already
426 lost, forcing "aio_sendfile" to again hit the disk. Explicit
427 "aio_read" + "aio_write" let's you better control resource usage.
428
307 This call tries to make use of a native "sendfile" syscall to 429 This call tries to make use of a native "sendfile"-like syscall to
308 provide zero-copy operation. For this to work, $out_fh should refer 430 provide zero-copy operation. For this to work, $out_fh should refer
309 to a socket, and $in_fh should refer to mmap'able file. 431 to a socket, and $in_fh should refer to an mmap'able file.
310 432
311 If the native sendfile call fails or is not implemented, it will be 433 If a native sendfile cannot be found or it fails with "ENOSYS",
312 emulated, so you can call "aio_sendfile" on any type of filehandle 434 "EINVAL", "ENOTSUP", "EOPNOTSUPP", "EAFNOSUPPORT", "EPROTOTYPE" or
313 regardless of the limitations of the operating system. 435 "ENOTSOCK", it will be emulated, so you can call "aio_sendfile" on
436 any type of filehandle regardless of the limitations of the
437 operating system.
314 438
315 Please note, however, that "aio_sendfile" can read more bytes from 439 As native sendfile syscalls (as practically any non-POSIX interface
316 $in_fh than are written, and there is no way to find out how many 440 hacked together in a hurry to improve benchmark numbers) tend to be
317 bytes have been read from "aio_sendfile" alone, as "aio_sendfile" 441 rather buggy on many systems, this implementation tries to work
318 only provides the number of bytes written to $out_fh. Only if the 442 around some known bugs in Linux and FreeBSD kernels (probably
319 result value equals $length one can assume that $length bytes have 443 others, too), but that might fail, so you really really should check
320 been read. 444 the return value of "aio_sendfile" - fewre bytes than expected might
445 have been transferred.
321 446
322 aio_readahead $fh,$offset,$length, $callback->($retval) 447 aio_readahead $fh,$offset,$length, $callback->($retval)
323 "aio_readahead" populates the page cache with data from a file so 448 "aio_readahead" populates the page cache with data from a file so
324 that subsequent reads from that file will not block on disk I/O. The 449 that subsequent reads from that file will not block on disk I/O. The
325 $offset argument specifies the starting point from which data is to 450 $offset argument specifies the starting point from which data is to
… …
346 Currently, the stats are always 64-bit-stats, i.e. instead of 471 Currently, the stats are always 64-bit-stats, i.e. instead of
347 returning an error when stat'ing a large file, the results will be 472 returning an error when stat'ing a large file, the results will be
348 silently truncated unless perl itself is compiled with large file 473 silently truncated unless perl itself is compiled with large file
349 support. 474 support.
350 475
476 To help interpret the mode and dev/rdev stat values, IO::AIO offers
477 the following constants and functions (if not implemented, the
478 constants will be 0 and the functions will either "croak" or fall
479 back on traditional behaviour).
480
481 "S_IFMT", "S_IFIFO", "S_IFCHR", "S_IFBLK", "S_IFLNK", "S_IFREG",
482 "S_IFDIR", "S_IFWHT", "S_IFSOCK", "IO::AIO::major $dev_t",
483 "IO::AIO::minor $dev_t", "IO::AIO::makedev $major, $minor".
484
351 Example: Print the length of /etc/passwd: 485 Example: Print the length of /etc/passwd:
352 486
353 aio_stat "/etc/passwd", sub { 487 aio_stat "/etc/passwd", sub {
354 $_[0] and die "stat failed: $!"; 488 $_[0] and die "stat failed: $!";
355 print "size is ", -s _, "\n"; 489 print "size is ", -s _, "\n";
356 }; 490 };
357 491
492 aio_statvfs $fh_or_path, $callback->($statvfs)
493 Works like the POSIX "statvfs" or "fstatvfs" syscalls, depending on
494 whether a file handle or path was passed.
495
496 On success, the callback is passed a hash reference with the
497 following members: "bsize", "frsize", "blocks", "bfree", "bavail",
498 "files", "ffree", "favail", "fsid", "flag" and "namemax". On
499 failure, "undef" is passed.
500
501 The following POSIX IO::AIO::ST_* constants are defined: "ST_RDONLY"
502 and "ST_NOSUID".
503
504 The following non-POSIX IO::AIO::ST_* flag masks are defined to
505 their correct value when available, or to 0 on systems that do not
506 support them: "ST_NODEV", "ST_NOEXEC", "ST_SYNCHRONOUS",
507 "ST_MANDLOCK", "ST_WRITE", "ST_APPEND", "ST_IMMUTABLE",
508 "ST_NOATIME", "ST_NODIRATIME" and "ST_RELATIME".
509
510 Example: stat "/wd" and dump out the data if successful.
511
512 aio_statvfs "/wd", sub {
513 my $f = $_[0]
514 or die "statvfs: $!";
515
516 use Data::Dumper;
517 say Dumper $f;
518 };
519
520 # result:
521 {
522 bsize => 1024,
523 bfree => 4333064312,
524 blocks => 10253828096,
525 files => 2050765568,
526 flag => 4096,
527 favail => 2042092649,
528 bavail => 4333064312,
529 ffree => 2042092649,
530 namemax => 255,
531 frsize => 1024,
532 fsid => 1810
533 }
534
535 Here is a (likely partial) list of fsid values used by Linux - it is
536 safe to hardcode these when the $^O is "linux":
537
538 0x0000adf5 adfs
539 0x0000adff affs
540 0x5346414f afs
541 0x09041934 anon-inode filesystem
542 0x00000187 autofs
543 0x42465331 befs
544 0x1badface bfs
545 0x42494e4d binfmt_misc
546 0x9123683e btrfs
547 0x0027e0eb cgroupfs
548 0xff534d42 cifs
549 0x73757245 coda
550 0x012ff7b7 coh
551 0x28cd3d45 cramfs
552 0x453dcd28 cramfs-wend (wrong endianness)
553 0x64626720 debugfs
554 0x00001373 devfs
555 0x00001cd1 devpts
556 0x0000f15f ecryptfs
557 0x00414a53 efs
558 0x0000137d ext
559 0x0000ef53 ext2/ext3
560 0x0000ef51 ext2
561 0x00004006 fat
562 0x65735546 fuseblk
563 0x65735543 fusectl
564 0x0bad1dea futexfs
565 0x01161970 gfs2
566 0x47504653 gpfs
567 0x00004244 hfs
568 0xf995e849 hpfs
569 0x958458f6 hugetlbfs
570 0x2bad1dea inotifyfs
571 0x00009660 isofs
572 0x000072b6 jffs2
573 0x3153464a jfs
574 0x6b414653 k-afs
575 0x0bd00bd0 lustre
576 0x0000137f minix
577 0x0000138f minix 30 char names
578 0x00002468 minix v2
579 0x00002478 minix v2 30 char names
580 0x00004d5a minix v3
581 0x19800202 mqueue
582 0x00004d44 msdos
583 0x0000564c novell
584 0x00006969 nfs
585 0x6e667364 nfsd
586 0x00003434 nilfs
587 0x5346544e ntfs
588 0x00009fa1 openprom
589 0x7461636F ocfs2
590 0x00009fa0 proc
591 0x6165676c pstorefs
592 0x0000002f qnx4
593 0x858458f6 ramfs
594 0x52654973 reiserfs
595 0x00007275 romfs
596 0x67596969 rpc_pipefs
597 0x73636673 securityfs
598 0xf97cff8c selinux
599 0x0000517b smb
600 0x534f434b sockfs
601 0x73717368 squashfs
602 0x62656572 sysfs
603 0x012ff7b6 sysv2
604 0x012ff7b5 sysv4
605 0x01021994 tmpfs
606 0x15013346 udf
607 0x00011954 ufs
608 0x54190100 ufs byteswapped
609 0x00009fa2 usbdevfs
610 0x01021997 v9fs
611 0xa501fcf5 vxfs
612 0xabba1974 xenfs
613 0x012ff7b4 xenix
614 0x58465342 xfs
615 0x012fd16d xia
616
358 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 617 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
359 Works like perl's "utime" function (including the special case of 618 Works like perl's "utime" function (including the special case of
360 $atime and $mtime being undef). Fractional times are supported if 619 $atime and $mtime being undef). Fractional times are supported if
361 the underlying syscalls support them. 620 the underlying syscalls support them.
362 621
… …
384 aio_chown "path", 0, undef; 643 aio_chown "path", 0, undef;
385 644
386 aio_truncate $fh_or_path, $offset, $callback->($status) 645 aio_truncate $fh_or_path, $offset, $callback->($status)
387 Works like truncate(2) or ftruncate(2). 646 Works like truncate(2) or ftruncate(2).
388 647
648 aio_allocate $fh, $mode, $offset, $len, $callback->($status)
649 Allocates or freed disk space according to the $mode argument. See
650 the linux "fallocate" docuemntation for details.
651
652 $mode can currently be 0 or "IO::AIO::FALLOC_FL_KEEP_SIZE" to
653 allocate space, or "IO::AIO::FALLOC_FL_PUNCH_HOLE |
654 IO::AIO::FALLOC_FL_KEEP_SIZE", to deallocate a file range.
655
656 The file system block size used by "fallocate" is presumably the
657 "f_bsize" returned by "statvfs".
658
659 If "fallocate" isn't available or cannot be emulated (currently no
660 emulation will be attempted), passes -1 and sets $! to "ENOSYS".
661
389 aio_chmod $fh_or_path, $mode, $callback->($status) 662 aio_chmod $fh_or_path, $mode, $callback->($status)
390 Works like perl's "chmod" function. 663 Works like perl's "chmod" function.
391 664
392 aio_unlink $pathname, $callback->($status) 665 aio_unlink $pathname, $callback->($status)
393 Asynchronously unlink (delete) a file and call the callback with the 666 Asynchronously unlink (delete) a file and call the callback with the
394 result code. 667 result code.
395 668
396 aio_mknod $path, $mode, $dev, $callback->($status) 669 aio_mknod $pathname, $mode, $dev, $callback->($status)
397 [EXPERIMENTAL] 670 [EXPERIMENTAL]
398 671
399 Asynchronously create a device node (or fifo). See mknod(2). 672 Asynchronously create a device node (or fifo). See mknod(2).
400 673
401 The only (POSIX-) portable way of calling this function is: 674 The only (POSIX-) portable way of calling this function is:
402 675
403 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 676 aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
677
678 See "aio_stat" for info about some potentially helpful extra
679 constants and functions.
404 680
405 aio_link $srcpath, $dstpath, $callback->($status) 681 aio_link $srcpath, $dstpath, $callback->($status)
406 Asynchronously create a new link to the existing object at $srcpath 682 Asynchronously create a new link to the existing object at $srcpath
407 at the path $dstpath and call the callback with the result code. 683 at the path $dstpath and call the callback with the result code.
408 684
409 aio_symlink $srcpath, $dstpath, $callback->($status) 685 aio_symlink $srcpath, $dstpath, $callback->($status)
410 Asynchronously create a new symbolic link to the existing object at 686 Asynchronously create a new symbolic link to the existing object at
411 $srcpath at the path $dstpath and call the callback with the result 687 $srcpath at the path $dstpath and call the callback with the result
412 code. 688 code.
413 689
414 aio_readlink $path, $callback->($link) 690 aio_readlink $pathname, $callback->($link)
415 Asynchronously read the symlink specified by $path and pass it to 691 Asynchronously read the symlink specified by $path and pass it to
416 the callback. If an error occurs, nothing or undef gets passed to 692 the callback. If an error occurs, nothing or undef gets passed to
417 the callback. 693 the callback.
418 694
695 aio_realpath $pathname, $callback->($path)
696 Asynchronously make the path absolute and resolve any symlinks in
697 $path. The resulting path only consists of directories (same as
698 Cwd::realpath).
699
700 This request can be used to get the absolute path of the current
701 working directory by passing it a path of . (a single dot).
702
419 aio_rename $srcpath, $dstpath, $callback->($status) 703 aio_rename $srcpath, $dstpath, $callback->($status)
420 Asynchronously rename the object at $srcpath to $dstpath, just as 704 Asynchronously rename the object at $srcpath to $dstpath, just as
421 rename(2) and call the callback with the result code. 705 rename(2) and call the callback with the result code.
706
707 On systems that support the AIO::WD working directory abstraction
708 natively, the case "[$wd, "."]" as $srcpath is specialcased -
709 instead of failing, "rename" is called on the absolute path of $wd.
422 710
423 aio_mkdir $pathname, $mode, $callback->($status) 711 aio_mkdir $pathname, $mode, $callback->($status)
424 Asynchronously mkdir (create) a directory and call the callback with 712 Asynchronously mkdir (create) a directory and call the callback with
425 the result code. $mode will be modified by the umask at the time the 713 the result code. $mode will be modified by the umask at the time the
426 request is executed, so do not change your umask. 714 request is executed, so do not change your umask.
427 715
428 aio_rmdir $pathname, $callback->($status) 716 aio_rmdir $pathname, $callback->($status)
429 Asynchronously rmdir (delete) a directory and call the callback with 717 Asynchronously rmdir (delete) a directory and call the callback with
430 the result code. 718 the result code.
431 719
720 On systems that support the AIO::WD working directory abstraction
721 natively, the case "[$wd, "."]" is specialcased - instead of
722 failing, "rmdir" is called on the absolute path of $wd.
723
432 aio_readdir $pathname, $callback->($entries) 724 aio_readdir $pathname, $callback->($entries)
433 Unlike the POSIX call of the same name, "aio_readdir" reads an 725 Unlike the POSIX call of the same name, "aio_readdir" reads an
434 entire directory (i.e. opendir + readdir + closedir). The entries 726 entire directory (i.e. opendir + readdir + closedir). The entries
435 will not be sorted, and will NOT include the "." and ".." entries. 727 will not be sorted, and will NOT include the "." and ".." entries.
436 728
437 The callback a single argument which is either "undef" or an 729 The callback is passed a single argument which is either "undef" or
438 array-ref with the filenames. 730 an array-ref with the filenames.
439 731
732 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
733 Quite similar to "aio_readdir", but the $flags argument allows one
734 to tune behaviour and output format. In case of an error, $entries
735 will be "undef".
736
737 The flags are a combination of the following constants, ORed
738 together (the flags will also be passed to the callback, possibly
739 modified):
740
741 IO::AIO::READDIR_DENTS
742 When this flag is off, then the callback gets an arrayref
743 consisting of names only (as with "aio_readdir"), otherwise it
744 gets an arrayref with "[$name, $type, $inode]" arrayrefs, each
745 describing a single directory entry in more detail.
746
747 $name is the name of the entry.
748
749 $type is one of the "IO::AIO::DT_xxx" constants:
750
751 "IO::AIO::DT_UNKNOWN", "IO::AIO::DT_FIFO", "IO::AIO::DT_CHR",
752 "IO::AIO::DT_DIR", "IO::AIO::DT_BLK", "IO::AIO::DT_REG",
753 "IO::AIO::DT_LNK", "IO::AIO::DT_SOCK", "IO::AIO::DT_WHT".
754
755 "IO::AIO::DT_UNKNOWN" means just that: readdir does not know. If
756 you need to know, you have to run stat yourself. Also, for speed
757 reasons, the $type scalars are read-only: you can not modify
758 them.
759
760 $inode is the inode number (which might not be exact on systems
761 with 64 bit inode numbers and 32 bit perls). This field has
762 unspecified content on systems that do not deliver the inode
763 information.
764
765 IO::AIO::READDIR_DIRS_FIRST
766 When this flag is set, then the names will be returned in an
767 order where likely directories come first, in optimal stat
768 order. This is useful when you need to quickly find directories,
769 or you want to find all directories while avoiding to stat()
770 each entry.
771
772 If the system returns type information in readdir, then this is
773 used to find directories directly. Otherwise, likely directories
774 are names beginning with ".", or otherwise names with no dots,
775 of which names with short names are tried first.
776
777 IO::AIO::READDIR_STAT_ORDER
778 When this flag is set, then the names will be returned in an
779 order suitable for stat()'ing each one. That is, when you plan
780 to stat() all files in the given directory, then the returned
781 order will likely be fastest.
782
783 If both this flag and "IO::AIO::READDIR_DIRS_FIRST" are
784 specified, then the likely dirs come first, resulting in a less
785 optimal stat order.
786
787 IO::AIO::READDIR_FOUND_UNKNOWN
788 This flag should not be set when calling "aio_readdirx".
789 Instead, it is being set by "aio_readdirx", when any of the
790 $type's found were "IO::AIO::DT_UNKNOWN". The absence of this
791 flag therefore indicates that all $type's are known, which can
792 be used to speed up some algorithms.
793
440 aio_load $path, $data, $callback->($status) 794 aio_load $pathname, $data, $callback->($status)
441 This is a composite request that tries to fully load the given file 795 This is a composite request that tries to fully load the given file
442 into memory. Status is the same as with aio_read. 796 into memory. Status is the same as with aio_read.
443 797
444 aio_copy $srcpath, $dstpath, $callback->($status) 798 aio_copy $srcpath, $dstpath, $callback->($status)
445 Try to copy the *file* (directories not supported as either source 799 Try to copy the *file* (directories not supported as either source
446 or destination) from $srcpath to $dstpath and call the callback with 800 or destination) from $srcpath to $dstpath and call the callback with
447 the 0 (error) or -1 ok. 801 a status of 0 (ok) or -1 (error, see $!).
448 802
449 This is a composite request that it creates the destination file 803 This is a composite request that creates the destination file with
450 with mode 0200 and copies the contents of the source file into it 804 mode 0200 and copies the contents of the source file into it using
451 using "aio_sendfile", followed by restoring atime, mtime, access 805 "aio_sendfile", followed by restoring atime, mtime, access mode and
452 mode and uid/gid, in that order. 806 uid/gid, in that order.
453 807
454 If an error occurs, the partial destination file will be unlinked, 808 If an error occurs, the partial destination file will be unlinked,
455 if possible, except when setting atime, mtime, access mode and 809 if possible, except when setting atime, mtime, access mode and
456 uid/gid, where errors are being ignored. 810 uid/gid, where errors are being ignored.
457 811
458 aio_move $srcpath, $dstpath, $callback->($status) 812 aio_move $srcpath, $dstpath, $callback->($status)
459 Try to move the *file* (directories not supported as either source 813 Try to move the *file* (directories not supported as either source
460 or destination) from $srcpath to $dstpath and call the callback with 814 or destination) from $srcpath to $dstpath and call the callback with
461 the 0 (error) or -1 ok. 815 a status of 0 (ok) or -1 (error, see $!).
462 816
463 This is a composite request that tries to rename(2) the file first. 817 This is a composite request that tries to rename(2) the file first;
464 If rename files with "EXDEV", it copies the file with "aio_copy" 818 if rename fails with "EXDEV", it copies the file with "aio_copy"
465 and, if that is successful, unlinking the $srcpath. 819 and, if that is successful, unlinks the $srcpath.
466 820
467 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 821 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
468 Scans a directory (similar to "aio_readdir") but additionally tries 822 Scans a directory (similar to "aio_readdir") but additionally tries
469 to efficiently separate the entries of directory $path into two sets 823 to efficiently separate the entries of directory $path into two sets
470 of names, directories you can recurse into (directories), and ones 824 of names, directories you can recurse into (directories), and ones
471 you cannot recurse into (everything else, including symlinks to 825 you cannot recurse into (everything else, including symlinks to
472 directories). 826 directories).
… …
490 Implementation notes. 844 Implementation notes.
491 845
492 The "aio_readdir" cannot be avoided, but "stat()"'ing every entry 846 The "aio_readdir" cannot be avoided, but "stat()"'ing every entry
493 can. 847 can.
494 848
849 If readdir returns file type information, then this is used directly
850 to find directories.
851
495 After reading the directory, the modification time, size etc. of the 852 Otherwise, after reading the directory, the modification time, size
496 directory before and after the readdir is checked, and if they match 853 etc. of the directory before and after the readdir is checked, and
497 (and isn't the current time), the link count will be used to decide 854 if they match (and isn't the current time), the link count will be
498 how many entries are directories (if >= 2). Otherwise, no knowledge 855 used to decide how many entries are directories (if >= 2).
499 of the number of subdirectories will be assumed. 856 Otherwise, no knowledge of the number of subdirectories will be
857 assumed.
500 858
501 Then entries will be sorted into likely directories (everything 859 Then entries will be sorted into likely directories a non-initial
502 without a non-initial dot currently) and likely non-directories 860 dot currently) and likely non-directories (see "aio_readdirx"). Then
503 (everything else). Then every entry plus an appended "/." will be 861 every entry plus an appended "/." will be "stat"'ed, likely
504 "stat"'ed, likely directories first. If that succeeds, it assumes 862 directories first, in order of their inode numbers. If that
505 that the entry is a directory or a symlink to directory (which will 863 succeeds, it assumes that the entry is a directory or a symlink to
506 be checked seperately). This is often faster than stat'ing the entry 864 directory (which will be checked separately). This is often faster
507 itself because filesystems might detect the type of the entry 865 than stat'ing the entry itself because filesystems might detect the
508 without reading the inode data (e.g. ext2fs filetype feature). 866 type of the entry without reading the inode data (e.g. ext2fs
867 filetype feature), even on systems that cannot return the filetype
868 information on readdir.
509 869
510 If the known number of directories (link count - 2) has been 870 If the known number of directories (link count - 2) has been
511 reached, the rest of the entries is assumed to be non-directories. 871 reached, the rest of the entries is assumed to be non-directories.
512 872
513 This only works with certainty on POSIX (= UNIX) filesystems, which 873 This only works with certainty on POSIX (= UNIX) filesystems, which
… …
515 875
516 It will also likely work on non-POSIX filesystems with reduced 876 It will also likely work on non-POSIX filesystems with reduced
517 efficiency as those tend to return 0 or 1 as link counts, which 877 efficiency as those tend to return 0 or 1 as link counts, which
518 disables the directory counting heuristic. 878 disables the directory counting heuristic.
519 879
520 aio_rmtree $path, $callback->($status) 880 aio_rmtree $pathname, $callback->($status)
521 Delete a directory tree starting (and including) $path, return the 881 Delete a directory tree starting (and including) $path, return the
522 status of the final "rmdir" only. This is a composite request that 882 status of the final "rmdir" only. This is a composite request that
523 uses "aio_scandir" to recurse into and rmdir directories, and unlink 883 uses "aio_scandir" to recurse into and rmdir directories, and unlink
524 everything else. 884 everything else.
525 885
886 aio_sync $callback->($status)
887 Asynchronously call sync and call the callback when finished.
888
526 aio_fsync $fh, $callback->($status) 889 aio_fsync $fh, $callback->($status)
527 Asynchronously call fsync on the given filehandle and call the 890 Asynchronously call fsync on the given filehandle and call the
528 callback with the fsync result code. 891 callback with the fsync result code.
529 892
530 aio_fdatasync $fh, $callback->($status) 893 aio_fdatasync $fh, $callback->($status)
531 Asynchronously call fdatasync on the given filehandle and call the 894 Asynchronously call fdatasync on the given filehandle and call the
532 callback with the fdatasync result code. 895 callback with the fdatasync result code.
533 896
534 If this call isn't available because your OS lacks it or it couldn't 897 If this call isn't available because your OS lacks it or it couldn't
535 be detected, it will be emulated by calling "fsync" instead. 898 be detected, it will be emulated by calling "fsync" instead.
899
900 aio_syncfs $fh, $callback->($status)
901 Asynchronously call the syncfs syscall to sync the filesystem
902 associated to the given filehandle and call the callback with the
903 syncfs result code. If syncfs is not available, calls sync(), but
904 returns -1 and sets errno to "ENOSYS" nevertheless.
905
906 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
907 Sync the data portion of the file specified by $offset and $length
908 to disk (but NOT the metadata), by calling the Linux-specific
909 sync_file_range call. If sync_file_range is not available or it
910 returns ENOSYS, then fdatasync or fsync is being substituted.
911
912 $flags can be a combination of
913 "IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE",
914 "IO::AIO::SYNC_FILE_RANGE_WRITE" and
915 "IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER": refer to the sync_file_range
916 manpage for details.
917
918 aio_pathsync $pathname, $callback->($status)
919 This request tries to open, fsync and close the given path. This is
920 a composite request intended to sync directories after directory
921 operations (E.g. rename). This might not work on all operating
922 systems or have any specific effect, but usually it makes sure that
923 directory changes get written to disc. It works for anything that
924 can be opened for read-only, not just directories.
925
926 Future versions of this function might fall back to other methods
927 when "fsync" on the directory fails (such as calling "sync").
928
929 Passes 0 when everything went ok, and -1 on error.
930
931 aio_msync $scalar, $offset = 0, $length = undef, flags = 0,
932 $callback->($status)
933 This is a rather advanced IO::AIO call, which only works on
934 mmap(2)ed scalars (see the "IO::AIO::mmap" function, although it
935 also works on data scalars managed by the Sys::Mmap or Mmap modules,
936 note that the scalar must only be modified in-place while an aio
937 operation is pending on it).
938
939 It calls the "msync" function of your OS, if available, with the
940 memory area starting at $offset in the string and ending $length
941 bytes later. If $length is negative, counts from the end, and if
942 $length is "undef", then it goes till the end of the string. The
943 flags can be a combination of "IO::AIO::MS_ASYNC",
944 "IO::AIO::MS_INVALIDATE" and "IO::AIO::MS_SYNC".
945
946 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0,
947 $callback->($status)
948 This is a rather advanced IO::AIO call, which works best on
949 mmap(2)ed scalars.
950
951 It touches (reads or writes) all memory pages in the specified range
952 inside the scalar. All caveats and parameters are the same as for
953 "aio_msync", above, except for flags, which must be either 0 (which
954 reads all pages and ensures they are instantiated) or
955 "IO::AIO::MT_MODIFY", which modifies the memory pages (by reading
956 and writing an octet from it, which dirties the page).
957
958 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
959 This is a rather advanced IO::AIO call, which works best on
960 mmap(2)ed scalars.
961
962 It reads in all the pages of the underlying storage into memory (if
963 any) and locks them, so they are not getting swapped/paged out or
964 removed.
965
966 If $length is undefined, then the scalar will be locked till the
967 end.
968
969 On systems that do not implement "mlock", this function returns -1
970 and sets errno to "ENOSYS".
971
972 Note that the corresponding "munlock" is synchronous and is
973 documented under "MISCELLANEOUS FUNCTIONS".
974
975 Example: open a file, mmap and mlock it - both will be undone when
976 $data gets destroyed.
977
978 open my $fh, "<", $path or die "$path: $!";
979 my $data;
980 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
981 aio_mlock $data; # mlock in background
982
983 aio_mlockall $flags, $callback->($status)
984 Calls the "mlockall" function with the given $flags (a combination
985 of "IO::AIO::MCL_CURRENT" and "IO::AIO::MCL_FUTURE").
986
987 On systems that do not implement "mlockall", this function returns
988 -1 and sets errno to "ENOSYS".
989
990 Note that the corresponding "munlockall" is synchronous and is
991 documented under "MISCELLANEOUS FUNCTIONS".
992
993 Example: asynchronously lock all current and future pages into
994 memory.
995
996 aio_mlockall IO::AIO::MCL_FUTURE;
997
998 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
999 Queries the extents of the given file (by calling the Linux "FIEMAP"
1000 ioctl, see <http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for
1001 details). If the ioctl is not available on your OS, then this
1002 request will fail with "ENOSYS".
1003
1004 $start is the starting offset to query extents for, $length is the
1005 size of the range to query - if it is "undef", then the whole file
1006 will be queried.
1007
1008 $flags is a combination of flags ("IO::AIO::FIEMAP_FLAG_SYNC" or
1009 "IO::AIO::FIEMAP_FLAG_XATTR" - "IO::AIO::FIEMAP_FLAGS_COMPAT" is
1010 also exported), and is normally 0 or "IO::AIO::FIEMAP_FLAG_SYNC" to
1011 query the data portion.
1012
1013 $count is the maximum number of extent records to return. If it is
1014 "undef", then IO::AIO queries all extents of the range. As a very
1015 special case, if it is 0, then the callback receives the number of
1016 extents instead of the extents themselves (which is unreliable, see
1017 below).
1018
1019 If an error occurs, the callback receives no arguments. The special
1020 "errno" value "IO::AIO::EBADR" is available to test for flag errors.
1021
1022 Otherwise, the callback receives an array reference with extent
1023 structures. Each extent structure is an array reference itself, with
1024 the following members:
1025
1026 [$logical, $physical, $length, $flags]
1027
1028 Flags is any combination of the following flag values (typically
1029 either 0 or "IO::AIO::FIEMAP_EXTENT_LAST" (1)):
1030
1031 "IO::AIO::FIEMAP_EXTENT_LAST", "IO::AIO::FIEMAP_EXTENT_UNKNOWN",
1032 "IO::AIO::FIEMAP_EXTENT_DELALLOC", "IO::AIO::FIEMAP_EXTENT_ENCODED",
1033 "IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED",
1034 "IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED",
1035 "IO::AIO::FIEMAP_EXTENT_DATA_INLINE",
1036 "IO::AIO::FIEMAP_EXTENT_DATA_TAIL",
1037 "IO::AIO::FIEMAP_EXTENT_UNWRITTEN", "IO::AIO::FIEMAP_EXTENT_MERGED"
1038 or "IO::AIO::FIEMAP_EXTENT_SHARED".
1039
1040 At the time of this writing (Linux 3.2), this requets is unreliable
1041 unless $count is "undef", as the kernel has all sorts of bugs
1042 preventing it to return all extents of a range for files with large
1043 number of extents. The code works around all these issues if $count
1044 is undef.
536 1045
537 aio_group $callback->(...) 1046 aio_group $callback->(...)
538 This is a very special aio request: Instead of doing something, it 1047 This is a very special aio request: Instead of doing something, it
539 is a container for other aio requests, which is useful if you want 1048 is a container for other aio requests, which is useful if you want
540 to bundle many requests into a single, composite, request with a 1049 to bundle many requests into a single, composite, request with a
… …
575 requests like sleep and file handle readable/writable, the overhead 1084 requests like sleep and file handle readable/writable, the overhead
576 this creates is immense (it blocks a thread for a long time) so do 1085 this creates is immense (it blocks a thread for a long time) so do
577 not use this function except to put your application under 1086 not use this function except to put your application under
578 artificial I/O pressure. 1087 artificial I/O pressure.
579 1088
1089 IO::AIO::WD - multiple working directories
1090 Your process only has one current working directory, which is used by
1091 all threads. This makes it hard to use relative paths (some other
1092 component could call "chdir" at any time, and it is hard to control when
1093 the path will be used by IO::AIO).
1094
1095 One solution for this is to always use absolute paths. This usually
1096 works, but can be quite slow (the kernel has to walk the whole path on
1097 every access), and can also be a hassle to implement.
1098
1099 Newer POSIX systems have a number of functions (openat, fdopendir,
1100 futimensat and so on) that make it possible to specify working
1101 directories per operation.
1102
1103 For portability, and because the clowns who "designed", or shall I
1104 write, perpetrated this new interface were obviously half-drunk, this
1105 abstraction cannot be perfect, though.
1106
1107 IO::AIO allows you to convert directory paths into a so-called
1108 IO::AIO::WD object. This object stores the canonicalised, absolute
1109 version of the path, and on systems that allow it, also a directory file
1110 descriptor.
1111
1112 Everywhere where a pathname is accepted by IO::AIO (e.g. in "aio_stat"
1113 or "aio_unlink"), one can specify an array reference with an IO::AIO::WD
1114 object and a pathname instead (or the IO::AIO::WD object alone, which
1115 gets interpreted as "[$wd, "."]"). If the pathname is absolute, the
1116 IO::AIO::WD object is ignored, otherwise the pathname is resolved
1117 relative to that IO::AIO::WD object.
1118
1119 For example, to get a wd object for /etc and then stat passwd inside,
1120 you would write:
1121
1122 aio_wd "/etc", sub {
1123 my $etcdir = shift;
1124
1125 # although $etcdir can be undef on error, there is generally no reason
1126 # to check for errors here, as aio_stat will fail with ENOENT
1127 # when $etcdir is undef.
1128
1129 aio_stat [$etcdir, "passwd"], sub {
1130 # yay
1131 };
1132 };
1133
1134 That "aio_wd" is a request and not a normal function shows that creating
1135 an IO::AIO::WD object is itself a potentially blocking operation, which
1136 is why it is done asynchronously.
1137
1138 To stat the directory obtained with "aio_wd" above, one could write
1139 either of the following three request calls:
1140
1141 aio_lstat "/etc" , sub { ... # pathname as normal string
1142 aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
1143 aio_lstat $wd , sub { ... # shorthand for the previous
1144
1145 As with normal pathnames, IO::AIO keeps a copy of the working directory
1146 object and the pathname string, so you could write the following without
1147 causing any issues due to $path getting reused:
1148
1149 my $path = [$wd, undef];
1150
1151 for my $name (qw(abc def ghi)) {
1152 $path->[1] = $name;
1153 aio_stat $path, sub {
1154 # ...
1155 };
1156 }
1157
1158 There are some caveats: when directories get renamed (or deleted), the
1159 pathname string doesn't change, so will point to the new directory (or
1160 nowhere at all), while the directory fd, if available on the system,
1161 will still point to the original directory. Most functions accepting a
1162 pathname will use the directory fd on newer systems, and the string on
1163 older systems. Some functions (such as realpath) will always rely on the
1164 string form of the pathname.
1165
1166 So this functionality is mainly useful to get some protection against
1167 "chdir", to easily get an absolute path out of a relative path for
1168 future reference, and to speed up doing many operations in the same
1169 directory (e.g. when stat'ing all files in a directory).
1170
1171 The following functions implement this working directory abstraction:
1172
1173 aio_wd $pathname, $callback->($wd)
1174 Asynchonously canonicalise the given pathname and convert it to an
1175 IO::AIO::WD object representing it. If possible and supported on the
1176 system, also open a directory fd to speed up pathname resolution
1177 relative to this working directory.
1178
1179 If something goes wrong, then "undef" is passwd to the callback
1180 instead of a working directory object and $! is set appropriately.
1181 Since passing "undef" as working directory component of a pathname
1182 fails the request with "ENOENT", there is often no need for error
1183 checking in the "aio_wd" callback, as future requests using the
1184 value will fail in the expected way.
1185
1186 If this call isn't available because your OS lacks it or it couldn't
1187 be detected, it will be emulated by calling "fsync" instead.
1188
1189 IO::AIO::CWD
1190 This is a compiletime constant (object) that represents the process
1191 current working directory.
1192
1193 Specifying this object as working directory object for a pathname is
1194 as if the pathname would be specified directly, without a directory
1195 object. For example, these calls are functionally identical:
1196
1197 aio_stat "somefile", sub { ... };
1198 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1199
1200 To recover the path associated with an IO::AIO::WD object, you can use
1201 "aio_realpath":
1202
1203 aio_realpath $wd, sub {
1204 warn "path is $_[0]\n";
1205 };
1206
1207 Currently, "aio_statvfs" always, and "aio_rename" and "aio_rmdir"
1208 sometimes, fall back to using an absolue path.
1209
580 IO::AIO::REQ CLASS 1210 IO::AIO::REQ CLASS
581 All non-aggregate "aio_*" functions return an object of this class when 1211 All non-aggregate "aio_*" functions return an object of this class when
582 called in non-void context. 1212 called in non-void context.
583 1213
584 cancel $req 1214 cancel $req
585 Cancels the request, if possible. Has the effect of skipping 1215 Cancels the request, if possible. Has the effect of skipping
586 execution when entering the execute state and skipping calling the 1216 execution when entering the execute state and skipping calling the
587 callback when entering the the result state, but will leave the 1217 callback when entering the the result state, but will leave the
588 request otherwise untouched. That means that requests that currently 1218 request otherwise untouched (with the exception of readdir). That
589 execute will not be stopped and resources held by the request will 1219 means that requests that currently execute will not be stopped and
590 not be freed prematurely. 1220 resources held by the request will not be freed prematurely.
591 1221
592 cb $req $callback->(...) 1222 cb $req $callback->(...)
593 Replace (or simply set) the callback registered to the request. 1223 Replace (or simply set) the callback registered to the request.
594 1224
595 IO::AIO::GRP CLASS 1225 IO::AIO::GRP CLASS
… …
622 }; 1252 };
623 1253
624 This makes it very easy to create composite requests (see the source of 1254 This makes it very easy to create composite requests (see the source of
625 "aio_move" for an application) that work and feel like simple requests. 1255 "aio_move" for an application) that work and feel like simple requests.
626 1256
627 * The IO::AIO::GRP objects will be cleaned up during calls to 1257 * The IO::AIO::GRP objects will be cleaned up during calls to
628 "IO::AIO::poll_cb", just like any other request. 1258 "IO::AIO::poll_cb", just like any other request.
1259
629 * They can be canceled like any other request. Canceling will cancel not 1260 * They can be canceled like any other request. Canceling will cancel
630 only the request itself, but also all requests it contains. 1261 not only the request itself, but also all requests it contains.
1262
631 * They can also can also be added to other IO::AIO::GRP objects. 1263 * They can also can also be added to other IO::AIO::GRP objects.
1264
632 * You must not add requests to a group from within the group callback 1265 * You must not add requests to a group from within the group callback
633 (or any later time). 1266 (or any later time).
634 1267
635 Their lifetime, simplified, looks like this: when they are empty, they 1268 Their lifetime, simplified, looks like this: when they are empty, they
636 will finish very quickly. If they contain only requests that are in the 1269 will finish very quickly. If they contain only requests that are in the
637 "done" state, they will also finish. Otherwise they will continue to 1270 "done" state, they will also finish. Otherwise they will continue to
638 exist. 1271 exist.
639 1272
640 That means after creating a group you have some time to add requests. 1273 That means after creating a group you have some time to add requests
641 And in the callbacks of those requests, you can add further requests to 1274 (precisely before the callback has been invoked, which is only done
642 the group. And only when all those requests have finished will the the 1275 within the "poll_cb"). And in the callbacks of those requests, you can
643 group itself finish. 1276 add further requests to the group. And only when all those requests have
1277 finished will the the group itself finish.
644 1278
645 add $grp ... 1279 add $grp ...
646 $grp->add (...) 1280 $grp->add (...)
647 Add one or more requests to the group. Any type of IO::AIO::REQ can 1281 Add one or more requests to the group. Any type of IO::AIO::REQ can
648 be added, including other groups, as long as you do not create 1282 be added, including other groups, as long as you do not create
… …
653 $grp->cancel_subs 1287 $grp->cancel_subs
654 Cancel all subrequests and clears any feeder, but not the group 1288 Cancel all subrequests and clears any feeder, but not the group
655 request itself. Useful when you queued a lot of events but got a 1289 request itself. Useful when you queued a lot of events but got a
656 result early. 1290 result early.
657 1291
1292 The group request will finish normally (you cannot add requests to
1293 the group).
1294
658 $grp->result (...) 1295 $grp->result (...)
659 Set the result value(s) that will be passed to the group callback 1296 Set the result value(s) that will be passed to the group callback
660 when all subrequests have finished and set thre groups errno to the 1297 when all subrequests have finished and set the groups errno to the
661 current value of errno (just like calling "errno" without an error 1298 current value of errno (just like calling "errno" without an error
662 number). By default, no argument will be passed and errno is zero. 1299 number). By default, no argument will be passed and errno is zero.
663 1300
664 $grp->errno ([$errno]) 1301 $grp->errno ([$errno])
665 Sets the group errno value to $errno, or the current value of errno 1302 Sets the group errno value to $errno, or the current value of errno
… …
676 Sets a feeder/generator on this group: every group can have an 1313 Sets a feeder/generator on this group: every group can have an
677 attached generator that generates requests if idle. The idea behind 1314 attached generator that generates requests if idle. The idea behind
678 this is that, although you could just queue as many requests as you 1315 this is that, although you could just queue as many requests as you
679 want in a group, this might starve other requests for a potentially 1316 want in a group, this might starve other requests for a potentially
680 long time. For example, "aio_scandir" might generate hundreds of 1317 long time. For example, "aio_scandir" might generate hundreds of
681 thousands "aio_stat" requests, delaying any later requests for a 1318 thousands of "aio_stat" requests, delaying any later requests for a
682 long time. 1319 long time.
683 1320
684 To avoid this, and allow incremental generation of requests, you can 1321 To avoid this, and allow incremental generation of requests, you can
685 instead a group and set a feeder on it that generates those 1322 instead a group and set a feeder on it that generates those
686 requests. The feed callback will be called whenever there are few 1323 requests. The feed callback will be called whenever there are few
… …
691 does not impose any limits). 1328 does not impose any limits).
692 1329
693 If the feed does not queue more requests when called, it will be 1330 If the feed does not queue more requests when called, it will be
694 automatically removed from the group. 1331 automatically removed from the group.
695 1332
696 If the feed limit is 0, it will be set to 2 automatically. 1333 If the feed limit is 0 when this method is called, it will be set to
1334 2 automatically.
697 1335
698 Example: 1336 Example:
699 1337
700 # stat all files in @files, but only ever use four aio requests concurrently: 1338 # stat all files in @files, but only ever use four aio requests concurrently:
701 1339
… …
712 Sets the feeder limit for the group: The feeder will be called 1350 Sets the feeder limit for the group: The feeder will be called
713 whenever the group contains less than this many requests. 1351 whenever the group contains less than this many requests.
714 1352
715 Setting the limit to 0 will pause the feeding process. 1353 Setting the limit to 0 will pause the feeding process.
716 1354
1355 The default value for the limit is 0, but note that setting a feeder
1356 automatically bumps it up to 2.
1357
717 SUPPORT FUNCTIONS 1358 SUPPORT FUNCTIONS
718 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1359 EVENT PROCESSING AND EVENT LOOP INTEGRATION
719 $fileno = IO::AIO::poll_fileno 1360 $fileno = IO::AIO::poll_fileno
720 Return the *request result pipe file descriptor*. This filehandle 1361 Return the *request result pipe file descriptor*. This filehandle
721 must be polled for reading by some mechanism outside this module 1362 must be polled for reading by some mechanism outside this module
722 (e.g. Event or select, see below or the SYNOPSIS). If the pipe 1363 (e.g. EV, Glib, select and so on, see below or the SYNOPSIS). If the
723 becomes readable you have to call "poll_cb" to check the results. 1364 pipe becomes readable you have to call "poll_cb" to check the
1365 results.
724 1366
725 See "poll_cb" for an example. 1367 See "poll_cb" for an example.
726 1368
727 IO::AIO::poll_cb 1369 IO::AIO::poll_cb
728 Process some outstanding events on the result pipe. You have to call 1370 Process some requests that have reached the result phase (i.e. they
729 this regularly. Returns the number of events processed. Returns 1371 have been executed but the results are not yet reported). You have
1372 to call this "regularly" to finish outstanding requests.
1373
1374 Returns 0 if all events could be processed (or there were no events
1375 to process), or -1 if it returned earlier for whatever reason.
730 immediately when no events are outstanding. The amount of events 1376 Returns immediately when no events are outstanding. The amount of
731 processed depends on the settings of "IO::AIO::max_poll_req" and 1377 events processed depends on the settings of "IO::AIO::max_poll_req",
732 "IO::AIO::max_poll_time". 1378 "IO::AIO::max_poll_time" and "IO::AIO::max_outstanding".
733 1379
734 If not all requests were processed for whatever reason, the 1380 If not all requests were processed for whatever reason, the poll
735 filehandle will still be ready when "poll_cb" returns. 1381 file descriptor will still be ready when "poll_cb" returns, so
1382 normally you don't have to do anything special to have it called
1383 later.
1384
1385 Apart from calling "IO::AIO::poll_cb" when the event filehandle
1386 becomes ready, it can be beneficial to call this function from loops
1387 which submit a lot of requests, to make sure the results get
1388 processed when they become available and not just when the loop is
1389 finished and the event loop takes over again. This function returns
1390 very fast when there are no outstanding requests.
736 1391
737 Example: Install an Event watcher that automatically calls 1392 Example: Install an Event watcher that automatically calls
738 IO::AIO::poll_cb with high priority: 1393 IO::AIO::poll_cb with high priority (more examples can be found in
1394 the SYNOPSIS section, at the top of this document):
739 1395
740 Event->io (fd => IO::AIO::poll_fileno, 1396 Event->io (fd => IO::AIO::poll_fileno,
741 poll => 'r', async => 1, 1397 poll => 'r', async => 1,
742 cb => \&IO::AIO::poll_cb); 1398 cb => \&IO::AIO::poll_cb);
1399
1400 IO::AIO::poll_wait
1401 Wait until either at least one request is in the result phase or no
1402 requests are outstanding anymore.
1403
1404 This is useful if you want to synchronously wait for some requests
1405 to become ready, without actually handling them.
1406
1407 See "nreqs" for an example.
1408
1409 IO::AIO::poll
1410 Waits until some requests have been handled.
1411
1412 Returns the number of requests processed, but is otherwise strictly
1413 equivalent to:
1414
1415 IO::AIO::poll_wait, IO::AIO::poll_cb
1416
1417 IO::AIO::flush
1418 Wait till all outstanding AIO requests have been handled.
1419
1420 Strictly equivalent to:
1421
1422 IO::AIO::poll_wait, IO::AIO::poll_cb
1423 while IO::AIO::nreqs;
743 1424
744 IO::AIO::max_poll_reqs $nreqs 1425 IO::AIO::max_poll_reqs $nreqs
745 IO::AIO::max_poll_time $seconds 1426 IO::AIO::max_poll_time $seconds
746 These set the maximum number of requests (default 0, meaning 1427 These set the maximum number of requests (default 0, meaning
747 infinity) that are being processed by "IO::AIO::poll_cb" in one 1428 infinity) that are being processed by "IO::AIO::poll_cb" in one
… …
771 # use a low priority so other tasks have priority 1452 # use a low priority so other tasks have priority
772 Event->io (fd => IO::AIO::poll_fileno, 1453 Event->io (fd => IO::AIO::poll_fileno,
773 poll => 'r', nice => 1, 1454 poll => 'r', nice => 1,
774 cb => &IO::AIO::poll_cb); 1455 cb => &IO::AIO::poll_cb);
775 1456
776 IO::AIO::poll_wait
777 If there are any outstanding requests and none of them in the result
778 phase, wait till the result filehandle becomes ready for reading
779 (simply does a "select" on the filehandle. This is useful if you
780 want to synchronously wait for some requests to finish).
781
782 See "nreqs" for an example.
783
784 IO::AIO::poll
785 Waits until some requests have been handled.
786
787 Returns the number of requests processed, but is otherwise strictly
788 equivalent to:
789
790 IO::AIO::poll_wait, IO::AIO::poll_cb
791
792 IO::AIO::flush
793 Wait till all outstanding AIO requests have been handled.
794
795 Strictly equivalent to:
796
797 IO::AIO::poll_wait, IO::AIO::poll_cb
798 while IO::AIO::nreqs;
799
800 CONTROLLING THE NUMBER OF THREADS 1457 CONTROLLING THE NUMBER OF THREADS
801 IO::AIO::min_parallel $nthreads 1458 IO::AIO::min_parallel $nthreads
802 Set the minimum number of AIO threads to $nthreads. The current 1459 Set the minimum number of AIO threads to $nthreads. The current
803 default is 8, which means eight asynchronous operations can execute 1460 default is 8, which means eight asynchronous operations can execute
804 concurrently at any one time (the number of outstanding requests, 1461 concurrently at any one time (the number of outstanding requests,
… …
833 1490
834 Under normal circumstances you don't need to call this function. 1491 Under normal circumstances you don't need to call this function.
835 1492
836 IO::AIO::max_idle $nthreads 1493 IO::AIO::max_idle $nthreads
837 Limit the number of threads (default: 4) that are allowed to idle 1494 Limit the number of threads (default: 4) that are allowed to idle
838 (i.e., threads that did not get a request to process within 10 1495 (i.e., threads that did not get a request to process within the idle
839 seconds). That means if a thread becomes idle while $nthreads other 1496 timeout (default: 10 seconds). That means if a thread becomes idle
840 threads are also idle, it will free its resources and exit. 1497 while $nthreads other threads are also idle, it will free its
1498 resources and exit.
841 1499
842 This is useful when you allow a large number of threads (e.g. 100 or 1500 This is useful when you allow a large number of threads (e.g. 100 or
843 1000) to allow for extremely high load situations, but want to free 1501 1000) to allow for extremely high load situations, but want to free
844 resources under normal circumstances (1000 threads can easily 1502 resources under normal circumstances (1000 threads can easily
845 consume 30MB of RAM). 1503 consume 30MB of RAM).
846 1504
847 The default is probably ok in most situations, especially if thread 1505 The default is probably ok in most situations, especially if thread
848 creation is fast. If thread creation is very slow on your system you 1506 creation is fast. If thread creation is very slow on your system you
849 might want to use larger values. 1507 might want to use larger values.
850 1508
1509 IO::AIO::idle_timeout $seconds
1510 Sets the minimum idle timeout (default 10) after which worker
1511 threads are allowed to exit. SEe "IO::AIO::max_idle".
1512
851 $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1513 IO::AIO::max_outstanding $maxreqs
1514 Sets the maximum number of outstanding requests to $nreqs. If you do
1515 queue up more than this number of requests, the next call to
1516 "IO::AIO::poll_cb" (and other functions calling "poll_cb", such as
1517 "IO::AIO::flush" or "IO::AIO::poll") will block until the limit is
1518 no longer exceeded.
1519
1520 In other words, this setting does not enforce a queue limit, but can
1521 be used to make poll functions block if the limit is exceeded.
1522
852 This is a very bad function to use in interactive programs because 1523 This is a very bad function to use in interactive programs because
853 it blocks, and a bad way to reduce concurrency because it is 1524 it blocks, and a bad way to reduce concurrency because it is
854 inexact: Better use an "aio_group" together with a feed callback. 1525 inexact: Better use an "aio_group" together with a feed callback.
855 1526
856 Sets the maximum number of outstanding requests to $nreqs. If you to 1527 It's main use is in scripts without an event loop - when you want to
857 queue up more than this number of requests, the next call to the 1528 stat a lot of files, you can write somehting like this:
858 "poll_cb" (and "poll_some" and other functions calling "poll_cb")
859 function will block until the limit is no longer exceeded.
860 1529
861 The default value is very large, so there is no practical limit on 1530 IO::AIO::max_outstanding 32;
1531
1532 for my $path (...) {
1533 aio_stat $path , ...;
1534 IO::AIO::poll_cb;
1535 }
1536
1537 IO::AIO::flush;
1538
1539 The call to "poll_cb" inside the loop will normally return
1540 instantly, but as soon as more thna 32 reqeusts are in-flight, it
1541 will block until some requests have been handled. This keeps the
1542 loop from pushing a large number of "aio_stat" requests onto the
1543 queue.
1544
1545 The default value for "max_outstanding" is very large, so there is
862 the number of outstanding requests. 1546 no practical limit on the number of outstanding requests.
863
864 You can still queue as many requests as you want. Therefore,
865 "max_oustsanding" is mainly useful in simple scripts (with low
866 values) or as a stop gap to shield against fatal memory overflow
867 (with large values).
868 1547
869 STATISTICAL INFORMATION 1548 STATISTICAL INFORMATION
870 IO::AIO::nreqs 1549 IO::AIO::nreqs
871 Returns the number of requests currently in the ready, execute or 1550 Returns the number of requests currently in the ready, execute or
872 pending states (i.e. for which their callback has not been invoked 1551 pending states (i.e. for which their callback has not been invoked
… …
883 1562
884 IO::AIO::npending 1563 IO::AIO::npending
885 Returns the number of requests currently in the pending state 1564 Returns the number of requests currently in the pending state
886 (executed, but not yet processed by poll_cb). 1565 (executed, but not yet processed by poll_cb).
887 1566
1567 MISCELLANEOUS FUNCTIONS
1568 IO::AIO implements some functions that might be useful, but are not
1569 asynchronous.
1570
1571 IO::AIO::sendfile $ofh, $ifh, $offset, $count
1572 Calls the "eio_sendfile_sync" function, which is like
1573 "aio_sendfile", but is blocking (this makes most sense if you know
1574 the input data is likely cached already and the output filehandle is
1575 set to non-blocking operations).
1576
1577 Returns the number of bytes copied, or -1 on error.
1578
1579 IO::AIO::fadvise $fh, $offset, $len, $advice
1580 Simply calls the "posix_fadvise" function (see its manpage for
1581 details). The following advice constants are available:
1582 "IO::AIO::FADV_NORMAL", "IO::AIO::FADV_SEQUENTIAL",
1583 "IO::AIO::FADV_RANDOM", "IO::AIO::FADV_NOREUSE",
1584 "IO::AIO::FADV_WILLNEED", "IO::AIO::FADV_DONTNEED".
1585
1586 On systems that do not implement "posix_fadvise", this function
1587 returns ENOSYS, otherwise the return value of "posix_fadvise".
1588
1589 IO::AIO::madvise $scalar, $offset, $len, $advice
1590 Simply calls the "posix_madvise" function (see its manpage for
1591 details). The following advice constants are available:
1592 "IO::AIO::MADV_NORMAL", "IO::AIO::MADV_SEQUENTIAL",
1593 "IO::AIO::MADV_RANDOM", "IO::AIO::MADV_WILLNEED",
1594 "IO::AIO::MADV_DONTNEED".
1595
1596 On systems that do not implement "posix_madvise", this function
1597 returns ENOSYS, otherwise the return value of "posix_madvise".
1598
1599 IO::AIO::mprotect $scalar, $offset, $len, $protect
1600 Simply calls the "mprotect" function on the preferably AIO::mmap'ed
1601 $scalar (see its manpage for details). The following protect
1602 constants are available: "IO::AIO::PROT_NONE", "IO::AIO::PROT_READ",
1603 "IO::AIO::PROT_WRITE", "IO::AIO::PROT_EXEC".
1604
1605 On systems that do not implement "mprotect", this function returns
1606 ENOSYS, otherwise the return value of "mprotect".
1607
1608 IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1609 Memory-maps a file (or anonymous memory range) and attaches it to
1610 the given $scalar, which will act like a string scalar. Returns true
1611 on success, and false otherwise.
1612
1613 The only operations allowed on the scalar are "substr"/"vec" that
1614 don't change the string length, and most read-only operations such
1615 as copying it or searching it with regexes and so on.
1616
1617 Anything else is unsafe and will, at best, result in memory leaks.
1618
1619 The memory map associated with the $scalar is automatically removed
1620 when the $scalar is destroyed, or when the "IO::AIO::mmap" or
1621 "IO::AIO::munmap" functions are called.
1622
1623 This calls the "mmap"(2) function internally. See your system's
1624 manual page for details on the $length, $prot and $flags parameters.
1625
1626 The $length must be larger than zero and smaller than the actual
1627 filesize.
1628
1629 $prot is a combination of "IO::AIO::PROT_NONE",
1630 "IO::AIO::PROT_EXEC", "IO::AIO::PROT_READ" and/or
1631 "IO::AIO::PROT_WRITE",
1632
1633 $flags can be a combination of "IO::AIO::MAP_SHARED" or
1634 "IO::AIO::MAP_PRIVATE", or a number of system-specific flags (when
1635 not available, the are defined as 0): "IO::AIO::MAP_ANONYMOUS"
1636 (which is set to "MAP_ANON" if your system only provides this
1637 constant), "IO::AIO::MAP_HUGETLB", "IO::AIO::MAP_LOCKED",
1638 "IO::AIO::MAP_NORESERVE", "IO::AIO::MAP_POPULATE" or
1639 "IO::AIO::MAP_NONBLOCK"
1640
1641 If $fh is "undef", then a file descriptor of -1 is passed.
1642
1643 $offset is the offset from the start of the file - it generally must
1644 be a multiple of "IO::AIO::PAGESIZE" and defaults to 0.
1645
1646 Example:
1647
1648 use Digest::MD5;
1649 use IO::AIO;
1650
1651 open my $fh, "<verybigfile"
1652 or die "$!";
1653
1654 IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
1655 or die "verybigfile: $!";
1656
1657 my $fast_md5 = md5 $data;
1658
1659 IO::AIO::munmap $scalar
1660 Removes a previous mmap and undefines the $scalar.
1661
1662 IO::AIO::munlock $scalar, $offset = 0, $length = undef
1663 Calls the "munlock" function, undoing the effects of a previous
1664 "aio_mlock" call (see its description for details).
1665
1666 IO::AIO::munlockall
1667 Calls the "munlockall" function.
1668
1669 On systems that do not implement "munlockall", this function returns
1670 ENOSYS, otherwise the return value of "munlockall".
1671
1672 IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
1673 Calls the GNU/Linux splice(2) syscall, if available. If $r_off or
1674 $w_off are "undef", then "NULL" is passed for these, otherwise they
1675 should be the file offset.
1676
1677 $r_fh and $w_fh should not refer to the same file, as splice might
1678 silently corrupt the data in this case.
1679
1680 The following symbol flag values are available:
1681 "IO::AIO::SPLICE_F_MOVE", "IO::AIO::SPLICE_F_NONBLOCK",
1682 "IO::AIO::SPLICE_F_MORE" and "IO::AIO::SPLICE_F_GIFT".
1683
1684 See the splice(2) manpage for details.
1685
1686 IO::AIO::tee $r_fh, $w_fh, $length, $flags
1687 Calls the GNU/Linux tee(2) syscall, see it's manpage and the
1688 description for "IO::AIO::splice" above for details.
1689
1690EVENT LOOP INTEGRATION
1691 It is recommended to use AnyEvent::AIO to integrate IO::AIO
1692 automatically into many event loops:
1693
1694 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
1695 use AnyEvent::AIO;
1696
1697 You can also integrate IO::AIO manually into many event loops, here are
1698 some examples of how to do this:
1699
1700 # EV integration
1701 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
1702
1703 # Event integration
1704 Event->io (fd => IO::AIO::poll_fileno,
1705 poll => 'r',
1706 cb => \&IO::AIO::poll_cb);
1707
1708 # Glib/Gtk2 integration
1709 add_watch Glib::IO IO::AIO::poll_fileno,
1710 in => sub { IO::AIO::poll_cb; 1 };
1711
1712 # Tk integration
1713 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
1714 readable => \&IO::AIO::poll_cb);
1715
1716 # Danga::Socket integration
1717 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
1718 \&IO::AIO::poll_cb);
1719
888 FORK BEHAVIOUR 1720 FORK BEHAVIOUR
889 This module should do "the right thing" when the process using it forks: 1721 Usage of pthreads in a program changes the semantics of fork
1722 considerably. Specifically, only async-safe functions can be called
1723 after fork. Perl doesn't know about this, so in general, you cannot call
1724 fork with defined behaviour in perl if pthreads are involved. IO::AIO
1725 uses pthreads, so this applies, but many other extensions and (for
1726 inexplicable reasons) perl itself often is linked against pthreads, so
1727 this limitation applies to quite a lot of perls.
890 1728
891 Before the fork, IO::AIO enters a quiescent state where no requests can 1729 This module no longer tries to fight your OS, or POSIX. That means
892 be added in other threads and no results will be processed. After the 1730 IO::AIO only works in the process that loaded it. Forking is fully
893 fork the parent simply leaves the quiescent state and continues 1731 supported, but using IO::AIO in the child is not.
894 request/result processing, while the child frees the request/result
895 queue (so that the requests started before the fork will only be handled
896 in the parent). Threads will be started on demand until the limit set in
897 the parent process has been reached again.
898 1732
899 In short: the parent will, after a short pause, continue as if fork had 1733 You might get around by not *using* IO::AIO before (or after) forking.
900 not been called, while the child will act as if IO::AIO has not been 1734 You could also try to call the IO::AIO::reinit function in the child:
901 used yet. 1735
1736 IO::AIO::reinit
1737 Abandons all current requests and I/O threads and simply
1738 reinitialises all data structures. This is not an operation
1739 supported by any standards, but happens to work on GNU/Linux and
1740 some newer BSD systems.
1741
1742 The only reasonable use for this function is to call it after
1743 forking, if "IO::AIO" was used in the parent. Calling it while
1744 IO::AIO is active in the process will result in undefined behaviour.
1745 Calling it at any time will also result in any undefined (by POSIX)
1746 behaviour.
902 1747
903 MEMORY USAGE 1748 MEMORY USAGE
904 Per-request usage: 1749 Per-request usage:
905 1750
906 Each aio request uses - depending on your architecture - around 100-200 1751 Each aio request uses - depending on your architecture - around 100-200
907 bytes of memory. In addition, stat requests need a stat buffer (possibly 1752 bytes of memory. In addition, stat requests need a stat buffer (possibly
908 a few hundred bytes), readdir requires a result buffer and so on. Perl 1753 a few hundred bytes), readdir requires a result buffer and so on. Perl
909 scalars and other data passed into aio requests will also be locked and 1754 scalars and other data passed into aio requests will also be locked and
910 will consume memory till the request has entered the done state. 1755 will consume memory till the request has entered the done state.
911 1756
912 This is now awfully much, so queuing lots of requests is not usually a 1757 This is not awfully much, so queuing lots of requests is not usually a
913 problem. 1758 problem.
914 1759
915 Per-thread usage: 1760 Per-thread usage:
916 1761
917 In the execution phase, some aio requests require more memory for 1762 In the execution phase, some aio requests require more memory for
… …
920 1765
921KNOWN BUGS 1766KNOWN BUGS
922 Known bugs will be fixed in the next release. 1767 Known bugs will be fixed in the next release.
923 1768
924SEE ALSO 1769SEE ALSO
925 Coro::AIO. 1770 AnyEvent::AIO for easy integration into event loops, Coro::AIO for a
1771 more natural syntax.
926 1772
927AUTHOR 1773AUTHOR
928 Marc Lehmann <schmorp@schmorp.de> 1774 Marc Lehmann <schmorp@schmorp.de>
929 http://home.schmorp.de/ 1775 http://home.schmorp.de/
930 1776

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines