1 /* Print and select stack frames for GDB, the GNU debugger.
3 Copyright (C) 1986-2023 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 (frame_info_ptr 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_ptr frame
, int print_level
,
225 enum print_what print_what
, int print_args
,
226 struct symtab_and_line sal
);
228 static frame_info_ptr
find_frame_for_function (const char *);
229 static frame_info_ptr
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 (frame_info_ptr 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
, frame_info_ptr 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 (frame_info_ptr 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 (frame_info_ptr 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 gdb_printf (stream
, ", ");
403 gdb_printf (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 gdb_puts (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 gdb_puts (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
= true;
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
, frame_info_ptr 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_ptr 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 ()))
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_deref
->length ()))
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 (sym
->type ());
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
, frame_info_ptr 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
= func
->value_block ();
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 (!sym
->is_argument ())
776 switch (sym
->aclass ())
781 long current_offset
= sym
->value_longest ();
782 int arg_size
= sym
->type ()->length ();
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 (nsym
->aclass () == LOC_REGISTER
832 && !nsym
->is_argument ())
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 (frame_info_ptr 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
,
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 ("Unexpected print frame-info value `%s'.",
995 /* Print the PC from FRAME, plus any flags, to UIOUT. */
998 print_pc (struct ui_out
*uiout
, struct gdbarch
*gdbarch
, frame_info_ptr frame
,
1001 uiout
->field_core_addr ("addr", gdbarch
, pc
);
1003 std::string flags
= gdbarch_get_pc_address_flags (gdbarch
, frame
, pc
);
1004 if (!flags
.empty ())
1007 uiout
->field_string ("addr_flags", flags
);
1015 get_user_print_what_frame_info (gdb::optional
<enum print_what
> *what
)
1018 = print_frame_info_to_print_what
1019 (user_frame_print_options
.print_frame_info
);
1022 /* Print information about frame FRAME. The output is format according
1023 to PRINT_LEVEL and PRINT_WHAT and PRINT_ARGS. For the meaning of
1024 PRINT_WHAT, see enum print_what comments in frame.h.
1025 Note that PRINT_WHAT is overridden if FP_OPTS.print_frame_info
1026 != print_frame_info_auto.
1028 Used in "where" output, and to emit breakpoint or step
1032 print_frame_info (const frame_print_options
&fp_opts
,
1033 frame_info_ptr frame
, int print_level
,
1034 enum print_what print_what
, int print_args
,
1035 int set_current_sal
)
1037 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1040 struct ui_out
*uiout
= current_uiout
;
1042 if (!current_uiout
->is_mi_like_p ()
1043 && fp_opts
.print_frame_info
!= print_frame_info_auto
)
1045 /* Use the specific frame information desired by the user. */
1046 print_what
= *print_frame_info_to_print_what (fp_opts
.print_frame_info
);
1049 if (get_frame_type (frame
) == DUMMY_FRAME
1050 || get_frame_type (frame
) == SIGTRAMP_FRAME
1051 || get_frame_type (frame
) == ARCH_FRAME
)
1053 ui_out_emit_tuple
tuple_emitter (uiout
, "frame");
1055 annotate_frame_begin (print_level
? frame_relative_level (frame
) : 0,
1056 gdbarch
, get_frame_pc (frame
));
1058 /* Do this regardless of SOURCE because we don't have any source
1059 to list for this frame. */
1063 uiout
->field_fmt_signed (2, ui_left
, "level",
1064 frame_relative_level (frame
));
1066 if (uiout
->is_mi_like_p ())
1068 annotate_frame_address ();
1069 print_pc (uiout
, gdbarch
, frame
, get_frame_pc (frame
));
1070 annotate_frame_address_end ();
1073 if (get_frame_type (frame
) == DUMMY_FRAME
)
1075 annotate_function_call ();
1076 uiout
->field_string ("func", "<function called from gdb>",
1077 metadata_style
.style ());
1079 else if (get_frame_type (frame
) == SIGTRAMP_FRAME
)
1081 annotate_signal_handler_caller ();
1082 uiout
->field_string ("func", "<signal handler called>",
1083 metadata_style
.style ());
1085 else if (get_frame_type (frame
) == ARCH_FRAME
)
1087 uiout
->field_string ("func", "<cross-architecture call>",
1088 metadata_style
.style ());
1091 annotate_frame_end ();
1093 /* If disassemble-next-line is set to auto or on output the next
1095 if (disassemble_next_line
== AUTO_BOOLEAN_AUTO
1096 || disassemble_next_line
== AUTO_BOOLEAN_TRUE
)
1097 do_gdb_disassembly (get_frame_arch (frame
), 1,
1098 get_frame_pc (frame
), get_frame_pc (frame
) + 1);
1103 /* If FRAME is not the innermost frame, that normally means that
1104 FRAME->pc points to *after* the call instruction, and we want to
1105 get the line containing the call, never the next line. But if
1106 the next frame is a SIGTRAMP_FRAME or a DUMMY_FRAME, then the
1107 next frame was not entered as the result of a call, and we want
1108 to get the line containing FRAME->pc. */
1109 symtab_and_line sal
= find_frame_sal (frame
);
1111 location_print
= (print_what
== LOCATION
1112 || print_what
== SRC_AND_LOC
1113 || print_what
== LOC_AND_ADDRESS
1114 || print_what
== SHORT_LOCATION
);
1115 if (location_print
|| !sal
.symtab
)
1116 print_frame (fp_opts
, frame
, print_level
, print_what
, print_args
, sal
);
1118 source_print
= (print_what
== SRC_LINE
|| print_what
== SRC_AND_LOC
);
1120 /* If disassemble-next-line is set to auto or on and doesn't have
1121 the line debug messages for $pc, output the next instruction. */
1122 if ((disassemble_next_line
== AUTO_BOOLEAN_AUTO
1123 || disassemble_next_line
== AUTO_BOOLEAN_TRUE
)
1124 && source_print
&& !sal
.symtab
)
1125 do_gdb_disassembly (get_frame_arch (frame
), 1,
1126 get_frame_pc (frame
), get_frame_pc (frame
) + 1);
1128 if (source_print
&& sal
.symtab
)
1130 int mid_statement
= ((print_what
== SRC_LINE
)
1131 && frame_show_address (frame
, sal
));
1132 if (annotation_level
> 0
1133 && annotate_source_line (sal
.symtab
, sal
.line
, mid_statement
,
1134 get_frame_pc (frame
)))
1136 /* The call to ANNOTATE_SOURCE_LINE already printed the
1137 annotation for this source line, so we avoid the two cases
1138 below and do not print the actual source line. The
1139 documentation for annotations makes it clear that the source
1140 line annotation is printed __instead__ of printing the source
1141 line, not as well as.
1143 However, if we fail to print the source line, which usually
1144 means either the source file is missing, or the requested
1145 line is out of range of the file, then we don't print the
1146 source annotation, and will pass through the "normal" print
1147 source line code below, the expectation is that this code
1148 will print an appropriate error. */
1150 else if (deprecated_print_frame_info_listing_hook
)
1151 deprecated_print_frame_info_listing_hook (sal
.symtab
, sal
.line
,
1155 struct value_print_options opts
;
1157 get_user_print_options (&opts
);
1158 /* We used to do this earlier, but that is clearly
1159 wrong. This function is used by many different
1160 parts of gdb, including normal_stop in infrun.c,
1161 which uses this to print out the current PC
1162 when we stepi/nexti into the middle of a source
1163 line. Only the command line really wants this
1164 behavior. Other UIs probably would like the
1165 ability to decide for themselves if it is desired. */
1166 if (opts
.addressprint
&& mid_statement
)
1168 print_pc (uiout
, gdbarch
, frame
, get_frame_pc (frame
));
1172 print_source_lines (sal
.symtab
, sal
.line
, sal
.line
+ 1, 0);
1175 /* If disassemble-next-line is set to on and there is line debug
1176 messages, output assembly codes for next line. */
1177 if (disassemble_next_line
== AUTO_BOOLEAN_TRUE
)
1178 do_gdb_disassembly (get_frame_arch (frame
), -1, sal
.pc
, sal
.end
);
1181 if (set_current_sal
)
1185 if (get_frame_pc_if_available (frame
, &pc
))
1186 last_displayed_symtab_info
.set (sal
.pspace
, pc
, sal
.symtab
, sal
.line
);
1188 last_displayed_symtab_info
.invalidate ();
1191 annotate_frame_end ();
1193 gdb_flush (gdb_stdout
);
1199 clear_last_displayed_sal (void)
1201 last_displayed_symtab_info
.invalidate ();
1207 last_displayed_sal_is_valid (void)
1209 return last_displayed_symtab_info
.is_valid ();
1214 struct program_space
*
1215 get_last_displayed_pspace (void)
1217 return last_displayed_symtab_info
.pspace ();
1223 get_last_displayed_addr (void)
1225 return last_displayed_symtab_info
.address ();
1231 get_last_displayed_symtab (void)
1233 return last_displayed_symtab_info
.symtab ();
1239 get_last_displayed_line (void)
1241 return last_displayed_symtab_info
.line ();
1247 get_last_displayed_sal ()
1249 symtab_and_line sal
;
1251 if (last_displayed_symtab_info
.is_valid ())
1253 sal
.pspace
= last_displayed_symtab_info
.pspace ();
1254 sal
.pc
= last_displayed_symtab_info
.address ();
1255 sal
.symtab
= last_displayed_symtab_info
.symtab ();
1256 sal
.line
= last_displayed_symtab_info
.line ();
1263 /* Attempt to obtain the name, FUNLANG and optionally FUNCP of the function
1264 corresponding to FRAME. */
1266 gdb::unique_xmalloc_ptr
<char>
1267 find_frame_funname (frame_info_ptr frame
, enum language
*funlang
,
1268 struct symbol
**funcp
)
1270 struct symbol
*func
;
1271 gdb::unique_xmalloc_ptr
<char> funname
;
1273 *funlang
= language_unknown
;
1277 func
= get_frame_function (frame
);
1280 const char *print_name
= func
->print_name ();
1282 *funlang
= func
->language ();
1285 if (*funlang
== language_cplus
)
1287 /* It seems appropriate to use print_name() here,
1288 to display the demangled name that we already have
1289 stored in the symbol table, but we stored a version
1290 with DMGL_PARAMS turned on, and here we don't want to
1291 display parameters. So remove the parameters. */
1292 funname
= cp_remove_params (print_name
);
1295 /* If we didn't hit the C++ case above, set *funname
1297 if (funname
== NULL
)
1298 funname
.reset (xstrdup (print_name
));
1302 struct bound_minimal_symbol msymbol
;
1305 if (!get_frame_address_in_block_if_available (frame
, &pc
))
1308 msymbol
= lookup_minimal_symbol_by_pc (pc
);
1309 if (msymbol
.minsym
!= NULL
)
1311 funname
.reset (xstrdup (msymbol
.minsym
->print_name ()));
1312 *funlang
= msymbol
.minsym
->language ();
1320 print_frame (const frame_print_options
&fp_opts
,
1321 frame_info_ptr frame
, int print_level
,
1322 enum print_what print_what
, int print_args
,
1323 struct symtab_and_line sal
)
1325 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1326 struct ui_out
*uiout
= current_uiout
;
1327 enum language funlang
= language_unknown
;
1328 struct value_print_options opts
;
1329 struct symbol
*func
;
1333 pc_p
= get_frame_pc_if_available (frame
, &pc
);
1335 gdb::unique_xmalloc_ptr
<char> funname
1336 = find_frame_funname (frame
, &funlang
, &func
);
1338 annotate_frame_begin (print_level
? frame_relative_level (frame
) : 0,
1342 ui_out_emit_tuple
tuple_emitter (uiout
, "frame");
1347 uiout
->field_fmt_signed (2, ui_left
, "level",
1348 frame_relative_level (frame
));
1350 get_user_print_options (&opts
);
1351 if (opts
.addressprint
)
1353 || frame_show_address (frame
, sal
)
1354 || print_what
== LOC_AND_ADDRESS
)
1356 annotate_frame_address ();
1358 print_pc (uiout
, gdbarch
, frame
, pc
);
1360 uiout
->field_string ("addr", "<unavailable>",
1361 metadata_style
.style ());
1362 annotate_frame_address_end ();
1363 uiout
->text (" in ");
1365 annotate_frame_function_name ();
1368 gdb_puts (funname
? funname
.get () : "??", &stb
);
1369 uiout
->field_stream ("func", stb
, function_name_style
.style ());
1370 uiout
->wrap_hint (3);
1371 annotate_frame_args ();
1378 if (gdbarch_frame_num_args_p (gdbarch
))
1380 numargs
= gdbarch_frame_num_args (gdbarch
, frame
);
1381 gdb_assert (numargs
>= 0);
1387 ui_out_emit_list
list_emitter (uiout
, "args");
1390 print_frame_args (fp_opts
, func
, frame
, numargs
, gdb_stdout
);
1392 catch (const gdb_exception_error
&e
)
1396 /* FIXME: ARGS must be a list. If one argument is a string it
1397 will have " that will not be properly escaped. */
1402 if (print_what
!= SHORT_LOCATION
&& sal
.symtab
)
1404 const char *filename_display
;
1406 filename_display
= symtab_to_filename_for_display (sal
.symtab
);
1407 annotate_frame_source_begin ();
1408 uiout
->wrap_hint (3);
1409 uiout
->text (" at ");
1410 annotate_frame_source_file ();
1411 uiout
->field_string ("file", filename_display
,
1412 file_name_style
.style ());
1413 if (uiout
->is_mi_like_p ())
1415 const char *fullname
= symtab_to_fullname (sal
.symtab
);
1417 uiout
->field_string ("fullname", fullname
);
1419 annotate_frame_source_file_end ();
1421 annotate_frame_source_line ();
1422 uiout
->field_signed ("line", sal
.line
);
1423 annotate_frame_source_end ();
1426 if (print_what
!= SHORT_LOCATION
1427 && pc_p
&& (funname
== NULL
|| sal
.symtab
== NULL
))
1430 = 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 (frame_info_ptr fi
, bool selected_frame_p
)
1478 struct symbol
*func
;
1480 frame_info_ptr 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 gdb_printf (_("Stack level %d, frame at "),
1546 frame_relative_level (fi
));
1550 gdb_printf (_("Stack frame at "));
1552 gdb_puts (paddress (gdbarch
, get_frame_base (fi
)));
1554 gdb_printf (" %s = ", pc_regname
);
1556 gdb_puts (paddress (gdbarch
, get_frame_pc (fi
)));
1558 fputs_styled ("<unavailable>", metadata_style
.style (), gdb_stdout
);
1560 gdb_stdout
->wrap_here (3);
1563 gdb_printf (" in ");
1566 gdb_stdout
->wrap_here (3);
1570 styled_string (file_name_style
.style (),
1571 symtab_to_filename_for_display (sal
.symtab
)),
1574 gdb_stdout
->wrap_here (4);
1575 gdb_printf ("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 gdb_puts (paddress (gdbarch
, caller_pc
));
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 gdb_printf (_(" Outermost frame: %s\n"),
1616 frame_stop_reason_string (fi
));
1618 else if (get_frame_type (fi
) == TAILCALL_FRAME
)
1619 gdb_puts (" tail call frame");
1620 else if (get_frame_type (fi
) == INLINE_FRAME
)
1621 gdb_printf (" inlined into frame %d",
1622 frame_relative_level (get_prev_frame (fi
)));
1625 gdb_printf (" called by frame at ");
1626 gdb_puts (paddress (gdbarch
, get_frame_base (calling_frame_info
)));
1628 if (get_next_frame (fi
) && calling_frame_info
)
1630 gdb_stdout
->wrap_here (3);
1631 if (get_next_frame (fi
))
1633 gdb_printf (" caller of frame at ");
1634 gdb_puts (paddress (gdbarch
, get_frame_base (get_next_frame (fi
))));
1636 if (get_next_frame (fi
) || calling_frame_info
)
1640 gdb_printf (" 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 gdb_printf (" Arglist at unknown address.\n");
1653 gdb_printf (" Arglist at ");
1654 gdb_puts (paddress (gdbarch
, arg_list
));
1657 if (!gdbarch_frame_num_args_p (gdbarch
))
1660 gdb_puts (" args: ");
1664 numargs
= gdbarch_frame_num_args (gdbarch
, fi
);
1665 gdb_assert (numargs
>= 0);
1667 gdb_puts (" no args.");
1668 else if (numargs
== 1)
1669 gdb_puts (" 1 arg: ");
1671 gdb_printf (" %d args: ", numargs
);
1674 print_frame_args (user_frame_print_options
,
1675 func
, fi
, numargs
, gdb_stdout
);
1680 /* Address of the local variables for this frame, or 0. */
1681 CORE_ADDR arg_list
= get_frame_locals_address (fi
);
1684 gdb_printf (" Locals at unknown address,");
1687 gdb_printf (" Locals at ");
1688 gdb_puts (paddress (gdbarch
, arg_list
));
1693 /* Print as much information as possible on the location of all the
1699 int sp_regnum
= gdbarch_sp_regnum (gdbarch
);
1701 /* The sp is special; what's displayed isn't the save address, but
1702 the value of the previous frame's sp. This is a legacy thing,
1703 at one stage the frame cached the previous frame's SP instead
1704 of its address, hence it was easiest to just display the cached
1708 struct value
*value
= frame_unwind_register_value (fi
, sp_regnum
);
1709 gdb_assert (value
!= NULL
);
1711 if (!value_optimized_out (value
) && value_entirely_available (value
))
1713 if (VALUE_LVAL (value
) == not_lval
)
1716 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1717 int sp_size
= register_size (gdbarch
, sp_regnum
);
1719 sp
= extract_unsigned_integer
1720 (value_contents_all (value
).data (), sp_size
, byte_order
);
1722 gdb_printf (" Previous frame's sp is ");
1723 gdb_puts (paddress (gdbarch
, sp
));
1726 else if (VALUE_LVAL (value
) == lval_memory
)
1728 gdb_printf (" Previous frame's sp at ");
1729 gdb_puts (paddress (gdbarch
, value_address (value
)));
1732 else if (VALUE_LVAL (value
) == lval_register
)
1734 gdb_printf (" Previous frame's sp in %s\n",
1735 gdbarch_register_name (gdbarch
,
1736 VALUE_REGNUM (value
)));
1739 release_value (value
);
1742 /* else keep quiet. */
1746 numregs
= gdbarch_num_cooked_regs (gdbarch
);
1747 for (i
= 0; i
< numregs
; i
++)
1749 && gdbarch_register_reggroup_p (gdbarch
, i
, all_reggroup
))
1751 enum lval_type lval
;
1757 /* Find out the location of the saved register without
1758 fetching the corresponding value. */
1759 frame_register_unwind (fi
, i
, &optimized
, &unavailable
,
1760 &lval
, &addr
, &realnum
, NULL
);
1761 /* For moment, only display registers that were saved on the
1763 if (!optimized
&& !unavailable
&& lval
== lval_memory
)
1766 gdb_puts (" Saved registers:\n ");
1769 gdb_stdout
->wrap_here (1);
1770 gdb_printf (" %s at ",
1771 gdbarch_register_name (gdbarch
, i
));
1772 gdb_puts (paddress (gdbarch
, addr
));
1776 if (count
|| need_nl
)
1781 /* Return the innermost frame at level LEVEL. */
1783 static frame_info_ptr
1784 leading_innermost_frame (int level
)
1786 frame_info_ptr leading
;
1788 leading
= get_current_frame ();
1790 gdb_assert (level
>= 0);
1792 while (leading
!= nullptr && level
)
1795 leading
= get_prev_frame (leading
);
1802 /* Return the starting frame needed to handle COUNT outermost frames. */
1804 static frame_info_ptr
1805 trailing_outermost_frame (int count
)
1807 frame_info_ptr current
;
1808 frame_info_ptr trailing
;
1810 trailing
= get_current_frame ();
1812 gdb_assert (count
> 0);
1815 while (current
!= nullptr && count
--)
1818 current
= get_prev_frame (current
);
1821 /* Will stop when CURRENT reaches the top of the stack.
1822 TRAILING will be COUNT below it. */
1823 while (current
!= nullptr)
1826 trailing
= get_prev_frame (trailing
);
1827 current
= get_prev_frame (current
);
1833 /* The core of all the "select-frame" sub-commands. Just wraps a call to
1837 select_frame_command_core (frame_info_ptr fi
, bool ignored
)
1839 frame_info_ptr prev_frame
= get_selected_frame ();
1841 if (get_selected_frame () != prev_frame
)
1842 gdb::observers::user_selected_context_changed
.notify (USER_SELECTED_FRAME
);
1845 /* The core of all the "frame" sub-commands. Select frame FI, and if this
1846 means we change frame send out a change notification (otherwise, just
1847 reprint the current frame summary). */
1850 frame_command_core (frame_info_ptr fi
, bool ignored
)
1852 frame_info_ptr prev_frame
= get_selected_frame ();
1854 if (get_selected_frame () != prev_frame
)
1855 gdb::observers::user_selected_context_changed
.notify (USER_SELECTED_FRAME
);
1857 print_selected_thread_frame (current_uiout
, USER_SELECTED_FRAME
);
1860 /* The three commands 'frame', 'select-frame', and 'info frame' all have a
1861 common set of sub-commands that allow a specific frame to be selected.
1862 All of the sub-command functions are static methods within this class
1863 template which is then instantiated below. The template parameter is a
1864 callback used to implement the functionality of the base command
1865 ('frame', 'select-frame', or 'info frame').
1867 In the template parameter FI is the frame being selected. The
1868 SELECTED_FRAME_P flag is true if the frame being selected was done by
1869 default, which happens when the user uses the base command with no
1870 arguments. For example the commands 'info frame', 'select-frame',
1871 'frame' will all cause SELECTED_FRAME_P to be true. In all other cases
1872 SELECTED_FRAME_P is false. */
1874 template <void (*FPTR
) (frame_info_ptr fi
, bool selected_frame_p
)>
1875 class frame_command_helper
1879 /* The "frame level" family of commands. The ARG is an integer that is
1880 the frame's level in the stack. */
1882 level (const char *arg
, int from_tty
)
1884 int level
= value_as_long (parse_and_eval (arg
));
1886 = find_relative_frame (get_current_frame (), &level
);
1888 error (_("No frame at level %s."), arg
);
1892 /* The "frame address" family of commands. ARG is a stack-pointer
1893 address for an existing frame. This command does not allow new
1894 frames to be created. */
1897 address (const char *arg
, int from_tty
)
1899 CORE_ADDR addr
= value_as_address (parse_and_eval (arg
));
1900 frame_info_ptr fid
= find_frame_for_address (addr
);
1902 error (_("No frame at address %s."), arg
);
1906 /* The "frame view" family of commands. ARG is one or two addresses and
1907 is used to view a frame that might be outside the current backtrace.
1908 The addresses are stack-pointer address, and (optional) pc-address. */
1911 view (const char *args
, int from_tty
)
1916 error (_("Missing address argument to view a frame"));
1918 gdb_argv
argv (args
);
1920 if (argv
.count () == 2)
1924 addr
[0] = value_as_address (parse_and_eval (argv
[0]));
1925 addr
[1] = value_as_address (parse_and_eval (argv
[1]));
1926 fid
= create_new_frame (addr
[0], addr
[1]);
1930 CORE_ADDR addr
= value_as_address (parse_and_eval (argv
[0]));
1931 fid
= create_new_frame (addr
, false);
1936 /* The "frame function" family of commands. ARG is the name of a
1937 function within the stack, the first function (searching from frame
1938 0) with that name will be selected. */
1941 function (const char *arg
, int from_tty
)
1944 error (_("Missing function name argument"));
1945 frame_info_ptr fid
= find_frame_for_function (arg
);
1947 error (_("No frame for function \"%s\"."), arg
);
1951 /* The "frame" base command, that is, when no sub-command is specified.
1952 If one argument is provided then we assume that this is a frame's
1953 level as historically, this was the supported command syntax that was
1956 If no argument is provided, then the current frame is selected. */
1959 base_command (const char *arg
, int from_tty
)
1962 FPTR (get_selected_frame (_("No stack.")), true);
1964 level (arg
, from_tty
);
1968 /* Instantiate three FRAME_COMMAND_HELPER instances to implement the
1969 sub-commands for 'info frame', 'frame', and 'select-frame' commands. */
1971 static frame_command_helper
<info_frame_command_core
> info_frame_cmd
;
1972 static frame_command_helper
<frame_command_core
> frame_cmd
;
1973 static frame_command_helper
<select_frame_command_core
> select_frame_cmd
;
1975 /* Print briefly all stack frames or just the innermost COUNT_EXP
1979 backtrace_command_1 (const frame_print_options
&fp_opts
,
1980 const backtrace_cmd_options
&bt_opts
,
1981 const char *count_exp
, int from_tty
)
1986 int py_start
= 0, py_end
= 0;
1987 enum ext_lang_bt_status result
= EXT_LANG_BT_ERROR
;
1989 if (!target_has_stack ())
1990 error (_("No stack."));
1994 count
= parse_and_eval_long (count_exp
);
2000 /* The argument to apply_ext_lang_frame_filter is the number
2001 of the final frame to print, and frames start at 0. */
2011 frame_filter_flags flags
= 0;
2014 flags
|= PRINT_LOCALS
;
2016 flags
|= PRINT_HIDE
;
2018 if (!bt_opts
.no_filters
)
2020 enum ext_lang_frame_args arg_type
;
2022 flags
|= PRINT_LEVEL
| PRINT_FRAME_INFO
| PRINT_ARGS
;
2024 flags
|= PRINT_MORE_FRAMES
;
2026 if (fp_opts
.print_frame_arguments
== print_frame_arguments_scalars
)
2027 arg_type
= CLI_SCALAR_VALUES
;
2028 else if (fp_opts
.print_frame_arguments
== print_frame_arguments_all
)
2029 arg_type
= CLI_ALL_VALUES
;
2030 else if (fp_opts
.print_frame_arguments
== print_frame_arguments_presence
)
2031 arg_type
= CLI_PRESENCE
;
2032 else if (fp_opts
.print_frame_arguments
== print_frame_arguments_none
)
2033 arg_type
= NO_VALUES
;
2037 result
= apply_ext_lang_frame_filter (get_current_frame (), flags
,
2038 arg_type
, current_uiout
,
2042 /* Run the inbuilt backtrace if there are no filters registered, or
2043 "-no-filters" has been specified from the command. */
2044 if (bt_opts
.no_filters
|| result
== EXT_LANG_BT_NO_FILTERS
)
2046 frame_info_ptr trailing
;
2048 /* The following code must do two things. First, it must set the
2049 variable TRAILING to the frame from which we should start
2050 printing. Second, it must set the variable count to the number
2051 of frames which we should print, or -1 if all of them. */
2053 if (count_exp
!= NULL
&& count
< 0)
2055 trailing
= trailing_outermost_frame (-count
);
2059 trailing
= get_current_frame ();
2061 for (fi
= trailing
; fi
&& count
--; fi
= get_prev_frame (fi
))
2065 /* Don't use print_stack_frame; if an error() occurs it probably
2066 means further attempts to backtrace would fail (on the other
2067 hand, perhaps the code does or could be fixed to make sure
2068 the frame->prev field gets set to NULL in that case). */
2070 print_frame_info (fp_opts
, fi
, 1, LOCATION
, 1, 0);
2071 if ((flags
& PRINT_LOCALS
) != 0)
2072 print_frame_local_vars (fi
, false, NULL
, NULL
, 1, gdb_stdout
);
2074 /* Save the last frame to check for error conditions. */
2078 /* If we've stopped before the end, mention that. */
2080 gdb_printf (_("(More stack frames follow...)\n"));
2082 /* If we've run out of frames, and the reason appears to be an error
2083 condition, print it. */
2084 if (fi
== NULL
&& trailing
!= NULL
)
2086 enum unwind_stop_reason reason
;
2088 reason
= get_frame_unwind_stop_reason (trailing
);
2089 if (reason
>= UNWIND_FIRST_ERROR
)
2090 gdb_printf (_("Backtrace stopped: %s\n"),
2091 frame_stop_reason_string (trailing
));
2096 /* Create an option_def_group array grouping all the "backtrace"
2097 options, with FP_OPTS, BT_CMD_OPT, SET_BT_OPTS as contexts. */
2099 static inline std::array
<gdb::option::option_def_group
, 3>
2100 make_backtrace_options_def_group (frame_print_options
*fp_opts
,
2101 backtrace_cmd_options
*bt_cmd_opts
,
2102 set_backtrace_options
*set_bt_opts
)
2105 { {frame_print_option_defs
}, fp_opts
},
2106 { {set_backtrace_option_defs
}, set_bt_opts
},
2107 { {backtrace_command_option_defs
}, bt_cmd_opts
}
2111 /* Parse the backtrace command's qualifiers. Returns ARG advanced
2112 past the qualifiers, if any. BT_CMD_OPTS, if not null, is used to
2113 store the parsed qualifiers. */
2116 parse_backtrace_qualifiers (const char *arg
,
2117 backtrace_cmd_options
*bt_cmd_opts
= nullptr)
2121 const char *save_arg
= arg
;
2122 std::string this_arg
= extract_arg (&arg
);
2124 if (this_arg
.empty ())
2127 if (startswith ("no-filters", this_arg
))
2129 if (bt_cmd_opts
!= nullptr)
2130 bt_cmd_opts
->no_filters
= true;
2132 else if (startswith ("full", this_arg
))
2134 if (bt_cmd_opts
!= nullptr)
2135 bt_cmd_opts
->full
= true;
2137 else if (startswith ("hide", this_arg
))
2139 if (bt_cmd_opts
!= nullptr)
2140 bt_cmd_opts
->hide
= true;
2144 /* Not a recognized qualifier, so stop. */
2151 backtrace_command (const char *arg
, int from_tty
)
2153 frame_print_options fp_opts
= user_frame_print_options
;
2154 backtrace_cmd_options bt_cmd_opts
;
2155 set_backtrace_options set_bt_opts
= user_set_backtrace_options
;
2158 = make_backtrace_options_def_group (&fp_opts
, &bt_cmd_opts
, &set_bt_opts
);
2159 gdb::option::process_options
2160 (&arg
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
2162 /* Parse non-'-'-prefixed qualifiers, for backwards
2166 arg
= parse_backtrace_qualifiers (arg
, &bt_cmd_opts
);
2171 /* These options are handled quite deep in the unwind machinery, so
2172 we get to pass them down by swapping globals. */
2173 scoped_restore restore_set_backtrace_options
2174 = make_scoped_restore (&user_set_backtrace_options
, set_bt_opts
);
2176 backtrace_command_1 (fp_opts
, bt_cmd_opts
, arg
, from_tty
);
2179 /* Completer for the "backtrace" command. */
2182 backtrace_command_completer (struct cmd_list_element
*ignore
,
2183 completion_tracker
&tracker
,
2184 const char *text
, const char */
*word*/
)
2187 = make_backtrace_options_def_group (nullptr, nullptr, nullptr);
2188 if (gdb::option::complete_options
2189 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
2194 const char *p
= skip_to_space (text
);
2197 static const char *const backtrace_cmd_qualifier_choices
[] = {
2198 "full", "no-filters", "hide", nullptr,
2200 complete_on_enum (tracker
, backtrace_cmd_qualifier_choices
,
2203 if (tracker
.have_completions ())
2208 const char *cmd
= parse_backtrace_qualifiers (text
);
2209 tracker
.advance_custom_word_point_by (cmd
- text
);
2214 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
2215 expression_completer (ignore
, tracker
, text
, word
);
2218 /* Iterate over the local variables of a block B, calling CB. */
2221 iterate_over_block_locals (const struct block
*b
,
2222 iterate_over_block_arg_local_vars_cb cb
)
2224 struct block_iterator iter
;
2227 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
2229 switch (sym
->aclass ())
2236 case LOC_OPTIMIZED_OUT
:
2237 if (sym
->is_argument ())
2239 if (sym
->domain () == COMMON_BLOCK_DOMAIN
)
2241 cb (sym
->print_name (), sym
);
2245 /* Ignore symbols which are not locals. */
2251 /* Iterate over all the local variables in block B, including all its
2252 superblocks, stopping when the top-level block is reached. */
2255 iterate_over_block_local_vars (const struct block
*block
,
2256 iterate_over_block_arg_local_vars_cb cb
)
2260 iterate_over_block_locals (block
, cb
);
2261 /* After handling the function's top-level block, stop. Don't
2262 continue to its superblock, the block of per-file
2264 if (block
->function ())
2266 block
= block
->superblock ();
2270 /* Data to be passed around in the calls to the locals and args
2273 struct print_variable_and_value_data
2275 gdb::optional
<compiled_regex
> preg
;
2276 gdb::optional
<compiled_regex
> treg
;
2277 struct frame_id frame_id
;
2279 struct ui_file
*stream
;
2282 void operator() (const char *print_name
, struct symbol
*sym
);
2285 /* The callback for the locals and args iterators. */
2288 print_variable_and_value_data::operator() (const char *print_name
,
2291 frame_info_ptr frame
;
2293 if (preg
.has_value ()
2294 && preg
->exec (sym
->natural_name (), 0, NULL
, 0) != 0)
2296 if (treg
.has_value ()
2297 && !treg_matches_sym_type_name (*treg
, sym
))
2299 if (language_def (sym
->language ())->symbol_printing_suppressed (sym
))
2302 frame
= frame_find_by_id (frame_id
);
2305 warning (_("Unable to restore previously selected frame."));
2309 print_variable_and_value (print_name
, sym
, frame
, stream
, num_tabs
);
2311 /* print_variable_and_value invalidates FRAME. */
2317 /* Prepares the regular expression REG from REGEXP.
2318 If REGEXP is NULL, it results in an empty regular expression. */
2321 prepare_reg (const char *regexp
, gdb::optional
<compiled_regex
> *reg
)
2325 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
2327 reg
->emplace (regexp
, cflags
, _("Invalid regexp"));
2333 /* Print all variables from the innermost up to the function block of FRAME.
2334 Print them with values to STREAM indented by NUM_TABS.
2335 If REGEXP is not NULL, only print local variables whose name
2337 If T_REGEXP is not NULL, only print local variables whose type
2339 If no local variables have been printed and !QUIET, prints a message
2340 explaining why no local variables could be printed.
2342 This function will invalidate FRAME. */
2345 print_frame_local_vars (frame_info_ptr frame
,
2347 const char *regexp
, const char *t_regexp
,
2348 int num_tabs
, struct ui_file
*stream
)
2350 struct print_variable_and_value_data cb_data
;
2351 const struct block
*block
;
2354 if (!get_frame_pc_if_available (frame
, &pc
))
2358 _("PC unavailable, cannot determine locals.\n"));
2362 block
= get_frame_block (frame
, 0);
2366 gdb_printf (stream
, "No symbol table info available.\n");
2370 prepare_reg (regexp
, &cb_data
.preg
);
2371 prepare_reg (t_regexp
, &cb_data
.treg
);
2372 cb_data
.frame_id
= get_frame_id (frame
);
2373 cb_data
.num_tabs
= 4 * num_tabs
;
2374 cb_data
.stream
= stream
;
2375 cb_data
.values_printed
= 0;
2377 /* Temporarily change the selected frame to the given FRAME.
2378 This allows routines that rely on the selected frame instead
2379 of being given a frame as parameter to use the correct frame. */
2380 scoped_restore_selected_frame restore_selected_frame
;
2381 select_frame (frame
);
2383 iterate_over_block_local_vars (block
, cb_data
);
2385 if (!cb_data
.values_printed
&& !quiet
)
2387 if (regexp
== NULL
&& t_regexp
== NULL
)
2388 gdb_printf (stream
, _("No locals.\n"));
2390 gdb_printf (stream
, _("No matching locals.\n"));
2394 /* Structure to hold the values of the options used by the 'info
2395 variables' command and other similar commands. These correspond to the
2396 -q and -t options. */
2398 struct info_print_options
2401 std::string type_regexp
;
2404 /* The options used by the 'info locals' and 'info args' commands. */
2406 static const gdb::option::option_def info_print_options_defs
[] = {
2407 gdb::option::boolean_option_def
<info_print_options
> {
2409 [] (info_print_options
*opt
) { return &opt
->quiet
; },
2410 nullptr, /* show_cmd_cb */
2411 nullptr /* set_doc */
2414 gdb::option::string_option_def
<info_print_options
> {
2416 [] (info_print_options
*opt
) { return &opt
->type_regexp
; },
2417 nullptr, /* show_cmd_cb */
2418 nullptr /* set_doc */
2422 /* Returns the option group used by 'info locals' and 'info args'
2425 static gdb::option::option_def_group
2426 make_info_print_options_def_group (info_print_options
*opts
)
2428 return {{info_print_options_defs
}, opts
};
2431 /* Command completer for 'info locals' and 'info args'. */
2434 info_print_command_completer (struct cmd_list_element
*ignore
,
2435 completion_tracker
&tracker
,
2436 const char *text
, const char * /* word */)
2439 = make_info_print_options_def_group (nullptr);
2440 if (gdb::option::complete_options
2441 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
2444 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
2445 symbol_completer (ignore
, tracker
, text
, word
);
2448 /* Implement the 'info locals' command. */
2451 info_locals_command (const char *args
, int from_tty
)
2453 info_print_options opts
;
2454 auto grp
= make_info_print_options_def_group (&opts
);
2455 gdb::option::process_options
2456 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
2457 if (args
!= nullptr && *args
== '\0')
2460 print_frame_local_vars
2461 (get_selected_frame (_("No frame selected.")),
2463 opts
.type_regexp
.empty () ? nullptr : opts
.type_regexp
.c_str (),
2467 /* Iterate over all the argument variables in block B. */
2470 iterate_over_block_arg_vars (const struct block
*b
,
2471 iterate_over_block_arg_local_vars_cb cb
)
2473 struct block_iterator iter
;
2474 struct symbol
*sym
, *sym2
;
2476 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
2478 /* Don't worry about things which aren't arguments. */
2479 if (sym
->is_argument ())
2481 /* We have to look up the symbol because arguments can have
2482 two entries (one a parameter, one a local) and the one we
2483 want is the local, which lookup_symbol will find for us.
2484 This includes gcc1 (not gcc2) on the sparc when passing a
2485 small structure and gcc2 when the argument type is float
2486 and it is passed as a double and converted to float by
2487 the prologue (in the latter case the type of the LOC_ARG
2488 symbol is double and the type of the LOC_LOCAL symbol is
2489 float). There are also LOC_ARG/LOC_REGISTER pairs which
2490 are not combined in symbol-reading. */
2492 sym2
= lookup_symbol_search_name (sym
->search_name (),
2493 b
, VAR_DOMAIN
).symbol
;
2494 cb (sym
->print_name (), sym2
);
2499 /* Print all argument variables of the function of FRAME.
2500 Print them with values to STREAM.
2501 If REGEXP is not NULL, only print argument variables whose name
2503 If T_REGEXP is not NULL, only print argument variables whose type
2505 If no argument variables have been printed and !QUIET, prints a message
2506 explaining why no argument variables could be printed.
2508 This function will invalidate FRAME. */
2511 print_frame_arg_vars (frame_info_ptr frame
,
2513 const char *regexp
, const char *t_regexp
,
2514 struct ui_file
*stream
)
2516 struct print_variable_and_value_data cb_data
;
2517 struct symbol
*func
;
2519 gdb::optional
<compiled_regex
> preg
;
2520 gdb::optional
<compiled_regex
> treg
;
2522 if (!get_frame_pc_if_available (frame
, &pc
))
2526 _("PC unavailable, cannot determine args.\n"));
2530 func
= get_frame_function (frame
);
2534 gdb_printf (stream
, _("No symbol table info available.\n"));
2538 prepare_reg (regexp
, &cb_data
.preg
);
2539 prepare_reg (t_regexp
, &cb_data
.treg
);
2540 cb_data
.frame_id
= get_frame_id (frame
);
2541 cb_data
.num_tabs
= 0;
2542 cb_data
.stream
= stream
;
2543 cb_data
.values_printed
= 0;
2545 iterate_over_block_arg_vars (func
->value_block (), cb_data
);
2547 /* do_print_variable_and_value invalidates FRAME. */
2550 if (!cb_data
.values_printed
&& !quiet
)
2552 if (regexp
== NULL
&& t_regexp
== NULL
)
2553 gdb_printf (stream
, _("No arguments.\n"));
2555 gdb_printf (stream
, _("No matching arguments.\n"));
2559 /* Implement the 'info args' command. */
2562 info_args_command (const char *args
, int from_tty
)
2564 info_print_options opts
;
2565 auto grp
= make_info_print_options_def_group (&opts
);
2566 gdb::option::process_options
2567 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
2568 if (args
!= nullptr && *args
== '\0')
2571 print_frame_arg_vars
2572 (get_selected_frame (_("No frame selected.")),
2574 opts
.type_regexp
.empty () ? nullptr : opts
.type_regexp
.c_str (),
2578 /* Return the symbol-block in which the selected frame is executing.
2579 Can return zero under various legitimate circumstances.
2581 If ADDR_IN_BLOCK is non-zero, set *ADDR_IN_BLOCK to the relevant
2582 code address within the block returned. We use this to decide
2583 which macros are in scope. */
2585 const struct block
*
2586 get_selected_block (CORE_ADDR
*addr_in_block
)
2588 if (!has_stack_frames ())
2591 return get_frame_block (get_selected_frame (NULL
), addr_in_block
);
2594 /* Find a frame a certain number of levels away from FRAME.
2595 LEVEL_OFFSET_PTR points to an int containing the number of levels.
2596 Positive means go to earlier frames (up); negative, the reverse.
2597 The int that contains the number of levels is counted toward
2598 zero as the frames for those levels are found.
2599 If the top or bottom frame is reached, that frame is returned,
2600 but the final value of *LEVEL_OFFSET_PTR is nonzero and indicates
2601 how much farther the original request asked to go. */
2604 find_relative_frame (frame_info_ptr frame
, int *level_offset_ptr
)
2606 /* Going up is simple: just call get_prev_frame enough times or
2607 until the initial frame is reached. */
2608 while (*level_offset_ptr
> 0)
2610 frame_info_ptr prev
= get_prev_frame (frame
);
2614 (*level_offset_ptr
)--;
2618 /* Going down is just as simple. */
2619 while (*level_offset_ptr
< 0)
2621 frame_info_ptr next
= get_next_frame (frame
);
2625 (*level_offset_ptr
)++;
2632 /* Select the frame up one or COUNT_EXP stack levels from the
2633 previously selected frame, and print it briefly. */
2636 up_silently_base (const char *count_exp
)
2638 frame_info_ptr frame
;
2642 count
= parse_and_eval_long (count_exp
);
2644 frame
= find_relative_frame (get_selected_frame ("No stack."), &count
);
2645 if (count
!= 0 && count_exp
== NULL
)
2646 error (_("Initial frame selected; you cannot go up."));
2647 select_frame (frame
);
2651 up_silently_command (const char *count_exp
, int from_tty
)
2653 up_silently_base (count_exp
);
2657 up_command (const char *count_exp
, int from_tty
)
2659 up_silently_base (count_exp
);
2660 gdb::observers::user_selected_context_changed
.notify (USER_SELECTED_FRAME
);
2663 /* Select the frame down one or COUNT_EXP stack levels from the previously
2664 selected frame, and print it briefly. */
2667 down_silently_base (const char *count_exp
)
2669 frame_info_ptr frame
;
2673 count
= -parse_and_eval_long (count_exp
);
2675 frame
= find_relative_frame (get_selected_frame ("No stack."), &count
);
2676 if (count
!= 0 && count_exp
== NULL
)
2678 /* We only do this if COUNT_EXP is not specified. That way
2679 "down" means to really go down (and let me know if that is
2680 impossible), but "down 9999" can be used to mean go all the
2681 way down without getting an error. */
2683 error (_("Bottom (innermost) frame selected; you cannot go down."));
2686 select_frame (frame
);
2690 down_silently_command (const char *count_exp
, int from_tty
)
2692 down_silently_base (count_exp
);
2696 down_command (const char *count_exp
, int from_tty
)
2698 down_silently_base (count_exp
);
2699 gdb::observers::user_selected_context_changed
.notify (USER_SELECTED_FRAME
);
2703 return_command (const char *retval_exp
, int from_tty
)
2705 /* Initialize it just to avoid a GCC false warning. */
2706 enum return_value_convention rv_conv
= RETURN_VALUE_STRUCT_CONVENTION
;
2707 frame_info_ptr thisframe
;
2708 struct gdbarch
*gdbarch
;
2709 struct symbol
*thisfun
;
2710 struct value
*return_value
= NULL
;
2711 struct value
*function
= NULL
;
2712 std::string query_prefix
;
2714 thisframe
= get_selected_frame ("No selected frame.");
2715 thisfun
= get_frame_function (thisframe
);
2716 gdbarch
= get_frame_arch (thisframe
);
2718 if (get_frame_type (get_current_frame ()) == INLINE_FRAME
)
2719 error (_("Can not force return from an inlined function."));
2721 /* Compute the return value. If the computation triggers an error,
2722 let it bail. If the return type can't be handled, set
2723 RETURN_VALUE to NULL, and QUERY_PREFIX to an informational
2727 expression_up retval_expr
= parse_expression (retval_exp
);
2728 struct type
*return_type
= NULL
;
2730 /* Compute the return value. Should the computation fail, this
2731 call throws an error. */
2732 return_value
= evaluate_expression (retval_expr
.get ());
2734 /* Cast return value to the return type of the function. Should
2735 the cast fail, this call throws an error. */
2736 if (thisfun
!= NULL
)
2737 return_type
= thisfun
->type ()->target_type ();
2738 if (return_type
== NULL
)
2740 if (retval_expr
->first_opcode () != UNOP_CAST
2741 && retval_expr
->first_opcode () != UNOP_CAST_TYPE
)
2742 error (_("Return value type not available for selected "
2744 "Please use an explicit cast of the value to return."));
2745 return_type
= value_type (return_value
);
2747 return_type
= check_typedef (return_type
);
2748 return_value
= value_cast (return_type
, return_value
);
2750 /* Make sure the value is fully evaluated. It may live in the
2751 stack frame we're about to pop. */
2752 if (value_lazy (return_value
))
2753 value_fetch_lazy (return_value
);
2755 if (thisfun
!= NULL
)
2756 function
= read_var_value (thisfun
, NULL
, thisframe
);
2758 rv_conv
= RETURN_VALUE_REGISTER_CONVENTION
;
2759 if (return_type
->code () == TYPE_CODE_VOID
)
2760 /* If the return-type is "void", don't try to find the
2761 return-value's location. However, do still evaluate the
2762 return expression so that, even when the expression result
2763 is discarded, side effects such as "return i++" still
2765 return_value
= NULL
;
2766 else if (thisfun
!= NULL
)
2768 if (is_nocall_function (check_typedef (value_type (function
))))
2771 string_printf ("Function '%s' does not follow the target "
2772 "calling convention.\n"
2773 "If you continue, setting the return value "
2774 "will probably lead to unpredictable "
2776 thisfun
->print_name ());
2779 rv_conv
= struct_return_convention (gdbarch
, function
, return_type
);
2780 if (rv_conv
== RETURN_VALUE_STRUCT_CONVENTION
2781 || rv_conv
== RETURN_VALUE_ABI_RETURNS_ADDRESS
)
2783 query_prefix
= "The location at which to store the "
2784 "function's return value is unknown.\n"
2785 "If you continue, the return value "
2786 "that you specified will be ignored.\n";
2787 return_value
= NULL
;
2792 /* Does an interactive user really want to do this? Include
2793 information, such as how well GDB can handle the return value, in
2794 the query message. */
2799 if (thisfun
== NULL
)
2800 confirmed
= query (_("%sMake selected stack frame return now? "),
2801 query_prefix
.c_str ());
2804 if (TYPE_NO_RETURN (thisfun
->type ()))
2805 warning (_("Function does not return normally to caller."));
2806 confirmed
= query (_("%sMake %s return now? "),
2807 query_prefix
.c_str (),
2808 thisfun
->print_name ());
2811 error (_("Not confirmed"));
2814 /* Discard the selected frame and all frames inner-to it. */
2815 frame_pop (get_selected_frame (NULL
));
2817 /* Store RETURN_VALUE in the just-returned register set. */
2818 if (return_value
!= NULL
)
2820 struct type
*return_type
= value_type (return_value
);
2821 struct gdbarch
*cache_arch
= get_current_regcache ()->arch ();
2823 gdb_assert (rv_conv
!= RETURN_VALUE_STRUCT_CONVENTION
2824 && rv_conv
!= RETURN_VALUE_ABI_RETURNS_ADDRESS
);
2825 gdbarch_return_value_as_value
2826 (cache_arch
, function
, return_type
,
2827 get_current_regcache (), NULL
/*read*/,
2828 value_contents (return_value
).data () /*write*/);
2831 /* If we are at the end of a call dummy now, pop the dummy frame
2833 if (get_frame_type (get_current_frame ()) == DUMMY_FRAME
)
2834 frame_pop (get_current_frame ());
2836 select_frame (get_current_frame ());
2837 /* If interactive, print the frame that is now current. */
2839 print_stack_frame (get_selected_frame (NULL
), 1, SRC_AND_LOC
, 1);
2842 /* Find the most inner frame in the current stack for a function called
2843 FUNCTION_NAME. If no matching frame is found return NULL. */
2845 static frame_info_ptr
2846 find_frame_for_function (const char *function_name
)
2848 /* Used to hold the lower and upper addresses for each of the
2849 SYMTAB_AND_LINEs found for functions matching FUNCTION_NAME. */
2850 struct function_bounds
2852 CORE_ADDR low
, high
;
2854 frame_info_ptr frame
;
2858 gdb_assert (function_name
!= NULL
);
2860 frame
= get_current_frame ();
2861 std::vector
<symtab_and_line
> sals
2862 = decode_line_with_current_source (function_name
,
2863 DECODE_LINE_FUNFIRSTLINE
);
2864 gdb::def_vector
<function_bounds
> func_bounds (sals
.size ());
2865 for (size_t i
= 0; i
< sals
.size (); i
++)
2867 if (sals
[i
].pspace
!= current_program_space
)
2868 func_bounds
[i
].low
= func_bounds
[i
].high
= 0;
2869 else if (sals
[i
].pc
== 0
2870 || find_pc_partial_function (sals
[i
].pc
, NULL
,
2871 &func_bounds
[i
].low
,
2872 &func_bounds
[i
].high
) == 0)
2873 func_bounds
[i
].low
= func_bounds
[i
].high
= 0;
2878 for (size_t i
= 0; (i
< sals
.size () && !found
); i
++)
2879 found
= (get_frame_pc (frame
) >= func_bounds
[i
].low
2880 && get_frame_pc (frame
) < func_bounds
[i
].high
);
2884 frame
= find_relative_frame (frame
, &level
);
2887 while (!found
&& level
== 0);
2895 /* The qcs command line flags for the "frame apply" commands. Keep
2896 this in sync with the "thread apply" commands. */
2898 using qcs_flag_option_def
2899 = gdb::option::flag_option_def
<qcs_flags
>;
2901 static const gdb::option::option_def fr_qcs_flags_option_defs
[] = {
2902 qcs_flag_option_def
{
2903 "q", [] (qcs_flags
*opt
) { return &opt
->quiet
; },
2904 N_("Disables printing the frame location information."),
2907 qcs_flag_option_def
{
2908 "c", [] (qcs_flags
*opt
) { return &opt
->cont
; },
2909 N_("Print any error raised by COMMAND and continue."),
2912 qcs_flag_option_def
{
2913 "s", [] (qcs_flags
*opt
) { return &opt
->silent
; },
2914 N_("Silently ignore any errors or empty output produced by COMMAND."),
2918 /* Create an option_def_group array for all the "frame apply" options,
2919 with FLAGS and SET_BT_OPTS as context. */
2921 static inline std::array
<gdb::option::option_def_group
, 2>
2922 make_frame_apply_options_def_group (qcs_flags
*flags
,
2923 set_backtrace_options
*set_bt_opts
)
2926 { {fr_qcs_flags_option_defs
}, flags
},
2927 { {set_backtrace_option_defs
}, set_bt_opts
},
2931 /* Apply a GDB command to all stack frames, or a set of identified frames,
2932 or innermost COUNT frames.
2933 With a negative COUNT, apply command on outermost -COUNT frames.
2935 frame apply 3 info frame Apply 'info frame' to frames 0, 1, 2
2936 frame apply -3 info frame Apply 'info frame' to outermost 3 frames.
2937 frame apply all x/i $pc Apply 'x/i $pc' cmd to all frames.
2938 frame apply all -s p local_var_no_idea_in_which_frame
2939 If a frame has a local variable called
2940 local_var_no_idea_in_which_frame, print frame
2941 and value of local_var_no_idea_in_which_frame.
2942 frame apply all -s -q p local_var_no_idea_in_which_frame
2943 Same as before, but only print the variable value.
2944 frame apply level 2-5 0 4-7 -s p i = i + 1
2945 Adds 1 to the variable i in the specified frames.
2946 Note that i will be incremented twice in
2949 /* Apply a GDB command to COUNT stack frames, starting at TRAILING.
2950 CMD starts with 0 or more qcs flags followed by the GDB command to apply.
2951 COUNT -1 means all frames starting at TRAILING. WHICH_COMMAND is used
2952 for error messages. */
2955 frame_apply_command_count (const char *which_command
,
2956 const char *cmd
, int from_tty
,
2957 frame_info_ptr trailing
, int count
)
2960 set_backtrace_options set_bt_opts
= user_set_backtrace_options
;
2962 auto group
= make_frame_apply_options_def_group (&flags
, &set_bt_opts
);
2963 gdb::option::process_options
2964 (&cmd
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
);
2966 validate_flags_qcs (which_command
, &flags
);
2968 if (cmd
== NULL
|| *cmd
== '\0')
2969 error (_("Please specify a command to apply on the selected frames"));
2971 /* The below will restore the current inferior/thread/frame.
2972 Usually, only the frame is effectively to be restored.
2973 But in case CMD switches of inferior/thread, better restore
2975 scoped_restore_current_thread restore_thread
;
2977 /* These options are handled quite deep in the unwind machinery, so
2978 we get to pass them down by swapping globals. */
2979 scoped_restore restore_set_backtrace_options
2980 = make_scoped_restore (&user_set_backtrace_options
, set_bt_opts
);
2982 for (frame_info_ptr fi
= trailing
; fi
&& count
--; fi
= get_prev_frame (fi
))
2989 std::string cmd_result
;
2991 /* In case CMD switches of inferior/thread/frame, the below
2992 restores the inferior/thread/frame. FI can then be
2993 set to the selected frame. */
2994 scoped_restore_current_thread restore_fi_current_frame
;
2996 execute_command_to_string
2997 (cmd_result
, cmd
, from_tty
, gdb_stdout
->term_out ());
2999 fi
= get_selected_frame (_("frame apply "
3000 "unable to get selected frame."));
3001 if (!flags
.silent
|| cmd_result
.length () > 0)
3004 print_stack_frame (fi
, 1, LOCATION
, 0);
3005 gdb_printf ("%s", cmd_result
.c_str ());
3008 catch (const gdb_exception_error
&ex
)
3010 fi
= get_selected_frame (_("frame apply "
3011 "unable to get selected frame."));
3015 print_stack_frame (fi
, 1, LOCATION
, 0);
3017 gdb_printf ("%s\n", ex
.what ());
3025 /* Completer for the "frame apply ..." commands. */
3028 frame_apply_completer (completion_tracker
&tracker
, const char *text
)
3030 const auto group
= make_frame_apply_options_def_group (nullptr, nullptr);
3031 if (gdb::option::complete_options
3032 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
3035 complete_nested_command_line (tracker
, text
);
3038 /* Completer for the "frame apply" commands. */
3041 frame_apply_level_cmd_completer (struct cmd_list_element
*ignore
,
3042 completion_tracker
&tracker
,
3043 const char *text
, const char */
*word*/
)
3045 /* Do this explicitly because there's an early return below. */
3046 tracker
.set_use_custom_word_point (true);
3048 number_or_range_parser
levels (text
);
3050 /* Skip the LEVEL list to find the options and command args. */
3053 while (!levels
.finished ())
3055 /* Call for effect. */
3056 levels
.get_number ();
3058 if (levels
.in_range ())
3059 levels
.skip_range ();
3062 catch (const gdb_exception_error
&ex
)
3064 /* get_number throws if it parses a negative number, for
3065 example. But a seemingly negative number may be the start of
3066 an option instead. */
3069 const char *cmd
= levels
.cur_tok ();
3073 /* No level list yet. */
3077 /* Check if we're past a valid LEVEL already. */
3078 if (levels
.finished ()
3079 && cmd
> text
&& !isspace (cmd
[-1]))
3082 /* We're past LEVELs, advance word point. */
3083 tracker
.advance_custom_word_point_by (cmd
- text
);
3086 frame_apply_completer (tracker
, text
);
3089 /* Completer for the "frame apply all" command. */
3092 frame_apply_all_cmd_completer (struct cmd_list_element
*ignore
,
3093 completion_tracker
&tracker
,
3094 const char *text
, const char */
*word*/
)
3096 frame_apply_completer (tracker
, text
);
3099 /* Completer for the "frame apply COUNT" command. */
3102 frame_apply_cmd_completer (struct cmd_list_element
*ignore
,
3103 completion_tracker
&tracker
,
3104 const char *text
, const char */
*word*/
)
3106 const char *cmd
= text
;
3108 int count
= get_number_trailer (&cmd
, 0);
3112 /* Check if we're past a valid COUNT already. */
3113 if (cmd
> text
&& !isspace (cmd
[-1]))
3116 /* We're past COUNT, advance word point. */
3117 tracker
.advance_custom_word_point_by (cmd
- text
);
3120 frame_apply_completer (tracker
, text
);
3123 /* Implementation of the "frame apply level" command. */
3126 frame_apply_level_command (const char *cmd
, int from_tty
)
3128 if (!target_has_stack ())
3129 error (_("No stack."));
3131 bool level_found
= false;
3132 const char *levels_str
= cmd
;
3133 number_or_range_parser
levels (levels_str
);
3135 /* Skip the LEVEL list to find the flags and command args. */
3136 while (!levels
.finished ())
3138 /* Call for effect. */
3139 levels
.get_number ();
3142 if (levels
.in_range ())
3143 levels
.skip_range ();
3147 error (_("Missing or invalid LEVEL... argument"));
3149 cmd
= levels
.cur_tok ();
3151 /* Redo the LEVELS parsing, but applying COMMAND. */
3152 levels
.init (levels_str
);
3153 while (!levels
.finished ())
3155 const int level_beg
= levels
.get_number ();
3158 if (levels
.in_range ())
3160 n_frames
= levels
.end_value () - level_beg
+ 1;
3161 levels
.skip_range ();
3166 frame_apply_command_count ("frame apply level", cmd
, from_tty
,
3167 leading_innermost_frame (level_beg
), n_frames
);
3171 /* Implementation of the "frame apply all" command. */
3174 frame_apply_all_command (const char *cmd
, int from_tty
)
3176 if (!target_has_stack ())
3177 error (_("No stack."));
3179 frame_apply_command_count ("frame apply all", cmd
, from_tty
,
3180 get_current_frame (), INT_MAX
);
3183 /* Implementation of the "frame apply" command. */
3186 frame_apply_command (const char* cmd
, int from_tty
)
3189 frame_info_ptr trailing
;
3191 if (!target_has_stack ())
3192 error (_("No stack."));
3195 error (_("Missing COUNT argument."));
3196 count
= get_number_trailer (&cmd
, 0);
3198 error (_("Invalid COUNT argument."));
3202 trailing
= trailing_outermost_frame (-count
);
3206 trailing
= get_current_frame ();
3208 frame_apply_command_count ("frame apply", cmd
, from_tty
,
3212 /* Implementation of the "faas" command. */
3215 faas_command (const char *cmd
, int from_tty
)
3217 if (cmd
== NULL
|| *cmd
== '\0')
3218 error (_("Please specify a command to apply on all frames"));
3219 std::string expanded
= std::string ("frame apply all -s ") + cmd
;
3220 execute_command (expanded
.c_str (), from_tty
);
3224 /* Find inner-mode frame with frame address ADDRESS. Return NULL if no
3225 matching frame can be found. */
3227 static frame_info_ptr
3228 find_frame_for_address (CORE_ADDR address
)
3233 id
= frame_id_build_wild (address
);
3235 /* If (s)he specifies the frame with an address, he deserves
3236 what (s)he gets. Still, give the highest one that matches.
3237 (NOTE: cagney/2004-10-29: Why highest, or outer-most, I don't
3239 for (fid
= get_current_frame ();
3241 fid
= get_prev_frame (fid
))
3243 if (id
== get_frame_id (fid
))
3245 frame_info_ptr prev_frame
;
3249 prev_frame
= get_prev_frame (fid
);
3251 || id
!= get_frame_id (prev_frame
))
3263 /* Commands with a prefix of `frame apply'. */
3264 static struct cmd_list_element
*frame_apply_cmd_list
= NULL
;
3266 /* Commands with a prefix of `frame'. */
3267 static struct cmd_list_element
*frame_cmd_list
= NULL
;
3269 /* Commands with a prefix of `select frame'. */
3270 static struct cmd_list_element
*select_frame_cmd_list
= NULL
;
3272 /* Commands with a prefix of `info frame'. */
3273 static struct cmd_list_element
*info_frame_cmd_list
= NULL
;
3275 void _initialize_stack ();
3277 _initialize_stack ()
3279 struct cmd_list_element
*cmd
;
3281 add_com ("return", class_stack
, return_command
, _("\
3282 Make selected stack frame return to its caller.\n\
3283 Control remains in the debugger, but when you continue\n\
3284 execution will resume in the frame above the one now selected.\n\
3285 If an argument is given, it is an expression for the value to return."));
3287 add_com ("up", class_stack
, up_command
, _("\
3288 Select and print stack frame that called this one.\n\
3289 An argument says how many frames up to go."));
3290 add_com ("up-silently", class_support
, up_silently_command
, _("\
3291 Same as the `up' command, but does not print anything.\n\
3292 This is useful in command scripts."));
3294 cmd_list_element
*down_cmd
3295 = add_com ("down", class_stack
, down_command
, _("\
3296 Select and print stack frame called by this one.\n\
3297 An argument says how many frames down to go."));
3298 add_com_alias ("do", down_cmd
, class_stack
, 1);
3299 add_com_alias ("dow", down_cmd
, class_stack
, 1);
3300 add_com ("down-silently", class_support
, down_silently_command
, _("\
3301 Same as the `down' command, but does not print anything.\n\
3302 This is useful in command scripts."));
3304 cmd_list_element
*frame_cmd_el
3305 = add_prefix_cmd ("frame", class_stack
,
3306 &frame_cmd
.base_command
, _("\
3307 Select and print a stack frame.\n\
3308 With no argument, print the selected stack frame. (See also \"info frame\").\n\
3309 A single numerical argument specifies the frame to select."),
3310 &frame_cmd_list
, 1, &cmdlist
);
3311 add_com_alias ("f", frame_cmd_el
, class_stack
, 1);
3313 #define FRAME_APPLY_OPTION_HELP "\
3314 Prints the frame location information followed by COMMAND output.\n\
3316 By default, an error raised during the execution of COMMAND\n\
3317 aborts \"frame apply\".\n\
3322 const auto frame_apply_opts
3323 = make_frame_apply_options_def_group (nullptr, nullptr);
3325 static std::string frame_apply_cmd_help
= gdb::option::build_help (_("\
3326 Apply a command to a number of frames.\n\
3327 Usage: frame apply COUNT [OPTION]... COMMAND\n\
3328 With a negative COUNT argument, applies the command on outermost -COUNT frames.\n"
3329 FRAME_APPLY_OPTION_HELP
),
3332 cmd
= add_prefix_cmd ("apply", class_stack
, frame_apply_command
,
3333 frame_apply_cmd_help
.c_str (),
3334 &frame_apply_cmd_list
, 1,
3336 set_cmd_completer_handle_brkchars (cmd
, frame_apply_cmd_completer
);
3338 static std::string frame_apply_all_cmd_help
= gdb::option::build_help (_("\
3339 Apply a command to all frames.\n\
3341 Usage: frame apply all [OPTION]... COMMAND\n"
3342 FRAME_APPLY_OPTION_HELP
),
3345 cmd
= add_cmd ("all", class_stack
, frame_apply_all_command
,
3346 frame_apply_all_cmd_help
.c_str (),
3347 &frame_apply_cmd_list
);
3348 set_cmd_completer_handle_brkchars (cmd
, frame_apply_all_cmd_completer
);
3350 static std::string frame_apply_level_cmd_help
= gdb::option::build_help (_("\
3351 Apply a command to a list of frames.\n\
3353 Usage: frame apply level LEVEL... [OPTION]... COMMAND\n\
3354 LEVEL is a space-separated list of levels of frames to apply COMMAND on.\n"
3355 FRAME_APPLY_OPTION_HELP
),
3358 cmd
= add_cmd ("level", class_stack
, frame_apply_level_command
,
3359 frame_apply_level_cmd_help
.c_str (),
3360 &frame_apply_cmd_list
);
3361 set_cmd_completer_handle_brkchars (cmd
, frame_apply_level_cmd_completer
);
3363 cmd
= add_com ("faas", class_stack
, faas_command
, _("\
3364 Apply a command to all frames (ignoring errors and empty output).\n\
3365 Usage: faas [OPTION]... COMMAND\n\
3366 shortcut for 'frame apply all -s [OPTION]... COMMAND'\n\
3367 See \"help frame apply all\" for available options."));
3368 set_cmd_completer_handle_brkchars (cmd
, frame_apply_all_cmd_completer
);
3370 add_cmd ("address", class_stack
, &frame_cmd
.address
,
3372 Select and print a stack frame by stack address.\n\
3374 Usage: frame address STACK-ADDRESS"),
3377 add_cmd ("view", class_stack
, &frame_cmd
.view
,
3379 View a stack frame that might be outside the current backtrace.\n\
3381 Usage: frame view STACK-ADDRESS\n\
3382 frame view STACK-ADDRESS PC-ADDRESS"),
3385 cmd
= add_cmd ("function", class_stack
, &frame_cmd
.function
,
3387 Select and print a stack frame by function name.\n\
3389 Usage: frame function NAME\n\
3391 The innermost frame that visited function NAME is selected."),
3393 set_cmd_completer (cmd
, frame_selection_by_function_completer
);
3396 add_cmd ("level", class_stack
, &frame_cmd
.level
,
3398 Select and print a stack frame by level.\n\
3400 Usage: frame level LEVEL"),
3403 cmd
= add_prefix_cmd_suppress_notification ("select-frame", class_stack
,
3404 &select_frame_cmd
.base_command
, _("\
3405 Select a stack frame without printing anything.\n\
3406 A single numerical argument specifies the frame to select."),
3407 &select_frame_cmd_list
, 1, &cmdlist
,
3408 &cli_suppress_notification
.user_selected_context
);
3410 add_cmd_suppress_notification ("address", class_stack
,
3411 &select_frame_cmd
.address
, _("\
3412 Select a stack frame by stack address.\n\
3414 Usage: select-frame address STACK-ADDRESS"),
3415 &select_frame_cmd_list
,
3416 &cli_suppress_notification
.user_selected_context
);
3419 add_cmd_suppress_notification ("view", class_stack
,
3420 &select_frame_cmd
.view
, _("\
3421 Select a stack frame that might be outside the current backtrace.\n\
3423 Usage: select-frame view STACK-ADDRESS\n\
3424 select-frame view STACK-ADDRESS PC-ADDRESS"),
3425 &select_frame_cmd_list
,
3426 &cli_suppress_notification
.user_selected_context
);
3428 cmd
= add_cmd_suppress_notification ("function", class_stack
,
3429 &select_frame_cmd
.function
, _("\
3430 Select a stack frame by function name.\n\
3432 Usage: select-frame function NAME"),
3433 &select_frame_cmd_list
,
3434 &cli_suppress_notification
.user_selected_context
);
3435 set_cmd_completer (cmd
, frame_selection_by_function_completer
);
3437 add_cmd_suppress_notification ("level", class_stack
,
3438 &select_frame_cmd
.level
, _("\
3439 Select a stack frame by level.\n\
3441 Usage: select-frame level LEVEL"),
3442 &select_frame_cmd_list
,
3443 &cli_suppress_notification
.user_selected_context
);
3445 const auto backtrace_opts
3446 = make_backtrace_options_def_group (nullptr, nullptr, nullptr);
3448 static std::string backtrace_help
3449 = gdb::option::build_help (_("\
3450 Print backtrace of all stack frames, or innermost COUNT frames.\n\
3451 Usage: backtrace [OPTION]... [QUALIFIER]... [COUNT | -COUNT]\n\
3456 For backward compatibility, the following qualifiers are supported:\n\
3458 full - same as -full option.\n\
3459 no-filters - same as -no-filters option.\n\
3460 hide - same as -hide.\n\
3462 With a negative COUNT, print outermost -COUNT frames."),
3465 cmd_list_element
*backtrace_cmd
3466 = add_com ("backtrace", class_stack
, backtrace_command
,
3467 backtrace_help
.c_str ());
3468 set_cmd_completer_handle_brkchars (backtrace_cmd
, backtrace_command_completer
);
3470 add_com_alias ("bt", backtrace_cmd
, class_stack
, 0);
3472 add_com_alias ("where", backtrace_cmd
, class_stack
, 0);
3473 cmd_list_element
*info_stack_cmd
3474 = add_info ("stack", backtrace_command
,
3475 _("Backtrace of the stack, or innermost COUNT frames."));
3476 add_info_alias ("s", info_stack_cmd
, 1);
3478 cmd_list_element
*info_frame_cmd_el
3479 = add_prefix_cmd ("frame", class_info
, &info_frame_cmd
.base_command
,
3480 _("All about the selected stack frame.\n\
3481 With no arguments, displays information about the currently selected stack\n\
3482 frame. Alternatively a frame specification may be provided (See \"frame\")\n\
3483 the information is then printed about the specified frame."),
3484 &info_frame_cmd_list
, 1, &infolist
);
3485 add_info_alias ("f", info_frame_cmd_el
, 1);
3487 add_cmd ("address", class_stack
, &info_frame_cmd
.address
,
3489 Print information about a stack frame selected by stack address.\n\
3491 Usage: info frame address STACK-ADDRESS"),
3492 &info_frame_cmd_list
);
3494 add_cmd ("view", class_stack
, &info_frame_cmd
.view
,
3496 Print information about a stack frame outside the current backtrace.\n\
3498 Usage: info frame view STACK-ADDRESS\n\
3499 info frame view STACK-ADDRESS PC-ADDRESS"),
3500 &info_frame_cmd_list
);
3502 cmd
= add_cmd ("function", class_stack
, &info_frame_cmd
.function
,
3504 Print information about a stack frame selected by function name.\n\
3506 Usage: info frame function NAME"),
3507 &info_frame_cmd_list
);
3508 set_cmd_completer (cmd
, frame_selection_by_function_completer
);
3510 add_cmd ("level", class_stack
, &info_frame_cmd
.level
,
3512 Print information about a stack frame selected by level.\n\
3514 Usage: info frame level LEVEL"),
3515 &info_frame_cmd_list
);
3517 cmd
= add_info ("locals", info_locals_command
,
3518 info_print_args_help (_("\
3519 All local variables of current stack frame or those matching REGEXPs.\n\
3520 Usage: info locals [-q] [-t TYPEREGEXP] [NAMEREGEXP]\n\
3521 Prints the local variables of the current stack frame.\n"),
3522 _("local variables"),
3524 set_cmd_completer_handle_brkchars (cmd
, info_print_command_completer
);
3525 cmd
= add_info ("args", info_args_command
,
3526 info_print_args_help (_("\
3527 All argument variables of current stack frame or those matching REGEXPs.\n\
3528 Usage: info args [-q] [-t TYPEREGEXP] [NAMEREGEXP]\n\
3529 Prints the argument variables of the current stack frame.\n"),
3530 _("argument variables"),
3532 set_cmd_completer_handle_brkchars (cmd
, info_print_command_completer
);
3534 /* Install "set print raw frame-arguments", a deprecated spelling of
3535 "set print raw-frame-arguments". */
3536 set_show_commands set_show_frame_args
3537 = add_setshow_boolean_cmd
3538 ("frame-arguments", no_class
,
3539 &user_frame_print_options
.print_raw_frame_arguments
,
3541 Set whether to print frame arguments in raw form."), _("\
3542 Show whether to print frame arguments in raw form."), _("\
3543 If set, frame arguments are printed in raw form, bypassing any\n\
3544 pretty-printers for that value."),
3546 &setprintrawlist
, &showprintrawlist
);
3547 deprecate_cmd (set_show_frame_args
.set
, "set print raw-frame-arguments");
3549 add_setshow_auto_boolean_cmd ("disassemble-next-line", class_stack
,
3550 &disassemble_next_line
, _("\
3551 Set whether to disassemble next source line or insn when execution stops."),
3553 Show whether to disassemble next source line or insn when execution stops."),
3555 If ON, GDB will display disassembly of the next source line, in addition\n\
3556 to displaying the source line itself. If the next source line cannot\n\
3557 be displayed (e.g., source is unavailable or there's no line info), GDB\n\
3558 will display disassembly of next instruction instead of showing the\n\
3560 If AUTO, display disassembly of next instruction only if the source line\n\
3561 cannot be displayed.\n\
3562 If OFF (which is the default), never display the disassembly of the next\n\
3565 show_disassemble_next_line
,
3566 &setlist
, &showlist
);
3567 disassemble_next_line
= AUTO_BOOLEAN_FALSE
;
3569 gdb::option::add_setshow_cmds_for_options
3570 (class_stack
, &user_frame_print_options
,
3571 frame_print_option_defs
, &setprintlist
, &showprintlist
);