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

Comparing Coro/Coro.pm (file contents):
Revision 1.1 by root, Tue Jul 3 02:53:34 2001 UTC vs.
Revision 1.16 by root, Tue Jul 17 15:42:28 2001 UTC

1	=head1 NAME	1	=head1 NAME
2		2
3	Coro - create an manage coroutines	3	Coro - coroutine process abstraction
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use Coro;	7	use Coro;
8		8
		9	async {
		10	# some asynchronous thread of execution
		11	};
		12
		13	# alternatively create an async process like this:
		14
		15	sub some_func : Coro {
		16	# some more async code
		17	}
		18
		19	yield;
		20
9	=head1 DESCRIPTION	21	=head1 DESCRIPTION
10		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	=cut
		29
		30	package Coro;
		31
		32	use Coro::State;
		33
		34	use base Exporter;
		35
		36	$VERSION = 0.07;
		37
		38	@EXPORT = qw(async yield schedule terminate);
		39	@EXPORT_OK = qw($current);
		40
		41	{
		42	use subs 'async';
		43
		44	my @async;
		45
		46	# this way of handling attributes simply is NOT scalable ;()
		47	sub import {
		48	Coro->export_to_level(1, @_);
		49	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
		50	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
		51	my ($package, $ref) = (shift, shift);
		52	my @attrs;
		53	for (@_) {
		54	if ($_ eq "Coro") {
		55	push @async, $ref;
		56	} else {
		57	push @attrs, @_;
		58	}
		59	}
		60	return $old ? $old->($package, $name, @attrs) : @attrs;
		61	};
		62	}
		63
		64	sub INIT {
		65	async pop @async while @async;
		66	}
		67	}
		68
		69	=item $main
		70
		71	This coroutine represents the main program.
		72
		73	=cut
		74
		75	our $main = new Coro;
		76
		77	=item $current
		78
		79	The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).
		80
		81	=cut
		82
		83	# maybe some other module used Coro::Specific before...
		84	if ($current) {
		85	$main->{specific} = $current->{specific};
		86	}
		87
		88	our $current = $main;
		89
		90	=item $idle
		91
		92	The coroutine to switch to when no other coroutine is running. The default
		93	implementation prints "FATAL: deadlock detected" and exits.
		94
		95	=cut
		96
		97	# should be done using priorities :(
		98	our $idle = new Coro sub {
		99	print STDERR "FATAL: deadlock detected\n";
		100	exit(51);
		101	};
		102
		103	# we really need priorities...
		104	my @ready; # the ready queue. hehe, rather broken ;)
		105
		106	# static methods. not really.
		107
		108	=head2 STATIC METHODS
		109
		110	Static methods are actually functions that operate on the current process only.
		111
11	=over 4	112	=over 4
12		113
13	=cut	114	=item async { ... } [@args...]
14		115
15	package Coro;	116	Create a new asynchronous process and return it's process object
		117	(usually unused). When the sub returns the new process is automatically
		118	terminated.
16		119
17	BEGIN {	120	# create a new coroutine that just prints its arguments
18	$VERSION = 0.01;	121	async {
		122	print "@_\n";
		123	} 1,2,3,4;
19		124
20	require XSLoader;	125	The coderef you submit MUST NOT be a closure that refers to variables
21	XSLoader::load Coro, $VERSION;	126	in an outer scope. This does NOT work. Pass arguments into it instead.
22	}
23		127
24	=item $main
25
26	This coroutine represents the main program.
27
28	=item $current
29
30	The current coroutine (the last coroutine switched to). The initial value is C<$main> (of course).
31
32	=cut	128	=cut
33		129
34	$main = $current = _newprocess {	130	sub async(&@) {
35	# never being called	131	my $pid = new Coro @_;
36	};	132	$pid->ready;
		133	$pid;
		134	}
