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