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

Comparing Coro/Coro.pm (file contents):
Revision 1.58 by pcg, Fri Feb 13 23:17:41 2004 UTC vs.
Revision 1.216 by root, Fri Nov 14 02:42:26 2008 UTC

…		…
2		2
3	Coro - coroutine process abstraction	3	Coro - coroutine process abstraction
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use Coro;	7	use Coro;
8		8
9	async {	9	async {
10	# some asynchronous thread of execution	10	# some asynchronous thread of execution
		11	print "2\n";
		12	cede; # yield back to main
		13	print "4\n";
11	};	14	};
12		15	print "1\n";
13	# alternatively create an async process like this:	16	cede; # yield to coroutine
14		17	print "3\n";
15	sub some_func : Coro {	18	cede; # and again
16	# some more async code	19
17	}	20	# use locking
18		21	use Coro::Semaphore;
19	cede;	22	my $lock = new Coro::Semaphore;
		23	my $locked;
		24
		25	$lock->down;
		26	$locked = 1;
		27	$lock->up;
20		28
21	=head1 DESCRIPTION	29	=head1 DESCRIPTION
22		30
23	This module collection manages coroutines. Coroutines are similar to	31	This module collection manages coroutines. Coroutines are similar to
24	threads but don't run in parallel.	32	threads but don't (in general) run in parallel at the same time even
		33	on SMP machines. The specific flavor of coroutine used in this module
		34	also guarantees you that it will not switch between coroutines unless
		35	necessary, at easily-identified points in your program, so locking and
		36	parallel access are rarely an issue, making coroutine programming much
		37	safer and easier than threads programming.
25		38
		39	Unlike a normal perl program, however, coroutines allow you to have
		40	multiple running interpreters that share data, which is especially useful
		41	to code pseudo-parallel processes and for event-based programming, such as
		42	multiple HTTP-GET requests running concurrently. See L<Coro::AnyEvent> to
		43	learn more.
		44
		45	Coroutines are also useful because Perl has no support for threads (the so
		46	called "threads" that perl offers are nothing more than the (bad) process
		47	emulation coming from the Windows platform: On standard operating systems
		48	they serve no purpose whatsoever, except by making your programs slow and
		49	making them use a lot of memory. Best disable them when building perl, or
		50	aks your software vendor/distributor to do it for you).
		51
26	In this module, coroutines are defined as "callchain + lexical variables	52	In this module, coroutines are defined as "callchain + lexical variables +
27	+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own	53	@_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain,
28	callchain, it's own set of lexicals and it's own set of perl's most	54	its own set of lexicals and its own set of perls most important global
29	important global variables.	55	variables (see L<Coro::State> for more configuration).
30		56
31	=cut	57	=cut
32		58
33	package Coro;	59	package Coro;
34		60
35	BEGIN { eval { require warnings } && warnings->unimport ("uninitialized") }	61	use strict qw(vars subs);
		62	no warnings "uninitialized";
36		63
37	use Coro::State;	64	use Coro::State;
38		65
39	use vars qw($idle $main $current);	66	use base qw(Coro::State Exporter);
40		67
41	use base Exporter;	68	our $idle; # idle handler
		69	our $main; # main coroutine
		70	our $current; # current coroutine
