1 /* MI Command Set - stack commands.
2 Copyright (C) 2000-2018 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"
37 #include "common/gdb_optional.h"
39 enum what_to_list { locals, arguments, all };
41 static void list_args_or_locals (enum what_to_list what,
42 enum print_values values,
43 struct frame_info *fi,
44 int skip_unavailable);
46 /* True if we want to allow Python-based frame filters. */
47 static int frame_filters = 0;
50 mi_cmd_enable_frame_filters (const char *command, char **argv, int argc)
53 error (_("-enable-frame-filters: no arguments allowed"));
57 /* Like apply_ext_lang_frame_filter, but take a print_values */
59 static enum ext_lang_bt_status
60 mi_apply_ext_lang_frame_filter (struct frame_info *frame,
61 frame_filter_flags flags,
62 enum print_values print_values,
64 int frame_low, int frame_high)
66 /* ext_lang_frame_args's MI options are compatible with MI print
68 return apply_ext_lang_frame_filter (frame, flags,
69 (enum ext_lang_frame_args) print_values,
71 frame_low, frame_high);
74 /* Print a list of the stack frames. Args can be none, in which case
75 we want to print the whole backtrace, or a pair of numbers
76 specifying the frame numbers at which to start and stop the
77 display. If the two numbers are equal, a single frame will be
81 mi_cmd_stack_list_frames (const char *command, char **argv, int argc)
86 struct frame_info *fi;
87 enum ext_lang_bt_status result = EXT_LANG_BT_ERROR;
94 static const struct mi_opt opts[] =
96 {"-no-frame-filters", NO_FRAME_FILTERS, 0},
100 /* Parse arguments. In this instance we are just looking for
101 --no-frame-filters. */
105 int opt = mi_getopt ("-stack-list-frames", argc, argv,
109 switch ((enum opt) opt)
111 case NO_FRAME_FILTERS:
117 /* After the last option is parsed, there should either be low -
118 high range, or no further arguments. */
119 if ((argc - oind != 0) && (argc - oind != 2))
120 error (_("-stack-list-frames: Usage: [--no-frame-filters] [FRAME_LOW FRAME_HIGH]"));
122 /* If there is a range, set it. */
123 if (argc - oind == 2)
125 frame_low = atoi (argv[0 + oind]);
126 frame_high = atoi (argv[1 + oind]);
130 /* Called with no arguments, it means we want the whole
136 /* Let's position fi on the frame at which to start the
137 display. Could be the innermost frame if the whole stack needs
138 displaying, or if frame_low is 0. */
139 for (i = 0, fi = get_current_frame ();
141 i++, fi = get_prev_frame (fi));
144 error (_("-stack-list-frames: Not enough frames in stack."));
146 ui_out_emit_list list_emitter (current_uiout, "stack");
148 if (! raw_arg && frame_filters)
150 frame_filter_flags flags = PRINT_LEVEL | PRINT_FRAME_INFO;
151 int py_frame_low = frame_low;
153 /* We cannot pass -1 to frame_low, as that would signify a
154 relative backtrace from the tail of the stack. So, in the case
155 of frame_low == -1, assign and increment it. */
156 if (py_frame_low == -1)
159 result = apply_ext_lang_frame_filter (get_current_frame (), flags,
160 NO_VALUES, current_uiout,
161 py_frame_low, frame_high);
164 /* Run the inbuilt backtrace if there are no filters registered, or
165 if "--no-frame-filters" has been specified from the command. */
166 if (! frame_filters || raw_arg || result == EXT_LANG_BT_NO_FILTERS)
168 /* Now let's print the frames up to frame_high, or until there are
169 frames in the stack. */
171 fi && (i <= frame_high || frame_high == -1);
172 i++, fi = get_prev_frame (fi))
175 /* Print the location and the address always, even for level 0.
176 If args is 0, don't print the arguments. */
177 print_frame_info (fi, 1, LOC_AND_ADDRESS, 0 /* args */, 0);
183 mi_cmd_stack_info_depth (const char *command, char **argv, int argc)
187 struct frame_info *fi;
190 error (_("-stack-info-depth: Usage: [MAX_DEPTH]"));
193 frame_high = atoi (argv[0]);
195 /* Called with no arguments, it means we want the real depth of
199 for (i = 0, fi = get_current_frame ();
200 fi && (i < frame_high || frame_high == -1);
201 i++, fi = get_prev_frame (fi))
204 current_uiout->field_int ("depth", i);
207 /* Print a list of the locals for the current frame. With argument of
208 0, print only the names, with argument of 1 print also the
212 mi_cmd_stack_list_locals (const char *command, char **argv, int argc)
214 struct frame_info *frame;
216 enum ext_lang_bt_status result = EXT_LANG_BT_ERROR;
217 enum print_values print_value;
219 int skip_unavailable = 0;
228 static const struct mi_opt opts[] =
230 {"-no-frame-filters", NO_FRAME_FILTERS, 0},
231 {"-skip-unavailable", SKIP_UNAVAILABLE, 0},
238 /* Don't parse 'print-values' as an option. */
239 int opt = mi_getopt ("-stack-list-locals", argc - 1, argv,
244 switch ((enum opt) opt)
246 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 frame_filter_flags 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 enum print_values print_values;
294 struct ui_out *uiout = current_uiout;
297 int skip_unavailable = 0;
298 enum ext_lang_bt_status result = EXT_LANG_BT_ERROR;
304 static const struct mi_opt opts[] =
306 {"-no-frame-filters", NO_FRAME_FILTERS, 0},
307 {"-skip-unavailable", SKIP_UNAVAILABLE, 0},
314 int opt = mi_getopt_allow_unknown ("-stack-list-args", argc, argv,
319 switch ((enum opt) opt)
321 case NO_FRAME_FILTERS:
324 case SKIP_UNAVAILABLE:
325 skip_unavailable = 1;
330 if (argc - oind != 1 && argc - oind != 3)
331 error (_("-stack-list-arguments: Usage: " \
332 "[--no-frame-filters] [--skip-unavailable] "
333 "PRINT_VALUES [FRAME_LOW FRAME_HIGH]"));
335 if (argc - oind == 3)
337 frame_low = atoi (argv[1 + oind]);
338 frame_high = atoi (argv[2 + oind]);
342 /* Called with no arguments, it means we want args for the whole
348 print_values = mi_parse_print_values (argv[oind]);
350 /* Let's position fi on the frame at which to start the
351 display. Could be the innermost frame if the whole stack needs
352 displaying, or if frame_low is 0. */
353 for (i = 0, fi = get_current_frame ();
355 i++, fi = get_prev_frame (fi));
358 error (_("-stack-list-arguments: Not enough frames in stack."));
360 ui_out_emit_list list_emitter (uiout, "stack-args");
362 if (! raw_arg && frame_filters)
364 frame_filter_flags flags = PRINT_LEVEL | PRINT_ARGS;
365 int py_frame_low = frame_low;
367 /* We cannot pass -1 to frame_low, as that would signify a
368 relative backtrace from the tail of the stack. So, in the case
369 of frame_low == -1, assign and increment it. */
370 if (py_frame_low == -1)
373 result = mi_apply_ext_lang_frame_filter (get_current_frame (), flags,
374 print_values, current_uiout,
375 py_frame_low, frame_high);
378 /* Run the inbuilt backtrace if there are no filters registered, or
379 if "--no-frame-filters" has been specified from the command. */
380 if (! frame_filters || raw_arg || result == EXT_LANG_BT_NO_FILTERS)
382 /* Now let's print the frames up to frame_high, or until there are
383 frames in the stack. */
385 fi && (i <= frame_high || frame_high == -1);
386 i++, fi = get_prev_frame (fi))
389 ui_out_emit_tuple tuple_emitter (uiout, "frame");
390 uiout->field_int ("level", i);
391 list_args_or_locals (arguments, print_values, fi, skip_unavailable);
396 /* Print a list of the local variables (including arguments) for the
397 current frame. ARGC must be 1 and ARGV[0] specify if only the names,
398 or both names and values of the variables must be printed. See
399 parse_print_value for possible values. */
402 mi_cmd_stack_list_variables (const char *command, char **argv, int argc)
404 struct frame_info *frame;
406 enum ext_lang_bt_status result = EXT_LANG_BT_ERROR;
407 enum print_values print_value;
409 int skip_unavailable = 0;
418 static const struct mi_opt opts[] =
420 {"-no-frame-filters", NO_FRAME_FILTERS, 0},
421 {"-skip-unavailable", SKIP_UNAVAILABLE, 0},
428 /* Don't parse 'print-values' as an option. */
429 int opt = mi_getopt ("-stack-list-variables", argc - 1,
430 argv, opts, &oind, &oarg);
433 switch ((enum opt) opt)
435 case NO_FRAME_FILTERS:
438 case SKIP_UNAVAILABLE:
439 skip_unavailable = 1;
445 /* After the last option is parsed, there should be only
447 if (argc - oind != 1)
448 error (_("-stack-list-variables: Usage: [--no-frame-filters] " \
449 "[--skip-unavailable] PRINT_VALUES"));
451 frame = get_selected_frame (NULL);
452 print_value = mi_parse_print_values (argv[oind]);
454 if (! raw_arg && frame_filters)
456 frame_filter_flags flags = PRINT_LEVEL | PRINT_ARGS | PRINT_LOCALS;
458 result = mi_apply_ext_lang_frame_filter (frame, flags,
460 current_uiout, 0, 0);
463 /* Run the inbuilt backtrace if there are no filters registered, or
464 if "--no-frame-filters" has been specified from the command. */
465 if (! frame_filters || raw_arg || result == EXT_LANG_BT_NO_FILTERS)
467 list_args_or_locals (all, print_value, frame,
472 /* Print single local or argument. ARG must be already read in. For
473 WHAT and VALUES see list_args_or_locals.
475 Errors are printed as if they would be the parameter value. Use
476 zeroed ARG iff it should not be printed according to VALUES. If
477 SKIP_UNAVAILABLE is true, only print ARG if it is available. */
480 list_arg_or_local (const struct frame_arg *arg, enum what_to_list what,
481 enum print_values values, int skip_unavailable)
483 struct ui_out *uiout = current_uiout;
485 gdb_assert (!arg->val || !arg->error);
486 gdb_assert ((values == PRINT_NO_VALUES && arg->val == NULL
487 && arg->error == NULL)
488 || values == PRINT_SIMPLE_VALUES
489 || (values == PRINT_ALL_VALUES
490 && (arg->val != NULL || arg->error != NULL)));
491 gdb_assert (arg->entry_kind == print_entry_values_no
492 || (arg->entry_kind == print_entry_values_only
493 && (arg->val || arg->error)));
495 if (skip_unavailable && arg->val != NULL
496 && (value_entirely_unavailable (arg->val)
497 /* A scalar object that does not have all bits available is
498 also considered unavailable, because all bits contribute
499 to its representation. */
500 || (val_print_scalar_type_p (value_type (arg->val))
501 && !value_bytes_available (arg->val,
502 value_embedded_offset (arg->val),
503 TYPE_LENGTH (value_type (arg->val))))))
506 gdb::optional<ui_out_emit_tuple> tuple_emitter;
507 if (values != PRINT_NO_VALUES || what == all)
508 tuple_emitter.emplace (uiout, nullptr);
512 stb.puts (SYMBOL_PRINT_NAME (arg->sym));
513 if (arg->entry_kind == print_entry_values_only)
515 uiout->field_stream ("name", stb);
517 if (what == all && SYMBOL_IS_ARGUMENT (arg->sym))
518 uiout->field_int ("arg", 1);
520 if (values == PRINT_SIMPLE_VALUES)
522 check_typedef (arg->sym->type);
523 type_print (arg->sym->type, "", &stb, -1);
524 uiout->field_stream ("type", stb);
527 if (arg->val || arg->error)
529 const char *error_message = NULL;
532 error_message = arg->error;
537 struct value_print_options opts;
539 get_no_prettyformat_print_options (&opts);
541 common_val_print (arg->val, &stb, 0, &opts,
542 language_def (SYMBOL_LANGUAGE (arg->sym)));
544 CATCH (except, RETURN_MASK_ERROR)
546 error_message = except.message;
550 if (error_message != NULL)
551 stb.printf (_("<error reading variable: %s>"), error_message);
552 uiout->field_stream ("value", stb);
556 /* Print a list of the objects for the frame FI in a certain form,
557 which is determined by VALUES. The objects can be locals,
558 arguments or both, which is determined by WHAT. If SKIP_UNAVAILABLE
559 is true, only print the arguments or local variables whose values
563 list_args_or_locals (enum what_to_list what, enum print_values values,
564 struct frame_info *fi, int skip_unavailable)
566 const struct block *block;
568 struct block_iterator iter;
570 const char *name_of_result;
571 struct ui_out *uiout = current_uiout;
573 block = get_frame_block (fi, 0);
578 name_of_result = "locals";
581 name_of_result = "args";
584 name_of_result = "variables";
587 internal_error (__FILE__, __LINE__,
588 "unexpected what_to_list: %d", (int) what);
591 ui_out_emit_list list_emitter (uiout, name_of_result);
595 ALL_BLOCK_SYMBOLS (block, iter, sym)
599 switch (SYMBOL_CLASS (sym))
602 case LOC_UNDEF: /* catches errors */
603 case LOC_CONST: /* constant */
604 case LOC_TYPEDEF: /* local typedef */
605 case LOC_LABEL: /* local label */
606 case LOC_BLOCK: /* local function */
607 case LOC_CONST_BYTES: /* loc. byte seq. */
608 case LOC_UNRESOLVED: /* unresolved static */
609 case LOC_OPTIMIZED_OUT: /* optimized out */
613 case LOC_ARG: /* argument */
614 case LOC_REF_ARG: /* reference arg */
615 case LOC_REGPARM_ADDR: /* indirect register arg */
616 case LOC_LOCAL: /* stack local */
617 case LOC_STATIC: /* static */
618 case LOC_REGISTER: /* register */
619 case LOC_COMPUTED: /* computed location */
622 else if (what == locals)
623 print_me = !SYMBOL_IS_ARGUMENT (sym);
625 print_me = SYMBOL_IS_ARGUMENT (sym);
631 struct frame_arg arg, entryarg;
633 if (SYMBOL_IS_ARGUMENT (sym))
634 sym2 = lookup_symbol (SYMBOL_LINKAGE_NAME (sym),
639 gdb_assert (sym2 != NULL);
641 memset (&arg, 0, sizeof (arg));
643 arg.entry_kind = print_entry_values_no;
644 memset (&entryarg, 0, sizeof (entryarg));
646 entryarg.entry_kind = print_entry_values_no;
650 case PRINT_SIMPLE_VALUES:
651 type = check_typedef (sym2->type);
652 if (TYPE_CODE (type) != TYPE_CODE_ARRAY
653 && TYPE_CODE (type) != TYPE_CODE_STRUCT
654 && TYPE_CODE (type) != TYPE_CODE_UNION)
656 case PRINT_ALL_VALUES:
657 if (SYMBOL_IS_ARGUMENT (sym))
658 read_frame_arg (sym2, fi, &arg, &entryarg);
660 read_frame_local (sym2, fi, &arg);
665 if (arg.entry_kind != print_entry_values_only)
666 list_arg_or_local (&arg, what, values, skip_unavailable);
667 if (entryarg.entry_kind != print_entry_values_no)
668 list_arg_or_local (&entryarg, what, values, skip_unavailable);
670 xfree (entryarg.error);
674 if (BLOCK_FUNCTION (block))
677 block = BLOCK_SUPERBLOCK (block);
682 mi_cmd_stack_select_frame (const char *command, char **argv, int argc)
684 if (argc == 0 || argc > 1)
685 error (_("-stack-select-frame: Usage: FRAME_SPEC"));
687 select_frame_command (argv[0], 1 /* not used */ );
691 mi_cmd_stack_info_frame (const char *command, char **argv, int argc)
694 error (_("-stack-info-frame: No arguments allowed"));
696 print_frame_info (get_selected_frame (NULL), 1, LOC_AND_ADDRESS, 0, 1);