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

Comparing Coro/Coro.pm (file contents):
Revision 1.86 by root, Sat Nov 25 01:14:11 2006 UTC vs.
Revision 1.106 by root, Fri Jan 5 17:44:17 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
		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).
		34
26	In this module, coroutines are defined as "callchain + lexical variables	35	In this module, coroutines are defined as "callchain + lexical variables +
27	+ @_ + $_ + $@ + $^W + C stack), that is, a coroutine has it's own	36	@_ + $_ + $@ + $/ + C stack), that is, a coroutine has its own callchain,
28	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
29	important global variables.	38	variables.
30		39
31	=cut	40	=cut
32		41
33	package Coro;	42	package Coro;
34		43
…		…
41		50
42	our $idle; # idle handler	51	our $idle; # idle handler
43	our $main; # main coroutine	52	our $main; # main coroutine
44	our $current; # current coroutine	53	our $current; # current coroutine
45		54
46	our $VERSION = '2.5';	55	our $VERSION = '3.3';
47		56
48	our @EXPORT = qw(async cede schedule terminate current);	57	our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);
49	our %EXPORT_TAGS = (	58	our %EXPORT_TAGS = (
50	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)],
51	);	60	);
52	our @EXPORT_OK = @{$EXPORT_TAGS{prio}};	61	our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
53		62
54	{	63	{
55	my @async;	64	my @async;
56	my $init;	65	my $init;
57		66
58	# this way of handling attributes simply is NOT scalable ;()	67	# this way of handling attributes simply is NOT scalable ;()
59	sub import {	68	sub import {
60	no strict 'refs';	69	no strict 'refs';
61		70
62	Coro->export_to_level(1, @_);	71	Coro->export_to_level (1, @_);
63		72
64	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};	73	my $old = *{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"}{CODE};
65	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {	74	*{(caller)[0]."::MODIFY_CODE_ATTRIBUTES"} = sub {
66	my ($package, $ref) = (shift, shift);	75	my ($package, $ref) = (shift, shift);
67	my @attrs;	76	my @attrs;
…		…
105	C<Coro::current> function instead.	114	C<Coro::current> function instead.
106		115
107	=cut	116	=cut
108		117
109	# maybe some other module used Coro::Specific before...	118	# maybe some other module used Coro::Specific before...
110	if ($current) {
111	$main->{specific} = $current->{specific};	119	$main->{specific} = $current->{specific}
112	}	120	if $current;
113		121
114	$current = $main;	122	_set_current $main;
115		123
116	sub current() { $current }	124	sub current() { $current }
117		125
118	=item $idle	126	=item $idle
119		127
120	A callback that is called whenever the scheduler finds no ready coroutines	128	A callback that is called whenever the scheduler finds no ready coroutines
121	to run. The default implementation prints "FATAL: deadlock detected" and	129	to run. The default implementation prints "FATAL: deadlock detected" and
122	exits.	130	exits, because the program has no other way to continue.
123		131
124	This hook is overwritten by modules such as C<Coro::Timer> and	132	This hook is overwritten by modules such as C<Coro::Timer> and
125	C<Coro::Event> to wait on an external event that hopefully wakes up some	133	C<Coro::Event> to wait on an external event that hopefully wake up a
126	coroutine.	134	coroutine so the scheduler can run it.
		135
		136	Please note that if your callback recursively invokes perl (e.g. for event
		137	handlers), then it must be prepared to be called recursively.
127		138
128	=cut	139	=cut
129		140
130	$idle = sub {	141	$idle = sub {
131	print STDERR "FATAL: deadlock detected\n";	142	require Carp;
132	exit (51);	143	Carp::croak ("FATAL: deadlock detected");
133	};	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	}
134		157
135	# this coroutine is necessary because a coroutine	158	# this coroutine is necessary because a coroutine
136	# cannot destroy itself.	159	# cannot destroy itself.
137	my @destroy;	160	my @destroy;
		161	my $manager;
		162
138	my $manager; $manager = new Coro sub {	163	$manager = new Coro sub {
139	while () {	164	while () {
140	# by overwriting the state object with the manager we destroy it	165	(shift @destroy)->_cancel
141	# while still being able to schedule this coroutine (in case it has
142	# been readied multiple times. this is harmless since the manager
143	# can be called as many times as neccessary and will always
144	# remove itself from the runqueue
145	while (@destroy) {	166	while @destroy;
146	my $coro = pop @destroy;
147	$coro->{status} \|\|= [];
148	$_->ready for @{delete $coro->{join} \|\| []};
149		167
150	# the next line destroys the coro state, but keeps the
151	# process itself intact (we basically make it a zombie
152	# process that always runs the manager thread, so it's possible
153	# to transfer() to this process).
154	$coro->_clone_state_from ($manager);
155	}
156	&schedule;	168	&schedule;
157	}	169	}
158	};	170	};
159		171
		172	$manager->prio (PRIO_MAX);
		173
160	# static methods. not really.	174	# static methods. not really.
161		175
162	=back	176	=back
163		177
164	=head2 STATIC METHODS	178	=head2 STATIC METHODS
165		179
166	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.
167		181
168	=over 4	182	=over 4
169		183
170	=item async { ... } [@args...]	184	=item async { ... } [@args...]
171		185
172	Create a new asynchronous process and return it's process object	186	Create a new asynchronous coroutine and return it's coroutine object
173	(usually unused). When the sub returns the new process is automatically	187	(usually unused). When the sub returns the new coroutine is automatically
174	terminated.	188	terminated.
		189
		190	Calling C<exit> in a coroutine will not work correctly, so do not do that.
175		191
176	When the coroutine dies, the program will exit, just as in the main	192	When the coroutine dies, the program will exit, just as in the main
177	program.	193	program.
178		194
179	# create a new coroutine that just prints its arguments	195	# create a new coroutine that just prints its arguments
…		…
182	} 1,2,3,4;	198	} 1,2,3,4;
183		199
184	=cut	200	=cut
185		201
186	sub async(&@) {	202	sub async(&@) {
187	my $pid = new Coro @_;	203	my $coro = new Coro @_;
188	$pid->ready;	204	$coro->ready;
189	$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
190	}	258	}
191		259
192	=item schedule	260	=item schedule
193		261
194	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
195	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
196	never be called again.	264	never be called again unless something else (e.g. an event handler) calls
		265	ready.
197		266
198	=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	}
199		285
200	=item cede	286	=item cede
201		287
202	"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
203	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
204	current "timeslice" to other coroutines of the same or higher priority.	290	current "timeslice" to other coroutines of the same or higher priority.
205		291
206	=cut	292	=item Coro::cede_notself
		293
		294	Works like cede, but is not exported by default and will cede to any
		295	coroutine, regardless of priority, once.
207		296
208	=item terminate [arg...]	297	=item terminate [arg...]
209		298
210	Terminates the current process with the given status values (see L<cancel>).	299	Terminates the current coroutine with the given status values (see L<cancel>).
211		300
212	=cut	301	=cut
213		302
214	sub terminate {	303	sub terminate {
215	$current->cancel (@_);	304	$current->cancel (@_);
…		…
217		306
218	=back	307	=back
219		308
220	# dynamic methods	309	# dynamic methods
221		310
222	=head2 PROCESS METHODS	311	=head2 COROUTINE METHODS
223		312
224	These are the methods you can call on process objects.	313	These are the methods you can call on coroutine objects.
225		314
226	=over 4	315	=over 4
227		316
228	=item new Coro \&sub [, @args...]	317	=item new Coro \&sub [, @args...]
229		318
230	Create a new process and return it. When the sub returns the process	319	Create a new coroutine and return it. When the sub returns the coroutine
231	automatically terminates as if C<terminate> with the returned values were	320	automatically terminates as if C<terminate> with the returned values were
232	called. To make the process run you must first put it into the ready queue	321	called. To make the coroutine run you must first put it into the ready queue
233	by calling the ready method.	322	by calling the ready method.
234		323
235	=cut	324	Calling C<exit> in a coroutine will not work correctly, so do not do that.
236		325
		326	=cut
		327
237	sub _new_coro {	328	sub _run_coro {
238	$current->_clear_idle_sp; # (re-)set the idle sp on the following cede
239	_set_cede_self; # ensures that cede cede's us first
240	cede;
241	terminate &{+shift};	329	terminate &{+shift};
242	}	330	}
243		331
244	sub new {	332	sub new {
245	my $class = shift;	333	my $class = shift;
246		334
247	$class->SUPER::new (\&_new_coro, @_)	335	$class->SUPER::new (\&_run_coro, @_)
248	}	336	}
249		337
250	=item $process->ready	338	=item $success = $coroutine->ready
251		339
252	Put the given process into the ready queue.	340	Put the given coroutine into the ready queue (according to it's priority)
		341	and return true. If the coroutine is already in the ready queue, do nothing
		342	and return false.
253		343
254	=cut	344	=item $is_ready = $coroutine->is_ready
255		345
		346	Return wether the coroutine is currently the ready queue or not,
		347
256	=item $process->cancel (arg...)	348	=item $coroutine->cancel (arg...)
257		349
258	Terminates the given process and makes it return the given arguments as	350	Terminates the given coroutine and makes it return the given arguments as
259	status (default: the empty list).	351	status (default: the empty list). Never returns if the coroutine is the
		352	current coroutine.
260		353
261	=cut	354	=cut
262		355
263	sub cancel {	356	sub cancel {
264	my $self = shift;	357	my $self = shift;
265	$self->{status} = [@_];	358	$self->{status} = [@_];
		359
		360	if ($current == $self) {
266	push @destroy, $self;	361	push @destroy, $self;
267	$manager->ready;	362	$manager->ready;
268	&schedule if $current == $self;	363	&schedule while 1;
		364	} else {
		365	$self->_cancel;
		366	}
269	}	367	}
270		368
271	=item $process->join	369	=item $coroutine->join
272		370
273	Wait until the coroutine terminates and return any values given to the	371	Wait until the coroutine terminates and return any values given to the
274	C<terminate> or C<cancel> functions. C<join> can be called multiple times	372	C<terminate> or C<cancel> functions. C<join> can be called multiple times
275	from multiple processes.	373	from multiple coroutine.
276		374
277	=cut	375	=cut
278		376
279	sub join {	377	sub join {
280	my $self = shift;	378	my $self = shift;
		379
281	unless ($self->{status}) {	380	unless ($self->{status}) {
282	push @{$self->{join}}, $current;	381	my $current = $current;
283	&schedule;	382
		383	push @{$self->{destroy_cb}}, sub {
		384	$current->ready;
		385	undef $current;
		386	};
		387
		388	&schedule while $current;
284	}	389	}
		390
285	wantarray ? @{$self->{status}} : $self->{status}[0];	391	wantarray ? @{$self->{status}} : $self->{status}[0];
286	}	392	}
287		393
		394	=item $coroutine->on_destroy (\&cb)
		395
		396	Registers a callback that is called when this coroutine gets destroyed,
		397	but before it is joined. The callback gets passed the terminate arguments,
		398	if any.
		399
		400	=cut
		401
		402	sub on_destroy {
		403	my ($self, $cb) = @_;
		404
		405	push @{ $self->{destroy_cb} }, $cb;
		406	}
		407
288	=item $oldprio = $process->prio ($newprio)	408	=item $oldprio = $coroutine->prio ($newprio)
289		409
290	Sets (or gets, if the argument is missing) the priority of the	410	Sets (or gets, if the argument is missing) the priority of the
291	process. Higher priority processes get run before lower priority	411	coroutine. Higher priority coroutines get run before lower priority
292	processes. Priorities are small signed integers (currently -4 .. +3),	412	coroutines. Priorities are small signed integers (currently -4 .. +3),
293	that you can refer to using PRIO_xxx constants (use the import tag :prio	413	that you can refer to using PRIO_xxx constants (use the import tag :prio
294	to get then):	414	to get then):
295		415
296	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN	416	PRIO_MAX > PRIO_HIGH > PRIO_NORMAL > PRIO_LOW > PRIO_IDLE > PRIO_MIN
297	3 > 1 > 0 > -1 > -3 > -4	417	3 > 1 > 0 > -1 > -3 > -4
…		…
300	current->prio(PRIO_HIGH);	420	current->prio(PRIO_HIGH);
301		421
302	The idle coroutine ($Coro::idle) always has a lower priority than any	422	The idle coroutine ($Coro::idle) always has a lower priority than any
303	existing coroutine.	423	existing coroutine.
304		424
305	Changing the priority of the current process will take effect immediately,	425	Changing the priority of the current coroutine will take effect immediately,
306	but changing the priority of processes in the ready queue (but not	426	but changing the priority of coroutines in the ready queue (but not
307	running) will only take effect after the next schedule (of that	427	running) will only take effect after the next schedule (of that
308	process). This is a bug that will be fixed in some future version.	428	coroutine). This is a bug that will be fixed in some future version.
309		429
310	=item $newprio = $process->nice ($change)	430	=item $newprio = $coroutine->nice ($change)
311		431
312	Similar to C<prio>, but subtract the given value from the priority (i.e.	432	Similar to C<prio>, but subtract the given value from the priority (i.e.
313	higher values mean lower priority, just as in unix).	433	higher values mean lower priority, just as in unix).
314		434
315	=item $olddesc = $process->desc ($newdesc)	435	=item $olddesc = $coroutine->desc ($newdesc)
316		436
317	Sets (or gets in case the argument is missing) the description for this	437	Sets (or gets in case the argument is missing) the description for this
318	process. This is just a free-form string you can associate with a process.	438	coroutine. This is just a free-form string you can associate with a coroutine.
319		439
320	=cut	440	=cut
321		441
322	sub desc {	442	sub desc {
323	my $old = $_[0]{desc};	443	my $old = $_[0]{desc};
…		…
325	$old;	445	$old;
326	}	446	}
327		447
328	=back	448	=back
329		449
		450	=head2 GLOBAL FUNCTIONS
		451
		452	=over 4
		453
		454	=item Coro::nready
		455
		456	Returns the number of coroutines that are currently in the ready state,
		457	i.e. that can be swicthed to. The value C<0> means that the only runnable
		458	coroutine is the currently running one, so C<cede> would have no effect,
		459	and C<schedule> would cause a deadlock unless there is an idle handler
		460	that wakes up some coroutines.
		461
		462	=item my $guard = Coro::guard { ... }
		463
		464	This creates and returns a guard object. Nothing happens until the objetc
		465	gets destroyed, in which case the codeblock given as argument will be
		466	executed. This is useful to free locks or other resources in case of a
		467	runtime error or when the coroutine gets canceled, as in both cases the
		468	guard block will be executed. The guard object supports only one method,
		469	C<< ->cancel >>, which will keep the codeblock from being executed.
		470
		471	Example: set some flag and clear it again when the coroutine gets canceled
		472	or the function returns:
		473
		474	sub do_something {
		475	my $guard = Coro::guard { $busy = 0 };
		476	$busy = 1;
		477
		478	# do something that requires $busy to be true
		479	}
		480
		481	=cut
		482
		483	sub guard(&) {
		484	bless \(my $cb = $_[0]), "Coro::guard"
		485	}
		486
		487	sub Coro::guard::cancel {
		488	${$_[0]} = sub { };
		489	}
		490
		491	sub Coro::guard::DESTROY {
		492	${$_[0]}->();
		493	}
		494
		495
		496	=item unblock_sub { ... }
		497
		498	This utility function takes a BLOCK or code reference and "unblocks" it,
		499	returning the new coderef. This means that the new coderef will return
		500	immediately without blocking, returning nothing, while the original code
		501	ref will be called (with parameters) from within its own coroutine.
		502
		503	The reason this fucntion exists is that many event libraries (such as the
		504	venerable L<Event\|Event> module) are not coroutine-safe (a weaker form
		505	of thread-safety). This means you must not block within event callbacks,
		506	otherwise you might suffer from crashes or worse.
		507
		508	This function allows your callbacks to block by executing them in another
		509	coroutine where it is safe to block. One example where blocking is handy
		510	is when you use the L<Coro::AIO\|Coro::AIO> functions to save results to
		511	disk.
		512
		513	In short: simply use C<unblock_sub { ... }> instead of C<sub { ... }> when
		514	creating event callbacks that want to block.
		515
		516	=cut
		517
		518	our @unblock_queue;
		519
		520	# we create a special coro because we want to cede,
		521	# to reduce pressure on the coro pool (because most callbacks
		522	# return immediately and can be reused) and because we cannot cede
		523	# inside an event callback.
		524	our $unblock_scheduler = async {
		525	while () {
		526	while (my $cb = pop @unblock_queue) {
		527	# this is an inlined copy of async_pool
		528	my $coro = (pop @pool or new Coro \&pool_handler);
		529
		530	$coro->{_invoke} = $cb;
		531	$coro->ready;
		532	cede; # for short-lived callbacks, this reduces pressure on the coro pool
		533	}
		534	schedule; # sleep well
		535	}
		536	};
		537
		538	sub unblock_sub(&) {
		539	my $cb = shift;
		540
		541	sub {
		542	unshift @unblock_queue, [$cb, @_];
		543	$unblock_scheduler->ready;
		544	}
		545	}
		546
		547	=back
		548
330	=cut	549	=cut
331		550
332	1;	551	1;
333		552
334	=head1 BUGS/LIMITATIONS	553	=head1 BUGS/LIMITATIONS

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.86 by root, Sat Nov 25 01:14:11 2006 UTC vs. Revision 1.106 by root, Fri Jan 5 17:44:17 2007 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.86 by root, Sat Nov 25 01:14:11 2006 UTC vs.
Revision 1.106 by root, Fri Jan 5 17:44:17 2007 UTC