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

Comparing Coro/Coro.pm (file contents):
Revision 1.13 by root, Tue Jul 17 00:24:14 2001 UTC vs.
Revision 1.81 by root, Fri Nov 24 11:36:57 2006 UTC

…		…
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
		24	threads but don't run in parallel.
		25
		26	In this module, coroutines are defined as "callchain + lexical variables
		27	+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own
		28	callchain, it's own set of lexicals and it's own set of perl's most
		29	important global variables.
		30
23	=cut	31	=cut
24		32
25	package Coro;	33	package Coro;
26		34
		35	use strict;
		36	no warnings "uninitialized";
		37
27	use Coro::State;	38	use Coro::State;
28		39
29	use base Exporter;	40	use base Exporter::;
30		41
		42	our $idle; # idle coroutine
		43	our $main; # main coroutine
		44	our $current; # current coroutine
		45
31	$VERSION = 0.05;	46	our $VERSION = '2.5';
32		47
33	@EXPORT = qw(async yield schedule terminate);	48	our @EXPORT = qw(async cede schedule terminate current);
34	@EXPORT_OK = qw($current);	49	our %EXPORT_TAGS = (
		50	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
		51	);
		52	our @EXPORT_OK = @{$EXPORT_TAGS{prio}};
35		53
36	{	54	{
37	use subs 'async';
38
39	my @async;	55	my @async;
		56	my $init;
40		57
41	# this way of handling attributes simply is NOT scalable ;()	58	# this way of handling attributes simply is NOT scalable ;()
42	sub import {	59	sub import {
		60	no strict 'refs';
		61
43	Coro->export_to_level(1, @_);	62	Coro->export_to_level(1, @_);
		63
44	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};	64	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
45	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {	65	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
46	my ($package, $ref) = (shift, shift);	66	my ($package, $ref) = (shift, shift);
47	my @attrs;	67	my @attrs;
48	for (@_) {	68	for (@_) {
49	if ($_ eq "Coro") {	69	if ($_ eq "Coro") {
50	push @async, $ref;	70	push @async, $ref;
		71	unless ($init++) {
		72	eval q{
		73	sub INIT {
		74	&async(pop @async) while @async;
		75	}
		76	};
		77	}
51	} else {	78	} else {
52	push @attrs, @_;	79	push @attrs, $_;
53	}	80	}
54	}	81	}
55	return $old ? $old->($package, $name, @attrs) : @attrs;	82	return $old ? $old->($package, $ref, @attrs) : @attrs;
56	};	83	};
57	}	84	}
58		85
59	sub INIT {
60	async pop @async while @async;
61	}
62	}	86	}
		87
		88	=over 4
63		89
64	=item $main	90	=item $main
65		91
66	This coroutine represents the main program.	92	This coroutine represents the main program.
67		93
68	=cut	94	=cut
69		95
70	our $main = new Coro;	96	$main = new Coro;
71		97
72	=item $current	98	=item $current (or as function: current)
73		99
74	The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).	100	The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).
75		101
76	=cut	102	=cut
77		103
78	# maybe some other module used Coro::Specific before...	104	# maybe some other module used Coro::Specific before...
79	if ($current) {	105	if ($current) {
80	$main->{specific} = $current->{specific};	106	$main->{specific} = $current->{specific};
81	}	107	}
82		108
83	our $current = $main;	109	$current = $main;
		110
		111	sub current() { $current }
84		112
85	=item $idle	113	=item $idle
86		114
87	The coroutine to switch to when no other coroutine is running. The default	115	The coroutine to switch to when no other coroutine is running. The default
88	implementation prints "FATAL: deadlock detected" and exits.	116	implementation prints "FATAL: deadlock detected" and exits.
89		117
90	=cut	118	=cut
91		119
92	# should be done using priorities :(	120	# should be done using priorities :(
93	our $idle = new Coro sub {	121	$idle = new Coro sub {
94	print STDERR "FATAL: deadlock detected\n";	122	print STDERR "FATAL: deadlock detected\n";
95	exit(51);	123	exit(51);
96	};	124	};
97		125
98	# we really need priorities...	126	# this coroutine is necessary because a coroutine
99	## my @ready; #d#	127	# cannot destroy itself.
100	our @ready = (); # the ready queue. hehe, rather broken ;)	128	my @destroy;
		129	my $manager;
		130	$manager = new Coro sub {
		131	while () {
		132	# by overwriting the state object with the manager we destroy it
		133	# while still being able to schedule this coroutine (in case it has
		134	# been readied multiple times. this is harmless since the manager
		135	# can be called as many times as neccessary and will always
		136	# remove itself from the runqueue
		137	while (@destroy) {
		138	my $coro = pop @destroy;
		139	$coro->{status} \|\|= [];
		140	$_->ready for @{delete $coro->{join} \|\| []};
		141
		142	# the next line destroys the _coro_state, but keeps the
		143	# process itself intact (we basically make it a zombie
		144	# process that always runs the manager thread, so it's possible
		145	# to transfer() to this process).
		146	$coro->{_coro_state} = $manager->{_coro_state};
		147	}
		148	&schedule;
		149	}
		150	};
