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

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.208 by root, Mon Sep 26 20:19:08 2011 UTC vs.
Revision 1.266 by root, Tue Aug 9 11:37:53 2016 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
68	=head2 EXAMPLE	72	=head2 EXAMPLE
69		73
70	This is a simple example that uses the EV module and loads	74	This is a simple example that uses the EV module and loads
71	F</etc/passwd> asynchronously:	75	F</etc/passwd> asynchronously:
72		76
73	use Fcntl;
74	use EV;	77	use EV;
75	use IO::AIO;	78	use IO::AIO;
76		79
77	# register the IO::AIO callback with EV	80	# register the IO::AIO callback with EV
78	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;	81	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
…		…
95		98
96	# file contents now in $contents	99	# file contents now in $contents
97	print $contents;	100	print $contents;
98		101
99	# exit event loop and program	102	# exit event loop and program
100	EV::unloop;	103	EV::break;
101	};	104	};
102	};	105	};
103		106
104	# possibly queue up other requests, or open GUI windows,	107	# possibly queue up other requests, or open GUI windows,
105	# check for sockets etc. etc.	108	# check for sockets etc. etc.
106		109
107	# process events as long as there are some:	110	# process events as long as there are some:
108	EV::loop;	111	EV::run;
109		112
110	=head1 REQUEST ANATOMY AND LIFETIME	113	=head1 REQUEST ANATOMY AND LIFETIME
111		114
112	Every C<aio_*> function creates a request. which is a C data structure not	115	Every C<aio_*> function creates a request. which is a C data structure not
113	directly visible to Perl.	116	directly visible to Perl.
…		…
168	use common::sense;	171	use common::sense;
169		172
170	use base 'Exporter';	173	use base 'Exporter';
171		174
172	BEGIN {	175	BEGIN {
173	our $VERSION = '4.0';	176	our $VERSION = 4.34;
174		177
175	our @AIO_REQ = qw(aio_sendfile 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
176	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
177	aio_scandir aio_symlink aio_readlink aio_realpath aio_sync	180	aio_scandir aio_symlink aio_readlink aio_realpath aio_fcntl aio_ioctl
178	aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range aio_fallocate	181	aio_sync aio_fsync aio_syncfs aio_fdatasync aio_sync_file_range
179	aio_pathsync aio_readahead	182	aio_pathsync aio_readahead aio_fiemap aio_allocate
180	aio_rename aio_link aio_move aio_copy aio_group	183	aio_rename aio_link aio_move aio_copy aio_group
181	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
182	aio_chmod aio_utime aio_truncate	185	aio_chmod aio_utime aio_truncate
183	aio_msync aio_mtouch aio_mlock aio_mlockall	186	aio_msync aio_mtouch aio_mlock aio_mlockall
184	aio_statvfs	187	aio_statvfs
…		…
202		205
203	=head1 FUNCTIONS	206	=head1 FUNCTIONS
204		207
205	=head2 QUICK OVERVIEW	208	=head2 QUICK OVERVIEW
206		209
207	This section simply lists the prototypes of the most important functions	210	This section simply lists the prototypes most of the functions for
208	for quick reference. See the following sections for function-by-function	211	quick reference. See the following sections for function-by-function
209	documentation.	212	documentation.
210		213
211	aio_wd $pathname, $callback->($wd)	214	aio_wd $pathname, $callback->($wd)
212	aio_open $pathname, $flags, $mode, $callback->($fh)	215	aio_open $pathname, $flags, $mode, $callback->($fh)
213	aio_close $fh, $callback->($status)	216	aio_close $fh, $callback->($status)
		217	aio_seek $fh,$offset,$whence, $callback->($offs)
214	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	218	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
215	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	219	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
216	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)	220	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
217	aio_readahead $fh,$offset,$length, $callback->($retval)	221	aio_readahead $fh,$offset,$length, $callback->($retval)
218	aio_stat $fh_or_path, $callback->($status)	222	aio_stat $fh_or_path, $callback->($status)
219	aio_lstat $fh, $callback->($status)	223	aio_lstat $fh, $callback->($status)
220	aio_statvfs $fh_or_path, $callback->($statvfs)	224	aio_statvfs $fh_or_path, $callback->($statvfs)
221	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	225	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
222	aio_chown $fh_or_path, $uid, $gid, $callback->($status)	226	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		227	aio_chmod $fh_or_path, $mode, $callback->($status)
223	aio_truncate $fh_or_path, $offset, $callback->($status)	228	aio_truncate $fh_or_path, $offset, $callback->($status)
224	aio_chmod $fh_or_path, $mode, $callback->($status)	229	aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		230	aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
225	aio_unlink $pathname, $callback->($status)	231	aio_unlink $pathname, $callback->($status)
226	aio_mknod $path, $mode, $dev, $callback->($status)	232	aio_mknod $pathname, $mode, $dev, $callback->($status)
227	aio_link $srcpath, $dstpath, $callback->($status)	233	aio_link $srcpath, $dstpath, $callback->($status)
228	aio_symlink $srcpath, $dstpath, $callback->($status)	234	aio_symlink $srcpath, $dstpath, $callback->($status)
229	aio_readlink $path, $callback->($link)	235	aio_readlink $pathname, $callback->($link)
230	aio_realpath $path, $callback->($link)	236	aio_realpath $pathname, $callback->($path)
231	aio_rename $srcpath, $dstpath, $callback->($status)	237	aio_rename $srcpath, $dstpath, $callback->($status)
232	aio_mkdir $pathname, $mode, $callback->($status)	238	aio_mkdir $pathname, $mode, $callback->($status)
233	aio_rmdir $pathname, $callback->($status)	239	aio_rmdir $pathname, $callback->($status)
234	aio_readdir $pathname, $callback->($entries)	240	aio_readdir $pathname, $callback->($entries)
235	aio_readdirx $pathname, $flags, $callback->($entries, $flags)	241	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
236	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST	242	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
237	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN	243	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
		244	aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
238	aio_load $path, $data, $callback->($status)	245	aio_load $pathname, $data, $callback->($status)
239	aio_copy $srcpath, $dstpath, $callback->($status)	246	aio_copy $srcpath, $dstpath, $callback->($status)
240	aio_move $srcpath, $dstpath, $callback->($status)	247	aio_move $srcpath, $dstpath, $callback->($status)
241	aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
242	aio_rmtree $path, $callback->($status)	248	aio_rmtree $pathname, $callback->($status)
		249	aio_fcntl $fh, $cmd, $arg, $callback->($status)
		250	aio_ioctl $fh, $request, $buf, $callback->($status)
243	aio_sync $callback->($status)	251	aio_sync $callback->($status)
244	aio_syncfs $fh, $callback->($status)	252	aio_syncfs $fh, $callback->($status)
245	aio_fsync $fh, $callback->($status)	253	aio_fsync $fh, $callback->($status)
246	aio_fdatasync $fh, $callback->($status)	254	aio_fdatasync $fh, $callback->($status)
247	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)	255	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
248	aio_pathsync $path, $callback->($status)	256	aio_pathsync $pathname, $callback->($status)
249	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	257	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
250	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)	258	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
251	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	259	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
252	aio_mlockall $flags, $callback->($status)	260	aio_mlockall $flags, $callback->($status)
253	aio_group $callback->(...)	261	aio_group $callback->(...)
…		…
271	IO::AIO::nready	279	IO::AIO::nready
272	IO::AIO::npending	280	IO::AIO::npending
273		281
274	IO::AIO::sendfile $ofh, $ifh, $offset, $count	282	IO::AIO::sendfile $ofh, $ifh, $offset, $count
275	IO::AIO::fadvise $fh, $offset, $len, $advice	283	IO::AIO::fadvise $fh, $offset, $len, $advice
		284	IO::AIO::mmap $scalar, $length, $prot, $flags[, $fh[, $offset]]
		285	IO::AIO::munmap $scalar
