oat_test.cc revision d582fa4ea62083a7598dded5b82dc2198b3daac7 
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 "class_linker.h"
19#include "common_compiler_test.h"
20#include "compiler.h"
21#include "dex/verification_results.h"
22#include "dex/quick/dex_file_to_method_inliner_map.h"
23#include "dex/quick_compiler_callbacks.h"
24#include "entrypoints/quick/quick_entrypoints.h"
25#include "mirror/art_method-inl.h"
26#include "mirror/class-inl.h"
27#include "mirror/object_array-inl.h"
28#include "mirror/object-inl.h"
29#include "oat_file-inl.h"
30#include "oat_writer.h"
31#include "scoped_thread_state_change.h"
32#include "vector_output_stream.h"
33
34namespace art {
35
36class OatTest : public CommonCompilerTest {
37 protected:
38  static const bool kCompile = false;  // DISABLED_ due to the time to compile libcore
39
40  void CheckMethod(mirror::ArtMethod* method,
41                   const OatFile::OatMethod& oat_method,
42                   const DexFile* dex_file)
43      SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
44    const CompiledMethod* compiled_method =
45        compiler_driver_->GetCompiledMethod(MethodReference(dex_file,
46                                                            method->GetDexMethodIndex()));
47
48    if (compiled_method == nullptr) {
49      EXPECT_TRUE(oat_method.GetQuickCode() == nullptr) << PrettyMethod(method) << " "
50                                                        << oat_method.GetQuickCode();
51      EXPECT_TRUE(oat_method.GetPortableCode() == nullptr) << PrettyMethod(method) << " "
52                                                           << oat_method.GetPortableCode();
53      EXPECT_EQ(oat_method.GetFrameSizeInBytes(), 0U);
54      EXPECT_EQ(oat_method.GetCoreSpillMask(), 0U);
55      EXPECT_EQ(oat_method.GetFpSpillMask(), 0U);
56    } else {
57      const void* quick_oat_code = oat_method.GetQuickCode();
58      if (quick_oat_code != nullptr) {
59        EXPECT_EQ(oat_method.GetFrameSizeInBytes(), compiled_method->GetFrameSizeInBytes());
60        EXPECT_EQ(oat_method.GetCoreSpillMask(), compiled_method->GetCoreSpillMask());
61        EXPECT_EQ(oat_method.GetFpSpillMask(), compiled_method->GetFpSpillMask());
62        uintptr_t oat_code_aligned = RoundDown(reinterpret_cast<uintptr_t>(quick_oat_code), 2);
63        quick_oat_code = reinterpret_cast<const void*>(oat_code_aligned);
64        const std::vector<uint8_t>* quick_code = compiled_method->GetQuickCode();
65        EXPECT_TRUE(quick_code != nullptr);
66        size_t code_size = quick_code->size() * sizeof(quick_code[0]);
67        EXPECT_EQ(0, memcmp(quick_oat_code, &quick_code[0], code_size))
68            << PrettyMethod(method) << " " << code_size;
69        CHECK_EQ(0, memcmp(quick_oat_code, &quick_code[0], code_size));
70      } else {
71        const void* portable_oat_code = oat_method.GetPortableCode();
72        EXPECT_TRUE(portable_oat_code != nullptr) << PrettyMethod(method);
73        EXPECT_EQ(oat_method.GetFrameSizeInBytes(), 0U);
74        EXPECT_EQ(oat_method.GetCoreSpillMask(), 0U);
75        EXPECT_EQ(oat_method.GetFpSpillMask(), 0U);
76        uintptr_t oat_code_aligned = RoundDown(reinterpret_cast<uintptr_t>(portable_oat_code), 2);
77        portable_oat_code = reinterpret_cast<const void*>(oat_code_aligned);
78        const std::vector<uint8_t>* portable_code = compiled_method->GetPortableCode();
79        EXPECT_TRUE(portable_code != nullptr);
80        size_t code_size = portable_code->size() * sizeof(portable_code[0]);
81        EXPECT_EQ(0, memcmp(quick_oat_code, &portable_code[0], code_size))
82            << PrettyMethod(method) << " " << code_size;
83        CHECK_EQ(0, memcmp(quick_oat_code, &portable_code[0], code_size));
84      }
85    }
86  }
87};
88
89TEST_F(OatTest, WriteRead) {
90  TimingLogger timings("OatTest::WriteRead", false, false);
91  ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
92
93  // TODO: make selectable.
94  Compiler::Kind compiler_kind = kUsePortableCompiler
95      ? Compiler::kPortable
96      : Compiler::kQuick;
97  InstructionSet insn_set = kIsTargetBuild ? kThumb2 : kX86;
98
99  std::string error_msg;
100  std::unique_ptr<const InstructionSetFeatures> insn_features(
101      InstructionSetFeatures::FromVariant(insn_set, "default", &error_msg));
102  ASSERT_TRUE(insn_features.get() != nullptr) << error_msg;
103  compiler_options_.reset(new CompilerOptions);
104  verification_results_.reset(new VerificationResults(compiler_options_.get()));
105  method_inliner_map_.reset(new DexFileToMethodInlinerMap);
106  callbacks_.reset(new QuickCompilerCallbacks(verification_results_.get(),
107                                              method_inliner_map_.get()));
108  timer_.reset(new CumulativeLogger("Compilation times"));
109  compiler_driver_.reset(new CompilerDriver(compiler_options_.get(),
110                                            verification_results_.get(),
111                                            method_inliner_map_.get(),
112                                            compiler_kind, insn_set,
113                                            insn_features.get(), false, nullptr, nullptr, 2, true,
114                                            true, timer_.get(), ""));
115  jobject class_loader = nullptr;
116  if (kCompile) {
117    TimingLogger timings2("OatTest::WriteRead", false, false);
118    compiler_driver_->CompileAll(class_loader, class_linker->GetBootClassPath(), &timings2);
119  }
120
121  ScratchFile tmp;
122  SafeMap<std::string, std::string> key_value_store;
123  key_value_store.Put(OatHeader::kImageLocationKey, "lue.art");
124  OatWriter oat_writer(class_linker->GetBootClassPath(),
125                       42U,
126                       4096U,
127                       0,
128                       compiler_driver_.get(),
129                       nullptr,
130                       &timings,
131                       &key_value_store);
132  bool success = compiler_driver_->WriteElf(GetTestAndroidRoot(),
133                                            !kIsTargetBuild,
134                                            class_linker->GetBootClassPath(),
135                                            &oat_writer,
136                                            tmp.GetFile());
137  ASSERT_TRUE(success);
138
139  if (kCompile) {  // OatWriter strips the code, regenerate to compare
140    compiler_driver_->CompileAll(class_loader, class_linker->GetBootClassPath(), &timings);
141  }
142  std::unique_ptr<OatFile> oat_file(OatFile::Open(tmp.GetFilename(), tmp.GetFilename(), nullptr,
143                                                  nullptr, false, &error_msg));
144  ASSERT_TRUE(oat_file.get() != nullptr) << error_msg;
145  const OatHeader& oat_header = oat_file->GetOatHeader();
146  ASSERT_TRUE(oat_header.IsValid());
147  ASSERT_EQ(1U, oat_header.GetDexFileCount());  // core
148  ASSERT_EQ(42U, oat_header.GetImageFileLocationOatChecksum());
149  ASSERT_EQ(4096U, oat_header.GetImageFileLocationOatDataBegin());
150  ASSERT_EQ("lue.art", std::string(oat_header.GetStoreValueByKey(OatHeader::kImageLocationKey)));
151
152  const DexFile* dex_file = java_lang_dex_file_;
153  uint32_t dex_file_checksum = dex_file->GetLocationChecksum();
154  const OatFile::OatDexFile* oat_dex_file = oat_file->GetOatDexFile(dex_file->GetLocation().c_str(),
155                                                                    &dex_file_checksum);
156  ASSERT_TRUE(oat_dex_file != nullptr);
157  CHECK_EQ(dex_file->GetLocationChecksum(), oat_dex_file->GetDexFileLocationChecksum());
158  ScopedObjectAccess soa(Thread::Current());
159  for (size_t i = 0; i < dex_file->NumClassDefs(); i++) {
160    const DexFile::ClassDef& class_def = dex_file->GetClassDef(i);
161    const uint8_t* class_data = dex_file->GetClassData(class_def);
162    size_t num_virtual_methods = 0;
163    if (class_data != nullptr) {
164      ClassDataItemIterator it(*dex_file, class_data);
165      num_virtual_methods = it.NumVirtualMethods();
166    }
167    const char* descriptor = dex_file->GetClassDescriptor(class_def);
168    StackHandleScope<1> hs(soa.Self());
169    mirror::Class* klass = class_linker->FindClass(soa.Self(), descriptor,
170                                                   NullHandle<mirror::ClassLoader>());
171
172    const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(i);
173    CHECK_EQ(mirror::Class::Status::kStatusNotReady, oat_class.GetStatus()) << descriptor;
174    CHECK_EQ(kCompile ? OatClassType::kOatClassAllCompiled : OatClassType::kOatClassNoneCompiled,
175             oat_class.GetType()) << descriptor;
176
177    size_t method_index = 0;
178    for (size_t j = 0; j < klass->NumDirectMethods(); j++, method_index++) {
179      CheckMethod(klass->GetDirectMethod(j),
180                  oat_class.GetOatMethod(method_index), dex_file);
181    }
182    for (size_t j = 0; j < num_virtual_methods; j++, method_index++) {
183      CheckMethod(klass->GetVirtualMethod(j),
184                  oat_class.GetOatMethod(method_index), dex_file);
185    }
186  }
187}
188
189TEST_F(OatTest, OatHeaderSizeCheck) {
190  // If this test is failing and you have to update these constants,
191  // it is time to update OatHeader::kOatVersion
192  EXPECT_EQ(84U, sizeof(OatHeader));
193  EXPECT_EQ(8U, sizeof(OatMethodOffsets));
194  EXPECT_EQ(24U, sizeof(OatQuickMethodHeader));
195  EXPECT_EQ(91 * GetInstructionSetPointerSize(kRuntimeISA), sizeof(QuickEntryPoints));
196}
197
198TEST_F(OatTest, OatHeaderIsValid) {
199    InstructionSet insn_set = kX86;
200    std::string error_msg;
201    std::unique_ptr<const InstructionSetFeatures> insn_features(
202        InstructionSetFeatures::FromVariant(insn_set, "default", &error_msg));
203    ASSERT_TRUE(insn_features.get() != nullptr) << error_msg;
204    std::vector<const DexFile*> dex_files;
205    uint32_t image_file_location_oat_checksum = 0;
206    uint32_t image_file_location_oat_begin = 0;
207    std::unique_ptr<OatHeader> oat_header(OatHeader::Create(insn_set,
208                                                            insn_features.get(),
209                                                            &dex_files,
210                                                            image_file_location_oat_checksum,
211                                                            image_file_location_oat_begin,
212                                                            nullptr));
213    ASSERT_NE(oat_header.get(), nullptr);
214    ASSERT_TRUE(oat_header->IsValid());
215
216    char* magic = const_cast<char*>(oat_header->GetMagic());
217    strcpy(magic, "");  // bad magic
218    ASSERT_FALSE(oat_header->IsValid());
219    strcpy(magic, "oat\n000");  // bad version
220    ASSERT_FALSE(oat_header->IsValid());
221}
222
223}  // namespace art
224