1 /* MI Command Set - stack commands. 2 Copyright (C) 2000-2013 Free Software Foundation, Inc. 3 Contributed by Cygnus Solutions (a Red Hat company). 4 5 This file is part of GDB. 6 7 This program is free software; you can redistribute it and/or modify 8 it under the terms of the GNU General Public License as published by 9 the Free Software Foundation; either version 3 of the License, or 10 (at your option) any later version. 11 12 This program is distributed in the hope that it will be useful, 13 but WITHOUT ANY WARRANTY; without even the implied warranty of 14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 GNU General Public License for more details. 16 17 You should have received a copy of the GNU General Public License 18 along with this program. If not, see <http://www.gnu.org/licenses/>. */ 19 20 #include "defs.h" 21 #include "target.h" 22 #include "frame.h" 23 #include "value.h" 24 #include "mi-cmds.h" 25 #include "ui-out.h" 26 #include "symtab.h" 27 #include "block.h" 28 #include "stack.h" 29 #include "dictionary.h" 30 #include "gdb_string.h" 31 #include "language.h" 32 #include "valprint.h" 33 #include "exceptions.h" 34 35 enum what_to_list { locals, arguments, all }; 36 37 static void list_args_or_locals (enum what_to_list what, 38 enum print_values values, 39 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 47 void 48 mi_cmd_stack_list_frames (char *command, char **argv, int argc) 49 { 50 int frame_low; 51 int frame_high; 52 int i; 53 struct cleanup *cleanup_stack; 54 struct frame_info *fi; 55 56 if (argc > 2 || argc == 1) 57 error (_("-stack-list-frames: Usage: [FRAME_LOW FRAME_HIGH]")); 58 59 if (argc == 2) 60 { 61 frame_low = atoi (argv[0]); 62 frame_high = atoi (argv[1]); 63 } 64 else 65 { 66 /* Called with no arguments, it means we want the whole 67 backtrace. */ 68 frame_low = -1; 69 frame_high = -1; 70 } 71 72 /* Let's position fi on the frame at which to start the 73 display. Could be the innermost frame if the whole stack needs 74 displaying, or if frame_low is 0. */ 75 for (i = 0, fi = get_current_frame (); 76 fi && i < frame_low; 77 i++, fi = get_prev_frame (fi)); 78 79 if (fi == NULL) 80 error (_("-stack-list-frames: Not enough frames in stack.")); 81 82 cleanup_stack = make_cleanup_ui_out_list_begin_end (current_uiout, "stack"); 83 84 /* Now let's print the frames up to frame_high, or until there are 85 frames in the stack. */ 86 for (; 87 fi && (i <= frame_high || frame_high == -1); 88 i++, fi = get_prev_frame (fi)) 89 { 90 QUIT; 91 /* Print the location and the address always, even for level 0. 92 If args is 0, don't print the arguments. */ 93 print_frame_info (fi, 1, LOC_AND_ADDRESS, 0 /* args */ ); 94 } 95 96 do_cleanups (cleanup_stack); 97 } 98 99 void 100 mi_cmd_stack_info_depth (char *command, char **argv, int argc) 101 { 102 int frame_high; 103 int i; 104 struct frame_info *fi; 105 106 if (argc > 1) 107 error (_("-stack-info-depth: Usage: [MAX_DEPTH]")); 108 109 if (argc == 1) 110 frame_high = atoi (argv[0]); 111 else 112 /* Called with no arguments, it means we want the real depth of 113 the stack. */ 114 frame_high = -1; 115 116 for (i = 0, fi = get_current_frame (); 117 fi && (i < frame_high || frame_high == -1); 118 i++, fi = get_prev_frame (fi)) 119 QUIT; 120 121 ui_out_field_int (current_uiout, "depth", i); 122 } 123 124 static enum print_values 125 parse_print_values (char *name) 126 { 127 if (strcmp (name, "0") == 0 128 || strcmp (name, mi_no_values) == 0) 129 return PRINT_NO_VALUES; 130 else if (strcmp (name, "1") == 0 131 || strcmp (name, mi_all_values) == 0) 132 return PRINT_ALL_VALUES; 133 else if (strcmp (name, "2") == 0 134 || strcmp (name, mi_simple_values) == 0) 135 return PRINT_SIMPLE_VALUES; 136 else 137 error (_("Unknown value for PRINT_VALUES: must be: \ 138 0 or \"%s\", 1 or \"%s\", 2 or \"%s\""), 139 mi_no_values, mi_all_values, mi_simple_values); 140 } 141 142 /* Print a list of the locals for the current frame. With argument of 143 0, print only the names, with argument of 1 print also the 144 values. */ 145 146 void 147 mi_cmd_stack_list_locals (char *command, char **argv, int argc) 148 { 149 struct frame_info *frame; 150 151 if (argc != 1) 152 error (_("-stack-list-locals: Usage: PRINT_VALUES")); 153 154 frame = get_selected_frame (NULL); 155 156 list_args_or_locals (locals, parse_print_values (argv[0]), frame); 157 } 158 159 /* Print a list of the arguments for the current frame. With argument 160 of 0, print only the names, with argument of 1 print also the 161 values. */ 162 163 void 164 mi_cmd_stack_list_args (char *command, char **argv, int argc) 165 { 166 int frame_low; 167 int frame_high; 168 int i; 169 struct frame_info *fi; 170 struct cleanup *cleanup_stack_args; 171 enum print_values print_values; 172 struct ui_out *uiout = current_uiout; 173 174 if (argc < 1 || argc > 3 || argc == 2) 175 error (_("-stack-list-arguments: Usage: " 176 "PRINT_VALUES [FRAME_LOW FRAME_HIGH]")); 177 178 if (argc == 3) 179 { 180 frame_low = atoi (argv[1]); 181 frame_high = atoi (argv[2]); 182 } 183 else 184 { 185 /* Called with no arguments, it means we want args for the whole 186 backtrace. */ 187 frame_low = -1; 188 frame_high = -1; 189 } 190 191 print_values = parse_print_values (argv[0]); 192 193 /* Let's position fi on the frame at which to start the 194 display. Could be the innermost frame if the whole stack needs 195 displaying, or if frame_low is 0. */ 196 for (i = 0, fi = get_current_frame (); 197 fi && i < frame_low; 198 i++, fi = get_prev_frame (fi)); 199 200 if (fi == NULL) 201 error (_("-stack-list-arguments: Not enough frames in stack.")); 202 203 cleanup_stack_args 204 = make_cleanup_ui_out_list_begin_end (uiout, "stack-args"); 205 206 /* Now let's print the frames up to frame_high, or until there are 207 frames in the stack. */ 208 for (; 209 fi && (i <= frame_high || frame_high == -1); 210 i++, fi = get_prev_frame (fi)) 211 { 212 struct cleanup *cleanup_frame; 213 214 QUIT; 215 cleanup_frame = make_cleanup_ui_out_tuple_begin_end (uiout, "frame"); 216 ui_out_field_int (uiout, "level", i); 217 list_args_or_locals (arguments, print_values, fi); 218 do_cleanups (cleanup_frame); 219 } 220 221 do_cleanups (cleanup_stack_args); 222 } 223 224 /* Print a list of the local variables (including arguments) for the 225 current frame. ARGC must be 1 and ARGV[0] specify if only the names, 226 or both names and values of the variables must be printed. See 227 parse_print_value for possible values. */ 228 229 void 230 mi_cmd_stack_list_variables (char *command, char **argv, int argc) 231 { 232 struct frame_info *frame; 233 234 if (argc != 1) 235 error (_("Usage: PRINT_VALUES")); 236 237 frame = get_selected_frame (NULL); 238 239 list_args_or_locals (all, parse_print_values (argv[0]), frame); 240 } 241 242 /* Print single local or argument. ARG must be already read in. For 243 WHAT and VALUES see list_args_or_locals. 244 245 Errors are printed as if they would be the parameter value. Use 246 zeroed ARG iff it should not be printed according to VALUES. */ 247 248 static void 249 list_arg_or_local (const struct frame_arg *arg, enum what_to_list what, 250 enum print_values values) 251 { 252 struct cleanup *old_chain; 253 struct cleanup *cleanup_tuple = NULL; 254 struct ui_out *uiout = current_uiout; 255 struct ui_file *stb; 256 257 stb = mem_fileopen (); 258 old_chain = make_cleanup_ui_file_delete (stb); 259 260 gdb_assert (!arg->val || !arg->error); 261 gdb_assert ((values == PRINT_NO_VALUES && arg->val == NULL 262 && arg->error == NULL) 263 || values == PRINT_SIMPLE_VALUES 264 || (values == PRINT_ALL_VALUES 265 && (arg->val != NULL || arg->error != NULL))); 266 gdb_assert (arg->entry_kind == print_entry_values_no 267 || (arg->entry_kind == print_entry_values_only 268 && (arg->val || arg->error))); 269 270 if (values != PRINT_NO_VALUES || what == all) 271 cleanup_tuple = make_cleanup_ui_out_tuple_begin_end (uiout, NULL); 272 273 fputs_filtered (SYMBOL_PRINT_NAME (arg->sym), stb); 274 if (arg->entry_kind == print_entry_values_only) 275 fputs_filtered ("@entry", stb); 276 ui_out_field_stream (uiout, "name", stb); 277 278 if (what == all && SYMBOL_IS_ARGUMENT (arg->sym)) 279 ui_out_field_int (uiout, "arg", 1); 280 281 if (values == PRINT_SIMPLE_VALUES) 282 { 283 check_typedef (arg->sym->type); 284 type_print (arg->sym->type, "", stb, -1); 285 ui_out_field_stream (uiout, "type", stb); 286 } 287 288 if (arg->val || arg->error) 289 { 290 volatile struct gdb_exception except; 291 292 if (arg->error) 293 except.message = arg->error; 294 else 295 { 296 /* TRY_CATCH has two statements, wrap it in a block. */ 297 298 TRY_CATCH (except, RETURN_MASK_ERROR) 299 { 300 struct value_print_options opts; 301 302 get_raw_print_options (&opts); 303 opts.deref_ref = 1; 304 common_val_print (arg->val, stb, 0, &opts, 305 language_def (SYMBOL_LANGUAGE (arg->sym))); 306 } 307 } 308 if (except.message) 309 fprintf_filtered (stb, _("<error reading variable: %s>"), 310 except.message); 311 ui_out_field_stream (uiout, "value", stb); 312 } 313 314 if (values != PRINT_NO_VALUES || what == all) 315 do_cleanups (cleanup_tuple); 316 do_cleanups (old_chain); 317 } 318 319 /* Print a list of the locals or the arguments for the currently 320 selected frame. If the argument passed is 0, printonly the names 321 of the variables, if an argument of 1 is passed, print the values 322 as well. */ 323 324 static void 325 list_args_or_locals (enum what_to_list what, enum print_values values, 326 struct frame_info *fi) 327 { 328 struct block *block; 329 struct symbol *sym; 330 struct block_iterator iter; 331 struct cleanup *cleanup_list; 332 struct type *type; 333 char *name_of_result; 334 struct ui_out *uiout = current_uiout; 335 336 block = get_frame_block (fi, 0); 337 338 switch (what) 339 { 340 case locals: 341 name_of_result = "locals"; 342 break; 343 case arguments: 344 name_of_result = "args"; 345 break; 346 case all: 347 name_of_result = "variables"; 348 break; 349 default: 350 internal_error (__FILE__, __LINE__, 351 "unexpected what_to_list: %d", (int) what); 352 } 353 354 cleanup_list = make_cleanup_ui_out_list_begin_end (uiout, name_of_result); 355 356 while (block != 0) 357 { 358 ALL_BLOCK_SYMBOLS (block, iter, sym) 359 { 360 int print_me = 0; 361 362 switch (SYMBOL_CLASS (sym)) 363 { 364 default: 365 case LOC_UNDEF: /* catches errors */ 366 case LOC_CONST: /* constant */ 367 case LOC_TYPEDEF: /* local typedef */ 368 case LOC_LABEL: /* local label */ 369 case LOC_BLOCK: /* local function */ 370 case LOC_CONST_BYTES: /* loc. byte seq. */ 371 case LOC_UNRESOLVED: /* unresolved static */ 372 case LOC_OPTIMIZED_OUT: /* optimized out */ 373 print_me = 0; 374 break; 375 376 case LOC_ARG: /* argument */ 377 case LOC_REF_ARG: /* reference arg */ 378 case LOC_REGPARM_ADDR: /* indirect register arg */ 379 case LOC_LOCAL: /* stack local */ 380 case LOC_STATIC: /* static */ 381 case LOC_REGISTER: /* register */ 382 case LOC_COMPUTED: /* computed location */ 383 if (what == all) 384 print_me = 1; 385 else if (what == locals) 386 print_me = !SYMBOL_IS_ARGUMENT (sym); 387 else 388 print_me = SYMBOL_IS_ARGUMENT (sym); 389 break; 390 } 391 if (print_me) 392 { 393 struct symbol *sym2; 394 struct frame_arg arg, entryarg; 395 396 if (SYMBOL_IS_ARGUMENT (sym)) 397 sym2 = lookup_symbol (SYMBOL_LINKAGE_NAME (sym), 398 block, VAR_DOMAIN, 399 NULL); 400 else 401 sym2 = sym; 402 gdb_assert (sym2 != NULL); 403 404 memset (&arg, 0, sizeof (arg)); 405 arg.sym = sym2; 406 arg.entry_kind = print_entry_values_no; 407 memset (&entryarg, 0, sizeof (entryarg)); 408 entryarg.sym = sym2; 409 entryarg.entry_kind = print_entry_values_no; 410 411 switch (values) 412 { 413 case PRINT_SIMPLE_VALUES: 414 type = check_typedef (sym2->type); 415 if (TYPE_CODE (type) != TYPE_CODE_ARRAY 416 && TYPE_CODE (type) != TYPE_CODE_STRUCT 417 && TYPE_CODE (type) != TYPE_CODE_UNION) 418 { 419 case PRINT_ALL_VALUES: 420 if (SYMBOL_IS_ARGUMENT (sym)) 421 read_frame_arg (sym2, fi, &arg, &entryarg); 422 else 423 read_frame_local (sym2, fi, &arg); 424 } 425 break; 426 } 427 428 if (arg.entry_kind != print_entry_values_only) 429 list_arg_or_local (&arg, what, values); 430 if (entryarg.entry_kind != print_entry_values_no) 431 list_arg_or_local (&entryarg, what, values); 432 xfree (arg.error); 433 xfree (entryarg.error); 434 } 435 } 436 437 if (BLOCK_FUNCTION (block)) 438 break; 439 else 440 block = BLOCK_SUPERBLOCK (block); 441 } 442 do_cleanups (cleanup_list); 443 } 444 445 void 446 mi_cmd_stack_select_frame (char *command, char **argv, int argc) 447 { 448 if (argc == 0 || argc > 1) 449 error (_("-stack-select-frame: Usage: FRAME_SPEC")); 450 451 select_frame_command (argv[0], 1 /* not used */ ); 452 } 453 454 void 455 mi_cmd_stack_info_frame (char *command, char **argv, int argc) 456 { 457 if (argc > 0) 458 error (_("-stack-info-frame: No arguments allowed")); 459 460 print_frame_info (get_selected_frame (NULL), 1, LOC_AND_ADDRESS, 0); 461 } 462