=head1 NAME Async::Interrupt - allow C/XS libraries to interrupt perl asynchronously =head1 SYNOPSIS use Async::Interrupt; =head1 DESCRIPTION This module implements a single feature only of interest to advanced perl modules, namely asynchronous interruptions (think "UNIX signals", which are very similar). Sometimes, modules wish to run code asynchronously (in another thread, or from a signal handler), and then signal the perl interpreter on certain events. One common way is to write some data to a pipe and use an event handling toolkit to watch for I/O events. Another way is to send a signal. Those methods are slow, and in the case of a pipe, also not asynchronous - it won't interrupt a running perl interpreter. This module implements asynchronous notifications that enable you to signal running perl code from another thread, asynchronously, and sometimes even without using a single syscall. =head2 USAGE SCENARIOS =over 4 =item Race-free signal handling There seems to be no way to do race-free signal handling in perl: to catch a signal, you have to execute Perl code, and between entering the interpreter C on, fixing the race completely. This can be used to implement the signal hadling in event loops, e.g. L, L, L and so on. =item Background threads want speedy reporting Assume you want very exact timing, and you can spare an extra cpu core for that. Then you can run an extra thread that signals your perl interpreter. This means you can get a very exact timing source while your perl code is number crunching, without even using a syscall to communicate between your threads. For example the deliantra game server uses a variant of this technique to interrupt background processes regularly to send map updates to game clients. L and L could also use this to speed up result reporting. =item Speedy event loop invocation One could use this module e.g. in L to interrupt a running coro-thread and cause it to enter the event loop. Or one could bind to C and tell some important sockets to send this signal, causing the event loop to be entered to reduce network latency. =back =head2 HOW TO USE You can use this module by creating an C object for each such event source. This object stores a perl and/or a C-level callback that is invoked when the C object gets signalled. It is executed at the next time the perl interpreter is running (i.e. it will interrupt a computation, but not an XS function or a syscall). You can signal the C object either by calling it's C<< ->signal >> method, or, more commonly, by calling a C function. There is also the built-in (POSIX) signal source. The C<< ->signal_func >> returns the address of the C function that is to be called (plus an argument to be used during the call). The signalling function also takes an integer argument in the range SIG_ATOMIC_MIN to SIG_ATOMIC_MAX (guaranteed to allow at least 0..127). Since this kind of interruption is fast, but can only interrupt a I interpreter, there is optional support for signalling a pipe - that means you can also wait for the pipe to become readable (e.g. via L or L). This, of course, incurs the overhead of a C and C syscall. =over 4 =cut package Async::Interrupt; use common::sense; BEGIN { # the next line forces initialisation of internal # signal handling # variables $SIG{KILL} = sub { }; our $VERSION = '0.501'; require XSLoader; XSLoader::load ("Async::Interrupt", $VERSION); } our $DIED = sub { warn "$@" }; =item $async = new Async::Interrupt key => value... Creates a new Async::Interrupt object. You may only use async notifications on this object while it exists, so you need to keep a reference to it at all times while it is used. Optional constructor arguments include (normally you would specify at least one of C or C). =over 4 =item cb => $coderef->($value) Registers a perl callback to be invoked whenever the async interrupt is signalled. Note that, since this callback can be invoked at basically any time, it must not modify any well-known global variables such as C<$/> without restoring them again before returning. The exceptions are C<$!> and C<$@>, which are saved and restored by Async::Interrupt. If the callback should throw an exception, then it will be caught, and C<$Async::Interrupt::DIED> will be called with C<$@> containing the exception. The default will simply C about the message and continue. =item c_cb => [$c_func, $c_arg] Registers a C callback the be invoked whenever the async interrupt is signalled. The C callback must have the following prototype: void c_func (pTHX_ void *c_arg, int value); Both C<$c_func> and C<$c_arg> must be specified as integers/IVs, and C<$value> is the C passed to some earlier call to either C<$signal> or the C function. Note that, because the callback can be invoked at almost any time, you have to be careful at saving and restoring global variables that Perl might use (the exception is C, which is saved and restored by Async::Interrupt). The callback itself runs as part of the perl context, so you can call any perl functions and modify any perl data structures (in which case the requirements set out for C apply as well). =item var => $scalar_ref When specified, then the given argument must be a reference to a scalar. The scalar will be set to C<0> intiially. Signalling the interrupt object will set it to the passed value, handling the interrupt will reset it to C<0> again. Note that the only thing you are legally allowed to do is to is to check the variable in a boolean or integer context (e.g. comparing it with a string, or printing it, will I it and might cause your program to crash or worse). =item signal => $signame_or_value When this parameter is specified, then the Async::Interrupt will hook the given signal, that is, it will effectively call C<< ->signal (0) >> each time the given signal is caught by the process. Only one async can hook a given signal, and the signal will be restored to defaults when the Async::Interrupt object gets destroyed. =item pipe => [$fileno_or_fh_for_reading, $fileno_or_fh_for_writing] Specifies two file descriptors (or file handles) that should be signalled whenever the async interrupt is signalled. This means a single octet will be written to it, and before the callback is being invoked, it will be read again. Due to races, it is unlikely but possible that multiple octets are written. It is required that the file handles are both in nonblocking mode. The object will keep a reference to the file handles. This can be used to ensure that async notifications will interrupt event frameworks as well. Note that C will create a suitable signal fd automatically when your program requests one, so you don't have to specify this agrument when all you want is an extra file descriptor to watch. =back =cut sub new { my ($class, %arg) = @_; bless \(_alloc $arg{cb}, @{$arg{c_cb}}[0,1], @{$arg{pipe}}[0,1], $arg{signal}, $arg{var}), $class } =item ($signal_func, $signal_arg) = $async->signal_func Returns the address of a function to call asynchronously. The function has the following prototype and needs to be passed the specified C<$c_arg>, which is a C cast to C: void (*signal_func) (void *signal_arg, int value) An example call would look like: signal_func (signal_arg, 0); The function is safe to call from within signal and thread contexts, at any time. The specified C is passed to both C and Perl callback. C<$value> must be in the valid range for a C, except C<0> (1..127 is portable). If the function is called while the Async::Interrupt object is already signaled but before the callbacks are being executed, then the stored C is either the old or the new one. Due to the asynchronous nature of the code, the C can even be passed to two consecutive invocations of the callback. =item $address = $async->c_var Returns the address (cast to IV) of an C variable. The variable is set to C<0> initially and gets set to the passed value whenever the object gets signalled, and reset to C<0> once the interrupt has been handled. Note that it is often beneficial to just call C to handle any interrupts. Example: call some XS function to store the address, then show C code waiting for it. my_xs_func $async->c_var; static IV *valuep; void my_xs_func (void *addr) CODE: valuep = (IV *)addr; // code in a loop, waiting while (!*valuep) ; // do soemthing =item $async->signal ($value=1) This signals the given async object from Perl code. Semi-obviously, this will instantly trigger the callback invocation. C<$value> must be in the valid range for a C, except C<0> (1..127 is portable). =item $async->block =item $async->unblock Sometimes you need a "critical section" of code that will not be interrupted by an Async::Interrupt. This can be implemented by calling C<< $async->block >> before the critical section, and C<< $async->unblock >> afterwards. Note that there must be exactly one call of C for every previous call to C (i.e. calls can nest). Since ensuring this in the presence of exceptions and threads is usually more difficult than you imagine, I recommend using C<< $async->scoped_block >> instead. =item $async->scope_block This call C<< $async->block >> and installs a handler that is called when the current scope is exited (via an exception, by canceling the Coro thread, by calling last/goto etc.). This is the recommended (and fastest) way to implement critical sections. =item $async->pipe_enable =item $async->pipe_disable Enable/disable signalling the pipe when the interrupt occurs (default is enabled). Writing to a pipe is relatively expensive, so it can be disabled when you know you are not waiting for it (for example, with L you could disable the pipe in a check watcher, and enable it in a prepare watcher). Note that currently, while C is in effect, no attempt to read from the pipe will be done when handling events. This might change as soon as I realize why this is a mistake. =item $fileno = $async->pipe_fileno Returns the reading side of the signalling pipe. If no signalling pipe is currently attached to the object, it will dynamically create one. Note that the only valid oepration on this file descriptor is to wait until it is readable. The fd might belong currently to a pipe, a tcp socket, or an eventfd, depending on the platform, and is guaranteed to be C