1 /* Print values for GNU debugger GDB.
3 Copyright (C) 1986-2012 Free Software Foundation, Inc.
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/>. */
21 #include "gdb_string.h"
27 #include "expression.h"
31 #include "breakpoint.h"
33 #include "gdb-demangle.h"
36 #include "symfile.h" /* for overlay functions */
37 #include "objfiles.h" /* ditto */
38 #include "completer.h" /* for completion functions */
40 #include "gdb_assert.h"
45 #include "exceptions.h"
48 #include "parser-defs.h"
50 #include "arch-utils.h"
51 #include "cli/cli-utils.h"
54 #include "tui/tui.h" /* For tui_active et al. */
57 #if defined(__MINGW32__) && !defined(PRINTF_HAS_LONG_LONG)
58 # define USE_PRINTF_I64 1
59 # define PRINTF_HAS_LONG_LONG
61 # define USE_PRINTF_I64 0
70 /* True if the value should be printed raw -- that is, bypassing
71 python-based formatters. */
75 /* Last specified output format. */
77 static char last_format = 0;
79 /* Last specified examination size. 'b', 'h', 'w' or `q'. */
81 static char last_size = 'w';
83 /* Default address to examine next, and associated architecture. */
85 static struct gdbarch *next_gdbarch;
86 static CORE_ADDR next_address;
88 /* Number of delay instructions following current disassembled insn. */
90 static int branch_delay_insns;
92 /* Last address examined. */
94 static CORE_ADDR last_examine_address;
96 /* Contents of last address examined.
97 This is not valid past the end of the `x' command! */
99 static struct value *last_examine_value;
101 /* Largest offset between a symbolic value and an address, that will be
102 printed as `0x1234 <symbol+offset>'. */
104 static unsigned int max_symbolic_offset = UINT_MAX;
106 show_max_symbolic_offset (struct ui_file *file, int from_tty,
107 struct cmd_list_element *c, const char *value)
109 fprintf_filtered (file,
110 _("The largest offset that will be "
111 "printed in <symbol+1234> form is %s.\n"),
115 /* Append the source filename and linenumber of the symbol when
116 printing a symbolic value as `<symbol at filename:linenum>' if set. */
117 static int print_symbol_filename = 0;
119 show_print_symbol_filename (struct ui_file *file, int from_tty,
120 struct cmd_list_element *c, const char *value)
122 fprintf_filtered (file, _("Printing of source filename and "
123 "line number with <symbol> is %s.\n"),
127 /* Number of auto-display expression currently being displayed.
128 So that we can disable it if we get a signal within it.
129 -1 when not doing one. */
131 int current_display_number;
135 /* Chain link to next auto-display item. */
136 struct display *next;
138 /* The expression as the user typed it. */
141 /* Expression to be evaluated and displayed. */
142 struct expression *exp;
144 /* Item number of this auto-display item. */
147 /* Display format specified. */
148 struct format_data format;
150 /* Program space associated with `block'. */
151 struct program_space *pspace;
153 /* Innermost block required by this expression when evaluated. */
156 /* Status of this display (enabled or disabled). */
160 /* Chain of expressions whose values should be displayed
161 automatically each time the program stops. */
163 static struct display *display_chain;
165 static int display_number;
167 /* Walk the following statement or block through all displays.
168 ALL_DISPLAYS_SAFE does so even if the statement deletes the current
171 #define ALL_DISPLAYS(B) \
172 for (B = display_chain; B; B = B->next)
174 #define ALL_DISPLAYS_SAFE(B,TMP) \
175 for (B = display_chain; \
176 B ? (TMP = B->next, 1): 0; \
179 /* Prototypes for exported functions. */
181 void output_command (char *, int);
183 void _initialize_printcmd (void);
185 /* Prototypes for local functions. */
187 static void do_one_display (struct display *);
190 /* Decode a format specification. *STRING_PTR should point to it.
191 OFORMAT and OSIZE are used as defaults for the format and size
192 if none are given in the format specification.
193 If OSIZE is zero, then the size field of the returned value
194 should be set only if a size is explicitly specified by the
196 The structure returned describes all the data
197 found in the specification. In addition, *STRING_PTR is advanced
198 past the specification and past all whitespace following it. */
200 static struct format_data
201 decode_format (char **string_ptr, int oformat, int osize)
203 struct format_data val;
204 char *p = *string_ptr;
211 if (*p >= '0' && *p <= '9')
212 val.count = atoi (p);
213 while (*p >= '0' && *p <= '9')
216 /* Now process size or format letters that follow. */
220 if (*p == 'b' || *p == 'h' || *p == 'w' || *p == 'g')
227 else if (*p >= 'a' && *p <= 'z')
233 while (*p == ' ' || *p == '\t')
237 /* Set defaults for format and size if not specified. */
238 if (val.format == '?')
242 /* Neither has been specified. */
243 val.format = oformat;
247 /* If a size is specified, any format makes a reasonable
248 default except 'i'. */
249 val.format = oformat == 'i' ? 'x' : oformat;
251 else if (val.size == '?')
255 /* Pick the appropriate size for an address. This is deferred
256 until do_examine when we know the actual architecture to use.
257 A special size value of 'a' is used to indicate this case. */
258 val.size = osize ? 'a' : osize;
261 /* Floating point has to be word or giantword. */
262 if (osize == 'w' || osize == 'g')
265 /* Default it to giantword if the last used size is not
267 val.size = osize ? 'g' : osize;
270 /* Characters default to one byte. */
271 val.size = osize ? 'b' : osize;
274 /* Display strings with byte size chars unless explicitly
280 /* The default is the size most recently specified. */
287 /* Print value VAL on stream according to OPTIONS.
288 Do not end with a newline.
289 SIZE is the letter for the size of datum being printed.
290 This is used to pad hex numbers so they line up. SIZE is 0
291 for print / output and set for examine. */
294 print_formatted (struct value *val, int size,
295 const struct value_print_options *options,
296 struct ui_file *stream)
298 struct type *type = check_typedef (value_type (val));
299 int len = TYPE_LENGTH (type);
301 if (VALUE_LVAL (val) == lval_memory)
302 next_address = value_address (val) + len;
306 switch (options->format)
310 struct type *elttype = value_type (val);
312 next_address = (value_address (val)
313 + val_print_string (elttype, NULL,
314 value_address (val), -1,
315 stream, options) * len);
320 /* We often wrap here if there are long symbolic names. */
322 next_address = (value_address (val)
323 + gdb_print_insn (get_type_arch (type),
324 value_address (val), stream,
325 &branch_delay_insns));
330 if (options->format == 0 || options->format == 's'
331 || TYPE_CODE (type) == TYPE_CODE_REF
332 || TYPE_CODE (type) == TYPE_CODE_ARRAY
333 || TYPE_CODE (type) == TYPE_CODE_STRING
334 || TYPE_CODE (type) == TYPE_CODE_STRUCT
335 || TYPE_CODE (type) == TYPE_CODE_UNION
336 || TYPE_CODE (type) == TYPE_CODE_NAMESPACE)
337 value_print (val, stream, options);
339 /* User specified format, so don't look to the type to tell us
341 val_print_scalar_formatted (type,
342 value_contents_for_printing (val),
343 value_embedded_offset (val),
345 options, size, stream);
348 /* Return builtin floating point type of same length as TYPE.
349 If no such type is found, return TYPE itself. */
351 float_type_from_length (struct type *type)
353 struct gdbarch *gdbarch = get_type_arch (type);
354 const struct builtin_type *builtin = builtin_type (gdbarch);
355 unsigned int len = TYPE_LENGTH (type);
357 if (len == TYPE_LENGTH (builtin->builtin_float))
358 type = builtin->builtin_float;
359 else if (len == TYPE_LENGTH (builtin->builtin_double))
360 type = builtin->builtin_double;
361 else if (len == TYPE_LENGTH (builtin->builtin_long_double))
362 type = builtin->builtin_long_double;
367 /* Print a scalar of data of type TYPE, pointed to in GDB by VALADDR,
368 according to OPTIONS and SIZE on STREAM. Formats s and i are not
369 supported at this level. */
372 print_scalar_formatted (const void *valaddr, struct type *type,
373 const struct value_print_options *options,
374 int size, struct ui_file *stream)
376 struct gdbarch *gdbarch = get_type_arch (type);
377 LONGEST val_long = 0;
378 unsigned int len = TYPE_LENGTH (type);
379 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
381 /* String printing should go through val_print_scalar_formatted. */
382 gdb_assert (options->format != 's');
384 if (len > sizeof(LONGEST) &&
385 (TYPE_CODE (type) == TYPE_CODE_INT
386 || TYPE_CODE (type) == TYPE_CODE_ENUM))
388 switch (options->format)
391 print_octal_chars (stream, valaddr, len, byte_order);
395 print_decimal_chars (stream, valaddr, len, byte_order);
398 print_binary_chars (stream, valaddr, len, byte_order);
401 print_hex_chars (stream, valaddr, len, byte_order);
404 print_char_chars (stream, type, valaddr, len, byte_order);
411 if (options->format != 'f')
412 val_long = unpack_long (type, valaddr);
414 /* If the value is a pointer, and pointers and addresses are not the
415 same, then at this point, the value's length (in target bytes) is
416 gdbarch_addr_bit/TARGET_CHAR_BIT, not TYPE_LENGTH (type). */
417 if (TYPE_CODE (type) == TYPE_CODE_PTR)
418 len = gdbarch_addr_bit (gdbarch) / TARGET_CHAR_BIT;
420 /* If we are printing it as unsigned, truncate it in case it is actually
421 a negative signed value (e.g. "print/u (short)-1" should print 65535
422 (if shorts are 16 bits) instead of 4294967295). */
423 if (options->format != 'd' || TYPE_UNSIGNED (type))
425 if (len < sizeof (LONGEST))
426 val_long &= ((LONGEST) 1 << HOST_CHAR_BIT * len) - 1;
429 switch (options->format)
434 /* No size specified, like in print. Print varying # of digits. */
435 print_longest (stream, 'x', 1, val_long);
444 print_longest (stream, size, 1, val_long);
447 error (_("Undefined output size \"%c\"."), size);
452 print_longest (stream, 'd', 1, val_long);
456 print_longest (stream, 'u', 0, val_long);
461 print_longest (stream, 'o', 1, val_long);
463 fprintf_filtered (stream, "0");
468 CORE_ADDR addr = unpack_pointer (type, valaddr);
470 print_address (gdbarch, addr, stream);
476 struct value_print_options opts = *options;
479 if (TYPE_UNSIGNED (type))
480 type = builtin_type (gdbarch)->builtin_true_unsigned_char;
482 type = builtin_type (gdbarch)->builtin_true_char;
484 value_print (value_from_longest (type, val_long), stream, &opts);
489 type = float_type_from_length (type);
490 print_floating (valaddr, type, stream);
494 internal_error (__FILE__, __LINE__,
495 _("failed internal consistency check"));
498 /* Binary; 't' stands for "two". */
500 char bits[8 * (sizeof val_long) + 1];
501 char buf[8 * (sizeof val_long) + 32];
506 width = 8 * (sizeof val_long);
523 error (_("Undefined output size \"%c\"."), size);
529 bits[width] = (val_long & 1) ? '1' : '0';
534 while (*cp && *cp == '0')
539 strncpy (buf, cp, sizeof (bits));
540 fputs_filtered (buf, stream);
545 error (_("Undefined output format \"%c\"."), options->format);
549 /* Specify default address for `x' command.
550 The `info lines' command uses this. */
553 set_next_address (struct gdbarch *gdbarch, CORE_ADDR addr)
555 struct type *ptr_type = builtin_type (gdbarch)->builtin_data_ptr;
557 next_gdbarch = gdbarch;
560 /* Make address available to the user as $_. */
561 set_internalvar (lookup_internalvar ("_"),
562 value_from_pointer (ptr_type, addr));
565 /* Optionally print address ADDR symbolically as <SYMBOL+OFFSET> on STREAM,
566 after LEADIN. Print nothing if no symbolic name is found nearby.
567 Optionally also print source file and line number, if available.
568 DO_DEMANGLE controls whether to print a symbol in its native "raw" form,
569 or to interpret it as a possible C++ name and convert it back to source
570 form. However note that DO_DEMANGLE can be overridden by the specific
571 settings of the demangle and asm_demangle variables. */
574 print_address_symbolic (struct gdbarch *gdbarch, CORE_ADDR addr,
575 struct ui_file *stream,
576 int do_demangle, char *leadin)
579 char *filename = NULL;
584 /* Throw away both name and filename. */
585 struct cleanup *cleanup_chain = make_cleanup (free_current_contents, &name);
586 make_cleanup (free_current_contents, &filename);
588 if (build_address_symbolic (gdbarch, addr, do_demangle, &name, &offset,
589 &filename, &line, &unmapped))
591 do_cleanups (cleanup_chain);
595 fputs_filtered (leadin, stream);
597 fputs_filtered ("<*", stream);
599 fputs_filtered ("<", stream);
600 fputs_filtered (name, stream);
602 fprintf_filtered (stream, "+%u", (unsigned int) offset);
604 /* Append source filename and line number if desired. Give specific
605 line # of this addr, if we have it; else line # of the nearest symbol. */
606 if (print_symbol_filename && filename != NULL)
609 fprintf_filtered (stream, " at %s:%d", filename, line);
611 fprintf_filtered (stream, " in %s", filename);
614 fputs_filtered ("*>", stream);
616 fputs_filtered (">", stream);
618 do_cleanups (cleanup_chain);
621 /* Given an address ADDR return all the elements needed to print the
622 address in a symbolic form. NAME can be mangled or not depending
623 on DO_DEMANGLE (and also on the asm_demangle global variable,
624 manipulated via ''set print asm-demangle''). Return 0 in case of
625 success, when all the info in the OUT paramters is valid. Return 1
628 build_address_symbolic (struct gdbarch *gdbarch,
629 CORE_ADDR addr, /* IN */
630 int do_demangle, /* IN */
631 char **name, /* OUT */
632 int *offset, /* OUT */
633 char **filename, /* OUT */
635 int *unmapped) /* OUT */
637 struct minimal_symbol *msymbol;
638 struct symbol *symbol;
639 CORE_ADDR name_location = 0;
640 struct obj_section *section = NULL;
641 const char *name_temp = "";
643 /* Let's say it is mapped (not unmapped). */
646 /* Determine if the address is in an overlay, and whether it is
648 if (overlay_debugging)
650 section = find_pc_overlay (addr);
651 if (pc_in_unmapped_range (addr, section))
654 addr = overlay_mapped_address (addr, section);
658 /* First try to find the address in the symbol table, then
659 in the minsyms. Take the closest one. */
661 /* This is defective in the sense that it only finds text symbols. So
662 really this is kind of pointless--we should make sure that the
663 minimal symbols have everything we need (by changing that we could
664 save some memory, but for many debug format--ELF/DWARF or
665 anything/stabs--it would be inconvenient to eliminate those minimal
667 msymbol = lookup_minimal_symbol_by_pc_section (addr, section);
668 symbol = find_pc_sect_function (addr, section);
672 /* If this is a function (i.e. a code address), strip out any
673 non-address bits. For instance, display a pointer to the
674 first instruction of a Thumb function as <function>; the
675 second instruction will be <function+2>, even though the
676 pointer is <function+3>. This matches the ISA behavior. */
677 addr = gdbarch_addr_bits_remove (gdbarch, addr);
679 name_location = BLOCK_START (SYMBOL_BLOCK_VALUE (symbol));
680 if (do_demangle || asm_demangle)
681 name_temp = SYMBOL_PRINT_NAME (symbol);
683 name_temp = SYMBOL_LINKAGE_NAME (symbol);
688 if (SYMBOL_VALUE_ADDRESS (msymbol) > name_location || symbol == NULL)
690 /* The msymbol is closer to the address than the symbol;
691 use the msymbol instead. */
693 name_location = SYMBOL_VALUE_ADDRESS (msymbol);
694 if (do_demangle || asm_demangle)
695 name_temp = SYMBOL_PRINT_NAME (msymbol);
697 name_temp = SYMBOL_LINKAGE_NAME (msymbol);
700 if (symbol == NULL && msymbol == NULL)
703 /* If the nearest symbol is too far away, don't print anything symbolic. */
705 /* For when CORE_ADDR is larger than unsigned int, we do math in
706 CORE_ADDR. But when we detect unsigned wraparound in the
707 CORE_ADDR math, we ignore this test and print the offset,
708 because addr+max_symbolic_offset has wrapped through the end
709 of the address space back to the beginning, giving bogus comparison. */
710 if (addr > name_location + max_symbolic_offset
711 && name_location + max_symbolic_offset > name_location)
714 *offset = addr - name_location;
716 *name = xstrdup (name_temp);
718 if (print_symbol_filename)
720 struct symtab_and_line sal;
722 sal = find_pc_sect_line (addr, section, 0);
726 *filename = xstrdup (sal.symtab->filename);
734 /* Print address ADDR symbolically on STREAM.
735 First print it as a number. Then perhaps print
736 <SYMBOL + OFFSET> after the number. */
739 print_address (struct gdbarch *gdbarch,
740 CORE_ADDR addr, struct ui_file *stream)
742 fputs_filtered (paddress (gdbarch, addr), stream);
743 print_address_symbolic (gdbarch, addr, stream, asm_demangle, " ");
746 /* Return a prefix for instruction address:
747 "=> " for current instruction, else " ". */
750 pc_prefix (CORE_ADDR addr)
752 if (has_stack_frames ())
754 struct frame_info *frame;
757 frame = get_selected_frame (NULL);
758 if (get_frame_pc_if_available (frame, &pc) && pc == addr)
764 /* Print address ADDR symbolically on STREAM. Parameter DEMANGLE
765 controls whether to print the symbolic name "raw" or demangled.
766 Global setting "addressprint" controls whether to print hex address
770 print_address_demangle (const struct value_print_options *opts,
771 struct gdbarch *gdbarch, CORE_ADDR addr,
772 struct ui_file *stream, int do_demangle)
774 if (opts->addressprint)
776 fputs_filtered (paddress (gdbarch, addr), stream);
777 print_address_symbolic (gdbarch, addr, stream, do_demangle, " ");
781 print_address_symbolic (gdbarch, addr, stream, do_demangle, "");
786 /* Examine data at address ADDR in format FMT.
787 Fetch it from memory and print on gdb_stdout. */
790 do_examine (struct format_data fmt, struct gdbarch *gdbarch, CORE_ADDR addr)
795 struct type *val_type = NULL;
798 struct value_print_options opts;
803 next_gdbarch = gdbarch;
806 /* Instruction format implies fetch single bytes
807 regardless of the specified size.
808 The case of strings is handled in decode_format, only explicit
809 size operator are not changed to 'b'. */
815 /* Pick the appropriate size for an address. */
816 if (gdbarch_ptr_bit (next_gdbarch) == 64)
818 else if (gdbarch_ptr_bit (next_gdbarch) == 32)
820 else if (gdbarch_ptr_bit (next_gdbarch) == 16)
823 /* Bad value for gdbarch_ptr_bit. */
824 internal_error (__FILE__, __LINE__,
825 _("failed internal consistency check"));
829 val_type = builtin_type (next_gdbarch)->builtin_int8;
830 else if (size == 'h')
831 val_type = builtin_type (next_gdbarch)->builtin_int16;
832 else if (size == 'w')
833 val_type = builtin_type (next_gdbarch)->builtin_int32;
834 else if (size == 'g')
835 val_type = builtin_type (next_gdbarch)->builtin_int64;
839 struct type *char_type = NULL;
841 /* Search for "char16_t" or "char32_t" types or fall back to 8-bit char
842 if type is not found. */
844 char_type = builtin_type (next_gdbarch)->builtin_char16;
845 else if (size == 'w')
846 char_type = builtin_type (next_gdbarch)->builtin_char32;
848 val_type = char_type;
851 if (size != '\0' && size != 'b')
852 warning (_("Unable to display strings with "
853 "size '%c', using 'b' instead."), size);
855 val_type = builtin_type (next_gdbarch)->builtin_int8;
864 if (format == 's' || format == 'i')
867 get_formatted_print_options (&opts, format);
869 /* Print as many objects as specified in COUNT, at most maxelts per line,
870 with the address of the next one at the start of each line. */
876 fputs_filtered (pc_prefix (next_address), gdb_stdout);
877 print_address (next_gdbarch, next_address, gdb_stdout);
878 printf_filtered (":");
883 printf_filtered ("\t");
884 /* Note that print_formatted sets next_address for the next
886 last_examine_address = next_address;
888 if (last_examine_value)
889 value_free (last_examine_value);
891 /* The value to be displayed is not fetched greedily.
892 Instead, to avoid the possibility of a fetched value not
893 being used, its retrieval is delayed until the print code
894 uses it. When examining an instruction stream, the
895 disassembler will perform its own memory fetch using just
896 the address stored in LAST_EXAMINE_VALUE. FIXME: Should
897 the disassembler be modified so that LAST_EXAMINE_VALUE
898 is left with the byte sequence from the last complete
899 instruction fetched from memory? */
900 last_examine_value = value_at_lazy (val_type, next_address);
902 if (last_examine_value)
903 release_value (last_examine_value);
905 print_formatted (last_examine_value, size, &opts, gdb_stdout);
907 /* Display any branch delay slots following the final insn. */
908 if (format == 'i' && count == 1)
909 count += branch_delay_insns;
911 printf_filtered ("\n");
912 gdb_flush (gdb_stdout);
917 validate_format (struct format_data fmt, char *cmdname)
920 error (_("Size letters are meaningless in \"%s\" command."), cmdname);
922 error (_("Item count other than 1 is meaningless in \"%s\" command."),
924 if (fmt.format == 'i')
925 error (_("Format letter \"%c\" is meaningless in \"%s\" command."),
926 fmt.format, cmdname);
929 /* Evaluate string EXP as an expression in the current language and
930 print the resulting value. EXP may contain a format specifier as the
931 first argument ("/x myvar" for example, to print myvar in hex). */
934 print_command_1 (char *exp, int inspect, int voidprint)
936 struct expression *expr;
937 struct cleanup *old_chain = 0;
940 struct format_data fmt;
943 if (exp && *exp == '/')
946 fmt = decode_format (&exp, last_format, 0);
947 validate_format (fmt, "print");
948 last_format = format = fmt.format;
960 expr = parse_expression (exp);
961 old_chain = make_cleanup (free_current_contents, &expr);
963 val = evaluate_expression (expr);
966 val = access_value_history (0);
968 if (voidprint || (val && value_type (val) &&
969 TYPE_CODE (value_type (val)) != TYPE_CODE_VOID))
971 struct value_print_options opts;
972 int histindex = record_latest_value (val);
975 annotate_value_history_begin (histindex, value_type (val));
977 annotate_value_begin (value_type (val));
980 printf_unfiltered ("\031(gdb-makebuffer \"%s\" %d '(\"",
982 else if (histindex >= 0)
983 printf_filtered ("$%d = ", histindex);
986 annotate_value_history_value ();
988 get_formatted_print_options (&opts, format);
989 opts.inspect_it = inspect;
992 print_formatted (val, fmt.size, &opts, gdb_stdout);
993 printf_filtered ("\n");
996 annotate_value_history_end ();
998 annotate_value_end ();
1001 printf_unfiltered ("\") )\030");
1005 do_cleanups (old_chain);
1009 print_command (char *exp, int from_tty)
1011 print_command_1 (exp, 0, 1);
1014 /* Same as print, except in epoch, it gets its own window. */
1016 inspect_command (char *exp, int from_tty)
1018 extern int epoch_interface;
1020 print_command_1 (exp, epoch_interface, 1);
1023 /* Same as print, except it doesn't print void results. */
1025 call_command (char *exp, int from_tty)
1027 print_command_1 (exp, 0, 0);
1031 output_command (char *exp, int from_tty)
1033 struct expression *expr;
1034 struct cleanup *old_chain;
1037 struct format_data fmt;
1038 struct value_print_options opts;
1043 if (exp && *exp == '/')
1046 fmt = decode_format (&exp, 0, 0);
1047 validate_format (fmt, "output");
1048 format = fmt.format;
1051 expr = parse_expression (exp);
1052 old_chain = make_cleanup (free_current_contents, &expr);
1054 val = evaluate_expression (expr);
1056 annotate_value_begin (value_type (val));
1058 get_formatted_print_options (&opts, format);
1060 print_formatted (val, fmt.size, &opts, gdb_stdout);
1062 annotate_value_end ();
1065 gdb_flush (gdb_stdout);
1067 do_cleanups (old_chain);
1071 set_command (char *exp, int from_tty)
1073 struct expression *expr = parse_expression (exp);
1074 struct cleanup *old_chain =
1075 make_cleanup (free_current_contents, &expr);
1077 if (expr->nelts >= 1)
1078 switch (expr->elts[0].opcode)
1080 case UNOP_PREINCREMENT:
1081 case UNOP_POSTINCREMENT:
1082 case UNOP_PREDECREMENT:
1083 case UNOP_POSTDECREMENT:
1085 case BINOP_ASSIGN_MODIFY:
1090 (_("Expression is not an assignment (and might have no effect)"));
1093 evaluate_expression (expr);
1094 do_cleanups (old_chain);
1098 sym_info (char *arg, int from_tty)
1100 struct minimal_symbol *msymbol;
1101 struct objfile *objfile;
1102 struct obj_section *osect;
1103 CORE_ADDR addr, sect_addr;
1105 unsigned int offset;
1108 error_no_arg (_("address"));
1110 addr = parse_and_eval_address (arg);
1111 ALL_OBJSECTIONS (objfile, osect)
1113 /* Only process each object file once, even if there's a separate
1115 if (objfile->separate_debug_objfile_backlink)
1118 sect_addr = overlay_mapped_address (addr, osect);
1120 if (obj_section_addr (osect) <= sect_addr
1121 && sect_addr < obj_section_endaddr (osect)
1122 && (msymbol = lookup_minimal_symbol_by_pc_section (sect_addr, osect)))
1124 const char *obj_name, *mapped, *sec_name, *msym_name;
1126 struct cleanup *old_chain;
1129 offset = sect_addr - SYMBOL_VALUE_ADDRESS (msymbol);
1130 mapped = section_is_mapped (osect) ? _("mapped") : _("unmapped");
1131 sec_name = osect->the_bfd_section->name;
1132 msym_name = SYMBOL_PRINT_NAME (msymbol);
1134 /* Don't print the offset if it is zero.
1135 We assume there's no need to handle i18n of "sym + offset". */
1137 loc_string = xstrprintf ("%s + %u", msym_name, offset);
1139 loc_string = xstrprintf ("%s", msym_name);
1141 /* Use a cleanup to free loc_string in case the user quits
1142 a pagination request inside printf_filtered. */
1143 old_chain = make_cleanup (xfree, loc_string);
1145 gdb_assert (osect->objfile && osect->objfile->name);
1146 obj_name = osect->objfile->name;
1148 if (MULTI_OBJFILE_P ())
1149 if (pc_in_unmapped_range (addr, osect))
1150 if (section_is_overlay (osect))
1151 printf_filtered (_("%s in load address range of "
1152 "%s overlay section %s of %s\n"),
1153 loc_string, mapped, sec_name, obj_name);
1155 printf_filtered (_("%s in load address range of "
1156 "section %s of %s\n"),
1157 loc_string, sec_name, obj_name);
1159 if (section_is_overlay (osect))
1160 printf_filtered (_("%s in %s overlay section %s of %s\n"),
1161 loc_string, mapped, sec_name, obj_name);
1163 printf_filtered (_("%s in section %s of %s\n"),
1164 loc_string, sec_name, obj_name);
1166 if (pc_in_unmapped_range (addr, osect))
1167 if (section_is_overlay (osect))
1168 printf_filtered (_("%s in load address range of %s overlay "
1170 loc_string, mapped, sec_name);
1172 printf_filtered (_("%s in load address range of section %s\n"),
1173 loc_string, sec_name);
1175 if (section_is_overlay (osect))
1176 printf_filtered (_("%s in %s overlay section %s\n"),
1177 loc_string, mapped, sec_name);
1179 printf_filtered (_("%s in section %s\n"),
1180 loc_string, sec_name);
1182 do_cleanups (old_chain);
1186 printf_filtered (_("No symbol matches %s.\n"), arg);
1190 address_info (char *exp, int from_tty)
1192 struct gdbarch *gdbarch;
1195 struct minimal_symbol *msymbol;
1197 struct obj_section *section;
1198 CORE_ADDR load_addr, context_pc = 0;
1199 int is_a_field_of_this; /* C++: lookup_symbol sets this to nonzero
1200 if exp is a field of `this'. */
1203 error (_("Argument required."));
1205 sym = lookup_symbol (exp, get_selected_block (&context_pc), VAR_DOMAIN,
1206 &is_a_field_of_this);
1209 if (is_a_field_of_this)
1211 printf_filtered ("Symbol \"");
1212 fprintf_symbol_filtered (gdb_stdout, exp,
1213 current_language->la_language, DMGL_ANSI);
1214 printf_filtered ("\" is a field of the local class variable ");
1215 if (current_language->la_language == language_objc)
1216 printf_filtered ("`self'\n"); /* ObjC equivalent of "this" */
1218 printf_filtered ("`this'\n");
1222 msymbol = lookup_minimal_symbol (exp, NULL, NULL);
1224 if (msymbol != NULL)
1226 gdbarch = get_objfile_arch (msymbol_objfile (msymbol));
1227 load_addr = SYMBOL_VALUE_ADDRESS (msymbol);
1229 printf_filtered ("Symbol \"");
1230 fprintf_symbol_filtered (gdb_stdout, exp,
1231 current_language->la_language, DMGL_ANSI);
1232 printf_filtered ("\" is at ");
1233 fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1234 printf_filtered (" in a file compiled without debugging");
1235 section = SYMBOL_OBJ_SECTION (msymbol);
1236 if (section_is_overlay (section))
1238 load_addr = overlay_unmapped_address (load_addr, section);
1239 printf_filtered (",\n -- loaded at ");
1240 fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1241 printf_filtered (" in overlay section %s",
1242 section->the_bfd_section->name);
1244 printf_filtered (".\n");
1247 error (_("No symbol \"%s\" in current context."), exp);
1251 printf_filtered ("Symbol \"");
1252 fprintf_symbol_filtered (gdb_stdout, SYMBOL_PRINT_NAME (sym),
1253 current_language->la_language, DMGL_ANSI);
1254 printf_filtered ("\" is ");
1255 val = SYMBOL_VALUE (sym);
1256 section = SYMBOL_OBJ_SECTION (sym);
1257 gdbarch = get_objfile_arch (SYMBOL_SYMTAB (sym)->objfile);
1259 switch (SYMBOL_CLASS (sym))
1262 case LOC_CONST_BYTES:
1263 printf_filtered ("constant");
1267 printf_filtered ("a label at address ");
1268 load_addr = SYMBOL_VALUE_ADDRESS (sym);
1269 fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1270 if (section_is_overlay (section))
1272 load_addr = overlay_unmapped_address (load_addr, section);
1273 printf_filtered (",\n -- loaded at ");
1274 fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1275 printf_filtered (" in overlay section %s",
1276 section->the_bfd_section->name);
1281 /* FIXME: cagney/2004-01-26: It should be possible to
1282 unconditionally call the SYMBOL_COMPUTED_OPS method when available.
1283 Unfortunately DWARF 2 stores the frame-base (instead of the
1284 function) location in a function's symbol. Oops! For the
1285 moment enable this when/where applicable. */
1286 SYMBOL_COMPUTED_OPS (sym)->describe_location (sym, context_pc,
1291 /* GDBARCH is the architecture associated with the objfile the symbol
1292 is defined in; the target architecture may be different, and may
1293 provide additional registers. However, we do not know the target
1294 architecture at this point. We assume the objfile architecture
1295 will contain all the standard registers that occur in debug info
1297 regno = SYMBOL_REGISTER_OPS (sym)->register_number (sym, gdbarch);
1299 if (SYMBOL_IS_ARGUMENT (sym))
1300 printf_filtered (_("an argument in register %s"),
1301 gdbarch_register_name (gdbarch, regno));
1303 printf_filtered (_("a variable in register %s"),
1304 gdbarch_register_name (gdbarch, regno));
1308 printf_filtered (_("static storage at address "));
1309 load_addr = SYMBOL_VALUE_ADDRESS (sym);
1310 fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1311 if (section_is_overlay (section))
1313 load_addr = overlay_unmapped_address (load_addr, section);
1314 printf_filtered (_(",\n -- loaded at "));
1315 fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1316 printf_filtered (_(" in overlay section %s"),
1317 section->the_bfd_section->name);
1321 case LOC_REGPARM_ADDR:
1322 /* Note comment at LOC_REGISTER. */
1323 regno = SYMBOL_REGISTER_OPS (sym)->register_number (sym, gdbarch);
1324 printf_filtered (_("address of an argument in register %s"),
1325 gdbarch_register_name (gdbarch, regno));
1329 printf_filtered (_("an argument at offset %ld"), val);
1333 printf_filtered (_("a local variable at frame offset %ld"), val);
1337 printf_filtered (_("a reference argument at offset %ld"), val);
1341 printf_filtered (_("a typedef"));
1345 printf_filtered (_("a function at address "));
1346 load_addr = BLOCK_START (SYMBOL_BLOCK_VALUE (sym));
1347 fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1348 if (section_is_overlay (section))
1350 load_addr = overlay_unmapped_address (load_addr, section);
1351 printf_filtered (_(",\n -- loaded at "));
1352 fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1353 printf_filtered (_(" in overlay section %s"),
1354 section->the_bfd_section->name);
1358 case LOC_UNRESOLVED:
1360 struct minimal_symbol *msym;
1362 msym = lookup_minimal_symbol (SYMBOL_LINKAGE_NAME (sym), NULL, NULL);
1364 printf_filtered ("unresolved");
1367 section = SYMBOL_OBJ_SECTION (msym);
1368 load_addr = SYMBOL_VALUE_ADDRESS (msym);
1371 && (section->the_bfd_section->flags & SEC_THREAD_LOCAL) != 0)
1372 printf_filtered (_("a thread-local variable at offset %s "
1373 "in the thread-local storage for `%s'"),
1374 paddress (gdbarch, load_addr),
1375 section->objfile->name);
1378 printf_filtered (_("static storage at address "));
1379 fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1380 if (section_is_overlay (section))
1382 load_addr = overlay_unmapped_address (load_addr, section);
1383 printf_filtered (_(",\n -- loaded at "));
1384 fputs_filtered (paddress (gdbarch, load_addr), gdb_stdout);
1385 printf_filtered (_(" in overlay section %s"),
1386 section->the_bfd_section->name);
1393 case LOC_OPTIMIZED_OUT:
1394 printf_filtered (_("optimized out"));
1398 printf_filtered (_("of unknown (botched) type"));
1401 printf_filtered (".\n");
1406 x_command (char *exp, int from_tty)
1408 struct expression *expr;
1409 struct format_data fmt;
1410 struct cleanup *old_chain;
1413 fmt.format = last_format ? last_format : 'x';
1414 fmt.size = last_size;
1418 if (exp && *exp == '/')
1421 fmt = decode_format (&exp, last_format, last_size);
1424 /* If we have an expression, evaluate it and use it as the address. */
1426 if (exp != 0 && *exp != 0)
1428 expr = parse_expression (exp);
1429 /* Cause expression not to be there any more if this command is
1430 repeated with Newline. But don't clobber a user-defined
1431 command's definition. */
1434 old_chain = make_cleanup (free_current_contents, &expr);
1435 val = evaluate_expression (expr);
1436 if (TYPE_CODE (value_type (val)) == TYPE_CODE_REF)
1437 val = coerce_ref (val);
1438 /* In rvalue contexts, such as this, functions are coerced into
1439 pointers to functions. This makes "x/i main" work. */
1440 if (/* last_format == 'i' && */
1441 TYPE_CODE (value_type (val)) == TYPE_CODE_FUNC
1442 && VALUE_LVAL (val) == lval_memory)
1443 next_address = value_address (val);
1445 next_address = value_as_address (val);
1447 next_gdbarch = expr->gdbarch;
1448 do_cleanups (old_chain);
1452 error_no_arg (_("starting display address"));
1454 do_examine (fmt, next_gdbarch, next_address);
1456 /* If the examine succeeds, we remember its size and format for next
1457 time. Set last_size to 'b' for strings. */
1458 if (fmt.format == 's')
1461 last_size = fmt.size;
1462 last_format = fmt.format;
1464 /* Set a couple of internal variables if appropriate. */
1465 if (last_examine_value)
1467 /* Make last address examined available to the user as $_. Use
1468 the correct pointer type. */
1469 struct type *pointer_type
1470 = lookup_pointer_type (value_type (last_examine_value));
1471 set_internalvar (lookup_internalvar ("_"),
1472 value_from_pointer (pointer_type,
1473 last_examine_address));
1475 /* Make contents of last address examined available to the user
1476 as $__. If the last value has not been fetched from memory
1477 then don't fetch it now; instead mark it by voiding the $__
1479 if (value_lazy (last_examine_value))
1480 clear_internalvar (lookup_internalvar ("__"));
1482 set_internalvar (lookup_internalvar ("__"), last_examine_value);
1487 /* Add an expression to the auto-display chain.
1488 Specify the expression. */
1491 display_command (char *exp, int from_tty)
1493 struct format_data fmt;
1494 struct expression *expr;
1495 struct display *new;
1499 /* NOTE: cagney/2003-02-13 The `tui_active' was previously
1501 if (tui_active && exp != NULL && *exp == '$')
1502 display_it = (tui_set_layout_for_display_command (exp) == TUI_FAILURE);
1516 fmt = decode_format (&exp, 0, 0);
1517 if (fmt.size && fmt.format == 0)
1519 if (fmt.format == 'i' || fmt.format == 's')
1530 innermost_block = NULL;
1531 expr = parse_expression (exp);
1533 new = (struct display *) xmalloc (sizeof (struct display));
1535 new->exp_string = xstrdup (exp);
1537 new->block = innermost_block;
1538 new->pspace = current_program_space;
1539 new->next = display_chain;
1540 new->number = ++display_number;
1543 display_chain = new;
1545 if (from_tty && target_has_execution)
1546 do_one_display (new);
1553 free_display (struct display *d)
1555 xfree (d->exp_string);
1560 /* Clear out the display_chain. Done when new symtabs are loaded,
1561 since this invalidates the types stored in many expressions. */
1564 clear_displays (void)
1568 while ((d = display_chain) != NULL)
1570 display_chain = d->next;
1575 /* Delete the auto-display DISPLAY. */
1578 delete_display (struct display *display)
1582 gdb_assert (display != NULL);
1584 if (display_chain == display)
1585 display_chain = display->next;
1588 if (d->next == display)
1590 d->next = display->next;
1594 free_display (display);
1597 /* Call FUNCTION on each of the displays whose numbers are given in
1598 ARGS. DATA is passed unmodified to FUNCTION. */
1601 map_display_numbers (char *args,
1602 void (*function) (struct display *,
1606 struct get_number_or_range_state state;
1607 struct display *b, *tmp;
1611 error_no_arg (_("one or more display numbers"));
1613 init_number_or_range (&state, args);
1615 while (!state.finished)
1617 char *p = state.string;
1619 num = get_number_or_range (&state);
1621 warning (_("bad display number at or near '%s'"), p);
1624 struct display *d, *tmp;
1626 ALL_DISPLAYS_SAFE (d, tmp)
1627 if (d->number == num)
1630 printf_unfiltered (_("No display number %d.\n"), num);
1637 /* Callback for map_display_numbers, that deletes a display. */
1640 do_delete_display (struct display *d, void *data)
1645 /* "undisplay" command. */
1648 undisplay_command (char *args, int from_tty)
1651 struct get_number_or_range_state state;
1655 if (query (_("Delete all auto-display expressions? ")))
1661 map_display_numbers (args, do_delete_display, NULL);
1665 /* Display a single auto-display.
1666 Do nothing if the display cannot be printed in the current context,
1667 or if the display is disabled. */
1670 do_one_display (struct display *d)
1672 struct cleanup *old_chain;
1673 int within_current_scope;
1675 if (d->enabled_p == 0)
1678 /* The expression carries the architecture that was used at parse time.
1679 This is a problem if the expression depends on architecture features
1680 (e.g. register numbers), and the current architecture is now different.
1681 For example, a display statement like "display/i $pc" is expected to
1682 display the PC register of the current architecture, not the arch at
1683 the time the display command was given. Therefore, we re-parse the
1684 expression if the current architecture has changed. */
1685 if (d->exp != NULL && d->exp->gdbarch != get_current_arch ())
1694 volatile struct gdb_exception ex;
1696 TRY_CATCH (ex, RETURN_MASK_ALL)
1698 innermost_block = NULL;
1699 d->exp = parse_expression (d->exp_string);
1700 d->block = innermost_block;
1704 /* Can't re-parse the expression. Disable this display item. */
1706 warning (_("Unable to display \"%s\": %s"),
1707 d->exp_string, ex.message);
1714 if (d->pspace == current_program_space)
1715 within_current_scope = contained_in (get_selected_block (0), d->block);
1717 within_current_scope = 0;
1720 within_current_scope = 1;
1721 if (!within_current_scope)
1724 old_chain = make_cleanup_restore_integer (¤t_display_number);
1725 current_display_number = d->number;
1727 annotate_display_begin ();
1728 printf_filtered ("%d", d->number);
1729 annotate_display_number_end ();
1730 printf_filtered (": ");
1733 volatile struct gdb_exception ex;
1735 annotate_display_format ();
1737 printf_filtered ("x/");
1738 if (d->format.count != 1)
1739 printf_filtered ("%d", d->format.count);
1740 printf_filtered ("%c", d->format.format);
1741 if (d->format.format != 'i' && d->format.format != 's')
1742 printf_filtered ("%c", d->format.size);
1743 printf_filtered (" ");
1745 annotate_display_expression ();
1747 puts_filtered (d->exp_string);
1748 annotate_display_expression_end ();
1750 if (d->format.count != 1 || d->format.format == 'i')
1751 printf_filtered ("\n");
1753 printf_filtered (" ");
1755 annotate_display_value ();
1757 TRY_CATCH (ex, RETURN_MASK_ERROR)
1762 val = evaluate_expression (d->exp);
1763 addr = value_as_address (val);
1764 if (d->format.format == 'i')
1765 addr = gdbarch_addr_bits_remove (d->exp->gdbarch, addr);
1766 do_examine (d->format, d->exp->gdbarch, addr);
1769 fprintf_filtered (gdb_stdout, _("<error: %s>\n"), ex.message);
1773 struct value_print_options opts;
1774 volatile struct gdb_exception ex;
1776 annotate_display_format ();
1778 if (d->format.format)
1779 printf_filtered ("/%c ", d->format.format);
1781 annotate_display_expression ();
1783 puts_filtered (d->exp_string);
1784 annotate_display_expression_end ();
1786 printf_filtered (" = ");
1788 annotate_display_expression ();
1790 get_formatted_print_options (&opts, d->format.format);
1791 opts.raw = d->format.raw;
1793 TRY_CATCH (ex, RETURN_MASK_ERROR)
1797 val = evaluate_expression (d->exp);
1798 print_formatted (val, d->format.size, &opts, gdb_stdout);
1801 fprintf_filtered (gdb_stdout, _("<error: %s>"), ex.message);
1802 printf_filtered ("\n");
1805 annotate_display_end ();
1807 gdb_flush (gdb_stdout);
1808 do_cleanups (old_chain);
1811 /* Display all of the values on the auto-display chain which can be
1812 evaluated in the current scope. */
1819 for (d = display_chain; d; d = d->next)
1823 /* Delete the auto-display which we were in the process of displaying.
1824 This is done when there is an error or a signal. */
1827 disable_display (int num)
1831 for (d = display_chain; d; d = d->next)
1832 if (d->number == num)
1837 printf_unfiltered (_("No display number %d.\n"), num);
1841 disable_current_display (void)
1843 if (current_display_number >= 0)
1845 disable_display (current_display_number);
1846 fprintf_unfiltered (gdb_stderr,
1847 _("Disabling display %d to "
1848 "avoid infinite recursion.\n"),
1849 current_display_number);
1851 current_display_number = -1;
1855 display_info (char *ignore, int from_tty)
1860 printf_unfiltered (_("There are no auto-display expressions now.\n"));
1862 printf_filtered (_("Auto-display expressions now in effect:\n\
1863 Num Enb Expression\n"));
1865 for (d = display_chain; d; d = d->next)
1867 printf_filtered ("%d: %c ", d->number, "ny"[(int) d->enabled_p]);
1869 printf_filtered ("/%d%c%c ", d->format.count, d->format.size,
1871 else if (d->format.format)
1872 printf_filtered ("/%c ", d->format.format);
1873 puts_filtered (d->exp_string);
1874 if (d->block && !contained_in (get_selected_block (0), d->block))
1875 printf_filtered (_(" (cannot be evaluated in the current context)"));
1876 printf_filtered ("\n");
1877 gdb_flush (gdb_stdout);
1881 /* Callback fo map_display_numbers, that enables or disables the
1882 passed in display D. */
1885 do_enable_disable_display (struct display *d, void *data)
1887 d->enabled_p = *(int *) data;
1890 /* Implamentation of both the "disable display" and "enable display"
1891 commands. ENABLE decides what to do. */
1894 enable_disable_display_command (char *args, int from_tty, int enable)
1901 d->enabled_p = enable;
1905 map_display_numbers (args, do_enable_disable_display, &enable);
1908 /* The "enable display" command. */
1911 enable_display_command (char *args, int from_tty)
1913 enable_disable_display_command (args, from_tty, 1);
1916 /* The "disable display" command. */
1919 disable_display_command (char *args, int from_tty)
1921 enable_disable_display_command (args, from_tty, 0);
1924 /* display_chain items point to blocks and expressions. Some expressions in
1925 turn may point to symbols.
1926 Both symbols and blocks are obstack_alloc'd on objfile_stack, and are
1927 obstack_free'd when a shared library is unloaded.
1928 Clear pointers that are about to become dangling.
1929 Both .exp and .block fields will be restored next time we need to display
1930 an item by re-parsing .exp_string field in the new execution context. */
1933 clear_dangling_display_expressions (struct so_list *solib)
1935 struct objfile *objfile = solib->objfile;
1938 /* With no symbol file we cannot have a block or expression from it. */
1939 if (objfile == NULL)
1941 if (objfile->separate_debug_objfile_backlink)
1942 objfile = objfile->separate_debug_objfile_backlink;
1943 gdb_assert (objfile->pspace == solib->pspace);
1945 for (d = display_chain; d != NULL; d = d->next)
1947 if (d->pspace != solib->pspace)
1950 if (lookup_objfile_from_block (d->block) == objfile
1951 || (d->exp && exp_uses_objfile (d->exp, objfile)))
1961 /* Print the value in stack frame FRAME of a variable specified by a
1962 struct symbol. NAME is the name to print; if NULL then VAR's print
1963 name will be used. STREAM is the ui_file on which to print the
1964 value. INDENT specifies the number of indent levels to print
1965 before printing the variable name. */
1968 print_variable_and_value (const char *name, struct symbol *var,
1969 struct frame_info *frame,
1970 struct ui_file *stream, int indent)
1972 volatile struct gdb_exception except;
1975 name = SYMBOL_PRINT_NAME (var);
1977 fprintf_filtered (stream, "%s%s = ", n_spaces (2 * indent), name);
1978 TRY_CATCH (except, RETURN_MASK_ERROR)
1981 struct value_print_options opts;
1983 val = read_var_value (var, frame);
1984 get_user_print_options (&opts);
1986 common_val_print (val, stream, indent, &opts, current_language);
1988 if (except.reason < 0)
1989 fprintf_filtered(stream, "<error reading variable %s (%s)>", name,
1991 fprintf_filtered (stream, "\n");
1994 /* printf "printf format string" ARG to STREAM. */
1997 ui_printf (char *arg, struct ui_file *stream)
2001 char *string = NULL;
2002 struct value **val_args;
2004 char *current_substring;
2006 int allocated_args = 20;
2007 struct cleanup *old_cleanups;
2009 val_args = xmalloc (allocated_args * sizeof (struct value *));
2010 old_cleanups = make_cleanup (free_current_contents, &val_args);
2013 error_no_arg (_("format-control string and values to print"));
2015 s = skip_spaces (s);
2017 /* A format string should follow, enveloped in double quotes. */
2019 error (_("Bad format string, missing '\"'."));
2021 /* Parse the format-control string and copy it into the string STRING,
2022 processing some kinds of escape sequence. */
2024 f = string = (char *) alloca (strlen (s) + 1);
2032 error (_("Bad format string, non-terminated '\"'."));
2065 /* ??? TODO: handle other escape sequences. */
2066 error (_("Unrecognized escape character \\%c in format string."),
2076 /* Skip over " and following space and comma. */
2079 s = skip_spaces (s);
2081 if (*s != ',' && *s != 0)
2082 error (_("Invalid argument syntax"));
2086 s = skip_spaces (s);
2088 /* Need extra space for the '\0's. Doubling the size is sufficient. */
2089 substrings = alloca (strlen (string) * 2);
2090 current_substring = substrings;
2093 /* Now scan the string for %-specs and see what kinds of args they want.
2094 argclass[I] classifies the %-specs so we can give printf_filtered
2095 something of the right size. */
2099 int_arg, long_arg, long_long_arg, ptr_arg,
2100 string_arg, wide_string_arg, wide_char_arg,
2101 double_arg, long_double_arg, decfloat_arg
2103 enum argclass *argclass;
2104 enum argclass this_argclass;
2109 argclass = (enum argclass *) alloca (strlen (s) * sizeof *argclass);
2116 int seen_hash = 0, seen_zero = 0, lcount = 0, seen_prec = 0;
2117 int seen_space = 0, seen_plus = 0;
2118 int seen_big_l = 0, seen_h = 0, seen_big_h = 0;
2119 int seen_big_d = 0, seen_double_big_d = 0;
2122 /* Check the validity of the format specifier, and work
2123 out what argument it expects. We only accept C89
2124 format strings, with the exception of long long (which
2125 we autoconf for). */
2127 /* Skip over "%%". */
2134 /* The first part of a format specifier is a set of flag
2136 while (strchr ("0-+ #", *f))
2149 /* The next part of a format specifier is a width. */
2150 while (strchr ("0123456789", *f))
2153 /* The next part of a format specifier is a precision. */
2158 while (strchr ("0123456789", *f))
2162 /* The next part of a format specifier is a length modifier. */
2183 /* Decimal32 modifier. */
2189 /* Decimal64 and Decimal128 modifiers. */
2194 /* Check for a Decimal128. */
2198 seen_double_big_d = 1;
2214 if (seen_space || seen_plus)
2221 this_argclass = int_arg;
2222 else if (lcount == 1)
2223 this_argclass = long_arg;
2225 this_argclass = long_long_arg;
2232 this_argclass = lcount == 0 ? int_arg : wide_char_arg;
2233 if (lcount > 1 || seen_h || seen_big_l)
2235 if (seen_prec || seen_zero || seen_space || seen_plus)
2240 this_argclass = ptr_arg;
2241 if (lcount || seen_h || seen_big_l)
2243 if (seen_prec || seen_zero || seen_space || seen_plus)
2248 this_argclass = lcount == 0 ? string_arg : wide_string_arg;
2249 if (lcount > 1 || seen_h || seen_big_l)
2251 if (seen_zero || seen_space || seen_plus)
2260 if (seen_big_h || seen_big_d || seen_double_big_d)
2261 this_argclass = decfloat_arg;
2262 else if (seen_big_l)
2263 this_argclass = long_double_arg;
2265 this_argclass = double_arg;
2267 if (lcount || seen_h)
2272 error (_("`*' not supported for precision or width in printf"));
2275 error (_("Format specifier `n' not supported in printf"));
2278 error (_("Incomplete format specifier at end of format string"));
2281 error (_("Unrecognized format specifier '%c' in printf"), *f);
2285 error (_("Inappropriate modifiers to "
2286 "format specifier '%c' in printf"),
2291 if (lcount > 1 && USE_PRINTF_I64)
2293 /* Windows' printf does support long long, but not the usual way.
2294 Convert %lld to %I64d. */
2295 int length_before_ll = f - last_arg - 1 - lcount;
2297 strncpy (current_substring, last_arg, length_before_ll);
2298 strcpy (current_substring + length_before_ll, "I64");
2299 current_substring[length_before_ll + 3] =
2300 last_arg[length_before_ll + lcount];
2301 current_substring += length_before_ll + 4;
2303 else if (this_argclass == wide_string_arg
2304 || this_argclass == wide_char_arg)
2306 /* Convert %ls or %lc to %s. */
2307 int length_before_ls = f - last_arg - 2;
2309 strncpy (current_substring, last_arg, length_before_ls);
2310 strcpy (current_substring + length_before_ls, "s");
2311 current_substring += length_before_ls + 2;
2315 strncpy (current_substring, last_arg, f - last_arg);
2316 current_substring += f - last_arg;
2318 *current_substring++ = '\0';
2320 argclass[nargs_wanted++] = this_argclass;
2323 /* Now, parse all arguments and evaluate them.
2324 Store the VALUEs in VAL_ARGS. */
2330 if (nargs == allocated_args)
2331 val_args = (struct value **) xrealloc ((char *) val_args,
2332 (allocated_args *= 2)
2333 * sizeof (struct value *));
2335 val_args[nargs] = parse_to_comma_and_eval (&s1);
2343 if (nargs != nargs_wanted)
2344 error (_("Wrong number of arguments for specified format-string"));
2346 /* Now actually print them. */
2347 current_substring = substrings;
2348 for (i = 0; i < nargs; i++)
2350 switch (argclass[i])
2358 tem = value_as_address (val_args[i]);
2360 /* This is a %s argument. Find the length of the string. */
2366 read_memory (tem + j, &c, 1);
2371 /* Copy the string contents into a string inside GDB. */
2372 str = (gdb_byte *) alloca (j + 1);
2374 read_memory (tem, str, j);
2377 fprintf_filtered (stream, current_substring, (char *) str);
2380 case wide_string_arg:
2385 struct gdbarch *gdbarch
2386 = get_type_arch (value_type (val_args[i]));
2387 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
2388 struct type *wctype = lookup_typename (current_language, gdbarch,
2389 "wchar_t", NULL, 0);
2390 int wcwidth = TYPE_LENGTH (wctype);
2391 gdb_byte *buf = alloca (wcwidth);
2392 struct obstack output;
2393 struct cleanup *inner_cleanup;
2395 tem = value_as_address (val_args[i]);
2397 /* This is a %s argument. Find the length of the string. */
2398 for (j = 0;; j += wcwidth)
2401 read_memory (tem + j, buf, wcwidth);
2402 if (extract_unsigned_integer (buf, wcwidth, byte_order) == 0)
2406 /* Copy the string contents into a string inside GDB. */
2407 str = (gdb_byte *) alloca (j + wcwidth);
2409 read_memory (tem, str, j);
2410 memset (&str[j], 0, wcwidth);
2412 obstack_init (&output);
2413 inner_cleanup = make_cleanup_obstack_free (&output);
2415 convert_between_encodings (target_wide_charset (gdbarch),
2418 &output, translit_char);
2419 obstack_grow_str0 (&output, "");
2421 fprintf_filtered (stream, current_substring,
2422 obstack_base (&output));
2423 do_cleanups (inner_cleanup);
2428 struct gdbarch *gdbarch
2429 = get_type_arch (value_type (val_args[i]));
2430 struct type *wctype = lookup_typename (current_language, gdbarch,
2431 "wchar_t", NULL, 0);
2432 struct type *valtype;
2433 struct obstack output;
2434 struct cleanup *inner_cleanup;
2435 const gdb_byte *bytes;
2437 valtype = value_type (val_args[i]);
2438 if (TYPE_LENGTH (valtype) != TYPE_LENGTH (wctype)
2439 || TYPE_CODE (valtype) != TYPE_CODE_INT)
2440 error (_("expected wchar_t argument for %%lc"));
2442 bytes = value_contents (val_args[i]);
2444 obstack_init (&output);
2445 inner_cleanup = make_cleanup_obstack_free (&output);
2447 convert_between_encodings (target_wide_charset (gdbarch),
2449 bytes, TYPE_LENGTH (valtype),
2450 TYPE_LENGTH (valtype),
2451 &output, translit_char);
2452 obstack_grow_str0 (&output, "");
2454 fprintf_filtered (stream, current_substring,
2455 obstack_base (&output));
2456 do_cleanups (inner_cleanup);
2461 struct type *type = value_type (val_args[i]);
2465 /* If format string wants a float, unchecked-convert the value
2466 to floating point of the same size. */
2467 type = float_type_from_length (type);
2468 val = unpack_double (type, value_contents (val_args[i]), &inv);
2470 error (_("Invalid floating value found in program."));
2472 fprintf_filtered (stream, current_substring, (double) val);
2475 case long_double_arg:
2476 #ifdef HAVE_LONG_DOUBLE
2478 struct type *type = value_type (val_args[i]);
2482 /* If format string wants a float, unchecked-convert the value
2483 to floating point of the same size. */
2484 type = float_type_from_length (type);
2485 val = unpack_double (type, value_contents (val_args[i]), &inv);
2487 error (_("Invalid floating value found in program."));
2489 fprintf_filtered (stream, current_substring,
2494 error (_("long double not supported in printf"));
2497 #if defined (CC_HAS_LONG_LONG) && defined (PRINTF_HAS_LONG_LONG)
2499 long long val = value_as_long (val_args[i]);
2501 fprintf_filtered (stream, current_substring, val);
2505 error (_("long long not supported in printf"));
2509 int val = value_as_long (val_args[i]);
2511 fprintf_filtered (stream, current_substring, val);
2516 long val = value_as_long (val_args[i]);
2518 fprintf_filtered (stream, current_substring, val);
2522 /* Handles decimal floating values. */
2525 const gdb_byte *param_ptr = value_contents (val_args[i]);
2527 #if defined (PRINTF_HAS_DECFLOAT)
2528 /* If we have native support for Decimal floating
2529 printing, handle it here. */
2530 fprintf_filtered (stream, current_substring, param_ptr);
2533 /* As a workaround until vasprintf has native support for DFP
2534 we convert the DFP values to string and print them using
2535 the %s format specifier. */
2538 int nnull_chars = 0;
2540 /* Parameter data. */
2541 struct type *param_type = value_type (val_args[i]);
2542 unsigned int param_len = TYPE_LENGTH (param_type);
2543 struct gdbarch *gdbarch = get_type_arch (param_type);
2544 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
2546 /* DFP output data. */
2547 struct value *dfp_value = NULL;
2551 struct type *dfp_type = NULL;
2552 char decstr[MAX_DECIMAL_STRING];
2554 /* Points to the end of the string so that we can go back
2555 and check for DFP length modifiers. */
2556 eos = current_substring + strlen (current_substring);
2558 /* Look for the float/double format specifier. */
2559 while (*eos != 'f' && *eos != 'e' && *eos != 'E'
2560 && *eos != 'g' && *eos != 'G')
2565 /* Search for the '%' char and extract the size and type of
2566 the output decimal value based on its modifiers
2567 (%Hf, %Df, %DDf). */
2568 while (*--sos != '%')
2573 dfp_type = builtin_type (gdbarch)->builtin_decfloat;
2575 else if (*sos == 'D' && *(sos - 1) == 'D')
2578 dfp_type = builtin_type (gdbarch)->builtin_declong;
2584 dfp_type = builtin_type (gdbarch)->builtin_decdouble;
2588 /* Replace %Hf, %Df and %DDf with %s's. */
2591 /* Go through the whole format string and pull the correct
2592 number of chars back to compensate for the change in the
2593 format specifier. */
2594 while (nnull_chars < nargs - i)
2602 /* Conversion between different DFP types. */
2603 if (TYPE_CODE (param_type) == TYPE_CODE_DECFLOAT)
2604 decimal_convert (param_ptr, param_len, byte_order,
2605 dec, dfp_len, byte_order);
2607 /* If this is a non-trivial conversion, just output 0.
2608 A correct converted value can be displayed by explicitly
2609 casting to a DFP type. */
2610 decimal_from_string (dec, dfp_len, byte_order, "0");
2612 dfp_value = value_from_decfloat (dfp_type, dec);
2614 dfp_ptr = (gdb_byte *) value_contents (dfp_value);
2616 decimal_to_string (dfp_ptr, dfp_len, byte_order, decstr);
2618 /* Print the DFP value. */
2619 fprintf_filtered (stream, current_substring, decstr);
2627 /* We avoid the host's %p because pointers are too
2628 likely to be the wrong size. The only interesting
2629 modifier for %p is a width; extract that, and then
2630 handle %p as glibc would: %#x or a literal "(nil)". */
2632 char *p, *fmt, *fmt_p;
2633 #if defined (CC_HAS_LONG_LONG) && defined (PRINTF_HAS_LONG_LONG)
2634 long long val = value_as_long (val_args[i]);
2636 long val = value_as_long (val_args[i]);
2639 fmt = alloca (strlen (current_substring) + 5);
2641 /* Copy up to the leading %. */
2642 p = current_substring;
2646 int is_percent = (*p == '%');
2661 /* Copy any width. */
2662 while (*p >= '0' && *p < '9')
2665 gdb_assert (*p == 'p' && *(p + 1) == '\0');
2668 #if defined (CC_HAS_LONG_LONG) && defined (PRINTF_HAS_LONG_LONG)
2674 fprintf_filtered (stream, fmt, val);
2680 fprintf_filtered (stream, fmt, "(nil)");
2686 internal_error (__FILE__, __LINE__,
2687 _("failed internal consistency check"));
2689 /* Skip to the next substring. */
2690 current_substring += strlen (current_substring) + 1;
2692 /* Print the portion of the format string after the last argument.
2693 Note that this will not include any ordinary %-specs, but it
2694 might include "%%". That is why we use printf_filtered and not
2695 puts_filtered here. Also, we pass a dummy argument because
2696 some platforms have modified GCC to include -Wformat-security
2697 by default, which will warn here if there is no argument. */
2698 fprintf_filtered (stream, last_arg, 0);
2700 do_cleanups (old_cleanups);
2703 /* Implement the "printf" command. */
2706 printf_command (char *arg, int from_tty)
2708 ui_printf (arg, gdb_stdout);
2711 /* Implement the "eval" command. */
2714 eval_command (char *arg, int from_tty)
2716 struct ui_file *ui_out = mem_fileopen ();
2717 struct cleanup *cleanups = make_cleanup_ui_file_delete (ui_out);
2720 ui_printf (arg, ui_out);
2722 expanded = ui_file_xstrdup (ui_out, NULL);
2723 make_cleanup (xfree, expanded);
2725 execute_command (expanded, from_tty);
2727 do_cleanups (cleanups);
2731 _initialize_printcmd (void)
2733 struct cmd_list_element *c;
2735 current_display_number = -1;
2737 observer_attach_solib_unloaded (clear_dangling_display_expressions);
2739 add_info ("address", address_info,
2740 _("Describe where symbol SYM is stored."));
2742 add_info ("symbol", sym_info, _("\
2743 Describe what symbol is at location ADDR.\n\
2744 Only for symbols with fixed locations (global or static scope)."));
2746 add_com ("x", class_vars, x_command, _("\
2747 Examine memory: x/FMT ADDRESS.\n\
2748 ADDRESS is an expression for the memory address to examine.\n\
2749 FMT is a repeat count followed by a format letter and a size letter.\n\
2750 Format letters are o(octal), x(hex), d(decimal), u(unsigned decimal),\n\
2751 t(binary), f(float), a(address), i(instruction), c(char) and s(string).\n\
2752 Size letters are b(byte), h(halfword), w(word), g(giant, 8 bytes).\n\
2753 The specified number of objects of the specified size are printed\n\
2754 according to the format.\n\n\
2755 Defaults for format and size letters are those previously used.\n\
2756 Default count is 1. Default address is following last thing printed\n\
2757 with this command or \"print\"."));
2760 add_com ("whereis", class_vars, whereis_command,
2761 _("Print line number and file of definition of variable."));
2764 add_info ("display", display_info, _("\
2765 Expressions to display when program stops, with code numbers."));
2767 add_cmd ("undisplay", class_vars, undisplay_command, _("\
2768 Cancel some expressions to be displayed when program stops.\n\
2769 Arguments are the code numbers of the expressions to stop displaying.\n\
2770 No argument means cancel all automatic-display expressions.\n\
2771 \"delete display\" has the same effect as this command.\n\
2772 Do \"info display\" to see current list of code numbers."),
2775 add_com ("display", class_vars, display_command, _("\
2776 Print value of expression EXP each time the program stops.\n\
2777 /FMT may be used before EXP as in the \"print\" command.\n\
2778 /FMT \"i\" or \"s\" or including a size-letter is allowed,\n\
2779 as in the \"x\" command, and then EXP is used to get the address to examine\n\
2780 and examining is done as in the \"x\" command.\n\n\
2781 With no argument, display all currently requested auto-display expressions.\n\
2782 Use \"undisplay\" to cancel display requests previously made."));
2784 add_cmd ("display", class_vars, enable_display_command, _("\
2785 Enable some expressions to be displayed when program stops.\n\
2786 Arguments are the code numbers of the expressions to resume displaying.\n\
2787 No argument means enable all automatic-display expressions.\n\
2788 Do \"info display\" to see current list of code numbers."), &enablelist);
2790 add_cmd ("display", class_vars, disable_display_command, _("\
2791 Disable some expressions to be displayed when program stops.\n\
2792 Arguments are the code numbers of the expressions to stop displaying.\n\
2793 No argument means disable all automatic-display expressions.\n\
2794 Do \"info display\" to see current list of code numbers."), &disablelist);
2796 add_cmd ("display", class_vars, undisplay_command, _("\
2797 Cancel some expressions to be displayed when program stops.\n\
2798 Arguments are the code numbers of the expressions to stop displaying.\n\
2799 No argument means cancel all automatic-display expressions.\n\
2800 Do \"info display\" to see current list of code numbers."), &deletelist);
2802 add_com ("printf", class_vars, printf_command, _("\
2803 printf \"printf format string\", arg1, arg2, arg3, ..., argn\n\
2804 This is useful for formatted output in user-defined commands."));
2806 add_com ("output", class_vars, output_command, _("\
2807 Like \"print\" but don't put in value history and don't print newline.\n\
2808 This is useful in user-defined commands."));
2810 add_prefix_cmd ("set", class_vars, set_command, _("\
2811 Evaluate expression EXP and assign result to variable VAR, using assignment\n\
2812 syntax appropriate for the current language (VAR = EXP or VAR := EXP for\n\
2813 example). VAR may be a debugger \"convenience\" variable (names starting\n\
2814 with $), a register (a few standard names starting with $), or an actual\n\
2815 variable in the program being debugged. EXP is any valid expression.\n\
2816 Use \"set variable\" for variables with names identical to set subcommands.\n\
2818 With a subcommand, this command modifies parts of the gdb environment.\n\
2819 You can see these environment settings with the \"show\" command."),
2820 &setlist, "set ", 1, &cmdlist);
2822 add_com ("assign", class_vars, set_command, _("\
2823 Evaluate expression EXP and assign result to variable VAR, using assignment\n\
2824 syntax appropriate for the current language (VAR = EXP or VAR := EXP for\n\
2825 example). VAR may be a debugger \"convenience\" variable (names starting\n\
2826 with $), a register (a few standard names starting with $), or an actual\n\
2827 variable in the program being debugged. EXP is any valid expression.\n\
2828 Use \"set variable\" for variables with names identical to set subcommands.\n\
2829 \nWith a subcommand, this command modifies parts of the gdb environment.\n\
2830 You can see these environment settings with the \"show\" command."));
2832 /* "call" is the same as "set", but handy for dbx users to call fns. */
2833 c = add_com ("call", class_vars, call_command, _("\
2834 Call a function in the program.\n\
2835 The argument is the function name and arguments, in the notation of the\n\
2836 current working language. The result is printed and saved in the value\n\
2837 history, if it is not void."));
2838 set_cmd_completer (c, expression_completer);
2840 add_cmd ("variable", class_vars, set_command, _("\
2841 Evaluate expression EXP and assign result to variable VAR, using assignment\n\
2842 syntax appropriate for the current language (VAR = EXP or VAR := EXP for\n\
2843 example). VAR may be a debugger \"convenience\" variable (names starting\n\
2844 with $), a register (a few standard names starting with $), or an actual\n\
2845 variable in the program being debugged. EXP is any valid expression.\n\
2846 This may usually be abbreviated to simply \"set\"."),
2849 c = add_com ("print", class_vars, print_command, _("\
2850 Print value of expression EXP.\n\
2851 Variables accessible are those of the lexical environment of the selected\n\
2852 stack frame, plus all those whose scope is global or an entire file.\n\
2854 $NUM gets previous value number NUM. $ and $$ are the last two values.\n\
2855 $$NUM refers to NUM'th value back from the last one.\n\
2856 Names starting with $ refer to registers (with the values they would have\n\
2857 if the program were to return to the stack frame now selected, restoring\n\
2858 all registers saved by frames farther in) or else to debugger\n\
2859 \"convenience\" variables (any such name not a known register).\n\
2860 Use assignment expressions to give values to convenience variables.\n\
2862 {TYPE}ADREXP refers to a datum of data type TYPE, located at address ADREXP.\n\
2863 @ is a binary operator for treating consecutive data objects\n\
2864 anywhere in memory as an array. FOO@NUM gives an array whose first\n\
2865 element is FOO, whose second element is stored in the space following\n\
2866 where FOO is stored, etc. FOO must be an expression whose value\n\
2867 resides in memory.\n\
2869 EXP may be preceded with /FMT, where FMT is a format letter\n\
2870 but no count or size letter (see \"x\" command)."));
2871 set_cmd_completer (c, expression_completer);
2872 add_com_alias ("p", "print", class_vars, 1);
2874 c = add_com ("inspect", class_vars, inspect_command, _("\
2875 Same as \"print\" command, except that if you are running in the epoch\n\
2876 environment, the value is printed in its own window."));
2877 set_cmd_completer (c, expression_completer);
2879 add_setshow_uinteger_cmd ("max-symbolic-offset", no_class,
2880 &max_symbolic_offset, _("\
2881 Set the largest offset that will be printed in <symbol+1234> form."), _("\
2882 Show the largest offset that will be printed in <symbol+1234> form."), NULL,
2884 show_max_symbolic_offset,
2885 &setprintlist, &showprintlist);
2886 add_setshow_boolean_cmd ("symbol-filename", no_class,
2887 &print_symbol_filename, _("\
2888 Set printing of source filename and line number with <symbol>."), _("\
2889 Show printing of source filename and line number with <symbol>."), NULL,
2891 show_print_symbol_filename,
2892 &setprintlist, &showprintlist);
2894 add_com ("eval", no_class, eval_command, _("\
2895 Convert \"printf format string\", arg1, arg2, arg3, ..., argn to\n\
2896 a command line, and call it."));