42		71
43	$VERSION = 0.95;	72	our $VERSION = 5.0;
44		73
45	@EXPORT = qw(async cede schedule terminate current);	74	our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
46	%EXPORT_TAGS = (	75	our %EXPORT_TAGS = (
47	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],	76	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
48	);	77	);
49	@EXPORT_OK = @{$EXPORT_TAGS{prio}};	78	our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
50
51	{
52	my @async;
53	my $init;
54
55	# this way of handling attributes simply is NOT scalable ;()
56	sub import {
57	Coro->export_to_level(1, @_);
58	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
59	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
60	my ($package, $ref) = (shift, shift);
61	my @attrs;
62	for (@_) {
63	if ($_ eq "Coro") {
64	push @async, $ref;
65	unless ($init++) {
66	eval q{
67	sub INIT {
68	&async(pop @async) while @async;
69	}
70	};
71	}
72	} else {
73	push @attrs, $_;
74	}
75	}
76	return $old ? $old->($package, $ref, @attrs) : @attrs;
77	};
78	}
79
80	}
81		79
82	=over 4	80	=over 4
83		81
84	=item $main	82	=item $Coro::main
85		83
86	This coroutine represents the main program.	84	This variable stores the coroutine object that represents the main
		85	program. While you cna C<ready> it and do most other things you can do to
		86	coroutines, it is mainly useful to compare again C<$Coro::current>, to see
		87	whether you are running in the main program or not.
87		88
88	=cut	89	=cut
89		90
90	$main = new Coro;	91	$main = new Coro;
91		92
92	=item $current (or as function: current)	93	=item $Coro::current
93		94
94	The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).	95	The coroutine object representing the current coroutine (the last
		96	coroutine that the Coro scheduler switched to). The initial value is
		97	C<$main> (of course).
95		98
		99	This variable is B<strictly> I<read-only>. You can take copies of the
		100	value stored in it and use it as any other coroutine object, but you must
		101	not otherwise modify the variable itself.
		102
96	=cut	103	=cut
		104
		105	$main->{desc} = "[main::]";
97		106
98	# maybe some other module used Coro::Specific before...	107	# maybe some other module used Coro::Specific before...
99	if ($current) {
100	$main->{specific} = $current->{specific};	108	$main->{_specific} = $current->{_specific}
101	}	109	if $current;
102		110
103	$current = $main;	111	_set_current $main;
104		112
105	sub current() { $current }	113	sub current() { $current } # [DEPRECATED]
106		114
107	=item $idle	115	=item $Coro::idle
108		116
109	The coroutine to switch to when no other coroutine is running. The default	117	This variable is mainly useful to integrate Coro into event loops. It is
110	implementation prints "FATAL: deadlock detected" and exits.	118	usually better to rely on L<Coro::AnyEvent> or LC<Coro::EV>, as this is
		119	pretty low-level functionality.
111		120
112	=cut	121	This variable stores a callback that is called whenever the scheduler
		122	finds no ready coroutines to run. The default implementation prints
		123	"FATAL: deadlock detected" and exits, because the program has no other way
		124	to continue.
113		125
114	# should be done using priorities :(	126	This hook is overwritten by modules such as C<Coro::Timer> and
115	$idle = new Coro sub {	127	C<Coro::AnyEvent> to wait on an external event that hopefully wake up a
116	print STDERR "FATAL: deadlock detected\n";	128	coroutine so the scheduler can run it.
117	exit(51);	129
		130	Note that the callback I<must not>, under any circumstances, block
		131	the current coroutine. Normally, this is achieved by having an "idle
		132	coroutine" that calls the event loop and then blocks again, and then
		133	readying that coroutine in the idle handler.
		134
		135	See L<Coro::Event> or L<Coro::AnyEvent> for examples of using this
		136	technique.
		137
		138	Please note that if your callback recursively invokes perl (e.g. for event
		139	handlers), then it must be prepared to be called recursively itself.
		140
		141	=cut
		142
		143	$idle = sub {
		144	require Carp;
		145	Carp::croak ("FATAL: deadlock detected");
118	};	146	};
		147
		148	sub _cancel {
		149	my ($self) = @_;
		150
		151	# free coroutine data and mark as destructed
		152	$self->_destroy
		153	or return;
		154
		155	# call all destruction callbacks
		156	$_->(@{$self->{_status}})
		157	for @{ delete $self->{_on_destroy} \|\| [] };
		158	}
119		159
120	# this coroutine is necessary because a coroutine	160	# this coroutine is necessary because a coroutine
121	# cannot destroy itself.	161	# cannot destroy itself.
122	my @destroy;	162	my @destroy;
123	my $manager;	163	my $manager;
		164
