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

Comparing IO-AIO/README (file contents):
Revision 1.46 by root, Sun Mar 27 10:26:08 2011 UTC vs.
Revision 1.61 by root, Sun Aug 12 06:07:06 2018 UTC

1NAME 1NAME
2 IO::AIO - Asynchronous Input/Output 2 IO::AIO - Asynchronous/Advanced Input/Output
3 3
4SYNOPSIS 4SYNOPSIS
5 use IO::AIO; 5 use IO::AIO;
6 6
7 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub { 7 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
… …
55 not well-supported or restricted (GNU/Linux doesn't allow them on normal 55 not well-supported or restricted (GNU/Linux doesn't allow them on normal
56 files currently, for example), and they would only support aio_read and 56 files currently, for example), and they would only support aio_read and
57 aio_write, so the remaining functionality would have to be implemented 57 aio_write, so the remaining functionality would have to be implemented
58 using threads anyway. 58 using threads anyway.
59 59
60 In addition to asynchronous I/O, this module also exports some rather
61 arcane interfaces, such as "madvise" or linux's "splice" system call,
62 which is why the "A" in "AIO" can also mean *advanced*.
63
60 Although the module will work in the presence of other (Perl-) threads, 64 Although the module will work in the presence of other (Perl-) threads,
61 it is currently not reentrant in any way, so use appropriate locking 65 it is currently not reentrant in any way, so use appropriate locking
62 yourself, always call "poll_cb" from within the same thread, or never 66 yourself, always call "poll_cb" from within the same thread, or never
63 call "poll_cb" (or other "aio_" functions) recursively. 67 call "poll_cb" (or other "aio_" functions) recursively.
64 68
65 EXAMPLE 69 EXAMPLE
66 This is a simple example that uses the EV module and loads /etc/passwd 70 This is a simple example that uses the EV module and loads /etc/passwd
67 asynchronously: 71 asynchronously:
68 72
69 use Fcntl;
70 use EV; 73 use EV;
71 use IO::AIO; 74 use IO::AIO;
72 75
73 # register the IO::AIO callback with EV 76 # register the IO::AIO callback with EV
74 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; 77 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
… …
91 94
92 # file contents now in $contents 95 # file contents now in $contents
93 print $contents; 96 print $contents;
94 97
95 # exit event loop and program 98 # exit event loop and program
96 EV::unloop; 99 EV::break;
97 }; 100 };
98 }; 101 };
99 102
100 # possibly queue up other requests, or open GUI windows, 103 # possibly queue up other requests, or open GUI windows,
101 # check for sockets etc. etc. 104 # check for sockets etc. etc.
102 105
103 # process events as long as there are some: 106 # process events as long as there are some:
104 EV::loop; 107 EV::run;
105 108
106REQUEST ANATOMY AND LIFETIME 109REQUEST ANATOMY AND LIFETIME
107 Every "aio_*" function creates a request. which is a C data structure 110 Every "aio_*" function creates a request. which is a C data structure
108 not directly visible to Perl. 111 not directly visible to Perl.
109 112
… …
146 the actual aio request is severed and calling its methods will 149 the actual aio request is severed and calling its methods will
147 either do nothing or result in a runtime error). 150 either do nothing or result in a runtime error).
148 151
149FUNCTIONS 152FUNCTIONS
150 QUICK OVERVIEW 153 QUICK OVERVIEW
151 This section simply lists the prototypes of the most important functions 154 This section simply lists the prototypes most of the functions for quick
152 for quick reference. See the following sections for function-by-function 155 reference. See the following sections for function-by-function
153 documentation. 156 documentation.
154 157
158 aio_wd $pathname, $callback->($wd)
155 aio_open $pathname, $flags, $mode, $callback->($fh) 159 aio_open $pathname, $flags, $mode, $callback->($fh)
156 aio_close $fh, $callback->($status) 160 aio_close $fh, $callback->($status)
161 aio_seek $fh,$offset,$whence, $callback->($offs)
157 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 162 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
158 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 163 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
159 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 164 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
160 aio_readahead $fh,$offset,$length, $callback->($retval) 165 aio_readahead $fh,$offset,$length, $callback->($retval)
161 aio_stat $fh_or_path, $callback->($status) 166 aio_stat $fh_or_path, $callback->($status)
162 aio_lstat $fh, $callback->($status) 167 aio_lstat $fh, $callback->($status)
163 aio_statvfs $fh_or_path, $callback->($statvfs) 168 aio_statvfs $fh_or_path, $callback->($statvfs)
164 aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 169 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
165 aio_chown $fh_or_path, $uid, $gid, $callback->($status) 170 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
171 aio_chmod $fh_or_path, $mode, $callback->($status)
166 aio_truncate $fh_or_path, $offset, $callback->($status) 172 aio_truncate $fh_or_path, $offset, $callback->($status)
167 aio_chmod $fh_or_path, $mode, $callback->($status) 173 aio_allocate $fh, $mode, $offset, $len, $callback->($status)
174 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
168 aio_unlink $pathname, $callback->($status) 175 aio_unlink $pathname, $callback->($status)
169 aio_mknod $path, $mode, $dev, $callback->($status) 176 aio_mknod $pathname, $mode, $dev, $callback->($status)
170 aio_link $srcpath, $dstpath, $callback->($status) 177 aio_link $srcpath, $dstpath, $callback->($status)
171 aio_symlink $srcpath, $dstpath, $callback->($status) 178 aio_symlink $srcpath, $dstpath, $callback->($status)
172 aio_readlink $path, $callback->($link) 179 aio_readlink $pathname, $callback->($link)
180 aio_realpath $pathname, $callback->($path)
173 aio_rename $srcpath, $dstpath, $callback->($status) 181 aio_rename $srcpath, $dstpath, $callback->($status)
182 aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
174 aio_mkdir $pathname, $mode, $callback->($status) 183 aio_mkdir $pathname, $mode, $callback->($status)
175 aio_rmdir $pathname, $callback->($status) 184 aio_rmdir $pathname, $callback->($status)
176 aio_readdir $pathname, $callback->($entries) 185 aio_readdir $pathname, $callback->($entries)
177 aio_readdirx $pathname, $flags, $callback->($entries, $flags) 186 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
178 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST 187 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
179 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN 188 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
189 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
180 aio_load $path, $data, $callback->($status) 190 aio_load $pathname, $data, $callback->($status)
181 aio_copy $srcpath, $dstpath, $callback->($status) 191 aio_copy $srcpath, $dstpath, $callback->($status)
182 aio_move $srcpath, $dstpath, $callback->($status) 192 aio_move $srcpath, $dstpath, $callback->($status)
183 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
184 aio_rmtree $path, $callback->($status) 193 aio_rmtree $pathname, $callback->($status)
194 aio_fcntl $fh, $cmd, $arg, $callback->($status)
195 aio_ioctl $fh, $request, $buf, $callback->($status)
185 aio_sync $callback->($status) 196 aio_sync $callback->($status)
197 aio_syncfs $fh, $callback->($status)
186 aio_fsync $fh, $callback->($status) 198 aio_fsync $fh, $callback->($status)
187 aio_fdatasync $fh, $callback->($status) 199 aio_fdatasync $fh, $callback->($status)
188 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 200 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
189 aio_pathsync $path, $callback->($status) 201 aio_pathsync $pathname, $callback->($status)
190 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 202 aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
191 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 203 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
192 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 204 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
193 aio_mlockall $flags, $callback->($status) 205 aio_mlockall $flags, $callback->($status)
194 aio_group $callback->(...) 206 aio_group $callback->(...)
195 aio_nop $callback->() 207 aio_nop $callback->()
… …
209 IO::AIO::idle_timeout $seconds 221 IO::AIO::idle_timeout $seconds
210 IO::AIO::max_outstanding $maxreqs 222 IO::AIO::max_outstanding $maxreqs
211 IO::AIO::nreqs 223 IO::AIO::nreqs
212 IO::AIO::nready 224 IO::AIO::nready
213 IO::AIO::npending 225 IO::AIO::npending
226 $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL]
227 IO::AIO::min_fdlimit $nfd [EXPERIMENTAL]
214 228
215 IO::AIO::sendfile $ofh, $ifh, $offset, $count 229 IO::AIO::sendfile $ofh, $ifh, $offset, $count
216 IO::AIO::fadvise $fh, $offset, $len, $advice 230 IO::AIO::fadvise $fh, $offset, $len, $advice
231 IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
232 IO::AIO::munmap $scalar
233 IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]
217 IO::AIO::madvise $scalar, $offset, $length, $advice 234 IO::AIO::madvise $scalar, $offset, $length, $advice
218 IO::AIO::mprotect $scalar, $offset, $length, $protect 235 IO::AIO::mprotect $scalar, $offset, $length, $protect
219 IO::AIO::munlock $scalar, $offset = 0, $length = undef 236 IO::AIO::munlock $scalar, $offset = 0, $length = undef
220 IO::AIO::munlockall 237 IO::AIO::munlockall
221 238
222 AIO REQUEST FUNCTIONS 239 API NOTES
223 All the "aio_*" calls are more or less thin wrappers around the syscall 240 All the "aio_*" calls are more or less thin wrappers around the syscall
224 with the same name (sans "aio_"). The arguments are similar or 241 with the same name (sans "aio_"). The arguments are similar or
225 identical, and they all accept an additional (and optional) $callback 242 identical, and they all accept an additional (and optional) $callback
226 argument which must be a code reference. This code reference will get 243 argument which must be a code reference. This code reference will be
227 called with the syscall return code (e.g. most syscalls return -1 on
228 error, unlike perl, which usually delivers "false") as its sole argument
229 after the given syscall has been executed asynchronously. 244 called after the syscall has been executed in an asynchronous fashion.
245 The results of the request will be passed as arguments to the callback
246 (and, if an error occured, in $!) - for most requests the syscall return
247 code (e.g. most syscalls return -1 on error, unlike perl, which usually
248 delivers "false").
249
250 Some requests (such as "aio_readdir") pass the actual results and
251 communicate failures by passing "undef".
230 252
231 All functions expecting a filehandle keep a copy of the filehandle 253 All functions expecting a filehandle keep a copy of the filehandle
232 internally until the request has finished. 254 internally until the request has finished.
233 255
234 All functions return request objects of type IO::AIO::REQ that allow 256 All functions return request objects of type IO::AIO::REQ that allow
235 further manipulation of those requests while they are in-flight. 257 further manipulation of those requests while they are in-flight.
236 258
237 The pathnames you pass to these routines *must* be absolute and encoded 259 The pathnames you pass to these routines *should* be absolute. The
238 as octets. The reason for the former is that at the time the request is 260 reason for this is that at the time the request is being executed, the
239 being executed, the current working directory could have changed. 261 current working directory could have changed. Alternatively, you can
240 Alternatively, you can make sure that you never change the current 262 make sure that you never change the current working directory anywhere
241 working directory anywhere in the program and then use relative paths. 263 in the program and then use relative paths. You can also take advantage
264 of IO::AIOs working directory abstraction, that lets you specify paths
265 relative to some previously-opened "working directory object" - see the
266 description of the "IO::AIO::WD" class later in this document.
242 267
243 To encode pathnames as octets, either make sure you either: a) always 268 To encode pathnames as octets, either make sure you either: a) always
244 pass in filenames you got from outside (command line, readdir etc.) 269 pass in filenames you got from outside (command line, readdir etc.)
245 without tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module 270 without tinkering, b) are in your native filesystem encoding, c) use the
246 and encode your pathnames to the locale (or other) encoding in effect in 271 Encode module and encode your pathnames to the locale (or other)
247 the user environment, d) use Glib::filename_from_unicode on unicode 272 encoding in effect in the user environment, d) use
248 filenames or e) use something else to ensure your scalar has the correct 273 Glib::filename_from_unicode on unicode filenames or e) use something
249 contents. 274 else to ensure your scalar has the correct contents.
250 275
251 This works, btw. independent of the internal UTF-8 bit, which IO::AIO 276 This works, btw. independent of the internal UTF-8 bit, which IO::AIO
252 handles correctly whether it is set or not. 277 handles correctly whether it is set or not.
253 278
279 AIO REQUEST FUNCTIONS
254 $prev_pri = aioreq_pri [$pri] 280 $prev_pri = aioreq_pri [$pri]
255 Returns the priority value that would be used for the next request 281 Returns the priority value that would be used for the next request
256 and, if $pri is given, sets the priority for the next aio request. 282 and, if $pri is given, sets the priority for the next aio request.
257 283
258 The default priority is 0, the minimum and maximum priorities are -4 284 The default priority is 0, the minimum and maximum priorities are -4
… …
280 Similar to "aioreq_pri", but subtracts the given value from the 306 Similar to "aioreq_pri", but subtracts the given value from the
281 current priority, so the effect is cumulative. 307 current priority, so the effect is cumulative.
282 308
283 aio_open $pathname, $flags, $mode, $callback->($fh) 309 aio_open $pathname, $flags, $mode, $callback->($fh)
284 Asynchronously open or create a file and call the callback with a 310 Asynchronously open or create a file and call the callback with a
285 newly created filehandle for the file. 311 newly created filehandle for the file (or "undef" in case of an
312 error).
286 313
287 The pathname passed to "aio_open" must be absolute. See API NOTES, 314 The pathname passed to "aio_open" must be absolute. See API NOTES,
288 above, for an explanation. 315 above, for an explanation.
289 316
290 The $flags argument is a bitmask. See the "Fcntl" module for a list. 317 The $flags argument is a bitmask. See the "Fcntl" module for a list.
… …
306 } else { 333 } else {
307 die "open failed: $!\n"; 334 die "open failed: $!\n";
308 } 335 }
309 }; 336 };
310 337
338 In addition to all the common open modes/flags ("O_RDONLY",
339 "O_WRONLY", "O_RDWR", "O_CREAT", "O_TRUNC", "O_EXCL" and
340 "O_APPEND"), the following POSIX and non-POSIX constants are
341 available (missing ones on your system are, as usual, 0):
342
343 "O_ASYNC", "O_DIRECT", "O_NOATIME", "O_CLOEXEC", "O_NOCTTY",
344 "O_NOFOLLOW", "O_NONBLOCK", "O_EXEC", "O_SEARCH", "O_DIRECTORY",
345 "O_DSYNC", "O_RSYNC", "O_SYNC", "O_PATH", "O_TMPFILE", "O_TTY_INIT"
346 and "O_ACCMODE".
347
311 aio_close $fh, $callback->($status) 348 aio_close $fh, $callback->($status)
312 Asynchronously close a file and call the callback with the result 349 Asynchronously close a file and call the callback with the result
313 code. 350 code.
314 351
315 Unfortunately, you can't do this to perl. Perl *insists* very 352 Unfortunately, you can't do this to perl. Perl *insists* very
… …
320 will use dup2 to overwrite the file descriptor with the write-end of 357 will use dup2 to overwrite the file descriptor with the write-end of
321 a pipe (the pipe fd will be created on demand and will be cached). 358 a pipe (the pipe fd will be created on demand and will be cached).
322 359
323 Or in other words: the file descriptor will be closed, but it will 360 Or in other words: the file descriptor will be closed, but it will
324 not be free for reuse until the perl filehandle is closed. 361 not be free for reuse until the perl filehandle is closed.
362
363 aio_seek $fh, $offset, $whence, $callback->($offs)
364 Seeks the filehandle to the new $offset, similarly to perl's
365 "sysseek". The $whence can use the traditional values (0 for
366 "IO::AIO::SEEK_SET", 1 for "IO::AIO::SEEK_CUR" or 2 for
367 "IO::AIO::SEEK_END").
368
369 The resulting absolute offset will be passed to the callback, or -1
370 in case of an error.
371
372 In theory, the $whence constants could be different than the
373 corresponding values from Fcntl, but perl guarantees they are the
374 same, so don't panic.
375
376 As a GNU/Linux (and maybe Solaris) extension, also the constants
377 "IO::AIO::SEEK_DATA" and "IO::AIO::SEEK_HOLE" are available, if they
378 could be found. No guarantees about suitability for use in
379 "aio_seek" or Perl's "sysseek" can be made though, although I would
380 naively assume they "just work".
325 381
326 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 382 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
327 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 383 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
328 Reads or writes $length bytes from or to the specified $fh and 384 Reads or writes $length bytes from or to the specified $fh and
329 $offset into the scalar given by $data and offset $dataoffset and 385 $offset into the scalar given by $data and offset $dataoffset and
330 calls the callback without the actual number of bytes read (or -1 on 386 calls the callback with the actual number of bytes transferred (or
331 error, just like the syscall). 387 -1 on error, just like the syscall).
332 388
333 "aio_read" will, like "sysread", shrink or grow the $data scalar to 389 "aio_read" will, like "sysread", shrink or grow the $data scalar to
334 offset plus the actual number of bytes read. 390 offset plus the actual number of bytes read.
335 391
336 If $offset is undefined, then the current file descriptor offset 392 If $offset is undefined, then the current file descriptor offset
… …
358 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 414 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
359 Tries to copy $length bytes from $in_fh to $out_fh. It starts 415 Tries to copy $length bytes from $in_fh to $out_fh. It starts
360 reading at byte offset $in_offset, and starts writing at the current 416 reading at byte offset $in_offset, and starts writing at the current
361 file offset of $out_fh. Because of that, it is not safe to issue 417 file offset of $out_fh. Because of that, it is not safe to issue
362 more than one "aio_sendfile" per $out_fh, as they will interfere 418 more than one "aio_sendfile" per $out_fh, as they will interfere
363 with each other. 419 with each other. The same $in_fh works fine though, as this function
420 does not move or use the file offset of $in_fh.
364 421
365 Please note that "aio_sendfile" can read more bytes from $in_fh than 422 Please note that "aio_sendfile" can read more bytes from $in_fh than
366 are written, and there is no way to find out how many bytes have 423 are written, and there is no way to find out how many more bytes
367 been read from "aio_sendfile" alone, as "aio_sendfile" only provides 424 have been read from "aio_sendfile" alone, as "aio_sendfile" only
368 the number of bytes written to $out_fh. Only if the result value 425 provides the number of bytes written to $out_fh. Only if the result
369 equals $length one can assume that $length bytes have been read. 426 value equals $length one can assume that $length bytes have been
427 read.
370 428
371 Unlike with other "aio_" functions, it makes a lot of sense to use 429 Unlike with other "aio_" functions, it makes a lot of sense to use
372 "aio_sendfile" on non-blocking sockets, as long as one end 430 "aio_sendfile" on non-blocking sockets, as long as one end
373 (typically the $in_fh) is a file - the file I/O will then be 431 (typically the $in_fh) is a file - the file I/O will then be
374 asynchronous, while the socket I/O will be non-blocking. Note, 432 asynchronous, while the socket I/O will be non-blocking. Note,
375 however, that you can run into a trap where "aio_sendfile" reads 433 however, that you can run into a trap where "aio_sendfile" reads
376 some data with readahead, then fails to write all data, and when the 434 some data with readahead, then fails to write all data, and when the
377 socket is ready the next time, the data in the cache is already 435 socket is ready the next time, the data in the cache is already
378 lost, forcing "aio_sendfile" to again hit the disk. Explicit 436 lost, forcing "aio_sendfile" to again hit the disk. Explicit
379 "aio_read" + "aio_write" let's you control resource usage much 437 "aio_read" + "aio_write" let's you better control resource usage.
380 better.
381 438
382 This call tries to make use of a native "sendfile" syscall to 439 This call tries to make use of a native "sendfile"-like syscall to
383 provide zero-copy operation. For this to work, $out_fh should refer 440 provide zero-copy operation. For this to work, $out_fh should refer
384 to a socket, and $in_fh should refer to an mmap'able file. 441 to a socket, and $in_fh should refer to an mmap'able file.
385 442
386 If a native sendfile cannot be found or it fails with "ENOSYS", 443 If a native sendfile cannot be found or it fails with "ENOSYS",
387 "ENOTSUP", "EOPNOTSUPP", "EAFNOSUPPORT", "EPROTOTYPE" or "ENOTSOCK", 444 "EINVAL", "ENOTSUP", "EOPNOTSUPP", "EAFNOSUPPORT", "EPROTOTYPE" or
388 it will be emulated, so you can call "aio_sendfile" on any type of 445 "ENOTSOCK", it will be emulated, so you can call "aio_sendfile" on
389 filehandle regardless of the limitations of the operating system. 446 any type of filehandle regardless of the limitations of the
447 operating system.
448
449 As native sendfile syscalls (as practically any non-POSIX interface
450 hacked together in a hurry to improve benchmark numbers) tend to be
451 rather buggy on many systems, this implementation tries to work
452 around some known bugs in Linux and FreeBSD kernels (probably
453 others, too), but that might fail, so you really really should check
454 the return value of "aio_sendfile" - fewer bytes than expected might
455 have been transferred.
390 456
391 aio_readahead $fh,$offset,$length, $callback->($retval) 457 aio_readahead $fh,$offset,$length, $callback->($retval)
392 "aio_readahead" populates the page cache with data from a file so 458 "aio_readahead" populates the page cache with data from a file so
393 that subsequent reads from that file will not block on disk I/O. The 459 that subsequent reads from that file will not block on disk I/O. The
394 $offset argument specifies the starting point from which data is to 460 $offset argument specifies the starting point from which data is to
… …
397 to a page boundary and bytes are read up to the next page boundary 463 to a page boundary and bytes are read up to the next page boundary
398 greater than or equal to (off-set+length). "aio_readahead" does not 464 greater than or equal to (off-set+length). "aio_readahead" does not
399 read beyond the end of the file. The current file offset of the file 465 read beyond the end of the file. The current file offset of the file
400 is left unchanged. 466 is left unchanged.
401 467
402 If that syscall doesn't exist (likely if your OS isn't Linux) it 468 If that syscall doesn't exist (likely if your kernel isn't Linux) it
403 will be emulated by simply reading the data, which would have a 469 will be emulated by simply reading the data, which would have a
404 similar effect. 470 similar effect.
405 471
406 aio_stat $fh_or_path, $callback->($status) 472 aio_stat $fh_or_path, $callback->($status)
407 aio_lstat $fh, $callback->($status) 473 aio_lstat $fh, $callback->($status)
… …
423 back on traditional behaviour). 489 back on traditional behaviour).
424 490
425 "S_IFMT", "S_IFIFO", "S_IFCHR", "S_IFBLK", "S_IFLNK", "S_IFREG", 491 "S_IFMT", "S_IFIFO", "S_IFCHR", "S_IFBLK", "S_IFLNK", "S_IFREG",
426 "S_IFDIR", "S_IFWHT", "S_IFSOCK", "IO::AIO::major $dev_t", 492 "S_IFDIR", "S_IFWHT", "S_IFSOCK", "IO::AIO::major $dev_t",
427 "IO::AIO::minor $dev_t", "IO::AIO::makedev $major, $minor". 493 "IO::AIO::minor $dev_t", "IO::AIO::makedev $major, $minor".
494
495 To access higher resolution stat timestamps, see "SUBSECOND STAT
496 TIME ACCESS".
428 497
429 Example: Print the length of /etc/passwd: 498 Example: Print the length of /etc/passwd:
430 499
431 aio_stat "/etc/passwd", sub { 500 aio_stat "/etc/passwd", sub {
432 $_[0] and die "stat failed: $!"; 501 $_[0] and die "stat failed: $!";
… …
505 aio_chown "path", 0, undef; 574 aio_chown "path", 0, undef;
506 575
507 aio_truncate $fh_or_path, $offset, $callback->($status) 576 aio_truncate $fh_or_path, $offset, $callback->($status)
508 Works like truncate(2) or ftruncate(2). 577 Works like truncate(2) or ftruncate(2).
509 578
579 aio_allocate $fh, $mode, $offset, $len, $callback->($status)
580 Allocates or frees disk space according to the $mode argument. See
581 the linux "fallocate" documentation for details.
582
583 $mode is usually 0 or "IO::AIO::FALLOC_FL_KEEP_SIZE" to allocate
584 space, or "IO::AIO::FALLOC_FL_PUNCH_HOLE |
585 IO::AIO::FALLOC_FL_KEEP_SIZE", to deallocate a file range.
586
587 IO::AIO also supports "FALLOC_FL_COLLAPSE_RANGE", to remove a range
588 (without leaving a hole), "FALLOC_FL_ZERO_RANGE", to zero a range,
589 "FALLOC_FL_INSERT_RANGE" to insert a range and
590 "FALLOC_FL_UNSHARE_RANGE" to unshare shared blocks (see your
591 fallocate(2) manpage).
592
593 The file system block size used by "fallocate" is presumably the
594 "f_bsize" returned by "statvfs", but different filesystems and
595 filetypes can dictate other limitations.
596
597 If "fallocate" isn't available or cannot be emulated (currently no
598 emulation will be attempted), passes -1 and sets $! to "ENOSYS".
599
510 aio_chmod $fh_or_path, $mode, $callback->($status) 600 aio_chmod $fh_or_path, $mode, $callback->($status)
511 Works like perl's "chmod" function. 601 Works like perl's "chmod" function.
512 602
513 aio_unlink $pathname, $callback->($status) 603 aio_unlink $pathname, $callback->($status)
514 Asynchronously unlink (delete) a file and call the callback with the 604 Asynchronously unlink (delete) a file and call the callback with the
515 result code. 605 result code.
516 606
517 aio_mknod $path, $mode, $dev, $callback->($status) 607 aio_mknod $pathname, $mode, $dev, $callback->($status)
518 [EXPERIMENTAL] 608 [EXPERIMENTAL]
519 609
520 Asynchronously create a device node (or fifo). See mknod(2). 610 Asynchronously create a device node (or fifo). See mknod(2).
521 611
522 The only (POSIX-) portable way of calling this function is: 612 The only (POSIX-) portable way of calling this function is:
523 613
524 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 614 aio_mknod $pathname, IO::AIO::S_IFIFO | $mode, 0, sub { ...
525 615
526 See "aio_stat" for info about some potentially helpful extra 616 See "aio_stat" for info about some potentially helpful extra
527 constants and functions. 617 constants and functions.
528 618
529 aio_link $srcpath, $dstpath, $callback->($status) 619 aio_link $srcpath, $dstpath, $callback->($status)
… …
533 aio_symlink $srcpath, $dstpath, $callback->($status) 623 aio_symlink $srcpath, $dstpath, $callback->($status)
534 Asynchronously create a new symbolic link to the existing object at 624 Asynchronously create a new symbolic link to the existing object at
535 $srcpath at the path $dstpath and call the callback with the result 625 $srcpath at the path $dstpath and call the callback with the result
536 code. 626 code.
537 627
538 aio_readlink $path, $callback->($link) 628 aio_readlink $pathname, $callback->($link)
539 Asynchronously read the symlink specified by $path and pass it to 629 Asynchronously read the symlink specified by $path and pass it to
540 the callback. If an error occurs, nothing or undef gets passed to 630 the callback. If an error occurs, nothing or undef gets passed to
541 the callback. 631 the callback.
542 632
633 aio_realpath $pathname, $callback->($path)
634 Asynchronously make the path absolute and resolve any symlinks in
635 $path. The resulting path only consists of directories (same as
636 Cwd::realpath).
637
638 This request can be used to get the absolute path of the current
639 working directory by passing it a path of . (a single dot).
640
543 aio_rename $srcpath, $dstpath, $callback->($status) 641 aio_rename $srcpath, $dstpath, $callback->($status)
544 Asynchronously rename the object at $srcpath to $dstpath, just as 642 Asynchronously rename the object at $srcpath to $dstpath, just as
545 rename(2) and call the callback with the result code. 643 rename(2) and call the callback with the result code.
644
645 On systems that support the AIO::WD working directory abstraction
646 natively, the case "[$wd, "."]" as $srcpath is specialcased -
647 instead of failing, "rename" is called on the absolute path of $wd.
648
649 aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
650 Basically a version of "aio_rename" with an additional $flags
651 argument. Calling this with "$flags=0" is the same as calling
652 "aio_rename".
653
654 Non-zero flags are currently only supported on GNU/Linux systems
655 that support renameat2. Other systems fail with "ENOSYS" in this
656 case.
657
658 The following constants are available (missing ones are, as usual
659 0), see renameat2(2) for details:
660
661 "IO::AIO::RENAME_NOREPLACE", "IO::AIO::RENAME_EXCHANGE" and
662 "IO::AIO::RENAME_WHITEOUT".
546 663
547 aio_mkdir $pathname, $mode, $callback->($status) 664 aio_mkdir $pathname, $mode, $callback->($status)
548 Asynchronously mkdir (create) a directory and call the callback with 665 Asynchronously mkdir (create) a directory and call the callback with
549 the result code. $mode will be modified by the umask at the time the 666 the result code. $mode will be modified by the umask at the time the
550 request is executed, so do not change your umask. 667 request is executed, so do not change your umask.
551 668
552 aio_rmdir $pathname, $callback->($status) 669 aio_rmdir $pathname, $callback->($status)
553 Asynchronously rmdir (delete) a directory and call the callback with 670 Asynchronously rmdir (delete) a directory and call the callback with
554 the result code. 671 the result code.
555 672
673 On systems that support the AIO::WD working directory abstraction
674 natively, the case "[$wd, "."]" is specialcased - instead of
675 failing, "rmdir" is called on the absolute path of $wd.
676
556 aio_readdir $pathname, $callback->($entries) 677 aio_readdir $pathname, $callback->($entries)
557 Unlike the POSIX call of the same name, "aio_readdir" reads an 678 Unlike the POSIX call of the same name, "aio_readdir" reads an
558 entire directory (i.e. opendir + readdir + closedir). The entries 679 entire directory (i.e. opendir + readdir + closedir). The entries
559 will not be sorted, and will NOT include the "." and ".." entries. 680 will not be sorted, and will NOT include the "." and ".." entries.
560 681
561 The callback is passed a single argument which is either "undef" or 682 The callback is passed a single argument which is either "undef" or
562 an array-ref with the filenames. 683 an array-ref with the filenames.
563 684
564 aio_readdirx $pathname, $flags, $callback->($entries, $flags) 685 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
565 Quite similar to "aio_readdir", but the $flags argument allows to 686 Quite similar to "aio_readdir", but the $flags argument allows one
566 tune behaviour and output format. In case of an error, $entries will 687 to tune behaviour and output format. In case of an error, $entries
567 be "undef". 688 will be "undef".
568 689
569 The flags are a combination of the following constants, ORed 690 The flags are a combination of the following constants, ORed
570 together (the flags will also be passed to the callback, possibly 691 together (the flags will also be passed to the callback, possibly
571 modified): 692 modified):
572 693
573 IO::AIO::READDIR_DENTS 694 IO::AIO::READDIR_DENTS
574 When this flag is off, then the callback gets an arrayref with 695 Normally the callback gets an arrayref consisting of names only
575 of names only (as with "aio_readdir"), otherwise it gets an 696 (as with "aio_readdir"). If this flag is set, then the callback
576 arrayref with "[$name, $type, $inode]" arrayrefs, each 697 gets an arrayref with "[$name, $type, $inode]" arrayrefs, each
577 describing a single directory entry in more detail. 698 describing a single directory entry in more detail:
578 699
579 $name is the name of the entry. 700 $name is the name of the entry.
580 701
581 $type is one of the "IO::AIO::DT_xxx" constants: 702 $type is one of the "IO::AIO::DT_xxx" constants:
582 703
583 "IO::AIO::DT_UNKNOWN", "IO::AIO::DT_FIFO", "IO::AIO::DT_CHR", 704 "IO::AIO::DT_UNKNOWN", "IO::AIO::DT_FIFO", "IO::AIO::DT_CHR",
584 "IO::AIO::DT_DIR", "IO::AIO::DT_BLK", "IO::AIO::DT_REG", 705 "IO::AIO::DT_DIR", "IO::AIO::DT_BLK", "IO::AIO::DT_REG",
585 "IO::AIO::DT_LNK", "IO::AIO::DT_SOCK", "IO::AIO::DT_WHT". 706 "IO::AIO::DT_LNK", "IO::AIO::DT_SOCK", "IO::AIO::DT_WHT".
586 707
587 "IO::AIO::DT_UNKNOWN" means just that: readdir does not know. If 708 "IO::AIO::DT_UNKNOWN" means just that: readdir does not know. If
588 you need to know, you have to run stat yourself. Also, for speed 709 you need to know, you have to run stat yourself. Also, for
589 reasons, the $type scalars are read-only: you can not modify 710 speed/memory reasons, the $type scalars are read-only: you must
590 them. 711 not modify them.
591 712
592 $inode is the inode number (which might not be exact on systems 713 $inode is the inode number (which might not be exact on systems
593 with 64 bit inode numbers and 32 bit perls). This field has 714 with 64 bit inode numbers and 32 bit perls). This field has
594 unspecified content on systems that do not deliver the inode 715 unspecified content on systems that do not deliver the inode
595 information. 716 information.
596 717
597 IO::AIO::READDIR_DIRS_FIRST 718 IO::AIO::READDIR_DIRS_FIRST
598 When this flag is set, then the names will be returned in an 719 When this flag is set, then the names will be returned in an
599 order where likely directories come first. This is useful when 720 order where likely directories come first, in optimal stat
600 you need to quickly find directories, or you want to find all 721 order. This is useful when you need to quickly find directories,
601 directories while avoiding to stat() each entry. 722 or you want to find all directories while avoiding to stat()
723 each entry.
602 724
603 If the system returns type information in readdir, then this is 725 If the system returns type information in readdir, then this is
604 used to find directories directly. Otherwise, likely directories 726 used to find directories directly. Otherwise, likely directories
605 are files beginning with ".", or otherwise files with no dots, 727 are names beginning with ".", or otherwise names with no dots,
606 of which files with short names are tried first. 728 of which names with short names are tried first.
607 729
608 IO::AIO::READDIR_STAT_ORDER 730 IO::AIO::READDIR_STAT_ORDER
609 When this flag is set, then the names will be returned in an 731 When this flag is set, then the names will be returned in an
610 order suitable for stat()'ing each one. That is, when you plan 732 order suitable for stat()'ing each one. That is, when you plan
611 to stat() all files in the given directory, then the returned 733 to stat() most or all files in the given directory, then the
612 order will likely be fastest. 734 returned order will likely be faster.
613 735
614 If both this flag and "IO::AIO::READDIR_DIRS_FIRST" are 736 If both this flag and "IO::AIO::READDIR_DIRS_FIRST" are
615 specified, then the likely dirs come first, resulting in a less 737 specified, then the likely dirs come first, resulting in a less
616 optimal stat order. 738 optimal stat order for stat'ing all entries, but likely a more
739 optimal order for finding subdirectories.
617 740
618 IO::AIO::READDIR_FOUND_UNKNOWN 741 IO::AIO::READDIR_FOUND_UNKNOWN
619 This flag should not be set when calling "aio_readdirx". 742 This flag should not be set when calling "aio_readdirx".
620 Instead, it is being set by "aio_readdirx", when any of the 743 Instead, it is being set by "aio_readdirx", when any of the
621 $type's found were "IO::AIO::DT_UNKNOWN". The absense of this 744 $type's found were "IO::AIO::DT_UNKNOWN". The absence of this
622 flag therefore indicates that all $type's are known, which can 745 flag therefore indicates that all $type's are known, which can
623 be used to speed up some algorithms. 746 be used to speed up some algorithms.
624 747
748 aio_slurp $pathname, $offset, $length, $data, $callback->($status)
749 Opens, reads and closes the given file. The data is put into $data,
750 which is resized as required.
751
752 If $offset is negative, then it is counted from the end of the file.
753
754 If $length is zero, then the remaining length of the file is used.
755 Also, in this case, the same limitations to modifying $data apply as
756 when IO::AIO::mmap is used, i.e. it must only be modified in-place
757 with "substr". If the size of the file is known, specifying a
758 non-zero $length results in a performance advantage.
759
760 This request is similar to the older "aio_load" request, but since
761 it is a single request, it might be more efficient to use.
762
763 Example: load /etc/passwd into $passwd.
764
765 my $passwd;
766 aio_slurp "/etc/passwd", 0, 0, $passwd, sub {
767 $_[0] >= 0
768 or die "/etc/passwd: $!\n";
769
770 printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd;
771 print $passwd;
772 };
773 IO::AIO::flush;
774
625 aio_load $path, $data, $callback->($status) 775 aio_load $pathname, $data, $callback->($status)
626 This is a composite request that tries to fully load the given file 776 This is a composite request that tries to fully load the given file
627 into memory. Status is the same as with aio_read. 777 into memory. Status is the same as with aio_read.
778
779 Using "aio_slurp" might be more efficient, as it is a single
780 request.
628 781
629 aio_copy $srcpath, $dstpath, $callback->($status) 782 aio_copy $srcpath, $dstpath, $callback->($status)
630 Try to copy the *file* (directories not supported as either source 783 Try to copy the *file* (directories not supported as either source
631 or destination) from $srcpath to $dstpath and call the callback with 784 or destination) from $srcpath to $dstpath and call the callback with
632 a status of 0 (ok) or -1 (error, see $!). 785 a status of 0 (ok) or -1 (error, see $!).
633 786
787 Existing destination files will be truncated.
788
634 This is a composite request that creates the destination file with 789 This is a composite request that creates the destination file with
635 mode 0200 and copies the contents of the source file into it using 790 mode 0200 and copies the contents of the source file into it using
636 "aio_sendfile", followed by restoring atime, mtime, access mode and 791 "aio_sendfile", followed by restoring atime, mtime, access mode and
637 uid/gid, in that order. 792 uid/gid, in that order.
638 793
… …
647 802
648 This is a composite request that tries to rename(2) the file first; 803 This is a composite request that tries to rename(2) the file first;
649 if rename fails with "EXDEV", it copies the file with "aio_copy" 804 if rename fails with "EXDEV", it copies the file with "aio_copy"
650 and, if that is successful, unlinks the $srcpath. 805 and, if that is successful, unlinks the $srcpath.
651 806
652 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs) 807 aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
653 Scans a directory (similar to "aio_readdir") but additionally tries 808 Scans a directory (similar to "aio_readdir") but additionally tries
654 to efficiently separate the entries of directory $path into two sets 809 to efficiently separate the entries of directory $path into two sets
655 of names, directories you can recurse into (directories), and ones 810 of names, directories you can recurse into (directories), and ones
656 you cannot recurse into (everything else, including symlinks to 811 you cannot recurse into (everything else, including symlinks to
657 directories). 812 directories).
658 813
659 "aio_scandir" is a composite request that creates of many sub 814 "aio_scandir" is a composite request that generates many sub
660 requests_ $maxreq specifies the maximum number of outstanding aio 815 requests. $maxreq specifies the maximum number of outstanding aio
661 requests that this function generates. If it is "<= 0", then a 816 requests that this function generates. If it is "<= 0", then a
662 suitable default will be chosen (currently 4). 817 suitable default will be chosen (currently 4).
663 818
664 On error, the callback is called without arguments, otherwise it 819 On error, the callback is called without arguments, otherwise it
665 receives two array-refs with path-relative entry names. 820 receives two array-refs with path-relative entry names.
… …
690 Then entries will be sorted into likely directories a non-initial 845 Then entries will be sorted into likely directories a non-initial
691 dot currently) and likely non-directories (see "aio_readdirx"). Then 846 dot currently) and likely non-directories (see "aio_readdirx"). Then
692 every entry plus an appended "/." will be "stat"'ed, likely 847 every entry plus an appended "/." will be "stat"'ed, likely
693 directories first, in order of their inode numbers. If that 848 directories first, in order of their inode numbers. If that
694 succeeds, it assumes that the entry is a directory or a symlink to 849 succeeds, it assumes that the entry is a directory or a symlink to
695 directory (which will be checked seperately). This is often faster 850 directory (which will be checked separately). This is often faster
696 than stat'ing the entry itself because filesystems might detect the 851 than stat'ing the entry itself because filesystems might detect the
697 type of the entry without reading the inode data (e.g. ext2fs 852 type of the entry without reading the inode data (e.g. ext2fs
698 filetype feature), even on systems that cannot return the filetype 853 filetype feature), even on systems that cannot return the filetype
699 information on readdir. 854 information on readdir.
700 855
… …
706 861
707 It will also likely work on non-POSIX filesystems with reduced 862 It will also likely work on non-POSIX filesystems with reduced
708 efficiency as those tend to return 0 or 1 as link counts, which 863 efficiency as those tend to return 0 or 1 as link counts, which
709 disables the directory counting heuristic. 864 disables the directory counting heuristic.
710 865
711 aio_rmtree $path, $callback->($status) 866 aio_rmtree $pathname, $callback->($status)
712 Delete a directory tree starting (and including) $path, return the 867 Delete a directory tree starting (and including) $path, return the
713 status of the final "rmdir" only. This is a composite request that 868 status of the final "rmdir" only. This is a composite request that
714 uses "aio_scandir" to recurse into and rmdir directories, and unlink 869 uses "aio_scandir" to recurse into and rmdir directories, and unlink
715 everything else. 870 everything else.
716 871
872 aio_fcntl $fh, $cmd, $arg, $callback->($status)
873 aio_ioctl $fh, $request, $buf, $callback->($status)
874 These work just like the "fcntl" and "ioctl" built-in functions,
875 except they execute asynchronously and pass the return value to the
876 callback.
877
878 Both calls can be used for a lot of things, some of which make more
879 sense to run asynchronously in their own thread, while some others
880 make less sense. For example, calls that block waiting for external
881 events, such as locking, will also lock down an I/O thread while it
882 is waiting, which can deadlock the whole I/O system. At the same
883 time, there might be no alternative to using a thread to wait.
884
885 So in general, you should only use these calls for things that do
886 (filesystem) I/O, not for things that wait for other events
887 (network, other processes), although if you are careful and know
888 what you are doing, you still can.
889
890 The following constants are available (missing ones are, as usual
891 0):
892
893 "F_DUPFD_CLOEXEC",
894
895 "F_OFD_GETLK", "F_OFD_SETLK", "F_OFD_GETLKW",
896
897 "FIFREEZE", "FITHAW", "FITRIM", "FICLONE", "FICLONERANGE",
898 "FIDEDUPERANGE".
899
900 "FS_IOC_GETFLAGS", "FS_IOC_SETFLAGS", "FS_IOC_GETVERSION",
901 "FS_IOC_SETVERSION", "FS_IOC_FIEMAP".
902
903 "FS_IOC_FSGETXATTR", "FS_IOC_FSSETXATTR",
904 "FS_IOC_SET_ENCRYPTION_POLICY", "FS_IOC_GET_ENCRYPTION_PWSALT",
905 "FS_IOC_GET_ENCRYPTION_POLICY", "FS_KEY_DESCRIPTOR_SIZE".
906
907 "FS_SECRM_FL", "FS_UNRM_FL", "FS_COMPR_FL", "FS_SYNC_FL",
908 "FS_IMMUTABLE_FL", "FS_APPEND_FL", "FS_NODUMP_FL", "FS_NOATIME_FL",
909 "FS_DIRTY_FL", "FS_COMPRBLK_FL", "FS_NOCOMP_FL", "FS_ENCRYPT_FL",
910 "FS_BTREE_FL", "FS_INDEX_FL", "FS_JOURNAL_DATA_FL", "FS_NOTAIL_FL",
911 "FS_DIRSYNC_FL", "FS_TOPDIR_FL", "FS_FL_USER_MODIFIABLE".
912
913 "FS_XFLAG_REALTIME", "FS_XFLAG_PREALLOC", "FS_XFLAG_IMMUTABLE",
914 "FS_XFLAG_APPEND", "FS_XFLAG_SYNC", "FS_XFLAG_NOATIME",
915 "FS_XFLAG_NODUMP", "FS_XFLAG_RTINHERIT", "FS_XFLAG_PROJINHERIT",
916 "FS_XFLAG_NOSYMLINKS", "FS_XFLAG_EXTSIZE", "FS_XFLAG_EXTSZINHERIT",
917 "FS_XFLAG_NODEFRAG", "FS_XFLAG_FILESTREAM", "FS_XFLAG_DAX",
918 "FS_XFLAG_HASATTR",
919
717 aio_sync $callback->($status) 920 aio_sync $callback->($status)
718 Asynchronously call sync and call the callback when finished. 921 Asynchronously call sync and call the callback when finished.
719 922
720 aio_fsync $fh, $callback->($status) 923 aio_fsync $fh, $callback->($status)
721 Asynchronously call fsync on the given filehandle and call the 924 Asynchronously call fsync on the given filehandle and call the
… …
725 Asynchronously call fdatasync on the given filehandle and call the 928 Asynchronously call fdatasync on the given filehandle and call the
726 callback with the fdatasync result code. 929 callback with the fdatasync result code.
727 930
728 If this call isn't available because your OS lacks it or it couldn't 931 If this call isn't available because your OS lacks it or it couldn't
729 be detected, it will be emulated by calling "fsync" instead. 932 be detected, it will be emulated by calling "fsync" instead.
933
934 aio_syncfs $fh, $callback->($status)
935 Asynchronously call the syncfs syscall to sync the filesystem
936 associated to the given filehandle and call the callback with the
937 syncfs result code. If syncfs is not available, calls sync(), but
938 returns -1 and sets errno to "ENOSYS" nevertheless.
730 939
731 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 940 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
732 Sync the data portion of the file specified by $offset and $length 941 Sync the data portion of the file specified by $offset and $length
733 to disk (but NOT the metadata), by calling the Linux-specific 942 to disk (but NOT the metadata), by calling the Linux-specific
734 sync_file_range call. If sync_file_range is not available or it 943 sync_file_range call. If sync_file_range is not available or it
… …
738 "IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE", 947 "IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE",
739 "IO::AIO::SYNC_FILE_RANGE_WRITE" and 948 "IO::AIO::SYNC_FILE_RANGE_WRITE" and
740 "IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER": refer to the sync_file_range 949 "IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER": refer to the sync_file_range
741 manpage for details. 950 manpage for details.
742 951
743 aio_pathsync $path, $callback->($status) 952 aio_pathsync $pathname, $callback->($status)
744 This request tries to open, fsync and close the given path. This is 953 This request tries to open, fsync and close the given path. This is
745 a composite request intended to sync directories after directory 954 a composite request intended to sync directories after directory
746 operations (E.g. rename). This might not work on all operating 955 operations (E.g. rename). This might not work on all operating
747 systems or have any specific effect, but usually it makes sure that 956 systems or have any specific effect, but usually it makes sure that
748 directory changes get written to disc. It works for anything that 957 directory changes get written to disc. It works for anything that
… …
751 Future versions of this function might fall back to other methods 960 Future versions of this function might fall back to other methods
752 when "fsync" on the directory fails (such as calling "sync"). 961 when "fsync" on the directory fails (such as calling "sync").
753 962
754 Passes 0 when everything went ok, and -1 on error. 963 Passes 0 when everything went ok, and -1 on error.
755 964
756 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, 965 aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC,
757 $callback->($status) 966 $callback->($status)
758 This is a rather advanced IO::AIO call, which only works on 967 This is a rather advanced IO::AIO call, which only works on
759 mmap(2)ed scalars (see the "IO::AIO::mmap" function, although it 968 mmap(2)ed scalars (see the "IO::AIO::mmap" function, although it
760 also works on data scalars managed by the Sys::Mmap or Mmap modules, 969 also works on data scalars managed by the Sys::Mmap or Mmap modules,
761 note that the scalar must only be modified in-place while an aio 970 note that the scalar must only be modified in-place while an aio
… …
763 972
764 It calls the "msync" function of your OS, if available, with the 973 It calls the "msync" function of your OS, if available, with the
765 memory area starting at $offset in the string and ending $length 974 memory area starting at $offset in the string and ending $length
766 bytes later. If $length is negative, counts from the end, and if 975 bytes later. If $length is negative, counts from the end, and if
767 $length is "undef", then it goes till the end of the string. The 976 $length is "undef", then it goes till the end of the string. The
768 flags can be a combination of "IO::AIO::MS_ASYNC", 977 flags can be either "IO::AIO::MS_ASYNC" or "IO::AIO::MS_SYNC", plus
769 "IO::AIO::MS_INVALIDATE" and "IO::AIO::MS_SYNC". 978 an optional "IO::AIO::MS_INVALIDATE".
770 979
771 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, 980 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0,
772 $callback->($status) 981 $callback->($status)
773 This is a rather advanced IO::AIO call, which works best on 982 This is a rather advanced IO::AIO call, which works best on
774 mmap(2)ed scalars. 983 mmap(2)ed scalars.
775 984
776 It touches (reads or writes) all memory pages in the specified range 985 It touches (reads or writes) all memory pages in the specified range
777 inside the scalar. All caveats and parameters are the same as for 986 inside the scalar. All caveats and parameters are the same as for
778 "aio_msync", above, except for flags, which must be either 0 (which 987 "aio_msync", above, except for flags, which must be either 0 (which
779 reads all pages and ensures they are instantiated) or 988 reads all pages and ensures they are instantiated) or
780 "IO::AIO::MT_MODIFY", which modifies the memory page s(by reading 989 "IO::AIO::MT_MODIFY", which modifies the memory pages (by reading
781 and writing an octet from it, which dirties the page). 990 and writing an octet from it, which dirties the page).
782 991
783 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status) 992 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
784 This is a rather advanced IO::AIO call, which works best on 993 This is a rather advanced IO::AIO call, which works best on
785 mmap(2)ed scalars. 994 mmap(2)ed scalars.
… …
817 1026
818 Example: asynchronously lock all current and future pages into 1027 Example: asynchronously lock all current and future pages into
819 memory. 1028 memory.
820 1029
821 aio_mlockall IO::AIO::MCL_FUTURE; 1030 aio_mlockall IO::AIO::MCL_FUTURE;
1031
1032 aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
1033 Queries the extents of the given file (by calling the Linux "FIEMAP"
1034 ioctl, see <http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for
1035 details). If the ioctl is not available on your OS, then this
1036 request will fail with "ENOSYS".
1037
1038 $start is the starting offset to query extents for, $length is the
1039 size of the range to query - if it is "undef", then the whole file
1040 will be queried.
1041
1042 $flags is a combination of flags ("IO::AIO::FIEMAP_FLAG_SYNC" or
1043 "IO::AIO::FIEMAP_FLAG_XATTR" - "IO::AIO::FIEMAP_FLAGS_COMPAT" is
1044 also exported), and is normally 0 or "IO::AIO::FIEMAP_FLAG_SYNC" to
1045 query the data portion.
1046
1047 $count is the maximum number of extent records to return. If it is
1048 "undef", then IO::AIO queries all extents of the range. As a very
1049 special case, if it is 0, then the callback receives the number of
1050 extents instead of the extents themselves (which is unreliable, see
1051 below).
1052
1053 If an error occurs, the callback receives no arguments. The special
1054 "errno" value "IO::AIO::EBADR" is available to test for flag errors.
1055
1056 Otherwise, the callback receives an array reference with extent
1057 structures. Each extent structure is an array reference itself, with
1058 the following members:
1059
1060 [$logical, $physical, $length, $flags]
1061
1062 Flags is any combination of the following flag values (typically
1063 either 0 or "IO::AIO::FIEMAP_EXTENT_LAST" (1)):
1064
1065 "IO::AIO::FIEMAP_EXTENT_LAST", "IO::AIO::FIEMAP_EXTENT_UNKNOWN",
1066 "IO::AIO::FIEMAP_EXTENT_DELALLOC", "IO::AIO::FIEMAP_EXTENT_ENCODED",
1067 "IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED",
1068 "IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED",
1069 "IO::AIO::FIEMAP_EXTENT_DATA_INLINE",
1070 "IO::AIO::FIEMAP_EXTENT_DATA_TAIL",
1071 "IO::AIO::FIEMAP_EXTENT_UNWRITTEN", "IO::AIO::FIEMAP_EXTENT_MERGED"
1072 or "IO::AIO::FIEMAP_EXTENT_SHARED".
1073
1074 At the time of this writing (Linux 3.2), this request is unreliable
1075 unless $count is "undef", as the kernel has all sorts of bugs
1076 preventing it to return all extents of a range for files with a
1077 large number of extents. The code (only) works around all these
1078 issues if $count is "undef".
822 1079
823 aio_group $callback->(...) 1080 aio_group $callback->(...)
824 This is a very special aio request: Instead of doing something, it 1081 This is a very special aio request: Instead of doing something, it
825 is a container for other aio requests, which is useful if you want 1082 is a container for other aio requests, which is useful if you want
826 to bundle many requests into a single, composite, request with a 1083 to bundle many requests into a single, composite, request with a
… …
860 While it is theoretically handy to have simple I/O scheduling 1117 While it is theoretically handy to have simple I/O scheduling
861 requests like sleep and file handle readable/writable, the overhead 1118 requests like sleep and file handle readable/writable, the overhead
862 this creates is immense (it blocks a thread for a long time) so do 1119 this creates is immense (it blocks a thread for a long time) so do
863 not use this function except to put your application under 1120 not use this function except to put your application under
864 artificial I/O pressure. 1121 artificial I/O pressure.
1122
1123 IO::AIO::WD - multiple working directories
1124 Your process only has one current working directory, which is used by
1125 all threads. This makes it hard to use relative paths (some other
1126 component could call "chdir" at any time, and it is hard to control when
1127 the path will be used by IO::AIO).
1128
1129 One solution for this is to always use absolute paths. This usually
1130 works, but can be quite slow (the kernel has to walk the whole path on
1131 every access), and can also be a hassle to implement.
1132
1133 Newer POSIX systems have a number of functions (openat, fdopendir,
1134 futimensat and so on) that make it possible to specify working
1135 directories per operation.
1136
1137 For portability, and because the clowns who "designed", or shall I
1138 write, perpetrated this new interface were obviously half-drunk, this
1139 abstraction cannot be perfect, though.
1140
1141 IO::AIO allows you to convert directory paths into a so-called
1142 IO::AIO::WD object. This object stores the canonicalised, absolute
1143 version of the path, and on systems that allow it, also a directory file
1144 descriptor.
1145
1146 Everywhere where a pathname is accepted by IO::AIO (e.g. in "aio_stat"
1147 or "aio_unlink"), one can specify an array reference with an IO::AIO::WD
1148 object and a pathname instead (or the IO::AIO::WD object alone, which
1149 gets interpreted as "[$wd, "."]"). If the pathname is absolute, the
1150 IO::AIO::WD object is ignored, otherwise the pathname is resolved
1151 relative to that IO::AIO::WD object.
1152
1153 For example, to get a wd object for /etc and then stat passwd inside,
1154 you would write:
1155
1156 aio_wd "/etc", sub {
1157 my $etcdir = shift;
1158
1159 # although $etcdir can be undef on error, there is generally no reason
1160 # to check for errors here, as aio_stat will fail with ENOENT
1161 # when $etcdir is undef.
1162
1163 aio_stat [$etcdir, "passwd"], sub {
1164 # yay
1165 };
1166 };
1167
1168 The fact that "aio_wd" is a request and not a normal function shows that
1169 creating an IO::AIO::WD object is itself a potentially blocking
1170 operation, which is why it is done asynchronously.
1171
1172 To stat the directory obtained with "aio_wd" above, one could write
1173 either of the following three request calls:
1174
1175 aio_lstat "/etc" , sub { ... # pathname as normal string
1176 aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
1177 aio_lstat $wd , sub { ... # shorthand for the previous
1178
1179 As with normal pathnames, IO::AIO keeps a copy of the working directory
1180 object and the pathname string, so you could write the following without
1181 causing any issues due to $path getting reused:
1182
1183 my $path = [$wd, undef];
1184
1185 for my $name (qw(abc def ghi)) {
1186 $path->[1] = $name;
1187 aio_stat $path, sub {
1188 # ...
1189 };
1190 }
1191
1192 There are some caveats: when directories get renamed (or deleted), the
1193 pathname string doesn't change, so will point to the new directory (or
1194 nowhere at all), while the directory fd, if available on the system,
1195 will still point to the original directory. Most functions accepting a
1196 pathname will use the directory fd on newer systems, and the string on
1197 older systems. Some functions (such as "aio_realpath") will always rely
1198 on the string form of the pathname.
1199
1200 So this functionality is mainly useful to get some protection against
1201 "chdir", to easily get an absolute path out of a relative path for
1202 future reference, and to speed up doing many operations in the same
1203 directory (e.g. when stat'ing all files in a directory).
1204
1205 The following functions implement this working directory abstraction:
1206
1207 aio_wd $pathname, $callback->($wd)
1208 Asynchonously canonicalise the given pathname and convert it to an
1209 IO::AIO::WD object representing it. If possible and supported on the
1210 system, also open a directory fd to speed up pathname resolution
1211 relative to this working directory.
1212
1213 If something goes wrong, then "undef" is passwd to the callback
1214 instead of a working directory object and $! is set appropriately.
1215 Since passing "undef" as working directory component of a pathname
1216 fails the request with "ENOENT", there is often no need for error
1217 checking in the "aio_wd" callback, as future requests using the
1218 value will fail in the expected way.
1219
1220 IO::AIO::CWD
1221 This is a compiletime constant (object) that represents the process
1222 current working directory.
1223
1224 Specifying this object as working directory object for a pathname is
1225 as if the pathname would be specified directly, without a directory
1226 object. For example, these calls are functionally identical:
1227
1228 aio_stat "somefile", sub { ... };
1229 aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
1230
1231 To recover the path associated with an IO::AIO::WD object, you can use
1232 "aio_realpath":
1233
1234 aio_realpath $wd, sub {
1235 warn "path is $_[0]\n";
1236 };
1237
1238 Currently, "aio_statvfs" always, and "aio_rename" and "aio_rmdir"
1239 sometimes, fall back to using an absolue path.
865 1240
866 IO::AIO::REQ CLASS 1241 IO::AIO::REQ CLASS
867 All non-aggregate "aio_*" functions return an object of this class when 1242 All non-aggregate "aio_*" functions return an object of this class when
868 called in non-void context. 1243 called in non-void context.
869 1244
… …
969 Sets a feeder/generator on this group: every group can have an 1344 Sets a feeder/generator on this group: every group can have an
970 attached generator that generates requests if idle. The idea behind 1345 attached generator that generates requests if idle. The idea behind
971 this is that, although you could just queue as many requests as you 1346 this is that, although you could just queue as many requests as you
972 want in a group, this might starve other requests for a potentially 1347 want in a group, this might starve other requests for a potentially
973 long time. For example, "aio_scandir" might generate hundreds of 1348 long time. For example, "aio_scandir" might generate hundreds of
974 thousands "aio_stat" requests, delaying any later requests for a 1349 thousands of "aio_stat" requests, delaying any later requests for a
975 long time. 1350 long time.
976 1351
977 To avoid this, and allow incremental generation of requests, you can 1352 To avoid this, and allow incremental generation of requests, you can
978 instead a group and set a feeder on it that generates those 1353 instead a group and set a feeder on it that generates those
979 requests. The feed callback will be called whenever there are few 1354 requests. The feed callback will be called whenever there are few
… …
1021 results. 1396 results.
1022 1397
1023 See "poll_cb" for an example. 1398 See "poll_cb" for an example.
1024 1399
1025 IO::AIO::poll_cb 1400 IO::AIO::poll_cb
1026 Process some outstanding events on the result pipe. You have to call 1401 Process some requests that have reached the result phase (i.e. they
1027 this regularly. Returns 0 if all events could be processed, or -1 if 1402 have been executed but the results are not yet reported). You have
1028 it returned earlier for whatever reason. Returns immediately when no 1403 to call this "regularly" to finish outstanding requests.
1029 events are outstanding. The amount of events processed depends on
1030 the settings of "IO::AIO::max_poll_req" and
1031 "IO::AIO::max_poll_time".
1032 1404
1405 Returns 0 if all events could be processed (or there were no events
1406 to process), or -1 if it returned earlier for whatever reason.
1407 Returns immediately when no events are outstanding. The amount of
1408 events processed depends on the settings of "IO::AIO::max_poll_req",
1409 "IO::AIO::max_poll_time" and "IO::AIO::max_outstanding".
1410
1033 If not all requests were processed for whatever reason, the 1411 If not all requests were processed for whatever reason, the poll
1034 filehandle will still be ready when "poll_cb" returns, so normally 1412 file descriptor will still be ready when "poll_cb" returns, so
1035 you don't have to do anything special to have it called later. 1413 normally you don't have to do anything special to have it called
1414 later.
1415
1416 Apart from calling "IO::AIO::poll_cb" when the event filehandle
1417 becomes ready, it can be beneficial to call this function from loops
1418 which submit a lot of requests, to make sure the results get
1419 processed when they become available and not just when the loop is
1420 finished and the event loop takes over again. This function returns
1421 very fast when there are no outstanding requests.
1036 1422
1037 Example: Install an Event watcher that automatically calls 1423 Example: Install an Event watcher that automatically calls
1038 IO::AIO::poll_cb with high priority (more examples can be found in 1424 IO::AIO::poll_cb with high priority (more examples can be found in
1039 the SYNOPSIS section, at the top of this document): 1425 the SYNOPSIS section, at the top of this document):
1040 1426
1041 Event->io (fd => IO::AIO::poll_fileno, 1427 Event->io (fd => IO::AIO::poll_fileno,
1042 poll => 'r', async => 1, 1428 poll => 'r', async => 1,
1043 cb => \&IO::AIO::poll_cb); 1429 cb => \&IO::AIO::poll_cb);
1044 1430
1045 IO::AIO::poll_wait 1431 IO::AIO::poll_wait
1046 If there are any outstanding requests and none of them in the result 1432 Wait until either at least one request is in the result phase or no
1047 phase, wait till the result filehandle becomes ready for reading 1433 requests are outstanding anymore.
1048 (simply does a "select" on the filehandle. This is useful if you 1434
1049 want to synchronously wait for some requests to finish). 1435 This is useful if you want to synchronously wait for some requests
1436 to become ready, without actually handling them.
1050 1437
1051 See "nreqs" for an example. 1438 See "nreqs" for an example.
1052 1439
1053 IO::AIO::poll 1440 IO::AIO::poll
1054 Waits until some requests have been handled. 1441 Waits until some requests have been handled.
… …
1153 IO::AIO::idle_timeout $seconds 1540 IO::AIO::idle_timeout $seconds
1154 Sets the minimum idle timeout (default 10) after which worker 1541 Sets the minimum idle timeout (default 10) after which worker
1155 threads are allowed to exit. SEe "IO::AIO::max_idle". 1542 threads are allowed to exit. SEe "IO::AIO::max_idle".
1156 1543
1157 IO::AIO::max_outstanding $maxreqs 1544 IO::AIO::max_outstanding $maxreqs
1545 Sets the maximum number of outstanding requests to $nreqs. If you do
1546 queue up more than this number of requests, the next call to
1547 "IO::AIO::poll_cb" (and other functions calling "poll_cb", such as
1548 "IO::AIO::flush" or "IO::AIO::poll") will block until the limit is
1549 no longer exceeded.
1550
1551 In other words, this setting does not enforce a queue limit, but can
1552 be used to make poll functions block if the limit is exceeded.
1553
1158 This is a very bad function to use in interactive programs because 1554 This is a very bad function to use in interactive programs because
1159 it blocks, and a bad way to reduce concurrency because it is 1555 it blocks, and a bad way to reduce concurrency because it is
1160 inexact: Better use an "aio_group" together with a feed callback. 1556 inexact: Better use an "aio_group" together with a feed callback.
1161 1557
1162 Sets the maximum number of outstanding requests to $nreqs. If you do 1558 Its main use is in scripts without an event loop - when you want to
1163 queue up more than this number of requests, the next call to the 1559 stat a lot of files, you can write something like this:
1164 "poll_cb" (and "poll_some" and other functions calling "poll_cb")
1165 function will block until the limit is no longer exceeded.
1166 1560
1167 The default value is very large, so there is no practical limit on 1561 IO::AIO::max_outstanding 32;
1562
1563 for my $path (...) {
1564 aio_stat $path , ...;
1565 IO::AIO::poll_cb;
1566 }
1567
1568 IO::AIO::flush;
1569
1570 The call to "poll_cb" inside the loop will normally return
1571 instantly, but as soon as more thna 32 reqeusts are in-flight, it
1572 will block until some requests have been handled. This keeps the
1573 loop from pushing a large number of "aio_stat" requests onto the
1574 queue.
1575
1576 The default value for "max_outstanding" is very large, so there is
1168 the number of outstanding requests. 1577 no practical limit on the number of outstanding requests.
1169
1170 You can still queue as many requests as you want. Therefore,
1171 "max_outstanding" is mainly useful in simple scripts (with low
1172 values) or as a stop gap to shield against fatal memory overflow
1173 (with large values).
1174 1578
1175 STATISTICAL INFORMATION 1579 STATISTICAL INFORMATION
1176 IO::AIO::nreqs 1580 IO::AIO::nreqs
1177 Returns the number of requests currently in the ready, execute or 1581 Returns the number of requests currently in the ready, execute or
1178 pending states (i.e. for which their callback has not been invoked 1582 pending states (i.e. for which their callback has not been invoked
… …
1189 1593
1190 IO::AIO::npending 1594 IO::AIO::npending
1191 Returns the number of requests currently in the pending state 1595 Returns the number of requests currently in the pending state
1192 (executed, but not yet processed by poll_cb). 1596 (executed, but not yet processed by poll_cb).
1193 1597
1598 SUBSECOND STAT TIME ACCESS
1599 Both "aio_stat"/"aio_lstat" and perl's "stat"/"lstat" functions can
1600 generally find access/modification and change times with subsecond time
1601 accuracy of the system supports it, but perl's built-in functions only
1602 return the integer part.
1603
1604 The following functions return the timestamps of the most recent stat
1605 with subsecond precision on most systems and work both after
1606 "aio_stat"/"aio_lstat" and perl's "stat"/"lstat" calls. Their return
1607 value is only meaningful after a successful "stat"/"lstat" call, or
1608 during/after a successful "aio_stat"/"aio_lstat" callback.
1609
1610 This is similar to the Time::HiRes "stat" functions, but can return full
1611 resolution without rounding and work with standard perl "stat",
1612 alleviating the need to call the special "Time::HiRes" functions, which
1613 do not act like their perl counterparts.
1614
1615 On operating systems or file systems where subsecond time resolution is
1616 not supported or could not be detected, a fractional part of 0 is
1617 returned, so it is always safe to call these functions.
1618
1619 $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime
1620 Return the access, modication or change time, respectively,
1621 including fractional part. Due to the limited precision of floating
1622 point, the accuracy on most platforms is only a bit better than
1623 milliseconds for times around now - see the *nsec* function family,
1624 below, for full accuracy.
1625
1626 ($atime, $mtime, $ctime, ...) = IO::AIO::st_xtime
1627 Returns access, modification and change time all in one go, and
1628 maybe more times in the future version.
1629
1630 $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec,
1631 IO::AIO::st_ctimensec
1632 Return the fractional access, modifcation or change time, in
1633 nanoseconds, as an integer in the range 0 to 999999999.
1634
1635 ($atime, $mtime, $ctime, ...) = IO::AIO::st_xtimensec
1636 Like the functions above, but returns all three times in one go (and
1637 maybe more in future versions).
1638
1639 Example: print the high resolution modification time of /etc, using
1640 "stat", and "IO::AIO::aio_stat".
1641
1642 if (stat "/etc") {
1643 printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
1644 }
1645
1646 IO::AIO::aio_stat "/etc", sub {
1647 $_[0]
1648 and return;
1649
1650 printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
1651 };
1652
1653 IO::AIO::flush;
1654
1655 Output of the awbove on my system, showing reduced and full accuracy:
1656
1657 stat(/etc) mtime: 1534043702.020808
1658 aio_stat(/etc) mtime: 1534043702.020807792
1659
1194 MISCELLANEOUS FUNCTIONS 1660 MISCELLANEOUS FUNCTIONS
1195 IO::AIO implements some functions that might be useful, but are not 1661 IO::AIO implements some functions that are useful when you want to use
1196 asynchronous. 1662 some "Advanced I/O" function not available to in Perl, without going the
1663 "Asynchronous I/O" route. Many of these have an asynchronous "aio_*"
1664 counterpart.
1665
1666 $numfd = IO::AIO::get_fdlimit
1667 This function is *EXPERIMENTAL* and subject to change.
1668
1669 Tries to find the current file descriptor limit and returns it, or
1670 "undef" and sets $! in case of an error. The limit is one larger
1671 than the highest valid file descriptor number.
1672
1673 IO::AIO::min_fdlimit [$numfd]
1674 This function is *EXPERIMENTAL* and subject to change.
1675
1676 Try to increase the current file descriptor limit(s) to at least
1677 $numfd by changing the soft or hard file descriptor resource limit.
1678 If $numfd is missing, it will try to set a very high limit, although
1679 this is not recommended when you know the actual minimum that you
1680 require.
1681
1682 If the limit cannot be raised enough, the function makes a
1683 best-effort attempt to increase the limit as much as possible, using
1684 various tricks, while still failing. You can query the resulting
1685 limit using "IO::AIO::get_fdlimit".
1686
1687 If an error occurs, returns "undef" and sets $!, otherwise returns
1688 true.
1197 1689
1198 IO::AIO::sendfile $ofh, $ifh, $offset, $count 1690 IO::AIO::sendfile $ofh, $ifh, $offset, $count
1199 Calls the "eio_sendfile_sync" function, which is like 1691 Calls the "eio_sendfile_sync" function, which is like
1200 "aio_sendfile", but is blocking (this makes most sense if you know 1692 "aio_sendfile", but is blocking (this makes most sense if you know
1201 the input data is likely cached already and the output filehandle is 1693 the input data is likely cached already and the output filehandle is
… …
1203 1695
1204 Returns the number of bytes copied, or -1 on error. 1696 Returns the number of bytes copied, or -1 on error.
1205 1697
1206 IO::AIO::fadvise $fh, $offset, $len, $advice 1698 IO::AIO::fadvise $fh, $offset, $len, $advice
1207 Simply calls the "posix_fadvise" function (see its manpage for 1699 Simply calls the "posix_fadvise" function (see its manpage for
1208 details). The following advice constants are avaiable: 1700 details). The following advice constants are available:
1209 "IO::AIO::FADV_NORMAL", "IO::AIO::FADV_SEQUENTIAL", 1701 "IO::AIO::FADV_NORMAL", "IO::AIO::FADV_SEQUENTIAL",
1210 "IO::AIO::FADV_RANDOM", "IO::AIO::FADV_NOREUSE", 1702 "IO::AIO::FADV_RANDOM", "IO::AIO::FADV_NOREUSE",
1211 "IO::AIO::FADV_WILLNEED", "IO::AIO::FADV_DONTNEED". 1703 "IO::AIO::FADV_WILLNEED", "IO::AIO::FADV_DONTNEED".
1212 1704
1213 On systems that do not implement "posix_fadvise", this function 1705 On systems that do not implement "posix_fadvise", this function
1214 returns ENOSYS, otherwise the return value of "posix_fadvise". 1706 returns ENOSYS, otherwise the return value of "posix_fadvise".
1215 1707
1216 IO::AIO::madvise $scalar, $offset, $len, $advice 1708 IO::AIO::madvise $scalar, $offset, $len, $advice
1217 Simply calls the "posix_madvise" function (see its manpage for 1709 Simply calls the "posix_madvise" function (see its manpage for
1218 details). The following advice constants are avaiable: 1710 details). The following advice constants are available:
1219 "IO::AIO::MADV_NORMAL", "IO::AIO::MADV_SEQUENTIAL", 1711 "IO::AIO::MADV_NORMAL", "IO::AIO::MADV_SEQUENTIAL",
1220 "IO::AIO::MADV_RANDOM", "IO::AIO::MADV_WILLNEED", 1712 "IO::AIO::MADV_RANDOM", "IO::AIO::MADV_WILLNEED",
1221 "IO::AIO::MADV_DONTNEED". 1713 "IO::AIO::MADV_DONTNEED".
1222 1714
1715 If $offset is negative, counts from the end. If $length is negative,
1716 the remaining length of the $scalar is used. If possible, $length
1717 will be reduced to fit into the $scalar.
1718
1223 On systems that do not implement "posix_madvise", this function 1719 On systems that do not implement "posix_madvise", this function
1224 returns ENOSYS, otherwise the return value of "posix_madvise". 1720 returns ENOSYS, otherwise the return value of "posix_madvise".
1225 1721
1226 IO::AIO::mprotect $scalar, $offset, $len, $protect 1722 IO::AIO::mprotect $scalar, $offset, $len, $protect
1227 Simply calls the "mprotect" function on the preferably AIO::mmap'ed 1723 Simply calls the "mprotect" function on the preferably AIO::mmap'ed
1228 $scalar (see its manpage for details). The following protect 1724 $scalar (see its manpage for details). The following protect
1229 constants are avaiable: "IO::AIO::PROT_NONE", "IO::AIO::PROT_READ", 1725 constants are available: "IO::AIO::PROT_NONE", "IO::AIO::PROT_READ",
1230 "IO::AIO::PROT_WRITE", "IO::AIO::PROT_EXEC". 1726 "IO::AIO::PROT_WRITE", "IO::AIO::PROT_EXEC".
1727
1728 If $offset is negative, counts from the end. If $length is negative,
1729 the remaining length of the $scalar is used. If possible, $length
1730 will be reduced to fit into the $scalar.
1231 1731
1232 On systems that do not implement "mprotect", this function returns 1732 On systems that do not implement "mprotect", this function returns
1233 ENOSYS, otherwise the return value of "mprotect". 1733 ENOSYS, otherwise the return value of "mprotect".
1234 1734
1235 IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 1735 IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1236 Memory-maps a file (or anonymous memory range) and attaches it to 1736 Memory-maps a file (or anonymous memory range) and attaches it to
1237 the given $scalar, which will act like a string scalar. 1737 the given $scalar, which will act like a string scalar. Returns true
1738 on success, and false otherwise.
1238 1739
1740 The scalar must exist, but its contents do not matter - this means
1741 you cannot use a nonexistant array or hash element. When in doubt,
1742 "undef" the scalar first.
1743
1239 The only operations allowed on the scalar are "substr"/"vec" that 1744 The only operations allowed on the mmapped scalar are
1240 don't change the string length, and most read-only operations such 1745 "substr"/"vec", which don't change the string length, and most
1241 as copying it or searching it with regexes and so on. 1746 read-only operations such as copying it or searching it with regexes
1747 and so on.
1242 1748
1243 Anything else is unsafe and will, at best, result in memory leaks. 1749 Anything else is unsafe and will, at best, result in memory leaks.
1244 1750
1245 The memory map associated with the $scalar is automatically removed 1751 The memory map associated with the $scalar is automatically removed
1246 when the $scalar is destroyed, or when the "IO::AIO::mmap" or 1752 when the $scalar is undef'd or destroyed, or when the
1247 "IO::AIO::munmap" functions are called. 1753 "IO::AIO::mmap" or "IO::AIO::munmap" functions are called on it.
1248 1754
1249 This calls the "mmap"(2) function internally. See your system's 1755 This calls the "mmap"(2) function internally. See your system's
1250 manual page for details on the $length, $prot and $flags parameters. 1756 manual page for details on the $length, $prot and $flags parameters.
1251 1757
1252 The $length must be larger than zero and smaller than the actual 1758 The $length must be larger than zero and smaller than the actual
… …
1256 "IO::AIO::PROT_EXEC", "IO::AIO::PROT_READ" and/or 1762 "IO::AIO::PROT_EXEC", "IO::AIO::PROT_READ" and/or
1257 "IO::AIO::PROT_WRITE", 1763 "IO::AIO::PROT_WRITE",
1258 1764
1259 $flags can be a combination of "IO::AIO::MAP_SHARED" or 1765 $flags can be a combination of "IO::AIO::MAP_SHARED" or
1260 "IO::AIO::MAP_PRIVATE", or a number of system-specific flags (when 1766 "IO::AIO::MAP_PRIVATE", or a number of system-specific flags (when
1261 not available, the are defined as 0): "IO::AIO::MAP_ANONYMOUS" 1767 not available, the are 0): "IO::AIO::MAP_ANONYMOUS" (which is set to
1262 (which is set to "MAP_ANON" if your system only provides this 1768 "MAP_ANON" if your system only provides this constant),
1769 "IO::AIO::MAP_LOCKED", "IO::AIO::MAP_NORESERVE",
1263 constant), "IO::AIO::MAP_HUGETLB", "IO::AIO::MAP_LOCKED", 1770 "IO::AIO::MAP_POPULATE", "IO::AIO::MAP_NONBLOCK",
1771 "IO::AIO::MAP_FIXED", "IO::AIO::MAP_GROWSDOWN",
1264 "IO::AIO::MAP_NORESERVE", "IO::AIO::MAP_POPULATE" or 1772 "IO::AIO::MAP_32BIT", "IO::AIO::MAP_HUGETLB" or
1265 "IO::AIO::MAP_NONBLOCK" 1773 "IO::AIO::MAP_STACK".
1266 1774
1267 If $fh is "undef", then a file descriptor of -1 is passed. 1775 If $fh is "undef", then a file descriptor of -1 is passed.
1268 1776
1269 $offset is the offset from the start of the file - it generally must 1777 $offset is the offset from the start of the file - it generally must
1270 be a multiple of "IO::AIO::PAGESIZE" and defaults to 0. 1778 be a multiple of "IO::AIO::PAGESIZE" and defaults to 0.
… …
1282 1790
1283 my $fast_md5 = md5 $data; 1791 my $fast_md5 = md5 $data;
1284 1792
1285 IO::AIO::munmap $scalar 1793 IO::AIO::munmap $scalar
1286 Removes a previous mmap and undefines the $scalar. 1794 Removes a previous mmap and undefines the $scalar.
1795
1796 IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[,
1797 $new_address = 0]
1798 Calls the Linux-specific mremap(2) system call. The $scalar must
1799 have been mapped by "IO::AIO::mmap", and $flags must currently
1800 either be 0 or "IO::AIO::MREMAP_MAYMOVE".
1801
1802 Returns true if successful, and false otherwise. If the underlying
1803 mmapped region has changed address, then the true value has the
1804 numerical value 1, otherwise it has the numerical value 0:
1805
1806 my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
1807 or die "mremap: $!";
1808
1809 if ($success*1) {
1810 warn "scalar has chanegd address in memory\n";
1811 }
1812
1813 "IO::AIO::MREMAP_FIXED" and the $new_address argument are currently
1814 implemented, but not supported and might go away in a future
1815 version.
1816
1817 On systems where this call is not supported or is not emulated, this
1818 call returns falls and sets $! to "ENOSYS".
1287 1819
1288 IO::AIO::munlock $scalar, $offset = 0, $length = undef 1820 IO::AIO::munlock $scalar, $offset = 0, $length = undef
1289 Calls the "munlock" function, undoing the effects of a previous 1821 Calls the "munlock" function, undoing the effects of a previous
1290 "aio_mlock" call (see its description for details). 1822 "aio_mlock" call (see its description for details).
1291 1823
1292 IO::AIO::munlockall 1824 IO::AIO::munlockall
1293 Calls the "munlockall" function. 1825 Calls the "munlockall" function.
1294 1826
1295 On systems that do not implement "munlockall", this function returns 1827 On systems that do not implement "munlockall", this function returns
1296 ENOSYS, otherwise the return value of "munlockall". 1828 ENOSYS, otherwise the return value of "munlockall".
1829
1830 IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
1831 Calls the GNU/Linux splice(2) syscall, if available. If $r_off or
1832 $w_off are "undef", then "NULL" is passed for these, otherwise they
1833 should be the file offset.
1834
1835 $r_fh and $w_fh should not refer to the same file, as splice might
1836 silently corrupt the data in this case.
1837
1838 The following symbol flag values are available:
1839 "IO::AIO::SPLICE_F_MOVE", "IO::AIO::SPLICE_F_NONBLOCK",
1840 "IO::AIO::SPLICE_F_MORE" and "IO::AIO::SPLICE_F_GIFT".
1841
1842 See the splice(2) manpage for details.
1843
1844 IO::AIO::tee $r_fh, $w_fh, $length, $flags
1845 Calls the GNU/Linux tee(2) syscall, see its manpage and the
1846 description for "IO::AIO::splice" above for details.
1847
1848 $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
1849 Attempts to query or change the pipe buffer size. Obviously works
1850 only on pipes, and currently works only on GNU/Linux systems, and
1851 fails with -1/"ENOSYS" everywhere else. If anybody knows how to
1852 influence pipe buffer size on other systems, drop me a note.
1853
1854 ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
1855 This is a direct interface to the Linux pipe2(2) system call. If
1856 $flags is missing or 0, then this should be the same as a call to
1857 perl's built-in "pipe" function and create a new pipe, and works on
1858 systems that lack the pipe2 syscall. On win32, this case invokes
1859 "_pipe (..., 4096, O_BINARY)".
1860
1861 If $flags is non-zero, it tries to invoke the pipe2 system call with
1862 the given flags (Linux 2.6.27, glibc 2.9).
1863
1864 On success, the read and write file handles are returned.
1865
1866 On error, nothing will be returned. If the pipe2 syscall is missing
1867 and $flags is non-zero, fails with "ENOSYS".
1868
1869 Please refer to pipe2(2) for more info on the $flags, but at the
1870 time of this writing, "IO::AIO::O_CLOEXEC", "IO::AIO::O_NONBLOCK"
1871 and "IO::AIO::O_DIRECT" (Linux 3.4, for packet-based pipes) were
1872 supported.
1873
1874 Example: create a pipe race-free w.r.t. threads and fork:
1875
1876 my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
1877 or die "pipe2: $!\n";
1878
1879 $fh = IO::AIO::eventfd [$initval, [$flags]]
1880 This is a direct interface to the Linux eventfd(2) system call. The
1881 (unhelpful) defaults for $initval and $flags are 0 for both.
1882
1883 On success, the new eventfd filehandle is returned, otherwise
1884 returns "undef". If the eventfd syscall is missing, fails with
1885 "ENOSYS".
1886
1887 Please refer to eventfd(2) for more info on this call.
1888
1889 The following symbol flag values are available:
1890 "IO::AIO::EFD_CLOEXEC", "IO::AIO::EFD_NONBLOCK" and
1891 "IO::AIO::EFD_SEMAPHORE" (Linux 2.6.30).
1892
1893 Example: create a new eventfd filehandle:
1894
1895 $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC
1896 or die "eventfd: $!\n";
1897
1898 $fh = IO::AIO::timerfd_create $clockid[, $flags]
1899 This is a direct interface to the Linux timerfd_create(2) system
1900 call. The (unhelpful) default for $flags is 0.
1901
1902 On success, the new timerfd filehandle is returned, otherwise
1903 returns "undef". If the eventfd syscall is missing, fails with
1904 "ENOSYS".
1905
1906 Please refer to timerfd_create(2) for more info on this call.
1907
1908 The following $clockid values are available:
1909 "IO::AIO::CLOCK_REALTIME", "IO::AIO::CLOCK_MONOTONIC"
1910 "IO::AIO::CLOCK_CLOCK_BOOTTIME" (Linux 3.15)
1911 "IO::AIO::CLOCK_CLOCK_REALTIME_ALARM" (Linux 3.11) and
1912 "IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM" (Linux 3.11).
1913
1914 The following $flags values are available (Linux 2.6.27):
1915 "IO::AIO::TFD_NONBLOCK" and "IO::AIO::TFD_CLOEXEC".
1916
1917 Example: create a new timerfd and set it to one-second repeated
1918 alarms, then wait for two alarms:
1919
1920 my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC
1921 or die "timerfd_create: $!\n";
1922
1923 defined IO::AIO::timerfd_settime $fh, 0, 1, 1
1924 or die "timerfd_settime: $!\n";
1925
1926 for (1..2) {
1927 8 == sysread $fh, my $buf, 8
1928 or die "timerfd read failure\n";
1929
1930 printf "number of expirations (likely 1): %d\n",
1931 unpack "Q", $buf;
1932 }
1933
1934 ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags,
1935 $new_interval, $nbw_value
1936 This is a direct interface to the Linux timerfd_settime(2) system
1937 call. Please refer to its manpage for more info on this call.
1938
1939 The new itimerspec is specified using two (possibly fractional)
1940 second values, $new_interval and $new_value).
1941
1942 On success, the current interval and value are returned (as per
1943 "timerfd_gettime"). On failure, the empty list is returned.
1944
1945 The following $flags values are available:
1946 "IO::AIO::TFD_TIMER_ABSTIME" and "IO::AIO::TFD_TIMER_CANCEL_ON_SET".
1947
1948 See "IO::AIO::timerfd_create" for a full example.
1949
1950 ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
1951 This is a direct interface to the Linux timerfd_gettime(2) system
1952 call. Please refer to its manpage for more info on this call.
1953
1954 On success, returns the current values of interval and value for the
1955 given timerfd (as potentially fractional second values). On failure,
1956 the empty list is returned.
1297 1957
1298EVENT LOOP INTEGRATION 1958EVENT LOOP INTEGRATION
1299 It is recommended to use AnyEvent::AIO to integrate IO::AIO 1959 It is recommended to use AnyEvent::AIO to integrate IO::AIO
1300 automatically into many event loops: 1960 automatically into many event loops:
1301 1961
… …
1324 # Danga::Socket integration 1984 # Danga::Socket integration
1325 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno => 1985 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
1326 \&IO::AIO::poll_cb); 1986 \&IO::AIO::poll_cb);
1327 1987
1328 FORK BEHAVIOUR 1988 FORK BEHAVIOUR
1329 This module should do "the right thing" when the process using it forks: 1989 Usage of pthreads in a program changes the semantics of fork
1990 considerably. Specifically, only async-safe functions can be called
1991 after fork. Perl doesn't know about this, so in general, you cannot call
1992 fork with defined behaviour in perl if pthreads are involved. IO::AIO
1993 uses pthreads, so this applies, but many other extensions and (for
1994 inexplicable reasons) perl itself often is linked against pthreads, so
1995 this limitation applies to quite a lot of perls.
1330 1996
1331 Before the fork, IO::AIO enters a quiescent state where no requests can 1997 This module no longer tries to fight your OS, or POSIX. That means
1332 be added in other threads and no results will be processed. After the 1998 IO::AIO only works in the process that loaded it. Forking is fully
1333 fork the parent simply leaves the quiescent state and continues 1999 supported, but using IO::AIO in the child is not.
1334 request/result processing, while the child frees the request/result
1335 queue (so that the requests started before the fork will only be handled
1336 in the parent). Threads will be started on demand until the limit set in
1337 the parent process has been reached again.
1338 2000
1339 In short: the parent will, after a short pause, continue as if fork had 2001 You might get around by not *using* IO::AIO before (or after) forking.
1340 not been called, while the child will act as if IO::AIO has not been 2002 You could also try to call the IO::AIO::reinit function in the child:
1341 used yet. 2003
2004 IO::AIO::reinit
2005 Abandons all current requests and I/O threads and simply
2006 reinitialises all data structures. This is not an operation
2007 supported by any standards, but happens to work on GNU/Linux and
2008 some newer BSD systems.
2009
2010 The only reasonable use for this function is to call it after
2011 forking, if "IO::AIO" was used in the parent. Calling it while
2012 IO::AIO is active in the process will result in undefined behaviour.
2013 Calling it at any time will also result in any undefined (by POSIX)
2014 behaviour.
2015
2016 LINUX-SPECIFIC CALLS
2017 When a call is documented as "linux-specific" then this means it
2018 originated on GNU/Linux. "IO::AIO" will usually try to autodetect the
2019 availability and compatibility of such calls regardless of the platform
2020 it is compiled on, so platforms such as FreeBSD which often implement
2021 these calls will work. When in doubt, call them and see if they fail wth
2022 "ENOSYS".
1342 2023
1343 MEMORY USAGE 2024 MEMORY USAGE
1344 Per-request usage: 2025 Per-request usage:
1345 2026
1346 Each aio request uses - depending on your architecture - around 100-200 2027 Each aio request uses - depending on your architecture - around 100-200
… …
1357 In the execution phase, some aio requests require more memory for 2038 In the execution phase, some aio requests require more memory for
1358 temporary buffers, and each thread requires a stack and other data 2039 temporary buffers, and each thread requires a stack and other data
1359 structures (usually around 16k-128k, depending on the OS). 2040 structures (usually around 16k-128k, depending on the OS).
1360 2041
1361KNOWN BUGS 2042KNOWN BUGS
1362 Known bugs will be fixed in the next release. 2043 Known bugs will be fixed in the next release :)
2044
2045KNOWN ISSUES
2046 Calls that try to "import" foreign memory areas (such as "IO::AIO::mmap"
2047 or "IO::AIO::aio_slurp") do not work with generic lvalues, such as
2048 non-created hash slots or other scalars I didn't think of. It's best to
2049 avoid such and either use scalar variables or making sure that the
2050 scalar exists (e.g. by storing "undef") and isn't "funny" (e.g. tied).
2051
2052 I am not sure anything can be done about this, so this is considered a
2053 known issue, rather than a bug.
1363 2054
1364SEE ALSO 2055SEE ALSO
1365 AnyEvent::AIO for easy integration into event loops, Coro::AIO for a 2056 AnyEvent::AIO for easy integration into event loops, Coro::AIO for a
1366 more natural syntax. 2057 more natural syntax.
1367 2058

Diff Legend

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