1 /* Debugging extensions for Guile
2 * Copyright (C) 1995, 1996, 1997, 1998 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 */
57 #include "continuations.h"
66 /* {Run time control of the debugging evaluator}
69 SCM_PROC (s_debug_options
, "debug-options-interface", 0, 1, 0, scm_debug_options
);
72 scm_debug_options (setting
)
77 ans
= scm_options (setting
,
82 if (!(1 <= SCM_N_FRAMES
&& SCM_N_FRAMES
<= SCM_MAX_FRAME_SIZE
))
84 scm_options (ans
, scm_debug_opts
, SCM_N_DEBUG_OPTIONS
, s_debug_options
);
85 scm_out_of_range (s_debug_options
, setting
);
89 scm_stack_checking_enabled_p
= SCM_STACK_CHECKING_P
;
90 scm_debug_eframe_size
= 2 * SCM_N_FRAMES
;
95 SCM_PROC (s_with_traps
, "with-traps", 1, 0, 0, scm_with_traps
);
98 with_traps_before (void *data
)
100 int *trap_flag
= data
;
101 *trap_flag
= SCM_TRAPS_P
;
106 with_traps_after (void *data
)
108 int *trap_flag
= data
;
109 SCM_TRAPS_P
= *trap_flag
;
113 with_traps_inner (void *data
)
115 SCM thunk
= (SCM
) data
;
116 return scm_apply (thunk
, SCM_EOL
, SCM_EOL
);
120 scm_with_traps (SCM thunk
)
123 SCM_ASSERT (SCM_NFALSEP (scm_thunk_p (thunk
)),
127 return scm_internal_dynamic_wind (with_traps_before
,
135 static SCM scm_i_source
, scm_i_more
;
136 static SCM scm_i_proc
, scm_i_args
, scm_i_eval_args
;
137 static SCM scm_i_procname
;
142 long scm_tc16_memoized
;
145 static int prinmemoized
SCM_P ((SCM obj
, SCM port
, scm_print_state
*pstate
));
148 prinmemoized (obj
, port
, pstate
)
151 scm_print_state
*pstate
;
153 int writingp
= SCM_WRITINGP (pstate
);
154 scm_puts ("#<memoized ", port
);
155 SCM_SET_WRITINGP (pstate
, 1);
157 scm_iprin1 (SCM_MEMOIZED_EXP (obj
), port
, pstate
);
159 scm_iprin1 (scm_unmemoize (obj
), port
, pstate
);
161 SCM_SET_WRITINGP (pstate
, writingp
);
162 scm_putc ('>', port
);
166 static scm_smobfuns memoizedsmob
=
167 {scm_markcdr
, scm_free0
, prinmemoized
, 0};
169 SCM_PROC (s_memoized_p
, "memoized?", 1, 0, 0, scm_memoized_p
);
175 return SCM_NIMP (obj
) && SCM_MEMOIZEDP (obj
) ? SCM_BOOL_T
: SCM_BOOL_F
;
179 scm_make_memoized (exp
, env
)
183 /* *fixme* Check that env is a valid environment. */
191 SCM_SETCAR (ans
, scm_tc16_memoized
);
198 * Some primitives for construction of memoized code
200 * - procedure: memcons CAR CDR [ENV]
202 * Construct a pair, encapsulated in a memoized object.
204 * The CAR and CDR can be either normal or memoized. If ENV isn't
205 * specified, the top-level environment of the current module will
206 * be assumed. All environments must match.
208 * - procedure: make-gloc VARIABLE [ENV]
210 * Return a gloc, encapsulated in a memoized object.
212 * (Glocs can't exist in normal list structures, since they will
213 * be mistaken for structs.)
215 * - procedure: gloc? OBJECT
217 * Return #t if OBJECT is a memoized gloc.
219 * - procedure: make-iloc FRAME BINDING CDRP
221 * Return an iloc referring to frame no. FRAME, binding
222 * no. BINDING. If CDRP is non-#f, the iloc is referring to a
223 * frame consisting of a single pair, with the value stored in the
226 * - procedure: iloc? OBJECT
228 * Return #t if OBJECT is an iloc.
230 * - procedure: mem->proc MEMOIZED
232 * Construct a closure from the memoized lambda expression MEMOIZED
234 * WARNING! The code is not copied!
236 * - procedure: proc->mem CLOSURE
238 * Turn the closure CLOSURE into a memoized object.
240 * WARNING! The code is not copied!
242 * - constant: SCM_IM_AND
243 * - constant: SCM_IM_BEGIN
244 * - constant: SCM_IM_CASE
245 * - constant: SCM_IM_COND
246 * - constant: SCM_IM_DO
247 * - constant: SCM_IM_IF
248 * - constant: SCM_IM_LAMBDA
249 * - constant: SCM_IM_LET
250 * - constant: SCM_IM_LETSTAR
251 * - constant: SCM_IM_LETREC
252 * - constant: SCM_IM_OR
253 * - constant: SCM_IM_QUOTE
254 * - constant: SCM_IM_SET
255 * - constant: SCM_IM_DEFINE
256 * - constant: SCM_IM_APPLY
257 * - constant: SCM_IM_CONT
260 #include "variable.h"
263 SCM_PROC (s_make_gloc
, "make-gloc", 1, 1, 0, scm_make_gloc
);
266 scm_make_gloc (var
, env
)
271 if (SCM_NIMP (var
) && SCM_CONSP (var
))
272 var
= scm_cons (SCM_BOOL_F
, var
);
275 SCM_ASSERT (SCM_NIMP (var
) && SCM_VARIABLEP (var
),
279 if (SCM_UNBNDP (env
))
280 env
= scm_top_level_env (SCM_CDR (scm_top_level_lookup_closure_var
));
282 SCM_ASSERT (SCM_NULLP (env
) || (SCM_NIMP (env
) && SCM_CONSP (env
)),
286 return scm_make_memoized (SCM_VARVCELL (var
) + 1, env
);
289 SCM_PROC (s_gloc_p
, "gloc?", 1, 0, 0, scm_gloc_p
);
295 return ((SCM_NIMP (obj
)
296 && SCM_MEMOIZEDP (obj
)
297 && (SCM_MEMOIZED_EXP (obj
) & 7) == 1)
302 SCM_PROC (s_make_iloc
, "make-iloc", 3, 0, 0, scm_make_iloc
);
305 scm_make_iloc (frame
, binding
, cdrp
)
310 SCM_ASSERT (SCM_INUMP (frame
), frame
, SCM_ARG1
, s_make_iloc
);
311 SCM_ASSERT (SCM_INUMP (binding
), binding
, SCM_ARG2
, s_make_iloc
);
313 + SCM_IFRINC
* SCM_INUM (frame
)
314 + (SCM_NFALSEP (cdrp
) ? SCM_ICDR
: 0)
315 + SCM_IDINC
* SCM_INUM (binding
));
318 SCM_PROC (s_iloc_p
, "iloc?", 1, 0, 0, scm_iloc_p
);
324 return SCM_ILOCP (obj
) ? SCM_BOOL_T
: SCM_BOOL_F
;
327 SCM_PROC (s_memcons
, "memcons", 2, 1, 0, scm_memcons
);
330 scm_memcons (car
, cdr
, env
)
335 if (SCM_NIMP (car
) && SCM_MEMOIZEDP (car
))
337 /*fixme* environments may be two different but equal top-level envs */
338 if (!SCM_UNBNDP (env
) && SCM_MEMOIZED_ENV (car
) != env
)
339 scm_misc_error (s_memcons
,
340 "environment mismatch arg1 <-> arg3",
341 scm_cons2 (car
, env
, SCM_EOL
));
343 env
= SCM_MEMOIZED_ENV (car
);
344 car
= SCM_MEMOIZED_EXP (car
);
346 if (SCM_NIMP (cdr
) && SCM_MEMOIZEDP (cdr
))
348 if (!SCM_UNBNDP (env
) && SCM_MEMOIZED_ENV (cdr
) != env
)
349 scm_misc_error (s_memcons
,
350 "environment mismatch arg2 <-> arg3",
351 scm_cons2 (cdr
, env
, SCM_EOL
));
353 env
= SCM_MEMOIZED_ENV (cdr
);
354 cdr
= SCM_MEMOIZED_EXP (cdr
);
356 if (SCM_UNBNDP (env
))
357 env
= scm_top_level_env (SCM_CDR (scm_top_level_lookup_closure_var
));
359 SCM_ASSERT (SCM_NULLP (env
) || (SCM_NIMP (env
) && SCM_CONSP (env
)),
363 return scm_make_memoized (scm_cons (car
, cdr
), env
);
366 SCM_PROC (s_mem_to_proc
, "mem->proc", 1, 0, 0, scm_mem_to_proc
);
369 scm_mem_to_proc (obj
)
373 SCM_ASSERT (SCM_NIMP (obj
) && SCM_MEMOIZEDP (obj
),
377 env
= SCM_MEMOIZED_ENV (obj
);
378 obj
= SCM_MEMOIZED_EXP (obj
);
379 if (!(SCM_NIMP (obj
) && SCM_CAR (obj
) == SCM_IM_LAMBDA
))
380 scm_misc_error (s_mem_to_proc
,
381 "expected lambda expression",
382 scm_cons (obj
, SCM_EOL
));
383 return scm_closure (SCM_CDR (obj
), env
);
386 SCM_PROC (s_proc_to_mem
, "proc->mem", 1, 0, 0, scm_proc_to_mem
);
389 scm_proc_to_mem (obj
)
392 SCM_ASSERT (SCM_NIMP (obj
) && SCM_CLOSUREP (obj
),
396 return scm_make_memoized (scm_cons (SCM_IM_LAMBDA
, SCM_CODE (obj
)),
400 #endif /* GUILE_DEBUG */
402 SCM_PROC (s_unmemoize
, "unmemoize", 1, 0, 0, scm_unmemoize
);
408 SCM_ASSERT (SCM_NIMP (m
) && SCM_MEMOIZEDP (m
), m
, SCM_ARG1
, s_unmemoize
);
409 return scm_unmemocopy (SCM_MEMOIZED_EXP (m
), SCM_MEMOIZED_ENV (m
));
412 SCM_PROC (s_memoized_environment
, "memoized-environment", 1, 0, 0, scm_memoized_environment
);
415 scm_memoized_environment (m
)
418 SCM_ASSERT (SCM_NIMP (m
) && SCM_MEMOIZEDP (m
), m
, SCM_ARG1
, s_unmemoize
);
419 return SCM_MEMOIZED_ENV (m
);
422 SCM_PROC (s_procedure_name
, "procedure-name", 1, 0, 0, scm_procedure_name
);
425 scm_procedure_name (proc
)
428 SCM_ASSERT(scm_procedure_p (proc
) == SCM_BOOL_T
,
432 switch (SCM_TYP7 (proc
)) {
433 case scm_tcs_closures
:
436 SCM name
= scm_procedure_property (proc
, scm_i_name
);
438 /* Source property scm_i_procname not implemented yet... */
439 SCM name
= scm_source_property (SCM_CAR (SCM_CDR (SCM_CODE (proc
))), scm_i_procname
);
440 if (SCM_FALSEP (name
))
441 name
= scm_procedure_property (proc
, scm_i_name
);
443 if (SCM_FALSEP (name
))
444 name
= scm_procedure_property (proc
, scm_i_inner_name
);
448 return SCM_SNAME (proc
);
454 SCM_PROC (s_procedure_source
, "procedure-source", 1, 0, 0, scm_procedure_source
);
457 scm_procedure_source (proc
)
460 SCM_ASSERT(SCM_NIMP (proc
), proc
, SCM_ARG1
, s_procedure_source
);
461 switch (SCM_TYP7 (proc
)) {
462 case scm_tcs_closures
:
465 src
= scm_source_property (SCM_CDR (SCM_CODE (proc
)), scm_i_copy
);
466 if (src
!= SCM_BOOL_F
)
467 return scm_cons2 (scm_i_lambda
, SCM_CAR (SCM_CODE (proc
)), src
);
468 src
= SCM_CODE (proc
);
469 return scm_cons (scm_i_lambda
,
471 SCM_EXTEND_ENV (SCM_CAR (src
),
480 /* It would indeed be a nice thing if we supplied source even for
481 built in procedures! */
482 return scm_procedure_property (proc
, scm_i_source
);
484 scm_wta (proc
, (char *) SCM_ARG1
, s_procedure_source
);
489 SCM_PROC (s_procedure_environment
, "procedure-environment", 1, 0, 0, scm_procedure_environment
);
492 scm_procedure_environment (proc
)
495 SCM_ASSERT (SCM_NIMP (proc
), proc
, SCM_ARG1
, s_procedure_environment
);
496 switch (SCM_TYP7 (proc
)) {
497 case scm_tcs_closures
:
498 return SCM_ENV (proc
);
506 scm_wta (proc
, (char *) SCM_ARG1
, s_procedure_environment
);
513 /* Eval in a local environment. We would like to have the ability to
514 * evaluate in a specified local environment, but due to the
515 * memoization this isn't normally possible. We solve it by copying
516 * the code before evaluating. One solution would be to have eval.c
517 * generate yet another evaluator. They are not very big actually.
519 SCM_PROC (s_local_eval
, "local-eval", 1, 1, 0, scm_local_eval
);
522 scm_local_eval (exp
, env
)
526 if (SCM_UNBNDP (env
))
528 SCM_ASSERT (SCM_NIMP (exp
) && SCM_MEMOIZEDP (exp
), exp
, SCM_ARG1
, s_local_eval
);
529 return scm_eval_3 (SCM_MEMOIZED_EXP (exp
), 0, SCM_MEMOIZED_ENV (exp
));
531 return scm_eval_3 (exp
, 1, env
);
535 scm_start_stack (id
, exp
, env
)
541 scm_debug_frame vframe
;
542 scm_debug_info vframe_vect_body
;
543 vframe
.prev
= scm_last_debug_frame
;
544 vframe
.status
= SCM_VOIDFRAME
;
545 vframe
.vect
= &vframe_vect_body
;
546 vframe
.vect
[0].id
= id
;
547 scm_last_debug_frame
= &vframe
;
548 answer
= scm_eval_3 (exp
, 1, env
);
549 scm_last_debug_frame
= vframe
.prev
;
553 static char s_start_stack
[] = "start-stack";
555 scm_m_start_stack (exp
, env
)
560 SCM_ASSERT (SCM_NIMP (exp
)
562 && SCM_NIMP (SCM_CDR (exp
))
563 && SCM_ECONSP (SCM_CDR (exp
))
564 && SCM_NULLP (SCM_CDDR (exp
)),
568 return scm_start_stack (scm_eval_car (exp
, env
), SCM_CADR (exp
), env
);
573 * The debugging evaluator throws these on frame traps.
576 long scm_tc16_debugobj
;
578 static int prindebugobj
SCM_P ((SCM obj
, SCM port
, scm_print_state
*pstate
));
581 prindebugobj (obj
, port
, pstate
)
584 scm_print_state
*pstate
;
586 scm_puts ("#<debug-object ", port
);
587 scm_intprint (SCM_DEBUGOBJ_FRAME (obj
), 16, port
);
588 scm_putc ('>', port
);
592 static scm_smobfuns debugobjsmob
=
593 {0, scm_free0
, prindebugobj
, 0};
595 SCM_PROC (s_debug_object_p
, "debug-object?", 1, 0, 0, scm_debug_object_p
);
598 scm_debug_object_p (obj
)
601 return SCM_NIMP (obj
) && SCM_DEBUGOBJP (obj
) ? SCM_BOOL_T
: SCM_BOOL_F
;
606 scm_make_debugobj (frame
)
607 scm_debug_frame
*frame
;
612 SCM_SET_DEBUGOBJ_FRAME (z
, (SCM
) frame
);
613 SCM_SETCAR (z
, scm_tc16_debugobj
);
620 /* Undocumented debugging procedure */
622 SCM_PROC (s_debug_hang
, "debug-hang", 0, 1, 0, scm_debug_hang
);
630 return SCM_UNSPECIFIED
;
639 scm_init_opts (scm_debug_options
, scm_debug_opts
, SCM_N_DEBUG_OPTIONS
);
641 scm_tc16_memoized
= scm_newsmob (&memoizedsmob
);
642 scm_tc16_debugobj
= scm_newsmob (&debugobjsmob
);
644 scm_i_procname
= SCM_CAR (scm_sysintern ("procname", SCM_UNDEFINED
));
645 scm_i_more
= SCM_CAR (scm_sysintern ("...", SCM_UNDEFINED
));
646 scm_i_source
= SCM_CAR (scm_sysintern ("source", SCM_UNDEFINED
));
647 scm_i_proc
= SCM_CAR (scm_sysintern ("proc", SCM_UNDEFINED
));
648 scm_i_args
= SCM_CAR (scm_sysintern ("args", SCM_UNDEFINED
));
649 scm_i_eval_args
= SCM_CAR (scm_sysintern ("eval-args", SCM_UNDEFINED
));
651 scm_make_synt (s_start_stack
, scm_makacro
, scm_m_start_stack
);
654 scm_sysintern ("SCM_IM_AND", SCM_IM_AND
);
655 scm_sysintern ("SCM_IM_BEGIN", SCM_IM_BEGIN
);
656 scm_sysintern ("SCM_IM_CASE", SCM_IM_CASE
);
657 scm_sysintern ("SCM_IM_COND", SCM_IM_COND
);
658 scm_sysintern ("SCM_IM_DO", SCM_IM_DO
);
659 scm_sysintern ("SCM_IM_IF", SCM_IM_IF
);
660 scm_sysintern ("SCM_IM_LAMBDA", SCM_IM_LAMBDA
);
661 scm_sysintern ("SCM_IM_LET", SCM_IM_LET
);
662 scm_sysintern ("SCM_IM_LETSTAR", SCM_IM_LETSTAR
);
663 scm_sysintern ("SCM_IM_LETREC", SCM_IM_LETREC
);
664 scm_sysintern ("SCM_IM_OR", SCM_IM_OR
);
665 scm_sysintern ("SCM_IM_QUOTE", SCM_IM_QUOTE
);
666 scm_sysintern ("SCM_IM_SET", SCM_IM_SET
);
667 scm_sysintern ("SCM_IM_DEFINE", SCM_IM_DEFINE
);
668 scm_sysintern ("SCM_IM_APPLY", SCM_IM_APPLY
);
669 scm_sysintern ("SCM_IM_CONT", SCM_IM_CONT
);
671 scm_add_feature ("debug-extensions");