gdb/jv-valprint.c

   1 /* Support for printing Java values for GDB, the GNU debugger.
   2
   3    Copyright (C) 1997-2005, 2007-2012 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 "gdbcore.h"
  24 #include "expression.h"
  25 #include "value.h"
  26 #include "demangle.h"
  27 #include "valprint.h"
  28 #include "language.h"
  29 #include "jv-lang.h"
  30 #include "c-lang.h"
  31 #include "annotate.h"
  32 #include "gdb_string.h"
  33
  34 /* Local functions */
  35
  36 void
  37 java_value_print (struct value *val, struct ui_file *stream,
  38                   const struct value_print_options *options)
  39 {
  40   struct gdbarch *gdbarch = get_type_arch (value_type (val));
  41   enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
  42   struct type *type;
  43   CORE_ADDR address;
  44   int i;
  45   const char *name;
  46   struct value_print_options opts;
  47
  48   type = value_type (val);
  49   address = value_address (val);
  50
  51   if (is_object_type (type))
  52     {
  53       CORE_ADDR obj_addr;
  54       struct value *tem = val;
  55
  56       /* Get the run-time type, and cast the object into that.  */
  57       while (TYPE_CODE (value_type (tem)) == TYPE_CODE_PTR)
  58         tem = value_ind (tem);
  59
  60       obj_addr = value_address (tem);
  61
  62       if (obj_addr != 0)
  63         {
  64           type = type_from_class (gdbarch, java_class_from_object (val));
  65           type = lookup_pointer_type (type);
  66
  67           val = value_at (type, address);
  68         }
  69     }
  70
  71   if (TYPE_CODE (type) == TYPE_CODE_PTR && !value_logical_not (val))
  72     type_print (TYPE_TARGET_TYPE (type), "", stream, -1);
  73
  74   name = TYPE_TAG_NAME (type);
  75   if (TYPE_CODE (type) == TYPE_CODE_STRUCT && name != NULL
  76       && (i = strlen (name), name[i - 1] == ']'))
  77     {
  78       gdb_byte buf4[4];
  79       long length;
  80       unsigned int things_printed = 0;
  81       int reps;
  82       struct type *el_type
  83         = java_primitive_type_from_name (gdbarch, name, i - 2);
  84
  85       i = 0;
  86       read_memory (address + get_java_object_header_size (gdbarch), buf4, 4);
  87
  88       length = (long) extract_signed_integer (buf4, 4, byte_order);
  89       fprintf_filtered (stream, "{length: %ld", length);
  90
  91       if (el_type == NULL)
  92         {
  93           CORE_ADDR element;
  94           CORE_ADDR next_element = -1; /* Dummy initial value.  */
  95
  96           /* Skip object header and length.  */
  97           address += get_java_object_header_size (gdbarch) + 4;
  98
  99           while (i < length && things_printed < options->print_max)
 100             {
 101               gdb_byte *buf;
 102
 103               buf = alloca (gdbarch_ptr_bit (gdbarch) / HOST_CHAR_BIT);
 104               fputs_filtered (", ", stream);
 105               wrap_here (n_spaces (2));
 106
 107               if (i > 0)
 108                 element = next_element;
 109               else
 110                 {
 111                   read_memory (address, buf, sizeof (buf));
 112                   address += gdbarch_ptr_bit (gdbarch) / HOST_CHAR_BIT;
 113                   /* FIXME: cagney/2003-05-24: Bogus or what.  It
 114                      pulls a host sized pointer out of the target and
 115                      then extracts that as an address (while assuming
 116                      that the address is unsigned)!  */
 117                   element = extract_unsigned_integer (buf, sizeof (buf),
 118                                                       byte_order);
 119                 }
 120
 121               for (reps = 1; i + reps < length; reps++)
 122                 {
 123                   read_memory (address, buf, sizeof (buf));
 124                   address += gdbarch_ptr_bit (gdbarch) / HOST_CHAR_BIT;
 125                   /* FIXME: cagney/2003-05-24: Bogus or what.  It
 126                      pulls a host sized pointer out of the target and
 127                      then extracts that as an address (while assuming
 128                      that the address is unsigned)!  */
 129                   next_element = extract_unsigned_integer (buf, sizeof (buf),
 130                                                            byte_order);
 131                   if (next_element != element)
 132                     break;
 133                 }
 134
 135               if (reps == 1)
 136                 fprintf_filtered (stream, "%d: ", i);
 137               else
 138                 fprintf_filtered (stream, "%d..%d: ", i, i + reps - 1);
 139
 140               if (element == 0)
 141                 fprintf_filtered (stream, "null");
 142               else
 143                 fprintf_filtered (stream, "@%s", paddress (gdbarch, element));
 144
 145               things_printed++;
 146               i += reps;
 147             }
 148         }
 149       else
 150         {
 151           struct value *v = allocate_value (el_type);
 152           struct value *next_v = allocate_value (el_type);
 153
 154           set_value_address (v, (address
 155                                  + get_java_object_header_size (gdbarch) + 4));
 156           set_value_address (next_v, value_raw_address (v));
 157
 158           while (i < length && things_printed < options->print_max)
 159             {
 160               fputs_filtered (", ", stream);
 161               wrap_here (n_spaces (2));
 162
 163               if (i > 0)
 164                 {
 165                   struct value *tmp;
 166
 167                   tmp = next_v;
 168                   next_v = v;
 169                   v = tmp;
 170                 }
 171               else
 172                 {
 173                   set_value_lazy (v, 1);
 174                   set_value_offset (v, 0);
 175                 }
 176
 177               set_value_offset (next_v, value_offset (v));
 178
 179               for (reps = 1; i + reps < length; reps++)
 180                 {
 181                   set_value_lazy (next_v, 1);
 182                   set_value_offset (next_v, value_offset (next_v)
 183                                     + TYPE_LENGTH (el_type));
 184                   value_fetch_lazy (next_v);
 185                   if (!(value_available_contents_eq
 186                         (v, value_embedded_offset (v),
 187                          next_v, value_embedded_offset (next_v),
 188                          TYPE_LENGTH (el_type))))
 189                     break;
 190                 }
 191
 192               if (reps == 1)
 193                 fprintf_filtered (stream, "%d: ", i);
 194               else
 195                 fprintf_filtered (stream, "%d..%d: ", i, i + reps - 1);
 196
 197               opts = *options;
 198               opts.deref_ref = 1;
 199               common_val_print (v, stream, 1, &opts, current_language);
 200
 201               things_printed++;
 202               i += reps;
 203             }
 204         }
 205
 206       if (i < length)
 207         fprintf_filtered (stream, "...");
 208
 209       fprintf_filtered (stream, "}");
 210
 211       return;
 212     }
 213
 214   /* If it's type String, print it.  */
 215
 216   if (TYPE_CODE (type) == TYPE_CODE_PTR
 217       && TYPE_TARGET_TYPE (type)
 218       && TYPE_TAG_NAME (TYPE_TARGET_TYPE (type))
 219       && strcmp (TYPE_TAG_NAME (TYPE_TARGET_TYPE (type)),
 220                  "java.lang.String") == 0
 221       && (options->format == 0 || options->format == 's')
 222       && address != 0
 223       && value_as_address (val) != 0)
 224     {
 225       struct type *char_type;
 226       struct value *data_val;
 227       CORE_ADDR data;
 228       struct value *boffset_val;
 229       unsigned long boffset;
 230       struct value *count_val;
 231       unsigned long count;
 232       struct value *mark;
 233
 234       mark = value_mark ();     /* Remember start of new values.  */
 235
 236       data_val = value_struct_elt (&val, NULL, "data", NULL, NULL);
 237       data = value_as_address (data_val);
 238
 239       boffset_val = value_struct_elt (&val, NULL, "boffset", NULL, NULL);
 240       boffset = value_as_address (boffset_val);
 241
 242       count_val = value_struct_elt (&val, NULL, "count", NULL, NULL);
 243       count = value_as_address (count_val);
 244
 245       value_free_to_mark (mark);        /* Release unnecessary values.  */
 246
 247       char_type = builtin_java_type (gdbarch)->builtin_char;
 248       val_print_string (char_type, NULL, data + boffset, count, stream,
 249                         options);
 250
 251       return;
 252     }
 253
 254   opts = *options;
 255   opts.deref_ref = 1;
 256   common_val_print (val, stream, 0, &opts, current_language);
 257 }
 258
 259 /* TYPE, VALADDR, ADDRESS, STREAM, RECURSE, and OPTIONS have the
 260    same meanings as in cp_print_value and c_val_print.
 261
 262    DONT_PRINT is an array of baseclass types that we
 263    should not print, or zero if called from top level.  */
 264
 265 static void
 266 java_print_value_fields (struct type *type, const gdb_byte *valaddr,
 267                          int offset,
 268                          CORE_ADDR address, struct ui_file *stream,
 269                          int recurse,
 270                          const struct value *val,
 271                          const struct value_print_options *options)
 272 {
 273   int i, len, n_baseclasses;
 274
 275   CHECK_TYPEDEF (type);
 276
 277   fprintf_filtered (stream, "{");
 278   len = TYPE_NFIELDS (type);
 279   n_baseclasses = TYPE_N_BASECLASSES (type);
 280
 281   if (n_baseclasses > 0)
 282     {
 283       int i, n_baseclasses = TYPE_N_BASECLASSES (type);
 284
 285       for (i = 0; i < n_baseclasses; i++)
 286         {
 287           int boffset;
 288           struct type *baseclass = check_typedef (TYPE_BASECLASS (type, i));
 289           const char *basename = TYPE_NAME (baseclass);
 290           const gdb_byte *base_valaddr;
 291
 292           if (BASETYPE_VIA_VIRTUAL (type, i))
 293             continue;
 294
 295           if (basename != NULL && strcmp (basename, "java.lang.Object") == 0)
 296             continue;
 297
 298           boffset = 0;
 299
 300           if (options->pretty)
 301             {
 302               fprintf_filtered (stream, "\n");
 303               print_spaces_filtered (2 * (recurse + 1), stream);
 304             }
 305           fputs_filtered ("<", stream);
 306           /* Not sure what the best notation is in the case where there is no
 307              baseclass name.  */
 308           fputs_filtered (basename ? basename : "", stream);
 309           fputs_filtered ("> = ", stream);
 310
 311           base_valaddr = valaddr;
 312
 313           java_print_value_fields (baseclass, base_valaddr,
 314                                    offset + boffset, address,
 315                                    stream, recurse + 1, val, options);
 316           fputs_filtered (", ", stream);
 317         }
 318     }
 319
 320   if (!len && n_baseclasses == 1)
 321     fprintf_filtered (stream, "<No data fields>");
 322   else
 323     {
 324       int fields_seen = 0;
 325
 326       for (i = n_baseclasses; i < len; i++)
 327         {
 328           /* If requested, skip printing of static fields.  */
 329           if (field_is_static (&TYPE_FIELD (type, i)))
 330             {
 331               const char *name = TYPE_FIELD_NAME (type, i);
 332
 333               if (!options->static_field_print)
 334                 continue;
 335               if (name != NULL && strcmp (name, "class") == 0)
 336                 continue;
 337             }
 338           if (fields_seen)
 339             fprintf_filtered (stream, ", ");
 340           else if (n_baseclasses > 0)
 341             {
 342               if (options->pretty)
 343                 {
 344                   fprintf_filtered (stream, "\n");
 345                   print_spaces_filtered (2 + 2 * recurse, stream);
 346                   fputs_filtered ("members of ", stream);
 347                   fputs_filtered (type_name_no_tag (type), stream);
 348                   fputs_filtered (": ", stream);
 349                 }
 350             }
 351           fields_seen = 1;
 352
 353           if (options->pretty)
 354             {
 355               fprintf_filtered (stream, "\n");
 356               print_spaces_filtered (2 + 2 * recurse, stream);
 357             }
 358           else
 359             {
 360               wrap_here (n_spaces (2 + 2 * recurse));
 361             }
 362           if (options->inspect_it)
 363             {
 364               if (TYPE_CODE (TYPE_FIELD_TYPE (type, i)) == TYPE_CODE_PTR)
 365                 fputs_filtered ("\"( ptr \"", stream);
 366               else
 367                 fputs_filtered ("\"( nodef \"", stream);
 368               if (field_is_static (&TYPE_FIELD (type, i)))
 369                 fputs_filtered ("static ", stream);
 370               fprintf_symbol_filtered (stream, TYPE_FIELD_NAME (type, i),
 371                                        language_cplus,
 372                                        DMGL_PARAMS | DMGL_ANSI);
 373               fputs_filtered ("\" \"", stream);
 374               fprintf_symbol_filtered (stream, TYPE_FIELD_NAME (type, i),
 375                                        language_cplus,
 376                                        DMGL_PARAMS | DMGL_ANSI);
 377               fputs_filtered ("\") \"", stream);
 378             }
 379           else
 380             {
 381               annotate_field_begin (TYPE_FIELD_TYPE (type, i));
 382
 383               if (field_is_static (&TYPE_FIELD (type, i)))
 384                 fputs_filtered ("static ", stream);
 385               fprintf_symbol_filtered (stream, TYPE_FIELD_NAME (type, i),
 386                                        language_cplus,
 387                                        DMGL_PARAMS | DMGL_ANSI);
 388               annotate_field_name_end ();
 389               fputs_filtered (": ", stream);
 390               annotate_field_value ();
 391             }
 392
 393           if (!field_is_static (&TYPE_FIELD (type, i))
 394               && TYPE_FIELD_PACKED (type, i))
 395             {
 396               struct value *v;
 397
 398               /* Bitfields require special handling, especially due to byte
 399                  order problems.  */
 400               if (TYPE_FIELD_IGNORE (type, i))
 401                 {
 402                   fputs_filtered ("<optimized out or zero length>", stream);
 403                 }
 404               else if (value_bits_synthetic_pointer (val,
 405                                                      TYPE_FIELD_BITPOS (type,
 406                                                                         i),
 407                                                      TYPE_FIELD_BITSIZE (type,
 408                                                                          i)))
 409                 {
 410                   fputs_filtered (_("<synthetic pointer>"), stream);
 411                 }
 412               else if (!value_bits_valid (val, TYPE_FIELD_BITPOS (type, i),
 413                                           TYPE_FIELD_BITSIZE (type, i)))
 414                 {
 415                   val_print_optimized_out (stream);
 416                 }
 417               else
 418                 {
 419                   struct value_print_options opts;
 420
 421                   v = value_field_bitfield (type, i, valaddr, offset, val);
 422
 423                   opts = *options;
 424                   opts.deref_ref = 0;
 425                   common_val_print (v, stream, recurse + 1,
 426                                     &opts, current_language);
 427                 }
 428             }
 429           else
 430             {
 431               if (TYPE_FIELD_IGNORE (type, i))
 432                 {
 433                   fputs_filtered ("<optimized out or zero length>", stream);
 434                 }
 435               else if (field_is_static (&TYPE_FIELD (type, i)))
 436                 {
 437                   struct value *v = value_static_field (type, i);
 438
 439                   if (v == NULL)
 440                     val_print_optimized_out (stream);
 441                   else
 442                     {
 443                       struct value_print_options opts;
 444                       struct type *t = check_typedef (value_type (v));
 445
 446                       if (TYPE_CODE (t) == TYPE_CODE_STRUCT)
 447                         v = value_addr (v);
 448                       opts = *options;
 449                       opts.deref_ref = 0;
 450                       common_val_print (v, stream, recurse + 1,
 451                                         &opts, current_language);
 452                     }
 453                 }
 454               else if (TYPE_FIELD_TYPE (type, i) == NULL)
 455                 fputs_filtered ("<unknown type>", stream);
 456               else
 457                 {
 458                   struct value_print_options opts = *options;
 459
 460                   opts.deref_ref = 0;
 461                   val_print (TYPE_FIELD_TYPE (type, i),
 462                              valaddr,
 463                              offset + TYPE_FIELD_BITPOS (type, i) / 8,
 464                              address, stream, recurse + 1, val, &opts,
 465                              current_language);
 466                 }
 467             }
 468           annotate_field_end ();
 469         }
 470
 471       if (options->pretty)
 472         {
 473           fprintf_filtered (stream, "\n");
 474           print_spaces_filtered (2 * recurse, stream);
 475         }
 476     }
 477   fprintf_filtered (stream, "}");
 478 }
 479
 480 /* See val_print for a description of the various parameters of this
 481    function; they are identical.  */
 482
 483 void
 484 java_val_print (struct type *type, const gdb_byte *valaddr,
 485                 int embedded_offset, CORE_ADDR address,
 486                 struct ui_file *stream, int recurse,
 487                 const struct value *val,
 488                 const struct value_print_options *options)
 489 {
 490   struct gdbarch *gdbarch = get_type_arch (type);
 491   unsigned int i = 0;   /* Number of characters printed.  */
 492   struct type *target_type;
 493   CORE_ADDR addr;
 494
 495   CHECK_TYPEDEF (type);
 496   switch (TYPE_CODE (type))
 497     {
 498     case TYPE_CODE_PTR:
 499       if (options->format && options->format != 's')
 500         {
 501           val_print_scalar_formatted (type, valaddr, embedded_offset,
 502                                       val, options, 0, stream);
 503           break;
 504         }
 505       addr = unpack_pointer (type, valaddr + embedded_offset);
 506       if (addr == 0)
 507         {
 508           fputs_filtered ("null", stream);
 509           return;
 510         }
 511       target_type = check_typedef (TYPE_TARGET_TYPE (type));
 512
 513       if (TYPE_CODE (target_type) == TYPE_CODE_FUNC)
 514         {
 515           /* Try to print what function it points to.  */
 516           print_address_demangle (gdbarch, addr, stream, demangle);
 517           return;
 518         }
 519
 520       if (options->addressprint && options->format != 's')
 521         {
 522           fputs_filtered ("@", stream);
 523           print_longest (stream, 'x', 0, (ULONGEST) addr);
 524         }
 525
 526       return;
 527
 528     case TYPE_CODE_CHAR:
 529     case TYPE_CODE_INT:
 530       /* Can't just call c_val_print because that prints bytes as C
 531          chars.  */
 532       if (options->format || options->output_format)
 533         {
 534           struct value_print_options opts = *options;
 535
 536           opts.format = (options->format ? options->format
 537                          : options->output_format);
 538           val_print_scalar_formatted (type, valaddr, embedded_offset,
 539                                       val, &opts, 0, stream);
 540         }
 541       else if (TYPE_CODE (type) == TYPE_CODE_CHAR
 542                || (TYPE_CODE (type) == TYPE_CODE_INT
 543                    && TYPE_LENGTH (type) == 2
 544                    && strcmp (TYPE_NAME (type), "char") == 0))
 545         LA_PRINT_CHAR ((int) unpack_long (type, valaddr + embedded_offset),
 546                        type, stream);
 547       else
 548         val_print_type_code_int (type, valaddr + embedded_offset, stream);
 549       break;
 550
 551     case TYPE_CODE_STRUCT:
 552       java_print_value_fields (type, valaddr, embedded_offset,
 553                                address, stream, recurse, val, options);
 554       break;
 555
 556     default:
 557       c_val_print (type, valaddr, embedded_offset, address, stream,
 558                    recurse, val, options);
 559       break;
 560     }
 561 }