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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.94 by root, Wed Nov 8 02:01:02 2006 UTC vs.
Revision 1.147 by root, Wed Jun 3 12:24:49 2009 UTC

26 $req->cancel; # cancel request if still in queue 26 $req->cancel; # cancel request if still in queue
27 27
28 my $grp = aio_group sub { print "all stats done\n" }; 28 my $grp = aio_group sub { print "all stats done\n" };
29 add $grp aio_stat "..." for ...; 29 add $grp aio_stat "..." for ...;
30 30
31 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
32 use AnyEvent::AIO;
33
31 # AnyEvent integration 34 # EV integration
32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!"; 35 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34 36
35 # Event integration 37 # Event integration
36 Event->io (fd => IO::AIO::poll_fileno, 38 Event->io (fd => IO::AIO::poll_fileno,
37 poll => 'r', 39 poll => 'r',
38 cb => \&IO::AIO::poll_cb); 40 cb => \&IO::AIO::poll_cb);
62etc.), but can also be used to easily do operations in parallel that are 64etc.), but can also be used to easily do operations in parallel that are
63normally done sequentially, e.g. stat'ing many files, which is much faster 65normally done sequentially, e.g. stat'ing many files, which is much faster
64on a RAID volume or over NFS when you do a number of stat operations 66on a RAID volume or over NFS when you do a number of stat operations
65concurrently. 67concurrently.
66 68
67While most of this works on all types of file descriptors (for example 69While most of this works on all types of file descriptors (for
68sockets), using these functions on file descriptors that support 70example sockets), using these functions on file descriptors that
69nonblocking operation (again, sockets, pipes etc.) is very inefficient or 71support nonblocking operation (again, sockets, pipes etc.) is very
70might not work (aio_read fails on sockets/pipes/fifos). Use an event loop 72inefficient. Use an event loop for that (such as the L<Event|Event>
71for that (such as the L<Event|Event> module): IO::AIO will naturally fit 73module): IO::AIO will naturally fit into such an event loop itself.
72into such an event loop itself.
73 74
74In this version, a number of threads are started that execute your 75In this version, a number of threads are started that execute your
75requests and signal their completion. You don't need thread support 76requests and signal their completion. You don't need thread support
76in perl, and the threads created by this module will not be visible 77in perl, and the threads created by this module will not be visible
77to perl. In the future, this module might make use of the native aio 78to perl. In the future, this module might make use of the native aio
79not well-supported or restricted (GNU/Linux doesn't allow them on normal 80not well-supported or restricted (GNU/Linux doesn't allow them on normal
80files currently, for example), and they would only support aio_read and 81files currently, for example), and they would only support aio_read and
81aio_write, so the remaining functionality would have to be implemented 82aio_write, so the remaining functionality would have to be implemented
82using threads anyway. 83using threads anyway.
83 84
84Although the module will work with in the presence of other (Perl-) 85Although the module will work in the presence of other (Perl-) threads,
85threads, it is currently not reentrant in any way, so use appropriate 86it is currently not reentrant in any way, so use appropriate locking
86locking yourself, always call C<poll_cb> from within the same thread, or 87yourself, always call C<poll_cb> from within the same thread, or never
87never call C<poll_cb> (or other C<aio_> functions) recursively. 88call C<poll_cb> (or other C<aio_> functions) recursively.
88 89
89=head2 EXAMPLE 90=head2 EXAMPLE
90 91
91This is a simple example that uses the Event module and loads 92This is a simple example that uses the Event module and loads
92F</etc/passwd> asynchronously: 93F</etc/passwd> asynchronously:
184 185
185=cut 186=cut
186 187
187package IO::AIO; 188package IO::AIO;
188 189
190use Carp ();
191
189no warnings; 192no warnings;
190use strict 'vars'; 193use strict 'vars';
191 194
192use base 'Exporter'; 195use base 'Exporter';
193 196
194BEGIN { 197BEGIN {
195 our $VERSION = '2.2'; 198 our $VERSION = '3.19';
196 199
197 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close aio_stat 200 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
198 aio_lstat aio_unlink aio_rmdir aio_readdir aio_scandir aio_symlink 201 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir
199 aio_readlink aio_fsync aio_fdatasync aio_readahead aio_rename aio_link 202 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
200 aio_move aio_copy aio_group aio_nop aio_mknod); 203 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
204 aio_rename aio_link aio_move aio_copy aio_group
205 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
206 aio_chmod aio_utime aio_truncate);
207
201 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 208 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
202 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 209 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
203 min_parallel max_parallel max_idle 210 min_parallel max_parallel max_idle
204 nreqs nready npending nthreads 211 nreqs nready npending nthreads
205 max_poll_time max_poll_reqs); 212 max_poll_time max_poll_reqs);
206 213
214 push @AIO_REQ, qw(aio_busy); # not exported
215
207 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 216 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
208 217
209 require XSLoader; 218 require XSLoader;
210 XSLoader::load ("IO::AIO", $VERSION); 219 XSLoader::load ("IO::AIO", $VERSION);
211} 220}
217All the C<aio_*> calls are more or less thin wrappers around the syscall 226All the C<aio_*> calls are more or less thin wrappers around the syscall
218with the same name (sans C<aio_>). The arguments are similar or identical, 227with the same name (sans C<aio_>). The arguments are similar or identical,
219and they all accept an additional (and optional) C<$callback> argument 228and they all accept an additional (and optional) C<$callback> argument
220which must be a code reference. This code reference will get called with 229which must be a code reference. This code reference will get called with
221the syscall return code (e.g. most syscalls return C<-1> on error, unlike 230the syscall return code (e.g. most syscalls return C<-1> on error, unlike
222perl, which usually delivers "false") as it's sole argument when the given 231perl, which usually delivers "false") as its sole argument after the given
223syscall has been executed asynchronously. 232syscall has been executed asynchronously.
224 233
225All functions expecting a filehandle keep a copy of the filehandle 234All functions expecting a filehandle keep a copy of the filehandle
226internally until the request has finished. 235internally until the request has finished.
227 236
241your pathnames to the locale (or other) encoding in effect in the user 250your pathnames to the locale (or other) encoding in effect in the user
242environment, d) use Glib::filename_from_unicode on unicode filenames or e) 251environment, d) use Glib::filename_from_unicode on unicode filenames or e)
243use something else to ensure your scalar has the correct contents. 252use something else to ensure your scalar has the correct contents.
244 253
245This works, btw. independent of the internal UTF-8 bit, which IO::AIO 254This works, btw. independent of the internal UTF-8 bit, which IO::AIO
246handles correctly wether it is set or not. 255handles correctly whether it is set or not.
247 256
248=over 4 257=over 4
249 258
250=item $prev_pri = aioreq_pri [$pri] 259=item $prev_pri = aioreq_pri [$pri]
251 260
271 aio_read $_[0], ..., sub { 280 aio_read $_[0], ..., sub {
272 ... 281 ...
273 }; 282 };
274 }; 283 };
275 284
285
276=item aioreq_nice $pri_adjust 286=item aioreq_nice $pri_adjust
277 287
278Similar to C<aioreq_pri>, but subtracts the given value from the current 288Similar to C<aioreq_pri>, but subtracts the given value from the current
279priority, so the effect is cumulative. 289priority, so the effect is cumulative.
290
280 291
281=item aio_open $pathname, $flags, $mode, $callback->($fh) 292=item aio_open $pathname, $flags, $mode, $callback->($fh)
282 293
283Asynchronously open or create a file and call the callback with a newly 294Asynchronously open or create a file and call the callback with a newly
284created filehandle for the file. 295created filehandle for the file.
290list. They are the same as used by C<sysopen>. 301list. They are the same as used by C<sysopen>.
291 302
292Likewise, C<$mode> specifies the mode of the newly created file, if it 303Likewise, C<$mode> specifies the mode of the newly created file, if it
293didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>, 304didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,
294except that it is mandatory (i.e. use C<0> if you don't create new files, 305except that it is mandatory (i.e. use C<0> if you don't create new files,
295and C<0666> or C<0777> if you do). 306and C<0666> or C<0777> if you do). Note that the C<$mode> will be modified
307by the umask in effect then the request is being executed, so better never
308change the umask.
296 309
297Example: 310Example:
298 311
299 aio_open "/etc/passwd", O_RDONLY, 0, sub { 312 aio_open "/etc/passwd", O_RDONLY, 0, sub {
300 if ($_[0]) { 313 if ($_[0]) {
303 } else { 316 } else {
304 die "open failed: $!\n"; 317 die "open failed: $!\n";
305 } 318 }
306 }; 319 };
307 320
321
308=item aio_close $fh, $callback->($status) 322=item aio_close $fh, $callback->($status)
309 323
310Asynchronously close a file and call the callback with the result 324Asynchronously close a file and call the callback with the result
311code. I<WARNING:> although accepted, you should not pass in a perl 325code.
312filehandle here, as perl will likely close the file descriptor another
313time when the filehandle is destroyed. Normally, you can safely call perls
314C<close> or just let filehandles go out of scope.
315 326
316This is supposed to be a bug in the API, so that might change. It's 327Unfortunately, you can't do this to perl. Perl I<insists> very strongly on
317therefore best to avoid this function. 328closing the file descriptor associated with the filehandle itself.
329
330Therefore, C<aio_close> will not close the filehandle - instead it will
331use dup2 to overwrite the file descriptor with the write-end of a pipe
332(the pipe fd will be created on demand and will be cached).
333
334Or in other words: the file descriptor will be closed, but it will not be
335free for reuse until the perl filehandle is closed.
336
337=cut
318 338
319=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 339=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
320 340
321=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 341=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
322 342
323Reads or writes C<length> bytes from the specified C<fh> and C<offset> 343Reads or writes C<$length> bytes from or to the specified C<$fh> and
324into the scalar given by C<data> and offset C<dataoffset> and calls the 344C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
325callback without the actual number of bytes read (or -1 on error, just 345and calls the callback without the actual number of bytes read (or -1 on
326like the syscall). 346error, just like the syscall).
347
348C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
349offset plus the actual number of bytes read.
350
351If C<$offset> is undefined, then the current file descriptor offset will
352be used (and updated), otherwise the file descriptor offset will not be
353changed by these calls.
354
355If C<$length> is undefined in C<aio_write>, use the remaining length of
356C<$data>.
357
358If C<$dataoffset> is less than zero, it will be counted from the end of
359C<$data>.
327 360
328The C<$data> scalar I<MUST NOT> be modified in any way while the request 361The C<$data> scalar I<MUST NOT> be modified in any way while the request
329is outstanding. Modifying it can result in segfaults or WW3 (if the 362is outstanding. Modifying it can result in segfaults or World War III (if
330necessary/optional hardware is installed). 363the necessary/optional hardware is installed).
331 364
332Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at 365Example: Read 15 bytes at offset 7 into scalar C<$buffer>, starting at
333offset C<0> within the scalar: 366offset C<0> within the scalar:
334 367
335 aio_read $fh, 7, 15, $buffer, 0, sub { 368 aio_read $fh, 7, 15, $buffer, 0, sub {
336 $_[0] > 0 or die "read error: $!"; 369 $_[0] > 0 or die "read error: $!";
337 print "read $_[0] bytes: <$buffer>\n"; 370 print "read $_[0] bytes: <$buffer>\n";
338 }; 371 };
372
339 373
340=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval) 374=item aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
341 375
342Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts 376Tries to copy C<$length> bytes from C<$in_fh> to C<$out_fh>. It starts
343reading at byte offset C<$in_offset>, and starts writing at the current 377reading at byte offset C<$in_offset>, and starts writing at the current
357C<$in_fh> than are written, and there is no way to find out how many 391C<$in_fh> than are written, and there is no way to find out how many
358bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 392bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
359provides the number of bytes written to C<$out_fh>. Only if the result 393provides the number of bytes written to C<$out_fh>. Only if the result
360value equals C<$length> one can assume that C<$length> bytes have been 394value equals C<$length> one can assume that C<$length> bytes have been
361read. 395read.
396
362 397
363=item aio_readahead $fh,$offset,$length, $callback->($retval) 398=item aio_readahead $fh,$offset,$length, $callback->($retval)
364 399
365C<aio_readahead> populates the page cache with data from a file so that 400C<aio_readahead> populates the page cache with data from a file so that
366subsequent reads from that file will not block on disk I/O. The C<$offset> 401subsequent reads from that file will not block on disk I/O. The C<$offset>
372file. The current file offset of the file is left unchanged. 407file. The current file offset of the file is left unchanged.
373 408
374If that syscall doesn't exist (likely if your OS isn't Linux) it will be 409If that syscall doesn't exist (likely if your OS isn't Linux) it will be
375emulated by simply reading the data, which would have a similar effect. 410emulated by simply reading the data, which would have a similar effect.
376 411
412
377=item aio_stat $fh_or_path, $callback->($status) 413=item aio_stat $fh_or_path, $callback->($status)
378 414
379=item aio_lstat $fh, $callback->($status) 415=item aio_lstat $fh, $callback->($status)
380 416
381Works like perl's C<stat> or C<lstat> in void context. The callback will 417Works like perl's C<stat> or C<lstat> in void context. The callback will
394 aio_stat "/etc/passwd", sub { 430 aio_stat "/etc/passwd", sub {
395 $_[0] and die "stat failed: $!"; 431 $_[0] and die "stat failed: $!";
396 print "size is ", -s _, "\n"; 432 print "size is ", -s _, "\n";
397 }; 433 };
398 434
435
436=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
437
438Works like perl's C<utime> function (including the special case of $atime
439and $mtime being undef). Fractional times are supported if the underlying
440syscalls support them.
441
442When called with a pathname, uses utimes(2) if available, otherwise
443utime(2). If called on a file descriptor, uses futimes(2) if available,
444otherwise returns ENOSYS, so this is not portable.
445
446Examples:
447
448 # set atime and mtime to current time (basically touch(1)):
449 aio_utime "path", undef, undef;
450 # set atime to current time and mtime to beginning of the epoch:
451 aio_utime "path", time, undef; # undef==0
452
453
454=item aio_chown $fh_or_path, $uid, $gid, $callback->($status)
455
456Works like perl's C<chown> function, except that C<undef> for either $uid
457or $gid is being interpreted as "do not change" (but -1 can also be used).
458
459Examples:
460
461 # same as "chown root path" in the shell:
462 aio_chown "path", 0, -1;
463 # same as above:
464 aio_chown "path", 0, undef;
465
466
467=item aio_truncate $fh_or_path, $offset, $callback->($status)
468
469Works like truncate(2) or ftruncate(2).
470
471
472=item aio_chmod $fh_or_path, $mode, $callback->($status)
473
474Works like perl's C<chmod> function.
475
476
399=item aio_unlink $pathname, $callback->($status) 477=item aio_unlink $pathname, $callback->($status)
400 478
401Asynchronously unlink (delete) a file and call the callback with the 479Asynchronously unlink (delete) a file and call the callback with the
402result code. 480result code.
403 481
482
404=item aio_mknod $path, $mode, $dev, $callback->($status) 483=item aio_mknod $path, $mode, $dev, $callback->($status)
405 484
406[EXPERIMENTAL] 485[EXPERIMENTAL]
407 486
408Asynchronously create a device node (or fifo). See mknod(2). 487Asynchronously create a device node (or fifo). See mknod(2).
409 488
410The only (POSIX-) portable way of calling this function is: 489The only (POSIX-) portable way of calling this function is:
411 490
412 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ... 491 aio_mknod $path, IO::AIO::S_IFIFO | $mode, 0, sub { ...
492
413 493
414=item aio_link $srcpath, $dstpath, $callback->($status) 494=item aio_link $srcpath, $dstpath, $callback->($status)
415 495
416Asynchronously create a new link to the existing object at C<$srcpath> at 496Asynchronously create a new link to the existing object at C<$srcpath> at
417the path C<$dstpath> and call the callback with the result code. 497the path C<$dstpath> and call the callback with the result code.
418 498
499
419=item aio_symlink $srcpath, $dstpath, $callback->($status) 500=item aio_symlink $srcpath, $dstpath, $callback->($status)
420 501
421Asynchronously create a new symbolic link to the existing object at C<$srcpath> at 502Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
422the path C<$dstpath> and call the callback with the result code. 503the path C<$dstpath> and call the callback with the result code.
504
423 505
424=item aio_readlink $path, $callback->($link) 506=item aio_readlink $path, $callback->($link)
425 507
426Asynchronously read the symlink specified by C<$path> and pass it to 508Asynchronously read the symlink specified by C<$path> and pass it to
427the callback. If an error occurs, nothing or undef gets passed to the 509the callback. If an error occurs, nothing or undef gets passed to the
428callback. 510callback.
429 511
512
430=item aio_rename $srcpath, $dstpath, $callback->($status) 513=item aio_rename $srcpath, $dstpath, $callback->($status)
431 514
432Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as 515Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
433rename(2) and call the callback with the result code. 516rename(2) and call the callback with the result code.
434 517
518
519=item aio_mkdir $pathname, $mode, $callback->($status)
520
521Asynchronously mkdir (create) a directory and call the callback with
522the result code. C<$mode> will be modified by the umask at the time the
523request is executed, so do not change your umask.
524
525
435=item aio_rmdir $pathname, $callback->($status) 526=item aio_rmdir $pathname, $callback->($status)
436 527
437Asynchronously rmdir (delete) a directory and call the callback with the 528Asynchronously rmdir (delete) a directory and call the callback with the
438result code. 529result code.
530
439 531
440=item aio_readdir $pathname, $callback->($entries) 532=item aio_readdir $pathname, $callback->($entries)
441 533
442Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 534Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
443directory (i.e. opendir + readdir + closedir). The entries will not be 535directory (i.e. opendir + readdir + closedir). The entries will not be
444sorted, and will B<NOT> include the C<.> and C<..> entries. 536sorted, and will B<NOT> include the C<.> and C<..> entries.
445 537
446The callback a single argument which is either C<undef> or an array-ref 538The callback a single argument which is either C<undef> or an array-ref
447with the filenames. 539with the filenames.
448 540
541
542=item aio_load $path, $data, $callback->($status)
543
544This is a composite request that tries to fully load the given file into
545memory. Status is the same as with aio_read.
546
547=cut
548
549sub aio_load($$;$) {
550 my ($path, undef, $cb) = @_;
551 my $data = \$_[1];
552
553 my $pri = aioreq_pri;
554 my $grp = aio_group $cb;
555
556 aioreq_pri $pri;
557 add $grp aio_open $path, O_RDONLY, 0, sub {
558 my $fh = shift
559 or return $grp->result (-1);
560
561 aioreq_pri $pri;
562 add $grp aio_read $fh, 0, (-s $fh), $$data, 0, sub {
563 $grp->result ($_[0]);
564 };
565 };
566
567 $grp
568}
569
449=item aio_copy $srcpath, $dstpath, $callback->($status) 570=item aio_copy $srcpath, $dstpath, $callback->($status)
450 571
451Try to copy the I<file> (directories not supported as either source or 572Try to copy the I<file> (directories not supported as either source or
452destination) from C<$srcpath> to C<$dstpath> and call the callback with 573destination) from C<$srcpath> to C<$dstpath> and call the callback with
453the C<0> (error) or C<-1> ok. 574the C<0> (error) or C<-1> ok.
454 575
455This is a composite request that it creates the destination file with 576This is a composite request that creates the destination file with
456mode 0200 and copies the contents of the source file into it using 577mode 0200 and copies the contents of the source file into it using
457C<aio_sendfile>, followed by restoring atime, mtime, access mode and 578C<aio_sendfile>, followed by restoring atime, mtime, access mode and
458uid/gid, in that order. 579uid/gid, in that order.
459 580
460If an error occurs, the partial destination file will be unlinked, if 581If an error occurs, the partial destination file will be unlinked, if
470 my $grp = aio_group $cb; 591 my $grp = aio_group $cb;
471 592
472 aioreq_pri $pri; 593 aioreq_pri $pri;
473 add $grp aio_open $src, O_RDONLY, 0, sub { 594 add $grp aio_open $src, O_RDONLY, 0, sub {
474 if (my $src_fh = $_[0]) { 595 if (my $src_fh = $_[0]) {
475 my @stat = stat $src_fh; 596 my @stat = stat $src_fh; # hmm, might bock over nfs?
476 597
477 aioreq_pri $pri; 598 aioreq_pri $pri;
478 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 599 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
479 if (my $dst_fh = $_[0]) { 600 if (my $dst_fh = $_[0]) {
480 aioreq_pri $pri; 601 aioreq_pri $pri;
481 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 602 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
482 if ($_[0] == $stat[7]) { 603 if ($_[0] == $stat[7]) {
483 $grp->result (0); 604 $grp->result (0);
484 close $src_fh; 605 close $src_fh;
485 606
486 # those should not normally block. should. should. 607 my $ch = sub {
608 aioreq_pri $pri;
609 add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
610 aioreq_pri $pri;
611 add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
612 aioreq_pri $pri;
613 add $grp aio_close $dst_fh;
614 }
615 };
616 };
617
618 aioreq_pri $pri;
619 add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
620 if ($_[0] < 0 && $! == ENOSYS) {
621 aioreq_pri $pri;
487 utime $stat[8], $stat[9], $dst; 622 add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
488 chmod $stat[2] & 07777, $dst_fh; 623 } else {
489 chown $stat[4], $stat[5], $dst_fh; 624 $ch->();
625 }
490 close $dst_fh; 626 };
491 } else { 627 } else {
492 $grp->result (-1); 628 $grp->result (-1);
493 close $src_fh; 629 close $src_fh;
494 close $dst_fh; 630 close $dst_fh;
495 631
514 650
515Try to move the I<file> (directories not supported as either source or 651Try to move the I<file> (directories not supported as either source or
516destination) from C<$srcpath> to C<$dstpath> and call the callback with 652destination) from C<$srcpath> to C<$dstpath> and call the callback with
517the C<0> (error) or C<-1> ok. 653the C<0> (error) or C<-1> ok.
518 654
519This is a composite request that tries to rename(2) the file first. If 655This is a composite request that tries to rename(2) the file first; if
520rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if 656rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
521that is successful, unlinking the C<$srcpath>. 657that is successful, unlinks the C<$srcpath>.
522 658
523=cut 659=cut
524 660
525sub aio_move($$;$) { 661sub aio_move($$;$) {
526 my ($src, $dst, $cb) = @_; 662 my ($src, $dst, $cb) = @_;
600as those tend to return 0 or 1 as link counts, which disables the 736as those tend to return 0 or 1 as link counts, which disables the
601directory counting heuristic. 737directory counting heuristic.
602 738
603=cut 739=cut
604 740
605sub aio_scandir($$$) { 741sub aio_scandir($$;$) {
606 my ($path, $maxreq, $cb) = @_; 742 my ($path, $maxreq, $cb) = @_;
607 743
608 my $pri = aioreq_pri; 744 my $pri = aioreq_pri;
609 745
610 my $grp = aio_group $cb; 746 my $grp = aio_group $cb;
686 }; 822 };
687 823
688 $grp 824 $grp
689} 825}
690 826
827=item aio_rmtree $path, $callback->($status)
828
829Delete a directory tree starting (and including) C<$path>, return the
830status of the final C<rmdir> only. This is a composite request that
831uses C<aio_scandir> to recurse into and rmdir directories, and unlink
832everything else.
833
834=cut
835
836sub aio_rmtree;
837sub aio_rmtree($;$) {
838 my ($path, $cb) = @_;
839
840 my $pri = aioreq_pri;
841 my $grp = aio_group $cb;
842
843 aioreq_pri $pri;
844 add $grp aio_scandir $path, 0, sub {
845 my ($dirs, $nondirs) = @_;
846
847 my $dirgrp = aio_group sub {
848 add $grp aio_rmdir $path, sub {
849 $grp->result ($_[0]);
850 };
851 };
852
853 (aioreq_pri $pri), add $dirgrp aio_rmtree "$path/$_" for @$dirs;
854 (aioreq_pri $pri), add $dirgrp aio_unlink "$path/$_" for @$nondirs;
855
856 add $grp $dirgrp;
857 };
858
859 $grp
860}
861
862=item aio_sync $callback->($status)
863
864Asynchronously call sync and call the callback when finished.
865
691=item aio_fsync $fh, $callback->($status) 866=item aio_fsync $fh, $callback->($status)
692 867
693Asynchronously call fsync on the given filehandle and call the callback 868Asynchronously call fsync on the given filehandle and call the callback
694with the fsync result code. 869with the fsync result code.
695 870
698Asynchronously call fdatasync on the given filehandle and call the 873Asynchronously call fdatasync on the given filehandle and call the
699callback with the fdatasync result code. 874callback with the fdatasync result code.
700 875
701If this call isn't available because your OS lacks it or it couldn't be 876If this call isn't available because your OS lacks it or it couldn't be
702detected, it will be emulated by calling C<fsync> instead. 877detected, it will be emulated by calling C<fsync> instead.
878
879=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
880
881Sync the data portion of the file specified by C<$offset> and C<$length>
882to disk (but NOT the metadata), by calling the Linux-specific
883sync_file_range call. If sync_file_range is not available or it returns
884ENOSYS, then fdatasync or fsync is being substituted.
885
886C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
887C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
888C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
889manpage for details.
890
891=item aio_pathsync $path, $callback->($status)
892
893This request tries to open, fsync and close the given path. This is a
894composite request intended to sync directories after directory operations
895(E.g. rename). This might not work on all operating systems or have any
896specific effect, but usually it makes sure that directory changes get
897written to disc. It works for anything that can be opened for read-only,
898not just directories.
899
900Passes C<0> when everything went ok, and C<-1> on error.
901
902=cut
903
904sub aio_pathsync($;$) {
905 my ($path, $cb) = @_;
906
907 my $pri = aioreq_pri;
908 my $grp = aio_group $cb;
909
910 aioreq_pri $pri;
911 add $grp aio_open $path, O_RDONLY, 0, sub {
912 my ($fh) = @_;
913 if ($fh) {
914 aioreq_pri $pri;
915 add $grp aio_fsync $fh, sub {
916 $grp->result ($_[0]);
917
918 aioreq_pri $pri;
919 add $grp aio_close $fh;
920 };
921 } else {
922 $grp->result (-1);
923 }
924 };
925
926 $grp
927}
703 928
704=item aio_group $callback->(...) 929=item aio_group $callback->(...)
705 930
706This is a very special aio request: Instead of doing something, it is a 931This is a very special aio request: Instead of doing something, it is a
707container for other aio requests, which is useful if you want to bundle 932container for other aio requests, which is useful if you want to bundle
819Their lifetime, simplified, looks like this: when they are empty, they 1044Their lifetime, simplified, looks like this: when they are empty, they
820will finish very quickly. If they contain only requests that are in the 1045will finish very quickly. If they contain only requests that are in the
821C<done> state, they will also finish. Otherwise they will continue to 1046C<done> state, they will also finish. Otherwise they will continue to
822exist. 1047exist.
823 1048
824That means after creating a group you have some time to add requests. And 1049That means after creating a group you have some time to add requests
825in the callbacks of those requests, you can add further requests to the 1050(precisely before the callback has been invoked, which is only done within
826group. And only when all those requests have finished will the the group 1051the C<poll_cb>). And in the callbacks of those requests, you can add
827itself finish. 1052further requests to the group. And only when all those requests have
1053finished will the the group itself finish.
828 1054
829=over 4 1055=over 4
830 1056
831=item add $grp ... 1057=item add $grp ...
832 1058
844itself. Useful when you queued a lot of events but got a result early. 1070itself. Useful when you queued a lot of events but got a result early.
845 1071
846=item $grp->result (...) 1072=item $grp->result (...)
847 1073
848Set the result value(s) that will be passed to the group callback when all 1074Set the result value(s) that will be passed to the group callback when all
849subrequests have finished and set thre groups errno to the current value 1075subrequests have finished and set the groups errno to the current value
850of errno (just like calling C<errno> without an error number). By default, 1076of errno (just like calling C<errno> without an error number). By default,
851no argument will be passed and errno is zero. 1077no argument will be passed and errno is zero.
852 1078
853=item $grp->errno ([$errno]) 1079=item $grp->errno ([$errno])
854 1080
865=item feed $grp $callback->($grp) 1091=item feed $grp $callback->($grp)
866 1092
867Sets a feeder/generator on this group: every group can have an attached 1093Sets a feeder/generator on this group: every group can have an attached
868generator that generates requests if idle. The idea behind this is that, 1094generator that generates requests if idle. The idea behind this is that,
869although you could just queue as many requests as you want in a group, 1095although you could just queue as many requests as you want in a group,
870this might starve other requests for a potentially long time. For 1096this might starve other requests for a potentially long time. For example,
871example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1097C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
872requests, delaying any later requests for a long time. 1098delaying any later requests for a long time.
873 1099
874To avoid this, and allow incremental generation of requests, you can 1100To avoid this, and allow incremental generation of requests, you can
875instead a group and set a feeder on it that generates those requests. The 1101instead a group and set a feeder on it that generates those requests. The
876feed callback will be called whenever there are few enough (see C<limit>, 1102feed callback will be called whenever there are few enough (see C<limit>,
877below) requests active in the group itself and is expected to queue more 1103below) requests active in the group itself and is expected to queue more
881not impose any limits). 1107not impose any limits).
882 1108
883If the feed does not queue more requests when called, it will be 1109If the feed does not queue more requests when called, it will be
884automatically removed from the group. 1110automatically removed from the group.
885 1111
886If the feed limit is C<0>, it will be set to C<2> automatically. 1112If the feed limit is C<0> when this method is called, it will be set to
1113C<2> automatically.
887 1114
888Example: 1115Example:
889 1116
890 # stat all files in @files, but only ever use four aio requests concurrently: 1117 # stat all files in @files, but only ever use four aio requests concurrently:
891 1118
903Sets the feeder limit for the group: The feeder will be called whenever 1130Sets the feeder limit for the group: The feeder will be called whenever
904the group contains less than this many requests. 1131the group contains less than this many requests.
905 1132
906Setting the limit to C<0> will pause the feeding process. 1133Setting the limit to C<0> will pause the feeding process.
907 1134
1135The default value for the limit is C<0>, but note that setting a feeder
1136automatically bumps it up to C<2>.
1137
908=back 1138=back
909 1139
910=head2 SUPPORT FUNCTIONS 1140=head2 SUPPORT FUNCTIONS
911 1141
912=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1142=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
923See C<poll_cb> for an example. 1153See C<poll_cb> for an example.
924 1154
925=item IO::AIO::poll_cb 1155=item IO::AIO::poll_cb
926 1156
927Process some outstanding events on the result pipe. You have to call this 1157Process some outstanding events on the result pipe. You have to call this
928regularly. Returns the number of events processed. Returns immediately 1158regularly. Returns C<0> if all events could be processed, or C<-1> if it
1159returned earlier for whatever reason. Returns immediately when no events
929when no events are outstanding. The amount of events processed depends on 1160are outstanding. The amount of events processed depends on the settings of
930the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. 1161C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
931 1162
932If not all requests were processed for whatever reason, the filehandle 1163If not all requests were processed for whatever reason, the filehandle
933will still be ready when C<poll_cb> returns. 1164will still be ready when C<poll_cb> returns, so normally you don't have to
1165do anything special to have it called later.
934 1166
935Example: Install an Event watcher that automatically calls 1167Example: Install an Event watcher that automatically calls
936IO::AIO::poll_cb with high priority: 1168IO::AIO::poll_cb with high priority:
937 1169
938 Event->io (fd => IO::AIO::poll_fileno, 1170 Event->io (fd => IO::AIO::poll_fileno,
997Strictly equivalent to: 1229Strictly equivalent to:
998 1230
999 IO::AIO::poll_wait, IO::AIO::poll_cb 1231 IO::AIO::poll_wait, IO::AIO::poll_cb
1000 while IO::AIO::nreqs; 1232 while IO::AIO::nreqs;
1001 1233
1234=back
1235
1002=head3 CONTROLLING THE NUMBER OF THREADS 1236=head3 CONTROLLING THE NUMBER OF THREADS
1237
1238=over
1003 1239
1004=item IO::AIO::min_parallel $nthreads 1240=item IO::AIO::min_parallel $nthreads
1005 1241
1006Set the minimum number of AIO threads to C<$nthreads>. The current 1242Set the minimum number of AIO threads to C<$nthreads>. The current
1007default is C<8>, which means eight asynchronous operations can execute 1243default is C<8>, which means eight asynchronous operations can execute
1048 1284
1049The default is probably ok in most situations, especially if thread 1285The default is probably ok in most situations, especially if thread
1050creation is fast. If thread creation is very slow on your system you might 1286creation is fast. If thread creation is very slow on your system you might
1051want to use larger values. 1287want to use larger values.
1052 1288
1053=item $oldmaxreqs = IO::AIO::max_outstanding $maxreqs 1289=item IO::AIO::max_outstanding $maxreqs
1054 1290
1055This is a very bad function to use in interactive programs because it 1291This is a very bad function to use in interactive programs because it
1056blocks, and a bad way to reduce concurrency because it is inexact: Better 1292blocks, and a bad way to reduce concurrency because it is inexact: Better
1057use an C<aio_group> together with a feed callback. 1293use an C<aio_group> together with a feed callback.
1058 1294
1059Sets the maximum number of outstanding requests to C<$nreqs>. If you 1295Sets the maximum number of outstanding requests to C<$nreqs>. If you
1060to queue up more than this number of requests, the next call to the 1296do queue up more than this number of requests, the next call to the
1061C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>) 1297C<poll_cb> (and C<poll_some> and other functions calling C<poll_cb>)
1062function will block until the limit is no longer exceeded. 1298function will block until the limit is no longer exceeded.
1063 1299
1064The default value is very large, so there is no practical limit on the 1300The default value is very large, so there is no practical limit on the
1065number of outstanding requests. 1301number of outstanding requests.
1066 1302
1067You can still queue as many requests as you want. Therefore, 1303You can still queue as many requests as you want. Therefore,
1068C<max_oustsanding> is mainly useful in simple scripts (with low values) or 1304C<max_outstanding> is mainly useful in simple scripts (with low values) or
1069as a stop gap to shield against fatal memory overflow (with large values). 1305as a stop gap to shield against fatal memory overflow (with large values).
1070 1306
1307=back
1308
1071=head3 STATISTICAL INFORMATION 1309=head3 STATISTICAL INFORMATION
1310
1311=over
1072 1312
1073=item IO::AIO::nreqs 1313=item IO::AIO::nreqs
1074 1314
1075Returns the number of requests currently in the ready, execute or pending 1315Returns the number of requests currently in the ready, execute or pending
1076states (i.e. for which their callback has not been invoked yet). 1316states (i.e. for which their callback has not been invoked yet).
1092 1332
1093=back 1333=back
1094 1334
1095=cut 1335=cut
1096 1336
1097# support function to convert a fd into a perl filehandle
1098sub _fd2fh {
1099 return undef if $_[0] < 0;
1100
1101 # try to generate nice filehandles
1102 my $sym = "IO::AIO::fd#$_[0]";
1103 local *$sym;
1104
1105 open *$sym, "+<&=$_[0]" # usually works under any unix
1106 or open *$sym, "<&=$_[0]" # cygwin needs this
1107 or open *$sym, ">&=$_[0]" # or this
1108 or return undef;
1109
1110 *$sym
1111}
1112
1113min_parallel 8; 1337min_parallel 8;
1114 1338
1115END { 1339END { flush }
1116 min_parallel 1;
1117 flush;
1118};
1119 1340
11201; 13411;
1121 1342
1122=head2 FORK BEHAVIOUR 1343=head2 FORK BEHAVIOUR
1123 1344
1143bytes of memory. In addition, stat requests need a stat buffer (possibly 1364bytes of memory. In addition, stat requests need a stat buffer (possibly
1144a few hundred bytes), readdir requires a result buffer and so on. Perl 1365a few hundred bytes), readdir requires a result buffer and so on. Perl
1145scalars and other data passed into aio requests will also be locked and 1366scalars and other data passed into aio requests will also be locked and
1146will consume memory till the request has entered the done state. 1367will consume memory till the request has entered the done state.
1147 1368
1148This is now awfully much, so queuing lots of requests is not usually a 1369This is not awfully much, so queuing lots of requests is not usually a
1149problem. 1370problem.
1150 1371
1151Per-thread usage: 1372Per-thread usage:
1152 1373
1153In the execution phase, some aio requests require more memory for 1374In the execution phase, some aio requests require more memory for
1158 1379
1159Known bugs will be fixed in the next release. 1380Known bugs will be fixed in the next release.
1160 1381
1161=head1 SEE ALSO 1382=head1 SEE ALSO
1162 1383
1163L<Coro::AIO>. 1384L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1385more natural syntax.
1164 1386
1165=head1 AUTHOR 1387=head1 AUTHOR
1166 1388
1167 Marc Lehmann <schmorp@schmorp.de> 1389 Marc Lehmann <schmorp@schmorp.de>
1168 http://home.schmorp.de/ 1390 http://home.schmorp.de/

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines