[ViewVC] Diff of: cvs/Coro/README

Comparing Coro/README (file contents):
Revision 1.18 by root, Thu Nov 20 09:37:21 2008 UTC vs.
Revision 1.30 by root, Wed Jun 29 17:58:52 2011 UTC

…		…
1	NAME	1	NAME
2	Coro - coroutine process abstraction	2	Coro - the only real threads in perl
3		3
4	SYNOPSIS	4	SYNOPSIS
5	use Coro;	5	use Coro;
6		6
7	async {	7	async {
8	# some asynchronous thread of execution	8	# some asynchronous thread of execution
9	print "2\n";	9	print "2\n";
10	cede; # yield back to main	10	cede; # yield back to main
11	print "4\n";	11	print "4\n";
12	};	12	};
13	print "1\n";	13	print "1\n";
14	cede; # yield to coroutine	14	cede; # yield to coro
15	print "3\n";	15	print "3\n";
16	cede; # and again	16	cede; # and again
17		17
18	# use locking	18	# use locking
19	use Coro::Semaphore;
20	my $lock = new Coro::Semaphore;	19	my $lock = new Coro::Semaphore;
21	my $locked;	20	my $locked;
22		21
23	$lock->down;	22	$lock->down;
24	$locked = 1;	23	$locked = 1;
25	$lock->up;	24	$lock->up;
26		25
27	DESCRIPTION	26	DESCRIPTION
28	This module collection manages coroutines. Coroutines are similar to	27	For a tutorial-style introduction, please read the Coro::Intro manpage.
29	threads but don't (in general) run in parallel at the same time even on	28	This manpage mainly contains reference information.
30	SMP machines. The specific flavor of coroutine used in this module also	29
31	guarantees you that it will not switch between coroutines unless	30	This module collection manages continuations in general, most often in
		31	the form of cooperative threads (also called coros, or simply "coro" in
		32	the documentation). They are similar to kernel threads but don't (in
		33	general) run in parallel at the same time even on SMP machines. The
		34	specific flavor of thread offered by this module also guarantees you
		35	that it will not switch between threads unless necessary, at
32	necessary, at easily-identified points in your program, so locking and	36	easily-identified points in your program, so locking and parallel access
33	parallel access are rarely an issue, making coroutine programming much	37	are rarely an issue, making thread programming much safer and easier
34	safer and easier than threads programming.	38	than using other thread models.
35		39
36	Unlike a normal perl program, however, coroutines allow you to have	40	Unlike the so-called "Perl threads" (which are not actually real threads
37	multiple running interpreters that share data, which is especially	41	but only the windows process emulation (see section of same name for
38	useful to code pseudo-parallel processes and for event-based	42	more details) ported to UNIX, and as such act as processes), Coro
39	programming, such as multiple HTTP-GET requests running concurrently.	43	provides a full shared address space, which makes communication between
40	See Coro::AnyEvent to learn more.	44	threads very easy. And coro threads are fast, too: disabling the Windows
		45	process emulation code in your perl and using Coro can easily result in
		46	a two to four times speed increase for your programs. A parallel matrix
		47	multiplication benchmark (very communication-intensive) runs over 300
		48	times faster on a single core than perls pseudo-threads on a quad core
		49	using all four cores.
41		50
42	Coroutines are also useful because Perl has no support for threads (the	51	Coro achieves that by supporting multiple running interpreters that
43	so called "threads" that perl offers are nothing more than the (bad)	52	share data, which is especially useful to code pseudo-parallel processes
44	process emulation coming from the Windows platform: On standard	53	and for event-based programming, such as multiple HTTP-GET requests
45	operating systems they serve no purpose whatsoever, except by making	54	running concurrently. See Coro::AnyEvent to learn more on how to
46	your programs slow and making them use a lot of memory. Best disable	55	integrate Coro into an event-based environment.
47	them when building perl, or aks your software vendor/distributor to do
48	it for you).
49		56
50	In this module, coroutines are defined as "callchain + lexical variables	57	In this module, a thread is defined as "callchain + lexical variables +
51	+ @_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own	58	some package variables + C stack), that is, a thread has its own
52	callchain, its own set of lexicals and its own set of perls most	59	callchain, its own set of lexicals and its own set of perls most
53	important global variables (see Coro::State for more configuration).	60	important global variables (see Coro::State for more configuration and
		61	background info).
