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.181 by root, Tue May 4 21:14:01 2010 UTC vs.
Revision 1.184 by root, Mon Nov 1 22:03:43 2010 UTC

… …
168use common::sense; 168use common::sense;
169 169
170use base 'Exporter'; 170use base 'Exporter';
171 171
172BEGIN { 172BEGIN {
173 our $VERSION = '3.65'; 173 our $VERSION = '3.7';
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::madvise $scalar, $offset, $length, $advice
271 IO::AIO::mprotect $scalar, $offset, $length, $protect
272 IO::AIO::munlock $scalar, $offset = 0, $length = undef
267 IO::AIO::munlockall 273 IO::AIO::munlockall
268 274
269=head2 AIO REQUEST FUNCTIONS 275=head2 AIO REQUEST FUNCTIONS
270 276
271All the C<aio_*> calls are more or less thin wrappers around the syscall 277All the C<aio_*> calls are more or less thin wrappers around the syscall
… …
1108as for C<aio_msync>, above, except for flags, which must be either 1114as for C<aio_msync>, above, except for flags, which must be either
1109C<0> (which reads all pages and ensures they are instantiated) or 1115C<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 1116C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and
1111writing an octet from it, which dirties the page). 1117writing an octet from it, which dirties the page).
1112 1118
1119=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1120
1121This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1122scalars.
1123
1124It reads in all the pages of the underlying storage into memory (if any)
1125and locks them, so they are not getting swapped/paged out or removed.
1126
1127If C<$length> is undefined, then the scalar will be locked till the end.
1128
1129On systems that do not implement C<mlock>, this function returns C<-1>
1130and sets errno to C<ENOSYS>.
1131
1132Note that the corresponding C<munlock> is synchronous and is
1133documented under L<MISCELLANEOUS FUNCTIONS>.
1134
1135Example: open a file, mmap and mlock it - both will be undone when
1136C<$data> gets destroyed.
1137
1138 open my $fh, "<", $path or die "$path: $!";
1139 my $data;
1140 IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1141 aio_mlock $data; # mlock in background
1142
1143=item aio_mlockall $flags, $callback->($status)
1144
1145Calls the C<mlockall> function with the given C<$flags> (a combination of
1146C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).
1147
1148On systems that do not implement C<mlockall>, this function returns C<-1>
1149and sets errno to C<ENOSYS>.
1150
1151Note that the corresponding C<munlockall> is synchronous and is
1152documented under L<MISCELLANEOUS FUNCTIONS>.
1153
1154Example: asynchronously lock all current and future pages into memory.
1155
1156 aio_mlockall IO::AIO::MCL_FUTURE;
1157
1113=item aio_group $callback->(...) 1158=item aio_group $callback->(...)
1114 1159
1115This is a very special aio request: Instead of doing something, it is a 1160This 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 1161container for other aio requests, which is useful if you want to bundle
1117many requests into a single, composite, request with a definite callback 1162many requests into a single, composite, request with a definite callback
… …
1537 1582
1538Returns the number of bytes copied, or C<-1> on error. 1583Returns the number of bytes copied, or C<-1> on error.
1539 1584
1540=item IO::AIO::fadvise $fh, $offset, $len, $advice 1585=item IO::AIO::fadvise $fh, $offset, $len, $advice
1541 1586
1542Simply calls the C<posix_fadvise> function (see it's 1587Simply calls the C<posix_fadvise> function (see its
1543manpage for details). The following advice constants are 1588manpage for details). The following advice constants are
1544avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>, 1589avaiable: C<IO::AIO::FADV_NORMAL>, C<IO::AIO::FADV_SEQUENTIAL>,
1545C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>, 1590C<IO::AIO::FADV_RANDOM>, C<IO::AIO::FADV_NOREUSE>,
1546C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>. 1591C<IO::AIO::FADV_WILLNEED>, C<IO::AIO::FADV_DONTNEED>.
1547 1592
1548On systems that do not implement C<posix_fadvise>, this function returns 1593On systems that do not implement C<posix_fadvise>, this function returns
1549ENOSYS, otherwise the return value of C<posix_fadvise>. 1594ENOSYS, otherwise the return value of C<posix_fadvise>.
1595
1596=item IO::AIO::madvise $scalar, $offset, $len, $advice
1597
1598Simply calls the C<posix_madvise> function (see its
1599manpage for details). The following advice constants are
1600avaiable: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1601C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.
1602
1603On systems that do not implement C<posix_madvise>, this function returns
1604ENOSYS, otherwise the return value of C<posix_madvise>.
1605
1606=item IO::AIO::mprotect $scalar, $offset, $len, $protect
1607
1608Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
1609$scalar (see its manpage for details). The following protect
1610constants are avaiable: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
1611C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
1612
1613On systems that do not implement C<mprotect>, this function returns
1614ENOSYS, otherwise the return value of C<mprotect>.
1550 1615
1551=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset] 1616=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1552 1617
1553Memory-maps a file (or anonymous memory range) and attaches it to the 1618Memory-maps a file (or anonymous memory range) and attaches it to the
1554given C<$scalar>, which will act like a string scalar. 1619given C<$scalar>, which will act like a string scalar.
… …
1600 1665
1601=item IO::AIO::munmap $scalar 1666=item IO::AIO::munmap $scalar
1602 1667
1603Removes a previous mmap and undefines the C<$scalar>. 1668Removes a previous mmap and undefines the C<$scalar>.
1604 1669
1605=item IO::AIO::mlockall $flags 1670=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
1606 1671
1607Calls the C<mlockall> function with the given C<$flags> (a combination of 1672Calls the C<munlock> function, undoing the effects of a previous
1608C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL__FUTURE>). 1673C<aio_mlock> call (see its description for details).
1609
1610On systems that do not implement C<mlockall>, this function returns
1611ENOSYS, otherwise the return value of C<mlockall>.
1612 1674
1613=item IO::AIO::munlockall 1675=item IO::AIO::munlockall
1614 1676
1615Calls the C<munlockall> function. 1677Calls the C<munlockall> function.
1616 1678

Diff Legend

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