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

Comparing Coro/Coro.pm (file contents):
Revision 1.30 by root, Sat Aug 11 19:59:19 2001 UTC vs.
Revision 1.139 by root, Thu Sep 27 15:52:30 2007 UTC

…		…
8		8
9	async {	9	async {
10	# some asynchronous thread of execution	10	# some asynchronous thread of execution
11	};	11	};
12		12
13	# alternatively create an async process like this:	13	# alternatively create an async coroutine like this:
14		14
15	sub some_func : Coro {	15	sub some_func : Coro {
16	# some more async code	16	# some more async code
17	}	17	}
18		18
19	cede;	19	cede;
20		20
21	=head1 DESCRIPTION	21	=head1 DESCRIPTION
22		22
23	This module collection manages coroutines. Coroutines are similar to	23	This module collection manages coroutines. Coroutines are similar
24	Threads but don't run in parallel.	24	to threads but don't run in parallel at the same time even on SMP
		25	machines. The specific flavor of coroutine used in this module also
		26	guarantees you that it will not switch between coroutines unless
		27	necessary, at easily-identified points in your program, so locking and
		28	parallel access are rarely an issue, making coroutine programming much
		29	safer than threads programming.
25		30
26	This module is still experimental, see the BUGS section below.	31	(Perl, however, does not natively support real threads but instead does a
		32	very slow and memory-intensive emulation of processes using threads. This
		33	is a performance win on Windows machines, and a loss everywhere else).
27		34
28	In this module, coroutines are defined as "callchain + lexical variables	35	In this module, coroutines are defined as "callchain + lexical variables +
29	+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own	36	@_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain,
30	callchain, it's own set of lexicals and it's own set of perl's most	37	its own set of lexicals and its own set of perls most important global
31	important global variables.	38	variables.
32		39
33	=cut	40	=cut
34		41
35	package Coro;	42	package Coro;
36		43
		44	use strict;
		45	no warnings "uninitialized";
		46
37	use Coro::State;	47	use Coro::State;
38		48
39	use base Exporter;	49	use base qw(Coro::State Exporter);
40		50
41	$VERSION = 0.45;	51	our $idle; # idle handler
		52	our $main; # main coroutine
		53	our $current; # current coroutine
42		54
		55	our $VERSION = '3.8';
		56
43	@EXPORT = qw(async cede schedule terminate current);	57	our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
44	@EXPORT_OK = qw($current);	58	our %EXPORT_TAGS = (
		59	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
		60	);
		61	our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
45		62
46	{	63	{
47	my @async;	64	my @async;
48	my $init;	65	my $init;
49		66
50	# this way of handling attributes simply is NOT scalable ;()	67	# this way of handling attributes simply is NOT scalable ;()
51	sub import {	68	sub import {
		69	no strict 'refs';
		70
52	Coro->export_to_level(1, @_);	71	Coro->export_to_level (1, @_);
		72
53	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};	73	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
54	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {	74	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
55	my ($package, $ref) = (shift, shift);	75	my ($package, $ref) = (shift, shift);
56	my @attrs;	76	my @attrs;
57	for (@_) {	77	for (@_) {
…		…
72	};	92	};
73	}	93	}
74		94
75	}	95	}
76		96
		97	=over 4
		98
77	=item $main	99	=item $main
78		100
79	This coroutine represents the main program.	101	This coroutine represents the main program.
80		102
81	=cut	103	=cut
82		104
83	our $main = new Coro;	105	$main = new Coro;
84		106
85	=item $current (or as function: current)	107	=item $current (or as function: current)
86		108
87	The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).	109	The current coroutine (the last coroutine switched to). The initial value
		110	is C<$main> (of course).
88		111
		112	This variable is B<strictly> I<read-only>. It is provided for performance
		113	reasons. If performance is not essential you are encouraged to use the
		114	C<Coro::current> function instead.
		115
89	=cut	116	=cut
		117
		118	$main->{desc} = "[main::]";
90		119
91	# maybe some other module used Coro::Specific before...	120	# maybe some other module used Coro::Specific before...
92	if ($current) {
93	$main->{specific} = $current->{specific};	121	$main->{specific} = $current->{specific}
94	}	122	if $current;
95		123
96	our $current = $main;	124	_set_current $main;
97		125
98	sub current() { $current }	126	sub current() { $current }
99		127
100	=item $idle	128	=item $idle
101		129
102	The coroutine to switch to when no other coroutine is running. The default	130	A callback that is called whenever the scheduler finds no ready coroutines
103	implementation prints "FATAL: deadlock detected" and exits.	131	to run. The default implementation prints "FATAL: deadlock detected" and
		132	exits, because the program has no other way to continue.
