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.124 by root, Sat May 10 19:25:33 2008 UTC vs.
Revision 1.181 by root, Tue May 4 21:14:01 2010 UTC

… …
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7 use IO::AIO; 7 use IO::AIO;
8 8
9 aio_open "/etc/passwd", O_RDONLY, 0, sub { 9 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
10 my $fh = shift 10 my $fh = shift
11 or die "/etc/passwd: $!"; 11 or die "/etc/passwd: $!";
12 ... 12 ...
13 }; 13 };
14 14
… …
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, urxvt, pureperl...)
32 open my $fh, "<&=" . IO::AIO::poll_fileno or die "$!";
33 my $w = AnyEvent->io (fh => $fh, poll => 'r', cb => sub { IO::AIO::poll_cb });
34
35 # EV integration
36 my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
37
38 # Event integration
39 Event->io (fd => IO::AIO::poll_fileno,
40 poll => 'r',
41 cb => \&IO::AIO::poll_cb);
42
43 # Glib/Gtk2 integration
44 add_watch Glib::IO IO::AIO::poll_fileno,
45 in => sub { IO::AIO::poll_cb; 1 };
46
47 # Tk integration
48 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
49 readable => \&IO::AIO::poll_cb);
50
51 # Danga::Socket integration
52 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
53 \&IO::AIO::poll_cb);
54
55=head1 DESCRIPTION 31=head1 DESCRIPTION
56 32
57This module implements asynchronous I/O using whatever means your 33This module implements asynchronous I/O using whatever means your
58operating system supports. 34operating system supports. It is implemented as an interface to C<libeio>
35(L<http://software.schmorp.de/pkg/libeio.html>).
59 36
60Asynchronous means that operations that can normally block your program 37Asynchronous means that operations that can normally block your program
61(e.g. reading from disk) will be done asynchronously: the operation 38(e.g. reading from disk) will be done asynchronously: the operation
62will still block, but you can do something else in the meantime. This 39will still block, but you can do something else in the meantime. This
63is extremely useful for programs that need to stay interactive even 40is extremely useful for programs that need to stay interactive even
… …
67on a RAID volume or over NFS when you do a number of stat operations 44on a RAID volume or over NFS when you do a number of stat operations
68concurrently. 45concurrently.
69 46
70While most of this works on all types of file descriptors (for 47While most of this works on all types of file descriptors (for
71example sockets), using these functions on file descriptors that 48example sockets), using these functions on file descriptors that
72support nonblocking operation (again, sockets, pipes etc.) is very 49support nonblocking operation (again, sockets, pipes etc.) is
73inefficient. Use an event loop for that (such as the L<Event|Event> 50very inefficient. Use an event loop for that (such as the L<EV>
74module): IO::AIO will naturally fit into such an event loop itself. 51module): IO::AIO will naturally fit into such an event loop itself.
75 52
76In this version, a number of threads are started that execute your 53In this version, a number of threads are started that execute your
77requests and signal their completion. You don't need thread support 54requests and signal their completion. You don't need thread support
78in perl, and the threads created by this module will not be visible 55in perl, and the threads created by this module will not be visible
… …
88yourself, always call C<poll_cb> from within the same thread, or never 65yourself, always call C<poll_cb> from within the same thread, or never
89call C<poll_cb> (or other C<aio_> functions) recursively. 66call C<poll_cb> (or other C<aio_> functions) recursively.
90 67
91=head2 EXAMPLE 68=head2 EXAMPLE
92 69
93This is a simple example that uses the Event module and loads 70This is a simple example that uses the EV module and loads
94F</etc/passwd> asynchronously: 71F</etc/passwd> asynchronously:
95 72
96 use Fcntl; 73 use Fcntl;
97 use Event; 74 use EV;
98 use IO::AIO; 75 use IO::AIO;
99 76
100 # register the IO::AIO callback with Event 77 # register the IO::AIO callback with EV
101 Event->io (fd => IO::AIO::poll_fileno, 78 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
102 poll => 'r',
103 cb => \&IO::AIO::poll_cb);
104 79
105 # queue the request to open /etc/passwd 80 # queue the request to open /etc/passwd
106 aio_open "/etc/passwd", O_RDONLY, 0, sub { 81 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
107 my $fh = shift 82 my $fh = shift
108 or die "error while opening: $!"; 83 or die "error while opening: $!";
109 84
110 # stat'ing filehandles is generally non-blocking 85 # stat'ing filehandles is generally non-blocking
111 my $size = -s $fh; 86 my $size = -s $fh;
… …
120 95
121 # file contents now in $contents 96 # file contents now in $contents
122 print $contents; 97 print $contents;
123 98
124 # exit event loop and program 99 # exit event loop and program
125 Event::unloop; 100 EV::unloop;
126 }; 101 };
127 }; 102 };
128 103
129 # possibly queue up other requests, or open GUI windows, 104 # possibly queue up other requests, or open GUI windows,
130 # check for sockets etc. etc. 105 # check for sockets etc. etc.
131 106
132 # process events as long as there are some: 107 # process events as long as there are some:
133 Event::loop; 108 EV::loop;
134 109
135=head1 REQUEST ANATOMY AND LIFETIME 110=head1 REQUEST ANATOMY AND LIFETIME
136 111
137Every C<aio_*> function creates a request. which is a C data structure not 112Every C<aio_*> function creates a request. which is a C data structure not
138directly visible to Perl. 113directly visible to Perl.
… …
188 163
189package IO::AIO; 164package IO::AIO;
190 165
191use Carp (); 166use Carp ();
192 167
193no warnings; 168use common::sense;
194use strict 'vars';
195 169
196use base 'Exporter'; 170use base 'Exporter';
197 171
198BEGIN { 172BEGIN {
199 our $VERSION = '3.0'; 173 our $VERSION = '3.65';
200 174
201 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close 175 our @AIO_REQ = qw(aio_sendfile aio_read aio_write aio_open aio_close
202 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir 176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
203 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync 177 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
204 aio_fdatasync aio_pathsync aio_readahead 178 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
205 aio_rename aio_link aio_move aio_copy aio_group 179 aio_rename aio_link aio_move aio_copy aio_group
206 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown 180 aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
207 aio_chmod aio_utime aio_truncate); 181 aio_chmod aio_utime aio_truncate
182 aio_msync aio_mtouch aio_statvfs);
208 183
209 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 184 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
210 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 185 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
211 min_parallel max_parallel max_idle 186 min_parallel max_parallel max_idle
212 nreqs nready npending nthreads 187 nreqs nready npending nthreads
213 max_poll_time max_poll_reqs); 188 max_poll_time max_poll_reqs
189 sendfile fadvise);
190
191 push @AIO_REQ, qw(aio_busy); # not exported
214 192
215 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 193 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
216 194
217 require XSLoader; 195 require XSLoader;
218 XSLoader::load ("IO::AIO", $VERSION); 196 XSLoader::load ("IO::AIO", $VERSION);
219} 197}
220 198
221=head1 FUNCTIONS 199=head1 FUNCTIONS
200
201=head2 QUICK OVERVIEW
202
203This section simply lists the prototypes of the most important functions
204for quick reference. See the following sections for function-by-function
205documentation.
206
207 aio_open $pathname, $flags, $mode, $callback->($fh)
208 aio_close $fh, $callback->($status)
209 aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
210 aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
211 aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
212 aio_readahead $fh,$offset,$length, $callback->($retval)
213 aio_stat $fh_or_path, $callback->($status)
214 aio_lstat $fh, $callback->($status)
215 aio_statvfs $fh_or_path, $callback->($statvfs)
216 aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
217 aio_chown $fh_or_path, $uid, $gid, $callback->($status)
218 aio_truncate $fh_or_path, $offset, $callback->($status)
219 aio_chmod $fh_or_path, $mode, $callback->($status)
220 aio_unlink $pathname, $callback->($status)
221 aio_mknod $path, $mode, $dev, $callback->($status)
222 aio_link $srcpath, $dstpath, $callback->($status)
223 aio_symlink $srcpath, $dstpath, $callback->($status)
224 aio_readlink $path, $callback->($link)
225 aio_rename $srcpath, $dstpath, $callback->($status)
226 aio_mkdir $pathname, $mode, $callback->($status)
227 aio_rmdir $pathname, $callback->($status)
228 aio_readdir $pathname, $callback->($entries)
229 aio_readdirx $pathname, $flags, $callback->($entries, $flags)
230 IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
231 IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
232 aio_load $path, $data, $callback->($status)
233 aio_copy $srcpath, $dstpath, $callback->($status)
234 aio_move $srcpath, $dstpath, $callback->($status)
235 aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
236 aio_rmtree $path, $callback->($status)
237 aio_sync $callback->($status)
238 aio_fsync $fh, $callback->($status)
239 aio_fdatasync $fh, $callback->($status)
240 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
241 aio_pathsync $path, $callback->($status)
242 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
243 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
244 aio_group $callback->(...)
245 aio_nop $callback->()
246
247 $prev_pri = aioreq_pri [$pri]
248 aioreq_nice $pri_adjust
249
250 IO::AIO::poll_wait
251 IO::AIO::poll_cb
252 IO::AIO::poll
253 IO::AIO::flush
254 IO::AIO::max_poll_reqs $nreqs
255 IO::AIO::max_poll_time $seconds
256 IO::AIO::min_parallel $nthreads
257 IO::AIO::max_parallel $nthreads
258 IO::AIO::max_idle $nthreads
259 IO::AIO::max_outstanding $maxreqs
260 IO::AIO::nreqs
261 IO::AIO::nready
262 IO::AIO::npending
263
264 IO::AIO::sendfile $ofh, $ifh, $offset, $count
265 IO::AIO::fadvise $fh, $offset, $len, $advice
266 IO::AIO::mlockall $flags
267 IO::AIO::munlockall
222 268
223=head2 AIO REQUEST FUNCTIONS 269=head2 AIO REQUEST FUNCTIONS
224 270
225All the C<aio_*> calls are more or less thin wrappers around the syscall 271All the C<aio_*> calls are more or less thin wrappers around the syscall
226with the same name (sans C<aio_>). The arguments are similar or identical, 272with the same name (sans C<aio_>). The arguments are similar or identical,
227and they all accept an additional (and optional) C<$callback> argument 273and they all accept an additional (and optional) C<$callback> argument
228which must be a code reference. This code reference will get called with 274which must be a code reference. This code reference will get called with
229the syscall return code (e.g. most syscalls return C<-1> on error, unlike 275the syscall return code (e.g. most syscalls return C<-1> on error, unlike
230perl, which usually delivers "false") as it's sole argument when the given 276perl, which usually delivers "false") as its sole argument after the given
231syscall has been executed asynchronously. 277syscall has been executed asynchronously.
232 278
233All functions expecting a filehandle keep a copy of the filehandle 279All functions expecting a filehandle keep a copy of the filehandle
234internally until the request has finished. 280internally until the request has finished.
235 281
… …
249your pathnames to the locale (or other) encoding in effect in the user 295your pathnames to the locale (or other) encoding in effect in the user
250environment, d) use Glib::filename_from_unicode on unicode filenames or e) 296environment, d) use Glib::filename_from_unicode on unicode filenames or e)
251use something else to ensure your scalar has the correct contents. 297use something else to ensure your scalar has the correct contents.
252 298
253This works, btw. independent of the internal UTF-8 bit, which IO::AIO 299This works, btw. independent of the internal UTF-8 bit, which IO::AIO
254handles correctly wether it is set or not. 300handles correctly whether it is set or not.
255 301
256=over 4 302=over 4
257 303
258=item $prev_pri = aioreq_pri [$pri] 304=item $prev_pri = aioreq_pri [$pri]
259 305
… …
306by the umask in effect then the request is being executed, so better never 352by the umask in effect then the request is being executed, so better never
307change the umask. 353change the umask.
308 354
309Example: 355Example:
310 356
311 aio_open "/etc/passwd", O_RDONLY, 0, sub { 357 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
312 if ($_[0]) { 358 if ($_[0]) {
313 print "open successful, fh is $_[0]\n"; 359 print "open successful, fh is $_[0]\n";
314 ... 360 ...
315 } else { 361 } else {
316 die "open failed: $!\n"; 362 die "open failed: $!\n";
… …
337 383
338=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 384=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
339 385
340=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval) 386=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
341 387
342Reads or writes C<$length> bytes from the specified C<$fh> and C<$offset> 388Reads or writes C<$length> bytes from or to the specified C<$fh> and
343into the scalar given by C<$data> and offset C<$dataoffset> and calls the 389C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
344callback without the actual number of bytes read (or -1 on error, just 390and calls the callback without the actual number of bytes read (or -1 on
345like the syscall). 391error, just like the syscall).
392
393C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
394offset plus the actual number of bytes read.
346 395
347If C<$offset> is undefined, then the current file descriptor offset will 396If C<$offset> is undefined, then the current file descriptor offset will
348be used (and updated), otherwise the file descriptor offset will not be 397be used (and updated), otherwise the file descriptor offset will not be
349changed by these calls. 398changed by these calls.
350 399
351If C<$length> is undefined in C<aio_write>, use the remaining length of C<$data>. 400If C<$length> is undefined in C<aio_write>, use the remaining length of
401C<$data>.
352 402
353If C<$dataoffset> is less than zero, it will be counted from the end of 403If C<$dataoffset> is less than zero, it will be counted from the end of
354C<$data>. 404C<$data>.
355 405
356The C<$data> scalar I<MUST NOT> be modified in any way while the request 406The C<$data> scalar I<MUST NOT> be modified in any way while the request
… …
374than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each 424than one C<aio_sendfile> per C<$out_fh>, as they will interfere with each
375other. 425other.
376 426
377This call tries to make use of a native C<sendfile> syscall to provide 427This call tries to make use of a native C<sendfile> syscall to provide
378zero-copy operation. For this to work, C<$out_fh> should refer to a 428zero-copy operation. For this to work, C<$out_fh> should refer to a
379socket, and C<$in_fh> should refer to mmap'able file. 429socket, and C<$in_fh> should refer to an mmap'able file.
380 430
381If the native sendfile call fails or is not implemented, it will be 431If a native sendfile cannot be found or it fails with C<ENOSYS>,
432C<ENOTSUP>, C<EOPNOTSUPP>, C<EAFNOSUPPORT>, C<EPROTOTYPE> or C<ENOTSOCK>,
382emulated, so you can call C<aio_sendfile> on any type of filehandle 433it will be emulated, so you can call C<aio_sendfile> on any type of
383regardless of the limitations of the operating system. 434filehandle regardless of the limitations of the operating system.
384 435
385Please note, however, that C<aio_sendfile> can read more bytes from 436Please note, however, that C<aio_sendfile> can read more bytes from
386C<$in_fh> than are written, and there is no way to find out how many 437C<$in_fh> than are written, and there is no way to find out how many
387bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only 438bytes have been read from C<aio_sendfile> alone, as C<aio_sendfile> only
388provides the number of bytes written to C<$out_fh>. Only if the result 439provides the number of bytes written to C<$out_fh>. Only if the result
… …
426 $_[0] and die "stat failed: $!"; 477 $_[0] and die "stat failed: $!";
427 print "size is ", -s _, "\n"; 478 print "size is ", -s _, "\n";
428 }; 479 };
429 480
430 481
482=item aio_statvfs $fh_or_path, $callback->($statvfs)
483
484Works like the POSIX C<statvfs> or C<fstatvfs> syscalls, depending on
485whether a file handle or path was passed.
486
487On success, the callback is passed a hash reference with the following
488members: C<bsize>, C<frsize>, C<blocks>, C<bfree>, C<bavail>, C<files>,
489C<ffree>, C<favail>, C<fsid>, C<flag> and C<namemax>. On failure, C<undef>
490is passed.
491
492The following POSIX IO::AIO::ST_* constants are defined: C<ST_RDONLY> and
493C<ST_NOSUID>.
494
495The following non-POSIX IO::AIO::ST_* flag masks are defined to
496their correct value when available, or to C<0> on systems that do
497not support them: C<ST_NODEV>, C<ST_NOEXEC>, C<ST_SYNCHRONOUS>,
498C<ST_MANDLOCK>, C<ST_WRITE>, C<ST_APPEND>, C<ST_IMMUTABLE>, C<ST_NOATIME>,
499C<ST_NODIRATIME> and C<ST_RELATIME>.
500
501Example: stat C</wd> and dump out the data if successful.
502
503 aio_statvfs "/wd", sub {
504 my $f = $_[0]
505 or die "statvfs: $!";
506
507 use Data::Dumper;
508 say Dumper $f;
509 };
510
511 # result:
512 {
513 bsize => 1024,
514 bfree => 4333064312,
515 blocks => 10253828096,
516 files => 2050765568,
517 flag => 4096,
518 favail => 2042092649,
519 bavail => 4333064312,
520 ffree => 2042092649,
521 namemax => 255,
522 frsize => 1024,
523 fsid => 1810
524 }
525
526
431=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status) 527=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
432 528
433Works like perl's C<utime> function (including the special case of $atime 529Works like perl's C<utime> function (including the special case of $atime
434and $mtime being undef). Fractional times are supported if the underlying 530and $mtime being undef). Fractional times are supported if the underlying
435syscalls support them. 531syscalls support them.
… …
528 624
529Unlike the POSIX call of the same name, C<aio_readdir> reads an entire 625Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
530directory (i.e. opendir + readdir + closedir). The entries will not be 626directory (i.e. opendir + readdir + closedir). The entries will not be
531sorted, and will B<NOT> include the C<.> and C<..> entries. 627sorted, and will B<NOT> include the C<.> and C<..> entries.
532 628
533The callback a single argument which is either C<undef> or an array-ref 629The callback is passed a single argument which is either C<undef> or an
534with the filenames. 630array-ref with the filenames.
631
632
633=item aio_readdirx $pathname, $flags, $callback->($entries, $flags)
634
635Quite similar to C<aio_readdir>, but the C<$flags> argument allows to tune
636behaviour and output format. In case of an error, C<$entries> will be
637C<undef>.
638
639The flags are a combination of the following constants, ORed together (the
640flags will also be passed to the callback, possibly modified):
641
642=over 4
643
644=item IO::AIO::READDIR_DENTS
645
646When this flag is off, then the callback gets an arrayref with of names
647only (as with C<aio_readdir>), otherwise it gets an arrayref with
648C<[$name, $type, $inode]> arrayrefs, each describing a single directory
649entry in more detail.
650
651C<$name> is the name of the entry.
652
653C<$type> is one of the C<IO::AIO::DT_xxx> constants:
654
655C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
656C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
657C<IO::AIO::DT_WHT>.
658
659C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to
660know, you have to run stat yourself. Also, for speed reasons, the C<$type>
661scalars are read-only: you can not modify them.
662
663C<$inode> is the inode number (which might not be exact on systems with 64
664bit inode numbers and 32 bit perls). This field has unspecified content on
665systems that do not deliver the inode information.
666
667=item IO::AIO::READDIR_DIRS_FIRST
668
669When this flag is set, then the names will be returned in an order where
670likely directories come first. This is useful when you need to quickly
671find directories, or you want to find all directories while avoiding to
672stat() each entry.
673
674If the system returns type information in readdir, then this is used
675to find directories directly. Otherwise, likely directories are files
676beginning with ".", or otherwise files with no dots, of which files with
677short names are tried first.
678
679=item IO::AIO::READDIR_STAT_ORDER
680
681When this flag is set, then the names will be returned in an order
682suitable for stat()'ing each one. That is, when you plan to stat()
683all files in the given directory, then the returned order will likely
684be fastest.
685
686If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then
687the likely dirs come first, resulting in a less optimal stat order.
688
689=item IO::AIO::READDIR_FOUND_UNKNOWN
690
691This flag should not be set when calling C<aio_readdirx>. Instead, it
692is being set by C<aio_readdirx>, when any of the C<$type>'s found were
693C<IO::AIO::DT_UNKNOWN>. The absense of this flag therefore indicates that all
694C<$type>'s are known, which can be used to speed up some algorithms.
695
696=back
535 697
536 698
537=item aio_load $path, $data, $callback->($status) 699=item aio_load $path, $data, $callback->($status)
538 700
539This is a composite request that tries to fully load the given file into 701This is a composite request that tries to fully load the given file into
… …
564 726
565=item aio_copy $srcpath, $dstpath, $callback->($status) 727=item aio_copy $srcpath, $dstpath, $callback->($status)
566 728
567Try to copy the I<file> (directories not supported as either source or 729Try to copy the I<file> (directories not supported as either source or
568destination) from C<$srcpath> to C<$dstpath> and call the callback with 730destination) from C<$srcpath> to C<$dstpath> and call the callback with
569the C<0> (error) or C<-1> ok. 731a status of C<0> (ok) or C<-1> (error, see C<$!>).
570 732
571This is a composite request that it creates the destination file with 733This is a composite request that creates the destination file with
572mode 0200 and copies the contents of the source file into it using 734mode 0200 and copies the contents of the source file into it using
573C<aio_sendfile>, followed by restoring atime, mtime, access mode and 735C<aio_sendfile>, followed by restoring atime, mtime, access mode and
574uid/gid, in that order. 736uid/gid, in that order.
575 737
576If an error occurs, the partial destination file will be unlinked, if 738If an error occurs, the partial destination file will be unlinked, if
… …
586 my $grp = aio_group $cb; 748 my $grp = aio_group $cb;
587 749
588 aioreq_pri $pri; 750 aioreq_pri $pri;
589 add $grp aio_open $src, O_RDONLY, 0, sub { 751 add $grp aio_open $src, O_RDONLY, 0, sub {
590 if (my $src_fh = $_[0]) { 752 if (my $src_fh = $_[0]) {
591 my @stat = stat $src_fh; 753 my @stat = stat $src_fh; # hmm, might block over nfs?
592 754
593 aioreq_pri $pri; 755 aioreq_pri $pri;
594 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub { 756 add $grp aio_open $dst, O_CREAT | O_WRONLY | O_TRUNC, 0200, sub {
595 if (my $dst_fh = $_[0]) { 757 if (my $dst_fh = $_[0]) {
596 aioreq_pri $pri; 758 aioreq_pri $pri;
597 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub { 759 add $grp aio_sendfile $dst_fh, $src_fh, 0, $stat[7], sub {
598 if ($_[0] == $stat[7]) { 760 if ($_[0] == $stat[7]) {
599 $grp->result (0); 761 $grp->result (0);
600 close $src_fh; 762 close $src_fh;
601 763
602 # those should not normally block. should. should. 764 my $ch = sub {
603 utime $stat[8], $stat[9], $dst; 765 aioreq_pri $pri;
604 chmod $stat[2] & 07777, $dst_fh; 766 add $grp aio_chmod $dst_fh, $stat[2] & 07777, sub {
605 chown $stat[4], $stat[5], $dst_fh; 767 aioreq_pri $pri;
768 add $grp aio_chown $dst_fh, $stat[4], $stat[5], sub {
769 aioreq_pri $pri;
770 add $grp aio_close $dst_fh;
771 }
772 };
773 };
606 774
607 aioreq_pri $pri; 775 aioreq_pri $pri;
608 add $grp aio_close $dst_fh; 776 add $grp aio_utime $dst_fh, $stat[8], $stat[9], sub {
777 if ($_[0] < 0 && $! == ENOSYS) {
778 aioreq_pri $pri;
779 add $grp aio_utime $dst, $stat[8], $stat[9], $ch;
780 } else {
781 $ch->();
782 }
783 };
609 } else { 784 } else {
610 $grp->result (-1); 785 $grp->result (-1);
611 close $src_fh; 786 close $src_fh;
612 close $dst_fh; 787 close $dst_fh;
613 788
… …
630 805
631=item aio_move $srcpath, $dstpath, $callback->($status) 806=item aio_move $srcpath, $dstpath, $callback->($status)
632 807
633Try to move the I<file> (directories not supported as either source or 808Try to move the I<file> (directories not supported as either source or
634destination) from C<$srcpath> to C<$dstpath> and call the callback with 809destination) from C<$srcpath> to C<$dstpath> and call the callback with
635the C<0> (error) or C<-1> ok. 810a status of C<0> (ok) or C<-1> (error, see C<$!>).
636 811
637This is a composite request that tries to rename(2) the file first. If 812This is a composite request that tries to rename(2) the file first; if
638rename files with C<EXDEV>, it copies the file with C<aio_copy> and, if 813rename fails with C<EXDEV>, it copies the file with C<aio_copy> and, if
639that is successful, unlinking the C<$srcpath>. 814that is successful, unlinks the C<$srcpath>.
640 815
641=cut 816=cut
642 817
643sub aio_move($$;$) { 818sub aio_move($$;$) {
644 my ($src, $dst, $cb) = @_; 819 my ($src, $dst, $cb) = @_;
… …
691 866
692Implementation notes. 867Implementation notes.
693 868
694The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can. 869The C<aio_readdir> cannot be avoided, but C<stat()>'ing every entry can.
695 870
871If readdir returns file type information, then this is used directly to
872find directories.
873
696After reading the directory, the modification time, size etc. of the 874Otherwise, after reading the directory, the modification time, size etc.
697directory before and after the readdir is checked, and if they match (and 875of the directory before and after the readdir is checked, and if they
698isn't the current time), the link count will be used to decide how many 876match (and isn't the current time), the link count will be used to decide
699entries are directories (if >= 2). Otherwise, no knowledge of the number 877how many entries are directories (if >= 2). Otherwise, no knowledge of the
700of subdirectories will be assumed. 878number of subdirectories will be assumed.
701 879
702Then entries will be sorted into likely directories (everything without 880Then entries will be sorted into likely directories a non-initial dot
703a non-initial dot currently) and likely non-directories (everything 881currently) and likely non-directories (see C<aio_readdirx>). Then every
704else). Then every entry plus an appended C</.> will be C<stat>'ed, 882entry plus an appended C</.> will be C<stat>'ed, likely directories first,
705likely directories first. If that succeeds, it assumes that the entry 883in order of their inode numbers. If that succeeds, it assumes that the
706is a directory or a symlink to directory (which will be checked 884entry is a directory or a symlink to directory (which will be checked
707seperately). This is often faster than stat'ing the entry itself because 885seperately). This is often faster than stat'ing the entry itself because
708filesystems might detect the type of the entry without reading the inode 886filesystems might detect the type of the entry without reading the inode
709data (e.g. ext2fs filetype feature). 887data (e.g. ext2fs filetype feature), even on systems that cannot return
888the filetype information on readdir.
710 889
711If the known number of directories (link count - 2) has been reached, the 890If the known number of directories (link count - 2) has been reached, the
712rest of the entries is assumed to be non-directories. 891rest of the entries is assumed to be non-directories.
713 892
714This only works with certainty on POSIX (= UNIX) filesystems, which 893This only works with certainty on POSIX (= UNIX) filesystems, which
… …
736 my $now = time; 915 my $now = time;
737 my $hash1 = join ":", (stat _)[0,1,3,7,9]; 916 my $hash1 = join ":", (stat _)[0,1,3,7,9];
738 917
739 # read the directory entries 918 # read the directory entries
740 aioreq_pri $pri; 919 aioreq_pri $pri;
741 add $grp aio_readdir $path, sub { 920 add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub {
742 my $entries = shift 921 my $entries = shift
743 or return $grp->result (); 922 or return $grp->result ();
744 923
745 # stat the dir another time 924 # stat the dir another time
746 aioreq_pri $pri; 925 aioreq_pri $pri;
… …
752 # take the slow route if anything looks fishy 931 # take the slow route if anything looks fishy
753 if ($hash1 ne $hash2 or (stat _)[9] == $now) { 932 if ($hash1 ne $hash2 or (stat _)[9] == $now) {
754 $ndirs = -1; 933 $ndirs = -1;
755 } else { 934 } else {
756 # if nlink == 2, we are finished 935 # if nlink == 2, we are finished
757 # on non-posix-fs's, we rely on nlink < 2 936 # for non-posix-fs's, we rely on nlink < 2
758 $ndirs = (stat _)[3] - 2 937 $ndirs = (stat _)[3] - 2
759 or return $grp->result ([], $entries); 938 or return $grp->result ([], $entries);
760 } 939 }
761 940
762 # sort into likely dirs and likely nondirs
763 # dirs == files without ".", short entries first
764 $entries = [map $_->[0],
765 sort { $b->[1] cmp $a->[1] }
766 map [$_, sprintf "%s%04d", (/.\./ ? "1" : "0"), length],
767 @$entries];
768
769 my (@dirs, @nondirs); 941 my (@dirs, @nondirs);
770 942
771 my $statgrp = add $grp aio_group sub { 943 my $statgrp = add $grp aio_group sub {
772 $grp->result (\@dirs, \@nondirs); 944 $grp->result (\@dirs, \@nondirs);
773 }; 945 };
774 946
775 limit $statgrp $maxreq; 947 limit $statgrp $maxreq;
776 feed $statgrp sub { 948 feed $statgrp sub {
777 return unless @$entries; 949 return unless @$entries;
778 my $entry = pop @$entries; 950 my $entry = shift @$entries;
779 951
780 aioreq_pri $pri; 952 aioreq_pri $pri;
781 add $statgrp aio_stat "$path/$entry/.", sub { 953 add $statgrp aio_stat "$path/$entry/.", sub {
782 if ($_[0] < 0) { 954 if ($_[0] < 0) {
783 push @nondirs, $entry; 955 push @nondirs, $entry;
… …
856callback with the fdatasync result code. 1028callback with the fdatasync result code.
857 1029
858If this call isn't available because your OS lacks it or it couldn't be 1030If this call isn't available because your OS lacks it or it couldn't be
859detected, it will be emulated by calling C<fsync> instead. 1031detected, it will be emulated by calling C<fsync> instead.
860 1032
1033=item aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
1034
1035Sync the data portion of the file specified by C<$offset> and C<$length>
1036to disk (but NOT the metadata), by calling the Linux-specific
1037sync_file_range call. If sync_file_range is not available or it returns
1038ENOSYS, then fdatasync or fsync is being substituted.
1039
1040C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
1041C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
1042C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
1043manpage for details.
1044
861=item aio_pathsync $path, $callback->($status) 1045=item aio_pathsync $path, $callback->($status)
862 1046
863This request tries to open, fsync and close the given path. This is a 1047This request tries to open, fsync and close the given path. This is a
864composite request intended tosync directories after directory operations 1048composite request intended to sync directories after directory operations
865(E.g. rename). This might not work on all operating systems or have any 1049(E.g. rename). This might not work on all operating systems or have any
866specific effect, but usually it makes sure that directory changes get 1050specific effect, but usually it makes sure that directory changes get
867written to disc. It works for anything that can be opened for read-only, 1051written to disc. It works for anything that can be opened for read-only,
868not just directories. 1052not just directories.
1053
1054Future versions of this function might fall back to other methods when
1055C<fsync> on the directory fails (such as calling C<sync>).
869 1056
870Passes C<0> when everything went ok, and C<-1> on error. 1057Passes C<0> when everything went ok, and C<-1> on error.
871 1058
872=cut 1059=cut
873 1060
… …
894 }; 1081 };
895 1082
896 $grp 1083 $grp
897} 1084}
898 1085
1086=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1087
1088This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1089scalars (see the C<IO::AIO::mmap> function, although it also works on data
1090scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1091scalar must only be modified in-place while an aio operation is pending on
1092it).
1093
1094It calls the C<msync> function of your OS, if available, with the memory
1095area starting at C<$offset> in the string and ending C<$length> bytes
1096later. If C<$length> is negative, counts from the end, and if C<$length>
1097is C<undef>, then it goes till the end of the string. The flags can be
1098a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and
1099C<IO::AIO::MS_SYNC>.
1100
1101=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1102
1103This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1104scalars.
1105
1106It touches (reads or writes) all memory pages in the specified
1107range inside the scalar. All caveats and parameters are the same
1108as for C<aio_msync>, above, except for flags, which must be either
1109C<0> (which reads all pages and ensures they are instantiated) or
1110C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
1111writing an octet from it, which dirties the page).
1112
899=item aio_group $callback->(...) 1113=item aio_group $callback->(...)
900 1114
901This is a very special aio request: Instead of doing something, it is a 1115This is a very special aio request: Instead of doing something, it is a
902container for other aio requests, which is useful if you want to bundle 1116container for other aio requests, which is useful if you want to bundle
903many requests into a single, composite, request with a definite callback 1117many requests into a single, composite, request with a definite callback
… …
952=item cancel $req 1166=item cancel $req
953 1167
954Cancels the request, if possible. Has the effect of skipping execution 1168Cancels the request, if possible. Has the effect of skipping execution
955when entering the B<execute> state and skipping calling the callback when 1169when entering the B<execute> state and skipping calling the callback when
956entering the the B<result> state, but will leave the request otherwise 1170entering the the B<result> state, but will leave the request otherwise
957untouched. That means that requests that currently execute will not be 1171untouched (with the exception of readdir). That means that requests that
958stopped and resources held by the request will not be freed prematurely. 1172currently execute will not be stopped and resources held by the request
1173will not be freed prematurely.
959 1174
960=item cb $req $callback->(...) 1175=item cb $req $callback->(...)
961 1176
962Replace (or simply set) the callback registered to the request. 1177Replace (or simply set) the callback registered to the request.
963 1178
… …
1014Their lifetime, simplified, looks like this: when they are empty, they 1229Their lifetime, simplified, looks like this: when they are empty, they
1015will finish very quickly. If they contain only requests that are in the 1230will finish very quickly. If they contain only requests that are in the
1016C<done> state, they will also finish. Otherwise they will continue to 1231C<done> state, they will also finish. Otherwise they will continue to
1017exist. 1232exist.
1018 1233
1019That means after creating a group you have some time to add requests. And 1234That means after creating a group you have some time to add requests
1020in the callbacks of those requests, you can add further requests to the 1235(precisely before the callback has been invoked, which is only done within
1021group. And only when all those requests have finished will the the group 1236the C<poll_cb>). And in the callbacks of those requests, you can add
1022itself finish. 1237further requests to the group. And only when all those requests have
1238finished will the the group itself finish.
1023 1239
1024=over 4 1240=over 4
1025 1241
1026=item add $grp ... 1242=item add $grp ...
1027 1243
… …
1035 1251
1036=item $grp->cancel_subs 1252=item $grp->cancel_subs
1037 1253
1038Cancel all subrequests and clears any feeder, but not the group request 1254Cancel all subrequests and clears any feeder, but not the group request
1039itself. Useful when you queued a lot of events but got a result early. 1255itself. Useful when you queued a lot of events but got a result early.
1256
1257The group request will finish normally (you cannot add requests to the
1258group).
1040 1259
1041=item $grp->result (...) 1260=item $grp->result (...)
1042 1261
1043Set the result value(s) that will be passed to the group callback when all 1262Set the result value(s) that will be passed to the group callback when all
1044subrequests have finished and set the groups errno to the current value 1263subrequests have finished and set the groups errno to the current value
… …
1060=item feed $grp $callback->($grp) 1279=item feed $grp $callback->($grp)
1061 1280
1062Sets a feeder/generator on this group: every group can have an attached 1281Sets a feeder/generator on this group: every group can have an attached
1063generator that generates requests if idle. The idea behind this is that, 1282generator that generates requests if idle. The idea behind this is that,
1064although you could just queue as many requests as you want in a group, 1283although you could just queue as many requests as you want in a group,
1065this might starve other requests for a potentially long time. For 1284this might starve other requests for a potentially long time. For example,
1066example, C<aio_scandir> might generate hundreds of thousands C<aio_stat> 1285C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,
1067requests, delaying any later requests for a long time. 1286delaying any later requests for a long time.
1068 1287
1069To avoid this, and allow incremental generation of requests, you can 1288To avoid this, and allow incremental generation of requests, you can
1070instead a group and set a feeder on it that generates those requests. The 1289instead a group and set a feeder on it that generates those requests. The
1071feed callback will be called whenever there are few enough (see C<limit>, 1290feed callback will be called whenever there are few enough (see C<limit>,
1072below) requests active in the group itself and is expected to queue more 1291below) requests active in the group itself and is expected to queue more
… …
1076not impose any limits). 1295not impose any limits).
1077 1296
1078If the feed does not queue more requests when called, it will be 1297If the feed does not queue more requests when called, it will be
1079automatically removed from the group. 1298automatically removed from the group.
1080 1299
1081If the feed limit is C<0>, it will be set to C<2> automatically. 1300If the feed limit is C<0> when this method is called, it will be set to
1301C<2> automatically.
1082 1302
1083Example: 1303Example:
1084 1304
1085 # stat all files in @files, but only ever use four aio requests concurrently: 1305 # stat all files in @files, but only ever use four aio requests concurrently:
1086 1306
… …
1098Sets the feeder limit for the group: The feeder will be called whenever 1318Sets the feeder limit for the group: The feeder will be called whenever
1099the group contains less than this many requests. 1319the group contains less than this many requests.
1100 1320
1101Setting the limit to C<0> will pause the feeding process. 1321Setting the limit to C<0> will pause the feeding process.
1102 1322
1323The default value for the limit is C<0>, but note that setting a feeder
1324automatically bumps it up to C<2>.
1325
1103=back 1326=back
1104 1327
1105=head2 SUPPORT FUNCTIONS 1328=head2 SUPPORT FUNCTIONS
1106 1329
1107=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION 1330=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
… …
1109=over 4 1332=over 4
1110 1333
1111=item $fileno = IO::AIO::poll_fileno 1334=item $fileno = IO::AIO::poll_fileno
1112 1335
1113Return the I<request result pipe file descriptor>. This filehandle must be 1336Return the I<request result pipe file descriptor>. This filehandle must be
1114polled for reading by some mechanism outside this module (e.g. Event or 1337polled for reading by some mechanism outside this module (e.g. EV, Glib,
1115select, see below or the SYNOPSIS). If the pipe becomes readable you have 1338select and so on, see below or the SYNOPSIS). If the pipe becomes readable
1116to call C<poll_cb> to check the results. 1339you have to call C<poll_cb> to check the results.
1117 1340
1118See C<poll_cb> for an example. 1341See C<poll_cb> for an example.
1119 1342
1120=item IO::AIO::poll_cb 1343=item IO::AIO::poll_cb
1121 1344
1122Process some outstanding events on the result pipe. You have to call this 1345Process some outstanding events on the result pipe. You have to call this
1123regularly. Returns the number of events processed. Returns immediately 1346regularly. Returns C<0> if all events could be processed, or C<-1> if it
1347returned earlier for whatever reason. Returns immediately when no events
1124when no events are outstanding. The amount of events processed depends on 1348are outstanding. The amount of events processed depends on the settings of
1125the settings of C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>. 1349C<IO::AIO::max_poll_req> and C<IO::AIO::max_poll_time>.
1126 1350
1127If not all requests were processed for whatever reason, the filehandle 1351If not all requests were processed for whatever reason, the filehandle
1128will still be ready when C<poll_cb> returns. 1352will still be ready when C<poll_cb> returns, so normally you don't have to
1353do anything special to have it called later.
1129 1354
1130Example: Install an Event watcher that automatically calls 1355Example: Install an Event watcher that automatically calls
1131IO::AIO::poll_cb with high priority: 1356IO::AIO::poll_cb with high priority (more examples can be found in the
1357SYNOPSIS section, at the top of this document):
1132 1358
1133 Event->io (fd => IO::AIO::poll_fileno, 1359 Event->io (fd => IO::AIO::poll_fileno,
1134 poll => 'r', async => 1, 1360 poll => 'r', async => 1,
1135 cb => \&IO::AIO::poll_cb); 1361 cb => \&IO::AIO::poll_cb);
1362
1363=item IO::AIO::poll_wait
1364
1365If there are any outstanding requests and none of them in the result
1366phase, wait till the result filehandle becomes ready for reading (simply
1367does a C<select> on the filehandle. This is useful if you want to
1368synchronously wait for some requests to finish).
1369
1370See C<nreqs> for an example.
1371
1372=item IO::AIO::poll
1373
1374Waits until some requests have been handled.
1375
1376Returns the number of requests processed, but is otherwise strictly
1377equivalent to:
1378
1379 IO::AIO::poll_wait, IO::AIO::poll_cb
1380
1381=item IO::AIO::flush
1382
1383Wait till all outstanding AIO requests have been handled.
1384
1385Strictly equivalent to:
1386
1387 IO::AIO::poll_wait, IO::AIO::poll_cb
1388 while IO::AIO::nreqs;
1136 1389
1137=item IO::AIO::max_poll_reqs $nreqs 1390=item IO::AIO::max_poll_reqs $nreqs
1138 1391
1139=item IO::AIO::max_poll_time $seconds 1392=item IO::AIO::max_poll_time $seconds
1140 1393
… …
1165 # use a low priority so other tasks have priority 1418 # use a low priority so other tasks have priority
1166 Event->io (fd => IO::AIO::poll_fileno, 1419 Event->io (fd => IO::AIO::poll_fileno,
1167 poll => 'r', nice => 1, 1420 poll => 'r', nice => 1,
1168 cb => &IO::AIO::poll_cb); 1421 cb => &IO::AIO::poll_cb);
1169 1422
1170=item IO::AIO::poll_wait
1171
1172If there are any outstanding requests and none of them in the result
1173phase, wait till the result filehandle becomes ready for reading (simply
1174does a C<select> on the filehandle. This is useful if you want to
1175synchronously wait for some requests to finish).
1176
1177See C<nreqs> for an example.
1178
1179=item IO::AIO::poll
1180
1181Waits until some requests have been handled.
1182
1183Returns the number of requests processed, but is otherwise strictly
1184equivalent to:
1185
1186 IO::AIO::poll_wait, IO::AIO::poll_cb
1187
1188=item IO::AIO::flush
1189
1190Wait till all outstanding AIO requests have been handled.
1191
1192Strictly equivalent to:
1193
1194 IO::AIO::poll_wait, IO::AIO::poll_cb
1195 while IO::AIO::nreqs;
1196
1197=back 1423=back
1198 1424
1199=head3 CONTROLLING THE NUMBER OF THREADS 1425=head3 CONTROLLING THE NUMBER OF THREADS
1200 1426
1201=over 1427=over
… …
1293Returns the number of requests currently in the pending state (executed, 1519Returns the number of requests currently in the pending state (executed,
1294but not yet processed by poll_cb). 1520but not yet processed by poll_cb).
1295 1521
1296=back 1522=back
1297 1523
1524=head3 MISCELLANEOUS FUNCTIONS
1525
1526IO::AIO implements some functions that might be useful, but are not
1527asynchronous.
1528
1529=over 4
1530
1531=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1532
1533Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
1534but is blocking (this makes most sense if you know the input data is
1535likely cached already and the output filehandle is set to non-blocking
1536operations).
1537
1538Returns the number of bytes copied, or C<-1> on error.
1539
1540=item IO::AIO::fadvise $fh, $offset, $len, $advice
1541
1542Simply calls the C<posix_fadvise> function (see it's
1543manpage for details). The following advice constants are
1544avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1545C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1546C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1547
1548On systems that do not implement C<posix_fadvise>, this function returns
1549ENOSYS, otherwise the return value of C<posix_fadvise>.
1550
1551=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1552
1553Memory-maps a file (or anonymous memory range) and attaches it to the
1554given C<$scalar>, which will act like a string scalar.
1555
1556The only operations allowed on the scalar are C<substr>/C<vec> that don't
1557change the string length, and most read-only operations such as copying it
1558or searching it with regexes and so on.
1559
1560Anything else is unsafe and will, at best, result in memory leaks.
1561
1562The memory map associated with the C<$scalar> is automatically removed
1563when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or
1564C<IO::AIO::munmap> functions are called.
1565
1566This calls the C<mmap>(2) function internally. See your system's manual
1567page for details on the C<$length>, C<$prot> and C<$flags> parameters.
1568
1569The C<$length> must be larger than zero and smaller than the actual
1570filesize.
1571
1572C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1573C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1574
1575C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or
1576C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when
1577not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>
1578(which is set to C<MAP_ANON> if your system only provides this
1579constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,
1580C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
1581C<IO::AIO::MAP_NONBLOCK>
1582
1583If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1584
1585C<$offset> is the offset from the start of the file - it generally must be
1586a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
1587
1588Example:
1589
1590 use Digest::MD5;
1591 use IO::AIO;
1592
1593 open my $fh, "<verybigfile"
1594 or die "$!";
1595
1596 IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
1597 or die "verybigfile: $!";
1598
1599 my $fast_md5 = md5 $data;
1600
1601=item IO::AIO::munmap $scalar
1602
1603Removes a previous mmap and undefines the C<$scalar>.
1604
1605=item IO::AIO::mlockall $flags
1606
1607Calls the C<mlockall> function with the given C<$flags> (a combination of
1608C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL__FUTURE>).
1609
1610On systems that do not implement C<mlockall>, this function returns
1611ENOSYS, otherwise the return value of C<mlockall>.
1612
1613=item IO::AIO::munlockall
1614
1615Calls the C<munlockall> function.
1616
1617On systems that do not implement C<munlockall>, this function returns
1618ENOSYS, otherwise the return value of C<munlockall>.
1619
1620=back
1621
1298=cut 1622=cut
1299 1623
1300min_parallel 8; 1624min_parallel 8;
1301 1625
1302END { flush } 1626END { flush }
1303 1627
13041; 16281;
1629
1630=head1 EVENT LOOP INTEGRATION
1631
1632It is recommended to use L<AnyEvent::AIO> to integrate IO::AIO
1633automatically into many event loops:
1634
1635 # AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
1636 use AnyEvent::AIO;
1637
1638You can also integrate IO::AIO manually into many event loops, here are
1639some examples of how to do this:
1640
1641 # EV integration
1642 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
1643
1644 # Event integration
1645 Event->io (fd => IO::AIO::poll_fileno,
1646 poll => 'r',
1647 cb => \&IO::AIO::poll_cb);
1648
1649 # Glib/Gtk2 integration
1650 add_watch Glib::IO IO::AIO::poll_fileno,
1651 in => sub { IO::AIO::poll_cb; 1 };
1652
1653 # Tk integration
1654 Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
1655 readable => \&IO::AIO::poll_cb);
1656
1657 # Danga::Socket integration
1658 Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
1659 \&IO::AIO::poll_cb);
1305 1660
1306=head2 FORK BEHAVIOUR 1661=head2 FORK BEHAVIOUR
1307 1662
1308This module should do "the right thing" when the process using it forks: 1663This module should do "the right thing" when the process using it forks:
1309 1664
… …
1342 1697
1343Known bugs will be fixed in the next release. 1698Known bugs will be fixed in the next release.
1344 1699
1345=head1 SEE ALSO 1700=head1 SEE ALSO
1346 1701
1347L<Coro::AIO>. 1702L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
1703more natural syntax.
1348 1704
1349=head1 AUTHOR 1705=head1 AUTHOR
1350 1706
1351 Marc Lehmann <schmorp@schmorp.de> 1707 Marc Lehmann <schmorp@schmorp.de>
1352 http://home.schmorp.de/ 1708 http://home.schmorp.de/

Diff Legend

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