1 /* Scheme interface to stack frames.
3 Copyright (C) 2008-2017 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 /* See README file in this directory for implementation notes, coding
21 conventions, et.al. */
31 #include "user-regs.h"
33 #include "guile-internal.h"
35 /* The <gdb:frame> smob.
36 The typedef for this struct is in guile-internal.h. */
40 /* This always appears first. */
43 struct frame_id frame_id
;
44 struct gdbarch
*gdbarch
;
46 /* Frames are tracked by inferior.
47 We need some place to put the eq?-able hash table, and this feels as
48 good a place as any. Frames in one inferior shouldn't be considered
49 equal to frames in a different inferior. The frame becomes invalid if
50 this becomes NULL (the inferior has been deleted from gdb).
51 It's easier to relax restrictions than impose them after the fact.
52 N.B. It is an outstanding question whether a frame survives reruns of
53 the inferior. Intuitively the answer is "No", but currently a frame
54 also survives, e.g., multiple invocations of the same function from
55 the same point. Even different threads can have the same frame, e.g.,
56 if a thread dies and a new thread gets the same stack. */
57 struct inferior
*inferior
;
59 /* Marks that the FRAME_ID member actually holds the ID of the frame next
60 to this, and not this frame's ID itself. This is a hack to permit Scheme
61 frame objects which represent invalid frames (i.e., the last frame_info
62 in a corrupt stack). The problem arises from the fact that this code
63 relies on FRAME_ID to uniquely identify a frame, which is not always true
64 for the last "frame" in a corrupt stack (it can have a null ID, or the
65 same ID as the previous frame). Whenever get_prev_frame returns NULL, we
66 record the frame_id of the next frame and set FRAME_ID_IS_NEXT to 1. */
70 static const char frame_smob_name
[] = "gdb:frame";
72 /* The tag Guile knows the frame smob by. */
73 static scm_t_bits frame_smob_tag
;
75 /* Keywords used in argument passing. */
76 static SCM block_keyword
;
78 static const struct inferior_data
*frscm_inferior_data_key
;
80 /* Administrivia for frame smobs. */
82 /* Helper function to hash a frame_smob. */
85 frscm_hash_frame_smob (const void *p
)
87 const frame_smob
*f_smob
= (const frame_smob
*) p
;
88 const struct frame_id
*fid
= &f_smob
->frame_id
;
89 hashval_t hash
= htab_hash_pointer (f_smob
->inferior
);
91 if (fid
->stack_status
== FID_STACK_VALID
)
92 hash
= iterative_hash (&fid
->stack_addr
, sizeof (fid
->stack_addr
), hash
);
94 hash
= iterative_hash (&fid
->code_addr
, sizeof (fid
->code_addr
), hash
);
95 if (fid
->special_addr_p
)
96 hash
= iterative_hash (&fid
->special_addr
, sizeof (fid
->special_addr
),
102 /* Helper function to compute equality of frame_smobs. */
105 frscm_eq_frame_smob (const void *ap
, const void *bp
)
107 const frame_smob
*a
= (const frame_smob
*) ap
;
108 const frame_smob
*b
= (const frame_smob
*) bp
;
110 return (frame_id_eq (a
->frame_id
, b
->frame_id
)
111 && a
->inferior
== b
->inferior
112 && a
->inferior
!= NULL
);
115 /* Return the frame -> SCM mapping table.
116 It is created if necessary. */
119 frscm_inferior_frame_map (struct inferior
*inferior
)
121 htab_t htab
= (htab_t
) inferior_data (inferior
, frscm_inferior_data_key
);
125 htab
= gdbscm_create_eqable_gsmob_ptr_map (frscm_hash_frame_smob
,
126 frscm_eq_frame_smob
);
127 set_inferior_data (inferior
, frscm_inferior_data_key
, htab
);
133 /* The smob "free" function for <gdb:frame>. */
136 frscm_free_frame_smob (SCM self
)
138 frame_smob
*f_smob
= (frame_smob
*) SCM_SMOB_DATA (self
);
140 if (f_smob
->inferior
!= NULL
)
142 htab_t htab
= frscm_inferior_frame_map (f_smob
->inferior
);
144 gdbscm_clear_eqable_gsmob_ptr_slot (htab
, &f_smob
->base
);
147 /* Not necessary, done to catch bugs. */
148 f_smob
->inferior
= NULL
;
153 /* The smob "print" function for <gdb:frame>. */
156 frscm_print_frame_smob (SCM self
, SCM port
, scm_print_state
*pstate
)
158 frame_smob
*f_smob
= (frame_smob
*) SCM_SMOB_DATA (self
);
160 gdbscm_printf (port
, "#<%s ", frame_smob_name
);
163 fprint_frame_id (&strfile
, f_smob
->frame_id
);
164 gdbscm_printf (port
, "%s", strfile
.c_str ());
166 scm_puts (">", port
);
168 scm_remember_upto_here_1 (self
);
170 /* Non-zero means success. */
174 /* Low level routine to create a <gdb:frame> object. */
177 frscm_make_frame_smob (void)
179 frame_smob
*f_smob
= (frame_smob
*)
180 scm_gc_malloc (sizeof (frame_smob
), frame_smob_name
);
183 f_smob
->frame_id
= null_frame_id
;
184 f_smob
->gdbarch
= NULL
;
185 f_smob
->inferior
= NULL
;
186 f_smob
->frame_id_is_next
= 0;
187 f_scm
= scm_new_smob (frame_smob_tag
, (scm_t_bits
) f_smob
);
188 gdbscm_init_eqable_gsmob (&f_smob
->base
, f_scm
);
193 /* Return non-zero if SCM is a <gdb:frame> object. */
196 frscm_is_frame (SCM scm
)
198 return SCM_SMOB_PREDICATE (frame_smob_tag
, scm
);
201 /* (frame? object) -> boolean */
204 gdbscm_frame_p (SCM scm
)
206 return scm_from_bool (frscm_is_frame (scm
));
209 /* Create a new <gdb:frame> object that encapsulates FRAME.
210 Returns a <gdb:exception> object if there is an error. */
213 frscm_scm_from_frame (struct frame_info
*frame
, struct inferior
*inferior
)
215 frame_smob
*f_smob
, f_smob_for_lookup
;
218 eqable_gdb_smob
**slot
;
219 struct frame_id frame_id
= null_frame_id
;
220 struct gdbarch
*gdbarch
= NULL
;
221 int frame_id_is_next
= 0;
223 /* If we've already created a gsmob for this frame, return it.
224 This makes frames eq?-able. */
225 htab
= frscm_inferior_frame_map (inferior
);
226 f_smob_for_lookup
.frame_id
= get_frame_id (frame
);
227 f_smob_for_lookup
.inferior
= inferior
;
228 slot
= gdbscm_find_eqable_gsmob_ptr_slot (htab
, &f_smob_for_lookup
.base
);
230 return (*slot
)->containing_scm
;
234 /* Try to get the previous frame, to determine if this is the last frame
235 in a corrupt stack. If so, we need to store the frame_id of the next
236 frame and not of this one (which is possibly invalid). */
237 if (get_prev_frame (frame
) == NULL
238 && get_frame_unwind_stop_reason (frame
) != UNWIND_NO_REASON
239 && get_next_frame (frame
) != NULL
)
241 frame_id
= get_frame_id (get_next_frame (frame
));
242 frame_id_is_next
= 1;
246 frame_id
= get_frame_id (frame
);
247 frame_id_is_next
= 0;
249 gdbarch
= get_frame_arch (frame
);
251 CATCH (except
, RETURN_MASK_ALL
)
253 return gdbscm_scm_from_gdb_exception (except
);
257 f_scm
= frscm_make_frame_smob ();
258 f_smob
= (frame_smob
*) SCM_SMOB_DATA (f_scm
);
259 f_smob
->frame_id
= frame_id
;
260 f_smob
->gdbarch
= gdbarch
;
261 f_smob
->inferior
= inferior
;
262 f_smob
->frame_id_is_next
= frame_id_is_next
;
264 gdbscm_fill_eqable_gsmob_ptr_slot (slot
, &f_smob
->base
);
269 /* Create a new <gdb:frame> object that encapsulates FRAME.
270 A Scheme exception is thrown if there is an error. */
273 frscm_scm_from_frame_unsafe (struct frame_info
*frame
,
274 struct inferior
*inferior
)
276 SCM f_scm
= frscm_scm_from_frame (frame
, inferior
);
278 if (gdbscm_is_exception (f_scm
))
279 gdbscm_throw (f_scm
);
284 /* Returns the <gdb:frame> object in SELF.
285 Throws an exception if SELF is not a <gdb:frame> object. */
288 frscm_get_frame_arg_unsafe (SCM self
, int arg_pos
, const char *func_name
)
290 SCM_ASSERT_TYPE (frscm_is_frame (self
), self
, arg_pos
, func_name
,
296 /* There is no gdbscm_scm_to_frame function because translating
297 a frame SCM object to a struct frame_info * can throw a GDB error.
298 Thus code working with frames has to handle both Scheme errors (e.g., the
299 object is not a frame) and GDB errors (e.g., the frame lookup failed).
301 To help keep things clear we split what would be gdbscm_scm_to_frame
304 frscm_get_frame_smob_arg_unsafe
305 - throws a Scheme error if object is not a frame,
306 or if the inferior is gone or is no longer current
308 frscm_frame_smob_to_frame
309 - may throw a gdb error if the conversion fails
310 - it's not clear when it will and won't throw a GDB error,
311 but for robustness' sake we assume that whenever we call out to GDB
312 a GDB error may get thrown (and thus the call must be wrapped in a
315 /* Returns the frame_smob for the object wrapped by FRAME_SCM.
316 A Scheme error is thrown if FRAME_SCM is not a frame. */
319 frscm_get_frame_smob_arg_unsafe (SCM self
, int arg_pos
, const char *func_name
)
321 SCM f_scm
= frscm_get_frame_arg_unsafe (self
, arg_pos
, func_name
);
322 frame_smob
*f_smob
= (frame_smob
*) SCM_SMOB_DATA (f_scm
);
324 if (f_smob
->inferior
== NULL
)
326 gdbscm_invalid_object_error (func_name
, arg_pos
, self
,
329 if (f_smob
->inferior
!= current_inferior ())
330 scm_misc_error (func_name
, _("inferior has changed"), SCM_EOL
);
335 /* Returns the frame_info object wrapped by F_SMOB.
336 If the frame doesn't exist anymore (the frame id doesn't
337 correspond to any frame in the inferior), returns NULL.
338 This function calls GDB routines, so don't assume a GDB error will
342 frscm_frame_smob_to_frame (frame_smob
*f_smob
)
344 struct frame_info
*frame
;
346 frame
= frame_find_by_id (f_smob
->frame_id
);
350 if (f_smob
->frame_id_is_next
)
351 frame
= get_prev_frame (frame
);
356 /* Helper function for frscm_del_inferior_frames to mark the frame
360 frscm_mark_frame_invalid (void **slot
, void *info
)
362 frame_smob
*f_smob
= (frame_smob
*) *slot
;
364 f_smob
->inferior
= NULL
;
368 /* This function is called when an inferior is about to be freed.
369 Invalidate the frame as further actions on the frame could result
370 in bad data. All access to the frame should be gated by
371 frscm_get_frame_smob_arg_unsafe which will raise an exception on
375 frscm_del_inferior_frames (struct inferior
*inferior
, void *datum
)
377 htab_t htab
= (htab_t
) datum
;
381 htab_traverse_noresize (htab
, frscm_mark_frame_invalid
, NULL
);
388 /* (frame-valid? <gdb:frame>) -> bool
389 Returns #t if the frame corresponding to the frame_id of this
390 object still exists in the inferior. */
393 gdbscm_frame_valid_p (SCM self
)
396 struct frame_info
*frame
= NULL
;
398 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
402 frame
= frscm_frame_smob_to_frame (f_smob
);
404 CATCH (except
, RETURN_MASK_ALL
)
406 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
410 return scm_from_bool (frame
!= NULL
);
413 /* (frame-name <gdb:frame>) -> string
414 Returns the name of the function corresponding to this frame,
415 or #f if there is no function. */
418 gdbscm_frame_name (SCM self
)
422 enum language lang
= language_minimal
;
423 struct frame_info
*frame
= NULL
;
426 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
430 frame
= frscm_frame_smob_to_frame (f_smob
);
432 find_frame_funname (frame
, &name
, &lang
, NULL
);
434 CATCH (except
, RETURN_MASK_ALL
)
437 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
443 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
449 result
= gdbscm_scm_from_c_string (name
);
458 /* (frame-type <gdb:frame>) -> integer
459 Returns the frame type, namely one of the gdb:*_FRAME constants. */
462 gdbscm_frame_type (SCM self
)
465 enum frame_type type
= NORMAL_FRAME
;
466 struct frame_info
*frame
= NULL
;
468 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
472 frame
= frscm_frame_smob_to_frame (f_smob
);
474 type
= get_frame_type (frame
);
476 CATCH (except
, RETURN_MASK_ALL
)
478 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
484 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
488 return scm_from_int (type
);
491 /* (frame-arch <gdb:frame>) -> <gdb:architecture>
492 Returns the frame's architecture as a gdb:architecture object. */
495 gdbscm_frame_arch (SCM self
)
498 struct frame_info
*frame
= NULL
;
500 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
504 frame
= frscm_frame_smob_to_frame (f_smob
);
506 CATCH (except
, RETURN_MASK_ALL
)
508 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
514 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
518 return arscm_scm_from_arch (f_smob
->gdbarch
);
521 /* (frame-unwind-stop-reason <gdb:frame>) -> integer
522 Returns one of the gdb:FRAME_UNWIND_* constants. */
525 gdbscm_frame_unwind_stop_reason (SCM self
)
528 struct frame_info
*frame
= NULL
;
529 enum unwind_stop_reason stop_reason
;
531 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
535 frame
= frscm_frame_smob_to_frame (f_smob
);
537 CATCH (except
, RETURN_MASK_ALL
)
539 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
545 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
549 stop_reason
= get_frame_unwind_stop_reason (frame
);
551 return scm_from_int (stop_reason
);
554 /* (frame-pc <gdb:frame>) -> integer
555 Returns the frame's resume address. */
558 gdbscm_frame_pc (SCM self
)
562 struct frame_info
*frame
= NULL
;
564 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
568 frame
= frscm_frame_smob_to_frame (f_smob
);
570 pc
= get_frame_pc (frame
);
572 CATCH (except
, RETURN_MASK_ALL
)
574 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
580 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
584 return gdbscm_scm_from_ulongest (pc
);
587 /* (frame-block <gdb:frame>) -> <gdb:block>
588 Returns the frame's code block, or #f if one cannot be found. */
591 gdbscm_frame_block (SCM self
)
594 const struct block
*block
= NULL
, *fn_block
;
595 struct frame_info
*frame
= NULL
;
597 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
601 frame
= frscm_frame_smob_to_frame (f_smob
);
603 block
= get_frame_block (frame
, NULL
);
605 CATCH (except
, RETURN_MASK_ALL
)
607 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
613 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
617 for (fn_block
= block
;
618 fn_block
!= NULL
&& BLOCK_FUNCTION (fn_block
) == NULL
;
619 fn_block
= BLOCK_SUPERBLOCK (fn_block
))
622 if (block
== NULL
|| fn_block
== NULL
|| BLOCK_FUNCTION (fn_block
) == NULL
)
624 scm_misc_error (FUNC_NAME
, _("cannot find block for frame"),
630 return bkscm_scm_from_block
631 (block
, symbol_objfile (BLOCK_FUNCTION (fn_block
)));
637 /* (frame-function <gdb:frame>) -> <gdb:symbol>
638 Returns the symbol for the function corresponding to this frame,
639 or #f if there isn't one. */
642 gdbscm_frame_function (SCM self
)
645 struct symbol
*sym
= NULL
;
646 struct frame_info
*frame
= NULL
;
648 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
652 frame
= frscm_frame_smob_to_frame (f_smob
);
654 sym
= find_pc_function (get_frame_address_in_block (frame
));
656 CATCH (except
, RETURN_MASK_ALL
)
658 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
664 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
669 return syscm_scm_from_symbol (sym
);
674 /* (frame-older <gdb:frame>) -> <gdb:frame>
675 Returns the frame immediately older (outer) to this frame,
676 or #f if there isn't one. */
679 gdbscm_frame_older (SCM self
)
682 struct frame_info
*prev
= NULL
;
683 struct frame_info
*frame
= NULL
;
685 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
689 frame
= frscm_frame_smob_to_frame (f_smob
);
691 prev
= get_prev_frame (frame
);
693 CATCH (except
, RETURN_MASK_ALL
)
695 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
701 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
706 return frscm_scm_from_frame_unsafe (prev
, f_smob
->inferior
);
711 /* (frame-newer <gdb:frame>) -> <gdb:frame>
712 Returns the frame immediately newer (inner) to this frame,
713 or #f if there isn't one. */
716 gdbscm_frame_newer (SCM self
)
719 struct frame_info
*next
= NULL
;
720 struct frame_info
*frame
= NULL
;
722 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
726 frame
= frscm_frame_smob_to_frame (f_smob
);
728 next
= get_next_frame (frame
);
730 CATCH (except
, RETURN_MASK_ALL
)
732 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
738 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
743 return frscm_scm_from_frame_unsafe (next
, f_smob
->inferior
);
748 /* (frame-sal <gdb:frame>) -> <gdb:sal>
749 Returns the frame's symtab and line. */
752 gdbscm_frame_sal (SCM self
)
755 struct symtab_and_line sal
;
756 struct frame_info
*frame
= NULL
;
758 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
762 frame
= frscm_frame_smob_to_frame (f_smob
);
764 sal
= find_frame_sal (frame
);
766 CATCH (except
, RETURN_MASK_ALL
)
768 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
774 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
778 return stscm_scm_from_sal (sal
);
781 /* (frame-read-register <gdb:frame> string) -> <gdb:value>
782 The register argument must be a string. */
785 gdbscm_frame_read_register (SCM self
, SCM register_scm
)
788 struct value
*value
= NULL
;
789 struct frame_info
*frame
= NULL
;
790 struct cleanup
*cleanup
;
793 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
794 gdbscm_parse_function_args (FUNC_NAME
, SCM_ARG2
, NULL
, "s",
795 register_scm
, ®ister_str
);
796 cleanup
= make_cleanup (xfree
, register_str
);
802 frame
= frscm_frame_smob_to_frame (f_smob
);
805 regnum
= user_reg_map_name_to_regnum (get_frame_arch (frame
),
807 strlen (register_str
));
809 value
= value_of_register (regnum
, frame
);
812 CATCH (except
, RETURN_MASK_ALL
)
814 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
818 do_cleanups (cleanup
);
822 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
828 gdbscm_out_of_range_error (FUNC_NAME
, SCM_ARG2
, register_scm
,
829 _("unknown register"));
832 return vlscm_scm_from_value (value
);
835 /* (frame-read-var <gdb:frame> <gdb:symbol>) -> <gdb:value>
836 (frame-read-var <gdb:frame> string [#:block <gdb:block>]) -> <gdb:value>
837 If the optional block argument is provided start the search from that block,
838 otherwise search from the frame's current block (determined by examining
839 the resume address of the frame). The variable argument must be a string
840 or an instance of a <gdb:symbol>. The block argument must be an instance of
844 gdbscm_frame_read_var (SCM self
, SCM symbol_scm
, SCM rest
)
846 SCM keywords
[] = { block_keyword
, SCM_BOOL_F
};
849 int block_arg_pos
= -1;
850 SCM block_scm
= SCM_UNDEFINED
;
851 struct frame_info
*frame
= NULL
;
852 struct symbol
*var
= NULL
;
853 const struct block
*block
= NULL
;
854 struct value
*value
= NULL
;
856 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
860 frame
= frscm_frame_smob_to_frame (f_smob
);
862 CATCH (except
, RETURN_MASK_ALL
)
864 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
870 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
874 gdbscm_parse_function_args (FUNC_NAME
, SCM_ARG3
, keywords
, "#O",
875 rest
, &block_arg_pos
, &block_scm
);
877 if (syscm_is_symbol (symbol_scm
))
879 var
= syscm_get_valid_symbol_arg_unsafe (symbol_scm
, SCM_ARG2
,
881 SCM_ASSERT (SCM_UNBNDP (block_scm
), block_scm
, SCM_ARG3
, FUNC_NAME
);
883 else if (scm_is_string (symbol_scm
))
886 const struct block
*block
= NULL
;
887 struct cleanup
*cleanup
;
888 struct gdb_exception except
= exception_none
;
890 if (! SCM_UNBNDP (block_scm
))
894 gdb_assert (block_arg_pos
> 0);
895 block
= bkscm_scm_to_block (block_scm
, block_arg_pos
, FUNC_NAME
,
898 gdbscm_throw (except_scm
);
901 var_name
= gdbscm_scm_to_c_string (symbol_scm
);
902 cleanup
= make_cleanup (xfree
, var_name
);
903 /* N.B. Between here and the call to do_cleanups, don't do anything
904 to cause a Scheme exception without performing the cleanup. */
908 struct block_symbol lookup_sym
;
911 block
= get_frame_block (frame
, NULL
);
912 lookup_sym
= lookup_symbol (var_name
, block
, VAR_DOMAIN
, NULL
);
913 var
= lookup_sym
.symbol
;
914 block
= lookup_sym
.block
;
916 CATCH (ex
, RETURN_MASK_ALL
)
922 do_cleanups (cleanup
);
923 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
927 do_cleanups (cleanup
);
928 gdbscm_out_of_range_error (FUNC_NAME
, 0, symbol_scm
,
929 _("variable not found"));
932 do_cleanups (cleanup
);
936 /* Use SCM_ASSERT_TYPE for more consistent error messages. */
937 SCM_ASSERT_TYPE (0, symbol_scm
, SCM_ARG1
, FUNC_NAME
,
938 _("gdb:symbol or string"));
943 value
= read_var_value (var
, block
, frame
);
945 CATCH (except
, RETURN_MASK_ALL
)
947 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
951 return vlscm_scm_from_value (value
);
954 /* (frame-select <gdb:frame>) -> unspecified
955 Select this frame. */
958 gdbscm_frame_select (SCM self
)
961 struct frame_info
*frame
= NULL
;
963 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
967 frame
= frscm_frame_smob_to_frame (f_smob
);
969 select_frame (frame
);
971 CATCH (except
, RETURN_MASK_ALL
)
973 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
979 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
983 return SCM_UNSPECIFIED
;
986 /* (newest-frame) -> <gdb:frame>
987 Returns the newest frame. */
990 gdbscm_newest_frame (void)
992 struct frame_info
*frame
= NULL
;
996 frame
= get_current_frame ();
998 CATCH (except
, RETURN_MASK_ALL
)
1000 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
1004 return frscm_scm_from_frame_unsafe (frame
, current_inferior ());
1007 /* (selected-frame) -> <gdb:frame>
1008 Returns the selected frame. */
1011 gdbscm_selected_frame (void)
1013 struct frame_info
*frame
= NULL
;
1017 frame
= get_selected_frame (_("No frame is currently selected"));
1019 CATCH (except
, RETURN_MASK_ALL
)
1021 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
1025 return frscm_scm_from_frame_unsafe (frame
, current_inferior ());
1028 /* (unwind-stop-reason-string integer) -> string
1029 Return a string explaining the unwind stop reason. */
1032 gdbscm_unwind_stop_reason_string (SCM reason_scm
)
1037 gdbscm_parse_function_args (FUNC_NAME
, SCM_ARG1
, NULL
, "i",
1038 reason_scm
, &reason
);
1040 if (reason
< UNWIND_FIRST
|| reason
> UNWIND_LAST
)
1041 scm_out_of_range (FUNC_NAME
, reason_scm
);
1043 str
= unwind_stop_reason_to_string ((enum unwind_stop_reason
) reason
);
1044 return gdbscm_scm_from_c_string (str
);
1047 /* Initialize the Scheme frame support. */
1049 static const scheme_integer_constant frame_integer_constants
[] =
1051 #define ENTRY(X) { #X, X }
1053 ENTRY (NORMAL_FRAME
),
1054 ENTRY (DUMMY_FRAME
),
1055 ENTRY (INLINE_FRAME
),
1056 ENTRY (TAILCALL_FRAME
),
1057 ENTRY (SIGTRAMP_FRAME
),
1059 ENTRY (SENTINEL_FRAME
),
1063 #define SET(name, description) \
1064 { "FRAME_" #name, name },
1065 #include "unwind_stop_reasons.def"
1068 END_INTEGER_CONSTANTS
1071 static const scheme_function frame_functions
[] =
1073 { "frame?", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_p
),
1075 Return #t if the object is a <gdb:frame> object." },
1077 { "frame-valid?", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_valid_p
),
1079 Return #t if the object is a valid <gdb:frame> object.\n\
1080 Frames become invalid when the inferior returns to its caller." },
1082 { "frame-name", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_name
),
1084 Return the name of the function corresponding to this frame,\n\
1085 or #f if there is no function." },
1087 { "frame-arch", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_arch
),
1089 Return the frame's architecture as a <gdb:arch> object." },
1091 { "frame-type", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_type
),
1093 Return the frame type, namely one of the gdb:*_FRAME constants." },
1095 { "frame-unwind-stop-reason", 1, 0, 0,
1096 as_a_scm_t_subr (gdbscm_frame_unwind_stop_reason
),
1098 Return one of the gdb:FRAME_UNWIND_* constants explaining why\n\
1099 it's not possible to find frames older than this." },
1101 { "frame-pc", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_pc
),
1103 Return the frame's resume address." },
1105 { "frame-block", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_block
),
1107 Return the frame's code block, or #f if one cannot be found." },
1109 { "frame-function", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_function
),
1111 Return the <gdb:symbol> for the function corresponding to this frame,\n\
1112 or #f if there isn't one." },
1114 { "frame-older", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_older
),
1116 Return the frame immediately older (outer) to this frame,\n\
1117 or #f if there isn't one." },
1119 { "frame-newer", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_newer
),
1121 Return the frame immediately newer (inner) to this frame,\n\
1122 or #f if there isn't one." },
1124 { "frame-sal", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_sal
),
1126 Return the frame's symtab-and-line <gdb:sal> object." },
1128 { "frame-read-var", 2, 0, 1, as_a_scm_t_subr (gdbscm_frame_read_var
),
1130 Return the value of the symbol in the frame.\n\
1132 Arguments: <gdb:frame> <gdb:symbol>\n\
1133 Or: <gdb:frame> string [#:block <gdb:block>]" },
1135 { "frame-read-register", 2, 0, 0,
1136 as_a_scm_t_subr (gdbscm_frame_read_register
),
1138 Return the value of the register in the frame.\n\
1140 Arguments: <gdb:frame> string" },
1142 { "frame-select", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_select
),
1144 Select this frame." },
1146 { "newest-frame", 0, 0, 0, as_a_scm_t_subr (gdbscm_newest_frame
),
1148 Return the newest frame." },
1150 { "selected-frame", 0, 0, 0, as_a_scm_t_subr (gdbscm_selected_frame
),
1152 Return the selected frame." },
1154 { "unwind-stop-reason-string", 1, 0, 0,
1155 as_a_scm_t_subr (gdbscm_unwind_stop_reason_string
),
1157 Return a string explaining the unwind stop reason.\n\
1159 Arguments: integer (the result of frame-unwind-stop-reason)" },
1165 gdbscm_initialize_frames (void)
1168 = gdbscm_make_smob_type (frame_smob_name
, sizeof (frame_smob
));
1169 scm_set_smob_free (frame_smob_tag
, frscm_free_frame_smob
);
1170 scm_set_smob_print (frame_smob_tag
, frscm_print_frame_smob
);
1172 gdbscm_define_integer_constants (frame_integer_constants
, 1);
1173 gdbscm_define_functions (frame_functions
, 1);
1175 block_keyword
= scm_from_latin1_keyword ("block");
1177 /* Register an inferior "free" callback so we can properly
1178 invalidate frames when an inferior file is about to be deleted. */
1179 frscm_inferior_data_key
1180 = register_inferior_data_with_cleanup (NULL
, frscm_del_inferior_frames
);