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.178 by root, Sun Jan 10 23:10:58 2010 UTC vs.
Revision 1.183 by root, Sun Sep 12 03:40:05 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
… …
76 76
77 # register the IO::AIO callback with EV 77 # register the IO::AIO callback with EV
78 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb; 78 my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
79 79
80 # queue the request to open /etc/passwd 80 # queue the request to open /etc/passwd
81 aio_open "/etc/passwd", O_RDONLY, 0, sub { 81 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
82 my $fh = shift 82 my $fh = shift
83 or die "error while opening: $!"; 83 or die "error while opening: $!";
84 84
85 # stat'ing filehandles is generally non-blocking 85 # stat'ing filehandles is generally non-blocking
86 my $size = -s $fh; 86 my $size = -s $fh;
… …
168use common::sense; 168use common::sense;
169 169
170use base 'Exporter'; 170use base 'Exporter';
171 171
172BEGIN { 172BEGIN {
173 our $VERSION = '3.6'; 173 our $VERSION = '3.65';
174 174
175 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
176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx 176 aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx
177 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync 177 aio_scandir aio_symlink aio_readlink aio_sync aio_fsync
178 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead 178 aio_fdatasync aio_sync_file_range aio_pathsync aio_readahead
179 aio_rename aio_link aio_move aio_copy aio_group 179 aio_rename aio_link aio_move aio_copy aio_group
180 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
181 aio_chmod aio_utime aio_truncate 181 aio_chmod aio_utime aio_truncate
182 aio_msync aio_mtouch aio_statvfs); 182 aio_msync aio_mtouch aio_mlock aio_mlockall
183 aio_statvfs);
183 184
184 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice)); 185 our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
185 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush 186 our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
186 min_parallel max_parallel max_idle 187 min_parallel max_parallel max_idle
187 nreqs nready npending nthreads 188 nreqs nready npending nthreads
188 max_poll_time max_poll_reqs 189 max_poll_time max_poll_reqs
189 sendfile fadvise); 190 sendfile fadvise madvise
191 mmap munmap munlock munlockall);
190 192
191 push @AIO_REQ, qw(aio_busy); # not exported 193 push @AIO_REQ, qw(aio_busy); # not exported
192 194
193 @IO::AIO::GRP::ISA = 'IO::AIO::REQ'; 195 @IO::AIO::GRP::ISA = 'IO::AIO::REQ';
194 196
… …
239 aio_fdatasync $fh, $callback->($status) 241 aio_fdatasync $fh, $callback->($status)
240 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status) 242 aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
241 aio_pathsync $path, $callback->($status) 243 aio_pathsync $path, $callback->($status)
242 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 244 aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
243 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status) 245 aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
246 aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
247 aio_mlockall $flags, $callback->($status)
244 aio_group $callback->(...) 248 aio_group $callback->(...)
245 aio_nop $callback->() 249 aio_nop $callback->()
246 250
247 $prev_pri = aioreq_pri [$pri] 251 $prev_pri = aioreq_pri [$pri]
248 aioreq_nice $pri_adjust 252 aioreq_nice $pri_adjust
… …
261 IO::AIO::nready 265 IO::AIO::nready
262 IO::AIO::npending 266 IO::AIO::npending
263 267
264 IO::AIO::sendfile $ofh, $ifh, $offset, $count 268 IO::AIO::sendfile $ofh, $ifh, $offset, $count
265 IO::AIO::fadvise $fh, $offset, $len, $advice 269 IO::AIO::fadvise $fh, $offset, $len, $advice
266 IO::AIO::mlockall $flags 270 IO::AIO::munlock $scalar, $offset = 0, $length = undef
267 IO::AIO::munlockall 271 IO::AIO::munlockall
268 272
269=head2 AIO REQUEST FUNCTIONS 273=head2 AIO REQUEST FUNCTIONS
270 274
271All the C<aio_*> calls are more or less thin wrappers around the syscall 275All the C<aio_*> calls are more or less thin wrappers around the syscall
… …
352by the umask in effect then the request is being executed, so better never 356by the umask in effect then the request is being executed, so better never
353change the umask. 357change the umask.
354 358
355Example: 359Example:
356 360
357 aio_open "/etc/passwd", O_RDONLY, 0, sub { 361 aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
358 if ($_[0]) { 362 if ($_[0]) {
359 print "open successful, fh is $_[0]\n"; 363 print "open successful, fh is $_[0]\n";
360 ... 364 ...
361 } else { 365 } else {
362 die "open failed: $!\n"; 366 die "open failed: $!\n";
… …
1108as for C<aio_msync>, above, except for flags, which must be either 1112as for C<aio_msync>, above, except for flags, which must be either
1109C<0> (which reads all pages and ensures they are instantiated) or 1113C<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 1114C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
1111writing an octet from it, which dirties the page). 1115writing an octet from it, which dirties the page).
1112 1116
1117=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1118
1119This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1120scalars.
1121
1122It reads in all the pages of the underlying storage into memory (if any)
1123and locks them, so they are not getting swapped/paged out or removed.
1124
1125If C<$length> is undefined, then the scalar will be locked till the end.
1126
1127On systems that do not implement C<mlock>, this function returns C<-1>
1128and sets errno to C<ENOSYS>.
1129
1130Note that the corresponding C<munlock> is synchronous and is
1131documented under L<MISCELLANEOUS FUNCTIONS>.
1132
1133Example: open a file, mmap and mlock it - both will be undone when
1134C<$data> gets destroyed.
1135
1136 open my $fh, "<", $path or die "$path: $!";
1137 my $data;
1138 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1139 aio_mlock $data; # mlock in background
1140
1141=item aio_mlockall $flags, $callback->($status)
1142
1143Calls the C<mlockall> function with the given C<$flags> (a combination of
1144C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
1145
1146On systems that do not implement C<mlockall>, this function returns C<-1>
1147and sets errno to C<ENOSYS>.
1148
1149Note that the corresponding C<munlockall> is synchronous and is
1150documented under L<MISCELLANEOUS FUNCTIONS>.
1151
1152Example: asynchronously lock all current and future pages into memory.
1153
1154 aio_mlockall IO::AIO::MCL_FUTURE;
1155
1113=item aio_group $callback->(...) 1156=item aio_group $callback->(...)
1114 1157
1115This is a very special aio request: Instead of doing something, it is a 1158This is a very special aio request: Instead of doing something, it is a
1116container for other aio requests, which is useful if you want to bundle 1159container for other aio requests, which is useful if you want to bundle
1117many requests into a single, composite, request with a definite callback 1160many requests into a single, composite, request with a definite callback
… …
1580C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or 1623C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or
1581C<IO::AIO::MAP_NONBLOCK> 1624C<IO::AIO::MAP_NONBLOCK>
1582 1625
1583If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. 1626If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1584 1627
1628C<$offset> is the offset from the start of the file - it generally must be
1629a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
1630
1585Example: 1631Example:
1586 1632
1587 use Digest::MD5; 1633 use Digest::MD5;
1588 use IO::AIO; 1634 use IO::AIO;
1589 1635
… …
1597 1643
1598=item IO::AIO::munmap $scalar 1644=item IO::AIO::munmap $scalar
1599 1645
1600Removes a previous mmap and undefines the C<$scalar>. 1646Removes a previous mmap and undefines the C<$scalar>.
1601 1647
1602=item IO::AIO::mlockall $flags 1648=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
1603 1649
1604Calls the C<mlockall> function with the given C<$flags> (a combination of 1650Calls the C<munlock> function, undoing the effects of a previous
1605C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL__FUTURE>). 1651C<aio_mlock> call (see its description for details).
1606
1607On systems that do not implement C<mlockall>, this function returns
1608ENOSYS, otherwise the return value of C<mlockall>.
1609 1652
1610=item IO::AIO::munlockall 1653=item IO::AIO::munlockall
1611 1654
1612Calls the C<munlockall> function. 1655Calls the C<munlockall> function.
1613 1656

Diff Legend

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