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

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

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.226 by root, Wed Nov 19 16:01:32 2008 UTC vs. Revision 1.268 by root, Thu Oct 1 23:16:27 2009 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.226 by root, Wed Nov 19 16:01:32 2008 UTC vs.
Revision 1.268 by root, Thu Oct 1 23:16:27 2009 UTC