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

Comparing Coro/Coro.pm (file contents):
Revision 1.33 by root, Sun Sep 16 00:44:05 2001 UTC vs.
Revision 1.107 by root, Fri Jan 5 18:25:51 2007 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
26	This module is still experimental, see the BUGS section below.	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).
27		34
28	In this module, coroutines are defined as "callchain + lexical variables	35	In this module, coroutines are defined as "callchain + lexical variables +
29	+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own	36	@_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain,
30	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
31	important global variables.	38	variables.
32		39
33	=cut	40	=cut
34		41
35	package Coro;	42	package Coro;
36		43
		44	use strict;
		45	no warnings "uninitialized";
		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.49;	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 async_pool 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	};
		145
		146	sub _cancel {
		147	my ($self) = @_;
		148
		149	# free coroutine data and mark as destructed
		150	$self->_destroy
		151	or return;
		152
		153	# call all destruction callbacks
		154	$_->(@{$self->{status}})
		155	for @{(delete $self->{destroy_cb}) \|\| []};
		156	}
115		157
116	# this coroutine is necessary because a coroutine	158	# this coroutine is necessary because a coroutine
117	# cannot destroy itself.	159	# cannot destroy itself.
118	my @destroy;	160	my @destroy;
		161	my $manager;
		162
119	my $manager = new Coro sub {	163	$manager = new Coro sub {
120	while() {	164	while () {
121	delete ((pop @destroy)->{_coro_state}) while @destroy;	165	(shift @destroy)->_cancel
		166	while @destroy;
		167
122	&schedule;	168	&schedule;
123	}	169	}
124	};	170	};
125		171
		172	$manager->prio (PRIO_MAX);
		173
126	# static methods. not really.	174	# static methods. not really.
127		175
		176	=back
		177
128	=head2 STATIC METHODS	178	=head2 STATIC METHODS
129		179
130	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.
131		181
132	=over 4	182	=over 4
133		183
134	=item async { ... } [@args...]	184	=item async { ... } [@args...]
135		185
136	Create a new asynchronous process and return it's process object	186	Create a new asynchronous coroutine and return it's coroutine object
137	(usually unused). When the sub returns the new process is automatically	187	(usually unused). When the sub returns the new coroutine is automatically
138	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.
139		194
140	# create a new coroutine that just prints its arguments	195	# create a new coroutine that just prints its arguments
141	async {	196	async {
142	print "@_\n";	197	print "@_\n";
143	} 1,2,3,4;	198	} 1,2,3,4;
144		199
145	The coderef you submit MUST NOT be a closure that refers to variables
146	in an outer scope. This does NOT work. Pass arguments into it instead.
147
148	=cut	200	=cut
149		201
150	sub async(&@) {	202	sub async(&@) {
151	my $pid = new Coro @_;	203	my $coro = new Coro @_;
152	$manager->ready; # this ensures that the stack is cloned from the manager
153	$pid->ready;	204	$coro->ready;
154	$pid;	205	$coro
		206	}
		207
		208	=item async_pool { ... } [@args...]
		209
		210	Similar to C<async>, but uses a coroutine pool, so you should not call
		211	terminate or join (although you are allowed to), and you get a coroutine
		212	that might have executed other code already (which can be good or bad :).
		213
		214	Also, the block is executed in an C<eval> context and a warning will be
		215	issued in case of an exception instead of terminating the program, as C<async> does.
		216
		217	The priority will be reset to C<0> after each job, otherwise the coroutine
		218	will be re-used "as-is".
		219
		220	The pool size is limited to 8 idle coroutines (this can be adjusted by
		221	changing $Coro::POOL_SIZE), and there can be as many non-idle coros as
		222	required.
		223
		224	If you are concerned about pooled coroutines growing a lot because a
		225	single C<async_pool> used a lot of stackspace you can e.g. C<async_pool {
		226	terminate }> once per second or so to slowly replenish the pool.
		227
		228	=cut
		229
		230	our $POOL_SIZE = 8;
		231	our @pool;
		232
		233	sub pool_handler {
		234	while () {
		235	my ($cb, @arg) = @{ delete $current->{_invoke} };
		236
		237	eval {
		238	$cb->(@arg);
		239	};
		240	warn $@ if $@;
		241
		242	last if @pool >= $POOL_SIZE;
		243	push @pool, $current;
		244
		245	$current->prio (0);
		246	schedule;
		247	}
		248	}
		249
		250	sub async_pool(&@) {
		251	# this is also inlined into the unlock_scheduler
		252	my $coro = (pop @pool or new Coro \&pool_handler);
		253
		254	$coro->{_invoke} = [@_];
		255	$coro->ready;
		256
		257	$coro
155	}	258	}
156		259
157	=item schedule	260	=item schedule
158		261
159	Calls the scheduler. Please note that the current process will not be put	262	Calls the scheduler. Please note that the current coroutine will not be put
160	into the ready queue, so calling this function usually means you will	263	into the ready queue, so calling this function usually means you will
161	never be called again.	264	never be called again unless something else (e.g. an event handler) calls
		265	ready.
