oat_test.cc revision dcdc85bbd569f0ee66c331b4219c19304a616214 
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 "arch/instruction_set_features.h"
18#include "art_method-inl.h"
19#include "base/unix_file/fd_file.h"
20#include "class_linker.h"
21#include "common_compiler_test.h"
22#include "compiled_method.h"
23#include "compiler.h"
24#include "dex/pass_manager.h"
25#include "dex/quick/dex_file_to_method_inliner_map.h"
26#include "dex/quick_compiler_callbacks.h"
27#include "dex/verification_results.h"
28#include "driver/compiler_driver.h"
29#include "driver/compiler_options.h"
30#include "dwarf/method_debug_info.h"
31#include "elf_writer.h"
32#include "elf_writer_quick.h"
33#include "entrypoints/quick/quick_entrypoints.h"
34#include "linker/vector_output_stream.h"
35#include "mirror/class-inl.h"
36#include "mirror/object_array-inl.h"
37#include "mirror/object-inl.h"
38#include "oat_file-inl.h"
39#include "oat_writer.h"
40#include "scoped_thread_state_change.h"
41
42namespace art {
43
44NO_RETURN static void Usage(const char* fmt, ...) {
45  va_list ap;
46  va_start(ap, fmt);
47  std::string error;
48  StringAppendV(&error, fmt, ap);
49  LOG(FATAL) << error;
50  va_end(ap);
51  UNREACHABLE();
52}
53
54class OatTest : public CommonCompilerTest {
55 protected:
56  static const bool kCompile = false;  // DISABLED_ due to the time to compile libcore
57
58  void CheckMethod(ArtMethod* method,
59                   const OatFile::OatMethod& oat_method,
60                   const DexFile& dex_file)
61      SHARED_REQUIRES(Locks::mutator_lock_) {
62    const CompiledMethod* compiled_method =
63        compiler_driver_->GetCompiledMethod(MethodReference(&dex_file,
64                                                            method->GetDexMethodIndex()));
65
66    if (compiled_method == nullptr) {
67      EXPECT_TRUE(oat_method.GetQuickCode() == nullptr) << PrettyMethod(method) << " "
68                                                        << oat_method.GetQuickCode();
69      EXPECT_EQ(oat_method.GetFrameSizeInBytes(), 0U);
70      EXPECT_EQ(oat_method.GetCoreSpillMask(), 0U);
71      EXPECT_EQ(oat_method.GetFpSpillMask(), 0U);
72    } else {
73      const void* quick_oat_code = oat_method.GetQuickCode();
74      EXPECT_TRUE(quick_oat_code != nullptr) << PrettyMethod(method);
75      EXPECT_EQ(oat_method.GetFrameSizeInBytes(), compiled_method->GetFrameSizeInBytes());
76      EXPECT_EQ(oat_method.GetCoreSpillMask(), compiled_method->GetCoreSpillMask());
77      EXPECT_EQ(oat_method.GetFpSpillMask(), compiled_method->GetFpSpillMask());
78      uintptr_t oat_code_aligned = RoundDown(reinterpret_cast<uintptr_t>(quick_oat_code), 2);
79      quick_oat_code = reinterpret_cast<const void*>(oat_code_aligned);
80      ArrayRef<const uint8_t> quick_code = compiled_method->GetQuickCode();
81      EXPECT_FALSE(quick_code.empty());
82      size_t code_size = quick_code.size() * sizeof(quick_code[0]);
83      EXPECT_EQ(0, memcmp(quick_oat_code, &quick_code[0], code_size))
84          << PrettyMethod(method) << " " << code_size;
85      CHECK_EQ(0, memcmp(quick_oat_code, &quick_code[0], code_size));
86    }
87  }
88
89  void SetupCompiler(Compiler::Kind compiler_kind,
90                     InstructionSet insn_set,
91                     const std::vector<std::string>& compiler_options,
92                     /*out*/std::string* error_msg) {
93    ASSERT_TRUE(error_msg != nullptr);
94    insn_features_.reset(InstructionSetFeatures::FromVariant(insn_set, "default", error_msg));
95    ASSERT_TRUE(insn_features_ != nullptr) << error_msg;
96    compiler_options_.reset(new CompilerOptions);
97    for (const std::string& option : compiler_options) {
98      compiler_options_->ParseCompilerOption(option, Usage);
99    }
100    verification_results_.reset(new VerificationResults(compiler_options_.get()));
101    method_inliner_map_.reset(new DexFileToMethodInlinerMap);
102    callbacks_.reset(new QuickCompilerCallbacks(verification_results_.get(),
103                                                method_inliner_map_.get(),
104                                                CompilerCallbacks::CallbackMode::kCompileApp));
105    Runtime::Current()->SetCompilerCallbacks(callbacks_.get());
106    timer_.reset(new CumulativeLogger("Compilation times"));
107    compiler_driver_.reset(new CompilerDriver(compiler_options_.get(),
108                                              verification_results_.get(),
109                                              method_inliner_map_.get(),
110                                              compiler_kind,
111                                              insn_set,
112                                              insn_features_.get(),
113                                              false,
114                                              nullptr,
115                                              nullptr,
116                                              nullptr,
117                                              2,
118                                              true,
119                                              true,
120                                              "",
121                                              false,
122                                              timer_.get(),
123                                              -1,
124                                              "",
125                                              nullptr));
126  }
127
128  bool WriteElf(File* file,
129                const std::vector<const DexFile*>& dex_files,
130                SafeMap<std::string, std::string>& key_value_store) {
131    TimingLogger timings("WriteElf", false, false);
132    OatWriter oat_writer(dex_files,
133                         42U,
134                         4096U,
135                         0,
136                         compiler_driver_.get(),
137                         nullptr,
138                         /*compiling_boot_image*/false,
139                         &timings,
140                         &key_value_store);
141    std::unique_ptr<ElfWriter> elf_writer = CreateElfWriterQuick(
142        compiler_driver_->GetInstructionSet(),
143        &compiler_driver_->GetCompilerOptions(),
144        file);
145
146    elf_writer->Start();
147
148    OutputStream* rodata = elf_writer->StartRoData();
149    if (!oat_writer.WriteRodata(rodata)) {
150      return false;
151    }
152    elf_writer->EndRoData(rodata);
153
154    OutputStream* text = elf_writer->StartText();
155    if (!oat_writer.WriteCode(text)) {
156      return false;
157    }
158    elf_writer->EndText(text);
159
160    elf_writer->SetBssSize(oat_writer.GetBssSize());
161    elf_writer->WriteDynamicSection();
162    elf_writer->WriteDebugInfo(oat_writer.GetMethodDebugInfo());
163    elf_writer->WritePatchLocations(oat_writer.GetAbsolutePatchLocations());
164
165    return elf_writer->End();
166  }
167
168  std::unique_ptr<const InstructionSetFeatures> insn_features_;
169  std::unique_ptr<QuickCompilerCallbacks> callbacks_;
170};
171
172TEST_F(OatTest, WriteRead) {
173  TimingLogger timings("OatTest::WriteRead", false, false);
174  ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
175
176  // TODO: make selectable.
177  Compiler::Kind compiler_kind = Compiler::kQuick;
178  InstructionSet insn_set = kIsTargetBuild ? kThumb2 : kX86;
179  std::string error_msg;
180  SetupCompiler(compiler_kind, insn_set, std::vector<std::string>(), /*out*/ &error_msg);
181
182  jobject class_loader = nullptr;
183  if (kCompile) {
184    TimingLogger timings2("OatTest::WriteRead", false, false);
185    compiler_driver_->SetDexFilesForOatFile(class_linker->GetBootClassPath());
186    compiler_driver_->CompileAll(class_loader, class_linker->GetBootClassPath(), &timings2);
187  }
188
189  ScratchFile tmp;
190  SafeMap<std::string, std::string> key_value_store;
191  key_value_store.Put(OatHeader::kImageLocationKey, "lue.art");
192  bool success = WriteElf(tmp.GetFile(), class_linker->GetBootClassPath(), key_value_store);
193  ASSERT_TRUE(success);
194
195  if (kCompile) {  // OatWriter strips the code, regenerate to compare
196    compiler_driver_->CompileAll(class_loader, class_linker->GetBootClassPath(), &timings);
197  }
198  std::unique_ptr<OatFile> oat_file(OatFile::Open(tmp.GetFilename(), tmp.GetFilename(), nullptr,
199                                                  nullptr, false, nullptr, &error_msg));
200  ASSERT_TRUE(oat_file.get() != nullptr) << error_msg;
201  const OatHeader& oat_header = oat_file->GetOatHeader();
202  ASSERT_TRUE(oat_header.IsValid());
203  ASSERT_EQ(class_linker->GetBootClassPath().size(), oat_header.GetDexFileCount());  // core
204  ASSERT_EQ(42U, oat_header.GetImageFileLocationOatChecksum());
205  ASSERT_EQ(4096U, oat_header.GetImageFileLocationOatDataBegin());
206  ASSERT_EQ("lue.art", std::string(oat_header.GetStoreValueByKey(OatHeader::kImageLocationKey)));
207
208  ASSERT_TRUE(java_lang_dex_file_ != nullptr);
209  const DexFile& dex_file = *java_lang_dex_file_;
210  uint32_t dex_file_checksum = dex_file.GetLocationChecksum();
211  const OatFile::OatDexFile* oat_dex_file = oat_file->GetOatDexFile(dex_file.GetLocation().c_str(),
212                                                                    &dex_file_checksum);
213  ASSERT_TRUE(oat_dex_file != nullptr);
214  CHECK_EQ(dex_file.GetLocationChecksum(), oat_dex_file->GetDexFileLocationChecksum());
215  ScopedObjectAccess soa(Thread::Current());
216  auto pointer_size = class_linker->GetImagePointerSize();
217  for (size_t i = 0; i < dex_file.NumClassDefs(); i++) {
218    const DexFile::ClassDef& class_def = dex_file.GetClassDef(i);
219    const uint8_t* class_data = dex_file.GetClassData(class_def);
220
221    size_t num_virtual_methods = 0;
222    if (class_data != nullptr) {
223      ClassDataItemIterator it(dex_file, class_data);
224      num_virtual_methods = it.NumVirtualMethods();
225    }
226
227    const char* descriptor = dex_file.GetClassDescriptor(class_def);
228    mirror::Class* klass = class_linker->FindClass(soa.Self(),
229                                                   descriptor,
230                                                   ScopedNullHandle<mirror::ClassLoader>());
231
232    const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(i);
233    CHECK_EQ(mirror::Class::Status::kStatusNotReady, oat_class.GetStatus()) << descriptor;
234    CHECK_EQ(kCompile ? OatClassType::kOatClassAllCompiled : OatClassType::kOatClassNoneCompiled,
235             oat_class.GetType()) << descriptor;
236
237    size_t method_index = 0;
238    for (auto& m : klass->GetDirectMethods(pointer_size)) {
239      CheckMethod(&m, oat_class.GetOatMethod(method_index), dex_file);
240      ++method_index;
241    }
242    size_t visited_virtuals = 0;
243    // TODO We should also check copied methods in this test.
244    for (auto& m : klass->GetDeclaredVirtualMethods(pointer_size)) {
245      EXPECT_FALSE(m.IsMiranda());
246      CheckMethod(&m, oat_class.GetOatMethod(method_index), dex_file);
247      ++method_index;
248      ++visited_virtuals;
249    }
250    EXPECT_EQ(visited_virtuals, num_virtual_methods);
251  }
252}
253
254TEST_F(OatTest, OatHeaderSizeCheck) {
255  // If this test is failing and you have to update these constants,
256  // it is time to update OatHeader::kOatVersion
257  EXPECT_EQ(72U, sizeof(OatHeader));
258  EXPECT_EQ(4U, sizeof(OatMethodOffsets));
259  EXPECT_EQ(28U, sizeof(OatQuickMethodHeader));
260  EXPECT_EQ(132 * GetInstructionSetPointerSize(kRuntimeISA), sizeof(QuickEntryPoints));
261}
262
263TEST_F(OatTest, OatHeaderIsValid) {
264    InstructionSet insn_set = kX86;
265    std::string error_msg;
266    std::unique_ptr<const InstructionSetFeatures> insn_features(
267        InstructionSetFeatures::FromVariant(insn_set, "default", &error_msg));
268    ASSERT_TRUE(insn_features.get() != nullptr) << error_msg;
269    std::unique_ptr<OatHeader> oat_header(OatHeader::Create(insn_set,
270                                                            insn_features.get(),
271                                                            0u,
272                                                            nullptr));
273    ASSERT_NE(oat_header.get(), nullptr);
274    ASSERT_TRUE(oat_header->IsValid());
275
276    char* magic = const_cast<char*>(oat_header->GetMagic());
277    strcpy(magic, "");  // bad magic
278    ASSERT_FALSE(oat_header->IsValid());
279    strcpy(magic, "oat\n000");  // bad version
280    ASSERT_FALSE(oat_header->IsValid());
281}
282
283TEST_F(OatTest, EmptyTextSection) {
284  TimingLogger timings("OatTest::EmptyTextSection", false, false);
285
286  // TODO: make selectable.
287  Compiler::Kind compiler_kind = Compiler::kQuick;
288  InstructionSet insn_set = kRuntimeISA;
289  if (insn_set == kArm) insn_set = kThumb2;
290  std::string error_msg;
291  std::vector<std::string> compiler_options;
292  compiler_options.push_back("--compiler-filter=verify-at-runtime");
293  SetupCompiler(compiler_kind, insn_set, compiler_options, /*out*/ &error_msg);
294
295  jobject class_loader;
296  {
297    ScopedObjectAccess soa(Thread::Current());
298    class_loader = LoadDex("Main");
299  }
300  ASSERT_TRUE(class_loader != nullptr);
301  std::vector<const DexFile*> dex_files = GetDexFiles(class_loader);
302  ASSERT_TRUE(!dex_files.empty());
303
304  ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
305  for (const DexFile* dex_file : dex_files) {
306    ScopedObjectAccess soa(Thread::Current());
307    class_linker->RegisterDexFile(
308        *dex_file,
309        class_linker->GetOrCreateAllocatorForClassLoader(
310            soa.Decode<mirror::ClassLoader*>(class_loader)));
311  }
312  compiler_driver_->SetDexFilesForOatFile(dex_files);
313  compiler_driver_->CompileAll(class_loader, dex_files, &timings);
314
315  ScratchFile tmp;
316  SafeMap<std::string, std::string> key_value_store;
317  key_value_store.Put(OatHeader::kImageLocationKey, "test.art");
318  bool success = WriteElf(tmp.GetFile(), dex_files, key_value_store);
319  ASSERT_TRUE(success);
320
321  std::unique_ptr<OatFile> oat_file(OatFile::Open(tmp.GetFilename(),
322                                                  tmp.GetFilename(),
323                                                  nullptr,
324                                                  nullptr,
325                                                  false,
326                                                  nullptr,
327                                                  &error_msg));
328  ASSERT_TRUE(oat_file != nullptr);
329  EXPECT_LT(static_cast<size_t>(oat_file->Size()), static_cast<size_t>(tmp.GetFile()->GetLength()));
330}
331
332}  // namespace art
333