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

Comparing AnyEvent-Fork/Fork.pm (file contents):
Revision 1.23 by root, Sat Apr 6 08:29:43 2013 UTC vs.
Revision 1.49 by root, Fri Apr 19 12:56:53 2013 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	Or you can implement it yourself in whatever way you like, use some
		44	message-passing module such as L<AnyEvent::MP>, some pipe such as
		45	L<AnyEvent::ZeroMQ>, use L<AnyEvent::Handle> on both sides to send
		46	e.g. JSON or Storable messages, and so on.
		47
		48	=head2 COMPARISON TO OTHER MODULES
		49
		50	There is an abundance of modules on CPAN that do "something fork", such as
		51	L<Parallel::ForkManager>, L<AnyEvent::ForkManager>, L<AnyEvent::Worker>
		52	or L<AnyEvent::Subprocess>. There are modules that implement their own
		53	process management, such as L<AnyEvent::DBI>.
		54
		55	The problems that all these modules try to solve are real, however, none
		56	of them (from what I have seen) tackle the very real problems of unwanted
		57	memory sharing, efficiency, not being able to use event processing or
		58	similar modules in the processes they create.
		59
		60	This module doesn't try to replace any of them - instead it tries to solve
		61	the problem of creating processes with a minimum of fuss and overhead (and
		62	also luxury). Ideally, most of these would use AnyEvent::Fork internally,
		63	except they were written before AnyEvent:Fork was available, so obviously
		64	had to roll their own.
		65
		66	=head2 PROBLEM STATEMENT
		67
		68	There are two traditional ways to implement parallel processing on UNIX
		69	like operating systems - fork and process, and fork+exec and process. They
		70	have different advantages and disadvantages that I describe below,
		71	together with how this module tries to mitigate the disadvantages.
		72
		73	=over 4
		74
		75	=item Forking from a big process can be very slow.
		76
		77	A 5GB process needs 0.05s to fork on my 3.6GHz amd64 GNU/Linux box. This
		78	overhead is often shared with exec (because you have to fork first), but
		79	in some circumstances (e.g. when vfork is used), fork+exec can be much
		80	faster.
		81
		82	This module can help here by telling a small(er) helper process to fork,
		83	which is faster then forking the main process, and also uses vfork where
		84	possible. This gives the speed of vfork, with the flexibility of fork.
		85
		86	=item Forking usually creates a copy-on-write copy of the parent
		87	process.
		88
		89	For example, modules or data files that are loaded will not use additional
		90	memory after a fork. When exec'ing a new process, modules and data files
		91	might need to be loaded again, at extra CPU and memory cost. But when
		92	forking, literally all data structures are copied - if the program frees
		93	them and replaces them by new data, the child processes will retain the
		94	old version even if it isn't used, which can suddenly and unexpectedly
		95	increase memory usage when freeing memory.
		96
		97	The trade-off is between more sharing with fork (which can be good or
		98	bad), and no sharing with exec.
		99
		100	This module allows the main program to do a controlled fork, and allows
		101	modules to exec processes safely at any time. When creating a custom
		102	process pool you can take advantage of data sharing via fork without
		103	risking to share large dynamic data structures that will blow up child
		104	memory usage.
		105
		106	In other words, this module puts you into control over what is being
		107	shared and what isn't, at all times.
		108
		109	=item Exec'ing a new perl process might be difficult.
		110
		111	For example, it is not easy to find the correct path to the perl
		112	interpreter - C<$^X> might not be a perl interpreter at all.
		113
		114	This module tries hard to identify the correct path to the perl
		115	interpreter. With a cooperative main program, exec'ing the interpreter
		116	might not even be necessary, but even without help from the main program,
		117	it will still work when used from a module.
		118
		119	=item Exec'ing a new perl process might be slow, as all necessary modules
		120	have to be loaded from disk again, with no guarantees of success.
		121
		122	Long running processes might run into problems when perl is upgraded
		123	and modules are no longer loadable because they refer to a different
		124	perl version, or parts of a distribution are newer than the ones already
		125	loaded.
		126
		127	This module supports creating pre-initialised perl processes to be used as
		128	a template for new processes.
		129
		130	=item Forking might be impossible when a program is running.
		131
		132	For example, POSIX makes it almost impossible to fork from a
		133	multi-threaded program while doing anything useful in the child - in
		134	fact, if your perl program uses POSIX threads (even indirectly via
		135	e.g. L<IO::AIO> or L<threads>), you cannot call fork on the perl level
		136	anymore without risking corruption issues on a number of operating
		137	systems.
		138
		139	This module can safely fork helper processes at any time, by calling
		140	fork+exec in C, in a POSIX-compatible way (via L<Proc::FastSpawn>).
		141
		142	=item Parallel processing with fork might be inconvenient or difficult
		143	to implement. Modules might not work in both parent and child.
		144
		145	For example, when a program uses an event loop and creates watchers it
		146	becomes very hard to use the event loop from a child program, as the
		147	watchers already exist but are only meaningful in the parent. Worse, a
		148	module might want to use such a module, not knowing whether another module
		149	or the main program also does, leading to problems.
		150
		151	Apart from event loops, graphical toolkits also commonly fall into the
		152	"unsafe module" category, or just about anything that communicates with
		153	the external world, such as network libraries and file I/O modules, which
		154	usually don't like being copied and then allowed to continue in two
		155	processes.
		156
		157	With this module only the main program is allowed to create new processes
		158	by forking (because only the main program can know when it is still safe
		159	to do so) - all other processes are created via fork+exec, which makes it
		160	possible to use modules such as event loops or window interfaces safely.
		161
		162	=back
		163
		164	=head1 EXAMPLES
		165
