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

Comparing IO-AIO/README (file contents):
Revision 1.26 by root, Thu Oct 4 12:50:35 2007 UTC vs.
Revision 1.50 by root, Sun Oct 9 08:24:49 2011 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
150 QUICK OVERVIEW
151 This section simply lists the prototypes of the most important functions
152 for quick 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_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
159 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
160 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
161 aio_readahead $fh,$offset,$length, $callback->($retval)
162 aio_stat $fh_or_path, $callback->($status)
163 aio_lstat $fh, $callback->($status)
164 aio_statvfs $fh_or_path, $callback->($statvfs)
165 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
166 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
167 aio_truncate $fh_or_path, $offset, $callback->($status)
168 aio_chmod $fh_or_path, $mode, $callback->($status)
169 aio_unlink $pathname, $callback->($status)
170 aio_mknod $pathname, $mode, $dev, $callback->($status)
171 aio_link $srcpath, $dstpath, $callback->($status)
172 aio_symlink $srcpath, $dstpath, $callback->($status)
173 aio_readlink $pathname, $callback->($link)
174 aio_realpath $pathname, $callback->($link)
175 aio_rename $srcpath, $dstpath, $callback->($status)
176 aio_mkdir $pathname, $mode, $callback->($status)
177 aio_rmdir $pathname, $callback->($status)
178 aio_readdir $pathname, $callback->($entries)
179 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
180 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
181 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
182 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
183 aio_load $pathname, $data, $callback->($status)
184 aio_copy $srcpath, $dstpath, $callback->($status)
185 aio_move $srcpath, $dstpath, $callback->($status)
186 aio_rmtree $pathname, $callback->($status)
187 aio_sync $callback->($status)
188 aio_syncfs $fh, $callback->($status)
189 aio_fsync $fh, $callback->($status)
190 aio_fdatasync $fh, $callback->($status)
191 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
192 aio_pathsync $pathname, $callback->($status)
193 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
194 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
195 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
196 aio_mlockall $flags, $callback->($status)
197 aio_group $callback->(...)
198 aio_nop $callback->()
199
200 $prev_pri = aioreq_pri [$pri]
201 aioreq_nice $pri_adjust
202
203 IO::AIO::poll_wait
204 IO::AIO::poll_cb
205 IO::AIO::poll
206 IO::AIO::flush
207 IO::AIO::max_poll_reqs $nreqs
208 IO::AIO::max_poll_time $seconds
209 IO::AIO::min_parallel $nthreads
210 IO::AIO::max_parallel $nthreads
211 IO::AIO::max_idle $nthreads
212 IO::AIO::idle_timeout $seconds
213 IO::AIO::max_outstanding $maxreqs
214 IO::AIO::nreqs
215 IO::AIO::nready
216 IO::AIO::npending
217
218 IO::AIO::sendfile $ofh, $ifh, $offset, $count
219 IO::AIO::fadvise $fh, $offset, $len, $advice
220 IO::AIO::madvise $scalar, $offset, $length, $advice
221 IO::AIO::mprotect $scalar, $offset, $length, $protect
222 IO::AIO::munlock $scalar, $offset = 0, $length = undef
223 IO::AIO::munlockall
224
172 AIO REQUEST FUNCTIONS 225 AIO REQUEST FUNCTIONS
173 All the "aio_*" calls are more or less thin wrappers around the syscall 226 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 227 with the same name (sans "aio_"). The arguments are similar or
175 identical, and they all accept an additional (and optional) $callback 228 identical, and they all accept an additional (and optional) $callback
176 argument which must be a code reference. This code reference will get 229 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 230 called after the syscall has been executed in an asynchronous fashion.
178 error, unlike perl, which usually delivers "false") as it's sole 231 The results of the request will be passed as arguments to the callback
179 argument when the given syscall has been executed asynchronously. 232 (and, if an error occured, in $!) - for most requests the syscall return
233 code (e.g. most syscalls return -1 on error, unlike perl, which usually
234 delivers "false").
235
236 Some requests (such as "aio_readdir") pass the actual results and
237 communicate failures by passing "undef".
180 238
181 All functions expecting a filehandle keep a copy of the filehandle 239 All functions expecting a filehandle keep a copy of the filehandle
182 internally until the request has finished. 240 internally until the request has finished.
183 241
184 All functions return request objects of type IO::AIO::REQ that allow 242 All functions return request objects of type IO::AIO::REQ that allow
185 further manipulation of those requests while they are in-flight. 243 further manipulation of those requests while they are in-flight.
186 244
187 The pathnames you pass to these routines *must* be absolute and encoded 245 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 246 reason for this is that at the time the request is being executed, the
189 being executed, the current working directory could have changed. 247 current working directory could have changed. Alternatively, you can
190 Alternatively, you can make sure that you never change the current 248 make sure that you never change the current working directory anywhere
191 working directory anywhere in the program and then use relative paths. 249 in the program and then use relative paths. You can also take advantage
250 of IO::AIOs working directory abstraction, that lets you specify paths
251 relative to some previously-opened "working directory object" - see the
252 description of the "IO::AIO::WD" class later in this document.
192 253
193 To encode pathnames as octets, either make sure you either: a) always 254 To encode pathnames as octets, either make sure you either: a) always
194 pass in filenames you got from outside (command line, readdir etc.) 255 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 256 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 257 Encode module and encode your pathnames to the locale (or other)
197 the user environment, d) use Glib::filename_from_unicode on unicode 258 encoding in effect in the user environment, d) use
198 filenames or e) use something else to ensure your scalar has the correct 259 Glib::filename_from_unicode on unicode filenames or e) use something
199 contents. 260 else to ensure your scalar has the correct contents.
200 261
201 This works, btw. independent of the internal UTF-8 bit, which IO::AIO 262 This works, btw. independent of the internal UTF-8 bit, which IO::AIO
202 handles correctly wether it is set or not. 263 handles correctly whether it is set or not.
203 264
204 $prev_pri = aioreq_pri [$pri] 265 $prev_pri = aioreq_pri [$pri]
205 Returns the priority value that would be used for the next request 266 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. 267 and, if $pri is given, sets the priority for the next aio request.
207 268
247 will be modified by the umask in effect then the request is being 308 will be modified by the umask in effect then the request is being
248 executed, so better never change the umask. 309 executed, so better never change the umask.
249 310
250 Example: 311 Example:
251 312
252 aio_open "/etc/passwd", O_RDONLY, 0, sub { 313 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
253 if ($_[0]) { 314 if ($_[0]) {
254 print "open successful, fh is $_[0]\n"; 315 print "open successful, fh is $_[0]\n";
255 ... 316 ...
256 } else { 317 } else {
257 die "open failed: $!\n"; 318 die "open failed: $!\n";
258 } 319 }
259 }; 320 };
260 321
322 In addition to all the common open modes/flags ("O_RDONLY",
323 "O_WRONLY", "O_RDWR", "O_CREAT", "O_TRUNC", "O_EXCL" and
324 "O_APPEND"), the following POSIX and non-POSIX constants are
325 available (missing ones on your system are, as usual, 0):
326
327 "O_ASYNC", "O_DIRECT", "O_NOATIME", "O_CLOEXEC", "O_NOCTTY",
328 "O_NOFOLLOW", "O_NONBLOCK", "O_EXEC", "O_SEARCH", "O_DIRECTORY",
329 "O_DSYNC", "O_RSYNC", "O_SYNC" and "O_TTY_INIT".
330
261 aio_close $fh, $callback->($status) 331 aio_close $fh, $callback->($status)
262 Asynchronously close a file and call the callback with the result 332 Asynchronously close a file and call the callback with the result
263 code. 333 code.
264 334
265 Unlike the other functions operating on files, this function uses 335 Unfortunately, you can't do this to perl. Perl *insists* very
266 the PerlIO layer to close the filehandle. The reason is that the 336 strongly on closing the file descriptor associated with the
267 PerlIO API insists on closing the underlying fd itself, no matter 337 filehandle itself.
268 what, and doesn't allow modifications to the fd. Unfortunately, it
269 is not clear that you can call PerlIO from different threads
270 (actually, its quite clear that this won't work in some cases), so
271 while it likely works perfectly with simple file handles (such as
272 the ones created by "aio_open") it might fail in interesting ways
273 for others.
274 338
275 Having said that, aio_close tries to clean up the filehandle as much 339 Therefore, "aio_close" will not close the filehandle - instead it
276 as possible before handing it to an io thread, and generally does 340 will use dup2 to overwrite the file descriptor with the write-end of
277 work. 341 a pipe (the pipe fd will be created on demand and will be cached).
342
343 Or in other words: the file descriptor will be closed, but it will
344 not be free for reuse until the perl filehandle is closed.
278 345
279 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 346 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
280 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 347 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
281 Reads or writes $length bytes from the specified $fh and $offset 348 Reads or writes $length bytes from or to the specified $fh and
282 into the scalar given by $data and offset $dataoffset and calls the 349 $offset into the scalar given by $data and offset $dataoffset and
283 callback without the actual number of bytes read (or -1 on error, 350 calls the callback without the actual number of bytes read (or -1 on
284 just like the syscall). 351 error, just like the syscall).
352
353 "aio_read" will, like "sysread", shrink or grow the $data scalar to
354 offset plus the actual number of bytes read.
285 355
286 If $offset is undefined, then the current file descriptor offset 356 If $offset is undefined, then the current file descriptor offset
287 will be used (and updated), otherwise the file descriptor offset 357 will be used (and updated), otherwise the file descriptor offset
288 will not be changed by these calls. 358 will not be changed by these calls.
289 359
308 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 378 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
309 Tries to copy $length bytes from $in_fh to $out_fh. It starts 379 Tries to copy $length bytes from $in_fh to $out_fh. It starts
310 reading at byte offset $in_offset, and starts writing at the current 380 reading at byte offset $in_offset, and starts writing at the current
311 file offset of $out_fh. Because of that, it is not safe to issue 381 file offset of $out_fh. Because of that, it is not safe to issue
312 more than one "aio_sendfile" per $out_fh, as they will interfere 382 more than one "aio_sendfile" per $out_fh, as they will interfere
313 with each other. 383 with each other. The same $in_fh works fine though, as this function
384 does not move or use the file offset of $in_fh.
314 385
386 Please note that "aio_sendfile" can read more bytes from $in_fh than
387 are written, and there is no way to find out how many more bytes
388 have been read from "aio_sendfile" alone, as "aio_sendfile" only
389 provides the number of bytes written to $out_fh. Only if the result
390 value equals $length one can assume that $length bytes have been
391 read.
392
393 Unlike with other "aio_" functions, it makes a lot of sense to use
394 "aio_sendfile" on non-blocking sockets, as long as one end
395 (typically the $in_fh) is a file - the file I/O will then be
396 asynchronous, while the socket I/O will be non-blocking. Note,
397 however, that you can run into a trap where "aio_sendfile" reads
398 some data with readahead, then fails to write all data, and when the
399 socket is ready the next time, the data in the cache is already
400 lost, forcing "aio_sendfile" to again hit the disk. Explicit
401 "aio_read" + "aio_write" let's you better control resource usage.
402
315 This call tries to make use of a native "sendfile" syscall to 403 This call tries to make use of a native "sendfile"-like syscall to
316 provide zero-copy operation. For this to work, $out_fh should refer 404 provide zero-copy operation. For this to work, $out_fh should refer
317 to a socket, and $in_fh should refer to mmap'able file. 405 to a socket, and $in_fh should refer to an mmap'able file.
318 406
319 If the native sendfile call fails or is not implemented, it will be 407 If a native sendfile cannot be found or it fails with "ENOSYS",
320 emulated, so you can call "aio_sendfile" on any type of filehandle 408 "EINVAL", "ENOTSUP", "EOPNOTSUPP", "EAFNOSUPPORT", "EPROTOTYPE" or
321 regardless of the limitations of the operating system. 409 "ENOTSOCK", it will be emulated, so you can call "aio_sendfile" on
410 any type of filehandle regardless of the limitations of the
411 operating system.
322 412
323 Please note, however, that "aio_sendfile" can read more bytes from 413 As native sendfile syscalls (as practically any non-POSIX interface
324 $in_fh than are written, and there is no way to find out how many 414 hacked together in a hurry to improve benchmark numbers) tend to be
325 bytes have been read from "aio_sendfile" alone, as "aio_sendfile" 415 rather buggy on many systems, this implementation tries to work
326 only provides the number of bytes written to $out_fh. Only if the 416 around some known bugs in Linux and FreeBSD kernels (probably
327 result value equals $length one can assume that $length bytes have 417 others, too), but that might fail, so you really really should check
328 been read. 418 the return value of "aio_sendfile" - fewre bytes than expected might
419 have been transferred.
329 420
330 aio_readahead $fh,$offset,$length, $callback->($retval) 421 aio_readahead $fh,$offset,$length, $callback->($retval)
331 "aio_readahead" populates the page cache with data from a file so 422 "aio_readahead" populates the page cache with data from a file so
332 that subsequent reads from that file will not block on disk I/O. The 423 that subsequent reads from that file will not block on disk I/O. The
333 $offset argument specifies the starting point from which data is to 424 $offset argument specifies the starting point from which data is to
354 Currently, the stats are always 64-bit-stats, i.e. instead of 445 Currently, the stats are always 64-bit-stats, i.e. instead of
355 returning an error when stat'ing a large file, the results will be 446 returning an error when stat'ing a large file, the results will be
356 silently truncated unless perl itself is compiled with large file 447 silently truncated unless perl itself is compiled with large file
357 support. 448 support.
358 449
450 To help interpret the mode and dev/rdev stat values, IO::AIO offers
451 the following constants and functions (if not implemented, the
452 constants will be 0 and the functions will either "croak" or fall
453 back on traditional behaviour).
454
455 "S_IFMT", "S_IFIFO", "S_IFCHR", "S_IFBLK", "S_IFLNK", "S_IFREG",
456 "S_IFDIR", "S_IFWHT", "S_IFSOCK", "IO::AIO::major $dev_t",
457 "IO::AIO::minor $dev_t", "IO::AIO::makedev $major, $minor".
458
359 Example: Print the length of /etc/passwd: 459 Example: Print the length of /etc/passwd:
360 460
361 aio_stat "/etc/passwd", sub { 461 aio_stat "/etc/passwd", sub {
362 $_[0] and die "stat failed: $!"; 462 $_[0] and die "stat failed: $!";
363 print "size is ", -s _, "\n"; 463 print "size is ", -s _, "\n";
364 }; 464 };
365 465
466 aio_statvfs $fh_or_path, $callback->($statvfs)
467 Works like the POSIX "statvfs" or "fstatvfs" syscalls, depending on
468 whether a file handle or path was passed.
469
470 On success, the callback is passed a hash reference with the
471 following members: "bsize", "frsize", "blocks", "bfree", "bavail",
472 "files", "ffree", "favail", "fsid", "flag" and "namemax". On
473 failure, "undef" is passed.
474
475 The following POSIX IO::AIO::ST_* constants are defined: "ST_RDONLY"
476 and "ST_NOSUID".
477
478 The following non-POSIX IO::AIO::ST_* flag masks are defined to
479 their correct value when available, or to 0 on systems that do not
480 support them: "ST_NODEV", "ST_NOEXEC", "ST_SYNCHRONOUS",
481 "ST_MANDLOCK", "ST_WRITE", "ST_APPEND", "ST_IMMUTABLE",
482 "ST_NOATIME", "ST_NODIRATIME" and "ST_RELATIME".
483
484 Example: stat "/wd" and dump out the data if successful.
485
486 aio_statvfs "/wd", sub {
487 my $f = $_[0]
488 or die "statvfs: $!";
489
490 use Data::Dumper;
491 say Dumper $f;
492 };
493
494 # result:
495 {
496 bsize => 1024,
497 bfree => 4333064312,
498 blocks => 10253828096,
499 files => 2050765568,
500 flag => 4096,
501 favail => 2042092649,
502 bavail => 4333064312,
503 ffree => 2042092649,
504 namemax => 255,
505 frsize => 1024,
506 fsid => 1810
507 }
508
366 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 509 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
367 Works like perl's "utime" function (including the special case of 510 Works like perl's "utime" function (including the special case of
368 $atime and $mtime being undef). Fractional times are supported if 511 $atime and $mtime being undef). Fractional times are supported if
369 the underlying syscalls support them. 512 the underlying syscalls support them.
370 513
399 542
400 aio_unlink $pathname, $callback->($status) 543 aio_unlink $pathname, $callback->($status)
401 Asynchronously unlink (delete) a file and call the callback with the 544 Asynchronously unlink (delete) a file and call the callback with the
402 result code. 545 result code.
403 546
404 aio_mknod $path, $mode, $dev, $callback->($status) 547 aio_mknod $pathname, $mode, $dev, $callback->($status)
405 [EXPERIMENTAL] 548 [EXPERIMENTAL]
406 549
407 Asynchronously create a device node (or fifo). See mknod(2). 550 Asynchronously create a device node (or fifo). See mknod(2).
408 551
409 The only (POSIX-) portable way of calling this function is: 552 The only (POSIX-) portable way of calling this function is:
410 553
411 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 554 aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
555
556 See "aio_stat" for info about some potentially helpful extra
557 constants and functions.
412 558
413 aio_link $srcpath, $dstpath, $callback->($status) 559 aio_link $srcpath, $dstpath, $callback->($status)
414 Asynchronously create a new link to the existing object at $srcpath 560 Asynchronously create a new link to the existing object at $srcpath
415 at the path $dstpath and call the callback with the result code. 561 at the path $dstpath and call the callback with the result code.
416 562
417 aio_symlink $srcpath, $dstpath, $callback->($status) 563 aio_symlink $srcpath, $dstpath, $callback->($status)
418 Asynchronously create a new symbolic link to the existing object at 564 Asynchronously create a new symbolic link to the existing object at
419 $srcpath at the path $dstpath and call the callback with the result 565 $srcpath at the path $dstpath and call the callback with the result
420 code. 566 code.
421 567
422 aio_readlink $path, $callback->($link) 568 aio_readlink $pathname, $callback->($link)
423 Asynchronously read the symlink specified by $path and pass it to 569 Asynchronously read the symlink specified by $path and pass it to
424 the callback. If an error occurs, nothing or undef gets passed to 570 the callback. If an error occurs, nothing or undef gets passed to
425 the callback. 571 the callback.
572
573 aio_realpath $pathname, $callback->($path)
574 Asynchronously make the path absolute and resolve any symlinks in
575 $path. The resulting path only consists of directories (Same as
576 Cwd::realpath).
577
578 This request can be used to get the absolute path of the current
579 working directory by passing it a path of . (a single dot).
426 580
427 aio_rename $srcpath, $dstpath, $callback->($status) 581 aio_rename $srcpath, $dstpath, $callback->($status)
428 Asynchronously rename the object at $srcpath to $dstpath, just as 582 Asynchronously rename the object at $srcpath to $dstpath, just as
429 rename(2) and call the callback with the result code. 583 rename(2) and call the callback with the result code.
430 584
440 aio_readdir $pathname, $callback->($entries) 594 aio_readdir $pathname, $callback->($entries)
441 Unlike the POSIX call of the same name, "aio_readdir" reads an 595 Unlike the POSIX call of the same name, "aio_readdir" reads an
442 entire directory (i.e. opendir + readdir + closedir). The entries 596 entire directory (i.e. opendir + readdir + closedir). The entries
443 will not be sorted, and will NOT include the "." and ".." entries. 597 will not be sorted, and will NOT include the "." and ".." entries.
444 598
445 The callback a single argument which is either "undef" or an 599 The callback is passed a single argument which is either "undef" or
446 array-ref with the filenames. 600 an array-ref with the filenames.
447 601
602 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
603 Quite similar to "aio_readdir", but the $flags argument allows one
604 to tune behaviour and output format. In case of an error, $entries
605 will be "undef".
606
607 The flags are a combination of the following constants, ORed
608 together (the flags will also be passed to the callback, possibly
609 modified):
610
611 IO::AIO::READDIR_DENTS
612 When this flag is off, then the callback gets an arrayref
613 consisting of names only (as with "aio_readdir"), otherwise it
614 gets an arrayref with "[$name, $type, $inode]" arrayrefs, each
615 describing a single directory entry in more detail.
616
617 $name is the name of the entry.
618
619 $type is one of the "IO::AIO::DT_xxx" constants:
620
621 "IO::AIO::DT_UNKNOWN", "IO::AIO::DT_FIFO", "IO::AIO::DT_CHR",
622 "IO::AIO::DT_DIR", "IO::AIO::DT_BLK", "IO::AIO::DT_REG",
623 "IO::AIO::DT_LNK", "IO::AIO::DT_SOCK", "IO::AIO::DT_WHT".
624
625 "IO::AIO::DT_UNKNOWN" means just that: readdir does not know. If
626 you need to know, you have to run stat yourself. Also, for speed
627 reasons, the $type scalars are read-only: you can not modify
628 them.
629
630 $inode is the inode number (which might not be exact on systems
631 with 64 bit inode numbers and 32 bit perls). This field has
632 unspecified content on systems that do not deliver the inode
633 information.
634
635 IO::AIO::READDIR_DIRS_FIRST
636 When this flag is set, then the names will be returned in an
637 order where likely directories come first, in optimal stat
638 order. This is useful when you need to quickly find directories,
639 or you want to find all directories while avoiding to stat()
640 each entry.
641
642 If the system returns type information in readdir, then this is
643 used to find directories directly. Otherwise, likely directories
644 are names beginning with ".", or otherwise names with no dots,
645 of which names with short names are tried first.
646
647 IO::AIO::READDIR_STAT_ORDER
648 When this flag is set, then the names will be returned in an
649 order suitable for stat()'ing each one. That is, when you plan
650 to stat() all files in the given directory, then the returned
651 order will likely be fastest.
652
653 If both this flag and "IO::AIO::READDIR_DIRS_FIRST" are
654 specified, then the likely dirs come first, resulting in a less
655 optimal stat order.
656
657 IO::AIO::READDIR_FOUND_UNKNOWN
658 This flag should not be set when calling "aio_readdirx".
659 Instead, it is being set by "aio_readdirx", when any of the
660 $type's found were "IO::AIO::DT_UNKNOWN". The absence of this
661 flag therefore indicates that all $type's are known, which can
662 be used to speed up some algorithms.
663
448 aio_load $path, $data, $callback->($status) 664 aio_load $pathname, $data, $callback->($status)
449 This is a composite request that tries to fully load the given file 665 This is a composite request that tries to fully load the given file
450 into memory. Status is the same as with aio_read. 666 into memory. Status is the same as with aio_read.
451 667
452 aio_copy $srcpath, $dstpath, $callback->($status) 668 aio_copy $srcpath, $dstpath, $callback->($status)
453 Try to copy the *file* (directories not supported as either source 669 Try to copy the *file* (directories not supported as either source
454 or destination) from $srcpath to $dstpath and call the callback with 670 or destination) from $srcpath to $dstpath and call the callback with
455 the 0 (error) or -1 ok. 671 a status of 0 (ok) or -1 (error, see $!).
456 672
457 This is a composite request that it creates the destination file 673 This is a composite request that creates the destination file with
458 with mode 0200 and copies the contents of the source file into it 674 mode 0200 and copies the contents of the source file into it using
459 using "aio_sendfile", followed by restoring atime, mtime, access 675 "aio_sendfile", followed by restoring atime, mtime, access mode and
460 mode and uid/gid, in that order. 676 uid/gid, in that order.
461 677
462 If an error occurs, the partial destination file will be unlinked, 678 If an error occurs, the partial destination file will be unlinked,
463 if possible, except when setting atime, mtime, access mode and 679 if possible, except when setting atime, mtime, access mode and
464 uid/gid, where errors are being ignored. 680 uid/gid, where errors are being ignored.
465 681
466 aio_move $srcpath, $dstpath, $callback->($status) 682 aio_move $srcpath, $dstpath, $callback->($status)
467 Try to move the *file* (directories not supported as either source 683 Try to move the *file* (directories not supported as either source
468 or destination) from $srcpath to $dstpath and call the callback with 684 or destination) from $srcpath to $dstpath and call the callback with
469 the 0 (error) or -1 ok. 685 a status of 0 (ok) or -1 (error, see $!).
470 686
471 This is a composite request that tries to rename(2) the file first. 687 This is a composite request that tries to rename(2) the file first;
472 If rename files with "EXDEV", it copies the file with "aio_copy" 688 if rename fails with "EXDEV", it copies the file with "aio_copy"
473 and, if that is successful, unlinking the $srcpath. 689 and, if that is successful, unlinks the $srcpath.
474 690
475 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 691 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
476 Scans a directory (similar to "aio_readdir") but additionally tries 692 Scans a directory (similar to "aio_readdir") but additionally tries
477 to efficiently separate the entries of directory $path into two sets 693 to efficiently separate the entries of directory $path into two sets
478 of names, directories you can recurse into (directories), and ones 694 of names, directories you can recurse into (directories), and ones
479 you cannot recurse into (everything else, including symlinks to 695 you cannot recurse into (everything else, including symlinks to
480 directories). 696 directories).
498 Implementation notes. 714 Implementation notes.
499 715
500 The "aio_readdir" cannot be avoided, but "stat()"'ing every entry 716 The "aio_readdir" cannot be avoided, but "stat()"'ing every entry
501 can. 717 can.
502 718
719 If readdir returns file type information, then this is used directly
720 to find directories.
721
503 After reading the directory, the modification time, size etc. of the 722 Otherwise, after reading the directory, the modification time, size
504 directory before and after the readdir is checked, and if they match 723 etc. of the directory before and after the readdir is checked, and
505 (and isn't the current time), the link count will be used to decide 724 if they match (and isn't the current time), the link count will be
506 how many entries are directories (if >= 2). Otherwise, no knowledge 725 used to decide how many entries are directories (if >= 2).
507 of the number of subdirectories will be assumed. 726 Otherwise, no knowledge of the number of subdirectories will be
727 assumed.
508 728
509 Then entries will be sorted into likely directories (everything 729 Then entries will be sorted into likely directories a non-initial
510 without a non-initial dot currently) and likely non-directories 730 dot currently) and likely non-directories (see "aio_readdirx"). Then
511 (everything else). Then every entry plus an appended "/." will be 731 every entry plus an appended "/." will be "stat"'ed, likely
512 "stat"'ed, likely directories first. If that succeeds, it assumes 732 directories first, in order of their inode numbers. If that
513 that the entry is a directory or a symlink to directory (which will 733 succeeds, it assumes that the entry is a directory or a symlink to
514 be checked seperately). This is often faster than stat'ing the entry 734 directory (which will be checked separately). This is often faster
515 itself because filesystems might detect the type of the entry 735 than stat'ing the entry itself because filesystems might detect the
516 without reading the inode data (e.g. ext2fs filetype feature). 736 type of the entry without reading the inode data (e.g. ext2fs
737 filetype feature), even on systems that cannot return the filetype
738 information on readdir.
517 739
518 If the known number of directories (link count - 2) has been 740 If the known number of directories (link count - 2) has been
519 reached, the rest of the entries is assumed to be non-directories. 741 reached, the rest of the entries is assumed to be non-directories.
520 742
521 This only works with certainty on POSIX (= UNIX) filesystems, which 743 This only works with certainty on POSIX (= UNIX) filesystems, which
523 745
524 It will also likely work on non-POSIX filesystems with reduced 746 It will also likely work on non-POSIX filesystems with reduced
525 efficiency as those tend to return 0 or 1 as link counts, which 747 efficiency as those tend to return 0 or 1 as link counts, which
526 disables the directory counting heuristic. 748 disables the directory counting heuristic.
527 749
528 aio_rmtree $path, $callback->($status) 750 aio_rmtree $pathname, $callback->($status)
529 Delete a directory tree starting (and including) $path, return the 751 Delete a directory tree starting (and including) $path, return the
530 status of the final "rmdir" only. This is a composite request that 752 status of the final "rmdir" only. This is a composite request that
531 uses "aio_scandir" to recurse into and rmdir directories, and unlink 753 uses "aio_scandir" to recurse into and rmdir directories, and unlink
532 everything else. 754 everything else.
533 755
756 aio_sync $callback->($status)
757 Asynchronously call sync and call the callback when finished.
758
534 aio_fsync $fh, $callback->($status) 759 aio_fsync $fh, $callback->($status)
535 Asynchronously call fsync on the given filehandle and call the 760 Asynchronously call fsync on the given filehandle and call the
536 callback with the fsync result code. 761 callback with the fsync result code.
537 762
538 aio_fdatasync $fh, $callback->($status) 763 aio_fdatasync $fh, $callback->($status)
539 Asynchronously call fdatasync on the given filehandle and call the 764 Asynchronously call fdatasync on the given filehandle and call the
540 callback with the fdatasync result code. 765 callback with the fdatasync result code.
541 766
542 If this call isn't available because your OS lacks it or it couldn't 767 If this call isn't available because your OS lacks it or it couldn't
543 be detected, it will be emulated by calling "fsync" instead. 768 be detected, it will be emulated by calling "fsync" instead.
769
770 aio_syncfs $fh, $callback->($status)
771 Asynchronously call the syncfs syscall to sync the filesystem
772 associated to the given filehandle and call the callback with the
773 syncfs result code. If syncfs is not available, calls sync(), but
774 returns -1 and sets errno to "ENOSYS" nevertheless.
775
776 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
777 Sync the data portion of the file specified by $offset and $length
778 to disk (but NOT the metadata), by calling the Linux-specific
779 sync_file_range call. If sync_file_range is not available or it
780 returns ENOSYS, then fdatasync or fsync is being substituted.
781
782 $flags can be a combination of
783 "IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE",
784 "IO::AIO::SYNC_FILE_RANGE_WRITE" and
785 "IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER": refer to the sync_file_range
786 manpage for details.
787
788 aio_pathsync $pathname, $callback->($status)
789 This request tries to open, fsync and close the given path. This is
790 a composite request intended to sync directories after directory
791 operations (E.g. rename). This might not work on all operating
792 systems or have any specific effect, but usually it makes sure that
793 directory changes get written to disc. It works for anything that
794 can be opened for read-only, not just directories.
795
796 Future versions of this function might fall back to other methods
797 when "fsync" on the directory fails (such as calling "sync").
798
799 Passes 0 when everything went ok, and -1 on error.
800
801 aio_msync $scalar, $offset = 0, $length = undef, flags = 0,
802 $callback->($status)
803 This is a rather advanced IO::AIO call, which only works on
804 mmap(2)ed scalars (see the "IO::AIO::mmap" function, although it
805 also works on data scalars managed by the Sys::Mmap or Mmap modules,
806 note that the scalar must only be modified in-place while an aio
807 operation is pending on it).
808
809 It calls the "msync" function of your OS, if available, with the
810 memory area starting at $offset in the string and ending $length
811 bytes later. If $length is negative, counts from the end, and if
812 $length is "undef", then it goes till the end of the string. The
813 flags can be a combination of "IO::AIO::MS_ASYNC",
814 "IO::AIO::MS_INVALIDATE" and "IO::AIO::MS_SYNC".
815
816 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0,
817 $callback->($status)
818 This is a rather advanced IO::AIO call, which works best on
819 mmap(2)ed scalars.
820
821 It touches (reads or writes) all memory pages in the specified range
822 inside the scalar. All caveats and parameters are the same as for
823 "aio_msync", above, except for flags, which must be either 0 (which
824 reads all pages and ensures they are instantiated) or
825 "IO::AIO::MT_MODIFY", which modifies the memory page s(by reading
826 and writing an octet from it, which dirties the page).
827
828 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
829 This is a rather advanced IO::AIO call, which works best on
830 mmap(2)ed scalars.
831
832 It reads in all the pages of the underlying storage into memory (if
833 any) and locks them, so they are not getting swapped/paged out or
834 removed.
835
836 If $length is undefined, then the scalar will be locked till the
837 end.
838
839 On systems that do not implement "mlock", this function returns -1
840 and sets errno to "ENOSYS".
841
842 Note that the corresponding "munlock" is synchronous and is
843 documented under "MISCELLANEOUS FUNCTIONS".
844
845 Example: open a file, mmap and mlock it - both will be undone when
846 $data gets destroyed.
847
848 open my $fh, "<", $path or die "$path: $!";
849 my $data;
850 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
851 aio_mlock $data; # mlock in background
852
853 aio_mlockall $flags, $callback->($status)
854 Calls the "mlockall" function with the given $flags (a combination
855 of "IO::AIO::MCL_CURRENT" and "IO::AIO::MCL_FUTURE").
856
857 On systems that do not implement "mlockall", this function returns
858 -1 and sets errno to "ENOSYS".
859
860 Note that the corresponding "munlockall" is synchronous and is
861 documented under "MISCELLANEOUS FUNCTIONS".
862
863 Example: asynchronously lock all current and future pages into
864 memory.
865
866 aio_mlockall IO::AIO::MCL_FUTURE;
544 867
545 aio_group $callback->(...) 868 aio_group $callback->(...)
546 This is a very special aio request: Instead of doing something, it 869 This is a very special aio request: Instead of doing something, it
547 is a container for other aio requests, which is useful if you want 870 is a container for other aio requests, which is useful if you want
548 to bundle many requests into a single, composite, request with a 871 to bundle many requests into a single, composite, request with a
583 requests like sleep and file handle readable/writable, the overhead 906 requests like sleep and file handle readable/writable, the overhead
584 this creates is immense (it blocks a thread for a long time) so do 907 this creates is immense (it blocks a thread for a long time) so do
585 not use this function except to put your application under 908 not use this function except to put your application under
586 artificial I/O pressure. 909 artificial I/O pressure.
587 910
911 IO::AIO::WD - multiple working directories
912 Your process only has one current working directory, which is used by
913 all threads. This makes it hard to use relative paths (some other
914 component could call "chdir" at any time, and it is hard to control when
915 the path will be used by IO::AIO).
916
917 One solution for this is to always use absolute paths. This usually
918 works, but can be quite slow (the kernel has to walk the whole path on
919 every access), and can also be a hassle to implement.
920
921 Newer POSIX systems have a number of functions (openat, fdopendir,
922 futimensat and so on) that make it possible to specify working
923 directories per operation.
924
925 For portability, and because the clowns who "designed", or shall I
926 write, perpetrated this new interface were obviously half-drunk, this
927 abstraction cannot be perfect, though.
928
929 IO::AIO allows you to convert directory paths into a so-called
930 IO::AIO::WD object. This object stores the canonicalised, absolute
931 version of the path, and on systems that allow it, also a directory file
932 descriptor.
933
934 Everywhere where a pathname is accepted by IO::AIO (e.g. in "aio_stat"
935 or "aio_unlink"), one can specify an array reference with an IO::AIO::WD
936 object and a pathname instead (or the IO::AIO::WD object alone, which
937 gets interpreted as "[$wd, "."]"). If the pathname is absolute, the
938 IO::AIO::WD object is ignored, otherwise the pathname is resolved
939 relative to that IO::AIO::WD object.
940
941 For example, to get a wd object for /etc and then stat passwd inside,
942 you would write:
943
944 aio_wd "/etc", sub {
945 my $etcdir = shift;
946
947 # although $etcdir can be undef on error, there is generally no reason
948 # to check for errors here, as aio_stat will fail with ENOENT
949 # when $etcdir is undef.
950
951 aio_stat [$etcdir, "passwd"], sub {
952 # yay
953 };
954 };
955
956 That "aio_wd" is a request and not a normal function shows that creating
957 an IO::AIO::WD object is itself a potentially blocking operation, which
958 is why it is done asynchronously.
959
960 To stat the directory obtained with "aio_wd" above, one could write
961 either of the following three request calls:
962
963 aio_lstat "/etc" , sub { ... # pathname as normal string
964 aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
965 aio_lstat $wd , sub { ... # shorthand for the previous
966
967 As with normal pathnames, IO::AIO keeps a copy of the working directory
968 object and the pathname string, so you could write the following without
969 causing any issues due to $path getting reused:
970
971 my $path = [$wd, undef];
972
973 for my $name (qw(abc def ghi)) {
974 $path->[1] = $name;
975 aio_stat $path, sub {
976 # ...
977 };
978 }
979
980 There are some caveats: when directories get renamed (or deleted), the
981 pathname string doesn't change, so will point to the new directory (or
982 nowhere at all), while the directory fd, if available on the system,
983 will still point to the original directory. Most functions accepting a
984 pathname will use the directory fd on newer systems, and the string on
985 older systems. Some functions (such as realpath) will always rely on the
986 string form of the pathname.
987
988 So this fucntionality is mainly useful to get some protection against
989 "chdir", to easily get an absolute path out of a relative path for
990 future reference, and to speed up doing many operations in the same
991 directory (e.g. when stat'ing all files in a directory).
992
993 The following functions implement this working directory abstraction:
994
995 aio_wd $pathname, $callback->($wd)
996 Asynchonously canonicalise the given pathname and convert it to an
997 IO::AIO::WD object representing it. If possible and supported on the
998 system, also open a directory fd to speed up pathname resolution
999 relative to this working directory.
1000
1001 If something goes wrong, then "undef" is passwd to the callback
1002 instead of a working directory object and $! is set appropriately.
1003 Since passing "undef" as working directory component of a pathname
1004 fails the request with "ENOENT", there is often no need for error
1005 checking in the "aio_wd" callback, as future requests using the
1006 value will fail in the expected way.
1007
1008 If this call isn't available because your OS lacks it or it couldn't
1009 be detected, it will be emulated by calling "fsync" instead.
1010
1011 IO::AIO::CWD
1012 This is a compiletime constant (object) that represents the process
1013 current working directory.
1014
1015 Specifying this object as working directory object for a pathname is
1016 as if the pathname would be specified directly, without a directory
1017 object, e.g., these calls are functionally identical:
1018
1019 aio_stat "somefile", sub { ... };
1020 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1021
588 IO::AIO::REQ CLASS 1022 IO::AIO::REQ CLASS
589 All non-aggregate "aio_*" functions return an object of this class when 1023 All non-aggregate "aio_*" functions return an object of this class when
590 called in non-void context. 1024 called in non-void context.
591 1025
592 cancel $req 1026 cancel $req
593 Cancels the request, if possible. Has the effect of skipping 1027 Cancels the request, if possible. Has the effect of skipping
594 execution when entering the execute state and skipping calling the 1028 execution when entering the execute state and skipping calling the
595 callback when entering the the result state, but will leave the 1029 callback when entering the the result state, but will leave the
596 request otherwise untouched. That means that requests that currently 1030 request otherwise untouched (with the exception of readdir). That
597 execute will not be stopped and resources held by the request will 1031 means that requests that currently execute will not be stopped and
598 not be freed prematurely. 1032 resources held by the request will not be freed prematurely.
599 1033
600 cb $req $callback->(...) 1034 cb $req $callback->(...)
601 Replace (or simply set) the callback registered to the request. 1035 Replace (or simply set) the callback registered to the request.
602 1036
603 IO::AIO::GRP CLASS 1037 IO::AIO::GRP CLASS
630 }; 1064 };
631 1065
632 This makes it very easy to create composite requests (see the source of 1066 This makes it very easy to create composite requests (see the source of
633 "aio_move" for an application) that work and feel like simple requests. 1067 "aio_move" for an application) that work and feel like simple requests.
634 1068
635 * The IO::AIO::GRP objects will be cleaned up during calls to 1069 * The IO::AIO::GRP objects will be cleaned up during calls to
636 "IO::AIO::poll_cb", just like any other request. 1070 "IO::AIO::poll_cb", just like any other request.
1071
637 * They can be canceled like any other request. Canceling will cancel not 1072 * They can be canceled like any other request. Canceling will cancel
638 only the request itself, but also all requests it contains. 1073 not only the request itself, but also all requests it contains.
1074
639 * They can also can also be added to other IO::AIO::GRP objects. 1075 * They can also can also be added to other IO::AIO::GRP objects.
1076
640 * You must not add requests to a group from within the group callback 1077 * You must not add requests to a group from within the group callback
641 (or any later time). 1078 (or any later time).
642 1079
643 Their lifetime, simplified, looks like this: when they are empty, they 1080 Their lifetime, simplified, looks like this: when they are empty, they
644 will finish very quickly. If they contain only requests that are in the 1081 will finish very quickly. If they contain only requests that are in the
645 "done" state, they will also finish. Otherwise they will continue to 1082 "done" state, they will also finish. Otherwise they will continue to
646 exist. 1083 exist.
647 1084
648 That means after creating a group you have some time to add requests. 1085 That means after creating a group you have some time to add requests
649 And in the callbacks of those requests, you can add further requests to 1086 (precisely before the callback has been invoked, which is only done
650 the group. And only when all those requests have finished will the the 1087 within the "poll_cb"). And in the callbacks of those requests, you can
651 group itself finish. 1088 add further requests to the group. And only when all those requests have
1089 finished will the the group itself finish.
652 1090
653 add $grp ... 1091 add $grp ...
654 $grp->add (...) 1092 $grp->add (...)
655 Add one or more requests to the group. Any type of IO::AIO::REQ can 1093 Add one or more requests to the group. Any type of IO::AIO::REQ can
656 be added, including other groups, as long as you do not create 1094 be added, including other groups, as long as you do not create
661 $grp->cancel_subs 1099 $grp->cancel_subs
662 Cancel all subrequests and clears any feeder, but not the group 1100 Cancel all subrequests and clears any feeder, but not the group
663 request itself. Useful when you queued a lot of events but got a 1101 request itself. Useful when you queued a lot of events but got a
664 result early. 1102 result early.
665 1103
1104 The group request will finish normally (you cannot add requests to
1105 the group).
1106
666 $grp->result (...) 1107 $grp->result (...)
667 Set the result value(s) that will be passed to the group callback 1108 Set the result value(s) that will be passed to the group callback
668 when all subrequests have finished and set thre groups errno to the 1109 when all subrequests have finished and set the groups errno to the
669 current value of errno (just like calling "errno" without an error 1110 current value of errno (just like calling "errno" without an error
670 number). By default, no argument will be passed and errno is zero. 1111 number). By default, no argument will be passed and errno is zero.
671 1112
672 $grp->errno ([$errno]) 1113 $grp->errno ([$errno])
673 Sets the group errno value to $errno, or the current value of errno 1114 Sets the group errno value to $errno, or the current value of errno
684 Sets a feeder/generator on this group: every group can have an 1125 Sets a feeder/generator on this group: every group can have an
685 attached generator that generates requests if idle. The idea behind 1126 attached generator that generates requests if idle. The idea behind
686 this is that, although you could just queue as many requests as you 1127 this is that, although you could just queue as many requests as you
687 want in a group, this might starve other requests for a potentially 1128 want in a group, this might starve other requests for a potentially
688 long time. For example, "aio_scandir" might generate hundreds of 1129 long time. For example, "aio_scandir" might generate hundreds of
689 thousands "aio_stat" requests, delaying any later requests for a 1130 thousands of "aio_stat" requests, delaying any later requests for a
690 long time. 1131 long time.
691 1132
692 To avoid this, and allow incremental generation of requests, you can 1133 To avoid this, and allow incremental generation of requests, you can
693 instead a group and set a feeder on it that generates those 1134 instead a group and set a feeder on it that generates those
694 requests. The feed callback will be called whenever there are few 1135 requests. The feed callback will be called whenever there are few
699 does not impose any limits). 1140 does not impose any limits).
700 1141
701 If the feed does not queue more requests when called, it will be 1142 If the feed does not queue more requests when called, it will be
702 automatically removed from the group. 1143 automatically removed from the group.
703 1144
704 If the feed limit is 0, it will be set to 2 automatically. 1145 If the feed limit is 0 when this method is called, it will be set to
1146 2 automatically.
705 1147
706 Example: 1148 Example:
707 1149
708 # stat all files in @files, but only ever use four aio requests concurrently: 1150 # stat all files in @files, but only ever use four aio requests concurrently:
709 1151
720 Sets the feeder limit for the group: The feeder will be called 1162 Sets the feeder limit for the group: The feeder will be called
721 whenever the group contains less than this many requests. 1163 whenever the group contains less than this many requests.
722 1164
723 Setting the limit to 0 will pause the feeding process. 1165 Setting the limit to 0 will pause the feeding process.
724 1166
1167 The default value for the limit is 0, but note that setting a feeder
1168 automatically bumps it up to 2.
1169
725 SUPPORT FUNCTIONS 1170 SUPPORT FUNCTIONS
726 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1171 EVENT PROCESSING AND EVENT LOOP INTEGRATION
727 $fileno = IO::AIO::poll_fileno 1172 $fileno = IO::AIO::poll_fileno
728 Return the *request result pipe file descriptor*. This filehandle 1173 Return the *request result pipe file descriptor*. This filehandle
729 must be polled for reading by some mechanism outside this module 1174 must be polled for reading by some mechanism outside this module
730 (e.g. Event or select, see below or the SYNOPSIS). If the pipe 1175 (e.g. EV, Glib, select and so on, see below or the SYNOPSIS). If the
731 becomes readable you have to call "poll_cb" to check the results. 1176 pipe becomes readable you have to call "poll_cb" to check the
1177 results.
732 1178
733 See "poll_cb" for an example. 1179 See "poll_cb" for an example.
734 1180
735 IO::AIO::poll_cb 1181 IO::AIO::poll_cb
736 Process some outstanding events on the result pipe. You have to call 1182 Process some outstanding events on the result pipe. You have to call
737 this regularly. Returns the number of events processed. Returns 1183 this regularly. Returns 0 if all events could be processed (or there
738 immediately when no events are outstanding. The amount of events 1184 were no events to process), or -1 if it returned earlier for
739 processed depends on the settings of "IO::AIO::max_poll_req" and 1185 whatever reason. Returns immediately when no events are outstanding.
740 "IO::AIO::max_poll_time". 1186 The amount of events processed depends on the settings of
1187 "IO::AIO::max_poll_req" and "IO::AIO::max_poll_time".
741 1188
742 If not all requests were processed for whatever reason, the 1189 If not all requests were processed for whatever reason, the
743 filehandle will still be ready when "poll_cb" returns. 1190 filehandle will still be ready when "poll_cb" returns, so normally
1191 you don't have to do anything special to have it called later.
1192
1193 Apart from calling "IO::AIO::poll_cb" when the event filehandle
1194 becomes ready, it can be beneficial to call this function from loops
1195 which submit a lot of requests, to make sure the results get
1196 processed when they become available and not just when the loop is
1197 finished and the event loop takes over again. This function returns
1198 very fast when there are no outstanding requests.
744 1199
745 Example: Install an Event watcher that automatically calls 1200 Example: Install an Event watcher that automatically calls
746 IO::AIO::poll_cb with high priority: 1201 IO::AIO::poll_cb with high priority (more examples can be found in
1202 the SYNOPSIS section, at the top of this document):
747 1203
748 Event->io (fd => IO::AIO::poll_fileno, 1204 Event->io (fd => IO::AIO::poll_fileno,
749 poll => 'r', async => 1, 1205 poll => 'r', async => 1,
750 cb => \&IO::AIO::poll_cb); 1206 cb => \&IO::AIO::poll_cb);
1207
1208 IO::AIO::poll_wait
1209 If there are any outstanding requests and none of them in the result
1210 phase, wait till the result filehandle becomes ready for reading
1211 (simply does a "select" on the filehandle. This is useful if you
1212 want to synchronously wait for some requests to finish).
1213
1214 See "nreqs" for an example.
1215
1216 IO::AIO::poll
1217 Waits until some requests have been handled.
1218
1219 Returns the number of requests processed, but is otherwise strictly
1220 equivalent to:
1221
1222 IO::AIO::poll_wait, IO::AIO::poll_cb
1223
1224 IO::AIO::flush
1225 Wait till all outstanding AIO requests have been handled.
1226
1227 Strictly equivalent to:
1228
1229 IO::AIO::poll_wait, IO::AIO::poll_cb
1230 while IO::AIO::nreqs;
751 1231
752 IO::AIO::max_poll_reqs $nreqs 1232 IO::AIO::max_poll_reqs $nreqs
753 IO::AIO::max_poll_time $seconds 1233 IO::AIO::max_poll_time $seconds
754 These set the maximum number of requests (default 0, meaning 1234 These set the maximum number of requests (default 0, meaning
755 infinity) that are being processed by "IO::AIO::poll_cb" in one 1235 infinity) that are being processed by "IO::AIO::poll_cb" in one
779 # use a low priority so other tasks have priority 1259 # use a low priority so other tasks have priority
780 Event->io (fd => IO::AIO::poll_fileno, 1260 Event->io (fd => IO::AIO::poll_fileno,
781 poll => 'r', nice => 1, 1261 poll => 'r', nice => 1,
782 cb => &IO::AIO::poll_cb); 1262 cb => &IO::AIO::poll_cb);
783 1263
784 IO::AIO::poll_wait
785 If there are any outstanding requests and none of them in the result
786 phase, wait till the result filehandle becomes ready for reading
787 (simply does a "select" on the filehandle. This is useful if you
788 want to synchronously wait for some requests to finish).
789
790 See "nreqs" for an example.
791
792 IO::AIO::poll
793 Waits until some requests have been handled.
794
795 Returns the number of requests processed, but is otherwise strictly
796 equivalent to:
797
798 IO::AIO::poll_wait, IO::AIO::poll_cb
799
800 IO::AIO::flush
801 Wait till all outstanding AIO requests have been handled.
802
803 Strictly equivalent to:
804
805 IO::AIO::poll_wait, IO::AIO::poll_cb
806 while IO::AIO::nreqs;
807
808 CONTROLLING THE NUMBER OF THREADS 1264 CONTROLLING THE NUMBER OF THREADS
809 IO::AIO::min_parallel $nthreads 1265 IO::AIO::min_parallel $nthreads
810 Set the minimum number of AIO threads to $nthreads. The current 1266 Set the minimum number of AIO threads to $nthreads. The current
811 default is 8, which means eight asynchronous operations can execute 1267 default is 8, which means eight asynchronous operations can execute
812 concurrently at any one time (the number of outstanding requests, 1268 concurrently at any one time (the number of outstanding requests,
841 1297
842 Under normal circumstances you don't need to call this function. 1298 Under normal circumstances you don't need to call this function.
843 1299
844 IO::AIO::max_idle $nthreads 1300 IO::AIO::max_idle $nthreads
845 Limit the number of threads (default: 4) that are allowed to idle 1301 Limit the number of threads (default: 4) that are allowed to idle
846 (i.e., threads that did not get a request to process within 10 1302 (i.e., threads that did not get a request to process within the idle
847 seconds). That means if a thread becomes idle while $nthreads other 1303 timeout (default: 10 seconds). That means if a thread becomes idle
848 threads are also idle, it will free its resources and exit. 1304 while $nthreads other threads are also idle, it will free its
1305 resources and exit.
849 1306
850 This is useful when you allow a large number of threads (e.g. 100 or 1307 This is useful when you allow a large number of threads (e.g. 100 or
851 1000) to allow for extremely high load situations, but want to free 1308 1000) to allow for extremely high load situations, but want to free
852 resources under normal circumstances (1000 threads can easily 1309 resources under normal circumstances (1000 threads can easily
853 consume 30MB of RAM). 1310 consume 30MB of RAM).
854 1311
855 The default is probably ok in most situations, especially if thread 1312 The default is probably ok in most situations, especially if thread
856 creation is fast. If thread creation is very slow on your system you 1313 creation is fast. If thread creation is very slow on your system you
857 might want to use larger values. 1314 might want to use larger values.
858 1315
1316 IO::AIO::idle_timeout $seconds
1317 Sets the minimum idle timeout (default 10) after which worker
1318 threads are allowed to exit. SEe "IO::AIO::max_idle".
1319
859 $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1320 IO::AIO::max_outstanding $maxreqs
1321 Sets the maximum number of outstanding requests to $nreqs. If you do
1322 queue up more than this number of requests, the next call to
1323 "IO::AIO::poll_cb" (and other functions calling "poll_cb", such as
1324 "IO::AIO::flush" or "IO::AIO::poll") will block until the limit is
1325 no longer exceeded.
1326
1327 In other words, this setting does not enforce a queue limit, but can
1328 be used to make poll functions block if the limit is exceeded.
1329
860 This is a very bad function to use in interactive programs because 1330 This is a very bad function to use in interactive programs because
861 it blocks, and a bad way to reduce concurrency because it is 1331 it blocks, and a bad way to reduce concurrency because it is
862 inexact: Better use an "aio_group" together with a feed callback. 1332 inexact: Better use an "aio_group" together with a feed callback.
863 1333
864 Sets the maximum number of outstanding requests to $nreqs. If you do 1334 It's main use is in scripts without an event loop - when you want to
865 queue up more than this number of requests, the next call to the 1335 stat a lot of files, you can write somehting like this:
866 "poll_cb" (and "poll_some" and other functions calling "poll_cb")
867 function will block until the limit is no longer exceeded.
868 1336
869 The default value is very large, so there is no practical limit on 1337 IO::AIO::max_outstanding 32;
1338
1339 for my $path (...) {
1340 aio_stat $path , ...;
1341 IO::AIO::poll_cb;
1342 }
1343
1344 IO::AIO::flush;
1345
1346 The call to "poll_cb" inside the loop will normally return
1347 instantly, but as soon as more thna 32 reqeusts are in-flight, it
1348 will block until some requests have been handled. This keeps the
1349 loop from pushing a large number of "aio_stat" requests onto the
1350 queue.
1351
1352 The default value for "max_outstanding" is very large, so there is
870 the number of outstanding requests. 1353 no practical limit on the number of outstanding requests.
871
872 You can still queue as many requests as you want. Therefore,
873 "max_oustsanding" is mainly useful in simple scripts (with low
874 values) or as a stop gap to shield against fatal memory overflow
875 (with large values).
876 1354
877 STATISTICAL INFORMATION 1355 STATISTICAL INFORMATION
878 IO::AIO::nreqs 1356 IO::AIO::nreqs
879 Returns the number of requests currently in the ready, execute or 1357 Returns the number of requests currently in the ready, execute or
880 pending states (i.e. for which their callback has not been invoked 1358 pending states (i.e. for which their callback has not been invoked
891 1369
892 IO::AIO::npending 1370 IO::AIO::npending
893 Returns the number of requests currently in the pending state 1371 Returns the number of requests currently in the pending state
894 (executed, but not yet processed by poll_cb). 1372 (executed, but not yet processed by poll_cb).
895 1373
1374 MISCELLANEOUS FUNCTIONS
1375 IO::AIO implements some functions that might be useful, but are not
1376 asynchronous.
1377
1378 IO::AIO::sendfile $ofh, $ifh, $offset, $count
1379 Calls the "eio_sendfile_sync" function, which is like
1380 "aio_sendfile", but is blocking (this makes most sense if you know
1381 the input data is likely cached already and the output filehandle is
1382 set to non-blocking operations).
1383
1384 Returns the number of bytes copied, or -1 on error.
1385
1386 IO::AIO::fadvise $fh, $offset, $len, $advice
1387 Simply calls the "posix_fadvise" function (see its manpage for
1388 details). The following advice constants are available:
1389 "IO::AIO::FADV_NORMAL", "IO::AIO::FADV_SEQUENTIAL",
1390 "IO::AIO::FADV_RANDOM", "IO::AIO::FADV_NOREUSE",
1391 "IO::AIO::FADV_WILLNEED", "IO::AIO::FADV_DONTNEED".
1392
1393 On systems that do not implement "posix_fadvise", this function
1394 returns ENOSYS, otherwise the return value of "posix_fadvise".
1395
1396 IO::AIO::madvise $scalar, $offset, $len, $advice
1397 Simply calls the "posix_madvise" function (see its manpage for
1398 details). The following advice constants are available:
1399 "IO::AIO::MADV_NORMAL", "IO::AIO::MADV_SEQUENTIAL",
1400 "IO::AIO::MADV_RANDOM", "IO::AIO::MADV_WILLNEED",
1401 "IO::AIO::MADV_DONTNEED".
1402
1403 On systems that do not implement "posix_madvise", this function
1404 returns ENOSYS, otherwise the return value of "posix_madvise".
1405
1406 IO::AIO::mprotect $scalar, $offset, $len, $protect
1407 Simply calls the "mprotect" function on the preferably AIO::mmap'ed
1408 $scalar (see its manpage for details). The following protect
1409 constants are available: "IO::AIO::PROT_NONE", "IO::AIO::PROT_READ",
1410 "IO::AIO::PROT_WRITE", "IO::AIO::PROT_EXEC".
1411
1412 On systems that do not implement "mprotect", this function returns
1413 ENOSYS, otherwise the return value of "mprotect".
1414
1415 IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1416 Memory-maps a file (or anonymous memory range) and attaches it to
1417 the given $scalar, which will act like a string scalar.
1418
1419 The only operations allowed on the scalar are "substr"/"vec" that
1420 don't change the string length, and most read-only operations such
1421 as copying it or searching it with regexes and so on.
1422
1423 Anything else is unsafe and will, at best, result in memory leaks.
1424
1425 The memory map associated with the $scalar is automatically removed
1426 when the $scalar is destroyed, or when the "IO::AIO::mmap" or
1427 "IO::AIO::munmap" functions are called.
1428
1429 This calls the "mmap"(2) function internally. See your system's
1430 manual page for details on the $length, $prot and $flags parameters.
1431
1432 The $length must be larger than zero and smaller than the actual
1433 filesize.
1434
1435 $prot is a combination of "IO::AIO::PROT_NONE",
1436 "IO::AIO::PROT_EXEC", "IO::AIO::PROT_READ" and/or
1437 "IO::AIO::PROT_WRITE",
1438
1439 $flags can be a combination of "IO::AIO::MAP_SHARED" or
1440 "IO::AIO::MAP_PRIVATE", or a number of system-specific flags (when
1441 not available, the are defined as 0): "IO::AIO::MAP_ANONYMOUS"
1442 (which is set to "MAP_ANON" if your system only provides this
1443 constant), "IO::AIO::MAP_HUGETLB", "IO::AIO::MAP_LOCKED",
1444 "IO::AIO::MAP_NORESERVE", "IO::AIO::MAP_POPULATE" or
1445 "IO::AIO::MAP_NONBLOCK"
1446
1447 If $fh is "undef", then a file descriptor of -1 is passed.
1448
1449 $offset is the offset from the start of the file - it generally must
1450 be a multiple of "IO::AIO::PAGESIZE" and defaults to 0.
1451
1452 Example:
1453
1454 use Digest::MD5;
1455 use IO::AIO;
1456
1457 open my $fh, "<verybigfile"
1458 or die "$!";
1459
1460 IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
1461 or die "verybigfile: $!";
1462
1463 my $fast_md5 = md5 $data;
1464
1465 IO::AIO::munmap $scalar
1466 Removes a previous mmap and undefines the $scalar.
1467
1468 IO::AIO::munlock $scalar, $offset = 0, $length = undef
1469 Calls the "munlock" function, undoing the effects of a previous
1470 "aio_mlock" call (see its description for details).
1471
1472 IO::AIO::munlockall
1473 Calls the "munlockall" function.
1474
1475 On systems that do not implement "munlockall", this function returns
1476 ENOSYS, otherwise the return value of "munlockall".
1477
1478EVENT LOOP INTEGRATION
1479 It is recommended to use AnyEvent::AIO to integrate IO::AIO
1480 automatically into many event loops:
1481
1482 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
1483 use AnyEvent::AIO;
1484
1485 You can also integrate IO::AIO manually into many event loops, here are
1486 some examples of how to do this:
1487
1488 # EV integration
1489 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
1490
1491 # Event integration
1492 Event->io (fd => IO::AIO::poll_fileno,
1493 poll => 'r',
1494 cb => \&IO::AIO::poll_cb);
1495
1496 # Glib/Gtk2 integration
1497 add_watch Glib::IO IO::AIO::poll_fileno,
1498 in => sub { IO::AIO::poll_cb; 1 };
1499
1500 # Tk integration
1501 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
1502 readable => \&IO::AIO::poll_cb);
1503
1504 # Danga::Socket integration
1505 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
1506 \&IO::AIO::poll_cb);
1507
896 FORK BEHAVIOUR 1508 FORK BEHAVIOUR
897 This module should do "the right thing" when the process using it forks: 1509 Usage of pthreads in a program changes the semantics of fork
1510 considerably. Specifically, only async-safe functions can be called
1511 after fork. Perl doesn't know about this, so in general, you cannot call
1512 fork with defined behaviour in perl if pthreads are involved. IO::AIO
1513 uses pthreads, so this applies, but many other extensions and (for
1514 inexplicable reasons) perl itself often is linked against pthreads, so
1515 this limitation applies to quite a lot of perls.
898 1516
899 Before the fork, IO::AIO enters a quiescent state where no requests can 1517 This module no longer tries to fight your OS, or POSIX. That means
900 be added in other threads and no results will be processed. After the 1518 IO::AIO only works in the process that loaded it. Forking is fully
901 fork the parent simply leaves the quiescent state and continues 1519 supported, but using IO::AIO in the child is not.
902 request/result processing, while the child frees the request/result
903 queue (so that the requests started before the fork will only be handled
904 in the parent). Threads will be started on demand until the limit set in
905 the parent process has been reached again.
906 1520
907 In short: the parent will, after a short pause, continue as if fork had 1521 You might get around by not *using* IO::AIO before (or after) forking.
908 not been called, while the child will act as if IO::AIO has not been 1522 You could also try to call the IO::AIO::reinit function in the child:
909 used yet. 1523
1524 IO::AIO::reinit
1525 Abandons all current requests and I/O threads and simply
1526 reinitialises all data structures. This is not an operation
1527 supported by any standards, but happens to work on GNU/Linux and
1528 some newer BSD systems.
1529
1530 The only reasonable use for this function is to call it after
1531 forking, if "IO::AIO" was used in the parent. Calling it while
1532 IO::AIO is active in the process will result in undefined behaviour.
1533 Calling it at any time will also result in any undefined (by POSIX)
1534 behaviour.
910 1535
911 MEMORY USAGE 1536 MEMORY USAGE
912 Per-request usage: 1537 Per-request usage:
913 1538
914 Each aio request uses - depending on your architecture - around 100-200 1539 Each aio request uses - depending on your architecture - around 100-200
928 1553
929KNOWN BUGS 1554KNOWN BUGS
930 Known bugs will be fixed in the next release. 1555 Known bugs will be fixed in the next release.
931 1556
932SEE ALSO 1557SEE ALSO
933 Coro::AIO. 1558 AnyEvent::AIO for easy integration into event loops, Coro::AIO for a
1559 more natural syntax.
934 1560
935AUTHOR 1561AUTHOR
936 Marc Lehmann <schmorp@schmorp.de> 1562 Marc Lehmann <schmorp@schmorp.de>
937 http://home.schmorp.de/ 1563 http://home.schmorp.de/
938 1564

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines