Signals.c 15 KB
Newer Older
1
/* -----------------------------------------------------------------------------
2
 *
3
 * (c) The GHC Team, 1998-2005
4
5
6
7
8
 *
 * Signal processing / handling.
 *
 * ---------------------------------------------------------------------------*/

9
/* This is non-Posix-compliant.
10
11
   #include "PosixSource.h" 
*/
12
13
#include "Rts.h"
#include "SchedAPI.h"
14
#include "Schedule.h"
15
16
#include "RtsSignals.h"
#include "posix/Signals.h"
17
18
#include "RtsUtils.h"
#include "RtsFlags.h"
19
#include "Prelude.h"
20

21
22
#ifdef alpha_HOST_ARCH
# if defined(linux_HOST_OS)
23
24
25
26
#  include <asm/fpu.h>
# else
#  include <machine/fpu.h>
# endif
ken's avatar
ken committed
27
28
#endif

29
30
31
32
33
34
35
36
37
38
#ifdef HAVE_UNISTD_H
# include <unistd.h>
#endif

#ifdef HAVE_SIGNAL_H
# include <signal.h>
#endif

#include <stdlib.h>

sof's avatar
sof committed
39
40
41
42
43
44
/* This curious flag is provided for the benefit of the Haskell binding
 * to POSIX.1 to control whether or not to include SA_NOCLDSTOP when
 * installing a SIGCHLD handler. 
 */
StgInt nocldstop = 0;

45
46
47
48
/* -----------------------------------------------------------------------------
 * The table of signal handlers
 * -------------------------------------------------------------------------- */

sof's avatar
sof committed
49
#if defined(RTS_USER_SIGNALS)
50

51
/* SUP: The type of handlers is a little bit, well, doubtful... */
52
StgInt *signal_handlers = NULL; /* Dynamically grown array of signal handlers */
53
54
static StgInt nHandlers = 0;    /* Size of handlers array */

55
56
static nat n_haskell_handlers = 0;

57
/* -----------------------------------------------------------------------------
58
59
 * Allocate/resize the table of signal handlers.
 * -------------------------------------------------------------------------- */
60
61
62
63

static void
more_handlers(I_ sig)
{
64
    StgInt i;
65
66

    if (sig < nHandlers)
67
	return;
68

69
70
    if (signal_handlers == NULL)
	signal_handlers = (StgInt *)stgMallocBytes((sig + 1) * sizeof(StgInt), "more_handlers");
71
    else
72
	signal_handlers = (StgInt *)stgReallocBytes(signal_handlers, (sig + 1) * sizeof(StgInt), "more_handlers");
73
74

    for(i = nHandlers; i <= sig; i++)
75
	// Fill in the new slots with default actions
76
	signal_handlers[i] = STG_SIG_DFL;
77
78
79
80

    nHandlers = sig + 1;
}

81
82
83
84
/* -----------------------------------------------------------------------------
 * Pending Handlers
 *
 * The mechanism for starting handlers differs between the threaded
85
 * (THREADED_RTS) and non-threaded versions of the RTS.
86
87
88
89
90
 *
 * When the RTS is single-threaded, we just write the pending signal
 * handlers into a buffer, and start a thread for each one in the
 * scheduler loop.
 *
91
 * When THREADED_RTS, the problem is that signals might be
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 * delivered to multiple threads, so we would need to synchronise
 * access to pending_handler_buf somehow.  Using thread
 * synchronisation from a signal handler isn't possible in general
 * (some OSs support it, eg. MacOS X, but not all).  So instead:
 *
 *   - the signal handler writes the signal number into the pipe
 *     managed by the IO manager thread (see GHC.Conc).
 *   - the IO manager picks up the signal number and calls
 *     startSignalHandler() to start the thread.
 *
 * This also has the nice property that we don't need to arrange to
 * wake up a worker task to start the signal handler: the IO manager
 * wakes up when we write into the pipe.
 *
 * -------------------------------------------------------------------------- */

// Here's the pipe into which we will send our signals
static int io_manager_pipe = -1;

111
112
113
#define IO_MANAGER_WAKEUP 0xff
#define IO_MANAGER_DIE    0xfe

114
115
116
void
setIOManagerPipe (int fd)
{
117
    // only called when THREADED_RTS, but unconditionally
118
119
120
121
    // compiled here because GHC.Conc depends on it.
    io_manager_pipe = fd;
}

