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

Comparing Coro/Coro.pm (file contents):
Revision 1.42 by root, Tue Nov 6 20:37:20 2001 UTC vs.
Revision 1.102 by root, Fri Dec 29 11:37:49 2006 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 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
		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).
		34
26	In this module, coroutines are defined as "callchain + lexical variables	35	In this module, coroutines are defined as "callchain + lexical variables +
27	+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own	36	@_ + $_ + $@ + $/ + 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	37	its own set of lexicals and its own set of perls most important global
29	important global variables.	38	variables.
30		39
31	=cut	40	=cut
32		41
33	package Coro;	42	package Coro;
34		43
		44	use strict;
35	no warnings qw(uninitialized);	45	no warnings "uninitialized";
36		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.52;	51	our $idle; # idle handler
		52	our $main; # main coroutine
		53	our $current; # current coroutine
42		54
		55	our $VERSION = '3.3';
		56
43	@EXPORT = qw(async cede schedule terminate current);	57	our @EXPORT = qw(async cede schedule terminate current unblock_sub);
44	%EXPORT_TAGS = (	58	our %EXPORT_TAGS = (
45	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],	59	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
46	);	60	);
47	@EXPORT_OK = @{$EXPORT_TAGS{prio}};	61	our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
48		62
49	{	63	{
50	my @async;	64	my @async;
51	my $init;	65	my $init;
52		66
53	# this way of handling attributes simply is NOT scalable ;()	67	# this way of handling attributes simply is NOT scalable ;()
54	sub import {	68	sub import {
		69	no strict 'refs';
		70
55	Coro->export_to_level(1, @_);	71	Coro->export_to_level (1, @_);
		72
56	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};	73	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
57	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {	74	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
58	my ($package, $ref) = (shift, shift);	75	my ($package, $ref) = (shift, shift);
59	my @attrs;	76	my @attrs;
60	for (@_) {	77	for (@_) {
…		…
75	};	92	};
76	}	93	}
77		94
78	}	95	}
79		96
		97	=over 4
		98
80	=item $main	99	=item $main
81		100
82	This coroutine represents the main program.	101	This coroutine represents the main program.
83		102
84	=cut	103	=cut
85		104
86	our $main = new Coro;	105	$main = new Coro;
87		106
88	=item $current (or as function: current)	107	=item $current (or as function: current)
89		108
90	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.
91		115
92	=cut	116	=cut
93		117
94	# maybe some other module used Coro::Specific before...	118	# maybe some other module used Coro::Specific before...
95	if ($current) {
96	$main->{specific} = $current->{specific};	119	$main->{specific} = $current->{specific}
97	}	120	if $current;
98		121
99	our $current = $main;	122	_set_current $main;
100		123
101	sub current() { $current }	124	sub current() { $current }
102		125
103	=item $idle	126	=item $idle
104		127
105	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
106	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.
107		131
108	=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.
109		135
110	# should be done using priorities :(	136	Please note that if your callback recursively invokes perl (e.g. for event
111	our $idle = new Coro sub {	137	handlers), then it must be prepared to be called recursively.
112	print STDERR "FATAL: deadlock detected\n";	138
113	exit(51);	139	=cut
		140
		141	$idle = sub {
		142	require Carp;
		143	Carp::croak ("FATAL: deadlock detected");
114	};	144	};
115		145
116	# this coroutine is necessary because a coroutine	146	# this coroutine is necessary because a coroutine
117	# cannot destroy itself.	147	# cannot destroy itself.
118	my @destroy;	148	my @destroy;
119	my $manager;
120	$manager = new Coro sub {	149	my $manager; $manager = new Coro sub {
121	while() {	150	while () {
122	# by overwriting the state object with the manager we destroy it	151	# by overwriting the state object with the manager we destroy it
123	# while still being able to schedule this coroutine (in case it has	152	# while still being able to schedule this coroutine (in case it has
124	# been readied multiple times. this is harmless since the manager	153	# been readied multiple times. this is harmless since the manager
125	# can be called as many times as neccessary and will always	154	# can be called as many times as neccessary and will always
126	# remove itself from the runqueue	155	# remove itself from the runqueue
127	while (@destroy) {	156	while (@destroy) {
128	my $coro = pop @destroy;	157	my $coro = pop @destroy;
		158
129	$coro->{status} \|\|= [];	159	$coro->{status} \|\|= [];
		160
130	$_->ready for @{delete $coro->{join} \|\| []};	161	$_->ready for @{(delete $coro->{join} ) \|\| []};
131	$coro->{_coro_state} = $manager->{_coro_state};	162	$_->(@{$coro->{status}}) for @{(delete $coro->{destroy_cb}) \|\| []};
		163
		164	# the next line destroys the coro state, but keeps the
		165	# coroutine itself intact (we basically make it a zombie
		166	# coroutine that always runs the manager thread, so it's possible
		167	# to transfer() to this coroutine).
		168	$coro->_clone_state_from ($manager);
132	}	169	}
133	&schedule;	170	&schedule;
134	}	171	}
135	};	172	};
136		173
137	# static methods. not really.	174	# static methods. not really.
138		175
		176	=back
		177
