1 /* Debugging extensions for Guile
2 * Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000 Free Software Foundation
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2, or (at your option)
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this software; see the file COPYING. If not, write to
16 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307 USA
19 * As a special exception, the Free Software Foundation gives permission
20 * for additional uses of the text contained in its release of GUILE.
22 * The exception is that, if you link the GUILE library with other files
23 * to produce an executable, this does not by itself cause the
24 * resulting executable to be covered by the GNU General Public License.
25 * Your use of that executable is in no way restricted on account of
26 * linking the GUILE library code into it.
28 * This exception does not however invalidate any other reasons why
29 * the executable file might be covered by the GNU General Public License.
31 * This exception applies only to the code released by the
32 * Free Software Foundation under the name GUILE. If you copy
33 * code from other Free Software Foundation releases into a copy of
34 * GUILE, as the General Public License permits, the exception does
35 * not apply to the code that you add in this way. To avoid misleading
36 * anyone as to the status of such modified files, you must delete
37 * this exception notice from them.
39 * If you write modifications of your own for GUILE, it is your choice
40 * whether to permit this exception to apply to your modifications.
41 * If you do not wish that, delete this exception notice.
43 * The author can be reached at djurfeldt@nada.kth.se
44 * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN */
46 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
47 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
51 #include "libguile/_scm.h"
52 #include "libguile/eval.h"
53 #include "libguile/stackchk.h"
54 #include "libguile/throw.h"
55 #include "libguile/macros.h"
56 #include "libguile/smob.h"
57 #include "libguile/procprop.h"
58 #include "libguile/srcprop.h"
59 #include "libguile/alist.h"
60 #include "libguile/continuations.h"
61 #include "libguile/strports.h"
62 #include "libguile/read.h"
63 #include "libguile/feature.h"
64 #include "libguile/dynwind.h"
65 #include "libguile/modules.h"
66 #include "libguile/ports.h"
67 #include "libguile/root.h"
68 #include "libguile/fluids.h"
70 #include "libguile/validate.h"
71 #include "libguile/debug.h"
74 /* {Run time control of the debugging evaluator}
77 SCM_DEFINE (scm_debug_options
, "debug-options-interface", 0, 1, 0,
79 "Option interface for the debug options. Instead of using\n"
80 "this procedure directly, use the procedures @code{debug-enable},\n"
81 "@code{debug-disable}, @code{debug-set!} and @var{debug-options}.")
82 #define FUNC_NAME s_scm_debug_options
86 ans
= scm_options (setting
,
91 if (!(1 <= SCM_N_FRAMES
&& SCM_N_FRAMES
<= SCM_MAX_FRAME_SIZE
))
93 scm_options (ans
, scm_debug_opts
, SCM_N_DEBUG_OPTIONS
, FUNC_NAME
);
94 SCM_OUT_OF_RANGE (1, setting
);
98 scm_stack_checking_enabled_p
= SCM_STACK_CHECKING_P
;
99 scm_debug_eframe_size
= 2 * SCM_N_FRAMES
;
106 with_traps_before (void *data
)
108 int *trap_flag
= data
;
109 *trap_flag
= SCM_TRAPS_P
;
114 with_traps_after (void *data
)
116 int *trap_flag
= data
;
117 SCM_TRAPS_P
= *trap_flag
;
121 with_traps_inner (void *data
)
123 SCM thunk
= SCM_PACK (data
);
124 return scm_apply (thunk
, SCM_EOL
, SCM_EOL
);
127 SCM_DEFINE (scm_with_traps
, "with-traps", 1, 0, 0,
129 "Call @var{thunk} with traps enabled.")
130 #define FUNC_NAME s_scm_with_traps
133 SCM_VALIDATE_THUNK (1,thunk
);
134 return scm_internal_dynamic_wind (with_traps_before
,
137 (void *) SCM_UNPACK (thunk
),
144 SCM_SYMBOL (scm_sym_procname
, "procname");
145 SCM_SYMBOL (scm_sym_dots
, "...");
146 SCM_SYMBOL (scm_sym_source
, "source");
151 scm_bits_t scm_tc16_memoized
;
154 memoized_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
156 int writingp
= SCM_WRITINGP (pstate
);
157 scm_puts ("#<memoized ", port
);
158 SCM_SET_WRITINGP (pstate
, 1);
160 scm_iprin1 (SCM_MEMOIZED_EXP (obj
), port
, pstate
);
162 scm_iprin1 (scm_unmemoize (obj
), port
, pstate
);
164 SCM_SET_WRITINGP (pstate
, writingp
);
165 scm_putc ('>', port
);
169 SCM_DEFINE (scm_memoized_p
, "memoized?", 1, 0, 0,
171 "Return @code{#t} if @var{obj} is memoized.")
172 #define FUNC_NAME s_scm_memoized_p
174 return SCM_BOOL(SCM_MEMOIZEDP (obj
));
179 scm_make_memoized (SCM exp
, SCM env
)
181 /* *fixme* Check that env is a valid environment. */
184 SCM_NEWSMOB (z
, SCM_UNPACK (exp
), SCM_UNPACK (env
));
185 SCM_NEWSMOB (ans
, scm_tc16_memoized
, SCM_UNPACK (z
));
192 * Some primitives for construction of memoized code
194 * - procedure: memcons CAR CDR [ENV]
196 * Construct a pair, encapsulated in a memoized object.
198 * The CAR and CDR can be either normal or memoized. If ENV isn't
199 * specified, the top-level environment of the current module will
200 * be assumed. All environments must match.
202 * - procedure: make-gloc VARIABLE [ENV]
204 * Return a gloc, encapsulated in a memoized object.
206 * (Glocs can't exist in normal list structures, since they will
207 * be mistaken for structs.)
209 * - procedure: gloc? OBJECT
211 * Return #t if OBJECT is a memoized gloc.
213 * - procedure: make-iloc FRAME BINDING CDRP
215 * Return an iloc referring to frame no. FRAME, binding
216 * no. BINDING. If CDRP is non-#f, the iloc is referring to a
217 * frame consisting of a single pair, with the value stored in the
220 * - procedure: iloc? OBJECT
222 * Return #t if OBJECT is an iloc.
224 * - procedure: mem->proc MEMOIZED
226 * Construct a closure from the memoized lambda expression MEMOIZED
228 * WARNING! The code is not copied!
230 * - procedure: proc->mem CLOSURE
232 * Turn the closure CLOSURE into a memoized object.
234 * WARNING! The code is not copied!
236 * - constant: SCM_IM_AND
237 * - constant: SCM_IM_BEGIN
238 * - constant: SCM_IM_CASE
239 * - constant: SCM_IM_COND
240 * - constant: SCM_IM_DO
241 * - constant: SCM_IM_IF
242 * - constant: SCM_IM_LAMBDA
243 * - constant: SCM_IM_LET
244 * - constant: SCM_IM_LETSTAR
245 * - constant: SCM_IM_LETREC
246 * - constant: SCM_IM_OR
247 * - constant: SCM_IM_QUOTE
248 * - constant: SCM_IM_SET
249 * - constant: SCM_IM_DEFINE
250 * - constant: SCM_IM_APPLY
251 * - constant: SCM_IM_CONT
252 * - constant: SCM_IM_DISPATCH
255 #include "libguile/variable.h"
256 #include "libguile/procs.h"
258 SCM_DEFINE (scm_make_gloc
, "make-gloc", 1, 1, 0,
260 "Create a gloc for variable @var{var} in the environment\n"
262 #define FUNC_NAME s_scm_make_gloc
266 var
= scm_cons (SCM_BOOL_F
, var
);
269 SCM_VALIDATE_VARIABLE (1,var
);
270 if (SCM_UNBNDP (env
))
271 env
= scm_top_level_env (SCM_TOP_LEVEL_LOOKUP_CLOSURE
);
273 SCM_VALIDATE_NULLORCONS (2,env
);
274 return scm_make_memoized (SCM_VARVCELL (var
) + 1, env
);
278 SCM_DEFINE (scm_gloc_p
, "gloc?", 1, 0, 0,
280 "Return @code{#t} if @var{obj} is a gloc.")
281 #define FUNC_NAME s_scm_gloc_p
283 return SCM_BOOL((SCM_MEMOIZEDP (obj
)
284 && (SCM_UNPACK(SCM_MEMOIZED_EXP (obj
)) & 7) == 1));
288 SCM_DEFINE (scm_make_iloc
, "make-iloc", 3, 0, 0,
289 (SCM frame
, SCM binding
, SCM cdrp
),
290 "Return a new iloc with frame offset @var{frame}, binding\n"
291 "offset @var{binding} and the cdr flag @var{cdrp}.")
292 #define FUNC_NAME s_scm_make_iloc
294 SCM_VALIDATE_INUM (1,frame
);
295 SCM_VALIDATE_INUM (2,binding
);
297 + SCM_IFRINC
* SCM_INUM (frame
)
298 + (SCM_NFALSEP (cdrp
) ? SCM_ICDR
: 0)
299 + SCM_IDINC
* SCM_INUM (binding
));
303 SCM_DEFINE (scm_iloc_p
, "iloc?", 1, 0, 0,
305 "Return @code{#t} if @var{obj} is an iloc.")
306 #define FUNC_NAME s_scm_iloc_p
308 return SCM_BOOL(SCM_ILOCP (obj
));
312 SCM_DEFINE (scm_memcons
, "memcons", 2, 1, 0,
313 (SCM car
, SCM cdr
, SCM env
),
314 "Return a new memoized cons cell with @var{car} and @var{cdr}\n"
315 "as members and @var{env} as the environment.")
316 #define FUNC_NAME s_scm_memcons
318 if (SCM_MEMOIZEDP (car
))
320 /*fixme* environments may be two different but equal top-level envs */
321 if (!SCM_UNBNDP (env
) && SCM_MEMOIZED_ENV (car
) != env
)
322 SCM_MISC_ERROR ("environment mismatch arg1 <-> arg3",
323 scm_cons2 (car
, env
, SCM_EOL
));
325 env
= SCM_MEMOIZED_ENV (car
);
326 car
= SCM_MEMOIZED_EXP (car
);
328 if (SCM_MEMOIZEDP (cdr
))
330 if (!SCM_UNBNDP (env
) && SCM_MEMOIZED_ENV (cdr
) != env
)
331 SCM_MISC_ERROR ("environment mismatch arg2 <-> arg3",
332 scm_cons2 (cdr
, env
, SCM_EOL
));
334 env
= SCM_MEMOIZED_ENV (cdr
);
335 cdr
= SCM_MEMOIZED_EXP (cdr
);
337 if (SCM_UNBNDP (env
))
338 env
= scm_top_level_env (SCM_TOP_LEVEL_LOOKUP_CLOSURE
);
340 SCM_VALIDATE_NULLORCONS (3,env
);
341 return scm_make_memoized (scm_cons (car
, cdr
), env
);
345 SCM_DEFINE (scm_mem_to_proc
, "mem->proc", 1, 0, 0,
347 "Convert a memoized object (which must be a lambda expression)\n"
349 #define FUNC_NAME s_scm_mem_to_proc
352 SCM_VALIDATE_MEMOIZED (1,obj
);
353 env
= SCM_MEMOIZED_ENV (obj
);
354 obj
= SCM_MEMOIZED_EXP (obj
);
355 if (!(SCM_NIMP (obj
) && SCM_CAR (obj
) == SCM_IM_LAMBDA
))
356 SCM_MISC_ERROR ("expected lambda expression",
357 scm_cons (obj
, SCM_EOL
));
358 return scm_closure (SCM_CDR (obj
), env
);
362 SCM_DEFINE (scm_proc_to_mem
, "proc->mem", 1, 0, 0,
364 "Convert a procedure to a memoized object.")
365 #define FUNC_NAME s_scm_proc_to_mem
367 SCM_VALIDATE_CLOSURE (1, obj
);
368 return scm_make_memoized (scm_cons (SCM_IM_LAMBDA
, SCM_CODE (obj
)),
373 #endif /* GUILE_DEBUG */
375 SCM_DEFINE (scm_unmemoize
, "unmemoize", 1, 0, 0,
377 "Unmemoize the memoized expression @var{m},")
378 #define FUNC_NAME s_scm_unmemoize
380 SCM_VALIDATE_MEMOIZED (1,m
);
381 return scm_unmemocopy (SCM_MEMOIZED_EXP (m
), SCM_MEMOIZED_ENV (m
));
385 SCM_DEFINE (scm_memoized_environment
, "memoized-environment", 1, 0, 0,
387 "Return the environment of the memoized expression @var{m}.")
388 #define FUNC_NAME s_scm_memoized_environment
390 SCM_VALIDATE_MEMOIZED (1,m
);
391 return SCM_MEMOIZED_ENV (m
);
395 SCM_DEFINE (scm_procedure_name
, "procedure-name", 1, 0, 0,
397 "Return the name of the procedure @var{proc}")
398 #define FUNC_NAME s_scm_procedure_name
400 SCM_VALIDATE_PROC (1,proc
);
401 switch (SCM_TYP7 (proc
)) {
403 return SCM_SNAME (proc
);
406 SCM name
= scm_procedure_property (proc
, scm_sym_name
);
408 /* Source property scm_sym_procname not implemented yet... */
409 SCM name
= scm_source_property (SCM_CAR (SCM_CDR (SCM_CODE (proc
))), scm_sym_procname
);
410 if (SCM_FALSEP (name
))
411 name
= scm_procedure_property (proc
, scm_sym_name
);
413 if (SCM_FALSEP (name
) && SCM_CLOSUREP (proc
))
414 name
= scm_reverse_lookup (SCM_ENV (proc
), proc
);
421 SCM_DEFINE (scm_procedure_source
, "procedure-source", 1, 0, 0,
423 "Return the source of the procedure @var{proc}.")
424 #define FUNC_NAME s_scm_procedure_source
426 SCM_VALIDATE_NIM (1,proc
);
427 switch (SCM_TYP7 (proc
)) {
428 case scm_tcs_closures
:
431 src
= scm_source_property (SCM_CDR (SCM_CODE (proc
)), scm_sym_copy
);
432 if (! SCM_FALSEP (src
))
433 return scm_cons2 (scm_sym_lambda
, SCM_CAR (SCM_CODE (proc
)), src
);
434 src
= SCM_CODE (proc
);
435 return scm_cons (scm_sym_lambda
,
437 SCM_EXTEND_ENV (SCM_CAR (src
),
445 /* It would indeed be a nice thing if we supplied source even for
446 built in procedures! */
447 return scm_procedure_property (proc
, scm_sym_source
);
455 SCM_DEFINE (scm_procedure_environment
, "procedure-environment", 1, 0, 0,
457 "Return the environment of the procedure @var{proc}.")
458 #define FUNC_NAME s_scm_procedure_environment
460 SCM_VALIDATE_NIM (1,proc
);
461 switch (SCM_TYP7 (proc
)) {
462 case scm_tcs_closures
:
463 return SCM_ENV (proc
);
478 /* Eval in a local environment. We would like to have the ability to
479 * evaluate in a specified local environment, but due to the
480 * memoization this isn't normally possible. We solve it by copying
481 * the code before evaluating. One solution would be to have eval.c
482 * generate yet another evaluator. They are not very big actually.
484 SCM_DEFINE (scm_local_eval
, "local-eval", 1, 1, 0,
486 "Evaluate @var{exp} in its environment. If @var{env} is supplied,\n"
487 "it is the environment in which to evaluate @var{exp}. Otherwise,\n"
488 "@var{exp} must be a memoized code object (in which case, its environment\n"
490 #define FUNC_NAME s_scm_local_eval
492 if (SCM_UNBNDP (env
))
494 SCM_VALIDATE_MEMOIZED (1, exp
);
495 return scm_i_eval_x (SCM_MEMOIZED_EXP (exp
), SCM_MEMOIZED_ENV (exp
));
497 return scm_i_eval (exp
, env
);
502 SCM_REGISTER_PROC (s_reverse_lookup
, "reverse-lookup", 2, 0, 0, scm_reverse_lookup
);
506 scm_reverse_lookup (SCM env
, SCM data
)
509 while (SCM_NIMP (env
) && SCM_SLOPPY_CONSP (SCM_CAR (env
)))
511 names
= SCM_CAAR (env
);
512 values
= SCM_CDAR (env
);
513 while (SCM_CONSP (names
))
515 if (SCM_EQ_P (SCM_CAR (values
), data
))
516 return SCM_CAR (names
);
517 names
= SCM_CDR (names
);
518 values
= SCM_CDR (values
);
520 if (! SCM_NULLP (names
) && SCM_EQ_P (values
, data
))
528 scm_start_stack (SCM id
, SCM exp
, SCM env
)
531 scm_debug_frame vframe
;
532 scm_debug_info vframe_vect_body
;
533 vframe
.prev
= scm_last_debug_frame
;
534 vframe
.status
= SCM_VOIDFRAME
;
535 vframe
.vect
= &vframe_vect_body
;
536 vframe
.vect
[0].id
= id
;
537 scm_last_debug_frame
= &vframe
;
538 answer
= scm_i_eval (exp
, env
);
539 scm_last_debug_frame
= vframe
.prev
;
543 SCM_SYNTAX(s_start_stack
, "start-stack", scm_makacro
, scm_m_start_stack
);
546 scm_m_start_stack (SCM exp
, SCM env
)
549 SCM_ASSERT (SCM_ECONSP (exp
)
550 && SCM_ECONSP (SCM_CDR (exp
))
551 && SCM_NULLP (SCM_CDDR (exp
)),
555 return scm_start_stack (scm_eval_car (exp
, env
), SCM_CADR (exp
), env
);
560 * The debugging evaluator throws these on frame traps.
563 scm_bits_t scm_tc16_debugobj
;
566 debugobj_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
568 scm_puts ("#<debug-object ", port
);
569 scm_intprint ((int) SCM_DEBUGOBJ_FRAME (obj
), 16, port
);
570 scm_putc ('>', port
);
574 SCM_DEFINE (scm_debug_object_p
, "debug-object?", 1, 0, 0,
576 "Return @code{#t} if @var{obj} is a debug object.")
577 #define FUNC_NAME s_scm_debug_object_p
579 return SCM_BOOL(SCM_DEBUGOBJP (obj
));
585 scm_make_debugobj (scm_debug_frame
*frame
)
590 SCM_SET_DEBUGOBJ_FRAME (z
, frame
);
591 SCM_SET_CELL_TYPE (z
, scm_tc16_debugobj
);
598 /* Undocumented debugging procedure */
600 SCM_DEFINE (scm_debug_hang
, "debug-hang", 0, 1, 0,
602 "Go into an endless loop, which can be only terminated with\n"
604 #define FUNC_NAME s_scm_debug_hang
608 return SCM_UNSPECIFIED
;
618 scm_init_opts (scm_debug_options
, scm_debug_opts
, SCM_N_DEBUG_OPTIONS
);
620 scm_tc16_memoized
= scm_make_smob_type ("memoized", 0);
621 scm_set_smob_mark (scm_tc16_memoized
, scm_markcdr
);
622 scm_set_smob_print (scm_tc16_memoized
, memoized_print
);
624 scm_tc16_debugobj
= scm_make_smob_type ("debug-object", 0);
625 scm_set_smob_print (scm_tc16_debugobj
, debugobj_print
);
628 scm_sysintern ("SCM_IM_AND", SCM_IM_AND
);
629 scm_sysintern ("SCM_IM_BEGIN", SCM_IM_BEGIN
);
630 scm_sysintern ("SCM_IM_CASE", SCM_IM_CASE
);
631 scm_sysintern ("SCM_IM_COND", SCM_IM_COND
);
632 scm_sysintern ("SCM_IM_DO", SCM_IM_DO
);
633 scm_sysintern ("SCM_IM_IF", SCM_IM_IF
);
634 scm_sysintern ("SCM_IM_LAMBDA", SCM_IM_LAMBDA
);
635 scm_sysintern ("SCM_IM_LET", SCM_IM_LET
);
636 scm_sysintern ("SCM_IM_LETSTAR", SCM_IM_LETSTAR
);
637 scm_sysintern ("SCM_IM_LETREC", SCM_IM_LETREC
);
638 scm_sysintern ("SCM_IM_OR", SCM_IM_OR
);
639 scm_sysintern ("SCM_IM_QUOTE", SCM_IM_QUOTE
);
640 scm_sysintern ("SCM_IM_SET_X", SCM_IM_SET_X
);
641 scm_sysintern ("SCM_IM_DEFINE", SCM_IM_DEFINE
);
642 scm_sysintern ("SCM_IM_APPLY", SCM_IM_APPLY
);
643 scm_sysintern ("SCM_IM_CONT", SCM_IM_CONT
);
644 scm_sysintern ("SCM_IM_DISPATCH", SCM_IM_DISPATCH
);
646 scm_add_feature ("debug-extensions");
648 #ifndef SCM_MAGIC_SNARFER
649 #include "libguile/debug.x"