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