162		266
163	=cut	267	The canonical way to wait on external events is this:
		268
		269	{
		270	# remember current coroutine
		271	my $current = $Coro::current;
		272
		273	# register a hypothetical event handler
		274	on_event_invoke sub {
		275	# wake up sleeping coroutine
		276	$current->ready;
		277	undef $current;
		278	};
		279
		280	# call schedule until event occured.
		281	# in case we are woken up for other reasons
		282	# (current still defined), loop.
		283	Coro::schedule while $current;
		284	}
164		285
165	=item cede	286	=item cede
166		287
167	"Cede" to other processes. This function puts the current process into the	288	"Cede" to other coroutines. This function puts the current coroutine into the
168	ready queue and calls C<schedule>, which has the effect of giving up the	289	ready queue and calls C<schedule>, which has the effect of giving up the
169	current "timeslice" to other coroutines of the same or higher priority.	290	current "timeslice" to other coroutines of the same or higher priority.
170		291
171	=cut	292	Returns true if at least one coroutine switch has happened.
172		293
		294	=item Coro::cede_notself
		295
		296	Works like cede, but is not exported by default and will cede to any
		297	coroutine, regardless of priority, once.
		298
		299	Returns true if at least one coroutine switch has happened.
		300
173	=item terminate	301	=item terminate [arg...]
174		302
175	Terminates the current process.	303	Terminates the current coroutine with the given status values (see L<cancel>).
176
177	Future versions of this function will allow result arguments.
178		304
179	=cut	305	=cut
180		306
181	sub terminate {	307	sub terminate {
182	$current->cancel;	308	$current->cancel (@_);
183	&schedule;
184	die; # NORETURN
185	}	309	}
186		310
187	=back	311	=back
188		312
189	# dynamic methods	313	# dynamic methods
190		314
191	=head2 PROCESS METHODS	315	=head2 COROUTINE METHODS
192		316
193	These are the methods you can call on process objects.	317	These are the methods you can call on coroutine objects.
194		318
195	=over 4	319	=over 4
196		320
197	=item new Coro \&sub [, @args...]	321	=item new Coro \&sub [, @args...]
198		322
199	Create a new process and return it. When the sub returns the process	323	Create a new coroutine and return it. When the sub returns the coroutine
200	automatically terminates. To start the process you must first put it into	324	automatically terminates as if C<terminate> with the returned values were
		325	called. To make the coroutine run you must first put it into the ready queue
201	the ready queue by calling the ready method.	326	by calling the ready method.
202		327
203	The coderef you submit MUST NOT be a closure that refers to variables	328	Calling C<exit> in a coroutine will not work correctly, so do not do that.
204	in an outer scope. This does NOT work. Pass arguments into it instead.
205		329
206	=cut	330	=cut
207		331
208	sub _newcoro {	332	sub _run_coro {
209	terminate &{+shift};	333	terminate &{+shift};
210	}	334	}
211		335
212	sub new {	336	sub new {
213	my $class = shift;	337	my $class = shift;
214	bless {
215	_coro_state => (new Coro::State $_[0] && \&_newcoro, @_),
216	}, $class;
217	}
218		338
219	=item $process->ready	339	$class->SUPER::new (\&_run_coro, @_)
		340	}
