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