Elliott Hughes | 2faa5f1 | 2012-01-30 14:42:07 -0800 | [diff] [blame] | 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 | */ |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 16 | |
| 17 | #include "image.h" |
| 18 | |
Mathieu Chartier | 1a84296 | 2018-11-13 15:09:51 -0800 | [diff] [blame] | 19 | #include <lz4.h> |
| 20 | #include <sstream> |
| 21 | |
Vladimir Marko | 80afd02 | 2015-05-19 18:08:00 +0100 | [diff] [blame] | 22 | #include "base/bit_utils.h" |
Andreas Gampe | c6ea7d0 | 2017-02-01 16:46:28 -0800 | [diff] [blame] | 23 | #include "base/length_prefixed_array.h" |
David Sehr | c431b9d | 2018-03-02 12:01:51 -0800 | [diff] [blame] | 24 | #include "base/utils.h" |
Ian Rogers | 4f6ad8a | 2013-03-18 15:27:28 -0700 | [diff] [blame] | 25 | #include "mirror/object-inl.h" |
Andreas Gampe | 8cf9cb3 | 2017-07-19 09:28:38 -0700 | [diff] [blame] | 26 | #include "mirror/object_array-inl.h" |
| 27 | #include "mirror/object_array.h" |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 28 | |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 29 | namespace art { |
| 30 | |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 31 | const uint8_t ImageHeader::kImageMagic[] = { 'a', 'r', 't', '\n' }; |
Vladimir Marko | 92eec3a | 2019-11-05 10:59:36 +0000 | [diff] [blame^] | 32 | const uint8_t ImageHeader::kImageVersion[] = { '0', '8', '0', '\0' }; // Chained checksums. |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 33 | |
Vladimir Marko | 7391c8c | 2018-11-21 17:58:44 +0000 | [diff] [blame] | 34 | ImageHeader::ImageHeader(uint32_t image_reservation_size, |
| 35 | uint32_t component_count, |
| 36 | uint32_t image_begin, |
Mathieu Chartier | 31e8925 | 2013-08-28 11:29:12 -0700 | [diff] [blame] | 37 | uint32_t image_size, |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 38 | ImageSection* sections, |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 39 | uint32_t image_roots, |
| 40 | uint32_t oat_checksum, |
| 41 | uint32_t oat_file_begin, |
| 42 | uint32_t oat_data_begin, |
| 43 | uint32_t oat_data_end, |
Igor Murashkin | 4677476 | 2014-10-22 11:37:02 -0700 | [diff] [blame] | 44 | uint32_t oat_file_end, |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 45 | uint32_t boot_image_begin, |
| 46 | uint32_t boot_image_size, |
Vladimir Marko | 92eec3a | 2019-11-05 10:59:36 +0000 | [diff] [blame^] | 47 | uint32_t boot_image_component_count, |
| 48 | uint32_t boot_image_checksum, |
Mathieu Chartier | 1a84296 | 2018-11-13 15:09:51 -0800 | [diff] [blame] | 49 | uint32_t pointer_size) |
Vladimir Marko | 7391c8c | 2018-11-21 17:58:44 +0000 | [diff] [blame] | 50 | : image_reservation_size_(image_reservation_size), |
| 51 | component_count_(component_count), |
| 52 | image_begin_(image_begin), |
Mathieu Chartier | 31e8925 | 2013-08-28 11:29:12 -0700 | [diff] [blame] | 53 | image_size_(image_size), |
Vladimir Marko | c10a0c6 | 2018-11-16 11:39:22 +0000 | [diff] [blame] | 54 | image_checksum_(0u), |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 55 | oat_checksum_(oat_checksum), |
| 56 | oat_file_begin_(oat_file_begin), |
| 57 | oat_data_begin_(oat_data_begin), |
| 58 | oat_data_end_(oat_data_end), |
| 59 | oat_file_end_(oat_file_end), |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 60 | boot_image_begin_(boot_image_begin), |
| 61 | boot_image_size_(boot_image_size), |
Vladimir Marko | 92eec3a | 2019-11-05 10:59:36 +0000 | [diff] [blame^] | 62 | boot_image_component_count_(boot_image_component_count), |
| 63 | boot_image_checksum_(boot_image_checksum), |
Igor Murashkin | 4677476 | 2014-10-22 11:37:02 -0700 | [diff] [blame] | 64 | image_roots_(image_roots), |
Mathieu Chartier | 1a84296 | 2018-11-13 15:09:51 -0800 | [diff] [blame] | 65 | pointer_size_(pointer_size) { |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 66 | CHECK_EQ(image_begin, RoundUp(image_begin, kPageSize)); |
| 67 | CHECK_EQ(oat_file_begin, RoundUp(oat_file_begin, kPageSize)); |
| 68 | CHECK_EQ(oat_data_begin, RoundUp(oat_data_begin, kPageSize)); |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 69 | CHECK_LT(image_roots, oat_file_begin); |
| 70 | CHECK_LE(oat_file_begin, oat_data_begin); |
| 71 | CHECK_LT(oat_data_begin, oat_data_end); |
| 72 | CHECK_LE(oat_data_end, oat_file_end); |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 73 | CHECK(ValidPointerSize(pointer_size_)) << pointer_size_; |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 74 | memcpy(magic_, kImageMagic, sizeof(kImageMagic)); |
| 75 | memcpy(version_, kImageVersion, sizeof(kImageVersion)); |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 76 | std::copy_n(sections, kSectionCount, sections_); |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 77 | } |
| 78 | |
Vladimir Marko | c0b30c9 | 2019-07-23 14:58:25 +0100 | [diff] [blame] | 79 | void ImageHeader::RelocateImageReferences(int64_t delta) { |
| 80 | CHECK_ALIGNED(delta, kPageSize) << "relocation delta must be page aligned"; |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 81 | oat_file_begin_ += delta; |
| 82 | oat_data_begin_ += delta; |
| 83 | oat_data_end_ += delta; |
| 84 | oat_file_end_ += delta; |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 85 | image_begin_ += delta; |
| 86 | image_roots_ += delta; |
| 87 | } |
| 88 | |
Vladimir Marko | c0b30c9 | 2019-07-23 14:58:25 +0100 | [diff] [blame] | 89 | void ImageHeader::RelocateBootImageReferences(int64_t delta) { |
| 90 | CHECK_ALIGNED(delta, kPageSize) << "relocation delta must be page aligned"; |
| 91 | DCHECK_EQ(boot_image_begin_ != 0u, boot_image_size_ != 0u); |
| 92 | if (boot_image_begin_ != 0u) { |
| 93 | boot_image_begin_ += delta; |
| 94 | } |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 95 | for (size_t i = 0; i < kImageMethodsCount; ++i) { |
| 96 | image_methods_[i] += delta; |
| 97 | } |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 98 | } |
| 99 | |
Vladimir Marko | 2191069 | 2019-11-06 13:27:03 +0000 | [diff] [blame] | 100 | bool ImageHeader::IsAppImage() const { |
| 101 | // Unlike boot image and boot image extensions which include address space for |
| 102 | // oat files in their reservation size, app images are loaded separately from oat |
| 103 | // files and their reservation size is the image size rounded up to full page. |
| 104 | return image_reservation_size_ == RoundUp(image_size_, kPageSize); |
| 105 | } |
| 106 | |
Brian Carlstrom | 68708f5 | 2013-09-03 14:15:31 -0700 | [diff] [blame] | 107 | bool ImageHeader::IsValid() const { |
| 108 | if (memcmp(magic_, kImageMagic, sizeof(kImageMagic)) != 0) { |
| 109 | return false; |
| 110 | } |
| 111 | if (memcmp(version_, kImageVersion, sizeof(kImageVersion)) != 0) { |
| 112 | return false; |
| 113 | } |
Vladimir Marko | 7391c8c | 2018-11-21 17:58:44 +0000 | [diff] [blame] | 114 | if (!IsAligned<kPageSize>(image_reservation_size_)) { |
| 115 | return false; |
| 116 | } |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 117 | // Unsigned so wraparound is well defined. |
| 118 | if (image_begin_ >= image_begin_ + image_size_) { |
| 119 | return false; |
| 120 | } |
| 121 | if (oat_file_begin_ > oat_file_end_) { |
| 122 | return false; |
| 123 | } |
| 124 | if (oat_data_begin_ > oat_data_end_) { |
| 125 | return false; |
| 126 | } |
| 127 | if (oat_file_begin_ >= oat_data_begin_) { |
| 128 | return false; |
| 129 | } |
Brian Carlstrom | 68708f5 | 2013-09-03 14:15:31 -0700 | [diff] [blame] | 130 | return true; |
| 131 | } |
| 132 | |
| 133 | const char* ImageHeader::GetMagic() const { |
| 134 | CHECK(IsValid()); |
| 135 | return reinterpret_cast<const char*>(magic_); |
| 136 | } |
| 137 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 138 | ArtMethod* ImageHeader::GetImageMethod(ImageMethod index) const { |
| 139 | CHECK_LT(static_cast<size_t>(index), kImageMethodsCount); |
| 140 | return reinterpret_cast<ArtMethod*>(image_methods_[index]); |
| 141 | } |
| 142 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 143 | std::ostream& operator<<(std::ostream& os, const ImageSection& section) { |
| 144 | return os << "size=" << section.Size() << " range=" << section.Offset() << "-" << section.End(); |
| 145 | } |
| 146 | |
David Sehr | a49e053 | 2017-08-25 08:05:29 -0700 | [diff] [blame] | 147 | void ImageHeader::VisitObjects(ObjectVisitor* visitor, |
| 148 | uint8_t* base, |
| 149 | PointerSize pointer_size) const { |
| 150 | DCHECK_EQ(pointer_size, GetPointerSize()); |
| 151 | const ImageSection& objects = GetObjectsSection(); |
| 152 | static const size_t kStartPos = RoundUp(sizeof(ImageHeader), kObjectAlignment); |
| 153 | for (size_t pos = kStartPos; pos < objects.Size(); ) { |
| 154 | mirror::Object* object = reinterpret_cast<mirror::Object*>(base + objects.Offset() + pos); |
| 155 | visitor->Visit(object); |
| 156 | pos += RoundUp(object->SizeOf(), kObjectAlignment); |
| 157 | } |
| 158 | } |
| 159 | |
Andreas Gampe | bda1d60 | 2016-08-29 17:43:45 -0700 | [diff] [blame] | 160 | PointerSize ImageHeader::GetPointerSize() const { |
| 161 | return ConvertToPointerSize(pointer_size_); |
| 162 | } |
| 163 | |
Mathieu Chartier | 1a84296 | 2018-11-13 15:09:51 -0800 | [diff] [blame] | 164 | bool ImageHeader::Block::Decompress(uint8_t* out_ptr, |
| 165 | const uint8_t* in_ptr, |
| 166 | std::string* error_msg) const { |
| 167 | switch (storage_mode_) { |
| 168 | case kStorageModeUncompressed: { |
| 169 | CHECK_EQ(image_size_, data_size_); |
| 170 | memcpy(out_ptr + image_offset_, in_ptr + data_offset_, data_size_); |
| 171 | break; |
| 172 | } |
| 173 | case kStorageModeLZ4: |
| 174 | case kStorageModeLZ4HC: { |
| 175 | // LZ4HC and LZ4 have same internal format, both use LZ4_decompress. |
| 176 | const size_t decompressed_size = LZ4_decompress_safe( |
| 177 | reinterpret_cast<const char*>(in_ptr) + data_offset_, |
| 178 | reinterpret_cast<char*>(out_ptr) + image_offset_, |
| 179 | data_size_, |
| 180 | image_size_); |
| 181 | CHECK_EQ(decompressed_size, image_size_); |
| 182 | break; |
| 183 | } |
| 184 | default: { |
| 185 | if (error_msg != nullptr) { |
| 186 | *error_msg = (std::ostringstream() << "Invalid image format " << storage_mode_).str(); |
| 187 | } |
| 188 | return false; |
| 189 | } |
| 190 | } |
| 191 | return true; |
| 192 | } |
| 193 | |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 194 | } // namespace art |