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

Comparing AnyEvent-Fork/Fork.pm (file contents):
Revision 1.39 by root, Sat Apr 6 22:39:37 2013 UTC vs.
Revision 1.69 by root, Sat Nov 5 19:12:15 2016 UTC

…		…
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,	42
43	and so on.	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.
44		51
45	=head2 COMPARISON TO OTHER MODULES	52	=head2 COMPARISON TO OTHER MODULES
46		53
47	There is an abundance of modules on CPAN that do "something fork", such as	54	There is an abundance of modules on CPAN that do "something fork", such as
48	L<Parallel::ForkManager>, L<AnyEvent::ForkManager>, L<AnyEvent::Worker>	55	L<Parallel::ForkManager>, L<AnyEvent::ForkManager>, L<AnyEvent::Worker>
49	or L<AnyEvent::Subprocess>. There are modules that implement their own	56	or L<AnyEvent::Subprocess>. There are modules that implement their own
50	process management, such as L<AnyEvent::DBI>.	57	process management, such as L<AnyEvent::DBI>.
51		58
52	The problems that all these modules try to solve are real, however, none	59	The problems that all these modules try to solve are real, however, none
53	of them (from what I have seen) tackle the very real problems of unwanted	60	of them (from what I have seen) tackle the very real problems of unwanted
54	memory sharing, efficiency, not being able to use event processing or	61	memory sharing, efficiency or not being able to use event processing, GUI
55	similar modules in the processes they create.	62	toolkits or similar modules in the processes they create.
56		63
57	This module doesn't try to replace any of them - instead it tries to solve	64	This module doesn't try to replace any of them - instead it tries to solve
58	the problem of creating processes with a minimum of fuss and overhead (and	65	the problem of creating processes with a minimum of fuss and overhead (and
59	also luxury). Ideally, most of these would use AnyEvent::Fork internally,	66	also luxury). Ideally, most of these would use AnyEvent::Fork internally,
60	except they were written before AnyEvent:Fork was available, so obviously	67	except they were written before AnyEvent:Fork was available, so obviously
…		…
82		89
83	=item Forking usually creates a copy-on-write copy of the parent	90	=item Forking usually creates a copy-on-write copy of the parent
84	process.	91	process.
85		92
86	For example, modules or data files that are loaded will not use additional	93	For example, modules or data files that are loaded will not use additional
87	memory after a fork. When exec'ing a new process, modules and data files	94	memory after a fork. Exec'ing a new process, in contrast, means modules
88	might need to be loaded again, at extra CPU and memory cost. But when	95	and data files might need to be loaded again, at extra CPU and memory
89	forking, literally all data structures are copied - if the program frees	96	cost.
		97
		98	But when forking, you still create a copy of your data structures - if
90	them and replaces them by new data, the child processes will retain the	99	the program frees them and replaces them by new data, the child processes
91	old version even if it isn't used, which can suddenly and unexpectedly	100	will retain the old version even if it isn't used, which can suddenly and
92	increase memory usage when freeing memory.	101	unexpectedly increase memory usage when freeing memory.
93		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
94	The trade-off is between more sharing with fork (which can be good or	112	There is a trade-off between more sharing with fork (which can be good or
95	bad), and no sharing with exec.	113	bad), and no sharing with exec.
96		114
97	This module allows the main program to do a controlled fork, and allows	115	This module allows the main program to do a controlled fork, and allows
98	modules to exec processes safely at any time. When creating a custom	116	modules to exec processes safely at any time. When creating a custom
99	process pool you can take advantage of data sharing via fork without	117	process pool you can take advantage of data sharing via fork without
…		…
104	shared and what isn't, at all times.	122	shared and what isn't, at all times.
105		123
106	=item Exec'ing a new perl process might be difficult.	124	=item Exec'ing a new perl process might be difficult.
107		125
108	For example, it is not easy to find the correct path to the perl	126	For example, it is not easy to find the correct path to the perl
109	interpreter - C<$^X> might not be a perl interpreter at all.	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.
110		129
111	This module tries hard to identify the correct path to the perl	130	This module tries hard to identify the correct path to the perl
112	interpreter. With a cooperative main program, exec'ing the interpreter	131	interpreter. With a cooperative main program, exec'ing the interpreter
113	might not even be necessary, but even without help from the main program,	132	might not even be necessary, but even without help from the main program,
114	it will still work when used from a module.	133	it will still work when used from a module.
…		…
120	and modules are no longer loadable because they refer to a different	139	and modules are no longer loadable because they refer to a different
121	perl version, or parts of a distribution are newer than the ones already	140	perl version, or parts of a distribution are newer than the ones already
122	loaded.	141	loaded.
123		142
124	This module supports creating pre-initialised perl processes to be used as	143	This module supports creating pre-initialised perl processes to be used as
125	a template for new processes.	144	a template for new processes at a later time, e.g. for use in a process
		145	pool.
