1 /* Print and select stack frames for GDB, the GNU debugger.
3 Copyright (C) 1986-2022 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/>. */
24 #include "expression.h"
31 #include "breakpoint.h"
38 #include "dictionary.h"
39 #include "reggroups.h"
43 #include "gdbthread.h"
44 #include "cp-support.h"
46 #include "inline-frame.h"
48 #include "cli/cli-utils.h"
53 #include "extension.h"
54 #include "observable.h"
55 #include "gdbsupport/def-vector.h"
56 #include "cli/cli-option.h"
57 #include "cli/cli-style.h"
58 #include "gdbsupport/buildargv.h"
60 /* The possible choices of "set print frame-arguments", and the value
63 const char print_frame_arguments_all
[] = "all";
64 const char print_frame_arguments_scalars
[] = "scalars";
65 const char print_frame_arguments_none
[] = "none";
66 const char print_frame_arguments_presence
[] = "presence";
68 static const char *const print_frame_arguments_choices
[] =
70 print_frame_arguments_all
,
71 print_frame_arguments_scalars
,
72 print_frame_arguments_none
,
73 print_frame_arguments_presence
,
77 /* The possible choices of "set print frame-info", and the value
80 const char print_frame_info_auto
[] = "auto";
81 const char print_frame_info_source_line
[] = "source-line";
82 const char print_frame_info_location
[] = "location";
83 const char print_frame_info_source_and_location
[] = "source-and-location";
84 const char print_frame_info_location_and_address
[] = "location-and-address";
85 const char print_frame_info_short_location
[] = "short-location";
87 static const char *const print_frame_info_choices
[] =
89 print_frame_info_auto
,
90 print_frame_info_source_line
,
91 print_frame_info_location
,
92 print_frame_info_source_and_location
,
93 print_frame_info_location_and_address
,
94 print_frame_info_short_location
,
98 /* print_frame_info_print_what[i] maps a choice to the corresponding
100 static const gdb::optional
<enum print_what
> print_frame_info_print_what
[] =
101 {{}, /* Empty value for "auto". */
102 SRC_LINE
, LOCATION
, SRC_AND_LOC
, LOC_AND_ADDRESS
, SHORT_LOCATION
};
104 /* The possible choices of "set print entry-values", and the value
107 const char print_entry_values_no
[] = "no";
108 const char print_entry_values_only
[] = "only";
109 const char print_entry_values_preferred
[] = "preferred";
110 const char print_entry_values_if_needed
[] = "if-needed";
111 const char print_entry_values_both
[] = "both";
112 const char print_entry_values_compact
[] = "compact";
113 const char print_entry_values_default
[] = "default";
114 static const char *const print_entry_values_choices
[] =
116 print_entry_values_no
,
117 print_entry_values_only
,
118 print_entry_values_preferred
,
119 print_entry_values_if_needed
,
120 print_entry_values_both
,
121 print_entry_values_compact
,
122 print_entry_values_default
,
127 frame_print_options user_frame_print_options
;
129 /* Option definitions for some frame-related "set print ..."
132 using boolean_option_def
133 = gdb::option::boolean_option_def
<frame_print_options
>;
134 using enum_option_def
135 = gdb::option::enum_option_def
<frame_print_options
>;
137 static const gdb::option::option_def frame_print_option_defs
[] = {
141 print_entry_values_choices
,
142 [] (frame_print_options
*opt
) { return &opt
->print_entry_values
; },
143 NULL
, /* show_cmd_cb */
144 N_("Set printing of function arguments at function entry."),
145 N_("Show printing of function arguments at function entry."),
146 N_("GDB can sometimes determine the values of function arguments at entry,\n\
147 in addition to their current values. This option tells GDB whether\n\
148 to print the current value, the value at entry (marked as val@entry),\n\
149 or both. Note that one or both of these values may be <optimized out>."),
154 print_frame_arguments_choices
,
155 [] (frame_print_options
*opt
) { return &opt
->print_frame_arguments
; },
156 NULL
, /* show_cmd_cb */
157 N_("Set printing of non-scalar frame arguments."),
158 N_("Show printing of non-scalar frame arguments."),
163 "raw-frame-arguments",
164 [] (frame_print_options
*opt
) { return &opt
->print_raw_frame_arguments
; },
165 NULL
, /* show_cmd_cb */
166 N_("Set whether to print frame arguments in raw form."),
167 N_("Show whether to print frame arguments in raw form."),
168 N_("If set, frame arguments are printed in raw form, bypassing any\n\
169 pretty-printers for that value.")
174 print_frame_info_choices
,
175 [] (frame_print_options
*opt
) { return &opt
->print_frame_info
; },
176 NULL
, /* show_cmd_cb */
177 N_("Set printing of frame information."),
178 N_("Show printing of frame information."),
184 /* Options for the "backtrace" command. */
186 struct backtrace_cmd_options
189 bool no_filters
= false;
193 using bt_flag_option_def
194 = gdb::option::flag_option_def
<backtrace_cmd_options
>;
196 static const gdb::option::option_def backtrace_command_option_defs
[] = {
199 [] (backtrace_cmd_options
*opt
) { return &opt
->full
; },
200 N_("Print values of local variables.")
205 [] (backtrace_cmd_options
*opt
) { return &opt
->no_filters
; },
206 N_("Prohibit frame filters from executing on a backtrace."),
211 [] (backtrace_cmd_options
*opt
) { return &opt
->hide
; },
212 N_("Causes Python frame filter elided frames to not be printed."),
216 /* Prototypes for local functions. */
218 static void print_frame_local_vars (struct frame_info
*frame
,
220 const char *regexp
, const char *t_regexp
,
221 int num_tabs
, struct ui_file
*stream
);
223 static void print_frame (const frame_print_options
&opts
,
224 frame_info
*frame
, int print_level
,
225 enum print_what print_what
, int print_args
,
226 struct symtab_and_line sal
);
228 static struct frame_info
*find_frame_for_function (const char *);
229 static struct frame_info
*find_frame_for_address (CORE_ADDR
);
231 /* Zero means do things normally; we are interacting directly with the
232 user. One means print the full filename and linenumber when a
233 frame is printed, and do so in a format emacs18/emacs19.22 can
234 parse. Two means print similar annotations, but in many more
235 cases and in a slightly different syntax. */
237 int annotation_level
= 0;
239 /* Class used to manage tracking the last symtab we displayed. */
241 class last_displayed_symtab_info_type
244 /* True if the cached information is valid. */
245 bool is_valid () const
248 /* Return the cached program_space. If the cache is invalid nullptr is
250 struct program_space
*pspace () const
253 /* Return the cached CORE_ADDR address. If the cache is invalid 0 is
255 CORE_ADDR
address () const
256 { return m_address
; }
258 /* Return the cached symtab. If the cache is invalid nullptr is
260 struct symtab
*symtab () const
263 /* Return the cached line number. If the cache is invalid 0 is
268 /* Invalidate the cache, reset all the members to their default value. */
278 /* Store a new set of values in the cache. */
279 void set (struct program_space
*pspace
, CORE_ADDR address
,
280 struct symtab
*symtab
, int line
)
282 gdb_assert (pspace
!= nullptr);
292 /* True when the cache is valid. */
293 bool m_valid
= false;
295 /* The last program space displayed. */
296 struct program_space
*m_pspace
= nullptr;
298 /* The last address displayed. */
299 CORE_ADDR m_address
= 0;
301 /* The last symtab displayed. */
302 struct symtab
*m_symtab
= nullptr;
304 /* The last line number displayed. */
308 /* An actual instance of the cache, holds information about the last symtab
310 static last_displayed_symtab_info_type last_displayed_symtab_info
;
317 frame_show_address (struct frame_info
*frame
,
318 struct symtab_and_line sal
)
320 /* If there is a line number, but no PC, then there is no location
321 information associated with this sal. The only way that should
322 happen is for the call sites of inlined functions (SAL comes from
323 find_frame_sal). Otherwise, we would have some PC range if the
324 SAL came from a line table. */
325 if (sal
.line
!= 0 && sal
.pc
== 0 && sal
.end
== 0)
327 if (get_next_frame (frame
) == NULL
)
328 gdb_assert (inline_skipped_frames (inferior_thread ()) > 0);
330 gdb_assert (get_frame_type (get_next_frame (frame
)) == INLINE_FRAME
);
334 return get_frame_pc (frame
) != sal
.pc
|| !sal
.is_stmt
;
340 print_stack_frame_to_uiout (struct ui_out
*uiout
, struct frame_info
*frame
,
341 int print_level
, enum print_what print_what
,
344 scoped_restore save_uiout
= make_scoped_restore (¤t_uiout
, uiout
);
346 print_stack_frame (frame
, print_level
, print_what
, set_current_sal
);
349 /* Show or print a stack frame FRAME briefly. The output is formatted
350 according to PRINT_LEVEL and PRINT_WHAT printing the frame's
351 relative level, function name, argument list, and file name and
352 line number. If the frame's PC is not at the beginning of the
353 source line, the actual PC is printed at the beginning. */
356 print_stack_frame (struct frame_info
*frame
, int print_level
,
357 enum print_what print_what
,
361 /* For mi, always print location and address. */
362 if (current_uiout
->is_mi_like_p ())
363 print_what
= LOC_AND_ADDRESS
;
367 print_frame_info (user_frame_print_options
,
368 frame
, print_level
, print_what
, 1 /* print_args */,
371 set_current_sal_from_frame (frame
);
373 catch (const gdb_exception_error
&e
)
378 /* Print nameless arguments of frame FRAME on STREAM, where START is
379 the offset of the first nameless argument, and NUM is the number of
380 nameless arguments to print. FIRST is nonzero if this is the first
381 argument (not just the first nameless argument). */
384 print_frame_nameless_args (struct frame_info
*frame
, long start
, int num
,
385 int first
, struct ui_file
*stream
)
387 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
388 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
393 for (i
= 0; i
< num
; i
++)
396 argsaddr
= get_frame_args_address (frame
);
399 arg_value
= read_memory_integer (argsaddr
+ start
,
400 sizeof (int), byte_order
);
402 fprintf_filtered (stream
, ", ");
403 fprintf_filtered (stream
, "%ld", arg_value
);
405 start
+= sizeof (int);
409 /* Print single argument of inferior function. ARG must be already
412 Errors are printed as if they would be the parameter value. Use zeroed ARG
413 iff it should not be printed according to user settings. */
416 print_frame_arg (const frame_print_options
&fp_opts
,
417 const struct frame_arg
*arg
)
419 struct ui_out
*uiout
= current_uiout
;
423 gdb_assert (!arg
->val
|| !arg
->error
);
424 gdb_assert (arg
->entry_kind
== print_entry_values_no
425 || arg
->entry_kind
== print_entry_values_only
426 || (!uiout
->is_mi_like_p ()
427 && arg
->entry_kind
== print_entry_values_compact
));
429 annotate_arg_emitter arg_emitter
;
430 ui_out_emit_tuple
tuple_emitter (uiout
, NULL
);
431 fputs_filtered (arg
->sym
->print_name (), &stb
);
432 if (arg
->entry_kind
== print_entry_values_compact
)
434 /* It is OK to provide invalid MI-like stream as with
435 PRINT_ENTRY_VALUE_COMPACT we never use MI. */
438 fputs_filtered (arg
->sym
->print_name (), &stb
);
440 if (arg
->entry_kind
== print_entry_values_only
441 || arg
->entry_kind
== print_entry_values_compact
)
443 uiout
->field_stream ("name", stb
, variable_name_style
.style ());
444 annotate_arg_name_end ();
448 if (!arg
->val
&& !arg
->error
)
454 stb
.printf (_("<error reading variable: %s>"), arg
->error
.get ());
455 style
= metadata_style
.style ();
461 const struct language_defn
*language
;
462 struct value_print_options vp_opts
;
464 /* Avoid value_print because it will deref ref parameters. We
465 just want to print their addresses. Print ??? for args whose
466 address we do not know. We pass 2 as "recurse" to val_print
467 because our standard indentation here is 4 spaces, and
468 val_print indents 2 for each recurse. */
470 annotate_arg_value (value_type (arg
->val
));
472 /* Use the appropriate language to display our symbol, unless the
473 user forced the language to a specific language. */
474 if (language_mode
== language_mode_auto
)
475 language
= language_def (arg
->sym
->language ());
477 language
= current_language
;
479 get_no_prettyformat_print_options (&vp_opts
);
480 vp_opts
.deref_ref
= 1;
481 vp_opts
.raw
= fp_opts
.print_raw_frame_arguments
;
483 /* True in "summary" mode, false otherwise. */
485 = fp_opts
.print_frame_arguments
== print_frame_arguments_scalars
;
487 common_val_print_checked (arg
->val
, &stb
, 2, &vp_opts
, language
);
489 catch (const gdb_exception_error
&except
)
491 stb
.printf (_("<error reading variable: %s>"),
493 style
= metadata_style
.style ();
498 uiout
->field_stream ("value", stb
, style
);
501 /* Read in inferior function local SYM at FRAME into ARGP. Caller is
502 responsible for xfree of ARGP->ERROR. This function never throws an
506 read_frame_local (struct symbol
*sym
, struct frame_info
*frame
,
507 struct frame_arg
*argp
)
515 argp
->val
= read_var_value (sym
, NULL
, frame
);
517 catch (const gdb_exception_error
&except
)
519 argp
->error
.reset (xstrdup (except
.what ()));
523 /* Read in inferior function parameter SYM at FRAME into ARGP. This
524 function never throws an exception. */
527 read_frame_arg (const frame_print_options
&fp_opts
,
528 symbol
*sym
, frame_info
*frame
,
529 struct frame_arg
*argp
, struct frame_arg
*entryargp
)
531 struct value
*val
= NULL
, *entryval
= NULL
;
532 char *val_error
= NULL
, *entryval_error
= NULL
;
535 if (fp_opts
.print_entry_values
!= print_entry_values_only
536 && fp_opts
.print_entry_values
!= print_entry_values_preferred
)
540 val
= read_var_value (sym
, NULL
, frame
);
542 catch (const gdb_exception_error
&except
)
544 val_error
= (char *) alloca (except
.message
->size () + 1);
545 strcpy (val_error
, except
.what ());
549 if (SYMBOL_COMPUTED_OPS (sym
) != NULL
550 && SYMBOL_COMPUTED_OPS (sym
)->read_variable_at_entry
!= NULL
551 && fp_opts
.print_entry_values
!= print_entry_values_no
552 && (fp_opts
.print_entry_values
!= print_entry_values_if_needed
553 || !val
|| value_optimized_out (val
)))
557 const struct symbol_computed_ops
*ops
;
559 ops
= SYMBOL_COMPUTED_OPS (sym
);
560 entryval
= ops
->read_variable_at_entry (sym
, frame
);
562 catch (const gdb_exception_error
&except
)
564 if (except
.error
!= NO_ENTRY_VALUE_ERROR
)
566 entryval_error
= (char *) alloca (except
.message
->size () + 1);
567 strcpy (entryval_error
, except
.what ());
571 if (entryval
!= NULL
&& value_optimized_out (entryval
))
574 if (fp_opts
.print_entry_values
== print_entry_values_compact
575 || fp_opts
.print_entry_values
== print_entry_values_default
)
577 /* For MI do not try to use print_entry_values_compact for ARGP. */
579 if (val
&& entryval
&& !current_uiout
->is_mi_like_p ())
581 struct type
*type
= value_type (val
);
583 if (value_lazy (val
))
584 value_fetch_lazy (val
);
585 if (value_lazy (entryval
))
586 value_fetch_lazy (entryval
);
588 if (value_contents_eq (val
, 0, entryval
, 0, TYPE_LENGTH (type
)))
590 /* Initialize it just to avoid a GCC false warning. */
591 struct value
*val_deref
= NULL
, *entryval_deref
;
593 /* DW_AT_call_value does match with the current
594 value. If it is a reference still try to verify if
595 dereferenced DW_AT_call_data_value does not differ. */
599 struct type
*type_deref
;
601 val_deref
= coerce_ref (val
);
602 if (value_lazy (val_deref
))
603 value_fetch_lazy (val_deref
);
604 type_deref
= value_type (val_deref
);
606 entryval_deref
= coerce_ref (entryval
);
607 if (value_lazy (entryval_deref
))
608 value_fetch_lazy (entryval_deref
);
610 /* If the reference addresses match but dereferenced
611 content does not match print them. */
613 && value_contents_eq (val_deref
, 0,
615 TYPE_LENGTH (type_deref
)))
618 catch (const gdb_exception_error
&except
)
620 /* If the dereferenced content could not be
621 fetched do not display anything. */
622 if (except
.error
== NO_ENTRY_VALUE_ERROR
)
624 else if (except
.message
!= NULL
)
627 = (char *) alloca (except
.message
->size () + 1);
628 strcpy (entryval_error
, except
.what ());
632 /* Value was not a reference; and its content matches. */
633 if (val
== val_deref
)
641 /* Try to remove possibly duplicate error message for ENTRYARGP even
644 if (val_error
&& entryval_error
645 && strcmp (val_error
, entryval_error
) == 0)
647 entryval_error
= NULL
;
649 /* Do not se VAL_EQUAL as the same error message may be shown for
650 the entry value even if no entry values are present in the
656 if (entryval
== NULL
)
658 if (fp_opts
.print_entry_values
== print_entry_values_preferred
)
660 gdb_assert (val
== NULL
);
664 val
= read_var_value (sym
, NULL
, frame
);
666 catch (const gdb_exception_error
&except
)
668 val_error
= (char *) alloca (except
.message
->size () + 1);
669 strcpy (val_error
, except
.what ());
672 if (fp_opts
.print_entry_values
== print_entry_values_only
673 || fp_opts
.print_entry_values
== print_entry_values_both
674 || (fp_opts
.print_entry_values
== print_entry_values_preferred
675 && (!val
|| value_optimized_out (val
))))
677 entryval
= allocate_optimized_out_value (SYMBOL_TYPE (sym
));
678 entryval_error
= NULL
;
681 if ((fp_opts
.print_entry_values
== print_entry_values_compact
682 || fp_opts
.print_entry_values
== print_entry_values_if_needed
683 || fp_opts
.print_entry_values
== print_entry_values_preferred
)
684 && (!val
|| value_optimized_out (val
)) && entryval
!= NULL
)
692 argp
->error
.reset (val_error
? xstrdup (val_error
) : NULL
);
693 if (!val
&& !val_error
)
694 argp
->entry_kind
= print_entry_values_only
;
695 else if ((fp_opts
.print_entry_values
== print_entry_values_compact
696 || fp_opts
.print_entry_values
== print_entry_values_default
)
699 argp
->entry_kind
= print_entry_values_compact
;
700 gdb_assert (!current_uiout
->is_mi_like_p ());
703 argp
->entry_kind
= print_entry_values_no
;
705 entryargp
->sym
= sym
;
706 entryargp
->val
= entryval
;
707 entryargp
->error
.reset (entryval_error
? xstrdup (entryval_error
) : NULL
);
708 if (!entryval
&& !entryval_error
)
709 entryargp
->entry_kind
= print_entry_values_no
;
711 entryargp
->entry_kind
= print_entry_values_only
;
714 /* Print the arguments of frame FRAME on STREAM, given the function
715 FUNC running in that frame (as a symbol), where NUM is the number
716 of arguments according to the stack frame (or -1 if the number of
717 arguments is unknown). */
719 /* Note that currently the "number of arguments according to the
720 stack frame" is only known on VAX where i refers to the "number of
721 ints of arguments according to the stack frame". */
724 print_frame_args (const frame_print_options
&fp_opts
,
725 struct symbol
*func
, struct frame_info
*frame
,
726 int num
, struct ui_file
*stream
)
728 struct ui_out
*uiout
= current_uiout
;
730 /* Offset of next stack argument beyond the one we have seen that is
731 at the highest offset, or -1 if we haven't come to a stack
733 long highest_offset
= -1;
734 /* Number of ints of arguments that we have printed so far. */
735 int args_printed
= 0;
736 /* True if we should print arg names. If false, we only indicate
737 the presence of arguments by printing ellipsis. */
739 = fp_opts
.print_frame_arguments
!= print_frame_arguments_presence
;
740 /* True if we should print arguments, false otherwise. */
743 && fp_opts
.print_frame_arguments
!= print_frame_arguments_none
);
745 /* Temporarily change the selected frame to the given FRAME.
746 This allows routines that rely on the selected frame instead
747 of being given a frame as parameter to use the correct frame. */
748 scoped_restore_selected_frame restore_selected_frame
;
749 select_frame (frame
);
753 const struct block
*b
= SYMBOL_BLOCK_VALUE (func
);
754 struct block_iterator iter
;
757 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
759 struct frame_arg arg
, entryarg
;
763 /* Keep track of the highest stack argument offset seen, and
764 skip over any kinds of symbols we don't care about. */
766 if (!SYMBOL_IS_ARGUMENT (sym
))
776 switch (SYMBOL_CLASS (sym
))
781 long current_offset
= SYMBOL_VALUE (sym
);
782 int arg_size
= TYPE_LENGTH (SYMBOL_TYPE (sym
));
784 /* Compute address of next argument by adding the size of
785 this argument and rounding to an int boundary. */
787 ((current_offset
+ arg_size
+ sizeof (int) - 1)
788 & ~(sizeof (int) - 1));
790 /* If this is the highest offset seen yet, set
792 if (highest_offset
== -1
793 || (current_offset
> highest_offset
))
794 highest_offset
= current_offset
;
796 /* Add the number of ints we're about to print to
798 args_printed
+= (arg_size
+ sizeof (int) - 1) / sizeof (int);
801 /* We care about types of symbols, but don't need to
802 keep track of stack offsets in them. */
804 case LOC_REGPARM_ADDR
:
806 case LOC_OPTIMIZED_OUT
:
811 /* We have to look up the symbol because arguments can have
812 two entries (one a parameter, one a local) and the one we
813 want is the local, which lookup_symbol will find for us.
814 This includes gcc1 (not gcc2) on SPARC when passing a
815 small structure and gcc2 when the argument type is float
816 and it is passed as a double and converted to float by
817 the prologue (in the latter case the type of the LOC_ARG
818 symbol is double and the type of the LOC_LOCAL symbol is
820 /* But if the parameter name is null, don't try it. Null
821 parameter names occur on the RS/6000, for traceback
822 tables. FIXME, should we even print them? */
824 if (*sym
->linkage_name ())
828 nsym
= lookup_symbol_search_name (sym
->search_name (),
829 b
, VAR_DOMAIN
).symbol
;
830 gdb_assert (nsym
!= NULL
);
831 if (SYMBOL_CLASS (nsym
) == LOC_REGISTER
832 && !SYMBOL_IS_ARGUMENT (nsym
))
834 /* There is a LOC_ARG/LOC_REGISTER pair. This means
835 that it was passed on the stack and loaded into a
836 register, or passed in a register and stored in a
837 stack slot. GDB 3.x used the LOC_ARG; GDB
838 4.0-4.11 used the LOC_REGISTER.
840 Reasons for using the LOC_ARG:
842 (1) Because find_saved_registers may be slow for
845 (2) Because registers are often re-used and stack
846 slots rarely (never?) are. Therefore using
847 the stack slot is much less likely to print
850 Reasons why we might want to use the LOC_REGISTER:
852 (1) So that the backtrace prints the same value
853 as "print foo". I see no compelling reason
854 why this needs to be the case; having the
855 backtrace print the value which was passed
856 in, and "print foo" print the value as
857 modified within the called function, makes
860 Additional note: It might be nice if "info args"
861 displayed both values.
863 One more note: There is a case with SPARC
864 structure passing where we need to use the
865 LOC_REGISTER, but this is dealt with by creating
866 a single LOC_REGPARM in symbol reading. */
868 /* Leave sym (the LOC_ARG) alone. */
875 /* Print the current arg. */
878 uiout
->wrap_hint (4);
883 arg
.entry_kind
= print_entry_values_no
;
885 entryarg
.entry_kind
= print_entry_values_no
;
888 read_frame_arg (fp_opts
, sym
, frame
, &arg
, &entryarg
);
890 if (arg
.entry_kind
!= print_entry_values_only
)
891 print_frame_arg (fp_opts
, &arg
);
893 if (entryarg
.entry_kind
!= print_entry_values_no
)
895 if (arg
.entry_kind
!= print_entry_values_only
)
898 uiout
->wrap_hint (4);
901 print_frame_arg (fp_opts
, &entryarg
);
908 /* Don't print nameless args in situations where we don't know
909 enough about the stack to find them. */
914 if (highest_offset
== -1)
915 start
= gdbarch_frame_args_skip (get_frame_arch (frame
));
917 start
= highest_offset
;
919 if (!print_names
&& !first
&& num
> 0)
922 print_frame_nameless_args (frame
, start
, num
- args_printed
,
927 /* Set the current source and line to the location given by frame
928 FRAME, if possible. When CENTER is true, adjust so the relevant
929 line is in the center of the next 'list'. */
932 set_current_sal_from_frame (struct frame_info
*frame
)
934 symtab_and_line sal
= find_frame_sal (frame
);
935 if (sal
.symtab
!= NULL
)
936 set_current_source_symtab_and_line (sal
);
939 /* If ON, GDB will display disassembly of the next source line when
940 execution of the program being debugged stops.
941 If AUTO (which is the default), or there's no line info to determine
942 the source line of the next instruction, display disassembly of next
943 instruction instead. */
945 static enum auto_boolean disassemble_next_line
;
948 show_disassemble_next_line (struct ui_file
*file
, int from_tty
,
949 struct cmd_list_element
*c
,
952 fprintf_filtered (file
,
953 _("Debugger's willingness to use "
954 "disassemble-next-line is %s.\n"),
958 /* Use TRY_CATCH to catch the exception from the gdb_disassembly
959 because it will be broken by filter sometime. */
962 do_gdb_disassembly (struct gdbarch
*gdbarch
,
963 int how_many
, CORE_ADDR low
, CORE_ADDR high
)
968 gdb_disassembly (gdbarch
, current_uiout
,
969 DISASSEMBLY_RAW_INSN
, how_many
,
972 catch (const gdb_exception_error
&exception
)
974 /* If an exception was thrown while doing the disassembly, print
975 the error message, to give the user a clue of what happened. */
976 exception_print (gdb_stderr
, exception
);
980 /* Converts the PRINT_FRAME_INFO choice to an optional enum print_what.
981 Value not present indicates to the caller to use default values
982 specific to the command being executed. */
984 static gdb::optional
<enum print_what
>
985 print_frame_info_to_print_what (const char *print_frame_info
)
987 for (int i
= 0; print_frame_info_choices
[i
] != NULL
; i
++)
988 if (print_frame_info
== print_frame_info_choices
[i
])
989 return print_frame_info_print_what
[i
];
991 internal_error (__FILE__
, __LINE__
,
992 "Unexpected print frame-info value `%s'.",
996 /* Print the PC from FRAME, plus any flags, to UIOUT. */
999 print_pc (struct ui_out
*uiout
, struct gdbarch
*gdbarch
, frame_info
*frame
,
1002 uiout
->field_core_addr ("addr", gdbarch
, pc
);
1004 std::string flags
= gdbarch_get_pc_address_flags (gdbarch
, frame
, pc
);
1005 if (!flags
.empty ())
1008 uiout
->field_string ("addr_flags", flags
);
1016 get_user_print_what_frame_info (gdb::optional
<enum print_what
> *what
)
1019 = print_frame_info_to_print_what
1020 (user_frame_print_options
.print_frame_info
);
1023 /* Print information about frame FRAME. The output is format according
1024 to PRINT_LEVEL and PRINT_WHAT and PRINT_ARGS. For the meaning of
1025 PRINT_WHAT, see enum print_what comments in frame.h.
1026 Note that PRINT_WHAT is overridden if FP_OPTS.print_frame_info
1027 != print_frame_info_auto.
1029 Used in "where" output, and to emit breakpoint or step
1033 print_frame_info (const frame_print_options
&fp_opts
,
1034 frame_info
*frame
, int print_level
,
1035 enum print_what print_what
, int print_args
,
1036 int set_current_sal
)
1038 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1041 struct ui_out
*uiout
= current_uiout
;
1043 if (!current_uiout
->is_mi_like_p ()
1044 && fp_opts
.print_frame_info
!= print_frame_info_auto
)
1046 /* Use the specific frame information desired by the user. */
1047 print_what
= *print_frame_info_to_print_what (fp_opts
.print_frame_info
);
1050 if (get_frame_type (frame
) == DUMMY_FRAME
1051 || get_frame_type (frame
) == SIGTRAMP_FRAME
1052 || get_frame_type (frame
) == ARCH_FRAME
)
1054 ui_out_emit_tuple
tuple_emitter (uiout
, "frame");
1056 annotate_frame_begin (print_level
? frame_relative_level (frame
) : 0,
1057 gdbarch
, get_frame_pc (frame
));
1059 /* Do this regardless of SOURCE because we don't have any source
1060 to list for this frame. */
1064 uiout
->field_fmt_signed (2, ui_left
, "level",
1065 frame_relative_level (frame
));
1067 if (uiout
->is_mi_like_p ())
1069 annotate_frame_address ();
1070 print_pc (uiout
, gdbarch
, frame
, get_frame_pc (frame
));
1071 annotate_frame_address_end ();
1074 if (get_frame_type (frame
) == DUMMY_FRAME
)
1076 annotate_function_call ();
1077 uiout
->field_string ("func", "<function called from gdb>",
1078 metadata_style
.style ());
1080 else if (get_frame_type (frame
) == SIGTRAMP_FRAME
)
1082 annotate_signal_handler_caller ();
1083 uiout
->field_string ("func", "<signal handler called>",
1084 metadata_style
.style ());
1086 else if (get_frame_type (frame
) == ARCH_FRAME
)
1088 uiout
->field_string ("func", "<cross-architecture call>",
1089 metadata_style
.style ());
1092 annotate_frame_end ();
1094 /* If disassemble-next-line is set to auto or on output the next
1096 if (disassemble_next_line
== AUTO_BOOLEAN_AUTO
1097 || disassemble_next_line
== AUTO_BOOLEAN_TRUE
)
1098 do_gdb_disassembly (get_frame_arch (frame
), 1,
1099 get_frame_pc (frame
), get_frame_pc (frame
) + 1);
1104 /* If FRAME is not the innermost frame, that normally means that
1105 FRAME->pc points to *after* the call instruction, and we want to
1106 get the line containing the call, never the next line. But if
1107 the next frame is a SIGTRAMP_FRAME or a DUMMY_FRAME, then the
1108 next frame was not entered as the result of a call, and we want
1109 to get the line containing FRAME->pc. */
1110 symtab_and_line sal
= find_frame_sal (frame
);
1112 location_print
= (print_what
== LOCATION
1113 || print_what
== SRC_AND_LOC
1114 || print_what
== LOC_AND_ADDRESS
1115 || print_what
== SHORT_LOCATION
);
1116 if (location_print
|| !sal
.symtab
)
1117 print_frame (fp_opts
, frame
, print_level
, print_what
, print_args
, sal
);
1119 source_print
= (print_what
== SRC_LINE
|| print_what
== SRC_AND_LOC
);
1121 /* If disassemble-next-line is set to auto or on and doesn't have
1122 the line debug messages for $pc, output the next instruction. */
1123 if ((disassemble_next_line
== AUTO_BOOLEAN_AUTO
1124 || disassemble_next_line
== AUTO_BOOLEAN_TRUE
)
1125 && source_print
&& !sal
.symtab
)
1126 do_gdb_disassembly (get_frame_arch (frame
), 1,
1127 get_frame_pc (frame
), get_frame_pc (frame
) + 1);
1129 if (source_print
&& sal
.symtab
)
1131 int mid_statement
= ((print_what
== SRC_LINE
)
1132 && frame_show_address (frame
, sal
));
1133 if (annotation_level
> 0
1134 && annotate_source_line (sal
.symtab
, sal
.line
, mid_statement
,
1135 get_frame_pc (frame
)))
1137 /* The call to ANNOTATE_SOURCE_LINE already printed the
1138 annotation for this source line, so we avoid the two cases
1139 below and do not print the actual source line. The
1140 documentation for annotations makes it clear that the source
1141 line annotation is printed __instead__ of printing the source
1142 line, not as well as.
1144 However, if we fail to print the source line, which usually
1145 means either the source file is missing, or the requested
1146 line is out of range of the file, then we don't print the
1147 source annotation, and will pass through the "normal" print
1148 source line code below, the expectation is that this code
1149 will print an appropriate error. */
1151 else if (deprecated_print_frame_info_listing_hook
)
1152 deprecated_print_frame_info_listing_hook (sal
.symtab
, sal
.line
,
1156 struct value_print_options opts
;
1158 get_user_print_options (&opts
);
1159 /* We used to do this earlier, but that is clearly
1160 wrong. This function is used by many different
1161 parts of gdb, including normal_stop in infrun.c,
1162 which uses this to print out the current PC
1163 when we stepi/nexti into the middle of a source
1164 line. Only the command line really wants this
1165 behavior. Other UIs probably would like the
1166 ability to decide for themselves if it is desired. */
1167 if (opts
.addressprint
&& mid_statement
)
1169 print_pc (uiout
, gdbarch
, frame
, get_frame_pc (frame
));
1173 print_source_lines (sal
.symtab
, sal
.line
, sal
.line
+ 1, 0);
1176 /* If disassemble-next-line is set to on and there is line debug
1177 messages, output assembly codes for next line. */
1178 if (disassemble_next_line
== AUTO_BOOLEAN_TRUE
)
1179 do_gdb_disassembly (get_frame_arch (frame
), -1, sal
.pc
, sal
.end
);
1182 if (set_current_sal
)
1186 if (get_frame_pc_if_available (frame
, &pc
))
1187 last_displayed_symtab_info
.set (sal
.pspace
, pc
, sal
.symtab
, sal
.line
);
1189 last_displayed_symtab_info
.invalidate ();
1192 annotate_frame_end ();
1194 gdb_flush (gdb_stdout
);
1200 clear_last_displayed_sal (void)
1202 last_displayed_symtab_info
.invalidate ();
1208 last_displayed_sal_is_valid (void)
1210 return last_displayed_symtab_info
.is_valid ();
1215 struct program_space
*
1216 get_last_displayed_pspace (void)
1218 return last_displayed_symtab_info
.pspace ();
1224 get_last_displayed_addr (void)
1226 return last_displayed_symtab_info
.address ();
1232 get_last_displayed_symtab (void)
1234 return last_displayed_symtab_info
.symtab ();
1240 get_last_displayed_line (void)
1242 return last_displayed_symtab_info
.line ();
1248 get_last_displayed_sal ()
1250 symtab_and_line sal
;
1252 if (last_displayed_symtab_info
.is_valid ())
1254 sal
.pspace
= last_displayed_symtab_info
.pspace ();
1255 sal
.pc
= last_displayed_symtab_info
.address ();
1256 sal
.symtab
= last_displayed_symtab_info
.symtab ();
1257 sal
.line
= last_displayed_symtab_info
.line ();
1264 /* Attempt to obtain the name, FUNLANG and optionally FUNCP of the function
1265 corresponding to FRAME. */
1267 gdb::unique_xmalloc_ptr
<char>
1268 find_frame_funname (struct frame_info
*frame
, enum language
*funlang
,
1269 struct symbol
**funcp
)
1271 struct symbol
*func
;
1272 gdb::unique_xmalloc_ptr
<char> funname
;
1274 *funlang
= language_unknown
;
1278 func
= get_frame_function (frame
);
1281 const char *print_name
= func
->print_name ();
1283 *funlang
= func
->language ();
1286 if (*funlang
== language_cplus
)
1288 /* It seems appropriate to use print_name() here,
1289 to display the demangled name that we already have
1290 stored in the symbol table, but we stored a version
1291 with DMGL_PARAMS turned on, and here we don't want to
1292 display parameters. So remove the parameters. */
1293 funname
= cp_remove_params (print_name
);
1296 /* If we didn't hit the C++ case above, set *funname
1298 if (funname
== NULL
)
1299 funname
.reset (xstrdup (print_name
));
1303 struct bound_minimal_symbol msymbol
;
1306 if (!get_frame_address_in_block_if_available (frame
, &pc
))
1309 msymbol
= lookup_minimal_symbol_by_pc (pc
);
1310 if (msymbol
.minsym
!= NULL
)
1312 funname
.reset (xstrdup (msymbol
.minsym
->print_name ()));
1313 *funlang
= msymbol
.minsym
->language ();
1321 print_frame (const frame_print_options
&fp_opts
,
1322 frame_info
*frame
, int print_level
,
1323 enum print_what print_what
, int print_args
,
1324 struct symtab_and_line sal
)
1326 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1327 struct ui_out
*uiout
= current_uiout
;
1328 enum language funlang
= language_unknown
;
1329 struct value_print_options opts
;
1330 struct symbol
*func
;
1334 pc_p
= get_frame_pc_if_available (frame
, &pc
);
1336 gdb::unique_xmalloc_ptr
<char> funname
1337 = find_frame_funname (frame
, &funlang
, &func
);
1339 annotate_frame_begin (print_level
? frame_relative_level (frame
) : 0,
1343 ui_out_emit_tuple
tuple_emitter (uiout
, "frame");
1348 uiout
->field_fmt_signed (2, ui_left
, "level",
1349 frame_relative_level (frame
));
1351 get_user_print_options (&opts
);
1352 if (opts
.addressprint
)
1354 || frame_show_address (frame
, sal
)
1355 || print_what
== LOC_AND_ADDRESS
)
1357 annotate_frame_address ();
1359 print_pc (uiout
, gdbarch
, frame
, pc
);
1361 uiout
->field_string ("addr", "<unavailable>",
1362 metadata_style
.style ());
1363 annotate_frame_address_end ();
1364 uiout
->text (" in ");
1366 annotate_frame_function_name ();
1369 fputs_filtered (funname
? funname
.get () : "??", &stb
);
1370 uiout
->field_stream ("func", stb
, function_name_style
.style ());
1371 uiout
->wrap_hint (3);
1372 annotate_frame_args ();
1379 if (gdbarch_frame_num_args_p (gdbarch
))
1381 numargs
= gdbarch_frame_num_args (gdbarch
, frame
);
1382 gdb_assert (numargs
>= 0);
1388 ui_out_emit_list
list_emitter (uiout
, "args");
1391 print_frame_args (fp_opts
, func
, frame
, numargs
, gdb_stdout
);
1393 catch (const gdb_exception_error
&e
)
1397 /* FIXME: ARGS must be a list. If one argument is a string it
1398 will have " that will not be properly escaped. */
1403 if (print_what
!= SHORT_LOCATION
&& sal
.symtab
)
1405 const char *filename_display
;
1407 filename_display
= symtab_to_filename_for_display (sal
.symtab
);
1408 annotate_frame_source_begin ();
1409 uiout
->wrap_hint (3);
1410 uiout
->text (" at ");
1411 annotate_frame_source_file ();
1412 uiout
->field_string ("file", filename_display
,
1413 file_name_style
.style ());
1414 if (uiout
->is_mi_like_p ())
1416 const char *fullname
= symtab_to_fullname (sal
.symtab
);
1418 uiout
->field_string ("fullname", fullname
);
1420 annotate_frame_source_file_end ();
1422 annotate_frame_source_line ();
1423 uiout
->field_signed ("line", sal
.line
);
1424 annotate_frame_source_end ();
1427 if (print_what
!= SHORT_LOCATION
1428 && pc_p
&& (funname
== NULL
|| sal
.symtab
== NULL
))
1430 char *lib
= solib_name_from_address (get_frame_program_space (frame
),
1431 get_frame_pc (frame
));
1435 annotate_frame_where ();
1436 uiout
->wrap_hint (2);
1437 uiout
->text (" from ");
1438 uiout
->field_string ("from", lib
, file_name_style
.style ());
1441 if (uiout
->is_mi_like_p ())
1442 uiout
->field_string ("arch",
1443 (gdbarch_bfd_arch_info (gdbarch
))->printable_name
);
1450 /* Completion function for "frame function", "info frame function", and
1451 "select-frame function" commands. */
1454 frame_selection_by_function_completer (struct cmd_list_element
*ignore
,
1455 completion_tracker
&tracker
,
1456 const char *text
, const char *word
)
1458 /* This is used to complete function names within a stack. It would be
1459 nice if we only offered functions that were actually in the stack.
1460 However, this would mean unwinding the stack to completion, which
1461 could take too long, or on a corrupted stack, possibly not end.
1462 Instead, we offer all symbol names as a safer choice. */
1463 collect_symbol_completion_matches (tracker
,
1464 complete_symbol_mode::EXPRESSION
,
1465 symbol_name_match_type::EXPRESSION
,
1469 /* Core of all the "info frame" sub-commands. Print information about a
1470 frame FI. If SELECTED_FRAME_P is true then the user didn't provide a
1471 frame specification, they just entered 'info frame'. If the user did
1472 provide a frame specification (for example 'info frame 0', 'info frame
1473 level 1') then SELECTED_FRAME_P will be false. */
1476 info_frame_command_core (struct frame_info
*fi
, bool selected_frame_p
)
1478 struct symbol
*func
;
1480 struct frame_info
*calling_frame_info
;
1482 const char *funname
= 0;
1483 enum language funlang
= language_unknown
;
1484 const char *pc_regname
;
1485 struct gdbarch
*gdbarch
;
1488 /* Initialize it to avoid "may be used uninitialized" warning. */
1489 CORE_ADDR caller_pc
= 0;
1490 int caller_pc_p
= 0;
1492 gdbarch
= get_frame_arch (fi
);
1494 /* Name of the value returned by get_frame_pc(). Per comments, "pc"
1495 is not a good name. */
1496 if (gdbarch_pc_regnum (gdbarch
) >= 0)
1497 /* OK, this is weird. The gdbarch_pc_regnum hardware register's value can
1498 easily not match that of the internal value returned by
1500 pc_regname
= gdbarch_register_name (gdbarch
, gdbarch_pc_regnum (gdbarch
));
1502 /* But then, this is weird to. Even without gdbarch_pc_regnum, an
1503 architectures will often have a hardware register called "pc",
1504 and that register's value, again, can easily not match
1508 frame_pc_p
= get_frame_pc_if_available (fi
, &frame_pc
);
1509 func
= get_frame_function (fi
);
1510 symtab_and_line sal
= find_frame_sal (fi
);
1512 gdb::unique_xmalloc_ptr
<char> func_only
;
1515 funname
= func
->print_name ();
1516 funlang
= func
->language ();
1517 if (funlang
== language_cplus
)
1519 /* It seems appropriate to use print_name() here,
1520 to display the demangled name that we already have
1521 stored in the symbol table, but we stored a version
1522 with DMGL_PARAMS turned on, and here we don't want to
1523 display parameters. So remove the parameters. */
1524 func_only
= cp_remove_params (funname
);
1527 funname
= func_only
.get ();
1530 else if (frame_pc_p
)
1532 struct bound_minimal_symbol msymbol
;
1534 msymbol
= lookup_minimal_symbol_by_pc (frame_pc
);
1535 if (msymbol
.minsym
!= NULL
)
1537 funname
= msymbol
.minsym
->print_name ();
1538 funlang
= msymbol
.minsym
->language ();
1541 calling_frame_info
= get_prev_frame (fi
);
1543 if (selected_frame_p
&& frame_relative_level (fi
) >= 0)
1545 printf_filtered (_("Stack level %d, frame at "),
1546 frame_relative_level (fi
));
1550 printf_filtered (_("Stack frame at "));
1552 puts_filtered (paddress (gdbarch
, get_frame_base (fi
)));
1553 printf_filtered (":\n");
1554 printf_filtered (" %s = ", pc_regname
);
1556 puts_filtered (paddress (gdbarch
, get_frame_pc (fi
)));
1558 fputs_styled ("<unavailable>", metadata_style
.style (), gdb_stdout
);
1563 printf_filtered (" in ");
1564 puts_filtered (funname
);
1570 styled_string (file_name_style
.style (),
1571 symtab_to_filename_for_display (sal
.symtab
)),
1573 puts_filtered ("; ");
1575 printf_filtered ("saved %s = ", pc_regname
);
1577 if (!frame_id_p (frame_unwind_caller_id (fi
)))
1578 val_print_not_saved (gdb_stdout
);
1583 caller_pc
= frame_unwind_caller_pc (fi
);
1586 catch (const gdb_exception_error
&ex
)
1590 case NOT_AVAILABLE_ERROR
:
1591 val_print_unavailable (gdb_stdout
);
1593 case OPTIMIZED_OUT_ERROR
:
1594 val_print_not_saved (gdb_stdout
);
1597 fprintf_styled (gdb_stdout
, metadata_style
.style (),
1606 puts_filtered (paddress (gdbarch
, caller_pc
));
1607 printf_filtered ("\n");
1609 if (calling_frame_info
== NULL
)
1611 enum unwind_stop_reason reason
;
1613 reason
= get_frame_unwind_stop_reason (fi
);
1614 if (reason
!= UNWIND_NO_REASON
)
1615 printf_filtered (_(" Outermost frame: %s\n"),
1616 frame_stop_reason_string (fi
));
1618 else if (get_frame_type (fi
) == TAILCALL_FRAME
)
1619 puts_filtered (" tail call frame");
1620 else if (get_frame_type (fi
) == INLINE_FRAME
)
1621 printf_filtered (" inlined into frame %d",
1622 frame_relative_level (get_prev_frame (fi
)));
1625 printf_filtered (" called by frame at ");
1626 puts_filtered (paddress (gdbarch
, get_frame_base (calling_frame_info
)));
1628 if (get_next_frame (fi
) && calling_frame_info
)
1629 puts_filtered (",");
1631 if (get_next_frame (fi
))
1633 printf_filtered (" caller of frame at ");
1634 puts_filtered (paddress (gdbarch
, get_frame_base (get_next_frame (fi
))));
1636 if (get_next_frame (fi
) || calling_frame_info
)
1637 puts_filtered ("\n");
1640 printf_filtered (" source language %s.\n",
1641 language_str (s
->language
));
1644 /* Address of the argument list for this frame, or 0. */
1645 CORE_ADDR arg_list
= get_frame_args_address (fi
);
1646 /* Number of args for this frame, or -1 if unknown. */
1650 printf_filtered (" Arglist at unknown address.\n");
1653 printf_filtered (" Arglist at ");
1654 puts_filtered (paddress (gdbarch
, arg_list
));
1655 printf_filtered (",");
1657 if (!gdbarch_frame_num_args_p (gdbarch
))
1660 puts_filtered (" args: ");
1664 numargs
= gdbarch_frame_num_args (gdbarch
, fi
);
1665 gdb_assert (numargs
>= 0);
1667 puts_filtered (" no args.");
1668 else if (numargs
== 1)
1669 puts_filtered (" 1 arg: ");
1671 printf_filtered (" %d args: ", numargs
);
1673 print_frame_args (user_frame_print_options
,
1674 func
, fi
, numargs
, gdb_stdout
);
1675 puts_filtered ("\n");
1679 /* Address of the local variables for this frame, or 0. */
1680 CORE_ADDR arg_list
= get_frame_locals_address (fi
);
1683 printf_filtered (" Locals at unknown address,");
1686 printf_filtered (" Locals at ");
1687 puts_filtered (paddress (gdbarch
, arg_list
));
1688 printf_filtered (",");
1692 /* Print as much information as possible on the location of all the
1698 int sp_regnum
= gdbarch_sp_regnum (gdbarch
);
1700 /* The sp is special; what's displayed isn't the save address, but
1701 the value of the previous frame's sp. This is a legacy thing,
1702 at one stage the frame cached the previous frame's SP instead
1703 of its address, hence it was easiest to just display the cached
1707 struct value
*value
= frame_unwind_register_value (fi
, sp_regnum
);
1708 gdb_assert (value
!= NULL
);
1710 if (!value_optimized_out (value
) && value_entirely_available (value
))
1712 if (VALUE_LVAL (value
) == not_lval
)
1715 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1716 int sp_size
= register_size (gdbarch
, sp_regnum
);
1718 sp
= extract_unsigned_integer
1719 (value_contents_all (value
).data (), sp_size
, byte_order
);
1721 printf_filtered (" Previous frame's sp is ");
1722 puts_filtered (paddress (gdbarch
, sp
));
1723 printf_filtered ("\n");
1725 else if (VALUE_LVAL (value
) == lval_memory
)
1727 printf_filtered (" Previous frame's sp at ");
1728 puts_filtered (paddress (gdbarch
, value_address (value
)));
1729 printf_filtered ("\n");
1731 else if (VALUE_LVAL (value
) == lval_register
)
1733 printf_filtered (" Previous frame's sp in %s\n",
1734 gdbarch_register_name (gdbarch
,
1735 VALUE_REGNUM (value
)));
1738 release_value (value
);
1741 /* else keep quiet. */
1745 numregs
= gdbarch_num_cooked_regs (gdbarch
);
1746 for (i
= 0; i
< numregs
; i
++)
1748 && gdbarch_register_reggroup_p (gdbarch
, i
, all_reggroup
))
1750 enum lval_type lval
;
1756 /* Find out the location of the saved register without
1757 fetching the corresponding value. */
1758 frame_register_unwind (fi
, i
, &optimized
, &unavailable
,
1759 &lval
, &addr
, &realnum
, NULL
);
1760 /* For moment, only display registers that were saved on the
1762 if (!optimized
&& !unavailable
&& lval
== lval_memory
)
1765 puts_filtered (" Saved registers:\n ");
1767 puts_filtered (",");
1769 printf_filtered (" %s at ",
1770 gdbarch_register_name (gdbarch
, i
));
1771 puts_filtered (paddress (gdbarch
, addr
));
1775 if (count
|| need_nl
)
1776 puts_filtered ("\n");
1780 /* Return the innermost frame at level LEVEL. */
1782 static struct frame_info
*
1783 leading_innermost_frame (int level
)
1785 struct frame_info
*leading
;
1787 leading
= get_current_frame ();
1789 gdb_assert (level
>= 0);
1791 while (leading
!= nullptr && level
)
1794 leading
= get_prev_frame (leading
);
1801 /* Return the starting frame needed to handle COUNT outermost frames. */
1803 static struct frame_info
*
1804 trailing_outermost_frame (int count
)
1806 struct frame_info
*current
;
1807 struct frame_info
*trailing
;
1809 trailing
= get_current_frame ();
1811 gdb_assert (count
> 0);
1814 while (current
!= nullptr && count
--)
1817 current
= get_prev_frame (current
);
1820 /* Will stop when CURRENT reaches the top of the stack.
1821 TRAILING will be COUNT below it. */
1822 while (current
!= nullptr)
1825 trailing
= get_prev_frame (trailing
);
1826 current
= get_prev_frame (current
);
1832 /* The core of all the "select-frame" sub-commands. Just wraps a call to
1836 select_frame_command_core (struct frame_info
*fi
, bool ignored
)
1838 frame_info
*prev_frame
= get_selected_frame ();
1840 if (get_selected_frame () != prev_frame
)
1841 gdb::observers::user_selected_context_changed
.notify (USER_SELECTED_FRAME
);
1847 select_frame_for_mi (struct frame_info
*fi
)
1849 select_frame_command_core (fi
, false /* Ignored. */);
1852 /* The core of all the "frame" sub-commands. Select frame FI, and if this
1853 means we change frame send out a change notification (otherwise, just
1854 reprint the current frame summary). */
1857 frame_command_core (struct frame_info
*fi
, bool ignored
)
1859 frame_info
*prev_frame
= get_selected_frame ();
1861 if (get_selected_frame () != prev_frame
)
1862 gdb::observers::user_selected_context_changed
.notify (USER_SELECTED_FRAME
);
1864 print_selected_thread_frame (current_uiout
, USER_SELECTED_FRAME
);
1867 /* The three commands 'frame', 'select-frame', and 'info frame' all have a
1868 common set of sub-commands that allow a specific frame to be selected.
1869 All of the sub-command functions are static methods within this class
1870 template which is then instantiated below. The template parameter is a
1871 callback used to implement the functionality of the base command
1872 ('frame', 'select-frame', or 'info frame').
1874 In the template parameter FI is the frame being selected. The
1875 SELECTED_FRAME_P flag is true if the frame being selected was done by
1876 default, which happens when the user uses the base command with no
1877 arguments. For example the commands 'info frame', 'select-frame',
1878 'frame' will all cause SELECTED_FRAME_P to be true. In all other cases
1879 SELECTED_FRAME_P is false. */
1881 template <void (*FPTR
) (struct frame_info
*fi
, bool selected_frame_p
)>
1882 class frame_command_helper
1886 /* The "frame level" family of commands. The ARG is an integer that is
1887 the frame's level in the stack. */
1889 level (const char *arg
, int from_tty
)
1891 int level
= value_as_long (parse_and_eval (arg
));
1892 struct frame_info
*fid
1893 = find_relative_frame (get_current_frame (), &level
);
1895 error (_("No frame at level %s."), arg
);
1899 /* The "frame address" family of commands. ARG is a stack-pointer
1900 address for an existing frame. This command does not allow new
1901 frames to be created. */
1904 address (const char *arg
, int from_tty
)
1906 CORE_ADDR addr
= value_as_address (parse_and_eval (arg
));
1907 struct frame_info
*fid
= find_frame_for_address (addr
);
1909 error (_("No frame at address %s."), arg
);
1913 /* The "frame view" family of commands. ARG is one or two addresses and
1914 is used to view a frame that might be outside the current backtrace.
1915 The addresses are stack-pointer address, and (optional) pc-address. */
1918 view (const char *args
, int from_tty
)
1920 struct frame_info
*fid
;
1923 error (_("Missing address argument to view a frame"));
1925 gdb_argv
argv (args
);
1927 if (argv
.count () == 2)
1931 addr
[0] = value_as_address (parse_and_eval (argv
[0]));
1932 addr
[1] = value_as_address (parse_and_eval (argv
[1]));
1933 fid
= create_new_frame (addr
[0], addr
[1]);
1937 CORE_ADDR addr
= value_as_address (parse_and_eval (argv
[0]));
1938 fid
= create_new_frame (addr
, false);
1943 /* The "frame function" family of commands. ARG is the name of a
1944 function within the stack, the first function (searching from frame
1945 0) with that name will be selected. */
1948 function (const char *arg
, int from_tty
)
1951 error (_("Missing function name argument"));
1952 struct frame_info
*fid
= find_frame_for_function (arg
);
1954 error (_("No frame for function \"%s\"."), arg
);
1958 /* The "frame" base command, that is, when no sub-command is specified.
1959 If one argument is provided then we assume that this is a frame's
1960 level as historically, this was the supported command syntax that was
1963 If no argument is provided, then the current frame is selected. */
1966 base_command (const char *arg
, int from_tty
)
1969 FPTR (get_selected_frame (_("No stack.")), true);
1971 level (arg
, from_tty
);
1975 /* Instantiate three FRAME_COMMAND_HELPER instances to implement the
1976 sub-commands for 'info frame', 'frame', and 'select-frame' commands. */
1978 static frame_command_helper
<info_frame_command_core
> info_frame_cmd
;
1979 static frame_command_helper
<frame_command_core
> frame_cmd
;
1980 static frame_command_helper
<select_frame_command_core
> select_frame_cmd
;
1982 /* Print briefly all stack frames or just the innermost COUNT_EXP
1986 backtrace_command_1 (const frame_print_options
&fp_opts
,
1987 const backtrace_cmd_options
&bt_opts
,
1988 const char *count_exp
, int from_tty
)
1991 struct frame_info
*fi
;
1993 int py_start
= 0, py_end
= 0;
1994 enum ext_lang_bt_status result
= EXT_LANG_BT_ERROR
;
1996 if (!target_has_stack ())
1997 error (_("No stack."));
2001 count
= parse_and_eval_long (count_exp
);
2007 /* The argument to apply_ext_lang_frame_filter is the number
2008 of the final frame to print, and frames start at 0. */
2018 frame_filter_flags flags
= 0;
2021 flags
|= PRINT_LOCALS
;
2023 flags
|= PRINT_HIDE
;
2025 if (!bt_opts
.no_filters
)
2027 enum ext_lang_frame_args arg_type
;
2029 flags
|= PRINT_LEVEL
| PRINT_FRAME_INFO
| PRINT_ARGS
;
2031 flags
|= PRINT_MORE_FRAMES
;
2033 if (fp_opts
.print_frame_arguments
== print_frame_arguments_scalars
)
2034 arg_type
= CLI_SCALAR_VALUES
;
2035 else if (fp_opts
.print_frame_arguments
== print_frame_arguments_all
)
2036 arg_type
= CLI_ALL_VALUES
;
2037 else if (fp_opts
.print_frame_arguments
== print_frame_arguments_presence
)
2038 arg_type
= CLI_PRESENCE
;
2039 else if (fp_opts
.print_frame_arguments
== print_frame_arguments_none
)
2040 arg_type
= NO_VALUES
;
2044 result
= apply_ext_lang_frame_filter (get_current_frame (), flags
,
2045 arg_type
, current_uiout
,
2049 /* Run the inbuilt backtrace if there are no filters registered, or
2050 "-no-filters" has been specified from the command. */
2051 if (bt_opts
.no_filters
|| result
== EXT_LANG_BT_NO_FILTERS
)
2053 struct frame_info
*trailing
;
2055 /* The following code must do two things. First, it must set the
2056 variable TRAILING to the frame from which we should start
2057 printing. Second, it must set the variable count to the number
2058 of frames which we should print, or -1 if all of them. */
2060 if (count_exp
!= NULL
&& count
< 0)
2062 trailing
= trailing_outermost_frame (-count
);
2066 trailing
= get_current_frame ();
2068 for (fi
= trailing
; fi
&& count
--; fi
= get_prev_frame (fi
))
2072 /* Don't use print_stack_frame; if an error() occurs it probably
2073 means further attempts to backtrace would fail (on the other
2074 hand, perhaps the code does or could be fixed to make sure
2075 the frame->prev field gets set to NULL in that case). */
2077 print_frame_info (fp_opts
, fi
, 1, LOCATION
, 1, 0);
2078 if ((flags
& PRINT_LOCALS
) != 0)
2080 struct frame_id frame_id
= get_frame_id (fi
);
2082 print_frame_local_vars (fi
, false, NULL
, NULL
, 1, gdb_stdout
);
2084 /* print_frame_local_vars invalidates FI. */
2085 fi
= frame_find_by_id (frame_id
);
2089 warning (_("Unable to restore previously selected frame."));
2094 /* Save the last frame to check for error conditions. */
2098 /* If we've stopped before the end, mention that. */
2100 printf_filtered (_("(More stack frames follow...)\n"));
2102 /* If we've run out of frames, and the reason appears to be an error
2103 condition, print it. */
2104 if (fi
== NULL
&& trailing
!= NULL
)
2106 enum unwind_stop_reason reason
;
2108 reason
= get_frame_unwind_stop_reason (trailing
);
2109 if (reason
>= UNWIND_FIRST_ERROR
)
2110 printf_filtered (_("Backtrace stopped: %s\n"),
2111 frame_stop_reason_string (trailing
));
2116 /* Create an option_def_group array grouping all the "backtrace"
2117 options, with FP_OPTS, BT_CMD_OPT, SET_BT_OPTS as contexts. */
2119 static inline std::array
<gdb::option::option_def_group
, 3>
2120 make_backtrace_options_def_group (frame_print_options
*fp_opts
,
2121 backtrace_cmd_options
*bt_cmd_opts
,
2122 set_backtrace_options
*set_bt_opts
)
2125 { {frame_print_option_defs
}, fp_opts
},
2126 { {set_backtrace_option_defs
}, set_bt_opts
},
2127 { {backtrace_command_option_defs
}, bt_cmd_opts
}
2131 /* Parse the backtrace command's qualifiers. Returns ARG advanced
2132 past the qualifiers, if any. BT_CMD_OPTS, if not null, is used to
2133 store the parsed qualifiers. */
2136 parse_backtrace_qualifiers (const char *arg
,
2137 backtrace_cmd_options
*bt_cmd_opts
= nullptr)
2141 const char *save_arg
= arg
;
2142 std::string this_arg
= extract_arg (&arg
);
2144 if (this_arg
.empty ())
2147 if (subset_compare (this_arg
.c_str (), "no-filters"))
2149 if (bt_cmd_opts
!= nullptr)
2150 bt_cmd_opts
->no_filters
= true;
2152 else if (subset_compare (this_arg
.c_str (), "full"))
2154 if (bt_cmd_opts
!= nullptr)
2155 bt_cmd_opts
->full
= true;
2157 else if (subset_compare (this_arg
.c_str (), "hide"))
2159 if (bt_cmd_opts
!= nullptr)
2160 bt_cmd_opts
->hide
= true;
2164 /* Not a recognized qualifier, so stop. */
2171 backtrace_command (const char *arg
, int from_tty
)
2173 frame_print_options fp_opts
= user_frame_print_options
;
2174 backtrace_cmd_options bt_cmd_opts
;
2175 set_backtrace_options set_bt_opts
= user_set_backtrace_options
;
2178 = make_backtrace_options_def_group (&fp_opts
, &bt_cmd_opts
, &set_bt_opts
);
2179 gdb::option::process_options
2180 (&arg
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
2182 /* Parse non-'-'-prefixed qualifiers, for backwards
2186 arg
= parse_backtrace_qualifiers (arg
, &bt_cmd_opts
);
2191 /* These options are handled quite deep in the unwind machinery, so
2192 we get to pass them down by swapping globals. */
2193 scoped_restore restore_set_backtrace_options
2194 = make_scoped_restore (&user_set_backtrace_options
, set_bt_opts
);
2196 backtrace_command_1 (fp_opts
, bt_cmd_opts
, arg
, from_tty
);
2199 /* Completer for the "backtrace" command. */
2202 backtrace_command_completer (struct cmd_list_element
*ignore
,
2203 completion_tracker
&tracker
,
2204 const char *text
, const char */
*word*/
)
2207 = make_backtrace_options_def_group (nullptr, nullptr, nullptr);
2208 if (gdb::option::complete_options
2209 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
2214 const char *p
= skip_to_space (text
);
2217 static const char *const backtrace_cmd_qualifier_choices
[] = {
2218 "full", "no-filters", "hide", nullptr,
2220 complete_on_enum (tracker
, backtrace_cmd_qualifier_choices
,
2223 if (tracker
.have_completions ())
2228 const char *cmd
= parse_backtrace_qualifiers (text
);
2229 tracker
.advance_custom_word_point_by (cmd
- text
);
2234 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
2235 expression_completer (ignore
, tracker
, text
, word
);
2238 /* Iterate over the local variables of a block B, calling CB with
2242 iterate_over_block_locals (const struct block
*b
,
2243 iterate_over_block_arg_local_vars_cb cb
,
2246 struct block_iterator iter
;
2249 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
2251 switch (SYMBOL_CLASS (sym
))
2258 case LOC_OPTIMIZED_OUT
:
2259 if (SYMBOL_IS_ARGUMENT (sym
))
2261 if (SYMBOL_DOMAIN (sym
) == COMMON_BLOCK_DOMAIN
)
2263 (*cb
) (sym
->print_name (), sym
, cb_data
);
2267 /* Ignore symbols which are not locals. */
2273 /* Iterate over all the local variables in block B, including all its
2274 superblocks, stopping when the top-level block is reached. */
2277 iterate_over_block_local_vars (const struct block
*block
,
2278 iterate_over_block_arg_local_vars_cb cb
,
2283 iterate_over_block_locals (block
, cb
, cb_data
);
2284 /* After handling the function's top-level block, stop. Don't
2285 continue to its superblock, the block of per-file
2287 if (BLOCK_FUNCTION (block
))
2289 block
= BLOCK_SUPERBLOCK (block
);
2293 /* Data to be passed around in the calls to the locals and args
2296 struct print_variable_and_value_data
2298 gdb::optional
<compiled_regex
> preg
;
2299 gdb::optional
<compiled_regex
> treg
;
2300 struct frame_id frame_id
;
2302 struct ui_file
*stream
;
2306 /* The callback for the locals and args iterators. */
2309 do_print_variable_and_value (const char *print_name
,
2313 struct print_variable_and_value_data
*p
2314 = (struct print_variable_and_value_data
*) cb_data
;
2315 struct frame_info
*frame
;
2317 if (p
->preg
.has_value ()
2318 && p
->preg
->exec (sym
->natural_name (), 0, NULL
, 0) != 0)
2320 if (p
->treg
.has_value ()
2321 && !treg_matches_sym_type_name (*p
->treg
, sym
))
2323 if (language_def (sym
->language ())->symbol_printing_suppressed (sym
))
2326 frame
= frame_find_by_id (p
->frame_id
);
2329 warning (_("Unable to restore previously selected frame."));
2333 print_variable_and_value (print_name
, sym
, frame
, p
->stream
, p
->num_tabs
);
2335 /* print_variable_and_value invalidates FRAME. */
2338 p
->values_printed
= 1;
2341 /* Prepares the regular expression REG from REGEXP.
2342 If REGEXP is NULL, it results in an empty regular expression. */
2345 prepare_reg (const char *regexp
, gdb::optional
<compiled_regex
> *reg
)
2349 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
2351 reg
->emplace (regexp
, cflags
, _("Invalid regexp"));
2357 /* Print all variables from the innermost up to the function block of FRAME.
2358 Print them with values to STREAM indented by NUM_TABS.
2359 If REGEXP is not NULL, only print local variables whose name
2361 If T_REGEXP is not NULL, only print local variables whose type
2363 If no local variables have been printed and !QUIET, prints a message
2364 explaining why no local variables could be printed.
2366 This function will invalidate FRAME. */
2369 print_frame_local_vars (struct frame_info
*frame
,
2371 const char *regexp
, const char *t_regexp
,
2372 int num_tabs
, struct ui_file
*stream
)
2374 struct print_variable_and_value_data cb_data
;
2375 const struct block
*block
;
2378 if (!get_frame_pc_if_available (frame
, &pc
))
2381 fprintf_filtered (stream
,
2382 _("PC unavailable, cannot determine locals.\n"));
2386 block
= get_frame_block (frame
, 0);
2390 fprintf_filtered (stream
, "No symbol table info available.\n");
2394 prepare_reg (regexp
, &cb_data
.preg
);
2395 prepare_reg (t_regexp
, &cb_data
.treg
);
2396 cb_data
.frame_id
= get_frame_id (frame
);
2397 cb_data
.num_tabs
= 4 * num_tabs
;
2398 cb_data
.stream
= stream
;
2399 cb_data
.values_printed
= 0;
2401 /* Temporarily change the selected frame to the given FRAME.
2402 This allows routines that rely on the selected frame instead
2403 of being given a frame as parameter to use the correct frame. */
2404 scoped_restore_selected_frame restore_selected_frame
;
2405 select_frame (frame
);
2407 iterate_over_block_local_vars (block
,
2408 do_print_variable_and_value
,
2411 if (!cb_data
.values_printed
&& !quiet
)
2413 if (regexp
== NULL
&& t_regexp
== NULL
)
2414 fprintf_filtered (stream
, _("No locals.\n"));
2416 fprintf_filtered (stream
, _("No matching locals.\n"));
2420 /* Structure to hold the values of the options used by the 'info
2421 variables' command and other similar commands. These correspond to the
2422 -q and -t options. */
2424 struct info_print_options
2427 std::string type_regexp
;
2430 /* The options used by the 'info locals' and 'info args' commands. */
2432 static const gdb::option::option_def info_print_options_defs
[] = {
2433 gdb::option::boolean_option_def
<info_print_options
> {
2435 [] (info_print_options
*opt
) { return &opt
->quiet
; },
2436 nullptr, /* show_cmd_cb */
2437 nullptr /* set_doc */
2440 gdb::option::string_option_def
<info_print_options
> {
2442 [] (info_print_options
*opt
) { return &opt
->type_regexp
; },
2443 nullptr, /* show_cmd_cb */
2444 nullptr /* set_doc */
2448 /* Returns the option group used by 'info locals' and 'info args'
2451 static gdb::option::option_def_group
2452 make_info_print_options_def_group (info_print_options
*opts
)
2454 return {{info_print_options_defs
}, opts
};
2457 /* Command completer for 'info locals' and 'info args'. */
2460 info_print_command_completer (struct cmd_list_element
*ignore
,
2461 completion_tracker
&tracker
,
2462 const char *text
, const char * /* word */)
2465 = make_info_print_options_def_group (nullptr);
2466 if (gdb::option::complete_options
2467 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
2470 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
2471 symbol_completer (ignore
, tracker
, text
, word
);
2474 /* Implement the 'info locals' command. */
2477 info_locals_command (const char *args
, int from_tty
)
2479 info_print_options opts
;
2480 auto grp
= make_info_print_options_def_group (&opts
);
2481 gdb::option::process_options
2482 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
2483 if (args
!= nullptr && *args
== '\0')
2486 print_frame_local_vars
2487 (get_selected_frame (_("No frame selected.")),
2489 opts
.type_regexp
.empty () ? nullptr : opts
.type_regexp
.c_str (),
2493 /* Iterate over all the argument variables in block B. */
2496 iterate_over_block_arg_vars (const struct block
*b
,
2497 iterate_over_block_arg_local_vars_cb cb
,
2500 struct block_iterator iter
;
2501 struct symbol
*sym
, *sym2
;
2503 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
2505 /* Don't worry about things which aren't arguments. */
2506 if (SYMBOL_IS_ARGUMENT (sym
))
2508 /* We have to look up the symbol because arguments can have
2509 two entries (one a parameter, one a local) and the one we
2510 want is the local, which lookup_symbol will find for us.
2511 This includes gcc1 (not gcc2) on the sparc when passing a
2512 small structure and gcc2 when the argument type is float
2513 and it is passed as a double and converted to float by
2514 the prologue (in the latter case the type of the LOC_ARG
2515 symbol is double and the type of the LOC_LOCAL symbol is
2516 float). There are also LOC_ARG/LOC_REGISTER pairs which
2517 are not combined in symbol-reading. */
2519 sym2
= lookup_symbol_search_name (sym
->search_name (),
2520 b
, VAR_DOMAIN
).symbol
;
2521 (*cb
) (sym
->print_name (), sym2
, cb_data
);
2526 /* Print all argument variables of the function of FRAME.
2527 Print them with values to STREAM.
2528 If REGEXP is not NULL, only print argument variables whose name
2530 If T_REGEXP is not NULL, only print argument variables whose type
2532 If no argument variables have been printed and !QUIET, prints a message
2533 explaining why no argument variables could be printed.
2535 This function will invalidate FRAME. */
2538 print_frame_arg_vars (struct frame_info
*frame
,
2540 const char *regexp
, const char *t_regexp
,
2541 struct ui_file
*stream
)
2543 struct print_variable_and_value_data cb_data
;
2544 struct symbol
*func
;
2546 gdb::optional
<compiled_regex
> preg
;
2547 gdb::optional
<compiled_regex
> treg
;
2549 if (!get_frame_pc_if_available (frame
, &pc
))
2552 fprintf_filtered (stream
,
2553 _("PC unavailable, cannot determine args.\n"));
2557 func
= get_frame_function (frame
);
2561 fprintf_filtered (stream
, _("No symbol table info available.\n"));
2565 prepare_reg (regexp
, &cb_data
.preg
);
2566 prepare_reg (t_regexp
, &cb_data
.treg
);
2567 cb_data
.frame_id
= get_frame_id (frame
);
2568 cb_data
.num_tabs
= 0;
2569 cb_data
.stream
= stream
;
2570 cb_data
.values_printed
= 0;
2572 iterate_over_block_arg_vars (SYMBOL_BLOCK_VALUE (func
),
2573 do_print_variable_and_value
, &cb_data
);
2575 /* do_print_variable_and_value invalidates FRAME. */
2578 if (!cb_data
.values_printed
&& !quiet
)
2580 if (regexp
== NULL
&& t_regexp
== NULL
)
2581 fprintf_filtered (stream
, _("No arguments.\n"));
2583 fprintf_filtered (stream
, _("No matching arguments.\n"));
2587 /* Implement the 'info args' command. */
2590 info_args_command (const char *args
, int from_tty
)
2592 info_print_options opts
;
2593 auto grp
= make_info_print_options_def_group (&opts
);
2594 gdb::option::process_options
2595 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
2596 if (args
!= nullptr && *args
== '\0')
2599 print_frame_arg_vars
2600 (get_selected_frame (_("No frame selected.")),
2602 opts
.type_regexp
.empty () ? nullptr : opts
.type_regexp
.c_str (),
2606 /* Return the symbol-block in which the selected frame is executing.
2607 Can return zero under various legitimate circumstances.
2609 If ADDR_IN_BLOCK is non-zero, set *ADDR_IN_BLOCK to the relevant
2610 code address within the block returned. We use this to decide
2611 which macros are in scope. */
2613 const struct block
*
2614 get_selected_block (CORE_ADDR
*addr_in_block
)
2616 if (!has_stack_frames ())
2619 return get_frame_block (get_selected_frame (NULL
), addr_in_block
);
2622 /* Find a frame a certain number of levels away from FRAME.
2623 LEVEL_OFFSET_PTR points to an int containing the number of levels.
2624 Positive means go to earlier frames (up); negative, the reverse.
2625 The int that contains the number of levels is counted toward
2626 zero as the frames for those levels are found.
2627 If the top or bottom frame is reached, that frame is returned,
2628 but the final value of *LEVEL_OFFSET_PTR is nonzero and indicates
2629 how much farther the original request asked to go. */
2632 find_relative_frame (struct frame_info
*frame
, int *level_offset_ptr
)
2634 /* Going up is simple: just call get_prev_frame enough times or
2635 until the initial frame is reached. */
2636 while (*level_offset_ptr
> 0)
2638 struct frame_info
*prev
= get_prev_frame (frame
);
2642 (*level_offset_ptr
)--;
2646 /* Going down is just as simple. */
2647 while (*level_offset_ptr
< 0)
2649 struct frame_info
*next
= get_next_frame (frame
);
2653 (*level_offset_ptr
)++;
2660 /* Select the frame up one or COUNT_EXP stack levels from the
2661 previously selected frame, and print it briefly. */
2664 up_silently_base (const char *count_exp
)
2666 struct frame_info
*frame
;
2670 count
= parse_and_eval_long (count_exp
);
2672 frame
= find_relative_frame (get_selected_frame ("No stack."), &count
);
2673 if (count
!= 0 && count_exp
== NULL
)
2674 error (_("Initial frame selected; you cannot go up."));
2675 select_frame (frame
);
2679 up_silently_command (const char *count_exp
, int from_tty
)
2681 up_silently_base (count_exp
);
2685 up_command (const char *count_exp
, int from_tty
)
2687 up_silently_base (count_exp
);
2688 gdb::observers::user_selected_context_changed
.notify (USER_SELECTED_FRAME
);
2691 /* Select the frame down one or COUNT_EXP stack levels from the previously
2692 selected frame, and print it briefly. */
2695 down_silently_base (const char *count_exp
)
2697 struct frame_info
*frame
;
2701 count
= -parse_and_eval_long (count_exp
);
2703 frame
= find_relative_frame (get_selected_frame ("No stack."), &count
);
2704 if (count
!= 0 && count_exp
== NULL
)
2706 /* We only do this if COUNT_EXP is not specified. That way
2707 "down" means to really go down (and let me know if that is
2708 impossible), but "down 9999" can be used to mean go all the
2709 way down without getting an error. */
2711 error (_("Bottom (innermost) frame selected; you cannot go down."));
2714 select_frame (frame
);
2718 down_silently_command (const char *count_exp
, int from_tty
)
2720 down_silently_base (count_exp
);
2724 down_command (const char *count_exp
, int from_tty
)
2726 down_silently_base (count_exp
);
2727 gdb::observers::user_selected_context_changed
.notify (USER_SELECTED_FRAME
);
2731 return_command (const char *retval_exp
, int from_tty
)
2733 /* Initialize it just to avoid a GCC false warning. */
2734 enum return_value_convention rv_conv
= RETURN_VALUE_STRUCT_CONVENTION
;
2735 struct frame_info
*thisframe
;
2736 struct gdbarch
*gdbarch
;
2737 struct symbol
*thisfun
;
2738 struct value
*return_value
= NULL
;
2739 struct value
*function
= NULL
;
2740 const char *query_prefix
= "";
2742 thisframe
= get_selected_frame ("No selected frame.");
2743 thisfun
= get_frame_function (thisframe
);
2744 gdbarch
= get_frame_arch (thisframe
);
2746 if (get_frame_type (get_current_frame ()) == INLINE_FRAME
)
2747 error (_("Can not force return from an inlined function."));
2749 /* Compute the return value. If the computation triggers an error,
2750 let it bail. If the return type can't be handled, set
2751 RETURN_VALUE to NULL, and QUERY_PREFIX to an informational
2755 expression_up retval_expr
= parse_expression (retval_exp
);
2756 struct type
*return_type
= NULL
;
2758 /* Compute the return value. Should the computation fail, this
2759 call throws an error. */
2760 return_value
= evaluate_expression (retval_expr
.get ());
2762 /* Cast return value to the return type of the function. Should
2763 the cast fail, this call throws an error. */
2764 if (thisfun
!= NULL
)
2765 return_type
= TYPE_TARGET_TYPE (SYMBOL_TYPE (thisfun
));
2766 if (return_type
== NULL
)
2768 if (retval_expr
->first_opcode () != UNOP_CAST
2769 && retval_expr
->first_opcode () != UNOP_CAST_TYPE
)
2770 error (_("Return value type not available for selected "
2772 "Please use an explicit cast of the value to return."));
2773 return_type
= value_type (return_value
);
2775 return_type
= check_typedef (return_type
);
2776 return_value
= value_cast (return_type
, return_value
);
2778 /* Make sure the value is fully evaluated. It may live in the
2779 stack frame we're about to pop. */
2780 if (value_lazy (return_value
))
2781 value_fetch_lazy (return_value
);
2783 if (thisfun
!= NULL
)
2784 function
= read_var_value (thisfun
, NULL
, thisframe
);
2786 rv_conv
= RETURN_VALUE_REGISTER_CONVENTION
;
2787 if (return_type
->code () == TYPE_CODE_VOID
)
2788 /* If the return-type is "void", don't try to find the
2789 return-value's location. However, do still evaluate the
2790 return expression so that, even when the expression result
2791 is discarded, side effects such as "return i++" still
2793 return_value
= NULL
;
2794 else if (thisfun
!= NULL
)
2796 rv_conv
= struct_return_convention (gdbarch
, function
, return_type
);
2797 if (rv_conv
== RETURN_VALUE_STRUCT_CONVENTION
2798 || rv_conv
== RETURN_VALUE_ABI_RETURNS_ADDRESS
)
2800 query_prefix
= "The location at which to store the "
2801 "function's return value is unknown.\n"
2802 "If you continue, the return value "
2803 "that you specified will be ignored.\n";
2804 return_value
= NULL
;
2809 /* Does an interactive user really want to do this? Include
2810 information, such as how well GDB can handle the return value, in
2811 the query message. */
2816 if (thisfun
== NULL
)
2817 confirmed
= query (_("%sMake selected stack frame return now? "),
2821 if (TYPE_NO_RETURN (thisfun
->type
))
2822 warning (_("Function does not return normally to caller."));
2823 confirmed
= query (_("%sMake %s return now? "), query_prefix
,
2824 thisfun
->print_name ());
2827 error (_("Not confirmed"));
2830 /* Discard the selected frame and all frames inner-to it. */
2831 frame_pop (get_selected_frame (NULL
));
2833 /* Store RETURN_VALUE in the just-returned register set. */
2834 if (return_value
!= NULL
)
2836 struct type
*return_type
= value_type (return_value
);
2837 struct gdbarch
*cache_arch
= get_current_regcache ()->arch ();
2839 gdb_assert (rv_conv
!= RETURN_VALUE_STRUCT_CONVENTION
2840 && rv_conv
!= RETURN_VALUE_ABI_RETURNS_ADDRESS
);
2841 gdbarch_return_value (cache_arch
, function
, return_type
,
2842 get_current_regcache (), NULL
/*read*/,
2843 value_contents (return_value
).data () /*write*/);
2846 /* If we are at the end of a call dummy now, pop the dummy frame
2848 if (get_frame_type (get_current_frame ()) == DUMMY_FRAME
)
2849 frame_pop (get_current_frame ());
2851 select_frame (get_current_frame ());
2852 /* If interactive, print the frame that is now current. */
2854 print_stack_frame (get_selected_frame (NULL
), 1, SRC_AND_LOC
, 1);
2857 /* Find the most inner frame in the current stack for a function called
2858 FUNCTION_NAME. If no matching frame is found return NULL. */
2860 static struct frame_info
*
2861 find_frame_for_function (const char *function_name
)
2863 /* Used to hold the lower and upper addresses for each of the
2864 SYMTAB_AND_LINEs found for functions matching FUNCTION_NAME. */
2865 struct function_bounds
2867 CORE_ADDR low
, high
;
2869 struct frame_info
*frame
;
2873 gdb_assert (function_name
!= NULL
);
2875 frame
= get_current_frame ();
2876 std::vector
<symtab_and_line
> sals
2877 = decode_line_with_current_source (function_name
,
2878 DECODE_LINE_FUNFIRSTLINE
);
2879 gdb::def_vector
<function_bounds
> func_bounds (sals
.size ());
2880 for (size_t i
= 0; i
< sals
.size (); i
++)
2882 if (sals
[i
].pspace
!= current_program_space
)
2883 func_bounds
[i
].low
= func_bounds
[i
].high
= 0;
2884 else if (sals
[i
].pc
== 0
2885 || find_pc_partial_function (sals
[i
].pc
, NULL
,
2886 &func_bounds
[i
].low
,
2887 &func_bounds
[i
].high
) == 0)
2888 func_bounds
[i
].low
= func_bounds
[i
].high
= 0;
2893 for (size_t i
= 0; (i
< sals
.size () && !found
); i
++)
2894 found
= (get_frame_pc (frame
) >= func_bounds
[i
].low
2895 && get_frame_pc (frame
) < func_bounds
[i
].high
);
2899 frame
= find_relative_frame (frame
, &level
);
2902 while (!found
&& level
== 0);
2910 /* Implements the dbx 'func' command. */
2913 func_command (const char *arg
, int from_tty
)
2918 struct frame_info
*frame
= find_frame_for_function (arg
);
2920 error (_("'%s' not within current stack frame."), arg
);
2921 if (frame
!= get_selected_frame (NULL
))
2923 select_frame (frame
);
2924 print_stack_frame (get_selected_frame (NULL
), 1, SRC_AND_LOC
, 1);
2928 /* The qcs command line flags for the "frame apply" commands. Keep
2929 this in sync with the "thread apply" commands. */
2931 using qcs_flag_option_def
2932 = gdb::option::flag_option_def
<qcs_flags
>;
2934 static const gdb::option::option_def fr_qcs_flags_option_defs
[] = {
2935 qcs_flag_option_def
{
2936 "q", [] (qcs_flags
*opt
) { return &opt
->quiet
; },
2937 N_("Disables printing the frame location information."),
2940 qcs_flag_option_def
{
2941 "c", [] (qcs_flags
*opt
) { return &opt
->cont
; },
2942 N_("Print any error raised by COMMAND and continue."),
2945 qcs_flag_option_def
{
2946 "s", [] (qcs_flags
*opt
) { return &opt
->silent
; },
2947 N_("Silently ignore any errors or empty output produced by COMMAND."),
2951 /* Create an option_def_group array for all the "frame apply" options,
2952 with FLAGS and SET_BT_OPTS as context. */
2954 static inline std::array
<gdb::option::option_def_group
, 2>
2955 make_frame_apply_options_def_group (qcs_flags
*flags
,
2956 set_backtrace_options
*set_bt_opts
)
2959 { {fr_qcs_flags_option_defs
}, flags
},
2960 { {set_backtrace_option_defs
}, set_bt_opts
},
2964 /* Apply a GDB command to all stack frames, or a set of identified frames,
2965 or innermost COUNT frames.
2966 With a negative COUNT, apply command on outermost -COUNT frames.
2968 frame apply 3 info frame Apply 'info frame' to frames 0, 1, 2
2969 frame apply -3 info frame Apply 'info frame' to outermost 3 frames.
2970 frame apply all x/i $pc Apply 'x/i $pc' cmd to all frames.
2971 frame apply all -s p local_var_no_idea_in_which_frame
2972 If a frame has a local variable called
2973 local_var_no_idea_in_which_frame, print frame
2974 and value of local_var_no_idea_in_which_frame.
2975 frame apply all -s -q p local_var_no_idea_in_which_frame
2976 Same as before, but only print the variable value.
2977 frame apply level 2-5 0 4-7 -s p i = i + 1
2978 Adds 1 to the variable i in the specified frames.
2979 Note that i will be incremented twice in
2982 /* Apply a GDB command to COUNT stack frames, starting at TRAILING.
2983 CMD starts with 0 or more qcs flags followed by the GDB command to apply.
2984 COUNT -1 means all frames starting at TRAILING. WHICH_COMMAND is used
2985 for error messages. */
2988 frame_apply_command_count (const char *which_command
,
2989 const char *cmd
, int from_tty
,
2990 struct frame_info
*trailing
, int count
)
2993 set_backtrace_options set_bt_opts
= user_set_backtrace_options
;
2995 auto group
= make_frame_apply_options_def_group (&flags
, &set_bt_opts
);
2996 gdb::option::process_options
2997 (&cmd
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
);
2999 validate_flags_qcs (which_command
, &flags
);
3001 if (cmd
== NULL
|| *cmd
== '\0')
3002 error (_("Please specify a command to apply on the selected frames"));
3004 /* The below will restore the current inferior/thread/frame.
3005 Usually, only the frame is effectively to be restored.
3006 But in case CMD switches of inferior/thread, better restore
3008 scoped_restore_current_thread restore_thread
;
3010 /* These options are handled quite deep in the unwind machinery, so
3011 we get to pass them down by swapping globals. */
3012 scoped_restore restore_set_backtrace_options
3013 = make_scoped_restore (&user_set_backtrace_options
, set_bt_opts
);
3015 for (frame_info
*fi
= trailing
; fi
&& count
--; fi
= get_prev_frame (fi
))
3022 std::string cmd_result
;
3024 /* In case CMD switches of inferior/thread/frame, the below
3025 restores the inferior/thread/frame. FI can then be
3026 set to the selected frame. */
3027 scoped_restore_current_thread restore_fi_current_frame
;
3029 execute_command_to_string
3030 (cmd_result
, cmd
, from_tty
, gdb_stdout
->term_out ());
3032 fi
= get_selected_frame (_("frame apply "
3033 "unable to get selected frame."));
3034 if (!flags
.silent
|| cmd_result
.length () > 0)
3037 print_stack_frame (fi
, 1, LOCATION
, 0);
3038 printf_filtered ("%s", cmd_result
.c_str ());
3041 catch (const gdb_exception_error
&ex
)
3043 fi
= get_selected_frame (_("frame apply "
3044 "unable to get selected frame."));
3048 print_stack_frame (fi
, 1, LOCATION
, 0);
3050 printf_filtered ("%s\n", ex
.what ());
3058 /* Completer for the "frame apply ..." commands. */
3061 frame_apply_completer (completion_tracker
&tracker
, const char *text
)
3063 const auto group
= make_frame_apply_options_def_group (nullptr, nullptr);
3064 if (gdb::option::complete_options
3065 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
3068 complete_nested_command_line (tracker
, text
);
3071 /* Completer for the "frame apply" commands. */
3074 frame_apply_level_cmd_completer (struct cmd_list_element
*ignore
,
3075 completion_tracker
&tracker
,
3076 const char *text
, const char */
*word*/
)
3078 /* Do this explicitly because there's an early return below. */
3079 tracker
.set_use_custom_word_point (true);
3081 number_or_range_parser
levels (text
);
3083 /* Skip the LEVEL list to find the options and command args. */
3086 while (!levels
.finished ())
3088 /* Call for effect. */
3089 levels
.get_number ();
3091 if (levels
.in_range ())
3092 levels
.skip_range ();
3095 catch (const gdb_exception_error
&ex
)
3097 /* get_number throws if it parses a negative number, for
3098 example. But a seemingly negative number may be the start of
3099 an option instead. */
3102 const char *cmd
= levels
.cur_tok ();
3106 /* No level list yet. */
3110 /* Check if we're past a valid LEVEL already. */
3111 if (levels
.finished ()
3112 && cmd
> text
&& !isspace (cmd
[-1]))
3115 /* We're past LEVELs, advance word point. */
3116 tracker
.advance_custom_word_point_by (cmd
- text
);
3119 frame_apply_completer (tracker
, text
);
3122 /* Completer for the "frame apply all" command. */
3125 frame_apply_all_cmd_completer (struct cmd_list_element
*ignore
,
3126 completion_tracker
&tracker
,
3127 const char *text
, const char */
*word*/
)
3129 frame_apply_completer (tracker
, text
);
3132 /* Completer for the "frame apply COUNT" command. */
3135 frame_apply_cmd_completer (struct cmd_list_element
*ignore
,
3136 completion_tracker
&tracker
,
3137 const char *text
, const char */
*word*/
)
3139 const char *cmd
= text
;
3141 int count
= get_number_trailer (&cmd
, 0);
3145 /* Check if we're past a valid COUNT already. */
3146 if (cmd
> text
&& !isspace (cmd
[-1]))
3149 /* We're past COUNT, advance word point. */
3150 tracker
.advance_custom_word_point_by (cmd
- text
);
3153 frame_apply_completer (tracker
, text
);
3156 /* Implementation of the "frame apply level" command. */
3159 frame_apply_level_command (const char *cmd
, int from_tty
)
3161 if (!target_has_stack ())
3162 error (_("No stack."));
3164 bool level_found
= false;
3165 const char *levels_str
= cmd
;
3166 number_or_range_parser
levels (levels_str
);
3168 /* Skip the LEVEL list to find the flags and command args. */
3169 while (!levels
.finished ())
3171 /* Call for effect. */
3172 levels
.get_number ();
3175 if (levels
.in_range ())
3176 levels
.skip_range ();
3180 error (_("Missing or invalid LEVEL... argument"));
3182 cmd
= levels
.cur_tok ();
3184 /* Redo the LEVELS parsing, but applying COMMAND. */
3185 levels
.init (levels_str
);
3186 while (!levels
.finished ())
3188 const int level_beg
= levels
.get_number ();
3191 if (levels
.in_range ())
3193 n_frames
= levels
.end_value () - level_beg
+ 1;
3194 levels
.skip_range ();
3199 frame_apply_command_count ("frame apply level", cmd
, from_tty
,
3200 leading_innermost_frame (level_beg
), n_frames
);
3204 /* Implementation of the "frame apply all" command. */
3207 frame_apply_all_command (const char *cmd
, int from_tty
)
3209 if (!target_has_stack ())
3210 error (_("No stack."));
3212 frame_apply_command_count ("frame apply all", cmd
, from_tty
,
3213 get_current_frame (), INT_MAX
);
3216 /* Implementation of the "frame apply" command. */
3219 frame_apply_command (const char* cmd
, int from_tty
)
3222 struct frame_info
*trailing
;
3224 if (!target_has_stack ())
3225 error (_("No stack."));
3228 error (_("Missing COUNT argument."));
3229 count
= get_number_trailer (&cmd
, 0);
3231 error (_("Invalid COUNT argument."));
3235 trailing
= trailing_outermost_frame (-count
);
3239 trailing
= get_current_frame ();
3241 frame_apply_command_count ("frame apply", cmd
, from_tty
,
3245 /* Implementation of the "faas" command. */
3248 faas_command (const char *cmd
, int from_tty
)
3250 if (cmd
== NULL
|| *cmd
== '\0')
3251 error (_("Please specify a command to apply on all frames"));
3252 std::string expanded
= std::string ("frame apply all -s ") + cmd
;
3253 execute_command (expanded
.c_str (), from_tty
);
3257 /* Find inner-mode frame with frame address ADDRESS. Return NULL if no
3258 matching frame can be found. */
3260 static struct frame_info
*
3261 find_frame_for_address (CORE_ADDR address
)
3264 struct frame_info
*fid
;
3266 id
= frame_id_build_wild (address
);
3268 /* If (s)he specifies the frame with an address, he deserves
3269 what (s)he gets. Still, give the highest one that matches.
3270 (NOTE: cagney/2004-10-29: Why highest, or outer-most, I don't
3272 for (fid
= get_current_frame ();
3274 fid
= get_prev_frame (fid
))
3276 if (frame_id_eq (id
, get_frame_id (fid
)))
3278 struct frame_info
*prev_frame
;
3282 prev_frame
= get_prev_frame (fid
);
3284 || !frame_id_eq (id
, get_frame_id (prev_frame
)))
3296 /* Commands with a prefix of `frame apply'. */
3297 static struct cmd_list_element
*frame_apply_cmd_list
= NULL
;
3299 /* Commands with a prefix of `frame'. */
3300 static struct cmd_list_element
*frame_cmd_list
= NULL
;
3302 /* Commands with a prefix of `select frame'. */
3303 static struct cmd_list_element
*select_frame_cmd_list
= NULL
;
3305 /* Commands with a prefix of `info frame'. */
3306 static struct cmd_list_element
*info_frame_cmd_list
= NULL
;
3308 void _initialize_stack ();
3310 _initialize_stack ()
3312 struct cmd_list_element
*cmd
;
3314 add_com ("return", class_stack
, return_command
, _("\
3315 Make selected stack frame return to its caller.\n\
3316 Control remains in the debugger, but when you continue\n\
3317 execution will resume in the frame above the one now selected.\n\
3318 If an argument is given, it is an expression for the value to return."));
3320 add_com ("up", class_stack
, up_command
, _("\
3321 Select and print stack frame that called this one.\n\
3322 An argument says how many frames up to go."));
3323 add_com ("up-silently", class_support
, up_silently_command
, _("\
3324 Same as the `up' command, but does not print anything.\n\
3325 This is useful in command scripts."));
3327 cmd_list_element
*down_cmd
3328 = add_com ("down", class_stack
, down_command
, _("\
3329 Select and print stack frame called by this one.\n\
3330 An argument says how many frames down to go."));
3331 add_com_alias ("do", down_cmd
, class_stack
, 1);
3332 add_com_alias ("dow", down_cmd
, class_stack
, 1);
3333 add_com ("down-silently", class_support
, down_silently_command
, _("\
3334 Same as the `down' command, but does not print anything.\n\
3335 This is useful in command scripts."));
3337 cmd_list_element
*frame_cmd_el
3338 = add_prefix_cmd ("frame", class_stack
,
3339 &frame_cmd
.base_command
, _("\
3340 Select and print a stack frame.\n\
3341 With no argument, print the selected stack frame. (See also \"info frame\").\n\
3342 A single numerical argument specifies the frame to select."),
3343 &frame_cmd_list
, 1, &cmdlist
);
3344 add_com_alias ("f", frame_cmd_el
, class_stack
, 1);
3346 #define FRAME_APPLY_OPTION_HELP "\
3347 Prints the frame location information followed by COMMAND output.\n\
3349 By default, an error raised during the execution of COMMAND\n\
3350 aborts \"frame apply\".\n\
3355 const auto frame_apply_opts
3356 = make_frame_apply_options_def_group (nullptr, nullptr);
3358 static std::string frame_apply_cmd_help
= gdb::option::build_help (_("\
3359 Apply a command to a number of frames.\n\
3360 Usage: frame apply COUNT [OPTION]... COMMAND\n\
3361 With a negative COUNT argument, applies the command on outermost -COUNT frames.\n"
3362 FRAME_APPLY_OPTION_HELP
),
3365 cmd
= add_prefix_cmd ("apply", class_stack
, frame_apply_command
,
3366 frame_apply_cmd_help
.c_str (),
3367 &frame_apply_cmd_list
, 1,
3369 set_cmd_completer_handle_brkchars (cmd
, frame_apply_cmd_completer
);
3371 static std::string frame_apply_all_cmd_help
= gdb::option::build_help (_("\
3372 Apply a command to all frames.\n\
3374 Usage: frame apply all [OPTION]... COMMAND\n"
3375 FRAME_APPLY_OPTION_HELP
),
3378 cmd
= add_cmd ("all", class_stack
, frame_apply_all_command
,
3379 frame_apply_all_cmd_help
.c_str (),
3380 &frame_apply_cmd_list
);
3381 set_cmd_completer_handle_brkchars (cmd
, frame_apply_all_cmd_completer
);
3383 static std::string frame_apply_level_cmd_help
= gdb::option::build_help (_("\
3384 Apply a command to a list of frames.\n\
3386 Usage: frame apply level LEVEL... [OPTION]... COMMAND\n\
3387 LEVEL is a space-separated list of levels of frames to apply COMMAND on.\n"
3388 FRAME_APPLY_OPTION_HELP
),
3391 cmd
= add_cmd ("level", class_stack
, frame_apply_level_command
,
3392 frame_apply_level_cmd_help
.c_str (),
3393 &frame_apply_cmd_list
);
3394 set_cmd_completer_handle_brkchars (cmd
, frame_apply_level_cmd_completer
);
3396 cmd
= add_com ("faas", class_stack
, faas_command
, _("\
3397 Apply a command to all frames (ignoring errors and empty output).\n\
3398 Usage: faas [OPTION]... COMMAND\n\
3399 shortcut for 'frame apply all -s [OPTION]... COMMAND'\n\
3400 See \"help frame apply all\" for available options."));
3401 set_cmd_completer_handle_brkchars (cmd
, frame_apply_all_cmd_completer
);
3403 add_cmd ("address", class_stack
, &frame_cmd
.address
,
3405 Select and print a stack frame by stack address.\n\
3407 Usage: frame address STACK-ADDRESS"),
3410 add_cmd ("view", class_stack
, &frame_cmd
.view
,
3412 View a stack frame that might be outside the current backtrace.\n\
3414 Usage: frame view STACK-ADDRESS\n\
3415 frame view STACK-ADDRESS PC-ADDRESS"),
3418 cmd
= add_cmd ("function", class_stack
, &frame_cmd
.function
,
3420 Select and print a stack frame by function name.\n\
3422 Usage: frame function NAME\n\
3424 The innermost frame that visited function NAME is selected."),
3426 set_cmd_completer (cmd
, frame_selection_by_function_completer
);
3429 add_cmd ("level", class_stack
, &frame_cmd
.level
,
3431 Select and print a stack frame by level.\n\
3433 Usage: frame level LEVEL"),
3436 cmd
= add_prefix_cmd_suppress_notification ("select-frame", class_stack
,
3437 &select_frame_cmd
.base_command
, _("\
3438 Select a stack frame without printing anything.\n\
3439 A single numerical argument specifies the frame to select."),
3440 &select_frame_cmd_list
, 1, &cmdlist
,
3441 &cli_suppress_notification
.user_selected_context
);
3443 add_cmd_suppress_notification ("address", class_stack
,
3444 &select_frame_cmd
.address
, _("\
3445 Select a stack frame by stack address.\n\
3447 Usage: select-frame address STACK-ADDRESS"),
3448 &select_frame_cmd_list
,
3449 &cli_suppress_notification
.user_selected_context
);
3452 add_cmd_suppress_notification ("view", class_stack
,
3453 &select_frame_cmd
.view
, _("\
3454 Select a stack frame that might be outside the current backtrace.\n\
3456 Usage: select-frame view STACK-ADDRESS\n\
3457 select-frame view STACK-ADDRESS PC-ADDRESS"),
3458 &select_frame_cmd_list
,
3459 &cli_suppress_notification
.user_selected_context
);
3461 cmd
= add_cmd_suppress_notification ("function", class_stack
,
3462 &select_frame_cmd
.function
, _("\
3463 Select a stack frame by function name.\n\
3465 Usage: select-frame function NAME"),
3466 &select_frame_cmd_list
,
3467 &cli_suppress_notification
.user_selected_context
);
3468 set_cmd_completer (cmd
, frame_selection_by_function_completer
);
3470 add_cmd_suppress_notification ("level", class_stack
,
3471 &select_frame_cmd
.level
, _("\
3472 Select a stack frame by level.\n\
3474 Usage: select-frame level LEVEL"),
3475 &select_frame_cmd_list
,
3476 &cli_suppress_notification
.user_selected_context
);
3478 const auto backtrace_opts
3479 = make_backtrace_options_def_group (nullptr, nullptr, nullptr);
3481 static std::string backtrace_help
3482 = gdb::option::build_help (_("\
3483 Print backtrace of all stack frames, or innermost COUNT frames.\n\
3484 Usage: backtrace [OPTION]... [QUALIFIER]... [COUNT | -COUNT]\n\
3489 For backward compatibility, the following qualifiers are supported:\n\
3491 full - same as -full option.\n\
3492 no-filters - same as -no-filters option.\n\
3493 hide - same as -hide.\n\
3495 With a negative COUNT, print outermost -COUNT frames."),
3498 cmd_list_element
*backtrace_cmd
3499 = add_com ("backtrace", class_stack
, backtrace_command
,
3500 backtrace_help
.c_str ());
3501 set_cmd_completer_handle_brkchars (backtrace_cmd
, backtrace_command_completer
);
3503 add_com_alias ("bt", backtrace_cmd
, class_stack
, 0);
3505 add_com_alias ("where", backtrace_cmd
, class_stack
, 0);
3506 cmd_list_element
*info_stack_cmd
3507 = add_info ("stack", backtrace_command
,
3508 _("Backtrace of the stack, or innermost COUNT frames."));
3509 add_info_alias ("s", info_stack_cmd
, 1);
3511 cmd_list_element
*info_frame_cmd_el
3512 = add_prefix_cmd ("frame", class_info
, &info_frame_cmd
.base_command
,
3513 _("All about the selected stack frame.\n\
3514 With no arguments, displays information about the currently selected stack\n\
3515 frame. Alternatively a frame specification may be provided (See \"frame\")\n\
3516 the information is then printed about the specified frame."),
3517 &info_frame_cmd_list
, 1, &infolist
);
3518 add_info_alias ("f", info_frame_cmd_el
, 1);
3520 add_cmd ("address", class_stack
, &info_frame_cmd
.address
,
3522 Print information about a stack frame selected by stack address.\n\
3524 Usage: info frame address STACK-ADDRESS"),
3525 &info_frame_cmd_list
);
3527 add_cmd ("view", class_stack
, &info_frame_cmd
.view
,
3529 Print information about a stack frame outside the current backtrace.\n\
3531 Usage: info frame view STACK-ADDRESS\n\
3532 info frame view STACK-ADDRESS PC-ADDRESS"),
3533 &info_frame_cmd_list
);
3535 cmd
= add_cmd ("function", class_stack
, &info_frame_cmd
.function
,
3537 Print information about a stack frame selected by function name.\n\
3539 Usage: info frame function NAME"),
3540 &info_frame_cmd_list
);
3541 set_cmd_completer (cmd
, frame_selection_by_function_completer
);
3543 add_cmd ("level", class_stack
, &info_frame_cmd
.level
,
3545 Print information about a stack frame selected by level.\n\
3547 Usage: info frame level LEVEL"),
3548 &info_frame_cmd_list
);
3550 cmd
= add_info ("locals", info_locals_command
,
3551 info_print_args_help (_("\
3552 All local variables of current stack frame or those matching REGEXPs.\n\
3553 Usage: info locals [-q] [-t TYPEREGEXP] [NAMEREGEXP]\n\
3554 Prints the local variables of the current stack frame.\n"),
3555 _("local variables"),
3557 set_cmd_completer_handle_brkchars (cmd
, info_print_command_completer
);
3558 cmd
= add_info ("args", info_args_command
,
3559 info_print_args_help (_("\
3560 All argument variables of current stack frame or those matching REGEXPs.\n\
3561 Usage: info args [-q] [-t TYPEREGEXP] [NAMEREGEXP]\n\
3562 Prints the argument variables of the current stack frame.\n"),
3563 _("argument variables"),
3565 set_cmd_completer_handle_brkchars (cmd
, info_print_command_completer
);
3568 add_com ("func", class_stack
, func_command
, _("\
3569 Select the stack frame that contains NAME.\n\
3570 Usage: func NAME"));
3572 /* Install "set print raw frame-arguments", a deprecated spelling of
3573 "set print raw-frame-arguments". */
3574 set_show_commands set_show_frame_args
3575 = add_setshow_boolean_cmd
3576 ("frame-arguments", no_class
,
3577 &user_frame_print_options
.print_raw_frame_arguments
,
3579 Set whether to print frame arguments in raw form."), _("\
3580 Show whether to print frame arguments in raw form."), _("\
3581 If set, frame arguments are printed in raw form, bypassing any\n\
3582 pretty-printers for that value."),
3584 &setprintrawlist
, &showprintrawlist
);
3585 deprecate_cmd (set_show_frame_args
.set
, "set print raw-frame-arguments");
3587 add_setshow_auto_boolean_cmd ("disassemble-next-line", class_stack
,
3588 &disassemble_next_line
, _("\
3589 Set whether to disassemble next source line or insn when execution stops."),
3591 Show whether to disassemble next source line or insn when execution stops."),
3593 If ON, GDB will display disassembly of the next source line, in addition\n\
3594 to displaying the source line itself. If the next source line cannot\n\
3595 be displayed (e.g., source is unavailable or there's no line info), GDB\n\
3596 will display disassembly of next instruction instead of showing the\n\
3598 If AUTO, display disassembly of next instruction only if the source line\n\
3599 cannot be displayed.\n\
3600 If OFF (which is the default), never display the disassembly of the next\n\
3603 show_disassemble_next_line
,
3604 &setlist
, &showlist
);
3605 disassemble_next_line
= AUTO_BOOLEAN_FALSE
;
3607 gdb::option::add_setshow_cmds_for_options
3608 (class_stack
, &user_frame_print_options
,
3609 frame_print_option_defs
, &setprintlist
, &showprintlist
);