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