5 /* Copyright (C) 1995, 1996, 1998, 1999, 2000 Free Software Foundation, Inc.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2, or (at your option)
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this software; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20 * Boston, MA 02111-1307 USA
22 * As a special exception, the Free Software Foundation gives permission
23 * for additional uses of the text contained in its release of GUILE.
25 * The exception is that, if you link the GUILE library with other files
26 * to produce an executable, this does not by itself cause the
27 * resulting executable to be covered by the GNU General Public License.
28 * Your use of that executable is in no way restricted on account of
29 * linking the GUILE library code into it.
31 * This exception does not however invalidate any other reasons why
32 * the executable file might be covered by the GNU General Public License.
34 * This exception applies only to the code released by the
35 * Free Software Foundation under the name GUILE. If you copy
36 * code from other Free Software Foundation releases into a copy of
37 * GUILE, as the General Public License permits, the exception does
38 * not apply to the code that you add in this way. To avoid misleading
39 * anyone as to the status of such modified files, you must delete
40 * this exception notice from them.
42 * If you write modifications of your own for GUILE, it is your choice
43 * whether to permit this exception to apply to your modifications.
44 * If you do not wish that, delete this exception notice. */
47 /* "What's the difference between _scm.h and __scm.h?"
49 _scm.h is not installed; it's only visible to the libguile sources
52 __scm.h is installed, and is #included by <libguile.h>. If both
53 the client and libguile need some piece of information, and it
54 doesn't fit well into the header file for any particular module, it
55 should go in __scm.h. */
58 /* {Supported Options}
60 * These may be defined or undefined.
63 /* Old async mechanism */
64 /* #define GUILE_OLD_ASYNC_CLICK */
66 /* #define GUILE_DEBUG_FREELIST */
68 /* If the compile FLAG `SCM_CAUTIOUS' is #defined then the number of
69 * arguments is always checked for application of closures. If the
70 * compile FLAG `SCM_RECKLESS' is #defined then they are not checked.
71 * Otherwise, number of argument checks for closures are made only when
72 * the function position (whose value is the closure) of a combination is
73 * not an ILOC or GLOC. When the function position of a combination is a
74 * symbol it will be checked only the first time it is evaluated because
75 * it will then be replaced with an ILOC or GLOC.
80 /* After looking up a local for the first time, rewrite the
81 * code graph, caching its position.
83 #define MEMOIZE_LOCALS
85 /* All the number support there is.
89 /* GC should relinquish empty cons-pair arenas. */
90 /* cmm:FIXME look at this after done mangling the GC */
91 /* #define GC_FREE_SEGMENTS */
93 /* Provide a scheme-accessible count-down timer that
94 * generates a pseudo-interrupt.
99 /* Use engineering notation when converting numbers strings?
103 #undef SCM_CAREFUL_INTS
105 /* {Unsupported Options}
107 * These must be defined as given here.
113 /* Guile Scheme supports the #f/() distinction; Guile Lisp won't. We
114 have horrible plans for their unification. */
119 /* Random options (not yet supported or in final form). */
121 #define STACK_CHECKING
122 #undef NO_CEVAL_STACK_CHECKING
126 /* What did the configure script discover about the outside world? */
127 #include "libguile/scmconfig.h"
131 /* {Debugging Options}
133 * These compile time options determine whether to include code that is only
134 * useful for debugging guile itself or C level extensions to guile. The
135 * common prefix for all option macros of this kind is "SCM_DEBUG_". It is
136 * guaranteed that a macro named SCM_DEBUG_XXX is defined to be either 0 or 1,
137 * i. e. there is no need to test for the undefined case. This allows to use
138 * these definitions comfortably in macro code, as in the following example:
139 * #define FOO do { if (SCM_DEBUG_XXX) bar(); else baz(); } while (0)
140 * Any sane compiler will remove the unused branch without any performance
141 * penalty for the resulting code.
143 * Note: Some SCM_DEBUG_XXX options are not settable at configure time.
144 * To change the value of such options you will have to edit this header
145 * file or give suitable options to make, like:
146 * make all CFLAGS="-DSCM_DEBUG_XXX=1 ..."
150 /* The value of SCM_DEBUG determines the default for most of the not yet
151 * defined debugging options. This allows, for example, to enable most of the
152 * debugging options by simply defining SCM_DEBUG as 1.
158 /* If SCM_DEBUG_CELL_ACCESSES is set to 1, cell accesses will perform
159 * exhaustive parameter checking: It will be verified that cell parameters
160 * actually point to a valid heap cell. Note: If this option is enabled,
161 * guile will run about ten times slower than normally.
163 #ifndef SCM_DEBUG_CELL_ACCESSES
164 #define SCM_DEBUG_CELL_ACCESSES SCM_DEBUG
167 /* If SCM_DEBUG_DEPRECATED is set to 1, deprecated code is not compiled. This
168 * can be used by developers to get rid of references to deprecated code.
170 #ifndef SCM_DEBUG_DEPRECATED
171 #define SCM_DEBUG_DEPRECATED SCM_DEBUG
174 /* If SCM_DEBUG_REST_ARGUMENT is set to 1, functions that take rest arguments
175 * will check whether the rest arguments are actually passed as a proper list.
176 * Otherwise, if SCM_DEBUG_REST_ARGUMENT is 0, functions that take rest
177 * arguments will take it for granted that these are passed as a proper list.
179 #ifndef SCM_DEBUG_REST_ARGUMENT
180 #define SCM_DEBUG_REST_ARGUMENT SCM_DEBUG
183 /* Use this for _compile time_ type checking only, since the compiled result
184 * will be quite inefficient. The right way to make use of this option is to
185 * do a 'make clean; make CFLAGS=-DSCM_DEBUG_TYPING_STRICTNESS=1', fix your
186 * errors, and then do 'make clean; make'.
188 #ifndef SCM_DEBUG_TYPING_STRICTNESS
189 #define SCM_DEBUG_TYPING_STRICTNESS 0
194 #ifdef HAVE_LONG_LONGS
196 /* Some auto-generated .h files contain unused prototypes
197 * that need these typedefs.
199 typedef long long long_long
;
200 typedef unsigned long long ulong_long
;
202 #endif /* HAVE_LONG_LONGS */
208 * SCM_CHAR_CODE_LIMIT == UCHAR_MAX + 1
209 * SCM_MOST_POSITIVE_FIXNUM (LONG_MAX>>2)
210 * SCM_MOST_NEGATIVE_FIXNUM == SCM_SRS((long)LONG_MIN, 2)
216 # define SCM_CHAR_CODE_LIMIT (UCHAR_MAX+1L)
218 # define SCM_CHAR_CODE_LIMIT 256L
219 # endif /* def UCHAR_MAX */
220 # define SCM_MOST_POSITIVE_FIXNUM (LONG_MAX>>2)
221 # ifdef _UNICOS /* Stupid cray bug */
222 # define SCM_MOST_NEGATIVE_FIXNUM ((long)LONG_MIN/4)
224 # define SCM_MOST_NEGATIVE_FIXNUM SCM_SRS((long)LONG_MIN, 2)
227 # define SCM_CHAR_CODE_LIMIT 256L
228 # define SCM_MOST_POSITIVE_FIXNUM ((long)((unsigned long)~0L>>3))
230 # define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM-1)
232 # define SCM_MOST_NEGATIVE_FIXNUM (-SCM_MOST_POSITIVE_FIXNUM)
233 # endif /* (0 != ~0) */
234 #endif /* def HAVE_LIMITS_H */
241 # endif /* def AMIGA */
242 # define scm_sizet size_t
245 # define scm_sizet size_t
247 # define scm_sizet unsigned int
248 # endif /* def _SIZE_T */
249 #endif /* def STDC_HEADERS */
253 #include "libguile/tags.h"
257 # ifndef CHEAP_CONTINUATIONS
258 typedef int jmp_buf[17];
259 extern int setjump(jmp_buf env
);
260 extern int longjump(jmp_buf env
, int ret
);
261 # define setjmp setjump
262 # define longjmp longjump
268 typedef int jmp_buf[112];
269 extern int setjump(jmp_buf env
);
270 extern int longjump(jmp_buf env
, int ret
);
271 # define setjmp setjump
272 # define longjmp longjump
273 # else /* ndef _CRAY1 */
275 # endif /* ndef _CRAY1 */
276 #endif /* ndef vms */
278 /* James Clark came up with this neat one instruction fix for
279 * continuations on the SPARC. It flushes the register windows so
280 * that all the state of the process is contained in the stack.
284 # define SCM_FLUSH_REGISTER_WINDOWS asm("ta 3")
286 # define SCM_FLUSH_REGISTER_WINDOWS /* empty */
289 /* If stack is not longword aligned then
292 /* #define SHORT_ALIGN */
304 typedef short SCM_STACKITEM
;
306 typedef long SCM_STACKITEM
;
311 #define SCM_THREAD_DEFER
312 #define SCM_THREAD_ALLOW
313 #define SCM_THREAD_REDEFER
314 #define SCM_THREAD_SWITCHING_CODE
317 #ifdef GUILE_OLD_ASYNC_CLICK
318 extern unsigned int scm_async_clock
;
320 #define SCM_ASYNC_TICK \
322 if (0 == --scm_async_clock) \
323 scm_async_click (); \
326 extern int scm_asyncs_pending_p
;
328 #define SCM_ASYNC_TICK /*fixme* should change names */ \
330 if (scm_asyncs_pending_p) \
331 scm_async_click (); \
335 #ifdef SCM_CAREFUL_INTS
336 #define SCM_CHECK_NOT_DISABLED \
337 if (scm_ints_disabled) \
338 fputs("ints already disabled\n", stderr); \
340 #define SCM_CHECK_NOT_ENABLED \
341 if (!scm_ints_disabled) \
342 fputs("ints already enabled\n", stderr); \
345 #define SCM_CHECK_NOT_DISABLED
346 #define SCM_CHECK_NOT_ENABLED
350 /* Anthony Green writes:
351 When the compiler sees...
355 ...it doesn't actually promise to keep the critical code within the
356 boundries of the DEFER/ALLOW_INTS instructions. It may very well
357 schedule it outside of the magic defined in those macros.
359 However, GCC's volatile asm feature forms a barrier over which code is
360 never moved. So if you add...
362 ...to each of the DEFER_INTS and ALLOW_INTS macros, the critical
363 code will always remain in place. asm's without inputs or outputs
364 are implicitly volatile. */
366 #define SCM_FENCE asm /* volatile */ ("")
371 #define SCM_DEFER_INTS \
374 SCM_CHECK_NOT_DISABLED; \
377 scm_ints_disabled = 1; \
382 #define SCM_ALLOW_INTS_ONLY \
385 scm_ints_disabled = 0; \
389 #define SCM_ALLOW_INTS \
392 SCM_CHECK_NOT_ENABLED; \
393 SCM_THREAD_SWITCHING_CODE; \
395 scm_ints_disabled = 0; \
402 #define SCM_REDEFER_INTS \
405 SCM_THREAD_REDEFER; \
406 ++scm_ints_disabled; \
411 #define SCM_REALLOW_INTS \
414 SCM_THREAD_SWITCHING_CODE; \
416 --scm_ints_disabled; \
430 /* Classification of critical sections
432 * When Guile moves to POSIX threads, it won't be possible to prevent
433 * context switching. In fact, the whole idea of context switching is
434 * bogus if threads are run by different processors. Therefore, we
435 * must ultimately eliminate all critical sections or enforce them by
438 * All instances of SCM_DEFER_INTS and SCM_ALLOW_INTS should therefore
439 * be classified and replaced by one of the delimiters below. If you
440 * understand what this is all about, I'd like to encourage you to
441 * help with this task. The set of classes below must of course be
442 * incrementally augmented.
444 * MDJ 980419 <djurfeldt@nada.kth.se>
449 * Allocation of a cell with type tag in the CAR.
451 * With POSIX threads, each thread will have a private pool of free
452 * cells. Therefore, this type of section can be removed. But! It
453 * is important that the CDR is initialized first (with the CAR still
454 * indicating a free cell) so that we can guarantee a consistent heap
458 #ifdef SCM_POSIX_THREADS
459 #define SCM_ENTER_A_SECTION
460 #define SCM_EXIT_A_SECTION
462 #define SCM_ENTER_A_SECTION SCM_DEFER_INTS
463 #define SCM_EXIT_A_SECTION SCM_ALLOW_INTS
474 #define SCM_ASSERT(_cond, _arg, _pos, _subr)
475 #define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr)
476 #define SCM_ASRTGO(_cond, _label)
478 #define SCM_ASSERT(_cond, _arg, _pos, _subr) \
480 scm_wta(_arg, (char *)(_pos), _subr)
481 #define SCM_ASSERT_TYPE(_cond, _arg, _pos, _subr, _msg) \
483 scm_wrong_type_arg_msg(_subr, _pos, _arg, _msg)
484 #define SCM_ASRTGO(_cond, _label) \
493 /* Dirk:FIXME:: In all of the SCM_WTA_DISPATCH_* macros it is assumed that
494 * 'gf' is zero if uninitialized. It would be cleaner if some valid SCM value
495 * like SCM_BOOL_F or SCM_UNDEFINED was chosen.
498 extern SCM
scm_call_generic_0 (SCM gf
);
500 #define SCM_WTA_DISPATCH_0(gf, arg, pos, subr) \
501 return (SCM_UNPACK (gf) \
502 ? scm_call_generic_0 ((gf)) \
503 : scm_wta ((arg), (char *) (pos), (subr)))
504 #define SCM_GASSERT0(cond, gf, arg, pos, subr) \
505 if (!(cond)) SCM_WTA_DISPATCH_0((gf), (arg), (pos), (subr))
507 extern SCM
scm_call_generic_1 (SCM gf
, SCM a1
);
509 #define SCM_WTA_DISPATCH_1(gf, a1, pos, subr) \
510 return (SCM_UNPACK (gf) \
511 ? scm_call_generic_1 ((gf), (a1)) \
512 : scm_wta ((a1), (char *) (pos), (subr)))
513 #define SCM_GASSERT1(cond, gf, a1, pos, subr) \
514 if (!(cond)) SCM_WTA_DISPATCH_1((gf), (a1), (pos), (subr))
516 extern SCM
scm_call_generic_2 (SCM gf
, SCM a1
, SCM a2
);
518 #define SCM_WTA_DISPATCH_2(gf, a1, a2, pos, subr) \
519 return (SCM_UNPACK (gf) \
520 ? scm_call_generic_2 ((gf), (a1), (a2)) \
521 : scm_wta ((pos) == SCM_ARG1 ? (a1) : (a2), (char *) (pos), (subr)))
522 #define SCM_GASSERT2(cond, gf, a1, a2, pos, subr) \
523 if (!(cond)) SCM_WTA_DISPATCH_2((gf), (a1), (a2), (pos), (subr))
525 extern SCM
scm_apply_generic (SCM gf
, SCM args
);
527 #define SCM_WTA_DISPATCH_n(gf, args, pos, subr) \
528 return (SCM_UNPACK (gf) \
529 ? scm_apply_generic ((gf), (args)) \
530 : scm_wta (scm_list_ref ((args), SCM_MAKINUM ((pos) - 1)), \
533 #define SCM_GASSERTn(cond, gf, args, pos, subr) \
534 if (!(cond)) SCM_WTA_DISPATCH_n((gf), (args), (pos), (subr))
536 #ifndef SCM_MAGIC_SNARFER
537 /* Let these macros pass through if
538 we are snarfing; thus we can tell the
539 difference between the use of an actual
540 number vs. the use of one of these macros --
541 actual numbers in SCM_VALIDATE_* and SCM_ASSERT
542 constructs must match the formal argument name,
543 but using SCM_ARG* avoids the test */
554 /* SCM_WNA must follow the last SCM_ARGn in sequence.
557 #define SCM_OUTOFRANGE 10
558 #define SCM_NALLOC 11
560 #endif /* SCM_MAGIC_SNARFER */
564 /* SCM_EXIT_SUCCESS is the default code to return from SCM if no errors
565 * were encountered. SCM_EXIT_FAILURE is the default code to return from
566 * SCM if errors were encountered. The return code can be explicitly
567 * specified in a SCM program with (scm_quit <n>).
570 #ifndef SCM_EXIT_SUCCESS
572 #define SCM_EXIT_SUCCESS 1
574 #define SCM_EXIT_SUCCESS 0
576 #endif /* ndef SCM_EXIT_SUCCESS */
577 #ifndef SCM_EXIT_FAILURE
579 #define SCM_EXIT_FAILURE 2
581 #define SCM_EXIT_FAILURE 1
583 #endif /* ndef SCM_EXIT_FAILURE */