utils/TableGen/CodeGenInstruction.h

   1 //===- CodeGenInstruction.h - Instruction Class Wrapper ---------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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   struct CodeGenInstruction {
  27     Record *TheDef;            // The actual record defining this instruction.
  28     std::string Name;          // Contents of the 'Name' field.
  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     /// OperandInfo - The information we keep track of for each operand in the
  36     /// operand list for a tablegen instruction.
  37     struct OperandInfo {
  38       /// Rec - The definition this operand is declared as.
  39       ///
  40       Record *Rec;
  41
  42       /// Name - If this operand was assigned a symbolic name, this is it,
  43       /// otherwise, it's empty.
  44       std::string Name;
  45
  46       /// PrinterMethodName - The method used to print operands of this type in
  47       /// the asmprinter.
  48       std::string PrinterMethodName;
  49
  50       /// MIOperandNo - Currently (this is meant to be phased out), some logical
  51       /// operands correspond to multiple MachineInstr operands.  In the X86
  52       /// target for example, one address operand is represented as 4
  53       /// MachineOperands.  Because of this, the operand number in the
  54       /// OperandList may not match the MachineInstr operand num.  Until it
  55       /// does, this contains the MI operand index of this operand.
  56       unsigned MIOperandNo;
  57       unsigned MINumOperands;   // The number of operands.
  58
  59       /// MIOperandInfo - Default MI operand type. Note an operand may be made
  60       /// up of multiple MI operands.
  61       DagInit *MIOperandInfo;
  62
  63       OperandInfo(Record *R, const std::string &N, const std::string &PMN,
  64                   unsigned MION, unsigned MINO, DagInit *MIOI)
  65         : Rec(R), Name(N), PrinterMethodName(PMN), MIOperandNo(MION),
  66           MINumOperands(MINO), MIOperandInfo(MIOI) {}
  67     };
  68
  69     /// OperandList - The list of declared operands, along with their declared
  70     /// type (which is a record).
  71     std::vector<OperandInfo> OperandList;
  72
  73     // Various boolean values we track for the instruction.
  74     bool isReturn;
  75     bool isBranch;
  76     bool isBarrier;
  77     bool isCall;
  78     bool isLoad;
  79     bool isStore;
  80     bool isTwoAddress;
  81     bool isConvertibleToThreeAddress;
  82     bool isCommutable;
  83     bool isTerminator;
  84     bool hasDelaySlot;
  85     bool usesCustomDAGSchedInserter;
  86     bool hasVariableNumberOfOperands;
  87     bool hasCtrlDep;
  88     bool noResults;
  89
  90     CodeGenInstruction(Record *R, const std::string &AsmStr);
  91
  92     /// getOperandNamed - Return the index of the operand with the specified
  93     /// non-empty name.  If the instruction does not have an operand with the
  94     /// specified name, throw an exception.
  95     unsigned getOperandNamed(const std::string &Name) const;
  96   };
  97 }
  98
  99 #endif