1 /* Debugging extensions for Guile
2 * Copyright (C) 1995, 1996, 1997, 1998, 1999 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 */
61 #include "continuations.h"
68 #include "scm_validate.h"
72 /* {Run time control of the debugging evaluator}
75 GUILE_PROC (scm_debug_options
, "debug-options-interface", 0, 1, 0,
78 #define FUNC_NAME s_scm_debug_options
82 ans
= scm_options (setting
,
87 if (!(1 <= SCM_N_FRAMES
&& SCM_N_FRAMES
<= SCM_MAX_FRAME_SIZE
))
89 scm_options (ans
, scm_debug_opts
, SCM_N_DEBUG_OPTIONS
, FUNC_NAME
);
90 scm_out_of_range (FUNC_NAME
, setting
);
94 scm_stack_checking_enabled_p
= SCM_STACK_CHECKING_P
;
95 scm_debug_eframe_size
= 2 * SCM_N_FRAMES
;
102 with_traps_before (void *data
)
104 int *trap_flag
= data
;
105 *trap_flag
= SCM_TRAPS_P
;
110 with_traps_after (void *data
)
112 int *trap_flag
= data
;
113 SCM_TRAPS_P
= *trap_flag
;
117 with_traps_inner (void *data
)
119 SCM thunk
= (SCM
) data
;
120 return scm_apply (thunk
, SCM_EOL
, SCM_EOL
);
123 GUILE_PROC (scm_with_traps
, "with-traps", 1, 0, 0,
126 #define FUNC_NAME s_scm_with_traps
129 SCM_VALIDATE_THUNK(1,thunk
);
130 return scm_internal_dynamic_wind (with_traps_before
,
139 static SCM scm_sym_source
, scm_sym_dots
;
140 static SCM scm_sym_procname
;
145 long scm_tc16_memoized
;
149 prinmemoized (SCM obj
,SCM port
,scm_print_state
*pstate
)
151 int writingp
= SCM_WRITINGP (pstate
);
152 scm_puts ("#<memoized ", port
);
153 SCM_SET_WRITINGP (pstate
, 1);
155 scm_iprin1 (SCM_MEMOIZED_EXP (obj
), port
, pstate
);
157 scm_iprin1 (scm_unmemoize (obj
), port
, pstate
);
159 SCM_SET_WRITINGP (pstate
, writingp
);
160 scm_putc ('>', port
);
164 GUILE_PROC (scm_memoized_p
, "memoized?", 1, 0, 0,
167 #define FUNC_NAME s_scm_memoized_p
169 return SCM_BOOL(SCM_NIMP (obj
) && SCM_MEMOIZEDP (obj
));
174 scm_make_memoized (SCM exp
, SCM env
)
176 /* *fixme* Check that env is a valid environment. */
179 SCM_NEWSMOB (z
, exp
, env
);
180 SCM_NEWSMOB (ans
, scm_tc16_memoized
, z
);
187 * Some primitives for construction of memoized code
189 * - procedure: memcons CAR CDR [ENV]
191 * Construct a pair, encapsulated in a memoized object.
193 * The CAR and CDR can be either normal or memoized. If ENV isn't
194 * specified, the top-level environment of the current module will
195 * be assumed. All environments must match.
197 * - procedure: make-gloc VARIABLE [ENV]
199 * Return a gloc, encapsulated in a memoized object.
201 * (Glocs can't exist in normal list structures, since they will
202 * be mistaken for structs.)
204 * - procedure: gloc? OBJECT
206 * Return #t if OBJECT is a memoized gloc.
208 * - procedure: make-iloc FRAME BINDING CDRP
210 * Return an iloc referring to frame no. FRAME, binding
211 * no. BINDING. If CDRP is non-#f, the iloc is referring to a
212 * frame consisting of a single pair, with the value stored in the
215 * - procedure: iloc? OBJECT
217 * Return #t if OBJECT is an iloc.
219 * - procedure: mem->proc MEMOIZED
221 * Construct a closure from the memoized lambda expression MEMOIZED
223 * WARNING! The code is not copied!
225 * - procedure: proc->mem CLOSURE
227 * Turn the closure CLOSURE into a memoized object.
229 * WARNING! The code is not copied!
231 * - constant: SCM_IM_AND
232 * - constant: SCM_IM_BEGIN
233 * - constant: SCM_IM_CASE
234 * - constant: SCM_IM_COND
235 * - constant: SCM_IM_DO
236 * - constant: SCM_IM_IF
237 * - constant: SCM_IM_LAMBDA
238 * - constant: SCM_IM_LET
239 * - constant: SCM_IM_LETSTAR
240 * - constant: SCM_IM_LETREC
241 * - constant: SCM_IM_OR
242 * - constant: SCM_IM_QUOTE
243 * - constant: SCM_IM_SET
244 * - constant: SCM_IM_DEFINE
245 * - constant: SCM_IM_APPLY
246 * - constant: SCM_IM_CONT
247 * - constant: SCM_IM_DISPATCH
250 #include "variable.h"
253 GUILE_PROC (scm_make_gloc
, "make-gloc", 1, 1, 0,
256 #define FUNC_NAME s_scm_make_gloc
259 if (SCM_NIMP (var
) && SCM_CONSP (var
))
260 var
= scm_cons (SCM_BOOL_F
, var
);
263 SCM_VALIDATE_VARIABLE(1,var
);
264 if (SCM_UNBNDP (env
))
265 env
= scm_top_level_env (SCM_CDR (scm_top_level_lookup_closure_var
));
267 SCM_VALIDATE_NULLORCONS(2,env
);
268 return scm_make_memoized (SCM_VARVCELL (var
) + 1, env
);
272 GUILE_PROC (scm_gloc_p
, "gloc?", 1, 0, 0,
275 #define FUNC_NAME s_scm_gloc_p
277 return SCM_BOOL((SCM_NIMP (obj
)
278 && SCM_MEMOIZEDP (obj
)
279 && (SCM_MEMOIZED_EXP (obj
) & 7) == 1));
283 GUILE_PROC (scm_make_iloc
, "make-iloc", 3, 0, 0,
284 (SCM frame
, SCM binding
, SCM cdrp
),
286 #define FUNC_NAME s_scm_make_iloc
288 SCM_VALIDATE_INT(1,frame
);
289 SCM_VALIDATE_INT(2,binding
)
291 + SCM_IFRINC
* SCM_INUM (frame
)
292 + (SCM_NFALSEP (cdrp
) ? SCM_ICDR
: 0)
293 + SCM_IDINC
* SCM_INUM (binding
));
297 GUILE_PROC (scm_iloc_p
, "iloc?", 1, 0, 0,
300 #define FUNC_NAME s_scm_iGUILE_p
302 return SCM_BOOL(SCM_ILOCP (obj
));
306 GUILE_PROC (scm_memcons
, "memcons", 2, 1, 0,
307 (SCM car
, SCM cdr
, SCM env
),
309 #define FUNC_NAME s_scm_memcons
311 if (SCM_NIMP (car
) && SCM_MEMOIZEDP (car
))
313 /*fixme* environments may be two different but equal top-level envs */
314 if (!SCM_UNBNDP (env
) && SCM_MEMOIZED_ENV (car
) != env
)
315 scm_misc_error (s_memcons
,
316 "environment mismatch arg1 <-> arg3",
317 scm_cons2 (car
, env
, SCM_EOL
));
319 env
= SCM_MEMOIZED_ENV (car
);
320 car
= SCM_MEMOIZED_EXP (car
);
322 if (SCM_NIMP (cdr
) && SCM_MEMOIZEDP (cdr
))
324 if (!SCM_UNBNDP (env
) && SCM_MEMOIZED_ENV (cdr
) != env
)
325 scm_misc_error (s_memcons
,
326 "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_CDR (scm_top_level_lookup_closure_var
));
335 SCM_ASSERT (SCM_NULLP (env
) || (SCM_NIMP (env
) && SCM_CONSP (env
)),
339 return scm_make_memoized (scm_cons (car
, cdr
), env
);
343 GUILE_PROC (scm_mem_to_proc
, "mem->proc", 1, 0, 0,
346 #define FUNC_NAME s_scm_mem_to_proc
349 SCM_VALIDATE_MEMOIZED(1,obj
);
350 env
= SCM_MEMOIZED_ENV (obj
);
351 obj
= SCM_MEMOIZED_EXP (obj
);
352 if (!(SCM_NIMP (obj
) && SCM_CAR (obj
) == SCM_IM_LAMBDA
))
353 scm_misc_error (s_mem_to_proc
,
354 "expected lambda expression",
355 scm_cons (obj
, SCM_EOL
));
356 return scm_closure (SCM_CDR (obj
), env
);
360 GUILE_PROC (scm_proc_to_mem
, "proc->mem", 1, 0, 0,
363 #define FUNC_NAME s_scm_proc_to_mem
365 SCM_VALIDATE_CLOSURE(1,obj
)
366 return scm_make_memoized (scm_cons (SCM_IM_LAMBDA
, SCM_CODE (obj
)),
371 #endif /* GUILE_DEBUG */
373 GUILE_PROC (scm_unmemoize
, "unmemoize", 1, 0, 0,
376 #define FUNC_NAME s_scm_unmemoize
378 SCM_VALIDATE_MEMOIZED(1,m
);
379 return scm_unmemocopy (SCM_MEMOIZED_EXP (m
), SCM_MEMOIZED_ENV (m
));
383 GUILE_PROC (scm_memoized_environment
, "memoized-environment", 1, 0, 0,
386 #define FUNC_NAME s_scm_memoized_environment
388 SCM_VALIDATE_MEMOIZED(1,m
);
389 return SCM_MEMOIZED_ENV (m
);
393 GUILE_PROC (scm_procedure_name
, "procedure-name", 1, 0, 0,
396 #define FUNC_NAME s_scm_procedure_name
398 SCM_VALIDATE_PROC(1,proc
);
399 switch (SCM_TYP7 (proc
)) {
401 return SCM_SNAME (proc
);
404 SCM name
= scm_procedure_property (proc
, scm_sym_name
);
406 /* Source property scm_sym_procname not implemented yet... */
407 SCM name
= scm_source_property (SCM_CAR (SCM_CDR (SCM_CODE (proc
))), scm_sym_procname
);
408 if (SCM_FALSEP (name
))
409 name
= scm_procedure_property (proc
, scm_sym_name
);
411 if (SCM_FALSEP (name
) && SCM_CLOSUREP (proc
))
412 name
= scm_reverse_lookup (SCM_ENV (proc
), proc
);
419 GUILE_PROC (scm_procedure_source
, "procedure-source", 1, 0, 0,
422 #define FUNC_NAME s_scm_procedure_source
424 SCM_VALIDATE_NIMP(1,proc
);
425 switch (SCM_TYP7 (proc
)) {
426 case scm_tcs_closures
:
429 src
= scm_source_property (SCM_CDR (SCM_CODE (proc
)), scm_sym_copy
);
430 if (src
!= SCM_BOOL_F
)
431 return scm_cons2 (scm_sym_lambda
, SCM_CAR (SCM_CODE (proc
)), src
);
432 src
= SCM_CODE (proc
);
433 return scm_cons (scm_sym_lambda
,
435 SCM_EXTEND_ENV (SCM_CAR (src
),
444 /* It would indeed be a nice thing if we supplied source even for
445 built in procedures! */
446 return scm_procedure_property (proc
, scm_sym_source
);
454 GUILE_PROC (scm_procedure_environment
, "procedure-environment", 1, 0, 0,
457 #define FUNC_NAME s_scm_procedure_environment
459 SCM_VALIDATE_NIMP(1,proc
);
460 switch (SCM_TYP7 (proc
)) {
461 case scm_tcs_closures
:
462 return SCM_ENV (proc
);
478 /* Eval in a local environment. We would like to have the ability to
479 * evaluate in a specified local environment, but due to the
480 * memoization this isn't normally possible. We solve it by copying
481 * the code before evaluating. One solution would be to have eval.c
482 * generate yet another evaluator. They are not very big actually.
484 GUILE_PROC (scm_local_eval
, "local-eval", 1, 1, 0,
487 #define FUNC_NAME s_scm_local_eval
489 if (SCM_UNBNDP (env
))
491 SCM_VALIDATE_MEMOIZED(1,exp
);
492 return scm_eval_3 (SCM_MEMOIZED_EXP (exp
), 0, SCM_MEMOIZED_ENV (exp
));
494 return scm_eval_3 (exp
, 1, env
);
499 SCM_REGISTER_PROC (s_reverse_lookup
, "reverse-lookup", 2, 0, 0, scm_reverse_lookup
);
503 scm_reverse_lookup (SCM env
, SCM data
)
506 while (SCM_NIMP (env
) && SCM_CONSP (SCM_CAR (env
)))
508 names
= SCM_CAAR (env
);
509 values
= SCM_CDAR (env
);
510 while (SCM_NIMP (names
) && SCM_CONSP (names
))
512 if (SCM_CAR (values
) == data
)
513 return SCM_CAR (names
);
514 names
= SCM_CDR (names
);
515 values
= SCM_CDR (values
);
517 if (names
!= SCM_EOL
&& values
== data
)
525 scm_start_stack (id
, exp
, env
)
531 scm_debug_frame vframe
;
532 scm_debug_info vframe_vect_body
;
533 vframe
.prev
= scm_last_debug_frame
;
534 vframe
.status
= SCM_VOIDFRAME
;
535 vframe
.vect
= &vframe_vect_body
;
536 vframe
.vect
[0].id
= id
;
537 scm_last_debug_frame
= &vframe
;
538 answer
= scm_eval_3 (exp
, 1, env
);
539 scm_last_debug_frame
= vframe
.prev
;
543 SCM_SYNTAX(s_start_stack
, "start-stack", scm_makacro
, scm_m_start_stack
);
546 scm_m_start_stack (exp
, env
)
551 SCM_ASSERT (SCM_NIMP (exp
)
553 && SCM_NIMP (SCM_CDR (exp
))
554 && SCM_ECONSP (SCM_CDR (exp
))
555 && SCM_NULLP (SCM_CDDR (exp
)),
559 return scm_start_stack (scm_eval_car (exp
, env
), SCM_CADR (exp
), env
);
564 * The debugging evaluator throws these on frame traps.
567 long scm_tc16_debugobj
;
570 prindebugobj (SCM obj
,SCM port
,scm_print_state
*pstate
)
572 scm_puts ("#<debug-object ", port
);
573 scm_intprint (SCM_DEBUGOBJ_FRAME (obj
), 16, port
);
574 scm_putc ('>', port
);
578 GUILE_PROC (scm_debug_object_p
, "debug-object?", 1, 0, 0,
581 #define FUNC_NAME s_scm_debug_object_p
583 return SCM_BOOL(SCM_NIMP (obj
) && SCM_DEBUGOBJP (obj
));
589 scm_make_debugobj (scm_debug_frame
*frame
)
594 SCM_SET_DEBUGOBJ_FRAME (z
, (SCM
) frame
);
595 SCM_SETCAR (z
, scm_tc16_debugobj
);
602 /* Undocumented debugging procedure */
604 GUILE_PROC (scm_debug_hang
, "debug-hang", 0, 1, 0,
607 #define FUNC_NAME s_scm_debug_hang
611 return SCM_UNSPECIFIED
;
621 scm_init_opts (scm_debug_options
, scm_debug_opts
, SCM_N_DEBUG_OPTIONS
);
623 scm_tc16_memoized
= scm_make_smob_type_mfpe ("memoized", 0,
624 scm_markcdr
, NULL
, prinmemoized
, NULL
);
626 scm_tc16_debugobj
= scm_make_smob_type_mfpe ("debug-object", 0,
627 NULL
, NULL
, prindebugobj
, NULL
);
629 scm_sym_procname
= SCM_CAR (scm_sysintern ("procname", SCM_UNDEFINED
));
630 scm_sym_dots
= SCM_CAR (scm_sysintern ("...", SCM_UNDEFINED
));
631 scm_sym_source
= SCM_CAR (scm_sysintern ("source", SCM_UNDEFINED
));
634 scm_sysintern ("SCM_IM_AND", SCM_IM_AND
);
635 scm_sysintern ("SCM_IM_BEGIN", SCM_IM_BEGIN
);
636 scm_sysintern ("SCM_IM_CASE", SCM_IM_CASE
);
637 scm_sysintern ("SCM_IM_COND", SCM_IM_COND
);
638 scm_sysintern ("SCM_IM_DO", SCM_IM_DO
);
639 scm_sysintern ("SCM_IM_IF", SCM_IM_IF
);
640 scm_sysintern ("SCM_IM_LAMBDA", SCM_IM_LAMBDA
);
641 scm_sysintern ("SCM_IM_LET", SCM_IM_LET
);
642 scm_sysintern ("SCM_IM_LETSTAR", SCM_IM_LETSTAR
);
643 scm_sysintern ("SCM_IM_LETREC", SCM_IM_LETREC
);
644 scm_sysintern ("SCM_IM_OR", SCM_IM_OR
);
645 scm_sysintern ("SCM_IM_QUOTE", SCM_IM_QUOTE
);
646 scm_sysintern ("SCM_IM_SET_X", SCM_IM_SET_X
);
647 scm_sysintern ("SCM_IM_DEFINE", SCM_IM_DEFINE
);
648 scm_sysintern ("SCM_IM_APPLY", SCM_IM_APPLY
);
649 scm_sysintern ("SCM_IM_CONT", SCM_IM_CONT
);
650 scm_sysintern ("SCM_IM_DISPATCH", SCM_IM_DISPATCH
);
652 scm_add_feature ("debug-extensions");