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