54		62
		63	See also the "SEE ALSO" section at the end of this document - the Coro
		64	module family is quite large.
		65
		66	CORO THREAD LIFE CYCLE
		67	During the long and exciting (or not) life of a coro thread, it goes
		68	through a number of states:
		69
		70	1. Creation
		71	The first thing in the life of a coro thread is it's creation -
		72	obviously. The typical way to create a thread is to call the "async
		73	BLOCK" function:
		74
		75	async {
		76	# thread code goes here
		77	};
		78
		79	You can also pass arguments, which are put in @_:
		80
		81	async {
		82	print $_[1]; # prints 2
		83	} 1, 2, 3;
		84
		85	This creates a new coro thread and puts it into the ready queue,
		86	meaning it will run as soon as the CPU is free for it.
		87
		88	"async" will return a Coro object - you can store this for future
		89	reference or ignore it - a thread that is running, ready to run or
		90	waiting for some event is alive on it's own.
		91
		92	Another way to create a thread is to call the "new" constructor with
		93	a code-reference:
		94
		95	new Coro sub {
		96	# thread code goes here
		97	}, @optional_arguments;
		98
		99	This is quite similar to calling "async", but the important
		100	difference is that the new thread is not put into the ready queue,
		101	so the thread will not run until somebody puts it there. "async" is,
		102	therefore, identical to this sequence:
		103
		104	my $coro = new Coro sub {
		105	# thread code goes here
		106	};
		107	$coro->ready;
		108	return $coro;
		109
		110	2. Startup
		111	When a new coro thread is created, only a copy of the code reference
		112	and the arguments are stored, no extra memory for stacks and so on
		113	is allocated, keeping the coro thread in a low-memory state.
		114
		115	Only when it actually starts executing will all the resources be
		116	finally allocated.
		117
		118	The optional arguments specified at coro creation are available in
		119	@_, similar to function calls.
		120
		121	3. Running / Blocking
		122	A lot can happen after the coro thread has started running. Quite
		123	usually, it will not run to the end in one go (because you could use
		124	a function instead), but it will give up the CPU regularly because
		125	it waits for external events.
		126
		127	As long as a coro thread runs, its Coro object is available in the
		128	global variable $Coro::current.
		129
		130	The low-level way to give up the CPU is to call the scheduler, which
		131	selects a new coro thread to run:
		132
		133	Coro::schedule;
		134
		135	Since running threads are not in the ready queue, calling the
		136	scheduler without doing anything else will block the coro thread
		137	forever - you need to arrange either for the coro to put woken up
		138	(readied) by some other event or some other thread, or you can put
		139	it into the ready queue before scheduling:
		140
		141	# this is exactly what Coro::cede does
		142	$Coro::current->ready;
		143	Coro::schedule;
		144
		145	All the higher-level synchronisation methods (Coro::Semaphore,
		146	Coro::rouse_*...) are actually implemented via "->ready" and
		147	"Coro::schedule".
		148
		149	While the coro thread is running it also might get assigned a
		150	C-level thread, or the C-level thread might be unassigned from it,
		151	as the Coro runtime wishes. A C-level thread needs to be assigned
		152	when your perl thread calls into some C-level function and that
		153	function in turn calls perl and perl then wants to switch
		154	coroutines. This happens most often when you run an event loop and
		155	block in the callback, or when perl itself calls some function such
		156	as "AUTOLOAD" or methods via the "tie" mechanism.
		157
		158	4. Termination
		159	Many threads actually terminate after some time. There are a number
		160	of ways to terminate a coro thread, the simplest is returning from
		161	the top-level code reference:
		162
		163	async {
		164	# after returning from here, the coro thread is terminated
		165	};
		166
		167	async {
		168	return if 0.5 < rand; # terminate a little earlier, maybe
		169	print "got a chance to print this\n";
		170	# or here
		171	};
		172
		173	Any values returned from the coroutine can be recovered using
		174	"->join":
		175
		176	my $coro = async {
		177	"hello, world\n" # return a string
		178	};
		179
		180	my $hello_world = $coro->join;
		181
		182	print $hello_world;
		183
		184	Another way to terminate is to call "Coro::terminate", which at any
		185	subroutine call nesting level:
		186
		187	async {
		188	Coro::terminate "return value 1", "return value 2";
		189	};
		190
		191	And yet another way is to "->cancel" (or "->safe_cancel") the coro
		192	thread from another thread:
		193
		194	my $coro = async {
		195	exit 1;
		196	};
		197
		198	$coro->cancel; # also accepts values for ->join to retrieve
		199
		200	Cancellation can be dangerous - it's a bit like calling "exit"
		201	without actually exiting, and might leave C libraries and XS modules
		202	in a weird state. Unlike other thread implementations, however, Coro
		203	is exceptionally safe with regards to cancellation, as perl will
		204	always be in a consistent state, and for those cases where you want
		205	to do truly marvellous things with your coro while it is being
		206	cancelled - that is, make sure all cleanup code is executed from the
		207	thread being cancelled - there is even a "->safe_cancel" method.
		208
		209	So, cancelling a thread that runs in an XS event loop might not be
		210	the best idea, but any other combination that deals with perl only
		211	(cancelling when a thread is in a "tie" method or an "AUTOLOAD" for
		212	example) is safe.
		213
		214	Lastly, a coro thread object that isn't referenced is "->cancel"'ed
		215	automatically - just like other objects in Perl. This is not such a
		216	common case, however - a running thread is referencedy b
		217	$Coro::current, a thread ready to run is referenced by the ready
		218	queue, a thread waiting on a lock or semaphore is referenced by
		219	being in some wait list and so on. But a thread that isn't in any of
		220	those queues gets cancelled:
		221
		222	async {
		223	schedule; # cede to other coros, don't go into the ready queue
		224	};
		225
		226	cede;
		227	# now the async above is destroyed, as it is not referenced by anything.
		228
		229	5. Cleanup
		230	Threads will allocate various resources. Most but not all will be
		231	returned when a thread terminates, during clean-up.
		232
		233	Cleanup is quite similar to throwing an uncaught exception: perl
		234	will work it's way up through all subroutine calls and blocks. On
		235	it's way, it will release all "my" variables, undo all "local"'s and
		236	free any other resources truly local to the thread.
		237
		238	So, a common way to free resources is to keep them referenced only
		239	by my variables:
		240
		241	async {
		242	my $big_cache = new Cache ...;
		243	};
		244
		245	If there are no other references, then the $big_cache object will be
		246	freed when the thread terminates, regardless of how it does so.
		247
		248	What it does "NOT" do is unlock any Coro::Semaphores or similar
		249	resources, but that's where the "guard" methods come in handy:
		250
		251	my $sem = new Coro::Semaphore;
		252
		253	async {
		254	my $lock_guard = $sem->guard;
		255	# if we reutrn, or die or get cancelled, here,
		256	# then the semaphore will be "up"ed.
		257	};
		258
		259	The "Guard::guard" function comes in handy for any custom cleanup
		260	you might want to do (but you cannot switch to other coroutines form
		261	those code blocks):
		262
		263	async {
		264	my $window = new Gtk2::Window "toplevel";
		265	# The window will not be cleaned up automatically, even when $window
		266	# gets freed, so use a guard to ensure it's destruction
		267	# in case of an error:
		268	my $window_guard = Guard::guard { $window->destroy };
		269
		270	# we are safe here
		271	};
		272
		273	Last not least, "local" can often be handy, too, e.g. when
		274	temporarily replacing the coro thread description:
		275
		276	sub myfunction {
		277	local $Coro::current->{desc} = "inside myfunction(@_)";
		278
		279	# if we return or die here, the description will be restored
		280	}
		281
		282	6. Viva La Zombie Muerte
		283	Even after a thread has terminated and cleaned up its resources, the
		284	Coro object still is there and stores the return values of the
		285	thread.
		286
		287	The means the Coro object gets freed automatically when the thread
		288	has terminated and cleaned up and there arenot other references.
		289
		290	If there are, the Coro object will stay around, and you can call
		291	"->join" as many times as you wish to retrieve the result values:
		292
		293	async {
		294	print "hi\n";
		295	1
		296	};
		297
		298	# run the async above, and free everything before returning
		299	# from Coro::cede:
		300	Coro::cede;
		301
		302	{
		303	my $coro = async {
		304	print "hi\n";
		305	1
		306	};
		307
		308	# run the async above, and clean up, but do not free the coro
		309	# object:
		310	Coro::cede;
		311
		312	# optionally retrieve the result values
		313	my @results = $coro->join;
		314
		315	# now $coro goes out of scope, and presumably gets freed
		316	};
		317
		318	GLOBAL VARIABLES
55	$Coro::main	319	$Coro::main
56	This variable stores the coroutine object that represents the main	320	This variable stores the Coro object that represents the main
57	program. While you cna "ready" it and do most other things you can	321	program. While you cna "ready" it and do most other things you can
58	do to coroutines, it is mainly useful to compare again	322	do to coro, it is mainly useful to compare again $Coro::current, to
59	$Coro::current, to see whether you are running in the main program	323	see whether you are running in the main program or not.
60	or not.
61		324
62	$Coro::current	325	$Coro::current
63	The coroutine object representing the current coroutine (the last	326	The Coro object representing the current coro (the last coro that
64	coroutine that the Coro scheduler switched to). The initial value is	327	the Coro scheduler switched to). The initial value is $Coro::main
65	$Coro::main (of course).	328	(of course).
66		329
67	This variable is strictly read-only. You can take copies of the	330	This variable is strictly read-only. You can take copies of the
68	value stored in it and use it as any other coroutine object, but you	331	value stored in it and use it as any other Coro object, but you must
69	must not otherwise modify the variable itself.	332	not otherwise modify the variable itself.
70		333
71	$Coro::idle	334	$Coro::idle
72	This variable is mainly useful to integrate Coro into event loops.	335	This variable is mainly useful to integrate Coro into event loops.
73	It is usually better to rely on Coro::AnyEvent or L"Coro::EV", as	336	It is usually better to rely on Coro::AnyEvent or Coro::EV, as this
74	this is pretty low-level functionality.	337	is pretty low-level functionality.
75		338
76	This variable stores a callback that is called whenever the	339	This variable stores a Coro object that is put into the ready queue
77	scheduler finds no ready coroutines to run. The default	340	when there are no other ready threads (without invoking any ready
78	implementation prints "FATAL: deadlock detected" and exits, because	341	hooks).
79	the program has no other way to continue.
80		342
		343	The default implementation dies with "FATAL: deadlock detected.",
		344	followed by a thread listing, because the program has no other way
		345	to continue.
		346