139	=head2 STATIC METHODS	178	=head2 STATIC METHODS
140		179
141	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.
142		181
143	=over 4	182	=over 4
144		183
145	=item async { ... } [@args...]	184	=item async { ... } [@args...]
146		185
147	Create a new asynchronous process and return it's process object	186	Create a new asynchronous coroutine and return it's coroutine object
148	(usually unused). When the sub returns the new process is automatically	187	(usually unused). When the sub returns the new coroutine is automatically
149	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.
150		194
151	# create a new coroutine that just prints its arguments	195	# create a new coroutine that just prints its arguments
152	async {	196	async {
153	print "@_\n";	197	print "@_\n";
154	} 1,2,3,4;	198	} 1,2,3,4;
155		199
156	The coderef you submit MUST NOT be a closure that refers to variables
157	in an outer scope. This does NOT work. Pass arguments into it instead.
158
159	=cut	200	=cut
160		201
161	sub async(&@) {	202	sub async(&@) {
162	my $pid = new Coro @_;	203	my $pid = new Coro @_;
163	$manager->ready; # this ensures that the stack is cloned from the manager
164	$pid->ready;	204	$pid->ready;
165	$pid;	205	$pid
166	}	206	}
167		207
168	=item schedule	208	=item schedule
169		209
170	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
171	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
172	never be called again.	212	never be called again unless something else (e.g. an event handler) calls
		213	ready.
173		214
174	=cut	215	The canonical way to wait on external events is this:
		216
		217	{
		218	# remember current coroutine
		219	my $current = $Coro::current;
		220
		221	# register a hypothetical event handler
		222	on_event_invoke sub {
		223	# wake up sleeping coroutine
		224	$current->ready;
		225	undef $current;
		226	};
		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	}
175		233
176	=item cede	234	=item cede
177		235
178	"Cede" to other processes. This function puts the current process into the	236	"Cede" to other coroutines. This function puts the current coroutine into the
179	ready queue and calls C<schedule>, which has the effect of giving up the	237	ready queue and calls C<schedule>, which has the effect of giving up the
180	current "timeslice" to other coroutines of the same or higher priority.	238	current "timeslice" to other coroutines of the same or higher priority.
181		239
182	=cut	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.
183		244
184	=item terminate [arg...]	245	=item terminate [arg...]
185		246
186	Terminates the current process.	247	Terminates the current coroutine with the given status values (see L<cancel>).
187
188	Future versions of this function will allow result arguments.
189		248
190	=cut	249	=cut
191		250
192	sub terminate {	251	sub terminate {
193	$current->{status} = [@_];
194	$current->cancel;	252	$current->cancel (@_);
195	&schedule;
196	die; # NORETURN
197	}	253	}
198		254
199	=back	255	=back
200		256
201	# dynamic methods	257	# dynamic methods
202		258
203	=head2 PROCESS METHODS	259	=head2 COROUTINE METHODS
204		260
205	These are the methods you can call on process objects.	261	These are the methods you can call on coroutine objects.
206		262
207	=over 4	263	=over 4
208		264
209	=item new Coro \&sub [, @args...]	265	=item new Coro \&sub [, @args...]
210		266
211	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
212	automatically terminates as if C<terminate> with the returned values were	268	automatically terminates as if C<terminate> with the returned values were
213	called. To make the process run you must first put it into the ready queue	269	called. To make the coroutine run you must first put it into the ready queue
214	by calling the ready method.	270	by calling the ready method.
215		271
216	=cut	272	Calling C<exit> in a coroutine will not work correctly, so do not do that.
217		273
		274	=cut
		275
218	sub _newcoro {	276	sub _run_coro {
219	terminate &{+shift};	277	terminate &{+shift};
220	}	278	}
221		279
222	sub new {	280	sub new {
223	my $class = shift;	281	my $class = shift;
224	bless {
225	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
226	}, $class;
227	}
228		282
229	=item $process->ready	283	$class->SUPER::new (\&_run_coro, @_)
		284	}
