[ViewVC] Diff of: cvs/AnyEvent-Fork/Fork.pm

Comparing AnyEvent-Fork/Fork.pm (file contents):
Revision 1.17 by root, Fri Apr 5 23:42:24 2013 UTC vs.
Revision 1.63 by root, Wed Nov 26 13:36:18 2014 UTC

…		…
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	use AnyEvent::Fork;	7	use AnyEvent::Fork;
8		8
9	##################################################################	9	AnyEvent::Fork
		10	->new
		11	->require ("MyModule")
		12	->run ("MyModule::server", my $cv = AE::cv);
		13
		14	my $fh = $cv->recv;
		15
		16	=head1 DESCRIPTION
		17
		18	This module allows you to create new processes, without actually forking
		19	them from your current process (avoiding the problems of forking), but
		20	preserving most of the advantages of fork.
		21
		22	It can be used to create new worker processes or new independent
		23	subprocesses for short- and long-running jobs, process pools (e.g. for use
		24	in pre-forked servers) but also to spawn new external processes (such as
		25	CGI scripts from a web server), which can be faster (and more well behaved)
		26	than using fork+exec in big processes.
		27
		28	Special care has been taken to make this module useful from other modules,
		29	while still supporting specialised environments such as L<App::Staticperl>
		30	or L<PAR::Packer>.
		31
		32	=head2 WHAT THIS MODULE IS NOT
		33
		34	This module only creates processes and lets you pass file handles and
		35	strings to it, and run perl code. It does not implement any kind of RPC -
		36	there is no back channel from the process back to you, and there is no RPC
		37	or message passing going on.
		38
		39	If you need some form of RPC, you could use the L<AnyEvent::Fork::RPC>
		40	companion module, which adds simple RPC/job queueing to a process created
		41	by this module.
		42
		43	And if you need some automatic process pool management on top of
		44	L<AnyEvent::Fork::RPC>, you can look at the L<AnyEvent::Fork::Pool>
		45	companion module.
		46
		47	Or you can implement it yourself in whatever way you like: use some
		48	message-passing module such as L<AnyEvent::MP>, some pipe such as
		49	L<AnyEvent::ZeroMQ>, use L<AnyEvent::Handle> on both sides to send
		50	e.g. JSON or Storable messages, and so on.
		51
		52	=head2 COMPARISON TO OTHER MODULES
		53
		54	There is an abundance of modules on CPAN that do "something fork", such as
		55	L<Parallel::ForkManager>, L<AnyEvent::ForkManager>, L<AnyEvent::Worker>
		56	or L<AnyEvent::Subprocess>. There are modules that implement their own
		57	process management, such as L<AnyEvent::DBI>.
		58
		59	The problems that all these modules try to solve are real, however, none
		60	of them (from what I have seen) tackle the very real problems of unwanted
		61	memory sharing, efficiency or not being able to use event processing, GUI
		62	toolkits or similar modules in the processes they create.
		63
		64	This module doesn't try to replace any of them - instead it tries to solve
		65	the problem of creating processes with a minimum of fuss and overhead (and
		66	also luxury). Ideally, most of these would use AnyEvent::Fork internally,
		67	except they were written before AnyEvent:Fork was available, so obviously
		68	had to roll their own.
		69
		70	=head2 PROBLEM STATEMENT
		71
		72	There are two traditional ways to implement parallel processing on UNIX
		73	like operating systems - fork and process, and fork+exec and process. They
		74	have different advantages and disadvantages that I describe below,
		75	together with how this module tries to mitigate the disadvantages.
		76
		77	=over 4
		78
		79	=item Forking from a big process can be very slow.
		80
		81	A 5GB process needs 0.05s to fork on my 3.6GHz amd64 GNU/Linux box. This
		82	overhead is often shared with exec (because you have to fork first), but
		83	in some circumstances (e.g. when vfork is used), fork+exec can be much
		84	faster.
		85
		86	This module can help here by telling a small(er) helper process to fork,
		87	which is faster then forking the main process, and also uses vfork where
		88	possible. This gives the speed of vfork, with the flexibility of fork.
		89
		90	=item Forking usually creates a copy-on-write copy of the parent
		91	process.
		92
		93	For example, modules or data files that are loaded will not use additional
		94	memory after a fork. Exec'ing a new process, in contrast, means modules
		95	and data files might need to be loaded again, at extra CPU and memory
		96	cost.
		97
		98	But when forking, you still create a copy of your data structures - if
		99	the program frees them and replaces them by new data, the child processes
		100	will retain the old version even if it isn't used, which can suddenly and
		101	unexpectedly increase memory usage when freeing memory.
		102
		103	For example, L<Gtk2::CV> is an image viewer optimised for large
		104	directories (millions of pictures). It also forks subprocesses for
		105	thumbnail generation, which inherit the data structure that stores all
		106	file information. If the user changes the directory, it gets freed in
		107	the main process, leaving a copy in the thumbnailer processes. This can
		108	lead to many times the memory usage that would actually be required. The
		109	solution is to fork early (and being unable to dynamically generate more
		110	subprocesses or do this from a module)... or to use L<AnyEvent:Fork>.
		111
		112	There is a trade-off between more sharing with fork (which can be good or
		113	bad), and no sharing with exec.
		114
		115	This module allows the main program to do a controlled fork, and allows
		116	modules to exec processes safely at any time. When creating a custom
		117	process pool you can take advantage of data sharing via fork without
		118	risking to share large dynamic data structures that will blow up child
		119	memory usage.
		120
		121	In other words, this module puts you into control over what is being
		122	shared and what isn't, at all times.
		123
		124	=item Exec'ing a new perl process might be difficult.
		125
		126	For example, it is not easy to find the correct path to the perl
		127	interpreter - C<$^X> might not be a perl interpreter at all. Worse, there
		128	might not even be a perl binary installed on the system.
		129
		130	This module tries hard to identify the correct path to the perl
		131	interpreter. With a cooperative main program, exec'ing the interpreter
		132	might not even be necessary, but even without help from the main program,
		133	it will still work when used from a module.
		134
		135	=item Exec'ing a new perl process might be slow, as all necessary modules
		136	have to be loaded from disk again, with no guarantees of success.
		137
		138	Long running processes might run into problems when perl is upgraded
		139	and modules are no longer loadable because they refer to a different
		140	perl version, or parts of a distribution are newer than the ones already
		141	loaded.
		142
		143	This module supports creating pre-initialised perl processes to be used as
		144	a template for new processes at a later time, e.g. for use in a process
		145	pool.
		146
		147	=item Forking might be impossible when a program is running.
		148
		149	For example, POSIX makes it almost impossible to fork from a
		150	multi-threaded program while doing anything useful in the child - in
		151	fact, if your perl program uses POSIX threads (even indirectly via
		152	e.g. L<IO::AIO> or L<threads>), you cannot call fork on the perl level
		153	anymore without risking memory corruption or worse on a number of
		154	operating systems.
		155
		156	This module can safely fork helper processes at any time, by calling
		157	fork+exec in C, in a POSIX-compatible way (via L<Proc::FastSpawn>).
		158
		159	=item Parallel processing with fork might be inconvenient or difficult
		160	to implement. Modules might not work in both parent and child.
		161
		162	For example, when a program uses an event loop and creates watchers it
		163	becomes very hard to use the event loop from a child program, as the
		164	watchers already exist but are only meaningful in the parent. Worse, a
		165	module might want to use such a module, not knowing whether another module
		166	or the main program also does, leading to problems.
		167
		168	Apart from event loops, graphical toolkits also commonly fall into the
		169	"unsafe module" category, or just about anything that communicates with
		170	the external world, such as network libraries and file I/O modules, which
		171	usually don't like being copied and then allowed to continue in two
		172	processes.
		173
		174	With this module only the main program is allowed to create new processes
		175	by forking (because only the main program can know when it is still safe
		176	to do so) - all other processes are created via fork+exec, which makes it
		177	possible to use modules such as event loops or window interfaces safely.
		178
		179	=back
		180
		181	=head1 EXAMPLES
		182
