blob: 7e53d8d2ab374d1005d8e14c6afe1b0d8108ee10 [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 Carlstromdb4d5402011-08-09 12:18:28 -070016
Brian Carlstroma1ce1fe2014-02-24 23:23:58 -080017#include "image.h"
18
Ian Rogers700a4022014-05-19 16:49:03 -070019#include <memory>
Ian Rogers0cfe1fb2011-08-26 03:29:44 -070020#include <string>
21#include <vector>
22
Andreas Gampe46ee31b2016-12-14 10:11:49 -080023#include "android-base/stringprintf.h"
24
Andreas Gampec6ea7d02017-02-01 16:46:28 -080025#include "art_method-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070026#include "base/unix_file/fd_file.h"
Vladimir Marko3481ba22015-04-13 12:22:36 +010027#include "class_linker-inl.h"
Calin Juravle857f0582016-12-20 14:36:59 +000028#include "compiler_callbacks.h"
Brian Carlstroma1ce1fe2014-02-24 23:23:58 -080029#include "common_compiler_test.h"
David Srbecky4fda4eb2016-02-05 13:34:46 +000030#include "debug/method_debug_info.h"
Calin Juravle857f0582016-12-20 14:36:59 +000031#include "dex/quick_compiler_callbacks.h"
Andreas Gampe3f41a012016-02-18 16:53:41 -080032#include "driver/compiler_options.h"
Tong Shen62d1ca32014-09-03 17:24:56 -070033#include "elf_writer.h"
Vladimir Marko10c13562015-11-25 14:33:36 +000034#include "elf_writer_quick.h"
Ian Rogers1d54e732013-05-02 21:10:01 -070035#include "gc/space/image_space.h"
Ian Rogerse63db272014-07-15 15:36:11 -070036#include "image_writer.h"
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +000037#include "linker/buffered_output_stream.h"
38#include "linker/file_output_stream.h"
Vladimir Marko944da602016-02-19 12:27:55 +000039#include "linker/multi_oat_relative_patcher.h"
Ian Rogersd9c4fc92013-10-01 19:45:43 -070040#include "lock_word.h"
41#include "mirror/object-inl.h"
Ian Rogerse63db272014-07-15 15:36:11 -070042#include "oat_writer.h"
Mathieu Chartier0795f232016-09-27 18:43:30 -070043#include "scoped_thread_state_change-inl.h"
Brian Carlstrom51c24672013-07-11 16:00:56 -070044#include "signal_catcher.h"
buzbeec143c552011-08-20 17:38:58 -070045#include "utils.h"
Brian Carlstromdb4d5402011-08-09 12:18:28 -070046
Brian Carlstromdb4d5402011-08-09 12:18:28 -070047namespace art {
48
Mathieu Chartier496577f2016-09-20 15:33:31 -070049static const uintptr_t kRequestedImageBase = ART_BASE_ADDRESS;
50
51struct CompilationHelper {
52 std::vector<std::string> dex_file_locations;
53 std::vector<ScratchFile> image_locations;
54 std::vector<std::unique_ptr<const DexFile>> extra_dex_files;
55 std::vector<ScratchFile> image_files;
56 std::vector<ScratchFile> oat_files;
57 std::vector<ScratchFile> vdex_files;
58 std::string image_dir;
59
60 void Compile(CompilerDriver* driver,
61 ImageHeader::StorageMode storage_mode);
62
63 std::vector<size_t> GetImageObjectSectionSizes();
64
65 ~CompilationHelper();
66};
67
Brian Carlstroma1ce1fe2014-02-24 23:23:58 -080068class ImageTest : public CommonCompilerTest {
Ian Rogers10c5b782013-01-10 10:40:53 -080069 protected:
70 virtual void SetUp() {
Brian Carlstrom700c8d32012-11-05 10:42:02 -080071 ReserveImageSpace();
Brian Carlstroma1ce1fe2014-02-24 23:23:58 -080072 CommonCompilerTest::SetUp();
Ian Rogers10c5b782013-01-10 10:40:53 -080073 }
Mathieu Chartier496577f2016-09-20 15:33:31 -070074
Mathieu Chartierceb07b32015-12-10 09:33:21 -080075 void TestWriteRead(ImageHeader::StorageMode storage_mode);
Mathieu Chartier496577f2016-09-20 15:33:31 -070076
77 void Compile(ImageHeader::StorageMode storage_mode,
78 CompilationHelper& out_helper,
79 const std::string& extra_dex = "",
Artem Udovichenkob3f2b5c2017-01-31 11:49:33 +030080 const std::initializer_list<std::string>& image_classes = {});
Mathieu Chartier496577f2016-09-20 15:33:31 -070081
Calin Juravle857f0582016-12-20 14:36:59 +000082 void SetUpRuntimeOptions(RuntimeOptions* options) OVERRIDE {
83 CommonCompilerTest::SetUpRuntimeOptions(options);
84 callbacks_.reset(new QuickCompilerCallbacks(
85 verification_results_.get(),
86 CompilerCallbacks::CallbackMode::kCompileBootImage));
87 options->push_back(std::make_pair("compilercallbacks", callbacks_.get()));
88 }
89
Mathieu Chartier496577f2016-09-20 15:33:31 -070090 std::unordered_set<std::string>* GetImageClasses() OVERRIDE {
91 return new std::unordered_set<std::string>(image_classes_);
92 }
93
Artem Udovichenkob3f2b5c2017-01-31 11:49:33 +030094 ArtMethod* FindCopiedMethod(ArtMethod* origin, mirror::Class* klass)
95 REQUIRES_SHARED(Locks::mutator_lock_) {
96 PointerSize pointer_size = class_linker_->GetImagePointerSize();
97 for (ArtMethod& m : klass->GetCopiedMethods(pointer_size)) {
98 if (strcmp(origin->GetName(), m.GetName()) == 0 &&
99 origin->GetSignature() == m.GetSignature()) {
100 return &m;
101 }
102 }
103 return nullptr;
104 }
105
Mathieu Chartier496577f2016-09-20 15:33:31 -0700106 private:
107 std::unordered_set<std::string> image_classes_;
Ian Rogers10c5b782013-01-10 10:40:53 -0800108};
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700109
Mathieu Chartier496577f2016-09-20 15:33:31 -0700110CompilationHelper::~CompilationHelper() {
111 for (ScratchFile& image_file : image_files) {
112 image_file.Unlink();
113 }
114 for (ScratchFile& oat_file : oat_files) {
115 oat_file.Unlink();
116 }
117 for (ScratchFile& vdex_file : vdex_files) {
118 vdex_file.Unlink();
119 }
120 const int rmdir_result = rmdir(image_dir.c_str());
121 CHECK_EQ(0, rmdir_result);
122}
Andreas Gampe3f41a012016-02-18 16:53:41 -0800123
Mathieu Chartier496577f2016-09-20 15:33:31 -0700124std::vector<size_t> CompilationHelper::GetImageObjectSectionSizes() {
125 std::vector<size_t> ret;
126 for (ScratchFile& image_file : image_files) {
127 std::unique_ptr<File> file(OS::OpenFileForReading(image_file.GetFilename().c_str()));
128 CHECK(file.get() != nullptr);
129 ImageHeader image_header;
130 CHECK_EQ(file->ReadFully(&image_header, sizeof(image_header)), true);
131 CHECK(image_header.IsValid());
132 ret.push_back(image_header.GetImageSize());
133 }
134 return ret;
135}
Andreas Gampe3f41a012016-02-18 16:53:41 -0800136
Mathieu Chartier496577f2016-09-20 15:33:31 -0700137void CompilationHelper::Compile(CompilerDriver* driver,
138 ImageHeader::StorageMode storage_mode) {
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800139 ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
Mathieu Chartier496577f2016-09-20 15:33:31 -0700140 std::vector<const DexFile*> class_path = class_linker->GetBootClassPath();
141
142 for (const std::unique_ptr<const DexFile>& dex_file : extra_dex_files) {
143 {
144 ScopedObjectAccess soa(Thread::Current());
145 // Inject in boot class path so that the compiler driver can see it.
146 class_linker->AppendToBootClassPath(soa.Self(), *dex_file.get());
147 }
148 class_path.push_back(dex_file.get());
149 }
Mathieu Chartier866d8742016-09-21 15:24:18 -0700150
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800151 // Enable write for dex2dex.
Mathieu Chartier496577f2016-09-20 15:33:31 -0700152 for (const DexFile* dex_file : class_path) {
153 dex_file_locations.push_back(dex_file->GetLocation());
154 if (dex_file->IsReadOnly()) {
155 dex_file->EnableWrite();
156 }
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800157 }
Mathieu Chartier866d8742016-09-21 15:24:18 -0700158 {
Mathieu Chartier496577f2016-09-20 15:33:31 -0700159 // Create a generic tmp file, to be the base of the .art and .oat temporary files.
Mathieu Chartier866d8742016-09-21 15:24:18 -0700160 ScratchFile location;
Mathieu Chartier496577f2016-09-20 15:33:31 -0700161 for (int i = 0; i < static_cast<int>(class_path.size()); ++i) {
Andreas Gampe46ee31b2016-12-14 10:11:49 -0800162 std::string cur_location =
163 android::base::StringPrintf("%s-%d.art", location.GetFilename().c_str(), i);
Mathieu Chartier866d8742016-09-21 15:24:18 -0700164 image_locations.push_back(ScratchFile(cur_location));
165 }
166 }
167 std::vector<std::string> image_filenames;
Mathieu Chartier866d8742016-09-21 15:24:18 -0700168 for (ScratchFile& file : image_locations) {
169 std::string image_filename(GetSystemImageFilename(file.GetFilename().c_str(), kRuntimeISA));
170 image_filenames.push_back(image_filename);
171 size_t pos = image_filename.rfind('/');
172 CHECK_NE(pos, std::string::npos) << image_filename;
173 if (image_dir.empty()) {
174 image_dir = image_filename.substr(0, pos);
175 int mkdir_result = mkdir(image_dir.c_str(), 0700);
176 CHECK_EQ(0, mkdir_result) << image_dir;
177 }
178 image_files.push_back(ScratchFile(OS::CreateEmptyFile(image_filename.c_str())));
179 }
Brian Carlstrom0e12bdc2014-05-14 17:44:28 -0700180
Mathieu Chartier866d8742016-09-21 15:24:18 -0700181 std::vector<std::string> oat_filenames;
Mathieu Chartier866d8742016-09-21 15:24:18 -0700182 std::vector<std::string> vdex_filenames;
Mathieu Chartier866d8742016-09-21 15:24:18 -0700183 for (const std::string& image_filename : image_filenames) {
184 std::string oat_filename = ReplaceFileExtension(image_filename, "oat");
185 oat_files.push_back(ScratchFile(OS::CreateEmptyFile(oat_filename.c_str())));
186 oat_filenames.push_back(oat_filename);
187 std::string vdex_filename = ReplaceFileExtension(image_filename, "vdex");
188 vdex_files.push_back(ScratchFile(OS::CreateEmptyFile(vdex_filename.c_str())));
189 vdex_filenames.push_back(vdex_filename);
190 }
David Brazdil7b49e6c2016-09-01 11:06:18 +0100191
Vladimir Marko944da602016-02-19 12:27:55 +0000192 std::unordered_map<const DexFile*, size_t> dex_file_to_oat_index_map;
Mathieu Chartier866d8742016-09-21 15:24:18 -0700193 std::vector<const char*> oat_filename_vector;
194 for (const std::string& file : oat_filenames) {
195 oat_filename_vector.push_back(file.c_str());
Jeff Haodcdc85b2015-12-04 14:06:18 -0800196 }
Mathieu Chartier866d8742016-09-21 15:24:18 -0700197 std::vector<const char*> image_filename_vector;
198 for (const std::string& file : image_filenames) {
199 image_filename_vector.push_back(file.c_str());
200 }
201 size_t image_idx = 0;
Mathieu Chartier496577f2016-09-20 15:33:31 -0700202 for (const DexFile* dex_file : class_path) {
Mathieu Chartier866d8742016-09-21 15:24:18 -0700203 dex_file_to_oat_index_map.emplace(dex_file, image_idx);
204 ++image_idx;
205 }
206 // TODO: compile_pic should be a test argument.
Mathieu Chartier496577f2016-09-20 15:33:31 -0700207 std::unique_ptr<ImageWriter> writer(new ImageWriter(*driver,
208 kRequestedImageBase,
Mathieu Chartierda5b28a2015-11-05 08:03:47 -0800209 /*compile_pic*/false,
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800210 /*compile_app_image*/false,
Jeff Haodcdc85b2015-12-04 14:06:18 -0800211 storage_mode,
212 oat_filename_vector,
Vladimir Marko944da602016-02-19 12:27:55 +0000213 dex_file_to_oat_index_map));
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700214 {
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800215 {
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700216 jobject class_loader = nullptr;
Ian Rogers5fe9af72013-11-14 00:17:20 -0800217 TimingLogger timings("ImageTest::WriteRead", false, false);
Mathieu Chartierf5997b42014-06-20 10:37:54 -0700218 TimingLogger::ScopedTiming t("CompileAll", &timings);
Mathieu Chartier496577f2016-09-20 15:33:31 -0700219 driver->SetDexFilesForOatFile(class_path);
Nicolas Geoffray6bb7f1b2016-11-03 10:52:49 +0000220 driver->CompileAll(class_loader, class_path, /* verifier_deps */ nullptr, &timings);
Brian Carlstrom96391602013-06-13 19:49:50 -0700221
Mathieu Chartierf5997b42014-06-20 10:37:54 -0700222 t.NewTiming("WriteElf");
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700223 SafeMap<std::string, std::string> key_value_store;
Mathieu Chartier866d8742016-09-21 15:24:18 -0700224 std::vector<const char*> dex_filename_vector;
Mathieu Chartier496577f2016-09-20 15:33:31 -0700225 for (size_t i = 0; i < class_path.size(); ++i) {
Mathieu Chartier866d8742016-09-21 15:24:18 -0700226 dex_filename_vector.push_back("");
227 }
228 key_value_store.Put(OatHeader::kBootClassPathKey,
229 gc::space::ImageSpace::GetMultiImageBootClassPath(
230 dex_filename_vector,
231 oat_filename_vector,
232 image_filename_vector));
233
Mathieu Chartier866d8742016-09-21 15:24:18 -0700234 std::vector<std::unique_ptr<ElfWriter>> elf_writers;
235 std::vector<std::unique_ptr<OatWriter>> oat_writers;
236 for (ScratchFile& oat_file : oat_files) {
Mathieu Chartier496577f2016-09-20 15:33:31 -0700237 elf_writers.emplace_back(CreateElfWriterQuick(driver->GetInstructionSet(),
238 driver->GetInstructionSetFeatures(),
239 &driver->GetCompilerOptions(),
240 oat_file.GetFile()));
Mathieu Chartier866d8742016-09-21 15:24:18 -0700241 elf_writers.back()->Start();
Jeff Hao608f2ce2016-10-19 11:17:11 -0700242 oat_writers.emplace_back(new OatWriter(/*compiling_boot_image*/true,
243 &timings,
244 /*profile_compilation_info*/nullptr));
Mathieu Chartier866d8742016-09-21 15:24:18 -0700245 }
246
247 std::vector<OutputStream*> rodata;
248 std::vector<std::unique_ptr<MemMap>> opened_dex_files_map;
249 std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
250 // Now that we have finalized key_value_store_, start writing the oat file.
251 for (size_t i = 0, size = oat_writers.size(); i != size; ++i) {
Mathieu Chartier496577f2016-09-20 15:33:31 -0700252 const DexFile* dex_file = class_path[i];
Mathieu Chartier866d8742016-09-21 15:24:18 -0700253 rodata.push_back(elf_writers[i]->StartRoData());
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000254 ArrayRef<const uint8_t> raw_dex_file(
255 reinterpret_cast<const uint8_t*>(&dex_file->GetHeader()),
256 dex_file->GetHeader().file_size_);
Mathieu Chartier866d8742016-09-21 15:24:18 -0700257 oat_writers[i]->AddRawDexFileSource(raw_dex_file,
258 dex_file->GetLocation().c_str(),
259 dex_file->GetLocationChecksum());
260
261 std::unique_ptr<MemMap> cur_opened_dex_files_map;
262 std::vector<std::unique_ptr<const DexFile>> cur_opened_dex_files;
263 bool dex_files_ok = oat_writers[i]->WriteAndOpenDexFiles(
264 kIsVdexEnabled ? vdex_files[i].GetFile() : oat_files[i].GetFile(),
265 rodata.back(),
Mathieu Chartier496577f2016-09-20 15:33:31 -0700266 driver->GetInstructionSet(),
267 driver->GetInstructionSetFeatures(),
David Brazdil7b49e6c2016-09-01 11:06:18 +0100268 &key_value_store,
269 /* verify */ false, // Dex files may be dex-to-dex-ed, don't verify.
Nicolas Geoffray81f57d12016-12-20 13:17:09 +0000270 /* update_input_vdex */ false,
Mathieu Chartier866d8742016-09-21 15:24:18 -0700271 &cur_opened_dex_files_map,
272 &cur_opened_dex_files);
David Brazdil7b49e6c2016-09-01 11:06:18 +0100273 ASSERT_TRUE(dex_files_ok);
Vladimir Marko944da602016-02-19 12:27:55 +0000274
Mathieu Chartier866d8742016-09-21 15:24:18 -0700275 if (cur_opened_dex_files_map != nullptr) {
276 opened_dex_files_map.push_back(std::move(cur_opened_dex_files_map));
277 for (std::unique_ptr<const DexFile>& cur_dex_file : cur_opened_dex_files) {
278 // dex_file_oat_index_map_.emplace(dex_file.get(), i);
279 opened_dex_files.push_back(std::move(cur_dex_file));
280 }
281 } else {
282 ASSERT_TRUE(cur_opened_dex_files.empty());
283 }
284 }
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000285 bool image_space_ok = writer->PrepareImageAddressSpace();
286 ASSERT_TRUE(image_space_ok);
287
Nicolas Geoffrayf54e5df2016-12-01 10:45:08 +0000288 if (kIsVdexEnabled) {
289 for (size_t i = 0, size = vdex_files.size(); i != size; ++i) {
290 std::unique_ptr<BufferedOutputStream> vdex_out(
291 MakeUnique<BufferedOutputStream>(
292 MakeUnique<FileOutputStream>(vdex_files[i].GetFile())));
293 oat_writers[i]->WriteVerifierDeps(vdex_out.get(), nullptr);
294 oat_writers[i]->WriteChecksumsAndVdexHeader(vdex_out.get());
295 }
296 }
297
Mathieu Chartier866d8742016-09-21 15:24:18 -0700298 for (size_t i = 0, size = oat_files.size(); i != size; ++i) {
Mathieu Chartier496577f2016-09-20 15:33:31 -0700299 linker::MultiOatRelativePatcher patcher(driver->GetInstructionSet(),
300 driver->GetInstructionSetFeatures());
Mathieu Chartier866d8742016-09-21 15:24:18 -0700301 OatWriter* const oat_writer = oat_writers[i].get();
302 ElfWriter* const elf_writer = elf_writers[i].get();
Mathieu Chartier496577f2016-09-20 15:33:31 -0700303 std::vector<const DexFile*> cur_dex_files(1u, class_path[i]);
Nicolas Geoffray4acefd32016-10-24 13:14:58 +0100304 oat_writer->Initialize(driver, writer.get(), cur_dex_files);
305 oat_writer->PrepareLayout(&patcher);
Mathieu Chartier866d8742016-09-21 15:24:18 -0700306 size_t rodata_size = oat_writer->GetOatHeader().GetExecutableOffset();
307 size_t text_size = oat_writer->GetOatSize() - rodata_size;
Vladimir Markoaad75c62016-10-03 08:46:48 +0000308 elf_writer->PrepareDynamicSection(rodata_size,
309 text_size,
310 oat_writer->GetBssSize(),
311 oat_writer->GetBssRootsOffset());
Vladimir Marko944da602016-02-19 12:27:55 +0000312
Mathieu Chartier866d8742016-09-21 15:24:18 -0700313 writer->UpdateOatFileLayout(i,
314 elf_writer->GetLoadedSize(),
315 oat_writer->GetOatDataOffset(),
316 oat_writer->GetOatSize());
Vladimir Marko944da602016-02-19 12:27:55 +0000317
Mathieu Chartier866d8742016-09-21 15:24:18 -0700318 bool rodata_ok = oat_writer->WriteRodata(rodata[i]);
319 ASSERT_TRUE(rodata_ok);
320 elf_writer->EndRoData(rodata[i]);
Vladimir Marko10c13562015-11-25 14:33:36 +0000321
Mathieu Chartier866d8742016-09-21 15:24:18 -0700322 OutputStream* text = elf_writer->StartText();
323 bool text_ok = oat_writer->WriteCode(text);
324 ASSERT_TRUE(text_ok);
325 elf_writer->EndText(text);
Vladimir Marko10c13562015-11-25 14:33:36 +0000326
Mathieu Chartier866d8742016-09-21 15:24:18 -0700327 bool header_ok = oat_writer->WriteHeader(elf_writer->GetStream(), 0u, 0u, 0u);
328 ASSERT_TRUE(header_ok);
Vladimir Marko9bdf1082016-01-21 12:15:52 +0000329
Mathieu Chartier866d8742016-09-21 15:24:18 -0700330 writer->UpdateOatFileHeader(i, oat_writer->GetOatHeader());
Vladimir Marko944da602016-02-19 12:27:55 +0000331
Mathieu Chartier866d8742016-09-21 15:24:18 -0700332 elf_writer->WriteDynamicSection();
333 elf_writer->WriteDebugInfo(oat_writer->GetMethodDebugInfo());
Vladimir Marko10c13562015-11-25 14:33:36 +0000334
Mathieu Chartier866d8742016-09-21 15:24:18 -0700335 bool success = elf_writer->End();
336 ASSERT_TRUE(success);
337 }
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700338 }
Mathieu Chartier357e9be2012-08-01 11:00:14 -0700339
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800340 bool success_image = writer->Write(kInvalidFd,
Mathieu Chartier866d8742016-09-21 15:24:18 -0700341 image_filename_vector,
342 oat_filename_vector);
jeffhao8161c032012-10-31 15:50:00 -0700343 ASSERT_TRUE(success_image);
Andreas Gampe4303ba92014-11-06 01:00:46 -0800344
Mathieu Chartier866d8742016-09-21 15:24:18 -0700345 for (size_t i = 0, size = oat_filenames.size(); i != size; ++i) {
346 const char* oat_filename = oat_filenames[i].c_str();
347 std::unique_ptr<File> oat_file(OS::OpenFileReadWrite(oat_filename));
348 ASSERT_TRUE(oat_file != nullptr);
349 bool success_fixup = ElfWriter::Fixup(oat_file.get(),
350 writer->GetOatDataBegin(i));
351 ASSERT_TRUE(success_fixup);
352 ASSERT_EQ(oat_file->FlushCloseOrErase(), 0) << "Could not flush and close oat file "
353 << oat_filename;
354 }
jeffhao8161c032012-10-31 15:50:00 -0700355 }
Mathieu Chartier496577f2016-09-20 15:33:31 -0700356}
Brian Carlstrom4a289ed2011-08-16 17:17:49 -0700357
Mathieu Chartier496577f2016-09-20 15:33:31 -0700358void ImageTest::Compile(ImageHeader::StorageMode storage_mode,
359 CompilationHelper& helper,
360 const std::string& extra_dex,
Artem Udovichenkob3f2b5c2017-01-31 11:49:33 +0300361 const std::initializer_list<std::string>& image_classes) {
362 for (const std::string& image_class : image_classes) {
Mathieu Chartier496577f2016-09-20 15:33:31 -0700363 image_classes_.insert(image_class);
364 }
365 CreateCompilerDriver(Compiler::kOptimizing, kRuntimeISA, kIsTargetBuild ? 2U : 16U);
366 // Set inline filter values.
Mathieu Chartier496577f2016-09-20 15:33:31 -0700367 compiler_options_->SetInlineMaxCodeUnits(CompilerOptions::kDefaultInlineMaxCodeUnits);
368 image_classes_.clear();
369 if (!extra_dex.empty()) {
370 helper.extra_dex_files = OpenTestDexFiles(extra_dex.c_str());
371 }
372 helper.Compile(compiler_driver_.get(), storage_mode);
Artem Udovichenkob3f2b5c2017-01-31 11:49:33 +0300373 if (image_classes.begin() != image_classes.end()) {
Mathieu Chartier496577f2016-09-20 15:33:31 -0700374 // Make sure the class got initialized.
375 ScopedObjectAccess soa(Thread::Current());
376 ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
Artem Udovichenkob3f2b5c2017-01-31 11:49:33 +0300377 for (const std::string& image_class : image_classes) {
378 mirror::Class* klass = class_linker->FindSystemClass(Thread::Current(), image_class.c_str());
379 EXPECT_TRUE(klass != nullptr);
380 EXPECT_TRUE(klass->IsInitialized());
381 }
Mathieu Chartier496577f2016-09-20 15:33:31 -0700382 }
383}
384
385void ImageTest::TestWriteRead(ImageHeader::StorageMode storage_mode) {
386 CompilationHelper helper;
387 Compile(storage_mode, /*out*/ helper);
Mathieu Chartier866d8742016-09-21 15:24:18 -0700388 std::vector<uint64_t> image_file_sizes;
Mathieu Chartier496577f2016-09-20 15:33:31 -0700389 for (ScratchFile& image_file : helper.image_files) {
Ian Rogers700a4022014-05-19 16:49:03 -0700390 std::unique_ptr<File> file(OS::OpenFileForReading(image_file.GetFilename().c_str()));
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700391 ASSERT_TRUE(file.get() != nullptr);
Brian Carlstrom4a289ed2011-08-16 17:17:49 -0700392 ImageHeader image_header;
Andreas Gampe4303ba92014-11-06 01:00:46 -0800393 ASSERT_EQ(file->ReadFully(&image_header, sizeof(image_header)), true);
Brian Carlstrom4a289ed2011-08-16 17:17:49 -0700394 ASSERT_TRUE(image_header.IsValid());
Mathieu Chartiere401d142015-04-22 13:56:20 -0700395 const auto& bitmap_section = image_header.GetImageSection(ImageHeader::kSectionImageBitmap);
396 ASSERT_GE(bitmap_section.Offset(), sizeof(image_header));
397 ASSERT_NE(0U, bitmap_section.Size());
Brian Carlstrom69b15fb2011-09-03 12:25:21 -0700398
Ian Rogers1d54e732013-05-02 21:10:01 -0700399 gc::Heap* heap = Runtime::Current()->GetHeap();
Mathieu Chartiera9d82fe2016-01-25 20:06:11 -0800400 ASSERT_TRUE(heap->HaveContinuousSpaces());
Mathieu Chartier590fee92013-09-13 13:46:47 -0700401 gc::space::ContinuousSpace* space = heap->GetNonMovingSpace();
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700402 ASSERT_FALSE(space->IsImageSpace());
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700403 ASSERT_TRUE(space != nullptr);
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -0700404 ASSERT_TRUE(space->IsMallocSpace());
Mathieu Chartier866d8742016-09-21 15:24:18 -0700405 image_file_sizes.push_back(file->GetLength());
Brian Carlstrom4a289ed2011-08-16 17:17:49 -0700406 }
Brian Carlstrom8a436592011-08-15 21:27:23 -0700407
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700408 ASSERT_TRUE(compiler_driver_->GetImageClasses() != nullptr);
Andreas Gampeb1fcead2015-04-20 18:53:51 -0700409 std::unordered_set<std::string> image_classes(*compiler_driver_->GetImageClasses());
Brian Carlstrom96391602013-06-13 19:49:50 -0700410
Mathieu Chartier0e4627e2012-10-23 16:13:36 -0700411 // Need to delete the compiler since it has worker threads which are attached to runtime.
Ian Rogers1212a022013-03-04 10:48:41 -0800412 compiler_driver_.reset();
Mathieu Chartier0e4627e2012-10-23 16:13:36 -0700413
Ian Rogers10c5b782013-01-10 10:40:53 -0800414 // Tear down old runtime before making a new one, clearing out misc state.
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700415
416 // Remove the reservation of the memory for use to load the image.
417 // Need to do this before we reset the runtime.
418 UnreserveImageSpace();
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700419
Mathieu Chartier496577f2016-09-20 15:33:31 -0700420 helper.extra_dex_files.clear();
Ian Rogers10c5b782013-01-10 10:40:53 -0800421 runtime_.reset();
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700422 java_lang_dex_file_ = nullptr;
Brian Carlstrom9cff8e12011-08-18 16:47:29 -0700423
Mathieu Chartier6e88ef62014-10-14 15:01:24 -0700424 MemMap::Init();
Brian Carlstrom8a436592011-08-15 21:27:23 -0700425
Ian Rogerse63db272014-07-15 15:36:11 -0700426 RuntimeOptions options;
Brian Carlstrom58ae9412011-10-04 00:56:06 -0700427 std::string image("-Ximage:");
Mathieu Chartier496577f2016-09-20 15:33:31 -0700428 image.append(helper.image_locations[0].GetFilename());
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700429 options.push_back(std::make_pair(image.c_str(), static_cast<void*>(nullptr)));
Alex Light6e183f22014-07-18 14:57:04 -0700430 // By default the compiler this creates will not include patch information.
431 options.push_back(std::make_pair("-Xnorelocate", nullptr));
Brian Carlstrom8a436592011-08-15 21:27:23 -0700432
Ian Rogers00f7d0e2012-07-19 15:28:27 -0700433 if (!Runtime::Create(options, false)) {
434 LOG(FATAL) << "Failed to create runtime";
435 return;
436 }
437 runtime_.reset(Runtime::Current());
438 // Runtime::Create acquired the mutator_lock_ that is normally given away when we Runtime::Start,
439 // give it away now and then switch to a more managable ScopedObjectAccess.
440 Thread::Current()->TransitionFromRunnableToSuspended(kNative);
441 ScopedObjectAccess soa(Thread::Current());
Mathieu Chartier2cebb242015-04-21 16:50:40 -0700442 ASSERT_TRUE(runtime_.get() != nullptr);
Brian Carlstrom8a436592011-08-15 21:27:23 -0700443 class_linker_ = runtime_->GetClassLinker();
Brian Carlstrom9cff8e12011-08-18 16:47:29 -0700444
Ian Rogers1d54e732013-05-02 21:10:01 -0700445 gc::Heap* heap = Runtime::Current()->GetHeap();
Jeff Haodcdc85b2015-12-04 14:06:18 -0800446 ASSERT_TRUE(heap->HasBootImageSpace());
Hiroshi Yamauchicf58d4a2013-09-26 14:21:22 -0700447 ASSERT_TRUE(heap->GetNonMovingSpace()->IsMallocSpace());
Brian Carlstrom9cff8e12011-08-18 16:47:29 -0700448
Jeff Haodcdc85b2015-12-04 14:06:18 -0800449 // We loaded the runtime with an explicit image, so it must exist.
Mathieu Chartier866d8742016-09-21 15:24:18 -0700450 ASSERT_EQ(heap->GetBootImageSpaces().size(), image_file_sizes.size());
Mathieu Chartier496577f2016-09-20 15:33:31 -0700451 for (size_t i = 0; i < helper.dex_file_locations.size(); ++i) {
Mathieu Chartier866d8742016-09-21 15:24:18 -0700452 std::unique_ptr<const DexFile> dex(
Mathieu Chartier496577f2016-09-20 15:33:31 -0700453 LoadExpectSingleDexFile(helper.dex_file_locations[i].c_str()));
454 ASSERT_TRUE(dex != nullptr);
Mathieu Chartier866d8742016-09-21 15:24:18 -0700455 uint64_t image_file_size = image_file_sizes[i];
456 gc::space::ImageSpace* image_space = heap->GetBootImageSpaces()[i];
457 ASSERT_TRUE(image_space != nullptr);
458 if (storage_mode == ImageHeader::kStorageModeUncompressed) {
459 // Uncompressed, image should be smaller than file.
460 ASSERT_LE(image_space->GetImageHeader().GetImageSize(), image_file_size);
Mathieu Chartier496577f2016-09-20 15:33:31 -0700461 } else if (image_file_size > 16 * KB) {
462 // Compressed, file should be smaller than image. Not really valid for small images.
Mathieu Chartier866d8742016-09-21 15:24:18 -0700463 ASSERT_LE(image_file_size, image_space->GetImageHeader().GetImageSize());
Brian Carlstrom96391602013-06-13 19:49:50 -0700464 }
Mathieu Chartier866d8742016-09-21 15:24:18 -0700465
466 image_space->VerifyImageAllocations();
467 uint8_t* image_begin = image_space->Begin();
468 uint8_t* image_end = image_space->End();
469 if (i == 0) {
470 // This check is only valid for image 0.
Mathieu Chartier496577f2016-09-20 15:33:31 -0700471 CHECK_EQ(kRequestedImageBase, reinterpret_cast<uintptr_t>(image_begin));
Mathieu Chartier866d8742016-09-21 15:24:18 -0700472 }
473 for (size_t j = 0; j < dex->NumClassDefs(); ++j) {
474 const DexFile::ClassDef& class_def = dex->GetClassDef(j);
475 const char* descriptor = dex->GetClassDescriptor(class_def);
476 mirror::Class* klass = class_linker_->FindSystemClass(soa.Self(), descriptor);
477 EXPECT_TRUE(klass != nullptr) << descriptor;
478 if (image_classes.find(descriptor) == image_classes.end()) {
479 EXPECT_TRUE(reinterpret_cast<uint8_t*>(klass) >= image_end ||
480 reinterpret_cast<uint8_t*>(klass) < image_begin) << descriptor;
481 } else {
482 // Image classes should be located inside the image.
483 EXPECT_LT(image_begin, reinterpret_cast<uint8_t*>(klass)) << descriptor;
484 EXPECT_LT(reinterpret_cast<uint8_t*>(klass), image_end) << descriptor;
485 }
486 EXPECT_TRUE(Monitor::IsValidLockWord(klass->GetLockWord(false)));
487 }
Brian Carlstrom9cff8e12011-08-18 16:47:29 -0700488 }
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700489}
490
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800491TEST_F(ImageTest, WriteReadUncompressed) {
492 TestWriteRead(ImageHeader::kStorageModeUncompressed);
493}
494
495TEST_F(ImageTest, WriteReadLZ4) {
496 TestWriteRead(ImageHeader::kStorageModeLZ4);
497}
498
Mathieu Chartiera6e81ed2016-02-25 13:52:10 -0800499TEST_F(ImageTest, WriteReadLZ4HC) {
500 TestWriteRead(ImageHeader::kStorageModeLZ4HC);
501}
502
Mathieu Chartier496577f2016-09-20 15:33:31 -0700503TEST_F(ImageTest, TestImageLayout) {
504 std::vector<size_t> image_sizes;
505 std::vector<size_t> image_sizes_extra;
506 // Compile multi-image with ImageLayoutA being the last image.
507 {
508 CompilationHelper helper;
Artem Udovichenkob3f2b5c2017-01-31 11:49:33 +0300509 Compile(ImageHeader::kStorageModeUncompressed, helper, "ImageLayoutA", {"LMyClass;"});
Mathieu Chartier496577f2016-09-20 15:33:31 -0700510 image_sizes = helper.GetImageObjectSectionSizes();
511 }
512 TearDown();
513 runtime_.reset();
514 SetUp();
515 // Compile multi-image with ImageLayoutB being the last image.
516 {
517 CompilationHelper helper;
Artem Udovichenkob3f2b5c2017-01-31 11:49:33 +0300518 Compile(ImageHeader::kStorageModeUncompressed, helper, "ImageLayoutB", {"LMyClass;"});
Mathieu Chartier496577f2016-09-20 15:33:31 -0700519 image_sizes_extra = helper.GetImageObjectSectionSizes();
520 }
521 // Make sure that the new stuff in the clinit in ImageLayoutB is in the last image and not in the
522 // first two images.
523 ASSERT_EQ(image_sizes.size(), image_sizes.size());
524 // Sizes of the images should be the same. These sizes are for the whole image unrounded.
525 for (size_t i = 0; i < image_sizes.size() - 1; ++i) {
526 EXPECT_EQ(image_sizes[i], image_sizes_extra[i]);
527 }
528 // Last image should be larger since it has a hash map and a string.
529 EXPECT_LT(image_sizes.back(), image_sizes_extra.back());
530}
531
Brian Carlstrom179486a2013-09-03 11:51:42 -0700532TEST_F(ImageTest, ImageHeaderIsValid) {
533 uint32_t image_begin = ART_BASE_ADDRESS;
534 uint32_t image_size_ = 16 * KB;
Brian Carlstrom179486a2013-09-03 11:51:42 -0700535 uint32_t image_roots = ART_BASE_ADDRESS + (1 * KB);
536 uint32_t oat_checksum = 0;
537 uint32_t oat_file_begin = ART_BASE_ADDRESS + (4 * KB); // page aligned
538 uint32_t oat_data_begin = ART_BASE_ADDRESS + (8 * KB); // page aligned
539 uint32_t oat_data_end = ART_BASE_ADDRESS + (9 * KB);
540 uint32_t oat_file_end = ART_BASE_ADDRESS + (10 * KB);
Mathieu Chartiere401d142015-04-22 13:56:20 -0700541 ImageSection sections[ImageHeader::kSectionCount];
Brian Carlstrom179486a2013-09-03 11:51:42 -0700542 ImageHeader image_header(image_begin,
543 image_size_,
Mathieu Chartiere401d142015-04-22 13:56:20 -0700544 sections,
Brian Carlstrom179486a2013-09-03 11:51:42 -0700545 image_roots,
546 oat_checksum,
547 oat_file_begin,
548 oat_data_begin,
549 oat_data_end,
Igor Murashkin46774762014-10-22 11:37:02 -0700550 oat_file_end,
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800551 /*boot_image_begin*/0U,
552 /*boot_image_size*/0U,
553 /*boot_oat_begin*/0U,
554 /*boot_oat_size_*/0U,
Mathieu Chartiere401d142015-04-22 13:56:20 -0700555 sizeof(void*),
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800556 /*compile_pic*/false,
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800557 /*is_pic*/false,
Mathieu Chartierceb07b32015-12-10 09:33:21 -0800558 ImageHeader::kDefaultStorageMode,
559 /*data_size*/0u);
Brian Carlstrom179486a2013-09-03 11:51:42 -0700560 ASSERT_TRUE(image_header.IsValid());
Mathieu Chartierfbc31082016-01-24 11:59:56 -0800561 ASSERT_TRUE(!image_header.IsAppImage());
Brian Carlstrom179486a2013-09-03 11:51:42 -0700562
563 char* magic = const_cast<char*>(image_header.GetMagic());
564 strcpy(magic, ""); // bad magic
565 ASSERT_FALSE(image_header.IsValid());
566 strcpy(magic, "art\n000"); // bad version
567 ASSERT_FALSE(image_header.IsValid());
568}
569
Artem Udovichenkob3f2b5c2017-01-31 11:49:33 +0300570// Test that pointer to quick code is the same in
571// a default method of an interface and in a copied method
572// of a class which implements the interface. This should be true
573// only if the copied method and the origin method are located in the
574// same oat file.
575TEST_F(ImageTest, TestDefaultMethods) {
576 CompilationHelper helper;
577 Compile(ImageHeader::kStorageModeUncompressed,
578 helper,
579 "DefaultMethods",
580 {"LIface;", "LImpl;", "LIterableBase;"});
581
582 PointerSize pointer_size = class_linker_->GetImagePointerSize();
583 Thread* self = Thread::Current();
584 ScopedObjectAccess soa(self);
585
586 // Test the pointer to quick code is the same in origin method
587 // and in the copied method form the same oat file.
588 mirror::Class* iface_klass = class_linker_->LookupClass(
589 self, "LIface;", ObjPtr<mirror::ClassLoader>());
590 ASSERT_NE(nullptr, iface_klass);
591 ArtMethod* origin = iface_klass->FindDeclaredVirtualMethod(
592 "defaultMethod", "()V", pointer_size);
593 ASSERT_NE(nullptr, origin);
594 const void* code = origin->GetEntryPointFromQuickCompiledCodePtrSize(pointer_size);
595 // The origin method should have a pointer to quick code
596 ASSERT_NE(nullptr, code);
597 ASSERT_FALSE(class_linker_->IsQuickToInterpreterBridge(code));
598 mirror::Class* impl_klass = class_linker_->LookupClass(
599 self, "LImpl;", ObjPtr<mirror::ClassLoader>());
600 ASSERT_NE(nullptr, impl_klass);
601 ArtMethod* copied = FindCopiedMethod(origin, impl_klass);
602 ASSERT_NE(nullptr, copied);
603 // the copied method should have pointer to the same quick code as the origin method
604 ASSERT_EQ(code, copied->GetEntryPointFromQuickCompiledCodePtrSize(pointer_size));
605
606 // Test the origin method has pointer to quick code
607 // but the copied method has pointer to interpreter
608 // because these methods are in different oat files.
609 mirror::Class* iterable_klass = class_linker_->LookupClass(
610 self, "Ljava/lang/Iterable;", ObjPtr<mirror::ClassLoader>());
611 ASSERT_NE(nullptr, iterable_klass);
612 origin = iterable_klass->FindDeclaredVirtualMethod(
613 "forEach", "(Ljava/util/function/Consumer;)V", pointer_size);
614 ASSERT_NE(nullptr, origin);
615 code = origin->GetEntryPointFromQuickCompiledCodePtrSize(pointer_size);
616 // the origin method should have a pointer to quick code
617 ASSERT_NE(nullptr, code);
618 ASSERT_FALSE(class_linker_->IsQuickToInterpreterBridge(code));
619 mirror::Class* iterablebase_klass = class_linker_->LookupClass(
620 self, "LIterableBase;", ObjPtr<mirror::ClassLoader>());
621 ASSERT_NE(nullptr, iterablebase_klass);
622 copied = FindCopiedMethod(origin, iterablebase_klass);
623 ASSERT_NE(nullptr, copied);
624 code = copied->GetEntryPointFromQuickCompiledCodePtrSize(pointer_size);
625 // the copied method should have a pointer to interpreter
626 ASSERT_TRUE(class_linker_->IsQuickToInterpreterBridge(code));
627}
628
Brian Carlstromdb4d5402011-08-09 12:18:28 -0700629} // namespace art