Change frame_filter_flags to use DEF_ENUM_FLAGS_TYPE
[deliverable/binutils-gdb.git] / gdb / mi / mi-cmd-stack.c
1 /* MI Command Set - stack commands.
2 Copyright (C) 2000-2018 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 "language.h"
31 #include "valprint.h"
32 #include "utils.h"
33 #include "mi-getopt.h"
34 #include "extension.h"
35 #include <ctype.h>
36 #include "mi-parse.h"
37 #include "common/gdb_optional.h"
38
39 enum what_to_list { locals, arguments, all };
40
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);
45
46 /* True if we want to allow Python-based frame filters. */
47 static int frame_filters = 0;
48
49 void
50 mi_cmd_enable_frame_filters (const char *command, char **argv, int argc)
51 {
52 if (argc != 0)
53 error (_("-enable-frame-filters: no arguments allowed"));
54 frame_filters = 1;
55 }
56
57 /* Like apply_ext_lang_frame_filter, but take a print_values */
58
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,
63 struct ui_out *out,
64 int frame_low, int frame_high)
65 {
66 /* ext_lang_frame_args's MI options are compatible with MI print
67 values. */
68 return apply_ext_lang_frame_filter (frame, flags,
69 (enum ext_lang_frame_args) print_values,
70 out,
71 frame_low, frame_high);
72 }
73
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
78 displayed. */
79
80 void
81 mi_cmd_stack_list_frames (const char *command, char **argv, int argc)
82 {
83 int frame_low;
84 int frame_high;
85 int i;
86 struct frame_info *fi;
87 enum ext_lang_bt_status result = EXT_LANG_BT_ERROR;
88 int raw_arg = 0;
89 int oind = 0;
90 enum opt
91 {
92 NO_FRAME_FILTERS
93 };
94 static const struct mi_opt opts[] =
95 {
96 {"-no-frame-filters", NO_FRAME_FILTERS, 0},
97 { 0, 0, 0 }
98 };
99
100 /* Parse arguments. In this instance we are just looking for
101 --no-frame-filters. */
102 while (1)
103 {
104 char *oarg;
105 int opt = mi_getopt ("-stack-list-frames", argc, argv,
106 opts, &oind, &oarg);
107 if (opt < 0)
108 break;
109 switch ((enum opt) opt)
110 {
111 case NO_FRAME_FILTERS:
112 raw_arg = oind;
113 break;
114 }
115 }
116
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]"));
121
122 /* If there is a range, set it. */
123 if (argc - oind == 2)
124 {
125 frame_low = atoi (argv[0 + oind]);
126 frame_high = atoi (argv[1 + oind]);
127 }
128 else
129 {
130 /* Called with no arguments, it means we want the whole
131 backtrace. */
132 frame_low = -1;
133 frame_high = -1;
134 }
135
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 ();
140 fi && i < frame_low;
141 i++, fi = get_prev_frame (fi));
142
143 if (fi == NULL)
144 error (_("-stack-list-frames: Not enough frames in stack."));
145
146 ui_out_emit_list list_emitter (current_uiout, "stack");
147
148 if (! raw_arg && frame_filters)
149 {
150 frame_filter_flags flags = PRINT_LEVEL | PRINT_FRAME_INFO;
151 int py_frame_low = frame_low;
152
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)
157 py_frame_low++;
158
159 result = apply_ext_lang_frame_filter (get_current_frame (), flags,
160 NO_VALUES, current_uiout,
161 py_frame_low, frame_high);
162 }
163
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)
167 {
168 /* Now let's print the frames up to frame_high, or until there are
169 frames in the stack. */
170 for (;
171 fi && (i <= frame_high || frame_high == -1);
172 i++, fi = get_prev_frame (fi))
173 {
174 QUIT;
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);
178 }
179 }
180 }
181
182 void
183 mi_cmd_stack_info_depth (const char *command, char **argv, int argc)
184 {
185 int frame_high;
186 int i;
187 struct frame_info *fi;
188
189 if (argc > 1)
190 error (_("-stack-info-depth: Usage: [MAX_DEPTH]"));
191
192 if (argc == 1)
193 frame_high = atoi (argv[0]);
194 else
195 /* Called with no arguments, it means we want the real depth of
196 the stack. */
197 frame_high = -1;
198
199 for (i = 0, fi = get_current_frame ();
200 fi && (i < frame_high || frame_high == -1);
201 i++, fi = get_prev_frame (fi))
202 QUIT;
203
204 current_uiout->field_int ("depth", i);
205 }
206
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
209 values. */
210
211 void
212 mi_cmd_stack_list_locals (const char *command, char **argv, int argc)
213 {
214 struct frame_info *frame;
215 int raw_arg = 0;
216 enum ext_lang_bt_status result = EXT_LANG_BT_ERROR;
217 enum print_values print_value;
218 int oind = 0;
219 int skip_unavailable = 0;
220
221 if (argc > 1)
222 {
223 enum opt
224 {
225 NO_FRAME_FILTERS,
226 SKIP_UNAVAILABLE,
227 };
228 static const struct mi_opt opts[] =
229 {
230 {"-no-frame-filters", NO_FRAME_FILTERS, 0},
231 {"-skip-unavailable", SKIP_UNAVAILABLE, 0},
232 { 0, 0, 0 }
233 };
234
235 while (1)
236 {
237 char *oarg;
238 /* Don't parse 'print-values' as an option. */
239 int opt = mi_getopt ("-stack-list-locals", argc - 1, argv,
240 opts, &oind, &oarg);
241
242 if (opt < 0)
243 break;
244 switch ((enum opt) opt)
245 {
246 case NO_FRAME_FILTERS:
247 raw_arg = oind;
248 case SKIP_UNAVAILABLE:
249 skip_unavailable = 1;
250 break;
251 }
252 }
253 }
254
255 /* After the last option is parsed, there should be only
256 'print-values'. */
257 if (argc - oind != 1)
258 error (_("-stack-list-locals: Usage: [--no-frame-filters] "
259 "[--skip-unavailable] PRINT_VALUES"));
260
261 frame = get_selected_frame (NULL);
262 print_value = mi_parse_print_values (argv[oind]);
263
264 if (! raw_arg && frame_filters)
265 {
266 frame_filter_flags flags = PRINT_LEVEL | PRINT_LOCALS;
267
268 result = mi_apply_ext_lang_frame_filter (frame, flags, print_value,
269 current_uiout, 0, 0);
270 }
271
272 /* Run the inbuilt backtrace if there are no filters registered, or
273 if "--no-frame-filters" has been specified from the command. */
274 if (! frame_filters || raw_arg || result == EXT_LANG_BT_NO_FILTERS)
275 {
276 list_args_or_locals (locals, print_value, frame,
277 skip_unavailable);
278 }
279 }
280
281 /* Print a list of the arguments for the current frame. With argument
282 of 0, print only the names, with argument of 1 print also the
283 values. */
284
285 void
286 mi_cmd_stack_list_args (const char *command, char **argv, int argc)
287 {
288 int frame_low;
289 int frame_high;
290 int i;
291 struct frame_info *fi;
292 enum print_values print_values;
293 struct ui_out *uiout = current_uiout;
294 int raw_arg = 0;
295 int oind = 0;
296 int skip_unavailable = 0;
297 enum ext_lang_bt_status result = EXT_LANG_BT_ERROR;
298 enum opt
299 {
300 NO_FRAME_FILTERS,
301 SKIP_UNAVAILABLE,
302 };
303 static const struct mi_opt opts[] =
304 {
305 {"-no-frame-filters", NO_FRAME_FILTERS, 0},
306 {"-skip-unavailable", SKIP_UNAVAILABLE, 0},
307 { 0, 0, 0 }
308 };
309
310 while (1)
311 {
312 char *oarg;
313 int opt = mi_getopt_allow_unknown ("-stack-list-args", argc, argv,
314 opts, &oind, &oarg);
315
316 if (opt < 0)
317 break;
318 switch ((enum opt) opt)
319 {
320 case NO_FRAME_FILTERS:
321 raw_arg = oind;
322 break;
323 case SKIP_UNAVAILABLE:
324 skip_unavailable = 1;
325 break;
326 }
327 }
328
329 if (argc - oind != 1 && argc - oind != 3)
330 error (_("-stack-list-arguments: Usage: " \
331 "[--no-frame-filters] [--skip-unavailable] "
332 "PRINT_VALUES [FRAME_LOW FRAME_HIGH]"));
333
334 if (argc - oind == 3)
335 {
336 frame_low = atoi (argv[1 + oind]);
337 frame_high = atoi (argv[2 + oind]);
338 }
339 else
340 {
341 /* Called with no arguments, it means we want args for the whole
342 backtrace. */
343 frame_low = -1;
344 frame_high = -1;
345 }
346
347 print_values = mi_parse_print_values (argv[oind]);
348
349 /* Let's position fi on the frame at which to start the
350 display. Could be the innermost frame if the whole stack needs
351 displaying, or if frame_low is 0. */
352 for (i = 0, fi = get_current_frame ();
353 fi && i < frame_low;
354 i++, fi = get_prev_frame (fi));
355
356 if (fi == NULL)
357 error (_("-stack-list-arguments: Not enough frames in stack."));
358
359 ui_out_emit_list list_emitter (uiout, "stack-args");
360
361 if (! raw_arg && frame_filters)
362 {
363 frame_filter_flags flags = PRINT_LEVEL | PRINT_ARGS;
364 int py_frame_low = frame_low;
365
366 /* We cannot pass -1 to frame_low, as that would signify a
367 relative backtrace from the tail of the stack. So, in the case
368 of frame_low == -1, assign and increment it. */
369 if (py_frame_low == -1)
370 py_frame_low++;
371
372 result = mi_apply_ext_lang_frame_filter (get_current_frame (), flags,
373 print_values, current_uiout,
374 py_frame_low, frame_high);
375 }
376
377 /* Run the inbuilt backtrace if there are no filters registered, or
378 if "--no-frame-filters" has been specified from the command. */
379 if (! frame_filters || raw_arg || result == EXT_LANG_BT_NO_FILTERS)
380 {
381 /* Now let's print the frames up to frame_high, or until there are
382 frames in the stack. */
383 for (;
384 fi && (i <= frame_high || frame_high == -1);
385 i++, fi = get_prev_frame (fi))
386 {
387 QUIT;
388 ui_out_emit_tuple tuple_emitter (uiout, "frame");
389 uiout->field_int ("level", i);
390 list_args_or_locals (arguments, print_values, fi, skip_unavailable);
391 }
392 }
393 }
394
395 /* Print a list of the local variables (including arguments) for the
396 current frame. ARGC must be 1 and ARGV[0] specify if only the names,
397 or both names and values of the variables must be printed. See
398 parse_print_value for possible values. */
399
400 void
401 mi_cmd_stack_list_variables (const char *command, char **argv, int argc)
402 {
403 struct frame_info *frame;
404 int raw_arg = 0;
405 enum ext_lang_bt_status result = EXT_LANG_BT_ERROR;
406 enum print_values print_value;
407 int oind = 0;
408 int skip_unavailable = 0;
409
410 if (argc > 1)
411 {
412 enum opt
413 {
414 NO_FRAME_FILTERS,
415 SKIP_UNAVAILABLE,
416 };
417 static const struct mi_opt opts[] =
418 {
419 {"-no-frame-filters", NO_FRAME_FILTERS, 0},
420 {"-skip-unavailable", SKIP_UNAVAILABLE, 0},
421 { 0, 0, 0 }
422 };
423
424 while (1)
425 {
426 char *oarg;
427 /* Don't parse 'print-values' as an option. */
428 int opt = mi_getopt ("-stack-list-variables", argc - 1,
429 argv, opts, &oind, &oarg);
430 if (opt < 0)
431 break;
432 switch ((enum opt) opt)
433 {
434 case NO_FRAME_FILTERS:
435 raw_arg = oind;
436 break;
437 case SKIP_UNAVAILABLE:
438 skip_unavailable = 1;
439 break;
440 }
441 }
442 }
443
444 /* After the last option is parsed, there should be only
445 'print-values'. */
446 if (argc - oind != 1)
447 error (_("-stack-list-variables: Usage: [--no-frame-filters] " \
448 "[--skip-unavailable] PRINT_VALUES"));
449
450 frame = get_selected_frame (NULL);
451 print_value = mi_parse_print_values (argv[oind]);
452
453 if (! raw_arg && frame_filters)
454 {
455 frame_filter_flags flags = PRINT_LEVEL | PRINT_ARGS | PRINT_LOCALS;
456
457 result = mi_apply_ext_lang_frame_filter (frame, flags,
458 print_value,
459 current_uiout, 0, 0);
460 }
461
462 /* Run the inbuilt backtrace if there are no filters registered, or
463 if "--no-frame-filters" has been specified from the command. */
464 if (! frame_filters || raw_arg || result == EXT_LANG_BT_NO_FILTERS)
465 {
466 list_args_or_locals (all, print_value, frame,
467 skip_unavailable);
468 }
469 }
470
471 /* Print single local or argument. ARG must be already read in. For
472 WHAT and VALUES see list_args_or_locals.
473
474 Errors are printed as if they would be the parameter value. Use
475 zeroed ARG iff it should not be printed according to VALUES. If
476 SKIP_UNAVAILABLE is true, only print ARG if it is available. */
477
478 static void
479 list_arg_or_local (const struct frame_arg *arg, enum what_to_list what,
480 enum print_values values, int skip_unavailable)
481 {
482 struct ui_out *uiout = current_uiout;
483
484 gdb_assert (!arg->val || !arg->error);
485 gdb_assert ((values == PRINT_NO_VALUES && arg->val == NULL
486 && arg->error == NULL)
487 || values == PRINT_SIMPLE_VALUES
488 || (values == PRINT_ALL_VALUES
489 && (arg->val != NULL || arg->error != NULL)));
490 gdb_assert (arg->entry_kind == print_entry_values_no
491 || (arg->entry_kind == print_entry_values_only
492 && (arg->val || arg->error)));
493
494 if (skip_unavailable && arg->val != NULL
495 && (value_entirely_unavailable (arg->val)
496 /* A scalar object that does not have all bits available is
497 also considered unavailable, because all bits contribute
498 to its representation. */
499 || (val_print_scalar_type_p (value_type (arg->val))
500 && !value_bytes_available (arg->val,
501 value_embedded_offset (arg->val),
502 TYPE_LENGTH (value_type (arg->val))))))
503 return;
504
505 gdb::optional<ui_out_emit_tuple> tuple_emitter;
506 if (values != PRINT_NO_VALUES || what == all)
507 tuple_emitter.emplace (uiout, nullptr);
508
509 string_file stb;
510
511 stb.puts (SYMBOL_PRINT_NAME (arg->sym));
512 if (arg->entry_kind == print_entry_values_only)
513 stb.puts ("@entry");
514 uiout->field_stream ("name", stb);
515
516 if (what == all && SYMBOL_IS_ARGUMENT (arg->sym))
517 uiout->field_int ("arg", 1);
518
519 if (values == PRINT_SIMPLE_VALUES)
520 {
521 check_typedef (arg->sym->type);
522 type_print (arg->sym->type, "", &stb, -1);
523 uiout->field_stream ("type", stb);
524 }
525
526 if (arg->val || arg->error)
527 {
528 const char *error_message = NULL;
529
530 if (arg->error)
531 error_message = arg->error;
532 else
533 {
534 TRY
535 {
536 struct value_print_options opts;
537
538 get_no_prettyformat_print_options (&opts);
539 opts.deref_ref = 1;
540 common_val_print (arg->val, &stb, 0, &opts,
541 language_def (SYMBOL_LANGUAGE (arg->sym)));
542 }
543 CATCH (except, RETURN_MASK_ERROR)
544 {
545 error_message = except.message;
546 }
547 END_CATCH
548 }
549 if (error_message != NULL)
550 stb.printf (_("<error reading variable: %s>"), error_message);
551 uiout->field_stream ("value", stb);
552 }
553 }
554
555 /* Print a list of the objects for the frame FI in a certain form,
556 which is determined by VALUES. The objects can be locals,
557 arguments or both, which is determined by WHAT. If SKIP_UNAVAILABLE
558 is true, only print the arguments or local variables whose values
559 are available. */
560
561 static void
562 list_args_or_locals (enum what_to_list what, enum print_values values,
563 struct frame_info *fi, int skip_unavailable)
564 {
565 const struct block *block;
566 struct symbol *sym;
567 struct block_iterator iter;
568 struct type *type;
569 const char *name_of_result;
570 struct ui_out *uiout = current_uiout;
571
572 block = get_frame_block (fi, 0);
573
574 switch (what)
575 {
576 case locals:
577 name_of_result = "locals";
578 break;
579 case arguments:
580 name_of_result = "args";
581 break;
582 case all:
583 name_of_result = "variables";
584 break;
585 default:
586 internal_error (__FILE__, __LINE__,
587 "unexpected what_to_list: %d", (int) what);
588 }
589
590 ui_out_emit_list list_emitter (uiout, name_of_result);
591
592 while (block != 0)
593 {
594 ALL_BLOCK_SYMBOLS (block, iter, sym)
595 {
596 int print_me = 0;
597
598 switch (SYMBOL_CLASS (sym))
599 {
600 default:
601 case LOC_UNDEF: /* catches errors */
602 case LOC_CONST: /* constant */
603 case LOC_TYPEDEF: /* local typedef */
604 case LOC_LABEL: /* local label */
605 case LOC_BLOCK: /* local function */
606 case LOC_CONST_BYTES: /* loc. byte seq. */
607 case LOC_UNRESOLVED: /* unresolved static */
608 case LOC_OPTIMIZED_OUT: /* optimized out */
609 print_me = 0;
610 break;
611
612 case LOC_ARG: /* argument */
613 case LOC_REF_ARG: /* reference arg */
614 case LOC_REGPARM_ADDR: /* indirect register arg */
615 case LOC_LOCAL: /* stack local */
616 case LOC_STATIC: /* static */
617 case LOC_REGISTER: /* register */
618 case LOC_COMPUTED: /* computed location */
619 if (what == all)
620 print_me = 1;
621 else if (what == locals)
622 print_me = !SYMBOL_IS_ARGUMENT (sym);
623 else
624 print_me = SYMBOL_IS_ARGUMENT (sym);
625 break;
626 }
627 if (print_me)
628 {
629 struct symbol *sym2;
630 struct frame_arg arg, entryarg;
631
632 if (SYMBOL_IS_ARGUMENT (sym))
633 sym2 = lookup_symbol (SYMBOL_LINKAGE_NAME (sym),
634 block, VAR_DOMAIN,
635 NULL).symbol;
636 else
637 sym2 = sym;
638 gdb_assert (sym2 != NULL);
639
640 memset (&arg, 0, sizeof (arg));
641 arg.sym = sym2;
642 arg.entry_kind = print_entry_values_no;
643 memset (&entryarg, 0, sizeof (entryarg));
644 entryarg.sym = sym2;
645 entryarg.entry_kind = print_entry_values_no;
646
647 switch (values)
648 {
649 case PRINT_SIMPLE_VALUES:
650 type = check_typedef (sym2->type);
651 if (TYPE_CODE (type) != TYPE_CODE_ARRAY
652 && TYPE_CODE (type) != TYPE_CODE_STRUCT
653 && TYPE_CODE (type) != TYPE_CODE_UNION)
654 {
655 case PRINT_ALL_VALUES:
656 if (SYMBOL_IS_ARGUMENT (sym))
657 read_frame_arg (sym2, fi, &arg, &entryarg);
658 else
659 read_frame_local (sym2, fi, &arg);
660 }
661 break;
662 }
663
664 if (arg.entry_kind != print_entry_values_only)
665 list_arg_or_local (&arg, what, values, skip_unavailable);
666 if (entryarg.entry_kind != print_entry_values_no)
667 list_arg_or_local (&entryarg, what, values, skip_unavailable);
668 xfree (arg.error);
669 xfree (entryarg.error);
670 }
671 }
672
673 if (BLOCK_FUNCTION (block))
674 break;
675 else
676 block = BLOCK_SUPERBLOCK (block);
677 }
678 }
679
680 void
681 mi_cmd_stack_select_frame (const char *command, char **argv, int argc)
682 {
683 if (argc == 0 || argc > 1)
684 error (_("-stack-select-frame: Usage: FRAME_SPEC"));
685
686 select_frame_command (argv[0], 1 /* not used */ );
687 }
688
689 void
690 mi_cmd_stack_info_frame (const char *command, char **argv, int argc)
691 {
692 if (argc > 0)
693 error (_("-stack-info-frame: No arguments allowed"));
694
695 print_frame_info (get_selected_frame (NULL), 1, LOC_AND_ADDRESS, 0, 1);
696 }
This page took 0.044191 seconds and 4 git commands to generate.