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