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 | #ifndef ART_SRC_IMAGE_H_ |
| 18 | #define ART_SRC_IMAGE_H_ |
| 19 | |
| 20 | #include <string.h> |
| 21 | |
| 22 | #include "globals.h" |
Brian Carlstrom | a663ea5 | 2011-08-19 23:33:41 -0700 | [diff] [blame] | 23 | #include "object.h" |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 24 | |
| 25 | namespace art { |
| 26 | |
| 27 | // header of image files written by ImageWriter, read and validated by Space. |
Ian Rogers | df1ce91 | 2012-11-27 17:07:11 -0800 | [diff] [blame] | 28 | class PACKED(4) ImageHeader { |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 29 | public: |
| 30 | ImageHeader() {} |
| 31 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 32 | ImageHeader(uint32_t image_begin, |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 33 | uint32_t image_roots, |
| 34 | uint32_t oat_checksum, |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame^] | 35 | uint32_t oat_file_begin, |
| 36 | uint32_t oat_data_begin, |
| 37 | uint32_t oat_data_end, |
| 38 | uint32_t oat_file_end) |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 39 | : image_begin_(image_begin), |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 40 | oat_checksum_(oat_checksum), |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame^] | 41 | oat_file_begin_(oat_file_begin), |
| 42 | oat_data_begin_(oat_data_begin), |
| 43 | oat_data_end_(oat_data_end), |
| 44 | oat_file_end_(oat_file_end), |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 45 | image_roots_(image_roots) { |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 46 | CHECK_EQ(image_begin, RoundUp(image_begin, kPageSize)); |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame^] | 47 | CHECK_EQ(oat_file_begin, RoundUp(oat_file_begin, kPageSize)); |
| 48 | CHECK_EQ(oat_data_begin, RoundUp(oat_data_begin, kPageSize)); |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 49 | CHECK_LT(image_begin, image_roots); |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame^] | 50 | CHECK_LT(image_roots, oat_file_begin); |
| 51 | CHECK_LE(oat_file_begin, oat_data_begin); |
| 52 | CHECK_LT(oat_data_begin, oat_data_end); |
| 53 | CHECK_LE(oat_data_end, oat_file_end); |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 54 | memcpy(magic_, kImageMagic, sizeof(kImageMagic)); |
| 55 | memcpy(version_, kImageVersion, sizeof(kImageVersion)); |
| 56 | } |
| 57 | |
Brian Carlstrom | 78128a6 | 2011-09-15 17:21:19 -0700 | [diff] [blame] | 58 | bool IsValid() const { |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 59 | if (memcmp(magic_, kImageMagic, sizeof(kImageMagic) != 0)) { |
| 60 | return false; |
| 61 | } |
| 62 | if (memcmp(version_, kImageVersion, sizeof(kImageVersion) != 0)) { |
| 63 | return false; |
| 64 | } |
| 65 | return true; |
| 66 | } |
| 67 | |
Brian Carlstrom | 78128a6 | 2011-09-15 17:21:19 -0700 | [diff] [blame] | 68 | const char* GetMagic() const { |
| 69 | CHECK(IsValid()); |
| 70 | return reinterpret_cast<const char*>(magic_); |
| 71 | } |
| 72 | |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 73 | byte* GetImageBegin() const { |
| 74 | return reinterpret_cast<byte*>(image_begin_); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 75 | } |
| 76 | |
| 77 | uint32_t GetOatChecksum() const { |
| 78 | return oat_checksum_; |
| 79 | } |
| 80 | |
Brian Carlstrom | a85b837 | 2012-10-18 17:00:32 -0700 | [diff] [blame] | 81 | void SetOatChecksum(uint32_t oat_checksum) { |
| 82 | oat_checksum_ = oat_checksum; |
| 83 | } |
| 84 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame^] | 85 | byte* GetOatFileBegin() const { |
| 86 | return reinterpret_cast<byte*>(oat_file_begin_); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 87 | } |
| 88 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame^] | 89 | byte* GetOatDataBegin() const { |
| 90 | return reinterpret_cast<byte*>(oat_data_begin_); |
| 91 | } |
| 92 | |
| 93 | byte* GetOatDataEnd() const { |
| 94 | return reinterpret_cast<byte*>(oat_data_end_); |
| 95 | } |
| 96 | |
| 97 | byte* GetOatFileEnd() const { |
| 98 | return reinterpret_cast<byte*>(oat_file_end_); |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 99 | } |
| 100 | |
Brian Carlstrom | 1619286 | 2011-09-12 17:50:06 -0700 | [diff] [blame] | 101 | enum ImageRoot { |
| 102 | kJniStubArray, |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 103 | kAbstractMethodErrorStubArray, |
Ian Rogers | ad25ac5 | 2011-10-04 19:13:33 -0700 | [diff] [blame] | 104 | kStaticResolutionStubArray, |
Ian Rogers | 1cb0a1d | 2011-10-06 15:24:35 -0700 | [diff] [blame] | 105 | kUnknownMethodResolutionStubArray, |
Ian Rogers | 1984651 | 2012-02-24 11:42:47 -0800 | [diff] [blame] | 106 | kResolutionMethod, |
Ian Rogers | ff1ed47 | 2011-09-20 13:46:24 -0700 | [diff] [blame] | 107 | kCalleeSaveMethod, |
Ian Rogers | 4f0d07c | 2011-10-06 23:38:47 -0700 | [diff] [blame] | 108 | kRefsOnlySaveMethod, |
| 109 | kRefsAndArgsSaveMethod, |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 110 | kOatLocation, |
Brian Carlstrom | 58ae941 | 2011-10-04 00:56:06 -0700 | [diff] [blame] | 111 | kDexCaches, |
Brian Carlstrom | 34f426c | 2011-10-04 12:58:02 -0700 | [diff] [blame] | 112 | kClassRoots, |
Brian Carlstrom | 1619286 | 2011-09-12 17:50:06 -0700 | [diff] [blame] | 113 | kImageRootsMax, |
| 114 | }; |
| 115 | |
Ian Rogers | 00f7d0e | 2012-07-19 15:28:27 -0700 | [diff] [blame] | 116 | Object* GetImageRoot(ImageRoot image_root) const |
Ian Rogers | b726dcb | 2012-09-05 08:57:23 -0700 | [diff] [blame] | 117 | SHARED_LOCKS_REQUIRED(Locks::mutator_lock_) { |
Brian Carlstrom | aded5f7 | 2011-10-07 17:15:04 -0700 | [diff] [blame] | 118 | return GetImageRoots()->Get(image_root); |
Brian Carlstrom | 1619286 | 2011-09-12 17:50:06 -0700 | [diff] [blame] | 119 | } |
| 120 | |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 121 | private: |
Brian Carlstrom | aded5f7 | 2011-10-07 17:15:04 -0700 | [diff] [blame] | 122 | ObjectArray<Object>* GetImageRoots() const { |
| 123 | return reinterpret_cast<ObjectArray<Object>*>(image_roots_); |
| 124 | } |
| 125 | |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 126 | static const byte kImageMagic[4]; |
| 127 | static const byte kImageVersion[4]; |
| 128 | |
| 129 | byte magic_[4]; |
| 130 | byte version_[4]; |
Brian Carlstrom | a663ea5 | 2011-08-19 23:33:41 -0700 | [diff] [blame] | 131 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame^] | 132 | // Required base address for mapping the image. |
Ian Rogers | 30fab40 | 2012-01-23 15:43:46 -0800 | [diff] [blame] | 133 | uint32_t image_begin_; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 134 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame^] | 135 | // 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] | 136 | uint32_t oat_checksum_; |
| 137 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame^] | 138 | // Start address for oat file. Will be before oat_data_begin_ for .so files. |
| 139 | uint32_t oat_file_begin_; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 140 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame^] | 141 | // Required oat address expected by image Method::GetCode() pointers. |
| 142 | uint32_t oat_data_begin_; |
Brian Carlstrom | 1619286 | 2011-09-12 17:50:06 -0700 | [diff] [blame] | 143 | |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame^] | 144 | // End of oat data address range for this image file. |
| 145 | uint32_t oat_data_end_; |
| 146 | |
| 147 | // End of oat file address range. will be after oat_data_end_ for |
| 148 | // .so files. Used for positioning a following alloc spaces. |
| 149 | uint32_t oat_file_end_; |
| 150 | |
| 151 | // 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] | 152 | uint32_t image_roots_; |
| 153 | |
| 154 | friend class ImageWriter; |
Ian Rogers | 3a5c1ce | 2012-02-29 10:06:46 -0800 | [diff] [blame] | 155 | friend class ImageDumper; // For GetImageRoots() |
Brian Carlstrom | 4a289ed | 2011-08-16 17:17:49 -0700 | [diff] [blame] | 156 | }; |
| 157 | |
| 158 | } // namespace art |
| 159 | |
| 160 | #endif // ART_SRC_IMAGE_H_ |