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

Comparing AnyEvent-Fork/Fork.pm (file contents):
Revision 1.26 by root, Sat Apr 6 08:58:51 2013 UTC vs.
Revision 1.57 by root, Sun Aug 25 17:38:43 2013 UTC

…		…
27		27
28	Special care has been taken to make this module useful from other modules,	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>	29	while still supporting specialised environments such as L<App::Staticperl>
30	or L<PAR::Packer>.	30	or L<PAR::Packer>.
31		31
32	=head1 WHAT THIS MODULE IS NOT	32	=head2 WHAT THIS MODULE IS NOT
33		33
34	This module only creates processes and lets you pass file handles and	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 -	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	36	there is no back channel from the process back to you, and there is no RPC
37	or message passing going on.	37	or message passing going on.
38		38
39	If you need some form of RPC, you can either implement it yourself	39	If you need some form of RPC, you could use the L<AnyEvent::Fork::RPC>
40	in whatever way you like, use some message-passing module such	40	companion module, which adds simple RPC/job queueing to a process created
41	as L<AnyEvent::MP>, some pipe such as L<AnyEvent::ZeroMQ>, use	41	by this module.
42	L<AnyEvent::Handle> on both sides to send e.g. JSON or Storable messages,
43	and so on.
44		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, not being able to use event processing or
		62	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
45	=head1 PROBLEM STATEMENT	70	=head2 PROBLEM STATEMENT
46		71
47	There are two traditional ways to implement parallel processing on UNIX	72	There are two traditional ways to implement parallel processing on UNIX
48	like operating systems - fork and process, and fork+exec and process. They	73	like operating systems - fork and process, and fork+exec and process. They
49	have different advantages and disadvantages that I describe below,	74	have different advantages and disadvantages that I describe below,
50	together with how this module tries to mitigate the disadvantages.	75	together with how this module tries to mitigate the disadvantages.
…		…
152		177
153	# now $master_filehandle is connected to the	178	# now $master_filehandle is connected to the
154	# $slave_filehandle in the new process.	179	# $slave_filehandle in the new process.
155	});	180	});
156		181
157	# MyModule::worker might look like this	182	C<MyModule> might look like this:
		183
		184	package MyModule;
		185
