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