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

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.357 by root, Wed Jul 21 06:36:11 2021 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.357 by root, Wed Jul 21 06:36:11 2021 UTC