1 /*
  2  * Copyright (c) 1997, 2021, 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_INTERPRETERRUNTIME_HPP
 26 #define SHARE_INTERPRETER_INTERPRETERRUNTIME_HPP
 27 
 28 #include "interpreter/bytecode.hpp"
 29 #include "interpreter/linkResolver.hpp"
 30 #include "oops/method.hpp"
 31 #include "runtime/frame.hpp"
 32 #include "runtime/signature.hpp"
 33 #include "runtime/thread.hpp"
 34 #include "utilities/macros.hpp"
 35 
 36 class BufferBlob;
 37 class CodeBuffer;
 38 
 39 // The InterpreterRuntime is called by the interpreter for everything
 40 // that cannot/should not be dealt with in assembly and needs C support.
 41 
 42 class InterpreterRuntime: AllStatic {
 43   friend class BytecodeClosure; // for method and bcp
 44   friend class PrintingClosure; // for method and bcp
 45 
 46  private:
 47 
 48   static void      set_bcp_and_mdp(address bcp, JavaThread* current);
 49   static void      note_trap_inner(JavaThread* current, int reason,
 50                                    const methodHandle& trap_method, int trap_bci);
 51   static void      note_trap(JavaThread* current, int reason);
 52 
 53   // Inner work method for Interpreter's frequency counter overflow.
 54   static nmethod* frequency_counter_overflow_inner(JavaThread* current, address branch_bcp);
 55 
 56  public:
 57   // Constants
 58   static void    ldc           (JavaThread* current, bool wide);
 59   static void    resolve_ldc   (JavaThread* current, Bytecodes::Code bytecode);
 60 
 61   // Allocation
 62   static void    _new          (JavaThread* current, ConstantPool* pool, int index);
 63   static void    newarray      (JavaThread* current, BasicType type, jint size);
 64   static void    anewarray     (JavaThread* threcurrentad, ConstantPool* pool, int index, jint size);
 65   static void    multianewarray(JavaThread* current, jint* first_size_address);
 66   static void    register_finalizer(JavaThread* current, oopDesc* obj);
 67   static void    defaultvalue  (JavaThread* current, ConstantPool* pool, int index);
 68   static int     withfield     (JavaThread* current, ConstantPoolCacheEntry* cpe, uintptr_t ptr);
 69   static void    uninitialized_static_inline_type_field(JavaThread* current, oopDesc* mirror, int offset);
 70   static void    write_heap_copy (JavaThread* current, oopDesc* value, int offset, oopDesc* rcv);
 71   static void    read_inlined_field(JavaThread* current, oopDesc* value, int index, Klass* field_holder);
 72 
 73   static void value_array_load(JavaThread* current, arrayOopDesc* array, int index);
 74   static void value_array_store(JavaThread* current, void* val, arrayOopDesc* array, int index);
 75 
 76   static jboolean is_substitutable(JavaThread* current, oopDesc* aobj, oopDesc* bobj);
 77 
 78   // Quicken instance-of and check-cast bytecodes
 79   static void    quicken_io_cc(JavaThread* current);
 80 
 81   // Exceptions thrown by the interpreter
 82   static void    throw_AbstractMethodError(JavaThread* current);
 83   static void    throw_AbstractMethodErrorWithMethod(JavaThread* current, Method* oop);
 84   static void    throw_AbstractMethodErrorVerbose(JavaThread* current,
 85                                                   Klass* recvKlass,
 86                                                   Method* missingMethod);
 87 
 88   static void    throw_InstantiationError(JavaThread* current);
 89   static void    throw_IncompatibleClassChangeError(JavaThread* current);
 90   static void    throw_IncompatibleClassChangeErrorVerbose(JavaThread* current,
 91                                                            Klass* resc,
 92                                                            Klass* interfaceKlass);
 93   static void    throw_StackOverflowError(JavaThread* current);
 94   static void    throw_delayed_StackOverflowError(JavaThread* current);
 95   static void    throw_ArrayIndexOutOfBoundsException(JavaThread* current, arrayOopDesc* a, jint index);
 96   static void    throw_ClassCastException(JavaThread* current, oopDesc* obj);
 97   static void    throw_NullPointerException(JavaThread* current);
 98 
 99   static void    create_exception(JavaThread* current, char* name, char* message);
100   static void    create_klass_exception(JavaThread* current, char* name, oopDesc* obj);
101   static address exception_handler_for_exception(JavaThread* current, oopDesc* exception);
102 #if INCLUDE_JVMTI
103   static void    member_name_arg_or_null(JavaThread* current, address dmh, Method* m, address bcp);
104 #endif
105   static void    throw_pending_exception(JavaThread* current);
106 
107   static void resolve_from_cache(JavaThread* current, Bytecodes::Code bytecode);
108  private:
109   // Statics & fields
110   static void resolve_get_put(JavaThread* current, Bytecodes::Code bytecode);
111 
112   // Calls
113   static void resolve_invoke(JavaThread* current, Bytecodes::Code bytecode);
114   static void resolve_invokehandle (JavaThread* current);
115   static void resolve_invokedynamic(JavaThread* current);
116 
117  public:
118   // Synchronization
119   static void    monitorenter(JavaThread* current, BasicObjectLock* elem);
120   static void    monitorexit (BasicObjectLock* elem);
121 
122   static void    throw_illegal_monitor_state_exception(JavaThread* current);
123   static void    new_illegal_monitor_state_exception(JavaThread* current);
124 
125   // Breakpoints
126   static void _breakpoint(JavaThread* current, Method* method, address bcp);
127   static Bytecodes::Code get_original_bytecode_at(JavaThread* current, Method* method, address bcp);
128   static void            set_original_bytecode_at(JavaThread* current, Method* method, address bcp, Bytecodes::Code new_code);
129 
130   // Safepoints
131   static void    at_safepoint(JavaThread* current);
132   static void    at_unwind(JavaThread* current);
133 
134   // Debugger support
135   static void post_field_access(JavaThread* current, oopDesc* obj,
136     ConstantPoolCacheEntry *cp_entry);
137   static void post_field_modification(JavaThread* current, oopDesc* obj,
138     ConstantPoolCacheEntry *cp_entry, jvalue *value);
139   static void post_method_entry(JavaThread* current);
140   static void post_method_exit (JavaThread* current);
141   static int  interpreter_contains(address pc);
142 
143   // Native signature handlers
144   static void prepare_native_call(JavaThread* current, Method* method);
145   static address slow_signature_handler(JavaThread* current,
146                                         Method* method,
147                                         intptr_t* from, intptr_t* to);
148 
149 #if defined(IA32) || defined(AMD64) || defined(ARM)
150   // Popframe support (only needed on x86, AMD64 and ARM)
151   static void popframe_move_outgoing_args(JavaThread* current, void* src_address, void* dest_address);
152 #endif
153 
154   // bytecode tracing is only used by the TraceBytecodes
155   static intptr_t trace_bytecode(JavaThread* current, intptr_t preserve_this_value, intptr_t tos, intptr_t tos2) PRODUCT_RETURN0;
156 
157   // Platform dependent stuff
158 #include CPU_HEADER(interpreterRT)
159 
160   // optional normalization of fingerprints to reduce the number of adapters
161   static uint64_t normalize_fast_native_fingerprint(uint64_t fingerprint);
162 
163   // Interpreter's frequency counter overflow
164   static nmethod* frequency_counter_overflow(JavaThread* current, address branch_bcp);
165 
166   // Interpreter profiling support
167   static jint    bcp_to_di(Method* method, address cur_bcp);
168   static void    update_mdp_for_ret(JavaThread* current, int bci);
169 #ifdef ASSERT
170   static void    verify_mdp(Method* method, address bcp, address mdp);
171 #endif // ASSERT
172   static MethodCounters* build_method_counters(JavaThread* current, Method* m);
173 };
174 
175 
176 class SignatureHandlerLibrary: public AllStatic {
177  public:
178   enum { buffer_size =  1*K }; // the size of the temporary code buffer
179   enum { blob_size   = 32*K }; // the size of a handler code blob.
180 
181  private:
182   static BufferBlob*              _handler_blob; // the current buffer blob containing the generated handlers
183   static address                  _handler;      // next available address within _handler_blob;
184   static GrowableArray<uint64_t>* _fingerprints; // the fingerprint collection
185   static GrowableArray<address>*  _handlers;     // the corresponding handlers
186   static address                  _buffer;       // the temporary code buffer
187 
188   static address set_handler_blob();
189   static void initialize();
190   static address set_handler(CodeBuffer* buffer);
191   static void pd_set_handler(address handler);
192 
193  public:
194   static void add(const methodHandle& method);
195   static void add(uint64_t fingerprint, address handler);
196 };
197 
198 #endif // SHARE_INTERPRETER_INTERPRETERRUNTIME_HPP