[project @ 2002-04-10 11:43:43 by stolz]
[ghc-hetmet.git] / ghc / rts / Signals.c
index 219ce67..9edefbb 100644 (file)
@@ -1,5 +1,5 @@
 /* -----------------------------------------------------------------------------
 /* -----------------------------------------------------------------------------
- * $Id: Signals.c,v 1.5 1999/03/02 20:01:55 sof Exp $
+ * $Id: Signals.c,v 1.24 2002/03/26 23:51:27 sof Exp $
  *
  * (c) The GHC Team, 1998-1999
  *
  *
  * (c) The GHC Team, 1998-1999
  *
@@ -7,20 +7,31 @@
  *
  * ---------------------------------------------------------------------------*/
 
  *
  * ---------------------------------------------------------------------------*/
 
+/* This is non-Posix-compliant.
+   #include "PosixSource.h" 
+*/
 #include "Rts.h"
 #include "SchedAPI.h"
 #include "Rts.h"
 #include "SchedAPI.h"
+#include "Schedule.h"
 #include "Signals.h"
 #include "RtsUtils.h"
 #include "RtsFlags.h"
 #include "StablePriv.h"
 
 #include "Signals.h"
 #include "RtsUtils.h"
 #include "RtsFlags.h"
 #include "StablePriv.h"
 
+#ifdef alpha_TARGET_ARCH
+#include <machine/fpu.h>
+#endif
+
 #ifndef mingw32_TARGET_OS
 
 #ifndef PAR
 
 #ifndef mingw32_TARGET_OS
 
 #ifndef PAR
 
+/* SUP: The type of handlers is a little bit, well, doubtful... */
 static StgInt *handlers = NULL; /* Dynamically grown array of signal handlers */
 static StgInt nHandlers = 0;    /* Size of handlers array */
 
 static StgInt *handlers = NULL; /* Dynamically grown array of signal handlers */
 static StgInt nHandlers = 0;    /* Size of handlers array */
 
+static nat n_haskell_handlers = 0;
+
 #define N_PENDING_HANDLERS 16
 
 StgPtr pending_handler_buf[N_PENDING_HANDLERS];
 #define N_PENDING_HANDLERS 16
 
 StgPtr pending_handler_buf[N_PENDING_HANDLERS];
