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