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

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.8 by root, Sat Jul 14 22:14:21 2001 UTC vs.
Revision 1.30 by root, Sat Aug 11 19:59:19 2001 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	This module is still experimental, see the BUGS section below.
		27
		28	In this module, coroutines are defined as "callchain + lexical variables
		29	+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own
		30	callchain, it's own set of lexicals and it's own set of perl's most
		31	important global variables.
		32
23	=cut	33	=cut
24		34
25	package Coro;	35	package Coro;
26		36
27	use Coro::State;	37	use Coro::State;
28		38
29	use base Exporter;	39	use base Exporter;
30		40
31	$VERSION = 0.03;	41	$VERSION = 0.45;
32		42
33	@EXPORT = qw(async yield schedule);	43	@EXPORT = qw(async cede schedule terminate current);
34	@EXPORT_OK = qw($current);	44	@EXPORT_OK = qw($current);
35		45
36	{	46	{
37	use subs 'async';
38
39	my @async;	47	my @async;
		48	my $init;
40		49
41	# this way of handling attributes simply is NOT scalable ;()	50	# this way of handling attributes simply is NOT scalable ;()
42	sub import {	51	sub import {
43	Coro->export_to_level(1, @_);	52	Coro->export_to_level(1, @_);
44	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};	53	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
…		…
46	my ($package, $ref) = (shift, shift);	55	my ($package, $ref) = (shift, shift);
47	my @attrs;	56	my @attrs;
48	for (@_) {	57	for (@_) {
49	if ($_ eq "Coro") {	58	if ($_ eq "Coro") {
50	push @async, $ref;	59	push @async, $ref;
		60	unless ($init++) {
		61	eval q{
		62	sub INIT {
		63	&async(pop @async) while @async;
		64	}
		65	};
		66	}
51	} else {	67	} else {
52	push @attrs, @_;	68	push @attrs, $_;
53	}	69	}
54	}	70	}
55	return $old ? $old->($package, $name, @attrs) : @attrs;	71	return $old ? $old->($package, $ref, @attrs) : @attrs;
56	};	72	};
57	}	73	}
58		74
59	sub INIT {
60	async pop @async while @async;
61	}
62	}	75	}
63
64	my $idle = new Coro sub {
65	&yield while 1;
66	};
67		76
68	=item $main	77	=item $main
69		78
70	This coroutine represents the main program.	79	This coroutine represents the main program.
71		80
72	=cut	81	=cut
73		82
74	$main = new Coro;	83	our $main = new Coro;
75		84
76	=item $current	85	=item $current (or as function: current)
77		86
78	The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).	87	The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).
79		88
80	=cut	89	=cut
81		90
82	# maybe some other module used Coro::Specific before...	91	# maybe some other module used Coro::Specific before...
83	if ($current) {	92	if ($current) {
84	$main->{specific} = $current->{specific};	93	$main->{specific} = $current->{specific};
85	}	94	}
86		95
87	$current = $main;	96	our $current = $main;
88		97
89	# we really need priorities...	98	sub current() { $current }
90	my @ready = (); # the ready queue. hehe, rather broken ;)	99
		100	=item $idle
		101
		102	The coroutine to switch to when no other coroutine is running. The default
		103	implementation prints "FATAL: deadlock detected" and exits.
		104
		105	=cut
		106
		107	# should be done using priorities :(
		108	our $idle = new Coro sub {
		109	print STDERR "FATAL: deadlock detected\n";
		110	exit(51);
		111	};
		112
		113	# this coroutine is necessary because a coroutine
		114	# cannot destroy itself.
		115	my @destroy;
		116	my $manager = new Coro sub {
		117	while() {
		118	delete ((pop @destroy)->{_coro_state}) while @destroy;
		119	&schedule;
		120	}
		121	};
91		122
92	# static methods. not really.	123	# static methods. not really.
93		124
94	=head2 STATIC METHODS	125	=head2 STATIC METHODS
95		126
96	Static methods are actually functions that operate on the current process only.	127	Static methods are actually functions that operate on the current process only.
97		128
98	=over 4	129	=over 4
99		130
100	=item async { ... };	131	=item async { ... } [@args...]
101		132
102	Create a new asynchronous process and return it's process object	133	Create a new asynchronous process and return it's process object
103	(usually unused). When the sub returns the new process is automatically	134	(usually unused). When the sub returns the new process is automatically
104	terminated.	135	terminated.
105		136
106	=cut	137	# create a new coroutine that just prints its arguments
		138	async {
		139	print "@_\n";
		140	} 1,2,3,4;
107		141
		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
		146
