blob: 4f776ca0a6cd71ef3106519a85b056509e80eb12 [file] [log] [blame]
Chris Lattnerec352402004-08-01 05:04:00 +00001//===- CodeGenInstruction.h - Instruction Class Wrapper ---------*- C++ -*-===//
Misha Brukman3da94ae2005-04-22 00:00:37 +00002//
Chris Lattnerec352402004-08-01 05:04:00 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner30609102007-12-29 20:37:13 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukman3da94ae2005-04-22 00:00:37 +00007//
Chris Lattnerec352402004-08-01 05:04:00 +00008//===----------------------------------------------------------------------===//
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
Chris Lattner87c59052004-08-01 07:42:39 +000017#include "llvm/CodeGen/ValueTypes.h"
Chris Lattnerec352402004-08-01 05:04:00 +000018#include <string>
19#include <vector>
20#include <utility>
21
22namespace llvm {
23 class Record;
Chris Lattner65303d62005-11-19 07:05:57 +000024 class DagInit;
Chris Lattnerec352402004-08-01 05:04:00 +000025
Jeff Cohend41b30d2006-11-05 19:31:28 +000026 class CodeGenInstruction {
27 public:
Chris Lattnerec352402004-08-01 05:04:00 +000028 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.
31
32 /// AsmString - The format string used to emit a .s file for the
33 /// instruction.
34 std::string AsmString;
Chris Lattner6cc654b2008-01-06 01:35:39 +000035
36 /// getName - Return the contents of the instruction Name field if set,
37 /// otherwise return the name of the def.
38 std::string getName() const;
39
Chris Lattnercf03da02004-08-11 02:22:39 +000040 /// OperandInfo - The information we keep track of for each operand in the
41 /// operand list for a tablegen instruction.
Chris Lattner87c59052004-08-01 07:42:39 +000042 struct OperandInfo {
Chris Lattnercf03da02004-08-11 02:22:39 +000043 /// Rec - The definition this operand is declared as.
Chris Lattner0e384b62005-08-19 16:57:28 +000044 ///
Chris Lattner87c59052004-08-01 07:42:39 +000045 Record *Rec;
Chris Lattnercf03da02004-08-11 02:22:39 +000046
Chris Lattnercf03da02004-08-11 02:22:39 +000047 /// Name - If this operand was assigned a symbolic name, this is it,
48 /// otherwise, it's empty.
Chris Lattner87c59052004-08-01 07:42:39 +000049 std::string Name;
Chris Lattnercf03da02004-08-11 02:22:39 +000050
51 /// PrinterMethodName - The method used to print operands of this type in
52 /// the asmprinter.
53 std::string PrinterMethodName;
54
55 /// MIOperandNo - Currently (this is meant to be phased out), some logical
56 /// operands correspond to multiple MachineInstr operands. In the X86
57 /// target for example, one address operand is represented as 4
58 /// MachineOperands. Because of this, the operand number in the
59 /// OperandList may not match the MachineInstr operand num. Until it
60 /// does, this contains the MI operand index of this operand.
61 unsigned MIOperandNo;
Chris Lattnercfbf96a2005-08-18 23:38:41 +000062 unsigned MINumOperands; // The number of operands.
Chris Lattnercf03da02004-08-11 02:22:39 +000063
Chris Lattnerf64f9a42006-11-15 23:23:02 +000064 /// DoNotEncode - Bools are set to true in this vector for each operand in
65 /// the DisableEncoding list. These should not be emitted by the code
66 /// emitter.
67 std::vector<bool> DoNotEncode;
68
Nate Begeman8ef9d162005-11-30 23:58:18 +000069 /// MIOperandInfo - Default MI operand type. Note an operand may be made
70 /// up of multiple MI operands.
Chris Lattner65303d62005-11-19 07:05:57 +000071 DagInit *MIOperandInfo;
Chris Lattnera0cca4a2006-11-06 23:49:51 +000072
Chris Lattner0bb75002006-11-15 02:38:17 +000073 /// Constraint info for this operand. This operand can have pieces, so we
74 /// track constraint info for each.
75 std::vector<std::string> Constraints;
Chris Lattner65303d62005-11-19 07:05:57 +000076
Nate Begeman86193d12005-12-01 00:12:04 +000077 OperandInfo(Record *R, const std::string &N, const std::string &PMN,
78 unsigned MION, unsigned MINO, DagInit *MIOI)
79 : Rec(R), Name(N), PrinterMethodName(PMN), MIOperandNo(MION),
Chris Lattner65303d62005-11-19 07:05:57 +000080 MINumOperands(MINO), MIOperandInfo(MIOI) {}
Chris Lattner87c59052004-08-01 07:42:39 +000081 };
Misha Brukman3da94ae2005-04-22 00:00:37 +000082
Evan Cheng64d80e32007-07-19 01:14:50 +000083 /// NumDefs - Number of def operands declared.
84 ///
85 unsigned NumDefs;
86
Chris Lattnerec352402004-08-01 05:04:00 +000087 /// OperandList - The list of declared operands, along with their declared
88 /// type (which is a record).
Chris Lattner87c59052004-08-01 07:42:39 +000089 std::vector<OperandInfo> OperandList;
Chris Lattnerec352402004-08-01 05:04:00 +000090
91 // Various boolean values we track for the instruction.
92 bool isReturn;
93 bool isBranch;
Owen Anderson20ab2902007-11-12 07:39:39 +000094 bool isIndirectBranch;
Chris Lattnerec352402004-08-01 05:04:00 +000095 bool isBarrier;
96 bool isCall;
Nate Begemancdd66b52004-09-28 21:01:45 +000097 bool isLoad;
98 bool isStore;
Evan Cheng3dd298f2007-12-13 00:42:35 +000099 bool isImplicitDef;
Evan Cheng5127ce02007-05-16 20:45:24 +0000100 bool isPredicable;
Chris Lattneraad75aa2005-01-02 02:29:04 +0000101 bool isConvertibleToThreeAddress;
102 bool isCommutable;
Chris Lattnerec352402004-08-01 05:04:00 +0000103 bool isTerminator;
Dan Gohmand45eddd2007-06-26 00:48:07 +0000104 bool isReMaterializable;
Chris Lattner5b71d3a2004-09-28 18:38:01 +0000105 bool hasDelaySlot;
Chris Lattner5f89bf02005-08-26 20:42:52 +0000106 bool usesCustomDAGSchedInserter;
Chris Lattnercfbf96a2005-08-18 23:38:41 +0000107 bool hasVariableNumberOfOperands;
Evan Cheng1c3d19e2005-12-04 08:18:16 +0000108 bool hasCtrlDep;
Evan Chengeaa91b02007-06-19 01:26:51 +0000109 bool isNotDuplicable;
Evan Cheng88cc0922007-07-10 18:05:01 +0000110 bool hasOptionalDef;
Bill Wendling6b1da9c2007-12-14 01:48:59 +0000111 bool mayHaveSideEffects;
112 bool neverHasSideEffects;
Chris Lattner0bb75002006-11-15 02:38:17 +0000113
114 /// ParseOperandName - Parse an operand name like "$foo" or "$foo.bar",
115 /// where $foo is a whole operand and $foo.bar refers to a suboperand.
116 /// This throws an exception if the name is invalid. If AllowWholeOp is
117 /// true, references to operands with suboperands are allowed, otherwise
118 /// not.
119 std::pair<unsigned,unsigned> ParseOperandName(const std::string &Op,
120 bool AllowWholeOp = true);
121
122 /// getFlattenedOperandNumber - Flatten a operand/suboperand pair into a
123 /// flat machineinstr operand #.
124 unsigned getFlattenedOperandNumber(std::pair<unsigned,unsigned> Op) const {
125 return OperandList[Op.first].MIOperandNo + Op.second;
126 }
127
Chris Lattnerf64f9a42006-11-15 23:23:02 +0000128 /// getSubOperandNumber - Unflatten a operand number into an
129 /// operand/suboperand pair.
130 std::pair<unsigned,unsigned> getSubOperandNumber(unsigned Op) const {
131 for (unsigned i = 0; ; ++i) {
132 assert(i < OperandList.size() && "Invalid flat operand #");
133 if (OperandList[i].MIOperandNo+OperandList[i].MINumOperands > Op)
134 return std::make_pair(i, Op-OperandList[i].MIOperandNo);
135 }
136 }
137
138
139 /// isFlatOperandNotEmitted - Return true if the specified flat operand #
140 /// should not be emitted with the code emitter.
141 bool isFlatOperandNotEmitted(unsigned FlatOpNo) const {
142 std::pair<unsigned,unsigned> Op = getSubOperandNumber(FlatOpNo);
143 if (OperandList[Op.first].DoNotEncode.size() > Op.second)
144 return OperandList[Op.first].DoNotEncode[Op.second];
145 return false;
146 }
Chris Lattnerec352402004-08-01 05:04:00 +0000147
Chris Lattner175580c2004-08-14 22:50:53 +0000148 CodeGenInstruction(Record *R, const std::string &AsmStr);
Chris Lattner87c59052004-08-01 07:42:39 +0000149
150 /// getOperandNamed - Return the index of the operand with the specified
151 /// non-empty name. If the instruction does not have an operand with the
152 /// specified name, throw an exception.
153 unsigned getOperandNamed(const std::string &Name) const;
Chris Lattnerec352402004-08-01 05:04:00 +0000154 };
155}
156
157#endif