124	$manager = new Coro sub {	165	$manager = new Coro sub {
125	while () {	166	while () {
126	# by overwriting the state object with the manager we destroy it	167	(shift @destroy)->_cancel
127	# while still being able to schedule this coroutine (in case it has
128	# been readied multiple times. this is harmless since the manager
129	# can be called as many times as neccessary and will always
130	# remove itself from the runqueue
131	while (@destroy) {	168	while @destroy;
132	my $coro = pop @destroy;	169
133	$coro->{status} \|\|= [];
134	$_->ready for @{delete $coro->{join} \|\| []};
135	$coro->{_coro_state} = $manager->{_coro_state};
136	}
137	&schedule;	170	&schedule;
138	}	171	}
139	};	172	};
140		173	$manager->{desc} = "[coro manager]";
141	# static methods. not really.	174	$manager->prio (PRIO_MAX);
142		175
143	=back	176	=back
144		177
145	=head2 STATIC METHODS	178	=head2 SIMPLE COROUTINE CREATION
146
147	Static methods are actually functions that operate on the current process only.
148		179
149	=over 4	180	=over 4
150		181
151	=item async { ... } [@args...]	182	=item async { ... } [@args...]
152		183
153	Create a new asynchronous process and return it's process object	184	Create a new coroutine and return it's coroutine object (usually
154	(usually unused). When the sub returns the new process is automatically	185	unused). The coroutine will be put into the ready queue, so
		186	it will start running automatically on the next scheduler run.
		187
		188	The first argument is a codeblock/closure that should be executed in the
		189	coroutine. When it returns argument returns the coroutine is automatically
155	terminated.	190	terminated.
156		191
		192	The remaining arguments are passed as arguments to the closure.
		193
		194	See the C<Coro::State::new> constructor for info about the coroutine
		195	environment in which coroutines are executed.
		196
		197	Calling C<exit> in a coroutine will do the same as calling exit outside
		198	the coroutine. Likewise, when the coroutine dies, the program will exit,
		199	just as it would in the main program.
		200
		201	If you do not want that, you can provide a default C<die> handler, or
		202	simply avoid dieing (by use of C<eval>).
		203
157	# create a new coroutine that just prints its arguments	204	Example: Create a new coroutine that just prints its arguments.
		205
158	async {	206	async {
159	print "@_\n";	207	print "@_\n";
160	} 1,2,3,4;	208	} 1,2,3,4;
161		209
162	=cut	210	=cut
163		211
164	sub async(&@) {	212	sub async(&@) {
165	my $pid = new Coro @_;	213	my $coro = new Coro @_;
166	$manager->ready; # this ensures that the stack is cloned from the manager
167	$pid->ready;	214	$coro->ready;
168	$pid;	215	$coro
169	}	216	}
		217
		218	=item async_pool { ... } [@args...]
		219
		220	Similar to C<async>, but uses a coroutine pool, so you should not call
		221	terminate or join on it (although you are allowed to), and you get a
		222	coroutine that might have executed other code already (which can be good
		223	or bad :).
		224
		225	On the plus side, this function is faster than creating (and destroying)
		226	a completly new coroutine, so if you need a lot of generic coroutines in
		227	quick successsion, use C<async_pool>, not C<async>.
		228
		229	The code block is executed in an C<eval> context and a warning will be
		230	issued in case of an exception instead of terminating the program, as
		231	C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
		232	will not work in the expected way, unless you call terminate or cancel,
		233	which somehow defeats the purpose of pooling (but is fine in the
		234	exceptional case).
		235
		236	The priority will be reset to C<0> after each run, tracing will be
		237	disabled, the description will be reset and the default output filehandle
		238	gets restored, so you can change all these. Otherwise the coroutine will
		239	be re-used "as-is": most notably if you change other per-coroutine global
		240	stuff such as C<$/> you I<must needs> revert that change, which is most
		241	simply done by using local as in: C<< local $/ >>.
		242
		243	The idle pool size is limited to C<8> idle coroutines (this can be
		244	adjusted by changing $Coro::POOL_SIZE), but there can be as many non-idle
		245	coros as required.
		246
		247	If you are concerned about pooled coroutines growing a lot because a
		248	single C<async_pool> used a lot of stackspace you can e.g. C<async_pool
		249	{ terminate }> once per second or so to slowly replenish the pool. In
		250	addition to that, when the stacks used by a handler grows larger than 16kb
		251	(adjustable via $Coro::POOL_RSS) it will also be destroyed.
		252
		253	=cut
		254
		255	our $POOL_SIZE = 8;
		256	our $POOL_RSS = 16 * 1024;
		257	our @async_pool;
		258
		259	sub pool_handler {
		260	my $cb;
		261
		262	while () {
		263	eval {
		264	while () {
		265	_pool_1 $cb;
		266	&$cb;
		267	_pool_2 $cb;
		268	&schedule;
		269	}
		270	};
		271
		272	if ($@) {
		273	last if $@ eq "\3async_pool terminate\2\n";
		274	warn $@;
		275	}
		276	}
		277	}
		278
		279	sub async_pool(&@) {
		280	# this is also inlined into the unlock_scheduler
		281	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
		282
		283	$coro->{_invoke} = [@_];
		284	$coro->ready;
		285
		286	$coro
		287	}
		288
		289	=back
		290
		291	=head2 STATIC METHODS
		292
		293	Static methods are actually functions that operate on the current coroutine.
		294
		295	=over 4
