1 /* MI Command Set - stack commands.
2 Copyright (C) 2000-2013 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"
30 #include "gdb_string.h"
33 #include "exceptions.h"
35 enum what_to_list { locals, arguments, all };
37 static void list_args_or_locals (enum what_to_list what,
38 enum print_values values,
39 struct frame_info *fi);
41 /* Print a list of the stack frames. Args can be none, in which case
42 we want to print the whole backtrace, or a pair of numbers
43 specifying the frame numbers at which to start and stop the
44 display. If the two numbers are equal, a single frame will be
48 mi_cmd_stack_list_frames (char *command, char **argv, int argc)
53 struct cleanup *cleanup_stack;
54 struct frame_info *fi;
56 if (argc > 2 || argc == 1)
57 error (_("-stack-list-frames: Usage: [FRAME_LOW FRAME_HIGH]"));
61 frame_low = atoi (argv[0]);
62 frame_high = atoi (argv[1]);
66 /* Called with no arguments, it means we want the whole
72 /* Let's position fi on the frame at which to start the
73 display. Could be the innermost frame if the whole stack needs
74 displaying, or if frame_low is 0. */
75 for (i = 0, fi = get_current_frame ();
77 i++, fi = get_prev_frame (fi));
80 error (_("-stack-list-frames: Not enough frames in stack."));
82 cleanup_stack = make_cleanup_ui_out_list_begin_end (current_uiout, "stack");
84 /* Now let's print the frames up to frame_high, or until there are
85 frames in the stack. */
87 fi && (i <= frame_high || frame_high == -1);
88 i++, fi = get_prev_frame (fi))
91 /* Print the location and the address always, even for level 0.
92 If args is 0, don't print the arguments. */
93 print_frame_info (fi, 1, LOC_AND_ADDRESS, 0 /* args */ );
96 do_cleanups (cleanup_stack);
100 mi_cmd_stack_info_depth (char *command, char **argv, int argc)
104 struct frame_info *fi;
107 error (_("-stack-info-depth: Usage: [MAX_DEPTH]"));
110 frame_high = atoi (argv[0]);
112 /* Called with no arguments, it means we want the real depth of
116 for (i = 0, fi = get_current_frame ();
117 fi && (i < frame_high || frame_high == -1);
118 i++, fi = get_prev_frame (fi))
121 ui_out_field_int (current_uiout, "depth", i);
124 static enum print_values
125 parse_print_values (char *name)
127 if (strcmp (name, "0") == 0
128 || strcmp (name, mi_no_values) == 0)
129 return PRINT_NO_VALUES;
130 else if (strcmp (name, "1") == 0
131 || strcmp (name, mi_all_values) == 0)
132 return PRINT_ALL_VALUES;
133 else if (strcmp (name, "2") == 0
134 || strcmp (name, mi_simple_values) == 0)
135 return PRINT_SIMPLE_VALUES;
137 error (_("Unknown value for PRINT_VALUES: must be: \
138 0 or \"%s\", 1 or \"%s\", 2 or \"%s\""),
139 mi_no_values, mi_all_values, mi_simple_values);
142 /* Print a list of the locals for the current frame. With argument of
143 0, print only the names, with argument of 1 print also the
147 mi_cmd_stack_list_locals (char *command, char **argv, int argc)
149 struct frame_info *frame;
152 error (_("-stack-list-locals: Usage: PRINT_VALUES"));
154 frame = get_selected_frame (NULL);
156 list_args_or_locals (locals, parse_print_values (argv[0]), frame);
159 /* Print a list of the arguments for the current frame. With argument
160 of 0, print only the names, with argument of 1 print also the
164 mi_cmd_stack_list_args (char *command, char **argv, int argc)
169 struct frame_info *fi;
170 struct cleanup *cleanup_stack_args;
171 enum print_values print_values;
172 struct ui_out *uiout = current_uiout;
174 if (argc < 1 || argc > 3 || argc == 2)
175 error (_("-stack-list-arguments: Usage: "
176 "PRINT_VALUES [FRAME_LOW FRAME_HIGH]"));
180 frame_low = atoi (argv[1]);
181 frame_high = atoi (argv[2]);
185 /* Called with no arguments, it means we want args for the whole
191 print_values = parse_print_values (argv[0]);
193 /* Let's position fi on the frame at which to start the
194 display. Could be the innermost frame if the whole stack needs
195 displaying, or if frame_low is 0. */
196 for (i = 0, fi = get_current_frame ();
198 i++, fi = get_prev_frame (fi));
201 error (_("-stack-list-arguments: Not enough frames in stack."));
204 = make_cleanup_ui_out_list_begin_end (uiout, "stack-args");
206 /* Now let's print the frames up to frame_high, or until there are
207 frames in the stack. */
209 fi && (i <= frame_high || frame_high == -1);
210 i++, fi = get_prev_frame (fi))
212 struct cleanup *cleanup_frame;
215 cleanup_frame = make_cleanup_ui_out_tuple_begin_end (uiout, "frame");
216 ui_out_field_int (uiout, "level", i);
217 list_args_or_locals (arguments, print_values, fi);
218 do_cleanups (cleanup_frame);
221 do_cleanups (cleanup_stack_args);
224 /* Print a list of the local variables (including arguments) for the
225 current frame. ARGC must be 1 and ARGV[0] specify if only the names,
226 or both names and values of the variables must be printed. See
227 parse_print_value for possible values. */
230 mi_cmd_stack_list_variables (char *command, char **argv, int argc)
232 struct frame_info *frame;
235 error (_("Usage: PRINT_VALUES"));
237 frame = get_selected_frame (NULL);
239 list_args_or_locals (all, parse_print_values (argv[0]), frame);
242 /* Print single local or argument. ARG must be already read in. For
243 WHAT and VALUES see list_args_or_locals.
245 Errors are printed as if they would be the parameter value. Use
246 zeroed ARG iff it should not be printed according to VALUES. */
249 list_arg_or_local (const struct frame_arg *arg, enum what_to_list what,
250 enum print_values values)
252 struct cleanup *old_chain;
253 struct cleanup *cleanup_tuple = NULL;
254 struct ui_out *uiout = current_uiout;
257 stb = mem_fileopen ();
258 old_chain = make_cleanup_ui_file_delete (stb);
260 gdb_assert (!arg->val || !arg->error);
261 gdb_assert ((values == PRINT_NO_VALUES && arg->val == NULL
262 && arg->error == NULL)
263 || values == PRINT_SIMPLE_VALUES
264 || (values == PRINT_ALL_VALUES
265 && (arg->val != NULL || arg->error != NULL)));
266 gdb_assert (arg->entry_kind == print_entry_values_no
267 || (arg->entry_kind == print_entry_values_only
268 && (arg->val || arg->error)));
270 if (values != PRINT_NO_VALUES || what == all)
271 cleanup_tuple = make_cleanup_ui_out_tuple_begin_end (uiout, NULL);
273 fputs_filtered (SYMBOL_PRINT_NAME (arg->sym), stb);
274 if (arg->entry_kind == print_entry_values_only)
275 fputs_filtered ("@entry", stb);
276 ui_out_field_stream (uiout, "name", stb);
278 if (what == all && SYMBOL_IS_ARGUMENT (arg->sym))
279 ui_out_field_int (uiout, "arg", 1);
281 if (values == PRINT_SIMPLE_VALUES)
283 check_typedef (arg->sym->type);
284 type_print (arg->sym->type, "", stb, -1);
285 ui_out_field_stream (uiout, "type", stb);
288 if (arg->val || arg->error)
290 volatile struct gdb_exception except;
293 except.message = arg->error;
296 /* TRY_CATCH has two statements, wrap it in a block. */
298 TRY_CATCH (except, RETURN_MASK_ERROR)
300 struct value_print_options opts;
302 get_raw_print_options (&opts);
304 common_val_print (arg->val, stb, 0, &opts,
305 language_def (SYMBOL_LANGUAGE (arg->sym)));
309 fprintf_filtered (stb, _("<error reading variable: %s>"),
311 ui_out_field_stream (uiout, "value", stb);
314 if (values != PRINT_NO_VALUES || what == all)
315 do_cleanups (cleanup_tuple);
316 do_cleanups (old_chain);
319 /* Print a list of the locals or the arguments for the currently
320 selected frame. If the argument passed is 0, printonly the names
321 of the variables, if an argument of 1 is passed, print the values
325 list_args_or_locals (enum what_to_list what, enum print_values values,
326 struct frame_info *fi)
330 struct block_iterator iter;
331 struct cleanup *cleanup_list;
333 char *name_of_result;
334 struct ui_out *uiout = current_uiout;
336 block = get_frame_block (fi, 0);
341 name_of_result = "locals";
344 name_of_result = "args";
347 name_of_result = "variables";
350 internal_error (__FILE__, __LINE__,
351 "unexpected what_to_list: %d", (int) what);
354 cleanup_list = make_cleanup_ui_out_list_begin_end (uiout, name_of_result);
358 ALL_BLOCK_SYMBOLS (block, iter, sym)
362 switch (SYMBOL_CLASS (sym))
365 case LOC_UNDEF: /* catches errors */
366 case LOC_CONST: /* constant */
367 case LOC_TYPEDEF: /* local typedef */
368 case LOC_LABEL: /* local label */
369 case LOC_BLOCK: /* local function */
370 case LOC_CONST_BYTES: /* loc. byte seq. */
371 case LOC_UNRESOLVED: /* unresolved static */
372 case LOC_OPTIMIZED_OUT: /* optimized out */
376 case LOC_ARG: /* argument */
377 case LOC_REF_ARG: /* reference arg */
378 case LOC_REGPARM_ADDR: /* indirect register arg */
379 case LOC_LOCAL: /* stack local */
380 case LOC_STATIC: /* static */
381 case LOC_REGISTER: /* register */
382 case LOC_COMPUTED: /* computed location */
385 else if (what == locals)
386 print_me = !SYMBOL_IS_ARGUMENT (sym);
388 print_me = SYMBOL_IS_ARGUMENT (sym);
394 struct frame_arg arg, entryarg;
396 if (SYMBOL_IS_ARGUMENT (sym))
397 sym2 = lookup_symbol (SYMBOL_LINKAGE_NAME (sym),
402 gdb_assert (sym2 != NULL);
404 memset (&arg, 0, sizeof (arg));
406 arg.entry_kind = print_entry_values_no;
407 memset (&entryarg, 0, sizeof (entryarg));
409 entryarg.entry_kind = print_entry_values_no;
413 case PRINT_SIMPLE_VALUES:
414 type = check_typedef (sym2->type);
415 if (TYPE_CODE (type) != TYPE_CODE_ARRAY
416 && TYPE_CODE (type) != TYPE_CODE_STRUCT
417 && TYPE_CODE (type) != TYPE_CODE_UNION)
419 case PRINT_ALL_VALUES:
420 if (SYMBOL_IS_ARGUMENT (sym))
421 read_frame_arg (sym2, fi, &arg, &entryarg);
423 read_frame_local (sym2, fi, &arg);
428 if (arg.entry_kind != print_entry_values_only)
429 list_arg_or_local (&arg, what, values);
430 if (entryarg.entry_kind != print_entry_values_no)
431 list_arg_or_local (&entryarg, what, values);
433 xfree (entryarg.error);
437 if (BLOCK_FUNCTION (block))
440 block = BLOCK_SUPERBLOCK (block);
442 do_cleanups (cleanup_list);
446 mi_cmd_stack_select_frame (char *command, char **argv, int argc)
448 if (argc == 0 || argc > 1)
449 error (_("-stack-select-frame: Usage: FRAME_SPEC"));
451 select_frame_command (argv[0], 1 /* not used */ );
455 mi_cmd_stack_info_frame (char *command, char **argv, int argc)
458 error (_("-stack-info-frame: No arguments allowed"));
460 print_frame_info (get_selected_frame (NULL), 1, LOC_AND_ADDRESS, 0);