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 */
46 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
47 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
50 #include "libguile/_scm.h"
51 #include "libguile/eval.h"
52 #include "libguile/stackchk.h"
53 #include "libguile/throw.h"
54 #include "libguile/macros.h"
55 #include "libguile/smob.h"
56 #include "libguile/procprop.h"
57 #include "libguile/srcprop.h"
58 #include "libguile/alist.h"
59 #include "libguile/continuations.h"
60 #include "libguile/strports.h"
61 #include "libguile/read.h"
62 #include "libguile/feature.h"
63 #include "libguile/dynwind.h"
64 #include "libguile/modules.h"
65 #include "libguile/ports.h"
66 #include "libguile/root.h"
67 #include "libguile/fluids.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 @var{debug-options}.")
81 #define FUNC_NAME s_scm_debug_options
85 ans
= scm_options (setting
,
90 if (!(1 <= SCM_N_FRAMES
&& SCM_N_FRAMES
<= SCM_MAX_FRAME_SIZE
))
92 scm_options (ans
, scm_debug_opts
, SCM_N_DEBUG_OPTIONS
, FUNC_NAME
);
93 SCM_OUT_OF_RANGE (1, setting
);
97 scm_stack_checking_enabled_p
= SCM_STACK_CHECKING_P
;
98 scm_debug_eframe_size
= 2 * SCM_N_FRAMES
;
105 with_traps_before (void *data
)
107 int *trap_flag
= data
;
108 *trap_flag
= SCM_TRAPS_P
;
113 with_traps_after (void *data
)
115 int *trap_flag
= data
;
116 SCM_TRAPS_P
= *trap_flag
;
120 with_traps_inner (void *data
)
122 SCM thunk
= SCM_PACK (data
);
123 return scm_apply (thunk
, SCM_EOL
, SCM_EOL
);
126 SCM_DEFINE (scm_with_traps
, "with-traps", 1, 0, 0,
128 "Call @var{thunk} with traps enabled.")
129 #define FUNC_NAME s_scm_with_traps
132 SCM_VALIDATE_THUNK (1,thunk
);
133 return scm_internal_dynamic_wind (with_traps_before
,
136 (void *) SCM_UNPACK (thunk
),
143 SCM_SYMBOL (scm_sym_procname
, "procname");
144 SCM_SYMBOL (scm_sym_dots
, "...");
145 SCM_SYMBOL (scm_sym_source
, "source");
150 scm_bits_t scm_tc16_memoized
;
153 memoized_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
155 int writingp
= SCM_WRITINGP (pstate
);
156 scm_puts ("#<memoized ", port
);
157 SCM_SET_WRITINGP (pstate
, 1);
159 scm_iprin1 (SCM_MEMOIZED_EXP (obj
), port
, pstate
);
161 scm_iprin1 (scm_unmemoize (obj
), port
, pstate
);
163 SCM_SET_WRITINGP (pstate
, writingp
);
164 scm_putc ('>', port
);
168 SCM_DEFINE (scm_memoized_p
, "memoized?", 1, 0, 0,
170 "Return @code{#t} if @var{obj} is memoized.")
171 #define FUNC_NAME s_scm_memoized_p
173 return SCM_BOOL(SCM_MEMOIZEDP (obj
));
178 scm_make_memoized (SCM exp
, SCM env
)
180 /* *fixme* Check that env is a valid environment. */
183 SCM_NEWSMOB (z
, SCM_UNPACK (exp
), SCM_UNPACK (env
));
184 SCM_NEWSMOB (ans
, scm_tc16_memoized
, SCM_UNPACK (z
));
191 * Some primitives for construction of memoized code
193 * - procedure: memcons CAR CDR [ENV]
195 * Construct a pair, encapsulated in a memoized object.
197 * The CAR and CDR can be either normal or memoized. If ENV isn't
198 * specified, the top-level environment of the current module will
199 * be assumed. All environments must match.
201 * - procedure: make-gloc VARIABLE [ENV]
203 * Return a gloc, encapsulated in a memoized object.
205 * (Glocs can't exist in normal list structures, since they will
206 * be mistaken for structs.)
208 * - procedure: gloc? OBJECT
210 * Return #t if OBJECT is a memoized gloc.
212 * - procedure: make-iloc FRAME BINDING CDRP
214 * Return an iloc referring to frame no. FRAME, binding
215 * no. BINDING. If CDRP is non-#f, the iloc is referring to a
216 * frame consisting of a single pair, with the value stored in the
219 * - procedure: iloc? OBJECT
221 * Return #t if OBJECT is an iloc.
223 * - procedure: mem->proc MEMOIZED
225 * Construct a closure from the memoized lambda expression MEMOIZED
227 * WARNING! The code is not copied!
229 * - procedure: proc->mem CLOSURE
231 * Turn the closure CLOSURE into a memoized object.
233 * WARNING! The code is not copied!
235 * - constant: SCM_IM_AND
236 * - constant: SCM_IM_BEGIN
237 * - constant: SCM_IM_CASE
238 * - constant: SCM_IM_COND
239 * - constant: SCM_IM_DO
240 * - constant: SCM_IM_IF
241 * - constant: SCM_IM_LAMBDA
242 * - constant: SCM_IM_LET
243 * - constant: SCM_IM_LETSTAR
244 * - constant: SCM_IM_LETREC
245 * - constant: SCM_IM_OR
246 * - constant: SCM_IM_QUOTE
247 * - constant: SCM_IM_SET
248 * - constant: SCM_IM_DEFINE
249 * - constant: SCM_IM_APPLY
250 * - constant: SCM_IM_CONT
251 * - constant: SCM_IM_DISPATCH
254 #include "libguile/variable.h"
255 #include "libguile/procs.h"
257 SCM_DEFINE (scm_make_gloc
, "make-gloc", 1, 1, 0,
259 "Create a gloc for variable @var{var} in the environment\n"
261 #define FUNC_NAME s_scm_make_gloc
263 SCM_VALIDATE_VARIABLE (1,var
);
264 if (SCM_UNBNDP (env
))
265 env
= scm_top_level_env (SCM_TOP_LEVEL_LOOKUP_CLOSURE
);
267 SCM_VALIDATE_NULLORCONS (2,env
);
268 return scm_make_memoized (SCM_UNPACK (var
) + scm_tc3_cons_gloc
, env
);
272 SCM_DEFINE (scm_gloc_p
, "gloc?", 1, 0, 0,
274 "Return @code{#t} if @var{obj} is a gloc.")
275 #define FUNC_NAME s_scm_gloc_p
278 SCM_BOOL (SCM_MEMOIZEDP (obj
)
279 && ((SCM_UNPACK(SCM_MEMOIZED_EXP(obj
))&7) == scm_tc3_cons_gloc
));
283 SCM_DEFINE (scm_make_iloc
, "make-iloc", 3, 0, 0,
284 (SCM frame
, SCM binding
, SCM cdrp
),
285 "Return a new iloc with frame offset @var{frame}, binding\n"
286 "offset @var{binding} and the cdr flag @var{cdrp}.")
287 #define FUNC_NAME s_scm_make_iloc
289 SCM_VALIDATE_INUM (1,frame
);
290 SCM_VALIDATE_INUM (2,binding
);
292 + SCM_IFRINC
* SCM_INUM (frame
)
293 + (SCM_NFALSEP (cdrp
) ? SCM_ICDR
: 0)
294 + SCM_IDINC
* SCM_INUM (binding
));
298 SCM_DEFINE (scm_iloc_p
, "iloc?", 1, 0, 0,
300 "Return @code{#t} if @var{obj} is an iloc.")
301 #define FUNC_NAME s_scm_iloc_p
303 return SCM_BOOL(SCM_ILOCP (obj
));
307 SCM_DEFINE (scm_memcons
, "memcons", 2, 1, 0,
308 (SCM car
, SCM cdr
, SCM env
),
309 "Return a new memoized cons cell with @var{car} and @var{cdr}\n"
310 "as members and @var{env} as the environment.")
311 #define FUNC_NAME s_scm_memcons
313 if (SCM_MEMOIZEDP (car
))
315 /*fixme* environments may be two different but equal top-level envs */
316 if (!SCM_UNBNDP (env
) && SCM_MEMOIZED_ENV (car
) != env
)
317 SCM_MISC_ERROR ("environment mismatch arg1 <-> arg3",
318 scm_cons2 (car
, env
, SCM_EOL
));
320 env
= SCM_MEMOIZED_ENV (car
);
321 car
= SCM_MEMOIZED_EXP (car
);
323 if (SCM_MEMOIZEDP (cdr
))
325 if (!SCM_UNBNDP (env
) && SCM_MEMOIZED_ENV (cdr
) != env
)
326 SCM_MISC_ERROR ("environment mismatch arg2 <-> arg3",
327 scm_cons2 (cdr
, env
, SCM_EOL
));
329 env
= SCM_MEMOIZED_ENV (cdr
);
330 cdr
= SCM_MEMOIZED_EXP (cdr
);
332 if (SCM_UNBNDP (env
))
333 env
= scm_top_level_env (SCM_TOP_LEVEL_LOOKUP_CLOSURE
);
335 SCM_VALIDATE_NULLORCONS (3,env
);
336 return scm_make_memoized (scm_cons (car
, cdr
), env
);
340 SCM_DEFINE (scm_mem_to_proc
, "mem->proc", 1, 0, 0,
342 "Convert a memoized object (which must be a lambda expression)\n"
344 #define FUNC_NAME s_scm_mem_to_proc
347 SCM_VALIDATE_MEMOIZED (1,obj
);
348 env
= SCM_MEMOIZED_ENV (obj
);
349 obj
= SCM_MEMOIZED_EXP (obj
);
350 if (!(SCM_NIMP (obj
) && SCM_CAR (obj
) == SCM_IM_LAMBDA
))
351 SCM_MISC_ERROR ("expected lambda expression",
352 scm_cons (obj
, SCM_EOL
));
353 return scm_closure (SCM_CDR (obj
), env
);
357 SCM_DEFINE (scm_proc_to_mem
, "proc->mem", 1, 0, 0,
359 "Convert a procedure to a memoized object.")
360 #define FUNC_NAME s_scm_proc_to_mem
362 SCM_VALIDATE_CLOSURE (1, obj
);
363 return scm_make_memoized (scm_cons (SCM_IM_LAMBDA
, SCM_CODE (obj
)),
368 #endif /* GUILE_DEBUG */
370 SCM_DEFINE (scm_unmemoize
, "unmemoize", 1, 0, 0,
372 "Unmemoize the memoized expression @var{m},")
373 #define FUNC_NAME s_scm_unmemoize
375 SCM_VALIDATE_MEMOIZED (1,m
);
376 return scm_unmemocopy (SCM_MEMOIZED_EXP (m
), SCM_MEMOIZED_ENV (m
));
380 SCM_DEFINE (scm_memoized_environment
, "memoized-environment", 1, 0, 0,
382 "Return the environment of the memoized expression @var{m}.")
383 #define FUNC_NAME s_scm_memoized_environment
385 SCM_VALIDATE_MEMOIZED (1,m
);
386 return SCM_MEMOIZED_ENV (m
);
390 SCM_DEFINE (scm_procedure_name
, "procedure-name", 1, 0, 0,
392 "Return the name of the procedure @var{proc}")
393 #define FUNC_NAME s_scm_procedure_name
395 SCM_VALIDATE_PROC (1,proc
);
396 switch (SCM_TYP7 (proc
)) {
398 return SCM_SNAME (proc
);
401 SCM name
= scm_procedure_property (proc
, scm_sym_name
);
403 /* Source property scm_sym_procname not implemented yet... */
404 SCM name
= scm_source_property (SCM_CAR (SCM_CDR (SCM_CODE (proc
))), scm_sym_procname
);
405 if (SCM_FALSEP (name
))
406 name
= scm_procedure_property (proc
, scm_sym_name
);
408 if (SCM_FALSEP (name
) && SCM_CLOSUREP (proc
))
409 name
= scm_reverse_lookup (SCM_ENV (proc
), proc
);
416 SCM_DEFINE (scm_procedure_source
, "procedure-source", 1, 0, 0,
418 "Return the source of the procedure @var{proc}.")
419 #define FUNC_NAME s_scm_procedure_source
421 SCM_VALIDATE_NIM (1,proc
);
422 switch (SCM_TYP7 (proc
)) {
423 case scm_tcs_closures
:
425 SCM formals
= SCM_CLOSURE_FORMALS (proc
);
426 SCM src
= scm_source_property (SCM_CDR (SCM_CODE (proc
)), scm_sym_copy
);
427 if (!SCM_FALSEP (src
))
428 return scm_cons2 (scm_sym_lambda
, formals
, src
);
429 return scm_cons (scm_sym_lambda
,
430 scm_unmemocopy (SCM_CODE (proc
),
431 SCM_EXTEND_ENV (formals
,
439 /* It would indeed be a nice thing if we supplied source even for
440 built in procedures! */
441 return scm_procedure_property (proc
, scm_sym_source
);
443 SCM_WRONG_TYPE_ARG (1, proc
);
449 SCM_DEFINE (scm_procedure_environment
, "procedure-environment", 1, 0, 0,
451 "Return the environment of the procedure @var{proc}.")
452 #define FUNC_NAME s_scm_procedure_environment
454 SCM_VALIDATE_NIM (1,proc
);
455 switch (SCM_TYP7 (proc
)) {
456 case scm_tcs_closures
:
457 return SCM_ENV (proc
);
464 SCM_WRONG_TYPE_ARG (1, proc
);
472 /* Eval in a local environment. We would like to have the ability to
473 * evaluate in a specified local environment, but due to the
474 * memoization this isn't normally possible. We solve it by copying
475 * the code before evaluating. One solution would be to have eval.c
476 * generate yet another evaluator. They are not very big actually.
478 SCM_DEFINE (scm_local_eval
, "local-eval", 1, 1, 0,
480 "Evaluate @var{exp} in its environment. If @var{env} is supplied,\n"
481 "it is the environment in which to evaluate @var{exp}. Otherwise,\n"
482 "@var{exp} must be a memoized code object (in which case, its environment\n"
484 #define FUNC_NAME s_scm_local_eval
486 if (SCM_UNBNDP (env
))
488 SCM_VALIDATE_MEMOIZED (1, exp
);
489 return scm_i_eval_x (SCM_MEMOIZED_EXP (exp
), SCM_MEMOIZED_ENV (exp
));
491 return scm_i_eval (exp
, env
);
496 SCM_REGISTER_PROC (s_reverse_lookup
, "reverse-lookup", 2, 0, 0, scm_reverse_lookup
);
500 scm_reverse_lookup (SCM env
, SCM data
)
502 while (SCM_CONSP (env
) && SCM_CONSP (SCM_CAR (env
)))
504 SCM names
= SCM_CAAR (env
);
505 SCM values
= SCM_CDAR (env
);
506 while (SCM_CONSP (names
))
508 if (SCM_EQ_P (SCM_CAR (values
), data
))
509 return SCM_CAR (names
);
510 names
= SCM_CDR (names
);
511 values
= SCM_CDR (values
);
513 if (!SCM_NULLP (names
) && SCM_EQ_P (values
, data
))
521 scm_start_stack (SCM id
, SCM exp
, SCM env
)
524 scm_debug_frame_t vframe
;
525 scm_debug_info_t vframe_vect_body
;
526 vframe
.prev
= scm_last_debug_frame
;
527 vframe
.status
= SCM_VOIDFRAME
;
528 vframe
.vect
= &vframe_vect_body
;
529 vframe
.vect
[0].id
= id
;
530 scm_last_debug_frame
= &vframe
;
531 answer
= scm_i_eval (exp
, env
);
532 scm_last_debug_frame
= vframe
.prev
;
536 SCM_SYNTAX(s_start_stack
, "start-stack", scm_makacro
, scm_m_start_stack
);
539 scm_m_start_stack (SCM exp
, SCM env
)
540 #define FUNC_NAME s_start_stack
543 if (!SCM_ECONSP (exp
)
544 || !SCM_ECONSP (SCM_CDR (exp
))
545 || !SCM_NULLP (SCM_CDDR (exp
)))
546 SCM_WRONG_NUM_ARGS ();
547 return scm_start_stack (scm_eval_car (exp
, env
), SCM_CADR (exp
), env
);
554 * The debugging evaluator throws these on frame traps.
557 scm_bits_t scm_tc16_debugobj
;
560 debugobj_print (SCM obj
, SCM port
, scm_print_state
*pstate
)
562 scm_puts ("#<debug-object ", port
);
563 scm_intprint ((int) SCM_DEBUGOBJ_FRAME (obj
), 16, port
);
564 scm_putc ('>', port
);
568 SCM_DEFINE (scm_debug_object_p
, "debug-object?", 1, 0, 0,
570 "Return @code{#t} if @var{obj} is a debug object.")
571 #define FUNC_NAME s_scm_debug_object_p
573 return SCM_BOOL(SCM_DEBUGOBJP (obj
));
579 scm_make_debugobj (scm_debug_frame_t
*frame
)
584 SCM_SET_DEBUGOBJ_FRAME (z
, frame
);
585 SCM_SET_CELL_TYPE (z
, scm_tc16_debugobj
);
592 /* Undocumented debugging procedure */
594 SCM_DEFINE (scm_debug_hang
, "debug-hang", 0, 1, 0,
596 "Go into an endless loop, which can be only terminated with\n"
598 #define FUNC_NAME s_scm_debug_hang
602 return SCM_UNSPECIFIED
;
612 scm_init_opts (scm_debug_options
, scm_debug_opts
, SCM_N_DEBUG_OPTIONS
);
614 scm_tc16_memoized
= scm_make_smob_type ("memoized", 0);
615 scm_set_smob_mark (scm_tc16_memoized
, scm_markcdr
);
616 scm_set_smob_print (scm_tc16_memoized
, memoized_print
);
618 scm_tc16_debugobj
= scm_make_smob_type ("debug-object", 0);
619 scm_set_smob_print (scm_tc16_debugobj
, debugobj_print
);
622 scm_c_define ("SCM_IM_AND", SCM_IM_AND
);
623 scm_c_define ("SCM_IM_BEGIN", SCM_IM_BEGIN
);
624 scm_c_define ("SCM_IM_CASE", SCM_IM_CASE
);
625 scm_c_define ("SCM_IM_COND", SCM_IM_COND
);
626 scm_c_define ("SCM_IM_DO", SCM_IM_DO
);
627 scm_c_define ("SCM_IM_IF", SCM_IM_IF
);
628 scm_c_define ("SCM_IM_LAMBDA", SCM_IM_LAMBDA
);
629 scm_c_define ("SCM_IM_LET", SCM_IM_LET
);
630 scm_c_define ("SCM_IM_LETSTAR", SCM_IM_LETSTAR
);
631 scm_c_define ("SCM_IM_LETREC", SCM_IM_LETREC
);
632 scm_c_define ("SCM_IM_OR", SCM_IM_OR
);
633 scm_c_define ("SCM_IM_QUOTE", SCM_IM_QUOTE
);
634 scm_c_define ("SCM_IM_SET_X", SCM_IM_SET_X
);
635 scm_c_define ("SCM_IM_DEFINE", SCM_IM_DEFINE
);
636 scm_c_define ("SCM_IM_APPLY", SCM_IM_APPLY
);
637 scm_c_define ("SCM_IM_CONT", SCM_IM_CONT
);
638 scm_c_define ("SCM_IM_DISPATCH", SCM_IM_DISPATCH
);
640 scm_add_feature ("debug-extensions");
642 #ifndef SCM_MAGIC_SNARFER
643 #include "libguile/debug.x"