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 | |
Ian Rogers | d582fa4 | 2014-11-05 23:46:43 -0800 | [diff] [blame] | 22 | #include "arch/instruction_set.h" |
Elliott Hughes | 7616005 | 2012-12-12 16:31:20 -0800 | [diff] [blame] | 23 | #include "base/macros.h" |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 24 | #include "dex_file.h" |
Andreas Gampe | 22f8e5c | 2014-07-09 11:38:21 -0700 | [diff] [blame] | 25 | #include "safe_map.h" |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 26 | |
| 27 | namespace art { |
| 28 | |
Ian Rogers | d582fa4 | 2014-11-05 23:46:43 -0800 | [diff] [blame] | 29 | class InstructionSetFeatures; |
| 30 | |
Ian Rogers | df1ce91 | 2012-11-27 17:07:11 -0800 | [diff] [blame] | 31 | class PACKED(4) OatHeader { |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 32 | public: |
Andreas Gampe | 2bcb3b2 | 2014-12-12 15:25:14 -0800 | [diff] [blame] | 33 | static constexpr uint8_t kOatMagic[] = { 'o', 'a', 't', '\n' }; |
Vladimir Marko | 9bdf108 | 2016-01-21 12:15:52 +0000 | [diff] [blame] | 34 | static constexpr uint8_t kOatVersion[] = { '0', '7', '5', '\0' }; |
Brian Carlstrom | 7c3d13a | 2013-09-04 17:15:11 -0700 | [diff] [blame] | 35 | |
Andreas Gampe | 22f8e5c | 2014-07-09 11:38:21 -0700 | [diff] [blame] | 36 | static constexpr const char* kImageLocationKey = "image-location"; |
| 37 | static constexpr const char* kDex2OatCmdLineKey = "dex2oat-cmdline"; |
| 38 | static constexpr const char* kDex2OatHostKey = "dex2oat-host"; |
Andreas Gampe | 7ba6496 | 2014-10-23 11:37:40 -0700 | [diff] [blame] | 39 | static constexpr const char* kPicKey = "pic"; |
Sebastien Hertz | 0de1133 | 2015-05-13 12:14:05 +0200 | [diff] [blame] | 40 | static constexpr const char* kDebuggableKey = "debuggable"; |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame^] | 41 | static constexpr const char* kCompilationType = "compilation-type"; |
Andreas Gampe | 7848da4 | 2015-04-09 11:15:04 -0700 | [diff] [blame] | 42 | static constexpr const char* kClassPathKey = "classpath"; |
Jeff Hao | dcdc85b | 2015-12-04 14:06:18 -0800 | [diff] [blame] | 43 | static constexpr const char* kBootClassPath = "bootclasspath"; |
Andreas Gampe | 22f8e5c | 2014-07-09 11:38:21 -0700 | [diff] [blame] | 44 | |
Sebastien Hertz | 0de1133 | 2015-05-13 12:14:05 +0200 | [diff] [blame] | 45 | static constexpr const char kTrueValue[] = "true"; |
| 46 | static constexpr const char kFalseValue[] = "false"; |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame^] | 47 | static constexpr const char kExtractOnlyValue[] = "extract-only"; |
| 48 | static constexpr const char kProfileGuideCompiledValue[] = "profile-guide"; |
| 49 | |
Sebastien Hertz | 0de1133 | 2015-05-13 12:14:05 +0200 | [diff] [blame] | 50 | |
Andreas Gampe | 22f8e5c | 2014-07-09 11:38:21 -0700 | [diff] [blame] | 51 | static OatHeader* Create(InstructionSet instruction_set, |
Ian Rogers | 6f3dbba | 2014-10-14 17:41:57 -0700 | [diff] [blame] | 52 | const InstructionSetFeatures* instruction_set_features, |
Vladimir Marko | 49b0f45 | 2015-12-10 13:49:19 +0000 | [diff] [blame] | 53 | uint32_t dex_file_count, |
Andreas Gampe | 22f8e5c | 2014-07-09 11:38:21 -0700 | [diff] [blame] | 54 | const SafeMap<std::string, std::string>* variable_data); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 55 | |
| 56 | bool IsValid() const; |
Andreas Gampe | 2bcb3b2 | 2014-12-12 15:25:14 -0800 | [diff] [blame] | 57 | std::string GetValidationErrorMessage() const; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 58 | const char* GetMagic() const; |
| 59 | uint32_t GetChecksum() const; |
Vladimir Marko | 49b0f45 | 2015-12-10 13:49:19 +0000 | [diff] [blame] | 60 | void UpdateChecksumWithHeaderData(); |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 61 | void UpdateChecksum(const void* data, size_t length); |
Ian Rogers | 4f6ad8a | 2013-03-18 15:27:28 -0700 | [diff] [blame] | 62 | uint32_t GetDexFileCount() const { |
| 63 | DCHECK(IsValid()); |
| 64 | return dex_file_count_; |
| 65 | } |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 66 | uint32_t GetExecutableOffset() const; |
| 67 | void SetExecutableOffset(uint32_t executable_offset); |
Ian Rogers | 468532e | 2013-08-05 10:56:33 -0700 | [diff] [blame] | 68 | |
| 69 | const void* GetInterpreterToInterpreterBridge() const; |
| 70 | uint32_t GetInterpreterToInterpreterBridgeOffset() const; |
| 71 | void SetInterpreterToInterpreterBridgeOffset(uint32_t offset); |
| 72 | const void* GetInterpreterToCompiledCodeBridge() const; |
| 73 | uint32_t GetInterpreterToCompiledCodeBridgeOffset() const; |
| 74 | void SetInterpreterToCompiledCodeBridgeOffset(uint32_t offset); |
| 75 | |
| 76 | const void* GetJniDlsymLookup() const; |
| 77 | uint32_t GetJniDlsymLookupOffset() const; |
| 78 | void SetJniDlsymLookupOffset(uint32_t offset); |
| 79 | |
Andreas Gampe | 2da8823 | 2014-02-27 12:26:20 -0800 | [diff] [blame] | 80 | const void* GetQuickGenericJniTrampoline() const; |
| 81 | uint32_t GetQuickGenericJniTrampolineOffset() const; |
| 82 | void SetQuickGenericJniTrampolineOffset(uint32_t offset); |
Jeff Hao | 0aba0ba | 2013-06-03 14:49:28 -0700 | [diff] [blame] | 83 | const void* GetQuickResolutionTrampoline() const; |
| 84 | uint32_t GetQuickResolutionTrampolineOffset() const; |
| 85 | void SetQuickResolutionTrampolineOffset(uint32_t offset); |
Jeff Hao | 88474b4 | 2013-10-23 16:24:40 -0700 | [diff] [blame] | 86 | const void* GetQuickImtConflictTrampoline() const; |
| 87 | uint32_t GetQuickImtConflictTrampolineOffset() const; |
| 88 | void SetQuickImtConflictTrampolineOffset(uint32_t offset); |
Ian Rogers | 468532e | 2013-08-05 10:56:33 -0700 | [diff] [blame] | 89 | const void* GetQuickToInterpreterBridge() const; |
| 90 | uint32_t GetQuickToInterpreterBridgeOffset() const; |
| 91 | void SetQuickToInterpreterBridgeOffset(uint32_t offset); |
| 92 | |
Alex Light | a59dd80 | 2014-07-02 16:28:08 -0700 | [diff] [blame] | 93 | int32_t GetImagePatchDelta() const; |
| 94 | void RelocateOat(off_t delta); |
| 95 | void SetImagePatchDelta(int32_t off); |
| 96 | |
Jeff Hao | 0aba0ba | 2013-06-03 14:49:28 -0700 | [diff] [blame] | 97 | InstructionSet GetInstructionSet() const; |
Ian Rogers | 6f3dbba | 2014-10-14 17:41:57 -0700 | [diff] [blame] | 98 | uint32_t GetInstructionSetFeaturesBitmap() const; |
Vladimir Marko | 49b0f45 | 2015-12-10 13:49:19 +0000 | [diff] [blame] | 99 | |
Brian Carlstrom | 28db012 | 2012-10-18 16:20:41 -0700 | [diff] [blame] | 100 | uint32_t GetImageFileLocationOatChecksum() const; |
Vladimir Marko | 49b0f45 | 2015-12-10 13:49:19 +0000 | [diff] [blame] | 101 | void SetImageFileLocationOatChecksum(uint32_t image_file_location_oat_checksum); |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 102 | uint32_t GetImageFileLocationOatDataBegin() const; |
Vladimir Marko | 49b0f45 | 2015-12-10 13:49:19 +0000 | [diff] [blame] | 103 | void SetImageFileLocationOatDataBegin(uint32_t image_file_location_oat_data_begin); |
Andreas Gampe | 22f8e5c | 2014-07-09 11:38:21 -0700 | [diff] [blame] | 104 | |
| 105 | uint32_t GetKeyValueStoreSize() const; |
| 106 | const uint8_t* GetKeyValueStore() const; |
| 107 | const char* GetStoreValueByKey(const char* key) const; |
| 108 | bool GetStoreKeyValuePairByIndex(size_t index, const char** key, const char** value) const; |
| 109 | |
| 110 | size_t GetHeaderSize() const; |
Igor Murashkin | 4677476 | 2014-10-22 11:37:02 -0700 | [diff] [blame] | 111 | bool IsPic() const; |
Sebastien Hertz | 0de1133 | 2015-05-13 12:14:05 +0200 | [diff] [blame] | 112 | bool IsDebuggable() const; |
David Brazdil | ce4b0ba | 2016-01-28 15:05:49 +0000 | [diff] [blame] | 113 | bool IsExtractOnly() const; |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame^] | 114 | bool IsProfileGuideCompiled() const; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 115 | |
| 116 | private: |
Calin Juravle | b077e15 | 2016-02-18 18:47:37 +0000 | [diff] [blame^] | 117 | bool KeyHasValue(const char* key, const char* value, size_t value_size) const; |
| 118 | |
Andreas Gampe | 22f8e5c | 2014-07-09 11:38:21 -0700 | [diff] [blame] | 119 | OatHeader(InstructionSet instruction_set, |
Ian Rogers | 6f3dbba | 2014-10-14 17:41:57 -0700 | [diff] [blame] | 120 | const InstructionSetFeatures* instruction_set_features, |
Vladimir Marko | 49b0f45 | 2015-12-10 13:49:19 +0000 | [diff] [blame] | 121 | uint32_t dex_file_count, |
Andreas Gampe | 22f8e5c | 2014-07-09 11:38:21 -0700 | [diff] [blame] | 122 | const SafeMap<std::string, std::string>* variable_data); |
| 123 | |
Sebastien Hertz | 0de1133 | 2015-05-13 12:14:05 +0200 | [diff] [blame] | 124 | // Returns true if the value of the given key is "true", false otherwise. |
| 125 | bool IsKeyEnabled(const char* key) const; |
| 126 | |
Andreas Gampe | 22f8e5c | 2014-07-09 11:38:21 -0700 | [diff] [blame] | 127 | void Flatten(const SafeMap<std::string, std::string>* variable_data); |
| 128 | |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 129 | uint8_t magic_[4]; |
| 130 | uint8_t version_[4]; |
| 131 | uint32_t adler32_checksum_; |
Elliott Hughes | a72ec82 | 2012-03-05 17:12:22 -0800 | [diff] [blame] | 132 | |
| 133 | InstructionSet instruction_set_; |
Ian Rogers | 6f3dbba | 2014-10-14 17:41:57 -0700 | [diff] [blame] | 134 | uint32_t instruction_set_features_bitmap_; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 135 | uint32_t dex_file_count_; |
| 136 | uint32_t executable_offset_; |
Ian Rogers | 468532e | 2013-08-05 10:56:33 -0700 | [diff] [blame] | 137 | uint32_t interpreter_to_interpreter_bridge_offset_; |
| 138 | uint32_t interpreter_to_compiled_code_bridge_offset_; |
| 139 | uint32_t jni_dlsym_lookup_offset_; |
Andreas Gampe | 2da8823 | 2014-02-27 12:26:20 -0800 | [diff] [blame] | 140 | uint32_t quick_generic_jni_trampoline_offset_; |
Jeff Hao | 88474b4 | 2013-10-23 16:24:40 -0700 | [diff] [blame] | 141 | uint32_t quick_imt_conflict_trampoline_offset_; |
Jeff Hao | 0aba0ba | 2013-06-03 14:49:28 -0700 | [diff] [blame] | 142 | uint32_t quick_resolution_trampoline_offset_; |
Ian Rogers | 468532e | 2013-08-05 10:56:33 -0700 | [diff] [blame] | 143 | uint32_t quick_to_interpreter_bridge_offset_; |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 144 | |
Alex Light | a59dd80 | 2014-07-02 16:28:08 -0700 | [diff] [blame] | 145 | // The amount that the image this oat is associated with has been patched. |
| 146 | int32_t image_patch_delta_; |
| 147 | |
Brian Carlstrom | 28db012 | 2012-10-18 16:20:41 -0700 | [diff] [blame] | 148 | uint32_t image_file_location_oat_checksum_; |
Brian Carlstrom | 700c8d3 | 2012-11-05 10:42:02 -0800 | [diff] [blame] | 149 | uint32_t image_file_location_oat_data_begin_; |
Andreas Gampe | 22f8e5c | 2014-07-09 11:38:21 -0700 | [diff] [blame] | 150 | |
| 151 | uint32_t key_value_store_size_; |
| 152 | uint8_t key_value_store_[0]; // note variable width data at end |
Brian Carlstrom | 81f3ca1 | 2012-03-17 00:27:35 -0700 | [diff] [blame] | 153 | |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 154 | DISALLOW_COPY_AND_ASSIGN(OatHeader); |
| 155 | }; |
| 156 | |
Vladimir Marko | 8a63057 | 2014-04-09 18:45:35 +0100 | [diff] [blame] | 157 | // OatMethodOffsets are currently 5x32-bits=160-bits long, so if we can |
Brian Carlstrom | ba150c3 | 2013-08-27 17:31:03 -0700 | [diff] [blame] | 158 | // save even one OatMethodOffsets struct, the more complicated encoding |
Vladimir Marko | 8a63057 | 2014-04-09 18:45:35 +0100 | [diff] [blame] | 159 | // using a bitmap pays for itself since few classes will have 160 |
Brian Carlstrom | ba150c3 | 2013-08-27 17:31:03 -0700 | [diff] [blame] | 160 | // methods. |
| 161 | enum OatClassType { |
| 162 | kOatClassAllCompiled = 0, // OatClass is followed by an OatMethodOffsets for each method. |
| 163 | kOatClassSomeCompiled = 1, // A bitmap of which OatMethodOffsets are present follows the OatClass. |
Ian Rogers | 7b078e8 | 2014-09-10 14:44:24 -0700 | [diff] [blame] | 164 | kOatClassNoneCompiled = 2, // All methods are interpreted so no OatMethodOffsets are necessary. |
Brian Carlstrom | ba150c3 | 2013-08-27 17:31:03 -0700 | [diff] [blame] | 165 | kOatClassMax = 3, |
| 166 | }; |
| 167 | |
| 168 | std::ostream& operator<<(std::ostream& os, const OatClassType& rhs); |
| 169 | |
Ian Rogers | df1ce91 | 2012-11-27 17:07:11 -0800 | [diff] [blame] | 170 | class PACKED(4) OatMethodOffsets { |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 171 | public: |
Mathieu Chartier | 957ca1c | 2014-11-21 16:51:29 -0800 | [diff] [blame] | 172 | OatMethodOffsets(uint32_t code_offset = 0); |
Logan Chien | 971bf3f | 2012-05-01 15:47:55 +0800 | [diff] [blame] | 173 | |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 174 | ~OatMethodOffsets(); |
| 175 | |
Andreas Gampe | 758a801 | 2015-04-03 21:28:42 -0700 | [diff] [blame] | 176 | OatMethodOffsets& operator=(const OatMethodOffsets&) = default; |
| 177 | |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 178 | uint32_t code_offset_; |
Brian Carlstrom | 3320cf4 | 2011-10-04 14:58:28 -0700 | [diff] [blame] | 179 | }; |
| 180 | |
Brian Carlstrom | e24fa61 | 2011-09-29 00:53:55 -0700 | [diff] [blame] | 181 | } // namespace art |
| 182 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 183 | #endif // ART_RUNTIME_OAT_H_ |