122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
#if defined(THREADED_RTS)
void
ioManagerWakeup (void)
{
    // Wake up the IO Manager thread by sending a byte down its pipe
    if (io_manager_pipe >= 0) {
	StgWord8 byte = (StgWord8)IO_MANAGER_WAKEUP;
	write(io_manager_pipe, &byte, 1);
    }
}

void
ioManagerDie (void)
{
    // Ask the IO Manager thread to exit
    if (io_manager_pipe >= 0) {
	StgWord8 byte = (StgWord8)IO_MANAGER_DIE;
	write(io_manager_pipe, &byte, 1);
    }
}

void
ioManagerStart (void)
{
    // Make sure the IO manager thread is running
    Capability *cap;
    if (io_manager_pipe < 0) {
	cap = rts_lock();
150
	rts_evalIO(cap,&base_GHCziConc_ensureIOManagerIsRunning_closure,NULL);
151
152
153
154
155
	rts_unlock(cap);
    }
}
#endif

156
#if !defined(THREADED_RTS)
157
158
159
160
161
162

#define N_PENDING_HANDLERS 16

StgPtr pending_handler_buf[N_PENDING_HANDLERS];
StgPtr *next_pending_handler = pending_handler_buf;

163
#endif /* THREADED_RTS */
164

165
/* -----------------------------------------------------------------------------
166
167
168
169
170
171
172
173
 * 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.
 * -------------------------------------------------------------------------- */
174

175
176
177
178
179
180
181
182
183
184
185
186
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.
 * -------------------------------------------------------------------------- */
187
188
189
190
191
192

static void
generic_handler(int sig)
{
    sigset_t signals;

193
#if defined(THREADED_RTS)
194

195
196
197
198
199
200
    if (io_manager_pipe != -1)
    {
	// Write the signal number into the pipe as a single byte.  We
	// hope that signals fit into a byte...
	StgWord8 csig = (StgWord8)sig;
	write(io_manager_pipe, &csig, 1);
201
    }
202
203
204
205
    // If the IO manager hasn't told us what the FD of the write end
    // of its pipe is, there's not much we can do here, so just ignore
    // the signal..

206
#else /* not THREADED_RTS */
207

208
209
210
211
    /* Can't call allocate from here.  Probably can't call malloc
       either.  However, we have to schedule a new thread somehow.

       It's probably ok to request a context switch and allow the
212
       scheduler to  start the handler thread, but how do we
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
       communicate this to the scheduler?

       We need some kind of locking, but with low overhead (i.e. no
       blocking signals every time around the scheduler).
       
       Signal Handlers are atomic (i.e. they can't be interrupted), and
       we can make use of this.  We just need to make sure the
       critical section of the scheduler can't be interrupted - the
       only way to do this is to block signals.  However, we can lower
       the overhead by only blocking signals when there are any
       handlers to run, i.e. the set of pending handlers is
       non-empty.
    */
       
    /* We use a stack to store the pending signals.  We can't
       dynamically grow this since we can't allocate any memory from
       within a signal handler.

       Hence unfortunately we have to bomb out if the buffer
       overflows.  It might be acceptable to carry on in certain
       circumstances, depending on the signal.  
    */

236
    *next_pending_handler++ = deRefStablePtr((StgStablePtr)signal_handlers[sig]);
237

238
    // stack full?
239
    if (next_pending_handler == &pending_handler_buf[N_PENDING_HANDLERS]) {
240
	errorBelch("too many pending signals");
241
	stg_exit(EXIT_FAILURE);
242
243
    }
    
244
#endif /* THREADED_RTS */
245

246
    // re-establish the signal handler, and carry on
247
248
249
    sigemptyset(&signals);
    sigaddset(&signals, sig);
    sigprocmask(SIG_UNBLOCK, &signals, NULL);
250

251
252
253
254
255
    // *always* do the SIGCONT handler, even if the user overrides it.
    if (sig == SIGCONT) {
	cont_handler(sig);
    }

256
    context_switch = 1;
257
258
259
}

/* -----------------------------------------------------------------------------
260
261
 * Blocking/Unblocking of the user signals
 * -------------------------------------------------------------------------- */
262
263
264
265
266
267
268
269
270
271
272
273
274

static sigset_t userSignals;
static sigset_t savedSignals;

void
initUserSignals(void)
{
    sigemptyset(&userSignals);
}

void
blockUserSignals(void)
{
275
    sigprocmask(SIG_BLOCK, &userSignals, &savedSignals);
276
277
278
279
280
281
282
283
}

