ghc/rts/win32/ConsoleHandler.c

   1 /*
   2  * Console control handler support.
   3  *
   4  */
   5 #include "Rts.h"
   6 #include <windows.h>
   7 #include "ConsoleHandler.h"
   8 #include "SchedAPI.h"
   9 #include "Schedule.h"
  10 #include "RtsUtils.h"
  11 #include "RtsFlags.h"
  12 #include "StablePriv.h"
  13
  14 extern int stg_InstallConsoleEvent(int action, StgStablePtr *handler);
  15
  16 static BOOL WINAPI shutdown_handler(DWORD dwCtrlType);
  17 static BOOL WINAPI generic_handler(DWORD dwCtrlType);
  18
  19 static rtsBool deliver_event = rtsTrue;
  20 static StgInt console_handler = STG_SIG_DFL;
  21
  22 #define N_PENDING_EVENTS 16
  23 StgInt stg_pending_events = 0;           /* number of undelivered events */
  24 DWORD stg_pending_buf[N_PENDING_EVENTS]; /* their associated event numbers. */
  25
  26 /*
  27  * Function: initUserSignals()
  28  *
  29  * Initialize the console handling substrate.
  30  */
  31 void
  32 initUserSignals(void)
  33 {
  34     stg_pending_events = 0;
  35     console_handler = STG_SIG_DFL;
  36     return;
  37 }
  38
  39 /*
  40  * Function: shutdown_handler()
  41  *
  42  * Local function that performs the default handling of Ctrl+C kind
  43  * events; gently shutting down the RTS
  44  *
  45  * To repeat Signals.c remark -- user code may choose to override the
  46  * default handler. Which is fine, assuming they put back the default
  47  * handler when/if they de-install the custom handler.
  48  *
  49  */
  50 static BOOL WINAPI shutdown_handler(DWORD dwCtrlType)
  51 {
  52     switch (dwCtrlType) {
  53
  54     case CTRL_C_EVENT:
  55     case CTRL_BREAK_EVENT:
  56     case CTRL_CLOSE_EVENT:
  57
  58         // If we're already trying to interrupt the RTS, terminate with
  59         // extreme prejudice.  So the first ^C tries to exit the program
  60         // cleanly, and the second one just kills it.
  61         if (interrupted) {
  62             stg_exit(EXIT_INTERRUPTED);
  63         } else {
  64             interruptStgRts();
  65         }
  66         return TRUE;
  67
  68         /* shutdown + logoff events are not handled here. */
  69     default:
  70         return FALSE;
  71     }
  72 }
  73
  74
  75 /*
  76  * Function: initDefaultHandlers()
  77  *
  78  * Install any default signal/console handlers. Currently we install a
  79  * Ctrl+C handler that shuts down the RTS in an orderly manner.
  80  */
  81 void initDefaultHandlers(void)
  82 {
  83     if ( !SetConsoleCtrlHandler(shutdown_handler, TRUE) ) {
  84         prog_belch("warning: failed to install default console handler");
  85     }
  86
  87 }
  88
  89
  90 /*
  91  * Function: blockUserSignals()
  92  *
  93  * Temporarily block the delivery of further console events. Needed to
  94  * avoid race conditions when GCing the stack of outstanding handlers or
  95  * when emptying the stack by running the handlers.
  96  *
  97  */
  98 void
  99 blockUserSignals(void)
 100 {
 101     deliver_event = rtsFalse;
 102 }
 103
 104
 105 /*
 106  * Function: unblockUserSignals()
 107  *
 108  * The inverse of blockUserSignals(); re-enable the deliver of console events.
 109  */
 110 void
 111 unblockUserSignals(void)
 112 {
 113     deliver_event = rtsTrue;
 114 }
 115
 116
 117 /*
 118  * Function: awaitUserSignals()
 119  *
 120  * Wait for the next console event. Currently a NOP (returns immediately.)
 121  */
 122 void awaitUserSignals(void)
 123 {
 124     return;
 125 }
 126
 127
 128 /*
 129  * Function: startSignalHandlers()
 130  *
 131  * Run the handlers associated with the stacked up console events. Console
 132  * event delivery is blocked for the duration of this call.
 133  */
 134 void startSignalHandlers(void)
 135 {
 136     StgStablePtr handler;
 137
 138     if (console_handler < 0) {
 139         return;
 140     }
 141     blockUserSignals();
 142
 143     handler = deRefStablePtr((StgStablePtr)console_handler);
 144     while (stg_pending_events > 0) {
 145         stg_pending_events--;
 146         scheduleThread(
 147             createIOThread(RtsFlags.GcFlags.initialStkSize,
 148                            rts_apply((StgClosure *)handler,
 149                                      rts_mkInt(stg_pending_buf[stg_pending_events]))));
 150     }
 151     unblockUserSignals();
 152 }
 153
 154
 155 /*
 156  * Function: markSignalHandlers()
 157  *
 158  * Evacuate the handler stack. _Assumes_ that console event delivery
 159  * has already been blocked.
 160  */
 161 void markSignalHandlers (evac_fn evac)
 162 {
 163     if (console_handler >= 0) {
 164         StgPtr p = deRefStablePtr((StgStablePtr)console_handler);
 165         evac((StgClosure**)&p);
 166     }
 167 }
 168
 169
 170 /*
 171  * Function: handleSignalsInThisThread()
 172  *
 173  * Have current (OS) thread assume responsibility of handling console events/signals.
 174  * Currently not used (by the console event handling code.)
 175  */
 176 void handleSignalsInThisThread(void)
 177 {
 178     return;
 179 }
 180
 181 /*
 182  * Function: generic_handler()
 183  *
 184  * Local function which handles incoming console event (done in a sep OS thread),
 185  * recording the event in stg_pending_events.
 186  */
 187 static BOOL WINAPI generic_handler(DWORD dwCtrlType)
 188 {
 189     /* Ultra-simple -- up the counter + signal a switch. */
 190     if ( stg_pending_events < N_PENDING_EVENTS ) {
 191         stg_pending_buf[stg_pending_events] = dwCtrlType;
 192         stg_pending_events++;
 193     }
 194     context_switch = 1;
 195     return TRUE;
 196 }
 197
 198
 199 /*
 200  * Function: stg_InstallConsoleEvent()
 201  *
 202  * Install/remove a console event handler.
 203  */
 204 int
 205 stg_InstallConsoleEvent(int action, StgStablePtr *handler)
 206 {
 207     StgInt previous_hdlr = console_handler;
 208
 209     switch (action) {
 210     case STG_SIG_IGN:
 211         console_handler = STG_SIG_IGN;
 212         if ( !SetConsoleCtrlHandler(NULL, TRUE) ) {
 213             prog_belch("warning: unable to ignore console events");
 214         }
 215         break;
 216     case STG_SIG_DFL:
 217         console_handler = STG_SIG_IGN;
 218         if ( !SetConsoleCtrlHandler(NULL, FALSE) ) {
 219             prog_belch("warning: unable to restore default console event handling");
 220         }
 221         break;
 222     case STG_SIG_HAN:
 223         console_handler = (StgInt)*handler;
 224         if ( !SetConsoleCtrlHandler(generic_handler, TRUE) ) {
 225             prog_belch("warning: unable to install console event handler");
 226         }
 227         break;
 228     }
 229
 230     if (previous_hdlr == STG_SIG_DFL ||
 231         previous_hdlr == STG_SIG_IGN) {
 232         return previous_hdlr;
 233     } else {
 234         *handler = (StgStablePtr)previous_hdlr;
 235         return STG_SIG_HAN;
 236     }
 237 }