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
))
390 struct cleanup
*cleanup_frame
;
393 cleanup_frame
= make_cleanup_ui_out_tuple_begin_end (uiout
, "frame");
394 uiout
->field_int ("level", i
);
395 list_args_or_locals (arguments
, print_values
, fi
, skip_unavailable
);
396 do_cleanups (cleanup_frame
);
399 do_cleanups (cleanup_stack_args
);
402 /* Print a list of the local variables (including arguments) for the
403 current frame. ARGC must be 1 and ARGV[0] specify if only the names,
404 or both names and values of the variables must be printed. See
405 parse_print_value for possible values. */
408 mi_cmd_stack_list_variables (const char *command
, char **argv
, int argc
)
410 struct frame_info
*frame
;
412 enum ext_lang_bt_status result
= EXT_LANG_BT_ERROR
;
413 enum print_values print_value
;
415 int skip_unavailable
= 0;
424 static const struct mi_opt opts
[] =
426 {"-no-frame-filters", NO_FRAME_FILTERS
, 0},
427 {"-skip-unavailable", SKIP_UNAVAILABLE
, 0},
434 /* Don't parse 'print-values' as an option. */
435 int opt
= mi_getopt ("-stack-list-variables", argc
- 1,
436 argv
, opts
, &oind
, &oarg
);
439 switch ((enum opt
) opt
)
441 case NO_FRAME_FILTERS
:
444 case SKIP_UNAVAILABLE
:
445 skip_unavailable
= 1;
451 /* After the last option is parsed, there should be only
453 if (argc
- oind
!= 1)
454 error (_("-stack-list-variables: Usage: [--no-frame-filters] " \
455 "[--skip-unavailable] PRINT_VALUES"));
457 frame
= get_selected_frame (NULL
);
458 print_value
= mi_parse_print_values (argv
[oind
]);
460 if (! raw_arg
&& frame_filters
)
462 int flags
= PRINT_LEVEL
| PRINT_ARGS
| PRINT_LOCALS
;
464 result
= mi_apply_ext_lang_frame_filter (frame
, flags
,
466 current_uiout
, 0, 0);
469 /* Run the inbuilt backtrace if there are no filters registered, or
470 if "--no-frame-filters" has been specified from the command. */
471 if (! frame_filters
|| raw_arg
|| result
== EXT_LANG_BT_NO_FILTERS
)
473 list_args_or_locals (all
, print_value
, frame
,
478 /* Print single local or argument. ARG must be already read in. For
479 WHAT and VALUES see list_args_or_locals.
481 Errors are printed as if they would be the parameter value. Use
482 zeroed ARG iff it should not be printed according to VALUES. If
483 SKIP_UNAVAILABLE is true, only print ARG if it is available. */
486 list_arg_or_local (const struct frame_arg
*arg
, enum what_to_list what
,
487 enum print_values values
, int skip_unavailable
)
489 struct cleanup
*old_chain
;
490 struct ui_out
*uiout
= current_uiout
;
492 gdb_assert (!arg
->val
|| !arg
->error
);
493 gdb_assert ((values
== PRINT_NO_VALUES
&& arg
->val
== NULL
494 && arg
->error
== NULL
)
495 || values
== PRINT_SIMPLE_VALUES
496 || (values
== PRINT_ALL_VALUES
497 && (arg
->val
!= NULL
|| arg
->error
!= NULL
)));
498 gdb_assert (arg
->entry_kind
== print_entry_values_no
499 || (arg
->entry_kind
== print_entry_values_only
500 && (arg
->val
|| arg
->error
)));
502 if (skip_unavailable
&& arg
->val
!= NULL
503 && (value_entirely_unavailable (arg
->val
)
504 /* A scalar object that does not have all bits available is
505 also considered unavailable, because all bits contribute
506 to its representation. */
507 || (val_print_scalar_type_p (value_type (arg
->val
))
508 && !value_bytes_available (arg
->val
,
509 value_embedded_offset (arg
->val
),
510 TYPE_LENGTH (value_type (arg
->val
))))))
513 old_chain
= make_cleanup (null_cleanup
, NULL
);
515 if (values
!= PRINT_NO_VALUES
|| what
== all
)
516 make_cleanup_ui_out_tuple_begin_end (uiout
, NULL
);
520 stb
.puts (SYMBOL_PRINT_NAME (arg
->sym
));
521 if (arg
->entry_kind
== print_entry_values_only
)
523 uiout
->field_stream ("name", stb
);
525 if (what
== all
&& SYMBOL_IS_ARGUMENT (arg
->sym
))
526 uiout
->field_int ("arg", 1);
528 if (values
== PRINT_SIMPLE_VALUES
)
530 check_typedef (arg
->sym
->type
);
531 type_print (arg
->sym
->type
, "", &stb
, -1);
532 uiout
->field_stream ("type", stb
);
535 if (arg
->val
|| arg
->error
)
537 const char *error_message
= NULL
;
540 error_message
= arg
->error
;
545 struct value_print_options opts
;
547 get_no_prettyformat_print_options (&opts
);
549 common_val_print (arg
->val
, &stb
, 0, &opts
,
550 language_def (SYMBOL_LANGUAGE (arg
->sym
)));
552 CATCH (except
, RETURN_MASK_ERROR
)
554 error_message
= except
.message
;
558 if (error_message
!= NULL
)
559 stb
.printf (_("<error reading variable: %s>"), error_message
);
560 uiout
->field_stream ("value", stb
);
563 do_cleanups (old_chain
);
566 /* Print a list of the objects for the frame FI in a certain form,
567 which is determined by VALUES. The objects can be locals,
568 arguments or both, which is determined by WHAT. If SKIP_UNAVAILABLE
569 is true, only print the arguments or local variables whose values
573 list_args_or_locals (enum what_to_list what
, enum print_values values
,
574 struct frame_info
*fi
, int skip_unavailable
)
576 const struct block
*block
;
578 struct block_iterator iter
;
579 struct cleanup
*cleanup_list
;
581 const char *name_of_result
;
582 struct ui_out
*uiout
= current_uiout
;
584 block
= get_frame_block (fi
, 0);
589 name_of_result
= "locals";
592 name_of_result
= "args";
595 name_of_result
= "variables";
598 internal_error (__FILE__
, __LINE__
,
599 "unexpected what_to_list: %d", (int) what
);
602 cleanup_list
= make_cleanup_ui_out_list_begin_end (uiout
, name_of_result
);
606 ALL_BLOCK_SYMBOLS (block
, iter
, sym
)
610 switch (SYMBOL_CLASS (sym
))
613 case LOC_UNDEF
: /* catches errors */
614 case LOC_CONST
: /* constant */
615 case LOC_TYPEDEF
: /* local typedef */
616 case LOC_LABEL
: /* local label */
617 case LOC_BLOCK
: /* local function */
618 case LOC_CONST_BYTES
: /* loc. byte seq. */
619 case LOC_UNRESOLVED
: /* unresolved static */
620 case LOC_OPTIMIZED_OUT
: /* optimized out */
624 case LOC_ARG
: /* argument */
625 case LOC_REF_ARG
: /* reference arg */
626 case LOC_REGPARM_ADDR
: /* indirect register arg */
627 case LOC_LOCAL
: /* stack local */
628 case LOC_STATIC
: /* static */
629 case LOC_REGISTER
: /* register */
630 case LOC_COMPUTED
: /* computed location */
633 else if (what
== locals
)
634 print_me
= !SYMBOL_IS_ARGUMENT (sym
);
636 print_me
= SYMBOL_IS_ARGUMENT (sym
);
642 struct frame_arg arg
, entryarg
;
644 if (SYMBOL_IS_ARGUMENT (sym
))
645 sym2
= lookup_symbol (SYMBOL_LINKAGE_NAME (sym
),
650 gdb_assert (sym2
!= NULL
);
652 memset (&arg
, 0, sizeof (arg
));
654 arg
.entry_kind
= print_entry_values_no
;
655 memset (&entryarg
, 0, sizeof (entryarg
));
657 entryarg
.entry_kind
= print_entry_values_no
;
661 case PRINT_SIMPLE_VALUES
:
662 type
= check_typedef (sym2
->type
);
663 if (TYPE_CODE (type
) != TYPE_CODE_ARRAY
664 && TYPE_CODE (type
) != TYPE_CODE_STRUCT
665 && TYPE_CODE (type
) != TYPE_CODE_UNION
)
667 case PRINT_ALL_VALUES
:
668 if (SYMBOL_IS_ARGUMENT (sym
))
669 read_frame_arg (sym2
, fi
, &arg
, &entryarg
);
671 read_frame_local (sym2
, fi
, &arg
);
676 if (arg
.entry_kind
!= print_entry_values_only
)
677 list_arg_or_local (&arg
, what
, values
, skip_unavailable
);
678 if (entryarg
.entry_kind
!= print_entry_values_no
)
679 list_arg_or_local (&entryarg
, what
, values
, skip_unavailable
);
681 xfree (entryarg
.error
);
685 if (BLOCK_FUNCTION (block
))
688 block
= BLOCK_SUPERBLOCK (block
);
690 do_cleanups (cleanup_list
);
694 mi_cmd_stack_select_frame (const char *command
, char **argv
, int argc
)
696 if (argc
== 0 || argc
> 1)
697 error (_("-stack-select-frame: Usage: FRAME_SPEC"));
699 select_frame_command (argv
[0], 1 /* not used */ );
703 mi_cmd_stack_info_frame (const char *command
, char **argv
, int argc
)
706 error (_("-stack-info-frame: No arguments allowed"));
708 print_frame_info (get_selected_frame (NULL
), 1, LOC_AND_ADDRESS
, 0, 1);