230		285
231	Put the given process into the ready queue.	286	=item $success = $coroutine->ready
232		287
233	=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.
234		291
235	=item $process->cancel	292	=item $is_ready = $coroutine->is_ready
236		293
237	Like C<terminate>, but terminates the specified process instead.	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).
238		300
239	=cut	301	=cut
240		302
241	sub cancel {	303	sub cancel {
		304	my $self = shift;
		305	$self->{status} = [@_];
242	push @destroy, $_[0];	306	push @destroy, $self;
243	$manager->ready;	307	$manager->ready;
244	&schedule if $current == $_[0];	308	&schedule if $current == $self;
245	}	309	}
246		310
247	=item $process->join	311	=item $coroutine->join
248		312
249	Wait until the coroutine terminates and return any values given to the	313	Wait until the coroutine terminates and return any values given to the
250	C<terminate> function. C<join> can be called multiple times from multiple	314	C<terminate> or C<cancel> functions. C<join> can be called multiple times
251	processes.	315	from multiple coroutine.
252		316
253	=cut	317	=cut
254		318
255	sub join {	319	sub join {
256	my $self = shift;	320	my $self = shift;
…		…
259	&schedule;	323	&schedule;
260	}	324	}
261	wantarray ? @{$self->{status}} : $self->{status}[0];	325	wantarray ? @{$self->{status}} : $self->{status}[0];
262	}	326	}
263		327
		328	=item $coroutine->on_destroy (\&cb)
		329
		330	Registers a callback that is called when this coroutine gets destroyed,
		331	but before it is joined. The callback gets passed the terminate arguments,
		332	if any.
		333
		334	=cut
		335
		336	sub on_destroy {
		337	my ($self, $cb) = @_;
		338
		339	push @{ $self->{destroy_cb} }, $cb;
		340	}
		341
