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