[ViewVC] Diff of: cvs/IO-AIO/README

Comparing IO-AIO/README (file contents):
Revision 1.33 by root, Sun Oct 12 22:40:52 2008 UTC vs.
Revision 1.44 by root, Mon Nov 1 22:03:43 2010 UTC

…		…
2	IO::AIO - Asynchronous Input/Output	2	IO::AIO - Asynchronous Input/Output
3		3
4	SYNOPSIS	4	SYNOPSIS
5	use IO::AIO;	5	use IO::AIO;
6		6
7	aio_open "/etc/passwd", O_RDONLY, 0, sub {	7	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
8	my $fh = shift	8	my $fh = shift
9	or die "/etc/passwd: $!";	9	or die "/etc/passwd: $!";
10	...	10	...
11	};	11	};
12		12
…		…
24	$req->cancel; # cancel request if still in queue	24	$req->cancel; # cancel request if still in queue
25		25
26	my $grp = aio_group sub { print "all stats done\n" };	26	my $grp = aio_group sub { print "all stats done\n" };
27	add $grp aio_stat "..." for ...;	27	add $grp aio_stat "..." for ...;
28		28
29	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
30	use AnyEvent::AIO;
31
32	# EV integration
33	my $w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
34
35	# Event integration
36	Event->io (fd => IO::AIO::poll_fileno,
37	poll => 'r',
38	cb => \&IO::AIO::poll_cb);
39
40	# Glib/Gtk2 integration
41	add_watch Glib::IO IO::AIO::poll_fileno,
42	in => sub { IO::AIO::poll_cb; 1 };
43
44	# Tk integration
45	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
46	readable => \&IO::AIO::poll_cb);
47
48	# Danga::Socket integration
49	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
50	\&IO::AIO::poll_cb);
51
52	DESCRIPTION	29	DESCRIPTION
53	This module implements asynchronous I/O using whatever means your	30	This module implements asynchronous I/O using whatever means your
54	operating system supports.	31	operating system supports. It is implemented as an interface to "libeio"
		32	(<http://software.schmorp.de/pkg/libeio.html>).
55		33
56	Asynchronous means that operations that can normally block your program	34	Asynchronous means that operations that can normally block your program
57	(e.g. reading from disk) will be done asynchronously: the operation will	35	(e.g. reading from disk) will be done asynchronously: the operation will
58	still block, but you can do something else in the meantime. This is	36	still block, but you can do something else in the meantime. This is
59	extremely useful for programs that need to stay interactive even when	37	extremely useful for programs that need to stay interactive even when
…		…
64	operations concurrently.	42	operations concurrently.
65		43
66	While most of this works on all types of file descriptors (for example	44	While most of this works on all types of file descriptors (for example
67	sockets), using these functions on file descriptors that support	45	sockets), using these functions on file descriptors that support
68	nonblocking operation (again, sockets, pipes etc.) is very inefficient.	46	nonblocking operation (again, sockets, pipes etc.) is very inefficient.
69	Use an event loop for that (such as the Event module): IO::AIO will	47	Use an event loop for that (such as the EV module): IO::AIO will
70	naturally fit into such an event loop itself.	48	naturally fit into such an event loop itself.
71		49
72	In this version, a number of threads are started that execute your	50	In this version, a number of threads are started that execute your
73	requests and signal their completion. You don't need thread support in	51	requests and signal their completion. You don't need thread support in
74	perl, and the threads created by this module will not be visible to	52	perl, and the threads created by this module will not be visible to
…		…
83	it is currently not reentrant in any way, so use appropriate locking	61	it is currently not reentrant in any way, so use appropriate locking
84	yourself, always call "poll_cb" from within the same thread, or never	62	yourself, always call "poll_cb" from within the same thread, or never
85	call "poll_cb" (or other "aio_" functions) recursively.	63	call "poll_cb" (or other "aio_" functions) recursively.
86		64
87	EXAMPLE	65	EXAMPLE
88	This is a simple example that uses the Event module and loads	66	This is a simple example that uses the EV module and loads /etc/passwd
89	/etc/passwd asynchronously:	67	asynchronously:
90		68
91	use Fcntl;	69	use Fcntl;
92	use Event;	70	use EV;
93	use IO::AIO;	71	use IO::AIO;
94		72
95	# register the IO::AIO callback with Event	73	# register the IO::AIO callback with EV
96	Event->io (fd => IO::AIO::poll_fileno,	74	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
97	poll => 'r',
98	cb => \&IO::AIO::poll_cb);
99		75
100	# queue the request to open /etc/passwd	76	# queue the request to open /etc/passwd
101	aio_open "/etc/passwd", O_RDONLY, 0, sub {	77	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
102	my $fh = shift	78	my $fh = shift
103	or die "error while opening: $!";	79	or die "error while opening: $!";
104		80
105	# stat'ing filehandles is generally non-blocking	81	# stat'ing filehandles is generally non-blocking
106	my $size = -s $fh;	82	my $size = -s $fh;
…		…
115		91
116	# file contents now in $contents	92	# file contents now in $contents
117	print $contents;	93	print $contents;
118		94
119	# exit event loop and program	95	# exit event loop and program
120	Event::unloop;	96	EV::unloop;
121	};	97	};
122	};	98	};
123		99
124	# possibly queue up other requests, or open GUI windows,	100	# possibly queue up other requests, or open GUI windows,
125	# check for sockets etc. etc.	101	# check for sockets etc. etc.
126		102
127	# process events as long as there are some:	103	# process events as long as there are some:
128	Event::loop;	104	EV::loop;
129		105
130	REQUEST ANATOMY AND LIFETIME	106	REQUEST ANATOMY AND LIFETIME
131	Every "aio_*" function creates a request. which is a C data structure	107	Every "aio_*" function creates a request. which is a C data structure
132	not directly visible to Perl.	108	not directly visible to Perl.
133		109
…		…
169	anymore (except possibly for the Perl object, but its connection to	145	anymore (except possibly for the Perl object, but its connection to
170	the actual aio request is severed and calling its methods will	146	the actual aio request is severed and calling its methods will
171	either do nothing or result in a runtime error).	147	either do nothing or result in a runtime error).
172		148
173	FUNCTIONS	149	FUNCTIONS
		150	QUICK OVERVIEW
		151	This section simply lists the prototypes of the most important functions
		152	for quick reference. See the following sections for function-by-function
		153	documentation.
		154
		155	aio_open $pathname, $flags, $mode, $callback->($fh)
		156	aio_close $fh, $callback->($status)
		157	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		158	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
		159	aio_sendfile $out_fh, $in_fh, $in_offset, $length, $callback->($retval)
		160	aio_readahead $fh,$offset,$length, $callback->($retval)
		161	aio_stat $fh_or_path, $callback->($status)
		162	aio_lstat $fh, $callback->($status)
		163	aio_statvfs $fh_or_path, $callback->($statvfs)
		164	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
		165	aio_chown $fh_or_path, $uid, $gid, $callback->($status)
		166	aio_truncate $fh_or_path, $offset, $callback->($status)
		167	aio_chmod $fh_or_path, $mode, $callback->($status)
		168	aio_unlink $pathname, $callback->($status)
		169	aio_mknod $path, $mode, $dev, $callback->($status)
		170	aio_link $srcpath, $dstpath, $callback->($status)
		171	aio_symlink $srcpath, $dstpath, $callback->($status)
		172	aio_readlink $path, $callback->($link)
		173	aio_rename $srcpath, $dstpath, $callback->($status)
		174	aio_mkdir $pathname, $mode, $callback->($status)
		175	aio_rmdir $pathname, $callback->($status)
		176	aio_readdir $pathname, $callback->($entries)
		177	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		178	IO::AIO::READDIR_DENTS IO::AIO::READDIR_DIRS_FIRST
		179	IO::AIO::READDIR_STAT_ORDER IO::AIO::READDIR_FOUND_UNKNOWN
		180	aio_load $path, $data, $callback->($status)
		181	aio_copy $srcpath, $dstpath, $callback->($status)
		182	aio_move $srcpath, $dstpath, $callback->($status)
		183	aio_scandir $path, $maxreq, $callback->($dirs, $nondirs)
		184	aio_rmtree $path, $callback->($status)
		185	aio_sync $callback->($status)
		186	aio_fsync $fh, $callback->($status)
		187	aio_fdatasync $fh, $callback->($status)
		188	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		189	aio_pathsync $path, $callback->($status)
		190	aio_msync $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		191	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0, $callback->($status)
		192	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		193	aio_mlockall $flags, $callback->($status)
		194	aio_group $callback->(...)
		195	aio_nop $callback->()
		196
		197	$prev_pri = aioreq_pri [$pri]
		198	aioreq_nice $pri_adjust
		199
		200	IO::AIO::poll_wait
		201	IO::AIO::poll_cb
		202	IO::AIO::poll
		203	IO::AIO::flush
		204	IO::AIO::max_poll_reqs $nreqs
		205	IO::AIO::max_poll_time $seconds
		206	IO::AIO::min_parallel $nthreads
		207	IO::AIO::max_parallel $nthreads
		208	IO::AIO::max_idle $nthreads
		209	IO::AIO::max_outstanding $maxreqs
		210	IO::AIO::nreqs
		211	IO::AIO::nready
		212	IO::AIO::npending
		213
		214	IO::AIO::sendfile $ofh, $ifh, $offset, $count
		215	IO::AIO::fadvise $fh, $offset, $len, $advice
		216	IO::AIO::madvise $scalar, $offset, $length, $advice
		217	IO::AIO::mprotect $scalar, $offset, $length, $protect
		218	IO::AIO::munlock $scalar, $offset = 0, $length = undef
		219	IO::AIO::munlockall
		220