170		296
171	=item schedule	297	=item schedule
172		298
173	Calls the scheduler. Please note that the current process will not be put	299	Calls the scheduler. The scheduler will find the next coroutine that is
		300	to be run from the ready queue and switches to it. The next coroutine
		301	to be run is simply the one with the highest priority that is longest
		302	in its ready queue. If there is no coroutine ready, it will clal the
		303	C<$Coro::idle> hook.
		304
		305	Please note that the current coroutine will I<not> be put into the ready
174	into the ready queue, so calling this function usually means you will	306	queue, so calling this function usually means you will never be called
175	never be called again.	307	again unless something else (e.g. an event handler) calls C<< ->ready >>,
		308	thus waking you up.
176		309
177	=cut	310	This makes C<schedule> I<the> generic method to use to block the current
		311	coroutine and wait for events: first you remember the current coroutine in
		312	a variable, then arrange for some callback of yours to call C<< ->ready
		313	>> on that once some event happens, and last you call C<schedule> to put
		314	yourself to sleep. Note that a lot of things can wake your coroutine up,
		315	so you need to check whether the event indeed happened, e.g. by storing the
		316	status in a variable.
		317
		318	The canonical way to wait on external events is this:
		319
		320	{
		321	# remember current coroutine
		322	my $current = $Coro::current;
		323
		324	# register a hypothetical event handler
		325	on_event_invoke sub {
		326	# wake up sleeping coroutine
		327	$current->ready;
		328	undef $current;
		329	};
		330
		331	# call schedule until event occurred.
		332	# in case we are woken up for other reasons
		333	# (current still defined), loop.
		334	Coro::schedule while $current;
		335	}
178		336
179	=item cede	337	=item cede
180		338
181	"Cede" to other processes. This function puts the current process into the	339	"Cede" to other coroutines. This function puts the current coroutine into
182	ready queue and calls C<schedule>, which has the effect of giving up the	340	the ready queue and calls C<schedule>, which has the effect of giving
183	current "timeslice" to other coroutines of the same or higher priority.	341	up the current "timeslice" to other coroutines of the same or higher
		342	priority. Once your coroutine gets its turn again it will automatically be
		343	resumed.
184		344
185	=cut	345	This function is often called C<yield> in other languages.
		346
		347	=item Coro::cede_notself
		348
		349	Works like cede, but is not exported by default and will cede to I<any>
		350	coroutine, regardless of priority. This is useful sometimes to ensure
		351	progress is made.