108	sub async(&) {	147	sub async(&@) {
109	(new Coro $_[0])->ready;	148	my $pid = new Coro @_;
		149	$manager->ready; # this ensures that the stack is cloned from the manager
		150	$pid->ready;
		151	$pid;
110	}	152	}
111		153
112	=item schedule	154	=item schedule
113		155
114	Calls the scheduler. Please note that the current process will not be put	156	Calls the scheduler. Please note that the current process will not be put
115	into the ready queue, so calling this function usually means you will	157	into the ready queue, so calling this function usually means you will
116	never be called again.	158	never be called again.
117		159
118	=cut	160	=cut
119		161
120	my $prev;
121
122	sub schedule {
123	($prev, $current) = ($current, shift @ready);
124	Coro::State::transfer($prev, $current);
125	}
126
127	=item yield	162	=item cede
128		163
129	Yield to other processes. This function puts the current process into the	164	"Cede" to other processes. This function puts the current process into the
130	ready queue and calls C<schedule>.	165	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.
131		167
132	=cut	168	=cut
133		169
134	sub yield {	170	=item terminate
		171
		172	Terminates the current process.
		173
		174	Future versions of this function will allow result arguments.
		175
		176	=cut
		177
		178	sub terminate {
135	$current->ready;	179	$current->cancel;
136	&schedule;	180	&schedule;
137	}	181	die; # NORETURN
138
139	=item terminate
140
141	Terminates the current process.
142
143	=cut
144
145	sub terminate {
146	&schedule;
147	}	182	}
148		183
149	=back	184	=back
150		185
151	# dynamic methods	186	# dynamic methods
…		…
154		189
155	These are the methods you can call on process objects.	190	These are the methods you can call on process objects.
156		191
157	=over 4	192	=over 4
158		193
159	=item new Coro \⊂	194	=item new Coro \&sub [, @args...]
160		195
161	Create a new process and return it. When the sub returns the process	196	Create a new process and return it. When the sub returns the process
162	automatically terminates. To start the process you must first put it into	197	automatically terminates. To start the process you must first put it into
163	the ready queue by calling the ready method.	198	the ready queue by calling the ready method.
164		199
		200	The coderef you submit MUST NOT be a closure that refers to variables
		201	in an outer scope. This does NOT work. Pass arguments into it instead.
		202
165	=cut	203	=cut
		204
		205	sub _newcoro {
		206	terminate &{+shift};
		207	}
166		208
167	sub new {	209	sub new {
168	my $class = shift;	210	my $class = shift;
169	my $proc = $_[0];
170	bless {	211	bless {
171	_coro_state => new Coro::State ($proc ? sub { &$proc; &terminate } : $proc),	212	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
172	}, $class;	213	}, $class;
173	}	214	}
174		215
175	=item $process->ready	216	=item $process->ready
176		217
177	Put the current process into the ready queue.	218	Put the current process into the ready queue.
178		219
179	=cut	220	=cut
180		221
181	sub ready {	222	=item $process->cancel
		223
		224	Like C<terminate>, but terminates the specified process instead.
		225
		226	=cut
		227
		228	sub cancel {
182	push @ready, $_[0];	229	push @destroy, $_[0];
		230	$manager->ready;
183	}	231	}
184		232
185	=back	233	=back
186		234
187	=cut	235	=cut
188		236
189	1;	237	1;
		238
		239	=head1 BUGS/LIMITATIONS
		240
		241	- could be faster, especially when the core would introduce special
		242	support for coroutines (like it does for threads).
		243	- there is still a memleak on coroutine termination that I could not
		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
		250	the same thread (this requirement might be loosened in the future to
		251	allow per-thread schedulers, but Coro::State does not yet allow this).
		252
		253	=head1 SEE ALSO
		254
		255	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
		256	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,
		257	L<Coro::Handle>, L<Coro::Socket>.
190		258
191	=head1 AUTHOR	259	=head1 AUTHOR
192		260
193	Marc Lehmann <pcg@goof.com>	261	Marc Lehmann <pcg@goof.com>
194	http://www.goof.com/pcg/marc/	262	http://www.goof.com/pcg/marc/

Diff Legend

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

Comparing cvsroot/Coro/Coro.pm (file contents): Revision 1.8 by root, Sat Jul 14 22:14:21 2001 UTC vs. Revision 1.30 by root, Sat Aug 11 19:59:19 2001 UTC

Diff Legend

Comparing cvsroot/Coro/Coro.pm (file contents):
Revision 1.8 by root, Sat Jul 14 22:14:21 2001 UTC vs.
Revision 1.30 by root, Sat Aug 11 19:59:19 2001 UTC