276	IO::AIO::madvise $scalar, $offset, $length, $advice	286	IO::AIO::madvise $scalar, $offset, $length, $advice
277	IO::AIO::mprotect $scalar, $offset, $length, $protect	287	IO::AIO::mprotect $scalar, $offset, $length, $protect
278	IO::AIO::munlock $scalar, $offset = 0, $length = undef	288	IO::AIO::munlock $scalar, $offset = 0, $length = undef
279	IO::AIO::munlockall	289	IO::AIO::munlockall
280		290
281	=head2 AIO REQUEST FUNCTIONS	291	=head2 API NOTES
282		292
283	All the C<aio_*> calls are more or less thin wrappers around the syscall	293	All the C<aio_*> calls are more or less thin wrappers around the syscall
284	with the same name (sans C<aio_>). The arguments are similar or identical,	294	with the same name (sans C<aio_>). The arguments are similar or identical,
285	and they all accept an additional (and optional) C<$callback> argument	295	and they all accept an additional (and optional) C<$callback> argument
286	which must be a code reference. This code reference will get called with	296	which must be a code reference. This code reference will be called after
287	the syscall return code (e.g. most syscalls return C<-1> on error, unlike	297	the syscall has been executed in an asynchronous fashion. The results
288	perl, which usually delivers "false") as its sole argument after the given	298	of the request will be passed as arguments to the callback (and, if an
289	syscall has been executed asynchronously.	299	error occured, in C<$!>) - for most requests the syscall return code (e.g.
		300	most syscalls return C<-1> on error, unlike perl, which usually delivers
		301	"false").
		302
		303	Some requests (such as C<aio_readdir>) pass the actual results and
		304	communicate failures by passing C<undef>.
290		305
291	All functions expecting a filehandle keep a copy of the filehandle	306	All functions expecting a filehandle keep a copy of the filehandle
292	internally until the request has finished.	307	internally until the request has finished.
293		308
294	All functions return request objects of type L<IO::AIO::REQ> that allow	309	All functions return request objects of type L<IO::AIO::REQ> that allow
295	further manipulation of those requests while they are in-flight.	310	further manipulation of those requests while they are in-flight.
296		311
297	The pathnames you pass to these routines I<must> be absolute and	312	The pathnames you pass to these routines I<should> be absolute. The
298	encoded as octets. The reason for the former is that at the time the	313	reason for this is that at the time the request is being executed, the
299	request is being executed, the current working directory could have	314	current working directory could have changed. Alternatively, you can
300	changed. Alternatively, you can make sure that you never change the	315	make sure that you never change the current working directory anywhere
301	current working directory anywhere in the program and then use relative	316	in the program and then use relative paths. You can also take advantage
302	paths.	317	of IO::AIOs working directory abstraction, that lets you specify paths
		318	relative to some previously-opened "working directory object" - see the
		319	description of the C<IO::AIO::WD> class later in this document.
303		320
304	To encode pathnames as octets, either make sure you either: a) always pass	321	To encode pathnames as octets, either make sure you either: a) always pass
305	in filenames you got from outside (command line, readdir etc.) without	322	in filenames you got from outside (command line, readdir etc.) without
306	tinkering, b) are ASCII or ISO 8859-1, c) use the Encode module and encode	323	tinkering, b) are in your native filesystem encoding, c) use the Encode
307	your pathnames to the locale (or other) encoding in effect in the user	324	module and encode your pathnames to the locale (or other) encoding in
308	environment, d) use Glib::filename_from_unicode on unicode filenames or e)	325	effect in the user environment, d) use Glib::filename_from_unicode on
309	use something else to ensure your scalar has the correct contents.	326	unicode filenames or e) use something else to ensure your scalar has the
		327	correct contents.
310		328
311	This works, btw. independent of the internal UTF-8 bit, which IO::AIO	329	This works, btw. independent of the internal UTF-8 bit, which IO::AIO
312	handles correctly whether it is set or not.	330	handles correctly whether it is set or not.
		331
		332	=head2 AIO REQUEST FUNCTIONS
313		333
314	=over 4	334	=over 4
315		335
316	=item $prev_pri = aioreq_pri [$pri]	336	=item $prev_pri = aioreq_pri [$pri]
317		337
…		…
347		367
348		368
349	=item aio_open $pathname, $flags, $mode, $callback->($fh)	369	=item aio_open $pathname, $flags, $mode, $callback->($fh)
350		370
351	Asynchronously open or create a file and call the callback with a newly	371	Asynchronously open or create a file and call the callback with a newly
352	created filehandle for the file.	372	created filehandle for the file (or C<undef> in case of an error).
353		373
354	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,	374	The pathname passed to C<aio_open> must be absolute. See API NOTES, above,
355	for an explanation.	375	for an explanation.
356		376
357	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a	377	The C<$flags> argument is a bitmask. See the C<Fcntl> module for a
…		…
380	following POSIX and non-POSIX constants are available (missing ones on	400	following POSIX and non-POSIX constants are available (missing ones on
381	your system are, as usual, C<0>):	401	your system are, as usual, C<0>):
382		402
383	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,	403	C<O_ASYNC>, C<O_DIRECT>, C<O_NOATIME>, C<O_CLOEXEC>, C<O_NOCTTY>, C<O_NOFOLLOW>,
384	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,	404	C<O_NONBLOCK>, C<O_EXEC>, C<O_SEARCH>, C<O_DIRECTORY>, C<O_DSYNC>,
385	C<O_RSYNC>, C<O_SYNC> and C<O_TTY_INIT>.	405	C<O_RSYNC>, C<O_SYNC>, C<O_PATH>, C<O_TMPFILE>, and C<O_TTY_INIT>.
386		406
387		407
388	=item aio_close $fh, $callback->($status)	408	=item aio_close $fh, $callback->($status)
389		409
390	Asynchronously close a file and call the callback with the result	410	Asynchronously close a file and call the callback with the result
…		…
400	Or in other words: the file descriptor will be closed, but it will not be	420	Or in other words: the file descriptor will be closed, but it will not be
401	free for reuse until the perl filehandle is closed.	421	free for reuse until the perl filehandle is closed.
402		422
403	=cut	423	=cut
404		424
		425	=item aio_seek $fh, $offset, $whence, $callback->($offs)
		426
		427	Seeks the filehandle to the new C<$offset>, similarly to perl's
		428	C<sysseek>. The C<$whence> can use the traditional values (C<0> for
		429	C<IO::AIO::SEEK_SET>, C<1> for C<IO::AIO::SEEK_CUR> or C<2> for
		430	C<IO::AIO::SEEK_END>).
		431
		432	The resulting absolute offset will be passed to the callback, or C<-1> in
		433	case of an error.
		434
		435	In theory, the C<$whence> constants could be different than the
		436	corresponding values from L<Fcntl>, but perl guarantees they are the same,
		437	so don't panic.
		438
		439	As a GNU/Linux (and maybe Solaris) extension, also the constants
		440	C<IO::AIO::SEEK_DATA> and C<IO::AIO::SEEK_HOLE> are available, if they
		441	could be found. No guarantees about suitability for use in C<aio_seek> or
		442	Perl's C<sysseek> can be made though, although I would naively assume they
		443	"just work".
		444
