[ViewVC] Diff of: cvs/IO-AIO/AIO.pm

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.263 by root, Tue Jul 12 20:46:33 2016 UTC vs.
Revision 1.318 by root, Sat Apr 1 02:14:05 2023 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	IO::AIO - Asynchronous Input/Output	3	IO::AIO - Asynchronous/Advanced Input/Output
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use IO::AIO;	7	use IO::AIO;
8		8
58	not well-supported or restricted (GNU/Linux doesn't allow them on normal	58	not well-supported or restricted (GNU/Linux doesn't allow them on normal
59	files currently, for example), and they would only support aio_read and	59	files currently, for example), and they would only support aio_read and
60	aio_write, so the remaining functionality would have to be implemented	60	aio_write, so the remaining functionality would have to be implemented
61	using threads anyway.	61	using threads anyway.
62		62
		63	In addition to asynchronous I/O, this module also exports some rather
		64	arcane interfaces, such as C<madvise> or linux's C<splice> system call,
		65	which is why the C<A> in C<AIO> can also mean I<advanced>.
		66
63	Although the module will work in the presence of other (Perl-) threads,	67	Although the module will work in the presence of other (Perl-) threads,
64	it is currently not reentrant in any way, so use appropriate locking	68	it is currently not reentrant in any way, so use appropriate locking
65	yourself, always call C<poll_cb> from within the same thread, or never	69	yourself, always call C<poll_cb> from within the same thread, or never
66	call C<poll_cb> (or other C<aio_> functions) recursively.	70	call C<poll_cb> (or other C<aio_> functions) recursively.
67		71
…		…
167	use common::sense;	171	use common::sense;
168		172
169	use base 'Exporter';	173	use base 'Exporter';
170		174
171	BEGIN {	175	BEGIN {
172	our $VERSION = 4.34;	176	our $VERSION = 4.80;
173		177
174	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
175	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
176	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
177	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
178	aio_pathsync aio_readahead aio_fiemap aio_allocate	182	aio_pathsync aio_readahead aio_fiemap aio_allocate
179	aio_rename aio_link aio_move aio_copy aio_group	183	aio_rename aio_rename2 aio_link aio_move aio_copy aio_group
180	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown	184	aio_nop aio_mknod aio_load aio_rmtree aio_mkdir aio_chown
181	aio_chmod aio_utime aio_truncate	185	aio_chmod aio_utime aio_truncate
182	aio_msync aio_mtouch aio_mlock aio_mlockall	186	aio_msync aio_mtouch aio_mlock aio_mlockall
183	aio_statvfs	187	aio_statvfs
		188	aio_slurp
184	aio_wd);	189	aio_wd);
185		190
186	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));	191	our @EXPORT = (@AIO_REQ, qw(aioreq_pri aioreq_nice));
187	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush	192	our @EXPORT_OK = qw(poll_fileno poll_cb poll_wait flush
188	min_parallel max_parallel max_idle idle_timeout	193	min_parallel max_parallel max_idle idle_timeout
189	nreqs nready npending nthreads	194	nreqs nready npending nthreads
190	max_poll_time max_poll_reqs	195	max_poll_time max_poll_reqs
191	sendfile fadvise madvise	196	sendfile fadvise madvise
192	mmap munmap munlock munlockall);	197	mmap munmap mremap munlock munlockall
		198
		199	accept4 tee splice pipe2 pipesize
		200	fexecve mount umount memfd_create eventfd
		201	timerfd_create timerfd_settime timerfd_gettime
		202	pidfd_open pidfd_send_signal pidfd_getfd);
193		203
194	push @AIO_REQ, qw(aio_busy); # not exported	204	push @AIO_REQ, qw(aio_busy); # not exported
195		205
196	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';	206	@IO::AIO::GRP::ISA = 'IO::AIO::REQ';
197		207
…		…
229	aio_link $srcpath, $dstpath, $callback->($status)	239	aio_link $srcpath, $dstpath, $callback->($status)
230	aio_symlink $srcpath, $dstpath, $callback->($status)	240	aio_symlink $srcpath, $dstpath, $callback->($status)
231	aio_readlink $pathname, $callback->($link)	241	aio_readlink $pathname, $callback->($link)
232	aio_realpath $pathname, $callback->($path)	242	aio_realpath $pathname, $callback->($path)
233	aio_rename $srcpath, $dstpath, $callback->($status)	243	aio_rename $srcpath, $dstpath, $callback->($status)
		244	aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
234	aio_mkdir $pathname, $mode, $callback->($status)	245	aio_mkdir $pathname, $mode, $callback->($status)
235	aio_rmdir $pathname, $callback->($status)	246	aio_rmdir $pathname, $callback->($status)
236	aio_readdir $pathname, $callback->($entries)	247	aio_readdir $pathname, $callback->($entries)
237	aio_readdirx $pathname, $flags, $callback->($entries, $flags)	248	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
238	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST	249	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
…		…
248	aio_syncfs $fh, $callback->($status)	259	aio_syncfs $fh, $callback->($status)
249	aio_fsync $fh, $callback->($status)	260	aio_fsync $fh, $callback->($status)
250	aio_fdatasync $fh, $callback->($status)	261	aio_fdatasync $fh, $callback->($status)
251	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)	262	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
252	aio_pathsync $pathname, $callback->($status)	263	aio_pathsync $pathname, $callback->($status)
253	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	264	aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
254	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	265	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
255	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	266	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
256	aio_mlockall $flags, $callback->($status)	267	aio_mlockall $flags, $callback->($status)
257	aio_group $callback->(...)	268	aio_group $callback->(...)
258	aio_nop $callback->()	269	aio_nop $callback->()
…		…
272	IO::AIO::idle_timeout $seconds	283	IO::AIO::idle_timeout $seconds
273	IO::AIO::max_outstanding $maxreqs	284	IO::AIO::max_outstanding $maxreqs
274	IO::AIO::nreqs	285	IO::AIO::nreqs
275	IO::AIO::nready	286	IO::AIO::nready
276	IO::AIO::npending	287	IO::AIO::npending
		288	IO::AIO::reinit
		289
		290	$nfd = IO::AIO::get_fdlimit
		291	IO::AIO::min_fdlimit $nfd
277		292
278	IO::AIO::sendfile $ofh, $ifh, $offset, $count	293	IO::AIO::sendfile $ofh, $ifh, $offset, $count
279	IO::AIO::fadvise $fh, $offset, $len, $advice	294	IO::AIO::fadvise $fh, $offset, $len, $advice
		295	IO::AIO::fexecve $fh, $argv, $envp
		296
280	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]	297	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
281	IO::AIO::munmap $scalar	298	IO::AIO::munmap $scalar
		299	IO::AIO::mremap $scalar, $new_length, $flags[, $new_address]