10	# create a single new process, tell it to run your worker function	183	=head2 Create a single new process, tell it to run your worker function.
11		184
12	AnyEvent::Fork	185	AnyEvent::Fork
13	->new	186	->new
14	->require ("MyModule")	187	->require ("MyModule")
15	->run ("MyModule::worker, sub {	188	->run ("MyModule::worker, sub {
…		…
17		190
18	# now $master_filehandle is connected to the	191	# now $master_filehandle is connected to the
19	# $slave_filehandle in the new process.	192	# $slave_filehandle in the new process.
20	});	193	});
21		194
22	# MyModule::worker might look like this	195	C<MyModule> might look like this:
		196
		197	package MyModule;
		198
23	sub MyModule::worker {	199	sub worker {
24	my ($slave_filehandle) = @_;	200	my ($slave_filehandle) = @_;
25		201
26	# now $slave_filehandle is connected to the $master_filehandle	202	# now $slave_filehandle is connected to the $master_filehandle
27	# in the original prorcess. have fun!	203	# in the original prorcess. have fun!
28	}	204	}
29		205
30	##################################################################
31	# create a pool of server processes all accepting on the same socket	206	=head2 Create a pool of server processes all accepting on the same socket.
32		207
33	# create listener socket	208	# create listener socket
34	my $listener = ...;	209	my $listener = ...;
35		210
36	# create a pool template, initialise it and give it the socket	211	# create a pool template, initialise it and give it the socket
…		…
48	}	223	}
49		224
50	# now do other things - maybe use the filehandle provided by run	225	# now do other things - maybe use the filehandle provided by run
51	# to wait for the processes to die. or whatever.	226	# to wait for the processes to die. or whatever.
52		227
53	# My::Server::run might look like this	228	C<My::Server> might look like this:
54	sub My::Server::run {	229
		230	package My::Server;
		231
		232	sub run {
55	my ($slave, $listener, $id) = @_;	233	my ($slave, $listener, $id) = @_;
56		234
57	close $slave; # we do not use the socket, so close it to save resources	235	close $slave; # we do not use the socket, so close it to save resources
58		236
59	# we could go ballistic and use e.g. AnyEvent here, or IO::AIO,	237	# we could go ballistic and use e.g. AnyEvent here, or IO::AIO,
…		…
61	while (my $socket = $listener->accept) {	239	while (my $socket = $listener->accept) {
62	# do sth. with new socket	240	# do sth. with new socket
63	}	241	}
64	}	242	}
65		243
66	=head1 DESCRIPTION	244	=head2 use AnyEvent::Fork as a faster fork+exec
67		245
68	This module allows you to create new processes, without actually forking	246	This runs C</bin/echo hi>, with standard output redirected to F</tmp/log>
69	them from your current process (avoiding the problems of forking), but	247	and standard error redirected to the communications socket. It is usually
70	preserving most of the advantages of fork.	248	faster than fork+exec, but still lets you prepare the environment.
71		249
72	It can be used to create new worker processes or new independent	250	open my $output, ">/tmp/log" or die "$!";
73	subprocesses for short- and long-running jobs, process pools (e.g. for use
74	in pre-forked servers) but also to spawn new external processes (such as
75	CGI scripts from a web server), which can be faster (and more well behaved)
76	than using fork+exec in big processes.
77		251
78	Special care has been taken to make this module useful from other modules,	252	AnyEvent::Fork
79	while still supporting specialised environments such as L<App::Staticperl>	253	->new
80	or L<PAR::Packer>.	254	->eval ('
		255	# compile a helper function for later use
		256	sub run {
		257	my ($fh, $output, @cmd) = @_;
81		258
82	=head1 WHAT THIS MODULE IS NOT	259	# perl will clear close-on-exec on STDOUT/STDERR
		260	open STDOUT, ">&", $output or die;
		261	open STDERR, ">&", $fh or die;
83		262
84	This module only creates processes and lets you pass file handles and	263	exec @cmd;
85	strings to it, and run perl code. It does not implement any kind of RPC -	264	}
86	there is no back channel from the process back to you, and there is no RPC	265	')
87	or message passing going on.	266	->send_fh ($output)
		267	->send_arg ("/bin/echo", "hi")
		268	->run ("run", my $cv = AE::cv);
88		269
89	If you need some form of RPC, you can either implement it yourself	270	my $stderr = $cv->recv;
90	in whatever way you like, use some message-passing module such
91	as L<AnyEvent::MP>, some pipe such as L<AnyEvent::ZeroMQ>, use
92	L<AnyEvent::Handle> on both sides to send e.g. JSON or Storable messages,
93	and so on.
94		271
95	=head1 PROBLEM STATEMENT	272	=head2 For stingy users: put the worker code into a C<DATA> section.
96		273
97	There are two ways to implement parallel processing on UNIX like operating	274	When you want to be stingy with files, you can put your code into the
98	systems - fork and process, and fork+exec and process. They have different	275	C<DATA> section of your module (or program):
99	advantages and disadvantages that I describe below, together with how this
100	module tries to mitigate the disadvantages.
101		276
102	=over 4	277	use AnyEvent::Fork;
103		278
104	=item Forking from a big process can be very slow (a 5GB process needs	279	AnyEvent::Fork
105	0.05s to fork on my 3.6GHz amd64 GNU/Linux box for example). This overhead	280	->new
106	is often shared with exec (because you have to fork first), but in some	281	->eval (do { local $/; <DATA> })
107	circumstances (e.g. when vfork is used), fork+exec can be much faster.	282	->run ("doit", sub { ... });
108		283
109	This module can help here by telling a small(er) helper process to fork,	284	__DATA__
110	or fork+exec instead.
111		285
112	=item Forking usually creates a copy-on-write copy of the parent	286	sub doit {
113	process. Memory (for example, modules or data files that have been	287	... do something!
114	will not take additional memory). When exec'ing a new process, modules	288	}
115	and data files might need to be loaded again, at extra CPU and memory
116	cost. Likewise when forking, all data structures are copied as well - if
117	the program frees them and replaces them by new data, the child processes
118	will retain the memory even if it isn't used.
119		289
120	This module allows the main program to do a controlled fork, and allows	290	=head2 For stingy standalone programs: do not rely on external files at
121	modules to exec processes safely at any time. When creating a custom	291	all.
122	process pool you can take advantage of data sharing via fork without
123	risking to share large dynamic data structures that will blow up child
124	memory usage.
125		292
126	=item Exec'ing a new perl process might be difficult and slow. For	293	For single-file scripts it can be inconvenient to rely on external
127	example, it is not easy to find the correct path to the perl interpreter,	294	files - even when using a C<DATA> section, you still need to C<exec> an
128	and all modules have to be loaded from disk again. Long running processes	295	external perl interpreter, which might not be available when using
129	might run into problems when perl is upgraded for example.	296	L<App::Staticperl>, L<Urlader> or L<PAR::Packer> for example.
130		297
131	This module supports creating pre-initialised perl processes to be used	298	Two modules help here - L<AnyEvent::Fork::Early> forks a template process
132	as template, and also tries hard to identify the correct path to the perl	299	for all further calls to C<new_exec>, and L<AnyEvent::Fork::Template>
133	interpreter. With a cooperative main program, exec'ing the interpreter	300	forks the main program as a template process.
134	might not even be necessary.
135		301
136	=item Forking might be impossible when a program is running. For example,	302	Here is how your main program should look like:
137	POSIX makes it almost impossible to fork from a multi-threaded program and
138	do anything useful in the child - strictly speaking, if your perl program
139	uses posix threads (even indirectly via e.g. L<IO::AIO> or L<threads>),
140	you cannot call fork on the perl level anymore, at all.
141		303
142	This module can safely fork helper processes at any time, by calling	304	#! perl
143	fork+exec in C, in a POSIX-compatible way.
144		305
145	=item Parallel processing with fork might be inconvenient or difficult	306	# optional, as the very first thing.
146	to implement. For example, when a program uses an event loop and creates	307	# in case modules want to create their own processes.
147	watchers it becomes very hard to use the event loop from a child	308	use AnyEvent::Fork::Early;
148	program, as the watchers already exist but are only meaningful in the
149	parent. Worse, a module might want to use such a system, not knowing
150	whether another module or the main program also does, leading to problems.
151		309
152	This module only lets the main program create pools by forking (because	310	# next, load all modules you need in your template process
153	only the main program can know when it is still safe to do so) - all other	311	use Example::My::Module
154	pools are created by fork+exec, after which such modules can again be	312	use Example::Whatever;
155	loaded.
156		313
157	=back	314	# next, put your run function definition and anything else you
		315	# need, but do not use code outside of BEGIN blocks.
		316	sub worker_run {
		317	my ($fh, @args) = @_;
		318	...
		319	}
		320
		321	# now preserve everything so far as AnyEvent::Fork object
		322	# in $TEMPLATE.
		323	use AnyEvent::Fork::Template;
		324
		325	# do not put code outside of BEGIN blocks until here
		326
		327	# now use the $TEMPLATE process in any way you like
		328
		329	# for example: create 10 worker processes
		330	my @worker;
		331	my $cv = AE::cv;
		332	for (1..10) {
		333	$cv->begin;
		334	$TEMPLATE->fork->send_arg ($_)->run ("worker_run", sub {
		335	push @worker, shift;
		336	$cv->end;
		337	});
		338	}
		339	$cv->recv;
158		340
159	=head1 CONCEPTS	341	=head1 CONCEPTS
160		342
161	This module can create new processes either by executing a new perl	343	This module can create new processes either by executing a new perl
162	process, or by forking from an existing "template" process.	344	process, or by forking from an existing "template" process.
		345
		346	All these processes are called "child processes" (whether they are direct
		347	children or not), while the process that manages them is called the
		348	"parent process".
163		349
164	Each such process comes with its own file handle that can be used to	350	Each such process comes with its own file handle that can be used to
165	communicate with it (it's actually a socket - one end in the new process,	351	communicate with it (it's actually a socket - one end in the new process,
166	one end in the main process), and among the things you can do in it are	352	one end in the main process), and among the things you can do in it are
167	load modules, fork new processes, send file handles to it, and execute	353	load modules, fork new processes, send file handles to it, and execute
…		…
241	my ($fork_fh) = @_;	427	my ($fork_fh) = @_;
242	});	428	});
243		429
244	=back	430	=back
245		431
246	=head1 FUNCTIONS	432	=head1 THE C<AnyEvent::Fork> CLASS
		433
		434	This module exports nothing, and only implements a single class -
		435	C<AnyEvent::Fork>.
		436
		437	There are two class constructors that both create new processes - C<new>
		438	and C<new_exec>. The C<fork> method creates a new process by forking an
		439	existing one and could be considered a third constructor.
		440
		441	Most of the remaining methods deal with preparing the new process, by
		442	loading code, evaluating code and sending data to the new process. They
		443	usually return the process object, so you can chain method calls.
		444
		445	If a process object is destroyed before calling its C<run> method, then
		446	the process simply exits. After C<run> is called, all responsibility is
		447	passed to the specified function.
		448
		449	As long as there is any outstanding work to be done, process objects
		450	resist being destroyed, so there is no reason to store them unless you
		451	need them later - configure and forget works just fine.
