1 /*
  2  * Copyright (c) 1997, 2020, 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_TEMPLATEINTERPRETER_HPP
 26 #define SHARE_INTERPRETER_TEMPLATEINTERPRETER_HPP
 27 
 28 #include "interpreter/abstractInterpreter.hpp"
 29 #include "interpreter/templateTable.hpp"
 30 
 31 // This file contains the platform-independent parts
 32 // of the template interpreter and the template interpreter generator.
 33 
 34 #ifndef ZERO
 35 
 36 class InterpreterMacroAssembler;
 37 class InterpreterCodelet;
 38 
 39 //------------------------------------------------------------------------------------------------------------------------
 40 // A little wrapper class to group tosca-specific entry points into a unit.
 41 // (tosca = Top-Of-Stack CAche)
 42 
 43 class EntryPoint {
 44  private:
 45   address _entry[number_of_states];
 46 
 47  public:
 48   // Construction
 49   EntryPoint();
 50   EntryPoint(address bentry, address zentry, address centry, address sentry, address aentry, address ientry, address lentry, address fentry, address dentry, address ventry);
 51   // Will use the ientry for each of [bzcs]entry
 52   EntryPoint(address aentry, address ientry, address lentry, address fentry, address dentry, address ventry);
 53   // Attributes
 54   address entry(TosState state) const;                // return target address for a given tosca state
 55   void    set_entry(TosState state, address entry);   // set    target address for a given tosca state
 56   void    print();
 57 
 58   // Comparison
 59   bool operator == (const EntryPoint& y);             // for debugging only
 60 };
 61 
 62 
 63 //------------------------------------------------------------------------------------------------------------------------
 64 // A little wrapper class to group tosca-specific dispatch tables into a unit.
 65 
 66 class DispatchTable {
 67  public:
 68   enum { length = 1 << BitsPerByte };                 // an entry point for each byte value (also for undefined bytecodes)
 69 
 70  private:
 71   address _table[number_of_states][length];           // dispatch tables, indexed by tosca and bytecode
 72 
 73  public:
 74   // Attributes
 75   EntryPoint entry(int i) const;                      // return entry point for a given bytecode i
 76   void       set_entry(int i, EntryPoint& entry);     // set    entry point for a given bytecode i
 77   address*   table_for(TosState state)          { return _table[state]; }
 78   address*   table_for()                        { return table_for((TosState)0); }
 79   int        distance_from(address *table)      { return table - table_for(); }
 80   int        distance_from(TosState state)      { return distance_from(table_for(state)); }
 81 
 82   // Comparison
 83   bool operator == (DispatchTable& y);                // for debugging only
 84 };
 85 
 86 class TemplateInterpreter: public AbstractInterpreter {
 87   friend class VMStructs;
 88   friend class InterpreterMacroAssembler;
 89   friend class TemplateInterpreterGenerator;
 90   friend class TemplateTable;
 91   friend class CodeCacheExtensions;
 92   // friend class Interpreter;
 93  public:
 94 
 95   enum MoreConstants {
 96     max_invoke_length = 5,    // invokedynamic is the longest
 97     max_bytecode_length = 6,  // worse case is wide iinc, "reexecute" bytecodes are excluded because "skip" will be 0
 98     number_of_return_entries  = max_invoke_length + 1,          // number of return entry points
 99     number_of_deopt_entries   = max_bytecode_length + 1,        // number of deoptimization entry points
100     number_of_return_addrs    = number_of_states                // number of return addresses
101   };
102 
103  protected:
104 
105   static address    _throw_ArrayIndexOutOfBoundsException_entry;
106   static address    _throw_ArrayStoreException_entry;
107   static address    _throw_ArithmeticException_entry;
108   static address    _throw_ClassCastException_entry;
109   static address    _throw_NullPointerException_entry;
110   static address    _throw_exception_entry;
111 
112   static address    _throw_StackOverflowError_entry;
113 
114   static address    _remove_activation_entry;                   // continuation address if an exception is not handled by current frame
115   static address    _remove_activation_preserving_args_entry;   // continuation address when current frame is being popped
116 
117 #ifndef PRODUCT
118   static EntryPoint _trace_code;
119 #endif // !PRODUCT
120   static EntryPoint _return_entry[number_of_return_entries];    // entry points to return to from a call
121   static EntryPoint _earlyret_entry;                            // entry point to return early from a call
122   static EntryPoint _deopt_entry[number_of_deopt_entries];      // entry points to return to from a deoptimization
123   static address    _deopt_reexecute_return_entry;
124   static EntryPoint _safept_entry;
125 
126   static address _invoke_return_entry[number_of_return_addrs];           // for invokestatic, invokespecial, invokevirtual return entries
127   static address _invokeinterface_return_entry[number_of_return_addrs];  // for invokeinterface return entries
128   static address _invokedynamic_return_entry[number_of_return_addrs];    // for invokedynamic return entries
129 
130   static DispatchTable _active_table;                           // the active    dispatch table (used by the interpreter for dispatch)
131   static DispatchTable _normal_table;                           // the normal    dispatch table (used to set the active table in normal mode)
132   static DispatchTable _safept_table;                           // the safepoint dispatch table (used to set the active table for safepoints)
133   static address       _wentry_point[DispatchTable::length];    // wide instructions only (vtos tosca always)
134 
135 
136  public:
137   // Initialization/debugging
138   static void       initialize_stub();
139   static void       initialize_code();
140   // this only returns whether a pc is within generated code for the interpreter.
141   static bool       contains(address pc)                        { return _code != NULL && _code->contains(pc); }
142   // Debugging/printing
143   static InterpreterCodelet* codelet_containing(address pc);
144 
145 
146  public:
147 
148   static address    remove_activation_early_entry(TosState state) { return _earlyret_entry.entry(state); }
149   static address    remove_activation_preserving_args_entry()     { return _remove_activation_preserving_args_entry; }
150 
151   static address    remove_activation_entry()                   { return _remove_activation_entry; }
152   static address    throw_exception_entry()                     { return _throw_exception_entry; }
153   static address    throw_ArithmeticException_entry()           { return _throw_ArithmeticException_entry; }
154   static address    throw_NullPointerException_entry()          { return _throw_NullPointerException_entry; }
155   static address    throw_StackOverflowError_entry()            { return _throw_StackOverflowError_entry; }
156 
157   // Code generation
158 #ifndef PRODUCT
159   static address    trace_code    (TosState state)              { return _trace_code.entry(state); }
160 #endif // !PRODUCT
161   static address*   dispatch_table(TosState state)              { return _active_table.table_for(state); }
162   static address*   dispatch_table()                            { return _active_table.table_for(); }
163   static int        distance_from_dispatch_table(TosState state){ return _active_table.distance_from(state); }
164   static address*   normal_table(TosState state)                { return _normal_table.table_for(state); }
165   static address*   normal_table()                              { return _normal_table.table_for(); }
166   static address*   safept_table(TosState state)                { return _safept_table.table_for(state); }
167 
168   // Support for invokes
169   static address*   invoke_return_entry_table()                 { return _invoke_return_entry; }
170   static address*   invokeinterface_return_entry_table()        { return _invokeinterface_return_entry; }
171   static address*   invokedynamic_return_entry_table()          { return _invokedynamic_return_entry; }
172   static int        TosState_as_index(TosState state);
173 
174   static address* invoke_return_entry_table_for(Bytecodes::Code code);
175 
176   static address deopt_entry(TosState state, int length);
177   static address deopt_reexecute_return_entry()                 { return _deopt_reexecute_return_entry; }
178   static address return_entry(TosState state, int length, Bytecodes::Code code);
179 
180   // Safepoint support
181   static void       notice_safepoints();                        // stops the thread when reaching a safepoint
182   static void       ignore_safepoints();                        // ignores safepoints
183 
184   // Deoptimization support
185   // Compute the entry address for continuation after
186   static address deopt_continue_after_entry(Method* method,
187                                             address bcp,
188                                             int callee_parameters,
189                                             bool is_top_frame);
190   // Deoptimization should reexecute this bytecode
191   static bool    bytecode_should_reexecute(Bytecodes::Code code);
192   // Compute the address for reexecution
193   static address deopt_reexecute_entry(Method* method, address bcp);
194 
195   // Size of interpreter code.  Max size with JVMTI
196   static int InterpreterCodeSize;
197 };
198 
199 #endif // !ZERO
200 
201 #endif // SHARE_INTERPRETER_TEMPLATEINTERPRETER_HPP