1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001 Free Software Foundation, Inc.
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2, or (at your option)
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this software; see the file COPYING. If not, write to
15 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
16 * Boston, MA 02111-1307 USA
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
21 * The exception is that, if you link the GUILE library with other files
22 * to produce an executable, this does not by itself cause the
23 * resulting executable to be covered by the GNU General Public License.
24 * Your use of that executable is in no way restricted on account of
25 * linking the GUILE library code into it.
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
30 * This exception applies only to the code released by the
31 * Free Software Foundation under the name GUILE. If you copy
32 * code from other Free Software Foundation releases into a copy of
33 * GUILE, as the General Public License permits, the exception does
34 * not apply to the code that you add in this way. To avoid misleading
35 * anyone as to the status of such modified files, you must delete
36 * this exception notice from them.
38 * If you write modifications of your own for GUILE, it is your choice
39 * whether to permit this exception to apply to your modifications.
40 * If you do not wish that, delete this exception notice. */
48 #include "libguile/_scm.h"
50 #include "libguile/async.h"
51 #include "libguile/eval.h"
52 #include "libguile/root.h"
53 #include "libguile/vectors.h"
55 #include "libguile/validate.h"
56 #include "libguile/scmsigs.h"
62 #ifdef HAVE_SYS_TIME_H
66 /* The thread system has its own sleep and usleep functions. */
69 #if defined(MISSING_SLEEP_DECL)
73 #if defined(HAVE_USLEEP) && defined(MISSING_USLEEP_DECL)
81 #define alarm(sec) (0)
82 /* This weird comma expression is because Sleep is void under Windows. */
83 #define sleep(sec) (Sleep ((sec) * 1000), 0)
84 #define usleep(usec) (Sleep ((usec) / 1000), 0)
85 #define kill(pid, sig) raise (sig)
90 /* SIGRETTYPE is the type that signal handlers return. See <signal.h> */
93 # define SIGRETTYPE RETSIGTYPE
96 # define SIGRETTYPE void
98 # define SIGRETTYPE int
104 /* take_signal is installed as the C signal handler whenever a Scheme
105 handler is set. when a signal arrives, take_signal marks the corresponding
106 element of got_signal and marks signal_async. the thunk in signal_async
107 (sys_deliver_signals) will be run at the next opportunity, outside a
108 critical section. sys_deliver_signals runs each Scheme handler for
109 which got_signal is set. */
111 static SCM signal_async
;
113 static char got_signal
[NSIG
];
115 /* a Scheme vector of handler procedures. */
116 static SCM
*signal_handlers
;
118 /* saves the original C handlers, when a new handler is installed.
119 set to SIG_ERR if the original handler is installed. */
120 #ifdef HAVE_SIGACTION
121 static struct sigaction orig_handlers
[NSIG
];
123 static SIGRETTYPE (*orig_handlers
[NSIG
])(int);
127 take_signal (int signum
)
129 int saved_errno
= errno
;
132 if (!scm_ints_disabled
)
134 /* For reasons of speed, the SCM_NEWCELL macro doesn't defer
135 interrupts. Instead, it first sets its argument to point to
136 the first cell in the list, and then advances the freelist
137 pointer to the next cell. Now, if this procedure is
138 interrupted, the only anomalous state possible is to have
139 both SCM_NEWCELL's argument and scm_freelist pointing to the
140 same cell. To deal with this case, we always throw away the
141 first cell in scm_freelist here.
143 At least, that's the theory. I'm not convinced that that's
144 the only anomalous path we need to worry about. */
145 SCM_NEWCELL (ignored
);
147 got_signal
[signum
] = 1;
149 /* unblock the signal before the scheme handler gets to run, since
150 it may use longjmp to escape (i.e., throw an exception). */
154 sigaddset (&set
, signum
);
155 sigprocmask (SIG_UNBLOCK
, &set
, NULL
);
158 scm_system_async_mark (signal_async
);
163 sys_deliver_signals (void)
167 for (i
= 0; i
< NSIG
; i
++)
171 /* The flag is reset before calling the handler in case the
172 handler doesn't return. If the handler doesn't return
173 but leaves other signals flagged, they their handlers
174 will be applied some time later when the async is checked
175 again. It would probably be better to reset the flags
176 after doing a longjmp. */
178 #ifndef HAVE_SIGACTION
179 signal (i
, take_signal
);
181 scm_call_1 (SCM_VELTS (*signal_handlers
)[i
], SCM_MAKINUM (i
));
184 return SCM_UNSPECIFIED
;
187 /* user interface for installation of signal handlers. */
188 SCM_DEFINE (scm_sigaction
, "sigaction", 1, 2, 0,
189 (SCM signum
, SCM handler
, SCM flags
),
190 "Install or report the signal handler for a specified signal.\n\n"
191 "@var{signum} is the signal number, which can be specified using the value\n"
192 "of variables such as @code{SIGINT}.\n\n"
193 "If @var{action} is omitted, @code{sigaction} returns a pair: the\n"
194 "CAR is the current\n"
195 "signal hander, which will be either an integer with the value @code{SIG_DFL}\n"
196 "(default action) or @code{SIG_IGN} (ignore), or the Scheme procedure which\n"
197 "handles the signal, or @code{#f} if a non-Scheme procedure handles the\n"
198 "signal. The CDR contains the current @code{sigaction} flags for the handler.\n\n"
199 "If @var{action} is provided, it is installed as the new handler for\n"
200 "@var{signum}. @var{action} can be a Scheme procedure taking one\n"
201 "argument, or the value of @code{SIG_DFL} (default action) or\n"
202 "@code{SIG_IGN} (ignore), or @code{#f} to restore whatever signal handler\n"
203 "was installed before @code{sigaction} was first used. Flags can\n"
204 "optionally be specified for the new handler (@code{SA_RESTART} will\n"
205 "always be added if it's available and the system is using restartable\n"
206 "system calls.) The return value is a pair with information about the\n"
207 "old handler as described above.\n\n"
208 "This interface does not provide access to the \"signal blocking\"\n"
209 "facility. Maybe this is not needed, since the thread support may\n"
210 "provide solutions to the problem of consistent access to data\n"
212 #define FUNC_NAME s_scm_sigaction
215 #ifdef HAVE_SIGACTION
216 struct sigaction action
;
217 struct sigaction old_action
;
219 SIGRETTYPE (* chandler
) (int);
220 SIGRETTYPE (* old_chandler
) (int);
223 int save_handler
= 0;
224 SCM
*scheme_handlers
= SCM_VELTS (*signal_handlers
);
227 SCM_VALIDATE_INUM_COPY (1,signum
,csig
);
228 #if defined(HAVE_SIGACTION)
229 #if defined(SA_RESTART) && defined(HAVE_RESTARTABLE_SYSCALLS)
230 /* don't allow SA_RESTART to be omitted if HAVE_RESTARTABLE_SYSCALLS
231 is defined, since libguile would be likely to produce spurious
233 action
.sa_flags
= SA_RESTART
;
237 if (!SCM_UNBNDP (flags
))
239 SCM_VALIDATE_INUM (3,flags
);
240 action
.sa_flags
|= SCM_INUM (flags
);
242 sigemptyset (&action
.sa_mask
);
245 old_handler
= scheme_handlers
[csig
];
246 if (SCM_UNBNDP (handler
))
248 else if (SCM_EQ_P (scm_integer_p (handler
), SCM_BOOL_T
))
250 if (SCM_NUM2LONG (2, handler
) == (long) SIG_DFL
251 || SCM_NUM2LONG (2, handler
) == (long) SIG_IGN
)
253 #ifdef HAVE_SIGACTION
254 action
.sa_handler
= (SIGRETTYPE (*) (int)) SCM_INUM (handler
);
256 chandler
= (SIGRETTYPE (*) (int)) SCM_INUM (handler
);
258 scheme_handlers
[csig
] = SCM_BOOL_F
;
261 SCM_OUT_OF_RANGE (2, handler
);
263 else if (SCM_FALSEP (handler
))
265 /* restore the default handler. */
266 #ifdef HAVE_SIGACTION
267 if (orig_handlers
[csig
].sa_handler
== SIG_ERR
)
271 action
= orig_handlers
[csig
];
272 orig_handlers
[csig
].sa_handler
= SIG_ERR
;
273 scheme_handlers
[csig
] = SCM_BOOL_F
;
276 if (orig_handlers
[csig
] == SIG_ERR
)
280 chandler
= orig_handlers
[csig
];
281 orig_handlers
[csig
] = SIG_ERR
;
282 scheme_handlers
[csig
] = SCM_BOOL_F
;
288 SCM_VALIDATE_NIM (2,handler
);
289 #ifdef HAVE_SIGACTION
290 action
.sa_handler
= take_signal
;
291 if (orig_handlers
[csig
].sa_handler
== SIG_ERR
)
294 chandler
= take_signal
;
295 if (orig_handlers
[csig
] == SIG_ERR
)
298 scheme_handlers
[csig
] = handler
;
301 /* XXX - Silently ignore setting handlers for `program error signals'
302 because they can't currently be handled by Scheme code.
307 /* This list of program error signals is from the GNU Libc
316 #if defined(SIGIOT) && (SIGIOT != SIGABRT)
331 #ifdef HAVE_SIGACTION
334 if (sigaction (csig
, 0, &old_action
) == -1)
339 if (sigaction (csig
, &action
, &old_action
) == -1)
342 orig_handlers
[csig
] = old_action
;
344 if (old_action
.sa_handler
== SIG_DFL
|| old_action
.sa_handler
== SIG_IGN
)
345 old_handler
= scm_long2num ((long) old_action
.sa_handler
);
347 return scm_cons (old_handler
, SCM_MAKINUM (old_action
.sa_flags
));
351 if ((old_chandler
= signal (csig
, SIG_IGN
)) == SIG_ERR
)
353 if (signal (csig
, old_chandler
) == SIG_ERR
)
358 if ((old_chandler
= signal (csig
, chandler
)) == SIG_ERR
)
361 orig_handlers
[csig
] = old_chandler
;
363 if (old_chandler
== SIG_DFL
|| old_chandler
== SIG_IGN
)
364 old_handler
= scm_long2num ((long) old_chandler
);
366 return scm_cons (old_handler
, SCM_MAKINUM (0));
371 SCM_DEFINE (scm_restore_signals
, "restore-signals", 0, 0, 0,
373 "Return all signal handlers to the values they had before any call to\n"
374 "@code{sigaction} was made. The return value is unspecified.")
375 #define FUNC_NAME s_scm_restore_signals
378 SCM
*scheme_handlers
= SCM_VELTS (*signal_handlers
);
380 for (i
= 0; i
< NSIG
; i
++)
382 #ifdef HAVE_SIGACTION
383 if (orig_handlers
[i
].sa_handler
!= SIG_ERR
)
385 if (sigaction (i
, &orig_handlers
[i
], NULL
) == -1)
387 orig_handlers
[i
].sa_handler
= SIG_ERR
;
388 scheme_handlers
[i
] = SCM_BOOL_F
;
391 if (orig_handlers
[i
] != SIG_ERR
)
393 if (signal (i
, orig_handlers
[i
]) == SIG_ERR
)
395 orig_handlers
[i
] = SIG_ERR
;
396 scheme_handlers
[i
] = SCM_BOOL_F
;
400 return SCM_UNSPECIFIED
;
404 SCM_DEFINE (scm_alarm
, "alarm", 1, 0, 0,
406 "Set a timer to raise a @code{SIGALRM} signal after the specified\n"
407 "number of seconds (an integer). It's advisable to install a signal\n"
409 "@code{SIGALRM} beforehand, since the default action is to terminate\n"
411 "The return value indicates the time remaining for the previous alarm,\n"
412 "if any. The new value replaces the previous alarm. If there was\n"
413 "no previous alarm, the return value is zero.")
414 #define FUNC_NAME s_scm_alarm
417 SCM_VALIDATE_INUM (1,i
);
418 j
= alarm (SCM_INUM (i
));
419 return SCM_MAKINUM (j
);
423 #ifdef HAVE_SETITIMER
424 SCM_DEFINE (scm_setitimer
, "setitimer", 5, 0, 0,
426 SCM interval_seconds
, SCM interval_microseconds
,
427 SCM value_seconds
, SCM value_microseconds
),
428 "Set the timer specified by @var{which_timer} according to the given\n"
429 "@var{interval_seconds}, @var{interval_microseconds},\n"
430 "@var{value_seconds}, and @var{value_microseconds} values.\n"
432 "Return information about the timer's previous setting."
434 "Errors are handled as described in the guile info pages under ``POSIX\n"
435 "Interface Conventions''.\n"
437 "The timers available are: @code{ITIMER_REAL}, @code{ITIMER_VIRTUAL}, \n"
438 "and @code{ITIMER_PROF}.\n"
440 "The return value will be a list of two cons pairs representing the\n"
441 "current state of the given timer. The first pair is the seconds and\n"
442 "microseconds of the timer @code{it_interval}, and the second pair is\n"
443 "the seconds and microseconds of the timer @code{it_value}.\n")
444 #define FUNC_NAME s_scm_setitimer
448 struct itimerval new_timer
;
449 struct itimerval old_timer
;
451 c_which_timer
= SCM_NUM2INT(1, which_timer
);
452 new_timer
.it_interval
.tv_sec
= SCM_NUM2LONG(2, interval_seconds
);
453 new_timer
.it_interval
.tv_usec
= SCM_NUM2LONG(3, interval_microseconds
);
454 new_timer
.it_value
.tv_sec
= SCM_NUM2LONG(4, value_seconds
);
455 new_timer
.it_value
.tv_usec
= SCM_NUM2LONG(5, value_microseconds
);
457 SCM_SYSCALL(rv
= setitimer(c_which_timer
, &new_timer
, &old_timer
));
462 return scm_list_2(scm_cons(scm_long2num(old_timer
.it_interval
.tv_sec
),
463 scm_long2num(old_timer
.it_interval
.tv_usec
)),
464 scm_cons(scm_long2num(old_timer
.it_value
.tv_sec
),
465 scm_long2num(old_timer
.it_value
.tv_usec
)));
468 #endif /* HAVE_SETITIMER */
470 #ifdef HAVE_GETITIMER
471 SCM_DEFINE (scm_getitimer
, "getitimer", 1, 0, 0,
473 "Return information about the timer specified by @var{which_timer}"
475 "Errors are handled as described in the guile info pages under ``POSIX\n"
476 "Interface Conventions''.\n"
478 "The timers available are: @code{ITIMER_REAL}, @code{ITIMER_VIRTUAL}, \n"
479 "and @code{ITIMER_PROF}.\n"
481 "The return value will be a list of two cons pairs representing the\n"
482 "current state of the given timer. The first pair is the seconds and\n"
483 "microseconds of the timer @code{it_interval}, and the second pair is\n"
484 "the seconds and microseconds of the timer @code{it_value}.\n")
485 #define FUNC_NAME s_scm_getitimer
489 struct itimerval old_timer
;
491 c_which_timer
= SCM_NUM2INT(1, which_timer
);
493 SCM_SYSCALL(rv
= getitimer(c_which_timer
, &old_timer
));
498 return scm_list_2(scm_cons(scm_long2num(old_timer
.it_interval
.tv_sec
),
499 scm_long2num(old_timer
.it_interval
.tv_usec
)),
500 scm_cons(scm_long2num(old_timer
.it_value
.tv_sec
),
501 scm_long2num(old_timer
.it_value
.tv_usec
)));
504 #endif /* HAVE_GETITIMER */
507 SCM_DEFINE (scm_pause
, "pause", 0, 0, 0,
509 "Pause the current process (thread?) until a signal arrives whose\n"
510 "action is to either terminate the current process or invoke a\n"
511 "handler procedure. The return value is unspecified.")
512 #define FUNC_NAME s_scm_pause
515 return SCM_UNSPECIFIED
;
520 SCM_DEFINE (scm_sleep
, "sleep", 1, 0, 0,
522 "Wait for the given number of seconds (an integer) or until a signal\n"
523 "arrives. The return value is zero if the time elapses or the number\n"
524 "of seconds remaining otherwise.")
525 #define FUNC_NAME s_scm_sleep
528 SCM_VALIDATE_INUM_MIN (1,i
,0);
530 j
= scm_thread_sleep (SCM_INUM(i
));
532 j
= sleep (SCM_INUM(i
));
534 return scm_ulong2num (j
);
538 #if defined(USE_THREADS) || defined(HAVE_USLEEP) || defined(__MINGW32__)
539 SCM_DEFINE (scm_usleep
, "usleep", 1, 0, 0,
541 "Sleep for I microseconds. @code{usleep} is not available on\n"
543 #define FUNC_NAME s_scm_usleep
545 SCM_VALIDATE_INUM_MIN (1,i
,0);
548 /* If we have threads, we use the thread system's sleep function. */
550 unsigned long j
= scm_thread_usleep (SCM_INUM (i
));
551 return scm_ulong2num (j
);
554 #ifdef USLEEP_RETURNS_VOID
555 usleep (SCM_INUM (i
));
559 int j
= usleep (SCM_INUM (i
));
560 return SCM_MAKINUM (j
);
566 #endif /* USE_THREADS || HAVE_USLEEP || __MINGW32__ */
568 SCM_DEFINE (scm_raise
, "raise", 1, 0, 0,
570 "Sends a specified signal @var{sig} to the current process, where\n"
571 "@var{sig} is as described for the kill procedure.")
572 #define FUNC_NAME s_scm_raise
574 SCM_VALIDATE_INUM (1,sig
);
576 if (kill (getpid (), (int) SCM_INUM (sig
)) != 0)
579 return SCM_UNSPECIFIED
;
592 SCM_VARIABLE_LOC (scm_c_define ("signal-handlers",
593 scm_c_make_vector (NSIG
, SCM_BOOL_F
)));
594 /* XXX - use scm_c_make_gsubr here instead of `define'? */
595 thunk
= scm_c_define_gsubr ("%deliver-signals", 0, 0, 0,
596 sys_deliver_signals
);
597 signal_async
= scm_system_async (thunk
);
599 for (i
= 0; i
< NSIG
; i
++)
602 #ifdef HAVE_SIGACTION
603 orig_handlers
[i
].sa_handler
= SIG_ERR
;
606 orig_handlers
[i
] = SIG_ERR
;
609 #ifdef HAVE_RESTARTABLE_SYSCALLS
610 /* If HAVE_RESTARTABLE_SYSCALLS is defined, it's important that
611 signals really are restartable. don't rely on the same
612 run-time that configure got: reset the default for every signal.
614 #ifdef HAVE_SIGINTERRUPT
616 #elif defined(SA_RESTART)
618 struct sigaction action
;
620 sigaction (i
, NULL
, &action
);
621 if (!(action
.sa_flags
& SA_RESTART
))
623 action
.sa_flags
|= SA_RESTART
;
624 sigaction (i
, &action
, NULL
);
628 /* if neither siginterrupt nor SA_RESTART are available we may
629 as well assume that signals are always restartable. */
633 scm_c_define ("NSIG", scm_long2num (NSIG
));
634 scm_c_define ("SIG_IGN", scm_long2num ((long) SIG_IGN
));
635 scm_c_define ("SIG_DFL", scm_long2num ((long) SIG_DFL
));
637 scm_c_define ("SA_NOCLDSTOP", scm_long2num (SA_NOCLDSTOP
));
640 scm_c_define ("SA_RESTART", scm_long2num (SA_RESTART
));
643 #if defined(HAVE_SETITIMER) || defined(HAVE_GETITIMER)
644 /* Stuff needed by setitimer and getitimer. */
645 scm_c_define ("ITIMER_REAL", SCM_MAKINUM (ITIMER_REAL
));
646 scm_c_define ("ITIMER_VIRTUAL", SCM_MAKINUM (ITIMER_VIRTUAL
));
647 scm_c_define ("ITIMER_PROF", SCM_MAKINUM (ITIMER_PROF
));
648 #endif /* defined(HAVE_SETITIMER) || defined(HAVE_GETITIMER) */
650 #ifndef SCM_MAGIC_SNARFER
651 #include "libguile/scmsigs.x"