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

Comparing Coro/Coro.pm (file contents):
Revision 1.256 by root, Wed Jun 17 21:38:23 2009 UTC vs.
Revision 1.274 by root, Sat Dec 12 01:30:26 2009 UTC

…		…
40	points in your program, so locking and parallel access are rarely an	40	points in your program, so locking and parallel access are rarely an
41	issue, making thread programming much safer and easier than using other	41	issue, making thread programming much safer and easier than using other
42	thread models.	42	thread models.
43		43
44	Unlike the so-called "Perl threads" (which are not actually real threads	44	Unlike the so-called "Perl threads" (which are not actually real threads
45	but only the windows process emulation ported to unix, and as such act	45	but only the windows process emulation (see section of same name for more
46	as processes), Coro provides a full shared address space, which makes	46	details) ported to unix, and as such act as processes), Coro provides
47	communication between threads very easy. And Coro's threads are fast,	47	a full shared address space, which makes communication between threads
48	too: disabling the Windows process emulation code in your perl and using	48	very easy. And Coro's threads are fast, too: disabling the Windows
49	Coro can easily result in a two to four times speed increase for your	49	process emulation code in your perl and using Coro can easily result in
50	programs. A parallel matrix multiplication benchmark runs over 300 times	50	a two to four times speed increase for your programs. A parallel matrix
51	faster on a single core than perl's pseudo-threads on a quad core using	51	multiplication benchmark runs over 300 times faster on a single core than
52	all four cores.	52	perl's pseudo-threads on a quad core using all four cores.
53		53
54	Coro achieves that by supporting multiple running interpreters that share	54	Coro achieves that by supporting multiple running interpreters that share
55	data, which is especially useful to code pseudo-parallel processes and	55	data, which is especially useful to code pseudo-parallel processes and
56	for event-based programming, such as multiple HTTP-GET requests running	56	for event-based programming, such as multiple HTTP-GET requests running
57	concurrently. See L<Coro::AnyEvent> to learn more on how to integrate Coro	57	concurrently. See L<Coro::AnyEvent> to learn more on how to integrate Coro
…		…
67		67
68	=cut	68	=cut
69		69
70	package Coro;	70	package Coro;
71		71
72	use strict qw(vars subs);	72	use common::sense;
73	no warnings "uninitialized";	73
		74	use Carp ();
74		75
75	use Guard ();	76	use Guard ();
76		77
77	use Coro::State;	78	use Coro::State;
78		79
…		…
80		81
81	our $idle; # idle handler	82	our $idle; # idle handler
82	our $main; # main coro	83	our $main; # main coro
83	our $current; # current coro	84	our $current; # current coro
84		85
85	our $VERSION = 5.132;	86	our $VERSION = 5.21;
86		87
87	our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub);	88	our @EXPORT = qw(async async_pool cede schedule terminate current unblock_sub rouse_cb rouse_wait);
88	our %EXPORT_TAGS = (	89	our %EXPORT_TAGS = (
89	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],	90	prio => [qw(PRIO_MAX PRIO_HIGH PRIO_NORMAL PRIO_LOW PRIO_IDLE PRIO_MIN)],
90	);	91	);
91	our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));	92	our @EXPORT_OK = (@{$EXPORT_TAGS{prio}}, qw(nready));
92		93
…		…
123		124
124	This variable is mainly useful to integrate Coro into event loops. It is	125	This variable is mainly useful to integrate Coro into event loops. It is
125	usually better to rely on L<Coro::AnyEvent> or L<Coro::EV>, as this is	126	usually better to rely on L<Coro::AnyEvent> or L<Coro::EV>, as this is
126	pretty low-level functionality.	127	pretty low-level functionality.
127		128
128	This variable stores either a Coro object or a callback.	129	This variable stores a Coro object that is put into the ready queue when
		130	there are no other ready threads (without invoking any ready hooks).