101		151
102	# static methods. not really.	152	# static methods. not really.
		153
		154	=back
103		155
104	=head2 STATIC METHODS	156	=head2 STATIC METHODS
105		157
106	Static methods are actually functions that operate on the current process only.	158	Static methods are actually functions that operate on the current process only.
107		159
…		…
110	=item async { ... } [@args...]	162	=item async { ... } [@args...]
111		163
112	Create a new asynchronous process and return it's process object	164	Create a new asynchronous process and return it's process object
113	(usually unused). When the sub returns the new process is automatically	165	(usually unused). When the sub returns the new process is automatically
114	terminated.	166	terminated.
		167
		168	When the coroutine dies, the program will exit, just as in the main
		169	program.
115		170
116	# create a new coroutine that just prints its arguments	171	# create a new coroutine that just prints its arguments
117	async {	172	async {
118	print "@_\n";	173	print "@_\n";
119	} 1,2,3,4;	174	} 1,2,3,4;
120		175
121	The coderef you submit MUST NOT be a closure that refers to variables
122	in an outer scope. This does NOT work. Pass arguments into it instead.
123
124	=cut	176	=cut
125		177
126	sub async(&@) {	178	sub async(&@) {
127	my $pid = new Coro @_;	179	my $pid = new Coro @_;
		180	$manager->ready; # this ensures that the stack is cloned from the manager
128	$pid->ready;	181	$pid->ready;
129	$pid;	182	$pid;
130	}	183	}
131		184
132	=item schedule	185	=item schedule
…		…
135	into the ready queue, so calling this function usually means you will	188	into the ready queue, so calling this function usually means you will
136	never be called again.	189	never be called again.
137		190
138	=cut	191	=cut
139		192
140	my $prev;
141
142	sub schedule {
143	# should be done using priorities :(
144	($prev, $current) = ($current, shift @ready \|\| $idle);
145	Coro::State::transfer($prev, $current);
146	}
147
148	=item yield	193	=item cede
149		194
150	Yield to other processes. This function puts the current process into the	195	"Cede" to other processes. This function puts the current process into the
151	ready queue and calls C<schedule>.	196	ready queue and calls C<schedule>, which has the effect of giving up the
		197	current "timeslice" to other coroutines of the same or higher priority.
152		198
153	=cut	199	=cut
154		200
155	sub yield {
156	$current->ready;
157	&schedule;
158	}
159
160	=item terminate	201	=item terminate [arg...]
161		202
162	Terminates the current process.	203	Terminates the current process with the given status values (see L<cancel>).
163
164	Future versions of this function will allow result arguments.
165		204
166	=cut	205	=cut
167		206
168	sub terminate {	207	sub terminate {
169	$current->{_results} = [@_];	208	$current->cancel (@_);
170	&schedule;
171	}	209	}
172		210
173	=back	211	=back
174		212
175	# dynamic methods	213	# dynamic methods
…		…
181	=over 4	219	=over 4
182		220
183	=item new Coro \&sub [, @args...]	221	=item new Coro \&sub [, @args...]
184		222
185	Create a new process and return it. When the sub returns the process	223	Create a new process and return it. When the sub returns the process
186	automatically terminates. To start the process you must first put it into	224	automatically terminates as if C<terminate> with the returned values were
		225	called. To make the process run you must first put it into the ready queue