264	=item $oldprio = $process->prio($newprio)	342	=item $oldprio = $coroutine->prio ($newprio)
265		343
266	Sets (or gets, if the argument is missing) the priority of the	344	Sets (or gets, if the argument is missing) the priority of the
267	process. Higher priority processes get run before lower priority	345	coroutine. Higher priority coroutines get run before lower priority
268	processes. Priorities are smalled signed integer (currently -4 .. +3),	346	coroutines. Priorities are small signed integers (currently -4 .. +3),
269	that you can refer to using PRIO_xxx constants (use the import tag :prio	347	that you can refer to using PRIO_xxx constants (use the import tag :prio
270	to get then):	348	to get then):
271		349
272	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN	350	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
273	3 > 1 > 0 > -1 > -3 > -4	351	3 > 1 > 0 > -1 > -3 > -4
…		…
276	current->prio(PRIO_HIGH);	354	current->prio(PRIO_HIGH);
277		355
278	The idle coroutine ($Coro::idle) always has a lower priority than any	356	The idle coroutine ($Coro::idle) always has a lower priority than any
279	existing coroutine.	357	existing coroutine.
280		358
281	Changing the priority of the current process will take effect immediately,	359	Changing the priority of the current coroutine will take effect immediately,
282	but changing the priority of processes in the ready queue (but not	360	but changing the priority of coroutines in the ready queue (but not
283	running) will only take effect after the next schedule (of that	361	running) will only take effect after the next schedule (of that
284	process). This is a bug that will be fixed in some future version.	362	coroutine). This is a bug that will be fixed in some future version.
285		363
286	=cut
287
288	sub prio {
289	my $old = $_[0]{prio};
290	$_[0]{prio} = $_[1] if @_ > 1;
291	$old;
292	}
293
294	=item $newprio = $process->nice($change)	364	=item $newprio = $coroutine->nice ($change)
295		365
296	Similar to C<prio>, but subtract the given value from the priority (i.e.	366	Similar to C<prio>, but subtract the given value from the priority (i.e.
297	higher values mean lower priority, just as in unix).	367	higher values mean lower priority, just as in unix).
298		368
299	=cut
300
301	sub nice {
302	$_[0]{prio} -= $_[1];
303	}
304
305	=item $olddesc = $process->desc($newdesc)	369	=item $olddesc = $coroutine->desc ($newdesc)
306		370
307	Sets (or gets in case the argument is missing) the description for this	371	Sets (or gets in case the argument is missing) the description for this
308	process. This is just a free-form string you can associate with a process.	372	coroutine. This is just a free-form string you can associate with a coroutine.
309		373
310	=cut	374	=cut
311		375
312	sub desc {	376	sub desc {
313	my $old = $_[0]{desc};	377	my $old = $_[0]{desc};
…		…
315	$old;	379	$old;
316	}	380	}
317		381
318	=back	382	=back
319		383
		384	=head2 GLOBAL FUNCTIONS
		385
		386	=over 4
		387
		388	=item Coro::nready
		389
		390	Returns the number of coroutines that are currently in the ready state,
		391	i.e. that can be swicthed to. The value C<0> means that the only runnable
		392	coroutine is the currently running one, so C<cede> would have no effect,
		393	and C<schedule> would cause a deadlock unless there is an idle handler
		394	that wakes up some coroutines.
		395
		396	=item unblock_sub { ... }
		397
		398	This utility function takes a BLOCK or code reference and "unblocks" it,
		399	returning the new coderef. This means that the new coderef will return
		400	immediately without blocking, returning nothing, while the original code
		401	ref will be called (with parameters) from within its own coroutine.
		402
		403	The reason this fucntion exists is that many event libraries (such as the
		404	venerable L<Event\|Event> module) are not coroutine-safe (a weaker form
		405	of thread-safety). This means you must not block within event callbacks,
		406	otherwise you might suffer from crashes or worse.
		407
		408	This function allows your callbacks to block by executing them in another
		409	coroutine where it is safe to block. One example where blocking is handy
		410	is when you use the L<Coro::AIO\|Coro::AIO> functions to save results to
		411	disk.
		412
		413	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
		414	creating event callbacks that want to block.
		415
		416	=cut
		417
		418	our @unblock_pool;
		419	our @unblock_queue;
		420	our $UNBLOCK_POOL_SIZE = 2;
		421
		422	sub unblock_handler_ {
		423	while () {
		424	my ($cb, @arg) = @{ delete $Coro::current->{arg} };
		425	$cb->(@arg);
		426
		427	last if @unblock_pool >= $UNBLOCK_POOL_SIZE;
		428	push @unblock_pool, $Coro::current;
		429	schedule;
		430	}
		431	}
		432
		433	our $unblock_scheduler = async {
		434	while () {
		435	while (my $cb = pop @unblock_queue) {
		436	my $handler = (pop @unblock_pool or new Coro \&unblock_handler_);
		437	$handler->{arg} = $cb;
		438	$handler->ready;
		439	cede;
		440	}
		441
		442	schedule;
		443	}
		444	};
		445
		446	sub unblock_sub(&) {
		447	my $cb = shift;
		448
		449	sub {
		450	push @unblock_queue, [$cb, @_];
		451	$unblock_scheduler->ready;
		452	}
		453	}
		454
		455	=back
		456
320	=cut	457	=cut
321		458
322	1;	459	1;
323		460
324	=head1 BUGS/LIMITATIONS	461	=head1 BUGS/LIMITATIONS
325		462
326	- you must make very sure that no coro is still active on global destruction.	463	- you must make very sure that no coro is still active on global
327	very bad things might happen otherwise (usually segfaults).	464	destruction. very bad things might happen otherwise (usually segfaults).
		465
328	- this module is not thread-safe. You should only ever use this module from	466	- this module is not thread-safe. You should only ever use this module
329	the same thread (this requirement might be loosened in the future to	467	from the same thread (this requirement might be losened in the future
330	allow per-thread schedulers, but Coro::State does not yet allow this).	468	to allow per-thread schedulers, but Coro::State does not yet allow
		469	this).
331		470
332	=head1 SEE ALSO	471	=head1 SEE ALSO
333		472
334	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	473	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
335	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,	474
336	L<Coro::Handle>, L<Coro::Socket>.	475	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
		476
		477	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
		478
		479	Embedding: L<Coro:MakeMaker>
337		480
338	=head1 AUTHOR	481	=head1 AUTHOR
339		482
340	Marc Lehmann <pcg@goof.com>	483	Marc Lehmann <schmorp@schmorp.de>
341	http://www.goof.com/pcg/marc/	484	http://home.schmorp.de/
342		485
343	=cut	486	=cut
344		487

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.42 by root, Tue Nov 6 20:37:20 2001 UTC vs. Revision 1.102 by root, Fri Dec 29 11:37:49 2006 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.42 by root, Tue Nov 6 20:37:20 2001 UTC vs.
Revision 1.102 by root, Fri Dec 29 11:37:49 2006 UTC