1 /*
   2  * Copyright (c) 1997, 2019, 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 // The InterpreterRuntime is called by the interpreter for everything
  37 // that cannot/should not be dealt with in assembly and needs C support.
  38 
  39 class InterpreterRuntime: AllStatic {
  40   friend class BytecodeClosure; // for method and bcp
  41   friend class PrintingClosure; // for method and bcp
  42 
  43  private:
  44 
  45   static void      set_bcp_and_mdp(address bcp, JavaThread*thread);
  46   static void      note_trap_inner(JavaThread* thread, int reason,
  47                                    const methodHandle& trap_method, int trap_bci, TRAPS);
  48   static void      note_trap(JavaThread *thread, int reason, TRAPS);
  49 #ifdef CC_INTERP
  50   // Profile traps in C++ interpreter.
  51   static void      note_trap(JavaThread* thread, int reason, Method *method, int trap_bci);
  52 #endif // CC_INTERP
  53 
  54   // Inner work method for Interpreter's frequency counter overflow.
  55   static nmethod* frequency_counter_overflow_inner(JavaThread* thread, address branch_bcp);
  56 
  57  public:
  58   // Constants
  59   static void    ldc           (JavaThread* thread, bool wide);
  60   static void    resolve_ldc   (JavaThread* thread, Bytecodes::Code bytecode);
  61 
  62   // Allocation
  63   static void    _new          (JavaThread* thread, ConstantPool* pool, int index);
  64   static void    newarray      (JavaThread* thread, BasicType type, jint size);
  65   static void    anewarray     (JavaThread* thread, ConstantPool* pool, int index, jint size);
  66   static void    multianewarray(JavaThread* thread, jint* first_size_address);
  67   static void    register_finalizer(JavaThread* thread, oopDesc* obj);
  68   static void    defaultvalue  (JavaThread* thread, ConstantPool* pool, int index);
  69   static int     withfield     (JavaThread* thread, ConstantPoolCache* cp_cache);
  70   static void    uninitialized_static_value_field(JavaThread* thread, oopDesc* mirror, int offset);
  71   static void    uninitialized_instance_value_field(JavaThread* thread, oopDesc* obj, int offset);
  72   static void    write_heap_copy (JavaThread* thread, oopDesc* value, int offset, oopDesc* rcv);

  73   static void    read_flattened_field(JavaThread* thread, oopDesc* value, int index, Klass* field_holder);
  74 
  75   static void value_array_load(JavaThread* thread, arrayOopDesc* array, int index);
  76   static void value_array_store(JavaThread* thread, void* val, arrayOopDesc* array, int index);
  77 
  78   static jboolean is_substitutable(JavaThread* thread, oopDesc* aobj, oopDesc* bobj);
  79 
  80   // Quicken instance-of and check-cast bytecodes
  81   static void    quicken_io_cc(JavaThread* thread);
  82 
  83   // Exceptions thrown by the interpreter
  84   static void    throw_AbstractMethodError(JavaThread* thread);
  85   static void    throw_AbstractMethodErrorWithMethod(JavaThread* thread, Method* oop);
  86   static void    throw_AbstractMethodErrorVerbose(JavaThread* thread,
  87                                                   Klass* recvKlass,
  88                                                   Method* missingMethod);
  89 
  90   static void    throw_IncompatibleClassChangeError(JavaThread* thread);
  91   static void    throw_IncompatibleClassChangeErrorVerbose(JavaThread* thread,
  92                                                            Klass* resc,
  93                                                            Klass* interfaceKlass);
  94   static void    throw_StackOverflowError(JavaThread* thread);
  95   static void    throw_delayed_StackOverflowError(JavaThread* thread);
  96   static void    throw_ArrayIndexOutOfBoundsException(JavaThread* thread, arrayOopDesc* a, jint index);
  97   static void    throw_ClassCastException(JavaThread* thread, oopDesc* obj);
  98   static void    create_exception(JavaThread* thread, char* name, char* message);
  99   static void    create_klass_exception(JavaThread* thread, char* name, oopDesc* obj);
 100   static address exception_handler_for_exception(JavaThread* thread, oopDesc* exception);
 101 #if INCLUDE_JVMTI
 102   static void    member_name_arg_or_null(JavaThread* thread, address dmh, Method* m, address bcp);
 103 #endif
 104   static void    throw_pending_exception(JavaThread* thread);
 105 
 106 #ifdef CC_INTERP
 107   // Profile traps in C++ interpreter.
 108   static void    note_nullCheck_trap (JavaThread* thread, Method *method, int trap_bci);
 109   static void    note_div0Check_trap (JavaThread* thread, Method *method, int trap_bci);
 110   static void    note_rangeCheck_trap(JavaThread* thread, Method *method, int trap_bci);
 111   static void    note_classCheck_trap(JavaThread* thread, Method *method, int trap_bci);
 112   static void    note_arrayCheck_trap(JavaThread* thread, Method *method, int trap_bci);
 113   // A dummy for macros that shall not profile traps.
 114   static void    note_no_trap(JavaThread* thread, Method *method, int trap_bci) {}
 115 #endif // CC_INTERP
 116 
 117   static void resolve_from_cache(JavaThread* thread, Bytecodes::Code bytecode);
 118  private:
 119   // Statics & fields
 120   static void resolve_get_put(JavaThread* thread, Bytecodes::Code bytecode);
 121 
 122   // Calls
 123   static void resolve_invoke(JavaThread* thread, Bytecodes::Code bytecode);
 124   static void resolve_invokehandle (JavaThread* thread);
 125   static void resolve_invokedynamic(JavaThread* thread);
 126 
 127  public:
 128   // Synchronization
 129   static void    monitorenter(JavaThread* thread, BasicObjectLock* elem);
 130   static void    monitorexit (JavaThread* thread, BasicObjectLock* elem);
 131 
 132   static void    throw_illegal_monitor_state_exception(JavaThread* thread);
 133   static void    new_illegal_monitor_state_exception(JavaThread* thread);
 134 
 135   // Breakpoints
 136   static void _breakpoint(JavaThread* thread, Method* method, address bcp);
 137   static Bytecodes::Code get_original_bytecode_at(JavaThread* thread, Method* method, address bcp);
 138   static void            set_original_bytecode_at(JavaThread* thread, Method* method, address bcp, Bytecodes::Code new_code);
 139 
 140   // Safepoints
 141   static void    at_safepoint(JavaThread* thread);
 142 
 143   // Debugger support
 144   static void post_field_access(JavaThread *thread, oopDesc* obj,
 145     ConstantPoolCacheEntry *cp_entry);
 146   static void post_field_modification(JavaThread *thread, oopDesc* obj,
 147     ConstantPoolCacheEntry *cp_entry, jvalue *value);
 148   static void post_method_entry(JavaThread *thread);
 149   static void post_method_exit (JavaThread *thread);
 150   static int  interpreter_contains(address pc);
 151 
 152   // Native signature handlers
 153   static void prepare_native_call(JavaThread* thread, Method* method);
 154   static address slow_signature_handler(JavaThread* thread,
 155                                         Method* method,
 156                                         intptr_t* from, intptr_t* to);
 157 
 158 #if defined(IA32) || defined(AMD64) || defined(ARM)
 159   // Popframe support (only needed on x86, AMD64 and ARM)
 160   static void popframe_move_outgoing_args(JavaThread* thread, void* src_address, void* dest_address);
 161 #endif
 162 
 163   // bytecode tracing is only used by the TraceBytecodes
 164   static intptr_t trace_bytecode(JavaThread* thread, intptr_t preserve_this_value, intptr_t tos, intptr_t tos2) PRODUCT_RETURN0;
 165 
 166   // Platform dependent stuff
 167 #include CPU_HEADER(interpreterRT)
 168 
 169   // optional normalization of fingerprints to reduce the number of adapters
 170   static uint64_t normalize_fast_native_fingerprint(uint64_t fingerprint);
 171 
 172   // Interpreter's frequency counter overflow
 173   static nmethod* frequency_counter_overflow(JavaThread* thread, address branch_bcp);
 174 
 175   // Interpreter profiling support
 176   static jint    bcp_to_di(Method* method, address cur_bcp);
 177   static void    profile_method(JavaThread* thread);
 178   static void    update_mdp_for_ret(JavaThread* thread, int bci);
 179 #ifdef ASSERT
 180   static void    verify_mdp(Method* method, address bcp, address mdp);
 181 #endif // ASSERT
 182   static MethodCounters* build_method_counters(JavaThread* thread, Method* m);
 183 };
 184 
 185 
 186 class SignatureHandlerLibrary: public AllStatic {
 187  public:
 188   enum { buffer_size =  1*K }; // the size of the temporary code buffer
 189   enum { blob_size   = 32*K }; // the size of a handler code blob.
 190 
 191  private:
 192   static BufferBlob*              _handler_blob; // the current buffer blob containing the generated handlers
 193   static address                  _handler;      // next available address within _handler_blob;
 194   static GrowableArray<uint64_t>* _fingerprints; // the fingerprint collection
 195   static GrowableArray<address>*  _handlers;     // the corresponding handlers
 196   static address                  _buffer;       // the temporary code buffer
 197 
 198   static address set_handler_blob();
 199   static void initialize();
 200   static address set_handler(CodeBuffer* buffer);
 201   static void pd_set_handler(address handler);
 202 
 203  public:
 204   static void add(const methodHandle& method);
 205   static void add(uint64_t fingerprint, address handler);
 206 };
 207 
 208 #endif // SHARE_INTERPRETER_INTERPRETERRUNTIME_HPP
--- EOF ---