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 | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 27 | class PACKED(4) ImageSection { |
| 28 | public: |
| 29 | ImageSection() : offset_(0), size_(0) { } |
| 30 | ImageSection(uint32_t offset, uint32_t size) : offset_(offset), size_(size) { } |
| 31 | ImageSection(const ImageSection& section) = default; |
| 32 | ImageSection& operator=(const ImageSection& section) = default; |
| 33 | |
| 34 | uint32_t Offset() const { |
| 35 | return offset_; |
| 36 | } |
| 37 | |
| 38 | uint32_t Size() const { |
| 39 | return size_; |
| 40 | } |
| 41 | |
| 42 | uint32_t End() const { |
| 43 | return Offset() + Size(); |
| 44 | } |
| 45 | |
| 46 | bool Contains(uint64_t offset) const { |
| 47 | return offset - offset_ < size_; |
| 48 | } |
| 49 | |
| 50 | private: |
| 51 | uint32_t offset_; |
| 52 | uint32_t size_; |
| 53 | }; |
| 54 | |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 55 | // header of image files written by ImageWriter, read and validated by Space. |
Ian Rogers | df1ce91 | 2012-11-27 17:07:11 -0800 | [diff] [blame] | 56 | class PACKED(4) ImageHeader { |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 57 | public: |
Igor Murashkin | 4677476 | 2014-10-22 11:37:02 -0700 | [diff] [blame] | 58 | ImageHeader() : compile_pic_(0) {} |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 59 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 60 | ImageHeader(uint32_t image_begin, |
Mathieu Chartier | 31e8925 | 2013-08-28 11:29:12 -0700 | [diff] [blame] | 61 | uint32_t image_size_, |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 62 | ImageSection* sections, |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 63 | uint32_t image_roots, |
| 64 | uint32_t oat_checksum, |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 65 | uint32_t oat_file_begin, |
| 66 | uint32_t oat_data_begin, |
| 67 | uint32_t oat_data_end, |
Igor Murashkin | 4677476 | 2014-10-22 11:37:02 -0700 | [diff] [blame] | 68 | uint32_t oat_file_end, |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 69 | uint32_t pointer_size, |
Igor Murashkin | 4677476 | 2014-10-22 11:37:02 -0700 | [diff] [blame] | 70 | bool compile_pic_); |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 71 | |
Brian Carlstrom | 68708f5 | 2013-09-03 14:15:31 -0700 | [diff] [blame] | 72 | bool IsValid() const; |
| 73 | const char* GetMagic() const; |
Brian Carlstrom | 78128a6 | 2011-09-15 17:21:19 -0700 | [diff] [blame] | 74 | |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 75 | uint8_t* GetImageBegin() const { |
| 76 | return reinterpret_cast<uint8_t*>(image_begin_); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 77 | } |
| 78 | |
Mathieu Chartier | 31e8925 | 2013-08-28 11:29:12 -0700 | [diff] [blame] | 79 | size_t GetImageSize() const { |
| 80 | return static_cast<uint32_t>(image_size_); |
| 81 | } |
| 82 | |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 83 | uint32_t GetOatChecksum() const { |
| 84 | return oat_checksum_; |
| 85 | } |
| 86 | |
Brian Carlstrom | a85b837 | 2012-10-18 17:00:32 -0700 | [diff] [blame] | 87 | void SetOatChecksum(uint32_t oat_checksum) { |
| 88 | oat_checksum_ = oat_checksum; |
| 89 | } |
| 90 | |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 91 | uint8_t* GetOatFileBegin() const { |
| 92 | return reinterpret_cast<uint8_t*>(oat_file_begin_); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 93 | } |
| 94 | |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 95 | uint8_t* GetOatDataBegin() const { |
| 96 | return reinterpret_cast<uint8_t*>(oat_data_begin_); |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 97 | } |
| 98 | |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 99 | uint8_t* GetOatDataEnd() const { |
| 100 | return reinterpret_cast<uint8_t*>(oat_data_end_); |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 101 | } |
| 102 | |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 103 | uint8_t* GetOatFileEnd() const { |
| 104 | return reinterpret_cast<uint8_t*>(oat_file_end_); |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 105 | } |
| 106 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 107 | uint32_t GetPointerSize() const { |
| 108 | return pointer_size_; |
| 109 | } |
| 110 | |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 111 | off_t GetPatchDelta() const { |
| 112 | return patch_delta_; |
| 113 | } |
| 114 | |
Nicolas Geoffray | 9583fbc | 2014-02-28 15:21:07 +0000 | [diff] [blame] | 115 | static std::string GetOatLocationFromImageLocation(const std::string& image) { |
| 116 | std::string oat_filename = image; |
| 117 | if (oat_filename.length() <= 3) { |
Ian Rogers | b9beb2e | 2014-05-09 16:57:40 -0700 | [diff] [blame] | 118 | oat_filename += ".oat"; |
Nicolas Geoffray | 9583fbc | 2014-02-28 15:21:07 +0000 | [diff] [blame] | 119 | } else { |
| 120 | oat_filename.replace(oat_filename.length() - 3, 3, "oat"); |
| 121 | } |
| 122 | return oat_filename; |
| 123 | } |
| 124 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 125 | enum ImageMethod { |
Ian Rogers | 1984651 | 2012-02-24 11:42:47 -0800 | [diff] [blame] | 126 | kResolutionMethod, |
Jeff Hao | 88474b4 | 2013-10-23 16:24:40 -0700 | [diff] [blame] | 127 | kImtConflictMethod, |
Mathieu Chartier | 2d2621a | 2014-10-23 16:48:06 -0700 | [diff] [blame] | 128 | kImtUnimplementedMethod, |
Ian Rogers | ff1ed47 | 2011-09-20 13:46:24 -0700 | [diff] [blame] | 129 | kCalleeSaveMethod, |
Ian Rogers | 4f0d07c | 2011-10-06 23:38:47 -0700 | [diff] [blame] | 130 | kRefsOnlySaveMethod, |
| 131 | kRefsAndArgsSaveMethod, |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 132 | kImageMethodsCount, // Number of elements in enum. |
| 133 | }; |
| 134 | |
| 135 | enum ImageRoot { |
Brian Carlstrom | 58ae941 | 2011-10-04 00:56:06 -0700 | [diff] [blame] | 136 | kDexCaches, |
Brian Carlstrom | 34f426c | 2011-10-04 12:58:02 -0700 | [diff] [blame] | 137 | kClassRoots, |
Brian Carlstrom | 1619286 | 2011-09-12 17:50:06 -0700 | [diff] [blame] | 138 | kImageRootsMax, |
| 139 | }; |
| 140 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 141 | enum ImageSections { |
| 142 | kSectionObjects, |
| 143 | kSectionArtFields, |
| 144 | kSectionArtMethods, |
Mathieu Chartier | d39645e | 2015-06-09 17:50:29 -0700 | [diff] [blame] | 145 | kSectionInternedStrings, |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 146 | kSectionImageBitmap, |
| 147 | kSectionCount, // Number of elements in enum. |
| 148 | }; |
| 149 | |
| 150 | ArtMethod* GetImageMethod(ImageMethod index) const; |
| 151 | void SetImageMethod(ImageMethod index, ArtMethod* method); |
| 152 | |
| 153 | const ImageSection& GetImageSection(ImageSections index) const; |
| 154 | const ImageSection& GetMethodsSection() const { |
| 155 | return GetImageSection(kSectionArtMethods); |
| 156 | } |
| 157 | |
Ian Rogers | 2dd0e2c | 2013-01-24 12:42:14 -0800 | [diff] [blame] | 158 | mirror::Object* GetImageRoot(ImageRoot image_root) const |
| 159 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Hiroshi Yamauchi | 2cd334a | 2015-01-09 14:03:35 -0800 | [diff] [blame] | 160 | mirror::ObjectArray<mirror::Object>* GetImageRoots() const |
| 161 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_); |
Brian Carlstrom | aded5f7 | 2011-10-07 17:15:04 -0700 | [diff] [blame] | 162 | |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 163 | void RelocateImage(off_t delta); |
| 164 | |
Igor Murashkin | 4677476 | 2014-10-22 11:37:02 -0700 | [diff] [blame] | 165 | bool CompilePic() const { |
| 166 | return compile_pic_ != 0; |
| 167 | } |
| 168 | |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 169 | private: |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 170 | static const uint8_t kImageMagic[4]; |
| 171 | static const uint8_t kImageVersion[4]; |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 172 | |
Ian Rogers | 1373595 | 2014-10-08 12:43:28 -0700 | [diff] [blame] | 173 | uint8_t magic_[4]; |
| 174 | uint8_t version_[4]; |
Brian Carlstrom | a663ea5 | 2011-08-19 23:33:41 -0700 | [diff] [blame] | 175 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 176 | // Required base address for mapping the image. |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 177 | uint32_t image_begin_; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 178 | |
Mathieu Chartier | 31e8925 | 2013-08-28 11:29:12 -0700 | [diff] [blame] | 179 | // Image size, not page aligned. |
| 180 | uint32_t image_size_; |
| 181 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 182 | // 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] | 183 | uint32_t oat_checksum_; |
| 184 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 185 | // Start address for oat file. Will be before oat_data_begin_ for .so files. |
| 186 | uint32_t oat_file_begin_; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 187 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 188 | // Required oat address expected by image Method::GetCode() pointers. |
| 189 | uint32_t oat_data_begin_; |
Brian Carlstrom | 1619286 | 2011-09-12 17:50:06 -0700 | [diff] [blame] | 190 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 191 | // End of oat data address range for this image file. |
| 192 | uint32_t oat_data_end_; |
| 193 | |
| 194 | // End of oat file address range. will be after oat_data_end_ for |
| 195 | // .so files. Used for positioning a following alloc spaces. |
| 196 | uint32_t oat_file_end_; |
| 197 | |
Alex Light | 53cb16b | 2014-06-12 11:26:29 -0700 | [diff] [blame] | 198 | // The total delta that this image has been patched. |
| 199 | int32_t patch_delta_; |
| 200 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 201 | // 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] | 202 | uint32_t image_roots_; |
| 203 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 204 | // Pointer size, this affects the size of the ArtMethods. |
| 205 | uint32_t pointer_size_; |
| 206 | |
Igor Murashkin | 4677476 | 2014-10-22 11:37:02 -0700 | [diff] [blame] | 207 | // Boolean (0 or 1) to denote if the image was compiled with --compile-pic option |
| 208 | const uint32_t compile_pic_; |
| 209 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 210 | // Image sections |
| 211 | ImageSection sections_[kSectionCount]; |
| 212 | |
| 213 | // Image methods. |
| 214 | uint64_t image_methods_[kImageMethodsCount]; |
| 215 | |
Brian Carlstrom | 1619286 | 2011-09-12 17:50:06 -0700 | [diff] [blame] | 216 | friend class ImageWriter; |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 217 | }; |
| 218 | |
Mathieu Chartier | e401d14 | 2015-04-22 13:56:20 -0700 | [diff] [blame] | 219 | std::ostream& operator<<(std::ostream& os, const ImageHeader::ImageMethod& policy); |
| 220 | std::ostream& operator<<(std::ostream& os, const ImageHeader::ImageRoot& policy); |
| 221 | std::ostream& operator<<(std::ostream& os, const ImageHeader::ImageSections& section); |
| 222 | std::ostream& operator<<(std::ostream& os, const ImageSection& section); |
| 223 | |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 224 | } // namespace art |
| 225 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 226 | #endif // ART_RUNTIME_IMAGE_H_ |