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)))
317 struct value *v = NULL;
321 v = value_static_field (type, i);
324 CATCH (ex, RETURN_MASK_ERROR)
326 fprintf_filtered (stream,
327 _("<error reading variable: %s>"),
332 cp_print_static_field (TYPE_FIELD_TYPE (type, i),
333 v, stream, recurse + 1,
336 else if (i == vptr_fieldno && type == vptr_basetype)
338 int i_offset = offset + TYPE_FIELD_BITPOS (type, i) / 8;
339 struct type *i_type = TYPE_FIELD_TYPE (type, i);
341 if (valprint_check_validity (stream, i_type, i_offset, val))
345 addr = extract_typed_address (valaddr + i_offset, i_type);
346 print_function_pointer_address (options,
347 get_type_arch (type),
353 struct value_print_options opts = *options;
356 val_print (TYPE_FIELD_TYPE (type, i),
357 offset + TYPE_FIELD_BITPOS (type, i) / 8,
359 stream, recurse + 1, val, &opts,
363 annotate_field_end ();
366 if (dont_print_statmem == 0)
368 size_t obstack_final_size =
369 obstack_object_size (&dont_print_statmem_obstack);
371 if (obstack_final_size > statmem_obstack_initial_size)
373 /* In effect, a pop of the printed-statics stack. */
375 = statmem_obstack_initial_size - obstack_final_size;
376 obstack_blank_fast (&dont_print_statmem_obstack, shrink_bytes);
379 if (last_set_recurse != recurse)
382 obstack_object_size (&dont_print_stat_array_obstack);
384 if (obstack_final_size > stat_array_obstack_initial_size)
387 (char *) obstack_next_free (&dont_print_stat_array_obstack)
388 - (obstack_final_size
389 - stat_array_obstack_initial_size);
391 obstack_free (&dont_print_stat_array_obstack,
394 last_set_recurse = -1;
398 if (options->prettyformat)
400 fprintf_filtered (stream, "\n");
401 print_spaces_filtered (2 * recurse, stream);
403 } /* if there are data fields */
405 fprintf_filtered (stream, "}");
408 /* Like cp_print_value_fields, but find the runtime type of the object
409 and pass it as the `real_type' argument to cp_print_value_fields.
410 This function is a hack to work around the fact that
411 common_val_print passes the embedded offset to val_print, but not
412 the enclosing type. */
415 cp_print_value_fields_rtti (struct type *type,
416 const gdb_byte *valaddr, LONGEST offset,
418 struct ui_file *stream, int recurse,
420 const struct value_print_options *options,
421 struct type **dont_print_vb,
422 int dont_print_statmem)
424 struct type *real_type = NULL;
426 /* We require all bits to be valid in order to attempt a
428 if (!value_bits_any_optimized_out (val,
429 TARGET_CHAR_BIT * offset,
430 TARGET_CHAR_BIT * TYPE_LENGTH (type)))
436 /* Ugh, we have to convert back to a value here. */
437 value = value_from_contents_and_address (type, valaddr + offset,
439 type = value_type (value);
440 /* We don't actually care about most of the result here -- just
441 the type. We already have the correct offset, due to how
442 val_print was initially called. */
443 real_type = value_rtti_type (value, &full, &top, &using_enc);
449 cp_print_value_fields (type, real_type, offset,
450 address, stream, recurse, val, options,
451 dont_print_vb, dont_print_statmem);
454 /* Special val_print routine to avoid printing multiple copies of
455 virtual baseclasses. */
458 cp_print_value (struct type *type, struct type *real_type,
460 CORE_ADDR address, struct ui_file *stream,
461 int recurse, struct value *val,
462 const struct value_print_options *options,
463 struct type **dont_print_vb)
465 struct type **last_dont_print
466 = (struct type **) obstack_next_free (&dont_print_vb_obstack);
467 struct obstack tmp_obstack = dont_print_vb_obstack;
468 int i, n_baseclasses = TYPE_N_BASECLASSES (type);
470 struct type *thistype;
471 const gdb_byte *valaddr = value_contents_for_printing (val);
473 if (dont_print_vb == 0)
475 /* If we're at top level, carve out a completely fresh chunk of
476 the obstack and use that until this particular invocation
478 /* Bump up the high-water mark. Now alpha is omega. */
479 obstack_finish (&dont_print_vb_obstack);
482 for (i = 0; i < n_baseclasses; i++)
486 struct type *baseclass = check_typedef (TYPE_BASECLASS (type, i));
487 const char *basename = TYPE_NAME (baseclass);
488 struct value *base_val = NULL;
490 if (BASETYPE_VIA_VIRTUAL (type, i))
492 struct type **first_dont_print
493 = (struct type **) obstack_base (&dont_print_vb_obstack);
495 int j = (struct type **)
496 obstack_next_free (&dont_print_vb_obstack) - first_dont_print;
499 if (baseclass == first_dont_print[j])
502 obstack_ptr_grow (&dont_print_vb_obstack, baseclass);
506 thistype = real_type;
510 boffset = baseclass_offset (type, i, valaddr, offset, address, val);
512 CATCH (ex, RETURN_MASK_ERROR)
514 if (ex.error == NOT_AVAILABLE_ERROR)
523 if (BASETYPE_VIA_VIRTUAL (type, i))
525 /* The virtual base class pointer might have been
526 clobbered by the user program. Make sure that it
527 still points to a valid memory location. */
529 if ((boffset + offset) < 0
530 || (boffset + offset) >= TYPE_LENGTH (real_type))
532 gdb::byte_vector buf (TYPE_LENGTH (baseclass));
534 if (target_read_memory (address + boffset, buf.data (),
535 TYPE_LENGTH (baseclass)) != 0)
537 base_val = value_from_contents_and_address (baseclass,
540 baseclass = value_type (base_val);
543 thistype = baseclass;
556 /* Now do the printing. */
557 if (options->prettyformat)
559 fprintf_filtered (stream, "\n");
560 print_spaces_filtered (2 * recurse, stream);
562 fputs_filtered ("<", stream);
563 /* Not sure what the best notation is in the case where there is
564 no baseclass name. */
565 fputs_filtered (basename ? basename : "", stream);
566 fputs_filtered ("> = ", stream);
569 val_print_unavailable (stream);
571 val_print_invalid_address (stream);
576 /* Attempt to run an extension language pretty-printer on the
577 baseclass if possible. */
580 = apply_ext_lang_val_pretty_printer (baseclass,
581 thisoffset + boffset,
582 value_address (base_val),
588 cp_print_value_fields (baseclass, thistype,
589 thisoffset + boffset,
590 value_address (base_val),
591 stream, recurse, base_val, options,
593 obstack_base (&dont_print_vb_obstack)),
596 fputs_filtered (", ", stream);
602 if (dont_print_vb == 0)
604 /* Free the space used to deal with the printing
605 of this type from top level. */
606 obstack_free (&dont_print_vb_obstack, last_dont_print);
607 /* Reset watermark so that we can continue protecting
608 ourselves from whatever we were protecting ourselves. */
609 dont_print_vb_obstack = tmp_obstack;
613 /* Print value of a static member. To avoid infinite recursion when
614 printing a class that contains a static instance of the class, we
615 keep the addresses of all printed static member classes in an
616 obstack and refuse to print them more than once.
618 VAL contains the value to print, TYPE, STREAM, RECURSE, and OPTIONS
619 have the same meanings as in c_val_print. */
622 cp_print_static_field (struct type *type,
624 struct ui_file *stream,
626 const struct value_print_options *options)
628 struct value_print_options opts;
630 if (value_entirely_optimized_out (val))
632 val_print_optimized_out (val, stream);
636 struct type *real_type = check_typedef (type);
637 if (TYPE_CODE (real_type) == TYPE_CODE_STRUCT)
639 CORE_ADDR *first_dont_print;
644 = (CORE_ADDR *) obstack_base (&dont_print_statmem_obstack);
645 i = obstack_object_size (&dont_print_statmem_obstack)
646 / sizeof (CORE_ADDR);
650 if (value_address (val) == first_dont_print[i])
652 fputs_filtered ("<same as static member of an already"
659 addr = value_address (val);
660 obstack_grow (&dont_print_statmem_obstack, (char *) &addr,
662 cp_print_value_fields (type, value_enclosing_type (val),
663 value_embedded_offset (val), addr,
664 stream, recurse, val,
669 if (TYPE_CODE (real_type) == TYPE_CODE_ARRAY)
671 struct type **first_dont_print;
673 struct type *target_type = TYPE_TARGET_TYPE (type);
676 = (struct type **) obstack_base (&dont_print_stat_array_obstack);
677 i = obstack_object_size (&dont_print_stat_array_obstack)
678 / sizeof (struct type *);
682 if (target_type == first_dont_print[i])
684 fputs_filtered ("<same as static member of an already"
691 obstack_grow (&dont_print_stat_array_obstack,
692 (char *) &target_type,
693 sizeof (struct type *));
699 value_embedded_offset (val),
701 stream, recurse, val,
702 &opts, current_language);
705 /* Find the field in *SELF, or its non-virtual base classes, with
706 bit offset OFFSET. Set *SELF to the containing type and *FIELDNO
707 to the containing field number. If OFFSET is not exactly at the
708 start of some field, set *SELF to NULL. */
711 cp_find_class_member (struct type **self_p, int *fieldno,
718 *self_p = check_typedef (*self_p);
720 len = TYPE_NFIELDS (self);
722 for (i = TYPE_N_BASECLASSES (self); i < len; i++)
724 LONGEST bitpos = TYPE_FIELD_BITPOS (self, i);
727 if (offset == bitpos)
734 for (i = 0; i < TYPE_N_BASECLASSES (self); i++)
736 LONGEST bitpos = TYPE_FIELD_BITPOS (self, i);
737 LONGEST bitsize = 8 * TYPE_LENGTH (TYPE_FIELD_TYPE (self, i));
739 if (offset >= bitpos && offset < bitpos + bitsize)
741 *self_p = TYPE_FIELD_TYPE (self, i);
742 cp_find_class_member (self_p, fieldno, offset - bitpos);
751 cp_print_class_member (const gdb_byte *valaddr, struct type *type,
752 struct ui_file *stream, const char *prefix)
754 enum bfd_endian byte_order = gdbarch_byte_order (get_type_arch (type));
756 /* VAL is a byte offset into the structure type SELF_TYPE.
757 Find the name of the field for that offset and
759 struct type *self_type = TYPE_SELF_TYPE (type);
763 val = extract_signed_integer (valaddr,
767 /* Pointers to data members are usually byte offsets into an object.
768 Because a data member can have offset zero, and a NULL pointer to
769 member must be distinct from any valid non-NULL pointer to
770 member, either the value is biased or the NULL value has a
771 special representation; both are permitted by ISO C++. HP aCC
772 used a bias of 0x20000000; HP cfront used a bias of 1; g++ 3.x
773 and other compilers which use the Itanium ABI use -1 as the NULL
774 value. GDB only supports that last form; to add support for
775 another form, make this into a cp-abi hook. */
779 fprintf_filtered (stream, "NULL");
783 cp_find_class_member (&self_type, &fieldno, val << 3);
785 if (self_type != NULL)
789 fputs_filtered (prefix, stream);
790 name = TYPE_NAME (self_type);
792 fputs_filtered (name, stream);
794 c_type_print_base (self_type, stream, 0, 0, &type_print_raw_options);
795 fprintf_filtered (stream, "::");
796 fputs_filtered (TYPE_FIELD_NAME (self_type, fieldno), stream);
799 fprintf_filtered (stream, "%ld", (long) val);
804 _initialize_cp_valprint (void)
806 add_setshow_boolean_cmd ("static-members", class_support,
807 &user_print_options.static_field_print, _("\
808 Set printing of C++ static members."), _("\
809 Show printing of C++ static members."), NULL,
811 show_static_field_print,
812 &setprintlist, &showprintlist);
814 add_setshow_boolean_cmd ("vtbl", class_support,
815 &user_print_options.vtblprint, _("\
816 Set printing of C++ virtual function tables."), _("\
817 Show printing of C++ virtual function tables."), NULL,
820 &setprintlist, &showprintlist);
822 add_setshow_boolean_cmd ("object", class_support,
823 &user_print_options.objectprint, _("\
824 Set printing of object's derived type based on vtable info."), _("\
825 Show printing of object's derived type based on vtable info."), NULL,
828 &setprintlist, &showprintlist);
830 obstack_begin (&dont_print_stat_array_obstack,
831 32 * sizeof (struct type *));
832 obstack_begin (&dont_print_statmem_obstack,
833 32 * sizeof (CORE_ADDR));
834 obstack_begin (&dont_print_vb_obstack,
835 32 * sizeof (struct type *));