10	# create a single new process, tell it to run your worker function	166	=head2 Create a single new process, tell it to run your worker function.
11		167
12	AnyEvent::Fork	168	AnyEvent::Fork
13	->new	169	->new
14	->require ("MyModule")	170	->require ("MyModule")
15	->run ("MyModule::worker, sub {	171	->run ("MyModule::worker, sub {
…		…
17		173
18	# now $master_filehandle is connected to the	174	# now $master_filehandle is connected to the
19	# $slave_filehandle in the new process.	175	# $slave_filehandle in the new process.
20	});	176	});
21		177
22	# MyModule::worker might look like this	178	C<MyModule> might look like this:
		179
		180	package MyModule;
		181
23	sub MyModule::worker {	182	sub worker {
24	my ($slave_filehandle) = @_;	183	my ($slave_filehandle) = @_;
25		184
26	# now $slave_filehandle is connected to the $master_filehandle	185	# now $slave_filehandle is connected to the $master_filehandle
27	# in the original prorcess. have fun!	186	# in the original prorcess. have fun!
28	}	187	}
29		188
30	##################################################################
31	# create a pool of server processes all accepting on the same socket	189	=head2 Create a pool of server processes all accepting on the same socket.
32		190
33	# create listener socket	191	# create listener socket
34	my $listener = ...;	192	my $listener = ...;
35		193
36	# create a pool template, initialise it and give it the socket	194	# create a pool template, initialise it and give it the socket
…		…
48	}	206	}
49		207
50	# now do other things - maybe use the filehandle provided by run	208	# now do other things - maybe use the filehandle provided by run
51	# to wait for the processes to die. or whatever.	209	# to wait for the processes to die. or whatever.
52		210
53	# My::Server::run might look like this	211	C<My::Server> might look like this:
54	sub My::Server::run {	212
		213	package My::Server;
		214
		215	sub run {
55	my ($slave, $listener, $id) = @_;	216	my ($slave, $listener, $id) = @_;
56		217
57	close $slave; # we do not use the socket, so close it to save resources	218	close $slave; # we do not use the socket, so close it to save resources
58		219
59	# we could go ballistic and use e.g. AnyEvent here, or IO::AIO,	220	# we could go ballistic and use e.g. AnyEvent here, or IO::AIO,
…		…
61	while (my $socket = $listener->accept) {	222	while (my $socket = $listener->accept) {
62	# do sth. with new socket	223	# do sth. with new socket
63	}	224	}
64	}	225	}
65		226
66	##################################################################
67	# use AnyEvent::Fork as a faster fork+exec	227	=head2 use AnyEvent::Fork as a faster fork+exec
68		228
69	# this runs /bin/echo hi, with stdout redirected to /tmp/log	229	This runs C</bin/echo hi>, with standard output redirected to F</tmp/log>
70	# and stderr to the communications socket. it is usually faster	230	and standard error redirected to the communications socket. It is usually
71	# than fork+exec, but still let's you prepare the environment.	231	faster than fork+exec, but still lets you prepare the environment.
72		232
73	open my $output, ">/tmp/log" or die "$!";	233	open my $output, ">/tmp/log" or die "$!";
74		234
75	AnyEvent::Fork	235	AnyEvent::Fork
76	->new	236	->new
77	->eval ('	237	->eval ('
		238	# compile a helper function for later use
78	sub run {	239	sub run {
79	my ($fh, $output, @cmd) = @_;	240	my ($fh, $output, @cmd) = @_;
80		241
81	# perl will clear close-on-exec on STDOUT/STDERR	242	# perl will clear close-on-exec on STDOUT/STDERR
82	open STDOUT, ">&", $output or die;	243	open STDOUT, ">&", $output or die;
…		…
89	->send_arg ("/bin/echo", "hi")	250	->send_arg ("/bin/echo", "hi")
90	->run ("run", my $cv = AE::cv);	251	->run ("run", my $cv = AE::cv);
91		252
92	my $stderr = $cv->recv;	253	my $stderr = $cv->recv;
93		254
94	=head1 DESCRIPTION
95
96	This module allows you to create new processes, without actually forking
97	them from your current process (avoiding the problems of forking), but
98	preserving most of the advantages of fork.
99
100	It can be used to create new worker processes or new independent
101	subprocesses for short- and long-running jobs, process pools (e.g. for use
102	in pre-forked servers) but also to spawn new external processes (such as
103	CGI scripts from a web server), which can be faster (and more well behaved)
104	than using fork+exec in big processes.
105
106	Special care has been taken to make this module useful from other modules,
107	while still supporting specialised environments such as L<App::Staticperl>
108	or L<PAR::Packer>.
109
110	=head1 WHAT THIS MODULE IS NOT
111
112	This module only creates processes and lets you pass file handles and
113	strings to it, and run perl code. It does not implement any kind of RPC -
114	there is no back channel from the process back to you, and there is no RPC
115	or message passing going on.
116
117	If you need some form of RPC, you can either implement it yourself
118	in whatever way you like, use some message-passing module such
119	as L<AnyEvent::MP>, some pipe such as L<AnyEvent::ZeroMQ>, use
120	L<AnyEvent::Handle> on both sides to send e.g. JSON or Storable messages,
121	and so on.
122
123	=head1 PROBLEM STATEMENT
124
125	There are two ways to implement parallel processing on UNIX like operating
126	systems - fork and process, and fork+exec and process. They have different
127	advantages and disadvantages that I describe below, together with how this
128	module tries to mitigate the disadvantages.
129
130	=over 4
131
132	=item Forking from a big process can be very slow (a 5GB process needs
133	0.05s to fork on my 3.6GHz amd64 GNU/Linux box for example). This overhead
134	is often shared with exec (because you have to fork first), but in some
135	circumstances (e.g. when vfork is used), fork+exec can be much faster.
136
137	This module can help here by telling a small(er) helper process to fork,
138	or fork+exec instead.
139
140	=item Forking usually creates a copy-on-write copy of the parent
141	process. Memory (for example, modules or data files that have been
142	will not take additional memory). When exec'ing a new process, modules
143	and data files might need to be loaded again, at extra CPU and memory
144	cost. Likewise when forking, all data structures are copied as well - if
145	the program frees them and replaces them by new data, the child processes
146	will retain the memory even if it isn't used.
147
148	This module allows the main program to do a controlled fork, and allows
149	modules to exec processes safely at any time. When creating a custom
150	process pool you can take advantage of data sharing via fork without
151	risking to share large dynamic data structures that will blow up child
152	memory usage.
153
154	=item Exec'ing a new perl process might be difficult and slow. For
155	example, it is not easy to find the correct path to the perl interpreter,
156	and all modules have to be loaded from disk again. Long running processes
157	might run into problems when perl is upgraded for example.
158
159	This module supports creating pre-initialised perl processes to be used
160	as template, and also tries hard to identify the correct path to the perl
161	interpreter. With a cooperative main program, exec'ing the interpreter
162	might not even be necessary.
163
164	=item Forking might be impossible when a program is running. For example,
165	POSIX makes it almost impossible to fork from a multi-threaded program and
166	do anything useful in the child - strictly speaking, if your perl program
167	uses posix threads (even indirectly via e.g. L<IO::AIO> or L<threads>),
168	you cannot call fork on the perl level anymore, at all.
169
170	This module can safely fork helper processes at any time, by calling
171	fork+exec in C, in a POSIX-compatible way.
172
173	=item Parallel processing with fork might be inconvenient or difficult
174	to implement. For example, when a program uses an event loop and creates
175	watchers it becomes very hard to use the event loop from a child
176	program, as the watchers already exist but are only meaningful in the
177	parent. Worse, a module might want to use such a system, not knowing
178	whether another module or the main program also does, leading to problems.
179
180	This module only lets the main program create pools by forking (because
181	only the main program can know when it is still safe to do so) - all other
182	pools are created by fork+exec, after which such modules can again be
183	loaded.
184
185	=back
186
187	=head1 CONCEPTS	255	=head1 CONCEPTS
188		256
189	This module can create new processes either by executing a new perl	257	This module can create new processes either by executing a new perl
190	process, or by forking from an existing "template" process.	258	process, or by forking from an existing "template" process.
		259
		260	All these processes are called "child processes" (whether they are direct
		261	children or not), while the process that manages them is called the
		262	"parent process".
191		263
192	Each such process comes with its own file handle that can be used to	264	Each such process comes with its own file handle that can be used to
193	communicate with it (it's actually a socket - one end in the new process,	265	communicate with it (it's actually a socket - one end in the new process,
194	one end in the main process), and among the things you can do in it are	266	one end in the main process), and among the things you can do in it are
195	load modules, fork new processes, send file handles to it, and execute	267	load modules, fork new processes, send file handles to it, and execute
…		…
269	my ($fork_fh) = @_;	341	my ($fork_fh) = @_;
270	});	342	});
271		343
272	=back	344	=back
273		345
274	=head1 FUNCTIONS	346	=head1 THE C<AnyEvent::Fork> CLASS
		347
		348	This module exports nothing, and only implements a single class -
		349	C<AnyEvent::Fork>.
		350
		351	There are two class constructors that both create new processes - C<new>
		352	and C<new_exec>. The C<fork> method creates a new process by forking an
		353	existing one and could be considered a third constructor.
		354
		355	Most of the remaining methods deal with preparing the new process, by
		356	loading code, evaluating code and sending data to the new process. They
		357	usually return the process object, so you can chain method calls.
		358
		359	If a process object is destroyed before calling its C<run> method, then
		360	the process simply exits. After C<run> is called, all responsibility is
		361	passed to the specified function.
		362
		363	As long as there is any outstanding work to be done, process objects
		364	resist being destroyed, so there is no reason to store them unless you
		365	need them later - configure and forget works just fine.