247		452
248	=over 4	453	=over 4
249		454
250	=cut	455	=cut
251		456
252	package AnyEvent::Fork;	457	package AnyEvent::Fork;
253		458
254	use common::sense;	459	use common::sense;
255		460
256	use Socket ();	461	use Errno ();
257		462
258	use AnyEvent;	463	use AnyEvent;
259	use AnyEvent::Util ();	464	use AnyEvent::Util ();
260		465
261	use IO::FDPass;	466	use IO::FDPass;
262		467
263	our $VERSION = 0.2;	468	our $VERSION = 1.2;
264
265	our $PERL; # the path to the perl interpreter, deduces with various forms of magic
266
267	=item my $pool = new AnyEvent::Fork key => value...
268
269	Create a new process pool. The following named parameters are supported:
270
271	=over 4
272
273	=back
274
275	=cut
276		469
277	# the early fork template process	470	# the early fork template process
278	our $EARLY;	471	our $EARLY;
279		472
280	# the empty template process	473	# the empty template process
281	our $TEMPLATE;	474	our $TEMPLATE;
282		475
		476	sub QUEUE() { 0 }
		477	sub FH() { 1 }
		478	sub WW() { 2 }
		479	sub PID() { 3 }
		480	sub CB() { 4 }
		481
		482	sub _new {
		483	my ($self, $fh, $pid) = @_;
		484
		485	AnyEvent::Util::fh_nonblocking $fh, 1;
		486
		487	$self = bless [
		488	[], # write queue - strings or fd's
		489	$fh,
		490	undef, # AE watcher
		491	$pid,
		492	], $self;
		493
		494	$self
		495	}
		496