126		146
127	=item Forking might be impossible when a program is running.	147	=item Forking might be impossible when a program is running.
128		148
129	For example, POSIX makes it almost impossible to fork from a	149	For example, POSIX makes it almost impossible to fork from a
130	multi-threaded program while doing anything useful in the child - in	150	multi-threaded program while doing anything useful in the child - in
131	fact, if your perl program uses POSIX threads (even indirectly via	151	fact, if your perl program uses POSIX threads (even indirectly via
132	e.g. L<IO::AIO> or L<threads>), you cannot call fork on the perl level	152	e.g. L<IO::AIO> or L<threads>), you cannot call fork on the perl level
133	anymore without risking corruption issues on a number of operating	153	anymore without risking memory corruption or worse on a number of
134	systems.	154	operating systems.
135		155
136	This module can safely fork helper processes at any time, by calling	156	This module can safely fork helper processes at any time, by calling
137	fork+exec in C, in a POSIX-compatible way (via L<Proc::FastSpawn>).	157	fork+exec in C, in a POSIX-compatible way (via L<Proc::FastSpawn>).
138		158
139	=item Parallel processing with fork might be inconvenient or difficult	159	=item Parallel processing with fork might be inconvenient or difficult
…		…
158		178
159	=back	179	=back
160		180
161	=head1 EXAMPLES	181	=head1 EXAMPLES
162		182
		183	This is where the wall of text ends and code speaks.
		184
