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 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 17 | #ifndef ART_RUNTIME_IMAGE_H_ |
| 18 | #define ART_RUNTIME_IMAGE_H_ |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 19 | |
| 20 | #include <string.h> |
| 21 | |
| 22 | #include "globals.h" |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 23 | #include "mirror/object.h" |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 24 | |
| 25 | namespace art { |
| 26 | |
Mathieu Chartier | 54d220e | 2015-07-30 16:20:06 -0700 | [diff] [blame] | 27 | class ArtField; |
| 28 | class ArtMethod; |
| 29 | |
| 30 | class ArtMethodVisitor { |
| 31 | public: |
| 32 | virtual ~ArtMethodVisitor() {} |
| 33 | |
| 34 | virtual void Visit(ArtMethod* method) = 0; |
| 35 | }; |
| 36 | |
| 37 | class ArtFieldVisitor { |
| 38 | public: |
| 39 | virtual ~ArtFieldVisitor() {} |
| 40 | |
| 41 | virtual void Visit(ArtField* method) = 0; |
| 42 | }; |
| 43 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 44 | class PACKED(4) ImageSection { |
| 45 | public: |
| 46 | ImageSection() : offset_(0), size_(0) { } |
| 47 | ImageSection(uint32_t offset, uint32_t size) : offset_(offset), size_(size) { } |
| 48 | ImageSection(const ImageSection& section) = default; |
| 49 | ImageSection& operator=(const ImageSection& section) = default; |
| 50 | |
| 51 | uint32_t Offset() const { |
| 52 | return offset_; |
| 53 | } |
| 54 | |
| 55 | uint32_t Size() const { |
| 56 | return size_; |
| 57 | } |
| 58 | |
| 59 | uint32_t End() const { |
| 60 | return Offset() + Size(); |
| 61 | } |
| 62 | |
| 63 | bool Contains(uint64_t offset) const { |
| 64 | return offset - offset_ < size_; |
| 65 | } |
| 66 | |
Mathieu Chartier | 54d220e | 2015-07-30 16:20:06 -0700 | [diff] [blame] | 67 | // Visit ArtMethods in the section starting at base. |
Vladimir Marko | cf36d49 | 2015-08-12 19:27:26 +0100 | [diff] [blame] | 68 | void VisitPackedArtMethods(ArtMethodVisitor* visitor, uint8_t* base, size_t pointer_size) const; |
Mathieu Chartier | 54d220e | 2015-07-30 16:20:06 -0700 | [diff] [blame] | 69 | |
| 70 | // Visit ArtMethods in the section starting at base. |
| 71 | void VisitPackedArtFields(ArtFieldVisitor* visitor, uint8_t* base) const; |
| 72 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 73 | private: |
| 74 | uint32_t offset_; |
| 75 | uint32_t size_; |
| 76 | }; |
| 77 | |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 78 | // header of image files written by ImageWriter, read and validated by Space. |
Ian Rogers | df1ce91 | 2012-11-27 17:07:11 -0800 | [diff] [blame] | 79 | class PACKED(4) ImageHeader { |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 80 | public: |
Mathieu Chartier | ceb07b3 | 2015-12-10 09:33:21 -0800 | [diff] [blame] | 81 | enum StorageMode : uint32_t { |
| 82 | kStorageModeUncompressed, |
| 83 | kStorageModeLZ4, |
| 84 | kStorageModeCount, // Number of elements in enum. |
| 85 | }; |
| 86 | static constexpr StorageMode kDefaultStorageMode = kStorageModeUncompressed; |
| 87 | |
Sebastien Hertz | aa50d3a | 2015-08-25 15:25:41 +0200 | [diff] [blame] | 88 | ImageHeader() |
Mathieu Chartier | ceb07b3 | 2015-12-10 09:33:21 -0800 | [diff] [blame] | 89 | : image_begin_(0U), |
| 90 | image_size_(0U), |
| 91 | oat_checksum_(0U), |
| 92 | oat_file_begin_(0U), |
| 93 | oat_data_begin_(0U), |
| 94 | oat_data_end_(0U), |
| 95 | oat_file_end_(0U), |
| 96 | patch_delta_(0), |
| 97 | image_roots_(0U), |
| 98 | pointer_size_(0U), |
| 99 | compile_pic_(0), |
| 100 | storage_mode_(kDefaultStorageMode), |
| 101 | data_size_(0) {} |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 102 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 103 | ImageHeader(uint32_t image_begin, |
Mathieu Chartier | 763a31e | 2015-11-16 16:05:55 -0800 | [diff] [blame] | 104 | uint32_t image_size, |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 105 | ImageSection* sections, |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 106 | uint32_t image_roots, |
| 107 | uint32_t oat_checksum, |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 108 | uint32_t oat_file_begin, |
| 109 | uint32_t oat_data_begin, |
| 110 | uint32_t oat_data_end, |
Igor Murashkin | 4677476 | 2014-10-22 11:37:02 -0700 | [diff] [blame] | 111 | uint32_t oat_file_end, |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 112 | uint32_t pointer_size, |
Mathieu Chartier | ceb07b3 | 2015-12-10 09:33:21 -0800 | [diff] [blame] | 113 | bool compile_pic, |
| 114 | StorageMode storage_mode, |
| 115 | size_t data_size); |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 116 | |
Brian Carlstrom | 68708f5 | 2013-09-03 14:15:31 -0700 | [diff] [blame] | 117 | bool IsValid() const; |
| 118 | const char* GetMagic() const; |
Brian Carlstrom | 78128a6 | 2011-09-15 17:21:19 -0700 | [diff] [blame] | 119 | |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 120 | uint8_t* GetImageBegin() const { |
| 121 | return reinterpret_cast<uint8_t*>(image_begin_); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 122 | } |
| 123 | |
Mathieu Chartier | 31e8925 | 2013-08-28 11:29:12 -0700 | [diff] [blame] | 124 | size_t GetImageSize() const { |
| 125 | return static_cast<uint32_t>(image_size_); |
| 126 | } |
| 127 | |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 128 | uint32_t GetOatChecksum() const { |
| 129 | return oat_checksum_; |
| 130 | } |
| 131 | |
Brian Carlstrom | a85b837 | 2012-10-18 17:00:32 -0700 | [diff] [blame] | 132 | void SetOatChecksum(uint32_t oat_checksum) { |
| 133 | oat_checksum_ = oat_checksum; |
| 134 | } |
| 135 | |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 136 | uint8_t* GetOatFileBegin() const { |
| 137 | return reinterpret_cast<uint8_t*>(oat_file_begin_); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 138 | } |
| 139 | |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 140 | uint8_t* GetOatDataBegin() const { |
| 141 | return reinterpret_cast<uint8_t*>(oat_data_begin_); |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 142 | } |
| 143 | |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 144 | uint8_t* GetOatDataEnd() const { |
| 145 | return reinterpret_cast<uint8_t*>(oat_data_end_); |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 146 | } |
| 147 | |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 148 | uint8_t* GetOatFileEnd() const { |
| 149 | return reinterpret_cast<uint8_t*>(oat_file_end_); |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 150 | } |
| 151 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 152 | uint32_t GetPointerSize() const { |
| 153 | return pointer_size_; |
| 154 | } |
| 155 | |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 156 | off_t GetPatchDelta() const { |
| 157 | return patch_delta_; |
| 158 | } |
| 159 | |
Nicolas Geoffray | 9583fbc | 2014-02-28 15:21:07 +0000 | [diff] [blame] | 160 | static std::string GetOatLocationFromImageLocation(const std::string& image) { |
| 161 | std::string oat_filename = image; |
| 162 | if (oat_filename.length() <= 3) { |
Ian Rogers | b9beb2e | 2014-05-09 16:57:40 -0700 | [diff] [blame] | 163 | oat_filename += ".oat"; |
Nicolas Geoffray | 9583fbc | 2014-02-28 15:21:07 +0000 | [diff] [blame] | 164 | } else { |
| 165 | oat_filename.replace(oat_filename.length() - 3, 3, "oat"); |
| 166 | } |
| 167 | return oat_filename; |
| 168 | } |
| 169 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 170 | enum ImageMethod { |
Ian Rogers | 1984651 | 2012-02-24 11:42:47 -0800 | [diff] [blame] | 171 | kResolutionMethod, |
Jeff Hao | 88474b4 | 2013-10-23 16:24:40 -0700 | [diff] [blame] | 172 | kImtConflictMethod, |
Mathieu Chartier | 2d2621a | 2014-10-23 16:48:06 -0700 | [diff] [blame] | 173 | kImtUnimplementedMethod, |
Ian Rogers | ff1ed47 | 2011-09-20 13:46:24 -0700 | [diff] [blame] | 174 | kCalleeSaveMethod, |
Ian Rogers | 4f0d07c | 2011-10-06 23:38:47 -0700 | [diff] [blame] | 175 | kRefsOnlySaveMethod, |
| 176 | kRefsAndArgsSaveMethod, |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 177 | kImageMethodsCount, // Number of elements in enum. |
| 178 | }; |
| 179 | |
| 180 | enum ImageRoot { |
Brian Carlstrom | 58ae941 | 2011-10-04 00:56:06 -0700 | [diff] [blame] | 181 | kDexCaches, |
Brian Carlstrom | 34f426c | 2011-10-04 12:58:02 -0700 | [diff] [blame] | 182 | kClassRoots, |
Brian Carlstrom | 1619286 | 2011-09-12 17:50:06 -0700 | [diff] [blame] | 183 | kImageRootsMax, |
| 184 | }; |
| 185 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 186 | enum ImageSections { |
| 187 | kSectionObjects, |
| 188 | kSectionArtFields, |
| 189 | kSectionArtMethods, |
Vladimir Marko | 05792b9 | 2015-08-03 11:56:49 +0100 | [diff] [blame] | 190 | kSectionDexCacheArrays, |
Mathieu Chartier | d39645e | 2015-06-09 17:50:29 -0700 | [diff] [blame] | 191 | kSectionInternedStrings, |
Mathieu Chartier | 208a5cb | 2015-12-02 15:44:07 -0800 | [diff] [blame] | 192 | kSectionClassTable, |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 193 | kSectionImageBitmap, |
| 194 | kSectionCount, // Number of elements in enum. |
| 195 | }; |
| 196 | |
| 197 | ArtMethod* GetImageMethod(ImageMethod index) const; |
| 198 | void SetImageMethod(ImageMethod index, ArtMethod* method); |
| 199 | |
| 200 | const ImageSection& GetImageSection(ImageSections index) const; |
| 201 | const ImageSection& GetMethodsSection() const { |
| 202 | return GetImageSection(kSectionArtMethods); |
| 203 | } |
| 204 | |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 205 | mirror::Object* GetImageRoot(ImageRoot image_root) const |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 206 | SHARED_REQUIRES(Locks::mutator_lock_); |
Hiroshi Yamauchi | 2cd334a | 2015-01-09 14:03:35 -0800 | [diff] [blame] | 207 | mirror::ObjectArray<mirror::Object>* GetImageRoots() const |
Mathieu Chartier | 9044347 | 2015-07-16 20:32:27 -0700 | [diff] [blame] | 208 | SHARED_REQUIRES(Locks::mutator_lock_); |
Brian Carlstrom | aded5f7 | 2011-10-07 17:15:04 -0700 | [diff] [blame] | 209 | |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 210 | void RelocateImage(off_t delta); |
| 211 | |
Igor Murashkin | 4677476 | 2014-10-22 11:37:02 -0700 | [diff] [blame] | 212 | bool CompilePic() const { |
| 213 | return compile_pic_ != 0; |
| 214 | } |
| 215 | |
Mathieu Chartier | ceb07b3 | 2015-12-10 09:33:21 -0800 | [diff] [blame] | 216 | StorageMode GetStorageMode() const { |
| 217 | return storage_mode_; |
| 218 | } |
| 219 | |
| 220 | uint64_t GetDataSize() const { |
| 221 | return data_size_; |
| 222 | } |
| 223 | |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 224 | private: |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 225 | static const uint8_t kImageMagic[4]; |
| 226 | static const uint8_t kImageVersion[4]; |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 227 | |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 228 | uint8_t magic_[4]; |
| 229 | uint8_t version_[4]; |
Brian Carlstrom | a663ea5 | 2011-08-19 23:33:41 -0700 | [diff] [blame] | 230 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 231 | // Required base address for mapping the image. |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 232 | uint32_t image_begin_; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 233 | |
Mathieu Chartier | 31e8925 | 2013-08-28 11:29:12 -0700 | [diff] [blame] | 234 | // Image size, not page aligned. |
| 235 | uint32_t image_size_; |
| 236 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 237 | // Checksum of the oat file we link to for load time sanity check. |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 238 | uint32_t oat_checksum_; |
| 239 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 240 | // Start address for oat file. Will be before oat_data_begin_ for .so files. |
| 241 | uint32_t oat_file_begin_; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 242 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 243 | // Required oat address expected by image Method::GetCode() pointers. |
| 244 | uint32_t oat_data_begin_; |
Brian Carlstrom | 1619286 | 2011-09-12 17:50:06 -0700 | [diff] [blame] | 245 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 246 | // End of oat data address range for this image file. |
| 247 | uint32_t oat_data_end_; |
| 248 | |
| 249 | // End of oat file address range. will be after oat_data_end_ for |
| 250 | // .so files. Used for positioning a following alloc spaces. |
| 251 | uint32_t oat_file_end_; |
| 252 | |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 253 | // The total delta that this image has been patched. |
| 254 | int32_t patch_delta_; |
| 255 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 256 | // Absolute address of an Object[] of objects needed to reinitialize from an image. |
Brian Carlstrom | 1619286 | 2011-09-12 17:50:06 -0700 | [diff] [blame] | 257 | uint32_t image_roots_; |
| 258 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 259 | // Pointer size, this affects the size of the ArtMethods. |
| 260 | uint32_t pointer_size_; |
| 261 | |
Igor Murashkin | 4677476 | 2014-10-22 11:37:02 -0700 | [diff] [blame] | 262 | // Boolean (0 or 1) to denote if the image was compiled with --compile-pic option |
| 263 | const uint32_t compile_pic_; |
| 264 | |
Mathieu Chartier | 67ad20e | 2015-12-09 15:41:09 -0800 | [diff] [blame] | 265 | // Image section sizes/offsets correspond to the uncompressed form. |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 266 | ImageSection sections_[kSectionCount]; |
| 267 | |
| 268 | // Image methods. |
| 269 | uint64_t image_methods_[kImageMethodsCount]; |
| 270 | |
Mathieu Chartier | ceb07b3 | 2015-12-10 09:33:21 -0800 | [diff] [blame] | 271 | // Storage method for the image, the image may be compressed. |
| 272 | StorageMode storage_mode_; |
| 273 | |
| 274 | // Data size for the image data excluding the bitmap and the header. For compressed images, this |
| 275 | // is the compressed size in the file. |
| 276 | uint32_t data_size_; |
| 277 | |
Brian Carlstrom | 1619286 | 2011-09-12 17:50:06 -0700 | [diff] [blame] | 278 | friend class ImageWriter; |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 279 | }; |
| 280 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 281 | std::ostream& operator<<(std::ostream& os, const ImageHeader::ImageMethod& policy); |
| 282 | std::ostream& operator<<(std::ostream& os, const ImageHeader::ImageRoot& policy); |
| 283 | std::ostream& operator<<(std::ostream& os, const ImageHeader::ImageSections& section); |
| 284 | std::ostream& operator<<(std::ostream& os, const ImageSection& section); |
Mathieu Chartier | ceb07b3 | 2015-12-10 09:33:21 -0800 | [diff] [blame] | 285 | std::ostream& operator<<(std::ostream& os, const ImageHeader::StorageMode& mode); |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 286 | |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 287 | } // namespace art |
| 288 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 289 | #endif // ART_RUNTIME_IMAGE_H_ |