283	sub _cmd {	497	sub _cmd {
284	my $self = shift;	498	my $self = shift;
285		499
286	#TODO: maybe append the packet to any existing string command already in the queue
287
288	# ideally, we would want to use "a (w/a)*" as format string, but perl versions	500	# ideally, we would want to use "a (w/a)*" as format string, but perl
289	# from at least 5.8.9 to 5.16.3 are all buggy and can't unpack it.	501	# versions from at least 5.8.9 to 5.16.3 are all buggy and can't unpack
290	push @{ $self->[2] }, pack "L/a", pack "(w/a)*", @_;	502	# it.
		503	push @{ $self->[QUEUE] }, pack "a L/a*", $_[0], $_[1];
291		504
292	$self->[3] \|\|= AE::io $self->[1], 1, sub {	505	$self->[WW] \|\|= AE::io $self->[FH], 1, sub {
		506	do {
293	# send the next "thing" in the queue - either a reference to an fh,	507	# send the next "thing" in the queue - either a reference to an fh,
294	# or a plain string.	508	# or a plain string.
295		509
296	if (ref $self->[2][0]) {	510	if (ref $self->[QUEUE][0]) {
297	# send fh	511	# send fh
298	IO::FDPass::send fileno $self->[1], fileno ${ $self->[2][0] }	512	unless (IO::FDPass::send fileno $self->[FH], fileno ${ $self->[QUEUE][0] }) {
		513	return if $! == Errno::EAGAIN \|\| $! == Errno::EWOULDBLOCK;
		514	undef $self->[WW];
		515	die "AnyEvent::Fork: file descriptor send failure: $!";
		516	}
		517
299	and shift @{ $self->[2] };	518	shift @{ $self->[QUEUE] };
300		519
301	} else {	520	} else {
302	# send string	521	# send string
303	my $len = syswrite $self->[1], $self->[2][0]	522	my $len = syswrite $self->[FH], $self->[QUEUE][0];
		523
		524	unless ($len) {
		525	return if $! == Errno::EAGAIN \|\| $! == Errno::EWOULDBLOCK;
		526	undef $self->[WW];
304	or do { undef $self->[3]; die "AnyEvent::Fork: command write failure: $!" };	527	die "AnyEvent::Fork: command write failure: $!";
		528	}
305		529
306	substr $self->[2][0], 0, $len, "";	530	substr $self->[QUEUE][0], 0, $len, "";
307	shift @{ $self->[2] } unless length $self->[2][0];	531	shift @{ $self->[QUEUE] } unless length $self->[QUEUE][0];
308	}	532	}
		533	} while @{ $self->[QUEUE] };
309		534
310	unless (@{ $self->[2] }) {	535	# everything written
311	undef $self->[3];	536	undef $self->[WW];
		537
312	# invoke run callback	538	# invoke run callback, if any
		539	if ($self->[CB]) {
313	$self->[0]->($self->[1]) if $self->[0];	540	$self->[CB]->($self->[FH]);
		541	@$self = ();
314	}	542	}
315	};	543	};
316		544
317	() # make sure we don't leak the watcher	545	() # make sure we don't leak the watcher
318	}
319
320	sub _new {
321	my ($self, $fh) = @_;
322
323	AnyEvent::Util::fh_nonblocking $fh, 1;
324
325	$self = bless [
326	undef, # run callback
327	$fh,
328	[], # write queue - strings or fd's
329	undef, # AE watcher
330	], $self;
331
332	$self
333	}	546	}
334		547
335	# fork template from current process, used by AnyEvent::Fork::Early/Template	548	# fork template from current process, used by AnyEvent::Fork::Early/Template
336	sub _new_fork {	549	sub _new_fork {
337	my ($fh, $slave) = AnyEvent::Util::portable_socketpair;	550	my ($fh, $slave) = AnyEvent::Util::portable_socketpair;
…		…
342	if ($pid eq 0) {	555	if ($pid eq 0) {
343	require AnyEvent::Fork::Serve;	556	require AnyEvent::Fork::Serve;
344	$AnyEvent::Fork::Serve::OWNER = $parent;	557	$AnyEvent::Fork::Serve::OWNER = $parent;
345	close $fh;	558	close $fh;
346	$0 = "$_[1] of $parent";	559	$0 = "$_[1] of $parent";
347	$SIG{CHLD} = 'IGNORE';
348	AnyEvent::Fork::Serve::serve ($slave);	560	AnyEvent::Fork::Serve::serve ($slave);
349	exit 0;	561	exit 0;
350	} elsif (!$pid) {	562	} elsif (!$pid) {
351	die "AnyEvent::Fork::Early/Template: unable to fork template process: $!";	563	die "AnyEvent::Fork::Early/Template: unable to fork template process: $!";
352	}	564	}
353		565
354	AnyEvent::Fork->_new ($fh)	566	AnyEvent::Fork->_new ($fh, $pid)
355	}	567	}
356		568
357	=item my $proc = new AnyEvent::Fork	569	=item my $proc = new AnyEvent::Fork
358		570
359	Create a new "empty" perl interpreter process and returns its process	571	Create a new "empty" perl interpreter process and returns its process
360	object for further manipulation.	572	object for further manipulation.
361		573
362	The new process is forked from a template process that is kept around	574	The new process is forked from a template process that is kept around
363	for this purpose. When it doesn't exist yet, it is created by a call to	575	for this purpose. When it doesn't exist yet, it is created by a call to
364	C<new_exec> and kept around for future calls.	576	C<new_exec> first and then stays around for future calls.
365
366	When the process object is destroyed, it will release the file handle
367	that connects it with the new process. When the new process has not yet
368	called C<run>, then the process will exit. Otherwise, what happens depends
369	entirely on the code that is executed.
370		577
371	=cut	578	=cut
372		579
373	sub new {	580	sub new {
374	my $class = shift;	581	my $class = shift;
…		…
411		618
412	You should use C<new> whenever possible, except when having a template	619	You should use C<new> whenever possible, except when having a template
413	process around is unacceptable.	620	process around is unacceptable.
414		621
415	The path to the perl interpreter is divined using various methods - first	622	The path to the perl interpreter is divined using various methods - first
416	C<$^X> is investigated to see if the path ends with something that sounds	623	C<$^X> is investigated to see if the path ends with something that looks
417	as if it were the perl interpreter. Failing this, the module falls back to	624	as if it were the perl interpreter. Failing this, the module falls back to
418	using C<$Config::Config{perlpath}>.	625	using C<$Config::Config{perlpath}>.
419		626
		627	The path to perl can also be overriden by setting the global variable
		628	C<$AnyEvent::Fork::PERL> - it's value will be used for all subsequent
		629	invocations.
		630
420	=cut	631	=cut
		632
		633	our $PERL;
421		634
422	sub new_exec {	635	sub new_exec {
423	my ($self) = @_;	636	my ($self) = @_;
424		637
425	return $EARLY->fork	638	return $EARLY->fork
426	if $EARLY;	639	if $EARLY;
427		640
		641	unless (defined $PERL) {
428	# first find path of perl	642	# first find path of perl
429	my $perl = $;	643	my $perl = $^X;
430		644
431	# first we try $^X, but the path must be absolute (always on win32), and end in sth.	645	# first we try $^X, but the path must be absolute (always on win32), and end in sth.
432	# that looks like perl. this obviously only works for posix and win32	646	# that looks like perl. this obviously only works for posix and win32
433	unless (	647	unless (
434	($^O eq "MSWin32" \|\| $perl =~ m%^/%)	648	($^O eq "MSWin32" \|\| $perl =~ m%^/%)
435	&& $perl =~ m%[/\\]perl(?:[0-9]+(\.[0-9]+)+)?(\.exe)?$%i	649	&& $perl =~ m%[/\\]perl(?:[0-9]+(\.[0-9]+)+)?(\.exe)?$%i
436	) {	650	) {
437	# if it doesn't look perlish enough, try Config	651	# if it doesn't look perlish enough, try Config
438	require Config;	652	require Config;
439	$perl = $Config::Config{perlpath};	653	$perl = $Config::Config{perlpath};
440	$perl =~ s/(?:\Q$Config::Config{_exe}\E)?$/$Config::Config{_exe}/;	654	$perl =~ s/(?:\Q$Config::Config{_exe}\E)?$/$Config::Config{_exe}/;
		655	}
		656
		657	$PERL = $perl;
441	}	658	}
442		659
443	require Proc::FastSpawn;	660	require Proc::FastSpawn;
444		661
445	my ($fh, $slave) = AnyEvent::Util::portable_socketpair;	662	my ($fh, $slave) = AnyEvent::Util::portable_socketpair;
…		…
452	# quick. also doesn't work in win32. of course. what did you expect	669	# quick. also doesn't work in win32. of course. what did you expect
453	#local $ENV{PERL5LIB} = join ":", grep !ref, @INC;	670	#local $ENV{PERL5LIB} = join ":", grep !ref, @INC;
454	my %env = %ENV;	671	my %env = %ENV;
455	$env{PERL5LIB} = join +($^O eq "MSWin32" ? ";" : ":"), grep !ref, @INC;	672	$env{PERL5LIB} = join +($^O eq "MSWin32" ? ";" : ":"), grep !ref, @INC;
456		673
457	Proc::FastSpawn::spawn (	674	my $pid = Proc::FastSpawn::spawn (
458	$perl,	675	$PERL,
459	["perl", "-MAnyEvent::Fork::Serve", "-e", "AnyEvent::Fork::Serve::me", fileno $slave, $$],	676	["perl", "-MAnyEvent::Fork::Serve", "-e", "AnyEvent::Fork::Serve::me", fileno $slave, $$],
460	[map "$_=$env{$_}", keys %env],	677	[map "$_=$env{$_}", keys %env],
461	) or die "unable to spawn AnyEvent::Fork server: $!";	678	) or die "unable to spawn AnyEvent::Fork server: $!";
462		679
463	$self->_new ($fh)	680	$self->_new ($fh, $pid)
		681	}
		682
		683	=item $pid = $proc->pid
		684
		685	Returns the process id of the process I<iff it is a direct child of the
		686	process running AnyEvent::Fork>, and C<undef> otherwise. As a general
		687	rule (that you cannot rely upon), processes created via C<new_exec>,
		688	L<AnyEvent::Fork::Early> or L<AnyEvent::Fork::Template> are direct
		689	children, while all other processes are not.
		690
		691	Or in other words, you do not normally have to take care of zombies for
		692	processes created via C<new>, but when in doubt, or zombies are a problem,
		693	you need to check whether a process is a diretc child by calling this
		694	method, and possibly creating a child watcher or reap it manually.
		695
		696	=cut
		697
		698	sub pid {
		699	$_[0][PID]
464	}	700	}
465		701
466	=item $proc = $proc->eval ($perlcode, @args)	702	=item $proc = $proc->eval ($perlcode, @args)
467		703
468	Evaluates the given C<$perlcode> as ... perl code, while setting C<@_> to	704	Evaluates the given C<$perlcode> as ... Perl code, while setting C<@_> to
469	the strings specified by C<@args>.	705	the strings specified by C<@args>, in the "main" package.
470		706
471	This call is meant to do any custom initialisation that might be required	707	This call is meant to do any custom initialisation that might be required
472	(for example, the C<require> method uses it). It's not supposed to be used	708	(for example, the C<require> method uses it). It's not supposed to be used
473	to completely take over the process, use C<run> for that.	709	to completely take over the process, use C<run> for that.
474		710
475	The code will usually be executed after this call returns, and there is no	711	The code will usually be executed after this call returns, and there is no
476	way to pass anything back to the calling process. Any evaluation errors	712	way to pass anything back to the calling process. Any evaluation errors
477	will be reported to stderr and cause the process to exit.	713	will be reported to stderr and cause the process to exit.
478		714
		715	If you want to execute some code (that isn't in a module) to take over the
		716	process, you should compile a function via C<eval> first, and then call
		717	it via C<run>. This also gives you access to any arguments passed via the
		718	C<send_xxx> methods, such as file handles. See the L<use AnyEvent::Fork as
		719	a faster fork+exec> example to see it in action.
		720
479	Returns the process object for easy chaining of method calls.	721	Returns the process object for easy chaining of method calls.
480		722
481	=cut	723	=cut
482		724
483	sub eval {	725	sub eval {
484	my ($self, $code, @args) = @_;	726	my ($self, $code, @args) = @_;
485		727
486	$self->_cmd (e => $code, @args);	728	$self->_cmd (e => pack "(w/a)", $code, @args);
487		729
488	$self	730	$self
489	}	731	}
490		732
491	=item $proc = $proc->require ($module, ...)	733	=item $proc = $proc->require ($module, ...)
…		…
508	=item $proc = $proc->send_fh ($handle, ...)	750	=item $proc = $proc->send_fh ($handle, ...)
509		751
510	Send one or more file handles (I<not> file descriptors) to the process,	752	Send one or more file handles (I<not> file descriptors) to the process,
511	to prepare a call to C<run>.	753	to prepare a call to C<run>.
512		754
513	The process object keeps a reference to the handles until this is done,	755	The process object keeps a reference to the handles until they have
514	so you must not explicitly close the handles. This is most easily	756	been passed over to the process, so you must not explicitly close the
515	accomplished by simply not storing the file handles anywhere after passing	757	handles. This is most easily accomplished by simply not storing the file
516	them to this method.	758	handles anywhere after passing them to this method - when AnyEvent::Fork
		759	is finished using them, perl will automatically close them.
517		760
518	Returns the process object for easy chaining of method calls.	761	Returns the process object for easy chaining of method calls.
519		762
520	Example: pass a file handle to a process, and release it without	763	Example: pass a file handle to a process, and release it without
521	closing. It will be closed automatically when it is no longer used.	764	closing. It will be closed automatically when it is no longer used.
…		…
528	sub send_fh {	771	sub send_fh {
529	my ($self, @fh) = @_;	772	my ($self, @fh) = @_;
530		773
531	for my $fh (@fh) {	774	for my $fh (@fh) {
532	$self->_cmd ("h");	775	$self->_cmd ("h");
533	push @{ $self->[2] }, \$fh;	776	push @{ $self->[QUEUE] }, \$fh;
534	}	777	}
535		778
536	$self	779	$self
537	}	780	}
538		781
539	=item $proc = $proc->send_arg ($string, ...)	782	=item $proc = $proc->send_arg ($string, ...)
540		783
541	Send one or more argument strings to the process, to prepare a call to	784	Send one or more argument strings to the process, to prepare a call to
542	C<run>. The strings can be any octet string.	785	C<run>. The strings can be any octet strings.
		786
		787	The protocol is optimised to pass a moderate number of relatively short
		788	strings - while you can pass up to 4GB of data in one go, this is more
		789	meant to pass some ID information or other startup info, not big chunks of
		790	data.
543		791
544	Returns the process object for easy chaining of method calls.	792	Returns the process object for easy chaining of method calls.
545		793
546	=cut	794	=cut
547		795
548	sub send_arg {	796	sub send_arg {
549	my ($self, @arg) = @_;	797	my ($self, @arg) = @_;
550		798
551	$self->_cmd (a => @arg);	799	$self->_cmd (a => pack "(w/a)", @arg);
552		800
553	$self	801	$self
554	}	802	}
555		803
556	=item $proc->run ($func, $cb->($fh))	804	=item $proc->run ($func, $cb->($fh))
557		805
558	Enter the function specified by the fully qualified name in C<$func> in	806	Enter the function specified by the function name in C<$func> in the
559	the process. The function is called with the communication socket as first	807	process. The function is called with the communication socket as first
560	argument, followed by all file handles and string arguments sent earlier	808	argument, followed by all file handles and string arguments sent earlier
561	via C<send_fh> and C<send_arg> methods, in the order they were called.	809	via C<send_fh> and C<send_arg> methods, in the order they were called.
562		810
563	If the called function returns, the process exits.
564
565	Preparing the process can take time - when the process is ready, the
566	callback is invoked with the local communications socket as argument.
567
568	The process object becomes unusable on return from this function.	811	The process object becomes unusable on return from this function - any
		812	further method calls result in undefined behaviour.
		813
		814	The function name should be fully qualified, but if it isn't, it will be
		815	looked up in the C<main> package.
		816
		817	If the called function returns, doesn't exist, or any error occurs, the
		818	process exits.
		819
		820	Preparing the process is done in the background - when all commands have
		821	been sent, the callback is invoked with the local communications socket
		822	as argument. At this point you can start using the socket in any way you
		823	like.
569		824
570	If the communication socket isn't used, it should be closed on both sides,	825	If the communication socket isn't used, it should be closed on both sides,
571	to save on kernel memory.	826	to save on kernel memory.
572		827
573	The socket is non-blocking in the parent, and blocking in the newly	828	The socket is non-blocking in the parent, and blocking in the newly
574	created process. The close-on-exec flag is set on both. Even if not used	829	created process. The close-on-exec flag is set in both.
		830
575	otherwise, the socket can be a good indicator for the existence of the	831	Even if not used otherwise, the socket can be a good indicator for the
576	process - if the other process exits, you get a readable event on it,	832	existence of the process - if the other process exits, you get a readable
577	because exiting the process closes the socket (if it didn't create any	833	event on it, because exiting the process closes the socket (if it didn't
578	children using fork).	834	create any children using fork).
		835
		836	=over 4
		837
		838	=item Compatibility to L<AnyEvent::Fork::Remote>
		839
		840	If you want to write code that works with both this module and
		841	L<AnyEvent::Fork::Remote>, you need to write your code so that it assumes
		842	there are two file handles for communications, which might not be unix
		843	domain sockets. The C<run> function should start like this:
		844
		845	sub run {
		846	my ($rfh, @args) = @_; # @args is your normal arguments
		847	my $wfh = fileno $rfh ? $rfh : *STDOUT;
		848
		849	# now use $rfh for reading and $wfh for writing
		850	}
		851
		852	This checks whether the passed file handle is, in fact, the process
		853	C<STDIN> handle. If it is, then the function was invoked visa
		854	L<AnyEvent::Fork::Remote>, so STDIN should be used for reading and
		855	C<STDOUT> should be used for writing.
		856
		857	In all other cases, the function was called via this module, and there is
		858	only one file handle that should be sued for reading and writing.
		859
		860	=back
579		861
580	Example: create a template for a process pool, pass a few strings, some	862	Example: create a template for a process pool, pass a few strings, some
581	file handles, then fork, pass one more string, and run some code.	863	file handles, then fork, pass one more string, and run some code.
582		864
583	my $pool = AnyEvent::Fork	865	my $pool = AnyEvent::Fork
…		…
591	->send_arg ("str3")	873	->send_arg ("str3")
592	->run ("Some::function", sub {	874	->run ("Some::function", sub {
593	my ($fh) = @_;	875	my ($fh) = @_;
594		876
595	# fh is nonblocking, but we trust that the OS can accept these	877	# fh is nonblocking, but we trust that the OS can accept these
596	# extra 3 octets anyway.	878	# few octets anyway.
597	syswrite $fh, "hi #$_\n";	879	syswrite $fh, "hi #$_\n";
598		880
599	# $fh is being closed here, as we don't store it anywhere	881	# $fh is being closed here, as we don't store it anywhere
600	});	882	});
601	}	883	}
…		…
603	# Some::function might look like this - all parameters passed before fork	885	# Some::function might look like this - all parameters passed before fork
604	# and after will be passed, in order, after the communications socket.	886	# and after will be passed, in order, after the communications socket.
605	sub Some::function {	887	sub Some::function {
606	my ($fh, $str1, $str2, $fh1, $fh2, $str3) = @_;	888	my ($fh, $str1, $str2, $fh1, $fh2, $str3) = @_;
607		889
608	print scalar <$fh>; # prints "hi 1\n" and "hi 2\n"	890	print scalar <$fh>; # prints "hi #1\n" and "hi #2\n" in any order
609	}	891	}
610		892
611	=cut	893	=cut
612		894
613	sub run {	895	sub run {
614	my ($self, $func, $cb) = @_;	896	my ($self, $func, $cb) = @_;
615		897
616	$self->[0] = $cb;	898	$self->[CB] = $cb;
617	$self->_cmd (r => $func);	899	$self->_cmd (r => $func);
		900	}
		901
		902	=back
		903
		904	=head2 EXPERIMENTAL METHODS
		905
		906	These methods might go away completely or change behaviour, at any time.
		907
		908	=over 4
		909
		910	=item $proc->to_fh ($cb->($fh)) # EXPERIMENTAL, MIGHT BE REMOVED
		911
		912	Flushes all commands out to the process and then calls the callback with
		913	the communications socket.
		914
		915	The process object becomes unusable on return from this function - any
		916	further method calls result in undefined behaviour.
		917
		918	The point of this method is to give you a file handle that you can pass
		919	to another process. In that other process, you can call C<new_from_fh
		920	AnyEvent::Fork $fh> to create a new C<AnyEvent::Fork> object from it,
		921	thereby effectively passing a fork object to another process.
		922
		923	=cut
		924
		925	sub to_fh {
		926	my ($self, $cb) = @_;
		927
		928	$self->[CB] = $cb;
		929
		930	unless ($self->[WW]) {
		931	$self->[CB]->($self->[FH]);
		932	@$self = ();
		933	}
		934	}
		935
		936	=item new_from_fh AnyEvent::Fork $fh # EXPERIMENTAL, MIGHT BE REMOVED
		937
		938	Takes a file handle originally rceeived by the C<to_fh> method and creates
		939	a new C<AnyEvent:Fork> object. The child process itself will not change in
		940	any way, i.e. it will keep all the modifications done to it before calling
		941	C<to_fh>.
		942
		943	The new object is very much like the original object, except that the
		944	C<pid> method will return C<undef> even if the process is a direct child.
		945
		946	=cut
		947
		948	sub new_from_fh {
		949	my ($class, $fh) = @_;
		950
		951	$class->_new ($fh)
618	}	952	}
619		953
620	=back	954	=back
621		955
622	=head1 PERFORMANCE	956	=head1 PERFORMANCE
623		957
624	Now for some unscientific benchmark numbers (all done on an amd64	958	Now for some unscientific benchmark numbers (all done on an amd64
625	GNU/Linux box). These are intended to give you an idea of the relative	959	GNU/Linux box). These are intended to give you an idea of the relative
626	performance you can expect.	960	performance you can expect, they are not meant to be absolute performance
		961	numbers.