275		366
276	=over 4	367	=over 4
277		368
278	=cut	369	=cut
279		370
…		…
286	use AnyEvent;	377	use AnyEvent;
287	use AnyEvent::Util ();	378	use AnyEvent::Util ();
288		379
289	use IO::FDPass;	380	use IO::FDPass;
290		381
291	our $VERSION = 0.5;	382	our $VERSION = 0.7;
292
293	our $PERL; # the path to the perl interpreter, deduces with various forms of magic
294
295	=item my $pool = new AnyEvent::Fork key => value...
296
297	Create a new process pool. The following named parameters are supported:
298
299	=over 4
300
301	=back
302
303	=cut
304		383
305	# the early fork template process	384	# the early fork template process
306	our $EARLY;	385	our $EARLY;
307		386
308	# the empty template process	387	# the empty template process
309	our $TEMPLATE;	388	our $TEMPLATE;
		389
		390	sub QUEUE() { 0 }
		391	sub FH() { 1 }
		392	sub WW() { 2 }
		393	sub PID() { 3 }
		394	sub CB() { 4 }
		395
		396	sub _new {
		397	my ($self, $fh, $pid) = @_;
		398
		399	AnyEvent::Util::fh_nonblocking $fh, 1;
		400
		401	$self = bless [
		402	[], # write queue - strings or fd's
		403	$fh,
		404	undef, # AE watcher
		405	$pid,
		406	], $self;
		407
		408	$self
		409	}