104		133
105	=cut	134	This hook is overwritten by modules such as C<Coro::Timer> and
		135	C<Coro::Event> to wait on an external event that hopefully wake up a
		136	coroutine so the scheduler can run it.
106		137
107	# should be done using priorities :(	138	Please note that if your callback recursively invokes perl (e.g. for event
108	our $idle = new Coro sub {	139	handlers), then it must be prepared to be called recursively.
109	print STDERR "FATAL: deadlock detected\n";	140
110	exit(51);	141	=cut
		142
		143	$idle = sub {
		144	require Carp;
		145	Carp::croak ("FATAL: deadlock detected");
111	};	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->{destroy_cb}) \|\| []};
		158	}
		159
		160	sub _do_trace_sub {
		161	&{$current->{_trace_sub_cb}}
		162	}
		163
		164	sub _do_trace_line {
		165	&{$current->{_trace_line_cb}}
		166	}
112		167
113	# this coroutine is necessary because a coroutine	168	# this coroutine is necessary because a coroutine
114	# cannot destroy itself.	169	# cannot destroy itself.
115	my @destroy;	170	my @destroy;
		171	my $manager;
		172
116	my $manager = new Coro sub {	173	$manager = new Coro sub {
117	while() {	174	while () {
118	delete ((pop @destroy)->{_coro_state}) while @destroy;	175	(shift @destroy)->_cancel
		176	while @destroy;
		177
119	&schedule;	178	&schedule;
120	}	179	}
121	};	180	};
		181	$manager->desc ("[coro manager]");
		182	$manager->prio (PRIO_MAX);
122		183
123	# static methods. not really.	184	# static methods. not really.
124		185
		186	=back
		187
125	=head2 STATIC METHODS	188	=head2 STATIC METHODS
126		189
127	Static methods are actually functions that operate on the current process only.	190	Static methods are actually functions that operate on the current coroutine only.
128		191
129	=over 4	192	=over 4
130		193
131	=item async { ... } [@args...]	194	=item async { ... } [@args...]
132		195
133	Create a new asynchronous process and return it's process object	196	Create a new asynchronous coroutine and return it's coroutine object
134	(usually unused). When the sub returns the new process is automatically	197	(usually unused). When the sub returns the new coroutine is automatically
135	terminated.	198	terminated.
		199
		200	Calling C<exit> in a coroutine will do the same as calling exit outside
		201	the coroutine. Likewise, when the coroutine dies, the program will exit,
		202	just as it would in the main program.
