blob: fbed596d335d507d892b60d2f0505676229a97ad [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
Elliott Hughes76160052012-12-12 16:31:20 -080022#include "base/macros.h"
Brian Carlstrome24fa612011-09-29 00:53:55 -070023#include "dex_file.h"
Elliott Hughes0f3c5532012-03-30 14:51:51 -070024#include "instruction_set.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 Rogersdf1ce912012-11-27 17:07:11 -080030class PACKED(4) OatHeader {
Brian Carlstrome24fa612011-09-29 00:53:55 -070031 public:
Brian Carlstrom7c3d13a2013-09-04 17:15:11 -070032 static const uint8_t kOatMagic[4];
33 static const uint8_t kOatVersion[4];
34
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070035 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 Carlstrome24fa612011-09-29 00:53:55 -070045
46 bool IsValid() const;
47 const char* GetMagic() const;
48 uint32_t GetChecksum() const;
49 void UpdateChecksum(const void* data, size_t length);
Ian Rogers4f6ad8a2013-03-18 15:27:28 -070050 uint32_t GetDexFileCount() const {
51 DCHECK(IsValid());
52 return dex_file_count_;
53 }
Brian Carlstrome24fa612011-09-29 00:53:55 -070054 uint32_t GetExecutableOffset() const;
55 void SetExecutableOffset(uint32_t executable_offset);
Ian Rogers468532e2013-08-05 10:56:33 -070056
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 Hao0aba0ba2013-06-03 14:49:28 -070068 const void* GetPortableResolutionTrampoline() const;
69 uint32_t GetPortableResolutionTrampolineOffset() const;
70 void SetPortableResolutionTrampolineOffset(uint32_t offset);
Jeff Hao88474b42013-10-23 16:24:40 -070071 const void* GetPortableImtConflictTrampoline() const;
72 uint32_t GetPortableImtConflictTrampolineOffset() const;
73 void SetPortableImtConflictTrampolineOffset(uint32_t offset);
Ian Rogers468532e2013-08-05 10:56:33 -070074 const void* GetPortableToInterpreterBridge() const;
75 uint32_t GetPortableToInterpreterBridgeOffset() const;
76 void SetPortableToInterpreterBridgeOffset(uint32_t offset);
77
Andreas Gampe2da88232014-02-27 12:26:20 -080078 const void* GetQuickGenericJniTrampoline() const;
79 uint32_t GetQuickGenericJniTrampolineOffset() const;
80 void SetQuickGenericJniTrampolineOffset(uint32_t offset);
Jeff Hao0aba0ba2013-06-03 14:49:28 -070081 const void* GetQuickResolutionTrampoline() const;
82 uint32_t GetQuickResolutionTrampolineOffset() const;
83 void SetQuickResolutionTrampolineOffset(uint32_t offset);
Jeff Hao88474b42013-10-23 16:24:40 -070084 const void* GetQuickImtConflictTrampoline() const;
85 uint32_t GetQuickImtConflictTrampolineOffset() const;
86 void SetQuickImtConflictTrampolineOffset(uint32_t offset);
Ian Rogers468532e2013-08-05 10:56:33 -070087 const void* GetQuickToInterpreterBridge() const;
88 uint32_t GetQuickToInterpreterBridgeOffset() const;
89 void SetQuickToInterpreterBridgeOffset(uint32_t offset);
90
Jeff Hao0aba0ba2013-06-03 14:49:28 -070091 InstructionSet GetInstructionSet() const;
Dave Allison70202782013-10-22 17:52:19 -070092 const InstructionSetFeatures& GetInstructionSetFeatures() const;
Brian Carlstrom28db0122012-10-18 16:20:41 -070093 uint32_t GetImageFileLocationOatChecksum() const;
Brian Carlstrom700c8d32012-11-05 10:42:02 -080094 uint32_t GetImageFileLocationOatDataBegin() const;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -070095
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 Carlstrome24fa612011-09-29 00:53:55 -0700102
103 private:
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700104 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 Carlstrome24fa612011-09-29 00:53:55 -0700113 uint8_t magic_[4];
114 uint8_t version_[4];
115 uint32_t adler32_checksum_;
Elliott Hughesa72ec822012-03-05 17:12:22 -0800116
117 InstructionSet instruction_set_;
Dave Allison70202782013-10-22 17:52:19 -0700118 InstructionSetFeatures instruction_set_features_;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700119 uint32_t dex_file_count_;
120 uint32_t executable_offset_;
Ian Rogers468532e2013-08-05 10:56:33 -0700121 uint32_t interpreter_to_interpreter_bridge_offset_;
122 uint32_t interpreter_to_compiled_code_bridge_offset_;
123 uint32_t jni_dlsym_lookup_offset_;
Jeff Hao88474b42013-10-23 16:24:40 -0700124 uint32_t portable_imt_conflict_trampoline_offset_;
Jeff Hao0aba0ba2013-06-03 14:49:28 -0700125 uint32_t portable_resolution_trampoline_offset_;
Ian Rogers468532e2013-08-05 10:56:33 -0700126 uint32_t portable_to_interpreter_bridge_offset_;
Andreas Gampe2da88232014-02-27 12:26:20 -0800127 uint32_t quick_generic_jni_trampoline_offset_;
Jeff Hao88474b42013-10-23 16:24:40 -0700128 uint32_t quick_imt_conflict_trampoline_offset_;
Jeff Hao0aba0ba2013-06-03 14:49:28 -0700129 uint32_t quick_resolution_trampoline_offset_;
Ian Rogers468532e2013-08-05 10:56:33 -0700130 uint32_t quick_to_interpreter_bridge_offset_;
Brian Carlstrome24fa612011-09-29 00:53:55 -0700131
Brian Carlstrom28db0122012-10-18 16:20:41 -0700132 uint32_t image_file_location_oat_checksum_;
Brian Carlstrom700c8d32012-11-05 10:42:02 -0800133 uint32_t image_file_location_oat_data_begin_;
Andreas Gampe22f8e5c2014-07-09 11:38:21 -0700134
135 uint32_t key_value_store_size_;
136 uint8_t key_value_store_[0]; // note variable width data at end
Brian Carlstrom81f3ca12012-03-17 00:27:35 -0700137
Brian Carlstrome24fa612011-09-29 00:53:55 -0700138 DISALLOW_COPY_AND_ASSIGN(OatHeader);
139};
140
Vladimir Marko8a630572014-04-09 18:45:35 +0100141// OatMethodOffsets are currently 5x32-bits=160-bits long, so if we can
Brian Carlstromba150c32013-08-27 17:31:03 -0700142// save even one OatMethodOffsets struct, the more complicated encoding
Vladimir Marko8a630572014-04-09 18:45:35 +0100143// using a bitmap pays for itself since few classes will have 160
Brian Carlstromba150c32013-08-27 17:31:03 -0700144// methods.
145enum 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
152std::ostream& operator<<(std::ostream& os, const OatClassType& rhs);
153
Ian Rogersdf1ce912012-11-27 17:07:11 -0800154class PACKED(4) OatMethodOffsets {
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700155 public:
156 OatMethodOffsets();
Logan Chien971bf3f2012-05-01 15:47:55 +0800157
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700158 OatMethodOffsets(uint32_t code_offset,
Brian Carlstromdf629502013-07-17 22:39:56 -0700159 uint32_t gc_map_offset);
Logan Chien971bf3f2012-05-01 15:47:55 +0800160
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700161 ~OatMethodOffsets();
162
163 uint32_t code_offset_;
Brian Carlstrome7d856b2012-01-11 18:10:55 -0800164 uint32_t gc_map_offset_;
Brian Carlstrom3320cf42011-10-04 14:58:28 -0700165};
166
Vladimir Marko7624d252014-05-02 14:40:15 +0100167// OatQuickMethodHeader precedes the raw code chunk generated by the Quick compiler.
168class PACKED(4) OatQuickMethodHeader {
Vladimir Marko96c6ab92014-04-08 14:00:50 +0100169 public:
Vladimir Marko7624d252014-05-02 14:40:15 +0100170 OatQuickMethodHeader();
Vladimir Marko96c6ab92014-04-08 14:00:50 +0100171
Vladimir Marko7624d252014-05-02 14:40:15 +0100172 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 Marko96c6ab92014-04-08 14:00:50 +0100175
Vladimir Marko7624d252014-05-02 14:40:15 +0100176 ~OatQuickMethodHeader();
Vladimir Marko96c6ab92014-04-08 14:00:50 +0100177
Vladimir Marko8a630572014-04-09 18:45:35 +0100178 // 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 Marko7624d252014-05-02 14:40:15 +0100182 // The stack frame information.
183 QuickMethodFrameInfo frame_info_;
Vladimir Marko96c6ab92014-04-08 14:00:50 +0100184 // The code size in bytes.
185 uint32_t code_size_;
186};
187
Brian Carlstrome24fa612011-09-29 00:53:55 -0700188} // namespace art
189
Brian Carlstromfc0e3212013-07-17 14:40:12 -0700190#endif // ART_RUNTIME_OAT_H_