129		131
130	If it is a callback, the it is called whenever the scheduler finds no	132	The default implementation dies with "FATAL: deadlock detected.", followed
131	ready coros to run. The default implementation prints "FATAL:	133	by a thread listing, because the program has no other way to continue.
132	deadlock detected" and exits, because the program has no other way to
133	continue.
134
135	If it is a coro object, then this object will be readied (without
136	invoking any ready hooks, however) when the scheduler finds no other ready
137	coros to run.
138		134
139	This hook is overwritten by modules such as C<Coro::EV> and	135	This hook is overwritten by modules such as C<Coro::EV> and
140	C<Coro::AnyEvent> to wait on an external event that hopefully wake up a	136	C<Coro::AnyEvent> to wait on an external event that hopefully wake up a
141	coro so the scheduler can run it.	137	coro so the scheduler can run it.
142		138
143	Note that the callback I<must not>, under any circumstances, block
144	the current coro. Normally, this is achieved by having an "idle
145	coro" that calls the event loop and then blocks again, and then
146	readying that coro in the idle handler, or by simply placing the idle
147	coro in this variable.
148
149	See L<Coro::Event> or L<Coro::AnyEvent> for examples of using this	139	See L<Coro::EV> or L<Coro::AnyEvent> for examples of using this technique.
150	technique.
151		140
152	Please note that if your callback recursively invokes perl (e.g. for event
153	handlers), then it must be prepared to be called recursively itself.
154
155	=cut	141	=cut
156		142
157	$idle = sub {	143	$idle = new Coro sub {
158	require Carp;	144	require Coro::Debug;
159	Carp::croak ("FATAL: deadlock detected");	145	die "FATAL: deadlock detected.\n"
		146	. Coro::Debug::ps_listing ();
160	};	147	};
161		148
162	# this coro is necessary because a coro	149	# this coro is necessary because a coro
163	# cannot destroy itself.	150	# cannot destroy itself.
164	our @destroy;	151	our @destroy;
…		…
206	Example: Create a new coro that just prints its arguments.	193	Example: Create a new coro that just prints its arguments.
207		194
208	async {	195	async {
209	print "@_\n";	196	print "@_\n";
210	} 1,2,3,4;	197	} 1,2,3,4;
211
212	=cut
213
214	sub async(&@) {
215	my $coro = new Coro @_;
216	$coro->ready;
217	$coro
218	}
219		198
220	=item async_pool { ... } [@args...]	199	=item async_pool { ... } [@args...]
221		200
222	Similar to C<async>, but uses a coro pool, so you should not call	201	Similar to C<async>, but uses a coro pool, so you should not call
223	terminate or join on it (although you are allowed to), and you get a	202	terminate or join on it (although you are allowed to), and you get a
…		…
280	=item schedule	259	=item schedule
281		260
282	Calls the scheduler. The scheduler will find the next coro that is	261	Calls the scheduler. The scheduler will find the next coro that is
283	to be run from the ready queue and switches to it. The next coro	262	to be run from the ready queue and switches to it. The next coro
284	to be run is simply the one with the highest priority that is longest	263	to be run is simply the one with the highest priority that is longest
285	in its ready queue. If there is no coro ready, it will clal the	264	in its ready queue. If there is no coro ready, it will call the
286	C<$Coro::idle> hook.	265	C<$Coro::idle> hook.
287		266
288	Please note that the current coro will I<not> be put into the ready	267	Please note that the current coro will I<not> be put into the ready
289	queue, so calling this function usually means you will never be called	268	queue, so calling this function usually means you will never be called
290	again unless something else (e.g. an event handler) calls C<< ->ready >>,	269	again unless something else (e.g. an event handler) calls C<< ->ready >>,
…		…
686	venerable L<Event\|Event> module) are not thread-safe (a weaker form	665	venerable L<Event\|Event> module) are not thread-safe (a weaker form
687	of reentrancy). This means you must not block within event callbacks,	666	of reentrancy). This means you must not block within event callbacks,
688	otherwise you might suffer from crashes or worse. The only event library	667	otherwise you might suffer from crashes or worse. The only event library
689	currently known that is safe to use without C<unblock_sub> is L<EV>.	668	currently known that is safe to use without C<unblock_sub> is L<EV>.
690		669
		670	Coro will try to catch you when you block in the event loop
		671	("FATAL:$Coro::IDLE blocked itself"), but this is just best effort and
		672	only works when you do not run your own event loop.
		673
691	This function allows your callbacks to block by executing them in another	674	This function allows your callbacks to block by executing them in another
692	coro where it is safe to block. One example where blocking is handy	675	coro where it is safe to block. One example where blocking is handy
693	is when you use the L<Coro::AIO\|Coro::AIO> functions to save results to	676	is when you use the L<Coro::AIO\|Coro::AIO> functions to save results to
694	disk, for example.	677	disk, for example.
695		678
…		…
736	unshift @unblock_queue, [$cb, @_];	719	unshift @unblock_queue, [$cb, @_];
737	$unblock_scheduler->ready;	720	$unblock_scheduler->ready;
738	}	721	}
739	}	722	}
740		723
741	=item $cb = Coro::rouse_cb	724	=item $cb = rouse_cb
742		725
743	Create and return a "rouse callback". That's a code reference that,	726	Create and return a "rouse callback". That's a code reference that,
744	when called, will remember a copy of its arguments and notify the owner	727	when called, will remember a copy of its arguments and notify the owner
745	coro of the callback.	728	coro of the callback.
746		729
747	See the next function.	730	See the next function.
748		731
749	=item @args = Coro::rouse_wait [$cb]	732	=item @args = rouse_wait [$cb]
750		733
751	Wait for the specified rouse callback (or the last one that was created in	734	Wait for the specified rouse callback (or the last one that was created in
752	this coro).	735	this coro).
753		736
754	As soon as the callback is invoked (or when the callback was invoked	737	As soon as the callback is invoked (or when the callback was invoked
755	before C<rouse_wait>), it will return the arguments originally passed to	738	before C<rouse_wait>), it will return the arguments originally passed to
756	the rouse callback.	739	the rouse callback. In scalar context, that means you get the I<last>
		740	argument, just as if C<rouse_wait> had a C<return ($a1, $a2, $a3...)>
		741	statement at the end.
