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 <array> 21 #include <vector> 22 23 #include "base/compiler_filter.h" 24 #include "base/macros.h" 25 #include "base/safe_map.h" 26 27 namespace art { 28 29 enum class InstructionSet; 30 class InstructionSetFeatures; 31 32 class PACKED(4) OatHeader { 33 public: 34 static constexpr std::array<uint8_t, 4> kOatMagic { { 'o', 'a', 't', '\n' } }; 35 // Last oat version changed reason: Disable partial LSE b/197818595. 36 static constexpr std::array<uint8_t, 4> kOatVersion { { '1', '9', '9', '\0' } }; 37 38 static constexpr const char* kDex2OatCmdLineKey = "dex2oat-cmdline"; 39 static constexpr const char* kDebuggableKey = "debuggable"; 40 static constexpr const char* kNativeDebuggableKey = "native-debuggable"; 41 static constexpr const char* kCompilerFilter = "compiler-filter"; 42 static constexpr const char* kClassPathKey = "classpath"; 43 static constexpr const char* kBootClassPathKey = "bootclasspath"; 44 static constexpr const char* kBootClassPathChecksumsKey = "bootclasspath-checksums"; 45 static constexpr const char* kApexVersionsKey = "apex-versions"; 46 static constexpr const char* kConcurrentCopying = "concurrent-copying"; 47 static constexpr const char* kCompilationReasonKey = "compilation-reason"; 48 static constexpr const char* kRequiresImage = "requires-image"; 49 50 static constexpr const char kTrueValue[] = "true"; 51 static constexpr const char kFalseValue[] = "false"; 52 53 54 static OatHeader* Create(InstructionSet instruction_set, 55 const InstructionSetFeatures* instruction_set_features, 56 uint32_t dex_file_count, 57 const SafeMap<std::string, std::string>* variable_data); 58 59 bool IsValid() const; 60 std::string GetValidationErrorMessage() const; 61 static void CheckOatVersion(std::array<uint8_t, 4> version); 62 const char* GetMagic() const; 63 uint32_t GetChecksum() const; 64 void SetChecksum(uint32_t checksum); GetDexFileCount()65 uint32_t GetDexFileCount() const { 66 DCHECK(IsValid()); 67 return dex_file_count_; 68 } 69 uint32_t GetOatDexFilesOffset() const; 70 void SetOatDexFilesOffset(uint32_t oat_dex_files_offset); 71 uint32_t GetExecutableOffset() const; 72 void SetExecutableOffset(uint32_t executable_offset); 73 74 const void* GetJniDlsymLookupTrampoline() const; 75 uint32_t GetJniDlsymLookupTrampolineOffset() const; 76 void SetJniDlsymLookupTrampolineOffset(uint32_t offset); 77 const void* GetJniDlsymLookupCriticalTrampoline() const; 78 uint32_t GetJniDlsymLookupCriticalTrampolineOffset() const; 79 void SetJniDlsymLookupCriticalTrampolineOffset(uint32_t offset); 80 81 const void* GetQuickGenericJniTrampoline() const; 82 uint32_t GetQuickGenericJniTrampolineOffset() const; 83 void SetQuickGenericJniTrampolineOffset(uint32_t offset); 84 const void* GetQuickResolutionTrampoline() const; 85 uint32_t GetQuickResolutionTrampolineOffset() const; 86 void SetQuickResolutionTrampolineOffset(uint32_t offset); 87 const void* GetQuickImtConflictTrampoline() const; 88 uint32_t GetQuickImtConflictTrampolineOffset() const; 89 void SetQuickImtConflictTrampolineOffset(uint32_t offset); 90 const void* GetQuickToInterpreterBridge() const; 91 uint32_t GetQuickToInterpreterBridgeOffset() const; 92 void SetQuickToInterpreterBridgeOffset(uint32_t offset); 93 const void* GetNterpTrampoline() const; 94 uint32_t GetNterpTrampolineOffset() const; 95 void SetNterpTrampolineOffset(uint32_t offset); 96 97 InstructionSet GetInstructionSet() const; 98 uint32_t GetInstructionSetFeaturesBitmap() const; 99 100 uint32_t GetKeyValueStoreSize() const; 101 const uint8_t* GetKeyValueStore() const; 102 const char* GetStoreValueByKey(const char* key) const; 103 bool GetStoreKeyValuePairByIndex(size_t index, const char** key, const char** value) const; 104 105 size_t GetHeaderSize() const; 106 bool IsDebuggable() const; 107 bool IsNativeDebuggable() const; 108 CompilerFilter::Filter GetCompilerFilter() const; 109 bool IsConcurrentCopying() const; 110 bool RequiresImage() const; 111 112 private: 113 bool KeyHasValue(const char* key, const char* value, size_t value_size) const; 114 115 OatHeader(InstructionSet instruction_set, 116 const InstructionSetFeatures* instruction_set_features, 117 uint32_t dex_file_count, 118 const SafeMap<std::string, std::string>* variable_data); 119 120 // Returns true if the value of the given key is "true", false otherwise. 121 bool IsKeyEnabled(const char* key) const; 122 123 void Flatten(const SafeMap<std::string, std::string>* variable_data); 124 125 std::array<uint8_t, 4> magic_; 126 std::array<uint8_t, 4> version_; 127 uint32_t oat_checksum_; 128 129 InstructionSet instruction_set_; 130 uint32_t instruction_set_features_bitmap_; 131 uint32_t dex_file_count_; 132 uint32_t oat_dex_files_offset_; 133 uint32_t executable_offset_; 134 uint32_t jni_dlsym_lookup_trampoline_offset_; 135 uint32_t jni_dlsym_lookup_critical_trampoline_offset_; 136 uint32_t quick_generic_jni_trampoline_offset_; 137 uint32_t quick_imt_conflict_trampoline_offset_; 138 uint32_t quick_resolution_trampoline_offset_; 139 uint32_t quick_to_interpreter_bridge_offset_; 140 uint32_t nterp_trampoline_offset_; 141 142 uint32_t key_value_store_size_; 143 uint8_t key_value_store_[0]; // note variable width data at end 144 145 DISALLOW_COPY_AND_ASSIGN(OatHeader); 146 }; 147 148 } // namespace art 149 150 #endif // ART_RUNTIME_OAT_H_ 151