1 /*
   2  * Copyright (c) 1997, 2018, 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_VM_INTERPRETER_INTERPRETERRUNTIME_HPP
  26 #define SHARE_VM_INTERPRETER_INTERPRETERRUNTIME_HPP
  27 
  28 #include "interpreter/bytecode.hpp"
  29 #include "interpreter/linkResolver.hpp"
  30 #include "memory/universe.hpp"
  31 #include "oops/method.hpp"
  32 #include "runtime/frame.hpp"
  33 #include "runtime/signature.hpp"
  34 #include "runtime/thread.hpp"
  35 #include "utilities/macros.hpp"
  36 
  37 // The InterpreterRuntime is called by the interpreter for everything
  38 // that cannot/should not be dealt with in assembly and needs C support.
  39 
  40 class InterpreterRuntime: AllStatic {
  41   friend class BytecodeClosure; // for method and bcp
  42   friend class PrintingClosure; // for method and bcp
  43 
  44  private:
  45 
  46   static void      set_bcp_and_mdp(address bcp, JavaThread*thread);
  47   static void      note_trap_inner(JavaThread* thread, int reason,
  48                                    const methodHandle& trap_method, int trap_bci, TRAPS);
  49   static void      note_trap(JavaThread *thread, int reason, TRAPS);
  50 #ifdef CC_INTERP
  51   // Profile traps in C++ interpreter.
  52   static void      note_trap(JavaThread* thread, int reason, Method *method, int trap_bci);
  53 #endif // CC_INTERP
  54 
  55   // Inner work method for Interpreter's frequency counter overflow.
  56   static nmethod* frequency_counter_overflow_inner(JavaThread* thread, address branch_bcp);
  57 
  58  public:
  59   // Constants
  60   static void    ldc           (JavaThread* thread, bool wide);
  61   static void    resolve_ldc   (JavaThread* thread, Bytecodes::Code bytecode);
  62 
  63   // Allocation
  64   static void    _new          (JavaThread* thread, ConstantPool* pool, int index);
  65   static void    newarray      (JavaThread* thread, BasicType type, jint size);
  66   static void    anewarray     (JavaThread* thread, ConstantPool* pool, int index, jint size);
  67   static void    multianewarray(JavaThread* thread, jint* first_size_address);
  68   static void    register_finalizer(JavaThread* thread, oopDesc* obj);
  69 
  70   // Quicken instance-of and check-cast bytecodes
  71   static void    quicken_io_cc(JavaThread* thread);
  72 
  73   // Exceptions thrown by the interpreter
  74   static void    throw_AbstractMethodError(JavaThread* thread);
  75   static void    throw_AbstractMethodErrorWithMethod(JavaThread* thread, Method* oop);
  76   static void    throw_AbstractMethodErrorVerbose(JavaThread* thread,
  77                                                   Klass* recvKlass,
  78                                                   Method* missingMethod);
  79 
  80   static void    throw_IncompatibleClassChangeError(JavaThread* thread);
  81   static void    throw_IncompatibleClassChangeErrorVerbose(JavaThread* thread,
  82                                                            Klass* resc,
  83                                                            Klass* interfaceKlass);
  84   static void    throw_StackOverflowError(JavaThread* thread);
  85   static void    throw_delayed_StackOverflowError(JavaThread* thread);
  86   static void    throw_ArrayIndexOutOfBoundsException(JavaThread* thread, arrayOopDesc* a, jint index);
  87   static void    throw_ClassCastException(JavaThread* thread, oopDesc* obj);
  88   static void    create_exception(JavaThread* thread, char* name, char* message);
  89   static void    create_klass_exception(JavaThread* thread, char* name, oopDesc* obj);
  90   static address exception_handler_for_exception(JavaThread* thread, oopDesc* exception);
  91 #if INCLUDE_JVMTI
  92   static void    member_name_arg_or_null(JavaThread* thread, address dmh, Method* m, address bcp);
  93 #endif
  94   static void    throw_pending_exception(JavaThread* thread);
  95 
  96 #ifdef CC_INTERP
  97   // Profile traps in C++ interpreter.
  98   static void    note_nullCheck_trap (JavaThread* thread, Method *method, int trap_bci);
  99   static void    note_div0Check_trap (JavaThread* thread, Method *method, int trap_bci);
 100   static void    note_rangeCheck_trap(JavaThread* thread, Method *method, int trap_bci);
 101   static void    note_classCheck_trap(JavaThread* thread, Method *method, int trap_bci);
 102   static void    note_arrayCheck_trap(JavaThread* thread, Method *method, int trap_bci);
 103   // A dummy for macros that shall not profile traps.
 104   static void    note_no_trap(JavaThread* thread, Method *method, int trap_bci) {}
 105 #endif // CC_INTERP
 106 
 107   static void resolve_from_cache(JavaThread* thread, Bytecodes::Code bytecode);
 108  private:
 109   // Statics & fields
 110   static void resolve_get_put(JavaThread* thread, Bytecodes::Code bytecode);
 111 
 112   // Calls
 113   static void resolve_invoke(JavaThread* thread, Bytecodes::Code bytecode);
 114   static void resolve_invokehandle (JavaThread* thread);
 115   static void resolve_invokedynamic(JavaThread* thread);
 116 
 117  public:
 118   // Synchronization
 119   static void    monitorenter(JavaThread* thread, BasicObjectLock* elem);
 120   static void    monitorexit (JavaThread* thread, BasicObjectLock* elem);
 121 
 122   static void    throw_illegal_monitor_state_exception(JavaThread* thread);
 123   static void    new_illegal_monitor_state_exception(JavaThread* thread);
 124 
 125   // Breakpoints
 126   static void _breakpoint(JavaThread* thread, Method* method, address bcp);
 127   static Bytecodes::Code get_original_bytecode_at(JavaThread* thread, Method* method, address bcp);
 128   static void            set_original_bytecode_at(JavaThread* thread, Method* method, address bcp, Bytecodes::Code new_code);
 129   static bool is_breakpoint(JavaThread *thread);
 130 
 131   // Safepoints
 132   static void    at_safepoint(JavaThread* thread);
 133 
 134   // Debugger support
 135   static void post_field_access(JavaThread *thread, oopDesc* obj,
 136     ConstantPoolCacheEntry *cp_entry);
 137   static void post_field_modification(JavaThread *thread, oopDesc* obj,
 138     ConstantPoolCacheEntry *cp_entry, jvalue *value);
 139   static void post_method_entry(JavaThread *thread);
 140   static void post_method_exit (JavaThread *thread);
 141   static int  interpreter_contains(address pc);
 142 
 143   // Native signature handlers
 144   static void prepare_native_call(JavaThread* thread, Method* method);
 145   static address slow_signature_handler(JavaThread* thread,
 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* thread, 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* thread, 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* thread, address branch_bcp);
 165 
 166   // Interpreter profiling support
 167   static jint    bcp_to_di(Method* method, address cur_bcp);
 168   static void    profile_method(JavaThread* thread);
 169   static void    update_mdp_for_ret(JavaThread* thread, int bci);
 170 #ifdef ASSERT
 171   static void    verify_mdp(Method* method, address bcp, address mdp);
 172 #endif // ASSERT
 173   static MethodCounters* build_method_counters(JavaThread* thread, Method* m);
 174 };
 175 
 176 
 177 class SignatureHandlerLibrary: public AllStatic {
 178  public:
 179   enum { buffer_size =  1*K }; // the size of the temporary code buffer
 180   enum { blob_size   = 32*K }; // the size of a handler code blob.
 181 
 182  private:
 183   static BufferBlob*              _handler_blob; // the current buffer blob containing the generated handlers
 184   static address                  _handler;      // next available address within _handler_blob;
 185   static GrowableArray<uint64_t>* _fingerprints; // the fingerprint collection
 186   static GrowableArray<address>*  _handlers;     // the corresponding handlers
 187   static address                  _buffer;       // the temporary code buffer
 188 
 189   static address set_handler_blob();
 190   static void initialize();
 191   static address set_handler(CodeBuffer* buffer);
 192   static void pd_set_handler(address handler);
 193 
 194  public:
 195   static void add(const methodHandle& method);
 196   static void add(uint64_t fingerprint, address handler);
 197 };
 198 
 199 #endif // SHARE_VM_INTERPRETER_INTERPRETERRUNTIME_HPP