1 /*
   2  * Copyright (c) 2012, 2016, 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 #ifndef SHARE_VM_JVMCI_JVMCI_RUNTIME_HPP
  25 #define SHARE_VM_JVMCI_JVMCI_RUNTIME_HPP
  26 
  27 #include "interpreter/interpreter.hpp"
  28 #include "memory/allocation.hpp"
  29 #include "runtime/arguments.hpp"
  30 #include "runtime/deoptimization.hpp"
  31 
  32 #define JVMCI_ERROR(...)       \
  33   { Exceptions::fthrow(THREAD_AND_LOCATION, vmSymbols::jdk_vm_ci_common_JVMCIError(), __VA_ARGS__); return; }
  34 
  35 #define JVMCI_ERROR_(ret, ...) \
  36   { Exceptions::fthrow(THREAD_AND_LOCATION, vmSymbols::jdk_vm_ci_common_JVMCIError(), __VA_ARGS__); return ret; }
  37 
  38 #define JVMCI_ERROR_0(...)    JVMCI_ERROR_(0, __VA_ARGS__)
  39 #define JVMCI_ERROR_NULL(...) JVMCI_ERROR_(NULL, __VA_ARGS__)
  40 #define JVMCI_ERROR_OK(...)   JVMCI_ERROR_(JVMCIEnv::ok, __VA_ARGS__)
  41 #define CHECK_OK              CHECK_(JVMCIEnv::ok)
  42 
  43 class ParseClosure : public StackObj {
  44   int _lineNo;
  45   char* _filename;
  46   bool _abort;
  47 protected:
  48   void abort() { _abort = true; }
  49   void warn_and_abort(const char* message) {
  50     warn(message);
  51     abort();
  52   }
  53   void warn(const char* message) {
  54     warning("Error at line %d while parsing %s: %s", _lineNo, _filename == NULL ? "?" : _filename, message);
  55   }
  56  public:
  57   ParseClosure() : _lineNo(0), _filename(NULL), _abort(false) {}
  58   void parse_line(char* line) {
  59     _lineNo++;
  60     do_line(line);
  61   }
  62   virtual void do_line(char* line) = 0;
  63   int lineNo() { return _lineNo; }
  64   bool is_aborted() { return _abort; }
  65   void set_filename(char* path) {_filename = path; _lineNo = 0;}
  66 };
  67 
  68 class JVMCIRuntime: public AllStatic {
  69  public:
  70   // Constants describing whether JVMCI wants to be able to adjust the compilation
  71   // level selected for a method by the VM compilation policy and if so, based on
  72   // what information about the method being schedule for compilation.
  73   enum CompLevelAdjustment {
  74      none = 0,             // no adjustment
  75      by_holder = 1,        // adjust based on declaring class of method
  76      by_full_signature = 2 // adjust based on declaring class, name and signature of method
  77   };
  78 
  79  private:
  80   static jobject _HotSpotJVMCIRuntime_instance;
  81   static bool _HotSpotJVMCIRuntime_initialized;
  82   static bool _well_known_classes_initialized;
  83 
  84   static int _trivial_prefixes_count;
  85   static char** _trivial_prefixes;
  86 
  87   static CompLevelAdjustment _comp_level_adjustment;
  88 
  89   static bool _shutdown_called;
  90 
  91   static CompLevel adjust_comp_level_inner(methodHandle method, bool is_osr, CompLevel level, JavaThread* thread);
  92 
  93  public:
  94   static bool is_HotSpotJVMCIRuntime_initialized() {
  95     return _HotSpotJVMCIRuntime_initialized;
  96   }
  97 
  98   /**
  99    * Gets the singleton HotSpotJVMCIRuntime instance, initializing it if necessary
 100    */
 101   static Handle get_HotSpotJVMCIRuntime(TRAPS) {
 102     initialize_JVMCI(CHECK_(Handle()));
 103     return Handle(JNIHandles::resolve_non_null(_HotSpotJVMCIRuntime_instance));
 104   }
 105 
 106   static jobject get_HotSpotJVMCIRuntime_jobject(TRAPS) {
 107     initialize_JVMCI(CHECK_NULL);
 108     assert(_HotSpotJVMCIRuntime_initialized, "must be");
 109     return _HotSpotJVMCIRuntime_instance;
 110   }
 111 
 112   static Handle callStatic(const char* className, const char* methodName, const char* returnType, JavaCallArguments* args, TRAPS);
 113 
 114   /**
 115    * Trigger initialization of HotSpotJVMCIRuntime through JVMCI.getRuntime()
 116    */
 117   static void initialize_JVMCI(TRAPS);
 118 
 119   /**
 120    * Explicitly initialize HotSpotJVMCIRuntime itself
 121    */
 122   static void initialize_HotSpotJVMCIRuntime(TRAPS);
 123 
 124   static void initialize_well_known_classes(TRAPS);
 125 
 126   static void metadata_do(void f(Metadata*));
 127 
 128   static void shutdown(TRAPS);
 129 
 130   static bool shutdown_called() {
 131     return _shutdown_called;
 132   }
 133 
 134   static bool treat_as_trivial(Method* method);
 135 
 136   /**
 137    * Lets JVMCI modify the compilation level currently selected for a method by
 138    * the VM compilation policy.
 139    *
 140    * @param method the method being scheduled for compilation
 141    * @param is_osr specifies if the compilation is an OSR compilation
 142    * @param level the compilation level currently selected by the VM compilation policy
 143    * @param thread the current thread
 144    * @return the compilation level to use for the compilation
 145    */
 146   static CompLevel adjust_comp_level(methodHandle method, bool is_osr, CompLevel level, JavaThread* thread);
 147 
 148   static BasicType kindToBasicType(Handle kind, TRAPS);
 149 
 150   // The following routines are all called from compiled JVMCI code
 151 
 152   static void new_instance(JavaThread* thread, Klass* klass);
 153   static void new_array(JavaThread* thread, Klass* klass, jint length);
 154   static void new_multi_array(JavaThread* thread, Klass* klass, int rank, jint* dims);
 155   static void dynamic_new_array(JavaThread* thread, oopDesc* element_mirror, jint length);
 156   static void dynamic_new_instance(JavaThread* thread, oopDesc* type_mirror);
 157   static jboolean thread_is_interrupted(JavaThread* thread, oopDesc* obj, jboolean clear_interrupted);
 158   static void vm_message(jboolean vmError, jlong format, jlong v1, jlong v2, jlong v3);
 159   static jint identity_hash_code(JavaThread* thread, oopDesc* obj);
 160   static address exception_handler_for_pc(JavaThread* thread);
 161   static void monitorenter(JavaThread* thread, oopDesc* obj, BasicLock* lock);
 162   static void monitorexit (JavaThread* thread, oopDesc* obj, BasicLock* lock);
 163   static void vm_error(JavaThread* thread, jlong where, jlong format, jlong value);
 164   static oopDesc* load_and_clear_exception(JavaThread* thread);
 165   static void log_printf(JavaThread* thread, oopDesc* format, jlong v1, jlong v2, jlong v3);
 166   static void log_primitive(JavaThread* thread, jchar typeChar, jlong value, jboolean newline);
 167   // Print the passed in object, optionally followed by a newline.  If
 168   // as_string is true and the object is a java.lang.String then it
 169   // printed as a string, otherwise the type of the object is printed
 170   // followed by its address.
 171   static void log_object(JavaThread* thread, oopDesc* object, bool as_string, bool newline);
 172   static void write_barrier_pre(JavaThread* thread, oopDesc* obj);
 173   static void write_barrier_post(JavaThread* thread, void* card);
 174   static jboolean validate_object(JavaThread* thread, oopDesc* parent, oopDesc* child);
 175   static void new_store_pre_barrier(JavaThread* thread);
 176 
 177   // used to throw exceptions from compiled JVMCI code
 178   static void throw_and_post_jvmti_exception(JavaThread* thread, const char* exception, const char* message);
 179   // helper methods to throw exception with complex messages
 180   static void throw_klass_external_name_exception(JavaThread* thread, const char* exception, Klass* klass);
 181   static void throw_class_cast_exception(JavaThread* thread, const char* exception, Klass* caster_klass, Klass* target_klass);
 182 
 183   // Test only function
 184   static int test_deoptimize_call_int(JavaThread* thread, int value);
 185 };
 186 
 187 // Tracing macros.
 188 
 189 #define IF_TRACE_jvmci_1 if (!(JVMCITraceLevel >= 1)) ; else
 190 #define IF_TRACE_jvmci_2 if (!(JVMCITraceLevel >= 2)) ; else
 191 #define IF_TRACE_jvmci_3 if (!(JVMCITraceLevel >= 3)) ; else
 192 #define IF_TRACE_jvmci_4 if (!(JVMCITraceLevel >= 4)) ; else
 193 #define IF_TRACE_jvmci_5 if (!(JVMCITraceLevel >= 5)) ; else
 194 
 195 #define TRACE_jvmci_1 if (!(JVMCITraceLevel >= 1 && (tty->print("JVMCITrace-1: "), true))) ; else tty->print_cr
 196 #define TRACE_jvmci_2 if (!(JVMCITraceLevel >= 2 && (tty->print("   JVMCITrace-2: "), true))) ; else tty->print_cr
 197 #define TRACE_jvmci_3 if (!(JVMCITraceLevel >= 3 && (tty->print("      JVMCITrace-3: "), true))) ; else tty->print_cr
 198 #define TRACE_jvmci_4 if (!(JVMCITraceLevel >= 4 && (tty->print("         JVMCITrace-4: "), true))) ; else tty->print_cr
 199 #define TRACE_jvmci_5 if (!(JVMCITraceLevel >= 5 && (tty->print("            JVMCITrace-5: "), true))) ; else tty->print_cr
 200 
 201 #endif // SHARE_VM_JVMCI_JVMCI_RUNTIME_HPP