1 //===- CodeGenInstruction.h - Instruction Class Wrapper ---------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
10 // This file defines a wrapper class for the 'Instruction' TableGen class.
12 //===----------------------------------------------------------------------===//
14 #ifndef CODEGEN_INSTRUCTION_H
15 #define CODEGEN_INSTRUCTION_H
17 #include "llvm/CodeGen/ValueTypes.h"
26 class CodeGenInstruction {
28 Record *TheDef; // The actual record defining this instruction.
29 std::string Name; // Contents of the 'Name' field.
30 std::string Namespace; // The namespace the instruction is in.
32 /// AsmString - The format string used to emit a .s file for the
34 std::string AsmString;
36 /// OperandInfo - The information we keep track of for each operand in the
37 /// operand list for a tablegen instruction.
39 /// Rec - The definition this operand is declared as.
43 /// Name - If this operand was assigned a symbolic name, this is it,
44 /// otherwise, it's empty.
47 /// PrinterMethodName - The method used to print operands of this type in
49 std::string PrinterMethodName;
51 /// MIOperandNo - Currently (this is meant to be phased out), some logical
52 /// operands correspond to multiple MachineInstr operands. In the X86
53 /// target for example, one address operand is represented as 4
54 /// MachineOperands. Because of this, the operand number in the
55 /// OperandList may not match the MachineInstr operand num. Until it
56 /// does, this contains the MI operand index of this operand.
58 unsigned MINumOperands; // The number of operands.
60 /// DoNotEncode - Bools are set to true in this vector for each operand in
61 /// the DisableEncoding list. These should not be emitted by the code
63 std::vector<bool> DoNotEncode;
65 /// MIOperandInfo - Default MI operand type. Note an operand may be made
66 /// up of multiple MI operands.
67 DagInit *MIOperandInfo;
69 /// Constraint info for this operand. This operand can have pieces, so we
70 /// track constraint info for each.
71 std::vector<std::string> Constraints;
73 OperandInfo(Record *R, const std::string &N, const std::string &PMN,
74 unsigned MION, unsigned MINO, DagInit *MIOI)
75 : Rec(R), Name(N), PrinterMethodName(PMN), MIOperandNo(MION),
76 MINumOperands(MINO), MIOperandInfo(MIOI) {}
79 /// OperandList - The list of declared operands, along with their declared
80 /// type (which is a record).
81 std::vector<OperandInfo> OperandList;
83 // Various boolean values we track for the instruction.
91 bool isConvertibleToThreeAddress;
94 bool isReMaterializable;
96 bool usesCustomDAGSchedInserter;
97 bool hasVariableNumberOfOperands;
100 bool isNotDuplicable;
103 /// ParseOperandName - Parse an operand name like "$foo" or "$foo.bar",
104 /// where $foo is a whole operand and $foo.bar refers to a suboperand.
105 /// This throws an exception if the name is invalid. If AllowWholeOp is
106 /// true, references to operands with suboperands are allowed, otherwise
108 std::pair<unsigned,unsigned> ParseOperandName(const std::string &Op,
109 bool AllowWholeOp = true);
111 /// getFlattenedOperandNumber - Flatten a operand/suboperand pair into a
112 /// flat machineinstr operand #.
113 unsigned getFlattenedOperandNumber(std::pair<unsigned,unsigned> Op) const {
114 return OperandList[Op.first].MIOperandNo + Op.second;
117 /// getSubOperandNumber - Unflatten a operand number into an
118 /// operand/suboperand pair.
119 std::pair<unsigned,unsigned> getSubOperandNumber(unsigned Op) const {
120 for (unsigned i = 0; ; ++i) {
121 assert(i < OperandList.size() && "Invalid flat operand #");
122 if (OperandList[i].MIOperandNo+OperandList[i].MINumOperands > Op)
123 return std::make_pair(i, Op-OperandList[i].MIOperandNo);
128 /// isFlatOperandNotEmitted - Return true if the specified flat operand #
129 /// should not be emitted with the code emitter.
130 bool isFlatOperandNotEmitted(unsigned FlatOpNo) const {
131 std::pair<unsigned,unsigned> Op = getSubOperandNumber(FlatOpNo);
132 if (OperandList[Op.first].DoNotEncode.size() > Op.second)
133 return OperandList[Op.first].DoNotEncode[Op.second];
137 CodeGenInstruction(Record *R, const std::string &AsmStr);
139 /// getOperandNamed - Return the index of the operand with the specified
140 /// non-empty name. If the instruction does not have an operand with the
141 /// specified name, throw an exception.
142 unsigned getOperandNamed(const std::string &Name) const;