1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002 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 will queue the
106 Scheme handler procedure for its thread. */
109 /* Scheme vectors with information about a signal. signal_handlers
110 contains the handler procedure or #f, signal_handler_cells contains
111 preallocated cells for queuing the handler in take_signal since we
112 can't allocate during signal delivery, signal_handler_threads
113 points to the thread that a signal should be delivered to.
115 static SCM
*signal_handlers
;
116 static SCM signal_handler_cells
;
117 static SCM signal_handler_threads
;
119 /* saves the original C handlers, when a new handler is installed.
120 set to SIG_ERR if the original handler is installed. */
121 #ifdef HAVE_SIGACTION
122 static struct sigaction orig_handlers
[NSIG
];
124 static SIGRETTYPE (*orig_handlers
[NSIG
])(int);
128 take_signal (int signum
)
130 if (signum
>= 0 && signum
< NSIG
)
132 SCM thread
= SCM_VECTOR_REF (signal_handler_threads
, signum
);
133 scm_i_queue_async_cell (SCM_VECTOR_REF(signal_handler_cells
, signum
),
134 scm_i_thread_root (thread
));
136 #ifndef HAVE_SIGACTION
137 signal (signum
, take_signal
);
142 scm_sigaction (SCM signum
, SCM handler
, SCM flags
)
144 return scm_sigaction_for_thread (signum
, handler
, flags
, SCM_UNDEFINED
);
148 close_1 (SCM proc
, SCM arg
)
150 return scm_primitive_eval_x (scm_list_3 (scm_sym_lambda
, SCM_EOL
,
151 scm_list_2 (proc
, arg
)));
154 /* user interface for installation of signal handlers. */
155 SCM_DEFINE (scm_sigaction_for_thread
, "sigaction", 1, 3, 0,
156 (SCM signum
, SCM handler
, SCM flags
, SCM thread
),
157 "Install or report the signal handler for a specified signal.\n\n"
158 "@var{signum} is the signal number, which can be specified using the value\n"
159 "of variables such as @code{SIGINT}.\n\n"
160 "If @var{handler} is omitted, @code{sigaction} returns a pair: the\n"
161 "CAR is the current\n"
162 "signal hander, which will be either an integer with the value @code{SIG_DFL}\n"
163 "(default action) or @code{SIG_IGN} (ignore), or the Scheme procedure which\n"
164 "handles the signal, or @code{#f} if a non-Scheme procedure handles the\n"
165 "signal. The CDR contains the current @code{sigaction} flags for the handler.\n\n"
166 "If @var{handler} is provided, it is installed as the new handler for\n"
167 "@var{signum}. @var{handler} can be a Scheme procedure taking one\n"
168 "argument, or the value of @code{SIG_DFL} (default action) or\n"
169 "@code{SIG_IGN} (ignore), or @code{#f} to restore whatever signal handler\n"
170 "was installed before @code{sigaction} was first used. When\n"
171 "a scheme procedure has been specified, that procedure will run\n"
172 "in the given @var{thread}. When no thread has been given, the\n"
173 "thread that made this call to @code{sigaction} is used.\n"
175 "optionally be specified for the new handler (@code{SA_RESTART} will\n"
176 "always be added if it's available and the system is using restartable\n"
177 "system calls.) The return value is a pair with information about the\n"
178 "old handler as described above.\n\n"
179 "This interface does not provide access to the \"signal blocking\"\n"
180 "facility. Maybe this is not needed, since the thread support may\n"
181 "provide solutions to the problem of consistent access to data\n"
183 #define FUNC_NAME s_scm_sigaction_for_thread
186 #ifdef HAVE_SIGACTION
187 struct sigaction action
;
188 struct sigaction old_action
;
190 SIGRETTYPE (* chandler
) (int) = SIG_DFL
;
191 SIGRETTYPE (* old_chandler
) (int);
194 int save_handler
= 0;
198 SCM_VALIDATE_INUM_COPY (1, signum
, csig
);
199 if (csig
< 0 || csig
> NSIG
)
200 SCM_OUT_OF_RANGE (1, signum
);
201 #if defined(HAVE_SIGACTION)
202 #if defined(SA_RESTART) && defined(HAVE_RESTARTABLE_SYSCALLS)
203 /* don't allow SA_RESTART to be omitted if HAVE_RESTARTABLE_SYSCALLS
204 is defined, since libguile would be likely to produce spurious
206 action
.sa_flags
= SA_RESTART
;
210 if (!SCM_UNBNDP (flags
))
212 SCM_VALIDATE_INUM (3, flags
);
213 action
.sa_flags
|= SCM_INUM (flags
);
215 sigemptyset (&action
.sa_mask
);
216 if (SCM_UNBNDP (thread
))
217 thread
= scm_current_thread ();
219 SCM_VALIDATE_THREAD (4, thread
);
222 old_handler
= SCM_VECTOR_REF(*signal_handlers
, csig
);
223 if (SCM_UNBNDP (handler
))
225 else if (SCM_EQ_P (scm_integer_p (handler
), SCM_BOOL_T
))
227 if (SCM_NUM2LONG (2, handler
) == (long) SIG_DFL
228 || SCM_NUM2LONG (2, handler
) == (long) SIG_IGN
)
230 #ifdef HAVE_SIGACTION
231 action
.sa_handler
= (SIGRETTYPE (*) (int)) SCM_INUM (handler
);
233 chandler
= (SIGRETTYPE (*) (int)) SCM_INUM (handler
);
235 SCM_VECTOR_SET (*signal_handlers
, csig
, SCM_BOOL_F
);
238 SCM_OUT_OF_RANGE (2, handler
);
240 else if (SCM_FALSEP (handler
))
242 /* restore the default handler. */
243 #ifdef HAVE_SIGACTION
244 if (orig_handlers
[csig
].sa_handler
== SIG_ERR
)
248 action
= orig_handlers
[csig
];
249 orig_handlers
[csig
].sa_handler
= SIG_ERR
;
250 SCM_VECTOR_SET (*signal_handlers
, csig
, SCM_BOOL_F
);
254 if (orig_handlers
[csig
] == SIG_ERR
)
258 chandler
= orig_handlers
[csig
];
259 orig_handlers
[csig
] = SIG_ERR
;
260 SCM_VECTOR_SET (*signal_handlers
, csig
, SCM_BOOL_F
);
266 SCM_VALIDATE_NIM (2, handler
);
267 #ifdef HAVE_SIGACTION
268 action
.sa_handler
= take_signal
;
269 if (orig_handlers
[csig
].sa_handler
== SIG_ERR
)
272 chandler
= take_signal
;
273 if (orig_handlers
[csig
] == SIG_ERR
)
276 SCM_VECTOR_SET (*signal_handlers
, csig
, handler
);
277 SCM_VECTOR_SET (signal_handler_cells
, csig
,
278 scm_cons (close_1 (handler
, signum
), SCM_BOOL_F
));
279 SCM_VECTOR_SET (signal_handler_threads
, csig
, thread
);
282 /* XXX - Silently ignore setting handlers for `program error signals'
283 because they can't currently be handled by Scheme code.
288 /* This list of program error signals is from the GNU Libc
297 #if defined(SIGIOT) && (SIGIOT != SIGABRT)
312 #ifdef HAVE_SIGACTION
315 if (sigaction (csig
, 0, &old_action
) == -1)
320 if (sigaction (csig
, &action
, &old_action
) == -1)
323 orig_handlers
[csig
] = old_action
;
325 if (old_action
.sa_handler
== SIG_DFL
|| old_action
.sa_handler
== SIG_IGN
)
326 old_handler
= scm_long2num ((long) old_action
.sa_handler
);
328 return scm_cons (old_handler
, SCM_MAKINUM (old_action
.sa_flags
));
332 if ((old_chandler
= signal (csig
, SIG_IGN
)) == SIG_ERR
)
334 if (signal (csig
, old_chandler
) == SIG_ERR
)
339 if ((old_chandler
= signal (csig
, chandler
)) == SIG_ERR
)
342 orig_handlers
[csig
] = old_chandler
;
344 if (old_chandler
== SIG_DFL
|| old_chandler
== SIG_IGN
)
345 old_handler
= scm_long2num ((long) old_chandler
);
347 return scm_cons (old_handler
, SCM_MAKINUM (0));
352 SCM_DEFINE (scm_restore_signals
, "restore-signals", 0, 0, 0,
354 "Return all signal handlers to the values they had before any call to\n"
355 "@code{sigaction} was made. The return value is unspecified.")
356 #define FUNC_NAME s_scm_restore_signals
359 for (i
= 0; i
< NSIG
; i
++)
361 #ifdef HAVE_SIGACTION
362 if (orig_handlers
[i
].sa_handler
!= SIG_ERR
)
364 if (sigaction (i
, &orig_handlers
[i
], NULL
) == -1)
366 orig_handlers
[i
].sa_handler
= SIG_ERR
;
367 SCM_VECTOR_SET (*signal_handlers
, i
, SCM_BOOL_F
);
370 if (orig_handlers
[i
] != SIG_ERR
)
372 if (signal (i
, orig_handlers
[i
]) == SIG_ERR
)
374 orig_handlers
[i
] = SIG_ERR
;
375 SCM_VECTOR_SET (*signal_handlers
, i
, SCM_BOOL_F
);
379 return SCM_UNSPECIFIED
;
383 SCM_DEFINE (scm_alarm
, "alarm", 1, 0, 0,
385 "Set a timer to raise a @code{SIGALRM} signal after the specified\n"
386 "number of seconds (an integer). It's advisable to install a signal\n"
388 "@code{SIGALRM} beforehand, since the default action is to terminate\n"
390 "The return value indicates the time remaining for the previous alarm,\n"
391 "if any. The new value replaces the previous alarm. If there was\n"
392 "no previous alarm, the return value is zero.")
393 #define FUNC_NAME s_scm_alarm
396 SCM_VALIDATE_INUM (1, i
);
397 j
= alarm (SCM_INUM (i
));
398 return SCM_MAKINUM (j
);
402 #ifdef HAVE_SETITIMER
403 SCM_DEFINE (scm_setitimer
, "setitimer", 5, 0, 0,
405 SCM interval_seconds
, SCM interval_microseconds
,
406 SCM value_seconds
, SCM value_microseconds
),
407 "Set the timer specified by @var{which_timer} according to the given\n"
408 "@var{interval_seconds}, @var{interval_microseconds},\n"
409 "@var{value_seconds}, and @var{value_microseconds} values.\n"
411 "Return information about the timer's previous setting."
413 "Errors are handled as described in the guile info pages under ``POSIX\n"
414 "Interface Conventions''.\n"
416 "The timers available are: @code{ITIMER_REAL}, @code{ITIMER_VIRTUAL},\n"
417 "and @code{ITIMER_PROF}.\n"
419 "The return value will be a list of two cons pairs representing the\n"
420 "current state of the given timer. The first pair is the seconds and\n"
421 "microseconds of the timer @code{it_interval}, and the second pair is\n"
422 "the seconds and microseconds of the timer @code{it_value}.")
423 #define FUNC_NAME s_scm_setitimer
427 struct itimerval new_timer
;
428 struct itimerval old_timer
;
430 c_which_timer
= SCM_NUM2INT(1, which_timer
);
431 new_timer
.it_interval
.tv_sec
= SCM_NUM2LONG(2, interval_seconds
);
432 new_timer
.it_interval
.tv_usec
= SCM_NUM2LONG(3, interval_microseconds
);
433 new_timer
.it_value
.tv_sec
= SCM_NUM2LONG(4, value_seconds
);
434 new_timer
.it_value
.tv_usec
= SCM_NUM2LONG(5, value_microseconds
);
436 SCM_SYSCALL(rv
= setitimer(c_which_timer
, &new_timer
, &old_timer
));
441 return scm_list_2(scm_cons(scm_long2num(old_timer
.it_interval
.tv_sec
),
442 scm_long2num(old_timer
.it_interval
.tv_usec
)),
443 scm_cons(scm_long2num(old_timer
.it_value
.tv_sec
),
444 scm_long2num(old_timer
.it_value
.tv_usec
)));
447 #endif /* HAVE_SETITIMER */
449 #ifdef HAVE_GETITIMER
450 SCM_DEFINE (scm_getitimer
, "getitimer", 1, 0, 0,
452 "Return information about the timer specified by @var{which_timer}"
454 "Errors are handled as described in the guile info pages under ``POSIX\n"
455 "Interface Conventions''.\n"
457 "The timers available are: @code{ITIMER_REAL}, @code{ITIMER_VIRTUAL},\n"
458 "and @code{ITIMER_PROF}.\n"
460 "The return value will be a list of two cons pairs representing the\n"
461 "current state of the given timer. The first pair is the seconds and\n"
462 "microseconds of the timer @code{it_interval}, and the second pair is\n"
463 "the seconds and microseconds of the timer @code{it_value}.")
464 #define FUNC_NAME s_scm_getitimer
468 struct itimerval old_timer
;
470 c_which_timer
= SCM_NUM2INT(1, which_timer
);
472 SCM_SYSCALL(rv
= getitimer(c_which_timer
, &old_timer
));
477 return scm_list_2(scm_cons(scm_long2num(old_timer
.it_interval
.tv_sec
),
478 scm_long2num(old_timer
.it_interval
.tv_usec
)),
479 scm_cons(scm_long2num(old_timer
.it_value
.tv_sec
),
480 scm_long2num(old_timer
.it_value
.tv_usec
)));
483 #endif /* HAVE_GETITIMER */
486 SCM_DEFINE (scm_pause
, "pause", 0, 0, 0,
488 "Pause the current process (thread?) until a signal arrives whose\n"
489 "action is to either terminate the current process or invoke a\n"
490 "handler procedure. The return value is unspecified.")
491 #define FUNC_NAME s_scm_pause
494 return SCM_UNSPECIFIED
;
499 SCM_DEFINE (scm_sleep
, "sleep", 1, 0, 0,
501 "Wait for the given number of seconds (an integer) or until a signal\n"
502 "arrives. The return value is zero if the time elapses or the number\n"
503 "of seconds remaining otherwise.")
504 #define FUNC_NAME s_scm_sleep
507 SCM_VALIDATE_INUM_MIN (1, i
,0);
509 j
= scm_thread_sleep (SCM_INUM(i
));
511 j
= sleep (SCM_INUM(i
));
513 return scm_ulong2num (j
);
517 #if defined(USE_THREADS) || defined(HAVE_USLEEP) || defined(__MINGW32__)
518 SCM_DEFINE (scm_usleep
, "usleep", 1, 0, 0,
520 "Sleep for I microseconds. @code{usleep} is not available on\n"
522 #define FUNC_NAME s_scm_usleep
524 SCM_VALIDATE_INUM_MIN (1, i
,0);
527 /* If we have threads, we use the thread system's sleep function. */
529 unsigned long j
= scm_thread_usleep (SCM_INUM (i
));
530 return scm_ulong2num (j
);
533 #ifdef USLEEP_RETURNS_VOID
534 usleep (SCM_INUM (i
));
538 int j
= usleep (SCM_INUM (i
));
539 return SCM_MAKINUM (j
);
545 #endif /* USE_THREADS || HAVE_USLEEP || __MINGW32__ */
547 SCM_DEFINE (scm_raise
, "raise", 1, 0, 0,
549 "Sends a specified signal @var{sig} to the current process, where\n"
550 "@var{sig} is as described for the kill procedure.")
551 #define FUNC_NAME s_scm_raise
553 SCM_VALIDATE_INUM (1, sig
);
555 if (kill (getpid (), (int) SCM_INUM (sig
)) != 0)
558 return SCM_UNSPECIFIED
;
570 SCM_VARIABLE_LOC (scm_c_define ("signal-handlers",
571 scm_c_make_vector (NSIG
, SCM_BOOL_F
)));
572 signal_handler_cells
=
573 scm_permanent_object (scm_c_make_vector (NSIG
, SCM_BOOL_F
));
574 signal_handler_threads
=
575 scm_permanent_object (scm_c_make_vector (NSIG
, SCM_BOOL_F
));
577 for (i
= 0; i
< NSIG
; i
++)
579 #ifdef HAVE_SIGACTION
580 orig_handlers
[i
].sa_handler
= SIG_ERR
;
583 orig_handlers
[i
] = SIG_ERR
;
586 #ifdef HAVE_RESTARTABLE_SYSCALLS
587 /* If HAVE_RESTARTABLE_SYSCALLS is defined, it's important that
588 signals really are restartable. don't rely on the same
589 run-time that configure got: reset the default for every signal.
591 #ifdef HAVE_SIGINTERRUPT
593 #elif defined(SA_RESTART)
595 struct sigaction action
;
597 sigaction (i
, NULL
, &action
);
598 if (!(action
.sa_flags
& SA_RESTART
))
600 action
.sa_flags
|= SA_RESTART
;
601 sigaction (i
, &action
, NULL
);
605 /* if neither siginterrupt nor SA_RESTART are available we may
606 as well assume that signals are always restartable. */
610 scm_c_define ("NSIG", scm_long2num (NSIG
));
611 scm_c_define ("SIG_IGN", scm_long2num ((long) SIG_IGN
));
612 scm_c_define ("SIG_DFL", scm_long2num ((long) SIG_DFL
));
614 scm_c_define ("SA_NOCLDSTOP", scm_long2num (SA_NOCLDSTOP
));
617 scm_c_define ("SA_RESTART", scm_long2num (SA_RESTART
));
620 #if defined(HAVE_SETITIMER) || defined(HAVE_GETITIMER)
621 /* Stuff needed by setitimer and getitimer. */
622 scm_c_define ("ITIMER_REAL", SCM_MAKINUM (ITIMER_REAL
));
623 scm_c_define ("ITIMER_VIRTUAL", SCM_MAKINUM (ITIMER_VIRTUAL
));
624 scm_c_define ("ITIMER_PROF", SCM_MAKINUM (ITIMER_PROF
));
625 #endif /* defined(HAVE_SETITIMER) || defined(HAVE_GETITIMER) */
627 #include "libguile/scmsigs.x"