signalmodule.c 30.6 KB
Newer Older
1

2
/* Signal module -- many thanks to Lance Ellinghaus */
3

4 5
/* XXX Signals should be recorded per thread, now we have thread state. */

6
#include "Python.h"
7

8
#ifdef MS_WINDOWS
9
#include <Windows.h>
Benjamin Peterson's avatar
Benjamin Peterson committed
10
#ifdef HAVE_PROCESS_H
11 12
#include <process.h>
#endif
Benjamin Peterson's avatar
Benjamin Peterson committed
13
#endif
14

Benjamin Peterson's avatar
Benjamin Peterson committed
15
#ifdef HAVE_SIGNAL_H
16
#include <signal.h>
Benjamin Peterson's avatar
Benjamin Peterson committed
17 18
#endif
#ifdef HAVE_SYS_STAT_H
19
#include <sys/stat.h>
Benjamin Peterson's avatar
Benjamin Peterson committed
20
#endif
21
#ifdef HAVE_SYS_TIME_H
22
#include <sys/time.h>
23
#endif
24

25 26 27 28 29 30 31 32
#if defined(HAVE_PTHREAD_SIGMASK) && !defined(HAVE_BROKEN_PTHREAD_SIGMASK)
#  define PYPTHREAD_SIGMASK
#endif

#if defined(PYPTHREAD_SIGMASK) && defined(HAVE_PTHREAD_H)
#  include <pthread.h>
#endif

33
#ifndef SIG_ERR
34
#define SIG_ERR ((PyOS_sighandler_t)(-1))
35 36
#endif

37
#if defined(PYOS_OS2) && !defined(PYCC_GCC)
Guido van Rossum's avatar
Guido van Rossum committed
38 39 40 41
#define NSIG 12
#include <process.h>
#endif

42
#ifndef NSIG
43
# if defined(_NSIG)
44
#  define NSIG _NSIG            /* For BSD/SysV */
45
# elif defined(_SIGMAX)
46
#  define NSIG (_SIGMAX + 1)    /* For QNX */
47
# elif defined(SIGMAX)
48
#  define NSIG (SIGMAX + 1)     /* For djgpp */
49
# else
50
#  define NSIG 64               /* Use a reasonable default value */
51
# endif
52 53 54
#endif


55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
/*
   NOTES ON THE INTERACTION BETWEEN SIGNALS AND THREADS

   When threads are supported, we want the following semantics:

   - only the main thread can set a signal handler
   - any thread can get a signal handler
   - signals are only delivered to the main thread

   I.e. we don't support "synchronous signals" like SIGFPE (catching
   this doesn't make much sense in Python anyway) nor do we support
   signals as a means of inter-thread communication, since not all
   thread implementations support that (at least our thread library
   doesn't).

   We still have the problem that in some implementations signals
   generated by the keyboard (e.g. SIGINT) are delivered to all
   threads (e.g. SGI), while in others (e.g. Solaris) such signals are
   delivered to one random thread (an intermediate possibility would
Guido van Rossum's avatar
Guido van Rossum committed
74
   be to deliver it to the main thread -- POSIX?).  For now, we have
75 76 77 78
   a working implementation that works in all three cases -- the
   handler ignores signals if getpid() isn't the same as in the main
   thread.  XXX This is a hack.

79 80 81
   GNU pth is a user-space threading library, and as such, all threads
   run within the same process. In this case, if the currently running
   thread is not the main_thread, send the signal to the main_thread.
82 83 84
*/

#ifdef WITH_THREAD
85
#include <sys/types.h> /* For pid_t */
86
#include "pythread.h"
87 88 89 90
static long main_thread;
static pid_t main_pid;
#endif

Barry Warsaw's avatar
Barry Warsaw committed
91
static struct {
92 93
    int tripped;
    PyObject *func;
Barry Warsaw's avatar
Barry Warsaw committed
94 95
} Handlers[NSIG];

96 97
static sig_atomic_t wakeup_fd = -1;

98 99
/* Speed up sigcheck() when none tripped */
static volatile sig_atomic_t is_tripped = 0;
100

Barry Warsaw's avatar
Barry Warsaw committed
101 102 103
static PyObject *DefaultHandler;
static PyObject *IgnoreHandler;
static PyObject *IntHandler;
104

105 106 107 108 109
/* On Solaris 8, gcc will produce a warning that the function
   declaration is not a prototype. This is caused by the definition of
   SIG_DFL as (void (*)())0; the correct declaration would have been
   (void (*)(int))0. */

110
static PyOS_sighandler_t old_siginthandler = SIG_DFL;
111

112 113 114 115 116 117 118 119 120 121 122
#ifdef HAVE_GETITIMER
static PyObject *ItimerError;

/* auxiliary functions for setitimer/getitimer */
static void
timeval_from_double(double d, struct timeval *tv)
{
    tv->tv_sec = floor(d);
    tv->tv_usec = fmod(d, 1.0) * 1000000.0;
}

123
Py_LOCAL_INLINE(double)
124 125 126 127 128 129 130 131 132 133 134 135
double_from_timeval(struct timeval *tv)
{
    return tv->tv_sec + (double)(tv->tv_usec / 1000000.0);
}

static PyObject *
itimer_retval(struct itimerval *iv)
{
    PyObject *r, *v;

    r = PyTuple_New(2);
    if (r == NULL)
136
    return NULL;
137 138

    if(!(v = PyFloat_FromDouble(double_from_timeval(&iv->it_value)))) {
139 140
    Py_DECREF(r);
    return NULL;
141 142 143 144 145
    }

    PyTuple_SET_ITEM(r, 0, v);

    if(!(v = PyFloat_FromDouble(double_from_timeval(&iv->it_interval)))) {
146 147
    Py_DECREF(r);
    return NULL;
148 149 150 151 152 153 154
    }

    PyTuple_SET_ITEM(r, 1, v);

    return r;
}
#endif
155

