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