81	This hook is overwritten by modules such as "Coro::Timer" and	347	This hook is overwritten by modules such as "Coro::EV" and
82	"Coro::AnyEvent" to wait on an external event that hopefully wake up	348	"Coro::AnyEvent" to wait on an external event that hopefully wakes
83	a coroutine so the scheduler can run it.	349	up a coro so the scheduler can run it.
84		350
85	Note that the callback must not, under any circumstances, block
86	the current coroutine. Normally, this is achieved by having an "idle
87	coroutine" that calls the event loop and then blocks again, and then
88	readying that coroutine in the idle handler.
89
90	See Coro::Event or Coro::AnyEvent for examples of using this	351	See Coro::EV or Coro::AnyEvent for examples of using this technique.
91	technique.
92		352
93	Please note that if your callback recursively invokes perl (e.g. for
94	event handlers), then it must be prepared to be called recursively
95	itself.
96
97	SIMPLE COROUTINE CREATION	353	SIMPLE CORO CREATION
98	async { ... } [@args...]	354	async { ... } [@args...]
99	Create a new coroutine and return it's coroutine object (usually	355	Create a new coro and return its Coro object (usually unused). The
100	unused). The coroutine will be put into the ready queue, so it will	356	coro will be put into the ready queue, so it will start running
101	start running automatically on the next scheduler run.	357	automatically on the next scheduler run.
102		358
103	The first argument is a codeblock/closure that should be executed in	359	The first argument is a codeblock/closure that should be executed in
104	the coroutine. When it returns argument returns the coroutine is	360	the coro. When it returns argument returns the coro is automatically
105	automatically terminated.	361	terminated.
106		362
107	The remaining arguments are passed as arguments to the closure.	363	The remaining arguments are passed as arguments to the closure.
108		364
109	See the "Coro::State::new" constructor for info about the coroutine	365	See the "Coro::State::new" constructor for info about the coro
110	environment in which coroutines are executed.	366	environment in which coro are executed.
111		367
112	Calling "exit" in a coroutine will do the same as calling exit	368	Calling "exit" in a coro will do the same as calling exit outside
113	outside the coroutine. Likewise, when the coroutine dies, the	369	the coro. Likewise, when the coro dies, the program will exit, just
114	program will exit, just as it would in the main program.	370	as it would in the main program.
115		371
116	If you do not want that, you can provide a default "die" handler, or	372	If you do not want that, you can provide a default "die" handler, or
117	simply avoid dieing (by use of "eval").	373	simply avoid dieing (by use of "eval").
118		374
119	Example: Create a new coroutine that just prints its arguments.	375	Example: Create a new coro that just prints its arguments.
120		376
121	async {	377	async {
122	print "@_\n";	378	print "@_\n";
123	} 1,2,3,4;	379	} 1,2,3,4;
124		380
125	async_pool { ... } [@args...]	381	async_pool { ... } [@args...]
126	Similar to "async", but uses a coroutine pool, so you should not	382	Similar to "async", but uses a coro pool, so you should not call
127	call terminate or join on it (although you are allowed to), and you	383	terminate or join on it (although you are allowed to), and you get a
128	get a coroutine that might have executed other code already (which	384	coro that might have executed other code already (which can be good
129	can be good or bad :).	385	or bad :).
130		386
131	On the plus side, this function is about twice as fast as creating	387	On the plus side, this function is about twice as fast as creating
132	(and destroying) a completely new coroutine, so if you need a lot of	388	(and destroying) a completely new coro, so if you need a lot of
133	generic coroutines in quick successsion, use "async_pool", not	389	generic coros in quick successsion, use "async_pool", not "async".
134	"async".
135		390
136	The code block is executed in an "eval" context and a warning will	391	The code block is executed in an "eval" context and a warning will
137	be issued in case of an exception instead of terminating the	392	be issued in case of an exception instead of terminating the
138	program, as "async" does. As the coroutine is being reused, stuff	393	program, as "async" does. As the coro is being reused, stuff like
139	like "on_destroy" will not work in the expected way, unless you call	394	"on_destroy" will not work in the expected way, unless you call
140	terminate or cancel, which somehow defeats the purpose of pooling	395	terminate or cancel, which somehow defeats the purpose of pooling
141	(but is fine in the exceptional case).	396	(but is fine in the exceptional case).
142		397
143	The priority will be reset to 0 after each run, tracing will be	398	The priority will be reset to 0 after each run, tracing will be
144	disabled, the description will be reset and the default output	399	disabled, the description will be reset and the default output
145	filehandle gets restored, so you can change all these. Otherwise the	400	filehandle gets restored, so you can change all these. Otherwise the
146	coroutine will be re-used "as-is": most notably if you change other	401	coro will be re-used "as-is": most notably if you change other
147	per-coroutine global stuff such as $/ you must needs revert that	402	per-coro global stuff such as $/ you must needs revert that
148	change, which is most simply done by using local as in: "local $/".	403	change, which is most simply done by using local as in: "local $/".
149		404
150	The idle pool size is limited to 8 idle coroutines (this can be	405	The idle pool size is limited to 8 idle coros (this can be adjusted
151	adjusted by changing $Coro::POOL_SIZE), but there can be as many	406	by changing $Coro::POOL_SIZE), but there can be as many non-idle
152	non-idle coros as required.	407	coros as required.
153		408
154	If you are concerned about pooled coroutines growing a lot because a	409	If you are concerned about pooled coros growing a lot because a
155	single "async_pool" used a lot of stackspace you can e.g.	410	single "async_pool" used a lot of stackspace you can e.g.
156	"async_pool { terminate }" once per second or so to slowly replenish	411	"async_pool { terminate }" once per second or so to slowly replenish
157	the pool. In addition to that, when the stacks used by a handler	412	the pool. In addition to that, when the stacks used by a handler
158	grows larger than 16kb (adjustable via $Coro::POOL_RSS) it will also	413	grows larger than 32kb (adjustable via $Coro::POOL_RSS) it will also
159	be destroyed.	414	be destroyed.
160		415
161	STATIC METHODS	416	STATIC METHODS
162	Static methods are actually functions that operate on the current	417	Static methods are actually functions that implicitly operate on the
163	coroutine.	418	current coro.
164		419
165	schedule	420	schedule
166	Calls the scheduler. The scheduler will find the next coroutine that	421	Calls the scheduler. The scheduler will find the next coro that is
167	is to be run from the ready queue and switches to it. The next	422	to be run from the ready queue and switches to it. The next coro to
168	coroutine to be run is simply the one with the highest priority that	423	be run is simply the one with the highest priority that is longest
169	is longest in its ready queue. If there is no coroutine ready, it	424	in its ready queue. If there is no coro ready, it will call the
170	will clal the $Coro::idle hook.	425	$Coro::idle hook.
171		426
172	Please note that the current coroutine will not be put into the	427	Please note that the current coro will not be put into the ready
173	ready queue, so calling this function usually means you will never	428	queue, so calling this function usually means you will never be
174	be called again unless something else (e.g. an event handler) calls	429	called again unless something else (e.g. an event handler) calls
175	"->ready", thus waking you up.	430	"->ready", thus waking you up.
176		431
177	This makes "schedule" the generic method to use to block the	432	This makes "schedule" the generic method to use to block the
178	current coroutine and wait for events: first you remember the	433	current coro and wait for events: first you remember the current
179	current coroutine in a variable, then arrange for some callback of	434	coro in a variable, then arrange for some callback of yours to call
180	yours to call "->ready" on that once some event happens, and last	435	"->ready" on that once some event happens, and last you call
181	you call "schedule" to put yourself to sleep. Note that a lot of	436	"schedule" to put yourself to sleep. Note that a lot of things can
182	things can wake your coroutine up, so you need to check whether the	437	wake your coro up, so you need to check whether the event indeed
183	event indeed happened, e.g. by storing the status in a variable.	438	happened, e.g. by storing the status in a variable.
184		439
185	See HOW TO WAIT FOR A CALLBACK, below, for some ways to wait for	440	See HOW TO WAIT FOR A CALLBACK, below, for some ways to wait for
186	callbacks.	441	callbacks.
187		442
188	cede	443	cede
189	"Cede" to other coroutines. This function puts the current coroutine	444	"Cede" to other coros. This function puts the current coro into the
190	into the ready queue and calls "schedule", which has the effect of	445	ready queue and calls "schedule", which has the effect of giving up
191	giving up the current "timeslice" to other coroutines of the same or	446	the current "timeslice" to other coros of the same or higher
192	higher priority. Once your coroutine gets its turn again it will	447	priority. Once your coro gets its turn again it will automatically
193	automatically be resumed.	448	be resumed.
194		449
195	This function is often called "yield" in other languages.	450	This function is often called "yield" in other languages.
196		451
197	Coro::cede_notself	452	Coro::cede_notself
198	Works like cede, but is not exported by default and will cede to	453	Works like cede, but is not exported by default and will cede to
199	any coroutine, regardless of priority. This is useful sometimes to	454	any coro, regardless of priority. This is useful sometimes to
200	ensure progress is made.	455	ensure progress is made.
201		456
202	terminate [arg...]	457	terminate [arg...]
203	Terminates the current coroutine with the given status values (see	458	Terminates the current coro with the given status values (see
204	cancel).	459	cancel). The values will not be copied, but referenced directly.
		460
		461	Coro::on_enter BLOCK, Coro::on_leave BLOCK
		462	These function install enter and leave winders in the current scope.
		463	The enter block will be executed when on_enter is called and
		464	whenever the current coro is re-entered by the scheduler, while the
		465	leave block is executed whenever the current coro is blocked by the
		466	scheduler, and also when the containing scope is exited (by whatever
		467	means, be it exit, die, last etc.).
		468
		469	*Neither invoking the scheduler, nor exceptions, are allowed within
		470	those BLOCKs*. That means: do not even think about calling "die"
		471	without an eval, and do not even think of entering the scheduler in
		472	any way.
		473
		474	Since both BLOCKs are tied to the current scope, they will
		475	automatically be removed when the current scope exits.
		476
		477	These functions implement the same concept as "dynamic-wind" in
		478	scheme does, and are useful when you want to localise some resource
		479	to a specific coro.
		480
		481	They slow down thread switching considerably for coros that use them
		482	(about 40% for a BLOCK with a single assignment, so thread switching
		483	is still reasonably fast if the handlers are fast).
		484
		485	These functions are best understood by an example: The following
		486	function will change the current timezone to
		487	"Antarctica/South_Pole", which requires a call to "tzset", but by
		488	using "on_enter" and "on_leave", which remember/change the current
		489	timezone and restore the previous value, respectively, the timezone
		490	is only changed for the coro that installed those handlers.
		491
		492	use POSIX qw(tzset);
		493
		494	async {
		495	my $old_tz; # store outside TZ value here
		496
		497	Coro::on_enter {
		498	$old_tz = $ENV{TZ}; # remember the old value
		499
		500	$ENV{TZ} = "Antarctica/South_Pole";
		501	tzset; # enable new value
		502	};
		503
		504	Coro::on_leave {
		505	$ENV{TZ} = $old_tz;
		506	tzset; # restore old value
		507	};
		508
		509	# at this place, the timezone is Antarctica/South_Pole,
		510	# without disturbing the TZ of any other coro.
		511	};
		512
		513	This can be used to localise about any resource (locale, uid,
		514	current working directory etc.) to a block, despite the existance of
		515	other coros.
		516
		517	Another interesting example implements time-sliced multitasking
		518	using interval timers (this could obviously be optimised, but does
		519	the job):
		520
		521	# "timeslice" the given block
		522	sub timeslice(&) {
		523	use Time::HiRes ();
		524
		525	Coro::on_enter {
		526	# on entering the thread, we set an VTALRM handler to cede
		527	$SIG{VTALRM} = sub { cede };
		528	# and then start the interval timer
		529	Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0.01, 0.01;
		530	};
		531	Coro::on_leave {
		532	# on leaving the thread, we stop the interval timer again
		533	Time::HiRes::setitimer &Time::HiRes::ITIMER_VIRTUAL, 0, 0;
		534	};
		535
		536	&{+shift};
		537	}
		538
		539	# use like this:
		540	timeslice {
		541	# The following is an endless loop that would normally
		542	# monopolise the process. Since it runs in a timesliced
		543	# environment, it will regularly cede to other threads.
		544	while () { }
		545	};
