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