@@ -29,40 +40,55 @@ StgPtr *next_pending_handler = pending_handler_buf;
 StgInt nocldstop = 0;
 
 /* -----------------------------------------------------------------------------
 StgInt nocldstop = 0;
 
 /* -----------------------------------------------------------------------------
-   Allocate/resize the table of signal handlers.
-   -------------------------------------------------------------------------- */
+ * Allocate/resize the table of signal handlers.
+ * -------------------------------------------------------------------------- */
 
 static void
 more_handlers(I_ sig)
 {
 
 static void
 more_handlers(I_ sig)
 {
-    I_ i;
+    StgInt i;
 
     if (sig < nHandlers)
        return;
 
     if (handlers == NULL)
 
     if (sig < nHandlers)
        return;
 
     if (handlers == NULL)
-       handlers = (I_ *) malloc((sig + 1) * sizeof(I_));
+       handlers = (StgInt *) malloc((sig + 1) * sizeof(StgInt));
     else
     else
-       handlers = (I_ *) realloc(handlers, (sig + 1) * sizeof(I_));
+       handlers = (StgInt *) realloc(handlers, (sig + 1) * sizeof(StgInt));
 
     if (handlers == NULL) {
 
     if (handlers == NULL) {
-       fflush(stdout);
-       fprintf(stderr, "VM exhausted (in more_handlers)\n");
-       exit(EXIT_FAILURE);
+       // don't fflush(stdout); WORKAROUND bug in Linux glibc
+       barf("VM exhausted (in more_handlers)");
     }
     for(i = nHandlers; i <= sig; i++)
     }
     for(i = nHandlers; i <= sig; i++)
-       /* Fill in the new slots with default actions */
+       // Fill in the new slots with default actions
        handlers[i] = STG_SIG_DFL;
 
     nHandlers = sig + 1;
 }
 
 /* -----------------------------------------------------------------------------
        handlers[i] = STG_SIG_DFL;
 
     nHandlers = sig + 1;
 }
 
 /* -----------------------------------------------------------------------------
-   Low-level signal handler
+ * SIGCONT handler
+ *
+ * It seems that shells tend to put stdin back into blocking mode
+ * following a suspend/resume of the process.  Here we arrange to put
+ * it back into non-blocking mode.  We don't do anything to
+ * stdout/stderr because these handles don't get put into non-blocking
+ * mode at all - see the comments on stdout/stderr in PrelHandle.hsc.
+ * -------------------------------------------------------------------------- */
 
 
-   Places the requested handler on a stack of pending handlers to be
-   started up at the next context switch.
-   -------------------------------------------------------------------------- */
+static void
+cont_handler(int sig STG_UNUSED)
+{
+    setNonBlockingFd(0);
+}
+
+/* -----------------------------------------------------------------------------
+ * Low-level signal handler
+ *
+ * Places the requested handler on a stack of pending handlers to be
+ * started up at the next context switch.
+ * -------------------------------------------------------------------------- */
 
 static void
 generic_handler(int sig)
 
 static void
 generic_handler(int sig)
@@ -73,7 +99,7 @@ generic_handler(int sig)
        either.  However, we have to schedule a new thread somehow.
 
        It's probably ok to request a context switch and allow the
        either.  However, we have to schedule a new thread somehow.
 
        It's probably ok to request a context switch and allow the
-       scheduler to  start the handler thread, but how to we
+       scheduler to  start the handler thread, but how do we
        communicate this to the scheduler?
 
        We need some kind of locking, but with low overhead (i.e. no
        communicate this to the scheduler?
 
        We need some kind of locking, but with low overhead (i.e. no
@@ -97,22 +123,29 @@ generic_handler(int sig)
        circumstances, depending on the signal.  
     */
 
        circumstances, depending on the signal.  
     */
 
-    *next_pending_handler++ = deRefStablePtr(handlers[sig]);
+    *next_pending_handler++ = deRefStablePtr((StgStablePtr)handlers[sig]);
 
 
-    /* stack full? */
+    // stack full?
     if (next_pending_handler == &pending_handler_buf[N_PENDING_HANDLERS]) {
     if (next_pending_handler == &pending_handler_buf[N_PENDING_HANDLERS]) {
-      barf("too many pending signals");
+       barf("too many pending signals");
     }
     
     }
     
-    /* re-establish the signal handler, and carry on */
+    // re-establish the signal handler, and carry on
     sigemptyset(&signals);
     sigaddset(&signals, sig);
     sigprocmask(SIG_UNBLOCK, &signals, NULL);
     sigemptyset(&signals);
     sigaddset(&signals, sig);
     sigprocmask(SIG_UNBLOCK, &signals, NULL);
+
+    // *always* do the SIGCONT handler, even if the user overrides it.
+    if (sig == SIGCONT) {
+       cont_handler(sig);
+    }
+
+    context_switch = 1;
 }
 
 /* -----------------------------------------------------------------------------
 }
 
 /* -----------------------------------------------------------------------------
-   Blocking/Unblocking of the user signals
-   -------------------------------------------------------------------------- */
+ * Blocking/Unblocking of the user signals
+ * -------------------------------------------------------------------------- */
 
 static sigset_t userSignals;
 static sigset_t savedSignals;
 
 static sigset_t userSignals;
 static sigset_t savedSignals;
@@ -135,24 +168,38 @@ unblockUserSignals(void)
     sigprocmask(SIG_SETMASK, &savedSignals, NULL);
 }
 
     sigprocmask(SIG_SETMASK, &savedSignals, NULL);
 }
 
+rtsBool
+anyUserHandlers(void)
+{
+    return n_haskell_handlers != 0;
+}
+
+void
+awaitUserSignals(void)
+{
+    while (!signals_pending() && !interrupted) {
+       pause();
+    }
+}
 
 /* -----------------------------------------------------------------------------
 
 /* -----------------------------------------------------------------------------
-   Install a Haskell signal handler.
-   -------------------------------------------------------------------------- */
+ * Install a Haskell signal handler.
+ * -------------------------------------------------------------------------- */
 
 StgInt 
 
 StgInt 