158	sub MyModule::worker {	186	sub worker {
159	my ($slave_filehandle) = @_;	187	my ($slave_filehandle) = @_;
160		188
161	# now $slave_filehandle is connected to the $master_filehandle	189	# now $slave_filehandle is connected to the $master_filehandle
162	# in the original prorcess. have fun!	190	# in the original prorcess. have fun!
163	}	191	}
…		…
182	}	210	}
183		211
184	# now do other things - maybe use the filehandle provided by run	212	# now do other things - maybe use the filehandle provided by run
185	# to wait for the processes to die. or whatever.	213	# to wait for the processes to die. or whatever.
186		214
187	# My::Server::run might look like this	215	C<My::Server> might look like this:
188	sub My::Server::run {	216
		217	package My::Server;
		218
		219	sub run {
189	my ($slave, $listener, $id) = @_;	220	my ($slave, $listener, $id) = @_;
190		221
191	close $slave; # we do not use the socket, so close it to save resources	222	close $slave; # we do not use the socket, so close it to save resources
192		223
193	# we could go ballistic and use e.g. AnyEvent here, or IO::AIO,	224	# we could go ballistic and use e.g. AnyEvent here, or IO::AIO,
…		…
197	}	228	}
198	}	229	}
199		230
200	=head2 use AnyEvent::Fork as a faster fork+exec	231	=head2 use AnyEvent::Fork as a faster fork+exec
201		232
202	This runs /bin/echo hi, with stdout redirected to /tmp/log and stderr to	233	This runs C</bin/echo hi>, with standard output redirected to F</tmp/log>
203	the communications socket. It is usually faster than fork+exec, but still	234	and standard error redirected to the communications socket. It is usually
204	let's you prepare the environment.	235	faster than fork+exec, but still lets you prepare the environment.
205		236
206	open my $output, ">/tmp/log" or die "$!";	237	open my $output, ">/tmp/log" or die "$!";
207		238
208	AnyEvent::Fork	239	AnyEvent::Fork
209	->new	240	->new
210	->eval ('	241	->eval ('
		242	# compile a helper function for later use
211	sub run {	243	sub run {
212	my ($fh, $output, @cmd) = @_;	244	my ($fh, $output, @cmd) = @_;
213		245
214	# perl will clear close-on-exec on STDOUT/STDERR	246	# perl will clear close-on-exec on STDOUT/STDERR
215	open STDOUT, ">&", $output or die;	247	open STDOUT, ">&", $output or die;
…		…
222	->send_arg ("/bin/echo", "hi")	254	->send_arg ("/bin/echo", "hi")
223	->run ("run", my $cv = AE::cv);	255	->run ("run", my $cv = AE::cv);
224		256
225	my $stderr = $cv->recv;	257	my $stderr = $cv->recv;
226		258
		259	=head2 For stingy users: put the worker code into a C<DATA> section.
		260
		261	When you want to be stingy with files, you cna put your code into the
		262	C<DATA> section of your module (or program):
		263
		264	use AnyEvent::Fork;
		265
		266	AnyEvent::Fork
		267	->new
		268	->eval (do { local $/; <DATA> })
		269	->run ("doit", sub { ... });
		270
		271	__DATA__
		272
		273	sub doit {
		274	... do something!
		275	}
		276
		277	=head2 For stingy standalone programs: do not rely on external files at
		278	all.
		279
		280	For single-file scripts it can be inconvenient to rely on external
		281	files - even when using < C<DATA> section, you still need to C<exec>
		282	an external perl interpreter, which might not be available when using
		283	L<App::Staticperl>, L<Urlader> or L<PAR::Packer> for example.
		284
		285	Two modules help here - L<AnyEvent::Fork::Early> forks a template process
		286	for all further calls to C<new_exec>, and L<AnyEvent::Fork::Template>
		287	forks the main program as a template process.
		288
		289	Here is how your main program should look like:
		290
		291	#! perl
		292
		293	# optional, as the very first thing.
		294	# in case modules want to create their own processes.
		295	use AnyEvent::Fork::Early;
		296
		297	# next, load all modules you need in your template process
		298	use Example::My::Module
		299	use Example::Whatever;
		300
		301	# next, put your run function definition and anything else you
		302	# need, but do not use code outside of BEGIN blocks.
		303	sub worker_run {
		304	my ($fh, @args) = @_;
		305	...
		306	}
		307
		308	# now preserve everything so far as AnyEvent::Fork object
		309	# in §TEMPLATE.
		310	use AnyEvent::Fork::Template;
		311
		312	# do not put code outside of BEGIN blocks until here
		313
		314	# now use the $TEMPLATE process in any way you like
		315
		316	# for example: create 10 worker processes
		317	my @worker;
		318	my $cv = AE::cv;
		319	for (1..10) {
		320	$cv->begin;
		321	$TEMPLATE->fork->send_arg ($_)->run ("worker_run", sub {
		322	push @worker, shift;
		323	$cv->end;
		324	});
		325	}
		326	$cv->recv;
		327
227	=head1 CONCEPTS	328	=head1 CONCEPTS
228		329
229	This module can create new processes either by executing a new perl	330	This module can create new processes either by executing a new perl
230	process, or by forking from an existing "template" process.	331	process, or by forking from an existing "template" process.
		332
		333	All these processes are called "child processes" (whether they are direct
		334	children or not), while the process that manages them is called the
		335	"parent process".
231		336
232	Each such process comes with its own file handle that can be used to	337	Each such process comes with its own file handle that can be used to
233	communicate with it (it's actually a socket - one end in the new process,	338	communicate with it (it's actually a socket - one end in the new process,
234	one end in the main process), and among the things you can do in it are	339	one end in the main process), and among the things you can do in it are
235	load modules, fork new processes, send file handles to it, and execute	340	load modules, fork new processes, send file handles to it, and execute
…		…
309	my ($fork_fh) = @_;	414	my ($fork_fh) = @_;
310	});	415	});
311		416
312	=back	417	=back
313		418
314	=head1 FUNCTIONS	419	=head1 THE C<AnyEvent::Fork> CLASS
		420
		421	This module exports nothing, and only implements a single class -
		422	C<AnyEvent::Fork>.
		423
		424	There are two class constructors that both create new processes - C<new>
		425	and C<new_exec>. The C<fork> method creates a new process by forking an
		426	existing one and could be considered a third constructor.
		427
		428	Most of the remaining methods deal with preparing the new process, by
		429	loading code, evaluating code and sending data to the new process. They
		430	usually return the process object, so you can chain method calls.
		431
		432	If a process object is destroyed before calling its C<run> method, then
		433	the process simply exits. After C<run> is called, all responsibility is
		434	passed to the specified function.
		435
		436	As long as there is any outstanding work to be done, process objects
		437	resist being destroyed, so there is no reason to store them unless you
		438	need them later - configure and forget works just fine.
