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