627		962
628	OK, so, I ran a simple benchmark that creates a socket pair, forks, calls	963	OK, so, I ran a simple benchmark that creates a socket pair, forks, calls
629	exit in the child and waits for the socket to close in the parent. I did	964	exit in the child and waits for the socket to close in the parent. I did
630	load AnyEvent, EV and AnyEvent::Fork, for a total process size of 6312kB.	965	load AnyEvent, EV and AnyEvent::Fork, for a total process size of 5100kB.
631		966
632	2079 new processes per second, using socketpair + fork manually	967	2079 new processes per second, using manual socketpair + fork
633		968
634	Then I did the same thing, but instead of calling fork, I called	969	Then I did the same thing, but instead of calling fork, I called
635	AnyEvent::Fork->new->run ("CORE::exit") and then again waited for the	970	AnyEvent::Fork->new->run ("CORE::exit") and then again waited for the
636	socket form the child to close on exit. This does the same thing as manual	971	socket from the child to close on exit. This does the same thing as manual
637	socket pair + fork, except that what is forked is the template process	972	socket pair + fork, except that what is forked is the template process
638	(2440kB), and the socket needs to be passed to the server at the other end	973	(2440kB), and the socket needs to be passed to the server at the other end
639	of the socket first.	974	of the socket first.
640		975
641	2307 new processes per second, using AnyEvent::Fork->new	976	2307 new processes per second, using AnyEvent::Fork->new
…		…
646	479 vfork+execs per second, using AnyEvent::Fork->new_exec	981	479 vfork+execs per second, using AnyEvent::Fork->new_exec
647		982
648	So how can C<< AnyEvent->new >> be faster than a standard fork, even	983	So how can C<< AnyEvent->new >> be faster than a standard fork, even
649	though it uses the same operations, but adds a lot of overhead?	984	though it uses the same operations, but adds a lot of overhead?
650		985
651	The difference is simply the process size: forking the 6MB process takes	986	The difference is simply the process size: forking the 5MB process takes
652	so much longer than forking the 2.5MB template process that the overhead	987	so much longer than forking the 2.5MB template process that the extra
653	introduced is canceled out.	988	overhead is canceled out.
654		989
655	If the benchmark process grows, the normal fork becomes even slower:	990	If the benchmark process grows, the normal fork becomes even slower:
656		991
657	1340 new processes, manual fork in a 20MB process	992	1340 new processes, manual fork of a 20MB process
658	731 new processes, manual fork in a 200MB process	993	731 new processes, manual fork of a 200MB process
659	235 new processes, manual fork in a 2000MB process	994	235 new processes, manual fork of a 2000MB process
660		995
661	What that means (to me) is that I can use this module without having a	996	What that means (to me) is that I can use this module without having a bad
662	very bad conscience because of the extra overhead required to start new	997	conscience because of the extra overhead required to start new processes.
663	processes.
664		998
665	=head1 TYPICAL PROBLEMS	999	=head1 TYPICAL PROBLEMS
666		1000
667	This section lists typical problems that remain. I hope by recognising	1001	This section lists typical problems that remain. I hope by recognising
668	them, most can be avoided.	1002	them, most can be avoided.
669		1003
670	=over 4	1004	=over 4
671		1005
672	=item exit runs destructors
673
674	=item "leaked" file descriptors for exec'ed processes	1006	=item leaked file descriptors for exec'ed processes
675		1007
676	POSIX systems inherit file descriptors by default when exec'ing a new	1008	POSIX systems inherit file descriptors by default when exec'ing a new
677	process. While perl itself laudably sets the close-on-exec flags on new	1009	process. While perl itself laudably sets the close-on-exec flags on new
678	file handles, most C libraries don't care, and even if all cared, it's	1010	file handles, most C libraries don't care, and even if all cared, it's
679	often not possible to set the flag in a race-free manner.	1011	often not possible to set the flag in a race-free manner.
…		…
699	libraries or the code that leaks those file descriptors.	1031	libraries or the code that leaks those file descriptors.
700		1032
701	Fortunately, most of these leaked descriptors do no harm, other than	1033	Fortunately, most of these leaked descriptors do no harm, other than
702	sitting on some resources.	1034	sitting on some resources.
703		1035
704	=item "leaked" file descriptors for fork'ed processes	1036	=item leaked file descriptors for fork'ed processes
705		1037
706	Normally, L<AnyEvent::Fork> does start new processes by exec'ing them,	1038	Normally, L<AnyEvent::Fork> does start new processes by exec'ing them,
707	which closes file descriptors not marked for being inherited.	1039	which closes file descriptors not marked for being inherited.
708		1040
709	However, L<AnyEvent::Fork::Early> and L<AnyEvent::Fork::Template> offer	1041	However, L<AnyEvent::Fork::Early> and L<AnyEvent::Fork::Template> offer
…		…
717	trouble with a fork.	1049	trouble with a fork.
718		1050
719	The solution is to either not load these modules before use'ing	1051	The solution is to either not load these modules before use'ing
720	L<AnyEvent::Fork::Early> or L<AnyEvent::Fork::Template>, or to delay	1052	L<AnyEvent::Fork::Early> or L<AnyEvent::Fork::Template>, or to delay
721	initialising them, for example, by calling C<init Gtk2> manually.	1053	initialising them, for example, by calling C<init Gtk2> manually.
		1054
		1055	=item exiting calls object destructors
		1056
		1057	This only applies to users of L<AnyEvent::Fork:Early> and
		1058	L<AnyEvent::Fork::Template>, or when initialising code creates objects
		1059	that reference external resources.
		1060
		1061	When a process created by AnyEvent::Fork exits, it might do so by calling
		1062	exit, or simply letting perl reach the end of the program. At which point
		1063	Perl runs all destructors.
		1064
		1065	Not all destructors are fork-safe - for example, an object that represents
		1066	the connection to an X display might tell the X server to free resources,
		1067	which is inconvenient when the "real" object in the parent still needs to
		1068	use them.
		1069
		1070	This is obviously not a problem for L<AnyEvent::Fork::Early>, as you used
		1071	it as the very first thing, right?
		1072
		1073	It is a problem for L<AnyEvent::Fork::Template> though - and the solution
		1074	is to not create objects with nontrivial destructors that might have an
		1075	effect outside of Perl.