405	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	445	=item aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
406		446
407	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	447	=item aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
408		448
409	Reads or writes C<$length> bytes from or to the specified C<$fh> and	449	Reads or writes C<$length> bytes from or to the specified C<$fh> and
410	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>	450	C<$offset> into the scalar given by C<$data> and offset C<$dataoffset>
411	and calls the callback without the actual number of bytes read (or -1 on	451	and calls the callback with the actual number of bytes read (or -1 on
412	error, just like the syscall).	452	error, just like the syscall).
413		453
414	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to	454	C<aio_read> will, like C<sysread>, shrink or grow the C<$data> scalar to
415	offset plus the actual number of bytes read.	455	offset plus the actual number of bytes read.
416		456
…		…
474	As native sendfile syscalls (as practically any non-POSIX interface hacked	514	As native sendfile syscalls (as practically any non-POSIX interface hacked
475	together in a hurry to improve benchmark numbers) tend to be rather buggy	515	together in a hurry to improve benchmark numbers) tend to be rather buggy
476	on many systems, this implementation tries to work around some known bugs	516	on many systems, this implementation tries to work around some known bugs
477	in Linux and FreeBSD kernels (probably others, too), but that might fail,	517	in Linux and FreeBSD kernels (probably others, too), but that might fail,
478	so you really really should check the return value of C<aio_sendfile> -	518	so you really really should check the return value of C<aio_sendfile> -
479	fewre bytes than expected might have been transferred.	519	fewer bytes than expected might have been transferred.
480		520
481		521
482	=item aio_readahead $fh,$offset,$length, $callback->($retval)	522	=item aio_readahead $fh,$offset,$length, $callback->($retval)
483		523
484	C<aio_readahead> populates the page cache with data from a file so that	524	C<aio_readahead> populates the page cache with data from a file so that
…		…
488	whole pages, so that offset is effectively rounded down to a page boundary	528	whole pages, so that offset is effectively rounded down to a page boundary
489	and bytes are read up to the next page boundary greater than or equal to	529	and bytes are read up to the next page boundary greater than or equal to
490	(off-set+length). C<aio_readahead> does not read beyond the end of the	530	(off-set+length). C<aio_readahead> does not read beyond the end of the
491	file. The current file offset of the file is left unchanged.	531	file. The current file offset of the file is left unchanged.
492		532
493	If that syscall doesn't exist (likely if your OS isn't Linux) it will be	533	If that syscall doesn't exist (likely if your kernel isn't Linux) it will
494	emulated by simply reading the data, which would have a similar effect.	534	be emulated by simply reading the data, which would have a similar effect.
495		535
496		536
497	=item aio_stat $fh_or_path, $callback->($status)	537	=item aio_stat $fh_or_path, $callback->($status)
498		538
499	=item aio_lstat $fh, $callback->($status)	539	=item aio_lstat $fh, $callback->($status)
…		…
568	namemax => 255,	608	namemax => 255,
569	frsize => 1024,	609	frsize => 1024,
570	fsid => 1810	610	fsid => 1810
571	}	611	}
572		612
		613	Here is a (likely partial - send me updates!) list of fsid values used by
		614	Linux - it is safe to hardcode these when C<$^O> is C<linux>:
		615
		616	0x0000adf5 adfs
		617	0x0000adff affs
		618	0x5346414f afs
		619	0x09041934 anon-inode filesystem
		620	0x00000187 autofs
		621	0x42465331 befs
		622	0x1badface bfs
		623	0x42494e4d binfmt_misc
		624	0x9123683e btrfs
		625	0x0027e0eb cgroupfs
		626	0xff534d42 cifs
		627	0x73757245 coda
		628	0x012ff7b7 coh
		629	0x28cd3d45 cramfs
		630	0x453dcd28 cramfs-wend (wrong endianness)
		631	0x64626720 debugfs
		632	0x00001373 devfs
		633	0x00001cd1 devpts
		634	0x0000f15f ecryptfs
		635	0x00414a53 efs
		636	0x0000137d ext
		637	0x0000ef53 ext2/ext3/ext4
		638	0x0000ef51 ext2
		639	0xf2f52010 f2fs
		640	0x00004006 fat
		641	0x65735546 fuseblk
		642	0x65735543 fusectl
		643	0x0bad1dea futexfs
		644	0x01161970 gfs2
		645	0x47504653 gpfs
		646	0x00004244 hfs
		647	0xf995e849 hpfs
		648	0x00c0ffee hostfs
		649	0x958458f6 hugetlbfs
		650	0x2bad1dea inotifyfs
		651	0x00009660 isofs
		652	0x000072b6 jffs2
		653	0x3153464a jfs
		654	0x6b414653 k-afs
		655	0x0bd00bd0 lustre
		656	0x0000137f minix
		657	0x0000138f minix 30 char names
		658	0x00002468 minix v2
		659	0x00002478 minix v2 30 char names
		660	0x00004d5a minix v3
		661	0x19800202 mqueue
		662	0x00004d44 msdos
		663	0x0000564c novell
		664	0x00006969 nfs
		665	0x6e667364 nfsd
		666	0x00003434 nilfs
		667	0x5346544e ntfs
		668	0x00009fa1 openprom
		669	0x7461636F ocfs2
		670	0x00009fa0 proc
		671	0x6165676c pstorefs
		672	0x0000002f qnx4
		673	0x68191122 qnx6
		674	0x858458f6 ramfs
		675	0x52654973 reiserfs
		676	0x00007275 romfs
		677	0x67596969 rpc_pipefs
		678	0x73636673 securityfs
		679	0xf97cff8c selinux
		680	0x0000517b smb
		681	0x534f434b sockfs
		682	0x73717368 squashfs
		683	0x62656572 sysfs
		684	0x012ff7b6 sysv2
		685	0x012ff7b5 sysv4
		686	0x01021994 tmpfs
		687	0x15013346 udf
		688	0x00011954 ufs
		689	0x54190100 ufs byteswapped
		690	0x00009fa2 usbdevfs
		691	0x01021997 v9fs
		692	0xa501fcf5 vxfs
		693	0xabba1974 xenfs
		694	0x012ff7b4 xenix
		695	0x58465342 xfs
		696	0x012fd16d xia
573		697
574	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	698	=item aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
575		699
576	Works like perl's C<utime> function (including the special case of $atime	700	Works like perl's C<utime> function (including the special case of $atime
577	and $mtime being undef). Fractional times are supported if the underlying	701	and $mtime being undef). Fractional times are supported if the underlying
…		…
605	=item aio_truncate $fh_or_path, $offset, $callback->($status)	729	=item aio_truncate $fh_or_path, $offset, $callback->($status)
606		730
607	Works like truncate(2) or ftruncate(2).	731	Works like truncate(2) or ftruncate(2).
608		732
609		733
		734	=item aio_allocate $fh, $mode, $offset, $len, $callback->($status)
		735
		736	Allocates or frees disk space according to the C<$mode> argument. See the
		737	linux C<fallocate> documentation for details.
		738
		739	C<$mode> is usually C<0> or C<IO::AIO::FALLOC_FL_KEEP_SIZE> to allocate
		740	space, or C<IO::AIO::FALLOC_FL_PUNCH_HOLE \| IO::AIO::FALLOC_FL_KEEP_SIZE>,
		741	to deallocate a file range.
		742
		743	IO::AIO also supports C<FALLOC_FL_COLLAPSE_RANGE>, to remove a range
		744	(without leaving a hole) and C<FALLOC_FL_ZERO_RANGE>, to zero a range (see
		745	your L<fallocate(2)> manpage).
		746
		747	The file system block size used by C<fallocate> is presumably the
		748	C<f_bsize> returned by C<statvfs>.
		749
		750	If C<fallocate> isn't available or cannot be emulated (currently no
		751	emulation will be attempted), passes C<-1> and sets C<$!> to C<ENOSYS>.
		752
		753