220		341
221	Put the current process into the ready queue.	342	=item $success = $coroutine->ready
222		343
223	=cut	344	Put the given coroutine into the ready queue (according to it's priority)
		345	and return true. If the coroutine is already in the ready queue, do nothing
		346	and return false.
224		347
225	=item $process->cancel	348	=item $is_ready = $coroutine->is_ready
226		349
227	Like C<terminate>, but terminates the specified process instead.	350	Return wether the coroutine is currently the ready queue or not,
		351
		352	=item $coroutine->cancel (arg...)
		353
		354	Terminates the given coroutine and makes it return the given arguments as
		355	status (default: the empty list). Never returns if the coroutine is the
		356	current coroutine.
228		357
229	=cut	358	=cut
230		359
231	sub cancel {	360	sub cancel {
		361	my $self = shift;
		362	$self->{status} = [@_];
		363
		364	if ($current == $self) {
232	push @destroy, $_[0];	365	push @destroy, $self;
233	$manager->ready;	366	$manager->ready;
		367	&schedule while 1;
		368	} else {
		369	$self->_cancel;
		370	}
234	}	371	}
235		372
		373	=item $coroutine->join
		374
		375	Wait until the coroutine terminates and return any values given to the
		376	C<terminate> or C<cancel> functions. C<join> can be called multiple times
		377	from multiple coroutine.
		378
		379	=cut
		380
		381	sub join {
		382	my $self = shift;
		383
		384	unless ($self->{status}) {
		385	my $current = $current;
		386
		387	push @{$self->{destroy_cb}}, sub {
		388	$current->ready;
		389	undef $current;
		390	};
		391
		392	&schedule while $current;
		393	}
		394
		395	wantarray ? @{$self->{status}} : $self->{status}[0];
		396	}
		397
		398	=item $coroutine->on_destroy (\&cb)
		399
		400	Registers a callback that is called when this coroutine gets destroyed,
		401	but before it is joined. The callback gets passed the terminate arguments,
		402	if any.
		403
		404	=cut
		405
		406	sub on_destroy {
		407	my ($self, $cb) = @_;
		408
		409	push @{ $self->{destroy_cb} }, $cb;
		410	}
		411
236	=item $oldprio = $process->prio($newprio)	412	=item $oldprio = $coroutine->prio ($newprio)
237		413
238	Sets the priority of the process. Higher priority processes get run before	414	Sets (or gets, if the argument is missing) the priority of the
239	lower priority processes. Priorities are smalled signed integer (currently	415	coroutine. Higher priority coroutines get run before lower priority
		416	coroutines. Priorities are small signed integers (currently -4 .. +3),
240	-4 .. +3), that you can refer to using PRIO_xxx constants (use the import	417	that you can refer to using PRIO_xxx constants (use the import tag :prio
241	tag :prio to get then):	418	to get then):
242		419
243	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN	420	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
244	3 > 1 > 0 > -1 > -3 > -4	421	3 > 1 > 0 > -1 > -3 > -4
245		422
246	# set priority to HIGH	423	# set priority to HIGH
247	current->prio(PRIO_HIGH);	424	current->prio(PRIO_HIGH);
248		425
249	The idle coroutine ($Coro::idle) always has a lower priority than any	426	The idle coroutine ($Coro::idle) always has a lower priority than any
250	existing coroutine.	427	existing coroutine.
251		428
252	Changing the priority of the current process will take effect immediately,	429	Changing the priority of the current coroutine will take effect immediately,
253	but changing the priority of processes in the ready queue (but not	430	but changing the priority of coroutines in the ready queue (but not
254	running) will only take effect after the next schedule (of that	431	running) will only take effect after the next schedule (of that
255	process). This is a bug that will be fixed in some future version.	432	coroutine). This is a bug that will be fixed in some future version.
256		433
257	=cut
258
259	sub prio {
260	my $old = $_[0]{prio};
261	$_[0]{prio} = $_[1] if @_ > 1;
262	$old;
263	}
264
265	=item $newprio = $process->nice($change)	434	=item $newprio = $coroutine->nice ($change)
266		435
267	Similar to C<prio>, but subtract the given value from the priority (i.e.	436	Similar to C<prio>, but subtract the given value from the priority (i.e.
268	higher values mean lower priority, just as in unix).	437	higher values mean lower priority, just as in unix).
269		438
270	=cut	439	=item $olddesc = $coroutine->desc ($newdesc)
271		440
272	sub nice {	441	Sets (or gets in case the argument is missing) the description for this
273	$_[0]{prio} -= $_[1];	442	coroutine. This is just a free-form string you can associate with a coroutine.
		443
		444	=cut
		445
		446	sub desc {
		447	my $old = $_[0]{desc};
		448	$_[0]{desc} = $_[1] if @_ > 1;
		449	$old;
274	}	450	}
275		451
276	=back	452	=back
277		453
		454	=head2 GLOBAL FUNCTIONS
		455
		456	=over 4
		457
		458	=item Coro::nready
		459
		460	Returns the number of coroutines that are currently in the ready state,
		461	i.e. that can be swicthed to. The value C<0> means that the only runnable
		462	coroutine is the currently running one, so C<cede> would have no effect,
		463	and C<schedule> would cause a deadlock unless there is an idle handler
		464	that wakes up some coroutines.
		465
		466	=item my $guard = Coro::guard { ... }
		467
		468	This creates and returns a guard object. Nothing happens until the objetc
		469	gets destroyed, in which case the codeblock given as argument will be
		470	executed. This is useful to free locks or other resources in case of a
		471	runtime error or when the coroutine gets canceled, as in both cases the
		472	guard block will be executed. The guard object supports only one method,
		473	C<< ->cancel >>, which will keep the codeblock from being executed.
		474
		475	Example: set some flag and clear it again when the coroutine gets canceled
		476	or the function returns:
		477
		478	sub do_something {
		479	my $guard = Coro::guard { $busy = 0 };
		480	$busy = 1;
		481
		482	# do something that requires $busy to be true
		483	}
		484
		485	=cut
		486
		487	sub guard(&) {
		488	bless \(my $cb = $_[0]), "Coro::guard"
		489	}
		490
		491	sub Coro::guard::cancel {
		492	${$_[0]} = sub { };
		493	}
		494
		495	sub Coro::guard::DESTROY {
		496	${$_[0]}->();
		497	}
		498
		499
		500	=item unblock_sub { ... }
		501
		502	This utility function takes a BLOCK or code reference and "unblocks" it,
		503	returning the new coderef. This means that the new coderef will return
		504	immediately without blocking, returning nothing, while the original code
		505	ref will be called (with parameters) from within its own coroutine.
		506
		507	The reason this fucntion exists is that many event libraries (such as the
		508	venerable L<Event\|Event> module) are not coroutine-safe (a weaker form
		509	of thread-safety). This means you must not block within event callbacks,
		510	otherwise you might suffer from crashes or worse.
		511
		512	This function allows your callbacks to block by executing them in another
		513	coroutine where it is safe to block. One example where blocking is handy
		514	is when you use the L<Coro::AIO\|Coro::AIO> functions to save results to
		515	disk.
		516
		517	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
		518	creating event callbacks that want to block.
		519
		520	=cut
		521
		522	our @unblock_queue;
		523
		524	# we create a special coro because we want to cede,
		525	# to reduce pressure on the coro pool (because most callbacks
		526	# return immediately and can be reused) and because we cannot cede
		527	# inside an event callback.
		528	our $unblock_scheduler = async {
		529	while () {
		530	while (my $cb = pop @unblock_queue) {
		531	# this is an inlined copy of async_pool
		532	my $coro = (pop @pool or new Coro \&pool_handler);
		533
		534	$coro->{_invoke} = $cb;
		535	$coro->ready;
		536	cede; # for short-lived callbacks, this reduces pressure on the coro pool
		537	}
		538	schedule; # sleep well
		539	}
		540	};
		541
		542	sub unblock_sub(&) {
		543	my $cb = shift;
		544
		545	sub {
		546	unshift @unblock_queue, [$cb, @_];
		547	$unblock_scheduler->ready;
		548	}
		549	}
		550
		551	=back
		552
278	=cut	553	=cut
279		554
280	1;	555	1;
281		556
282	=head1 BUGS/LIMITATIONS	557	=head1 BUGS/LIMITATIONS
283		558
284	- you must make very sure that no coro is still active on global destruction.	559	- you must make very sure that no coro is still active on global
285	very bad things might happen otherwise (usually segfaults).	560	destruction. very bad things might happen otherwise (usually segfaults).
		561
286	- this module is not thread-safe. You must only ever use this module from	562	- this module is not thread-safe. You should only ever use this module
287	the same thread (this requirement might be loosened in the future to	563	from the same thread (this requirement might be losened in the future
288	allow per-thread schedulers, but Coro::State does not yet allow this).	564	to allow per-thread schedulers, but Coro::State does not yet allow
		565	this).
289		566
290	=head1 SEE ALSO	567	=head1 SEE ALSO
291		568
292	L<Coro::Channel>, L<Coro::Cont>, L<Coro::Specific>, L<Coro::Semaphore>,	569	Support/Utility: L<Coro::Cont>, L<Coro::Specific>, L<Coro::State>, L<Coro::Util>.
293	L<Coro::Signal>, L<Coro::State>, L<Coro::Event>, L<Coro::RWLock>,	570
294	L<Coro::Handle>, L<Coro::Socket>.	571	Locking/IPC: L<Coro::Signal>, L<Coro::Channel>, L<Coro::Semaphore>, L<Coro::SemaphoreSet>, L<Coro::RWLock>.
		572
		573	Event/IO: L<Coro::Timer>, L<Coro::Event>, L<Coro::Handle>, L<Coro::Socket>, L<Coro::Select>.
		574
		575	Embedding: L<Coro:MakeMaker>
295		576
296	=head1 AUTHOR	577	=head1 AUTHOR
297		578
298	Marc Lehmann <pcg@goof.com>	579	Marc Lehmann <schmorp@schmorp.de>
299	http://www.goof.com/pcg/marc/	580	http://home.schmorp.de/
300		581
301	=cut	582	=cut
302		583

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.33 by root, Sun Sep 16 00:44:05 2001 UTC vs. Revision 1.107 by root, Fri Jan 5 18:25:51 2007 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.33 by root, Sun Sep 16 00:44:05 2001 UTC vs.
Revision 1.107 by root, Fri Jan 5 18:25:51 2007 UTC