1 /* Debugging extensions for Guile
2 * Copyright (C) 1995,1996,1997,1998,1999,2000,2001 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"
68 #include "libguile/validate.h"
69 #include "libguile/debug.h"
72 /* {Run time control of the debugging evaluator}
75 SCM_DEFINE (scm_debug_options
, "debug-options-interface", 0, 1, 0,
77 "Option interface for the debug options. Instead of using\n"
78 "this procedure directly, use the procedures @code{debug-enable},\n"
79 "@code{debug-disable}, @code{debug-set!} and @var{debug-options}.")
80 #define FUNC_NAME s_scm_debug_options
84 ans
= scm_options (setting
,
89 if (!(1 <= SCM_N_FRAMES
&& SCM_N_FRAMES
<= SCM_MAX_FRAME_SIZE
))
91 scm_options (ans
, scm_debug_opts
, SCM_N_DEBUG_OPTIONS
, FUNC_NAME
);
92 SCM_OUT_OF_RANGE (1, setting
);
96 scm_stack_checking_enabled_p
= SCM_STACK_CHECKING_P
;
97 scm_debug_eframe_size
= 2 * SCM_N_FRAMES
;
104 with_traps_before (void *data
)
106 int *trap_flag
= data
;
107 *trap_flag
= SCM_TRAPS_P
;
112 with_traps_after (void *data
)
114 int *trap_flag
= data
;
115 SCM_TRAPS_P
= *trap_flag
;
119 with_traps_inner (void *data
)
121 SCM thunk
= SCM_PACK (data
);
122 return scm_call_0 (thunk
);
125 SCM_DEFINE (scm_with_traps
, "with-traps", 1, 0, 0,
127 "Call @var{thunk} with traps enabled.")
128 #define FUNC_NAME s_scm_with_traps
131 SCM_VALIDATE_THUNK (1,thunk
);
132 return scm_internal_dynamic_wind (with_traps_before
,
135 (void *) SCM_UNPACK (thunk
),
142 SCM_SYMBOL (scm_sym_procname
, "procname");
143 SCM_SYMBOL (scm_sym_dots
, "...");
144 SCM_SYMBOL (scm_sym_source
, "source");
149 scm_t_bits scm_tc16_memoized
;
152 memoized_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
154 int writingp
= SCM_WRITINGP (pstate
);
155 scm_puts ("#<memoized ", port
);
156 SCM_SET_WRITINGP (pstate
, 1);
158 scm_iprin1 (SCM_MEMOIZED_EXP (obj
), port
, pstate
);
160 scm_iprin1 (scm_unmemoize (obj
), port
, pstate
);
162 SCM_SET_WRITINGP (pstate
, writingp
);
163 scm_putc ('>', port
);
167 SCM_DEFINE (scm_memoized_p
, "memoized?", 1, 0, 0,
169 "Return @code{#t} if @var{obj} is memoized.")
170 #define FUNC_NAME s_scm_memoized_p
172 return SCM_BOOL(SCM_MEMOIZEDP (obj
));
177 scm_make_memoized (SCM exp
, SCM env
)
179 /* *fixme* Check that env is a valid environment. */
182 SCM_NEWSMOB (z
, SCM_UNPACK (exp
), SCM_UNPACK (env
));
183 SCM_NEWSMOB (ans
, scm_tc16_memoized
, SCM_UNPACK (z
));
190 * Some primitives for construction of memoized code
192 * - procedure: memcons CAR CDR [ENV]
194 * Construct a pair, encapsulated in a memoized object.
196 * The CAR and CDR can be either normal or memoized. If ENV isn't
197 * specified, the top-level environment of the current module will
198 * be assumed. All environments must match.
200 * - procedure: make-iloc FRAME BINDING CDRP
202 * Return an iloc referring to frame no. FRAME, binding
203 * no. BINDING. If CDRP is non-#f, the iloc is referring to a
204 * frame consisting of a single pair, with the value stored in the
207 * - procedure: iloc? OBJECT
209 * Return #t if OBJECT is an iloc.
211 * - procedure: mem->proc MEMOIZED
213 * Construct a closure from the memoized lambda expression MEMOIZED
215 * WARNING! The code is not copied!
217 * - procedure: proc->mem CLOSURE
219 * Turn the closure CLOSURE into a memoized object.
221 * WARNING! The code is not copied!
223 * - constant: SCM_IM_AND
224 * - constant: SCM_IM_BEGIN
225 * - constant: SCM_IM_CASE
226 * - constant: SCM_IM_COND
227 * - constant: SCM_IM_DO
228 * - constant: SCM_IM_IF
229 * - constant: SCM_IM_LAMBDA
230 * - constant: SCM_IM_LET
231 * - constant: SCM_IM_LETSTAR
232 * - constant: SCM_IM_LETREC
233 * - constant: SCM_IM_OR
234 * - constant: SCM_IM_QUOTE
235 * - constant: SCM_IM_SET
236 * - constant: SCM_IM_DEFINE
237 * - constant: SCM_IM_APPLY
238 * - constant: SCM_IM_CONT
239 * - constant: SCM_IM_DISPATCH
242 #include "libguile/variable.h"
243 #include "libguile/procs.h"
245 SCM_DEFINE (scm_make_iloc
, "make-iloc", 3, 0, 0,
246 (SCM frame
, SCM binding
, SCM cdrp
),
247 "Return a new iloc with frame offset @var{frame}, binding\n"
248 "offset @var{binding} and the cdr flag @var{cdrp}.")
249 #define FUNC_NAME s_scm_make_iloc
251 SCM_VALIDATE_INUM (1,frame
);
252 SCM_VALIDATE_INUM (2,binding
);
253 return SCM_PACK (SCM_UNPACK (SCM_ILOC00
)
254 + SCM_IFRINC
* SCM_INUM (frame
)
255 + (!SCM_FALSEP (cdrp
) ? SCM_ICDR
: 0)
256 + SCM_IDINC
* SCM_INUM (binding
));
260 SCM_DEFINE (scm_iloc_p
, "iloc?", 1, 0, 0,
262 "Return @code{#t} if @var{obj} is an iloc.")
263 #define FUNC_NAME s_scm_iloc_p
265 return SCM_BOOL(SCM_ILOCP (obj
));
269 SCM_DEFINE (scm_memcons
, "memcons", 2, 1, 0,
270 (SCM car
, SCM cdr
, SCM env
),
271 "Return a new memoized cons cell with @var{car} and @var{cdr}\n"
272 "as members and @var{env} as the environment.")
273 #define FUNC_NAME s_scm_memcons
275 if (SCM_MEMOIZEDP (car
))
277 /*fixme* environments may be two different but equal top-level envs */
278 if (!SCM_UNBNDP (env
) && SCM_MEMOIZED_ENV (car
) != env
)
279 SCM_MISC_ERROR ("environment mismatch arg1 <-> arg3",
280 scm_list_2 (car
, env
));
282 env
= SCM_MEMOIZED_ENV (car
);
283 car
= SCM_MEMOIZED_EXP (car
);
285 if (SCM_MEMOIZEDP (cdr
))
287 if (!SCM_UNBNDP (env
) && SCM_MEMOIZED_ENV (cdr
) != env
)
288 SCM_MISC_ERROR ("environment mismatch arg2 <-> arg3",
289 scm_list_2 (cdr
, env
));
291 env
= SCM_MEMOIZED_ENV (cdr
);
292 cdr
= SCM_MEMOIZED_EXP (cdr
);
294 if (SCM_UNBNDP (env
))
295 env
= scm_top_level_env (SCM_TOP_LEVEL_LOOKUP_CLOSURE
);
297 SCM_VALIDATE_NULLORCONS (3,env
);
298 return scm_make_memoized (scm_cons (car
, cdr
), env
);
302 SCM_DEFINE (scm_mem_to_proc
, "mem->proc", 1, 0, 0,
304 "Convert a memoized object (which must be a lambda expression)\n"
306 #define FUNC_NAME s_scm_mem_to_proc
309 SCM_VALIDATE_MEMOIZED (1,obj
);
310 env
= SCM_MEMOIZED_ENV (obj
);
311 obj
= SCM_MEMOIZED_EXP (obj
);
312 if (!SCM_CONSP (obj
) || !SCM_EQ_P (CAR (obj
), SCM_IM_LAMBDA
))
313 SCM_MISC_ERROR ("expected lambda expression", scm_list_1 (obj
));
314 return scm_closure (SCM_CDR (obj
), env
);
318 SCM_DEFINE (scm_proc_to_mem
, "proc->mem", 1, 0, 0,
320 "Convert a procedure to a memoized object.")
321 #define FUNC_NAME s_scm_proc_to_mem
323 SCM_VALIDATE_CLOSURE (1, obj
);
324 return scm_make_memoized (scm_cons (SCM_IM_LAMBDA
, SCM_CODE (obj
)),
329 #endif /* GUILE_DEBUG */
331 SCM_DEFINE (scm_unmemoize
, "unmemoize", 1, 0, 0,
333 "Unmemoize the memoized expression @var{m},")
334 #define FUNC_NAME s_scm_unmemoize
336 SCM_VALIDATE_MEMOIZED (1,m
);
337 return scm_unmemocopy (SCM_MEMOIZED_EXP (m
), SCM_MEMOIZED_ENV (m
));
341 SCM_DEFINE (scm_memoized_environment
, "memoized-environment", 1, 0, 0,
343 "Return the environment of the memoized expression @var{m}.")
344 #define FUNC_NAME s_scm_memoized_environment
346 SCM_VALIDATE_MEMOIZED (1,m
);
347 return SCM_MEMOIZED_ENV (m
);
351 SCM_DEFINE (scm_procedure_name
, "procedure-name", 1, 0, 0,
353 "Return the name of the procedure @var{proc}")
354 #define FUNC_NAME s_scm_procedure_name
356 SCM_VALIDATE_PROC (1,proc
);
357 switch (SCM_TYP7 (proc
)) {
359 return SCM_SNAME (proc
);
362 SCM name
= scm_procedure_property (proc
, scm_sym_name
);
364 /* Source property scm_sym_procname not implemented yet... */
365 SCM name
= scm_source_property (SCM_CADR (SCM_CODE (proc
)), scm_sym_procname
);
366 if (SCM_FALSEP (name
))
367 name
= scm_procedure_property (proc
, scm_sym_name
);
369 if (SCM_FALSEP (name
) && SCM_CLOSUREP (proc
))
370 name
= scm_reverse_lookup (SCM_ENV (proc
), proc
);
377 SCM_DEFINE (scm_procedure_source
, "procedure-source", 1, 0, 0,
379 "Return the source of the procedure @var{proc}.")
380 #define FUNC_NAME s_scm_procedure_source
382 SCM_VALIDATE_NIM (1,proc
);
383 switch (SCM_TYP7 (proc
)) {
384 case scm_tcs_closures
:
386 SCM formals
= SCM_CLOSURE_FORMALS (proc
);
387 SCM src
= scm_source_property (SCM_CDR (SCM_CODE (proc
)), scm_sym_copy
);
388 if (!SCM_FALSEP (src
))
389 return scm_cons2 (scm_sym_lambda
, formals
, src
);
390 return scm_cons (scm_sym_lambda
,
391 scm_unmemocopy (SCM_CODE (proc
),
392 SCM_EXTEND_ENV (formals
,
400 /* It would indeed be a nice thing if we supplied source even for
401 built in procedures! */
402 return scm_procedure_property (proc
, scm_sym_source
);
404 SCM_WRONG_TYPE_ARG (1, proc
);
410 SCM_DEFINE (scm_procedure_environment
, "procedure-environment", 1, 0, 0,
412 "Return the environment of the procedure @var{proc}.")
413 #define FUNC_NAME s_scm_procedure_environment
415 SCM_VALIDATE_NIM (1,proc
);
416 switch (SCM_TYP7 (proc
)) {
417 case scm_tcs_closures
:
418 return SCM_ENV (proc
);
425 SCM_WRONG_TYPE_ARG (1, proc
);
433 /* Eval in a local environment. We would like to have the ability to
434 * evaluate in a specified local environment, but due to the
435 * memoization this isn't normally possible. We solve it by copying
436 * the code before evaluating. One solution would be to have eval.c
437 * generate yet another evaluator. They are not very big actually.
439 SCM_DEFINE (scm_local_eval
, "local-eval", 1, 1, 0,
441 "Evaluate @var{exp} in its environment. If @var{env} is supplied,\n"
442 "it is the environment in which to evaluate @var{exp}. Otherwise,\n"
443 "@var{exp} must be a memoized code object (in which case, its environment\n"
445 #define FUNC_NAME s_scm_local_eval
447 if (SCM_UNBNDP (env
))
449 SCM_VALIDATE_MEMOIZED (1, exp
);
450 return scm_i_eval_x (SCM_MEMOIZED_EXP (exp
), SCM_MEMOIZED_ENV (exp
));
452 return scm_i_eval (exp
, env
);
457 SCM_REGISTER_PROC (s_reverse_lookup
, "reverse-lookup", 2, 0, 0, scm_reverse_lookup
);
461 scm_reverse_lookup (SCM env
, SCM data
)
463 while (SCM_CONSP (env
) && SCM_CONSP (SCM_CAR (env
)))
465 SCM names
= SCM_CAAR (env
);
466 SCM values
= SCM_CDAR (env
);
467 while (SCM_CONSP (names
))
469 if (SCM_EQ_P (SCM_CAR (values
), data
))
470 return SCM_CAR (names
);
471 names
= SCM_CDR (names
);
472 values
= SCM_CDR (values
);
474 if (!SCM_NULLP (names
) && SCM_EQ_P (values
, data
))
482 scm_start_stack (SCM id
, SCM exp
, SCM env
)
485 scm_t_debug_frame vframe
;
486 scm_t_debug_info vframe_vect_body
;
487 vframe
.prev
= scm_last_debug_frame
;
488 vframe
.status
= SCM_VOIDFRAME
;
489 vframe
.vect
= &vframe_vect_body
;
490 vframe
.vect
[0].id
= id
;
491 scm_last_debug_frame
= &vframe
;
492 answer
= scm_i_eval (exp
, env
);
493 scm_last_debug_frame
= vframe
.prev
;
497 SCM_SYNTAX(s_start_stack
, "start-stack", scm_makacro
, scm_m_start_stack
);
500 scm_m_start_stack (SCM exp
, SCM env
)
501 #define FUNC_NAME s_start_stack
505 || !SCM_CONSP (SCM_CDR (exp
))
506 || !SCM_NULLP (SCM_CDDR (exp
)))
507 SCM_WRONG_NUM_ARGS ();
508 return scm_start_stack (scm_eval_car (exp
, env
), SCM_CADR (exp
), env
);
515 * The debugging evaluator throws these on frame traps.
518 scm_t_bits scm_tc16_debugobj
;
521 debugobj_print (SCM obj
, SCM port
, scm_print_state
*pstate SCM_UNUSED
)
523 scm_puts ("#<debug-object ", port
);
524 scm_intprint ((long) SCM_DEBUGOBJ_FRAME (obj
), 16, port
);
525 scm_putc ('>', port
);
529 SCM_DEFINE (scm_debug_object_p
, "debug-object?", 1, 0, 0,
531 "Return @code{#t} if @var{obj} is a debug object.")
532 #define FUNC_NAME s_scm_debug_object_p
534 return SCM_BOOL(SCM_DEBUGOBJP (obj
));
540 scm_make_debugobj (scm_t_debug_frame
*frame
)
545 SCM_SET_DEBUGOBJ_FRAME (z
, frame
);
546 SCM_SET_CELL_TYPE (z
, scm_tc16_debugobj
);
553 /* Undocumented debugging procedure */
555 SCM_DEFINE (scm_debug_hang
, "debug-hang", 0, 1, 0,
557 "Go into an endless loop, which can be only terminated with\n"
559 #define FUNC_NAME s_scm_debug_hang
563 return SCM_UNSPECIFIED
;
573 scm_init_opts (scm_debug_options
, scm_debug_opts
, SCM_N_DEBUG_OPTIONS
);
575 scm_tc16_memoized
= scm_make_smob_type ("memoized", 0);
576 scm_set_smob_mark (scm_tc16_memoized
, scm_markcdr
);
577 scm_set_smob_print (scm_tc16_memoized
, memoized_print
);
579 scm_tc16_debugobj
= scm_make_smob_type ("debug-object", 0);
580 scm_set_smob_print (scm_tc16_debugobj
, debugobj_print
);
583 scm_c_define ("SCM_IM_AND", SCM_IM_AND
);
584 scm_c_define ("SCM_IM_BEGIN", SCM_IM_BEGIN
);
585 scm_c_define ("SCM_IM_CASE", SCM_IM_CASE
);
586 scm_c_define ("SCM_IM_COND", SCM_IM_COND
);
587 scm_c_define ("SCM_IM_DO", SCM_IM_DO
);
588 scm_c_define ("SCM_IM_IF", SCM_IM_IF
);
589 scm_c_define ("SCM_IM_LAMBDA", SCM_IM_LAMBDA
);
590 scm_c_define ("SCM_IM_LET", SCM_IM_LET
);
591 scm_c_define ("SCM_IM_LETSTAR", SCM_IM_LETSTAR
);
592 scm_c_define ("SCM_IM_LETREC", SCM_IM_LETREC
);
593 scm_c_define ("SCM_IM_OR", SCM_IM_OR
);
594 scm_c_define ("SCM_IM_QUOTE", SCM_IM_QUOTE
);
595 scm_c_define ("SCM_IM_SET_X", SCM_IM_SET_X
);
596 scm_c_define ("SCM_IM_DEFINE", SCM_IM_DEFINE
);
597 scm_c_define ("SCM_IM_APPLY", SCM_IM_APPLY
);
598 scm_c_define ("SCM_IM_CONT", SCM_IM_CONT
);
599 scm_c_define ("SCM_IM_DISPATCH", SCM_IM_DISPATCH
);
601 scm_add_feature ("debug-extensions");
603 #ifndef SCM_MAGIC_SNARFER
604 #include "libguile/debug.x"