… | |
… | |
171 | use common::sense; |
171 | use common::sense; |
172 | |
172 | |
173 | use base 'Exporter'; |
173 | use base 'Exporter'; |
174 | |
174 | |
175 | BEGIN { |
175 | BEGIN { |
176 | our $VERSION = 4.6; |
176 | our $VERSION = 4.76; |
177 | |
177 | |
178 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
178 | our @AIO_REQ = qw(aio_sendfile aio_seek aio_read aio_write aio_open aio_close |
179 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
179 | aio_stat aio_lstat aio_unlink aio_rmdir aio_readdir aio_readdirx |
180 | aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl |
180 | aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl |
181 | aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range |
181 | aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range |
… | |
… | |
278 | IO::AIO::idle_timeout $seconds |
278 | IO::AIO::idle_timeout $seconds |
279 | IO::AIO::max_outstanding $maxreqs |
279 | IO::AIO::max_outstanding $maxreqs |
280 | IO::AIO::nreqs |
280 | IO::AIO::nreqs |
281 | IO::AIO::nready |
281 | IO::AIO::nready |
282 | IO::AIO::npending |
282 | IO::AIO::npending |
|
|
283 | IO::AIO::reinit |
|
|
284 | |
283 | $nfd = IO::AIO::get_fdlimit [EXPERIMENTAL] |
285 | $nfd = IO::AIO::get_fdlimit |
284 | IO::AIO::min_fdlimit $nfd [EXPERIMENTAL] |
286 | IO::AIO::min_fdlimit $nfd |
285 | |
287 | |
286 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
288 | IO::AIO::sendfile $ofh, $ifh, $offset, $count |
287 | IO::AIO::fadvise $fh, $offset, $len, $advice |
289 | IO::AIO::fadvise $fh, $offset, $len, $advice |
|
|
290 | |
288 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
291 | IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]] |
289 | IO::AIO::munmap $scalar |
292 | IO::AIO::munmap $scalar |
290 | IO::AIO::mremap $scalar, $new_length, $flags[, $new_address] |
293 | IO::AIO::mremap $scalar, $new_length, $flags[, $new_address] |
291 | IO::AIO::madvise $scalar, $offset, $length, $advice |
294 | IO::AIO::madvise $scalar, $offset, $length, $advice |
292 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
295 | IO::AIO::mprotect $scalar, $offset, $length, $protect |
293 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
296 | IO::AIO::munlock $scalar, $offset = 0, $length = undef |
294 | IO::AIO::munlockall |
297 | IO::AIO::munlockall |
|
|
298 | |
|
|
299 | # stat extensions |
|
|
300 | $counter = IO::AIO::st_gen |
|
|
301 | $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime |
|
|
302 | ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
|
|
303 | $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec |
|
|
304 | $seconds = IO::AIO::st_btimesec |
|
|
305 | ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec |
|
|
306 | |
|
|
307 | # very much unportable syscalls |
|
|
308 | IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_len, $flags |
|
|
309 | IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
|
|
310 | IO::AIO::tee $r_fh, $w_fh, $length, $flags |
|
|
311 | $actual_size = IO::AIO::pipesize $r_fh[, $new_size] |
|
|
312 | ($rfh, $wfh) = IO::AIO::pipe2 [$flags] |
|
|
313 | $fh = IO::AIO::memfd_create $pathname[, $flags] |
|
|
314 | $fh = IO::AIO::eventfd [$initval, [$flags]] |
|
|
315 | $fh = IO::AIO::timerfd_create $clockid[, $flags] |
|
|
316 | ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value |
|
|
317 | ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh |
295 | |
318 | |
296 | =head2 API NOTES |
319 | =head2 API NOTES |
297 | |
320 | |
298 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
321 | All the C<aio_*> calls are more or less thin wrappers around the syscall |
299 | with the same name (sans C<aio_>). The arguments are similar or identical, |
322 | with the same name (sans C<aio_>). The arguments are similar or identical, |
… | |
… | |
1109 | aioreq_pri $pri; |
1132 | aioreq_pri $pri; |
1110 | add $grp aio_stat $wd, sub { |
1133 | add $grp aio_stat $wd, sub { |
1111 | return $grp->result () if $_[0]; |
1134 | return $grp->result () if $_[0]; |
1112 | my $now = time; |
1135 | my $now = time; |
1113 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
1136 | my $hash1 = join ":", (stat _)[0,1,3,7,9]; |
|
|
1137 | my $rdxflags = READDIR_DIRS_FIRST; |
|
|
1138 | |
|
|
1139 | if ((stat _)[3] < 2) { |
|
|
1140 | # at least one non-POSIX filesystem exists |
|
|
1141 | # that returns useful DT_type values: btrfs, |
|
|
1142 | # so optimise for this here by requesting dents |
|
|
1143 | $rdxflags |= READDIR_DENTS; |
|
|
1144 | } |
1114 | |
1145 | |
1115 | # read the directory entries |
1146 | # read the directory entries |
1116 | aioreq_pri $pri; |
1147 | aioreq_pri $pri; |
1117 | add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub { |
1148 | add $grp aio_readdirx $wd, $rdxflags, sub { |
1118 | my $entries = shift |
1149 | my ($entries, $flags) = @_ |
1119 | or return $grp->result (); |
1150 | or return $grp->result (); |
|
|
1151 | |
|
|
1152 | if ($rdxflags & READDIR_DENTS) { |
|
|
1153 | # if we requested type values, see if we can use them directly. |
|
|
1154 | |
|
|
1155 | # if there were any DT_UNKNOWN entries then we assume we |
|
|
1156 | # don't know. alternatively, we could assume that if we get |
|
|
1157 | # one DT_DIR, then all directories are indeed marked with |
|
|
1158 | # DT_DIR, but this seems not required for btrfs, and this |
|
|
1159 | # is basically the "btrfs can't get it's act together" code |
|
|
1160 | # branch. |
|
|
1161 | unless ($flags & READDIR_FOUND_UNKNOWN) { |
|
|
1162 | # now we have valid DT_ information for all entries, |
|
|
1163 | # so use it as an optimisation without further stat's. |
|
|
1164 | # they must also all be at the beginning of @$entries |
|
|
1165 | # by now. |
|
|
1166 | |
|
|
1167 | my $dirs; |
|
|
1168 | |
|
|
1169 | if (@$entries) { |
|
|
1170 | for (0 .. $#$entries) { |
|
|
1171 | if ($entries->[$_][1] != DT_DIR) { |
|
|
1172 | # splice out directories |
|
|
1173 | $dirs = [splice @$entries, 0, $_]; |
|
|
1174 | last; |
|
|
1175 | } |
|
|
1176 | } |
|
|
1177 | |
|
|
1178 | # if we didn't find any non-dir, then all entries are dirs |
|
|
1179 | unless ($dirs) { |
|
|
1180 | ($dirs, $entries) = ($entries, []); |
|
|
1181 | } |
|
|
1182 | } else { |
|
|
1183 | # directory is empty, so there are no sbdirs |
|
|
1184 | $dirs = []; |
|
|
1185 | } |
|
|
1186 | |
|
|
1187 | # either splice'd the directories out or the dir was empty. |
|
|
1188 | # convert dents to filenames |
|
|
1189 | $_ = $_->[0] for @$dirs; |
|
|
1190 | $_ = $_->[0] for @$entries; |
|
|
1191 | |
|
|
1192 | return $grp->result ($dirs, $entries); |
|
|
1193 | } |
|
|
1194 | |
|
|
1195 | # cannot use, so return to our old ways |
|
|
1196 | # by pretending we only scanned for names. |
|
|
1197 | $_ = $_->[0] for @$entries; |
|
|
1198 | } |
1120 | |
1199 | |
1121 | # stat the dir another time |
1200 | # stat the dir another time |
1122 | aioreq_pri $pri; |
1201 | aioreq_pri $pri; |
1123 | add $grp aio_stat $wd, sub { |
1202 | add $grp aio_stat $wd, sub { |
1124 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
1203 | my $hash2 = join ":", (stat _)[0,1,3,7,9]; |
… | |
… | |
1230 | So in general, you should only use these calls for things that do |
1309 | So in general, you should only use these calls for things that do |
1231 | (filesystem) I/O, not for things that wait for other events (network, |
1310 | (filesystem) I/O, not for things that wait for other events (network, |
1232 | other processes), although if you are careful and know what you are doing, |
1311 | other processes), although if you are careful and know what you are doing, |
1233 | you still can. |
1312 | you still can. |
1234 | |
1313 | |
1235 | The following constants are available (missing ones are, as usual C<0>): |
1314 | The following constants are available and can be used for normal C<ioctl> |
|
|
1315 | and C<fcntl> as well (missing ones are, as usual C<0>): |
1236 | |
1316 | |
1237 | C<F_DUPFD_CLOEXEC>, |
1317 | C<F_DUPFD_CLOEXEC>, |
1238 | |
1318 | |
1239 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
1319 | C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>, |
1240 | |
1320 | |
1241 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
1321 | C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>. |
|
|
1322 | |
|
|
1323 | C<F_ADD_SEALS>, C<F_GET_SEALS>, C<F_SEAL_SEAL>, C<F_SEAL_SHRINK>, C<F_SEAL_GROW> and |
|
|
1324 | C<F_SEAL_WRITE>. |
1242 | |
1325 | |
1243 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
1326 | C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>, |
1244 | C<FS_IOC_FIEMAP>. |
1327 | C<FS_IOC_FIEMAP>. |
1245 | |
1328 | |
1246 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
1329 | C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>, |
… | |
… | |
1385 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1468 | IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh; |
1386 | aio_mlock $data; # mlock in background |
1469 | aio_mlock $data; # mlock in background |
1387 | |
1470 | |
1388 | =item aio_mlockall $flags, $callback->($status) |
1471 | =item aio_mlockall $flags, $callback->($status) |
1389 | |
1472 | |
1390 | Calls the C<mlockall> function with the given C<$flags> (a combination of |
1473 | Calls the C<mlockall> function with the given C<$flags> (a |
1391 | C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>). |
1474 | combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and |
|
|
1475 | C<IO::AIO::MCL_ONFAULT>). |
1392 | |
1476 | |
1393 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1477 | On systems that do not implement C<mlockall>, this function returns C<-1> |
1394 | and sets errno to C<ENOSYS>. |
1478 | and sets errno to C<ENOSYS>. Similarly, flag combinations not supported |
|
|
1479 | by the system result in a return value of C<-1> with errno being set to |
|
|
1480 | C<EINVAL>. |
1395 | |
1481 | |
1396 | Note that the corresponding C<munlockall> is synchronous and is |
1482 | Note that the corresponding C<munlockall> is synchronous and is |
1397 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1483 | documented under L<MISCELLANEOUS FUNCTIONS>. |
1398 | |
1484 | |
1399 | Example: asynchronously lock all current and future pages into memory. |
1485 | Example: asynchronously lock all current and future pages into memory. |
… | |
… | |
1593 | C<aio_wd> callback, as future requests using the value will fail in the |
1679 | C<aio_wd> callback, as future requests using the value will fail in the |
1594 | expected way. |
1680 | expected way. |
1595 | |
1681 | |
1596 | =item IO::AIO::CWD |
1682 | =item IO::AIO::CWD |
1597 | |
1683 | |
1598 | This is a compiletime constant (object) that represents the process |
1684 | This is a compile time constant (object) that represents the process |
1599 | current working directory. |
1685 | current working directory. |
1600 | |
1686 | |
1601 | Specifying this object as working directory object for a pathname is as if |
1687 | Specifying this object as working directory object for a pathname is as if |
1602 | the pathname would be specified directly, without a directory object. For |
1688 | the pathname would be specified directly, without a directory object. For |
1603 | example, these calls are functionally identical: |
1689 | example, these calls are functionally identical: |
… | |
… | |
1975 | longer exceeded. |
2061 | longer exceeded. |
1976 | |
2062 | |
1977 | In other words, this setting does not enforce a queue limit, but can be |
2063 | In other words, this setting does not enforce a queue limit, but can be |
1978 | used to make poll functions block if the limit is exceeded. |
2064 | used to make poll functions block if the limit is exceeded. |
1979 | |
2065 | |
1980 | This is a very bad function to use in interactive programs because it |
2066 | This is a bad function to use in interactive programs because it blocks, |
1981 | blocks, and a bad way to reduce concurrency because it is inexact: Better |
2067 | and a bad way to reduce concurrency because it is inexact. If you need to |
|
|
2068 | issue many requests without being able to call a poll function on demand, |
1982 | use an C<aio_group> together with a feed callback. |
2069 | it is better to use an C<aio_group> together with a feed callback. |
1983 | |
2070 | |
1984 | Its main use is in scripts without an event loop - when you want to stat |
2071 | Its main use is in scripts without an event loop - when you want to stat a |
1985 | a lot of files, you can write something like this: |
2072 | lot of files, you can write something like this: |
1986 | |
2073 | |
1987 | IO::AIO::max_outstanding 32; |
2074 | IO::AIO::max_outstanding 32; |
1988 | |
2075 | |
1989 | for my $path (...) { |
2076 | for my $path (...) { |
1990 | aio_stat $path , ...; |
2077 | aio_stat $path , ...; |
1991 | IO::AIO::poll_cb; |
2078 | IO::AIO::poll_cb; |
1992 | } |
2079 | } |
1993 | |
2080 | |
1994 | IO::AIO::flush; |
2081 | IO::AIO::flush; |
1995 | |
2082 | |
1996 | The call to C<poll_cb> inside the loop will normally return instantly, but |
2083 | The call to C<poll_cb> inside the loop will normally return instantly, |
1997 | as soon as more thna C<32> reqeusts are in-flight, it will block until |
2084 | allowing the loop to progress, but as soon as more than C<32> requests |
1998 | some requests have been handled. This keeps the loop from pushing a large |
2085 | are in-flight, it will block until some requests have been handled. This |
1999 | number of C<aio_stat> requests onto the queue. |
2086 | keeps the loop from pushing a large number of C<aio_stat> requests onto |
|
|
2087 | the queue (which, with many paths to stat, can use up a lot of memory). |
2000 | |
2088 | |
2001 | The default value for C<max_outstanding> is very large, so there is no |
2089 | The default value for C<max_outstanding> is very large, so there is no |
2002 | practical limit on the number of outstanding requests. |
2090 | practical limit on the number of outstanding requests. |
2003 | |
2091 | |
2004 | =back |
2092 | =back |
… | |
… | |
2063 | for times around now - see the I<nsec> function family, below, for full |
2151 | for times around now - see the I<nsec> function family, below, for full |
2064 | accuracy. |
2152 | accuracy. |
2065 | |
2153 | |
2066 | File birth time is only available when the OS and perl support it (on |
2154 | File birth time is only available when the OS and perl support it (on |
2067 | FreeBSD and NetBSD at the time of this writing, although support is |
2155 | FreeBSD and NetBSD at the time of this writing, although support is |
2068 | adaptive, so if your OS/perl gains support, IO::AIO can take avdantage of |
2156 | adaptive, so if your OS/perl gains support, IO::AIO can take advantage of |
2069 | it). On systems where it isn't available, C<0> is currently returned, but |
2157 | it). On systems where it isn't available, C<0> is currently returned, but |
2070 | this might change to C<undef> in a future version. |
2158 | this might change to C<undef> in a future version. |
2071 | |
2159 | |
2072 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
2160 | =item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime |
2073 | |
2161 | |
… | |
… | |
2134 | |
2222 | |
2135 | =over 4 |
2223 | =over 4 |
2136 | |
2224 | |
2137 | =item $numfd = IO::AIO::get_fdlimit |
2225 | =item $numfd = IO::AIO::get_fdlimit |
2138 | |
2226 | |
2139 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2140 | |
|
|
2141 | Tries to find the current file descriptor limit and returns it, or |
2227 | Tries to find the current file descriptor limit and returns it, or |
2142 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
2228 | C<undef> and sets C<$!> in case of an error. The limit is one larger than |
2143 | the highest valid file descriptor number. |
2229 | the highest valid file descriptor number. |
2144 | |
2230 | |
2145 | =item IO::AIO::min_fdlimit [$numfd] |
2231 | =item IO::AIO::min_fdlimit [$numfd] |
2146 | |
|
|
2147 | This function is I<EXPERIMENTAL> and subject to change. |
|
|
2148 | |
2232 | |
2149 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
2233 | Try to increase the current file descriptor limit(s) to at least C<$numfd> |
2150 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
2234 | by changing the soft or hard file descriptor resource limit. If C<$numfd> |
2151 | is missing, it will try to set a very high limit, although this is not |
2235 | is missing, it will try to set a very high limit, although this is not |
2152 | recommended when you know the actual minimum that you require. |
2236 | recommended when you know the actual minimum that you require. |
… | |
… | |
2247 | C<IO::AIO::MAP_POPULATE>, |
2331 | C<IO::AIO::MAP_POPULATE>, |
2248 | C<IO::AIO::MAP_NONBLOCK>, |
2332 | C<IO::AIO::MAP_NONBLOCK>, |
2249 | C<IO::AIO::MAP_FIXED>, |
2333 | C<IO::AIO::MAP_FIXED>, |
2250 | C<IO::AIO::MAP_GROWSDOWN>, |
2334 | C<IO::AIO::MAP_GROWSDOWN>, |
2251 | C<IO::AIO::MAP_32BIT>, |
2335 | C<IO::AIO::MAP_32BIT>, |
2252 | C<IO::AIO::MAP_HUGETLB> or |
2336 | C<IO::AIO::MAP_HUGETLB>, |
2253 | C<IO::AIO::MAP_STACK>. |
2337 | C<IO::AIO::MAP_STACK>, |
|
|
2338 | C<IO::AIO::MAP_FIXED_NOREPLACE>, |
|
|
2339 | C<IO::AIO::MAP_SHARED_VALIDATE>, |
|
|
2340 | C<IO::AIO::MAP_SYNC> or |
|
|
2341 | C<IO::AIO::MAP_UNINITIALIZED>. |
2254 | |
2342 | |
2255 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
2343 | If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed. |
2256 | |
2344 | |
2257 | C<$offset> is the offset from the start of the file - it generally must be |
2345 | C<$offset> is the offset from the start of the file - it generally must be |
2258 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
2346 | a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>. |
… | |
… | |
2295 | implemented, but not supported and might go away in a future version. |
2383 | implemented, but not supported and might go away in a future version. |
2296 | |
2384 | |
2297 | On systems where this call is not supported or is not emulated, this call |
2385 | On systems where this call is not supported or is not emulated, this call |
2298 | returns falls and sets C<$!> to C<ENOSYS>. |
2386 | returns falls and sets C<$!> to C<ENOSYS>. |
2299 | |
2387 | |
|
|
2388 | =item IO::AIO::mlockall $flags |
|
|
2389 | |
|
|
2390 | Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>, |
|
|
2391 | but is blocking. |
|
|
2392 | |
2300 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2393 | =item IO::AIO::munlock $scalar, $offset = 0, $length = undef |
2301 | |
2394 | |
2302 | Calls the C<munlock> function, undoing the effects of a previous |
2395 | Calls the C<munlock> function, undoing the effects of a previous |
2303 | C<aio_mlock> call (see its description for details). |
2396 | C<aio_mlock> call (see its description for details). |
2304 | |
2397 | |
… | |
… | |
2306 | |
2399 | |
2307 | Calls the C<munlockall> function. |
2400 | Calls the C<munlockall> function. |
2308 | |
2401 | |
2309 | On systems that do not implement C<munlockall>, this function returns |
2402 | On systems that do not implement C<munlockall>, this function returns |
2310 | ENOSYS, otherwise the return value of C<munlockall>. |
2403 | ENOSYS, otherwise the return value of C<munlockall>. |
|
|
2404 | |
|
|
2405 | =item $fh = IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_maxlen, $flags |
|
|
2406 | |
|
|
2407 | Uses the GNU/Linux C<accept4(2)> syscall, if available, to accept a socket |
|
|
2408 | and return the new file handle on success, or sets C<$!> and returns |
|
|
2409 | C<undef> on error. |
|
|
2410 | |
|
|
2411 | The remote name of the new socket will be stored in C<$sockaddr>, which |
|
|
2412 | will be extended to allow for at least C<$sockaddr_maxlen> octets. If the |
|
|
2413 | socket name does not fit into C<$sockaddr_maxlen> octets, this is signaled |
|
|
2414 | by returning a longer string in C<$sockaddr>, which might or might not be |
|
|
2415 | truncated. |
|
|
2416 | |
|
|
2417 | To accept name-less sockets, use C<undef> for C<$sockaddr> and C<0> for |
|
|
2418 | C<$sockaddr_maxlen>. |
|
|
2419 | |
|
|
2420 | The main reasons to use this syscall rather than portable C<accept(2)> |
|
|
2421 | are that you can specify C<SOCK_NONBLOCK> and/or C<SOCK_CLOEXEC> |
|
|
2422 | flags and you can accept name-less sockets by specifying C<0> for |
|
|
2423 | C<$sockaddr_maxlen>, which is sadly not possible with perl's interface to |
|
|
2424 | C<accept>. |
2311 | |
2425 | |
2312 | =item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
2426 | =item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags |
2313 | |
2427 | |
2314 | Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or |
2428 | Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or |
2315 | C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they |
2429 | C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they |
… | |
… | |
2359 | Example: create a pipe race-free w.r.t. threads and fork: |
2473 | Example: create a pipe race-free w.r.t. threads and fork: |
2360 | |
2474 | |
2361 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
2475 | my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC |
2362 | or die "pipe2: $!\n"; |
2476 | or die "pipe2: $!\n"; |
2363 | |
2477 | |
|
|
2478 | =item $fh = IO::AIO::memfd_create $pathname[, $flags] |
|
|
2479 | |
|
|
2480 | This is a direct interface to the Linux L<memfd_create(2)> system |
|
|
2481 | call. The (unhelpful) default for C<$flags> is C<0>, but your default |
|
|
2482 | should be C<IO::AIO::MFD_CLOEXEC>. |
|
|
2483 | |
|
|
2484 | On success, the new memfd filehandle is returned, otherwise returns |
|
|
2485 | C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>. |
|
|
2486 | |
|
|
2487 | Please refer to L<memfd_create(2)> for more info on this call. |
|
|
2488 | |
|
|
2489 | The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>, |
|
|
2490 | C<IO::AIO::MFD_ALLOW_SEALING>, C<IO::AIO::MFD_HUGETLB>, |
|
|
2491 | C<IO::AIO::MFD_HUGETLB_2MB> and C<IO::AIO::MFD_HUGETLB_1GB>. |
|
|
2492 | |
|
|
2493 | Example: create a new memfd. |
|
|
2494 | |
|
|
2495 | my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC |
|
|
2496 | or die "memfd_create: $!\n"; |
|
|
2497 | |
|
|
2498 | =item $fh = IO::AIO::pidfd_open $pid[, $flags] |
|
|
2499 | |
|
|
2500 | This is an interface to the Linux L<pidfd_open(2)> system call. The |
|
|
2501 | default for C<$flags> is C<0>. |
|
|
2502 | |
|
|
2503 | On success, a new pidfd filehandle is returned (that is already set to |
|
|
2504 | close-on-exec), otherwise returns C<undef>. If the syscall is missing, |
|
|
2505 | fails with C<ENOSYS>. |
|
|
2506 | |
|
|
2507 | Example: open pid 6341 as pidfd. |
|
|
2508 | |
|
|
2509 | my $fh = IO::AIO::pidfd_open 6341 |
|
|
2510 | or die "pidfd_open: $!\n"; |
|
|
2511 | |
|
|
2512 | =item $status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[, $flags]] |
|
|
2513 | |
|
|
2514 | This is an interface to the Linux L<pidfd_send_signal> system call. The |
|
|
2515 | default for C<$siginfo> is C<undef> and the default for C<$flags> is C<0>. |
|
|
2516 | |
|
|
2517 | Returns the system call status. If the syscall is missing, fails with |
|
|
2518 | C<ENOSYS>. |
|
|
2519 | |
|
|
2520 | When specified, C<$siginfo> must be a reference to a hash with one or more |
|
|
2521 | of the following members: |
|
|
2522 | |
|
|
2523 | =over |
|
|
2524 | |
|
|
2525 | =item code - the C<si_code> member |
|
|
2526 | |
|
|
2527 | =item pid - the C<si_pid> member |
|
|
2528 | |
|
|
2529 | =item uid - the C<si_uid> member |
|
|
2530 | |
|
|
2531 | =item value_int - the C<si_value.sival_int> member |
|
|
2532 | |
|
|
2533 | =item value_ptr - the C<si_value.sival_ptr> member, specified as an integer |
|
|
2534 | |
|
|
2535 | =back |
|
|
2536 | |
|
|
2537 | Example: send a SIGKILL to the specified process. |
|
|
2538 | |
|
|
2539 | my $status = IO::AIO::pidfd_send_signal $pidfh, 9, undef |
|
|
2540 | and die "pidfd_send_signal: $!\n"; |
|
|
2541 | |
|
|
2542 | Example: send a SIGKILL to the specified process with extra data. |
|
|
2543 | |
|
|
2544 | my $status = IO::AIO::pidfd_send_signal $pidfh, 9, { code => -1, value_int => 7 } |
|
|
2545 | and die "pidfd_send_signal: $!\n"; |
|
|
2546 | |
|
|
2547 | =item $fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags] |
|
|
2548 | |
|
|
2549 | This is an interface to the Linux L<pidfd_getfd> system call. The default |
|
|
2550 | for C<$flags> is C<0>. |
|
|
2551 | |
|
|
2552 | On success, returns a dup'ed copy of the target file descriptor (specified |
|
|
2553 | as an integer) returned (that is already set to close-on-exec), otherwise |
|
|
2554 | returns C<undef>. If the syscall is missing, fails with C<ENOSYS>. |
|
|
2555 | |
|
|
2556 | Example: get a copy of standard error of another process and print soemthing to it. |
|
|
2557 | |
|
|
2558 | my $errfh = IO::AIO::pidfd_getfd $pidfh, 2 |
|
|
2559 | or die "pidfd_getfd: $!\n"; |
|
|
2560 | print $errfh "stderr\n"; |
|
|
2561 | |
2364 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
2562 | =item $fh = IO::AIO::eventfd [$initval, [$flags]] |
2365 | |
2563 | |
2366 | This is a direct interface to the Linux L<eventfd(2)> system call. The |
2564 | This is a direct interface to the Linux L<eventfd(2)> system call. The |
2367 | (unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both. |
2565 | (unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both. |
2368 | |
2566 | |
… | |
… | |
2374 | The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, |
2572 | The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>, |
2375 | C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). |
2573 | C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30). |
2376 | |
2574 | |
2377 | Example: create a new eventfd filehandle: |
2575 | Example: create a new eventfd filehandle: |
2378 | |
2576 | |
2379 | $fh = IO::AIO::eventfd 0, IO::AIO::O_CLOEXEC |
2577 | $fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC |
2380 | or die "eventfd: $!\n"; |
2578 | or die "eventfd: $!\n"; |
2381 | |
2579 | |
2382 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
2580 | =item $fh = IO::AIO::timerfd_create $clockid[, $flags] |
2383 | |
2581 | |
2384 | This is a direct interface to the Linux L<timerfd_create(2)> system call. The |
2582 | This is a direct interface to the Linux L<timerfd_create(2)> system |
2385 | (unhelpful) default for C<$flags> is C<0>. |
2583 | call. The (unhelpful) default for C<$flags> is C<0>, but your default |
|
|
2584 | should be C<IO::AIO::TFD_CLOEXEC>. |
2386 | |
2585 | |
2387 | On success, the new timerfd filehandle is returned, otherwise returns |
2586 | On success, the new timerfd filehandle is returned, otherwise returns |
2388 | C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>. |
2587 | C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>. |
2389 | |
2588 | |
2390 | Please refer to L<timerfd_create(2)> for more info on this call. |
2589 | Please refer to L<timerfd_create(2)> for more info on this call. |
2391 | |
2590 | |
2392 | The following C<$clockid> values are |
2591 | The following C<$clockid> values are |
2393 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |
2592 | available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC> |
… | |
… | |
2559 | known issue, rather than a bug. |
2758 | known issue, rather than a bug. |
2560 | |
2759 | |
2561 | =head1 SEE ALSO |
2760 | =head1 SEE ALSO |
2562 | |
2761 | |
2563 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2762 | L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a |
2564 | more natural syntax. |
2763 | more natural syntax and L<IO::FDPass> for file descriptor passing. |
2565 | |
2764 | |
2566 | =head1 AUTHOR |
2765 | =head1 AUTHOR |
2567 | |
2766 | |
2568 | Marc Lehmann <schmorp@schmorp.de> |
2767 | Marc Lehmann <schmorp@schmorp.de> |
2569 | http://home.schmorp.de/ |
2768 | http://home.schmorp.de/ |