610	=item aio_chmod $fh_or_path, $mode, $callback->($status)	754	=item aio_chmod $fh_or_path, $mode, $callback->($status)
611		755
612	Works like perl's C<chmod> function.	756	Works like perl's C<chmod> function.
613		757
614		758
…		…
616		760
617	Asynchronously unlink (delete) a file and call the callback with the	761	Asynchronously unlink (delete) a file and call the callback with the
618	result code.	762	result code.
619		763
620		764
621	=item aio_mknod $path, $mode, $dev, $callback->($status)	765	=item aio_mknod $pathname, $mode, $dev, $callback->($status)
622		766
623	[EXPERIMENTAL]	767	[EXPERIMENTAL]
624		768
625	Asynchronously create a device node (or fifo). See mknod(2).	769	Asynchronously create a device node (or fifo). See mknod(2).
626		770
627	The only (POSIX-) portable way of calling this function is:	771	The only (POSIX-) portable way of calling this function is:
628		772
629	aio_mknod $path, IO::AIO::S_IFIFO \| $mode, 0, sub { ...	773	aio_mknod $pathname, IO::AIO::S_IFIFO \| $mode, 0, sub { ...
630		774
631	See C<aio_stat> for info about some potentially helpful extra constants	775	See C<aio_stat> for info about some potentially helpful extra constants
632	and functions.	776	and functions.
633		777
634	=item aio_link $srcpath, $dstpath, $callback->($status)	778	=item aio_link $srcpath, $dstpath, $callback->($status)
…		…
641		785
642	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at	786	Asynchronously create a new symbolic link to the existing object at C<$srcpath> at
643	the path C<$dstpath> and call the callback with the result code.	787	the path C<$dstpath> and call the callback with the result code.
644		788
645		789
646	=item aio_readlink $path, $callback->($link)	790	=item aio_readlink $pathname, $callback->($link)
647		791
648	Asynchronously read the symlink specified by C<$path> and pass it to	792	Asynchronously read the symlink specified by C<$path> and pass it to
649	the callback. If an error occurs, nothing or undef gets passed to the	793	the callback. If an error occurs, nothing or undef gets passed to the
650	callback.	794	callback.
651		795
652		796
653	=item aio_realpath $path, $callback->($path)	797	=item aio_realpath $pathname, $callback->($path)
654		798
655	Asynchronously make the path absolute and resolve any symlinks in	799	Asynchronously make the path absolute and resolve any symlinks in
656	C<$path>. The resulting path only consists of directories (Same as	800	C<$path>. The resulting path only consists of directories (same as
657	L<Cwd::realpath>).	801	L<Cwd::realpath>).
658		802
659	This request can be used to get the absolute path of the current working	803	This request can be used to get the absolute path of the current working
660	directory by passing it a path of F<.> (a single dot).	804	directory by passing it a path of F<.> (a single dot).
661		805
662		806
663	=item aio_rename $srcpath, $dstpath, $callback->($status)	807	=item aio_rename $srcpath, $dstpath, $callback->($status)
664		808
665	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as	809	Asynchronously rename the object at C<$srcpath> to C<$dstpath>, just as
666	rename(2) and call the callback with the result code.	810	rename(2) and call the callback with the result code.
		811
		812	On systems that support the AIO::WD working directory abstraction
		813	natively, the case C<[$wd, "."]> as C<$srcpath> is specialcased - instead
		814	of failing, C<rename> is called on the absolute path of C<$wd>.
667		815
668		816
669	=item aio_mkdir $pathname, $mode, $callback->($status)	817	=item aio_mkdir $pathname, $mode, $callback->($status)
670		818
671	Asynchronously mkdir (create) a directory and call the callback with	819	Asynchronously mkdir (create) a directory and call the callback with
…		…
675		823
676	=item aio_rmdir $pathname, $callback->($status)	824	=item aio_rmdir $pathname, $callback->($status)
677		825
678	Asynchronously rmdir (delete) a directory and call the callback with the	826	Asynchronously rmdir (delete) a directory and call the callback with the
679	result code.	827	result code.
		828
		829	On systems that support the AIO::WD working directory abstraction
		830	natively, the case C<[$wd, "."]> is specialcased - instead of failing,
		831	C<rmdir> is called on the absolute path of C<$wd>.
680		832
681		833
682	=item aio_readdir $pathname, $callback->($entries)	834	=item aio_readdir $pathname, $callback->($entries)
683		835
684	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire	836	Unlike the POSIX call of the same name, C<aio_readdir> reads an entire
…		…
753	C<$type>'s are known, which can be used to speed up some algorithms.	905	C<$type>'s are known, which can be used to speed up some algorithms.
754		906
755	=back	907	=back
756		908
757		909
758	=item aio_load $path, $data, $callback->($status)	910	=item aio_load $pathname, $data, $callback->($status)
759		911
760	This is a composite request that tries to fully load the given file into	912	This is a composite request that tries to fully load the given file into
761	memory. Status is the same as with aio_read.	913	memory. Status is the same as with aio_read.
762		914
763	=cut	915	=cut
…		…
898	};	1050	};
899		1051
900	$grp	1052	$grp
901	}	1053	}
902		1054
903	=item aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)	1055	=item aio_scandir $pathname, $maxreq, $callback->($dirs, $nondirs)
904		1056
905	Scans a directory (similar to C<aio_readdir>) but additionally tries to	1057	Scans a directory (similar to C<aio_readdir>) but additionally tries to
906	efficiently separate the entries of directory C<$path> into two sets of	1058	efficiently separate the entries of directory C<$path> into two sets of
907	names, directories you can recurse into (directories), and ones you cannot	1059	names, directories you can recurse into (directories), and ones you cannot
908	recurse into (everything else, including symlinks to directories).	1060	recurse into (everything else, including symlinks to directories).
…		…
965		1117
966	my $grp = aio_group $cb;	1118	my $grp = aio_group $cb;
967		1119
968	$maxreq = 4 if $maxreq <= 0;	1120	$maxreq = 4 if $maxreq <= 0;
969		1121
970	# stat once	1122	# get a wd object
971	aioreq_pri $pri;	1123	aioreq_pri $pri;
972	add $grp aio_stat $path, sub {	1124	add $grp aio_wd $path, sub {
		1125	$_[0]
973	return $grp->result () if $_[0];	1126	or return $grp->result ();
974	my $now = time;
975	my $hash1 = join ":", (stat _)[0,1,3,7,9];
976		1127
977	# read the directory entries	1128	my $wd = [shift, "."];
		1129
		1130	# stat once
978	aioreq_pri $pri;	1131	aioreq_pri $pri;
979	add $grp aio_readdirx $path, READDIR_DIRS_FIRST, sub {	1132	add $grp aio_stat $wd, sub {
980	my $entries = shift
981	or return $grp->result ();	1133	return $grp->result () if $_[0];
		1134	my $now = time;
		1135	my $hash1 = join ":", (stat _)[0,1,3,7,9];
982		1136
983	# stat the dir another time	1137	# read the directory entries
984	aioreq_pri $pri;	1138	aioreq_pri $pri;
		1139	add $grp aio_readdirx $wd, READDIR_DIRS_FIRST, sub {
		1140	my $entries = shift
		1141	or return $grp->result ();
		1142
		1143	# stat the dir another time
		1144	aioreq_pri $pri;
985	add $grp aio_stat $path, sub {	1145	add $grp aio_stat $wd, sub {
986	my $hash2 = join ":", (stat _)[0,1,3,7,9];	1146	my $hash2 = join ":", (stat _)[0,1,3,7,9];
987		1147
988	my $ndirs;	1148	my $ndirs;
989		1149
990	# take the slow route if anything looks fishy	1150	# take the slow route if anything looks fishy
991	if ($hash1 ne $hash2 or (stat _)[9] == $now) {	1151	if ($hash1 ne $hash2 or (stat _)[9] == $now) {
992	$ndirs = -1;	1152	$ndirs = -1;
993	} else {	1153	} else {
994	# if nlink == 2, we are finished	1154	# if nlink == 2, we are finished
995	# for non-posix-fs's, we rely on nlink < 2	1155	# for non-posix-fs's, we rely on nlink < 2
996	$ndirs = (stat _)[3] - 2	1156	$ndirs = (stat _)[3] - 2
997	or return $grp->result ([], $entries);	1157	or return $grp->result ([], $entries);
998	}	1158	}
999		1159
1000	my (@dirs, @nondirs);	1160	my (@dirs, @nondirs);
1001		1161
1002	my $statgrp = add $grp aio_group sub {	1162	my $statgrp = add $grp aio_group sub {
1003	$grp->result (\@dirs, \@nondirs);	1163	$grp->result (\@dirs, \@nondirs);
1004	};	1164	};
1005		1165
1006	limit $statgrp $maxreq;	1166	limit $statgrp $maxreq;
1007	feed $statgrp sub {	1167	feed $statgrp sub {
1008	return unless @$entries;	1168	return unless @$entries;
1009	my $entry = shift @$entries;	1169	my $entry = shift @$entries;
1010		1170
1011	aioreq_pri $pri;	1171	aioreq_pri $pri;
		1172	$wd->[1] = "$entry/.";
1012	add $statgrp aio_stat "$path/$entry/.", sub {	1173	add $statgrp aio_stat $wd, sub {
1013	if ($_[0] < 0) {	1174	if ($_[0] < 0) {
1014	push @nondirs, $entry;	1175	push @nondirs, $entry;
1015	} else {	1176	} else {
1016	# need to check for real directory	1177	# need to check for real directory
1017	aioreq_pri $pri;	1178	aioreq_pri $pri;
		1179	$wd->[1] = $entry;
1018	add $statgrp aio_lstat "$path/$entry", sub {	1180	add $statgrp aio_lstat $wd, sub {
1019	if (-d _) {	1181	if (-d _) {
1020	push @dirs, $entry;	1182	push @dirs, $entry;
1021		1183
1022	unless (--$ndirs) {	1184	unless (--$ndirs) {
1023	push @nondirs, @$entries;	1185	push @nondirs, @$entries;
1024	feed $statgrp;	1186	feed $statgrp;
		1187	}
		1188	} else {
		1189	push @nondirs, $entry;
1025	}	1190	}
1026	} else {
1027	push @nondirs, $entry;
1028	}	1191	}
1029	}	1192	}
1030	}	1193	};
1031	};	1194	};
1032	};	1195	};
1033	};	1196	};
1034	};	1197	};
1035	};	1198	};
1036		1199
1037	$grp	1200	$grp
1038	}	1201	}
1039		1202
1040	=item aio_rmtree $path, $callback->($status)	1203	=item aio_rmtree $pathname, $callback->($status)
1041		1204
1042	Delete a directory tree starting (and including) C<$path>, return the	1205	Delete a directory tree starting (and including) C<$path>, return the
1043	status of the final C<rmdir> only. This is a composite request that	1206	status of the final C<rmdir> only. This is a composite request that
1044	uses C<aio_scandir> to recurse into and rmdir directories, and unlink	1207	uses C<aio_scandir> to recurse into and rmdir directories, and unlink
1045	everything else.	1208	everything else.
1046		1209
1047	=cut	1210	=cut
1048		1211
…		…
1070	};	1233	};
1071		1234
1072	$grp	1235	$grp
1073	}	1236	}
1074		1237
		1238	=item aio_fcntl $fh, $cmd, $arg, $callback->($status)
		1239
		1240	=item aio_ioctl $fh, $request, $buf, $callback->($status)
		1241
		1242	These work just like the C<fcntl> and C<ioctl> built-in functions, except
		1243	they execute asynchronously and pass the return value to the callback.
		1244
		1245	Both calls can be used for a lot of things, some of which make more sense
		1246	to run asynchronously in their own thread, while some others make less
		1247	sense. For example, calls that block waiting for external events, such
		1248	as locking, will also lock down an I/O thread while it is waiting, which
		1249	can deadlock the whole I/O system. At the same time, there might be no
		1250	alternative to using a thread to wait.
		1251
		1252	So in general, you should only use these calls for things that do
		1253	(filesystem) I/O, not for things that wait for other events (network,
		1254	other processes), although if you are careful and know what you are doing,
		1255	you still can.
		1256
		1257	The following constants are available (missing ones are, as usual C<0>):
		1258
		1259	C<FIFREEZE>, C<FITHAW>, C<FITRIM>, C<FICLONE>, C<FICLONERANGE>, C<FIDEDUPERANGE>.
		1260
		1261	C<FS_IOC_GETFLAGS>, C<FS_IOC_SETFLAGS>, C<FS_IOC_GETVERSION>, C<FS_IOC_SETVERSION>,
		1262	C<FS_IOC_FIEMAP>.
		1263
		1264	C<FS_IOC_FSGETXATTR>, C<FS_IOC_FSSETXATTR>, C<FS_IOC_SET_ENCRYPTION_POLICY>,
		1265	C<FS_IOC_GET_ENCRYPTION_PWSALT>, C<FS_IOC_GET_ENCRYPTION_POLICY>, C<FS_KEY_DESCRIPTOR_SIZE>.
		1266
		1267	C<FS_SECRM_FL>, C<FS_UNRM_FL>, C<FS_COMPR_FL>, C<FS_SYNC_FL>, C<FS_IMMUTABLE_FL>,
		1268	C<FS_APPEND_FL>, C<FS_NODUMP_FL>, C<FS_NOATIME_FL>, C<FS_DIRTY_FL>,
		1269	C<FS_COMPRBLK_FL>, C<FS_NOCOMP_FL>, C<FS_ENCRYPT_FL>, C<FS_BTREE_FL>,
		1270	C<FS_INDEX_FL>, C<FS_JOURNAL_DATA_FL>, C<FS_NOTAIL_FL>, C<FS_DIRSYNC_FL>, C<FS_TOPDIR_FL>,
		1271	C<FS_FL_USER_MODIFIABLE>.
		1272
		1273	C<FS_XFLAG_REALTIME>, C<FS_XFLAG_PREALLOC>, C<FS_XFLAG_IMMUTABLE>, C<FS_XFLAG_APPEND>,
		1274	C<FS_XFLAG_SYNC>, C<FS_XFLAG_NOATIME>, C<FS_XFLAG_NODUMP>, C<FS_XFLAG_RTINHERIT>,
		1275	C<FS_XFLAG_PROJINHERIT>, C<FS_XFLAG_NOSYMLINKS>, C<FS_XFLAG_EXTSIZE>, C<FS_XFLAG_EXTSZINHERIT>,
		1276	C<FS_XFLAG_NODEFRAG>, C<FS_XFLAG_FILESTREAM>, C<FS_XFLAG_DAX>, C<FS_XFLAG_HASATTR>,
		1277
