1 /* Print and select stack frames for GDB, the GNU debugger.
3 Copyright (C) 1986-2022 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "expression.h"
31 #include "breakpoint.h"
38 #include "dictionary.h"
39 #include "reggroups.h"
43 #include "gdbthread.h"
44 #include "cp-support.h"
46 #include "inline-frame.h"
48 #include "cli/cli-utils.h"
53 #include "extension.h"
54 #include "observable.h"
55 #include "gdbsupport/def-vector.h"
56 #include "cli/cli-option.h"
57 #include "cli/cli-style.h"
58 #include "gdbsupport/buildargv.h"
60 /* The possible choices of "set print frame-arguments", and the value
63 const char print_frame_arguments_all
[] = "all";
64 const char print_frame_arguments_scalars
[] = "scalars";
65 const char print_frame_arguments_none
[] = "none";
66 const char print_frame_arguments_presence
[] = "presence";
68 static const char *const print_frame_arguments_choices
[] =
70 print_frame_arguments_all
,
71 print_frame_arguments_scalars
,
72 print_frame_arguments_none
,
73 print_frame_arguments_presence
,
77 /* The possible choices of "set print frame-info", and the value
80 const char print_frame_info_auto
[] = "auto";
81 const char print_frame_info_source_line
[] = "source-line";
82 const char print_frame_info_location
[] = "location";
83 const char print_frame_info_source_and_location
[] = "source-and-location";
84 const char print_frame_info_location_and_address
[] = "location-and-address";
85 const char print_frame_info_short_location
[] = "short-location";
87 static const char *const print_frame_info_choices
[] =
89 print_frame_info_auto
,
90 print_frame_info_source_line
,
91 print_frame_info_location
,
92 print_frame_info_source_and_location
,
93 print_frame_info_location_and_address
,
94 print_frame_info_short_location
,
98 /* print_frame_info_print_what[i] maps a choice to the corresponding
100 static const gdb::optional
<enum print_what
> print_frame_info_print_what
[] =
101 {{}, /* Empty value for "auto". */
102 SRC_LINE
, LOCATION
, SRC_AND_LOC
, LOC_AND_ADDRESS
, SHORT_LOCATION
};
104 /* The possible choices of "set print entry-values", and the value
107 const char print_entry_values_no
[] = "no";
108 const char print_entry_values_only
[] = "only";
109 const char print_entry_values_preferred
[] = "preferred";
110 const char print_entry_values_if_needed
[] = "if-needed";
111 const char print_entry_values_both
[] = "both";
112 const char print_entry_values_compact
[] = "compact";
113 const char print_entry_values_default
[] = "default";
114 static const char *const print_entry_values_choices
[] =
116 print_entry_values_no
,
117 print_entry_values_only
,
118 print_entry_values_preferred
,
119 print_entry_values_if_needed
,
120 print_entry_values_both
,
121 print_entry_values_compact
,
122 print_entry_values_default
,
127 frame_print_options user_frame_print_options
;
129 /* Option definitions for some frame-related "set print ..."
132 using boolean_option_def
133 = gdb::option::boolean_option_def
<frame_print_options
>;
134 using enum_option_def
135 = gdb::option::enum_option_def
<frame_print_options
>;
137 static const gdb::option::option_def frame_print_option_defs
[] = {
141 print_entry_values_choices
,
142 [] (frame_print_options
*opt
) { return &opt
->print_entry_values
; },
143 NULL
, /* show_cmd_cb */
144 N_("Set printing of function arguments at function entry."),
145 N_("Show printing of function arguments at function entry."),
146 N_("GDB can sometimes determine the values of function arguments at entry,\n\
147 in addition to their current values. This option tells GDB whether\n\
148 to print the current value, the value at entry (marked as val@entry),\n\
149 or both. Note that one or both of these values may be <optimized out>."),
154 print_frame_arguments_choices
,
155 [] (frame_print_options
*opt
) { return &opt
->print_frame_arguments
; },
156 NULL
, /* show_cmd_cb */
157 N_("Set printing of non-scalar frame arguments."),
158 N_("Show printing of non-scalar frame arguments."),
163 "raw-frame-arguments",
164 [] (frame_print_options
*opt
) { return &opt
->print_raw_frame_arguments
; },
165 NULL
, /* show_cmd_cb */
166 N_("Set whether to print frame arguments in raw form."),
167 N_("Show whether to print frame arguments in raw form."),
168 N_("If set, frame arguments are printed in raw form, bypassing any\n\
169 pretty-printers for that value.")
174 print_frame_info_choices
,
175 [] (frame_print_options
*opt
) { return &opt
->print_frame_info
; },
176 NULL
, /* show_cmd_cb */
177 N_("Set printing of frame information."),
178 N_("Show printing of frame information."),
184 /* Options for the "backtrace" command. */
186 struct backtrace_cmd_options
189 bool no_filters
= false;
193 using bt_flag_option_def
194 = gdb::option::flag_option_def
<backtrace_cmd_options
>;
196 static const gdb::option::option_def backtrace_command_option_defs
[] = {
199 [] (backtrace_cmd_options
*opt
) { return &opt
->full
; },
200 N_("Print values of local variables.")
205 [] (backtrace_cmd_options
*opt
) { return &opt
->no_filters
; },
206 N_("Prohibit frame filters from executing on a backtrace."),
211 [] (backtrace_cmd_options
*opt
) { return &opt
->hide
; },
212 N_("Causes Python frame filter elided frames to not be printed."),
216 /* Prototypes for local functions. */
218 static void print_frame_local_vars (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
;
365 frame
.prepare_reinflate ();
368 print_frame_info (user_frame_print_options
,
369 frame
, print_level
, print_what
, 1 /* print_args */,
373 set_current_sal_from_frame (frame
);
375 catch (const gdb_exception_error
&e
)
380 /* Print nameless arguments of frame FRAME on STREAM, where START is
381 the offset of the first nameless argument, and NUM is the number of
382 nameless arguments to print. FIRST is nonzero if this is the first
383 argument (not just the first nameless argument). */
386 print_frame_nameless_args (frame_info_ptr frame
, long start
, int num
,
387 int first
, struct ui_file
*stream
)
389 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
390 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
395 for (i
= 0; i
< num
; i
++)
398 argsaddr
= get_frame_args_address (frame
);
401 arg_value
= read_memory_integer (argsaddr
+ start
,
402 sizeof (int), byte_order
);
404 gdb_printf (stream
, ", ");
405 gdb_printf (stream
, "%ld", arg_value
);
407 start
+= sizeof (int);
411 /* Print single argument of inferior function. ARG must be already
414 Errors are printed as if they would be the parameter value. Use zeroed ARG
415 iff it should not be printed according to user settings. */
418 print_frame_arg (const frame_print_options
&fp_opts
,
419 const struct frame_arg
*arg
)
421 struct ui_out
*uiout
= current_uiout
;
425 gdb_assert (!arg
->val
|| !arg
->error
);
426 gdb_assert (arg
->entry_kind
== print_entry_values_no
427 || arg
->entry_kind
== print_entry_values_only
428 || (!uiout
->is_mi_like_p ()
429 && arg
->entry_kind
== print_entry_values_compact
));
431 annotate_arg_emitter arg_emitter
;
432 ui_out_emit_tuple
tuple_emitter (uiout
, NULL
);
433 gdb_puts (arg
->sym
->print_name (), &stb
);
434 if (arg
->entry_kind
== print_entry_values_compact
)
436 /* It is OK to provide invalid MI-like stream as with
437 PRINT_ENTRY_VALUE_COMPACT we never use MI. */
440 gdb_puts (arg
->sym
->print_name (), &stb
);
442 if (arg
->entry_kind
== print_entry_values_only
443 || arg
->entry_kind
== print_entry_values_compact
)
445 uiout
->field_stream ("name", stb
, variable_name_style
.style ());
446 annotate_arg_name_end ();
450 if (!arg
->val
&& !arg
->error
)
456 stb
.printf (_("<error reading variable: %s>"), arg
->error
.get ());
457 style
= metadata_style
.style ();
463 const struct language_defn
*language
;
464 struct value_print_options vp_opts
;
466 /* Avoid value_print because it will deref ref parameters. We
467 just want to print their addresses. Print ??? for args whose
468 address we do not know. We pass 2 as "recurse" to val_print
469 because our standard indentation here is 4 spaces, and
470 val_print indents 2 for each recurse. */
472 annotate_arg_value (value_type (arg
->val
));
474 /* Use the appropriate language to display our symbol, unless the
475 user forced the language to a specific language. */
476 if (language_mode
== language_mode_auto
)
477 language
= language_def (arg
->sym
->language ());
479 language
= current_language
;
481 get_no_prettyformat_print_options (&vp_opts
);
482 vp_opts
.deref_ref
= 1;
483 vp_opts
.raw
= fp_opts
.print_raw_frame_arguments
;
485 /* True in "summary" mode, false otherwise. */
487 = fp_opts
.print_frame_arguments
== print_frame_arguments_scalars
;
489 common_val_print_checked (arg
->val
, &stb
, 2, &vp_opts
, language
);
491 catch (const gdb_exception_error
&except
)
493 stb
.printf (_("<error reading variable: %s>"),
495 style
= metadata_style
.style ();
500 uiout
->field_stream ("value", stb
, style
);
503 /* Read in inferior function local SYM at FRAME into ARGP. Caller is
504 responsible for xfree of ARGP->ERROR. This function never throws an
508 read_frame_local (struct symbol
*sym
, frame_info_ptr frame
,
509 struct frame_arg
*argp
)
517 argp
->val
= read_var_value (sym
, NULL
, frame
);
519 catch (const gdb_exception_error
&except
)
521 argp
->error
.reset (xstrdup (except
.what ()));
525 /* Read in inferior function parameter SYM at FRAME into ARGP. This
526 function never throws an exception. */
529 read_frame_arg (const frame_print_options
&fp_opts
,
530 symbol
*sym
, frame_info_ptr frame
,
531 struct frame_arg
*argp
, struct frame_arg
*entryargp
)
533 struct value
*val
= NULL
, *entryval
= NULL
;
534 char *val_error
= NULL
, *entryval_error
= NULL
;
537 if (fp_opts
.print_entry_values
!= print_entry_values_only
538 && fp_opts
.print_entry_values
!= print_entry_values_preferred
)
542 val
= read_var_value (sym
, NULL
, frame
);
544 catch (const gdb_exception_error
&except
)
546 val_error
= (char *) alloca (except
.message
->size () + 1);
547 strcpy (val_error
, except
.what ());
551 if (SYMBOL_COMPUTED_OPS (sym
) != NULL
552 && SYMBOL_COMPUTED_OPS (sym
)->read_variable_at_entry
!= NULL
553 && fp_opts
.print_entry_values
!= print_entry_values_no
554 && (fp_opts
.print_entry_values
!= print_entry_values_if_needed
555 || !val
|| value_optimized_out (val
)))
559 const struct symbol_computed_ops
*ops
;
561 ops
= SYMBOL_COMPUTED_OPS (sym
);
562 entryval
= ops
->read_variable_at_entry (sym
, frame
);
564 catch (const gdb_exception_error
&except
)
566 if (except
.error
!= NO_ENTRY_VALUE_ERROR
)
568 entryval_error
= (char *) alloca (except
.message
->size () + 1);
569 strcpy (entryval_error
, except
.what ());
573 if (entryval
!= NULL
&& value_optimized_out (entryval
))
576 if (fp_opts
.print_entry_values
== print_entry_values_compact
577 || fp_opts
.print_entry_values
== print_entry_values_default
)
579 /* For MI do not try to use print_entry_values_compact for ARGP. */
581 if (val
&& entryval
&& !current_uiout
->is_mi_like_p ())
583 struct type
*type
= value_type (val
);
585 if (value_lazy (val
))
586 value_fetch_lazy (val
);
587 if (value_lazy (entryval
))
588 value_fetch_lazy (entryval
);
590 if (value_contents_eq (val
, 0, entryval
, 0, type
->length ()))
592 /* Initialize it just to avoid a GCC false warning. */
593 struct value
*val_deref
= NULL
, *entryval_deref
;
595 /* DW_AT_call_value does match with the current
596 value. If it is a reference still try to verify if
597 dereferenced DW_AT_call_data_value does not differ. */
601 struct type
*type_deref
;
603 val_deref
= coerce_ref (val
);
604 if (value_lazy (val_deref
))
605 value_fetch_lazy (val_deref
);
606 type_deref
= value_type (val_deref
);
608 entryval_deref
= coerce_ref (entryval
);
609 if (value_lazy (entryval_deref
))
610 value_fetch_lazy (entryval_deref
);
612 /* If the reference addresses match but dereferenced
613 content does not match print them. */
615 && value_contents_eq (val_deref
, 0,
617 type_deref
->length ()))
620 catch (const gdb_exception_error
&except
)
622 /* If the dereferenced content could not be
623 fetched do not display anything. */
624 if (except
.error
== NO_ENTRY_VALUE_ERROR
)
626 else if (except
.message
!= NULL
)
629 = (char *) alloca (except
.message
->size () + 1);
630 strcpy (entryval_error
, except
.what ());
634 /* Value was not a reference; and its content matches. */
635 if (val
== val_deref
)
643 /* Try to remove possibly duplicate error message for ENTRYARGP even
646 if (val_error
&& entryval_error
647 && strcmp (val_error
, entryval_error
) == 0)
649 entryval_error
= NULL
;
651 /* Do not se VAL_EQUAL as the same error message may be shown for
652 the entry value even if no entry values are present in the
658 if (entryval
== NULL
)
660 if (fp_opts
.print_entry_values
== print_entry_values_preferred
)
662 gdb_assert (val
== NULL
);
666 val
= read_var_value (sym
, NULL
, frame
);
668 catch (const gdb_exception_error
&except
)
670 val_error
= (char *) alloca (except
.message
->size () + 1);
671 strcpy (val_error
, except
.what ());
674 if (fp_opts
.print_entry_values
== print_entry_values_only
675 || fp_opts
.print_entry_values
== print_entry_values_both
676 || (fp_opts
.print_entry_values
== print_entry_values_preferred
677 && (!val
|| value_optimized_out (val
))))
679 entryval
= allocate_optimized_out_value (sym
->type ());
680 entryval_error
= NULL
;
683 if ((fp_opts
.print_entry_values
== print_entry_values_compact
684 || fp_opts
.print_entry_values
== print_entry_values_if_needed
685 || fp_opts
.print_entry_values
== print_entry_values_preferred
)
686 && (!val
|| value_optimized_out (val
)) && entryval
!= NULL
)
694 argp
->error
.reset (val_error
? xstrdup (val_error
) : NULL
);
695 if (!val
&& !val_error
)
696 argp
->entry_kind
= print_entry_values_only
;
697 else if ((fp_opts
.print_entry_values
== print_entry_values_compact
698 || fp_opts
.print_entry_values
== print_entry_values_default
)
701 argp
->entry_kind
= print_entry_values_compact
;
702 gdb_assert (!current_uiout
->is_mi_like_p ());
705 argp
->entry_kind
= print_entry_values_no
;
707 entryargp
->sym
= sym
;
708 entryargp
->val
= entryval
;
709 entryargp
->error
.reset (entryval_error
? xstrdup (entryval_error
) : NULL
);
710 if (!entryval
&& !entryval_error
)
711 entryargp
->entry_kind
= print_entry_values_no
;
713 entryargp
->entry_kind
= print_entry_values_only
;
716 /* Print the arguments of frame FRAME on STREAM, given the function
717 FUNC running in that frame (as a symbol), where NUM is the number
718 of arguments according to the stack frame (or -1 if the number of
719 arguments is unknown). */
721 /* Note that currently the "number of arguments according to the
722 stack frame" is only known on VAX where i refers to the "number of
723 ints of arguments according to the stack frame". */
726 print_frame_args (const frame_print_options
&fp_opts
,
727 struct symbol
*func
, frame_info_ptr frame
,
728 int num
, struct ui_file
*stream
)
730 struct ui_out
*uiout
= current_uiout
;
732 /* Offset of next stack argument beyond the one we have seen that is
733 at the highest offset, or -1 if we haven't come to a stack
735 long highest_offset
= -1;
736 /* Number of ints of arguments that we have printed so far. */
737 int args_printed
= 0;
738 /* True if we should print arg names. If false, we only indicate
739 the presence of arguments by printing ellipsis. */
741 = fp_opts
.print_frame_arguments
!= print_frame_arguments_presence
;
742 /* True if we should print arguments, false otherwise. */
745 && fp_opts
.print_frame_arguments
!= print_frame_arguments_none
);
747 /* If one of the arguments has a pretty printer that calls a
748 function of the inferior to print it, the pointer must be
750 frame
.prepare_reinflate ();
752 /* Temporarily change the selected frame to the given FRAME.
753 This allows routines that rely on the selected frame instead
754 of being given a frame as parameter to use the correct frame. */
755 scoped_restore_selected_frame restore_selected_frame
;
756 select_frame (frame
);
760 const struct block
*b
= func
->value_block ();
761 struct block_iterator iter
;
764 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
766 struct frame_arg arg
, entryarg
;
770 /* Keep track of the highest stack argument offset seen, and
771 skip over any kinds of symbols we don't care about. */
773 if (!sym
->is_argument ())
783 switch (sym
->aclass ())
788 long current_offset
= sym
->value_longest ();
789 int arg_size
= sym
->type ()->length ();
791 /* Compute address of next argument by adding the size of
792 this argument and rounding to an int boundary. */
794 ((current_offset
+ arg_size
+ sizeof (int) - 1)
795 & ~(sizeof (int) - 1));
797 /* If this is the highest offset seen yet, set
799 if (highest_offset
== -1
800 || (current_offset
> highest_offset
))
801 highest_offset
= current_offset
;
803 /* Add the number of ints we're about to print to
805 args_printed
+= (arg_size
+ sizeof (int) - 1) / sizeof (int);
808 /* We care about types of symbols, but don't need to
809 keep track of stack offsets in them. */
811 case LOC_REGPARM_ADDR
:
813 case LOC_OPTIMIZED_OUT
:
818 /* We have to look up the symbol because arguments can have
819 two entries (one a parameter, one a local) and the one we
820 want is the local, which lookup_symbol will find for us.
821 This includes gcc1 (not gcc2) on SPARC when passing a
822 small structure and gcc2 when the argument type is float
823 and it is passed as a double and converted to float by
824 the prologue (in the latter case the type of the LOC_ARG
825 symbol is double and the type of the LOC_LOCAL symbol is
827 /* But if the parameter name is null, don't try it. Null
828 parameter names occur on the RS/6000, for traceback
829 tables. FIXME, should we even print them? */
831 if (*sym
->linkage_name ())
835 nsym
= lookup_symbol_search_name (sym
->search_name (),
836 b
, VAR_DOMAIN
).symbol
;
837 gdb_assert (nsym
!= NULL
);
838 if (nsym
->aclass () == LOC_REGISTER
839 && !nsym
->is_argument ())
841 /* There is a LOC_ARG/LOC_REGISTER pair. This means
842 that it was passed on the stack and loaded into a
843 register, or passed in a register and stored in a
844 stack slot. GDB 3.x used the LOC_ARG; GDB
845 4.0-4.11 used the LOC_REGISTER.
847 Reasons for using the LOC_ARG:
849 (1) Because find_saved_registers may be slow for
852 (2) Because registers are often re-used and stack
853 slots rarely (never?) are. Therefore using
854 the stack slot is much less likely to print
857 Reasons why we might want to use the LOC_REGISTER:
859 (1) So that the backtrace prints the same value
860 as "print foo". I see no compelling reason
861 why this needs to be the case; having the
862 backtrace print the value which was passed
863 in, and "print foo" print the value as
864 modified within the called function, makes
867 Additional note: It might be nice if "info args"
868 displayed both values.
870 One more note: There is a case with SPARC
871 structure passing where we need to use the
872 LOC_REGISTER, but this is dealt with by creating
873 a single LOC_REGPARM in symbol reading. */
875 /* Leave sym (the LOC_ARG) alone. */
882 /* Print the current arg. */
885 uiout
->wrap_hint (4);
890 arg
.entry_kind
= print_entry_values_no
;
892 entryarg
.entry_kind
= print_entry_values_no
;
895 read_frame_arg (fp_opts
, sym
, frame
, &arg
, &entryarg
);
897 if (arg
.entry_kind
!= print_entry_values_only
)
898 print_frame_arg (fp_opts
, &arg
);
900 if (entryarg
.entry_kind
!= print_entry_values_no
)
902 if (arg
.entry_kind
!= print_entry_values_only
)
905 uiout
->wrap_hint (4);
908 print_frame_arg (fp_opts
, &entryarg
);
916 /* Don't print nameless args in situations where we don't know
917 enough about the stack to find them. */
922 if (highest_offset
== -1)
923 start
= gdbarch_frame_args_skip (get_frame_arch (frame
));
925 start
= highest_offset
;
927 if (!print_names
&& !first
&& num
> 0)
930 print_frame_nameless_args (frame
, start
, num
- args_printed
,
935 /* Set the current source and line to the location given by frame
936 FRAME, if possible. When CENTER is true, adjust so the relevant
937 line is in the center of the next 'list'. */
940 set_current_sal_from_frame (frame_info_ptr frame
)
942 symtab_and_line sal
= find_frame_sal (frame
);
943 if (sal
.symtab
!= NULL
)
944 set_current_source_symtab_and_line (sal
);
947 /* If ON, GDB will display disassembly of the next source line when
948 execution of the program being debugged stops.
949 If AUTO (which is the default), or there's no line info to determine
950 the source line of the next instruction, display disassembly of next
951 instruction instead. */
953 static enum auto_boolean disassemble_next_line
;
956 show_disassemble_next_line (struct ui_file
*file
, int from_tty
,
957 struct cmd_list_element
*c
,
961 _("Debugger's willingness to use "
962 "disassemble-next-line is %s.\n"),
966 /* Use TRY_CATCH to catch the exception from the gdb_disassembly
967 because it will be broken by filter sometime. */
970 do_gdb_disassembly (struct gdbarch
*gdbarch
,
971 int how_many
, CORE_ADDR low
, CORE_ADDR high
)
976 gdb_disassembly (gdbarch
, current_uiout
,
977 DISASSEMBLY_RAW_INSN
, how_many
,
980 catch (const gdb_exception_error
&exception
)
982 /* If an exception was thrown while doing the disassembly, print
983 the error message, to give the user a clue of what happened. */
984 exception_print (gdb_stderr
, exception
);
988 /* Converts the PRINT_FRAME_INFO choice to an optional enum print_what.
989 Value not present indicates to the caller to use default values
990 specific to the command being executed. */
992 static gdb::optional
<enum print_what
>
993 print_frame_info_to_print_what (const char *print_frame_info
)
995 for (int i
= 0; print_frame_info_choices
[i
] != NULL
; i
++)
996 if (print_frame_info
== print_frame_info_choices
[i
])
997 return print_frame_info_print_what
[i
];
999 internal_error ("Unexpected print frame-info value `%s'.",
1003 /* Print the PC from FRAME, plus any flags, to UIOUT. */
1006 print_pc (struct ui_out
*uiout
, struct gdbarch
*gdbarch
, frame_info_ptr frame
,
1009 uiout
->field_core_addr ("addr", gdbarch
, pc
);
1011 std::string flags
= gdbarch_get_pc_address_flags (gdbarch
, frame
, pc
);
1012 if (!flags
.empty ())
1015 uiout
->field_string ("addr_flags", flags
);
1023 get_user_print_what_frame_info (gdb::optional
<enum print_what
> *what
)
1026 = print_frame_info_to_print_what
1027 (user_frame_print_options
.print_frame_info
);
1030 /* Print information about frame FRAME. The output is format according
1031 to PRINT_LEVEL and PRINT_WHAT and PRINT_ARGS. For the meaning of
1032 PRINT_WHAT, see enum print_what comments in frame.h.
1033 Note that PRINT_WHAT is overridden if FP_OPTS.print_frame_info
1034 != print_frame_info_auto.
1036 Used in "where" output, and to emit breakpoint or step
1040 print_frame_info (const frame_print_options
&fp_opts
,
1041 frame_info_ptr frame
, int print_level
,
1042 enum print_what print_what
, int print_args
,
1043 int set_current_sal
)
1045 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1048 struct ui_out
*uiout
= current_uiout
;
1050 if (!current_uiout
->is_mi_like_p ()
1051 && fp_opts
.print_frame_info
!= print_frame_info_auto
)
1053 /* Use the specific frame information desired by the user. */
1054 print_what
= *print_frame_info_to_print_what (fp_opts
.print_frame_info
);
1057 if (get_frame_type (frame
) == DUMMY_FRAME
1058 || get_frame_type (frame
) == SIGTRAMP_FRAME
1059 || get_frame_type (frame
) == ARCH_FRAME
)
1061 ui_out_emit_tuple
tuple_emitter (uiout
, "frame");
1063 annotate_frame_begin (print_level
? frame_relative_level (frame
) : 0,
1064 gdbarch
, get_frame_pc (frame
));
1066 /* Do this regardless of SOURCE because we don't have any source
1067 to list for this frame. */
1071 uiout
->field_fmt_signed (2, ui_left
, "level",
1072 frame_relative_level (frame
));
1074 if (uiout
->is_mi_like_p ())
1076 annotate_frame_address ();
1077 print_pc (uiout
, gdbarch
, frame
, get_frame_pc (frame
));
1078 annotate_frame_address_end ();
1081 if (get_frame_type (frame
) == DUMMY_FRAME
)
1083 annotate_function_call ();
1084 uiout
->field_string ("func", "<function called from gdb>",
1085 metadata_style
.style ());
1087 else if (get_frame_type (frame
) == SIGTRAMP_FRAME
)
1089 annotate_signal_handler_caller ();
1090 uiout
->field_string ("func", "<signal handler called>",
1091 metadata_style
.style ());
1093 else if (get_frame_type (frame
) == ARCH_FRAME
)
1095 uiout
->field_string ("func", "<cross-architecture call>",
1096 metadata_style
.style ());
1099 annotate_frame_end ();
1101 /* If disassemble-next-line is set to auto or on output the next
1103 if (disassemble_next_line
== AUTO_BOOLEAN_AUTO
1104 || disassemble_next_line
== AUTO_BOOLEAN_TRUE
)
1105 do_gdb_disassembly (get_frame_arch (frame
), 1,
1106 get_frame_pc (frame
), get_frame_pc (frame
) + 1);
1111 /* If FRAME is not the innermost frame, that normally means that
1112 FRAME->pc points to *after* the call instruction, and we want to
1113 get the line containing the call, never the next line. But if
1114 the next frame is a SIGTRAMP_FRAME or a DUMMY_FRAME, then the
1115 next frame was not entered as the result of a call, and we want
1116 to get the line containing FRAME->pc. */
1117 symtab_and_line sal
= find_frame_sal (frame
);
1119 location_print
= (print_what
== LOCATION
1120 || print_what
== SRC_AND_LOC
1121 || print_what
== LOC_AND_ADDRESS
1122 || print_what
== SHORT_LOCATION
);
1123 if (location_print
|| !sal
.symtab
)
1124 print_frame (fp_opts
, frame
, print_level
, print_what
, print_args
, sal
);
1126 source_print
= (print_what
== SRC_LINE
|| print_what
== SRC_AND_LOC
);
1128 /* If disassemble-next-line is set to auto or on and doesn't have
1129 the line debug messages for $pc, output the next instruction. */
1130 if ((disassemble_next_line
== AUTO_BOOLEAN_AUTO
1131 || disassemble_next_line
== AUTO_BOOLEAN_TRUE
)
1132 && source_print
&& !sal
.symtab
)
1133 do_gdb_disassembly (get_frame_arch (frame
), 1,
1134 get_frame_pc (frame
), get_frame_pc (frame
) + 1);
1136 if (source_print
&& sal
.symtab
)
1138 int mid_statement
= ((print_what
== SRC_LINE
)
1139 && frame_show_address (frame
, sal
));
1140 if (annotation_level
> 0
1141 && annotate_source_line (sal
.symtab
, sal
.line
, mid_statement
,
1142 get_frame_pc (frame
)))
1144 /* The call to ANNOTATE_SOURCE_LINE already printed the
1145 annotation for this source line, so we avoid the two cases
1146 below and do not print the actual source line. The
1147 documentation for annotations makes it clear that the source
1148 line annotation is printed __instead__ of printing the source
1149 line, not as well as.
1151 However, if we fail to print the source line, which usually
1152 means either the source file is missing, or the requested
1153 line is out of range of the file, then we don't print the
1154 source annotation, and will pass through the "normal" print
1155 source line code below, the expectation is that this code
1156 will print an appropriate error. */
1158 else if (deprecated_print_frame_info_listing_hook
)
1159 deprecated_print_frame_info_listing_hook (sal
.symtab
, sal
.line
,
1163 struct value_print_options opts
;
1165 get_user_print_options (&opts
);
1166 /* We used to do this earlier, but that is clearly
1167 wrong. This function is used by many different
1168 parts of gdb, including normal_stop in infrun.c,
1169 which uses this to print out the current PC
1170 when we stepi/nexti into the middle of a source
1171 line. Only the command line really wants this
1172 behavior. Other UIs probably would like the
1173 ability to decide for themselves if it is desired. */
1174 if (opts
.addressprint
&& mid_statement
)
1176 print_pc (uiout
, gdbarch
, frame
, get_frame_pc (frame
));
1180 print_source_lines (sal
.symtab
, sal
.line
, sal
.line
+ 1, 0);
1184 /* If disassemble-next-line is set to on and there is line debug
1185 messages, output assembly codes for next line. */
1186 if (disassemble_next_line
== AUTO_BOOLEAN_TRUE
)
1187 do_gdb_disassembly (get_frame_arch (frame
), -1, sal
.pc
, sal
.end
);
1190 if (set_current_sal
)
1194 if (get_frame_pc_if_available (frame
, &pc
))
1195 last_displayed_symtab_info
.set (sal
.pspace
, pc
, sal
.symtab
, sal
.line
);
1197 last_displayed_symtab_info
.invalidate ();
1200 annotate_frame_end ();
1202 gdb_flush (gdb_stdout
);
1208 clear_last_displayed_sal (void)
1210 last_displayed_symtab_info
.invalidate ();
1216 last_displayed_sal_is_valid (void)
1218 return last_displayed_symtab_info
.is_valid ();
1223 struct program_space
*
1224 get_last_displayed_pspace (void)
1226 return last_displayed_symtab_info
.pspace ();
1232 get_last_displayed_addr (void)
1234 return last_displayed_symtab_info
.address ();
1240 get_last_displayed_symtab (void)
1242 return last_displayed_symtab_info
.symtab ();
1248 get_last_displayed_line (void)
1250 return last_displayed_symtab_info
.line ();
1256 get_last_displayed_sal ()
1258 symtab_and_line sal
;
1260 if (last_displayed_symtab_info
.is_valid ())
1262 sal
.pspace
= last_displayed_symtab_info
.pspace ();
1263 sal
.pc
= last_displayed_symtab_info
.address ();
1264 sal
.symtab
= last_displayed_symtab_info
.symtab ();
1265 sal
.line
= last_displayed_symtab_info
.line ();
1272 /* Attempt to obtain the name, FUNLANG and optionally FUNCP of the function
1273 corresponding to FRAME. */
1275 gdb::unique_xmalloc_ptr
<char>
1276 find_frame_funname (frame_info_ptr frame
, enum language
*funlang
,
1277 struct symbol
**funcp
)
1279 struct symbol
*func
;
1280 gdb::unique_xmalloc_ptr
<char> funname
;
1282 *funlang
= language_unknown
;
1286 func
= get_frame_function (frame
);
1289 const char *print_name
= func
->print_name ();
1291 *funlang
= func
->language ();
1294 if (*funlang
== language_cplus
)
1296 /* It seems appropriate to use print_name() here,
1297 to display the demangled name that we already have
1298 stored in the symbol table, but we stored a version
1299 with DMGL_PARAMS turned on, and here we don't want to
1300 display parameters. So remove the parameters. */
1301 funname
= cp_remove_params (print_name
);
1304 /* If we didn't hit the C++ case above, set *funname
1306 if (funname
== NULL
)
1307 funname
.reset (xstrdup (print_name
));
1311 struct bound_minimal_symbol msymbol
;
1314 if (!get_frame_address_in_block_if_available (frame
, &pc
))
1317 msymbol
= lookup_minimal_symbol_by_pc (pc
);
1318 if (msymbol
.minsym
!= NULL
)
1320 funname
.reset (xstrdup (msymbol
.minsym
->print_name ()));
1321 *funlang
= msymbol
.minsym
->language ();
1329 print_frame (const frame_print_options
&fp_opts
,
1330 frame_info_ptr frame
, int print_level
,
1331 enum print_what print_what
, int print_args
,
1332 struct symtab_and_line sal
)
1334 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1335 struct ui_out
*uiout
= current_uiout
;
1336 enum language funlang
= language_unknown
;
1337 struct value_print_options opts
;
1338 struct symbol
*func
;
1342 pc_p
= get_frame_pc_if_available (frame
, &pc
);
1344 gdb::unique_xmalloc_ptr
<char> funname
1345 = find_frame_funname (frame
, &funlang
, &func
);
1347 annotate_frame_begin (print_level
? frame_relative_level (frame
) : 0,
1351 ui_out_emit_tuple
tuple_emitter (uiout
, "frame");
1356 uiout
->field_fmt_signed (2, ui_left
, "level",
1357 frame_relative_level (frame
));
1359 get_user_print_options (&opts
);
1360 if (opts
.addressprint
)
1362 || frame_show_address (frame
, sal
)
1363 || print_what
== LOC_AND_ADDRESS
)
1365 annotate_frame_address ();
1367 print_pc (uiout
, gdbarch
, frame
, pc
);
1369 uiout
->field_string ("addr", "<unavailable>",
1370 metadata_style
.style ());
1371 annotate_frame_address_end ();
1372 uiout
->text (" in ");
1374 annotate_frame_function_name ();
1377 gdb_puts (funname
? funname
.get () : "??", &stb
);
1378 uiout
->field_stream ("func", stb
, function_name_style
.style ());
1379 uiout
->wrap_hint (3);
1380 annotate_frame_args ();
1387 if (gdbarch_frame_num_args_p (gdbarch
))
1389 numargs
= gdbarch_frame_num_args (gdbarch
, frame
);
1390 gdb_assert (numargs
>= 0);
1396 ui_out_emit_list
list_emitter (uiout
, "args");
1399 print_frame_args (fp_opts
, func
, frame
, numargs
, gdb_stdout
);
1401 catch (const gdb_exception_error
&e
)
1405 /* FIXME: ARGS must be a list. If one argument is a string it
1406 will have " that will not be properly escaped. */
1411 if (print_what
!= SHORT_LOCATION
&& sal
.symtab
)
1413 const char *filename_display
;
1415 filename_display
= symtab_to_filename_for_display (sal
.symtab
);
1416 annotate_frame_source_begin ();
1417 uiout
->wrap_hint (3);
1418 uiout
->text (" at ");
1419 annotate_frame_source_file ();
1420 uiout
->field_string ("file", filename_display
,
1421 file_name_style
.style ());
1422 if (uiout
->is_mi_like_p ())
1424 const char *fullname
= symtab_to_fullname (sal
.symtab
);
1426 uiout
->field_string ("fullname", fullname
);
1428 annotate_frame_source_file_end ();
1430 annotate_frame_source_line ();
1431 uiout
->field_signed ("line", sal
.line
);
1432 annotate_frame_source_end ();
1435 if (print_what
!= SHORT_LOCATION
1436 && pc_p
&& (funname
== NULL
|| sal
.symtab
== NULL
))
1439 = solib_name_from_address (get_frame_program_space (frame
),
1440 get_frame_pc (frame
));
1444 annotate_frame_where ();
1445 uiout
->wrap_hint (2);
1446 uiout
->text (" from ");
1447 uiout
->field_string ("from", lib
, file_name_style
.style ());
1450 if (uiout
->is_mi_like_p ())
1451 uiout
->field_string ("arch",
1452 (gdbarch_bfd_arch_info (gdbarch
))->printable_name
);
1459 /* Completion function for "frame function", "info frame function", and
1460 "select-frame function" commands. */
1463 frame_selection_by_function_completer (struct cmd_list_element
*ignore
,
1464 completion_tracker
&tracker
,
1465 const char *text
, const char *word
)
1467 /* This is used to complete function names within a stack. It would be
1468 nice if we only offered functions that were actually in the stack.
1469 However, this would mean unwinding the stack to completion, which
1470 could take too long, or on a corrupted stack, possibly not end.
1471 Instead, we offer all symbol names as a safer choice. */
1472 collect_symbol_completion_matches (tracker
,
1473 complete_symbol_mode::EXPRESSION
,
1474 symbol_name_match_type::EXPRESSION
,
1478 /* Core of all the "info frame" sub-commands. Print information about a
1479 frame FI. If SELECTED_FRAME_P is true then the user didn't provide a
1480 frame specification, they just entered 'info frame'. If the user did
1481 provide a frame specification (for example 'info frame 0', 'info frame
1482 level 1') then SELECTED_FRAME_P will be false. */
1485 info_frame_command_core (frame_info_ptr fi
, bool selected_frame_p
)
1487 struct symbol
*func
;
1489 frame_info_ptr calling_frame_info
;
1491 const char *funname
= 0;
1492 enum language funlang
= language_unknown
;
1493 const char *pc_regname
;
1494 struct gdbarch
*gdbarch
;
1497 /* Initialize it to avoid "may be used uninitialized" warning. */
1498 CORE_ADDR caller_pc
= 0;
1499 int caller_pc_p
= 0;
1501 gdbarch
= get_frame_arch (fi
);
1503 /* Name of the value returned by get_frame_pc(). Per comments, "pc"
1504 is not a good name. */
1505 if (gdbarch_pc_regnum (gdbarch
) >= 0)
1506 /* OK, this is weird. The gdbarch_pc_regnum hardware register's value can
1507 easily not match that of the internal value returned by
1509 pc_regname
= gdbarch_register_name (gdbarch
, gdbarch_pc_regnum (gdbarch
));
1511 /* But then, this is weird to. Even without gdbarch_pc_regnum, an
1512 architectures will often have a hardware register called "pc",
1513 and that register's value, again, can easily not match
1517 frame_pc_p
= get_frame_pc_if_available (fi
, &frame_pc
);
1518 func
= get_frame_function (fi
);
1519 symtab_and_line sal
= find_frame_sal (fi
);
1521 gdb::unique_xmalloc_ptr
<char> func_only
;
1524 funname
= func
->print_name ();
1525 funlang
= func
->language ();
1526 if (funlang
== language_cplus
)
1528 /* It seems appropriate to use print_name() here,
1529 to display the demangled name that we already have
1530 stored in the symbol table, but we stored a version
1531 with DMGL_PARAMS turned on, and here we don't want to
1532 display parameters. So remove the parameters. */
1533 func_only
= cp_remove_params (funname
);
1536 funname
= func_only
.get ();
1539 else if (frame_pc_p
)
1541 struct bound_minimal_symbol msymbol
;
1543 msymbol
= lookup_minimal_symbol_by_pc (frame_pc
);
1544 if (msymbol
.minsym
!= NULL
)
1546 funname
= msymbol
.minsym
->print_name ();
1547 funlang
= msymbol
.minsym
->language ();
1550 calling_frame_info
= get_prev_frame (fi
);
1552 if (selected_frame_p
&& frame_relative_level (fi
) >= 0)
1554 gdb_printf (_("Stack level %d, frame at "),
1555 frame_relative_level (fi
));
1559 gdb_printf (_("Stack frame at "));
1561 gdb_puts (paddress (gdbarch
, get_frame_base (fi
)));
1563 gdb_printf (" %s = ", pc_regname
);
1565 gdb_puts (paddress (gdbarch
, get_frame_pc (fi
)));
1567 fputs_styled ("<unavailable>", metadata_style
.style (), gdb_stdout
);
1569 gdb_stdout
->wrap_here (3);
1572 gdb_printf (" in ");
1575 gdb_stdout
->wrap_here (3);
1579 styled_string (file_name_style
.style (),
1580 symtab_to_filename_for_display (sal
.symtab
)),
1583 gdb_stdout
->wrap_here (4);
1584 gdb_printf ("saved %s = ", pc_regname
);
1586 if (!frame_id_p (frame_unwind_caller_id (fi
)))
1587 val_print_not_saved (gdb_stdout
);
1592 caller_pc
= frame_unwind_caller_pc (fi
);
1595 catch (const gdb_exception_error
&ex
)
1599 case NOT_AVAILABLE_ERROR
:
1600 val_print_unavailable (gdb_stdout
);
1602 case OPTIMIZED_OUT_ERROR
:
1603 val_print_not_saved (gdb_stdout
);
1606 fprintf_styled (gdb_stdout
, metadata_style
.style (),
1615 gdb_puts (paddress (gdbarch
, caller_pc
));
1618 if (calling_frame_info
== NULL
)
1620 enum unwind_stop_reason reason
;
1622 reason
= get_frame_unwind_stop_reason (fi
);
1623 if (reason
!= UNWIND_NO_REASON
)
1624 gdb_printf (_(" Outermost frame: %s\n"),
1625 frame_stop_reason_string (fi
));
1627 else if (get_frame_type (fi
) == TAILCALL_FRAME
)
1628 gdb_puts (" tail call frame");
1629 else if (get_frame_type (fi
) == INLINE_FRAME
)
1630 gdb_printf (" inlined into frame %d",
1631 frame_relative_level (get_prev_frame (fi
)));
1634 gdb_printf (" called by frame at ");
1635 gdb_puts (paddress (gdbarch
, get_frame_base (calling_frame_info
)));
1637 if (get_next_frame (fi
) && calling_frame_info
)
1639 gdb_stdout
->wrap_here (3);
1640 if (get_next_frame (fi
))
1642 gdb_printf (" caller of frame at ");
1643 gdb_puts (paddress (gdbarch
, get_frame_base (get_next_frame (fi
))));
1645 if (get_next_frame (fi
) || calling_frame_info
)
1649 gdb_printf (" source language %s.\n",
1650 language_str (s
->language ()));
1653 /* Address of the argument list for this frame, or 0. */
1654 CORE_ADDR arg_list
= get_frame_args_address (fi
);
1655 /* Number of args for this frame, or -1 if unknown. */
1659 gdb_printf (" Arglist at unknown address.\n");
1662 gdb_printf (" Arglist at ");
1663 gdb_puts (paddress (gdbarch
, arg_list
));
1666 if (!gdbarch_frame_num_args_p (gdbarch
))
1669 gdb_puts (" args: ");
1673 numargs
= gdbarch_frame_num_args (gdbarch
, fi
);
1674 gdb_assert (numargs
>= 0);
1676 gdb_puts (" no args.");
1677 else if (numargs
== 1)
1678 gdb_puts (" 1 arg: ");
1680 gdb_printf (" %d args: ", numargs
);
1683 fi
.prepare_reinflate ();
1684 print_frame_args (user_frame_print_options
,
1685 func
, fi
, numargs
, gdb_stdout
);
1692 /* Address of the local variables for this frame, or 0. */
1693 CORE_ADDR arg_list
= get_frame_locals_address (fi
);
1696 gdb_printf (" Locals at unknown address,");
1699 gdb_printf (" Locals at ");
1700 gdb_puts (paddress (gdbarch
, arg_list
));
1705 /* Print as much information as possible on the location of all the
1711 int sp_regnum
= gdbarch_sp_regnum (gdbarch
);
1713 /* The sp is special; what's displayed isn't the save address, but
1714 the value of the previous frame's sp. This is a legacy thing,
1715 at one stage the frame cached the previous frame's SP instead
1716 of its address, hence it was easiest to just display the cached
1720 struct value
*value
= frame_unwind_register_value (fi
, sp_regnum
);
1721 gdb_assert (value
!= NULL
);
1723 if (!value_optimized_out (value
) && value_entirely_available (value
))
1725 if (VALUE_LVAL (value
) == not_lval
)
1728 enum bfd_endian byte_order
= gdbarch_byte_order (gdbarch
);
1729 int sp_size
= register_size (gdbarch
, sp_regnum
);
1731 sp
= extract_unsigned_integer
1732 (value_contents_all (value
).data (), sp_size
, byte_order
);
1734 gdb_printf (" Previous frame's sp is ");
1735 gdb_puts (paddress (gdbarch
, sp
));
1738 else if (VALUE_LVAL (value
) == lval_memory
)
1740 gdb_printf (" Previous frame's sp at ");
1741 gdb_puts (paddress (gdbarch
, value_address (value
)));
1744 else if (VALUE_LVAL (value
) == lval_register
)
1746 gdb_printf (" Previous frame's sp in %s\n",
1747 gdbarch_register_name (gdbarch
,
1748 VALUE_REGNUM (value
)));
1751 release_value (value
);
1754 /* else keep quiet. */
1758 numregs
= gdbarch_num_cooked_regs (gdbarch
);
1759 for (i
= 0; i
< numregs
; i
++)
1761 && gdbarch_register_reggroup_p (gdbarch
, i
, all_reggroup
))
1763 enum lval_type lval
;
1769 /* Find out the location of the saved register without
1770 fetching the corresponding value. */
1771 frame_register_unwind (fi
, i
, &optimized
, &unavailable
,
1772 &lval
, &addr
, &realnum
, NULL
);
1773 /* For moment, only display registers that were saved on the
1775 if (!optimized
&& !unavailable
&& lval
== lval_memory
)
1778 gdb_puts (" Saved registers:\n ");
1781 gdb_stdout
->wrap_here (1);
1782 gdb_printf (" %s at ",
1783 gdbarch_register_name (gdbarch
, i
));
1784 gdb_puts (paddress (gdbarch
, addr
));
1788 if (count
|| need_nl
)
1793 /* Return the innermost frame at level LEVEL. */
1795 static frame_info_ptr
1796 leading_innermost_frame (int level
)
1798 frame_info_ptr leading
;
1800 leading
= get_current_frame ();
1802 gdb_assert (level
>= 0);
1804 while (leading
!= nullptr && level
)
1807 leading
= get_prev_frame (leading
);
1814 /* Return the starting frame needed to handle COUNT outermost frames. */
1816 static frame_info_ptr
1817 trailing_outermost_frame (int count
)
1819 frame_info_ptr current
;
1820 frame_info_ptr trailing
;
1822 trailing
= get_current_frame ();
1824 gdb_assert (count
> 0);
1827 while (current
!= nullptr && count
--)
1830 current
= get_prev_frame (current
);
1833 /* Will stop when CURRENT reaches the top of the stack.
1834 TRAILING will be COUNT below it. */
1835 while (current
!= nullptr)
1838 trailing
= get_prev_frame (trailing
);
1839 current
= get_prev_frame (current
);
1845 /* The core of all the "select-frame" sub-commands. Just wraps a call to
1849 select_frame_command_core (frame_info_ptr fi
, bool ignored
)
1851 frame_info_ptr prev_frame
= get_selected_frame ();
1853 if (get_selected_frame () != prev_frame
)
1854 gdb::observers::user_selected_context_changed
.notify (USER_SELECTED_FRAME
);
1857 /* The core of all the "frame" sub-commands. Select frame FI, and if this
1858 means we change frame send out a change notification (otherwise, just
1859 reprint the current frame summary). */
1862 frame_command_core (frame_info_ptr fi
, bool ignored
)
1864 frame_info_ptr prev_frame
= get_selected_frame ();
1866 if (get_selected_frame () != prev_frame
)
1867 gdb::observers::user_selected_context_changed
.notify (USER_SELECTED_FRAME
);
1869 print_selected_thread_frame (current_uiout
, USER_SELECTED_FRAME
);
1872 /* The three commands 'frame', 'select-frame', and 'info frame' all have a
1873 common set of sub-commands that allow a specific frame to be selected.
1874 All of the sub-command functions are static methods within this class
1875 template which is then instantiated below. The template parameter is a
1876 callback used to implement the functionality of the base command
1877 ('frame', 'select-frame', or 'info frame').
1879 In the template parameter FI is the frame being selected. The
1880 SELECTED_FRAME_P flag is true if the frame being selected was done by
1881 default, which happens when the user uses the base command with no
1882 arguments. For example the commands 'info frame', 'select-frame',
1883 'frame' will all cause SELECTED_FRAME_P to be true. In all other cases
1884 SELECTED_FRAME_P is false. */
1886 template <void (*FPTR
) (frame_info_ptr fi
, bool selected_frame_p
)>
1887 class frame_command_helper
1891 /* The "frame level" family of commands. The ARG is an integer that is
1892 the frame's level in the stack. */
1894 level (const char *arg
, int from_tty
)
1896 int level
= value_as_long (parse_and_eval (arg
));
1898 = find_relative_frame (get_current_frame (), &level
);
1900 error (_("No frame at level %s."), arg
);
1904 /* The "frame address" family of commands. ARG is a stack-pointer
1905 address for an existing frame. This command does not allow new
1906 frames to be created. */
1909 address (const char *arg
, int from_tty
)
1911 CORE_ADDR addr
= value_as_address (parse_and_eval (arg
));
1912 frame_info_ptr fid
= find_frame_for_address (addr
);
1914 error (_("No frame at address %s."), arg
);
1918 /* The "frame view" family of commands. ARG is one or two addresses and
1919 is used to view a frame that might be outside the current backtrace.
1920 The addresses are stack-pointer address, and (optional) pc-address. */
1923 view (const char *args
, int from_tty
)
1928 error (_("Missing address argument to view a frame"));
1930 gdb_argv
argv (args
);
1932 if (argv
.count () == 2)
1936 addr
[0] = value_as_address (parse_and_eval (argv
[0]));
1937 addr
[1] = value_as_address (parse_and_eval (argv
[1]));
1938 fid
= create_new_frame (addr
[0], addr
[1]);
1942 CORE_ADDR addr
= value_as_address (parse_and_eval (argv
[0]));
1943 fid
= create_new_frame (addr
, false);
1948 /* The "frame function" family of commands. ARG is the name of a
1949 function within the stack, the first function (searching from frame
1950 0) with that name will be selected. */
1953 function (const char *arg
, int from_tty
)
1956 error (_("Missing function name argument"));
1957 frame_info_ptr fid
= find_frame_for_function (arg
);
1959 error (_("No frame for function \"%s\"."), arg
);
1963 /* The "frame" base command, that is, when no sub-command is specified.
1964 If one argument is provided then we assume that this is a frame's
1965 level as historically, this was the supported command syntax that was
1968 If no argument is provided, then the current frame is selected. */
1971 base_command (const char *arg
, int from_tty
)
1974 FPTR (get_selected_frame (_("No stack.")), true);
1976 level (arg
, from_tty
);
1980 /* Instantiate three FRAME_COMMAND_HELPER instances to implement the
1981 sub-commands for 'info frame', 'frame', and 'select-frame' commands. */
1983 static frame_command_helper
<info_frame_command_core
> info_frame_cmd
;
1984 static frame_command_helper
<frame_command_core
> frame_cmd
;
1985 static frame_command_helper
<select_frame_command_core
> select_frame_cmd
;
1987 /* Print briefly all stack frames or just the innermost COUNT_EXP
1991 backtrace_command_1 (const frame_print_options
&fp_opts
,
1992 const backtrace_cmd_options
&bt_opts
,
1993 const char *count_exp
, int from_tty
)
1998 int py_start
= 0, py_end
= 0;
1999 enum ext_lang_bt_status result
= EXT_LANG_BT_ERROR
;
2001 if (!target_has_stack ())
2002 error (_("No stack."));
2006 count
= parse_and_eval_long (count_exp
);
2012 /* The argument to apply_ext_lang_frame_filter is the number
2013 of the final frame to print, and frames start at 0. */
2023 frame_filter_flags flags
= 0;
2026 flags
|= PRINT_LOCALS
;
2028 flags
|= PRINT_HIDE
;
2030 if (!bt_opts
.no_filters
)
2032 enum ext_lang_frame_args arg_type
;
2034 flags
|= PRINT_LEVEL
| PRINT_FRAME_INFO
| PRINT_ARGS
;
2036 flags
|= PRINT_MORE_FRAMES
;
2038 if (fp_opts
.print_frame_arguments
== print_frame_arguments_scalars
)
2039 arg_type
= CLI_SCALAR_VALUES
;
2040 else if (fp_opts
.print_frame_arguments
== print_frame_arguments_all
)
2041 arg_type
= CLI_ALL_VALUES
;
2042 else if (fp_opts
.print_frame_arguments
== print_frame_arguments_presence
)
2043 arg_type
= CLI_PRESENCE
;
2044 else if (fp_opts
.print_frame_arguments
== print_frame_arguments_none
)
2045 arg_type
= NO_VALUES
;
2049 result
= apply_ext_lang_frame_filter (get_current_frame (), flags
,
2050 arg_type
, current_uiout
,
2054 /* Run the inbuilt backtrace if there are no filters registered, or
2055 "-no-filters" has been specified from the command. */
2056 if (bt_opts
.no_filters
|| result
== EXT_LANG_BT_NO_FILTERS
)
2058 frame_info_ptr trailing
;
2060 /* The following code must do two things. First, it must set the
2061 variable TRAILING to the frame from which we should start
2062 printing. Second, it must set the variable count to the number
2063 of frames which we should print, or -1 if all of them. */
2065 if (count_exp
!= NULL
&& count
< 0)
2067 trailing
= trailing_outermost_frame (-count
);
2071 trailing
= get_current_frame ();
2073 for (fi
= trailing
; fi
&& count
--; fi
= get_prev_frame (fi
))
2076 fi
.prepare_reinflate ();
2078 /* Don't use print_stack_frame; if an error() occurs it probably
2079 means further attempts to backtrace would fail (on the other
2080 hand, perhaps the code does or could be fixed to make sure
2081 the frame->prev field gets set to NULL in that case). */
2083 print_frame_info (fp_opts
, fi
, 1, LOCATION
, 1, 0);
2084 if ((flags
& PRINT_LOCALS
) != 0)
2085 print_frame_local_vars (fi
, false, NULL
, NULL
, 1, gdb_stdout
);
2087 /* Save the last frame to check for error conditions. */
2092 /* If we've stopped before the end, mention that. */
2094 gdb_printf (_("(More stack frames follow...)\n"));
2096 /* If we've run out of frames, and the reason appears to be an error
2097 condition, print it. */
2098 if (fi
== NULL
&& trailing
!= NULL
)
2100 enum unwind_stop_reason reason
;
2102 reason
= get_frame_unwind_stop_reason (trailing
);
2103 if (reason
>= UNWIND_FIRST_ERROR
)
2104 gdb_printf (_("Backtrace stopped: %s\n"),
2105 frame_stop_reason_string (trailing
));
2110 /* Create an option_def_group array grouping all the "backtrace"
2111 options, with FP_OPTS, BT_CMD_OPT, SET_BT_OPTS as contexts. */
2113 static inline std::array
<gdb::option::option_def_group
, 3>
2114 make_backtrace_options_def_group (frame_print_options
*fp_opts
,
2115 backtrace_cmd_options
*bt_cmd_opts
,
2116 set_backtrace_options
*set_bt_opts
)
2119 { {frame_print_option_defs
}, fp_opts
},
2120 { {set_backtrace_option_defs
}, set_bt_opts
},
2121 { {backtrace_command_option_defs
}, bt_cmd_opts
}
2125 /* Parse the backtrace command's qualifiers. Returns ARG advanced
2126 past the qualifiers, if any. BT_CMD_OPTS, if not null, is used to
2127 store the parsed qualifiers. */
2130 parse_backtrace_qualifiers (const char *arg
,
2131 backtrace_cmd_options
*bt_cmd_opts
= nullptr)
2135 const char *save_arg
= arg
;
2136 std::string this_arg
= extract_arg (&arg
);
2138 if (this_arg
.empty ())
2141 if (subset_compare (this_arg
.c_str (), "no-filters"))
2143 if (bt_cmd_opts
!= nullptr)
2144 bt_cmd_opts
->no_filters
= true;
2146 else if (subset_compare (this_arg
.c_str (), "full"))
2148 if (bt_cmd_opts
!= nullptr)
2149 bt_cmd_opts
->full
= true;
2151 else if (subset_compare (this_arg
.c_str (), "hide"))
2153 if (bt_cmd_opts
!= nullptr)
2154 bt_cmd_opts
->hide
= true;
2158 /* Not a recognized qualifier, so stop. */
2165 backtrace_command (const char *arg
, int from_tty
)
2167 frame_print_options fp_opts
= user_frame_print_options
;
2168 backtrace_cmd_options bt_cmd_opts
;
2169 set_backtrace_options set_bt_opts
= user_set_backtrace_options
;
2172 = make_backtrace_options_def_group (&fp_opts
, &bt_cmd_opts
, &set_bt_opts
);
2173 gdb::option::process_options
2174 (&arg
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
2176 /* Parse non-'-'-prefixed qualifiers, for backwards
2180 arg
= parse_backtrace_qualifiers (arg
, &bt_cmd_opts
);
2185 /* These options are handled quite deep in the unwind machinery, so
2186 we get to pass them down by swapping globals. */
2187 scoped_restore restore_set_backtrace_options
2188 = make_scoped_restore (&user_set_backtrace_options
, set_bt_opts
);
2190 backtrace_command_1 (fp_opts
, bt_cmd_opts
, arg
, from_tty
);
2193 /* Completer for the "backtrace" command. */
2196 backtrace_command_completer (struct cmd_list_element
*ignore
,
2197 completion_tracker
&tracker
,
2198 const char *text
, const char */
*word*/
)
2201 = make_backtrace_options_def_group (nullptr, nullptr, nullptr);
2202 if (gdb::option::complete_options
2203 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
2208 const char *p
= skip_to_space (text
);
2211 static const char *const backtrace_cmd_qualifier_choices
[] = {
2212 "full", "no-filters", "hide", nullptr,
2214 complete_on_enum (tracker
, backtrace_cmd_qualifier_choices
,
2217 if (tracker
.have_completions ())
2222 const char *cmd
= parse_backtrace_qualifiers (text
);
2223 tracker
.advance_custom_word_point_by (cmd
- text
);
2228 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
2229 expression_completer (ignore
, tracker
, text
, word
);
2232 /* Iterate over the local variables of a block B, calling CB. */
2235 iterate_over_block_locals (const struct block
*b
,
2236 iterate_over_block_arg_local_vars_cb cb
)
2238 struct block_iterator iter
;
2241 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
2243 switch (sym
->aclass ())
2250 case LOC_OPTIMIZED_OUT
:
2251 if (sym
->is_argument ())
2253 if (sym
->domain () == COMMON_BLOCK_DOMAIN
)
2255 cb (sym
->print_name (), sym
);
2259 /* Ignore symbols which are not locals. */
2265 /* Iterate over all the local variables in block B, including all its
2266 superblocks, stopping when the top-level block is reached. */
2269 iterate_over_block_local_vars (const struct block
*block
,
2270 iterate_over_block_arg_local_vars_cb cb
)
2274 iterate_over_block_locals (block
, cb
);
2275 /* After handling the function's top-level block, stop. Don't
2276 continue to its superblock, the block of per-file
2278 if (block
->function ())
2280 block
= block
->superblock ();
2284 /* Data to be passed around in the calls to the locals and args
2287 struct print_variable_and_value_data
2289 gdb::optional
<compiled_regex
> preg
;
2290 gdb::optional
<compiled_regex
> treg
;
2291 struct frame_id frame_id
;
2293 struct ui_file
*stream
;
2296 void operator() (const char *print_name
, struct symbol
*sym
);
2299 /* The callback for the locals and args iterators. */
2302 print_variable_and_value_data::operator() (const char *print_name
,
2305 frame_info_ptr frame
;
2307 if (preg
.has_value ()
2308 && preg
->exec (sym
->natural_name (), 0, NULL
, 0) != 0)
2310 if (treg
.has_value ()
2311 && !treg_matches_sym_type_name (*treg
, sym
))
2313 if (language_def (sym
->language ())->symbol_printing_suppressed (sym
))
2316 frame
= frame_find_by_id (frame_id
);
2319 warning (_("Unable to restore previously selected frame."));
2323 print_variable_and_value (print_name
, sym
, frame
, stream
, num_tabs
);
2325 /* print_variable_and_value invalidates FRAME. */
2331 /* Prepares the regular expression REG from REGEXP.
2332 If REGEXP is NULL, it results in an empty regular expression. */
2335 prepare_reg (const char *regexp
, gdb::optional
<compiled_regex
> *reg
)
2339 int cflags
= REG_NOSUB
| (case_sensitivity
== case_sensitive_off
2341 reg
->emplace (regexp
, cflags
, _("Invalid regexp"));
2347 /* Print all variables from the innermost up to the function block of FRAME.
2348 Print them with values to STREAM indented by NUM_TABS.
2349 If REGEXP is not NULL, only print local variables whose name
2351 If T_REGEXP is not NULL, only print local variables whose type
2353 If no local variables have been printed and !QUIET, prints a message
2354 explaining why no local variables could be printed.
2356 This function will invalidate FRAME. */
2359 print_frame_local_vars (frame_info_ptr frame
,
2361 const char *regexp
, const char *t_regexp
,
2362 int num_tabs
, struct ui_file
*stream
)
2364 struct print_variable_and_value_data cb_data
;
2365 const struct block
*block
;
2368 if (!get_frame_pc_if_available (frame
, &pc
))
2372 _("PC unavailable, cannot determine locals.\n"));
2376 block
= get_frame_block (frame
, 0);
2380 gdb_printf (stream
, "No symbol table info available.\n");
2384 prepare_reg (regexp
, &cb_data
.preg
);
2385 prepare_reg (t_regexp
, &cb_data
.treg
);
2386 cb_data
.frame_id
= get_frame_id (frame
);
2387 cb_data
.num_tabs
= 4 * num_tabs
;
2388 cb_data
.stream
= stream
;
2389 cb_data
.values_printed
= 0;
2391 /* Temporarily change the selected frame to the given FRAME.
2392 This allows routines that rely on the selected frame instead
2393 of being given a frame as parameter to use the correct frame. */
2394 scoped_restore_selected_frame restore_selected_frame
;
2395 select_frame (frame
);
2397 iterate_over_block_local_vars (block
, cb_data
);
2399 if (!cb_data
.values_printed
&& !quiet
)
2401 if (regexp
== NULL
&& t_regexp
== NULL
)
2402 gdb_printf (stream
, _("No locals.\n"));
2404 gdb_printf (stream
, _("No matching locals.\n"));
2408 /* Structure to hold the values of the options used by the 'info
2409 variables' command and other similar commands. These correspond to the
2410 -q and -t options. */
2412 struct info_print_options
2415 std::string type_regexp
;
2418 /* The options used by the 'info locals' and 'info args' commands. */
2420 static const gdb::option::option_def info_print_options_defs
[] = {
2421 gdb::option::boolean_option_def
<info_print_options
> {
2423 [] (info_print_options
*opt
) { return &opt
->quiet
; },
2424 nullptr, /* show_cmd_cb */
2425 nullptr /* set_doc */
2428 gdb::option::string_option_def
<info_print_options
> {
2430 [] (info_print_options
*opt
) { return &opt
->type_regexp
; },
2431 nullptr, /* show_cmd_cb */
2432 nullptr /* set_doc */
2436 /* Returns the option group used by 'info locals' and 'info args'
2439 static gdb::option::option_def_group
2440 make_info_print_options_def_group (info_print_options
*opts
)
2442 return {{info_print_options_defs
}, opts
};
2445 /* Command completer for 'info locals' and 'info args'. */
2448 info_print_command_completer (struct cmd_list_element
*ignore
,
2449 completion_tracker
&tracker
,
2450 const char *text
, const char * /* word */)
2453 = make_info_print_options_def_group (nullptr);
2454 if (gdb::option::complete_options
2455 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
2458 const char *word
= advance_to_expression_complete_word_point (tracker
, text
);
2459 symbol_completer (ignore
, tracker
, text
, word
);
2462 /* Implement the 'info locals' command. */
2465 info_locals_command (const char *args
, int from_tty
)
2467 info_print_options opts
;
2468 auto grp
= make_info_print_options_def_group (&opts
);
2469 gdb::option::process_options
2470 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
2471 if (args
!= nullptr && *args
== '\0')
2474 print_frame_local_vars
2475 (get_selected_frame (_("No frame selected.")),
2477 opts
.type_regexp
.empty () ? nullptr : opts
.type_regexp
.c_str (),
2481 /* Iterate over all the argument variables in block B. */
2484 iterate_over_block_arg_vars (const struct block
*b
,
2485 iterate_over_block_arg_local_vars_cb cb
)
2487 struct block_iterator iter
;
2488 struct symbol
*sym
, *sym2
;
2490 ALL_BLOCK_SYMBOLS (b
, iter
, sym
)
2492 /* Don't worry about things which aren't arguments. */
2493 if (sym
->is_argument ())
2495 /* We have to look up the symbol because arguments can have
2496 two entries (one a parameter, one a local) and the one we
2497 want is the local, which lookup_symbol will find for us.
2498 This includes gcc1 (not gcc2) on the sparc when passing a
2499 small structure and gcc2 when the argument type is float
2500 and it is passed as a double and converted to float by
2501 the prologue (in the latter case the type of the LOC_ARG
2502 symbol is double and the type of the LOC_LOCAL symbol is
2503 float). There are also LOC_ARG/LOC_REGISTER pairs which
2504 are not combined in symbol-reading. */
2506 sym2
= lookup_symbol_search_name (sym
->search_name (),
2507 b
, VAR_DOMAIN
).symbol
;
2508 cb (sym
->print_name (), sym2
);
2513 /* Print all argument variables of the function of FRAME.
2514 Print them with values to STREAM.
2515 If REGEXP is not NULL, only print argument variables whose name
2517 If T_REGEXP is not NULL, only print argument variables whose type
2519 If no argument variables have been printed and !QUIET, prints a message
2520 explaining why no argument variables could be printed.
2522 This function will invalidate FRAME. */
2525 print_frame_arg_vars (frame_info_ptr frame
,
2527 const char *regexp
, const char *t_regexp
,
2528 struct ui_file
*stream
)
2530 struct print_variable_and_value_data cb_data
;
2531 struct symbol
*func
;
2533 gdb::optional
<compiled_regex
> preg
;
2534 gdb::optional
<compiled_regex
> treg
;
2536 if (!get_frame_pc_if_available (frame
, &pc
))
2540 _("PC unavailable, cannot determine args.\n"));
2544 func
= get_frame_function (frame
);
2548 gdb_printf (stream
, _("No symbol table info available.\n"));
2552 prepare_reg (regexp
, &cb_data
.preg
);
2553 prepare_reg (t_regexp
, &cb_data
.treg
);
2554 cb_data
.frame_id
= get_frame_id (frame
);
2555 cb_data
.num_tabs
= 0;
2556 cb_data
.stream
= stream
;
2557 cb_data
.values_printed
= 0;
2559 iterate_over_block_arg_vars (func
->value_block (), cb_data
);
2561 /* do_print_variable_and_value invalidates FRAME. */
2564 if (!cb_data
.values_printed
&& !quiet
)
2566 if (regexp
== NULL
&& t_regexp
== NULL
)
2567 gdb_printf (stream
, _("No arguments.\n"));
2569 gdb_printf (stream
, _("No matching arguments.\n"));
2573 /* Implement the 'info args' command. */
2576 info_args_command (const char *args
, int from_tty
)
2578 info_print_options opts
;
2579 auto grp
= make_info_print_options_def_group (&opts
);
2580 gdb::option::process_options
2581 (&args
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, grp
);
2582 if (args
!= nullptr && *args
== '\0')
2585 print_frame_arg_vars
2586 (get_selected_frame (_("No frame selected.")),
2588 opts
.type_regexp
.empty () ? nullptr : opts
.type_regexp
.c_str (),
2592 /* Return the symbol-block in which the selected frame is executing.
2593 Can return zero under various legitimate circumstances.
2595 If ADDR_IN_BLOCK is non-zero, set *ADDR_IN_BLOCK to the relevant
2596 code address within the block returned. We use this to decide
2597 which macros are in scope. */
2599 const struct block
*
2600 get_selected_block (CORE_ADDR
*addr_in_block
)
2602 if (!has_stack_frames ())
2605 return get_frame_block (get_selected_frame (NULL
), addr_in_block
);
2608 /* Find a frame a certain number of levels away from FRAME.
2609 LEVEL_OFFSET_PTR points to an int containing the number of levels.
2610 Positive means go to earlier frames (up); negative, the reverse.
2611 The int that contains the number of levels is counted toward
2612 zero as the frames for those levels are found.
2613 If the top or bottom frame is reached, that frame is returned,
2614 but the final value of *LEVEL_OFFSET_PTR is nonzero and indicates
2615 how much farther the original request asked to go. */
2618 find_relative_frame (frame_info_ptr frame
, int *level_offset_ptr
)
2620 /* Going up is simple: just call get_prev_frame enough times or
2621 until the initial frame is reached. */
2622 while (*level_offset_ptr
> 0)
2624 frame_info_ptr prev
= get_prev_frame (frame
);
2628 (*level_offset_ptr
)--;
2632 /* Going down is just as simple. */
2633 while (*level_offset_ptr
< 0)
2635 frame_info_ptr next
= get_next_frame (frame
);
2639 (*level_offset_ptr
)++;
2646 /* Select the frame up one or COUNT_EXP stack levels from the
2647 previously selected frame, and print it briefly. */
2650 up_silently_base (const char *count_exp
)
2652 frame_info_ptr frame
;
2656 count
= parse_and_eval_long (count_exp
);
2658 frame
= find_relative_frame (get_selected_frame ("No stack."), &count
);
2659 if (count
!= 0 && count_exp
== NULL
)
2660 error (_("Initial frame selected; you cannot go up."));
2661 select_frame (frame
);
2665 up_silently_command (const char *count_exp
, int from_tty
)
2667 up_silently_base (count_exp
);
2671 up_command (const char *count_exp
, int from_tty
)
2673 up_silently_base (count_exp
);
2674 gdb::observers::user_selected_context_changed
.notify (USER_SELECTED_FRAME
);
2677 /* Select the frame down one or COUNT_EXP stack levels from the previously
2678 selected frame, and print it briefly. */
2681 down_silently_base (const char *count_exp
)
2683 frame_info_ptr frame
;
2687 count
= -parse_and_eval_long (count_exp
);
2689 frame
= find_relative_frame (get_selected_frame ("No stack."), &count
);
2690 if (count
!= 0 && count_exp
== NULL
)
2692 /* We only do this if COUNT_EXP is not specified. That way
2693 "down" means to really go down (and let me know if that is
2694 impossible), but "down 9999" can be used to mean go all the
2695 way down without getting an error. */
2697 error (_("Bottom (innermost) frame selected; you cannot go down."));
2700 select_frame (frame
);
2704 down_silently_command (const char *count_exp
, int from_tty
)
2706 down_silently_base (count_exp
);
2710 down_command (const char *count_exp
, int from_tty
)
2712 down_silently_base (count_exp
);
2713 gdb::observers::user_selected_context_changed
.notify (USER_SELECTED_FRAME
);
2717 return_command (const char *retval_exp
, int from_tty
)
2719 /* Initialize it just to avoid a GCC false warning. */
2720 enum return_value_convention rv_conv
= RETURN_VALUE_STRUCT_CONVENTION
;
2721 frame_info_ptr thisframe
;
2722 struct gdbarch
*gdbarch
;
2723 struct symbol
*thisfun
;
2724 struct value
*return_value
= NULL
;
2725 struct value
*function
= NULL
;
2726 std::string query_prefix
;
2728 thisframe
= get_selected_frame ("No selected frame.");
2729 thisfun
= get_frame_function (thisframe
);
2730 gdbarch
= get_frame_arch (thisframe
);
2732 if (get_frame_type (get_current_frame ()) == INLINE_FRAME
)
2733 error (_("Can not force return from an inlined function."));
2735 /* Compute the return value. If the computation triggers an error,
2736 let it bail. If the return type can't be handled, set
2737 RETURN_VALUE to NULL, and QUERY_PREFIX to an informational
2741 expression_up retval_expr
= parse_expression (retval_exp
);
2742 struct type
*return_type
= NULL
;
2744 /* Compute the return value. Should the computation fail, this
2745 call throws an error. */
2746 return_value
= evaluate_expression (retval_expr
.get ());
2748 /* Cast return value to the return type of the function. Should
2749 the cast fail, this call throws an error. */
2750 if (thisfun
!= NULL
)
2751 return_type
= thisfun
->type ()->target_type ();
2752 if (return_type
== NULL
)
2754 if (retval_expr
->first_opcode () != UNOP_CAST
2755 && retval_expr
->first_opcode () != UNOP_CAST_TYPE
)
2756 error (_("Return value type not available for selected "
2758 "Please use an explicit cast of the value to return."));
2759 return_type
= value_type (return_value
);
2761 return_type
= check_typedef (return_type
);
2762 return_value
= value_cast (return_type
, return_value
);
2764 /* Make sure the value is fully evaluated. It may live in the
2765 stack frame we're about to pop. */
2766 if (value_lazy (return_value
))
2767 value_fetch_lazy (return_value
);
2769 if (thisfun
!= NULL
)
2770 function
= read_var_value (thisfun
, NULL
, thisframe
);
2772 rv_conv
= RETURN_VALUE_REGISTER_CONVENTION
;
2773 if (return_type
->code () == TYPE_CODE_VOID
)
2774 /* If the return-type is "void", don't try to find the
2775 return-value's location. However, do still evaluate the
2776 return expression so that, even when the expression result
2777 is discarded, side effects such as "return i++" still
2779 return_value
= NULL
;
2780 else if (thisfun
!= NULL
)
2782 if (is_nocall_function (check_typedef (value_type (function
))))
2785 string_printf ("Function '%s' does not follow the target "
2786 "calling convention.\n"
2787 "If you continue, setting the return value "
2788 "will probably lead to unpredictable "
2790 thisfun
->print_name ());
2793 rv_conv
= struct_return_convention (gdbarch
, function
, return_type
);
2794 if (rv_conv
== RETURN_VALUE_STRUCT_CONVENTION
2795 || rv_conv
== RETURN_VALUE_ABI_RETURNS_ADDRESS
)
2797 query_prefix
= "The location at which to store the "
2798 "function's return value is unknown.\n"
2799 "If you continue, the return value "
2800 "that you specified will be ignored.\n";
2801 return_value
= NULL
;
2806 /* Does an interactive user really want to do this? Include
2807 information, such as how well GDB can handle the return value, in
2808 the query message. */
2813 if (thisfun
== NULL
)
2814 confirmed
= query (_("%sMake selected stack frame return now? "),
2815 query_prefix
.c_str ());
2818 if (TYPE_NO_RETURN (thisfun
->type ()))
2819 warning (_("Function does not return normally to caller."));
2820 confirmed
= query (_("%sMake %s return now? "),
2821 query_prefix
.c_str (),
2822 thisfun
->print_name ());
2825 error (_("Not confirmed"));
2828 /* Discard the selected frame and all frames inner-to it. */
2829 frame_pop (get_selected_frame (NULL
));
2831 /* Store RETURN_VALUE in the just-returned register set. */
2832 if (return_value
!= NULL
)
2834 struct type
*return_type
= value_type (return_value
);
2835 struct gdbarch
*cache_arch
= get_current_regcache ()->arch ();
2837 gdb_assert (rv_conv
!= RETURN_VALUE_STRUCT_CONVENTION
2838 && rv_conv
!= RETURN_VALUE_ABI_RETURNS_ADDRESS
);
2839 gdbarch_return_value (cache_arch
, function
, return_type
,
2840 get_current_regcache (), NULL
/*read*/,
2841 value_contents (return_value
).data () /*write*/);
2844 /* If we are at the end of a call dummy now, pop the dummy frame
2846 if (get_frame_type (get_current_frame ()) == DUMMY_FRAME
)
2847 frame_pop (get_current_frame ());
2849 select_frame (get_current_frame ());
2850 /* If interactive, print the frame that is now current. */
2852 print_stack_frame (get_selected_frame (NULL
), 1, SRC_AND_LOC
, 1);
2855 /* Find the most inner frame in the current stack for a function called
2856 FUNCTION_NAME. If no matching frame is found return NULL. */
2858 static frame_info_ptr
2859 find_frame_for_function (const char *function_name
)
2861 /* Used to hold the lower and upper addresses for each of the
2862 SYMTAB_AND_LINEs found for functions matching FUNCTION_NAME. */
2863 struct function_bounds
2865 CORE_ADDR low
, high
;
2867 frame_info_ptr frame
;
2871 gdb_assert (function_name
!= NULL
);
2873 frame
= get_current_frame ();
2874 std::vector
<symtab_and_line
> sals
2875 = decode_line_with_current_source (function_name
,
2876 DECODE_LINE_FUNFIRSTLINE
);
2877 gdb::def_vector
<function_bounds
> func_bounds (sals
.size ());
2878 for (size_t i
= 0; i
< sals
.size (); i
++)
2880 if (sals
[i
].pspace
!= current_program_space
)
2881 func_bounds
[i
].low
= func_bounds
[i
].high
= 0;
2882 else if (sals
[i
].pc
== 0
2883 || find_pc_partial_function (sals
[i
].pc
, NULL
,
2884 &func_bounds
[i
].low
,
2885 &func_bounds
[i
].high
) == 0)
2886 func_bounds
[i
].low
= func_bounds
[i
].high
= 0;
2891 for (size_t i
= 0; (i
< sals
.size () && !found
); i
++)
2892 found
= (get_frame_pc (frame
) >= func_bounds
[i
].low
2893 && get_frame_pc (frame
) < func_bounds
[i
].high
);
2897 frame
= find_relative_frame (frame
, &level
);
2900 while (!found
&& level
== 0);
2908 /* The qcs command line flags for the "frame apply" commands. Keep
2909 this in sync with the "thread apply" commands. */
2911 using qcs_flag_option_def
2912 = gdb::option::flag_option_def
<qcs_flags
>;
2914 static const gdb::option::option_def fr_qcs_flags_option_defs
[] = {
2915 qcs_flag_option_def
{
2916 "q", [] (qcs_flags
*opt
) { return &opt
->quiet
; },
2917 N_("Disables printing the frame location information."),
2920 qcs_flag_option_def
{
2921 "c", [] (qcs_flags
*opt
) { return &opt
->cont
; },
2922 N_("Print any error raised by COMMAND and continue."),
2925 qcs_flag_option_def
{
2926 "s", [] (qcs_flags
*opt
) { return &opt
->silent
; },
2927 N_("Silently ignore any errors or empty output produced by COMMAND."),
2931 /* Create an option_def_group array for all the "frame apply" options,
2932 with FLAGS and SET_BT_OPTS as context. */
2934 static inline std::array
<gdb::option::option_def_group
, 2>
2935 make_frame_apply_options_def_group (qcs_flags
*flags
,
2936 set_backtrace_options
*set_bt_opts
)
2939 { {fr_qcs_flags_option_defs
}, flags
},
2940 { {set_backtrace_option_defs
}, set_bt_opts
},
2944 /* Apply a GDB command to all stack frames, or a set of identified frames,
2945 or innermost COUNT frames.
2946 With a negative COUNT, apply command on outermost -COUNT frames.
2948 frame apply 3 info frame Apply 'info frame' to frames 0, 1, 2
2949 frame apply -3 info frame Apply 'info frame' to outermost 3 frames.
2950 frame apply all x/i $pc Apply 'x/i $pc' cmd to all frames.
2951 frame apply all -s p local_var_no_idea_in_which_frame
2952 If a frame has a local variable called
2953 local_var_no_idea_in_which_frame, print frame
2954 and value of local_var_no_idea_in_which_frame.
2955 frame apply all -s -q p local_var_no_idea_in_which_frame
2956 Same as before, but only print the variable value.
2957 frame apply level 2-5 0 4-7 -s p i = i + 1
2958 Adds 1 to the variable i in the specified frames.
2959 Note that i will be incremented twice in
2962 /* Apply a GDB command to COUNT stack frames, starting at TRAILING.
2963 CMD starts with 0 or more qcs flags followed by the GDB command to apply.
2964 COUNT -1 means all frames starting at TRAILING. WHICH_COMMAND is used
2965 for error messages. */
2968 frame_apply_command_count (const char *which_command
,
2969 const char *cmd
, int from_tty
,
2970 frame_info_ptr trailing
, int count
)
2973 set_backtrace_options set_bt_opts
= user_set_backtrace_options
;
2975 auto group
= make_frame_apply_options_def_group (&flags
, &set_bt_opts
);
2976 gdb::option::process_options
2977 (&cmd
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
);
2979 validate_flags_qcs (which_command
, &flags
);
2981 if (cmd
== NULL
|| *cmd
== '\0')
2982 error (_("Please specify a command to apply on the selected frames"));
2984 /* The below will restore the current inferior/thread/frame.
2985 Usually, only the frame is effectively to be restored.
2986 But in case CMD switches of inferior/thread, better restore
2988 scoped_restore_current_thread restore_thread
;
2990 /* These options are handled quite deep in the unwind machinery, so
2991 we get to pass them down by swapping globals. */
2992 scoped_restore restore_set_backtrace_options
2993 = make_scoped_restore (&user_set_backtrace_options
, set_bt_opts
);
2995 for (frame_info_ptr fi
= trailing
; fi
&& count
--; fi
= get_prev_frame (fi
))
3002 std::string cmd_result
;
3004 /* In case CMD switches of inferior/thread/frame, the below
3005 restores the inferior/thread/frame. FI can then be
3006 set to the selected frame. */
3007 scoped_restore_current_thread restore_fi_current_frame
;
3009 execute_command_to_string
3010 (cmd_result
, cmd
, from_tty
, gdb_stdout
->term_out ());
3012 fi
= get_selected_frame (_("frame apply "
3013 "unable to get selected frame."));
3014 if (!flags
.silent
|| cmd_result
.length () > 0)
3017 print_stack_frame (fi
, 1, LOCATION
, 0);
3018 gdb_printf ("%s", cmd_result
.c_str ());
3021 catch (const gdb_exception_error
&ex
)
3023 fi
= get_selected_frame (_("frame apply "
3024 "unable to get selected frame."));
3028 print_stack_frame (fi
, 1, LOCATION
, 0);
3030 gdb_printf ("%s\n", ex
.what ());
3038 /* Completer for the "frame apply ..." commands. */
3041 frame_apply_completer (completion_tracker
&tracker
, const char *text
)
3043 const auto group
= make_frame_apply_options_def_group (nullptr, nullptr);
3044 if (gdb::option::complete_options
3045 (tracker
, &text
, gdb::option::PROCESS_OPTIONS_UNKNOWN_IS_OPERAND
, group
))
3048 complete_nested_command_line (tracker
, text
);
3051 /* Completer for the "frame apply" commands. */
3054 frame_apply_level_cmd_completer (struct cmd_list_element
*ignore
,
3055 completion_tracker
&tracker
,
3056 const char *text
, const char */
*word*/
)
3058 /* Do this explicitly because there's an early return below. */
3059 tracker
.set_use_custom_word_point (true);
3061 number_or_range_parser
levels (text
);
3063 /* Skip the LEVEL list to find the options and command args. */
3066 while (!levels
.finished ())
3068 /* Call for effect. */
3069 levels
.get_number ();
3071 if (levels
.in_range ())
3072 levels
.skip_range ();
3075 catch (const gdb_exception_error
&ex
)
3077 /* get_number throws if it parses a negative number, for
3078 example. But a seemingly negative number may be the start of
3079 an option instead. */
3082 const char *cmd
= levels
.cur_tok ();
3086 /* No level list yet. */
3090 /* Check if we're past a valid LEVEL already. */
3091 if (levels
.finished ()
3092 && cmd
> text
&& !isspace (cmd
[-1]))
3095 /* We're past LEVELs, advance word point. */
3096 tracker
.advance_custom_word_point_by (cmd
- text
);
3099 frame_apply_completer (tracker
, text
);
3102 /* Completer for the "frame apply all" command. */
3105 frame_apply_all_cmd_completer (struct cmd_list_element
*ignore
,
3106 completion_tracker
&tracker
,
3107 const char *text
, const char */
*word*/
)
3109 frame_apply_completer (tracker
, text
);
3112 /* Completer for the "frame apply COUNT" command. */
3115 frame_apply_cmd_completer (struct cmd_list_element
*ignore
,
3116 completion_tracker
&tracker
,
3117 const char *text
, const char */
*word*/
)
3119 const char *cmd
= text
;
3121 int count
= get_number_trailer (&cmd
, 0);
3125 /* Check if we're past a valid COUNT already. */
3126 if (cmd
> text
&& !isspace (cmd
[-1]))
3129 /* We're past COUNT, advance word point. */
3130 tracker
.advance_custom_word_point_by (cmd
- text
);
3133 frame_apply_completer (tracker
, text
);
3136 /* Implementation of the "frame apply level" command. */
3139 frame_apply_level_command (const char *cmd
, int from_tty
)
3141 if (!target_has_stack ())
3142 error (_("No stack."));
3144 bool level_found
= false;
3145 const char *levels_str
= cmd
;
3146 number_or_range_parser
levels (levels_str
);
3148 /* Skip the LEVEL list to find the flags and command args. */
3149 while (!levels
.finished ())
3151 /* Call for effect. */
3152 levels
.get_number ();
3155 if (levels
.in_range ())
3156 levels
.skip_range ();
3160 error (_("Missing or invalid LEVEL... argument"));
3162 cmd
= levels
.cur_tok ();
3164 /* Redo the LEVELS parsing, but applying COMMAND. */
3165 levels
.init (levels_str
);
3166 while (!levels
.finished ())
3168 const int level_beg
= levels
.get_number ();
3171 if (levels
.in_range ())
3173 n_frames
= levels
.end_value () - level_beg
+ 1;
3174 levels
.skip_range ();
3179 frame_apply_command_count ("frame apply level", cmd
, from_tty
,
3180 leading_innermost_frame (level_beg
), n_frames
);
3184 /* Implementation of the "frame apply all" command. */
3187 frame_apply_all_command (const char *cmd
, int from_tty
)
3189 if (!target_has_stack ())
3190 error (_("No stack."));
3192 frame_apply_command_count ("frame apply all", cmd
, from_tty
,
3193 get_current_frame (), INT_MAX
);
3196 /* Implementation of the "frame apply" command. */
3199 frame_apply_command (const char* cmd
, int from_tty
)
3202 frame_info_ptr trailing
;
3204 if (!target_has_stack ())
3205 error (_("No stack."));
3208 error (_("Missing COUNT argument."));
3209 count
= get_number_trailer (&cmd
, 0);
3211 error (_("Invalid COUNT argument."));
3215 trailing
= trailing_outermost_frame (-count
);
3219 trailing
= get_current_frame ();
3221 frame_apply_command_count ("frame apply", cmd
, from_tty
,
3225 /* Implementation of the "faas" command. */
3228 faas_command (const char *cmd
, int from_tty
)
3230 if (cmd
== NULL
|| *cmd
== '\0')
3231 error (_("Please specify a command to apply on all frames"));
3232 std::string expanded
= std::string ("frame apply all -s ") + cmd
;
3233 execute_command (expanded
.c_str (), from_tty
);
3237 /* Find inner-mode frame with frame address ADDRESS. Return NULL if no
3238 matching frame can be found. */
3240 static frame_info_ptr
3241 find_frame_for_address (CORE_ADDR address
)
3246 id
= frame_id_build_wild (address
);
3248 /* If (s)he specifies the frame with an address, he deserves
3249 what (s)he gets. Still, give the highest one that matches.
3250 (NOTE: cagney/2004-10-29: Why highest, or outer-most, I don't
3252 for (fid
= get_current_frame ();
3254 fid
= get_prev_frame (fid
))
3256 if (id
== get_frame_id (fid
))
3258 frame_info_ptr prev_frame
;
3262 prev_frame
= get_prev_frame (fid
);
3264 || id
!= get_frame_id (prev_frame
))
3276 /* Commands with a prefix of `frame apply'. */
3277 static struct cmd_list_element
*frame_apply_cmd_list
= NULL
;
3279 /* Commands with a prefix of `frame'. */
3280 static struct cmd_list_element
*frame_cmd_list
= NULL
;
3282 /* Commands with a prefix of `select frame'. */
3283 static struct cmd_list_element
*select_frame_cmd_list
= NULL
;
3285 /* Commands with a prefix of `info frame'. */
3286 static struct cmd_list_element
*info_frame_cmd_list
= NULL
;
3288 void _initialize_stack ();
3290 _initialize_stack ()
3292 struct cmd_list_element
*cmd
;
3294 add_com ("return", class_stack
, return_command
, _("\
3295 Make selected stack frame return to its caller.\n\
3296 Control remains in the debugger, but when you continue\n\
3297 execution will resume in the frame above the one now selected.\n\
3298 If an argument is given, it is an expression for the value to return."));
3300 add_com ("up", class_stack
, up_command
, _("\
3301 Select and print stack frame that called this one.\n\
3302 An argument says how many frames up to go."));
3303 add_com ("up-silently", class_support
, up_silently_command
, _("\
3304 Same as the `up' command, but does not print anything.\n\
3305 This is useful in command scripts."));
3307 cmd_list_element
*down_cmd
3308 = add_com ("down", class_stack
, down_command
, _("\
3309 Select and print stack frame called by this one.\n\
3310 An argument says how many frames down to go."));
3311 add_com_alias ("do", down_cmd
, class_stack
, 1);
3312 add_com_alias ("dow", down_cmd
, class_stack
, 1);
3313 add_com ("down-silently", class_support
, down_silently_command
, _("\
3314 Same as the `down' command, but does not print anything.\n\
3315 This is useful in command scripts."));
3317 cmd_list_element
*frame_cmd_el
3318 = add_prefix_cmd ("frame", class_stack
,
3319 &frame_cmd
.base_command
, _("\
3320 Select and print a stack frame.\n\
3321 With no argument, print the selected stack frame. (See also \"info frame\").\n\
3322 A single numerical argument specifies the frame to select."),
3323 &frame_cmd_list
, 1, &cmdlist
);
3324 add_com_alias ("f", frame_cmd_el
, class_stack
, 1);
3326 #define FRAME_APPLY_OPTION_HELP "\
3327 Prints the frame location information followed by COMMAND output.\n\
3329 By default, an error raised during the execution of COMMAND\n\
3330 aborts \"frame apply\".\n\
3335 const auto frame_apply_opts
3336 = make_frame_apply_options_def_group (nullptr, nullptr);
3338 static std::string frame_apply_cmd_help
= gdb::option::build_help (_("\
3339 Apply a command to a number of frames.\n\
3340 Usage: frame apply COUNT [OPTION]... COMMAND\n\
3341 With a negative COUNT argument, applies the command on outermost -COUNT frames.\n"
3342 FRAME_APPLY_OPTION_HELP
),
3345 cmd
= add_prefix_cmd ("apply", class_stack
, frame_apply_command
,
3346 frame_apply_cmd_help
.c_str (),
3347 &frame_apply_cmd_list
, 1,
3349 set_cmd_completer_handle_brkchars (cmd
, frame_apply_cmd_completer
);
3351 static std::string frame_apply_all_cmd_help
= gdb::option::build_help (_("\
3352 Apply a command to all frames.\n\
3354 Usage: frame apply all [OPTION]... COMMAND\n"
3355 FRAME_APPLY_OPTION_HELP
),
3358 cmd
= add_cmd ("all", class_stack
, frame_apply_all_command
,
3359 frame_apply_all_cmd_help
.c_str (),
3360 &frame_apply_cmd_list
);
3361 set_cmd_completer_handle_brkchars (cmd
, frame_apply_all_cmd_completer
);
3363 static std::string frame_apply_level_cmd_help
= gdb::option::build_help (_("\
3364 Apply a command to a list of frames.\n\
3366 Usage: frame apply level LEVEL... [OPTION]... COMMAND\n\
3367 LEVEL is a space-separated list of levels of frames to apply COMMAND on.\n"
3368 FRAME_APPLY_OPTION_HELP
),
3371 cmd
= add_cmd ("level", class_stack
, frame_apply_level_command
,
3372 frame_apply_level_cmd_help
.c_str (),
3373 &frame_apply_cmd_list
);
3374 set_cmd_completer_handle_brkchars (cmd
, frame_apply_level_cmd_completer
);
3376 cmd
= add_com ("faas", class_stack
, faas_command
, _("\
3377 Apply a command to all frames (ignoring errors and empty output).\n\
3378 Usage: faas [OPTION]... COMMAND\n\
3379 shortcut for 'frame apply all -s [OPTION]... COMMAND'\n\
3380 See \"help frame apply all\" for available options."));
3381 set_cmd_completer_handle_brkchars (cmd
, frame_apply_all_cmd_completer
);
3383 add_cmd ("address", class_stack
, &frame_cmd
.address
,
3385 Select and print a stack frame by stack address.\n\
3387 Usage: frame address STACK-ADDRESS"),
3390 add_cmd ("view", class_stack
, &frame_cmd
.view
,
3392 View a stack frame that might be outside the current backtrace.\n\
3394 Usage: frame view STACK-ADDRESS\n\
3395 frame view STACK-ADDRESS PC-ADDRESS"),
3398 cmd
= add_cmd ("function", class_stack
, &frame_cmd
.function
,
3400 Select and print a stack frame by function name.\n\
3402 Usage: frame function NAME\n\
3404 The innermost frame that visited function NAME is selected."),
3406 set_cmd_completer (cmd
, frame_selection_by_function_completer
);
3409 add_cmd ("level", class_stack
, &frame_cmd
.level
,
3411 Select and print a stack frame by level.\n\
3413 Usage: frame level LEVEL"),
3416 cmd
= add_prefix_cmd_suppress_notification ("select-frame", class_stack
,
3417 &select_frame_cmd
.base_command
, _("\
3418 Select a stack frame without printing anything.\n\
3419 A single numerical argument specifies the frame to select."),
3420 &select_frame_cmd_list
, 1, &cmdlist
,
3421 &cli_suppress_notification
.user_selected_context
);
3423 add_cmd_suppress_notification ("address", class_stack
,
3424 &select_frame_cmd
.address
, _("\
3425 Select a stack frame by stack address.\n\
3427 Usage: select-frame address STACK-ADDRESS"),
3428 &select_frame_cmd_list
,
3429 &cli_suppress_notification
.user_selected_context
);
3432 add_cmd_suppress_notification ("view", class_stack
,
3433 &select_frame_cmd
.view
, _("\
3434 Select a stack frame that might be outside the current backtrace.\n\
3436 Usage: select-frame view STACK-ADDRESS\n\
3437 select-frame view STACK-ADDRESS PC-ADDRESS"),
3438 &select_frame_cmd_list
,
3439 &cli_suppress_notification
.user_selected_context
);
3441 cmd
= add_cmd_suppress_notification ("function", class_stack
,
3442 &select_frame_cmd
.function
, _("\
3443 Select a stack frame by function name.\n\
3445 Usage: select-frame function NAME"),
3446 &select_frame_cmd_list
,
3447 &cli_suppress_notification
.user_selected_context
);
3448 set_cmd_completer (cmd
, frame_selection_by_function_completer
);
3450 add_cmd_suppress_notification ("level", class_stack
,
3451 &select_frame_cmd
.level
, _("\
3452 Select a stack frame by level.\n\
3454 Usage: select-frame level LEVEL"),
3455 &select_frame_cmd_list
,
3456 &cli_suppress_notification
.user_selected_context
);
3458 const auto backtrace_opts
3459 = make_backtrace_options_def_group (nullptr, nullptr, nullptr);
3461 static std::string backtrace_help
3462 = gdb::option::build_help (_("\
3463 Print backtrace of all stack frames, or innermost COUNT frames.\n\
3464 Usage: backtrace [OPTION]... [QUALIFIER]... [COUNT | -COUNT]\n\
3469 For backward compatibility, the following qualifiers are supported:\n\
3471 full - same as -full option.\n\
3472 no-filters - same as -no-filters option.\n\
3473 hide - same as -hide.\n\
3475 With a negative COUNT, print outermost -COUNT frames."),
3478 cmd_list_element
*backtrace_cmd
3479 = add_com ("backtrace", class_stack
, backtrace_command
,
3480 backtrace_help
.c_str ());
3481 set_cmd_completer_handle_brkchars (backtrace_cmd
, backtrace_command_completer
);
3483 add_com_alias ("bt", backtrace_cmd
, class_stack
, 0);
3485 add_com_alias ("where", backtrace_cmd
, class_stack
, 0);
3486 cmd_list_element
*info_stack_cmd
3487 = add_info ("stack", backtrace_command
,
3488 _("Backtrace of the stack, or innermost COUNT frames."));
3489 add_info_alias ("s", info_stack_cmd
, 1);
3491 cmd_list_element
*info_frame_cmd_el
3492 = add_prefix_cmd ("frame", class_info
, &info_frame_cmd
.base_command
,
3493 _("All about the selected stack frame.\n\
3494 With no arguments, displays information about the currently selected stack\n\
3495 frame. Alternatively a frame specification may be provided (See \"frame\")\n\
3496 the information is then printed about the specified frame."),
3497 &info_frame_cmd_list
, 1, &infolist
);
3498 add_info_alias ("f", info_frame_cmd_el
, 1);
3500 add_cmd ("address", class_stack
, &info_frame_cmd
.address
,
3502 Print information about a stack frame selected by stack address.\n\
3504 Usage: info frame address STACK-ADDRESS"),
3505 &info_frame_cmd_list
);
3507 add_cmd ("view", class_stack
, &info_frame_cmd
.view
,
3509 Print information about a stack frame outside the current backtrace.\n\
3511 Usage: info frame view STACK-ADDRESS\n\
3512 info frame view STACK-ADDRESS PC-ADDRESS"),
3513 &info_frame_cmd_list
);
3515 cmd
= add_cmd ("function", class_stack
, &info_frame_cmd
.function
,
3517 Print information about a stack frame selected by function name.\n\
3519 Usage: info frame function NAME"),
3520 &info_frame_cmd_list
);
3521 set_cmd_completer (cmd
, frame_selection_by_function_completer
);
3523 add_cmd ("level", class_stack
, &info_frame_cmd
.level
,
3525 Print information about a stack frame selected by level.\n\
3527 Usage: info frame level LEVEL"),
3528 &info_frame_cmd_list
);
3530 cmd
= add_info ("locals", info_locals_command
,
3531 info_print_args_help (_("\
3532 All local variables of current stack frame or those matching REGEXPs.\n\
3533 Usage: info locals [-q] [-t TYPEREGEXP] [NAMEREGEXP]\n\
3534 Prints the local variables of the current stack frame.\n"),
3535 _("local variables"),
3537 set_cmd_completer_handle_brkchars (cmd
, info_print_command_completer
);
3538 cmd
= add_info ("args", info_args_command
,
3539 info_print_args_help (_("\
3540 All argument variables of current stack frame or those matching REGEXPs.\n\
3541 Usage: info args [-q] [-t TYPEREGEXP] [NAMEREGEXP]\n\
3542 Prints the argument variables of the current stack frame.\n"),
3543 _("argument variables"),
3545 set_cmd_completer_handle_brkchars (cmd
, info_print_command_completer
);
3547 /* Install "set print raw frame-arguments", a deprecated spelling of
3548 "set print raw-frame-arguments". */
3549 set_show_commands set_show_frame_args
3550 = add_setshow_boolean_cmd
3551 ("frame-arguments", no_class
,
3552 &user_frame_print_options
.print_raw_frame_arguments
,
3554 Set whether to print frame arguments in raw form."), _("\
3555 Show whether to print frame arguments in raw form."), _("\
3556 If set, frame arguments are printed in raw form, bypassing any\n\
3557 pretty-printers for that value."),
3559 &setprintrawlist
, &showprintrawlist
);
3560 deprecate_cmd (set_show_frame_args
.set
, "set print raw-frame-arguments");
3562 add_setshow_auto_boolean_cmd ("disassemble-next-line", class_stack
,
3563 &disassemble_next_line
, _("\
3564 Set whether to disassemble next source line or insn when execution stops."),
3566 Show whether to disassemble next source line or insn when execution stops."),
3568 If ON, GDB will display disassembly of the next source line, in addition\n\
3569 to displaying the source line itself. If the next source line cannot\n\
3570 be displayed (e.g., source is unavailable or there's no line info), GDB\n\
3571 will display disassembly of next instruction instead of showing the\n\
3573 If AUTO, display disassembly of next instruction only if the source line\n\
3574 cannot be displayed.\n\
3575 If OFF (which is the default), never display the disassembly of the next\n\
3578 show_disassemble_next_line
,
3579 &setlist
, &showlist
);
3580 disassemble_next_line
= AUTO_BOOLEAN_FALSE
;
3582 gdb::option::add_setshow_cmds_for_options
3583 (class_stack
, &user_frame_print_options
,
3584 frame_print_option_defs
, &setprintlist
, &showprintlist
);