205		546
206	killall	547	killall
207	Kills/terminates/cancels all coroutines except the currently running	548	Kills/terminates/cancels all coros except the currently running one.
208	one. This is useful after a fork, either in the child or the parent,
209	as usually only one of them should inherit the running coroutines.
210		549
211	Note that while this will try to free some of the main programs	550	Note that while this will try to free some of the main interpreter
212	resources, you cannot free all of them, so if a coroutine that is	551	resources if the calling coro isn't the main coro, but one cannot
213	not the main program calls this function, there will be some	552	free all of them, so if a coro that is not the main coro calls this
214	one-time resource leak.	553	function, there will be some one-time resource leak.
215		554
216	COROUTINE METHODS	555	CORO OBJECT METHODS
217	These are the methods you can call on coroutine objects (or to create	556	These are the methods you can call on coro objects (or to create them).
218	them).
219		557
220	new Coro \&sub [, @args...]	558	new Coro \&sub [, @args...]
221	Create a new coroutine and return it. When the sub returns, the	559	Create a new coro and return it. When the sub returns, the coro
222	coroutine automatically terminates as if "terminate" with the	560	automatically terminates as if "terminate" with the returned values
223	returned values were called. To make the coroutine run you must	561	were called. To make the coro run you must first put it into the
224	first put it into the ready queue by calling the ready method.	562	ready queue by calling the ready method.
225		563
226	See "async" and "Coro::State::new" for additional info about the	564	See "async" and "Coro::State::new" for additional info about the
227	coroutine environment.	565	coro environment.
228		566
229	$success = $coroutine->ready	567	$success = $coro->ready
230	Put the given coroutine into the end of its ready queue (there is	568	Put the given coro into the end of its ready queue (there is one
231	one queue for each priority) and return true. If the coroutine is	569	queue for each priority) and return true. If the coro is already in
232	already in the ready queue, do nothing and return false.	570	the ready queue, do nothing and return false.
233		571
234	This ensures that the scheduler will resume this coroutine	572	This ensures that the scheduler will resume this coro automatically
235	automatically once all the coroutines of higher priority and all	573	once all the coro of higher priority and all coro of the same
236	coroutines of the same priority that were put into the ready queue	574	priority that were put into the ready queue earlier have been
237	earlier have been resumed.	575	resumed.
238		576
		577	$coro->suspend
		578	Suspends the specified coro. A suspended coro works just like any
		579	other coro, except that the scheduler will not select a suspended
		580	coro for execution.
		581
		582	Suspending a coro can be useful when you want to keep the coro from
		583	running, but you don't want to destroy it, or when you want to
		584	temporarily freeze a coro (e.g. for debugging) to resume it later.
		585
		586	A scenario for the former would be to suspend all (other) coros
		587	after a fork and keep them alive, so their destructors aren't
		588	called, but new coros can be created.
		589
		590	$coro->resume
		591	If the specified coro was suspended, it will be resumed. Note that
		592	when the coro was in the ready queue when it was suspended, it might
		593	have been unreadied by the scheduler, so an activation might have
		594	been lost.
		595
		596	To avoid this, it is best to put a suspended coro into the ready
		597	queue unconditionally, as every synchronisation mechanism must
		598	protect itself against spurious wakeups, and the one in the Coro
		599	family certainly do that.
		600
		601	$state->is_new
		602	Returns true iff this Coro object is "new", i.e. has never been run
		603	yet. Those states basically consist of only the code reference to
		604	call and the arguments, but consumes very little other resources.
		605	New states will automatically get assigned a perl interpreter when
		606	they are transfered to.
		607
		608	$state->is_zombie
		609	Returns true iff the Coro object has been cancelled, i.e. it's
		610	resources freed because they were "cancel"'ed, "terminate"'d,
		611	"safe_cancel"'ed or simply went out of scope.
		612
		613	The name "zombie" stems from UNIX culture, where a process that has
		614	exited and only stores and exit status and no other resources is
		615	called a "zombie".
		616