136		203
137	# create a new coroutine that just prints its arguments	204	# create a new coroutine that just prints its arguments
138	async {	205	async {
139	print "@_\n";	206	print "@_\n";
140	} 1,2,3,4;	207	} 1,2,3,4;
141		208
142	The coderef you submit MUST NOT be a closure that refers to variables
143	in an outer scope. This does NOT work. Pass arguments into it instead.
144
145	=cut	209	=cut
146		210
147	sub async(&@) {	211	sub async(&@) {
148	my $pid = new Coro @_;	212	my $coro = new Coro @_;
149	$manager->ready; # this ensures that the stack is cloned from the manager
150	$pid->ready;	213	$coro->ready;
151	$pid;	214	$coro
		215	}
		216
		217	=item async_pool { ... } [@args...]
		218
		219	Similar to C<async>, but uses a coroutine pool, so you should not call
		220	terminate or join (although you are allowed to), and you get a coroutine
		221	that might have executed other code already (which can be good or bad :).
		222
		223	Also, the block is executed in an C<eval> context and a warning will be
		224	issued in case of an exception instead of terminating the program, as
		225	C<async> does. As the coroutine is being reused, stuff like C<on_destroy>
		226	will not work in the expected way, unless you call terminate or cancel,
		227	which somehow defeats the purpose of pooling.
		228
		229	The priority will be reset to C<0> after each job, otherwise the coroutine
		230	will be re-used "as-is".
		231
		232	The pool size is limited to 8 idle coroutines (this can be adjusted by
		233	changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
		234	required.
		235
		236	If you are concerned about pooled coroutines growing a lot because a
		237	single C<async_pool> used a lot of stackspace you can e.g. C<async_pool
		238	{ terminate }> once per second or so to slowly replenish the pool. In
		239	addition to that, when the stacks used by a handler grows larger than 16kb
		240	(adjustable with $Coro::POOL_RSS) it will also exit.
		241
		242	=cut
		243
		244	our $POOL_SIZE = 8;
		245	our $POOL_RSS = 16 * 1024;
		246	our @async_pool;
		247
		248	sub pool_handler {
		249	my $cb;
		250
		251	while () {
		252	eval {
		253	while () {
		254	_pool_1 $cb;
		255	&$cb;
		256	_pool_2 $cb;
		257	&schedule;
		258	}
		259	};
		260
		261	last if $@ eq "\3terminate\2\n";
		262	warn $@ if $@;
		263	}
		264	}
		265
		266	sub async_pool(&@) {
		267	# this is also inlined into the unlock_scheduler
		268	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
		269
		270	$coro->{_invoke} = [@_];
		271	$coro->ready;
		272
		273	$coro
152	}	274	}
153		275
154	=item schedule	276	=item schedule
155		277
156	Calls the scheduler. Please note that the current process will not be put	278	Calls the scheduler. Please note that the current coroutine will not be put
157	into the ready queue, so calling this function usually means you will	279	into the ready queue, so calling this function usually means you will
158	never be called again.	280	never be called again unless something else (e.g. an event handler) calls
		281	ready.
159		282
160	=cut	283	The canonical way to wait on external events is this:
		284
		285	{
		286	# remember current coroutine
		287	my $current = $Coro::current;
		288
		289	# register a hypothetical event handler
		290	on_event_invoke sub {
		291	# wake up sleeping coroutine
		292	$current->ready;
		293	undef $current;
		294	};
		295
		296	# call schedule until event occurred.
		297	# in case we are woken up for other reasons
		298	# (current still defined), loop.
		299	Coro::schedule while $current;
		300	}
161		301
162	=item cede	302	=item cede
163		303
164	"Cede" to other processes. This function puts the current process into the	304	"Cede" to other coroutines. This function puts the current coroutine into the
165	ready queue and calls C<schedule>, which has the effect of giving up the	305	ready queue and calls C<schedule>, which has the effect of giving up the
166	current "timeslice" to other coroutines of the same or higher priority.	306	current "timeslice" to other coroutines of the same or higher priority.
167		307
168	=cut	308	Returns true if at least one coroutine switch has happened.
169		309
		310	=item Coro::cede_notself
		311
		312	Works like cede, but is not exported by default and will cede to any
		313	coroutine, regardless of priority, once.
		314
		315	Returns true if at least one coroutine switch has happened.
		316
170	=item terminate	317	=item terminate [arg...]
171		318
172	Terminates the current process.	319	Terminates the current coroutine with the given status values (see L<cancel>).
173
174	Future versions of this function will allow result arguments.
175		320
176	=cut	321	=cut
177		322
178	sub terminate {	323	sub terminate {
179	$current->cancel;	324	$current->cancel (@_);
180	&schedule;
181	die; # NORETURN
182	}	325	}
183		326
184	=back	327	=back
185		328
186	# dynamic methods	329	# dynamic methods
187		330
188	=head2 PROCESS METHODS	331	=head2 COROUTINE METHODS
189		332
190	These are the methods you can call on process objects.	333	These are the methods you can call on coroutine objects.
191		334
192	=over 4	335	=over 4
193		336
194	=item new Coro \&sub [, @args...]	337	=item new Coro \&sub [, @args...]
195		338
196	Create a new process and return it. When the sub returns the process	339	Create a new coroutine and return it. When the sub returns the coroutine
197	automatically terminates. To start the process you must first put it into	340	automatically terminates as if C<terminate> with the returned values were
		341	called. To make the coroutine run you must first put it into the ready queue
198	the ready queue by calling the ready method.	342	by calling the ready method.
199		343
200	The coderef you submit MUST NOT be a closure that refers to variables	344	See C<async> for additional discussion.
201	in an outer scope. This does NOT work. Pass arguments into it instead.
202		345
203	=cut	346	=cut
204		347
205	sub _newcoro {	348	sub _run_coro {
206	terminate &{+shift};	349	terminate &{+shift};
207	}	350	}
208		351
209	sub new {	352	sub new {
210	my $class = shift;	353	my $class = shift;
211	bless {
212	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
213	}, $class;
214	}
215		354
216	=item $process->ready	355	$class->SUPER::new (\&_run_coro, @_)
		356	}
217		357
218	Put the current process into the ready queue.	358	=item $success = $coroutine->ready
219		359
220	=cut	360	Put the given coroutine into the ready queue (according to it's priority)
		361	and return true. If the coroutine is already in the ready queue, do nothing
		362	and return false.
221		363
222	=item $process->cancel	364	=item $is_ready = $coroutine->is_ready
223		365
224	Like C<terminate>, but terminates the specified process instead.	366	Return wether the coroutine is currently the ready queue or not,
		367
		368	=item $coroutine->cancel (arg...)
		369
		370	Terminates the given coroutine and makes it return the given arguments as
		371	status (default: the empty list). Never returns if the coroutine is the
		372	current coroutine.
225		373
226	=cut	374	=cut
227		375
228	sub cancel {	376	sub cancel {
		377	my $self = shift;
		378	$self->{status} = [@_];
		379
		380	if ($current == $self) {
229	push @destroy, $_[0];	381	push @destroy, $self;
230	$manager->ready;	382	$manager->ready;
		383	&schedule while 1;
		384	} else {
		385	$self->_cancel;
		386	}
		387	}
		388
		389	=item $coroutine->join
		390
		391	Wait until the coroutine terminates and return any values given to the
		392	C<terminate> or C<cancel> functions. C<join> can be called multiple times
		393	from multiple coroutine.
		394
		395	=cut
		396
		397	sub join {
		398	my $self = shift;
		399
		400	unless ($self->{status}) {
		401	my $current = $current;
		402
		403	push @{$self->{destroy_cb}}, sub {
		404	$current->ready;
		405	undef $current;
		406	};
		407
		408	&schedule while $current;
		409	}
		410
		411	wantarray ? @{$self->{status}} : $self->{status}[0];
		412	}
		413
		414	=item $coroutine->on_destroy (\&cb)
		415
		416	Registers a callback that is called when this coroutine gets destroyed,
		417	but before it is joined. The callback gets passed the terminate arguments,
		418	if any.
		419
		420	=cut
		421
		422	sub on_destroy {
		423	my ($self, $cb) = @_;
		424
		425	push @{ $self->{destroy_cb} }, $cb;
		426	}
		427
		428	=item $oldprio = $coroutine->prio ($newprio)
		429
		430	Sets (or gets, if the argument is missing) the priority of the
		431	coroutine. Higher priority coroutines get run before lower priority
		432	coroutines. Priorities are small signed integers (currently -4 .. +3),
		433	that you can refer to using PRIO_xxx constants (use the import tag :prio
		434	to get then):
		435
		436	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
		437	3 > 1 > 0 > -1 > -3 > -4
		438
		439	# set priority to HIGH
		440	current->prio(PRIO_HIGH);
		441
		442	The idle coroutine ($Coro::idle) always has a lower priority than any
		443	existing coroutine.
		444
		445	Changing the priority of the current coroutine will take effect immediately,
		446	but changing the priority of coroutines in the ready queue (but not
		447	running) will only take effect after the next schedule (of that
		448	coroutine). This is a bug that will be fixed in some future version.
		449
		450	=item $newprio = $coroutine->nice ($change)
		451
		452	Similar to C<prio>, but subtract the given value from the priority (i.e.
		453	higher values mean lower priority, just as in unix).
		454
		455	=item $olddesc = $coroutine->desc ($newdesc)
		456
		457	Sets (or gets in case the argument is missing) the description for this
		458	coroutine. This is just a free-form string you can associate with a coroutine.
		459
		460	=cut
		461
		462	sub desc {
		463	my $old = $_[0]{desc};
		464	$_[0]{desc} = $_[1] if @_ > 1;
		465	$old;
231	}	466	}
232		467
233	=back	468	=back
234		469
		470	=head2 GLOBAL FUNCTIONS
		471
		472	=over 4
		473
		474	=item Coro::nready
		475
		476	Returns the number of coroutines that are currently in the ready state,
		477	i.e. that can be switched to. The value C<0> means that the only runnable
		478	coroutine is the currently running one, so C<cede> would have no effect,
		479	and C<schedule> would cause a deadlock unless there is an idle handler
		480	that wakes up some coroutines.
		481
		482	=item my $guard = Coro::guard { ... }
		483
		484	This creates and returns a guard object. Nothing happens until the object
		485	gets destroyed, in which case the codeblock given as argument will be
		486	executed. This is useful to free locks or other resources in case of a
		487	runtime error or when the coroutine gets canceled, as in both cases the
		488	guard block will be executed. The guard object supports only one method,
		489	C<< ->cancel >>, which will keep the codeblock from being executed.
		490
		491	Example: set some flag and clear it again when the coroutine gets canceled
		492	or the function returns:
		493
		494	sub do_something {
		495	my $guard = Coro::guard { $busy = 0 };
		496	$busy = 1;
		497
		498	# do something that requires $busy to be true
		499	}
		500
		501	=cut
		502
		503	sub guard(&) {
		504	bless \(my $cb = $_[0]), "Coro::guard"
		505	}
		506
		507	sub Coro::guard::cancel {
		508	${$_[0]} = sub { };
		509	}
		510
		511	sub Coro::guard::DESTROY {
		512	${$_[0]}->();
		513	}
		514
		515
		516	=item unblock_sub { ... }
		517
		518	This utility function takes a BLOCK or code reference and "unblocks" it,
		519	returning the new coderef. This means that the new coderef will return
		520	immediately without blocking, returning nothing, while the original code
		521	ref will be called (with parameters) from within its own coroutine.
		522
		523	The reason this function exists is that many event libraries (such as the
		524	venerable L<Event\|Event> module) are not coroutine-safe (a weaker form
		525	of thread-safety). This means you must not block within event callbacks,
		526	otherwise you might suffer from crashes or worse.
		527
		528	This function allows your callbacks to block by executing them in another
		529	coroutine where it is safe to block. One example where blocking is handy
		530	is when you use the L<Coro::AIO\|Coro::AIO> functions to save results to
		531	disk.
		532
		533	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
		534	creating event callbacks that want to block.
		535
		536	=cut
		537
		538	our @unblock_queue;
		539
		540	# we create a special coro because we want to cede,
		541	# to reduce pressure on the coro pool (because most callbacks
		542	# return immediately and can be reused) and because we cannot cede
		543	# inside an event callback.
		544	our $unblock_scheduler = new Coro sub {
		545	while () {
		546	while (my $cb = pop @unblock_queue) {
		547	# this is an inlined copy of async_pool
		548	my $coro = (pop @async_pool) \|\| new Coro \&pool_handler;
		549
		550	$coro->{_invoke} = $cb;
		551	$coro->ready;
		552	cede; # for short-lived callbacks, this reduces pressure on the coro pool
		553	}
		554	schedule; # sleep well
		555	}
		556	};
		557	$unblock_scheduler->desc ("[unblock_sub scheduler]");
		558
		559	sub unblock_sub(&) {
		560	my $cb = shift;
		561
		562	sub {
		563	unshift @unblock_queue, [$cb, @_];
		564	$unblock_scheduler->ready;
		565	}
		566	}
		567
		568	=back
		569
235	=cut	570	=cut
236		571
237	1;	572	1;
238		573
239	=head1 BUGS/LIMITATIONS	574	=head1 BUGS/LIMITATIONS
240		575
241	- could be faster, especially when the core would introduce special	576	- you must make very sure that no coro is still active on global
242	support for coroutines (like it does for threads).	577	destruction. very bad things might happen otherwise (usually segfaults).
243	- there is still a memleak on coroutine termination that I could not	578
244	identify. Could be as small as a single SV.
245	- this module is not well-tested.
246	- if variables or arguments "disappear" (become undef) or become
247	corrupted please contact the author so he cen iron out the
248	remaining bugs.
249	- this module is not thread-safe. You must only ever use this module from	579	- this module is not thread-safe. You should only ever use this module
250	the same thread (this requirement might be loosened in the future to	580	from the same thread (this requirement might be loosened in the future
251	allow per-thread schedulers, but Coro::State does not yet allow this).	581	to allow per-thread schedulers, but Coro::State does not yet allow
		582	this).
252		583
253	=head1 SEE ALSO	584	=head1 SEE ALSO
254		585
255	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	586	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
256	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,	587
257	L<Coro::Handle>, L<Coro::Socket>.	588	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
		589
		590	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
		591
		592	Embedding: L<Coro:MakeMaker>
258		593
259	=head1 AUTHOR	594	=head1 AUTHOR
260		595
261	Marc Lehmann <pcg@goof.com>	596	Marc Lehmann <schmorp@schmorp.de>
262	http://www.goof.com/pcg/marc/	597	http://home.schmorp.de/
263		598
264	=cut	599	=cut
265		600

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.30 by root, Sat Aug 11 19:59:19 2001 UTC vs. Revision 1.139 by root, Thu Sep 27 15:52:30 2007 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.30 by root, Sat Aug 11 19:59:19 2001 UTC vs.
Revision 1.139 by root, Thu Sep 27 15:52:30 2007 UTC