1 //===- CodeGenInstruction.h - Instruction Class Wrapper ---------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // 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"
18 #include "llvm/ADT/StringRef.h"
19 #include "llvm/Support/SourceMgr.h"
30 class CGIOperandList {
32 class ConstraintInfo {
33 enum { None, EarlyClobber, Tied } Kind;
34 unsigned OtherTiedOperand;
36 ConstraintInfo() : Kind(None) {}
38 static ConstraintInfo getEarlyClobber() {
40 I.Kind = EarlyClobber;
41 I.OtherTiedOperand = 0;
45 static ConstraintInfo getTied(unsigned Op) {
48 I.OtherTiedOperand = Op;
52 bool isNone() const { return Kind == None; }
53 bool isEarlyClobber() const { return Kind == EarlyClobber; }
54 bool isTied() const { return Kind == Tied; }
56 unsigned getTiedOperand() const {
58 return OtherTiedOperand;
62 /// OperandInfo - The information we keep track of for each operand in the
63 /// operand list for a tablegen instruction.
65 /// Rec - The definition this operand is declared as.
69 /// Name - If this operand was assigned a symbolic name, this is it,
70 /// otherwise, it's empty.
73 /// PrinterMethodName - The method used to print operands of this type in
75 std::string PrinterMethodName;
77 /// EncoderMethodName - The method used to get the machine operand value
78 /// for binary encoding. "getMachineOpValue" by default.
79 std::string EncoderMethodName;
81 /// OperandType - A value from MCOI::OperandType representing the type of
83 std::string OperandType;
85 /// MIOperandNo - Currently (this is meant to be phased out), some logical
86 /// operands correspond to multiple MachineInstr operands. In the X86
87 /// target for example, one address operand is represented as 4
88 /// MachineOperands. Because of this, the operand number in the
89 /// OperandList may not match the MachineInstr operand num. Until it
90 /// does, this contains the MI operand index of this operand.
92 unsigned MINumOperands; // The number of operands.
94 /// DoNotEncode - Bools are set to true in this vector for each operand in
95 /// the DisableEncoding list. These should not be emitted by the code
97 std::vector<bool> DoNotEncode;
99 /// MIOperandInfo - Default MI operand type. Note an operand may be made
100 /// up of multiple MI operands.
101 DagInit *MIOperandInfo;
103 /// Constraint info for this operand. This operand can have pieces, so we
104 /// track constraint info for each.
105 std::vector<ConstraintInfo> Constraints;
107 OperandInfo(Record *R, const std::string &N, const std::string &PMN,
108 const std::string &EMN, const std::string &OT, unsigned MION,
109 unsigned MINO, DagInit *MIOI)
110 : Rec(R), Name(N), PrinterMethodName(PMN), EncoderMethodName(EMN),
111 OperandType(OT), MIOperandNo(MION), MINumOperands(MINO),
112 MIOperandInfo(MIOI) {}
115 /// getTiedOperand - If this operand is tied to another one, return the
116 /// other operand number. Otherwise, return -1.
117 int getTiedRegister() const {
118 for (unsigned j = 0, e = Constraints.size(); j != e; ++j) {
119 const CGIOperandList::ConstraintInfo &CI = Constraints[j];
120 if (CI.isTied()) return CI.getTiedOperand();
126 CGIOperandList(Record *D);
128 Record *TheDef; // The actual record containing this OperandList.
130 /// NumDefs - Number of def operands declared, this is the number of
131 /// elements in the instruction's (outs) list.
135 /// OperandList - The list of declared operands, along with their declared
136 /// type (which is a record).
137 std::vector<OperandInfo> OperandList;
139 // Information gleaned from the operand list.
144 // Provide transparent accessors to the operand list.
145 bool empty() const { return OperandList.empty(); }
146 unsigned size() const { return OperandList.size(); }
147 const OperandInfo &operator[](unsigned i) const { return OperandList[i]; }
148 OperandInfo &operator[](unsigned i) { return OperandList[i]; }
149 OperandInfo &back() { return OperandList.back(); }
150 const OperandInfo &back() const { return OperandList.back(); }
153 /// getOperandNamed - Return the index of the operand with the specified
154 /// non-empty name. If the instruction does not have an operand with the
155 /// specified name, throw an exception.
156 unsigned getOperandNamed(StringRef Name) const;
158 /// hasOperandNamed - Query whether the instruction has an operand of the
159 /// given name. If so, return true and set OpIdx to the index of the
160 /// operand. Otherwise, return false.
161 bool hasOperandNamed(StringRef Name, unsigned &OpIdx) const;
163 /// ParseOperandName - Parse an operand name like "$foo" or "$foo.bar",
164 /// where $foo is a whole operand and $foo.bar refers to a suboperand.
165 /// This throws an exception if the name is invalid. If AllowWholeOp is
166 /// true, references to operands with suboperands are allowed, otherwise
168 std::pair<unsigned,unsigned> ParseOperandName(const std::string &Op,
169 bool AllowWholeOp = true);
171 /// getFlattenedOperandNumber - Flatten a operand/suboperand pair into a
172 /// flat machineinstr operand #.
173 unsigned getFlattenedOperandNumber(std::pair<unsigned,unsigned> Op) const {
174 return OperandList[Op.first].MIOperandNo + Op.second;
177 /// getSubOperandNumber - Unflatten a operand number into an
178 /// operand/suboperand pair.
179 std::pair<unsigned,unsigned> getSubOperandNumber(unsigned Op) const {
180 for (unsigned i = 0; ; ++i) {
181 assert(i < OperandList.size() && "Invalid flat operand #");
182 if (OperandList[i].MIOperandNo+OperandList[i].MINumOperands > Op)
183 return std::make_pair(i, Op-OperandList[i].MIOperandNo);
188 /// isFlatOperandNotEmitted - Return true if the specified flat operand #
189 /// should not be emitted with the code emitter.
190 bool isFlatOperandNotEmitted(unsigned FlatOpNo) const {
191 std::pair<unsigned,unsigned> Op = getSubOperandNumber(FlatOpNo);
192 if (OperandList[Op.first].DoNotEncode.size() > Op.second)
193 return OperandList[Op.first].DoNotEncode[Op.second];
197 void ProcessDisableEncoding(std::string Value);
201 class CodeGenInstruction {
203 Record *TheDef; // The actual record defining this instruction.
204 std::string Namespace; // The namespace the instruction is in.
206 /// AsmString - The format string used to emit a .s file for the
208 std::string AsmString;
210 /// Operands - This is information about the (ins) and (outs) list specified
211 /// to the instruction.
212 CGIOperandList Operands;
214 /// ImplicitDefs/ImplicitUses - These are lists of registers that are
215 /// implicitly defined and used by the instruction.
216 std::vector<Record*> ImplicitDefs, ImplicitUses;
218 // Various boolean values we track for the instruction.
221 bool isIndirectBranch;
234 bool isConvertibleToThreeAddress;
237 bool isReMaterializable;
239 bool usesCustomInserter;
240 bool hasPostISelHook;
242 bool isNotDuplicable;
244 bool hasSideEffects_Unset;
245 bool neverHasSideEffects;
246 bool isAsCheapAsAMove;
247 bool hasExtraSrcRegAllocReq;
248 bool hasExtraDefRegAllocReq;
252 /// Are there any undefined flags?
253 bool hasUndefFlags() const {
254 return mayLoad_Unset || mayStore_Unset || hasSideEffects_Unset;
257 // The record used to infer instruction flags, or NULL if no flag values
258 // have been inferred.
259 Record *InferredFrom;
261 CodeGenInstruction(Record *R);
263 /// HasOneImplicitDefWithKnownVT - If the instruction has at least one
264 /// implicit def and it has a known VT, return the VT, otherwise return
267 HasOneImplicitDefWithKnownVT(const CodeGenTarget &TargetInfo) const;
270 /// FlattenAsmStringVariants - Flatten the specified AsmString to only
271 /// include text from the specified variant, returning the new string.
272 static std::string FlattenAsmStringVariants(StringRef AsmString,
277 /// CodeGenInstAlias - This represents an InstAlias definition.
278 class CodeGenInstAlias {
280 Record *TheDef; // The actual record defining this InstAlias.
282 /// AsmString - The format string used to emit a .s file for the
284 std::string AsmString;
286 /// Result - The result instruction.
289 /// ResultInst - The instruction generated by the alias (decoded from
291 CodeGenInstruction *ResultInst;
294 struct ResultOperand {
307 ResultOperand(std::string N, Record *r) : Name(N), R(r), Kind(K_Record) {}
308 ResultOperand(int64_t I) : Imm(I), Kind(K_Imm) {}
309 ResultOperand(Record *r) : R(r), Kind(K_Reg) {}
311 bool isRecord() const { return Kind == K_Record; }
312 bool isImm() const { return Kind == K_Imm; }
313 bool isReg() const { return Kind == K_Reg; }
315 StringRef getName() const { assert(isRecord()); return Name; }
316 Record *getRecord() const { assert(isRecord()); return R; }
317 int64_t getImm() const { assert(isImm()); return Imm; }
318 Record *getRegister() const { assert(isReg()); return R; }
321 /// ResultOperands - The decoded operands for the result instruction.
322 std::vector<ResultOperand> ResultOperands;
324 /// ResultInstOperandIndex - For each operand, this vector holds a pair of
325 /// indices to identify the corresponding operand in the result
326 /// instruction. The first index specifies the operand and the second
327 /// index specifies the suboperand. If there are no suboperands or if all
328 /// of them are matched by the operand, the second value should be -1.
329 std::vector<std::pair<unsigned, int> > ResultInstOperandIndex;
331 CodeGenInstAlias(Record *R, CodeGenTarget &T);
333 bool tryAliasOpMatch(DagInit *Result, unsigned AliasOpNo,
334 Record *InstOpRec, bool hasSubOps, ArrayRef<SMLoc> Loc,
335 CodeGenTarget &T, ResultOperand &ResOp);