common_compiler_test.cc revision 998c21661b5074c293cae818d0ab7c44dcda3a66 
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 "arch/instruction_set_features.h"
20#include "art_field-inl.h"
21#include "art_method.h"
22#include "class_linker.h"
23#include "compiled_method.h"
24#include "dex/pass_manager.h"
25#include "dex/quick_compiler_callbacks.h"
26#include "dex/quick/dex_file_to_method_inliner_map.h"
27#include "dex/verification_results.h"
28#include "driver/compiler_driver.h"
29#include "driver/compiler_options.h"
30#include "interpreter/interpreter.h"
31#include "mirror/class_loader.h"
32#include "mirror/class-inl.h"
33#include "mirror/dex_cache.h"
34#include "mirror/object-inl.h"
35#include "oat_quick_method_header.h"
36#include "scoped_thread_state_change.h"
37#include "thread-inl.h"
38#include "utils.h"
39
40namespace art {
41
42CommonCompilerTest::CommonCompilerTest() {}
43CommonCompilerTest::~CommonCompilerTest() {}
44
45void CommonCompilerTest::MakeExecutable(ArtMethod* method) {
46  CHECK(method != nullptr);
47
48  const CompiledMethod* compiled_method = nullptr;
49  if (!method->IsAbstract()) {
50    mirror::DexCache* dex_cache = method->GetDeclaringClass()->GetDexCache();
51    const DexFile& dex_file = *dex_cache->GetDexFile();
52    compiled_method =
53        compiler_driver_->GetCompiledMethod(MethodReference(&dex_file,
54                                                            method->GetDexMethodIndex()));
55  }
56  if (compiled_method != nullptr) {
57    ArrayRef<const uint8_t> code = compiled_method->GetQuickCode();
58    uint32_t code_size = code.size();
59    CHECK_NE(0u, code_size);
60    ArrayRef<const uint8_t> vmap_table = compiled_method->GetVmapTable();
61    uint32_t vmap_table_offset = vmap_table.empty() ? 0u
62        : sizeof(OatQuickMethodHeader) + vmap_table.size();
63    ArrayRef<const uint8_t> mapping_table = compiled_method->GetMappingTable();
64    bool mapping_table_used = !mapping_table.empty();
65    size_t mapping_table_size = mapping_table.size();
66    uint32_t mapping_table_offset = !mapping_table_used ? 0u
67        : sizeof(OatQuickMethodHeader) + vmap_table.size() + mapping_table_size;
68    ArrayRef<const uint8_t> gc_map = compiled_method->GetGcMap();
69    bool gc_map_used = !gc_map.empty();
70    size_t gc_map_size = gc_map.size();
71    uint32_t gc_map_offset = !gc_map_used ? 0u
72        : sizeof(OatQuickMethodHeader) + vmap_table.size() + mapping_table_size + gc_map_size;
73    OatQuickMethodHeader method_header(mapping_table_offset, vmap_table_offset, gc_map_offset,
74                                       compiled_method->GetFrameSizeInBytes(),
75                                       compiled_method->GetCoreSpillMask(),
76                                       compiled_method->GetFpSpillMask(), code_size);
77
78    header_code_and_maps_chunks_.push_back(std::vector<uint8_t>());
79    std::vector<uint8_t>* chunk = &header_code_and_maps_chunks_.back();
80    const size_t max_padding = GetInstructionSetAlignment(compiled_method->GetInstructionSet());
81    const size_t size =
82        gc_map_size + mapping_table_size + vmap_table.size() + sizeof(method_header) + code_size;
83    chunk->reserve(size + max_padding);
84    chunk->resize(sizeof(method_header));
85    memcpy(&(*chunk)[0], &method_header, sizeof(method_header));
86    chunk->insert(chunk->begin(), vmap_table.begin(), vmap_table.end());
87    if (mapping_table_used) {
88      chunk->insert(chunk->begin(), mapping_table.begin(), mapping_table.end());
89    }
90    if (gc_map_used) {
91      chunk->insert(chunk->begin(), gc_map.begin(), gc_map.end());
92    }
93    chunk->insert(chunk->end(), code.begin(), code.end());
94    CHECK_EQ(chunk->size(), size);
95    const void* unaligned_code_ptr = chunk->data() + (size - code_size);
96    size_t offset = dchecked_integral_cast<size_t>(reinterpret_cast<uintptr_t>(unaligned_code_ptr));
97    size_t padding = compiled_method->AlignCode(offset) - offset;
98    // Make sure no resizing takes place.
99    CHECK_GE(chunk->capacity(), chunk->size() + padding);
100    chunk->insert(chunk->begin(), padding, 0);
101    const void* code_ptr = reinterpret_cast<const uint8_t*>(unaligned_code_ptr) + padding;
102    CHECK_EQ(code_ptr, static_cast<const void*>(chunk->data() + (chunk->size() - code_size)));
103    MakeExecutable(code_ptr, code.size());
104    const void* method_code = CompiledMethod::CodePointer(code_ptr,
105                                                          compiled_method->GetInstructionSet());
106    LOG(INFO) << "MakeExecutable " << PrettyMethod(method) << " code=" << method_code;
107    class_linker_->SetEntryPointsToCompiledCode(method, method_code);
108  } else {
109    // No code? You must mean to go into the interpreter.
110    // Or the generic JNI...
111    class_linker_->SetEntryPointsToInterpreter(method);
112  }
113}
114
115void CommonCompilerTest::MakeExecutable(const void* code_start, size_t code_length) {
116  CHECK(code_start != nullptr);
117  CHECK_NE(code_length, 0U);
118  uintptr_t data = reinterpret_cast<uintptr_t>(code_start);
119  uintptr_t base = RoundDown(data, kPageSize);
120  uintptr_t limit = RoundUp(data + code_length, kPageSize);
121  uintptr_t len = limit - base;
122  int result = mprotect(reinterpret_cast<void*>(base), len, PROT_READ | PROT_WRITE | PROT_EXEC);
123  CHECK_EQ(result, 0);
124
125  // Flush instruction cache
126  // Only uses __builtin___clear_cache if GCC >= 4.3.3
127#if GCC_VERSION >= 40303
128  __builtin___clear_cache(reinterpret_cast<void*>(base), reinterpret_cast<void*>(base + len));
129#else
130  // Only warn if not Intel as Intel doesn't have cache flush instructions.
131#if !defined(__i386__) && !defined(__x86_64__)
132  UNIMPLEMENTED(WARNING) << "cache flush";
133#endif
134#endif
135}
136
137void CommonCompilerTest::MakeExecutable(mirror::ClassLoader* class_loader, const char* class_name) {
138  std::string class_descriptor(DotToDescriptor(class_name));
139  Thread* self = Thread::Current();
140  StackHandleScope<1> hs(self);
141  Handle<mirror::ClassLoader> loader(hs.NewHandle(class_loader));
142  mirror::Class* klass = class_linker_->FindClass(self, class_descriptor.c_str(), loader);
143  CHECK(klass != nullptr) << "Class not found " << class_name;
144  size_t pointer_size = class_linker_->GetImagePointerSize();
145  for (auto& m : klass->GetMethods(pointer_size)) {
146    MakeExecutable(&m);
147  }
148}
149
150// Get the set of image classes given to the compiler-driver in SetUp. Note: the compiler
151// driver assumes ownership of the set, so the test should properly release the set.
152std::unordered_set<std::string>* CommonCompilerTest::GetImageClasses() {
153  // Empty set: by default no classes are retained in the image.
154  return new std::unordered_set<std::string>();
155}
156
157// Get the set of compiled classes given to the compiler-driver in SetUp. Note: the compiler
158// driver assumes ownership of the set, so the test should properly release the set.
159std::unordered_set<std::string>* CommonCompilerTest::GetCompiledClasses() {
160  // Null, no selection of compiled-classes.
161  return nullptr;
162}
163
164// Get the set of compiled methods given to the compiler-driver in SetUp. Note: the compiler
165// driver assumes ownership of the set, so the test should properly release the set.
166std::unordered_set<std::string>* CommonCompilerTest::GetCompiledMethods() {
167  // Null, no selection of compiled-methods.
168  return nullptr;
169}
170
171void CommonCompilerTest::SetUp() {
172  CommonRuntimeTest::SetUp();
173  {
174    ScopedObjectAccess soa(Thread::Current());
175
176    const InstructionSet instruction_set = kRuntimeISA;
177    // Take the default set of instruction features from the build.
178    instruction_set_features_.reset(InstructionSetFeatures::FromCppDefines());
179
180    runtime_->SetInstructionSet(instruction_set);
181    for (int i = 0; i < Runtime::kLastCalleeSaveType; i++) {
182      Runtime::CalleeSaveType type = Runtime::CalleeSaveType(i);
183      if (!runtime_->HasCalleeSaveMethod(type)) {
184        runtime_->SetCalleeSaveMethod(runtime_->CreateCalleeSaveMethod(), type);
185      }
186    }
187
188    timer_.reset(new CumulativeLogger("Compilation times"));
189    CreateCompilerDriver(compiler_kind_, instruction_set);
190  }
191}
192
193void CommonCompilerTest::CreateCompilerDriver(Compiler::Kind kind, InstructionSet isa) {
194  compiler_driver_.reset(new CompilerDriver(compiler_options_.get(),
195                                            verification_results_.get(),
196                                            method_inliner_map_.get(),
197                                            kind,
198                                            isa,
199                                            instruction_set_features_.get(),
200                                            true,
201                                            GetImageClasses(),
202                                            GetCompiledClasses(),
203                                            GetCompiledMethods(),
204                                            2,
205                                            true,
206                                            true,
207                                            "",
208                                            false,
209                                            timer_.get(),
210                                            -1,
211                                            /* dex_to_oat_map */ nullptr,
212                                            /* profile_compilation_info */ nullptr));
213  // We typically don't generate an image in unit tests, disable this optimization by default.
214  compiler_driver_->SetSupportBootImageFixup(false);
215}
216
217void CommonCompilerTest::SetUpRuntimeOptions(RuntimeOptions* options) {
218  CommonRuntimeTest::SetUpRuntimeOptions(options);
219
220  compiler_options_.reset(new CompilerOptions);
221  verification_results_.reset(new VerificationResults(compiler_options_.get()));
222  method_inliner_map_.reset(new DexFileToMethodInlinerMap);
223  callbacks_.reset(new QuickCompilerCallbacks(verification_results_.get(),
224                                              method_inliner_map_.get(),
225                                              CompilerCallbacks::CallbackMode::kCompileApp));
226}
227
228Compiler::Kind CommonCompilerTest::GetCompilerKind() const {
229  return compiler_kind_;
230}
231
232void CommonCompilerTest::SetCompilerKind(Compiler::Kind compiler_kind) {
233  compiler_kind_ = compiler_kind;
234}
235
236InstructionSet CommonCompilerTest::GetInstructionSet() const {
237  DCHECK(compiler_driver_.get() != nullptr);
238  return compiler_driver_->GetInstructionSet();
239}
240
241void CommonCompilerTest::TearDown() {
242  timer_.reset();
243  compiler_driver_.reset();
244  callbacks_.reset();
245  method_inliner_map_.reset();
246  verification_results_.reset();
247  compiler_options_.reset();
248
249  CommonRuntimeTest::TearDown();
250}
251
252void CommonCompilerTest::CompileClass(mirror::ClassLoader* class_loader, const char* class_name) {
253  std::string class_descriptor(DotToDescriptor(class_name));
254  Thread* self = Thread::Current();
255  StackHandleScope<1> hs(self);
256  Handle<mirror::ClassLoader> loader(hs.NewHandle(class_loader));
257  mirror::Class* klass = class_linker_->FindClass(self, class_descriptor.c_str(), loader);
258  CHECK(klass != nullptr) << "Class not found " << class_name;
259  auto pointer_size = class_linker_->GetImagePointerSize();
260  for (auto& m : klass->GetMethods(pointer_size)) {
261    CompileMethod(&m);
262  }
263}
264
265void CommonCompilerTest::CompileMethod(ArtMethod* method) {
266  CHECK(method != nullptr);
267  TimingLogger timings("CommonTest::CompileMethod", false, false);
268  TimingLogger::ScopedTiming t(__FUNCTION__, &timings);
269  compiler_driver_->CompileOne(Thread::Current(), method, &timings);
270  TimingLogger::ScopedTiming t2("MakeExecutable", &timings);
271  MakeExecutable(method);
272}
273
274void CommonCompilerTest::CompileDirectMethod(Handle<mirror::ClassLoader> class_loader,
275                                             const char* class_name, const char* method_name,
276                                             const char* signature) {
277  std::string class_descriptor(DotToDescriptor(class_name));
278  Thread* self = Thread::Current();
279  mirror::Class* klass = class_linker_->FindClass(self, class_descriptor.c_str(), class_loader);
280  CHECK(klass != nullptr) << "Class not found " << class_name;
281  auto pointer_size = class_linker_->GetImagePointerSize();
282  ArtMethod* method = klass->FindDirectMethod(method_name, signature, pointer_size);
283  CHECK(method != nullptr) << "Direct method not found: "
284      << class_name << "." << method_name << signature;
285  CompileMethod(method);
286}
287
288void CommonCompilerTest::CompileVirtualMethod(Handle<mirror::ClassLoader> class_loader,
289                                              const char* class_name, const char* method_name,
290                                              const char* signature) {
291  std::string class_descriptor(DotToDescriptor(class_name));
292  Thread* self = Thread::Current();
293  mirror::Class* klass = class_linker_->FindClass(self, class_descriptor.c_str(), class_loader);
294  CHECK(klass != nullptr) << "Class not found " << class_name;
295  auto pointer_size = class_linker_->GetImagePointerSize();
296  ArtMethod* method = klass->FindVirtualMethod(method_name, signature, pointer_size);
297  CHECK(method != nullptr) << "Virtual method not found: "
298      << class_name << "." << method_name << signature;
299  CompileMethod(method);
300}
301
302void CommonCompilerTest::ReserveImageSpace() {
303  // Reserve where the image will be loaded up front so that other parts of test set up don't
304  // accidentally end up colliding with the fixed memory address when we need to load the image.
305  std::string error_msg;
306  MemMap::Init();
307  image_reservation_.reset(MemMap::MapAnonymous("image reservation",
308                                                reinterpret_cast<uint8_t*>(ART_BASE_ADDRESS),
309                                                (size_t)100 * 1024 * 1024,  // 100MB
310                                                PROT_NONE,
311                                                false /* no need for 4gb flag with fixed mmap*/,
312                                                false /* not reusing existing reservation */,
313                                                &error_msg));
314  CHECK(image_reservation_.get() != nullptr) << error_msg;
315}
316
317void CommonCompilerTest::UnreserveImageSpace() {
318  image_reservation_.reset();
319}
320
321}  // namespace art
322