315		439
316	=over 4	440	=over 4
317		441
318	=cut	442	=cut
319		443
…		…
326	use AnyEvent;	450	use AnyEvent;
327	use AnyEvent::Util ();	451	use AnyEvent::Util ();
328		452
329	use IO::FDPass;	453	use IO::FDPass;
330		454
331	our $VERSION = 0.5;	455	our $VERSION = 1.1;
332
333	our $PERL; # the path to the perl interpreter, deduces with various forms of magic
334
335	=item my $pool = new AnyEvent::Fork key => value...
336
337	Create a new process pool. The following named parameters are supported:
338
339	=over 4
340
341	=back
342
343	=cut
344		456
345	# the early fork template process	457	# the early fork template process
346	our $EARLY;	458	our $EARLY;
347		459
348	# the empty template process	460	# the empty template process
349	our $TEMPLATE;	461	our $TEMPLATE;
		462
		463	sub QUEUE() { 0 }
		464	sub FH() { 1 }
		465	sub WW() { 2 }
		466	sub PID() { 3 }
		467	sub CB() { 4 }
		468
		469	sub _new {
		470	my ($self, $fh, $pid) = @_;
		471
		472	AnyEvent::Util::fh_nonblocking $fh, 1;
		473
		474	$self = bless [
		475	[], # write queue - strings or fd's
		476	$fh,
		477	undef, # AE watcher
		478	$pid,
		479	], $self;
		480
		481	$self
		482	}
