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 "debug/method_debug_info.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 "elf_writer.h"
31#include "elf_writer_quick.h"
32#include "entrypoints/quick/quick_entrypoints.h"
33#include "linker/multi_oat_relative_patcher.h"
34#include "linker/vector_output_stream.h"
35#include "mirror/class-inl.h"
36#include "mirror/object-inl.h"
37#include "mirror/object_array-inl.h"
38#include "oat_file-inl.h"
39#include "oat_writer.h"
40#include "scoped_thread_state_change.h"
41#include "utils/test_dex_file_builder.h"
42
43namespace art {
44
45NO_RETURN static void Usage(const char* fmt, ...) {
46  va_list ap;
47  va_start(ap, fmt);
48  std::string error;
49  StringAppendV(&error, fmt, ap);
50  LOG(FATAL) << error;
51  va_end(ap);
52  UNREACHABLE();
53}
54
55class OatTest : public CommonCompilerTest {
56 protected:
57  static const bool kCompile = false;  // DISABLED_ due to the time to compile libcore
58
59  void CheckMethod(ArtMethod* method,
60                   const OatFile::OatMethod& oat_method,
61                   const DexFile& dex_file)
62      SHARED_REQUIRES(Locks::mutator_lock_) {
63    const CompiledMethod* compiled_method =
64        compiler_driver_->GetCompiledMethod(MethodReference(&dex_file,
65                                                            method->GetDexMethodIndex()));
66
67    if (compiled_method == nullptr) {
68      EXPECT_TRUE(oat_method.GetQuickCode() == nullptr) << PrettyMethod(method) << " "
69                                                        << oat_method.GetQuickCode();
70      EXPECT_EQ(oat_method.GetFrameSizeInBytes(), 0U);
71      EXPECT_EQ(oat_method.GetCoreSpillMask(), 0U);
72      EXPECT_EQ(oat_method.GetFpSpillMask(), 0U);
73    } else {
74      const void* quick_oat_code = oat_method.GetQuickCode();
75      EXPECT_TRUE(quick_oat_code != nullptr) << PrettyMethod(method);
76      EXPECT_EQ(oat_method.GetFrameSizeInBytes(), compiled_method->GetFrameSizeInBytes());
77      EXPECT_EQ(oat_method.GetCoreSpillMask(), compiled_method->GetCoreSpillMask());
78      EXPECT_EQ(oat_method.GetFpSpillMask(), compiled_method->GetFpSpillMask());
79      uintptr_t oat_code_aligned = RoundDown(reinterpret_cast<uintptr_t>(quick_oat_code), 2);
80      quick_oat_code = reinterpret_cast<const void*>(oat_code_aligned);
81      ArrayRef<const uint8_t> quick_code = compiled_method->GetQuickCode();
82      EXPECT_FALSE(quick_code.empty());
83      size_t code_size = quick_code.size() * sizeof(quick_code[0]);
84      EXPECT_EQ(0, memcmp(quick_oat_code, &quick_code[0], code_size))
85          << PrettyMethod(method) << " " << code_size;
86      CHECK_EQ(0, memcmp(quick_oat_code, &quick_code[0], code_size));
87    }
88  }
89
90  void SetupCompiler(Compiler::Kind compiler_kind,
91                     InstructionSet insn_set,
92                     const std::vector<std::string>& compiler_options,
93                     /*out*/std::string* error_msg) {
94    ASSERT_TRUE(error_msg != nullptr);
95    insn_features_.reset(InstructionSetFeatures::FromVariant(insn_set, "default", error_msg));
96    ASSERT_TRUE(insn_features_ != nullptr) << error_msg;
97    compiler_options_.reset(new CompilerOptions);
98    for (const std::string& option : compiler_options) {
99      compiler_options_->ParseCompilerOption(option, Usage);
100    }
101    verification_results_.reset(new VerificationResults(compiler_options_.get()));
102    method_inliner_map_.reset(new DexFileToMethodInlinerMap);
103    callbacks_.reset(new QuickCompilerCallbacks(verification_results_.get(),
104                                                method_inliner_map_.get(),
105                                                CompilerCallbacks::CallbackMode::kCompileApp));
106    Runtime::Current()->SetCompilerCallbacks(callbacks_.get());
107    timer_.reset(new CumulativeLogger("Compilation times"));
108    compiler_driver_.reset(new CompilerDriver(compiler_options_.get(),
109                                              verification_results_.get(),
110                                              method_inliner_map_.get(),
111                                              compiler_kind,
112                                              insn_set,
113                                              insn_features_.get(),
114                                              /* boot_image */ false,
115                                              /* app_image */ false,
116                                              /* image_classes */ nullptr,
117                                              /* compiled_classes */ nullptr,
118                                              /* compiled_methods */ nullptr,
119                                              /* thread_count */ 2,
120                                              /* dump_stats */ true,
121                                              /* dump_passes */ true,
122                                              timer_.get(),
123                                              /* swap_fd */ -1,
124                                              /* profile_compilation_info */ nullptr));
125  }
126
127  bool WriteElf(File* file,
128                const std::vector<const DexFile*>& dex_files,
129                SafeMap<std::string, std::string>& key_value_store,
130                bool verify) {
131    TimingLogger timings("WriteElf", false, false);
132    OatWriter oat_writer(/*compiling_boot_image*/false, &timings);
133    for (const DexFile* dex_file : dex_files) {
134      ArrayRef<const uint8_t> raw_dex_file(
135          reinterpret_cast<const uint8_t*>(&dex_file->GetHeader()),
136          dex_file->GetHeader().file_size_);
137      if (!oat_writer.AddRawDexFileSource(raw_dex_file,
138                                          dex_file->GetLocation().c_str(),
139                                          dex_file->GetLocationChecksum())) {
140        return false;
141      }
142    }
143    return DoWriteElf(file, oat_writer, key_value_store, verify);
144  }
145
146  bool WriteElf(File* file,
147                const std::vector<const char*>& dex_filenames,
148                SafeMap<std::string, std::string>& key_value_store,
149                bool verify) {
150    TimingLogger timings("WriteElf", false, false);
151    OatWriter oat_writer(/*compiling_boot_image*/false, &timings);
152    for (const char* dex_filename : dex_filenames) {
153      if (!oat_writer.AddDexFileSource(dex_filename, dex_filename)) {
154        return false;
155      }
156    }
157    return DoWriteElf(file, oat_writer, key_value_store, verify);
158  }
159
160  bool WriteElf(File* file,
161                ScopedFd&& zip_fd,
162                const char* location,
163                SafeMap<std::string, std::string>& key_value_store,
164                bool verify) {
165    TimingLogger timings("WriteElf", false, false);
166    OatWriter oat_writer(/*compiling_boot_image*/false, &timings);
167    if (!oat_writer.AddZippedDexFilesSource(std::move(zip_fd), location)) {
168      return false;
169    }
170    return DoWriteElf(file, oat_writer, key_value_store, verify);
171  }
172
173  bool DoWriteElf(File* file,
174                  OatWriter& oat_writer,
175                  SafeMap<std::string, std::string>& key_value_store,
176                  bool verify) {
177    std::unique_ptr<ElfWriter> elf_writer = CreateElfWriterQuick(
178        compiler_driver_->GetInstructionSet(),
179        compiler_driver_->GetInstructionSetFeatures(),
180        &compiler_driver_->GetCompilerOptions(),
181        file);
182    elf_writer->Start();
183    OutputStream* rodata = elf_writer->StartRoData();
184    std::unique_ptr<MemMap> opened_dex_files_map;
185    std::vector<std::unique_ptr<const DexFile>> opened_dex_files;
186    if (!oat_writer.WriteAndOpenDexFiles(rodata,
187                                         file,
188                                         compiler_driver_->GetInstructionSet(),
189                                         compiler_driver_->GetInstructionSetFeatures(),
190                                         &key_value_store,
191                                         verify,
192                                         &opened_dex_files_map,
193                                         &opened_dex_files)) {
194      return false;
195    }
196    Runtime* runtime = Runtime::Current();
197    ClassLinker* const class_linker = runtime->GetClassLinker();
198    std::vector<const DexFile*> dex_files;
199    for (const std::unique_ptr<const DexFile>& dex_file : opened_dex_files) {
200      dex_files.push_back(dex_file.get());
201      ScopedObjectAccess soa(Thread::Current());
202      class_linker->RegisterDexFile(*dex_file, nullptr);
203    }
204    linker::MultiOatRelativePatcher patcher(compiler_driver_->GetInstructionSet(),
205                                            instruction_set_features_.get());
206    oat_writer.PrepareLayout(compiler_driver_.get(), nullptr, dex_files, &patcher);
207    size_t rodata_size = oat_writer.GetOatHeader().GetExecutableOffset();
208    size_t text_size = oat_writer.GetSize() - rodata_size;
209    elf_writer->SetLoadedSectionSizes(rodata_size, text_size, oat_writer.GetBssSize());
210
211    if (!oat_writer.WriteRodata(rodata)) {
212      return false;
213    }
214    elf_writer->EndRoData(rodata);
215
216    OutputStream* text = elf_writer->StartText();
217    if (!oat_writer.WriteCode(text)) {
218      return false;
219    }
220    elf_writer->EndText(text);
221
222    if (!oat_writer.WriteHeader(elf_writer->GetStream(), 42U, 4096U, 0)) {
223      return false;
224    }
225
226    elf_writer->WriteDynamicSection();
227    elf_writer->WriteDebugInfo(oat_writer.GetMethodDebugInfo());
228    elf_writer->WritePatchLocations(oat_writer.GetAbsolutePatchLocations());
229
230    return elf_writer->End();
231  }
232
233  void TestDexFileInput(bool verify, bool low_4gb);
234  void TestZipFileInput(bool verify);
235
236  std::unique_ptr<const InstructionSetFeatures> insn_features_;
237  std::unique_ptr<QuickCompilerCallbacks> callbacks_;
238};
239
240class ZipBuilder {
241 public:
242  explicit ZipBuilder(File* zip_file) : zip_file_(zip_file) { }
243
244  bool AddFile(const char* location, const void* data, size_t size) {
245    off_t offset = lseek(zip_file_->Fd(), 0, SEEK_CUR);
246    if (offset == static_cast<off_t>(-1)) {
247      return false;
248    }
249
250    ZipFileHeader file_header;
251    file_header.crc32 = crc32(0u, reinterpret_cast<const Bytef*>(data), size);
252    file_header.compressed_size = size;
253    file_header.uncompressed_size = size;
254    file_header.filename_length = strlen(location);
255
256    if (!zip_file_->WriteFully(&file_header, sizeof(file_header)) ||
257        !zip_file_->WriteFully(location, file_header.filename_length) ||
258        !zip_file_->WriteFully(data, size)) {
259      return false;
260    }
261
262    CentralDirectoryFileHeader cdfh;
263    cdfh.crc32 = file_header.crc32;
264    cdfh.compressed_size = size;
265    cdfh.uncompressed_size = size;
266    cdfh.filename_length = file_header.filename_length;
267    cdfh.relative_offset_of_local_file_header = offset;
268    file_data_.push_back(FileData { cdfh, location });
269    return true;
270  }
271
272  bool Finish() {
273    off_t offset = lseek(zip_file_->Fd(), 0, SEEK_CUR);
274    if (offset == static_cast<off_t>(-1)) {
275      return false;
276    }
277
278    size_t central_directory_size = 0u;
279    for (const FileData& file_data : file_data_) {
280      if (!zip_file_->WriteFully(&file_data.cdfh, sizeof(file_data.cdfh)) ||
281          !zip_file_->WriteFully(file_data.location, file_data.cdfh.filename_length)) {
282        return false;
283      }
284      central_directory_size += sizeof(file_data.cdfh) + file_data.cdfh.filename_length;
285    }
286    EndOfCentralDirectoryRecord eocd_record;
287    eocd_record.number_of_central_directory_records_on_this_disk = file_data_.size();
288    eocd_record.total_number_of_central_directory_records = file_data_.size();
289    eocd_record.size_of_central_directory = central_directory_size;
290    eocd_record.offset_of_start_of_central_directory = offset;
291    return
292        zip_file_->WriteFully(&eocd_record, sizeof(eocd_record)) &&
293        zip_file_->Flush() == 0;
294  }
295
296 private:
297  struct PACKED(1) ZipFileHeader {
298    uint32_t signature = 0x04034b50;
299    uint16_t version_needed_to_extract = 10;
300    uint16_t general_purpose_bit_flag = 0;
301    uint16_t compression_method = 0;            // 0 = store only.
302    uint16_t file_last_modification_time = 0u;
303    uint16_t file_last_modification_date = 0u;
304    uint32_t crc32;
305    uint32_t compressed_size;
306    uint32_t uncompressed_size;
307    uint16_t filename_length;
308    uint16_t extra_field_length = 0u;           // No extra fields.
309  };
310
311  struct PACKED(1) CentralDirectoryFileHeader {
312    uint32_t signature = 0x02014b50;
313    uint16_t version_made_by = 10;
314    uint16_t version_needed_to_extract = 10;
315    uint16_t general_purpose_bit_flag = 0;
316    uint16_t compression_method = 0;            // 0 = store only.
317    uint16_t file_last_modification_time = 0u;
318    uint16_t file_last_modification_date = 0u;
319    uint32_t crc32;
320    uint32_t compressed_size;
321    uint32_t uncompressed_size;
322    uint16_t filename_length;
323    uint16_t extra_field_length = 0u;           // No extra fields.
324    uint16_t file_comment_length = 0u;          // No file comment.
325    uint16_t disk_number_where_file_starts = 0u;
326    uint16_t internal_file_attributes = 0u;
327    uint32_t external_file_attributes = 0u;
328    uint32_t relative_offset_of_local_file_header;
329  };
330
331  struct PACKED(1) EndOfCentralDirectoryRecord {
332    uint32_t signature = 0x06054b50;
333    uint16_t number_of_this_disk = 0u;
334    uint16_t disk_where_central_directory_starts = 0u;
335    uint16_t number_of_central_directory_records_on_this_disk;
336    uint16_t total_number_of_central_directory_records;
337    uint32_t size_of_central_directory;
338    uint32_t offset_of_start_of_central_directory;
339    uint16_t comment_length = 0u;               // No file comment.
340  };
341
342  struct FileData {
343    CentralDirectoryFileHeader cdfh;
344    const char* location;
345  };
346
347  File* zip_file_;
348  std::vector<FileData> file_data_;
349};
350
351TEST_F(OatTest, WriteRead) {
352  TimingLogger timings("OatTest::WriteRead", false, false);
353  ClassLinker* class_linker = Runtime::Current()->GetClassLinker();
354
355  // TODO: make selectable.
356  Compiler::Kind compiler_kind = Compiler::kQuick;
357  InstructionSet insn_set = kIsTargetBuild ? kThumb2 : kX86;
358  std::string error_msg;
359  SetupCompiler(compiler_kind, insn_set, std::vector<std::string>(), /*out*/ &error_msg);
360
361  jobject class_loader = nullptr;
362  if (kCompile) {
363    TimingLogger timings2("OatTest::WriteRead", false, false);
364    compiler_driver_->SetDexFilesForOatFile(class_linker->GetBootClassPath());
365    compiler_driver_->CompileAll(class_loader, class_linker->GetBootClassPath(), &timings2);
366  }
367
368  ScratchFile tmp;
369  SafeMap<std::string, std::string> key_value_store;
370  key_value_store.Put(OatHeader::kImageLocationKey, "lue.art");
371  bool success = WriteElf(tmp.GetFile(), class_linker->GetBootClassPath(), key_value_store, false);
372  ASSERT_TRUE(success);
373
374  if (kCompile) {  // OatWriter strips the code, regenerate to compare
375    compiler_driver_->CompileAll(class_loader, class_linker->GetBootClassPath(), &timings);
376  }
377  std::unique_ptr<OatFile> oat_file(OatFile::Open(tmp.GetFilename(),
378                                                  tmp.GetFilename(),
379                                                  nullptr,
380                                                  nullptr,
381                                                  false,
382                                                  /*low_4gb*/true,
383                                                  nullptr,
384                                                  &error_msg));
385  ASSERT_TRUE(oat_file.get() != nullptr) << error_msg;
386  const OatHeader& oat_header = oat_file->GetOatHeader();
387  ASSERT_TRUE(oat_header.IsValid());
388  ASSERT_EQ(class_linker->GetBootClassPath().size(), oat_header.GetDexFileCount());  // core
389  ASSERT_EQ(42U, oat_header.GetImageFileLocationOatChecksum());
390  ASSERT_EQ(4096U, oat_header.GetImageFileLocationOatDataBegin());
391  ASSERT_EQ("lue.art", std::string(oat_header.GetStoreValueByKey(OatHeader::kImageLocationKey)));
392
393  ASSERT_TRUE(java_lang_dex_file_ != nullptr);
394  const DexFile& dex_file = *java_lang_dex_file_;
395  uint32_t dex_file_checksum = dex_file.GetLocationChecksum();
396  const OatFile::OatDexFile* oat_dex_file = oat_file->GetOatDexFile(dex_file.GetLocation().c_str(),
397                                                                    &dex_file_checksum);
398  ASSERT_TRUE(oat_dex_file != nullptr);
399  CHECK_EQ(dex_file.GetLocationChecksum(), oat_dex_file->GetDexFileLocationChecksum());
400  ScopedObjectAccess soa(Thread::Current());
401  auto pointer_size = class_linker->GetImagePointerSize();
402  for (size_t i = 0; i < dex_file.NumClassDefs(); i++) {
403    const DexFile::ClassDef& class_def = dex_file.GetClassDef(i);
404    const uint8_t* class_data = dex_file.GetClassData(class_def);
405
406    size_t num_virtual_methods = 0;
407    if (class_data != nullptr) {
408      ClassDataItemIterator it(dex_file, class_data);
409      num_virtual_methods = it.NumVirtualMethods();
410    }
411
412    const char* descriptor = dex_file.GetClassDescriptor(class_def);
413    mirror::Class* klass = class_linker->FindClass(soa.Self(),
414                                                   descriptor,
415                                                   ScopedNullHandle<mirror::ClassLoader>());
416
417    const OatFile::OatClass oat_class = oat_dex_file->GetOatClass(i);
418    CHECK_EQ(mirror::Class::Status::kStatusNotReady, oat_class.GetStatus()) << descriptor;
419    CHECK_EQ(kCompile ? OatClassType::kOatClassAllCompiled : OatClassType::kOatClassNoneCompiled,
420             oat_class.GetType()) << descriptor;
421
422    size_t method_index = 0;
423    for (auto& m : klass->GetDirectMethods(pointer_size)) {
424      CheckMethod(&m, oat_class.GetOatMethod(method_index), dex_file);
425      ++method_index;
426    }
427    size_t visited_virtuals = 0;
428    // TODO We should also check copied methods in this test.
429    for (auto& m : klass->GetDeclaredVirtualMethods(pointer_size)) {
430      if (!klass->IsInterface()) {
431        EXPECT_FALSE(m.IsCopied());
432      }
433      CheckMethod(&m, oat_class.GetOatMethod(method_index), dex_file);
434      ++method_index;
435      ++visited_virtuals;
436    }
437    EXPECT_EQ(visited_virtuals, num_virtual_methods);
438  }
439}
440
441TEST_F(OatTest, OatHeaderSizeCheck) {
442  // If this test is failing and you have to update these constants,
443  // it is time to update OatHeader::kOatVersion
444  EXPECT_EQ(72U, sizeof(OatHeader));
445  EXPECT_EQ(4U, sizeof(OatMethodOffsets));
446  EXPECT_EQ(20U, sizeof(OatQuickMethodHeader));
447  EXPECT_EQ(132 * GetInstructionSetPointerSize(kRuntimeISA), sizeof(QuickEntryPoints));
448}
449
450TEST_F(OatTest, OatHeaderIsValid) {
451  InstructionSet insn_set = kX86;
452  std::string error_msg;
453  std::unique_ptr<const InstructionSetFeatures> insn_features(
454    InstructionSetFeatures::FromVariant(insn_set, "default", &error_msg));
455  ASSERT_TRUE(insn_features.get() != nullptr) << error_msg;
456  std::unique_ptr<OatHeader> oat_header(OatHeader::Create(insn_set,
457                                                          insn_features.get(),
458                                                          0u,
459                                                          nullptr));
460  ASSERT_NE(oat_header.get(), nullptr);
461  ASSERT_TRUE(oat_header->IsValid());
462
463  char* magic = const_cast<char*>(oat_header->GetMagic());
464  strcpy(magic, "");  // bad magic
465  ASSERT_FALSE(oat_header->IsValid());
466  strcpy(magic, "oat\n000");  // bad version
467  ASSERT_FALSE(oat_header->IsValid());
468}
469
470TEST_F(OatTest, EmptyTextSection) {
471  TimingLogger timings("OatTest::EmptyTextSection", false, false);
472
473  // TODO: make selectable.
474  Compiler::Kind compiler_kind = Compiler::kQuick;
475  InstructionSet insn_set = kRuntimeISA;
476  if (insn_set == kArm) insn_set = kThumb2;
477  std::string error_msg;
478  std::vector<std::string> compiler_options;
479  compiler_options.push_back("--compiler-filter=verify-at-runtime");
480  SetupCompiler(compiler_kind, insn_set, compiler_options, /*out*/ &error_msg);
481
482  jobject class_loader;
483  {
484    ScopedObjectAccess soa(Thread::Current());
485    class_loader = LoadDex("Main");
486  }
487  ASSERT_TRUE(class_loader != nullptr);
488  std::vector<const DexFile*> dex_files = GetDexFiles(class_loader);
489  ASSERT_TRUE(!dex_files.empty());
490
491  ClassLinker* const class_linker = Runtime::Current()->GetClassLinker();
492  for (const DexFile* dex_file : dex_files) {
493    ScopedObjectAccess soa(Thread::Current());
494    class_linker->RegisterDexFile(*dex_file, soa.Decode<mirror::ClassLoader*>(class_loader));
495  }
496  compiler_driver_->SetDexFilesForOatFile(dex_files);
497  compiler_driver_->CompileAll(class_loader, dex_files, &timings);
498
499  ScratchFile tmp;
500  SafeMap<std::string, std::string> key_value_store;
501  key_value_store.Put(OatHeader::kImageLocationKey, "test.art");
502  bool success = WriteElf(tmp.GetFile(), dex_files, key_value_store, false);
503  ASSERT_TRUE(success);
504
505  std::unique_ptr<OatFile> oat_file(OatFile::Open(tmp.GetFilename(),
506                                                  tmp.GetFilename(),
507                                                  nullptr,
508                                                  nullptr,
509                                                  false,
510                                                  /*low_4gb*/false,
511                                                  nullptr,
512                                                  &error_msg));
513  ASSERT_TRUE(oat_file != nullptr);
514  EXPECT_LT(static_cast<size_t>(oat_file->Size()), static_cast<size_t>(tmp.GetFile()->GetLength()));
515}
516
517static void MaybeModifyDexFileToFail(bool verify, std::unique_ptr<const DexFile>& data) {
518  // If in verify mode (= fail the verifier mode), make sure we fail early. We'll fail already
519  // because of the missing map, but that may lead to out of bounds reads.
520  if (verify) {
521    const_cast<DexFile::Header*>(&data->GetHeader())->checksum_++;
522  }
523}
524
525void OatTest::TestDexFileInput(bool verify, bool low_4gb) {
526  TimingLogger timings("OatTest::DexFileInput", false, false);
527
528  std::vector<const char*> input_filenames;
529
530  ScratchFile dex_file1;
531  TestDexFileBuilder builder1;
532  builder1.AddField("Lsome.TestClass;", "int", "someField");
533  builder1.AddMethod("Lsome.TestClass;", "()I", "foo");
534  std::unique_ptr<const DexFile> dex_file1_data = builder1.Build(dex_file1.GetFilename());
535
536  MaybeModifyDexFileToFail(verify, dex_file1_data);
537
538  bool success = dex_file1.GetFile()->WriteFully(&dex_file1_data->GetHeader(),
539                                                 dex_file1_data->GetHeader().file_size_);
540  ASSERT_TRUE(success);
541  success = dex_file1.GetFile()->Flush() == 0;
542  ASSERT_TRUE(success);
543  input_filenames.push_back(dex_file1.GetFilename().c_str());
544
545  ScratchFile dex_file2;
546  TestDexFileBuilder builder2;
547  builder2.AddField("Land.AnotherTestClass;", "boolean", "someOtherField");
548  builder2.AddMethod("Land.AnotherTestClass;", "()J", "bar");
549  std::unique_ptr<const DexFile> dex_file2_data = builder2.Build(dex_file2.GetFilename());
550
551  MaybeModifyDexFileToFail(verify, dex_file2_data);
552
553  success = dex_file2.GetFile()->WriteFully(&dex_file2_data->GetHeader(),
554                                            dex_file2_data->GetHeader().file_size_);
555  ASSERT_TRUE(success);
556  success = dex_file2.GetFile()->Flush() == 0;
557  ASSERT_TRUE(success);
558  input_filenames.push_back(dex_file2.GetFilename().c_str());
559
560  ScratchFile oat_file;
561  SafeMap<std::string, std::string> key_value_store;
562  key_value_store.Put(OatHeader::kImageLocationKey, "test.art");
563  success = WriteElf(oat_file.GetFile(), input_filenames, key_value_store, verify);
564
565  // In verify mode, we expect failure.
566  if (verify) {
567    ASSERT_FALSE(success);
568    return;
569  }
570
571  ASSERT_TRUE(success);
572
573  std::string error_msg;
574  std::unique_ptr<OatFile> opened_oat_file(OatFile::Open(oat_file.GetFilename(),
575                                                         oat_file.GetFilename(),
576                                                         nullptr,
577                                                         nullptr,
578                                                         false,
579                                                         low_4gb,
580                                                         nullptr,
581                                                         &error_msg));
582  if (low_4gb) {
583    uintptr_t begin = reinterpret_cast<uintptr_t>(opened_oat_file->Begin());
584    EXPECT_EQ(begin, static_cast<uint32_t>(begin));
585  }
586  ASSERT_TRUE(opened_oat_file != nullptr);
587  ASSERT_EQ(2u, opened_oat_file->GetOatDexFiles().size());
588  std::unique_ptr<const DexFile> opened_dex_file1 =
589      opened_oat_file->GetOatDexFiles()[0]->OpenDexFile(&error_msg);
590  std::unique_ptr<const DexFile> opened_dex_file2 =
591      opened_oat_file->GetOatDexFiles()[1]->OpenDexFile(&error_msg);
592
593  ASSERT_EQ(dex_file1_data->GetHeader().file_size_, opened_dex_file1->GetHeader().file_size_);
594  ASSERT_EQ(0, memcmp(&dex_file1_data->GetHeader(),
595                      &opened_dex_file1->GetHeader(),
596                      dex_file1_data->GetHeader().file_size_));
597  ASSERT_EQ(dex_file1_data->GetLocation(), opened_dex_file1->GetLocation());
598
599  ASSERT_EQ(dex_file2_data->GetHeader().file_size_, opened_dex_file2->GetHeader().file_size_);
600  ASSERT_EQ(0, memcmp(&dex_file2_data->GetHeader(),
601                      &opened_dex_file2->GetHeader(),
602                      dex_file2_data->GetHeader().file_size_));
603  ASSERT_EQ(dex_file2_data->GetLocation(), opened_dex_file2->GetLocation());
604}
605
606TEST_F(OatTest, DexFileInputCheckOutput) {
607  TestDexFileInput(false, /*low_4gb*/false);
608}
609
610TEST_F(OatTest, DexFileInputCheckOutputLow4GB) {
611  TestDexFileInput(false, /*low_4gb*/true);
612}
613
614TEST_F(OatTest, DexFileInputCheckVerifier) {
615  TestDexFileInput(true, /*low_4gb*/false);
616}
617
618void OatTest::TestZipFileInput(bool verify) {
619  TimingLogger timings("OatTest::DexFileInput", false, false);
620
621  ScratchFile zip_file;
622  ZipBuilder zip_builder(zip_file.GetFile());
623
624  ScratchFile dex_file1;
625  TestDexFileBuilder builder1;
626  builder1.AddField("Lsome.TestClass;", "long", "someField");
627  builder1.AddMethod("Lsome.TestClass;", "()D", "foo");
628  std::unique_ptr<const DexFile> dex_file1_data = builder1.Build(dex_file1.GetFilename());
629
630  MaybeModifyDexFileToFail(verify, dex_file1_data);
631
632  bool success = dex_file1.GetFile()->WriteFully(&dex_file1_data->GetHeader(),
633                                                 dex_file1_data->GetHeader().file_size_);
634  ASSERT_TRUE(success);
635  success = dex_file1.GetFile()->Flush() == 0;
636  ASSERT_TRUE(success);
637  success = zip_builder.AddFile("classes.dex",
638                                &dex_file1_data->GetHeader(),
639                                dex_file1_data->GetHeader().file_size_);
640  ASSERT_TRUE(success);
641
642  ScratchFile dex_file2;
643  TestDexFileBuilder builder2;
644  builder2.AddField("Land.AnotherTestClass;", "boolean", "someOtherField");
645  builder2.AddMethod("Land.AnotherTestClass;", "()J", "bar");
646  std::unique_ptr<const DexFile> dex_file2_data = builder2.Build(dex_file2.GetFilename());
647
648  MaybeModifyDexFileToFail(verify, dex_file2_data);
649
650  success = dex_file2.GetFile()->WriteFully(&dex_file2_data->GetHeader(),
651                                            dex_file2_data->GetHeader().file_size_);
652  ASSERT_TRUE(success);
653  success = dex_file2.GetFile()->Flush() == 0;
654  ASSERT_TRUE(success);
655  success = zip_builder.AddFile("classes2.dex",
656                                &dex_file2_data->GetHeader(),
657                                dex_file2_data->GetHeader().file_size_);
658  ASSERT_TRUE(success);
659
660  success = zip_builder.Finish();
661  ASSERT_TRUE(success) << strerror(errno);
662
663  SafeMap<std::string, std::string> key_value_store;
664  key_value_store.Put(OatHeader::kImageLocationKey, "test.art");
665  {
666    // Test using the AddDexFileSource() interface with the zip file.
667    std::vector<const char*> input_filenames { zip_file.GetFilename().c_str() };  // NOLINT [readability/braces] [4]
668
669    ScratchFile oat_file;
670    success = WriteElf(oat_file.GetFile(), input_filenames, key_value_store, verify);
671
672    if (verify) {
673      ASSERT_FALSE(success);
674    } else {
675      ASSERT_TRUE(success);
676
677      std::string error_msg;
678      std::unique_ptr<OatFile> opened_oat_file(OatFile::Open(oat_file.GetFilename(),
679                                                             oat_file.GetFilename(),
680                                                             nullptr,
681                                                             nullptr,
682                                                             false,
683                                                             /*low_4gb*/false,
684                                                             nullptr,
685                                                             &error_msg));
686      ASSERT_TRUE(opened_oat_file != nullptr);
687      ASSERT_EQ(2u, opened_oat_file->GetOatDexFiles().size());
688      std::unique_ptr<const DexFile> opened_dex_file1 =
689          opened_oat_file->GetOatDexFiles()[0]->OpenDexFile(&error_msg);
690      std::unique_ptr<const DexFile> opened_dex_file2 =
691          opened_oat_file->GetOatDexFiles()[1]->OpenDexFile(&error_msg);
692
693      ASSERT_EQ(dex_file1_data->GetHeader().file_size_, opened_dex_file1->GetHeader().file_size_);
694      ASSERT_EQ(0, memcmp(&dex_file1_data->GetHeader(),
695                          &opened_dex_file1->GetHeader(),
696                          dex_file1_data->GetHeader().file_size_));
697      ASSERT_EQ(DexFile::GetMultiDexLocation(0, zip_file.GetFilename().c_str()),
698                opened_dex_file1->GetLocation());
699
700      ASSERT_EQ(dex_file2_data->GetHeader().file_size_, opened_dex_file2->GetHeader().file_size_);
701      ASSERT_EQ(0, memcmp(&dex_file2_data->GetHeader(),
702                          &opened_dex_file2->GetHeader(),
703                          dex_file2_data->GetHeader().file_size_));
704      ASSERT_EQ(DexFile::GetMultiDexLocation(1, zip_file.GetFilename().c_str()),
705                opened_dex_file2->GetLocation());
706    }
707  }
708
709  {
710    // Test using the AddZipDexFileSource() interface with the zip file handle.
711    ScopedFd zip_fd(dup(zip_file.GetFd()));
712    ASSERT_NE(-1, zip_fd.get());
713
714    ScratchFile oat_file;
715    success = WriteElf(oat_file.GetFile(),
716                       std::move(zip_fd),
717                       zip_file.GetFilename().c_str(),
718                       key_value_store,
719                       verify);
720    if (verify) {
721      ASSERT_FALSE(success);
722    } else {
723      ASSERT_TRUE(success);
724
725      std::string error_msg;
726      std::unique_ptr<OatFile> opened_oat_file(OatFile::Open(oat_file.GetFilename(),
727                                                             oat_file.GetFilename(),
728                                                             nullptr,
729                                                             nullptr,
730                                                             false,
731                                                             /*low_4gb*/false,
732                                                             nullptr,
733                                                             &error_msg));
734      ASSERT_TRUE(opened_oat_file != nullptr);
735      ASSERT_EQ(2u, opened_oat_file->GetOatDexFiles().size());
736      std::unique_ptr<const DexFile> opened_dex_file1 =
737          opened_oat_file->GetOatDexFiles()[0]->OpenDexFile(&error_msg);
738      std::unique_ptr<const DexFile> opened_dex_file2 =
739          opened_oat_file->GetOatDexFiles()[1]->OpenDexFile(&error_msg);
740
741      ASSERT_EQ(dex_file1_data->GetHeader().file_size_, opened_dex_file1->GetHeader().file_size_);
742      ASSERT_EQ(0, memcmp(&dex_file1_data->GetHeader(),
743                          &opened_dex_file1->GetHeader(),
744                          dex_file1_data->GetHeader().file_size_));
745      ASSERT_EQ(DexFile::GetMultiDexLocation(0, zip_file.GetFilename().c_str()),
746                opened_dex_file1->GetLocation());
747
748      ASSERT_EQ(dex_file2_data->GetHeader().file_size_, opened_dex_file2->GetHeader().file_size_);
749      ASSERT_EQ(0, memcmp(&dex_file2_data->GetHeader(),
750                          &opened_dex_file2->GetHeader(),
751                          dex_file2_data->GetHeader().file_size_));
752      ASSERT_EQ(DexFile::GetMultiDexLocation(1, zip_file.GetFilename().c_str()),
753                opened_dex_file2->GetLocation());
754    }
755  }
756}
757
758TEST_F(OatTest, ZipFileInputCheckOutput) {
759  TestZipFileInput(false);
760}
761
762TEST_F(OatTest, ZipFileInputCheckVerifier) {
763  TestZipFileInput(true);
764}
765
766TEST_F(OatTest, UpdateChecksum) {
767  InstructionSet insn_set = kX86;
768  std::string error_msg;
769  std::unique_ptr<const InstructionSetFeatures> insn_features(
770    InstructionSetFeatures::FromVariant(insn_set, "default", &error_msg));
771  ASSERT_TRUE(insn_features.get() != nullptr) << error_msg;
772  std::unique_ptr<OatHeader> oat_header(OatHeader::Create(insn_set,
773                                                          insn_features.get(),
774                                                          0u,
775                                                          nullptr));
776  // The starting adler32 value is 1.
777  EXPECT_EQ(1U, oat_header->GetChecksum());
778
779  oat_header->UpdateChecksum(OatHeader::kOatMagic, sizeof(OatHeader::kOatMagic));
780  EXPECT_EQ(64291151U, oat_header->GetChecksum());
781
782  // Make sure that null data does not reset the checksum.
783  oat_header->UpdateChecksum(nullptr, 0);
784  EXPECT_EQ(64291151U, oat_header->GetChecksum());
785
786  oat_header->UpdateChecksum(OatHeader::kOatMagic, sizeof(OatHeader::kOatMagic));
787  EXPECT_EQ(216138397U, oat_header->GetChecksum());
788}
789
790}  // namespace art
791