1 /* Scheme interface to stack frames.
3 Copyright (C) 2008-2016 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
);
159 struct ui_file
*strfile
;
161 gdbscm_printf (port
, "#<%s ", frame_smob_name
);
163 strfile
= mem_fileopen ();
164 fprint_frame_id (strfile
, f_smob
->frame_id
);
165 std::string s
= ui_file_as_string (strfile
);
166 gdbscm_printf (port
, "%s", s
.c_str ());
167 ui_file_delete (strfile
);
169 scm_puts (">", port
);
171 scm_remember_upto_here_1 (self
);
173 /* Non-zero means success. */
177 /* Low level routine to create a <gdb:frame> object. */
180 frscm_make_frame_smob (void)
182 frame_smob
*f_smob
= (frame_smob
*)
183 scm_gc_malloc (sizeof (frame_smob
), frame_smob_name
);
186 f_smob
->frame_id
= null_frame_id
;
187 f_smob
->gdbarch
= NULL
;
188 f_smob
->inferior
= NULL
;
189 f_smob
->frame_id_is_next
= 0;
190 f_scm
= scm_new_smob (frame_smob_tag
, (scm_t_bits
) f_smob
);
191 gdbscm_init_eqable_gsmob (&f_smob
->base
, f_scm
);
196 /* Return non-zero if SCM is a <gdb:frame> object. */
199 frscm_is_frame (SCM scm
)
201 return SCM_SMOB_PREDICATE (frame_smob_tag
, scm
);
204 /* (frame? object) -> boolean */
207 gdbscm_frame_p (SCM scm
)
209 return scm_from_bool (frscm_is_frame (scm
));
212 /* Create a new <gdb:frame> object that encapsulates FRAME.
213 Returns a <gdb:exception> object if there is an error. */
216 frscm_scm_from_frame (struct frame_info
*frame
, struct inferior
*inferior
)
218 frame_smob
*f_smob
, f_smob_for_lookup
;
221 eqable_gdb_smob
**slot
;
222 struct frame_id frame_id
= null_frame_id
;
223 struct gdbarch
*gdbarch
= NULL
;
224 int frame_id_is_next
= 0;
226 /* If we've already created a gsmob for this frame, return it.
227 This makes frames eq?-able. */
228 htab
= frscm_inferior_frame_map (inferior
);
229 f_smob_for_lookup
.frame_id
= get_frame_id (frame
);
230 f_smob_for_lookup
.inferior
= inferior
;
231 slot
= gdbscm_find_eqable_gsmob_ptr_slot (htab
, &f_smob_for_lookup
.base
);
233 return (*slot
)->containing_scm
;
237 /* Try to get the previous frame, to determine if this is the last frame
238 in a corrupt stack. If so, we need to store the frame_id of the next
239 frame and not of this one (which is possibly invalid). */
240 if (get_prev_frame (frame
) == NULL
241 && get_frame_unwind_stop_reason (frame
) != UNWIND_NO_REASON
242 && get_next_frame (frame
) != NULL
)
244 frame_id
= get_frame_id (get_next_frame (frame
));
245 frame_id_is_next
= 1;
249 frame_id
= get_frame_id (frame
);
250 frame_id_is_next
= 0;
252 gdbarch
= get_frame_arch (frame
);
254 CATCH (except
, RETURN_MASK_ALL
)
256 return gdbscm_scm_from_gdb_exception (except
);
260 f_scm
= frscm_make_frame_smob ();
261 f_smob
= (frame_smob
*) SCM_SMOB_DATA (f_scm
);
262 f_smob
->frame_id
= frame_id
;
263 f_smob
->gdbarch
= gdbarch
;
264 f_smob
->inferior
= inferior
;
265 f_smob
->frame_id_is_next
= frame_id_is_next
;
267 gdbscm_fill_eqable_gsmob_ptr_slot (slot
, &f_smob
->base
);
272 /* Create a new <gdb:frame> object that encapsulates FRAME.
273 A Scheme exception is thrown if there is an error. */
276 frscm_scm_from_frame_unsafe (struct frame_info
*frame
,
277 struct inferior
*inferior
)
279 SCM f_scm
= frscm_scm_from_frame (frame
, inferior
);
281 if (gdbscm_is_exception (f_scm
))
282 gdbscm_throw (f_scm
);
287 /* Returns the <gdb:frame> object in SELF.
288 Throws an exception if SELF is not a <gdb:frame> object. */
291 frscm_get_frame_arg_unsafe (SCM self
, int arg_pos
, const char *func_name
)
293 SCM_ASSERT_TYPE (frscm_is_frame (self
), self
, arg_pos
, func_name
,
299 /* There is no gdbscm_scm_to_frame function because translating
300 a frame SCM object to a struct frame_info * can throw a GDB error.
301 Thus code working with frames has to handle both Scheme errors (e.g., the
302 object is not a frame) and GDB errors (e.g., the frame lookup failed).
304 To help keep things clear we split what would be gdbscm_scm_to_frame
307 frscm_get_frame_smob_arg_unsafe
308 - throws a Scheme error if object is not a frame,
309 or if the inferior is gone or is no longer current
311 frscm_frame_smob_to_frame
312 - may throw a gdb error if the conversion fails
313 - it's not clear when it will and won't throw a GDB error,
314 but for robustness' sake we assume that whenever we call out to GDB
315 a GDB error may get thrown (and thus the call must be wrapped in a
318 /* Returns the frame_smob for the object wrapped by FRAME_SCM.
319 A Scheme error is thrown if FRAME_SCM is not a frame. */
322 frscm_get_frame_smob_arg_unsafe (SCM self
, int arg_pos
, const char *func_name
)
324 SCM f_scm
= frscm_get_frame_arg_unsafe (self
, arg_pos
, func_name
);
325 frame_smob
*f_smob
= (frame_smob
*) SCM_SMOB_DATA (f_scm
);
327 if (f_smob
->inferior
== NULL
)
329 gdbscm_invalid_object_error (func_name
, arg_pos
, self
,
332 if (f_smob
->inferior
!= current_inferior ())
333 scm_misc_error (func_name
, _("inferior has changed"), SCM_EOL
);
338 /* Returns the frame_info object wrapped by F_SMOB.
339 If the frame doesn't exist anymore (the frame id doesn't
340 correspond to any frame in the inferior), returns NULL.
341 This function calls GDB routines, so don't assume a GDB error will
345 frscm_frame_smob_to_frame (frame_smob
*f_smob
)
347 struct frame_info
*frame
;
349 frame
= frame_find_by_id (f_smob
->frame_id
);
353 if (f_smob
->frame_id_is_next
)
354 frame
= get_prev_frame (frame
);
359 /* Helper function for frscm_del_inferior_frames to mark the frame
363 frscm_mark_frame_invalid (void **slot
, void *info
)
365 frame_smob
*f_smob
= (frame_smob
*) *slot
;
367 f_smob
->inferior
= NULL
;
371 /* This function is called when an inferior is about to be freed.
372 Invalidate the frame as further actions on the frame could result
373 in bad data. All access to the frame should be gated by
374 frscm_get_frame_smob_arg_unsafe which will raise an exception on
378 frscm_del_inferior_frames (struct inferior
*inferior
, void *datum
)
380 htab_t htab
= (htab_t
) datum
;
384 htab_traverse_noresize (htab
, frscm_mark_frame_invalid
, NULL
);
391 /* (frame-valid? <gdb:frame>) -> bool
392 Returns #t if the frame corresponding to the frame_id of this
393 object still exists in the inferior. */
396 gdbscm_frame_valid_p (SCM self
)
399 struct frame_info
*frame
= NULL
;
401 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
405 frame
= frscm_frame_smob_to_frame (f_smob
);
407 CATCH (except
, RETURN_MASK_ALL
)
409 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
413 return scm_from_bool (frame
!= NULL
);
416 /* (frame-name <gdb:frame>) -> string
417 Returns the name of the function corresponding to this frame,
418 or #f if there is no function. */
421 gdbscm_frame_name (SCM self
)
425 enum language lang
= language_minimal
;
426 struct frame_info
*frame
= NULL
;
429 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
433 frame
= frscm_frame_smob_to_frame (f_smob
);
435 find_frame_funname (frame
, &name
, &lang
, NULL
);
437 CATCH (except
, RETURN_MASK_ALL
)
440 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
446 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
452 result
= gdbscm_scm_from_c_string (name
);
461 /* (frame-type <gdb:frame>) -> integer
462 Returns the frame type, namely one of the gdb:*_FRAME constants. */
465 gdbscm_frame_type (SCM self
)
468 enum frame_type type
= NORMAL_FRAME
;
469 struct frame_info
*frame
= NULL
;
471 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
475 frame
= frscm_frame_smob_to_frame (f_smob
);
477 type
= get_frame_type (frame
);
479 CATCH (except
, RETURN_MASK_ALL
)
481 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
487 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
491 return scm_from_int (type
);
494 /* (frame-arch <gdb:frame>) -> <gdb:architecture>
495 Returns the frame's architecture as a gdb:architecture object. */
498 gdbscm_frame_arch (SCM self
)
501 struct frame_info
*frame
= NULL
;
503 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
507 frame
= frscm_frame_smob_to_frame (f_smob
);
509 CATCH (except
, RETURN_MASK_ALL
)
511 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
517 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
521 return arscm_scm_from_arch (f_smob
->gdbarch
);
524 /* (frame-unwind-stop-reason <gdb:frame>) -> integer
525 Returns one of the gdb:FRAME_UNWIND_* constants. */
528 gdbscm_frame_unwind_stop_reason (SCM self
)
531 struct frame_info
*frame
= NULL
;
532 enum unwind_stop_reason stop_reason
;
534 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
538 frame
= frscm_frame_smob_to_frame (f_smob
);
540 CATCH (except
, RETURN_MASK_ALL
)
542 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
548 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
552 stop_reason
= get_frame_unwind_stop_reason (frame
);
554 return scm_from_int (stop_reason
);
557 /* (frame-pc <gdb:frame>) -> integer
558 Returns the frame's resume address. */
561 gdbscm_frame_pc (SCM self
)
565 struct frame_info
*frame
= NULL
;
567 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
571 frame
= frscm_frame_smob_to_frame (f_smob
);
573 pc
= get_frame_pc (frame
);
575 CATCH (except
, RETURN_MASK_ALL
)
577 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
583 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
587 return gdbscm_scm_from_ulongest (pc
);
590 /* (frame-block <gdb:frame>) -> <gdb:block>
591 Returns the frame's code block, or #f if one cannot be found. */
594 gdbscm_frame_block (SCM self
)
597 const struct block
*block
= NULL
, *fn_block
;
598 struct frame_info
*frame
= NULL
;
600 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
604 frame
= frscm_frame_smob_to_frame (f_smob
);
606 block
= get_frame_block (frame
, NULL
);
608 CATCH (except
, RETURN_MASK_ALL
)
610 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
616 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
620 for (fn_block
= block
;
621 fn_block
!= NULL
&& BLOCK_FUNCTION (fn_block
) == NULL
;
622 fn_block
= BLOCK_SUPERBLOCK (fn_block
))
625 if (block
== NULL
|| fn_block
== NULL
|| BLOCK_FUNCTION (fn_block
) == NULL
)
627 scm_misc_error (FUNC_NAME
, _("cannot find block for frame"),
633 return bkscm_scm_from_block
634 (block
, symbol_objfile (BLOCK_FUNCTION (fn_block
)));
640 /* (frame-function <gdb:frame>) -> <gdb:symbol>
641 Returns the symbol for the function corresponding to this frame,
642 or #f if there isn't one. */
645 gdbscm_frame_function (SCM self
)
648 struct symbol
*sym
= NULL
;
649 struct frame_info
*frame
= NULL
;
651 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
655 frame
= frscm_frame_smob_to_frame (f_smob
);
657 sym
= find_pc_function (get_frame_address_in_block (frame
));
659 CATCH (except
, RETURN_MASK_ALL
)
661 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
667 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
672 return syscm_scm_from_symbol (sym
);
677 /* (frame-older <gdb:frame>) -> <gdb:frame>
678 Returns the frame immediately older (outer) to this frame,
679 or #f if there isn't one. */
682 gdbscm_frame_older (SCM self
)
685 struct frame_info
*prev
= NULL
;
686 struct frame_info
*frame
= NULL
;
688 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
692 frame
= frscm_frame_smob_to_frame (f_smob
);
694 prev
= get_prev_frame (frame
);
696 CATCH (except
, RETURN_MASK_ALL
)
698 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
704 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
709 return frscm_scm_from_frame_unsafe (prev
, f_smob
->inferior
);
714 /* (frame-newer <gdb:frame>) -> <gdb:frame>
715 Returns the frame immediately newer (inner) to this frame,
716 or #f if there isn't one. */
719 gdbscm_frame_newer (SCM self
)
722 struct frame_info
*next
= NULL
;
723 struct frame_info
*frame
= NULL
;
725 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
729 frame
= frscm_frame_smob_to_frame (f_smob
);
731 next
= get_next_frame (frame
);
733 CATCH (except
, RETURN_MASK_ALL
)
735 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
741 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
746 return frscm_scm_from_frame_unsafe (next
, f_smob
->inferior
);
751 /* (frame-sal <gdb:frame>) -> <gdb:sal>
752 Returns the frame's symtab and line. */
755 gdbscm_frame_sal (SCM self
)
758 struct symtab_and_line sal
;
759 struct frame_info
*frame
= NULL
;
761 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
765 frame
= frscm_frame_smob_to_frame (f_smob
);
767 find_frame_sal (frame
, &sal
);
769 CATCH (except
, RETURN_MASK_ALL
)
771 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
777 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
781 return stscm_scm_from_sal (sal
);
784 /* (frame-read-register <gdb:frame> string) -> <gdb:value>
785 The register argument must be a string. */
788 gdbscm_frame_read_register (SCM self
, SCM register_scm
)
791 struct value
*value
= NULL
;
792 struct frame_info
*frame
= NULL
;
793 struct cleanup
*cleanup
;
796 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
797 gdbscm_parse_function_args (FUNC_NAME
, SCM_ARG2
, NULL
, "s",
798 register_scm
, ®ister_str
);
799 cleanup
= make_cleanup (xfree
, register_str
);
805 frame
= frscm_frame_smob_to_frame (f_smob
);
808 regnum
= user_reg_map_name_to_regnum (get_frame_arch (frame
),
810 strlen (register_str
));
812 value
= value_of_register (regnum
, frame
);
815 CATCH (except
, RETURN_MASK_ALL
)
817 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
821 do_cleanups (cleanup
);
825 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
831 gdbscm_out_of_range_error (FUNC_NAME
, SCM_ARG2
, register_scm
,
832 _("unknown register"));
835 return vlscm_scm_from_value (value
);
838 /* (frame-read-var <gdb:frame> <gdb:symbol>) -> <gdb:value>
839 (frame-read-var <gdb:frame> string [#:block <gdb:block>]) -> <gdb:value>
840 If the optional block argument is provided start the search from that block,
841 otherwise search from the frame's current block (determined by examining
842 the resume address of the frame). The variable argument must be a string
843 or an instance of a <gdb:symbol>. The block argument must be an instance of
847 gdbscm_frame_read_var (SCM self
, SCM symbol_scm
, SCM rest
)
849 SCM keywords
[] = { block_keyword
, SCM_BOOL_F
};
852 int block_arg_pos
= -1;
853 SCM block_scm
= SCM_UNDEFINED
;
854 struct frame_info
*frame
= NULL
;
855 struct symbol
*var
= NULL
;
856 const struct block
*block
= NULL
;
857 struct value
*value
= NULL
;
859 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
863 frame
= frscm_frame_smob_to_frame (f_smob
);
865 CATCH (except
, RETURN_MASK_ALL
)
867 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
873 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
877 gdbscm_parse_function_args (FUNC_NAME
, SCM_ARG3
, keywords
, "#O",
878 rest
, &block_arg_pos
, &block_scm
);
880 if (syscm_is_symbol (symbol_scm
))
882 var
= syscm_get_valid_symbol_arg_unsafe (symbol_scm
, SCM_ARG2
,
884 SCM_ASSERT (SCM_UNBNDP (block_scm
), block_scm
, SCM_ARG3
, FUNC_NAME
);
886 else if (scm_is_string (symbol_scm
))
889 const struct block
*block
= NULL
;
890 struct cleanup
*cleanup
;
891 struct gdb_exception except
= exception_none
;
893 if (! SCM_UNBNDP (block_scm
))
897 gdb_assert (block_arg_pos
> 0);
898 block
= bkscm_scm_to_block (block_scm
, block_arg_pos
, FUNC_NAME
,
901 gdbscm_throw (except_scm
);
904 var_name
= gdbscm_scm_to_c_string (symbol_scm
);
905 cleanup
= make_cleanup (xfree
, var_name
);
906 /* N.B. Between here and the call to do_cleanups, don't do anything
907 to cause a Scheme exception without performing the cleanup. */
911 struct block_symbol lookup_sym
;
914 block
= get_frame_block (frame
, NULL
);
915 lookup_sym
= lookup_symbol (var_name
, block
, VAR_DOMAIN
, NULL
);
916 var
= lookup_sym
.symbol
;
917 block
= lookup_sym
.block
;
919 CATCH (ex
, RETURN_MASK_ALL
)
925 do_cleanups (cleanup
);
926 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
930 do_cleanups (cleanup
);
931 gdbscm_out_of_range_error (FUNC_NAME
, 0, symbol_scm
,
932 _("variable not found"));
935 do_cleanups (cleanup
);
939 /* Use SCM_ASSERT_TYPE for more consistent error messages. */
940 SCM_ASSERT_TYPE (0, symbol_scm
, SCM_ARG1
, FUNC_NAME
,
941 _("gdb:symbol or string"));
946 value
= read_var_value (var
, block
, frame
);
948 CATCH (except
, RETURN_MASK_ALL
)
950 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
954 return vlscm_scm_from_value (value
);
957 /* (frame-select <gdb:frame>) -> unspecified
958 Select this frame. */
961 gdbscm_frame_select (SCM self
)
964 struct frame_info
*frame
= NULL
;
966 f_smob
= frscm_get_frame_smob_arg_unsafe (self
, SCM_ARG1
, FUNC_NAME
);
970 frame
= frscm_frame_smob_to_frame (f_smob
);
972 select_frame (frame
);
974 CATCH (except
, RETURN_MASK_ALL
)
976 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
982 gdbscm_invalid_object_error (FUNC_NAME
, SCM_ARG1
, self
,
986 return SCM_UNSPECIFIED
;
989 /* (newest-frame) -> <gdb:frame>
990 Returns the newest frame. */
993 gdbscm_newest_frame (void)
995 struct frame_info
*frame
= NULL
;
999 frame
= get_current_frame ();
1001 CATCH (except
, RETURN_MASK_ALL
)
1003 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
1007 return frscm_scm_from_frame_unsafe (frame
, current_inferior ());
1010 /* (selected-frame) -> <gdb:frame>
1011 Returns the selected frame. */
1014 gdbscm_selected_frame (void)
1016 struct frame_info
*frame
= NULL
;
1020 frame
= get_selected_frame (_("No frame is currently selected"));
1022 CATCH (except
, RETURN_MASK_ALL
)
1024 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
1028 return frscm_scm_from_frame_unsafe (frame
, current_inferior ());
1031 /* (unwind-stop-reason-string integer) -> string
1032 Return a string explaining the unwind stop reason. */
1035 gdbscm_unwind_stop_reason_string (SCM reason_scm
)
1040 gdbscm_parse_function_args (FUNC_NAME
, SCM_ARG1
, NULL
, "i",
1041 reason_scm
, &reason
);
1043 if (reason
< UNWIND_FIRST
|| reason
> UNWIND_LAST
)
1044 scm_out_of_range (FUNC_NAME
, reason_scm
);
1046 str
= unwind_stop_reason_to_string ((enum unwind_stop_reason
) reason
);
1047 return gdbscm_scm_from_c_string (str
);
1050 /* Initialize the Scheme frame support. */
1052 static const scheme_integer_constant frame_integer_constants
[] =
1054 #define ENTRY(X) { #X, X }
1056 ENTRY (NORMAL_FRAME
),
1057 ENTRY (DUMMY_FRAME
),
1058 ENTRY (INLINE_FRAME
),
1059 ENTRY (TAILCALL_FRAME
),
1060 ENTRY (SIGTRAMP_FRAME
),
1062 ENTRY (SENTINEL_FRAME
),
1066 #define SET(name, description) \
1067 { "FRAME_" #name, name },
1068 #include "unwind_stop_reasons.def"
1071 END_INTEGER_CONSTANTS
1074 static const scheme_function frame_functions
[] =
1076 { "frame?", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_p
),
1078 Return #t if the object is a <gdb:frame> object." },
1080 { "frame-valid?", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_valid_p
),
1082 Return #t if the object is a valid <gdb:frame> object.\n\
1083 Frames become invalid when the inferior returns to its caller." },
1085 { "frame-name", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_name
),
1087 Return the name of the function corresponding to this frame,\n\
1088 or #f if there is no function." },
1090 { "frame-arch", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_arch
),
1092 Return the frame's architecture as a <gdb:arch> object." },
1094 { "frame-type", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_type
),
1096 Return the frame type, namely one of the gdb:*_FRAME constants." },
1098 { "frame-unwind-stop-reason", 1, 0, 0,
1099 as_a_scm_t_subr (gdbscm_frame_unwind_stop_reason
),
1101 Return one of the gdb:FRAME_UNWIND_* constants explaining why\n\
1102 it's not possible to find frames older than this." },
1104 { "frame-pc", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_pc
),
1106 Return the frame's resume address." },
1108 { "frame-block", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_block
),
1110 Return the frame's code block, or #f if one cannot be found." },
1112 { "frame-function", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_function
),
1114 Return the <gdb:symbol> for the function corresponding to this frame,\n\
1115 or #f if there isn't one." },
1117 { "frame-older", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_older
),
1119 Return the frame immediately older (outer) to this frame,\n\
1120 or #f if there isn't one." },
1122 { "frame-newer", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_newer
),
1124 Return the frame immediately newer (inner) to this frame,\n\
1125 or #f if there isn't one." },
1127 { "frame-sal", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_sal
),
1129 Return the frame's symtab-and-line <gdb:sal> object." },
1131 { "frame-read-var", 2, 0, 1, as_a_scm_t_subr (gdbscm_frame_read_var
),
1133 Return the value of the symbol in the frame.\n\
1135 Arguments: <gdb:frame> <gdb:symbol>\n\
1136 Or: <gdb:frame> string [#:block <gdb:block>]" },
1138 { "frame-read-register", 2, 0, 0,
1139 as_a_scm_t_subr (gdbscm_frame_read_register
),
1141 Return the value of the register in the frame.\n\
1143 Arguments: <gdb:frame> string" },
1145 { "frame-select", 1, 0, 0, as_a_scm_t_subr (gdbscm_frame_select
),
1147 Select this frame." },
1149 { "newest-frame", 0, 0, 0, as_a_scm_t_subr (gdbscm_newest_frame
),
1151 Return the newest frame." },
1153 { "selected-frame", 0, 0, 0, as_a_scm_t_subr (gdbscm_selected_frame
),
1155 Return the selected frame." },
1157 { "unwind-stop-reason-string", 1, 0, 0,
1158 as_a_scm_t_subr (gdbscm_unwind_stop_reason_string
),
1160 Return a string explaining the unwind stop reason.\n\
1162 Arguments: integer (the result of frame-unwind-stop-reason)" },
1168 gdbscm_initialize_frames (void)
1171 = gdbscm_make_smob_type (frame_smob_name
, sizeof (frame_smob
));
1172 scm_set_smob_free (frame_smob_tag
, frscm_free_frame_smob
);
1173 scm_set_smob_print (frame_smob_tag
, frscm_print_frame_smob
);
1175 gdbscm_define_integer_constants (frame_integer_constants
, 1);
1176 gdbscm_define_functions (frame_functions
, 1);
1178 block_keyword
= scm_from_latin1_keyword ("block");
1180 /* Register an inferior "free" callback so we can properly
1181 invalidate frames when an inferior file is about to be deleted. */
1182 frscm_inferior_data_key
1183 = register_inferior_data_with_cleanup (NULL
, frscm_del_inferior_frames
);