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_lang_continuation_doYield,                             // implementation of jdk.internal.vm.Continuation.doYield()
 85     java_util_zip_CRC32_update,                                 // implementation of java.util.zip.CRC32.update()
 86     java_util_zip_CRC32_updateBytes,                            // implementation of java.util.zip.CRC32.updateBytes()
 87     java_util_zip_CRC32_updateByteBuffer,                       // implementation of java.util.zip.CRC32.updateByteBuffer()
 88     java_util_zip_CRC32C_updateBytes,                           // implementation of java.util.zip.CRC32C.updateBytes(crc, b[], off, end)
 89     java_util_zip_CRC32C_updateDirectByteBuffer,                // implementation of java.util.zip.CRC32C.updateDirectByteBuffer(crc, address, off, end)
 90     java_lang_Float_intBitsToFloat,                             // implementation of java.lang.Float.intBitsToFloat()
 91     java_lang_Float_floatToRawIntBits,                          // implementation of java.lang.Float.floatToRawIntBits()
 92     java_lang_Double_longBitsToDouble,                          // implementation of java.lang.Double.longBitsToDouble()
 93     java_lang_Double_doubleToRawLongBits,                       // implementation of java.lang.Double.doubleToRawLongBits()
 94     number_of_method_entries,
 95     invalid = -1
 96   };
 97 
 98   // Conversion from the part of the above enum to vmIntrinsics::_invokeExact, etc.
 99   static vmIntrinsics::ID method_handle_intrinsic(MethodKind kind) {
100     if (kind >= method_handle_invoke_FIRST && kind <= method_handle_invoke_LAST)
101       return vmIntrinsics::ID_from(static_cast<int>(vmIntrinsics::FIRST_MH_SIG_POLY) + (kind - method_handle_invoke_FIRST));
102     else
103       return vmIntrinsics::_none;
104   }
105 
106   enum SomeConstants {
107     number_of_result_handlers = 10                              // number of result handlers for native calls
108   };
109 
110  protected:
111   static StubQueue* _code;                                      // the interpreter code (codelets)
112 
113   static bool       _notice_safepoints;                         // true if safepoints are activated
114 
115   static address    _native_entry_begin;                        // Region for native entry code
116   static address    _native_entry_end;
117 
118   // method entry points
119   static address    _entry_table[number_of_method_entries];     // entry points for a given method
120   static address    _native_abi_to_tosca[number_of_result_handlers];  // for native method result handlers
121   static address    _slow_signature_handler;                              // the native method generic (slow) signature handler
122 
123   static address    _rethrow_exception_entry;                   // rethrows an activation in previous frame
124 
125   friend class      AbstractInterpreterGenerator;
126   friend class      InterpreterMacroAssembler;
127 
128  public:
129   // Initialization/debugging
130   static void       initialize();
131   static StubQueue* code()                                      { return _code; }
132 
133 
134   // Method activation
135   static MethodKind method_kind(const methodHandle& m);
136   static address    entry_for_kind(MethodKind k)                { assert(0 <= k && k < number_of_method_entries, "illegal kind"); return _entry_table[k]; }
137   static address    entry_for_method(const methodHandle& m)     { return entry_for_kind(method_kind(m)); }
138 
139   // used for bootstrapping method handles:
140   static void       set_entry_for_kind(MethodKind k, address e);
141 
142   static void       print_method_kind(MethodKind kind)          PRODUCT_RETURN;
143 
144   // These should never be compiled since the interpreter will prefer
145   // the compiled version to the intrinsic version.
146   static bool       can_be_compiled(const methodHandle& m) {
147     switch (m->intrinsic_id()) {
148       case vmIntrinsics::_dsin  : // fall thru
149       case vmIntrinsics::_dcos  : // fall thru
150       case vmIntrinsics::_dtan  : // fall thru
151       case vmIntrinsics::_dabs  : // fall thru
152       case vmIntrinsics::_dsqrt : // fall thru
153       case vmIntrinsics::_dsqrt_strict : // fall thru
154       case vmIntrinsics::_dlog  : // fall thru
155       case vmIntrinsics::_dlog10: // fall thru
156       case vmIntrinsics::_dpow  : // fall thru
157       case vmIntrinsics::_dexp  : // fall thru
158       case vmIntrinsics::_fmaD  : // fall thru
159       case vmIntrinsics::_fmaF  : // fall thru
160       case vmIntrinsics::_Continuation_doYield : // fall thru
161         return false;
162 
163       default:
164         return true;
165     }
166   }
167 
168   // Runtime support
169 
170   // length = invoke bytecode length (to advance to next bytecode)
171   static address deopt_entry(TosState state, int length) { ShouldNotReachHere(); return NULL; }
172   static address return_entry(TosState state, int length, Bytecodes::Code code) { ShouldNotReachHere(); return NULL; }
173 
174   static address    rethrow_exception_entry()                   { return _rethrow_exception_entry; }
175 
176   // Activation size in words for a method that is just being called.
177   // Parameters haven't been pushed so count them too.
178   static int        size_top_interpreter_activation(Method* method);
179 
180   // Deoptimization support
181   // Compute the entry address for continuation after
182   static address deopt_continue_after_entry(Method* method,
183                                             address bcp,
184                                             int callee_parameters,
185                                             bool is_top_frame);
186   // Compute the entry address for reexecution
187   static address deopt_reexecute_entry(Method* method, address bcp);
188   // Deoptimization should reexecute this bytecode
189   static bool    bytecode_should_reexecute(Bytecodes::Code code);
190 
191   // deoptimization support
192   static int        size_activation(int max_stack,
193                                     int temps,
194                                     int extra_args,
195                                     int monitors,
196                                     int callee_params,
197                                     int callee_locals,
198                                     bool is_top_frame);
199 
200   static void      layout_activation(Method* method,
201                                      int temps,
202                                      int popframe_args,
203                                      int monitors,
204                                      int caller_actual_parameters,
205                                      int callee_params,
206                                      int callee_locals,
207                                      frame* caller,
208                                      frame* interpreter_frame,
209                                      bool is_top_frame,
210                                      bool is_bottom_frame);
211 
212   // Runtime support
213   static bool       is_not_reached(const methodHandle& method, int bci);
214   // Safepoint support
215   static void       notice_safepoints()                         { ShouldNotReachHere(); } // stops the thread when reaching a safepoint
216   static void       ignore_safepoints()                         { ShouldNotReachHere(); } // ignores safepoints
217 
218   // Support for native calls
219   static address    slow_signature_handler()                    { return _slow_signature_handler; }
220   static address    result_handler(BasicType type)              { return _native_abi_to_tosca[BasicType_as_index(type)]; }
221   static int        BasicType_as_index(BasicType type);         // computes index into result_handler_by_index table
222   static bool       in_native_entry(address pc)                 { return _native_entry_begin <= pc && pc < _native_entry_end; }
223   // Debugging/printing
224   static void       print();                                    // prints the interpreter code
225 
226  public:
227   // Interpreter helpers
228   const static int stackElementWords   = 1;
229   const static int stackElementSize    = stackElementWords * wordSize;
230   const static int logStackElementSize = LogBytesPerWord;
231 
232   static int expr_index_at(int i) {
233     return stackElementWords * i;
234   }
235 
236   static int expr_offset_in_bytes(int i) {
237 #if !defined(ZERO) && (defined(PPC) || defined(S390))
238     return stackElementSize * i + wordSize;  // both point to one word past TOS
239 #else
240     return stackElementSize * i;
241 #endif
242   }
243 
244   static int local_index_at(int i) {
245     assert(i <= 0, "local direction already negated");
246     return stackElementWords * i;
247   }
248 
249 #if !defined(ZERO) && (defined(IA32) || defined(AMD64))
250   static Address::ScaleFactor stackElementScale() {
251     return NOT_LP64(Address::times_4) LP64_ONLY(Address::times_8);
252   }
253 #endif
254 
255   // Local values relative to locals[n]
256   static int  local_offset_in_bytes(int n) {
257     return ((frame::interpreter_frame_expression_stack_direction() * n) * stackElementSize);
258   }
259 
260   // access to stacked values according to type:
261   static oop* oop_addr_in_slot(intptr_t* slot_addr) {
262     return (oop*) slot_addr;
263   }
264   static jint* int_addr_in_slot(intptr_t* slot_addr) {
265     if ((int) sizeof(jint) < wordSize && !Endian::is_Java_byte_ordering_different())
266       // big-endian LP64
267       return (jint*)(slot_addr + 1) - 1;
268     else
269       return (jint*) slot_addr;
270   }
271   static jlong long_in_slot(intptr_t* slot_addr) {
272     if (sizeof(intptr_t) >= sizeof(jlong)) {
273       return *(jlong*) slot_addr;
274     } else {
275       return Bytes::get_native_u8((address)slot_addr);
276     }
277   }
278   static void set_long_in_slot(intptr_t* slot_addr, jlong value) {
279     if (sizeof(intptr_t) >= sizeof(jlong)) {
280       *(jlong*) slot_addr = value;
281     } else {
282       Bytes::put_native_u8((address)slot_addr, value);
283     }
284   }
285 
286   static void initialize_method_handle_entries();
287 };
288 
289 //------------------------------------------------------------------------------------------------------------------------
290 // The interpreter generator.
291 
292 class Template;
293 class AbstractInterpreterGenerator: public StackObj {
294  protected:
295   InterpreterMacroAssembler* _masm;
296 
297  public:
298   AbstractInterpreterGenerator(StubQueue* _code);
299 };
300 
301 #endif // SHARE_INTERPRETER_ABSTRACTINTERPRETER_HPP
--- EOF ---