Update years in copyright notice for the GDB files.
[platform/upstream/binutils.git] / gdb / stack.c
1 /* Print and select stack frames for GDB, the GNU debugger.
2
3    Copyright (C) 1986-2013 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)
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           ui_out_field_string (uiout, "fullname", fullname);
1193         }
1194       annotate_frame_source_file_end ();
1195       ui_out_text (uiout, ":");
1196       annotate_frame_source_line ();
1197       ui_out_field_int (uiout, "line", sal.line);
1198       annotate_frame_source_end ();
1199     }
1200
1201   if (pc_p && (funname == NULL || sal.symtab == NULL))
1202     {
1203 #ifdef PC_SOLIB
1204       char *lib = PC_SOLIB (get_frame_pc (frame));
1205 #else
1206       char *lib = solib_name_from_address (get_frame_program_space (frame),
1207                                            get_frame_pc (frame));
1208 #endif
1209       if (lib)
1210         {
1211           annotate_frame_where ();
1212           ui_out_wrap_hint (uiout, "  ");
1213           ui_out_text (uiout, " from ");
1214           ui_out_field_string (uiout, "from", lib);
1215         }
1216     }
1217
1218   /* do_cleanups will call ui_out_tuple_end() for us.  */
1219   do_cleanups (list_chain);
1220   ui_out_text (uiout, "\n");
1221   do_cleanups (old_chain);
1222 }
1223 \f
1224
1225 /* Read a frame specification in whatever the appropriate format is
1226    from FRAME_EXP.  Call error(), printing MESSAGE, if the
1227    specification is in any way invalid (so this function never returns
1228    NULL).  When SEPECTED_P is non-NULL set its target to indicate that
1229    the default selected frame was used.  */
1230
1231 static struct frame_info *
1232 parse_frame_specification_1 (const char *frame_exp, const char *message,
1233                              int *selected_frame_p)
1234 {
1235   int numargs;
1236   struct value *args[4];
1237   CORE_ADDR addrs[ARRAY_SIZE (args)];
1238
1239   if (frame_exp == NULL)
1240     numargs = 0;
1241   else
1242     {
1243       numargs = 0;
1244       while (1)
1245         {
1246           char *addr_string;
1247           struct cleanup *cleanup;
1248           const char *p;
1249
1250           /* Skip leading white space, bail of EOL.  */
1251           while (isspace (*frame_exp))
1252             frame_exp++;
1253           if (!*frame_exp)
1254             break;
1255
1256           /* Parse the argument, extract it, save it.  */
1257           for (p = frame_exp;
1258                *p && !isspace (*p);
1259                p++);
1260           addr_string = savestring (frame_exp, p - frame_exp);
1261           frame_exp = p;
1262           cleanup = make_cleanup (xfree, addr_string);
1263           
1264           /* NOTE: Parse and evaluate expression, but do not use
1265              functions such as parse_and_eval_long or
1266              parse_and_eval_address to also extract the value.
1267              Instead value_as_long and value_as_address are used.
1268              This avoids problems with expressions that contain
1269              side-effects.  */
1270           if (numargs >= ARRAY_SIZE (args))
1271             error (_("Too many args in frame specification"));
1272           args[numargs++] = parse_and_eval (addr_string);
1273
1274           do_cleanups (cleanup);
1275         }
1276     }
1277
1278   /* If no args, default to the selected frame.  */
1279   if (numargs == 0)
1280     {
1281       if (selected_frame_p != NULL)
1282         (*selected_frame_p) = 1;
1283       return get_selected_frame (message);
1284     }
1285
1286   /* None of the remaining use the selected frame.  */
1287   if (selected_frame_p != NULL)
1288     (*selected_frame_p) = 0;
1289
1290   /* Assume the single arg[0] is an integer, and try using that to
1291      select a frame relative to current.  */
1292   if (numargs == 1)
1293     {
1294       struct frame_info *fid;
1295       int level = value_as_long (args[0]);
1296
1297       fid = find_relative_frame (get_current_frame (), &level);
1298       if (level == 0)
1299         /* find_relative_frame was successful.  */
1300         return fid;
1301     }
1302
1303   /* Convert each value into a corresponding address.  */
1304   {
1305     int i;
1306
1307     for (i = 0; i < numargs; i++)
1308       addrs[i] = value_as_address (args[i]);
1309   }
1310
1311   /* Assume that the single arg[0] is an address, use that to identify
1312      a frame with a matching ID.  Should this also accept stack/pc or
1313      stack/pc/special.  */
1314   if (numargs == 1)
1315     {
1316       struct frame_id id = frame_id_build_wild (addrs[0]);
1317       struct frame_info *fid;
1318
1319       /* If (s)he specifies the frame with an address, he deserves
1320          what (s)he gets.  Still, give the highest one that matches.
1321          (NOTE: cagney/2004-10-29: Why highest, or outer-most, I don't
1322          know).  */
1323       for (fid = get_current_frame ();
1324            fid != NULL;
1325            fid = get_prev_frame (fid))
1326         {
1327           if (frame_id_eq (id, get_frame_id (fid)))
1328             {
1329               struct frame_info *prev_frame;
1330
1331               while (1)
1332                 {
1333                   prev_frame = get_prev_frame (fid);
1334                   if (!prev_frame
1335                       || !frame_id_eq (id, get_frame_id (prev_frame)))
1336                     break;
1337                   fid = prev_frame;
1338                 }
1339               return fid;
1340             }
1341         }
1342       }
1343
1344   /* We couldn't identify the frame as an existing frame, but
1345      perhaps we can create one with a single argument.  */
1346   if (numargs == 1)
1347     return create_new_frame (addrs[0], 0);
1348   else if (numargs == 2)
1349     return create_new_frame (addrs[0], addrs[1]);
1350   else
1351     error (_("Too many args in frame specification"));
1352 }
1353
1354 static struct frame_info *
1355 parse_frame_specification (char *frame_exp)
1356 {
1357   return parse_frame_specification_1 (frame_exp, NULL, NULL);
1358 }
1359
1360 /* Print verbosely the selected frame or the frame at address
1361    ADDR_EXP.  Absolutely all information in the frame is printed.  */
1362
1363 static void
1364 frame_info (char *addr_exp, int from_tty)
1365 {
1366   struct frame_info *fi;
1367   struct symtab_and_line sal;
1368   struct symbol *func;
1369   struct symtab *s;
1370   struct frame_info *calling_frame_info;
1371   int numregs;
1372   const char *funname = 0;
1373   enum language funlang = language_unknown;
1374   const char *pc_regname;
1375   int selected_frame_p;
1376   struct gdbarch *gdbarch;
1377   struct cleanup *back_to = make_cleanup (null_cleanup, NULL);
1378   CORE_ADDR frame_pc;
1379   int frame_pc_p;
1380   CORE_ADDR caller_pc;
1381
1382   fi = parse_frame_specification_1 (addr_exp, "No stack.", &selected_frame_p);
1383   gdbarch = get_frame_arch (fi);
1384
1385   /* Name of the value returned by get_frame_pc().  Per comments, "pc"
1386      is not a good name.  */
1387   if (gdbarch_pc_regnum (gdbarch) >= 0)
1388     /* OK, this is weird.  The gdbarch_pc_regnum hardware register's value can
1389        easily not match that of the internal value returned by
1390        get_frame_pc().  */
1391     pc_regname = gdbarch_register_name (gdbarch, gdbarch_pc_regnum (gdbarch));
1392   else
1393     /* But then, this is weird to.  Even without gdbarch_pc_regnum, an
1394        architectures will often have a hardware register called "pc",
1395        and that register's value, again, can easily not match
1396        get_frame_pc().  */
1397     pc_regname = "pc";
1398
1399   frame_pc_p = get_frame_pc_if_available (fi, &frame_pc);
1400   find_frame_sal (fi, &sal);
1401   func = get_frame_function (fi);
1402   s = sal.symtab;
1403   if (func)
1404     {
1405       funname = SYMBOL_PRINT_NAME (func);
1406       funlang = SYMBOL_LANGUAGE (func);
1407       if (funlang == language_cplus)
1408         {
1409           /* It seems appropriate to use SYMBOL_PRINT_NAME() here,
1410              to display the demangled name that we already have
1411              stored in the symbol table, but we stored a version
1412              with DMGL_PARAMS turned on, and here we don't want to
1413              display parameters.  So remove the parameters.  */
1414           char *func_only = cp_remove_params (funname);
1415
1416           if (func_only)
1417             {
1418               funname = func_only;
1419               make_cleanup (xfree, func_only);
1420             }
1421         }
1422     }
1423   else if (frame_pc_p)
1424     {
1425       struct minimal_symbol *msymbol;
1426
1427       msymbol = lookup_minimal_symbol_by_pc (frame_pc);
1428       if (msymbol != NULL)
1429         {
1430           funname = SYMBOL_PRINT_NAME (msymbol);
1431           funlang = SYMBOL_LANGUAGE (msymbol);
1432         }
1433     }
1434   calling_frame_info = get_prev_frame (fi);
1435
1436   if (selected_frame_p && frame_relative_level (fi) >= 0)
1437     {
1438       printf_filtered (_("Stack level %d, frame at "),
1439                        frame_relative_level (fi));
1440     }
1441   else
1442     {
1443       printf_filtered (_("Stack frame at "));
1444     }
1445   fputs_filtered (paddress (gdbarch, get_frame_base (fi)), gdb_stdout);
1446   printf_filtered (":\n");
1447   printf_filtered (" %s = ", pc_regname);
1448   if (frame_pc_p)
1449     fputs_filtered (paddress (gdbarch, get_frame_pc (fi)), gdb_stdout);
1450   else
1451     fputs_filtered ("<unavailable>", gdb_stdout);
1452
1453   wrap_here ("   ");
1454   if (funname)
1455     {
1456       printf_filtered (" in ");
1457       fprintf_symbol_filtered (gdb_stdout, funname, funlang,
1458                                DMGL_ANSI | DMGL_PARAMS);
1459     }
1460   wrap_here ("   ");
1461   if (sal.symtab)
1462     printf_filtered (" (%s:%d)", sal.symtab->filename, sal.line);
1463   puts_filtered ("; ");
1464   wrap_here ("    ");
1465   printf_filtered ("saved %s ", pc_regname);
1466   if (frame_unwind_caller_pc_if_available (fi, &caller_pc))
1467     fputs_filtered (paddress (gdbarch, caller_pc), gdb_stdout);
1468   else
1469     fputs_filtered ("<unavailable>", gdb_stdout);
1470   printf_filtered ("\n");
1471
1472   if (calling_frame_info == NULL)
1473     {
1474       enum unwind_stop_reason reason;
1475
1476       reason = get_frame_unwind_stop_reason (fi);
1477       if (reason != UNWIND_NO_REASON)
1478         printf_filtered (_(" Outermost frame: %s\n"),
1479                          frame_stop_reason_string (reason));
1480     }
1481   else if (get_frame_type (fi) == TAILCALL_FRAME)
1482     puts_filtered (" tail call frame");
1483   else if (get_frame_type (fi) == INLINE_FRAME)
1484     printf_filtered (" inlined into frame %d",
1485                      frame_relative_level (get_prev_frame (fi)));
1486   else
1487     {
1488       printf_filtered (" called by frame at ");
1489       fputs_filtered (paddress (gdbarch, get_frame_base (calling_frame_info)),
1490                       gdb_stdout);
1491     }
1492   if (get_next_frame (fi) && calling_frame_info)
1493     puts_filtered (",");
1494   wrap_here ("   ");
1495   if (get_next_frame (fi))
1496     {
1497       printf_filtered (" caller of frame at ");
1498       fputs_filtered (paddress (gdbarch, get_frame_base (get_next_frame (fi))),
1499                       gdb_stdout);
1500     }
1501   if (get_next_frame (fi) || calling_frame_info)
1502     puts_filtered ("\n");
1503
1504   if (s)
1505     printf_filtered (" source language %s.\n",
1506                      language_str (s->language));
1507
1508   {
1509     /* Address of the argument list for this frame, or 0.  */
1510     CORE_ADDR arg_list = get_frame_args_address (fi);
1511     /* Number of args for this frame, or -1 if unknown.  */
1512     int numargs;
1513
1514     if (arg_list == 0)
1515       printf_filtered (" Arglist at unknown address.\n");
1516     else
1517       {
1518         printf_filtered (" Arglist at ");
1519         fputs_filtered (paddress (gdbarch, arg_list), gdb_stdout);
1520         printf_filtered (",");
1521
1522         if (!gdbarch_frame_num_args_p (gdbarch))
1523           {
1524             numargs = -1;
1525             puts_filtered (" args: ");
1526           }
1527         else
1528           {
1529             numargs = gdbarch_frame_num_args (gdbarch, fi);
1530             gdb_assert (numargs >= 0);
1531             if (numargs == 0)
1532               puts_filtered (" no args.");
1533             else if (numargs == 1)
1534               puts_filtered (" 1 arg: ");
1535             else
1536               printf_filtered (" %d args: ", numargs);
1537           }
1538         print_frame_args (func, fi, numargs, gdb_stdout);
1539         puts_filtered ("\n");
1540       }
1541   }
1542   {
1543     /* Address of the local variables for this frame, or 0.  */
1544     CORE_ADDR arg_list = get_frame_locals_address (fi);
1545
1546     if (arg_list == 0)
1547       printf_filtered (" Locals at unknown address,");
1548     else
1549       {
1550         printf_filtered (" Locals at ");
1551         fputs_filtered (paddress (gdbarch, arg_list), gdb_stdout);
1552         printf_filtered (",");
1553       }
1554   }
1555
1556   /* Print as much information as possible on the location of all the
1557      registers.  */
1558   {
1559     enum lval_type lval;
1560     int optimized;
1561     int unavailable;
1562     CORE_ADDR addr;
1563     int realnum;
1564     int count;
1565     int i;
1566     int need_nl = 1;
1567
1568     /* The sp is special; what's displayed isn't the save address, but
1569        the value of the previous frame's sp.  This is a legacy thing,
1570        at one stage the frame cached the previous frame's SP instead
1571        of its address, hence it was easiest to just display the cached
1572        value.  */
1573     if (gdbarch_sp_regnum (gdbarch) >= 0)
1574       {
1575         /* Find out the location of the saved stack pointer with out
1576            actually evaluating it.  */
1577         frame_register_unwind (fi, gdbarch_sp_regnum (gdbarch),
1578                                &optimized, &unavailable, &lval, &addr,
1579                                &realnum, NULL);
1580         if (!optimized && !unavailable && lval == not_lval)
1581           {
1582             enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
1583             int sp_size = register_size (gdbarch, gdbarch_sp_regnum (gdbarch));
1584             gdb_byte value[MAX_REGISTER_SIZE];
1585             CORE_ADDR sp;
1586
1587             frame_register_unwind (fi, gdbarch_sp_regnum (gdbarch),
1588                                    &optimized, &unavailable, &lval, &addr,
1589                                    &realnum, value);
1590             /* NOTE: cagney/2003-05-22: This is assuming that the
1591                stack pointer was packed as an unsigned integer.  That
1592                may or may not be valid.  */
1593             sp = extract_unsigned_integer (value, sp_size, byte_order);
1594             printf_filtered (" Previous frame's sp is ");
1595             fputs_filtered (paddress (gdbarch, sp), gdb_stdout);
1596             printf_filtered ("\n");
1597             need_nl = 0;
1598           }
1599         else if (!optimized && !unavailable && lval == lval_memory)
1600           {
1601             printf_filtered (" Previous frame's sp at ");
1602             fputs_filtered (paddress (gdbarch, addr), gdb_stdout);
1603             printf_filtered ("\n");
1604             need_nl = 0;
1605           }
1606         else if (!optimized && !unavailable && lval == lval_register)
1607           {
1608             printf_filtered (" Previous frame's sp in %s\n",
1609                              gdbarch_register_name (gdbarch, realnum));
1610             need_nl = 0;
1611           }
1612         /* else keep quiet.  */
1613       }
1614
1615     count = 0;
1616     numregs = gdbarch_num_regs (gdbarch)
1617               + gdbarch_num_pseudo_regs (gdbarch);
1618     for (i = 0; i < numregs; i++)
1619       if (i != gdbarch_sp_regnum (gdbarch)
1620           && gdbarch_register_reggroup_p (gdbarch, i, all_reggroup))
1621         {
1622           /* Find out the location of the saved register without
1623              fetching the corresponding value.  */
1624           frame_register_unwind (fi, i, &optimized, &unavailable,
1625                                  &lval, &addr, &realnum, NULL);
1626           /* For moment, only display registers that were saved on the
1627              stack.  */
1628           if (!optimized && !unavailable && lval == lval_memory)
1629             {
1630               if (count == 0)
1631                 puts_filtered (" Saved registers:\n ");
1632               else
1633                 puts_filtered (",");
1634               wrap_here (" ");
1635               printf_filtered (" %s at ",
1636                                gdbarch_register_name (gdbarch, i));
1637               fputs_filtered (paddress (gdbarch, addr), gdb_stdout);
1638               count++;
1639             }
1640         }
1641     if (count || need_nl)
1642       puts_filtered ("\n");
1643   }
1644
1645   do_cleanups (back_to);
1646 }
1647
1648 /* Print briefly all stack frames or just the innermost COUNT_EXP
1649    frames.  */
1650
1651 static void
1652 backtrace_command_1 (char *count_exp, int show_locals, int from_tty)
1653 {
1654   struct frame_info *fi;
1655   int count;
1656   int i;
1657   struct frame_info *trailing;
1658   int trailing_level;
1659
1660   if (!target_has_stack)
1661     error (_("No stack."));
1662
1663   /* The following code must do two things.  First, it must set the
1664      variable TRAILING to the frame from which we should start
1665      printing.  Second, it must set the variable count to the number
1666      of frames which we should print, or -1 if all of them.  */
1667   trailing = get_current_frame ();
1668
1669   trailing_level = 0;
1670   if (count_exp)
1671     {
1672       count = parse_and_eval_long (count_exp);
1673       if (count < 0)
1674         {
1675           struct frame_info *current;
1676
1677           count = -count;
1678
1679           current = trailing;
1680           while (current && count--)
1681             {
1682               QUIT;
1683               current = get_prev_frame (current);
1684             }
1685
1686           /* Will stop when CURRENT reaches the top of the stack.
1687              TRAILING will be COUNT below it.  */
1688           while (current)
1689             {
1690               QUIT;
1691               trailing = get_prev_frame (trailing);
1692               current = get_prev_frame (current);
1693               trailing_level++;
1694             }
1695
1696           count = -1;
1697         }
1698     }
1699   else
1700     count = -1;
1701
1702   if (info_verbose)
1703     {
1704       /* Read in symbols for all of the frames.  Need to do this in a
1705          separate pass so that "Reading in symbols for xxx" messages
1706          don't screw up the appearance of the backtrace.  Also if
1707          people have strong opinions against reading symbols for
1708          backtrace this may have to be an option.  */
1709       i = count;
1710       for (fi = trailing; fi != NULL && i--; fi = get_prev_frame (fi))
1711         {
1712           CORE_ADDR pc;
1713
1714           QUIT;
1715           pc = get_frame_address_in_block (fi);
1716           find_pc_sect_symtab_via_partial (pc, find_pc_mapped_section (pc));
1717         }
1718     }
1719
1720   for (i = 0, fi = trailing; fi && count--; i++, fi = get_prev_frame (fi))
1721     {
1722       QUIT;
1723
1724       /* Don't use print_stack_frame; if an error() occurs it probably
1725          means further attempts to backtrace would fail (on the other
1726          hand, perhaps the code does or could be fixed to make sure
1727          the frame->prev field gets set to NULL in that case).  */
1728       print_frame_info (fi, 1, LOCATION, 1);
1729       if (show_locals)
1730         {
1731           struct frame_id frame_id = get_frame_id (fi);
1732
1733           print_frame_local_vars (fi, 1, gdb_stdout);
1734
1735           /* print_frame_local_vars invalidates FI.  */
1736           fi = frame_find_by_id (frame_id);
1737           if (fi == NULL)
1738             {
1739               trailing = NULL;
1740               warning (_("Unable to restore previously selected frame."));
1741               break;
1742             }
1743         }
1744
1745       /* Save the last frame to check for error conditions.  */
1746       trailing = fi;
1747     }
1748
1749   /* If we've stopped before the end, mention that.  */
1750   if (fi && from_tty)
1751     printf_filtered (_("(More stack frames follow...)\n"));
1752
1753   /* If we've run out of frames, and the reason appears to be an error
1754      condition, print it.  */
1755   if (fi == NULL && trailing != NULL)
1756     {
1757       enum unwind_stop_reason reason;
1758
1759       reason = get_frame_unwind_stop_reason (trailing);
1760       if (reason >= UNWIND_FIRST_ERROR)
1761         printf_filtered (_("Backtrace stopped: %s\n"),
1762                          frame_stop_reason_string (reason));
1763     }
1764 }
1765
1766 static void
1767 backtrace_command (char *arg, int from_tty)
1768 {
1769   struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1770   int fulltrace_arg = -1, arglen = 0, argc = 0;
1771
1772   if (arg)
1773     {
1774       char **argv;
1775       int i;
1776
1777       argv = gdb_buildargv (arg);
1778       make_cleanup_freeargv (argv);
1779       argc = 0;
1780       for (i = 0; argv[i]; i++)
1781         {
1782           unsigned int j;
1783
1784           for (j = 0; j < strlen (argv[i]); j++)
1785             argv[i][j] = tolower (argv[i][j]);
1786
1787           if (fulltrace_arg < 0 && subset_compare (argv[i], "full"))
1788             fulltrace_arg = argc;
1789           else
1790             {
1791               arglen += strlen (argv[i]);
1792               argc++;
1793             }
1794         }
1795       arglen += argc;
1796       if (fulltrace_arg >= 0)
1797         {
1798           if (arglen > 0)
1799             {
1800               arg = xmalloc (arglen + 1);
1801               make_cleanup (xfree, arg);
1802               arg[0] = 0;
1803               for (i = 0; i < (argc + 1); i++)
1804                 {
1805                   if (i != fulltrace_arg)
1806                     {
1807                       strcat (arg, argv[i]);
1808                       strcat (arg, " ");
1809                     }
1810                 }
1811             }
1812           else
1813             arg = NULL;
1814         }
1815     }
1816
1817   backtrace_command_1 (arg, fulltrace_arg >= 0 /* show_locals */, from_tty);
1818
1819   do_cleanups (old_chain);
1820 }
1821
1822 static void
1823 backtrace_full_command (char *arg, int from_tty)
1824 {
1825   backtrace_command_1 (arg, 1 /* show_locals */, from_tty);
1826 }
1827 \f
1828
1829 /* Iterate over the local variables of a block B, calling CB with
1830    CB_DATA.  */
1831
1832 static void
1833 iterate_over_block_locals (struct block *b,
1834                            iterate_over_block_arg_local_vars_cb cb,
1835                            void *cb_data)
1836 {
1837   struct block_iterator iter;
1838   struct symbol *sym;
1839
1840   ALL_BLOCK_SYMBOLS (b, iter, sym)
1841     {
1842       switch (SYMBOL_CLASS (sym))
1843         {
1844         case LOC_LOCAL:
1845         case LOC_REGISTER:
1846         case LOC_STATIC:
1847         case LOC_COMPUTED:
1848           if (SYMBOL_IS_ARGUMENT (sym))
1849             break;
1850           if (SYMBOL_DOMAIN (sym) == COMMON_BLOCK_DOMAIN)
1851             break;
1852           (*cb) (SYMBOL_PRINT_NAME (sym), sym, cb_data);
1853           break;
1854
1855         default:
1856           /* Ignore symbols which are not locals.  */
1857           break;
1858         }
1859     }
1860 }
1861
1862
1863 /* Same, but print labels.  */
1864
1865 #if 0
1866 /* Commented out, as the code using this function has also been
1867    commented out.  FIXME:brobecker/2009-01-13: Find out why the code
1868    was commented out in the first place.  The discussion introducing
1869    this change (2007-12-04: Support lexical blocks and function bodies
1870    that occupy non-contiguous address ranges) did not explain why
1871    this change was made.  */
1872 static int
1873 print_block_frame_labels (struct gdbarch *gdbarch, struct block *b,
1874                           int *have_default, struct ui_file *stream)
1875 {
1876   struct block_iterator iter;
1877   struct symbol *sym;
1878   int values_printed = 0;
1879
1880   ALL_BLOCK_SYMBOLS (b, iter, sym)
1881     {
1882       if (strcmp (SYMBOL_LINKAGE_NAME (sym), "default") == 0)
1883         {
1884           if (*have_default)
1885             continue;
1886           *have_default = 1;
1887         }
1888       if (SYMBOL_CLASS (sym) == LOC_LABEL)
1889         {
1890           struct symtab_and_line sal;
1891           struct value_print_options opts;
1892
1893           sal = find_pc_line (SYMBOL_VALUE_ADDRESS (sym), 0);
1894           values_printed = 1;
1895           fputs_filtered (SYMBOL_PRINT_NAME (sym), stream);
1896           get_user_print_options (&opts);
1897           if (opts.addressprint)
1898             {
1899               fprintf_filtered (stream, " ");
1900               fputs_filtered (paddress (gdbarch, SYMBOL_VALUE_ADDRESS (sym)),
1901                               stream);
1902             }
1903           fprintf_filtered (stream, " in file %s, line %d\n",
1904                             sal.symtab->filename, sal.line);
1905         }
1906     }
1907
1908   return values_printed;
1909 }
1910 #endif
1911
1912 /* Iterate over all the local variables in block B, including all its
1913    superblocks, stopping when the top-level block is reached.  */
1914
1915 void
1916 iterate_over_block_local_vars (struct block *block,
1917                                iterate_over_block_arg_local_vars_cb cb,
1918                                void *cb_data)
1919 {
1920   while (block)
1921     {
1922       iterate_over_block_locals (block, cb, cb_data);
1923       /* After handling the function's top-level block, stop.  Don't
1924          continue to its superblock, the block of per-file
1925          symbols.  */
1926       if (BLOCK_FUNCTION (block))
1927         break;
1928       block = BLOCK_SUPERBLOCK (block);
1929     }
1930 }
1931
1932 /* Data to be passed around in the calls to the locals and args
1933    iterators.  */
1934
1935 struct print_variable_and_value_data
1936 {
1937   struct frame_id frame_id;
1938   int num_tabs;
1939   struct ui_file *stream;
1940   int values_printed;
1941 };
1942
1943 /* The callback for the locals and args iterators.  */
1944
1945 static void
1946 do_print_variable_and_value (const char *print_name,
1947                              struct symbol *sym,
1948                              void *cb_data)
1949 {
1950   struct print_variable_and_value_data *p = cb_data;
1951   struct frame_info *frame;
1952
1953   frame = frame_find_by_id (p->frame_id);
1954   if (frame == NULL)
1955     {
1956       warning (_("Unable to restore previously selected frame."));
1957       return;
1958     }
1959
1960   print_variable_and_value (print_name, sym, frame, p->stream, p->num_tabs);
1961
1962   /* print_variable_and_value invalidates FRAME.  */
1963   frame = NULL;
1964
1965   p->values_printed = 1;
1966 }
1967
1968 /* Print all variables from the innermost up to the function block of FRAME.
1969    Print them with values to STREAM indented by NUM_TABS.
1970
1971    This function will invalidate FRAME.  */
1972
1973 static void
1974 print_frame_local_vars (struct frame_info *frame, int num_tabs,
1975                         struct ui_file *stream)
1976 {
1977   struct print_variable_and_value_data cb_data;
1978   struct block *block;
1979   CORE_ADDR pc;
1980
1981   if (!get_frame_pc_if_available (frame, &pc))
1982     {
1983       fprintf_filtered (stream,
1984                         _("PC unavailable, cannot determine locals.\n"));
1985       return;
1986     }
1987
1988   block = get_frame_block (frame, 0);
1989   if (block == 0)
1990     {
1991       fprintf_filtered (stream, "No symbol table info available.\n");
1992       return;
1993     }
1994
1995   cb_data.frame_id = get_frame_id (frame);
1996   cb_data.num_tabs = 4 * num_tabs;
1997   cb_data.stream = stream;
1998   cb_data.values_printed = 0;
1999
2000   iterate_over_block_local_vars (block,
2001                                  do_print_variable_and_value,
2002                                  &cb_data);
2003
2004   /* do_print_variable_and_value invalidates FRAME.  */
2005   frame = NULL;
2006
2007   if (!cb_data.values_printed)
2008     fprintf_filtered (stream, _("No locals.\n"));
2009 }
2010
2011 void
2012 locals_info (char *args, int from_tty)
2013 {
2014   print_frame_local_vars (get_selected_frame (_("No frame selected.")),
2015                           0, gdb_stdout);
2016 }
2017
2018 /* Iterate over all the argument variables in block B.
2019
2020    Returns 1 if any argument was walked; 0 otherwise.  */
2021
2022 void
2023 iterate_over_block_arg_vars (struct block *b,
2024                              iterate_over_block_arg_local_vars_cb cb,
2025                              void *cb_data)
2026 {
2027   struct block_iterator iter;
2028   struct symbol *sym, *sym2;
2029
2030   ALL_BLOCK_SYMBOLS (b, iter, sym)
2031     {
2032       /* Don't worry about things which aren't arguments.  */
2033       if (SYMBOL_IS_ARGUMENT (sym))
2034         {
2035           /* We have to look up the symbol because arguments can have
2036              two entries (one a parameter, one a local) and the one we
2037              want is the local, which lookup_symbol will find for us.
2038              This includes gcc1 (not gcc2) on the sparc when passing a
2039              small structure and gcc2 when the argument type is float
2040              and it is passed as a double and converted to float by
2041              the prologue (in the latter case the type of the LOC_ARG
2042              symbol is double and the type of the LOC_LOCAL symbol is
2043              float).  There are also LOC_ARG/LOC_REGISTER pairs which
2044              are not combined in symbol-reading.  */
2045
2046           sym2 = lookup_symbol (SYMBOL_LINKAGE_NAME (sym),
2047                                 b, VAR_DOMAIN, NULL);
2048           (*cb) (SYMBOL_PRINT_NAME (sym), sym2, cb_data);
2049         }
2050     }
2051 }
2052
2053 /* Print all argument variables of the function of FRAME.
2054    Print them with values to STREAM.
2055
2056    This function will invalidate FRAME.  */
2057
2058 static void
2059 print_frame_arg_vars (struct frame_info *frame, struct ui_file *stream)
2060 {
2061   struct print_variable_and_value_data cb_data;
2062   struct symbol *func;
2063   CORE_ADDR pc;
2064
2065   if (!get_frame_pc_if_available (frame, &pc))
2066     {
2067       fprintf_filtered (stream, _("PC unavailable, cannot determine args.\n"));
2068       return;
2069     }
2070
2071   func = get_frame_function (frame);
2072   if (func == NULL)
2073     {
2074       fprintf_filtered (stream, _("No symbol table info available.\n"));
2075       return;
2076     }
2077
2078   cb_data.frame_id = get_frame_id (frame);
2079   cb_data.num_tabs = 0;
2080   cb_data.stream = gdb_stdout;
2081   cb_data.values_printed = 0;
2082
2083   iterate_over_block_arg_vars (SYMBOL_BLOCK_VALUE (func),
2084                                do_print_variable_and_value, &cb_data);
2085
2086   /* do_print_variable_and_value invalidates FRAME.  */
2087   frame = NULL;
2088
2089   if (!cb_data.values_printed)
2090     fprintf_filtered (stream, _("No arguments.\n"));
2091 }
2092
2093 void
2094 args_info (char *ignore, int from_tty)
2095 {
2096   print_frame_arg_vars (get_selected_frame (_("No frame selected.")),
2097                         gdb_stdout);
2098 }
2099
2100
2101 static void
2102 args_plus_locals_info (char *ignore, int from_tty)
2103 {
2104   args_info (ignore, from_tty);
2105   locals_info (ignore, from_tty);
2106 }
2107 \f
2108
2109 /* Select frame FRAME.  Also print the stack frame and show the source
2110    if this is the tui version.  */
2111 static void
2112 select_and_print_frame (struct frame_info *frame)
2113 {
2114   select_frame (frame);
2115   if (frame)
2116     print_stack_frame (frame, 1, SRC_AND_LOC);
2117 }
2118 \f
2119 /* Return the symbol-block in which the selected frame is executing.
2120    Can return zero under various legitimate circumstances.
2121
2122    If ADDR_IN_BLOCK is non-zero, set *ADDR_IN_BLOCK to the relevant
2123    code address within the block returned.  We use this to decide
2124    which macros are in scope.  */
2125
2126 struct block *
2127 get_selected_block (CORE_ADDR *addr_in_block)
2128 {
2129   if (!has_stack_frames ())
2130     return 0;
2131
2132   return get_frame_block (get_selected_frame (NULL), addr_in_block);
2133 }
2134
2135 /* Find a frame a certain number of levels away from FRAME.
2136    LEVEL_OFFSET_PTR points to an int containing the number of levels.
2137    Positive means go to earlier frames (up); negative, the reverse.
2138    The int that contains the number of levels is counted toward
2139    zero as the frames for those levels are found.
2140    If the top or bottom frame is reached, that frame is returned,
2141    but the final value of *LEVEL_OFFSET_PTR is nonzero and indicates
2142    how much farther the original request asked to go.  */
2143
2144 struct frame_info *
2145 find_relative_frame (struct frame_info *frame, int *level_offset_ptr)
2146 {
2147   /* Going up is simple: just call get_prev_frame enough times or
2148      until the initial frame is reached.  */
2149   while (*level_offset_ptr > 0)
2150     {
2151       struct frame_info *prev = get_prev_frame (frame);
2152
2153       if (!prev)
2154         break;
2155       (*level_offset_ptr)--;
2156       frame = prev;
2157     }
2158
2159   /* Going down is just as simple.  */
2160   while (*level_offset_ptr < 0)
2161     {
2162       struct frame_info *next = get_next_frame (frame);
2163
2164       if (!next)
2165         break;
2166       (*level_offset_ptr)++;
2167       frame = next;
2168     }
2169
2170   return frame;
2171 }
2172
2173 /* The "select_frame" command.  With no argument this is a NOP.
2174    Select the frame at level LEVEL_EXP if it is a valid level.
2175    Otherwise, treat LEVEL_EXP as an address expression and select it.
2176
2177    See parse_frame_specification for more info on proper frame
2178    expressions.  */
2179
2180 void
2181 select_frame_command (char *level_exp, int from_tty)
2182 {
2183   select_frame (parse_frame_specification_1 (level_exp, "No stack.", NULL));
2184 }
2185
2186 /* The "frame" command.  With no argument, print the selected frame
2187    briefly.  With an argument, behave like select_frame and then print
2188    the selected frame.  */
2189
2190 static void
2191 frame_command (char *level_exp, int from_tty)
2192 {
2193   select_frame_command (level_exp, from_tty);
2194   print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
2195 }
2196
2197 /* The XDB Compatibility command to print the current frame.  */
2198
2199 static void
2200 current_frame_command (char *level_exp, int from_tty)
2201 {
2202   print_stack_frame (get_selected_frame (_("No stack.")), 1, SRC_AND_LOC);
2203 }
2204
2205 /* Select the frame up one or COUNT_EXP stack levels from the
2206    previously selected frame, and print it briefly.  */
2207
2208 static void
2209 up_silently_base (char *count_exp)
2210 {
2211   struct frame_info *frame;
2212   int count = 1;
2213
2214   if (count_exp)
2215     count = parse_and_eval_long (count_exp);
2216
2217   frame = find_relative_frame (get_selected_frame ("No stack."), &count);
2218   if (count != 0 && count_exp == NULL)
2219     error (_("Initial frame selected; you cannot go up."));
2220   select_frame (frame);
2221 }
2222
2223 static void
2224 up_silently_command (char *count_exp, int from_tty)
2225 {
2226   up_silently_base (count_exp);
2227 }
2228
2229 static void
2230 up_command (char *count_exp, int from_tty)
2231 {
2232   up_silently_base (count_exp);
2233   print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
2234 }
2235
2236 /* Select the frame down one or COUNT_EXP stack levels from the previously
2237    selected frame, and print it briefly.  */
2238
2239 static void
2240 down_silently_base (char *count_exp)
2241 {
2242   struct frame_info *frame;
2243   int count = -1;
2244
2245   if (count_exp)
2246     count = -parse_and_eval_long (count_exp);
2247
2248   frame = find_relative_frame (get_selected_frame ("No stack."), &count);
2249   if (count != 0 && count_exp == NULL)
2250     {
2251       /* We only do this if COUNT_EXP is not specified.  That way
2252          "down" means to really go down (and let me know if that is
2253          impossible), but "down 9999" can be used to mean go all the
2254          way down without getting an error.  */
2255
2256       error (_("Bottom (innermost) frame selected; you cannot go down."));
2257     }
2258
2259   select_frame (frame);
2260 }
2261
2262 static void
2263 down_silently_command (char *count_exp, int from_tty)
2264 {
2265   down_silently_base (count_exp);
2266 }
2267
2268 static void
2269 down_command (char *count_exp, int from_tty)
2270 {
2271   down_silently_base (count_exp);
2272   print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
2273 }
2274 \f
2275
2276 void
2277 return_command (char *retval_exp, int from_tty)
2278 {
2279   struct frame_info *thisframe;
2280   struct gdbarch *gdbarch;
2281   struct symbol *thisfun;
2282   struct value *return_value = NULL;
2283   struct value *function = NULL;
2284   const char *query_prefix = "";
2285
2286   thisframe = get_selected_frame ("No selected frame.");
2287   thisfun = get_frame_function (thisframe);
2288   gdbarch = get_frame_arch (thisframe);
2289
2290   if (get_frame_type (get_current_frame ()) == INLINE_FRAME)
2291     error (_("Can not force return from an inlined function."));
2292
2293   /* Compute the return value.  If the computation triggers an error,
2294      let it bail.  If the return type can't be handled, set
2295      RETURN_VALUE to NULL, and QUERY_PREFIX to an informational
2296      message.  */
2297   if (retval_exp)
2298     {
2299       struct expression *retval_expr = parse_expression (retval_exp);
2300       struct cleanup *old_chain = make_cleanup (xfree, retval_expr);
2301       struct type *return_type = NULL;
2302
2303       /* Compute the return value.  Should the computation fail, this
2304          call throws an error.  */
2305       return_value = evaluate_expression (retval_expr);
2306
2307       /* Cast return value to the return type of the function.  Should
2308          the cast fail, this call throws an error.  */
2309       if (thisfun != NULL)
2310         return_type = TYPE_TARGET_TYPE (SYMBOL_TYPE (thisfun));
2311       if (return_type == NULL)
2312         {
2313           if (retval_expr->elts[0].opcode != UNOP_CAST
2314               && retval_expr->elts[0].opcode != UNOP_CAST_TYPE)
2315             error (_("Return value type not available for selected "
2316                      "stack frame.\n"
2317                      "Please use an explicit cast of the value to return."));
2318           return_type = value_type (return_value);
2319         }
2320       do_cleanups (old_chain);
2321       CHECK_TYPEDEF (return_type);
2322       return_value = value_cast (return_type, return_value);
2323
2324       /* Make sure the value is fully evaluated.  It may live in the
2325          stack frame we're about to pop.  */
2326       if (value_lazy (return_value))
2327         value_fetch_lazy (return_value);
2328
2329       if (thisfun != NULL)
2330         function = read_var_value (thisfun, thisframe);
2331
2332       if (TYPE_CODE (return_type) == TYPE_CODE_VOID)
2333         /* If the return-type is "void", don't try to find the
2334            return-value's location.  However, do still evaluate the
2335            return expression so that, even when the expression result
2336            is discarded, side effects such as "return i++" still
2337            occur.  */
2338         return_value = NULL;
2339       else if (thisfun != NULL
2340                && using_struct_return (gdbarch, function, return_type))
2341         {
2342           query_prefix = "The location at which to store the "
2343             "function's return value is unknown.\n"
2344             "If you continue, the return value "
2345             "that you specified will be ignored.\n";
2346           return_value = NULL;
2347         }
2348     }
2349
2350   /* Does an interactive user really want to do this?  Include
2351      information, such as how well GDB can handle the return value, in
2352      the query message.  */
2353   if (from_tty)
2354     {
2355       int confirmed;
2356
2357       if (thisfun == NULL)
2358         confirmed = query (_("%sMake selected stack frame return now? "),
2359                            query_prefix);
2360       else
2361         confirmed = query (_("%sMake %s return now? "), query_prefix,
2362                            SYMBOL_PRINT_NAME (thisfun));
2363       if (!confirmed)
2364         error (_("Not confirmed"));
2365     }
2366
2367   /* Discard the selected frame and all frames inner-to it.  */
2368   frame_pop (get_selected_frame (NULL));
2369
2370   /* Store RETURN_VALUE in the just-returned register set.  */
2371   if (return_value != NULL)
2372     {
2373       struct type *return_type = value_type (return_value);
2374       struct gdbarch *gdbarch = get_regcache_arch (get_current_regcache ());
2375
2376       gdb_assert (gdbarch_return_value (gdbarch, function, return_type, NULL,
2377                                         NULL, NULL)
2378                   == RETURN_VALUE_REGISTER_CONVENTION);
2379       gdbarch_return_value (gdbarch, function, return_type,
2380                             get_current_regcache (), NULL /*read*/,
2381                             value_contents (return_value) /*write*/);
2382     }
2383
2384   /* If we are at the end of a call dummy now, pop the dummy frame
2385      too.  */
2386   if (get_frame_type (get_current_frame ()) == DUMMY_FRAME)
2387     frame_pop (get_current_frame ());
2388
2389   /* If interactive, print the frame that is now current.  */
2390   if (from_tty)
2391     frame_command ("0", 1);
2392   else
2393     select_frame_command ("0", 0);
2394 }
2395
2396 /* Sets the scope to input function name, provided that the function
2397    is within the current stack frame.  */
2398
2399 struct function_bounds
2400 {
2401   CORE_ADDR low, high;
2402 };
2403
2404 static void
2405 func_command (char *arg, int from_tty)
2406 {
2407   struct frame_info *frame;
2408   int found = 0;
2409   struct symtabs_and_lines sals;
2410   int i;
2411   int level = 1;
2412   struct function_bounds *func_bounds = NULL;
2413   struct cleanup *cleanups;
2414
2415   if (arg != NULL)
2416     return;
2417
2418   frame = parse_frame_specification ("0");
2419   sals = decode_line_with_current_source (arg, DECODE_LINE_FUNFIRSTLINE);
2420   cleanups = make_cleanup (xfree, sals.sals);
2421   func_bounds = (struct function_bounds *) xmalloc (
2422                               sizeof (struct function_bounds) * sals.nelts);
2423   make_cleanup (xfree, func_bounds);
2424   for (i = 0; (i < sals.nelts && !found); i++)
2425     {
2426       if (sals.sals[i].pspace != current_program_space)
2427         func_bounds[i].low = func_bounds[i].high = 0;
2428       else if (sals.sals[i].pc == 0
2429                || find_pc_partial_function (sals.sals[i].pc, NULL,
2430                                             &func_bounds[i].low,
2431                                             &func_bounds[i].high) == 0)
2432         {
2433           func_bounds[i].low = func_bounds[i].high = 0;
2434         }
2435     }
2436
2437   do
2438     {
2439       for (i = 0; (i < sals.nelts && !found); i++)
2440         found = (get_frame_pc (frame) >= func_bounds[i].low
2441                  && get_frame_pc (frame) < func_bounds[i].high);
2442       if (!found)
2443         {
2444           level = 1;
2445           frame = find_relative_frame (frame, &level);
2446         }
2447     }
2448   while (!found && level == 0);
2449
2450   do_cleanups (cleanups);
2451
2452   if (!found)
2453     printf_filtered (_("'%s' not within current stack frame.\n"), arg);
2454   else if (frame != get_selected_frame (NULL))
2455     select_and_print_frame (frame);
2456 }
2457
2458 /* Gets the language of the current frame.  */
2459
2460 enum language
2461 get_frame_language (void)
2462 {
2463   struct frame_info *frame = deprecated_safe_get_selected_frame ();
2464
2465   if (frame)
2466     {
2467       volatile struct gdb_exception ex;
2468       CORE_ADDR pc = 0;
2469       struct symtab *s;
2470
2471       /* We determine the current frame language by looking up its
2472          associated symtab.  To retrieve this symtab, we use the frame
2473          PC.  However we cannot use the frame PC as is, because it
2474          usually points to the instruction following the "call", which
2475          is sometimes the first instruction of another function.  So
2476          we rely on get_frame_address_in_block(), it provides us with
2477          a PC that is guaranteed to be inside the frame's code
2478          block.  */
2479
2480       TRY_CATCH (ex, RETURN_MASK_ERROR)
2481         {
2482           pc = get_frame_address_in_block (frame);
2483         }
2484       if (ex.reason < 0)
2485         {
2486           if (ex.error != NOT_AVAILABLE_ERROR)
2487             throw_exception (ex);
2488         }
2489       else
2490         {
2491           s = find_pc_symtab (pc);
2492           if (s != NULL)
2493             return s->language;
2494         }
2495     }
2496
2497   return language_unknown;
2498 }
2499 \f
2500
2501 /* Provide a prototype to silence -Wmissing-prototypes.  */
2502 void _initialize_stack (void);
2503
2504 void
2505 _initialize_stack (void)
2506 {
2507   add_com ("return", class_stack, return_command, _("\
2508 Make selected stack frame return to its caller.\n\
2509 Control remains in the debugger, but when you continue\n\
2510 execution will resume in the frame above the one now selected.\n\
2511 If an argument is given, it is an expression for the value to return."));
2512
2513   add_com ("up", class_stack, up_command, _("\
2514 Select and print stack frame that called this one.\n\
2515 An argument says how many frames up to go."));
2516   add_com ("up-silently", class_support, up_silently_command, _("\
2517 Same as the `up' command, but does not print anything.\n\
2518 This is useful in command scripts."));
2519
2520   add_com ("down", class_stack, down_command, _("\
2521 Select and print stack frame called by this one.\n\
2522 An argument says how many frames down to go."));
2523   add_com_alias ("do", "down", class_stack, 1);
2524   add_com_alias ("dow", "down", class_stack, 1);
2525   add_com ("down-silently", class_support, down_silently_command, _("\
2526 Same as the `down' command, but does not print anything.\n\
2527 This is useful in command scripts."));
2528
2529   add_com ("frame", class_stack, frame_command, _("\
2530 Select and print a stack frame.\nWith no argument, \
2531 print the selected stack frame.  (See also \"info frame\").\n\
2532 An argument specifies the frame to select.\n\
2533 It can be a stack frame number or the address of the frame.\n\
2534 With argument, nothing is printed if input is coming from\n\
2535 a command file or a user-defined command."));
2536
2537   add_com_alias ("f", "frame", class_stack, 1);
2538
2539   if (xdb_commands)
2540     {
2541       add_com ("L", class_stack, current_frame_command,
2542                _("Print the current stack frame.\n"));
2543       add_com_alias ("V", "frame", class_stack, 1);
2544     }
2545   add_com ("select-frame", class_stack, select_frame_command, _("\
2546 Select a stack frame without printing anything.\n\
2547 An argument specifies the frame to select.\n\
2548 It can be a stack frame number or the address of the frame.\n"));
2549
2550   add_com ("backtrace", class_stack, backtrace_command, _("\
2551 Print backtrace of all stack frames, or innermost COUNT frames.\n\
2552 With a negative argument, print outermost -COUNT frames.\nUse of the \
2553 'full' qualifier also prints the values of the local variables.\n"));
2554   add_com_alias ("bt", "backtrace", class_stack, 0);
2555   if (xdb_commands)
2556     {
2557       add_com_alias ("t", "backtrace", class_stack, 0);
2558       add_com ("T", class_stack, backtrace_full_command, _("\
2559 Print backtrace of all stack frames, or innermost COUNT frames\n\
2560 and the values of the local variables.\n\
2561 With a negative argument, print outermost -COUNT frames.\n\
2562 Usage: T <count>\n"));
2563     }
2564
2565   add_com_alias ("where", "backtrace", class_alias, 0);
2566   add_info ("stack", backtrace_command,
2567             _("Backtrace of the stack, or innermost COUNT frames."));
2568   add_info_alias ("s", "stack", 1);
2569   add_info ("frame", frame_info,
2570             _("All about selected stack frame, or frame at ADDR."));
2571   add_info_alias ("f", "frame", 1);
2572   add_info ("locals", locals_info,
2573             _("Local variables of current stack frame."));
2574   add_info ("args", args_info,
2575             _("Argument variables of current stack frame."));
2576   if (xdb_commands)
2577     add_com ("l", class_info, args_plus_locals_info,
2578              _("Argument and local variables of current stack frame."));
2579
2580   if (dbx_commands)
2581     add_com ("func", class_stack, func_command, _("\
2582 Select the stack frame that contains <func>.\n\
2583 Usage: func <name>\n"));
2584
2585   add_setshow_enum_cmd ("frame-arguments", class_stack,
2586                         print_frame_arguments_choices, &print_frame_arguments,
2587                         _("Set printing of non-scalar frame arguments"),
2588                         _("Show printing of non-scalar frame arguments"),
2589                         NULL, NULL, NULL, &setprintlist, &showprintlist);
2590
2591   add_setshow_auto_boolean_cmd ("disassemble-next-line", class_stack,
2592                                 &disassemble_next_line, _("\
2593 Set whether to disassemble next source line or insn when execution stops."),
2594                                 _("\
2595 Show whether to disassemble next source line or insn when execution stops."),
2596                                 _("\
2597 If ON, GDB will display disassembly of the next source line, in addition\n\
2598 to displaying the source line itself.  If the next source line cannot\n\
2599 be displayed (e.g., source is unavailable or there's no line info), GDB\n\
2600 will display disassembly of next instruction instead of showing the\n\
2601 source line.\n\
2602 If AUTO, display disassembly of next instruction only if the source line\n\
2603 cannot be displayed.\n\
2604 If OFF (which is the default), never display the disassembly of the next\n\
2605 source line."),
2606                                 NULL,
2607                                 show_disassemble_next_line,
2608                                 &setlist, &showlist);
2609   disassemble_next_line = AUTO_BOOLEAN_FALSE;
2610
2611   add_setshow_enum_cmd ("entry-values", class_stack,
2612                         print_entry_values_choices, &print_entry_values,
2613                         _("Set printing of function arguments at function "
2614                           "entry"),
2615                         _("Show printing of function arguments at function "
2616                           "entry"),
2617                         _("\
2618 GDB can sometimes determine the values of function arguments at entry,\n\
2619 in addition to their current values.  This option tells GDB whether\n\
2620 to print the current value, the value at entry (marked as val@entry),\n\
2621 or both.  Note that one or both of these values may be <optimized out>."),
2622                         NULL, NULL, &setprintlist, &showprintlist);
2623 }