blob: 80d7b982b4a038dffc0aea94b50e799e454e34e2 [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
Andreas Gampe53c913b2014-08-12 23:19:23 -070017#include "class_linker.h"
Brian Carlstroma1ce1fe2014-02-24 23:23:58 -080018#include "common_compiler_test.h"
Ian Rogerse63db272014-07-15 15:36:11 -070019#include "compiler.h"
20#include "dex/verification_results.h"
21#include "dex/quick/dex_file_to_method_inliner_map.h"
22#include "dex/quick_compiler_callbacks.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010023#include "entrypoints/quick/quick_entrypoints.h"
Brian Carlstromea46f952013-07-30 01:26:50 -070024#include "mirror/art_method-inl.h"
Ian Rogers2dd0e2c2013-01-24 12:42:14 -080025#include "mirror/class-inl.h"
Brian Carlstroma1ce1fe2014-02-24 23:23:58 -080026#include "mirror/object_array-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070027#include "mirror/object-inl.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010028#include "oat_file-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070029#include "oat_writer.h"
30#include "scoped_thread_state_change.h"
Brian Carlstrom700c8d32012-11-05 10:42:02 -080031#include "vector_output_stream.h"
Brian Carlstrome24fa612011-09-29 00:53:55 -070032
Brian Carlstrome24fa612011-09-29 00:53:55 -070033namespace art {
34
Brian Carlstroma1ce1fe2014-02-24 23:23:58 -080035class OatTest : public CommonCompilerTest {
Logan Chieneeb7edf2012-03-09 20:38:39 +080036 protected:
Brian Carlstromba150c32013-08-27 17:31:03 -070037 static const bool kCompile = false; // DISABLED_ due to the time to compile libcore
38
Brian Carlstromea46f952013-07-30 01:26:50 -070039 void CheckMethod(mirror::ArtMethod* method,
Logan Chieneeb7edf2012-03-09 20:38:39 +080040 const OatFile::OatMethod& oat_method,
Ian Rogers00f7d0e2012-07-19 15:28:27 -070041 const DexFile* dex_file)
Ian Rogersb726dcb2012-09-05 08:57:23 -070042 SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) {
Logan Chieneeb7edf2012-03-09 20:38:39 +080043 const CompiledMethod* compiled_method =
Brian Carlstrom51c24672013-07-11 16:00:56 -070044 compiler_driver_->GetCompiledMethod(MethodReference(dex_file,
45 method->GetDexMethodIndex()));
Logan Chieneeb7edf2012-03-09 20:38:39 +080046
47 if (compiled_method == NULL) {
Ian Rogersef7d42f2014-01-06 12:55:46 -080048 EXPECT_TRUE(oat_method.GetQuickCode() == NULL) << PrettyMethod(method) << " "
49 << oat_method.GetQuickCode();
50 EXPECT_TRUE(oat_method.GetPortableCode() == NULL) << PrettyMethod(method) << " "
51 << oat_method.GetPortableCode();
52 EXPECT_EQ(oat_method.GetFrameSizeInBytes(), 0U);
Logan Chieneeb7edf2012-03-09 20:38:39 +080053 EXPECT_EQ(oat_method.GetCoreSpillMask(), 0U);
54 EXPECT_EQ(oat_method.GetFpSpillMask(), 0U);
55 } else {
Ian Rogersef7d42f2014-01-06 12:55:46 -080056 const void* quick_oat_code = oat_method.GetQuickCode();
57 if (quick_oat_code != nullptr) {
58 EXPECT_EQ(oat_method.GetFrameSizeInBytes(), compiled_method->GetFrameSizeInBytes());
59 EXPECT_EQ(oat_method.GetCoreSpillMask(), compiled_method->GetCoreSpillMask());
60 EXPECT_EQ(oat_method.GetFpSpillMask(), compiled_method->GetFpSpillMask());
61 uintptr_t oat_code_aligned = RoundDown(reinterpret_cast<uintptr_t>(quick_oat_code), 2);
62 quick_oat_code = reinterpret_cast<const void*>(oat_code_aligned);
63 const std::vector<uint8_t>* quick_code = compiled_method->GetQuickCode();
64 EXPECT_TRUE(quick_code != nullptr);
65 size_t code_size = quick_code->size() * sizeof(quick_code[0]);
66 EXPECT_EQ(0, memcmp(quick_oat_code, &quick_code[0], code_size))
67 << PrettyMethod(method) << " " << code_size;
68 CHECK_EQ(0, memcmp(quick_oat_code, &quick_code[0], code_size));
69 } else {
70 const void* portable_oat_code = oat_method.GetPortableCode();
71 EXPECT_TRUE(portable_oat_code != nullptr) << PrettyMethod(method);
72 EXPECT_EQ(oat_method.GetFrameSizeInBytes(), 0U);
73 EXPECT_EQ(oat_method.GetCoreSpillMask(), 0U);
74 EXPECT_EQ(oat_method.GetFpSpillMask(), 0U);
75 uintptr_t oat_code_aligned = RoundDown(reinterpret_cast<uintptr_t>(portable_oat_code), 2);
76 portable_oat_code = reinterpret_cast<const void*>(oat_code_aligned);
77 const std::vector<uint8_t>* portable_code = compiled_method->GetPortableCode();
78 EXPECT_TRUE(portable_code != nullptr);
79 size_t code_size = portable_code->size() * sizeof(portable_code[0]);
80 EXPECT_EQ(0, memcmp(quick_oat_code, &portable_code[0], code_size))
81 << PrettyMethod(method) << " " << code_size;
82 CHECK_EQ(0, memcmp(quick_oat_code, &portable_code[0], code_size));
83 }
Logan Chieneeb7edf2012-03-09 20:38:39 +080084 }
85 }
86};
Brian Carlstrome24fa612011-09-29 00:53:55 -070087
88TEST_F(OatTest, WriteRead) {
Brian Carlstroma1ce1fe2014-02-24 23:23:58 -080089 TimingLogger timings("OatTest::WriteRead", false, false);
Jesse Wilson254db0f2011-11-16 16:44:11 -050090 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
Brian Carlstrome24fa612011-09-29 00:53:55 -070091
Ian Rogersef7d42f2014-01-06 12:55:46 -080092 // TODO: make selectable.
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +000093 Compiler::Kind compiler_kind = kUsePortableCompiler
94 ? Compiler::kPortable
95 : Compiler::kQuick;
Ian Rogersa073c672013-07-30 17:43:55 -070096 InstructionSet insn_set = kIsTargetBuild ? kThumb2 : kX86;
Dave Allison70202782013-10-22 17:52:19 -070097
98 InstructionSetFeatures insn_features;
Brian Carlstrom6449c622014-02-10 23:48:36 -080099 compiler_options_.reset(new CompilerOptions);
100 verification_results_.reset(new VerificationResults(compiler_options_.get()));
Nicolas Geoffrayf5df8972014-02-14 18:37:08 +0000101 method_inliner_map_.reset(new DexFileToMethodInlinerMap);
Ian Rogerse63db272014-07-15 15:36:11 -0700102 callbacks_.reset(new QuickCompilerCallbacks(verification_results_.get(),
103 method_inliner_map_.get()));
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +0000104 timer_.reset(new CumulativeLogger("Compilation times"));
Brian Carlstrom6449c622014-02-10 23:48:36 -0800105 compiler_driver_.reset(new CompilerDriver(compiler_options_.get(),
106 verification_results_.get(),
Sebastien Hertz102a8f22013-12-18 11:41:30 +0100107 method_inliner_map_.get(),
Nicolas Geoffrayb34f69a2014-03-07 15:28:39 +0000108 compiler_kind, insn_set,
Nicolas Geoffrayea3fa0b2014-02-10 11:59:41 +0000109 insn_features, false, NULL, 2, true, true,
110 timer_.get()));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700111 jobject class_loader = NULL;
Brian Carlstromba150c32013-08-27 17:31:03 -0700112 if (kCompile) {
Ian Rogers5fe9af72013-11-14 00:17:20 -0800113 TimingLogger timings("OatTest::WriteRead", false, false);
Ian Rogers3d504072014-03-01 09:16:49 -0800114 compiler_driver_->CompileAll(class_loader, class_linker->GetBootClassPath(), &timings);
Brian Carlstrome24fa612011-09-29 00:53:55 -0700115 }
116
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700117 ScopedObjectAccess soa(Thread::Current());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700118 ScratchFile tmp;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700119 SafeMap<std::string, std::string> key_value_store;
120 key_value_store.Put(OatHeader::kImageLocationKey, "lue.art");
Brian Carlstromc50d8e12013-07-23 22:35:16 -0700121 OatWriter oat_writer(class_linker->GetBootClassPath(),
122 42U,
123 4096U,
Alex Lighta59dd802014-07-02 16:28:08 -0700124 0,
Ian Rogersca368cb2013-11-15 15:52:08 -0800125 compiler_driver_.get(),
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700126 &timings,
127 &key_value_store);
Brian Carlstromc50d8e12013-07-23 22:35:16 -0700128 bool success = compiler_driver_->WriteElf(GetTestAndroidRoot(),
129 !kIsTargetBuild,
130 class_linker->GetBootClassPath(),
Ian Rogers3d504072014-03-01 09:16:49 -0800131 &oat_writer,
Brian Carlstromc50d8e12013-07-23 22:35:16 -0700132 tmp.GetFile());
133 ASSERT_TRUE(success);
Brian Carlstrome24fa612011-09-29 00:53:55 -0700134
Brian Carlstromba150c32013-08-27 17:31:03 -0700135 if (kCompile) { // OatWriter strips the code, regenerate to compare
Ian Rogers3d504072014-03-01 09:16:49 -0800136 compiler_driver_->CompileAll(class_loader, class_linker->GetBootClassPath(), &timings);
Brian Carlstrome24fa612011-09-29 00:53:55 -0700137 }
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700138 std::string error_msg;
Ian Rogers700a4022014-05-19 16:49:03 -0700139 std::unique_ptr<OatFile> oat_file(OatFile::Open(tmp.GetFilename(), tmp.GetFilename(), NULL, false,
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700140 &error_msg));
141 ASSERT_TRUE(oat_file.get() != nullptr) << error_msg;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700142 const OatHeader& oat_header = oat_file->GetOatHeader();
Brian Carlstromf852fb22012-10-19 11:01:58 -0700143 ASSERT_TRUE(oat_header.IsValid());
Brian Carlstrom919b11c2013-08-30 13:30:36 -0700144 ASSERT_EQ(1U, oat_header.GetDexFileCount()); // core
Brian Carlstrom28db0122012-10-18 16:20:41 -0700145 ASSERT_EQ(42U, oat_header.GetImageFileLocationOatChecksum());
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800146 ASSERT_EQ(4096U, oat_header.GetImageFileLocationOatDataBegin());
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700147 ASSERT_EQ("lue.art", std::string(oat_header.GetStoreValueByKey(OatHeader::kImageLocationKey)));
Brian Carlstrome24fa612011-09-29 00:53:55 -0700148
Brian Carlstroma004aa92012-02-08 18:05:09 -0800149 const DexFile* dex_file = java_lang_dex_file_;
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700150 uint32_t dex_file_checksum = dex_file->GetLocationChecksum();
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700151 const OatFile::OatDexFile* oat_dex_file = oat_file->GetOatDexFile(dex_file->GetLocation().c_str(),
Brian Carlstrom756ee4e2013-10-03 15:46:12 -0700152 &dex_file_checksum);
Ian Rogers8d31bbd2013-10-13 10:44:14 -0700153 ASSERT_TRUE(oat_dex_file != nullptr);
Brian Carlstroma004aa92012-02-08 18:05:09 -0800154 CHECK_EQ(dex_file->GetLocationChecksum(), oat_dex_file->GetDexFileLocationChecksum());
155 for (size_t i = 0; i < dex_file->NumClassDefs(); i++) {
156 const DexFile::ClassDef& class_def = dex_file->GetClassDef(i);
157 const byte* class_data = dex_file->GetClassData(class_def);
Brian Carlstromba150c32013-08-27 17:31:03 -0700158 size_t num_virtual_methods = 0;
Ian Rogers0571d352011-11-03 19:51:38 -0700159 if (class_data != NULL) {
Brian Carlstroma004aa92012-02-08 18:05:09 -0800160 ClassDataItemIterator it(*dex_file, class_data);
Ian Rogers0571d352011-11-03 19:51:38 -0700161 num_virtual_methods = it.NumVirtualMethods();
162 }
Brian Carlstroma004aa92012-02-08 18:05:09 -0800163 const char* descriptor = dex_file->GetClassDescriptor(class_def);
Mathieu Chartiereb8167a2014-05-07 15:43:14 -0700164 StackHandleScope<1> hs(soa.Self());
Mathieu Chartier0cd81352014-05-22 16:48:55 -0700165 mirror::Class* klass = class_linker->FindClass(soa.Self(), descriptor,
166 NullHandle<mirror::ClassLoader>());
Brian Carlstrome24fa612011-09-29 00:53:55 -0700167
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100168 const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(i);
169 CHECK_EQ(mirror::Class::Status::kStatusNotReady, oat_class.GetStatus()) << descriptor;
Brian Carlstromba150c32013-08-27 17:31:03 -0700170 CHECK_EQ(kCompile ? OatClassType::kOatClassAllCompiled : OatClassType::kOatClassNoneCompiled,
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100171 oat_class.GetType()) << descriptor;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700172
173 size_t method_index = 0;
174 for (size_t i = 0; i < klass->NumDirectMethods(); i++, method_index++) {
Logan Chieneeb7edf2012-03-09 20:38:39 +0800175 CheckMethod(klass->GetDirectMethod(i),
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100176 oat_class.GetOatMethod(method_index), dex_file);
Brian Carlstrome24fa612011-09-29 00:53:55 -0700177 }
178 for (size_t i = 0; i < num_virtual_methods; i++, method_index++) {
Logan Chieneeb7edf2012-03-09 20:38:39 +0800179 CheckMethod(klass->GetVirtualMethod(i),
Vladimir Markod3c5beb2014-04-11 16:32:51 +0100180 oat_class.GetOatMethod(method_index), dex_file);
Brian Carlstrome24fa612011-09-29 00:53:55 -0700181 }
182 }
183}
184
Brian Carlstrom341df942012-06-27 12:29:22 -0700185TEST_F(OatTest, OatHeaderSizeCheck) {
186 // If this test is failing and you have to update these constants,
187 // it is time to update OatHeader::kOatVersion
Alex Lighta59dd802014-07-02 16:28:08 -0700188 EXPECT_EQ(84U, sizeof(OatHeader));
Vladimir Marko7624d252014-05-02 14:40:15 +0100189 EXPECT_EQ(8U, sizeof(OatMethodOffsets));
190 EXPECT_EQ(24U, sizeof(OatQuickMethodHeader));
Fred Shih37f05ef2014-07-16 18:38:08 -0700191 EXPECT_EQ(91 * GetInstructionSetPointerSize(kRuntimeISA), sizeof(QuickEntryPoints));
Brian Carlstrom341df942012-06-27 12:29:22 -0700192}
193
Brian Carlstromf852fb22012-10-19 11:01:58 -0700194TEST_F(OatTest, OatHeaderIsValid) {
195 InstructionSet instruction_set = kX86;
Dave Allison70202782013-10-22 17:52:19 -0700196 InstructionSetFeatures instruction_set_features;
Brian Carlstromf852fb22012-10-19 11:01:58 -0700197 std::vector<const DexFile*> dex_files;
198 uint32_t image_file_location_oat_checksum = 0;
199 uint32_t image_file_location_oat_begin = 0;
Andreas Gampe928f72b2014-09-09 19:53:48 -0700200 std::unique_ptr<OatHeader> oat_header(OatHeader::Create(instruction_set,
201 instruction_set_features,
202 &dex_files,
203 image_file_location_oat_checksum,
204 image_file_location_oat_begin,
205 nullptr));
206 ASSERT_NE(oat_header.get(), nullptr);
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700207 ASSERT_TRUE(oat_header->IsValid());
Brian Carlstromf852fb22012-10-19 11:01:58 -0700208
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700209 char* magic = const_cast<char*>(oat_header->GetMagic());
Brian Carlstromf852fb22012-10-19 11:01:58 -0700210 strcpy(magic, ""); // bad magic
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700211 ASSERT_FALSE(oat_header->IsValid());
Brian Carlstrom7934ac22013-07-26 10:54:15 -0700212 strcpy(magic, "oat\n000"); // bad version
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700213 ASSERT_FALSE(oat_header->IsValid());
Brian Carlstromf852fb22012-10-19 11:01:58 -0700214}
215
Brian Carlstrome24fa612011-09-29 00:53:55 -0700216} // namespace art