S390: Document guarded-storage register support
[external/binutils.git] / gdb / stack.c
1 /* Print and select stack frames for GDB, the GNU debugger.
2
3    Copyright (C) 1986-2017 Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
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.
11
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.
16
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/>.  */
19
20 #include "defs.h"
21 #include "value.h"
22 #include "symtab.h"
23 #include "gdbtypes.h"
24 #include "expression.h"
25 #include "language.h"
26 #include "frame.h"
27 #include "gdbcmd.h"
28 #include "gdbcore.h"
29 #include "target.h"
30 #include "source.h"
31 #include "breakpoint.h"
32 #include "demangle.h"
33 #include "inferior.h"
34 #include "annotate.h"
35 #include "ui-out.h"
36 #include "block.h"
37 #include "stack.h"
38 #include "dictionary.h"
39 #include "reggroups.h"
40 #include "regcache.h"
41 #include "solib.h"
42 #include "valprint.h"
43 #include "gdbthread.h"
44 #include "cp-support.h"
45 #include "disasm.h"
46 #include "inline-frame.h"
47 #include "linespec.h"
48 #include "cli/cli-utils.h"
49 #include "objfiles.h"
50
51 #include "safe-ctype.h"
52 #include "symfile.h"
53 #include "extension.h"
54 #include "observer.h"
55 #include "common/def-vector.h"
56
57 /* The possible choices of "set print frame-arguments", and the value
58    of this setting.  */
59
60 static const char *const print_frame_arguments_choices[] =
61   {"all", "scalars", "none", NULL};
62 static const char *print_frame_arguments = "scalars";
63
64 /* If non-zero, don't invoke pretty-printers for frame arguments.  */
65 static int print_raw_frame_arguments;
66
67 /* The possible choices of "set print entry-values", and the value
68    of this setting.  */
69
70 const char print_entry_values_no[] = "no";
71 const char print_entry_values_only[] = "only";
72 const char print_entry_values_preferred[] = "preferred";
73 const char print_entry_values_if_needed[] = "if-needed";
74 const char print_entry_values_both[] = "both";
75 const char print_entry_values_compact[] = "compact";
76 const char print_entry_values_default[] = "default";
77 static const char *const print_entry_values_choices[] =
78 {
79   print_entry_values_no,
80   print_entry_values_only,
81   print_entry_values_preferred,
82   print_entry_values_if_needed,
83   print_entry_values_both,
84   print_entry_values_compact,
85   print_entry_values_default,
86   NULL
87 };
88 const char *print_entry_values = print_entry_values_default;
89
90 /* Prototypes for local functions.  */
91
92 static void print_frame_local_vars (struct frame_info *, int,
93                                     struct ui_file *);
94
95 static void print_frame (struct frame_info *frame, int print_level,
96                          enum print_what print_what,  int print_args,
97                          struct symtab_and_line sal);
98
99 static void set_last_displayed_sal (int valid,
100                                     struct program_space *pspace,
101                                     CORE_ADDR addr,
102                                     struct symtab *symtab,
103                                     int line);
104
105 /* Zero means do things normally; we are interacting directly with the
106    user.  One means print the full filename and linenumber when a
107    frame is printed, and do so in a format emacs18/emacs19.22 can
108    parse.  Two means print similar annotations, but in many more
109    cases and in a slightly different syntax.  */
110
111 int annotation_level = 0;
112
113 /* These variables hold the last symtab and line we displayed to the user.
114  * This is where we insert a breakpoint or a skiplist entry by default.  */
115 static int last_displayed_sal_valid = 0;
116 static struct program_space *last_displayed_pspace = 0;
117 static CORE_ADDR last_displayed_addr = 0;
118 static struct symtab *last_displayed_symtab = 0;
119 static int last_displayed_line = 0;
120 \f
121
122 /* Return 1 if we should display the address in addition to the location,
123    because we are in the middle of a statement.  */
124
125 static int
126 frame_show_address (struct frame_info *frame,
127                     struct symtab_and_line sal)
128 {
129   /* If there is a line number, but no PC, then there is no location
130      information associated with this sal.  The only way that should
131      happen is for the call sites of inlined functions (SAL comes from
132      find_frame_sal).  Otherwise, we would have some PC range if the
133      SAL came from a line table.  */
134   if (sal.line != 0 && sal.pc == 0 && sal.end == 0)
135     {
136       if (get_next_frame (frame) == NULL)
137         gdb_assert (inline_skipped_frames (inferior_ptid) > 0);
138       else
139         gdb_assert (get_frame_type (get_next_frame (frame)) == INLINE_FRAME);
140       return 0;
141     }
142
143   return get_frame_pc (frame) != sal.pc;
144 }
145
146 /* See frame.h.  */
147
148 void
149 print_stack_frame_to_uiout (struct ui_out *uiout, struct frame_info *frame,
150                             int print_level, enum print_what print_what,
151                             int set_current_sal)
152 {
153   scoped_restore save_uiout = make_scoped_restore (&current_uiout, uiout);
154
155   print_stack_frame (frame, print_level, print_what, set_current_sal);
156 }
157
158 /* Show or print a stack frame FRAME briefly.  The output is formatted
159    according to PRINT_LEVEL and PRINT_WHAT printing the frame's
160    relative level, function name, argument list, and file name and
161    line number.  If the frame's PC is not at the beginning of the
162    source line, the actual PC is printed at the beginning.  */
163
164 void
165 print_stack_frame (struct frame_info *frame, int print_level,
166                    enum print_what print_what,
167                    int set_current_sal)
168 {
169
170   /* For mi, alway print location and address.  */
171   if (current_uiout->is_mi_like_p ())
172     print_what = LOC_AND_ADDRESS;
173
174   TRY
175     {
176       print_frame_info (frame, print_level, print_what, 1 /* print_args */,
177                         set_current_sal);
178       if (set_current_sal)
179         set_current_sal_from_frame (frame);
180     }
181   CATCH (e, RETURN_MASK_ERROR)
182     {
183     }
184   END_CATCH
185 }
186
187 /* Print nameless arguments of frame FRAME on STREAM, where START is
188    the offset of the first nameless argument, and NUM is the number of
189    nameless arguments to print.  FIRST is nonzero if this is the first
190    argument (not just the first nameless argument).  */
191
192 static void
193 print_frame_nameless_args (struct frame_info *frame, long start, int num,
194                            int first, struct ui_file *stream)
195 {
196   struct gdbarch *gdbarch = get_frame_arch (frame);
197   enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
198   int i;
199   CORE_ADDR argsaddr;
200   long arg_value;
201
202   for (i = 0; i < num; i++)
203     {
204       QUIT;
205       argsaddr = get_frame_args_address (frame);
206       if (!argsaddr)
207         return;
208       arg_value = read_memory_integer (argsaddr + start,
209                                        sizeof (int), byte_order);
210       if (!first)
211         fprintf_filtered (stream, ", ");
212       fprintf_filtered (stream, "%ld", arg_value);
213       first = 0;
214       start += sizeof (int);
215     }
216 }
217
218 /* Print single argument of inferior function.  ARG must be already
219    read in.
220
221    Errors are printed as if they would be the parameter value.  Use zeroed ARG
222    iff it should not be printed accoring to user settings.  */
223
224 static void
225 print_frame_arg (const struct frame_arg *arg)
226 {
227   struct ui_out *uiout = current_uiout;
228   const char *error_message = NULL;
229
230   string_file stb;
231
232   gdb_assert (!arg->val || !arg->error);
233   gdb_assert (arg->entry_kind == print_entry_values_no
234               || arg->entry_kind == print_entry_values_only
235               || (!uiout->is_mi_like_p ()
236                   && arg->entry_kind == print_entry_values_compact));
237
238   annotate_arg_emitter arg_emitter;
239   ui_out_emit_tuple tuple_emitter (uiout, NULL);
240   fprintf_symbol_filtered (&stb, SYMBOL_PRINT_NAME (arg->sym),
241                            SYMBOL_LANGUAGE (arg->sym), DMGL_PARAMS | DMGL_ANSI);
242   if (arg->entry_kind == print_entry_values_compact)
243     {
244       /* It is OK to provide invalid MI-like stream as with
245          PRINT_ENTRY_VALUE_COMPACT we never use MI.  */
246       stb.puts ("=");
247
248       fprintf_symbol_filtered (&stb, SYMBOL_PRINT_NAME (arg->sym),
249                                SYMBOL_LANGUAGE (arg->sym),
250                                DMGL_PARAMS | DMGL_ANSI);
251     }
252   if (arg->entry_kind == print_entry_values_only
253       || arg->entry_kind == print_entry_values_compact)
254     stb.puts ("@entry");
255   uiout->field_stream ("name", stb);
256   annotate_arg_name_end ();
257   uiout->text ("=");
258
259   if (!arg->val && !arg->error)
260     uiout->text ("...");
261   else
262     {
263       if (arg->error)
264         error_message = arg->error;
265       else
266         {
267           TRY
268             {
269               const struct language_defn *language;
270               struct value_print_options opts;
271
272               /* Avoid value_print because it will deref ref parameters.  We
273                  just want to print their addresses.  Print ??? for args whose
274                  address we do not know.  We pass 2 as "recurse" to val_print
275                  because our standard indentation here is 4 spaces, and
276                  val_print indents 2 for each recurse.  */ 
277
278               annotate_arg_value (value_type (arg->val));
279
280               /* Use the appropriate language to display our symbol, unless the
281                  user forced the language to a specific language.  */
282               if (language_mode == language_mode_auto)
283                 language = language_def (SYMBOL_LANGUAGE (arg->sym));
284               else
285                 language = current_language;
286
287               get_no_prettyformat_print_options (&opts);
288               opts.deref_ref = 1;
289               opts.raw = print_raw_frame_arguments;
290
291               /* True in "summary" mode, false otherwise.  */
292               opts.summary = !strcmp (print_frame_arguments, "scalars");
293
294               common_val_print (arg->val, &stb, 2, &opts, language);
295             }
296           CATCH (except, RETURN_MASK_ERROR)
297             {
298               error_message = except.message;
299             }
300           END_CATCH
301         }
302       if (error_message != NULL)
303         stb.printf (_("<error reading variable: %s>"), error_message);
304     }
305
306   uiout->field_stream ("value", stb);
307 }
308
309 /* Read in inferior function local SYM at FRAME into ARGP.  Caller is
310    responsible for xfree of ARGP->ERROR.  This function never throws an
311    exception.  */
312
313 void
314 read_frame_local (struct symbol *sym, struct frame_info *frame,
315                   struct frame_arg *argp)
316 {
317   argp->sym = sym;
318   argp->val = NULL;
319   argp->error = NULL;
320
321   TRY
322     {
323       argp->val = read_var_value (sym, NULL, frame);
324     }
325   CATCH (except, RETURN_MASK_ERROR)
326     {
327       argp->error = xstrdup (except.message);
328     }
329   END_CATCH
330 }
331
332 /* Read in inferior function parameter SYM at FRAME into ARGP.  Caller is
333    responsible for xfree of ARGP->ERROR.  This function never throws an
334    exception.  */
335
336 void
337 read_frame_arg (struct symbol *sym, struct frame_info *frame,
338                 struct frame_arg *argp, struct frame_arg *entryargp)
339 {
340   struct value *val = NULL, *entryval = NULL;
341   char *val_error = NULL, *entryval_error = NULL;
342   int val_equal = 0;
343
344   if (print_entry_values != print_entry_values_only
345       && print_entry_values != print_entry_values_preferred)
346     {
347       TRY
348         {
349           val = read_var_value (sym, NULL, frame);
350         }
351       CATCH (except, RETURN_MASK_ERROR)
352         {
353           val_error = (char *) alloca (strlen (except.message) + 1);
354           strcpy (val_error, except.message);
355         }
356       END_CATCH
357     }
358
359   if (SYMBOL_COMPUTED_OPS (sym) != NULL
360       && SYMBOL_COMPUTED_OPS (sym)->read_variable_at_entry != NULL
361       && print_entry_values != print_entry_values_no
362       && (print_entry_values != print_entry_values_if_needed
363           || !val || value_optimized_out (val)))
364     {
365       TRY
366         {
367           const struct symbol_computed_ops *ops;
368
369           ops = SYMBOL_COMPUTED_OPS (sym);
370           entryval = ops->read_variable_at_entry (sym, frame);
371         }
372       CATCH (except, RETURN_MASK_ERROR)
373         {
374           if (except.error != NO_ENTRY_VALUE_ERROR)
375             {
376               entryval_error = (char *) alloca (strlen (except.message) + 1);
377               strcpy (entryval_error, except.message);
378             }
379         }
380       END_CATCH
381
382       if (entryval != NULL && value_optimized_out (entryval))
383         entryval = NULL;
384
385       if (print_entry_values == print_entry_values_compact
386           || print_entry_values == print_entry_values_default)
387         {
388           /* For MI do not try to use print_entry_values_compact for ARGP.  */
389
390           if (val && entryval && !current_uiout->is_mi_like_p ())
391             {
392               struct type *type = value_type (val);
393
394               if (value_lazy (val))
395                 value_fetch_lazy (val);
396               if (value_lazy (entryval))
397                 value_fetch_lazy (entryval);
398
399               if (value_contents_eq (val, 0, entryval, 0, TYPE_LENGTH (type)))
400                 {
401                   /* Initialize it just to avoid a GCC false warning.  */
402                   struct value *val_deref = NULL, *entryval_deref;
403
404                   /* DW_AT_call_value does match with the current
405                      value.  If it is a reference still try to verify if
406                      dereferenced DW_AT_call_data_value does not differ.  */
407
408                   TRY
409                     {
410                       struct type *type_deref;
411
412                       val_deref = coerce_ref (val);
413                       if (value_lazy (val_deref))
414                         value_fetch_lazy (val_deref);
415                       type_deref = value_type (val_deref);
416
417                       entryval_deref = coerce_ref (entryval);
418                       if (value_lazy (entryval_deref))
419                         value_fetch_lazy (entryval_deref);
420
421                       /* If the reference addresses match but dereferenced
422                          content does not match print them.  */
423                       if (val != val_deref
424                           && value_contents_eq (val_deref, 0,
425                                                 entryval_deref, 0,
426                                                 TYPE_LENGTH (type_deref)))
427                         val_equal = 1;
428                     }
429                   CATCH (except, RETURN_MASK_ERROR)
430                     {
431                       /* If the dereferenced content could not be
432                          fetched do not display anything.  */
433                       if (except.error == NO_ENTRY_VALUE_ERROR)
434                         val_equal = 1;
435                       else if (except.message != NULL)
436                         {
437                           entryval_error = (char *) alloca (strlen (except.message) + 1);
438                           strcpy (entryval_error, except.message);
439                         }
440                     }
441                   END_CATCH
442
443                   /* Value was not a reference; and its content matches.  */
444                   if (val == val_deref)
445                     val_equal = 1;
446
447                   if (val_equal)
448                     entryval = NULL;
449                 }
450             }
451
452           /* Try to remove possibly duplicate error message for ENTRYARGP even
453              in MI mode.  */
454
455           if (val_error && entryval_error
456               && strcmp (val_error, entryval_error) == 0)
457             {
458               entryval_error = NULL;
459
460               /* Do not se VAL_EQUAL as the same error message may be shown for
461                  the entry value even if no entry values are present in the
462                  inferior.  */
463             }
464         }
465     }
466
467   if (entryval == NULL)
468     {
469       if (print_entry_values == print_entry_values_preferred)
470         {
471           gdb_assert (val == NULL);
472
473           TRY
474             {
475               val = read_var_value (sym, NULL, frame);
476             }
477           CATCH (except, RETURN_MASK_ERROR)
478             {
479               val_error = (char *) alloca (strlen (except.message) + 1);
480               strcpy (val_error, except.message);
481             }
482           END_CATCH
483         }
484       if (print_entry_values == print_entry_values_only
485           || print_entry_values == print_entry_values_both
486           || (print_entry_values == print_entry_values_preferred
487               && (!val || value_optimized_out (val))))
488         {
489           entryval = allocate_optimized_out_value (SYMBOL_TYPE (sym));
490           entryval_error = NULL;
491         }
492     }
493   if ((print_entry_values == print_entry_values_compact
494        || print_entry_values == print_entry_values_if_needed
495        || print_entry_values == print_entry_values_preferred)
496       && (!val || value_optimized_out (val)) && entryval != NULL)
497     {
498       val = NULL;
499       val_error = NULL;
500     }
501
502   argp->sym = sym;
503   argp->val = val;
504   argp->error = val_error ? xstrdup (val_error) : NULL;
505   if (!val && !val_error)
506     argp->entry_kind = print_entry_values_only;
507   else if ((print_entry_values == print_entry_values_compact
508            || print_entry_values == print_entry_values_default) && val_equal)
509     {
510       argp->entry_kind = print_entry_values_compact;
511       gdb_assert (!current_uiout->is_mi_like_p ());
512     }
513   else
514     argp->entry_kind = print_entry_values_no;
515
516   entryargp->sym = sym;
517   entryargp->val = entryval;
518   entryargp->error = entryval_error ? xstrdup (entryval_error) : NULL;
519   if (!entryval && !entryval_error)
520     entryargp->entry_kind = print_entry_values_no;
521   else
522     entryargp->entry_kind = print_entry_values_only;
523 }
524
525 /* Print the arguments of frame FRAME on STREAM, given the function
526    FUNC running in that frame (as a symbol), where NUM is the number
527    of arguments according to the stack frame (or -1 if the number of
528    arguments is unknown).  */
529
530 /* Note that currently the "number of arguments according to the
531    stack frame" is only known on VAX where i refers to the "number of
532    ints of arguments according to the stack frame".  */
533
534 static void
535 print_frame_args (struct symbol *func, struct frame_info *frame,
536                   int num, struct ui_file *stream)
537 {
538   struct ui_out *uiout = current_uiout;
539   int first = 1;
540   /* Offset of next stack argument beyond the one we have seen that is
541      at the highest offset, or -1 if we haven't come to a stack
542      argument yet.  */
543   long highest_offset = -1;
544   /* Number of ints of arguments that we have printed so far.  */
545   int args_printed = 0;
546   /* True if we should print arguments, false otherwise.  */
547   int print_args = strcmp (print_frame_arguments, "none");
548
549   if (func)
550     {
551       const struct block *b = SYMBOL_BLOCK_VALUE (func);
552       struct block_iterator iter;
553       struct symbol *sym;
554
555       ALL_BLOCK_SYMBOLS (b, iter, sym)
556         {
557           struct frame_arg arg, entryarg;
558
559           QUIT;
560
561           /* Keep track of the highest stack argument offset seen, and
562              skip over any kinds of symbols we don't care about.  */
563
564           if (!SYMBOL_IS_ARGUMENT (sym))
565             continue;
566
567           switch (SYMBOL_CLASS (sym))
568             {
569             case LOC_ARG:
570             case LOC_REF_ARG:
571               {
572                 long current_offset = SYMBOL_VALUE (sym);
573                 int arg_size = TYPE_LENGTH (SYMBOL_TYPE (sym));
574
575                 /* Compute address of next argument by adding the size of
576                    this argument and rounding to an int boundary.  */
577                 current_offset =
578                   ((current_offset + arg_size + sizeof (int) - 1)
579                    & ~(sizeof (int) - 1));
580
581                 /* If this is the highest offset seen yet, set
582                    highest_offset.  */
583                 if (highest_offset == -1
584                     || (current_offset > highest_offset))
585                   highest_offset = current_offset;
586
587                 /* Add the number of ints we're about to print to
588                    args_printed.  */
589                 args_printed += (arg_size + sizeof (int) - 1) / sizeof (int);
590               }
591
592               /* We care about types of symbols, but don't need to
593                  keep track of stack offsets in them.  */
594             case LOC_REGISTER:
595             case LOC_REGPARM_ADDR:
596             case LOC_COMPUTED:
597             case LOC_OPTIMIZED_OUT:
598             default:
599               break;
600             }
601
602           /* We have to look up the symbol because arguments can have
603              two entries (one a parameter, one a local) and the one we
604              want is the local, which lookup_symbol will find for us.
605              This includes gcc1 (not gcc2) on SPARC when passing a
606              small structure and gcc2 when the argument type is float
607              and it is passed as a double and converted to float by
608              the prologue (in the latter case the type of the LOC_ARG
609              symbol is double and the type of the LOC_LOCAL symbol is
610              float).  */
611           /* But if the parameter name is null, don't try it.  Null
612              parameter names occur on the RS/6000, for traceback
613              tables.  FIXME, should we even print them?  */
614
615           if (*SYMBOL_LINKAGE_NAME (sym))
616             {
617               struct symbol *nsym;
618
619               nsym = lookup_symbol (SYMBOL_LINKAGE_NAME (sym),
620                                     b, VAR_DOMAIN, NULL).symbol;
621               gdb_assert (nsym != NULL);
622               if (SYMBOL_CLASS (nsym) == LOC_REGISTER
623                   && !SYMBOL_IS_ARGUMENT (nsym))
624                 {
625                   /* There is a LOC_ARG/LOC_REGISTER pair.  This means
626                      that it was passed on the stack and loaded into a
627                      register, or passed in a register and stored in a
628                      stack slot.  GDB 3.x used the LOC_ARG; GDB
629                      4.0-4.11 used the LOC_REGISTER.
630
631                      Reasons for using the LOC_ARG:
632
633                      (1) Because find_saved_registers may be slow for
634                          remote debugging.
635
636                      (2) Because registers are often re-used and stack
637                          slots rarely (never?) are.  Therefore using
638                          the stack slot is much less likely to print
639                          garbage.
640
641                      Reasons why we might want to use the LOC_REGISTER:
642
643                      (1) So that the backtrace prints the same value
644                          as "print foo".  I see no compelling reason
645                          why this needs to be the case; having the
646                          backtrace print the value which was passed
647                          in, and "print foo" print the value as
648                          modified within the called function, makes
649                          perfect sense to me.
650
651                      Additional note: It might be nice if "info args"
652                      displayed both values.
653
654                      One more note: There is a case with SPARC
655                      structure passing where we need to use the
656                      LOC_REGISTER, but this is dealt with by creating
657                      a single LOC_REGPARM in symbol reading.  */
658
659                   /* Leave sym (the LOC_ARG) alone.  */
660                   ;
661                 }
662               else
663                 sym = nsym;
664             }
665
666           /* Print the current arg.  */
667           if (!first)
668             uiout->text (", ");
669           uiout->wrap_hint ("    ");
670
671           if (!print_args)
672             {
673               memset (&arg, 0, sizeof (arg));
674               arg.sym = sym;
675               arg.entry_kind = print_entry_values_no;
676               memset (&entryarg, 0, sizeof (entryarg));
677               entryarg.sym = sym;
678               entryarg.entry_kind = print_entry_values_no;
679             }
680           else
681             read_frame_arg (sym, frame, &arg, &entryarg);
682
683           if (arg.entry_kind != print_entry_values_only)
684             print_frame_arg (&arg);
685
686           if (entryarg.entry_kind != print_entry_values_no)
687             {
688               if (arg.entry_kind != print_entry_values_only)
689                 {
690                   uiout->text (", ");
691                   uiout->wrap_hint ("    ");
692                 }
693
694               print_frame_arg (&entryarg);
695             }
696
697           xfree (arg.error);
698           xfree (entryarg.error);
699
700           first = 0;
701         }
702     }
703
704   /* Don't print nameless args in situations where we don't know
705      enough about the stack to find them.  */
706   if (num != -1)
707     {
708       long start;
709
710       if (highest_offset == -1)
711         start = gdbarch_frame_args_skip (get_frame_arch (frame));
712       else
713         start = highest_offset;
714
715       print_frame_nameless_args (frame, start, num - args_printed,
716                                  first, stream);
717     }
718 }
719
720 /* Set the current source and line to the location given by frame
721    FRAME, if possible.  When CENTER is true, adjust so the relevant
722    line is in the center of the next 'list'.  */
723
724 void
725 set_current_sal_from_frame (struct frame_info *frame)
726 {
727   symtab_and_line sal = find_frame_sal (frame);
728   if (sal.symtab != NULL)
729     set_current_source_symtab_and_line (sal);
730 }
731
732 /* If ON, GDB will display disassembly of the next source line when
733    execution of the program being debugged stops.
734    If AUTO (which is the default), or there's no line info to determine
735    the source line of the next instruction, display disassembly of next
736    instruction instead.  */
737
738 static enum auto_boolean disassemble_next_line;
739
740 static void
741 show_disassemble_next_line (struct ui_file *file, int from_tty,
742                                  struct cmd_list_element *c,
743                                  const char *value)
744 {
745   fprintf_filtered (file,
746                     _("Debugger's willingness to use "
747                       "disassemble-next-line is %s.\n"),
748                     value);
749 }
750
751 /* Use TRY_CATCH to catch the exception from the gdb_disassembly
752    because it will be broken by filter sometime.  */
753
754 static void
755 do_gdb_disassembly (struct gdbarch *gdbarch,
756                     int how_many, CORE_ADDR low, CORE_ADDR high)
757 {
758
759   TRY
760     {
761       gdb_disassembly (gdbarch, current_uiout,
762                        DISASSEMBLY_RAW_INSN, how_many,
763                        low, high);
764     }
765   CATCH (exception, RETURN_MASK_ERROR)
766     {
767       /* If an exception was thrown while doing the disassembly, print
768          the error message, to give the user a clue of what happened.  */
769       exception_print (gdb_stderr, exception);
770     }
771   END_CATCH
772 }
773
774 /* Print information about frame FRAME.  The output is format according
775    to PRINT_LEVEL and PRINT_WHAT and PRINT_ARGS.  The meaning of
776    PRINT_WHAT is:
777    
778    SRC_LINE: Print only source line.
779    LOCATION: Print only location.
780    LOC_AND_SRC: Print location and source line.
781
782    Used in "where" output, and to emit breakpoint or step
783    messages.  */
784
785 void
786 print_frame_info (struct frame_info *frame, int print_level,
787                   enum print_what print_what, int print_args,
788                   int set_current_sal)
789 {
790   struct gdbarch *gdbarch = get_frame_arch (frame);
791   int source_print;
792   int location_print;
793   struct ui_out *uiout = current_uiout;
794
795   if (get_frame_type (frame) == DUMMY_FRAME
796       || get_frame_type (frame) == SIGTRAMP_FRAME
797       || get_frame_type (frame) == ARCH_FRAME)
798     {
799       ui_out_emit_tuple tuple_emitter (uiout, "frame");
800
801       annotate_frame_begin (print_level ? frame_relative_level (frame) : 0,
802                             gdbarch, get_frame_pc (frame));
803
804       /* Do this regardless of SOURCE because we don't have any source
805          to list for this frame.  */
806       if (print_level)
807         {
808           uiout->text ("#");
809           uiout->field_fmt_int (2, ui_left, "level",
810                                 frame_relative_level (frame));
811         }
812       if (uiout->is_mi_like_p ())
813         {
814           annotate_frame_address ();
815           uiout->field_core_addr ("addr",
816                                   gdbarch, get_frame_pc (frame));
817           annotate_frame_address_end ();
818         }
819
820       if (get_frame_type (frame) == DUMMY_FRAME)
821         {
822           annotate_function_call ();
823           uiout->field_string ("func", "<function called from gdb>");
824         }
825       else if (get_frame_type (frame) == SIGTRAMP_FRAME)
826         {
827           annotate_signal_handler_caller ();
828           uiout->field_string ("func", "<signal handler called>");
829         }
830       else if (get_frame_type (frame) == ARCH_FRAME)
831         {
832           uiout->field_string ("func", "<cross-architecture call>");
833         }
834       uiout->text ("\n");
835       annotate_frame_end ();
836
837       /* If disassemble-next-line is set to auto or on output the next
838          instruction.  */
839       if (disassemble_next_line == AUTO_BOOLEAN_AUTO
840           || disassemble_next_line == AUTO_BOOLEAN_TRUE)
841         do_gdb_disassembly (get_frame_arch (frame), 1,
842                             get_frame_pc (frame), get_frame_pc (frame) + 1);
843
844       return;
845     }
846
847   /* If FRAME is not the innermost frame, that normally means that
848      FRAME->pc points to *after* the call instruction, and we want to
849      get the line containing the call, never the next line.  But if
850      the next frame is a SIGTRAMP_FRAME or a DUMMY_FRAME, then the
851      next frame was not entered as the result of a call, and we want
852      to get the line containing FRAME->pc.  */
853   symtab_and_line sal = find_frame_sal (frame);
854
855   location_print = (print_what == LOCATION 
856                     || print_what == LOC_AND_ADDRESS
857                     || print_what == SRC_AND_LOC);
858
859   if (location_print || !sal.symtab)
860     print_frame (frame, print_level, print_what, print_args, sal);
861
862   source_print = (print_what == SRC_LINE || print_what == SRC_AND_LOC);
863
864   /* If disassemble-next-line is set to auto or on and doesn't have
865      the line debug messages for $pc, output the next instruction.  */
866   if ((disassemble_next_line == AUTO_BOOLEAN_AUTO
867        || disassemble_next_line == AUTO_BOOLEAN_TRUE)
868       && source_print && !sal.symtab)
869     do_gdb_disassembly (get_frame_arch (frame), 1,
870                         get_frame_pc (frame), get_frame_pc (frame) + 1);
871
872   if (source_print && sal.symtab)
873     {
874       int done = 0;
875       int mid_statement = ((print_what == SRC_LINE)
876                            && frame_show_address (frame, sal));
877
878       if (annotation_level)
879         done = identify_source_line (sal.symtab, sal.line, mid_statement,
880                                      get_frame_pc (frame));
881       if (!done)
882         {
883           if (deprecated_print_frame_info_listing_hook)
884             deprecated_print_frame_info_listing_hook (sal.symtab, 
885                                                       sal.line, 
886                                                       sal.line + 1, 0);
887           else
888             {
889               struct value_print_options opts;
890
891               get_user_print_options (&opts);
892               /* We used to do this earlier, but that is clearly
893                  wrong.  This function is used by many different
894                  parts of gdb, including normal_stop in infrun.c,
895                  which uses this to print out the current PC
896                  when we stepi/nexti into the middle of a source
897                  line.  Only the command line really wants this
898                  behavior.  Other UIs probably would like the
899                  ability to decide for themselves if it is desired.  */
900               if (opts.addressprint && mid_statement)
901                 {
902                   uiout->field_core_addr ("addr",
903                                           gdbarch, get_frame_pc (frame));
904                   uiout->text ("\t");
905                 }
906
907               print_source_lines (sal.symtab, sal.line, sal.line + 1, 0);
908             }
909         }
910
911       /* If disassemble-next-line is set to on and there is line debug
912          messages, output assembly codes for next line.  */
913       if (disassemble_next_line == AUTO_BOOLEAN_TRUE)
914         do_gdb_disassembly (get_frame_arch (frame), -1, sal.pc, sal.end);
915     }
916
917   if (set_current_sal)
918     {
919       CORE_ADDR pc;
920
921       if (get_frame_pc_if_available (frame, &pc))
922         set_last_displayed_sal (1, sal.pspace, pc, sal.symtab, sal.line);
923       else
924         set_last_displayed_sal (0, 0, 0, 0, 0);
925     }
926
927   annotate_frame_end ();
928
929   gdb_flush (gdb_stdout);
930 }
931
932 /* Remember the last symtab and line we displayed, which we use e.g.
933  * as the place to put a breakpoint when the `break' command is
934  * invoked with no arguments.  */
935
936 static void
937 set_last_displayed_sal (int valid, struct program_space *pspace,
938                         CORE_ADDR addr, struct symtab *symtab,
939                         int line)
940 {
941   last_displayed_sal_valid = valid;
942   last_displayed_pspace = pspace;
943   last_displayed_addr = addr;
944   last_displayed_symtab = symtab;
945   last_displayed_line = line;
946   if (valid && pspace == NULL)
947     {
948       clear_last_displayed_sal ();
949       internal_error (__FILE__, __LINE__,
950                       _("Trying to set NULL pspace."));
951     }
952 }
953
954 /* Forget the last sal we displayed.  */
955
956 void
957 clear_last_displayed_sal (void)
958 {
959   last_displayed_sal_valid = 0;
960   last_displayed_pspace = 0;
961   last_displayed_addr = 0;
962   last_displayed_symtab = 0;
963   last_displayed_line = 0;
964 }
965
966 /* Is our record of the last sal we displayed valid?  If not,
967  * the get_last_displayed_* functions will return NULL or 0, as
968  * appropriate.  */
969
970 int
971 last_displayed_sal_is_valid (void)
972 {
973   return last_displayed_sal_valid;
974 }
975
976 /* Get the pspace of the last sal we displayed, if it's valid.  */
977
978 struct program_space *
979 get_last_displayed_pspace (void)
980 {
981   if (last_displayed_sal_valid)
982     return last_displayed_pspace;
983   return 0;
984 }
985
986 /* Get the address of the last sal we displayed, if it's valid.  */
987
988 CORE_ADDR
989 get_last_displayed_addr (void)
990 {
991   if (last_displayed_sal_valid)
992     return last_displayed_addr;
993   return 0;
994 }
995
996 /* Get the symtab of the last sal we displayed, if it's valid.  */
997
998 struct symtab*
999 get_last_displayed_symtab (void)
1000 {
1001   if (last_displayed_sal_valid)
1002     return last_displayed_symtab;
1003   return 0;
1004 }
1005
1006 /* Get the line of the last sal we displayed, if it's valid.  */
1007
1008 int
1009 get_last_displayed_line (void)
1010 {
1011   if (last_displayed_sal_valid)
1012     return last_displayed_line;
1013   return 0;
1014 }
1015
1016 /* Get the last sal we displayed, if it's valid.  */
1017
1018 symtab_and_line
1019 get_last_displayed_sal ()
1020 {
1021   symtab_and_line sal;
1022
1023   if (last_displayed_sal_valid)
1024     {
1025       sal.pspace = last_displayed_pspace;
1026       sal.pc = last_displayed_addr;
1027       sal.symtab = last_displayed_symtab;
1028       sal.line = last_displayed_line;
1029     }
1030
1031   return sal;
1032 }
1033
1034
1035 /* Attempt to obtain the name, FUNLANG and optionally FUNCP of the function
1036    corresponding to FRAME.  */
1037
1038 gdb::unique_xmalloc_ptr<char>
1039 find_frame_funname (struct frame_info *frame, enum language *funlang,
1040                     struct symbol **funcp)
1041 {
1042   struct symbol *func;
1043   gdb::unique_xmalloc_ptr<char> funname;
1044
1045   *funlang = language_unknown;
1046   if (funcp)
1047     *funcp = NULL;
1048
1049   func = get_frame_function (frame);
1050   if (func)
1051     {
1052       /* In certain pathological cases, the symtabs give the wrong
1053          function (when we are in the first function in a file which
1054          is compiled without debugging symbols, the previous function
1055          is compiled with debugging symbols, and the "foo.o" symbol
1056          that is supposed to tell us where the file with debugging
1057          symbols ends has been truncated by ar because it is longer
1058          than 15 characters).  This also occurs if the user uses asm()
1059          to create a function but not stabs for it (in a file compiled
1060          with -g).
1061
1062          So look in the minimal symbol tables as well, and if it comes
1063          up with a larger address for the function use that instead.
1064          I don't think this can ever cause any problems; there
1065          shouldn't be any minimal symbols in the middle of a function;
1066          if this is ever changed many parts of GDB will need to be
1067          changed (and we'll create a find_pc_minimal_function or some
1068          such).  */
1069
1070       struct bound_minimal_symbol msymbol;
1071
1072       /* Don't attempt to do this for inlined functions, which do not
1073          have a corresponding minimal symbol.  */
1074       if (!block_inlined_p (SYMBOL_BLOCK_VALUE (func)))
1075         msymbol
1076           = lookup_minimal_symbol_by_pc (get_frame_address_in_block (frame));
1077       else
1078         memset (&msymbol, 0, sizeof (msymbol));
1079
1080       if (msymbol.minsym != NULL
1081           && (BMSYMBOL_VALUE_ADDRESS (msymbol)
1082               > BLOCK_START (SYMBOL_BLOCK_VALUE (func))))
1083         {
1084           /* We also don't know anything about the function besides
1085              its address and name.  */
1086           func = 0;
1087           funname.reset (xstrdup (MSYMBOL_PRINT_NAME (msymbol.minsym)));
1088           *funlang = MSYMBOL_LANGUAGE (msymbol.minsym);
1089         }
1090       else
1091         {
1092           const char *print_name = SYMBOL_PRINT_NAME (func);
1093
1094           *funlang = SYMBOL_LANGUAGE (func);
1095           if (funcp)
1096             *funcp = func;
1097           if (*funlang == language_cplus)
1098             {
1099               /* It seems appropriate to use SYMBOL_PRINT_NAME() here,
1100                  to display the demangled name that we already have
1101                  stored in the symbol table, but we stored a version
1102                  with DMGL_PARAMS turned on, and here we don't want to
1103                  display parameters.  So remove the parameters.  */
1104               char *func_only = cp_remove_params (print_name);
1105
1106               if (func_only)
1107                 funname.reset (func_only);
1108             }
1109
1110           /* If we didn't hit the C++ case above, set *funname
1111              here.  */
1112           if (funname == NULL)
1113             funname.reset (xstrdup (print_name));
1114         }
1115     }
1116   else
1117     {
1118       struct bound_minimal_symbol msymbol;
1119       CORE_ADDR pc;
1120
1121       if (!get_frame_address_in_block_if_available (frame, &pc))
1122         return funname;
1123
1124       msymbol = lookup_minimal_symbol_by_pc (pc);
1125       if (msymbol.minsym != NULL)
1126         {
1127           funname.reset (xstrdup (MSYMBOL_PRINT_NAME (msymbol.minsym)));
1128           *funlang = MSYMBOL_LANGUAGE (msymbol.minsym);
1129         }
1130     }
1131
1132   return funname;
1133 }
1134
1135 static void
1136 print_frame (struct frame_info *frame, int print_level,
1137              enum print_what print_what, int print_args,
1138              struct symtab_and_line sal)
1139 {
1140   struct gdbarch *gdbarch = get_frame_arch (frame);
1141   struct ui_out *uiout = current_uiout;
1142   enum language funlang = language_unknown;
1143   struct value_print_options opts;
1144   struct symbol *func;
1145   CORE_ADDR pc = 0;
1146   int pc_p;
1147
1148   pc_p = get_frame_pc_if_available (frame, &pc);
1149
1150   gdb::unique_xmalloc_ptr<char> funname
1151     = find_frame_funname (frame, &funlang, &func);
1152
1153   annotate_frame_begin (print_level ? frame_relative_level (frame) : 0,
1154                         gdbarch, pc);
1155
1156   {
1157     ui_out_emit_tuple tuple_emitter (uiout, "frame");
1158
1159     if (print_level)
1160       {
1161         uiout->text ("#");
1162         uiout->field_fmt_int (2, ui_left, "level",
1163                               frame_relative_level (frame));
1164       }
1165     get_user_print_options (&opts);
1166     if (opts.addressprint)
1167       if (!sal.symtab
1168           || frame_show_address (frame, sal)
1169           || print_what == LOC_AND_ADDRESS)
1170         {
1171           annotate_frame_address ();
1172           if (pc_p)
1173             uiout->field_core_addr ("addr", gdbarch, pc);
1174           else
1175             uiout->field_string ("addr", "<unavailable>");
1176           annotate_frame_address_end ();
1177           uiout->text (" in ");
1178         }
1179     annotate_frame_function_name ();
1180
1181     string_file stb;
1182     fprintf_symbol_filtered (&stb, funname ? funname.get () : "??",
1183                              funlang, DMGL_ANSI);
1184     uiout->field_stream ("func", stb);
1185     uiout->wrap_hint ("   ");
1186     annotate_frame_args ();
1187       
1188     uiout->text (" (");
1189     if (print_args)
1190       {
1191         struct gdbarch *gdbarch = get_frame_arch (frame);
1192         int numargs;
1193
1194         if (gdbarch_frame_num_args_p (gdbarch))
1195           {
1196             numargs = gdbarch_frame_num_args (gdbarch, frame);
1197             gdb_assert (numargs >= 0);
1198           }
1199         else
1200           numargs = -1;
1201     
1202         {
1203           ui_out_emit_list list_emitter (uiout, "args");
1204           TRY
1205             {
1206               print_frame_args (func, frame, numargs, gdb_stdout);
1207             }
1208           CATCH (e, RETURN_MASK_ERROR)
1209             {
1210             }
1211           END_CATCH
1212
1213             /* FIXME: ARGS must be a list.  If one argument is a string it
1214                will have " that will not be properly escaped.  */
1215             }
1216         QUIT;
1217       }
1218     uiout->text (")");
1219     if (sal.symtab)
1220       {
1221         const char *filename_display;
1222       
1223         filename_display = symtab_to_filename_for_display (sal.symtab);
1224         annotate_frame_source_begin ();
1225         uiout->wrap_hint ("   ");
1226         uiout->text (" at ");
1227         annotate_frame_source_file ();
1228         uiout->field_string ("file", filename_display);
1229         if (uiout->is_mi_like_p ())
1230           {
1231             const char *fullname = symtab_to_fullname (sal.symtab);
1232
1233             uiout->field_string ("fullname", fullname);
1234           }
1235         annotate_frame_source_file_end ();
1236         uiout->text (":");
1237         annotate_frame_source_line ();
1238         uiout->field_int ("line", sal.line);
1239         annotate_frame_source_end ();
1240       }
1241
1242     if (pc_p && (funname == NULL || sal.symtab == NULL))
1243       {
1244         char *lib = solib_name_from_address (get_frame_program_space (frame),
1245                                              get_frame_pc (frame));
1246
1247         if (lib)
1248           {
1249             annotate_frame_where ();
1250             uiout->wrap_hint ("  ");
1251             uiout->text (" from ");
1252             uiout->field_string ("from", lib);
1253           }
1254       }
1255   }
1256
1257   uiout->text ("\n");
1258 }
1259 \f
1260
1261 /* Read a frame specification in whatever the appropriate format is from
1262    FRAME_EXP.  Call error() if the specification is in any way invalid (so
1263    this function never returns NULL).  When SELECTED_FRAME_P is non-NULL
1264    set its target to indicate that the default selected frame was used.  */
1265
1266 static struct frame_info *
1267 parse_frame_specification (const char *frame_exp, int *selected_frame_p)
1268 {
1269   int numargs;
1270   struct value *args[4];
1271   CORE_ADDR addrs[ARRAY_SIZE (args)];
1272
1273   if (frame_exp == NULL)
1274     numargs = 0;
1275   else
1276     {
1277       numargs = 0;
1278       while (1)
1279         {
1280           char *addr_string;
1281           struct cleanup *cleanup;
1282           const char *p;
1283
1284           /* Skip leading white space, bail of EOL.  */
1285           frame_exp = skip_spaces (frame_exp);
1286           if (!*frame_exp)
1287             break;
1288
1289           /* Parse the argument, extract it, save it.  */
1290           for (p = frame_exp;
1291                *p && !ISSPACE (*p);
1292                p++);
1293           addr_string = savestring (frame_exp, p - frame_exp);
1294           frame_exp = p;
1295           cleanup = make_cleanup (xfree, addr_string);
1296           
1297           /* NOTE: Parse and evaluate expression, but do not use
1298              functions such as parse_and_eval_long or
1299              parse_and_eval_address to also extract the value.
1300              Instead value_as_long and value_as_address are used.
1301              This avoids problems with expressions that contain
1302              side-effects.  */
1303           if (numargs >= ARRAY_SIZE (args))
1304             error (_("Too many args in frame specification"));
1305           args[numargs++] = parse_and_eval (addr_string);
1306
1307           do_cleanups (cleanup);
1308         }
1309     }
1310
1311   /* If no args, default to the selected frame.  */
1312   if (numargs == 0)
1313     {
1314       if (selected_frame_p != NULL)
1315         (*selected_frame_p) = 1;
1316       return get_selected_frame (_("No stack."));
1317     }
1318
1319   /* None of the remaining use the selected frame.  */
1320   if (selected_frame_p != NULL)
1321     (*selected_frame_p) = 0;
1322
1323   /* Assume the single arg[0] is an integer, and try using that to
1324      select a frame relative to current.  */
1325   if (numargs == 1)
1326     {
1327       struct frame_info *fid;
1328       int level = value_as_long (args[0]);
1329
1330       fid = find_relative_frame (get_current_frame (), &level);
1331       if (level == 0)
1332         /* find_relative_frame was successful.  */
1333         return fid;
1334     }
1335
1336   /* Convert each value into a corresponding address.  */
1337   {
1338     int i;
1339
1340     for (i = 0; i < numargs; i++)
1341       addrs[i] = value_as_address (args[i]);
1342   }
1343
1344   /* Assume that the single arg[0] is an address, use that to identify
1345      a frame with a matching ID.  Should this also accept stack/pc or
1346      stack/pc/special.  */
1347   if (numargs == 1)
1348     {
1349       struct frame_id id = frame_id_build_wild (addrs[0]);
1350       struct frame_info *fid;
1351
1352       /* If (s)he specifies the frame with an address, he deserves
1353          what (s)he gets.  Still, give the highest one that matches.
1354          (NOTE: cagney/2004-10-29: Why highest, or outer-most, I don't
1355          know).  */
1356       for (fid = get_current_frame ();
1357            fid != NULL;
1358            fid = get_prev_frame (fid))
1359         {
1360           if (frame_id_eq (id, get_frame_id (fid)))
1361             {
1362               struct frame_info *prev_frame;
1363
1364               while (1)
1365                 {
1366                   prev_frame = get_prev_frame (fid);
1367                   if (!prev_frame
1368                       || !frame_id_eq (id, get_frame_id (prev_frame)))
1369                     break;
1370                   fid = prev_frame;
1371                 }
1372               return fid;
1373             }
1374         }
1375       }
1376
1377   /* We couldn't identify the frame as an existing frame, but
1378      perhaps we can create one with a single argument.  */
1379   if (numargs == 1)
1380     return create_new_frame (addrs[0], 0);
1381   else if (numargs == 2)
1382     return create_new_frame (addrs[0], addrs[1]);
1383   else
1384     error (_("Too many args in frame specification"));
1385 }
1386
1387 /* Print verbosely the selected frame or the frame at address
1388    ADDR_EXP.  Absolutely all information in the frame is printed.  */
1389
1390 static void
1391 info_frame_command (char *addr_exp, int from_tty)
1392 {
1393   struct frame_info *fi;
1394   struct symbol *func;
1395   struct symtab *s;
1396   struct frame_info *calling_frame_info;
1397   int numregs;
1398   const char *funname = 0;
1399   enum language funlang = language_unknown;
1400   const char *pc_regname;
1401   int selected_frame_p;
1402   struct gdbarch *gdbarch;
1403   struct cleanup *back_to = make_cleanup (null_cleanup, NULL);
1404   CORE_ADDR frame_pc;
1405   int frame_pc_p;
1406   /* Initialize it to avoid "may be used uninitialized" warning.  */
1407   CORE_ADDR caller_pc = 0;
1408   int caller_pc_p = 0;
1409
1410   fi = parse_frame_specification (addr_exp, &selected_frame_p);
1411   gdbarch = get_frame_arch (fi);
1412
1413   /* Name of the value returned by get_frame_pc().  Per comments, "pc"
1414      is not a good name.  */
1415   if (gdbarch_pc_regnum (gdbarch) >= 0)
1416     /* OK, this is weird.  The gdbarch_pc_regnum hardware register's value can
1417        easily not match that of the internal value returned by
1418        get_frame_pc().  */
1419     pc_regname = gdbarch_register_name (gdbarch, gdbarch_pc_regnum (gdbarch));
1420   else
1421     /* But then, this is weird to.  Even without gdbarch_pc_regnum, an
1422        architectures will often have a hardware register called "pc",
1423        and that register's value, again, can easily not match
1424        get_frame_pc().  */
1425     pc_regname = "pc";
1426
1427   frame_pc_p = get_frame_pc_if_available (fi, &frame_pc);
1428   func = get_frame_function (fi);
1429   symtab_and_line sal = find_frame_sal (fi);
1430   s = sal.symtab;
1431   if (func)
1432     {
1433       funname = SYMBOL_PRINT_NAME (func);
1434       funlang = SYMBOL_LANGUAGE (func);
1435       if (funlang == language_cplus)
1436         {
1437           /* It seems appropriate to use SYMBOL_PRINT_NAME() here,
1438              to display the demangled name that we already have
1439              stored in the symbol table, but we stored a version
1440              with DMGL_PARAMS turned on, and here we don't want to
1441              display parameters.  So remove the parameters.  */
1442           char *func_only = cp_remove_params (funname);
1443
1444           if (func_only)
1445             {
1446               funname = func_only;
1447               make_cleanup (xfree, func_only);
1448             }
1449         }
1450     }
1451   else if (frame_pc_p)
1452     {
1453       struct bound_minimal_symbol msymbol;
1454
1455       msymbol = lookup_minimal_symbol_by_pc (frame_pc);
1456       if (msymbol.minsym != NULL)
1457         {
1458           funname = MSYMBOL_PRINT_NAME (msymbol.minsym);
1459           funlang = MSYMBOL_LANGUAGE (msymbol.minsym);
1460         }
1461     }
1462   calling_frame_info = get_prev_frame (fi);
1463
1464   if (selected_frame_p && frame_relative_level (fi) >= 0)
1465     {
1466       printf_filtered (_("Stack level %d, frame at "),
1467                        frame_relative_level (fi));
1468     }
1469   else
1470     {
1471       printf_filtered (_("Stack frame at "));
1472     }
1473   fputs_filtered (paddress (gdbarch, get_frame_base (fi)), gdb_stdout);
1474   printf_filtered (":\n");
1475   printf_filtered (" %s = ", pc_regname);
1476   if (frame_pc_p)
1477     fputs_filtered (paddress (gdbarch, get_frame_pc (fi)), gdb_stdout);
1478   else
1479     fputs_filtered ("<unavailable>", gdb_stdout);
1480
1481   wrap_here ("   ");
1482   if (funname)
1483     {
1484       printf_filtered (" in ");
1485       fprintf_symbol_filtered (gdb_stdout, funname, funlang,
1486                                DMGL_ANSI | DMGL_PARAMS);
1487     }
1488   wrap_here ("   ");
1489   if (sal.symtab)
1490     printf_filtered (" (%s:%d)", symtab_to_filename_for_display (sal.symtab),
1491                      sal.line);
1492   puts_filtered ("; ");
1493   wrap_here ("    ");
1494   printf_filtered ("saved %s = ", pc_regname);
1495
1496   if (!frame_id_p (frame_unwind_caller_id (fi)))
1497     val_print_not_saved (gdb_stdout);
1498   else
1499     {
1500       TRY
1501         {
1502           caller_pc = frame_unwind_caller_pc (fi);
1503           caller_pc_p = 1;
1504         }
1505       CATCH (ex, RETURN_MASK_ERROR)
1506         {
1507           switch (ex.error)
1508             {
1509             case NOT_AVAILABLE_ERROR:
1510               val_print_unavailable (gdb_stdout);
1511               break;
1512             case OPTIMIZED_OUT_ERROR:
1513               val_print_not_saved (gdb_stdout);
1514               break;
1515             default:
1516               fprintf_filtered (gdb_stdout, _("<error: %s>"), ex.message);
1517               break;
1518             }
1519         }
1520       END_CATCH
1521     }
1522
1523   if (caller_pc_p)
1524     fputs_filtered (paddress (gdbarch, caller_pc), gdb_stdout);
1525   printf_filtered ("\n");
1526
1527   if (calling_frame_info == NULL)
1528     {
1529       enum unwind_stop_reason reason;
1530
1531       reason = get_frame_unwind_stop_reason (fi);
1532       if (reason != UNWIND_NO_REASON)
1533         printf_filtered (_(" Outermost frame: %s\n"),
1534                          frame_stop_reason_string (fi));
1535     }
1536   else if (get_frame_type (fi) == TAILCALL_FRAME)
1537     puts_filtered (" tail call frame");
1538   else if (get_frame_type (fi) == INLINE_FRAME)
1539     printf_filtered (" inlined into frame %d",
1540                      frame_relative_level (get_prev_frame (fi)));
1541   else
1542     {
1543       printf_filtered (" called by frame at ");
1544       fputs_filtered (paddress (gdbarch, get_frame_base (calling_frame_info)),
1545                       gdb_stdout);
1546     }
1547   if (get_next_frame (fi) && calling_frame_info)
1548     puts_filtered (",");
1549   wrap_here ("   ");
1550   if (get_next_frame (fi))
1551     {
1552       printf_filtered (" caller of frame at ");
1553       fputs_filtered (paddress (gdbarch, get_frame_base (get_next_frame (fi))),
1554                       gdb_stdout);
1555     }
1556   if (get_next_frame (fi) || calling_frame_info)
1557     puts_filtered ("\n");
1558
1559   if (s)
1560     printf_filtered (" source language %s.\n",
1561                      language_str (s->language));
1562
1563   {
1564     /* Address of the argument list for this frame, or 0.  */
1565     CORE_ADDR arg_list = get_frame_args_address (fi);
1566     /* Number of args for this frame, or -1 if unknown.  */
1567     int numargs;
1568
1569     if (arg_list == 0)
1570       printf_filtered (" Arglist at unknown address.\n");
1571     else
1572       {
1573         printf_filtered (" Arglist at ");
1574         fputs_filtered (paddress (gdbarch, arg_list), gdb_stdout);
1575         printf_filtered (",");
1576
1577         if (!gdbarch_frame_num_args_p (gdbarch))
1578           {
1579             numargs = -1;
1580             puts_filtered (" args: ");
1581           }
1582         else
1583           {
1584             numargs = gdbarch_frame_num_args (gdbarch, fi);
1585             gdb_assert (numargs >= 0);
1586             if (numargs == 0)
1587               puts_filtered (" no args.");
1588             else if (numargs == 1)
1589               puts_filtered (" 1 arg: ");
1590             else
1591               printf_filtered (" %d args: ", numargs);
1592           }
1593         print_frame_args (func, fi, numargs, gdb_stdout);
1594         puts_filtered ("\n");
1595       }
1596   }
1597   {
1598     /* Address of the local variables for this frame, or 0.  */
1599     CORE_ADDR arg_list = get_frame_locals_address (fi);
1600
1601     if (arg_list == 0)
1602       printf_filtered (" Locals at unknown address,");
1603     else
1604       {
1605         printf_filtered (" Locals at ");
1606         fputs_filtered (paddress (gdbarch, arg_list), gdb_stdout);
1607         printf_filtered (",");
1608       }
1609   }
1610
1611   /* Print as much information as possible on the location of all the
1612      registers.  */
1613   {
1614     int count;
1615     int i;
1616     int need_nl = 1;
1617     int sp_regnum = gdbarch_sp_regnum (gdbarch);
1618
1619     /* The sp is special; what's displayed isn't the save address, but
1620        the value of the previous frame's sp.  This is a legacy thing,
1621        at one stage the frame cached the previous frame's SP instead
1622        of its address, hence it was easiest to just display the cached
1623        value.  */
1624     if (sp_regnum >= 0)
1625       {
1626         struct value *value = frame_unwind_register_value (fi, sp_regnum);
1627         gdb_assert (value != NULL);
1628
1629         if (!value_optimized_out (value) && value_entirely_available (value))
1630           {
1631             if (VALUE_LVAL (value) == not_lval)
1632               {
1633                 CORE_ADDR sp;
1634                 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1635                 int sp_size = register_size (gdbarch, sp_regnum);
1636
1637                 sp = extract_unsigned_integer (value_contents_all (value),
1638                                                sp_size, byte_order);
1639
1640                 printf_filtered (" Previous frame's sp is ");
1641                 fputs_filtered (paddress (gdbarch, sp), gdb_stdout);
1642                 printf_filtered ("\n");
1643               }
1644             else if (VALUE_LVAL (value) == lval_memory)
1645               {
1646                 printf_filtered (" Previous frame's sp at ");
1647                 fputs_filtered (paddress (gdbarch, value_address (value)),
1648                                 gdb_stdout);
1649                 printf_filtered ("\n");
1650               }
1651             else if (VALUE_LVAL (value) == lval_register)
1652               {
1653                 printf_filtered (" Previous frame's sp in %s\n",
1654                                  gdbarch_register_name (gdbarch,
1655                                                         VALUE_REGNUM (value)));
1656               }
1657
1658             release_value (value);
1659             value_free (value);
1660             need_nl = 0;
1661           }
1662         /* else keep quiet.  */
1663       }
1664
1665     count = 0;
1666     numregs = gdbarch_num_regs (gdbarch)
1667               + gdbarch_num_pseudo_regs (gdbarch);
1668     for (i = 0; i < numregs; i++)
1669       if (i != sp_regnum
1670           && gdbarch_register_reggroup_p (gdbarch, i, all_reggroup))
1671         {
1672           enum lval_type lval;
1673           int optimized;
1674           int unavailable;
1675           CORE_ADDR addr;
1676           int realnum;
1677
1678           /* Find out the location of the saved register without
1679              fetching the corresponding value.  */
1680           frame_register_unwind (fi, i, &optimized, &unavailable,
1681                                  &lval, &addr, &realnum, NULL);
1682           /* For moment, only display registers that were saved on the
1683              stack.  */
1684           if (!optimized && !unavailable && lval == lval_memory)
1685             {
1686               if (count == 0)
1687                 puts_filtered (" Saved registers:\n ");
1688               else
1689                 puts_filtered (",");
1690               wrap_here (" ");
1691               printf_filtered (" %s at ",
1692                                gdbarch_register_name (gdbarch, i));
1693               fputs_filtered (paddress (gdbarch, addr), gdb_stdout);
1694               count++;
1695             }
1696         }
1697     if (count || need_nl)
1698       puts_filtered ("\n");
1699   }
1700
1701   do_cleanups (back_to);
1702 }
1703
1704 /* Print briefly all stack frames or just the innermost COUNT_EXP
1705    frames.  */
1706
1707 static void
1708 backtrace_command_1 (char *count_exp, int show_locals, int no_filters,
1709                      int from_tty)
1710 {
1711   struct frame_info *fi;
1712   int count;
1713   int i;
1714   struct frame_info *trailing;
1715   int trailing_level, py_start = 0, py_end = 0;
1716   enum ext_lang_bt_status result = EXT_LANG_BT_ERROR;
1717
1718   if (!target_has_stack)
1719     error (_("No stack."));
1720
1721   /* The following code must do two things.  First, it must set the
1722      variable TRAILING to the frame from which we should start
1723      printing.  Second, it must set the variable count to the number
1724      of frames which we should print, or -1 if all of them.  */
1725   trailing = get_current_frame ();
1726
1727   trailing_level = 0;
1728   if (count_exp)
1729     {
1730       count = parse_and_eval_long (count_exp);
1731       if (count < 0)
1732         {
1733           struct frame_info *current;
1734
1735           py_start = count;
1736           count = -count;
1737
1738           current = trailing;
1739           while (current && count--)
1740             {
1741               QUIT;
1742               current = get_prev_frame (current);
1743             }
1744
1745           /* Will stop when CURRENT reaches the top of the stack.
1746              TRAILING will be COUNT below it.  */
1747           while (current)
1748             {
1749               QUIT;
1750               trailing = get_prev_frame (trailing);
1751               current = get_prev_frame (current);
1752               trailing_level++;
1753             }
1754
1755           count = -1;
1756         }
1757       else
1758         {
1759           py_start = 0;
1760           py_end = count;
1761         }
1762     }
1763   else
1764     {
1765       py_end = -1;
1766       count = -1;
1767     }
1768
1769   if (info_verbose)
1770     {
1771       /* Read in symbols for all of the frames.  Need to do this in a
1772          separate pass so that "Reading in symbols for xxx" messages
1773          don't screw up the appearance of the backtrace.  Also if
1774          people have strong opinions against reading symbols for
1775          backtrace this may have to be an option.  */
1776       i = count;
1777       for (fi = trailing; fi != NULL && i--; fi = get_prev_frame (fi))
1778         {
1779           CORE_ADDR pc;
1780
1781           QUIT;
1782           pc = get_frame_address_in_block (fi);
1783           expand_symtab_containing_pc (pc, find_pc_mapped_section (pc));
1784         }
1785     }
1786
1787   if (! no_filters)
1788     {
1789       int flags = PRINT_LEVEL | PRINT_FRAME_INFO | PRINT_ARGS;
1790       enum ext_lang_frame_args arg_type;
1791
1792       if (show_locals)
1793         flags |= PRINT_LOCALS;
1794
1795       if (!strcmp (print_frame_arguments, "scalars"))
1796         arg_type = CLI_SCALAR_VALUES;
1797       else if (!strcmp (print_frame_arguments, "all"))
1798         arg_type = CLI_ALL_VALUES;
1799       else
1800         arg_type = NO_VALUES;
1801
1802       result = apply_ext_lang_frame_filter (get_current_frame (), flags,
1803                                             arg_type, current_uiout,
1804                                             py_start, py_end);
1805     }
1806
1807   /* Run the inbuilt backtrace if there are no filters registered, or
1808      "no-filters" has been specified from the command.  */
1809   if (no_filters ||  result == EXT_LANG_BT_NO_FILTERS)
1810     {
1811       for (i = 0, fi = trailing; fi && count--; i++, fi = get_prev_frame (fi))
1812         {
1813           QUIT;
1814
1815           /* Don't use print_stack_frame; if an error() occurs it probably
1816              means further attempts to backtrace would fail (on the other
1817              hand, perhaps the code does or could be fixed to make sure
1818              the frame->prev field gets set to NULL in that case).  */
1819
1820           print_frame_info (fi, 1, LOCATION, 1, 0);
1821           if (show_locals)
1822             {
1823               struct frame_id frame_id = get_frame_id (fi);
1824
1825               print_frame_local_vars (fi, 1, gdb_stdout);
1826
1827               /* print_frame_local_vars invalidates FI.  */
1828               fi = frame_find_by_id (frame_id);
1829               if (fi == NULL)
1830                 {
1831                   trailing = NULL;
1832                   warning (_("Unable to restore previously selected frame."));
1833                   break;
1834                 }
1835             }
1836
1837           /* Save the last frame to check for error conditions.  */
1838           trailing = fi;
1839         }
1840
1841       /* If we've stopped before the end, mention that.  */
1842       if (fi && from_tty)
1843         printf_filtered (_("(More stack frames follow...)\n"));
1844
1845       /* If we've run out of frames, and the reason appears to be an error
1846          condition, print it.  */
1847       if (fi == NULL && trailing != NULL)
1848         {
1849           enum unwind_stop_reason reason;
1850
1851           reason = get_frame_unwind_stop_reason (trailing);
1852           if (reason >= UNWIND_FIRST_ERROR)
1853             printf_filtered (_("Backtrace stopped: %s\n"),
1854                              frame_stop_reason_string (trailing));
1855         }
1856     }
1857 }
1858
1859 static void
1860 backtrace_command (char *arg, int from_tty)
1861 {
1862   struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1863   int fulltrace_arg = -1, arglen = 0, argc = 0, no_filters  = -1;
1864   int user_arg = 0;
1865
1866   if (arg)
1867     {
1868       char **argv;
1869       int i;
1870
1871       gdb_argv built_argv (arg);
1872       argv = built_argv.get ();
1873       argc = 0;
1874       for (i = 0; argv[i]; i++)
1875         {
1876           unsigned int j;
1877
1878           for (j = 0; j < strlen (argv[i]); j++)
1879             argv[i][j] = TOLOWER (argv[i][j]);
1880
1881           if (no_filters < 0 && subset_compare (argv[i], "no-filters"))
1882             no_filters = argc;
1883           else
1884             {
1885               if (fulltrace_arg < 0 && subset_compare (argv[i], "full"))
1886                 fulltrace_arg = argc;
1887               else
1888                 {
1889                   user_arg++;
1890                   arglen += strlen (argv[i]);
1891                 }
1892             }
1893           argc++;
1894         }
1895       arglen += user_arg;
1896       if (fulltrace_arg >= 0 || no_filters >= 0)
1897         {
1898           if (arglen > 0)
1899             {
1900               arg = (char *) xmalloc (arglen + 1);
1901               make_cleanup (xfree, arg);
1902               arg[0] = 0;
1903               for (i = 0; i < argc; i++)
1904                 {
1905                   if (i != fulltrace_arg && i != no_filters)
1906                     {
1907                       strcat (arg, argv[i]);
1908                       strcat (arg, " ");
1909                     }
1910                 }
1911             }
1912           else
1913             arg = NULL;
1914         }
1915     }
1916
1917   backtrace_command_1 (arg, fulltrace_arg >= 0 /* show_locals */,
1918                        no_filters >= 0 /* no frame-filters */, from_tty);
1919
1920   do_cleanups (old_chain);
1921 }
1922
1923 /* Iterate over the local variables of a block B, calling CB with
1924    CB_DATA.  */
1925
1926 static void
1927 iterate_over_block_locals (const struct block *b,
1928                            iterate_over_block_arg_local_vars_cb cb,
1929                            void *cb_data)
1930 {
1931   struct block_iterator iter;
1932   struct symbol *sym;
1933
1934   ALL_BLOCK_SYMBOLS (b, iter, sym)
1935     {
1936       switch (SYMBOL_CLASS (sym))
1937         {
1938         case LOC_LOCAL:
1939         case LOC_REGISTER:
1940         case LOC_STATIC:
1941         case LOC_COMPUTED:
1942           if (SYMBOL_IS_ARGUMENT (sym))
1943             break;
1944           if (SYMBOL_DOMAIN (sym) == COMMON_BLOCK_DOMAIN)
1945             break;
1946           (*cb) (SYMBOL_PRINT_NAME (sym), sym, cb_data);
1947           break;
1948
1949         default:
1950           /* Ignore symbols which are not locals.  */
1951           break;
1952         }
1953     }
1954 }
1955
1956
1957 /* Same, but print labels.  */
1958
1959 #if 0
1960 /* Commented out, as the code using this function has also been
1961    commented out.  FIXME:brobecker/2009-01-13: Find out why the code
1962    was commented out in the first place.  The discussion introducing
1963    this change (2007-12-04: Support lexical blocks and function bodies
1964    that occupy non-contiguous address ranges) did not explain why
1965    this change was made.  */
1966 static int
1967 print_block_frame_labels (struct gdbarch *gdbarch, struct block *b,
1968                           int *have_default, struct ui_file *stream)
1969 {
1970   struct block_iterator iter;
1971   struct symbol *sym;
1972   int values_printed = 0;
1973
1974   ALL_BLOCK_SYMBOLS (b, iter, sym)
1975     {
1976       if (strcmp (SYMBOL_LINKAGE_NAME (sym), "default") == 0)
1977         {
1978           if (*have_default)
1979             continue;
1980           *have_default = 1;
1981         }
1982       if (SYMBOL_CLASS (sym) == LOC_LABEL)
1983         {
1984           struct symtab_and_line sal;
1985           struct value_print_options opts;
1986
1987           sal = find_pc_line (SYMBOL_VALUE_ADDRESS (sym), 0);
1988           values_printed = 1;
1989           fputs_filtered (SYMBOL_PRINT_NAME (sym), stream);
1990           get_user_print_options (&opts);
1991           if (opts.addressprint)
1992             {
1993               fprintf_filtered (stream, " ");
1994               fputs_filtered (paddress (gdbarch, SYMBOL_VALUE_ADDRESS (sym)),
1995                               stream);
1996             }
1997           fprintf_filtered (stream, " in file %s, line %d\n",
1998                             sal.symtab->filename, sal.line);
1999         }
2000     }
2001
2002   return values_printed;
2003 }
2004 #endif
2005
2006 /* Iterate over all the local variables in block B, including all its
2007    superblocks, stopping when the top-level block is reached.  */
2008
2009 void
2010 iterate_over_block_local_vars (const struct block *block,
2011                                iterate_over_block_arg_local_vars_cb cb,
2012                                void *cb_data)
2013 {
2014   while (block)
2015     {
2016       iterate_over_block_locals (block, cb, cb_data);
2017       /* After handling the function's top-level block, stop.  Don't
2018          continue to its superblock, the block of per-file
2019          symbols.  */
2020       if (BLOCK_FUNCTION (block))
2021         break;
2022       block = BLOCK_SUPERBLOCK (block);
2023     }
2024 }
2025
2026 /* Data to be passed around in the calls to the locals and args
2027    iterators.  */
2028
2029 struct print_variable_and_value_data
2030 {
2031   struct frame_id frame_id;
2032   int num_tabs;
2033   struct ui_file *stream;
2034   int values_printed;
2035 };
2036
2037 /* The callback for the locals and args iterators.  */
2038
2039 static void
2040 do_print_variable_and_value (const char *print_name,
2041                              struct symbol *sym,
2042                              void *cb_data)
2043 {
2044   struct print_variable_and_value_data *p
2045     = (struct print_variable_and_value_data *) cb_data;
2046   struct frame_info *frame;
2047
2048   frame = frame_find_by_id (p->frame_id);
2049   if (frame == NULL)
2050     {
2051       warning (_("Unable to restore previously selected frame."));
2052       return;
2053     }
2054
2055   print_variable_and_value (print_name, sym, frame, p->stream, p->num_tabs);
2056
2057   /* print_variable_and_value invalidates FRAME.  */
2058   frame = NULL;
2059
2060   p->values_printed = 1;
2061 }
2062
2063 /* Print all variables from the innermost up to the function block of FRAME.
2064    Print them with values to STREAM indented by NUM_TABS.
2065
2066    This function will invalidate FRAME.  */
2067
2068 static void
2069 print_frame_local_vars (struct frame_info *frame, int num_tabs,
2070                         struct ui_file *stream)
2071 {
2072   struct print_variable_and_value_data cb_data;
2073   const struct block *block;
2074   CORE_ADDR pc;
2075   struct gdb_exception except = exception_none;
2076
2077   if (!get_frame_pc_if_available (frame, &pc))
2078     {
2079       fprintf_filtered (stream,
2080                         _("PC unavailable, cannot determine locals.\n"));
2081       return;
2082     }
2083
2084   block = get_frame_block (frame, 0);
2085   if (block == 0)
2086     {
2087       fprintf_filtered (stream, "No symbol table info available.\n");
2088       return;
2089     }
2090
2091   cb_data.frame_id = get_frame_id (frame);
2092   cb_data.num_tabs = 4 * num_tabs;
2093   cb_data.stream = stream;
2094   cb_data.values_printed = 0;
2095
2096   /* Temporarily change the selected frame to the given FRAME.
2097      This allows routines that rely on the selected frame instead
2098      of being given a frame as parameter to use the correct frame.  */
2099   select_frame (frame);
2100
2101   TRY
2102     {
2103       iterate_over_block_local_vars (block,
2104                                      do_print_variable_and_value,
2105                                      &cb_data);
2106     }
2107   CATCH (ex, RETURN_MASK_ALL)
2108     {
2109       except = ex;
2110     }
2111   END_CATCH
2112
2113   /* Restore the selected frame, and then rethrow if there was a problem.  */
2114   select_frame (frame_find_by_id (cb_data.frame_id));
2115   if (except.reason < 0)
2116     throw_exception (except);
2117
2118   /* do_print_variable_and_value invalidates FRAME.  */
2119   frame = NULL;
2120
2121   if (!cb_data.values_printed)
2122     fprintf_filtered (stream, _("No locals.\n"));
2123 }
2124
2125 void
2126 info_locals_command (char *args, int from_tty)
2127 {
2128   print_frame_local_vars (get_selected_frame (_("No frame selected.")),
2129                           0, gdb_stdout);
2130 }
2131
2132 /* Iterate over all the argument variables in block B.
2133
2134    Returns 1 if any argument was walked; 0 otherwise.  */
2135
2136 void
2137 iterate_over_block_arg_vars (const struct block *b,
2138                              iterate_over_block_arg_local_vars_cb cb,
2139                              void *cb_data)
2140 {
2141   struct block_iterator iter;
2142   struct symbol *sym, *sym2;
2143
2144   ALL_BLOCK_SYMBOLS (b, iter, sym)
2145     {
2146       /* Don't worry about things which aren't arguments.  */
2147       if (SYMBOL_IS_ARGUMENT (sym))
2148         {
2149           /* We have to look up the symbol because arguments can have
2150              two entries (one a parameter, one a local) and the one we
2151              want is the local, which lookup_symbol will find for us.
2152              This includes gcc1 (not gcc2) on the sparc when passing a
2153              small structure and gcc2 when the argument type is float
2154              and it is passed as a double and converted to float by
2155              the prologue (in the latter case the type of the LOC_ARG
2156              symbol is double and the type of the LOC_LOCAL symbol is
2157              float).  There are also LOC_ARG/LOC_REGISTER pairs which
2158              are not combined in symbol-reading.  */
2159
2160           sym2 = lookup_symbol (SYMBOL_LINKAGE_NAME (sym),
2161                                 b, VAR_DOMAIN, NULL).symbol;
2162           (*cb) (SYMBOL_PRINT_NAME (sym), sym2, cb_data);
2163         }
2164     }
2165 }
2166
2167 /* Print all argument variables of the function of FRAME.
2168    Print them with values to STREAM.
2169
2170    This function will invalidate FRAME.  */
2171
2172 static void
2173 print_frame_arg_vars (struct frame_info *frame, struct ui_file *stream)
2174 {
2175   struct print_variable_and_value_data cb_data;
2176   struct symbol *func;
2177   CORE_ADDR pc;
2178
2179   if (!get_frame_pc_if_available (frame, &pc))
2180     {
2181       fprintf_filtered (stream, _("PC unavailable, cannot determine args.\n"));
2182       return;
2183     }
2184
2185   func = get_frame_function (frame);
2186   if (func == NULL)
2187     {
2188       fprintf_filtered (stream, _("No symbol table info available.\n"));
2189       return;
2190     }
2191
2192   cb_data.frame_id = get_frame_id (frame);
2193   cb_data.num_tabs = 0;
2194   cb_data.stream = gdb_stdout;
2195   cb_data.values_printed = 0;
2196
2197   iterate_over_block_arg_vars (SYMBOL_BLOCK_VALUE (func),
2198                                do_print_variable_and_value, &cb_data);
2199
2200   /* do_print_variable_and_value invalidates FRAME.  */
2201   frame = NULL;
2202
2203   if (!cb_data.values_printed)
2204     fprintf_filtered (stream, _("No arguments.\n"));
2205 }
2206
2207 void
2208 info_args_command (char *ignore, int from_tty)
2209 {
2210   print_frame_arg_vars (get_selected_frame (_("No frame selected.")),
2211                         gdb_stdout);
2212 }
2213
2214 /* Select frame FRAME.  Also print the stack frame and show the source
2215    if this is the tui version.  */
2216 static void
2217 select_and_print_frame (struct frame_info *frame)
2218 {
2219   select_frame (frame);
2220   if (frame)
2221     print_stack_frame (frame, 1, SRC_AND_LOC, 1);
2222 }
2223 \f
2224 /* Return the symbol-block in which the selected frame is executing.
2225    Can return zero under various legitimate circumstances.
2226
2227    If ADDR_IN_BLOCK is non-zero, set *ADDR_IN_BLOCK to the relevant
2228    code address within the block returned.  We use this to decide
2229    which macros are in scope.  */
2230
2231 const struct block *
2232 get_selected_block (CORE_ADDR *addr_in_block)
2233 {
2234   if (!has_stack_frames ())
2235     return 0;
2236
2237   return get_frame_block (get_selected_frame (NULL), addr_in_block);
2238 }
2239
2240 /* Find a frame a certain number of levels away from FRAME.
2241    LEVEL_OFFSET_PTR points to an int containing the number of levels.
2242    Positive means go to earlier frames (up); negative, the reverse.
2243    The int that contains the number of levels is counted toward
2244    zero as the frames for those levels are found.
2245    If the top or bottom frame is reached, that frame is returned,
2246    but the final value of *LEVEL_OFFSET_PTR is nonzero and indicates
2247    how much farther the original request asked to go.  */
2248
2249 struct frame_info *
2250 find_relative_frame (struct frame_info *frame, int *level_offset_ptr)
2251 {
2252   /* Going up is simple: just call get_prev_frame enough times or
2253      until the initial frame is reached.  */
2254   while (*level_offset_ptr > 0)
2255     {
2256       struct frame_info *prev = get_prev_frame (frame);
2257
2258       if (!prev)
2259         break;
2260       (*level_offset_ptr)--;
2261       frame = prev;
2262     }
2263
2264   /* Going down is just as simple.  */
2265   while (*level_offset_ptr < 0)
2266     {
2267       struct frame_info *next = get_next_frame (frame);
2268
2269       if (!next)
2270         break;
2271       (*level_offset_ptr)++;
2272       frame = next;
2273     }
2274
2275   return frame;
2276 }
2277
2278 /* The "select_frame" command.  With no argument this is a NOP.
2279    Select the frame at level LEVEL_EXP if it is a valid level.
2280    Otherwise, treat LEVEL_EXP as an address expression and select it.
2281
2282    See parse_frame_specification for more info on proper frame
2283    expressions.  */
2284
2285 void
2286 select_frame_command (char *level_exp, int from_tty)
2287 {
2288   struct frame_info *prev_frame = get_selected_frame_if_set ();
2289
2290   select_frame (parse_frame_specification (level_exp, NULL));
2291   if (get_selected_frame_if_set () != prev_frame)
2292     observer_notify_user_selected_context_changed (USER_SELECTED_FRAME);
2293 }
2294
2295 /* The "frame" command.  With no argument, print the selected frame
2296    briefly.  With an argument, behave like select_frame and then print
2297    the selected frame.  */
2298
2299 static void
2300 frame_command (char *level_exp, int from_tty)
2301 {
2302   struct frame_info *prev_frame = get_selected_frame_if_set ();
2303
2304   select_frame (parse_frame_specification (level_exp, NULL));
2305   if (get_selected_frame_if_set () != prev_frame)
2306     observer_notify_user_selected_context_changed (USER_SELECTED_FRAME);
2307   else
2308     print_selected_thread_frame (current_uiout, USER_SELECTED_FRAME);
2309 }
2310
2311 /* Select the frame up one or COUNT_EXP stack levels from the
2312    previously selected frame, and print it briefly.  */
2313
2314 static void
2315 up_silently_base (const char *count_exp)
2316 {
2317   struct frame_info *frame;
2318   int count = 1;
2319
2320   if (count_exp)
2321     count = parse_and_eval_long (count_exp);
2322
2323   frame = find_relative_frame (get_selected_frame ("No stack."), &count);
2324   if (count != 0 && count_exp == NULL)
2325     error (_("Initial frame selected; you cannot go up."));
2326   select_frame (frame);
2327 }
2328
2329 static void
2330 up_silently_command (char *count_exp, int from_tty)
2331 {
2332   up_silently_base (count_exp);
2333 }
2334
2335 static void
2336 up_command (char *count_exp, int from_tty)
2337 {
2338   up_silently_base (count_exp);
2339   observer_notify_user_selected_context_changed (USER_SELECTED_FRAME);
2340 }
2341
2342 /* Select the frame down one or COUNT_EXP stack levels from the previously
2343    selected frame, and print it briefly.  */
2344
2345 static void
2346 down_silently_base (const char *count_exp)
2347 {
2348   struct frame_info *frame;
2349   int count = -1;
2350
2351   if (count_exp)
2352     count = -parse_and_eval_long (count_exp);
2353
2354   frame = find_relative_frame (get_selected_frame ("No stack."), &count);
2355   if (count != 0 && count_exp == NULL)
2356     {
2357       /* We only do this if COUNT_EXP is not specified.  That way
2358          "down" means to really go down (and let me know if that is
2359          impossible), but "down 9999" can be used to mean go all the
2360          way down without getting an error.  */
2361
2362       error (_("Bottom (innermost) frame selected; you cannot go down."));
2363     }
2364
2365   select_frame (frame);
2366 }
2367
2368 static void
2369 down_silently_command (char *count_exp, int from_tty)
2370 {
2371   down_silently_base (count_exp);
2372 }
2373
2374 static void
2375 down_command (char *count_exp, int from_tty)
2376 {
2377   down_silently_base (count_exp);
2378   observer_notify_user_selected_context_changed (USER_SELECTED_FRAME);
2379 }
2380
2381 void
2382 return_command (char *retval_exp, int from_tty)
2383 {
2384   /* Initialize it just to avoid a GCC false warning.  */
2385   enum return_value_convention rv_conv = RETURN_VALUE_STRUCT_CONVENTION;
2386   struct frame_info *thisframe;
2387   struct gdbarch *gdbarch;
2388   struct symbol *thisfun;
2389   struct value *return_value = NULL;
2390   struct value *function = NULL;
2391   const char *query_prefix = "";
2392
2393   thisframe = get_selected_frame ("No selected frame.");
2394   thisfun = get_frame_function (thisframe);
2395   gdbarch = get_frame_arch (thisframe);
2396
2397   if (get_frame_type (get_current_frame ()) == INLINE_FRAME)
2398     error (_("Can not force return from an inlined function."));
2399
2400   /* Compute the return value.  If the computation triggers an error,
2401      let it bail.  If the return type can't be handled, set
2402      RETURN_VALUE to NULL, and QUERY_PREFIX to an informational
2403      message.  */
2404   if (retval_exp)
2405     {
2406       expression_up retval_expr = parse_expression (retval_exp);
2407       struct type *return_type = NULL;
2408
2409       /* Compute the return value.  Should the computation fail, this
2410          call throws an error.  */
2411       return_value = evaluate_expression (retval_expr.get ());
2412
2413       /* Cast return value to the return type of the function.  Should
2414          the cast fail, this call throws an error.  */
2415       if (thisfun != NULL)
2416         return_type = TYPE_TARGET_TYPE (SYMBOL_TYPE (thisfun));
2417       if (return_type == NULL)
2418         {
2419           if (retval_expr->elts[0].opcode != UNOP_CAST
2420               && retval_expr->elts[0].opcode != UNOP_CAST_TYPE)
2421             error (_("Return value type not available for selected "
2422                      "stack frame.\n"
2423                      "Please use an explicit cast of the value to return."));
2424           return_type = value_type (return_value);
2425         }
2426       return_type = check_typedef (return_type);
2427       return_value = value_cast (return_type, return_value);
2428
2429       /* Make sure the value is fully evaluated.  It may live in the
2430          stack frame we're about to pop.  */
2431       if (value_lazy (return_value))
2432         value_fetch_lazy (return_value);
2433
2434       if (thisfun != NULL)
2435         function = read_var_value (thisfun, NULL, thisframe);
2436
2437       rv_conv = RETURN_VALUE_REGISTER_CONVENTION;
2438       if (TYPE_CODE (return_type) == TYPE_CODE_VOID)
2439         /* If the return-type is "void", don't try to find the
2440            return-value's location.  However, do still evaluate the
2441            return expression so that, even when the expression result
2442            is discarded, side effects such as "return i++" still
2443            occur.  */
2444         return_value = NULL;
2445       else if (thisfun != NULL)
2446         {
2447           rv_conv = struct_return_convention (gdbarch, function, return_type);
2448           if (rv_conv == RETURN_VALUE_STRUCT_CONVENTION
2449               || rv_conv == RETURN_VALUE_ABI_RETURNS_ADDRESS)
2450             {
2451               query_prefix = "The location at which to store the "
2452                 "function's return value is unknown.\n"
2453                 "If you continue, the return value "
2454                 "that you specified will be ignored.\n";
2455               return_value = NULL;
2456             }
2457         }
2458     }
2459
2460   /* Does an interactive user really want to do this?  Include
2461      information, such as how well GDB can handle the return value, in
2462      the query message.  */
2463   if (from_tty)
2464     {
2465       int confirmed;
2466
2467       if (thisfun == NULL)
2468         confirmed = query (_("%sMake selected stack frame return now? "),
2469                            query_prefix);
2470       else
2471         {
2472           if (TYPE_NO_RETURN (thisfun->type))
2473             warning (_("Function does not return normally to caller."));
2474           confirmed = query (_("%sMake %s return now? "), query_prefix,
2475                              SYMBOL_PRINT_NAME (thisfun));
2476         }
2477       if (!confirmed)
2478         error (_("Not confirmed"));
2479     }
2480
2481   /* Discard the selected frame and all frames inner-to it.  */
2482   frame_pop (get_selected_frame (NULL));
2483
2484   /* Store RETURN_VALUE in the just-returned register set.  */
2485   if (return_value != NULL)
2486     {
2487       struct type *return_type = value_type (return_value);
2488       struct gdbarch *gdbarch = get_regcache_arch (get_current_regcache ());
2489
2490       gdb_assert (rv_conv != RETURN_VALUE_STRUCT_CONVENTION
2491                   && rv_conv != RETURN_VALUE_ABI_RETURNS_ADDRESS);
2492       gdbarch_return_value (gdbarch, function, return_type,
2493                             get_current_regcache (), NULL /*read*/,
2494                             value_contents (return_value) /*write*/);
2495     }
2496
2497   /* If we are at the end of a call dummy now, pop the dummy frame
2498      too.  */
2499   if (get_frame_type (get_current_frame ()) == DUMMY_FRAME)
2500     frame_pop (get_current_frame ());
2501
2502   select_frame (get_current_frame ());
2503   /* If interactive, print the frame that is now current.  */
2504   if (from_tty)
2505     print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC, 1);
2506 }
2507
2508 /* Sets the scope to input function name, provided that the function
2509    is within the current stack frame.  */
2510
2511 struct function_bounds
2512 {
2513   CORE_ADDR low, high;
2514 };
2515
2516 static void
2517 func_command (char *arg, int from_tty)
2518 {
2519   struct frame_info *frame;
2520   int found = 0;
2521   int level = 1;
2522
2523   if (arg == NULL)
2524     return;
2525
2526   frame = get_current_frame ();
2527   std::vector<symtab_and_line> sals
2528     = decode_line_with_current_source (arg, DECODE_LINE_FUNFIRSTLINE);
2529   gdb::def_vector<function_bounds> func_bounds (sals.size ());
2530   for (size_t i = 0; (i < sals.size () && !found); i++)
2531     {
2532       if (sals[i].pspace != current_program_space)
2533         func_bounds[i].low = func_bounds[i].high = 0;
2534       else if (sals[i].pc == 0
2535                || find_pc_partial_function (sals[i].pc, NULL,
2536                                             &func_bounds[i].low,
2537                                             &func_bounds[i].high) == 0)
2538         {
2539           func_bounds[i].low = func_bounds[i].high = 0;
2540         }
2541     }
2542
2543   do
2544     {
2545       for (size_t i = 0; (i < sals.size () && !found); i++)
2546         found = (get_frame_pc (frame) >= func_bounds[i].low
2547                  && get_frame_pc (frame) < func_bounds[i].high);
2548       if (!found)
2549         {
2550           level = 1;
2551           frame = find_relative_frame (frame, &level);
2552         }
2553     }
2554   while (!found && level == 0);
2555
2556   if (!found)
2557     printf_filtered (_("'%s' not within current stack frame.\n"), arg);
2558   else if (frame != get_selected_frame (NULL))
2559     select_and_print_frame (frame);
2560 }
2561
2562 void
2563 _initialize_stack (void)
2564 {
2565   add_com ("return", class_stack, return_command, _("\
2566 Make selected stack frame return to its caller.\n\
2567 Control remains in the debugger, but when you continue\n\
2568 execution will resume in the frame above the one now selected.\n\
2569 If an argument is given, it is an expression for the value to return."));
2570
2571   add_com ("up", class_stack, up_command, _("\
2572 Select and print stack frame that called this one.\n\
2573 An argument says how many frames up to go."));
2574   add_com ("up-silently", class_support, up_silently_command, _("\
2575 Same as the `up' command, but does not print anything.\n\
2576 This is useful in command scripts."));
2577
2578   add_com ("down", class_stack, down_command, _("\
2579 Select and print stack frame called by this one.\n\
2580 An argument says how many frames down to go."));
2581   add_com_alias ("do", "down", class_stack, 1);
2582   add_com_alias ("dow", "down", class_stack, 1);
2583   add_com ("down-silently", class_support, down_silently_command, _("\
2584 Same as the `down' command, but does not print anything.\n\
2585 This is useful in command scripts."));
2586
2587   add_com ("frame", class_stack, frame_command, _("\
2588 Select and print a stack frame.\nWith no argument, \
2589 print the selected stack frame.  (See also \"info frame\").\n\
2590 An argument specifies the frame to select.\n\
2591 It can be a stack frame number or the address of the frame.\n"));
2592
2593   add_com_alias ("f", "frame", class_stack, 1);
2594
2595   add_com_suppress_notification ("select-frame", class_stack, select_frame_command, _("\
2596 Select a stack frame without printing anything.\n\
2597 An argument specifies the frame to select.\n\
2598 It can be a stack frame number or the address of the frame.\n"),
2599                  &cli_suppress_notification.user_selected_context);
2600
2601   add_com ("backtrace", class_stack, backtrace_command, _("\
2602 Print backtrace of all stack frames, or innermost COUNT frames.\n\
2603 With a negative argument, print outermost -COUNT frames.\nUse of the \
2604 'full' qualifier also prints the values of the local variables.\n\
2605 Use of the 'no-filters' qualifier prohibits frame filters from executing\n\
2606 on this backtrace.\n"));
2607   add_com_alias ("bt", "backtrace", class_stack, 0);
2608
2609   add_com_alias ("where", "backtrace", class_alias, 0);
2610   add_info ("stack", backtrace_command,
2611             _("Backtrace of the stack, or innermost COUNT frames."));
2612   add_info_alias ("s", "stack", 1);
2613   add_info ("frame", info_frame_command,
2614             _("All about selected stack frame, or frame at ADDR."));
2615   add_info_alias ("f", "frame", 1);
2616   add_info ("locals", info_locals_command,
2617             _("Local variables of current stack frame."));
2618   add_info ("args", info_args_command,
2619             _("Argument variables of current stack frame."));
2620
2621   if (dbx_commands)
2622     add_com ("func", class_stack, func_command, _("\
2623 Select the stack frame that contains <func>.\n\
2624 Usage: func <name>\n"));
2625
2626   add_setshow_enum_cmd ("frame-arguments", class_stack,
2627                         print_frame_arguments_choices, &print_frame_arguments,
2628                         _("Set printing of non-scalar frame arguments"),
2629                         _("Show printing of non-scalar frame arguments"),
2630                         NULL, NULL, NULL, &setprintlist, &showprintlist);
2631
2632   add_setshow_boolean_cmd ("frame-arguments", no_class,
2633                            &print_raw_frame_arguments, _("\
2634 Set whether to print frame arguments in raw form."), _("\
2635 Show whether to print frame arguments in raw form."), _("\
2636 If set, frame arguments are printed in raw form, bypassing any\n\
2637 pretty-printers for that value."),
2638                            NULL, NULL,
2639                            &setprintrawlist, &showprintrawlist);
2640
2641   add_setshow_auto_boolean_cmd ("disassemble-next-line", class_stack,
2642                                 &disassemble_next_line, _("\
2643 Set whether to disassemble next source line or insn when execution stops."),
2644                                 _("\
2645 Show whether to disassemble next source line or insn when execution stops."),
2646                                 _("\
2647 If ON, GDB will display disassembly of the next source line, in addition\n\
2648 to displaying the source line itself.  If the next source line cannot\n\
2649 be displayed (e.g., source is unavailable or there's no line info), GDB\n\
2650 will display disassembly of next instruction instead of showing the\n\
2651 source line.\n\
2652 If AUTO, display disassembly of next instruction only if the source line\n\
2653 cannot be displayed.\n\
2654 If OFF (which is the default), never display the disassembly of the next\n\
2655 source line."),
2656                                 NULL,
2657                                 show_disassemble_next_line,
2658                                 &setlist, &showlist);
2659   disassemble_next_line = AUTO_BOOLEAN_FALSE;
2660
2661   add_setshow_enum_cmd ("entry-values", class_stack,
2662                         print_entry_values_choices, &print_entry_values,
2663                         _("Set printing of function arguments at function "
2664                           "entry"),
2665                         _("Show printing of function arguments at function "
2666                           "entry"),
2667                         _("\
2668 GDB can sometimes determine the values of function arguments at entry,\n\
2669 in addition to their current values.  This option tells GDB whether\n\
2670 to print the current value, the value at entry (marked as val@entry),\n\
2671 or both.  Note that one or both of these values may be <optimized out>."),
2672                         NULL, NULL, &setprintlist, &showprintlist);
2673 }