174	AIO REQUEST FUNCTIONS	221	AIO REQUEST FUNCTIONS
175	All the "aio_*" calls are more or less thin wrappers around the syscall	222	All the "aio_*" calls are more or less thin wrappers around the syscall
176	with the same name (sans "aio_"). The arguments are similar or	223	with the same name (sans "aio_"). The arguments are similar or
177	identical, and they all accept an additional (and optional) $callback	224	identical, and they all accept an additional (and optional) $callback
178	argument which must be a code reference. This code reference will get	225	argument which must be a code reference. This code reference will get
…		…
249	will be modified by the umask in effect then the request is being	296	will be modified by the umask in effect then the request is being
250	executed, so better never change the umask.	297	executed, so better never change the umask.
251		298
252	Example:	299	Example:
253		300
254	aio_open "/etc/passwd", O_RDONLY, 0, sub {	301	aio_open "/etc/passwd", IO::AIO::O_RDONLY, 0, sub {
255	if ($_[0]) {	302	if ($_[0]) {
256	print "open successful, fh is $_[0]\n";	303	print "open successful, fh is $_[0]\n";
257	...	304	...
258	} else {	305	} else {
259	die "open failed: $!\n";	306	die "open failed: $!\n";
…		…
275	Or in other words: the file descriptor will be closed, but it will	322	Or in other words: the file descriptor will be closed, but it will
276	not be free for reuse until the perl filehandle is closed.	323	not be free for reuse until the perl filehandle is closed.
277		324
278	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	325	aio_read $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
279	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)	326	aio_write $fh,$offset,$length, $data,$dataoffset, $callback->($retval)
280	Reads or writes $length bytes from the specified $fh and $offset	327	Reads or writes $length bytes from or to the specified $fh and
281	into the scalar given by $data and offset $dataoffset and calls the	328	$offset into the scalar given by $data and offset $dataoffset and
282	callback without the actual number of bytes read (or -1 on error,	329	calls the callback without the actual number of bytes read (or -1 on
283	just like the syscall).	330	error, just like the syscall).
		331
		332	"aio_read" will, like "sysread", shrink or grow the $data scalar to
		333	offset plus the actual number of bytes read.
284		334
285	If $offset is undefined, then the current file descriptor offset	335	If $offset is undefined, then the current file descriptor offset
286	will be used (and updated), otherwise the file descriptor offset	336	will be used (and updated), otherwise the file descriptor offset
287	will not be changed by these calls.	337	will not be changed by these calls.
288		338
…		…
311	more than one "aio_sendfile" per $out_fh, as they will interfere	361	more than one "aio_sendfile" per $out_fh, as they will interfere
312	with each other.	362	with each other.
313		363
314	This call tries to make use of a native "sendfile" syscall to	364	This call tries to make use of a native "sendfile" syscall to
315	provide zero-copy operation. For this to work, $out_fh should refer	365	provide zero-copy operation. For this to work, $out_fh should refer
316	to a socket, and $in_fh should refer to mmap'able file.	366	to a socket, and $in_fh should refer to an mmap'able file.
317		367
318	If the native sendfile call fails or is not implemented, it will be	368	If a native sendfile cannot be found or it fails with "ENOSYS",
		369	"ENOTSUP", "EOPNOTSUPP", "EAFNOSUPPORT", "EPROTOTYPE" or "ENOTSOCK",
319	emulated, so you can call "aio_sendfile" on any type of filehandle	370	it will be emulated, so you can call "aio_sendfile" on any type of
320	regardless of the limitations of the operating system.	371	filehandle regardless of the limitations of the operating system.
321		372
322	Please note, however, that "aio_sendfile" can read more bytes from	373	Please note, however, that "aio_sendfile" can read more bytes from
323	$in_fh than are written, and there is no way to find out how many	374	$in_fh than are written, and there is no way to find out how many
324	bytes have been read from "aio_sendfile" alone, as "aio_sendfile"	375	bytes have been read from "aio_sendfile" alone, as "aio_sendfile"
325	only provides the number of bytes written to $out_fh. Only if the	376	only provides the number of bytes written to $out_fh. Only if the
…		…
360	aio_stat "/etc/passwd", sub {	411	aio_stat "/etc/passwd", sub {
361	$_[0] and die "stat failed: $!";	412	$_[0] and die "stat failed: $!";
362	print "size is ", -s _, "\n";	413	print "size is ", -s _, "\n";
363	};	414	};
364		415
		416	aio_statvfs $fh_or_path, $callback->($statvfs)
		417	Works like the POSIX "statvfs" or "fstatvfs" syscalls, depending on
		418	whether a file handle or path was passed.
		419
		420	On success, the callback is passed a hash reference with the
		421	following members: "bsize", "frsize", "blocks", "bfree", "bavail",
		422	"files", "ffree", "favail", "fsid", "flag" and "namemax". On
		423	failure, "undef" is passed.
		424
		425	The following POSIX IO::AIO::ST_* constants are defined: "ST_RDONLY"
		426	and "ST_NOSUID".
		427
		428	The following non-POSIX IO::AIO::ST_* flag masks are defined to
		429	their correct value when available, or to 0 on systems that do not
		430	support them: "ST_NODEV", "ST_NOEXEC", "ST_SYNCHRONOUS",
		431	"ST_MANDLOCK", "ST_WRITE", "ST_APPEND", "ST_IMMUTABLE",
		432	"ST_NOATIME", "ST_NODIRATIME" and "ST_RELATIME".
		433
		434	Example: stat "/wd" and dump out the data if successful.
		435
		436	aio_statvfs "/wd", sub {
		437	my $f = $_[0]
		438	or die "statvfs: $!";
		439
		440	use Data::Dumper;
		441	say Dumper $f;
		442	};
		443
		444	# result:
		445	{
		446	bsize => 1024,
		447	bfree => 4333064312,
		448	blocks => 10253828096,
		449	files => 2050765568,
		450	flag => 4096,
		451	favail => 2042092649,
		452	bavail => 4333064312,
		453	ffree => 2042092649,
		454	namemax => 255,
		455	frsize => 1024,
		456	fsid => 1810
		457	}
		458
365	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)	459	aio_utime $fh_or_path, $atime, $mtime, $callback->($status)
366	Works like perl's "utime" function (including the special case of	460	Works like perl's "utime" function (including the special case of
367	$atime and $mtime being undef). Fractional times are supported if	461	$atime and $mtime being undef). Fractional times are supported if
368	the underlying syscalls support them.	462	the underlying syscalls support them.
369		463
…		…
439	aio_readdir $pathname, $callback->($entries)	533	aio_readdir $pathname, $callback->($entries)
440	Unlike the POSIX call of the same name, "aio_readdir" reads an	534	Unlike the POSIX call of the same name, "aio_readdir" reads an
441	entire directory (i.e. opendir + readdir + closedir). The entries	535	entire directory (i.e. opendir + readdir + closedir). The entries
442	will not be sorted, and will NOT include the "." and ".." entries.	536	will not be sorted, and will NOT include the "." and ".." entries.
443		537
444	The callback a single argument which is either "undef" or an	538	The callback is passed a single argument which is either "undef" or
445	array-ref with the filenames.	539	an array-ref with the filenames.
		540
		541	aio_readdirx $pathname, $flags, $callback->($entries, $flags)
		542	Quite similar to "aio_readdir", but the $flags argument allows to
		543	tune behaviour and output format. In case of an error, $entries will
		544	be "undef".
		545
		546	The flags are a combination of the following constants, ORed
		547	together (the flags will also be passed to the callback, possibly
		548	modified):
		549
		550	IO::AIO::READDIR_DENTS
		551	When this flag is off, then the callback gets an arrayref with
		552	of names only (as with "aio_readdir"), otherwise it gets an
		553	arrayref with "[$name, $type, $inode]" arrayrefs, each
		554	describing a single directory entry in more detail.
		555
		556	$name is the name of the entry.
		557
		558	$type is one of the "IO::AIO::DT_xxx" constants:
		559
		560	"IO::AIO::DT_UNKNOWN", "IO::AIO::DT_FIFO", "IO::AIO::DT_CHR",
		561	"IO::AIO::DT_DIR", "IO::AIO::DT_BLK", "IO::AIO::DT_REG",
		562	"IO::AIO::DT_LNK", "IO::AIO::DT_SOCK", "IO::AIO::DT_WHT".
		563
		564	"IO::AIO::DT_UNKNOWN" means just that: readdir does not know. If
		565	you need to know, you have to run stat yourself. Also, for speed
		566	reasons, the $type scalars are read-only: you can not modify
		567	them.
		568
		569	$inode is the inode number (which might not be exact on systems
		570	with 64 bit inode numbers and 32 bit perls). This field has
		571	unspecified content on systems that do not deliver the inode
		572	information.
		573
		574	IO::AIO::READDIR_DIRS_FIRST
		575	When this flag is set, then the names will be returned in an
		576	order where likely directories come first. This is useful when
		577	you need to quickly find directories, or you want to find all
		578	directories while avoiding to stat() each entry.
		579
		580	If the system returns type information in readdir, then this is
		581	used to find directories directly. Otherwise, likely directories
		582	are files beginning with ".", or otherwise files with no dots,
		583	of which files with short names are tried first.
		584
		585	IO::AIO::READDIR_STAT_ORDER
		586	When this flag is set, then the names will be returned in an
		587	order suitable for stat()'ing each one. That is, when you plan
		588	to stat() all files in the given directory, then the returned
		589	order will likely be fastest.
		590
		591	If both this flag and "IO::AIO::READDIR_DIRS_FIRST" are
		592	specified, then the likely dirs come first, resulting in a less
		593	optimal stat order.
		594
		595	IO::AIO::READDIR_FOUND_UNKNOWN
		596	This flag should not be set when calling "aio_readdirx".
		597	Instead, it is being set by "aio_readdirx", when any of the
		598	$type's found were "IO::AIO::DT_UNKNOWN". The absense of this
		599	flag therefore indicates that all $type's are known, which can
		600	be used to speed up some algorithms.
446		601
447	aio_load $path, $data, $callback->($status)	602	aio_load $path, $data, $callback->($status)
448	This is a composite request that tries to fully load the given file	603	This is a composite request that tries to fully load the given file
449	into memory. Status is the same as with aio_read.	604	into memory. Status is the same as with aio_read.
450		605
451	aio_copy $srcpath, $dstpath, $callback->($status)	606	aio_copy $srcpath, $dstpath, $callback->($status)
452	Try to copy the file (directories not supported as either source	607	Try to copy the file (directories not supported as either source
453	or destination) from $srcpath to $dstpath and call the callback with	608	or destination) from $srcpath to $dstpath and call the callback with
454	the 0 (error) or -1 ok.	609	a status of 0 (ok) or -1 (error, see $!).
455		610
456	This is a composite request that creates the destination file with	611	This is a composite request that creates the destination file with
457	mode 0200 and copies the contents of the source file into it using	612	mode 0200 and copies the contents of the source file into it using
458	"aio_sendfile", followed by restoring atime, mtime, access mode and	613	"aio_sendfile", followed by restoring atime, mtime, access mode and
459	uid/gid, in that order.	614	uid/gid, in that order.
…		…
463	uid/gid, where errors are being ignored.	618	uid/gid, where errors are being ignored.
464		619
465	aio_move $srcpath, $dstpath, $callback->($status)	620	aio_move $srcpath, $dstpath, $callback->($status)
466	Try to move the file (directories not supported as either source	621	Try to move the file (directories not supported as either source
467	or destination) from $srcpath to $dstpath and call the callback with	622	or destination) from $srcpath to $dstpath and call the callback with
468	the 0 (error) or -1 ok.	623	a status of 0 (ok) or -1 (error, see $!).
469		624
470	This is a composite request that tries to rename(2) the file first;	625	This is a composite request that tries to rename(2) the file first;
471	if rename fails with "EXDEV", it copies the file with "aio_copy"	626	if rename fails with "EXDEV", it copies the file with "aio_copy"
472	and, if that is successful, unlinks the $srcpath.	627	and, if that is successful, unlinks the $srcpath.
473		628
…		…
497	Implementation notes.	652	Implementation notes.
498		653
499	The "aio_readdir" cannot be avoided, but "stat()"'ing every entry	654	The "aio_readdir" cannot be avoided, but "stat()"'ing every entry
500	can.	655	can.
501		656
		657	If readdir returns file type information, then this is used directly
		658	to find directories.
		659
502	After reading the directory, the modification time, size etc. of the	660	Otherwise, after reading the directory, the modification time, size
503	directory before and after the readdir is checked, and if they match	661	etc. of the directory before and after the readdir is checked, and
504	(and isn't the current time), the link count will be used to decide	662	if they match (and isn't the current time), the link count will be
505	how many entries are directories (if >= 2). Otherwise, no knowledge	663	used to decide how many entries are directories (if >= 2).
506	of the number of subdirectories will be assumed.	664	Otherwise, no knowledge of the number of subdirectories will be
		665	assumed.
507		666
508	Then entries will be sorted into likely directories (everything	667	Then entries will be sorted into likely directories a non-initial
509	without a non-initial dot currently) and likely non-directories	668	dot currently) and likely non-directories (see "aio_readdirx"). Then
510	(everything else). Then every entry plus an appended "/." will be	669	every entry plus an appended "/." will be "stat"'ed, likely
511	"stat"'ed, likely directories first. If that succeeds, it assumes	670	directories first, in order of their inode numbers. If that
512	that the entry is a directory or a symlink to directory (which will	671	succeeds, it assumes that the entry is a directory or a symlink to
513	be checked seperately). This is often faster than stat'ing the entry	672	directory (which will be checked seperately). This is often faster
514	itself because filesystems might detect the type of the entry	673	than stat'ing the entry itself because filesystems might detect the
515	without reading the inode data (e.g. ext2fs filetype feature).	674	type of the entry without reading the inode data (e.g. ext2fs
		675	filetype feature), even on systems that cannot return the filetype
		676	information on readdir.