186		352
187	=item terminate [arg...]	353	=item terminate [arg...]
188		354
189	Terminates the current process.	355	Terminates the current coroutine with the given status values (see L<cancel>).
190		356
191	Future versions of this function will allow result arguments.	357	=item killall
		358
		359	Kills/terminates/cancels all coroutines except the currently running
		360	one. This is useful after a fork, either in the child or the parent, as
		361	usually only one of them should inherit the running coroutines.
		362
		363	Note that while this will try to free some of the main programs resources,
		364	you cannot free all of them, so if a coroutine that is not the main
		365	program calls this function, there will be some one-time resource leak.
192		366
193	=cut	367	=cut
194		368
195	sub terminate {	369	sub terminate {
196	$current->{status} = [@_];
197	$current->cancel;	370	$current->cancel (@_);
198	&schedule;	371	}
199	die; # NORETURN	372
		373	sub killall {
		374	for (Coro::State::list) {
		375	$_->cancel
		376	if $_ != $current && UNIVERSAL::isa $_, "Coro";
		377	}
200	}	378	}
201		379
202	=back	380	=back
203		381
204	# dynamic methods
205
206	=head2 PROCESS METHODS	382	=head2 COROUTINE METHODS
207		383
208	These are the methods you can call on process objects.	384	These are the methods you can call on coroutine objects (or to create
		385	them).
209		386
210	=over 4	387	=over 4
211		388
212	=item new Coro \&sub [, @args...]	389	=item new Coro \&sub [, @args...]
213		390
214	Create a new process and return it. When the sub returns the process	391	Create a new coroutine and return it. When the sub returns, the coroutine
215	automatically terminates as if C<terminate> with the returned values were	392	automatically terminates as if C<terminate> with the returned values were
216	called. To make the process run you must first put it into the ready queue	393	called. To make the coroutine run you must first put it into the ready
217	by calling the ready method.	394	queue by calling the ready method.
218		395
219	=cut	396	See C<async> and C<Coro::State::new> for additional info about the
		397	coroutine environment.
220		398
		399	=cut
		400
221	sub _newcoro {	401	sub _run_coro {
222	terminate &{+shift};	402	terminate &{+shift};
223	}	403	}
224		404
225	sub new {	405	sub new {
226	my $class = shift;	406	my $class = shift;
227	bless {
228	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
229	}, $class;
230	}
231		407
232	=item $process->ready	408	$class->SUPER::new (\&_run_coro, @_)
		409	}
233		410
234	Put the given process into the ready queue.	411	=item $success = $coroutine->ready
235		412
236	=cut	413	Put the given coroutine into the end of its ready queue (there is one
		414	queue for each priority) and return true. If the coroutine is already in
		415	the ready queue, do nothing and return false.
237		416
238	=item $process->cancel	417	This ensures that the scheduler will resume this coroutine automatically
		418	once all the coroutines of higher priority and all coroutines of the same
		419	priority that were put into the ready queue earlier have been resumed.
239		420
240	Like C<terminate>, but terminates the specified process instead.	421	=item $is_ready = $coroutine->is_ready
		422
		423	Return whether the coroutine is currently the ready queue or not,
		424
		425	=item $coroutine->cancel (arg...)
		426
		427	Terminates the given coroutine and makes it return the given arguments as
		428	status (default: the empty list). Never returns if the coroutine is the
		429	current coroutine.
