/* Copyright (C) 1995,1996,1997,1998,2000,2001 Free Software Foundation, Inc. * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2, or (at your option) * any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this software; see the file COPYING. If not, write to * the Free Software Foundation, Inc., 59 Temple Place, Suite 330, * Boston, MA 02111-1307 USA * * As a special exception, the Free Software Foundation gives permission * for additional uses of the text contained in its release of GUILE. * * The exception is that, if you link the GUILE library with other files * to produce an executable, this does not by itself cause the * resulting executable to be covered by the GNU General Public License. * Your use of that executable is in no way restricted on account of * linking the GUILE library code into it. * * This exception does not however invalidate any other reasons why * the executable file might be covered by the GNU General Public License. * * This exception applies only to the code released by the * Free Software Foundation under the name GUILE. If you copy * code from other Free Software Foundation releases into a copy of * GUILE, as the General Public License permits, the exception does * not apply to the code that you add in this way. To avoid misleading * anyone as to the status of such modified files, you must delete * this exception notice from them. * * If you write modifications of your own for GUILE, it is your choice * whether to permit this exception to apply to your modifications. * If you do not wish that, delete this exception notice. */ #include #include "libguile/_scm.h" #include "libguile/eval.h" #include "libguile/throw.h" #include "libguile/root.h" #include "libguile/smob.h" #include "libguile/validate.h" #include "libguile/async.h" #ifdef HAVE_STRING_H #include #endif #ifdef HAVE_UNISTD_H #include #endif /* {Asynchronous Events} * * * Async == thunk + mark. * * Setting the mark guarantees future execution of the thunk. More * than one set may be satisfied by a single execution. * * scm_tick_clock decremented once per SCM_ALLOW_INTS. * Async execution triggered by SCM_ALLOW_INTS when scm_tick_clock drops to 0. * Async execution prevented by scm_mask_ints != 0. * * If the clock reaches 0 when scm_mask_ints != 0, then reset the clock * to 1. * * If the clock reaches 0 any other time, run marked asyncs. * * From a unix signal handler, mark a corresponding async and set the clock * to 1. Do SCM_REDEFER_INTS;/SCM_REALLOW_INTS so that if the signal handler is not * called in the dynamic scope of a critical section, it is excecuted immediately. * * Overall, closely timed signals of a particular sort may be combined. Pending signals * are delivered in a fixed priority order, regardless of arrival order. * */ /* True between SCM_DEFER_INTS and SCM_ALLOW_INTS, and * when the interpreter is not running at all. */ int scm_ints_disabled = 1; unsigned int scm_mask_ints = 1; #ifdef GUILE_OLD_ASYNC_CLICK unsigned int scm_async_clock = 20; static unsigned int scm_async_rate = 20; static unsigned int scm_tick_clock = 0; static unsigned int scm_tick_rate = 0; static unsigned int scm_desired_tick_rate = 0; static unsigned int scm_switch_clock = 0; static unsigned int scm_switch_rate = 0; static unsigned int scm_desired_switch_rate = 0; #else int scm_asyncs_pending_p = 0; #endif static scm_t_bits tc16_async; /* cmm: this has SCM_ prefix because SCM_MAKE_VALIDATE expects it. this is ugly. */ #define SCM_ASYNCP(X) SCM_TYP16_PREDICATE (tc16_async, X) #define VALIDATE_ASYNC(pos,a) SCM_MAKE_VALIDATE(pos, a, ASYNCP) #define ASYNC_GOT_IT(X) (SCM_CELL_WORD_0 (X) >> 16) #define SET_ASYNC_GOT_IT(X, V) (SCM_SET_CELL_WORD_0 ((X), SCM_TYP16 (X) | ((V) << 16))) #define ASYNC_THUNK(X) SCM_CELL_OBJECT_1 (X) #ifdef GUILE_OLD_ASYNC_CLICK int scm_asyncs_pending () { SCM pos; pos = scm_asyncs; while (!SCM_NULLP (pos)) { SCM a = SCM_CAR (pos); if (ASYNC_GOT_IT (a)) return 1; pos = SCM_CDR (pos); } return 0; } void scm_async_click () { int owe_switch; int owe_tick; if (!scm_switch_rate) { owe_switch = 0; scm_switch_clock = scm_switch_rate = scm_desired_switch_rate; scm_desired_switch_rate = 0; } else { owe_switch = (scm_async_rate >= scm_switch_clock); if (owe_switch) { if (scm_desired_switch_rate) { scm_switch_clock = scm_switch_rate = scm_desired_switch_rate; scm_desired_switch_rate = 0; } else scm_switch_clock = scm_switch_rate; } else { if (scm_desired_switch_rate) { scm_switch_clock = scm_switch_rate = scm_desired_switch_rate; scm_desired_switch_rate = 0; } else scm_switch_clock -= scm_async_rate; } } if (scm_mask_ints) { if (owe_switch) scm_switch (); scm_async_clock = 1; return;; } if (!scm_tick_rate) { unsigned int r; owe_tick = 0; r = scm_desired_tick_rate; if (r) { scm_desired_tick_rate = 0; scm_tick_rate = r; scm_tick_clock = r; } } else { owe_tick = (scm_async_rate >= scm_tick_clock); if (owe_tick) { scm_tick_clock = scm_tick_rate = scm_desired_tick_rate; scm_desired_tick_rate = 0; } else { if (scm_desired_tick_rate) { scm_tick_clock = scm_tick_rate = scm_desired_tick_rate; scm_desired_tick_rate = 0; } else scm_tick_clock -= scm_async_rate; } } SCM_DEFER_INTS; if (scm_tick_rate && scm_switch_rate) { scm_async_rate = min (scm_tick_clock, scm_switch_clock); scm_async_clock = scm_async_rate; } else if (scm_tick_rate) { scm_async_clock = scm_async_rate = scm_tick_clock; } else if (scm_switch_rate) { scm_async_clock = scm_async_rate = scm_switch_clock; } else scm_async_clock = scm_async_rate = 1 << 16; SCM_ALLOW_INTS_ONLY; tail: scm_run_asyncs (scm_asyncs); SCM_DEFER_INTS; if (scm_asyncs_pending ()) { SCM_ALLOW_INTS_ONLY; goto tail; } SCM_ALLOW_INTS; if (owe_switch) scm_switch (); } void scm_switch () { #if 0 /* Thread switching code should probably reside here, but the async switching code doesn't seem to work, so it's put in the SCM_DEFER_INTS macro instead. /mdj */ SCM_THREAD_SWITCHING_CODE; #endif } #else void scm_async_click () { if (!scm_mask_ints) do scm_run_asyncs (scm_asyncs); while (scm_asyncs_pending_p); } #endif static SCM async_mark (SCM obj) { return ASYNC_THUNK (obj); } SCM_DEFINE (scm_async, "async", 1, 0, 0, (SCM thunk), "Create a new async for the procedure @var{thunk}.") #define FUNC_NAME s_scm_async { SCM_RETURN_NEWSMOB (tc16_async, SCM_UNPACK (thunk)); } #undef FUNC_NAME SCM_DEFINE (scm_system_async, "system-async", 1, 0, 0, (SCM thunk), "Create a new async for the procedure @var{thunk}. Also\n" "add it to the system's list of active async objects.") #define FUNC_NAME s_scm_system_async { SCM it = scm_async (thunk); scm_asyncs = scm_cons (it, scm_asyncs); return it; } #undef FUNC_NAME SCM_DEFINE (scm_async_mark, "async-mark", 1, 0, 0, (SCM a), "Mark the async @var{a} for future execution.") #define FUNC_NAME s_scm_async_mark { VALIDATE_ASYNC (1, a); #ifdef GUILE_OLD_ASYNC_CLICK SET_ASYNC_GOT_IT (a, 1); #else SET_ASYNC_GOT_IT (a, scm_asyncs_pending_p = 1); #endif return SCM_UNSPECIFIED; } #undef FUNC_NAME SCM_DEFINE (scm_system_async_mark, "system-async-mark", 1, 0, 0, (SCM a), "Mark the async @var{a} for future execution.") #define FUNC_NAME s_scm_system_async_mark { VALIDATE_ASYNC (1, a); SCM_REDEFER_INTS; #ifdef GUILE_OLD_ASYNC_CLICK SET_ASYNC_GOT_IT (a, 1); scm_async_rate = 1 + scm_async_rate - scm_async_clock; scm_async_clock = 1; #else SET_ASYNC_GOT_IT (a, scm_asyncs_pending_p = 1); #endif SCM_REALLOW_INTS; return SCM_UNSPECIFIED; } #undef FUNC_NAME SCM_DEFINE (scm_run_asyncs, "run-asyncs", 1, 0, 0, (SCM list_of_a), "Execute all thunks from the asyncs of the list @var{list_of_a}.") #define FUNC_NAME s_scm_run_asyncs { #ifdef GUILE_OLD_ASYNC_CLICK if (scm_mask_ints) return SCM_BOOL_F; #else scm_asyncs_pending_p = 0; #endif while (! SCM_NULLP (list_of_a)) { SCM a; SCM_VALIDATE_CONS (1, list_of_a); a = SCM_CAR (list_of_a); VALIDATE_ASYNC (SCM_ARG1, a); scm_mask_ints = 1; if (ASYNC_GOT_IT (a)) { SET_ASYNC_GOT_IT (a, 0); scm_call_0 (ASYNC_THUNK (a)); } scm_mask_ints = 0; list_of_a = SCM_CDR (list_of_a); } return SCM_BOOL_T; } #undef FUNC_NAME SCM_DEFINE (scm_noop, "noop", 0, 0, 1, (SCM args), "Do nothing. When called without arguments, return @code{#f},\n" "otherwise return the first argument.") #define FUNC_NAME s_scm_noop { SCM_VALIDATE_REST_ARGUMENT (args); return (SCM_NULLP (args) ? SCM_BOOL_F : SCM_CAR (args)); } #undef FUNC_NAME #ifdef GUILE_OLD_ASYNC_CLICK SCM_DEFINE (scm_set_tick_rate, "set-tick-rate", 1, 0, 0, (SCM n), "Set the rate of async ticks to @var{n}. Return the old rate\n" "value.") #define FUNC_NAME s_scm_set_tick_rate { unsigned int old_n = scm_tick_rate; SCM_VALIDATE_INUM (1, n); scm_desired_tick_rate = SCM_INUM (n); scm_async_rate = 1 + scm_async_rate - scm_async_clock; scm_async_clock = 1; return SCM_MAKINUM (old_n); } #undef FUNC_NAME SCM_DEFINE (scm_set_switch_rate, "set-switch-rate", 1, 0, 0, (SCM n), "Set the async switch rate to @var{n}. Return the old value\n" "of the switch rate.") #define FUNC_NAME s_scm_set_switch_rate { unsigned int old_n = scm_switch_rate; SCM_VALIDATE_INUM (1, n); scm_desired_switch_rate = SCM_INUM (n); scm_async_rate = 1 + scm_async_rate - scm_async_clock; scm_async_clock = 1; return SCM_MAKINUM (old_n); } #undef FUNC_NAME #endif SCM_DEFINE (scm_unmask_signals, "unmask-signals", 0, 0, 0, (), "Unmask signals. The returned value is not specified.") #define FUNC_NAME s_scm_unmask_signals { scm_mask_ints = 0; return SCM_UNSPECIFIED; } #undef FUNC_NAME SCM_DEFINE (scm_mask_signals, "mask-signals", 0, 0, 0, (), "Mask signals. The returned value is not specified.") #define FUNC_NAME s_scm_mask_signals { scm_mask_ints = 1; return SCM_UNSPECIFIED; } #undef FUNC_NAME void scm_init_async () { scm_asyncs = SCM_EOL; tc16_async = scm_make_smob_type ("async", 0); scm_set_smob_mark (tc16_async, async_mark); #include "libguile/async.x" } /* Local Variables: c-file-style: "gnu" End: */