ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent-Fork/Fork.pm
Revision: 1.29
Committed: Sat Apr 6 09:15:49 2013 UTC (11 years, 1 month ago) by root
Branch: MAIN
Changes since 1.28: +5 -6 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.1 =head1 NAME
2    
3 root 1.4 AnyEvent::Fork - everything you wanted to use fork() for, but couldn't
4 root 1.1
5     =head1 SYNOPSIS
6    
7 root 1.4 use AnyEvent::Fork;
8 root 1.1
9 root 1.24 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     =head1 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 can either implement it yourself
40     in whatever way you like, use some message-passing module such
41     as L<AnyEvent::MP>, some pipe such as L<AnyEvent::ZeroMQ>, use
42     L<AnyEvent::Handle> on both sides to send e.g. JSON or Storable messages,
43     and so on.
44    
45 root 1.25 =head1 PROBLEM STATEMENT
46    
47     There are two traditional ways to implement parallel processing on UNIX
48     like operating systems - fork and process, and fork+exec and process. They
49     have different advantages and disadvantages that I describe below,
50     together with how this module tries to mitigate the disadvantages.
51    
52     =over 4
53    
54     =item Forking from a big process can be very slow.
55    
56     A 5GB process needs 0.05s to fork on my 3.6GHz amd64 GNU/Linux box. This
57     overhead is often shared with exec (because you have to fork first), but
58     in some circumstances (e.g. when vfork is used), fork+exec can be much
59     faster.
60    
61     This module can help here by telling a small(er) helper process to fork,
62     which is faster then forking the main process, and also uses vfork where
63     possible. This gives the speed of vfork, with the flexibility of fork.
64    
65     =item Forking usually creates a copy-on-write copy of the parent
66     process.
67    
68     For example, modules or data files that are loaded will not use additional
69     memory after a fork. When exec'ing a new process, modules and data files
70     might need to be loaded again, at extra CPU and memory cost. But when
71     forking, literally all data structures are copied - if the program frees
72     them and replaces them by new data, the child processes will retain the
73     old version even if it isn't used, which can suddenly and unexpectedly
74     increase memory usage when freeing memory.
75    
76     The trade-off is between more sharing with fork (which can be good or
77     bad), and no sharing with exec.
78    
79     This module allows the main program to do a controlled fork, and allows
80     modules to exec processes safely at any time. When creating a custom
81     process pool you can take advantage of data sharing via fork without
82     risking to share large dynamic data structures that will blow up child
83     memory usage.
84    
85     In other words, this module puts you into control over what is being
86     shared and what isn't, at all times.
87    
88     =item Exec'ing a new perl process might be difficult.
89    
90     For example, it is not easy to find the correct path to the perl
91     interpreter - C<$^X> might not be a perl interpreter at all.
92    
93     This module tries hard to identify the correct path to the perl
94     interpreter. With a cooperative main program, exec'ing the interpreter
95     might not even be necessary, but even without help from the main program,
96     it will still work when used from a module.
97    
98     =item Exec'ing a new perl process might be slow, as all necessary modules
99     have to be loaded from disk again, with no guarantees of success.
100    
101     Long running processes might run into problems when perl is upgraded
102     and modules are no longer loadable because they refer to a different
103     perl version, or parts of a distribution are newer than the ones already
104     loaded.
105    
106     This module supports creating pre-initialised perl processes to be used as
107     a template for new processes.
108    
109     =item Forking might be impossible when a program is running.
110    
111     For example, POSIX makes it almost impossible to fork from a
112     multi-threaded program while doing anything useful in the child - in
113     fact, if your perl program uses POSIX threads (even indirectly via
114     e.g. L<IO::AIO> or L<threads>), you cannot call fork on the perl level
115     anymore without risking corruption issues on a number of operating
116     systems.
117    
118     This module can safely fork helper processes at any time, by calling
119     fork+exec in C, in a POSIX-compatible way (via L<Proc::FastSpawn>).
120    
121     =item Parallel processing with fork might be inconvenient or difficult
122     to implement. Modules might not work in both parent and child.
123    
124     For example, when a program uses an event loop and creates watchers it
125     becomes very hard to use the event loop from a child program, as the
126     watchers already exist but are only meaningful in the parent. Worse, a
127     module might want to use such a module, not knowing whether another module
128     or the main program also does, leading to problems.
129    
130 root 1.26 Apart from event loops, graphical toolkits also commonly fall into the
131     "unsafe module" category, or just about anything that communicates with
132     the external world, such as network libraries and file I/O modules, which
133     usually don't like being copied and then allowed to continue in two
134     processes.
135    
136 root 1.25 With this module only the main program is allowed to create new processes
137     by forking (because only the main program can know when it is still safe
138     to do so) - all other processes are created via fork+exec, which makes it
139     possible to use modules such as event loops or window interfaces safely.
140    
141     =back
142    
143 root 1.24 =head1 EXAMPLES
144    
145     =head2 Create a single new process, tell it to run your worker function.
146 root 1.9
147     AnyEvent::Fork
148     ->new
149     ->require ("MyModule")
150     ->run ("MyModule::worker, sub {
151     my ($master_filehandle) = @_;
152    
153     # now $master_filehandle is connected to the
154     # $slave_filehandle in the new process.
155     });
156    
157     # MyModule::worker might look like this
158     sub MyModule::worker {
159     my ($slave_filehandle) = @_;
160    
161     # now $slave_filehandle is connected to the $master_filehandle
162     # in the original prorcess. have fun!
163     }
164    
165 root 1.24 =head2 Create a pool of server processes all accepting on the same socket.
166 root 1.9
167     # create listener socket
168     my $listener = ...;
169    
170     # create a pool template, initialise it and give it the socket
171     my $pool = AnyEvent::Fork
172     ->new
173     ->require ("Some::Stuff", "My::Server")
174     ->send_fh ($listener);
175    
176     # now create 10 identical workers
177     for my $id (1..10) {
178     $pool
179     ->fork
180     ->send_arg ($id)
181     ->run ("My::Server::run");
182     }
183    
184     # now do other things - maybe use the filehandle provided by run
185     # to wait for the processes to die. or whatever.
186    
187     # My::Server::run might look like this
188     sub My::Server::run {
189     my ($slave, $listener, $id) = @_;
190    
191     close $slave; # we do not use the socket, so close it to save resources
192    
193     # we could go ballistic and use e.g. AnyEvent here, or IO::AIO,
194     # or anything we usually couldn't do in a process forked normally.
195     while (my $socket = $listener->accept) {
196     # do sth. with new socket
197     }
198     }
199    
200 root 1.24 =head2 use AnyEvent::Fork as a faster fork+exec
201 root 1.23
202 root 1.24 This runs /bin/echo hi, with stdout redirected to /tmp/log and stderr to
203     the communications socket. It is usually faster than fork+exec, but still
204     let's you prepare the environment.
205 root 1.23
206     open my $output, ">/tmp/log" or die "$!";
207    
208     AnyEvent::Fork
209     ->new
210     ->eval ('
211     sub run {
212     my ($fh, $output, @cmd) = @_;
213    
214     # perl will clear close-on-exec on STDOUT/STDERR
215     open STDOUT, ">&", $output or die;
216     open STDERR, ">&", $fh or die;
217    
218     exec @cmd;
219     }
220     ')
221     ->send_fh ($output)
222     ->send_arg ("/bin/echo", "hi")
223     ->run ("run", my $cv = AE::cv);
224    
225     my $stderr = $cv->recv;
226    
227 root 1.3 =head1 CONCEPTS
228    
229     This module can create new processes either by executing a new perl
230     process, or by forking from an existing "template" process.
231    
232     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,
234     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
236     functions.
237    
238     There are multiple ways to create additional processes to execute some
239     jobs:
240    
241     =over 4
242    
243     =item fork a new process from the "default" template process, load code,
244     run it
245    
246     This module has a "default" template process which it executes when it is
247     needed the first time. Forking from this process shares the memory used
248     for the perl interpreter with the new process, but loading modules takes
249     time, and the memory is not shared with anything else.
250    
251     This is ideal for when you only need one extra process of a kind, with the
252 root 1.17 option of starting and stopping it on demand.
253 root 1.3
254 root 1.9 Example:
255    
256     AnyEvent::Fork
257     ->new
258     ->require ("Some::Module")
259     ->run ("Some::Module::run", sub {
260     my ($fork_fh) = @_;
261     });
262    
263 root 1.3 =item fork a new template process, load code, then fork processes off of
264     it and run the code
265    
266     When you need to have a bunch of processes that all execute the same (or
267     very similar) tasks, then a good way is to create a new template process
268     for them, loading all the modules you need, and then create your worker
269     processes from this new template process.
270    
271     This way, all code (and data structures) that can be shared (e.g. the
272     modules you loaded) is shared between the processes, and each new process
273     consumes relatively little memory of its own.
274    
275     The disadvantage of this approach is that you need to create a template
276     process for the sole purpose of forking new processes from it, but if you
277 root 1.17 only need a fixed number of processes you can create them, and then destroy
278 root 1.3 the template process.
279    
280 root 1.9 Example:
281    
282     my $template = AnyEvent::Fork->new->require ("Some::Module");
283    
284     for (1..10) {
285     $template->fork->run ("Some::Module::run", sub {
286     my ($fork_fh) = @_;
287     });
288     }
289    
290     # at this point, you can keep $template around to fork new processes
291     # later, or you can destroy it, which causes it to vanish.
292    
293 root 1.3 =item execute a new perl interpreter, load some code, run it
294    
295     This is relatively slow, and doesn't allow you to share memory between
296     multiple processes.
297    
298     The only advantage is that you don't have to have a template process
299     hanging around all the time to fork off some new processes, which might be
300     an advantage when there are long time spans where no extra processes are
301     needed.
302    
303 root 1.9 Example:
304    
305     AnyEvent::Fork
306     ->new_exec
307     ->require ("Some::Module")
308     ->run ("Some::Module::run", sub {
309     my ($fork_fh) = @_;
310     });
311    
312 root 1.3 =back
313    
314 root 1.27 =head1 THE C<AnyEvent::Fork> CLASS
315    
316     This module exports nothing, and only implements a single class -
317     C<AnyEvent::Fork>.
318    
319 root 1.28 There are two class constructors that both create new processes - C<new>
320     and C<new_exec>. The C<fork> method creates a new process by forking an
321 root 1.27 existing one and could be considered a third constructor.
322    
323     Most of the remaining methods deal with preparing the new process, by
324     loading code, evaluating code and sending data to the new process. They
325     usually return the process object, so you can chain method calls.
326    
327     If a process object is destroyed before calling its C<run> method, then
328     the process simply exits. After C<run> is called, all responsibility is
329     passed to the specified function.
330 root 1.3
331 root 1.29 As long as there is any outstanding work to be done, process objects
332     resist being destroyed, so there is no reason to store them unless you
333     need them later - configure and forget works just fine.
334    
335 root 1.1 =over 4
336    
337     =cut
338    
339 root 1.4 package AnyEvent::Fork;
340 root 1.1
341     use common::sense;
342    
343 root 1.18 use Errno ();
344 root 1.1
345     use AnyEvent;
346     use AnyEvent::Util ();
347    
348 root 1.15 use IO::FDPass;
349    
350 root 1.21 our $VERSION = 0.5;
351 root 1.12
352 root 1.4 our $PERL; # the path to the perl interpreter, deduces with various forms of magic
353 root 1.1
354     =over 4
355    
356     =back
357    
358     =cut
359    
360 root 1.5 # the early fork template process
361     our $EARLY;
362    
363 root 1.4 # the empty template process
364     our $TEMPLATE;
365    
366     sub _cmd {
367     my $self = shift;
368    
369 root 1.18 # ideally, we would want to use "a (w/a)*" as format string, but perl
370     # versions from at least 5.8.9 to 5.16.3 are all buggy and can't unpack
371     # it.
372 root 1.19 push @{ $self->[2] }, pack "a L/a*", $_[0], $_[1];
373 root 1.4
374 root 1.19 $self->[3] ||= AE::io $self->[1], 1, sub {
375     do {
376     # send the next "thing" in the queue - either a reference to an fh,
377     # or a plain string.
378    
379     if (ref $self->[2][0]) {
380     # send fh
381     unless (IO::FDPass::send fileno $self->[1], fileno ${ $self->[2][0] }) {
382     return if $! == Errno::EAGAIN || $! == Errno::EWOULDBLOCK;
383     undef $self->[3];
384     die "AnyEvent::Fork: file descriptor send failure: $!";
385 root 1.18 }
386 root 1.4
387 root 1.19 shift @{ $self->[2] };
388 root 1.18
389 root 1.19 } else {
390     # send string
391     my $len = syswrite $self->[1], $self->[2][0];
392    
393     unless ($len) {
394     return if $! == Errno::EAGAIN || $! == Errno::EWOULDBLOCK;
395     undef $self->[3];
396     die "AnyEvent::Fork: command write failure: $!";
397     }
398 root 1.18
399 root 1.19 substr $self->[2][0], 0, $len, "";
400     shift @{ $self->[2] } unless length $self->[2][0];
401     }
402     } while @{ $self->[2] };
403    
404     # everything written
405     undef $self->[3];
406    
407     # invoke run callback, if any
408 root 1.20 $self->[4]->($self->[1]) if $self->[4];
409 root 1.19 };
410 root 1.14
411     () # make sure we don't leak the watcher
412 root 1.4 }
413 root 1.1
414 root 1.4 sub _new {
415 root 1.19 my ($self, $fh, $pid) = @_;
416 root 1.1
417 root 1.6 AnyEvent::Util::fh_nonblocking $fh, 1;
418    
419 root 1.4 $self = bless [
420 root 1.20 $pid,
421 root 1.1 $fh,
422 root 1.4 [], # write queue - strings or fd's
423     undef, # AE watcher
424     ], $self;
425    
426     $self
427 root 1.1 }
428    
429 root 1.6 # fork template from current process, used by AnyEvent::Fork::Early/Template
430     sub _new_fork {
431     my ($fh, $slave) = AnyEvent::Util::portable_socketpair;
432 root 1.7 my $parent = $$;
433    
434 root 1.6 my $pid = fork;
435    
436     if ($pid eq 0) {
437     require AnyEvent::Fork::Serve;
438 root 1.7 $AnyEvent::Fork::Serve::OWNER = $parent;
439 root 1.6 close $fh;
440 root 1.7 $0 = "$_[1] of $parent";
441 root 1.16 $SIG{CHLD} = 'IGNORE';
442 root 1.6 AnyEvent::Fork::Serve::serve ($slave);
443 root 1.15 exit 0;
444 root 1.6 } elsif (!$pid) {
445     die "AnyEvent::Fork::Early/Template: unable to fork template process: $!";
446     }
447    
448 root 1.19 AnyEvent::Fork->_new ($fh, $pid)
449 root 1.6 }
450    
451 root 1.4 =item my $proc = new AnyEvent::Fork
452 root 1.1
453 root 1.4 Create a new "empty" perl interpreter process and returns its process
454     object for further manipulation.
455 root 1.1
456 root 1.4 The new process is forked from a template process that is kept around
457     for this purpose. When it doesn't exist yet, it is created by a call to
458 root 1.29 C<new_exec> first and then stays around for future calls.
459 root 1.9
460 root 1.4 =cut
461    
462     sub new {
463     my $class = shift;
464 root 1.1
465 root 1.4 $TEMPLATE ||= $class->new_exec;
466     $TEMPLATE->fork
467 root 1.1 }
468    
469 root 1.4 =item $new_proc = $proc->fork
470    
471     Forks C<$proc>, creating a new process, and returns the process object
472     of the new process.
473    
474     If any of the C<send_> functions have been called before fork, then they
475     will be cloned in the child. For example, in a pre-forked server, you
476     might C<send_fh> the listening socket into the template process, and then
477     keep calling C<fork> and C<run>.
478    
479     =cut
480    
481     sub fork {
482     my ($self) = @_;
483 root 1.1
484     my ($fh, $slave) = AnyEvent::Util::portable_socketpair;
485 root 1.4
486     $self->send_fh ($slave);
487     $self->_cmd ("f");
488    
489     AnyEvent::Fork->_new ($fh)
490     }
491    
492     =item my $proc = new_exec AnyEvent::Fork
493    
494     Create a new "empty" perl interpreter process and returns its process
495     object for further manipulation.
496    
497     Unlike the C<new> method, this method I<always> spawns a new perl process
498     (except in some cases, see L<AnyEvent::Fork::Early> for details). This
499     reduces the amount of memory sharing that is possible, and is also slower.
500    
501     You should use C<new> whenever possible, except when having a template
502     process around is unacceptable.
503    
504 root 1.17 The path to the perl interpreter is divined using various methods - first
505 root 1.4 C<$^X> is investigated to see if the path ends with something that sounds
506     as if it were the perl interpreter. Failing this, the module falls back to
507     using C<$Config::Config{perlpath}>.
508    
509     =cut
510    
511     sub new_exec {
512     my ($self) = @_;
513    
514 root 1.5 return $EARLY->fork
515     if $EARLY;
516    
517 root 1.4 # first find path of perl
518     my $perl = $;
519    
520     # first we try $^X, but the path must be absolute (always on win32), and end in sth.
521     # that looks like perl. this obviously only works for posix and win32
522     unless (
523 root 1.15 ($^O eq "MSWin32" || $perl =~ m%^/%)
524 root 1.4 && $perl =~ m%[/\\]perl(?:[0-9]+(\.[0-9]+)+)?(\.exe)?$%i
525     ) {
526     # if it doesn't look perlish enough, try Config
527     require Config;
528     $perl = $Config::Config{perlpath};
529     $perl =~ s/(?:\Q$Config::Config{_exe}\E)?$/$Config::Config{_exe}/;
530     }
531    
532     require Proc::FastSpawn;
533    
534     my ($fh, $slave) = AnyEvent::Util::portable_socketpair;
535     Proc::FastSpawn::fd_inherit (fileno $slave);
536    
537 root 1.10 # new fh's should always be set cloexec (due to $^F),
538     # but hey, not on win32, so we always clear the inherit flag.
539     Proc::FastSpawn::fd_inherit (fileno $fh, 0);
540    
541 root 1.4 # quick. also doesn't work in win32. of course. what did you expect
542     #local $ENV{PERL5LIB} = join ":", grep !ref, @INC;
543 root 1.1 my %env = %ENV;
544 root 1.15 $env{PERL5LIB} = join +($^O eq "MSWin32" ? ";" : ":"), grep !ref, @INC;
545 root 1.1
546 root 1.19 my $pid = Proc::FastSpawn::spawn (
547 root 1.4 $perl,
548 root 1.7 ["perl", "-MAnyEvent::Fork::Serve", "-e", "AnyEvent::Fork::Serve::me", fileno $slave, $$],
549 root 1.4 [map "$_=$env{$_}", keys %env],
550     ) or die "unable to spawn AnyEvent::Fork server: $!";
551    
552 root 1.19 $self->_new ($fh, $pid)
553 root 1.4 }
554    
555 root 1.20 =item $pid = $proc->pid
556    
557     Returns the process id of the process I<iff it is a direct child of the
558     process> running AnyEvent::Fork, and C<undef> otherwise.
559    
560     Normally, only processes created via C<< AnyEvent::Fork->new_exec >> and
561     L<AnyEvent::Fork::Template> are direct children, and you are responsible
562     to clean up their zombies when they die.
563    
564     All other processes are not direct children, and will be cleaned up by
565     AnyEvent::Fork.
566    
567     =cut
568    
569     sub pid {
570     $_[0][0]
571     }
572    
573 root 1.9 =item $proc = $proc->eval ($perlcode, @args)
574    
575     Evaluates the given C<$perlcode> as ... perl code, while setting C<@_> to
576 root 1.23 the strings specified by C<@args>, in the "main" package.
577 root 1.9
578     This call is meant to do any custom initialisation that might be required
579     (for example, the C<require> method uses it). It's not supposed to be used
580     to completely take over the process, use C<run> for that.
581    
582     The code will usually be executed after this call returns, and there is no
583     way to pass anything back to the calling process. Any evaluation errors
584     will be reported to stderr and cause the process to exit.
585    
586 root 1.23 If you want to execute some code to take over the process (see the
587     "fork+exec" example in the SYNOPSIS), you should compile a function via
588     C<eval> first, and then call it via C<run>. This also gives you access to
589     any arguments passed via the C<send_xxx> methods, such as file handles.
590    
591 root 1.9 Returns the process object for easy chaining of method calls.
592    
593     =cut
594    
595     sub eval {
596     my ($self, $code, @args) = @_;
597    
598 root 1.19 $self->_cmd (e => pack "(w/a*)*", $code, @args);
599 root 1.9
600     $self
601     }
602    
603 root 1.4 =item $proc = $proc->require ($module, ...)
604 root 1.1
605 root 1.9 Tries to load the given module(s) into the process
606 root 1.1
607 root 1.4 Returns the process object for easy chaining of method calls.
608 root 1.1
609 root 1.9 =cut
610    
611     sub require {
612     my ($self, @modules) = @_;
613    
614     s%::%/%g for @modules;
615     $self->eval ('require "$_.pm" for @_', @modules);
616    
617     $self
618     }
619    
620 root 1.4 =item $proc = $proc->send_fh ($handle, ...)
621 root 1.1
622 root 1.4 Send one or more file handles (I<not> file descriptors) to the process,
623     to prepare a call to C<run>.
624 root 1.1
625 root 1.4 The process object keeps a reference to the handles until this is done,
626     so you must not explicitly close the handles. This is most easily
627     accomplished by simply not storing the file handles anywhere after passing
628     them to this method.
629    
630     Returns the process object for easy chaining of method calls.
631    
632 root 1.17 Example: pass a file handle to a process, and release it without
633     closing. It will be closed automatically when it is no longer used.
634 root 1.9
635     $proc->send_fh ($my_fh);
636     undef $my_fh; # free the reference if you want, but DO NOT CLOSE IT
637    
638 root 1.4 =cut
639    
640     sub send_fh {
641     my ($self, @fh) = @_;
642    
643     for my $fh (@fh) {
644     $self->_cmd ("h");
645     push @{ $self->[2] }, \$fh;
646     }
647    
648     $self
649 root 1.1 }
650    
651 root 1.4 =item $proc = $proc->send_arg ($string, ...)
652    
653     Send one or more argument strings to the process, to prepare a call to
654     C<run>. The strings can be any octet string.
655    
656 root 1.18 The protocol is optimised to pass a moderate number of relatively short
657     strings - while you can pass up to 4GB of data in one go, this is more
658     meant to pass some ID information or other startup info, not big chunks of
659     data.
660    
661 root 1.17 Returns the process object for easy chaining of method calls.
662 root 1.4
663     =cut
664 root 1.1
665 root 1.4 sub send_arg {
666     my ($self, @arg) = @_;
667 root 1.1
668 root 1.19 $self->_cmd (a => pack "(w/a*)*", @arg);
669 root 1.1
670     $self
671     }
672    
673 root 1.4 =item $proc->run ($func, $cb->($fh))
674    
675 root 1.23 Enter the function specified by the function name in C<$func> in the
676     process. The function is called with the communication socket as first
677 root 1.4 argument, followed by all file handles and string arguments sent earlier
678     via C<send_fh> and C<send_arg> methods, in the order they were called.
679    
680 root 1.23 The function name should be fully qualified, but if it isn't, it will be
681     looked up in the main package.
682 root 1.4
683 root 1.23 If the called function returns, doesn't exist, or any error occurs, the
684     process exits.
685 root 1.4
686 root 1.23 Preparing the process is done in the background - when all commands have
687     been sent, the callback is invoked with the local communications socket
688     as argument. At this point you can start using the socket in any way you
689     like.
690    
691     The process object becomes unusable on return from this function - any
692     further method calls result in undefined behaviour.
693 root 1.4
694     If the communication socket isn't used, it should be closed on both sides,
695     to save on kernel memory.
696    
697     The socket is non-blocking in the parent, and blocking in the newly
698 root 1.23 created process. The close-on-exec flag is set in both.
699    
700     Even if not used otherwise, the socket can be a good indicator for the
701     existence of the process - if the other process exits, you get a readable
702     event on it, because exiting the process closes the socket (if it didn't
703     create any children using fork).
704 root 1.4
705 root 1.9 Example: create a template for a process pool, pass a few strings, some
706     file handles, then fork, pass one more string, and run some code.
707    
708     my $pool = AnyEvent::Fork
709     ->new
710     ->send_arg ("str1", "str2")
711     ->send_fh ($fh1, $fh2);
712    
713     for (1..2) {
714     $pool
715     ->fork
716     ->send_arg ("str3")
717     ->run ("Some::function", sub {
718     my ($fh) = @_;
719    
720     # fh is nonblocking, but we trust that the OS can accept these
721 root 1.22 # few octets anyway.
722 root 1.9 syswrite $fh, "hi #$_\n";
723    
724     # $fh is being closed here, as we don't store it anywhere
725     });
726     }
727    
728     # Some::function might look like this - all parameters passed before fork
729     # and after will be passed, in order, after the communications socket.
730     sub Some::function {
731     my ($fh, $str1, $str2, $fh1, $fh2, $str3) = @_;
732    
733 root 1.22 print scalar <$fh>; # prints "hi #1\n" and "hi #2\n" in any order
734 root 1.9 }
735    
736 root 1.4 =cut
737    
738     sub run {
739     my ($self, $func, $cb) = @_;
740    
741 root 1.20 $self->[4] = $cb;
742 root 1.9 $self->_cmd (r => $func);
743 root 1.4 }
744    
745 root 1.1 =back
746    
747 root 1.16 =head1 PERFORMANCE
748    
749     Now for some unscientific benchmark numbers (all done on an amd64
750     GNU/Linux box). These are intended to give you an idea of the relative
751 root 1.18 performance you can expect, they are not meant to be absolute performance
752     numbers.
753 root 1.16
754 root 1.17 OK, so, I ran a simple benchmark that creates a socket pair, forks, calls
755 root 1.16 exit in the child and waits for the socket to close in the parent. I did
756 root 1.18 load AnyEvent, EV and AnyEvent::Fork, for a total process size of 5100kB.
757 root 1.16
758 root 1.18 2079 new processes per second, using manual socketpair + fork
759 root 1.16
760     Then I did the same thing, but instead of calling fork, I called
761     AnyEvent::Fork->new->run ("CORE::exit") and then again waited for the
762     socket form the child to close on exit. This does the same thing as manual
763 root 1.17 socket pair + fork, except that what is forked is the template process
764 root 1.16 (2440kB), and the socket needs to be passed to the server at the other end
765     of the socket first.
766    
767     2307 new processes per second, using AnyEvent::Fork->new
768    
769     And finally, using C<new_exec> instead C<new>, using vforks+execs to exec
770     a new perl interpreter and compile the small server each time, I get:
771    
772     479 vfork+execs per second, using AnyEvent::Fork->new_exec
773    
774 root 1.17 So how can C<< AnyEvent->new >> be faster than a standard fork, even
775     though it uses the same operations, but adds a lot of overhead?
776 root 1.16
777     The difference is simply the process size: forking the 6MB process takes
778     so much longer than forking the 2.5MB template process that the overhead
779     introduced is canceled out.
780    
781     If the benchmark process grows, the normal fork becomes even slower:
782    
783     1340 new processes, manual fork in a 20MB process
784     731 new processes, manual fork in a 200MB process
785     235 new processes, manual fork in a 2000MB process
786    
787 root 1.17 What that means (to me) is that I can use this module without having a
788     very bad conscience because of the extra overhead required to start new
789 root 1.16 processes.
790    
791 root 1.15 =head1 TYPICAL PROBLEMS
792    
793     This section lists typical problems that remain. I hope by recognising
794     them, most can be avoided.
795    
796     =over 4
797    
798     =item "leaked" file descriptors for exec'ed processes
799    
800     POSIX systems inherit file descriptors by default when exec'ing a new
801     process. While perl itself laudably sets the close-on-exec flags on new
802     file handles, most C libraries don't care, and even if all cared, it's
803     often not possible to set the flag in a race-free manner.
804    
805     That means some file descriptors can leak through. And since it isn't
806 root 1.17 possible to know which file descriptors are "good" and "necessary" (or
807     even to know which file descriptors are open), there is no good way to
808 root 1.15 close the ones that might harm.
809    
810     As an example of what "harm" can be done consider a web server that
811     accepts connections and afterwards some module uses AnyEvent::Fork for the
812     first time, causing it to fork and exec a new process, which might inherit
813     the network socket. When the server closes the socket, it is still open
814     in the child (which doesn't even know that) and the client might conclude
815     that the connection is still fine.
816    
817     For the main program, there are multiple remedies available -
818     L<AnyEvent::Fork::Early> is one, creating a process early and not using
819     C<new_exec> is another, as in both cases, the first process can be exec'ed
820     well before many random file descriptors are open.
821    
822     In general, the solution for these kind of problems is to fix the
823     libraries or the code that leaks those file descriptors.
824    
825 root 1.17 Fortunately, most of these leaked descriptors do no harm, other than
826 root 1.15 sitting on some resources.
827    
828     =item "leaked" file descriptors for fork'ed processes
829    
830     Normally, L<AnyEvent::Fork> does start new processes by exec'ing them,
831     which closes file descriptors not marked for being inherited.
832    
833     However, L<AnyEvent::Fork::Early> and L<AnyEvent::Fork::Template> offer
834     a way to create these processes by forking, and this leaks more file
835     descriptors than exec'ing them, as there is no way to mark descriptors as
836     "close on fork".
837    
838     An example would be modules like L<EV>, L<IO::AIO> or L<Gtk2>. Both create
839     pipes for internal uses, and L<Gtk2> might open a connection to the X
840     server. L<EV> and L<IO::AIO> can deal with fork, but Gtk2 might have
841     trouble with a fork.
842    
843     The solution is to either not load these modules before use'ing
844     L<AnyEvent::Fork::Early> or L<AnyEvent::Fork::Template>, or to delay
845     initialising them, for example, by calling C<init Gtk2> manually.
846    
847 root 1.19 =item exit runs destructors
848    
849     This only applies to users of Lc<AnyEvent::Fork:Early> and
850     L<AnyEvent::Fork::Template>.
851    
852     When a process created by AnyEvent::Fork exits, it might do so by calling
853     exit, or simply letting perl reach the end of the program. At which point
854     Perl runs all destructors.
855    
856     Not all destructors are fork-safe - for example, an object that represents
857     the connection to an X display might tell the X server to free resources,
858     which is inconvenient when the "real" object in the parent still needs to
859     use them.
860    
861     This is obviously not a problem for L<AnyEvent::Fork::Early>, as you used
862     it as the very first thing, right?
863    
864     It is a problem for L<AnyEvent::Fork::Template> though - and the solution
865     is to not create objects with nontrivial destructors that might have an
866     effect outside of Perl.
867    
868 root 1.15 =back
869    
870 root 1.8 =head1 PORTABILITY NOTES
871    
872 root 1.10 Native win32 perls are somewhat supported (AnyEvent::Fork::Early is a nop,
873     and ::Template is not going to work), and it cost a lot of blood and sweat
874     to make it so, mostly due to the bloody broken perl that nobody seems to
875     care about. The fork emulation is a bad joke - I have yet to see something
876 root 1.17 useful that you can do with it without running into memory corruption
877 root 1.10 issues or other braindamage. Hrrrr.
878    
879     Cygwin perl is not supported at the moment, as it should implement fd
880     passing, but doesn't, and rolling my own is hard, as cygwin doesn't
881     support enough functionality to do it.
882 root 1.8
883 root 1.13 =head1 SEE ALSO
884    
885     L<AnyEvent::Fork::Early> (to avoid executing a perl interpreter),
886     L<AnyEvent::Fork::Template> (to create a process by forking the main
887     program at a convenient time).
888    
889 root 1.1 =head1 AUTHOR
890    
891     Marc Lehmann <schmorp@schmorp.de>
892     http://home.schmorp.de/
893    
894     =cut
895    
896     1
897