241		430
242	=cut	431	=cut
243		432
244	sub cancel {	433	sub cancel {
		434	my $self = shift;
		435	$self->{_status} = [@_];
		436
		437	if ($current == $self) {
245	push @destroy, $_[0];	438	push @destroy, $self;
246	$manager->ready;	439	$manager->ready;
247	&schedule if $current == $_[0];	440	&schedule while 1;
		441	} else {
		442	$self->_cancel;
		443	}
248	}	444	}
249		445
		446	=item $coroutine->throw ([$scalar])
		447
		448	If C<$throw> is specified and defined, it will be thrown as an exception
		449	inside the coroutine at the next convenient point in time (usually after
		450	it gains control at the next schedule/transfer/cede). Otherwise clears the
		451	exception object.
		452
		453	The exception object will be thrown "as is" with the specified scalar in
		454	C<$@>, i.e. if it is a string, no line number or newline will be appended
		455	(unlike with C<die>).
		456
		457	This can be used as a softer means than C<cancel> to ask a coroutine to
		458	end itself, although there is no guarantee that the exception will lead to
		459	termination, and if the exception isn't caught it might well end the whole
		460	program.
		461
		462	You might also think of C<throw> as being the moral equivalent of
		463	C<kill>ing a coroutine with a signal (in this case, a scalar).
		464
250	=item $process->join	465	=item $coroutine->join
251		466
252	Wait until the coroutine terminates and return any values given to the	467	Wait until the coroutine terminates and return any values given to the
253	C<terminate> function. C<join> can be called multiple times from multiple	468	C<terminate> or C<cancel> functions. C<join> can be called concurrently
254	processes.	469	from multiple coroutines, and all will be resumed and given the status
		470	return once the C<$coroutine> terminates.
255		471
256	=cut	472	=cut
257		473
258	sub join {	474	sub join {
259	my $self = shift;	475	my $self = shift;
		476
260	unless ($self->{status}) {	477	unless ($self->{_status}) {
261	push @{$self->{join}}, $current;	478	my $current = $current;
262	&schedule;	479
		480	push @{$self->{_on_destroy}}, sub {
		481	$current->ready;
		482	undef $current;
		483	};
		484
		485	&schedule while $current;
263	}	486	}
		487
264	wantarray ? @{$self->{status}} : $self->{status}[0];	488	wantarray ? @{$self->{_status}} : $self->{_status}[0];
265	}	489	}
266		490
		491	=item $coroutine->on_destroy (\&cb)
		492
		493	Registers a callback that is called when this coroutine gets destroyed,
		494	but before it is joined. The callback gets passed the terminate arguments,
		495	if any, and I<must not> die, under any circumstances.
		496
		497	=cut
		498
		499	sub on_destroy {
		500	my ($self, $cb) = @_;
		501
		502	push @{ $self->{_on_destroy} }, $cb;
		503	}
		504
267	=item $oldprio = $process->prio($newprio)	505	=item $oldprio = $coroutine->prio ($newprio)
268		506
269	Sets (or gets, if the argument is missing) the priority of the	507	Sets (or gets, if the argument is missing) the priority of the
270	process. Higher priority processes get run before lower priority	508	coroutine. Higher priority coroutines get run before lower priority
271	processes. Priorities are small signed integers (currently -4 .. +3),	509	coroutines. Priorities are small signed integers (currently -4 .. +3),
272	that you can refer to using PRIO_xxx constants (use the import tag :prio	510	that you can refer to using PRIO_xxx constants (use the import tag :prio
273	to get then):	511	to get then):
274		512
275	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN	513	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
276	3 > 1 > 0 > -1 > -3 > -4	514	3 > 1 > 0 > -1 > -3 > -4
…		…
279	current->prio(PRIO_HIGH);	517	current->prio(PRIO_HIGH);
280		518
281	The idle coroutine ($Coro::idle) always has a lower priority than any	519	The idle coroutine ($Coro::idle) always has a lower priority than any
282	existing coroutine.	520	existing coroutine.
283		521
284	Changing the priority of the current process will take effect immediately,	522	Changing the priority of the current coroutine will take effect immediately,
285	but changing the priority of processes in the ready queue (but not	523	but changing the priority of coroutines in the ready queue (but not
286	running) will only take effect after the next schedule (of that	524	running) will only take effect after the next schedule (of that
287	process). This is a bug that will be fixed in some future version.	525	coroutine). This is a bug that will be fixed in some future version.
288		526
289	=cut
290
291	sub prio {
292	my $old = $_[0]{prio};
293	$_[0]{prio} = $_[1] if @_ > 1;
294	$old;
295	}
296
297	=item $newprio = $process->nice($change)	527	=item $newprio = $coroutine->nice ($change)
298		528
299	Similar to C<prio>, but subtract the given value from the priority (i.e.	529	Similar to C<prio>, but subtract the given value from the priority (i.e.
300	higher values mean lower priority, just as in unix).	530	higher values mean lower priority, just as in unix).
301		531
302	=cut
303
304	sub nice {
305	$_[0]{prio} -= $_[1];
306	}
307
308	=item $olddesc = $process->desc($newdesc)	532	=item $olddesc = $coroutine->desc ($newdesc)
309		533
310	Sets (or gets in case the argument is missing) the description for this	534	Sets (or gets in case the argument is missing) the description for this
311	process. This is just a free-form string you can associate with a process.	535	coroutine. This is just a free-form string you can associate with a
		536	coroutine.
		537
		538	This method simply sets the C<< $coroutine->{desc} >> member to the given
		539	string. You can modify this member directly if you wish.
