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

Comparing Coro/Coro.pm (file contents):
Revision 1.11 by root, Sun Jul 15 03:24:18 2001 UTC vs.
Revision 1.72 by root, Mon Dec 12 17:49:07 2005 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
31	$VERSION = 0.04;	42	our $idle; # idle coroutine
		43	our $main; # main coroutine
		44	our $current; # current coroutine
32		45
33	@EXPORT = qw(async yield schedule);	46	our $VERSION = 1.51;
34	@EXPORT_OK = qw($current);	47
		48	our @EXPORT = qw(async cede schedule terminate 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 = (); # the ready queue. hehe, rather broken ;)	127	# cannot destroy itself.
		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	};
100		151
101	# static methods. not really.	152	# static methods. not really.
102		153
		154	=back
		155
103	=head2 STATIC METHODS	156	=head2 STATIC METHODS
104		157
105	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.
106		159
107	=over 4	160	=over 4
108		161
109	=item async { ... };	162	=item async { ... } [@args...]
110		163
111	Create a new asynchronous process and return it's process object	164	Create a new asynchronous process and return it's process object
112	(usually unused). When the sub returns the new process is automatically	165	(usually unused). When the sub returns the new process is automatically
113	terminated.	166	terminated.
114		167
115	=cut	168	# create a new coroutine that just prints its arguments
		169	async {
		170	print "@_\n";
		171	} 1,2,3,4;
116		172
		173	=cut
		174
117	sub async(&) {	175	sub async(&@) {
118	my $pid = new Coro $_[0];	176	my $pid = new Coro @_;
		177	$manager->ready; # this ensures that the stack is cloned from the manager
119	$pid->ready;	178	$pid->ready;
120	$pid;	179	$pid;
121	}	180	}
122		181
123	=item schedule	182	=item schedule
…		…
126	into the ready queue, so calling this function usually means you will	185	into the ready queue, so calling this function usually means you will
127	never be called again.	186	never be called again.
128		187
129	=cut	188	=cut
130		189
131	my $prev;
132
133	sub schedule {
134	# should be done using priorities :(
135	($prev, $current) = ($current, shift @ready \|\| $idle);
136	Coro::State::transfer($prev, $current);
137	}
138
139	=item yield	190	=item cede
140		191
141	Yield to other processes. This function puts the current process into the	192	"Cede" to other processes. This function puts the current process into the
142	ready queue and calls C<schedule>.	193	ready queue and calls C<schedule>, which has the effect of giving up the
		194	current "timeslice" to other coroutines of the same or higher priority.
143		195
144	=cut	196	=cut
145		197
146	sub yield {
147	$current->ready;
148	&schedule;
149	}
150
151	=item terminate	198	=item terminate [arg...]
152		199
153	Terminates the current process.	200	Terminates the current process with the given status values (see L<cancel>).
154		201
155	=cut	202	=cut
156		203
157	sub terminate {	204	sub terminate {
158	&schedule;	205	$current->cancel (@_);
159	}	206	}
160		207
161	=back	208	=back
162		209
163	# dynamic methods	210	# dynamic methods
…		…
166		213
167	These are the methods you can call on process objects.	214	These are the methods you can call on process objects.
168		215
169	=over 4	216	=over 4
170		217
171	=item new Coro \⊂	218	=item new Coro \&sub [, @args...]
172		219
173	Create a new process and return it. When the sub returns the process	220	Create a new process and return it. When the sub returns the process
174	automatically terminates. To start the process you must first put it into	221	automatically terminates as if C<terminate> with the returned values were
		222	called. To make the process run you must first put it into the ready queue
175	the ready queue by calling the ready method.	223	by calling the ready method.
176		224
177	=cut	225	=cut
		226
		227	sub _newcoro {
		228	terminate &{+shift};
		229	}
