gdb/mi/mi-cmd-stack.c

   1 /* MI Command Set - stack commands.
   2    Copyright (C) 2000, 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010, 2011
   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 #include "valprint.h"
  34 #include "exceptions.h"
  35
  36 enum what_to_list { locals, arguments, all };
  37
  38 static void list_args_or_locals (enum what_to_list what,
  39                                  int values, struct frame_info *fi);
  40
  41 /* Print a list of the stack frames. Args can be none, in which case
  42    we want to print the whole backtrace, or a pair of numbers
  43    specifying the frame numbers at which to start and stop the
  44    display. If the two numbers are equal, a single frame will be
  45    displayed. */
  46 void
  47 mi_cmd_stack_list_frames (char *command, char **argv, int argc)
  48 {
  49   int frame_low;
  50   int frame_high;
  51   int i;
  52   struct cleanup *cleanup_stack;
  53   struct frame_info *fi;
  54
  55   if (argc > 2 || argc == 1)
  56     error (_("-stack-list-frames: Usage: [FRAME_LOW FRAME_HIGH]"));
  57
  58   if (argc == 2)
  59     {
  60       frame_low = atoi (argv[0]);
  61       frame_high = atoi (argv[1]);
  62     }
  63   else
  64     {
  65       /* Called with no arguments, it means we want the whole
  66          backtrace. */
  67       frame_low = -1;
  68       frame_high = -1;
  69     }
  70
  71   /* Let's position fi on the frame at which to start the
  72      display. Could be the innermost frame if the whole stack needs
  73      displaying, or if frame_low is 0. */
  74   for (i = 0, fi = get_current_frame ();
  75        fi && i < frame_low;
  76        i++, fi = get_prev_frame (fi));
  77
  78   if (fi == NULL)
  79     error (_("-stack-list-frames: Not enough frames in stack."));
  80
  81   cleanup_stack = make_cleanup_ui_out_list_begin_end (current_uiout, "stack");
  82
  83   /* Now let;s print the frames up to frame_high, or until there are
  84      frames in the stack. */
  85   for (;
  86        fi && (i <= frame_high || frame_high == -1);
  87        i++, fi = get_prev_frame (fi))
  88     {
  89       QUIT;
  90       /* Print the location and the address always, even for level 0.
  91          args == 0: don't print the arguments. */
  92       print_frame_info (fi, 1, LOC_AND_ADDRESS, 0 /* args */ );
  93     }
  94
  95   do_cleanups (cleanup_stack);
  96 }
  97
  98 void
  99 mi_cmd_stack_info_depth (char *command, char **argv, int argc)
 100 {
 101   int frame_high;
 102   int i;
 103   struct frame_info *fi;
 104
 105   if (argc > 1)
 106     error (_("-stack-info-depth: Usage: [MAX_DEPTH]"));
 107
 108   if (argc == 1)
 109     frame_high = atoi (argv[0]);
 110   else
 111     /* Called with no arguments, it means we want the real depth of
 112        the stack. */
 113     frame_high = -1;
 114
 115   for (i = 0, fi = get_current_frame ();
 116        fi && (i < frame_high || frame_high == -1);
 117        i++, fi = get_prev_frame (fi))
 118     QUIT;
 119
 120   ui_out_field_int (current_uiout, "depth", i);
 121 }
 122
 123 static enum print_values
 124 parse_print_values (char *name)
 125 {
 126    if (strcmp (name, "0") == 0
 127        || strcmp (name, mi_no_values) == 0)
 128      return PRINT_NO_VALUES;
 129    else if (strcmp (name, "1") == 0
 130             || strcmp (name, mi_all_values) == 0)
 131      return PRINT_ALL_VALUES;
 132    else if (strcmp (name, "2") == 0
 133             || strcmp (name, mi_simple_values) == 0)
 134      return PRINT_SIMPLE_VALUES;
 135    else
 136      error (_("Unknown value for PRINT_VALUES: must be: \
 137 0 or \"%s\", 1 or \"%s\", 2 or \"%s\""),
 138             mi_no_values, mi_all_values, mi_simple_values);
 139 }
 140
 141 /* Print a list of the locals for the current frame.  With argument of
 142    0, print only the names, with argument of 1 print also the
 143    values. */
 144 void
 145 mi_cmd_stack_list_locals (char *command, char **argv, int argc)
 146 {
 147   struct frame_info *frame;
 148
 149   if (argc != 1)
 150     error (_("-stack-list-locals: Usage: PRINT_VALUES"));
 151
 152    frame = get_selected_frame (NULL);
 153
 154    list_args_or_locals (locals, parse_print_values (argv[0]), frame);
 155 }
 156
 157 /* Print a list of the arguments for the current frame.  With argument
 158    of 0, print only the names, with argument of 1 print also the
 159    values. */
 160 void
 161 mi_cmd_stack_list_args (char *command, char **argv, int argc)
 162 {
 163   int frame_low;
 164   int frame_high;
 165   int i;
 166   struct frame_info *fi;
 167   struct cleanup *cleanup_stack_args;
 168   enum print_values print_values;
 169   struct ui_out *uiout = current_uiout;
 170
 171   if (argc < 1 || argc > 3 || argc == 2)
 172     error (_("-stack-list-arguments: Usage: "
 173              "PRINT_VALUES [FRAME_LOW FRAME_HIGH]"));
 174
 175   if (argc == 3)
 176     {
 177       frame_low = atoi (argv[1]);
 178       frame_high = atoi (argv[2]);
 179     }
 180   else
 181     {
 182       /* Called with no arguments, it means we want args for the whole
 183          backtrace. */
 184       frame_low = -1;
 185       frame_high = -1;
 186     }
 187
 188   print_values = parse_print_values (argv[0]);
 189
 190   /* Let's position fi on the frame at which to start the
 191      display. Could be the innermost frame if the whole stack needs
 192      displaying, or if frame_low is 0. */
 193   for (i = 0, fi = get_current_frame ();
 194        fi && i < frame_low;
 195        i++, fi = get_prev_frame (fi));
 196
 197   if (fi == NULL)
 198     error (_("-stack-list-arguments: Not enough frames in stack."));
 199
 200   cleanup_stack_args
 201     = make_cleanup_ui_out_list_begin_end (uiout, "stack-args");
 202
 203   /* Now let's print the frames up to frame_high, or until there are
 204      frames in the stack. */
 205   for (;
 206        fi && (i <= frame_high || frame_high == -1);
 207        i++, fi = get_prev_frame (fi))
 208     {
 209       struct cleanup *cleanup_frame;
 210
 211       QUIT;
 212       cleanup_frame = make_cleanup_ui_out_tuple_begin_end (uiout, "frame");
 213       ui_out_field_int (uiout, "level", i);
 214       list_args_or_locals (arguments, print_values, fi);
 215       do_cleanups (cleanup_frame);
 216     }
 217
 218   do_cleanups (cleanup_stack_args);
 219 }
 220
 221 /* Print a list of the local variables (including arguments) for the
 222    current frame.  ARGC must be 1 and ARGV[0] specify if only the names,
 223    or both names and values of the variables must be printed.  See
 224    parse_print_value for possible values.  */
 225 void
 226 mi_cmd_stack_list_variables (char *command, char **argv, int argc)
 227 {
 228   struct frame_info *frame;
 229
 230   if (argc != 1)
 231     error (_("Usage: PRINT_VALUES"));
 232
 233   frame = get_selected_frame (NULL);
 234
 235   list_args_or_locals (all, parse_print_values (argv[0]), frame);
 236 }
 237
 238
 239 /* Print a list of the locals or the arguments for the currently
 240    selected frame.  If the argument passed is 0, printonly the names
 241    of the variables, if an argument of 1 is passed, print the values
 242    as well. */
 243 static void
 244 list_args_or_locals (enum what_to_list what, int values, struct frame_info *fi)
 245 {
 246   struct block *block;
 247   struct symbol *sym;
 248   struct dict_iterator iter;
 249   struct cleanup *cleanup_list;
 250   struct ui_stream *stb;
 251   struct type *type;
 252   char *name_of_result;
 253   struct ui_out *uiout = current_uiout;
 254
 255   stb = ui_out_stream_new (uiout);
 256
 257   block = get_frame_block (fi, 0);
 258
 259   switch (what)
 260     {
 261     case locals:
 262       name_of_result = "locals";
 263       break;
 264     case arguments:
 265       name_of_result = "args";
 266       break;
 267     case all:
 268       name_of_result = "variables";
 269       break;
 270     default:
 271       internal_error (__FILE__, __LINE__,
 272                       "unexpected what_to_list: %d", (int) what);
 273     }
 274
 275   cleanup_list = make_cleanup_ui_out_list_begin_end (uiout, name_of_result);
 276
 277   while (block != 0)
 278     {
 279       ALL_BLOCK_SYMBOLS (block, iter, sym)
 280         {
 281           int print_me = 0;
 282
 283           switch (SYMBOL_CLASS (sym))
 284             {
 285             default:
 286             case LOC_UNDEF:     /* catches errors        */
 287             case LOC_CONST:     /* constant              */
 288             case LOC_TYPEDEF:   /* local typedef         */
 289             case LOC_LABEL:     /* local label           */
 290             case LOC_BLOCK:     /* local function        */
 291             case LOC_CONST_BYTES:       /* loc. byte seq.        */
 292             case LOC_UNRESOLVED:        /* unresolved static     */
 293             case LOC_OPTIMIZED_OUT:     /* optimized out         */
 294               print_me = 0;
 295               break;
 296
 297             case LOC_ARG:       /* argument              */
 298             case LOC_REF_ARG:   /* reference arg         */
 299             case LOC_REGPARM_ADDR:      /* indirect register arg */
 300             case LOC_LOCAL:     /* stack local           */
 301             case LOC_STATIC:    /* static                */
 302             case LOC_REGISTER:  /* register              */
 303             case LOC_COMPUTED:  /* computed location     */
 304               if (what == all)
 305                 print_me = 1;
 306               else if (what == locals)
 307                 print_me = !SYMBOL_IS_ARGUMENT (sym);
 308               else
 309                 print_me = SYMBOL_IS_ARGUMENT (sym);
 310               break;
 311             }
 312           if (print_me)
 313             {
 314               struct cleanup *cleanup_tuple = NULL;
 315               struct symbol *sym2;
 316               struct value *val;
 317
 318               if (values != PRINT_NO_VALUES || what == all)
 319                 cleanup_tuple =
 320                   make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
 321               ui_out_field_string (uiout, "name", SYMBOL_PRINT_NAME (sym));
 322               if (what == all && SYMBOL_IS_ARGUMENT (sym))
 323                 ui_out_field_int (uiout, "arg", 1);
 324
 325               if (SYMBOL_IS_ARGUMENT (sym))
 326                 sym2 = lookup_symbol (SYMBOL_NATURAL_NAME (sym),
 327                                       block, VAR_DOMAIN,
 328                                       (int *) NULL);
 329               else
 330                 sym2 = sym;
 331               switch (values)
 332                 {
 333                 case PRINT_SIMPLE_VALUES:
 334                   type = check_typedef (sym2->type);
 335                   type_print (sym2->type, "", stb->stream, -1);
 336                   ui_out_field_stream (uiout, "type", stb);
 337                   if (TYPE_CODE (type) != TYPE_CODE_ARRAY
 338                       && TYPE_CODE (type) != TYPE_CODE_STRUCT
 339                       && TYPE_CODE (type) != TYPE_CODE_UNION)
 340                     {
 341                       volatile struct gdb_exception except;
 342
 343                       TRY_CATCH (except, RETURN_MASK_ERROR)
 344                         {
 345                           struct value_print_options opts;
 346
 347                           val = read_var_value (sym2, fi);
 348                           get_raw_print_options (&opts);
 349                           opts.deref_ref = 1;
 350                           common_val_print
 351                             (val, stb->stream, 0, &opts,
 352                              language_def (SYMBOL_LANGUAGE (sym2)));
 353                         }
 354                       if (except.reason < 0)
 355                         fprintf_filtered (stb->stream,
 356                                           _("<error reading variable: %s>"),
 357                                           except.message);
 358
 359                       ui_out_field_stream (uiout, "value", stb);
 360                     }
 361                   break;
 362                 case PRINT_ALL_VALUES:
 363                   {
 364                     volatile struct gdb_exception except;
 365
 366                     TRY_CATCH (except, RETURN_MASK_ERROR)
 367                       {
 368                         struct value_print_options opts;
 369
 370                         val = read_var_value (sym2, fi);
 371                         get_raw_print_options (&opts);
 372                         opts.deref_ref = 1;
 373                         common_val_print
 374                           (val, stb->stream, 0, &opts,
 375                            language_def (SYMBOL_LANGUAGE (sym2)));
 376                       }
 377                     if (except.reason < 0)
 378                       fprintf_filtered (stb->stream,
 379                                         _("<error reading variable: %s>"),
 380                                         except.message);
 381
 382                     ui_out_field_stream (uiout, "value", stb);
 383                   }
 384                   break;
 385                 }
 386
 387               if (values != PRINT_NO_VALUES || what == all)
 388                 do_cleanups (cleanup_tuple);
 389             }
 390         }
 391       if (BLOCK_FUNCTION (block))
 392         break;
 393       else
 394         block = BLOCK_SUPERBLOCK (block);
 395     }
 396   do_cleanups (cleanup_list);
 397   ui_out_stream_delete (stb);
 398 }
 399
 400 void
 401 mi_cmd_stack_select_frame (char *command, char **argv, int argc)
 402 {
 403   if (argc == 0 || argc > 1)
 404     error (_("-stack-select-frame: Usage: FRAME_SPEC"));
 405
 406   select_frame_command (argv[0], 1 /* not used */ );
 407 }
 408
 409 void
 410 mi_cmd_stack_info_frame (char *command, char **argv, int argc)
 411 {
 412   if (argc > 0)
 413     error (_("-stack-info-frame: No arguments required"));
 414
 415   print_frame_info (get_selected_frame (NULL), 1, LOC_AND_ADDRESS, 0);
 416 }