1 /*
2  * Copyright (c) 1997, 2015, 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_ABSTRACTINTERPRETER_HPP
26 #define SHARE_VM_INTERPRETER_ABSTRACTINTERPRETER_HPP
27 
28 #include "code/stubs.hpp"
29 #include "interpreter/bytecodes.hpp"
30 #include "runtime/thread.inline.hpp"
31 #include "runtime/vmThread.hpp"
32 #include "utilities/top.hpp"
33 #if defined INTERP_MASM_MD_HPP
34 # include INTERP_MASM_MD_HPP
35 #elif defined TARGET_ARCH_x86
36 # include "interp_masm_x86.hpp"
37 #elif defined TARGET_ARCH_MODEL_aarch64
38 # include "interp_masm_aarch64.hpp"
39 #elif defined TARGET_ARCH_MODEL_sparc
40 # include "interp_masm_sparc.hpp"
41 #elif defined TARGET_ARCH_MODEL_zero
42 # include "interp_masm_zero.hpp"
43 #elif defined TARGET_ARCH_MODEL_ppc_64
44 # include "interp_masm_ppc_64.hpp"
45 #endif
46 
47 // This file contains the platform-independent parts
48 // of the abstract interpreter and the abstract interpreter generator.
49 
50 // Organization of the interpreter(s). There exists two different interpreters in hotpot
51 // an assembly language version (aka template interpreter) and a high level language version
52 // (aka c++ interpreter). Th division of labor is as follows:
53 
54 // Template Interpreter          C++ Interpreter        Functionality
55 //
56 // templateTable*                bytecodeInterpreter*   actual interpretation of bytecodes
57 //
58 // templateInterpreter*          cppInterpreter*        generation of assembly code that creates
59 //                                                      and manages interpreter runtime frames.
60 //                                                      Also code for populating interpreter
61 //                                                      frames created during deoptimization.
62 //
63 // For both template and c++ interpreter. There are common files for aspects of the interpreter
64 // that are generic to both interpreters. This is the layout:
65 //
66 // abstractInterpreter.hpp: generic description of the interpreter.
67 // interpreter*:            generic frame creation and handling.
68 //
69 
70 //------------------------------------------------------------------------------------------------------------------------
71 // The C++ interface to the bytecode interpreter(s).
72 
73 class AbstractInterpreter: AllStatic {
74   friend class VMStructs;
75   friend class Interpreter;
76   friend class CppInterpreterGenerator;
77  public:
78   enum MethodKind {
79     zerolocals,                                                 // method needs locals initialization
80     zerolocals_synchronized,                                    // method needs locals initialization & is synchronized
81     native,                                                     // native method
82     native_synchronized,                                        // native method & is synchronized
83     empty,                                                      // empty method (code: _return)
84     accessor,                                                   // accessor method (code: _aload_0, _getfield, _(a|i)return)
85     abstract,                                                   // abstract method (throws an AbstractMethodException)
86     method_handle_invoke_FIRST,                                 // java.lang.invoke.MethodHandles::invokeExact, etc.
87     method_handle_invoke_LAST                                   = (method_handle_invoke_FIRST
88                                                                    + (vmIntrinsics::LAST_MH_SIG_POLY
89                                                                       - vmIntrinsics::FIRST_MH_SIG_POLY)),
90     java_lang_math_sin,                                         // implementation of java.lang.Math.sin   (x)
91     java_lang_math_cos,                                         // implementation of java.lang.Math.cos   (x)
92     java_lang_math_tan,                                         // implementation of java.lang.Math.tan   (x)
93     java_lang_math_abs,                                         // implementation of java.lang.Math.abs   (x)
94     java_lang_math_sqrt,                                        // implementation of java.lang.Math.sqrt  (x)
95     java_lang_math_log,                                         // implementation of java.lang.Math.log   (x)
96     java_lang_math_log10,                                       // implementation of java.lang.Math.log10 (x)
97     java_lang_math_pow,                                         // implementation of java.lang.Math.pow   (x,y)
98     java_lang_math_exp,                                         // implementation of java.lang.Math.exp   (x)
99     java_lang_ref_reference_get,                                // implementation of java.lang.ref.Reference.get()
100     java_util_zip_CRC32_update,                                 // implementation of java.util.zip.CRC32.update()
101     java_util_zip_CRC32_updateBytes,                            // implementation of java.util.zip.CRC32.updateBytes()
102     java_util_zip_CRC32_updateByteBuffer,                       // implementation of java.util.zip.CRC32.updateByteBuffer()
103     number_of_method_entries,
104     invalid = -1
105   };
106 
107   // Conversion from the part of the above enum to vmIntrinsics::_invokeExact, etc.
method_handle_intrinsic(MethodKind kind)108   static vmIntrinsics::ID method_handle_intrinsic(MethodKind kind) {
109     if (kind >= method_handle_invoke_FIRST && kind <= method_handle_invoke_LAST)
110       return (vmIntrinsics::ID)( vmIntrinsics::FIRST_MH_SIG_POLY + (kind - method_handle_invoke_FIRST) );
111     else
112       return vmIntrinsics::_none;
113   }
114 
115   enum SomeConstants {
116     number_of_result_handlers = 10                              // number of result handlers for native calls
117   };
118 
119  protected:
120   static StubQueue* _code;                                      // the interpreter code (codelets)
121 
122   static bool       _notice_safepoints;                         // true if safepoints are activated
123 
124   static address    _native_entry_begin;                        // Region for native entry code
125   static address    _native_entry_end;
126 
127   // method entry points
128   static address    _entry_table[number_of_method_entries];     // entry points for a given method
129   static address    _native_abi_to_tosca[number_of_result_handlers];  // for native method result handlers
130   static address    _slow_signature_handler;                              // the native method generic (slow) signature handler
131 
132   static address    _rethrow_exception_entry;                   // rethrows an activation in previous frame
133 
134   friend class      AbstractInterpreterGenerator;
135   friend class              InterpreterGenerator;
136   friend class      InterpreterMacroAssembler;
137 
138  public:
139   // Initialization/debugging
140   static void       initialize();
code()141   static StubQueue* code()                                      { return _code; }
142 
143 
144   // Method activation
145   static MethodKind method_kind(methodHandle m);
entry_for_kind(MethodKind k)146   static address    entry_for_kind(MethodKind k)                { assert(0 <= k && k < number_of_method_entries, "illegal kind"); return _entry_table[k]; }
entry_for_method(methodHandle m)147   static address    entry_for_method(methodHandle m)            { return entry_for_kind(method_kind(m)); }
148 
149   // used for bootstrapping method handles:
150   static void       set_entry_for_kind(MethodKind k, address e);
151 
152   static void       print_method_kind(MethodKind kind)          PRODUCT_RETURN;
153 
154   static bool       can_be_compiled(methodHandle m);
155 
156   // Runtime support
157 
158   // length = invoke bytecode length (to advance to next bytecode)
deopt_entry(TosState state,int length)159   static address deopt_entry(TosState state, int length) { ShouldNotReachHere(); return NULL; }
return_entry(TosState state,int length,Bytecodes::Code code)160   static address return_entry(TosState state, int length, Bytecodes::Code code) { ShouldNotReachHere(); return NULL; }
161 
rethrow_exception_entry()162   static address    rethrow_exception_entry()                   { return _rethrow_exception_entry; }
163 
164   // Activation size in words for a method that is just being called.
165   // Parameters haven't been pushed so count them too.
166   static int        size_top_interpreter_activation(Method* method);
167 
168   // Deoptimization support
169   // Compute the entry address for continuation after
170   static address deopt_continue_after_entry(Method* method,
171                                             address bcp,
172                                             int callee_parameters,
173                                             bool is_top_frame);
174   // Compute the entry address for reexecution
175   static address deopt_reexecute_entry(Method* method, address bcp);
176   // Deoptimization should reexecute this bytecode
177   static bool    bytecode_should_reexecute(Bytecodes::Code code);
178 
179   // deoptimization support
180   static int        size_activation(int max_stack,
181                                     int temps,
182                                     int extra_args,
183                                     int monitors,
184                                     int callee_params,
185                                     int callee_locals,
186                                     bool is_top_frame);
187 
188   static void      layout_activation(Method* method,
189                                      int temps,
190                                      int popframe_args,
191                                      int monitors,
192                                      int caller_actual_parameters,
193                                      int callee_params,
194                                      int callee_locals,
195                                      frame* caller,
196                                      frame* interpreter_frame,
197                                      bool is_top_frame,
198                                      bool is_bottom_frame);
199 
200   // Runtime support
201   static bool       is_not_reached(                       methodHandle method, int bci);
202   // Safepoint support
notice_safepoints()203   static void       notice_safepoints()                         { ShouldNotReachHere(); } // stops the thread when reaching a safepoint
ignore_safepoints()204   static void       ignore_safepoints()                         { ShouldNotReachHere(); } // ignores safepoints
205 
206   // Support for native calls
slow_signature_handler()207   static address    slow_signature_handler()                    { return _slow_signature_handler; }
result_handler(BasicType type)208   static address    result_handler(BasicType type)              { return _native_abi_to_tosca[BasicType_as_index(type)]; }
209   static int        BasicType_as_index(BasicType type);         // computes index into result_handler_by_index table
in_native_entry(address pc)210   static bool       in_native_entry(address pc)                 { return _native_entry_begin <= pc && pc < _native_entry_end; }
211   // Debugging/printing
212   static void       print();                                    // prints the interpreter code
213 
214  public:
215   // Interpreter helpers
216   const static int stackElementWords   = 1;
217   const static int stackElementSize    = stackElementWords * wordSize;
218   const static int logStackElementSize = LogBytesPerWord;
219 
220   // Local values relative to locals[n]
local_offset_in_bytes(int n)221   static int  local_offset_in_bytes(int n) {
222     return ((frame::interpreter_frame_expression_stack_direction() * n) * stackElementSize);
223   }
224 
225   // access to stacked values according to type:
oop_addr_in_slot(intptr_t * slot_addr)226   static oop* oop_addr_in_slot(intptr_t* slot_addr) {
227     return (oop*) slot_addr;
228   }
int_addr_in_slot(intptr_t * slot_addr)229   static jint* int_addr_in_slot(intptr_t* slot_addr) {
230     if ((int) sizeof(jint) < wordSize && !Bytes::is_Java_byte_ordering_different())
231       // big-endian LP64
232       return (jint*)(slot_addr + 1) - 1;
233     else
234       return (jint*) slot_addr;
235   }
long_in_slot(intptr_t * slot_addr)236   static jlong long_in_slot(intptr_t* slot_addr) {
237     if (sizeof(intptr_t) >= sizeof(jlong)) {
238       return *(jlong*) slot_addr;
239     } else {
240       return Bytes::get_native_u8((address)slot_addr);
241     }
242   }
set_long_in_slot(intptr_t * slot_addr,jlong value)243   static void set_long_in_slot(intptr_t* slot_addr, jlong value) {
244     if (sizeof(intptr_t) >= sizeof(jlong)) {
245       *(jlong*) slot_addr = value;
246     } else {
247       Bytes::put_native_u8((address)slot_addr, value);
248     }
249   }
get_jvalue_in_slot(intptr_t * slot_addr,BasicType type,jvalue * value)250   static void get_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
251     switch (type) {
252     case T_BOOLEAN: value->z = *int_addr_in_slot(slot_addr);            break;
253     case T_CHAR:    value->c = *int_addr_in_slot(slot_addr);            break;
254     case T_BYTE:    value->b = *int_addr_in_slot(slot_addr);            break;
255     case T_SHORT:   value->s = *int_addr_in_slot(slot_addr);            break;
256     case T_INT:     value->i = *int_addr_in_slot(slot_addr);            break;
257     case T_LONG:    value->j = long_in_slot(slot_addr);                 break;
258     case T_FLOAT:   value->f = *(jfloat*)int_addr_in_slot(slot_addr);   break;
259     case T_DOUBLE:  value->d = jdouble_cast(long_in_slot(slot_addr));   break;
260     case T_OBJECT:  value->l = (jobject)*oop_addr_in_slot(slot_addr);   break;
261     default:        ShouldNotReachHere();
262     }
263   }
set_jvalue_in_slot(intptr_t * slot_addr,BasicType type,jvalue * value)264   static void set_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
265     switch (type) {
266     case T_BOOLEAN: *int_addr_in_slot(slot_addr) = (value->z != 0);     break;
267     case T_CHAR:    *int_addr_in_slot(slot_addr) = value->c;            break;
268     case T_BYTE:    *int_addr_in_slot(slot_addr) = value->b;            break;
269     case T_SHORT:   *int_addr_in_slot(slot_addr) = value->s;            break;
270     case T_INT:     *int_addr_in_slot(slot_addr) = value->i;            break;
271     case T_LONG:    set_long_in_slot(slot_addr, value->j);              break;
272     case T_FLOAT:   *(jfloat*)int_addr_in_slot(slot_addr) = value->f;   break;
273     case T_DOUBLE:  set_long_in_slot(slot_addr, jlong_cast(value->d));  break;
274     case T_OBJECT:  *oop_addr_in_slot(slot_addr) = (oop) value->l;      break;
275     default:        ShouldNotReachHere();
276     }
277   }
278 };
279 
280 //------------------------------------------------------------------------------------------------------------------------
281 // The interpreter generator.
282 
283 class Template;
284 class AbstractInterpreterGenerator: public StackObj {
285  protected:
286   InterpreterMacroAssembler* _masm;
287 
288   // shared code sequences
289   // Converter for native abi result to tosca result
290   address generate_result_handler_for(BasicType type);
291   address generate_slow_signature_handler();
292 
293   // entry point generator
294   address generate_method_entry(AbstractInterpreter::MethodKind kind);
295 
296   void bang_stack_shadow_pages(bool native_call);
297 
298   void generate_all();
299   void initialize_method_handle_entries();
300 
301  public:
302   AbstractInterpreterGenerator(StubQueue* _code);
303 };
304 
305 #endif // SHARE_VM_INTERPRETER_ABSTRACTINTERPRETER_HPP
306