1 /*
2 * Copyright (c) 1999, 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_VM_JVMCI_JVMCIENV_HPP
26 #define SHARE_VM_JVMCI_JVMCIENV_HPP
27
28 #include "classfile/systemDictionary.hpp"
29 #include "code/debugInfoRec.hpp"
30 #include "code/dependencies.hpp"
31 #include "code/exceptionHandlerTable.hpp"
32 #include "compiler/oopMap.hpp"
33 #include "runtime/thread.hpp"
34
35 class CompileTask;
36
37 // Bring the JVMCI compiler thread into the VM state.
38 #define JVMCI_VM_ENTRY_MARK \
39 JavaThread* thread = JavaThread::current(); \
40 ThreadInVMfromNative __tiv(thread); \
41 ResetNoHandleMark rnhm; \
42 HandleMarkCleaner __hm(thread); \
43 Thread* THREAD = thread; \
44 debug_only(VMNativeEntryWrapper __vew;)
45
46 #define JVMCI_EXCEPTION_CONTEXT \
47 JavaThread* thread=JavaThread::current(); \
48 Thread* THREAD = thread;
49
50 //
51 // This class is the top level broker for requests from the compiler
52 // to the VM.
53 class JVMCIEnv : StackObj {
54 CI_PACKAGE_ACCESS_TO
55
56 friend class JVMCIVMStructs;
57 friend class CompileBroker;
58 friend class Dependencies; // for get_object, during logging
59
60 public:
61
62 enum CodeInstallResult {
63 ok,
64 dependencies_failed,
65 dependencies_invalid,
66 cache_full,
67 code_too_large
68 };
69
70 // Look up a klass by name from a particular class loader (the accessor's).
71 // If require_local, result must be defined in that class loader, or NULL.
72 // If !require_local, a result from remote class loader may be reported,
73 // if sufficient class loader constraints exist such that initiating
74 // a class loading request from the given loader is bound to return
75 // the class defined in the remote loader (or throw an error).
76 //
77 // Return an unloaded klass if !require_local and no class at all is found.
78 //
79 // The CI treats a klass as loaded if it is consistently defined in
80 // another loader, even if it hasn't yet been loaded in all loaders
81 // that could potentially see it via delegation.
82 static Klass* get_klass_by_name(Klass* accessing_klass, Symbol* klass_name, bool require_local);
83
84 // Constant pool access.
85 static Klass* get_klass_by_index(const constantPoolHandle& cpool,
86 int klass_index,
87 bool& is_accessible,
88 Klass* loading_klass);
89 static void get_field_by_index(InstanceKlass* loading_klass, fieldDescriptor& fd,
90 int field_index);
91 static methodHandle get_method_by_index(const constantPoolHandle& cpool,
92 int method_index, Bytecodes::Code bc,
93 InstanceKlass* loading_klass);
94
95 JVMCIEnv(CompileTask* task, int system_dictionary_modification_counter);
96
97 private:
98 CompileTask* _task;
99 int _system_dictionary_modification_counter;
100
101 // Compilation result values
102 const char* _failure_reason;
103 bool _retryable;
104
105 // Cache JVMTI state. Defined as bytes so that reading them from Java
106 // via Unsafe is well defined (the C++ type for bool is implementation
107 // defined and may not be the same as a Java boolean).
108 jbyte _jvmti_can_hotswap_or_post_breakpoint;
109 jbyte _jvmti_can_access_local_variables;
110 jbyte _jvmti_can_post_on_exceptions;
111 jbyte _jvmti_can_pop_frame;
112
113 // Implementation methods for loading and constant pool access.
114 static Klass* get_klass_by_name_impl(Klass* accessing_klass,
115 const constantPoolHandle& cpool,
116 Symbol* klass_name,
117 bool require_local);
118 static Klass* get_klass_by_index_impl(const constantPoolHandle& cpool,
119 int klass_index,
120 bool& is_accessible,
121 Klass* loading_klass);
122 static void get_field_by_index_impl(InstanceKlass* loading_klass, fieldDescriptor& fd,
123 int field_index);
124 static methodHandle get_method_by_index_impl(const constantPoolHandle& cpool,
125 int method_index, Bytecodes::Code bc,
126 InstanceKlass* loading_klass);
127
128 // Helper methods
129 static bool check_klass_accessibility(Klass* accessing_klass, Klass* resolved_klass);
130 static methodHandle lookup_method(InstanceKlass* accessor,
131 Klass* holder,
132 Symbol* name,
133 Symbol* sig,
134 Bytecodes::Code bc,
135 constantTag tag);
136
137 private:
138
139 // Is this thread currently in the VM state?
140 static bool is_in_vm();
141
142 // Helper routine for determining the validity of a compilation
143 // with respect to concurrent class loading.
144 static JVMCIEnv::CodeInstallResult validate_compile_task_dependencies(Dependencies* target, Handle compiled_code,
145 JVMCIEnv* env, char** failure_detail);
146
147 public:
148 CompileTask* task() { return _task; }
149
150 bool jvmti_state_changed() const;
151 bool jvmti_can_hotswap_or_post_breakpoint() const { return _jvmti_can_hotswap_or_post_breakpoint != 0; }
152 bool jvmti_can_access_local_variables() const { return _jvmti_can_access_local_variables != 0; }
153 bool jvmti_can_post_on_exceptions() const { return _jvmti_can_post_on_exceptions != 0; }
154 bool jvmti_can_pop_frame() const { return _jvmti_can_pop_frame != 0; }
155
156 const char* failure_reason() { return _failure_reason; }
157 bool retryable() { return _retryable; }
158
159 void set_failure(const char* reason, bool retryable) {
160 _failure_reason = reason;
161 _retryable = retryable;
162 }
163
164 // Register the result of a compilation.
165 static JVMCIEnv::CodeInstallResult register_method(
166 const methodHandle& target,
167 nmethod*& nm,
168 int entry_bci,
169 CodeOffsets* offsets,
170 int orig_pc_offset,
171 CodeBuffer* code_buffer,
172 int frame_words,
173 OopMapSet* oop_map_set,
174 ExceptionHandlerTable* handler_table,
175 AbstractCompiler* compiler,
176 DebugInformationRecorder* debug_info,
177 Dependencies* dependencies,
178 JVMCIEnv* env,
179 int compile_id,
180 bool has_unsafe_access,
181 bool has_wide_vector,
182 Handle installed_code,
183 Handle compiled_code,
184 Handle speculation_log);
185
186 // converts the Klass* representing the holder of a method into a
187 // InstanceKlass*. This is needed since the holder of a method in
188 // the bytecodes could be an array type. Basically this converts
189 // array types into java/lang/Object and other types stay as they are.
190 static InstanceKlass* get_instance_klass_for_declared_method_holder(Klass* klass);
191 };
192
193 #endif // SHARE_VM_JVMCI_JVMCIENV_HPP