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 | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 16 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 17 | #ifndef ART_RUNTIME_OAT_H_ |
| 18 | #define ART_RUNTIME_OAT_H_ |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 19 | |
| 20 | #include <vector> |
| 21 | |
Elliott Hughes | 7616005 | 2012-12-12 16:31:20 -0800 | [diff] [blame] | 22 | #include "base/macros.h" |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 23 | #include "dex_file.h" |
Elliott Hughes | 0f3c553 | 2012-03-30 14:51:51 -0700 | [diff] [blame] | 24 | #include "instruction_set.h" |
Vladimir Marko | 7624d25 | 2014-05-02 14:40:15 +0100 | [diff] [blame] | 25 | #include "quick/quick_method_frame_info.h" |
Andreas Gampe | 22f8e5c | 2014-07-09 11:38:21 -0700 | [diff] [blame] | 26 | #include "safe_map.h" |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 27 | |
| 28 | namespace art { |
| 29 | |
Ian Rogers | df1ce91 | 2012-11-27 17:07:11 -0800 | [diff] [blame] | 30 | class PACKED(4) OatHeader { |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 31 | public: |
Brian Carlstrom | 7c3d13a | 2013-09-04 17:15:11 -0700 | [diff] [blame] | 32 | static const uint8_t kOatMagic[4]; |
| 33 | static const uint8_t kOatVersion[4]; |
| 34 | |
Andreas Gampe | 22f8e5c | 2014-07-09 11:38:21 -0700 | [diff] [blame] | 35 | static constexpr const char* kImageLocationKey = "image-location"; |
| 36 | static constexpr const char* kDex2OatCmdLineKey = "dex2oat-cmdline"; |
| 37 | static constexpr const char* kDex2OatHostKey = "dex2oat-host"; |
| 38 | |
| 39 | static OatHeader* Create(InstructionSet instruction_set, |
| 40 | const InstructionSetFeatures& instruction_set_features, |
| 41 | const std::vector<const DexFile*>* dex_files, |
| 42 | uint32_t image_file_location_oat_checksum, |
| 43 | uint32_t image_file_location_oat_data_begin, |
| 44 | const SafeMap<std::string, std::string>* variable_data); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 45 | |
| 46 | bool IsValid() const; |
| 47 | const char* GetMagic() const; |
| 48 | uint32_t GetChecksum() const; |
| 49 | void UpdateChecksum(const void* data, size_t length); |
Ian Rogers | 4f6ad8a | 2013-03-18 15:27:28 -0700 | [diff] [blame] | 50 | uint32_t GetDexFileCount() const { |
| 51 | DCHECK(IsValid()); |
| 52 | return dex_file_count_; |
| 53 | } |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 54 | uint32_t GetExecutableOffset() const; |
| 55 | void SetExecutableOffset(uint32_t executable_offset); |
Ian Rogers | 468532e | 2013-08-05 10:56:33 -0700 | [diff] [blame] | 56 | |
| 57 | const void* GetInterpreterToInterpreterBridge() const; |
| 58 | uint32_t GetInterpreterToInterpreterBridgeOffset() const; |
| 59 | void SetInterpreterToInterpreterBridgeOffset(uint32_t offset); |
| 60 | const void* GetInterpreterToCompiledCodeBridge() const; |
| 61 | uint32_t GetInterpreterToCompiledCodeBridgeOffset() const; |
| 62 | void SetInterpreterToCompiledCodeBridgeOffset(uint32_t offset); |
| 63 | |
| 64 | const void* GetJniDlsymLookup() const; |
| 65 | uint32_t GetJniDlsymLookupOffset() const; |
| 66 | void SetJniDlsymLookupOffset(uint32_t offset); |
| 67 | |
Jeff Hao | 0aba0ba | 2013-06-03 14:49:28 -0700 | [diff] [blame] | 68 | const void* GetPortableResolutionTrampoline() const; |
| 69 | uint32_t GetPortableResolutionTrampolineOffset() const; |
| 70 | void SetPortableResolutionTrampolineOffset(uint32_t offset); |
Jeff Hao | 88474b4 | 2013-10-23 16:24:40 -0700 | [diff] [blame] | 71 | const void* GetPortableImtConflictTrampoline() const; |
| 72 | uint32_t GetPortableImtConflictTrampolineOffset() const; |
| 73 | void SetPortableImtConflictTrampolineOffset(uint32_t offset); |
Ian Rogers | 468532e | 2013-08-05 10:56:33 -0700 | [diff] [blame] | 74 | const void* GetPortableToInterpreterBridge() const; |
| 75 | uint32_t GetPortableToInterpreterBridgeOffset() const; |
| 76 | void SetPortableToInterpreterBridgeOffset(uint32_t offset); |
| 77 | |
Andreas Gampe | 2da8823 | 2014-02-27 12:26:20 -0800 | [diff] [blame] | 78 | const void* GetQuickGenericJniTrampoline() const; |
| 79 | uint32_t GetQuickGenericJniTrampolineOffset() const; |
| 80 | void SetQuickGenericJniTrampolineOffset(uint32_t offset); |
Jeff Hao | 0aba0ba | 2013-06-03 14:49:28 -0700 | [diff] [blame] | 81 | const void* GetQuickResolutionTrampoline() const; |
| 82 | uint32_t GetQuickResolutionTrampolineOffset() const; |
| 83 | void SetQuickResolutionTrampolineOffset(uint32_t offset); |
Jeff Hao | 88474b4 | 2013-10-23 16:24:40 -0700 | [diff] [blame] | 84 | const void* GetQuickImtConflictTrampoline() const; |
| 85 | uint32_t GetQuickImtConflictTrampolineOffset() const; |
| 86 | void SetQuickImtConflictTrampolineOffset(uint32_t offset); |
Ian Rogers | 468532e | 2013-08-05 10:56:33 -0700 | [diff] [blame] | 87 | const void* GetQuickToInterpreterBridge() const; |
| 88 | uint32_t GetQuickToInterpreterBridgeOffset() const; |
| 89 | void SetQuickToInterpreterBridgeOffset(uint32_t offset); |
| 90 | |
Jeff Hao | 0aba0ba | 2013-06-03 14:49:28 -0700 | [diff] [blame] | 91 | InstructionSet GetInstructionSet() const; |
Dave Allison | 7020278 | 2013-10-22 17:52:19 -0700 | [diff] [blame] | 92 | const InstructionSetFeatures& GetInstructionSetFeatures() const; |
Brian Carlstrom | 28db012 | 2012-10-18 16:20:41 -0700 | [diff] [blame] | 93 | uint32_t GetImageFileLocationOatChecksum() const; |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 94 | uint32_t GetImageFileLocationOatDataBegin() const; |
Andreas Gampe | 22f8e5c | 2014-07-09 11:38:21 -0700 | [diff] [blame] | 95 | |
| 96 | uint32_t GetKeyValueStoreSize() const; |
| 97 | const uint8_t* GetKeyValueStore() const; |
| 98 | const char* GetStoreValueByKey(const char* key) const; |
| 99 | bool GetStoreKeyValuePairByIndex(size_t index, const char** key, const char** value) const; |
| 100 | |
| 101 | size_t GetHeaderSize() const; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 102 | |
| 103 | private: |
Andreas Gampe | 22f8e5c | 2014-07-09 11:38:21 -0700 | [diff] [blame] | 104 | OatHeader(InstructionSet instruction_set, |
| 105 | const InstructionSetFeatures& instruction_set_features, |
| 106 | const std::vector<const DexFile*>* dex_files, |
| 107 | uint32_t image_file_location_oat_checksum, |
| 108 | uint32_t image_file_location_oat_data_begin, |
| 109 | const SafeMap<std::string, std::string>* variable_data); |
| 110 | |
| 111 | void Flatten(const SafeMap<std::string, std::string>* variable_data); |
| 112 | |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 113 | uint8_t magic_[4]; |
| 114 | uint8_t version_[4]; |
| 115 | uint32_t adler32_checksum_; |
Elliott Hughes | a72ec82 | 2012-03-05 17:12:22 -0800 | [diff] [blame] | 116 | |
| 117 | InstructionSet instruction_set_; |
Dave Allison | 7020278 | 2013-10-22 17:52:19 -0700 | [diff] [blame] | 118 | InstructionSetFeatures instruction_set_features_; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 119 | uint32_t dex_file_count_; |
| 120 | uint32_t executable_offset_; |
Ian Rogers | 468532e | 2013-08-05 10:56:33 -0700 | [diff] [blame] | 121 | uint32_t interpreter_to_interpreter_bridge_offset_; |
| 122 | uint32_t interpreter_to_compiled_code_bridge_offset_; |
| 123 | uint32_t jni_dlsym_lookup_offset_; |
Jeff Hao | 88474b4 | 2013-10-23 16:24:40 -0700 | [diff] [blame] | 124 | uint32_t portable_imt_conflict_trampoline_offset_; |
Jeff Hao | 0aba0ba | 2013-06-03 14:49:28 -0700 | [diff] [blame] | 125 | uint32_t portable_resolution_trampoline_offset_; |
Ian Rogers | 468532e | 2013-08-05 10:56:33 -0700 | [diff] [blame] | 126 | uint32_t portable_to_interpreter_bridge_offset_; |
Andreas Gampe | 2da8823 | 2014-02-27 12:26:20 -0800 | [diff] [blame] | 127 | uint32_t quick_generic_jni_trampoline_offset_; |
Jeff Hao | 88474b4 | 2013-10-23 16:24:40 -0700 | [diff] [blame] | 128 | uint32_t quick_imt_conflict_trampoline_offset_; |
Jeff Hao | 0aba0ba | 2013-06-03 14:49:28 -0700 | [diff] [blame] | 129 | uint32_t quick_resolution_trampoline_offset_; |
Ian Rogers | 468532e | 2013-08-05 10:56:33 -0700 | [diff] [blame] | 130 | uint32_t quick_to_interpreter_bridge_offset_; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 131 | |
Brian Carlstrom | 28db012 | 2012-10-18 16:20:41 -0700 | [diff] [blame] | 132 | uint32_t image_file_location_oat_checksum_; |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 133 | uint32_t image_file_location_oat_data_begin_; |
Andreas Gampe | 22f8e5c | 2014-07-09 11:38:21 -0700 | [diff] [blame] | 134 | |
| 135 | uint32_t key_value_store_size_; |
| 136 | uint8_t key_value_store_[0]; // note variable width data at end |
Brian Carlstrom | 81f3ca1 | 2012-03-17 00:27:35 -0700 | [diff] [blame] | 137 | |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 138 | DISALLOW_COPY_AND_ASSIGN(OatHeader); |
| 139 | }; |
| 140 | |
Vladimir Marko | 8a63057 | 2014-04-09 18:45:35 +0100 | [diff] [blame] | 141 | // OatMethodOffsets are currently 5x32-bits=160-bits long, so if we can |
Brian Carlstrom | ba150c3 | 2013-08-27 17:31:03 -0700 | [diff] [blame] | 142 | // save even one OatMethodOffsets struct, the more complicated encoding |
Vladimir Marko | 8a63057 | 2014-04-09 18:45:35 +0100 | [diff] [blame] | 143 | // using a bitmap pays for itself since few classes will have 160 |
Brian Carlstrom | ba150c3 | 2013-08-27 17:31:03 -0700 | [diff] [blame] | 144 | // methods. |
| 145 | enum OatClassType { |
| 146 | kOatClassAllCompiled = 0, // OatClass is followed by an OatMethodOffsets for each method. |
| 147 | kOatClassSomeCompiled = 1, // A bitmap of which OatMethodOffsets are present follows the OatClass. |
| 148 | kOatClassNoneCompiled = 2, // All methods are interpretted so no OatMethodOffsets are necessary. |
| 149 | kOatClassMax = 3, |
| 150 | }; |
| 151 | |
| 152 | std::ostream& operator<<(std::ostream& os, const OatClassType& rhs); |
| 153 | |
Ian Rogers | df1ce91 | 2012-11-27 17:07:11 -0800 | [diff] [blame] | 154 | class PACKED(4) OatMethodOffsets { |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 155 | public: |
| 156 | OatMethodOffsets(); |
Logan Chien | 971bf3f | 2012-05-01 15:47:55 +0800 | [diff] [blame] | 157 | |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 158 | OatMethodOffsets(uint32_t code_offset, |
Brian Carlstrom | df62950 | 2013-07-17 22:39:56 -0700 | [diff] [blame] | 159 | uint32_t gc_map_offset); |
Logan Chien | 971bf3f | 2012-05-01 15:47:55 +0800 | [diff] [blame] | 160 | |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 161 | ~OatMethodOffsets(); |
| 162 | |
| 163 | uint32_t code_offset_; |
Brian Carlstrom | e7d856b | 2012-01-11 18:10:55 -0800 | [diff] [blame] | 164 | uint32_t gc_map_offset_; |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 165 | }; |
| 166 | |
Vladimir Marko | 7624d25 | 2014-05-02 14:40:15 +0100 | [diff] [blame] | 167 | // OatQuickMethodHeader precedes the raw code chunk generated by the Quick compiler. |
| 168 | class PACKED(4) OatQuickMethodHeader { |
Vladimir Marko | 96c6ab9 | 2014-04-08 14:00:50 +0100 | [diff] [blame] | 169 | public: |
Vladimir Marko | 7624d25 | 2014-05-02 14:40:15 +0100 | [diff] [blame] | 170 | OatQuickMethodHeader(); |
Vladimir Marko | 96c6ab9 | 2014-04-08 14:00:50 +0100 | [diff] [blame] | 171 | |
Vladimir Marko | 7624d25 | 2014-05-02 14:40:15 +0100 | [diff] [blame] | 172 | explicit OatQuickMethodHeader(uint32_t mapping_table_offset, uint32_t vmap_table_offset, |
| 173 | uint32_t frame_size_in_bytes, uint32_t core_spill_mask, |
| 174 | uint32_t fp_spill_mask, uint32_t code_size); |
Vladimir Marko | 96c6ab9 | 2014-04-08 14:00:50 +0100 | [diff] [blame] | 175 | |
Vladimir Marko | 7624d25 | 2014-05-02 14:40:15 +0100 | [diff] [blame] | 176 | ~OatQuickMethodHeader(); |
Vladimir Marko | 96c6ab9 | 2014-04-08 14:00:50 +0100 | [diff] [blame] | 177 | |
Vladimir Marko | 8a63057 | 2014-04-09 18:45:35 +0100 | [diff] [blame] | 178 | // The offset in bytes from the start of the mapping table to the end of the header. |
| 179 | uint32_t mapping_table_offset_; |
| 180 | // The offset in bytes from the start of the vmap table to the end of the header. |
| 181 | uint32_t vmap_table_offset_; |
Vladimir Marko | 7624d25 | 2014-05-02 14:40:15 +0100 | [diff] [blame] | 182 | // The stack frame information. |
| 183 | QuickMethodFrameInfo frame_info_; |
Vladimir Marko | 96c6ab9 | 2014-04-08 14:00:50 +0100 | [diff] [blame] | 184 | // The code size in bytes. |
| 185 | uint32_t code_size_; |
| 186 | }; |
| 187 | |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 188 | } // namespace art |
| 189 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 190 | #endif // ART_RUNTIME_OAT_H_ |