1 /*
   2  * Copyright (c) 1997, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  *
  23  */
  24 
  25 #include "precompiled.hpp"
  26 #include "classfile/systemDictionary.hpp"
  27 #include "classfile/vmSymbols.hpp"
  28 #include "gc/shared/gcLocker.hpp"
  29 #include "logging/log.hpp"
  30 #include "logging/logStream.hpp"
  31 #include "memory/metaspaceShared.hpp"
  32 #include "memory/resourceArea.hpp"
  33 #include "memory/universe.inline.hpp"
  34 #include "oops/instanceKlass.hpp"
  35 #include "oops/klassVtable.hpp"
  36 #include "oops/method.hpp"
  37 #include "oops/objArrayOop.hpp"
  38 #include "oops/oop.inline.hpp"
  39 #include "prims/jvm.h"
  40 #include "runtime/arguments.hpp"
  41 #include "runtime/handles.inline.hpp"
  42 #include "utilities/copy.hpp"
  43 
  44 inline InstanceKlass* klassVtable::ik() const {
  45   return InstanceKlass::cast(_klass);
  46 }
  47 
  48 bool klassVtable::is_preinitialized_vtable() {
  49   return _klass->is_shared() && !MetaspaceShared::remapped_readwrite();
  50 }
  51 
  52 
  53 // this function computes the vtable size (including the size needed for miranda
  54 // methods) and the number of miranda methods in this class.
  55 // Note on Miranda methods: Let's say there is a class C that implements
  56 // interface I, and none of C's superclasses implements I.
  57 // Let's say there is an abstract method m in I that neither C
  58 // nor any of its super classes implement (i.e there is no method of any access,
  59 // with the same name and signature as m), then m is a Miranda method which is
  60 // entered as a public abstract method in C's vtable.  From then on it should
  61 // treated as any other public method in C for method over-ride purposes.
  62 void klassVtable::compute_vtable_size_and_num_mirandas(
  63     int* vtable_length_ret, int* num_new_mirandas,
  64     GrowableArray<Method*>* all_mirandas, const Klass* super,
  65     Array<Method*>* methods, AccessFlags class_flags, u2 major_version,
  66     Handle classloader, Symbol* classname, Array<Klass*>* local_interfaces,
  67     TRAPS) {
  68   NoSafepointVerifier nsv;
  69 
  70   // set up default result values
  71   int vtable_length = 0;
  72 
  73   // start off with super's vtable length
  74   vtable_length = super == NULL ? 0 : super->vtable_length();
  75 
  76   // go thru each method in the methods table to see if it needs a new entry
  77   int len = methods->length();
  78   for (int i = 0; i < len; i++) {
  79     assert(methods->at(i)->is_method(), "must be a Method*");
  80     methodHandle mh(THREAD, methods->at(i));
  81 
  82     if (needs_new_vtable_entry(mh, super, classloader, classname, class_flags, major_version, THREAD)) {
  83       vtable_length += vtableEntry::size(); // we need a new entry
  84     }
  85   }
  86 
  87   GrowableArray<Method*> new_mirandas(20);
  88   // compute the number of mirandas methods that must be added to the end
  89   get_mirandas(&new_mirandas, all_mirandas, super, methods, NULL, local_interfaces);
  90   *num_new_mirandas = new_mirandas.length();
  91 
  92   // Interfaces do not need interface methods in their vtables
  93   // This includes miranda methods and during later processing, default methods
  94   if (!class_flags.is_interface()) {
  95     vtable_length += *num_new_mirandas * vtableEntry::size();
  96   }
  97 
  98   if (Universe::is_bootstrapping() && vtable_length == 0) {
  99     // array classes don't have their superclass set correctly during
 100     // bootstrapping
 101     vtable_length = Universe::base_vtable_size();
 102   }
 103 
 104   if (super == NULL && vtable_length != Universe::base_vtable_size()) {
 105     if (Universe::is_bootstrapping()) {
 106       // Someone is attempting to override java.lang.Object incorrectly on the
 107       // bootclasspath.  The JVM cannot recover from this error including throwing
 108       // an exception
 109       vm_exit_during_initialization("Incompatible definition of java.lang.Object");
 110     } else {
 111       // Someone is attempting to redefine java.lang.Object incorrectly.  The
 112       // only way this should happen is from
 113       // SystemDictionary::resolve_from_stream(), which will detect this later
 114       // and throw a security exception.  So don't assert here to let
 115       // the exception occur.
 116       vtable_length = Universe::base_vtable_size();
 117     }
 118   }
 119   assert(vtable_length % vtableEntry::size() == 0, "bad vtable length");
 120   assert(vtable_length >= Universe::base_vtable_size(), "vtable too small");
 121 
 122   *vtable_length_ret = vtable_length;
 123 }
 124 
 125 int klassVtable::index_of(Method* m, int len) const {
 126   assert(m->has_vtable_index(), "do not ask this of non-vtable methods");
 127   return m->vtable_index();
 128 }
 129 
 130 // Copy super class's vtable to the first part (prefix) of this class's vtable,
 131 // and return the number of entries copied.  Expects that 'super' is the Java
 132 // super class (arrays can have "array" super classes that must be skipped).
 133 int klassVtable::initialize_from_super(Klass* super) {
 134   if (super == NULL) {
 135     return 0;
 136   } else if (is_preinitialized_vtable()) {
 137     // A shared class' vtable is preinitialized at dump time. No need to copy
 138     // methods from super class for shared class, as that was already done
 139     // during archiving time. However, if Jvmti has redefined a class,
 140     // copy super class's vtable in case the super class has changed.
 141     return super->vtable().length();
 142   } else {
 143     // copy methods from superKlass
 144     klassVtable superVtable = super->vtable();
 145     assert(superVtable.length() <= _length, "vtable too short");
 146 #ifdef ASSERT
 147     superVtable.verify(tty, true);
 148 #endif
 149     superVtable.copy_vtable_to(table());
 150     if (log_develop_is_enabled(Trace, vtables)) {
 151       ResourceMark rm;
 152       log_develop_trace(vtables)("copy vtable from %s to %s size %d",
 153                                  super->internal_name(), klass()->internal_name(),
 154                                  _length);
 155     }
 156     return superVtable.length();
 157   }
 158 }
 159 
 160 //
 161 // Revised lookup semantics   introduced 1.3 (Kestrel beta)
 162 void klassVtable::initialize_vtable(bool checkconstraints, TRAPS) {
 163 
 164   // Note:  Arrays can have intermediate array supers.  Use java_super to skip them.
 165   Klass* super = _klass->java_super();
 166   int nofNewEntries = 0;
 167 
 168   bool is_shared = _klass->is_shared();
 169 
 170   if (!_klass->is_array_klass()) {
 171     ResourceMark rm(THREAD);
 172     log_develop_debug(vtables)("Initializing: %s", _klass->name()->as_C_string());
 173   }
 174 
 175 #ifdef ASSERT
 176   oop* end_of_obj = (oop*)_klass + _klass->size();
 177   oop* end_of_vtable = (oop*)&table()[_length];
 178   assert(end_of_vtable <= end_of_obj, "vtable extends beyond end");
 179 #endif
 180 
 181   if (Universe::is_bootstrapping()) {
 182     assert(!is_shared, "sanity");
 183     // just clear everything
 184     for (int i = 0; i < _length; i++) table()[i].clear();
 185     return;
 186   }
 187 
 188   int super_vtable_len = initialize_from_super(super);
 189   if (_klass->is_array_klass()) {
 190     assert(super_vtable_len == _length, "arrays shouldn't introduce new methods");
 191   } else {
 192     assert(_klass->is_instance_klass(), "must be InstanceKlass");
 193 
 194     Array<Method*>* methods = ik()->methods();
 195     int len = methods->length();
 196     int initialized = super_vtable_len;
 197 
 198     // Check each of this class's methods against super;
 199     // if override, replace in copy of super vtable, otherwise append to end
 200     for (int i = 0; i < len; i++) {
 201       // update_inherited_vtable can stop for gc - ensure using handles
 202       HandleMark hm(THREAD);
 203       assert(methods->at(i)->is_method(), "must be a Method*");
 204       methodHandle mh(THREAD, methods->at(i));
 205 
 206       bool needs_new_entry = update_inherited_vtable(ik(), mh, super_vtable_len, -1, checkconstraints, CHECK);
 207 
 208       if (needs_new_entry) {
 209         put_method_at(mh(), initialized);
 210         mh()->set_vtable_index(initialized); // set primary vtable index
 211         initialized++;
 212       }
 213     }
 214 
 215     // update vtable with default_methods
 216     Array<Method*>* default_methods = ik()->default_methods();
 217     if (default_methods != NULL) {
 218       len = default_methods->length();
 219       if (len > 0) {
 220         Array<int>* def_vtable_indices = NULL;
 221         if ((def_vtable_indices = ik()->default_vtable_indices()) == NULL) {
 222           assert(!is_shared, "shared class def_vtable_indices does not exist");
 223           def_vtable_indices = ik()->create_new_default_vtable_indices(len, CHECK);
 224         } else {
 225           assert(def_vtable_indices->length() == len, "reinit vtable len?");
 226         }
 227         for (int i = 0; i < len; i++) {
 228           HandleMark hm(THREAD);
 229           assert(default_methods->at(i)->is_method(), "must be a Method*");
 230           methodHandle mh(THREAD, default_methods->at(i));
 231           assert(!mh->is_private(), "private interface method in the default method list");
 232           bool needs_new_entry = update_inherited_vtable(ik(), mh, super_vtable_len, i, checkconstraints, CHECK);
 233 
 234           // needs new entry
 235           if (needs_new_entry) {
 236             put_method_at(mh(), initialized);
 237             if (is_preinitialized_vtable()) {
 238               // At runtime initialize_vtable is rerun for a shared class
 239               // (loaded by the non-boot loader) as part of link_class_impl().
 240               // The dumptime vtable index should be the same as the runtime index.
 241               assert(def_vtable_indices->at(i) == initialized,
 242                      "dump time vtable index is different from runtime index");
 243             } else {
 244               def_vtable_indices->at_put(i, initialized); //set vtable index
 245             }
 246             initialized++;
 247           }
 248         }
 249       }
 250     }
 251 
 252     // add miranda methods; it will also return the updated initialized
 253     // Interfaces do not need interface methods in their vtables
 254     // This includes miranda methods and during later processing, default methods
 255     if (!ik()->is_interface()) {
 256       initialized = fill_in_mirandas(initialized);
 257     }
 258 
 259     // In class hierarchies where the accessibility is not increasing (i.e., going from private ->
 260     // package_private -> public/protected), the vtable might actually be smaller than our initial
 261     // calculation, for classfile versions for which we do not do transitive override
 262     // calculations.
 263     if (ik()->major_version() >= VTABLE_TRANSITIVE_OVERRIDE_VERSION) {
 264       assert(initialized == _length, "vtable initialization failed");
 265     } else {
 266       assert(initialized <= _length, "vtable initialization failed");
 267       for(;initialized < _length; initialized++) {
 268         table()[initialized].clear();
 269       }
 270     }
 271     NOT_PRODUCT(verify(tty, true));
 272   }
 273 }
 274 
 275 // Called for cases where a method does not override its superclass' vtable entry
 276 // For bytecodes not produced by javac together it is possible that a method does not override
 277 // the superclass's method, but might indirectly override a super-super class's vtable entry
 278 // If none found, return a null superk, else return the superk of the method this does override
 279 // For public and protected methods: if they override a superclass, they will
 280 // also be overridden themselves appropriately.
 281 // Private methods do not override and are not overridden.
 282 // Package Private methods are trickier:
 283 // e.g. P1.A, pub m
 284 // P2.B extends A, package private m
 285 // P1.C extends B, public m
 286 // P1.C.m needs to override P1.A.m and can not override P2.B.m
 287 // Therefore: all package private methods need their own vtable entries for
 288 // them to be the root of an inheritance overriding decision
 289 // Package private methods may also override other vtable entries
 290 InstanceKlass* klassVtable::find_transitive_override(InstanceKlass* initialsuper, const methodHandle& target_method,
 291                             int vtable_index, Handle target_loader, Symbol* target_classname, Thread * THREAD) {
 292   InstanceKlass* superk = initialsuper;
 293   while (superk != NULL && superk->super() != NULL) {
 294     InstanceKlass* supersuperklass = InstanceKlass::cast(superk->super());
 295     klassVtable ssVtable = supersuperklass->vtable();
 296     if (vtable_index < ssVtable.length()) {
 297       Method* super_method = ssVtable.method_at(vtable_index);
 298 #ifndef PRODUCT
 299       Symbol* name= target_method()->name();
 300       Symbol* signature = target_method()->signature();
 301       assert(super_method->name() == name && super_method->signature() == signature, "vtable entry name/sig mismatch");
 302 #endif
 303       if (supersuperklass->is_override(super_method, target_loader, target_classname, THREAD)) {
 304         if (log_develop_is_enabled(Trace, vtables)) {
 305           ResourceMark rm(THREAD);
 306           LogTarget(Trace, vtables) lt;
 307           LogStream ls(lt);
 308           char* sig = target_method()->name_and_sig_as_C_string();
 309           ls.print("transitive overriding superclass %s with %s index %d, original flags: ",
 310                        supersuperklass->internal_name(),
 311                        sig, vtable_index);
 312           super_method->print_linkage_flags(&ls);
 313           ls.print("overriders flags: ");
 314           target_method->print_linkage_flags(&ls);
 315           ls.cr();
 316         }
 317 
 318         break; // return found superk
 319       }
 320     } else  {
 321       // super class has no vtable entry here, stop transitive search
 322       superk = (InstanceKlass*)NULL;
 323       break;
 324     }
 325     // if no override found yet, continue to search up
 326     superk = superk->super() == NULL ? NULL : InstanceKlass::cast(superk->super());
 327   }
 328 
 329   return superk;
 330 }
 331 
 332 static void log_vtables(int i, bool overrides, const methodHandle& target_method,
 333                         Klass* target_klass, Method* super_method,
 334                         Thread* thread) {
 335 #ifndef PRODUCT
 336   if (log_develop_is_enabled(Trace, vtables)) {
 337     ResourceMark rm(thread);
 338     LogTarget(Trace, vtables) lt;
 339     LogStream ls(lt);
 340     char* sig = target_method()->name_and_sig_as_C_string();
 341     if (overrides) {
 342       ls.print("overriding with %s index %d, original flags: ",
 343                    sig, i);
 344     } else {
 345       ls.print("NOT overriding with %s index %d, original flags: ",
 346                    sig, i);
 347     }
 348     super_method->print_linkage_flags(&ls);
 349     ls.print("overriders flags: ");
 350     target_method->print_linkage_flags(&ls);
 351     ls.cr();
 352   }
 353 #endif
 354 }
 355 
 356 // Update child's copy of super vtable for overrides
 357 // OR return true if a new vtable entry is required.
 358 // Only called for InstanceKlass's, i.e. not for arrays
 359 // If that changed, could not use _klass as handle for klass
 360 bool klassVtable::update_inherited_vtable(InstanceKlass* klass, const methodHandle& target_method,
 361                                           int super_vtable_len, int default_index,
 362                                           bool checkconstraints, TRAPS) {
 363   ResourceMark rm;
 364   bool allocate_new = true;
 365   assert(klass->is_instance_klass(), "must be InstanceKlass");
 366 
 367   Array<int>* def_vtable_indices = NULL;
 368   bool is_default = false;
 369 
 370   // default methods are non-private concrete methods in superinterfaces which are added
 371   // to the vtable with their real method_holder.
 372   // Since vtable and itable indices share the same storage, don't touch
 373   // the default method's real vtable/itable index.
 374   // default_vtable_indices stores the vtable value relative to this inheritor
 375   if (default_index >= 0 ) {
 376     is_default = true;
 377     def_vtable_indices = klass->default_vtable_indices();
 378     assert(!target_method()->is_private(), "private interface method flagged as default");
 379     assert(def_vtable_indices != NULL, "def vtable alloc?");
 380     assert(default_index <= def_vtable_indices->length(), "def vtable len?");
 381   } else {
 382     assert(klass == target_method()->method_holder(), "caller resp.");
 383     // Initialize the method's vtable index to "nonvirtual".
 384     // If we allocate a vtable entry, we will update it to a non-negative number.
 385     target_method()->set_vtable_index(Method::nonvirtual_vtable_index);
 386   }
 387 
 388   // Static and <init> methods are never in
 389   if (target_method()->is_static() || target_method()->name() ==  vmSymbols::object_initializer_name()) {
 390     return false;
 391   }
 392 
 393   if (target_method->is_final_method(klass->access_flags())) {
 394     // a final method never needs a new entry; final methods can be statically
 395     // resolved and they have to be present in the vtable only if they override
 396     // a super's method, in which case they re-use its entry
 397     allocate_new = false;
 398   } else if (klass->is_interface()) {
 399     allocate_new = false;  // see note below in needs_new_vtable_entry
 400     // An interface never allocates new vtable slots, only inherits old ones.
 401     // This method will either be assigned its own itable index later,
 402     // or be assigned an inherited vtable index in the loop below.
 403     // default methods inherited by classes store their vtable indices
 404     // in the inheritor's default_vtable_indices.
 405     // default methods inherited by interfaces may already have a
 406     // valid itable index, if so, don't change it.
 407     // Overpass methods in an interface will be assigned an itable index later
 408     // by an inheriting class.
 409     // Private interface methods have no itable index and are always invoked nonvirtually,
 410     // so they retain their nonvirtual_vtable_index value, and therefore can_be_statically_bound()
 411     // will return true.
 412     if ((!is_default || !target_method()->has_itable_index()) && !target_method()->is_private()) {
 413       target_method()->set_vtable_index(Method::pending_itable_index);
 414     }
 415   }
 416 
 417   // we need a new entry if there is no superclass
 418   Klass* super = klass->super();
 419   if (super == NULL) {
 420     return allocate_new;
 421   }
 422 
 423   // private methods in classes always have a new entry in the vtable
 424   // specification interpretation since classic has
 425   // private methods not overriding
 426   // JDK8 adds private methods in interfaces which require invokespecial
 427   if (target_method()->is_private()) {
 428     return allocate_new;
 429   }
 430 
 431   // search through the vtable and update overridden entries
 432   // Since check_signature_loaders acquires SystemDictionary_lock
 433   // which can block for gc, once we are in this loop, use handles
 434   // For classfiles built with >= jdk7, we now look for transitive overrides
 435 
 436   Symbol* name = target_method()->name();
 437   Symbol* signature = target_method()->signature();
 438 
 439   Klass* target_klass = target_method()->method_holder();
 440   if (target_klass == NULL) {
 441     target_klass = _klass;
 442   }
 443 
 444   Handle target_loader(THREAD, target_klass->class_loader());
 445 
 446   Symbol* target_classname = target_klass->name();
 447   for(int i = 0; i < super_vtable_len; i++) {
 448     Method* super_method;
 449     if (is_preinitialized_vtable()) {
 450       // If this is a shared class, the vtable is already in the final state (fully
 451       // initialized). Need to look at the super's vtable.
 452       klassVtable superVtable = super->vtable();
 453       super_method = superVtable.method_at(i);
 454     } else {
 455       super_method = method_at(i);
 456     }
 457     // Check if method name matches
 458     if (super_method->name() == name && super_method->signature() == signature) {
 459 
 460       // get super_klass for method_holder for the found method
 461       InstanceKlass* super_klass =  super_method->method_holder();
 462 
 463       // Whether the method is being overridden
 464       bool overrides = false;
 465 
 466       // private methods are also never overridden
 467       if (!super_method->is_private() &&
 468           (is_default
 469           || ((super_klass->is_override(super_method, target_loader, target_classname, THREAD))
 470           || ((klass->major_version() >= VTABLE_TRANSITIVE_OVERRIDE_VERSION)
 471           && ((super_klass = find_transitive_override(super_klass,
 472                              target_method, i, target_loader,
 473                              target_classname, THREAD))
 474                              != (InstanceKlass*)NULL)))))
 475         {
 476         // Package private methods always need a new entry to root their own
 477         // overriding. They may also override other methods.
 478         if (!target_method()->is_package_private()) {
 479           allocate_new = false;
 480         }
 481 
 482         // Do not check loader constraints for overpass methods because overpass
 483         // methods are created by the jvm to throw exceptions.  They are not
 484         // resolved methods.
 485         if (checkconstraints && !target_method()->is_overpass()) {
 486           // Override vtable entry if passes loader constraint check
 487           // if loader constraint checking requested
 488           // No need to visit his super, since he and his super
 489           // have already made any needed loader constraints.
 490           // Since loader constraints are transitive, it is enough
 491           // to link to the first super, and we get all the others.
 492           Handle super_loader(THREAD, super_klass->class_loader());
 493 
 494           if (target_loader() != super_loader()) {
 495             ResourceMark rm(THREAD);
 496             Symbol* failed_type_symbol =
 497               SystemDictionary::check_signature_loaders(signature, target_loader,
 498                                                         super_loader, true,
 499                                                         CHECK_(false));
 500             if (failed_type_symbol != NULL) {
 501               const char* msg = "loader constraint violation for class %s: when resolving "
 502                 "overriding method \"%s\" the class loader (instance of %s) of the "
 503                 "selected method's type, %s, and the class loader (instance of %s) for its super "
 504                 "type %s have different Class objects for the type %s used in the signature";
 505               char* curr_class = klass->name()->as_C_string();
 506               char* sig = target_method()->name_and_sig_as_C_string();
 507               const char* loader1 = SystemDictionary::loader_name(target_loader());
 508               char* sel_class = target_klass->name()->as_C_string();
 509               const char* loader2 = SystemDictionary::loader_name(super_loader());
 510               char* super_class = super_klass->name()->as_C_string();
 511               char* failed_type_name = failed_type_symbol->as_C_string();
 512               size_t buflen = strlen(msg) + strlen(curr_class) + strlen(sig) +
 513                 strlen(loader1) + strlen(sel_class) + strlen(loader2) +
 514                 strlen(super_class) + strlen(failed_type_name);
 515               char* buf = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, buflen);
 516               jio_snprintf(buf, buflen, msg, curr_class, sig, loader1, sel_class, loader2,
 517                            super_class, failed_type_name);
 518               THROW_MSG_(vmSymbols::java_lang_LinkageError(), buf, false);
 519             }
 520           }
 521         }
 522 
 523         put_method_at(target_method(), i);
 524         overrides = true;
 525         if (!is_default) {
 526           target_method()->set_vtable_index(i);
 527         } else {
 528           if (def_vtable_indices != NULL) {
 529             if (is_preinitialized_vtable()) {
 530               // At runtime initialize_vtable is rerun as part of link_class_impl()
 531               // for a shared class loaded by the non-boot loader.
 532               // The dumptime vtable index should be the same as the runtime index.
 533               assert(def_vtable_indices->at(default_index) == i,
 534                      "dump time vtable index is different from runtime index");
 535             } else {
 536               def_vtable_indices->at_put(default_index, i);
 537             }
 538           }
 539           assert(super_method->is_default_method() || super_method->is_overpass()
 540                  || super_method->is_abstract(), "default override error");
 541         }
 542       } else {
 543         overrides = false;
 544       }
 545       log_vtables(i, overrides, target_method, target_klass, super_method, THREAD);
 546     }
 547   }
 548   return allocate_new;
 549 }
 550 
 551 void klassVtable::put_method_at(Method* m, int index) {
 552   if (is_preinitialized_vtable()) {
 553     // At runtime initialize_vtable is rerun as part of link_class_impl()
 554     // for shared class loaded by the non-boot loader to obtain the loader
 555     // constraints based on the runtime classloaders' context. The dumptime
 556     // method at the vtable index should be the same as the runtime method.
 557     assert(table()[index].method() == m,
 558            "archived method is different from the runtime method");
 559   } else {
 560     if (log_develop_is_enabled(Trace, vtables)) {
 561       ResourceMark rm;
 562       LogTarget(Trace, vtables) lt;
 563       LogStream ls(lt);
 564       const char* sig = (m != NULL) ? m->name_and_sig_as_C_string() : "<NULL>";
 565       ls.print("adding %s at index %d, flags: ", sig, index);
 566       if (m != NULL) {
 567         m->print_linkage_flags(&ls);
 568       }
 569       ls.cr();
 570     }
 571     table()[index].set(m);
 572   }
 573 }
 574 
 575 // Find out if a method "m" with superclass "super", loader "classloader" and
 576 // name "classname" needs a new vtable entry.  Let P be a class package defined
 577 // by "classloader" and "classname".
 578 // NOTE: The logic used here is very similar to the one used for computing
 579 // the vtables indices for a method. We cannot directly use that function because,
 580 // we allocate the InstanceKlass at load time, and that requires that the
 581 // superclass has been loaded.
 582 // However, the vtable entries are filled in at link time, and therefore
 583 // the superclass' vtable may not yet have been filled in.
 584 bool klassVtable::needs_new_vtable_entry(const methodHandle& target_method,
 585                                          const Klass* super,
 586                                          Handle classloader,
 587                                          Symbol* classname,
 588                                          AccessFlags class_flags,
 589                                          u2 major_version,
 590                                          TRAPS) {
 591   if (class_flags.is_interface()) {
 592     // Interfaces do not use vtables, except for java.lang.Object methods,
 593     // so there is no point to assigning
 594     // a vtable index to any of their local methods.  If we refrain from doing this,
 595     // we can use Method::_vtable_index to hold the itable index
 596     return false;
 597   }
 598 
 599   if (target_method->is_final_method(class_flags) ||
 600       // a final method never needs a new entry; final methods can be statically
 601       // resolved and they have to be present in the vtable only if they override
 602       // a super's method, in which case they re-use its entry
 603       (target_method()->is_static()) ||
 604       // static methods don't need to be in vtable
 605       (target_method()->name() ==  vmSymbols::object_initializer_name())
 606       // <init> is never called dynamically-bound
 607       ) {
 608     return false;
 609   }
 610 
 611   // Concrete interface methods do not need new entries, they override
 612   // abstract method entries using default inheritance rules
 613   if (target_method()->method_holder() != NULL &&
 614       target_method()->method_holder()->is_interface()  &&
 615       !target_method()->is_abstract()) {
 616     assert(target_method()->is_default_method() || target_method()->is_private(),
 617            "unexpected interface method type");
 618     return false;
 619   }
 620 
 621   // we need a new entry if there is no superclass
 622   if (super == NULL) {
 623     return true;
 624   }
 625 
 626   // private methods in classes always have a new entry in the vtable.
 627   // Specification interpretation since classic has private methods not overriding.
 628   if (target_method()->is_private()) {
 629     return true;
 630   }
 631 
 632   // Package private methods always need a new entry to root their own
 633   // overriding. This allows transitive overriding to work.
 634   if (target_method()->is_package_private()) {
 635     return true;
 636   }
 637 
 638   // search through the super class hierarchy to see if we need
 639   // a new entry
 640   ResourceMark rm;
 641   Symbol* name = target_method()->name();
 642   Symbol* signature = target_method()->signature();
 643   const Klass* k = super;
 644   Method* super_method = NULL;
 645   InstanceKlass *holder = NULL;
 646   Method* recheck_method =  NULL;
 647   while (k != NULL) {
 648     // lookup through the hierarchy for a method with matching name and sign.
 649     super_method = InstanceKlass::cast(k)->lookup_method(name, signature);
 650     if (super_method == NULL) {
 651       break; // we still have to search for a matching miranda method
 652     }
 653     // get the class holding the matching method
 654     // make sure you use that class for is_override
 655     InstanceKlass* superk = super_method->method_holder();
 656     // we want only instance method matches
 657     // pretend private methods are not in the super vtable
 658     // since we do override around them: e.g. a.m pub/b.m private/c.m pub,
 659     // ignore private, c.m pub does override a.m pub
 660     // For classes that were not javac'd together, we also do transitive overriding around
 661     // methods that have less accessibility
 662     if ((!super_method->is_static()) &&
 663        (!super_method->is_private())) {
 664       if (superk->is_override(super_method, classloader, classname, THREAD)) {
 665         return false;
 666       // else keep looking for transitive overrides
 667       }
 668     }
 669 
 670     // Start with lookup result and continue to search up, for versions supporting transitive override
 671     if (major_version >= VTABLE_TRANSITIVE_OVERRIDE_VERSION) {
 672       k = superk->super(); // haven't found an override match yet; continue to look
 673     } else {
 674       break;
 675     }
 676   }
 677 
 678   // if the target method is public or protected it may have a matching
 679   // miranda method in the super, whose entry it should re-use.
 680   // Actually, to handle cases that javac would not generate, we need
 681   // this check for all access permissions.
 682   const InstanceKlass *sk = InstanceKlass::cast(super);
 683   if (sk->has_miranda_methods()) {
 684     if (sk->lookup_method_in_all_interfaces(name, signature, Klass::find_defaults) != NULL) {
 685       return false;  // found a matching miranda; we do not need a new entry
 686     }
 687   }
 688   return true; // found no match; we need a new entry
 689 }
 690 
 691 // Support for miranda methods
 692 
 693 // get the vtable index of a miranda method with matching "name" and "signature"
 694 int klassVtable::index_of_miranda(Symbol* name, Symbol* signature) {
 695   // search from the bottom, might be faster
 696   for (int i = (length() - 1); i >= 0; i--) {
 697     Method* m = table()[i].method();
 698     if (is_miranda_entry_at(i) &&
 699         m->name() == name && m->signature() == signature) {
 700       return i;
 701     }
 702   }
 703   return Method::invalid_vtable_index;
 704 }
 705 
 706 // check if an entry at an index is miranda
 707 // requires that method m at entry be declared ("held") by an interface.
 708 bool klassVtable::is_miranda_entry_at(int i) {
 709   Method* m = method_at(i);
 710   Klass* method_holder = m->method_holder();
 711   InstanceKlass *mhk = InstanceKlass::cast(method_holder);
 712 
 713   // miranda methods are public abstract instance interface methods in a class's vtable
 714   if (mhk->is_interface()) {
 715     assert(m->is_public(), "should be public");
 716     assert(ik()->implements_interface(method_holder) , "this class should implement the interface");
 717     if (is_miranda(m, ik()->methods(), ik()->default_methods(), ik()->super())) {
 718       return true;
 719     }
 720   }
 721   return false;
 722 }
 723 
 724 // Check if a method is a miranda method, given a class's methods array,
 725 // its default_method table and its super class.
 726 // "Miranda" means an abstract non-private method that would not be
 727 // overridden for the local class.
 728 // A "miranda" method should only include non-private interface
 729 // instance methods, i.e. not private methods, not static methods,
 730 // not default methods (concrete interface methods), not overpass methods.
 731 // If a given class already has a local (including overpass) method, a
 732 // default method, or any of its superclasses has the same which would have
 733 // overridden an abstract method, then this is not a miranda method.
 734 //
 735 // Miranda methods are checked multiple times.
 736 // Pass 1: during class load/class file parsing: before vtable size calculation:
 737 // include superinterface abstract and default methods (non-private instance).
 738 // We include potential default methods to give them space in the vtable.
 739 // During the first run, the current instanceKlass has not yet been
 740 // created, the superclasses and superinterfaces do have instanceKlasses
 741 // but may not have vtables, the default_methods list is empty, no overpasses.
 742 // This is seen by default method creation.
 743 //
 744 // Pass 2: recalculated during vtable initialization: only include abstract methods.
 745 // The goal of pass 2 is to walk through the superinterfaces to see if any of
 746 // the superinterface methods (which were all abstract pre-default methods)
 747 // need to be added to the vtable.
 748 // With the addition of default methods, we have three new challenges:
 749 // overpasses, static interface methods and private interface methods.
 750 // Static and private interface methods do not get added to the vtable and
 751 // are not seen by the method resolution process, so we skip those.
 752 // Overpass methods are already in the vtable, so vtable lookup will
 753 // find them and we don't need to add a miranda method to the end of
 754 // the vtable. So we look for overpass methods and if they are found we
 755 // return false. Note that we inherit our superclasses vtable, so
 756 // the superclass' search also needs to use find_overpass so that if
 757 // one is found we return false.
 758 // False means - we don't need a miranda method added to the vtable.
 759 //
 760 // During the second run, default_methods is set up, so concrete methods from
 761 // superinterfaces with matching names/signatures to default_methods are already
 762 // in the default_methods list and do not need to be appended to the vtable
 763 // as mirandas. Abstract methods may already have been handled via
 764 // overpasses - either local or superclass overpasses, which may be
 765 // in the vtable already.
 766 //
 767 // Pass 3: They are also checked by link resolution and selection,
 768 // for invocation on a method (not interface method) reference that
 769 // resolves to a method with an interface as its method_holder.
 770 // Used as part of walking from the bottom of the vtable to find
 771 // the vtable index for the miranda method.
 772 //
 773 // Part of the Miranda Rights in the US mean that if you do not have
 774 // an attorney one will be appointed for you.
 775 bool klassVtable::is_miranda(Method* m, Array<Method*>* class_methods,
 776                              Array<Method*>* default_methods, const Klass* super) {
 777   if (m->is_static() || m->is_private() || m->is_overpass()) {
 778     return false;
 779   }
 780   Symbol* name = m->name();
 781   Symbol* signature = m->signature();
 782 
 783   // First look in local methods to see if already covered
 784   if (InstanceKlass::find_local_method(class_methods, name, signature,
 785               Klass::find_overpass, Klass::skip_static, Klass::skip_private) != NULL)
 786   {
 787     return false;
 788   }
 789 
 790   // Check local default methods
 791   if ((default_methods != NULL) &&
 792     (InstanceKlass::find_method(default_methods, name, signature) != NULL))
 793    {
 794      return false;
 795    }
 796 
 797   // Iterate on all superclasses, which should be InstanceKlasses.
 798   // Note that we explicitly look for overpasses at each level.
 799   // Overpasses may or may not exist for supers for pass 1,
 800   // they should have been created for pass 2 and later.
 801 
 802   for (const Klass* cursuper = super; cursuper != NULL; cursuper = cursuper->super())
 803   {
 804      if (InstanceKlass::cast(cursuper)->find_local_method(name, signature,
 805            Klass::find_overpass, Klass::skip_static, Klass::skip_private) != NULL) {
 806        return false;
 807      }
 808   }
 809 
 810   return true;
 811 }
 812 
 813 // Scans current_interface_methods for miranda methods that do not
 814 // already appear in new_mirandas, or default methods,  and are also not defined-and-non-private
 815 // in super (superclass).  These mirandas are added to all_mirandas if it is
 816 // not null; in addition, those that are not duplicates of miranda methods
 817 // inherited by super from its interfaces are added to new_mirandas.
 818 // Thus, new_mirandas will be the set of mirandas that this class introduces,
 819 // all_mirandas will be the set of all mirandas applicable to this class
 820 // including all defined in superclasses.
 821 void klassVtable::add_new_mirandas_to_lists(
 822     GrowableArray<Method*>* new_mirandas, GrowableArray<Method*>* all_mirandas,
 823     Array<Method*>* current_interface_methods, Array<Method*>* class_methods,
 824     Array<Method*>* default_methods, const Klass* super) {
 825 
 826   // iterate thru the current interface's method to see if it a miranda
 827   int num_methods = current_interface_methods->length();
 828   for (int i = 0; i < num_methods; i++) {
 829     Method* im = current_interface_methods->at(i);
 830     bool is_duplicate = false;
 831     int num_of_current_mirandas = new_mirandas->length();
 832     // check for duplicate mirandas in different interfaces we implement
 833     for (int j = 0; j < num_of_current_mirandas; j++) {
 834       Method* miranda = new_mirandas->at(j);
 835       if ((im->name() == miranda->name()) &&
 836           (im->signature() == miranda->signature())) {
 837         is_duplicate = true;
 838         break;
 839       }
 840     }
 841 
 842     if (!is_duplicate) { // we don't want duplicate miranda entries in the vtable
 843       if (is_miranda(im, class_methods, default_methods, super)) { // is it a miranda at all?
 844         const InstanceKlass *sk = InstanceKlass::cast(super);
 845         // check if it is a duplicate of a super's miranda
 846         if (sk->lookup_method_in_all_interfaces(im->name(), im->signature(), Klass::find_defaults) == NULL) {
 847           new_mirandas->append(im);
 848         }
 849         if (all_mirandas != NULL) {
 850           all_mirandas->append(im);
 851         }
 852       }
 853     }
 854   }
 855 }
 856 
 857 void klassVtable::get_mirandas(GrowableArray<Method*>* new_mirandas,
 858                                GrowableArray<Method*>* all_mirandas,
 859                                const Klass* super,
 860                                Array<Method*>* class_methods,
 861                                Array<Method*>* default_methods,
 862                                Array<Klass*>* local_interfaces) {
 863   assert((new_mirandas->length() == 0) , "current mirandas must be 0");
 864 
 865   // iterate thru the local interfaces looking for a miranda
 866   int num_local_ifs = local_interfaces->length();
 867   for (int i = 0; i < num_local_ifs; i++) {
 868     InstanceKlass *ik = InstanceKlass::cast(local_interfaces->at(i));
 869     add_new_mirandas_to_lists(new_mirandas, all_mirandas,
 870                               ik->methods(), class_methods,
 871                               default_methods, super);
 872     // iterate thru each local's super interfaces
 873     Array<Klass*>* super_ifs = ik->transitive_interfaces();
 874     int num_super_ifs = super_ifs->length();
 875     for (int j = 0; j < num_super_ifs; j++) {
 876       InstanceKlass *sik = InstanceKlass::cast(super_ifs->at(j));
 877       add_new_mirandas_to_lists(new_mirandas, all_mirandas,
 878                                 sik->methods(), class_methods,
 879                                 default_methods, super);
 880     }
 881   }
 882 }
 883 
 884 // Discover miranda methods ("miranda" = "interface abstract, no binding"),
 885 // and append them into the vtable starting at index initialized,
 886 // return the new value of initialized.
 887 // Miranda methods use vtable entries, but do not get assigned a vtable_index
 888 // The vtable_index is discovered by searching from the end of the vtable
 889 int klassVtable::fill_in_mirandas(int initialized) {
 890   GrowableArray<Method*> mirandas(20);
 891   get_mirandas(&mirandas, NULL, ik()->super(), ik()->methods(),
 892                ik()->default_methods(), ik()->local_interfaces());
 893   for (int i = 0; i < mirandas.length(); i++) {
 894     if (log_develop_is_enabled(Trace, vtables)) {
 895       Method* meth = mirandas.at(i);
 896       ResourceMark rm(Thread::current());
 897       LogTarget(Trace, vtables) lt;
 898       LogStream ls(lt);
 899       if (meth != NULL) {
 900         char* sig = meth->name_and_sig_as_C_string();
 901         ls.print("fill in mirandas with %s index %d, flags: ",
 902                      sig, initialized);
 903         meth->print_linkage_flags(&ls);
 904         ls.cr();
 905       }
 906     }
 907     put_method_at(mirandas.at(i), initialized);
 908     ++initialized;
 909   }
 910   return initialized;
 911 }
 912 
 913 // Copy this class's vtable to the vtable beginning at start.
 914 // Used to copy superclass vtable to prefix of subclass's vtable.
 915 void klassVtable::copy_vtable_to(vtableEntry* start) {
 916   Copy::disjoint_words((HeapWord*)table(), (HeapWord*)start, _length * vtableEntry::size());
 917 }
 918 
 919 #if INCLUDE_JVMTI
 920 bool klassVtable::adjust_default_method(int vtable_index, Method* old_method, Method* new_method) {
 921   // If old_method is default, find this vtable index in default_vtable_indices
 922   // and replace that method in the _default_methods list
 923   bool updated = false;
 924 
 925   Array<Method*>* default_methods = ik()->default_methods();
 926   if (default_methods != NULL) {
 927     int len = default_methods->length();
 928     for (int idx = 0; idx < len; idx++) {
 929       if (vtable_index == ik()->default_vtable_indices()->at(idx)) {
 930         if (default_methods->at(idx) == old_method) {
 931           default_methods->at_put(idx, new_method);
 932           updated = true;
 933         }
 934         break;
 935       }
 936     }
 937   }
 938   return updated;
 939 }
 940 
 941 // search the vtable for uses of either obsolete or EMCP methods
 942 void klassVtable::adjust_method_entries(InstanceKlass* holder, bool * trace_name_printed) {
 943   int prn_enabled = 0;
 944   for (int index = 0; index < length(); index++) {
 945     Method* old_method = unchecked_method_at(index);
 946     if (old_method == NULL || old_method->method_holder() != holder || !old_method->is_old()) {
 947       continue; // skip uninteresting entries
 948     }
 949     assert(!old_method->is_deleted(), "vtable methods may not be deleted");
 950 
 951     Method* new_method = holder->method_with_idnum(old_method->orig_method_idnum());
 952 
 953     assert(new_method != NULL, "method_with_idnum() should not be NULL");
 954     assert(old_method != new_method, "sanity check");
 955 
 956     put_method_at(new_method, index);
 957     // For default methods, need to update the _default_methods array
 958     // which can only have one method entry for a given signature
 959     bool updated_default = false;
 960     if (old_method->is_default_method()) {
 961       updated_default = adjust_default_method(index, old_method, new_method);
 962     }
 963 
 964     if (log_is_enabled(Info, redefine, class, update)) {
 965       ResourceMark rm;
 966       if (!(*trace_name_printed)) {
 967         log_info(redefine, class, update)
 968           ("adjust: klassname=%s for methods from name=%s",
 969            _klass->external_name(), old_method->method_holder()->external_name());
 970         *trace_name_printed = true;
 971       }
 972       log_debug(redefine, class, update, vtables)
 973         ("vtable method update: %s(%s), updated default = %s",
 974          new_method->name()->as_C_string(), new_method->signature()->as_C_string(), updated_default ? "true" : "false");
 975     }
 976   }
 977 }
 978 
 979 // a vtable should never contain old or obsolete methods
 980 bool klassVtable::check_no_old_or_obsolete_entries() {
 981   for (int i = 0; i < length(); i++) {
 982     Method* m = unchecked_method_at(i);
 983     if (m != NULL &&
 984         (NOT_PRODUCT(!m->is_valid() ||) m->is_old() || m->is_obsolete())) {
 985       return false;
 986     }
 987   }
 988   return true;
 989 }
 990 
 991 void klassVtable::dump_vtable() {
 992   tty->print_cr("vtable dump --");
 993   for (int i = 0; i < length(); i++) {
 994     Method* m = unchecked_method_at(i);
 995     if (m != NULL) {
 996       tty->print("      (%5d)  ", i);
 997       m->access_flags().print_on(tty);
 998       if (m->is_default_method()) {
 999         tty->print("default ");
1000       }
1001       if (m->is_overpass()) {
1002         tty->print("overpass");
1003       }
1004       tty->print(" --  ");
1005       m->print_name(tty);
1006       tty->cr();
1007     }
1008   }
1009 }
1010 #endif // INCLUDE_JVMTI
1011 
1012 // CDS/RedefineClasses support - clear vtables so they can be reinitialized
1013 void klassVtable::clear_vtable() {
1014   for (int i = 0; i < _length; i++) table()[i].clear();
1015 }
1016 
1017 bool klassVtable::is_initialized() {
1018   return _length == 0 || table()[0].method() != NULL;
1019 }
1020 
1021 //-----------------------------------------------------------------------------------------
1022 // Itable code
1023 
1024 // Initialize a itableMethodEntry
1025 void itableMethodEntry::initialize(Method* m) {
1026   if (m == NULL) return;
1027 
1028 #ifdef ASSERT
1029   if (MetaspaceShared::is_in_shared_space((void*)&_method) &&
1030      !MetaspaceShared::remapped_readwrite()) {
1031     // At runtime initialize_itable is rerun as part of link_class_impl()
1032     // for a shared class loaded by the non-boot loader.
1033     // The dumptime itable method entry should be the same as the runtime entry.
1034     assert(_method == m, "sanity");
1035   }
1036 #endif
1037   _method = m;
1038 }
1039 
1040 klassItable::klassItable(InstanceKlass* klass) {
1041   _klass = klass;
1042 
1043   if (klass->itable_length() > 0) {
1044     itableOffsetEntry* offset_entry = (itableOffsetEntry*)klass->start_of_itable();
1045     if (offset_entry  != NULL && offset_entry->interface_klass() != NULL) { // Check that itable is initialized
1046       // First offset entry points to the first method_entry
1047       intptr_t* method_entry  = (intptr_t *)(((address)klass) + offset_entry->offset());
1048       intptr_t* end         = klass->end_of_itable();
1049 
1050       _table_offset      = (intptr_t*)offset_entry - (intptr_t*)klass;
1051       _size_offset_table = (method_entry - ((intptr_t*)offset_entry)) / itableOffsetEntry::size();
1052       _size_method_table = (end - method_entry)                  / itableMethodEntry::size();
1053       assert(_table_offset >= 0 && _size_offset_table >= 0 && _size_method_table >= 0, "wrong computation");
1054       return;
1055     }
1056   }
1057 
1058   // The length of the itable was either zero, or it has not yet been initialized.
1059   _table_offset      = 0;
1060   _size_offset_table = 0;
1061   _size_method_table = 0;
1062 }
1063 
1064 static int initialize_count = 0;
1065 
1066 // Initialization
1067 void klassItable::initialize_itable(bool checkconstraints, TRAPS) {
1068   if (_klass->is_interface()) {
1069     // This needs to go after vtable indices are assigned but
1070     // before implementors need to know the number of itable indices.
1071     assign_itable_indices_for_interface(_klass);
1072   }
1073 
1074   // Cannot be setup doing bootstrapping, interfaces don't have
1075   // itables, and klass with only ones entry have empty itables
1076   if (Universe::is_bootstrapping() ||
1077       _klass->is_interface() ||
1078       _klass->itable_length() == itableOffsetEntry::size()) return;
1079 
1080   // There's alway an extra itable entry so we can null-terminate it.
1081   guarantee(size_offset_table() >= 1, "too small");
1082   int num_interfaces = size_offset_table() - 1;
1083   if (num_interfaces > 0) {
1084     log_develop_debug(itables)("%3d: Initializing itables for %s", ++initialize_count,
1085                        _klass->name()->as_C_string());
1086 
1087 
1088     // Iterate through all interfaces
1089     int i;
1090     for(i = 0; i < num_interfaces; i++) {
1091       itableOffsetEntry* ioe = offset_entry(i);
1092       HandleMark hm(THREAD);
1093       Klass* interf = ioe->interface_klass();
1094       assert(interf != NULL && ioe->offset() != 0, "bad offset entry in itable");
1095       initialize_itable_for_interface(ioe->offset(), interf, checkconstraints, CHECK);
1096     }
1097 
1098   }
1099   // Check that the last entry is empty
1100   itableOffsetEntry* ioe = offset_entry(size_offset_table() - 1);
1101   guarantee(ioe->interface_klass() == NULL && ioe->offset() == 0, "terminator entry missing");
1102 }
1103 
1104 
1105 inline bool interface_method_needs_itable_index(Method* m) {
1106   if (m->is_static())           return false;   // e.g., Stream.empty
1107   if (m->is_initializer())      return false;   // <init> or <clinit>
1108   if (m->is_private())          return false;   // requires invokeSpecial
1109   // If an interface redeclares a method from java.lang.Object,
1110   // it should already have a vtable index, don't touch it.
1111   // e.g., CharSequence.toString (from initialize_vtable)
1112   // if (m->has_vtable_index())  return false; // NO!
1113   return true;
1114 }
1115 
1116 int klassItable::assign_itable_indices_for_interface(Klass* klass) {
1117   // an interface does not have an itable, but its methods need to be numbered
1118   log_develop_debug(itables)("%3d: Initializing itable indices for interface %s",
1119                              ++initialize_count, klass->name()->as_C_string());
1120   Array<Method*>* methods = InstanceKlass::cast(klass)->methods();
1121   int nof_methods = methods->length();
1122   int ime_num = 0;
1123   for (int i = 0; i < nof_methods; i++) {
1124     Method* m = methods->at(i);
1125     if (interface_method_needs_itable_index(m)) {
1126       assert(!m->is_final_method(), "no final interface methods");
1127       // If m is already assigned a vtable index, do not disturb it.
1128       if (log_develop_is_enabled(Trace, itables)) {
1129         ResourceMark rm;
1130         LogTarget(Trace, itables) lt;
1131         LogStream ls(lt);
1132         assert(m != NULL, "methods can never be null");
1133         const char* sig = m->name_and_sig_as_C_string();
1134         if (m->has_vtable_index()) {
1135           ls.print("vtable index %d for method: %s, flags: ", m->vtable_index(), sig);
1136         } else {
1137           ls.print("itable index %d for method: %s, flags: ", ime_num, sig);
1138         }
1139         m->print_linkage_flags(&ls);
1140         ls.cr();
1141       }
1142       if (!m->has_vtable_index()) {
1143         // A shared method could have an initialized itable_index that
1144         // is < 0.
1145         assert(m->vtable_index() == Method::pending_itable_index ||
1146                m->is_shared(),
1147                "set by initialize_vtable");
1148         m->set_itable_index(ime_num);
1149         // Progress to next itable entry
1150         ime_num++;
1151       }
1152     }
1153   }
1154   assert(ime_num == method_count_for_interface(klass), "proper sizing");
1155   return ime_num;
1156 }
1157 
1158 int klassItable::method_count_for_interface(Klass* interf) {
1159   assert(interf->is_instance_klass(), "must be");
1160   assert(interf->is_interface(), "must be");
1161   Array<Method*>* methods = InstanceKlass::cast(interf)->methods();
1162   int nof_methods = methods->length();
1163   int length = 0;
1164   while (nof_methods > 0) {
1165     Method* m = methods->at(nof_methods-1);
1166     if (m->has_itable_index()) {
1167       length = m->itable_index() + 1;
1168       break;
1169     }
1170     nof_methods -= 1;
1171   }
1172 #ifdef ASSERT
1173   int nof_methods_copy = nof_methods;
1174   while (nof_methods_copy > 0) {
1175     Method* mm = methods->at(--nof_methods_copy);
1176     assert(!mm->has_itable_index() || mm->itable_index() < length, "");
1177   }
1178 #endif //ASSERT
1179   // return the rightmost itable index, plus one; or 0 if no methods have
1180   // itable indices
1181   return length;
1182 }
1183 
1184 
1185 void klassItable::initialize_itable_for_interface(int method_table_offset, Klass* interf, bool checkconstraints, TRAPS) {
1186   Array<Method*>* methods = InstanceKlass::cast(interf)->methods();
1187   int nof_methods = methods->length();
1188   HandleMark hm;
1189   assert(nof_methods > 0, "at least one method must exist for interface to be in vtable");
1190   Handle interface_loader (THREAD, InstanceKlass::cast(interf)->class_loader());
1191 
1192   int ime_count = method_count_for_interface(interf);
1193   for (int i = 0; i < nof_methods; i++) {
1194     Method* m = methods->at(i);
1195     methodHandle target;
1196     if (m->has_itable_index()) {
1197       // This search must match the runtime resolution, i.e. selection search for invokeinterface
1198       // to correctly enforce loader constraints for interface method inheritance
1199       target = LinkResolver::lookup_instance_method_in_klasses(_klass, m->name(), m->signature(), CHECK);
1200     }
1201     if (target == NULL || !target->is_public() || target->is_abstract() || target->is_overpass()) {
1202       // Entry does not resolve. Leave it empty for AbstractMethodError or other error.
1203       if (!(target == NULL) && !target->is_public() && !target->is_overpass()) {
1204         // Stuff an IllegalAccessError throwing method in there instead.
1205         itableOffsetEntry::method_entry(_klass, method_table_offset)[m->itable_index()].
1206             initialize(Universe::throw_illegal_access_error());
1207       }
1208     } else {
1209       // Entry did resolve, check loader constraints before initializing
1210       // if checkconstraints requested
1211       if (checkconstraints) {
1212         Handle method_holder_loader (THREAD, target->method_holder()->class_loader());
1213         if (method_holder_loader() != interface_loader()) {
1214           ResourceMark rm(THREAD);
1215           Symbol* failed_type_symbol =
1216             SystemDictionary::check_signature_loaders(m->signature(),
1217                                                       method_holder_loader,
1218                                                       interface_loader,
1219                                                       true, CHECK);
1220           if (failed_type_symbol != NULL) {
1221             const char* msg = "loader constraint violation in interface itable"
1222               " initialization for class %s: when resolving method \"%s\" the"
1223               " class loader (instance of %s) for super interface %s, and the class"
1224               " loader (instance of %s) of the selected method's type, %s have"
1225               " different Class objects for the type %s used in the signature";
1226             char* current = _klass->name()->as_C_string();
1227             char* sig = m->name_and_sig_as_C_string();
1228             const char* loader1 = SystemDictionary::loader_name(interface_loader());
1229             char* iface = InstanceKlass::cast(interf)->name()->as_C_string();
1230             const char* loader2 = SystemDictionary::loader_name(method_holder_loader());
1231             char* mclass = target()->method_holder()->name()->as_C_string();
1232             char* failed_type_name = failed_type_symbol->as_C_string();
1233             size_t buflen = strlen(msg) + strlen(current) + strlen(sig) +
1234               strlen(loader1) + strlen(iface) + strlen(loader2) + strlen(mclass) +
1235               strlen(failed_type_name);
1236             char* buf = NEW_RESOURCE_ARRAY_IN_THREAD(THREAD, char, buflen);
1237             jio_snprintf(buf, buflen, msg, current, sig, loader1, iface,
1238                          loader2, mclass, failed_type_name);
1239             THROW_MSG(vmSymbols::java_lang_LinkageError(), buf);
1240           }
1241         }
1242       }
1243 
1244       // ime may have moved during GC so recalculate address
1245       int ime_num = m->itable_index();
1246       assert(ime_num < ime_count, "oob");
1247       itableOffsetEntry::method_entry(_klass, method_table_offset)[ime_num].initialize(target());
1248       if (log_develop_is_enabled(Trace, itables)) {
1249         ResourceMark rm(THREAD);
1250         if (target() != NULL) {
1251           LogTarget(Trace, itables) lt;
1252           LogStream ls(lt);
1253           char* sig = target()->name_and_sig_as_C_string();
1254           ls.print("interface: %s, ime_num: %d, target: %s, method_holder: %s ",
1255                        interf->internal_name(), ime_num, sig,
1256                        target()->method_holder()->internal_name());
1257           ls.print("target_method flags: ");
1258           target()->print_linkage_flags(&ls);
1259           ls.cr();
1260         }
1261       }
1262     }
1263   }
1264 }
1265 
1266 #if INCLUDE_JVMTI
1267 // search the itable for uses of either obsolete or EMCP methods
1268 void klassItable::adjust_method_entries(InstanceKlass* holder, bool * trace_name_printed) {
1269 
1270   itableMethodEntry* ime = method_entry(0);
1271   for (int i = 0; i < _size_method_table; i++, ime++) {
1272     Method* old_method = ime->method();
1273     if (old_method == NULL || old_method->method_holder() != holder || !old_method->is_old()) {
1274       continue; // skip uninteresting entries
1275     }
1276     assert(!old_method->is_deleted(), "itable methods may not be deleted");
1277 
1278     Method* new_method = holder->method_with_idnum(old_method->orig_method_idnum());
1279 
1280     assert(new_method != NULL, "method_with_idnum() should not be NULL");
1281     assert(old_method != new_method, "sanity check");
1282 
1283     ime->initialize(new_method);
1284 
1285     if (log_is_enabled(Info, redefine, class, update)) {
1286       ResourceMark rm;
1287       if (!(*trace_name_printed)) {
1288         log_info(redefine, class, update)("adjust: name=%s", old_method->method_holder()->external_name());
1289         *trace_name_printed = true;
1290       }
1291       log_trace(redefine, class, update, itables)
1292         ("itable method update: %s(%s)", new_method->name()->as_C_string(), new_method->signature()->as_C_string());
1293     }
1294   }
1295 }
1296 
1297 // an itable should never contain old or obsolete methods
1298 bool klassItable::check_no_old_or_obsolete_entries() {
1299   itableMethodEntry* ime = method_entry(0);
1300   for (int i = 0; i < _size_method_table; i++) {
1301     Method* m = ime->method();
1302     if (m != NULL &&
1303         (NOT_PRODUCT(!m->is_valid() ||) m->is_old() || m->is_obsolete())) {
1304       return false;
1305     }
1306     ime++;
1307   }
1308   return true;
1309 }
1310 
1311 void klassItable::dump_itable() {
1312   itableMethodEntry* ime = method_entry(0);
1313   tty->print_cr("itable dump --");
1314   for (int i = 0; i < _size_method_table; i++) {
1315     Method* m = ime->method();
1316     if (m != NULL) {
1317       tty->print("      (%5d)  ", i);
1318       m->access_flags().print_on(tty);
1319       if (m->is_default_method()) {
1320         tty->print("default ");
1321       }
1322       tty->print(" --  ");
1323       m->print_name(tty);
1324       tty->cr();
1325     }
1326     ime++;
1327   }
1328 }
1329 #endif // INCLUDE_JVMTI
1330 
1331 // Setup
1332 class InterfaceVisiterClosure : public StackObj {
1333  public:
1334   virtual void doit(Klass* intf, int method_count) = 0;
1335 };
1336 
1337 // Visit all interfaces with at least one itable method
1338 void visit_all_interfaces(Array<Klass*>* transitive_intf, InterfaceVisiterClosure *blk) {
1339   // Handle array argument
1340   for(int i = 0; i < transitive_intf->length(); i++) {
1341     Klass* intf = transitive_intf->at(i);
1342     assert(intf->is_interface(), "sanity check");
1343 
1344     // Find no. of itable methods
1345     int method_count = 0;
1346     // method_count = klassItable::method_count_for_interface(intf);
1347     Array<Method*>* methods = InstanceKlass::cast(intf)->methods();
1348     if (methods->length() > 0) {
1349       for (int i = methods->length(); --i >= 0; ) {
1350         if (interface_method_needs_itable_index(methods->at(i))) {
1351           method_count++;
1352         }
1353       }
1354     }
1355 
1356     // Only count interfaces with at least one method
1357     if (method_count > 0) {
1358       blk->doit(intf, method_count);
1359     }
1360   }
1361 }
1362 
1363 class CountInterfacesClosure : public InterfaceVisiterClosure {
1364  private:
1365   int _nof_methods;
1366   int _nof_interfaces;
1367  public:
1368    CountInterfacesClosure() { _nof_methods = 0; _nof_interfaces = 0; }
1369 
1370    int nof_methods() const    { return _nof_methods; }
1371    int nof_interfaces() const { return _nof_interfaces; }
1372 
1373    void doit(Klass* intf, int method_count) { _nof_methods += method_count; _nof_interfaces++; }
1374 };
1375 
1376 class SetupItableClosure : public InterfaceVisiterClosure  {
1377  private:
1378   itableOffsetEntry* _offset_entry;
1379   itableMethodEntry* _method_entry;
1380   address            _klass_begin;
1381  public:
1382   SetupItableClosure(address klass_begin, itableOffsetEntry* offset_entry, itableMethodEntry* method_entry) {
1383     _klass_begin  = klass_begin;
1384     _offset_entry = offset_entry;
1385     _method_entry = method_entry;
1386   }
1387 
1388   itableMethodEntry* method_entry() const { return _method_entry; }
1389 
1390   void doit(Klass* intf, int method_count) {
1391     int offset = ((address)_method_entry) - _klass_begin;
1392     _offset_entry->initialize(intf, offset);
1393     _offset_entry++;
1394     _method_entry += method_count;
1395   }
1396 };
1397 
1398 int klassItable::compute_itable_size(Array<Klass*>* transitive_interfaces) {
1399   // Count no of interfaces and total number of interface methods
1400   CountInterfacesClosure cic;
1401   visit_all_interfaces(transitive_interfaces, &cic);
1402 
1403   // There's alway an extra itable entry so we can null-terminate it.
1404   int itable_size = calc_itable_size(cic.nof_interfaces() + 1, cic.nof_methods());
1405 
1406   // Statistics
1407   update_stats(itable_size * wordSize);
1408 
1409   return itable_size;
1410 }
1411 
1412 
1413 // Fill out offset table and interface klasses into the itable space
1414 void klassItable::setup_itable_offset_table(InstanceKlass* klass) {
1415   if (klass->itable_length() == 0) return;
1416   assert(!klass->is_interface(), "Should have zero length itable");
1417 
1418   // Count no of interfaces and total number of interface methods
1419   CountInterfacesClosure cic;
1420   visit_all_interfaces(klass->transitive_interfaces(), &cic);
1421   int nof_methods    = cic.nof_methods();
1422   int nof_interfaces = cic.nof_interfaces();
1423 
1424   // Add one extra entry so we can null-terminate the table
1425   nof_interfaces++;
1426 
1427   assert(compute_itable_size(klass->transitive_interfaces()) ==
1428          calc_itable_size(nof_interfaces, nof_methods),
1429          "mismatch calculation of itable size");
1430 
1431   // Fill-out offset table
1432   itableOffsetEntry* ioe = (itableOffsetEntry*)klass->start_of_itable();
1433   itableMethodEntry* ime = (itableMethodEntry*)(ioe + nof_interfaces);
1434   intptr_t* end               = klass->end_of_itable();
1435   assert((oop*)(ime + nof_methods) <= (oop*)klass->start_of_nonstatic_oop_maps(), "wrong offset calculation (1)");
1436   assert((oop*)(end) == (oop*)(ime + nof_methods),                      "wrong offset calculation (2)");
1437 
1438   // Visit all interfaces and initialize itable offset table
1439   SetupItableClosure sic((address)klass, ioe, ime);
1440   visit_all_interfaces(klass->transitive_interfaces(), &sic);
1441 
1442 #ifdef ASSERT
1443   ime  = sic.method_entry();
1444   oop* v = (oop*) klass->end_of_itable();
1445   assert( (oop*)(ime) == v, "wrong offset calculation (2)");
1446 #endif
1447 }
1448 
1449 
1450 // inverse to itable_index
1451 Method* klassItable::method_for_itable_index(Klass* intf, int itable_index) {
1452   assert(InstanceKlass::cast(intf)->is_interface(), "sanity check");
1453   assert(intf->verify_itable_index(itable_index), "");
1454   Array<Method*>* methods = InstanceKlass::cast(intf)->methods();
1455 
1456   if (itable_index < 0 || itable_index >= method_count_for_interface(intf))
1457     return NULL;                // help caller defend against bad indices
1458 
1459   int index = itable_index;
1460   Method* m = methods->at(index);
1461   int index2 = -1;
1462   while (!m->has_itable_index() ||
1463          (index2 = m->itable_index()) != itable_index) {
1464     assert(index2 < itable_index, "monotonic");
1465     if (++index == methods->length())
1466       return NULL;
1467     m = methods->at(index);
1468   }
1469   assert(m->itable_index() == itable_index, "correct inverse");
1470 
1471   return m;
1472 }
1473 
1474 void klassVtable::verify(outputStream* st, bool forced) {
1475   // make sure table is initialized
1476   if (!Universe::is_fully_initialized()) return;
1477 #ifndef PRODUCT
1478   // avoid redundant verifies
1479   if (!forced && _verify_count == Universe::verify_count()) return;
1480   _verify_count = Universe::verify_count();
1481 #endif
1482   oop* end_of_obj = (oop*)_klass + _klass->size();
1483   oop* end_of_vtable = (oop *)&table()[_length];
1484   if (end_of_vtable > end_of_obj) {
1485     fatal("klass %s: klass object too short (vtable extends beyond end)",
1486           _klass->internal_name());
1487   }
1488 
1489   for (int i = 0; i < _length; i++) table()[i].verify(this, st);
1490   // verify consistency with superKlass vtable
1491   Klass* super = _klass->super();
1492   if (super != NULL) {
1493     InstanceKlass* sk = InstanceKlass::cast(super);
1494     klassVtable vt = sk->vtable();
1495     for (int i = 0; i < vt.length(); i++) {
1496       verify_against(st, &vt, i);
1497     }
1498   }
1499 }
1500 
1501 void klassVtable::verify_against(outputStream* st, klassVtable* vt, int index) {
1502   vtableEntry* vte = &vt->table()[index];
1503   if (vte->method()->name()      != table()[index].method()->name() ||
1504       vte->method()->signature() != table()[index].method()->signature()) {
1505     fatal("mismatched name/signature of vtable entries");
1506   }
1507 }
1508 
1509 #ifndef PRODUCT
1510 void klassVtable::print() {
1511   ResourceMark rm;
1512   tty->print("klassVtable for klass %s (length %d):\n", _klass->internal_name(), length());
1513   for (int i = 0; i < length(); i++) {
1514     table()[i].print();
1515     tty->cr();
1516   }
1517 }
1518 #endif
1519 
1520 void vtableEntry::verify(klassVtable* vt, outputStream* st) {
1521   NOT_PRODUCT(FlagSetting fs(IgnoreLockingAssertions, true));
1522   Klass* vtklass = vt->klass();
1523   if (vtklass->is_instance_klass() &&
1524      (InstanceKlass::cast(vtklass)->major_version() >= klassVtable::VTABLE_TRANSITIVE_OVERRIDE_VERSION)) {
1525     assert(method() != NULL, "must have set method");
1526   }
1527   if (method() != NULL) {
1528     method()->verify();
1529     // we sub_type, because it could be a miranda method
1530     if (!vtklass->is_subtype_of(method()->method_holder())) {
1531 #ifndef PRODUCT
1532       print();
1533 #endif
1534       fatal("vtableEntry " PTR_FORMAT ": method is from subclass", p2i(this));
1535     }
1536  }
1537 }
1538 
1539 #ifndef PRODUCT
1540 
1541 void vtableEntry::print() {
1542   ResourceMark rm;
1543   tty->print("vtableEntry %s: ", method()->name()->as_C_string());
1544   if (Verbose) {
1545     tty->print("m " PTR_FORMAT " ", p2i(method()));
1546   }
1547 }
1548 
1549 class VtableStats : AllStatic {
1550  public:
1551   static int no_klasses;                // # classes with vtables
1552   static int no_array_klasses;          // # array classes
1553   static int no_instance_klasses;       // # instanceKlasses
1554   static int sum_of_vtable_len;         // total # of vtable entries
1555   static int sum_of_array_vtable_len;   // total # of vtable entries in array klasses only
1556   static int fixed;                     // total fixed overhead in bytes
1557   static int filler;                    // overhead caused by filler bytes
1558   static int entries;                   // total bytes consumed by vtable entries
1559   static int array_entries;             // total bytes consumed by array vtable entries
1560 
1561   static void do_class(Klass* k) {
1562     Klass* kl = k;
1563     klassVtable vt = kl->vtable();
1564     no_klasses++;
1565     if (kl->is_instance_klass()) {
1566       no_instance_klasses++;
1567       kl->array_klasses_do(do_class);
1568     }
1569     if (kl->is_array_klass()) {
1570       no_array_klasses++;
1571       sum_of_array_vtable_len += vt.length();
1572     }
1573     sum_of_vtable_len += vt.length();
1574   }
1575 
1576   static void compute() {
1577     ClassLoaderDataGraph::classes_do(do_class);
1578     fixed  = no_klasses * oopSize;      // vtable length
1579     // filler size is a conservative approximation
1580     filler = oopSize * (no_klasses - no_instance_klasses) * (sizeof(InstanceKlass) - sizeof(ArrayKlass) - 1);
1581     entries = sizeof(vtableEntry) * sum_of_vtable_len;
1582     array_entries = sizeof(vtableEntry) * sum_of_array_vtable_len;
1583   }
1584 };
1585 
1586 int VtableStats::no_klasses = 0;
1587 int VtableStats::no_array_klasses = 0;
1588 int VtableStats::no_instance_klasses = 0;
1589 int VtableStats::sum_of_vtable_len = 0;
1590 int VtableStats::sum_of_array_vtable_len = 0;
1591 int VtableStats::fixed = 0;
1592 int VtableStats::filler = 0;
1593 int VtableStats::entries = 0;
1594 int VtableStats::array_entries = 0;
1595 
1596 void klassVtable::print_statistics() {
1597   ResourceMark rm;
1598   HandleMark hm;
1599   VtableStats::compute();
1600   tty->print_cr("vtable statistics:");
1601   tty->print_cr("%6d classes (%d instance, %d array)", VtableStats::no_klasses, VtableStats::no_instance_klasses, VtableStats::no_array_klasses);
1602   int total = VtableStats::fixed + VtableStats::filler + VtableStats::entries;
1603   tty->print_cr("%6d bytes fixed overhead (refs + vtable object header)", VtableStats::fixed);
1604   tty->print_cr("%6d bytes filler overhead", VtableStats::filler);
1605   tty->print_cr("%6d bytes for vtable entries (%d for arrays)", VtableStats::entries, VtableStats::array_entries);
1606   tty->print_cr("%6d bytes total", total);
1607 }
1608 
1609 int  klassItable::_total_classes;   // Total no. of classes with itables
1610 long klassItable::_total_size;      // Total no. of bytes used for itables
1611 
1612 void klassItable::print_statistics() {
1613  tty->print_cr("itable statistics:");
1614  tty->print_cr("%6d classes with itables", _total_classes);
1615  tty->print_cr("%6lu K uses for itables (average by class: %ld bytes)", _total_size / K, _total_size / _total_classes);
1616 }
1617 
1618 #endif // PRODUCT