1 /*
2 * Copyright (c) 1997, 2016, 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_INTERPRETER_INTERPRETERRUNTIME_HPP
26 #define SHARE_VM_INTERPRETER_INTERPRETERRUNTIME_HPP
27
28 #include "interpreter/bytecode.hpp"
29 #include "interpreter/linkResolver.hpp"
30 #include "memory/universe.hpp"
31 #include "oops/method.hpp"
32 #include "runtime/frame.inline.hpp"
33 #include "runtime/signature.hpp"
34 #include "runtime/thread.hpp"
35 #include "utilities/macros.hpp"
36
37 // The InterpreterRuntime is called by the interpreter for everything
38 // that cannot/should not be dealt with in assembly and needs C support.
39
40 class InterpreterRuntime: AllStatic {
41 friend class BytecodeClosure; // for method and bcp
42 friend class PrintingClosure; // for method and bcp
43
44 private:
45 // Helper functions to access current interpreter state
46 static frame last_frame(JavaThread *thread) { return thread->last_frame(); }
47 static Method* method(JavaThread *thread) { return last_frame(thread).interpreter_frame_method(); }
48 static address bcp(JavaThread *thread) { return last_frame(thread).interpreter_frame_bcp(); }
49 static int bci(JavaThread *thread) { return last_frame(thread).interpreter_frame_bci(); }
50 static void set_bcp_and_mdp(address bcp, JavaThread*thread);
51 static Bytecodes::Code code(JavaThread *thread) {
52 // pass method to avoid calling unsafe bcp_to_method (partial fix 4926272)
53 return Bytecodes::code_at(method(thread), bcp(thread));
54 }
55 static Bytecode bytecode(JavaThread *thread) { return Bytecode(method(thread), bcp(thread)); }
56 static int get_index_u1(JavaThread *thread, Bytecodes::Code bc)
57 { return bytecode(thread).get_index_u1(bc); }
58 static int get_index_u2(JavaThread *thread, Bytecodes::Code bc)
59 { return bytecode(thread).get_index_u2(bc); }
60 static int get_index_u2_cpcache(JavaThread *thread, Bytecodes::Code bc)
61 { return bytecode(thread).get_index_u2_cpcache(bc); }
62 static int get_index_u4(JavaThread *thread, Bytecodes::Code bc)
63 { return bytecode(thread).get_index_u4(bc); }
64 static int number_of_dimensions(JavaThread *thread) { return bcp(thread)[3]; }
65
66 static ConstantPoolCacheEntry* cache_entry_at(JavaThread *thread, int i) { return method(thread)->constants()->cache()->entry_at(i); }
67 static ConstantPoolCacheEntry* cache_entry(JavaThread *thread) { return cache_entry_at(thread, Bytes::get_native_u2(bcp(thread) + 1)); }
68 static void note_trap_inner(JavaThread* thread, int reason,
69 methodHandle trap_method, int trap_bci, TRAPS);
70 static void note_trap(JavaThread *thread, int reason, TRAPS);
71 #ifdef CC_INTERP
72 // Profile traps in C++ interpreter.
73 static void note_trap(JavaThread* thread, int reason, Method *method, int trap_bci);
74 #endif // CC_INTERP
75
76 // Inner work method for Interpreter's frequency counter overflow.
77 static nmethod* frequency_counter_overflow_inner(JavaThread* thread, address branch_bcp);
78
79 public:
80 // Constants
81 static void ldc (JavaThread* thread, bool wide);
82 static void resolve_ldc (JavaThread* thread, Bytecodes::Code bytecode);
83
84 // Allocation
85 static void _new (JavaThread* thread, ConstantPool* pool, int index);
86 static void newarray (JavaThread* thread, BasicType type, jint size);
87 static void anewarray (JavaThread* thread, ConstantPool* pool, int index, jint size);
88 static void multianewarray(JavaThread* thread, jint* first_size_address);
89 static void register_finalizer(JavaThread* thread, oopDesc* obj);
90 static void vdefault (JavaThread* thread, ConstantPool* pool, int index);
91 static int vwithfield (JavaThread* thread, ConstantPoolCache* cp_cache);
92 static void qgetfield (JavaThread* thread, oopDesc* value, int offset);
93 static void qputfield (JavaThread* thread, oopDesc* obj, oopDesc* value, int offset);
94
95 // vaload/vastore
96 static void value_array_load(JavaThread* thread, arrayOopDesc* array, int index);
97 static void value_array_store(JavaThread* thread, arrayOopDesc* array, int index, void* val);
98
99 // Valhalla MVT VCC<->DVT
100 static void vbox (JavaThread* thread, ConstantPool* pool, int index, oopDesc* value);
101 static void vunbox(JavaThread* thread, ConstantPool* pool, int index, oopDesc* obj);
102
103
104 // Quicken instance-of and check-cast bytecodes
105 static void quicken_io_cc(JavaThread* thread);
106
107 // Exceptions thrown by the interpreter
108 static void throw_AbstractMethodError(JavaThread* thread);
109 static void throw_IncompatibleClassChangeError(JavaThread* thread);
110 static void throw_StackOverflowError(JavaThread* thread);
111 static void throw_delayed_StackOverflowError(JavaThread* thread);
112 static void throw_ArrayIndexOutOfBoundsException(JavaThread* thread, char* name, jint index);
113 static void throw_ClassCastException(JavaThread* thread, oopDesc* obj);
114 static void create_exception(JavaThread* thread, char* name, char* message);
115 static void create_klass_exception(JavaThread* thread, char* name, oopDesc* obj);
116 static address exception_handler_for_exception(JavaThread* thread, oopDesc* exception);
117 #if INCLUDE_JVMTI
118 static void member_name_arg_or_null(JavaThread* thread, address dmh, Method* m, address bcp);
119 #endif
120 static void throw_pending_exception(JavaThread* thread);
121
122 #ifdef CC_INTERP
123 // Profile traps in C++ interpreter.
124 static void note_nullCheck_trap (JavaThread* thread, Method *method, int trap_bci);
125 static void note_div0Check_trap (JavaThread* thread, Method *method, int trap_bci);
126 static void note_rangeCheck_trap(JavaThread* thread, Method *method, int trap_bci);
127 static void note_classCheck_trap(JavaThread* thread, Method *method, int trap_bci);
128 static void note_arrayCheck_trap(JavaThread* thread, Method *method, int trap_bci);
129 // A dummy for macros that shall not profile traps.
130 static void note_no_trap(JavaThread* thread, Method *method, int trap_bci) {}
131 #endif // CC_INTERP
132
133 static void resolve_from_cache(JavaThread* thread, Bytecodes::Code bytecode);
134 private:
135 // Statics & fields
136 static void resolve_get_put(JavaThread* thread, Bytecodes::Code bytecode);
137
138 // Calls
139 static void resolve_invoke(JavaThread* thread, Bytecodes::Code bytecode);
140 static void resolve_invokehandle (JavaThread* thread);
141 static void resolve_invokedynamic(JavaThread* thread);
142
143 public:
144 // Synchronization
145 static void monitorenter(JavaThread* thread, BasicObjectLock* elem);
146 static void monitorexit (JavaThread* thread, BasicObjectLock* elem);
147
148 static void throw_illegal_monitor_state_exception(JavaThread* thread);
149 static void new_illegal_monitor_state_exception(JavaThread* thread);
150
151 // Breakpoints
152 static void _breakpoint(JavaThread* thread, Method* method, address bcp);
153 static Bytecodes::Code get_original_bytecode_at(JavaThread* thread, Method* method, address bcp);
154 static void set_original_bytecode_at(JavaThread* thread, Method* method, address bcp, Bytecodes::Code new_code);
155 static bool is_breakpoint(JavaThread *thread) { return Bytecodes::code_or_bp_at(bcp(thread)) == Bytecodes::_breakpoint; }
156
157 // Safepoints
158 static void at_safepoint(JavaThread* thread);
159
160 // Debugger support
161 static void post_field_access(JavaThread *thread, oopDesc* obj,
162 ConstantPoolCacheEntry *cp_entry);
163 static void post_field_modification(JavaThread *thread, oopDesc* obj,
164 ConstantPoolCacheEntry *cp_entry, jvalue *value);
165 static void post_method_entry(JavaThread *thread);
166 static void post_method_exit (JavaThread *thread);
167 static int interpreter_contains(address pc);
168
169 // Native signature handlers
170 static void prepare_native_call(JavaThread* thread, Method* method);
171 static address slow_signature_handler(JavaThread* thread,
172 Method* method,
173 intptr_t* from, intptr_t* to);
174
175 #if defined(IA32) || defined(AMD64) || defined(ARM)
176 // Popframe support (only needed on x86, AMD64 and ARM)
177 static void popframe_move_outgoing_args(JavaThread* thread, void* src_address, void* dest_address);
178 #endif
179
180 // bytecode tracing is only used by the TraceBytecodes
181 static intptr_t trace_bytecode(JavaThread* thread, intptr_t preserve_this_value, intptr_t tos, intptr_t tos2) PRODUCT_RETURN0;
182
183 // Platform dependent stuff
184 #include CPU_HEADER(interpreterRT)
185
186 // optional normalization of fingerprints to reduce the number of adapters
187 static uint64_t normalize_fast_native_fingerprint(uint64_t fingerprint);
188
189 // Interpreter's frequency counter overflow
190 static nmethod* frequency_counter_overflow(JavaThread* thread, address branch_bcp);
191
192 // Interpreter profiling support
193 static jint bcp_to_di(Method* method, address cur_bcp);
194 static void profile_method(JavaThread* thread);
195 static void update_mdp_for_ret(JavaThread* thread, int bci);
196 #ifdef ASSERT
197 static void verify_mdp(Method* method, address bcp, address mdp);
198 #endif // ASSERT
199 static MethodCounters* build_method_counters(JavaThread* thread, Method* m);
200 };
201
202
203 class SignatureHandlerLibrary: public AllStatic {
204 public:
205 enum { buffer_size = 1*K }; // the size of the temporary code buffer
206 enum { blob_size = 32*K }; // the size of a handler code blob.
207
208 private:
209 static BufferBlob* _handler_blob; // the current buffer blob containing the generated handlers
210 static address _handler; // next available address within _handler_blob;
211 static GrowableArray<uint64_t>* _fingerprints; // the fingerprint collection
212 static GrowableArray<address>* _handlers; // the corresponding handlers
213 static address _buffer; // the temporary code buffer
214
215 static address set_handler_blob();
216 static void initialize();
217 static address set_handler(CodeBuffer* buffer);
218 static void pd_set_handler(address handler);
219
220 public:
221 static void add(const methodHandle& method);
222 static void add(uint64_t fingerprint, address handler);
223 };
224
225 #endif // SHARE_VM_INTERPRETER_INTERPRETERRUNTIME_HPP