* symtab.h (enum address_class): Remove LOC_REGPARM and
[platform/upstream/binutils.git] / gdb / stack.c
1 /* Print and select stack frames for GDB, the GNU debugger.
2
3    Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
4    1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2007, 2008
5    Free Software Foundation, Inc.
6
7    This file is part of GDB.
8
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 3 of the License, or
12    (at your option) any later version.
13
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18
19    You should have received a copy of the GNU General Public License
20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
21
22 #include "defs.h"
23 #include "value.h"
24 #include "symtab.h"
25 #include "gdbtypes.h"
26 #include "expression.h"
27 #include "language.h"
28 #include "frame.h"
29 #include "gdbcmd.h"
30 #include "gdbcore.h"
31 #include "target.h"
32 #include "source.h"
33 #include "breakpoint.h"
34 #include "demangle.h"
35 #include "inferior.h"
36 #include "annotate.h"
37 #include "ui-out.h"
38 #include "block.h"
39 #include "stack.h"
40 #include "dictionary.h"
41 #include "exceptions.h"
42 #include "reggroups.h"
43 #include "regcache.h"
44 #include "solib.h"
45 #include "valprint.h"
46
47 #include "gdb_assert.h"
48 #include <ctype.h>
49 #include "gdb_string.h"
50
51 void (*deprecated_selected_frame_level_changed_hook) (int);
52
53 /* The possible choices of "set print frame-arguments, and the value
54    of this setting.  */
55
56 static const char *print_frame_arguments_choices[] =
57   {"all", "scalars", "none", NULL};
58 static const char *print_frame_arguments = "all";
59
60 /* Prototypes for local functions. */
61
62 static void print_frame_local_vars (struct frame_info *, int,
63                                     struct ui_file *);
64
65 static void print_frame (struct frame_info *frame, int print_level,
66                          enum print_what print_what,  int print_args,
67                          struct symtab_and_line sal);
68
69 /* Zero means do things normally; we are interacting directly with the
70    user.  One means print the full filename and linenumber when a
71    frame is printed, and do so in a format emacs18/emacs19.22 can
72    parse.  Two means print similar annotations, but in many more
73    cases and in a slightly different syntax.  */
74
75 int annotation_level = 0;
76 \f
77
78 struct print_stack_frame_args
79 {
80   struct frame_info *frame;
81   int print_level;
82   enum print_what print_what;
83   int print_args;
84 };
85
86 /* Show or print the frame arguments; stub for catch_errors.  */
87
88 static int
89 print_stack_frame_stub (void *args)
90 {
91   struct print_stack_frame_args *p = args;
92   int center = (p->print_what == SRC_LINE || p->print_what == SRC_AND_LOC);
93
94   print_frame_info (p->frame, p->print_level, p->print_what, p->print_args);
95   set_current_sal_from_frame (p->frame, center);
96   return 0;
97 }
98
99 /* Show or print a stack frame FRAME briefly.  The output is format
100    according to PRINT_LEVEL and PRINT_WHAT printing the frame's
101    relative level, function name, argument list, and file name and
102    line number.  If the frame's PC is not at the beginning of the
103    source line, the actual PC is printed at the beginning.  */
104
105 void
106 print_stack_frame (struct frame_info *frame, int print_level,
107                    enum print_what print_what)
108 {
109   struct print_stack_frame_args args;
110
111   args.frame = frame;
112   args.print_level = print_level;
113   args.print_what = print_what;
114   /* For mi, alway print location and address.  */
115   args.print_what = ui_out_is_mi_like_p (uiout) ? LOC_AND_ADDRESS : print_what;
116   args.print_args = 1;
117
118   catch_errors (print_stack_frame_stub, &args, "", RETURN_MASK_ERROR);
119 }  
120
121 struct print_args_args
122 {
123   struct symbol *func;
124   struct frame_info *frame;
125   struct ui_file *stream;
126 };
127
128 static int print_args_stub (void *args);
129
130 /* Print nameless arguments of frame FRAME on STREAM, where START is
131    the offset of the first nameless argument, and NUM is the number of
132    nameless arguments to print.  FIRST is nonzero if this is the first
133    argument (not just the first nameless argument).  */
134
135 static void
136 print_frame_nameless_args (struct frame_info *frame, long start, int num,
137                            int first, struct ui_file *stream)
138 {
139   int i;
140   CORE_ADDR argsaddr;
141   long arg_value;
142
143   for (i = 0; i < num; i++)
144     {
145       QUIT;
146       argsaddr = get_frame_args_address (frame);
147       if (!argsaddr)
148         return;
149       arg_value = read_memory_integer (argsaddr + start, sizeof (int));
150       if (!first)
151         fprintf_filtered (stream, ", ");
152       fprintf_filtered (stream, "%ld", arg_value);
153       first = 0;
154       start += sizeof (int);
155     }
156 }
157
158 /* Return non-zero if the debugger should print the value of the provided
159    symbol parameter (SYM).  */
160
161 static int
162 print_this_frame_argument_p (struct symbol *sym)
163 {
164   struct type *type;
165   
166   /* If the user asked to print no argument at all, then obviously
167      do not print this argument.  */
168
169   if (strcmp (print_frame_arguments, "none") == 0)
170     return 0;
171
172   /* If the user asked to print all arguments, then we should print
173      that one.  */
174
175   if (strcmp (print_frame_arguments, "all") == 0)
176     return 1;
177
178   /* The user asked to print only the scalar arguments, so do not
179      print the non-scalar ones.  */
180
181   type = CHECK_TYPEDEF (SYMBOL_TYPE (sym));
182   while (TYPE_CODE (type) == TYPE_CODE_REF)
183     type = CHECK_TYPEDEF (TYPE_TARGET_TYPE (type));
184   switch (TYPE_CODE (type))
185     {
186       case TYPE_CODE_ARRAY:
187       case TYPE_CODE_STRUCT:
188       case TYPE_CODE_UNION:
189       case TYPE_CODE_SET:
190       case TYPE_CODE_STRING:
191       case TYPE_CODE_BITSTRING:
192         return 0;
193       default:
194         return 1;
195     }
196 }
197
198 /* Print the arguments of frame FRAME on STREAM, given the function
199    FUNC running in that frame (as a symbol), where NUM is the number
200    of arguments according to the stack frame (or -1 if the number of
201    arguments is unknown).  */
202
203 /* Note that currently the "number of argumentss according to the
204    stack frame" is only known on VAX where i refers to the "number of
205    ints of argumentss according to the stack frame".  */
206
207 static void
208 print_frame_args (struct symbol *func, struct frame_info *frame,
209                   int num, struct ui_file *stream)
210 {
211   int first = 1;
212   /* Offset of next stack argument beyond the one we have seen that is
213      at the highest offset, or -1 if we haven't come to a stack
214      argument yet.  */
215   long highest_offset = -1;
216   /* Number of ints of arguments that we have printed so far.  */
217   int args_printed = 0;
218   struct cleanup *old_chain, *list_chain;
219   struct ui_stream *stb;
220
221   stb = ui_out_stream_new (uiout);
222   old_chain = make_cleanup_ui_out_stream_delete (stb);
223
224   if (func)
225     {
226       struct block *b = SYMBOL_BLOCK_VALUE (func);
227       struct dict_iterator iter;
228       struct symbol *sym;
229       struct value *val;
230
231       ALL_BLOCK_SYMBOLS (b, iter, sym)
232         {
233           QUIT;
234
235           /* Keep track of the highest stack argument offset seen, and
236              skip over any kinds of symbols we don't care about.  */
237
238           if (!SYMBOL_IS_ARGUMENT (sym))
239             continue;
240
241           switch (SYMBOL_CLASS (sym))
242             {
243             case LOC_ARG:
244             case LOC_REF_ARG:
245               {
246                 long current_offset = SYMBOL_VALUE (sym);
247                 int arg_size = TYPE_LENGTH (SYMBOL_TYPE (sym));
248
249                 /* Compute address of next argument by adding the size of
250                    this argument and rounding to an int boundary.  */
251                 current_offset =
252                   ((current_offset + arg_size + sizeof (int) - 1)
253                    & ~(sizeof (int) - 1));
254
255                 /* If this is the highest offset seen yet, set
256                    highest_offset.  */
257                 if (highest_offset == -1
258                     || (current_offset > highest_offset))
259                   highest_offset = current_offset;
260
261                 /* Add the number of ints we're about to print to
262                    args_printed.  */
263                 args_printed += (arg_size + sizeof (int) - 1) / sizeof (int);
264               }
265
266               /* We care about types of symbols, but don't need to
267                  keep track of stack offsets in them.  */
268             case LOC_REGISTER:
269             case LOC_REGPARM_ADDR:
270             case LOC_COMPUTED:
271             case LOC_OPTIMIZED_OUT:
272             default:
273               break;
274             }
275
276           /* We have to look up the symbol because arguments can have
277              two entries (one a parameter, one a local) and the one we
278              want is the local, which lookup_symbol will find for us.
279              This includes gcc1 (not gcc2) on SPARC when passing a
280              small structure and gcc2 when the argument type is float
281              and it is passed as a double and converted to float by
282              the prologue (in the latter case the type of the LOC_ARG
283              symbol is double and the type of the LOC_LOCAL symbol is
284              float).  */
285           /* But if the parameter name is null, don't try it.  Null
286              parameter names occur on the RS/6000, for traceback
287              tables.  FIXME, should we even print them?  */
288
289           if (*DEPRECATED_SYMBOL_NAME (sym))
290             {
291               struct symbol *nsym;
292               nsym = lookup_symbol (DEPRECATED_SYMBOL_NAME (sym),
293                                     b, VAR_DOMAIN, NULL);
294               gdb_assert (nsym != NULL);
295               if (SYMBOL_CLASS (nsym) == LOC_REGISTER
296                   && !SYMBOL_IS_ARGUMENT (nsym))
297                 {
298                   /* There is a LOC_ARG/LOC_REGISTER pair.  This means
299                      that it was passed on the stack and loaded into a
300                      register, or passed in a register and stored in a
301                      stack slot.  GDB 3.x used the LOC_ARG; GDB
302                      4.0-4.11 used the LOC_REGISTER.
303
304                      Reasons for using the LOC_ARG:
305
306                      (1) Because find_saved_registers may be slow for
307                          remote debugging.
308
309                      (2) Because registers are often re-used and stack
310                          slots rarely (never?) are.  Therefore using
311                          the stack slot is much less likely to print
312                          garbage.
313
314                      Reasons why we might want to use the LOC_REGISTER:
315
316                      (1) So that the backtrace prints the same value
317                          as "print foo".  I see no compelling reason
318                          why this needs to be the case; having the
319                          backtrace print the value which was passed
320                          in, and "print foo" print the value as
321                          modified within the called function, makes
322                          perfect sense to me.
323
324                      Additional note: It might be nice if "info args"
325                      displayed both values.
326
327                      One more note: There is a case with SPARC
328                      structure passing where we need to use the
329                      LOC_REGISTER, but this is dealt with by creating
330                      a single LOC_REGPARM in symbol reading.  */
331
332                   /* Leave sym (the LOC_ARG) alone.  */
333                   ;
334                 }
335               else
336                 sym = nsym;
337             }
338
339           /* Print the current arg.  */
340           if (!first)
341             ui_out_text (uiout, ", ");
342           ui_out_wrap_hint (uiout, "    ");
343
344           annotate_arg_begin ();
345
346           list_chain = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
347           fprintf_symbol_filtered (stb->stream, SYMBOL_PRINT_NAME (sym),
348                                    SYMBOL_LANGUAGE (sym),
349                                    DMGL_PARAMS | DMGL_ANSI);
350           ui_out_field_stream (uiout, "name", stb);
351           annotate_arg_name_end ();
352           ui_out_text (uiout, "=");
353
354           if (print_this_frame_argument_p (sym))
355             {
356               /* Avoid value_print because it will deref ref parameters.
357                  We just want to print their addresses.  Print ??? for
358                  args whose address we do not know.  We pass 2 as
359                  "recurse" to val_print because our standard indentation
360                  here is 4 spaces, and val_print indents 2 for each
361                  recurse.  */
362               val = read_var_value (sym, frame);
363
364               annotate_arg_value (val == NULL ? NULL : value_type (val));
365
366               if (val)
367                 {
368                   const struct language_defn *language;
369
370                   /* Use the appropriate language to display our symbol,
371                      unless the user forced the language to a specific
372                      language.  */
373                   if (language_mode == language_mode_auto)
374                     language = language_def (SYMBOL_LANGUAGE (sym));
375                   else
376                     language = current_language;
377
378                   common_val_print (val, stb->stream, 0, 0, 2,
379                                     Val_no_prettyprint, language);
380                   ui_out_field_stream (uiout, "value", stb);
381                 }
382               else
383                 ui_out_text (uiout, "???");
384             }
385           else
386             ui_out_text (uiout, "...");
387
388
389           /* Invoke ui_out_tuple_end.  */
390           do_cleanups (list_chain);
391
392           annotate_arg_end ();
393
394           first = 0;
395         }
396     }
397
398   /* Don't print nameless args in situations where we don't know
399      enough about the stack to find them.  */
400   if (num != -1)
401     {
402       long start;
403
404       if (highest_offset == -1)
405         start = gdbarch_frame_args_skip (get_frame_arch (frame));
406       else
407         start = highest_offset;
408
409       print_frame_nameless_args (frame, start, num - args_printed,
410                                  first, stream);
411     }
412
413   do_cleanups (old_chain);
414 }
415
416 /* Stub for catch_errors.  */
417
418 static int
419 print_args_stub (void *args)
420 {
421   struct print_args_args *p = args;
422   struct gdbarch *gdbarch = get_frame_arch (p->frame);
423   int numargs;
424
425   if (gdbarch_frame_num_args_p (gdbarch))
426     {
427       numargs = gdbarch_frame_num_args (gdbarch, p->frame);
428       gdb_assert (numargs >= 0);
429     }
430   else
431     numargs = -1;
432   print_frame_args (p->func, p->frame, numargs, p->stream);
433   return 0;
434 }
435
436 /* Set the current source and line to the location given by frame
437    FRAME, if possible.  When CENTER is true, adjust so the relevant
438    line is in the center of the next 'list'.  */
439
440 void
441 set_current_sal_from_frame (struct frame_info *frame, int center)
442 {
443   struct symtab_and_line sal;
444
445   find_frame_sal (frame, &sal);
446   if (sal.symtab)
447     {
448       if (center)
449         sal.line = max (sal.line - get_lines_to_list () / 2, 1);
450       set_current_source_symtab_and_line (&sal);
451     }
452 }
453
454 /* Print information about frame FRAME.  The output is format according
455    to PRINT_LEVEL and PRINT_WHAT and PRINT ARGS.  The meaning of
456    PRINT_WHAT is:
457    
458    SRC_LINE: Print only source line.
459    LOCATION: Print only location.
460    LOC_AND_SRC: Print location and source line.
461
462    Used in "where" output, and to emit breakpoint or step
463    messages.  */
464
465 void
466 print_frame_info (struct frame_info *frame, int print_level,
467                   enum print_what print_what, int print_args)
468 {
469   struct symtab_and_line sal;
470   int source_print;
471   int location_print;
472
473   if (get_frame_type (frame) == DUMMY_FRAME
474       || get_frame_type (frame) == SIGTRAMP_FRAME)
475     {
476       struct cleanup *uiout_cleanup
477         = make_cleanup_ui_out_tuple_begin_end (uiout, "frame");
478
479       annotate_frame_begin (print_level ? frame_relative_level (frame) : 0,
480                             get_frame_pc (frame));
481
482       /* Do this regardless of SOURCE because we don't have any source
483          to list for this frame.  */
484       if (print_level)
485         {
486           ui_out_text (uiout, "#");
487           ui_out_field_fmt_int (uiout, 2, ui_left, "level",
488                                 frame_relative_level (frame));
489         }
490       if (ui_out_is_mi_like_p (uiout))
491         {
492           annotate_frame_address ();
493           ui_out_field_core_addr (uiout, "addr", get_frame_pc (frame));
494           annotate_frame_address_end ();
495         }
496
497       if (get_frame_type (frame) == DUMMY_FRAME)
498         {
499           annotate_function_call ();
500           ui_out_field_string (uiout, "func", "<function called from gdb>");
501         }
502       else if (get_frame_type (frame) == SIGTRAMP_FRAME)
503         {
504           annotate_signal_handler_caller ();
505           ui_out_field_string (uiout, "func", "<signal handler called>");
506         }
507       ui_out_text (uiout, "\n");
508       annotate_frame_end ();
509
510       do_cleanups (uiout_cleanup);
511       return;
512     }
513
514   /* If FRAME is not the innermost frame, that normally means that
515      FRAME->pc points to *after* the call instruction, and we want to
516      get the line containing the call, never the next line.  But if
517      the next frame is a SIGTRAMP_FRAME or a DUMMY_FRAME, then the
518      next frame was not entered as the result of a call, and we want
519      to get the line containing FRAME->pc.  */
520   find_frame_sal (frame, &sal);
521
522   location_print = (print_what == LOCATION 
523                     || print_what == LOC_AND_ADDRESS
524                     || print_what == SRC_AND_LOC);
525
526   if (location_print || !sal.symtab)
527     print_frame (frame, print_level, print_what, print_args, sal);
528
529   source_print = (print_what == SRC_LINE || print_what == SRC_AND_LOC);
530
531   if (source_print && sal.symtab)
532     {
533       int done = 0;
534       int mid_statement = ((print_what == SRC_LINE)
535                            && (get_frame_pc (frame) != sal.pc));
536
537       if (annotation_level)
538         done = identify_source_line (sal.symtab, sal.line, mid_statement,
539                                      get_frame_pc (frame));
540       if (!done)
541         {
542           if (deprecated_print_frame_info_listing_hook)
543             deprecated_print_frame_info_listing_hook (sal.symtab, 
544                                                       sal.line, 
545                                                       sal.line + 1, 0);
546           else
547             {
548               /* We used to do this earlier, but that is clearly
549                  wrong. This function is used by many different
550                  parts of gdb, including normal_stop in infrun.c,
551                  which uses this to print out the current PC
552                  when we stepi/nexti into the middle of a source
553                  line. Only the command line really wants this
554                  behavior. Other UIs probably would like the
555                  ability to decide for themselves if it is desired.  */
556               if (addressprint && mid_statement)
557                 {
558                   ui_out_field_core_addr (uiout, "addr", get_frame_pc (frame));
559                   ui_out_text (uiout, "\t");
560                 }
561
562               print_source_lines (sal.symtab, sal.line, sal.line + 1, 0);
563             }
564         }
565     }
566
567   if (print_what != LOCATION)
568     set_default_breakpoint (1, get_frame_pc (frame), sal.symtab, sal.line);
569
570   annotate_frame_end ();
571
572   gdb_flush (gdb_stdout);
573 }
574
575 static void
576 print_frame (struct frame_info *frame, int print_level,
577              enum print_what print_what, int print_args,
578              struct symtab_and_line sal)
579 {
580   struct symbol *func;
581   char *funname = NULL;
582   enum language funlang = language_unknown;
583   struct ui_stream *stb;
584   struct cleanup *old_chain, *list_chain;
585
586   stb = ui_out_stream_new (uiout);
587   old_chain = make_cleanup_ui_out_stream_delete (stb);
588
589   func = find_pc_function (get_frame_address_in_block (frame));
590   if (func)
591     {
592       /* In certain pathological cases, the symtabs give the wrong
593          function (when we are in the first function in a file which
594          is compiled without debugging symbols, the previous function
595          is compiled with debugging symbols, and the "foo.o" symbol
596          that is supposed to tell us where the file with debugging
597          symbols ends has been truncated by ar because it is longer
598          than 15 characters).  This also occurs if the user uses asm()
599          to create a function but not stabs for it (in a file compiled
600          with -g).
601
602          So look in the minimal symbol tables as well, and if it comes
603          up with a larger address for the function use that instead.
604          I don't think this can ever cause any problems; there
605          shouldn't be any minimal symbols in the middle of a function;
606          if this is ever changed many parts of GDB will need to be
607          changed (and we'll create a find_pc_minimal_function or some
608          such).  */
609
610       struct minimal_symbol *msymbol =
611         lookup_minimal_symbol_by_pc (get_frame_address_in_block (frame));
612
613       if (msymbol != NULL
614           && (SYMBOL_VALUE_ADDRESS (msymbol)
615               > BLOCK_START (SYMBOL_BLOCK_VALUE (func))))
616         {
617           /* We also don't know anything about the function besides
618              its address and name.  */
619           func = 0;
620           funname = DEPRECATED_SYMBOL_NAME (msymbol);
621           funlang = SYMBOL_LANGUAGE (msymbol);
622         }
623       else
624         {
625           funname = DEPRECATED_SYMBOL_NAME (func);
626           funlang = SYMBOL_LANGUAGE (func);
627           if (funlang == language_cplus)
628             {
629               /* It seems appropriate to use SYMBOL_PRINT_NAME() here,
630                  to display the demangled name that we already have
631                  stored in the symbol table, but we stored a version
632                  with DMGL_PARAMS turned on, and here we don't want to
633                  display parameters. So call the demangler again, with
634                  DMGL_ANSI only.
635
636                  Yes, printf_symbol_filtered() will again try to
637                  demangle the name on the fly, but the issue is that
638                  if cplus_demangle() fails here, it will fail there
639                  too. So we want to catch the failure (where DEMANGLED
640                  is NULL below) here, while we still have our hands on
641                  the function symbol.)  */
642               char *demangled = cplus_demangle (funname, DMGL_ANSI);
643               if (demangled == NULL)
644                 /* If the demangler fails, try the demangled name from
645                    the symbol table. That'll have parameters, but
646                    that's preferable to displaying a mangled name.  */
647                 funname = SYMBOL_PRINT_NAME (func);
648               else
649                 xfree (demangled);
650             }
651         }
652     }
653   else
654     {
655       struct minimal_symbol *msymbol = 
656         lookup_minimal_symbol_by_pc (get_frame_address_in_block (frame));
657
658       if (msymbol != NULL)
659         {
660           funname = DEPRECATED_SYMBOL_NAME (msymbol);
661           funlang = SYMBOL_LANGUAGE (msymbol);
662         }
663     }
664
665   annotate_frame_begin (print_level ? frame_relative_level (frame) : 0,
666                         get_frame_pc (frame));
667
668   list_chain = make_cleanup_ui_out_tuple_begin_end (uiout, "frame");
669
670   if (print_level)
671     {
672       ui_out_text (uiout, "#");
673       ui_out_field_fmt_int (uiout, 2, ui_left, "level",
674                             frame_relative_level (frame));
675     }
676   if (addressprint)
677     if (get_frame_pc (frame) != sal.pc || !sal.symtab
678         || print_what == LOC_AND_ADDRESS)
679       {
680         annotate_frame_address ();
681         ui_out_field_core_addr (uiout, "addr", get_frame_pc (frame));
682         annotate_frame_address_end ();
683         ui_out_text (uiout, " in ");
684       }
685   annotate_frame_function_name ();
686   fprintf_symbol_filtered (stb->stream, funname ? funname : "??",
687                            funlang, DMGL_ANSI);
688   ui_out_field_stream (uiout, "func", stb);
689   ui_out_wrap_hint (uiout, "   ");
690   annotate_frame_args ();
691       
692   ui_out_text (uiout, " (");
693   if (print_args)
694     {
695       struct print_args_args args;
696       struct cleanup *args_list_chain;
697       args.frame = frame;
698       args.func = func;
699       args.stream = gdb_stdout;
700       args_list_chain = make_cleanup_ui_out_list_begin_end (uiout, "args");
701       catch_errors (print_args_stub, &args, "", RETURN_MASK_ERROR);
702       /* FIXME: ARGS must be a list. If one argument is a string it
703           will have " that will not be properly escaped.  */
704       /* Invoke ui_out_tuple_end.  */
705       do_cleanups (args_list_chain);
706       QUIT;
707     }
708   ui_out_text (uiout, ")");
709   if (sal.symtab && sal.symtab->filename)
710     {
711       annotate_frame_source_begin ();
712       ui_out_wrap_hint (uiout, "   ");
713       ui_out_text (uiout, " at ");
714       annotate_frame_source_file ();
715       ui_out_field_string (uiout, "file", sal.symtab->filename);
716       if (ui_out_is_mi_like_p (uiout))
717         {
718           const char *fullname = symtab_to_fullname (sal.symtab);
719           if (fullname != NULL)
720             ui_out_field_string (uiout, "fullname", fullname);
721         }
722       annotate_frame_source_file_end ();
723       ui_out_text (uiout, ":");
724       annotate_frame_source_line ();
725       ui_out_field_int (uiout, "line", sal.line);
726       annotate_frame_source_end ();
727     }
728
729   if (!funname || (!sal.symtab || !sal.symtab->filename))
730     {
731 #ifdef PC_SOLIB
732       char *lib = PC_SOLIB (get_frame_pc (frame));
733 #else
734       char *lib = solib_address (get_frame_pc (frame));
735 #endif
736       if (lib)
737         {
738           annotate_frame_where ();
739           ui_out_wrap_hint (uiout, "  ");
740           ui_out_text (uiout, " from ");
741           ui_out_field_string (uiout, "from", lib);
742         }
743     }
744
745   /* do_cleanups will call ui_out_tuple_end() for us.  */
746   do_cleanups (list_chain);
747   ui_out_text (uiout, "\n");
748   do_cleanups (old_chain);
749 }
750 \f
751
752 /* Read a frame specification in whatever the appropriate format is
753    from FRAME_EXP.  Call error(), printing MESSAGE, if the
754    specification is in any way invalid (so this function never returns
755    NULL).  When SEPECTED_P is non-NULL set its target to indicate that
756    the default selected frame was used.  */
757
758 static struct frame_info *
759 parse_frame_specification_1 (const char *frame_exp, const char *message,
760                              int *selected_frame_p)
761 {
762   int numargs;
763   struct value *args[4];
764   CORE_ADDR addrs[ARRAY_SIZE (args)];
765
766   if (frame_exp == NULL)
767     numargs = 0;
768   else
769     {
770       char *addr_string;
771       struct cleanup *tmp_cleanup;
772
773       numargs = 0;
774       while (1)
775         {
776           char *addr_string;
777           struct cleanup *cleanup;
778           const char *p;
779
780           /* Skip leading white space, bail of EOL.  */
781           while (isspace (*frame_exp))
782             frame_exp++;
783           if (!*frame_exp)
784             break;
785
786           /* Parse the argument, extract it, save it.  */
787           for (p = frame_exp;
788                *p && !isspace (*p);
789                p++);
790           addr_string = savestring (frame_exp, p - frame_exp);
791           frame_exp = p;
792           cleanup = make_cleanup (xfree, addr_string);
793           
794           /* NOTE: Parse and evaluate expression, but do not use
795              functions such as parse_and_eval_long or
796              parse_and_eval_address to also extract the value.
797              Instead value_as_long and value_as_address are used.
798              This avoids problems with expressions that contain
799              side-effects.  */
800           if (numargs >= ARRAY_SIZE (args))
801             error (_("Too many args in frame specification"));
802           args[numargs++] = parse_and_eval (addr_string);
803
804           do_cleanups (cleanup);
805         }
806     }
807
808   /* If no args, default to the selected frame.  */
809   if (numargs == 0)
810     {
811       if (selected_frame_p != NULL)
812         (*selected_frame_p) = 1;
813       return get_selected_frame (message);
814     }
815
816   /* None of the remaining use the selected frame.  */
817   if (selected_frame_p != NULL)
818     (*selected_frame_p) = 0;
819
820   /* Assume the single arg[0] is an integer, and try using that to
821      select a frame relative to current.  */
822   if (numargs == 1)
823     {
824       struct frame_info *fid;
825       int level = value_as_long (args[0]);
826       fid = find_relative_frame (get_current_frame (), &level);
827       if (level == 0)
828         /* find_relative_frame was successful */
829         return fid;
830     }
831
832   /* Convert each value into a corresponding address.  */
833   {
834     int i;
835     for (i = 0; i < numargs; i++)
836       addrs[i] = value_as_address (args[0]);
837   }
838
839   /* Assume that the single arg[0] is an address, use that to identify
840      a frame with a matching ID.  Should this also accept stack/pc or
841      stack/pc/special.  */
842   if (numargs == 1)
843     {
844       struct frame_id id = frame_id_build_wild (addrs[0]);
845       struct frame_info *fid;
846
847       /* If (s)he specifies the frame with an address, he deserves
848          what (s)he gets.  Still, give the highest one that matches.
849          (NOTE: cagney/2004-10-29: Why highest, or outer-most, I don't
850          know).  */
851       for (fid = get_current_frame ();
852            fid != NULL;
853            fid = get_prev_frame (fid))
854         {
855           if (frame_id_eq (id, get_frame_id (fid)))
856             {
857               while (frame_id_eq (id, frame_unwind_id (fid)))
858                 fid = get_prev_frame (fid);
859               return fid;
860             }
861         }
862       }
863
864   /* We couldn't identify the frame as an existing frame, but
865      perhaps we can create one with a single argument.  */
866   if (numargs == 1)
867     return create_new_frame (addrs[0], 0);
868   else if (numargs == 2)
869     return create_new_frame (addrs[0], addrs[1]);
870   else
871     error (_("Too many args in frame specification"));
872 }
873
874 static struct frame_info *
875 parse_frame_specification (char *frame_exp)
876 {
877   return parse_frame_specification_1 (frame_exp, NULL, NULL);
878 }
879
880 /* Print verbosely the selected frame or the frame at address
881    ADDR_EXP.  Absolutely all information in the frame is printed.  */
882
883 static void
884 frame_info (char *addr_exp, int from_tty)
885 {
886   struct frame_info *fi;
887   struct symtab_and_line sal;
888   struct symbol *func;
889   struct symtab *s;
890   struct frame_info *calling_frame_info;
891   int i, count, numregs;
892   char *funname = 0;
893   enum language funlang = language_unknown;
894   const char *pc_regname;
895   int selected_frame_p;
896   struct gdbarch *gdbarch;
897
898   fi = parse_frame_specification_1 (addr_exp, "No stack.", &selected_frame_p);
899   gdbarch = get_frame_arch (fi);
900
901   /* Name of the value returned by get_frame_pc().  Per comments, "pc"
902      is not a good name.  */
903   if (gdbarch_pc_regnum (gdbarch) >= 0)
904     /* OK, this is weird.  The gdbarch_pc_regnum hardware register's value can
905        easily not match that of the internal value returned by
906        get_frame_pc().  */
907     pc_regname = gdbarch_register_name (gdbarch, gdbarch_pc_regnum (gdbarch));
908   else
909     /* But then, this is weird to.  Even without gdbarch_pc_regnum, an
910        architectures will often have a hardware register called "pc",
911        and that register's value, again, can easily not match
912        get_frame_pc().  */
913     pc_regname = "pc";
914
915   find_frame_sal (fi, &sal);
916   func = get_frame_function (fi);
917   /* FIXME: cagney/2002-11-28: Why bother?  Won't sal.symtab contain
918      the same value?  */
919   s = find_pc_symtab (get_frame_pc (fi));
920   if (func)
921     {
922       /* It seems appropriate to use SYMBOL_PRINT_NAME() here, to
923          display the demangled name that we already have stored in the
924          symbol table, but we stored a version with DMGL_PARAMS turned
925          on, and here we don't want to display parameters. So call the
926          demangler again, with DMGL_ANSI only.
927
928          Yes, printf_symbol_filtered() will again try to demangle the
929          name on the fly, but the issue is that if cplus_demangle()
930          fails here, it will fail there too. So we want to catch the
931          failure (where DEMANGLED is NULL below) here, while we still
932          have our hands on the function symbol.)  */
933       funname = DEPRECATED_SYMBOL_NAME (func);
934       funlang = SYMBOL_LANGUAGE (func);
935       if (funlang == language_cplus)
936         {
937           char *demangled = cplus_demangle (funname, DMGL_ANSI);
938           /* If the demangler fails, try the demangled name from the
939              symbol table. That'll have parameters, but that's
940              preferable to displaying a mangled name.  */
941           if (demangled == NULL)
942             funname = SYMBOL_PRINT_NAME (func);
943           else
944             xfree (demangled);
945         }
946     }
947   else
948     {
949       struct minimal_symbol *msymbol;
950
951       msymbol = lookup_minimal_symbol_by_pc (get_frame_pc (fi));
952       if (msymbol != NULL)
953         {
954           funname = DEPRECATED_SYMBOL_NAME (msymbol);
955           funlang = SYMBOL_LANGUAGE (msymbol);
956         }
957     }
958   calling_frame_info = get_prev_frame (fi);
959
960   if (selected_frame_p && frame_relative_level (fi) >= 0)
961     {
962       printf_filtered (_("Stack level %d, frame at "),
963                        frame_relative_level (fi));
964     }
965   else
966     {
967       printf_filtered (_("Stack frame at "));
968     }
969   fputs_filtered (paddress (get_frame_base (fi)), gdb_stdout);
970   printf_filtered (":\n");
971   printf_filtered (" %s = ", pc_regname);
972   fputs_filtered (paddress (get_frame_pc (fi)), gdb_stdout);
973
974   wrap_here ("   ");
975   if (funname)
976     {
977       printf_filtered (" in ");
978       fprintf_symbol_filtered (gdb_stdout, funname, funlang,
979                                DMGL_ANSI | DMGL_PARAMS);
980     }
981   wrap_here ("   ");
982   if (sal.symtab)
983     printf_filtered (" (%s:%d)", sal.symtab->filename, sal.line);
984   puts_filtered ("; ");
985   wrap_here ("    ");
986   printf_filtered ("saved %s ", pc_regname);
987   fputs_filtered (paddress (frame_pc_unwind (fi)), gdb_stdout);
988   printf_filtered ("\n");
989
990   if (calling_frame_info == NULL)
991     {
992       enum unwind_stop_reason reason;
993
994       reason = get_frame_unwind_stop_reason (fi);
995       if (reason != UNWIND_NO_REASON)
996         printf_filtered (_(" Outermost frame: %s\n"),
997                          frame_stop_reason_string (reason));
998     }
999
1000   if (calling_frame_info)
1001     {
1002       printf_filtered (" called by frame at ");
1003       fputs_filtered (paddress (get_frame_base (calling_frame_info)),
1004                       gdb_stdout);
1005     }
1006   if (get_next_frame (fi) && calling_frame_info)
1007     puts_filtered (",");
1008   wrap_here ("   ");
1009   if (get_next_frame (fi))
1010     {
1011       printf_filtered (" caller of frame at ");
1012       fputs_filtered (paddress (get_frame_base (get_next_frame (fi))),
1013                       gdb_stdout);
1014     }
1015   if (get_next_frame (fi) || calling_frame_info)
1016     puts_filtered ("\n");
1017
1018   if (s)
1019     printf_filtered (" source language %s.\n",
1020                      language_str (s->language));
1021
1022   {
1023     /* Address of the argument list for this frame, or 0.  */
1024     CORE_ADDR arg_list = get_frame_args_address (fi);
1025     /* Number of args for this frame, or -1 if unknown.  */
1026     int numargs;
1027
1028     if (arg_list == 0)
1029       printf_filtered (" Arglist at unknown address.\n");
1030     else
1031       {
1032         printf_filtered (" Arglist at ");
1033         fputs_filtered (paddress (arg_list), gdb_stdout);
1034         printf_filtered (",");
1035
1036         if (!gdbarch_frame_num_args_p (gdbarch))
1037           {
1038             numargs = -1;
1039             puts_filtered (" args: ");
1040           }
1041         else
1042           {
1043             numargs = gdbarch_frame_num_args (gdbarch, fi);
1044             gdb_assert (numargs >= 0);
1045             if (numargs == 0)
1046               puts_filtered (" no args.");
1047             else if (numargs == 1)
1048               puts_filtered (" 1 arg: ");
1049             else
1050               printf_filtered (" %d args: ", numargs);
1051           }
1052         print_frame_args (func, fi, numargs, gdb_stdout);
1053         puts_filtered ("\n");
1054       }
1055   }
1056   {
1057     /* Address of the local variables for this frame, or 0.  */
1058     CORE_ADDR arg_list = get_frame_locals_address (fi);
1059
1060     if (arg_list == 0)
1061       printf_filtered (" Locals at unknown address,");
1062     else
1063       {
1064         printf_filtered (" Locals at ");
1065         fputs_filtered (paddress (arg_list), gdb_stdout);
1066         printf_filtered (",");
1067       }
1068   }
1069
1070   /* Print as much information as possible on the location of all the
1071      registers.  */
1072   {
1073     enum lval_type lval;
1074     int optimized;
1075     CORE_ADDR addr;
1076     int realnum;
1077     int count;
1078     int i;
1079     int need_nl = 1;
1080
1081     /* The sp is special; what's displayed isn't the save address, but
1082        the value of the previous frame's sp.  This is a legacy thing,
1083        at one stage the frame cached the previous frame's SP instead
1084        of its address, hence it was easiest to just display the cached
1085        value.  */
1086     if (gdbarch_sp_regnum (gdbarch) >= 0)
1087       {
1088         /* Find out the location of the saved stack pointer with out
1089            actually evaluating it.  */
1090         frame_register_unwind (fi, gdbarch_sp_regnum (gdbarch),
1091                                &optimized, &lval, &addr,
1092                                &realnum, NULL);
1093         if (!optimized && lval == not_lval)
1094           {
1095             gdb_byte value[MAX_REGISTER_SIZE];
1096             CORE_ADDR sp;
1097             frame_register_unwind (fi, gdbarch_sp_regnum (gdbarch),
1098                                    &optimized, &lval, &addr,
1099                                    &realnum, value);
1100             /* NOTE: cagney/2003-05-22: This is assuming that the
1101                stack pointer was packed as an unsigned integer.  That
1102                may or may not be valid.  */
1103             sp = extract_unsigned_integer (value,
1104                                            register_size (gdbarch,
1105                                            gdbarch_sp_regnum (gdbarch)));
1106             printf_filtered (" Previous frame's sp is ");
1107             fputs_filtered (paddress (sp), gdb_stdout);
1108             printf_filtered ("\n");
1109             need_nl = 0;
1110           }
1111         else if (!optimized && lval == lval_memory)
1112           {
1113             printf_filtered (" Previous frame's sp at ");
1114             fputs_filtered (paddress (addr), gdb_stdout);
1115             printf_filtered ("\n");
1116             need_nl = 0;
1117           }
1118         else if (!optimized && lval == lval_register)
1119           {
1120             printf_filtered (" Previous frame's sp in %s\n",
1121                              gdbarch_register_name (gdbarch, realnum));
1122             need_nl = 0;
1123           }
1124         /* else keep quiet.  */
1125       }
1126
1127     count = 0;
1128     numregs = gdbarch_num_regs (gdbarch)
1129               + gdbarch_num_pseudo_regs (gdbarch);
1130     for (i = 0; i < numregs; i++)
1131       if (i != gdbarch_sp_regnum (gdbarch)
1132           && gdbarch_register_reggroup_p (gdbarch, i, all_reggroup))
1133         {
1134           /* Find out the location of the saved register without
1135              fetching the corresponding value.  */
1136           frame_register_unwind (fi, i, &optimized, &lval, &addr, &realnum,
1137                                  NULL);
1138           /* For moment, only display registers that were saved on the
1139              stack.  */
1140           if (!optimized && lval == lval_memory)
1141             {
1142               if (count == 0)
1143                 puts_filtered (" Saved registers:\n ");
1144               else
1145                 puts_filtered (",");
1146               wrap_here (" ");
1147               printf_filtered (" %s at ",
1148                                gdbarch_register_name (gdbarch, i));
1149               fputs_filtered (paddress (addr), gdb_stdout);
1150               count++;
1151             }
1152         }
1153     if (count || need_nl)
1154       puts_filtered ("\n");
1155   }
1156 }
1157
1158 /* Print briefly all stack frames or just the innermost COUNT_EXP
1159    frames.  */
1160
1161 static void
1162 backtrace_command_1 (char *count_exp, int show_locals, int from_tty)
1163 {
1164   struct frame_info *fi;
1165   int count;
1166   int i;
1167   struct frame_info *trailing;
1168   int trailing_level;
1169
1170   if (!target_has_stack)
1171     error (_("No stack."));
1172
1173   /* The following code must do two things.  First, it must set the
1174      variable TRAILING to the frame from which we should start
1175      printing.  Second, it must set the variable count to the number
1176      of frames which we should print, or -1 if all of them.  */
1177   trailing = get_current_frame ();
1178
1179   /* The target can be in a state where there is no valid frames
1180      (e.g., just connected). */
1181   if (trailing == NULL)
1182     error (_("No stack."));
1183
1184   trailing_level = 0;
1185   if (count_exp)
1186     {
1187       count = parse_and_eval_long (count_exp);
1188       if (count < 0)
1189         {
1190           struct frame_info *current;
1191
1192           count = -count;
1193
1194           current = trailing;
1195           while (current && count--)
1196             {
1197               QUIT;
1198               current = get_prev_frame (current);
1199             }
1200
1201           /* Will stop when CURRENT reaches the top of the stack.
1202              TRAILING will be COUNT below it.  */
1203           while (current)
1204             {
1205               QUIT;
1206               trailing = get_prev_frame (trailing);
1207               current = get_prev_frame (current);
1208               trailing_level++;
1209             }
1210
1211           count = -1;
1212         }
1213     }
1214   else
1215     count = -1;
1216
1217   if (info_verbose)
1218     {
1219       struct partial_symtab *ps;
1220
1221       /* Read in symbols for all of the frames.  Need to do this in a
1222          separate pass so that "Reading in symbols for xxx" messages
1223          don't screw up the appearance of the backtrace.  Also if
1224          people have strong opinions against reading symbols for
1225          backtrace this may have to be an option.  */
1226       i = count;
1227       for (fi = trailing; fi != NULL && i--; fi = get_prev_frame (fi))
1228         {
1229           QUIT;
1230           ps = find_pc_psymtab (get_frame_address_in_block (fi));
1231           if (ps)
1232             PSYMTAB_TO_SYMTAB (ps); /* Force syms to come in.  */
1233         }
1234     }
1235
1236   for (i = 0, fi = trailing; fi && count--; i++, fi = get_prev_frame (fi))
1237     {
1238       QUIT;
1239
1240       /* Don't use print_stack_frame; if an error() occurs it probably
1241          means further attempts to backtrace would fail (on the other
1242          hand, perhaps the code does or could be fixed to make sure
1243          the frame->prev field gets set to NULL in that case).  */
1244       print_frame_info (fi, 1, LOCATION, 1);
1245       if (show_locals)
1246         print_frame_local_vars (fi, 1, gdb_stdout);
1247
1248       /* Save the last frame to check for error conditions.  */
1249       trailing = fi;
1250     }
1251
1252   /* If we've stopped before the end, mention that.  */
1253   if (fi && from_tty)
1254     printf_filtered (_("(More stack frames follow...)\n"));
1255
1256   /* If we've run out of frames, and the reason appears to be an error
1257      condition, print it.  */
1258   if (fi == NULL && trailing != NULL)
1259     {
1260       enum unwind_stop_reason reason;
1261
1262       reason = get_frame_unwind_stop_reason (trailing);
1263       if (reason > UNWIND_FIRST_ERROR)
1264         printf_filtered (_("Backtrace stopped: %s\n"),
1265                          frame_stop_reason_string (reason));
1266     }
1267 }
1268
1269 struct backtrace_command_args
1270 {
1271   char *count_exp;
1272   int show_locals;
1273   int from_tty;
1274 };
1275
1276 /* Stub for catch_errors.  */
1277
1278 static int
1279 backtrace_command_stub (void *data)
1280 {
1281   struct backtrace_command_args *args = data;
1282   backtrace_command_1 (args->count_exp, args->show_locals, args->from_tty);
1283   return 0;
1284 }
1285
1286 static void
1287 backtrace_command (char *arg, int from_tty)
1288 {
1289   struct cleanup *old_chain = NULL;
1290   int fulltrace_arg = -1, arglen = 0, argc = 0;
1291   struct backtrace_command_args btargs;
1292
1293   if (arg)
1294     {
1295       char **argv;
1296       int i;
1297
1298       argv = buildargv (arg);
1299       old_chain = make_cleanup_freeargv (argv);
1300       argc = 0;
1301       for (i = 0; argv[i]; i++)
1302         {
1303           unsigned int j;
1304
1305           for (j = 0; j < strlen (argv[i]); j++)
1306             argv[i][j] = tolower (argv[i][j]);
1307
1308           if (fulltrace_arg < 0 && subset_compare (argv[i], "full"))
1309             fulltrace_arg = argc;
1310           else
1311             {
1312               arglen += strlen (argv[i]);
1313               argc++;
1314             }
1315         }
1316       arglen += argc;
1317       if (fulltrace_arg >= 0)
1318         {
1319           if (arglen > 0)
1320             {
1321               arg = xmalloc (arglen + 1);
1322               memset (arg, 0, arglen + 1);
1323               for (i = 0; i < (argc + 1); i++)
1324                 {
1325                   if (i != fulltrace_arg)
1326                     {
1327                       strcat (arg, argv[i]);
1328                       strcat (arg, " ");
1329                     }
1330                 }
1331             }
1332           else
1333             arg = NULL;
1334         }
1335     }
1336
1337   btargs.count_exp = arg;
1338   btargs.show_locals = (fulltrace_arg >= 0);
1339   btargs.from_tty = from_tty;
1340   catch_errors (backtrace_command_stub, &btargs, "", RETURN_MASK_ERROR);
1341
1342   if (fulltrace_arg >= 0 && arglen > 0)
1343     xfree (arg);
1344
1345   if (old_chain)
1346     do_cleanups (old_chain);
1347 }
1348
1349 static void
1350 backtrace_full_command (char *arg, int from_tty)
1351 {
1352   struct backtrace_command_args btargs;
1353   btargs.count_exp = arg;
1354   btargs.show_locals = 1;
1355   btargs.from_tty = from_tty;
1356   catch_errors (backtrace_command_stub, &btargs, "", RETURN_MASK_ERROR);
1357 }
1358 \f
1359
1360 /* Print the local variables of a block B active in FRAME on STREAM.
1361    Return 1 if any variables were printed; 0 otherwise.  */
1362
1363 static int
1364 print_block_frame_locals (struct block *b, struct frame_info *frame,
1365                           int num_tabs, struct ui_file *stream)
1366 {
1367   struct dict_iterator iter;
1368   struct symbol *sym;
1369   int values_printed = 0;
1370   int j;
1371
1372   ALL_BLOCK_SYMBOLS (b, iter, sym)
1373     {
1374       switch (SYMBOL_CLASS (sym))
1375         {
1376         case LOC_LOCAL:
1377         case LOC_REGISTER:
1378         case LOC_STATIC:
1379         case LOC_COMPUTED:
1380           if (SYMBOL_IS_ARGUMENT (sym))
1381             break;
1382           values_printed = 1;
1383           for (j = 0; j < num_tabs; j++)
1384             fputs_filtered ("\t", stream);
1385           fputs_filtered (SYMBOL_PRINT_NAME (sym), stream);
1386           fputs_filtered (" = ", stream);
1387           print_variable_value (sym, frame, stream);
1388           fprintf_filtered (stream, "\n");
1389           break;
1390
1391         default:
1392           /* Ignore symbols which are not locals.  */
1393           break;
1394         }
1395     }
1396
1397   return values_printed;
1398 }
1399
1400 /* Same, but print labels.  */
1401
1402 static int
1403 print_block_frame_labels (struct block *b, int *have_default,
1404                           struct ui_file *stream)
1405 {
1406   struct dict_iterator iter;
1407   struct symbol *sym;
1408   int values_printed = 0;
1409
1410   ALL_BLOCK_SYMBOLS (b, iter, sym)
1411     {
1412       if (strcmp (DEPRECATED_SYMBOL_NAME (sym), "default") == 0)
1413         {
1414           if (*have_default)
1415             continue;
1416           *have_default = 1;
1417         }
1418       if (SYMBOL_CLASS (sym) == LOC_LABEL)
1419         {
1420           struct symtab_and_line sal;
1421           sal = find_pc_line (SYMBOL_VALUE_ADDRESS (sym), 0);
1422           values_printed = 1;
1423           fputs_filtered (SYMBOL_PRINT_NAME (sym), stream);
1424           if (addressprint)
1425             {
1426               fprintf_filtered (stream, " ");
1427               fputs_filtered (paddress (SYMBOL_VALUE_ADDRESS (sym)), stream);
1428             }
1429           fprintf_filtered (stream, " in file %s, line %d\n",
1430                             sal.symtab->filename, sal.line);
1431         }
1432     }
1433
1434   return values_printed;
1435 }
1436
1437 /* Print on STREAM all the local variables in frame FRAME, including
1438    all the blocks active in that frame at its current PC.
1439
1440    Returns 1 if the job was done, or 0 if nothing was printed because
1441    we have no info on the function running in FRAME.  */
1442
1443 static void
1444 print_frame_local_vars (struct frame_info *frame, int num_tabs,
1445                         struct ui_file *stream)
1446 {
1447   struct block *block = get_frame_block (frame, 0);
1448   int values_printed = 0;
1449
1450   if (block == 0)
1451     {
1452       fprintf_filtered (stream, "No symbol table info available.\n");
1453       return;
1454     }
1455
1456   while (block)
1457     {
1458       if (print_block_frame_locals (block, frame, num_tabs, stream))
1459         values_printed = 1;
1460       /* After handling the function's top-level block, stop.  Don't
1461          continue to its superblock, the block of per-file symbols.  */
1462       if (BLOCK_FUNCTION (block))
1463         break;
1464       block = BLOCK_SUPERBLOCK (block);
1465     }
1466
1467   if (!values_printed)
1468     fprintf_filtered (stream, _("No locals.\n"));
1469 }
1470
1471 /* Same, but print labels.  */
1472
1473 static void
1474 print_frame_label_vars (struct frame_info *frame, int this_level_only,
1475                         struct ui_file *stream)
1476 {
1477 #if 1
1478   fprintf_filtered (stream, "print_frame_label_vars disabled.\n");
1479 #else
1480   struct blockvector *bl;
1481   struct block *block = get_frame_block (frame, 0);
1482   int values_printed = 0;
1483   int index, have_default = 0;
1484   char *blocks_printed;
1485   CORE_ADDR pc = get_frame_pc (frame);
1486
1487   if (block == 0)
1488     {
1489       fprintf_filtered (stream, "No symbol table info available.\n");
1490       return;
1491     }
1492
1493   bl = blockvector_for_pc (BLOCK_END (block) - 4, &index);
1494   blocks_printed = alloca (BLOCKVECTOR_NBLOCKS (bl) * sizeof (char));
1495   memset (blocks_printed, 0, BLOCKVECTOR_NBLOCKS (bl) * sizeof (char));
1496
1497   while (block != 0)
1498     {
1499       CORE_ADDR end = BLOCK_END (block) - 4;
1500       int last_index;
1501
1502       if (bl != blockvector_for_pc (end, &index))
1503         error (_("blockvector blotch"));
1504       if (BLOCKVECTOR_BLOCK (bl, index) != block)
1505         error (_("blockvector botch"));
1506       last_index = BLOCKVECTOR_NBLOCKS (bl);
1507       index += 1;
1508
1509       /* Don't print out blocks that have gone by.  */
1510       while (index < last_index
1511              && BLOCK_END (BLOCKVECTOR_BLOCK (bl, index)) < pc)
1512         index++;
1513
1514       while (index < last_index
1515              && BLOCK_END (BLOCKVECTOR_BLOCK (bl, index)) < end)
1516         {
1517           if (blocks_printed[index] == 0)
1518             {
1519               if (print_block_frame_labels (BLOCKVECTOR_BLOCK (bl, index),
1520                                             &have_default, stream))
1521                 values_printed = 1;
1522               blocks_printed[index] = 1;
1523             }
1524           index++;
1525         }
1526       if (have_default)
1527         return;
1528       if (values_printed && this_level_only)
1529         return;
1530
1531       /* After handling the function's top-level block, stop.  Don't
1532          continue to its superblock, the block of per-file symbols.  */
1533       if (BLOCK_FUNCTION (block))
1534         break;
1535       block = BLOCK_SUPERBLOCK (block);
1536     }
1537
1538   if (!values_printed && !this_level_only)
1539     fprintf_filtered (stream, _("No catches.\n"));
1540 #endif
1541 }
1542
1543 void
1544 locals_info (char *args, int from_tty)
1545 {
1546   print_frame_local_vars (get_selected_frame (_("No frame selected.")),
1547                           0, gdb_stdout);
1548 }
1549
1550 static void
1551 catch_info (char *ignore, int from_tty)
1552 {
1553   struct symtab_and_line *sal;
1554
1555   /* Assume g++ compiled code; old GDB 4.16 behaviour.  */
1556   print_frame_label_vars (get_selected_frame (_("No frame selected.")),
1557                           0, gdb_stdout);
1558 }
1559
1560 static void
1561 print_frame_arg_vars (struct frame_info *frame, struct ui_file *stream)
1562 {
1563   struct symbol *func = get_frame_function (frame);
1564   struct block *b;
1565   struct dict_iterator iter;
1566   struct symbol *sym, *sym2;
1567   int values_printed = 0;
1568
1569   if (func == 0)
1570     {
1571       fprintf_filtered (stream, _("No symbol table info available.\n"));
1572       return;
1573     }
1574
1575   b = SYMBOL_BLOCK_VALUE (func);
1576   ALL_BLOCK_SYMBOLS (b, iter, sym)
1577     {
1578       /* Don't worry about things which aren't arguments.  */
1579       if (SYMBOL_IS_ARGUMENT (sym))
1580         {
1581           values_printed = 1;
1582           fputs_filtered (SYMBOL_PRINT_NAME (sym), stream);
1583           fputs_filtered (" = ", stream);
1584
1585           /* We have to look up the symbol because arguments can have
1586              two entries (one a parameter, one a local) and the one we
1587              want is the local, which lookup_symbol will find for us.
1588              This includes gcc1 (not gcc2) on the sparc when passing a
1589              small structure and gcc2 when the argument type is float
1590              and it is passed as a double and converted to float by
1591              the prologue (in the latter case the type of the LOC_ARG
1592              symbol is double and the type of the LOC_LOCAL symbol is
1593              float).  There are also LOC_ARG/LOC_REGISTER pairs which
1594              are not combined in symbol-reading.  */
1595
1596           sym2 = lookup_symbol (DEPRECATED_SYMBOL_NAME (sym),
1597                                 b, VAR_DOMAIN, NULL);
1598           print_variable_value (sym2, frame, stream);
1599           fprintf_filtered (stream, "\n");
1600         }
1601     }
1602
1603   if (!values_printed)
1604     fprintf_filtered (stream, _("No arguments.\n"));
1605 }
1606
1607 void
1608 args_info (char *ignore, int from_tty)
1609 {
1610   print_frame_arg_vars (get_selected_frame (_("No frame selected.")),
1611                         gdb_stdout);
1612 }
1613
1614
1615 static void
1616 args_plus_locals_info (char *ignore, int from_tty)
1617 {
1618   args_info (ignore, from_tty);
1619   locals_info (ignore, from_tty);
1620 }
1621 \f
1622
1623 /* Select frame FRAME.  Also print the stack frame and show the source
1624    if this is the tui version.  */
1625 static void
1626 select_and_print_frame (struct frame_info *frame)
1627 {
1628   select_frame (frame);
1629   if (frame)
1630     print_stack_frame (frame, 1, SRC_AND_LOC);
1631 }
1632 \f
1633 /* Return the symbol-block in which the selected frame is executing.
1634    Can return zero under various legitimate circumstances.
1635
1636    If ADDR_IN_BLOCK is non-zero, set *ADDR_IN_BLOCK to the relevant
1637    code address within the block returned.  We use this to decide
1638    which macros are in scope.  */
1639
1640 struct block *
1641 get_selected_block (CORE_ADDR *addr_in_block)
1642 {
1643   if (!target_has_stack)
1644     return 0;
1645
1646   return get_frame_block (get_selected_frame (NULL), addr_in_block);
1647 }
1648
1649 /* Find a frame a certain number of levels away from FRAME.
1650    LEVEL_OFFSET_PTR points to an int containing the number of levels.
1651    Positive means go to earlier frames (up); negative, the reverse.
1652    The int that contains the number of levels is counted toward
1653    zero as the frames for those levels are found.
1654    If the top or bottom frame is reached, that frame is returned,
1655    but the final value of *LEVEL_OFFSET_PTR is nonzero and indicates
1656    how much farther the original request asked to go.  */
1657
1658 struct frame_info *
1659 find_relative_frame (struct frame_info *frame, int *level_offset_ptr)
1660 {
1661   /* Going up is simple: just call get_prev_frame enough times or
1662      until the initial frame is reached.  */
1663   while (*level_offset_ptr > 0)
1664     {
1665       struct frame_info *prev = get_prev_frame (frame);
1666       if (!prev)
1667         break;
1668       (*level_offset_ptr)--;
1669       frame = prev;
1670     }
1671
1672   /* Going down is just as simple.  */
1673   while (*level_offset_ptr < 0)
1674     {
1675       struct frame_info *next = get_next_frame (frame);
1676       if (!next)
1677         break;
1678       (*level_offset_ptr)++;
1679       frame = next;
1680     }
1681
1682   return frame;
1683 }
1684
1685 /* The "select_frame" command.  With no argument this is a NOP.
1686    Select the frame at level LEVEL_EXP if it is a valid level.
1687    Otherwise, treat LEVEL_EXP as an address expression and select it.
1688
1689    See parse_frame_specification for more info on proper frame
1690    expressions.  */
1691
1692 void
1693 select_frame_command (char *level_exp, int from_tty)
1694 {
1695   select_frame (parse_frame_specification_1 (level_exp, "No stack.", NULL));
1696 }
1697
1698 /* The "frame" command.  With no argument, print the selected frame
1699    briefly.  With an argument, behave like select_frame and then print
1700    the selected frame.  */
1701
1702 static void
1703 frame_command (char *level_exp, int from_tty)
1704 {
1705   select_frame_command (level_exp, from_tty);
1706   print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
1707 }
1708
1709 /* The XDB Compatibility command to print the current frame.  */
1710
1711 static void
1712 current_frame_command (char *level_exp, int from_tty)
1713 {
1714   print_stack_frame (get_selected_frame (_("No stack.")), 1, SRC_AND_LOC);
1715 }
1716
1717 /* Select the frame up one or COUNT_EXP stack levels from the
1718    previously selected frame, and print it briefly.  */
1719
1720 static void
1721 up_silently_base (char *count_exp)
1722 {
1723   struct frame_info *frame;
1724   int count = 1;
1725
1726   if (count_exp)
1727     count = parse_and_eval_long (count_exp);
1728
1729   frame = find_relative_frame (get_selected_frame ("No stack."), &count);
1730   if (count != 0 && count_exp == NULL)
1731     error (_("Initial frame selected; you cannot go up."));
1732   select_frame (frame);
1733 }
1734
1735 static void
1736 up_silently_command (char *count_exp, int from_tty)
1737 {
1738   up_silently_base (count_exp);
1739 }
1740
1741 static void
1742 up_command (char *count_exp, int from_tty)
1743 {
1744   up_silently_base (count_exp);
1745   print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
1746 }
1747
1748 /* Select the frame down one or COUNT_EXP stack levels from the previously
1749    selected frame, and print it briefly.  */
1750
1751 static void
1752 down_silently_base (char *count_exp)
1753 {
1754   struct frame_info *frame;
1755   int count = -1;
1756   if (count_exp)
1757     count = -parse_and_eval_long (count_exp);
1758
1759   frame = find_relative_frame (get_selected_frame ("No stack."), &count);
1760   if (count != 0 && count_exp == NULL)
1761     {
1762       /* We only do this if COUNT_EXP is not specified.  That way
1763          "down" means to really go down (and let me know if that is
1764          impossible), but "down 9999" can be used to mean go all the
1765          way down without getting an error.  */
1766
1767       error (_("Bottom (innermost) frame selected; you cannot go down."));
1768     }
1769
1770   select_frame (frame);
1771 }
1772
1773 static void
1774 down_silently_command (char *count_exp, int from_tty)
1775 {
1776   down_silently_base (count_exp);
1777 }
1778
1779 static void
1780 down_command (char *count_exp, int from_tty)
1781 {
1782   down_silently_base (count_exp);
1783   print_stack_frame (get_selected_frame (NULL), 1, SRC_AND_LOC);
1784 }
1785 \f
1786
1787 void
1788 return_command (char *retval_exp, int from_tty)
1789 {
1790   struct symbol *thisfun;
1791   struct value *return_value = NULL;
1792   const char *query_prefix = "";
1793
1794   thisfun = get_frame_function (get_selected_frame ("No selected frame."));
1795
1796   /* Compute the return value.  If the computation triggers an error,
1797      let it bail.  If the return type can't be handled, set
1798      RETURN_VALUE to NULL, and QUERY_PREFIX to an informational
1799      message.  */
1800   if (retval_exp)
1801     {
1802       struct type *return_type = NULL;
1803
1804       /* Compute the return value.  Should the computation fail, this
1805          call throws an error.  */
1806       return_value = parse_and_eval (retval_exp);
1807
1808       /* Cast return value to the return type of the function.  Should
1809          the cast fail, this call throws an error.  */
1810       if (thisfun != NULL)
1811         return_type = TYPE_TARGET_TYPE (SYMBOL_TYPE (thisfun));
1812       if (return_type == NULL)
1813         return_type = builtin_type_int;
1814       CHECK_TYPEDEF (return_type);
1815       return_value = value_cast (return_type, return_value);
1816
1817       /* Make sure the value is fully evaluated.  It may live in the
1818          stack frame we're about to pop.  */
1819       if (value_lazy (return_value))
1820         value_fetch_lazy (return_value);
1821
1822       if (TYPE_CODE (return_type) == TYPE_CODE_VOID)
1823         /* If the return-type is "void", don't try to find the
1824            return-value's location.  However, do still evaluate the
1825            return expression so that, even when the expression result
1826            is discarded, side effects such as "return i++" still
1827            occur.  */
1828         return_value = NULL;
1829       else if (using_struct_return (SYMBOL_TYPE (thisfun), return_type))
1830         {
1831           query_prefix = "\
1832 The location at which to store the function's return value is unknown.\n\
1833 If you continue, the return value that you specified will be ignored.\n";
1834           return_value = NULL;
1835         }
1836     }
1837
1838   /* Does an interactive user really want to do this?  Include
1839      information, such as how well GDB can handle the return value, in
1840      the query message.  */
1841   if (from_tty)
1842     {
1843       int confirmed;
1844       if (thisfun == NULL)
1845         confirmed = query (_("%sMake selected stack frame return now? "),
1846                            query_prefix);
1847       else
1848         confirmed = query (_("%sMake %s return now? "), query_prefix,
1849                            SYMBOL_PRINT_NAME (thisfun));
1850       if (!confirmed)
1851         error (_("Not confirmed"));
1852     }
1853
1854   /* NOTE: cagney/2003-01-18: Is this silly?  Rather than pop each
1855      frame in turn, should this code just go straight to the relevant
1856      frame and pop that?  */
1857
1858   /* First discard all frames inner-to the selected frame (making the
1859      selected frame current).  */
1860   {
1861     struct frame_id selected_id = get_frame_id (get_selected_frame (NULL));
1862     while (!frame_id_eq (selected_id, get_frame_id (get_current_frame ())))
1863       {
1864         struct frame_info *frame = get_current_frame ();
1865         if (frame_id_inner (get_frame_arch (frame), selected_id,
1866                             get_frame_id (frame)))
1867           /* Caught in the safety net, oops!  We've gone way past the
1868              selected frame.  */
1869           error (_("Problem while popping stack frames (corrupt stack?)"));
1870         frame_pop (get_current_frame ());
1871       }
1872   }
1873
1874   /* Second discard the selected frame (which is now also the current
1875      frame).  */
1876   frame_pop (get_current_frame ());
1877
1878   /* Store RETURN_VALUE in the just-returned register set.  */
1879   if (return_value != NULL)
1880     {
1881       struct type *return_type = value_type (return_value);
1882       struct gdbarch *gdbarch = get_regcache_arch (get_current_regcache ());
1883       gdb_assert (gdbarch_return_value (gdbarch, SYMBOL_TYPE (thisfun),
1884                                         return_type, NULL, NULL, NULL)
1885                   == RETURN_VALUE_REGISTER_CONVENTION);
1886       gdbarch_return_value (gdbarch, SYMBOL_TYPE (thisfun), return_type,
1887                             get_current_regcache (), NULL /*read*/,
1888                             value_contents (return_value) /*write*/);
1889     }
1890
1891   /* If we are at the end of a call dummy now, pop the dummy frame
1892      too.  */
1893   if (get_frame_type (get_current_frame ()) == DUMMY_FRAME)
1894     frame_pop (get_current_frame ());
1895
1896   /* If interactive, print the frame that is now current.  */
1897   if (from_tty)
1898     frame_command ("0", 1);
1899   else
1900     select_frame_command ("0", 0);
1901 }
1902
1903 /* Sets the scope to input function name, provided that the function
1904    is within the current stack frame */
1905
1906 struct function_bounds
1907 {
1908   CORE_ADDR low, high;
1909 };
1910
1911 static void
1912 func_command (char *arg, int from_tty)
1913 {
1914   struct frame_info *frame;
1915   int found = 0;
1916   struct symtabs_and_lines sals;
1917   int i;
1918   int level = 1;
1919   struct function_bounds *func_bounds = NULL;
1920
1921   if (arg != NULL)
1922     return;
1923
1924   frame = parse_frame_specification ("0");
1925   sals = decode_line_spec (arg, 1);
1926   func_bounds = (struct function_bounds *) xmalloc (
1927                               sizeof (struct function_bounds) * sals.nelts);
1928   for (i = 0; (i < sals.nelts && !found); i++)
1929     {
1930       if (sals.sals[i].pc == 0
1931           || find_pc_partial_function (sals.sals[i].pc, NULL,
1932                                        &func_bounds[i].low,
1933                                        &func_bounds[i].high) == 0)
1934         {
1935           func_bounds[i].low = func_bounds[i].high = 0;
1936         }
1937     }
1938
1939   do
1940     {
1941       for (i = 0; (i < sals.nelts && !found); i++)
1942         found = (get_frame_pc (frame) >= func_bounds[i].low
1943                  && get_frame_pc (frame) < func_bounds[i].high);
1944       if (!found)
1945         {
1946           level = 1;
1947           frame = find_relative_frame (frame, &level);
1948         }
1949     }
1950   while (!found && level == 0);
1951
1952   if (func_bounds)
1953     xfree (func_bounds);
1954
1955   if (!found)
1956     printf_filtered (_("'%s' not within current stack frame.\n"), arg);
1957   else if (frame != get_selected_frame (NULL))
1958     select_and_print_frame (frame);
1959 }
1960
1961 /* Gets the language of the current frame.  */
1962
1963 enum language
1964 get_frame_language (void)
1965 {
1966   struct frame_info *frame = deprecated_safe_get_selected_frame ();
1967
1968   if (frame)
1969     {
1970       /* We determine the current frame language by looking up its
1971          associated symtab.  To retrieve this symtab, we use the frame
1972          PC.  However we cannot use the frame PC as is, because it
1973          usually points to the instruction following the "call", which
1974          is sometimes the first instruction of another function.  So
1975          we rely on get_frame_address_in_block(), it provides us with
1976          a PC that is guaranteed to be inside the frame's code
1977          block.  */
1978       CORE_ADDR pc = get_frame_address_in_block (frame);
1979       struct symtab *s = find_pc_symtab (pc);
1980
1981       if (s)
1982         return s->language;
1983     }
1984
1985   return language_unknown;
1986 }
1987 \f
1988
1989 /* Provide a prototype to silence -Wmissing-prototypes.  */
1990 void _initialize_stack (void);
1991
1992 void
1993 _initialize_stack (void)
1994 {
1995 #if 0
1996   backtrace_limit = 30;
1997 #endif
1998
1999   add_com ("return", class_stack, return_command, _("\
2000 Make selected stack frame return to its caller.\n\
2001 Control remains in the debugger, but when you continue\n\
2002 execution will resume in the frame above the one now selected.\n\
2003 If an argument is given, it is an expression for the value to return."));
2004
2005   add_com ("up", class_stack, up_command, _("\
2006 Select and print stack frame that called this one.\n\
2007 An argument says how many frames up to go."));
2008   add_com ("up-silently", class_support, up_silently_command, _("\
2009 Same as the `up' command, but does not print anything.\n\
2010 This is useful in command scripts."));
2011
2012   add_com ("down", class_stack, down_command, _("\
2013 Select and print stack frame called by this one.\n\
2014 An argument says how many frames down to go."));
2015   add_com_alias ("do", "down", class_stack, 1);
2016   add_com_alias ("dow", "down", class_stack, 1);
2017   add_com ("down-silently", class_support, down_silently_command, _("\
2018 Same as the `down' command, but does not print anything.\n\
2019 This is useful in command scripts."));
2020
2021   add_com ("frame", class_stack, frame_command, _("\
2022 Select and print a stack frame.\n\
2023 With no argument, print the selected stack frame.  (See also \"info frame\").\n\
2024 An argument specifies the frame to select.\n\
2025 It can be a stack frame number or the address of the frame.\n\
2026 With argument, nothing is printed if input is coming from\n\
2027 a command file or a user-defined command."));
2028
2029   add_com_alias ("f", "frame", class_stack, 1);
2030
2031   if (xdb_commands)
2032     {
2033       add_com ("L", class_stack, current_frame_command,
2034                _("Print the current stack frame.\n"));
2035       add_com_alias ("V", "frame", class_stack, 1);
2036     }
2037   add_com ("select-frame", class_stack, select_frame_command, _("\
2038 Select a stack frame without printing anything.\n\
2039 An argument specifies the frame to select.\n\
2040 It can be a stack frame number or the address of the frame.\n"));
2041
2042   add_com ("backtrace", class_stack, backtrace_command, _("\
2043 Print backtrace of all stack frames, or innermost COUNT frames.\n\
2044 With a negative argument, print outermost -COUNT frames.\n\
2045 Use of the 'full' qualifier also prints the values of the local variables.\n"));
2046   add_com_alias ("bt", "backtrace", class_stack, 0);
2047   if (xdb_commands)
2048     {
2049       add_com_alias ("t", "backtrace", class_stack, 0);
2050       add_com ("T", class_stack, backtrace_full_command, _("\
2051 Print backtrace of all stack frames, or innermost COUNT frames \n\
2052 and the values of the local variables.\n\
2053 With a negative argument, print outermost -COUNT frames.\n\
2054 Usage: T <count>\n"));
2055     }
2056
2057   add_com_alias ("where", "backtrace", class_alias, 0);
2058   add_info ("stack", backtrace_command,
2059             _("Backtrace of the stack, or innermost COUNT frames."));
2060   add_info_alias ("s", "stack", 1);
2061   add_info ("frame", frame_info,
2062             _("All about selected stack frame, or frame at ADDR."));
2063   add_info_alias ("f", "frame", 1);
2064   add_info ("locals", locals_info,
2065             _("Local variables of current stack frame."));
2066   add_info ("args", args_info,
2067             _("Argument variables of current stack frame."));
2068   if (xdb_commands)
2069     add_com ("l", class_info, args_plus_locals_info,
2070              _("Argument and local variables of current stack frame."));
2071
2072   if (dbx_commands)
2073     add_com ("func", class_stack, func_command, _("\
2074 Select the stack frame that contains <func>.\n\
2075 Usage: func <name>\n"));
2076
2077   add_info ("catch", catch_info,
2078             _("Exceptions that can be caught in the current stack frame."));
2079
2080   add_setshow_enum_cmd ("frame-arguments", class_stack,
2081                         print_frame_arguments_choices, &print_frame_arguments,
2082                         _("Set printing of non-scalar frame arguments"),
2083                         _("Show printing of non-scalar frame arguments"),
2084                         NULL, NULL, NULL, &setprintlist, &showprintlist);
2085
2086 #if 0
2087   add_cmd ("backtrace-limit", class_stack, set_backtrace_limit_command, _(\
2088 "Specify maximum number of frames for \"backtrace\" to print by default."),
2089            &setlist);
2090   add_info ("backtrace-limit", backtrace_limit_info, _("\
2091 The maximum number of frames for \"backtrace\" to print by default."));
2092 #endif
2093 }