350		483
351	sub _cmd {	484	sub _cmd {
352	my $self = shift;	485	my $self = shift;
353		486
354	# ideally, we would want to use "a (w/a)*" as format string, but perl	487	# ideally, we would want to use "a (w/a)*" as format string, but perl
355	# versions from at least 5.8.9 to 5.16.3 are all buggy and can't unpack	488	# versions from at least 5.8.9 to 5.16.3 are all buggy and can't unpack
356	# it.	489	# it.
357	push @{ $self->[2] }, pack "a L/a*", $_[0], $_[1];	490	push @{ $self->[QUEUE] }, pack "a L/a*", $_[0], $_[1];
358		491
359	$self->[3] \|\|= AE::io $self->[1], 1, sub {	492	$self->[WW] \|\|= AE::io $self->[FH], 1, sub {
360	do {	493	do {
361	# send the next "thing" in the queue - either a reference to an fh,	494	# send the next "thing" in the queue - either a reference to an fh,
362	# or a plain string.	495	# or a plain string.
363		496
364	if (ref $self->[2][0]) {	497	if (ref $self->[QUEUE][0]) {
365	# send fh	498	# send fh
366	unless (IO::FDPass::send fileno $self->[1], fileno ${ $self->[2][0] }) {	499	unless (IO::FDPass::send fileno $self->[FH], fileno ${ $self->[QUEUE][0] }) {
367	return if $! == Errno::EAGAIN \|\| $! == Errno::EWOULDBLOCK;	500	return if $! == Errno::EAGAIN \|\| $! == Errno::EWOULDBLOCK;
368	undef $self->[3];	501	undef $self->[WW];
369	die "AnyEvent::Fork: file descriptor send failure: $!";	502	die "AnyEvent::Fork: file descriptor send failure: $!";
370	}	503	}
371		504
372	shift @{ $self->[2] };	505	shift @{ $self->[QUEUE] };
373		506
374	} else {	507	} else {
375	# send string	508	# send string
376	my $len = syswrite $self->[1], $self->[2][0];	509	my $len = syswrite $self->[FH], $self->[QUEUE][0];
377		510
378	unless ($len) {	511	unless ($len) {
379	return if $! == Errno::EAGAIN \|\| $! == Errno::EWOULDBLOCK;	512	return if $! == Errno::EAGAIN \|\| $! == Errno::EWOULDBLOCK;
380	undef $self->[3];	513	undef $self->[WW];
381	die "AnyEvent::Fork: command write failure: $!";	514	die "AnyEvent::Fork: command write failure: $!";
382	}	515	}
383		516
384	substr $self->[2][0], 0, $len, "";	517	substr $self->[QUEUE][0], 0, $len, "";
385	shift @{ $self->[2] } unless length $self->[2][0];	518	shift @{ $self->[QUEUE] } unless length $self->[QUEUE][0];
386	}	519	}
387	} while @{ $self->[2] };	520	} while @{ $self->[QUEUE] };
388		521
389	# everything written	522	# everything written
390	undef $self->[3];	523	undef $self->[WW];
391		524
392	# invoke run callback, if any	525	# invoke run callback, if any
393	$self->[4]->($self->[1]) if $self->[4];	526	if ($self->[CB]) {
		527	$self->[CB]->($self->[FH]);
		528	@$self = ();
		529	}
394	};	530	};
395		531
396	() # make sure we don't leak the watcher	532	() # make sure we don't leak the watcher
397	}
398
399	sub _new {
400	my ($self, $fh, $pid) = @_;
401
402	AnyEvent::Util::fh_nonblocking $fh, 1;
403
404	$self = bless [
405	$pid,
406	$fh,
407	[], # write queue - strings or fd's
408	undef, # AE watcher
409	], $self;
410
411	$self
412	}	533	}
413		534
414	# fork template from current process, used by AnyEvent::Fork::Early/Template	535	# fork template from current process, used by AnyEvent::Fork::Early/Template
415	sub _new_fork {	536	sub _new_fork {
416	my ($fh, $slave) = AnyEvent::Util::portable_socketpair;	537	my ($fh, $slave) = AnyEvent::Util::portable_socketpair;
…		…
421	if ($pid eq 0) {	542	if ($pid eq 0) {
422	require AnyEvent::Fork::Serve;	543	require AnyEvent::Fork::Serve;
423	$AnyEvent::Fork::Serve::OWNER = $parent;	544	$AnyEvent::Fork::Serve::OWNER = $parent;
424	close $fh;	545	close $fh;
425	$0 = "$_[1] of $parent";	546	$0 = "$_[1] of $parent";
426	$SIG{CHLD} = 'IGNORE';
427	AnyEvent::Fork::Serve::serve ($slave);	547	AnyEvent::Fork::Serve::serve ($slave);
428	exit 0;	548	exit 0;
429	} elsif (!$pid) {	549	} elsif (!$pid) {
430	die "AnyEvent::Fork::Early/Template: unable to fork template process: $!";	550	die "AnyEvent::Fork::Early/Template: unable to fork template process: $!";
431	}	551	}
…		…
438	Create a new "empty" perl interpreter process and returns its process	558	Create a new "empty" perl interpreter process and returns its process
439	object for further manipulation.	559	object for further manipulation.
440		560
441	The new process is forked from a template process that is kept around	561	The new process is forked from a template process that is kept around
442	for this purpose. When it doesn't exist yet, it is created by a call to	562	for this purpose. When it doesn't exist yet, it is created by a call to
443	C<new_exec> and kept around for future calls.	563	C<new_exec> first and then stays around for future calls.
444
445	When the process object is destroyed, it will release the file handle
446	that connects it with the new process. When the new process has not yet
447	called C<run>, then the process will exit. Otherwise, what happens depends
448	entirely on the code that is executed.
449		564
450	=cut	565	=cut
451		566
452	sub new {	567	sub new {
453	my $class = shift;	568	my $class = shift;
…		…
490		605
491	You should use C<new> whenever possible, except when having a template	606	You should use C<new> whenever possible, except when having a template
492	process around is unacceptable.	607	process around is unacceptable.
493		608
494	The path to the perl interpreter is divined using various methods - first	609	The path to the perl interpreter is divined using various methods - first
495	C<$^X> is investigated to see if the path ends with something that sounds	610	C<$^X> is investigated to see if the path ends with something that looks
496	as if it were the perl interpreter. Failing this, the module falls back to	611	as if it were the perl interpreter. Failing this, the module falls back to
497	using C<$Config::Config{perlpath}>.	612	using C<$Config::Config{perlpath}>.
498		613
		614	The path to perl can also be overriden by setting the global variable
		615	C<$AnyEvent::Fork::PERL> - it's value will be used for all subsequent
		616	invocations.
		617
499	=cut	618	=cut
		619
		620	our $PERL;
500		621
501	sub new_exec {	622	sub new_exec {
502	my ($self) = @_;	623	my ($self) = @_;
503		624
504	return $EARLY->fork	625	return $EARLY->fork
505	if $EARLY;	626	if $EARLY;
506		627
		628	unless (defined $PERL) {
507	# first find path of perl	629	# first find path of perl
508	my $perl = $;	630	my $perl = $;
509		631
510	# first we try $^X, but the path must be absolute (always on win32), and end in sth.	632	# first we try $^X, but the path must be absolute (always on win32), and end in sth.
511	# that looks like perl. this obviously only works for posix and win32	633	# that looks like perl. this obviously only works for posix and win32
512	unless (	634	unless (
513	($^O eq "MSWin32" \|\| $perl =~ m%^/%)	635	($^O eq "MSWin32" \|\| $perl =~ m%^/%)
514	&& $perl =~ m%[/\\]perl(?:[0-9]+(\.[0-9]+)+)?(\.exe)?$%i	636	&& $perl =~ m%[/\\]perl(?:[0-9]+(\.[0-9]+)+)?(\.exe)?$%i
515	) {	637	) {
516	# if it doesn't look perlish enough, try Config	638	# if it doesn't look perlish enough, try Config
517	require Config;	639	require Config;
518	$perl = $Config::Config{perlpath};	640	$perl = $Config::Config{perlpath};
519	$perl =~ s/(?:\Q$Config::Config{_exe}\E)?$/$Config::Config{_exe}/;	641	$perl =~ s/(?:\Q$Config::Config{_exe}\E)?$/$Config::Config{_exe}/;
		642	}
		643
		644	$PERL = $perl;
520	}	645	}
521		646
522	require Proc::FastSpawn;	647	require Proc::FastSpawn;
523		648
524	my ($fh, $slave) = AnyEvent::Util::portable_socketpair;	649	my ($fh, $slave) = AnyEvent::Util::portable_socketpair;
…		…
532	#local $ENV{PERL5LIB} = join ":", grep !ref, @INC;	657	#local $ENV{PERL5LIB} = join ":", grep !ref, @INC;
533	my %env = %ENV;	658	my %env = %ENV;
534	$env{PERL5LIB} = join +($^O eq "MSWin32" ? ";" : ":"), grep !ref, @INC;	659	$env{PERL5LIB} = join +($^O eq "MSWin32" ? ";" : ":"), grep !ref, @INC;
535		660
536	my $pid = Proc::FastSpawn::spawn (	661	my $pid = Proc::FastSpawn::spawn (
537	$perl,	662	$PERL,
538	["perl", "-MAnyEvent::Fork::Serve", "-e", "AnyEvent::Fork::Serve::me", fileno $slave, $$],	663	["perl", "-MAnyEvent::Fork::Serve", "-e", "AnyEvent::Fork::Serve::me", fileno $slave, $$],
539	[map "$_=$env{$_}", keys %env],	664	[map "$_=$env{$_}", keys %env],
540	) or die "unable to spawn AnyEvent::Fork server: $!";	665	) or die "unable to spawn AnyEvent::Fork server: $!";
541		666
542	$self->_new ($fh, $pid)	667	$self->_new ($fh, $pid)
543	}	668	}
544		669
545	=item $pid = $proc->pid	670	=item $pid = $proc->pid
546		671
547	Returns the process id of the process I<iff it is a direct child of the	672	Returns the process id of the process I<iff it is a direct child of the
548	process> running AnyEvent::Fork, and C<undef> otherwise.	673	process running AnyEvent::Fork>, and C<undef> otherwise.
549		674
550	Normally, only processes created via C<< AnyEvent::Fork->new_exec >> and	675	Normally, only processes created via C<< AnyEvent::Fork->new_exec >> and
551	L<AnyEvent::Fork::Template> are direct children, and you are responsible	676	L<AnyEvent::Fork::Template> are direct children, and you are responsible
552	to clean up their zombies when they die.	677	to clean up their zombies when they die.
553		678
554	All other processes are not direct children, and will be cleaned up by	679	All other processes are not direct children, and will be cleaned up by
555	AnyEvent::Fork.	680	AnyEvent::Fork itself.
556		681
557	=cut	682	=cut
558		683
559	sub pid {	684	sub pid {
560	$_[0][0]	685	$_[0][PID]
561	}	686	}
562		687
563	=item $proc = $proc->eval ($perlcode, @args)	688	=item $proc = $proc->eval ($perlcode, @args)
564		689
565	Evaluates the given C<$perlcode> as ... perl code, while setting C<@_> to	690	Evaluates the given C<$perlcode> as ... Perl code, while setting C<@_> to
566	the strings specified by C<@args>, in the "main" package.	691	the strings specified by C<@args>, in the "main" package.
567		692
568	This call is meant to do any custom initialisation that might be required	693	This call is meant to do any custom initialisation that might be required
569	(for example, the C<require> method uses it). It's not supposed to be used	694	(for example, the C<require> method uses it). It's not supposed to be used
570	to completely take over the process, use C<run> for that.	695	to completely take over the process, use C<run> for that.
571		696
572	The code will usually be executed after this call returns, and there is no	697	The code will usually be executed after this call returns, and there is no
573	way to pass anything back to the calling process. Any evaluation errors	698	way to pass anything back to the calling process. Any evaluation errors
574	will be reported to stderr and cause the process to exit.	699	will be reported to stderr and cause the process to exit.
575		700
576	If you want to execute some code to take over the process (see the	701	If you want to execute some code (that isn't in a module) to take over the
577	"fork+exec" example in the SYNOPSIS), you should compile a function via	702	process, you should compile a function via C<eval> first, and then call
578	C<eval> first, and then call it via C<run>. This also gives you access to	703	it via C<run>. This also gives you access to any arguments passed via the
579	any arguments passed via the C<send_xxx> methods, such as file handles.	704	C<send_xxx> methods, such as file handles. See the L<use AnyEvent::Fork as
		705	a faster fork+exec> example to see it in action.
580		706
581	Returns the process object for easy chaining of method calls.	707	Returns the process object for easy chaining of method calls.
582		708
583	=cut	709	=cut
584		710
…		…
610	=item $proc = $proc->send_fh ($handle, ...)	736	=item $proc = $proc->send_fh ($handle, ...)
611		737
612	Send one or more file handles (I<not> file descriptors) to the process,	738	Send one or more file handles (I<not> file descriptors) to the process,
613	to prepare a call to C<run>.	739	to prepare a call to C<run>.
614		740
615	The process object keeps a reference to the handles until this is done,	741	The process object keeps a reference to the handles until they have
616	so you must not explicitly close the handles. This is most easily	742	been passed over to the process, so you must not explicitly close the
617	accomplished by simply not storing the file handles anywhere after passing	743	handles. This is most easily accomplished by simply not storing the file
618	them to this method.	744	handles anywhere after passing them to this method - when AnyEvent::Fork
		745	is finished using them, perl will automatically close them.
619		746
620	Returns the process object for easy chaining of method calls.	747	Returns the process object for easy chaining of method calls.
621		748
622	Example: pass a file handle to a process, and release it without	749	Example: pass a file handle to a process, and release it without
623	closing. It will be closed automatically when it is no longer used.	750	closing. It will be closed automatically when it is no longer used.
…		…
630	sub send_fh {	757	sub send_fh {
631	my ($self, @fh) = @_;	758	my ($self, @fh) = @_;
632		759
633	for my $fh (@fh) {	760	for my $fh (@fh) {
634	$self->_cmd ("h");	761	$self->_cmd ("h");
635	push @{ $self->[2] }, \$fh;	762	push @{ $self->[QUEUE] }, \$fh;
636	}	763	}
637		764
638	$self	765	$self
639	}	766	}
640		767
641	=item $proc = $proc->send_arg ($string, ...)	768	=item $proc = $proc->send_arg ($string, ...)
642		769
643	Send one or more argument strings to the process, to prepare a call to	770	Send one or more argument strings to the process, to prepare a call to
644	C<run>. The strings can be any octet string.	771	C<run>. The strings can be any octet strings.
645		772
646	The protocol is optimised to pass a moderate number of relatively short	773	The protocol is optimised to pass a moderate number of relatively short
647	strings - while you can pass up to 4GB of data in one go, this is more	774	strings - while you can pass up to 4GB of data in one go, this is more
648	meant to pass some ID information or other startup info, not big chunks of	775	meant to pass some ID information or other startup info, not big chunks of
649	data.	776	data.
…		…
665	Enter the function specified by the function name in C<$func> in the	792	Enter the function specified by the function name in C<$func> in the
666	process. The function is called with the communication socket as first	793	process. The function is called with the communication socket as first
667	argument, followed by all file handles and string arguments sent earlier	794	argument, followed by all file handles and string arguments sent earlier
668	via C<send_fh> and C<send_arg> methods, in the order they were called.	795	via C<send_fh> and C<send_arg> methods, in the order they were called.
669		796
		797	The process object becomes unusable on return from this function - any
		798	further method calls result in undefined behaviour.
		799
670	The function name should be fully qualified, but if it isn't, it will be	800	The function name should be fully qualified, but if it isn't, it will be
671	looked up in the main package.	801	looked up in the C<main> package.
672		802
673	If the called function returns, doesn't exist, or any error occurs, the	803	If the called function returns, doesn't exist, or any error occurs, the
674	process exits.	804	process exits.
675		805
676	Preparing the process is done in the background - when all commands have	806	Preparing the process is done in the background - when all commands have
677	been sent, the callback is invoked with the local communications socket	807	been sent, the callback is invoked with the local communications socket
678	as argument. At this point you can start using the socket in any way you	808	as argument. At this point you can start using the socket in any way you
679	like.	809	like.
680
681	The process object becomes unusable on return from this function - any
682	further method calls result in undefined behaviour.
683		810
684	If the communication socket isn't used, it should be closed on both sides,	811	If the communication socket isn't used, it should be closed on both sides,
685	to save on kernel memory.	812	to save on kernel memory.
686		813
687	The socket is non-blocking in the parent, and blocking in the newly	814	The socket is non-blocking in the parent, and blocking in the newly
…		…
726	=cut	853	=cut
727		854
728	sub run {	855	sub run {
729	my ($self, $func, $cb) = @_;	856	my ($self, $func, $cb) = @_;
730		857
731	$self->[4] = $cb;	858	$self->[CB] = $cb;
732	$self->_cmd (r => $func);	859	$self->_cmd (r => $func);
		860	}
		861
		862	=back
		863
		864	=head2 EXPERIMENTAL METHODS
		865
		866	These methods might go away completely or change behaviour, at any time.
		867
		868	=over 4
		869
		870	=item $proc->to_fh ($cb->($fh)) # EXPERIMENTAL, MIGHT BE REMOVED
		871
		872	Flushes all commands out to the process and then calls the callback with
		873	the communications socket.
		874
		875	The process object becomes unusable on return from this function - any
		876	further method calls result in undefined behaviour.
		877
		878	The point of this method is to give you a file handle thta you cna pass
		879	to another process. In that other process, you can call C<new_from_fh
		880	AnyEvent::Fork> to create a new C<AnyEvent::Fork> object from it, thereby
		881	effectively passing a fork object to another process.
		882
		883	=cut
		884
		885	sub to_fh {
		886	my ($self, $cb) = @_;
		887
		888	$self->[CB] = $cb;
		889
		890	unless ($self->[WW]) {
		891	$self->[CB]->($self->[FH]);
		892	@$self = ();
		893	}
		894	}
		895
		896	=item new_from_fh AnyEvent::Fork $fh # EXPERIMENTAL, MIGHT BE REMOVED
		897
		898	Takes a file handle originally rceeived by the C<to_fh> method and creates
		899	a new C<AnyEvent:Fork> object. The child process itself will not change in
		900	any way, i.e. it will keep all the modifications done to it before calling
		901	C<to_fh>.
		902
		903	The new object is very much like the original object, except that the
		904	C<pid> method will return C<undef> even if the process is a direct child.
		905
		906	=cut
		907
		908	sub new_from_fh {
		909	my ($class, $fh) = @_;
		910
		911	$class->_new ($fh)
733	}	912	}
734		913
735	=back	914	=back
736		915
737	=head1 PERFORMANCE	916	=head1 PERFORMANCE
…		…
747		926
748	2079 new processes per second, using manual socketpair + fork	927	2079 new processes per second, using manual socketpair + fork
749		928
750	Then I did the same thing, but instead of calling fork, I called	929	Then I did the same thing, but instead of calling fork, I called
751	AnyEvent::Fork->new->run ("CORE::exit") and then again waited for the	930	AnyEvent::Fork->new->run ("CORE::exit") and then again waited for the
752	socket form the child to close on exit. This does the same thing as manual	931	socket from the child to close on exit. This does the same thing as manual
753	socket pair + fork, except that what is forked is the template process	932	socket pair + fork, except that what is forked is the template process
754	(2440kB), and the socket needs to be passed to the server at the other end	933	(2440kB), and the socket needs to be passed to the server at the other end
755	of the socket first.	934	of the socket first.
756		935
757	2307 new processes per second, using AnyEvent::Fork->new	936	2307 new processes per second, using AnyEvent::Fork->new
…		…
762	479 vfork+execs per second, using AnyEvent::Fork->new_exec	941	479 vfork+execs per second, using AnyEvent::Fork->new_exec
763		942
764	So how can C<< AnyEvent->new >> be faster than a standard fork, even	943	So how can C<< AnyEvent->new >> be faster than a standard fork, even
765	though it uses the same operations, but adds a lot of overhead?	944	though it uses the same operations, but adds a lot of overhead?
766		945
767	The difference is simply the process size: forking the 6MB process takes	946	The difference is simply the process size: forking the 5MB process takes
768	so much longer than forking the 2.5MB template process that the overhead	947	so much longer than forking the 2.5MB template process that the extra
769	introduced is canceled out.	948	overhead is canceled out.
770		949
771	If the benchmark process grows, the normal fork becomes even slower:	950	If the benchmark process grows, the normal fork becomes even slower:
772		951
773	1340 new processes, manual fork in a 20MB process	952	1340 new processes, manual fork of a 20MB process
774	731 new processes, manual fork in a 200MB process	953	731 new processes, manual fork of a 200MB process
775	235 new processes, manual fork in a 2000MB process	954	235 new processes, manual fork of a 2000MB process
776		955
777	What that means (to me) is that I can use this module without having a	956	What that means (to me) is that I can use this module without having a bad
778	very bad conscience because of the extra overhead required to start new	957	conscience because of the extra overhead required to start new processes.
779	processes.
780		958
781	=head1 TYPICAL PROBLEMS	959	=head1 TYPICAL PROBLEMS
782		960
783	This section lists typical problems that remain. I hope by recognising	961	This section lists typical problems that remain. I hope by recognising
784	them, most can be avoided.	962	them, most can be avoided.
785		963
786	=over 4	964	=over 4
787		965
788	=item "leaked" file descriptors for exec'ed processes	966	=item leaked file descriptors for exec'ed processes
789		967
790	POSIX systems inherit file descriptors by default when exec'ing a new	968	POSIX systems inherit file descriptors by default when exec'ing a new
791	process. While perl itself laudably sets the close-on-exec flags on new	969	process. While perl itself laudably sets the close-on-exec flags on new
792	file handles, most C libraries don't care, and even if all cared, it's	970	file handles, most C libraries don't care, and even if all cared, it's
793	often not possible to set the flag in a race-free manner.	971	often not possible to set the flag in a race-free manner.
…		…
813	libraries or the code that leaks those file descriptors.	991	libraries or the code that leaks those file descriptors.
814		992
815	Fortunately, most of these leaked descriptors do no harm, other than	993	Fortunately, most of these leaked descriptors do no harm, other than
816	sitting on some resources.	994	sitting on some resources.
817		995
818	=item "leaked" file descriptors for fork'ed processes	996	=item leaked file descriptors for fork'ed processes
819		997
820	Normally, L<AnyEvent::Fork> does start new processes by exec'ing them,	998	Normally, L<AnyEvent::Fork> does start new processes by exec'ing them,
821	which closes file descriptors not marked for being inherited.	999	which closes file descriptors not marked for being inherited.
822		1000
823	However, L<AnyEvent::Fork::Early> and L<AnyEvent::Fork::Template> offer	1001	However, L<AnyEvent::Fork::Early> and L<AnyEvent::Fork::Template> offer
…		…
832		1010
833	The solution is to either not load these modules before use'ing	1011	The solution is to either not load these modules before use'ing
834	L<AnyEvent::Fork::Early> or L<AnyEvent::Fork::Template>, or to delay	1012	L<AnyEvent::Fork::Early> or L<AnyEvent::Fork::Template>, or to delay
835	initialising them, for example, by calling C<init Gtk2> manually.	1013	initialising them, for example, by calling C<init Gtk2> manually.
836		1014
837	=item exit runs destructors	1015	=item exiting calls object destructors
838		1016
839	This only applies to users of Lc<AnyEvent::Fork:Early> and	1017	This only applies to users of L<AnyEvent::Fork:Early> and
840	L<AnyEvent::Fork::Template>.	1018	L<AnyEvent::Fork::Template>, or when initialising code creates objects
		1019	that reference external resources.
841		1020
842	When a process created by AnyEvent::Fork exits, it might do so by calling	1021	When a process created by AnyEvent::Fork exits, it might do so by calling
843	exit, or simply letting perl reach the end of the program. At which point	1022	exit, or simply letting perl reach the end of the program. At which point
844	Perl runs all destructors.	1023	Perl runs all destructors.
845		1024
…		…
864	to make it so, mostly due to the bloody broken perl that nobody seems to	1043	to make it so, mostly due to the bloody broken perl that nobody seems to
865	care about. The fork emulation is a bad joke - I have yet to see something	1044	care about. The fork emulation is a bad joke - I have yet to see something
866	useful that you can do with it without running into memory corruption	1045	useful that you can do with it without running into memory corruption
867	issues or other braindamage. Hrrrr.	1046	issues or other braindamage. Hrrrr.
868		1047
869	Cygwin perl is not supported at the moment, as it should implement fd	1048	Since fork is endlessly broken on win32 perls (it doesn't even remotely
870	passing, but doesn't, and rolling my own is hard, as cygwin doesn't	1049	work within it's documented limits) and quite obviously it's not getting
871	support enough functionality to do it.	1050	improved any time soon, the best way to proceed on windows would be to
		1051	always use C<new_exec> and thus never rely on perl's fork "emulation".
		1052
		1053	Cygwin perl is not supported at the moment due to some hilarious
		1054	shortcomings of its API - see L<IO::FDPoll> for more details. If you never
		1055	use C<send_fh> and always use C<new_exec> to create processes, it should
		1056	work though.
872		1057
873	=head1 SEE ALSO	1058	=head1 SEE ALSO
874		1059
875	L<AnyEvent::Fork::Early> (to avoid executing a perl interpreter),	1060	L<AnyEvent::Fork::Early>, to avoid executing a perl interpreter at all
		1061	(part of this distribution).
		1062
876	L<AnyEvent::Fork::Template> (to create a process by forking the main	1063	L<AnyEvent::Fork::Template>, to create a process by forking the main
877	program at a convenient time).	1064	program at a convenient time (part of this distribution).
878		1065
879	=head1 AUTHOR	1066	L<AnyEvent::Fork::Remote>, for another way to create processes that is
		1067	mostly compatible to this module and modules building on top of it, but
		1068	works better with remote processes.
		1069
		1070	L<AnyEvent::Fork::RPC>, for simple RPC to child processes (on CPAN).
		1071
		1072	L<AnyEvent::Fork::Pool>, for simple worker process pool (on CPAN).
		1073
		1074	=head1 AUTHOR AND CONTACT INFORMATION
880		1075
881	Marc Lehmann <schmorp@schmorp.de>	1076	Marc Lehmann <schmorp@schmorp.de>
882	http://home.schmorp.de/	1077	http://software.schmorp.de/pkg/AnyEvent-Fork
883		1078
884	=cut	1079	=cut
885		1080
886	1	1081	1
887		1082

Diff Legend

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

Comparing AnyEvent-Fork/Fork.pm (file contents): Revision 1.26 by root, Sat Apr 6 08:58:51 2013 UTC vs. Revision 1.57 by root, Sun Aug 25 17:38:43 2013 UTC

Diff Legend

Comparing AnyEvent-Fork/Fork.pm (file contents):
Revision 1.26 by root, Sat Apr 6 08:58:51 2013 UTC vs.
Revision 1.57 by root, Sun Aug 25 17:38:43 2013 UTC