blob: b40ea3768ad36dc9c8f7c22ab1d6a99eb62a4884 [file] [log] [blame]
Calin Juravlec416d332015-04-23 16:01:43 +01001/*
2 * Copyright (C) 2015 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 */
Nicolas Geoffray5d37c152017-01-12 13:25:19 +000016
Calin Juravlec416d332015-04-23 16:01:43 +010017#include "stack_map_stream.h"
18
Andreas Gampe90b936d2017-01-31 08:58:55 -080019#include "art_method-inl.h"
David Srbecky45aa5982016-03-18 02:15:09 +000020#include "base/stl_util.h"
David Sehr9e734c72018-01-04 17:56:19 -080021#include "dex/dex_file_types.h"
Nicolas Geoffrayfbdfa6d2017-02-03 10:43:13 +000022#include "optimizing/optimizing_compiler.h"
Nicolas Geoffray5d37c152017-01-12 13:25:19 +000023#include "runtime.h"
24#include "scoped_thread_state_change-inl.h"
25
Calin Juravlec416d332015-04-23 16:01:43 +010026namespace art {
27
Calin Juravle4f46ac52015-04-23 18:47:21 +010028void StackMapStream::BeginStackMapEntry(uint32_t dex_pc,
29 uint32_t native_pc_offset,
30 uint32_t register_mask,
31 BitVector* sp_mask,
32 uint32_t num_dex_registers,
33 uint8_t inlining_depth) {
34 DCHECK_EQ(0u, current_entry_.dex_pc) << "EndStackMapEntry not called after BeginStackMapEntry";
35 current_entry_.dex_pc = dex_pc;
Mathieu Chartiera2f526f2017-01-19 14:48:48 -080036 current_entry_.native_pc_code_offset = CodeOffset::FromOffset(native_pc_offset, instruction_set_);
Calin Juravle4f46ac52015-04-23 18:47:21 +010037 current_entry_.register_mask = register_mask;
38 current_entry_.sp_mask = sp_mask;
Calin Juravle4f46ac52015-04-23 18:47:21 +010039 current_entry_.inlining_depth = inlining_depth;
Vladimir Marko225b6462015-09-28 12:17:40 +010040 current_entry_.inline_infos_start_index = inline_infos_.size();
David Srbecky45aa5982016-03-18 02:15:09 +000041 current_entry_.stack_mask_index = 0;
Andreas Gampee2abbc62017-09-15 11:59:26 -070042 current_entry_.dex_method_index = dex::kDexNoIndex;
Mathieu Chartier32289082017-02-09 15:57:37 -080043 current_entry_.dex_register_entry.num_dex_registers = num_dex_registers;
44 current_entry_.dex_register_entry.locations_start_index = dex_register_locations_.size();
Vladimir Marko174b2e22017-10-12 13:34:49 +010045 current_entry_.dex_register_entry.live_dex_registers_mask = nullptr;
46 if (num_dex_registers != 0u) {
47 current_entry_.dex_register_entry.live_dex_registers_mask =
48 ArenaBitVector::Create(allocator_, num_dex_registers, true, kArenaAllocStackMapStream);
49 current_entry_.dex_register_entry.live_dex_registers_mask->ClearAllBits();
50 }
Nicolas Geoffrayb1d0f3f2015-05-14 12:41:51 +010051 current_dex_register_ = 0;
Calin Juravlec416d332015-04-23 16:01:43 +010052}
53
Calin Juravle4f46ac52015-04-23 18:47:21 +010054void StackMapStream::EndStackMapEntry() {
Mathieu Chartier32289082017-02-09 15:57:37 -080055 current_entry_.dex_register_map_index = AddDexRegisterMapEntry(current_entry_.dex_register_entry);
Vladimir Marko225b6462015-09-28 12:17:40 +010056 stack_maps_.push_back(current_entry_);
Calin Juravle4f46ac52015-04-23 18:47:21 +010057 current_entry_ = StackMapEntry();
58}
59
Nicolas Geoffrayb1d0f3f2015-05-14 12:41:51 +010060void StackMapStream::AddDexRegisterEntry(DexRegisterLocation::Kind kind, int32_t value) {
Calin Juravlec416d332015-04-23 16:01:43 +010061 if (kind != DexRegisterLocation::Kind::kNone) {
62 // Ensure we only use non-compressed location kind at this stage.
David Srbecky7dc11782016-02-25 13:23:56 +000063 DCHECK(DexRegisterLocation::IsShortLocationKind(kind)) << kind;
Calin Juravlec416d332015-04-23 16:01:43 +010064 DexRegisterLocation location(kind, value);
65
66 // Look for Dex register `location` in the location catalog (using the
67 // companion hash map of locations to indices). Use its index if it
68 // is already in the location catalog. If not, insert it (in the
69 // location catalog and the hash map) and use the newly created index.
70 auto it = location_catalog_entries_indices_.Find(location);
71 if (it != location_catalog_entries_indices_.end()) {
72 // Retrieve the index from the hash map.
Vladimir Marko225b6462015-09-28 12:17:40 +010073 dex_register_locations_.push_back(it->second);
Calin Juravlec416d332015-04-23 16:01:43 +010074 } else {
75 // Create a new entry in the location catalog and the hash map.
Vladimir Marko225b6462015-09-28 12:17:40 +010076 size_t index = location_catalog_entries_.size();
77 location_catalog_entries_.push_back(location);
78 dex_register_locations_.push_back(index);
Calin Juravlec416d332015-04-23 16:01:43 +010079 location_catalog_entries_indices_.Insert(std::make_pair(location, index));
80 }
Mathieu Chartier32289082017-02-09 15:57:37 -080081 DexRegisterMapEntry* const entry = in_inline_frame_
82 ? &current_inline_info_.dex_register_entry
83 : &current_entry_.dex_register_entry;
84 DCHECK_LT(current_dex_register_, entry->num_dex_registers);
85 entry->live_dex_registers_mask->SetBit(current_dex_register_);
86 entry->hash += (1 <<
87 (current_dex_register_ % (sizeof(DexRegisterMapEntry::hash) * kBitsPerByte)));
88 entry->hash += static_cast<uint32_t>(value);
89 entry->hash += static_cast<uint32_t>(kind);
Calin Juravlec416d332015-04-23 16:01:43 +010090 }
Nicolas Geoffrayb1d0f3f2015-05-14 12:41:51 +010091 current_dex_register_++;
Calin Juravlec416d332015-04-23 16:01:43 +010092}
93
Mathieu Chartierd776ff02017-01-17 09:32:18 -080094void StackMapStream::AddInvoke(InvokeType invoke_type, uint32_t dex_method_index) {
95 current_entry_.invoke_type = invoke_type;
96 current_entry_.dex_method_index = dex_method_index;
97}
98
Nicolas Geoffray5d37c152017-01-12 13:25:19 +000099void StackMapStream::BeginInlineInfoEntry(ArtMethod* method,
Nicolas Geoffrayb1d0f3f2015-05-14 12:41:51 +0100100 uint32_t dex_pc,
Nicolas Geoffray5d37c152017-01-12 13:25:19 +0000101 uint32_t num_dex_registers,
102 const DexFile* outer_dex_file) {
Nicolas Geoffrayb1d0f3f2015-05-14 12:41:51 +0100103 DCHECK(!in_inline_frame_);
104 in_inline_frame_ = true;
Nicolas Geoffray5d37c152017-01-12 13:25:19 +0000105 if (EncodeArtMethodInInlineInfo(method)) {
106 current_inline_info_.method = method;
107 } else {
108 if (dex_pc != static_cast<uint32_t>(-1) && kIsDebugBuild) {
109 ScopedObjectAccess soa(Thread::Current());
110 DCHECK(IsSameDexFile(*outer_dex_file, *method->GetDexFile()));
111 }
112 current_inline_info_.method_index = method->GetDexMethodIndexUnchecked();
113 }
Nicolas Geoffrayb1d0f3f2015-05-14 12:41:51 +0100114 current_inline_info_.dex_pc = dex_pc;
Mathieu Chartier32289082017-02-09 15:57:37 -0800115 current_inline_info_.dex_register_entry.num_dex_registers = num_dex_registers;
116 current_inline_info_.dex_register_entry.locations_start_index = dex_register_locations_.size();
Vladimir Marko174b2e22017-10-12 13:34:49 +0100117 current_inline_info_.dex_register_entry.live_dex_registers_mask = nullptr;
118 if (num_dex_registers != 0) {
119 current_inline_info_.dex_register_entry.live_dex_registers_mask =
120 ArenaBitVector::Create(allocator_, num_dex_registers, true, kArenaAllocStackMapStream);
121 current_inline_info_.dex_register_entry.live_dex_registers_mask->ClearAllBits();
122 }
Nicolas Geoffrayb1d0f3f2015-05-14 12:41:51 +0100123 current_dex_register_ = 0;
124}
125
126void StackMapStream::EndInlineInfoEntry() {
Mathieu Chartier32289082017-02-09 15:57:37 -0800127 current_inline_info_.dex_register_map_index =
128 AddDexRegisterMapEntry(current_inline_info_.dex_register_entry);
Nicolas Geoffrayb1d0f3f2015-05-14 12:41:51 +0100129 DCHECK(in_inline_frame_);
Mathieu Chartier32289082017-02-09 15:57:37 -0800130 DCHECK_EQ(current_dex_register_, current_inline_info_.dex_register_entry.num_dex_registers)
Nicolas Geoffrayb1d0f3f2015-05-14 12:41:51 +0100131 << "Inline information contains less registers than expected";
132 in_inline_frame_ = false;
Vladimir Marko225b6462015-09-28 12:17:40 +0100133 inline_infos_.push_back(current_inline_info_);
Nicolas Geoffrayb1d0f3f2015-05-14 12:41:51 +0100134 current_inline_info_ = InlineInfoEntry();
Calin Juravlec416d332015-04-23 16:01:43 +0100135}
136
Calin Juravlec416d332015-04-23 16:01:43 +0100137size_t StackMapStream::ComputeDexRegisterLocationCatalogSize() const {
138 size_t size = DexRegisterLocationCatalog::kFixedSize;
Vladimir Marko225b6462015-09-28 12:17:40 +0100139 for (const DexRegisterLocation& dex_register_location : location_catalog_entries_) {
Calin Juravlec416d332015-04-23 16:01:43 +0100140 size += DexRegisterLocationCatalog::EntrySize(dex_register_location);
141 }
142 return size;
143}
144
Mathieu Chartier32289082017-02-09 15:57:37 -0800145size_t StackMapStream::DexRegisterMapEntry::ComputeSize(size_t catalog_size) const {
Vladimir Marko225b6462015-09-28 12:17:40 +0100146 // For num_dex_registers == 0u live_dex_registers_mask may be null.
147 if (num_dex_registers == 0u) {
148 return 0u; // No register map will be emitted.
149 }
David Srbecky052f8ca2018-04-26 15:42:54 +0100150 size_t number_of_live_dex_registers = live_dex_registers_mask->NumSetBits();
151 if (live_dex_registers_mask->NumSetBits() == 0) {
152 return 0u; // No register map will be emitted.
153 }
Vladimir Marko225b6462015-09-28 12:17:40 +0100154 DCHECK(live_dex_registers_mask != nullptr);
155
Calin Juravlec416d332015-04-23 16:01:43 +0100156 // Size of the map in bytes.
157 size_t size = DexRegisterMap::kFixedSize;
158 // Add the live bit mask for the Dex register liveness.
Nicolas Geoffrayb1d0f3f2015-05-14 12:41:51 +0100159 size += DexRegisterMap::GetLiveBitMaskSize(num_dex_registers);
Calin Juravlec416d332015-04-23 16:01:43 +0100160 // Compute the size of the set of live Dex register entries.
Calin Juravlec416d332015-04-23 16:01:43 +0100161 size_t map_entries_size_in_bits =
Mathieu Chartier32289082017-02-09 15:57:37 -0800162 DexRegisterMap::SingleEntrySizeInBits(catalog_size) * number_of_live_dex_registers;
Calin Juravlec416d332015-04-23 16:01:43 +0100163 size_t map_entries_size_in_bytes =
164 RoundUp(map_entries_size_in_bits, kBitsPerByte) / kBitsPerByte;
165 size += map_entries_size_in_bytes;
166 return size;
167}
168
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -0700169void StackMapStream::FillInMethodInfo(MemoryRegion region) {
170 {
171 MethodInfo info(region.begin(), method_indices_.size());
172 for (size_t i = 0; i < method_indices_.size(); ++i) {
173 info.SetMethodIndex(i, method_indices_[i]);
174 }
175 }
176 if (kIsDebugBuild) {
177 // Check the data matches.
178 MethodInfo info(region.begin());
179 const size_t count = info.NumMethodIndices();
180 DCHECK_EQ(count, method_indices_.size());
181 for (size_t i = 0; i < count; ++i) {
182 DCHECK_EQ(info.GetMethodIndex(i), method_indices_[i]);
183 }
184 }
185}
186
David Srbecky052f8ca2018-04-26 15:42:54 +0100187template<typename Vector>
188static MemoryRegion EncodeMemoryRegion(Vector* out, size_t* bit_offset, uint32_t bit_length) {
189 uint32_t byte_length = BitsToBytesRoundUp(bit_length);
190 EncodeVarintBits(out, bit_offset, byte_length);
191 *bit_offset = RoundUp(*bit_offset, kBitsPerByte);
192 out->resize(out->size() + byte_length);
193 MemoryRegion region(out->data() + *bit_offset / kBitsPerByte, byte_length);
194 *bit_offset += kBitsPerByte * byte_length;
195 return region;
196}
Calin Juravle4f46ac52015-04-23 18:47:21 +0100197
David Srbecky052f8ca2018-04-26 15:42:54 +0100198size_t StackMapStream::PrepareForFillIn() {
199 size_t bit_offset = 0;
200 out_.clear();
David Srbecky09ed0982016-02-12 21:58:43 +0000201
David Srbecky052f8ca2018-04-26 15:42:54 +0100202 // Decide the offsets of dex register map entries, but do not write them out yet.
203 // Needs to be done first as it modifies the stack map entry.
204 size_t dex_register_map_bytes = 0;
205 for (DexRegisterMapEntry& entry : dex_register_entries_) {
206 size_t size = entry.ComputeSize(location_catalog_entries_.size());
207 entry.offset = size == 0 ? DexRegisterMapEntry::kOffsetUnassigned : dex_register_map_bytes;
208 dex_register_map_bytes += size;
209 }
Calin Juravlec416d332015-04-23 16:01:43 +0100210
David Srbecky052f8ca2018-04-26 15:42:54 +0100211 // Must be done before calling ComputeInlineInfoEncoding since ComputeInlineInfoEncoding requires
212 // dex_method_index_idx to be filled in.
213 PrepareMethodIndices();
Mathieu Chartier575d3e62017-02-06 11:00:40 -0800214
David Srbecky052f8ca2018-04-26 15:42:54 +0100215 // Dedup stack masks. Needs to be done first as it modifies the stack map entry.
David Srbecky4b59d102018-05-29 21:46:10 +0000216 BitmapTableBuilder stack_mask_builder(allocator_);
217 for (StackMapEntry& stack_map : stack_maps_) {
218 BitVector* mask = stack_map.sp_mask;
219 size_t num_bits = (mask != nullptr) ? mask->GetNumberOfBits() : 0;
220 if (num_bits != 0) {
221 stack_map.stack_mask_index = stack_mask_builder.Dedup(mask->GetRawStorage(), num_bits);
222 } else {
223 stack_map.stack_mask_index = StackMap::kNoValue;
224 }
225 }
Calin Juravlec416d332015-04-23 16:01:43 +0100226
David Srbecky052f8ca2018-04-26 15:42:54 +0100227 // Dedup register masks. Needs to be done first as it modifies the stack map entry.
David Srbecky4b59d102018-05-29 21:46:10 +0000228 BitTableBuilder<std::array<uint32_t, RegisterMask::kCount>> register_mask_builder(allocator_);
229 for (StackMapEntry& stack_map : stack_maps_) {
230 uint32_t register_mask = stack_map.register_mask;
231 if (register_mask != 0) {
232 uint32_t shift = LeastSignificantBit(register_mask);
233 std::array<uint32_t, RegisterMask::kCount> entry = {
234 register_mask >> shift,
235 shift,
236 };
237 stack_map.register_mask_index = register_mask_builder.Dedup(&entry);
238 } else {
239 stack_map.register_mask_index = StackMap::kNoValue;
240 }
241 }
David Srbecky052f8ca2018-04-26 15:42:54 +0100242
243 // Write dex register maps.
244 MemoryRegion dex_register_map_region =
245 EncodeMemoryRegion(&out_, &bit_offset, dex_register_map_bytes * kBitsPerByte);
246 for (DexRegisterMapEntry& entry : dex_register_entries_) {
247 size_t entry_size = entry.ComputeSize(location_catalog_entries_.size());
248 if (entry_size != 0) {
249 DexRegisterMap dex_register_map(
250 dex_register_map_region.Subregion(entry.offset, entry_size));
251 FillInDexRegisterMap(dex_register_map,
252 entry.num_dex_registers,
253 *entry.live_dex_registers_mask,
254 entry.locations_start_index);
255 }
256 }
257
258 // Write dex register catalog.
259 EncodeVarintBits(&out_, &bit_offset, location_catalog_entries_.size());
260 size_t location_catalog_bytes = ComputeDexRegisterLocationCatalogSize();
261 MemoryRegion dex_register_location_catalog_region =
262 EncodeMemoryRegion(&out_, &bit_offset, location_catalog_bytes * kBitsPerByte);
Calin Juravlec416d332015-04-23 16:01:43 +0100263 DexRegisterLocationCatalog dex_register_location_catalog(dex_register_location_catalog_region);
264 // Offset in `dex_register_location_catalog` where to store the next
265 // register location.
266 size_t location_catalog_offset = DexRegisterLocationCatalog::kFixedSize;
Vladimir Marko225b6462015-09-28 12:17:40 +0100267 for (DexRegisterLocation dex_register_location : location_catalog_entries_) {
Calin Juravlec416d332015-04-23 16:01:43 +0100268 dex_register_location_catalog.SetRegisterInfo(location_catalog_offset, dex_register_location);
269 location_catalog_offset += DexRegisterLocationCatalog::EntrySize(dex_register_location);
270 }
271 // Ensure we reached the end of the Dex registers location_catalog.
272 DCHECK_EQ(location_catalog_offset, dex_register_location_catalog_region.size());
273
David Srbecky052f8ca2018-04-26 15:42:54 +0100274 // Write stack maps.
David Srbeckydd966bc2018-05-24 13:55:52 +0100275 BitTableBuilder<std::array<uint32_t, StackMap::kCount>> stack_map_builder(allocator_);
276 BitTableBuilder<std::array<uint32_t, InvokeInfo::kCount>> invoke_info_builder(allocator_);
277 BitTableBuilder<std::array<uint32_t, InlineInfo::kCount>> inline_info_builder(allocator_);
David Srbecky052f8ca2018-04-26 15:42:54 +0100278 for (const StackMapEntry& entry : stack_maps_) {
Andreas Gampee2abbc62017-09-15 11:59:26 -0700279 if (entry.dex_method_index != dex::kDexNoIndex) {
David Srbeckydd966bc2018-05-24 13:55:52 +0100280 std::array<uint32_t, InvokeInfo::kCount> invoke_info_entry {
David Srbecky052f8ca2018-04-26 15:42:54 +0100281 entry.native_pc_code_offset.CompressedValue(),
282 entry.invoke_type,
David Srbeckydd966bc2018-05-24 13:55:52 +0100283 entry.dex_method_index_idx
284 };
285 invoke_info_builder.Add(invoke_info_entry);
Mathieu Chartierd776ff02017-01-17 09:32:18 -0800286 }
287
Calin Juravlec416d332015-04-23 16:01:43 +0100288 // Set the inlining info.
David Srbeckydd966bc2018-05-24 13:55:52 +0100289 uint32_t inline_info_index = inline_info_builder.size();
David Srbecky052f8ca2018-04-26 15:42:54 +0100290 DCHECK_LE(entry.inline_infos_start_index + entry.inlining_depth, inline_infos_.size());
291 for (size_t depth = 0; depth < entry.inlining_depth; ++depth) {
292 InlineInfoEntry inline_entry = inline_infos_[depth + entry.inline_infos_start_index];
293 uint32_t method_index_idx = inline_entry.dex_method_index_idx;
294 uint32_t extra_data = 1;
295 if (inline_entry.method != nullptr) {
296 method_index_idx = High32Bits(reinterpret_cast<uintptr_t>(inline_entry.method));
297 extra_data = Low32Bits(reinterpret_cast<uintptr_t>(inline_entry.method));
Calin Juravlec416d332015-04-23 16:01:43 +0100298 }
David Srbeckydd966bc2018-05-24 13:55:52 +0100299 std::array<uint32_t, InlineInfo::kCount> inline_info_entry {
David Srbecky052f8ca2018-04-26 15:42:54 +0100300 (depth == entry.inlining_depth - 1) ? InlineInfo::kLast : InlineInfo::kMore,
301 method_index_idx,
302 inline_entry.dex_pc,
303 extra_data,
David Srbeckydd966bc2018-05-24 13:55:52 +0100304 dex_register_entries_[inline_entry.dex_register_map_index].offset,
305 };
306 inline_info_builder.Add(inline_info_entry);
Calin Juravlec416d332015-04-23 16:01:43 +0100307 }
David Srbeckydd966bc2018-05-24 13:55:52 +0100308 std::array<uint32_t, StackMap::kCount> stack_map_entry {
David Srbecky052f8ca2018-04-26 15:42:54 +0100309 entry.native_pc_code_offset.CompressedValue(),
310 entry.dex_pc,
311 dex_register_entries_[entry.dex_register_map_index].offset,
David Srbeckydd966bc2018-05-24 13:55:52 +0100312 entry.inlining_depth != 0 ? inline_info_index : InlineInfo::kNoValue,
David Srbecky052f8ca2018-04-26 15:42:54 +0100313 entry.register_mask_index,
David Srbeckydd966bc2018-05-24 13:55:52 +0100314 entry.stack_mask_index,
315 };
316 stack_map_builder.Add(stack_map_entry);
Calin Juravlec416d332015-04-23 16:01:43 +0100317 }
David Srbecky052f8ca2018-04-26 15:42:54 +0100318 stack_map_builder.Encode(&out_, &bit_offset);
319 invoke_info_builder.Encode(&out_, &bit_offset);
320 inline_info_builder.Encode(&out_, &bit_offset);
David Srbecky052f8ca2018-04-26 15:42:54 +0100321 register_mask_builder.Encode(&out_, &bit_offset);
David Srbecky4b59d102018-05-29 21:46:10 +0000322 stack_mask_builder.Encode(&out_, &bit_offset);
David Srbecky45aa5982016-03-18 02:15:09 +0000323
David Srbecky052f8ca2018-04-26 15:42:54 +0100324 return UnsignedLeb128Size(out_.size()) + out_.size();
325}
326
327void StackMapStream::FillInCodeInfo(MemoryRegion region) {
328 DCHECK_EQ(0u, current_entry_.dex_pc) << "EndStackMapEntry not called after BeginStackMapEntry";
329 DCHECK_NE(0u, out_.size()) << "PrepareForFillIn not called before FillIn";
330 DCHECK_EQ(region.size(), UnsignedLeb128Size(out_.size()) + out_.size());
331
332 uint8_t* ptr = EncodeUnsignedLeb128(region.begin(), out_.size());
333 region.CopyFromVector(ptr - region.begin(), out_);
Mathieu Chartier1a20b682017-01-31 14:25:16 -0800334
David Srbecky1bbdfd72016-02-24 16:39:26 +0000335 // Verify all written data in debug build.
336 if (kIsDebugBuild) {
337 CheckCodeInfo(region);
338 }
Calin Juravlec416d332015-04-23 16:01:43 +0100339}
340
Nicolas Geoffrayb1d0f3f2015-05-14 12:41:51 +0100341void StackMapStream::FillInDexRegisterMap(DexRegisterMap dex_register_map,
342 uint32_t num_dex_registers,
343 const BitVector& live_dex_registers_mask,
344 uint32_t start_index_in_dex_register_locations) const {
345 dex_register_map.SetLiveBitMask(num_dex_registers, live_dex_registers_mask);
346 // Set the dex register location mapping data.
Vladimir Marko225b6462015-09-28 12:17:40 +0100347 size_t number_of_live_dex_registers = live_dex_registers_mask.NumSetBits();
348 DCHECK_LE(number_of_live_dex_registers, dex_register_locations_.size());
349 DCHECK_LE(start_index_in_dex_register_locations,
350 dex_register_locations_.size() - number_of_live_dex_registers);
351 for (size_t index_in_dex_register_locations = 0;
352 index_in_dex_register_locations != number_of_live_dex_registers;
353 ++index_in_dex_register_locations) {
354 size_t location_catalog_entry_index = dex_register_locations_[
355 start_index_in_dex_register_locations + index_in_dex_register_locations];
356 dex_register_map.SetLocationCatalogEntryIndex(
357 index_in_dex_register_locations,
358 location_catalog_entry_index,
359 num_dex_registers,
360 location_catalog_entries_.size());
Nicolas Geoffrayb1d0f3f2015-05-14 12:41:51 +0100361 }
362}
363
Mathieu Chartier32289082017-02-09 15:57:37 -0800364size_t StackMapStream::AddDexRegisterMapEntry(const DexRegisterMapEntry& entry) {
365 const size_t current_entry_index = dex_register_entries_.size();
366 auto entries_it = dex_map_hash_to_stack_map_indices_.find(entry.hash);
Calin Juravlec416d332015-04-23 16:01:43 +0100367 if (entries_it == dex_map_hash_to_stack_map_indices_.end()) {
368 // We don't have a perfect hash functions so we need a list to collect all stack maps
369 // which might have the same dex register map.
Vladimir Marko174b2e22017-10-12 13:34:49 +0100370 ScopedArenaVector<uint32_t> stack_map_indices(allocator_->Adapter(kArenaAllocStackMapStream));
Vladimir Marko225b6462015-09-28 12:17:40 +0100371 stack_map_indices.push_back(current_entry_index);
Mathieu Chartier32289082017-02-09 15:57:37 -0800372 dex_map_hash_to_stack_map_indices_.Put(entry.hash, std::move(stack_map_indices));
373 } else {
374 // We might have collisions, so we need to check whether or not we really have a match.
375 for (uint32_t test_entry_index : entries_it->second) {
376 if (DexRegisterMapEntryEquals(dex_register_entries_[test_entry_index], entry)) {
377 return test_entry_index;
378 }
Calin Juravlec416d332015-04-23 16:01:43 +0100379 }
Mathieu Chartier32289082017-02-09 15:57:37 -0800380 entries_it->second.push_back(current_entry_index);
Calin Juravlec416d332015-04-23 16:01:43 +0100381 }
Mathieu Chartier32289082017-02-09 15:57:37 -0800382 dex_register_entries_.push_back(entry);
383 return current_entry_index;
Calin Juravlec416d332015-04-23 16:01:43 +0100384}
385
Mathieu Chartier32289082017-02-09 15:57:37 -0800386bool StackMapStream::DexRegisterMapEntryEquals(const DexRegisterMapEntry& a,
387 const DexRegisterMapEntry& b) const {
388 if ((a.live_dex_registers_mask == nullptr) != (b.live_dex_registers_mask == nullptr)) {
Calin Juravlec416d332015-04-23 16:01:43 +0100389 return false;
390 }
391 if (a.num_dex_registers != b.num_dex_registers) {
392 return false;
393 }
Vladimir Marko225b6462015-09-28 12:17:40 +0100394 if (a.num_dex_registers != 0u) {
395 DCHECK(a.live_dex_registers_mask != nullptr);
396 DCHECK(b.live_dex_registers_mask != nullptr);
397 if (!a.live_dex_registers_mask->Equal(b.live_dex_registers_mask)) {
Calin Juravlec416d332015-04-23 16:01:43 +0100398 return false;
399 }
Vladimir Marko225b6462015-09-28 12:17:40 +0100400 size_t number_of_live_dex_registers = a.live_dex_registers_mask->NumSetBits();
401 DCHECK_LE(number_of_live_dex_registers, dex_register_locations_.size());
Mathieu Chartier32289082017-02-09 15:57:37 -0800402 DCHECK_LE(a.locations_start_index,
Vladimir Marko225b6462015-09-28 12:17:40 +0100403 dex_register_locations_.size() - number_of_live_dex_registers);
Mathieu Chartier32289082017-02-09 15:57:37 -0800404 DCHECK_LE(b.locations_start_index,
Vladimir Marko225b6462015-09-28 12:17:40 +0100405 dex_register_locations_.size() - number_of_live_dex_registers);
Mathieu Chartier32289082017-02-09 15:57:37 -0800406 auto a_begin = dex_register_locations_.begin() + a.locations_start_index;
407 auto b_begin = dex_register_locations_.begin() + b.locations_start_index;
Vladimir Marko225b6462015-09-28 12:17:40 +0100408 if (!std::equal(a_begin, a_begin + number_of_live_dex_registers, b_begin)) {
409 return false;
Calin Juravlec416d332015-04-23 16:01:43 +0100410 }
411 }
412 return true;
413}
414
David Srbecky1bbdfd72016-02-24 16:39:26 +0000415// Helper for CheckCodeInfo - check that register map has the expected content.
416void StackMapStream::CheckDexRegisterMap(const CodeInfo& code_info,
417 const DexRegisterMap& dex_register_map,
418 size_t num_dex_registers,
419 BitVector* live_dex_registers_mask,
420 size_t dex_register_locations_index) const {
David Srbecky1bbdfd72016-02-24 16:39:26 +0000421 for (size_t reg = 0; reg < num_dex_registers; reg++) {
422 // Find the location we tried to encode.
423 DexRegisterLocation expected = DexRegisterLocation::None();
424 if (live_dex_registers_mask->IsBitSet(reg)) {
425 size_t catalog_index = dex_register_locations_[dex_register_locations_index++];
426 expected = location_catalog_entries_[catalog_index];
427 }
428 // Compare to the seen location.
429 if (expected.GetKind() == DexRegisterLocation::Kind::kNone) {
Mathieu Chartier575d3e62017-02-06 11:00:40 -0800430 DCHECK(!dex_register_map.IsValid() || !dex_register_map.IsDexRegisterLive(reg))
431 << dex_register_map.IsValid() << " " << dex_register_map.IsDexRegisterLive(reg);
David Srbecky1bbdfd72016-02-24 16:39:26 +0000432 } else {
433 DCHECK(dex_register_map.IsDexRegisterLive(reg));
434 DexRegisterLocation seen = dex_register_map.GetDexRegisterLocation(
David Srbecky052f8ca2018-04-26 15:42:54 +0100435 reg, num_dex_registers, code_info);
David Srbecky1bbdfd72016-02-24 16:39:26 +0000436 DCHECK_EQ(expected.GetKind(), seen.GetKind());
437 DCHECK_EQ(expected.GetValue(), seen.GetValue());
438 }
439 }
440 if (num_dex_registers == 0) {
441 DCHECK(!dex_register_map.IsValid());
442 }
443}
444
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -0700445void StackMapStream::PrepareMethodIndices() {
446 CHECK(method_indices_.empty());
447 method_indices_.resize(stack_maps_.size() + inline_infos_.size());
Vladimir Marko174b2e22017-10-12 13:34:49 +0100448 ScopedArenaUnorderedMap<uint32_t, size_t> dedupe(allocator_->Adapter(kArenaAllocStackMapStream));
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -0700449 for (StackMapEntry& stack_map : stack_maps_) {
450 const size_t index = dedupe.size();
451 const uint32_t method_index = stack_map.dex_method_index;
Andreas Gampee2abbc62017-09-15 11:59:26 -0700452 if (method_index != dex::kDexNoIndex) {
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -0700453 stack_map.dex_method_index_idx = dedupe.emplace(method_index, index).first->second;
454 method_indices_[index] = method_index;
455 }
456 }
457 for (InlineInfoEntry& inline_info : inline_infos_) {
458 const size_t index = dedupe.size();
459 const uint32_t method_index = inline_info.method_index;
Andreas Gampee2abbc62017-09-15 11:59:26 -0700460 CHECK_NE(method_index, dex::kDexNoIndex);
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -0700461 inline_info.dex_method_index_idx = dedupe.emplace(method_index, index).first->second;
462 method_indices_[index] = method_index;
463 }
464 method_indices_.resize(dedupe.size());
465}
466
David Srbecky1bbdfd72016-02-24 16:39:26 +0000467// Check that all StackMapStream inputs are correctly encoded by trying to read them back.
468void StackMapStream::CheckCodeInfo(MemoryRegion region) const {
469 CodeInfo code_info(region);
David Srbecky052f8ca2018-04-26 15:42:54 +0100470 DCHECK_EQ(code_info.GetNumberOfStackMaps(), stack_maps_.size());
David Srbecky052f8ca2018-04-26 15:42:54 +0100471 DCHECK_EQ(code_info.GetNumberOfLocationCatalogEntries(), location_catalog_entries_.size());
Mathieu Chartierd776ff02017-01-17 09:32:18 -0800472 size_t invoke_info_index = 0;
David Srbecky1bbdfd72016-02-24 16:39:26 +0000473 for (size_t s = 0; s < stack_maps_.size(); ++s) {
David Srbecky052f8ca2018-04-26 15:42:54 +0100474 const StackMap stack_map = code_info.GetStackMapAt(s);
David Srbecky1bbdfd72016-02-24 16:39:26 +0000475 StackMapEntry entry = stack_maps_[s];
476
477 // Check main stack map fields.
David Srbecky052f8ca2018-04-26 15:42:54 +0100478 DCHECK_EQ(stack_map.GetNativePcOffset(instruction_set_),
Mathieu Chartiera2f526f2017-01-19 14:48:48 -0800479 entry.native_pc_code_offset.Uint32Value(instruction_set_));
David Srbecky052f8ca2018-04-26 15:42:54 +0100480 DCHECK_EQ(stack_map.GetDexPc(), entry.dex_pc);
481 DCHECK_EQ(stack_map.GetRegisterMaskIndex(), entry.register_mask_index);
482 DCHECK_EQ(code_info.GetRegisterMaskOf(stack_map), entry.register_mask);
David Srbecky052f8ca2018-04-26 15:42:54 +0100483 DCHECK_EQ(stack_map.GetStackMaskIndex(), entry.stack_mask_index);
484 BitMemoryRegion stack_mask = code_info.GetStackMaskOf(stack_map);
David Srbecky1bbdfd72016-02-24 16:39:26 +0000485 if (entry.sp_mask != nullptr) {
David Srbecky45aa5982016-03-18 02:15:09 +0000486 DCHECK_GE(stack_mask.size_in_bits(), entry.sp_mask->GetNumberOfBits());
David Srbecky4b59d102018-05-29 21:46:10 +0000487 for (size_t b = 0; b < stack_mask.size_in_bits(); b++) {
488 DCHECK_EQ(stack_mask.LoadBit(b), entry.sp_mask->IsBitSet(b)) << b;
David Srbecky1bbdfd72016-02-24 16:39:26 +0000489 }
490 } else {
David Srbecky4b59d102018-05-29 21:46:10 +0000491 DCHECK_EQ(stack_mask.size_in_bits(), 0u);
David Srbecky1bbdfd72016-02-24 16:39:26 +0000492 }
Andreas Gampee2abbc62017-09-15 11:59:26 -0700493 if (entry.dex_method_index != dex::kDexNoIndex) {
David Srbecky052f8ca2018-04-26 15:42:54 +0100494 InvokeInfo invoke_info = code_info.GetInvokeInfo(invoke_info_index);
495 DCHECK_EQ(invoke_info.GetNativePcOffset(instruction_set_),
Mathieu Chartierd776ff02017-01-17 09:32:18 -0800496 entry.native_pc_code_offset.Uint32Value(instruction_set_));
David Srbecky052f8ca2018-04-26 15:42:54 +0100497 DCHECK_EQ(invoke_info.GetInvokeType(), entry.invoke_type);
498 DCHECK_EQ(invoke_info.GetMethodIndexIdx(), entry.dex_method_index_idx);
Mathieu Chartierd776ff02017-01-17 09:32:18 -0800499 invoke_info_index++;
500 }
David Srbecky1bbdfd72016-02-24 16:39:26 +0000501 CheckDexRegisterMap(code_info,
502 code_info.GetDexRegisterMapOf(
David Srbecky052f8ca2018-04-26 15:42:54 +0100503 stack_map, entry.dex_register_entry.num_dex_registers),
Mathieu Chartier32289082017-02-09 15:57:37 -0800504 entry.dex_register_entry.num_dex_registers,
505 entry.dex_register_entry.live_dex_registers_mask,
506 entry.dex_register_entry.locations_start_index);
David Srbecky1bbdfd72016-02-24 16:39:26 +0000507
508 // Check inline info.
David Srbecky052f8ca2018-04-26 15:42:54 +0100509 DCHECK_EQ(stack_map.HasInlineInfo(), (entry.inlining_depth != 0));
David Srbecky1bbdfd72016-02-24 16:39:26 +0000510 if (entry.inlining_depth != 0) {
David Srbecky052f8ca2018-04-26 15:42:54 +0100511 InlineInfo inline_info = code_info.GetInlineInfoOf(stack_map);
512 DCHECK_EQ(inline_info.GetDepth(), entry.inlining_depth);
David Srbecky1bbdfd72016-02-24 16:39:26 +0000513 for (size_t d = 0; d < entry.inlining_depth; ++d) {
514 size_t inline_info_index = entry.inline_infos_start_index + d;
515 DCHECK_LT(inline_info_index, inline_infos_.size());
516 InlineInfoEntry inline_entry = inline_infos_[inline_info_index];
David Srbecky052f8ca2018-04-26 15:42:54 +0100517 DCHECK_EQ(inline_info.GetDexPcAtDepth(d), inline_entry.dex_pc);
518 if (inline_info.EncodesArtMethodAtDepth(d)) {
519 DCHECK_EQ(inline_info.GetArtMethodAtDepth(d),
Nicolas Geoffray5d37c152017-01-12 13:25:19 +0000520 inline_entry.method);
521 } else {
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -0700522 const size_t method_index_idx =
David Srbecky052f8ca2018-04-26 15:42:54 +0100523 inline_info.GetMethodIndexIdxAtDepth(d);
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -0700524 DCHECK_EQ(method_index_idx, inline_entry.dex_method_index_idx);
525 DCHECK_EQ(method_indices_[method_index_idx], inline_entry.method_index);
Nicolas Geoffray5d37c152017-01-12 13:25:19 +0000526 }
David Srbecky1bbdfd72016-02-24 16:39:26 +0000527
528 CheckDexRegisterMap(code_info,
529 code_info.GetDexRegisterMapAtDepth(
Mathieu Chartier32289082017-02-09 15:57:37 -0800530 d,
531 inline_info,
Mathieu Chartier32289082017-02-09 15:57:37 -0800532 inline_entry.dex_register_entry.num_dex_registers),
533 inline_entry.dex_register_entry.num_dex_registers,
534 inline_entry.dex_register_entry.live_dex_registers_mask,
535 inline_entry.dex_register_entry.locations_start_index);
David Srbecky1bbdfd72016-02-24 16:39:26 +0000536 }
537 }
538 }
539}
540
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -0700541size_t StackMapStream::ComputeMethodInfoSize() const {
David Srbecky052f8ca2018-04-26 15:42:54 +0100542 DCHECK_NE(0u, out_.size()) << "PrepareForFillIn not called before " << __FUNCTION__;
Mathieu Chartiercbcedbf2017-03-12 22:24:50 -0700543 return MethodInfo::ComputeSize(method_indices_.size());
544}
545
Calin Juravlec416d332015-04-23 16:01:43 +0100546} // namespace art