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