-sig_install(StgInt sig, StgInt spi, StgStablePtr handler, sigset_t *mask)
+stg_sig_install(StgInt sig, StgInt spi, StgStablePtr handler, sigset_t *mask)
 {
     sigset_t signals;
     struct sigaction action;
     StgInt previous_spi;
 
 {
     sigset_t signals;
     struct sigaction action;
     StgInt previous_spi;
 
-    /* Block the signal until we figure out what to do */
-    /* Count on this to fail if the signal number is invalid */
-    if(sig < 0 || sigemptyset(&signals) || sigaddset(&signals, sig) ||
-       sigprocmask(SIG_BLOCK, &signals, NULL))
-      return STG_SIG_ERR;
-
+    // Block the signal until we figure out what to do
+    // Count on this to fail if the signal number is invalid
+    if (sig < 0 || sigemptyset(&signals) ||
+       sigaddset(&signals, sig) || sigprocmask(SIG_BLOCK, &signals, NULL)) {
+       return STG_SIG_ERR;
+    }
+    
     more_handlers(sig);
 
     previous_spi = handlers[sig];
     more_handlers(sig);
 
     previous_spi = handlers[sig];
@@ -169,13 +216,16 @@ sig_install(StgInt sig, StgInt spi, StgStablePtr handler, sigset_t *mask)
        sigdelset(&userSignals, sig);
         action.sa_handler = SIG_DFL;
        break;
        sigdelset(&userSignals, sig);
         action.sa_handler = SIG_DFL;
        break;
+
     case STG_SIG_HAN:
     case STG_SIG_HAN:
-       handlers[sig] = (I_)handler;
+       handlers[sig] = (StgInt)handler;
        sigaddset(&userSignals, sig);
        action.sa_handler = generic_handler;
        sigaddset(&userSignals, sig);
        action.sa_handler = generic_handler;
+       n_haskell_handlers++;
        break;
        break;
+
     default:
     default:
-        barf("sig_install: bad spi");
+        barf("stg_sig_install: bad spi");
     }
 
     if (mask != 0)
     }
 
     if (mask != 0)
@@ -188,24 +238,23 @@ sig_install(StgInt sig, StgInt spi, StgStablePtr handler, sigset_t *mask)
     if (sigaction(sig, &action, NULL) || 
        sigprocmask(SIG_UNBLOCK, &signals, NULL)) 
     {
     if (sigaction(sig, &action, NULL) || 
        sigprocmask(SIG_UNBLOCK, &signals, NULL)) 
     {
-      /* need to return an error code, so avoid a stable pointer leak
-       * by freeing the previous handler if there was one.
-       */       
-      if (previous_spi >= 0) {
-         freeStablePtr(handlers[sig]);
-      }
-      return STG_SIG_ERR;
+       // need to return an error code, so avoid a stable pointer leak
+       // by freeing the previous handler if there was one.
+       if (previous_spi >= 0) {
+           freeStablePtr(stgCast(StgStablePtr,handlers[sig]));
+           n_haskell_handlers--;
+       }
+       return STG_SIG_ERR;
     }
     }
-
+    
     return previous_spi;
 }
 
 /* -----------------------------------------------------------------------------
     return previous_spi;
 }
 
 /* -----------------------------------------------------------------------------
-   Creating new threads for the pending signal handlers.
-   -------------------------------------------------------------------------- */
-
+ * Creating new threads for the pending signal handlers.
+ * -------------------------------------------------------------------------- */
 void
 void
-start_signal_handlers(void)
+startSignalHandlers(void)
 {
   blockUserSignals();
   
 {
   blockUserSignals();
   
@@ -213,31 +262,116 @@ start_signal_handlers(void)
 
     next_pending_handler--;
 
 
     next_pending_handler--;
 
-    /* create*Thread  puts the thread on the head of the runnable
-     * queue, hence it will be run next.  Poor man's priority
-     * scheduling.
-     */
-    createIOThread(RtsFlags.GcFlags.initialStkSize, 
-                  (StgClosure *) *next_pending_handler);
+    scheduleThread(
+       createIOThread(RtsFlags.GcFlags.initialStkSize, 
+                     (StgClosure *) *next_pending_handler));
   }
 
   unblockUserSignals();
 }
 
   }
 
   unblockUserSignals();
 }
 
