gdb/mi/mi-cmd-stack.c

   1 /* MI Command Set - stack commands.
   2    Copyright (C) 2000, 2002, 2003, 2004, 2005, 2007, 2008
   3    Free Software Foundation, Inc.
   4    Contributed by Cygnus Solutions (a Red Hat company).
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #include "defs.h"
  22 #include "target.h"
  23 #include "frame.h"
  24 #include "value.h"
  25 #include "mi-cmds.h"
  26 #include "ui-out.h"
  27 #include "symtab.h"
  28 #include "block.h"
  29 #include "stack.h"
  30 #include "dictionary.h"
  31 #include "gdb_string.h"
  32 #include "language.h"
  33
  34 static void list_args_or_locals (int locals, int values, struct frame_info *fi);
  35
  36 /* Print a list of the stack frames. Args can be none, in which case
  37    we want to print the whole backtrace, or a pair of numbers
  38    specifying the frame numbers at which to start and stop the
  39    display. If the two numbers are equal, a single frame will be
  40    displayed. */
  41 void
  42 mi_cmd_stack_list_frames (char *command, char **argv, int argc)
  43 {
  44   int frame_low;
  45   int frame_high;
  46   int i;
  47   struct cleanup *cleanup_stack;
  48   struct frame_info *fi;
  49
  50   if (argc > 2 || argc == 1)
  51     error (_("mi_cmd_stack_list_frames: Usage: [FRAME_LOW FRAME_HIGH]"));
  52
  53   if (argc == 2)
  54     {
  55       frame_low = atoi (argv[0]);
  56       frame_high = atoi (argv[1]);
  57     }
  58   else
  59     {
  60       /* Called with no arguments, it means we want the whole
  61          backtrace. */
  62       frame_low = -1;
  63       frame_high = -1;
  64     }
  65
  66   /* Let's position fi on the frame at which to start the
  67      display. Could be the innermost frame if the whole stack needs
  68      displaying, or if frame_low is 0. */
  69   for (i = 0, fi = get_current_frame ();
  70        fi && i < frame_low;
  71        i++, fi = get_prev_frame (fi));
  72
  73   if (fi == NULL)
  74     error (_("mi_cmd_stack_list_frames: Not enough frames in stack."));
  75
  76   cleanup_stack = make_cleanup_ui_out_list_begin_end (uiout, "stack");
  77
  78   /* Now let;s print the frames up to frame_high, or until there are
  79      frames in the stack. */
  80   for (;
  81        fi && (i <= frame_high || frame_high == -1);
  82        i++, fi = get_prev_frame (fi))
  83     {
  84       QUIT;
  85       /* Print the location and the address always, even for level 0.
  86          args == 0: don't print the arguments. */
  87       print_frame_info (fi, 1, LOC_AND_ADDRESS, 0 /* args */ );
  88     }
  89
  90   do_cleanups (cleanup_stack);
  91 }
  92
  93 void
  94 mi_cmd_stack_info_depth (char *command, char **argv, int argc)
  95 {
  96   int frame_high;
  97   int i;
  98   struct frame_info *fi;
  99
 100   if (argc > 1)
 101     error (_("mi_cmd_stack_info_depth: Usage: [MAX_DEPTH]"));
 102
 103   if (argc == 1)
 104     frame_high = atoi (argv[0]);
 105   else
 106     /* Called with no arguments, it means we want the real depth of
 107        the stack. */
 108     frame_high = -1;
 109
 110   for (i = 0, fi = get_current_frame ();
 111        fi && (i < frame_high || frame_high == -1);
 112        i++, fi = get_prev_frame (fi))
 113     QUIT;
 114
 115   ui_out_field_int (uiout, "depth", i);
 116 }
 117
 118 /* Print a list of the locals for the current frame. With argument of
 119    0, print only the names, with argument of 1 print also the
 120    values. */
 121 void
 122 mi_cmd_stack_list_locals (char *command, char **argv, int argc)
 123 {
 124   struct frame_info *frame;
 125   enum print_values print_values;
 126
 127   if (argc != 1)
 128     error (_("mi_cmd_stack_list_locals: Usage: PRINT_VALUES"));
 129
 130    frame = get_selected_frame (NULL);
 131
 132    if (strcmp (argv[0], "0") == 0
 133        || strcmp (argv[0], mi_no_values) == 0)
 134      print_values = PRINT_NO_VALUES;
 135    else if (strcmp (argv[0], "1") == 0
 136             || strcmp (argv[0], mi_all_values) == 0)
 137      print_values = PRINT_ALL_VALUES;
 138    else if (strcmp (argv[0], "2") == 0
 139             || strcmp (argv[0], mi_simple_values) == 0)
 140      print_values = PRINT_SIMPLE_VALUES;
 141    else
 142      error (_("Unknown value for PRINT_VALUES: must be: \
 143 0 or \"%s\", 1 or \"%s\", 2 or \"%s\""),
 144             mi_no_values, mi_all_values, mi_simple_values);
 145   list_args_or_locals (1, print_values, frame);
 146 }
 147
 148 /* Print a list of the arguments for the current frame. With argument
 149    of 0, print only the names, with argument of 1 print also the
 150    values. */
 151 void
 152 mi_cmd_stack_list_args (char *command, char **argv, int argc)
 153 {
 154   int frame_low;
 155   int frame_high;
 156   int i;
 157   struct frame_info *fi;
 158   struct cleanup *cleanup_stack_args;
 159
 160   if (argc < 1 || argc > 3 || argc == 2)
 161     error (_("mi_cmd_stack_list_args: Usage: PRINT_VALUES [FRAME_LOW FRAME_HIGH]"));
 162
 163   if (argc == 3)
 164     {
 165       frame_low = atoi (argv[1]);
 166       frame_high = atoi (argv[2]);
 167     }
 168   else
 169     {
 170       /* Called with no arguments, it means we want args for the whole
 171          backtrace. */
 172       frame_low = -1;
 173       frame_high = -1;
 174     }
 175
 176   /* Let's position fi on the frame at which to start the
 177      display. Could be the innermost frame if the whole stack needs
 178      displaying, or if frame_low is 0. */
 179   for (i = 0, fi = get_current_frame ();
 180        fi && i < frame_low;
 181        i++, fi = get_prev_frame (fi));
 182
 183   if (fi == NULL)
 184     error (_("mi_cmd_stack_list_args: Not enough frames in stack."));
 185
 186   cleanup_stack_args = make_cleanup_ui_out_list_begin_end (uiout, "stack-args");
 187
 188   /* Now let's print the frames up to frame_high, or until there are
 189      frames in the stack. */
 190   for (;
 191        fi && (i <= frame_high || frame_high == -1);
 192        i++, fi = get_prev_frame (fi))
 193     {
 194       struct cleanup *cleanup_frame;
 195       QUIT;
 196       cleanup_frame = make_cleanup_ui_out_tuple_begin_end (uiout, "frame");
 197       ui_out_field_int (uiout, "level", i);
 198       list_args_or_locals (0, atoi (argv[0]), fi);
 199       do_cleanups (cleanup_frame);
 200     }
 201
 202   do_cleanups (cleanup_stack_args);
 203 }
 204
 205 /* Print a list of the locals or the arguments for the currently
 206    selected frame.  If the argument passed is 0, printonly the names
 207    of the variables, if an argument of 1 is passed, print the values
 208    as well. */
 209 static void
 210 list_args_or_locals (int locals, int values, struct frame_info *fi)
 211 {
 212   struct block *block;
 213   struct symbol *sym;
 214   struct dict_iterator iter;
 215   int nsyms;
 216   struct cleanup *cleanup_list;
 217   static struct ui_stream *stb = NULL;
 218   struct type *type;
 219
 220   stb = ui_out_stream_new (uiout);
 221
 222   block = get_frame_block (fi, 0);
 223
 224   cleanup_list = make_cleanup_ui_out_list_begin_end (uiout, locals ? "locals" : "args");
 225
 226   while (block != 0)
 227     {
 228       ALL_BLOCK_SYMBOLS (block, iter, sym)
 229         {
 230           int print_me = 0;
 231
 232           switch (SYMBOL_CLASS (sym))
 233             {
 234             default:
 235             case LOC_UNDEF:     /* catches errors        */
 236             case LOC_CONST:     /* constant              */
 237             case LOC_TYPEDEF:   /* local typedef         */
 238             case LOC_LABEL:     /* local label           */
 239             case LOC_BLOCK:     /* local function        */
 240             case LOC_CONST_BYTES:       /* loc. byte seq.        */
 241             case LOC_UNRESOLVED:        /* unresolved static     */
 242             case LOC_OPTIMIZED_OUT:     /* optimized out         */
 243               print_me = 0;
 244               break;
 245
 246             case LOC_ARG:       /* argument              */
 247             case LOC_REF_ARG:   /* reference arg         */
 248             case LOC_REGPARM_ADDR:      /* indirect register arg */
 249             case LOC_LOCAL:     /* stack local           */
 250             case LOC_STATIC:    /* static                */
 251             case LOC_REGISTER:  /* register              */
 252             case LOC_COMPUTED:  /* computed location     */
 253               if (SYMBOL_IS_ARGUMENT (sym) ? !locals : locals)
 254                 print_me = 1;
 255               break;
 256             }
 257           if (print_me)
 258             {
 259               struct cleanup *cleanup_tuple = NULL;
 260               struct symbol *sym2;
 261               struct value *val;
 262               if (values != PRINT_NO_VALUES)
 263                 cleanup_tuple =
 264                   make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
 265               ui_out_field_string (uiout, "name", SYMBOL_PRINT_NAME (sym));
 266
 267               if (!locals)
 268                 sym2 = lookup_symbol (SYMBOL_NATURAL_NAME (sym),
 269                                       block, VAR_DOMAIN,
 270                                       (int *) NULL);
 271               else
 272                 sym2 = sym;
 273               switch (values)
 274                 {
 275                 case PRINT_SIMPLE_VALUES:
 276                   type = check_typedef (sym2->type);
 277                   type_print (sym2->type, "", stb->stream, -1);
 278                   ui_out_field_stream (uiout, "type", stb);
 279                   if (TYPE_CODE (type) != TYPE_CODE_ARRAY
 280                       && TYPE_CODE (type) != TYPE_CODE_STRUCT
 281                       && TYPE_CODE (type) != TYPE_CODE_UNION)
 282                     {
 283                       val = read_var_value (sym2, fi);
 284                       common_val_print
 285                         (val, stb->stream, 0, 1, 0, Val_no_prettyprint,
 286                          language_def (SYMBOL_LANGUAGE (sym2)));
 287                       ui_out_field_stream (uiout, "value", stb);
 288                     }
 289                   do_cleanups (cleanup_tuple);
 290                   break;
 291                 case PRINT_ALL_VALUES:
 292                   val = read_var_value (sym2, fi);
 293                   common_val_print
 294                     (val, stb->stream, 0, 1, 0, Val_no_prettyprint,
 295                      language_def (SYMBOL_LANGUAGE (sym2)));
 296                   ui_out_field_stream (uiout, "value", stb);
 297                   do_cleanups (cleanup_tuple);
 298                   break;
 299                 }
 300             }
 301         }
 302       if (BLOCK_FUNCTION (block))
 303         break;
 304       else
 305         block = BLOCK_SUPERBLOCK (block);
 306     }
 307   do_cleanups (cleanup_list);
 308   ui_out_stream_delete (stb);
 309 }
 310
 311 void
 312 mi_cmd_stack_select_frame (char *command, char **argv, int argc)
 313 {
 314   if (argc == 0 || argc > 1)
 315     error (_("mi_cmd_stack_select_frame: Usage: FRAME_SPEC"));
 316
 317   select_frame_command (argv[0], 1 /* not used */ );
 318 }
 319
 320 void
 321 mi_cmd_stack_info_frame (char *command, char **argv, int argc)
 322 {
 323   if (argc > 0)
 324     error (_("mi_cmd_stack_info_frame: No arguments required"));
 325
 326   print_frame_info (get_selected_frame (NULL), 1, LOC_AND_ADDRESS, 0);
 327 }