blob: 8c90edb1f4e08d8fddf8744683d7f53eab3b0c8c [file] [log] [blame]
buzbee311ca162013-02-28 15:56:43 -08001/*
2 * Copyright (C) 2013 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
Ian Rogers6282dc12013-04-18 15:54:02 -070017#include "base/stl_util.h"
buzbee311ca162013-02-28 15:56:43 -080018#include "compiler_internals.h"
buzbee311ca162013-02-28 15:56:43 -080019#include "dex_file-inl.h"
Ian Rogers6282dc12013-04-18 15:54:02 -070020#include "leb128.h"
21#include "mir_graph.h"
buzbee311ca162013-02-28 15:56:43 -080022
Vladimir Marko5816ed42013-11-27 17:04:20 +000023#include "dex/quick/dex_file_to_method_inliner_map.h"
24#include "dex/quick/dex_file_method_inliner.h"
25
buzbee311ca162013-02-28 15:56:43 -080026namespace art {
27
28#define MAX_PATTERN_LEN 5
29
buzbee1fd33462013-03-25 13:40:45 -070030const char* MIRGraph::extended_mir_op_names_[kMirOpLast - kMirOpFirst] = {
31 "Phi",
32 "Copy",
33 "FusedCmplFloat",
34 "FusedCmpgFloat",
35 "FusedCmplDouble",
36 "FusedCmpgDouble",
37 "FusedCmpLong",
38 "Nop",
39 "OpNullCheck",
40 "OpRangeCheck",
41 "OpDivZeroCheck",
42 "Check1",
43 "Check2",
44 "Select",
45};
46
buzbee862a7602013-04-05 10:58:54 -070047MIRGraph::MIRGraph(CompilationUnit* cu, ArenaAllocator* arena)
buzbee1fd33462013-03-25 13:40:45 -070048 : reg_location_(NULL),
buzbee862a7602013-04-05 10:58:54 -070049 compiler_temps_(arena, 6, kGrowableArrayMisc),
buzbee1fd33462013-03-25 13:40:45 -070050 cu_(cu),
buzbee311ca162013-02-28 15:56:43 -080051 ssa_base_vregs_(NULL),
52 ssa_subscripts_(NULL),
buzbee311ca162013-02-28 15:56:43 -080053 vreg_to_ssa_map_(NULL),
54 ssa_last_defs_(NULL),
55 is_constant_v_(NULL),
56 constant_values_(NULL),
buzbee862a7602013-04-05 10:58:54 -070057 use_counts_(arena, 256, kGrowableArrayMisc),
58 raw_use_counts_(arena, 256, kGrowableArrayMisc),
buzbee311ca162013-02-28 15:56:43 -080059 num_reachable_blocks_(0),
buzbee862a7602013-04-05 10:58:54 -070060 dfs_order_(NULL),
61 dfs_post_order_(NULL),
62 dom_post_order_traversal_(NULL),
buzbee311ca162013-02-28 15:56:43 -080063 i_dom_list_(NULL),
64 def_block_matrix_(NULL),
65 temp_block_v_(NULL),
66 temp_dalvik_register_v_(NULL),
67 temp_ssa_register_v_(NULL),
buzbee862a7602013-04-05 10:58:54 -070068 block_list_(arena, 100, kGrowableArrayBlockList),
buzbee311ca162013-02-28 15:56:43 -080069 try_block_addr_(NULL),
70 entry_block_(NULL),
71 exit_block_(NULL),
buzbee311ca162013-02-28 15:56:43 -080072 num_blocks_(0),
73 current_code_item_(NULL),
buzbeeb48819d2013-09-14 16:15:25 -070074 dex_pc_to_block_map_(arena, 0, kGrowableArrayMisc),
buzbee311ca162013-02-28 15:56:43 -080075 current_method_(kInvalidEntry),
76 current_offset_(kInvalidEntry),
77 def_count_(0),
78 opcode_count_(NULL),
buzbee1fd33462013-03-25 13:40:45 -070079 num_ssa_regs_(0),
80 method_sreg_(0),
buzbee862a7602013-04-05 10:58:54 -070081 attributes_(METHOD_IS_LEAF), // Start with leaf assumption, change on encountering invoke.
82 checkstats_(NULL),
buzbeeb48819d2013-09-14 16:15:25 -070083 arena_(arena),
84 backward_branches_(0),
85 forward_branches_(0) {
buzbee862a7602013-04-05 10:58:54 -070086 try_block_addr_ = new (arena_) ArenaBitVector(arena_, 0, true /* expandable */);
buzbee311ca162013-02-28 15:56:43 -080087}
88
Ian Rogers6282dc12013-04-18 15:54:02 -070089MIRGraph::~MIRGraph() {
90 STLDeleteElements(&m_units_);
91}
92
buzbee311ca162013-02-28 15:56:43 -080093/*
94 * Parse an instruction, return the length of the instruction
95 */
Brian Carlstrom2ce745c2013-07-17 17:44:30 -070096int MIRGraph::ParseInsn(const uint16_t* code_ptr, DecodedInstruction* decoded_instruction) {
buzbee311ca162013-02-28 15:56:43 -080097 const Instruction* instruction = Instruction::At(code_ptr);
98 *decoded_instruction = DecodedInstruction(instruction);
99
100 return instruction->SizeInCodeUnits();
101}
102
103
104/* Split an existing block from the specified code offset into two */
buzbee0d829482013-10-11 15:24:55 -0700105BasicBlock* MIRGraph::SplitBlock(DexOffset code_offset,
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700106 BasicBlock* orig_block, BasicBlock** immed_pred_block_p) {
buzbee0d829482013-10-11 15:24:55 -0700107 DCHECK_GT(code_offset, orig_block->start_offset);
buzbee311ca162013-02-28 15:56:43 -0800108 MIR* insn = orig_block->first_mir_insn;
buzbee0d829482013-10-11 15:24:55 -0700109 MIR* prev = NULL;
buzbee311ca162013-02-28 15:56:43 -0800110 while (insn) {
111 if (insn->offset == code_offset) break;
buzbee0d829482013-10-11 15:24:55 -0700112 prev = insn;
buzbee311ca162013-02-28 15:56:43 -0800113 insn = insn->next;
114 }
115 if (insn == NULL) {
116 LOG(FATAL) << "Break split failed";
117 }
buzbee862a7602013-04-05 10:58:54 -0700118 BasicBlock *bottom_block = NewMemBB(kDalvikByteCode, num_blocks_++);
119 block_list_.Insert(bottom_block);
buzbee311ca162013-02-28 15:56:43 -0800120
121 bottom_block->start_offset = code_offset;
122 bottom_block->first_mir_insn = insn;
123 bottom_block->last_mir_insn = orig_block->last_mir_insn;
124
125 /* If this block was terminated by a return, the flag needs to go with the bottom block */
126 bottom_block->terminated_by_return = orig_block->terminated_by_return;
127 orig_block->terminated_by_return = false;
128
buzbee311ca162013-02-28 15:56:43 -0800129 /* Handle the taken path */
130 bottom_block->taken = orig_block->taken;
buzbee0d829482013-10-11 15:24:55 -0700131 if (bottom_block->taken != NullBasicBlockId) {
132 orig_block->taken = NullBasicBlockId;
133 BasicBlock* bb_taken = GetBasicBlock(bottom_block->taken);
134 bb_taken->predecessors->Delete(orig_block->id);
135 bb_taken->predecessors->Insert(bottom_block->id);
buzbee311ca162013-02-28 15:56:43 -0800136 }
137
138 /* Handle the fallthrough path */
139 bottom_block->fall_through = orig_block->fall_through;
buzbee0d829482013-10-11 15:24:55 -0700140 orig_block->fall_through = bottom_block->id;
141 bottom_block->predecessors->Insert(orig_block->id);
142 if (bottom_block->fall_through != NullBasicBlockId) {
143 BasicBlock* bb_fall_through = GetBasicBlock(bottom_block->fall_through);
144 bb_fall_through->predecessors->Delete(orig_block->id);
145 bb_fall_through->predecessors->Insert(bottom_block->id);
buzbee311ca162013-02-28 15:56:43 -0800146 }
147
148 /* Handle the successor list */
buzbee0d829482013-10-11 15:24:55 -0700149 if (orig_block->successor_block_list_type != kNotUsed) {
150 bottom_block->successor_block_list_type = orig_block->successor_block_list_type;
151 bottom_block->successor_blocks = orig_block->successor_blocks;
152 orig_block->successor_block_list_type = kNotUsed;
153 orig_block->successor_blocks = NULL;
154 GrowableArray<SuccessorBlockInfo*>::Iterator iterator(bottom_block->successor_blocks);
buzbee311ca162013-02-28 15:56:43 -0800155 while (true) {
buzbee862a7602013-04-05 10:58:54 -0700156 SuccessorBlockInfo *successor_block_info = iterator.Next();
buzbee311ca162013-02-28 15:56:43 -0800157 if (successor_block_info == NULL) break;
buzbee0d829482013-10-11 15:24:55 -0700158 BasicBlock *bb = GetBasicBlock(successor_block_info->block);
159 bb->predecessors->Delete(orig_block->id);
160 bb->predecessors->Insert(bottom_block->id);
buzbee311ca162013-02-28 15:56:43 -0800161 }
162 }
163
buzbee0d829482013-10-11 15:24:55 -0700164 orig_block->last_mir_insn = prev;
165 prev->next = NULL;
buzbee311ca162013-02-28 15:56:43 -0800166
buzbee311ca162013-02-28 15:56:43 -0800167 /*
168 * Update the immediate predecessor block pointer so that outgoing edges
169 * can be applied to the proper block.
170 */
171 if (immed_pred_block_p) {
172 DCHECK_EQ(*immed_pred_block_p, orig_block);
173 *immed_pred_block_p = bottom_block;
174 }
buzbeeb48819d2013-09-14 16:15:25 -0700175
176 // Associate dex instructions in the bottom block with the new container.
Vladimir Marko8a3e7e72014-01-23 12:39:29 +0000177 DCHECK(insn != nullptr);
178 DCHECK(insn != orig_block->first_mir_insn);
179 DCHECK(insn == bottom_block->first_mir_insn);
180 DCHECK_EQ(insn->offset, bottom_block->start_offset);
181 DCHECK(static_cast<int>(insn->dalvikInsn.opcode) == kMirOpCheck ||
182 !IsPseudoMirOp(insn->dalvikInsn.opcode));
183 DCHECK_EQ(dex_pc_to_block_map_.Get(insn->offset), orig_block->id);
184 MIR* p = insn;
185 dex_pc_to_block_map_.Put(p->offset, bottom_block->id);
186 while (p != bottom_block->last_mir_insn) {
187 p = p->next;
188 DCHECK(p != nullptr);
buzbeeb48819d2013-09-14 16:15:25 -0700189 int opcode = p->dalvikInsn.opcode;
190 /*
191 * Some messiness here to ensure that we only enter real opcodes and only the
192 * first half of a potentially throwing instruction that has been split into
Vladimir Marko8a3e7e72014-01-23 12:39:29 +0000193 * CHECK and work portions. Since the 2nd half of a split operation is always
194 * the first in a BasicBlock, we can't hit it here.
buzbeeb48819d2013-09-14 16:15:25 -0700195 */
Vladimir Marko8a3e7e72014-01-23 12:39:29 +0000196 if ((opcode == kMirOpCheck) || !IsPseudoMirOp(opcode)) {
197 DCHECK_EQ(dex_pc_to_block_map_.Get(p->offset), orig_block->id);
buzbeeb48819d2013-09-14 16:15:25 -0700198 dex_pc_to_block_map_.Put(p->offset, bottom_block->id);
199 }
buzbeeb48819d2013-09-14 16:15:25 -0700200 }
201
buzbee311ca162013-02-28 15:56:43 -0800202 return bottom_block;
203}
204
205/*
206 * Given a code offset, find out the block that starts with it. If the offset
207 * is in the middle of an existing block, split it into two. If immed_pred_block_p
208 * is not non-null and is the block being split, update *immed_pred_block_p to
209 * point to the bottom block so that outgoing edges can be set up properly
210 * (by the caller)
211 * Utilizes a map for fast lookup of the typical cases.
212 */
buzbee0d829482013-10-11 15:24:55 -0700213BasicBlock* MIRGraph::FindBlock(DexOffset code_offset, bool split, bool create,
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700214 BasicBlock** immed_pred_block_p) {
buzbeebd663de2013-09-10 15:41:31 -0700215 if (code_offset >= cu_->code_item->insns_size_in_code_units_) {
buzbee311ca162013-02-28 15:56:43 -0800216 return NULL;
217 }
buzbeeb48819d2013-09-14 16:15:25 -0700218
219 int block_id = dex_pc_to_block_map_.Get(code_offset);
220 BasicBlock* bb = (block_id == 0) ? NULL : block_list_.Get(block_id);
221
222 if ((bb != NULL) && (bb->start_offset == code_offset)) {
223 // Does this containing block start with the desired instruction?
buzbeebd663de2013-09-10 15:41:31 -0700224 return bb;
225 }
buzbee311ca162013-02-28 15:56:43 -0800226
buzbeeb48819d2013-09-14 16:15:25 -0700227 // No direct hit.
228 if (!create) {
229 return NULL;
buzbee311ca162013-02-28 15:56:43 -0800230 }
231
buzbeeb48819d2013-09-14 16:15:25 -0700232 if (bb != NULL) {
233 // The target exists somewhere in an existing block.
234 return SplitBlock(code_offset, bb, bb == *immed_pred_block_p ? immed_pred_block_p : NULL);
235 }
236
237 // Create a new block.
buzbee862a7602013-04-05 10:58:54 -0700238 bb = NewMemBB(kDalvikByteCode, num_blocks_++);
239 block_list_.Insert(bb);
buzbee311ca162013-02-28 15:56:43 -0800240 bb->start_offset = code_offset;
buzbeeb48819d2013-09-14 16:15:25 -0700241 dex_pc_to_block_map_.Put(bb->start_offset, bb->id);
buzbee311ca162013-02-28 15:56:43 -0800242 return bb;
243}
244
buzbeeb48819d2013-09-14 16:15:25 -0700245
buzbee311ca162013-02-28 15:56:43 -0800246/* Identify code range in try blocks and set up the empty catch blocks */
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700247void MIRGraph::ProcessTryCatchBlocks() {
buzbee311ca162013-02-28 15:56:43 -0800248 int tries_size = current_code_item_->tries_size_;
buzbee0d829482013-10-11 15:24:55 -0700249 DexOffset offset;
buzbee311ca162013-02-28 15:56:43 -0800250
251 if (tries_size == 0) {
252 return;
253 }
254
255 for (int i = 0; i < tries_size; i++) {
256 const DexFile::TryItem* pTry =
257 DexFile::GetTryItems(*current_code_item_, i);
buzbee0d829482013-10-11 15:24:55 -0700258 DexOffset start_offset = pTry->start_addr_;
259 DexOffset end_offset = start_offset + pTry->insn_count_;
buzbee311ca162013-02-28 15:56:43 -0800260 for (offset = start_offset; offset < end_offset; offset++) {
buzbee862a7602013-04-05 10:58:54 -0700261 try_block_addr_->SetBit(offset);
buzbee311ca162013-02-28 15:56:43 -0800262 }
263 }
264
265 // Iterate over each of the handlers to enqueue the empty Catch blocks
266 const byte* handlers_ptr = DexFile::GetCatchHandlerData(*current_code_item_, 0);
267 uint32_t handlers_size = DecodeUnsignedLeb128(&handlers_ptr);
268 for (uint32_t idx = 0; idx < handlers_size; idx++) {
269 CatchHandlerIterator iterator(handlers_ptr);
270 for (; iterator.HasNext(); iterator.Next()) {
271 uint32_t address = iterator.GetHandlerAddress();
272 FindBlock(address, false /* split */, true /*create*/,
273 /* immed_pred_block_p */ NULL);
274 }
275 handlers_ptr = iterator.EndDataPointer();
276 }
277}
278
279/* Process instructions with the kBranch flag */
buzbee0d829482013-10-11 15:24:55 -0700280BasicBlock* MIRGraph::ProcessCanBranch(BasicBlock* cur_block, MIR* insn, DexOffset cur_offset,
281 int width, int flags, const uint16_t* code_ptr,
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700282 const uint16_t* code_end) {
buzbee0d829482013-10-11 15:24:55 -0700283 DexOffset target = cur_offset;
buzbee311ca162013-02-28 15:56:43 -0800284 switch (insn->dalvikInsn.opcode) {
285 case Instruction::GOTO:
286 case Instruction::GOTO_16:
287 case Instruction::GOTO_32:
288 target += insn->dalvikInsn.vA;
289 break;
290 case Instruction::IF_EQ:
291 case Instruction::IF_NE:
292 case Instruction::IF_LT:
293 case Instruction::IF_GE:
294 case Instruction::IF_GT:
295 case Instruction::IF_LE:
296 cur_block->conditional_branch = true;
297 target += insn->dalvikInsn.vC;
298 break;
299 case Instruction::IF_EQZ:
300 case Instruction::IF_NEZ:
301 case Instruction::IF_LTZ:
302 case Instruction::IF_GEZ:
303 case Instruction::IF_GTZ:
304 case Instruction::IF_LEZ:
305 cur_block->conditional_branch = true;
306 target += insn->dalvikInsn.vB;
307 break;
308 default:
309 LOG(FATAL) << "Unexpected opcode(" << insn->dalvikInsn.opcode << ") with kBranch set";
310 }
buzbeeb48819d2013-09-14 16:15:25 -0700311 CountBranch(target);
buzbee311ca162013-02-28 15:56:43 -0800312 BasicBlock *taken_block = FindBlock(target, /* split */ true, /* create */ true,
313 /* immed_pred_block_p */ &cur_block);
buzbee0d829482013-10-11 15:24:55 -0700314 cur_block->taken = taken_block->id;
315 taken_block->predecessors->Insert(cur_block->id);
buzbee311ca162013-02-28 15:56:43 -0800316
317 /* Always terminate the current block for conditional branches */
318 if (flags & Instruction::kContinue) {
319 BasicBlock *fallthrough_block = FindBlock(cur_offset + width,
320 /*
321 * If the method is processed
322 * in sequential order from the
323 * beginning, we don't need to
324 * specify split for continue
325 * blocks. However, this
326 * routine can be called by
327 * compileLoop, which starts
328 * parsing the method from an
329 * arbitrary address in the
330 * method body.
331 */
332 true,
333 /* create */
334 true,
335 /* immed_pred_block_p */
336 &cur_block);
buzbee0d829482013-10-11 15:24:55 -0700337 cur_block->fall_through = fallthrough_block->id;
338 fallthrough_block->predecessors->Insert(cur_block->id);
buzbee311ca162013-02-28 15:56:43 -0800339 } else if (code_ptr < code_end) {
buzbee27247762013-07-28 12:03:58 -0700340 FindBlock(cur_offset + width, /* split */ false, /* create */ true,
buzbee311ca162013-02-28 15:56:43 -0800341 /* immed_pred_block_p */ NULL);
buzbee311ca162013-02-28 15:56:43 -0800342 }
343 return cur_block;
344}
345
346/* Process instructions with the kSwitch flag */
buzbee17189ac2013-11-08 11:07:02 -0800347BasicBlock* MIRGraph::ProcessCanSwitch(BasicBlock* cur_block, MIR* insn, DexOffset cur_offset,
348 int width, int flags) {
buzbee311ca162013-02-28 15:56:43 -0800349 const uint16_t* switch_data =
350 reinterpret_cast<const uint16_t*>(GetCurrentInsns() + cur_offset + insn->dalvikInsn.vB);
351 int size;
352 const int* keyTable;
353 const int* target_table;
354 int i;
355 int first_key;
356
357 /*
358 * Packed switch data format:
359 * ushort ident = 0x0100 magic value
360 * ushort size number of entries in the table
361 * int first_key first (and lowest) switch case value
362 * int targets[size] branch targets, relative to switch opcode
363 *
364 * Total size is (4+size*2) 16-bit code units.
365 */
366 if (insn->dalvikInsn.opcode == Instruction::PACKED_SWITCH) {
367 DCHECK_EQ(static_cast<int>(switch_data[0]),
368 static_cast<int>(Instruction::kPackedSwitchSignature));
369 size = switch_data[1];
370 first_key = switch_data[2] | (switch_data[3] << 16);
371 target_table = reinterpret_cast<const int*>(&switch_data[4]);
372 keyTable = NULL; // Make the compiler happy
373 /*
374 * Sparse switch data format:
375 * ushort ident = 0x0200 magic value
376 * ushort size number of entries in the table; > 0
377 * int keys[size] keys, sorted low-to-high; 32-bit aligned
378 * int targets[size] branch targets, relative to switch opcode
379 *
380 * Total size is (2+size*4) 16-bit code units.
381 */
382 } else {
383 DCHECK_EQ(static_cast<int>(switch_data[0]),
384 static_cast<int>(Instruction::kSparseSwitchSignature));
385 size = switch_data[1];
386 keyTable = reinterpret_cast<const int*>(&switch_data[2]);
387 target_table = reinterpret_cast<const int*>(&switch_data[2 + size*2]);
388 first_key = 0; // To make the compiler happy
389 }
390
buzbee0d829482013-10-11 15:24:55 -0700391 if (cur_block->successor_block_list_type != kNotUsed) {
buzbee311ca162013-02-28 15:56:43 -0800392 LOG(FATAL) << "Successor block list already in use: "
buzbee0d829482013-10-11 15:24:55 -0700393 << static_cast<int>(cur_block->successor_block_list_type);
buzbee311ca162013-02-28 15:56:43 -0800394 }
buzbee0d829482013-10-11 15:24:55 -0700395 cur_block->successor_block_list_type =
396 (insn->dalvikInsn.opcode == Instruction::PACKED_SWITCH) ? kPackedSwitch : kSparseSwitch;
397 cur_block->successor_blocks =
Brian Carlstromdf629502013-07-17 22:39:56 -0700398 new (arena_) GrowableArray<SuccessorBlockInfo*>(arena_, size, kGrowableArraySuccessorBlocks);
buzbee311ca162013-02-28 15:56:43 -0800399
400 for (i = 0; i < size; i++) {
401 BasicBlock *case_block = FindBlock(cur_offset + target_table[i], /* split */ true,
402 /* create */ true, /* immed_pred_block_p */ &cur_block);
403 SuccessorBlockInfo *successor_block_info =
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -0700404 static_cast<SuccessorBlockInfo*>(arena_->Alloc(sizeof(SuccessorBlockInfo),
405 ArenaAllocator::kAllocSuccessor));
buzbee0d829482013-10-11 15:24:55 -0700406 successor_block_info->block = case_block->id;
buzbee311ca162013-02-28 15:56:43 -0800407 successor_block_info->key =
408 (insn->dalvikInsn.opcode == Instruction::PACKED_SWITCH) ?
409 first_key + i : keyTable[i];
buzbee0d829482013-10-11 15:24:55 -0700410 cur_block->successor_blocks->Insert(successor_block_info);
411 case_block->predecessors->Insert(cur_block->id);
buzbee311ca162013-02-28 15:56:43 -0800412 }
413
414 /* Fall-through case */
Brian Carlstromdf629502013-07-17 22:39:56 -0700415 BasicBlock* fallthrough_block = FindBlock(cur_offset + width, /* split */ false,
416 /* create */ true, /* immed_pred_block_p */ NULL);
buzbee0d829482013-10-11 15:24:55 -0700417 cur_block->fall_through = fallthrough_block->id;
418 fallthrough_block->predecessors->Insert(cur_block->id);
buzbee17189ac2013-11-08 11:07:02 -0800419 return cur_block;
buzbee311ca162013-02-28 15:56:43 -0800420}
421
422/* Process instructions with the kThrow flag */
buzbee0d829482013-10-11 15:24:55 -0700423BasicBlock* MIRGraph::ProcessCanThrow(BasicBlock* cur_block, MIR* insn, DexOffset cur_offset,
424 int width, int flags, ArenaBitVector* try_block_addr,
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700425 const uint16_t* code_ptr, const uint16_t* code_end) {
buzbee862a7602013-04-05 10:58:54 -0700426 bool in_try_block = try_block_addr->IsBitSet(cur_offset);
buzbee17189ac2013-11-08 11:07:02 -0800427 bool is_throw = (insn->dalvikInsn.opcode == Instruction::THROW);
428 bool build_all_edges =
429 (cu_->disable_opt & (1 << kSuppressExceptionEdges)) || is_throw || in_try_block;
buzbee311ca162013-02-28 15:56:43 -0800430
431 /* In try block */
432 if (in_try_block) {
433 CatchHandlerIterator iterator(*current_code_item_, cur_offset);
434
buzbee0d829482013-10-11 15:24:55 -0700435 if (cur_block->successor_block_list_type != kNotUsed) {
buzbee311ca162013-02-28 15:56:43 -0800436 LOG(INFO) << PrettyMethod(cu_->method_idx, *cu_->dex_file);
437 LOG(FATAL) << "Successor block list already in use: "
buzbee0d829482013-10-11 15:24:55 -0700438 << static_cast<int>(cur_block->successor_block_list_type);
buzbee311ca162013-02-28 15:56:43 -0800439 }
440
buzbee0d829482013-10-11 15:24:55 -0700441 cur_block->successor_block_list_type = kCatch;
442 cur_block->successor_blocks =
buzbee862a7602013-04-05 10:58:54 -0700443 new (arena_) GrowableArray<SuccessorBlockInfo*>(arena_, 2, kGrowableArraySuccessorBlocks);
buzbee311ca162013-02-28 15:56:43 -0800444
Brian Carlstrom02c8cc62013-07-18 15:54:44 -0700445 for (; iterator.HasNext(); iterator.Next()) {
buzbee311ca162013-02-28 15:56:43 -0800446 BasicBlock *catch_block = FindBlock(iterator.GetHandlerAddress(), false /* split*/,
447 false /* creat */, NULL /* immed_pred_block_p */);
448 catch_block->catch_entry = true;
449 if (kIsDebugBuild) {
450 catches_.insert(catch_block->start_offset);
451 }
452 SuccessorBlockInfo *successor_block_info = reinterpret_cast<SuccessorBlockInfo*>
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -0700453 (arena_->Alloc(sizeof(SuccessorBlockInfo), ArenaAllocator::kAllocSuccessor));
buzbee0d829482013-10-11 15:24:55 -0700454 successor_block_info->block = catch_block->id;
buzbee311ca162013-02-28 15:56:43 -0800455 successor_block_info->key = iterator.GetHandlerTypeIndex();
buzbee0d829482013-10-11 15:24:55 -0700456 cur_block->successor_blocks->Insert(successor_block_info);
457 catch_block->predecessors->Insert(cur_block->id);
buzbee311ca162013-02-28 15:56:43 -0800458 }
buzbee17189ac2013-11-08 11:07:02 -0800459 } else if (build_all_edges) {
buzbee862a7602013-04-05 10:58:54 -0700460 BasicBlock *eh_block = NewMemBB(kExceptionHandling, num_blocks_++);
buzbee0d829482013-10-11 15:24:55 -0700461 cur_block->taken = eh_block->id;
buzbee862a7602013-04-05 10:58:54 -0700462 block_list_.Insert(eh_block);
buzbee311ca162013-02-28 15:56:43 -0800463 eh_block->start_offset = cur_offset;
buzbee0d829482013-10-11 15:24:55 -0700464 eh_block->predecessors->Insert(cur_block->id);
buzbee311ca162013-02-28 15:56:43 -0800465 }
466
buzbee17189ac2013-11-08 11:07:02 -0800467 if (is_throw) {
buzbee311ca162013-02-28 15:56:43 -0800468 cur_block->explicit_throw = true;
buzbee27247762013-07-28 12:03:58 -0700469 if (code_ptr < code_end) {
buzbee311ca162013-02-28 15:56:43 -0800470 // Force creation of new block following THROW via side-effect
471 FindBlock(cur_offset + width, /* split */ false, /* create */ true,
472 /* immed_pred_block_p */ NULL);
473 }
474 if (!in_try_block) {
475 // Don't split a THROW that can't rethrow - we're done.
476 return cur_block;
477 }
478 }
479
buzbee17189ac2013-11-08 11:07:02 -0800480 if (!build_all_edges) {
481 /*
482 * Even though there is an exception edge here, control cannot return to this
483 * method. Thus, for the purposes of dataflow analysis and optimization, we can
484 * ignore the edge. Doing this reduces compile time, and increases the scope
485 * of the basic-block level optimization pass.
486 */
487 return cur_block;
488 }
489
buzbee311ca162013-02-28 15:56:43 -0800490 /*
491 * Split the potentially-throwing instruction into two parts.
492 * The first half will be a pseudo-op that captures the exception
493 * edges and terminates the basic block. It always falls through.
494 * Then, create a new basic block that begins with the throwing instruction
495 * (minus exceptions). Note: this new basic block must NOT be entered into
496 * the block_map. If the potentially-throwing instruction is the target of a
497 * future branch, we need to find the check psuedo half. The new
498 * basic block containing the work portion of the instruction should
499 * only be entered via fallthrough from the block containing the
500 * pseudo exception edge MIR. Note also that this new block is
501 * not automatically terminated after the work portion, and may
502 * contain following instructions.
buzbeeb48819d2013-09-14 16:15:25 -0700503 *
504 * Note also that the dex_pc_to_block_map_ entry for the potentially
505 * throwing instruction will refer to the original basic block.
buzbee311ca162013-02-28 15:56:43 -0800506 */
buzbee862a7602013-04-05 10:58:54 -0700507 BasicBlock *new_block = NewMemBB(kDalvikByteCode, num_blocks_++);
508 block_list_.Insert(new_block);
buzbee311ca162013-02-28 15:56:43 -0800509 new_block->start_offset = insn->offset;
buzbee0d829482013-10-11 15:24:55 -0700510 cur_block->fall_through = new_block->id;
511 new_block->predecessors->Insert(cur_block->id);
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -0700512 MIR* new_insn = static_cast<MIR*>(arena_->Alloc(sizeof(MIR), ArenaAllocator::kAllocMIR));
buzbee311ca162013-02-28 15:56:43 -0800513 *new_insn = *insn;
514 insn->dalvikInsn.opcode =
515 static_cast<Instruction::Code>(kMirOpCheck);
516 // Associate the two halves
517 insn->meta.throw_insn = new_insn;
buzbee311ca162013-02-28 15:56:43 -0800518 AppendMIR(new_block, new_insn);
519 return new_block;
520}
521
522/* Parse a Dex method and insert it into the MIRGraph at the current insert point. */
523void MIRGraph::InlineMethod(const DexFile::CodeItem* code_item, uint32_t access_flags,
Ian Rogers8b2c0b92013-09-19 02:56:49 -0700524 InvokeType invoke_type, uint16_t class_def_idx,
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700525 uint32_t method_idx, jobject class_loader, const DexFile& dex_file) {
buzbee311ca162013-02-28 15:56:43 -0800526 current_code_item_ = code_item;
527 method_stack_.push_back(std::make_pair(current_method_, current_offset_));
528 current_method_ = m_units_.size();
529 current_offset_ = 0;
530 // TODO: will need to snapshot stack image and use that as the mir context identification.
531 m_units_.push_back(new DexCompilationUnit(cu_, class_loader, Runtime::Current()->GetClassLinker(),
532 dex_file, current_code_item_, class_def_idx, method_idx, access_flags));
533 const uint16_t* code_ptr = current_code_item_->insns_;
534 const uint16_t* code_end =
535 current_code_item_->insns_ + current_code_item_->insns_size_in_code_units_;
536
537 // TODO: need to rework expansion of block list & try_block_addr when inlining activated.
buzbeeb48819d2013-09-14 16:15:25 -0700538 // TUNING: use better estimate of basic blocks for following resize.
buzbee862a7602013-04-05 10:58:54 -0700539 block_list_.Resize(block_list_.Size() + current_code_item_->insns_size_in_code_units_);
buzbeeb48819d2013-09-14 16:15:25 -0700540 dex_pc_to_block_map_.SetSize(dex_pc_to_block_map_.Size() + current_code_item_->insns_size_in_code_units_);
buzbeebd663de2013-09-10 15:41:31 -0700541
buzbee311ca162013-02-28 15:56:43 -0800542 // TODO: replace with explicit resize routine. Using automatic extension side effect for now.
buzbee862a7602013-04-05 10:58:54 -0700543 try_block_addr_->SetBit(current_code_item_->insns_size_in_code_units_);
544 try_block_addr_->ClearBit(current_code_item_->insns_size_in_code_units_);
buzbee311ca162013-02-28 15:56:43 -0800545
546 // If this is the first method, set up default entry and exit blocks.
547 if (current_method_ == 0) {
548 DCHECK(entry_block_ == NULL);
549 DCHECK(exit_block_ == NULL);
Brian Carlstrom42748892013-07-18 18:04:08 -0700550 DCHECK_EQ(num_blocks_, 0);
buzbee0d829482013-10-11 15:24:55 -0700551 // Use id 0 to represent a null block.
552 BasicBlock* null_block = NewMemBB(kNullBlock, num_blocks_++);
553 DCHECK_EQ(null_block->id, NullBasicBlockId);
554 null_block->hidden = true;
555 block_list_.Insert(null_block);
buzbee862a7602013-04-05 10:58:54 -0700556 entry_block_ = NewMemBB(kEntryBlock, num_blocks_++);
buzbee862a7602013-04-05 10:58:54 -0700557 block_list_.Insert(entry_block_);
buzbee0d829482013-10-11 15:24:55 -0700558 exit_block_ = NewMemBB(kExitBlock, num_blocks_++);
buzbee862a7602013-04-05 10:58:54 -0700559 block_list_.Insert(exit_block_);
buzbee311ca162013-02-28 15:56:43 -0800560 // TODO: deprecate all "cu->" fields; move what's left to wherever CompilationUnit is allocated.
561 cu_->dex_file = &dex_file;
562 cu_->class_def_idx = class_def_idx;
563 cu_->method_idx = method_idx;
564 cu_->access_flags = access_flags;
565 cu_->invoke_type = invoke_type;
566 cu_->shorty = dex_file.GetMethodShorty(dex_file.GetMethodId(method_idx));
567 cu_->num_ins = current_code_item_->ins_size_;
568 cu_->num_regs = current_code_item_->registers_size_ - cu_->num_ins;
569 cu_->num_outs = current_code_item_->outs_size_;
570 cu_->num_dalvik_registers = current_code_item_->registers_size_;
571 cu_->insns = current_code_item_->insns_;
572 cu_->code_item = current_code_item_;
573 } else {
574 UNIMPLEMENTED(FATAL) << "Nested inlining not implemented.";
575 /*
576 * Will need to manage storage for ins & outs, push prevous state and update
577 * insert point.
578 */
579 }
580
581 /* Current block to record parsed instructions */
buzbee862a7602013-04-05 10:58:54 -0700582 BasicBlock *cur_block = NewMemBB(kDalvikByteCode, num_blocks_++);
buzbee0d829482013-10-11 15:24:55 -0700583 DCHECK_EQ(current_offset_, 0U);
buzbee311ca162013-02-28 15:56:43 -0800584 cur_block->start_offset = current_offset_;
buzbee862a7602013-04-05 10:58:54 -0700585 block_list_.Insert(cur_block);
buzbee0d829482013-10-11 15:24:55 -0700586 // TODO: for inlining support, insert at the insert point rather than entry block.
587 entry_block_->fall_through = cur_block->id;
588 cur_block->predecessors->Insert(entry_block_->id);
buzbee311ca162013-02-28 15:56:43 -0800589
590 /* Identify code range in try blocks and set up the empty catch blocks */
591 ProcessTryCatchBlocks();
592
buzbee311ca162013-02-28 15:56:43 -0800593 /* Parse all instructions and put them into containing basic blocks */
594 while (code_ptr < code_end) {
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -0700595 MIR *insn = static_cast<MIR *>(arena_->Alloc(sizeof(MIR), ArenaAllocator::kAllocMIR));
buzbee311ca162013-02-28 15:56:43 -0800596 insn->offset = current_offset_;
597 insn->m_unit_index = current_method_;
598 int width = ParseInsn(code_ptr, &insn->dalvikInsn);
599 insn->width = width;
600 Instruction::Code opcode = insn->dalvikInsn.opcode;
601 if (opcode_count_ != NULL) {
602 opcode_count_[static_cast<int>(opcode)]++;
603 }
604
buzbee311ca162013-02-28 15:56:43 -0800605 int flags = Instruction::FlagsOf(insn->dalvikInsn.opcode);
606
buzbee1da1e2f2013-11-15 13:37:01 -0800607 uint64_t df_flags = oat_data_flow_attributes_[insn->dalvikInsn.opcode];
buzbee311ca162013-02-28 15:56:43 -0800608
609 if (df_flags & DF_HAS_DEFS) {
610 def_count_ += (df_flags & DF_A_WIDE) ? 2 : 1;
611 }
612
buzbee1da1e2f2013-11-15 13:37:01 -0800613 if (df_flags & DF_LVN) {
614 cur_block->use_lvn = true; // Run local value numbering on this basic block.
615 }
616
buzbee27247762013-07-28 12:03:58 -0700617 // Check for inline data block signatures
618 if (opcode == Instruction::NOP) {
619 // A simple NOP will have a width of 1 at this point, embedded data NOP > 1.
620 if ((width == 1) && ((current_offset_ & 0x1) == 0x1) && ((code_end - code_ptr) > 1)) {
621 // Could be an aligning nop. If an embedded data NOP follows, treat pair as single unit.
622 uint16_t following_raw_instruction = code_ptr[1];
623 if ((following_raw_instruction == Instruction::kSparseSwitchSignature) ||
624 (following_raw_instruction == Instruction::kPackedSwitchSignature) ||
625 (following_raw_instruction == Instruction::kArrayDataSignature)) {
626 width += Instruction::At(code_ptr + 1)->SizeInCodeUnits();
627 }
628 }
629 if (width == 1) {
630 // It is a simple nop - treat normally.
631 AppendMIR(cur_block, insn);
632 } else {
buzbee0d829482013-10-11 15:24:55 -0700633 DCHECK(cur_block->fall_through == NullBasicBlockId);
634 DCHECK(cur_block->taken == NullBasicBlockId);
buzbee27247762013-07-28 12:03:58 -0700635 // Unreachable instruction, mark for no continuation.
636 flags &= ~Instruction::kContinue;
637 }
638 } else {
639 AppendMIR(cur_block, insn);
640 }
641
buzbeeb48819d2013-09-14 16:15:25 -0700642 // Associate the starting dex_pc for this opcode with its containing basic block.
643 dex_pc_to_block_map_.Put(insn->offset, cur_block->id);
644
buzbee27247762013-07-28 12:03:58 -0700645 code_ptr += width;
646
buzbee311ca162013-02-28 15:56:43 -0800647 if (flags & Instruction::kBranch) {
648 cur_block = ProcessCanBranch(cur_block, insn, current_offset_,
649 width, flags, code_ptr, code_end);
650 } else if (flags & Instruction::kReturn) {
651 cur_block->terminated_by_return = true;
buzbee0d829482013-10-11 15:24:55 -0700652 cur_block->fall_through = exit_block_->id;
653 exit_block_->predecessors->Insert(cur_block->id);
buzbee311ca162013-02-28 15:56:43 -0800654 /*
655 * Terminate the current block if there are instructions
656 * afterwards.
657 */
658 if (code_ptr < code_end) {
659 /*
660 * Create a fallthrough block for real instructions
661 * (incl. NOP).
662 */
buzbee27247762013-07-28 12:03:58 -0700663 FindBlock(current_offset_ + width, /* split */ false, /* create */ true,
664 /* immed_pred_block_p */ NULL);
buzbee311ca162013-02-28 15:56:43 -0800665 }
666 } else if (flags & Instruction::kThrow) {
667 cur_block = ProcessCanThrow(cur_block, insn, current_offset_, width, flags, try_block_addr_,
668 code_ptr, code_end);
669 } else if (flags & Instruction::kSwitch) {
buzbee17189ac2013-11-08 11:07:02 -0800670 cur_block = ProcessCanSwitch(cur_block, insn, current_offset_, width, flags);
buzbee311ca162013-02-28 15:56:43 -0800671 }
672 current_offset_ += width;
673 BasicBlock *next_block = FindBlock(current_offset_, /* split */ false, /* create */
674 false, /* immed_pred_block_p */ NULL);
675 if (next_block) {
676 /*
677 * The next instruction could be the target of a previously parsed
678 * forward branch so a block is already created. If the current
679 * instruction is not an unconditional branch, connect them through
680 * the fall-through link.
681 */
buzbee0d829482013-10-11 15:24:55 -0700682 DCHECK(cur_block->fall_through == NullBasicBlockId ||
683 GetBasicBlock(cur_block->fall_through) == next_block ||
684 GetBasicBlock(cur_block->fall_through) == exit_block_);
buzbee311ca162013-02-28 15:56:43 -0800685
buzbee0d829482013-10-11 15:24:55 -0700686 if ((cur_block->fall_through == NullBasicBlockId) && (flags & Instruction::kContinue)) {
687 cur_block->fall_through = next_block->id;
688 next_block->predecessors->Insert(cur_block->id);
buzbee311ca162013-02-28 15:56:43 -0800689 }
690 cur_block = next_block;
691 }
692 }
Vladimir Marko5816ed42013-11-27 17:04:20 +0000693
buzbee311ca162013-02-28 15:56:43 -0800694 if (cu_->enable_debug & (1 << kDebugDumpCFG)) {
695 DumpCFG("/sdcard/1_post_parse_cfg/", true);
696 }
697
698 if (cu_->verbose) {
buzbee1fd33462013-03-25 13:40:45 -0700699 DumpMIRGraph();
buzbee311ca162013-02-28 15:56:43 -0800700 }
701}
702
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700703void MIRGraph::ShowOpcodeStats() {
buzbee311ca162013-02-28 15:56:43 -0800704 DCHECK(opcode_count_ != NULL);
705 LOG(INFO) << "Opcode Count";
706 for (int i = 0; i < kNumPackedOpcodes; i++) {
707 if (opcode_count_[i] != 0) {
708 LOG(INFO) << "-C- " << Instruction::Name(static_cast<Instruction::Code>(i))
709 << " " << opcode_count_[i];
710 }
711 }
712}
713
714// TODO: use a configurable base prefix, and adjust callers to supply pass name.
715/* Dump the CFG into a DOT graph */
Jean Christophe Beylerd0a51552014-01-10 14:18:31 -0800716void MIRGraph::DumpCFG(const char* dir_prefix, bool all_blocks, const char *suffix) {
buzbee311ca162013-02-28 15:56:43 -0800717 FILE* file;
718 std::string fname(PrettyMethod(cu_->method_idx, *cu_->dex_file));
719 ReplaceSpecialChars(fname);
Jean Christophe Beylerd0a51552014-01-10 14:18:31 -0800720 fname = StringPrintf("%s%s%x%s.dot", dir_prefix, fname.c_str(),
721 GetBasicBlock(GetEntryBlock()->fall_through)->start_offset,
722 suffix == nullptr ? "" : suffix);
buzbee311ca162013-02-28 15:56:43 -0800723 file = fopen(fname.c_str(), "w");
724 if (file == NULL) {
725 return;
726 }
727 fprintf(file, "digraph G {\n");
728
729 fprintf(file, " rankdir=TB\n");
730
731 int num_blocks = all_blocks ? GetNumBlocks() : num_reachable_blocks_;
732 int idx;
733
734 for (idx = 0; idx < num_blocks; idx++) {
buzbee862a7602013-04-05 10:58:54 -0700735 int block_idx = all_blocks ? idx : dfs_order_->Get(idx);
buzbee311ca162013-02-28 15:56:43 -0800736 BasicBlock *bb = GetBasicBlock(block_idx);
737 if (bb == NULL) break;
738 if (bb->block_type == kDead) continue;
739 if (bb->block_type == kEntryBlock) {
740 fprintf(file, " entry_%d [shape=Mdiamond];\n", bb->id);
741 } else if (bb->block_type == kExitBlock) {
742 fprintf(file, " exit_%d [shape=Mdiamond];\n", bb->id);
743 } else if (bb->block_type == kDalvikByteCode) {
744 fprintf(file, " block%04x_%d [shape=record,label = \"{ \\\n",
745 bb->start_offset, bb->id);
746 const MIR *mir;
747 fprintf(file, " {block id %d\\l}%s\\\n", bb->id,
748 bb->first_mir_insn ? " | " : " ");
749 for (mir = bb->first_mir_insn; mir; mir = mir->next) {
750 int opcode = mir->dalvikInsn.opcode;
751 fprintf(file, " {%04x %s %s %s\\l}%s\\\n", mir->offset,
buzbee1fd33462013-03-25 13:40:45 -0700752 mir->ssa_rep ? GetDalvikDisassembly(mir) :
buzbee311ca162013-02-28 15:56:43 -0800753 (opcode < kMirOpFirst) ? Instruction::Name(mir->dalvikInsn.opcode) :
buzbee1fd33462013-03-25 13:40:45 -0700754 extended_mir_op_names_[opcode - kMirOpFirst],
buzbee311ca162013-02-28 15:56:43 -0800755 (mir->optimization_flags & MIR_IGNORE_RANGE_CHECK) != 0 ? " no_rangecheck" : " ",
756 (mir->optimization_flags & MIR_IGNORE_NULL_CHECK) != 0 ? " no_nullcheck" : " ",
757 mir->next ? " | " : " ");
758 }
759 fprintf(file, " }\"];\n\n");
760 } else if (bb->block_type == kExceptionHandling) {
761 char block_name[BLOCK_NAME_LEN];
762
763 GetBlockName(bb, block_name);
764 fprintf(file, " %s [shape=invhouse];\n", block_name);
765 }
766
767 char block_name1[BLOCK_NAME_LEN], block_name2[BLOCK_NAME_LEN];
768
buzbee0d829482013-10-11 15:24:55 -0700769 if (bb->taken != NullBasicBlockId) {
buzbee311ca162013-02-28 15:56:43 -0800770 GetBlockName(bb, block_name1);
buzbee0d829482013-10-11 15:24:55 -0700771 GetBlockName(GetBasicBlock(bb->taken), block_name2);
buzbee311ca162013-02-28 15:56:43 -0800772 fprintf(file, " %s:s -> %s:n [style=dotted]\n",
773 block_name1, block_name2);
774 }
buzbee0d829482013-10-11 15:24:55 -0700775 if (bb->fall_through != NullBasicBlockId) {
buzbee311ca162013-02-28 15:56:43 -0800776 GetBlockName(bb, block_name1);
buzbee0d829482013-10-11 15:24:55 -0700777 GetBlockName(GetBasicBlock(bb->fall_through), block_name2);
buzbee311ca162013-02-28 15:56:43 -0800778 fprintf(file, " %s:s -> %s:n\n", block_name1, block_name2);
779 }
780
buzbee0d829482013-10-11 15:24:55 -0700781 if (bb->successor_block_list_type != kNotUsed) {
buzbee311ca162013-02-28 15:56:43 -0800782 fprintf(file, " succ%04x_%d [shape=%s,label = \"{ \\\n",
783 bb->start_offset, bb->id,
buzbee0d829482013-10-11 15:24:55 -0700784 (bb->successor_block_list_type == kCatch) ? "Mrecord" : "record");
785 GrowableArray<SuccessorBlockInfo*>::Iterator iterator(bb->successor_blocks);
buzbee862a7602013-04-05 10:58:54 -0700786 SuccessorBlockInfo *successor_block_info = iterator.Next();
buzbee311ca162013-02-28 15:56:43 -0800787
788 int succ_id = 0;
789 while (true) {
790 if (successor_block_info == NULL) break;
791
buzbee0d829482013-10-11 15:24:55 -0700792 BasicBlock *dest_block = GetBasicBlock(successor_block_info->block);
buzbee862a7602013-04-05 10:58:54 -0700793 SuccessorBlockInfo *next_successor_block_info = iterator.Next();
buzbee311ca162013-02-28 15:56:43 -0800794
795 fprintf(file, " {<f%d> %04x: %04x\\l}%s\\\n",
796 succ_id++,
797 successor_block_info->key,
798 dest_block->start_offset,
799 (next_successor_block_info != NULL) ? " | " : " ");
800
801 successor_block_info = next_successor_block_info;
802 }
803 fprintf(file, " }\"];\n\n");
804
805 GetBlockName(bb, block_name1);
806 fprintf(file, " %s:s -> succ%04x_%d:n [style=dashed]\n",
807 block_name1, bb->start_offset, bb->id);
808
buzbee0d829482013-10-11 15:24:55 -0700809 if (bb->successor_block_list_type == kPackedSwitch ||
810 bb->successor_block_list_type == kSparseSwitch) {
811 GrowableArray<SuccessorBlockInfo*>::Iterator iter(bb->successor_blocks);
buzbee311ca162013-02-28 15:56:43 -0800812
813 succ_id = 0;
814 while (true) {
buzbee862a7602013-04-05 10:58:54 -0700815 SuccessorBlockInfo *successor_block_info = iter.Next();
buzbee311ca162013-02-28 15:56:43 -0800816 if (successor_block_info == NULL) break;
817
buzbee0d829482013-10-11 15:24:55 -0700818 BasicBlock* dest_block = GetBasicBlock(successor_block_info->block);
buzbee311ca162013-02-28 15:56:43 -0800819
820 GetBlockName(dest_block, block_name2);
821 fprintf(file, " succ%04x_%d:f%d:e -> %s:n\n", bb->start_offset,
822 bb->id, succ_id++, block_name2);
823 }
824 }
825 }
826 fprintf(file, "\n");
827
828 if (cu_->verbose) {
829 /* Display the dominator tree */
830 GetBlockName(bb, block_name1);
831 fprintf(file, " cfg%s [label=\"%s\", shape=none];\n",
832 block_name1, block_name1);
833 if (bb->i_dom) {
buzbee0d829482013-10-11 15:24:55 -0700834 GetBlockName(GetBasicBlock(bb->i_dom), block_name2);
buzbee311ca162013-02-28 15:56:43 -0800835 fprintf(file, " cfg%s:s -> cfg%s:n\n\n", block_name2, block_name1);
836 }
837 }
838 }
839 fprintf(file, "}\n");
840 fclose(file);
841}
842
buzbee1fd33462013-03-25 13:40:45 -0700843/* Insert an MIR instruction to the end of a basic block */
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700844void MIRGraph::AppendMIR(BasicBlock* bb, MIR* mir) {
buzbee1fd33462013-03-25 13:40:45 -0700845 if (bb->first_mir_insn == NULL) {
846 DCHECK(bb->last_mir_insn == NULL);
847 bb->last_mir_insn = bb->first_mir_insn = mir;
buzbee0d829482013-10-11 15:24:55 -0700848 mir->next = NULL;
buzbee1fd33462013-03-25 13:40:45 -0700849 } else {
850 bb->last_mir_insn->next = mir;
buzbee1fd33462013-03-25 13:40:45 -0700851 mir->next = NULL;
852 bb->last_mir_insn = mir;
853 }
854}
855
856/* Insert an MIR instruction to the head of a basic block */
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700857void MIRGraph::PrependMIR(BasicBlock* bb, MIR* mir) {
buzbee1fd33462013-03-25 13:40:45 -0700858 if (bb->first_mir_insn == NULL) {
859 DCHECK(bb->last_mir_insn == NULL);
860 bb->last_mir_insn = bb->first_mir_insn = mir;
buzbee0d829482013-10-11 15:24:55 -0700861 mir->next = NULL;
buzbee1fd33462013-03-25 13:40:45 -0700862 } else {
buzbee1fd33462013-03-25 13:40:45 -0700863 mir->next = bb->first_mir_insn;
buzbee1fd33462013-03-25 13:40:45 -0700864 bb->first_mir_insn = mir;
865 }
866}
867
868/* Insert a MIR instruction after the specified MIR */
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700869void MIRGraph::InsertMIRAfter(BasicBlock* bb, MIR* current_mir, MIR* new_mir) {
buzbee1fd33462013-03-25 13:40:45 -0700870 new_mir->next = current_mir->next;
871 current_mir->next = new_mir;
872
buzbee0d829482013-10-11 15:24:55 -0700873 if (bb->last_mir_insn == current_mir) {
buzbee1fd33462013-03-25 13:40:45 -0700874 /* Is the last MIR in the block */
875 bb->last_mir_insn = new_mir;
876 }
877}
878
Brian Carlstrom2ce745c2013-07-17 17:44:30 -0700879char* MIRGraph::GetDalvikDisassembly(const MIR* mir) {
buzbee1fd33462013-03-25 13:40:45 -0700880 DecodedInstruction insn = mir->dalvikInsn;
881 std::string str;
882 int flags = 0;
883 int opcode = insn.opcode;
884 char* ret;
885 bool nop = false;
886 SSARepresentation* ssa_rep = mir->ssa_rep;
887 Instruction::Format dalvik_format = Instruction::k10x; // Default to no-operand format
888 int defs = (ssa_rep != NULL) ? ssa_rep->num_defs : 0;
889 int uses = (ssa_rep != NULL) ? ssa_rep->num_uses : 0;
890
891 // Handle special cases.
892 if ((opcode == kMirOpCheck) || (opcode == kMirOpCheckPart2)) {
893 str.append(extended_mir_op_names_[opcode - kMirOpFirst]);
894 str.append(": ");
895 // Recover the original Dex instruction
896 insn = mir->meta.throw_insn->dalvikInsn;
897 ssa_rep = mir->meta.throw_insn->ssa_rep;
898 defs = ssa_rep->num_defs;
899 uses = ssa_rep->num_uses;
900 opcode = insn.opcode;
901 } else if (opcode == kMirOpNop) {
902 str.append("[");
buzbee0d829482013-10-11 15:24:55 -0700903 // Recover original opcode.
904 insn.opcode = Instruction::At(current_code_item_->insns_ + mir->offset)->Opcode();
905 opcode = insn.opcode;
buzbee1fd33462013-03-25 13:40:45 -0700906 nop = true;
907 }
908
909 if (opcode >= kMirOpFirst) {
910 str.append(extended_mir_op_names_[opcode - kMirOpFirst]);
911 } else {
912 dalvik_format = Instruction::FormatOf(insn.opcode);
913 flags = Instruction::FlagsOf(insn.opcode);
914 str.append(Instruction::Name(insn.opcode));
915 }
916
917 if (opcode == kMirOpPhi) {
buzbee0d829482013-10-11 15:24:55 -0700918 BasicBlockId* incoming = mir->meta.phi_incoming;
buzbee1fd33462013-03-25 13:40:45 -0700919 str.append(StringPrintf(" %s = (%s",
920 GetSSANameWithConst(ssa_rep->defs[0], true).c_str(),
921 GetSSANameWithConst(ssa_rep->uses[0], true).c_str()));
Brian Carlstromb1eba212013-07-17 18:07:19 -0700922 str.append(StringPrintf(":%d", incoming[0]));
buzbee1fd33462013-03-25 13:40:45 -0700923 int i;
924 for (i = 1; i < uses; i++) {
925 str.append(StringPrintf(", %s:%d",
926 GetSSANameWithConst(ssa_rep->uses[i], true).c_str(),
927 incoming[i]));
928 }
929 str.append(")");
930 } else if ((flags & Instruction::kBranch) != 0) {
931 // For branches, decode the instructions to print out the branch targets.
932 int offset = 0;
933 switch (dalvik_format) {
934 case Instruction::k21t:
935 str.append(StringPrintf(" %s,", GetSSANameWithConst(ssa_rep->uses[0], false).c_str()));
936 offset = insn.vB;
937 break;
938 case Instruction::k22t:
939 str.append(StringPrintf(" %s, %s,", GetSSANameWithConst(ssa_rep->uses[0], false).c_str(),
940 GetSSANameWithConst(ssa_rep->uses[1], false).c_str()));
941 offset = insn.vC;
942 break;
943 case Instruction::k10t:
944 case Instruction::k20t:
945 case Instruction::k30t:
946 offset = insn.vA;
947 break;
948 default:
949 LOG(FATAL) << "Unexpected branch format " << dalvik_format << " from " << insn.opcode;
950 }
951 str.append(StringPrintf(" 0x%x (%c%x)", mir->offset + offset,
952 offset > 0 ? '+' : '-', offset > 0 ? offset : -offset));
953 } else {
954 // For invokes-style formats, treat wide regs as a pair of singles
955 bool show_singles = ((dalvik_format == Instruction::k35c) ||
956 (dalvik_format == Instruction::k3rc));
957 if (defs != 0) {
958 str.append(StringPrintf(" %s", GetSSANameWithConst(ssa_rep->defs[0], false).c_str()));
959 if (uses != 0) {
960 str.append(", ");
961 }
962 }
963 for (int i = 0; i < uses; i++) {
964 str.append(
965 StringPrintf(" %s", GetSSANameWithConst(ssa_rep->uses[i], show_singles).c_str()));
966 if (!show_singles && (reg_location_ != NULL) && reg_location_[i].wide) {
967 // For the listing, skip the high sreg.
968 i++;
969 }
970 if (i != (uses -1)) {
971 str.append(",");
972 }
973 }
974 switch (dalvik_format) {
Brian Carlstrom7934ac22013-07-26 10:54:15 -0700975 case Instruction::k11n: // Add one immediate from vB
buzbee1fd33462013-03-25 13:40:45 -0700976 case Instruction::k21s:
977 case Instruction::k31i:
978 case Instruction::k21h:
979 str.append(StringPrintf(", #%d", insn.vB));
980 break;
Brian Carlstrom7934ac22013-07-26 10:54:15 -0700981 case Instruction::k51l: // Add one wide immediate
Ian Rogers23b03b52014-01-24 11:10:03 -0800982 str.append(StringPrintf(", #%" PRId64, insn.vB_wide));
buzbee1fd33462013-03-25 13:40:45 -0700983 break;
Brian Carlstrom7934ac22013-07-26 10:54:15 -0700984 case Instruction::k21c: // One register, one string/type/method index
buzbee1fd33462013-03-25 13:40:45 -0700985 case Instruction::k31c:
986 str.append(StringPrintf(", index #%d", insn.vB));
987 break;
Brian Carlstrom7934ac22013-07-26 10:54:15 -0700988 case Instruction::k22c: // Two registers, one string/type/method index
buzbee1fd33462013-03-25 13:40:45 -0700989 str.append(StringPrintf(", index #%d", insn.vC));
990 break;
Brian Carlstrom7934ac22013-07-26 10:54:15 -0700991 case Instruction::k22s: // Add one immediate from vC
buzbee1fd33462013-03-25 13:40:45 -0700992 case Instruction::k22b:
993 str.append(StringPrintf(", #%d", insn.vC));
994 break;
Brian Carlstrom02c8cc62013-07-18 15:54:44 -0700995 default: {
996 // Nothing left to print
buzbee1fd33462013-03-25 13:40:45 -0700997 }
Brian Carlstrom02c8cc62013-07-18 15:54:44 -0700998 }
buzbee1fd33462013-03-25 13:40:45 -0700999 }
1000 if (nop) {
1001 str.append("]--optimized away");
1002 }
1003 int length = str.length() + 1;
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -07001004 ret = static_cast<char*>(arena_->Alloc(length, ArenaAllocator::kAllocDFInfo));
buzbee1fd33462013-03-25 13:40:45 -07001005 strncpy(ret, str.c_str(), length);
1006 return ret;
1007}
1008
1009/* Turn method name into a legal Linux file name */
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001010void MIRGraph::ReplaceSpecialChars(std::string& str) {
Brian Carlstrom9b7085a2013-07-18 15:15:21 -07001011 static const struct { const char before; const char after; } match[] = {
1012 {'/', '-'}, {';', '#'}, {' ', '#'}, {'$', '+'},
1013 {'(', '@'}, {')', '@'}, {'<', '='}, {'>', '='}
1014 };
buzbee1fd33462013-03-25 13:40:45 -07001015 for (unsigned int i = 0; i < sizeof(match)/sizeof(match[0]); i++) {
1016 std::replace(str.begin(), str.end(), match[i].before, match[i].after);
1017 }
1018}
1019
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001020std::string MIRGraph::GetSSAName(int ssa_reg) {
Ian Rogers39ebcb82013-05-30 16:57:23 -07001021 // TODO: This value is needed for LLVM and debugging. Currently, we compute this and then copy to
1022 // the arena. We should be smarter and just place straight into the arena, or compute the
1023 // value more lazily.
buzbee1fd33462013-03-25 13:40:45 -07001024 return StringPrintf("v%d_%d", SRegToVReg(ssa_reg), GetSSASubscript(ssa_reg));
1025}
1026
1027// Similar to GetSSAName, but if ssa name represents an immediate show that as well.
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001028std::string MIRGraph::GetSSANameWithConst(int ssa_reg, bool singles_only) {
buzbee1fd33462013-03-25 13:40:45 -07001029 if (reg_location_ == NULL) {
1030 // Pre-SSA - just use the standard name
1031 return GetSSAName(ssa_reg);
1032 }
1033 if (IsConst(reg_location_[ssa_reg])) {
1034 if (!singles_only && reg_location_[ssa_reg].wide) {
Ian Rogers23b03b52014-01-24 11:10:03 -08001035 return StringPrintf("v%d_%d#0x%" PRIx64, SRegToVReg(ssa_reg), GetSSASubscript(ssa_reg),
buzbee1fd33462013-03-25 13:40:45 -07001036 ConstantValueWide(reg_location_[ssa_reg]));
1037 } else {
Brian Carlstromb1eba212013-07-17 18:07:19 -07001038 return StringPrintf("v%d_%d#0x%x", SRegToVReg(ssa_reg), GetSSASubscript(ssa_reg),
buzbee1fd33462013-03-25 13:40:45 -07001039 ConstantValue(reg_location_[ssa_reg]));
1040 }
1041 } else {
1042 return StringPrintf("v%d_%d", SRegToVReg(ssa_reg), GetSSASubscript(ssa_reg));
1043 }
1044}
1045
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001046void MIRGraph::GetBlockName(BasicBlock* bb, char* name) {
buzbee1fd33462013-03-25 13:40:45 -07001047 switch (bb->block_type) {
1048 case kEntryBlock:
1049 snprintf(name, BLOCK_NAME_LEN, "entry_%d", bb->id);
1050 break;
1051 case kExitBlock:
1052 snprintf(name, BLOCK_NAME_LEN, "exit_%d", bb->id);
1053 break;
1054 case kDalvikByteCode:
1055 snprintf(name, BLOCK_NAME_LEN, "block%04x_%d", bb->start_offset, bb->id);
1056 break;
1057 case kExceptionHandling:
1058 snprintf(name, BLOCK_NAME_LEN, "exception%04x_%d", bb->start_offset,
1059 bb->id);
1060 break;
1061 default:
1062 snprintf(name, BLOCK_NAME_LEN, "_%d", bb->id);
1063 break;
1064 }
1065}
1066
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001067const char* MIRGraph::GetShortyFromTargetIdx(int target_idx) {
buzbee0d829482013-10-11 15:24:55 -07001068 // TODO: for inlining support, use current code unit.
buzbee1fd33462013-03-25 13:40:45 -07001069 const DexFile::MethodId& method_id = cu_->dex_file->GetMethodId(target_idx);
1070 return cu_->dex_file->GetShorty(method_id.proto_idx_);
1071}
1072
1073/* Debug Utility - dump a compilation unit */
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001074void MIRGraph::DumpMIRGraph() {
buzbee1fd33462013-03-25 13:40:45 -07001075 BasicBlock* bb;
1076 const char* block_type_names[] = {
buzbee17189ac2013-11-08 11:07:02 -08001077 "Null Block",
buzbee1fd33462013-03-25 13:40:45 -07001078 "Entry Block",
1079 "Code Block",
1080 "Exit Block",
1081 "Exception Handling",
1082 "Catch Block"
1083 };
1084
1085 LOG(INFO) << "Compiling " << PrettyMethod(cu_->method_idx, *cu_->dex_file);
1086 LOG(INFO) << cu_->insns << " insns";
1087 LOG(INFO) << GetNumBlocks() << " blocks in total";
buzbee862a7602013-04-05 10:58:54 -07001088 GrowableArray<BasicBlock*>::Iterator iterator(&block_list_);
buzbee1fd33462013-03-25 13:40:45 -07001089
1090 while (true) {
buzbee862a7602013-04-05 10:58:54 -07001091 bb = iterator.Next();
buzbee1fd33462013-03-25 13:40:45 -07001092 if (bb == NULL) break;
1093 LOG(INFO) << StringPrintf("Block %d (%s) (insn %04x - %04x%s)",
1094 bb->id,
1095 block_type_names[bb->block_type],
1096 bb->start_offset,
1097 bb->last_mir_insn ? bb->last_mir_insn->offset : bb->start_offset,
1098 bb->last_mir_insn ? "" : " empty");
buzbee0d829482013-10-11 15:24:55 -07001099 if (bb->taken != NullBasicBlockId) {
1100 LOG(INFO) << " Taken branch: block " << bb->taken
1101 << "(0x" << std::hex << GetBasicBlock(bb->taken)->start_offset << ")";
buzbee1fd33462013-03-25 13:40:45 -07001102 }
buzbee0d829482013-10-11 15:24:55 -07001103 if (bb->fall_through != NullBasicBlockId) {
1104 LOG(INFO) << " Fallthrough : block " << bb->fall_through
1105 << " (0x" << std::hex << GetBasicBlock(bb->fall_through)->start_offset << ")";
buzbee1fd33462013-03-25 13:40:45 -07001106 }
1107 }
1108}
1109
1110/*
1111 * Build an array of location records for the incoming arguments.
1112 * Note: one location record per word of arguments, with dummy
1113 * high-word loc for wide arguments. Also pull up any following
1114 * MOVE_RESULT and incorporate it into the invoke.
1115 */
1116CallInfo* MIRGraph::NewMemCallInfo(BasicBlock* bb, MIR* mir, InvokeType type,
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001117 bool is_range) {
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -07001118 CallInfo* info = static_cast<CallInfo*>(arena_->Alloc(sizeof(CallInfo),
1119 ArenaAllocator::kAllocMisc));
buzbee1fd33462013-03-25 13:40:45 -07001120 MIR* move_result_mir = FindMoveResult(bb, mir);
1121 if (move_result_mir == NULL) {
1122 info->result.location = kLocInvalid;
1123 } else {
1124 info->result = GetRawDest(move_result_mir);
buzbee1fd33462013-03-25 13:40:45 -07001125 move_result_mir->dalvikInsn.opcode = static_cast<Instruction::Code>(kMirOpNop);
1126 }
1127 info->num_arg_words = mir->ssa_rep->num_uses;
1128 info->args = (info->num_arg_words == 0) ? NULL : static_cast<RegLocation*>
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -07001129 (arena_->Alloc(sizeof(RegLocation) * info->num_arg_words, ArenaAllocator::kAllocMisc));
buzbee1fd33462013-03-25 13:40:45 -07001130 for (int i = 0; i < info->num_arg_words; i++) {
1131 info->args[i] = GetRawSrc(mir, i);
1132 }
1133 info->opt_flags = mir->optimization_flags;
1134 info->type = type;
1135 info->is_range = is_range;
1136 info->index = mir->dalvikInsn.vB;
1137 info->offset = mir->offset;
1138 return info;
1139}
1140
buzbee862a7602013-04-05 10:58:54 -07001141// Allocate a new basic block.
Brian Carlstrom2ce745c2013-07-17 17:44:30 -07001142BasicBlock* MIRGraph::NewMemBB(BBType block_type, int block_id) {
Mathieu Chartierf6c4b3b2013-08-24 16:11:37 -07001143 BasicBlock* bb = static_cast<BasicBlock*>(arena_->Alloc(sizeof(BasicBlock),
1144 ArenaAllocator::kAllocBB));
buzbee862a7602013-04-05 10:58:54 -07001145 bb->block_type = block_type;
1146 bb->id = block_id;
1147 // TUNING: better estimate of the exit block predecessors?
buzbee0d829482013-10-11 15:24:55 -07001148 bb->predecessors = new (arena_) GrowableArray<BasicBlockId>(arena_,
Brian Carlstromdf629502013-07-17 22:39:56 -07001149 (block_type == kExitBlock) ? 2048 : 2,
1150 kGrowableArrayPredecessors);
buzbee0d829482013-10-11 15:24:55 -07001151 bb->successor_block_list_type = kNotUsed;
buzbee862a7602013-04-05 10:58:54 -07001152 block_id_map_.Put(block_id, block_id);
1153 return bb;
1154}
buzbee1fd33462013-03-25 13:40:45 -07001155
Jean Christophe Beyler4e97c532014-01-07 10:07:18 -08001156void MIRGraph::InitializeConstantPropagation() {
1157 is_constant_v_ = new (arena_) ArenaBitVector(arena_, GetNumSSARegs(), false);
1158 constant_values_ = static_cast<int*>(arena_->Alloc(sizeof(int) * GetNumSSARegs(), ArenaAllocator::kAllocDFInfo));
1159}
1160
1161void MIRGraph::InitializeMethodUses() {
1162 // The gate starts by initializing the use counts
1163 int num_ssa_regs = GetNumSSARegs();
1164 use_counts_.Resize(num_ssa_regs + 32);
1165 raw_use_counts_.Resize(num_ssa_regs + 32);
1166 // Initialize list
1167 for (int i = 0; i < num_ssa_regs; i++) {
1168 use_counts_.Insert(0);
1169 raw_use_counts_.Insert(0);
1170 }
1171}
1172
1173void MIRGraph::InitializeSSATransformation() {
1174 /* Compute the DFS order */
1175 ComputeDFSOrders();
1176
1177 /* Compute the dominator info */
1178 ComputeDominators();
1179
1180 /* Allocate data structures in preparation for SSA conversion */
1181 CompilerInitializeSSAConversion();
1182
1183 /* Find out the "Dalvik reg def x block" relation */
1184 ComputeDefBlockMatrix();
1185
1186 /* Insert phi nodes to dominance frontiers for all variables */
1187 InsertPhiNodes();
1188
1189 /* Rename register names by local defs and phi nodes */
1190 ClearAllVisitedFlags();
1191 DoDFSPreOrderSSARename(GetEntryBlock());
1192
1193 /*
1194 * Shared temp bit vector used by each block to count the number of defs
1195 * from all the predecessor blocks.
1196 */
1197 temp_ssa_register_v_ =
1198 new (arena_) ArenaBitVector(arena_, GetNumSSARegs(), false, kBitMapTempSSARegisterV);
1199}
1200
1201void MIRGraph::CheckSSARegisterVector() {
1202 DCHECK(temp_ssa_register_v_ != nullptr);
1203}
1204
Brian Carlstrom7934ac22013-07-26 10:54:15 -07001205} // namespace art