187	the ready queue by calling the ready method.	226	by calling the ready method.
188
189	The coderef you submit MUST NOT be a closure that refers to variables
190	in an outer scope. This does NOT work. Pass arguments into it instead.
191		227
192	=cut	228	=cut
193		229
194	sub _newcoro {	230	sub _newcoro {
195	terminate &{+shift};	231	terminate &{+shift};
196	}	232	}
197		233
198	sub new {	234	sub new {
199	my $class = shift;	235	my $class = shift;
200	bless {	236	bless {
201	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),	237	_coro_state => (new Coro::State \&_newcoro, @_),
202	}, $class;	238	}, $class;
203	}	239	}
204		240
205	=item $process->ready	241	=item $process->ready
206		242
207	Put the current process into the ready queue.	243	Put the given process into the ready queue.
208		244
209	=cut	245	=cut
210		246
211	sub ready {	247	=item $process->cancel (arg...)
212	push @ready, $_[0];	248
		249	Terminates the given process and makes it return the given arguments as
		250	status (default: the empty list).
		251
		252	=cut
		253
		254	sub cancel {
		255	my $self = shift;
		256	$self->{status} = [@_];
		257	push @destroy, $self;
		258	$manager->ready;
		259	&schedule if $current == $self;
		260	}
		261
		262	=item $process->join
		263
		264	Wait until the coroutine terminates and return any values given to the
		265	C<terminate> or C<cancel> functions. C<join> can be called multiple times
		266	from multiple processes.
		267
		268	=cut
		269
		270	sub join {
		271	my $self = shift;
		272	unless ($self->{status}) {
		273	push @{$self->{join}}, $current;
		274	&schedule;
		275	}
		276	wantarray ? @{$self->{status}} : $self->{status}[0];
		277	}
		278
		279	=item $oldprio = $process->prio($newprio)
		280
		281	Sets (or gets, if the argument is missing) the priority of the
		282	process. Higher priority processes get run before lower priority
		283	processes. Priorities are small signed integers (currently -4 .. +3),
		284	that you can refer to using PRIO_xxx constants (use the import tag :prio
		285	to get then):
		286
		287	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
		288	3 > 1 > 0 > -1 > -3 > -4
		289
		290	# set priority to HIGH
		291	current->prio(PRIO_HIGH);
		292
		293	The idle coroutine ($Coro::idle) always has a lower priority than any
		294	existing coroutine.
		295
		296	Changing the priority of the current process will take effect immediately,
		297	but changing the priority of processes in the ready queue (but not
		298	running) will only take effect after the next schedule (of that
		299	process). This is a bug that will be fixed in some future version.
		300
		301	=cut
		302
		303	sub prio {
		304	my $old = $_[0]{prio};
		305	$_[0]{prio} = $_[1] if @_ > 1;
		306	$old;
		307	}
		308
		309	=item $newprio = $process->nice($change)
		310
		311	Similar to C<prio>, but subtract the given value from the priority (i.e.
		312	higher values mean lower priority, just as in unix).
		313
		314	=cut
		315
		316	sub nice {
		317	$_[0]{prio} -= $_[1];
		318	}
		319
		320	=item $olddesc = $process->desc($newdesc)
		321
		322	Sets (or gets in case the argument is missing) the description for this
		323	process. This is just a free-form string you can associate with a process.
		324
		325	=cut
		326
		327	sub desc {
		328	my $old = $_[0]{desc};
		329	$_[0]{desc} = $_[1] if @_ > 1;
		330	$old;
213	}	331	}
214		332
215	=back	333	=back
216		334
217	=cut	335	=cut
218		336
219	1;	337	1;
220		338
		339	=head1 BUGS/LIMITATIONS
		340
		341	- you must make very sure that no coro is still active on global
		342	destruction. very bad things might happen otherwise (usually segfaults).
		343
		344	- this module is not thread-safe. You should only ever use this module
		345	from the same thread (this requirement might be losened in the future
		346	to allow per-thread schedulers, but Coro::State does not yet allow
		347	this).
		348
221	=head1 SEE ALSO	349	=head1 SEE ALSO
222		350
223	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	351	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
224	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>.	352
		353	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
		354
		355	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
		356
		357	Embedding: L<Coro:MakeMaker>
225		358
226	=head1 AUTHOR	359	=head1 AUTHOR
227		360
228	Marc Lehmann <pcg@goof.com>	361	Marc Lehmann <schmorp@schmorp.de>
229	http://www.goof.com/pcg/marc/	362	http://home.schmorp.de/
230		363
231	=cut	364	=cut
232		365

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.13 by root, Tue Jul 17 00:24:14 2001 UTC vs. Revision 1.81 by root, Fri Nov 24 11:36:57 2006 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.13 by root, Tue Jul 17 00:24:14 2001 UTC vs.
Revision 1.81 by root, Fri Nov 24 11:36:57 2006 UTC