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

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

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.21 by root, Sun Jul 22 03:24:10 2001 UTC vs. Revision 1.103 by root, Thu Jan 4 20:14:19 2007 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.21 by root, Sun Jul 22 03:24:10 2001 UTC vs.
Revision 1.103 by root, Thu Jan 4 20:14:19 2007 UTC