312		540
313	=cut	541	=cut
314		542
315	sub desc {	543	sub desc {
316	my $old = $_[0]{desc};	544	my $old = $_[0]{desc};
…		…
318	$old;	546	$old;
319	}	547	}
320		548
321	=back	549	=back
322		550
		551	=head2 GLOBAL FUNCTIONS
		552
		553	=over 4
		554
		555	=item Coro::nready
		556
		557	Returns the number of coroutines that are currently in the ready state,
		558	i.e. that can be switched to by calling C<schedule> directory or
		559	indirectly. The value C<0> means that the only runnable coroutine is the
		560	currently running one, so C<cede> would have no effect, and C<schedule>
		561	would cause a deadlock unless there is an idle handler that wakes up some
		562	coroutines.
		563
		564	=item my $guard = Coro::guard { ... }
		565
		566	This creates and returns a guard object. Nothing happens until the object
		567	gets destroyed, in which case the codeblock given as argument will be
		568	executed. This is useful to free locks or other resources in case of a
		569	runtime error or when the coroutine gets canceled, as in both cases the
		570	guard block will be executed. The guard object supports only one method,
		571	C<< ->cancel >>, which will keep the codeblock from being executed.
		572
		573	Example: set some flag and clear it again when the coroutine gets canceled
		574	or the function returns:
		575
		576	sub do_something {
		577	my $guard = Coro::guard { $busy = 0 };
		578	$busy = 1;
		579
		580	# do something that requires $busy to be true
		581	}
		582
		583	=cut
		584
		585	sub guard(&) {
		586	bless \(my $cb = $_[0]), "Coro::guard"
		587	}
		588
		589	sub Coro::guard::cancel {
		590	${$_[0]} = sub { };
		591	}
		592
		593	sub Coro::guard::DESTROY {
		594	${$_[0]}->();
		595	}
		596
		597
		598	=item unblock_sub { ... }
		599
		600	This utility function takes a BLOCK or code reference and "unblocks" it,
		601	returning a new coderef. Unblocking means that calling the new coderef
		602	will return immediately without blocking, returning nothing, while the
		603	original code ref will be called (with parameters) from within another
		604	coroutine.
		605
		606	The reason this function exists is that many event libraries (such as the
		607	venerable L<Event\|Event> module) are not coroutine-safe (a weaker form
		608	of thread-safety). This means you must not block within event callbacks,
		609	otherwise you might suffer from crashes or worse. The only event library
		610	currently known that is safe to use without C<unblock_sub> is L<EV>.
		611
		612	This function allows your callbacks to block by executing them in another
		613	coroutine where it is safe to block. One example where blocking is handy
		614	is when you use the L<Coro::AIO\|Coro::AIO> functions to save results to
		615	disk, for example.
		616
		617	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
		618	creating event callbacks that want to block.
		619
		620	If your handler does not plan to block (e.g. simply sends a message to
		621	another coroutine, or puts some other coroutine into the ready queue),
		622	there is no reason to use C<unblock_sub>.
		623
		624	Note that you also need to use C<unblock_sub> for any other callbacks that
		625	are indirectly executed by any C-based event loop. For example, when you
		626	use a module that uses L<AnyEvent> (and you use L<Coro::AnyEvent>) and it
		627	provides callbacks that are the result of some event callback, then you
		628	must not block either, or use C<unblock_sub>.
		629
		630	=cut
		631
		632	our @unblock_queue;
		633
		634	# we create a special coro because we want to cede,
		635	# to reduce pressure on the coro pool (because most callbacks
		636	# return immediately and can be reused) and because we cannot cede
		637	# inside an event callback.
		638	our $unblock_scheduler = new Coro sub {
		639	while () {
		640	while (my $cb = pop @unblock_queue) {
		641	# this is an inlined copy of async_pool
		642	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
		643
		644	$coro->{_invoke} = $cb;
		645	$coro->ready;
		646	cede; # for short-lived callbacks, this reduces pressure on the coro pool
		647	}
		648	schedule; # sleep well
		649	}
		650	};
		651	$unblock_scheduler->{desc} = "[unblock_sub scheduler]";
		652
		653	sub unblock_sub(&) {
		654	my $cb = shift;
		655
		656	sub {
		657	unshift @unblock_queue, [$cb, @_];
		658	$unblock_scheduler->ready;
		659	}
		660	}
		661
		662	=back
		663
