… | |
… | |
10 | |
10 | |
11 | This module implements a single feature only of interest to advanced perl |
11 | This module implements a single feature only of interest to advanced perl |
12 | modules, namely asynchronous interruptions (think "UNIX signals", which |
12 | modules, namely asynchronous interruptions (think "UNIX signals", which |
13 | are very similar). |
13 | are very similar). |
14 | |
14 | |
15 | Sometimes, modules wish to run code asynchronously (in another thread), |
15 | Sometimes, modules wish to run code asynchronously (in another thread, |
16 | and then signal the perl interpreter on certain events. One common way is |
16 | or from a signal handler), and then signal the perl interpreter on |
17 | to write some data to a pipe and use an event handling toolkit to watch |
17 | certain events. One common way is to write some data to a pipe and use an |
18 | for I/O events. Another way is to send a signal. Those methods are slow, |
18 | event handling toolkit to watch for I/O events. Another way is to send |
19 | and in the case of a pipe, also not asynchronous - it won't interrupt a |
19 | a signal. Those methods are slow, and in the case of a pipe, also not |
20 | running perl interpreter. |
20 | asynchronous - it won't interrupt a running perl interpreter. |
21 | |
21 | |
22 | This module implements asynchronous notifications that enable you to |
22 | This module implements asynchronous notifications that enable you to |
23 | signal running perl code form another thread, asynchronously, without |
23 | signal running perl code from another thread, asynchronously, and |
24 | issuing syscalls. |
24 | sometimes even without using a single syscall. |
25 | |
25 | |
26 | It works by creating an C<Async::Interrupt> object for each such use. This |
26 | =head2 USAGE SCENARIOS |
27 | object stores a perl and/or a C-level callback that is invoked when the |
27 | |
28 | C<Async::Interrupt> object gets signalled. It is executed at the next time |
28 | =over 4 |
29 | the perl interpreter is running (i.e. it will interrupt a computation, but |
29 | |
30 | not an XS function or a syscall). |
30 | =item Race-free signal handling |
|
|
31 | |
|
|
32 | There seems to be no way to do race-free signal handling in perl: to |
|
|
33 | catch a signal, you have to execute Perl code, and between entering the |
|
|
34 | interpreter C<select> function (or other blocking functions) and executing |
|
|
35 | the select syscall is a small but relevant timespan during which signals |
|
|
36 | will be queued, but perl signal handlers will not be executed and the |
|
|
37 | blocking syscall will not be interrupted. |
|
|
38 | |
|
|
39 | You can use this module to bind a signal to a callback while at the same |
|
|
40 | time activating an event pipe that you can C<select> on, fixing the race |
|
|
41 | completely. |
|
|
42 | |
|
|
43 | This can be used to implement the signal hadling in event loops, |
|
|
44 | e.g. L<AnyEvent>, L<POE>, L<IO::Async::Loop> and so on. |
|
|
45 | |
|
|
46 | =item Background threads want speedy reporting |
|
|
47 | |
|
|
48 | Assume you want very exact timing, and you can spare an extra cpu core |
|
|
49 | for that. Then you can run an extra thread that signals your perl |
|
|
50 | interpreter. This means you can get a very exact timing source while your |
|
|
51 | perl code is number crunching, without even using a syscall to communicate |
|
|
52 | between your threads. |
|
|
53 | |
|
|
54 | For example the deliantra game server uses a variant of this technique |
|
|
55 | to interrupt background processes regularly to send map updates to game |
|
|
56 | clients. |
|
|
57 | |
|
|
58 | Or L<EV::Loop::Async> uses an interrupt object to wake up perl when new |
|
|
59 | events have arrived. |
|
|
60 | |
|
|
61 | L<IO::AIO> and L<BDB> could also use this to speed up result reporting. |
|
|
62 | |
|
|
63 | =item Speedy event loop invocation |
|
|
64 | |
|
|
65 | One could use this module e.g. in L<Coro> to interrupt a running coro-thread |
|
|
66 | and cause it to enter the event loop. |
|
|
67 | |
|
|
68 | Or one could bind to C<SIGIO> and tell some important sockets to send this |
|
|
69 | signal, causing the event loop to be entered to reduce network latency. |
|
|
70 | |
|
|
71 | =back |
|
|
72 | |
|
|
73 | =head2 HOW TO USE |
|
|
74 | |
|
|
75 | You can use this module by creating an C<Async::Interrupt> object for each |
|
|
76 | such event source. This object stores a perl and/or a C-level callback |
|
|
77 | that is invoked when the C<Async::Interrupt> object gets signalled. It is |
|
|
78 | executed at the next time the perl interpreter is running (i.e. it will |
|
|
79 | interrupt a computation, but not an XS function or a syscall). |
31 | |
80 | |
32 | You can signal the C<Async::Interrupt> object either by calling it's C<< |
81 | You can signal the C<Async::Interrupt> object either by calling it's C<< |
33 | ->signal >> method, or, more commonly, by calling a C function. |
82 | ->signal >> method, or, more commonly, by calling a C function. There is |
|
|
83 | also the built-in (POSIX) signal source. |
34 | |
84 | |
35 | The C<< ->signal_func >> returns the address of the C function that is to |
85 | The C<< ->signal_func >> returns the address of the C function that is to |
36 | be called (plus an argument to be used during the call). The signalling |
86 | be called (plus an argument to be used during the call). The signalling |
37 | function also takes an integer argument in the range SIG_ATOMIC_MIN to |
87 | function also takes an integer argument in the range SIG_ATOMIC_MIN to |
38 | SIG_ATOMIC_MAX (guaranteed to allow at least 0..127). |
88 | SIG_ATOMIC_MAX (guaranteed to allow at least 0..127). |
39 | |
89 | |
40 | Since this kind of interruption is fast, but can only interrupt a |
90 | Since this kind of interruption is fast, but can only interrupt a |
41 | I<running> interpreter, there is optional support for also signalling a |
91 | I<running> interpreter, there is optional support for signalling a pipe |
42 | pipe - that means you can also wait for the pipe to become readable (e.g. |
92 | - that means you can also wait for the pipe to become readable (e.g. via |
43 | via L<EV> or L<AnyEvent>). This, of course, incurs the overhead of a |
93 | L<EV> or L<AnyEvent>). This, of course, incurs the overhead of a C<read> |
44 | C<read> and C<write> syscall. |
94 | and C<write> syscall. |
|
|
95 | |
|
|
96 | =head1 THE Async::Interrupt CLASS |
45 | |
97 | |
46 | =over 4 |
98 | =over 4 |
47 | |
99 | |
48 | =cut |
100 | =cut |
49 | |
101 | |
50 | package Async::Interrupt; |
102 | package Async::Interrupt; |
51 | |
103 | |
52 | no warnings; |
104 | use common::sense; |
53 | |
105 | |
54 | BEGIN { |
106 | BEGIN { |
|
|
107 | # the next line forces initialisation of internal |
|
|
108 | # signal handling # variables |
|
|
109 | $SIG{KILL} = sub { }; |
|
|
110 | |
55 | $VERSION = '0.03'; |
111 | our $VERSION = '0.6'; |
56 | |
112 | |
57 | require XSLoader; |
113 | require XSLoader; |
58 | XSLoader::load Async::Interrupt::, $VERSION; |
114 | XSLoader::load ("Async::Interrupt", $VERSION); |
59 | } |
115 | } |
60 | |
116 | |
61 | our $DIED = sub { warn "$@" }; |
117 | our $DIED = sub { warn "$@" }; |
62 | |
118 | |
63 | =item $async = new Async::Interrupt key => value... |
119 | =item $async = new Async::Interrupt key => value... |
… | |
… | |
106 | might use (the exception is C<errno>, which is saved and restored by |
162 | might use (the exception is C<errno>, which is saved and restored by |
107 | Async::Interrupt). The callback itself runs as part of the perl context, |
163 | Async::Interrupt). The callback itself runs as part of the perl context, |
108 | so you can call any perl functions and modify any perl data structures (in |
164 | so you can call any perl functions and modify any perl data structures (in |
109 | which case the requirements set out for C<cb> apply as well). |
165 | which case the requirements set out for C<cb> apply as well). |
110 | |
166 | |
|
|
167 | =item var => $scalar_ref |
|
|
168 | |
|
|
169 | When specified, then the given argument must be a reference to a |
|
|
170 | scalar. The scalar will be set to C<0> initially. Signalling the interrupt |
|
|
171 | object will set it to the passed value, handling the interrupt will reset |
|
|
172 | it to C<0> again. |
|
|
173 | |
|
|
174 | Note that the only thing you are legally allowed to do is to is to check |
|
|
175 | the variable in a boolean or integer context (e.g. comparing it with a |
|
|
176 | string, or printing it, will I<destroy> it and might cause your program to |
|
|
177 | crash or worse). |
|
|
178 | |
111 | =item signal => $signame_or_value |
179 | =item signal => $signame_or_value |
112 | |
180 | |
113 | When this parameter is specified, then the Async::Interrupt will hook the |
181 | When this parameter is specified, then the Async::Interrupt will hook the |
114 | given signal, that is, it will effectively call C<< ->signal (0) >> each time |
182 | given signal, that is, it will effectively call C<< ->signal (0) >> each time |
115 | the given signal is caught by the process. |
183 | the given signal is caught by the process. |
… | |
… | |
124 | be written to it, and before the callback is being invoked, it will be |
192 | be written to it, and before the callback is being invoked, it will be |
125 | read again. Due to races, it is unlikely but possible that multiple octets |
193 | read again. Due to races, it is unlikely but possible that multiple octets |
126 | are written. It is required that the file handles are both in nonblocking |
194 | are written. It is required that the file handles are both in nonblocking |
127 | mode. |
195 | mode. |
128 | |
196 | |
129 | You can get a portable pipe and set non-blocking mode portably by using |
|
|
130 | e.g. L<AnyEvent::Util> from the L<AnyEvent> distribution. |
|
|
131 | |
|
|
132 | It is also possible to pass in a linux eventfd as both read and write |
|
|
133 | handle (which is faster than a pipe). |
|
|
134 | |
|
|
135 | The object will keep a reference to the file handles. |
197 | The object will keep a reference to the file handles. |
136 | |
198 | |
137 | This can be used to ensure that async notifications will interrupt event |
199 | This can be used to ensure that async notifications will interrupt event |
138 | frameworks as well. |
200 | frameworks as well. |
139 | |
201 | |
|
|
202 | Note that C<Async::Interrupt> will create a suitable signal fd |
|
|
203 | automatically when your program requests one, so you don't have to specify |
|
|
204 | this argument when all you want is an extra file descriptor to watch. |
|
|
205 | |
|
|
206 | If you want to share a single event pipe between multiple Async::Interrupt |
|
|
207 | objects, you can use the C<Async::Interrupt::EventPipe> class to manage |
|
|
208 | those. |
|
|
209 | |
140 | =back |
210 | =back |
141 | |
211 | |
142 | =cut |
212 | =cut |
143 | |
213 | |
144 | sub new { |
214 | sub new { |
145 | my ($class, %arg) = @_; |
215 | my ($class, %arg) = @_; |
146 | |
216 | |
147 | bless \(_alloc $arg{cb}, @{$arg{c_cb}}[0,1], @{$arg{pipe}}[0,1], $arg{signal}), $class |
217 | bless \(_alloc $arg{cb}, @{$arg{c_cb}}[0,1], @{$arg{pipe}}[0,1], $arg{signal}, $arg{var}), $class |
148 | } |
218 | } |
149 | |
219 | |
150 | =item ($signal_func, $signal_arg) = $async->signal_func |
220 | =item ($signal_func, $signal_arg) = $async->signal_func |
151 | |
221 | |
152 | Returns the address of a function to call asynchronously. The function has |
222 | Returns the address of a function to call asynchronously. The function |
153 | the following prototype and needs to be passed the specified C<$c_arg>, |
223 | has the following prototype and needs to be passed the specified |
154 | which is a C<void *> cast to C<IV>: |
224 | C<$signal_arg>, which is a C<void *> cast to C<IV>: |
155 | |
225 | |
156 | void (*signal_func) (void *signal_arg, int value) |
226 | void (*signal_func) (void *signal_arg, int value) |
157 | |
227 | |
158 | An example call would look like: |
228 | An example call would look like: |
159 | |
229 | |
160 | signal_func (signal_arg, 0); |
230 | signal_func (signal_arg, 0); |
161 | |
231 | |
162 | The function is safe to call from within signal and thread contexts, at |
232 | The function is safe to call from within signal and thread contexts, at |
163 | any time. The specified C<value> is passed to both C and Perl callback. |
233 | any time. The specified C<value> is passed to both C and Perl callback. |
164 | |
234 | |
165 | C<$value> must be in the valid range for a C<sig_atomic_t> (0..127 is |
235 | C<$value> must be in the valid range for a C<sig_atomic_t>, except C<0> |
166 | portable). |
236 | (1..127 is portable). |
167 | |
237 | |
168 | If the function is called while the Async::Interrupt object is already |
238 | If the function is called while the Async::Interrupt object is already |
169 | signaled but before the callbacks are being executed, then the stored |
239 | signaled but before the callbacks are being executed, then the stored |
170 | C<value> is either the old or the new one. Due to the asynchronous |
240 | C<value> is either the old or the new one. Due to the asynchronous |
171 | nature of the code, the C<value> can even be passed to two consecutive |
241 | nature of the code, the C<value> can even be passed to two consecutive |
172 | invocations of the callback. |
242 | invocations of the callback. |
173 | |
243 | |
|
|
244 | =item $address = $async->c_var |
|
|
245 | |
|
|
246 | Returns the address (cast to IV) of an C<IV> variable. The variable is set |
|
|
247 | to C<0> initially and gets set to the passed value whenever the object |
|
|
248 | gets signalled, and reset to C<0> once the interrupt has been handled. |
|
|
249 | |
|
|
250 | Note that it is often beneficial to just call C<PERL_ASYNC_CHECK ()> to |
|
|
251 | handle any interrupts. |
|
|
252 | |
|
|
253 | Example: call some XS function to store the address, then show C code |
|
|
254 | waiting for it. |
|
|
255 | |
|
|
256 | my_xs_func $async->c_var; |
|
|
257 | |
|
|
258 | static IV *valuep; |
|
|
259 | |
|
|
260 | void |
|
|
261 | my_xs_func (void *addr) |
|
|
262 | CODE: |
|
|
263 | valuep = (IV *)addr; |
|
|
264 | |
|
|
265 | // code in a loop, waiting |
|
|
266 | while (!*valuep) |
|
|
267 | ; // do something |
|
|
268 | |
174 | =item $async->signal ($value=0) |
269 | =item $async->signal ($value=1) |
175 | |
270 | |
176 | This signals the given async object from Perl code. Semi-obviously, this |
271 | This signals the given async object from Perl code. Semi-obviously, this |
177 | will instantly trigger the callback invocation. |
272 | will instantly trigger the callback invocation (it does not, as the name |
|
|
273 | might imply, do anything with POSIX signals). |
178 | |
274 | |
179 | C<$value> must be in the valid range for a C<sig_atomic_t> (0..127 is |
275 | C<$value> must be in the valid range for a C<sig_atomic_t>, except C<0> |
180 | portable). |
276 | (1..127 is portable). |
|
|
277 | |
|
|
278 | =item $async->signal_hysteresis ($enable) |
|
|
279 | |
|
|
280 | Enables or disables signal hysteresis (default: disabled). If a POSIX |
|
|
281 | signal is used as a signal source for the interrupt object, then enabling |
|
|
282 | signal hysteresis causes Async::Interrupt to reset the signal action to |
|
|
283 | C<SIG_IGN> in the signal handler and restore it just before handling the |
|
|
284 | interruption. |
|
|
285 | |
|
|
286 | When you expect a lot of signals (e.g. when using SIGIO), then enabling |
|
|
287 | signal hysteresis can reduce the number of handler invocations |
|
|
288 | considerably, at the cost of two extra syscalls. |
|
|
289 | |
|
|
290 | Note that setting the signal to C<SIG_IGN> can have unintended side |
|
|
291 | effects when you fork and exec other programs, as often they do nto expect |
|
|
292 | signals to be ignored by default. |
181 | |
293 | |
182 | =item $async->block |
294 | =item $async->block |
183 | |
295 | |
184 | =item $async->unblock |
296 | =item $async->unblock |
185 | |
297 | |
… | |
… | |
200 | This call C<< $async->block >> and installs a handler that is called when |
312 | This call C<< $async->block >> and installs a handler that is called when |
201 | the current scope is exited (via an exception, by canceling the Coro |
313 | the current scope is exited (via an exception, by canceling the Coro |
202 | thread, by calling last/goto etc.). |
314 | thread, by calling last/goto etc.). |
203 | |
315 | |
204 | This is the recommended (and fastest) way to implement critical sections. |
316 | This is the recommended (and fastest) way to implement critical sections. |
|
|
317 | |
|
|
318 | =item ($block_func, $block_arg) = $async->scope_block_func |
|
|
319 | |
|
|
320 | Returns the address of a function that implements the C<scope_block> |
|
|
321 | functionality. |
|
|
322 | |
|
|
323 | It has the following prototype and needs to be passed the specified |
|
|
324 | C<$block_arg>, which is a C<void *> cast to C<IV>: |
|
|
325 | |
|
|
326 | void (*block_func) (void *block_arg) |
|
|
327 | |
|
|
328 | An example call would look like: |
|
|
329 | |
|
|
330 | block_func (block_arg); |
|
|
331 | |
|
|
332 | The function is safe to call only from within the toplevel of a perl XS |
|
|
333 | function and will call C<LEAVE> and C<ENTER> (in this order!). |
205 | |
334 | |
206 | =item $async->pipe_enable |
335 | =item $async->pipe_enable |
207 | |
336 | |
208 | =item $async->pipe_disable |
337 | =item $async->pipe_disable |
209 | |
338 | |
… | |
… | |
211 | enabled). Writing to a pipe is relatively expensive, so it can be disabled |
340 | enabled). Writing to a pipe is relatively expensive, so it can be disabled |
212 | when you know you are not waiting for it (for example, with L<EV> you |
341 | when you know you are not waiting for it (for example, with L<EV> you |
213 | could disable the pipe in a check watcher, and enable it in a prepare |
342 | could disable the pipe in a check watcher, and enable it in a prepare |
214 | watcher). |
343 | watcher). |
215 | |
344 | |
216 | Note that when C<fd_disable> is in effect, no attempt to read from the |
345 | Note that currently, while C<pipe_disable> is in effect, no attempt to |
217 | pipe will be done. |
346 | read from the pipe will be done when handling events. This might change as |
|
|
347 | soon as I realize why this is a mistake. |
|
|
348 | |
|
|
349 | =item $fileno = $async->pipe_fileno |
|
|
350 | |
|
|
351 | Returns the reading side of the signalling pipe. If no signalling pipe is |
|
|
352 | currently attached to the object, it will dynamically create one. |
|
|
353 | |
|
|
354 | Note that the only valid oepration on this file descriptor is to wait |
|
|
355 | until it is readable. The fd might belong currently to a pipe, a tcp |
|
|
356 | socket, or an eventfd, depending on the platform, and is guaranteed to be |
|
|
357 | C<select>able. |
|
|
358 | |
|
|
359 | =item $async->pipe_autodrain ($enable) |
|
|
360 | |
|
|
361 | Enables (C<1>) or disables (C<0>) automatic draining of the pipe (default: |
|
|
362 | enabled). When automatic draining is enabled, then Async::Interrupt will |
|
|
363 | automatically clear the pipe. Otherwise the user is responsible for this |
|
|
364 | draining. |
|
|
365 | |
|
|
366 | This is useful when you want to share one pipe among many Async::Interrupt |
|
|
367 | objects. |
|
|
368 | |
|
|
369 | =item $async->post_fork |
|
|
370 | |
|
|
371 | The object will not normally be usable after a fork (as the pipe fd is |
|
|
372 | shared between processes). Calling this method after a fork in the child |
|
|
373 | ensures that the object will work as expected again. It only needs to be |
|
|
374 | called when the async object is used in the child. |
|
|
375 | |
|
|
376 | This only works when the pipe was created by Async::Interrupt. |
|
|
377 | |
|
|
378 | Async::Interrupt ensures that the reading file descriptor does not change |
|
|
379 | it's value. |
|
|
380 | |
|
|
381 | =back |
|
|
382 | |
|
|
383 | =head1 THE Async::Interrupt::EventPipe CLASS |
|
|
384 | |
|
|
385 | Pipes are the predominent utility to make asynchronous signals |
|
|
386 | synchronous. However, pipes are hard to come by: they don't exist on the |
|
|
387 | broken windows platform, and on GNU/Linux systems, you might want to use |
|
|
388 | an C<eventfd> instead. |
|
|
389 | |
|
|
390 | This class creates selectable event pipes in a portable fashion: on |
|
|
391 | windows, it will try to create a tcp socket pair, on GNU/Linux, it will |
|
|
392 | try to create an eventfd and everywhere else it will try to use a normal |
|
|
393 | pipe. |
|
|
394 | |
|
|
395 | =over 4 |
|
|
396 | |
|
|
397 | =item $epipe = new Async::Interrupt::EventPipe |
|
|
398 | |
|
|
399 | This creates and returns an eventpipe object. This object is simply a |
|
|
400 | blessed array reference: |
|
|
401 | |
|
|
402 | =item ($r_fd, $w_fd) = $epipe->filenos |
|
|
403 | |
|
|
404 | Returns the read-side file descriptor and the write-side file descriptor. |
|
|
405 | |
|
|
406 | Example: pass an eventpipe object as pipe to the Async::Interrupt |
|
|
407 | constructor, and create an AnyEvent watcher for the read side. |
|
|
408 | |
|
|
409 | my $epipe = new Async::Interrupt::EventPipe; |
|
|
410 | my $asy = new Async::Interrupt pipe => [$epipe->filenos]; |
|
|
411 | my $iow = AnyEvent->io (fh => $epipe->fileno, poll => 'r', cb => sub { }); |
|
|
412 | |
|
|
413 | =item $r_fd = $epipe->fileno |
|
|
414 | |
|
|
415 | Return only the reading/listening side. |
|
|
416 | |
|
|
417 | =item $epipe->signal |
|
|
418 | |
|
|
419 | Write something to the pipe, in a portable fashion. |
|
|
420 | |
|
|
421 | =item $epipe->drain |
|
|
422 | |
|
|
423 | Drain (empty) the pipe. |
|
|
424 | |
|
|
425 | =item $epipe->renew |
|
|
426 | |
|
|
427 | Recreates the pipe (useful after a fork). The reading side will not change |
|
|
428 | it's file descriptor number, but the writing side might. |
|
|
429 | |
|
|
430 | =back |
218 | |
431 | |
219 | =cut |
432 | =cut |
220 | |
433 | |
221 | 1; |
434 | 1; |
222 | |
435 | |
223 | =back |
|
|
224 | |
|
|
225 | =head1 EXAMPLE |
436 | =head1 EXAMPLE |
226 | |
437 | |
227 | There really should be a complete C/XS example. Bug me about it. |
438 | There really should be a complete C/XS example. Bug me about it. Better |
|
|
439 | yet, create one. |
228 | |
440 | |
229 | =head1 IMPLEMENTATION DETAILS AND LIMITATIONS |
441 | =head1 IMPLEMENTATION DETAILS AND LIMITATIONS |
230 | |
442 | |
231 | This module works by "hijacking" SIGKILL, which is guaranteed to be always |
443 | This module works by "hijacking" SIGKILL, which is guaranteed to always |
232 | available in perl, but also cannot be caught, so is always available. |
444 | exist, but also cannot be caught, so is always available. |
233 | |
445 | |
234 | Basically, this module fakes the receive of a SIGKILL signal and |
446 | Basically, this module fakes the occurance of a SIGKILL signal and |
235 | then catches it. This makes normal signal handling slower (probably |
447 | then intercepts the interpreter handling it. This makes normal signal |
236 | unmeasurably), but has the advantage of not requiring a special runops nor |
448 | handling slower (probably unmeasurably, though), but has the advantage |
237 | slowing down normal perl execution a bit. |
449 | of not requiring a special runops function, nor slowing down normal perl |
|
|
450 | execution a bit. |
238 | |
451 | |
239 | It assumes that C<sig_atomic_t> and C<int> are both exception-safe to |
452 | It assumes that C<sig_atomic_t>, C<int> and C<IV> are all async-safe to |
240 | modify (C<sig_atomic_> is used by this module, and perl itself uses |
453 | modify. |
241 | C<int>, so we can assume that this is quite portable, at least w.r.t. |
|
|
242 | signals). |
|
|
243 | |
454 | |
244 | =head1 AUTHOR |
455 | =head1 AUTHOR |
245 | |
456 | |
246 | Marc Lehmann <schmorp@schmorp.de> |
457 | Marc Lehmann <schmorp@schmorp.de> |
247 | http://home.schmorp.de/ |
458 | http://home.schmorp.de/ |