1 //===-- llvm/CodeGen/MachineOperand.h - MachineOperand class ----*- 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 contains the declaration of the MachineOperand class.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_CODEGEN_MACHINEOPERAND_H
15 #define LLVM_CODEGEN_MACHINEOPERAND_H
17 #include "llvm/Support/DataTypes.h"
24 class MachineBasicBlock;
28 class MachineRegisterInfo;
31 /// MachineOperand class - Representation of each machine instruction operand.
33 class MachineOperand {
35 enum MachineOperandType {
36 MO_Register, // Register operand.
37 MO_Immediate, // Immediate Operand
39 MO_MachineBasicBlock, // MachineBasicBlock reference
40 MO_FrameIndex, // Abstract Stack Frame Index
41 MO_ConstantPoolIndex, // Address of indexed Constant in Constant Pool
42 MO_JumpTableIndex, // Address of indexed Jump Table for switch
43 MO_ExternalSymbol, // Name of external global symbol
44 MO_GlobalAddress // Address of a global value
48 /// OpKind - Specify what kind of operand this is. This discriminates the
50 MachineOperandType OpKind : 8;
52 /// IsDef/IsImp/IsKill/IsDead flags - These are only valid for MO_Register
55 /// IsDef - True if this is a def, false if this is a use of the register.
59 /// IsImp - True if this is an implicit def or use, false if it is explicit.
63 /// IsKill - True if this instruction is the last use of the register on this
64 /// path through the function. This is only valid on uses of registers.
67 /// IsDead - True if this register is never used by a subsequent instruction.
68 /// This is only valid on definitions of registers.
71 /// IsEarlyClobber - True if this MO_Register 'def' operand is written to
72 /// by the MachineInstr before all input registers are read. This is used to
73 /// model the GCC inline asm '&' constraint modifier.
74 bool IsEarlyClobber : 1;
76 /// OverlapsEarlyClobber - True if this MO_Register operand is used as an
77 /// input to an inline asm that has the earlyclobber bit set on some other
78 /// operand. Flag is not valid for any other case. See gcc doc
79 /// for description of earlyclobber.
80 bool OverlapsEarlyClobber : 1;
82 /// SubReg - Subregister number, only valid for MO_Register. A value of 0
83 /// indicates the MO_Register has no subReg.
86 /// ParentMI - This is the instruction that this operand is embedded into.
87 /// This is valid for all operand types, when the operand is in an instr.
88 MachineInstr *ParentMI;
90 /// Contents union - This contains the payload for the various operand types.
92 MachineBasicBlock *MBB; // For MO_MachineBasicBlock.
93 const ConstantFP *CFP; // For MO_FPImmediate.
94 int64_t ImmVal; // For MO_Immediate.
96 struct { // For MO_Register.
98 MachineOperand **Prev; // Access list for register.
102 /// OffsetedInfo - This struct contains the offset and an object identifier.
103 /// this represent the object as with an optional offset from it.
106 int Index; // For MO_*Index - The index itself.
107 const char *SymbolName; // For MO_ExternalSymbol.
108 GlobalValue *GV; // For MO_GlobalAddress.
110 int Offset; // An offset from the object.
114 explicit MachineOperand(MachineOperandType K) : OpKind(K), ParentMI(0) {}
116 MachineOperand(const MachineOperand &M) {
122 /// getType - Returns the MachineOperandType for this operand.
124 MachineOperandType getType() const { return OpKind; }
126 /// getParent - Return the instruction that this operand belongs to.
128 MachineInstr *getParent() { return ParentMI; }
129 const MachineInstr *getParent() const { return ParentMI; }
131 void print(std::ostream &os, const TargetMachine *TM = 0) const;
132 void print(raw_ostream &os, const TargetMachine *TM = 0) const;
134 /// Accessors that tell you what kind of MachineOperand you're looking at.
136 bool isRegister() const { return OpKind == MO_Register; }
137 bool isImmediate() const { return OpKind == MO_Immediate; }
138 bool isFPImmediate() const { return OpKind == MO_FPImmediate; }
139 bool isMachineBasicBlock() const { return OpKind == MO_MachineBasicBlock; }
140 bool isFrameIndex() const { return OpKind == MO_FrameIndex; }
141 bool isConstantPoolIndex() const { return OpKind == MO_ConstantPoolIndex; }
142 bool isJumpTableIndex() const { return OpKind == MO_JumpTableIndex; }
143 bool isGlobalAddress() const { return OpKind == MO_GlobalAddress; }
144 bool isExternalSymbol() const { return OpKind == MO_ExternalSymbol; }
146 //===--------------------------------------------------------------------===//
147 // Accessors for Register Operands
148 //===--------------------------------------------------------------------===//
150 /// getReg - Returns the register number.
151 unsigned getReg() const {
152 assert(isRegister() && "This is not a register operand!");
153 return Contents.Reg.RegNo;
156 unsigned getSubReg() const {
157 assert(isRegister() && "Wrong MachineOperand accessor");
158 return (unsigned)SubReg;
162 assert(isRegister() && "Wrong MachineOperand accessor");
167 assert(isRegister() && "Wrong MachineOperand accessor");
171 bool isImplicit() const {
172 assert(isRegister() && "Wrong MachineOperand accessor");
176 bool isDead() const {
177 assert(isRegister() && "Wrong MachineOperand accessor");
181 bool isKill() const {
182 assert(isRegister() && "Wrong MachineOperand accessor");
186 bool isEarlyClobber() const {
187 assert(isRegister() && "Wrong MachineOperand accessor");
188 return IsEarlyClobber;
191 bool overlapsEarlyClobber() const {
192 assert(isRegister() && "Wrong MachineOperand accessor");
193 return OverlapsEarlyClobber;
196 /// getNextOperandForReg - Return the next MachineOperand in the function that
197 /// uses or defines this register.
198 MachineOperand *getNextOperandForReg() const {
199 assert(isRegister() && "This is not a register operand!");
200 return Contents.Reg.Next;
203 //===--------------------------------------------------------------------===//
204 // Mutators for Register Operands
205 //===--------------------------------------------------------------------===//
207 /// Change the register this operand corresponds to.
209 void setReg(unsigned Reg);
211 void setSubReg(unsigned subReg) {
212 assert(isRegister() && "Wrong MachineOperand accessor");
213 SubReg = (unsigned char)subReg;
216 void setIsUse(bool Val = true) {
217 assert(isRegister() && "Wrong MachineOperand accessor");
221 void setIsDef(bool Val = true) {
222 assert(isRegister() && "Wrong MachineOperand accessor");
226 void setImplicit(bool Val = true) {
227 assert(isRegister() && "Wrong MachineOperand accessor");
231 void setIsKill(bool Val = true) {
232 assert(isRegister() && !IsDef && "Wrong MachineOperand accessor");
236 void setIsDead(bool Val = true) {
237 assert(isRegister() && IsDef && "Wrong MachineOperand accessor");
241 void setIsEarlyClobber(bool Val = true) {
242 assert(isRegister() && IsDef && "Wrong MachineOperand accessor");
243 IsEarlyClobber = Val;
246 void setOverlapsEarlyClobber(bool Val = true) {
247 assert(isRegister() && "Wrong MachineOperand accessor");
248 OverlapsEarlyClobber = Val;
251 //===--------------------------------------------------------------------===//
252 // Accessors for various operand types.
253 //===--------------------------------------------------------------------===//
255 int64_t getImm() const {
256 assert(isImmediate() && "Wrong MachineOperand accessor");
257 return Contents.ImmVal;
260 const ConstantFP *getFPImm() const {
261 assert(isFPImmediate() && "Wrong MachineOperand accessor");
265 MachineBasicBlock *getMBB() const {
266 assert(isMachineBasicBlock() && "Wrong MachineOperand accessor");
270 int getIndex() const {
271 assert((isFrameIndex() || isConstantPoolIndex() || isJumpTableIndex()) &&
272 "Wrong MachineOperand accessor");
273 return Contents.OffsetedInfo.Val.Index;
276 GlobalValue *getGlobal() const {
277 assert(isGlobalAddress() && "Wrong MachineOperand accessor");
278 return Contents.OffsetedInfo.Val.GV;
281 int getOffset() const {
282 assert((isGlobalAddress() || isExternalSymbol() || isConstantPoolIndex()) &&
283 "Wrong MachineOperand accessor");
284 return Contents.OffsetedInfo.Offset;
287 const char *getSymbolName() const {
288 assert(isExternalSymbol() && "Wrong MachineOperand accessor");
289 return Contents.OffsetedInfo.Val.SymbolName;
292 //===--------------------------------------------------------------------===//
293 // Mutators for various operand types.
294 //===--------------------------------------------------------------------===//
296 void setImm(int64_t immVal) {
297 assert(isImmediate() && "Wrong MachineOperand mutator");
298 Contents.ImmVal = immVal;
301 void setOffset(int Offset) {
302 assert((isGlobalAddress() || isExternalSymbol() || isConstantPoolIndex()) &&
303 "Wrong MachineOperand accessor");
304 Contents.OffsetedInfo.Offset = Offset;
307 void setIndex(int Idx) {
308 assert((isFrameIndex() || isConstantPoolIndex() || isJumpTableIndex()) &&
309 "Wrong MachineOperand accessor");
310 Contents.OffsetedInfo.Val.Index = Idx;
313 void setMBB(MachineBasicBlock *MBB) {
314 assert(isMachineBasicBlock() && "Wrong MachineOperand accessor");
318 //===--------------------------------------------------------------------===//
320 //===--------------------------------------------------------------------===//
322 /// isIdenticalTo - Return true if this operand is identical to the specified
323 /// operand. Note: This method ignores isKill and isDead properties.
324 bool isIdenticalTo(const MachineOperand &Other) const;
326 /// ChangeToImmediate - Replace this operand with a new immediate operand of
327 /// the specified value. If an operand is known to be an immediate already,
328 /// the setImm method should be used.
329 void ChangeToImmediate(int64_t ImmVal);
331 /// ChangeToRegister - Replace this operand with a new register operand of
332 /// the specified value. If an operand is known to be an register already,
333 /// the setReg method should be used.
334 void ChangeToRegister(unsigned Reg, bool isDef, bool isImp = false,
335 bool isKill = false, bool isDead = false);
337 //===--------------------------------------------------------------------===//
338 // Construction methods.
339 //===--------------------------------------------------------------------===//
341 static MachineOperand CreateImm(int64_t Val) {
342 MachineOperand Op(MachineOperand::MO_Immediate);
347 static MachineOperand CreateFPImm(const ConstantFP *CFP) {
348 MachineOperand Op(MachineOperand::MO_FPImmediate);
349 Op.Contents.CFP = CFP;
353 static MachineOperand CreateReg(unsigned Reg, bool isDef, bool isImp = false,
354 bool isKill = false, bool isDead = false,
356 bool isEarlyClobber = false,
357 bool overlapsEarlyClobber = false) {
358 MachineOperand Op(MachineOperand::MO_Register);
363 Op.IsEarlyClobber = isEarlyClobber;
364 Op.OverlapsEarlyClobber = overlapsEarlyClobber;
365 Op.Contents.Reg.RegNo = Reg;
366 Op.Contents.Reg.Prev = 0;
367 Op.Contents.Reg.Next = 0;
371 static MachineOperand CreateMBB(MachineBasicBlock *MBB) {
372 MachineOperand Op(MachineOperand::MO_MachineBasicBlock);
376 static MachineOperand CreateFI(unsigned Idx) {
377 MachineOperand Op(MachineOperand::MO_FrameIndex);
381 static MachineOperand CreateCPI(unsigned Idx, int Offset) {
382 MachineOperand Op(MachineOperand::MO_ConstantPoolIndex);
384 Op.setOffset(Offset);
387 static MachineOperand CreateJTI(unsigned Idx) {
388 MachineOperand Op(MachineOperand::MO_JumpTableIndex);
392 static MachineOperand CreateGA(GlobalValue *GV, int Offset) {
393 MachineOperand Op(MachineOperand::MO_GlobalAddress);
394 Op.Contents.OffsetedInfo.Val.GV = GV;
395 Op.setOffset(Offset);
398 static MachineOperand CreateES(const char *SymName, int Offset = 0) {
399 MachineOperand Op(MachineOperand::MO_ExternalSymbol);
400 Op.Contents.OffsetedInfo.Val.SymbolName = SymName;
401 Op.setOffset(Offset);
404 const MachineOperand &operator=(const MachineOperand &MO) {
410 IsEarlyClobber = MO.IsEarlyClobber;
411 OverlapsEarlyClobber = MO.OverlapsEarlyClobber;
413 ParentMI = MO.ParentMI;
414 Contents = MO.Contents;
418 friend class MachineInstr;
419 friend class MachineRegisterInfo;
421 //===--------------------------------------------------------------------===//
422 // Methods for handling register use/def lists.
423 //===--------------------------------------------------------------------===//
425 /// isOnRegUseList - Return true if this operand is on a register use/def list
426 /// or false if not. This can only be called for register operands that are
427 /// part of a machine instruction.
428 bool isOnRegUseList() const {
429 assert(isRegister() && "Can only add reg operand to use lists");
430 return Contents.Reg.Prev != 0;
433 /// AddRegOperandToRegInfo - Add this register operand to the specified
434 /// MachineRegisterInfo. If it is null, then the next/prev fields should be
435 /// explicitly nulled out.
436 void AddRegOperandToRegInfo(MachineRegisterInfo *RegInfo);
438 void RemoveRegOperandFromRegInfo() {
439 assert(isOnRegUseList() && "Reg operand is not on a use list");
440 // Unlink this from the doubly linked list of operands.
441 MachineOperand *NextOp = Contents.Reg.Next;
442 *Contents.Reg.Prev = NextOp;
444 assert(NextOp->getReg() == getReg() && "Corrupt reg use/def chain!");
445 NextOp->Contents.Reg.Prev = Contents.Reg.Prev;
447 Contents.Reg.Prev = 0;
448 Contents.Reg.Next = 0;
452 inline std::ostream &operator<<(std::ostream &OS, const MachineOperand &MO) {
457 inline raw_ostream &operator<<(raw_ostream &OS, const MachineOperand& MO) {
462 } // End llvm namespace