1 /*
2 * Copyright (c) 2015, 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23 package org.graalvm.compiler.lir.alloc.trace;
24
25 import static jdk.vm.ci.code.ValueUtil.asRegisterValue;
26 import static jdk.vm.ci.code.ValueUtil.isIllegal;
27 import static jdk.vm.ci.code.ValueUtil.isRegister;
28 import static org.graalvm.compiler.lir.LIRValueUtil.isConstantValue;
29 import static org.graalvm.compiler.lir.LIRValueUtil.isStackSlotValue;
30 import static org.graalvm.compiler.lir.alloc.trace.TraceUtil.asShadowedRegisterValue;
31 import static org.graalvm.compiler.lir.alloc.trace.TraceUtil.isShadowedRegisterValue;
32
33 import java.util.ArrayList;
34 import java.util.Arrays;
35
36 import org.graalvm.compiler.core.common.alloc.RegisterAllocationConfig;
37 import org.graalvm.compiler.core.common.alloc.Trace;
38 import org.graalvm.compiler.core.common.alloc.TraceBuilderResult;
39 import org.graalvm.compiler.core.common.cfg.AbstractBlockBase;
40 import org.graalvm.compiler.debug.DebugContext;
41 import org.graalvm.compiler.debug.Indent;
42 import org.graalvm.compiler.lir.LIR;
43 import org.graalvm.compiler.lir.LIRInstruction;
44 import org.graalvm.compiler.lir.StandardOp.JumpOp;
45 import org.graalvm.compiler.lir.StandardOp.LabelOp;
46 import org.graalvm.compiler.lir.alloc.trace.TraceAllocationPhase.TraceAllocationContext;
47 import org.graalvm.compiler.lir.gen.LIRGenerationResult;
48 import org.graalvm.compiler.lir.gen.LIRGeneratorTool.MoveFactory;
49 import org.graalvm.compiler.lir.ssa.SSAUtil;
50
51 import jdk.vm.ci.code.Architecture;
52 import jdk.vm.ci.code.RegisterValue;
53 import jdk.vm.ci.code.TargetDescription;
54 import jdk.vm.ci.meta.AllocatableValue;
55 import jdk.vm.ci.meta.Value;
56
57 public final class TraceGlobalMoveResolutionPhase {
58
59 private TraceGlobalMoveResolutionPhase() {
60 }
61
62 /**
63 * Abstract move resolver interface for testing.
64 */
65 public abstract static class MoveResolver {
66 public abstract void addMapping(Value src, AllocatableValue dst, Value fromStack);
67 }
68
69 public static void resolve(TargetDescription target, LIRGenerationResult lirGenRes, TraceAllocationContext context) {
70 LIR lir = lirGenRes.getLIR();
71 DebugContext debug = lir.getDebug();
72 debug.dump(DebugContext.VERBOSE_LEVEL, lir, "Before TraceGlobalMoveResultion");
73 MoveFactory spillMoveFactory = context.spillMoveFactory;
74 resolveGlobalDataFlow(context.resultTraces, lirGenRes, spillMoveFactory, target.arch, context.livenessInfo, context.registerAllocationConfig);
75 }
76
77 @SuppressWarnings("try")
78 private static void resolveGlobalDataFlow(TraceBuilderResult resultTraces, LIRGenerationResult lirGenRes, MoveFactory spillMoveFactory, Architecture arch, GlobalLivenessInfo livenessInfo,
79 RegisterAllocationConfig registerAllocationConfig) {
80 LIR lir = lirGenRes.getLIR();
81 /* Resolve trace global data-flow mismatch. */
82 TraceGlobalMoveResolver moveResolver = new TraceGlobalMoveResolver(lirGenRes, spillMoveFactory, registerAllocationConfig, arch);
83
84 DebugContext debug = lir.getDebug();
85 try (Indent indent = debug.logAndIndent("Trace global move resolution")) {
86 for (Trace trace : resultTraces.getTraces()) {
87 for (AbstractBlockBase<?> fromBlock : trace.getBlocks()) {
88 for (AbstractBlockBase<?> toBlock : fromBlock.getSuccessors()) {
89 if (resultTraces.getTraceForBlock(fromBlock) != resultTraces.getTraceForBlock(toBlock)) {
90 try (Indent indent0 = debug.logAndIndent("Handle trace edge from %s (Trace%d) to %s (Trace%d)", fromBlock, resultTraces.getTraceForBlock(fromBlock).getId(), toBlock,
91 resultTraces.getTraceForBlock(toBlock).getId())) {
92
93 final ArrayList<LIRInstruction> instructions;
94 final int insertIdx;
95 if (fromBlock.getSuccessorCount() == 1) {
96 instructions = lir.getLIRforBlock(fromBlock);
97 insertIdx = instructions.size() - 1;
98 } else {
99 assert toBlock.getPredecessorCount() == 1;
100 instructions = lir.getLIRforBlock(toBlock);
101 insertIdx = 1;
102 }
103
104 moveResolver.setInsertPosition(instructions, insertIdx);
105 resolveEdge(lir, livenessInfo, moveResolver, fromBlock, toBlock);
106 moveResolver.resolveAndAppendMoves();
107 }
108 }
109 }
110 }
111 }
112 }
113 }
114
115 private static void resolveEdge(LIR lir, GlobalLivenessInfo livenessInfo, TraceGlobalMoveResolver moveResolver, AbstractBlockBase<?> fromBlock, AbstractBlockBase<?> toBlock) {
116 assert verifyEdge(fromBlock, toBlock);
117
118 if (SSAUtil.isMerge(toBlock)) {
119 // PHI
120 JumpOp blockEnd = SSAUtil.phiOut(lir, fromBlock);
121 LabelOp label = SSAUtil.phiIn(lir, toBlock);
122
123 for (int i = 0; i < label.getPhiSize(); i++) {
124 Value in = label.getIncomingValue(i);
125 Value out = blockEnd.getOutgoingValue(i);
126 addMapping(moveResolver, out, in);
127 }
128 }
129 // GLI
130 Value[] locFrom = livenessInfo.getOutLocation(fromBlock);
131 Value[] locTo = livenessInfo.getInLocation(toBlock);
132 assert locFrom.length == locTo.length;
133
134 for (int i = 0; i < locFrom.length; i++) {
135 addMapping(moveResolver, locFrom[i], locTo[i]);
136 }
137 }
138
139 private static boolean isIllegalDestination(Value to) {
140 return isIllegal(to) || isConstantValue(to);
141 }
142
143 private static boolean verifyEdge(AbstractBlockBase<?> fromBlock, AbstractBlockBase<?> toBlock) {
144 assert Arrays.asList(toBlock.getPredecessors()).contains(fromBlock) : String.format("%s not in predecessor list: %s", fromBlock,
145 Arrays.toString(toBlock.getPredecessors()));
146 assert fromBlock.getSuccessorCount() == 1 || toBlock.getPredecessorCount() == 1 : String.format("Critical Edge? %s has %d successors and %s has %d predecessors",
147 fromBlock, fromBlock.getSuccessorCount(), toBlock, toBlock.getPredecessorCount());
148 assert Arrays.asList(fromBlock.getSuccessors()).contains(toBlock) : String.format("Predecessor block %s has wrong successor: %s, should contain: %s", fromBlock,
149 Arrays.toString(fromBlock.getSuccessors()), toBlock);
150 return true;
151 }
152
153 public static void addMapping(MoveResolver moveResolver, Value from, Value to) {
154 if (isIllegalDestination(to)) {
155 return;
156 }
157 if (isShadowedRegisterValue(to)) {
158 ShadowedRegisterValue toSh = asShadowedRegisterValue(to);
159 addMappingToRegister(moveResolver, from, toSh.getRegister());
160 addMappingToStackSlot(moveResolver, from, toSh.getStackSlot());
161 } else {
162 if (isRegister(to)) {
163 addMappingToRegister(moveResolver, from, asRegisterValue(to));
164 } else {
165 assert isStackSlotValue(to) : "Expected stack slot: " + to;
166 addMappingToStackSlot(moveResolver, from, (AllocatableValue) to);
167 }
168 }
169 }
170
171 private static void addMappingToRegister(MoveResolver moveResolver, Value from, RegisterValue register) {
172 if (isShadowedRegisterValue(from)) {
173 RegisterValue fromReg = asShadowedRegisterValue(from).getRegister();
174 AllocatableValue fromStack = asShadowedRegisterValue(from).getStackSlot();
175 checkAndAddMapping(moveResolver, fromReg, register, fromStack);
176 } else {
177 checkAndAddMapping(moveResolver, from, register, null);
178 }
179 }
180
181 private static void addMappingToStackSlot(MoveResolver moveResolver, Value from, AllocatableValue stack) {
182 if (isShadowedRegisterValue(from)) {
183 ShadowedRegisterValue shadowedFrom = asShadowedRegisterValue(from);
184 RegisterValue fromReg = shadowedFrom.getRegister();
185 AllocatableValue fromStack = shadowedFrom.getStackSlot();
186 if (!fromStack.equals(stack)) {
187 checkAndAddMapping(moveResolver, fromReg, stack, fromStack);
188 }
189 } else {
190 checkAndAddMapping(moveResolver, from, stack, null);
191 }
192
193 }
194
195 private static void checkAndAddMapping(MoveResolver moveResolver, Value from, AllocatableValue to, AllocatableValue fromStack) {
196 if (!from.equals(to) && (fromStack == null || !fromStack.equals(to))) {
197 moveResolver.addMapping(from, to, fromStack);
198 }
199 }
200
201 }