156
static PyObject *
Peter Schneider-Kamp's avatar
Peter Schneider-Kamp committed
157
signal_default_int_handler(PyObject *self, PyObject *args)
158
{
159 160
    PyErr_SetNone(PyExc_KeyboardInterrupt);
    return NULL;
161 162
}

163
PyDoc_STRVAR(default_int_handler_doc,
Guido van Rossum's avatar
Guido van Rossum committed
164 165
"default_int_handler(...)\n\
\n\
Michael W. Hudson's avatar
Michael W. Hudson committed
166
The default handler for SIGINT installed by Python.\n\
167
It raises KeyboardInterrupt.");
Guido van Rossum's avatar
Guido van Rossum committed
168

169 170 171 172

static int
checksignals_witharg(void * unused)
{
173
    return PyErr_CheckSignals();
174 175
}

176 177 178 179 180 181 182 183 184 185 186 187 188 189
static void
trip_signal(int sig_num)
{
    Handlers[sig_num].tripped = 1;
    if (is_tripped)
        return;
    /* Set is_tripped after setting .tripped, as it gets
       cleared in PyErr_CheckSignals() before .tripped. */
    is_tripped = 1;
    Py_AddPendingCall(checksignals_witharg, NULL);
    if (wakeup_fd != -1)
        write(wakeup_fd, "\0", 1);
}

190
static void
Peter Schneider-Kamp's avatar
Peter Schneider-Kamp committed
191
signal_handler(int sig_num)
192
{
193 194 195
    int save_errno = errno;

#if defined(WITH_THREAD) && defined(WITH_PTH)
196 197 198
    if (PyThread_get_thread_ident() != main_thread) {
        pth_raise(*(pth_t *) main_thread, sig_num);
    }
199
    else
200
#endif
201 202
    {
#ifdef WITH_THREAD
203
    /* See NOTES section above */
204
    if (getpid() == main_pid)
205
#endif
206
    {
207
        trip_signal(sig_num);
208
    }
209 210

#ifndef HAVE_SIGACTION
211
#ifdef SIGCHLD
212 213 214 215 216
    /* To avoid infinite recursion, this signal remains
       reset until explicit re-instated.
       Don't clear the 'func' field as it is our pointer
       to the Python handler... */
    if (sig_num != SIGCHLD)
217
#endif
218 219 220 221
    /* If the handler was not set up with sigaction, reinstall it.  See
     * Python/pythonrun.c for the implementation of PyOS_setsig which
     * makes this true.  See also issue8354. */
    PyOS_setsig(sig_num, signal_handler);
222
#endif
223 224 225 226 227
    }

    /* Issue #10311: asynchronously executing signal handlers should not
       mutate errno under the feet of unsuspecting C code. */
    errno = save_errno;
228
}
229

230

231
#ifdef HAVE_ALARM
232
static PyObject *
Peter Schneider-Kamp's avatar
Peter Schneider-Kamp committed
233
signal_alarm(PyObject *self, PyObject *args)
234
{
235 236 237 238 239
    int t;
    if (!PyArg_ParseTuple(args, "i:alarm", &t))
        return NULL;
    /* alarm() returns the number of seconds remaining */
    return PyLong_FromLong((long)alarm(t));
240
}
Guido van Rossum's avatar
Guido van Rossum committed
241

242
PyDoc_STRVAR(alarm_doc,
Guido van Rossum's avatar
Guido van Rossum committed
243 244
"alarm(seconds)\n\
\n\
245
Arrange for SIGALRM to arrive after the given number of seconds.");
246
#endif
247

248
#ifdef HAVE_PAUSE
249
static PyObject *
250
signal_pause(PyObject *self)
251
{
252 253 254 255 256 257 258 259 260 261 262
    Py_BEGIN_ALLOW_THREADS
    (void)pause();
    Py_END_ALLOW_THREADS
    /* make sure that any exceptions that got raised are propagated
     * back into Python
     */
    if (PyErr_CheckSignals())
        return NULL;

    Py_INCREF(Py_None);
    return Py_None;
263
}
264
PyDoc_STRVAR(pause_doc,
265 266
"pause()\n\
\n\
267
Wait until a signal arrives.");
Guido van Rossum's avatar
Guido van Rossum committed
268

269
#endif
270

271

272
static PyObject *
Peter Schneider-Kamp's avatar
Peter Schneider-Kamp committed
273
signal_signal(PyObject *self, PyObject *args)
274
{
275 276 277 278 279 280
    PyObject *obj;
    int sig_num;
    PyObject *old_handler;
    void (*func)(int);
    if (!PyArg_ParseTuple(args, "iO:signal", &sig_num, &obj))
        return NULL;
281 282
#ifdef MS_WINDOWS
    /* Validate that sig_num is one of the allowable signals */
283 284
    switch (sig_num) {
        case SIGABRT: break;
285 286 287 288 289
#ifdef SIGBREAK
        /* Issue #10003: SIGBREAK is not documented as permitted, but works
           and corresponds to CTRL_BREAK_EVENT. */
        case SIGBREAK: break;
#endif
290 291 292 293 294 295 296 297
        case SIGFPE: break;
        case SIGILL: break;
        case SIGINT: break;
        case SIGSEGV: break;
        case SIGTERM: break;
        default:
            PyErr_SetString(PyExc_ValueError, "invalid signal value");
            return NULL;
298 299
    }
#endif
300
#ifdef WITH_THREAD
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
    if (PyThread_get_thread_ident() != main_thread) {
        PyErr_SetString(PyExc_ValueError,
                        "signal only works in main thread");
        return NULL;
    }
#endif
    if (sig_num < 1 || sig_num >= NSIG) {
        PyErr_SetString(PyExc_ValueError,
                        "signal number out of range");
        return NULL;
    }
    if (obj == IgnoreHandler)
        func = SIG_IGN;
    else if (obj == DefaultHandler)
        func = SIG_DFL;
    else if (!PyCallable_Check(obj)) {
        PyErr_SetString(PyExc_TypeError,
318
"signal handler must be signal.SIG_IGN, signal.SIG_DFL, or a callable object");
319 320 321 322 323 324 325 326 327 328 329 330 331
                return NULL;
    }
    else
        func = signal_handler;
    if (PyOS_setsig(sig_num, func) == SIG_ERR) {
        PyErr_SetFromErrno(PyExc_RuntimeError);
        return NULL;
    }
    old_handler = Handlers[sig_num].func;
    Handlers[sig_num].tripped = 0;
    Py_INCREF(obj);
    Handlers[sig_num].func = obj;
    return old_handler;
332 333
}

334
PyDoc_STRVAR(signal_doc,
Guido van Rossum's avatar
Guido van Rossum committed
335 336 337 338 339 340 341 342
"signal(sig, action) -> action\n\
\n\
Set the action for the given signal.  The action can be SIG_DFL,\n\
SIG_IGN, or a callable Python object.  The previous action is\n\
returned.  See getsignal() for possible return values.\n\
\n\
*** IMPORTANT NOTICE ***\n\
A signal handler function is called with two arguments:\n\
343
the first is the signal number, the second is the interrupted stack frame.");
Guido van Rossum's avatar
Guido van Rossum committed
344

345

346
static PyObject *
Peter Schneider-Kamp's avatar
Peter Schneider-Kamp committed
347
signal_getsignal(PyObject *self, PyObject *args)
348
{
349 350 351 352 353 354 355 356 357 358 359 360
    int sig_num;
    PyObject *old_handler;
    if (!PyArg_ParseTuple(args, "i:getsignal", &sig_num))
        return NULL;
    if (sig_num < 1 || sig_num >= NSIG) {
        PyErr_SetString(PyExc_ValueError,
                        "signal number out of range");
        return NULL;
    }
    old_handler = Handlers[sig_num].func;
    Py_INCREF(old_handler);
    return old_handler;
361 362
}

363
PyDoc_STRVAR(getsignal_doc,
Guido van Rossum's avatar
Guido van Rossum committed
364 365 366 367 368 369
"getsignal(sig) -> action\n\
\n\
Return the current action for the given signal.  The return value can be:\n\
SIG_IGN -- if the signal is being ignored\n\
SIG_DFL -- if the default action for the signal is in effect\n\
None -- if an unknown handler is in effect\n\
370
anything else -- the callable Python object used as a handler");
371

Christian Heimes's avatar
Christian Heimes committed
372 373 374 375 376 377 378 379 380 381
#ifdef HAVE_SIGINTERRUPT
PyDoc_STRVAR(siginterrupt_doc,
"siginterrupt(sig, flag) -> None\n\
change system call restart behaviour: if flag is False, system calls\n\
will be restarted when interrupted by signal sig, else system calls\n\
will be interrupted.");

static PyObject *
signal_siginterrupt(PyObject *self, PyObject *args)
{
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
    int sig_num;
    int flag;

    if (!PyArg_ParseTuple(args, "ii:siginterrupt", &sig_num, &flag))
        return NULL;
    if (sig_num < 1 || sig_num >= NSIG) {
        PyErr_SetString(PyExc_ValueError,
                        "signal number out of range");
        return NULL;
    }
    if (siginterrupt(sig_num, flag)<0) {
        PyErr_SetFromErrno(PyExc_RuntimeError);
        return NULL;
    }

    Py_INCREF(Py_None);
    return Py_None;
Christian Heimes's avatar
Christian Heimes committed
399 400 401
}

#endif
402

403 404 405
static PyObject *
signal_set_wakeup_fd(PyObject *self, PyObject *args)
{
406 407 408 409
    struct stat buf;
    int fd, old_fd;
    if (!PyArg_ParseTuple(args, "i:set_wakeup_fd", &fd))
        return NULL;
410
#ifdef WITH_THREAD
411 412 413 414 415 416 417 418 419 420 421 422 423
    if (PyThread_get_thread_ident() != main_thread) {
        PyErr_SetString(PyExc_ValueError,
                        "set_wakeup_fd only works in main thread");
        return NULL;
    }
#endif
    if (fd != -1 && fstat(fd, &buf) != 0) {
        PyErr_SetString(PyExc_ValueError, "invalid fd");
        return NULL;
    }
    old_fd = wakeup_fd;
    wakeup_fd = fd;
    return PyLong_FromLong(old_fd);
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
}

PyDoc_STRVAR(set_wakeup_fd_doc,
"set_wakeup_fd(fd) -> fd\n\
\n\
Sets the fd to be written to (with '\\0') when a signal\n\
comes in.  A library can use this to wakeup select or poll.\n\
The previous fd is returned.\n\
\n\
The fd must be non-blocking.");

/* C API for the same, without all the error checking */
int
PySignal_SetWakeupFd(int fd)
{
439 440 441 442 443
    int old_fd = wakeup_fd;
    if (fd < 0)
        fd = -1;
    wakeup_fd = fd;
    return old_fd;
444 445 446
}


447 448 449 450 451 452 453 454 455 456
#ifdef HAVE_SETITIMER
static PyObject *
signal_setitimer(PyObject *self, PyObject *args)
{
    double first;
    double interval = 0;
    int which;
    struct itimerval new, old;

    if(!PyArg_ParseTuple(args, "id|d:setitimer", &which, &first, &interval))
457
    return NULL;
458 459 460 461 462

    timeval_from_double(first, &new.it_value);
    timeval_from_double(interval, &new.it_interval);
    /* Let OS check "which" value */
    if (setitimer(which, &new, &old) != 0) {
463 464
    PyErr_SetFromErrno(ItimerError);
    return NULL;
465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
    }

    return itimer_retval(&old);
}

PyDoc_STRVAR(setitimer_doc,
"setitimer(which, seconds[, interval])\n\
\n\
Sets given itimer (one of ITIMER_REAL, ITIMER_VIRTUAL\n\
or ITIMER_PROF) to fire after value seconds and after\n\
that every interval seconds.\n\
The itimer can be cleared by setting seconds to zero.\n\
\n\
Returns old values as a tuple: (delay, interval).");
#endif


#ifdef HAVE_GETITIMER
static PyObject *
signal_getitimer(PyObject *self, PyObject *args)
{
    int which;
    struct itimerval old;

    if (!PyArg_ParseTuple(args, "i:getitimer", &which))
490
    return NULL;
491 492

    if (getitimer(which, &old) != 0) {
493 494
    PyErr_SetFromErrno(ItimerError);
    return NULL;
495 496 497 498 499 500 501 502 503 504 505
    }

    return itimer_retval(&old);
}

PyDoc_STRVAR(getitimer_doc,
"getitimer(which)\n\
\n\
Returns current value of given itimer.");
#endif

506
#if defined(PYPTHREAD_SIGMASK) || defined(HAVE_SIGWAIT)
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
/* Convert an iterable to a sigset.
   Return 0 on success, return -1 and raise an exception on error. */

static int
iterable_to_sigset(PyObject *iterable, sigset_t *mask)
{
    int result = -1;
    PyObject *iterator, *item;
    long signum;
    int err;

    sigemptyset(mask);

    iterator = PyObject_GetIter(iterable);
    if (iterator == NULL)
        goto error;

    while (1)
    {
        item = PyIter_Next(iterator);
        if (item == NULL) {
            if (PyErr_Occurred())
                goto error;
            else
                break;
        }

        signum = PyLong_AsLong(item);
        Py_DECREF(item);
        if (signum == -1 && PyErr_Occurred())
            goto error;
        if (0 < signum && signum < NSIG)
            err = sigaddset(mask, (int)signum);
        else
            err = 1;
        if (err) {
            PyErr_Format(PyExc_ValueError,
                         "signal number %ld out of range", signum);
            goto error;
        }
    }
    result = 0;

error:
    Py_XDECREF(iterator);
    return result;
}
554
#endif
555

556
#if defined(PYPTHREAD_SIGMASK) || defined(HAVE_SIGPENDING)
557 558
static PyObject*
sigset_to_set(sigset_t mask)
559
{
560 561
    PyObject *signum, *result;
    int sig;
562

563
    result = PySet_New(0);
564 565 566 567
    if (result == NULL)
        return NULL;

    for (sig = 1; sig < NSIG; sig++) {
568
        if (sigismember(&mask, sig) != 1)
569 570 571 572 573 574 575 576 577 578 579 580
            continue;

        /* Handle the case where it is a member by adding the signal to
           the result list.  Ignore the other cases because they mean the
           signal isn't a member of the mask or the signal was invalid,
           and an invalid signal must have been our fault in constructing
           the loop boundaries. */
        signum = PyLong_FromLong(sig);
        if (signum == NULL) {
            Py_DECREF(result);
            return NULL;
        }
581
        if (PySet_Add(result, signum) == -1) {
582 583 584 585 586 587 588 589
            Py_DECREF(signum);
            Py_DECREF(result);
            return NULL;
        }
        Py_DECREF(signum);
    }
    return result;
}
590
#endif
591

592
#ifdef PYPTHREAD_SIGMASK
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
static PyObject *
signal_pthread_sigmask(PyObject *self, PyObject *args)
{
    int how;
    PyObject *signals;
    sigset_t mask, previous;
    int err;

    if (!PyArg_ParseTuple(args, "iO:pthread_sigmask", &how, &signals))
        return NULL;

    if (iterable_to_sigset(signals, &mask))
        return NULL;

    err = pthread_sigmask(how, &mask, &previous);
    if (err != 0) {
        errno = err;
610
        PyErr_SetFromErrno(PyExc_OSError);
611 612 613 614 615 616 617 618 619 620
        return NULL;
    }

    /* if signals was unblocked, signal handlers have been called */
    if (PyErr_CheckSignals())
        return NULL;

    return sigset_to_set(previous);
}

621 622 623 624 625 626
PyDoc_STRVAR(signal_pthread_sigmask_doc,
"pthread_sigmask(how, mask) -> old mask\n\
\n\
Fetch and/or change the signal mask of the calling thread.");
#endif   /* #ifdef PYPTHREAD_SIGMASK */

627

628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709
#ifdef HAVE_SIGPENDING
static PyObject *
signal_sigpending(PyObject *self)
{
    int err;
    sigset_t mask;
    err = sigpending(&mask);
    if (err)
        return PyErr_SetFromErrno(PyExc_OSError);
    return sigset_to_set(mask);
}

PyDoc_STRVAR(signal_sigpending_doc,
"sigpending() -> list\n\
\n\
Examine pending signals.");
#endif   /* #ifdef HAVE_SIGPENDING */


#ifdef HAVE_SIGWAIT
static PyObject *
signal_sigwait(PyObject *self, PyObject *args)
{
    PyObject *signals;
    sigset_t set;
    int err, signum;

    if (!PyArg_ParseTuple(args, "O:sigwait", &signals))
        return NULL;

    if (iterable_to_sigset(signals, &set))
        return NULL;

    err = sigwait(&set, &signum);
    if (err) {
        errno = err;
        return PyErr_SetFromErrno(PyExc_OSError);
    }

    return PyLong_FromLong(signum);
}

PyDoc_STRVAR(signal_sigwait_doc,
"sigwait(sigset) -> signum\n\
\n\
Wait a signal.");
#endif   /* #ifdef HAVE_SIGPENDING */


#if defined(HAVE_PTHREAD_KILL) && defined(WITH_THREAD)
static PyObject *
signal_pthread_kill(PyObject *self, PyObject *args)
{
    long tid;
    int signum;
    int err;

    if (!PyArg_ParseTuple(args, "li:pthread_kill", &tid, &signum))
        return NULL;

    err = pthread_kill(tid, signum);
    if (err != 0) {
        errno = err;
        PyErr_SetFromErrno(PyExc_OSError);
        return NULL;
    }

    /* the signal may have been send to the current thread */
    if (PyErr_CheckSignals())
        return NULL;

    Py_RETURN_NONE;
}

PyDoc_STRVAR(signal_pthread_kill_doc,
"pthread_kill(thread_id, signum)\n\
\n\
Send a signal to a thread.");
#endif   /* #if defined(HAVE_PTHREAD_KILL) && defined(WITH_THREAD) */



710
/* List of functions defined in the module */
Barry Warsaw's avatar
Barry Warsaw committed
711
static PyMethodDef signal_methods[] = {
712
#ifdef HAVE_ALARM
713
    {"alarm",                   signal_alarm, METH_VARARGS, alarm_doc},
714 715 716 717 718
#endif
#ifdef HAVE_SETITIMER
    {"setitimer",       signal_setitimer, METH_VARARGS, setitimer_doc},
#endif
#ifdef HAVE_GETITIMER
719
    {"getitimer",       signal_getitimer, METH_VARARGS, getitimer_doc},
720
#endif
721 722 723
    {"signal",                  signal_signal, METH_VARARGS, signal_doc},
    {"getsignal",               signal_getsignal, METH_VARARGS, getsignal_doc},
    {"set_wakeup_fd",           signal_set_wakeup_fd, METH_VARARGS, set_wakeup_fd_doc},
Christian Heimes's avatar
Christian Heimes committed
724
#ifdef HAVE_SIGINTERRUPT
725
    {"siginterrupt",            signal_siginterrupt, METH_VARARGS, siginterrupt_doc},
Christian Heimes's avatar
Christian Heimes committed
726
#endif
727
#ifdef HAVE_PAUSE
728
    {"pause",                   (PyCFunction)signal_pause,
729
     METH_NOARGS, pause_doc},
730
#endif
731 732
    {"default_int_handler", signal_default_int_handler,
     METH_VARARGS, default_int_handler_doc},
733 734 735 736
#if defined(HAVE_PTHREAD_KILL) && defined(WITH_THREAD)
    {"pthread_kill",            (PyCFunction)signal_pthread_kill,
     METH_VARARGS, signal_pthread_kill_doc},
#endif
737 738 739
#ifdef PYPTHREAD_SIGMASK
    {"pthread_sigmask",         (PyCFunction)signal_pthread_sigmask,
     METH_VARARGS, signal_pthread_sigmask_doc},
740 741 742 743 744 745 746 747
#endif
#ifdef HAVE_SIGPENDING
    {"sigpending",              (PyCFunction)signal_sigpending,
     METH_NOARGS, signal_sigpending_doc},
#endif
#ifdef HAVE_SIGWAIT
    {"sigwait",                 (PyCFunction)signal_sigwait,
     METH_VARARGS, signal_sigwait_doc},
748
#endif
749
    {NULL,                      NULL}           /* sentinel */
750 751
};

Barry Warsaw's avatar
Barry Warsaw committed
752

753
PyDoc_STRVAR(module_doc,
Guido van Rossum's avatar
Guido van Rossum committed
754 755 756 757 758
"This module provides mechanisms to use signal handlers in Python.\n\
\n\
Functions:\n\
\n\
alarm() -- cause SIGALRM after a specified time [Unix only]\n\
759 760 761
setitimer() -- cause a signal (described below) after a specified\n\
               float time and the timer may restart then [Unix only]\n\
getitimer() -- get current value of timer [Unix only]\n\
Guido van Rossum's avatar
Guido van Rossum committed
762 763 764 765 766
signal() -- set the action for a given signal\n\
getsignal() -- get the signal action for a given signal\n\
pause() -- wait until a signal arrives [Unix only]\n\
default_int_handler() -- default SIGINT handler\n\
\n\
767
signal constants:\n\
Guido van Rossum's avatar
Guido van Rossum committed
768 769 770 771 772
SIG_DFL -- used to refer to the system default handler\n\
SIG_IGN -- used to ignore the signal\n\
NSIG -- number of defined signals\n\
SIGINT, SIGTERM, etc. -- signal numbers\n\
\n\
773 774 775 776 777 778 779 780 781 782 783 784
itimer constants:\n\
ITIMER_REAL -- decrements in real time, and delivers SIGALRM upon\n\
               expiration\n\
ITIMER_VIRTUAL -- decrements only when the process is executing,\n\
               and delivers SIGVTALRM upon expiration\n\
ITIMER_PROF -- decrements both when the process is executing and\n\
               when the system is executing on behalf of the process.\n\
               Coupled with ITIMER_VIRTUAL, this timer is usually\n\
               used to profile the time spent by the application\n\
               in user and kernel space. SIGPROF is delivered upon\n\
               expiration.\n\
\n\n\
Guido van Rossum's avatar
Guido van Rossum committed
785 786
*** IMPORTANT NOTICE ***\n\
A signal handler function is called with two arguments:\n\
787
the first is the signal number, the second is the interrupted stack frame.");
Guido van Rossum's avatar
Guido van Rossum committed
788

789
static struct PyModuleDef signalmodule = {
790 791 792 793 794 795 796 797 798
    PyModuleDef_HEAD_INIT,
    "signal",
    module_doc,
    -1,
    signal_methods,
    NULL,
    NULL,
    NULL,
    NULL
799 800
};

801
PyMODINIT_FUNC
802
PyInit_signal(void)
803
{
804 805
    PyObject *m, *d, *x;
    int i;
806 807

#ifdef WITH_THREAD
808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
    main_thread = PyThread_get_thread_ident();
    main_pid = getpid();
#endif

    /* Create the module and add the functions */
    m = PyModule_Create(&signalmodule);
    if (m == NULL)
        return NULL;

    /* Add some symbolic constants to the module */
    d = PyModule_GetDict(m);

    x = DefaultHandler = PyLong_FromVoidPtr((void *)SIG_DFL);
    if (!x || PyDict_SetItemString(d, "SIG_DFL", x) < 0)
        goto finally;

    x = IgnoreHandler = PyLong_FromVoidPtr((void *)SIG_IGN);
    if (!x || PyDict_SetItemString(d, "SIG_IGN", x) < 0)
        goto finally;

    x = PyLong_FromLong((long)NSIG);
    if (!x || PyDict_SetItemString(d, "NSIG", x) < 0)
        goto finally;
    Py_DECREF(x);

833
#ifdef SIG_BLOCK
834 835
    if (PyModule_AddIntMacro(m, SIG_BLOCK))
         goto finally;
836 837
#endif
#ifdef SIG_UNBLOCK
838 839
    if (PyModule_AddIntMacro(m, SIG_UNBLOCK))
         goto finally;
840 841
#endif
#ifdef SIG_SETMASK
842 843
    if (PyModule_AddIntMacro(m, SIG_SETMASK))
         goto finally;
844 845
#endif

846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870
    x = IntHandler = PyDict_GetItemString(d, "default_int_handler");
    if (!x)
        goto finally;
    Py_INCREF(IntHandler);

    Handlers[0].tripped = 0;
    for (i = 1; i < NSIG; i++) {
        void (*t)(int);
        t = PyOS_getsig(i);
        Handlers[i].tripped = 0;
        if (t == SIG_DFL)
            Handlers[i].func = DefaultHandler;
        else if (t == SIG_IGN)
            Handlers[i].func = IgnoreHandler;
        else
            Handlers[i].func = Py_None; /* None of our business */
        Py_INCREF(Handlers[i].func);
    }
    if (Handlers[SIGINT].func == DefaultHandler) {
        /* Install default int handler */
        Py_INCREF(IntHandler);
        Py_DECREF(Handlers[SIGINT].func);
        Handlers[SIGINT].func = IntHandler;
        old_siginthandler = PyOS_setsig(SIGINT, signal_handler);
    }
871 872

#ifdef SIGHUP
873 874 875
    x = PyLong_FromLong(SIGHUP);
    PyDict_SetItemString(d, "SIGHUP", x);
    Py_XDECREF(x);
876 877
#endif
#ifdef SIGINT
878 879 880
    x = PyLong_FromLong(SIGINT);
    PyDict_SetItemString(d, "SIGINT", x);
    Py_XDECREF(x);
881
#endif
882
#ifdef SIGBREAK
883 884 885
    x = PyLong_FromLong(SIGBREAK);
    PyDict_SetItemString(d, "SIGBREAK", x);
    Py_XDECREF(x);
886
#endif
887
#ifdef SIGQUIT
888 889 890
    x = PyLong_FromLong(SIGQUIT);
    PyDict_SetItemString(d, "SIGQUIT", x);
    Py_XDECREF(x);
891 892
#endif
#ifdef SIGILL
893 894 895
    x = PyLong_FromLong(SIGILL);
    PyDict_SetItemString(d, "SIGILL", x);
    Py_XDECREF(x);
896 897
#endif
#ifdef SIGTRAP
898 899 900
    x = PyLong_FromLong(SIGTRAP);
    PyDict_SetItemString(d, "SIGTRAP", x);
    Py_XDECREF(x);
901 902
#endif
#ifdef SIGIOT
903 904 905
    x = PyLong_FromLong(SIGIOT);
    PyDict_SetItemString(d, "SIGIOT", x);
    Py_XDECREF(x);
906 907
#endif
#ifdef SIGABRT
908 909 910
    x = PyLong_FromLong(SIGABRT);
    PyDict_SetItemString(d, "SIGABRT", x);
    Py_XDECREF(x);
911 912
#endif
#ifdef SIGEMT
913 914 915
    x = PyLong_FromLong(SIGEMT);
    PyDict_SetItemString(d, "SIGEMT", x);
    Py_XDECREF(x);
916 917
#endif
#ifdef SIGFPE
918 919 920
    x = PyLong_FromLong(SIGFPE);
    PyDict_SetItemString(d, "SIGFPE", x);
    Py_XDECREF(x);
921 922
#endif
#ifdef SIGKILL
923 924 925
    x = PyLong_FromLong(SIGKILL);
    PyDict_SetItemString(d, "SIGKILL", x);
    Py_XDECREF(x);
926 927
#endif
#ifdef SIGBUS
928 929 930
    x = PyLong_FromLong(SIGBUS);
    PyDict_SetItemString(d, "SIGBUS", x);
    Py_XDECREF(x);
931 932
#endif
#ifdef SIGSEGV
933 934 935
    x = PyLong_FromLong(SIGSEGV);
    PyDict_SetItemString(d, "SIGSEGV", x);
    Py_XDECREF(x);
936 937
#endif
#ifdef SIGSYS
938 939 940
    x = PyLong_FromLong(SIGSYS);
    PyDict_SetItemString(d, "SIGSYS", x);
    Py_XDECREF(x);
941 942
#endif
#ifdef SIGPIPE
943 944 945
    x = PyLong_FromLong(SIGPIPE);
    PyDict_SetItemString(d, "SIGPIPE", x);
    Py_XDECREF(x);
946 947
#endif
#ifdef SIGALRM
948 949 950
    x = PyLong_FromLong(SIGALRM);
    PyDict_SetItemString(d, "SIGALRM", x);
    Py_XDECREF(x);
951 952
#endif
#ifdef SIGTERM
953 954 955
    x = PyLong_FromLong(SIGTERM);
    PyDict_SetItemString(d, "SIGTERM", x);
    Py_XDECREF(x);
956 957
#endif
#ifdef SIGUSR1
958 959 960
    x = PyLong_FromLong(SIGUSR1);
    PyDict_SetItemString(d, "SIGUSR1", x);
    Py_XDECREF(x);
961 962
#endif
#ifdef SIGUSR2
963 964 965
    x = PyLong_FromLong(SIGUSR2);
    PyDict_SetItemString(d, "SIGUSR2", x);
    Py_XDECREF(x);
966 967
#endif
#ifdef SIGCLD
968 969 970
    x = PyLong_FromLong(SIGCLD);
    PyDict_SetItemString(d, "SIGCLD", x);
    Py_XDECREF(x);
971 972
#endif
#ifdef SIGCHLD
973 974 975
    x = PyLong_FromLong(SIGCHLD);
    PyDict_SetItemString(d, "SIGCHLD", x);
    Py_XDECREF(x);
976 977
#endif
#ifdef SIGPWR
978 979 980
    x = PyLong_FromLong(SIGPWR);
    PyDict_SetItemString(d, "SIGPWR", x);
    Py_XDECREF(x);
981 982
#endif
#ifdef SIGIO
983 984 985
    x = PyLong_FromLong(SIGIO);
    PyDict_SetItemString(d, "SIGIO", x);
    Py_XDECREF(x);
986 987
#endif
#ifdef SIGURG
988 989 990
    x = PyLong_FromLong(SIGURG);
    PyDict_SetItemString(d, "SIGURG", x);
    Py_XDECREF(x);
991 992
#endif
#ifdef SIGWINCH
993 994 995
    x = PyLong_FromLong(SIGWINCH);
    PyDict_SetItemString(d, "SIGWINCH", x);
    Py_XDECREF(x);
996 997
#endif
#ifdef SIGPOLL
998 999 1000
    x = PyLong_FromLong(SIGPOLL);
    PyDict_SetItemString(d, "SIGPOLL", x);
    Py_XDECREF(x);
1001 1002
#endif
#ifdef SIGSTOP
1003 1004 1005
    x = PyLong_FromLong(SIGSTOP);
    PyDict_SetItemString(d, "SIGSTOP", x);
    Py_XDECREF(x);
1006 1007
#endif
#ifdef SIGTSTP
1008 1009 1010
    x = PyLong_FromLong(SIGTSTP);
    PyDict_SetItemString(d, "SIGTSTP", x);
    Py_XDECREF(x);
1011 1012
#endif
#ifdef SIGCONT
1013 1014 1015
    x = PyLong_FromLong(SIGCONT);
    PyDict_SetItemString(d, "SIGCONT", x);
    Py_XDECREF(x);
1016 1017
#endif
#ifdef SIGTTIN
1018 1019 1020
    x = PyLong_FromLong(SIGTTIN);
    PyDict_SetItemString(d, "SIGTTIN", x);
    Py_XDECREF(x);
1021 1022
#endif
#ifdef SIGTTOU
1023 1024 1025
    x = PyLong_FromLong(SIGTTOU);
    PyDict_SetItemString(d, "SIGTTOU", x);
    Py_XDECREF(x);
1026 1027
#endif
#ifdef SIGVTALRM
1028 1029 1030
    x = PyLong_FromLong(SIGVTALRM);
    PyDict_SetItemString(d, "SIGVTALRM", x);
    Py_XDECREF(x);
1031 1032
#endif
#ifdef SIGPROF
1033 1034 1035
    x = PyLong_FromLong(SIGPROF);
    PyDict_SetItemString(d, "SIGPROF", x);
    Py_XDECREF(x);
1036
#endif
1037
#ifdef SIGXCPU
1038 1039 1040
    x = PyLong_FromLong(SIGXCPU);
    PyDict_SetItemString(d, "SIGXCPU", x);
    Py_XDECREF(x);
1041 1042
#endif
#ifdef SIGXFSZ
1043 1044 1045
    x = PyLong_FromLong(SIGXFSZ);
    PyDict_SetItemString(d, "SIGXFSZ", x);
    Py_XDECREF(x);
1046
#endif
1047
#ifdef SIGRTMIN
1048 1049 1050
    x = PyLong_FromLong(SIGRTMIN);
    PyDict_SetItemString(d, "SIGRTMIN", x);
    Py_XDECREF(x);
1051 1052
#endif
#ifdef SIGRTMAX
1053 1054 1055
    x = PyLong_FromLong(SIGRTMAX);
    PyDict_SetItemString(d, "SIGRTMAX", x);
    Py_XDECREF(x);
1056
#endif
1057
#ifdef SIGINFO
1058 1059 1060
    x = PyLong_FromLong(SIGINFO);
    PyDict_SetItemString(d, "SIGINFO", x);
    Py_XDECREF(x);
1061
#endif
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079

#ifdef ITIMER_REAL
    x = PyLong_FromLong(ITIMER_REAL);
    PyDict_SetItemString(d, "ITIMER_REAL", x);
    Py_DECREF(x);
#endif
#ifdef ITIMER_VIRTUAL
    x = PyLong_FromLong(ITIMER_VIRTUAL);
    PyDict_SetItemString(d, "ITIMER_VIRTUAL", x);
    Py_DECREF(x);
#endif
#ifdef ITIMER_PROF
    x = PyLong_FromLong(ITIMER_PROF);
    PyDict_SetItemString(d, "ITIMER_PROF", x);
    Py_DECREF(x);
#endif

#if defined (HAVE_SETITIMER) || defined (HAVE_GETITIMER)
1080 1081
    ItimerError = PyErr_NewException("signal.ItimerError",
     PyExc_IOError, NULL);
1082
    if (ItimerError != NULL)
1083
    PyDict_SetItemString(d, "ItimerError", ItimerError);
1084 1085
#endif

1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
#ifdef CTRL_C_EVENT
    x = PyLong_FromLong(CTRL_C_EVENT);
    PyDict_SetItemString(d, "CTRL_C_EVENT", x);
    Py_DECREF(x);
#endif

#ifdef CTRL_BREAK_EVENT
    x = PyLong_FromLong(CTRL_BREAK_EVENT);
    PyDict_SetItemString(d, "CTRL_BREAK_EVENT", x);
    Py_DECREF(x);
#endif

1098
    if (PyErr_Occurred()) {
1099 1100
        Py_DECREF(m);
        m = NULL;
1101
    }
Barry Warsaw's avatar
Barry Warsaw committed
1102 1103

  finally:
1104
    return m;
1105 1106 1107
}

static void
1108
finisignal(void)
1109
{
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
    int i;
    PyObject *func;

    PyOS_setsig(SIGINT, old_siginthandler);
    old_siginthandler = SIG_DFL;

    for (i = 1; i < NSIG; i++) {
        func = Handlers[i].func;
        Handlers[i].tripped = 0;
        Handlers[i].func = NULL;
        if (i != SIGINT && func != NULL && func != Py_None &&
            func != DefaultHandler && func != IgnoreHandler)
            PyOS_setsig(i, SIG_DFL);
        Py_XDECREF(func);
    }

    Py_XDECREF(IntHandler);
    IntHandler = NULL;
    Py_XDECREF(DefaultHandler);
    DefaultHandler = NULL;
    Py_XDECREF(IgnoreHandler);
    IgnoreHandler = NULL;
1132 1133
}

Barry Warsaw's avatar
Barry Warsaw committed
1134 1135

/* Declared in pyerrors.h */
1136
int
1137
PyErr_CheckSignals(void)
1138
{
1139 1140
    int i;
    PyObject *f;
Barry Warsaw's avatar
Barry Warsaw committed
1141

1142 1143
    if (!is_tripped)
        return 0;
1144

1145
#ifdef WITH_THREAD
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
    if (PyThread_get_thread_ident() != main_thread)
        return 0;
#endif

    /*
     * The is_tripped variable is meant to speed up the calls to
     * PyErr_CheckSignals (both directly or via pending calls) when no
     * signal has arrived. This variable is set to 1 when a signal arrives
     * and it is set to 0 here, when we know some signals arrived. This way
     * we can run the registered handlers with no signals blocked.
     *
     * NOTE: with this approach we can have a situation where is_tripped is
     *       1 but we have no more signals to handle (Handlers[i].tripped
     *       is 0 for every signal i). This won't do us any harm (except
     *       we're gonna spent some cycles for nothing). This happens when
     *       we receive a signal i after we zero is_tripped and before we
     *       check Handlers[i].tripped.
     */
    is_tripped = 0;

    if (!(f = (PyObject *)PyEval_GetFrame()))
        f = Py_None;

    for (i = 1; i < NSIG; i++) {
        if (Handlers[i].tripped) {
            PyObject *result = NULL;
            PyObject *arglist = Py_BuildValue("(iO)", i, f);
            Handlers[i].tripped = 0;

            if (arglist) {
                result = PyEval_CallObject(Handlers[i].func,
                                           arglist);
                Py_DECREF(arglist);
            }
            if (!result)
                return -1;

            Py_DECREF(result);
        }
    }

    return 0;
1188 1189
}

1190

Barry Warsaw's avatar
Barry Warsaw committed
1191 1192 1193 1194
/* Replacements for intrcheck.c functionality
 * Declared in pyerrors.h
 */
void
1195
PyErr_SetInterrupt(void)
Barry Warsaw's avatar
Barry Warsaw committed
1196
{
1197
    trip_signal(SIGINT);
Barry Warsaw's avatar
Barry Warsaw committed
1198
}
1199 1200

void
1201
PyOS_InitInterrupts(void)
1202
{
1203 1204
    PyObject *m = PyInit_signal();
    if (m) {
1205
        _PyImport_FixupBuiltin(m, "signal");
1206 1207
        Py_DECREF(m);
    }
1208 1209 1210
}

void
1211
PyOS_FiniInterrupts(void)
1212
{
1213
    finisignal();
1214 1215 1216
}

int
1217
PyOS_InterruptOccurred(void)
1218
{
1219
    if (Handlers[SIGINT].tripped) {
1220
#ifdef WITH_THREAD
1221 1222
        if (PyThread_get_thread_ident() != main_thread)
            return 0;
1223
#endif
1224 1225 1226 1227
        Handlers[SIGINT].tripped = 0;
        return 1;
    }
    return 0;
1228
}
1229 1230

void
1231
PyOS_AfterFork(void)
1232 1233
{
#ifdef WITH_THREAD
1234
    _PyGILState_Reinit();
1235 1236 1237 1238 1239
    PyEval_ReInitThreads();
    main_thread = PyThread_get_thread_ident();
    main_pid = getpid();
    _PyImport_ReInitLock();
    PyThread_ReInitTLS();
1240 1241
#endif
}