blob: 074775633fd19618380dfa49f4500b8c301d7231 [file] [log] [blame]
Elliott Hughes2faa5f12012-01-30 14:42:07 -08001/*
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 */
Brian Carlstrome24fa612011-09-29 00:53:55 -070016
Ian Rogersd582fa42014-11-05 23:46:43 -080017#include "arch/instruction_set_features.h"
Mathieu Chartiere401d142015-04-22 13:56:20 -070018#include "art_method-inl.h"
Andreas Gampe53c913b2014-08-12 23:19:23 -070019#include "class_linker.h"
Brian Carlstroma1ce1fe2014-02-24 23:23:58 -080020#include "common_compiler_test.h"
Vladimir Marko20f85592015-03-19 10:07:02 +000021#include "compiled_method.h"
Ian Rogerse63db272014-07-15 15:36:11 -070022#include "compiler.h"
Mathieu Chartier5bdab122015-01-26 18:30:19 -080023#include "dex/pass_manager.h"
Ian Rogerse63db272014-07-15 15:36:11 -070024#include "dex/quick/dex_file_to_method_inliner_map.h"
25#include "dex/quick_compiler_callbacks.h"
Mathieu Chartier5bdab122015-01-26 18:30:19 -080026#include "dex/verification_results.h"
Vladimir Marko20f85592015-03-19 10:07:02 +000027#include "driver/compiler_driver.h"
28#include "driver/compiler_options.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010029#include "entrypoints/quick/quick_entrypoints.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080030#include "mirror/class-inl.h"
Brian Carlstroma1ce1fe2014-02-24 23:23:58 -080031#include "mirror/object_array-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070032#include "mirror/object-inl.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010033#include "oat_file-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070034#include "oat_writer.h"
35#include "scoped_thread_state_change.h"
Brian Carlstrom700c8d32012-11-05 10:42:02 -080036#include "vector_output_stream.h"
Brian Carlstrome24fa612011-09-29 00:53:55 -070037
Brian Carlstrome24fa612011-09-29 00:53:55 -070038namespace art {
39
Brian Carlstroma1ce1fe2014-02-24 23:23:58 -080040class OatTest : public CommonCompilerTest {
Logan Chieneeb7edf2012-03-09 20:38:39 +080041 protected:
Brian Carlstromba150c32013-08-27 17:31:03 -070042 static const bool kCompile = false; // DISABLED_ due to the time to compile libcore
43
Mathieu Chartiere401d142015-04-22 13:56:20 -070044 void CheckMethod(ArtMethod* method,
Logan Chieneeb7edf2012-03-09 20:38:39 +080045 const OatFile::OatMethod& oat_method,
Richard Uhlerfbef44d2014-12-23 09:48:51 -080046 const DexFile& dex_file)
Ian Rogersb726dcb2012-09-05 08:57:23 -070047 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Logan Chieneeb7edf2012-03-09 20:38:39 +080048 const CompiledMethod* compiled_method =
Richard Uhlerfbef44d2014-12-23 09:48:51 -080049 compiler_driver_->GetCompiledMethod(MethodReference(&dex_file,
Brian Carlstrom51c24672013-07-11 16:00:56 -070050 method->GetDexMethodIndex()));
Logan Chieneeb7edf2012-03-09 20:38:39 +080051
Ian Rogersd4c4d952014-10-16 20:31:53 -070052 if (compiled_method == nullptr) {
53 EXPECT_TRUE(oat_method.GetQuickCode() == nullptr) << PrettyMethod(method) << " "
54 << oat_method.GetQuickCode();
Ian Rogersef7d42f2014-01-06 12:55:46 -080055 EXPECT_EQ(oat_method.GetFrameSizeInBytes(), 0U);
Logan Chieneeb7edf2012-03-09 20:38:39 +080056 EXPECT_EQ(oat_method.GetCoreSpillMask(), 0U);
57 EXPECT_EQ(oat_method.GetFpSpillMask(), 0U);
58 } else {
Ian Rogersef7d42f2014-01-06 12:55:46 -080059 const void* quick_oat_code = oat_method.GetQuickCode();
Elliott Hughes956af0f2014-12-11 14:34:28 -080060 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);
Andreas Gampee21dc3d2014-12-08 16:59:43 -080066 const SwapVector<uint8_t>* quick_code = compiled_method->GetQuickCode();
Elliott Hughes956af0f2014-12-11 14:34:28 -080067 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));
Logan Chieneeb7edf2012-03-09 20:38:39 +080072 }
73 }
74};
Brian Carlstrome24fa612011-09-29 00:53:55 -070075
76TEST_F(OatTest, WriteRead) {
Brian Carlstroma1ce1fe2014-02-24 23:23:58 -080077 TimingLogger timings("OatTest::WriteRead", false, false);
Jesse Wilson254db0f2011-11-16 16:44:11 -050078 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
Brian Carlstrome24fa612011-09-29 00:53:55 -070079
Ian Rogersef7d42f2014-01-06 12:55:46 -080080 // TODO: make selectable.
Elliott Hughes956af0f2014-12-11 14:34:28 -080081 Compiler::Kind compiler_kind = Compiler::kQuick;
Ian Rogersa073c672013-07-30 17:43:55 -070082 InstructionSet insn_set = kIsTargetBuild ? kThumb2 : kX86;
Dave Allison70202782013-10-22 17:52:19 -070083
Ian Rogers6f3dbba2014-10-14 17:41:57 -070084 std::string error_msg;
85 std::unique_ptr<const InstructionSetFeatures> insn_features(
Ian Rogersd582fa42014-11-05 23:46:43 -080086 InstructionSetFeatures::FromVariant(insn_set, "default", &error_msg));
Ian Rogers6f3dbba2014-10-14 17:41:57 -070087 ASSERT_TRUE(insn_features.get() != nullptr) << error_msg;
Brian Carlstrom6449c622014-02-10 23:48:36 -080088 compiler_options_.reset(new CompilerOptions);
89 verification_results_.reset(new VerificationResults(compiler_options_.get()));
Nicolas Geoffrayf5df8972014-02-14 18:37:08 +000090 method_inliner_map_.reset(new DexFileToMethodInlinerMap);
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +000091 timer_.reset(new CumulativeLogger("Compilation times"));
Brian Carlstrom6449c622014-02-10 23:48:36 -080092 compiler_driver_.reset(new CompilerDriver(compiler_options_.get(),
93 verification_results_.get(),
Sebastien Hertz102a8f22013-12-18 11:41:30 +010094 method_inliner_map_.get(),
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000095 compiler_kind, insn_set,
Andreas Gampe70bef0d2015-04-15 02:37:28 -070096 insn_features.get(), false, nullptr, nullptr, nullptr,
97 2, true, true, "", timer_.get(), -1, ""));
Ian Rogersd4c4d952014-10-16 20:31:53 -070098 jobject class_loader = nullptr;
Brian Carlstromba150c32013-08-27 17:31:03 -070099 if (kCompile) {
Andreas Gampe277ccbd2014-11-03 21:36:10 -0800100 TimingLogger timings2("OatTest::WriteRead", false, false);
101 compiler_driver_->CompileAll(class_loader, class_linker->GetBootClassPath(), &timings2);
Brian Carlstrome24fa612011-09-29 00:53:55 -0700102 }
103
104 ScratchFile tmp;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700105 SafeMap<std::string, std::string> key_value_store;
106 key_value_store.Put(OatHeader::kImageLocationKey, "lue.art");
Brian Carlstromc50d8e12013-07-23 22:35:16 -0700107 OatWriter oat_writer(class_linker->GetBootClassPath(),
108 42U,
109 4096U,
Alex Lighta59dd802014-07-02 16:28:08 -0700110 0,
Ian Rogersca368cb2013-11-15 15:52:08 -0800111 compiler_driver_.get(),
Vladimir Markof4da6752014-08-01 19:04:18 +0100112 nullptr,
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700113 &timings,
114 &key_value_store);
Brian Carlstromc50d8e12013-07-23 22:35:16 -0700115 bool success = compiler_driver_->WriteElf(GetTestAndroidRoot(),
116 !kIsTargetBuild,
117 class_linker->GetBootClassPath(),
Ian Rogers3d504072014-03-01 09:16:49 -0800118 &oat_writer,
Brian Carlstromc50d8e12013-07-23 22:35:16 -0700119 tmp.GetFile());
120 ASSERT_TRUE(success);
Brian Carlstrome24fa612011-09-29 00:53:55 -0700121
Brian Carlstromba150c32013-08-27 17:31:03 -0700122 if (kCompile) { // OatWriter strips the code, regenerate to compare
Ian Rogers3d504072014-03-01 09:16:49 -0800123 compiler_driver_->CompileAll(class_loader, class_linker->GetBootClassPath(), &timings);
Brian Carlstrome24fa612011-09-29 00:53:55 -0700124 }
Ian Rogersd4c4d952014-10-16 20:31:53 -0700125 std::unique_ptr<OatFile> oat_file(OatFile::Open(tmp.GetFilename(), tmp.GetFilename(), nullptr,
Richard Uhlere5fed032015-03-18 08:21:11 -0700126 nullptr, false, nullptr, &error_msg));
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700127 ASSERT_TRUE(oat_file.get() != nullptr) << error_msg;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700128 const OatHeader& oat_header = oat_file->GetOatHeader();
Brian Carlstromf852fb22012-10-19 11:01:58 -0700129 ASSERT_TRUE(oat_header.IsValid());
Brian Carlstrom919b11c2013-08-30 13:30:36 -0700130 ASSERT_EQ(1U, oat_header.GetDexFileCount()); // core
Brian Carlstrom28db0122012-10-18 16:20:41 -0700131 ASSERT_EQ(42U, oat_header.GetImageFileLocationOatChecksum());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800132 ASSERT_EQ(4096U, oat_header.GetImageFileLocationOatDataBegin());
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700133 ASSERT_EQ("lue.art", std::string(oat_header.GetStoreValueByKey(OatHeader::kImageLocationKey)));
Brian Carlstrome24fa612011-09-29 00:53:55 -0700134
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800135 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(),
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700139 &dex_file_checksum);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700140 ASSERT_TRUE(oat_dex_file != nullptr);
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800141 CHECK_EQ(dex_file.GetLocationChecksum(), oat_dex_file->GetDexFileLocationChecksum());
Vladimir Markof4da6752014-08-01 19:04:18 +0100142 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartiere401d142015-04-22 13:56:20 -0700143 auto pointer_size = class_linker->GetImagePointerSize();
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800144 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);
Mathieu Chartiere401d142015-04-22 13:56:20 -0700147
Brian Carlstromba150c32013-08-27 17:31:03 -0700148 size_t num_virtual_methods = 0;
Ian Rogersd4c4d952014-10-16 20:31:53 -0700149 if (class_data != nullptr) {
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800150 ClassDataItemIterator it(dex_file, class_data);
Ian Rogers0571d352011-11-03 19:51:38 -0700151 num_virtual_methods = it.NumVirtualMethods();
152 }
Mathieu Chartiere401d142015-04-22 13:56:20 -0700153
Richard Uhlerfbef44d2014-12-23 09:48:51 -0800154 const char* descriptor = dex_file.GetClassDescriptor(class_def);
Mathieu Chartier0cd81352014-05-22 16:48:55 -0700155 mirror::Class* klass = class_linker->FindClass(soa.Self(), descriptor,
156 NullHandle<mirror::ClassLoader>());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700157
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100158 const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(i);
159 CHECK_EQ(mirror::Class::Status::kStatusNotReady, oat_class.GetStatus()) << descriptor;
Brian Carlstromba150c32013-08-27 17:31:03 -0700160 CHECK_EQ(kCompile ? OatClassType::kOatClassAllCompiled : OatClassType::kOatClassNoneCompiled,
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100161 oat_class.GetType()) << descriptor;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700162
163 size_t method_index = 0;
Mathieu Chartiere401d142015-04-22 13:56:20 -0700164 for (auto& m : klass->GetDirectMethods(pointer_size)) {
165 CheckMethod(&m, oat_class.GetOatMethod(method_index), dex_file);
166 ++method_index;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700167 }
Mathieu Chartiere401d142015-04-22 13:56:20 -0700168 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 }
Brian Carlstrome24fa612011-09-29 00:53:55 -0700175 }
Mathieu Chartiere401d142015-04-22 13:56:20 -0700176 EXPECT_EQ(visited_virtuals, num_virtual_methods);
Brian Carlstrome24fa612011-09-29 00:53:55 -0700177 }
178}
179
Brian Carlstrom341df942012-06-27 12:29:22 -0700180TEST_F(OatTest, OatHeaderSizeCheck) {
181 // If this test is failing and you have to update these constants,
182 // it is time to update OatHeader::kOatVersion
Elliott Hughes956af0f2014-12-11 14:34:28 -0800183 EXPECT_EQ(72U, sizeof(OatHeader));
Mathieu Chartier957ca1c2014-11-21 16:51:29 -0800184 EXPECT_EQ(4U, sizeof(OatMethodOffsets));
185 EXPECT_EQ(28U, sizeof(OatQuickMethodHeader));
Hiroshi Yamauchi1cc71eb2015-05-07 10:47:27 -0700186 EXPECT_EQ(112 * GetInstructionSetPointerSize(kRuntimeISA), sizeof(QuickEntryPoints));
Brian Carlstrom341df942012-06-27 12:29:22 -0700187}
188
Brian Carlstromf852fb22012-10-19 11:01:58 -0700189TEST_F(OatTest, OatHeaderIsValid) {
Ian Rogers6f3dbba2014-10-14 17:41:57 -0700190 InstructionSet insn_set = kX86;
191 std::string error_msg;
192 std::unique_ptr<const InstructionSetFeatures> insn_features(
Ian Rogersd582fa42014-11-05 23:46:43 -0800193 InstructionSetFeatures::FromVariant(insn_set, "default", &error_msg));
Ian Rogers6f3dbba2014-10-14 17:41:57 -0700194 ASSERT_TRUE(insn_features.get() != nullptr) << error_msg;
Brian Carlstromf852fb22012-10-19 11:01:58 -0700195 std::vector<const DexFile*> dex_files;
196 uint32_t image_file_location_oat_checksum = 0;
197 uint32_t image_file_location_oat_begin = 0;
Ian Rogers6f3dbba2014-10-14 17:41:57 -0700198 std::unique_ptr<OatHeader> oat_header(OatHeader::Create(insn_set,
199 insn_features.get(),
Andreas Gampe928f72b2014-09-09 19:53:48 -0700200 &dex_files,
201 image_file_location_oat_checksum,
202 image_file_location_oat_begin,
203 nullptr));
204 ASSERT_NE(oat_header.get(), nullptr);
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700205 ASSERT_TRUE(oat_header->IsValid());
Brian Carlstromf852fb22012-10-19 11:01:58 -0700206
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700207 char* magic = const_cast<char*>(oat_header->GetMagic());
Brian Carlstromf852fb22012-10-19 11:01:58 -0700208 strcpy(magic, ""); // bad magic
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700209 ASSERT_FALSE(oat_header->IsValid());
Brian Carlstrom7934ac22013-07-26 10:54:15 -0700210 strcpy(magic, "oat\n000"); // bad version
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700211 ASSERT_FALSE(oat_header->IsValid());
Brian Carlstromf852fb22012-10-19 11:01:58 -0700212}
213
Brian Carlstrome24fa612011-09-29 00:53:55 -0700214} // namespace art