Add comment.
[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/Debug.h"
34 #include "llvm/Support/ErrorHandling.h"
35 #include "llvm/Support/raw_ostream.h"
36 using namespace llvm;
37
38 //===----------------------------------------------------------------------===//
39 // Instruction Selector Implementation
40 //===----------------------------------------------------------------------===//
41
42 //===----------------------------------------------------------------------===//
43 // MipsDAGToDAGISel - MIPS specific code to select MIPS machine
44 // instructions for SelectionDAG operations.
45 //===----------------------------------------------------------------------===//
46 namespace {
47
48 class MipsDAGToDAGISel : public SelectionDAGISel {
49
50   /// TM - Keep a reference to MipsTargetMachine.
51   MipsTargetMachine &TM;
52
53   /// Subtarget - Keep a pointer to the MipsSubtarget around so that we can
54   /// make the right decision when generating code for different targets.
55   const MipsSubtarget &Subtarget;
56  
57 public:
58   explicit MipsDAGToDAGISel(MipsTargetMachine &tm) :
59   SelectionDAGISel(tm),
60   TM(tm), Subtarget(tm.getSubtarget<MipsSubtarget>()) {}
61   
62   // Pass Name
63   virtual const char *getPassName() const {
64     return "MIPS DAG->DAG Pattern Instruction Selection";
65   } 
66   
67
68 private:  
69   // Include the pieces autogenerated from the target description.
70   #include "MipsGenDAGISel.inc"
71
72   /// getTargetMachine - Return a reference to the TargetMachine, casted
73   /// to the target-specific type.
74   const MipsTargetMachine &getTargetMachine() {
75     return static_cast<const MipsTargetMachine &>(TM);
76   }
77
78   /// getInstrInfo - Return a reference to the TargetInstrInfo, casted
79   /// to the target-specific type.
80   const MipsInstrInfo *getInstrInfo() {
81     return getTargetMachine().getInstrInfo();
82   }
83
84   SDNode *getGlobalBaseReg();
85   SDNode *Select(SDNode *N);
86
87   // Complex Pattern.
88   bool SelectAddr(SDNode *Op, SDValue N, 
89                   SDValue &Base, SDValue &Offset);
90
91   SDNode *SelectLoadFp64(SDNode *N);
92   SDNode *SelectStoreFp64(SDNode *N);
93
94   // getI32Imm - Return a target constant with the specified
95   // value, of type i32.
96   inline SDValue getI32Imm(unsigned Imm) {
97     return CurDAG->getTargetConstant(Imm, MVT::i32);
98   }
99 };
100
101 }
102
103
104 /// getGlobalBaseReg - Output the instructions required to put the
105 /// GOT address into a register.
106 SDNode *MipsDAGToDAGISel::getGlobalBaseReg() {
107   unsigned GlobalBaseReg = getInstrInfo()->getGlobalBaseReg(MF);
108   return CurDAG->getRegister(GlobalBaseReg, TLI.getPointerTy()).getNode();
109 }
110
111 /// ComplexPattern used on MipsInstrInfo
112 /// Used on Mips Load/Store instructions
113 bool MipsDAGToDAGISel::
114 SelectAddr(SDNode *Op, SDValue Addr, SDValue &Offset, SDValue &Base)
115 {
116   // if Address is FI, get the TargetFrameIndex.
117   if (FrameIndexSDNode *FIN = dyn_cast<FrameIndexSDNode>(Addr)) {
118     Base   = CurDAG->getTargetFrameIndex(FIN->getIndex(), MVT::i32);
119     Offset = CurDAG->getTargetConstant(0, MVT::i32);
120     return true;
121   }
122     
123   // on PIC code Load GA
124   if (TM.getRelocationModel() == Reloc::PIC_) {
125     if ((Addr.getOpcode() == ISD::TargetGlobalAddress) || 
126         (Addr.getOpcode() == ISD::TargetConstantPool) || 
127         (Addr.getOpcode() == ISD::TargetJumpTable)){
128       Base   = CurDAG->getRegister(Mips::GP, MVT::i32);
129       Offset = Addr;
130       return true;
131     }
132   } else {
133     if ((Addr.getOpcode() == ISD::TargetExternalSymbol ||
134         Addr.getOpcode() == ISD::TargetGlobalAddress))
135       return false;
136   }    
137   
138   // Operand is a result from an ADD.
139   if (Addr.getOpcode() == ISD::ADD) {
140     if (ConstantSDNode *CN = dyn_cast<ConstantSDNode>(Addr.getOperand(1))) {
141       if (Predicate_immSExt16(CN)) {
142
143         // If the first operand is a FI, get the TargetFI Node
144         if (FrameIndexSDNode *FIN = dyn_cast<FrameIndexSDNode>
145                                     (Addr.getOperand(0))) {
146           Base = CurDAG->getTargetFrameIndex(FIN->getIndex(), MVT::i32);
147         } else {
148           Base = Addr.getOperand(0);
149         }
150
151         Offset = CurDAG->getTargetConstant(CN->getZExtValue(), MVT::i32);
152         return true;
153       }
154     }
155
156     // When loading from constant pools, load the lower address part in
157     // the instruction itself. Example, instead of:
158     //  lui $2, %hi($CPI1_0)
159     //  addiu $2, $2, %lo($CPI1_0)
160     //  lwc1 $f0, 0($2)
161     // Generate:
162     //  lui $2, %hi($CPI1_0)
163     //  lwc1 $f0, %lo($CPI1_0)($2)
164     if ((Addr.getOperand(0).getOpcode() == MipsISD::Hi || 
165          Addr.getOperand(0).getOpcode() == ISD::LOAD) &&
166         Addr.getOperand(1).getOpcode() == MipsISD::Lo) {
167       SDValue LoVal = Addr.getOperand(1); 
168       if (dyn_cast<ConstantPoolSDNode>(LoVal.getOperand(0))) {
169         Base = Addr.getOperand(0);
170         Offset = LoVal.getOperand(0);
171         return true;
172       }
173     }
174   }
175
176   Base   = Addr;
177   Offset = CurDAG->getTargetConstant(0, MVT::i32);
178   return true;
179 }
180
181 SDNode *MipsDAGToDAGISel::SelectLoadFp64(SDNode *N) {
182   MVT::SimpleValueType NVT = 
183     N->getValueType(0).getSimpleVT().SimpleTy;
184
185   if (!Subtarget.isMips1() || NVT != MVT::f64)
186     return NULL;
187
188   if (!Predicate_unindexedload(N) ||
189       !Predicate_load(N))
190     return NULL;
191
192   SDValue Chain = N->getOperand(0);
193   SDValue N1 = N->getOperand(1);
194   SDValue Offset0, Offset1, Base;
195
196   if (!SelectAddr(N, N1, Offset0, Base) ||
197       N1.getValueType() != MVT::i32)
198     return NULL;
199
200   MachineSDNode::mmo_iterator MemRefs0 = MF->allocateMemRefsArray(1);
201   MemRefs0[0] = cast<MemSDNode>(N)->getMemOperand();
202   DebugLoc dl = N->getDebugLoc();
203
204   // The second load should start after for 4 bytes. 
205   if (ConstantSDNode *C = dyn_cast<ConstantSDNode>(Offset0))
206     Offset1 = CurDAG->getTargetConstant(C->getSExtValue()+4, MVT::i32);
207   else if (ConstantPoolSDNode *CP = dyn_cast<ConstantPoolSDNode>(Offset0))
208     Offset1 = CurDAG->getTargetConstantPool(CP->getConstVal(), 
209                                             MVT::i32, 
210                                             CP->getAlignment(), 
211                                             CP->getOffset()+4, 
212                                             CP->getTargetFlags());
213   else
214     return NULL;
215
216   // Choose the offsets depending on the endianess
217   if (TM.getTargetData()->isBigEndian())
218     std::swap(Offset0, Offset1);
219
220   // Instead of:
221   //    ldc $f0, X($3)
222   // Generate:
223   //    lwc $f0, X($3)
224   //    lwc $f1, X+4($3)
225   SDNode *LD0 = CurDAG->getMachineNode(Mips::LWC1, dl, MVT::f32, 
226                                     MVT::Other, Offset0, Base, Chain);
227   SDValue Undef = SDValue(CurDAG->getMachineNode(TargetOpcode::IMPLICIT_DEF,
228                                                  dl, NVT), 0);
229   SDValue I0 = CurDAG->getTargetInsertSubreg(Mips::SUBREG_FPEVEN, dl, 
230                             MVT::f64, Undef, SDValue(LD0, 0));
231
232   SDNode *LD1 = CurDAG->getMachineNode(Mips::LWC1, dl, MVT::f32,
233                           MVT::Other, Offset1, Base, SDValue(LD0, 1));
234   SDValue I1 = CurDAG->getTargetInsertSubreg(Mips::SUBREG_FPODD, dl, 
235                             MVT::f64, I0, SDValue(LD1, 0));
236
237   ReplaceUses(SDValue(N, 0), I1);
238   ReplaceUses(SDValue(N, 1), Chain);
239   cast<MachineSDNode>(LD0)->setMemRefs(MemRefs0, MemRefs0 + 1);
240   cast<MachineSDNode>(LD1)->setMemRefs(MemRefs0, MemRefs0 + 1);
241   return I1.getNode();
242 }
243
244 SDNode *MipsDAGToDAGISel::SelectStoreFp64(SDNode *N) {
245
246   if (!Subtarget.isMips1() || 
247       N->getOperand(1).getValueType() != MVT::f64)
248     return NULL;
249
250   SDValue Chain = N->getOperand(0);
251
252   if (!Predicate_unindexedstore(N) ||
253       !Predicate_store(N))
254     return NULL;
255
256   SDValue N1 = N->getOperand(1);
257   SDValue N2 = N->getOperand(2);
258   SDValue Offset0, Offset1, Base;
259
260   if (!SelectAddr(N, N2, Offset0, Base) ||
261       N1.getValueType() != MVT::f64 ||
262       N2.getValueType() != MVT::i32)
263     return NULL;
264
265   MachineSDNode::mmo_iterator MemRefs0 = MF->allocateMemRefsArray(1);
266   MemRefs0[0] = cast<MemSDNode>(N)->getMemOperand();
267   DebugLoc dl = N->getDebugLoc();
268
269   // Get the even and odd part from the f64 register
270   SDValue FPOdd = CurDAG->getTargetExtractSubreg(Mips::SUBREG_FPODD, 
271                                                  dl, MVT::f32, N1);
272   SDValue FPEven = CurDAG->getTargetExtractSubreg(Mips::SUBREG_FPEVEN,
273                                                  dl, MVT::f32, N1);
274
275   // The second store should start after for 4 bytes. 
276   if (ConstantSDNode *C = dyn_cast<ConstantSDNode>(Offset0))
277     Offset1 = CurDAG->getTargetConstant(C->getSExtValue()+4, MVT::i32);
278   else
279     return NULL;
280
281   // Choose the offsets depending on the endianess
282   if (TM.getTargetData()->isBigEndian())
283     std::swap(Offset0, Offset1);
284
285   // Instead of:
286   //    sdc $f0, X($3)
287   // Generate:
288   //    swc $f0, X($3)
289   //    swc $f1, X+4($3)
290   SDValue Ops0[] = { FPEven, Offset0, Base, Chain };
291   Chain = SDValue(CurDAG->getMachineNode(Mips::SWC1, dl,
292                                        MVT::Other, Ops0, 4), 0);
293   cast<MachineSDNode>(Chain.getNode())->setMemRefs(MemRefs0, MemRefs0 + 1);
294
295   SDValue Ops1[] = { FPOdd, Offset1, Base, Chain };
296   Chain = SDValue(CurDAG->getMachineNode(Mips::SWC1, dl,
297                                        MVT::Other, Ops1, 4), 0);
298   cast<MachineSDNode>(Chain.getNode())->setMemRefs(MemRefs0, MemRefs0 + 1);
299
300   ReplaceUses(SDValue(N, 0), Chain);
301   return Chain.getNode();
302 }
303
304 /// Select instructions not customized! Used for
305 /// expanded, promoted and normal instructions
306 SDNode* MipsDAGToDAGISel::Select(SDNode *Node) {
307   unsigned Opcode = Node->getOpcode();
308   DebugLoc dl = Node->getDebugLoc();
309
310   // Dump information about the Node being selected
311   DEBUG(errs() << "Selecting: "; Node->dump(CurDAG); errs() << "\n");
312
313   // If we have a custom node, we already have selected!
314   if (Node->isMachineOpcode()) {
315     DEBUG(errs() << "== "; Node->dump(CurDAG); errs() << "\n");
316     return NULL;
317   }
318
319   ///
320   // Instruction Selection not handled by the auto-generated 
321   // tablegen selection should be handled here.
322   /// 
323   switch(Opcode) {
324
325     default: break;
326
327     case ISD::SUBE: 
328     case ISD::ADDE: {
329       SDValue InFlag = Node->getOperand(2), CmpLHS;
330       unsigned Opc = InFlag.getOpcode(); Opc=Opc;
331       assert(((Opc == ISD::ADDC || Opc == ISD::ADDE) || 
332               (Opc == ISD::SUBC || Opc == ISD::SUBE)) &&  
333              "(ADD|SUB)E flag operand must come from (ADD|SUB)C/E insn");
334
335       unsigned MOp;
336       if (Opcode == ISD::ADDE) {
337         CmpLHS = InFlag.getValue(0);
338         MOp = Mips::ADDu;
339       } else { 
340         CmpLHS = InFlag.getOperand(0);
341         MOp = Mips::SUBu;
342       }
343
344       SDValue Ops[] = { CmpLHS, InFlag.getOperand(1) };
345
346       SDValue LHS = Node->getOperand(0);
347       SDValue RHS = Node->getOperand(1);
348
349       EVT VT = LHS.getValueType();
350       SDNode *Carry = CurDAG->getMachineNode(Mips::SLTu, dl, VT, Ops, 2);
351       SDNode *AddCarry = CurDAG->getMachineNode(Mips::ADDu, dl, VT, 
352                                                 SDValue(Carry,0), RHS);
353
354       return CurDAG->SelectNodeTo(Node, MOp, VT, MVT::Flag,
355                                   LHS, SDValue(AddCarry,0));
356     }
357
358     /// Mul/Div with two results
359     case ISD::SDIVREM:
360     case ISD::UDIVREM:
361     case ISD::SMUL_LOHI:
362     case ISD::UMUL_LOHI: {
363       SDValue Op1 = Node->getOperand(0);
364       SDValue Op2 = Node->getOperand(1);
365
366       unsigned Op;
367       if (Opcode == ISD::UMUL_LOHI || Opcode == ISD::SMUL_LOHI)
368         Op = (Opcode == ISD::UMUL_LOHI ? Mips::MULTu : Mips::MULT);
369       else
370         Op = (Opcode == ISD::UDIVREM ? Mips::DIVu : Mips::DIV);
371
372       SDNode *MulDiv = CurDAG->getMachineNode(Op, dl, MVT::Flag, Op1, Op2);
373
374       SDValue InFlag = SDValue(MulDiv, 0);
375       SDNode *Lo = CurDAG->getMachineNode(Mips::MFLO, dl, MVT::i32, 
376                                           MVT::Flag, InFlag);
377       InFlag = SDValue(Lo,1);
378       SDNode *Hi = CurDAG->getMachineNode(Mips::MFHI, dl, MVT::i32, InFlag);
379
380       if (!SDValue(Node, 0).use_empty()) 
381         ReplaceUses(SDValue(Node, 0), SDValue(Lo,0));
382
383       if (!SDValue(Node, 1).use_empty()) 
384         ReplaceUses(SDValue(Node, 1), SDValue(Hi,0));
385
386       return NULL;
387     }
388
389     /// Special Muls
390     case ISD::MUL: 
391     case ISD::MULHS:
392     case ISD::MULHU: {
393       SDValue MulOp1 = Node->getOperand(0);
394       SDValue MulOp2 = Node->getOperand(1);
395
396       unsigned MulOp  = (Opcode == ISD::MULHU ? Mips::MULTu : Mips::MULT);
397       SDNode *MulNode = CurDAG->getMachineNode(MulOp, dl, 
398                                                MVT::Flag, MulOp1, MulOp2);
399
400       SDValue InFlag = SDValue(MulNode, 0);
401
402       if (Opcode == ISD::MUL)
403         return CurDAG->getMachineNode(Mips::MFLO, dl, MVT::i32, InFlag);
404       else
405         return CurDAG->getMachineNode(Mips::MFHI, dl, MVT::i32, InFlag);
406     }
407
408     /// Div/Rem operations
409     case ISD::SREM:
410     case ISD::UREM:
411     case ISD::SDIV: 
412     case ISD::UDIV: {
413       SDValue Op1 = Node->getOperand(0);
414       SDValue Op2 = Node->getOperand(1);
415
416       unsigned Op, MOp;
417       if (Opcode == ISD::SDIV || Opcode == ISD::UDIV) {
418         Op  = (Opcode == ISD::SDIV ? Mips::DIV : Mips::DIVu);
419         MOp = Mips::MFLO;
420       } else {
421         Op  = (Opcode == ISD::SREM ? Mips::DIV : Mips::DIVu);
422         MOp = Mips::MFHI;
423       }
424       SDNode *Node = CurDAG->getMachineNode(Op, dl, MVT::Flag, Op1, Op2);
425
426       SDValue InFlag = SDValue(Node, 0);
427       return CurDAG->getMachineNode(MOp, dl, MVT::i32, InFlag);
428     }
429
430     // Get target GOT address.
431     case ISD::GLOBAL_OFFSET_TABLE:
432       return getGlobalBaseReg();
433
434     case ISD::ConstantFP: {
435       ConstantFPSDNode *CN = dyn_cast<ConstantFPSDNode>(Node);
436       if (Node->getValueType(0) == MVT::f64 && CN->isExactlyValue(+0.0)) { 
437         SDValue Zero = CurDAG->getCopyFromReg(CurDAG->getEntryNode(), dl, 
438                                         Mips::ZERO, MVT::i32);
439         SDValue Undef = SDValue(
440           CurDAG->getMachineNode(TargetOpcode::IMPLICIT_DEF, dl, MVT::f64), 0);
441         SDNode *MTC = CurDAG->getMachineNode(Mips::MTC1, dl, MVT::f32, Zero);
442         SDValue I0 = CurDAG->getTargetInsertSubreg(Mips::SUBREG_FPEVEN, dl, 
443                             MVT::f64, Undef, SDValue(MTC, 0));
444         SDValue I1 = CurDAG->getTargetInsertSubreg(Mips::SUBREG_FPODD, dl, 
445                             MVT::f64, I0, SDValue(MTC, 0));
446         ReplaceUses(SDValue(Node, 0), I1);
447         return I1.getNode();
448       }
449       break;
450     }
451
452     case ISD::LOAD:
453       if (SDNode *ResNode = SelectLoadFp64(Node))
454         return ResNode;
455       // Other cases are autogenerated.
456       break;
457
458     case ISD::STORE:
459       if (SDNode *ResNode = SelectStoreFp64(Node))
460         return ResNode;
461       // Other cases are autogenerated.
462       break;
463
464     /// Handle direct and indirect calls when using PIC. On PIC, when 
465     /// GOT is smaller than about 64k (small code) the GA target is 
466     /// loaded with only one instruction. Otherwise GA's target must 
467     /// be loaded with 3 instructions. 
468     case MipsISD::JmpLink: {
469       if (TM.getRelocationModel() == Reloc::PIC_) {
470         unsigned LastOpNum = Node->getNumOperands()-1;
471
472         SDValue Chain  = Node->getOperand(0);
473         SDValue Callee = Node->getOperand(1);
474         SDValue InFlag;
475
476         // Skip the incomming flag if present
477         if (Node->getOperand(LastOpNum).getValueType() == MVT::Flag)
478           LastOpNum--;
479
480         if ( (isa<GlobalAddressSDNode>(Callee)) ||
481              (isa<ExternalSymbolSDNode>(Callee)) )
482         {
483           /// Direct call for global addresses and external symbols
484           SDValue GPReg = CurDAG->getRegister(Mips::GP, MVT::i32);
485
486           // Use load to get GOT target
487           SDValue Ops[] = { Callee, GPReg, Chain };
488           SDValue Load = SDValue(CurDAG->getMachineNode(Mips::LW, dl, MVT::i32, 
489                                      MVT::Other, Ops, 3), 0);
490           Chain = Load.getValue(1);
491
492           // Call target must be on T9
493           Chain = CurDAG->getCopyToReg(Chain, dl, Mips::T9, Load, InFlag);
494         } else 
495           /// Indirect call
496           Chain = CurDAG->getCopyToReg(Chain, dl, Mips::T9, Callee, InFlag);
497
498         // Map the JmpLink operands to JALR
499         SDVTList NodeTys = CurDAG->getVTList(MVT::Other, MVT::Flag);
500         SmallVector<SDValue, 8> Ops;
501         Ops.push_back(CurDAG->getRegister(Mips::T9, MVT::i32));
502
503         for (unsigned i = 2, e = LastOpNum+1; i != e; ++i)
504           Ops.push_back(Node->getOperand(i));
505         Ops.push_back(Chain);
506         Ops.push_back(Chain.getValue(1));
507
508         // Emit Jump and Link Register
509         SDNode *ResNode = CurDAG->getMachineNode(Mips::JALR, dl, NodeTys, 
510                                   &Ops[0], Ops.size());
511
512         // Replace Chain and InFlag
513         ReplaceUses(SDValue(Node, 0), SDValue(ResNode, 0));
514         ReplaceUses(SDValue(Node, 1), SDValue(ResNode, 1));
515         return ResNode;
516       } 
517     }
518   }
519
520   // Select the default instruction
521   SDNode *ResNode = SelectCode(Node);
522
523   DEBUG(errs() << "=> ");
524   if (ResNode == NULL || ResNode == Node)
525     DEBUG(Node->dump(CurDAG));
526   else
527     DEBUG(ResNode->dump(CurDAG));
528   DEBUG(errs() << "\n");
529   return ResNode;
530 }
531
532 /// createMipsISelDag - This pass converts a legalized DAG into a 
533 /// MIPS-specific DAG, ready for instruction scheduling.
534 FunctionPass *llvm::createMipsISelDag(MipsTargetMachine &TM) {
535   return new MipsDAGToDAGISel(TM);
536 }