1 /*
  2  * Copyright (c) 1997, 2021, 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_INTERPRETER_ABSTRACTINTERPRETER_HPP
 26 #define SHARE_INTERPRETER_ABSTRACTINTERPRETER_HPP
 27 
 28 #include "asm/macroAssembler.hpp"
 29 #include "classfile/vmIntrinsics.hpp"
 30 #include "code/stubs.hpp"
 31 #include "interpreter/bytecodes.hpp"
 32 #include "oops/method.hpp"
 33 #include "runtime/frame.hpp"
 34 #include "runtime/thread.hpp"
 35 #include "runtime/vmThread.hpp"
 36 
 37 // This file contains the platform-independent parts
 38 // of the abstract interpreter and the abstract interpreter generator.
 39 
 40 // Organization of the interpreter(s). There exists two different interpreters in hotpot
 41 // an assembly language version (aka template interpreter) and a high level language version
 42 // (aka c++ interpreter). Th division of labor is as follows:
 43 
 44 // Template Interpreter          Zero Interpreter       Functionality
 45 //
 46 // templateTable*                bytecodeInterpreter*   actual interpretation of bytecodes
 47 //
 48 // templateInterpreter*          zeroInterpreter*       generation of assembly code that creates
 49 //                                                      and manages interpreter runtime frames.
 50 //
 51 
 52 class InterpreterMacroAssembler;
 53 
 54 class AbstractInterpreter: AllStatic {
 55   friend class VMStructs;
 56   friend class ZeroInterpreterGenerator;
 57   friend class TemplateInterpreterGenerator;
 58  public:
 59   enum MethodKind {
 60     zerolocals,                                                 // method needs locals initialization
 61     zerolocals_synchronized,                                    // method needs locals initialization & is synchronized
 62     native,                                                     // native method
 63     native_synchronized,                                        // native method & is synchronized
 64     empty,                                                      // empty method (code: _return)
 65     getter,                                                     // getter method
 66     setter,                                                     // setter method
 67     abstract,                                                   // abstract method (throws an AbstractMethodException)
 68     method_handle_invoke_FIRST,                                 // java.lang.invoke.MethodHandles::invokeExact, etc.
 69     method_handle_invoke_LAST                                   = (method_handle_invoke_FIRST
 70                                                                    + (static_cast<int>(vmIntrinsics::LAST_MH_SIG_POLY)
 71                                                                       - static_cast<int>(vmIntrinsics::FIRST_MH_SIG_POLY))),
 72     java_lang_math_sin,                                         // implementation of java.lang.Math.sin   (x)
 73     java_lang_math_cos,                                         // implementation of java.lang.Math.cos   (x)
 74     java_lang_math_tan,                                         // implementation of java.lang.Math.tan   (x)
 75     java_lang_math_abs,                                         // implementation of java.lang.Math.abs   (x)
 76     java_lang_math_sqrt,                                        // implementation of java.lang.Math.sqrt  (x)
 77     java_lang_math_log,                                         // implementation of java.lang.Math.log   (x)
 78     java_lang_math_log10,                                       // implementation of java.lang.Math.log10 (x)
 79     java_lang_math_pow,                                         // implementation of java.lang.Math.pow   (x,y)
 80     java_lang_math_exp,                                         // implementation of java.lang.Math.exp   (x)
 81     java_lang_math_fmaF,                                        // implementation of java.lang.Math.fma   (x, y, z)
 82     java_lang_math_fmaD,                                        // implementation of java.lang.Math.fma   (x, y, z)
 83     java_lang_ref_reference_get,                                // implementation of java.lang.ref.Reference.get()
 84     java_util_zip_CRC32_update,                                 // implementation of java.util.zip.CRC32.update()
 85     java_util_zip_CRC32_updateBytes,                            // implementation of java.util.zip.CRC32.updateBytes()
 86     java_util_zip_CRC32_updateByteBuffer,                       // implementation of java.util.zip.CRC32.updateByteBuffer()
 87     java_util_zip_CRC32C_updateBytes,                           // implementation of java.util.zip.CRC32C.updateBytes(crc, b[], off, end)
 88     java_util_zip_CRC32C_updateDirectByteBuffer,                // implementation of java.util.zip.CRC32C.updateDirectByteBuffer(crc, address, off, end)
 89     java_lang_Float_intBitsToFloat,                             // implementation of java.lang.Float.intBitsToFloat()
 90     java_lang_Float_floatToRawIntBits,                          // implementation of java.lang.Float.floatToRawIntBits()
 91     java_lang_Double_longBitsToDouble,                          // implementation of java.lang.Double.longBitsToDouble()
 92     java_lang_Double_doubleToRawLongBits,                       // implementation of java.lang.Double.doubleToRawLongBits()
 93     number_of_method_entries,
 94     invalid = -1
 95   };
 96 
 97   // Conversion from the part of the above enum to vmIntrinsics::_invokeExact, etc.
 98   static vmIntrinsics::ID method_handle_intrinsic(MethodKind kind) {
 99     if (kind >= method_handle_invoke_FIRST && kind <= method_handle_invoke_LAST)
100       return vmIntrinsics::ID_from(static_cast<int>(vmIntrinsics::FIRST_MH_SIG_POLY) + (kind - method_handle_invoke_FIRST));
101     else
102       return vmIntrinsics::_none;
103   }
104 
105   enum SomeConstants {
106     number_of_result_handlers = 10                              // number of result handlers for native calls
107   };
108 
109  protected:
110   static StubQueue* _code;                                      // the interpreter code (codelets)
111 
112   static bool       _notice_safepoints;                         // true if safepoints are activated
113 
114   static address    _native_entry_begin;                        // Region for native entry code
115   static address    _native_entry_end;
116 
117   // method entry points
118   static address    _entry_table[number_of_method_entries];     // entry points for a given method
119   static address    _native_abi_to_tosca[number_of_result_handlers];  // for native method result handlers
120   static address    _slow_signature_handler;                              // the native method generic (slow) signature handler
121 
122   static address    _rethrow_exception_entry;                   // rethrows an activation in previous frame
123 
124   friend class      AbstractInterpreterGenerator;
125   friend class      InterpreterMacroAssembler;
126 
127  public:
128   // Initialization/debugging
129   static void       initialize();
130   static StubQueue* code()                                      { return _code; }
131 
132 
133   // Method activation
134   static MethodKind method_kind(const methodHandle& m);
135   static address    entry_for_kind(MethodKind k)                { assert(0 <= k && k < number_of_method_entries, "illegal kind"); return _entry_table[k]; }
136   static address    entry_for_method(const methodHandle& m)     { return entry_for_kind(method_kind(m)); }
137 
138   // used for bootstrapping method handles:
139   static void       set_entry_for_kind(MethodKind k, address e);
140 
141   static void       print_method_kind(MethodKind kind)          PRODUCT_RETURN;
142 
143   // These should never be compiled since the interpreter will prefer
144   // the compiled version to the intrinsic version.
145   static bool       can_be_compiled(const methodHandle& m) {
146     switch (m->intrinsic_id()) {
147       case vmIntrinsics::_dsin  : // fall thru
148       case vmIntrinsics::_dcos  : // fall thru
149       case vmIntrinsics::_dtan  : // fall thru
150       case vmIntrinsics::_dabs  : // fall thru
151       case vmIntrinsics::_dsqrt : // fall thru
152       case vmIntrinsics::_dlog  : // fall thru
153       case vmIntrinsics::_dlog10: // fall thru
154       case vmIntrinsics::_dpow  : // fall thru
155       case vmIntrinsics::_dexp  : // fall thru
156       case vmIntrinsics::_fmaD  : // fall thru
157       case vmIntrinsics::_fmaF  : // fall thru
158         return false;
159       default:
160         return true;
161     }
162   }
163 
164   // Runtime support
165 
166   // length = invoke bytecode length (to advance to next bytecode)
167   static address deopt_entry(TosState state, int length) { ShouldNotReachHere(); return NULL; }
168   static address return_entry(TosState state, int length, Bytecodes::Code code) { ShouldNotReachHere(); return NULL; }
169 
170   static address    rethrow_exception_entry()                   { return _rethrow_exception_entry; }
171 
172   // Activation size in words for a method that is just being called.
173   // Parameters haven't been pushed so count them too.
174   static int        size_top_interpreter_activation(Method* method);
175 
176   // Deoptimization support
177   // Compute the entry address for continuation after
178   static address deopt_continue_after_entry(Method* method,
179                                             address bcp,
180                                             int callee_parameters,
181                                             bool is_top_frame);
182   // Compute the entry address for reexecution
183   static address deopt_reexecute_entry(Method* method, address bcp);
184   // Deoptimization should reexecute this bytecode
185   static bool    bytecode_should_reexecute(Bytecodes::Code code);
186 
187   // deoptimization support
188   static int        size_activation(int max_stack,
189                                     int temps,
190                                     int extra_args,
191                                     int monitors,
192                                     int callee_params,
193                                     int callee_locals,
194                                     bool is_top_frame);
195 
196   static void      layout_activation(Method* method,
197                                      int temps,
198                                      int popframe_args,
199                                      int monitors,
200                                      int caller_actual_parameters,
201                                      int callee_params,
202                                      int callee_locals,
203                                      frame* caller,
204                                      frame* interpreter_frame,
205                                      bool is_top_frame,
206                                      bool is_bottom_frame);
207 
208   // Runtime support
209   static bool       is_not_reached(const methodHandle& method, int bci);
210   // Safepoint support
211   static void       notice_safepoints()                         { ShouldNotReachHere(); } // stops the thread when reaching a safepoint
212   static void       ignore_safepoints()                         { ShouldNotReachHere(); } // ignores safepoints
213 
214   // Support for native calls
215   static address    slow_signature_handler()                    { return _slow_signature_handler; }
216   static address    result_handler(BasicType type)              { return _native_abi_to_tosca[BasicType_as_index(type)]; }
217   static int        BasicType_as_index(BasicType type);         // computes index into result_handler_by_index table
218   static bool       in_native_entry(address pc)                 { return _native_entry_begin <= pc && pc < _native_entry_end; }
219   // Debugging/printing
220   static void       print();                                    // prints the interpreter code
221 
222  public:
223   // Interpreter helpers
224   const static int stackElementWords   = 1;
225   const static int stackElementSize    = stackElementWords * wordSize;
226   const static int logStackElementSize = LogBytesPerWord;
227 
228   static int expr_index_at(int i) {
229     return stackElementWords * i;
230   }
231 
232   static int expr_offset_in_bytes(int i) {
233 #if !defined(ZERO) && (defined(PPC) || defined(S390))
234     return stackElementSize * i + wordSize;  // both point to one word past TOS
235 #else
236     return stackElementSize * i;
237 #endif
238   }
239 
240   static int local_index_at(int i) {
241     assert(i <= 0, "local direction already negated");
242     return stackElementWords * i;
243   }
244 
245 #if !defined(ZERO) && (defined(IA32) || defined(AMD64))
246   static Address::ScaleFactor stackElementScale() {
247     return NOT_LP64(Address::times_4) LP64_ONLY(Address::times_8);
248   }
249 #endif
250 
251   // Local values relative to locals[n]
252   static int  local_offset_in_bytes(int n) {
253     return ((frame::interpreter_frame_expression_stack_direction() * n) * stackElementSize);
254   }
255 
256   // access to stacked values according to type:
257   static oop* oop_addr_in_slot(intptr_t* slot_addr) {
258     return (oop*) slot_addr;
259   }
260   static jint* int_addr_in_slot(intptr_t* slot_addr) {
261     if ((int) sizeof(jint) < wordSize && !Endian::is_Java_byte_ordering_different())
262       // big-endian LP64
263       return (jint*)(slot_addr + 1) - 1;
264     else
265       return (jint*) slot_addr;
266   }
267   static jlong long_in_slot(intptr_t* slot_addr) {
268     if (sizeof(intptr_t) >= sizeof(jlong)) {
269       return *(jlong*) slot_addr;
270     } else {
271       return Bytes::get_native_u8((address)slot_addr);
272     }
273   }
274   static void set_long_in_slot(intptr_t* slot_addr, jlong value) {
275     if (sizeof(intptr_t) >= sizeof(jlong)) {
276       *(jlong*) slot_addr = value;
277     } else {
278       Bytes::put_native_u8((address)slot_addr, value);
279     }
280   }
281 
282   static void initialize_method_handle_entries();
283 };
284 
285 //------------------------------------------------------------------------------------------------------------------------
286 // The interpreter generator.
287 
288 class Template;
289 class AbstractInterpreterGenerator: public StackObj {
290  protected:
291   InterpreterMacroAssembler* _masm;
292 
293  public:
294   AbstractInterpreterGenerator(StubQueue* _code);
295 };
296 
297 #endif // SHARE_INTERPRETER_ABSTRACTINTERPRETER_HPP