1 /* Print values for GDB, the GNU debugger.
3 Copyright (C) 1986-2020 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/>. */
30 #include "target-float.h"
31 #include "extension.h"
33 #include "gdb_obstack.h"
35 #include "typeprint.h"
38 #include "gdbsupport/byte-vector.h"
39 #include "cli/cli-option.h"
41 #include "cli/cli-style.h"
42 #include "count-one-bits.h"
44 /* Maximum number of wchars returned from wchar_iterate. */
47 /* A convenience macro to compute the size of a wchar_t buffer containing X
49 #define WCHAR_BUFLEN(X) ((X) * sizeof (gdb_wchar_t))
51 /* Character buffer size saved while iterating over wchars. */
52 #define WCHAR_BUFLEN_MAX WCHAR_BUFLEN (MAX_WCHARS)
54 /* A structure to encapsulate state information from iterated
55 character conversions. */
56 struct converted_character
58 /* The number of characters converted. */
61 /* The result of the conversion. See charset.h for more. */
62 enum wchar_iterate_result result
;
64 /* The (saved) converted character(s). */
65 gdb_wchar_t chars
[WCHAR_BUFLEN_MAX
];
67 /* The first converted target byte. */
70 /* The number of bytes converted. */
73 /* How many times this character(s) is repeated. */
77 /* Command lists for set/show print raw. */
78 struct cmd_list_element
*setprintrawlist
;
79 struct cmd_list_element
*showprintrawlist
;
81 /* Prototypes for local functions */
83 static int partial_memory_read (CORE_ADDR memaddr
, gdb_byte
*myaddr
,
84 int len
, int *errptr
);
86 static void set_input_radix_1 (int, unsigned);
88 static void set_output_radix_1 (int, unsigned);
90 static void val_print_type_code_flags (struct type
*type
,
91 const gdb_byte
*valaddr
,
92 struct ui_file
*stream
);
94 #define PRINT_MAX_DEFAULT 200 /* Start print_max off at this value. */
95 #define PRINT_MAX_DEPTH_DEFAULT 20 /* Start print_max_depth off at this value. */
97 struct value_print_options user_print_options
=
99 Val_prettyformat_default
, /* prettyformat */
100 0, /* prettyformat_arrays */
101 0, /* prettyformat_structs */
104 1, /* addressprint */
106 PRINT_MAX_DEFAULT
, /* print_max */
107 10, /* repeat_count_threshold */
108 0, /* output_format */
110 0, /* stop_print_at_null */
111 0, /* print_array_indexes */
113 1, /* static_field_print */
114 1, /* pascal_static_field_print */
117 1, /* symbol_print */
118 PRINT_MAX_DEPTH_DEFAULT
, /* max_depth */
122 /* Initialize *OPTS to be a copy of the user print options. */
124 get_user_print_options (struct value_print_options
*opts
)
126 *opts
= user_print_options
;
129 /* Initialize *OPTS to be a copy of the user print options, but with
130 pretty-formatting disabled. */
132 get_no_prettyformat_print_options (struct value_print_options
*opts
)
134 *opts
= user_print_options
;
135 opts
->prettyformat
= Val_no_prettyformat
;
138 /* Initialize *OPTS to be a copy of the user print options, but using
139 FORMAT as the formatting option. */
141 get_formatted_print_options (struct value_print_options
*opts
,
144 *opts
= user_print_options
;
145 opts
->format
= format
;
149 show_print_max (struct ui_file
*file
, int from_tty
,
150 struct cmd_list_element
*c
, const char *value
)
152 fprintf_filtered (file
,
153 _("Limit on string chars or array "
154 "elements to print is %s.\n"),
159 /* Default input and output radixes, and output format letter. */
161 unsigned input_radix
= 10;
163 show_input_radix (struct ui_file
*file
, int from_tty
,
164 struct cmd_list_element
*c
, const char *value
)
166 fprintf_filtered (file
,
167 _("Default input radix for entering numbers is %s.\n"),
171 unsigned output_radix
= 10;
173 show_output_radix (struct ui_file
*file
, int from_tty
,
174 struct cmd_list_element
*c
, const char *value
)
176 fprintf_filtered (file
,
177 _("Default output radix for printing of values is %s.\n"),
181 /* By default we print arrays without printing the index of each element in
182 the array. This behavior can be changed by setting PRINT_ARRAY_INDEXES. */
185 show_print_array_indexes (struct ui_file
*file
, int from_tty
,
186 struct cmd_list_element
*c
, const char *value
)
188 fprintf_filtered (file
, _("Printing of array indexes is %s.\n"), value
);
191 /* Print repeat counts if there are more than this many repetitions of an
192 element in an array. Referenced by the low level language dependent
196 show_repeat_count_threshold (struct ui_file
*file
, int from_tty
,
197 struct cmd_list_element
*c
, const char *value
)
199 fprintf_filtered (file
, _("Threshold for repeated print elements is %s.\n"),
203 /* If nonzero, stops printing of char arrays at first null. */
206 show_stop_print_at_null (struct ui_file
*file
, int from_tty
,
207 struct cmd_list_element
*c
, const char *value
)
209 fprintf_filtered (file
,
210 _("Printing of char arrays to stop "
211 "at first null char is %s.\n"),
215 /* Controls pretty printing of structures. */
218 show_prettyformat_structs (struct ui_file
*file
, int from_tty
,
219 struct cmd_list_element
*c
, const char *value
)
221 fprintf_filtered (file
, _("Pretty formatting of structures is %s.\n"), value
);
224 /* Controls pretty printing of arrays. */
227 show_prettyformat_arrays (struct ui_file
*file
, int from_tty
,
228 struct cmd_list_element
*c
, const char *value
)
230 fprintf_filtered (file
, _("Pretty formatting of arrays is %s.\n"), value
);
233 /* If nonzero, causes unions inside structures or other unions to be
237 show_unionprint (struct ui_file
*file
, int from_tty
,
238 struct cmd_list_element
*c
, const char *value
)
240 fprintf_filtered (file
,
241 _("Printing of unions interior to structures is %s.\n"),
245 /* If nonzero, causes machine addresses to be printed in certain contexts. */
248 show_addressprint (struct ui_file
*file
, int from_tty
,
249 struct cmd_list_element
*c
, const char *value
)
251 fprintf_filtered (file
, _("Printing of addresses is %s.\n"), value
);
255 show_symbol_print (struct ui_file
*file
, int from_tty
,
256 struct cmd_list_element
*c
, const char *value
)
258 fprintf_filtered (file
,
259 _("Printing of symbols when printing pointers is %s.\n"),
265 /* A helper function for val_print. When printing in "summary" mode,
266 we want to print scalar arguments, but not aggregate arguments.
267 This function distinguishes between the two. */
270 val_print_scalar_type_p (struct type
*type
)
272 type
= check_typedef (type
);
273 while (TYPE_IS_REFERENCE (type
))
275 type
= TYPE_TARGET_TYPE (type
);
276 type
= check_typedef (type
);
278 switch (TYPE_CODE (type
))
280 case TYPE_CODE_ARRAY
:
281 case TYPE_CODE_STRUCT
:
282 case TYPE_CODE_UNION
:
284 case TYPE_CODE_STRING
:
291 /* A helper function for val_print. When printing with limited depth we
292 want to print string and scalar arguments, but not aggregate arguments.
293 This function distinguishes between the two. */
296 val_print_scalar_or_string_type_p (struct type
*type
,
297 const struct language_defn
*language
)
299 return (val_print_scalar_type_p (type
)
300 || language
->la_is_string_type_p (type
));
303 /* See its definition in value.h. */
306 valprint_check_validity (struct ui_file
*stream
,
308 LONGEST embedded_offset
,
309 const struct value
*val
)
311 type
= check_typedef (type
);
313 if (type_not_associated (type
))
315 val_print_not_associated (stream
);
319 if (type_not_allocated (type
))
321 val_print_not_allocated (stream
);
325 if (TYPE_CODE (type
) != TYPE_CODE_UNION
326 && TYPE_CODE (type
) != TYPE_CODE_STRUCT
327 && TYPE_CODE (type
) != TYPE_CODE_ARRAY
)
329 if (value_bits_any_optimized_out (val
,
330 TARGET_CHAR_BIT
* embedded_offset
,
331 TARGET_CHAR_BIT
* TYPE_LENGTH (type
)))
333 val_print_optimized_out (val
, stream
);
337 if (value_bits_synthetic_pointer (val
, TARGET_CHAR_BIT
* embedded_offset
,
338 TARGET_CHAR_BIT
* TYPE_LENGTH (type
)))
340 const int is_ref
= TYPE_CODE (type
) == TYPE_CODE_REF
;
341 int ref_is_addressable
= 0;
345 const struct value
*deref_val
= coerce_ref_if_computed (val
);
347 if (deref_val
!= NULL
)
348 ref_is_addressable
= value_lval_const (deref_val
) == lval_memory
;
351 if (!is_ref
|| !ref_is_addressable
)
352 fputs_styled (_("<synthetic pointer>"), metadata_style
.style (),
355 /* C++ references should be valid even if they're synthetic. */
359 if (!value_bytes_available (val
, embedded_offset
, TYPE_LENGTH (type
)))
361 val_print_unavailable (stream
);
370 val_print_optimized_out (const struct value
*val
, struct ui_file
*stream
)
372 if (val
!= NULL
&& value_lval_const (val
) == lval_register
)
373 val_print_not_saved (stream
);
375 fprintf_styled (stream
, metadata_style
.style (), _("<optimized out>"));
379 val_print_not_saved (struct ui_file
*stream
)
381 fprintf_styled (stream
, metadata_style
.style (), _("<not saved>"));
385 val_print_unavailable (struct ui_file
*stream
)
387 fprintf_styled (stream
, metadata_style
.style (), _("<unavailable>"));
391 val_print_invalid_address (struct ui_file
*stream
)
393 fprintf_styled (stream
, metadata_style
.style (), _("<invalid address>"));
396 /* Print a pointer based on the type of its target.
398 Arguments to this functions are roughly the same as those in
399 generic_val_print. A difference is that ADDRESS is the address to print,
400 with embedded_offset already added. ELTTYPE represents
401 the pointed type after check_typedef. */
404 print_unpacked_pointer (struct type
*type
, struct type
*elttype
,
405 CORE_ADDR address
, struct ui_file
*stream
,
406 const struct value_print_options
*options
)
408 struct gdbarch
*gdbarch
= get_type_arch (type
);
410 if (TYPE_CODE (elttype
) == TYPE_CODE_FUNC
)
412 /* Try to print what function it points to. */
413 print_function_pointer_address (options
, gdbarch
, address
, stream
);
417 if (options
->symbol_print
)
418 print_address_demangle (options
, gdbarch
, address
, stream
, demangle
);
419 else if (options
->addressprint
)
420 fputs_filtered (paddress (gdbarch
, address
), stream
);
423 /* generic_val_print helper for TYPE_CODE_ARRAY. */
426 generic_val_print_array (struct type
*type
,
427 int embedded_offset
, CORE_ADDR address
,
428 struct ui_file
*stream
, int recurse
,
429 struct value
*original_value
,
430 const struct value_print_options
*options
,
432 generic_val_print_decorations
*decorations
)
434 struct type
*unresolved_elttype
= TYPE_TARGET_TYPE (type
);
435 struct type
*elttype
= check_typedef (unresolved_elttype
);
437 if (TYPE_LENGTH (type
) > 0 && TYPE_LENGTH (unresolved_elttype
) > 0)
439 LONGEST low_bound
, high_bound
;
441 if (!get_array_bounds (type
, &low_bound
, &high_bound
))
442 error (_("Could not determine the array high bound"));
444 if (options
->prettyformat_arrays
)
446 print_spaces_filtered (2 + 2 * recurse
, stream
);
449 fputs_filtered (decorations
->array_start
, stream
);
450 val_print_array_elements (type
, embedded_offset
,
452 recurse
, original_value
, options
, 0);
453 fputs_filtered (decorations
->array_end
, stream
);
457 /* Array of unspecified length: treat like pointer to first elt. */
458 print_unpacked_pointer (type
, elttype
, address
+ embedded_offset
, stream
,
464 /* generic_val_print helper for TYPE_CODE_PTR. */
467 generic_val_print_ptr (struct type
*type
,
468 int embedded_offset
, struct ui_file
*stream
,
469 struct value
*original_value
,
470 const struct value_print_options
*options
)
472 struct gdbarch
*gdbarch
= get_type_arch (type
);
473 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
475 if (options
->format
&& options
->format
!= 's')
477 val_print_scalar_formatted (type
, embedded_offset
,
478 original_value
, options
, 0, stream
);
482 struct type
*unresolved_elttype
= TYPE_TARGET_TYPE(type
);
483 struct type
*elttype
= check_typedef (unresolved_elttype
);
484 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
485 CORE_ADDR addr
= unpack_pointer (type
,
486 valaddr
+ embedded_offset
* unit_size
);
488 print_unpacked_pointer (type
, elttype
, addr
, stream
, options
);
493 /* generic_val_print helper for TYPE_CODE_MEMBERPTR. */
496 generic_val_print_memberptr (struct type
*type
,
497 int embedded_offset
, struct ui_file
*stream
,
498 struct value
*original_value
,
499 const struct value_print_options
*options
)
501 val_print_scalar_formatted (type
, embedded_offset
,
502 original_value
, options
, 0, stream
);
505 /* Print '@' followed by the address contained in ADDRESS_BUFFER. */
508 print_ref_address (struct type
*type
, const gdb_byte
*address_buffer
,
509 int embedded_offset
, struct ui_file
*stream
)
511 struct gdbarch
*gdbarch
= get_type_arch (type
);
513 if (address_buffer
!= NULL
)
516 = extract_typed_address (address_buffer
+ embedded_offset
, type
);
518 fprintf_filtered (stream
, "@");
519 fputs_filtered (paddress (gdbarch
, address
), stream
);
521 /* Else: we have a non-addressable value, such as a DW_AT_const_value. */
524 /* If VAL is addressable, return the value contents buffer of a value that
525 represents a pointer to VAL. Otherwise return NULL. */
527 static const gdb_byte
*
528 get_value_addr_contents (struct value
*deref_val
)
530 gdb_assert (deref_val
!= NULL
);
532 if (value_lval_const (deref_val
) == lval_memory
)
533 return value_contents_for_printing_const (value_addr (deref_val
));
536 /* We have a non-addressable value, such as a DW_AT_const_value. */
541 /* generic_val_print helper for TYPE_CODE_{RVALUE_,}REF. */
544 generic_val_print_ref (struct type
*type
,
545 int embedded_offset
, struct ui_file
*stream
, int recurse
,
546 struct value
*original_value
,
547 const struct value_print_options
*options
)
549 struct type
*elttype
= check_typedef (TYPE_TARGET_TYPE (type
));
550 struct value
*deref_val
= NULL
;
551 const int value_is_synthetic
552 = value_bits_synthetic_pointer (original_value
,
553 TARGET_CHAR_BIT
* embedded_offset
,
554 TARGET_CHAR_BIT
* TYPE_LENGTH (type
));
555 const int must_coerce_ref
= ((options
->addressprint
&& value_is_synthetic
)
556 || options
->deref_ref
);
557 const int type_is_defined
= TYPE_CODE (elttype
) != TYPE_CODE_UNDEF
;
558 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
560 if (must_coerce_ref
&& type_is_defined
)
562 deref_val
= coerce_ref_if_computed (original_value
);
564 if (deref_val
!= NULL
)
566 /* More complicated computed references are not supported. */
567 gdb_assert (embedded_offset
== 0);
570 deref_val
= value_at (TYPE_TARGET_TYPE (type
),
571 unpack_pointer (type
, valaddr
+ embedded_offset
));
573 /* Else, original_value isn't a synthetic reference or we don't have to print
574 the reference's contents.
576 Notice that for references to TYPE_CODE_STRUCT, 'set print object on' will
577 cause original_value to be a not_lval instead of an lval_computed,
578 which will make value_bits_synthetic_pointer return false.
579 This happens because if options->objectprint is true, c_value_print will
580 overwrite original_value's contents with the result of coercing
581 the reference through value_addr, and then set its type back to
582 TYPE_CODE_REF. In that case we don't have to coerce the reference again;
583 we can simply treat it as non-synthetic and move on. */
585 if (options
->addressprint
)
587 const gdb_byte
*address
= (value_is_synthetic
&& type_is_defined
588 ? get_value_addr_contents (deref_val
)
591 print_ref_address (type
, address
, embedded_offset
, stream
);
593 if (options
->deref_ref
)
594 fputs_filtered (": ", stream
);
597 if (options
->deref_ref
)
600 common_val_print (deref_val
, stream
, recurse
, options
,
603 fputs_filtered ("???", stream
);
607 /* Helper function for generic_val_print_enum.
608 This is also used to print enums in TYPE_CODE_FLAGS values. */
611 generic_val_print_enum_1 (struct type
*type
, LONGEST val
,
612 struct ui_file
*stream
)
617 len
= TYPE_NFIELDS (type
);
618 for (i
= 0; i
< len
; i
++)
621 if (val
== TYPE_FIELD_ENUMVAL (type
, i
))
628 fputs_styled (TYPE_FIELD_NAME (type
, i
), variable_name_style
.style (),
631 else if (TYPE_FLAG_ENUM (type
))
635 /* We have a "flag" enum, so we try to decompose it into pieces as
636 appropriate. The enum may have multiple enumerators representing
637 the same bit, in which case we choose to only print the first one
639 for (i
= 0; i
< len
; ++i
)
643 ULONGEST enumval
= TYPE_FIELD_ENUMVAL (type
, i
);
644 int nbits
= count_one_bits_ll (enumval
);
646 gdb_assert (nbits
== 0 || nbits
== 1);
648 if ((val
& enumval
) != 0)
652 fputs_filtered ("(", stream
);
656 fputs_filtered (" | ", stream
);
658 val
&= ~TYPE_FIELD_ENUMVAL (type
, i
);
659 fputs_styled (TYPE_FIELD_NAME (type
, i
),
660 variable_name_style
.style (), stream
);
666 /* There are leftover bits, print them. */
668 fputs_filtered ("(", stream
);
670 fputs_filtered (" | ", stream
);
672 fputs_filtered ("unknown: 0x", stream
);
673 print_longest (stream
, 'x', 0, val
);
674 fputs_filtered (")", stream
);
678 /* Nothing has been printed and the value is 0, the enum value must
680 fputs_filtered ("0", stream
);
684 /* Something has been printed, close the parenthesis. */
685 fputs_filtered (")", stream
);
689 print_longest (stream
, 'd', 0, val
);
692 /* generic_val_print helper for TYPE_CODE_ENUM. */
695 generic_val_print_enum (struct type
*type
,
696 int embedded_offset
, struct ui_file
*stream
,
697 struct value
*original_value
,
698 const struct value_print_options
*options
)
701 struct gdbarch
*gdbarch
= get_type_arch (type
);
702 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
706 val_print_scalar_formatted (type
, embedded_offset
,
707 original_value
, options
, 0, stream
);
711 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
713 val
= unpack_long (type
, valaddr
+ embedded_offset
* unit_size
);
715 generic_val_print_enum_1 (type
, val
, stream
);
719 /* generic_val_print helper for TYPE_CODE_FLAGS. */
722 generic_val_print_flags (struct type
*type
,
723 int embedded_offset
, struct ui_file
*stream
,
724 struct value
*original_value
,
725 const struct value_print_options
*options
)
729 val_print_scalar_formatted (type
, embedded_offset
, original_value
,
733 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
735 val_print_type_code_flags (type
, valaddr
+ embedded_offset
, stream
);
739 /* generic_val_print helper for TYPE_CODE_FUNC and TYPE_CODE_METHOD. */
742 generic_val_print_func (struct type
*type
,
743 int embedded_offset
, CORE_ADDR address
,
744 struct ui_file
*stream
,
745 struct value
*original_value
,
746 const struct value_print_options
*options
)
748 struct gdbarch
*gdbarch
= get_type_arch (type
);
752 val_print_scalar_formatted (type
, embedded_offset
,
753 original_value
, options
, 0, stream
);
757 /* FIXME, we should consider, at least for ANSI C language,
758 eliminating the distinction made between FUNCs and POINTERs
760 fprintf_filtered (stream
, "{");
761 type_print (type
, "", stream
, -1);
762 fprintf_filtered (stream
, "} ");
763 /* Try to print what function it points to, and its address. */
764 print_address_demangle (options
, gdbarch
, address
, stream
, demangle
);
768 /* generic_val_print helper for TYPE_CODE_BOOL. */
771 generic_val_print_bool (struct type
*type
,
772 int embedded_offset
, struct ui_file
*stream
,
773 struct value
*original_value
,
774 const struct value_print_options
*options
,
775 const struct generic_val_print_decorations
*decorations
)
778 struct gdbarch
*gdbarch
= get_type_arch (type
);
779 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
781 if (options
->format
|| options
->output_format
)
783 struct value_print_options opts
= *options
;
784 opts
.format
= (options
->format
? options
->format
785 : options
->output_format
);
786 val_print_scalar_formatted (type
, embedded_offset
,
787 original_value
, &opts
, 0, stream
);
791 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
793 val
= unpack_long (type
, valaddr
+ embedded_offset
* unit_size
);
795 fputs_filtered (decorations
->false_name
, stream
);
797 fputs_filtered (decorations
->true_name
, stream
);
799 print_longest (stream
, 'd', 0, val
);
803 /* generic_val_print helper for TYPE_CODE_INT. */
806 generic_val_print_int (struct type
*type
,
807 int embedded_offset
, struct ui_file
*stream
,
808 struct value
*original_value
,
809 const struct value_print_options
*options
)
811 struct value_print_options opts
= *options
;
813 opts
.format
= (options
->format
? options
->format
814 : options
->output_format
);
815 val_print_scalar_formatted (type
, embedded_offset
,
816 original_value
, &opts
, 0, stream
);
819 /* generic_val_print helper for TYPE_CODE_CHAR. */
822 generic_val_print_char (struct type
*type
, struct type
*unresolved_type
,
824 struct ui_file
*stream
,
825 struct value
*original_value
,
826 const struct value_print_options
*options
)
829 struct gdbarch
*gdbarch
= get_type_arch (type
);
830 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
832 if (options
->format
|| options
->output_format
)
834 struct value_print_options opts
= *options
;
836 opts
.format
= (options
->format
? options
->format
837 : options
->output_format
);
838 val_print_scalar_formatted (type
, embedded_offset
,
839 original_value
, &opts
, 0, stream
);
843 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
845 val
= unpack_long (type
, valaddr
+ embedded_offset
* unit_size
);
846 if (TYPE_UNSIGNED (type
))
847 fprintf_filtered (stream
, "%u", (unsigned int) val
);
849 fprintf_filtered (stream
, "%d", (int) val
);
850 fputs_filtered (" ", stream
);
851 LA_PRINT_CHAR (val
, unresolved_type
, stream
);
855 /* generic_val_print helper for TYPE_CODE_FLT and TYPE_CODE_DECFLOAT. */
858 generic_val_print_float (struct type
*type
,
859 int embedded_offset
, struct ui_file
*stream
,
860 struct value
*original_value
,
861 const struct value_print_options
*options
)
863 struct gdbarch
*gdbarch
= get_type_arch (type
);
864 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
868 val_print_scalar_formatted (type
, embedded_offset
,
869 original_value
, options
, 0, stream
);
873 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
875 print_floating (valaddr
+ embedded_offset
* unit_size
, type
, stream
);
879 /* generic_val_print helper for TYPE_CODE_COMPLEX. */
882 generic_val_print_complex (struct type
*type
,
883 int embedded_offset
, struct ui_file
*stream
,
884 struct value
*original_value
,
885 const struct value_print_options
*options
,
886 const struct generic_val_print_decorations
889 struct gdbarch
*gdbarch
= get_type_arch (type
);
890 int unit_size
= gdbarch_addressable_memory_unit_size (gdbarch
);
891 const gdb_byte
*valaddr
= value_contents_for_printing (original_value
);
893 fprintf_filtered (stream
, "%s", decorations
->complex_prefix
);
895 val_print_scalar_formatted (TYPE_TARGET_TYPE (type
),
896 embedded_offset
, original_value
, options
, 0,
899 print_floating (valaddr
+ embedded_offset
* unit_size
,
900 TYPE_TARGET_TYPE (type
), stream
);
901 fprintf_filtered (stream
, "%s", decorations
->complex_infix
);
903 val_print_scalar_formatted (TYPE_TARGET_TYPE (type
),
905 + type_length_units (TYPE_TARGET_TYPE (type
)),
906 original_value
, options
, 0, stream
);
908 print_floating (valaddr
+ embedded_offset
* unit_size
909 + TYPE_LENGTH (TYPE_TARGET_TYPE (type
)),
910 TYPE_TARGET_TYPE (type
), stream
);
911 fprintf_filtered (stream
, "%s", decorations
->complex_suffix
);
914 /* A generic val_print that is suitable for use by language
915 implementations of the la_val_print method. This function can
916 handle most type codes, though not all, notably exception
917 TYPE_CODE_UNION and TYPE_CODE_STRUCT, which must be implemented by
920 Most arguments are as to val_print.
922 The additional DECORATIONS argument can be used to customize the
923 output in some small, language-specific ways. */
926 generic_val_print (struct type
*type
,
927 int embedded_offset
, CORE_ADDR address
,
928 struct ui_file
*stream
, int recurse
,
929 struct value
*original_value
,
930 const struct value_print_options
*options
,
931 const struct generic_val_print_decorations
*decorations
)
933 struct type
*unresolved_type
= type
;
935 type
= check_typedef (type
);
936 switch (TYPE_CODE (type
))
938 case TYPE_CODE_ARRAY
:
939 generic_val_print_array (type
, embedded_offset
, address
, stream
,
940 recurse
, original_value
, options
, decorations
);
943 case TYPE_CODE_MEMBERPTR
:
944 generic_val_print_memberptr (type
, embedded_offset
, stream
,
945 original_value
, options
);
949 generic_val_print_ptr (type
, embedded_offset
, stream
,
950 original_value
, options
);
954 case TYPE_CODE_RVALUE_REF
:
955 generic_val_print_ref (type
, embedded_offset
, stream
, recurse
,
956 original_value
, options
);
960 generic_val_print_enum (type
, embedded_offset
, stream
,
961 original_value
, options
);
964 case TYPE_CODE_FLAGS
:
965 generic_val_print_flags (type
, embedded_offset
, stream
,
966 original_value
, options
);
970 case TYPE_CODE_METHOD
:
971 generic_val_print_func (type
, embedded_offset
, address
, stream
,
972 original_value
, options
);
976 generic_val_print_bool (type
, embedded_offset
, stream
,
977 original_value
, options
, decorations
);
980 case TYPE_CODE_RANGE
:
981 /* FIXME: create_static_range_type does not set the unsigned bit in a
982 range type (I think it probably should copy it from the
983 target type), so we won't print values which are too large to
984 fit in a signed integer correctly. */
985 /* FIXME: Doesn't handle ranges of enums correctly. (Can't just
986 print with the target type, though, because the size of our
987 type and the target type might differ). */
992 generic_val_print_int (type
, embedded_offset
, stream
,
993 original_value
, options
);
997 generic_val_print_char (type
, unresolved_type
, embedded_offset
,
998 stream
, original_value
, options
);
1002 case TYPE_CODE_DECFLOAT
:
1003 generic_val_print_float (type
, embedded_offset
, stream
,
1004 original_value
, options
);
1007 case TYPE_CODE_VOID
:
1008 fputs_filtered (decorations
->void_name
, stream
);
1011 case TYPE_CODE_ERROR
:
1012 fprintf_filtered (stream
, "%s", TYPE_ERROR_NAME (type
));
1015 case TYPE_CODE_UNDEF
:
1016 /* This happens (without TYPE_STUB set) on systems which don't use
1017 dbx xrefs (NO_DBX_XREFS in gcc) if a file has a "struct foo *bar"
1018 and no complete type for struct foo in that file. */
1019 fprintf_styled (stream
, metadata_style
.style (), _("<incomplete type>"));
1022 case TYPE_CODE_COMPLEX
:
1023 generic_val_print_complex (type
, embedded_offset
, stream
,
1024 original_value
, options
, decorations
);
1027 case TYPE_CODE_UNION
:
1028 case TYPE_CODE_STRUCT
:
1029 case TYPE_CODE_METHODPTR
:
1031 error (_("Unhandled type code %d in symbol table."),
1036 /* Print using the given LANGUAGE the data of type TYPE located at
1037 VAL's contents buffer + EMBEDDED_OFFSET (within GDB), which came
1038 from the inferior at address ADDRESS + EMBEDDED_OFFSET, onto
1039 stdio stream STREAM according to OPTIONS. VAL is the whole object
1040 that came from ADDRESS.
1042 The language printers will pass down an adjusted EMBEDDED_OFFSET to
1043 further helper subroutines as subfields of TYPE are printed. In
1044 such cases, VAL is passed down unadjusted, so
1045 that VAL can be queried for metadata about the contents data being
1046 printed, using EMBEDDED_OFFSET as an offset into VAL's contents
1047 buffer. For example: "has this field been optimized out", or "I'm
1048 printing an object while inspecting a traceframe; has this
1049 particular piece of data been collected?".
1051 RECURSE indicates the amount of indentation to supply before
1052 continuation lines; this amount is roughly twice the value of
1056 val_print (struct type
*type
, LONGEST embedded_offset
,
1057 CORE_ADDR address
, struct ui_file
*stream
, int recurse
,
1059 const struct value_print_options
*options
,
1060 const struct language_defn
*language
)
1063 struct value_print_options local_opts
= *options
;
1064 struct type
*real_type
= check_typedef (type
);
1066 if (local_opts
.prettyformat
== Val_prettyformat_default
)
1067 local_opts
.prettyformat
= (local_opts
.prettyformat_structs
1068 ? Val_prettyformat
: Val_no_prettyformat
);
1072 /* Ensure that the type is complete and not just a stub. If the type is
1073 only a stub and we can't find and substitute its complete type, then
1074 print appropriate string and return. */
1076 if (TYPE_STUB (real_type
))
1078 fprintf_styled (stream
, metadata_style
.style (), _("<incomplete type>"));
1082 if (!valprint_check_validity (stream
, real_type
, embedded_offset
, val
))
1087 ret
= apply_ext_lang_val_pretty_printer (type
, embedded_offset
,
1088 address
, stream
, recurse
,
1089 val
, options
, language
);
1094 /* Handle summary mode. If the value is a scalar, print it;
1095 otherwise, print an ellipsis. */
1096 if (options
->summary
&& !val_print_scalar_type_p (type
))
1098 fprintf_filtered (stream
, "...");
1102 /* If this value is too deep then don't print it. */
1103 if (!val_print_scalar_or_string_type_p (type
, language
)
1104 && val_print_check_max_depth (stream
, recurse
, options
, language
))
1109 language
->la_val_print (type
, embedded_offset
, address
,
1110 stream
, recurse
, val
,
1113 catch (const gdb_exception_error
&except
)
1115 fprintf_styled (stream
, metadata_style
.style (),
1116 _("<error reading variable>"));
1120 /* See valprint.h. */
1123 val_print_check_max_depth (struct ui_file
*stream
, int recurse
,
1124 const struct value_print_options
*options
,
1125 const struct language_defn
*language
)
1127 if (options
->max_depth
> -1 && recurse
>= options
->max_depth
)
1129 gdb_assert (language
->la_struct_too_deep_ellipsis
!= NULL
);
1130 fputs_filtered (language
->la_struct_too_deep_ellipsis
, stream
);
1137 /* Check whether the value VAL is printable. Return 1 if it is;
1138 return 0 and print an appropriate error message to STREAM according to
1139 OPTIONS if it is not. */
1142 value_check_printable (struct value
*val
, struct ui_file
*stream
,
1143 const struct value_print_options
*options
)
1147 fprintf_styled (stream
, metadata_style
.style (),
1148 _("<address of value unknown>"));
1152 if (value_entirely_optimized_out (val
))
1154 if (options
->summary
&& !val_print_scalar_type_p (value_type (val
)))
1155 fprintf_filtered (stream
, "...");
1157 val_print_optimized_out (val
, stream
);
1161 if (value_entirely_unavailable (val
))
1163 if (options
->summary
&& !val_print_scalar_type_p (value_type (val
)))
1164 fprintf_filtered (stream
, "...");
1166 val_print_unavailable (stream
);
1170 if (TYPE_CODE (value_type (val
)) == TYPE_CODE_INTERNAL_FUNCTION
)
1172 fprintf_styled (stream
, metadata_style
.style (),
1173 _("<internal function %s>"),
1174 value_internal_function_name (val
));
1178 if (type_not_associated (value_type (val
)))
1180 val_print_not_associated (stream
);
1184 if (type_not_allocated (value_type (val
)))
1186 val_print_not_allocated (stream
);
1193 /* Print using the given LANGUAGE the value VAL onto stream STREAM according
1196 This is a preferable interface to val_print, above, because it uses
1197 GDB's value mechanism. */
1200 common_val_print (struct value
*val
, struct ui_file
*stream
, int recurse
,
1201 const struct value_print_options
*options
,
1202 const struct language_defn
*language
)
1204 if (!value_check_printable (val
, stream
, options
))
1207 if (language
->la_language
== language_ada
)
1208 /* The value might have a dynamic type, which would cause trouble
1209 below when trying to extract the value contents (since the value
1210 size is determined from the type size which is unknown). So
1211 get a fixed representation of our value. */
1212 val
= ada_to_fixed_value (val
);
1214 if (value_lazy (val
))
1215 value_fetch_lazy (val
);
1217 val_print (value_type (val
),
1218 value_embedded_offset (val
), value_address (val
),
1220 val
, options
, language
);
1223 /* Print on stream STREAM the value VAL according to OPTIONS. The value
1224 is printed using the current_language syntax. */
1227 value_print (struct value
*val
, struct ui_file
*stream
,
1228 const struct value_print_options
*options
)
1230 scoped_value_mark free_values
;
1232 if (!value_check_printable (val
, stream
, options
))
1238 = apply_ext_lang_val_pretty_printer (value_type (val
),
1239 value_embedded_offset (val
),
1240 value_address (val
),
1242 val
, options
, current_language
);
1248 LA_VALUE_PRINT (val
, stream
, options
);
1252 val_print_type_code_flags (struct type
*type
, const gdb_byte
*valaddr
,
1253 struct ui_file
*stream
)
1255 ULONGEST val
= unpack_long (type
, valaddr
);
1256 int field
, nfields
= TYPE_NFIELDS (type
);
1257 struct gdbarch
*gdbarch
= get_type_arch (type
);
1258 struct type
*bool_type
= builtin_type (gdbarch
)->builtin_bool
;
1260 fputs_filtered ("[", stream
);
1261 for (field
= 0; field
< nfields
; field
++)
1263 if (TYPE_FIELD_NAME (type
, field
)[0] != '\0')
1265 struct type
*field_type
= TYPE_FIELD_TYPE (type
, field
);
1267 if (field_type
== bool_type
1268 /* We require boolean types here to be one bit wide. This is a
1269 problematic place to notify the user of an internal error
1270 though. Instead just fall through and print the field as an
1272 && TYPE_FIELD_BITSIZE (type
, field
) == 1)
1274 if (val
& ((ULONGEST
)1 << TYPE_FIELD_BITPOS (type
, field
)))
1277 styled_string (variable_name_style
.style (),
1278 TYPE_FIELD_NAME (type
, field
)));
1282 unsigned field_len
= TYPE_FIELD_BITSIZE (type
, field
);
1284 = val
>> (TYPE_FIELD_BITPOS (type
, field
) - field_len
+ 1);
1286 if (field_len
< sizeof (ULONGEST
) * TARGET_CHAR_BIT
)
1287 field_val
&= ((ULONGEST
) 1 << field_len
) - 1;
1288 fprintf_filtered (stream
, " %ps=",
1289 styled_string (variable_name_style
.style (),
1290 TYPE_FIELD_NAME (type
, field
)));
1291 if (TYPE_CODE (field_type
) == TYPE_CODE_ENUM
)
1292 generic_val_print_enum_1 (field_type
, field_val
, stream
);
1294 print_longest (stream
, 'd', 0, field_val
);
1298 fputs_filtered (" ]", stream
);
1301 /* Print a scalar of data of type TYPE, pointed to in GDB by VALADDR,
1302 according to OPTIONS and SIZE on STREAM. Format i is not supported
1305 This is how the elements of an array or structure are printed
1309 val_print_scalar_formatted (struct type
*type
,
1310 LONGEST embedded_offset
,
1312 const struct value_print_options
*options
,
1314 struct ui_file
*stream
)
1316 struct gdbarch
*arch
= get_type_arch (type
);
1317 int unit_size
= gdbarch_addressable_memory_unit_size (arch
);
1319 gdb_assert (val
!= NULL
);
1321 /* If we get here with a string format, try again without it. Go
1322 all the way back to the language printers, which may call us
1324 if (options
->format
== 's')
1326 struct value_print_options opts
= *options
;
1329 val_print (type
, embedded_offset
, 0, stream
, 0, val
, &opts
,
1334 /* value_contents_for_printing fetches all VAL's contents. They are
1335 needed to check whether VAL is optimized-out or unavailable
1337 const gdb_byte
*valaddr
= value_contents_for_printing (val
);
1339 /* A scalar object that does not have all bits available can't be
1340 printed, because all bits contribute to its representation. */
1341 if (value_bits_any_optimized_out (val
,
1342 TARGET_CHAR_BIT
* embedded_offset
,
1343 TARGET_CHAR_BIT
* TYPE_LENGTH (type
)))
1344 val_print_optimized_out (val
, stream
);
1345 else if (!value_bytes_available (val
, embedded_offset
, TYPE_LENGTH (type
)))
1346 val_print_unavailable (stream
);
1348 print_scalar_formatted (valaddr
+ embedded_offset
* unit_size
, type
,
1349 options
, size
, stream
);
1352 /* Print a number according to FORMAT which is one of d,u,x,o,b,h,w,g.
1353 The raison d'etre of this function is to consolidate printing of
1354 LONG_LONG's into this one function. The format chars b,h,w,g are
1355 from print_scalar_formatted(). Numbers are printed using C
1358 USE_C_FORMAT means to use C format in all cases. Without it,
1359 'o' and 'x' format do not include the standard C radix prefix
1362 Hilfinger/2004-09-09: USE_C_FORMAT was originally called USE_LOCAL
1363 and was intended to request formatting according to the current
1364 language and would be used for most integers that GDB prints. The
1365 exceptional cases were things like protocols where the format of
1366 the integer is a protocol thing, not a user-visible thing). The
1367 parameter remains to preserve the information of what things might
1368 be printed with language-specific format, should we ever resurrect
1372 print_longest (struct ui_file
*stream
, int format
, int use_c_format
,
1380 val
= int_string (val_long
, 10, 1, 0, 1); break;
1382 val
= int_string (val_long
, 10, 0, 0, 1); break;
1384 val
= int_string (val_long
, 16, 0, 0, use_c_format
); break;
1386 val
= int_string (val_long
, 16, 0, 2, 1); break;
1388 val
= int_string (val_long
, 16, 0, 4, 1); break;
1390 val
= int_string (val_long
, 16, 0, 8, 1); break;
1392 val
= int_string (val_long
, 16, 0, 16, 1); break;
1395 val
= int_string (val_long
, 8, 0, 0, use_c_format
); break;
1397 internal_error (__FILE__
, __LINE__
,
1398 _("failed internal consistency check"));
1400 fputs_filtered (val
, stream
);
1403 /* This used to be a macro, but I don't think it is called often enough
1404 to merit such treatment. */
1405 /* Convert a LONGEST to an int. This is used in contexts (e.g. number of
1406 arguments to a function, number in a value history, register number, etc.)
1407 where the value must not be larger than can fit in an int. */
1410 longest_to_int (LONGEST arg
)
1412 /* Let the compiler do the work. */
1413 int rtnval
= (int) arg
;
1415 /* Check for overflows or underflows. */
1416 if (sizeof (LONGEST
) > sizeof (int))
1420 error (_("Value out of range."));
1426 /* Print a floating point value of floating-point type TYPE,
1427 pointed to in GDB by VALADDR, on STREAM. */
1430 print_floating (const gdb_byte
*valaddr
, struct type
*type
,
1431 struct ui_file
*stream
)
1433 std::string str
= target_float_to_string (valaddr
, type
);
1434 fputs_filtered (str
.c_str (), stream
);
1438 print_binary_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
1439 unsigned len
, enum bfd_endian byte_order
, bool zero_pad
)
1444 bool seen_a_one
= false;
1446 /* Declared "int" so it will be signed.
1447 This ensures that right shift will shift in zeros. */
1449 const int mask
= 0x080;
1451 if (byte_order
== BFD_ENDIAN_BIG
)
1457 /* Every byte has 8 binary characters; peel off
1458 and print from the MSB end. */
1460 for (i
= 0; i
< (HOST_CHAR_BIT
* sizeof (*p
)); i
++)
1462 if (*p
& (mask
>> i
))
1467 if (zero_pad
|| seen_a_one
|| b
== '1')
1468 fputc_filtered (b
, stream
);
1476 for (p
= valaddr
+ len
- 1;
1480 for (i
= 0; i
< (HOST_CHAR_BIT
* sizeof (*p
)); i
++)
1482 if (*p
& (mask
>> i
))
1487 if (zero_pad
|| seen_a_one
|| b
== '1')
1488 fputc_filtered (b
, stream
);
1495 /* When not zero-padding, ensure that something is printed when the
1497 if (!zero_pad
&& !seen_a_one
)
1498 fputc_filtered ('0', stream
);
1501 /* A helper for print_octal_chars that emits a single octal digit,
1502 optionally suppressing it if is zero and updating SEEN_A_ONE. */
1505 emit_octal_digit (struct ui_file
*stream
, bool *seen_a_one
, int digit
)
1507 if (*seen_a_one
|| digit
!= 0)
1508 fprintf_filtered (stream
, "%o", digit
);
1513 /* VALADDR points to an integer of LEN bytes.
1514 Print it in octal on stream or format it in buf. */
1517 print_octal_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
1518 unsigned len
, enum bfd_endian byte_order
)
1521 unsigned char octa1
, octa2
, octa3
, carry
;
1524 /* Octal is 3 bits, which doesn't fit. Yuk. So we have to track
1525 * the extra bits, which cycle every three bytes:
1527 * Byte side: 0 1 2 3
1529 * bit number 123 456 78 | 9 012 345 6 | 78 901 234 | 567 890 12 |
1531 * Octal side: 0 1 carry 3 4 carry ...
1533 * Cycle number: 0 1 2
1535 * But of course we are printing from the high side, so we have to
1536 * figure out where in the cycle we are so that we end up with no
1537 * left over bits at the end.
1539 #define BITS_IN_OCTAL 3
1540 #define HIGH_ZERO 0340
1541 #define LOW_ZERO 0034
1542 #define CARRY_ZERO 0003
1543 static_assert (HIGH_ZERO
+ LOW_ZERO
+ CARRY_ZERO
== 0xff,
1544 "cycle zero constants are wrong");
1545 #define HIGH_ONE 0200
1546 #define MID_ONE 0160
1547 #define LOW_ONE 0016
1548 #define CARRY_ONE 0001
1549 static_assert (HIGH_ONE
+ MID_ONE
+ LOW_ONE
+ CARRY_ONE
== 0xff,
1550 "cycle one constants are wrong");
1551 #define HIGH_TWO 0300
1552 #define MID_TWO 0070
1553 #define LOW_TWO 0007
1554 static_assert (HIGH_TWO
+ MID_TWO
+ LOW_TWO
== 0xff,
1555 "cycle two constants are wrong");
1557 /* For 32 we start in cycle 2, with two bits and one bit carry;
1558 for 64 in cycle in cycle 1, with one bit and a two bit carry. */
1560 cycle
= (len
* HOST_CHAR_BIT
) % BITS_IN_OCTAL
;
1563 fputs_filtered ("0", stream
);
1564 bool seen_a_one
= false;
1565 if (byte_order
== BFD_ENDIAN_BIG
)
1574 /* No carry in, carry out two bits. */
1576 octa1
= (HIGH_ZERO
& *p
) >> 5;
1577 octa2
= (LOW_ZERO
& *p
) >> 2;
1578 carry
= (CARRY_ZERO
& *p
);
1579 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1580 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1584 /* Carry in two bits, carry out one bit. */
1586 octa1
= (carry
<< 1) | ((HIGH_ONE
& *p
) >> 7);
1587 octa2
= (MID_ONE
& *p
) >> 4;
1588 octa3
= (LOW_ONE
& *p
) >> 1;
1589 carry
= (CARRY_ONE
& *p
);
1590 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1591 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1592 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1596 /* Carry in one bit, no carry out. */
1598 octa1
= (carry
<< 2) | ((HIGH_TWO
& *p
) >> 6);
1599 octa2
= (MID_TWO
& *p
) >> 3;
1600 octa3
= (LOW_TWO
& *p
);
1602 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1603 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1604 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1608 error (_("Internal error in octal conversion;"));
1612 cycle
= cycle
% BITS_IN_OCTAL
;
1617 for (p
= valaddr
+ len
- 1;
1624 /* Carry out, no carry in */
1626 octa1
= (HIGH_ZERO
& *p
) >> 5;
1627 octa2
= (LOW_ZERO
& *p
) >> 2;
1628 carry
= (CARRY_ZERO
& *p
);
1629 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1630 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1634 /* Carry in, carry out */
1636 octa1
= (carry
<< 1) | ((HIGH_ONE
& *p
) >> 7);
1637 octa2
= (MID_ONE
& *p
) >> 4;
1638 octa3
= (LOW_ONE
& *p
) >> 1;
1639 carry
= (CARRY_ONE
& *p
);
1640 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1641 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1642 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1646 /* Carry in, no carry out */
1648 octa1
= (carry
<< 2) | ((HIGH_TWO
& *p
) >> 6);
1649 octa2
= (MID_TWO
& *p
) >> 3;
1650 octa3
= (LOW_TWO
& *p
);
1652 emit_octal_digit (stream
, &seen_a_one
, octa1
);
1653 emit_octal_digit (stream
, &seen_a_one
, octa2
);
1654 emit_octal_digit (stream
, &seen_a_one
, octa3
);
1658 error (_("Internal error in octal conversion;"));
1662 cycle
= cycle
% BITS_IN_OCTAL
;
1668 /* Possibly negate the integer represented by BYTES. It contains LEN
1669 bytes in the specified byte order. If the integer is negative,
1670 copy it into OUT_VEC, negate it, and return true. Otherwise, do
1671 nothing and return false. */
1674 maybe_negate_by_bytes (const gdb_byte
*bytes
, unsigned len
,
1675 enum bfd_endian byte_order
,
1676 gdb::byte_vector
*out_vec
)
1679 gdb_assert (len
> 0);
1680 if (byte_order
== BFD_ENDIAN_BIG
)
1681 sign_byte
= bytes
[0];
1683 sign_byte
= bytes
[len
- 1];
1684 if ((sign_byte
& 0x80) == 0)
1687 out_vec
->resize (len
);
1689 /* Compute -x == 1 + ~x. */
1690 if (byte_order
== BFD_ENDIAN_LITTLE
)
1693 for (unsigned i
= 0; i
< len
; ++i
)
1695 unsigned tem
= (0xff & ~bytes
[i
]) + carry
;
1696 (*out_vec
)[i
] = tem
& 0xff;
1703 for (unsigned i
= len
; i
> 0; --i
)
1705 unsigned tem
= (0xff & ~bytes
[i
- 1]) + carry
;
1706 (*out_vec
)[i
- 1] = tem
& 0xff;
1714 /* VALADDR points to an integer of LEN bytes.
1715 Print it in decimal on stream or format it in buf. */
1718 print_decimal_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
1719 unsigned len
, bool is_signed
,
1720 enum bfd_endian byte_order
)
1723 #define CARRY_OUT( x ) ((x) / TEN) /* extend char to int */
1724 #define CARRY_LEFT( x ) ((x) % TEN)
1725 #define SHIFT( x ) ((x) << 4)
1726 #define LOW_NIBBLE( x ) ( (x) & 0x00F)
1727 #define HIGH_NIBBLE( x ) (((x) & 0x0F0) >> 4)
1732 int i
, j
, decimal_digits
;
1736 gdb::byte_vector negated_bytes
;
1738 && maybe_negate_by_bytes (valaddr
, len
, byte_order
, &negated_bytes
))
1740 fputs_filtered ("-", stream
);
1741 valaddr
= negated_bytes
.data ();
1744 /* Base-ten number is less than twice as many digits
1745 as the base 16 number, which is 2 digits per byte. */
1747 decimal_len
= len
* 2 * 2;
1748 std::vector
<unsigned char> digits (decimal_len
, 0);
1750 /* Ok, we have an unknown number of bytes of data to be printed in
1753 * Given a hex number (in nibbles) as XYZ, we start by taking X and
1754 * decimalizing it as "x1 x2" in two decimal nibbles. Then we multiply
1755 * the nibbles by 16, add Y and re-decimalize. Repeat with Z.
1757 * The trick is that "digits" holds a base-10 number, but sometimes
1758 * the individual digits are > 10.
1760 * Outer loop is per nibble (hex digit) of input, from MSD end to
1763 decimal_digits
= 0; /* Number of decimal digits so far */
1764 p
= (byte_order
== BFD_ENDIAN_BIG
) ? valaddr
: valaddr
+ len
- 1;
1766 while ((byte_order
== BFD_ENDIAN_BIG
) ? (p
< valaddr
+ len
) : (p
>= valaddr
))
1769 * Multiply current base-ten number by 16 in place.
1770 * Each digit was between 0 and 9, now is between
1773 for (j
= 0; j
< decimal_digits
; j
++)
1775 digits
[j
] = SHIFT (digits
[j
]);
1778 /* Take the next nibble off the input and add it to what
1779 * we've got in the LSB position. Bottom 'digit' is now
1780 * between 0 and 159.
1782 * "flip" is used to run this loop twice for each byte.
1786 /* Take top nibble. */
1788 digits
[0] += HIGH_NIBBLE (*p
);
1793 /* Take low nibble and bump our pointer "p". */
1795 digits
[0] += LOW_NIBBLE (*p
);
1796 if (byte_order
== BFD_ENDIAN_BIG
)
1803 /* Re-decimalize. We have to do this often enough
1804 * that we don't overflow, but once per nibble is
1805 * overkill. Easier this way, though. Note that the
1806 * carry is often larger than 10 (e.g. max initial
1807 * carry out of lowest nibble is 15, could bubble all
1808 * the way up greater than 10). So we have to do
1809 * the carrying beyond the last current digit.
1812 for (j
= 0; j
< decimal_len
- 1; j
++)
1816 /* "/" won't handle an unsigned char with
1817 * a value that if signed would be negative.
1818 * So extend to longword int via "dummy".
1821 carry
= CARRY_OUT (dummy
);
1822 digits
[j
] = CARRY_LEFT (dummy
);
1824 if (j
>= decimal_digits
&& carry
== 0)
1827 * All higher digits are 0 and we
1828 * no longer have a carry.
1830 * Note: "j" is 0-based, "decimal_digits" is
1833 decimal_digits
= j
+ 1;
1839 /* Ok, now "digits" is the decimal representation, with
1840 the "decimal_digits" actual digits. Print! */
1842 for (i
= decimal_digits
- 1; i
> 0 && digits
[i
] == 0; --i
)
1847 fprintf_filtered (stream
, "%1d", digits
[i
]);
1851 /* VALADDR points to an integer of LEN bytes. Print it in hex on stream. */
1854 print_hex_chars (struct ui_file
*stream
, const gdb_byte
*valaddr
,
1855 unsigned len
, enum bfd_endian byte_order
,
1860 fputs_filtered ("0x", stream
);
1861 if (byte_order
== BFD_ENDIAN_BIG
)
1867 /* Strip leading 0 bytes, but be sure to leave at least a
1868 single byte at the end. */
1869 for (; p
< valaddr
+ len
- 1 && !*p
; ++p
)
1873 const gdb_byte
*first
= p
;
1878 /* When not zero-padding, use a different format for the
1879 very first byte printed. */
1880 if (!zero_pad
&& p
== first
)
1881 fprintf_filtered (stream
, "%x", *p
);
1883 fprintf_filtered (stream
, "%02x", *p
);
1888 p
= valaddr
+ len
- 1;
1892 /* Strip leading 0 bytes, but be sure to leave at least a
1893 single byte at the end. */
1894 for (; p
>= valaddr
+ 1 && !*p
; --p
)
1898 const gdb_byte
*first
= p
;
1903 /* When not zero-padding, use a different format for the
1904 very first byte printed. */
1905 if (!zero_pad
&& p
== first
)
1906 fprintf_filtered (stream
, "%x", *p
);
1908 fprintf_filtered (stream
, "%02x", *p
);
1913 /* VALADDR points to a char integer of LEN bytes.
1914 Print it out in appropriate language form on stream.
1915 Omit any leading zero chars. */
1918 print_char_chars (struct ui_file
*stream
, struct type
*type
,
1919 const gdb_byte
*valaddr
,
1920 unsigned len
, enum bfd_endian byte_order
)
1924 if (byte_order
== BFD_ENDIAN_BIG
)
1927 while (p
< valaddr
+ len
- 1 && *p
== 0)
1930 while (p
< valaddr
+ len
)
1932 LA_EMIT_CHAR (*p
, type
, stream
, '\'');
1938 p
= valaddr
+ len
- 1;
1939 while (p
> valaddr
&& *p
== 0)
1942 while (p
>= valaddr
)
1944 LA_EMIT_CHAR (*p
, type
, stream
, '\'');
1950 /* Print function pointer with inferior address ADDRESS onto stdio
1954 print_function_pointer_address (const struct value_print_options
*options
,
1955 struct gdbarch
*gdbarch
,
1957 struct ui_file
*stream
)
1960 = gdbarch_convert_from_func_ptr_addr (gdbarch
, address
,
1961 current_top_target ());
1963 /* If the function pointer is represented by a description, print
1964 the address of the description. */
1965 if (options
->addressprint
&& func_addr
!= address
)
1967 fputs_filtered ("@", stream
);
1968 fputs_filtered (paddress (gdbarch
, address
), stream
);
1969 fputs_filtered (": ", stream
);
1971 print_address_demangle (options
, gdbarch
, func_addr
, stream
, demangle
);
1975 /* Print on STREAM using the given OPTIONS the index for the element
1976 at INDEX of an array whose index type is INDEX_TYPE. */
1979 maybe_print_array_index (struct type
*index_type
, LONGEST index
,
1980 struct ui_file
*stream
,
1981 const struct value_print_options
*options
)
1983 struct value
*index_value
;
1985 if (!options
->print_array_indexes
)
1988 index_value
= value_from_longest (index_type
, index
);
1990 LA_PRINT_ARRAY_INDEX (index_value
, stream
, options
);
1993 /* Called by various <lang>_val_print routines to print elements of an
1994 array in the form "<elem1>, <elem2>, <elem3>, ...".
1996 (FIXME?) Assumes array element separator is a comma, which is correct
1997 for all languages currently handled.
1998 (FIXME?) Some languages have a notation for repeated array elements,
1999 perhaps we should try to use that notation when appropriate. */
2002 val_print_array_elements (struct type
*type
,
2003 LONGEST embedded_offset
,
2004 CORE_ADDR address
, struct ui_file
*stream
,
2007 const struct value_print_options
*options
,
2010 unsigned int things_printed
= 0;
2012 struct type
*elttype
, *index_type
, *base_index_type
;
2014 /* Position of the array element we are examining to see
2015 whether it is repeated. */
2017 /* Number of repetitions we have detected so far. */
2019 LONGEST low_bound
, high_bound
;
2020 LONGEST low_pos
, high_pos
;
2022 elttype
= TYPE_TARGET_TYPE (type
);
2023 eltlen
= type_length_units (check_typedef (elttype
));
2024 index_type
= TYPE_INDEX_TYPE (type
);
2026 if (get_array_bounds (type
, &low_bound
, &high_bound
))
2028 if (TYPE_CODE (index_type
) == TYPE_CODE_RANGE
)
2029 base_index_type
= TYPE_TARGET_TYPE (index_type
);
2031 base_index_type
= index_type
;
2033 /* Non-contiguous enumerations types can by used as index types
2034 in some languages (e.g. Ada). In this case, the array length
2035 shall be computed from the positions of the first and last
2036 literal in the enumeration type, and not from the values
2037 of these literals. */
2038 if (!discrete_position (base_index_type
, low_bound
, &low_pos
)
2039 || !discrete_position (base_index_type
, high_bound
, &high_pos
))
2041 warning (_("unable to get positions in array, use bounds instead"));
2042 low_pos
= low_bound
;
2043 high_pos
= high_bound
;
2046 /* The array length should normally be HIGH_POS - LOW_POS + 1.
2047 But we have to be a little extra careful, because some languages
2048 such as Ada allow LOW_POS to be greater than HIGH_POS for
2049 empty arrays. In that situation, the array length is just zero,
2051 if (low_pos
> high_pos
)
2054 len
= high_pos
- low_pos
+ 1;
2058 warning (_("unable to get bounds of array, assuming null array"));
2063 annotate_array_section_begin (i
, elttype
);
2065 for (; i
< len
&& things_printed
< options
->print_max
; i
++)
2069 if (options
->prettyformat_arrays
)
2071 fprintf_filtered (stream
, ",\n");
2072 print_spaces_filtered (2 + 2 * recurse
, stream
);
2076 fprintf_filtered (stream
, ", ");
2079 wrap_here (n_spaces (2 + 2 * recurse
));
2080 maybe_print_array_index (index_type
, i
+ low_bound
,
2085 /* Only check for reps if repeat_count_threshold is not set to
2086 UINT_MAX (unlimited). */
2087 if (options
->repeat_count_threshold
< UINT_MAX
)
2090 && value_contents_eq (val
,
2091 embedded_offset
+ i
* eltlen
,
2102 if (reps
> options
->repeat_count_threshold
)
2104 val_print (elttype
, embedded_offset
+ i
* eltlen
,
2105 address
, stream
, recurse
+ 1, val
, options
,
2107 annotate_elt_rep (reps
);
2108 fprintf_filtered (stream
, " %p[<repeats %u times>%p]",
2109 metadata_style
.style ().ptr (), reps
, nullptr);
2110 annotate_elt_rep_end ();
2113 things_printed
+= options
->repeat_count_threshold
;
2117 val_print (elttype
, embedded_offset
+ i
* eltlen
,
2119 stream
, recurse
+ 1, val
, options
, current_language
);
2124 annotate_array_section_end ();
2127 fprintf_filtered (stream
, "...");
2131 /* Read LEN bytes of target memory at address MEMADDR, placing the
2132 results in GDB's memory at MYADDR. Returns a count of the bytes
2133 actually read, and optionally a target_xfer_status value in the
2134 location pointed to by ERRPTR if ERRPTR is non-null. */
2136 /* FIXME: cagney/1999-10-14: Only used by val_print_string. Can this
2137 function be eliminated. */
2140 partial_memory_read (CORE_ADDR memaddr
, gdb_byte
*myaddr
,
2141 int len
, int *errptr
)
2143 int nread
; /* Number of bytes actually read. */
2144 int errcode
; /* Error from last read. */
2146 /* First try a complete read. */
2147 errcode
= target_read_memory (memaddr
, myaddr
, len
);
2155 /* Loop, reading one byte at a time until we get as much as we can. */
2156 for (errcode
= 0, nread
= 0; len
> 0 && errcode
== 0; nread
++, len
--)
2158 errcode
= target_read_memory (memaddr
++, myaddr
++, 1);
2160 /* If an error, the last read was unsuccessful, so adjust count. */
2173 /* Read a string from the inferior, at ADDR, with LEN characters of
2174 WIDTH bytes each. Fetch at most FETCHLIMIT characters. BUFFER
2175 will be set to a newly allocated buffer containing the string, and
2176 BYTES_READ will be set to the number of bytes read. Returns 0 on
2177 success, or a target_xfer_status on failure.
2179 If LEN > 0, reads the lesser of LEN or FETCHLIMIT characters
2180 (including eventual NULs in the middle or end of the string).
2182 If LEN is -1, stops at the first null character (not necessarily
2183 the first null byte) up to a maximum of FETCHLIMIT characters. Set
2184 FETCHLIMIT to UINT_MAX to read as many characters as possible from
2187 Unless an exception is thrown, BUFFER will always be allocated, even on
2188 failure. In this case, some characters might have been read before the
2189 failure happened. Check BYTES_READ to recognize this situation.
2191 Note: There was a FIXME asking to make this code use target_read_string,
2192 but this function is more general (can read past null characters, up to
2193 given LEN). Besides, it is used much more often than target_read_string
2194 so it is more tested. Perhaps callers of target_read_string should use
2195 this function instead? */
2198 read_string (CORE_ADDR addr
, int len
, int width
, unsigned int fetchlimit
,
2199 enum bfd_endian byte_order
, gdb::unique_xmalloc_ptr
<gdb_byte
> *buffer
,
2202 int errcode
; /* Errno returned from bad reads. */
2203 unsigned int nfetch
; /* Chars to fetch / chars fetched. */
2204 gdb_byte
*bufptr
; /* Pointer to next available byte in
2207 /* Loop until we either have all the characters, or we encounter
2208 some error, such as bumping into the end of the address space. */
2210 buffer
->reset (nullptr);
2214 /* We want fetchlimit chars, so we might as well read them all in
2216 unsigned int fetchlen
= std::min ((unsigned) len
, fetchlimit
);
2218 buffer
->reset ((gdb_byte
*) xmalloc (fetchlen
* width
));
2219 bufptr
= buffer
->get ();
2221 nfetch
= partial_memory_read (addr
, bufptr
, fetchlen
* width
, &errcode
)
2223 addr
+= nfetch
* width
;
2224 bufptr
+= nfetch
* width
;
2228 unsigned long bufsize
= 0;
2229 unsigned int chunksize
; /* Size of each fetch, in chars. */
2230 int found_nul
; /* Non-zero if we found the nul char. */
2231 gdb_byte
*limit
; /* First location past end of fetch buffer. */
2234 /* We are looking for a NUL terminator to end the fetching, so we
2235 might as well read in blocks that are large enough to be efficient,
2236 but not so large as to be slow if fetchlimit happens to be large.
2237 So we choose the minimum of 8 and fetchlimit. We used to use 200
2238 instead of 8 but 200 is way too big for remote debugging over a
2240 chunksize
= std::min (8u, fetchlimit
);
2245 nfetch
= std::min ((unsigned long) chunksize
, fetchlimit
- bufsize
);
2247 if (*buffer
== NULL
)
2248 buffer
->reset ((gdb_byte
*) xmalloc (nfetch
* width
));
2250 buffer
->reset ((gdb_byte
*) xrealloc (buffer
->release (),
2251 (nfetch
+ bufsize
) * width
));
2253 bufptr
= buffer
->get () + bufsize
* width
;
2256 /* Read as much as we can. */
2257 nfetch
= partial_memory_read (addr
, bufptr
, nfetch
* width
, &errcode
)
2260 /* Scan this chunk for the null character that terminates the string
2261 to print. If found, we don't need to fetch any more. Note
2262 that bufptr is explicitly left pointing at the next character
2263 after the null character, or at the next character after the end
2266 limit
= bufptr
+ nfetch
* width
;
2267 while (bufptr
< limit
)
2271 c
= extract_unsigned_integer (bufptr
, width
, byte_order
);
2276 /* We don't care about any error which happened after
2277 the NUL terminator. */
2284 while (errcode
== 0 /* no error */
2285 && bufptr
- buffer
->get () < fetchlimit
* width
/* no overrun */
2286 && !found_nul
); /* haven't found NUL yet */
2289 { /* Length of string is really 0! */
2290 /* We always allocate *buffer. */
2291 buffer
->reset ((gdb_byte
*) xmalloc (1));
2292 bufptr
= buffer
->get ();
2296 /* bufptr and addr now point immediately beyond the last byte which we
2297 consider part of the string (including a '\0' which ends the string). */
2298 *bytes_read
= bufptr
- buffer
->get ();
2305 /* Return true if print_wchar can display W without resorting to a
2306 numeric escape, false otherwise. */
2309 wchar_printable (gdb_wchar_t w
)
2311 return (gdb_iswprint (w
)
2312 || w
== LCST ('\a') || w
== LCST ('\b')
2313 || w
== LCST ('\f') || w
== LCST ('\n')
2314 || w
== LCST ('\r') || w
== LCST ('\t')
2315 || w
== LCST ('\v'));
2318 /* A helper function that converts the contents of STRING to wide
2319 characters and then appends them to OUTPUT. */
2322 append_string_as_wide (const char *string
,
2323 struct obstack
*output
)
2325 for (; *string
; ++string
)
2327 gdb_wchar_t w
= gdb_btowc (*string
);
2328 obstack_grow (output
, &w
, sizeof (gdb_wchar_t
));
2332 /* Print a wide character W to OUTPUT. ORIG is a pointer to the
2333 original (target) bytes representing the character, ORIG_LEN is the
2334 number of valid bytes. WIDTH is the number of bytes in a base
2335 characters of the type. OUTPUT is an obstack to which wide
2336 characters are emitted. QUOTER is a (narrow) character indicating
2337 the style of quotes surrounding the character to be printed.
2338 NEED_ESCAPE is an in/out flag which is used to track numeric
2339 escapes across calls. */
2342 print_wchar (gdb_wint_t w
, const gdb_byte
*orig
,
2343 int orig_len
, int width
,
2344 enum bfd_endian byte_order
,
2345 struct obstack
*output
,
2346 int quoter
, int *need_escapep
)
2348 int need_escape
= *need_escapep
;
2352 /* iswprint implementation on Windows returns 1 for tab character.
2353 In order to avoid different printout on this host, we explicitly
2354 use wchar_printable function. */
2358 obstack_grow_wstr (output
, LCST ("\\a"));
2361 obstack_grow_wstr (output
, LCST ("\\b"));
2364 obstack_grow_wstr (output
, LCST ("\\f"));
2367 obstack_grow_wstr (output
, LCST ("\\n"));
2370 obstack_grow_wstr (output
, LCST ("\\r"));
2373 obstack_grow_wstr (output
, LCST ("\\t"));
2376 obstack_grow_wstr (output
, LCST ("\\v"));
2380 if (wchar_printable (w
) && (!need_escape
|| (!gdb_iswdigit (w
)
2382 && w
!= LCST ('9'))))
2384 gdb_wchar_t wchar
= w
;
2386 if (w
== gdb_btowc (quoter
) || w
== LCST ('\\'))
2387 obstack_grow_wstr (output
, LCST ("\\"));
2388 obstack_grow (output
, &wchar
, sizeof (gdb_wchar_t
));
2394 for (i
= 0; i
+ width
<= orig_len
; i
+= width
)
2399 value
= extract_unsigned_integer (&orig
[i
], width
,
2401 /* If the value fits in 3 octal digits, print it that
2402 way. Otherwise, print it as a hex escape. */
2404 xsnprintf (octal
, sizeof (octal
), "\\%.3o",
2405 (int) (value
& 0777));
2407 xsnprintf (octal
, sizeof (octal
), "\\x%lx", (long) value
);
2408 append_string_as_wide (octal
, output
);
2410 /* If we somehow have extra bytes, print them now. */
2411 while (i
< orig_len
)
2415 xsnprintf (octal
, sizeof (octal
), "\\%.3o", orig
[i
] & 0xff);
2416 append_string_as_wide (octal
, output
);
2427 /* Print the character C on STREAM as part of the contents of a
2428 literal string whose delimiter is QUOTER. ENCODING names the
2432 generic_emit_char (int c
, struct type
*type
, struct ui_file
*stream
,
2433 int quoter
, const char *encoding
)
2435 enum bfd_endian byte_order
2436 = type_byte_order (type
);
2438 int need_escape
= 0;
2440 c_buf
= (gdb_byte
*) alloca (TYPE_LENGTH (type
));
2441 pack_long (c_buf
, type
, c
);
2443 wchar_iterator
iter (c_buf
, TYPE_LENGTH (type
), encoding
, TYPE_LENGTH (type
));
2445 /* This holds the printable form of the wchar_t data. */
2446 auto_obstack wchar_buf
;
2452 const gdb_byte
*buf
;
2454 int print_escape
= 1;
2455 enum wchar_iterate_result result
;
2457 num_chars
= iter
.iterate (&result
, &chars
, &buf
, &buflen
);
2462 /* If all characters are printable, print them. Otherwise,
2463 we're going to have to print an escape sequence. We
2464 check all characters because we want to print the target
2465 bytes in the escape sequence, and we don't know character
2466 boundaries there. */
2470 for (i
= 0; i
< num_chars
; ++i
)
2471 if (!wchar_printable (chars
[i
]))
2479 for (i
= 0; i
< num_chars
; ++i
)
2480 print_wchar (chars
[i
], buf
, buflen
,
2481 TYPE_LENGTH (type
), byte_order
,
2482 &wchar_buf
, quoter
, &need_escape
);
2486 /* This handles the NUM_CHARS == 0 case as well. */
2488 print_wchar (gdb_WEOF
, buf
, buflen
, TYPE_LENGTH (type
),
2489 byte_order
, &wchar_buf
, quoter
, &need_escape
);
2492 /* The output in the host encoding. */
2493 auto_obstack output
;
2495 convert_between_encodings (INTERMEDIATE_ENCODING
, host_charset (),
2496 (gdb_byte
*) obstack_base (&wchar_buf
),
2497 obstack_object_size (&wchar_buf
),
2498 sizeof (gdb_wchar_t
), &output
, translit_char
);
2499 obstack_1grow (&output
, '\0');
2501 fputs_filtered ((const char *) obstack_base (&output
), stream
);
2504 /* Return the repeat count of the next character/byte in ITER,
2505 storing the result in VEC. */
2508 count_next_character (wchar_iterator
*iter
,
2509 std::vector
<converted_character
> *vec
)
2511 struct converted_character
*current
;
2515 struct converted_character tmp
;
2519 = iter
->iterate (&tmp
.result
, &chars
, &tmp
.buf
, &tmp
.buflen
);
2520 if (tmp
.num_chars
> 0)
2522 gdb_assert (tmp
.num_chars
< MAX_WCHARS
);
2523 memcpy (tmp
.chars
, chars
, tmp
.num_chars
* sizeof (gdb_wchar_t
));
2525 vec
->push_back (tmp
);
2528 current
= &vec
->back ();
2530 /* Count repeated characters or bytes. */
2531 current
->repeat_count
= 1;
2532 if (current
->num_chars
== -1)
2540 struct converted_character d
;
2547 /* Get the next character. */
2548 d
.num_chars
= iter
->iterate (&d
.result
, &chars
, &d
.buf
, &d
.buflen
);
2550 /* If a character was successfully converted, save the character
2551 into the converted character. */
2552 if (d
.num_chars
> 0)
2554 gdb_assert (d
.num_chars
< MAX_WCHARS
);
2555 memcpy (d
.chars
, chars
, WCHAR_BUFLEN (d
.num_chars
));
2558 /* Determine if the current character is the same as this
2560 if (d
.num_chars
== current
->num_chars
&& d
.result
== current
->result
)
2562 /* There are two cases to consider:
2564 1) Equality of converted character (num_chars > 0)
2565 2) Equality of non-converted character (num_chars == 0) */
2566 if ((current
->num_chars
> 0
2567 && memcmp (current
->chars
, d
.chars
,
2568 WCHAR_BUFLEN (current
->num_chars
)) == 0)
2569 || (current
->num_chars
== 0
2570 && current
->buflen
== d
.buflen
2571 && memcmp (current
->buf
, d
.buf
, current
->buflen
) == 0))
2572 ++current
->repeat_count
;
2580 /* Push this next converted character onto the result vector. */
2581 repeat
= current
->repeat_count
;
2587 /* Print the characters in CHARS to the OBSTACK. QUOTE_CHAR is the quote
2588 character to use with string output. WIDTH is the size of the output
2589 character type. BYTE_ORDER is the target byte order. OPTIONS
2590 is the user's print options. */
2593 print_converted_chars_to_obstack (struct obstack
*obstack
,
2594 const std::vector
<converted_character
> &chars
,
2595 int quote_char
, int width
,
2596 enum bfd_endian byte_order
,
2597 const struct value_print_options
*options
)
2600 const converted_character
*elem
;
2601 enum {START
, SINGLE
, REPEAT
, INCOMPLETE
, FINISH
} state
, last
;
2602 gdb_wchar_t wide_quote_char
= gdb_btowc (quote_char
);
2603 int need_escape
= 0;
2605 /* Set the start state. */
2607 last
= state
= START
;
2615 /* Nothing to do. */
2622 /* We are outputting a single character
2623 (< options->repeat_count_threshold). */
2627 /* We were outputting some other type of content, so we
2628 must output and a comma and a quote. */
2630 obstack_grow_wstr (obstack
, LCST (", "));
2631 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
2633 /* Output the character. */
2634 for (j
= 0; j
< elem
->repeat_count
; ++j
)
2636 if (elem
->result
== wchar_iterate_ok
)
2637 print_wchar (elem
->chars
[0], elem
->buf
, elem
->buflen
, width
,
2638 byte_order
, obstack
, quote_char
, &need_escape
);
2640 print_wchar (gdb_WEOF
, elem
->buf
, elem
->buflen
, width
,
2641 byte_order
, obstack
, quote_char
, &need_escape
);
2650 /* We are outputting a character with a repeat count
2651 greater than options->repeat_count_threshold. */
2655 /* We were outputting a single string. Terminate the
2657 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
2660 obstack_grow_wstr (obstack
, LCST (", "));
2662 /* Output the character and repeat string. */
2663 obstack_grow_wstr (obstack
, LCST ("'"));
2664 if (elem
->result
== wchar_iterate_ok
)
2665 print_wchar (elem
->chars
[0], elem
->buf
, elem
->buflen
, width
,
2666 byte_order
, obstack
, quote_char
, &need_escape
);
2668 print_wchar (gdb_WEOF
, elem
->buf
, elem
->buflen
, width
,
2669 byte_order
, obstack
, quote_char
, &need_escape
);
2670 obstack_grow_wstr (obstack
, LCST ("'"));
2671 std::string s
= string_printf (_(" <repeats %u times>"),
2672 elem
->repeat_count
);
2673 for (j
= 0; s
[j
]; ++j
)
2675 gdb_wchar_t w
= gdb_btowc (s
[j
]);
2676 obstack_grow (obstack
, &w
, sizeof (gdb_wchar_t
));
2682 /* We are outputting an incomplete sequence. */
2685 /* If we were outputting a string of SINGLE characters,
2686 terminate the quote. */
2687 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
2690 obstack_grow_wstr (obstack
, LCST (", "));
2692 /* Output the incomplete sequence string. */
2693 obstack_grow_wstr (obstack
, LCST ("<incomplete sequence "));
2694 print_wchar (gdb_WEOF
, elem
->buf
, elem
->buflen
, width
, byte_order
,
2695 obstack
, 0, &need_escape
);
2696 obstack_grow_wstr (obstack
, LCST (">"));
2698 /* We do not attempt to output anything after this. */
2703 /* All done. If we were outputting a string of SINGLE
2704 characters, the string must be terminated. Otherwise,
2705 REPEAT and INCOMPLETE are always left properly terminated. */
2707 obstack_grow (obstack
, &wide_quote_char
, sizeof (gdb_wchar_t
));
2712 /* Get the next element and state. */
2714 if (state
!= FINISH
)
2716 elem
= &chars
[idx
++];
2717 switch (elem
->result
)
2719 case wchar_iterate_ok
:
2720 case wchar_iterate_invalid
:
2721 if (elem
->repeat_count
> options
->repeat_count_threshold
)
2727 case wchar_iterate_incomplete
:
2731 case wchar_iterate_eof
:
2739 /* Print the character string STRING, printing at most LENGTH
2740 characters. LENGTH is -1 if the string is nul terminated. TYPE is
2741 the type of each character. OPTIONS holds the printing options;
2742 printing stops early if the number hits print_max; repeat counts
2743 are printed as appropriate. Print ellipses at the end if we had to
2744 stop before printing LENGTH characters, or if FORCE_ELLIPSES.
2745 QUOTE_CHAR is the character to print at each end of the string. If
2746 C_STYLE_TERMINATOR is true, and the last character is 0, then it is
2750 generic_printstr (struct ui_file
*stream
, struct type
*type
,
2751 const gdb_byte
*string
, unsigned int length
,
2752 const char *encoding
, int force_ellipses
,
2753 int quote_char
, int c_style_terminator
,
2754 const struct value_print_options
*options
)
2756 enum bfd_endian byte_order
= type_byte_order (type
);
2758 int width
= TYPE_LENGTH (type
);
2760 struct converted_character
*last
;
2764 unsigned long current_char
= 1;
2766 for (i
= 0; current_char
; ++i
)
2769 current_char
= extract_unsigned_integer (string
+ i
* width
,
2775 /* If the string was not truncated due to `set print elements', and
2776 the last byte of it is a null, we don't print that, in
2777 traditional C style. */
2778 if (c_style_terminator
2781 && (extract_unsigned_integer (string
+ (length
- 1) * width
,
2782 width
, byte_order
) == 0))
2787 fputs_filtered ("\"\"", stream
);
2791 /* Arrange to iterate over the characters, in wchar_t form. */
2792 wchar_iterator
iter (string
, length
* width
, encoding
, width
);
2793 std::vector
<converted_character
> converted_chars
;
2795 /* Convert characters until the string is over or the maximum
2796 number of printed characters has been reached. */
2798 while (i
< options
->print_max
)
2804 /* Grab the next character and repeat count. */
2805 r
= count_next_character (&iter
, &converted_chars
);
2807 /* If less than zero, the end of the input string was reached. */
2811 /* Otherwise, add the count to the total print count and get
2812 the next character. */
2816 /* Get the last element and determine if the entire string was
2818 last
= &converted_chars
.back ();
2819 finished
= (last
->result
== wchar_iterate_eof
);
2821 /* Ensure that CONVERTED_CHARS is terminated. */
2822 last
->result
= wchar_iterate_eof
;
2824 /* WCHAR_BUF is the obstack we use to represent the string in
2826 auto_obstack wchar_buf
;
2828 /* Print the output string to the obstack. */
2829 print_converted_chars_to_obstack (&wchar_buf
, converted_chars
, quote_char
,
2830 width
, byte_order
, options
);
2832 if (force_ellipses
|| !finished
)
2833 obstack_grow_wstr (&wchar_buf
, LCST ("..."));
2835 /* OUTPUT is where we collect `char's for printing. */
2836 auto_obstack output
;
2838 convert_between_encodings (INTERMEDIATE_ENCODING
, host_charset (),
2839 (gdb_byte
*) obstack_base (&wchar_buf
),
2840 obstack_object_size (&wchar_buf
),
2841 sizeof (gdb_wchar_t
), &output
, translit_char
);
2842 obstack_1grow (&output
, '\0');
2844 fputs_filtered ((const char *) obstack_base (&output
), stream
);
2847 /* Print a string from the inferior, starting at ADDR and printing up to LEN
2848 characters, of WIDTH bytes a piece, to STREAM. If LEN is -1, printing
2849 stops at the first null byte, otherwise printing proceeds (including null
2850 bytes) until either print_max or LEN characters have been printed,
2851 whichever is smaller. ENCODING is the name of the string's
2852 encoding. It can be NULL, in which case the target encoding is
2856 val_print_string (struct type
*elttype
, const char *encoding
,
2857 CORE_ADDR addr
, int len
,
2858 struct ui_file
*stream
,
2859 const struct value_print_options
*options
)
2861 int force_ellipsis
= 0; /* Force ellipsis to be printed if nonzero. */
2862 int err
; /* Non-zero if we got a bad read. */
2863 int found_nul
; /* Non-zero if we found the nul char. */
2864 unsigned int fetchlimit
; /* Maximum number of chars to print. */
2866 gdb::unique_xmalloc_ptr
<gdb_byte
> buffer
; /* Dynamically growable fetch buffer. */
2867 struct gdbarch
*gdbarch
= get_type_arch (elttype
);
2868 enum bfd_endian byte_order
= type_byte_order (elttype
);
2869 int width
= TYPE_LENGTH (elttype
);
2871 /* First we need to figure out the limit on the number of characters we are
2872 going to attempt to fetch and print. This is actually pretty simple. If
2873 LEN >= zero, then the limit is the minimum of LEN and print_max. If
2874 LEN is -1, then the limit is print_max. This is true regardless of
2875 whether print_max is zero, UINT_MAX (unlimited), or something in between,
2876 because finding the null byte (or available memory) is what actually
2877 limits the fetch. */
2879 fetchlimit
= (len
== -1 ? options
->print_max
: std::min ((unsigned) len
,
2880 options
->print_max
));
2882 err
= read_string (addr
, len
, width
, fetchlimit
, byte_order
,
2883 &buffer
, &bytes_read
);
2887 /* We now have either successfully filled the buffer to fetchlimit,
2888 or terminated early due to an error or finding a null char when
2891 /* Determine found_nul by looking at the last character read. */
2893 if (bytes_read
>= width
)
2894 found_nul
= extract_unsigned_integer (buffer
.get () + bytes_read
- width
,
2895 width
, byte_order
) == 0;
2896 if (len
== -1 && !found_nul
)
2900 /* We didn't find a NUL terminator we were looking for. Attempt
2901 to peek at the next character. If not successful, or it is not
2902 a null byte, then force ellipsis to be printed. */
2904 peekbuf
= (gdb_byte
*) alloca (width
);
2906 if (target_read_memory (addr
, peekbuf
, width
) == 0
2907 && extract_unsigned_integer (peekbuf
, width
, byte_order
) != 0)
2910 else if ((len
>= 0 && err
!= 0) || (len
> bytes_read
/ width
))
2912 /* Getting an error when we have a requested length, or fetching less
2913 than the number of characters actually requested, always make us
2918 /* If we get an error before fetching anything, don't print a string.
2919 But if we fetch something and then get an error, print the string
2920 and then the error message. */
2921 if (err
== 0 || bytes_read
> 0)
2923 LA_PRINT_STRING (stream
, elttype
, buffer
.get (), bytes_read
/ width
,
2924 encoding
, force_ellipsis
, options
);
2929 std::string str
= memory_error_message (TARGET_XFER_E_IO
, gdbarch
, addr
);
2931 fprintf_filtered (stream
, _("<error: %ps>"),
2932 styled_string (metadata_style
.style (),
2936 return (bytes_read
/ width
);
2939 /* Handle 'show print max-depth'. */
2942 show_print_max_depth (struct ui_file
*file
, int from_tty
,
2943 struct cmd_list_element
*c
, const char *value
)
2945 fprintf_filtered (file
, _("Maximum print depth is %s.\n"), value
);
2949 /* The 'set input-radix' command writes to this auxiliary variable.
2950 If the requested radix is valid, INPUT_RADIX is updated; otherwise,
2951 it is left unchanged. */
2953 static unsigned input_radix_1
= 10;
2955 /* Validate an input or output radix setting, and make sure the user
2956 knows what they really did here. Radix setting is confusing, e.g.
2957 setting the input radix to "10" never changes it! */
2960 set_input_radix (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2962 set_input_radix_1 (from_tty
, input_radix_1
);
2966 set_input_radix_1 (int from_tty
, unsigned radix
)
2968 /* We don't currently disallow any input radix except 0 or 1, which don't
2969 make any mathematical sense. In theory, we can deal with any input
2970 radix greater than 1, even if we don't have unique digits for every
2971 value from 0 to radix-1, but in practice we lose on large radix values.
2972 We should either fix the lossage or restrict the radix range more.
2977 input_radix_1
= input_radix
;
2978 error (_("Nonsense input radix ``decimal %u''; input radix unchanged."),
2981 input_radix_1
= input_radix
= radix
;
2984 printf_filtered (_("Input radix now set to "
2985 "decimal %u, hex %x, octal %o.\n"),
2986 radix
, radix
, radix
);
2990 /* The 'set output-radix' command writes to this auxiliary variable.
2991 If the requested radix is valid, OUTPUT_RADIX is updated,
2992 otherwise, it is left unchanged. */
2994 static unsigned output_radix_1
= 10;
2997 set_output_radix (const char *args
, int from_tty
, struct cmd_list_element
*c
)
2999 set_output_radix_1 (from_tty
, output_radix_1
);
3003 set_output_radix_1 (int from_tty
, unsigned radix
)
3005 /* Validate the radix and disallow ones that we aren't prepared to
3006 handle correctly, leaving the radix unchanged. */
3010 user_print_options
.output_format
= 'x'; /* hex */
3013 user_print_options
.output_format
= 0; /* decimal */
3016 user_print_options
.output_format
= 'o'; /* octal */
3019 output_radix_1
= output_radix
;
3020 error (_("Unsupported output radix ``decimal %u''; "
3021 "output radix unchanged."),
3024 output_radix_1
= output_radix
= radix
;
3027 printf_filtered (_("Output radix now set to "
3028 "decimal %u, hex %x, octal %o.\n"),
3029 radix
, radix
, radix
);
3033 /* Set both the input and output radix at once. Try to set the output radix
3034 first, since it has the most restrictive range. An radix that is valid as
3035 an output radix is also valid as an input radix.
3037 It may be useful to have an unusual input radix. If the user wishes to
3038 set an input radix that is not valid as an output radix, he needs to use
3039 the 'set input-radix' command. */
3042 set_radix (const char *arg
, int from_tty
)
3046 radix
= (arg
== NULL
) ? 10 : parse_and_eval_long (arg
);
3047 set_output_radix_1 (0, radix
);
3048 set_input_radix_1 (0, radix
);
3051 printf_filtered (_("Input and output radices now set to "
3052 "decimal %u, hex %x, octal %o.\n"),
3053 radix
, radix
, radix
);
3057 /* Show both the input and output radices. */
3060 show_radix (const char *arg
, int from_tty
)
3064 if (input_radix
== output_radix
)
3066 printf_filtered (_("Input and output radices set to "
3067 "decimal %u, hex %x, octal %o.\n"),
3068 input_radix
, input_radix
, input_radix
);
3072 printf_filtered (_("Input radix set to decimal "
3073 "%u, hex %x, octal %o.\n"),
3074 input_radix
, input_radix
, input_radix
);
3075 printf_filtered (_("Output radix set to decimal "
3076 "%u, hex %x, octal %o.\n"),
3077 output_radix
, output_radix
, output_radix
);
3084 set_print (const char *arg
, int from_tty
)
3087 "\"set print\" must be followed by the name of a print subcommand.\n");
3088 help_list (setprintlist
, "set print ", all_commands
, gdb_stdout
);
3092 show_print (const char *args
, int from_tty
)
3094 cmd_show_list (showprintlist
, from_tty
, "");
3098 set_print_raw (const char *arg
, int from_tty
)
3101 "\"set print raw\" must be followed by the name of a \"print raw\" subcommand.\n");
3102 help_list (setprintrawlist
, "set print raw ", all_commands
, gdb_stdout
);
3106 show_print_raw (const char *args
, int from_tty
)
3108 cmd_show_list (showprintrawlist
, from_tty
, "");
3111 /* Controls printing of vtbl's. */
3113 show_vtblprint (struct ui_file
*file
, int from_tty
,
3114 struct cmd_list_element
*c
, const char *value
)
3116 fprintf_filtered (file
, _("\
3117 Printing of C++ virtual function tables is %s.\n"),
3121 /* Controls looking up an object's derived type using what we find in
3124 show_objectprint (struct ui_file
*file
, int from_tty
,
3125 struct cmd_list_element
*c
,
3128 fprintf_filtered (file
, _("\
3129 Printing of object's derived type based on vtable info is %s.\n"),
3134 show_static_field_print (struct ui_file
*file
, int from_tty
,
3135 struct cmd_list_element
*c
,
3138 fprintf_filtered (file
,
3139 _("Printing of C++ static members is %s.\n"),
3145 /* A couple typedefs to make writing the options a bit more
3147 using boolean_option_def
3148 = gdb::option::boolean_option_def
<value_print_options
>;
3149 using uinteger_option_def
3150 = gdb::option::uinteger_option_def
<value_print_options
>;
3151 using zuinteger_unlimited_option_def
3152 = gdb::option::zuinteger_unlimited_option_def
<value_print_options
>;
3154 /* Definitions of options for the "print" and "compile print"
3156 static const gdb::option::option_def value_print_option_defs
[] = {
3158 boolean_option_def
{
3160 [] (value_print_options
*opt
) { return &opt
->addressprint
; },
3161 show_addressprint
, /* show_cmd_cb */
3162 N_("Set printing of addresses."),
3163 N_("Show printing of addresses."),
3164 NULL
, /* help_doc */
3167 boolean_option_def
{
3169 [] (value_print_options
*opt
) { return &opt
->prettyformat_arrays
; },
3170 show_prettyformat_arrays
, /* show_cmd_cb */
3171 N_("Set pretty formatting of arrays."),
3172 N_("Show pretty formatting of arrays."),
3173 NULL
, /* help_doc */
3176 boolean_option_def
{
3178 [] (value_print_options
*opt
) { return &opt
->print_array_indexes
; },
3179 show_print_array_indexes
, /* show_cmd_cb */
3180 N_("Set printing of array indexes."),
3181 N_("Show printing of array indexes."),
3182 NULL
, /* help_doc */
3185 uinteger_option_def
{
3187 [] (value_print_options
*opt
) { return &opt
->print_max
; },
3188 show_print_max
, /* show_cmd_cb */
3189 N_("Set limit on string chars or array elements to print."),
3190 N_("Show limit on string chars or array elements to print."),
3191 N_("\"unlimited\" causes there to be no limit."),
3194 zuinteger_unlimited_option_def
{
3196 [] (value_print_options
*opt
) { return &opt
->max_depth
; },
3197 show_print_max_depth
, /* show_cmd_cb */
3198 N_("Set maximum print depth for nested structures, unions and arrays."),
3199 N_("Show maximum print depth for nested structures, unions, and arrays."),
3200 N_("When structures, unions, or arrays are nested beyond this depth then they\n\
3201 will be replaced with either '{...}' or '(...)' depending on the language.\n\
3202 Use \"unlimited\" to print the complete structure.")
3205 boolean_option_def
{
3207 [] (value_print_options
*opt
) { return &opt
->stop_print_at_null
; },
3208 show_stop_print_at_null
, /* show_cmd_cb */
3209 N_("Set printing of char arrays to stop at first null char."),
3210 N_("Show printing of char arrays to stop at first null char."),
3211 NULL
, /* help_doc */
3214 boolean_option_def
{
3216 [] (value_print_options
*opt
) { return &opt
->objectprint
; },
3217 show_objectprint
, /* show_cmd_cb */
3218 _("Set printing of C++ virtual function tables."),
3219 _("Show printing of C++ virtual function tables."),
3220 NULL
, /* help_doc */
3223 boolean_option_def
{
3225 [] (value_print_options
*opt
) { return &opt
->prettyformat_structs
; },
3226 show_prettyformat_structs
, /* show_cmd_cb */
3227 N_("Set pretty formatting of structures."),
3228 N_("Show pretty formatting of structures."),
3229 NULL
, /* help_doc */
3232 boolean_option_def
{
3234 [] (value_print_options
*opt
) { return &opt
->raw
; },
3235 NULL
, /* show_cmd_cb */
3236 N_("Set whether to print values in raw form."),
3237 N_("Show whether to print values in raw form."),
3238 N_("If set, values are printed in raw form, bypassing any\n\
3239 pretty-printers for that value.")
3242 uinteger_option_def
{
3244 [] (value_print_options
*opt
) { return &opt
->repeat_count_threshold
; },
3245 show_repeat_count_threshold
, /* show_cmd_cb */
3246 N_("Set threshold for repeated print elements."),
3247 N_("Show threshold for repeated print elements."),
3248 N_("\"unlimited\" causes all elements to be individually printed."),
3251 boolean_option_def
{
3253 [] (value_print_options
*opt
) { return &opt
->static_field_print
; },
3254 show_static_field_print
, /* show_cmd_cb */
3255 N_("Set printing of C++ static members."),
3256 N_("Show printing of C++ static members."),
3257 NULL
, /* help_doc */
3260 boolean_option_def
{
3262 [] (value_print_options
*opt
) { return &opt
->symbol_print
; },
3263 show_symbol_print
, /* show_cmd_cb */
3264 N_("Set printing of symbol names when printing pointers."),
3265 N_("Show printing of symbol names when printing pointers."),
3266 NULL
, /* help_doc */
3269 boolean_option_def
{
3271 [] (value_print_options
*opt
) { return &opt
->unionprint
; },
3272 show_unionprint
, /* show_cmd_cb */
3273 N_("Set printing of unions interior to structures."),
3274 N_("Show printing of unions interior to structures."),
3275 NULL
, /* help_doc */
3278 boolean_option_def
{
3280 [] (value_print_options
*opt
) { return &opt
->vtblprint
; },
3281 show_vtblprint
, /* show_cmd_cb */
3282 N_("Set printing of C++ virtual function tables."),
3283 N_("Show printing of C++ virtual function tables."),
3284 NULL
, /* help_doc */
3288 /* See valprint.h. */
3290 gdb::option::option_def_group
3291 make_value_print_options_def_group (value_print_options
*opts
)
3293 return {{value_print_option_defs
}, opts
};
3296 void _initialize_valprint ();
3298 _initialize_valprint ()
3300 cmd_list_element
*cmd
;
3302 add_prefix_cmd ("print", no_class
, set_print
,
3303 _("Generic command for setting how things print."),
3304 &setprintlist
, "set print ", 0, &setlist
);
3305 add_alias_cmd ("p", "print", no_class
, 1, &setlist
);
3306 /* Prefer set print to set prompt. */
3307 add_alias_cmd ("pr", "print", no_class
, 1, &setlist
);
3309 add_prefix_cmd ("print", no_class
, show_print
,
3310 _("Generic command for showing print settings."),
3311 &showprintlist
, "show print ", 0, &showlist
);
3312 add_alias_cmd ("p", "print", no_class
, 1, &showlist
);
3313 add_alias_cmd ("pr", "print", no_class
, 1, &showlist
);
3315 cmd
= add_prefix_cmd ("raw", no_class
, set_print_raw
,
3317 Generic command for setting what things to print in \"raw\" mode."),
3318 &setprintrawlist
, "set print raw ", 0,
3320 deprecate_cmd (cmd
, nullptr);
3322 cmd
= add_prefix_cmd ("raw", no_class
, show_print_raw
,
3323 _("Generic command for showing \"print raw\" settings."),
3324 &showprintrawlist
, "show print raw ", 0,
3326 deprecate_cmd (cmd
, nullptr);
3328 gdb::option::add_setshow_cmds_for_options
3329 (class_support
, &user_print_options
, value_print_option_defs
,
3330 &setprintlist
, &showprintlist
);
3332 add_setshow_zuinteger_cmd ("input-radix", class_support
, &input_radix_1
,
3334 Set default input radix for entering numbers."), _("\
3335 Show default input radix for entering numbers."), NULL
,
3338 &setlist
, &showlist
);
3340 add_setshow_zuinteger_cmd ("output-radix", class_support
, &output_radix_1
,
3342 Set default output radix for printing of values."), _("\
3343 Show default output radix for printing of values."), NULL
,
3346 &setlist
, &showlist
);
3348 /* The "set radix" and "show radix" commands are special in that
3349 they are like normal set and show commands but allow two normally
3350 independent variables to be either set or shown with a single
3351 command. So the usual deprecated_add_set_cmd() and [deleted]
3352 add_show_from_set() commands aren't really appropriate. */
3353 /* FIXME: i18n: With the new add_setshow_integer command, that is no
3354 longer true - show can display anything. */
3355 add_cmd ("radix", class_support
, set_radix
, _("\
3356 Set default input and output number radices.\n\
3357 Use 'set input-radix' or 'set output-radix' to independently set each.\n\
3358 Without an argument, sets both radices back to the default value of 10."),
3360 add_cmd ("radix", class_support
, show_radix
, _("\
3361 Show the default input and output number radices.\n\
3362 Use 'show input-radix' or 'show output-radix' to independently show each."),