2012-02-24 Pedro Alves <palves@redhat.com>
[platform/upstream/binutils.git] / gdb / stack.c
1 /* Print and select stack frames for GDB, the GNU debugger.
2
3    Copyright (C) 1986-2005, 2007-2012 Free Software Foundation, Inc.
4
5    This file is part of GDB.
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
19
20 #include "defs.h"
21 #include "value.h"
22 #include "symtab.h"
23 #include "gdbtypes.h"
24 #include "expression.h"
25 #include "language.h"
26 #include "frame.h"
27 #include "gdbcmd.h"
28 #include "gdbcore.h"
29 #include "target.h"
30 #include "source.h"
31 #include "breakpoint.h"
32 #include "demangle.h"
33 #include "inferior.h"
34 #include "annotate.h"
35 #include "ui-out.h"
36 #include "block.h"
37 #include "stack.h"
38 #include "dictionary.h"
39 #include "exceptions.h"
40 #include "reggroups.h"
41 #include "regcache.h"
42 #include "solib.h"
43 #include "valprint.h"
44 #include "gdbthread.h"
45 #include "cp-support.h"
46 #include "disasm.h"
47 #include "inline-frame.h"
48 #include "linespec.h"
49
50 #include "gdb_assert.h"
51 #include <ctype.h>
52 #include "gdb_string.h"
53
54 #include "psymtab.h"
55 #include "symfile.h"
56
57 void (*deprecated_selected_frame_level_changed_hook) (int);
58
59 /* The possible choices of "set print frame-arguments", and the value
60    of this setting.  */
61
62 static const char *const print_frame_arguments_choices[] =
63   {"all", "scalars", "none", NULL};
64 static const char *print_frame_arguments = "scalars";
65
66 /* The possible choices of "set print entry-values", and the value
67    of this setting.  */
68
69 const char print_entry_values_no[] = "no";
70 const char print_entry_values_only[] = "only";
71 const char print_entry_values_preferred[] = "preferred";
72 const char print_entry_values_if_needed[] = "if-needed";
73 const char print_entry_values_both[] = "both";
74 const char print_entry_values_compact[] = "compact";
75 const char print_entry_values_default[] = "default";
76 static const char *const print_entry_values_choices[] =
77 {
78   print_entry_values_no,
79   print_entry_values_only,
80   print_entry_values_preferred,
81   print_entry_values_if_needed,
82   print_entry_values_both,
83   print_entry_values_compact,
84   print_entry_values_default,
85   NULL
86 };
87 const char *print_entry_values = print_entry_values_default;
88
89 /* Prototypes for local functions.  */
90
91 static void print_frame_local_vars (struct frame_info *, int,
92                                     struct ui_file *);
93
94 static void print_frame (struct frame_info *frame, int print_level,
95                          enum print_what print_what,  int print_args,
96                          struct symtab_and_line sal);
97
98 static void set_last_displayed_sal (int valid,
99                                     struct program_space *pspace,
100                                     CORE_ADDR addr,
101                                     struct symtab *symtab,
102                                     int line);
103
104 /* Zero means do things normally; we are interacting directly with the
105    user.  One means print the full filename and linenumber when a
106    frame is printed, and do so in a format emacs18/emacs19.22 can
107    parse.  Two means print similar annotations, but in many more
108    cases and in a slightly different syntax.  */
109
110 int annotation_level = 0;
111
112 /* These variables hold the last symtab and line we displayed to the user.
113  * This is where we insert a breakpoint or a skiplist entry by default.  */
114 static int last_displayed_sal_valid = 0;
115 static struct program_space *last_displayed_pspace = 0;
116 static CORE_ADDR last_displayed_addr = 0;
117 static struct symtab *last_displayed_symtab = 0;
118 static int last_displayed_line = 0;
119 \f
120
121 /* Return 1 if we should display the address in addition to the location,
122    because we are in the middle of a statement.  */
123
124 static int
125 frame_show_address (struct frame_info *frame,
126                     struct symtab_and_line sal)
127 {
128   /* If there is a line number, but no PC, then there is no location
129      information associated with this sal.  The only way that should
130      happen is for the call sites of inlined functions (SAL comes from
131      find_frame_sal).  Otherwise, we would have some PC range if the
132      SAL came from a line table.  */
133   if (sal.line != 0 && sal.pc == 0 && sal.end == 0)
134     {
135       if (get_next_frame (frame) == NULL)
136         gdb_assert (inline_skipped_frames (inferior_ptid) > 0);
137       else
138         gdb_assert (get_frame_type (get_next_frame (frame)) == INLINE_FRAME);
139       return 0;
140     }
141
142   return get_frame_pc (frame) != sal.pc;
143 }
144
145 /* Show or print a stack frame FRAME briefly.  The output is format
146    according to PRINT_LEVEL and PRINT_WHAT printing the frame's
147    relative level, function name, argument list, and file name and
148    line number.  If the frame's PC is not at the beginning of the
149    source line, the actual PC is printed at the beginning.  */
150
151 void
152 print_stack_frame (struct frame_info *frame, int print_level,
153                    enum print_what print_what)
154 {
155   volatile struct gdb_exception e;
156
157   /* For mi, alway print location and address.  */
158   if (ui_out_is_mi_like_p (current_uiout))
159     print_what = LOC_AND_ADDRESS;
160
161   TRY_CATCH (e, RETURN_MASK_ERROR)
162     {
163       int center = (print_what == SRC_LINE || print_what == SRC_AND_LOC);
164
165       print_frame_info (frame, print_level, print_what, 1 /* print_args */);
166       set_current_sal_from_frame (frame, center);
167     }
168 }
169
170 /* Print nameless arguments of frame FRAME on STREAM, where START is
171    the offset of the first nameless argument, and NUM is the number of
172    nameless arguments to print.  FIRST is nonzero if this is the first
173    argument (not just the first nameless argument).  */
174
175 static void
176 print_frame_nameless_args (struct frame_info *frame, long start, int num,
177                            int first, struct ui_file *stream)
178 {
179   struct gdbarch *gdbarch = get_frame_arch (frame);
180   enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
181   int i;
182   CORE_ADDR argsaddr;
183   long arg_value;
184
185   for (i = 0; i < num; i++)
186     {
187       QUIT;
188       argsaddr = get_frame_args_address (frame);
189       if (!argsaddr)
190         return;
191       arg_value = read_memory_integer (argsaddr + start,
192                                        sizeof (int), byte_order);
193       if (!first)
194         fprintf_filtered (stream, ", ");
195       fprintf_filtered (stream, "%ld", arg_value);
196       first = 0;
197       start += sizeof (int);
198     }
199 }
200
201 /* Print single argument of inferior function.  ARG must be already
202    read in.
203
204    Errors are printed as if they would be the parameter value.  Use zeroed ARG
205    iff it should not be printed accoring to user settings.  */
206
207 static void
208 print_frame_arg (const struct frame_arg *arg)
209 {
210   struct ui_out *uiout = current_uiout;
211   volatile struct gdb_exception except;
212   struct cleanup *old_chain;
213   struct ui_stream *stb;
214
215   stb = ui_out_stream_new (uiout);
216   old_chain = make_cleanup_ui_out_stream_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->stream, 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->stream);
234
235       fprintf_symbol_filtered (stb->stream, 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->stream);
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->stream, 2, &opts, language);
283             }
284         }
285       if (except.message)
286         fprintf_filtered (stb->stream, _("<error reading variable: %s>"),
287                           except.message);
288     }
289
290   ui_out_field_stream (uiout, "value", stb);
291
292   /* Aleo 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               unsigned len = TYPE_LENGTH (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, len))
365                 {
366                   /* Initialize it just to avoid a GCC false warning.  */
367                   struct value *val_deref = NULL, *entryval_deref;
368
369                   /* DW_AT_GNU_call_site_value does match with the current
370                      value.  If it is a reference still try to verify if
371                      dereferenced DW_AT_GNU_call_site_data_value does not
372                      differ.  */
373
374                   TRY_CATCH (except, RETURN_MASK_ERROR)
375                     {
376                       unsigned len_deref;
377
378                       val_deref = coerce_ref (val);
379                       if (value_lazy (val_deref))
380                         value_fetch_lazy (val_deref);
381                       len_deref = TYPE_LENGTH (value_type (val_deref));
382
383                       entryval_deref = coerce_ref (entryval);
384                       if (value_lazy (entryval_deref))
385                         value_fetch_lazy (entryval_deref);
386
387                       /* If the reference addresses match but dereferenced
388                          content does not match print them.  */
389                       if (val != val_deref
390                           && value_available_contents_eq (val_deref, 0,
391                                                           entryval_deref, 0,
392                                                           len_deref))
393                         val_equal = 1;
394                     }
395
396                   /* Value was not a reference; and its content matches.  */
397                   if (val == val_deref)
398                     val_equal = 1;
399                   /* If the dereferenced content could not be fetched do not
400                      display anything.  */
401                   else if (except.error == NO_ENTRY_VALUE_ERROR)
402                     val_equal = 1;
403                   else if (except.message)
404                     {
405                       entryval_error = alloca (strlen (except.message) + 1);
406                       strcpy (entryval_error, except.message);
407                     }
408
409                   if (val_equal)
410                     entryval = NULL;
411                 }
412             }
413
414           /* Try to remove possibly duplicate error message for ENTRYARGP even
415              in MI mode.  */
416
417           if (val_error && entryval_error
418               && strcmp (val_error, entryval_error) == 0)
419             {
420               entryval_error = NULL;
421
422               /* Do not se VAL_EQUAL as the same error message may be shown for
423                  the entry value even if no entry values are present in the
424                  inferior.  */
425             }
426         }
427     }
428
429   if (entryval == NULL)
430     {
431       if (print_entry_values == print_entry_values_preferred)
432         {
433           TRY_CATCH (except, RETURN_MASK_ERROR)
434             {
435               val = read_var_value (sym, frame);
436             }
437           if (!val)
438             {
439               val_error = alloca (strlen (except.message) + 1);
440               strcpy (val_error, except.message);
441             }
442         }
443       if (print_entry_values == print_entry_values_only
444           || print_entry_values == print_entry_values_both
445           || (print_entry_values == print_entry_values_preferred
446               && (!val || value_optimized_out (val))))
447         entryval = allocate_optimized_out_value (SYMBOL_TYPE (sym));
448     }
449   if ((print_entry_values == print_entry_values_compact
450        || print_entry_values == print_entry_values_if_needed
451        || print_entry_values == print_entry_values_preferred)
452       && (!val || value_optimized_out (val)) && entryval != NULL)
453     {
454       val = NULL;
455       val_error = NULL;
456     }
457
458   argp->sym = sym;
459   argp->val = val;
460   argp->error = val_error ? xstrdup (val_error) : NULL;
461   if (!val && !val_error)
462     argp->entry_kind = print_entry_values_only;
463   else if ((print_entry_values == print_entry_values_compact
464            || print_entry_values == print_entry_values_default) && val_equal)
465     {
466       argp->entry_kind = print_entry_values_compact;
467       gdb_assert (!ui_out_is_mi_like_p (current_uiout));
468     }
469   else
470     argp->entry_kind = print_entry_values_no;
471
472   entryargp->sym = sym;
473   entryargp->val = entryval;
474   entryargp->error = entryval_error ? xstrdup (entryval_error) : NULL;
475   if (!entryval && !entryval_error)
476     entryargp->entry_kind = print_entry_values_no;
477   else
478     entryargp->entry_kind = print_entry_values_only;
479 }
480
481 /* Print the arguments of frame FRAME on STREAM, given the function
482    FUNC running in that frame (as a symbol), where NUM is the number
483    of arguments according to the stack frame (or -1 if the number of
484    arguments is unknown).  */
485
486 /* Note that currently the "number of arguments according to the
487    stack frame" is only known on VAX where i refers to the "number of
488    ints of arguments according to the stack frame".  */
489
490 static void
491 print_frame_args (struct symbol *func, struct frame_info *frame,
492                   int num, struct ui_file *stream)
493 {
494   struct ui_out *uiout = current_uiout;
495   int first = 1;
496   /* Offset of next stack argument beyond the one we have seen that is
497      at the highest offset, or -1 if we haven't come to a stack
498      argument yet.  */
499   long highest_offset = -1;
500   /* Number of ints of arguments that we have printed so far.  */
501   int args_printed = 0;
502   struct cleanup *old_chain, *list_chain;
503   struct ui_stream *stb;
504   /* True if we should print arguments, false otherwise.  */
505   int print_args = strcmp (print_frame_arguments, "none");
506   /* True in "summary" mode, false otherwise.  */
507   int summary = !strcmp (print_frame_arguments, "scalars");
508
509   stb = ui_out_stream_new (uiout);
510   old_chain = make_cleanup_ui_out_stream_delete (stb);
511
512   if (func)
513     {
514       struct block *b = SYMBOL_BLOCK_VALUE (func);
515       struct dict_iterator iter;
516       struct symbol *sym;
517
518       ALL_BLOCK_SYMBOLS (b, iter, sym)
519         {
520           struct frame_arg arg, entryarg;
521
522           QUIT;
523
524           /* Keep track of the highest stack argument offset seen, and
525              skip over any kinds of symbols we don't care about.  */
526
527           if (!SYMBOL_IS_ARGUMENT (sym))
528             continue;
529
530           switch (SYMBOL_CLASS (sym))
531             {
532             case LOC_ARG:
533             case LOC_REF_ARG:
534               {
535                 long current_offset = SYMBOL_VALUE (sym);
536                 int arg_size = TYPE_LENGTH (SYMBOL_TYPE (sym));
537
538                 /* Compute address of next argument by adding the size of
539                    this argument and rounding to an int boundary.  */
540                 current_offset =
541                   ((current_offset + arg_size + sizeof (int) - 1)
542                    & ~(sizeof (int) - 1));
543
544                 /* If this is the highest offset seen yet, set
545                    highest_offset.  */
546                 if (highest_offset == -1
547                     || (current_offset > highest_offset))
548                   highest_offset = current_offset;
549
550                 /* Add the number of ints we're about to print to
551                    args_printed.  */
552                 args_printed += (arg_size + sizeof (int) - 1) / sizeof (int);
553               }
554
555               /* We care about types of symbols, but don't need to
556                  keep track of stack offsets in them.  */
557             case LOC_REGISTER:
558             case LOC_REGPARM_ADDR:
559             case LOC_COMPUTED:
560             case LOC_OPTIMIZED_OUT:
561             default:
562               break;
563             }
564
565           /* We have to look up the symbol because arguments can have
566              two entries (one a parameter, one a local) and the one we
567              want is the local, which lookup_symbol will find for us.
568              This includes gcc1 (not gcc2) on SPARC when passing a
569              small structure and gcc2 when the argument type is float
570              and it is passed as a double and converted to float by
571              the prologue (in the latter case the type of the LOC_ARG
572              symbol is double and the type of the LOC_LOCAL symbol is
573              float).  */
574           /* But if the parameter name is null, don't try it.  Null
575              parameter names occur on the RS/6000, for traceback
576              tables.  FIXME, should we even print them?  */
577
578           if (*SYMBOL_LINKAGE_NAME (sym))
579             {
580               struct symbol *nsym;
581
582               nsym = lookup_symbol (SYMBOL_LINKAGE_NAME (sym),
583                                     b, VAR_DOMAIN, NULL);
584               gdb_assert (nsym != NULL);
585               if (SYMBOL_CLASS (nsym) == LOC_REGISTER
586                   && !SYMBOL_IS_ARGUMENT (nsym))
587                 {
588                   /* There is a LOC_ARG/LOC_REGISTER pair.  This means
589                      that it was passed on the stack and loaded into a
590                      register, or passed in a register and stored in a
591                      stack slot.  GDB 3.x used the LOC_ARG; GDB
592                      4.0-4.11 used the LOC_REGISTER.
593
594                      Reasons for using the LOC_ARG:
595
596                      (1) Because find_saved_registers may be slow for
597                          remote debugging.
598
599                      (2) Because registers are often re-used and stack
600                          slots rarely (never?) are.  Therefore using
601                          the stack slot is much less likely to print
602                          garbage.
603
604                      Reasons why we might want to use the LOC_REGISTER:
605
606                      (1) So that the backtrace prints the same value
607                          as "print foo".  I see no compelling reason
608                          why this needs to be the case; having the
609                          backtrace print the value which was passed
610                          in, and "print foo" print the value as
611                          modified within the called function, makes
612                          perfect sense to me.
613
614                      Additional note: It might be nice if "info args"
615                      displayed both values.
616
617                      One more note: There is a case with SPARC
618                      structure passing where we need to use the
619                      LOC_REGISTER, but this is dealt with by creating
620                      a single LOC_REGPARM in symbol reading.  */
621
622                   /* Leave sym (the LOC_ARG) alone.  */
623                   ;
624                 }
625               else
626                 sym = nsym;
627             }
628
629           /* Print the current arg.  */
630           if (!first)
631             ui_out_text (uiout, ", ");
632           ui_out_wrap_hint (uiout, "    ");
633
634           if (!print_args)
635             {
636               memset (&arg, 0, sizeof (arg));
637               arg.sym = sym;
638               arg.entry_kind = print_entry_values_no;
639               memset (&entryarg, 0, sizeof (entryarg));
640               entryarg.sym = sym;
641               entryarg.entry_kind = print_entry_values_no;
642             }
643           else
644             read_frame_arg (sym, frame, &arg, &entryarg);
645
646           if (arg.entry_kind != print_entry_values_only)
647             print_frame_arg (&arg);
648
649           if (entryarg.entry_kind != print_entry_values_no)
650             {
651               if (arg.entry_kind != print_entry_values_only)
652                 {
653                   ui_out_text (uiout, ", ");
654                   ui_out_wrap_hint (uiout, "    ");
655                 }
656
657               print_frame_arg (&entryarg);
658             }
659
660           xfree (arg.error);
661           xfree (entryarg.error);
662
663           first = 0;
664         }
665     }
666
667   /* Don't print nameless args in situations where we don't know
668      enough about the stack to find them.  */
669   if (num != -1)
670     {
671       long start;
672
673       if (highest_offset == -1)
674         start = gdbarch_frame_args_skip (get_frame_arch (frame));
675       else
676         start = highest_offset;
677
678       print_frame_nameless_args (frame, start, num - args_printed,
679                                  first, stream);
680     }
681
682   do_cleanups (old_chain);
683 }
684
685 /* Set the current source and line to the location given by frame
686    FRAME, if possible.  When CENTER is true, adjust so the relevant
687    line is in the center of the next 'list'.  */
688
689 void
690 set_current_sal_from_frame (struct frame_info *frame, int center)
691 {
692   struct symtab_and_line sal;
693
694   find_frame_sal (frame, &sal);
695   if (sal.symtab)
696     {
697       if (center)
698         sal.line = max (sal.line - get_lines_to_list () / 2, 1);
699       set_current_source_symtab_and_line (&sal);
700     }
701 }
702
703 /* If ON, GDB will display disassembly of the next source line when
704    execution of the program being debugged stops.
705    If AUTO (which is the default), or there's no line info to determine
706    the source line of the next instruction, display disassembly of next
707    instruction instead.  */
708
709 static enum auto_boolean disassemble_next_line;
710
711 static void
712 show_disassemble_next_line (struct ui_file *file, int from_tty,
713                                  struct cmd_list_element *c,
714                                  const char *value)
715 {
716   fprintf_filtered (file,
717                     _("Debugger's willingness to use "
718                       "disassemble-next-line is %s.\n"),
719                     value);
720 }
721
722 /* Use TRY_CATCH to catch the exception from the gdb_disassembly
723    because it will be broken by filter sometime.  */
724
725 static void
726 do_gdb_disassembly (struct gdbarch *gdbarch,
727                     int how_many, CORE_ADDR low, CORE_ADDR high)
728 {
729   volatile struct gdb_exception exception;
730
731   TRY_CATCH (exception, RETURN_MASK_ERROR)
732     {
733       gdb_disassembly (gdbarch, current_uiout, 0,
734                        DISASSEMBLY_RAW_INSN, how_many,
735                        low, high);
736     }
737   if (exception.reason < 0)
738     {
739       /* If an exception was thrown while doing the disassembly, print
740          the error message, to give the user a clue of what happened.  */
741       exception_print (gdb_stderr, exception);
742     }
743 }
744
745 /* Print information about frame FRAME.  The output is format according
746    to PRINT_LEVEL and PRINT_WHAT and PRINT_ARGS.  The meaning of
747    PRINT_WHAT is:
748    
749    SRC_LINE: Print only source line.
750    LOCATION: Print only location.
751    LOC_AND_SRC: Print location and source line.
752
753    Used in "where" output, and to emit breakpoint or step
754    messages.  */
755
756 void
757 print_frame_info (struct frame_info *frame, int print_level,
758                   enum print_what print_what, int print_args)
759 {
760   struct gdbarch *gdbarch = get_frame_arch (frame);
761   struct symtab_and_line sal;
762   int source_print;
763   int location_print;
764   struct ui_out *uiout = current_uiout;
765
766   if (get_frame_type (frame) == DUMMY_FRAME
767       || get_frame_type (frame) == SIGTRAMP_FRAME
768       || get_frame_type (frame) == ARCH_FRAME)
769     {
770       struct cleanup *uiout_cleanup
771         = make_cleanup_ui_out_tuple_begin_end (uiout, "frame");
772
773       annotate_frame_begin (print_level ? frame_relative_level (frame) : 0,
774                             gdbarch, get_frame_pc (frame));
775
776       /* Do this regardless of SOURCE because we don't have any source
777          to list for this frame.  */
778       if (print_level)
779         {
780           ui_out_text (uiout, "#");
781           ui_out_field_fmt_int (uiout, 2, ui_left, "level",
782                                 frame_relative_level (frame));
783         }
784       if (ui_out_is_mi_like_p (uiout))
785         {
786           annotate_frame_address ();
787           ui_out_field_core_addr (uiout, "addr",
788                                   gdbarch, get_frame_pc (frame));
789           annotate_frame_address_end ();
790         }
791
792       if (get_frame_type (frame) == DUMMY_FRAME)
793         {
794           annotate_function_call ();
795           ui_out_field_string (uiout, "func", "<function called from gdb>");
796         }
797       else if (get_frame_type (frame) == SIGTRAMP_FRAME)
798         {
799           annotate_signal_handler_caller ();
800           ui_out_field_string (uiout, "func", "<signal handler called>");
801         }
802       else if (get_frame_type (frame) == ARCH_FRAME)
803         {
804           ui_out_field_string (uiout, "func", "<cross-architecture call>");
805         }
806       ui_out_text (uiout, "\n");
807       annotate_frame_end ();
808
809       do_cleanups (uiout_cleanup);
810       return;
811     }
812
813   /* If FRAME is not the innermost frame, that normally means that
814      FRAME->pc points to *after* the call instruction, and we want to
815      get the line containing the call, never the next line.  But if
816      the next frame is a SIGTRAMP_FRAME or a DUMMY_FRAME, then the
817      next frame was not entered as the result of a call, and we want
818      to get the line containing FRAME->pc.  */
819   find_frame_sal (frame, &sal);
820
821   location_print = (print_what == LOCATION 
822                     || print_what == LOC_AND_ADDRESS
823                     || print_what == SRC_AND_LOC);
824
825   if (location_print || !sal.symtab)
826     print_frame (frame, print_level, print_what, print_args, sal);
827
828   source_print = (print_what == SRC_LINE || print_what == SRC_AND_LOC);
829
830   /* If disassemble-next-line is set to auto or on and doesn't have
831      the line debug messages for $pc, output the next instruction.  */
832   if ((disassemble_next_line == AUTO_BOOLEAN_AUTO
833        || disassemble_next_line == AUTO_BOOLEAN_TRUE)
834       && source_print && !sal.symtab)
835     do_gdb_disassembly (get_frame_arch (frame), 1,
836                         get_frame_pc (frame), get_frame_pc (frame) + 1);
837
838   if (source_print && sal.symtab)
839     {
840       int done = 0;
841       int mid_statement = ((print_what == SRC_LINE)
842                            && frame_show_address (frame, sal));
843
844       if (annotation_level)
845         done = identify_source_line (sal.symtab, sal.line, mid_statement,
846                                      get_frame_pc (frame));
847       if (!done)
848         {
849           if (deprecated_print_frame_info_listing_hook)
850             deprecated_print_frame_info_listing_hook (sal.symtab, 
851                                                       sal.line, 
852                                                       sal.line + 1, 0);
853           else
854             {
855               struct value_print_options opts;
856
857               get_user_print_options (&opts);
858               /* We used to do this earlier, but that is clearly
859                  wrong.  This function is used by many different
860                  parts of gdb, including normal_stop in infrun.c,
861                  which uses this to print out the current PC
862                  when we stepi/nexti into the middle of a source
863                  line.  Only the command line really wants this
864                  behavior.  Other UIs probably would like the
865                  ability to decide for themselves if it is desired.  */
866               if (opts.addressprint && mid_statement)
867                 {
868                   ui_out_field_core_addr (uiout, "addr",
869                                           gdbarch, get_frame_pc (frame));
870                   ui_out_text (uiout, "\t");
871                 }
872
873               print_source_lines (sal.symtab, sal.line, sal.line + 1, 0);
874             }
875         }
876
877       /* If disassemble-next-line is set to on and there is line debug
878          messages, output assembly codes for next line.  */
879       if (disassemble_next_line == AUTO_BOOLEAN_TRUE)
880         do_gdb_disassembly (get_frame_arch (frame), -1, sal.pc, sal.end);
881     }
882
883   if (print_what != LOCATION)
884     {
885       CORE_ADDR pc;
886
887       if (get_frame_pc_if_available (frame, &pc))
888         set_last_displayed_sal (1, sal.pspace, pc, sal.symtab, sal.line);
889       else
890         set_last_displayed_sal (0, 0, 0, 0, 0);
891     }
892
893   annotate_frame_end ();
894
895   gdb_flush (gdb_stdout);
896 }
897
898 /* Remember the last symtab and line we displayed, which we use e.g.
899  * as the place to put a breakpoint when the `break' command is
900  * invoked with no arguments.  */
901
902 static void
903 set_last_displayed_sal (int valid, struct program_space *pspace,
904                         CORE_ADDR addr, struct symtab *symtab,
905                         int line)
906 {
907   last_displayed_sal_valid = valid;
908   last_displayed_pspace = pspace;
909   last_displayed_addr = addr;
910   last_displayed_symtab = symtab;
911   last_displayed_line = line;
912   if (valid && pspace == NULL)
913     {
914       clear_last_displayed_sal ();
915       internal_error (__FILE__, __LINE__,
916                       _("Trying to set NULL pspace."));
917     }
918 }
919
920 /* Forget the last sal we displayed.  */
921
922 void
923 clear_last_displayed_sal (void)
924 {
925   last_displayed_sal_valid = 0;
926   last_displayed_pspace = 0;
927   last_displayed_addr = 0;
928   last_displayed_symtab = 0;
929   last_displayed_line = 0;
930 }
931
932 /* Is our record of the last sal we displayed valid?  If not,
933  * the get_last_displayed_* functions will return NULL or 0, as
934  * appropriate.  */
935
936 int
937 last_displayed_sal_is_valid (void)
938 {
939   return last_displayed_sal_valid;
940 }
941
942 /* Get the pspace of the last sal we displayed, if it's valid.  */
943
944 struct program_space *
945 get_last_displayed_pspace (void)
946 {
947   if (last_displayed_sal_valid)
948     return last_displayed_pspace;
949   return 0;
950 }
951
952 /* Get the address of the last sal we displayed, if it's valid.  */
953
954 CORE_ADDR
955 get_last_displayed_addr (void)
956 {
957   if (last_displayed_sal_valid)
958     return last_displayed_addr;
959   return 0;
960 }
961
962 /* Get the symtab of the last sal we displayed, if it's valid.  */
963
964 struct symtab*
965 get_last_displayed_symtab (void)
966 {
967   if (last_displayed_sal_valid)
968     return last_displayed_symtab;
969   return 0;
970 }
971
972 /* Get the line of the last sal we displayed, if it's valid.  */
973
974 int
975 get_last_displayed_line (void)
976 {
977   if (last_displayed_sal_valid)
978     return last_displayed_line;
979   return 0;
980 }
981
982 /* Get the last sal we displayed, if it's valid.  */
983
984 void
985 get_last_displayed_sal (struct symtab_and_line *sal)
986 {
987   if (last_displayed_sal_valid)
988     {
989       sal->pspace = last_displayed_pspace;
990       sal->pc = last_displayed_addr;
991       sal->symtab = last_displayed_symtab;
992       sal->line = last_displayed_line;
993     }
994   else
995     {
996       sal->pspace = 0;
997       sal->pc = 0;
998       sal->symtab = 0;
999       sal->line = 0;
1000     }
1001 }
1002
1003
1004 /* Attempt to obtain the FUNNAME, FUNLANG and optionally FUNCP of the function
1005    corresponding to FRAME.  */
1006
1007 void
1008 find_frame_funname (struct frame_info *frame, const char **funname,
1009                     enum language *funlang, struct symbol **funcp)
1010 {
1011   struct symbol *func;
1012
1013   *funname = NULL;
1014   *funlang = language_unknown;
1015   if (funcp)
1016     *funcp = NULL;
1017
1018   func = get_frame_function (frame);
1019   if (func)
1020     {
1021       /* In certain pathological cases, the symtabs give the wrong
1022          function (when we are in the first function in a file which
1023          is compiled without debugging symbols, the previous function
1024          is compiled with debugging symbols, and the "foo.o" symbol
1025          that is supposed to tell us where the file with debugging
1026          symbols ends has been truncated by ar because it is longer
1027          than 15 characters).  This also occurs if the user uses asm()
1028          to create a function but not stabs for it (in a file compiled
1029          with -g).
1030
1031          So look in the minimal symbol tables as well, and if it comes
1032          up with a larger address for the function use that instead.
1033          I don't think this can ever cause any problems; there
1034          shouldn't be any minimal symbols in the middle of a function;
1035          if this is ever changed many parts of GDB will need to be
1036          changed (and we'll create a find_pc_minimal_function or some
1037          such).  */
1038
1039       struct minimal_symbol *msymbol = NULL;
1040
1041       /* Don't attempt to do this for inlined functions, which do not
1042          have a corresponding minimal symbol.  */
1043       if (!block_inlined_p (SYMBOL_BLOCK_VALUE (func)))
1044         msymbol
1045           = lookup_minimal_symbol_by_pc (get_frame_address_in_block (frame));
1046
1047       if (msymbol != NULL
1048           && (SYMBOL_VALUE_ADDRESS (msymbol)
1049               > BLOCK_START (SYMBOL_BLOCK_VALUE (func))))
1050         {
1051           /* We also don't know anything about the function besides
1052              its address and name.  */
1053           func = 0;
1054           *funname = SYMBOL_PRINT_NAME (msymbol);
1055           *funlang = SYMBOL_LANGUAGE (msymbol);
1056         }
1057       else
1058         {
1059           *funname = SYMBOL_PRINT_NAME (func);
1060           *funlang = SYMBOL_LANGUAGE (func);
1061           if (funcp)
1062             *funcp = func;
1063           if (*funlang == language_cplus)
1064             {
1065               /* It seems appropriate to use SYMBOL_PRINT_NAME() here,
1066                  to display the demangled name that we already have
1067                  stored in the symbol table, but we stored a version
1068                  with DMGL_PARAMS turned on, and here we don't want to
1069                  display parameters.  So remove the parameters.  */
1070               char *func_only = cp_remove_params (*funname);
1071
1072               if (func_only)
1073                 {
1074                   *funname = func_only;
1075                   make_cleanup (xfree, func_only);
1076                 }
1077             }
1078         }
1079     }
1080   else
1081     {
1082       struct minimal_symbol *msymbol;
1083       CORE_ADDR pc;
1084
1085       if (!get_frame_address_in_block_if_available (frame, &pc))
1086         return;
1087
1088       msymbol = lookup_minimal_symbol_by_pc (pc);
1089       if (msymbol != NULL)
1090         {
1091           *funname = SYMBOL_PRINT_NAME (msymbol);
1092           *funlang = SYMBOL_LANGUAGE (msymbol);
1093         }
1094     }
1095 }
1096
1097 static void
1098 print_frame (struct frame_info *frame, int print_level,
1099              enum print_what print_what, int print_args,
1100              struct symtab_and_line sal)
1101 {
1102   struct gdbarch *gdbarch = get_frame_arch (frame);
1103   struct ui_out *uiout = current_uiout;
1104   const char *funname = NULL;
1105   enum language funlang = language_unknown;
1106   struct ui_stream *stb;
1107   struct cleanup *old_chain, *list_chain;
1108   struct value_print_options opts;
1109   struct symbol *func;
1110   CORE_ADDR pc = 0;
1111   int pc_p;
1112
1113   pc_p = get_frame_pc_if_available (frame, &pc);
1114
1115   stb = ui_out_stream_new (uiout);
1116   old_chain = make_cleanup_ui_out_stream_delete (stb);
1117
1118   find_frame_funname (frame, &funname, &funlang, &func);
1119
1120   annotate_frame_begin (print_level ? frame_relative_level (frame) : 0,
1121                         gdbarch, pc);
1122
1123   list_chain = make_cleanup_ui_out_tuple_begin_end (uiout, "frame");
1124
1125   if (print_level)
1126     {
1127       ui_out_text (uiout, "#");
1128       ui_out_field_fmt_int (uiout, 2, ui_left, "level",
1129                             frame_relative_level (frame));
1130     }
1131   get_user_print_options (&opts);
1132   if (opts.addressprint)
1133     if (!sal.symtab
1134         || frame_show_address (frame, sal)
1135         || print_what == LOC_AND_ADDRESS)
1136       {
1137         annotate_frame_address ();
1138         if (pc_p)
1139           ui_out_field_core_addr (uiout, "addr", gdbarch, pc);
1140         else
1141           ui_out_field_string (uiout, "addr", "<unavailable>");
1142         annotate_frame_address_end ();
1143         ui_out_text (uiout, " in ");
1144       }
1145   annotate_frame_function_name ();
1146   fprintf_symbol_filtered (stb->stream, funname ? funname : "??",
1147                            funlang, DMGL_ANSI);
1148   ui_out_field_stream (uiout, "func", stb);
1149   ui_out_wrap_hint (uiout, "   ");
1150   annotate_frame_args ();
1151       
1152   ui_out_text (uiout, " (");
1153   if (print_args)
1154     {
1155       struct gdbarch *gdbarch = get_frame_arch (frame);
1156       int numargs;
1157       struct cleanup *args_list_chain;
1158       volatile struct gdb_exception e;
1159
1160       if (gdbarch_frame_num_args_p (gdbarch))
1161         {
1162           numargs = gdbarch_frame_num_args (gdbarch, frame);
1163           gdb_assert (numargs >= 0);
1164         }
1165       else
1166         numargs = -1;
1167     
1168       args_list_chain = make_cleanup_ui_out_list_begin_end (uiout, "args");
1169       TRY_CATCH (e, RETURN_MASK_ERROR)
1170         {
1171           print_frame_args (func, frame, numargs, gdb_stdout);
1172         }
1173       /* FIXME: ARGS must be a list.  If one argument is a string it
1174           will have " that will not be properly escaped.  */
1175       /* Invoke ui_out_tuple_end.  */
1176       do_cleanups (args_list_chain);
1177       QUIT;
1178     }
1179   ui_out_text (uiout, ")");
1180   if (sal.symtab && sal.symtab->filename)
1181     {
1182       annotate_frame_source_begin ();
1183       ui_out_wrap_hint (uiout, "   ");
1184       ui_out_text (uiout, " at ");
1185       annotate_frame_source_file ();
1186       ui_out_field_string (uiout, "file", sal.symtab->filename);
1187       if (ui_out_is_mi_like_p (uiout))
1188         {
1189           const char *fullname = symtab_to_fullname (sal.symtab);
1190
1191           if (fullname != NULL)
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 || (!sal.symtab || !sal.symtab->filename)))
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         print_frame_local_vars (fi, 1, gdb_stdout);
1731
1732       /* Save the last frame to check for error conditions.  */
1733       trailing = fi;
1734     }
1735
1736   /* If we've stopped before the end, mention that.  */
1737   if (fi && from_tty)
1738     printf_filtered (_("(More stack frames follow...)\n"));
1739
1740   /* If we've run out of frames, and the reason appears to be an error
1741      condition, print it.  */
1742   if (fi == NULL && trailing != NULL)
1743     {
1744       enum unwind_stop_reason reason;
1745
1746       reason = get_frame_unwind_stop_reason (trailing);
1747       if (reason >= UNWIND_FIRST_ERROR)
1748         printf_filtered (_("Backtrace stopped: %s\n"),
1749                          frame_stop_reason_string (reason));
1750     }
1751 }
1752
1753 static void
1754 backtrace_command (char *arg, int from_tty)
1755 {
1756   struct cleanup *old_chain = make_cleanup (null_cleanup, NULL);
1757   int fulltrace_arg = -1, arglen = 0, argc = 0;
1758
1759   if (arg)
1760     {
1761       char **argv;
1762       int i;
1763
1764       argv = gdb_buildargv (arg);
1765       make_cleanup_freeargv (argv);
1766       argc = 0;
1767       for (i = 0; argv[i]; i++)
1768         {
1769           unsigned int j;
1770
1771           for (j = 0; j < strlen (argv[i]); j++)
1772             argv[i][j] = tolower (argv[i][j]);
1773
1774           if (fulltrace_arg < 0 && subset_compare (argv[i], "full"))
1775             fulltrace_arg = argc;
1776           else
1777             {
1778               arglen += strlen (argv[i]);
1779               argc++;
1780             }
1781         }
1782       arglen += argc;
1783       if (fulltrace_arg >= 0)
1784         {
1785           if (arglen > 0)
1786             {
1787               arg = xmalloc (arglen + 1);
1788               make_cleanup (xfree, arg);
1789               arg[0] = 0;
1790               for (i = 0; i < (argc + 1); i++)
1791                 {
1792                   if (i != fulltrace_arg)
1793                     {
1794                       strcat (arg, argv[i]);
1795                       strcat (arg, " ");
1796                     }
1797                 }
1798             }
1799           else
1800             arg = NULL;
1801         }
1802     }
1803
1804   backtrace_command_1 (arg, fulltrace_arg >= 0 /* show_locals */, from_tty);
1805
1806   do_cleanups (old_chain);
1807 }
1808
1809 static void
1810 backtrace_full_command (char *arg, int from_tty)
1811 {
1812   backtrace_command_1 (arg, 1 /* show_locals */, from_tty);
1813 }
1814 \f
1815
1816 /* Iterate over the local variables of a block B, calling CB with
1817    CB_DATA.  */
1818
1819 static void
1820 iterate_over_block_locals (struct block *b,
1821                            iterate_over_block_arg_local_vars_cb cb,
1822                            void *cb_data)
1823 {
1824   struct dict_iterator iter;
1825   struct symbol *sym;
1826
1827   ALL_BLOCK_SYMBOLS (b, iter, sym)
1828     {
1829       switch (SYMBOL_CLASS (sym))
1830         {
1831         case LOC_LOCAL:
1832         case LOC_REGISTER:
1833         case LOC_STATIC:
1834         case LOC_COMPUTED:
1835           if (SYMBOL_IS_ARGUMENT (sym))
1836             break;
1837           (*cb) (SYMBOL_PRINT_NAME (sym), sym, cb_data);
1838           break;
1839
1840         default:
1841           /* Ignore symbols which are not locals.  */
1842           break;
1843         }
1844     }
1845 }
1846
1847
1848 /* Same, but print labels.  */
1849
1850 #if 0
1851 /* Commented out, as the code using this function has also been
1852    commented out.  FIXME:brobecker/2009-01-13: Find out why the code
1853    was commented out in the first place.  The discussion introducing
1854    this change (2007-12-04: Support lexical blocks and function bodies
1855    that occupy non-contiguous address ranges) did not explain why
1856    this change was made.  */
1857 static int
1858 print_block_frame_labels (struct gdbarch *gdbarch, struct block *b,
1859                           int *have_default, struct ui_file *stream)
1860 {
1861   struct dict_iterator iter;
1862   struct symbol *sym;
1863   int values_printed = 0;
1864
1865   ALL_BLOCK_SYMBOLS (b, iter, sym)
1866     {
1867       if (strcmp (SYMBOL_LINKAGE_NAME (sym), "default") == 0)
1868         {
1869           if (*have_default)
1870             continue;
1871           *have_default = 1;
1872         }
1873       if (SYMBOL_CLASS (sym) == LOC_LABEL)
1874         {
1875           struct symtab_and_line sal;
1876           struct value_print_options opts;
1877
1878           sal = find_pc_line (SYMBOL_VALUE_ADDRESS (sym), 0);
1879           values_printed = 1;
1880           fputs_filtered (SYMBOL_PRINT_NAME (sym), stream);
1881           get_user_print_options (&opts);
1882           if (opts.addressprint)
1883             {
1884               fprintf_filtered (stream, " ");
1885               fputs_filtered (paddress (gdbarch, SYMBOL_VALUE_ADDRESS (sym)),
1886                               stream);
1887             }
1888           fprintf_filtered (stream, " in file %s, line %d\n",
1889                             sal.symtab->filename, sal.line);
1890         }
1891     }
1892
1893   return values_printed;
1894 }
1895 #endif
1896
1897 /* Iterate over all the local variables in block B, including all its
1898    superblocks, stopping when the top-level block is reached.  */
1899
1900 void
1901 iterate_over_block_local_vars (struct block *block,
1902                                iterate_over_block_arg_local_vars_cb cb,
1903                                void *cb_data)
1904 {
1905   while (block)
1906     {
1907       iterate_over_block_locals (block, cb, cb_data);
1908       /* After handling the function's top-level block, stop.  Don't
1909          continue to its superblock, the block of per-file
1910          symbols.  */
1911       if (BLOCK_FUNCTION (block))
1912         break;
1913       block = BLOCK_SUPERBLOCK (block);
1914     }
1915 }
1916
1917 /* Data to be passed around in the calls to the locals and args
1918    iterators.  */
1919
1920 struct print_variable_and_value_data
1921 {
1922   struct frame_info *frame;
1923   int num_tabs;
1924   struct ui_file *stream;
1925   int values_printed;
1926 };
1927
1928 /* The callback for the locals and args iterators.  */
1929
1930 static void
1931 do_print_variable_and_value (const char *print_name,
1932                              struct symbol *sym,
1933                              void *cb_data)
1934 {
1935   struct print_variable_and_value_data *p = cb_data;
1936
1937   print_variable_and_value (print_name, sym,
1938                             p->frame, p->stream, p->num_tabs);
1939   p->values_printed = 1;
1940 }
1941
1942 static void
1943 print_frame_local_vars (struct frame_info *frame, int num_tabs,
1944                         struct ui_file *stream)
1945 {
1946   struct print_variable_and_value_data cb_data;
1947   struct block *block;
1948   CORE_ADDR pc;
1949
1950   if (!get_frame_pc_if_available (frame, &pc))
1951     {
1952       fprintf_filtered (stream,
1953                         _("PC unavailable, cannot determine locals.\n"));
1954       return;
1955     }
1956
1957   block = get_frame_block (frame, 0);
1958   if (block == 0)
1959     {
1960       fprintf_filtered (stream, "No symbol table info available.\n");
1961       return;
1962     }
1963
1964   cb_data.frame = frame;
1965   cb_data.num_tabs = 4 * num_tabs;
1966   cb_data.stream = stream;
1967   cb_data.values_printed = 0;
1968
1969   iterate_over_block_local_vars (block,
1970                                  do_print_variable_and_value,
1971                                  &cb_data);
1972
1973   if (!cb_data.values_printed)
1974     fprintf_filtered (stream, _("No locals.\n"));
1975 }
1976
1977 void
1978 locals_info (char *args, int from_tty)
1979 {
1980   print_frame_local_vars (get_selected_frame (_("No frame selected.")),
1981                           0, gdb_stdout);
1982 }
1983
1984 /* Iterate over all the argument variables in block B.
1985
1986    Returns 1 if any argument was walked; 0 otherwise.  */
1987
1988 void
1989 iterate_over_block_arg_vars (struct block *b,
1990                              iterate_over_block_arg_local_vars_cb cb,
1991                              void *cb_data)
1992 {
1993   struct dict_iterator iter;
1994   struct symbol *sym, *sym2;
1995
1996   ALL_BLOCK_SYMBOLS (b, iter, sym)
1997     {
1998       /* Don't worry about things which aren't arguments.  */
1999       if (SYMBOL_IS_ARGUMENT (sym))
2000         {
2001           /* We have to look up the symbol because arguments can have
2002              two entries (one a parameter, one a local) and the one we
2003              want is the local, which lookup_symbol will find for us.
2004              This includes gcc1 (not gcc2) on the sparc when passing a
2005              small structure and gcc2 when the argument type is float
2006              and it is passed as a double and converted to float by
2007              the prologue (in the latter case the type of the LOC_ARG
2008              symbol is double and the type of the LOC_LOCAL symbol is
2009              float).  There are also LOC_ARG/LOC_REGISTER pairs which
2010              are not combined in symbol-reading.  */
2011
2012           sym2 = lookup_symbol (SYMBOL_LINKAGE_NAME (sym),
2013                                 b, VAR_DOMAIN, NULL);
2014           (*cb) (SYMBOL_PRINT_NAME (sym), sym2, cb_data);
2015         }
2016     }
2017 }
2018
2019 static void
2020 print_frame_arg_vars (struct frame_info *frame, struct ui_file *stream)
2021 {
2022   struct print_variable_and_value_data cb_data;
2023   struct symbol *func;
2024   CORE_ADDR pc;
2025
2026   if (!get_frame_pc_if_available (frame, &pc))
2027     {
2028       fprintf_filtered (stream, _("PC unavailable, cannot determine args.\n"));
2029       return;
2030     }
2031
2032   func = get_frame_function (frame);
2033   if (func == NULL)
2034     {
2035       fprintf_filtered (stream, _("No symbol table info available.\n"));
2036       return;
2037     }
2038
2039   cb_data.frame = frame;
2040   cb_data.num_tabs = 0;
2041   cb_data.stream = gdb_stdout;
2042   cb_data.values_printed = 0;
2043
2044   iterate_over_block_arg_vars (SYMBOL_BLOCK_VALUE (func),
2045                                do_print_variable_and_value, &cb_data);
2046
2047   if (!cb_data.values_printed)
2048     fprintf_filtered (stream, _("No arguments.\n"));
2049 }
2050
2051 void
2052 args_info (char *ignore, int from_tty)
2053 {
2054   print_frame_arg_vars (get_selected_frame (_("No frame selected.")),
2055                         gdb_stdout);
2056 }
2057
2058
2059 static void
2060 args_plus_locals_info (char *ignore, int from_tty)
2061 {
2062   args_info (ignore, from_tty);
2063   locals_info (ignore, from_tty);
2064 }
2065 \f
2066
2067 /* Select frame FRAME.  Also print the stack frame and show the source
2068    if this is the tui version.  */
2069 static void
2070 select_and_print_frame (struct frame_info *frame)
2071 {
2072   select_frame (frame);
2073   if (frame)
2074     print_stack_frame (frame, 1, SRC_AND_LOC);
2075 }
2076 \f
2077 /* Return the symbol-block in which the selected frame is executing.
2078    Can return zero under various legitimate circumstances.
2079
2080    If ADDR_IN_BLOCK is non-zero, set *ADDR_IN_BLOCK to the relevant
2081    code address within the block returned.  We use this to decide
2082    which macros are in scope.  */
2083
2084 struct block *
2085 get_selected_block (CORE_ADDR *addr_in_block)
2086 {
2087   if (!has_stack_frames ())
2088     return 0;
2089
2090   return get_frame_block (get_selected_frame (NULL), addr_in_block);
2091 }
2092
2093 /* Find a frame a certain number of levels away from FRAME.
2094    LEVEL_OFFSET_PTR points to an int containing the number of levels.
2095    Positive means go to earlier frames (up); negative, the reverse.
2096    The int that contains the number of levels is counted toward
2097    zero as the frames for those levels are found.
2098    If the top or bottom frame is reached, that frame is returned,
2099    but the final value of *LEVEL_OFFSET_PTR is nonzero and indicates
2100    how much farther the original request asked to go.  */
2101
2102 struct frame_info *
2103 find_relative_frame (struct frame_info *frame, int *level_offset_ptr)
2104 {
2105   /* Going up is simple: just call get_prev_frame enough times or
2106      until the initial frame is reached.  */
2107   while (*level_offset_ptr > 0)
2108     {
2109       struct frame_info *prev = get_prev_frame (frame);
2110
2111       if (!prev)
2112         break;
2113       (*level_offset_ptr)--;
2114       frame = prev;
2115     }
2116
2117   /* Going down is just as simple.  */
2118   while (*level_offset_ptr < 0)
2119     {
2120       struct frame_info *next = get_next_frame (frame);
2121
2122       if (!next)
2123         break;
2124       (*level_offset_ptr)++;
2125       frame = next;
2126     }
2127
2128   return frame;
2129 }
2130
2131 /* The "select_frame" command.  With no argument this is a NOP.
2132    Select the frame at level LEVEL_EXP if it is a valid level.
2133    Otherwise, treat LEVEL_EXP as an address expression and select it.
2134
2135    See parse_frame_specification for more info on proper frame
2136    expressions.  */
2137
2138 void
2139 select_frame_command (char *level_exp, int from_tty)
2140 {
2141   select_frame (parse_frame_specification_1 (level_exp, "No stack.", NULL));
2142 }
2143
2144 /* The "frame" command.  With no argument, print the selected frame
2145    briefly.  With an argument, behave like select_frame and then print
2146    the selected frame.  */
2147
2148 static void
2149 frame_command (char *level_exp, int from_tty)
2150 {
2151   select_frame_command (level_exp, from_tty);
2152   print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
2153 }
2154
2155 /* The XDB Compatibility command to print the current frame.  */
2156
2157 static void
2158 current_frame_command (char *level_exp, int from_tty)
2159 {
2160   print_stack_frame (get_selected_frame (_("No stack.")), 1, SRC_AND_LOC);
2161 }
2162
2163 /* Select the frame up one or COUNT_EXP stack levels from the
2164    previously selected frame, and print it briefly.  */
2165
2166 static void
2167 up_silently_base (char *count_exp)
2168 {
2169   struct frame_info *frame;
2170   int count = 1;
2171
2172   if (count_exp)
2173     count = parse_and_eval_long (count_exp);
2174
2175   frame = find_relative_frame (get_selected_frame ("No stack."), &count);
2176   if (count != 0 && count_exp == NULL)
2177     error (_("Initial frame selected; you cannot go up."));
2178   select_frame (frame);
2179 }
2180
2181 static void
2182 up_silently_command (char *count_exp, int from_tty)
2183 {
2184   up_silently_base (count_exp);
2185 }
2186
2187 static void
2188 up_command (char *count_exp, int from_tty)
2189 {
2190   up_silently_base (count_exp);
2191   print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
2192 }
2193
2194 /* Select the frame down one or COUNT_EXP stack levels from the previously
2195    selected frame, and print it briefly.  */
2196
2197 static void
2198 down_silently_base (char *count_exp)
2199 {
2200   struct frame_info *frame;
2201   int count = -1;
2202
2203   if (count_exp)
2204     count = -parse_and_eval_long (count_exp);
2205
2206   frame = find_relative_frame (get_selected_frame ("No stack."), &count);
2207   if (count != 0 && count_exp == NULL)
2208     {
2209       /* We only do this if COUNT_EXP is not specified.  That way
2210          "down" means to really go down (and let me know if that is
2211          impossible), but "down 9999" can be used to mean go all the
2212          way down without getting an error.  */
2213
2214       error (_("Bottom (innermost) frame selected; you cannot go down."));
2215     }
2216
2217   select_frame (frame);
2218 }
2219
2220 static void
2221 down_silently_command (char *count_exp, int from_tty)
2222 {
2223   down_silently_base (count_exp);
2224 }
2225
2226 static void
2227 down_command (char *count_exp, int from_tty)
2228 {
2229   down_silently_base (count_exp);
2230   print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
2231 }
2232 \f
2233
2234 void
2235 return_command (char *retval_exp, int from_tty)
2236 {
2237   struct frame_info *thisframe;
2238   struct gdbarch *gdbarch;
2239   struct symbol *thisfun;
2240   struct value *return_value = NULL;
2241   const char *query_prefix = "";
2242
2243   thisframe = get_selected_frame ("No selected frame.");
2244   thisfun = get_frame_function (thisframe);
2245   gdbarch = get_frame_arch (thisframe);
2246
2247   if (get_frame_type (get_current_frame ()) == INLINE_FRAME)
2248     error (_("Can not force return from an inlined function."));
2249
2250   /* Compute the return value.  If the computation triggers an error,
2251      let it bail.  If the return type can't be handled, set
2252      RETURN_VALUE to NULL, and QUERY_PREFIX to an informational
2253      message.  */
2254   if (retval_exp)
2255     {
2256       struct expression *retval_expr = parse_expression (retval_exp);
2257       struct cleanup *old_chain = make_cleanup (xfree, retval_expr);
2258       struct type *return_type = NULL;
2259
2260       /* Compute the return value.  Should the computation fail, this
2261          call throws an error.  */
2262       return_value = evaluate_expression (retval_expr);
2263
2264       /* Cast return value to the return type of the function.  Should
2265          the cast fail, this call throws an error.  */
2266       if (thisfun != NULL)
2267         return_type = TYPE_TARGET_TYPE (SYMBOL_TYPE (thisfun));
2268       if (return_type == NULL)
2269         {
2270           if (retval_expr->elts[0].opcode != UNOP_CAST)
2271             error (_("Return value type not available for selected "
2272                      "stack frame.\n"
2273                      "Please use an explicit cast of the value to return."));
2274           return_type = value_type (return_value);
2275         }
2276       do_cleanups (old_chain);
2277       CHECK_TYPEDEF (return_type);
2278       return_value = value_cast (return_type, return_value);
2279
2280       /* Make sure the value is fully evaluated.  It may live in the
2281          stack frame we're about to pop.  */
2282       if (value_lazy (return_value))
2283         value_fetch_lazy (return_value);
2284
2285       if (TYPE_CODE (return_type) == TYPE_CODE_VOID)
2286         /* If the return-type is "void", don't try to find the
2287            return-value's location.  However, do still evaluate the
2288            return expression so that, even when the expression result
2289            is discarded, side effects such as "return i++" still
2290            occur.  */
2291         return_value = NULL;
2292       else if (thisfun != NULL
2293                && using_struct_return (gdbarch,
2294                                        SYMBOL_TYPE (thisfun), return_type))
2295         {
2296           query_prefix = "The location at which to store the "
2297             "function's return value is unknown.\n"
2298             "If you continue, the return value "
2299             "that you specified will be ignored.\n";
2300           return_value = NULL;
2301         }
2302     }
2303
2304   /* Does an interactive user really want to do this?  Include
2305      information, such as how well GDB can handle the return value, in
2306      the query message.  */
2307   if (from_tty)
2308     {
2309       int confirmed;
2310
2311       if (thisfun == NULL)
2312         confirmed = query (_("%sMake selected stack frame return now? "),
2313                            query_prefix);
2314       else
2315         confirmed = query (_("%sMake %s return now? "), query_prefix,
2316                            SYMBOL_PRINT_NAME (thisfun));
2317       if (!confirmed)
2318         error (_("Not confirmed"));
2319     }
2320
2321   /* Discard the selected frame and all frames inner-to it.  */
2322   frame_pop (get_selected_frame (NULL));
2323
2324   /* Store RETURN_VALUE in the just-returned register set.  */
2325   if (return_value != NULL)
2326     {
2327       struct type *return_type = value_type (return_value);
2328       struct gdbarch *gdbarch = get_regcache_arch (get_current_regcache ());
2329       struct type *func_type = thisfun == NULL ? NULL : SYMBOL_TYPE (thisfun);
2330
2331       gdb_assert (gdbarch_return_value (gdbarch, func_type, return_type, NULL,
2332                                         NULL, NULL)
2333                   == RETURN_VALUE_REGISTER_CONVENTION);
2334       gdbarch_return_value (gdbarch, func_type, return_type,
2335                             get_current_regcache (), NULL /*read*/,
2336                             value_contents (return_value) /*write*/);
2337     }
2338
2339   /* If we are at the end of a call dummy now, pop the dummy frame
2340      too.  */
2341   if (get_frame_type (get_current_frame ()) == DUMMY_FRAME)
2342     frame_pop (get_current_frame ());
2343
2344   /* If interactive, print the frame that is now current.  */
2345   if (from_tty)
2346     frame_command ("0", 1);
2347   else
2348     select_frame_command ("0", 0);
2349 }
2350
2351 /* Sets the scope to input function name, provided that the function
2352    is within the current stack frame.  */
2353
2354 struct function_bounds
2355 {
2356   CORE_ADDR low, high;
2357 };
2358
2359 static void
2360 func_command (char *arg, int from_tty)
2361 {
2362   struct frame_info *frame;
2363   int found = 0;
2364   struct symtabs_and_lines sals;
2365   int i;
2366   int level = 1;
2367   struct function_bounds *func_bounds = NULL;
2368   struct cleanup *cleanups;
2369
2370   if (arg != NULL)
2371     return;
2372
2373   frame = parse_frame_specification ("0");
2374   sals = decode_line_spec (arg, DECODE_LINE_FUNFIRSTLINE);
2375   cleanups = make_cleanup (xfree, sals.sals);
2376   func_bounds = (struct function_bounds *) xmalloc (
2377                               sizeof (struct function_bounds) * sals.nelts);
2378   make_cleanup (xfree, func_bounds);
2379   for (i = 0; (i < sals.nelts && !found); i++)
2380     {
2381       if (sals.sals[i].pspace != current_program_space)
2382         func_bounds[i].low = func_bounds[i].high = 0;
2383       else if (sals.sals[i].pc == 0
2384                || find_pc_partial_function (sals.sals[i].pc, NULL,
2385                                             &func_bounds[i].low,
2386                                             &func_bounds[i].high) == 0)
2387         {
2388           func_bounds[i].low = func_bounds[i].high = 0;
2389         }
2390     }
2391
2392   do
2393     {
2394       for (i = 0; (i < sals.nelts && !found); i++)
2395         found = (get_frame_pc (frame) >= func_bounds[i].low
2396                  && get_frame_pc (frame) < func_bounds[i].high);
2397       if (!found)
2398         {
2399           level = 1;
2400           frame = find_relative_frame (frame, &level);
2401         }
2402     }
2403   while (!found && level == 0);
2404
2405   do_cleanups (cleanups);
2406
2407   if (!found)
2408     printf_filtered (_("'%s' not within current stack frame.\n"), arg);
2409   else if (frame != get_selected_frame (NULL))
2410     select_and_print_frame (frame);
2411 }
2412
2413 /* Gets the language of the current frame.  */
2414
2415 enum language
2416 get_frame_language (void)
2417 {
2418   struct frame_info *frame = deprecated_safe_get_selected_frame ();
2419
2420   if (frame)
2421     {
2422       volatile struct gdb_exception ex;
2423       CORE_ADDR pc = 0;
2424       struct symtab *s;
2425
2426       /* We determine the current frame language by looking up its
2427          associated symtab.  To retrieve this symtab, we use the frame
2428          PC.  However we cannot use the frame PC as is, because it
2429          usually points to the instruction following the "call", which
2430          is sometimes the first instruction of another function.  So
2431          we rely on get_frame_address_in_block(), it provides us with
2432          a PC that is guaranteed to be inside the frame's code
2433          block.  */
2434
2435       TRY_CATCH (ex, RETURN_MASK_ERROR)
2436         {
2437           pc = get_frame_address_in_block (frame);
2438         }
2439       if (ex.reason < 0)
2440         {
2441           if (ex.error != NOT_AVAILABLE_ERROR)
2442             throw_exception (ex);
2443         }
2444       else
2445         {
2446           s = find_pc_symtab (pc);
2447           if (s != NULL)
2448             return s->language;
2449         }
2450     }
2451
2452   return language_unknown;
2453 }
2454 \f
2455
2456 /* Provide a prototype to silence -Wmissing-prototypes.  */
2457 void _initialize_stack (void);
2458
2459 void
2460 _initialize_stack (void)
2461 {
2462   add_com ("return", class_stack, return_command, _("\
2463 Make selected stack frame return to its caller.\n\
2464 Control remains in the debugger, but when you continue\n\
2465 execution will resume in the frame above the one now selected.\n\
2466 If an argument is given, it is an expression for the value to return."));
2467
2468   add_com ("up", class_stack, up_command, _("\
2469 Select and print stack frame that called this one.\n\
2470 An argument says how many frames up to go."));
2471   add_com ("up-silently", class_support, up_silently_command, _("\
2472 Same as the `up' command, but does not print anything.\n\
2473 This is useful in command scripts."));
2474
2475   add_com ("down", class_stack, down_command, _("\
2476 Select and print stack frame called by this one.\n\
2477 An argument says how many frames down to go."));
2478   add_com_alias ("do", "down", class_stack, 1);
2479   add_com_alias ("dow", "down", class_stack, 1);
2480   add_com ("down-silently", class_support, down_silently_command, _("\
2481 Same as the `down' command, but does not print anything.\n\
2482 This is useful in command scripts."));
2483
2484   add_com ("frame", class_stack, frame_command, _("\
2485 Select and print a stack frame.\nWith no argument, \
2486 print the selected stack frame.  (See also \"info frame\").\n\
2487 An argument specifies the frame to select.\n\
2488 It can be a stack frame number or the address of the frame.\n\
2489 With argument, nothing is printed if input is coming from\n\
2490 a command file or a user-defined command."));
2491
2492   add_com_alias ("f", "frame", class_stack, 1);
2493
2494   if (xdb_commands)
2495     {
2496       add_com ("L", class_stack, current_frame_command,
2497                _("Print the current stack frame.\n"));
2498       add_com_alias ("V", "frame", class_stack, 1);
2499     }
2500   add_com ("select-frame", class_stack, select_frame_command, _("\
2501 Select a stack frame without printing anything.\n\
2502 An argument specifies the frame to select.\n\
2503 It can be a stack frame number or the address of the frame.\n"));
2504
2505   add_com ("backtrace", class_stack, backtrace_command, _("\
2506 Print backtrace of all stack frames, or innermost COUNT frames.\n\
2507 With a negative argument, print outermost -COUNT frames.\nUse of the \
2508 'full' qualifier also prints the values of the local variables.\n"));
2509   add_com_alias ("bt", "backtrace", class_stack, 0);
2510   if (xdb_commands)
2511     {
2512       add_com_alias ("t", "backtrace", class_stack, 0);
2513       add_com ("T", class_stack, backtrace_full_command, _("\
2514 Print backtrace of all stack frames, or innermost COUNT frames\n\
2515 and the values of the local variables.\n\
2516 With a negative argument, print outermost -COUNT frames.\n\
2517 Usage: T <count>\n"));
2518     }
2519
2520   add_com_alias ("where", "backtrace", class_alias, 0);
2521   add_info ("stack", backtrace_command,
2522             _("Backtrace of the stack, or innermost COUNT frames."));
2523   add_info_alias ("s", "stack", 1);
2524   add_info ("frame", frame_info,
2525             _("All about selected stack frame, or frame at ADDR."));
2526   add_info_alias ("f", "frame", 1);
2527   add_info ("locals", locals_info,
2528             _("Local variables of current stack frame."));
2529   add_info ("args", args_info,
2530             _("Argument variables of current stack frame."));
2531   if (xdb_commands)
2532     add_com ("l", class_info, args_plus_locals_info,
2533              _("Argument and local variables of current stack frame."));
2534
2535   if (dbx_commands)
2536     add_com ("func", class_stack, func_command, _("\
2537 Select the stack frame that contains <func>.\n\
2538 Usage: func <name>\n"));
2539
2540   add_setshow_enum_cmd ("frame-arguments", class_stack,
2541                         print_frame_arguments_choices, &print_frame_arguments,
2542                         _("Set printing of non-scalar frame arguments"),
2543                         _("Show printing of non-scalar frame arguments"),
2544                         NULL, NULL, NULL, &setprintlist, &showprintlist);
2545
2546   add_setshow_auto_boolean_cmd ("disassemble-next-line", class_stack,
2547                                 &disassemble_next_line, _("\
2548 Set whether to disassemble next source line or insn when execution stops."),
2549                                 _("\
2550 Show whether to disassemble next source line or insn when execution stops."),
2551                                 _("\
2552 If ON, GDB will display disassembly of the next source line, in addition\n\
2553 to displaying the source line itself.  If the next source line cannot\n\
2554 be displayed (e.g., source is unavailable or there's no line info), GDB\n\
2555 will display disassembly of next instruction instead of showing the\n\
2556 source line.\n\
2557 If AUTO, display disassembly of next instruction only if the source line\n\
2558 cannot be displayed.\n\
2559 If OFF (which is the default), never display the disassembly of the next\n\
2560 source line."),
2561                                 NULL,
2562                                 show_disassemble_next_line,
2563                                 &setlist, &showlist);
2564   disassemble_next_line = AUTO_BOOLEAN_FALSE;
2565
2566   add_setshow_enum_cmd ("entry-values", class_stack,
2567                         print_entry_values_choices, &print_entry_values,
2568                         _("Set printing of function arguments at function "
2569                           "entry"),
2570                         _("Show printing of function arguments at function "
2571                           "entry"),
2572                         _("\
2573 GDB can sometimes determine the values of function arguments at entry,\n\
2574 in addition to their current values.  This option tells GDB whether\n\
2575 to print the current value, the value at entry (marked as val@entry),\n\
2576 or both.  Note that one or both of these values may be <optimized out>."),
2577                         NULL, NULL, &setprintlist, &showprintlist);
2578 }