282	IO::AIO::madvise $scalar, $offset, $length, $advice	300	IO::AIO::madvise $scalar, $offset, $length, $advice
283	IO::AIO::mprotect $scalar, $offset, $length, $protect	301	IO::AIO::mprotect $scalar, $offset, $length, $protect
284	IO::AIO::munlock $scalar, $offset = 0, $length = undef	302	IO::AIO::munlock $scalar, $offset = 0, $length = undef
285	IO::AIO::munlockall	303	IO::AIO::munlockall
		304
		305	# stat extensions
		306	$counter = IO::AIO::st_gen
		307	$seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
		308	($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
		309	$nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
		310	$seconds = IO::AIO::st_btimesec
		311	($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
		312
		313	# very much unportable syscalls
		314	IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_len, $flags
		315	IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		316	IO::AIO::tee $r_fh, $w_fh, $length, $flags
		317
		318	$actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		319	($rfh, $wfh) = IO::AIO::pipe2 [$flags]
		320
		321	$fh = IO::AIO::eventfd [$initval, [$flags]]
		322	$fh = IO::AIO::memfd_create $pathname[, $flags]
		323
		324	$fh = IO::AIO::timerfd_create $clockid[, $flags]
		325	($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
		326	($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
		327
		328	$fh = IO::AIO::pidfd_open $pid[, $flags]
		329	$status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[, $flags]]
		330	$fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags]
		331
		332	$retval = IO::AIO::mount $special, $path, $fstype, $flags = 0, $data = undef
		333	$retval = IO::AIO::umount $path, $flags = 0
286		334
287	=head2 API NOTES	335	=head2 API NOTES
288		336
289	All the C<aio_*> calls are more or less thin wrappers around the syscall	337	All the C<aio_*> calls are more or less thin wrappers around the syscall
290	with the same name (sans C<aio_>). The arguments are similar or identical,	338	with the same name (sans C<aio_>). The arguments are similar or identical,
…		…
365	=item aio_open $pathname, $flags, $mode, $callback->($fh)	413	=item aio_open $pathname, $flags, $mode, $callback->($fh)
366		414
367	Asynchronously open or create a file and call the callback with a newly	415	Asynchronously open or create a file and call the callback with a newly
368	created filehandle for the file (or C<undef> in case of an error).	416	created filehandle for the file (or C<undef> in case of an error).
369		417
370	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
371	for an explanation.
372
373	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a	418	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
374	list. They are the same as used by C<sysopen>.	419	list. They are the same as used by C<sysopen>.
375		420
376	Likewise, C<$mode> specifies the mode of the newly created file, if it	421	Likewise, C<$mode> specifies the mode of the newly created file, if it
377	didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,	422	didn't exist and C<O_CREAT> has been given, just like perl's C<sysopen>,
…		…
396	following POSIX and non-POSIX constants are available (missing ones on	441	following POSIX and non-POSIX constants are available (missing ones on
397	your system are, as usual, C<0>):	442	your system are, as usual, C<0>):
398		443
399	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,	444	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
400	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,	445	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
401	C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>.	446	C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, C<O_TTY_INIT> and C<O_ACCMODE>.
402		447
403		448
404	=item aio_close $fh, $callback->($status)	449	=item aio_close $fh, $callback->($status)
405		450
406	Asynchronously close a file and call the callback with the result	451	Asynchronously close a file and call the callback with the result
…		…
441	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	486	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
442		487
443	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	488	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
444		489
445	Reads or writes C<$length> bytes from or to the specified C<$fh> and	490	Reads or writes C<$length> bytes from or to the specified C<$fh> and
446	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>	491	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset> and
447	and calls the callback without the actual number of bytes read (or -1 on	492	calls the callback with the actual number of bytes transferred (or -1 on
448	error, just like the syscall).	493	error, just like the syscall).
449		494
450	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to	495	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
451	offset plus the actual number of bytes read.	496	offset plus the actual number of bytes read.
452		497
…		…
532		577
533	=item aio_stat $fh_or_path, $callback->($status)	578	=item aio_stat $fh_or_path, $callback->($status)
534		579
535	=item aio_lstat $fh, $callback->($status)	580	=item aio_lstat $fh, $callback->($status)
536		581
537	Works like perl's C<stat> or C<lstat> in void context. The callback will	582	Works almost exactly like perl's C<stat> or C<lstat> in void context. The
538	be called after the stat and the results will be available using C<stat _>	583	callback will be called after the stat and the results will be available
539	or C<-s _> etc...	584	using C<stat _> or C<-s _> and other tests (with the exception of C<-B>
540		585	and C<-T>).
541	The pathname passed to C<aio_stat> must be absolute. See API NOTES, above,
542	for an explanation.
543		586
544	Currently, the stats are always 64-bit-stats, i.e. instead of returning an	587	Currently, the stats are always 64-bit-stats, i.e. instead of returning an
545	error when stat'ing a large file, the results will be silently truncated	588	error when stat'ing a large file, the results will be silently truncated
546	unless perl itself is compiled with large file support.	589	unless perl itself is compiled with large file support.
547		590
…		…
551	behaviour).	594	behaviour).
552		595
553	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,	596	C<S_IFMT>, C<S_IFIFO>, C<S_IFCHR>, C<S_IFBLK>, C<S_IFLNK>, C<S_IFREG>,
554	C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,	597	C<S_IFDIR>, C<S_IFWHT>, C<S_IFSOCK>, C<IO::AIO::major $dev_t>,
555	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.	598	C<IO::AIO::minor $dev_t>, C<IO::AIO::makedev $major, $minor>.
		599
		600	To access higher resolution stat timestamps, see L<SUBSECOND STAT TIME
		601	ACCESS>.
556		602
557	Example: Print the length of F</etc/passwd>:	603	Example: Print the length of F</etc/passwd>:
558		604
559	aio_stat "/etc/passwd", sub {	605	aio_stat "/etc/passwd", sub {
560	$_[0] and die "stat failed: $!";	606	$_[0] and die "stat failed: $!";
…		…
604	namemax => 255,	650	namemax => 255,
605	frsize => 1024,	651	frsize => 1024,
606	fsid => 1810	652	fsid => 1810
607	}	653	}
608		654
609	Here is a (likely partial - send me updates!) list of fsid values used by
610	Linux - it is safe to hardcode these when C<$^O> is C<linux>:
611
612	0x0000adf5 adfs
613	0x0000adff affs
614	0x5346414f afs
615	0x09041934 anon-inode filesystem
616	0x00000187 autofs
617	0x42465331 befs
618	0x1badface bfs
619	0x42494e4d binfmt_misc
620	0x9123683e btrfs
621	0x0027e0eb cgroupfs
622	0xff534d42 cifs
623	0x73757245 coda
624	0x012ff7b7 coh
625	0x28cd3d45 cramfs
626	0x453dcd28 cramfs-wend (wrong endianness)
627	0x64626720 debugfs
628	0x00001373 devfs
629	0x00001cd1 devpts
630	0x0000f15f ecryptfs
631	0x00414a53 efs
632	0x0000137d ext
633	0x0000ef53 ext2/ext3/ext4
634	0x0000ef51 ext2
635	0xf2f52010 f2fs
636	0x00004006 fat
637	0x65735546 fuseblk
638	0x65735543 fusectl
639	0x0bad1dea futexfs
640	0x01161970 gfs2
641	0x47504653 gpfs
642	0x00004244 hfs
643	0xf995e849 hpfs
644	0x00c0ffee hostfs
645	0x958458f6 hugetlbfs
646	0x2bad1dea inotifyfs
647	0x00009660 isofs
648	0x000072b6 jffs2
649	0x3153464a jfs
650	0x6b414653 k-afs
651	0x0bd00bd0 lustre
652	0x0000137f minix
653	0x0000138f minix 30 char names
654	0x00002468 minix v2
655	0x00002478 minix v2 30 char names
656	0x00004d5a minix v3
657	0x19800202 mqueue
658	0x00004d44 msdos
659	0x0000564c novell
660	0x00006969 nfs
661	0x6e667364 nfsd
662	0x00003434 nilfs
663	0x5346544e ntfs
664	0x00009fa1 openprom
665	0x7461636F ocfs2
666	0x00009fa0 proc
667	0x6165676c pstorefs
668	0x0000002f qnx4
669	0x68191122 qnx6
670	0x858458f6 ramfs
671	0x52654973 reiserfs
672	0x00007275 romfs
673	0x67596969 rpc_pipefs
674	0x73636673 securityfs
675	0xf97cff8c selinux
676	0x0000517b smb
677	0x534f434b sockfs
678	0x73717368 squashfs
679	0x62656572 sysfs
680	0x012ff7b6 sysv2
681	0x012ff7b5 sysv4
682	0x01021994 tmpfs
683	0x15013346 udf
684	0x00011954 ufs
685	0x54190100 ufs byteswapped
686	0x00009fa2 usbdevfs
687	0x01021997 v9fs
688	0xa501fcf5 vxfs
689	0xabba1974 xenfs
690	0x012ff7b4 xenix
691	0x58465342 xfs
692	0x012fd16d xia
693
694	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	655	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
695		656
696	Works like perl's C<utime> function (including the special case of $atime	657	Works like perl's C<utime> function (including the special case of $atime
697	and $mtime being undef). Fractional times are supported if the underlying	658	and $mtime being undef). Fractional times are supported if the underlying
698	syscalls support them.	659	syscalls support them.
699		660
700	When called with a pathname, uses utimes(2) if available, otherwise	661	When called with a pathname, uses utimensat(2) or utimes(2) if available,
701	utime(2). If called on a file descriptor, uses futimes(2) if available,	662	otherwise utime(2). If called on a file descriptor, uses futimens(2)
702	otherwise returns ENOSYS, so this is not portable.	663	or futimes(2) if available, otherwise returns ENOSYS, so this is not
		664	portable.
703		665
704	Examples:	666	Examples:
705		667
706	# set atime and mtime to current time (basically touch(1)):	668	# set atime and mtime to current time (basically touch(1)):
707	aio_utime "path", undef, undef;	669	aio_utime "path", undef, undef;
…		…
735	C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate	697	C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
736	space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \| IO::AIO::FALLOC_FL_KEEP_SIZE>,	698	space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \| IO::AIO::FALLOC_FL_KEEP_SIZE>,
737	to deallocate a file range.	699	to deallocate a file range.
738		700
739	IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range	701	IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
740	(without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see	702	(without leaving a hole), C<FALLOC_FL_ZERO_RANGE>, to zero a range,
741	your L<fallocate(2)> manpage).	703	C<FALLOC_FL_INSERT_RANGE> to insert a range and C<FALLOC_FL_UNSHARE_RANGE>
		704	to unshare shared blocks (see your L<fallocate(2)> manpage).
742		705
743	The file system block size used by C<fallocate> is presumably the	706	The file system block size used by C<fallocate> is presumably the
744	C<f_bsize> returned by C<statvfs>.	707	C<f_bsize> returned by C<statvfs>, but different filesystems and filetypes
		708	can dictate other limitations.
