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