1 /*
   2  * Copyright (c) 1998, 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 "interpreter/bytecodeStream.hpp"
  27 #include "interpreter/bytecodes.hpp"
  28 #include "interpreter/interpreter.hpp"
  29 #include "interpreter/rewriter.hpp"
  30 #include "logging/log.hpp"
  31 #include "memory/metadataFactory.hpp"
  32 #include "memory/metaspaceClosure.hpp"
  33 #include "memory/resourceArea.hpp"
  34 #include "memory/universe.inline.hpp"
  35 #include "oops/cpCache.hpp"
  36 #include "oops/objArrayOop.inline.hpp"
  37 #include "oops/oop.inline.hpp"
  38 #include "prims/methodHandles.hpp"
  39 #include "runtime/atomic.hpp"
  40 #include "runtime/handles.inline.hpp"
  41 #include "runtime/orderAccess.inline.hpp"
  42 #include "utilities/macros.hpp"
  43 
  44 // Implementation of ConstantPoolCacheEntry
  45 
  46 void ConstantPoolCacheEntry::initialize_entry(int index) {
  47   assert(0 < index && index < 0x10000, "sanity check");
  48   _indices = index;
  49   _f1 = NULL;
  50   _f2 = _flags = 0;
  51   assert(constant_pool_index() == index, "");
  52 }
  53 
  54 void ConstantPoolCacheEntry::verify_just_initialized(bool f2_used) {
  55   assert((_indices & (~cp_index_mask)) == 0, "sanity");
  56   assert(_f1 == NULL, "sanity");
  57   assert(_flags == 0, "sanity");
  58   if (!f2_used) {
  59     assert(_f2 == 0, "sanity");
  60   }
  61 }
  62 
  63 void ConstantPoolCacheEntry::reinitialize(bool f2_used) {
  64   _indices &= cp_index_mask;
  65   _f1 = NULL;
  66   _flags = 0;
  67   if (!f2_used) {
  68     _f2 = 0;
  69   }
  70 }
  71 
  72 int ConstantPoolCacheEntry::make_flags(TosState state,
  73                                        int option_bits,
  74                                        int field_index_or_method_params) {
  75   assert(state < number_of_states, "Invalid state in make_flags");
  76   int f = ((int)state << tos_state_shift) | option_bits | field_index_or_method_params;
  77   // Preserve existing flag bit values
  78   // The low bits are a field offset, or else the method parameter size.
  79 #ifdef ASSERT
  80   TosState old_state = flag_state();
  81   assert(old_state == (TosState)0 || old_state == state,
  82          "inconsistent cpCache flags state");
  83 #endif
  84   return (_flags | f) ;
  85 }
  86 
  87 void ConstantPoolCacheEntry::set_bytecode_1(Bytecodes::Code code) {
  88 #ifdef ASSERT
  89   // Read once.
  90   volatile Bytecodes::Code c = bytecode_1();
  91   assert(c == 0 || c == code || code == 0, "update must be consistent");
  92 #endif
  93   // Need to flush pending stores here before bytecode is written.
  94   OrderAccess::release_store(&_indices, _indices | ((u_char)code << bytecode_1_shift));
  95 }
  96 
  97 void ConstantPoolCacheEntry::set_bytecode_2(Bytecodes::Code code) {
  98 #ifdef ASSERT
  99   // Read once.
 100   volatile Bytecodes::Code c = bytecode_2();
 101   assert(c == 0 || c == code || code == 0, "update must be consistent");
 102 #endif
 103   // Need to flush pending stores here before bytecode is written.
 104   OrderAccess::release_store(&_indices, _indices | ((u_char)code << bytecode_2_shift));
 105 }
 106 
 107 // Sets f1, ordering with previous writes.
 108 void ConstantPoolCacheEntry::release_set_f1(Metadata* f1) {
 109   assert(f1 != NULL, "");
 110   OrderAccess::release_store(&_f1, f1);
 111 }
 112 
 113 // Note that concurrent update of both bytecodes can leave one of them
 114 // reset to zero.  This is harmless; the interpreter will simply re-resolve
 115 // the damaged entry.  More seriously, the memory synchronization is needed
 116 // to flush other fields (f1, f2) completely to memory before the bytecodes
 117 // are updated, lest other processors see a non-zero bytecode but zero f1/f2.
 118 void ConstantPoolCacheEntry::set_field(Bytecodes::Code get_code,
 119                                        Bytecodes::Code put_code,
 120                                        Klass* field_holder,
 121                                        int field_index,
 122                                        int field_offset,
 123                                        TosState field_type,
 124                                        bool is_final,
 125                                        bool is_volatile,
 126                                        Klass* root_klass) {
 127   set_f1(field_holder);
 128   set_f2(field_offset);
 129   assert((field_index & field_index_mask) == field_index,
 130          "field index does not fit in low flag bits");
 131   set_field_flags(field_type,
 132                   ((is_volatile ? 1 : 0) << is_volatile_shift) |
 133                   ((is_final    ? 1 : 0) << is_final_shift),
 134                   field_index);
 135   set_bytecode_1(get_code);
 136   set_bytecode_2(put_code);
 137   NOT_PRODUCT(verify(tty));
 138 }
 139 
 140 void ConstantPoolCacheEntry::set_parameter_size(int value) {
 141   // This routine is called only in corner cases where the CPCE is not yet initialized.
 142   // See AbstractInterpreter::deopt_continue_after_entry.
 143   assert(_flags == 0 || parameter_size() == 0 || parameter_size() == value,
 144          "size must not change: parameter_size=%d, value=%d", parameter_size(), value);
 145   // Setting the parameter size by itself is only safe if the
 146   // current value of _flags is 0, otherwise another thread may have
 147   // updated it and we don't want to overwrite that value.  Don't
 148   // bother trying to update it once it's nonzero but always make
 149   // sure that the final parameter size agrees with what was passed.
 150   if (_flags == 0) {
 151     intx newflags = (value & parameter_size_mask);
 152     Atomic::cmpxchg(newflags, &_flags, (intx)0);
 153   }
 154   guarantee(parameter_size() == value,
 155             "size must not change: parameter_size=%d, value=%d", parameter_size(), value);
 156 }
 157 
 158 void ConstantPoolCacheEntry::set_direct_or_vtable_call(Bytecodes::Code invoke_code,
 159                                                        const methodHandle& method,
 160                                                        int vtable_index,
 161                                                        bool sender_is_interface) {
 162   bool is_vtable_call = (vtable_index >= 0);  // FIXME: split this method on this boolean
 163   assert(method->interpreter_entry() != NULL, "should have been set at this point");
 164   assert(!method->is_obsolete(),  "attempt to write obsolete method to cpCache");
 165 
 166   int byte_no = -1;
 167   bool change_to_virtual = false;
 168 
 169   switch (invoke_code) {
 170     case Bytecodes::_invokeinterface:
 171       // We get here from InterpreterRuntime::resolve_invoke when an invokeinterface
 172       // instruction somehow links to a non-interface method (in Object).
 173       // In that case, the method has no itable index and must be invoked as a virtual.
 174       // Set a flag to keep track of this corner case.
 175       change_to_virtual = true;
 176 
 177       // ...and fall through as if we were handling invokevirtual:
 178     case Bytecodes::_invokevirtual:
 179       {
 180         if (!is_vtable_call) {
 181           assert(method->can_be_statically_bound(), "");
 182           // set_f2_as_vfinal_method checks if is_vfinal flag is true.
 183           set_method_flags(as_TosState(method->result_type()),
 184                            (                             1      << is_vfinal_shift) |
 185                            ((method->is_final_method() ? 1 : 0) << is_final_shift)  |
 186                            ((change_to_virtual         ? 1 : 0) << is_forced_virtual_shift),
 187                            method()->size_of_parameters());
 188           set_f2_as_vfinal_method(method());
 189         } else {
 190           assert(!method->can_be_statically_bound(), "");
 191           assert(vtable_index >= 0, "valid index");
 192           assert(!method->is_final_method(), "sanity");
 193           set_method_flags(as_TosState(method->result_type()),
 194                            ((change_to_virtual ? 1 : 0) << is_forced_virtual_shift),
 195                            method()->size_of_parameters());
 196           set_f2(vtable_index);
 197         }
 198         byte_no = 2;
 199         break;
 200       }
 201 
 202     case Bytecodes::_invokespecial:
 203     case Bytecodes::_invokestatic:
 204       assert(!is_vtable_call, "");
 205       // Note:  Read and preserve the value of the is_vfinal flag on any
 206       // invokevirtual bytecode shared with this constant pool cache entry.
 207       // It is cheap and safe to consult is_vfinal() at all times.
 208       // Once is_vfinal is set, it must stay that way, lest we get a dangling oop.
 209       set_method_flags(as_TosState(method->result_type()),
 210                        ((is_vfinal()               ? 1 : 0) << is_vfinal_shift) |
 211                        ((method->is_final_method() ? 1 : 0) << is_final_shift),
 212                        method()->size_of_parameters());
 213       set_f1(method());
 214       byte_no = 1;
 215       break;
 216     default:
 217       ShouldNotReachHere();
 218       break;
 219   }
 220 
 221   // Note:  byte_no also appears in TemplateTable::resolve.
 222   if (byte_no == 1) {
 223     assert(invoke_code != Bytecodes::_invokevirtual &&
 224            invoke_code != Bytecodes::_invokeinterface, "");
 225     // Don't mark invokespecial to method as resolved if sender is an interface.  The receiver
 226     // has to be checked that it is a subclass of the current class every time this bytecode
 227     // is executed.
 228     if (invoke_code != Bytecodes::_invokespecial || !sender_is_interface ||
 229         method->name() == vmSymbols::object_initializer_name()) {
 230     set_bytecode_1(invoke_code);
 231     }
 232   } else if (byte_no == 2)  {
 233     if (change_to_virtual) {
 234       assert(invoke_code == Bytecodes::_invokeinterface, "");
 235       // NOTE: THIS IS A HACK - BE VERY CAREFUL!!!
 236       //
 237       // Workaround for the case where we encounter an invokeinterface, but we
 238       // should really have an _invokevirtual since the resolved method is a
 239       // virtual method in java.lang.Object. This is a corner case in the spec
 240       // but is presumably legal. javac does not generate this code.
 241       //
 242       // We set bytecode_1() to _invokeinterface, because that is the
 243       // bytecode # used by the interpreter to see if it is resolved.
 244       // We set bytecode_2() to _invokevirtual.
 245       // See also interpreterRuntime.cpp. (8/25/2000)
 246       // Only set resolved for the invokeinterface case if method is public.
 247       // Otherwise, the method needs to be reresolved with caller for each
 248       // interface call.
 249       if (method->is_public()) set_bytecode_1(invoke_code);
 250     } else {
 251       assert(invoke_code == Bytecodes::_invokevirtual, "");
 252     }
 253     // set up for invokevirtual, even if linking for invokeinterface also:
 254     set_bytecode_2(Bytecodes::_invokevirtual);
 255   } else {
 256     ShouldNotReachHere();
 257   }
 258   NOT_PRODUCT(verify(tty));
 259 }
 260 
 261 void ConstantPoolCacheEntry::set_direct_call(Bytecodes::Code invoke_code, const methodHandle& method,
 262                                              bool sender_is_interface) {
 263   int index = Method::nonvirtual_vtable_index;
 264   // index < 0; FIXME: inline and customize set_direct_or_vtable_call
 265   set_direct_or_vtable_call(invoke_code, method, index, sender_is_interface);
 266 }
 267 
 268 void ConstantPoolCacheEntry::set_vtable_call(Bytecodes::Code invoke_code, const methodHandle& method, int index) {
 269   // either the method is a miranda or its holder should accept the given index
 270   assert(method->method_holder()->is_interface() || method->method_holder()->verify_vtable_index(index), "");
 271   // index >= 0; FIXME: inline and customize set_direct_or_vtable_call
 272   set_direct_or_vtable_call(invoke_code, method, index, false);
 273 }
 274 
 275 void ConstantPoolCacheEntry::set_itable_call(Bytecodes::Code invoke_code, const methodHandle& method, int index) {
 276   assert(method->method_holder()->verify_itable_index(index), "");
 277   assert(invoke_code == Bytecodes::_invokeinterface, "");
 278   InstanceKlass* interf = method->method_holder();
 279   assert(interf->is_interface(), "must be an interface");
 280   assert(!method->is_final_method(), "interfaces do not have final methods; cannot link to one here");
 281   set_f1(interf);
 282   set_f2(index);
 283   set_method_flags(as_TosState(method->result_type()),
 284                    0,  // no option bits
 285                    method()->size_of_parameters());
 286   set_bytecode_1(Bytecodes::_invokeinterface);
 287 }
 288 
 289 
 290 void ConstantPoolCacheEntry::set_method_handle(const constantPoolHandle& cpool, const CallInfo &call_info) {
 291   set_method_handle_common(cpool, Bytecodes::_invokehandle, call_info);
 292 }
 293 
 294 void ConstantPoolCacheEntry::set_dynamic_call(const constantPoolHandle& cpool, const CallInfo &call_info) {
 295   set_method_handle_common(cpool, Bytecodes::_invokedynamic, call_info);
 296 }
 297 
 298 void ConstantPoolCacheEntry::set_method_handle_common(const constantPoolHandle& cpool,
 299                                                       Bytecodes::Code invoke_code,
 300                                                       const CallInfo &call_info) {
 301   // NOTE: This CPCE can be the subject of data races.
 302   // There are three words to update: flags, refs[f2], f1 (in that order).
 303   // Writers must store all other values before f1.
 304   // Readers must test f1 first for non-null before reading other fields.
 305   // Competing writers must acquire exclusive access via a lock.
 306   // A losing writer waits on the lock until the winner writes f1 and leaves
 307   // the lock, so that when the losing writer returns, he can use the linked
 308   // cache entry.
 309 
 310   objArrayHandle resolved_references(Thread::current(), cpool->resolved_references());
 311   // Use the resolved_references() lock for this cpCache entry.
 312   // resolved_references are created for all classes with Invokedynamic, MethodHandle
 313   // or MethodType constant pool cache entries.
 314   assert(resolved_references() != NULL,
 315          "a resolved_references array should have been created for this class");
 316   ObjectLocker ol(resolved_references, Thread::current());
 317   if (!is_f1_null()) {
 318     return;
 319   }
 320 
 321   const methodHandle adapter = call_info.resolved_method();
 322   const Handle appendix      = call_info.resolved_appendix();
 323   const Handle method_type   = call_info.resolved_method_type();
 324   const bool has_appendix    = appendix.not_null();
 325   const bool has_method_type = method_type.not_null();
 326 
 327   // Write the flags.
 328   set_method_flags(as_TosState(adapter->result_type()),
 329                    ((has_appendix    ? 1 : 0) << has_appendix_shift   ) |
 330                    ((has_method_type ? 1 : 0) << has_method_type_shift) |
 331                    (                   1      << is_final_shift       ),
 332                    adapter->size_of_parameters());
 333 
 334   if (TraceInvokeDynamic) {
 335     ttyLocker ttyl;
 336     tty->print_cr("set_method_handle bc=%d appendix=" PTR_FORMAT "%s method_type=" PTR_FORMAT "%s method=" PTR_FORMAT " ",
 337                   invoke_code,
 338                   p2i(appendix()),    (has_appendix    ? "" : " (unused)"),
 339                   p2i(method_type()), (has_method_type ? "" : " (unused)"),
 340                   p2i(adapter()));
 341     adapter->print();
 342     if (has_appendix)  appendix()->print();
 343   }
 344 
 345   // Method handle invokes and invokedynamic sites use both cp cache words.
 346   // refs[f2], if not null, contains a value passed as a trailing argument to the adapter.
 347   // In the general case, this could be the call site's MethodType,
 348   // for use with java.lang.Invokers.checkExactType, or else a CallSite object.
 349   // f1 contains the adapter method which manages the actual call.
 350   // In the general case, this is a compiled LambdaForm.
 351   // (The Java code is free to optimize these calls by binding other
 352   // sorts of methods and appendices to call sites.)
 353   // JVM-level linking is via f1, as if for invokespecial, and signatures are erased.
 354   // The appendix argument (if any) is added to the signature, and is counted in the parameter_size bits.
 355   // Even with the appendix, the method will never take more than 255 parameter slots.
 356   //
 357   // This means that given a call site like (List)mh.invoke("foo"),
 358   // the f1 method has signature '(Ljl/Object;Ljl/invoke/MethodType;)Ljl/Object;',
 359   // not '(Ljava/lang/String;)Ljava/util/List;'.
 360   // The fact that String and List are involved is encoded in the MethodType in refs[f2].
 361   // This allows us to create fewer Methods, while keeping type safety.
 362   //
 363 
 364   // Store appendix, if any.
 365   if (has_appendix) {
 366     const int appendix_index = f2_as_index() + _indy_resolved_references_appendix_offset;
 367     assert(appendix_index >= 0 && appendix_index < resolved_references->length(), "oob");
 368     assert(resolved_references->obj_at(appendix_index) == NULL, "init just once");
 369     resolved_references->obj_at_put(appendix_index, appendix());
 370   }
 371 
 372   // Store MethodType, if any.
 373   if (has_method_type) {
 374     const int method_type_index = f2_as_index() + _indy_resolved_references_method_type_offset;
 375     assert(method_type_index >= 0 && method_type_index < resolved_references->length(), "oob");
 376     assert(resolved_references->obj_at(method_type_index) == NULL, "init just once");
 377     resolved_references->obj_at_put(method_type_index, method_type());
 378   }
 379 
 380   release_set_f1(adapter());  // This must be the last one to set (see NOTE above)!
 381 
 382   // The interpreter assembly code does not check byte_2,
 383   // but it is used by is_resolved, method_if_resolved, etc.
 384   set_bytecode_1(invoke_code);
 385   NOT_PRODUCT(verify(tty));
 386   if (TraceInvokeDynamic) {
 387     ttyLocker ttyl;
 388     this->print(tty, 0);
 389   }
 390 }
 391 
 392 Method* ConstantPoolCacheEntry::method_if_resolved(const constantPoolHandle& cpool) {
 393   // Decode the action of set_method and set_interface_call
 394   Bytecodes::Code invoke_code = bytecode_1();
 395   if (invoke_code != (Bytecodes::Code)0) {
 396     Metadata* f1 = f1_ord();
 397     if (f1 != NULL) {
 398       switch (invoke_code) {
 399       case Bytecodes::_invokeinterface:
 400         assert(f1->is_klass(), "");
 401         return klassItable::method_for_itable_index((Klass*)f1, f2_as_index());
 402       case Bytecodes::_invokestatic:
 403       case Bytecodes::_invokespecial:
 404         assert(!has_appendix(), "");
 405       case Bytecodes::_invokehandle:
 406       case Bytecodes::_invokedynamic:
 407         assert(f1->is_method(), "");
 408         return (Method*)f1;
 409       default:
 410         break;
 411       }
 412     }
 413   }
 414   invoke_code = bytecode_2();
 415   if (invoke_code != (Bytecodes::Code)0) {
 416     switch (invoke_code) {
 417     case Bytecodes::_invokevirtual:
 418       if (is_vfinal()) {
 419         // invokevirtual
 420         Method* m = f2_as_vfinal_method();
 421         assert(m->is_method(), "");
 422         return m;
 423       } else {
 424         int holder_index = cpool->uncached_klass_ref_index_at(constant_pool_index());
 425         if (cpool->tag_at(holder_index).is_klass()) {
 426           Klass* klass = cpool->resolved_klass_at(holder_index);
 427           return klass->method_at_vtable(f2_as_index());
 428         }
 429       }
 430       break;
 431     default:
 432       break;
 433     }
 434   }
 435   return NULL;
 436 }
 437 
 438 
 439 oop ConstantPoolCacheEntry::appendix_if_resolved(const constantPoolHandle& cpool) {
 440   if (!has_appendix())
 441     return NULL;
 442   const int ref_index = f2_as_index() + _indy_resolved_references_appendix_offset;
 443   objArrayOop resolved_references = cpool->resolved_references();
 444   return resolved_references->obj_at(ref_index);
 445 }
 446 
 447 
 448 oop ConstantPoolCacheEntry::method_type_if_resolved(const constantPoolHandle& cpool) {
 449   if (!has_method_type())
 450     return NULL;
 451   const int ref_index = f2_as_index() + _indy_resolved_references_method_type_offset;
 452   objArrayOop resolved_references = cpool->resolved_references();
 453   return resolved_references->obj_at(ref_index);
 454 }
 455 
 456 
 457 #if INCLUDE_JVMTI
 458 // RedefineClasses() API support:
 459 // If this ConstantPoolCacheEntry refers to old_method then update it
 460 // to refer to new_method.
 461 bool ConstantPoolCacheEntry::adjust_method_entry(Method* old_method,
 462        Method* new_method, bool * trace_name_printed) {
 463 
 464   if (is_vfinal()) {
 465     // virtual and final so _f2 contains method ptr instead of vtable index
 466     if (f2_as_vfinal_method() == old_method) {
 467       // match old_method so need an update
 468       // NOTE: can't use set_f2_as_vfinal_method as it asserts on different values
 469       _f2 = (intptr_t)new_method;
 470       if (log_is_enabled(Info, redefine, class, update)) {
 471         ResourceMark rm;
 472         if (!(*trace_name_printed)) {
 473           log_info(redefine, class, update)("adjust: name=%s", old_method->method_holder()->external_name());
 474           *trace_name_printed = true;
 475         }
 476         log_debug(redefine, class, update, constantpool)
 477           ("cpc vf-entry update: %s(%s)", new_method->name()->as_C_string(), new_method->signature()->as_C_string());
 478       }
 479       return true;
 480     }
 481 
 482     // f1() is not used with virtual entries so bail out
 483     return false;
 484   }
 485 
 486   if (_f1 == NULL) {
 487     // NULL f1() means this is a virtual entry so bail out
 488     // We are assuming that the vtable index does not need change.
 489     return false;
 490   }
 491 
 492   if (_f1 == old_method) {
 493     _f1 = new_method;
 494     if (log_is_enabled(Info, redefine, class, update)) {
 495       ResourceMark rm;
 496       if (!(*trace_name_printed)) {
 497         log_info(redefine, class, update)("adjust: name=%s", old_method->method_holder()->external_name());
 498         *trace_name_printed = true;
 499       }
 500       log_debug(redefine, class, update, constantpool)
 501         ("cpc entry update: %s(%s)", new_method->name()->as_C_string(), new_method->signature()->as_C_string());
 502     }
 503     return true;
 504   }
 505 
 506   return false;
 507 }
 508 
 509 // a constant pool cache entry should never contain old or obsolete methods
 510 bool ConstantPoolCacheEntry::check_no_old_or_obsolete_entries() {
 511   if (is_vfinal()) {
 512     // virtual and final so _f2 contains method ptr instead of vtable index
 513     Metadata* f2 = (Metadata*)_f2;
 514     // Return false if _f2 refers to an old or an obsolete method.
 515     // _f2 == NULL || !_f2->is_method() are just as unexpected here.
 516     return (f2 != NULL NOT_PRODUCT(&& f2->is_valid()) && f2->is_method() &&
 517             !((Method*)f2)->is_old() && !((Method*)f2)->is_obsolete());
 518   } else if (_f1 == NULL ||
 519              (NOT_PRODUCT(_f1->is_valid() &&) !_f1->is_method())) {
 520     // _f1 == NULL || !_f1->is_method() are OK here
 521     return true;
 522   }
 523   // return false if _f1 refers to a non-deleted old or obsolete method
 524   return (NOT_PRODUCT(_f1->is_valid() &&) _f1->is_method() &&
 525           (f1_as_method()->is_deleted() ||
 526           (!f1_as_method()->is_old() && !f1_as_method()->is_obsolete())));
 527 }
 528 
 529 Method* ConstantPoolCacheEntry::get_interesting_method_entry(Klass* k) {
 530   if (!is_method_entry()) {
 531     // not a method entry so not interesting by default
 532     return NULL;
 533   }
 534   Method* m = NULL;
 535   if (is_vfinal()) {
 536     // virtual and final so _f2 contains method ptr instead of vtable index
 537     m = f2_as_vfinal_method();
 538   } else if (is_f1_null()) {
 539     // NULL _f1 means this is a virtual entry so also not interesting
 540     return NULL;
 541   } else {
 542     if (!(_f1->is_method())) {
 543       // _f1 can also contain a Klass* for an interface
 544       return NULL;
 545     }
 546     m = f1_as_method();
 547   }
 548   assert(m != NULL && m->is_method(), "sanity check");
 549   if (m == NULL || !m->is_method() || (k != NULL && m->method_holder() != k)) {
 550     // robustness for above sanity checks or method is not in
 551     // the interesting class
 552     return NULL;
 553   }
 554   // the method is in the interesting class so the entry is interesting
 555   return m;
 556 }
 557 #endif // INCLUDE_JVMTI
 558 
 559 void ConstantPoolCacheEntry::print(outputStream* st, int index) const {
 560   // print separator
 561   if (index == 0) st->print_cr("                 -------------");
 562   // print entry
 563   st->print("%3d  (" PTR_FORMAT ")  ", index, (intptr_t)this);
 564   st->print_cr("[%02x|%02x|%5d]", bytecode_2(), bytecode_1(),
 565                constant_pool_index());
 566   st->print_cr("                 [   " PTR_FORMAT "]", (intptr_t)_f1);
 567   st->print_cr("                 [   " PTR_FORMAT "]", (intptr_t)_f2);
 568   st->print_cr("                 [   " PTR_FORMAT "]", (intptr_t)_flags);
 569   st->print_cr("                 -------------");
 570 }
 571 
 572 void ConstantPoolCacheEntry::verify(outputStream* st) const {
 573   // not implemented yet
 574 }
 575 
 576 // Implementation of ConstantPoolCache
 577 
 578 ConstantPoolCache* ConstantPoolCache::allocate(ClassLoaderData* loader_data,
 579                                      const intStack& index_map,
 580                                      const intStack& invokedynamic_index_map,
 581                                      const intStack& invokedynamic_map, TRAPS) {
 582 
 583   const int length = index_map.length() + invokedynamic_index_map.length();
 584   int size = ConstantPoolCache::size(length);
 585 
 586   return new (loader_data, size, MetaspaceObj::ConstantPoolCacheType, THREAD)
 587     ConstantPoolCache(length, index_map, invokedynamic_index_map, invokedynamic_map);
 588 }
 589 
 590 void ConstantPoolCache::initialize(const intArray& inverse_index_map,
 591                                    const intArray& invokedynamic_inverse_index_map,
 592                                    const intArray& invokedynamic_references_map) {
 593   for (int i = 0; i < inverse_index_map.length(); i++) {
 594     ConstantPoolCacheEntry* e = entry_at(i);
 595     int original_index = inverse_index_map.at(i);
 596     e->initialize_entry(original_index);
 597     assert(entry_at(i) == e, "sanity");
 598   }
 599 
 600   // Append invokedynamic entries at the end
 601   int invokedynamic_offset = inverse_index_map.length();
 602   for (int i = 0; i < invokedynamic_inverse_index_map.length(); i++) {
 603     int offset = i + invokedynamic_offset;
 604     ConstantPoolCacheEntry* e = entry_at(offset);
 605     int original_index = invokedynamic_inverse_index_map.at(i);
 606     e->initialize_entry(original_index);
 607     assert(entry_at(offset) == e, "sanity");
 608   }
 609 
 610   for (int ref = 0; ref < invokedynamic_references_map.length(); ref++) {
 611     const int cpci = invokedynamic_references_map.at(ref);
 612     if (cpci >= 0) {
 613 #ifdef ASSERT
 614       // invokedynamic and invokehandle have more entries; check if they
 615       // all point to the same constant pool cache entry.
 616       for (int entry = 1; entry < ConstantPoolCacheEntry::_indy_resolved_references_entries; entry++) {
 617         const int cpci_next = invokedynamic_references_map.at(ref + entry);
 618         assert(cpci == cpci_next, "%d == %d", cpci, cpci_next);
 619       }
 620 #endif
 621       entry_at(cpci)->initialize_resolved_reference_index(ref);
 622       ref += ConstantPoolCacheEntry::_indy_resolved_references_entries - 1;  // skip extra entries
 623     }
 624   }
 625 }
 626 
 627 void ConstantPoolCache::verify_just_initialized() {
 628   DEBUG_ONLY(walk_entries_for_initialization(/*check_only = */ true));
 629 }
 630 
 631 void ConstantPoolCache::remove_unshareable_info() {
 632   walk_entries_for_initialization(/*check_only = */ false);
 633 }
 634 
 635 void ConstantPoolCache::walk_entries_for_initialization(bool check_only) {
 636   assert(DumpSharedSpaces, "sanity");
 637   // When dumping the archive, we want to clean up the ConstantPoolCache
 638   // to remove any effect of linking due to the execution of Java code --
 639   // each ConstantPoolCacheEntry will have the same contents as if
 640   // ConstantPoolCache::initialize has just returned:
 641   //
 642   // - We keep the ConstantPoolCache::constant_pool_index() bits for all entries.
 643   // - We keep the "f2" field for entries used by invokedynamic and invokehandle
 644   // - All other bits in the entries are cleared to zero.
 645   ResourceMark rm;
 646 
 647   InstanceKlass* ik = constant_pool()->pool_holder();
 648   bool* f2_used = NEW_RESOURCE_ARRAY(bool, length());
 649   memset(f2_used, 0, sizeof(bool) * length());
 650 
 651   // Find all the slots that we need to preserve f2
 652   for (int i = 0; i < ik->methods()->length(); i++) {
 653     Method* m = ik->methods()->at(i);
 654     RawBytecodeStream bcs(m);
 655     while (!bcs.is_last_bytecode()) {
 656       Bytecodes::Code opcode = bcs.raw_next();
 657       switch (opcode) {
 658       case Bytecodes::_invokedynamic: {
 659           int index = Bytes::get_native_u4(bcs.bcp() + 1);
 660           int cp_cache_index = constant_pool()->invokedynamic_cp_cache_index(index);
 661           f2_used[cp_cache_index] = 1;
 662         }
 663         break;
 664       case Bytecodes::_invokehandle: {
 665           int cp_cache_index = Bytes::get_native_u2(bcs.bcp() + 1);
 666           f2_used[cp_cache_index] = 1;
 667         }
 668         break;
 669       default:
 670         break;
 671       }
 672     }
 673   }
 674 
 675   if (check_only) {
 676     DEBUG_ONLY(
 677       for (int i=0; i<length(); i++) {
 678         entry_at(i)->verify_just_initialized(f2_used[i]);
 679       })
 680   } else {
 681     for (int i=0; i<length(); i++) {
 682       entry_at(i)->reinitialize(f2_used[i]);
 683     }
 684   }
 685 }
 686 
 687 void ConstantPoolCache::deallocate_contents(ClassLoaderData* data) {
 688   assert(!is_shared(), "shared caches are not deallocated");
 689   data->remove_handle(_resolved_references);
 690   set_resolved_references(NULL);
 691   MetadataFactory::free_array<u2>(data, _reference_map);
 692   set_reference_map(NULL);
 693 }
 694 
 695 #if INCLUDE_CDS_JAVA_HEAP
 696 oop ConstantPoolCache::archived_references() {
 697   assert(UseSharedSpaces, "UseSharedSpaces expected.");
 698   return oopDesc::decode_heap_oop(_archived_references);
 699 }
 700 
 701 void ConstantPoolCache::set_archived_references(oop o) {
 702   assert(DumpSharedSpaces, "called only during runtime");
 703   _archived_references = oopDesc::encode_heap_oop(o);
 704 }
 705 #endif
 706 
 707 #if INCLUDE_JVMTI
 708 // RedefineClasses() API support:
 709 // If any entry of this ConstantPoolCache points to any of
 710 // old_methods, replace it with the corresponding new_method.
 711 void ConstantPoolCache::adjust_method_entries(InstanceKlass* holder, bool * trace_name_printed) {
 712   for (int i = 0; i < length(); i++) {
 713     ConstantPoolCacheEntry* entry = entry_at(i);
 714     Method* old_method = entry->get_interesting_method_entry(holder);
 715     if (old_method == NULL || !old_method->is_old()) {
 716       continue; // skip uninteresting entries
 717     }
 718     if (old_method->is_deleted()) {
 719       // clean up entries with deleted methods
 720       entry->initialize_entry(entry->constant_pool_index());
 721       continue;
 722     }
 723     Method* new_method = holder->method_with_idnum(old_method->orig_method_idnum());
 724 
 725     assert(new_method != NULL, "method_with_idnum() should not be NULL");
 726     assert(old_method != new_method, "sanity check");
 727 
 728     entry_at(i)->adjust_method_entry(old_method, new_method, trace_name_printed);
 729   }
 730 }
 731 
 732 // the constant pool cache should never contain old or obsolete methods
 733 bool ConstantPoolCache::check_no_old_or_obsolete_entries() {
 734   for (int i = 1; i < length(); i++) {
 735     if (entry_at(i)->get_interesting_method_entry(NULL) != NULL &&
 736         !entry_at(i)->check_no_old_or_obsolete_entries()) {
 737       return false;
 738     }
 739   }
 740   return true;
 741 }
 742 
 743 void ConstantPoolCache::dump_cache() {
 744   for (int i = 1; i < length(); i++) {
 745     if (entry_at(i)->get_interesting_method_entry(NULL) != NULL) {
 746       entry_at(i)->print(tty, i);
 747     }
 748   }
 749 }
 750 #endif // INCLUDE_JVMTI
 751 
 752 void ConstantPoolCache::metaspace_pointers_do(MetaspaceClosure* it) {
 753   log_trace(cds)("Iter(ConstantPoolCache): %p", this);
 754   it->push(&_constant_pool);
 755   it->push(&_reference_map);
 756 }
 757 
 758 // Printing
 759 
 760 void ConstantPoolCache::print_on(outputStream* st) const {
 761   assert(is_constantPoolCache(), "obj must be constant pool cache");
 762   st->print_cr("%s", internal_name());
 763   // print constant pool cache entries
 764   for (int i = 0; i < length(); i++) entry_at(i)->print(st, i);
 765 }
 766 
 767 void ConstantPoolCache::print_value_on(outputStream* st) const {
 768   assert(is_constantPoolCache(), "obj must be constant pool cache");
 769   st->print("cache [%d]", length());
 770   print_address_on(st);
 771   st->print(" for ");
 772   constant_pool()->print_value_on(st);
 773 }
 774 
 775 
 776 // Verification
 777 
 778 void ConstantPoolCache::verify_on(outputStream* st) {
 779   guarantee(is_constantPoolCache(), "obj must be constant pool cache");
 780   // print constant pool cache entries
 781   for (int i = 0; i < length(); i++) entry_at(i)->verify(st);
 782 }