gcc/java/verify-glue.c

   1 /* Glue to interface gcj with bytecode verifier.
   2    Copyright (C) 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
   3
   4 This file is part of GCC.
   5
   6 GCC is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GCC is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GCC; see the file COPYING.  If not, write to
  18 the Free Software Foundation, 51 Franklin Street, Fifth Floor,
  19 Boston, MA 02110-1301, USA.
  20
  21 Java and all Java-based marks are trademarks or registered trademarks
  22 of Sun Microsystems, Inc. in the United States and other countries.
  23 The Free Software Foundation is independent of Sun Microsystems, Inc.  */
  24
  25 /* Written by Tom Tromey <tromey@redhat.com>.  */
  26
  27 #include "config.h"
  28
  29 #include "system.h"
  30 #include "coretypes.h"
  31 #include "tm.h"
  32 #include "tree.h"
  33 #include "parse.h"
  34
  35 #include "verify.h"
  36 #include "java-tree.h"
  37 #include "java-except.h"
  38 #include "toplev.h"
  39
  40 void *
  41 vfy_alloc (size_t bytes)
  42 {
  43   return xmalloc (bytes);
  44 }
  45
  46 void
  47 vfy_free (void *mem)
  48 {
  49   free (mem);
  50 }
  51
  52 bool
  53 vfy_strings_equal (vfy_string one, vfy_string two)
  54 {
  55   return one == two;
  56 }
  57
  58 const char *
  59 vfy_string_bytes (vfy_string str)
  60 {
  61   return IDENTIFIER_POINTER (str);
  62 }
  63
  64 int
  65 vfy_string_length (vfy_string str)
  66 {
  67   return IDENTIFIER_LENGTH (str);
  68 }
  69
  70 vfy_string
  71 vfy_init_name (void)
  72 {
  73   return init_identifier_node;
  74 }
  75
  76 vfy_string
  77 vfy_clinit_name (void)
  78 {
  79   return clinit_identifier_node;
  80 }
  81
  82 static const char*
  83 skip_one_type (const char* ptr)
  84 {
  85   int ch = *ptr++;
  86
  87   while (ch == '[')
  88     {
  89       ch = *ptr++;
  90     }
  91
  92   if (ch == 'L')
  93     {
  94       do { ch = *ptr++; } while (ch != ';');
  95     }
  96
  97   return ptr;
  98 }
  99
 100 int
 101 vfy_count_arguments (vfy_string signature)
 102 {
 103   const char *ptr = IDENTIFIER_POINTER (signature);
 104   int arg_count = 0;
 105
 106   /* Skip '('.  */
 107   ptr++;
 108
 109   /* Count args.  */
 110   while (*ptr != ')')
 111     {
 112       ptr = skip_one_type (ptr);
 113       arg_count += 1;
 114     }
 115
 116   return arg_count;
 117 }
 118
 119 vfy_string
 120 vfy_get_string (const char *s, int len)
 121 {
 122   return get_identifier_with_length (s, len);
 123 }
 124
 125 vfy_string
 126 vfy_get_signature (vfy_method *method)
 127 {
 128   return method->signature;
 129 }
 130
 131 vfy_string
 132 vfy_get_method_name (vfy_method *method)
 133 {
 134   return method->name;
 135 }
 136
 137 bool
 138 vfy_is_static (vfy_method *method)
 139 {
 140   return METHOD_STATIC (method->method);
 141 }
 142
 143 const unsigned char *
 144 vfy_get_bytecode (vfy_method *method)
 145 {
 146   return method->bytes;
 147 }
 148
 149 vfy_exception *
 150 vfy_get_exceptions (vfy_method *method)
 151 {
 152   return method->exceptions;
 153 }
 154
 155 void
 156 vfy_get_exception (vfy_exception *exceptions, int index, int *handler,
 157                    int *start, int *end, int *handler_type)
 158 {
 159   *handler = exceptions[index].handler;
 160   *start = exceptions[index].start;
 161   *end = exceptions[index].end;
 162   *handler_type = exceptions[index].type;
 163 }
 164
 165 int
 166 vfy_tag (vfy_constants *pool, int index)
 167 {
 168   int result = JPOOL_TAG (pool, index);
 169   /* gcj will resolve constant pool entries other than string and
 170      class references.  The verifier doesn't care about the values, so
 171      we just strip off the resolved flag.  */
 172   if ((result & CONSTANT_ResolvedFlag) != 0
 173       && result != CONSTANT_ResolvedString
 174       && result != CONSTANT_ResolvedClass)
 175     result &= ~ CONSTANT_ResolvedFlag;
 176   return result;
 177 }
 178
 179 void
 180 vfy_load_indexes (vfy_constants *pool, int index,
 181                   vfy_uint_16 *index0, vfy_uint_16 *index1)
 182 {
 183   *index0 = JPOOL_USHORT1 (pool, index);
 184   *index1 = JPOOL_USHORT2 (pool, index);
 185 }
 186
 187 vfy_constants *
 188 vfy_get_constants (vfy_jclass klass)
 189 {
 190   return TYPE_JCF (klass);
 191 }
 192
 193 int
 194 vfy_get_constants_size (vfy_jclass klass)
 195 {
 196   return JPOOL_SIZE (TYPE_JCF (klass));
 197 }
 198
 199 vfy_string
 200 vfy_get_pool_string (vfy_constants *pool, int index)
 201 {
 202   return get_name_constant (pool, index);
 203 }
 204
 205 vfy_jclass
 206 vfy_get_pool_class (vfy_constants *pool, int index)
 207 {
 208   vfy_jclass k;
 209   k = get_class_constant (pool, index);
 210   return k;
 211 }
 212
 213 vfy_string
 214 vfy_make_string (const char *s, int len)
 215 {
 216   tree result;
 217   char *s2 = (char *) s;
 218   char save = s2[len];
 219   s2[len] = '\0';
 220   result = get_identifier (s2);
 221   s2[len] = save;
 222   return result;
 223 }
 224
 225 vfy_string
 226 vfy_get_class_name (vfy_jclass klass)
 227 {
 228   return DECL_NAME (TYPE_NAME (klass));
 229 }
 230
 231 bool
 232 vfy_is_assignable_from (vfy_jclass target, vfy_jclass source)
 233 {
 234   /* Any class is always assignable to itself, or java.lang.Object. */
 235   if (source == target || target == object_type_node)
 236     return true;
 237
 238   /* For the C++ ABI, perform this test statically. */
 239   if (! flag_indirect_dispatch)
 240     return can_widen_reference_to (source, target);
 241
 242   /* For the BC-ABI, we assume at compile time that reference types are always
 243   compatible.  However, a type assertion table entry is emitted so that the
 244   runtime can detect binary-incompatible changes.  */
 245
 246   add_type_assertion (current_class, JV_ASSERT_TYPES_COMPATIBLE, source,
 247                       target);
 248   return true;
 249 }
 250
 251 char
 252 vfy_get_primitive_char (vfy_jclass klass)
 253 {
 254   tree sig;
 255   gcc_assert (vfy_is_primitive (klass));
 256   sig = build_java_signature (klass);
 257   return (IDENTIFIER_POINTER (sig))[0];
 258 }
 259
 260 bool
 261 vfy_is_array (vfy_jclass klass)
 262 {
 263   return TYPE_ARRAY_P (klass);
 264 }
 265
 266 bool
 267 vfy_is_interface (vfy_jclass klass)
 268 {
 269   return CLASS_INTERFACE (TYPE_NAME (klass));
 270 }
 271
 272 bool
 273 vfy_is_primitive (vfy_jclass klass)
 274 {
 275   return JPRIMITIVE_TYPE_P (klass);
 276 }
 277
 278 vfy_jclass
 279 vfy_get_superclass (vfy_jclass klass)
 280 {
 281   vfy_jclass k;
 282   k = CLASSTYPE_SUPER (klass);
 283   return k;
 284 }
 285
 286 vfy_jclass
 287 vfy_get_array_class (vfy_jclass klass)
 288 {
 289   vfy_jclass k;
 290   k = build_java_array_type (klass, -1);
 291   return k;
 292 }
 293
 294 vfy_jclass
 295 vfy_get_component_type (vfy_jclass klass)
 296 {
 297   vfy_jclass k;
 298   gcc_assert (vfy_is_array (klass));
 299   k = TYPE_ARRAY_ELEMENT (klass);
 300   if (TREE_CODE (k) == POINTER_TYPE)
 301     k = TREE_TYPE (k);
 302   return k;
 303 }
 304
 305 bool
 306 vfy_is_abstract (vfy_jclass klass)
 307 {
 308   return CLASS_ABSTRACT (TYPE_NAME (klass));
 309 }
 310
 311 vfy_jclass
 312 vfy_find_class (vfy_jclass ignore ATTRIBUTE_UNUSED, vfy_string name)
 313 {
 314   vfy_jclass k;
 315
 316   k = get_type_from_signature (name);
 317   if (TREE_CODE (k) == POINTER_TYPE)
 318     k = TREE_TYPE (k);
 319
 320   return k;
 321 }
 322
 323 vfy_jclass
 324 vfy_object_type (void)
 325 {
 326   vfy_jclass k;
 327   k = object_type_node;
 328   return k;
 329 }
 330
 331 vfy_jclass
 332 vfy_class_type (void)
 333 {
 334   return class_type_node;
 335 }
 336
 337 vfy_jclass
 338 vfy_string_type (void)
 339 {
 340   vfy_jclass k;
 341   k = string_type_node;
 342   return k;
 343 }
 344
 345 vfy_jclass
 346 vfy_throwable_type (void)
 347 {
 348   vfy_jclass k;
 349   k = throwable_type_node;
 350   return k;
 351 }
 352
 353 vfy_jclass
 354 vfy_unsuitable_type (void)
 355 {
 356   return TYPE_SECOND;
 357 }
 358
 359 vfy_jclass
 360 vfy_return_address_type (void)
 361 {
 362   return TYPE_RETURN_ADDR;
 363 }
 364
 365 vfy_jclass
 366 vfy_null_type (void)
 367 {
 368   return TYPE_NULL;
 369 }
 370
 371 bool
 372 vfy_class_has_field (vfy_jclass klass, vfy_string name,
 373                      vfy_string signature)
 374 {
 375   tree field = TYPE_FIELDS (klass);
 376   while (field != NULL_TREE)
 377     {
 378       if (DECL_NAME (field) == name
 379           && build_java_signature (TREE_TYPE (field)) == signature)
 380         return true;
 381       field = TREE_CHAIN (field);
 382     }
 383   return false;
 384 }
 385
 386 int
 387 vfy_fail (const char *message, int pc, vfy_jclass ignore1 ATTRIBUTE_UNUSED,
 388           vfy_method *ignore2 ATTRIBUTE_UNUSED)
 389 {
 390   if (pc == -1)
 391     error ("verification failed: %s", message);
 392   else
 393     error ("verification failed at PC=%d: %s", pc, message);
 394   /* We have to return a value for the verifier to throw.  */
 395   return 1;
 396 }
 397
 398 vfy_jclass
 399 vfy_get_primitive_type (int type)
 400 {
 401   vfy_jclass k;
 402   k = decode_newarray_type (type);
 403   return k;
 404 }
 405
 406 void
 407 vfy_note_stack_depth (vfy_method *method, int pc, int depth)
 408 {
 409   tree label = lookup_label (pc);
 410   LABEL_TYPE_STATE (label) = make_tree_vec (method->max_locals + depth);
 411 }
 412
 413 void
 414 vfy_note_stack_type (vfy_method *method, int pc, int slot, vfy_jclass type)
 415 {
 416   tree label, vec;
 417
 418   slot += method->max_locals;
 419
 420   if (type == object_type_node)
 421     type = object_ptr_type_node;
 422
 423   label = lookup_label (pc);
 424   vec = LABEL_TYPE_STATE (label);
 425   TREE_VEC_ELT (vec, slot) = type;
 426 }
 427
 428 void
 429 vfy_note_local_type (vfy_method *method ATTRIBUTE_UNUSED, int pc, int slot,
 430                      vfy_jclass type)
 431 {
 432   tree label, vec;
 433
 434   if (type == object_type_node)
 435     type = object_ptr_type_node;
 436
 437   label = lookup_label (pc);
 438   vec = LABEL_TYPE_STATE (label);
 439   TREE_VEC_ELT (vec, slot) = type;
 440 }
 441
 442 void
 443 vfy_note_instruction_seen (int pc)
 444 {
 445   instruction_bits[pc] |= BCODE_VERIFIED;
 446 }
 447
 448 /* Verify the bytecodes of the current method.
 449    Return 1 on success, 0 on failure. */
 450 int
 451 verify_jvm_instructions_new (JCF *jcf, const unsigned char *byte_ops,
 452                          long length)
 453 {
 454   vfy_method method;
 455   int i, result, eh_count;
 456   vfy_exception *exceptions;
 457
 458   method_init_exceptions ();
 459
 460   JCF_SEEK (jcf, DECL_CODE_OFFSET (current_function_decl) + length);
 461   eh_count = JCF_readu2 (jcf);
 462
 463   exceptions = (vfy_exception *) xmalloc (eh_count * sizeof (vfy_exception));
 464   for (i = 0; i < eh_count; ++i)
 465     {
 466       int start_pc, end_pc, handler_pc, catch_type;
 467       unsigned char *p = jcf->read_ptr + 8 * i;
 468       start_pc = GET_u2 (p);
 469       end_pc = GET_u2 (p+2);
 470       handler_pc = GET_u2 (p+4);
 471       catch_type = GET_u2 (p+6);
 472
 473       if (start_pc < 0 || start_pc >= length
 474           || end_pc < 0 || end_pc > length || start_pc >= end_pc
 475           || handler_pc < 0 || handler_pc >= length)
 476         {
 477           error ("bad pc in exception_table");
 478           free (exceptions);
 479           return 0;
 480         }
 481
 482       exceptions[i].handler = handler_pc;
 483       exceptions[i].start = start_pc;
 484       exceptions[i].end = end_pc;
 485       exceptions[i].type = catch_type;
 486
 487       add_handler (start_pc, end_pc,
 488                    lookup_label (handler_pc),
 489                    catch_type == 0 ? NULL_TREE
 490                    : get_class_constant (jcf, catch_type));
 491       instruction_bits[handler_pc] |= BCODE_EXCEPTION_TARGET;
 492     }
 493
 494   gcc_assert (sanity_check_exception_range (&whole_range));
 495
 496   method.method = current_function_decl;
 497   method.signature = build_java_signature (TREE_TYPE (current_function_decl));
 498   method.name = DECL_NAME (current_function_decl);
 499   method.bytes = byte_ops;
 500   method.exceptions = exceptions;
 501   method.defining_class = DECL_CONTEXT (current_function_decl);
 502   method.max_stack = DECL_MAX_STACK (current_function_decl);
 503   method.max_locals = DECL_MAX_LOCALS (current_function_decl);
 504   method.code_length = length;
 505   method.exc_count = eh_count;
 506
 507   result = verify_method (&method);
 508
 509   free (exceptions);
 510
 511   return result;
 512 }