1 //===-- LegalizeTypes.cpp - Common code for DAG type legalizer ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the SelectionDAG::LegalizeTypes method. It transforms
11 // an arbitrary well-formed SelectionDAG to only consist of legal types. This
12 // is common code shared among the LegalizeTypes*.cpp files.
14 //===----------------------------------------------------------------------===//
16 #include "LegalizeTypes.h"
17 #include "llvm/Constants.h"
18 #include "llvm/DerivedTypes.h"
19 #include "llvm/Support/CommandLine.h"
20 #include "llvm/Support/MathExtras.h"
25 ViewLegalizeTypesDAGs("view-legalize-types-dags", cl::Hidden,
26 cl::desc("Pop up a window to show dags before legalize types"));
28 static const bool ViewLegalizeTypesDAGs = 0;
33 /// run - This is the main entry point for the type legalizer. This does a
34 /// top-down traversal of the dag, legalizing types as it goes.
35 void DAGTypeLegalizer::run() {
36 // Create a dummy node (which is not added to allnodes), that adds a reference
37 // to the root node, preventing it from being deleted, and tracking any
38 // changes of the root.
39 HandleSDNode Dummy(DAG.getRoot());
41 // The root of the dag may dangle to deleted nodes until the type legalizer is
42 // done. Set it to null to avoid confusion.
43 DAG.setRoot(SDOperand());
45 // Walk all nodes in the graph, assigning them a NodeID of 'ReadyToProcess'
46 // (and remembering them) if they are leaves and assigning 'NewNode' if
48 for (SelectionDAG::allnodes_iterator I = DAG.allnodes_begin(),
49 E = DAG.allnodes_end(); I != E; ++I) {
50 if (I->getNumOperands() == 0) {
51 I->setNodeId(ReadyToProcess);
52 Worklist.push_back(I);
54 I->setNodeId(NewNode);
58 // Now that we have a set of nodes to process, handle them all.
59 while (!Worklist.empty()) {
60 SDNode *N = Worklist.back();
62 assert(N->getNodeId() == ReadyToProcess &&
63 "Node should be ready if on worklist!");
65 // Scan the values produced by the node, checking to see if any result
68 unsigned NumResults = N->getNumValues();
70 MVT::ValueType ResultVT = N->getValueType(i);
71 LegalizeAction Action = getTypeAction(ResultVT);
72 if (Action == Promote) {
75 } else if (Action == Expand) {
76 // Expand can mean 1) split integer in half 2) scalarize single-element
77 // vector 3) split vector in half.
78 if (!MVT::isVector(ResultVT))
80 else if (MVT::getVectorNumElements(ResultVT) == 1)
81 ScalarizeResult(N, i); // Scalarize the single-element vector.
83 SplitResult(N, i); // Split the vector in half.
86 assert(Action == Legal && "Unknown action!");
88 } while (++i < NumResults);
90 // Scan the operand list for the node, handling any nodes with operands that
93 unsigned NumOperands = N->getNumOperands();
94 bool NeedsRevisit = false;
95 for (i = 0; i != NumOperands; ++i) {
96 MVT::ValueType OpVT = N->getOperand(i).getValueType();
97 LegalizeAction Action = getTypeAction(OpVT);
98 if (Action == Promote) {
99 NeedsRevisit = PromoteOperand(N, i);
101 } else if (Action == Expand) {
102 // Expand can mean 1) split integer in half 2) scalarize single-element
103 // vector 3) split vector in half.
104 if (!MVT::isVector(OpVT)) {
105 NeedsRevisit = ExpandOperand(N, i);
106 } else if (MVT::getVectorNumElements(OpVT) == 1) {
107 // Scalarize the single-element vector.
108 NeedsRevisit = ScalarizeOperand(N, i);
110 NeedsRevisit = SplitOperand(N, i); // Split the vector in half.
114 assert(Action == Legal && "Unknown action!");
118 // If the node needs revisiting, don't add all users to the worklist etc.
122 if (i == NumOperands)
123 DEBUG(cerr << "Legally typed node: "; N->dump(&DAG); cerr << "\n");
127 // If we reach here, the node was processed, potentially creating new nodes.
128 // Mark it as processed and add its users to the worklist as appropriate.
129 N->setNodeId(Processed);
131 for (SDNode::use_iterator UI = N->use_begin(), E = N->use_end();
134 int NodeID = User->getNodeId();
135 assert(NodeID != ReadyToProcess && NodeID != Processed &&
136 "Invalid node id for user of unprocessed node!");
138 // This node has two options: it can either be a new node or its Node ID
139 // may be a count of the number of operands it has that are not ready.
141 User->setNodeId(NodeID-1);
143 // If this was the last use it was waiting on, add it to the ready list.
144 if (NodeID-1 == ReadyToProcess)
145 Worklist.push_back(User);
149 // Otherwise, this node is new: this is the first operand of it that
150 // became ready. Its new NodeID is the number of operands it has minus 1
151 // (as this node is now processed).
152 assert(NodeID == NewNode && "Unknown node ID!");
153 User->setNodeId(User->getNumOperands()-1);
155 // If the node only has a single operand, it is now ready.
156 if (User->getNumOperands() == 1)
157 Worklist.push_back(User);
161 // If the root changed (e.g. it was a dead load, update the root).
162 DAG.setRoot(Dummy.getValue());
166 // Remove dead nodes. This is important to do for cleanliness but also before
167 // the checking loop below. Implicit folding by the DAG.getNode operators can
168 // cause unreachable nodes to be around with their flags set to new.
169 DAG.RemoveDeadNodes();
171 // In a debug build, scan all the nodes to make sure we found them all. This
172 // ensures that there are no cycles and that everything got processed.
174 for (SelectionDAG::allnodes_iterator I = DAG.allnodes_begin(),
175 E = DAG.allnodes_end(); I != E; ++I) {
178 // Check that all result types are legal.
179 for (unsigned i = 0, NumVals = I->getNumValues(); i < NumVals; ++i)
180 if (!isTypeLegal(I->getValueType(i))) {
181 cerr << "Result type " << i << " illegal!\n";
185 // Check that all operand types are legal.
186 for (unsigned i = 0, NumOps = I->getNumOperands(); i < NumOps; ++i)
187 if (!isTypeLegal(I->getOperand(i).getValueType())) {
188 cerr << "Operand type " << i << " illegal!\n";
192 if (I->getNodeId() != Processed) {
193 if (I->getNodeId() == NewNode)
194 cerr << "New node not 'noticed'?\n";
195 else if (I->getNodeId() > 0)
196 cerr << "Operand not processed?\n";
197 else if (I->getNodeId() == ReadyToProcess)
198 cerr << "Not added to worklist?\n";
203 I->dump(&DAG); cerr << "\n";
210 /// MarkNewNodes - The specified node is the root of a subtree of potentially
211 /// new nodes. Add the correct NodeId to mark it.
212 void DAGTypeLegalizer::MarkNewNodes(SDNode *N) {
213 // If this was an existing node that is already done, we're done.
214 if (N->getNodeId() != NewNode)
217 // Okay, we know that this node is new. Recursively walk all of its operands
218 // to see if they are new also. The depth of this walk is bounded by the size
219 // of the new tree that was constructed (usually 2-3 nodes), so we don't worry
220 // about revisiting of nodes.
222 // As we walk the operands, keep track of the number of nodes that are
223 // processed. If non-zero, this will become the new nodeid of this node.
224 unsigned NumProcessed = 0;
225 for (unsigned i = 0, e = N->getNumOperands(); i != e; ++i) {
226 int OpId = N->getOperand(i).Val->getNodeId();
228 MarkNewNodes(N->getOperand(i).Val);
229 else if (OpId == Processed)
233 N->setNodeId(N->getNumOperands()-NumProcessed);
234 if (N->getNodeId() == ReadyToProcess)
235 Worklist.push_back(N);
239 /// NodeUpdateListener - This class is a DAGUpdateListener that listens for
240 /// updates to nodes and recomputes their ready state.
241 class VISIBILITY_HIDDEN NodeUpdateListener :
242 public SelectionDAG::DAGUpdateListener {
243 DAGTypeLegalizer &DTL;
245 NodeUpdateListener(DAGTypeLegalizer &dtl) : DTL(dtl) {}
247 virtual void NodeDeleted(SDNode *N) {
249 assert(N->getNodeId() != DAGTypeLegalizer::Processed &&
250 N->getNodeId() != DAGTypeLegalizer::ReadyToProcess &&
251 "RAUW deleted processed node!");
254 virtual void NodeUpdated(SDNode *N) {
255 // Node updates can mean pretty much anything. It is possible that an
256 // operand was set to something already processed (f.e.) in which case
257 // this node could become ready. Recompute its flags.
258 assert(N->getNodeId() != DAGTypeLegalizer::Processed &&
259 N->getNodeId() != DAGTypeLegalizer::ReadyToProcess &&
260 "RAUW updated processed node!");
261 DTL.ReanalyzeNodeFlags(N);
267 /// ReplaceValueWith - The specified value was legalized to the specified other
268 /// value. If they are different, update the DAG and NodeIDs replacing any uses
269 /// of From to use To instead.
270 void DAGTypeLegalizer::ReplaceValueWith(SDOperand From, SDOperand To) {
271 if (From == To) return;
273 // If expansion produced new nodes, make sure they are properly marked.
274 if (To.Val->getNodeId() == NewNode)
275 MarkNewNodes(To.Val);
277 // Anything that used the old node should now use the new one. Note that this
278 // can potentially cause recursive merging.
279 NodeUpdateListener NUL(*this);
280 DAG.ReplaceAllUsesOfValueWith(From, To, &NUL);
282 // The old node may still be present in ExpandedNodes or PromotedNodes.
283 // Inform them about the replacement.
284 ReplacedNodes[From] = To;
287 /// ReplaceNodeWith - Replace uses of the 'from' node's results with the 'to'
288 /// node's results. The from and to node must define identical result types.
289 void DAGTypeLegalizer::ReplaceNodeWith(SDNode *From, SDNode *To) {
290 if (From == To) return;
291 assert(From->getNumValues() == To->getNumValues() &&
292 "Node results don't match");
294 // If expansion produced new nodes, make sure they are properly marked.
295 if (To->getNodeId() == NewNode)
298 // Anything that used the old node should now use the new one. Note that this
299 // can potentially cause recursive merging.
300 NodeUpdateListener NUL(*this);
301 DAG.ReplaceAllUsesWith(From, To, &NUL);
303 // The old node may still be present in ExpandedNodes or PromotedNodes.
304 // Inform them about the replacement.
305 for (unsigned i = 0, e = From->getNumValues(); i != e; ++i) {
306 assert(From->getValueType(i) == To->getValueType(i) &&
307 "Node results don't match");
308 ReplacedNodes[SDOperand(From, i)] = SDOperand(To, i);
313 /// RemapNode - If the specified value was already legalized to another value,
314 /// replace it by that value.
315 void DAGTypeLegalizer::RemapNode(SDOperand &N) {
316 DenseMap<SDOperand, SDOperand>::iterator I = ReplacedNodes.find(N);
317 if (I != ReplacedNodes.end()) {
318 // Use path compression to speed up future lookups if values get multiply
319 // replaced with other values.
320 RemapNode(I->second);
325 void DAGTypeLegalizer::SetPromotedOp(SDOperand Op, SDOperand Result) {
326 if (Result.Val->getNodeId() == NewNode)
327 MarkNewNodes(Result.Val);
329 SDOperand &OpEntry = PromotedNodes[Op];
330 assert(OpEntry.Val == 0 && "Node is already promoted!");
334 void DAGTypeLegalizer::SetScalarizedOp(SDOperand Op, SDOperand Result) {
335 if (Result.Val->getNodeId() == NewNode)
336 MarkNewNodes(Result.Val);
338 SDOperand &OpEntry = ScalarizedNodes[Op];
339 assert(OpEntry.Val == 0 && "Node is already scalarized!");
344 void DAGTypeLegalizer::GetExpandedOp(SDOperand Op, SDOperand &Lo,
346 std::pair<SDOperand, SDOperand> &Entry = ExpandedNodes[Op];
347 RemapNode(Entry.first);
348 RemapNode(Entry.second);
349 assert(Entry.first.Val && "Operand isn't expanded");
354 void DAGTypeLegalizer::SetExpandedOp(SDOperand Op, SDOperand Lo, SDOperand Hi) {
355 // Remember that this is the result of the node.
356 std::pair<SDOperand, SDOperand> &Entry = ExpandedNodes[Op];
357 assert(Entry.first.Val == 0 && "Node already expanded");
361 // Lo/Hi may have been newly allocated, if so, add nodeid's as relevant.
362 if (Lo.Val->getNodeId() == NewNode)
363 MarkNewNodes(Lo.Val);
364 if (Hi.Val->getNodeId() == NewNode)
365 MarkNewNodes(Hi.Val);
368 void DAGTypeLegalizer::GetSplitOp(SDOperand Op, SDOperand &Lo, SDOperand &Hi) {
369 std::pair<SDOperand, SDOperand> &Entry = SplitNodes[Op];
370 RemapNode(Entry.first);
371 RemapNode(Entry.second);
372 assert(Entry.first.Val && "Operand isn't split");
377 void DAGTypeLegalizer::SetSplitOp(SDOperand Op, SDOperand Lo, SDOperand Hi) {
378 // Remember that this is the result of the node.
379 std::pair<SDOperand, SDOperand> &Entry = SplitNodes[Op];
380 assert(Entry.first.Val == 0 && "Node already split");
384 // Lo/Hi may have been newly allocated, if so, add nodeid's as relevant.
385 if (Lo.Val->getNodeId() == NewNode)
386 MarkNewNodes(Lo.Val);
387 if (Hi.Val->getNodeId() == NewNode)
388 MarkNewNodes(Hi.Val);
392 SDOperand DAGTypeLegalizer::CreateStackStoreLoad(SDOperand Op,
393 MVT::ValueType DestVT) {
394 // Create the stack frame object.
395 SDOperand FIPtr = DAG.CreateStackTemporary(DestVT);
397 // Emit a store to the stack slot.
398 SDOperand Store = DAG.getStore(DAG.getEntryNode(), Op, FIPtr, NULL, 0);
399 // Result is a load from the stack slot.
400 return DAG.getLoad(DestVT, Store, FIPtr, NULL, 0);
403 /// HandleMemIntrinsic - This handles memcpy/memset/memmove with invalid
404 /// operands. This promotes or expands the operands as required.
405 SDOperand DAGTypeLegalizer::HandleMemIntrinsic(SDNode *N) {
406 // The chain and pointer [operands #0 and #1] are always valid types.
407 SDOperand Chain = N->getOperand(0);
408 SDOperand Ptr = N->getOperand(1);
409 SDOperand Op2 = N->getOperand(2);
411 // Op #2 is either a value (memset) or a pointer. Promote it if required.
412 switch (getTypeAction(Op2.getValueType())) {
413 default: assert(0 && "Unknown action for pointer/value operand");
415 case Promote: Op2 = GetPromotedOp(Op2); break;
418 // The length could have any action required.
419 SDOperand Length = N->getOperand(3);
420 switch (getTypeAction(Length.getValueType())) {
421 default: assert(0 && "Unknown action for memop operand");
423 case Promote: Length = GetPromotedZExtOp(Length); break;
425 SDOperand Dummy; // discard the high part.
426 GetExpandedOp(Length, Length, Dummy);
430 SDOperand Align = N->getOperand(4);
431 switch (getTypeAction(Align.getValueType())) {
432 default: assert(0 && "Unknown action for memop operand");
434 case Promote: Align = GetPromotedZExtOp(Align); break;
437 SDOperand AlwaysInline = N->getOperand(5);
438 switch (getTypeAction(AlwaysInline.getValueType())) {
439 default: assert(0 && "Unknown action for memop operand");
441 case Promote: AlwaysInline = GetPromotedZExtOp(AlwaysInline); break;
444 SDOperand Ops[] = { Chain, Ptr, Op2, Length, Align, AlwaysInline };
445 return DAG.UpdateNodeOperands(SDOperand(N, 0), Ops, 6);
448 /// SplitOp - Return the lower and upper halves of Op's bits in a value type
449 /// half the size of Op's.
450 void DAGTypeLegalizer::SplitOp(SDOperand Op, SDOperand &Lo, SDOperand &Hi) {
451 unsigned NVTBits = MVT::getSizeInBits(Op.getValueType())/2;
452 assert(MVT::getSizeInBits(Op.getValueType()) == 2*NVTBits &&
453 "Cannot split odd sized integer type");
454 MVT::ValueType NVT = MVT::getIntegerType(NVTBits);
455 Lo = DAG.getNode(ISD::TRUNCATE, NVT, Op);
456 Hi = DAG.getNode(ISD::SRL, Op.getValueType(), Op,
457 DAG.getConstant(NVTBits, TLI.getShiftAmountTy()));
458 Hi = DAG.getNode(ISD::TRUNCATE, NVT, Hi);
462 //===----------------------------------------------------------------------===//
464 //===----------------------------------------------------------------------===//
466 /// LegalizeTypes - This transforms the SelectionDAG into a SelectionDAG that
467 /// only uses types natively supported by the target.
469 /// Note that this is an involved process that may invalidate pointers into
471 void SelectionDAG::LegalizeTypes() {
472 if (ViewLegalizeTypesDAGs) viewGraph();
474 DAGTypeLegalizer(*this).run();