323	=cut	664	=cut
324		665
325	1;	666	1;
326		667
327	=head1 BUGS/LIMITATIONS	668	=head1 BUGS/LIMITATIONS
328		669
329	- you must make very sure that no coro is still active on global
330	destruction. very bad things might happen otherwise (usually segfaults).
331
332	- this module is not thread-safe. You should only ever use this module	670	This module is not perl-pseudo-thread-safe. You should only ever use this
333	from the same thread (this requirement might be losened in the future	671	module from the same thread (this requirement might be removed in the
334	to allow per-thread schedulers, but Coro::State does not yet allow	672	future to allow per-thread schedulers, but Coro::State does not yet allow
335	this).	673	this). I recommend disabling thread support and using processes, as this
		674	is much faster and uses less memory.
336		675
337	=head1 SEE ALSO	676	=head1 SEE ALSO
338		677
339	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	678	Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
340	L<Coro::Signal>, L<Coro::State>, L<Coro::Timer>, L<Coro::Event>,	679
341	L<Coro::L<Coro::RWLock>, Handle>, L<Coro::Socket>.	680	Debugging: L<Coro::Debug>.
		681
		682	Support/Utility: L<Coro::Specific>, L<Coro::Util>.
		683
		684	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
		685
		686	IO/Timers: L<Coro::Timer>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::AIO>.
		687
		688	Compatibility: L<Coro::LWP>, L<Coro::BDB>, L<Coro::Storable>, L<Coro::Select>.
		689
		690	XS API: L<Coro::MakeMaker>.
		691
		692	Low level Configuration, Coroutine Environment: L<Coro::State>.
342		693
343	=head1 AUTHOR	694	=head1 AUTHOR
344		695
345	Marc Lehmann <pcg@goof.com>	696	Marc Lehmann <schmorp@schmorp.de>
346	http://www.goof.com/pcg/marc/	697	http://home.schmorp.de/
347		698
348	=cut	699	=cut
349		700

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.58 by pcg, Fri Feb 13 23:17:41 2004 UTC vs. Revision 1.216 by root, Fri Nov 14 02:42:26 2008 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.58 by pcg, Fri Feb 13 23:17:41 2004 UTC vs.
Revision 1.216 by root, Fri Nov 14 02:42:26 2008 UTC