oat.h revision 2da882315a61072664f7ce3c212307342e907207 
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 "base/macros.h"
23#include "dex_file.h"
24#include "instruction_set.h"
25
26namespace art {
27
28class PACKED(4) OatHeader {
29 public:
30  static const uint8_t kOatMagic[4];
31  static const uint8_t kOatVersion[4];
32
33  OatHeader();
34  OatHeader(InstructionSet instruction_set,
35            const InstructionSetFeatures& instruction_set_features,
36            const std::vector<const DexFile*>* dex_files,
37            uint32_t image_file_location_oat_checksum,
38            uint32_t image_file_location_oat_data_begin,
39            const std::string& image_file_location);
40
41  bool IsValid() const;
42  const char* GetMagic() const;
43  uint32_t GetChecksum() const;
44  void UpdateChecksum(const void* data, size_t length);
45  uint32_t GetDexFileCount() const {
46    DCHECK(IsValid());
47    return dex_file_count_;
48  }
49  uint32_t GetExecutableOffset() const;
50  void SetExecutableOffset(uint32_t executable_offset);
51
52  const void* GetInterpreterToInterpreterBridge() const;
53  uint32_t GetInterpreterToInterpreterBridgeOffset() const;
54  void SetInterpreterToInterpreterBridgeOffset(uint32_t offset);
55  const void* GetInterpreterToCompiledCodeBridge() const;
56  uint32_t GetInterpreterToCompiledCodeBridgeOffset() const;
57  void SetInterpreterToCompiledCodeBridgeOffset(uint32_t offset);
58
59  const void* GetJniDlsymLookup() const;
60  uint32_t GetJniDlsymLookupOffset() const;
61  void SetJniDlsymLookupOffset(uint32_t offset);
62
63  const void* GetPortableResolutionTrampoline() const;
64  uint32_t GetPortableResolutionTrampolineOffset() const;
65  void SetPortableResolutionTrampolineOffset(uint32_t offset);
66  const void* GetPortableImtConflictTrampoline() const;
67  uint32_t GetPortableImtConflictTrampolineOffset() const;
68  void SetPortableImtConflictTrampolineOffset(uint32_t offset);
69  const void* GetPortableToInterpreterBridge() const;
70  uint32_t GetPortableToInterpreterBridgeOffset() const;
71  void SetPortableToInterpreterBridgeOffset(uint32_t offset);
72
73  const void* GetQuickGenericJniTrampoline() const;
74  uint32_t GetQuickGenericJniTrampolineOffset() const;
75  void SetQuickGenericJniTrampolineOffset(uint32_t offset);
76  const void* GetQuickResolutionTrampoline() const;
77  uint32_t GetQuickResolutionTrampolineOffset() const;
78  void SetQuickResolutionTrampolineOffset(uint32_t offset);
79  const void* GetQuickImtConflictTrampoline() const;
80  uint32_t GetQuickImtConflictTrampolineOffset() const;
81  void SetQuickImtConflictTrampolineOffset(uint32_t offset);
82  const void* GetQuickToInterpreterBridge() const;
83  uint32_t GetQuickToInterpreterBridgeOffset() const;
84  void SetQuickToInterpreterBridgeOffset(uint32_t offset);
85
86  InstructionSet GetInstructionSet() const;
87  const InstructionSetFeatures& GetInstructionSetFeatures() const;
88  uint32_t GetImageFileLocationOatChecksum() const;
89  uint32_t GetImageFileLocationOatDataBegin() const;
90  uint32_t GetImageFileLocationSize() const;
91  const uint8_t* GetImageFileLocationData() const;
92  std::string GetImageFileLocation() const;
93
94 private:
95  uint8_t magic_[4];
96  uint8_t version_[4];
97  uint32_t adler32_checksum_;
98
99  InstructionSet instruction_set_;
100  InstructionSetFeatures instruction_set_features_;
101  uint32_t dex_file_count_;
102  uint32_t executable_offset_;
103  uint32_t interpreter_to_interpreter_bridge_offset_;
104  uint32_t interpreter_to_compiled_code_bridge_offset_;
105  uint32_t jni_dlsym_lookup_offset_;
106  uint32_t portable_imt_conflict_trampoline_offset_;
107  uint32_t portable_resolution_trampoline_offset_;
108  uint32_t portable_to_interpreter_bridge_offset_;
109  uint32_t quick_generic_jni_trampoline_offset_;
110  uint32_t quick_imt_conflict_trampoline_offset_;
111  uint32_t quick_resolution_trampoline_offset_;
112  uint32_t quick_to_interpreter_bridge_offset_;
113
114  uint32_t image_file_location_oat_checksum_;
115  uint32_t image_file_location_oat_data_begin_;
116  uint32_t image_file_location_size_;
117  uint8_t image_file_location_data_[0];  // note variable width data at end
118
119  DISALLOW_COPY_AND_ASSIGN(OatHeader);
120};
121
122// OatMethodOffsets are currently 7x32-bits=224-bits long, so if we can
123// save even one OatMethodOffsets struct, the more complicated encoding
124// using a bitmap pays for itself since few classes will have 224
125// methods.
126enum OatClassType {
127  kOatClassAllCompiled = 0,   // OatClass is followed by an OatMethodOffsets for each method.
128  kOatClassSomeCompiled = 1,  // A bitmap of which OatMethodOffsets are present follows the OatClass.
129  kOatClassNoneCompiled = 2,  // All methods are interpretted so no OatMethodOffsets are necessary.
130  kOatClassMax = 3,
131};
132
133std::ostream& operator<<(std::ostream& os, const OatClassType& rhs);
134
135class PACKED(4) OatMethodOffsets {
136 public:
137  OatMethodOffsets();
138
139  OatMethodOffsets(uint32_t code_offset,
140                   uint32_t frame_size_in_bytes,
141                   uint32_t core_spill_mask,
142                   uint32_t fp_spill_mask,
143                   uint32_t mapping_table_offset,
144                   uint32_t vmap_table_offset,
145                   uint32_t gc_map_offset);
146
147  ~OatMethodOffsets();
148
149  uint32_t code_offset_;
150  uint32_t frame_size_in_bytes_;
151  uint32_t core_spill_mask_;
152  uint32_t fp_spill_mask_;
153  uint32_t mapping_table_offset_;
154  uint32_t vmap_table_offset_;
155  uint32_t gc_map_offset_;
156};
157
158}  // namespace art
159
160#endif  // ART_RUNTIME_OAT_H_
161