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

File Contents

# Content
1 =head1 NAME
2
3 AnyEvent::Fork - everything you wanted to use fork() for, but couldn't
4
5 =head1 SYNOPSIS
6
7 use AnyEvent::Fork;
8
9 AnyEvent::Fork
10 ->new
11 ->require ("MyModule")
12 ->run ("MyModule::server", my $cv = AE::cv);
13
14 my $fh = $cv->recv;
15
16 =head1 DESCRIPTION
17
18 This module allows you to create new processes, without actually forking
19 them from your current process (avoiding the problems of forking), but
20 preserving most of the advantages of fork.
21
22 It can be used to create new worker processes or new independent
23 subprocesses for short- and long-running jobs, process pools (e.g. for use
24 in pre-forked servers) but also to spawn new external processes (such as
25 CGI scripts from a web server), which can be faster (and more well behaved)
26 than using fork+exec in big processes.
27
28 Special care has been taken to make this module useful from other modules,
29 while still supporting specialised environments such as L<App::Staticperl>
30 or L<PAR::Packer>.
31
32 =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 =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 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 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 =head1 EXAMPLES
144
145 =head2 Create a single new process, tell it to run your worker function.
146
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 =head2 Create a pool of server processes all accepting on the same socket.
166
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 =head2 use AnyEvent::Fork as a faster fork+exec
201
202 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
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 =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 option of starting and stopping it on demand.
253
254 Example:
255
256 AnyEvent::Fork
257 ->new
258 ->require ("Some::Module")
259 ->run ("Some::Module::run", sub {
260 my ($fork_fh) = @_;
261 });
262
263 =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 only need a fixed number of processes you can create them, and then destroy
278 the template process.
279
280 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 =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 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 =back
313
314 =head1 THE C<AnyEvent::Fork> CLASS
315
316 This module exports nothing, and only implements a single class -
317 C<AnyEvent::Fork>.
318
319 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 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
331 =over 4
332
333 =cut
334
335 package AnyEvent::Fork;
336
337 use common::sense;
338
339 use Errno ();
340
341 use AnyEvent;
342 use AnyEvent::Util ();
343
344 use IO::FDPass;
345
346 our $VERSION = 0.5;
347
348 our $PERL; # the path to the perl interpreter, deduces with various forms of magic
349
350 =over 4
351
352 =back
353
354 =cut
355
356 # the early fork template process
357 our $EARLY;
358
359 # the empty template process
360 our $TEMPLATE;
361
362 sub _cmd {
363 my $self = shift;
364
365 # ideally, we would want to use "a (w/a)*" as format string, but perl
366 # versions from at least 5.8.9 to 5.16.3 are all buggy and can't unpack
367 # it.
368 push @{ $self->[2] }, pack "a L/a*", $_[0], $_[1];
369
370 $self->[3] ||= AE::io $self->[1], 1, sub {
371 do {
372 # send the next "thing" in the queue - either a reference to an fh,
373 # or a plain string.
374
375 if (ref $self->[2][0]) {
376 # send fh
377 unless (IO::FDPass::send fileno $self->[1], fileno ${ $self->[2][0] }) {
378 return if $! == Errno::EAGAIN || $! == Errno::EWOULDBLOCK;
379 undef $self->[3];
380 die "AnyEvent::Fork: file descriptor send failure: $!";
381 }
382
383 shift @{ $self->[2] };
384
385 } else {
386 # send string
387 my $len = syswrite $self->[1], $self->[2][0];
388
389 unless ($len) {
390 return if $! == Errno::EAGAIN || $! == Errno::EWOULDBLOCK;
391 undef $self->[3];
392 die "AnyEvent::Fork: command write failure: $!";
393 }
394
395 substr $self->[2][0], 0, $len, "";
396 shift @{ $self->[2] } unless length $self->[2][0];
397 }
398 } while @{ $self->[2] };
399
400 # everything written
401 undef $self->[3];
402
403 # invoke run callback, if any
404 $self->[4]->($self->[1]) if $self->[4];
405 };
406
407 () # make sure we don't leak the watcher
408 }
409
410 sub _new {
411 my ($self, $fh, $pid) = @_;
412
413 AnyEvent::Util::fh_nonblocking $fh, 1;
414
415 $self = bless [
416 $pid,
417 $fh,
418 [], # write queue - strings or fd's
419 undef, # AE watcher
420 ], $self;
421
422 $self
423 }
424
425 # fork template from current process, used by AnyEvent::Fork::Early/Template
426 sub _new_fork {
427 my ($fh, $slave) = AnyEvent::Util::portable_socketpair;
428 my $parent = $$;
429
430 my $pid = fork;
431
432 if ($pid eq 0) {
433 require AnyEvent::Fork::Serve;
434 $AnyEvent::Fork::Serve::OWNER = $parent;
435 close $fh;
436 $0 = "$_[1] of $parent";
437 $SIG{CHLD} = 'IGNORE';
438 AnyEvent::Fork::Serve::serve ($slave);
439 exit 0;
440 } elsif (!$pid) {
441 die "AnyEvent::Fork::Early/Template: unable to fork template process: $!";
442 }
443
444 AnyEvent::Fork->_new ($fh, $pid)
445 }
446
447 =item my $proc = new AnyEvent::Fork
448
449 Create a new "empty" perl interpreter process and returns its process
450 object for further manipulation.
451
452 The new process is forked from a template process that is kept around
453 for this purpose. When it doesn't exist yet, it is created by a call to
454 C<new_exec> and kept around for future calls.
455
456 When the process object is destroyed, it will release the file handle
457 that connects it with the new process. When the new process has not yet
458 called C<run>, then the process will exit. Otherwise, what happens depends
459 entirely on the code that is executed.
460
461 =cut
462
463 sub new {
464 my $class = shift;
465
466 $TEMPLATE ||= $class->new_exec;
467 $TEMPLATE->fork
468 }
469
470 =item $new_proc = $proc->fork
471
472 Forks C<$proc>, creating a new process, and returns the process object
473 of the new process.
474
475 If any of the C<send_> functions have been called before fork, then they
476 will be cloned in the child. For example, in a pre-forked server, you
477 might C<send_fh> the listening socket into the template process, and then
478 keep calling C<fork> and C<run>.
479
480 =cut
481
482 sub fork {
483 my ($self) = @_;
484
485 my ($fh, $slave) = AnyEvent::Util::portable_socketpair;
486
487 $self->send_fh ($slave);
488 $self->_cmd ("f");
489
490 AnyEvent::Fork->_new ($fh)
491 }
492
493 =item my $proc = new_exec AnyEvent::Fork
494
495 Create a new "empty" perl interpreter process and returns its process
496 object for further manipulation.
497
498 Unlike the C<new> method, this method I<always> spawns a new perl process
499 (except in some cases, see L<AnyEvent::Fork::Early> for details). This
500 reduces the amount of memory sharing that is possible, and is also slower.
501
502 You should use C<new> whenever possible, except when having a template
503 process around is unacceptable.
504
505 The path to the perl interpreter is divined using various methods - first
506 C<$^X> is investigated to see if the path ends with something that sounds
507 as if it were the perl interpreter. Failing this, the module falls back to
508 using C<$Config::Config{perlpath}>.
509
510 =cut
511
512 sub new_exec {
513 my ($self) = @_;
514
515 return $EARLY->fork
516 if $EARLY;
517
518 # first find path of perl
519 my $perl = $;
520
521 # first we try $^X, but the path must be absolute (always on win32), and end in sth.
522 # that looks like perl. this obviously only works for posix and win32
523 unless (
524 ($^O eq "MSWin32" || $perl =~ m%^/%)
525 && $perl =~ m%[/\\]perl(?:[0-9]+(\.[0-9]+)+)?(\.exe)?$%i
526 ) {
527 # if it doesn't look perlish enough, try Config
528 require Config;
529 $perl = $Config::Config{perlpath};
530 $perl =~ s/(?:\Q$Config::Config{_exe}\E)?$/$Config::Config{_exe}/;
531 }
532
533 require Proc::FastSpawn;
534
535 my ($fh, $slave) = AnyEvent::Util::portable_socketpair;
536 Proc::FastSpawn::fd_inherit (fileno $slave);
537
538 # new fh's should always be set cloexec (due to $^F),
539 # but hey, not on win32, so we always clear the inherit flag.
540 Proc::FastSpawn::fd_inherit (fileno $fh, 0);
541
542 # quick. also doesn't work in win32. of course. what did you expect
543 #local $ENV{PERL5LIB} = join ":", grep !ref, @INC;
544 my %env = %ENV;
545 $env{PERL5LIB} = join +($^O eq "MSWin32" ? ";" : ":"), grep !ref, @INC;
546
547 my $pid = Proc::FastSpawn::spawn (
548 $perl,
549 ["perl", "-MAnyEvent::Fork::Serve", "-e", "AnyEvent::Fork::Serve::me", fileno $slave, $$],
550 [map "$_=$env{$_}", keys %env],
551 ) or die "unable to spawn AnyEvent::Fork server: $!";
552
553 $self->_new ($fh, $pid)
554 }
555
556 =item $pid = $proc->pid
557
558 Returns the process id of the process I<iff it is a direct child of the
559 process> running AnyEvent::Fork, and C<undef> otherwise.
560
561 Normally, only processes created via C<< AnyEvent::Fork->new_exec >> and
562 L<AnyEvent::Fork::Template> are direct children, and you are responsible
563 to clean up their zombies when they die.
564
565 All other processes are not direct children, and will be cleaned up by
566 AnyEvent::Fork.
567
568 =cut
569
570 sub pid {
571 $_[0][0]
572 }
573
574 =item $proc = $proc->eval ($perlcode, @args)
575
576 Evaluates the given C<$perlcode> as ... perl code, while setting C<@_> to
577 the strings specified by C<@args>, in the "main" package.
578
579 This call is meant to do any custom initialisation that might be required
580 (for example, the C<require> method uses it). It's not supposed to be used
581 to completely take over the process, use C<run> for that.
582
583 The code will usually be executed after this call returns, and there is no
584 way to pass anything back to the calling process. Any evaluation errors
585 will be reported to stderr and cause the process to exit.
586
587 If you want to execute some code to take over the process (see the
588 "fork+exec" example in the SYNOPSIS), you should compile a function via
589 C<eval> first, and then call it via C<run>. This also gives you access to
590 any arguments passed via the C<send_xxx> methods, such as file handles.
591
592 Returns the process object for easy chaining of method calls.
593
594 =cut
595
596 sub eval {
597 my ($self, $code, @args) = @_;
598
599 $self->_cmd (e => pack "(w/a*)*", $code, @args);
600
601 $self
602 }
603
604 =item $proc = $proc->require ($module, ...)
605
606 Tries to load the given module(s) into the process
607
608 Returns the process object for easy chaining of method calls.
609
610 =cut
611
612 sub require {
613 my ($self, @modules) = @_;
614
615 s%::%/%g for @modules;
616 $self->eval ('require "$_.pm" for @_', @modules);
617
618 $self
619 }
620
621 =item $proc = $proc->send_fh ($handle, ...)
622
623 Send one or more file handles (I<not> file descriptors) to the process,
624 to prepare a call to C<run>.
625
626 The process object keeps a reference to the handles until this is done,
627 so you must not explicitly close the handles. This is most easily
628 accomplished by simply not storing the file handles anywhere after passing
629 them to this method.
630
631 Returns the process object for easy chaining of method calls.
632
633 Example: pass a file handle to a process, and release it without
634 closing. It will be closed automatically when it is no longer used.
635
636 $proc->send_fh ($my_fh);
637 undef $my_fh; # free the reference if you want, but DO NOT CLOSE IT
638
639 =cut
640
641 sub send_fh {
642 my ($self, @fh) = @_;
643
644 for my $fh (@fh) {
645 $self->_cmd ("h");
646 push @{ $self->[2] }, \$fh;
647 }
648
649 $self
650 }
651
652 =item $proc = $proc->send_arg ($string, ...)
653
654 Send one or more argument strings to the process, to prepare a call to
655 C<run>. The strings can be any octet string.
656
657 The protocol is optimised to pass a moderate number of relatively short
658 strings - while you can pass up to 4GB of data in one go, this is more
659 meant to pass some ID information or other startup info, not big chunks of
660 data.
661
662 Returns the process object for easy chaining of method calls.
663
664 =cut
665
666 sub send_arg {
667 my ($self, @arg) = @_;
668
669 $self->_cmd (a => pack "(w/a*)*", @arg);
670
671 $self
672 }
673
674 =item $proc->run ($func, $cb->($fh))
675
676 Enter the function specified by the function name in C<$func> in the
677 process. The function is called with the communication socket as first
678 argument, followed by all file handles and string arguments sent earlier
679 via C<send_fh> and C<send_arg> methods, in the order they were called.
680
681 The function name should be fully qualified, but if it isn't, it will be
682 looked up in the main package.
683
684 If the called function returns, doesn't exist, or any error occurs, the
685 process exits.
686
687 Preparing the process is done in the background - when all commands have
688 been sent, the callback is invoked with the local communications socket
689 as argument. At this point you can start using the socket in any way you
690 like.
691
692 The process object becomes unusable on return from this function - any
693 further method calls result in undefined behaviour.
694
695 If the communication socket isn't used, it should be closed on both sides,
696 to save on kernel memory.
697
698 The socket is non-blocking in the parent, and blocking in the newly
699 created process. The close-on-exec flag is set in both.
700
701 Even if not used otherwise, the socket can be a good indicator for the
702 existence of the process - if the other process exits, you get a readable
703 event on it, because exiting the process closes the socket (if it didn't
704 create any children using fork).
705
706 Example: create a template for a process pool, pass a few strings, some
707 file handles, then fork, pass one more string, and run some code.
708
709 my $pool = AnyEvent::Fork
710 ->new
711 ->send_arg ("str1", "str2")
712 ->send_fh ($fh1, $fh2);
713
714 for (1..2) {
715 $pool
716 ->fork
717 ->send_arg ("str3")
718 ->run ("Some::function", sub {
719 my ($fh) = @_;
720
721 # fh is nonblocking, but we trust that the OS can accept these
722 # few octets anyway.
723 syswrite $fh, "hi #$_\n";
724
725 # $fh is being closed here, as we don't store it anywhere
726 });
727 }
728
729 # Some::function might look like this - all parameters passed before fork
730 # and after will be passed, in order, after the communications socket.
731 sub Some::function {
732 my ($fh, $str1, $str2, $fh1, $fh2, $str3) = @_;
733
734 print scalar <$fh>; # prints "hi #1\n" and "hi #2\n" in any order
735 }
736
737 =cut
738
739 sub run {
740 my ($self, $func, $cb) = @_;
741
742 $self->[4] = $cb;
743 $self->_cmd (r => $func);
744 }
745
746 =back
747
748 =head1 PERFORMANCE
749
750 Now for some unscientific benchmark numbers (all done on an amd64
751 GNU/Linux box). These are intended to give you an idea of the relative
752 performance you can expect, they are not meant to be absolute performance
753 numbers.
754
755 OK, so, I ran a simple benchmark that creates a socket pair, forks, calls
756 exit in the child and waits for the socket to close in the parent. I did
757 load AnyEvent, EV and AnyEvent::Fork, for a total process size of 5100kB.
758
759 2079 new processes per second, using manual socketpair + fork
760
761 Then I did the same thing, but instead of calling fork, I called
762 AnyEvent::Fork->new->run ("CORE::exit") and then again waited for the
763 socket form the child to close on exit. This does the same thing as manual
764 socket pair + fork, except that what is forked is the template process
765 (2440kB), and the socket needs to be passed to the server at the other end
766 of the socket first.
767
768 2307 new processes per second, using AnyEvent::Fork->new
769
770 And finally, using C<new_exec> instead C<new>, using vforks+execs to exec
771 a new perl interpreter and compile the small server each time, I get:
772
773 479 vfork+execs per second, using AnyEvent::Fork->new_exec
774
775 So how can C<< AnyEvent->new >> be faster than a standard fork, even
776 though it uses the same operations, but adds a lot of overhead?
777
778 The difference is simply the process size: forking the 6MB process takes
779 so much longer than forking the 2.5MB template process that the overhead
780 introduced is canceled out.
781
782 If the benchmark process grows, the normal fork becomes even slower:
783
784 1340 new processes, manual fork in a 20MB process
785 731 new processes, manual fork in a 200MB process
786 235 new processes, manual fork in a 2000MB process
787
788 What that means (to me) is that I can use this module without having a
789 very bad conscience because of the extra overhead required to start new
790 processes.
791
792 =head1 TYPICAL PROBLEMS
793
794 This section lists typical problems that remain. I hope by recognising
795 them, most can be avoided.
796
797 =over 4
798
799 =item "leaked" file descriptors for exec'ed processes
800
801 POSIX systems inherit file descriptors by default when exec'ing a new
802 process. While perl itself laudably sets the close-on-exec flags on new
803 file handles, most C libraries don't care, and even if all cared, it's
804 often not possible to set the flag in a race-free manner.
805
806 That means some file descriptors can leak through. And since it isn't
807 possible to know which file descriptors are "good" and "necessary" (or
808 even to know which file descriptors are open), there is no good way to
809 close the ones that might harm.
810
811 As an example of what "harm" can be done consider a web server that
812 accepts connections and afterwards some module uses AnyEvent::Fork for the
813 first time, causing it to fork and exec a new process, which might inherit
814 the network socket. When the server closes the socket, it is still open
815 in the child (which doesn't even know that) and the client might conclude
816 that the connection is still fine.
817
818 For the main program, there are multiple remedies available -
819 L<AnyEvent::Fork::Early> is one, creating a process early and not using
820 C<new_exec> is another, as in both cases, the first process can be exec'ed
821 well before many random file descriptors are open.
822
823 In general, the solution for these kind of problems is to fix the
824 libraries or the code that leaks those file descriptors.
825
826 Fortunately, most of these leaked descriptors do no harm, other than
827 sitting on some resources.
828
829 =item "leaked" file descriptors for fork'ed processes
830
831 Normally, L<AnyEvent::Fork> does start new processes by exec'ing them,
832 which closes file descriptors not marked for being inherited.
833
834 However, L<AnyEvent::Fork::Early> and L<AnyEvent::Fork::Template> offer
835 a way to create these processes by forking, and this leaks more file
836 descriptors than exec'ing them, as there is no way to mark descriptors as
837 "close on fork".
838
839 An example would be modules like L<EV>, L<IO::AIO> or L<Gtk2>. Both create
840 pipes for internal uses, and L<Gtk2> might open a connection to the X
841 server. L<EV> and L<IO::AIO> can deal with fork, but Gtk2 might have
842 trouble with a fork.
843
844 The solution is to either not load these modules before use'ing
845 L<AnyEvent::Fork::Early> or L<AnyEvent::Fork::Template>, or to delay
846 initialising them, for example, by calling C<init Gtk2> manually.
847
848 =item exit runs destructors
849
850 This only applies to users of Lc<AnyEvent::Fork:Early> and
851 L<AnyEvent::Fork::Template>.
852
853 When a process created by AnyEvent::Fork exits, it might do so by calling
854 exit, or simply letting perl reach the end of the program. At which point
855 Perl runs all destructors.
856
857 Not all destructors are fork-safe - for example, an object that represents
858 the connection to an X display might tell the X server to free resources,
859 which is inconvenient when the "real" object in the parent still needs to
860 use them.
861
862 This is obviously not a problem for L<AnyEvent::Fork::Early>, as you used
863 it as the very first thing, right?
864
865 It is a problem for L<AnyEvent::Fork::Template> though - and the solution
866 is to not create objects with nontrivial destructors that might have an
867 effect outside of Perl.
868
869 =back
870
871 =head1 PORTABILITY NOTES
872
873 Native win32 perls are somewhat supported (AnyEvent::Fork::Early is a nop,
874 and ::Template is not going to work), and it cost a lot of blood and sweat
875 to make it so, mostly due to the bloody broken perl that nobody seems to
876 care about. The fork emulation is a bad joke - I have yet to see something
877 useful that you can do with it without running into memory corruption
878 issues or other braindamage. Hrrrr.
879
880 Cygwin perl is not supported at the moment, as it should implement fd
881 passing, but doesn't, and rolling my own is hard, as cygwin doesn't
882 support enough functionality to do it.
883
884 =head1 SEE ALSO
885
886 L<AnyEvent::Fork::Early> (to avoid executing a perl interpreter),
887 L<AnyEvent::Fork::Template> (to create a process by forking the main
888 program at a convenient time).
889
890 =head1 AUTHOR
891
892 Marc Lehmann <schmorp@schmorp.de>
893 http://home.schmorp.de/
894
895 =cut
896
897 1
898