239	$is_ready = $coroutine->is_ready	617	$is_ready = $coro->is_ready
240	Return whether the coroutine is currently the ready queue or not,	618	Returns true iff the Coro object is in the ready queue. Unless the
		619	Coro object gets destroyed, it will eventually be scheduled by the
		620	scheduler.
241		621
		622	$is_running = $coro->is_running
		623	Returns true iff the Coro object is currently running. Only one Coro
		624	object can ever be in the running state (but it currently is
		625	possible to have multiple running Coro::States).
		626
		627	$is_suspended = $coro->is_suspended
		628	Returns true iff this Coro object has been suspended. Suspended
		629	Coros will not ever be scheduled.
		630
242	$coroutine->cancel (arg...)	631	$coro->cancel (arg...)
243	Terminates the given coroutine and makes it return the given	632	Terminates the given Coro thread and makes it return the given
244	arguments as status (default: the empty list). Never returns if the	633	arguments as status (default: an empty list). Never returns if the
245	coroutine is the current coroutine.	634	Coro is the current Coro.
246		635
		636	This is a rather brutal way to free a coro, with some limitations -
		637	if the thread is inside a C callback that doesn't expect to be
		638	canceled, bad things can happen, or if the cancelled thread insists
		639	on running complicated cleanup handlers that rely on its thread
		640	context, things will not work.
		641
		642	Any cleanup code being run (e.g. from "guard" blocks) will be run
		643	without a thread context, and is not allowed to switch to other
		644	threads. On the plus side, "->cancel" will always clean up the
		645	thread, no matter what. If your cleanup code is complex or you want
		646	to avoid cancelling a C-thread that doesn't know how to clean up
		647	itself, it can be better to "->throw" an exception, or use
		648	"->safe_cancel".
		649
		650	The arguments to "->cancel" are not copied, but instead will be
		651	referenced directly (e.g. if you pass $var and after the call change
		652	that variable, then you might change the return values passed to
		653	e.g. "join", so don't do that).
		654
		655	The resources of the Coro are usually freed (or destructed) before
		656	this call returns, but this can be delayed for an indefinite amount
		657	of time, as in some cases the manager thread has to run first to
		658	actually destruct the Coro object.
		659
		660	$coro->safe_cancel ($arg...)
		661	Works mostly like "->cancel", but is inherently "safer", and
		662	consequently, can fail with an exception in cases the thread is not
		663	in a cancellable state.
		664
		665	This method works a bit like throwing an exception that cannot be
		666	caught - specifically, it will clean up the thread from within
		667	itself, so all cleanup handlers (e.g. "guard" blocks) are run with
		668	full thread context and can block if they wish. The downside is that
		669	there is no guarantee that the thread can be cancelled when you call
		670	this method, and therefore, it might fail. It is also considerably
		671	slower than "cancel" or "terminate".
		672
		673	A thread is in a safe-cancellable state if it either hasn't been run
		674	yet, or it has no C context attached and is inside an SLF function.
		675
		676	The latter two basically mean that the thread isn't currently inside
		677	a perl callback called from some C function (usually via some XS
		678	modules) and isn't currently executing inside some C function itself
		679	(via Coro's XS API).
		680
		681	This call returns true when it could cancel the thread, or croaks
		682	with an error otherwise (i.e. it either returns true or doesn't
		683	return at all).
		684
		685	Why the weird interface? Well, there are two common models on how
		686	and when to cancel things. In the first, you have the expectation
		687	that your coro thread can be cancelled when you want to cancel it -
		688	if the thread isn't cancellable, this would be a bug somewhere, so
		689	"->safe_cancel" croaks to notify of the bug.
		690
		691	In the second model you sometimes want to ask nicely to cancel a
		692	thread, but if it's not a good time, well, then don't cancel. This
		693	can be done relatively easy like this:
		694
		695	if (! eval { $coro->safe_cancel }) {
		696	warn "unable to cancel thread: $@";
		697	}
		698
		699	However, what you never should do is first try to cancel "safely"
		700	and if that fails, cancel the "hard" way with "->cancel". That makes
		701	no sense: either you rely on being able to execute cleanup code in
		702	your thread context, or you don't. If you do, then "->safe_cancel"
		703	is the only way, and if you don't, then "->cancel" is always faster
		704	and more direct.
		705
247	$coroutine->schedule_to	706	$coro->schedule_to
248	Puts the current coroutine to sleep (like "Coro::schedule"), but	707	Puts the current coro to sleep (like "Coro::schedule"), but instead
249	instead of continuing with the next coro from the ready queue,	708	of continuing with the next coro from the ready queue, always switch
250	always switch to the given coroutine object (regardless of priority	709	to the given coro object (regardless of priority etc.). The
251	etc.). The readyness state of that coroutine isn't changed.	710	readyness state of that coro isn't changed.
252		711
253	This is an advanced method for special cases - I'd love to hear	712	This is an advanced method for special cases - I'd love to hear
254	about any uses for this one.	713	about any uses for this one.
255		714
256	$coroutine->cede_to	715	$coro->cede_to
257	Like "schedule_to", but puts the current coroutine into the ready	716	Like "schedule_to", but puts the current coro into the ready queue.
258	queue. This has the effect of temporarily switching to the given	717	This has the effect of temporarily switching to the given coro, and
259	coroutine, and continuing some time later.	718	continuing some time later.
260		719
261	This is an advanced method for special cases - I'd love to hear	720	This is an advanced method for special cases - I'd love to hear
262	about any uses for this one.	721	about any uses for this one.
263		722
264	$coroutine->throw ([$scalar])	723	$coro->throw ([$scalar])
265	If $throw is specified and defined, it will be thrown as an	724	If $throw is specified and defined, it will be thrown as an
266	exception inside the coroutine at the next convenient point in time.	725	exception inside the coro at the next convenient point in time.
267	Otherwise clears the exception object.	726	Otherwise clears the exception object.
268		727
269	Coro will check for the exception each time a schedule-like-function	728	Coro will check for the exception each time a schedule-like-function
270	returns, i.e. after each "schedule", "cede",	729	returns, i.e. after each "schedule", "cede",
271	"Coro::Semaphore->down", "Coro::Handle->readable" and so on. Most of	730	"Coro::Semaphore->down", "Coro::Handle->readable" and so on. Most of
272	these functions detect this case and return early in case an	731	those functions (all that are part of Coro itself) detect this case
273	exception is pending.	732	and return early in case an exception is pending.
274		733
275	The exception object will be thrown "as is" with the specified	734	The exception object will be thrown "as is" with the specified
276	scalar in $@, i.e. if it is a string, no line number or newline will	735	scalar in $@, i.e. if it is a string, no line number or newline will
277	be appended (unlike with "die").	736	be appended (unlike with "die").
278		737
279	This can be used as a softer means than "cancel" to ask a coroutine	738	This can be used as a softer means than either "cancel" or
280	to end itself, although there is no guarantee that the exception	739	"safe_cancel "to ask a coro to end itself, although there is no
281	will lead to termination, and if the exception isn't caught it might	740	guarantee that the exception will lead to termination, and if the
282	well end the whole program.	741	exception isn't caught it might well end the whole program.
283		742
284	You might also think of "throw" as being the moral equivalent of	743	You might also think of "throw" as being the moral equivalent of
285	"kill"ing a coroutine with a signal (in this case, a scalar).	744	"kill"ing a coro with a signal (in this case, a scalar).
286		745
287	$coroutine->join	746	$coro->join
288	Wait until the coroutine terminates and return any values given to	747	Wait until the coro terminates and return any values given to the
289	the "terminate" or "cancel" functions. "join" can be called	748	"terminate" or "cancel" functions. "join" can be called concurrently
290	concurrently from multiple coroutines, and all will be resumed and	749	from multiple threads, and all will be resumed and given the status
291	given the status return once the $coroutine terminates.	750	return once the $coro terminates.
292		751
293	$coroutine->on_destroy (\&cb)	752	$coro->on_destroy (\&cb)
294	Registers a callback that is called when this coroutine gets	753	Registers a callback that is called when this coro thread gets
295	destroyed, but before it is joined. The callback gets passed the	754	destroyed, that is, after it's resources have been freed but before
		755	it is joined. The callback gets passed the terminate/cancel
296	terminate arguments, if any, and must not die, under any	756	arguments, if any, and must not die, under any circumstances.
297	circumstances.
298		757
		758	There can be any number of "on_destroy" callbacks per coro, and
		759	there is no way currently to remove a callback once added.
		760
299	$oldprio = $coroutine->prio ($newprio)	761	$oldprio = $coro->prio ($newprio)
300	Sets (or gets, if the argument is missing) the priority of the	762	Sets (or gets, if the argument is missing) the priority of the coro
301	coroutine. Higher priority coroutines get run before lower priority	763	thread. Higher priority coro get run before lower priority coros.
302	coroutines. Priorities are small signed integers (currently -4 ..	764	Priorities are small signed integers (currently -4 .. +3), that you
303	+3), that you can refer to using PRIO_xxx constants (use the import	765	can refer to using PRIO_xxx constants (use the import tag :prio to
304	tag :prio to get then):	766	get then):
305		767
306	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN	768	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
307	3 > 1 > 0 > -1 > -3 > -4	769	3 > 1 > 0 > -1 > -3 > -4
308		770
309	# set priority to HIGH	771	# set priority to HIGH
310	current->prio(PRIO_HIGH);	772	current->prio (PRIO_HIGH);
311		773
312	The idle coroutine ($Coro::idle) always has a lower priority than	774	The idle coro thread ($Coro::idle) always has a lower priority than
313	any existing coroutine.	775	any existing coro.
314		776
315	Changing the priority of the current coroutine will take effect	777	Changing the priority of the current coro will take effect
316	immediately, but changing the priority of coroutines in the ready	778	immediately, but changing the priority of a coro in the ready queue
317	queue (but not running) will only take effect after the next	779	(but not running) will only take effect after the next schedule (of
318	schedule (of that coroutine). This is a bug that will be fixed in	780	that coro). This is a bug that will be fixed in some future version.
319	some future version.
320		781
321	$newprio = $coroutine->nice ($change)	782	$newprio = $coro->nice ($change)
322	Similar to "prio", but subtract the given value from the priority	783	Similar to "prio", but subtract the given value from the priority
323	(i.e. higher values mean lower priority, just as in unix).	784	(i.e. higher values mean lower priority, just as in UNIX's nice
		785	command).
324		786
325	$olddesc = $coroutine->desc ($newdesc)	787	$olddesc = $coro->desc ($newdesc)
326	Sets (or gets in case the argument is missing) the description for	788	Sets (or gets in case the argument is missing) the description for
327	this coroutine. This is just a free-form string you can associate	789	this coro thread. This is just a free-form string you can associate
328	with a coroutine.	790	with a coro.
329		791
330	This method simply sets the "$coroutine->{desc}" member to the given	792	This method simply sets the "$coro->{desc}" member to the given
331	string. You can modify this member directly if you wish.	793	string. You can modify this member directly if you wish, and in
		794	fact, this is often preferred to indicate major processing states
		795	that cna then be seen for example in a Coro::Debug session:
332		796
		797	sub my_long_function {
		798	local $Coro::current->{desc} = "now in my_long_function";
		799	...
		800	$Coro::current->{desc} = "my_long_function: phase 1";
		801	...
		802	$Coro::current->{desc} = "my_long_function: phase 2";
		803	...
		804	}
		805
333	GLOBAL FUNCTIONS	806	GLOBAL FUNCTIONS
334	Coro::nready	807	Coro::nready
335	Returns the number of coroutines that are currently in the ready	808	Returns the number of coro that are currently in the ready state,
336	state, i.e. that can be switched to by calling "schedule" directory	809	i.e. that can be switched to by calling "schedule" directory or
337	or indirectly. The value 0 means that the only runnable coroutine is	810	indirectly. The value 0 means that the only runnable coro is the
338	the currently running one, so "cede" would have no effect, and	811	currently running one, so "cede" would have no effect, and
339	"schedule" would cause a deadlock unless there is an idle handler	812	"schedule" would cause a deadlock unless there is an idle handler
340	that wakes up some coroutines.	813	that wakes up some coro.
341		814
342	my $guard = Coro::guard { ... }	815	my $guard = Coro::guard { ... }
343	This creates and returns a guard object. Nothing happens until the	816	This function still exists, but is deprecated. Please use the
344	object gets destroyed, in which case the codeblock given as argument	817	"Guard::guard" function instead.
345	will be executed. This is useful to free locks or other resources in
346	case of a runtime error or when the coroutine gets canceled, as in
347	both cases the guard block will be executed. The guard object
348	supports only one method, "->cancel", which will keep the codeblock
349	from being executed.
350
351	Example: set some flag and clear it again when the coroutine gets
352	canceled or the function returns:
353
354	sub do_something {
355	my $guard = Coro::guard { $busy = 0 };
356	$busy = 1;
357
358	# do something that requires $busy to be true
359	}
360		818
361	unblock_sub { ... }	819	unblock_sub { ... }
362	This utility function takes a BLOCK or code reference and "unblocks"	820	This utility function takes a BLOCK or code reference and "unblocks"
363	it, returning a new coderef. Unblocking means that calling the new	821	it, returning a new coderef. Unblocking means that calling the new
364	coderef will return immediately without blocking, returning nothing,	822	coderef will return immediately without blocking, returning nothing,
365	while the original code ref will be called (with parameters) from	823	while the original code ref will be called (with parameters) from
366	within another coroutine.	824	within another coro.
367		825
368	The reason this function exists is that many event libraries (such	826	The reason this function exists is that many event libraries (such
369	as the venerable Event module) are not coroutine-safe (a weaker form	827	as the venerable Event module) are not thread-safe (a weaker form of
370	of thread-safety). This means you must not block within event	828	reentrancy). This means you must not block within event callbacks,
371	callbacks, otherwise you might suffer from crashes or worse. The	829	otherwise you might suffer from crashes or worse. The only event
372	only event library currently known that is safe to use without	830	library currently known that is safe to use without "unblock_sub" is
373	"unblock_sub" is EV.	831	EV (but you might still run into deadlocks if all event loops are
		832	blocked).
		833
		834	Coro will try to catch you when you block in the event loop
		835	("FATAL:$Coro::IDLE blocked itself"), but this is just best effort
		836	and only works when you do not run your own event loop.
374		837
375	This function allows your callbacks to block by executing them in	838	This function allows your callbacks to block by executing them in
376	another coroutine where it is safe to block. One example where	839	another coro where it is safe to block. One example where blocking
377	blocking is handy is when you use the Coro::AIO functions to save	840	is handy is when you use the Coro::AIO functions to save results to
378	results to disk, for example.	841	disk, for example.
379		842
380	In short: simply use "unblock_sub { ... }" instead of "sub { ... }"	843	In short: simply use "unblock_sub { ... }" instead of "sub { ... }"
381	when creating event callbacks that want to block.	844	when creating event callbacks that want to block.
382		845
383	If your handler does not plan to block (e.g. simply sends a message	846	If your handler does not plan to block (e.g. simply sends a message
384	to another coroutine, or puts some other coroutine into the ready	847	to another coro, or puts some other coro into the ready queue),
385	queue), there is no reason to use "unblock_sub".	848	there is no reason to use "unblock_sub".
386		849
387	Note that you also need to use "unblock_sub" for any other callbacks	850	Note that you also need to use "unblock_sub" for any other callbacks
388	that are indirectly executed by any C-based event loop. For example,	851	that are indirectly executed by any C-based event loop. For example,
389	when you use a module that uses AnyEvent (and you use	852	when you use a module that uses AnyEvent (and you use
390	Coro::AnyEvent) and it provides callbacks that are the result of	853	Coro::AnyEvent) and it provides callbacks that are the result of
391	some event callback, then you must not block either, or use	854	some event callback, then you must not block either, or use
392	"unblock_sub".	855	"unblock_sub".
393		856
394	$cb = Coro::rouse_cb	857	$cb = rouse_cb
395	Create and return a "rouse callback". That's a code reference that,	858	Create and return a "rouse callback". That's a code reference that,
396	when called, will save its arguments and notify the owner coroutine	859	when called, will remember a copy of its arguments and notify the
397	of the callback.	860	owner coro of the callback.
398		861
399	See the next function.	862	See the next function.
400		863
401	@args = Coro::rouse_wait [$cb]	864	@args = rouse_wait [$cb]
402	Wait for the specified rouse callback (or the last one tht was	865	Wait for the specified rouse callback (or the last one that was
403	created in this coroutine).	866	created in this coro).
404		867
405	As soon as the callback is invoked (or when the calback was invoked	868	As soon as the callback is invoked (or when the callback was invoked
406	before "rouse_wait"), it will return a copy of the arguments	869	before "rouse_wait"), it will return the arguments originally passed
407	originally passed to the rouse callback.	870	to the rouse callback. In scalar context, that means you get the
		871	last argument, just as if "rouse_wait" had a "return ($a1, $a2,
		872	$a3...)" statement at the end.
408		873
409	See the section HOW TO WAIT FOR A CALLBACK for an actual usage	874	See the section HOW TO WAIT FOR A CALLBACK for an actual usage
410	example.	875	example.
411		876
412	HOW TO WAIT FOR A CALLBACK	877	HOW TO WAIT FOR A CALLBACK
413	It is very common for a coroutine to wait for some callback to be	878	It is very common for a coro to wait for some callback to be called.
414	called. This occurs naturally when you use coroutines in an otherwise	879	This occurs naturally when you use coro in an otherwise event-based
415	event-based program, or when you use event-based libraries.	880	program, or when you use event-based libraries.
416		881
417	These typically register a callback for some event, and call that	882	These typically register a callback for some event, and call that
418	callback when the event occured. In a coroutine, however, you typically	883	callback when the event occured. In a coro, however, you typically want
419	want to just wait for the event, simplyifying things.	884	to just wait for the event, simplyifying things.
420		885
421	For example "AnyEvent->child" registers a callback to be called when a	886	For example "AnyEvent->child" registers a callback to be called when a
422	specific child has exited:	887	specific child has exited:
423		888
424	my $child_watcher = AnyEvent->child (pid => $pid, cb => sub { ... });	889	my $child_watcher = AnyEvent->child (pid => $pid, cb => sub { ... });
425		890
426	But from withina coroutine, you often just want to write this:	891	But from within a coro, you often just want to write this:
427		892
428	my $status = wait_for_child $pid;	893	my $status = wait_for_child $pid;
429		894
430	Coro offers two functions specifically designed to make this easy,	895	Coro offers two functions specifically designed to make this easy,
431	"Coro::rouse_cb" and "Coro::rouse_wait".	896	"Coro::rouse_cb" and "Coro::rouse_wait".
432		897
433	The first function, "rouse_cb", generates and returns a callback that,	898	The first function, "rouse_cb", generates and returns a callback that,
434	when invoked, will save it's arguments and notify the coroutine that	899	when invoked, will save its arguments and notify the coro that created
435	created the callback.	900	the callback.
436		901
437	The second function, "rouse_wait", waits for the callback to be called	902	The second function, "rouse_wait", waits for the callback to be called
438	(by calling "schedule" to go to sleep) and returns the arguments	903	(by calling "schedule" to go to sleep) and returns the arguments
439	originally passed to the callback.	904	originally passed to the callback.
440		905
454	you can roll your own, using "schedule":	919	you can roll your own, using "schedule":
455		920
456	sub wait_for_child($) {	921	sub wait_for_child($) {
457	my ($pid) = @_;	922	my ($pid) = @_;
458		923
459	# store the current coroutine in $current,	924	# store the current coro in $current,
460	# and provide result variables for the closure passed to ->child	925	# and provide result variables for the closure passed to ->child
461	my $current = $Coro::current;	926	my $current = $Coro::current;
462	my ($done, $rstatus);	927	my ($done, $rstatus);
463		928
464	# pass a closure to ->child	929	# pass a closure to ->child
…		…
475		940
476	BUGS/LIMITATIONS	941	BUGS/LIMITATIONS
477	fork with pthread backend	942	fork with pthread backend
478	When Coro is compiled using the pthread backend (which isn't	943	When Coro is compiled using the pthread backend (which isn't
479	recommended but required on many BSDs as their libcs are completely	944	recommended but required on many BSDs as their libcs are completely
480	broken), then coroutines will not survive a fork. There is no known	945	broken), then coro will not survive a fork. There is no known
481	workaround except to fix your libc and use a saner backend.	946	workaround except to fix your libc and use a saner backend.
482		947
483	perl process emulation ("threads")	948	perl process emulation ("threads")
484	This module is not perl-pseudo-thread-safe. You should only ever use	949	This module is not perl-pseudo-thread-safe. You should only ever use
485	this module from the same thread (this requirement might be removed	950	this module from the first thread (this requirement might be removed
486	in the future to allow per-thread schedulers, but Coro::State does	951	in the future to allow per-thread schedulers, but Coro::State does
487	not yet allow this). I recommend disabling thread support and using	952	not yet allow this). I recommend disabling thread support and using
488	processes, as having the windows process emulation enabled under	953	processes, as having the windows process emulation enabled under
489	unix roughly halves perl performance, even when not used.	954	unix roughly halves perl performance, even when not used.
490		955
		956	Attempts to use threads created in another emulated process will
		957	crash ("cleanly", with a null pointer exception).
		958
491	coroutine switching not signal safe	959	coro switching is not signal safe
492	You must not switch to another coroutine from within a signal	960	You must not switch to another coro from within a signal handler
493	handler (only relevant with %SIG - most event libraries provide safe	961	(only relevant with %SIG - most event libraries provide safe
494	signals).	962	signals), unless you are sure you are not interrupting a Coro
		963	function.
495		964
496	That means you MUST NOT call any function that might "block" the	965	That means you MUST NOT call any function that might "block" the
497	current coroutine - "cede", "schedule" "Coro::Semaphore->down" or	966	current coro - "cede", "schedule" "Coro::Semaphore->down" or
498	anything that calls those. Everything else, including calling	967	anything that calls those. Everything else, including calling
499	"ready", works.	968	"ready", works.
500		969
		970	WINDOWS PROCESS EMULATION
		971	A great many people seem to be confused about ithreads (for example,
		972	Chip Salzenberg called me unintelligent, incapable, stupid and gullible,
		973	while in the same mail making rather confused statements about perl
		974	ithreads (for example, that memory or files would be shared), showing
		975	his lack of understanding of this area - if it is hard to understand for
		976	Chip, it is probably not obvious to everybody).
		977
		978	What follows is an ultra-condensed version of my talk about threads in
		979	scripting languages given on the perl workshop 2009:
		980
		981	The so-called "ithreads" were originally implemented for two reasons:
		982	first, to (badly) emulate unix processes on native win32 perls, and
		983	secondly, to replace the older, real thread model ("5.005-threads").
		984
		985	It does that by using threads instead of OS processes. The difference
		986	between processes and threads is that threads share memory (and other
		987	state, such as files) between threads within a single process, while
		988	processes do not share anything (at least not semantically). That means
		989	that modifications done by one thread are seen by others, while
		990	modifications by one process are not seen by other processes.
		991
		992	The "ithreads" work exactly like that: when creating a new ithreads
		993	process, all state is copied (memory is copied physically, files and
		994	code is copied logically). Afterwards, it isolates all modifications. On
		995	UNIX, the same behaviour can be achieved by using operating system
		996	processes, except that UNIX typically uses hardware built into the
		997	system to do this efficiently, while the windows process emulation
		998	emulates this hardware in software (rather efficiently, but of course it
		999	is still much slower than dedicated hardware).
		1000
		1001	As mentioned before, loading code, modifying code, modifying data
		1002	structures and so on is only visible in the ithreads process doing the
		1003	modification, not in other ithread processes within the same OS process.
		1004
		1005	This is why "ithreads" do not implement threads for perl at all, only
		1006	processes. What makes it so bad is that on non-windows platforms, you
		1007	can actually take advantage of custom hardware for this purpose (as
		1008	evidenced by the forks module, which gives you the (i-) threads API,
		1009	just much faster).
		1010
		1011	Sharing data is in the i-threads model is done by transfering data
		1012	structures between threads using copying semantics, which is very slow -
		1013	shared data simply does not exist. Benchmarks using i-threads which are
		1014	communication-intensive show extremely bad behaviour with i-threads (in
		1015	fact, so bad that Coro, which cannot take direct advantage of multiple
		1016	CPUs, is often orders of magnitude faster because it shares data using
		1017	real threads, refer to my talk for details).
		1018
		1019	As summary, i-threads use threads to implement processes, while the
		1020	compatible forks module uses processes to emulate, uhm, processes.
		1021	I-threads slow down every perl program when enabled, and outside of
		1022	windows, serve no (or little) practical purpose, but disadvantages every
		1023	single-threaded Perl program.
		1024
		1025	This is the reason that I try to avoid the name "ithreads", as it is
		1026	misleading as it implies that it implements some kind of thread model
		1027	for perl, and prefer the name "windows process emulation", which
		1028	describes the actual use and behaviour of it much better.
		1029
501	SEE ALSO	1030	SEE ALSO
502	Event-Loop integration: Coro::AnyEvent, Coro::EV, Coro::Event.	1031	Event-Loop integration: Coro::AnyEvent, Coro::EV, Coro::Event.
503		1032
504	Debugging: Coro::Debug.	1033	Debugging: Coro::Debug.
505		1034
506	Support/Utility: Coro::Specific, Coro::Util.	1035	Support/Utility: Coro::Specific, Coro::Util.
507		1036
508	Locking/IPC: Coro::Signal, Coro::Channel, Coro::Semaphore,	1037	Locking and IPC: Coro::Signal, Coro::Channel, Coro::Semaphore,
509	Coro::SemaphoreSet, Coro::RWLock.	1038	Coro::SemaphoreSet, Coro::RWLock.
510		1039
511	IO/Timers: Coro::Timer, Coro::Handle, Coro::Socket, Coro::AIO.	1040	I/O and Timers: Coro::Timer, Coro::Handle, Coro::Socket, Coro::AIO.
512		1041
513	Compatibility: Coro::LWP, Coro::BDB, Coro::Storable, Coro::Select.	1042	Compatibility with other modules: Coro::LWP (but see also AnyEvent::HTTP
		1043	for a better-working alternative), Coro::BDB, Coro::Storable,
		1044	Coro::Select.
514		1045
515	XS API: Coro::MakeMaker.	1046	XS API: Coro::MakeMaker.
516		1047
517	Low level Configuration, Coroutine Environment: Coro::State.	1048	Low level Configuration, Thread Environment, Continuations: Coro::State.
518		1049
519	AUTHOR	1050	AUTHOR
520	Marc Lehmann <schmorp@schmorp.de>	1051	Marc Lehmann <schmorp@schmorp.de>
521	http://home.schmorp.de/	1052	http://home.schmorp.de/
522		1053

Diff Legend

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

Comparing Coro/README (file contents): Revision 1.18 by root, Thu Nov 20 09:37:21 2008 UTC vs. Revision 1.30 by root, Wed Jun 29 17:58:52 2011 UTC

Diff Legend

Comparing Coro/README (file contents):
Revision 1.18 by root, Thu Nov 20 09:37:21 2008 UTC vs.
Revision 1.30 by root, Wed Jun 29 17:58:52 2011 UTC