2002-07-20 Han-Wen <hanwen@cs.uu.nl>
[bpt/guile.git] / libguile / debug.c
1 /* Debugging extensions for Guile
2 * Copyright (C) 1995,1996,1997,1998,1999,2000,2001 Free Software Foundation
3 *
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)
7 * any later version.
8 *
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.
13 *
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
18 *
19 * As a special exception, the Free Software Foundation gives permission
20 * for additional uses of the text contained in its release of GUILE.
21 *
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.
27 *
28 * This exception does not however invalidate any other reasons why
29 * the executable file might be covered by the GNU General Public License.
30 *
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.
38 *
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.
42 *
43 * The author can be reached at djurfeldt@nada.kth.se
44 * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN */
45
46
47
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"
67
68 #include "libguile/validate.h"
69 #include "libguile/debug.h"
70 \f
71
72 /* {Run time control of the debugging evaluator}
73 */
74
75 SCM_DEFINE (scm_debug_options, "debug-options-interface", 0, 1, 0,
76 (SCM setting),
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 @code{debug-options}.")
80 #define FUNC_NAME s_scm_debug_options
81 {
82 SCM ans;
83 SCM_DEFER_INTS;
84 ans = scm_options (setting, scm_debug_opts, SCM_N_DEBUG_OPTIONS, FUNC_NAME);
85 if (!(1 <= SCM_N_FRAMES && SCM_N_FRAMES <= SCM_MAX_FRAME_SIZE))
86 {
87 scm_options (ans, scm_debug_opts, SCM_N_DEBUG_OPTIONS, FUNC_NAME);
88 SCM_OUT_OF_RANGE (1, setting);
89 }
90 SCM_RESET_DEBUG_MODE;
91 scm_stack_checking_enabled_p = SCM_STACK_CHECKING_P;
92 scm_debug_eframe_size = 2 * SCM_N_FRAMES;
93 SCM_ALLOW_INTS;
94 return ans;
95 }
96 #undef FUNC_NAME
97
98 static void
99 with_traps_before (void *data)
100 {
101 int *trap_flag = data;
102 *trap_flag = SCM_TRAPS_P;
103 SCM_TRAPS_P = 1;
104 }
105
106 static void
107 with_traps_after (void *data)
108 {
109 int *trap_flag = data;
110 SCM_TRAPS_P = *trap_flag;
111 }
112
113 static SCM
114 with_traps_inner (void *data)
115 {
116 SCM thunk = SCM_PACK (data);
117 return scm_call_0 (thunk);
118 }
119
120 SCM_DEFINE (scm_with_traps, "with-traps", 1, 0, 0,
121 (SCM thunk),
122 "Call @var{thunk} with traps enabled.")
123 #define FUNC_NAME s_scm_with_traps
124 {
125 int trap_flag;
126 SCM_VALIDATE_THUNK (1, thunk);
127 return scm_internal_dynamic_wind (with_traps_before,
128 with_traps_inner,
129 with_traps_after,
130 (void *) SCM_UNPACK (thunk),
131 &trap_flag);
132 }
133 #undef FUNC_NAME
134
135 \f
136
137 SCM_SYMBOL (scm_sym_procname, "procname");
138 SCM_SYMBOL (scm_sym_dots, "...");
139 SCM_SYMBOL (scm_sym_source, "source");
140
141 /* {Memoized Source}
142 */
143
144 scm_t_bits scm_tc16_memoized;
145
146 static int
147 memoized_print (SCM obj, SCM port, scm_print_state *pstate)
148 {
149 int writingp = SCM_WRITINGP (pstate);
150 scm_puts ("#<memoized ", port);
151 SCM_SET_WRITINGP (pstate, 1);
152 #ifdef GUILE_DEBUG
153 scm_iprin1 (SCM_MEMOIZED_EXP (obj), port, pstate);
154 #else
155 scm_iprin1 (scm_unmemoize (obj), port, pstate);
156 #endif
157 SCM_SET_WRITINGP (pstate, writingp);
158 scm_putc ('>', port);
159 return 1;
160 }
161
162 SCM_DEFINE (scm_memoized_p, "memoized?", 1, 0, 0,
163 (SCM obj),
164 "Return @code{#t} if @var{obj} is memoized.")
165 #define FUNC_NAME s_scm_memoized_p
166 {
167 return SCM_BOOL(SCM_MEMOIZEDP (obj));
168 }
169 #undef FUNC_NAME
170
171 SCM
172 scm_make_memoized (SCM exp, SCM env)
173 {
174 /* *fixme* Check that env is a valid environment. */
175 register SCM z, ans;
176 SCM_ENTER_A_SECTION;
177 SCM_NEWSMOB (z, SCM_UNPACK (exp), SCM_UNPACK (env));
178 SCM_NEWSMOB (ans, scm_tc16_memoized, SCM_UNPACK (z));
179 SCM_EXIT_A_SECTION;
180 return ans;
181 }
182
183 #ifdef GUILE_DEBUG
184 /*
185 * Some primitives for construction of memoized code
186 *
187 * - procedure: memcons CAR CDR [ENV]
188 *
189 * Construct a pair, encapsulated in a memoized object.
190 *
191 * The CAR and CDR can be either normal or memoized. If ENV isn't
192 * specified, the top-level environment of the current module will
193 * be assumed. All environments must match.
194 *
195 * - procedure: make-iloc FRAME BINDING CDRP
196 *
197 * Return an iloc referring to frame no. FRAME, binding
198 * no. BINDING. If CDRP is non-#f, the iloc is referring to a
199 * frame consisting of a single pair, with the value stored in the
200 * CDR.
201 *
202 * - procedure: iloc? OBJECT
203 *
204 * Return #t if OBJECT is an iloc.
205 *
206 * - procedure: mem->proc MEMOIZED
207 *
208 * Construct a closure from the memoized lambda expression MEMOIZED
209 *
210 * WARNING! The code is not copied!
211 *
212 * - procedure: proc->mem CLOSURE
213 *
214 * Turn the closure CLOSURE into a memoized object.
215 *
216 * WARNING! The code is not copied!
217 *
218 * - constant: SCM_IM_AND
219 * - constant: SCM_IM_BEGIN
220 * - constant: SCM_IM_CASE
221 * - constant: SCM_IM_COND
222 * - constant: SCM_IM_DO
223 * - constant: SCM_IM_IF
224 * - constant: SCM_IM_LAMBDA
225 * - constant: SCM_IM_LET
226 * - constant: SCM_IM_LETSTAR
227 * - constant: SCM_IM_LETREC
228 * - constant: SCM_IM_OR
229 * - constant: SCM_IM_QUOTE
230 * - constant: SCM_IM_SET
231 * - constant: SCM_IM_DEFINE
232 * - constant: SCM_IM_APPLY
233 * - constant: SCM_IM_CONT
234 * - constant: SCM_IM_DISPATCH
235 */
236
237 #include "libguile/variable.h"
238 #include "libguile/procs.h"
239
240 SCM_DEFINE (scm_make_iloc, "make-iloc", 3, 0, 0,
241 (SCM frame, SCM binding, SCM cdrp),
242 "Return a new iloc with frame offset @var{frame}, binding\n"
243 "offset @var{binding} and the cdr flag @var{cdrp}.")
244 #define FUNC_NAME s_scm_make_iloc
245 {
246 SCM_VALIDATE_INUM (1, frame);
247 SCM_VALIDATE_INUM (2, binding);
248 return SCM_PACK (SCM_UNPACK (SCM_ILOC00)
249 + SCM_IFRINC * SCM_INUM (frame)
250 + (!SCM_FALSEP (cdrp) ? SCM_ICDR : 0)
251 + SCM_IDINC * SCM_INUM (binding));
252 }
253 #undef FUNC_NAME
254
255 SCM_DEFINE (scm_iloc_p, "iloc?", 1, 0, 0,
256 (SCM obj),
257 "Return @code{#t} if @var{obj} is an iloc.")
258 #define FUNC_NAME s_scm_iloc_p
259 {
260 return SCM_BOOL(SCM_ILOCP (obj));
261 }
262 #undef FUNC_NAME
263
264 SCM_DEFINE (scm_memcons, "memcons", 2, 1, 0,
265 (SCM car, SCM cdr, SCM env),
266 "Return a new memoized cons cell with @var{car} and @var{cdr}\n"
267 "as members and @var{env} as the environment.")
268 #define FUNC_NAME s_scm_memcons
269 {
270 if (SCM_MEMOIZEDP (car))
271 {
272 /*fixme* environments may be two different but equal top-level envs */
273 if (!SCM_UNBNDP (env) && SCM_MEMOIZED_ENV (car) != env)
274 SCM_MISC_ERROR ("environment mismatch arg1 <-> arg3",
275 scm_list_2 (car, env));
276 else
277 env = SCM_MEMOIZED_ENV (car);
278 car = SCM_MEMOIZED_EXP (car);
279 }
280 if (SCM_MEMOIZEDP (cdr))
281 {
282 if (!SCM_UNBNDP (env) && SCM_MEMOIZED_ENV (cdr) != env)
283 SCM_MISC_ERROR ("environment mismatch arg2 <-> arg3",
284 scm_list_2 (cdr, env));
285 else
286 env = SCM_MEMOIZED_ENV (cdr);
287 cdr = SCM_MEMOIZED_EXP (cdr);
288 }
289 if (SCM_UNBNDP (env))
290 env = scm_top_level_env (SCM_TOP_LEVEL_LOOKUP_CLOSURE);
291 else
292 SCM_VALIDATE_NULLORCONS (3, env);
293 return scm_make_memoized (scm_cons (car, cdr), env);
294 }
295 #undef FUNC_NAME
296
297 SCM_DEFINE (scm_mem_to_proc, "mem->proc", 1, 0, 0,
298 (SCM obj),
299 "Convert a memoized object (which must be a lambda expression)\n"
300 "to a procedure.")
301 #define FUNC_NAME s_scm_mem_to_proc
302 {
303 SCM env;
304 SCM_VALIDATE_MEMOIZED (1, obj);
305 env = SCM_MEMOIZED_ENV (obj);
306 obj = SCM_MEMOIZED_EXP (obj);
307 if (!SCM_CONSP (obj) || !SCM_EQ_P (SCM_CAR (obj), SCM_IM_LAMBDA))
308 SCM_MISC_ERROR ("expected lambda expression", scm_list_1 (obj));
309 return scm_closure (SCM_CDR (obj), env);
310 }
311 #undef FUNC_NAME
312
313 SCM_DEFINE (scm_proc_to_mem, "proc->mem", 1, 0, 0,
314 (SCM obj),
315 "Convert a procedure to a memoized object.")
316 #define FUNC_NAME s_scm_proc_to_mem
317 {
318 SCM_VALIDATE_CLOSURE (1, obj);
319 return scm_make_memoized (scm_cons (SCM_IM_LAMBDA, SCM_CODE (obj)),
320 SCM_ENV (obj));
321 }
322 #undef FUNC_NAME
323
324 #endif /* GUILE_DEBUG */
325
326 SCM_DEFINE (scm_unmemoize, "unmemoize", 1, 0, 0,
327 (SCM m),
328 "Unmemoize the memoized expression @var{m},")
329 #define FUNC_NAME s_scm_unmemoize
330 {
331 SCM_VALIDATE_MEMOIZED (1, m);
332 return scm_unmemocopy (SCM_MEMOIZED_EXP (m), SCM_MEMOIZED_ENV (m));
333 }
334 #undef FUNC_NAME
335
336 SCM_DEFINE (scm_memoized_environment, "memoized-environment", 1, 0, 0,
337 (SCM m),
338 "Return the environment of the memoized expression @var{m}.")
339 #define FUNC_NAME s_scm_memoized_environment
340 {
341 SCM_VALIDATE_MEMOIZED (1, m);
342 return SCM_MEMOIZED_ENV (m);
343 }
344 #undef FUNC_NAME
345
346 SCM_DEFINE (scm_procedure_name, "procedure-name", 1, 0, 0,
347 (SCM proc),
348 "Return the name of the procedure @var{proc}")
349 #define FUNC_NAME s_scm_procedure_name
350 {
351 SCM_VALIDATE_PROC (1, proc);
352 switch (SCM_TYP7 (proc)) {
353 case scm_tcs_subrs:
354 return SCM_SNAME (proc);
355 default:
356 {
357 SCM name = scm_procedure_property (proc, scm_sym_name);
358 #if 0
359 /* Source property scm_sym_procname not implemented yet... */
360 SCM name = scm_source_property (SCM_CAR (SCM_CLOSURE_BODY (proc)), scm_sym_procname);
361 if (SCM_FALSEP (name))
362 name = scm_procedure_property (proc, scm_sym_name);
363 #endif
364 if (SCM_FALSEP (name) && SCM_CLOSUREP (proc))
365 name = scm_reverse_lookup (SCM_ENV (proc), proc);
366 return name;
367 }
368 }
369 }
370 #undef FUNC_NAME
371
372 SCM_DEFINE (scm_procedure_source, "procedure-source", 1, 0, 0,
373 (SCM proc),
374 "Return the source of the procedure @var{proc}.")
375 #define FUNC_NAME s_scm_procedure_source
376 {
377 SCM_VALIDATE_NIM (1, proc);
378 switch (SCM_TYP7 (proc)) {
379 case scm_tcs_closures:
380 {
381 SCM formals = SCM_CLOSURE_FORMALS (proc);
382 SCM src = scm_source_property (SCM_CLOSURE_BODY (proc), scm_sym_copy);
383 if (!SCM_FALSEP (src))
384 return scm_cons2 (scm_sym_lambda, formals, src);
385 return scm_cons (scm_sym_lambda,
386 scm_unmemocopy (SCM_CODE (proc),
387 SCM_EXTEND_ENV (formals,
388 SCM_EOL,
389 SCM_ENV (proc))));
390 }
391 case scm_tcs_subrs:
392 #ifdef CCLO
393 case scm_tc7_cclo:
394 #endif
395 /* It would indeed be a nice thing if we supplied source even for
396 built in procedures! */
397 return scm_procedure_property (proc, scm_sym_source);
398 default:
399 SCM_WRONG_TYPE_ARG (1, proc);
400 /* not reached */
401 }
402 }
403 #undef FUNC_NAME
404
405 SCM_DEFINE (scm_procedure_environment, "procedure-environment", 1, 0, 0,
406 (SCM proc),
407 "Return the environment of the procedure @var{proc}.")
408 #define FUNC_NAME s_scm_procedure_environment
409 {
410 SCM_VALIDATE_NIM (1, proc);
411 switch (SCM_TYP7 (proc)) {
412 case scm_tcs_closures:
413 return SCM_ENV (proc);
414 case scm_tcs_subrs:
415 #ifdef CCLO
416 case scm_tc7_cclo:
417 #endif
418 return SCM_EOL;
419 default:
420 SCM_WRONG_TYPE_ARG (1, proc);
421 /* not reached */
422 }
423 }
424 #undef FUNC_NAME
425
426 \f
427
428 /* Eval in a local environment. We would like to have the ability to
429 * evaluate in a specified local environment, but due to the
430 * memoization this isn't normally possible. We solve it by copying
431 * the code before evaluating. One solution would be to have eval.c
432 * generate yet another evaluator. They are not very big actually.
433 */
434 SCM_DEFINE (scm_local_eval, "local-eval", 1, 1, 0,
435 (SCM exp, SCM env),
436 "Evaluate @var{exp} in its environment. If @var{env} is supplied,\n"
437 "it is the environment in which to evaluate @var{exp}. Otherwise,\n"
438 "@var{exp} must be a memoized code object (in which case, its environment\n"
439 "is implicit).")
440 #define FUNC_NAME s_scm_local_eval
441 {
442 if (SCM_UNBNDP (env))
443 {
444 SCM_VALIDATE_MEMOIZED (1, exp);
445 return scm_i_eval_x (SCM_MEMOIZED_EXP (exp), SCM_MEMOIZED_ENV (exp));
446 }
447 return scm_i_eval (exp, env);
448 }
449 #undef FUNC_NAME
450
451 #if 0
452 SCM_REGISTER_PROC (s_reverse_lookup, "reverse-lookup", 2, 0, 0, scm_reverse_lookup);
453 #endif
454
455 SCM
456 scm_reverse_lookup (SCM env, SCM data)
457 {
458 while (SCM_CONSP (env) && SCM_CONSP (SCM_CAR (env)))
459 {
460 SCM names = SCM_CAAR (env);
461 SCM values = SCM_CDAR (env);
462 while (SCM_CONSP (names))
463 {
464 if (SCM_EQ_P (SCM_CAR (values), data))
465 return SCM_CAR (names);
466 names = SCM_CDR (names);
467 values = SCM_CDR (values);
468 }
469 if (!SCM_NULLP (names) && SCM_EQ_P (values, data))
470 return names;
471 env = SCM_CDR (env);
472 }
473 return SCM_BOOL_F;
474 }
475
476 SCM
477 scm_start_stack (SCM id, SCM exp, SCM env)
478 {
479 SCM answer;
480 scm_t_debug_frame vframe;
481 scm_t_debug_info vframe_vect_body;
482 vframe.prev = scm_last_debug_frame;
483 vframe.status = SCM_VOIDFRAME;
484 vframe.vect = &vframe_vect_body;
485 vframe.vect[0].id = id;
486 scm_last_debug_frame = &vframe;
487 answer = scm_i_eval (exp, env);
488 scm_last_debug_frame = vframe.prev;
489 return answer;
490 }
491
492 SCM_SYNTAX(s_start_stack, "start-stack", scm_makacro, scm_m_start_stack);
493
494 static SCM
495 scm_m_start_stack (SCM exp, SCM env)
496 #define FUNC_NAME s_start_stack
497 {
498 exp = SCM_CDR (exp);
499 if (!SCM_CONSP (exp)
500 || !SCM_CONSP (SCM_CDR (exp))
501 || !SCM_NULLP (SCM_CDDR (exp)))
502 SCM_WRONG_NUM_ARGS ();
503 return scm_start_stack (scm_eval_car (exp, env), SCM_CADR (exp), env);
504 }
505 #undef FUNC_NAME
506
507
508 /* {Debug Objects}
509 *
510 * The debugging evaluator throws these on frame traps.
511 */
512
513 scm_t_bits scm_tc16_debugobj;
514
515 static int
516 debugobj_print (SCM obj, SCM port, scm_print_state *pstate SCM_UNUSED)
517 {
518 scm_puts ("#<debug-object ", port);
519 scm_intprint ((long) SCM_DEBUGOBJ_FRAME (obj), 16, port);
520 scm_putc ('>', port);
521 return 1;
522 }
523
524 SCM_DEFINE (scm_debug_object_p, "debug-object?", 1, 0, 0,
525 (SCM obj),
526 "Return @code{#t} if @var{obj} is a debug object.")
527 #define FUNC_NAME s_scm_debug_object_p
528 {
529 return SCM_BOOL(SCM_DEBUGOBJP (obj));
530 }
531 #undef FUNC_NAME
532
533
534 SCM
535 scm_make_debugobj (scm_t_debug_frame *frame)
536 {
537 return scm_cell (scm_tc16_debugobj, (scm_t_bits) frame);
538 }
539
540 \f
541
542 /* Undocumented debugging procedure */
543 #ifdef GUILE_DEBUG
544 SCM_DEFINE (scm_debug_hang, "debug-hang", 0, 1, 0,
545 (SCM obj),
546 "Go into an endless loop, which can be only terminated with\n"
547 "a debugger.")
548 #define FUNC_NAME s_scm_debug_hang
549 {
550 int go = 0;
551 while (!go) ;
552 return SCM_UNSPECIFIED;
553 }
554 #undef FUNC_NAME
555 #endif
556
557 \f
558
559 void
560 scm_init_debug ()
561 {
562 scm_init_opts (scm_debug_options, scm_debug_opts, SCM_N_DEBUG_OPTIONS);
563
564 scm_tc16_memoized = scm_make_smob_type ("memoized", 0);
565 scm_set_smob_mark (scm_tc16_memoized, scm_markcdr);
566 scm_set_smob_print (scm_tc16_memoized, memoized_print);
567
568 scm_tc16_debugobj = scm_make_smob_type ("debug-object", 0);
569 scm_set_smob_print (scm_tc16_debugobj, debugobj_print);
570
571 #ifdef GUILE_DEBUG
572 scm_c_define ("SCM_IM_AND", SCM_IM_AND);
573 scm_c_define ("SCM_IM_BEGIN", SCM_IM_BEGIN);
574 scm_c_define ("SCM_IM_CASE", SCM_IM_CASE);
575 scm_c_define ("SCM_IM_COND", SCM_IM_COND);
576 scm_c_define ("SCM_IM_DO", SCM_IM_DO);
577 scm_c_define ("SCM_IM_IF", SCM_IM_IF);
578 scm_c_define ("SCM_IM_LAMBDA", SCM_IM_LAMBDA);
579 scm_c_define ("SCM_IM_LET", SCM_IM_LET);
580 scm_c_define ("SCM_IM_LETSTAR", SCM_IM_LETSTAR);
581 scm_c_define ("SCM_IM_LETREC", SCM_IM_LETREC);
582 scm_c_define ("SCM_IM_OR", SCM_IM_OR);
583 scm_c_define ("SCM_IM_QUOTE", SCM_IM_QUOTE);
584 scm_c_define ("SCM_IM_SET_X", SCM_IM_SET_X);
585 scm_c_define ("SCM_IM_DEFINE", SCM_IM_DEFINE);
586 scm_c_define ("SCM_IM_APPLY", SCM_IM_APPLY);
587 scm_c_define ("SCM_IM_CONT", SCM_IM_CONT);
588 scm_c_define ("SCM_IM_DISPATCH", SCM_IM_DISPATCH);
589 #endif
590 scm_add_feature ("debug-extensions");
591
592 #include "libguile/debug.x"
593 }
594
595 /*
596 Local Variables:
597 c-file-style: "gnu"
598 End:
599 */