void
unblockUserSignals(void)
{
    sigprocmask(SIG_SETMASK, &savedSignals, NULL);
}

284
285
286
287
288
289
rtsBool
anyUserHandlers(void)
{
    return n_haskell_handlers != 0;
}

290
#if !defined(THREADED_RTS)
291
292
293
void
awaitUserSignals(void)
{
294
    while (!signals_pending() && sched_state == SCHED_RUNNING) {
295
296
297
	pause();
    }
}
298
#endif
299
300

/* -----------------------------------------------------------------------------
301
302
 * Install a Haskell signal handler.
 * -------------------------------------------------------------------------- */
303

304
305
int
stg_sig_install(int sig, int spi, StgStablePtr *handler, void *mask)
306
{
307
    sigset_t signals, osignals;
308
309
310
    struct sigaction action;
    StgInt previous_spi;

311
312
313
    // 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) ||
314
	sigaddset(&signals, sig) || sigprocmask(SIG_BLOCK, &signals, &osignals)) {
315
316
317
	return STG_SIG_ERR;
    }
    
318
319
    more_handlers(sig);

320
    previous_spi = signal_handlers[sig];
321

322
323
    action.sa_flags = 0;
    
324
325
    switch(spi) {
    case STG_SIG_IGN:
326
    	signal_handlers[sig] = STG_SIG_IGN;
327
328
329
330
331
	sigdelset(&userSignals, sig);
        action.sa_handler = SIG_IGN;
    	break;
    	
    case STG_SIG_DFL:
332
    	signal_handlers[sig] = STG_SIG_DFL;
333
334
335
	sigdelset(&userSignals, sig);
        action.sa_handler = SIG_DFL;
    	break;
336

337
    case STG_SIG_HAN:
338
    case STG_SIG_RST:
339
    	signal_handlers[sig] = (StgInt)*handler;
340
341
	sigaddset(&userSignals, sig);
    	action.sa_handler = generic_handler;
342
343
344
	if (spi == STG_SIG_RST) {
	    action.sa_flags = SA_RESETHAND;
	}
345
	n_haskell_handlers++;
346
    	break;
347

348
    default:
349
        barf("stg_sig_install: bad spi");
350
351
    }

352
353
    if (mask != NULL)
        action.sa_mask = *(sigset_t *)mask;
354
355
356
    else
	sigemptyset(&action.sa_mask);

357
    action.sa_flags |= sig == SIGCHLD && nocldstop ? SA_NOCLDSTOP : 0;
358
359

    if (sigaction(sig, &action, NULL) || 
360
	sigprocmask(SIG_SETMASK, &osignals, NULL)) 
361
    {
362
363
364
	// 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) {
365
	    freeStablePtr(stgCast(StgStablePtr,signal_handlers[sig]));
366
	    n_haskell_handlers--;
367
368
	}
	return STG_SIG_ERR;
369
    }
sof's avatar
sof committed
370

371
372
373
374
375
376
377
    if (previous_spi == STG_SIG_DFL || previous_spi == STG_SIG_IGN
	|| previous_spi == STG_SIG_ERR) {
	return previous_spi;
    } else {
	*handler = (StgStablePtr)previous_spi;
	return STG_SIG_HAN;
    }
378
379
380
}

/* -----------------------------------------------------------------------------
381
 * Creating new threads for signal handlers.
382
 * -------------------------------------------------------------------------- */
383

384
#if !defined(THREADED_RTS)
385
void
386
startSignalHandlers(Capability *cap)
387
388
389
390
391
392
393
{
  blockUserSignals();
  
  while (next_pending_handler != pending_handler_buf) {

    next_pending_handler--;

394
395
    scheduleThread (cap,
	createIOThread(cap,
396
397
		       RtsFlags.GcFlags.initialStkSize, 
		       (StgClosure *) *next_pending_handler));
398
399
400
401
  }

  unblockUserSignals();
}
402
#endif
403

404
405
406
407
408
409
410
411
412
/* ----------------------------------------------------------------------------
 * Mark signal handlers during GC.
 *
 * We do this rather than trying to start all the signal handlers
 * prior to GC, because that requires extra heap for the new threads.
 * Signals must be blocked (see blockUserSignals() above) during GC to
 * avoid race conditions.
 * -------------------------------------------------------------------------- */

