pd.if.org Git - pdclib.old/blob - platform/example/includes/signal.h

   1 /* $Id$ */
   2
   3 /* 7.14 Signal handling <string.h>
   4
   5    This file is part of the Public Domain C Library (PDCLib).
   6    Permission is granted to use, modify, and / or redistribute at will.
   7 */
   8
   9 #ifndef _PDCLIB_SIGNAL_H
  10 #define _PDCLIB_SIGNAL_H _PDCLIB_SIGNAL_H
  11
  12 #ifndef _PDCLIB_CONFIG_H
  13 #define _PDCLIB_CONFIG_H _PDCLIB_CONFIG_H
  14 #include <_PDCLIB_config.h>
  15 #endif
  16
  17 /* Signals ------------------------------------------------------------------ */
  18
  19 /* A word on signals, to the people using PDCLib in their OS projects.
  20
  21    The definitions of the C standard leave about everything that *could* be
  22    useful to be "implementation defined". Without additional, non-standard
  23    arrangements, it is not possible to turn them into a useful tool.
  24
  25    This example implementation chose to "not generate any of these signals,
  26    except as a result of explicit calls to the raise function", which is
  27    allowed by the standard but of course does nothing for the usefulness of
  28    <signal.h>.
  29
  30    A useful signal handling would:
  31    1) make signal() a system call that registers the signal handler with the OS
  32    2) make raise() a system call triggering an OS signal to the running process
  33    3) make provisions that further signals of the same type are blocked until
  34       the signal handler returns (optional for SIGILL)
  35 */
  36
  37 /* These are the values used by Linux. */
  38
  39 /* Abnormal termination / abort() */
  40 #define SIGABRT 6
  41 /* Arithmetic exception / division by zero / overflow */
  42 #define SIGFPE  8
  43 /* Illegal instruction */
  44 #define SIGILL  4
  45 /* Interactive attention signal */
  46 #define SIGINT  2
  47 /* Invalid memory access */
  48 #define SIGSEGV 11
  49 /* Termination request */
  50 #define SIGTERM 15
  51
  52 /* The following should be defined to pointer values that could NEVER point to
  53    a valid signal handler function. (They are used as special arguments to
  54    signal().) Again, these are the values used by Linux.
  55 */
  56 #define SIG_DFL (void (*)( int ))0
  57 #define SIG_ERR (void (*)( int ))-1
  58 #define SIG_IGN (void (*)( int ))1
  59
  60 typedef _PDCLIB_sig_atomic sig_atomic_t;
  61
  62 /* Installs a signal handler "func" for the given signal.
  63    A signal handler is a function that takes an integer as argument (the signal
  64    number) and returns void.
  65
  66    Note that a signal handler can do very little else than:
  67    1) assign a value to a static object of type "volatile sig_atomic_t",
  68    2) call signal() with the value of sig equal to the signal received,
  69    3) call _Exit(),
  70    4) call abort().
  71    Virtually everything else is undefind.
  72
  73    The signal() function returns the previous installed signal handler, which
  74    at program start may be SIG_DFL or SIG_ILL. (This implementation uses
  75    SIG_DFL for all handlers.) If the request cannot be honored, SIG_ERR is
  76    returned and errno is set to an unspecified positive value.
  77 */
  78 void (*signal( int sig, void (*func)( int ) ) )( int );
  79
  80 /* Raises the given signal (executing the registered signal handler with the
  81    given signal number as parameter).
  82    This implementation does not prevent further signals of the same time from
  83    occuring, but executes signal( sig, SIG_DFL ) before entering the signal
  84    handler (i.e., a second signal before the signal handler re-registers itself
  85    or SIG_IGN will end the program).
  86    Returns zero if successful, nonzero otherwise. */
  87 int raise( int sig );
  88
  89 #endif
  90