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