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