516		677
517	If the known number of directories (link count - 2) has been	678	If the known number of directories (link count - 2) has been
518	reached, the rest of the entries is assumed to be non-directories.	679	reached, the rest of the entries is assumed to be non-directories.
519		680
520	This only works with certainty on POSIX (= UNIX) filesystems, which	681	This only works with certainty on POSIX (= UNIX) filesystems, which
…		…
541	Asynchronously call fdatasync on the given filehandle and call the	702	Asynchronously call fdatasync on the given filehandle and call the
542	callback with the fdatasync result code.	703	callback with the fdatasync result code.
543		704
544	If this call isn't available because your OS lacks it or it couldn't	705	If this call isn't available because your OS lacks it or it couldn't
545	be detected, it will be emulated by calling "fsync" instead.	706	be detected, it will be emulated by calling "fsync" instead.
		707
		708	aio_sync_file_range $fh, $offset, $nbytes, $flags, $callback->($status)
		709	Sync the data portion of the file specified by $offset and $length
		710	to disk (but NOT the metadata), by calling the Linux-specific
		711	sync_file_range call. If sync_file_range is not available or it
		712	returns ENOSYS, then fdatasync or fsync is being substituted.
		713
		714	$flags can be a combination of
		715	"IO::AIO::SYNC_FILE_RANGE_WAIT_BEFORE",
		716	"IO::AIO::SYNC_FILE_RANGE_WRITE" and
		717	"IO::AIO::SYNC_FILE_RANGE_WAIT_AFTER": refer to the sync_file_range
		718	manpage for details.