-#else /* PAR */
+#else // PAR
 StgInt 
 StgInt 
-sig_install(StgInt sig, StgInt spi, StgStablePtr handler, sigset_t *mask)
+stg_sig_install(StgInt sig, StgInt spi, StgStablePtr handler, sigset_t *mask)
 {
 {
-    fflush(stdout);
-    fprintf(stderr,
-           "No signal handling support in a parallel implementation.\n");
-    exit(EXIT_FAILURE);
+    // don't fflush(stdout); WORKAROUND bug in Linux glibc
+    barf("no signal handling support in a parallel implementation");
 }
 
 void
 }
 
 void
-start_signal_handlers(void)
+startSignalHandlers(void)
+{
+}
+#endif
+
+/* -----------------------------------------------------------------------------
+ * SIGINT handler.
+ *
+ * We like to shutdown nicely after receiving a SIGINT, write out the
+ * stats, write profiling info, close open files and flush buffers etc.
+ * -------------------------------------------------------------------------- */
+#ifdef SMP
+pthread_t startup_guy;
+#endif
+
+static void
+shutdown_handler(int sig STG_UNUSED)
 {
 {
+#ifdef SMP
+    // if I'm a worker thread, send this signal to the guy who
+    // originally called startupHaskell().  Since we're handling
+    // the signal, it won't be a "send to all threads" type of signal
+    // (according to the POSIX threads spec).
+    if (pthread_self() != startup_guy) {
+       pthread_kill(startup_guy, sig);
+       return;
+    }
+#endif
+
+    // If we're already trying to interrupt the RTS, terminate with
+    // extreme prejudice.  So the first ^C tries to exit the program
+    // cleanly, and the second one just kills it.
+    if (interrupted) {
+       exit(EXIT_INTERRUPTED);
+    } else {
+       interruptStgRts();
+    }
 }
 }
+
+/* -----------------------------------------------------------------------------
+ * Install default signal handlers.
+ *
+ * The RTS installs a default signal handler for catching
+ * SIGINT, so that we can perform an orderly shutdown.
+ *
+ * Haskell code may install their own SIGINT handler, which is
+ * fine, provided they're so kind as to put back the old one
+ * when they de-install.
+ *
+ * In addition to handling SIGINT, the RTS also handles SIGFPE
+ * by ignoring it.  Apparently IEEE requires floating-point
+ * exceptions to be ignored by default, but alpha-dec-osf3
+ * doesn't seem to do so.
+ * -------------------------------------------------------------------------- */
+void
+initDefaultHandlers()
+{
+    struct sigaction action,oact;
+
+#ifdef SMP
+    startup_guy = pthread_self();
 #endif
 
 #endif
 
+    // install the SIGINT handler
+    action.sa_handler = shutdown_handler;
+    sigemptyset(&action.sa_mask);
+    action.sa_flags = 0;
+    if (sigaction(SIGINT, &action, &oact) != 0) {
+       prog_belch("warning: failed to install SIGINT handler");
+    }
+
+#ifndef cygwin32_TARGET_OS
+    siginterrupt(SIGINT, 1);   // isn't this the default? --SDM
+#endif
+
+    // install the SIGCONT handler
+    action.sa_handler = cont_handler;
+    sigemptyset(&action.sa_mask);
+    action.sa_flags = 0;
+    if (sigaction(SIGCONT, &action, &oact) != 0) {
+       prog_belch("warning: failed to install SIGCONT handler");
+    }
+
+    // install the SIGFPE handler
+    action.sa_handler = SIG_IGN;
+    sigemptyset(&action.sa_mask);
+    action.sa_flags = 0;
+    if (sigaction(SIGFPE, &action, &oact) != 0) {
+       prog_belch("warning: failed to install SIGFPE handler");
+    }
+#ifdef alpha_TARGET_ARCH
+    ieee_set_fp_control(0);
+#endif
+}
+
 #endif /*! mingw32_TARGET_OS */
 #endif /*! mingw32_TARGET_OS */