413
#if !defined(THREADED_RTS)
414
415
416
417
418
419
420
421
422
423
424
void
markSignalHandlers (evac_fn evac)
{
    StgPtr *p;

    p = next_pending_handler;
    while (p != pending_handler_buf) {
	p--;
	evac((StgClosure **)p);
    }
}
425
426
427
428
429
430
#else
void
markSignalHandlers (evac_fn evac STG_UNUSED)
{
}
#endif
431

sof's avatar
sof committed
432
#else /* !RTS_USER_SIGNALS */
433
StgInt 
sof's avatar
sof committed
434
435
436
437
stg_sig_install(StgInt sig STG_UNUSED,
		StgInt spi STG_UNUSED,
		StgStablePtr* handler STG_UNUSED,
		void* mask STG_UNUSED)
438
{
sof's avatar
sof committed
439
440
  //barf("User signals not supported");
  return STG_SIG_DFL;
441
442
443
}

#endif
sof's avatar
sof committed
444

sof's avatar
sof committed
445
#if defined(RTS_USER_SIGNALS)
446
/* -----------------------------------------------------------------------------
447
448
449
450
451
 * 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.
 * -------------------------------------------------------------------------- */
452
453
454
455
#ifdef SMP
pthread_t startup_guy;
#endif

sof's avatar
sof committed
456
static void
457
shutdown_handler(int sig STG_UNUSED)
sof's avatar
sof committed
458
{
459
#ifdef SMP
460
461
462
463
464
465
466
467
    // 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;
    }
468
469
#endif

470
471
472
    // 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.
473
    if (sched_state >= SCHED_INTERRUPTING) {
sof's avatar
sof committed
474
	stg_exit(EXIT_INTERRUPTED);
475
476
477
    } else {
	interruptStgRts();
    }
sof's avatar
sof committed
478
479
}

480
481
482
/* -----------------------------------------------------------------------------
 * Install default signal handlers.
 *
sof's avatar
sof committed
483
 * The RTS installs a default signal handler for catching
484
 * SIGINT, so that we can perform an orderly shutdown.
sof's avatar
sof committed
485
486
487
488
 *
 * 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.
ken's avatar
ken committed
489
490
491
492
493
 *
 * 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.
494
 * -------------------------------------------------------------------------- */
sof's avatar
sof committed
495
void
496
initDefaultHandlers()
sof's avatar
sof committed
497
498
499
{
    struct sigaction action,oact;

500
501
502
#ifdef SMP
    startup_guy = pthread_self();
#endif
503
504

    // install the SIGINT handler
sof's avatar
sof committed
505
506
507
508
    action.sa_handler = shutdown_handler;
    sigemptyset(&action.sa_mask);
    action.sa_flags = 0;
    if (sigaction(SIGINT, &action, &oact) != 0) {
509
	errorBelch("warning: failed to install SIGINT handler");
sof's avatar
sof committed
510
    }
511

sof's avatar
sof committed
512
#if defined(HAVE_SIGINTERRUPT)
513
    siginterrupt(SIGINT, 1);	// isn't this the default? --SDM
sof's avatar
sof committed
514
#endif
515
516
517
518
519
520

    // install the SIGCONT handler
    action.sa_handler = cont_handler;
    sigemptyset(&action.sa_mask);
    action.sa_flags = 0;
    if (sigaction(SIGCONT, &action, &oact) != 0) {
521
	errorBelch("warning: failed to install SIGCONT handler");
522
    }
ken's avatar
ken committed
523

524
    // install the SIGFPE handler
525
526
527
528
529
530
531
532
533
534

    // In addition to handling SIGINT, also handle 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.

    // Commented out by SDM 2/7/2002: this causes an infinite loop on
    // some architectures when an integer division by zero occurs: we
    // don't recover from the floating point exception, and the
    // program just generates another one immediately.
#if 0
ken's avatar
ken committed
535
536
537
538
    action.sa_handler = SIG_IGN;
    sigemptyset(&action.sa_mask);
    action.sa_flags = 0;
    if (sigaction(SIGFPE, &action, &oact) != 0) {
539
	errorBelch("warning: failed to install SIGFPE handler");
ken's avatar
ken committed
540
    }
541
542
#endif

543
#ifdef alpha_HOST_ARCH
ken's avatar
ken committed
544
545
    ieee_set_fp_control(0);
#endif
546
}
sof's avatar
sof committed
547
548

#endif /* RTS_USER_SIGNALS */