546		719
547	aio_pathsync $path, $callback->($status)	720	aio_pathsync $path, $callback->($status)
548	This request tries to open, fsync and close the given path. This is	721	This request tries to open, fsync and close the given path. This is
549	a composite request intended to sync directories after directory	722	a composite request intended to sync directories after directory
550	operations (E.g. rename). This might not work on all operating	723	operations (E.g. rename). This might not work on all operating
551	systems or have any specific effect, but usually it makes sure that	724	systems or have any specific effect, but usually it makes sure that
552	directory changes get written to disc. It works for anything that	725	directory changes get written to disc. It works for anything that
553	can be opened for read-only, not just directories.	726	can be opened for read-only, not just directories.
554		727
		728	Future versions of this function might fall back to other methods
		729	when "fsync" on the directory fails (such as calling "sync").
		730
555	Passes 0 when everything went ok, and -1 on error.	731	Passes 0 when everything went ok, and -1 on error.
		732
		733	aio_msync $scalar, $offset = 0, $length = undef, flags = 0,
		734	$callback->($status)
		735	This is a rather advanced IO::AIO call, which only works on
		736	mmap(2)ed scalars (see the "IO::AIO::mmap" function, although it
		737	also works on data scalars managed by the Sys::Mmap or Mmap modules,
		738	note that the scalar must only be modified in-place while an aio
		739	operation is pending on it).
		740
		741	It calls the "msync" function of your OS, if available, with the
		742	memory area starting at $offset in the string and ending $length
		743	bytes later. If $length is negative, counts from the end, and if
		744	$length is "undef", then it goes till the end of the string. The
		745	flags can be a combination of "IO::AIO::MS_ASYNC",
		746	"IO::AIO::MS_INVALIDATE" and "IO::AIO::MS_SYNC".
		747
		748	aio_mtouch $scalar, $offset = 0, $length = undef, flags = 0,
		749	$callback->($status)
		750	This is a rather advanced IO::AIO call, which works best on
		751	mmap(2)ed scalars.
		752
		753	It touches (reads or writes) all memory pages in the specified range
		754	inside the scalar. All caveats and parameters are the same as for
		755	"aio_msync", above, except for flags, which must be either 0 (which
		756	reads all pages and ensures they are instantiated) or
		757	"IO::AIO::MT_MODIFY", which modifies the memory page s(by reading
		758	and writing an octet from it, which dirties the page).
		759
		760	aio_mlock $scalar, $offset = 0, $length = undef, $callback->($status)
		761	This is a rather advanced IO::AIO call, which works best on
		762	mmap(2)ed scalars.
		763
		764	It reads in all the pages of the underlying storage into memory (if
		765	any) and locks them, so they are not getting swapped/paged out or
		766	removed.
		767
		768	If $length is undefined, then the scalar will be locked till the
		769	end.
		770
		771	On systems that do not implement "mlock", this function returns -1
		772	and sets errno to "ENOSYS".
		773
		774	Note that the corresponding "munlock" is synchronous and is
		775	documented under "MISCELLANEOUS FUNCTIONS".
		776
		777	Example: open a file, mmap and mlock it - both will be undone when
		778	$data gets destroyed.
		779
		780	open my $fh, "<", $path or die "$path: $!";
		781	my $data;
		782	IO::AIO::mmap $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh;
		783	aio_mlock $data; # mlock in background
		784
		785	aio_mlockall $flags, $callback->($status)
		786	Calls the "mlockall" function with the given $flags (a combination
		787	of "IO::AIO::MCL_CURRENT" and "IO::AIO::MCL_FUTURE").
		788
		789	On systems that do not implement "mlockall", this function returns
		790	-1 and sets errno to "ENOSYS".
		791
		792	Note that the corresponding "munlockall" is synchronous and is
		793	documented under "MISCELLANEOUS FUNCTIONS".
		794
		795	Example: asynchronously lock all current and future pages into
		796	memory.
		797
		798	aio_mlockall IO::AIO::MCL_FUTURE;
