abstractInterpreter.hpp revision 1879:f95d63e2154a
1/*
2 * Copyright (c) 1997, 2010, 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_OS_FAMILY_linux
45# include "thread_linux.inline.hpp"
46#endif
47#ifdef TARGET_OS_FAMILY_solaris
48# include "thread_solaris.inline.hpp"
49#endif
50#ifdef TARGET_OS_FAMILY_windows
51# include "thread_windows.inline.hpp"
52#endif
53
54// This file contains the platform-independent parts
55// of the abstract interpreter and the abstract interpreter generator.
56
57// Organization of the interpreter(s). There exists two different interpreters in hotpot
58// an assembly language version (aka template interpreter) and a high level language version
59// (aka c++ interpreter). Th division of labor is as follows:
60
61// Template Interpreter          C++ Interpreter        Functionality
62//
63// templateTable*                bytecodeInterpreter*   actual interpretation of bytecodes
64//
65// templateInterpreter*          cppInterpreter*        generation of assembly code that creates
66//                                                      and manages interpreter runtime frames.
67//                                                      Also code for populating interpreter
68//                                                      frames created during deoptimization.
69//
70// For both template and c++ interpreter. There are common files for aspects of the interpreter
71// that are generic to both interpreters. This is the layout:
72//
73// abstractInterpreter.hpp: generic description of the interpreter.
74// interpreter*:            generic frame creation and handling.
75//
76
77//------------------------------------------------------------------------------------------------------------------------
78// The C++ interface to the bytecode interpreter(s).
79
80class AbstractInterpreter: AllStatic {
81  friend class VMStructs;
82  friend class Interpreter;
83  friend class CppInterpreterGenerator;
84 public:
85  enum MethodKind {
86    zerolocals,                                                 // method needs locals initialization
87    zerolocals_synchronized,                                    // method needs locals initialization & is synchronized
88    native,                                                     // native method
89    native_synchronized,                                        // native method & is synchronized
90    empty,                                                      // empty method (code: _return)
91    accessor,                                                   // accessor method (code: _aload_0, _getfield, _(a|i)return)
92    abstract,                                                   // abstract method (throws an AbstractMethodException)
93    method_handle,                                              // java.dyn.MethodHandles::invoke
94    java_lang_math_sin,                                         // implementation of java.lang.Math.sin   (x)
95    java_lang_math_cos,                                         // implementation of java.lang.Math.cos   (x)
96    java_lang_math_tan,                                         // implementation of java.lang.Math.tan   (x)
97    java_lang_math_abs,                                         // implementation of java.lang.Math.abs   (x)
98    java_lang_math_sqrt,                                        // implementation of java.lang.Math.sqrt  (x)
99    java_lang_math_log,                                         // implementation of java.lang.Math.log   (x)
100    java_lang_math_log10,                                       // implementation of java.lang.Math.log10 (x)
101    number_of_method_entries,
102    invalid = -1
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              InterpreterGenerator;
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(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(methodHandle m)            { return _entry_table[method_kind(m)]; }
138
139  static void       print_method_kind(MethodKind kind)          PRODUCT_RETURN;
140
141  static bool       can_be_compiled(methodHandle m);
142
143  // Runtime support
144
145  // length = invoke bytecode length (to advance to next bytecode)
146  static address    deopt_entry   (TosState state, int length) { ShouldNotReachHere(); return NULL; }
147  static address    return_entry  (TosState state, int length) { ShouldNotReachHere(); return NULL; }
148
149  static address    rethrow_exception_entry()                   { return _rethrow_exception_entry; }
150
151  // Activation size in words for a method that is just being called.
152  // Parameters haven't been pushed so count them too.
153  static int        size_top_interpreter_activation(methodOop method);
154
155  // Deoptimization support
156  // Compute the entry address for continuation after
157  static address deopt_continue_after_entry(methodOop method,
158                                            address bcp,
159                                            int callee_parameters,
160                                            bool is_top_frame);
161  // Compute the entry address for reexecution
162  static address deopt_reexecute_entry(methodOop method, address bcp);
163  // Deoptimization should reexecute this bytecode
164  static bool    bytecode_should_reexecute(Bytecodes::Code code);
165
166  // share implementation of size_activation and layout_activation:
167  static int        size_activation(methodOop method,
168                                    int temps,
169                                    int popframe_args,
170                                    int monitors,
171                                    int callee_params,
172                                    int callee_locals,
173                                    bool is_top_frame);
174
175  static int       layout_activation(methodOop method,
176                                      int temps,
177                                      int popframe_args,
178                                      int monitors,
179                                      int callee_params,
180                                      int callee_locals,
181                                      frame* caller,
182                                      frame* interpreter_frame,
183                                      bool is_top_frame);
184
185  // Runtime support
186  static bool       is_not_reached(                       methodHandle method, int bci);
187  // Safepoint support
188  static void       notice_safepoints()                         { ShouldNotReachHere(); } // stops the thread when reaching a safepoint
189  static void       ignore_safepoints()                         { ShouldNotReachHere(); } // ignores safepoints
190
191  // Support for native calls
192  static address    slow_signature_handler()                    { return _slow_signature_handler; }
193  static address    result_handler(BasicType type)              { return _native_abi_to_tosca[BasicType_as_index(type)]; }
194  static int        BasicType_as_index(BasicType type);         // computes index into result_handler_by_index table
195  static bool       in_native_entry(address pc)                 { return _native_entry_begin <= pc && pc < _native_entry_end; }
196  // Debugging/printing
197  static void       print();                                    // prints the interpreter code
198
199 public:
200  // Interpreter helpers
201  const static int stackElementWords   = 1;
202  const static int stackElementSize    = stackElementWords * wordSize;
203  const static int logStackElementSize = LogBytesPerWord;
204
205  // Local values relative to locals[n]
206  static int  local_offset_in_bytes(int n) {
207    return ((frame::interpreter_frame_expression_stack_direction() * n) * stackElementSize);
208  }
209
210  // access to stacked values according to type:
211  static oop* oop_addr_in_slot(intptr_t* slot_addr) {
212    return (oop*) slot_addr;
213  }
214  static jint* int_addr_in_slot(intptr_t* slot_addr) {
215    if ((int) sizeof(jint) < wordSize && !Bytes::is_Java_byte_ordering_different())
216      // big-endian LP64
217      return (jint*)(slot_addr + 1) - 1;
218    else
219      return (jint*) slot_addr;
220  }
221  static jlong long_in_slot(intptr_t* slot_addr) {
222    if (sizeof(intptr_t) >= sizeof(jlong)) {
223      return *(jlong*) slot_addr;
224    } else {
225      return Bytes::get_native_u8((address)slot_addr);
226    }
227  }
228  static void set_long_in_slot(intptr_t* slot_addr, jlong value) {
229    if (sizeof(intptr_t) >= sizeof(jlong)) {
230      *(jlong*) slot_addr = value;
231    } else {
232      Bytes::put_native_u8((address)slot_addr, value);
233    }
234  }
235  static void get_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
236    switch (type) {
237    case T_BOOLEAN: value->z = *int_addr_in_slot(slot_addr);            break;
238    case T_CHAR:    value->c = *int_addr_in_slot(slot_addr);            break;
239    case T_BYTE:    value->b = *int_addr_in_slot(slot_addr);            break;
240    case T_SHORT:   value->s = *int_addr_in_slot(slot_addr);            break;
241    case T_INT:     value->i = *int_addr_in_slot(slot_addr);            break;
242    case T_LONG:    value->j = long_in_slot(slot_addr);                 break;
243    case T_FLOAT:   value->f = *(jfloat*)int_addr_in_slot(slot_addr);   break;
244    case T_DOUBLE:  value->d = jdouble_cast(long_in_slot(slot_addr));   break;
245    case T_OBJECT:  value->l = (jobject)*oop_addr_in_slot(slot_addr);   break;
246    default:        ShouldNotReachHere();
247    }
248  }
249  static void set_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
250    switch (type) {
251    case T_BOOLEAN: *int_addr_in_slot(slot_addr) = (value->z != 0);     break;
252    case T_CHAR:    *int_addr_in_slot(slot_addr) = value->c;            break;
253    case T_BYTE:    *int_addr_in_slot(slot_addr) = value->b;            break;
254    case T_SHORT:   *int_addr_in_slot(slot_addr) = value->s;            break;
255    case T_INT:     *int_addr_in_slot(slot_addr) = value->i;            break;
256    case T_LONG:    set_long_in_slot(slot_addr, value->j);              break;
257    case T_FLOAT:   *(jfloat*)int_addr_in_slot(slot_addr) = value->f;   break;
258    case T_DOUBLE:  set_long_in_slot(slot_addr, jlong_cast(value->d));  break;
259    case T_OBJECT:  *oop_addr_in_slot(slot_addr) = (oop) value->l;      break;
260    default:        ShouldNotReachHere();
261    }
262  }
263};
264
265//------------------------------------------------------------------------------------------------------------------------
266// The interpreter generator.
267
268class Template;
269class AbstractInterpreterGenerator: public StackObj {
270 protected:
271  InterpreterMacroAssembler* _masm;
272
273  // shared code sequences
274  // Converter for native abi result to tosca result
275  address generate_result_handler_for(BasicType type);
276  address generate_slow_signature_handler();
277
278  // entry point generator
279  address generate_method_entry(AbstractInterpreter::MethodKind kind);
280
281  void bang_stack_shadow_pages(bool native_call);
282
283  void generate_all();
284
285 public:
286  AbstractInterpreterGenerator(StubQueue* _code);
287};
288
289#endif // SHARE_VM_INTERPRETER_ABSTRACTINTERPRETER_HPP
290