1 /*
2 * Copyright (C) 2011 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 #include "common_compiler_test.h"
18
19 #include <type_traits>
20
21 #include "arch/instruction_set_features.h"
22 #include "art_field-inl.h"
23 #include "art_method-inl.h"
24 #include "base/callee_save_type.h"
25 #include "base/casts.h"
26 #include "base/enums.h"
27 #include "base/utils.h"
28 #include "class_linker.h"
29 #include "compiled_method-inl.h"
30 #include "dex/descriptors_names.h"
31 #include "dex/verification_results.h"
32 #include "driver/compiled_method_storage.h"
33 #include "driver/compiler_options.h"
34 #include "jni/java_vm_ext.h"
35 #include "interpreter/interpreter.h"
36 #include "mirror/class-inl.h"
37 #include "mirror/class_loader.h"
38 #include "mirror/dex_cache.h"
39 #include "mirror/object-inl.h"
40 #include "oat_quick_method_header.h"
41 #include "scoped_thread_state_change-inl.h"
42 #include "thread-current-inl.h"
43 #include "utils/atomic_dex_ref_map-inl.h"
44
45 namespace art {
46
CreateCompilerOptions(InstructionSet instruction_set,const std::string & variant)47 std::unique_ptr<CompilerOptions> CommonCompilerTest::CreateCompilerOptions(
48 InstructionSet instruction_set, const std::string& variant) {
49 std::unique_ptr<CompilerOptions> compiler_options = std::make_unique<CompilerOptions>();
50 compiler_options->instruction_set_ = instruction_set;
51 std::string error_msg;
52 compiler_options->instruction_set_features_ =
53 InstructionSetFeatures::FromVariant(instruction_set, variant, &error_msg);
54 CHECK(compiler_options->instruction_set_features_ != nullptr) << error_msg;
55 return compiler_options;
56 }
57
CommonCompilerTest()58 CommonCompilerTest::CommonCompilerTest() {}
~CommonCompilerTest()59 CommonCompilerTest::~CommonCompilerTest() {}
60
MakeExecutable(ArtMethod * method,const CompiledMethod * compiled_method)61 void CommonCompilerTest::MakeExecutable(ArtMethod* method, const CompiledMethod* compiled_method) {
62 CHECK(method != nullptr);
63 // If the code size is 0 it means the method was skipped due to profile guided compilation.
64 if (compiled_method != nullptr && compiled_method->GetQuickCode().size() != 0u) {
65 ArrayRef<const uint8_t> code = compiled_method->GetQuickCode();
66 const uint32_t code_size = code.size();
67 ArrayRef<const uint8_t> vmap_table = compiled_method->GetVmapTable();
68 const uint32_t vmap_table_offset = vmap_table.empty() ? 0u
69 : sizeof(OatQuickMethodHeader) + vmap_table.size();
70 OatQuickMethodHeader method_header(vmap_table_offset, code_size);
71
72 header_code_and_maps_chunks_.push_back(std::vector<uint8_t>());
73 std::vector<uint8_t>* chunk = &header_code_and_maps_chunks_.back();
74 const size_t max_padding = GetInstructionSetAlignment(compiled_method->GetInstructionSet());
75 const size_t size = vmap_table.size() + sizeof(method_header) + code_size;
76 chunk->reserve(size + max_padding);
77 chunk->resize(sizeof(method_header));
78 static_assert(std::is_trivially_copyable<OatQuickMethodHeader>::value, "Cannot use memcpy");
79 memcpy(&(*chunk)[0], &method_header, sizeof(method_header));
80 chunk->insert(chunk->begin(), vmap_table.begin(), vmap_table.end());
81 chunk->insert(chunk->end(), code.begin(), code.end());
82 CHECK_EQ(chunk->size(), size);
83 const void* unaligned_code_ptr = chunk->data() + (size - code_size);
84 size_t offset = dchecked_integral_cast<size_t>(reinterpret_cast<uintptr_t>(unaligned_code_ptr));
85 size_t padding = compiled_method->AlignCode(offset) - offset;
86 // Make sure no resizing takes place.
87 CHECK_GE(chunk->capacity(), chunk->size() + padding);
88 chunk->insert(chunk->begin(), padding, 0);
89 const void* code_ptr = reinterpret_cast<const uint8_t*>(unaligned_code_ptr) + padding;
90 CHECK_EQ(code_ptr, static_cast<const void*>(chunk->data() + (chunk->size() - code_size)));
91 MakeExecutable(code_ptr, code.size());
92 const void* method_code = CompiledMethod::CodePointer(code_ptr,
93 compiled_method->GetInstructionSet());
94 LOG(INFO) << "MakeExecutable " << method->PrettyMethod() << " code=" << method_code;
95 method->SetEntryPointFromQuickCompiledCode(method_code);
96 } else {
97 // No code? You must mean to go into the interpreter.
98 // Or the generic JNI...
99 class_linker_->SetEntryPointsToInterpreter(method);
100 }
101 }
102
MakeExecutable(const void * code_start,size_t code_length)103 void CommonCompilerTest::MakeExecutable(const void* code_start, size_t code_length) {
104 CHECK(code_start != nullptr);
105 CHECK_NE(code_length, 0U);
106 uintptr_t data = reinterpret_cast<uintptr_t>(code_start);
107 uintptr_t base = RoundDown(data, kPageSize);
108 uintptr_t limit = RoundUp(data + code_length, kPageSize);
109 uintptr_t len = limit - base;
110 // Remove hwasan tag. This is done in kernel in newer versions. This supports older kernels.
111 void* base_ptr = HWASanUntag(reinterpret_cast<void*>(base));
112 int result = mprotect(base_ptr, len, PROT_READ | PROT_WRITE | PROT_EXEC);
113 CHECK_EQ(result, 0);
114
115 CHECK(FlushCpuCaches(reinterpret_cast<void*>(base), reinterpret_cast<void*>(base + len)));
116 }
117
SetUp()118 void CommonCompilerTest::SetUp() {
119 CommonRuntimeTest::SetUp();
120 {
121 ScopedObjectAccess soa(Thread::Current());
122
123 runtime_->SetInstructionSet(instruction_set_);
124 for (uint32_t i = 0; i < static_cast<uint32_t>(CalleeSaveType::kLastCalleeSaveType); ++i) {
125 CalleeSaveType type = CalleeSaveType(i);
126 if (!runtime_->HasCalleeSaveMethod(type)) {
127 runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
128 }
129 }
130 }
131 }
132
ApplyInstructionSet()133 void CommonCompilerTest::ApplyInstructionSet() {
134 // Copy local instruction_set_ and instruction_set_features_ to *compiler_options_;
135 CHECK(instruction_set_features_ != nullptr);
136 if (instruction_set_ == InstructionSet::kThumb2) {
137 CHECK_EQ(InstructionSet::kArm, instruction_set_features_->GetInstructionSet());
138 } else {
139 CHECK_EQ(instruction_set_, instruction_set_features_->GetInstructionSet());
140 }
141 compiler_options_->instruction_set_ = instruction_set_;
142 compiler_options_->instruction_set_features_ =
143 InstructionSetFeatures::FromBitmap(instruction_set_, instruction_set_features_->AsBitmap());
144 CHECK(compiler_options_->instruction_set_features_->Equals(instruction_set_features_.get()));
145 }
146
OverrideInstructionSetFeatures(InstructionSet instruction_set,const std::string & variant)147 void CommonCompilerTest::OverrideInstructionSetFeatures(InstructionSet instruction_set,
148 const std::string& variant) {
149 instruction_set_ = instruction_set;
150 std::string error_msg;
151 instruction_set_features_ =
152 InstructionSetFeatures::FromVariant(instruction_set, variant, &error_msg);
153 CHECK(instruction_set_features_ != nullptr) << error_msg;
154
155 if (compiler_options_ != nullptr) {
156 ApplyInstructionSet();
157 }
158 }
159
SetUpRuntimeOptions(RuntimeOptions * options)160 void CommonCompilerTest::SetUpRuntimeOptions(RuntimeOptions* options) {
161 CommonRuntimeTest::SetUpRuntimeOptions(options);
162
163 compiler_options_.reset(new CompilerOptions);
164 verification_results_.reset(new VerificationResults(compiler_options_.get()));
165
166 ApplyInstructionSet();
167 }
168
GetCompilerKind() const169 Compiler::Kind CommonCompilerTest::GetCompilerKind() const {
170 return compiler_kind_;
171 }
172
SetCompilerKind(Compiler::Kind compiler_kind)173 void CommonCompilerTest::SetCompilerKind(Compiler::Kind compiler_kind) {
174 compiler_kind_ = compiler_kind;
175 }
176
TearDown()177 void CommonCompilerTest::TearDown() {
178 verification_results_.reset();
179 compiler_options_.reset();
180
181 CommonRuntimeTest::TearDown();
182 }
183
CompileMethod(ArtMethod * method)184 void CommonCompilerTest::CompileMethod(ArtMethod* method) {
185 CHECK(method != nullptr);
186 TimingLogger timings("CommonCompilerTest::CompileMethod", false, false);
187 TimingLogger::ScopedTiming t(__FUNCTION__, &timings);
188 CompiledMethodStorage storage(/*swap_fd=*/ -1);
189 CompiledMethod* compiled_method = nullptr;
190 {
191 DCHECK(!Runtime::Current()->IsStarted());
192 Thread* self = Thread::Current();
193 StackHandleScope<2> hs(self);
194 std::unique_ptr<Compiler> compiler(
195 Compiler::Create(*compiler_options_, &storage, compiler_kind_));
196 const DexFile& dex_file = *method->GetDexFile();
197 Handle<mirror::DexCache> dex_cache = hs.NewHandle(class_linker_->FindDexCache(self, dex_file));
198 Handle<mirror::ClassLoader> class_loader = hs.NewHandle(method->GetClassLoader());
199 compiler_options_->verification_results_ = verification_results_.get();
200 if (method->IsNative()) {
201 compiled_method = compiler->JniCompile(method->GetAccessFlags(),
202 method->GetDexMethodIndex(),
203 dex_file,
204 dex_cache);
205 } else {
206 verification_results_->AddDexFile(&dex_file);
207 verification_results_->CreateVerifiedMethodFor(
208 MethodReference(&dex_file, method->GetDexMethodIndex()));
209 compiled_method = compiler->Compile(method->GetCodeItem(),
210 method->GetAccessFlags(),
211 method->GetInvokeType(),
212 method->GetClassDefIndex(),
213 method->GetDexMethodIndex(),
214 class_loader,
215 dex_file,
216 dex_cache);
217 }
218 compiler_options_->verification_results_ = nullptr;
219 }
220 CHECK(method != nullptr);
221 {
222 TimingLogger::ScopedTiming t2("MakeExecutable", &timings);
223 MakeExecutable(method, compiled_method);
224 }
225 CompiledMethod::ReleaseSwapAllocatedCompiledMethod(&storage, compiled_method);
226 }
227
CompileDirectMethod(Handle<mirror::ClassLoader> class_loader,const char * class_name,const char * method_name,const char * signature)228 void CommonCompilerTest::CompileDirectMethod(Handle<mirror::ClassLoader> class_loader,
229 const char* class_name, const char* method_name,
230 const char* signature) {
231 std::string class_descriptor(DotToDescriptor(class_name));
232 Thread* self = Thread::Current();
233 ObjPtr<mirror::Class> klass =
234 class_linker_->FindClass(self, class_descriptor.c_str(), class_loader);
235 CHECK(klass != nullptr) << "Class not found " << class_name;
236 auto pointer_size = class_linker_->GetImagePointerSize();
237 ArtMethod* method = klass->FindClassMethod(method_name, signature, pointer_size);
238 CHECK(method != nullptr && method->IsDirect()) << "Direct method not found: "
239 << class_name << "." << method_name << signature;
240 CompileMethod(method);
241 }
242
CompileVirtualMethod(Handle<mirror::ClassLoader> class_loader,const char * class_name,const char * method_name,const char * signature)243 void CommonCompilerTest::CompileVirtualMethod(Handle<mirror::ClassLoader> class_loader,
244 const char* class_name, const char* method_name,
245 const char* signature) {
246 std::string class_descriptor(DotToDescriptor(class_name));
247 Thread* self = Thread::Current();
248 ObjPtr<mirror::Class> klass =
249 class_linker_->FindClass(self, class_descriptor.c_str(), class_loader);
250 CHECK(klass != nullptr) << "Class not found " << class_name;
251 auto pointer_size = class_linker_->GetImagePointerSize();
252 ArtMethod* method = klass->FindClassMethod(method_name, signature, pointer_size);
253 CHECK(method != nullptr && !method->IsDirect()) << "Virtual method not found: "
254 << class_name << "." << method_name << signature;
255 CompileMethod(method);
256 }
257
ClearBootImageOption()258 void CommonCompilerTest::ClearBootImageOption() {
259 compiler_options_->image_type_ = CompilerOptions::ImageType::kNone;
260 }
261
262 } // namespace art
263