utils/TableGen/CodeGenInstruction.h

   1 //===- CodeGenInstruction.h - Instruction Class Wrapper ---------*- 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 a wrapper class for the 'Instruction' TableGen class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef CODEGEN_INSTRUCTION_H
  15 #define CODEGEN_INSTRUCTION_H
  16
  17 #include "llvm/CodeGen/ValueTypes.h"
  18 #include <string>
  19 #include <vector>
  20 #include <utility>
  21
  22 namespace llvm {
  23   class Record;
  24   class DagInit;
  25
  26   class CodeGenInstruction {
  27   public:
  28     Record *TheDef;            // The actual record defining this instruction.
  29     std::string Namespace;     // The namespace the instruction is in.
  30
  31     /// AsmString - The format string used to emit a .s file for the
  32     /// instruction.
  33     std::string AsmString;
  34
  35     class ConstraintInfo {
  36       enum { None, EarlyClobber, Tied } Kind;
  37       unsigned OtherTiedOperand;
  38     public:
  39       ConstraintInfo() : Kind(None) {}
  40
  41       static ConstraintInfo getEarlyClobber() {
  42         ConstraintInfo I;
  43         I.Kind = EarlyClobber;
  44         I.OtherTiedOperand = 0;
  45         return I;
  46       }
  47
  48       static ConstraintInfo getTied(unsigned Op) {
  49         ConstraintInfo I;
  50         I.Kind = Tied;
  51         I.OtherTiedOperand = Op;
  52         return I;
  53       }
  54
  55       bool isNone() const { return Kind == None; }
  56       bool isEarlyClobber() const { return Kind == EarlyClobber; }
  57       bool isTied() const { return Kind == Tied; }
  58
  59       unsigned getTiedOperand() const {
  60         assert(isTied());
  61         return OtherTiedOperand;
  62       }
  63     };
  64
  65     /// OperandInfo - The information we keep track of for each operand in the
  66     /// operand list for a tablegen instruction.
  67     struct OperandInfo {
  68       /// Rec - The definition this operand is declared as.
  69       ///
  70       Record *Rec;
  71
  72       /// Name - If this operand was assigned a symbolic name, this is it,
  73       /// otherwise, it's empty.
  74       std::string Name;
  75
  76       /// PrinterMethodName - The method used to print operands of this type in
  77       /// the asmprinter.
  78       std::string PrinterMethodName;
  79
  80       /// MIOperandNo - Currently (this is meant to be phased out), some logical
  81       /// operands correspond to multiple MachineInstr operands.  In the X86
  82       /// target for example, one address operand is represented as 4
  83       /// MachineOperands.  Because of this, the operand number in the
  84       /// OperandList may not match the MachineInstr operand num.  Until it
  85       /// does, this contains the MI operand index of this operand.
  86       unsigned MIOperandNo;
  87       unsigned MINumOperands;   // The number of operands.
  88
  89       /// DoNotEncode - Bools are set to true in this vector for each operand in
  90       /// the DisableEncoding list.  These should not be emitted by the code
  91       /// emitter.
  92       std::vector<bool> DoNotEncode;
  93
  94       /// MIOperandInfo - Default MI operand type. Note an operand may be made
  95       /// up of multiple MI operands.
  96       DagInit *MIOperandInfo;
  97
  98       /// Constraint info for this operand.  This operand can have pieces, so we
  99       /// track constraint info for each.
 100       std::vector<ConstraintInfo> Constraints;
 101
 102       OperandInfo(Record *R, const std::string &N, const std::string &PMN,
 103                   unsigned MION, unsigned MINO, DagInit *MIOI)
 104         : Rec(R), Name(N), PrinterMethodName(PMN), MIOperandNo(MION),
 105           MINumOperands(MINO), MIOperandInfo(MIOI) {}
 106     };
 107
 108     /// NumDefs - Number of def operands declared, this is the number of
 109     /// elements in the instruction's (outs) list.
 110     ///
 111     unsigned NumDefs;
 112
 113     /// OperandList - The list of declared operands, along with their declared
 114     /// type (which is a record).
 115     std::vector<OperandInfo> OperandList;
 116
 117     /// ImplicitDefs/ImplicitUses - These are lists of registers that are
 118     /// implicitly defined and used by the instruction.
 119     std::vector<Record*> ImplicitDefs, ImplicitUses;
 120
 121     // Various boolean values we track for the instruction.
 122     bool isReturn;
 123     bool isBranch;
 124     bool isIndirectBranch;
 125     bool isBarrier;
 126     bool isCall;
 127     bool canFoldAsLoad;
 128     bool mayLoad, mayStore;
 129     bool isPredicable;
 130     bool isConvertibleToThreeAddress;
 131     bool isCommutable;
 132     bool isTerminator;
 133     bool isReMaterializable;
 134     bool hasDelaySlot;
 135     bool usesCustomInserter;
 136     bool isVariadic;
 137     bool hasCtrlDep;
 138     bool isNotDuplicable;
 139     bool hasOptionalDef;
 140     bool hasSideEffects;
 141     bool neverHasSideEffects;
 142     bool isAsCheapAsAMove;
 143     bool hasExtraSrcRegAllocReq;
 144     bool hasExtraDefRegAllocReq;
 145
 146     /// ParseOperandName - Parse an operand name like "$foo" or "$foo.bar",
 147     /// where $foo is a whole operand and $foo.bar refers to a suboperand.
 148     /// This throws an exception if the name is invalid.  If AllowWholeOp is
 149     /// true, references to operands with suboperands are allowed, otherwise
 150     /// not.
 151     std::pair<unsigned,unsigned> ParseOperandName(const std::string &Op,
 152                                                   bool AllowWholeOp = true);
 153
 154     /// getFlattenedOperandNumber - Flatten a operand/suboperand pair into a
 155     /// flat machineinstr operand #.
 156     unsigned getFlattenedOperandNumber(std::pair<unsigned,unsigned> Op) const {
 157       return OperandList[Op.first].MIOperandNo + Op.second;
 158     }
 159
 160     /// getSubOperandNumber - Unflatten a operand number into an
 161     /// operand/suboperand pair.
 162     std::pair<unsigned,unsigned> getSubOperandNumber(unsigned Op) const {
 163       for (unsigned i = 0; ; ++i) {
 164         assert(i < OperandList.size() && "Invalid flat operand #");
 165         if (OperandList[i].MIOperandNo+OperandList[i].MINumOperands > Op)
 166           return std::make_pair(i, Op-OperandList[i].MIOperandNo);
 167       }
 168     }
 169
 170
 171     /// isFlatOperandNotEmitted - Return true if the specified flat operand #
 172     /// should not be emitted with the code emitter.
 173     bool isFlatOperandNotEmitted(unsigned FlatOpNo) const {
 174       std::pair<unsigned,unsigned> Op = getSubOperandNumber(FlatOpNo);
 175       if (OperandList[Op.first].DoNotEncode.size() > Op.second)
 176         return OperandList[Op.first].DoNotEncode[Op.second];
 177       return false;
 178     }
 179
 180     CodeGenInstruction(Record *R, const std::string &AsmStr);
 181
 182     /// getOperandNamed - Return the index of the operand with the specified
 183     /// non-empty name.  If the instruction does not have an operand with the
 184     /// specified name, throw an exception.
 185     unsigned getOperandNamed(const std::string &Name) const;
 186   };
 187 }
 188
 189 #endif