1 /* Support for printing C++ values for GDB, the GNU debugger.
3 Copyright (C) 1986, 1988, 1989, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
4 2000, 2001, 2002, 2003, 2005, 2006, 2007, 2008, 2009, 2010
5 Free Software Foundation, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 #include "gdb_obstack.h"
26 #include "expression.h"
32 #include "gdb_string.h"
37 #include "cp-support.h"
39 #include "python/python.h"
41 /* Controls printing of vtbl's */
43 show_vtblprint (struct ui_file *file, int from_tty,
44 struct cmd_list_element *c, const char *value)
46 fprintf_filtered (file, _("\
47 Printing of C++ virtual function tables is %s.\n"),
51 /* Controls looking up an object's derived type using what we find in
54 show_objectprint (struct ui_file *file, int from_tty,
55 struct cmd_list_element *c,
58 fprintf_filtered (file, _("\
59 Printing of object's derived type based on vtable info is %s.\n"),
64 show_static_field_print (struct ui_file *file, int from_tty,
65 struct cmd_list_element *c, const char *value)
67 fprintf_filtered (file, _("Printing of C++ static members is %s.\n"),
72 static struct obstack dont_print_vb_obstack;
73 static struct obstack dont_print_statmem_obstack;
74 static struct obstack dont_print_stat_array_obstack;
76 extern void _initialize_cp_valprint (void);
78 static void cp_print_static_field (struct type *, struct value *,
79 struct ui_file *, int,
80 const struct value_print_options *);
82 static void cp_print_value (struct type *, struct type *, const gdb_byte *,
83 int, CORE_ADDR, struct ui_file *, int,
85 const struct value_print_options *, struct type **);
88 /* GCC versions after 2.4.5 use this. */
89 const char vtbl_ptr_name[] = "__vtbl_ptr_type";
91 /* Return truth value for assertion that TYPE is of the type
92 "pointer to virtual function". */
95 cp_is_vtbl_ptr_type (struct type *type)
97 char *typename = type_name_no_tag (type);
99 return (typename != NULL && !strcmp (typename, vtbl_ptr_name));
102 /* Return truth value for the assertion that TYPE is of the type
103 "pointer to virtual function table". */
106 cp_is_vtbl_member (struct type *type)
108 /* With older versions of g++, the vtbl field pointed to an array
109 of structures. Nowadays it points directly to the structure. */
110 if (TYPE_CODE (type) == TYPE_CODE_PTR)
112 type = TYPE_TARGET_TYPE (type);
113 if (TYPE_CODE (type) == TYPE_CODE_ARRAY)
115 type = TYPE_TARGET_TYPE (type);
116 if (TYPE_CODE (type) == TYPE_CODE_STRUCT /* if not using thunks */
117 || TYPE_CODE (type) == TYPE_CODE_PTR) /* if using thunks */
119 /* Virtual functions tables are full of pointers
120 to virtual functions. */
121 return cp_is_vtbl_ptr_type (type);
124 else if (TYPE_CODE (type) == TYPE_CODE_STRUCT) /* if not using thunks */
126 return cp_is_vtbl_ptr_type (type);
128 else if (TYPE_CODE (type) == TYPE_CODE_PTR) /* if using thunks */
130 /* The type name of the thunk pointer is NULL when using dwarf2.
131 We could test for a pointer to a function, but there is
132 no type info for the virtual table either, so it wont help. */
133 return cp_is_vtbl_ptr_type (type);
139 /* Mutually recursive subroutines of cp_print_value and c_val_print to
140 print out a structure's fields: cp_print_value_fields and cp_print_value.
142 TYPE, VALADDR, ADDRESS, STREAM, RECURSE, and OPTIONS have the
143 same meanings as in cp_print_value and c_val_print.
145 2nd argument REAL_TYPE is used to carry over the type of the derived
146 class across the recursion to base classes.
148 DONT_PRINT is an array of baseclass types that we
149 should not print, or zero if called from top level. */
152 cp_print_value_fields (struct type *type, struct type *real_type,
153 const gdb_byte *valaddr, int offset, CORE_ADDR address,
154 struct ui_file *stream, int recurse,
155 const struct value *val,
156 const struct value_print_options *options,
157 struct type **dont_print_vb, int dont_print_statmem)
159 int i, len, n_baseclasses;
161 static int last_set_recurse = -1;
163 CHECK_TYPEDEF (type);
167 /* Any object can be left on obstacks only during an unexpected error. */
169 if (obstack_object_size (&dont_print_statmem_obstack) > 0)
171 obstack_free (&dont_print_statmem_obstack, NULL);
172 obstack_begin (&dont_print_statmem_obstack, 32 * sizeof (CORE_ADDR));
174 if (obstack_object_size (&dont_print_stat_array_obstack) > 0)
176 obstack_free (&dont_print_stat_array_obstack, NULL);
177 obstack_begin (&dont_print_stat_array_obstack,
178 32 * sizeof (struct type *));
182 fprintf_filtered (stream, "{");
183 len = TYPE_NFIELDS (type);
184 n_baseclasses = TYPE_N_BASECLASSES (type);
186 /* First, print out baseclasses such that we don't print
187 duplicates of virtual baseclasses. */
189 if (n_baseclasses > 0)
190 cp_print_value (type, real_type, valaddr, offset, address, stream,
191 recurse + 1, val, options, dont_print_vb);
193 /* Second, print out data fields */
195 /* If there are no data fields, skip this part */
196 if (len == n_baseclasses || !len)
197 fprintf_filtered (stream, "<No data fields>");
200 int statmem_obstack_initial_size = 0;
201 int stat_array_obstack_initial_size = 0;
203 if (dont_print_statmem == 0)
205 statmem_obstack_initial_size =
206 obstack_object_size (&dont_print_statmem_obstack);
208 if (last_set_recurse != recurse)
210 stat_array_obstack_initial_size =
211 obstack_object_size (&dont_print_stat_array_obstack);
213 last_set_recurse = recurse;
217 for (i = n_baseclasses; i < len; i++)
219 /* If requested, skip printing of static fields. */
220 if (!options->static_field_print
221 && field_is_static (&TYPE_FIELD (type, i)))
225 fprintf_filtered (stream, ", ");
226 else if (n_baseclasses > 0)
230 fprintf_filtered (stream, "\n");
231 print_spaces_filtered (2 + 2 * recurse, stream);
232 fputs_filtered ("members of ", stream);
233 fputs_filtered (type_name_no_tag (type), stream);
234 fputs_filtered (": ", stream);
241 fprintf_filtered (stream, "\n");
242 print_spaces_filtered (2 + 2 * recurse, stream);
246 wrap_here (n_spaces (2 + 2 * recurse));
248 if (options->inspect_it)
250 if (TYPE_CODE (TYPE_FIELD_TYPE (type, i)) == TYPE_CODE_PTR)
251 fputs_filtered ("\"( ptr \"", stream);
253 fputs_filtered ("\"( nodef \"", stream);
254 if (field_is_static (&TYPE_FIELD (type, i)))
255 fputs_filtered ("static ", stream);
256 fprintf_symbol_filtered (stream, TYPE_FIELD_NAME (type, i),
257 current_language->la_language,
258 DMGL_PARAMS | DMGL_ANSI);
259 fputs_filtered ("\" \"", stream);
260 fprintf_symbol_filtered (stream, TYPE_FIELD_NAME (type, i),
261 current_language->la_language,
262 DMGL_PARAMS | DMGL_ANSI);
263 fputs_filtered ("\") \"", stream);
267 annotate_field_begin (TYPE_FIELD_TYPE (type, i));
269 if (field_is_static (&TYPE_FIELD (type, i)))
270 fputs_filtered ("static ", stream);
271 fprintf_symbol_filtered (stream, TYPE_FIELD_NAME (type, i),
272 current_language->la_language,
273 DMGL_PARAMS | DMGL_ANSI);
274 annotate_field_name_end ();
275 /* do not print leading '=' in case of anonymous unions */
276 if (strcmp (TYPE_FIELD_NAME (type, i), ""))
277 fputs_filtered (" = ", stream);
278 annotate_field_value ();
281 if (!field_is_static (&TYPE_FIELD (type, i))
282 && TYPE_FIELD_PACKED (type, i))
286 /* Bitfields require special handling, especially due to byte
288 if (TYPE_FIELD_IGNORE (type, i))
290 fputs_filtered ("<optimized out or zero length>", stream);
292 else if (!value_bits_valid (val, TYPE_FIELD_BITPOS (type, i),
293 TYPE_FIELD_BITSIZE (type, i)))
295 fputs_filtered (_("<value optimized out>"), stream);
299 struct value_print_options opts = *options;
302 v = value_from_longest
303 (TYPE_FIELD_TYPE (type, i),
304 unpack_field_as_long (type, valaddr + offset, i));
306 common_val_print (v, stream, recurse + 1, &opts,
312 if (TYPE_FIELD_IGNORE (type, i))
314 fputs_filtered ("<optimized out or zero length>", stream);
316 else if (field_is_static (&TYPE_FIELD (type, i)))
318 struct value *v = value_static_field (type, i);
321 fputs_filtered ("<optimized out>", stream);
323 cp_print_static_field (TYPE_FIELD_TYPE (type, i), v,
324 stream, recurse + 1, options);
328 struct value_print_options opts = *options;
331 val_print (TYPE_FIELD_TYPE (type, i),
332 valaddr, offset + TYPE_FIELD_BITPOS (type, i) / 8,
334 stream, recurse + 1, val, &opts,
338 annotate_field_end ();
341 if (dont_print_statmem == 0)
343 int obstack_final_size =
344 obstack_object_size (&dont_print_statmem_obstack);
346 if (obstack_final_size > statmem_obstack_initial_size) {
347 /* In effect, a pop of the printed-statics stack. */
350 obstack_next_free (&dont_print_statmem_obstack) -
351 (obstack_final_size - statmem_obstack_initial_size);
353 obstack_free (&dont_print_statmem_obstack,
357 if (last_set_recurse != recurse)
359 int obstack_final_size =
360 obstack_object_size (&dont_print_stat_array_obstack);
362 if (obstack_final_size > stat_array_obstack_initial_size)
365 obstack_next_free (&dont_print_stat_array_obstack) -
366 (obstack_final_size - stat_array_obstack_initial_size);
368 obstack_free (&dont_print_stat_array_obstack,
371 last_set_recurse = -1;
377 fprintf_filtered (stream, "\n");
378 print_spaces_filtered (2 * recurse, stream);
380 } /* if there are data fields */
382 fprintf_filtered (stream, "}");
385 /* Like cp_print_value_fields, but find the runtime type of the object
386 and pass it as the `real_type' argument to cp_print_value_fields.
387 This function is a hack to work around the fact that
388 common_val_print passes the embedded offset to val_print, but not
389 the enclosing type. */
392 cp_print_value_fields_rtti (struct type *type,
393 const gdb_byte *valaddr, int offset,
395 struct ui_file *stream, int recurse,
396 const struct value *val,
397 const struct value_print_options *options,
398 struct type **dont_print_vb,
399 int dont_print_statmem)
401 struct type *real_type = NULL;
403 /* We require all bits to be valid in order to attempt a
405 if (value_bits_valid (val, TARGET_CHAR_BIT * offset,
406 TARGET_CHAR_BIT * TYPE_LENGTH (type)))
409 int full, top, using_enc;
411 /* Ugh, we have to convert back to a value here. */
412 value = value_from_contents_and_address (type, valaddr + offset,
414 /* We don't actually care about most of the result here -- just the
415 type. We already have the correct offset, due to how val_print
416 was initially called. */
417 real_type = value_rtti_type (value, &full, &top, &using_enc);
423 cp_print_value_fields (type, real_type, valaddr, offset,
424 address, stream, recurse, val, options,
425 dont_print_vb, dont_print_statmem);
428 /* Special val_print routine to avoid printing multiple copies of virtual
432 cp_print_value (struct type *type, struct type *real_type,
433 const gdb_byte *valaddr, int offset, CORE_ADDR address,
434 struct ui_file *stream, int recurse,
435 const struct value *val,
436 const struct value_print_options *options,
437 struct type **dont_print_vb)
439 struct type **last_dont_print
440 = (struct type **) obstack_next_free (&dont_print_vb_obstack);
441 struct obstack tmp_obstack = dont_print_vb_obstack;
442 int i, n_baseclasses = TYPE_N_BASECLASSES (type);
444 struct type *thistype;
446 if (dont_print_vb == 0)
448 /* If we're at top level, carve out a completely fresh
449 chunk of the obstack and use that until this particular
450 invocation returns. */
451 /* Bump up the high-water mark. Now alpha is omega. */
452 obstack_finish (&dont_print_vb_obstack);
455 for (i = 0; i < n_baseclasses; i++)
459 struct type *baseclass = check_typedef (TYPE_BASECLASS (type, i));
460 char *basename = TYPE_NAME (baseclass);
461 const gdb_byte *base_valaddr;
463 if (BASETYPE_VIA_VIRTUAL (type, i))
465 struct type **first_dont_print
466 = (struct type **) obstack_base (&dont_print_vb_obstack);
468 int j = (struct type **) obstack_next_free (&dont_print_vb_obstack)
472 if (baseclass == first_dont_print[j])
475 obstack_ptr_grow (&dont_print_vb_obstack, baseclass);
479 thistype = real_type;
481 boffset = baseclass_offset (type, i, valaddr + offset, address + offset);
482 skip = ((boffset == -1) || (boffset + offset) < 0) ? 1 : -1;
484 if (BASETYPE_VIA_VIRTUAL (type, i))
486 /* The virtual base class pointer might have been
487 clobbered by the user program. Make sure that it
488 still points to a valid memory location. */
491 && ((boffset + offset) < 0
492 || (boffset + offset) >= TYPE_LENGTH (real_type)))
494 /* FIXME (alloca): unsafe if baseclass is really really large. */
495 gdb_byte *buf = alloca (TYPE_LENGTH (baseclass));
498 if (target_read_memory (address + boffset, buf,
499 TYPE_LENGTH (baseclass)) != 0)
501 address = address + boffset;
504 thistype = baseclass;
507 base_valaddr = valaddr;
510 base_valaddr = valaddr;
512 /* now do the printing */
515 fprintf_filtered (stream, "\n");
516 print_spaces_filtered (2 * recurse, stream);
518 fputs_filtered ("<", stream);
519 /* Not sure what the best notation is in the case where there is no
521 fputs_filtered (basename ? basename : "", stream);
522 fputs_filtered ("> = ", stream);
526 fprintf_filtered (stream, "<invalid address>");
531 /* Attempt to run the Python pretty-printers on the
532 baseclass if possible. */
534 result = apply_val_pretty_printer (baseclass, base_valaddr,
535 thisoffset + boffset,
537 stream, recurse, val,
542 cp_print_value_fields (baseclass, thistype, base_valaddr,
543 thisoffset + boffset, address,
544 stream, recurse, val, options,
546 obstack_base (&dont_print_vb_obstack)),
549 fputs_filtered (", ", stream);
555 if (dont_print_vb == 0)
557 /* Free the space used to deal with the printing
558 of this type from top level. */
559 obstack_free (&dont_print_vb_obstack, last_dont_print);
560 /* Reset watermark so that we can continue protecting
561 ourselves from whatever we were protecting ourselves. */
562 dont_print_vb_obstack = tmp_obstack;
566 /* Print value of a static member.
567 To avoid infinite recursion when printing a class that contains
568 a static instance of the class, we keep the addresses of all printed
569 static member classes in an obstack and refuse to print them more
572 VAL contains the value to print, TYPE, STREAM, RECURSE, and OPTIONS
573 have the same meanings as in c_val_print. */
576 cp_print_static_field (struct type *type,
578 struct ui_file *stream,
580 const struct value_print_options *options)
582 struct value_print_options opts;
584 if (TYPE_CODE (type) == TYPE_CODE_STRUCT)
586 CORE_ADDR *first_dont_print;
591 = (CORE_ADDR *) obstack_base (&dont_print_statmem_obstack);
592 i = obstack_object_size (&dont_print_statmem_obstack)
593 / sizeof (CORE_ADDR);
597 if (value_address (val) == first_dont_print[i])
599 fputs_filtered ("<same as static member of an already"
606 addr = value_address (val);
607 obstack_grow (&dont_print_statmem_obstack, (char *) &addr,
609 CHECK_TYPEDEF (type);
610 cp_print_value_fields (type, value_enclosing_type (val),
611 value_contents_for_printing (val),
612 value_embedded_offset (val), addr,
614 val, options, NULL, 1);
618 if (TYPE_CODE (type) == TYPE_CODE_ARRAY)
620 struct type **first_dont_print;
622 struct type *target_type = TYPE_TARGET_TYPE (type);
625 = (struct type **) obstack_base (&dont_print_stat_array_obstack);
626 i = obstack_object_size (&dont_print_stat_array_obstack)
627 / sizeof (struct type *);
631 if (target_type == first_dont_print[i])
633 fputs_filtered ("<same as static member of an already"
640 obstack_grow (&dont_print_stat_array_obstack, (char *) &target_type,
641 sizeof (struct type *));
646 val_print (type, value_contents_for_printing (val),
647 value_embedded_offset (val), value_address (val),
649 val, &opts, current_language);
653 /* Find the field in *DOMAIN, or its non-virtual base classes, with bit offset
654 OFFSET. Set *DOMAIN to the containing type and *FIELDNO to the containing
655 field number. If OFFSET is not exactly at the start of some field, set
659 cp_find_class_member (struct type **domain_p, int *fieldno,
666 *domain_p = check_typedef (*domain_p);
668 len = TYPE_NFIELDS (domain);
670 for (i = TYPE_N_BASECLASSES (domain); i < len; i++)
672 LONGEST bitpos = TYPE_FIELD_BITPOS (domain, i);
675 if (offset == bitpos)
682 for (i = 0; i < TYPE_N_BASECLASSES (domain); i++)
684 LONGEST bitpos = TYPE_FIELD_BITPOS (domain, i);
685 LONGEST bitsize = 8 * TYPE_LENGTH (TYPE_FIELD_TYPE (domain, i));
687 if (offset >= bitpos && offset < bitpos + bitsize)
689 *domain_p = TYPE_FIELD_TYPE (domain, i);
690 cp_find_class_member (domain_p, fieldno, offset - bitpos);
699 cp_print_class_member (const gdb_byte *valaddr, struct type *type,
700 struct ui_file *stream, char *prefix)
702 enum bfd_endian byte_order = gdbarch_byte_order (get_type_arch (type));
704 /* VAL is a byte offset into the structure type DOMAIN.
705 Find the name of the field for that offset and
707 struct type *domain = TYPE_DOMAIN_TYPE (type);
709 unsigned int fieldno;
711 val = extract_signed_integer (valaddr, TYPE_LENGTH (type), byte_order);
713 /* Pointers to data members are usually byte offsets into an object.
714 Because a data member can have offset zero, and a NULL pointer to
715 member must be distinct from any valid non-NULL pointer to
716 member, either the value is biased or the NULL value has a
717 special representation; both are permitted by ISO C++. HP aCC
718 used a bias of 0x20000000; HP cfront used a bias of 1; g++ 3.x
719 and other compilers which use the Itanium ABI use -1 as the NULL
720 value. GDB only supports that last form; to add support for
721 another form, make this into a cp-abi hook. */
725 fprintf_filtered (stream, "NULL");
729 cp_find_class_member (&domain, &fieldno, val << 3);
735 fputs_filtered (prefix, stream);
736 name = type_name_no_tag (domain);
738 fputs_filtered (name, stream);
740 c_type_print_base (domain, stream, 0, 0);
741 fprintf_filtered (stream, "::");
742 fputs_filtered (TYPE_FIELD_NAME (domain, fieldno), stream);
745 fprintf_filtered (stream, "%ld", (long) val);
750 _initialize_cp_valprint (void)
752 add_setshow_boolean_cmd ("static-members", class_support,
753 &user_print_options.static_field_print, _("\
754 Set printing of C++ static members."), _("\
755 Show printing of C++ static members."), NULL,
757 show_static_field_print,
758 &setprintlist, &showprintlist);
760 add_setshow_boolean_cmd ("vtbl", class_support,
761 &user_print_options.vtblprint, _("\
762 Set printing of C++ virtual function tables."), _("\
763 Show printing of C++ virtual function tables."), NULL,
766 &setprintlist, &showprintlist);
768 add_setshow_boolean_cmd ("object", class_support,
769 &user_print_options.objectprint, _("\
770 Set printing of object's derived type based on vtable info."), _("\
771 Show printing of object's derived type based on vtable info."), NULL,
774 &setprintlist, &showprintlist);
776 obstack_begin (&dont_print_stat_array_obstack, 32 * sizeof (struct type *));
777 obstack_begin (&dont_print_statmem_obstack, 32 * sizeof (CORE_ADDR));
778 obstack_begin (&dont_print_vb_obstack, 32 * sizeof (struct type *));