1 /* Debugging extensions for Guile
2 * Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2006, 2008 Free Software Foundation
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
9 * This library 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 GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 #include "libguile/_scm.h"
25 #include "libguile/async.h"
26 #include "libguile/eval.h"
27 #include "libguile/list.h"
28 #include "libguile/stackchk.h"
29 #include "libguile/throw.h"
30 #include "libguile/macros.h"
31 #include "libguile/smob.h"
32 #include "libguile/procprop.h"
33 #include "libguile/srcprop.h"
34 #include "libguile/alist.h"
35 #include "libguile/continuations.h"
36 #include "libguile/strports.h"
37 #include "libguile/read.h"
38 #include "libguile/feature.h"
39 #include "libguile/dynwind.h"
40 #include "libguile/modules.h"
41 #include "libguile/ports.h"
42 #include "libguile/root.h"
43 #include "libguile/fluids.h"
44 #include "libguile/objects.h"
46 #include "libguile/validate.h"
47 #include "libguile/debug.h"
49 #include "libguile/private-options.h"
53 /* {Run time control of the debugging evaluator}
56 SCM_DEFINE (scm_debug_options
, "debug-options-interface", 0, 1, 0,
58 "Option interface for the debug options. Instead of using\n"
59 "this procedure directly, use the procedures @code{debug-enable},\n"
60 "@code{debug-disable}, @code{debug-set!} and @code{debug-options}.")
61 #define FUNC_NAME s_scm_debug_options
65 scm_dynwind_begin (0);
66 scm_dynwind_critical_section (SCM_BOOL_F
);
68 ans
= scm_options (setting
, scm_debug_opts
, FUNC_NAME
);
69 if (!(1 <= SCM_N_FRAMES
&& SCM_N_FRAMES
<= SCM_MAX_FRAME_SIZE
))
71 scm_options (ans
, scm_debug_opts
, FUNC_NAME
);
72 SCM_OUT_OF_RANGE (1, setting
);
76 scm_stack_checking_enabled_p
= SCM_STACK_CHECKING_P
;
78 scm_debug_eframe_size
= 2 * SCM_N_FRAMES
;
87 with_traps_before (void *data
)
89 int *trap_flag
= data
;
90 *trap_flag
= SCM_TRAPS_P
;
95 with_traps_after (void *data
)
97 int *trap_flag
= data
;
98 SCM_TRAPS_P
= *trap_flag
;
102 with_traps_inner (void *data
)
104 SCM thunk
= SCM_PACK ((scm_t_bits
) data
);
105 return scm_call_0 (thunk
);
108 SCM_DEFINE (scm_with_traps
, "with-traps", 1, 0, 0,
110 "Call @var{thunk} with traps enabled.")
111 #define FUNC_NAME s_scm_with_traps
114 SCM_VALIDATE_THUNK (1, thunk
);
115 return scm_internal_dynamic_wind (with_traps_before
,
118 (void *) SCM_UNPACK (thunk
),
124 SCM_SYMBOL (scm_sym_procname
, "procname");
125 SCM_SYMBOL (scm_sym_dots
, "...");
126 SCM_SYMBOL (scm_sym_source
, "source");
131 scm_t_bits scm_tc16_memoized
;
134 memoized_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
136 int writingp
= SCM_WRITINGP (pstate
);
137 scm_puts ("#<memoized ", port
);
138 SCM_SET_WRITINGP (pstate
, 1);
139 scm_iprin1 (SCM_MEMOIZED_EXP (obj
), port
, pstate
);
140 SCM_SET_WRITINGP (pstate
, writingp
);
141 scm_putc ('>', port
);
145 SCM_DEFINE (scm_memoized_p
, "memoized?", 1, 0, 0,
147 "Return @code{#t} if @var{obj} is memoized.")
148 #define FUNC_NAME s_scm_memoized_p
150 return scm_from_bool(SCM_MEMOIZEDP (obj
));
155 scm_make_memoized (SCM exp
, SCM env
)
157 /* *fixme* Check that env is a valid environment. */
158 SCM_RETURN_NEWSMOB (scm_tc16_memoized
, SCM_UNPACK (scm_cons (exp
, env
)));
163 * Some primitives for construction of memoized code
165 * - procedure: memcons CAR CDR [ENV]
167 * Construct a pair, encapsulated in a memoized object.
169 * The CAR and CDR can be either normal or memoized. If ENV isn't
170 * specified, the top-level environment of the current module will
171 * be assumed. All environments must match.
173 * - procedure: make-iloc FRAME BINDING CDRP
175 * Return an iloc referring to frame no. FRAME, binding
176 * no. BINDING. If CDRP is non-#f, the iloc is referring to a
177 * frame consisting of a single pair, with the value stored in the
180 * - procedure: iloc? OBJECT
182 * Return #t if OBJECT is an iloc.
184 * - procedure: mem->proc MEMOIZED
186 * Construct a closure from the memoized lambda expression MEMOIZED
188 * WARNING! The code is not copied!
190 * - procedure: proc->mem CLOSURE
192 * Turn the closure CLOSURE into a memoized object.
194 * WARNING! The code is not copied!
196 * - constant: SCM_IM_AND
197 * - constant: SCM_IM_BEGIN
198 * - constant: SCM_IM_CASE
199 * - constant: SCM_IM_COND
200 * - constant: SCM_IM_DO
201 * - constant: SCM_IM_IF
202 * - constant: SCM_IM_LAMBDA
203 * - constant: SCM_IM_LET
204 * - constant: SCM_IM_LETSTAR
205 * - constant: SCM_IM_LETREC
206 * - constant: SCM_IM_OR
207 * - constant: SCM_IM_QUOTE
208 * - constant: SCM_IM_SET
209 * - constant: SCM_IM_DEFINE
210 * - constant: SCM_IM_APPLY
211 * - constant: SCM_IM_CONT
212 * - constant: SCM_IM_DISPATCH
215 #include "libguile/variable.h"
216 #include "libguile/procs.h"
218 SCM_DEFINE (scm_memcons
, "memcons", 2, 1, 0,
219 (SCM car
, SCM cdr
, SCM env
),
220 "Return a new memoized cons cell with @var{car} and @var{cdr}\n"
221 "as members and @var{env} as the environment.")
222 #define FUNC_NAME s_scm_memcons
224 if (SCM_MEMOIZEDP (car
))
226 /*fixme* environments may be two different but equal top-level envs */
227 if (!SCM_UNBNDP (env
) && SCM_MEMOIZED_ENV (car
) != env
)
228 SCM_MISC_ERROR ("environment mismatch arg1 <-> arg3",
229 scm_list_2 (car
, env
));
231 env
= SCM_MEMOIZED_ENV (car
);
232 car
= SCM_MEMOIZED_EXP (car
);
234 if (SCM_MEMOIZEDP (cdr
))
236 if (!SCM_UNBNDP (env
) && SCM_MEMOIZED_ENV (cdr
) != env
)
237 SCM_MISC_ERROR ("environment mismatch arg2 <-> arg3",
238 scm_list_2 (cdr
, env
));
240 env
= SCM_MEMOIZED_ENV (cdr
);
241 cdr
= SCM_MEMOIZED_EXP (cdr
);
243 if (SCM_UNBNDP (env
))
244 env
= scm_top_level_env (SCM_TOP_LEVEL_LOOKUP_CLOSURE
);
246 SCM_VALIDATE_NULLORCONS (3, env
);
247 return scm_make_memoized (scm_cons (car
, cdr
), env
);
251 SCM_DEFINE (scm_mem_to_proc
, "mem->proc", 1, 0, 0,
253 "Convert a memoized object (which must represent a body)\n"
255 #define FUNC_NAME s_scm_mem_to_proc
258 SCM_VALIDATE_MEMOIZED (1, obj
);
259 env
= SCM_MEMOIZED_ENV (obj
);
260 obj
= SCM_MEMOIZED_EXP (obj
);
261 return scm_closure (obj
, env
);
265 SCM_DEFINE (scm_proc_to_mem
, "proc->mem", 1, 0, 0,
267 "Convert a procedure to a memoized object.")
268 #define FUNC_NAME s_scm_proc_to_mem
270 SCM_VALIDATE_CLOSURE (1, obj
);
271 return scm_make_memoized (SCM_CODE (obj
), SCM_ENV (obj
));
275 #endif /* GUILE_DEBUG */
277 SCM_DEFINE (scm_i_unmemoize_expr
, "unmemoize-expr", 1, 0, 0,
279 "Unmemoize the memoized expression @var{m},")
280 #define FUNC_NAME s_scm_i_unmemoize_expr
282 SCM_VALIDATE_MEMOIZED (1, m
);
283 return scm_i_unmemocopy_expr (SCM_MEMOIZED_EXP (m
), SCM_MEMOIZED_ENV (m
));
287 SCM_DEFINE (scm_memoized_environment
, "memoized-environment", 1, 0, 0,
289 "Return the environment of the memoized expression @var{m}.")
290 #define FUNC_NAME s_scm_memoized_environment
292 SCM_VALIDATE_MEMOIZED (1, m
);
293 return SCM_MEMOIZED_ENV (m
);
297 SCM_DEFINE (scm_procedure_name
, "procedure-name", 1, 0, 0,
299 "Return the name of the procedure @var{proc}")
300 #define FUNC_NAME s_scm_procedure_name
302 SCM_VALIDATE_PROC (1, proc
);
303 switch (SCM_TYP7 (proc
)) {
305 return SCM_SNAME (proc
);
308 SCM name
= scm_procedure_property (proc
, scm_sym_name
);
310 /* Source property scm_sym_procname not implemented yet... */
311 SCM name
= scm_source_property (SCM_CAR (SCM_CLOSURE_BODY (proc
)), scm_sym_procname
);
312 if (scm_is_false (name
))
313 name
= scm_procedure_property (proc
, scm_sym_name
);
315 if (scm_is_false (name
) && SCM_CLOSUREP (proc
))
316 name
= scm_reverse_lookup (SCM_ENV (proc
), proc
);
323 SCM_DEFINE (scm_procedure_source
, "procedure-source", 1, 0, 0,
325 "Return the source of the procedure @var{proc}.")
326 #define FUNC_NAME s_scm_procedure_source
328 SCM_VALIDATE_NIM (1, proc
);
330 switch (SCM_TYP7 (proc
)) {
331 case scm_tcs_closures
:
333 const SCM formals
= SCM_CLOSURE_FORMALS (proc
);
334 const SCM body
= SCM_CLOSURE_BODY (proc
);
335 const SCM src
= scm_source_property (body
, scm_sym_copy
);
337 if (scm_is_true (src
))
339 return scm_cons2 (scm_sym_lambda
, formals
, src
);
343 const SCM env
= SCM_EXTEND_ENV (formals
, SCM_EOL
, SCM_ENV (proc
));
344 return scm_cons2 (scm_sym_lambda
,
345 scm_i_finite_list_copy (formals
),
346 scm_i_unmemocopy_body (body
, env
));
350 if (!SCM_I_OPERATORP (proc
))
354 if (!SCM_SMOB_DESCRIPTOR (proc
).apply
)
361 /* It would indeed be a nice thing if we supplied source even for
362 built in procedures! */
363 return scm_procedure_property (proc
, scm_sym_source
);
366 SCM src
= scm_procedure_property (proc
, scm_sym_source
);
367 if (scm_is_true (src
))
369 proc
= SCM_PROCEDURE (proc
);
375 SCM_WRONG_TYPE_ARG (1, proc
);
376 return SCM_BOOL_F
; /* not reached */
380 SCM_DEFINE (scm_procedure_environment
, "procedure-environment", 1, 0, 0,
382 "Return the environment of the procedure @var{proc}.")
383 #define FUNC_NAME s_scm_procedure_environment
385 SCM_VALIDATE_NIM (1, proc
);
386 switch (SCM_TYP7 (proc
)) {
387 case scm_tcs_closures
:
388 return SCM_ENV (proc
);
395 SCM_WRONG_TYPE_ARG (1, proc
);
403 /* Eval in a local environment. We would like to have the ability to
404 * evaluate in a specified local environment, but due to the
405 * memoization this isn't normally possible. We solve it by copying
406 * the code before evaluating. One solution would be to have eval.c
407 * generate yet another evaluator. They are not very big actually.
409 SCM_DEFINE (scm_local_eval
, "local-eval", 1, 1, 0,
411 "Evaluate @var{exp} in its environment. If @var{env} is supplied,\n"
412 "it is the environment in which to evaluate @var{exp}. Otherwise,\n"
413 "@var{exp} must be a memoized code object (in which case, its environment\n"
415 #define FUNC_NAME s_scm_local_eval
417 if (SCM_UNBNDP (env
))
419 SCM_VALIDATE_MEMOIZED (1, exp
);
420 return scm_i_eval_x (SCM_MEMOIZED_EXP (exp
), SCM_MEMOIZED_ENV (exp
));
422 return scm_i_eval (exp
, env
);
427 SCM_REGISTER_PROC (s_reverse_lookup
, "reverse-lookup", 2, 0, 0, scm_reverse_lookup
);
431 scm_reverse_lookup (SCM env
, SCM data
)
433 while (scm_is_pair (env
) && scm_is_pair (SCM_CAR (env
)))
435 SCM names
= SCM_CAAR (env
);
436 SCM values
= SCM_CDAR (env
);
437 while (scm_is_pair (names
))
439 if (scm_is_eq (SCM_CAR (values
), data
))
440 return SCM_CAR (names
);
441 names
= SCM_CDR (names
);
442 values
= SCM_CDR (values
);
444 if (!scm_is_null (names
) && scm_is_eq (values
, data
))
451 SCM_DEFINE (scm_sys_start_stack
, "%start-stack", 2, 0, 0,
453 "Call @var{thunk} on an evaluator stack tagged with @var{id}.")
454 #define FUNC_NAME s_scm_sys_start_stack
457 scm_t_debug_frame vframe
;
458 scm_t_debug_info vframe_vect_body
;
459 vframe
.prev
= scm_i_last_debug_frame ();
460 vframe
.status
= SCM_VOIDFRAME
;
461 vframe
.vect
= &vframe_vect_body
;
462 vframe
.vect
[0].id
= id
;
463 scm_i_set_last_debug_frame (&vframe
);
464 answer
= scm_call_0 (thunk
);
465 scm_i_set_last_debug_frame (vframe
.prev
);
472 * The debugging evaluator throws these on frame traps.
475 scm_t_bits scm_tc16_debugobj
;
478 debugobj_print (SCM obj
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
480 scm_puts ("#<debug-object ", port
);
481 scm_intprint ((long) SCM_DEBUGOBJ_FRAME (obj
), 16, port
);
482 scm_putc ('>', port
);
486 SCM_DEFINE (scm_debug_object_p
, "debug-object?", 1, 0, 0,
488 "Return @code{#t} if @var{obj} is a debug object.")
489 #define FUNC_NAME s_scm_debug_object_p
491 return scm_from_bool(SCM_DEBUGOBJP (obj
));
497 scm_make_debugobj (scm_t_debug_frame
*frame
)
499 return scm_cell (scm_tc16_debugobj
, (scm_t_bits
) frame
);
504 /* Undocumented debugging procedure */
506 SCM_DEFINE (scm_debug_hang
, "debug-hang", 0, 1, 0,
508 "Go into an endless loop, which can be only terminated with\n"
510 #define FUNC_NAME s_scm_debug_hang
514 return SCM_UNSPECIFIED
;
524 scm_init_opts (scm_debug_options
, scm_debug_opts
);
526 scm_tc16_memoized
= scm_make_smob_type ("memoized", 0);
527 scm_set_smob_mark (scm_tc16_memoized
, scm_markcdr
);
528 scm_set_smob_print (scm_tc16_memoized
, memoized_print
);
530 scm_tc16_debugobj
= scm_make_smob_type ("debug-object", 0);
531 scm_set_smob_print (scm_tc16_debugobj
, debugobj_print
);
534 scm_c_define ("SCM_IM_AND", SCM_IM_AND
);
535 scm_c_define ("SCM_IM_BEGIN", SCM_IM_BEGIN
);
536 scm_c_define ("SCM_IM_CASE", SCM_IM_CASE
);
537 scm_c_define ("SCM_IM_COND", SCM_IM_COND
);
538 scm_c_define ("SCM_IM_DO", SCM_IM_DO
);
539 scm_c_define ("SCM_IM_IF", SCM_IM_IF
);
540 scm_c_define ("SCM_IM_LAMBDA", SCM_IM_LAMBDA
);
541 scm_c_define ("SCM_IM_LET", SCM_IM_LET
);
542 scm_c_define ("SCM_IM_LETSTAR", SCM_IM_LETSTAR
);
543 scm_c_define ("SCM_IM_LETREC", SCM_IM_LETREC
);
544 scm_c_define ("SCM_IM_OR", SCM_IM_OR
);
545 scm_c_define ("SCM_IM_QUOTE", SCM_IM_QUOTE
);
546 scm_c_define ("SCM_IM_SET_X", SCM_IM_SET_X
);
547 scm_c_define ("SCM_IM_DEFINE", SCM_IM_DEFINE
);
548 scm_c_define ("SCM_IM_APPLY", SCM_IM_APPLY
);
549 scm_c_define ("SCM_IM_CONT", SCM_IM_CONT
);
550 scm_c_define ("SCM_IM_DISPATCH", SCM_IM_DISPATCH
);
552 scm_add_feature ("debug-extensions");
554 #include "libguile/debug.x"