722		1076
723	=back	1077	=back
724		1078
725	=head1 PORTABILITY NOTES	1079	=head1 PORTABILITY NOTES
726		1080
…		…
729	to make it so, mostly due to the bloody broken perl that nobody seems to	1083	to make it so, mostly due to the bloody broken perl that nobody seems to
730	care about. The fork emulation is a bad joke - I have yet to see something	1084	care about. The fork emulation is a bad joke - I have yet to see something
731	useful that you can do with it without running into memory corruption	1085	useful that you can do with it without running into memory corruption
732	issues or other braindamage. Hrrrr.	1086	issues or other braindamage. Hrrrr.
733		1087
734	Cygwin perl is not supported at the moment, as it should implement fd	1088	Since fork is endlessly broken on win32 perls (it doesn't even remotely
735	passing, but doesn't, and rolling my own is hard, as cygwin doesn't	1089	work within it's documented limits) and quite obviously it's not getting
736	support enough functionality to do it.	1090	improved any time soon, the best way to proceed on windows would be to
		1091	always use C<new_exec> and thus never rely on perl's fork "emulation".
		1092
		1093	Cygwin perl is not supported at the moment due to some hilarious
		1094	shortcomings of its API - see L<IO::FDPoll> for more details. If you never
		1095	use C<send_fh> and always use C<new_exec> to create processes, it should
		1096	work though.
		1097
		1098	=head1 USING AnyEvent::Fork IN SUBPROCESSES
		1099
		1100	AnyEvent::Fork itself cannot generally be used in subprocesses. As long as
		1101	only one process ever forks new processes, sharing the template processes
		1102	is possible (you could use a pipe as a lock by writing a byte into it to
		1103	unlock, and reading the byte to lock for example)
		1104
		1105	To make concurrent calls possible after fork, you should get rid of the
		1106	template and early fork processes. AnyEvent::Fork will create a new
		1107	template process as needed.
		1108
		1109	undef $AnyEvent::Fork::EARLY;
		1110	undef $AnyEvent::Fork::TEMPLATE;
		1111
		1112	It doesn't matter whether you get rid of them in the parent or child after
		1113	a fork.
737		1114
738	=head1 SEE ALSO	1115	=head1 SEE ALSO
739		1116
740	L<AnyEvent::Fork::Early> (to avoid executing a perl interpreter),	1117	L<AnyEvent::Fork::Early>, to avoid executing a perl interpreter at all
		1118	(part of this distribution).
		1119
741	L<AnyEvent::Fork::Template> (to create a process by forking the main	1120	L<AnyEvent::Fork::Template>, to create a process by forking the main
742	program at a convenient time).	1121	program at a convenient time (part of this distribution).
743		1122
744	=head1 AUTHOR	1123	L<AnyEvent::Fork::Remote>, for another way to create processes that is
		1124	mostly compatible to this module and modules building on top of it, but
		1125	works better with remote processes.
		1126
		1127	L<AnyEvent::Fork::RPC>, for simple RPC to child processes (on CPAN).
		1128
		1129	L<AnyEvent::Fork::Pool>, for simple worker process pool (on CPAN).
		1130
		1131	=head1 AUTHOR AND CONTACT INFORMATION
745		1132
746	Marc Lehmann <schmorp@schmorp.de>	1133	Marc Lehmann <schmorp@schmorp.de>
747	http://home.schmorp.de/	1134	http://software.schmorp.de/pkg/AnyEvent-Fork
748		1135
749	=cut	1136	=cut
750		1137
751	1	1138	1
752		1139

Diff Legend

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

Comparing AnyEvent-Fork/Fork.pm (file contents): Revision 1.17 by root, Fri Apr 5 23:42:24 2013 UTC vs. Revision 1.63 by root, Wed Nov 26 13:36:18 2014 UTC

Diff Legend

Comparing AnyEvent-Fork/Fork.pm (file contents):
Revision 1.17 by root, Fri Apr 5 23:42:24 2013 UTC vs.
Revision 1.63 by root, Wed Nov 26 13:36:18 2014 UTC