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 | |
Vladimir Marko | 80afd02 | 2015-05-19 18:08:00 +0100 | [diff] [blame] | 19 | #include "base/bit_utils.h" |
Andreas Gampe | c6ea7d0 | 2017-02-01 16:46:28 -0800 | [diff] [blame^] | 20 | #include "base/length_prefixed_array.h" |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 21 | #include "mirror/object_array.h" |
| 22 | #include "mirror/object_array-inl.h" |
Ian Rogers | 4f6ad8a | 2013-03-18 15:27:28 -0700 | [diff] [blame] | 23 | #include "mirror/object-inl.h" |
Andreas Gampe | bda1d60 | 2016-08-29 17:43:45 -0700 | [diff] [blame] | 24 | #include "utils.h" |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 25 | |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 26 | namespace art { |
| 27 | |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 28 | const uint8_t ImageHeader::kImageMagic[] = { 'a', 'r', 't', '\n' }; |
Vladimir Marko | f44d36c | 2017-03-14 14:18:46 +0000 | [diff] [blame] | 29 | const uint8_t ImageHeader::kImageVersion[] = { '0', '4', '3', '\0' }; // hash-based DexCache fields |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 30 | |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 31 | ImageHeader::ImageHeader(uint32_t image_begin, |
Mathieu Chartier | 31e8925 | 2013-08-28 11:29:12 -0700 | [diff] [blame] | 32 | uint32_t image_size, |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 33 | ImageSection* sections, |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 34 | uint32_t image_roots, |
| 35 | uint32_t oat_checksum, |
| 36 | uint32_t oat_file_begin, |
| 37 | uint32_t oat_data_begin, |
| 38 | uint32_t oat_data_end, |
Igor Murashkin | 4677476 | 2014-10-22 11:37:02 -0700 | [diff] [blame] | 39 | uint32_t oat_file_end, |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 40 | uint32_t boot_image_begin, |
| 41 | uint32_t boot_image_size, |
| 42 | uint32_t boot_oat_begin, |
| 43 | uint32_t boot_oat_size, |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 44 | uint32_t pointer_size, |
Mathieu Chartier | ceb07b3 | 2015-12-10 09:33:21 -0800 | [diff] [blame] | 45 | bool compile_pic, |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 46 | bool is_pic, |
Mathieu Chartier | ceb07b3 | 2015-12-10 09:33:21 -0800 | [diff] [blame] | 47 | StorageMode storage_mode, |
| 48 | size_t data_size) |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 49 | : image_begin_(image_begin), |
Mathieu Chartier | 31e8925 | 2013-08-28 11:29:12 -0700 | [diff] [blame] | 50 | image_size_(image_size), |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 51 | oat_checksum_(oat_checksum), |
| 52 | oat_file_begin_(oat_file_begin), |
| 53 | oat_data_begin_(oat_data_begin), |
| 54 | oat_data_end_(oat_data_end), |
| 55 | oat_file_end_(oat_file_end), |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 56 | boot_image_begin_(boot_image_begin), |
| 57 | boot_image_size_(boot_image_size), |
| 58 | boot_oat_begin_(boot_oat_begin), |
| 59 | boot_oat_size_(boot_oat_size), |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 60 | patch_delta_(0), |
Igor Murashkin | 4677476 | 2014-10-22 11:37:02 -0700 | [diff] [blame] | 61 | image_roots_(image_roots), |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 62 | pointer_size_(pointer_size), |
Mathieu Chartier | ceb07b3 | 2015-12-10 09:33:21 -0800 | [diff] [blame] | 63 | compile_pic_(compile_pic), |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 64 | is_pic_(is_pic), |
Mathieu Chartier | ceb07b3 | 2015-12-10 09:33:21 -0800 | [diff] [blame] | 65 | storage_mode_(storage_mode), |
| 66 | data_size_(data_size) { |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 67 | CHECK_EQ(image_begin, RoundUp(image_begin, kPageSize)); |
| 68 | CHECK_EQ(oat_file_begin, RoundUp(oat_file_begin, kPageSize)); |
| 69 | CHECK_EQ(oat_data_begin, RoundUp(oat_data_begin, kPageSize)); |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 70 | CHECK_LT(image_roots, oat_file_begin); |
| 71 | CHECK_LE(oat_file_begin, oat_data_begin); |
| 72 | CHECK_LT(oat_data_begin, oat_data_end); |
| 73 | CHECK_LE(oat_data_end, oat_file_end); |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 74 | CHECK(ValidPointerSize(pointer_size_)) << pointer_size_; |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 75 | memcpy(magic_, kImageMagic, sizeof(kImageMagic)); |
| 76 | memcpy(version_, kImageVersion, sizeof(kImageVersion)); |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 77 | std::copy_n(sections, kSectionCount, sections_); |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 78 | } |
| 79 | |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 80 | void ImageHeader::RelocateImage(off_t delta) { |
| 81 | CHECK_ALIGNED(delta, kPageSize) << " patch delta must be page aligned"; |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 82 | oat_file_begin_ += delta; |
| 83 | oat_data_begin_ += delta; |
| 84 | oat_data_end_ += delta; |
| 85 | oat_file_end_ += delta; |
Nicolas Geoffray | 1bc977c | 2016-01-23 14:15:49 +0000 | [diff] [blame] | 86 | patch_delta_ += delta; |
Mathieu Chartier | fbc3108 | 2016-01-24 11:59:56 -0800 | [diff] [blame] | 87 | RelocateImageObjects(delta); |
| 88 | RelocateImageMethods(delta); |
| 89 | } |
| 90 | |
| 91 | void ImageHeader::RelocateImageObjects(off_t delta) { |
| 92 | image_begin_ += delta; |
| 93 | image_roots_ += delta; |
| 94 | } |
| 95 | |
| 96 | void ImageHeader::RelocateImageMethods(off_t delta) { |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 97 | for (size_t i = 0; i < kImageMethodsCount; ++i) { |
| 98 | image_methods_[i] += delta; |
| 99 | } |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 100 | } |
| 101 | |
Brian Carlstrom | 68708f5 | 2013-09-03 14:15:31 -0700 | [diff] [blame] | 102 | bool ImageHeader::IsValid() const { |
| 103 | if (memcmp(magic_, kImageMagic, sizeof(kImageMagic)) != 0) { |
| 104 | return false; |
| 105 | } |
| 106 | if (memcmp(version_, kImageVersion, sizeof(kImageVersion)) != 0) { |
| 107 | return false; |
| 108 | } |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 109 | // Unsigned so wraparound is well defined. |
| 110 | if (image_begin_ >= image_begin_ + image_size_) { |
| 111 | return false; |
| 112 | } |
| 113 | if (oat_file_begin_ > oat_file_end_) { |
| 114 | return false; |
| 115 | } |
| 116 | if (oat_data_begin_ > oat_data_end_) { |
| 117 | return false; |
| 118 | } |
| 119 | if (oat_file_begin_ >= oat_data_begin_) { |
| 120 | return false; |
| 121 | } |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 122 | if (!IsAligned<kPageSize>(patch_delta_)) { |
| 123 | return false; |
| 124 | } |
Brian Carlstrom | 68708f5 | 2013-09-03 14:15:31 -0700 | [diff] [blame] | 125 | return true; |
| 126 | } |
| 127 | |
| 128 | const char* ImageHeader::GetMagic() const { |
| 129 | CHECK(IsValid()); |
| 130 | return reinterpret_cast<const char*>(magic_); |
| 131 | } |
| 132 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 133 | ArtMethod* ImageHeader::GetImageMethod(ImageMethod index) const { |
| 134 | CHECK_LT(static_cast<size_t>(index), kImageMethodsCount); |
| 135 | return reinterpret_cast<ArtMethod*>(image_methods_[index]); |
| 136 | } |
| 137 | |
| 138 | void ImageHeader::SetImageMethod(ImageMethod index, ArtMethod* method) { |
| 139 | CHECK_LT(static_cast<size_t>(index), kImageMethodsCount); |
| 140 | image_methods_[index] = reinterpret_cast<uint64_t>(method); |
| 141 | } |
| 142 | |
| 143 | const ImageSection& ImageHeader::GetImageSection(ImageSections index) const { |
| 144 | CHECK_LT(static_cast<size_t>(index), kSectionCount); |
| 145 | return sections_[index]; |
| 146 | } |
| 147 | |
| 148 | std::ostream& operator<<(std::ostream& os, const ImageSection& section) { |
| 149 | return os << "size=" << section.Size() << " range=" << section.Offset() << "-" << section.End(); |
| 150 | } |
| 151 | |
Mathieu Chartier | e42888f | 2016-04-14 10:49:19 -0700 | [diff] [blame] | 152 | void ImageHeader::VisitPackedArtFields(ArtFieldVisitor* visitor, uint8_t* base) const { |
| 153 | const ImageSection& fields = GetFieldsSection(); |
| 154 | for (size_t pos = 0; pos < fields.Size(); ) { |
| 155 | auto* array = reinterpret_cast<LengthPrefixedArray<ArtField>*>(base + fields.Offset() + pos); |
Vladimir Marko | 35831e8 | 2015-09-11 11:59:18 +0100 | [diff] [blame] | 156 | for (size_t i = 0; i < array->size(); ++i) { |
Mathieu Chartier | 54d220e | 2015-07-30 16:20:06 -0700 | [diff] [blame] | 157 | visitor->Visit(&array->At(i, sizeof(ArtField))); |
| 158 | } |
Vladimir Marko | 35831e8 | 2015-09-11 11:59:18 +0100 | [diff] [blame] | 159 | pos += array->ComputeSize(array->size()); |
Mathieu Chartier | 54d220e | 2015-07-30 16:20:06 -0700 | [diff] [blame] | 160 | } |
| 161 | } |
| 162 | |
Mathieu Chartier | e42888f | 2016-04-14 10:49:19 -0700 | [diff] [blame] | 163 | void ImageHeader::VisitPackedArtMethods(ArtMethodVisitor* visitor, |
| 164 | uint8_t* base, |
Andreas Gampe | 542451c | 2016-07-26 09:02:02 -0700 | [diff] [blame] | 165 | PointerSize pointer_size) const { |
Vladimir Marko | 1463285 | 2015-08-17 12:07:23 +0100 | [diff] [blame] | 166 | const size_t method_alignment = ArtMethod::Alignment(pointer_size); |
| 167 | const size_t method_size = ArtMethod::Size(pointer_size); |
Mathieu Chartier | e42888f | 2016-04-14 10:49:19 -0700 | [diff] [blame] | 168 | const ImageSection& methods = GetMethodsSection(); |
| 169 | for (size_t pos = 0; pos < methods.Size(); ) { |
| 170 | auto* array = reinterpret_cast<LengthPrefixedArray<ArtMethod>*>(base + methods.Offset() + pos); |
Vladimir Marko | 35831e8 | 2015-09-11 11:59:18 +0100 | [diff] [blame] | 171 | for (size_t i = 0; i < array->size(); ++i) { |
Vladimir Marko | cf36d49 | 2015-08-12 19:27:26 +0100 | [diff] [blame] | 172 | visitor->Visit(&array->At(i, method_size, method_alignment)); |
Mathieu Chartier | 54d220e | 2015-07-30 16:20:06 -0700 | [diff] [blame] | 173 | } |
Vladimir Marko | 35831e8 | 2015-09-11 11:59:18 +0100 | [diff] [blame] | 174 | pos += array->ComputeSize(array->size(), method_size, method_alignment); |
Mathieu Chartier | 54d220e | 2015-07-30 16:20:06 -0700 | [diff] [blame] | 175 | } |
Mathieu Chartier | e42888f | 2016-04-14 10:49:19 -0700 | [diff] [blame] | 176 | const ImageSection& runtime_methods = GetRuntimeMethodsSection(); |
| 177 | for (size_t pos = 0; pos < runtime_methods.Size(); ) { |
| 178 | auto* method = reinterpret_cast<ArtMethod*>(base + runtime_methods.Offset() + pos); |
| 179 | visitor->Visit(method); |
| 180 | pos += method_size; |
| 181 | } |
Mathieu Chartier | 54d220e | 2015-07-30 16:20:06 -0700 | [diff] [blame] | 182 | } |
| 183 | |
Andreas Gampe | bda1d60 | 2016-08-29 17:43:45 -0700 | [diff] [blame] | 184 | PointerSize ImageHeader::GetPointerSize() const { |
| 185 | return ConvertToPointerSize(pointer_size_); |
| 186 | } |
| 187 | |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 188 | } // namespace art |