37		135
38	=item $error, $error_msg, $error_coro	136	=item schedule
39		137
40	This coroutine will be called on fatal errors. C<$error_msg> and	138	Calls the scheduler. Please note that the current process will not be put
41	C<$error_coro> return the error message and the error-causing coroutine,	139	into the ready queue, so calling this function usually means you will
42	respectively.	140	never be called again.
43		141
44	=cut	142	=cut
45		143
46	$error_msg =	144	my $prev;
47	$error_coro = undef;
48		145
49	$error = _newprocess {	146	sub schedule {
50	print STDERR "FATAL: $error_msg, program aborted\n";	147	# should be done using priorities :(
51	exit 250;	148	($prev, $current) = ($current, shift @ready \|\| $idle);
52	};	149	Coro::State::transfer($prev, $current);
		150	}
53		151
54	=item $coro = new $coderef [, @args]	152	=item yield
55		153
56	Create a new coroutine and return it. The first C<resume> call to this	154	Yield to other processes. This function puts the current process into the
57	coroutine will start execution at the given coderef. If it returns it	155	ready queue and calls C<schedule>.
58	should return a coroutine to switch to. If, after returning, the coroutine
59	is C<resume>d again it starts execution again at the givne coderef.
60		156
61	=cut	157	=cut
		158
		159	sub yield {
		160	$current->ready;
		161	&schedule;
		162	}
		163
		164	=item terminate
		165
		166	Terminates the current process.
		167
		168	Future versions of this function will allow result arguments.
		169
		170	=cut
		171
		172	sub terminate {
		173	$current->{_results} = [@_];
		174	&schedule;
		175	}
		176
		177	=back
		178
		179	# dynamic methods
		180
		181	=head2 PROCESS METHODS
		182
		183	These are the methods you can call on process objects.
		184
		185	=over 4
		186
		187	=item new Coro \&sub [, @args...]
		188
		189	Create a new process and return it. When the sub returns the process
		190	automatically terminates. To start the process you must first put it into
		191	the ready queue by calling the ready method.
		192
		193	The coderef you submit MUST NOT be a closure that refers to variables
		194	in an outer scope. This does NOT work. Pass arguments into it instead.
		195
		196	=cut
		197
		198	sub _newcoro {
		199	terminate &{+shift};
		200	}
62		201
63	sub new {	202	sub new {
64	my $class = $_[0];	203	my $class = shift;
65	my $proc = $_[1];	204	bless {
66	bless _newprocess {	205	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
67	do {
68	eval { &$proc->resume };
69	if ($@) {
70	($error_msg, $error_coro) = ($@, $current);
71	$error->resume;
72	}
73	} while ();
74	}, $class;	206	}, $class;
75	}	207	}
76		208
77	=item $coro->resume	209	=item $process->ready
78		210
79	Resume execution at the given coroutine.	211	Put the current process into the ready queue.
80		212
81	=cut	213	=cut
82		214
83	my $prev;	215	sub ready {
84		216	push @ready, $_[0];
85	sub resume {
86	$prev = $current; $current = $_[0];
87	_transfer($prev, $current);
88	}	217	}
		218
		219	=back
		220
		221	=cut
89		222
90	1;	223	1;
91		224
92	=back
93
94	=head1 BUGS	225	=head1 BUGS
95		226
96	This module has not yet been extensively tested.	227	- could be faster, especially when the core would introduce special
		228	support for coroutines (like it does for threads).
		229	- there is still a memleak on coroutine termination that I could not
		230	identify. Could be as small as a single SV.
		231	- this module is not well-tested.
		232
		233	=head1 SEE ALSO
		234
		235	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,
		236	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>.
97		237
98	=head1 AUTHOR	238	=head1 AUTHOR
99		239
100	Marc Lehmann <pcg@goof.com>	240	Marc Lehmann <pcg@goof.com>
101	http://www.goof.com/pcg/marc/	241	http://www.goof.com/pcg/marc/

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.1 by root, Tue Jul 3 02:53:34 2001 UTC vs. Revision 1.16 by root, Tue Jul 17 15:42:28 2001 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.1 by root, Tue Jul 3 02:53:34 2001 UTC vs.
Revision 1.16 by root, Tue Jul 17 15:42:28 2001 UTC