lib/CodeGen/SelectionDAG/LegalizeTypes.h

   1 //===-- LegalizeTypes.h - Definition of the DAG Type Legalizer class ------===//
   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 DAGTypeLegalizer class.  This is a private interface
  11 // shared between the code that implements the SelectionDAG::LegalizeTypes
  12 // method.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef SELECTIONDAG_LEGALIZETYPES_H
  17 #define SELECTIONDAG_LEGALIZETYPES_H
  18
  19 #define DEBUG_TYPE "legalize-types"
  20 #include "llvm/CodeGen/SelectionDAG.h"
  21 #include "llvm/Target/TargetLowering.h"
  22 #include "llvm/ADT/DenseMap.h"
  23 #include "llvm/Support/Compiler.h"
  24 #include "llvm/Support/Debug.h"
  25
  26 namespace llvm {
  27
  28 //===----------------------------------------------------------------------===//
  29 /// DAGTypeLegalizer - This takes an arbitrary SelectionDAG as input and
  30 /// hacks on it until the target machine can handle it.  This involves
  31 /// eliminating value sizes the machine cannot handle (promoting small sizes to
  32 /// large sizes or splitting up large values into small values) as well as
  33 /// eliminating operations the machine cannot handle.
  34 ///
  35 /// This code also does a small amount of optimization and recognition of idioms
  36 /// as part of its processing.  For example, if a target does not support a
  37 /// 'setcc' instruction efficiently, but does support 'brcc' instruction, this
  38 /// will attempt merge setcc and brc instructions into brcc's.
  39 ///
  40 class VISIBILITY_HIDDEN DAGTypeLegalizer {
  41   TargetLowering &TLI;
  42   SelectionDAG &DAG;
  43 public:
  44   // NodeIDFlags - This pass uses the NodeID on the SDNodes to hold information
  45   // about the state of the node.  The enum has all the values.
  46   enum NodeIDFlags {
  47     /// ReadyToProcess - All operands have been processed, so this node is ready
  48     /// to be handled.
  49     ReadyToProcess = 0,
  50
  51     /// NewNode - This is a new node that was created in the process of
  52     /// legalizing some other node.
  53     NewNode = -1,
  54
  55     /// Processed - This is a node that has already been processed.
  56     Processed = -2
  57
  58     // 1+ - This is a node which has this many unlegalized operands.
  59   };
  60 private:
  61   enum LegalizeAction {
  62     Legal,      // The target natively supports this type.
  63     Promote,    // This type should be executed in a larger type.
  64     Expand,     // This type should be split into two types of half the size.
  65     FloatToInt, // Convert a floating point type to an integer of the same size.
  66     Scalarize,  // Replace this one-element vector type with its element type.
  67     Split       // This vector type should be split into smaller vectors.
  68   };
  69
  70   /// ValueTypeActions - This is a bitvector that contains two bits for each
  71   /// simple value type, where the two bits correspond to the LegalizeAction
  72   /// enum from TargetLowering.  This can be queried with "getTypeAction(VT)".
  73   TargetLowering::ValueTypeActionImpl ValueTypeActions;
  74
  75   /// getTypeAction - Return how we should legalize values of this type, either
  76   /// it is already legal, or we need to promote it to a larger integer type, or
  77   /// we need to expand it into multiple registers of a smaller integer type, or
  78   /// we need to scalarize a one-element vector type into the element type, or
  79   /// we need to split a vector type into smaller vector types.
  80   LegalizeAction getTypeAction(MVT VT) const {
  81     switch (ValueTypeActions.getTypeAction(VT)) {
  82     default:
  83       assert(false && "Unknown legalize action!");
  84     case TargetLowering::Legal:
  85       return Legal;
  86     case TargetLowering::Promote:
  87       return Promote;
  88     case TargetLowering::Expand:
  89       // Expand can mean
  90       // 1) split scalar in half, 2) convert a float to an integer,
  91       // 3) scalarize a single-element vector, 4) split a vector in two.
  92       if (!VT.isVector()) {
  93         if (VT.getSizeInBits() == TLI.getTypeToTransformTo(VT).getSizeInBits())
  94           return FloatToInt;
  95         else
  96           return Expand;
  97       } else if (VT.getVectorNumElements() == 1) {
  98         return Scalarize;
  99       } else {
 100         return Split;
 101       }
 102     }
 103   }
 104
 105   /// isTypeLegal - Return true if this type is legal on this target.
 106   bool isTypeLegal(MVT VT) const {
 107     return ValueTypeActions.getTypeAction(VT) == TargetLowering::Legal;
 108   }
 109
 110   /// PromotedNodes - For nodes that are below legal width, this map indicates
 111   /// what promoted value to use.
 112   DenseMap<SDOperand, SDOperand> PromotedNodes;
 113
 114   /// ExpandedNodes - For nodes that need to be expanded this map indicates
 115   /// which operands are the expanded version of the input.
 116   DenseMap<SDOperand, std::pair<SDOperand, SDOperand> > ExpandedNodes;
 117
 118   /// FloatToIntedNodes - For floating point nodes converted to integers of
 119   /// the same size, this map indicates the converted value to use.
 120   DenseMap<SDOperand, SDOperand> FloatToIntedNodes;
 121
 122   /// ScalarizedNodes - For nodes that are <1 x ty>, this map indicates the
 123   /// scalar value of type 'ty' to use.
 124   DenseMap<SDOperand, SDOperand> ScalarizedNodes;
 125
 126   /// SplitNodes - For nodes that need to be split this map indicates
 127   /// which operands are the expanded version of the input.
 128   DenseMap<SDOperand, std::pair<SDOperand, SDOperand> > SplitNodes;
 129
 130   /// ReplacedNodes - For nodes that have been replaced with another,
 131   /// indicates the replacement node to use.
 132   DenseMap<SDOperand, SDOperand> ReplacedNodes;
 133
 134   /// Worklist - This defines a worklist of nodes to process.  In order to be
 135   /// pushed onto this worklist, all operands of a node must have already been
 136   /// processed.
 137   SmallVector<SDNode*, 128> Worklist;
 138
 139 public:
 140   explicit DAGTypeLegalizer(SelectionDAG &dag)
 141     : TLI(dag.getTargetLoweringInfo()), DAG(dag),
 142     ValueTypeActions(TLI.getValueTypeActions()) {
 143     assert(MVT::LAST_VALUETYPE <= 32 &&
 144            "Too many value types for ValueTypeActions to hold!");
 145   }
 146
 147   void run();
 148
 149   /// ReanalyzeNode - Recompute the NodeID and correct processed operands
 150   /// for the specified node, adding it to the worklist if ready.
 151   void ReanalyzeNode(SDNode *N) {
 152     N->setNodeId(NewNode);
 153     AnalyzeNewNode(N);
 154   }
 155
 156 private:
 157   void AnalyzeNewNode(SDNode *&N);
 158
 159   void ReplaceValueWith(SDOperand From, SDOperand To);
 160   void ReplaceNodeWith(SDNode *From, SDNode *To);
 161
 162   void RemapNode(SDOperand &N);
 163
 164   // Common routines.
 165   SDOperand BitConvertToInteger(SDOperand Op);
 166   SDOperand CreateStackStoreLoad(SDOperand Op, MVT DestVT);
 167   SDOperand JoinIntegers(SDOperand Lo, SDOperand Hi);
 168   void SplitInteger(SDOperand Op, SDOperand &Lo, SDOperand &Hi);
 169   void SplitInteger(SDOperand Op, MVT LoVT, MVT HiVT,
 170                     SDOperand &Lo, SDOperand &Hi);
 171   SDOperand MakeLibCall(RTLIB::Libcall LC, MVT RetVT,
 172                         const SDOperand *Ops, unsigned NumOps, bool isSigned);
 173
 174   //===--------------------------------------------------------------------===//
 175   // Promotion Support: LegalizeTypesPromote.cpp
 176   //===--------------------------------------------------------------------===//
 177
 178   SDOperand GetPromotedOp(SDOperand Op) {
 179     SDOperand &PromotedOp = PromotedNodes[Op];
 180     RemapNode(PromotedOp);
 181     assert(PromotedOp.Val && "Operand wasn't promoted?");
 182     return PromotedOp;
 183   }
 184   void SetPromotedOp(SDOperand Op, SDOperand Result);
 185
 186   /// GetPromotedZExtOp - Get a promoted operand and zero extend it to the final
 187   /// size.
 188   SDOperand GetPromotedZExtOp(SDOperand Op) {
 189     MVT OldVT = Op.getValueType();
 190     Op = GetPromotedOp(Op);
 191     return DAG.getZeroExtendInReg(Op, OldVT);
 192   }
 193
 194   // Result Promotion.
 195   void PromoteResult(SDNode *N, unsigned ResNo);
 196   SDOperand PromoteResult_BIT_CONVERT(SDNode *N);
 197   SDOperand PromoteResult_BUILD_PAIR(SDNode *N);
 198   SDOperand PromoteResult_Constant(SDNode *N);
 199   SDOperand PromoteResult_CTLZ(SDNode *N);
 200   SDOperand PromoteResult_CTPOP(SDNode *N);
 201   SDOperand PromoteResult_CTTZ(SDNode *N);
 202   SDOperand PromoteResult_EXTRACT_VECTOR_ELT(SDNode *N);
 203   SDOperand PromoteResult_FP_ROUND(SDNode *N);
 204   SDOperand PromoteResult_FP_TO_XINT(SDNode *N);
 205   SDOperand PromoteResult_INT_EXTEND(SDNode *N);
 206   SDOperand PromoteResult_LOAD(LoadSDNode *N);
 207   SDOperand PromoteResult_SDIV(SDNode *N);
 208   SDOperand PromoteResult_SELECT   (SDNode *N);
 209   SDOperand PromoteResult_SELECT_CC(SDNode *N);
 210   SDOperand PromoteResult_SETCC(SDNode *N);
 211   SDOperand PromoteResult_SHL(SDNode *N);
 212   SDOperand PromoteResult_SimpleIntBinOp(SDNode *N);
 213   SDOperand PromoteResult_SRA(SDNode *N);
 214   SDOperand PromoteResult_SRL(SDNode *N);
 215   SDOperand PromoteResult_TRUNCATE(SDNode *N);
 216   SDOperand PromoteResult_UDIV(SDNode *N);
 217   SDOperand PromoteResult_UNDEF(SDNode *N);
 218
 219   // Operand Promotion.
 220   bool PromoteOperand(SDNode *N, unsigned OperandNo);
 221   SDOperand PromoteOperand_ANY_EXTEND(SDNode *N);
 222   SDOperand PromoteOperand_BUILD_PAIR(SDNode *N);
 223   SDOperand PromoteOperand_BR_CC(SDNode *N, unsigned OpNo);
 224   SDOperand PromoteOperand_BRCOND(SDNode *N, unsigned OpNo);
 225   SDOperand PromoteOperand_BUILD_VECTOR(SDNode *N);
 226   SDOperand PromoteOperand_FP_EXTEND(SDNode *N);
 227   SDOperand PromoteOperand_FP_ROUND(SDNode *N);
 228   SDOperand PromoteOperand_INT_TO_FP(SDNode *N);
 229   SDOperand PromoteOperand_INSERT_VECTOR_ELT(SDNode *N, unsigned OpNo);
 230   SDOperand PromoteOperand_MEMBARRIER(SDNode *N);
 231   SDOperand PromoteOperand_RET(SDNode *N, unsigned OpNo);
 232   SDOperand PromoteOperand_SELECT(SDNode *N, unsigned OpNo);
 233   SDOperand PromoteOperand_SETCC(SDNode *N, unsigned OpNo);
 234   SDOperand PromoteOperand_SIGN_EXTEND(SDNode *N);
 235   SDOperand PromoteOperand_STORE(StoreSDNode *N, unsigned OpNo);
 236   SDOperand PromoteOperand_TRUNCATE(SDNode *N);
 237   SDOperand PromoteOperand_ZERO_EXTEND(SDNode *N);
 238
 239   void PromoteSetCCOperands(SDOperand &LHS,SDOperand &RHS, ISD::CondCode Code);
 240
 241   //===--------------------------------------------------------------------===//
 242   // Expansion Support: LegalizeTypesExpand.cpp
 243   //===--------------------------------------------------------------------===//
 244
 245   void GetExpandedOp(SDOperand Op, SDOperand &Lo, SDOperand &Hi);
 246   void SetExpandedOp(SDOperand Op, SDOperand Lo, SDOperand Hi);
 247
 248   // Result Expansion.
 249   void ExpandResult(SDNode *N, unsigned ResNo);
 250   void ExpandResult_ANY_EXTEND (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 251   void ExpandResult_AssertZext (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 252   void ExpandResult_BIT_CONVERT(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 253   void ExpandResult_BUILD_PAIR (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 254   void ExpandResult_Constant   (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 255   void ExpandResult_CTLZ       (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 256   void ExpandResult_CTPOP      (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 257   void ExpandResult_CTTZ       (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 258   void ExpandResult_EXTRACT_VECTOR_ELT(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 259   void ExpandResult_LOAD       (LoadSDNode *N, SDOperand &Lo, SDOperand &Hi);
 260   void ExpandResult_MERGE_VALUES(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 261   void ExpandResult_SIGN_EXTEND(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 262   void ExpandResult_SIGN_EXTEND_INREG(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 263   void ExpandResult_TRUNCATE   (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 264   void ExpandResult_UNDEF      (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 265   void ExpandResult_ZERO_EXTEND(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 266   void ExpandResult_FP_TO_SINT (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 267   void ExpandResult_FP_TO_UINT (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 268
 269   void ExpandResult_Logical    (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 270   void ExpandResult_BSWAP      (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 271   void ExpandResult_ADDSUB     (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 272   void ExpandResult_ADDSUBC    (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 273   void ExpandResult_ADDSUBE    (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 274   void ExpandResult_SELECT     (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 275   void ExpandResult_SELECT_CC  (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 276   void ExpandResult_MUL        (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 277   void ExpandResult_SDIV       (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 278   void ExpandResult_SREM       (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 279   void ExpandResult_UDIV       (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 280   void ExpandResult_UREM       (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 281   void ExpandResult_Shift      (SDNode *N, SDOperand &Lo, SDOperand &Hi);
 282
 283   void ExpandShiftByConstant(SDNode *N, unsigned Amt,
 284                              SDOperand &Lo, SDOperand &Hi);
 285   bool ExpandShiftWithKnownAmountBit(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 286
 287   // Operand Expansion.
 288   bool ExpandOperand(SDNode *N, unsigned OperandNo);
 289   SDOperand ExpandOperand_BIT_CONVERT(SDNode *N);
 290   SDOperand ExpandOperand_BR_CC(SDNode *N);
 291   SDOperand ExpandOperand_BUILD_VECTOR(SDNode *N);
 292   SDOperand ExpandOperand_EXTRACT_ELEMENT(SDNode *N);
 293   SDOperand ExpandOperand_SETCC(SDNode *N);
 294   SDOperand ExpandOperand_SINT_TO_FP(SDOperand Source, MVT DestTy);
 295   SDOperand ExpandOperand_STORE(StoreSDNode *N, unsigned OpNo);
 296   SDOperand ExpandOperand_TRUNCATE(SDNode *N);
 297   SDOperand ExpandOperand_UINT_TO_FP(SDOperand Source, MVT DestTy);
 298
 299   void ExpandSetCCOperands(SDOperand &NewLHS, SDOperand &NewRHS,
 300                            ISD::CondCode &CCCode);
 301
 302   //===--------------------------------------------------------------------===//
 303   // Float to Integer Conversion Support: LegalizeTypesFloatToInt.cpp
 304   //===--------------------------------------------------------------------===//
 305
 306   SDOperand GetIntegerOp(SDOperand Op) {
 307     SDOperand &IntegerOp = FloatToIntedNodes[Op];
 308     RemapNode(IntegerOp);
 309     assert(IntegerOp.Val && "Operand wasn't converted to integer?");
 310     return IntegerOp;
 311   }
 312   void SetIntegerOp(SDOperand Op, SDOperand Result);
 313
 314   // Result Float to Integer Conversion.
 315   void FloatToIntResult(SDNode *N, unsigned OpNo);
 316   SDOperand FloatToIntRes_BIT_CONVERT(SDNode *N);
 317   SDOperand FloatToIntRes_BUILD_PAIR(SDNode *N);
 318   SDOperand FloatToIntRes_ConstantFP(ConstantFPSDNode *N);
 319   SDOperand FloatToIntRes_FADD(SDNode *N);
 320   SDOperand FloatToIntRes_FCOPYSIGN(SDNode *N);
 321   SDOperand FloatToIntRes_FMUL(SDNode *N);
 322   SDOperand FloatToIntRes_FSUB(SDNode *N);
 323   SDOperand FloatToIntRes_LOAD(SDNode *N);
 324   SDOperand FloatToIntRes_XINT_TO_FP(SDNode *N);
 325
 326   // Operand Float to Integer Conversion.
 327   bool FloatToIntOperand(SDNode *N, unsigned OpNo);
 328   SDOperand FloatToIntOp_BIT_CONVERT(SDNode *N);
 329
 330   //===--------------------------------------------------------------------===//
 331   // Scalarization Support: LegalizeTypesScalarize.cpp
 332   //===--------------------------------------------------------------------===//
 333
 334   SDOperand GetScalarizedOp(SDOperand Op) {
 335     SDOperand &ScalarOp = ScalarizedNodes[Op];
 336     RemapNode(ScalarOp);
 337     assert(ScalarOp.Val && "Operand wasn't scalarized?");
 338     return ScalarOp;
 339   }
 340   void SetScalarizedOp(SDOperand Op, SDOperand Result);
 341
 342   // Result Vector Scalarization: <1 x ty> -> ty.
 343   void ScalarizeResult(SDNode *N, unsigned OpNo);
 344   SDOperand ScalarizeRes_BinOp(SDNode *N);
 345   SDOperand ScalarizeRes_UnaryOp(SDNode *N);
 346
 347   SDOperand ScalarizeRes_BIT_CONVERT(SDNode *N);
 348   SDOperand ScalarizeRes_FPOWI(SDNode *N);
 349   SDOperand ScalarizeRes_INSERT_VECTOR_ELT(SDNode *N);
 350   SDOperand ScalarizeRes_LOAD(LoadSDNode *N);
 351   SDOperand ScalarizeRes_SELECT(SDNode *N);
 352   SDOperand ScalarizeRes_UNDEF(SDNode *N);
 353   SDOperand ScalarizeRes_VECTOR_SHUFFLE(SDNode *N);
 354
 355   // Operand Vector Scalarization: <1 x ty> -> ty.
 356   bool ScalarizeOperand(SDNode *N, unsigned OpNo);
 357   SDOperand ScalarizeOp_BIT_CONVERT(SDNode *N);
 358   SDOperand ScalarizeOp_EXTRACT_VECTOR_ELT(SDNode *N);
 359   SDOperand ScalarizeOp_STORE(StoreSDNode *N, unsigned OpNo);
 360
 361   //===--------------------------------------------------------------------===//
 362   // Vector Splitting Support: LegalizeTypesSplit.cpp
 363   //===--------------------------------------------------------------------===//
 364
 365   void GetSplitOp(SDOperand Op, SDOperand &Lo, SDOperand &Hi);
 366   void SetSplitOp(SDOperand Op, SDOperand Lo, SDOperand Hi);
 367
 368   // Result Vector Splitting: <128 x ty> -> 2 x <64 x ty>.
 369   void SplitResult(SDNode *N, unsigned OpNo);
 370
 371   void SplitRes_UNDEF(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 372   void SplitRes_LOAD(LoadSDNode *N, SDOperand &Lo, SDOperand &Hi);
 373   void SplitRes_BUILD_PAIR(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 374   void SplitRes_INSERT_VECTOR_ELT(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 375   void SplitRes_VECTOR_SHUFFLE(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 376
 377   void SplitRes_BUILD_VECTOR(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 378   void SplitRes_CONCAT_VECTORS(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 379   void SplitRes_BIT_CONVERT(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 380   void SplitRes_UnOp(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 381   void SplitRes_BinOp(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 382   void SplitRes_FPOWI(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 383   void SplitRes_SELECT(SDNode *N, SDOperand &Lo, SDOperand &Hi);
 384
 385   // Operand Vector Splitting: <128 x ty> -> 2 x <64 x ty>.
 386   bool SplitOperand(SDNode *N, unsigned OpNo);
 387
 388   SDOperand SplitOp_BIT_CONVERT(SDNode *N);
 389   SDOperand SplitOp_EXTRACT_SUBVECTOR(SDNode *N);
 390   SDOperand SplitOp_EXTRACT_VECTOR_ELT(SDNode *N);
 391   SDOperand SplitOp_RET(SDNode *N, unsigned OpNo);
 392   SDOperand SplitOp_STORE(StoreSDNode *N, unsigned OpNo);
 393   SDOperand SplitOp_VECTOR_SHUFFLE(SDNode *N, unsigned OpNo);
 394
 395 public:
 396   void SanityCheck(SDNode *N);
 397 };
 398
 399 } // end namespace llvm.
 400
 401 #endif