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

Comparing IO-AIO/README (file contents):
Revision 1.19 by root, Sun Oct 29 01:03:13 2006 UTC vs.
Revision 1.25 by root, Mon Sep 24 19:28:50 2007 UTC

… …
3 3
4SYNOPSIS 4SYNOPSIS
5 use IO::AIO; 5 use IO::AIO;
6 6
7 aio_open "/etc/passwd", O_RDONLY, 0, sub { 7 aio_open "/etc/passwd", O_RDONLY, 0, sub {
8 my ($fh) = @_; 8 my $fh = shift
9 or die "/etc/passwd: $!";
9 ... 10 ...
10 }; 11 };
11 12
12 aio_unlink "/tmp/file", sub { }; 13 aio_unlink "/tmp/file", sub { };
13 14
… …
58 but can also be used to easily do operations in parallel that are 59 but can also be used to easily do operations in parallel that are
59 normally done sequentially, e.g. stat'ing many files, which is much 60 normally done sequentially, e.g. stat'ing many files, which is much
60 faster on a RAID volume or over NFS when you do a number of stat 61 faster on a RAID volume or over NFS when you do a number of stat
61 operations concurrently. 62 operations concurrently.
62 63
63 While this works on all types of file descriptors (for example sockets), 64 While most of this works on all types of file descriptors (for example
64 using these functions on file descriptors that support nonblocking 65 sockets), using these functions on file descriptors that support
65 operation (again, sockets, pipes etc.) is very inefficient. Use an event 66 nonblocking operation (again, sockets, pipes etc.) is very inefficient.
66 loop for that (such as the Event module): IO::AIO will naturally fit 67 Use an event loop for that (such as the Event module): IO::AIO will
67 into such an event loop itself. 68 naturally fit into such an event loop itself.
68 69
69 In this version, a number of threads are started that execute your 70 In this version, a number of threads are started that execute your
70 requests and signal their completion. You don't need thread support in 71 requests and signal their completion. You don't need thread support in
71 perl, and the threads created by this module will not be visible to 72 perl, and the threads created by this module will not be visible to
72 perl. In the future, this module might make use of the native aio 73 perl. In the future, this module might make use of the native aio
… …
74 not well-supported or restricted (GNU/Linux doesn't allow them on normal 75 not well-supported or restricted (GNU/Linux doesn't allow them on normal
75 files currently, for example), and they would only support aio_read and 76 files currently, for example), and they would only support aio_read and
76 aio_write, so the remaining functionality would have to be implemented 77 aio_write, so the remaining functionality would have to be implemented
77 using threads anyway. 78 using threads anyway.
78 79
79 Although the module will work with in the presence of other (Perl-) 80 Although the module will work in the presence of other (Perl-) threads,
80 threads, it is currently not reentrant in any way, so use appropriate 81 it is currently not reentrant in any way, so use appropriate locking
81 locking yourself, always call "poll_cb" from within the same thread, or 82 yourself, always call "poll_cb" from within the same thread, or never
82 never call "poll_cb" (or other "aio_" functions) recursively. 83 call "poll_cb" (or other "aio_" functions) recursively.
83 84
84 EXAMPLE 85 EXAMPLE
85 This is a simple example that uses the Event module and loads 86 This is a simple example that uses the Event module and loads
86 /etc/passwd asynchronously: 87 /etc/passwd asynchronously:
87 88
… …
94 poll => 'r', 95 poll => 'r',
95 cb => \&IO::AIO::poll_cb); 96 cb => \&IO::AIO::poll_cb);
96 97
97 # queue the request to open /etc/passwd 98 # queue the request to open /etc/passwd
98 aio_open "/etc/passwd", O_RDONLY, 0, sub { 99 aio_open "/etc/passwd", O_RDONLY, 0, sub {
99 my $fh = $_[0] 100 my $fh = shift
100 or die "error while opening: $!"; 101 or die "error while opening: $!";
101 102
102 # stat'ing filehandles is generally non-blocking 103 # stat'ing filehandles is generally non-blocking
103 my $size = -s $fh; 104 my $size = -s $fh;
104 105
… …
167 the actual aio request is severed and calling its methods will 168 the actual aio request is severed and calling its methods will
168 either do nothing or result in a runtime error). 169 either do nothing or result in a runtime error).
169 170
170FUNCTIONS 171FUNCTIONS
171 AIO REQUEST FUNCTIONS 172 AIO REQUEST FUNCTIONS
172 All the "aio_*" calls are more or less thin wrappers around the 173 All the "aio_*" calls are more or less thin wrappers around the syscall
173 syscall with the same name (sans "aio_"). The arguments are similar 174 with the same name (sans "aio_"). The arguments are similar or
174 or identical, and they all accept an additional (and optional) 175 identical, and they all accept an additional (and optional) $callback
175 $callback argument which must be a code reference. This code 176 argument which must be a code reference. This code reference will get
176 reference will get called with the syscall return code (e.g. most 177 called with the syscall return code (e.g. most syscalls return -1 on
177 syscalls return -1 on error, unlike perl, which usually delivers 178 error, unlike perl, which usually delivers "false") as it's sole
178 "false") as it's sole argument when the given syscall has been 179 argument when the given syscall has been executed asynchronously.
179 executed asynchronously.
180 180
181 All functions expecting a filehandle keep a copy of the filehandle 181 All functions expecting a filehandle keep a copy of the filehandle
182 internally until the request has finished. 182 internally until the request has finished.
183 183
184 All functions return request objects of type IO::AIO::REQ that allow 184 All functions return request objects of type IO::AIO::REQ that allow
185 further manipulation of those requests while they are in-flight. 185 further manipulation of those requests while they are in-flight.
186 186
187 The pathnames you pass to these routines *must* be absolute and 187 The pathnames you pass to these routines *must* be absolute and encoded
188 encoded as octets. The reason for the former is that at the time the 188 as octets. The reason for the former is that at the time the request is
189 request is being executed, the current working directory could have 189 being executed, the current working directory could have changed.
190 changed. Alternatively, you can make sure that you never change the 190 Alternatively, you can make sure that you never change the current
191 current working directory anywhere in the program and then use 191 working directory anywhere in the program and then use relative paths.
192 relative paths.
193 192
194 To encode pathnames as octets, either make sure you either: a) 193 To encode pathnames as octets, either make sure you either: a) always
195 always pass in filenames you got from outside (command line, readdir 194 pass in filenames you got from outside (command line, readdir etc.)
196 etc.) without tinkering, b) are ASCII or ISO 8859-1, c) use the 195 without tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module
197 Encode module and encode your pathnames to the locale (or other) 196 and encode your pathnames to the locale (or other) encoding in effect in
198 encoding in effect in the user environment, d) use 197 the user environment, d) use Glib::filename_from_unicode on unicode
199 Glib::filename_from_unicode on unicode filenames or e) use something 198 filenames or e) use something else to ensure your scalar has the correct
200 else to ensure your scalar has the correct contents. 199 contents.
201 200
202 This works, btw. independent of the internal UTF-8 bit, which 201 This works, btw. independent of the internal UTF-8 bit, which IO::AIO
203 IO::AIO handles correctly wether it is set or not. 202 handles correctly wether it is set or not.
204 203
205 $prev_pri = aioreq_pri [$pri] 204 $prev_pri = aioreq_pri [$pri]
206 Returns the priority value that would be used for the next 205 Returns the priority value that would be used for the next request
207 request and, if $pri is given, sets the priority for the next 206 and, if $pri is given, sets the priority for the next aio request.
208 aio request.
209 207
210 The default priority is 0, the minimum and maximum priorities 208 The default priority is 0, the minimum and maximum priorities are -4
211 are -4 and 4, respectively. Requests with higher priority will 209 and 4, respectively. Requests with higher priority will be serviced
212 be serviced first. 210 first.
213 211
214 The priority will be reset to 0 after each call to one of the 212 The priority will be reset to 0 after each call to one of the
215 "aio_*" functions. 213 "aio_*" functions.
216 214
217 Example: open a file with low priority, then read something from 215 Example: open a file with low priority, then read something from it
218 it with higher priority so the read request is serviced before 216 with higher priority so the read request is serviced before other
219 other low priority open requests (potentially spamming the 217 low priority open requests (potentially spamming the cache):
220 cache):
221 218
219 aioreq_pri -3;
220 aio_open ..., sub {
221 return unless $_[0];
222
222 aioreq_pri -3; 223 aioreq_pri -2;
223 aio_open ..., sub {
224 return unless $_[0];
225
226 aioreq_pri -2;
227 aio_read $_[0], ..., sub { 224 aio_read $_[0], ..., sub {
228 ...
229 };
230 };
231
232 aioreq_nice $pri_adjust
233 Similar to "aioreq_pri", but subtracts the given value from the
234 current priority, so the effect is cumulative.
235
236 aio_open $pathname, $flags, $mode, $callback->($fh)
237 Asynchronously open or create a file and call the callback with
238 a newly created filehandle for the file.
239
240 The pathname passed to "aio_open" must be absolute. See API
241 NOTES, above, for an explanation.
242
243 The $flags argument is a bitmask. See the "Fcntl" module for a
244 list. They are the same as used by "sysopen".
245
246 Likewise, $mode specifies the mode of the newly created file, if
247 it didn't exist and "O_CREAT" has been given, just like perl's
248 "sysopen", except that it is mandatory (i.e. use 0 if you don't
249 create new files, and 0666 or 0777 if you do).
250
251 Example:
252
253 aio_open "/etc/passwd", O_RDONLY, 0, sub {
254 if ($_[0]) {
255 print "open successful, fh is $_[0]\n";
256 ...
257 } else {
258 die "open failed: $!\n";
259 }
260 };
261
262 aio_close $fh, $callback->($status)
263 Asynchronously close a file and call the callback with the
264 result code. *WARNING:* although accepted, you should not pass
265 in a perl filehandle here, as perl will likely close the file
266 descriptor another time when the filehandle is destroyed.
267 Normally, you can safely call perls "close" or just let
268 filehandles go out of scope.
269
270 This is supposed to be a bug in the API, so that might change.
271 It's therefore best to avoid this function.
272
273 aio_read $fh,$offset,$length, $data,$dataoffset,
274 $callback->($retval)
275 aio_write $fh,$offset,$length, $data,$dataoffset,
276 $callback->($retval)
277 Reads or writes "length" bytes from the specified "fh" and
278 "offset" into the scalar given by "data" and offset "dataoffset"
279 and calls the callback without the actual number of bytes read
280 (or -1 on error, just like the syscall).
281
282 The $data scalar *MUST NOT* be modified in any way while the
283 request is outstanding. Modifying it can result in segfaults or
284 WW3 (if the necessary/optional hardware is installed).
285
286 Example: Read 15 bytes at offset 7 into scalar $buffer, starting
287 at offset 0 within the scalar:
288
289 aio_read $fh, 7, 15, $buffer, 0, sub {
290 $_[0] > 0 or die "read error: $!";
291 print "read $_[0] bytes: <$buffer>\n";
292 };
293
294 aio_sendfile $out_fh, $in_fh, $in_offset, $length,
295 $callback->($retval)
296 Tries to copy $length bytes from $in_fh to $out_fh. It starts
297 reading at byte offset $in_offset, and starts writing at the
298 current file offset of $out_fh. Because of that, it is not safe
299 to issue more than one "aio_sendfile" per $out_fh, as they will
300 interfere with each other.
301
302 This call tries to make use of a native "sendfile" syscall to
303 provide zero-copy operation. For this to work, $out_fh should
304 refer to a socket, and $in_fh should refer to mmap'able file.
305
306 If the native sendfile call fails or is not implemented, it will
307 be emulated, so you can call "aio_sendfile" on any type of
308 filehandle regardless of the limitations of the operating
309 system.
310
311 Please note, however, that "aio_sendfile" can read more bytes
312 from $in_fh than are written, and there is no way to find out
313 how many bytes have been read from "aio_sendfile" alone, as
314 "aio_sendfile" only provides the number of bytes written to
315 $out_fh. Only if the result value equals $length one can assume
316 that $length bytes have been read.
317
318 aio_readahead $fh,$offset,$length, $callback->($retval)
319 "aio_readahead" populates the page cache with data from a file
320 so that subsequent reads from that file will not block on disk
321 I/O. The $offset argument specifies the starting point from
322 which data is to be read and $length specifies the number of
323 bytes to be read. I/O is performed in whole pages, so that
324 offset is effectively rounded down to a page boundary and bytes
325 are read up to the next page boundary greater than or equal to
326 (off-set+length). "aio_readahead" does not read beyond the end
327 of the file. The current file offset of the file is left
328 unchanged.
329
330 If that syscall doesn't exist (likely if your OS isn't Linux) it
331 will be emulated by simply reading the data, which would have a
332 similar effect.
333
334 aio_stat $fh_or_path, $callback->($status)
335 aio_lstat $fh, $callback->($status)
336 Works like perl's "stat" or "lstat" in void context. The
337 callback will be called after the stat and the results will be
338 available using "stat _" or "-s _" etc...
339
340 The pathname passed to "aio_stat" must be absolute. See API
341 NOTES, above, for an explanation.
342
343 Currently, the stats are always 64-bit-stats, i.e. instead of
344 returning an error when stat'ing a large file, the results will
345 be silently truncated unless perl itself is compiled with large
346 file support.
347
348 Example: Print the length of /etc/passwd:
349
350 aio_stat "/etc/passwd", sub {
351 $_[0] and die "stat failed: $!";
352 print "size is ", -s _, "\n";
353 };
354
355 aio_unlink $pathname, $callback->($status)
356 Asynchronously unlink (delete) a file and call the callback with
357 the result code.
358
359 aio_mknod $path, $mode, $dev, $callback->($status)
360 [EXPERIMENTAL]
361
362 Asynchronously create a device node (or fifo). See mknod(2).
363
364 The only (POSIX-) portable way of calling this function is:
365
366 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
367
368 aio_link $srcpath, $dstpath, $callback->($status)
369 Asynchronously create a new link to the existing object at
370 $srcpath at the path $dstpath and call the callback with the
371 result code.
372
373 aio_symlink $srcpath, $dstpath, $callback->($status)
374 Asynchronously create a new symbolic link to the existing object
375 at $srcpath at the path $dstpath and call the callback with the
376 result code.
377
378 aio_rename $srcpath, $dstpath, $callback->($status)
379 Asynchronously rename the object at $srcpath to $dstpath, just
380 as rename(2) and call the callback with the result code.
381
382 aio_rmdir $pathname, $callback->($status)
383 Asynchronously rmdir (delete) a directory and call the callback
384 with the result code.
385
386 aio_readdir $pathname, $callback->($entries)
387 Unlike the POSIX call of the same name, "aio_readdir" reads an
388 entire directory (i.e. opendir + readdir + closedir). The
389 entries will not be sorted, and will NOT include the "." and
390 ".." entries.
391
392 The callback a single argument which is either "undef" or an
393 array-ref with the filenames.
394
395 aio_copy $srcpath, $dstpath, $callback->($status)
396 Try to copy the *file* (directories not supported as either
397 source or destination) from $srcpath to $dstpath and call the
398 callback with the 0 (error) or -1 ok.
399
400 This is a composite request that it creates the destination file
401 with mode 0200 and copies the contents of the source file into
402 it using "aio_sendfile", followed by restoring atime, mtime,
403 access mode and uid/gid, in that order.
404
405 If an error occurs, the partial destination file will be
406 unlinked, if possible, except when setting atime, mtime, access
407 mode and uid/gid, where errors are being ignored.
408
409 aio_move $srcpath, $dstpath, $callback->($status)
410 Try to move the *file* (directories not supported as either
411 source or destination) from $srcpath to $dstpath and call the
412 callback with the 0 (error) or -1 ok.
413
414 This is a composite request that tries to rename(2) the file
415 first. If rename files with "EXDEV", it copies the file with
416 "aio_copy" and, if that is successful, unlinking the $srcpath.
417
418 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
419 Scans a directory (similar to "aio_readdir") but additionally
420 tries to efficiently separate the entries of directory $path
421 into two sets of names, directories you can recurse into
422 (directories), and ones you cannot recurse into (everything
423 else, including symlinks to directories).
424
425 "aio_scandir" is a composite request that creates of many sub
426 requests_ $maxreq specifies the maximum number of outstanding
427 aio requests that this function generates. If it is "<= 0", then
428 a suitable default will be chosen (currently 4).
429
430 On error, the callback is called without arguments, otherwise it
431 receives two array-refs with path-relative entry names.
432
433 Example:
434
435 aio_scandir $dir, 0, sub {
436 my ($dirs, $nondirs) = @_;
437 print "real directories: @$dirs\n";
438 print "everything else: @$nondirs\n";
439 };
440
441 Implementation notes.
442
443 The "aio_readdir" cannot be avoided, but "stat()"'ing every
444 entry can.
445
446 After reading the directory, the modification time, size etc. of
447 the directory before and after the readdir is checked, and if
448 they match (and isn't the current time), the link count will be
449 used to decide how many entries are directories (if >= 2).
450 Otherwise, no knowledge of the number of subdirectories will be
451 assumed.
452
453 Then entries will be sorted into likely directories (everything
454 without a non-initial dot currently) and likely non-directories
455 (everything else). Then every entry plus an appended "/." will
456 be "stat"'ed, likely directories first. If that succeeds, it
457 assumes that the entry is a directory or a symlink to directory
458 (which will be checked seperately). This is often faster than
459 stat'ing the entry itself because filesystems might detect the
460 type of the entry without reading the inode data (e.g. ext2fs
461 filetype feature).
462
463 If the known number of directories (link count - 2) has been
464 reached, the rest of the entries is assumed to be
465 non-directories.
466
467 This only works with certainty on POSIX (= UNIX) filesystems,
468 which fortunately are the vast majority of filesystems around.
469
470 It will also likely work on non-POSIX filesystems with reduced
471 efficiency as those tend to return 0 or 1 as link counts, which
472 disables the directory counting heuristic.
473
474 aio_fsync $fh, $callback->($status)
475 Asynchronously call fsync on the given filehandle and call the
476 callback with the fsync result code.
477
478 aio_fdatasync $fh, $callback->($status)
479 Asynchronously call fdatasync on the given filehandle and call
480 the callback with the fdatasync result code.
481
482 If this call isn't available because your OS lacks it or it
483 couldn't be detected, it will be emulated by calling "fsync"
484 instead.
485
486 aio_group $callback->(...)
487 This is a very special aio request: Instead of doing something,
488 it is a container for other aio requests, which is useful if you
489 want to bundle many requests into a single, composite, request
490 with a definite callback and the ability to cancel the whole
491 request with its subrequests.
492
493 Returns an object of class IO::AIO::GRP. See its documentation
494 below for more info.
495
496 Example:
497
498 my $grp = aio_group sub {
499 print "all stats done\n";
500 };
501
502 add $grp
503 (aio_stat ...),
504 (aio_stat ...),
505 ...; 225 ...
506
507 aio_nop $callback->()
508 This is a special request - it does nothing in itself and is
509 only used for side effects, such as when you want to add a dummy
510 request to a group so that finishing the requests in the group
511 depends on executing the given code.
512
513 While this request does nothing, it still goes through the
514 execution phase and still requires a worker thread. Thus, the
515 callback will not be executed immediately but only after other
516 requests in the queue have entered their execution phase. This
517 can be used to measure request latency.
518
519 IO::AIO::aio_busy $fractional_seconds, $callback->() *NOT EXPORTED*
520 Mainly used for debugging and benchmarking, this aio request
521 puts one of the request workers to sleep for the given time.
522
523 While it is theoretically handy to have simple I/O scheduling
524 requests like sleep and file handle readable/writable, the
525 overhead this creates is immense (it blocks a thread for a long
526 time) so do not use this function except to put your application
527 under artificial I/O pressure.
528
529 IO::AIO::REQ CLASS
530 All non-aggregate "aio_*" functions return an object of this class
531 when called in non-void context.
532
533 cancel $req
534 Cancels the request, if possible. Has the effect of skipping
535 execution when entering the execute state and skipping calling
536 the callback when entering the the result state, but will leave
537 the request otherwise untouched. That means that requests that
538 currently execute will not be stopped and resources held by the
539 request will not be freed prematurely.
540
541 cb $req $callback->(...)
542 Replace (or simply set) the callback registered to the request.
543
544 IO::AIO::GRP CLASS
545 This class is a subclass of IO::AIO::REQ, so all its methods apply
546 to objects of this class, too.
547
548 A IO::AIO::GRP object is a special request that can contain multiple
549 other aio requests.
550
551 You create one by calling the "aio_group" constructing function with
552 a callback that will be called when all contained requests have
553 entered the "done" state:
554
555 my $grp = aio_group sub {
556 print "all requests are done\n";
557 };
558
559 You add requests by calling the "add" method with one or more
560 "IO::AIO::REQ" objects:
561
562 $grp->add (aio_unlink "...");
563
564 add $grp aio_stat "...", sub {
565 $_[0] or return $grp->result ("error");
566
567 # add another request dynamically, if first succeeded
568 add $grp aio_open "...", sub {
569 $grp->result ("ok");
570 }; 226 };
571 }; 227 };
572 228
229 aioreq_nice $pri_adjust
230 Similar to "aioreq_pri", but subtracts the given value from the
231 current priority, so the effect is cumulative.
232
233 aio_open $pathname, $flags, $mode, $callback->($fh)
234 Asynchronously open or create a file and call the callback with a
235 newly created filehandle for the file.
236
237 The pathname passed to "aio_open" must be absolute. See API NOTES,
238 above, for an explanation.
239
240 The $flags argument is a bitmask. See the "Fcntl" module for a list.
241 They are the same as used by "sysopen".
242
243 Likewise, $mode specifies the mode of the newly created file, if it
244 didn't exist and "O_CREAT" has been given, just like perl's
245 "sysopen", except that it is mandatory (i.e. use 0 if you don't
246 create new files, and 0666 or 0777 if you do). Note that the $mode
247 will be modified by the umask in effect then the request is being
248 executed, so better never change the umask.
249
250 Example:
251
252 aio_open "/etc/passwd", O_RDONLY, 0, sub {
253 if ($_[0]) {
254 print "open successful, fh is $_[0]\n";
255 ...
256 } else {
257 die "open failed: $!\n";
258 }
259 };
260
261 aio_close $fh, $callback->($status)
262 Asynchronously close a file and call the callback with the result
263 code. *WARNING:* although accepted, you should not pass in a perl
264 filehandle here, as perl will likely close the file descriptor
265 another time when the filehandle is destroyed. Normally, you can
266 safely call perls "close" or just let filehandles go out of scope.
267
268 This is supposed to be a bug in the API, so that might change. It's
269 therefore best to avoid this function.
270
271 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
272 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
273 Reads or writes $length bytes from the specified $fh and $offset
274 into the scalar given by $data and offset $dataoffset and calls the
275 callback without the actual number of bytes read (or -1 on error,
276 just like the syscall).
277
278 If $offset is undefined, then the current file descriptor offset
279 will be used (and updated), otherwise the file descriptor offset
280 will not be changed by these calls.
281
282 If $length is undefined in "aio_write", use the remaining length of
283 $data.
284
285 If $dataoffset is less than zero, it will be counted from the end of
286 $data.
287
288 The $data scalar *MUST NOT* be modified in any way while the request
289 is outstanding. Modifying it can result in segfaults or World War
290 III (if the necessary/optional hardware is installed).
291
292 Example: Read 15 bytes at offset 7 into scalar $buffer, starting at
293 offset 0 within the scalar:
294
295 aio_read $fh, 7, 15, $buffer, 0, sub {
296 $_[0] > 0 or die "read error: $!";
297 print "read $_[0] bytes: <$buffer>\n";
298 };
299
300 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
301 Tries to copy $length bytes from $in_fh to $out_fh. It starts
302 reading at byte offset $in_offset, and starts writing at the current
303 file offset of $out_fh. Because of that, it is not safe to issue
304 more than one "aio_sendfile" per $out_fh, as they will interfere
305 with each other.
306
307 This call tries to make use of a native "sendfile" syscall to
308 provide zero-copy operation. For this to work, $out_fh should refer
309 to a socket, and $in_fh should refer to mmap'able file.
310
311 If the native sendfile call fails or is not implemented, it will be
312 emulated, so you can call "aio_sendfile" on any type of filehandle
313 regardless of the limitations of the operating system.
314
315 Please note, however, that "aio_sendfile" can read more bytes from
316 $in_fh than are written, and there is no way to find out how many
317 bytes have been read from "aio_sendfile" alone, as "aio_sendfile"
318 only provides the number of bytes written to $out_fh. Only if the
319 result value equals $length one can assume that $length bytes have
320 been read.
321
322 aio_readahead $fh,$offset,$length, $callback->($retval)
323 "aio_readahead" populates the page cache with data from a file so
324 that subsequent reads from that file will not block on disk I/O. The
325 $offset argument specifies the starting point from which data is to
326 be read and $length specifies the number of bytes to be read. I/O is
327 performed in whole pages, so that offset is effectively rounded down
328 to a page boundary and bytes are read up to the next page boundary
329 greater than or equal to (off-set+length). "aio_readahead" does not
330 read beyond the end of the file. The current file offset of the file
331 is left unchanged.
332
333 If that syscall doesn't exist (likely if your OS isn't Linux) it
334 will be emulated by simply reading the data, which would have a
335 similar effect.
336
337 aio_stat $fh_or_path, $callback->($status)
338 aio_lstat $fh, $callback->($status)
339 Works like perl's "stat" or "lstat" in void context. The callback
340 will be called after the stat and the results will be available
341 using "stat _" or "-s _" etc...
342
343 The pathname passed to "aio_stat" must be absolute. See API NOTES,
344 above, for an explanation.
345
346 Currently, the stats are always 64-bit-stats, i.e. instead of
347 returning an error when stat'ing a large file, the results will be
348 silently truncated unless perl itself is compiled with large file
349 support.
350
351 Example: Print the length of /etc/passwd:
352
353 aio_stat "/etc/passwd", sub {
354 $_[0] and die "stat failed: $!";
355 print "size is ", -s _, "\n";
356 };
357
358 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
359 Works like perl's "utime" function (including the special case of
360 $atime and $mtime being undef). Fractional times are supported if
361 the underlying syscalls support them.
362
363 When called with a pathname, uses utimes(2) if available, otherwise
364 utime(2). If called on a file descriptor, uses futimes(2) if
365 available, otherwise returns ENOSYS, so this is not portable.
366
367 Examples:
368
369 # set atime and mtime to current time (basically touch(1)):
370 aio_utime "path", undef, undef;
371 # set atime to current time and mtime to beginning of the epoch:
372 aio_utime "path", time, undef; # undef==0
373
374 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
375 Works like perl's "chown" function, except that "undef" for either
376 $uid or $gid is being interpreted as "do not change" (but -1 can
377 also be used).
378
379 Examples:
380
381 # same as "chown root path" in the shell:
382 aio_chown "path", 0, -1;
383 # same as above:
384 aio_chown "path", 0, undef;
385
386 aio_truncate $fh_or_path, $offset, $callback->($status)
387 Works like truncate(2) or ftruncate(2).
388
389 aio_chmod $fh_or_path, $mode, $callback->($status)
390 Works like perl's "chmod" function.
391
392 aio_unlink $pathname, $callback->($status)
393 Asynchronously unlink (delete) a file and call the callback with the
394 result code.
395
396 aio_mknod $path, $mode, $dev, $callback->($status)
397 [EXPERIMENTAL]
398
399 Asynchronously create a device node (or fifo). See mknod(2).
400
401 The only (POSIX-) portable way of calling this function is:
402
403 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
404
405 aio_link $srcpath, $dstpath, $callback->($status)
406 Asynchronously create a new link to the existing object at $srcpath
407 at the path $dstpath and call the callback with the result code.
408
409 aio_symlink $srcpath, $dstpath, $callback->($status)
410 Asynchronously create a new symbolic link to the existing object at
411 $srcpath at the path $dstpath and call the callback with the result
412 code.
413
414 aio_readlink $path, $callback->($link)
415 Asynchronously read the symlink specified by $path and pass it to
416 the callback. If an error occurs, nothing or undef gets passed to
417 the callback.
418
419 aio_rename $srcpath, $dstpath, $callback->($status)
420 Asynchronously rename the object at $srcpath to $dstpath, just as
421 rename(2) and call the callback with the result code.
422
423 aio_mkdir $pathname, $mode, $callback->($status)
424 Asynchronously mkdir (create) a directory and call the callback with
425 the result code. $mode will be modified by the umask at the time the
426 request is executed, so do not change your umask.
427
428 aio_rmdir $pathname, $callback->($status)
429 Asynchronously rmdir (delete) a directory and call the callback with
430 the result code.
431
432 aio_readdir $pathname, $callback->($entries)
433 Unlike the POSIX call of the same name, "aio_readdir" reads an
434 entire directory (i.e. opendir + readdir + closedir). The entries
435 will not be sorted, and will NOT include the "." and ".." entries.
436
437 The callback a single argument which is either "undef" or an
438 array-ref with the filenames.
439
440 aio_load $path, $data, $callback->($status)
441 This is a composite request that tries to fully load the given file
442 into memory. Status is the same as with aio_read.
443
444 aio_copy $srcpath, $dstpath, $callback->($status)
445 Try to copy the *file* (directories not supported as either source
446 or destination) from $srcpath to $dstpath and call the callback with
447 the 0 (error) or -1 ok.
448
449 This is a composite request that it creates the destination file
450 with mode 0200 and copies the contents of the source file into it
451 using "aio_sendfile", followed by restoring atime, mtime, access
452 mode and uid/gid, in that order.
453
454 If an error occurs, the partial destination file will be unlinked,
455 if possible, except when setting atime, mtime, access mode and
456 uid/gid, where errors are being ignored.
457
458 aio_move $srcpath, $dstpath, $callback->($status)
459 Try to move the *file* (directories not supported as either source
460 or destination) from $srcpath to $dstpath and call the callback with
461 the 0 (error) or -1 ok.
462
463 This is a composite request that tries to rename(2) the file first.
464 If rename files with "EXDEV", it copies the file with "aio_copy"
465 and, if that is successful, unlinking the $srcpath.
466
467 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
468 Scans a directory (similar to "aio_readdir") but additionally tries
469 to efficiently separate the entries of directory $path into two sets
470 of names, directories you can recurse into (directories), and ones
471 you cannot recurse into (everything else, including symlinks to
472 directories).
473
474 "aio_scandir" is a composite request that creates of many sub
475 requests_ $maxreq specifies the maximum number of outstanding aio
476 requests that this function generates. If it is "<= 0", then a
477 suitable default will be chosen (currently 4).
478
479 On error, the callback is called without arguments, otherwise it
480 receives two array-refs with path-relative entry names.
481
482 Example:
483
484 aio_scandir $dir, 0, sub {
485 my ($dirs, $nondirs) = @_;
486 print "real directories: @$dirs\n";
487 print "everything else: @$nondirs\n";
488 };
489
490 Implementation notes.
491
492 The "aio_readdir" cannot be avoided, but "stat()"'ing every entry
493 can.
494
495 After reading the directory, the modification time, size etc. of the
496 directory before and after the readdir is checked, and if they match
497 (and isn't the current time), the link count will be used to decide
498 how many entries are directories (if >= 2). Otherwise, no knowledge
499 of the number of subdirectories will be assumed.
500
501 Then entries will be sorted into likely directories (everything
502 without a non-initial dot currently) and likely non-directories
503 (everything else). Then every entry plus an appended "/." will be
504 "stat"'ed, likely directories first. If that succeeds, it assumes
505 that the entry is a directory or a symlink to directory (which will
506 be checked seperately). This is often faster than stat'ing the entry
507 itself because filesystems might detect the type of the entry
508 without reading the inode data (e.g. ext2fs filetype feature).
509
510 If the known number of directories (link count - 2) has been
511 reached, the rest of the entries is assumed to be non-directories.
512
513 This only works with certainty on POSIX (= UNIX) filesystems, which
514 fortunately are the vast majority of filesystems around.
515
516 It will also likely work on non-POSIX filesystems with reduced
517 efficiency as those tend to return 0 or 1 as link counts, which
518 disables the directory counting heuristic.
519
520 aio_rmtree $path, $callback->($status)
521 Delete a directory tree starting (and including) $path, return the
522 status of the final "rmdir" only. This is a composite request that
523 uses "aio_scandir" to recurse into and rmdir directories, and unlink
524 everything else.
525
526 aio_fsync $fh, $callback->($status)
527 Asynchronously call fsync on the given filehandle and call the
528 callback with the fsync result code.
529
530 aio_fdatasync $fh, $callback->($status)
531 Asynchronously call fdatasync on the given filehandle and call the
532 callback with the fdatasync result code.
533
534 If this call isn't available because your OS lacks it or it couldn't
535 be detected, it will be emulated by calling "fsync" instead.
536
537 aio_group $callback->(...)
538 This is a very special aio request: Instead of doing something, it
539 is a container for other aio requests, which is useful if you want
540 to bundle many requests into a single, composite, request with a
541 definite callback and the ability to cancel the whole request with
542 its subrequests.
543
544 Returns an object of class IO::AIO::GRP. See its documentation below
545 for more info.
546
547 Example:
548
549 my $grp = aio_group sub {
550 print "all stats done\n";
551 };
552
553 add $grp
554 (aio_stat ...),
555 (aio_stat ...),
556 ...;
557
558 aio_nop $callback->()
559 This is a special request - it does nothing in itself and is only
560 used for side effects, such as when you want to add a dummy request
561 to a group so that finishing the requests in the group depends on
562 executing the given code.
563
564 While this request does nothing, it still goes through the execution
565 phase and still requires a worker thread. Thus, the callback will
566 not be executed immediately but only after other requests in the
567 queue have entered their execution phase. This can be used to
568 measure request latency.
569
570 IO::AIO::aio_busy $fractional_seconds, $callback->() *NOT EXPORTED*
571 Mainly used for debugging and benchmarking, this aio request puts
572 one of the request workers to sleep for the given time.
573
574 While it is theoretically handy to have simple I/O scheduling
575 requests like sleep and file handle readable/writable, the overhead
576 this creates is immense (it blocks a thread for a long time) so do
577 not use this function except to put your application under
578 artificial I/O pressure.
579
580 IO::AIO::REQ CLASS
581 All non-aggregate "aio_*" functions return an object of this class when
582 called in non-void context.
583
584 cancel $req
585 Cancels the request, if possible. Has the effect of skipping
586 execution when entering the execute state and skipping calling the
587 callback when entering the the result state, but will leave the
588 request otherwise untouched. That means that requests that currently
589 execute will not be stopped and resources held by the request will
590 not be freed prematurely.
591
592 cb $req $callback->(...)
593 Replace (or simply set) the callback registered to the request.
594
595 IO::AIO::GRP CLASS
596 This class is a subclass of IO::AIO::REQ, so all its methods apply to
597 objects of this class, too.
598
599 A IO::AIO::GRP object is a special request that can contain multiple
600 other aio requests.
601
602 You create one by calling the "aio_group" constructing function with a
603 callback that will be called when all contained requests have entered
604 the "done" state:
605
606 my $grp = aio_group sub {
607 print "all requests are done\n";
608 };
609
610 You add requests by calling the "add" method with one or more
611 "IO::AIO::REQ" objects:
612
613 $grp->add (aio_unlink "...");
614
615 add $grp aio_stat "...", sub {
616 $_[0] or return $grp->result ("error");
617
618 # add another request dynamically, if first succeeded
619 add $grp aio_open "...", sub {
620 $grp->result ("ok");
621 };
622 };
623
573 This makes it very easy to create composite requests (see the source 624 This makes it very easy to create composite requests (see the source of
574 of "aio_move" for an application) that work and feel like simple 625 "aio_move" for an application) that work and feel like simple requests.
575 requests.
576 626
577 * The IO::AIO::GRP objects will be cleaned up during calls to 627 * The IO::AIO::GRP objects will be cleaned up during calls to
578 "IO::AIO::poll_cb", just like any other request. 628 "IO::AIO::poll_cb", just like any other request.
579 * They can be canceled like any other request. Canceling will cancel 629 * They can be canceled like any other request. Canceling will cancel not
580 not only the request itself, but also all requests it contains. 630 only the request itself, but also all requests it contains.
581 * They can also can also be added to other IO::AIO::GRP objects. 631 * They can also can also be added to other IO::AIO::GRP objects.
582 * You must not add requests to a group from within the group 632 * You must not add requests to a group from within the group callback
583 callback (or any later time). 633 (or any later time).
584 634
585 Their lifetime, simplified, looks like this: when they are empty, 635 Their lifetime, simplified, looks like this: when they are empty, they
586 they will finish very quickly. If they contain only requests that 636 will finish very quickly. If they contain only requests that are in the
587 are in the "done" state, they will also finish. Otherwise they will 637 "done" state, they will also finish. Otherwise they will continue to
588 continue to exist. 638 exist.
589 639
590 That means after creating a group you have some time to add 640 That means after creating a group you have some time to add requests.
591 requests. And in the callbacks of those requests, you can add 641 And in the callbacks of those requests, you can add further requests to
592 further requests to the group. And only when all those requests have 642 the group. And only when all those requests have finished will the the
593 finished will the the group itself finish. 643 group itself finish.
594 644
595 add $grp ... 645 add $grp ...
596 $grp->add (...) 646 $grp->add (...)
597 Add one or more requests to the group. Any type of IO::AIO::REQ 647 Add one or more requests to the group. Any type of IO::AIO::REQ can
598 can be added, including other groups, as long as you do not 648 be added, including other groups, as long as you do not create
599 create circular dependencies. 649 circular dependencies.
600 650
601 Returns all its arguments. 651 Returns all its arguments.
602 652
603 $grp->cancel_subs 653 $grp->cancel_subs
604 Cancel all subrequests and clears any feeder, but not the group 654 Cancel all subrequests and clears any feeder, but not the group
605 request itself. Useful when you queued a lot of events but got a 655 request itself. Useful when you queued a lot of events but got a
606 result early. 656 result early.
607 657
608 $grp->result (...) 658 $grp->result (...)
609 Set the result value(s) that will be passed to the group 659 Set the result value(s) that will be passed to the group callback
610 callback when all subrequests have finished and set thre groups 660 when all subrequests have finished and set thre groups errno to the
611 errno to the current value of errno (just like calling "errno" 661 current value of errno (just like calling "errno" without an error
612 without an error number). By default, no argument will be passed 662 number). By default, no argument will be passed and errno is zero.
613 and errno is zero.
614 663
615 $grp->errno ([$errno]) 664 $grp->errno ([$errno])
616 Sets the group errno value to $errno, or the current value of 665 Sets the group errno value to $errno, or the current value of errno
617 errno when the argument is missing. 666 when the argument is missing.
618 667
619 Every aio request has an associated errno value that is restored 668 Every aio request has an associated errno value that is restored
620 when the callback is invoked. This method lets you change this 669 when the callback is invoked. This method lets you change this value
621 value from its default (0). 670 from its default (0).
622 671
623 Calling "result" will also set errno, so make sure you either 672 Calling "result" will also set errno, so make sure you either set $!
624 set $! before the call to "result", or call c<errno> after it. 673 before the call to "result", or call c<errno> after it.
625 674
626 feed $grp $callback->($grp) 675 feed $grp $callback->($grp)
627 Sets a feeder/generator on this group: every group can have an 676 Sets a feeder/generator on this group: every group can have an
628 attached generator that generates requests if idle. The idea 677 attached generator that generates requests if idle. The idea behind
629 behind this is that, although you could just queue as many 678 this is that, although you could just queue as many requests as you
630 requests as you want in a group, this might starve other 679 want in a group, this might starve other requests for a potentially
631 requests for a potentially long time. For example, "aio_scandir" 680 long time. For example, "aio_scandir" might generate hundreds of
632 might generate hundreds of thousands "aio_stat" requests, 681 thousands "aio_stat" requests, delaying any later requests for a
633 delaying any later requests for a long time. 682 long time.
634 683
635 To avoid this, and allow incremental generation of requests, you 684 To avoid this, and allow incremental generation of requests, you can
636 can instead a group and set a feeder on it that generates those 685 instead a group and set a feeder on it that generates those
637 requests. The feed callback will be called whenever there are 686 requests. The feed callback will be called whenever there are few
638 few enough (see "limit", below) requests active in the group 687 enough (see "limit", below) requests active in the group itself and
639 itself and is expected to queue more requests. 688 is expected to queue more requests.
640 689
641 The feed callback can queue as many requests as it likes (i.e. 690 The feed callback can queue as many requests as it likes (i.e. "add"
642 "add" does not impose any limits). 691 does not impose any limits).
643 692
644 If the feed does not queue more requests when called, it will be 693 If the feed does not queue more requests when called, it will be
645 automatically removed from the group. 694 automatically removed from the group.
646 695
647 If the feed limit is 0, it will be set to 2 automatically. 696 If the feed limit is 0, it will be set to 2 automatically.
648 697
649 Example: 698 Example:
650 699
651 # stat all files in @files, but only ever use four aio requests concurrently: 700 # stat all files in @files, but only ever use four aio requests concurrently:
652 701
653 my $grp = aio_group sub { print "finished\n" }; 702 my $grp = aio_group sub { print "finished\n" };
654 limit $grp 4; 703 limit $grp 4;
655 feed $grp sub { 704 feed $grp sub {
656 my $file = pop @files 705 my $file = pop @files
657 or return; 706 or return;
658 707
659 add $grp aio_stat $file, sub { ... }; 708 add $grp aio_stat $file, sub { ... };
660 }; 709 };
661 710
662 limit $grp $num 711 limit $grp $num
663 Sets the feeder limit for the group: The feeder will be called 712 Sets the feeder limit for the group: The feeder will be called
664 whenever the group contains less than this many requests. 713 whenever the group contains less than this many requests.
665 714
666 Setting the limit to 0 will pause the feeding process. 715 Setting the limit to 0 will pause the feeding process.
667 716
668 SUPPORT FUNCTIONS 717 SUPPORT FUNCTIONS
669 EVENT PROCESSING AND EVENT LOOP INTEGRATION 718 EVENT PROCESSING AND EVENT LOOP INTEGRATION
670 $fileno = IO::AIO::poll_fileno 719 $fileno = IO::AIO::poll_fileno
671 Return the *request result pipe file descriptor*. This 720 Return the *request result pipe file descriptor*. This filehandle
672 filehandle must be polled for reading by some mechanism outside 721 must be polled for reading by some mechanism outside this module
673 this module (e.g. Event or select, see below or the SYNOPSIS). 722 (e.g. Event or select, see below or the SYNOPSIS). If the pipe
674 If the pipe becomes readable you have to call "poll_cb" to check 723 becomes readable you have to call "poll_cb" to check the results.
675 the results.
676 724
677 See "poll_cb" for an example. 725 See "poll_cb" for an example.
678 726
679 IO::AIO::poll_cb 727 IO::AIO::poll_cb
680 Process some outstanding events on the result pipe. You have to 728 Process some outstanding events on the result pipe. You have to call
681 call this regularly. Returns the number of events processed. 729 this regularly. Returns the number of events processed. Returns
682 Returns immediately when no events are outstanding. The amount 730 immediately when no events are outstanding. The amount of events
683 of events processed depends on the settings of 731 processed depends on the settings of "IO::AIO::max_poll_req" and
684 "IO::AIO::max_poll_req" and "IO::AIO::max_poll_time". 732 "IO::AIO::max_poll_time".
685 733
686 If not all requests were processed for whatever reason, the 734 If not all requests were processed for whatever reason, the
687 filehandle will still be ready when "poll_cb" returns. 735 filehandle will still be ready when "poll_cb" returns.
688 736
689 Example: Install an Event watcher that automatically calls 737 Example: Install an Event watcher that automatically calls
690 IO::AIO::poll_cb with high priority: 738 IO::AIO::poll_cb with high priority:
691 739
692 Event->io (fd => IO::AIO::poll_fileno, 740 Event->io (fd => IO::AIO::poll_fileno,
693 poll => 'r', async => 1, 741 poll => 'r', async => 1,
694 cb => \&IO::AIO::poll_cb); 742 cb => \&IO::AIO::poll_cb);
695 743
696 IO::AIO::max_poll_reqs $nreqs 744 IO::AIO::max_poll_reqs $nreqs
697 IO::AIO::max_poll_time $seconds 745 IO::AIO::max_poll_time $seconds
698 These set the maximum number of requests (default 0, meaning 746 These set the maximum number of requests (default 0, meaning
699 infinity) that are being processed by "IO::AIO::poll_cb" in one 747 infinity) that are being processed by "IO::AIO::poll_cb" in one
700 call, respectively the maximum amount of time (default 0, 748 call, respectively the maximum amount of time (default 0, meaning
701 meaning infinity) spent in "IO::AIO::poll_cb" to process 749 infinity) spent in "IO::AIO::poll_cb" to process requests (more
702 requests (more correctly the mininum amount of time "poll_cb" is 750 correctly the mininum amount of time "poll_cb" is allowed to use).
703 allowed to use).
704 751
752 Setting "max_poll_time" to a non-zero value creates an overhead of
753 one syscall per request processed, which is not normally a problem
754 unless your callbacks are really really fast or your OS is really
755 really slow (I am not mentioning Solaris here). Using
756 "max_poll_reqs" incurs no overhead.
757
705 Setting these is useful if you want to ensure some level of 758 Setting these is useful if you want to ensure some level of
706 interactiveness when perl is not fast enough to process all 759 interactiveness when perl is not fast enough to process all requests
707 requests in time. 760 in time.
708 761
709 For interactive programs, values such as 0.01 to 0.1 should be 762 For interactive programs, values such as 0.01 to 0.1 should be fine.
710 fine.
711 763
712 Example: Install an Event watcher that automatically calls 764 Example: Install an Event watcher that automatically calls
713 IO::AIO::poll_some with low priority, to ensure that other parts 765 IO::AIO::poll_cb with low priority, to ensure that other parts of
714 of the program get the CPU sometimes even under high AIO load. 766 the program get the CPU sometimes even under high AIO load.
715 767
716 # try not to spend much more than 0.1s in poll_cb 768 # try not to spend much more than 0.1s in poll_cb
717 IO::AIO::max_poll_time 0.1; 769 IO::AIO::max_poll_time 0.1;
718 770
719 # use a low priority so other tasks have priority 771 # use a low priority so other tasks have priority
720 Event->io (fd => IO::AIO::poll_fileno, 772 Event->io (fd => IO::AIO::poll_fileno,
721 poll => 'r', nice => 1, 773 poll => 'r', nice => 1,
722 cb => &IO::AIO::poll_cb); 774 cb => &IO::AIO::poll_cb);
723 775
724 IO::AIO::poll_wait 776 IO::AIO::poll_wait
777 If there are any outstanding requests and none of them in the result
725 Wait till the result filehandle becomes ready for reading 778 phase, wait till the result filehandle becomes ready for reading
726 (simply does a "select" on the filehandle. This is useful if you 779 (simply does a "select" on the filehandle. This is useful if you
727 want to synchronously wait for some requests to finish). 780 want to synchronously wait for some requests to finish).
728 781
729 See "nreqs" for an example. 782 See "nreqs" for an example.
730 783
731 IO::AIO::poll 784 IO::AIO::poll
732 Waits until some requests have been handled. 785 Waits until some requests have been handled.
733 786
787 Returns the number of requests processed, but is otherwise strictly
734 Strictly equivalent to: 788 equivalent to:
735 789
736 IO::AIO::poll_wait, IO::AIO::poll_cb 790 IO::AIO::poll_wait, IO::AIO::poll_cb
737 if IO::AIO::nreqs;
738 791
739 IO::AIO::flush 792 IO::AIO::flush
740 Wait till all outstanding AIO requests have been handled. 793 Wait till all outstanding AIO requests have been handled.
741 794
742 Strictly equivalent to: 795 Strictly equivalent to:
743 796
744 IO::AIO::poll_wait, IO::AIO::poll_cb 797 IO::AIO::poll_wait, IO::AIO::poll_cb
745 while IO::AIO::nreqs; 798 while IO::AIO::nreqs;
746 799
747 CONTROLLING THE NUMBER OF THREADS 800 CONTROLLING THE NUMBER OF THREADS
748 IO::AIO::min_parallel $nthreads 801 IO::AIO::min_parallel $nthreads
749 Set the minimum number of AIO threads to $nthreads. The current 802 Set the minimum number of AIO threads to $nthreads. The current
750 default is 8, which means eight asynchronous operations can 803 default is 8, which means eight asynchronous operations can execute
751 execute concurrently at any one time (the number of outstanding 804 concurrently at any one time (the number of outstanding requests,
752 requests, however, is unlimited). 805 however, is unlimited).
753 806
754 IO::AIO starts threads only on demand, when an AIO request is 807 IO::AIO starts threads only on demand, when an AIO request is queued
755 queued and no free thread exists. Please note that queueing up a 808 and no free thread exists. Please note that queueing up a hundred
756 hundred requests can create demand for a hundred threads, even 809 requests can create demand for a hundred threads, even if it turns
757 if it turns out that everything is in the cache and could have 810 out that everything is in the cache and could have been processed
758 been processed faster by a single thread. 811 faster by a single thread.
759 812
760 It is recommended to keep the number of threads relatively low, 813 It is recommended to keep the number of threads relatively low, as
761 as some Linux kernel versions will scale negatively with the 814 some Linux kernel versions will scale negatively with the number of
762 number of threads (higher parallelity => MUCH higher latency). 815 threads (higher parallelity => MUCH higher latency). With current
763 With current Linux 2.6 versions, 4-32 threads should be fine. 816 Linux 2.6 versions, 4-32 threads should be fine.
764 817
765 Under most circumstances you don't need to call this function, 818 Under most circumstances you don't need to call this function, as
766 as the module selects a default that is suitable for low to 819 the module selects a default that is suitable for low to moderate
767 moderate load. 820 load.
768 821
769 IO::AIO::max_parallel $nthreads 822 IO::AIO::max_parallel $nthreads
770 Sets the maximum number of AIO threads to $nthreads. If more 823 Sets the maximum number of AIO threads to $nthreads. If more than
771 than the specified number of threads are currently running, this 824 the specified number of threads are currently running, this function
772 function kills them. This function blocks until the limit is 825 kills them. This function blocks until the limit is reached.
773 reached.
774 826
775 While $nthreads are zero, aio requests get queued but not 827 While $nthreads are zero, aio requests get queued but not executed
776 executed until the number of threads has been increased again. 828 until the number of threads has been increased again.
777 829
778 This module automatically runs "max_parallel 0" at program end, 830 This module automatically runs "max_parallel 0" at program end, to
779 to ensure that all threads are killed and that there are no 831 ensure that all threads are killed and that there are no outstanding
780 outstanding requests. 832 requests.
781 833
782 Under normal circumstances you don't need to call this function. 834 Under normal circumstances you don't need to call this function.
783 835
784 IO::AIO::max_idle $nthreads 836 IO::AIO::max_idle $nthreads
785 Limit the number of threads (default: 4) that are allowed to 837 Limit the number of threads (default: 4) that are allowed to idle
786 idle (i.e., threads that did not get a request to process within 838 (i.e., threads that did not get a request to process within 10
787 10 seconds). That means if a thread becomes idle while $nthreads 839 seconds). That means if a thread becomes idle while $nthreads other
788 other threads are also idle, it will free its resources and 840 threads are also idle, it will free its resources and exit.
789 exit.
790 841
791 This is useful when you allow a large number of threads (e.g. 842 This is useful when you allow a large number of threads (e.g. 100 or
792 100 or 1000) to allow for extremely high load situations, but 843 1000) to allow for extremely high load situations, but want to free
793 want to free resources under normal circumstances (1000 threads 844 resources under normal circumstances (1000 threads can easily
794 can easily consume 30MB of RAM). 845 consume 30MB of RAM).
795 846
796 The default is probably ok in most situations, especially if 847 The default is probably ok in most situations, especially if thread
797 thread creation is fast. If thread creation is very slow on your 848 creation is fast. If thread creation is very slow on your system you
798 system you might want to use larger values. 849 might want to use larger values.
799 850
800 $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 851 $oldmaxreqs = IO::AIO::max_outstanding $maxreqs
801 This is a very bad function to use in interactive programs 852 This is a very bad function to use in interactive programs because
802 because it blocks, and a bad way to reduce concurrency because 853 it blocks, and a bad way to reduce concurrency because it is
803 it is inexact: Better use an "aio_group" together with a feed 854 inexact: Better use an "aio_group" together with a feed callback.
804 callback.
805 855
806 Sets the maximum number of outstanding requests to $nreqs. If 856 Sets the maximum number of outstanding requests to $nreqs. If you do
807 you to queue up more than this number of requests, the next call 857 queue up more than this number of requests, the next call to the
808 to the "poll_cb" (and "poll_some" and other functions calling 858 "poll_cb" (and "poll_some" and other functions calling "poll_cb")
809 "poll_cb") function will block until the limit is no longer 859 function will block until the limit is no longer exceeded.
810 exceeded.
811 860
812 The default value is very large, so there is no practical limit 861 The default value is very large, so there is no practical limit on
813 on the number of outstanding requests. 862 the number of outstanding requests.
814 863
815 You can still queue as many requests as you want. Therefore, 864 You can still queue as many requests as you want. Therefore,
816 "max_oustsanding" is mainly useful in simple scripts (with low 865 "max_oustsanding" is mainly useful in simple scripts (with low
817 values) or as a stop gap to shield against fatal memory overflow 866 values) or as a stop gap to shield against fatal memory overflow
818 (with large values). 867 (with large values).
819 868
820 STATISTICAL INFORMATION 869 STATISTICAL INFORMATION
821 IO::AIO::nreqs 870 IO::AIO::nreqs
822 Returns the number of requests currently in the ready, execute 871 Returns the number of requests currently in the ready, execute or
823 or pending states (i.e. for which their callback has not been 872 pending states (i.e. for which their callback has not been invoked
824 invoked yet). 873 yet).
825 874
826 Example: wait till there are no outstanding requests anymore: 875 Example: wait till there are no outstanding requests anymore:
827 876
828 IO::AIO::poll_wait, IO::AIO::poll_cb 877 IO::AIO::poll_wait, IO::AIO::poll_cb
829 while IO::AIO::nreqs; 878 while IO::AIO::nreqs;
830 879
831 IO::AIO::nready 880 IO::AIO::nready
832 Returns the number of requests currently in the ready state (not 881 Returns the number of requests currently in the ready state (not yet
833 yet executed). 882 executed).
834 883
835 IO::AIO::npending 884 IO::AIO::npending
836 Returns the number of requests currently in the pending state 885 Returns the number of requests currently in the pending state
837 (executed, but not yet processed by poll_cb). 886 (executed, but not yet processed by poll_cb).
838 887
839 FORK BEHAVIOUR 888 FORK BEHAVIOUR
840 This module should do "the right thing" when the process using it 889 This module should do "the right thing" when the process using it forks:
841 forks:
842 890
843 Before the fork, IO::AIO enters a quiescent state where no requests 891 Before the fork, IO::AIO enters a quiescent state where no requests can
844 can be added in other threads and no results will be processed. 892 be added in other threads and no results will be processed. After the
845 After the fork the parent simply leaves the quiescent state and 893 fork the parent simply leaves the quiescent state and continues
846 continues request/result processing, while the child frees the 894 request/result processing, while the child frees the request/result
847 request/result queue (so that the requests started before the fork 895 queue (so that the requests started before the fork will only be handled
848 will only be handled in the parent). Threads will be started on 896 in the parent). Threads will be started on demand until the limit set in
849 demand until the limit set in the parent process has been reached 897 the parent process has been reached again.
850 again.
851 898
852 In short: the parent will, after a short pause, continue as if fork 899 In short: the parent will, after a short pause, continue as if fork had
853 had not been called, while the child will act as if IO::AIO has not 900 not been called, while the child will act as if IO::AIO has not been
854 been used yet. 901 used yet.
855 902
856 MEMORY USAGE 903 MEMORY USAGE
857 Per-request usage: 904 Per-request usage:
858 905
859 Each aio request uses - depending on your architecture - around 906 Each aio request uses - depending on your architecture - around 100-200
860 100-200 bytes of memory. In addition, stat requests need a stat 907 bytes of memory. In addition, stat requests need a stat buffer (possibly
861 buffer (possibly a few hundred bytes), readdir requires a result 908 a few hundred bytes), readdir requires a result buffer and so on. Perl
862 buffer and so on. Perl scalars and other data passed into aio 909 scalars and other data passed into aio requests will also be locked and
863 requests will also be locked and will consume memory till the 910 will consume memory till the request has entered the done state.
864 request has entered the done state.
865 911
866 This is now awfully much, so queuing lots of requests is not usually 912 This is not awfully much, so queuing lots of requests is not usually a
867 a problem. 913 problem.
868 914
869 Per-thread usage: 915 Per-thread usage:
870 916
871 In the execution phase, some aio requests require more memory for 917 In the execution phase, some aio requests require more memory for
872 temporary buffers, and each thread requires a stack and other data 918 temporary buffers, and each thread requires a stack and other data
873 structures (usually around 16k-128k, depending on the OS). 919 structures (usually around 16k-128k, depending on the OS).
874 920
875KNOWN BUGS 921KNOWN BUGS
876 Known bugs will be fixed in the next release. 922 Known bugs will be fixed in the next release.
877 923
878SEE ALSO 924SEE ALSO
879 Coro::AIO. 925 Coro::AIO.
880 926
881AUTHOR 927AUTHOR
882 Marc Lehmann <schmorp@schmorp.de> 928 Marc Lehmann <schmorp@schmorp.de>
883 http://home.schmorp.de/ 929 http://home.schmorp.de/
884 930

Diff Legend

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