757		742
758	See the section B<HOW TO WAIT FOR A CALLBACK> for an actual usage example.	743	See the section B<HOW TO WAIT FOR A CALLBACK> for an actual usage example.
759		744
760	=back	745	=back
761		746
…		…
849	the windows process emulation enabled under unix roughly halves perl	834	the windows process emulation enabled under unix roughly halves perl
850	performance, even when not used.	835	performance, even when not used.
851		836
852	=item coro switching is not signal safe	837	=item coro switching is not signal safe
853		838
854	You must not switch to another coro from within a signal handler	839	You must not switch to another coro from within a signal handler (only
855	(only relevant with %SIG - most event libraries provide safe signals).	840	relevant with %SIG - most event libraries provide safe signals), I<unless>
		841	you are sure you are not interrupting a Coro function.
856		842
857	That means you I<MUST NOT> call any function that might "block" the	843	That means you I<MUST NOT> call any function that might "block" the
858	current coro - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or	844	current coro - C<cede>, C<schedule> C<< Coro::Semaphore->down >> or
859	anything that calls those. Everything else, including calling C<ready>,	845	anything that calls those. Everything else, including calling C<ready>,
860	works.	846	works.
861		847
862	=back	848	=back
863		849
864		850
		851	=head1 WINDOWS PROCESS EMULATION
		852
		853	A great many people seem to be confused about ithreads (for example, Chip
		854	Salzenberg called me unintelligent, incapable, stupid and gullible,
		855	while in the same mail making rather confused statements about perl
		856	ithreads (for example, that memory or files would be shared), showing his
		857	lack of understanding of this area - if it is hard to understand for Chip,
		858	it is probably not obvious to everybody).
		859
		860	What follows is an ultra-condensed version of my talk about threads in
		861	scripting languages given onthe perl workshop 2009:
		862
		863	The so-called "ithreads" were originally implemented for two reasons:
		864	first, to (badly) emulate unix processes on native win32 perls, and
		865	secondly, to replace the older, real thread model ("5.005-threads").
		866
		867	It does that by using threads instead of OS processes. The difference
		868	between processes and threads is that threads share memory (and other
		869	state, such as files) between threads within a single process, while
		870	processes do not share anything (at least not semantically). That
		871	means that modifications done by one thread are seen by others, while
		872	modifications by one process are not seen by other processes.
		873
		874	The "ithreads" work exactly like that: when creating a new ithreads
		875	process, all state is copied (memory is copied physically, files and code
		876	is copied logically). Afterwards, it isolates all modifications. On UNIX,
		877	the same behaviour can be achieved by using operating system processes,
		878	except that UNIX typically uses hardware built into the system to do this
		879	efficiently, while the windows process emulation emulates this hardware in
		880	software (rather efficiently, but of course it is still much slower than
		881	dedicated hardware).
		882
		883	As mentioned before, loading code, modifying code, modifying data
		884	structures and so on is only visible in the ithreads process doing the
		885	modification, not in other ithread processes within the same OS process.
		886
		887	This is why "ithreads" do not implement threads for perl at all, only
		888	processes. What makes it so bad is that on non-windows platforms, you can
		889	actually take advantage of custom hardware for this purpose (as evidenced
		890	by the forks module, which gives you the (i-) threads API, just much
		891	faster).
		892
		893	Sharing data is in the i-threads model is done by transfering data
		894	structures between threads using copying semantics, which is very slow -
		895	shared data simply does not exist. Benchmarks using i-threads which are
		896	communication-intensive show extremely bad behaviour with i-threads (in
		897	fact, so bad that Coro, which cannot take direct advantage of multiple
		898	CPUs, is often orders of magnitude faster because it shares data using
		899	real threads, refer to my talk for details).
		900
		901	As summary, i-threads use threads to implement processes, while
		902	the compatible forks module uses processes to emulate, uhm,
		903	processes. I-threads slow down every perl program when enabled, and
		904	outside of windows, serve no (or little) practical purpose, but
		905	disadvantages every single-threaded Perl program.
		906
		907	This is the reason that I try to avoid the name "ithreads", as it is
		908	misleading as it implies that it implements some kind of thread model for
		909	perl, and prefer the name "windows process emulation", which describes the
		910	actual use and behaviour of it much better.
		911
865	=head1 SEE ALSO	912	=head1 SEE ALSO
866		913
867	Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.	914	Event-Loop integration: L<Coro::AnyEvent>, L<Coro::EV>, L<Coro::Event>.
868		915
869	Debugging: L<Coro::Debug>.	916	Debugging: L<Coro::Debug>.

Diff Legend

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

Comparing Coro/Coro.pm (file contents): Revision 1.256 by root, Wed Jun 17 21:38:23 2009 UTC vs. Revision 1.274 by root, Sat Dec 12 01:30:26 2009 UTC

Diff Legend

Comparing Coro/Coro.pm (file contents):
Revision 1.256 by root, Wed Jun 17 21:38:23 2009 UTC vs.
Revision 1.274 by root, Sat Dec 12 01:30:26 2009 UTC