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