745		709
746	If C<fallocate> isn't available or cannot be emulated (currently no	710	If C<fallocate> isn't available or cannot be emulated (currently no
747	emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.	711	emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
748		712
749		713
…		…
808	On systems that support the AIO::WD working directory abstraction	772	On systems that support the AIO::WD working directory abstraction
809	natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead	773	natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
810	of failing, C<rename> is called on the absolute path of C<$wd>.	774	of failing, C<rename> is called on the absolute path of C<$wd>.
811		775
812		776
		777	=item aio_rename2 $srcpath, $dstpath, $flags, $callback->($status)
		778
		779	Basically a version of C<aio_rename> with an additional C<$flags>
		780	argument. Calling this with C<$flags=0> is the same as calling
		781	C<aio_rename>.
		782
		783	Non-zero flags are currently only supported on GNU/Linux systems that
		784	support renameat2. Other systems fail with C<ENOSYS> in this case.
		785
		786	The following constants are available (missing ones are, as usual C<0>),
		787	see renameat2(2) for details:
		788
		789	C<IO::AIO::RENAME_NOREPLACE>, C<IO::AIO::RENAME_EXCHANGE>
		790	and C<IO::AIO::RENAME_WHITEOUT>.
		791
		792
813	=item aio_mkdir $pathname, $mode, $callback->($status)	793	=item aio_mkdir $pathname, $mode, $callback->($status)
814		794
815	Asynchronously mkdir (create) a directory and call the callback with	795	Asynchronously mkdir (create) a directory and call the callback with
816	the result code. C<$mode> will be modified by the umask at the time the	796	the result code. C<$mode> will be modified by the umask at the time the
817	request is executed, so do not change your umask.	797	request is executed, so do not change your umask.
…		…
848		828
849	=over 4	829	=over 4
850		830
851	=item IO::AIO::READDIR_DENTS	831	=item IO::AIO::READDIR_DENTS
852		832
853	When this flag is off, then the callback gets an arrayref consisting of	833	Normally the callback gets an arrayref consisting of names only (as
854	names only (as with C<aio_readdir>), otherwise it gets an arrayref with	834	with C<aio_readdir>). If this flag is set, then the callback gets an
855	C<[$name, $type, $inode]> arrayrefs, each describing a single directory	835	arrayref with C<[$name, $type, $inode]> arrayrefs, each describing a
856	entry in more detail.	836	single directory entry in more detail:
857		837
858	C<$name> is the name of the entry.	838	C<$name> is the name of the entry.
859		839
860	C<$type> is one of the C<IO::AIO::DT_xxx> constants:	840	C<$type> is one of the C<IO::AIO::DT_xxx> constants:
861		841
862	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,	842	C<IO::AIO::DT_UNKNOWN>, C<IO::AIO::DT_FIFO>, C<IO::AIO::DT_CHR>, C<IO::AIO::DT_DIR>,
863	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,	843	C<IO::AIO::DT_BLK>, C<IO::AIO::DT_REG>, C<IO::AIO::DT_LNK>, C<IO::AIO::DT_SOCK>,
864	C<IO::AIO::DT_WHT>.	844	C<IO::AIO::DT_WHT>.
865		845
866	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need to	846	C<IO::AIO::DT_UNKNOWN> means just that: readdir does not know. If you need
867	know, you have to run stat yourself. Also, for speed reasons, the C<$type>	847	to know, you have to run stat yourself. Also, for speed/memory reasons,
868	scalars are read-only: you can not modify them.	848	the C<$type> scalars are read-only: you must not modify them.
869		849
870	C<$inode> is the inode number (which might not be exact on systems with 64	850	C<$inode> is the inode number (which might not be exact on systems with 64
871	bit inode numbers and 32 bit perls). This field has unspecified content on	851	bit inode numbers and 32 bit perls). This field has unspecified content on
872	systems that do not deliver the inode information.	852	systems that do not deliver the inode information.
873		853
…		…
884	short names are tried first.	864	short names are tried first.
885		865
886	=item IO::AIO::READDIR_STAT_ORDER	866	=item IO::AIO::READDIR_STAT_ORDER
887		867
888	When this flag is set, then the names will be returned in an order	868	When this flag is set, then the names will be returned in an order
889	suitable for stat()'ing each one. That is, when you plan to stat()	869	suitable for stat()'ing each one. That is, when you plan to stat() most or
890	all files in the given directory, then the returned order will likely	870	all files in the given directory, then the returned order will likely be
891	be fastest.	871	faster.
892		872
893	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified, then	873	If both this flag and C<IO::AIO::READDIR_DIRS_FIRST> are specified,
894	the likely dirs come first, resulting in a less optimal stat order.	874	then the likely dirs come first, resulting in a less optimal stat order
		875	for stat'ing all entries, but likely a more optimal order for finding
		876	subdirectories.
895		877
896	=item IO::AIO::READDIR_FOUND_UNKNOWN	878	=item IO::AIO::READDIR_FOUND_UNKNOWN
897		879
898	This flag should not be set when calling C<aio_readdirx>. Instead, it	880	This flag should not be set when calling C<aio_readdirx>. Instead, it
899	is being set by C<aio_readdirx>, when any of the C<$type>'s found were	881	is being set by C<aio_readdirx>, when any of the C<$type>'s found were
…		…
901	C<$type>'s are known, which can be used to speed up some algorithms.	883	C<$type>'s are known, which can be used to speed up some algorithms.
902		884
903	=back	885	=back
904		886
905		887
		888	=item aio_slurp $pathname, $offset, $length, $data, $callback->($status)
		889
		890	Opens, reads and closes the given file. The data is put into C<$data>,
		891	which is resized as required.
		892
		893	If C<$offset> is negative, then it is counted from the end of the file.
		894
		895	If C<$length> is zero, then the remaining length of the file is
		896	used. Also, in this case, the same limitations to modifying C<$data> apply
		897	as when IO::AIO::mmap is used, i.e. it must only be modified in-place
		898	with C<substr>. If the size of the file is known, specifying a non-zero
		899	C<$length> results in a performance advantage.
		900
		901	This request is similar to the older C<aio_load> request, but since it is
		902	a single request, it might be more efficient to use.
		903
		904	Example: load F</etc/passwd> into C<$passwd>.
		905
		906	my $passwd;
		907	aio_slurp "/etc/passwd", 0, 0, $passwd, sub {
		908	$_[0] >= 0
		909	or die "/etc/passwd: $!\n";
		910
		911	printf "/etc/passwd is %d bytes long, and contains:\n", length $passwd;
		912	print $passwd;
		913	};
		914	IO::AIO::flush;
		915
		916
906	=item aio_load $pathname, $data, $callback->($status)	917	=item aio_load $pathname, $data, $callback->($status)
907		918
908	This is a composite request that tries to fully load the given file into	919	This is a composite request that tries to fully load the given file into
909	memory. Status is the same as with aio_read.	920	memory. Status is the same as with aio_read.
		921
		922	Using C<aio_slurp> might be more efficient, as it is a single request.
910		923
911	=cut	924	=cut
912		925
913	sub aio_load($$;$) {	926	sub aio_load($$;$) {
914	my ($path, undef, $cb) = @_;	927	my ($path, undef, $cb) = @_;
…		…
934	=item aio_copy $srcpath, $dstpath, $callback->($status)	947	=item aio_copy $srcpath, $dstpath, $callback->($status)
935		948
936	Try to copy the I<file> (directories not supported as either source or	949	Try to copy the I<file> (directories not supported as either source or
937	destination) from C<$srcpath> to C<$dstpath> and call the callback with	950	destination) from C<$srcpath> to C<$dstpath> and call the callback with
938	a status of C<0> (ok) or C<-1> (error, see C<$!>).	951	a status of C<0> (ok) or C<-1> (error, see C<$!>).
		952
		953	Existing destination files will be truncated.
939		954
940	This is a composite request that creates the destination file with	955	This is a composite request that creates the destination file with
941	mode 0200 and copies the contents of the source file into it using	956	mode 0200 and copies the contents of the source file into it using
942	C<aio_sendfile>, followed by restoring atime, mtime, access mode and	957	C<aio_sendfile>, followed by restoring atime, mtime, access mode and
943	uid/gid, in that order.	958	uid/gid, in that order.
…		…
1053	Scans a directory (similar to C<aio_readdir>) but additionally tries to	1068	Scans a directory (similar to C<aio_readdir>) but additionally tries to
1054	efficiently separate the entries of directory C<$path> into two sets of	1069	efficiently separate the entries of directory C<$path> into two sets of
1055	names, directories you can recurse into (directories), and ones you cannot	1070	names, directories you can recurse into (directories), and ones you cannot
1056	recurse into (everything else, including symlinks to directories).	1071	recurse into (everything else, including symlinks to directories).
1057		1072
1058	C<aio_scandir> is a composite request that creates of many sub requests_	1073	C<aio_scandir> is a composite request that generates many sub requests.
1059	C<$maxreq> specifies the maximum number of outstanding aio requests that	1074	C<$maxreq> specifies the maximum number of outstanding aio requests that
1060	this function generates. If it is C<< <= 0 >>, then a suitable default	1075	this function generates. If it is C<< <= 0 >>, then a suitable default
1061	will be chosen (currently 4).	1076	will be chosen (currently 4).
1062		1077
1063	On error, the callback is called without arguments, otherwise it receives	1078	On error, the callback is called without arguments, otherwise it receives
…		…
1127	aioreq_pri $pri;	1142	aioreq_pri $pri;
1128	add $grp aio_stat $wd, sub {	1143	add $grp aio_stat $wd, sub {
1129	return $grp->result () if $_[0];	1144	return $grp->result () if $_[0];
1130	my $now = time;	1145	my $now = time;
1131	my $hash1 = join ":", (stat _)[0,1,3,7,9];	1146	my $hash1 = join ":", (stat _)[0,1,3,7,9];
		1147	my $rdxflags = READDIR_DIRS_FIRST;
		1148
		1149	if ((stat _)[3] < 2) {
		1150	# at least one non-POSIX filesystem exists
		1151	# that returns useful DT_type values: btrfs,
		1152	# so optimise for this here by requesting dents
		1153	$rdxflags \|= READDIR_DENTS;
		1154	}
1132		1155
1133	# read the directory entries	1156	# read the directory entries
1134	aioreq_pri $pri;	1157	aioreq_pri $pri;
1135	add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {	1158	add $grp aio_readdirx $wd, $rdxflags, sub {
1136	my $entries = shift	1159	my ($entries, $flags) = @_
1137	or return $grp->result ();	1160	or return $grp->result ();
		1161
		1162	if ($rdxflags & READDIR_DENTS) {
		1163	# if we requested type values, see if we can use them directly.
		1164
		1165	# if there were any DT_UNKNOWN entries then we assume we
		1166	# don't know. alternatively, we could assume that if we get
		1167	# one DT_DIR, then all directories are indeed marked with
		1168	# DT_DIR, but this seems not required for btrfs, and this
		1169	# is basically the "btrfs can't get it's act together" code
		1170	# branch.
		1171	unless ($flags & READDIR_FOUND_UNKNOWN) {
		1172	# now we have valid DT_ information for all entries,
		1173	# so use it as an optimisation without further stat's.
		1174	# they must also all be at the beginning of @$entries
		1175	# by now.
		1176
		1177	my $dirs;
		1178
		1179	if (@$entries) {
		1180	for (0 .. $#$entries) {
		1181	if ($entries->[$_][1] != DT_DIR) {
		1182	# splice out directories
		1183	$dirs = [splice @$entries, 0, $_];
		1184	last;
		1185	}
		1186	}
		1187
		1188	# if we didn't find any non-dir, then all entries are dirs
		1189	unless ($dirs) {
		1190	($dirs, $entries) = ($entries, []);
		1191	}
		1192	} else {
		1193	# directory is empty, so there are no sbdirs
		1194	$dirs = [];
		1195	}
		1196
		1197	# either splice'd the directories out or the dir was empty.
		1198	# convert dents to filenames
		1199	$_ = $_->[0] for @$dirs;
		1200	$_ = $_->[0] for @$entries;
		1201
		1202	return $grp->result ($dirs, $entries);
		1203	}
		1204
		1205	# cannot use, so return to our old ways
		1206	# by pretending we only scanned for names.
		1207	$_ = $_->[0] for @$entries;
		1208	}
1138		1209
1139	# stat the dir another time	1210	# stat the dir another time
1140	aioreq_pri $pri;	1211	aioreq_pri $pri;
1141	add $grp aio_stat $wd, sub {	1212	add $grp aio_stat $wd, sub {
1142	my $hash2 = join ":", (stat _)[0,1,3,7,9];	1213	my $hash2 = join ":", (stat _)[0,1,3,7,9];
…		…
1248	So in general, you should only use these calls for things that do	1319	So in general, you should only use these calls for things that do
1249	(filesystem) I/O, not for things that wait for other events (network,	1320	(filesystem) I/O, not for things that wait for other events (network,
1250	other processes), although if you are careful and know what you are doing,	1321	other processes), although if you are careful and know what you are doing,
1251	you still can.	1322	you still can.
1252		1323
		1324	The following constants are available and can be used for normal C<ioctl>
		1325	and C<fcntl> as well (missing ones are, as usual C<0>):
		1326
		1327	C<F_DUPFD_CLOEXEC>,
		1328
		1329	C<F_OFD_GETLK>, C<F_OFD_SETLK>, C<F_OFD_GETLKW>,
		1330
		1331	C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
		1332
		1333	C<F_ADD_SEALS>, C<F_GET_SEALS>, C<F_SEAL_SEAL>, C<F_SEAL_SHRINK>, C<F_SEAL_GROW> and
		1334	C<F_SEAL_WRITE>.
		1335
		1336	C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
		1337	C<FS_IOC_FIEMAP>.
		1338
		1339	C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
		1340	C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
		1341
		1342	C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
		1343	C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
		1344	C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
		1345	C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
		1346	C<FS_FL_USER_MODIFIABLE>.
		1347
		1348	C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
		1349	C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
		1350	C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
		1351	C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
		1352
		1353	C<BLKROSET>, C<BLKROGET>, C<BLKRRPART>, C<BLKGETSIZE>, C<BLKFLSBUF>, C<BLKRASET>,
		1354	C<BLKRAGET>, C<BLKFRASET>, C<BLKFRAGET>, C<BLKSECTSET>, C<BLKSECTGET>, C<BLKSSZGET>,
		1355	C<BLKBSZGET>, C<BLKBSZSET>, C<BLKGETSIZE64>,
		1356
		1357
1253	=item aio_sync $callback->($status)	1358	=item aio_sync $callback->($status)
1254		1359
1255	Asynchronously call sync and call the callback when finished.	1360	Asynchronously call sync and call the callback when finished.
1256		1361
1257	=item aio_fsync $fh, $callback->($status)	1362	=item aio_fsync $fh, $callback->($status)
…		…
1325	};	1430	};
1326		1431
1327	$grp	1432	$grp
1328	}	1433	}
1329		1434
1330	=item aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	1435	=item aio_msync $scalar, $offset = 0, $length = undef, flags = MS_SYNC, $callback->($status)
1331		1436
1332	This is a rather advanced IO::AIO call, which only works on mmap(2)ed	1437	This is a rather advanced IO::AIO call, which only works on mmap(2)ed
1333	scalars (see the C<IO::AIO::mmap> function, although it also works on data	1438	scalars (see the C<IO::AIO::mmap> function, although it also works on data
1334	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the	1439	scalars managed by the L<Sys::Mmap> or L<Mmap> modules, note that the
1335	scalar must only be modified in-place while an aio operation is pending on	1440	scalar must only be modified in-place while an aio operation is pending on
…		…
1337		1442
1338	It calls the C<msync> function of your OS, if available, with the memory	1443	It calls the C<msync> function of your OS, if available, with the memory
1339	area starting at C<$offset> in the string and ending C<$length> bytes	1444	area starting at C<$offset> in the string and ending C<$length> bytes
1340	later. If C<$length> is negative, counts from the end, and if C<$length>	1445	later. If C<$length> is negative, counts from the end, and if C<$length>
1341	is C<undef>, then it goes till the end of the string. The flags can be	1446	is C<undef>, then it goes till the end of the string. The flags can be
1342	a combination of C<IO::AIO::MS_ASYNC>, C<IO::AIO::MS_INVALIDATE> and	1447	either C<IO::AIO::MS_ASYNC> or C<IO::AIO::MS_SYNC>, plus an optional
1343	C<IO::AIO::MS_SYNC>.	1448	C<IO::AIO::MS_INVALIDATE>.
1344		1449
1345	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	1450	=item aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
1346		1451
1347	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1452	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1348	scalars.	1453	scalars.
…		…
1378	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;	1483	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
1379	aio_mlock $data; # mlock in background	1484	aio_mlock $data; # mlock in background
1380		1485
1381	=item aio_mlockall $flags, $callback->($status)	1486	=item aio_mlockall $flags, $callback->($status)
1382		1487
1383	Calls the C<mlockall> function with the given C<$flags> (a combination of	1488	Calls the C<mlockall> function with the given C<$flags> (a
1384	C<IO::AIO::MCL_CURRENT> and C<IO::AIO::MCL_FUTURE>).	1489	combination of C<IO::AIO::MCL_CURRENT>, C<IO::AIO::MCL_FUTURE> and
		1490	C<IO::AIO::MCL_ONFAULT>).
1385		1491
1386	On systems that do not implement C<mlockall>, this function returns C<-1>	1492	On systems that do not implement C<mlockall>, this function returns C<-1>
1387	and sets errno to C<ENOSYS>.	1493	and sets errno to C<ENOSYS>. Similarly, flag combinations not supported
		1494	by the system result in a return value of C<-1> with errno being set to
		1495	C<EINVAL>.
1388		1496
1389	Note that the corresponding C<munlockall> is synchronous and is	1497	Note that the corresponding C<munlockall> is synchronous and is
1390	documented under L<MISCELLANEOUS FUNCTIONS>.	1498	documented under L<MISCELLANEOUS FUNCTIONS>.
1391		1499
1392	Example: asynchronously lock all current and future pages into memory.	1500	Example: asynchronously lock all current and future pages into memory.
…		…
1431	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,	1539	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
1432	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,	1540	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
1433	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or	1541	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
1434	C<IO::AIO::FIEMAP_EXTENT_SHARED>.	1542	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
1435		1543
1436	At the time of this writing (Linux 3.2), this requets is unreliable unless	1544	At the time of this writing (Linux 3.2), this request is unreliable unless
1437	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing	1545	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
1438	it to return all extents of a range for files with large number of	1546	it to return all extents of a range for files with a large number of
1439	extents. The code works around all these issues if C<$count> is undef.	1547	extents. The code (only) works around all these issues if C<$count> is
		1548	C<undef>.
1440		1549
1441	=item aio_group $callback->(...)	1550	=item aio_group $callback->(...)
1442		1551
1443	This is a very special aio request: Instead of doing something, it is a	1552	This is a very special aio request: Instead of doing something, it is a
1444	container for other aio requests, which is useful if you want to bundle	1553	container for other aio requests, which is useful if you want to bundle
…		…
1557	There are some caveats: when directories get renamed (or deleted), the	1666	There are some caveats: when directories get renamed (or deleted), the
1558	pathname string doesn't change, so will point to the new directory (or	1667	pathname string doesn't change, so will point to the new directory (or
1559	nowhere at all), while the directory fd, if available on the system,	1668	nowhere at all), while the directory fd, if available on the system,
1560	will still point to the original directory. Most functions accepting a	1669	will still point to the original directory. Most functions accepting a
1561	pathname will use the directory fd on newer systems, and the string on	1670	pathname will use the directory fd on newer systems, and the string on
1562	older systems. Some functions (such as realpath) will always rely on the	1671	older systems. Some functions (such as C<aio_realpath>) will always rely on
1563	string form of the pathname.	1672	the string form of the pathname.
1564		1673
1565	So this functionality is mainly useful to get some protection against	1674	So this functionality is mainly useful to get some protection against
1566	C<chdir>, to easily get an absolute path out of a relative path for future	1675	C<chdir>, to easily get an absolute path out of a relative path for future
1567	reference, and to speed up doing many operations in the same directory	1676	reference, and to speed up doing many operations in the same directory
1568	(e.g. when stat'ing all files in a directory).	1677	(e.g. when stat'ing all files in a directory).
…		…
1585	C<aio_wd> callback, as future requests using the value will fail in the	1694	C<aio_wd> callback, as future requests using the value will fail in the
1586	expected way.	1695	expected way.
1587		1696
1588	=item IO::AIO::CWD	1697	=item IO::AIO::CWD
1589		1698
1590	This is a compiletime constant (object) that represents the process	1699	This is a compile time constant (object) that represents the process
1591	current working directory.	1700	current working directory.
1592		1701
1593	Specifying this object as working directory object for a pathname is as if	1702	Specifying this object as working directory object for a pathname is as if
1594	the pathname would be specified directly, without a directory object. For	1703	the pathname would be specified directly, without a directory object. For
1595	example, these calls are functionally identical:	1704	example, these calls are functionally identical:
…		…
1776	The default value for the limit is C<0>, but note that setting a feeder	1885	The default value for the limit is C<0>, but note that setting a feeder
1777	automatically bumps it up to C<2>.	1886	automatically bumps it up to C<2>.
1778		1887
1779	=back	1888	=back
1780		1889
		1890
1781	=head2 SUPPORT FUNCTIONS	1891	=head2 SUPPORT FUNCTIONS
1782		1892
1783	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION	1893	=head3 EVENT PROCESSING AND EVENT LOOP INTEGRATION
1784		1894
1785	=over 4	1895	=over 4
…		…
1850	Strictly equivalent to:	1960	Strictly equivalent to:
1851		1961
1852	IO::AIO::poll_wait, IO::AIO::poll_cb	1962	IO::AIO::poll_wait, IO::AIO::poll_cb
1853	while IO::AIO::nreqs;	1963	while IO::AIO::nreqs;
1854		1964
		1965	This function can be useful at program aborts, to make sure outstanding
		1966	I/O has been done (C<IO::AIO> uses an C<END> block which already calls
		1967	this function on normal exits), or when you are merely using C<IO::AIO>
		1968	for its more advanced functions, rather than for async I/O, e.g.:
		1969
		1970	my ($dirs, $nondirs);
		1971	IO::AIO::aio_scandir "/tmp", 0, sub { ($dirs, $nondirs) = @_ };
		1972	IO::AIO::flush;
		1973	# $dirs, $nondirs are now set
		1974
1855	=item IO::AIO::max_poll_reqs $nreqs	1975	=item IO::AIO::max_poll_reqs $nreqs
1856		1976
1857	=item IO::AIO::max_poll_time $seconds	1977	=item IO::AIO::max_poll_time $seconds
1858		1978
1859	These set the maximum number of requests (default C<0>, meaning infinity)	1979	These set the maximum number of requests (default C<0>, meaning infinity)
…		…
1885	poll => 'r', nice => 1,	2005	poll => 'r', nice => 1,
1886	cb => &IO::AIO::poll_cb);	2006	cb => &IO::AIO::poll_cb);
1887		2007
1888	=back	2008	=back
1889		2009
		2010
1890	=head3 CONTROLLING THE NUMBER OF THREADS	2011	=head3 CONTROLLING THE NUMBER OF THREADS
1891		2012
1892	=over	2013	=over
1893		2014
1894	=item IO::AIO::min_parallel $nthreads	2015	=item IO::AIO::min_parallel $nthreads
…		…
1955	longer exceeded.	2076	longer exceeded.
1956		2077
1957	In other words, this setting does not enforce a queue limit, but can be	2078	In other words, this setting does not enforce a queue limit, but can be
1958	used to make poll functions block if the limit is exceeded.	2079	used to make poll functions block if the limit is exceeded.
1959		2080
1960	This is a very bad function to use in interactive programs because it	2081	This is a bad function to use in interactive programs because it blocks,
1961	blocks, and a bad way to reduce concurrency because it is inexact: Better	2082	and a bad way to reduce concurrency because it is inexact. If you need to
		2083	issue many requests without being able to call a poll function on demand,
1962	use an C<aio_group> together with a feed callback.	2084	it is better to use an C<aio_group> together with a feed callback.
1963		2085
1964	Its main use is in scripts without an event loop - when you want to stat	2086	Its main use is in scripts without an event loop - when you want to stat a
1965	a lot of files, you can write somehting like this:	2087	lot of files, you can write something like this:
1966		2088
1967	IO::AIO::max_outstanding 32;	2089	IO::AIO::max_outstanding 32;
1968		2090
1969	for my $path (...) {	2091	for my $path (...) {
1970	aio_stat $path , ...;	2092	aio_stat $path , ...;
1971	IO::AIO::poll_cb;	2093	IO::AIO::poll_cb;
1972	}	2094	}
1973		2095
1974	IO::AIO::flush;	2096	IO::AIO::flush;
1975		2097
1976	The call to C<poll_cb> inside the loop will normally return instantly, but	2098	The call to C<poll_cb> inside the loop will normally return instantly,
1977	as soon as more thna C<32> reqeusts are in-flight, it will block until	2099	allowing the loop to progress, but as soon as more than C<32> requests
1978	some requests have been handled. This keeps the loop from pushing a large	2100	are in-flight, it will block until some requests have been handled. This
1979	number of C<aio_stat> requests onto the queue.	2101	keeps the loop from pushing a large number of C<aio_stat> requests onto
		2102	the queue (which, with many paths to stat, can use up a lot of memory).
1980		2103
1981	The default value for C<max_outstanding> is very large, so there is no	2104	The default value for C<max_outstanding> is very large, so there is no
1982	practical limit on the number of outstanding requests.	2105	practical limit on the number of outstanding requests.
1983		2106
1984	=back	2107	=back
1985		2108
		2109
1986	=head3 STATISTICAL INFORMATION	2110	=head3 STATISTICAL INFORMATION
1987		2111
1988	=over	2112	=over
1989		2113
1990	=item IO::AIO::nreqs	2114	=item IO::AIO::nreqs
…		…
2006		2130
2007	Returns the number of requests currently in the pending state (executed,	2131	Returns the number of requests currently in the pending state (executed,
2008	but not yet processed by poll_cb).	2132	but not yet processed by poll_cb).
2009		2133
2010	=back	2134	=back
		2135
		2136
		2137	=head3 SUBSECOND STAT TIME ACCESS
		2138
		2139	Both C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> functions can
		2140	generally find access/modification and change times with subsecond time
		2141	accuracy of the system supports it, but perl's built-in functions only
		2142	return the integer part.
		2143
		2144	The following functions return the timestamps of the most recent
		2145	stat with subsecond precision on most systems and work both after
		2146	C<aio_stat>/C<aio_lstat> and perl's C<stat>/C<lstat> calls. Their return
		2147	value is only meaningful after a successful C<stat>/C<lstat> call, or
		2148	during/after a successful C<aio_stat>/C<aio_lstat> callback.
		2149
		2150	This is similar to the L<Time::HiRes> C<stat> functions, but can return
		2151	full resolution without rounding and work with standard perl C<stat>,
		2152	alleviating the need to call the special C<Time::HiRes> functions, which
		2153	do not act like their perl counterparts.
		2154
		2155	On operating systems or file systems where subsecond time resolution is
		2156	not supported or could not be detected, a fractional part of C<0> is
		2157	returned, so it is always safe to call these functions.
		2158
		2159	=over 4
		2160
		2161	=item $seconds = IO::AIO::st_atime, IO::AIO::st_mtime, IO::AIO::st_ctime, IO::AIO::st_btime
		2162
		2163	Return the access, modication, change or birth time, respectively,
		2164	including fractional part. Due to the limited precision of floating point,
		2165	the accuracy on most platforms is only a bit better than milliseconds
		2166	for times around now - see the I<nsec> function family, below, for full
		2167	accuracy.
		2168
		2169	File birth time is only available when the OS and perl support it (on
		2170	FreeBSD and NetBSD at the time of this writing, although support is
		2171	adaptive, so if your OS/perl gains support, IO::AIO can take advantage of
		2172	it). On systems where it isn't available, C<0> is currently returned, but
		2173	this might change to C<undef> in a future version.
		2174
		2175	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtime
		2176
		2177	Returns access, modification, change and birth time all in one go, and
		2178	maybe more times in the future version.
		2179
		2180	=item $nanoseconds = IO::AIO::st_atimensec, IO::AIO::st_mtimensec, IO::AIO::st_ctimensec, IO::AIO::st_btimensec
		2181
		2182	Return the fractional access, modifcation, change or birth time, in nanoseconds,
		2183	as an integer in the range C<0> to C<999999999>.
		2184
		2185	Note that no accessors are provided for access, modification and
		2186	change times - you need to get those from C<stat _> if required (C<int
		2187	IO::AIO::st_atime> and so on will I<not> generally give you the correct
		2188	value).
		2189
		2190	=item $seconds = IO::AIO::st_btimesec
		2191
		2192	The (integral) seconds part of the file birth time, if available.
		2193
		2194	=item ($atime, $mtime, $ctime, $btime, ...) = IO::AIO::st_xtimensec
		2195
		2196	Like the functions above, but returns all four times in one go (and maybe
		2197	more in future versions).
		2198
		2199	=item $counter = IO::AIO::st_gen
		2200
		2201	Returns the generation counter (in practice this is just a random number)
		2202	of the file. This is only available on platforms which have this member in
		2203	their C<struct stat> (most BSDs at the time of this writing) and generally
		2204	only to the root usert. If unsupported, C<0> is returned, but this might
		2205	change to C<undef> in a future version.
		2206
		2207	=back
		2208
		2209	Example: print the high resolution modification time of F</etc>, using
		2210	C<stat>, and C<IO::AIO::aio_stat>.
		2211
		2212	if (stat "/etc") {
		2213	printf "stat(/etc) mtime: %f\n", IO::AIO::st_mtime;
		2214	}
		2215
		2216	IO::AIO::aio_stat "/etc", sub {
		2217	$_[0]
		2218	and return;
		2219
		2220	printf "aio_stat(/etc) mtime: %d.%09d\n", (stat _)[9], IO::AIO::st_mtimensec;
		2221	};
		2222
		2223	IO::AIO::flush;
		2224
		2225	Output of the awbove on my system, showing reduced and full accuracy:
		2226
		2227	stat(/etc) mtime: 1534043702.020808
		2228	aio_stat(/etc) mtime: 1534043702.020807792
		2229
2011		2230
2012	=head3 MISCELLANEOUS FUNCTIONS	2231	=head3 MISCELLANEOUS FUNCTIONS
2013		2232
2014	IO::AIO implements some functions that are useful when you want to use	2233	IO::AIO implements some functions that are useful when you want to use
2015	some "Advanced I/O" function not available to in Perl, without going the	2234	some "Advanced I/O" function not available to in Perl, without going the
2016	"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>	2235	"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
2017	counterpart.	2236	counterpart.
2018		2237
2019	=over 4	2238	=over 4
		2239
		2240	=item $retval = IO::AIO::fexecve $fh, $argv, $envp
		2241
		2242	A more-or-less direct equivalent to the POSIX C<fexecve> functions, which
		2243	allows you to specify the program to be executed via a file descriptor (or
		2244	handle). Returns C<-1> and sets errno to C<ENOSYS> if not available.
		2245
		2246	=item $retval = IO::AIO::mount $special, $path, $fstype, $flags = 0, $data = undef
		2247
		2248	Calls the GNU/Linux mount syscall with the given arguments. All except
		2249	C<$flags> are strings, and if C<$data> is C<undef>, a C<NULL> will be
		2250	passed.
		2251
		2252	The following values for C<$flags> are available:
		2253
		2254	C<IO::AIO::MS_RDONLY>, C<IO::AIO::MS_NOSUID>, C<IO::AIO::MS_NODEV>, C<IO::AIO::MS_NOEXEC>, C<IO::AIO::MS_SYNCHRONOUS>,
		2255	C<IO::AIO::MS_REMOUNT>, C<IO::AIO::MS_MANDLOCK>, C<IO::AIO::MS_DIRSYNC>, C<IO::AIO::MS_NOATIME>,
		2256	C<IO::AIO::MS_NODIRATIME>, C<IO::AIO::MS_BIND>, C<IO::AIO::MS_MOVE>, C<IO::AIO::MS_REC>, C<IO::AIO::MS_SILENT>,
		2257	C<IO::AIO::MS_POSIXACL>, C<IO::AIO::MS_UNBINDABLE>, C<IO::AIO::MS_PRIVATE>, C<IO::AIO::MS_SLAVE>, C<IO::AIO::MS_SHARED>,
		2258	C<IO::AIO::MS_RELATIME>, C<IO::AIO::MS_KERNMOUNT>, C<IO::AIO::MS_I_VERSION>, C<IO::AIO::MS_STRICTATIME>,
		2259	C<IO::AIO::MS_LAZYTIME>, C<IO::AIO::MS_ACTIVE>, C<IO::AIO::MS_NOUSER>, C<IO::AIO::MS_RMT_MASK>, C<IO::AIO::MS_MGC_VAL> and
		2260	C<IO::AIO::MS_MGC_MSK>.
		2261
		2262	=item $retval = IO::AIO::umount $path, $flags = 0
		2263
		2264	Invokes the GNU/Linux C<umount> or C<umount2> syscalls. Always calls
		2265	C<umount> if C<$flags> is C<0>, otherwqise always tries to call
		2266	C<umount2>.
		2267
		2268	The following C<$flags> are available:
		2269
		2270	C<IO::AIO::MNT_FORCE>, C<IO::AIO::MNT_DETACH>, C<IO::AIO::MNT_EXPIRE> and C<IO::AIO::UMOUNT_NOFOLLOW>.
		2271
		2272	=item $numfd = IO::AIO::get_fdlimit
		2273
		2274	Tries to find the current file descriptor limit and returns it, or
		2275	C<undef> and sets C<$!> in case of an error. The limit is one larger than
		2276	the highest valid file descriptor number.
		2277
		2278	=item IO::AIO::min_fdlimit [$numfd]
		2279
		2280	Try to increase the current file descriptor limit(s) to at least C<$numfd>
		2281	by changing the soft or hard file descriptor resource limit. If C<$numfd>
		2282	is missing, it will try to set a very high limit, although this is not
		2283	recommended when you know the actual minimum that you require.
		2284
		2285	If the limit cannot be raised enough, the function makes a best-effort
		2286	attempt to increase the limit as much as possible, using various
		2287	tricks, while still failing. You can query the resulting limit using
		2288	C<IO::AIO::get_fdlimit>.
		2289
		2290	If an error occurs, returns C<undef> and sets C<$!>, otherwise returns
		2291	true.
2020		2292
2021	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count	2293	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
2022		2294
2023	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,	2295	Calls the C<eio_sendfile_sync> function, which is like C<aio_sendfile>,
2024	but is blocking (this makes most sense if you know the input data is	2296	but is blocking (this makes most sense if you know the input data is
…		…
2041	=item IO::AIO::madvise $scalar, $offset, $len, $advice	2313	=item IO::AIO::madvise $scalar, $offset, $len, $advice
2042		2314
2043	Simply calls the C<posix_madvise> function (see its	2315	Simply calls the C<posix_madvise> function (see its
2044	manpage for details). The following advice constants are	2316	manpage for details). The following advice constants are
2045	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,	2317	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
2046	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>,	2318	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>,
2047	C<IO::AIO::MADV_FREE>.	2319	C<IO::AIO::MADV_DONTNEED>.
		2320
		2321	If C<$offset> is negative, counts from the end. If C<$length> is negative,
		2322	the remaining length of the C<$scalar> is used. If possible, C<$length>
		2323	will be reduced to fit into the C<$scalar>.
2048		2324
2049	On systems that do not implement C<posix_madvise>, this function returns	2325	On systems that do not implement C<posix_madvise>, this function returns
2050	ENOSYS, otherwise the return value of C<posix_madvise>.	2326	ENOSYS, otherwise the return value of C<posix_madvise>.
2051		2327
2052	=item IO::AIO::mprotect $scalar, $offset, $len, $protect	2328	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
…		…
2054	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed	2330	Simply calls the C<mprotect> function on the preferably AIO::mmap'ed
2055	$scalar (see its manpage for details). The following protect	2331	$scalar (see its manpage for details). The following protect
2056	constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,	2332	constants are available: C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_READ>,
2057	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.	2333	C<IO::AIO::PROT_WRITE>, C<IO::AIO::PROT_EXEC>.
2058		2334
		2335	If C<$offset> is negative, counts from the end. If C<$length> is negative,
		2336	the remaining length of the C<$scalar> is used. If possible, C<$length>
		2337	will be reduced to fit into the C<$scalar>.
		2338
2059	On systems that do not implement C<mprotect>, this function returns	2339	On systems that do not implement C<mprotect>, this function returns
2060	ENOSYS, otherwise the return value of C<mprotect>.	2340	ENOSYS, otherwise the return value of C<mprotect>.
2061		2341
2062	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]	2342	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
2063		2343
2064	Memory-maps a file (or anonymous memory range) and attaches it to the	2344	Memory-maps a file (or anonymous memory range) and attaches it to the
2065	given C<$scalar>, which will act like a string scalar. Returns true on	2345	given C<$scalar>, which will act like a string scalar. Returns true on
2066	success, and false otherwise.	2346	success, and false otherwise.
2067		2347
		2348	The scalar must exist, but its contents do not matter - this means you
		2349	cannot use a nonexistant array or hash element. When in doubt, C<undef>
		2350	the scalar first.
		2351
2068	The only operations allowed on the scalar are C<substr>/C<vec> that don't	2352	The only operations allowed on the mmapped scalar are C<substr>/C<vec>,
2069	change the string length, and most read-only operations such as copying it	2353	which don't change the string length, and most read-only operations such
2070	or searching it with regexes and so on.	2354	as copying it or searching it with regexes and so on.
2071		2355
2072	Anything else is unsafe and will, at best, result in memory leaks.	2356	Anything else is unsafe and will, at best, result in memory leaks.
2073		2357
2074	The memory map associated with the C<$scalar> is automatically removed	2358	The memory map associated with the C<$scalar> is automatically removed
2075	when the C<$scalar> is destroyed, or when the C<IO::AIO::mmap> or	2359	when the C<$scalar> is undef'd or destroyed, or when the C<IO::AIO::mmap>
2076	C<IO::AIO::munmap> functions are called.	2360	or C<IO::AIO::munmap> functions are called on it.
2077		2361
2078	This calls the C<mmap>(2) function internally. See your system's manual	2362	This calls the C<mmap>(2) function internally. See your system's manual
2079	page for details on the C<$length>, C<$prot> and C<$flags> parameters.	2363	page for details on the C<$length>, C<$prot> and C<$flags> parameters.
2080		2364
2081	The C<$length> must be larger than zero and smaller than the actual	2365	The C<$length> must be larger than zero and smaller than the actual
…		…
2094	C<IO::AIO::MAP_POPULATE>,	2378	C<IO::AIO::MAP_POPULATE>,
2095	C<IO::AIO::MAP_NONBLOCK>,	2379	C<IO::AIO::MAP_NONBLOCK>,
2096	C<IO::AIO::MAP_FIXED>,	2380	C<IO::AIO::MAP_FIXED>,
2097	C<IO::AIO::MAP_GROWSDOWN>,	2381	C<IO::AIO::MAP_GROWSDOWN>,
2098	C<IO::AIO::MAP_32BIT>,	2382	C<IO::AIO::MAP_32BIT>,
2099	C<IO::AIO::MAP_HUGETLB> or	2383	C<IO::AIO::MAP_HUGETLB>,
2100	C<IO::AIO::MAP_STACK>.	2384	C<IO::AIO::MAP_STACK>,
		2385	C<IO::AIO::MAP_FIXED_NOREPLACE>,
		2386	C<IO::AIO::MAP_SHARED_VALIDATE>,
		2387	C<IO::AIO::MAP_SYNC> or
		2388	C<IO::AIO::MAP_UNINITIALIZED>.
2101		2389
2102	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.	2390	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
2103		2391
2104	C<$offset> is the offset from the start of the file - it generally must be	2392	C<$offset> is the offset from the start of the file - it generally must be
2105	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.	2393	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
…		…
2119		2407
2120	=item IO::AIO::munmap $scalar	2408	=item IO::AIO::munmap $scalar
2121		2409
2122	Removes a previous mmap and undefines the C<$scalar>.	2410	Removes a previous mmap and undefines the C<$scalar>.
2123		2411
		2412	=item IO::AIO::mremap $scalar, $new_length, $flags = MREMAP_MAYMOVE[, $new_address = 0]
		2413
		2414	Calls the Linux-specific mremap(2) system call. The C<$scalar> must have
		2415	been mapped by C<IO::AIO::mmap>, and C<$flags> must currently either be
		2416	C<0> or C<IO::AIO::MREMAP_MAYMOVE>.
		2417
		2418	Returns true if successful, and false otherwise. If the underlying mmapped
		2419	region has changed address, then the true value has the numerical value
		2420	C<1>, otherwise it has the numerical value C<0>:
		2421
		2422	my $success = IO::AIO::mremap $mmapped, 8192, IO::AIO::MREMAP_MAYMOVE
		2423	or die "mremap: $!";
		2424
		2425	if ($success*1) {
		2426	warn "scalar has chanegd address in memory\n";
		2427	}
		2428
		2429	C<IO::AIO::MREMAP_FIXED> and the C<$new_address> argument are currently
		2430	implemented, but not supported and might go away in a future version.
		2431
		2432	On systems where this call is not supported or is not emulated, this call
		2433	returns falls and sets C<$!> to C<ENOSYS>.
		2434
		2435	=item IO::AIO::mlockall $flags
		2436
		2437	Calls the C<eio_mlockall_sync> function, which is like C<aio_mlockall>,
		2438	but is blocking.
		2439
2124	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef	2440	=item IO::AIO::munlock $scalar, $offset = 0, $length = undef
2125		2441
2126	Calls the C<munlock> function, undoing the effects of a previous	2442	Calls the C<munlock> function, undoing the effects of a previous
2127	C<aio_mlock> call (see its description for details).	2443	C<aio_mlock> call (see its description for details).
2128		2444
…		…
2130		2446
2131	Calls the C<munlockall> function.	2447	Calls the C<munlockall> function.
2132		2448
2133	On systems that do not implement C<munlockall>, this function returns	2449	On systems that do not implement C<munlockall>, this function returns
2134	ENOSYS, otherwise the return value of C<munlockall>.	2450	ENOSYS, otherwise the return value of C<munlockall>.
		2451
		2452	=item $fh = IO::AIO::accept4 $r_fh, $sockaddr, $sockaddr_maxlen, $flags
		2453
		2454	Uses the GNU/Linux C<accept4(2)> syscall, if available, to accept a socket
		2455	and return the new file handle on success, or sets C<$!> and returns
		2456	C<undef> on error.
		2457
		2458	The remote name of the new socket will be stored in C<$sockaddr>, which
		2459	will be extended to allow for at least C<$sockaddr_maxlen> octets. If the
		2460	socket name does not fit into C<$sockaddr_maxlen> octets, this is signaled
		2461	by returning a longer string in C<$sockaddr>, which might or might not be
		2462	truncated.
		2463
		2464	To accept name-less sockets, use C<undef> for C<$sockaddr> and C<0> for
		2465	C<$sockaddr_maxlen>.
		2466
		2467	The main reasons to use this syscall rather than portable C<accept(2)>
		2468	are that you can specify C<SOCK_NONBLOCK> and/or C<SOCK_CLOEXEC>
		2469	flags and you can accept name-less sockets by specifying C<0> for
		2470	C<$sockaddr_maxlen>, which is sadly not possible with perl's interface to
		2471	C<accept>.
2135		2472
2136	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags	2473	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
2137		2474
2138	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or	2475	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
2139	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they	2476	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
…		…
2177	C<$flags> is non-zero, fails with C<ENOSYS>.	2514	C<$flags> is non-zero, fails with C<ENOSYS>.
2178		2515
2179	Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the	2516	Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
2180	time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and	2517	time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
2181	C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.	2518	C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
		2519
		2520	Example: create a pipe race-free w.r.t. threads and fork:
		2521
		2522	my ($rfh, $wfh) = IO::AIO::pipe2 IO::AIO::O_CLOEXEC
		2523	or die "pipe2: $!\n";
		2524
		2525	=item $fh = IO::AIO::memfd_create $pathname[, $flags]
		2526
		2527	This is a direct interface to the Linux L<memfd_create(2)> system
		2528	call. The (unhelpful) default for C<$flags> is C<0>, but your default
		2529	should be C<IO::AIO::MFD_CLOEXEC>.
		2530
		2531	On success, the new memfd filehandle is returned, otherwise returns
		2532	C<undef>. If the memfd_create syscall is missing, fails with C<ENOSYS>.
		2533
		2534	Please refer to L<memfd_create(2)> for more info on this call.
		2535
		2536	The following C<$flags> values are available: C<IO::AIO::MFD_CLOEXEC>,
		2537	C<IO::AIO::MFD_ALLOW_SEALING>, C<IO::AIO::MFD_HUGETLB>,
		2538	C<IO::AIO::MFD_HUGETLB_2MB> and C<IO::AIO::MFD_HUGETLB_1GB>.
		2539
		2540	Example: create a new memfd.
		2541
		2542	my $fh = IO::AIO::memfd_create "somenameforprocfd", IO::AIO::MFD_CLOEXEC
		2543	or die "memfd_create: $!\n";
		2544
		2545	=item $fh = IO::AIO::pidfd_open $pid[, $flags]
		2546
		2547	This is an interface to the Linux L<pidfd_open(2)> system call. The
		2548	default for C<$flags> is C<0>.
		2549
		2550	On success, a new pidfd filehandle is returned (that is already set to
		2551	close-on-exec), otherwise returns C<undef>. If the syscall is missing,
		2552	fails with C<ENOSYS>.
		2553
		2554	Example: open pid 6341 as pidfd.
		2555
		2556	my $fh = IO::AIO::pidfd_open 6341
		2557	or die "pidfd_open: $!\n";
		2558
		2559	=item $status = IO::AIO::pidfd_send_signal $pidfh, $signal[, $siginfo[, $flags]]
		2560
		2561	This is an interface to the Linux L<pidfd_send_signal> system call. The
		2562	default for C<$siginfo> is C<undef> and the default for C<$flags> is C<0>.
		2563
		2564	Returns the system call status. If the syscall is missing, fails with
		2565	C<ENOSYS>.
		2566
		2567	When specified, C<$siginfo> must be a reference to a hash with one or more
		2568	of the following members:
		2569
		2570	=over
		2571
		2572	=item code - the C<si_code> member
		2573
		2574	=item pid - the C<si_pid> member
		2575
		2576	=item uid - the C<si_uid> member
		2577
		2578	=item value_int - the C<si_value.sival_int> member
		2579
		2580	=item value_ptr - the C<si_value.sival_ptr> member, specified as an integer
		2581
		2582	=back
		2583
		2584	Example: send a SIGKILL to the specified process.
		2585
		2586	my $status = IO::AIO::pidfd_send_signal $pidfh, 9, undef
		2587	and die "pidfd_send_signal: $!\n";
		2588
		2589	Example: send a SIGKILL to the specified process with extra data.
		2590
		2591	my $status = IO::AIO::pidfd_send_signal $pidfh, 9, { code => -1, value_int => 7 }
		2592	and die "pidfd_send_signal: $!\n";
		2593
		2594	=item $fh = IO::AIO::pidfd_getfd $pidfh, $targetfd[, $flags]
		2595
		2596	This is an interface to the Linux L<pidfd_getfd> system call. The default
		2597	for C<$flags> is C<0>.
		2598
		2599	On success, returns a dup'ed copy of the target file descriptor (specified
		2600	as an integer) returned (that is already set to close-on-exec), otherwise
		2601	returns C<undef>. If the syscall is missing, fails with C<ENOSYS>.
		2602
		2603	Example: get a copy of standard error of another process and print soemthing to it.
		2604
		2605	my $errfh = IO::AIO::pidfd_getfd $pidfh, 2
		2606	or die "pidfd_getfd: $!\n";
		2607	print $errfh "stderr\n";
		2608
		2609	=item $fh = IO::AIO::eventfd [$initval, [$flags]]
		2610
		2611	This is a direct interface to the Linux L<eventfd(2)> system call. The
		2612	(unhelpful) defaults for C<$initval> and C<$flags> are C<0> for both.
		2613
		2614	On success, the new eventfd filehandle is returned, otherwise returns
		2615	C<undef>. If the eventfd syscall is missing, fails with C<ENOSYS>.
		2616
		2617	Please refer to L<eventfd(2)> for more info on this call.
		2618
		2619	The following symbol flag values are available: C<IO::AIO::EFD_CLOEXEC>,
		2620	C<IO::AIO::EFD_NONBLOCK> and C<IO::AIO::EFD_SEMAPHORE> (Linux 2.6.30).
		2621
		2622	Example: create a new eventfd filehandle:
		2623
		2624	$fh = IO::AIO::eventfd 0, IO::AIO::EFD_CLOEXEC
		2625	or die "eventfd: $!\n";
		2626
		2627	=item $fh = IO::AIO::timerfd_create $clockid[, $flags]
		2628
		2629	This is a direct interface to the Linux L<timerfd_create(2)> system
		2630	call. The (unhelpful) default for C<$flags> is C<0>, but your default
		2631	should be C<IO::AIO::TFD_CLOEXEC>.
		2632
		2633	On success, the new timerfd filehandle is returned, otherwise returns
		2634	C<undef>. If the timerfd_create syscall is missing, fails with C<ENOSYS>.
		2635
		2636	Please refer to L<timerfd_create(2)> for more info on this call.
		2637
		2638	The following C<$clockid> values are
		2639	available: C<IO::AIO::CLOCK_REALTIME>, C<IO::AIO::CLOCK_MONOTONIC>
		2640	C<IO::AIO::CLOCK_CLOCK_BOOTTIME> (Linux 3.15)
		2641	C<IO::AIO::CLOCK_CLOCK_REALTIME_ALARM> (Linux 3.11) and
		2642	C<IO::AIO::CLOCK_CLOCK_BOOTTIME_ALARM> (Linux 3.11).
		2643
		2644	The following C<$flags> values are available (Linux
		2645	2.6.27): C<IO::AIO::TFD_NONBLOCK> and C<IO::AIO::TFD_CLOEXEC>.
		2646
		2647	Example: create a new timerfd and set it to one-second repeated alarms,
		2648	then wait for two alarms:
		2649
		2650	my $fh = IO::AIO::timerfd_create IO::AIO::CLOCK_BOOTTIME, IO::AIO::TFD_CLOEXEC
		2651	or die "timerfd_create: $!\n";
		2652
		2653	defined IO::AIO::timerfd_settime $fh, 0, 1, 1
		2654	or die "timerfd_settime: $!\n";
		2655
		2656	for (1..2) {
		2657	8 == sysread $fh, my $buf, 8
		2658	or die "timerfd read failure\n";
		2659
		2660	printf "number of expirations (likely 1): %d\n",
		2661	unpack "Q", $buf;
		2662	}
		2663
		2664	=item ($cur_interval, $cur_value) = IO::AIO::timerfd_settime $fh, $flags, $new_interval, $nbw_value
		2665
		2666	This is a direct interface to the Linux L<timerfd_settime(2)> system
		2667	call. Please refer to its manpage for more info on this call.
		2668
		2669	The new itimerspec is specified using two (possibly fractional) second
		2670	values, C<$new_interval> and C<$new_value>).
		2671
		2672	On success, the current interval and value are returned (as per
		2673	C<timerfd_gettime>). On failure, the empty list is returned.
		2674
		2675	The following C<$flags> values are
		2676	available: C<IO::AIO::TFD_TIMER_ABSTIME> and
		2677	C<IO::AIO::TFD_TIMER_CANCEL_ON_SET>.
		2678
		2679	See C<IO::AIO::timerfd_create> for a full example.
		2680
		2681	=item ($cur_interval, $cur_value) = IO::AIO::timerfd_gettime $fh
		2682
		2683	This is a direct interface to the Linux L<timerfd_gettime(2)> system
		2684	call. Please refer to its manpage for more info on this call.
		2685
		2686	On success, returns the current values of interval and value for the given
		2687	timerfd (as potentially fractional second values). On failure, the empty
		2688	list is returned.
2182		2689
2183	=back	2690	=back
2184		2691
2185	=cut	2692	=cut
2186		2693
…		…
2252	the process will result in undefined behaviour. Calling it at any time	2759	the process will result in undefined behaviour. Calling it at any time
2253	will also result in any undefined (by POSIX) behaviour.	2760	will also result in any undefined (by POSIX) behaviour.
2254		2761
2255	=back	2762	=back
2256		2763
		2764	=head2 LINUX-SPECIFIC CALLS
		2765
		2766	When a call is documented as "linux-specific" then this means it
		2767	originated on GNU/Linux. C<IO::AIO> will usually try to autodetect the
		2768	availability and compatibility of such calls regardless of the platform
		2769	it is compiled on, so platforms such as FreeBSD which often implement
		2770	these calls will work. When in doubt, call them and see if they fail wth
		2771	C<ENOSYS>.
		2772
2257	=head2 MEMORY USAGE	2773	=head2 MEMORY USAGE
2258		2774
2259	Per-request usage:	2775	Per-request usage:
2260		2776
2261	Each aio request uses - depending on your architecture - around 100-200	2777	Each aio request uses - depending on your architecture - around 100-200
…		…
2273	temporary buffers, and each thread requires a stack and other data	2789	temporary buffers, and each thread requires a stack and other data
2274	structures (usually around 16k-128k, depending on the OS).	2790	structures (usually around 16k-128k, depending on the OS).
2275		2791
2276	=head1 KNOWN BUGS	2792	=head1 KNOWN BUGS
2277		2793
2278	Known bugs will be fixed in the next release.	2794	Known bugs will be fixed in the next release :)
		2795
		2796	=head1 KNOWN ISSUES
		2797
		2798	Calls that try to "import" foreign memory areas (such as C<IO::AIO::mmap>
		2799	or C<IO::AIO::aio_slurp>) do not work with generic lvalues, such as
		2800	non-created hash slots or other scalars I didn't think of. It's best to
		2801	avoid such and either use scalar variables or making sure that the scalar
		2802	exists (e.g. by storing C<undef>) and isn't "funny" (e.g. tied).
		2803
		2804	I am not sure anything can be done about this, so this is considered a
		2805	known issue, rather than a bug.
2279		2806
2280	=head1 SEE ALSO	2807	=head1 SEE ALSO
2281		2808
2282	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a	2809	L<AnyEvent::AIO> for easy integration into event loops, L<Coro::AIO> for a
2283	more natural syntax.	2810	more natural syntax and L<IO::FDPass> for file descriptor passing.
2284		2811
2285	=head1 AUTHOR	2812	=head1 AUTHOR
2286		2813
2287	Marc Lehmann <schmorp@schmorp.de>	2814	Marc Lehmann <schmorp@schmorp.de>
2288	http://home.schmorp.de/	2815	http://home.schmorp.de/

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.263 by root, Tue Jul 12 20:46:33 2016 UTC vs. Revision 1.318 by root, Sat Apr 1 02:14:05 2023 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.263 by root, Tue Jul 12 20:46:33 2016 UTC vs.
Revision 1.318 by root, Sat Apr 1 02:14:05 2023 UTC