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