163	=head2 Create a single new process, tell it to run your worker function.	185	=head2 Create a single new process, tell it to run your worker function.
164		186
165	AnyEvent::Fork	187	AnyEvent::Fork
166	->new	188	->new
167	->require ("MyModule")	189	->require ("MyModule")
…		…
178		200
179	sub worker {	201	sub worker {
180	my ($slave_filehandle) = @_;	202	my ($slave_filehandle) = @_;
181		203
182	# now $slave_filehandle is connected to the $master_filehandle	204	# now $slave_filehandle is connected to the $master_filehandle
183	# in the original prorcess. have fun!	205	# in the original process. have fun!
184	}	206	}
185		207
186	=head2 Create a pool of server processes all accepting on the same socket.	208	=head2 Create a pool of server processes all accepting on the same socket.
187		209
188	# create listener socket	210	# create listener socket
…		…
221	}	243	}
222	}	244	}
223		245
224	=head2 use AnyEvent::Fork as a faster fork+exec	246	=head2 use AnyEvent::Fork as a faster fork+exec
225		247
226	This runs C</bin/echo hi>, with stdandard output redirected to /tmp/log	248	This runs C</bin/echo hi>, with standard output redirected to F</tmp/log>
227	and standard error redirected to the communications socket. It is usually	249	and standard error redirected to the communications socket. It is usually
228	faster than fork+exec, but still lets you prepare the environment.	250	faster than fork+exec, but still lets you prepare the environment.
229		251
230	open my $output, ">/tmp/log" or die "$!";	252	open my $output, ">/tmp/log" or die "$!";
231		253
232	AnyEvent::Fork	254	AnyEvent::Fork
233	->new	255	->new
234	->eval ('	256	->eval ('
		257	# compile a helper function for later use
235	sub run {	258	sub run {
236	my ($fh, $output, @cmd) = @_;	259	my ($fh, $output, @cmd) = @_;
237		260
238	# perl will clear close-on-exec on STDOUT/STDERR	261	# perl will clear close-on-exec on STDOUT/STDERR
239	open STDOUT, ">&", $output or die;	262	open STDOUT, ">&", $output or die;
…		…
246	->send_arg ("/bin/echo", "hi")	269	->send_arg ("/bin/echo", "hi")
247	->run ("run", my $cv = AE::cv);	270	->run ("run", my $cv = AE::cv);
248		271
249	my $stderr = $cv->recv;	272	my $stderr = $cv->recv;
250		273
		274	=head2 For stingy users: put the worker code into a C<DATA> section.
		275
		276	When you want to be stingy with files, you can put your code into the
		277	C<DATA> section of your module (or program):
		278
		279	use AnyEvent::Fork;
		280
		281	AnyEvent::Fork
		282	->new
		283	->eval (do { local $/; <DATA> })
		284	->run ("doit", sub { ... });
		285
		286	__DATA__
		287
		288	sub doit {
		289	... do something!
		290	}
		291
		292	=head2 For stingy standalone programs: do not rely on external files at
		293	all.
		294
		295	For single-file scripts it can be inconvenient to rely on external
		296	files - even when using a C<DATA> section, you still need to C<exec> an
		297	external perl interpreter, which might not be available when using
		298	L<App::Staticperl>, L<Urlader> or L<PAR::Packer> for example.
		299
		300	Two modules help here - L<AnyEvent::Fork::Early> forks a template process
		301	for all further calls to C<new_exec>, and L<AnyEvent::Fork::Template>
		302	forks the main program as a template process.
		303
		304	Here is how your main program should look like:
		305
		306	#! perl
		307
		308	# optional, as the very first thing.
		309	# in case modules want to create their own processes.
		310	use AnyEvent::Fork::Early;
		311
		312	# next, load all modules you need in your template process
		313	use Example::My::Module
		314	use Example::Whatever;
		315
		316	# next, put your run function definition and anything else you
		317	# need, but do not use code outside of BEGIN blocks.
		318	sub worker_run {
		319	my ($fh, @args) = @_;
		320	...
		321	}
		322
		323	# now preserve everything so far as AnyEvent::Fork object
		324	# in $TEMPLATE.
		325	use AnyEvent::Fork::Template;
		326
		327	# do not put code outside of BEGIN blocks until here
		328
		329	# now use the $TEMPLATE process in any way you like
		330
		331	# for example: create 10 worker processes
		332	my @worker;
		333	my $cv = AE::cv;
		334	for (1..10) {
		335	$cv->begin;
		336	$TEMPLATE->fork->send_arg ($_)->run ("worker_run", sub {
		337	push @worker, shift;
		338	$cv->end;
		339	});
		340	}
		341	$cv->recv;
		342
251	=head1 CONCEPTS	343	=head1 CONCEPTS
252		344
253	This module can create new processes either by executing a new perl	345	This module can create new processes either by executing a new perl
254	process, or by forking from an existing "template" process.	346	process, or by forking from an existing "template" process.
		347
		348	All these processes are called "child processes" (whether they are direct
		349	children or not), while the process that manages them is called the
		350	"parent process".
255		351
256	Each such process comes with its own file handle that can be used to	352	Each such process comes with its own file handle that can be used to
257	communicate with it (it's actually a socket - one end in the new process,	353	communicate with it (it's actually a socket - one end in the new process,
258	one end in the main process), and among the things you can do in it are	354	one end in the main process), and among the things you can do in it are
259	load modules, fork new processes, send file handles to it, and execute	355	load modules, fork new processes, send file handles to it, and execute
…		…
369	use AnyEvent;	465	use AnyEvent;
370	use AnyEvent::Util ();	466	use AnyEvent::Util ();
371		467
372	use IO::FDPass;	468	use IO::FDPass;
373		469
374	our $VERSION = 0.5;	470	our $VERSION = 1.3;
375
376	our $PERL; # the path to the perl interpreter, deduces with various forms of magic
377
378	=over 4
379
380	=back
381
382	=cut
383		471
384	# the early fork template process	472	# the early fork template process
385	our $EARLY;	473	our $EARLY;
386		474
387	# the empty template process	475	# the empty template process
388	our $TEMPLATE;	476	our $TEMPLATE;
		477
		478	sub QUEUE() { 0 }
		479	sub FH() { 1 }
		480	sub WW() { 2 }
		481	sub PID() { 3 }
		482	sub CB() { 4 }
		483
		484	sub _new {
		485	my ($self, $fh, $pid) = @_;
		486
		487	AnyEvent::Util::fh_nonblocking $fh, 1;
		488
		489	$self = bless [
		490	[], # write queue - strings or fd's
		491	$fh,
		492	undef, # AE watcher
		493	$pid,
		494	], $self;
		495
		496	$self
		497	}
389		498
390	sub _cmd {	499	sub _cmd {
391	my $self = shift;	500	my $self = shift;
392		501
393	# ideally, we would want to use "a (w/a)*" as format string, but perl	502	# ideally, we would want to use "a (w/a)*" as format string, but perl
394	# versions from at least 5.8.9 to 5.16.3 are all buggy and can't unpack	503	# versions from at least 5.8.9 to 5.16.3 are all buggy and can't unpack
395	# it.	504	# it.
396	push @{ $self->[2] }, pack "a L/a*", $_[0], $_[1];	505	push @{ $self->[QUEUE] }, pack "a L/a*", $_[0], $_[1];
397		506
398	$self->[3] \|\|= AE::io $self->[1], 1, sub {	507	$self->[WW] \|\|= AE::io $self->[FH], 1, sub {
399	do {	508	do {
400	# send the next "thing" in the queue - either a reference to an fh,	509	# send the next "thing" in the queue - either a reference to an fh,
401	# or a plain string.	510	# or a plain string.
402		511
403	if (ref $self->[2][0]) {	512	if (ref $self->[QUEUE][0]) {
404	# send fh	513	# send fh
405	unless (IO::FDPass::send fileno $self->[1], fileno ${ $self->[2][0] }) {	514	unless (IO::FDPass::send fileno $self->[FH], fileno ${ $self->[QUEUE][0] }) {
406	return if $! == Errno::EAGAIN \|\| $! == Errno::EWOULDBLOCK;	515	return if $! == Errno::EAGAIN \|\| $! == Errno::EWOULDBLOCK;
407	undef $self->[3];	516	undef $self->[WW];
408	die "AnyEvent::Fork: file descriptor send failure: $!";	517	die "AnyEvent::Fork: file descriptor send failure: $!";
409	}	518	}
410		519
411	shift @{ $self->[2] };	520	shift @{ $self->[QUEUE] };
412		521
413	} else {	522	} else {
414	# send string	523	# send string
415	my $len = syswrite $self->[1], $self->[2][0];	524	my $len = syswrite $self->[FH], $self->[QUEUE][0];
416		525
417	unless ($len) {	526	unless ($len) {
418	return if $! == Errno::EAGAIN \|\| $! == Errno::EWOULDBLOCK;	527	return if $! == Errno::EAGAIN \|\| $! == Errno::EWOULDBLOCK;
419	undef $self->[3];	528	undef $self->[WW];
420	die "AnyEvent::Fork: command write failure: $!";	529	die "AnyEvent::Fork: command write failure: $!";
421	}	530	}
422		531
423	substr $self->[2][0], 0, $len, "";	532	substr $self->[QUEUE][0], 0, $len, "";
424	shift @{ $self->[2] } unless length $self->[2][0];	533	shift @{ $self->[QUEUE] } unless length $self->[QUEUE][0];
425	}	534	}
426	} while @{ $self->[2] };	535	} while @{ $self->[QUEUE] };
427		536
428	# everything written	537	# everything written
429	undef $self->[3];	538	undef $self->[WW];
430		539
431	# invoke run callback, if any	540	# invoke run callback, if any
432	$self->[4]->($self->[1]) if $self->[4];	541	if ($self->[CB]) {
		542	$self->[CB]->($self->[FH]);
		543	@$self = ();
		544	}
433	};	545	};
434		546
435	() # make sure we don't leak the watcher	547	() # make sure we don't leak the watcher
436	}
437
438	sub _new {
439	my ($self, $fh, $pid) = @_;
440
441	AnyEvent::Util::fh_nonblocking $fh, 1;
442
443	$self = bless [
444	$pid,
445	$fh,
446	[], # write queue - strings or fd's
447	undef, # AE watcher
448	], $self;
449
450	$self
451	}	548	}
452		549
453	# fork template from current process, used by AnyEvent::Fork::Early/Template	550	# fork template from current process, used by AnyEvent::Fork::Early/Template
454	sub _new_fork {	551	sub _new_fork {
455	my ($fh, $slave) = AnyEvent::Util::portable_socketpair;	552	my ($fh, $slave) = AnyEvent::Util::portable_socketpair;
…		…
459		556
460	if ($pid eq 0) {	557	if ($pid eq 0) {
461	require AnyEvent::Fork::Serve;	558	require AnyEvent::Fork::Serve;
462	$AnyEvent::Fork::Serve::OWNER = $parent;	559	$AnyEvent::Fork::Serve::OWNER = $parent;
463	close $fh;	560	close $fh;
464	$0 = "$_[1] of $parent";	561	$0 = "$parent AnyEvent::Fork/exec";
465	$SIG{CHLD} = 'IGNORE';
466	AnyEvent::Fork::Serve::serve ($slave);	562	AnyEvent::Fork::Serve::serve ($slave);
467	exit 0;	563	exit 0;
468	} elsif (!$pid) {	564	} elsif (!$pid) {
469	die "AnyEvent::Fork::Early/Template: unable to fork template process: $!";	565	die "AnyEvent::Fork::Early/Template: unable to fork template process: $!";
470	}	566	}
…		…
524		620
525	You should use C<new> whenever possible, except when having a template	621	You should use C<new> whenever possible, except when having a template
526	process around is unacceptable.	622	process around is unacceptable.
527		623
528	The path to the perl interpreter is divined using various methods - first	624	The path to the perl interpreter is divined using various methods - first
529	C<$^X> is investigated to see if the path ends with something that sounds	625	C<$^X> is investigated to see if the path ends with something that looks
530	as if it were the perl interpreter. Failing this, the module falls back to	626	as if it were the perl interpreter. Failing this, the module falls back to
531	using C<$Config::Config{perlpath}>.	627	using C<$Config::Config{perlpath}>.
532		628
		629	The path to perl can also be overriden by setting the global variable
		630	C<$AnyEvent::Fork::PERL> - it's value will be used for all subsequent
		631	invocations.
		632
533	=cut	633	=cut
		634
		635	our $PERL;
534		636
535	sub new_exec {	637	sub new_exec {
536	my ($self) = @_;	638	my ($self) = @_;
537		639
538	return $EARLY->fork	640	return $EARLY->fork
539	if $EARLY;	641	if $EARLY;
540		642
		643	unless (defined $PERL) {
541	# first find path of perl	644	# first find path of perl
542	my $perl = $;	645	my $perl = $^X;
543		646
544	# first we try $^X, but the path must be absolute (always on win32), and end in sth.	647	# first we try $^X, but the path must be absolute (always on win32), and end in sth.
545	# that looks like perl. this obviously only works for posix and win32	648	# that looks like perl. this obviously only works for posix and win32
546	unless (	649	unless (
547	($^O eq "MSWin32" \|\| $perl =~ m%^/%)	650	($^O eq "MSWin32" \|\| $perl =~ m%^/%)
548	&& $perl =~ m%[/\\]perl(?:[0-9]+(\.[0-9]+)+)?(\.exe)?$%i	651	&& $perl =~ m%[/\\]perl(?:[0-9]+(\.[0-9]+)+)?(\.exe)?$%i
549	) {	652	) {
550	# if it doesn't look perlish enough, try Config	653	# if it doesn't look perlish enough, try Config
551	require Config;	654	require Config;
552	$perl = $Config::Config{perlpath};	655	$perl = $Config::Config{perlpath};
553	$perl =~ s/(?:\Q$Config::Config{_exe}\E)?$/$Config::Config{_exe}/;	656	$perl =~ s/(?:\Q$Config::Config{_exe}\E)?$/$Config::Config{_exe}/;
		657	}
		658
		659	$PERL = $perl;
554	}	660	}
555		661
556	require Proc::FastSpawn;	662	require Proc::FastSpawn;
557		663
558	my ($fh, $slave) = AnyEvent::Util::portable_socketpair;	664	my ($fh, $slave) = AnyEvent::Util::portable_socketpair;
…		…
566	#local $ENV{PERL5LIB} = join ":", grep !ref, @INC;	672	#local $ENV{PERL5LIB} = join ":", grep !ref, @INC;
567	my %env = %ENV;	673	my %env = %ENV;
568	$env{PERL5LIB} = join +($^O eq "MSWin32" ? ";" : ":"), grep !ref, @INC;	674	$env{PERL5LIB} = join +($^O eq "MSWin32" ? ";" : ":"), grep !ref, @INC;
569		675
570	my $pid = Proc::FastSpawn::spawn (	676	my $pid = Proc::FastSpawn::spawn (
571	$perl,	677	$PERL,
572	["perl", "-MAnyEvent::Fork::Serve", "-e", "AnyEvent::Fork::Serve::me", fileno $slave, $$],	678	[$PERL, "-MAnyEvent::Fork::Serve", "-e", "AnyEvent::Fork::Serve::me", fileno $slave, $$],
573	[map "$_=$env{$_}", keys %env],	679	[map "$_=$env{$_}", keys %env],
574	) or die "unable to spawn AnyEvent::Fork server: $!";	680	) or die "unable to spawn AnyEvent::Fork server: $!";
575		681
576	$self->_new ($fh, $pid)	682	$self->_new ($fh, $pid)
577	}	683	}
578		684
579	=item $pid = $proc->pid	685	=item $pid = $proc->pid
580		686
581	Returns the process id of the process I<iff it is a direct child of the	687	Returns the process id of the process I<iff it is a direct child of the
582	process running AnyEvent::Fork>, and C<undef> otherwise.	688	process running AnyEvent::Fork>, and C<undef> otherwise. As a general
		689	rule (that you cannot rely upon), processes created via C<new_exec>,
		690	L<AnyEvent::Fork::Early> or L<AnyEvent::Fork::Template> are direct
		691	children, while all other processes are not.
583		692
584	Normally, only processes created via C<< AnyEvent::Fork->new_exec >> and	693	Or in other words, you do not normally have to take care of zombies for
585	L<AnyEvent::Fork::Template> are direct children, and you are responsible	694	processes created via C<new>, but when in doubt, or zombies are a problem,
586	to clean up their zombies when they die.	695	you need to check whether a process is a diretc child by calling this
587		696	method, and possibly creating a child watcher or reap it manually.
588	All other processes are not direct children, and will be cleaned up by
589	AnyEvent::Fork itself.
590		697
591	=cut	698	=cut
592		699
593	sub pid {	700	sub pid {
594	$_[0][0]	701	$_[0][PID]
595	}	702	}
596		703
597	=item $proc = $proc->eval ($perlcode, @args)	704	=item $proc = $proc->eval ($perlcode, @args)
598		705
599	Evaluates the given C<$perlcode> as ... perl code, while setting C<@_> to	706	Evaluates the given C<$perlcode> as ... Perl code, while setting C<@_> to
600	the strings specified by C<@args>, in the "main" package.	707	the strings specified by C<@args>, in the "main" package.
601		708
602	This call is meant to do any custom initialisation that might be required	709	This call is meant to do any custom initialisation that might be required
603	(for example, the C<require> method uses it). It's not supposed to be used	710	(for example, the C<require> method uses it). It's not supposed to be used
604	to completely take over the process, use C<run> for that.	711	to completely take over the process, use C<run> for that.
…		…
613	C<send_xxx> methods, such as file handles. See the L<use AnyEvent::Fork as	720	C<send_xxx> methods, such as file handles. See the L<use AnyEvent::Fork as
614	a faster fork+exec> example to see it in action.	721	a faster fork+exec> example to see it in action.
615		722
616	Returns the process object for easy chaining of method calls.	723	Returns the process object for easy chaining of method calls.
617		724
		725	It's common to want to call an iniitalisation function with some
		726	arguments. Make sure you actually pass C<@_> to that function (for example
		727	by using C<&name> syntax), and do not just specify a function name:
		728
		729	$proc->eval ('&MyModule::init', $string1, $string2);
		730
618	=cut	731	=cut
619		732
620	sub eval {	733	sub eval {
621	my ($self, $code, @args) = @_;	734	my ($self, $code, @args) = @_;
622		735
…		…
666	sub send_fh {	779	sub send_fh {
667	my ($self, @fh) = @_;	780	my ($self, @fh) = @_;
668		781
669	for my $fh (@fh) {	782	for my $fh (@fh) {
670	$self->_cmd ("h");	783	$self->_cmd ("h");
671	push @{ $self->[2] }, \$fh;	784	push @{ $self->[QUEUE] }, \$fh;
672	}	785	}
673		786
674	$self	787	$self
675	}	788	}
676		789
…		…
725		838
726	Even if not used otherwise, the socket can be a good indicator for the	839	Even if not used otherwise, the socket can be a good indicator for the
727	existence of the process - if the other process exits, you get a readable	840	existence of the process - if the other process exits, you get a readable
728	event on it, because exiting the process closes the socket (if it didn't	841	event on it, because exiting the process closes the socket (if it didn't
729	create any children using fork).	842	create any children using fork).
		843
		844	=over 4
		845
		846	=item Compatibility to L<AnyEvent::Fork::Remote>
		847
		848	If you want to write code that works with both this module and
		849	L<AnyEvent::Fork::Remote>, you need to write your code so that it assumes
		850	there are two file handles for communications, which might not be unix
		851	domain sockets. The C<run> function should start like this:
		852
		853	sub run {
		854	my ($rfh, @args) = @_; # @args is your normal arguments
		855	my $wfh = fileno $rfh ? $rfh : *STDOUT;
		856
		857	# now use $rfh for reading and $wfh for writing
		858	}
		859
		860	This checks whether the passed file handle is, in fact, the process
		861	C<STDIN> handle. If it is, then the function was invoked visa
		862	L<AnyEvent::Fork::Remote>, so STDIN should be used for reading and
		863	C<STDOUT> should be used for writing.
		864
		865	In all other cases, the function was called via this module, and there is
		866	only one file handle that should be sued for reading and writing.
		867
		868	=back
730		869
731	Example: create a template for a process pool, pass a few strings, some	870	Example: create a template for a process pool, pass a few strings, some
732	file handles, then fork, pass one more string, and run some code.	871	file handles, then fork, pass one more string, and run some code.
733		872
734	my $pool = AnyEvent::Fork	873	my $pool = AnyEvent::Fork
…		…
762	=cut	901	=cut
763		902
764	sub run {	903	sub run {
765	my ($self, $func, $cb) = @_;	904	my ($self, $func, $cb) = @_;
766		905
767	$self->[4] = $cb;	906	$self->[CB] = $cb;
768	$self->_cmd (r => $func);	907	$self->_cmd (r => $func);
		908	}
		909
		910	=back
		911
		912
		913	=head2 CHILD PROCESS INTERFACE
		914
		915	This module has a limited API for use in child processes.
		916
		917	=over 4
		918
		919	=item @args = AnyEvent::Fork::Serve::run_args
		920
		921	This function, which only exists before the C<run> method is called,
		922	returns the arguments that would be passed to the run function, and clears
		923	them.
		924
		925	This is mainly useful to get any file handles passed via C<send_fh>, but
		926	works for any arguments passed via C<< send_I<xxx> >> methods.
		927
		928	=back
		929
		930
		931	=head2 EXPERIMENTAL METHODS
		932
		933	These methods might go away completely or change behaviour, at any time.
		934
		935	=over 4
		936
		937	=item $proc->to_fh ($cb->($fh)) # EXPERIMENTAL, MIGHT BE REMOVED
		938
		939	Flushes all commands out to the process and then calls the callback with
		940	the communications socket.
		941
		942	The process object becomes unusable on return from this function - any
		943	further method calls result in undefined behaviour.
		944
		945	The point of this method is to give you a file handle that you can pass
		946	to another process. In that other process, you can call C<new_from_fh
		947	AnyEvent::Fork $fh> to create a new C<AnyEvent::Fork> object from it,
		948	thereby effectively passing a fork object to another process.
		949
		950	=cut
		951
		952	sub to_fh {
		953	my ($self, $cb) = @_;
		954
		955	$self->[CB] = $cb;
		956
		957	unless ($self->[WW]) {
		958	$self->[CB]->($self->[FH]);
		959	@$self = ();
		960	}
		961	}
		962
		963	=item new_from_fh AnyEvent::Fork $fh # EXPERIMENTAL, MIGHT BE REMOVED
		964
		965	Takes a file handle originally rceeived by the C<to_fh> method and creates
		966	a new C<AnyEvent:Fork> object. The child process itself will not change in
		967	any way, i.e. it will keep all the modifications done to it before calling
		968	C<to_fh>.
		969
		970	The new object is very much like the original object, except that the
		971	C<pid> method will return C<undef> even if the process is a direct child.
		972
		973	=cut
		974
		975	sub new_from_fh {
		976	my ($class, $fh) = @_;
		977
		978	$class->_new ($fh)
769	}	979	}
770		980
771	=back	981	=back
772		982
773	=head1 PERFORMANCE	983	=head1 PERFORMANCE
…		…
783		993
784	2079 new processes per second, using manual socketpair + fork	994	2079 new processes per second, using manual socketpair + fork
785		995
786	Then I did the same thing, but instead of calling fork, I called	996	Then I did the same thing, but instead of calling fork, I called
787	AnyEvent::Fork->new->run ("CORE::exit") and then again waited for the	997	AnyEvent::Fork->new->run ("CORE::exit") and then again waited for the
788	socket form the child to close on exit. This does the same thing as manual	998	socket from the child to close on exit. This does the same thing as manual
789	socket pair + fork, except that what is forked is the template process	999	socket pair + fork, except that what is forked is the template process
790	(2440kB), and the socket needs to be passed to the server at the other end	1000	(2440kB), and the socket needs to be passed to the server at the other end
791	of the socket first.	1001	of the socket first.
792		1002
793	2307 new processes per second, using AnyEvent::Fork->new	1003	2307 new processes per second, using AnyEvent::Fork->new
…		…
800	So how can C<< AnyEvent->new >> be faster than a standard fork, even	1010	So how can C<< AnyEvent->new >> be faster than a standard fork, even
801	though it uses the same operations, but adds a lot of overhead?	1011	though it uses the same operations, but adds a lot of overhead?
802		1012
803	The difference is simply the process size: forking the 5MB process takes	1013	The difference is simply the process size: forking the 5MB process takes
804	so much longer than forking the 2.5MB template process that the extra	1014	so much longer than forking the 2.5MB template process that the extra
805	overhead introduced is canceled out.	1015	overhead is canceled out.
806		1016
807	If the benchmark process grows, the normal fork becomes even slower:	1017	If the benchmark process grows, the normal fork becomes even slower:
808		1018
809	1340 new processes, manual fork of a 20MB process	1019	1340 new processes, manual fork of a 20MB process
810	731 new processes, manual fork of a 200MB process	1020	731 new processes, manual fork of a 200MB process
…		…
870	initialising them, for example, by calling C<init Gtk2> manually.	1080	initialising them, for example, by calling C<init Gtk2> manually.
871		1081
872	=item exiting calls object destructors	1082	=item exiting calls object destructors
873		1083
874	This only applies to users of L<AnyEvent::Fork:Early> and	1084	This only applies to users of L<AnyEvent::Fork:Early> and
875	L<AnyEvent::Fork::Template>, or when initialiasing code creates objects	1085	L<AnyEvent::Fork::Template>, or when initialising code creates objects
876	that reference external resources.	1086	that reference external resources.
877		1087
878	When a process created by AnyEvent::Fork exits, it might do so by calling	1088	When a process created by AnyEvent::Fork exits, it might do so by calling
879	exit, or simply letting perl reach the end of the program. At which point	1089	exit, or simply letting perl reach the end of the program. At which point
880	Perl runs all destructors.	1090	Perl runs all destructors.
…		…
900	to make it so, mostly due to the bloody broken perl that nobody seems to	1110	to make it so, mostly due to the bloody broken perl that nobody seems to
901	care about. The fork emulation is a bad joke - I have yet to see something	1111	care about. The fork emulation is a bad joke - I have yet to see something
902	useful that you can do with it without running into memory corruption	1112	useful that you can do with it without running into memory corruption
903	issues or other braindamage. Hrrrr.	1113	issues or other braindamage. Hrrrr.
904		1114
		1115	Since fork is endlessly broken on win32 perls (it doesn't even remotely
		1116	work within it's documented limits) and quite obviously it's not getting
		1117	improved any time soon, the best way to proceed on windows would be to
		1118	always use C<new_exec> and thus never rely on perl's fork "emulation".
		1119
905	Cygwin perl is not supported at the moment due to some hilarious	1120	Cygwin perl is not supported at the moment due to some hilarious
906	shortcomings of its API - see L<IO::FDPoll> for more details.	1121	shortcomings of its API - see L<IO::FDPoll> for more details. If you never
		1122	use C<send_fh> and always use C<new_exec> to create processes, it should
		1123	work though.
		1124
		1125	=head1 USING AnyEvent::Fork IN SUBPROCESSES
		1126
		1127	AnyEvent::Fork itself cannot generally be used in subprocesses. As long as
		1128	only one process ever forks new processes, sharing the template processes
		1129	is possible (you could use a pipe as a lock by writing a byte into it to
		1130	unlock, and reading the byte to lock for example)
		1131
		1132	To make concurrent calls possible after fork, you should get rid of the
		1133	template and early fork processes. AnyEvent::Fork will create a new
		1134	template process as needed.
		1135
		1136	undef $AnyEvent::Fork::EARLY;
		1137	undef $AnyEvent::Fork::TEMPLATE;
		1138
		1139	It doesn't matter whether you get rid of them in the parent or child after
		1140	a fork.
907		1141
908	=head1 SEE ALSO	1142	=head1 SEE ALSO
909		1143
910	L<AnyEvent::Fork::Early> (to avoid executing a perl interpreter),	1144	L<AnyEvent::Fork::Early>, to avoid executing a perl interpreter at all
		1145	(part of this distribution).
		1146
911	L<AnyEvent::Fork::Template> (to create a process by forking the main	1147	L<AnyEvent::Fork::Template>, to create a process by forking the main
912	program at a convenient time).	1148	program at a convenient time (part of this distribution).
913		1149
914	=head1 AUTHOR	1150	L<AnyEvent::Fork::Remote>, for another way to create processes that is
		1151	mostly compatible to this module and modules building on top of it, but
		1152	works better with remote processes.
		1153
		1154	L<AnyEvent::Fork::RPC>, for simple RPC to child processes (on CPAN).
		1155
		1156	L<AnyEvent::Fork::Pool>, for simple worker process pool (on CPAN).
		1157
		1158	=head1 AUTHOR AND CONTACT INFORMATION
915		1159
916	Marc Lehmann <schmorp@schmorp.de>	1160	Marc Lehmann <schmorp@schmorp.de>
917	http://home.schmorp.de/	1161	http://software.schmorp.de/pkg/AnyEvent-Fork
918		1162
919	=cut	1163	=cut
920		1164
921	1	1165	1
922		1166

Diff Legend

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

Comparing AnyEvent-Fork/Fork.pm (file contents): Revision 1.39 by root, Sat Apr 6 22:39:37 2013 UTC vs. Revision 1.69 by root, Sat Nov 5 19:12:15 2016 UTC

Diff Legend

Comparing AnyEvent-Fork/Fork.pm (file contents):
Revision 1.39 by root, Sat Apr 6 22:39:37 2013 UTC vs.
Revision 1.69 by root, Sat Nov 5 19:12:15 2016 UTC