1 /* Support for printing C++ values for GDB, the GNU debugger.
3 Copyright (C) 1986-2019 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_obstack.h"
24 #include "expression.h"
34 #include "cp-support.h"
36 #include "extension.h"
37 #include "typeprint.h"
38 #include "common/byte-vector.h"
40 /* Controls printing of vtbl's. */
42 show_vtblprint (struct ui_file *file, int from_tty,
43 struct cmd_list_element *c, const char *value)
45 fprintf_filtered (file, _("\
46 Printing of C++ virtual function tables is %s.\n"),
50 /* Controls looking up an object's derived type using what we find in
53 show_objectprint (struct ui_file *file, int from_tty,
54 struct cmd_list_element *c,
57 fprintf_filtered (file, _("\
58 Printing of object's derived type based on vtable info is %s.\n"),
63 show_static_field_print (struct ui_file *file, int from_tty,
64 struct cmd_list_element *c,
67 fprintf_filtered (file,
68 _("Printing of C++ static members is %s.\n"),
73 static struct obstack dont_print_vb_obstack;
74 static struct obstack dont_print_statmem_obstack;
75 static struct obstack dont_print_stat_array_obstack;
77 static void cp_print_static_field (struct type *, struct value *,
78 struct ui_file *, int,
79 const struct value_print_options *);
81 static void cp_print_value (struct type *, struct type *,
83 CORE_ADDR, struct ui_file *,
85 const struct value_print_options *,
89 /* GCC versions after 2.4.5 use this. */
90 extern const char vtbl_ptr_name[] = "__vtbl_ptr_type";
92 /* Return truth value for assertion that TYPE is of the type
93 "pointer to virtual function". */
96 cp_is_vtbl_ptr_type (struct type *type)
98 const char *type_name = TYPE_NAME (type);
100 return (type_name != NULL && !strcmp (type_name, vtbl_ptr_name));
103 /* Return truth value for the assertion that TYPE is of the type
104 "pointer to virtual function table". */
107 cp_is_vtbl_member (struct type *type)
109 /* With older versions of g++, the vtbl field pointed to an array of
110 structures. Nowadays it points directly to the structure. */
111 if (TYPE_CODE (type) == TYPE_CODE_PTR)
113 type = TYPE_TARGET_TYPE (type);
114 if (TYPE_CODE (type) == TYPE_CODE_ARRAY)
116 type = TYPE_TARGET_TYPE (type);
117 if (TYPE_CODE (type) == TYPE_CODE_STRUCT /* if not using thunks */
118 || TYPE_CODE (type) == TYPE_CODE_PTR) /* if using thunks */
120 /* Virtual functions tables are full of pointers
121 to virtual functions. */
122 return cp_is_vtbl_ptr_type (type);
125 else if (TYPE_CODE (type) == TYPE_CODE_STRUCT) /* if not using thunks */
127 return cp_is_vtbl_ptr_type (type);
129 else if (TYPE_CODE (type) == TYPE_CODE_PTR) /* if using thunks */
131 /* The type name of the thunk pointer is NULL when using
132 dwarf2. We could test for a pointer to a function, but
133 there is no type info for the virtual table either, so it
135 return cp_is_vtbl_ptr_type (type);
141 /* Mutually recursive subroutines of cp_print_value and c_val_print to
142 print out a structure's fields: cp_print_value_fields and
145 TYPE, VALADDR, ADDRESS, STREAM, RECURSE, and OPTIONS have the same
146 meanings as in cp_print_value and c_val_print.
148 2nd argument REAL_TYPE is used to carry over the type of the
149 derived class across the recursion to base classes.
151 DONT_PRINT is an array of baseclass types that we should not print,
152 or zero if called from top level. */
155 cp_print_value_fields (struct type *type, struct type *real_type,
157 CORE_ADDR address, struct ui_file *stream,
158 int recurse, struct value *val,
159 const struct value_print_options *options,
160 struct type **dont_print_vb,
161 int dont_print_statmem)
163 int i, len, n_baseclasses;
165 static int last_set_recurse = -1;
167 type = check_typedef (type);
171 /* Any object can be left on obstacks only during an unexpected
174 if (obstack_object_size (&dont_print_statmem_obstack) > 0)
176 obstack_free (&dont_print_statmem_obstack, NULL);
177 obstack_begin (&dont_print_statmem_obstack,
178 32 * sizeof (CORE_ADDR));
180 if (obstack_object_size (&dont_print_stat_array_obstack) > 0)
182 obstack_free (&dont_print_stat_array_obstack, NULL);
183 obstack_begin (&dont_print_stat_array_obstack,
184 32 * sizeof (struct type *));
188 fprintf_filtered (stream, "{");
189 len = TYPE_NFIELDS (type);
190 n_baseclasses = TYPE_N_BASECLASSES (type);
192 /* First, print out baseclasses such that we don't print
193 duplicates of virtual baseclasses. */
195 if (n_baseclasses > 0)
196 cp_print_value (type, real_type,
197 offset, address, stream,
198 recurse + 1, val, options,
201 /* Second, print out data fields */
203 /* If there are no data fields, skip this part */
204 if (len == n_baseclasses || !len)
205 fprintf_filtered (stream, "<No data fields>");
208 size_t statmem_obstack_initial_size = 0;
209 size_t stat_array_obstack_initial_size = 0;
210 struct type *vptr_basetype = NULL;
213 if (dont_print_statmem == 0)
215 statmem_obstack_initial_size =
216 obstack_object_size (&dont_print_statmem_obstack);
218 if (last_set_recurse != recurse)
220 stat_array_obstack_initial_size =
221 obstack_object_size (&dont_print_stat_array_obstack);
223 last_set_recurse = recurse;
227 vptr_fieldno = get_vptr_fieldno (type, &vptr_basetype);
228 for (i = n_baseclasses; i < len; i++)
230 const gdb_byte *valaddr = value_contents_for_printing (val);
232 /* If requested, skip printing of static fields. */
233 if (!options->static_field_print
234 && field_is_static (&TYPE_FIELD (type, i)))
238 fprintf_filtered (stream, ", ");
239 else if (n_baseclasses > 0)
241 if (options->prettyformat)
243 fprintf_filtered (stream, "\n");
244 print_spaces_filtered (2 + 2 * recurse, stream);
245 fputs_filtered ("members of ", stream);
246 fputs_filtered (TYPE_NAME (type), stream);
247 fputs_filtered (": ", stream);
252 if (options->prettyformat)
254 fprintf_filtered (stream, "\n");
255 print_spaces_filtered (2 + 2 * recurse, stream);
259 wrap_here (n_spaces (2 + 2 * recurse));
262 annotate_field_begin (TYPE_FIELD_TYPE (type, i));
264 if (field_is_static (&TYPE_FIELD (type, i)))
265 fputs_filtered ("static ", stream);
266 fprintf_symbol_filtered (stream,
267 TYPE_FIELD_NAME (type, i),
268 current_language->la_language,
269 DMGL_PARAMS | DMGL_ANSI);
270 annotate_field_name_end ();
271 /* Do not print leading '=' in case of anonymous
273 if (strcmp (TYPE_FIELD_NAME (type, i), ""))
274 fputs_filtered (" = ", stream);
275 annotate_field_value ();
277 if (!field_is_static (&TYPE_FIELD (type, i))
278 && TYPE_FIELD_PACKED (type, i))
282 /* Bitfields require special handling, especially due to
283 byte order problems. */
284 if (TYPE_FIELD_IGNORE (type, i))
286 fputs_filtered ("<optimized out or zero length>", stream);
288 else if (value_bits_synthetic_pointer (val,
289 TYPE_FIELD_BITPOS (type,
291 TYPE_FIELD_BITSIZE (type,
294 fputs_filtered (_("<synthetic pointer>"), stream);
298 struct value_print_options opts = *options;
302 v = value_field_bitfield (type, i, valaddr, offset, val);
304 common_val_print (v, stream, recurse + 1, &opts,
310 if (TYPE_FIELD_IGNORE (type, i))
312 fputs_filtered ("<optimized out or zero length>",
315 else if (field_is_static (&TYPE_FIELD (type, i)))
319 struct value *v = value_static_field (type, i);
321 cp_print_static_field (TYPE_FIELD_TYPE (type, i),
322 v, stream, recurse + 1,
325 CATCH (ex, RETURN_MASK_ERROR)
327 fprintf_filtered (stream,
328 _("<error reading variable: %s>"),
333 else if (i == vptr_fieldno && type == vptr_basetype)
335 int i_offset = offset + TYPE_FIELD_BITPOS (type, i) / 8;
336 struct type *i_type = TYPE_FIELD_TYPE (type, i);
338 if (valprint_check_validity (stream, i_type, i_offset, val))
342 addr = extract_typed_address (valaddr + i_offset, i_type);
343 print_function_pointer_address (options,
344 get_type_arch (type),
350 struct value_print_options opts = *options;
353 val_print (TYPE_FIELD_TYPE (type, i),
354 offset + TYPE_FIELD_BITPOS (type, i) / 8,
356 stream, recurse + 1, val, &opts,
360 annotate_field_end ();
363 if (dont_print_statmem == 0)
365 size_t obstack_final_size =
366 obstack_object_size (&dont_print_statmem_obstack);
368 if (obstack_final_size > statmem_obstack_initial_size)
370 /* In effect, a pop of the printed-statics stack. */
372 = statmem_obstack_initial_size - obstack_final_size;
373 obstack_blank_fast (&dont_print_statmem_obstack, shrink_bytes);
376 if (last_set_recurse != recurse)
379 obstack_object_size (&dont_print_stat_array_obstack);
381 if (obstack_final_size > stat_array_obstack_initial_size)
384 (char *) obstack_next_free (&dont_print_stat_array_obstack)
385 - (obstack_final_size
386 - stat_array_obstack_initial_size);
388 obstack_free (&dont_print_stat_array_obstack,
391 last_set_recurse = -1;
395 if (options->prettyformat)
397 fprintf_filtered (stream, "\n");
398 print_spaces_filtered (2 * recurse, stream);
400 } /* if there are data fields */
402 fprintf_filtered (stream, "}");
405 /* Like cp_print_value_fields, but find the runtime type of the object
406 and pass it as the `real_type' argument to cp_print_value_fields.
407 This function is a hack to work around the fact that
408 common_val_print passes the embedded offset to val_print, but not
409 the enclosing type. */
412 cp_print_value_fields_rtti (struct type *type,
413 const gdb_byte *valaddr, LONGEST offset,
415 struct ui_file *stream, int recurse,
417 const struct value_print_options *options,
418 struct type **dont_print_vb,
419 int dont_print_statmem)
421 struct type *real_type = NULL;
423 /* We require all bits to be valid in order to attempt a
425 if (!value_bits_any_optimized_out (val,
426 TARGET_CHAR_BIT * offset,
427 TARGET_CHAR_BIT * TYPE_LENGTH (type)))
433 /* Ugh, we have to convert back to a value here. */
434 value = value_from_contents_and_address (type, valaddr + offset,
436 type = value_type (value);
437 /* We don't actually care about most of the result here -- just
438 the type. We already have the correct offset, due to how
439 val_print was initially called. */
440 real_type = value_rtti_type (value, &full, &top, &using_enc);
446 cp_print_value_fields (type, real_type, offset,
447 address, stream, recurse, val, options,
448 dont_print_vb, dont_print_statmem);
451 /* Special val_print routine to avoid printing multiple copies of
452 virtual baseclasses. */
455 cp_print_value (struct type *type, struct type *real_type,
457 CORE_ADDR address, struct ui_file *stream,
458 int recurse, struct value *val,
459 const struct value_print_options *options,
460 struct type **dont_print_vb)
462 struct type **last_dont_print
463 = (struct type **) obstack_next_free (&dont_print_vb_obstack);
464 struct obstack tmp_obstack = dont_print_vb_obstack;
465 int i, n_baseclasses = TYPE_N_BASECLASSES (type);
467 struct type *thistype;
468 const gdb_byte *valaddr = value_contents_for_printing (val);
470 if (dont_print_vb == 0)
472 /* If we're at top level, carve out a completely fresh chunk of
473 the obstack and use that until this particular invocation
475 /* Bump up the high-water mark. Now alpha is omega. */
476 obstack_finish (&dont_print_vb_obstack);
479 for (i = 0; i < n_baseclasses; i++)
483 struct type *baseclass = check_typedef (TYPE_BASECLASS (type, i));
484 const char *basename = TYPE_NAME (baseclass);
485 struct value *base_val = NULL;
487 if (BASETYPE_VIA_VIRTUAL (type, i))
489 struct type **first_dont_print
490 = (struct type **) obstack_base (&dont_print_vb_obstack);
492 int j = (struct type **)
493 obstack_next_free (&dont_print_vb_obstack) - first_dont_print;
496 if (baseclass == first_dont_print[j])
499 obstack_ptr_grow (&dont_print_vb_obstack, baseclass);
503 thistype = real_type;
507 boffset = baseclass_offset (type, i, valaddr, offset, address, val);
509 CATCH (ex, RETURN_MASK_ERROR)
511 if (ex.error == NOT_AVAILABLE_ERROR)
520 if (BASETYPE_VIA_VIRTUAL (type, i))
522 /* The virtual base class pointer might have been
523 clobbered by the user program. Make sure that it
524 still points to a valid memory location. */
526 if ((boffset + offset) < 0
527 || (boffset + offset) >= TYPE_LENGTH (real_type))
529 gdb::byte_vector buf (TYPE_LENGTH (baseclass));
531 if (target_read_memory (address + boffset, buf.data (),
532 TYPE_LENGTH (baseclass)) != 0)
534 base_val = value_from_contents_and_address (baseclass,
537 baseclass = value_type (base_val);
540 thistype = baseclass;
553 /* Now do the printing. */
554 if (options->prettyformat)
556 fprintf_filtered (stream, "\n");
557 print_spaces_filtered (2 * recurse, stream);
559 fputs_filtered ("<", stream);
560 /* Not sure what the best notation is in the case where there is
561 no baseclass name. */
562 fputs_filtered (basename ? basename : "", stream);
563 fputs_filtered ("> = ", stream);
566 val_print_unavailable (stream);
568 val_print_invalid_address (stream);
573 /* Attempt to run an extension language pretty-printer on the
574 baseclass if possible. */
577 = apply_ext_lang_val_pretty_printer (baseclass,
578 thisoffset + boffset,
579 value_address (base_val),
585 cp_print_value_fields (baseclass, thistype,
586 thisoffset + boffset,
587 value_address (base_val),
588 stream, recurse, base_val, options,
590 obstack_base (&dont_print_vb_obstack)),
593 fputs_filtered (", ", stream);
599 if (dont_print_vb == 0)
601 /* Free the space used to deal with the printing
602 of this type from top level. */
603 obstack_free (&dont_print_vb_obstack, last_dont_print);
604 /* Reset watermark so that we can continue protecting
605 ourselves from whatever we were protecting ourselves. */
606 dont_print_vb_obstack = tmp_obstack;
610 /* Print value of a static member. To avoid infinite recursion when
611 printing a class that contains a static instance of the class, we
612 keep the addresses of all printed static member classes in an
613 obstack and refuse to print them more than once.
615 VAL contains the value to print, TYPE, STREAM, RECURSE, and OPTIONS
616 have the same meanings as in c_val_print. */
619 cp_print_static_field (struct type *type,
621 struct ui_file *stream,
623 const struct value_print_options *options)
625 struct value_print_options opts;
627 if (value_entirely_optimized_out (val))
629 val_print_optimized_out (val, stream);
633 struct type *real_type = check_typedef (type);
634 if (TYPE_CODE (real_type) == TYPE_CODE_STRUCT)
636 CORE_ADDR *first_dont_print;
641 = (CORE_ADDR *) obstack_base (&dont_print_statmem_obstack);
642 i = obstack_object_size (&dont_print_statmem_obstack)
643 / sizeof (CORE_ADDR);
647 if (value_address (val) == first_dont_print[i])
649 fputs_filtered ("<same as static member of an already"
656 addr = value_address (val);
657 obstack_grow (&dont_print_statmem_obstack, (char *) &addr,
659 cp_print_value_fields (type, value_enclosing_type (val),
660 value_embedded_offset (val), addr,
661 stream, recurse, val,
666 if (TYPE_CODE (real_type) == TYPE_CODE_ARRAY)
668 struct type **first_dont_print;
670 struct type *target_type = TYPE_TARGET_TYPE (type);
673 = (struct type **) obstack_base (&dont_print_stat_array_obstack);
674 i = obstack_object_size (&dont_print_stat_array_obstack)
675 / sizeof (struct type *);
679 if (target_type == first_dont_print[i])
681 fputs_filtered ("<same as static member of an already"
688 obstack_grow (&dont_print_stat_array_obstack,
689 (char *) &target_type,
690 sizeof (struct type *));
696 value_embedded_offset (val),
698 stream, recurse, val,
699 &opts, current_language);
702 /* Find the field in *SELF, or its non-virtual base classes, with
703 bit offset OFFSET. Set *SELF to the containing type and *FIELDNO
704 to the containing field number. If OFFSET is not exactly at the
705 start of some field, set *SELF to NULL. */
708 cp_find_class_member (struct type **self_p, int *fieldno,
715 *self_p = check_typedef (*self_p);
717 len = TYPE_NFIELDS (self);
719 for (i = TYPE_N_BASECLASSES (self); i < len; i++)
721 LONGEST bitpos = TYPE_FIELD_BITPOS (self, i);
724 if (offset == bitpos)
731 for (i = 0; i < TYPE_N_BASECLASSES (self); i++)
733 LONGEST bitpos = TYPE_FIELD_BITPOS (self, i);
734 LONGEST bitsize = 8 * TYPE_LENGTH (TYPE_FIELD_TYPE (self, i));
736 if (offset >= bitpos && offset < bitpos + bitsize)
738 *self_p = TYPE_FIELD_TYPE (self, i);
739 cp_find_class_member (self_p, fieldno, offset - bitpos);
748 cp_print_class_member (const gdb_byte *valaddr, struct type *type,
749 struct ui_file *stream, const char *prefix)
751 enum bfd_endian byte_order = gdbarch_byte_order (get_type_arch (type));
753 /* VAL is a byte offset into the structure type SELF_TYPE.
754 Find the name of the field for that offset and
756 struct type *self_type = TYPE_SELF_TYPE (type);
760 val = extract_signed_integer (valaddr,
764 /* Pointers to data members are usually byte offsets into an object.
765 Because a data member can have offset zero, and a NULL pointer to
766 member must be distinct from any valid non-NULL pointer to
767 member, either the value is biased or the NULL value has a
768 special representation; both are permitted by ISO C++. HP aCC
769 used a bias of 0x20000000; HP cfront used a bias of 1; g++ 3.x
770 and other compilers which use the Itanium ABI use -1 as the NULL
771 value. GDB only supports that last form; to add support for
772 another form, make this into a cp-abi hook. */
776 fprintf_filtered (stream, "NULL");
780 cp_find_class_member (&self_type, &fieldno, val << 3);
782 if (self_type != NULL)
786 fputs_filtered (prefix, stream);
787 name = TYPE_NAME (self_type);
789 fputs_filtered (name, stream);
791 c_type_print_base (self_type, stream, 0, 0, &type_print_raw_options);
792 fprintf_filtered (stream, "::");
793 fputs_filtered (TYPE_FIELD_NAME (self_type, fieldno), stream);
796 fprintf_filtered (stream, "%ld", (long) val);
801 _initialize_cp_valprint (void)
803 add_setshow_boolean_cmd ("static-members", class_support,
804 &user_print_options.static_field_print, _("\
805 Set printing of C++ static members."), _("\
806 Show printing of C++ static members."), NULL,
808 show_static_field_print,
809 &setprintlist, &showprintlist);
811 add_setshow_boolean_cmd ("vtbl", class_support,
812 &user_print_options.vtblprint, _("\
813 Set printing of C++ virtual function tables."), _("\
814 Show printing of C++ virtual function tables."), NULL,
817 &setprintlist, &showprintlist);
819 add_setshow_boolean_cmd ("object", class_support,
820 &user_print_options.objectprint, _("\
821 Set printing of object's derived type based on vtable info."), _("\
822 Show printing of object's derived type based on vtable info."), NULL,
825 &setprintlist, &showprintlist);
827 obstack_begin (&dont_print_stat_array_obstack,
828 32 * sizeof (struct type *));
829 obstack_begin (&dont_print_statmem_obstack,
830 32 * sizeof (CORE_ADDR));
831 obstack_begin (&dont_print_vb_obstack,
832 32 * sizeof (struct type *));