ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/AnyEvent-Fork/Fork.pm
(Generate patch)

Comparing AnyEvent-Fork/Fork.pm (file contents):
Revision 1.16 by root, Fri Apr 5 23:35:07 2013 UTC vs.
Revision 1.17 by root, Fri Apr 5 23:42:24 2013 UTC

70preserving most of the advantages of fork. 70preserving most of the advantages of fork.
71 71
72It can be used to create new worker processes or new independent 72It can be used to create new worker processes or new independent
73subprocesses for short- and long-running jobs, process pools (e.g. for use 73subprocesses for short- and long-running jobs, process pools (e.g. for use
74in pre-forked servers) but also to spawn new external processes (such as 74in pre-forked servers) but also to spawn new external processes (such as
75CGI scripts from a webserver), which can be faster (and more well behaved) 75CGI scripts from a web server), which can be faster (and more well behaved)
76than using fork+exec in big processes. 76than using fork+exec in big processes.
77 77
78Special care has been taken to make this module useful from other modules, 78Special care has been taken to make this module useful from other modules,
79while still supporting specialised environments such as L<App::Staticperl> 79while still supporting specialised environments such as L<App::Staticperl>
80or L<PAR::Packer>. 80or L<PAR::Packer>.
110or fork+exec instead. 110or fork+exec instead.
111 111
112=item Forking usually creates a copy-on-write copy of the parent 112=item Forking usually creates a copy-on-write copy of the parent
113process. Memory (for example, modules or data files that have been 113process. Memory (for example, modules or data files that have been
114will not take additional memory). When exec'ing a new process, modules 114will not take additional memory). When exec'ing a new process, modules
115and data files might need to be loaded again, at extra cpu and memory 115and data files might need to be loaded again, at extra CPU and memory
116cost. Likewise when forking, all data structures are copied as well - if 116cost. Likewise when forking, all data structures are copied as well - if
117the program frees them and replaces them by new data, the child processes 117the program frees them and replaces them by new data, the child processes
118will retain the memory even if it isn't used. 118will retain the memory even if it isn't used.
119 119
120This module allows the main program to do a controlled fork, and allows 120This module allows the main program to do a controlled fork, and allows
132as template, and also tries hard to identify the correct path to the perl 132as template, and also tries hard to identify the correct path to the perl
133interpreter. With a cooperative main program, exec'ing the interpreter 133interpreter. With a cooperative main program, exec'ing the interpreter
134might not even be necessary. 134might not even be necessary.
135 135
136=item Forking might be impossible when a program is running. For example, 136=item Forking might be impossible when a program is running. For example,
137POSIX makes it almost impossible to fork from a multithreaded program and 137POSIX makes it almost impossible to fork from a multi-threaded program and
138do anything useful in the child - strictly speaking, if your perl program 138do anything useful in the child - strictly speaking, if your perl program
139uses posix threads (even indirectly via e.g. L<IO::AIO> or L<threads>), 139uses posix threads (even indirectly via e.g. L<IO::AIO> or L<threads>),
140you cannot call fork on the perl level anymore, at all. 140you cannot call fork on the perl level anymore, at all.
141 141
142This module can safely fork helper processes at any time, by caling 142This module can safely fork helper processes at any time, by calling
143fork+exec in C, in a POSIX-compatible way. 143fork+exec in C, in a POSIX-compatible way.
144 144
145=item Parallel processing with fork might be inconvenient or difficult 145=item Parallel processing with fork might be inconvenient or difficult
146to implement. For example, when a program uses an event loop and creates 146to implement. For example, when a program uses an event loop and creates
147watchers it becomes very hard to use the event loop from a child 147watchers it becomes very hard to use the event loop from a child
179needed the first time. Forking from this process shares the memory used 179needed the first time. Forking from this process shares the memory used
180for the perl interpreter with the new process, but loading modules takes 180for the perl interpreter with the new process, but loading modules takes
181time, and the memory is not shared with anything else. 181time, and the memory is not shared with anything else.
182 182
183This is ideal for when you only need one extra process of a kind, with the 183This is ideal for when you only need one extra process of a kind, with the
184option of starting and stipping it on demand. 184option of starting and stopping it on demand.
185 185
186Example: 186Example:
187 187
188 AnyEvent::Fork 188 AnyEvent::Fork
189 ->new 189 ->new
204modules you loaded) is shared between the processes, and each new process 204modules you loaded) is shared between the processes, and each new process
205consumes relatively little memory of its own. 205consumes relatively little memory of its own.
206 206
207The disadvantage of this approach is that you need to create a template 207The disadvantage of this approach is that you need to create a template
208process for the sole purpose of forking new processes from it, but if you 208process for the sole purpose of forking new processes from it, but if you
209only need a fixed number of proceses you can create them, and then destroy 209only need a fixed number of processes you can create them, and then destroy
210the template process. 210the template process.
211 211
212Example: 212Example:
213 213
214 my $template = AnyEvent::Fork->new->require ("Some::Module"); 214 my $template = AnyEvent::Fork->new->require ("Some::Module");
410reduces the amount of memory sharing that is possible, and is also slower. 410reduces the amount of memory sharing that is possible, and is also slower.
411 411
412You should use C<new> whenever possible, except when having a template 412You should use C<new> whenever possible, except when having a template
413process around is unacceptable. 413process around is unacceptable.
414 414
415The path to the perl interpreter is divined usign various methods - first 415The path to the perl interpreter is divined using various methods - first
416C<$^X> is investigated to see if the path ends with something that sounds 416C<$^X> is investigated to see if the path ends with something that sounds
417as if it were the perl interpreter. Failing this, the module falls back to 417as if it were the perl interpreter. Failing this, the module falls back to
418using C<$Config::Config{perlpath}>. 418using C<$Config::Config{perlpath}>.
419 419
420=cut 420=cut
515accomplished by simply not storing the file handles anywhere after passing 515accomplished by simply not storing the file handles anywhere after passing
516them to this method. 516them to this method.
517 517
518Returns the process object for easy chaining of method calls. 518Returns the process object for easy chaining of method calls.
519 519
520Example: pass an fh to a process, and release it without closing. it will 520Example: pass a file handle to a process, and release it without
521be closed automatically when it is no longer used. 521closing. It will be closed automatically when it is no longer used.
522 522
523 $proc->send_fh ($my_fh); 523 $proc->send_fh ($my_fh);
524 undef $my_fh; # free the reference if you want, but DO NOT CLOSE IT 524 undef $my_fh; # free the reference if you want, but DO NOT CLOSE IT
525 525
526=cut 526=cut
539=item $proc = $proc->send_arg ($string, ...) 539=item $proc = $proc->send_arg ($string, ...)
540 540
541Send one or more argument strings to the process, to prepare a call to 541Send one or more argument strings to the process, to prepare a call to
542C<run>. The strings can be any octet string. 542C<run>. The strings can be any octet string.
543 543
544Returns the process object for easy chaining of emthod calls. 544Returns the process object for easy chaining of method calls.
545 545
546=cut 546=cut
547 547
548sub send_arg { 548sub send_arg {
549 my ($self, @arg) = @_; 549 my ($self, @arg) = @_;
570If the communication socket isn't used, it should be closed on both sides, 570If the communication socket isn't used, it should be closed on both sides,
571to save on kernel memory. 571to save on kernel memory.
572 572
573The socket is non-blocking in the parent, and blocking in the newly 573The socket is non-blocking in the parent, and blocking in the newly
574created process. The close-on-exec flag is set on both. Even if not used 574created process. The close-on-exec flag is set on both. Even if not used
575otherwise, the socket can be a good indicator for the existance of the 575otherwise, the socket can be a good indicator for the existence of the
576process - if the other process exits, you get a readable event on it, 576process - if the other process exits, you get a readable event on it,
577because exiting the process closes the socket (if it didn't create any 577because exiting the process closes the socket (if it didn't create any
578children using fork). 578children using fork).
579 579
580Example: create a template for a process pool, pass a few strings, some 580Example: create a template for a process pool, pass a few strings, some
623 623
624Now for some unscientific benchmark numbers (all done on an amd64 624Now for some unscientific benchmark numbers (all done on an amd64
625GNU/Linux box). These are intended to give you an idea of the relative 625GNU/Linux box). These are intended to give you an idea of the relative
626performance you can expect. 626performance you can expect.
627 627
628Ok, so, I ran a simple benchmark that creates a socketpair, forks, calls 628OK, so, I ran a simple benchmark that creates a socket pair, forks, calls
629exit in the child and waits for the socket to close in the parent. I did 629exit in the child and waits for the socket to close in the parent. I did
630load AnyEvent, EV and AnyEvent::Fork, for a total process size of 6312kB. 630load AnyEvent, EV and AnyEvent::Fork, for a total process size of 6312kB.
631 631
632 2079 new processes per second, using socketpair + fork manually 632 2079 new processes per second, using socketpair + fork manually
633 633
634Then I did the same thing, but instead of calling fork, I called 634Then I did the same thing, but instead of calling fork, I called
635AnyEvent::Fork->new->run ("CORE::exit") and then again waited for the 635AnyEvent::Fork->new->run ("CORE::exit") and then again waited for the
636socket form the child to close on exit. This does the same thing as manual 636socket form the child to close on exit. This does the same thing as manual
637socketpair + fork, except that what is forked is the template process 637socket pair + fork, except that what is forked is the template process
638(2440kB), and the socket needs to be passed to the server at the other end 638(2440kB), and the socket needs to be passed to the server at the other end
639of the socket first. 639of the socket first.
640 640
641 2307 new processes per second, using AnyEvent::Fork->new 641 2307 new processes per second, using AnyEvent::Fork->new
642 642
643And finally, using C<new_exec> instead C<new>, using vforks+execs to exec 643And finally, using C<new_exec> instead C<new>, using vforks+execs to exec
644a new perl interpreter and compile the small server each time, I get: 644a new perl interpreter and compile the small server each time, I get:
645 645
646 479 vfork+execs per second, using AnyEvent::Fork->new_exec 646 479 vfork+execs per second, using AnyEvent::Fork->new_exec
647 647
648So how can C<< AnyEvent->new >> be faster than a standard fork, een though 648So how can C<< AnyEvent->new >> be faster than a standard fork, even
649it uses the same operations, but adds a lot of overhead? 649though it uses the same operations, but adds a lot of overhead?
650 650
651The difference is simply the process size: forking the 6MB process takes 651The difference is simply the process size: forking the 6MB process takes
652so much longer than forking the 2.5MB template process that the overhead 652so much longer than forking the 2.5MB template process that the overhead
653introduced is canceled out. 653introduced is canceled out.
654 654
656 656
657 1340 new processes, manual fork in a 20MB process 657 1340 new processes, manual fork in a 20MB process
658 731 new processes, manual fork in a 200MB process 658 731 new processes, manual fork in a 200MB process
659 235 new processes, manual fork in a 2000MB process 659 235 new processes, manual fork in a 2000MB process
660 660
661What that means (to me) is that I can use this module without havign a 661What that means (to me) is that I can use this module without having a
662very bad conscience because of the extra overhead requried to strat new 662very bad conscience because of the extra overhead required to start new
663processes. 663processes.
664 664
665=head1 TYPICAL PROBLEMS 665=head1 TYPICAL PROBLEMS
666 666
667This section lists typical problems that remain. I hope by recognising 667This section lists typical problems that remain. I hope by recognising
668them, most can be avoided. 668them, most can be avoided.
669 669
670=over 4 670=over 4
671
672=item exit runs destructors
671 673
672=item "leaked" file descriptors for exec'ed processes 674=item "leaked" file descriptors for exec'ed processes
673 675
674POSIX systems inherit file descriptors by default when exec'ing a new 676POSIX systems inherit file descriptors by default when exec'ing a new
675process. While perl itself laudably sets the close-on-exec flags on new 677process. While perl itself laudably sets the close-on-exec flags on new
676file handles, most C libraries don't care, and even if all cared, it's 678file handles, most C libraries don't care, and even if all cared, it's
677often not possible to set the flag in a race-free manner. 679often not possible to set the flag in a race-free manner.
678 680
679That means some file descriptors can leak through. And since it isn't 681That means some file descriptors can leak through. And since it isn't
680possible to know which file descriptors are "good" and "neccessary" (or 682possible to know which file descriptors are "good" and "necessary" (or
681even to know which file descreiptors are open), there is no good way to 683even to know which file descriptors are open), there is no good way to
682close the ones that might harm. 684close the ones that might harm.
683 685
684As an example of what "harm" can be done consider a web server that 686As an example of what "harm" can be done consider a web server that
685accepts connections and afterwards some module uses AnyEvent::Fork for the 687accepts connections and afterwards some module uses AnyEvent::Fork for the
686first time, causing it to fork and exec a new process, which might inherit 688first time, causing it to fork and exec a new process, which might inherit
694well before many random file descriptors are open. 696well before many random file descriptors are open.
695 697
696In general, the solution for these kind of problems is to fix the 698In general, the solution for these kind of problems is to fix the
697libraries or the code that leaks those file descriptors. 699libraries or the code that leaks those file descriptors.
698 700
699Fortunately, most of these lekaed descriptors do no harm, other than 701Fortunately, most of these leaked descriptors do no harm, other than
700sitting on some resources. 702sitting on some resources.
701 703
702=item "leaked" file descriptors for fork'ed processes 704=item "leaked" file descriptors for fork'ed processes
703 705
704Normally, L<AnyEvent::Fork> does start new processes by exec'ing them, 706Normally, L<AnyEvent::Fork> does start new processes by exec'ing them,
724 726
725Native win32 perls are somewhat supported (AnyEvent::Fork::Early is a nop, 727Native win32 perls are somewhat supported (AnyEvent::Fork::Early is a nop,
726and ::Template is not going to work), and it cost a lot of blood and sweat 728and ::Template is not going to work), and it cost a lot of blood and sweat
727to make it so, mostly due to the bloody broken perl that nobody seems to 729to make it so, mostly due to the bloody broken perl that nobody seems to
728care about. The fork emulation is a bad joke - I have yet to see something 730care about. The fork emulation is a bad joke - I have yet to see something
729useful that you cna do with it without running into memory corruption 731useful that you can do with it without running into memory corruption
730issues or other braindamage. Hrrrr. 732issues or other braindamage. Hrrrr.
731 733
732Cygwin perl is not supported at the moment, as it should implement fd 734Cygwin perl is not supported at the moment, as it should implement fd
733passing, but doesn't, and rolling my own is hard, as cygwin doesn't 735passing, but doesn't, and rolling my own is hard, as cygwin doesn't
734support enough functionality to do it. 736support enough functionality to do it.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines