gdb/c-valprint.c

   1 /* Support for printing C values for GDB, the GNU debugger.
   2
   3    Copyright (C) 1986-2020 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   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.
  11
  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.
  16
  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/>.  */
  19
  20 #include "defs.h"
  21 #include "symtab.h"
  22 #include "gdbtypes.h"
  23 #include "expression.h"
  24 #include "value.h"
  25 #include "valprint.h"
  26 #include "language.h"
  27 #include "c-lang.h"
  28 #include "cp-abi.h"
  29 #include "target.h"
  30 #include "objfiles.h"
  31 \f
  32
  33 /* A helper for c_textual_element_type.  This checks the name of the
  34    typedef.  This is bogus but it isn't apparent that the compiler
  35    provides us the help we may need.  */
  36
  37 static int
  38 textual_name (const char *name)
  39 {
  40   return (!strcmp (name, "wchar_t")
  41           || !strcmp (name, "char16_t")
  42           || !strcmp (name, "char32_t"));
  43 }
  44
  45 /* Apply a heuristic to decide whether an array of TYPE or a pointer
  46    to TYPE should be printed as a textual string.  Return non-zero if
  47    it should, or zero if it should be treated as an array of integers
  48    or pointer to integers.  FORMAT is the current format letter, or 0
  49    if none.
  50
  51    We guess that "char" is a character.  Explicitly signed and
  52    unsigned character types are also characters.  Integer data from
  53    vector types is not.  The user can override this by using the /s
  54    format letter.  */
  55
  56 int
  57 c_textual_element_type (struct type *type, char format)
  58 {
  59   struct type *true_type, *iter_type;
  60
  61   if (format != 0 && format != 's')
  62     return 0;
  63
  64   /* We also rely on this for its side effect of setting up all the
  65      typedef pointers.  */
  66   true_type = check_typedef (type);
  67
  68   /* TYPE_CODE_CHAR is always textual.  */
  69   if (TYPE_CODE (true_type) == TYPE_CODE_CHAR)
  70     return 1;
  71
  72   /* Any other character-like types must be integral.  */
  73   if (TYPE_CODE (true_type) != TYPE_CODE_INT)
  74     return 0;
  75
  76   /* We peel typedefs one by one, looking for a match.  */
  77   iter_type = type;
  78   while (iter_type)
  79     {
  80       /* Check the name of the type.  */
  81       if (TYPE_NAME (iter_type) && textual_name (TYPE_NAME (iter_type)))
  82         return 1;
  83
  84       if (TYPE_CODE (iter_type) != TYPE_CODE_TYPEDEF)
  85         break;
  86
  87       /* Peel a single typedef.  If the typedef doesn't have a target
  88          type, we use check_typedef and hope the result is ok -- it
  89          might be for C++, where wchar_t is a built-in type.  */
  90       if (TYPE_TARGET_TYPE (iter_type))
  91         iter_type = TYPE_TARGET_TYPE (iter_type);
  92       else
  93         iter_type = check_typedef (iter_type);
  94     }
  95
  96   if (format == 's')
  97     {
  98       /* Print this as a string if we can manage it.  For now, no wide
  99          character support.  */
 100       if (TYPE_CODE (true_type) == TYPE_CODE_INT
 101           && TYPE_LENGTH (true_type) == 1)
 102         return 1;
 103     }
 104   else
 105     {
 106       /* If a one-byte TYPE_CODE_INT is missing the not-a-character
 107          flag, then we treat it as text; otherwise, we assume it's
 108          being used as data.  */
 109       if (TYPE_CODE (true_type) == TYPE_CODE_INT
 110           && TYPE_LENGTH (true_type) == 1
 111           && !TYPE_NOTTEXT (true_type))
 112         return 1;
 113     }
 114
 115   return 0;
 116 }
 117
 118 /* Decorations for C.  */
 119
 120 static const struct generic_val_print_decorations c_decorations =
 121 {
 122   "",
 123   " + ",
 124   "i",
 125   "true",
 126   "false",
 127   "void",
 128   "{",
 129   "}"
 130 };
 131
 132 /* Print a pointer based on the type of its target.
 133
 134    Arguments to this functions are roughly the same as those in c_val_print.
 135    A difference is that ADDRESS is the address to print, with embedded_offset
 136    already added.  UNRESOLVED_ELTTYPE and ELTTYPE represent the pointed type,
 137    respectively before and after check_typedef.  */
 138
 139 static void
 140 print_unpacked_pointer (struct type *type, struct type *elttype,
 141                         struct type *unresolved_elttype,
 142                         const gdb_byte *valaddr, int embedded_offset,
 143                         CORE_ADDR address, struct ui_file *stream, int recurse,
 144                         const struct value_print_options *options)
 145 {
 146   int want_space = 0;
 147   struct gdbarch *gdbarch = get_type_arch (type);
 148
 149   if (TYPE_CODE (elttype) == TYPE_CODE_FUNC)
 150     {
 151       /* Try to print what function it points to.  */
 152       print_function_pointer_address (options, gdbarch, address, stream);
 153       return;
 154     }
 155
 156   if (options->symbol_print)
 157     want_space = print_address_demangle (options, gdbarch, address, stream,
 158                                          demangle);
 159   else if (options->addressprint)
 160     {
 161       fputs_filtered (paddress (gdbarch, address), stream);
 162       want_space = 1;
 163     }
 164
 165   /* For a pointer to a textual type, also print the string
 166      pointed to, unless pointer is null.  */
 167
 168   if (c_textual_element_type (unresolved_elttype, options->format)
 169       && address != 0)
 170     {
 171       if (want_space)
 172         fputs_filtered (" ", stream);
 173       val_print_string (unresolved_elttype, NULL, address, -1, stream, options);
 174     }
 175   else if (cp_is_vtbl_member (type))
 176     {
 177       /* Print vtbl's nicely.  */
 178       CORE_ADDR vt_address = unpack_pointer (type, valaddr + embedded_offset);
 179       struct bound_minimal_symbol msymbol =
 180         lookup_minimal_symbol_by_pc (vt_address);
 181
 182       /* If 'symbol_print' is set, we did the work above.  */
 183       if (!options->symbol_print
 184           && (msymbol.minsym != NULL)
 185           && (vt_address == BMSYMBOL_VALUE_ADDRESS (msymbol)))
 186         {
 187           if (want_space)
 188             fputs_filtered (" ", stream);
 189           fputs_filtered (" <", stream);
 190           fputs_filtered (msymbol.minsym->print_name (), stream);
 191           fputs_filtered (">", stream);
 192           want_space = 1;
 193         }
 194
 195       if (vt_address && options->vtblprint)
 196         {
 197           struct value *vt_val;
 198           struct symbol *wsym = NULL;
 199           struct type *wtype;
 200
 201           if (want_space)
 202             fputs_filtered (" ", stream);
 203
 204           if (msymbol.minsym != NULL)
 205             {
 206               const char *search_name = msymbol.minsym->search_name ();
 207               wsym = lookup_symbol_search_name (search_name, NULL,
 208                                                 VAR_DOMAIN).symbol;
 209             }
 210
 211           if (wsym)
 212             {
 213               wtype = SYMBOL_TYPE (wsym);
 214             }
 215           else
 216             {
 217               wtype = unresolved_elttype;
 218             }
 219           vt_val = value_at (wtype, vt_address);
 220           common_val_print (vt_val, stream, recurse + 1, options,
 221                             current_language);
 222           if (options->prettyformat)
 223             {
 224               fprintf_filtered (stream, "\n");
 225               print_spaces_filtered (2 + 2 * recurse, stream);
 226             }
 227         }
 228     }
 229 }
 230
 231 /* c_value_print helper for TYPE_CODE_ARRAY.  */
 232
 233 static void
 234 c_value_print_array (struct value *val,
 235                      struct ui_file *stream, int recurse,
 236                      const struct value_print_options *options)
 237 {
 238   struct type *type = check_typedef (value_type (val));
 239   CORE_ADDR address = value_address (val);
 240   const gdb_byte *valaddr = value_contents_for_printing (val);
 241   struct type *unresolved_elttype = TYPE_TARGET_TYPE (type);
 242   struct type *elttype = check_typedef (unresolved_elttype);
 243
 244   if (TYPE_LENGTH (type) > 0 && TYPE_LENGTH (unresolved_elttype) > 0)
 245     {
 246       LONGEST low_bound, high_bound;
 247       int eltlen, len;
 248       enum bfd_endian byte_order = type_byte_order (type);
 249
 250       if (!get_array_bounds (type, &low_bound, &high_bound))
 251         error (_("Could not determine the array high bound"));
 252
 253       eltlen = TYPE_LENGTH (elttype);
 254       len = high_bound - low_bound + 1;
 255       if (options->prettyformat_arrays)
 256         {
 257           print_spaces_filtered (2 + 2 * recurse, stream);
 258         }
 259
 260       /* Print arrays of textual chars with a string syntax, as
 261          long as the entire array is valid.  */
 262       if (c_textual_element_type (unresolved_elttype,
 263                                   options->format)
 264           && value_bytes_available (val, 0, TYPE_LENGTH (type))
 265           && !value_bits_any_optimized_out (val, 0,
 266                                             TARGET_CHAR_BIT * TYPE_LENGTH (type)))
 267         {
 268           int force_ellipses = 0;
 269
 270           /* If requested, look for the first null char and only
 271              print elements up to it.  */
 272           if (options->stop_print_at_null)
 273             {
 274               unsigned int temp_len;
 275
 276               for (temp_len = 0;
 277                    (temp_len < len
 278                     && temp_len < options->print_max
 279                     && extract_unsigned_integer (valaddr + temp_len * eltlen,
 280                                                  eltlen, byte_order) != 0);
 281                    ++temp_len)
 282                 ;
 283
 284               /* Force LA_PRINT_STRING to print ellipses if
 285                  we've printed the maximum characters and
 286                  the next character is not \000.  */
 287               if (temp_len == options->print_max && temp_len < len)
 288                 {
 289                   ULONGEST ival
 290                     = extract_unsigned_integer (valaddr + temp_len * eltlen,
 291                                                 eltlen, byte_order);
 292                   if (ival != 0)
 293                     force_ellipses = 1;
 294                 }
 295
 296               len = temp_len;
 297             }
 298
 299           LA_PRINT_STRING (stream, unresolved_elttype, valaddr, len,
 300                            NULL, force_ellipses, options);
 301         }
 302       else
 303         {
 304           unsigned int i = 0;
 305           fprintf_filtered (stream, "{");
 306           /* If this is a virtual function table, print the 0th
 307              entry specially, and the rest of the members
 308              normally.  */
 309           if (cp_is_vtbl_ptr_type (elttype))
 310             {
 311               i = 1;
 312               fprintf_filtered (stream, _("%d vtable entries"),
 313                                 len - 1);
 314             }
 315           value_print_array_elements (val, stream, recurse, options, i);
 316           fprintf_filtered (stream, "}");
 317         }
 318     }
 319   else
 320     {
 321       /* Array of unspecified length: treat like pointer to first elt.  */
 322       print_unpacked_pointer (type, elttype, unresolved_elttype, valaddr,
 323                               0, address, stream, recurse, options);
 324     }
 325 }
 326
 327 /* c_value_print_inner helper for TYPE_CODE_PTR.  */
 328
 329 static void
 330 c_value_print_ptr (struct value *val, struct ui_file *stream, int recurse,
 331                    const struct value_print_options *options)
 332 {
 333   if (options->format && options->format != 's')
 334     {
 335       value_print_scalar_formatted (val, options, 0, stream);
 336       return;
 337     }
 338
 339   struct type *type = check_typedef (value_type (val));
 340   struct gdbarch *arch = get_type_arch (type);
 341   const gdb_byte *valaddr = value_contents_for_printing (val);
 342
 343   if (options->vtblprint && cp_is_vtbl_ptr_type (type))
 344     {
 345       /* Print the unmangled name if desired.  */
 346       /* Print vtable entry - we only get here if we ARE using
 347          -fvtable_thunks.  (Otherwise, look under
 348          TYPE_CODE_STRUCT.)  */
 349       CORE_ADDR addr = extract_typed_address (valaddr, type);
 350
 351       print_function_pointer_address (options, arch, addr, stream);
 352     }
 353   else
 354     {
 355       struct type *unresolved_elttype = TYPE_TARGET_TYPE (type);
 356       struct type *elttype = check_typedef (unresolved_elttype);
 357       CORE_ADDR addr = unpack_pointer (type, valaddr);
 358
 359       print_unpacked_pointer (type, elttype, unresolved_elttype, valaddr,
 360                               0, addr, stream, recurse, options);
 361     }
 362 }
 363
 364 /* c_value_print helper for TYPE_CODE_STRUCT and TYPE_CODE_UNION.  */
 365
 366 static void
 367 c_value_print_struct (struct value *val, struct ui_file *stream, int recurse,
 368                       const struct value_print_options *options)
 369 {
 370   struct type *type = check_typedef (value_type (val));
 371
 372   if (TYPE_CODE (type) == TYPE_CODE_UNION && recurse && !options->unionprint)
 373     fprintf_filtered (stream, "{...}");
 374   else if (options->vtblprint && cp_is_vtbl_ptr_type (type))
 375     {
 376       /* Print the unmangled name if desired.  */
 377       /* Print vtable entry - we only get here if NOT using
 378          -fvtable_thunks.  (Otherwise, look under
 379          TYPE_CODE_PTR.)  */
 380       struct gdbarch *gdbarch = get_type_arch (type);
 381       int offset = TYPE_FIELD_BITPOS (type, VTBL_FNADDR_OFFSET) / 8;
 382       struct type *field_type = TYPE_FIELD_TYPE (type, VTBL_FNADDR_OFFSET);
 383       const gdb_byte *valaddr = value_contents_for_printing (val);
 384       CORE_ADDR addr = extract_typed_address (valaddr + offset, field_type);
 385
 386       print_function_pointer_address (options, gdbarch, addr, stream);
 387     }
 388   else
 389     cp_print_value_fields (val, stream, recurse, options, NULL, 0);
 390 }
 391
 392 /* c_value_print helper for TYPE_CODE_INT.  */
 393
 394 static void
 395 c_value_print_int (struct value *val, struct ui_file *stream,
 396                    const struct value_print_options *options)
 397 {
 398   if (options->format || options->output_format)
 399     {
 400       struct value_print_options opts = *options;
 401
 402       opts.format = (options->format ? options->format
 403                      : options->output_format);
 404       value_print_scalar_formatted (val, &opts, 0, stream);
 405     }
 406   else
 407     {
 408       value_print_scalar_formatted (val, options, 0, stream);
 409       /* C and C++ has no single byte int type, char is used
 410          instead.  Since we don't know whether the value is really
 411          intended to be used as an integer or a character, print
 412          the character equivalent as well.  */
 413       struct type *type = value_type (val);
 414       const gdb_byte *valaddr = value_contents_for_printing (val);
 415       if (c_textual_element_type (type, options->format))
 416         {
 417           fputs_filtered (" ", stream);
 418           LA_PRINT_CHAR (unpack_long (type, valaddr), type, stream);
 419         }
 420     }
 421 }
 422
 423 /* c_value_print helper for TYPE_CODE_MEMBERPTR.  */
 424
 425 static void
 426 c_value_print_memberptr (struct value *val, struct ui_file *stream,
 427                          int recurse,
 428                          const struct value_print_options *options)
 429 {
 430   if (!options->format)
 431     {
 432       struct type *type = check_typedef (value_type (val));
 433       const gdb_byte *valaddr = value_contents_for_printing (val);
 434       cp_print_class_member (valaddr, type, stream, "&");
 435     }
 436   else
 437     generic_value_print (val, stream, recurse, options, &c_decorations);
 438 }
 439
 440 /* See c-lang.h.  */
 441
 442 void
 443 c_value_print_inner (struct value *val, struct ui_file *stream, int recurse,
 444                      const struct value_print_options *options)
 445 {
 446   struct type *type = value_type (val);
 447   const gdb_byte *valaddr = value_contents_for_printing (val);
 448
 449   type = check_typedef (type);
 450   switch (TYPE_CODE (type))
 451     {
 452     case TYPE_CODE_ARRAY:
 453       c_value_print_array (val, stream, recurse, options);
 454       break;
 455
 456     case TYPE_CODE_METHODPTR:
 457       cplus_print_method_ptr (valaddr, type, stream);
 458       break;
 459
 460     case TYPE_CODE_PTR:
 461       c_value_print_ptr (val, stream, recurse, options);
 462       break;
 463
 464     case TYPE_CODE_UNION:
 465     case TYPE_CODE_STRUCT:
 466       c_value_print_struct (val, stream, recurse, options);
 467       break;
 468
 469     case TYPE_CODE_INT:
 470       c_value_print_int (val, stream, options);
 471       break;
 472
 473     case TYPE_CODE_MEMBERPTR:
 474       c_value_print_memberptr (val, stream, recurse, options);
 475       break;
 476
 477     case TYPE_CODE_REF:
 478     case TYPE_CODE_RVALUE_REF:
 479     case TYPE_CODE_ENUM:
 480     case TYPE_CODE_FLAGS:
 481     case TYPE_CODE_FUNC:
 482     case TYPE_CODE_METHOD:
 483     case TYPE_CODE_BOOL:
 484     case TYPE_CODE_RANGE:
 485     case TYPE_CODE_FLT:
 486     case TYPE_CODE_DECFLOAT:
 487     case TYPE_CODE_VOID:
 488     case TYPE_CODE_ERROR:
 489     case TYPE_CODE_UNDEF:
 490     case TYPE_CODE_COMPLEX:
 491     case TYPE_CODE_CHAR:
 492     default:
 493       generic_value_print (val, stream, recurse, options, &c_decorations);
 494       break;
 495     }
 496 }
 497
 498 \f
 499 void
 500 c_value_print (struct value *val, struct ui_file *stream,
 501                const struct value_print_options *options)
 502 {
 503   struct type *type, *real_type;
 504   int full, using_enc;
 505   LONGEST top;
 506   struct value_print_options opts = *options;
 507
 508   opts.deref_ref = 1;
 509
 510   /* If it is a pointer, indicate what it points to.
 511
 512      Print type also if it is a reference.
 513
 514      C++: if it is a member pointer, we will take care
 515      of that when we print it.  */
 516
 517   type = check_typedef (value_type (val));
 518
 519   if (TYPE_CODE (type) == TYPE_CODE_PTR || TYPE_IS_REFERENCE (type))
 520     {
 521       struct type *original_type = value_type (val);
 522
 523       /* Hack:  remove (char *) for char strings.  Their
 524          type is indicated by the quoted string anyway.
 525          (Don't use c_textual_element_type here; quoted strings
 526          are always exactly (char *), (wchar_t *), or the like.  */
 527       if (TYPE_CODE (original_type) == TYPE_CODE_PTR
 528           && TYPE_NAME (original_type) == NULL
 529           && TYPE_NAME (TYPE_TARGET_TYPE (original_type)) != NULL
 530           && (strcmp (TYPE_NAME (TYPE_TARGET_TYPE (original_type)),
 531                       "char") == 0
 532               || textual_name (TYPE_NAME (TYPE_TARGET_TYPE (original_type)))))
 533         {
 534           /* Print nothing.  */
 535         }
 536       else if (options->objectprint
 537                && (TYPE_CODE (TYPE_TARGET_TYPE (type)) == TYPE_CODE_STRUCT))
 538         {
 539           int is_ref = TYPE_IS_REFERENCE (type);
 540           enum type_code refcode = TYPE_CODE_UNDEF;
 541
 542           if (is_ref)
 543             {
 544               val = value_addr (val);
 545               refcode = TYPE_CODE (type);
 546             }
 547
 548           /* Pointer to class, check real type of object.  */
 549           fprintf_filtered (stream, "(");
 550
 551           if (value_entirely_available (val))
 552             {
 553               real_type = value_rtti_indirect_type (val, &full, &top,
 554                                                     &using_enc);
 555               if (real_type)
 556                 {
 557                   /* RTTI entry found.  */
 558
 559                   /* Need to adjust pointer value.  */
 560                   val = value_from_pointer (real_type,
 561                                             value_as_address (val) - top);
 562
 563                   /* Note: When we look up RTTI entries, we don't get
 564                      any information on const or volatile
 565                      attributes.  */
 566                 }
 567             }
 568
 569           if (is_ref)
 570             val = value_ref (value_ind (val), refcode);
 571
 572           type = value_type (val);
 573           type_print (type, "", stream, -1);
 574           fprintf_filtered (stream, ") ");
 575         }
 576       else
 577         {
 578           /* normal case */
 579           fprintf_filtered (stream, "(");
 580           type_print (value_type (val), "", stream, -1);
 581           fprintf_filtered (stream, ") ");
 582         }
 583     }
 584
 585   if (!value_initialized (val))
 586     fprintf_filtered (stream, " [uninitialized] ");
 587
 588   if (options->objectprint && (TYPE_CODE (type) == TYPE_CODE_STRUCT))
 589     {
 590       /* Attempt to determine real type of object.  */
 591       real_type = value_rtti_type (val, &full, &top, &using_enc);
 592       if (real_type)
 593         {
 594           /* We have RTTI information, so use it.  */
 595           val = value_full_object (val, real_type,
 596                                    full, top, using_enc);
 597           /* In a destructor we might see a real type that is a
 598              superclass of the object's type.  In this case it is
 599              better to leave the object as-is.  */
 600           if (!(full
 601                 && (TYPE_LENGTH (real_type)
 602                     < TYPE_LENGTH (value_enclosing_type (val)))))
 603             val = value_cast (real_type, val);
 604           fprintf_filtered (stream, "(%s%s) ",
 605                             TYPE_NAME (real_type),
 606                             full ? "" : _(" [incomplete object]"));
 607         }
 608       else if (type != check_typedef (value_enclosing_type (val)))
 609         {
 610           /* No RTTI information, so let's do our best.  */
 611           fprintf_filtered (stream, "(%s ?) ",
 612                             TYPE_NAME (value_enclosing_type (val)));
 613           val = value_cast (value_enclosing_type (val), val);
 614         }
 615     }
 616
 617   common_val_print (val, stream, 0, &opts, current_language);
 618 }