310		410
311	sub _cmd {	411	sub _cmd {
312	my $self = shift;	412	my $self = shift;
313		413
314	# ideally, we would want to use "a (w/a)*" as format string, but perl	414	# ideally, we would want to use "a (w/a)*" as format string, but perl
315	# versions from at least 5.8.9 to 5.16.3 are all buggy and can't unpack	415	# versions from at least 5.8.9 to 5.16.3 are all buggy and can't unpack
316	# it.	416	# it.
317	push @{ $self->[2] }, pack "a L/a*", $_[0], $_[1];	417	push @{ $self->[QUEUE] }, pack "a L/a*", $_[0], $_[1];
318		418
319	$self->[3] \|\|= AE::io $self->[1], 1, sub {	419	$self->[WW] \|\|= AE::io $self->[FH], 1, sub {
320	do {	420	do {
321	# send the next "thing" in the queue - either a reference to an fh,	421	# send the next "thing" in the queue - either a reference to an fh,
322	# or a plain string.	422	# or a plain string.
323		423
324	if (ref $self->[2][0]) {	424	if (ref $self->[QUEUE][0]) {
325	# send fh	425	# send fh
326	unless (IO::FDPass::send fileno $self->[1], fileno ${ $self->[2][0] }) {	426	unless (IO::FDPass::send fileno $self->[FH], fileno ${ $self->[QUEUE][0] }) {
327	return if $! == Errno::EAGAIN \|\| $! == Errno::EWOULDBLOCK;	427	return if $! == Errno::EAGAIN \|\| $! == Errno::EWOULDBLOCK;
328	undef $self->[3];	428	undef $self->[WW];
329	die "AnyEvent::Fork: file descriptor send failure: $!";	429	die "AnyEvent::Fork: file descriptor send failure: $!";
330	}	430	}
331		431
332	shift @{ $self->[2] };	432	shift @{ $self->[QUEUE] };
333		433
334	} else {	434	} else {
335	# send string	435	# send string
336	my $len = syswrite $self->[1], $self->[2][0];	436	my $len = syswrite $self->[FH], $self->[QUEUE][0];
337		437
338	unless ($len) {	438	unless ($len) {
339	return if $! == Errno::EAGAIN \|\| $! == Errno::EWOULDBLOCK;	439	return if $! == Errno::EAGAIN \|\| $! == Errno::EWOULDBLOCK;
340	undef $self->[3];	440	undef $self->[3];
341	die "AnyEvent::Fork: command write failure: $!";	441	die "AnyEvent::Fork: command write failure: $!";
342	}	442	}
343		443
344	substr $self->[2][0], 0, $len, "";	444	substr $self->[QUEUE][0], 0, $len, "";
345	shift @{ $self->[2] } unless length $self->[2][0];	445	shift @{ $self->[QUEUE] } unless length $self->[QUEUE][0];
346	}	446	}
347	} while @{ $self->[2] };	447	} while @{ $self->[QUEUE] };
348		448
349	# everything written	449	# everything written
350	undef $self->[3];	450	undef $self->[WW];
351		451
352	# invoke run callback, if any	452	# invoke run callback, if any
353	$self->[4]->($self->[1]) if $self->[4];	453	if ($self->[CB]) {
		454	$self->[CB]->($self->[FH]);
		455	@$self = ();
		456	}
354	};	457	};
355		458
356	() # make sure we don't leak the watcher	459	() # make sure we don't leak the watcher
357	}
358
359	sub _new {
360	my ($self, $fh, $pid) = @_;
361
362	AnyEvent::Util::fh_nonblocking $fh, 1;
363
364	$self = bless [
365	$pid,
366	$fh,
367	[], # write queue - strings or fd's
368	undef, # AE watcher
369	], $self;
370
371	$self
372	}	460	}
373		461
374	# fork template from current process, used by AnyEvent::Fork::Early/Template	462	# fork template from current process, used by AnyEvent::Fork::Early/Template
375	sub _new_fork {	463	sub _new_fork {
376	my ($fh, $slave) = AnyEvent::Util::portable_socketpair;	464	my ($fh, $slave) = AnyEvent::Util::portable_socketpair;
…		…
381	if ($pid eq 0) {	469	if ($pid eq 0) {
382	require AnyEvent::Fork::Serve;	470	require AnyEvent::Fork::Serve;
383	$AnyEvent::Fork::Serve::OWNER = $parent;	471	$AnyEvent::Fork::Serve::OWNER = $parent;
384	close $fh;	472	close $fh;
385	$0 = "$_[1] of $parent";	473	$0 = "$_[1] of $parent";
386	$SIG{CHLD} = 'IGNORE';
387	AnyEvent::Fork::Serve::serve ($slave);	474	AnyEvent::Fork::Serve::serve ($slave);
388	exit 0;	475	exit 0;
389	} elsif (!$pid) {	476	} elsif (!$pid) {
390	die "AnyEvent::Fork::Early/Template: unable to fork template process: $!";	477	die "AnyEvent::Fork::Early/Template: unable to fork template process: $!";
391	}	478	}
…		…
398	Create a new "empty" perl interpreter process and returns its process	485	Create a new "empty" perl interpreter process and returns its process
399	object for further manipulation.	486	object for further manipulation.
400		487
401	The new process is forked from a template process that is kept around	488	The new process is forked from a template process that is kept around
402	for this purpose. When it doesn't exist yet, it is created by a call to	489	for this purpose. When it doesn't exist yet, it is created by a call to
403	C<new_exec> and kept around for future calls.	490	C<new_exec> first and then stays around for future calls.
404
405	When the process object is destroyed, it will release the file handle
406	that connects it with the new process. When the new process has not yet
407	called C<run>, then the process will exit. Otherwise, what happens depends
408	entirely on the code that is executed.
409		491
410	=cut	492	=cut
411		493
412	sub new {	494	sub new {
413	my $class = shift;	495	my $class = shift;
…		…
503	}	585	}
504		586
505	=item $pid = $proc->pid	587	=item $pid = $proc->pid
506		588
507	Returns the process id of the process I<iff it is a direct child of the	589	Returns the process id of the process I<iff it is a direct child of the
508	process> running AnyEvent::Fork, and C<undef> otherwise.	590	process running AnyEvent::Fork>, and C<undef> otherwise.
509		591
510	Normally, only processes created via C<< AnyEvent::Fork->new_exec >> and	592	Normally, only processes created via C<< AnyEvent::Fork->new_exec >> and
511	L<AnyEvent::Fork::Template> are direct children, and you are responsible	593	L<AnyEvent::Fork::Template> are direct children, and you are responsible
512	to clean up their zombies when they die.	594	to clean up their zombies when they die.
513		595
514	All other processes are not direct children, and will be cleaned up by	596	All other processes are not direct children, and will be cleaned up by
515	AnyEvent::Fork.	597	AnyEvent::Fork itself.
516		598
517	=cut	599	=cut
518		600
519	sub pid {	601	sub pid {
520	$_[0][0]	602	$_[0][PID]
521	}	603	}
522		604
523	=item $proc = $proc->eval ($perlcode, @args)	605	=item $proc = $proc->eval ($perlcode, @args)
524		606
525	Evaluates the given C<$perlcode> as ... perl code, while setting C<@_> to	607	Evaluates the given C<$perlcode> as ... Perl code, while setting C<@_> to
526	the strings specified by C<@args>, in the "main" package.	608	the strings specified by C<@args>, in the "main" package.
527		609
528	This call is meant to do any custom initialisation that might be required	610	This call is meant to do any custom initialisation that might be required
529	(for example, the C<require> method uses it). It's not supposed to be used	611	(for example, the C<require> method uses it). It's not supposed to be used
530	to completely take over the process, use C<run> for that.	612	to completely take over the process, use C<run> for that.
531		613
532	The code will usually be executed after this call returns, and there is no	614	The code will usually be executed after this call returns, and there is no
533	way to pass anything back to the calling process. Any evaluation errors	615	way to pass anything back to the calling process. Any evaluation errors
534	will be reported to stderr and cause the process to exit.	616	will be reported to stderr and cause the process to exit.
535		617
536	If you want to execute some code to take over the process (see the	618	If you want to execute some code (that isn't in a module) to take over the
537	"fork+exec" example in the SYNOPSIS), you should compile a function via	619	process, you should compile a function via C<eval> first, and then call
538	C<eval> first, and then call it via C<run>. This also gives you access to	620	it via C<run>. This also gives you access to any arguments passed via the
539	any arguments passed via the C<send_xxx> methods, such as file handles.	621	C<send_xxx> methods, such as file handles. See the L<use AnyEvent::Fork as
		622	a faster fork+exec> example to see it in action.
540		623
541	Returns the process object for easy chaining of method calls.	624	Returns the process object for easy chaining of method calls.
542		625
543	=cut	626	=cut
544		627
…		…
570	=item $proc = $proc->send_fh ($handle, ...)	653	=item $proc = $proc->send_fh ($handle, ...)
571		654
572	Send one or more file handles (I<not> file descriptors) to the process,	655	Send one or more file handles (I<not> file descriptors) to the process,
573	to prepare a call to C<run>.	656	to prepare a call to C<run>.
574		657
575	The process object keeps a reference to the handles until this is done,	658	The process object keeps a reference to the handles until they have
576	so you must not explicitly close the handles. This is most easily	659	been passed over to the process, so you must not explicitly close the
577	accomplished by simply not storing the file handles anywhere after passing	660	handles. This is most easily accomplished by simply not storing the file
578	them to this method.	661	handles anywhere after passing them to this method - when AnyEvent::Fork
		662	is finished using them, perl will automatically close them.
579		663
580	Returns the process object for easy chaining of method calls.	664	Returns the process object for easy chaining of method calls.
581		665
582	Example: pass a file handle to a process, and release it without	666	Example: pass a file handle to a process, and release it without
583	closing. It will be closed automatically when it is no longer used.	667	closing. It will be closed automatically when it is no longer used.
…		…
590	sub send_fh {	674	sub send_fh {
591	my ($self, @fh) = @_;	675	my ($self, @fh) = @_;
592		676
593	for my $fh (@fh) {	677	for my $fh (@fh) {
594	$self->_cmd ("h");	678	$self->_cmd ("h");
595	push @{ $self->[2] }, \$fh;	679	push @{ $self->[QUEUE] }, \$fh;
596	}	680	}
597		681
598	$self	682	$self
599	}	683	}
600		684
601	=item $proc = $proc->send_arg ($string, ...)	685	=item $proc = $proc->send_arg ($string, ...)
602		686
603	Send one or more argument strings to the process, to prepare a call to	687	Send one or more argument strings to the process, to prepare a call to
604	C<run>. The strings can be any octet string.	688	C<run>. The strings can be any octet strings.
605		689
606	The protocol is optimised to pass a moderate number of relatively short	690	The protocol is optimised to pass a moderate number of relatively short
607	strings - while you can pass up to 4GB of data in one go, this is more	691	strings - while you can pass up to 4GB of data in one go, this is more
608	meant to pass some ID information or other startup info, not big chunks of	692	meant to pass some ID information or other startup info, not big chunks of
609	data.	693	data.
…		…
625	Enter the function specified by the function name in C<$func> in the	709	Enter the function specified by the function name in C<$func> in the
626	process. The function is called with the communication socket as first	710	process. The function is called with the communication socket as first
627	argument, followed by all file handles and string arguments sent earlier	711	argument, followed by all file handles and string arguments sent earlier
628	via C<send_fh> and C<send_arg> methods, in the order they were called.	712	via C<send_fh> and C<send_arg> methods, in the order they were called.
629		713
		714	The process object becomes unusable on return from this function - any
		715	further method calls result in undefined behaviour.
		716
630	The function name should be fully qualified, but if it isn't, it will be	717	The function name should be fully qualified, but if it isn't, it will be
631	looked up in the main package.	718	looked up in the C<main> package.
632		719
633	If the called function returns, doesn't exist, or any error occurs, the	720	If the called function returns, doesn't exist, or any error occurs, the
634	process exits.	721	process exits.
635		722
636	Preparing the process is done in the background - when all commands have	723	Preparing the process is done in the background - when all commands have
637	been sent, the callback is invoked with the local communications socket	724	been sent, the callback is invoked with the local communications socket
638	as argument. At this point you can start using the socket in any way you	725	as argument. At this point you can start using the socket in any way you
639	like.	726	like.
640
641	The process object becomes unusable on return from this function - any
642	further method calls result in undefined behaviour.
643		727
644	If the communication socket isn't used, it should be closed on both sides,	728	If the communication socket isn't used, it should be closed on both sides,
645	to save on kernel memory.	729	to save on kernel memory.
646		730
647	The socket is non-blocking in the parent, and blocking in the newly	731	The socket is non-blocking in the parent, and blocking in the newly
…		…
686	=cut	770	=cut
687		771
688	sub run {	772	sub run {
689	my ($self, $func, $cb) = @_;	773	my ($self, $func, $cb) = @_;
690		774
691	$self->[4] = $cb;	775	$self->[CB] = $cb;
692	$self->_cmd (r => $func);	776	$self->_cmd (r => $func);
		777	}
		778
		779	=item $proc->to_fh ($cb->($fh))
		780
		781	Flushes all commands out to the process and then calls the callback with
		782	the communications socket.
		783
		784	The process object becomes unusable on return from this function - any
		785	further method calls result in undefined behaviour.
		786
		787	The point of this method is to give you a file handle thta you cna pass
		788	to another process. In that other process, you can call C<new_from_fh
		789	AnyEvent::Fork::RPC> to create a new C<AnyEvent::Fork> object from it,
		790	thereby effectively passing a fork object to another process.
		791
		792	=cut
		793
		794	sub to_fh {
		795	my ($self, $cb) = @_;
		796
		797	$self->[CB] = $cb;
		798
		799	unless ($self->[WW]) {
		800	$self->[CB]->($self->[FH]);
		801	@$self = ();
		802	}
		803	}
		804
		805	=item new_from_fh AnyEvent::Fork $fh
		806
		807	Takes a file handle originally rceeived by the C<to_fh> method and creates
		808	a new C<AnyEvent:Fork> object. The child process itself will not change in
		809	any way, i.e. it will keep all the modifications done to it before calling
		810	C<to_fh>.
		811
		812	The new object is very much like the original object, except that the
		813	C<pid> method will return C<undef> even if the process is a direct child.
		814
		815	=cut
		816
		817	sub new_from_fh {
		818	my ($class, $fh) = @_;
		819
		820	$class->_new ($fh)
693	}	821	}
694		822
695	=back	823	=back
696		824
697	=head1 PERFORMANCE	825	=head1 PERFORMANCE
…		…
707		835
708	2079 new processes per second, using manual socketpair + fork	836	2079 new processes per second, using manual socketpair + fork
709		837
710	Then I did the same thing, but instead of calling fork, I called	838	Then I did the same thing, but instead of calling fork, I called
711	AnyEvent::Fork->new->run ("CORE::exit") and then again waited for the	839	AnyEvent::Fork->new->run ("CORE::exit") and then again waited for the
712	socket form the child to close on exit. This does the same thing as manual	840	socket from the child to close on exit. This does the same thing as manual
713	socket pair + fork, except that what is forked is the template process	841	socket pair + fork, except that what is forked is the template process
714	(2440kB), and the socket needs to be passed to the server at the other end	842	(2440kB), and the socket needs to be passed to the server at the other end
715	of the socket first.	843	of the socket first.
716		844
717	2307 new processes per second, using AnyEvent::Fork->new	845	2307 new processes per second, using AnyEvent::Fork->new
…		…
722	479 vfork+execs per second, using AnyEvent::Fork->new_exec	850	479 vfork+execs per second, using AnyEvent::Fork->new_exec
723		851
724	So how can C<< AnyEvent->new >> be faster than a standard fork, even	852	So how can C<< AnyEvent->new >> be faster than a standard fork, even
725	though it uses the same operations, but adds a lot of overhead?	853	though it uses the same operations, but adds a lot of overhead?
726		854
727	The difference is simply the process size: forking the 6MB process takes	855	The difference is simply the process size: forking the 5MB process takes
728	so much longer than forking the 2.5MB template process that the overhead	856	so much longer than forking the 2.5MB template process that the extra
729	introduced is canceled out.	857	overhead is canceled out.
730		858
731	If the benchmark process grows, the normal fork becomes even slower:	859	If the benchmark process grows, the normal fork becomes even slower:
732		860
733	1340 new processes, manual fork in a 20MB process	861	1340 new processes, manual fork of a 20MB process
734	731 new processes, manual fork in a 200MB process	862	731 new processes, manual fork of a 200MB process
735	235 new processes, manual fork in a 2000MB process	863	235 new processes, manual fork of a 2000MB process
736		864
737	What that means (to me) is that I can use this module without having a	865	What that means (to me) is that I can use this module without having a bad
738	very bad conscience because of the extra overhead required to start new	866	conscience because of the extra overhead required to start new processes.
739	processes.
740		867
741	=head1 TYPICAL PROBLEMS	868	=head1 TYPICAL PROBLEMS
742		869
743	This section lists typical problems that remain. I hope by recognising	870	This section lists typical problems that remain. I hope by recognising
744	them, most can be avoided.	871	them, most can be avoided.
745		872
746	=over 4	873	=over 4
747		874
748	=item "leaked" file descriptors for exec'ed processes	875	=item leaked file descriptors for exec'ed processes
749		876
750	POSIX systems inherit file descriptors by default when exec'ing a new	877	POSIX systems inherit file descriptors by default when exec'ing a new
751	process. While perl itself laudably sets the close-on-exec flags on new	878	process. While perl itself laudably sets the close-on-exec flags on new
752	file handles, most C libraries don't care, and even if all cared, it's	879	file handles, most C libraries don't care, and even if all cared, it's
753	often not possible to set the flag in a race-free manner.	880	often not possible to set the flag in a race-free manner.
…		…
773	libraries or the code that leaks those file descriptors.	900	libraries or the code that leaks those file descriptors.
774		901
775	Fortunately, most of these leaked descriptors do no harm, other than	902	Fortunately, most of these leaked descriptors do no harm, other than
776	sitting on some resources.	903	sitting on some resources.
777		904
778	=item "leaked" file descriptors for fork'ed processes	905	=item leaked file descriptors for fork'ed processes
779		906
780	Normally, L<AnyEvent::Fork> does start new processes by exec'ing them,	907	Normally, L<AnyEvent::Fork> does start new processes by exec'ing them,
781	which closes file descriptors not marked for being inherited.	908	which closes file descriptors not marked for being inherited.
782		909
783	However, L<AnyEvent::Fork::Early> and L<AnyEvent::Fork::Template> offer	910	However, L<AnyEvent::Fork::Early> and L<AnyEvent::Fork::Template> offer
…		…
792		919
793	The solution is to either not load these modules before use'ing	920	The solution is to either not load these modules before use'ing
794	L<AnyEvent::Fork::Early> or L<AnyEvent::Fork::Template>, or to delay	921	L<AnyEvent::Fork::Early> or L<AnyEvent::Fork::Template>, or to delay
795	initialising them, for example, by calling C<init Gtk2> manually.	922	initialising them, for example, by calling C<init Gtk2> manually.
796		923
797	=item exit runs destructors	924	=item exiting calls object destructors
798		925
799	This only applies to users of Lc<AnyEvent::Fork:Early> and	926	This only applies to users of L<AnyEvent::Fork:Early> and
800	L<AnyEvent::Fork::Template>.	927	L<AnyEvent::Fork::Template>, or when initialising code creates objects
		928	that reference external resources.
801		929
802	When a process created by AnyEvent::Fork exits, it might do so by calling	930	When a process created by AnyEvent::Fork exits, it might do so by calling
803	exit, or simply letting perl reach the end of the program. At which point	931	exit, or simply letting perl reach the end of the program. At which point
804	Perl runs all destructors.	932	Perl runs all destructors.
805		933
…		…
824	to make it so, mostly due to the bloody broken perl that nobody seems to	952	to make it so, mostly due to the bloody broken perl that nobody seems to
825	care about. The fork emulation is a bad joke - I have yet to see something	953	care about. The fork emulation is a bad joke - I have yet to see something
826	useful that you can do with it without running into memory corruption	954	useful that you can do with it without running into memory corruption
827	issues or other braindamage. Hrrrr.	955	issues or other braindamage. Hrrrr.
828		956
829	Cygwin perl is not supported at the moment, as it should implement fd	957	Since fork is endlessly broken on win32 perls (it doesn't even remotely
830	passing, but doesn't, and rolling my own is hard, as cygwin doesn't	958	work within it's documented limits) and quite obviously it's not getting
831	support enough functionality to do it.	959	improved any time soon, the best way to proceed on windows would be to
		960	always use C<new_exec> and thus never rely on perl's fork "emulation".
		961
		962	Cygwin perl is not supported at the moment due to some hilarious
		963	shortcomings of its API - see L<IO::FDPoll> for more details. If you never
		964	use C<send_fh> and always use C<new_exec> to create processes, it should
		965	work though.
832		966
833	=head1 SEE ALSO	967	=head1 SEE ALSO
834		968
835	L<AnyEvent::Fork::Early> (to avoid executing a perl interpreter),	969	L<AnyEvent::Fork::Early>, to avoid executing a perl interpreter at all
		970	(part of this distribution).
		971
836	L<AnyEvent::Fork::Template> (to create a process by forking the main	972	L<AnyEvent::Fork::Template>, to create a process by forking the main
837	program at a convenient time).	973	program at a convenient time (part of this distribution).
838		974
839	=head1 AUTHOR	975	L<AnyEvent::Fork::RPC>, for simple RPC to child processes (on CPAN).
		976
		977	=head1 AUTHOR AND CONTACT INFORMATION
840		978
841	Marc Lehmann <schmorp@schmorp.de>	979	Marc Lehmann <schmorp@schmorp.de>
842	http://home.schmorp.de/	980	http://software.schmorp.de/pkg/AnyEvent-Fork
843		981
844	=cut	982	=cut
845		983
846	1	984	1
847		985

Diff Legend

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

Comparing AnyEvent-Fork/Fork.pm (file contents): Revision 1.23 by root, Sat Apr 6 08:29:43 2013 UTC vs. Revision 1.49 by root, Fri Apr 19 12:56:53 2013 UTC

Diff Legend

Comparing AnyEvent-Fork/Fork.pm (file contents):
Revision 1.23 by root, Sat Apr 6 08:29:43 2013 UTC vs.
Revision 1.49 by root, Fri Apr 19 12:56:53 2013 UTC