blob: 120de6d11fb36b17a7b73b868d4208cffc6ea87b [file] [log] [blame]
Elliott Hughes2faa5f12012-01-30 14:42:07 -08001/*
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 Carlstrome24fa612011-09-29 00:53:55 -070016
Brian Carlstromfc0e3212013-07-17 14:40:12 -070017#ifndef ART_RUNTIME_OAT_H_
18#define ART_RUNTIME_OAT_H_
Brian Carlstrome24fa612011-09-29 00:53:55 -070019
20#include <vector>
21
Ian Rogersd582fa42014-11-05 23:46:43 -080022#include "arch/instruction_set.h"
Elliott Hughes76160052012-12-12 16:31:20 -080023#include "base/macros.h"
Brian Carlstrome24fa612011-09-29 00:53:55 -070024#include "dex_file.h"
Vladimir Marko7624d252014-05-02 14:40:15 +010025#include "quick/quick_method_frame_info.h"
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070026#include "safe_map.h"
Brian Carlstrome24fa612011-09-29 00:53:55 -070027
28namespace art {
29
Ian Rogersd582fa42014-11-05 23:46:43 -080030class InstructionSetFeatures;
31
Ian Rogersdf1ce912012-11-27 17:07:11 -080032class PACKED(4) OatHeader {
Brian Carlstrome24fa612011-09-29 00:53:55 -070033 public:
Andreas Gampe2bcb3b22014-12-12 15:25:14 -080034 static constexpr uint8_t kOatMagic[] = { 'o', 'a', 't', '\n' };
Nicolas Geoffray1412dfa2015-03-20 14:48:13 +000035 static constexpr uint8_t kOatVersion[] = { '0', '6', '1', '\0' };
Brian Carlstrom7c3d13a2013-09-04 17:15:11 -070036
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070037 static constexpr const char* kImageLocationKey = "image-location";
38 static constexpr const char* kDex2OatCmdLineKey = "dex2oat-cmdline";
39 static constexpr const char* kDex2OatHostKey = "dex2oat-host";
Andreas Gampe7ba64962014-10-23 11:37:40 -070040 static constexpr const char* kPicKey = "pic";
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070041
42 static OatHeader* Create(InstructionSet instruction_set,
Ian Rogers6f3dbba2014-10-14 17:41:57 -070043 const InstructionSetFeatures* instruction_set_features,
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070044 const std::vector<const DexFile*>* dex_files,
45 uint32_t image_file_location_oat_checksum,
46 uint32_t image_file_location_oat_data_begin,
47 const SafeMap<std::string, std::string>* variable_data);
Brian Carlstrome24fa612011-09-29 00:53:55 -070048
49 bool IsValid() const;
Andreas Gampe2bcb3b22014-12-12 15:25:14 -080050 std::string GetValidationErrorMessage() const;
Brian Carlstrome24fa612011-09-29 00:53:55 -070051 const char* GetMagic() const;
52 uint32_t GetChecksum() const;
53 void UpdateChecksum(const void* data, size_t length);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070054 uint32_t GetDexFileCount() const {
55 DCHECK(IsValid());
56 return dex_file_count_;
57 }
Brian Carlstrome24fa612011-09-29 00:53:55 -070058 uint32_t GetExecutableOffset() const;
59 void SetExecutableOffset(uint32_t executable_offset);
Ian Rogers468532e2013-08-05 10:56:33 -070060
61 const void* GetInterpreterToInterpreterBridge() const;
62 uint32_t GetInterpreterToInterpreterBridgeOffset() const;
63 void SetInterpreterToInterpreterBridgeOffset(uint32_t offset);
64 const void* GetInterpreterToCompiledCodeBridge() const;
65 uint32_t GetInterpreterToCompiledCodeBridgeOffset() const;
66 void SetInterpreterToCompiledCodeBridgeOffset(uint32_t offset);
67
68 const void* GetJniDlsymLookup() const;
69 uint32_t GetJniDlsymLookupOffset() const;
70 void SetJniDlsymLookupOffset(uint32_t offset);
71
Andreas Gampe2da88232014-02-27 12:26:20 -080072 const void* GetQuickGenericJniTrampoline() const;
73 uint32_t GetQuickGenericJniTrampolineOffset() const;
74 void SetQuickGenericJniTrampolineOffset(uint32_t offset);
Jeff Hao0aba0ba2013-06-03 14:49:28 -070075 const void* GetQuickResolutionTrampoline() const;
76 uint32_t GetQuickResolutionTrampolineOffset() const;
77 void SetQuickResolutionTrampolineOffset(uint32_t offset);
Jeff Hao88474b42013-10-23 16:24:40 -070078 const void* GetQuickImtConflictTrampoline() const;
79 uint32_t GetQuickImtConflictTrampolineOffset() const;
80 void SetQuickImtConflictTrampolineOffset(uint32_t offset);
Ian Rogers468532e2013-08-05 10:56:33 -070081 const void* GetQuickToInterpreterBridge() const;
82 uint32_t GetQuickToInterpreterBridgeOffset() const;
83 void SetQuickToInterpreterBridgeOffset(uint32_t offset);
84
Alex Lighta59dd802014-07-02 16:28:08 -070085 int32_t GetImagePatchDelta() const;
86 void RelocateOat(off_t delta);
87 void SetImagePatchDelta(int32_t off);
88
Jeff Hao0aba0ba2013-06-03 14:49:28 -070089 InstructionSet GetInstructionSet() const;
Ian Rogers6f3dbba2014-10-14 17:41:57 -070090 uint32_t GetInstructionSetFeaturesBitmap() const;
Brian Carlstrom28db0122012-10-18 16:20:41 -070091 uint32_t GetImageFileLocationOatChecksum() const;
Brian Carlstrom700c8d32012-11-05 10:42:02 -080092 uint32_t GetImageFileLocationOatDataBegin() const;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070093
94 uint32_t GetKeyValueStoreSize() const;
95 const uint8_t* GetKeyValueStore() const;
96 const char* GetStoreValueByKey(const char* key) const;
97 bool GetStoreKeyValuePairByIndex(size_t index, const char** key, const char** value) const;
98
99 size_t GetHeaderSize() const;
Igor Murashkin46774762014-10-22 11:37:02 -0700100 bool IsPic() const;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700101
102 private:
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700103 OatHeader(InstructionSet instruction_set,
Ian Rogers6f3dbba2014-10-14 17:41:57 -0700104 const InstructionSetFeatures* instruction_set_features,
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700105 const std::vector<const DexFile*>* dex_files,
106 uint32_t image_file_location_oat_checksum,
107 uint32_t image_file_location_oat_data_begin,
108 const SafeMap<std::string, std::string>* variable_data);
109
110 void Flatten(const SafeMap<std::string, std::string>* variable_data);
111
Brian Carlstrome24fa612011-09-29 00:53:55 -0700112 uint8_t magic_[4];
113 uint8_t version_[4];
114 uint32_t adler32_checksum_;
Elliott Hughesa72ec822012-03-05 17:12:22 -0800115
116 InstructionSet instruction_set_;
Ian Rogers6f3dbba2014-10-14 17:41:57 -0700117 uint32_t instruction_set_features_bitmap_;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700118 uint32_t dex_file_count_;
119 uint32_t executable_offset_;
Ian Rogers468532e2013-08-05 10:56:33 -0700120 uint32_t interpreter_to_interpreter_bridge_offset_;
121 uint32_t interpreter_to_compiled_code_bridge_offset_;
122 uint32_t jni_dlsym_lookup_offset_;
Andreas Gampe2da88232014-02-27 12:26:20 -0800123 uint32_t quick_generic_jni_trampoline_offset_;
Jeff Hao88474b42013-10-23 16:24:40 -0700124 uint32_t quick_imt_conflict_trampoline_offset_;
Jeff Hao0aba0ba2013-06-03 14:49:28 -0700125 uint32_t quick_resolution_trampoline_offset_;
Ian Rogers468532e2013-08-05 10:56:33 -0700126 uint32_t quick_to_interpreter_bridge_offset_;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700127
Alex Lighta59dd802014-07-02 16:28:08 -0700128 // The amount that the image this oat is associated with has been patched.
129 int32_t image_patch_delta_;
130
Brian Carlstrom28db0122012-10-18 16:20:41 -0700131 uint32_t image_file_location_oat_checksum_;
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800132 uint32_t image_file_location_oat_data_begin_;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700133
134 uint32_t key_value_store_size_;
135 uint8_t key_value_store_[0]; // note variable width data at end
Brian Carlstrom81f3ca12012-03-17 00:27:35 -0700136
Brian Carlstrome24fa612011-09-29 00:53:55 -0700137 DISALLOW_COPY_AND_ASSIGN(OatHeader);
138};
139
Vladimir Marko8a630572014-04-09 18:45:35 +0100140// OatMethodOffsets are currently 5x32-bits=160-bits long, so if we can
Brian Carlstromba150c32013-08-27 17:31:03 -0700141// save even one OatMethodOffsets struct, the more complicated encoding
Vladimir Marko8a630572014-04-09 18:45:35 +0100142// using a bitmap pays for itself since few classes will have 160
Brian Carlstromba150c32013-08-27 17:31:03 -0700143// methods.
144enum OatClassType {
145 kOatClassAllCompiled = 0, // OatClass is followed by an OatMethodOffsets for each method.
146 kOatClassSomeCompiled = 1, // A bitmap of which OatMethodOffsets are present follows the OatClass.
Ian Rogers7b078e82014-09-10 14:44:24 -0700147 kOatClassNoneCompiled = 2, // All methods are interpreted so no OatMethodOffsets are necessary.
Brian Carlstromba150c32013-08-27 17:31:03 -0700148 kOatClassMax = 3,
149};
150
151std::ostream& operator<<(std::ostream& os, const OatClassType& rhs);
152
Ian Rogersdf1ce912012-11-27 17:07:11 -0800153class PACKED(4) OatMethodOffsets {
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700154 public:
Mathieu Chartier957ca1c2014-11-21 16:51:29 -0800155 OatMethodOffsets(uint32_t code_offset = 0);
Logan Chien971bf3f2012-05-01 15:47:55 +0800156
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700157 ~OatMethodOffsets();
158
159 uint32_t code_offset_;
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700160};
161
Vladimir Marko7624d252014-05-02 14:40:15 +0100162// OatQuickMethodHeader precedes the raw code chunk generated by the Quick compiler.
163class PACKED(4) OatQuickMethodHeader {
Vladimir Marko96c6ab92014-04-08 14:00:50 +0100164 public:
Mathieu Chartier957ca1c2014-11-21 16:51:29 -0800165 OatQuickMethodHeader(uint32_t mapping_table_offset = 0U, uint32_t vmap_table_offset = 0U,
166 uint32_t gc_map_offset = 0U, uint32_t frame_size_in_bytes = 0U,
167 uint32_t core_spill_mask = 0U, uint32_t fp_spill_mask = 0U,
168 uint32_t code_size = 0U);
Vladimir Marko96c6ab92014-04-08 14:00:50 +0100169
Vladimir Marko7624d252014-05-02 14:40:15 +0100170 ~OatQuickMethodHeader();
Vladimir Marko96c6ab92014-04-08 14:00:50 +0100171
Vladimir Marko8a630572014-04-09 18:45:35 +0100172 // The offset in bytes from the start of the mapping table to the end of the header.
173 uint32_t mapping_table_offset_;
174 // The offset in bytes from the start of the vmap table to the end of the header.
175 uint32_t vmap_table_offset_;
Mathieu Chartier957ca1c2014-11-21 16:51:29 -0800176 // The offset in bytes from the start of the gc map to the end of the header.
177 uint32_t gc_map_offset_;
Vladimir Marko7624d252014-05-02 14:40:15 +0100178 // The stack frame information.
179 QuickMethodFrameInfo frame_info_;
Vladimir Marko96c6ab92014-04-08 14:00:50 +0100180 // The code size in bytes.
181 uint32_t code_size_;
182};
183
Brian Carlstrome24fa612011-09-29 00:53:55 -0700184} // namespace art
185
Brian Carlstromfc0e3212013-07-17 14:40:12 -0700186#endif // ART_RUNTIME_OAT_H_