1 /* MI Command Set - stack commands.
2 Copyright (C) 2000-2017 Free Software Foundation, Inc.
3 Contributed by Cygnus Solutions (a Red Hat company).
5 This file is part of GDB.
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.
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.
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/>. */
29 #include "dictionary.h"
33 #include "mi-getopt.h"
34 #include "extension.h"
38 enum what_to_list { locals, arguments, all };
40 static void list_args_or_locals (enum what_to_list what,
41 enum print_values values,
42 struct frame_info *fi,
43 int skip_unavailable);
45 /* True if we want to allow Python-based frame filters. */
46 static int frame_filters = 0;
49 mi_cmd_enable_frame_filters (const char *command, char **argv, int argc)
52 error (_("-enable-frame-filters: no arguments allowed"));
56 /* Like apply_ext_lang_frame_filter, but take a print_values */
58 static enum ext_lang_bt_status
59 mi_apply_ext_lang_frame_filter (struct frame_info *frame, int flags,
60 enum print_values print_values,
62 int frame_low, int frame_high)
64 /* ext_lang_frame_args's MI options are compatible with MI print
66 return apply_ext_lang_frame_filter (frame, flags,
67 (enum ext_lang_frame_args) print_values,
69 frame_low, frame_high);
72 /* Print a list of the stack frames. Args can be none, in which case
73 we want to print the whole backtrace, or a pair of numbers
74 specifying the frame numbers at which to start and stop the
75 display. If the two numbers are equal, a single frame will be
79 mi_cmd_stack_list_frames (const char *command, char **argv, int argc)
84 struct cleanup *cleanup_stack;
85 struct frame_info *fi;
86 enum ext_lang_bt_status result = EXT_LANG_BT_ERROR;
93 static const struct mi_opt opts[] =
95 {"-no-frame-filters", NO_FRAME_FILTERS, 0},
99 /* Parse arguments. In this instance we are just looking for
100 --no-frame-filters. */
104 int opt = mi_getopt ("-stack-list-frames", argc, argv,
108 switch ((enum opt) opt)
110 case NO_FRAME_FILTERS:
116 /* After the last option is parsed, there should either be low -
117 high range, or no further arguments. */
118 if ((argc - oind != 0) && (argc - oind != 2))
119 error (_("-stack-list-frames: Usage: [--no-frame-filters] [FRAME_LOW FRAME_HIGH]"));
121 /* If there is a range, set it. */
122 if (argc - oind == 2)
124 frame_low = atoi (argv[0 + oind]);
125 frame_high = atoi (argv[1 + oind]);
129 /* Called with no arguments, it means we want the whole
135 /* Let's position fi on the frame at which to start the
136 display. Could be the innermost frame if the whole stack needs
137 displaying, or if frame_low is 0. */
138 for (i = 0, fi = get_current_frame ();
140 i++, fi = get_prev_frame (fi));
143 error (_("-stack-list-frames: Not enough frames in stack."));
145 cleanup_stack = make_cleanup_ui_out_list_begin_end (current_uiout, "stack");
147 if (! raw_arg && frame_filters)
149 int flags = PRINT_LEVEL | PRINT_FRAME_INFO;
150 int py_frame_low = frame_low;
152 /* We cannot pass -1 to frame_low, as that would signify a
153 relative backtrace from the tail of the stack. So, in the case
154 of frame_low == -1, assign and increment it. */
155 if (py_frame_low == -1)
158 result = apply_ext_lang_frame_filter (get_current_frame (), flags,
159 NO_VALUES, current_uiout,
160 py_frame_low, frame_high);
163 /* Run the inbuilt backtrace if there are no filters registered, or
164 if "--no-frame-filters" has been specified from the command. */
165 if (! frame_filters || raw_arg || result == EXT_LANG_BT_NO_FILTERS)
167 /* Now let's print the frames up to frame_high, or until there are
168 frames in the stack. */
170 fi && (i <= frame_high || frame_high == -1);
171 i++, fi = get_prev_frame (fi))
174 /* Print the location and the address always, even for level 0.
175 If args is 0, don't print the arguments. */
176 print_frame_info (fi, 1, LOC_AND_ADDRESS, 0 /* args */, 0);
180 do_cleanups (cleanup_stack);
184 mi_cmd_stack_info_depth (const char *command, char **argv, int argc)
188 struct frame_info *fi;
191 error (_("-stack-info-depth: Usage: [MAX_DEPTH]"));
194 frame_high = atoi (argv[0]);
196 /* Called with no arguments, it means we want the real depth of
200 for (i = 0, fi = get_current_frame ();
201 fi && (i < frame_high || frame_high == -1);
202 i++, fi = get_prev_frame (fi))
205 current_uiout->field_int ("depth", i);
208 /* Print a list of the locals for the current frame. With argument of
209 0, print only the names, with argument of 1 print also the
213 mi_cmd_stack_list_locals (const char *command, char **argv, int argc)
215 struct frame_info *frame;
217 enum ext_lang_bt_status result = EXT_LANG_BT_ERROR;
218 enum print_values print_value;
220 int skip_unavailable = 0;
229 static const struct mi_opt opts[] =
231 {"-no-frame-filters", NO_FRAME_FILTERS, 0},
232 {"-skip-unavailable", SKIP_UNAVAILABLE, 0},
239 /* Don't parse 'print-values' as an option. */
240 int opt = mi_getopt ("-stack-list-locals", argc - 1, argv,
245 switch ((enum opt) opt)
247 case NO_FRAME_FILTERS:
249 case SKIP_UNAVAILABLE:
250 skip_unavailable = 1;
256 /* After the last option is parsed, there should be only
258 if (argc - oind != 1)
259 error (_("-stack-list-locals: Usage: [--no-frame-filters] "
260 "[--skip-unavailable] PRINT_VALUES"));
262 frame = get_selected_frame (NULL);
263 print_value = mi_parse_print_values (argv[oind]);
265 if (! raw_arg && frame_filters)
267 int flags = PRINT_LEVEL | PRINT_LOCALS;
269 result = mi_apply_ext_lang_frame_filter (frame, flags, print_value,
270 current_uiout, 0, 0);
273 /* Run the inbuilt backtrace if there are no filters registered, or
274 if "--no-frame-filters" has been specified from the command. */
275 if (! frame_filters || raw_arg || result == EXT_LANG_BT_NO_FILTERS)
277 list_args_or_locals (locals, print_value, frame,
282 /* Print a list of the arguments for the current frame. With argument
283 of 0, print only the names, with argument of 1 print also the
287 mi_cmd_stack_list_args (const char *command, char **argv, int argc)
292 struct frame_info *fi;
293 struct cleanup *cleanup_stack_args;
294 enum print_values print_values;
295 struct ui_out *uiout = current_uiout;
298 int skip_unavailable = 0;
299 enum ext_lang_bt_status result = EXT_LANG_BT_ERROR;
305 static const struct mi_opt opts[] =
307 {"-no-frame-filters", NO_FRAME_FILTERS, 0},
308 {"-skip-unavailable", SKIP_UNAVAILABLE, 0},
315 int opt = mi_getopt_allow_unknown ("-stack-list-args", argc, argv,
320 switch ((enum opt) opt)
322 case NO_FRAME_FILTERS:
325 case SKIP_UNAVAILABLE:
326 skip_unavailable = 1;
331 if (argc - oind != 1 && argc - oind != 3)
332 error (_("-stack-list-arguments: Usage: " \
333 "[--no-frame-filters] [--skip-unavailable] "
334 "PRINT_VALUES [FRAME_LOW FRAME_HIGH]"));
336 if (argc - oind == 3)
338 frame_low = atoi (argv[1 + oind]);
339 frame_high = atoi (argv[2 + oind]);
343 /* Called with no arguments, it means we want args for the whole
349 print_values = mi_parse_print_values (argv[oind]);
351 /* Let's position fi on the frame at which to start the
352 display. Could be the innermost frame if the whole stack needs
353 displaying, or if frame_low is 0. */
354 for (i = 0, fi = get_current_frame ();
356 i++, fi = get_prev_frame (fi));
359 error (_("-stack-list-arguments: Not enough frames in stack."));
362 = make_cleanup_ui_out_list_begin_end (uiout, "stack-args");
364 if (! raw_arg && frame_filters)
366 int flags = PRINT_LEVEL | PRINT_ARGS;
367 int py_frame_low = frame_low;
369 /* We cannot pass -1 to frame_low, as that would signify a
370 relative backtrace from the tail of the stack. So, in the case
371 of frame_low == -1, assign and increment it. */
372 if (py_frame_low == -1)
375 result = mi_apply_ext_lang_frame_filter (get_current_frame (), flags,
376 print_values, current_uiout,
377 py_frame_low, frame_high);
380 /* Run the inbuilt backtrace if there are no filters registered, or
381 if "--no-frame-filters" has been specified from the command. */
382 if (! frame_filters || raw_arg || result == EXT_LANG_BT_NO_FILTERS)
384 /* Now let's print the frames up to frame_high, or until there are
385 frames in the stack. */
387 fi && (i <= frame_high || frame_high == -1);
388 i++, fi = get_prev_frame (fi))
391 ui_out_emit_tuple tuple_emitter (uiout, "frame");
392 uiout->field_int ("level", i);
393 list_args_or_locals (arguments, print_values, fi, skip_unavailable);
396 do_cleanups (cleanup_stack_args);
399 /* Print a list of the local variables (including arguments) for the
400 current frame. ARGC must be 1 and ARGV[0] specify if only the names,
401 or both names and values of the variables must be printed. See
402 parse_print_value for possible values. */
405 mi_cmd_stack_list_variables (const char *command, char **argv, int argc)
407 struct frame_info *frame;
409 enum ext_lang_bt_status result = EXT_LANG_BT_ERROR;
410 enum print_values print_value;
412 int skip_unavailable = 0;
421 static const struct mi_opt opts[] =
423 {"-no-frame-filters", NO_FRAME_FILTERS, 0},
424 {"-skip-unavailable", SKIP_UNAVAILABLE, 0},
431 /* Don't parse 'print-values' as an option. */
432 int opt = mi_getopt ("-stack-list-variables", argc - 1,
433 argv, opts, &oind, &oarg);
436 switch ((enum opt) opt)
438 case NO_FRAME_FILTERS:
441 case SKIP_UNAVAILABLE:
442 skip_unavailable = 1;
448 /* After the last option is parsed, there should be only
450 if (argc - oind != 1)
451 error (_("-stack-list-variables: Usage: [--no-frame-filters] " \
452 "[--skip-unavailable] PRINT_VALUES"));
454 frame = get_selected_frame (NULL);
455 print_value = mi_parse_print_values (argv[oind]);
457 if (! raw_arg && frame_filters)
459 int flags = PRINT_LEVEL | PRINT_ARGS | PRINT_LOCALS;
461 result = mi_apply_ext_lang_frame_filter (frame, flags,
463 current_uiout, 0, 0);
466 /* Run the inbuilt backtrace if there are no filters registered, or
467 if "--no-frame-filters" has been specified from the command. */
468 if (! frame_filters || raw_arg || result == EXT_LANG_BT_NO_FILTERS)
470 list_args_or_locals (all, print_value, frame,
475 /* Print single local or argument. ARG must be already read in. For
476 WHAT and VALUES see list_args_or_locals.
478 Errors are printed as if they would be the parameter value. Use
479 zeroed ARG iff it should not be printed according to VALUES. If
480 SKIP_UNAVAILABLE is true, only print ARG if it is available. */
483 list_arg_or_local (const struct frame_arg *arg, enum what_to_list what,
484 enum print_values values, int skip_unavailable)
486 struct cleanup *old_chain;
487 struct ui_out *uiout = current_uiout;
489 gdb_assert (!arg->val || !arg->error);
490 gdb_assert ((values == PRINT_NO_VALUES && arg->val == NULL
491 && arg->error == NULL)
492 || values == PRINT_SIMPLE_VALUES
493 || (values == PRINT_ALL_VALUES
494 && (arg->val != NULL || arg->error != NULL)));
495 gdb_assert (arg->entry_kind == print_entry_values_no
496 || (arg->entry_kind == print_entry_values_only
497 && (arg->val || arg->error)));
499 if (skip_unavailable && arg->val != NULL
500 && (value_entirely_unavailable (arg->val)
501 /* A scalar object that does not have all bits available is
502 also considered unavailable, because all bits contribute
503 to its representation. */
504 || (val_print_scalar_type_p (value_type (arg->val))
505 && !value_bytes_available (arg->val,
506 value_embedded_offset (arg->val),
507 TYPE_LENGTH (value_type (arg->val))))))
510 old_chain = make_cleanup (null_cleanup, NULL);
512 if (values != PRINT_NO_VALUES || what == all)
513 make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
517 stb.puts (SYMBOL_PRINT_NAME (arg->sym));
518 if (arg->entry_kind == print_entry_values_only)
520 uiout->field_stream ("name", stb);
522 if (what == all && SYMBOL_IS_ARGUMENT (arg->sym))
523 uiout->field_int ("arg", 1);
525 if (values == PRINT_SIMPLE_VALUES)
527 check_typedef (arg->sym->type);
528 type_print (arg->sym->type, "", &stb, -1);
529 uiout->field_stream ("type", stb);
532 if (arg->val || arg->error)
534 const char *error_message = NULL;
537 error_message = arg->error;
542 struct value_print_options opts;
544 get_no_prettyformat_print_options (&opts);
546 common_val_print (arg->val, &stb, 0, &opts,
547 language_def (SYMBOL_LANGUAGE (arg->sym)));
549 CATCH (except, RETURN_MASK_ERROR)
551 error_message = except.message;
555 if (error_message != NULL)
556 stb.printf (_("<error reading variable: %s>"), error_message);
557 uiout->field_stream ("value", stb);
560 do_cleanups (old_chain);
563 /* Print a list of the objects for the frame FI in a certain form,
564 which is determined by VALUES. The objects can be locals,
565 arguments or both, which is determined by WHAT. If SKIP_UNAVAILABLE
566 is true, only print the arguments or local variables whose values
570 list_args_or_locals (enum what_to_list what, enum print_values values,
571 struct frame_info *fi, int skip_unavailable)
573 const struct block *block;
575 struct block_iterator iter;
576 struct cleanup *cleanup_list;
578 const char *name_of_result;
579 struct ui_out *uiout = current_uiout;
581 block = get_frame_block (fi, 0);
586 name_of_result = "locals";
589 name_of_result = "args";
592 name_of_result = "variables";
595 internal_error (__FILE__, __LINE__,
596 "unexpected what_to_list: %d", (int) what);
599 cleanup_list = make_cleanup_ui_out_list_begin_end (uiout, name_of_result);
603 ALL_BLOCK_SYMBOLS (block, iter, sym)
607 switch (SYMBOL_CLASS (sym))
610 case LOC_UNDEF: /* catches errors */
611 case LOC_CONST: /* constant */
612 case LOC_TYPEDEF: /* local typedef */
613 case LOC_LABEL: /* local label */
614 case LOC_BLOCK: /* local function */
615 case LOC_CONST_BYTES: /* loc. byte seq. */
616 case LOC_UNRESOLVED: /* unresolved static */
617 case LOC_OPTIMIZED_OUT: /* optimized out */
621 case LOC_ARG: /* argument */
622 case LOC_REF_ARG: /* reference arg */
623 case LOC_REGPARM_ADDR: /* indirect register arg */
624 case LOC_LOCAL: /* stack local */
625 case LOC_STATIC: /* static */
626 case LOC_REGISTER: /* register */
627 case LOC_COMPUTED: /* computed location */
630 else if (what == locals)
631 print_me = !SYMBOL_IS_ARGUMENT (sym);
633 print_me = SYMBOL_IS_ARGUMENT (sym);
639 struct frame_arg arg, entryarg;
641 if (SYMBOL_IS_ARGUMENT (sym))
642 sym2 = lookup_symbol (SYMBOL_LINKAGE_NAME (sym),
647 gdb_assert (sym2 != NULL);
649 memset (&arg, 0, sizeof (arg));
651 arg.entry_kind = print_entry_values_no;
652 memset (&entryarg, 0, sizeof (entryarg));
654 entryarg.entry_kind = print_entry_values_no;
658 case PRINT_SIMPLE_VALUES:
659 type = check_typedef (sym2->type);
660 if (TYPE_CODE (type) != TYPE_CODE_ARRAY
661 && TYPE_CODE (type) != TYPE_CODE_STRUCT
662 && TYPE_CODE (type) != TYPE_CODE_UNION)
664 case PRINT_ALL_VALUES:
665 if (SYMBOL_IS_ARGUMENT (sym))
666 read_frame_arg (sym2, fi, &arg, &entryarg);
668 read_frame_local (sym2, fi, &arg);
673 if (arg.entry_kind != print_entry_values_only)
674 list_arg_or_local (&arg, what, values, skip_unavailable);
675 if (entryarg.entry_kind != print_entry_values_no)
676 list_arg_or_local (&entryarg, what, values, skip_unavailable);
678 xfree (entryarg.error);
682 if (BLOCK_FUNCTION (block))
685 block = BLOCK_SUPERBLOCK (block);
687 do_cleanups (cleanup_list);
691 mi_cmd_stack_select_frame (const char *command, char **argv, int argc)
693 if (argc == 0 || argc > 1)
694 error (_("-stack-select-frame: Usage: FRAME_SPEC"));
696 select_frame_command (argv[0], 1 /* not used */ );
700 mi_cmd_stack_info_frame (const char *command, char **argv, int argc)
703 error (_("-stack-info-frame: No arguments allowed"));
705 print_frame_info (get_selected_frame (NULL), 1, LOC_AND_ADDRESS, 0, 1);