include/llvm/Target/TargetInstrInfo.h

   1 //===-- llvm/Target/InstrInfo.h - Target Instruction Information --*-C++-*-==//
   2 //
   3 // This file describes the target machine instructions to the code generator.
   4 //
   5 //===---------------------------------------------------------------------===//
   6
   7 #ifndef LLVM_TARGET_MACHINEINSTRINFO_H
   8 #define LLVM_TARGET_MACHINEINSTRINFO_H
   9
  10 #include "Support/NonCopyable.h"
  11 #include "Support/DataTypes.h"
  12 #include <string>
  13 #include <vector>
  14
  15 class MachineInstrDescriptor;
  16 class TmpInstruction;
  17 class MachineInstr;
  18 class TargetMachine;
  19 class Value;
  20 class Instruction;
  21 class Function;
  22
  23 //---------------------------------------------------------------------------
  24 // Data types used to define information about a single machine instruction
  25 //---------------------------------------------------------------------------
  26
  27 typedef int MachineOpCode;
  28 typedef int OpCodeMask;
  29 typedef int InstrSchedClass;
  30
  31 const MachineOpCode INVALID_MACHINE_OPCODE = -1;
  32
  33
  34 // Global variable holding an array of descriptors for machine instructions.
  35 // The actual object needs to be created separately for each target machine.
  36 // This variable is initialized and reset by class MachineInstrInfo.
  37 //
  38 // FIXME: This should be a property of the target so that more than one target
  39 // at a time can be active...
  40 //
  41 extern const MachineInstrDescriptor *TargetInstrDescriptors;
  42
  43
  44 //---------------------------------------------------------------------------
  45 // struct MachineInstrDescriptor:
  46 //      Predefined information about each machine instruction.
  47 //      Designed to initialized statically.
  48 //
  49 // class MachineInstructionInfo
  50 //      Interface to description of machine instructions
  51 //
  52 //---------------------------------------------------------------------------
  53
  54
  55 const unsigned int      M_NOP_FLAG              = 1;
  56 const unsigned int      M_BRANCH_FLAG           = 1 << 1;
  57 const unsigned int      M_CALL_FLAG             = 1 << 2;
  58 const unsigned int      M_RET_FLAG              = 1 << 3;
  59 const unsigned int      M_ARITH_FLAG            = 1 << 4;
  60 const unsigned int      M_CC_FLAG               = 1 << 6;
  61 const unsigned int      M_LOGICAL_FLAG          = 1 << 6;
  62 const unsigned int      M_INT_FLAG              = 1 << 7;
  63 const unsigned int      M_FLOAT_FLAG            = 1 << 8;
  64 const unsigned int      M_CONDL_FLAG            = 1 << 9;
  65 const unsigned int      M_LOAD_FLAG             = 1 << 10;
  66 const unsigned int      M_PREFETCH_FLAG         = 1 << 11;
  67 const unsigned int      M_STORE_FLAG            = 1 << 12;
  68 const unsigned int      M_DUMMY_PHI_FLAG        = 1 << 13;
  69 const unsigned int      M_PSEUDO_FLAG           = 1 << 14;
  70
  71
  72 struct MachineInstrDescriptor {
  73   std::string     opCodeString;  // Assembly language mnemonic for the opcode.
  74   int             numOperands;   // Number of args; -1 if variable #args
  75   int             resultPos;     // Position of the result; -1 if no result
  76   unsigned int    maxImmedConst; // Largest +ve constant in IMMMED field or 0.
  77   bool            immedIsSignExtended; // Is IMMED field sign-extended? If so,
  78                                  //   smallest -ve value is -(maxImmedConst+1).
  79   unsigned int    numDelaySlots; // Number of delay slots after instruction
  80   unsigned int    latency;       // Latency in machine cycles
  81   InstrSchedClass schedClass;    // enum  identifying instr sched class
  82   unsigned int    iclass;        // flags identifying machine instr class
  83 };
  84
  85
  86 class MachineInstrInfo : public NonCopyableV {
  87 public:
  88   const TargetMachine& target;
  89
  90 protected:
  91   const MachineInstrDescriptor* desc;   // raw array to allow static init'n
  92   unsigned int descSize;                // number of entries in the desc array
  93   unsigned int numRealOpCodes;          // number of non-dummy op codes
  94
  95 public:
  96   MachineInstrInfo(const TargetMachine& tgt,
  97                    const MachineInstrDescriptor *desc, unsigned descSize,
  98                    unsigned numRealOpCodes);
  99   virtual ~MachineInstrInfo();
 100
 101   unsigned getNumRealOpCodes()  const { return numRealOpCodes; }
 102   unsigned getNumTotalOpCodes() const { return descSize; }
 103
 104   const MachineInstrDescriptor& getDescriptor(MachineOpCode opCode) const {
 105     assert(opCode >= 0 && opCode < (int)descSize);
 106     return desc[opCode];
 107   }
 108
 109   int getNumOperands(MachineOpCode opCode) const {
 110     return getDescriptor(opCode).numOperands;
 111   }
 112
 113   int getResultPos(MachineOpCode opCode) const {
 114     return getDescriptor(opCode).resultPos;
 115   }
 116
 117   unsigned getNumDelaySlots(MachineOpCode opCode) const {
 118     return getDescriptor(opCode).numDelaySlots;
 119   }
 120
 121   InstrSchedClass getSchedClass(MachineOpCode opCode) const {
 122     return getDescriptor(opCode).schedClass;
 123   }
 124
 125   //
 126   // Query instruction class flags according to the machine-independent
 127   // flags listed above.
 128   //
 129   unsigned int getIClass(MachineOpCode opCode) const {
 130     return getDescriptor(opCode).iclass;
 131   }
 132   bool isNop(MachineOpCode opCode) const {
 133     return getDescriptor(opCode).iclass & M_NOP_FLAG;
 134   }
 135   bool isBranch(MachineOpCode opCode) const {
 136     return getDescriptor(opCode).iclass & M_BRANCH_FLAG;
 137   }
 138   bool isCall(MachineOpCode opCode) const {
 139     return getDescriptor(opCode).iclass & M_CALL_FLAG;
 140   }
 141   bool isReturn(MachineOpCode opCode) const {
 142     return getDescriptor(opCode).iclass & M_RET_FLAG;
 143   }
 144   bool isControlFlow(MachineOpCode opCode) const {
 145     return getDescriptor(opCode).iclass & M_BRANCH_FLAG
 146         || getDescriptor(opCode).iclass & M_CALL_FLAG
 147         || getDescriptor(opCode).iclass & M_RET_FLAG;
 148   }
 149   bool isArith(MachineOpCode opCode) const {
 150     return getDescriptor(opCode).iclass & M_RET_FLAG;
 151   }
 152   bool isCCInstr(MachineOpCode opCode) const {
 153     return getDescriptor(opCode).iclass & M_CC_FLAG;
 154   }
 155   bool isLogical(MachineOpCode opCode) const {
 156     return getDescriptor(opCode).iclass & M_LOGICAL_FLAG;
 157   }
 158   bool isIntInstr(MachineOpCode opCode) const {
 159     return getDescriptor(opCode).iclass & M_INT_FLAG;
 160   }
 161   bool isFloatInstr(MachineOpCode opCode) const {
 162     return getDescriptor(opCode).iclass & M_FLOAT_FLAG;
 163   }
 164   bool isConditional(MachineOpCode opCode) const {
 165     return getDescriptor(opCode).iclass & M_CONDL_FLAG;
 166   }
 167   bool isLoad(MachineOpCode opCode) const {
 168     return getDescriptor(opCode).iclass & M_LOAD_FLAG;
 169   }
 170   bool isPrefetch(MachineOpCode opCode) const {
 171     return getDescriptor(opCode).iclass & M_PREFETCH_FLAG;
 172   }
 173   bool isLoadOrPrefetch(MachineOpCode opCode) const {
 174     return getDescriptor(opCode).iclass & M_LOAD_FLAG
 175         || getDescriptor(opCode).iclass & M_PREFETCH_FLAG;
 176   }
 177   bool isStore(MachineOpCode opCode) const {
 178     return getDescriptor(opCode).iclass & M_STORE_FLAG;
 179   }
 180   bool isMemoryAccess(MachineOpCode opCode) const {
 181     return getDescriptor(opCode).iclass & M_LOAD_FLAG
 182         || getDescriptor(opCode).iclass & M_PREFETCH_FLAG
 183         || getDescriptor(opCode).iclass & M_STORE_FLAG;
 184   }
 185   bool isDummyPhiInstr(const MachineOpCode opCode) const {
 186     return getDescriptor(opCode).iclass & M_DUMMY_PHI_FLAG;
 187   }
 188   bool isPseudoInstr(const MachineOpCode opCode) const {
 189     return getDescriptor(opCode).iclass & M_PSEUDO_FLAG;
 190   }
 191
 192   // Check if an instruction can be issued before its operands are ready,
 193   // or if a subsequent instruction that uses its result can be issued
 194   // before the results are ready.
 195   // Default to true since most instructions on many architectures allow this.
 196   //
 197   virtual bool hasOperandInterlock(MachineOpCode opCode) const {
 198     return true;
 199   }
 200
 201   virtual bool hasResultInterlock(MachineOpCode opCode) const {
 202     return true;
 203   }
 204
 205   //
 206   // Latencies for individual instructions and instruction pairs
 207   //
 208   virtual int minLatency(MachineOpCode opCode) const {
 209     return getDescriptor(opCode).latency;
 210   }
 211
 212   virtual int maxLatency(MachineOpCode opCode) const {
 213     return getDescriptor(opCode).latency;
 214   }
 215
 216   //
 217   // Which operand holds an immediate constant?  Returns -1 if none
 218   //
 219   virtual int getImmedConstantPos(MachineOpCode opCode) const {
 220     return -1; // immediate position is machine specific, so say -1 == "none"
 221   }
 222
 223   // Check if the specified constant fits in the immediate field
 224   // of this machine instruction
 225   //
 226   virtual bool constantFitsInImmedField(MachineOpCode opCode,
 227                                         int64_t intValue) const;
 228
 229   // Return the largest +ve constant that can be held in the IMMMED field
 230   // of this machine instruction.
 231   // isSignExtended is set to true if the value is sign-extended before use
 232   // (this is true for all immediate fields in SPARC instructions).
 233   // Return 0 if the instruction has no IMMED field.
 234   //
 235   virtual uint64_t maxImmedConstant(MachineOpCode opCode,
 236                                     bool &isSignExtended) const {
 237     isSignExtended = getDescriptor(opCode).immedIsSignExtended;
 238     return getDescriptor(opCode).maxImmedConst;
 239   }
 240
 241   //-------------------------------------------------------------------------
 242   // Code generation support for creating individual machine instructions
 243   //-------------------------------------------------------------------------
 244
 245   // Create an instruction sequence to put the constant `val' into
 246   // the virtual register `dest'.  `val' may be a Constant or a
 247   // GlobalValue, viz., the constant address of a global variable or function.
 248   // The generated instructions are returned in `minstrVec'.
 249   // Any temp. registers (TmpInstruction) created are returned in `tempVec'.
 250   //
 251   virtual void  CreateCodeToLoadConst(Function* method,
 252                                       Value* val,
 253                                       Instruction* dest,
 254                                       std::vector<MachineInstr*>& minstrVec,
 255                                       std::vector<TmpInstruction*> &) const = 0;
 256
 257   // Create an instruction sequence to copy an integer value `val'
 258   // to a floating point value `dest' by copying to memory and back.
 259   // val must be an integral type.  dest must be a Float or Double.
 260   // The generated instructions are returned in `minstrVec'.
 261   // Any temp. registers (TmpInstruction) created are returned in `tempVec'.
 262   //
 263   virtual void  CreateCodeToCopyIntToFloat(Function* method,
 264                                            Value* val,
 265                                            Instruction* dest,
 266                                            std::vector<MachineInstr*>& minstVec,
 267                                            std::vector<TmpInstruction*>& tmpVec,
 268                                            TargetMachine& target) const = 0;
 269
 270   // Similarly, create an instruction sequence to copy an FP value
 271   // `val' to an integer value `dest' by copying to memory and back.
 272   // See the previous function for information about return values.
 273   //
 274   virtual void  CreateCodeToCopyFloatToInt(Function* method,
 275                                            Value* val,
 276                                            Instruction* dest,
 277                                            std::vector<MachineInstr*>& minstVec,
 278                                            std::vector<TmpInstruction*>& tmpVec,
 279                                            TargetMachine& target) const = 0;
 280
 281
 282   // create copy instruction(s)
 283   virtual void CreateCopyInstructionsByType(const TargetMachine& target,
 284                                             Function* method,
 285                                             Value* src,
 286                                             Instruction* dest,
 287                                             std::vector<MachineInstr*>& minstrVec)
 288                                                                     const = 0;
 289 };
 290
 291 #endif