1 /*
   2  * Copyright (c) 1997, 2017, 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.inline.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 struct FrameInfo {
  41   address pc;
  42   address fp;
  43   address sp;
  44 };
  45 
  46 class InterpreterRuntime: AllStatic {
  47   friend class BytecodeClosure; // for method and bcp
  48   friend class PrintingClosure; // for method and bcp
  49 
  50  private:
  51   // Helper class to access current interpreter state
  52   class LastFrameAccessor : public StackObj {
  53     frame _last_frame;
  54   public:
  55     LastFrameAccessor(JavaThread* thread) {
  56       assert(thread == Thread::current(), "sanity");
  57       _last_frame = thread->last_frame();
  58     }
  59     bool is_interpreted_frame() const              { return _last_frame.is_interpreted_frame(); }
  60     Method*   method() const                       { return _last_frame.interpreter_frame_method(); }
  61     address   bcp() const                          { return _last_frame.interpreter_frame_bcp(); }
  62     int       bci() const                          { return _last_frame.interpreter_frame_bci(); }
  63     address   mdp() const                          { return _last_frame.interpreter_frame_mdp(); }
  64 
  65     void      set_bcp(address bcp)                 { _last_frame.interpreter_frame_set_bcp(bcp); }
  66     void      set_mdp(address dp)                  { _last_frame.interpreter_frame_set_mdp(dp); }
  67 
  68     // pass method to avoid calling unsafe bcp_to_method (partial fix 4926272)
  69     Bytecodes::Code code() const                   { return Bytecodes::code_at(method(), bcp()); }
  70 
  71     Bytecode  bytecode() const                     { return Bytecode(method(), bcp()); }
  72     int get_index_u1(Bytecodes::Code bc) const     { return bytecode().get_index_u1(bc); }
  73     int get_index_u2(Bytecodes::Code bc) const     { return bytecode().get_index_u2(bc); }
  74     int get_index_u2_cpcache(Bytecodes::Code bc) const
  75                                                    { return bytecode().get_index_u2_cpcache(bc); }
  76     int get_index_u4(Bytecodes::Code bc) const     { return bytecode().get_index_u4(bc); }
  77     int number_of_dimensions() const               { return bcp()[3]; }
  78     ConstantPoolCacheEntry* cache_entry_at(int i) const
  79                                                    { return method()->constants()->cache()->entry_at(i); }
  80     ConstantPoolCacheEntry* cache_entry() const    { return cache_entry_at(Bytes::get_native_u2(bcp() + 1)); }
  81 
  82     oop callee_receiver(Symbol* signature) {
  83       return _last_frame.interpreter_callee_receiver(signature);
  84     }
  85     BasicObjectLock* monitor_begin() const {
  86       return _last_frame.interpreter_frame_monitor_begin();
  87     }
  88     BasicObjectLock* monitor_end() const {
  89       return _last_frame.interpreter_frame_monitor_end();
  90     }
  91     BasicObjectLock* next_monitor(BasicObjectLock* current) const {
  92       return _last_frame.next_monitor_in_interpreter_frame(current);
  93     }
  94 
  95     frame& get_frame()                             { return _last_frame; }
  96   };
  97 
  98   static void      set_bcp_and_mdp(address bcp, JavaThread*thread);
  99   static void      note_trap_inner(JavaThread* thread, int reason,
 100                                    const methodHandle& trap_method, int trap_bci, TRAPS);
 101   static void      note_trap(JavaThread *thread, int reason, TRAPS);
 102 #ifdef CC_INTERP
 103   // Profile traps in C++ interpreter.
 104   static void      note_trap(JavaThread* thread, int reason, Method *method, int trap_bci);
 105 #endif // CC_INTERP
 106 
 107   // Inner work method for Interpreter's frequency counter overflow.
 108   static nmethod* frequency_counter_overflow_inner(JavaThread* thread, address branch_bcp);
 109 
 110  public:
 111   // Constants
 112   static void    ldc           (JavaThread* thread, bool wide);
 113   static void    resolve_ldc   (JavaThread* thread, Bytecodes::Code bytecode);
 114 
 115   // Allocation
 116   static void    _new          (JavaThread* thread, ConstantPool* pool, int index);
 117   static void    newarray      (JavaThread* thread, BasicType type, jint size);
 118   static void    anewarray     (JavaThread* thread, ConstantPool* pool, int index, jint size);
 119   static void    multianewarray(JavaThread* thread, jint* first_size_address);
 120   static void    register_finalizer(JavaThread* thread, oopDesc* obj);
 121 
 122   // Quicken instance-of and check-cast bytecodes
 123   static void    quicken_io_cc(JavaThread* thread);
 124 
 125   // Exceptions thrown by the interpreter
 126   static void    throw_AbstractMethodError(JavaThread* thread);
 127   static void    throw_IncompatibleClassChangeError(JavaThread* thread);
 128   static void    throw_StackOverflowError(JavaThread* thread);
 129   static void    throw_delayed_StackOverflowError(JavaThread* thread);
 130   static void    throw_ArrayIndexOutOfBoundsException(JavaThread* thread, char* name, jint index);
 131   static void    throw_ClassCastException(JavaThread* thread, oopDesc* obj);
 132   static void    create_exception(JavaThread* thread, char* name, char* message);
 133   static void    create_klass_exception(JavaThread* thread, char* name, oopDesc* obj);
 134   static address exception_handler_for_exception(JavaThread* thread, oopDesc* exception);
 135 #if INCLUDE_JVMTI
 136   static void    member_name_arg_or_null(JavaThread* thread, address dmh, Method* m, address bcp);
 137 #endif
 138   static void    throw_pending_exception(JavaThread* thread);
 139 
 140 #ifdef CC_INTERP
 141   // Profile traps in C++ interpreter.
 142   static void    note_nullCheck_trap (JavaThread* thread, Method *method, int trap_bci);
 143   static void    note_div0Check_trap (JavaThread* thread, Method *method, int trap_bci);
 144   static void    note_rangeCheck_trap(JavaThread* thread, Method *method, int trap_bci);
 145   static void    note_classCheck_trap(JavaThread* thread, Method *method, int trap_bci);
 146   static void    note_arrayCheck_trap(JavaThread* thread, Method *method, int trap_bci);
 147   // A dummy for macros that shall not profile traps.
 148   static void    note_no_trap(JavaThread* thread, Method *method, int trap_bci) {}
 149 #endif // CC_INTERP
 150 
 151   static void resolve_from_cache(JavaThread* thread, Bytecodes::Code bytecode);
 152  private:
 153   // Statics & fields
 154   static void resolve_get_put(JavaThread* thread, Bytecodes::Code bytecode);
 155 
 156   // Calls
 157   static void resolve_invoke(JavaThread* thread, Bytecodes::Code bytecode);
 158   static void resolve_invokehandle (JavaThread* thread);
 159   static void resolve_invokedynamic(JavaThread* thread);
 160 
 161  public:
 162   // Synchronization
 163   static void    monitorenter(JavaThread* thread, BasicObjectLock* elem);
 164   static void    monitorexit (JavaThread* thread, BasicObjectLock* elem);
 165 
 166   static void    throw_illegal_monitor_state_exception(JavaThread* thread);
 167   static void    new_illegal_monitor_state_exception(JavaThread* thread);
 168 
 169   // Breakpoints
 170   static void _breakpoint(JavaThread* thread, Method* method, address bcp);
 171   static Bytecodes::Code get_original_bytecode_at(JavaThread* thread, Method* method, address bcp);
 172   static void            set_original_bytecode_at(JavaThread* thread, Method* method, address bcp, Bytecodes::Code new_code);
 173   static bool is_breakpoint(JavaThread *thread) { return Bytecodes::code_or_bp_at(LastFrameAccessor(thread).bcp()) == Bytecodes::_breakpoint; }
 174 
 175   // Safepoints
 176   static void    at_safepoint(JavaThread* thread);
 177 
 178   // Continuation
 179   static void freeze(JavaThread* thread, FrameInfo* fi, oop context);
 180   static void pop_and_thaw0(JavaThread* thread, FrameInfo* fi, int num_frames, bool pop);
 181   static void pop_and_thaw(JavaThread* thread, FrameInfo* fi, int num_frames);
 182   static void thaw(JavaThread* thread, FrameInfo* fi, int num_frames);
 183 
 184   // Debugger support
 185   static void post_field_access(JavaThread *thread, oopDesc* obj,
 186     ConstantPoolCacheEntry *cp_entry);
 187   static void post_field_modification(JavaThread *thread, oopDesc* obj,
 188     ConstantPoolCacheEntry *cp_entry, jvalue *value);
 189   static void post_method_entry(JavaThread *thread);
 190   static void post_method_exit (JavaThread *thread);
 191   static int  interpreter_contains(address pc);
 192 
 193   // Native signature handlers
 194   static void prepare_native_call(JavaThread* thread, Method* method);
 195   static address slow_signature_handler(JavaThread* thread,
 196                                         Method* method,
 197                                         intptr_t* from, intptr_t* to);
 198 
 199 #if defined(IA32) || defined(AMD64) || defined(ARM)
 200   // Popframe support (only needed on x86, AMD64 and ARM)
 201   static void popframe_move_outgoing_args(JavaThread* thread, void* src_address, void* dest_address);
 202 #endif
 203 
 204   // bytecode tracing is only used by the TraceBytecodes
 205   static intptr_t trace_bytecode(JavaThread* thread, intptr_t preserve_this_value, intptr_t tos, intptr_t tos2) PRODUCT_RETURN0;
 206 
 207   // Platform dependent stuff
 208 #include CPU_HEADER(interpreterRT)
 209 
 210   // optional normalization of fingerprints to reduce the number of adapters
 211   static uint64_t normalize_fast_native_fingerprint(uint64_t fingerprint);
 212 
 213   // Interpreter's frequency counter overflow
 214   static nmethod* frequency_counter_overflow(JavaThread* thread, address branch_bcp);
 215 
 216   // Interpreter profiling support
 217   static jint    bcp_to_di(Method* method, address cur_bcp);
 218   static void    profile_method(JavaThread* thread);
 219   static void    update_mdp_for_ret(JavaThread* thread, int bci);
 220 #ifdef ASSERT
 221   static void    verify_mdp(Method* method, address bcp, address mdp);
 222 #endif // ASSERT
 223   static MethodCounters* build_method_counters(JavaThread* thread, Method* m);
 224 };
 225 
 226 
 227 class SignatureHandlerLibrary: public AllStatic {
 228  public:
 229   enum { buffer_size =  1*K }; // the size of the temporary code buffer
 230   enum { blob_size   = 32*K }; // the size of a handler code blob.
 231 
 232  private:
 233   static BufferBlob*              _handler_blob; // the current buffer blob containing the generated handlers
 234   static address                  _handler;      // next available address within _handler_blob;
 235   static GrowableArray<uint64_t>* _fingerprints; // the fingerprint collection
 236   static GrowableArray<address>*  _handlers;     // the corresponding handlers
 237   static address                  _buffer;       // the temporary code buffer
 238 
 239   static address set_handler_blob();
 240   static void initialize();
 241   static address set_handler(CodeBuffer* buffer);
 242   static void pd_set_handler(address handler);
 243 
 244  public:
 245   static void add(const methodHandle& method);
 246   static void add(uint64_t fingerprint, address handler);
 247 };
 248 
 249 #endif // SHARE_VM_INTERPRETER_INTERPRETERRUNTIME_HPP
--- EOF ---