556		799
557	aio_group $callback->(...)	800	aio_group $callback->(...)
558	This is a very special aio request: Instead of doing something, it	801	This is a very special aio request: Instead of doing something, it
559	is a container for other aio requests, which is useful if you want	802	is a container for other aio requests, which is useful if you want
560	to bundle many requests into a single, composite, request with a	803	to bundle many requests into a single, composite, request with a
…		…
603		846
604	cancel $req	847	cancel $req
605	Cancels the request, if possible. Has the effect of skipping	848	Cancels the request, if possible. Has the effect of skipping
606	execution when entering the execute state and skipping calling the	849	execution when entering the execute state and skipping calling the
607	callback when entering the the result state, but will leave the	850	callback when entering the the result state, but will leave the
608	request otherwise untouched. That means that requests that currently	851	request otherwise untouched (with the exception of readdir). That
609	execute will not be stopped and resources held by the request will	852	means that requests that currently execute will not be stopped and
610	not be freed prematurely.	853	resources held by the request will not be freed prematurely.
611		854
612	cb $req $callback->(...)	855	cb $req $callback->(...)
613	Replace (or simply set) the callback registered to the request.	856	Replace (or simply set) the callback registered to the request.
614		857
615	IO::AIO::GRP CLASS	858	IO::AIO::GRP CLASS
…		…
676		919
677	$grp->cancel_subs	920	$grp->cancel_subs
678	Cancel all subrequests and clears any feeder, but not the group	921	Cancel all subrequests and clears any feeder, but not the group
679	request itself. Useful when you queued a lot of events but got a	922	request itself. Useful when you queued a lot of events but got a
680	result early.	923	result early.
		924
		925	The group request will finish normally (you cannot add requests to
		926	the group).
