1 /* Debugging extensions for Guile
2 * Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003 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 */
48 #include "libguile/_scm.h"
49 #include "libguile/eval.h"
50 #include "libguile/list.h"
51 #include "libguile/stackchk.h"
52 #include "libguile/throw.h"
53 #include "libguile/macros.h"
54 #include "libguile/smob.h"
55 #include "libguile/procprop.h"
56 #include "libguile/srcprop.h"
57 #include "libguile/alist.h"
58 #include "libguile/continuations.h"
59 #include "libguile/strports.h"
60 #include "libguile/read.h"
61 #include "libguile/feature.h"
62 #include "libguile/dynwind.h"
63 #include "libguile/modules.h"
64 #include "libguile/ports.h"
65 #include "libguile/root.h"
66 #include "libguile/fluids.h"
67 #include "libguile/objects.h"
69 #include "libguile/validate.h"
70 #include "libguile/debug.h"
73 /* {Run time control of the debugging evaluator}
76 SCM_DEFINE (scm_debug_options
, "debug-options-interface", 0, 1, 0,
78 "Option interface for the debug options. Instead of using\n"
79 "this procedure directly, use the procedures @code{debug-enable},\n"
80 "@code{debug-disable}, @code{debug-set!} and @code{debug-options}.")
81 #define FUNC_NAME s_scm_debug_options
85 ans
= scm_options (setting
, scm_debug_opts
, SCM_N_DEBUG_OPTIONS
, FUNC_NAME
);
86 if (!(1 <= SCM_N_FRAMES
&& SCM_N_FRAMES
<= SCM_MAX_FRAME_SIZE
))
88 scm_options (ans
, scm_debug_opts
, SCM_N_DEBUG_OPTIONS
, FUNC_NAME
);
89 SCM_OUT_OF_RANGE (1, setting
);
92 scm_stack_checking_enabled_p
= SCM_STACK_CHECKING_P
;
93 scm_debug_eframe_size
= 2 * SCM_N_FRAMES
;
100 with_traps_before (void *data
)
102 int *trap_flag
= data
;
103 *trap_flag
= SCM_TRAPS_P
;
108 with_traps_after (void *data
)
110 int *trap_flag
= data
;
111 SCM_TRAPS_P
= *trap_flag
;
115 with_traps_inner (void *data
)
117 SCM thunk
= SCM_PACK (data
);
118 return scm_call_0 (thunk
);
121 SCM_DEFINE (scm_with_traps
, "with-traps", 1, 0, 0,
123 "Call @var{thunk} with traps enabled.")
124 #define FUNC_NAME s_scm_with_traps
127 SCM_VALIDATE_THUNK (1, thunk
);
128 return scm_internal_dynamic_wind (with_traps_before
,
131 (void *) SCM_UNPACK (thunk
),
138 SCM_SYMBOL (scm_sym_procname
, "procname");
139 SCM_SYMBOL (scm_sym_dots
, "...");
140 SCM_SYMBOL (scm_sym_source
, "source");
145 scm_t_bits scm_tc16_memoized
;
148 memoized_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
150 int writingp
= SCM_WRITINGP (pstate
);
151 scm_puts ("#<memoized ", port
);
152 SCM_SET_WRITINGP (pstate
, 1);
154 scm_iprin1 (SCM_MEMOIZED_EXP (obj
), port
, pstate
);
156 scm_iprin1 (scm_unmemoize (obj
), port
, pstate
);
158 SCM_SET_WRITINGP (pstate
, writingp
);
159 scm_putc ('>', port
);
163 SCM_DEFINE (scm_memoized_p
, "memoized?", 1, 0, 0,
165 "Return @code{#t} if @var{obj} is memoized.")
166 #define FUNC_NAME s_scm_memoized_p
168 return SCM_BOOL(SCM_MEMOIZEDP (obj
));
173 scm_make_memoized (SCM exp
, SCM env
)
175 /* *fixme* Check that env is a valid environment. */
178 SCM_NEWSMOB (z
, SCM_UNPACK (exp
), SCM_UNPACK (env
));
179 SCM_NEWSMOB (ans
, scm_tc16_memoized
, SCM_UNPACK (z
));
186 * Some primitives for construction of memoized code
188 * - procedure: memcons CAR CDR [ENV]
190 * Construct a pair, encapsulated in a memoized object.
192 * The CAR and CDR can be either normal or memoized. If ENV isn't
193 * specified, the top-level environment of the current module will
194 * be assumed. All environments must match.
196 * - procedure: make-iloc FRAME BINDING CDRP
198 * Return an iloc referring to frame no. FRAME, binding
199 * no. BINDING. If CDRP is non-#f, the iloc is referring to a
200 * frame consisting of a single pair, with the value stored in the
203 * - procedure: iloc? OBJECT
205 * Return #t if OBJECT is an iloc.
207 * - procedure: mem->proc MEMOIZED
209 * Construct a closure from the memoized lambda expression MEMOIZED
211 * WARNING! The code is not copied!
213 * - procedure: proc->mem CLOSURE
215 * Turn the closure CLOSURE into a memoized object.
217 * WARNING! The code is not copied!
219 * - constant: SCM_IM_AND
220 * - constant: SCM_IM_BEGIN
221 * - constant: SCM_IM_CASE
222 * - constant: SCM_IM_COND
223 * - constant: SCM_IM_DO
224 * - constant: SCM_IM_IF
225 * - constant: SCM_IM_LAMBDA
226 * - constant: SCM_IM_LET
227 * - constant: SCM_IM_LETSTAR
228 * - constant: SCM_IM_LETREC
229 * - constant: SCM_IM_OR
230 * - constant: SCM_IM_QUOTE
231 * - constant: SCM_IM_SET
232 * - constant: SCM_IM_DEFINE
233 * - constant: SCM_IM_APPLY
234 * - constant: SCM_IM_CONT
235 * - constant: SCM_IM_DISPATCH
238 #include "libguile/variable.h"
239 #include "libguile/procs.h"
241 SCM_DEFINE (scm_make_iloc
, "make-iloc", 3, 0, 0,
242 (SCM frame
, SCM binding
, SCM cdrp
),
243 "Return a new iloc with frame offset @var{frame}, binding\n"
244 "offset @var{binding} and the cdr flag @var{cdrp}.")
245 #define FUNC_NAME s_scm_make_iloc
247 SCM_VALIDATE_INUM (1, frame
);
248 SCM_VALIDATE_INUM (2, binding
);
249 return SCM_MAKE_ILOC (SCM_INUM (frame
),
255 SCM_DEFINE (scm_iloc_p
, "iloc?", 1, 0, 0,
257 "Return @code{#t} if @var{obj} is an iloc.")
258 #define FUNC_NAME s_scm_iloc_p
260 return SCM_BOOL(SCM_ILOCP (obj
));
264 SCM_DEFINE (scm_memcons
, "memcons", 2, 1, 0,
265 (SCM car
, SCM cdr
, SCM env
),
266 "Return a new memoized cons cell with @var{car} and @var{cdr}\n"
267 "as members and @var{env} as the environment.")
268 #define FUNC_NAME s_scm_memcons
270 if (SCM_MEMOIZEDP (car
))
272 /*fixme* environments may be two different but equal top-level envs */
273 if (!SCM_UNBNDP (env
) && SCM_MEMOIZED_ENV (car
) != env
)
274 SCM_MISC_ERROR ("environment mismatch arg1 <-> arg3",
275 scm_list_2 (car
, env
));
277 env
= SCM_MEMOIZED_ENV (car
);
278 car
= SCM_MEMOIZED_EXP (car
);
280 if (SCM_MEMOIZEDP (cdr
))
282 if (!SCM_UNBNDP (env
) && SCM_MEMOIZED_ENV (cdr
) != env
)
283 SCM_MISC_ERROR ("environment mismatch arg2 <-> arg3",
284 scm_list_2 (cdr
, env
));
286 env
= SCM_MEMOIZED_ENV (cdr
);
287 cdr
= SCM_MEMOIZED_EXP (cdr
);
289 if (SCM_UNBNDP (env
))
290 env
= scm_top_level_env (SCM_TOP_LEVEL_LOOKUP_CLOSURE
);
292 SCM_VALIDATE_NULLORCONS (3, env
);
293 return scm_make_memoized (scm_cons (car
, cdr
), env
);
297 SCM_DEFINE (scm_mem_to_proc
, "mem->proc", 1, 0, 0,
299 "Convert a memoized object (which must be a lambda expression)\n"
301 #define FUNC_NAME s_scm_mem_to_proc
304 SCM_VALIDATE_MEMOIZED (1, obj
);
305 env
= SCM_MEMOIZED_ENV (obj
);
306 obj
= SCM_MEMOIZED_EXP (obj
);
307 if (!SCM_CONSP (obj
) || !SCM_EQ_P (SCM_CAR (obj
), SCM_IM_LAMBDA
))
308 SCM_MISC_ERROR ("expected lambda expression", scm_list_1 (obj
));
309 return scm_closure (SCM_CDR (obj
), env
);
313 SCM_DEFINE (scm_proc_to_mem
, "proc->mem", 1, 0, 0,
315 "Convert a procedure to a memoized object.")
316 #define FUNC_NAME s_scm_proc_to_mem
318 SCM_VALIDATE_CLOSURE (1, obj
);
319 return scm_make_memoized (scm_cons (SCM_IM_LAMBDA
, SCM_CODE (obj
)),
324 #endif /* GUILE_DEBUG */
326 SCM_DEFINE (scm_unmemoize
, "unmemoize", 1, 0, 0,
328 "Unmemoize the memoized expression @var{m},")
329 #define FUNC_NAME s_scm_unmemoize
331 SCM_VALIDATE_MEMOIZED (1, m
);
332 return scm_unmemocopy (SCM_MEMOIZED_EXP (m
), SCM_MEMOIZED_ENV (m
));
336 SCM_DEFINE (scm_memoized_environment
, "memoized-environment", 1, 0, 0,
338 "Return the environment of the memoized expression @var{m}.")
339 #define FUNC_NAME s_scm_memoized_environment
341 SCM_VALIDATE_MEMOIZED (1, m
);
342 return SCM_MEMOIZED_ENV (m
);
346 SCM_DEFINE (scm_procedure_name
, "procedure-name", 1, 0, 0,
348 "Return the name of the procedure @var{proc}")
349 #define FUNC_NAME s_scm_procedure_name
351 SCM_VALIDATE_PROC (1, proc
);
352 switch (SCM_TYP7 (proc
)) {
354 return SCM_SNAME (proc
);
357 SCM name
= scm_procedure_property (proc
, scm_sym_name
);
359 /* Source property scm_sym_procname not implemented yet... */
360 SCM name
= scm_source_property (SCM_CAR (SCM_CLOSURE_BODY (proc
)), scm_sym_procname
);
361 if (SCM_FALSEP (name
))
362 name
= scm_procedure_property (proc
, scm_sym_name
);
364 if (SCM_FALSEP (name
) && SCM_CLOSUREP (proc
))
365 name
= scm_reverse_lookup (SCM_ENV (proc
), proc
);
372 SCM_DEFINE (scm_procedure_source
, "procedure-source", 1, 0, 0,
374 "Return the source of the procedure @var{proc}.")
375 #define FUNC_NAME s_scm_procedure_source
377 SCM_VALIDATE_NIM (1, proc
);
379 switch (SCM_TYP7 (proc
)) {
380 case scm_tcs_closures
:
382 SCM formals
= SCM_CLOSURE_FORMALS (proc
);
383 SCM src
= scm_source_property (SCM_CLOSURE_BODY (proc
), scm_sym_copy
);
384 if (!SCM_FALSEP (src
))
385 return scm_cons2 (scm_sym_lambda
, formals
, src
);
386 return scm_cons (scm_sym_lambda
,
387 scm_unmemocopy (SCM_CODE (proc
),
388 SCM_EXTEND_ENV (formals
,
393 if (!SCM_I_OPERATORP (proc
))
397 if (!SCM_SMOB_DESCRIPTOR (proc
).apply
)
404 /* It would indeed be a nice thing if we supplied source even for
405 built in procedures! */
406 return scm_procedure_property (proc
, scm_sym_source
);
409 SCM src
= scm_procedure_property (proc
, scm_sym_source
);
410 if (!SCM_FALSEP (src
))
412 proc
= SCM_PROCEDURE (proc
);
418 SCM_WRONG_TYPE_ARG (1, proc
);
419 return SCM_BOOL_F
; /* not reached */
423 SCM_DEFINE (scm_procedure_environment
, "procedure-environment", 1, 0, 0,
425 "Return the environment of the procedure @var{proc}.")
426 #define FUNC_NAME s_scm_procedure_environment
428 SCM_VALIDATE_NIM (1, proc
);
429 switch (SCM_TYP7 (proc
)) {
430 case scm_tcs_closures
:
431 return SCM_ENV (proc
);
438 SCM_WRONG_TYPE_ARG (1, proc
);
446 /* Eval in a local environment. We would like to have the ability to
447 * evaluate in a specified local environment, but due to the
448 * memoization this isn't normally possible. We solve it by copying
449 * the code before evaluating. One solution would be to have eval.c
450 * generate yet another evaluator. They are not very big actually.
452 SCM_DEFINE (scm_local_eval
, "local-eval", 1, 1, 0,
454 "Evaluate @var{exp} in its environment. If @var{env} is supplied,\n"
455 "it is the environment in which to evaluate @var{exp}. Otherwise,\n"
456 "@var{exp} must be a memoized code object (in which case, its environment\n"
458 #define FUNC_NAME s_scm_local_eval
460 if (SCM_UNBNDP (env
))
462 SCM_VALIDATE_MEMOIZED (1, exp
);
463 return scm_i_eval_x (SCM_MEMOIZED_EXP (exp
), SCM_MEMOIZED_ENV (exp
));
465 return scm_i_eval (exp
, env
);
470 SCM_REGISTER_PROC (s_reverse_lookup
, "reverse-lookup", 2, 0, 0, scm_reverse_lookup
);
474 scm_reverse_lookup (SCM env
, SCM data
)
476 while (SCM_CONSP (env
) && SCM_CONSP (SCM_CAR (env
)))
478 SCM names
= SCM_CAAR (env
);
479 SCM values
= SCM_CDAR (env
);
480 while (SCM_CONSP (names
))
482 if (SCM_EQ_P (SCM_CAR (values
), data
))
483 return SCM_CAR (names
);
484 names
= SCM_CDR (names
);
485 values
= SCM_CDR (values
);
487 if (!SCM_NULLP (names
) && SCM_EQ_P (values
, data
))
495 scm_start_stack (SCM id
, SCM exp
, SCM env
)
498 scm_t_debug_frame vframe
;
499 scm_t_debug_info vframe_vect_body
;
500 vframe
.prev
= scm_last_debug_frame
;
501 vframe
.status
= SCM_VOIDFRAME
;
502 vframe
.vect
= &vframe_vect_body
;
503 vframe
.vect
[0].id
= id
;
504 scm_last_debug_frame
= &vframe
;
505 answer
= scm_i_eval (exp
, env
);
506 scm_last_debug_frame
= vframe
.prev
;
510 SCM_SYNTAX(s_start_stack
, "start-stack", scm_makacro
, scm_m_start_stack
);
513 scm_m_start_stack (SCM exp
, SCM env
)
514 #define FUNC_NAME s_start_stack
518 || !SCM_CONSP (SCM_CDR (exp
))
519 || !SCM_NULLP (SCM_CDDR (exp
)))
520 SCM_WRONG_NUM_ARGS ();
521 return scm_start_stack (scm_eval_car (exp
, env
), SCM_CADR (exp
), env
);
528 * The debugging evaluator throws these on frame traps.
531 scm_t_bits scm_tc16_debugobj
;
534 debugobj_print (SCM obj
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
536 scm_puts ("#<debug-object ", port
);
537 scm_intprint ((long) SCM_DEBUGOBJ_FRAME (obj
), 16, port
);
538 scm_putc ('>', port
);
542 SCM_DEFINE (scm_debug_object_p
, "debug-object?", 1, 0, 0,
544 "Return @code{#t} if @var{obj} is a debug object.")
545 #define FUNC_NAME s_scm_debug_object_p
547 return SCM_BOOL(SCM_DEBUGOBJP (obj
));
553 scm_make_debugobj (scm_t_debug_frame
*frame
)
555 return scm_cell (scm_tc16_debugobj
, (scm_t_bits
) frame
);
560 /* Undocumented debugging procedure */
562 SCM_DEFINE (scm_debug_hang
, "debug-hang", 0, 1, 0,
564 "Go into an endless loop, which can be only terminated with\n"
566 #define FUNC_NAME s_scm_debug_hang
570 return SCM_UNSPECIFIED
;
580 scm_init_opts (scm_debug_options
, scm_debug_opts
, SCM_N_DEBUG_OPTIONS
);
582 scm_tc16_memoized
= scm_make_smob_type ("memoized", 0);
583 scm_set_smob_mark (scm_tc16_memoized
, scm_markcdr
);
584 scm_set_smob_print (scm_tc16_memoized
, memoized_print
);
586 scm_tc16_debugobj
= scm_make_smob_type ("debug-object", 0);
587 scm_set_smob_print (scm_tc16_debugobj
, debugobj_print
);
590 scm_c_define ("SCM_IM_AND", SCM_IM_AND
);
591 scm_c_define ("SCM_IM_BEGIN", SCM_IM_BEGIN
);
592 scm_c_define ("SCM_IM_CASE", SCM_IM_CASE
);
593 scm_c_define ("SCM_IM_COND", SCM_IM_COND
);
594 scm_c_define ("SCM_IM_DO", SCM_IM_DO
);
595 scm_c_define ("SCM_IM_IF", SCM_IM_IF
);
596 scm_c_define ("SCM_IM_LAMBDA", SCM_IM_LAMBDA
);
597 scm_c_define ("SCM_IM_LET", SCM_IM_LET
);
598 scm_c_define ("SCM_IM_LETSTAR", SCM_IM_LETSTAR
);
599 scm_c_define ("SCM_IM_LETREC", SCM_IM_LETREC
);
600 scm_c_define ("SCM_IM_OR", SCM_IM_OR
);
601 scm_c_define ("SCM_IM_QUOTE", SCM_IM_QUOTE
);
602 scm_c_define ("SCM_IM_SET_X", SCM_IM_SET_X
);
603 scm_c_define ("SCM_IM_DEFINE", SCM_IM_DEFINE
);
604 scm_c_define ("SCM_IM_APPLY", SCM_IM_APPLY
);
605 scm_c_define ("SCM_IM_CONT", SCM_IM_CONT
);
606 scm_c_define ("SCM_IM_DISPATCH", SCM_IM_DISPATCH
);
608 scm_add_feature ("debug-extensions");
610 #include "libguile/debug.x"