lib/Target/PIC16/PIC16ISelLowering.h

   1 //===-- PIC16ISelLowering.h - PIC16 DAG Lowering Interface ------*- C++ -*-===//
   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 the interfaces that PIC16 uses to lower LLVM code into a
  11 // selection DAG.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef PIC16ISELLOWERING_H
  16 #define PIC16ISELLOWERING_H
  17
  18 #include "PIC16.h"
  19 #include "PIC16Subtarget.h"
  20 #include "llvm/CodeGen/SelectionDAG.h"
  21 #include "llvm/CodeGen/SelectionDAGISel.h"
  22 #include "llvm/Target/TargetLowering.h"
  23 #include <map>
  24
  25 namespace llvm {
  26   namespace PIC16ISD {
  27     enum NodeType {
  28       // Start the numbering from where ISD NodeType finishes.
  29       FIRST_NUMBER = ISD::BUILTIN_OP_END,
  30
  31       Lo,            // Low 8-bits of GlobalAddress.
  32       Hi,            // High 8-bits of GlobalAddress.
  33       PIC16Load,
  34       PIC16LdArg,   // This is replica of PIC16Load but used to load function
  35                     // arguments and is being used for facilitating for some
  36                     // store removal optimizations.
  37
  38       PIC16LdWF,
  39       PIC16Store,
  40       PIC16StWF,
  41       Banksel,
  42       MTLO,          // Move to low part of FSR
  43       MTHI,          // Move to high part of FSR
  44       MTPCLATH,      // Move to PCLATCH
  45       PIC16Connect,  // General connector for PIC16 nodes
  46       BCF,
  47       LSLF,          // PIC16 Logical shift left
  48       LRLF,          // PIC16 Logical shift right
  49       RLF,           // Rotate left through carry
  50       RRF,           // Rotate right through carry
  51       CALL,          // PIC16 Call instruction
  52       CALLW,         // PIC16 CALLW instruction
  53       SUBCC,         // Compare for equality or inequality.
  54       SELECT_ICC,    // Psuedo to be caught in schedular and expanded to brcond.
  55       BRCOND,        // Conditional branch.
  56       RET,           // Return.
  57       Dummy
  58     };
  59
  60     // Keep track of different address spaces.
  61     enum AddressSpace {
  62       RAM_SPACE = 0,   // RAM address space
  63       ROM_SPACE = 1    // ROM address space number is 1
  64     };
  65     enum PIC16Libcall {
  66       MUL_I8 = RTLIB::UNKNOWN_LIBCALL + 1,
  67       SRA_I8,
  68       SLL_I8,
  69       SRL_I8,
  70       PIC16UnknownCall
  71     };
  72   }
  73
  74
  75   //===--------------------------------------------------------------------===//
  76   // TargetLowering Implementation
  77   //===--------------------------------------------------------------------===//
  78   class PIC16TargetLowering : public TargetLowering {
  79   public:
  80     explicit PIC16TargetLowering(PIC16TargetMachine &TM);
  81
  82     /// getTargetNodeName - This method returns the name of a target specific
  83     /// DAG node.
  84     virtual const char *getTargetNodeName(unsigned Opcode) const;
  85     /// getSetCCResultType - Return the ISD::SETCC ValueType
  86     virtual MVT::SimpleValueType getSetCCResultType(EVT ValType) const;
  87     SDValue LowerShift(SDValue Op, SelectionDAG &DAG);
  88     SDValue LowerMUL(SDValue Op, SelectionDAG &DAG);
  89     SDValue LowerADD(SDValue Op, SelectionDAG &DAG);
  90     SDValue LowerSUB(SDValue Op, SelectionDAG &DAG);
  91     SDValue LowerBinOp(SDValue Op, SelectionDAG &DAG);
  92     // Call returns
  93     SDValue
  94     LowerDirectCallReturn(SDValue RetLabel, SDValue Chain, SDValue InFlag,
  95                           const SmallVectorImpl<ISD::InputArg> &Ins,
  96                           DebugLoc dl, SelectionDAG &DAG,
  97                           SmallVectorImpl<SDValue> &InVals);
  98     SDValue
  99     LowerIndirectCallReturn(SDValue Chain, SDValue InFlag,
 100                              SDValue DataAddr_Lo, SDValue DataAddr_Hi,
 101                             const SmallVectorImpl<ISD::InputArg> &Ins,
 102                             DebugLoc dl, SelectionDAG &DAG,
 103                             SmallVectorImpl<SDValue> &InVals);
 104
 105     // Call arguments
 106     SDValue
 107     LowerDirectCallArguments(SDValue ArgLabel, SDValue Chain, SDValue InFlag,
 108                              const SmallVectorImpl<ISD::OutputArg> &Outs,
 109                              DebugLoc dl, SelectionDAG &DAG);
 110
 111     SDValue
 112     LowerIndirectCallArguments(SDValue Chain, SDValue InFlag,
 113                                SDValue DataAddr_Lo, SDValue DataAddr_Hi,
 114                                const SmallVectorImpl<ISD::OutputArg> &Outs,
 115                                const SmallVectorImpl<ISD::InputArg> &Ins,
 116                                DebugLoc dl, SelectionDAG &DAG);
 117
 118     SDValue LowerBR_CC(SDValue Op, SelectionDAG &DAG);
 119     SDValue LowerSELECT_CC(SDValue Op, SelectionDAG &DAG);
 120     SDValue getPIC16Cmp(SDValue LHS, SDValue RHS, unsigned OrigCC, SDValue &CC,
 121                         SelectionDAG &DAG, DebugLoc dl);
 122     virtual MachineBasicBlock *EmitInstrWithCustomInserter(MachineInstr *MI,
 123                                                          MachineBasicBlock *MBB,
 124                     DenseMap<MachineBasicBlock*, MachineBasicBlock*> *EM) const;
 125
 126
 127     virtual SDValue LowerOperation(SDValue Op, SelectionDAG &DAG);
 128     virtual void ReplaceNodeResults(SDNode *N,
 129                                     SmallVectorImpl<SDValue> &Results,
 130                                     SelectionDAG &DAG);
 131     virtual void LowerOperationWrapper(SDNode *N,
 132                                        SmallVectorImpl<SDValue> &Results,
 133                                        SelectionDAG &DAG);
 134
 135     virtual SDValue
 136     LowerFormalArguments(SDValue Chain,
 137                          CallingConv::ID CallConv,
 138                          bool isVarArg,
 139                          const SmallVectorImpl<ISD::InputArg> &Ins,
 140                          DebugLoc dl, SelectionDAG &DAG,
 141                          SmallVectorImpl<SDValue> &InVals);
 142
 143     virtual SDValue
 144       LowerCall(SDValue Chain, SDValue Callee,
 145                 CallingConv::ID CallConv, bool isVarArg, bool isTailCall,
 146                 const SmallVectorImpl<ISD::OutputArg> &Outs,
 147                 const SmallVectorImpl<ISD::InputArg> &Ins,
 148                 DebugLoc dl, SelectionDAG &DAG,
 149                 SmallVectorImpl<SDValue> &InVals);
 150
 151     virtual SDValue
 152       LowerReturn(SDValue Chain,
 153                   CallingConv::ID CallConv, bool isVarArg,
 154                   const SmallVectorImpl<ISD::OutputArg> &Outs,
 155                   DebugLoc dl, SelectionDAG &DAG);
 156
 157     SDValue ExpandStore(SDNode *N, SelectionDAG &DAG);
 158     SDValue ExpandLoad(SDNode *N, SelectionDAG &DAG);
 159     SDValue ExpandGlobalAddress(SDNode *N, SelectionDAG &DAG);
 160     SDValue ExpandExternalSymbol(SDNode *N, SelectionDAG &DAG);
 161     SDValue ExpandFrameIndex(SDNode *N, SelectionDAG &DAG);
 162
 163     SDValue PerformDAGCombine(SDNode *N, DAGCombinerInfo &DCI) const;
 164     SDValue PerformPIC16LoadCombine(SDNode *N, DAGCombinerInfo &DCI) const;
 165     SDValue PerformStoreCombine(SDNode *N, DAGCombinerInfo &DCI) const;
 166
 167     // This function returns the Tmp Offset for FrameIndex. If any TmpOffset
 168     // already exists for the FI then it returns the same else it creates the
 169     // new offset and returns.
 170     unsigned GetTmpOffsetForFI(unsigned FI, unsigned slot_size);
 171     void ResetTmpOffsetMap() { FiTmpOffsetMap.clear(); SetTmpSize(0); }
 172     void InitReservedFrameCount(const Function *F);
 173
 174     // Return the size of Tmp variable
 175     unsigned GetTmpSize() { return TmpSize; }
 176     void SetTmpSize(unsigned Size) { TmpSize = Size; }
 177
 178     /// getFunctionAlignment - Return the Log2 alignment of this function.
 179     virtual unsigned getFunctionAlignment(const Function *) const {
 180       // FIXME: The function never seems to be aligned.
 181       return 1;
 182     }
 183   private:
 184     // If the Node is a BUILD_PAIR representing a direct Address,
 185     // then this function will return true.
 186     bool isDirectAddress(const SDValue &Op);
 187
 188     // If the Node is a DirectAddress in ROM_SPACE then this
 189     // function will return true
 190     bool isRomAddress(const SDValue &Op);
 191
 192     // Extract the Lo and Hi component of Op.
 193     void GetExpandedParts(SDValue Op, SelectionDAG &DAG, SDValue &Lo,
 194                           SDValue &Hi);
 195
 196
 197     // Load pointer can be a direct or indirect address. In PIC16 direct
 198     // addresses need Banksel and Indirect addresses need to be loaded to
 199     // FSR first. Handle address specific cases here.
 200     void LegalizeAddress(SDValue Ptr, SelectionDAG &DAG, SDValue &Chain,
 201                          SDValue &NewPtr, unsigned &Offset, DebugLoc dl);
 202
 203     // FrameIndex should be broken down into ExternalSymbol and FrameOffset.
 204     void LegalizeFrameIndex(SDValue Op, SelectionDAG &DAG, SDValue &ES,
 205                             int &Offset);
 206
 207     // For indirect calls data address of the callee frame need to be
 208     // extracted. This function fills the arguments DataAddr_Lo and
 209     // DataAddr_Hi with the address of the callee frame.
 210     void GetDataAddress(DebugLoc dl, SDValue Callee, SDValue &Chain,
 211                         SDValue &DataAddr_Lo, SDValue &DataAddr_Hi,
 212                         SelectionDAG &DAG);
 213
 214     // We can not have both operands of a binary operation in W.
 215     // This function is used to put one operand on stack and generate a load.
 216     SDValue ConvertToMemOperand(SDValue Op, SelectionDAG &DAG, DebugLoc dl);
 217
 218     // This function checks if we need to put an operand of an operation on
 219     // stack and generate a load or not.
 220     // DAG parameter is required to access DAG information during
 221     // analysis.
 222     bool NeedToConvertToMemOp(SDValue Op, unsigned &MemOp, SelectionDAG &DAG);
 223
 224     /// Subtarget - Keep a pointer to the PIC16Subtarget around so that we can
 225     /// make the right decision when generating code for different targets.
 226     const PIC16Subtarget *Subtarget;
 227
 228
 229     // Extending the LIB Call framework of LLVM
 230     // to hold the names of PIC16Libcalls.
 231     const char *PIC16LibcallNames[PIC16ISD::PIC16UnknownCall];
 232
 233     // To set and retrieve the lib call names.
 234     void setPIC16LibcallName(PIC16ISD::PIC16Libcall Call, const char *Name);
 235     const char *getPIC16LibcallName(PIC16ISD::PIC16Libcall Call);
 236
 237     // Make PIC16 Libcall.
 238     SDValue MakePIC16Libcall(PIC16ISD::PIC16Libcall Call, EVT RetVT,
 239                              const SDValue *Ops, unsigned NumOps, bool isSigned,
 240                              SelectionDAG &DAG, DebugLoc dl);
 241
 242     // Check if operation has a direct load operand.
 243     inline bool isDirectLoad(const SDValue Op);
 244
 245   public:
 246     // Keep a pointer to SelectionDAGISel to access its public
 247     // interface (It is required during legalization)
 248     SelectionDAGISel   *ISel;
 249
 250   private:
 251     // The frameindexes generated for spill/reload are stack based.
 252     // This maps maintain zero based indexes for these FIs.
 253     std::map<unsigned, unsigned> FiTmpOffsetMap;
 254     unsigned TmpSize;
 255
 256     // These are the frames for return value and argument passing
 257     // These FrameIndices will be expanded to foo.frame external symbol
 258     // and all others will be expanded to foo.tmp external symbol.
 259     unsigned ReservedFrameCount;
 260   };
 261 } // namespace llvm
 262
 263 #endif // PIC16ISELLOWERING_H