abstractInterpreter.hpp revision 0:a61af66fc99e
1/*
2 * Copyright 1997-2007 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
20 * CA 95054 USA or visit www.sun.com if you need additional information or
21 * have any questions.
22 *
23 */
24
25// This file contains the platform-independant parts
26// of the abstract interpreter and the abstract interpreter generator.
27
28// Organization of the interpreter(s). There exists two different interpreters in hotpot
29// an assembly language version (aka template interpreter) and a high level language version
30// (aka c++ interpreter). Th division of labor is as follows:
31
32// Template Interpreter          C++ Interpreter        Functionality
33//
34// templateTable*                bytecodeInterpreter*   actual interpretation of bytecodes
35//
36// templateInterpreter*          cppInterpreter*        generation of assembly code that creates
37//                                                      and manages interpreter runtime frames.
38//                                                      Also code for populating interpreter
39//                                                      frames created during deoptimization.
40//
41// For both template and c++ interpreter. There are common files for aspects of the interpreter
42// that are generic to both interpreters. This is the layout:
43//
44// abstractInterpreter.hpp: generic description of the interpreter.
45// interpreter*:            generic frame creation and handling.
46//
47
48//------------------------------------------------------------------------------------------------------------------------
49// The C++ interface to the bytecode interpreter(s).
50
51class AbstractInterpreter: AllStatic {
52  friend class VMStructs;
53  friend class Interpreter;
54  friend class CppInterpreterGenerator;
55 public:
56  enum MethodKind {
57    zerolocals,                                                 // method needs locals initialization
58    zerolocals_synchronized,                                    // method needs locals initialization & is synchronized
59    native,                                                     // native method
60    native_synchronized,                                        // native method & is synchronized
61    empty,                                                      // empty method (code: _return)
62    accessor,                                                   // accessor method (code: _aload_0, _getfield, _(a|i)return)
63    abstract,                                                   // abstract method (throws an AbstractMethodException)
64    java_lang_math_sin,                                         // implementation of java.lang.Math.sin   (x)
65    java_lang_math_cos,                                         // implementation of java.lang.Math.cos   (x)
66    java_lang_math_tan,                                         // implementation of java.lang.Math.tan   (x)
67    java_lang_math_abs,                                         // implementation of java.lang.Math.abs   (x)
68    java_lang_math_sqrt,                                        // implementation of java.lang.Math.sqrt  (x)
69    java_lang_math_log,                                         // implementation of java.lang.Math.log   (x)
70    java_lang_math_log10,                                       // implementation of java.lang.Math.log10 (x)
71    number_of_method_entries,
72    invalid = -1
73  };
74
75  enum SomeConstants {
76    number_of_result_handlers = 10                              // number of result handlers for native calls
77  };
78
79 protected:
80  static StubQueue* _code;                                      // the interpreter code (codelets)
81
82  static bool       _notice_safepoints;                         // true if safepoints are activated
83
84  static address    _native_entry_begin;                        // Region for native entry code
85  static address    _native_entry_end;
86
87  // method entry points
88  static address    _entry_table[number_of_method_entries];     // entry points for a given method
89  static address    _native_abi_to_tosca[number_of_result_handlers];  // for native method result handlers
90  static address    _slow_signature_handler;                              // the native method generic (slow) signature handler
91
92  static address    _rethrow_exception_entry;                   // rethrows an activation in previous frame
93
94
95
96  friend class      AbstractInterpreterGenerator;
97  friend class              InterpreterGenerator;
98  friend class      InterpreterMacroAssembler;
99
100 public:
101  // Initialization/debugging
102  static void       initialize();
103  static StubQueue* code()                                      { return _code; }
104
105
106  // Method activation
107  static MethodKind method_kind(methodHandle m);
108  static address    entry_for_kind(MethodKind k)                { assert(0 <= k && k < number_of_method_entries, "illegal kind"); return _entry_table[k]; }
109  static address    entry_for_method(methodHandle m)            { return _entry_table[method_kind(m)]; }
110
111  static void       print_method_kind(MethodKind kind)          PRODUCT_RETURN;
112
113  // Runtime support
114
115  // length = invoke bytecode length (to advance to next bytecode)
116  static address    deopt_entry   (TosState state, int length) { ShouldNotReachHere(); return NULL; }
117  static address    return_entry  (TosState state, int length) { ShouldNotReachHere(); return NULL; }
118
119  static address    rethrow_exception_entry()                   { return _rethrow_exception_entry; }
120
121  // Activation size in words for a method that is just being called.
122  // Parameters haven't been pushed so count them too.
123  static int        size_top_interpreter_activation(methodOop method);
124
125  // Deoptimization support
126  static address    continuation_for(methodOop method,
127                                     address bcp,
128                                     int callee_parameters,
129                                     bool is_top_frame,
130                                     bool& use_next_mdp);
131
132  // share implementation of size_activation and layout_activation:
133  static int        size_activation(methodOop method,
134                                    int temps,
135                                    int popframe_args,
136                                    int monitors,
137                                    int callee_params,
138                                    int callee_locals,
139                                    bool is_top_frame);
140
141  static int       layout_activation(methodOop method,
142                                      int temps,
143                                      int popframe_args,
144                                      int monitors,
145                                      int callee_params,
146                                      int callee_locals,
147                                      frame* caller,
148                                      frame* interpreter_frame,
149                                      bool is_top_frame);
150
151  // Runtime support
152  static bool       is_not_reached(                       methodHandle method, int bci);
153  // Safepoint support
154  static void       notice_safepoints()                         { ShouldNotReachHere(); } // stops the thread when reaching a safepoint
155  static void       ignore_safepoints()                         { ShouldNotReachHere(); } // ignores safepoints
156
157  // Support for native calls
158  static address    slow_signature_handler()                    { return _slow_signature_handler; }
159  static address    result_handler(BasicType type)              { return _native_abi_to_tosca[BasicType_as_index(type)]; }
160  static int        BasicType_as_index(BasicType type);         // computes index into result_handler_by_index table
161  static bool       in_native_entry(address pc)                 { return _native_entry_begin <= pc && pc < _native_entry_end; }
162  // Debugging/printing
163  static void       print();                                    // prints the interpreter code
164
165  // Support for Tagged Stacks
166  //
167  // Tags are stored on the Java Expression stack above the value:
168  //
169  //  tag
170  //  value
171  //
172  // For double values:
173  //
174  //  tag2
175  //  high word
176  //  tag1
177  //  low word
178
179 public:
180  static int stackElementWords()   { return TaggedStackInterpreter ? 2 : 1; }
181  static int stackElementSize()    { return stackElementWords()*wordSize; }
182  static int logStackElementSize() { return
183                 TaggedStackInterpreter? LogBytesPerWord+1 : LogBytesPerWord; }
184
185  // Tag is at pointer, value is one below for a stack growing down
186  // (or above for stack growing up)
187  static int  value_offset_in_bytes()  {
188    return TaggedStackInterpreter ?
189      frame::interpreter_frame_expression_stack_direction() * wordSize : 0;
190  }
191  static int  tag_offset_in_bytes()    {
192    assert(TaggedStackInterpreter, "should not call this");
193    return 0;
194  }
195
196  // Tagged Locals
197  // Locals are stored relative to Llocals:
198  //
199  // tag    <- Llocals[n]
200  // value
201  //
202  // Category 2 types are indexed as:
203  //
204  // tag    <- Llocals[-n]
205  // high word
206  // tag    <- Llocals[-n+1]
207  // low word
208  //
209
210  // Local values relative to locals[n]
211  static int  local_offset_in_bytes(int n) {
212    return ((frame::interpreter_frame_expression_stack_direction() * n) *
213            stackElementSize()) + value_offset_in_bytes();
214  }
215  static int  local_tag_offset_in_bytes(int n) {
216    assert(TaggedStackInterpreter, "should not call this");
217    return ((frame::interpreter_frame_expression_stack_direction() * n) *
218            stackElementSize()) + tag_offset_in_bytes();
219  }
220
221};
222
223//------------------------------------------------------------------------------------------------------------------------
224// The interpreter generator.
225
226class Template;
227class AbstractInterpreterGenerator: public StackObj {
228 protected:
229  InterpreterMacroAssembler* _masm;
230
231  // shared code sequences
232  // Converter for native abi result to tosca result
233  address generate_result_handler_for(BasicType type);
234  address generate_slow_signature_handler();
235
236  // entry point generator
237  address generate_method_entry(AbstractInterpreter::MethodKind kind);
238
239  void bang_stack_shadow_pages(bool native_call);
240
241  void generate_all();
242
243 public:
244  AbstractInterpreterGenerator(StubQueue* _code);
245};
246