Have TableGen emit setSubgraphColor calls under control of a -gen-debug
[oota-llvm.git] / lib / Target / Mips / MipsISelDAGToDAG.cpp
1 //===-- MipsISelDAGToDAG.cpp - A dag to dag inst selector for Mips --------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines an instruction selector for the MIPS target.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #define DEBUG_TYPE "mips-isel"
15 #include "Mips.h"
16 #include "MipsISelLowering.h"
17 #include "MipsMachineFunction.h"
18 #include "MipsRegisterInfo.h"
19 #include "MipsSubtarget.h"
20 #include "MipsTargetMachine.h"
21 #include "llvm/GlobalValue.h"
22 #include "llvm/Instructions.h"
23 #include "llvm/Intrinsics.h"
24 #include "llvm/Support/CFG.h"
25 #include "llvm/Type.h"
26 #include "llvm/CodeGen/MachineConstantPool.h"
27 #include "llvm/CodeGen/MachineFunction.h"
28 #include "llvm/CodeGen/MachineFrameInfo.h"
29 #include "llvm/CodeGen/MachineInstrBuilder.h"
30 #include "llvm/CodeGen/MachineRegisterInfo.h"
31 #include "llvm/CodeGen/SelectionDAGISel.h"
32 #include "llvm/Target/TargetMachine.h"
33 #include "llvm/Support/Compiler.h"
34 #include "llvm/Support/Debug.h"
35 using namespace llvm;
36
37 //===----------------------------------------------------------------------===//
38 // Instruction Selector Implementation
39 //===----------------------------------------------------------------------===//
40
41 //===----------------------------------------------------------------------===//
42 // MipsDAGToDAGISel - MIPS specific code to select MIPS machine
43 // instructions for SelectionDAG operations.
44 //===----------------------------------------------------------------------===//
45 namespace {
46
47 class VISIBILITY_HIDDEN MipsDAGToDAGISel : public SelectionDAGISel {
48
49   /// TM - Keep a reference to MipsTargetMachine.
50   MipsTargetMachine &TM;
51
52   /// Subtarget - Keep a pointer to the MipsSubtarget around so that we can
53   /// make the right decision when generating code for different targets.
54   const MipsSubtarget &Subtarget;
55  
56 public:
57   explicit MipsDAGToDAGISel(MipsTargetMachine &tm) :
58   SelectionDAGISel(*tm.getTargetLowering()),
59   TM(tm), Subtarget(tm.getSubtarget<MipsSubtarget>()) {}
60   
61   virtual void InstructionSelect();
62
63   // Pass Name
64   virtual const char *getPassName() const {
65     return "MIPS DAG->DAG Pattern Instruction Selection";
66   } 
67   
68
69 private:  
70   // Include the pieces autogenerated from the target description.
71   #include "MipsGenDAGISel.inc"
72
73   SDValue getGlobalBaseReg();
74   SDNode *Select(SDValue N);
75
76   // Complex Pattern.
77   bool SelectAddr(SDValue Op, SDValue N, 
78                   SDValue &Base, SDValue &Offset);
79
80
81   // getI32Imm - Return a target constant with the specified
82   // value, of type i32.
83   inline SDValue getI32Imm(unsigned Imm) {
84     return CurDAG->getTargetConstant(Imm, MVT::i32);
85   }
86
87
88   #ifndef NDEBUG
89   unsigned Indent;
90   #endif
91 };
92
93 }
94
95 /// InstructionSelect - This callback is invoked by
96 /// SelectionDAGISel when it has created a SelectionDAG for us to codegen.
97 void MipsDAGToDAGISel::
98 InstructionSelect() 
99 {
100   DEBUG(BB->dump());
101   // Codegen the basic block.
102   #ifndef NDEBUG
103   DOUT << "===== Instruction selection begins:\n";
104   Indent = 0;
105   #endif
106
107   // Select target instructions for the DAG.
108   SelectRoot(*CurDAG);
109
110   #ifndef NDEBUG
111   DOUT << "===== Instruction selection ends:\n";
112   #endif
113
114   CurDAG->RemoveDeadNodes();
115 }
116
117 /// getGlobalBaseReg - Output the instructions required to put the
118 /// GOT address into a register.
119 SDValue MipsDAGToDAGISel::getGlobalBaseReg() {
120   MachineFunction* MF = BB->getParent();
121   unsigned GP = 0;
122   for(MachineRegisterInfo::livein_iterator ii = MF->getRegInfo().livein_begin(),
123         ee = MF->getRegInfo().livein_end(); ii != ee; ++ii)
124     if (ii->first == Mips::GP) {
125       GP = ii->second;
126       break;
127     }
128   assert(GP && "GOT PTR not in liveins");
129   return CurDAG->getCopyFromReg(CurDAG->getEntryNode(), 
130                                 GP, MVT::i32);
131 }
132
133 /// ComplexPattern used on MipsInstrInfo
134 /// Used on Mips Load/Store instructions
135 bool MipsDAGToDAGISel::
136 SelectAddr(SDValue Op, SDValue Addr, SDValue &Offset, SDValue &Base)
137 {
138   // if Address is FI, get the TargetFrameIndex.
139   if (FrameIndexSDNode *FIN = dyn_cast<FrameIndexSDNode>(Addr)) {
140     Base   = CurDAG->getTargetFrameIndex(FIN->getIndex(), MVT::i32);
141     Offset = CurDAG->getTargetConstant(0, MVT::i32);
142     return true;
143   }
144     
145   // on PIC code Load GA
146   if (TM.getRelocationModel() == Reloc::PIC_) {
147     if ((Addr.getOpcode() == ISD::TargetGlobalAddress) || 
148         (Addr.getOpcode() == ISD::TargetJumpTable)){
149       Base   = CurDAG->getRegister(Mips::GP, MVT::i32);
150       Offset = Addr;
151       return true;
152     }
153   } else {
154     if ((Addr.getOpcode() == ISD::TargetExternalSymbol ||
155         Addr.getOpcode() == ISD::TargetGlobalAddress))
156       return false;
157   }    
158   
159   // Operand is a result from an ADD.
160   if (Addr.getOpcode() == ISD::ADD) {
161     if (ConstantSDNode *CN = dyn_cast<ConstantSDNode>(Addr.getOperand(1))) {
162       if (Predicate_immSExt16(CN)) {
163
164         // If the first operand is a FI, get the TargetFI Node
165         if (FrameIndexSDNode *FIN = dyn_cast<FrameIndexSDNode>
166                                     (Addr.getOperand(0))) {
167           Base = CurDAG->getTargetFrameIndex(FIN->getIndex(), MVT::i32);
168         } else {
169           Base = Addr.getOperand(0);
170         }
171
172         Offset = CurDAG->getTargetConstant(CN->getZExtValue(), MVT::i32);
173         return true;
174       }
175     }
176   }
177
178   Base   = Addr;
179   Offset = CurDAG->getTargetConstant(0, MVT::i32);
180   return true;
181 }
182
183 /// Select instructions not customized! Used for
184 /// expanded, promoted and normal instructions
185 SDNode* MipsDAGToDAGISel::
186 Select(SDValue N) 
187 {
188   SDNode *Node = N.getNode();
189   unsigned Opcode = Node->getOpcode();
190
191   // Dump information about the Node being selected
192   #ifndef NDEBUG
193   DOUT << std::string(Indent, ' ') << "Selecting: ";
194   DEBUG(Node->dump(CurDAG));
195   DOUT << "\n";
196   Indent += 2;
197   #endif
198
199   // If we have a custom node, we already have selected!
200   if (Node->isMachineOpcode()) {
201     #ifndef NDEBUG
202     DOUT << std::string(Indent-2, ' ') << "== ";
203     DEBUG(Node->dump(CurDAG));
204     DOUT << "\n";
205     Indent -= 2;
206     #endif
207     return NULL;
208   }
209
210   ///
211   // Instruction Selection not handled by the auto-generated 
212   // tablegen selection should be handled here.
213   /// 
214   switch(Opcode) {
215
216     default: break;
217
218     case ISD::SUBE: 
219     case ISD::ADDE: {
220       SDValue InFlag = Node->getOperand(2), CmpLHS;
221       unsigned Opc = InFlag.getOpcode(), MOp;
222
223       assert(((Opc == ISD::ADDC || Opc == ISD::ADDE) || 
224               (Opc == ISD::SUBC || Opc == ISD::SUBE)) &&  
225              "(ADD|SUB)E flag operand must come from (ADD|SUB)C/E insn");
226
227       if (Opcode == ISD::ADDE) {
228         CmpLHS = InFlag.getValue(0);
229         MOp = Mips::ADDu;
230       } else { 
231         CmpLHS = InFlag.getOperand(0);
232         MOp = Mips::SUBu;
233       }
234
235       SDValue Ops[] = { CmpLHS, InFlag.getOperand(1) };
236
237       SDValue LHS = Node->getOperand(0);
238       SDValue RHS = Node->getOperand(1);
239       AddToISelQueue(LHS);
240       AddToISelQueue(RHS);
241
242       MVT VT = LHS.getValueType();
243       SDNode *Carry = CurDAG->getTargetNode(Mips::SLTu, VT, Ops, 2);
244       SDNode *AddCarry = CurDAG->getTargetNode(Mips::ADDu, VT, 
245                                                SDValue(Carry,0), RHS);
246
247       return CurDAG->SelectNodeTo(N.getNode(), MOp, VT, MVT::Flag, 
248                                   LHS, SDValue(AddCarry,0));
249     }
250
251     /// Mul/Div with two results
252     case ISD::SDIVREM:
253     case ISD::UDIVREM:
254     case ISD::SMUL_LOHI:
255     case ISD::UMUL_LOHI: {
256       SDValue Op1 = Node->getOperand(0);
257       SDValue Op2 = Node->getOperand(1);
258       AddToISelQueue(Op1);
259       AddToISelQueue(Op2);
260
261       unsigned Op;
262       if (Opcode == ISD::UMUL_LOHI || Opcode == ISD::SMUL_LOHI)
263         Op = (Opcode == ISD::UMUL_LOHI ? Mips::MULTu : Mips::MULT);
264       else
265         Op = (Opcode == ISD::UDIVREM ? Mips::DIVu : Mips::DIV);
266
267       SDNode *Node = CurDAG->getTargetNode(Op, MVT::Flag, Op1, Op2);
268
269       SDValue InFlag = SDValue(Node, 0);
270       SDNode *Lo = CurDAG->getTargetNode(Mips::MFLO, MVT::i32, 
271                                          MVT::Flag, InFlag);
272       InFlag = SDValue(Lo,1);
273       SDNode *Hi = CurDAG->getTargetNode(Mips::MFHI, MVT::i32, InFlag);
274
275       if (!N.getValue(0).use_empty()) 
276         ReplaceUses(N.getValue(0), SDValue(Lo,0));
277
278       if (!N.getValue(1).use_empty()) 
279         ReplaceUses(N.getValue(1), SDValue(Hi,0));
280
281       return NULL;
282     }
283
284     /// Special Muls
285     case ISD::MUL: 
286     case ISD::MULHS:
287     case ISD::MULHU: {
288       SDValue MulOp1 = Node->getOperand(0);
289       SDValue MulOp2 = Node->getOperand(1);
290       AddToISelQueue(MulOp1);
291       AddToISelQueue(MulOp2);
292
293       unsigned MulOp  = (Opcode == ISD::MULHU ? Mips::MULTu : Mips::MULT);
294       SDNode *MulNode = CurDAG->getTargetNode(MulOp, MVT::Flag, MulOp1, MulOp2);
295
296       SDValue InFlag = SDValue(MulNode, 0);
297
298       if (MulOp == ISD::MUL)
299         return CurDAG->getTargetNode(Mips::MFLO, MVT::i32, InFlag);
300       else
301         return CurDAG->getTargetNode(Mips::MFHI, MVT::i32, InFlag);
302     }
303
304     /// Div/Rem operations
305     case ISD::SREM:
306     case ISD::UREM:
307     case ISD::SDIV: 
308     case ISD::UDIV: {
309       SDValue Op1 = Node->getOperand(0);
310       SDValue Op2 = Node->getOperand(1);
311       AddToISelQueue(Op1);
312       AddToISelQueue(Op2);
313
314       unsigned Op, MOp;
315       if (Opcode == ISD::SDIV || Opcode == ISD::UDIV) {
316         Op  = (Opcode == ISD::SDIV ? Mips::DIV : Mips::DIVu);
317         MOp = Mips::MFLO;
318       } else {
319         Op  = (Opcode == ISD::SREM ? Mips::DIV : Mips::DIVu);
320         MOp = Mips::MFHI;
321       }
322       SDNode *Node = CurDAG->getTargetNode(Op, MVT::Flag, Op1, Op2);
323
324       SDValue InFlag = SDValue(Node, 0);
325       return CurDAG->getTargetNode(MOp, MVT::i32, InFlag);
326     }
327
328     // Get target GOT address.
329     case ISD::GLOBAL_OFFSET_TABLE: {
330       SDValue Result = getGlobalBaseReg();
331       ReplaceUses(N, Result);
332       return NULL;
333     }
334
335     /// Handle direct and indirect calls when using PIC. On PIC, when 
336     /// GOT is smaller than about 64k (small code) the GA target is 
337     /// loaded with only one instruction. Otherwise GA's target must 
338     /// be loaded with 3 instructions. 
339     case MipsISD::JmpLink: {
340       if (TM.getRelocationModel() == Reloc::PIC_) {
341         //bool isCodeLarge = (TM.getCodeModel() == CodeModel::Large);
342         SDValue Chain  = Node->getOperand(0);
343         SDValue Callee = Node->getOperand(1);
344         AddToISelQueue(Chain);
345         SDValue T9Reg = CurDAG->getRegister(Mips::T9, MVT::i32);
346         SDValue InFlag(0, 0);
347
348         if ( (isa<GlobalAddressSDNode>(Callee)) ||
349              (isa<ExternalSymbolSDNode>(Callee)) )
350         {
351           /// Direct call for global addresses and external symbols
352           SDValue GPReg = CurDAG->getRegister(Mips::GP, MVT::i32);
353
354           // Use load to get GOT target
355           SDValue Ops[] = { Callee, GPReg, Chain };
356           SDValue Load = SDValue(CurDAG->getTargetNode(Mips::LW, MVT::i32, 
357                                      MVT::Other, Ops, 3), 0);
358           Chain = Load.getValue(1);
359           AddToISelQueue(Chain);
360
361           // Call target must be on T9
362           Chain = CurDAG->getCopyToReg(Chain, T9Reg, Load, InFlag);
363         } else 
364           /// Indirect call
365           Chain = CurDAG->getCopyToReg(Chain, T9Reg, Callee, InFlag);
366
367         AddToISelQueue(Chain);
368
369         // Emit Jump and Link Register
370         SDNode *ResNode = CurDAG->getTargetNode(Mips::JALR, MVT::Other,
371                                   MVT::Flag, T9Reg, Chain);
372         Chain  = SDValue(ResNode, 0);
373         InFlag = SDValue(ResNode, 1);
374         ReplaceUses(SDValue(Node, 0), Chain);
375         ReplaceUses(SDValue(Node, 1), InFlag);
376         return ResNode;
377       } 
378     }
379   }
380
381   // Select the default instruction
382   SDNode *ResNode = SelectCode(N);
383
384   #ifndef NDEBUG
385   DOUT << std::string(Indent-2, ' ') << "=> ";
386   if (ResNode == NULL || ResNode == N.getNode())
387     DEBUG(N.getNode()->dump(CurDAG));
388   else
389     DEBUG(ResNode->dump(CurDAG));
390   DOUT << "\n";
391   Indent -= 2;
392   #endif
393
394   return ResNode;
395 }
396
397 /// createMipsISelDag - This pass converts a legalized DAG into a 
398 /// MIPS-specific DAG, ready for instruction scheduling.
399 FunctionPass *llvm::createMipsISelDag(MipsTargetMachine &TM) {
400   return new MipsDAGToDAGISel(TM);
401 }