[ViewVC] Diff of: cvs/Coro/Coro.pm

Comparing Coro/Coro.pm (file contents):
Revision 1.202 by root, Tue Sep 30 17:12:34 2008 UTC vs.
Revision 1.271 by root, Fri Oct 2 19:55:59 2009 UTC

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

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.202 by root, Tue Sep 30 17:12:34 2008 UTC vs. Revision 1.271 by root, Fri Oct 2 19:55:59 2009 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.202 by root, Tue Sep 30 17:12:34 2008 UTC vs.
Revision 1.271 by root, Fri Oct 2 19:55:59 2009 UTC