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 #ifndef SHARE_VM_OOPS_CPCACHEOOP_HPP
26 #define SHARE_VM_OOPS_CPCACHEOOP_HPP
27
28 #include "interpreter/bytecodes.hpp"
29 #include "oops/array.hpp"
30 #include "oops/oopHandle.hpp"
31 #include "utilities/align.hpp"
32 #include "utilities/constantTag.hpp"
33
34 class PSPromotionManager;
35
36 // The ConstantPoolCache is not a cache! It is the resolution table that the
37 // interpreter uses to avoid going into the runtime and a way to access resolved
38 // values.
39
40 // A ConstantPoolCacheEntry describes an individual entry of the constant
41 // pool cache. There's 2 principal kinds of entries: field entries for in-
42 // stance & static field access, and method entries for invokes. Some of
43 // the entry layout is shared and looks as follows:
44 //
45 // bit number |31 0|
46 // bit length |-8--|-8--|---16----|
47 // --------------------------------
48 // _indices [ b2 | b1 | index ] index = constant_pool_index
49 // _f1 [ entry specific ] metadata ptr (method or klass)
50 // _f2 [ entry specific ] vtable or res_ref index, or vfinal method ptr
51 // _flags [tos|0|F=1|0|0|0|f|v|0 |0000|field_index] (for field entries)
52 // bit length [ 4 |1| 1 |1|1|1|1|1|1 |1 |-3-|----16-----]
53 // _flags [tos|0|F=0|M|A|I|f|0|vf|indy_rf|000|00000|psize] (for method entries)
54 // bit length [ 4 |1| 1 |1|1|1|1|1|1 |-4--|--8--|--8--]
55
56 // --------------------------------
57 //
58 // with:
59 // index = original constant pool index
60 // b1 = bytecode 1
61 // b2 = bytecode 2
62 // psize = parameters size (method entries only)
63 // field_index = index into field information in holder InstanceKlass
64 // The index max is 0xffff (max number of fields in constant pool)
65 // and is multiplied by (InstanceKlass::next_offset) when accessing.
66 // tos = TosState
67 // F = the entry is for a field (or F=0 for a method)
68 // A = call site has an appendix argument (loaded from resolved references)
69 // I = interface call is forced virtual (must use a vtable index or vfinal)
70 // f = field or method is final
71 // v = field is volatile
72 // vf = virtual but final (method entries only: is_vfinal())
73 // indy_rf = call site specifier method resolution failed
74 //
75 // The flags after TosState have the following interpretation:
76 // bit 27: 0 for fields, 1 for methods
77 // f flag true if field is marked final
78 // v flag true if field is volatile (only for fields)
79 // f2 flag true if f2 contains an oop (e.g., virtual final method)
80 // fv flag true if invokeinterface used for method in class Object
81 //
82 // The flags 31, 30, 29, 28 together build a 4 bit number 0 to 16 with the
83 // following mapping to the TosState states:
84 //
85 // btos: 0
86 // ztos: 1
87 // ctos: 2
88 // stos: 3
89 // itos: 4
90 // ltos: 5
91 // ftos: 6
92 // dtos: 7
93 // atos: 8
94 // vtos: 9
95 //
96 // Entry specific: field entries:
97 // _indices = get (b1 section) and put (b2 section) bytecodes, original constant pool index
98 // _f1 = field holder (as a java.lang.Class, not a Klass*)
99 // _f2 = field offset in bytes
100 // _flags = field type information, original FieldInfo index in field holder
101 // (field_index section)
102 //
103 // Entry specific: method entries:
104 // _indices = invoke code for f1 (b1 section), invoke code for f2 (b2 section),
105 // original constant pool index
106 // _f1 = Method* for non-virtual calls, unused by virtual calls.
107 // for interface calls, which are essentially virtual but need a klass,
108 // contains Klass* for the corresponding interface.
109 // for invokedynamic and invokehandle, f1 contains the adapter method which
110 // manages the actual call. The appendix is stored in the ConstantPool
111 // resolved_references array.
112 // (upcoming metadata changes will move the appendix to a separate array)
113 // _f2 = vtable/itable index (or final Method*) for virtual calls only,
114 // unused by non-virtual. The is_vfinal flag indicates this is a
115 // method pointer for a final method, not an index.
116 // _flags = method type info (t section),
117 // virtual final bit (vfinal),
118 // parameter size (psize section)
119 //
120 // Note: invokevirtual & invokespecial bytecodes can share the same constant
121 // pool entry and thus the same constant pool cache entry. All invoke
122 // bytecodes but invokevirtual use only _f1 and the corresponding b1
123 // bytecode, while invokevirtual uses only _f2 and the corresponding
124 // b2 bytecode. The value of _flags is shared for both types of entries.
125 //
126 // The fields are volatile so that they are stored in the order written in the
127 // source code. The _indices field with the bytecode must be written last.
128
129 class CallInfo;
130
131 class ConstantPoolCacheEntry {
132 friend class VMStructs;
133 friend class constantPoolCacheKlass;
134 friend class ConstantPool;
135 friend class InterpreterRuntime;
136
137 private:
138 volatile intx _indices; // constant pool index & rewrite bytecodes
139 Metadata* volatile _f1; // entry specific metadata field
140 volatile intx _f2; // entry specific int/metadata field
141 volatile intx _flags; // flags
142
143
144 void set_bytecode_1(Bytecodes::Code code);
145 void set_bytecode_2(Bytecodes::Code code);
146 void set_f1(Metadata* f1) {
147 Metadata* existing_f1 = _f1; // read once
148 assert(existing_f1 == NULL || existing_f1 == f1, "illegal field change");
149 _f1 = f1;
150 }
151 void release_set_f1(Metadata* f1);
152 void set_f2(intx f2) {
153 intx existing_f2 = _f2; // read once
154 assert(existing_f2 == 0 || existing_f2 == f2, "illegal field change");
155 _f2 = f2;
156 }
157 void set_f2_as_vfinal_method(Method* f2) {
158 assert(is_vfinal(), "flags must be set");
159 set_f2((intx)f2);
160 }
161 int make_flags(TosState state, int option_bits, int field_index_or_method_params);
162 void set_flags(intx flags) { _flags = flags; }
163 void set_field_flags(TosState field_type, int option_bits, int field_index) {
164 assert((field_index & field_index_mask) == field_index, "field_index in range");
165 set_flags(make_flags(field_type, option_bits | (1 << is_field_entry_shift), field_index));
166 }
167 void set_method_flags(TosState return_type, int option_bits, int method_params) {
168 assert((method_params & parameter_size_mask) == method_params, "method_params in range");
169 set_flags(make_flags(return_type, option_bits, method_params));
170 }
171
172 public:
173 // specific bit definitions for the flags field:
174 // (Note: the interpreter must use these definitions to access the CP cache.)
175 enum {
176 // high order bits are the TosState corresponding to field type or method return type
177 tos_state_bits = 4,
178 tos_state_mask = right_n_bits(tos_state_bits),
179 tos_state_shift = BitsPerInt - tos_state_bits, // see verify_tos_state_shift below
180 // misc. option bits; can be any bit position in [16..27]
181 is_field_entry_shift = 26, // (F) is it a field or a method?
182 has_method_type_shift = 25, // (M) does the call site have a MethodType?
183 has_appendix_shift = 24, // (A) does the call site have an appendix argument?
184 is_forced_virtual_shift = 23, // (I) is the interface reference forced to virtual mode?
185 is_final_shift = 22, // (f) is the field or method final?
186 is_volatile_shift = 21, // (v) is the field volatile?
187 is_vfinal_shift = 20, // (vf) did the call resolve to a final method?
188 indy_resolution_failed_shift= 19, // (indy_rf) did call site specifier resolution fail ?
189 // low order bits give field index (for FieldInfo) or method parameter size:
190 field_index_bits = 16,
191 field_index_mask = right_n_bits(field_index_bits),
192 parameter_size_bits = 8, // subset of field_index_mask, range is 0..255
193 parameter_size_mask = right_n_bits(parameter_size_bits),
194 option_bits_mask = ~(((~0u) << tos_state_shift) | (field_index_mask | parameter_size_mask))
195 };
196
197 // specific bit definitions for the indices field:
198 enum {
199 cp_index_bits = 2*BitsPerByte,
200 cp_index_mask = right_n_bits(cp_index_bits),
201 bytecode_1_shift = cp_index_bits,
202 bytecode_1_mask = right_n_bits(BitsPerByte), // == (u1)0xFF
203 bytecode_2_shift = cp_index_bits + BitsPerByte,
204 bytecode_2_mask = right_n_bits(BitsPerByte) // == (u1)0xFF
205 };
206
207
208 // Initialization
209 void initialize_entry(int original_index); // initialize primary entry
210 void initialize_resolved_reference_index(int ref_index) {
211 assert(_f2 == 0, "set once"); // note: ref_index might be zero also
212 _f2 = ref_index;
213 }
214
215 void set_field( // sets entry to resolved field state
216 Bytecodes::Code get_code, // the bytecode used for reading the field
217 Bytecodes::Code put_code, // the bytecode used for writing the field
218 Klass* field_holder, // the object/klass holding the field
219 int orig_field_index, // the original field index in the field holder
220 int field_offset, // the field offset in words in the field holder
221 TosState field_type, // the (machine) field type
222 bool is_final, // the field is final
223 bool is_volatile, // the field is volatile
224 Klass* root_klass // needed by the GC to dirty the klass
225 );
226
227 private:
228 void set_direct_or_vtable_call(
229 Bytecodes::Code invoke_code, // the bytecode used for invoking the method
230 const methodHandle& method, // the method/prototype if any (NULL, otherwise)
231 int vtable_index, // the vtable index if any, else negative
232 bool sender_is_interface
233 );
234
235 public:
236 void set_direct_call( // sets entry to exact concrete method entry
237 Bytecodes::Code invoke_code, // the bytecode used for invoking the method
238 const methodHandle& method, // the method to call
239 bool sender_is_interface
240 );
241
242 void set_vtable_call( // sets entry to vtable index
243 Bytecodes::Code invoke_code, // the bytecode used for invoking the method
244 const methodHandle& method, // resolved method which declares the vtable index
245 int vtable_index // the vtable index
246 );
247
248 void set_itable_call(
249 Bytecodes::Code invoke_code, // the bytecode used; must be invokeinterface
250 Klass* referenced_klass, // the referenced klass in the InterfaceMethodref
251 const methodHandle& method, // the resolved interface method
252 int itable_index // index into itable for the method
253 );
254
255 void set_method_handle(
256 const constantPoolHandle& cpool, // holding constant pool (required for locking)
257 const CallInfo &call_info // Call link information
258 );
259
260 void set_dynamic_call(
261 const constantPoolHandle& cpool, // holding constant pool (required for locking)
262 const CallInfo &call_info // Call link information
263 );
264
265 // Common code for invokedynamic and MH invocations.
266
267 // The "appendix" is an optional call-site-specific parameter which is
268 // pushed by the JVM at the end of the argument list. This argument may
269 // be a MethodType for the MH.invokes and a CallSite for an invokedynamic
270 // instruction. However, its exact type and use depends on the Java upcall,
271 // which simply returns a compiled LambdaForm along with any reference
272 // that LambdaForm needs to complete the call. If the upcall returns a
273 // null appendix, the argument is not passed at all.
274 //
275 // The appendix is *not* represented in the signature of the symbolic
276 // reference for the call site, but (if present) it *is* represented in
277 // the Method* bound to the site. This means that static and dynamic
278 // resolution logic needs to make slightly different assessments about the
279 // number and types of arguments.
280 void set_method_handle_common(
281 const constantPoolHandle& cpool, // holding constant pool (required for locking)
282 Bytecodes::Code invoke_code, // _invokehandle or _invokedynamic
283 const CallInfo &call_info // Call link information
284 );
285
286 // Return TRUE if resolution failed and this thread got to record the failure
287 // status. Return FALSE if another thread succeeded or failed in resolving
288 // the method and recorded the success or failure before this thread had a
289 // chance to record its failure.
290 bool save_and_throw_indy_exc(const constantPoolHandle& cpool, int cpool_index,
291 int index, constantTag tag, TRAPS);
292
293 // invokedynamic and invokehandle call sites have two entries in the
294 // resolved references array:
295 // appendix (at index+0)
296 // MethodType (at index+1)
297 enum {
298 _indy_resolved_references_appendix_offset = 0,
299 _indy_resolved_references_method_type_offset = 1,
300 _indy_resolved_references_entries
301 };
302
303 Method* method_if_resolved(const constantPoolHandle& cpool);
304 oop appendix_if_resolved(const constantPoolHandle& cpool);
305 oop method_type_if_resolved(const constantPoolHandle& cpool);
306
307 void set_parameter_size(int value);
308
309 // Which bytecode number (1 or 2) in the index field is valid for this bytecode?
310 // Returns -1 if neither is valid.
311 static int bytecode_number(Bytecodes::Code code) {
312 switch (code) {
313 case Bytecodes::_getstatic : // fall through
314 case Bytecodes::_getfield : // fall through
315 case Bytecodes::_invokespecial : // fall through
316 case Bytecodes::_invokestatic : // fall through
317 case Bytecodes::_invokehandle : // fall through
318 case Bytecodes::_invokedynamic : // fall through
319 case Bytecodes::_invokeinterface : return 1;
320 case Bytecodes::_putstatic : // fall through
321 case Bytecodes::_putfield : // fall through
322 case Bytecodes::_invokevirtual : return 2;
323 default : break;
324 }
325 return -1;
326 }
327
328 // Has this bytecode been resolved? Only valid for invokes and get/put field/static.
329 bool is_resolved(Bytecodes::Code code) const;
330
331 // Accessors
332 int indices() const { return _indices; }
333 int indices_ord() const;
334 int constant_pool_index() const { return (indices() & cp_index_mask); }
335 Bytecodes::Code bytecode_1() const;
336 Bytecodes::Code bytecode_2() const;
337 Metadata* f1_ord() const;
338 Method* f1_as_method() const;
339 Klass* f1_as_klass() const;
340 // Use the accessor f1() to acquire _f1's value. This is needed for
341 // example in BytecodeInterpreter::run(), where is_f1_null() is
342 // called to check if an invokedynamic call is resolved. This load
343 // of _f1 must be ordered with the loads performed by
344 // cache->main_entry_index().
345 bool is_f1_null() const; // classifies a CPC entry as unbound
346 int f2_as_index() const { assert(!is_vfinal(), ""); return (int) _f2; }
347 Method* f2_as_vfinal_method() const { assert(is_vfinal(), ""); return (Method*)_f2; }
348 Method* f2_as_interface_method() const;
349 intx flags_ord() const;
350 int field_index() const { assert(is_field_entry(), ""); return (_flags & field_index_mask); }
351 int parameter_size() const { assert(is_method_entry(), ""); return (_flags & parameter_size_mask); }
352 bool is_volatile() const { return (_flags & (1 << is_volatile_shift)) != 0; }
353 bool is_final() const { return (_flags & (1 << is_final_shift)) != 0; }
354 bool is_forced_virtual() const { return (_flags & (1 << is_forced_virtual_shift)) != 0; }
355 bool is_vfinal() const { return (_flags & (1 << is_vfinal_shift)) != 0; }
356 bool indy_resolution_failed() const;
357 bool has_appendix() const;
358 bool has_method_type() const;
359 bool is_method_entry() const { return (_flags & (1 << is_field_entry_shift)) == 0; }
360 bool is_field_entry() const { return (_flags & (1 << is_field_entry_shift)) != 0; }
361 bool is_long() const { return flag_state() == ltos; }
362 bool is_double() const { return flag_state() == dtos; }
363 TosState flag_state() const { assert((uint)number_of_states <= (uint)tos_state_mask+1, "");
364 return (TosState)((_flags >> tos_state_shift) & tos_state_mask); }
365 void set_indy_resolution_failed();
366
367 // Code generation support
368 static WordSize size() {
369 return in_WordSize(align_up((int)sizeof(ConstantPoolCacheEntry), wordSize) / wordSize);
370 }
371 static ByteSize size_in_bytes() { return in_ByteSize(sizeof(ConstantPoolCacheEntry)); }
372 static ByteSize indices_offset() { return byte_offset_of(ConstantPoolCacheEntry, _indices); }
373 static ByteSize f1_offset() { return byte_offset_of(ConstantPoolCacheEntry, _f1); }
374 static ByteSize f2_offset() { return byte_offset_of(ConstantPoolCacheEntry, _f2); }
375 static ByteSize flags_offset() { return byte_offset_of(ConstantPoolCacheEntry, _flags); }
376
377 #if INCLUDE_JVMTI
378 // RedefineClasses() API support:
379 // If this ConstantPoolCacheEntry refers to old_method then update it
380 // to refer to new_method.
381 // trace_name_printed is set to true if the current call has
382 // printed the klass name so that other routines in the adjust_*
383 // group don't print the klass name.
384 void adjust_method_entry(Method* old_method, Method* new_method,
385 bool* trace_name_printed);
386 bool check_no_old_or_obsolete_entries();
387 Method* get_interesting_method_entry(Klass* k);
388 #endif // INCLUDE_JVMTI
389
390 // Debugging & Printing
391 void print (outputStream* st, int index) const;
392 void verify(outputStream* st) const;
393
394 static void verify_tos_state_shift() {
395 // When shifting flags as a 32-bit int, make sure we don't need an extra mask for tos_state:
396 assert((((u4)-1 >> tos_state_shift) & ~tos_state_mask) == 0, "no need for tos_state mask");
397 }
398
399 void verify_just_initialized(bool f2_used);
400 void reinitialize(bool f2_used);
401 };
402
403
404 // A constant pool cache is a runtime data structure set aside to a constant pool. The cache
405 // holds interpreter runtime information for all field access and invoke bytecodes. The cache
406 // is created and initialized before a class is actively used (i.e., initialized), the indivi-
407 // dual cache entries are filled at resolution (i.e., "link") time (see also: rewriter.*).
408
409 class ConstantPoolCache: public MetaspaceObj {
410 friend class VMStructs;
411 friend class MetadataFactory;
412 private:
413 // If you add a new field that points to any metaspace object, you
414 // must add this field to ConstantPoolCache::metaspace_pointers_do().
415 int _length;
416 ConstantPool* _constant_pool; // the corresponding constant pool
417
418 // The following fields need to be modified at runtime, so they cannot be
419 // stored in the ConstantPool, which is read-only.
420 // Array of resolved objects from the constant pool and map from resolved
421 // object index to original constant pool index
422 OopHandle _resolved_references;
423 Array<u2>* _reference_map;
424 // The narrowOop pointer to the archived resolved_references. Set at CDS dump
425 // time when caching java heap object is supported.
426 CDS_JAVA_HEAP_ONLY(narrowOop _archived_references;)
427
428 // Sizing
429 debug_only(friend class ClassVerifier;)
430
431 // Constructor
432 ConstantPoolCache(int length,
433 const intStack& inverse_index_map,
434 const intStack& invokedynamic_inverse_index_map,
435 const intStack& invokedynamic_references_map);
436
437 // Initialization
438 void initialize(const intArray& inverse_index_map,
439 const intArray& invokedynamic_inverse_index_map,
440 const intArray& invokedynamic_references_map);
441 public:
442 static ConstantPoolCache* allocate(ClassLoaderData* loader_data,
443 const intStack& cp_cache_map,
444 const intStack& invokedynamic_cp_cache_map,
445 const intStack& invokedynamic_references_map, TRAPS);
446 bool is_constantPoolCache() const { return true; }
447
448 int length() const { return _length; }
449 void metaspace_pointers_do(MetaspaceClosure* it);
450 MetaspaceObj::Type type() const { return ConstantPoolCacheType; }
451
452 oop archived_references() NOT_CDS_JAVA_HEAP_RETURN_(NULL);
453 void set_archived_references(oop o) NOT_CDS_JAVA_HEAP_RETURN;
454
455 oop resolved_references() { return _resolved_references.resolve(); }
456 void set_resolved_references(OopHandle s) { _resolved_references = s; }
457 Array<u2>* reference_map() const { return _reference_map; }
458 void set_reference_map(Array<u2>* o) { _reference_map = o; }
459
460 // Assembly code support
461 static int resolved_references_offset_in_bytes() { return offset_of(ConstantPoolCache, _resolved_references); }
462
463 // CDS support
464 void remove_unshareable_info();
465 void verify_just_initialized();
466 private:
467 void walk_entries_for_initialization(bool check_only);
468 void set_length(int length) { _length = length; }
469
470 static int header_size() { return sizeof(ConstantPoolCache) / wordSize; }
471 static int size(int length) { return align_metadata_size(header_size() + length * in_words(ConstantPoolCacheEntry::size())); }
472 public:
473 int size() const { return size(length()); }
474 private:
475
476 // Helpers
477 ConstantPool** constant_pool_addr() { return &_constant_pool; }
478 ConstantPoolCacheEntry* base() const { return (ConstantPoolCacheEntry*)((address)this + in_bytes(base_offset())); }
479
480 friend class constantPoolCacheKlass;
481 friend class ConstantPoolCacheEntry;
482
483 public:
484 // Accessors
485 void set_constant_pool(ConstantPool* pool) { _constant_pool = pool; }
486 ConstantPool* constant_pool() const { return _constant_pool; }
487 // Fetches the entry at the given index.
488 // In either case the index must not be encoded or byte-swapped in any way.
489 ConstantPoolCacheEntry* entry_at(int i) const {
490 assert(0 <= i && i < length(), "index out of bounds");
491 return base() + i;
492 }
493
494 // Code generation
495 static ByteSize base_offset() { return in_ByteSize(sizeof(ConstantPoolCache)); }
496 static ByteSize entry_offset(int raw_index) {
497 int index = raw_index;
498 return (base_offset() + ConstantPoolCacheEntry::size_in_bytes() * index);
499 }
500
501 #if INCLUDE_JVMTI
502 // RedefineClasses() API support:
503 // If any entry of this ConstantPoolCache points to any of
504 // old_methods, replace it with the corresponding new_method.
505 // trace_name_printed is set to true if the current call has
506 // printed the klass name so that other routines in the adjust_*
507 // group don't print the klass name.
508 void adjust_method_entries(InstanceKlass* holder, bool* trace_name_printed);
509 bool check_no_old_or_obsolete_entries();
510 void dump_cache();
511 #endif // INCLUDE_JVMTI
512
513 // RedefineClasses support
514 DEBUG_ONLY(bool on_stack() { return false; })
515 void deallocate_contents(ClassLoaderData* data);
516 bool is_klass() const { return false; }
517
518 // Printing
519 void print_on(outputStream* st) const;
520 void print_value_on(outputStream* st) const;
521
522 const char* internal_name() const { return "{constant pool cache}"; }
523
524 // Verify
525 void verify_on(outputStream* st);
526 };
527
528 #endif // SHARE_VM_OOPS_CPCACHEOOP_HPP