681		927
682	$grp->result (...)	928	$grp->result (...)
683	Set the result value(s) that will be passed to the group callback	929	Set the result value(s) that will be passed to the group callback
684	when all subrequests have finished and set the groups errno to the	930	when all subrequests have finished and set the groups errno to the
685	current value of errno (just like calling "errno" without an error	931	current value of errno (just like calling "errno" without an error
…		…
745	SUPPORT FUNCTIONS	991	SUPPORT FUNCTIONS
746	EVENT PROCESSING AND EVENT LOOP INTEGRATION	992	EVENT PROCESSING AND EVENT LOOP INTEGRATION
747	$fileno = IO::AIO::poll_fileno	993	$fileno = IO::AIO::poll_fileno
748	Return the request result pipe file descriptor. This filehandle	994	Return the request result pipe file descriptor. This filehandle
749	must be polled for reading by some mechanism outside this module	995	must be polled for reading by some mechanism outside this module
750	(e.g. Event or select, see below or the SYNOPSIS). If the pipe	996	(e.g. EV, Glib, select and so on, see below or the SYNOPSIS). If the
751	becomes readable you have to call "poll_cb" to check the results.	997	pipe becomes readable you have to call "poll_cb" to check the
		998	results.
752		999
753	See "poll_cb" for an example.	1000	See "poll_cb" for an example.
754		1001
755	IO::AIO::poll_cb	1002	IO::AIO::poll_cb
756	Process some outstanding events on the result pipe. You have to call	1003	Process some outstanding events on the result pipe. You have to call
…		…
763	If not all requests were processed for whatever reason, the	1010	If not all requests were processed for whatever reason, the
764	filehandle will still be ready when "poll_cb" returns, so normally	1011	filehandle will still be ready when "poll_cb" returns, so normally
765	you don't have to do anything special to have it called later.	1012	you don't have to do anything special to have it called later.
766		1013
767	Example: Install an Event watcher that automatically calls	1014	Example: Install an Event watcher that automatically calls
768	IO::AIO::poll_cb with high priority:	1015	IO::AIO::poll_cb with high priority (more examples can be found in
		1016	the SYNOPSIS section, at the top of this document):
769		1017
770	Event->io (fd => IO::AIO::poll_fileno,	1018	Event->io (fd => IO::AIO::poll_fileno,
771	poll => 'r', async => 1,	1019	poll => 'r', async => 1,
772	cb => \&IO::AIO::poll_cb);	1020	cb => \&IO::AIO::poll_cb);
		1021
		1022	IO::AIO::poll_wait
		1023	If there are any outstanding requests and none of them in the result
		1024	phase, wait till the result filehandle becomes ready for reading
		1025	(simply does a "select" on the filehandle. This is useful if you
		1026	want to synchronously wait for some requests to finish).
		1027
		1028	See "nreqs" for an example.
		1029
		1030	IO::AIO::poll
		1031	Waits until some requests have been handled.
		1032
		1033	Returns the number of requests processed, but is otherwise strictly
		1034	equivalent to:
		1035
		1036	IO::AIO::poll_wait, IO::AIO::poll_cb
		1037
		1038	IO::AIO::flush
		1039	Wait till all outstanding AIO requests have been handled.
		1040
		1041	Strictly equivalent to:
		1042
		1043	IO::AIO::poll_wait, IO::AIO::poll_cb
		1044	while IO::AIO::nreqs;
773		1045
774	IO::AIO::max_poll_reqs $nreqs	1046	IO::AIO::max_poll_reqs $nreqs
775	IO::AIO::max_poll_time $seconds	1047	IO::AIO::max_poll_time $seconds
776	These set the maximum number of requests (default 0, meaning	1048	These set the maximum number of requests (default 0, meaning
777	infinity) that are being processed by "IO::AIO::poll_cb" in one	1049	infinity) that are being processed by "IO::AIO::poll_cb" in one
…		…
801	# use a low priority so other tasks have priority	1073	# use a low priority so other tasks have priority
802	Event->io (fd => IO::AIO::poll_fileno,	1074	Event->io (fd => IO::AIO::poll_fileno,
803	poll => 'r', nice => 1,	1075	poll => 'r', nice => 1,
804	cb => &IO::AIO::poll_cb);	1076	cb => &IO::AIO::poll_cb);
805		1077
806	IO::AIO::poll_wait
807	If there are any outstanding requests and none of them in the result
808	phase, wait till the result filehandle becomes ready for reading
809	(simply does a "select" on the filehandle. This is useful if you
810	want to synchronously wait for some requests to finish).
811
812	See "nreqs" for an example.
813
814	IO::AIO::poll
815	Waits until some requests have been handled.
816
817	Returns the number of requests processed, but is otherwise strictly
818	equivalent to:
819
820	IO::AIO::poll_wait, IO::AIO::poll_cb
821
822	IO::AIO::flush
823	Wait till all outstanding AIO requests have been handled.
824
825	Strictly equivalent to:
826
827	IO::AIO::poll_wait, IO::AIO::poll_cb
828	while IO::AIO::nreqs;
829
830	CONTROLLING THE NUMBER OF THREADS	1078	CONTROLLING THE NUMBER OF THREADS
831	IO::AIO::min_parallel $nthreads	1079	IO::AIO::min_parallel $nthreads
832	Set the minimum number of AIO threads to $nthreads. The current	1080	Set the minimum number of AIO threads to $nthreads. The current
833	default is 8, which means eight asynchronous operations can execute	1081	default is 8, which means eight asynchronous operations can execute
834	concurrently at any one time (the number of outstanding requests,	1082	concurrently at any one time (the number of outstanding requests,
…		…
912	executed).	1160	executed).
913		1161
914	IO::AIO::npending	1162	IO::AIO::npending
915	Returns the number of requests currently in the pending state	1163	Returns the number of requests currently in the pending state
916	(executed, but not yet processed by poll_cb).	1164	(executed, but not yet processed by poll_cb).
		1165
		1166	MISCELLANEOUS FUNCTIONS
		1167	IO::AIO implements some functions that might be useful, but are not
		1168	asynchronous.
		1169
		1170	IO::AIO::sendfile $ofh, $ifh, $offset, $count
		1171	Calls the "eio_sendfile_sync" function, which is like
		1172	"aio_sendfile", but is blocking (this makes most sense if you know
		1173	the input data is likely cached already and the output filehandle is
		1174	set to non-blocking operations).
		1175
		1176	Returns the number of bytes copied, or -1 on error.
		1177
		1178	IO::AIO::fadvise $fh, $offset, $len, $advice
		1179	Simply calls the "posix_fadvise" function (see its manpage for
		1180	details). The following advice constants are avaiable:
		1181	"IO::AIO::FADV_NORMAL", "IO::AIO::FADV_SEQUENTIAL",
		1182	"IO::AIO::FADV_RANDOM", "IO::AIO::FADV_NOREUSE",
		1183	"IO::AIO::FADV_WILLNEED", "IO::AIO::FADV_DONTNEED".
		1184
		1185	On systems that do not implement "posix_fadvise", this function
		1186	returns ENOSYS, otherwise the return value of "posix_fadvise".
		1187
		1188	IO::AIO::madvise $scalar, $offset, $len, $advice
		1189	Simply calls the "posix_madvise" function (see its manpage for
		1190	details). The following advice constants are avaiable:
		1191	"IO::AIO::MADV_NORMAL", "IO::AIO::MADV_SEQUENTIAL",
		1192	"IO::AIO::MADV_RANDOM", "IO::AIO::MADV_WILLNEED",
		1193	"IO::AIO::MADV_DONTNEED".
		1194
		1195	On systems that do not implement "posix_madvise", this function
		1196	returns ENOSYS, otherwise the return value of "posix_madvise".
		1197
		1198	IO::AIO::mprotect $scalar, $offset, $len, $protect
		1199	Simply calls the "mprotect" function on the preferably AIO::mmap'ed
		1200	$scalar (see its manpage for details). The following protect
		1201	constants are avaiable: "IO::AIO::PROT_NONE", "IO::AIO::PROT_READ",
		1202	"IO::AIO::PROT_WRITE", "IO::AIO::PROT_EXEC".
		1203
		1204	On systems that do not implement "mprotect", this function returns
		1205	ENOSYS, otherwise the return value of "mprotect".
		1206
		1207	IO::AIO::mmap $scalar, $length, $prot, $flags, $fh[, $offset]
		1208	Memory-maps a file (or anonymous memory range) and attaches it to
		1209	the given $scalar, which will act like a string scalar.
		1210
		1211	The only operations allowed on the scalar are "substr"/"vec" that
		1212	don't change the string length, and most read-only operations such
		1213	as copying it or searching it with regexes and so on.
		1214
		1215	Anything else is unsafe and will, at best, result in memory leaks.
		1216
		1217	The memory map associated with the $scalar is automatically removed
		1218	when the $scalar is destroyed, or when the "IO::AIO::mmap" or
		1219	"IO::AIO::munmap" functions are called.
		1220
		1221	This calls the "mmap"(2) function internally. See your system's
		1222	manual page for details on the $length, $prot and $flags parameters.
		1223
		1224	The $length must be larger than zero and smaller than the actual
		1225	filesize.
		1226
		1227	$prot is a combination of "IO::AIO::PROT_NONE",
		1228	"IO::AIO::PROT_EXEC", "IO::AIO::PROT_READ" and/or
		1229	"IO::AIO::PROT_WRITE",
		1230
		1231	$flags can be a combination of "IO::AIO::MAP_SHARED" or
		1232	"IO::AIO::MAP_PRIVATE", or a number of system-specific flags (when
		1233	not available, the are defined as 0): "IO::AIO::MAP_ANONYMOUS"
		1234	(which is set to "MAP_ANON" if your system only provides this
		1235	constant), "IO::AIO::MAP_HUGETLB", "IO::AIO::MAP_LOCKED",
		1236	"IO::AIO::MAP_NORESERVE", "IO::AIO::MAP_POPULATE" or
		1237	"IO::AIO::MAP_NONBLOCK"
		1238
		1239	If $fh is "undef", then a file descriptor of -1 is passed.
		1240
		1241	$offset is the offset from the start of the file - it generally must
		1242	be a multiple of "IO::AIO::PAGESIZE" and defaults to 0.
		1243
		1244	Example:
		1245
		1246	use Digest::MD5;
		1247	use IO::AIO;
		1248
		1249	open my $fh, "<verybigfile"
		1250	or die "$!";
		1251
		1252	IO::AIO::mmap my $data, -s $fh, IO::AIO::PROT_READ, IO::AIO::MAP_SHARED, $fh
		1253	or die "verybigfile: $!";
		1254
		1255	my $fast_md5 = md5 $data;
		1256
		1257	IO::AIO::munmap $scalar
		1258	Removes a previous mmap and undefines the $scalar.
		1259
		1260	IO::AIO::munlock $scalar, $offset = 0, $length = undef
		1261	Calls the "munlock" function, undoing the effects of a previous
		1262	"aio_mlock" call (see its description for details).
		1263
		1264	IO::AIO::munlockall
		1265	Calls the "munlockall" function.
		1266
		1267	On systems that do not implement "munlockall", this function returns
		1268	ENOSYS, otherwise the return value of "munlockall".
		1269
		1270	EVENT LOOP INTEGRATION
		1271	It is recommended to use AnyEvent::AIO to integrate IO::AIO
		1272	automatically into many event loops:
		1273
		1274	# AnyEvent integration (EV, Event, Glib, Tk, POE, urxvt, pureperl...)
		1275	use AnyEvent::AIO;
		1276
		1277	You can also integrate IO::AIO manually into many event loops, here are
		1278	some examples of how to do this:
		1279
		1280	# EV integration
		1281	my $aio_w = EV::io IO::AIO::poll_fileno, EV::READ, \&IO::AIO::poll_cb;
		1282
		1283	# Event integration
		1284	Event->io (fd => IO::AIO::poll_fileno,
		1285	poll => 'r',
		1286	cb => \&IO::AIO::poll_cb);
		1287
		1288	# Glib/Gtk2 integration
		1289	add_watch Glib::IO IO::AIO::poll_fileno,
		1290	in => sub { IO::AIO::poll_cb; 1 };
		1291
		1292	# Tk integration
		1293	Tk::Event::IO->fileevent (IO::AIO::poll_fileno, "",
		1294	readable => \&IO::AIO::poll_cb);
		1295
		1296	# Danga::Socket integration
		1297	Danga::Socket->AddOtherFds (IO::AIO::poll_fileno =>
		1298	\&IO::AIO::poll_cb);
917		1299
918	FORK BEHAVIOUR	1300	FORK BEHAVIOUR
919	This module should do "the right thing" when the process using it forks:	1301	This module should do "the right thing" when the process using it forks:
920		1302
921	Before the fork, IO::AIO enters a quiescent state where no requests can	1303	Before the fork, IO::AIO enters a quiescent state where no requests can

Diff Legend

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

Comparing IO-AIO/README (file contents): Revision 1.33 by root, Sun Oct 12 22:40:52 2008 UTC vs. Revision 1.44 by root, Mon Nov 1 22:03:43 2010 UTC

Diff Legend

Comparing IO-AIO/README (file contents):
Revision 1.33 by root, Sun Oct 12 22:40:52 2008 UTC vs.
Revision 1.44 by root, Mon Nov 1 22:03:43 2010 UTC