gdb/mi/mi-cmd-stack.c

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