1075	=item aio_sync $callback->($status)	1278	=item aio_sync $callback->($status)
1076		1279
1077	Asynchronously call sync and call the callback when finished.	1280	Asynchronously call sync and call the callback when finished.
1078		1281
1079	=item aio_fsync $fh, $callback->($status)	1282	=item aio_fsync $fh, $callback->($status)
…		…
1106	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,	1309	C<$flags> can be a combination of C<IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE>,
1107	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and	1310	C<IO::AIO::SYNC_FILE_RANGE_WRITE> and
1108	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range	1311	C<IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER>: refer to the sync_file_range
1109	manpage for details.	1312	manpage for details.
1110		1313
1111	=item aio_pathsync $path, $callback->($status)	1314	=item aio_pathsync $pathname, $callback->($status)
1112		1315
1113	This request tries to open, fsync and close the given path. This is a	1316	This request tries to open, fsync and close the given path. This is a
1114	composite request intended to sync directories after directory operations	1317	composite request intended to sync directories after directory operations
1115	(E.g. rename). This might not work on all operating systems or have any	1318	(E.g. rename). This might not work on all operating systems or have any
1116	specific effect, but usually it makes sure that directory changes get	1319	specific effect, but usually it makes sure that directory changes get
…		…
1168		1371
1169	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1372	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
1170	scalars.	1373	scalars.
1171		1374
1172	It touches (reads or writes) all memory pages in the specified	1375	It touches (reads or writes) all memory pages in the specified
1173	range inside the scalar. All caveats and parameters are the same	1376	range inside the scalar. All caveats and parameters are the same
1174	as for C<aio_msync>, above, except for flags, which must be either	1377	as for C<aio_msync>, above, except for flags, which must be either
1175	C<0> (which reads all pages and ensures they are instantiated) or	1378	C<0> (which reads all pages and ensures they are instantiated) or
1176	C<IO::AIO::MT_MODIFY>, which modifies the memory page s(by reading and	1379	C<IO::AIO::MT_MODIFY>, which modifies the memory pages (by reading and
1177	writing an octet from it, which dirties the page).	1380	writing an octet from it, which dirties the page).
1178		1381
1179	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)	1382	=item aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
1180		1383
1181	This is a rather advanced IO::AIO call, which works best on mmap(2)ed	1384	This is a rather advanced IO::AIO call, which works best on mmap(2)ed
…		…
1212	documented under L<MISCELLANEOUS FUNCTIONS>.	1415	documented under L<MISCELLANEOUS FUNCTIONS>.
1213		1416
1214	Example: asynchronously lock all current and future pages into memory.	1417	Example: asynchronously lock all current and future pages into memory.
1215		1418
1216	aio_mlockall IO::AIO::MCL_FUTURE;	1419	aio_mlockall IO::AIO::MCL_FUTURE;
		1420
		1421	=item aio_fiemap $fh, $start, $length, $flags, $count, $cb->(\@extents)
		1422
		1423	Queries the extents of the given file (by calling the Linux C<FIEMAP>
		1424	ioctl, see L<http://cvs.schmorp.de/IO-AIO/doc/fiemap.txt> for details). If
		1425	the ioctl is not available on your OS, then this request will fail with
		1426	C<ENOSYS>.
		1427
		1428	C<$start> is the starting offset to query extents for, C<$length> is the
		1429	size of the range to query - if it is C<undef>, then the whole file will
		1430	be queried.
		1431
		1432	C<$flags> is a combination of flags (C<IO::AIO::FIEMAP_FLAG_SYNC> or
		1433	C<IO::AIO::FIEMAP_FLAG_XATTR> - C<IO::AIO::FIEMAP_FLAGS_COMPAT> is also
		1434	exported), and is normally C<0> or C<IO::AIO::FIEMAP_FLAG_SYNC> to query
		1435	the data portion.
		1436
		1437	C<$count> is the maximum number of extent records to return. If it is
		1438	C<undef>, then IO::AIO queries all extents of the range. As a very special
		1439	case, if it is C<0>, then the callback receives the number of extents
		1440	instead of the extents themselves (which is unreliable, see below).
		1441
		1442	If an error occurs, the callback receives no arguments. The special
		1443	C<errno> value C<IO::AIO::EBADR> is available to test for flag errors.
		1444
		1445	Otherwise, the callback receives an array reference with extent
		1446	structures. Each extent structure is an array reference itself, with the
		1447	following members:
		1448
		1449	[$logical, $physical, $length, $flags]
		1450
		1451	Flags is any combination of the following flag values (typically either C<0>
		1452	or C<IO::AIO::FIEMAP_EXTENT_LAST> (1)):
		1453
		1454	C<IO::AIO::FIEMAP_EXTENT_LAST>, C<IO::AIO::FIEMAP_EXTENT_UNKNOWN>,
		1455	C<IO::AIO::FIEMAP_EXTENT_DELALLOC>, C<IO::AIO::FIEMAP_EXTENT_ENCODED>,
		1456	C<IO::AIO::FIEMAP_EXTENT_DATA_ENCRYPTED>, C<IO::AIO::FIEMAP_EXTENT_NOT_ALIGNED>,
		1457	C<IO::AIO::FIEMAP_EXTENT_DATA_INLINE>, C<IO::AIO::FIEMAP_EXTENT_DATA_TAIL>,
		1458	C<IO::AIO::FIEMAP_EXTENT_UNWRITTEN>, C<IO::AIO::FIEMAP_EXTENT_MERGED> or
		1459	C<IO::AIO::FIEMAP_EXTENT_SHARED>.
		1460
		1461	At the time of this writing (Linux 3.2), this requets is unreliable unless
		1462	C<$count> is C<undef>, as the kernel has all sorts of bugs preventing
		1463	it to return all extents of a range for files with large number of
		1464	extents. The code works around all these issues if C<$count> is undef.
1217		1465
1218	=item aio_group $callback->(...)	1466	=item aio_group $callback->(...)
1219		1467
1220	This is a very special aio request: Instead of doing something, it is a	1468	This is a very special aio request: Instead of doing something, it is a
1221	container for other aio requests, which is useful if you want to bundle	1469	container for other aio requests, which is useful if you want to bundle
…		…
1258	like sleep and file handle readable/writable, the overhead this creates is	1506	like sleep and file handle readable/writable, the overhead this creates is
1259	immense (it blocks a thread for a long time) so do not use this function	1507	immense (it blocks a thread for a long time) so do not use this function
1260	except to put your application under artificial I/O pressure.	1508	except to put your application under artificial I/O pressure.
1261		1509
1262	=back	1510	=back
		1511
		1512
		1513	=head2 IO::AIO::WD - multiple working directories
		1514
		1515	Your process only has one current working directory, which is used by all
		1516	threads. This makes it hard to use relative paths (some other component
		1517	could call C<chdir> at any time, and it is hard to control when the path
		1518	will be used by IO::AIO).
		1519
		1520	One solution for this is to always use absolute paths. This usually works,
		1521	but can be quite slow (the kernel has to walk the whole path on every
		1522	access), and can also be a hassle to implement.
		1523
		1524	Newer POSIX systems have a number of functions (openat, fdopendir,
		1525	futimensat and so on) that make it possible to specify working directories
		1526	per operation.
		1527
		1528	For portability, and because the clowns who "designed", or shall I write,
		1529	perpetrated this new interface were obviously half-drunk, this abstraction
		1530	cannot be perfect, though.
		1531
		1532	IO::AIO allows you to convert directory paths into a so-called IO::AIO::WD
		1533	object. This object stores the canonicalised, absolute version of the
		1534	path, and on systems that allow it, also a directory file descriptor.
		1535
		1536	Everywhere where a pathname is accepted by IO::AIO (e.g. in C<aio_stat>
		1537	or C<aio_unlink>), one can specify an array reference with an IO::AIO::WD
		1538	object and a pathname instead (or the IO::AIO::WD object alone, which
		1539	gets interpreted as C<[$wd, "."]>). If the pathname is absolute, the
		1540	IO::AIO::WD object is ignored, otherwise the pathname is resolved relative
		1541	to that IO::AIO::WD object.
		1542
		1543	For example, to get a wd object for F</etc> and then stat F<passwd>
		1544	inside, you would write:
		1545
		1546	aio_wd "/etc", sub {
		1547	my $etcdir = shift;
		1548
		1549	# although $etcdir can be undef on error, there is generally no reason
		1550	# to check for errors here, as aio_stat will fail with ENOENT
		1551	# when $etcdir is undef.
		1552
		1553	aio_stat [$etcdir, "passwd"], sub {
		1554	# yay
		1555	};
		1556	};
		1557
		1558	The fact that C<aio_wd> is a request and not a normal function shows that
		1559	creating an IO::AIO::WD object is itself a potentially blocking operation,
		1560	which is why it is done asynchronously.
		1561
		1562	To stat the directory obtained with C<aio_wd> above, one could write
		1563	either of the following three request calls:
		1564
		1565	aio_lstat "/etc" , sub { ... # pathname as normal string
		1566	aio_lstat [$wd, "."], sub { ... # "." relative to $wd (i.e. $wd itself)
		1567	aio_lstat $wd , sub { ... # shorthand for the previous
		1568
		1569	As with normal pathnames, IO::AIO keeps a copy of the working directory
		1570	object and the pathname string, so you could write the following without
		1571	causing any issues due to C<$path> getting reused:
		1572
		1573	my $path = [$wd, undef];
		1574
		1575	for my $name (qw(abc def ghi)) {
		1576	$path->[1] = $name;
		1577	aio_stat $path, sub {
		1578	# ...
		1579	};
		1580	}
		1581
		1582	There are some caveats: when directories get renamed (or deleted), the
		1583	pathname string doesn't change, so will point to the new directory (or
		1584	nowhere at all), while the directory fd, if available on the system,
		1585	will still point to the original directory. Most functions accepting a
		1586	pathname will use the directory fd on newer systems, and the string on
		1587	older systems. Some functions (such as realpath) will always rely on the
		1588	string form of the pathname.
		1589
		1590	So this functionality is mainly useful to get some protection against
		1591	C<chdir>, to easily get an absolute path out of a relative path for future
		1592	reference, and to speed up doing many operations in the same directory
		1593	(e.g. when stat'ing all files in a directory).
		1594
		1595	The following functions implement this working directory abstraction:
		1596
		1597	=over 4
		1598
		1599	=item aio_wd $pathname, $callback->($wd)
		1600
		1601	Asynchonously canonicalise the given pathname and convert it to an
		1602	IO::AIO::WD object representing it. If possible and supported on the
		1603	system, also open a directory fd to speed up pathname resolution relative
		1604	to this working directory.
		1605
		1606	If something goes wrong, then C<undef> is passwd to the callback instead
		1607	of a working directory object and C<$!> is set appropriately. Since
		1608	passing C<undef> as working directory component of a pathname fails the
		1609	request with C<ENOENT>, there is often no need for error checking in the
		1610	C<aio_wd> callback, as future requests using the value will fail in the
		1611	expected way.
		1612
		1613	=item IO::AIO::CWD
		1614
		1615	This is a compiletime constant (object) that represents the process
		1616	current working directory.
		1617
		1618	Specifying this object as working directory object for a pathname is as if
		1619	the pathname would be specified directly, without a directory object. For
		1620	example, these calls are functionally identical:
		1621
		1622	aio_stat "somefile", sub { ... };
		1623	aio_stat [IO::AIO::CWD, "somefile"], sub { ... };
		1624
		1625	=back
		1626
		1627	To recover the path associated with an IO::AIO::WD object, you can use
		1628	C<aio_realpath>:
		1629
		1630	aio_realpath $wd, sub {
		1631	warn "path is $_[0]\n";
		1632	};
		1633
		1634	Currently, C<aio_statvfs> always, and C<aio_rename> and C<aio_rmdir>
		1635	sometimes, fall back to using an absolue path.
1263		1636
1264	=head2 IO::AIO::REQ CLASS	1637	=head2 IO::AIO::REQ CLASS
1265		1638
1266	All non-aggregate C<aio_*> functions return an object of this class when	1639	All non-aggregate C<aio_*> functions return an object of this class when
1267	called in non-void context.	1640	called in non-void context.
…		…
1385		1758
1386	Sets a feeder/generator on this group: every group can have an attached	1759	Sets a feeder/generator on this group: every group can have an attached
1387	generator that generates requests if idle. The idea behind this is that,	1760	generator that generates requests if idle. The idea behind this is that,
1388	although you could just queue as many requests as you want in a group,	1761	although you could just queue as many requests as you want in a group,
1389	this might starve other requests for a potentially long time. For example,	1762	this might starve other requests for a potentially long time. For example,
1390	C<aio_scandir> might generate hundreds of thousands C<aio_stat> requests,	1763	C<aio_scandir> might generate hundreds of thousands of C<aio_stat>
1391	delaying any later requests for a long time.	1764	requests, delaying any later requests for a long time.
1392		1765
1393	To avoid this, and allow incremental generation of requests, you can	1766	To avoid this, and allow incremental generation of requests, you can
1394	instead a group and set a feeder on it that generates those requests. The	1767	instead a group and set a feeder on it that generates those requests. The
1395	feed callback will be called whenever there are few enough (see C<limit>,	1768	feed callback will be called whenever there are few enough (see C<limit>,
1396	below) requests active in the group itself and is expected to queue more	1769	below) requests active in the group itself and is expected to queue more
…		…
1445		1818
1446	See C<poll_cb> for an example.	1819	See C<poll_cb> for an example.
1447		1820
1448	=item IO::AIO::poll_cb	1821	=item IO::AIO::poll_cb
1449		1822
1450	Process some outstanding events on the result pipe. You have to call	1823	Process some requests that have reached the result phase (i.e. they have
		1824	been executed but the results are not yet reported). You have to call
		1825	this "regularly" to finish outstanding requests.
		1826
1451	this regularly. Returns C<0> if all events could be processed (or there	1827	Returns C<0> if all events could be processed (or there were no
1452	were no events to process), or C<-1> if it returned earlier for whatever	1828	events to process), or C<-1> if it returned earlier for whatever
1453	reason. Returns immediately when no events are outstanding. The amount of	1829	reason. Returns immediately when no events are outstanding. The amount
1454	events processed depends on the settings of C<IO::AIO::max_poll_req> and	1830	of events processed depends on the settings of C<IO::AIO::max_poll_req>,
1455	C<IO::AIO::max_poll_time>.	1831	C<IO::AIO::max_poll_time> and C<IO::AIO::max_outstanding>.
1456		1832
1457	If not all requests were processed for whatever reason, the filehandle	1833	If not all requests were processed for whatever reason, the poll file
1458	will still be ready when C<poll_cb> returns, so normally you don't have to	1834	descriptor will still be ready when C<poll_cb> returns, so normally you
1459	do anything special to have it called later.	1835	don't have to do anything special to have it called later.
1460		1836
1461	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes	1837	Apart from calling C<IO::AIO::poll_cb> when the event filehandle becomes
1462	ready, it can be beneficial to call this function from loops which submit	1838	ready, it can be beneficial to call this function from loops which submit
1463	a lot of requests, to make sure the results get processed when they become	1839	a lot of requests, to make sure the results get processed when they become
1464	available and not just when the loop is finished and the event loop takes	1840	available and not just when the loop is finished and the event loop takes
…		…
1473	poll => 'r', async => 1,	1849	poll => 'r', async => 1,
1474	cb => \&IO::AIO::poll_cb);	1850	cb => \&IO::AIO::poll_cb);
1475		1851
1476	=item IO::AIO::poll_wait	1852	=item IO::AIO::poll_wait
1477		1853
1478	If there are any outstanding requests and none of them in the result	1854	Wait until either at least one request is in the result phase or no
1479	phase, wait till the result filehandle becomes ready for reading (simply	1855	requests are outstanding anymore.
1480	does a C<select> on the filehandle. This is useful if you want to	1856
1481	synchronously wait for some requests to finish).	1857	This is useful if you want to synchronously wait for some requests to
		1858	become ready, without actually handling them.
1482		1859
1483	See C<nreqs> for an example.	1860	See C<nreqs> for an example.
1484		1861
1485	=item IO::AIO::poll	1862	=item IO::AIO::poll
1486		1863
…		…
1607		1984
1608	This is a very bad function to use in interactive programs because it	1985	This is a very bad function to use in interactive programs because it
1609	blocks, and a bad way to reduce concurrency because it is inexact: Better	1986	blocks, and a bad way to reduce concurrency because it is inexact: Better
1610	use an C<aio_group> together with a feed callback.	1987	use an C<aio_group> together with a feed callback.
1611		1988
1612	It's main use is in scripts without an event loop - when you want to stat	1989	Its main use is in scripts without an event loop - when you want to stat
1613	a lot of files, you can write somehting like this:	1990	a lot of files, you can write somehting like this:
1614		1991
1615	IO::AIO::max_outstanding 32;	1992	IO::AIO::max_outstanding 32;
1616		1993
1617	for my $path (...) {	1994	for my $path (...) {
…		…
1657		2034
1658	=back	2035	=back
1659		2036
1660	=head3 MISCELLANEOUS FUNCTIONS	2037	=head3 MISCELLANEOUS FUNCTIONS
1661		2038
1662	IO::AIO implements some functions that might be useful, but are not	2039	IO::AIO implements some functions that are useful when you want to use
1663	asynchronous.	2040	some "Advanced I/O" function not available to in Perl, without going the
		2041	"Asynchronous I/O" route. Many of these have an asynchronous C<aio_*>
		2042	counterpart.
1664		2043
1665	=over 4	2044	=over 4
1666		2045
1667	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count	2046	=item IO::AIO::sendfile $ofh, $ifh, $offset, $count
1668		2047
…		…
1687	=item IO::AIO::madvise $scalar, $offset, $len, $advice	2066	=item IO::AIO::madvise $scalar, $offset, $len, $advice
1688		2067
1689	Simply calls the C<posix_madvise> function (see its	2068	Simply calls the C<posix_madvise> function (see its
1690	manpage for details). The following advice constants are	2069	manpage for details). The following advice constants are
1691	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,	2070	available: C<IO::AIO::MADV_NORMAL>, C<IO::AIO::MADV_SEQUENTIAL>,
1692	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>.	2071	C<IO::AIO::MADV_RANDOM>, C<IO::AIO::MADV_WILLNEED>, C<IO::AIO::MADV_DONTNEED>,
		2072	C<IO::AIO::MADV_FREE>.
1693		2073
1694	On systems that do not implement C<posix_madvise>, this function returns	2074	On systems that do not implement C<posix_madvise>, this function returns
1695	ENOSYS, otherwise the return value of C<posix_madvise>.	2075	ENOSYS, otherwise the return value of C<posix_madvise>.
1696		2076
1697	=item IO::AIO::mprotect $scalar, $offset, $len, $protect	2077	=item IO::AIO::mprotect $scalar, $offset, $len, $protect
…		…
1705	ENOSYS, otherwise the return value of C<mprotect>.	2085	ENOSYS, otherwise the return value of C<mprotect>.
1706		2086
1707	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]	2087	=item IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
1708		2088
1709	Memory-maps a file (or anonymous memory range) and attaches it to the	2089	Memory-maps a file (or anonymous memory range) and attaches it to the
1710	given C<$scalar>, which will act like a string scalar.	2090	given C<$scalar>, which will act like a string scalar. Returns true on
		2091	success, and false otherwise.
1711		2092
1712	The only operations allowed on the scalar are C<substr>/C<vec> that don't	2093	The only operations allowed on the scalar are C<substr>/C<vec> that don't
1713	change the string length, and most read-only operations such as copying it	2094	change the string length, and most read-only operations such as copying it
1714	or searching it with regexes and so on.	2095	or searching it with regexes and so on.
1715		2096
…		…
1726	filesize.	2107	filesize.
1727		2108
1728	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,	2109	C<$prot> is a combination of C<IO::AIO::PROT_NONE>, C<IO::AIO::PROT_EXEC>,
1729	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,	2110	C<IO::AIO::PROT_READ> and/or C<IO::AIO::PROT_WRITE>,
1730		2111
1731	C<$flags> can be a combination of C<IO::AIO::MAP_SHARED> or	2112	C<$flags> can be a combination of
1732	C<IO::AIO::MAP_PRIVATE>, or a number of system-specific flags (when	2113	C<IO::AIO::MAP_SHARED> or
1733	not available, the are defined as 0): C<IO::AIO::MAP_ANONYMOUS>	2114	C<IO::AIO::MAP_PRIVATE>,
		2115	or a number of system-specific flags (when not available, the are C<0>):
1734	(which is set to C<MAP_ANON> if your system only provides this	2116	C<IO::AIO::MAP_ANONYMOUS> (which is set to C<MAP_ANON> if your system only provides this constant),
1735	constant), C<IO::AIO::MAP_HUGETLB>, C<IO::AIO::MAP_LOCKED>,	2117	C<IO::AIO::MAP_LOCKED>,
1736	C<IO::AIO::MAP_NORESERVE>, C<IO::AIO::MAP_POPULATE> or	2118	C<IO::AIO::MAP_NORESERVE>,
		2119	C<IO::AIO::MAP_POPULATE>,
1737	C<IO::AIO::MAP_NONBLOCK>	2120	C<IO::AIO::MAP_NONBLOCK>,
		2121	C<IO::AIO::MAP_FIXED>,
		2122	C<IO::AIO::MAP_GROWSDOWN>,
		2123	C<IO::AIO::MAP_32BIT>,
		2124	C<IO::AIO::MAP_HUGETLB> or
		2125	C<IO::AIO::MAP_STACK>.
1738		2126
1739	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.	2127	If C<$fh> is C<undef>, then a file descriptor of C<-1> is passed.
1740		2128
1741	C<$offset> is the offset from the start of the file - it generally must be	2129	C<$offset> is the offset from the start of the file - it generally must be
1742	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.	2130	a multiple of C<IO::AIO::PAGESIZE> and defaults to C<0>.
…		…
1767		2155
1768	Calls the C<munlockall> function.	2156	Calls the C<munlockall> function.
1769		2157
1770	On systems that do not implement C<munlockall>, this function returns	2158	On systems that do not implement C<munlockall>, this function returns
1771	ENOSYS, otherwise the return value of C<munlockall>.	2159	ENOSYS, otherwise the return value of C<munlockall>.
		2160
		2161	=item IO::AIO::splice $r_fh, $r_off, $w_fh, $w_off, $length, $flags
		2162
		2163	Calls the GNU/Linux C<splice(2)> syscall, if available. If C<$r_off> or
		2164	C<$w_off> are C<undef>, then C<NULL> is passed for these, otherwise they
		2165	should be the file offset.
		2166
		2167	C<$r_fh> and C<$w_fh> should not refer to the same file, as splice might
		2168	silently corrupt the data in this case.
		2169
		2170	The following symbol flag values are available: C<IO::AIO::SPLICE_F_MOVE>,
		2171	C<IO::AIO::SPLICE_F_NONBLOCK>, C<IO::AIO::SPLICE_F_MORE> and
		2172	C<IO::AIO::SPLICE_F_GIFT>.
		2173
		2174	See the C<splice(2)> manpage for details.
		2175
		2176	=item IO::AIO::tee $r_fh, $w_fh, $length, $flags
		2177
		2178	Calls the GNU/Linux C<tee(2)> syscall, see its manpage and the
		2179	description for C<IO::AIO::splice> above for details.
		2180
		2181	=item $actual_size = IO::AIO::pipesize $r_fh[, $new_size]
		2182
		2183	Attempts to query or change the pipe buffer size. Obviously works only
		2184	on pipes, and currently works only on GNU/Linux systems, and fails with
		2185	C<-1>/C<ENOSYS> everywhere else. If anybody knows how to influence pipe buffer
		2186	size on other systems, drop me a note.
		2187
		2188	=item ($rfh, $wfh) = IO::AIO::pipe2 [$flags]
		2189
		2190	This is a direct interface to the Linux L<pipe2(2)> system call. If
		2191	C<$flags> is missing or C<0>, then this should be the same as a call to
		2192	perl's built-in C<pipe> function and create a new pipe, and works on
		2193	systems that lack the pipe2 syscall. On win32, this case invokes C<_pipe
		2194	(..., 4096, O_BINARY)>.
		2195
		2196	If C<$flags> is non-zero, it tries to invoke the pipe2 system call with
		2197	the given flags (Linux 2.6.27, glibc 2.9).
		2198
		2199	On success, the read and write file handles are returned.
		2200
		2201	On error, nothing will be returned. If the pipe2 syscall is missing and
		2202	C<$flags> is non-zero, fails with C<ENOSYS>.
		2203
		2204	Please refer to L<pipe2(2)> for more info on the C<$flags>, but at the
		2205	time of this writing, C<IO::AIO::O_CLOEXEC>, C<IO::AIO::O_NONBLOCK> and
		2206	C<IO::AIO::O_DIRECT> (Linux 3.4, for packet-based pipes) were supported.
1772		2207
1773	=back	2208	=back
1774		2209
1775	=cut	2210	=cut
1776		2211

Diff Legend

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

Comparing IO-AIO/AIO.pm (file contents): Revision 1.208 by root, Mon Sep 26 20:19:08 2011 UTC vs. Revision 1.266 by root, Tue Aug 9 11:37:53 2016 UTC

Diff Legend

Comparing IO-AIO/AIO.pm (file contents):
Revision 1.208 by root, Mon Sep 26 20:19:08 2011 UTC vs.
Revision 1.266 by root, Tue Aug 9 11:37:53 2016 UTC