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 */ 16 17 #ifndef ART_RUNTIME_OAT_H_ 18 #define ART_RUNTIME_OAT_H_ 19 20 #include <vector> 21 22 #include "arch/instruction_set.h" 23 #include "base/macros.h" 24 #include "dex_file.h" 25 #include "quick/quick_method_frame_info.h" 26 #include "safe_map.h" 27 28 namespace art { 29 30 class InstructionSetFeatures; 31 32 class PACKED(4) OatHeader { 33 public: 34 static constexpr uint8_t kOatMagic[] = { 'o', 'a', 't', '\n' }; 35 static constexpr uint8_t kOatVersion[] = { '0', '6', '4', '\0' }; 36 37 static constexpr const char* kImageLocationKey = "image-location"; 38 static constexpr const char* kDex2OatCmdLineKey = "dex2oat-cmdline"; 39 static constexpr const char* kDex2OatHostKey = "dex2oat-host"; 40 static constexpr const char* kPicKey = "pic"; 41 static constexpr const char* kDebuggableKey = "debuggable"; 42 static constexpr const char* kClassPathKey = "classpath"; 43 44 static constexpr const char kTrueValue[] = "true"; 45 static constexpr const char kFalseValue[] = "false"; 46 47 static OatHeader* Create(InstructionSet instruction_set, 48 const InstructionSetFeatures* instruction_set_features, 49 const std::vector<const DexFile*>* dex_files, 50 uint32_t image_file_location_oat_checksum, 51 uint32_t image_file_location_oat_data_begin, 52 const SafeMap<std::string, std::string>* variable_data); 53 54 bool IsValid() const; 55 std::string GetValidationErrorMessage() const; 56 const char* GetMagic() const; 57 uint32_t GetChecksum() const; 58 void UpdateChecksum(const void* data, size_t length); GetDexFileCount()59 uint32_t GetDexFileCount() const { 60 DCHECK(IsValid()); 61 return dex_file_count_; 62 } 63 uint32_t GetExecutableOffset() const; 64 void SetExecutableOffset(uint32_t executable_offset); 65 66 const void* GetInterpreterToInterpreterBridge() const; 67 uint32_t GetInterpreterToInterpreterBridgeOffset() const; 68 void SetInterpreterToInterpreterBridgeOffset(uint32_t offset); 69 const void* GetInterpreterToCompiledCodeBridge() const; 70 uint32_t GetInterpreterToCompiledCodeBridgeOffset() const; 71 void SetInterpreterToCompiledCodeBridgeOffset(uint32_t offset); 72 73 const void* GetJniDlsymLookup() const; 74 uint32_t GetJniDlsymLookupOffset() const; 75 void SetJniDlsymLookupOffset(uint32_t offset); 76 77 const void* GetQuickGenericJniTrampoline() const; 78 uint32_t GetQuickGenericJniTrampolineOffset() const; 79 void SetQuickGenericJniTrampolineOffset(uint32_t offset); 80 const void* GetQuickResolutionTrampoline() const; 81 uint32_t GetQuickResolutionTrampolineOffset() const; 82 void SetQuickResolutionTrampolineOffset(uint32_t offset); 83 const void* GetQuickImtConflictTrampoline() const; 84 uint32_t GetQuickImtConflictTrampolineOffset() const; 85 void SetQuickImtConflictTrampolineOffset(uint32_t offset); 86 const void* GetQuickToInterpreterBridge() const; 87 uint32_t GetQuickToInterpreterBridgeOffset() const; 88 void SetQuickToInterpreterBridgeOffset(uint32_t offset); 89 90 int32_t GetImagePatchDelta() const; 91 void RelocateOat(off_t delta); 92 void SetImagePatchDelta(int32_t off); 93 94 InstructionSet GetInstructionSet() const; 95 uint32_t GetInstructionSetFeaturesBitmap() const; 96 uint32_t GetImageFileLocationOatChecksum() const; 97 uint32_t GetImageFileLocationOatDataBegin() const; 98 99 uint32_t GetKeyValueStoreSize() const; 100 const uint8_t* GetKeyValueStore() const; 101 const char* GetStoreValueByKey(const char* key) const; 102 bool GetStoreKeyValuePairByIndex(size_t index, const char** key, const char** value) const; 103 104 size_t GetHeaderSize() const; 105 bool IsPic() const; 106 bool IsDebuggable() const; 107 108 private: 109 OatHeader(InstructionSet instruction_set, 110 const InstructionSetFeatures* instruction_set_features, 111 const std::vector<const DexFile*>* dex_files, 112 uint32_t image_file_location_oat_checksum, 113 uint32_t image_file_location_oat_data_begin, 114 const SafeMap<std::string, std::string>* variable_data); 115 116 // Returns true if the value of the given key is "true", false otherwise. 117 bool IsKeyEnabled(const char* key) const; 118 119 void Flatten(const SafeMap<std::string, std::string>* variable_data); 120 121 uint8_t magic_[4]; 122 uint8_t version_[4]; 123 uint32_t adler32_checksum_; 124 125 InstructionSet instruction_set_; 126 uint32_t instruction_set_features_bitmap_; 127 uint32_t dex_file_count_; 128 uint32_t executable_offset_; 129 uint32_t interpreter_to_interpreter_bridge_offset_; 130 uint32_t interpreter_to_compiled_code_bridge_offset_; 131 uint32_t jni_dlsym_lookup_offset_; 132 uint32_t quick_generic_jni_trampoline_offset_; 133 uint32_t quick_imt_conflict_trampoline_offset_; 134 uint32_t quick_resolution_trampoline_offset_; 135 uint32_t quick_to_interpreter_bridge_offset_; 136 137 // The amount that the image this oat is associated with has been patched. 138 int32_t image_patch_delta_; 139 140 uint32_t image_file_location_oat_checksum_; 141 uint32_t image_file_location_oat_data_begin_; 142 143 uint32_t key_value_store_size_; 144 uint8_t key_value_store_[0]; // note variable width data at end 145 146 DISALLOW_COPY_AND_ASSIGN(OatHeader); 147 }; 148 149 // OatMethodOffsets are currently 5x32-bits=160-bits long, so if we can 150 // save even one OatMethodOffsets struct, the more complicated encoding 151 // using a bitmap pays for itself since few classes will have 160 152 // methods. 153 enum OatClassType { 154 kOatClassAllCompiled = 0, // OatClass is followed by an OatMethodOffsets for each method. 155 kOatClassSomeCompiled = 1, // A bitmap of which OatMethodOffsets are present follows the OatClass. 156 kOatClassNoneCompiled = 2, // All methods are interpreted so no OatMethodOffsets are necessary. 157 kOatClassMax = 3, 158 }; 159 160 std::ostream& operator<<(std::ostream& os, const OatClassType& rhs); 161 162 class PACKED(4) OatMethodOffsets { 163 public: 164 OatMethodOffsets(uint32_t code_offset = 0); 165 166 ~OatMethodOffsets(); 167 168 OatMethodOffsets& operator=(const OatMethodOffsets&) = default; 169 170 uint32_t code_offset_; 171 }; 172 173 // OatQuickMethodHeader precedes the raw code chunk generated by the Quick compiler. 174 class PACKED(4) OatQuickMethodHeader { 175 public: 176 OatQuickMethodHeader(uint32_t mapping_table_offset = 0U, uint32_t vmap_table_offset = 0U, 177 uint32_t gc_map_offset = 0U, uint32_t frame_size_in_bytes = 0U, 178 uint32_t core_spill_mask = 0U, uint32_t fp_spill_mask = 0U, 179 uint32_t code_size = 0U); 180 181 ~OatQuickMethodHeader(); 182 183 OatQuickMethodHeader& operator=(const OatQuickMethodHeader&) = default; 184 185 // The offset in bytes from the start of the mapping table to the end of the header. 186 uint32_t mapping_table_offset_; 187 // The offset in bytes from the start of the vmap table to the end of the header. 188 uint32_t vmap_table_offset_; 189 // The offset in bytes from the start of the gc map to the end of the header. 190 uint32_t gc_map_offset_; 191 // The stack frame information. 192 QuickMethodFrameInfo frame_info_; 193 // The code size in bytes. 194 uint32_t code_size_; 195 }; 196 197 } // namespace art 198 199 #endif // ART_RUNTIME_OAT_H_ 200