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

Comparing Coro/Coro.pm (file contents):
Revision 1.234 by root, Fri Nov 21 06:52:10 2008 UTC vs.
Revision 1.294 by root, Fri May 6 21:15:17 2011 UTC

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

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.234 by root, Fri Nov 21 06:52:10 2008 UTC vs. Revision 1.294 by root, Fri May 6 21:15:17 2011 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.234 by root, Fri Nov 21 06:52:10 2008 UTC vs.
Revision 1.294 by root, Fri May 6 21:15:17 2011 UTC