178		230
179	sub new {	231	sub new {
180	my $class = shift;	232	my $class = shift;
181	my $proc = $_[0];
182	bless {	233	bless {
183	_coro_state => new Coro::State ($proc ? sub { &$proc; &terminate } : $proc),	234	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
184	}, $class;	235	}, $class;
185	}	236	}
186		237
187	=item $process->ready	238	=item $process->ready
188		239
189	Put the current process into the ready queue.	240	Put the given process into the ready queue.
190		241
191	=cut	242	=cut
192		243
193	sub ready {	244	=item $process->cancel (arg...)
194	push @ready, $_[0];	245
		246	Temrinates the given process and makes it return the given arguments as
		247	status (default: the empty list).
		248
		249	=cut
		250
		251	sub cancel {
		252	my $self = shift;
		253	$self->{status} = [@_];
		254	push @destroy, $self;
		255	$manager->ready;
		256	&schedule if $current == $self;
		257	}
		258
		259	=item $process->join
		260
		261	Wait until the coroutine terminates and return any values given to the
		262	C<terminate> or C<cancel> functions. C<join> can be called multiple times
		263	from multiple processes.
		264
		265	=cut
		266
		267	sub join {
		268	my $self = shift;
		269	unless ($self->{status}) {
		270	push @{$self->{join}}, $current;
		271	&schedule;
		272	}
		273	wantarray ? @{$self->{status}} : $self->{status}[0];
		274	}
		275
		276	=item $oldprio = $process->prio($newprio)
		277
		278	Sets (or gets, if the argument is missing) the priority of the
		279	process. Higher priority processes get run before lower priority
		280	processes. Priorities are small signed integers (currently -4 .. +3),
		281	that you can refer to using PRIO_xxx constants (use the import tag :prio
		282	to get then):
		283
		284	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
		285	3 > 1 > 0 > -1 > -3 > -4
		286
		287	# set priority to HIGH
		288	current->prio(PRIO_HIGH);
		289
		290	The idle coroutine ($Coro::idle) always has a lower priority than any
		291	existing coroutine.
		292
		293	Changing the priority of the current process will take effect immediately,
		294	but changing the priority of processes in the ready queue (but not
		295	running) will only take effect after the next schedule (of that
		296	process). This is a bug that will be fixed in some future version.
		297
		298	=cut
		299
		300	sub prio {
		301	my $old = $_[0]{prio};
		302	$_[0]{prio} = $_[1] if @_ > 1;
		303	$old;
		304	}
		305
		306	=item $newprio = $process->nice($change)
		307
		308	Similar to C<prio>, but subtract the given value from the priority (i.e.
		309	higher values mean lower priority, just as in unix).
		310
		311	=cut
		312
		313	sub nice {
		314	$_[0]{prio} -= $_[1];
		315	}
		316
		317	=item $olddesc = $process->desc($newdesc)
		318
		319	Sets (or gets in case the argument is missing) the description for this
		320	process. This is just a free-form string you can associate with a process.
		321
		322	=cut
		323
		324	sub desc {
		325	my $old = $_[0]{desc};
		326	$_[0]{desc} = $_[1] if @_ > 1;
		327	$old;
195	}	328	}
196		329
197	=back	330	=back
198		331
199	=cut	332	=cut
200		333
201	1;	334	1;
202		335
		336	=head1 BUGS/LIMITATIONS
		337
		338	- you must make very sure that no coro is still active on global
		339	destruction. very bad things might happen otherwise (usually segfaults).
		340
		341	- this module is not thread-safe. You should only ever use this module
		342	from the same thread (this requirement might be losened in the future
		343	to allow per-thread schedulers, but Coro::State does not yet allow
		344	this).
		345
203	=head1 SEE ALSO	346	=head1 SEE ALSO
204		347
205	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	348	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
206	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>.	349
		350	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
		351
		352	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
		353
		354	Embedding: L<Coro:MakeMaker>
207		355
208	=head1 AUTHOR	356	=head1 AUTHOR
209		357
210	Marc Lehmann <pcg@goof.com>	358	Marc Lehmann <schmorp@schmorp.de>
211	http://www.goof.com/pcg/marc/	359	http://home.schmorp.de/
212		360
213	=cut	361	=cut
214		362

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.11 by root, Sun Jul 15 03:24:18 2001 UTC vs. Revision 1.72 by root, Mon Dec 12 17:49:07 2005 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.11 by root, Sun Jul 15 03:24:18 2001 UTC vs.
Revision 1.72 by root, Mon Dec 12 17:49:07 2005 UTC