[llvm] r237911 - don't repeat function names in comments; NFC
Sanjay Patel
spatel at rotateright.com
Thu May 21 09:42:22 PDT 2015
Author: spatel
Date: Thu May 21 11:42:22 2015
New Revision: 237911
URL: http://llvm.org/viewvc/llvm-project?rev=237911&view=rev
Log:
don't repeat function names in comments; NFC
Modified:
llvm/trunk/include/llvm/CodeGen/MachineInstr.h
Modified: llvm/trunk/include/llvm/CodeGen/MachineInstr.h
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/include/llvm/CodeGen/MachineInstr.h?rev=237911&r1=237910&r2=237911&view=diff
==============================================================================
--- llvm/trunk/include/llvm/CodeGen/MachineInstr.h (original)
+++ llvm/trunk/include/llvm/CodeGen/MachineInstr.h Thu May 21 11:42:22 2015
@@ -42,7 +42,7 @@ class MachineFunction;
class MachineMemOperand;
//===----------------------------------------------------------------------===//
-/// MachineInstr - Representation of each machine instruction.
+/// Representation of each machine instruction.
///
/// This class isn't a POD type, but it must have a trivial destructor. When a
/// MachineFunction is deleted, all the contained MachineInstrs are deallocated
@@ -103,12 +103,12 @@ private:
friend struct ilist_traits<MachineBasicBlock>;
void setParent(MachineBasicBlock *P) { Parent = P; }
- /// MachineInstr ctor - This constructor creates a copy of the given
+ /// This constructor creates a copy of the given
/// MachineInstr in the given MachineFunction.
MachineInstr(MachineFunction &, const MachineInstr &);
- /// MachineInstr ctor - This constructor create a MachineInstr and add the
- /// implicit operands. It reserves space for number of operands specified by
+ /// This constructor create a MachineInstr and add the implicit operands.
+ /// It reserves space for number of operands specified by
/// MCInstrDesc. An explicit DebugLoc is supplied.
MachineInstr(MachineFunction &, const MCInstrDesc &MCID, DebugLoc dl,
bool NoImp = false);
@@ -120,43 +120,38 @@ public:
const MachineBasicBlock* getParent() const { return Parent; }
MachineBasicBlock* getParent() { return Parent; }
- /// getAsmPrinterFlags - Return the asm printer flags bitvector.
- ///
+ /// Return the asm printer flags bitvector.
uint8_t getAsmPrinterFlags() const { return AsmPrinterFlags; }
- /// clearAsmPrinterFlags - clear the AsmPrinter bitvector
- ///
+ /// Clear the AsmPrinter bitvector.
void clearAsmPrinterFlags() { AsmPrinterFlags = 0; }
- /// getAsmPrinterFlag - Return whether an AsmPrinter flag is set.
- ///
+ /// Return whether an AsmPrinter flag is set.
bool getAsmPrinterFlag(CommentFlag Flag) const {
return AsmPrinterFlags & Flag;
}
- /// setAsmPrinterFlag - Set a flag for the AsmPrinter.
- ///
+ /// Set a flag for the AsmPrinter.
void setAsmPrinterFlag(CommentFlag Flag) {
AsmPrinterFlags |= (uint8_t)Flag;
}
- /// clearAsmPrinterFlag - clear specific AsmPrinter flags
- ///
+ /// Clear specific AsmPrinter flags.
void clearAsmPrinterFlag(CommentFlag Flag) {
AsmPrinterFlags &= ~Flag;
}
- /// getFlags - Return the MI flags bitvector.
+ /// Return the MI flags bitvector.
uint8_t getFlags() const {
return Flags;
}
- /// getFlag - Return whether an MI flag is set.
+ /// Return whether an MI flag is set.
bool getFlag(MIFlag Flag) const {
return Flags & Flag;
}
- /// setFlag - Set a MI flag.
+ /// Set a MI flag.
void setFlag(MIFlag Flag) {
Flags |= (uint8_t)Flag;
}
@@ -172,8 +167,7 @@ public:
Flags &= ~((uint8_t)Flag);
}
- /// isInsideBundle - Return true if MI is in a bundle (but not the first MI
- /// in a bundle).
+ /// Return true if MI is in a bundle (but not the first MI in a bundle).
///
/// A bundle looks like this before it's finalized:
/// ----------------
@@ -212,7 +206,7 @@ public:
return getFlag(BundledPred);
}
- /// isBundled - Return true if this instruction part of a bundle. This is true
+ /// Return true if this instruction part of a bundle. This is true
/// if either itself or its following instruction is marked "InsideBundle".
bool isBundled() const {
return isBundledWithPred() || isBundledWithSucc();
@@ -240,26 +234,25 @@ public:
/// Break bundle below this instruction.
void unbundleFromSucc();
- /// getDebugLoc - Returns the debug location id of this MachineInstr.
- ///
+ /// Returns the debug location id of this MachineInstr.
const DebugLoc &getDebugLoc() const { return debugLoc; }
- /// \brief Return the debug variable referenced by
+ /// Return the debug variable referenced by
/// this DBG_VALUE instruction.
const DILocalVariable *getDebugVariable() const {
assert(isDebugValue() && "not a DBG_VALUE");
return cast<DILocalVariable>(getOperand(2).getMetadata());
}
- /// \brief Return the complex address expression referenced by
+ /// Return the complex address expression referenced by
/// this DBG_VALUE instruction.
const DIExpression *getDebugExpression() const {
assert(isDebugValue() && "not a DBG_VALUE");
return cast<DIExpression>(getOperand(3).getMetadata());
}
- /// emitError - Emit an error referring to the source location of this
- /// instruction. This should only be used for inline assembly that is somehow
+ /// Emit an error referring to the source location of this instruction.
+ /// This should only be used for inline assembly that is somehow
/// impossible to compile. Other errors should have been handled much
/// earlier.
///
@@ -267,8 +260,7 @@ public:
///
void emitError(StringRef Msg) const;
- /// getDesc - Returns the target instruction descriptor of this
- /// MachineInstr.
+ /// Returns the target instruction descriptor of this MachineInstr.
const MCInstrDesc &getDesc() const { return *MCID; }
/// Returns the opcode of this MachineInstr.
@@ -287,8 +279,7 @@ public:
return Operands[i];
}
- /// getNumExplicitOperands - Returns the number of non-implicit operands.
- ///
+ /// Returns the number of non-implicit operands.
unsigned getNumExplicitOperands() const;
/// iterator/begin/end - Iterate over all operands of a machine instruction.
@@ -352,8 +343,7 @@ public:
return iterator_range<mmo_iterator>(memoperands_begin(), memoperands_end());
}
- /// hasOneMemOperand - Return true if this instruction has exactly one
- /// MachineMemOperand.
+ /// Return true if this instruction has exactly one MachineMemOperand.
bool hasOneMemOperand() const {
return NumMemRefs == 1;
}
@@ -367,7 +357,7 @@ public:
AllInBundle // Return true if all instructions in bundle have property
};
- /// hasProperty - Return true if the instruction (or in the case of a bundle,
+ /// Return true if the instruction (or in the case of a bundle,
/// the instructions inside the bundle) has the specified property.
/// The first argument is the property being queried.
/// The second argument indicates whether the query should look inside
@@ -381,23 +371,22 @@ public:
return hasPropertyInBundle(1 << MCFlag, Type);
}
- /// isVariadic - Return true if this instruction can have a variable number of
- /// operands. In this case, the variable operands will be after the normal
+ /// Return true if this instruction can have a variable number of operands.
+ /// In this case, the variable operands will be after the normal
/// operands but before the implicit definitions and uses (if any are
/// present).
bool isVariadic(QueryType Type = IgnoreBundle) const {
return hasProperty(MCID::Variadic, Type);
}
- /// hasOptionalDef - Set if this instruction has an optional definition, e.g.
+ /// Set if this instruction has an optional definition, e.g.
/// ARM instructions which can set condition code if 's' bit is set.
bool hasOptionalDef(QueryType Type = IgnoreBundle) const {
return hasProperty(MCID::HasOptionalDef, Type);
}
- /// isPseudo - Return true if this is a pseudo instruction that doesn't
+ /// Return true if this is a pseudo instruction that doesn't
/// correspond to a real machine instruction.
- ///
bool isPseudo(QueryType Type = IgnoreBundle) const {
return hasProperty(MCID::Pseudo, Type);
}
@@ -410,16 +399,15 @@ public:
return hasProperty(MCID::Call, Type);
}
- /// isBarrier - Returns true if the specified instruction stops control flow
+ /// Returns true if the specified instruction stops control flow
/// from executing the instruction immediately following it. Examples include
/// unconditional branches and return instructions.
bool isBarrier(QueryType Type = AnyInBundle) const {
return hasProperty(MCID::Barrier, Type);
}
- /// isTerminator - Returns true if this instruction part of the terminator for
- /// a basic block. Typically this is things like return and branch
- /// instructions.
+ /// Returns true if this instruction part of the terminator for a basic block.
+ /// Typically this is things like return and branch instructions.
///
/// Various passes use this to insert code into the bottom of a basic block,
/// but before control flow occurs.
@@ -427,21 +415,21 @@ public:
return hasProperty(MCID::Terminator, Type);
}
- /// isBranch - Returns true if this is a conditional, unconditional, or
- /// indirect branch. Predicates below can be used to discriminate between
+ /// Returns true if this is a conditional, unconditional, or indirect branch.
+ /// Predicates below can be used to discriminate between
/// these cases, and the TargetInstrInfo::AnalyzeBranch method can be used to
/// get more information.
bool isBranch(QueryType Type = AnyInBundle) const {
return hasProperty(MCID::Branch, Type);
}
- /// isIndirectBranch - Return true if this is an indirect branch, such as a
+ /// Return true if this is an indirect branch, such as a
/// branch through a register.
bool isIndirectBranch(QueryType Type = AnyInBundle) const {
return hasProperty(MCID::IndirectBranch, Type);
}
- /// isConditionalBranch - Return true if this is a branch which may fall
+ /// Return true if this is a branch which may fall
/// through to the next instruction or may transfer control flow to some other
/// block. The TargetInstrInfo::AnalyzeBranch method can be used to get more
/// information about this branch.
@@ -449,7 +437,7 @@ public:
return isBranch(Type) & !isBarrier(Type) & !isIndirectBranch(Type);
}
- /// isUnconditionalBranch - Return true if this is a branch which always
+ /// Return true if this is a branch which always
/// transfers control flow to some other block. The
/// TargetInstrInfo::AnalyzeBranch method can be used to get more information
/// about this branch.
@@ -467,43 +455,41 @@ public:
return hasProperty(MCID::Predicable, Type);
}
- /// isCompare - Return true if this instruction is a comparison.
+ /// Return true if this instruction is a comparison.
bool isCompare(QueryType Type = IgnoreBundle) const {
return hasProperty(MCID::Compare, Type);
}
- /// isMoveImmediate - Return true if this instruction is a move immediate
+ /// Return true if this instruction is a move immediate
/// (including conditional moves) instruction.
bool isMoveImmediate(QueryType Type = IgnoreBundle) const {
return hasProperty(MCID::MoveImm, Type);
}
- /// isBitcast - Return true if this instruction is a bitcast instruction.
- ///
+ /// Return true if this instruction is a bitcast instruction.
bool isBitcast(QueryType Type = IgnoreBundle) const {
return hasProperty(MCID::Bitcast, Type);
}
- /// isSelect - Return true if this instruction is a select instruction.
- ///
+ /// Return true if this instruction is a select instruction.
bool isSelect(QueryType Type = IgnoreBundle) const {
return hasProperty(MCID::Select, Type);
}
- /// isNotDuplicable - Return true if this instruction cannot be safely
- /// duplicated. For example, if the instruction has a unique labels attached
+ /// Return true if this instruction cannot be safely duplicated.
+ /// For example, if the instruction has a unique labels attached
/// to it, duplicating it would cause multiple definition errors.
bool isNotDuplicable(QueryType Type = AnyInBundle) const {
return hasProperty(MCID::NotDuplicable, Type);
}
- /// hasDelaySlot - Returns true if the specified instruction has a delay slot
+ /// Returns true if the specified instruction has a delay slot
/// which must be filled by the code generator.
bool hasDelaySlot(QueryType Type = AnyInBundle) const {
return hasProperty(MCID::DelaySlot, Type);
}
- /// canFoldAsLoad - Return true for instructions that can be folded as
+ /// Return true for instructions that can be folded as
/// memory operands in other instructions. The most common use for this
/// is instructions that are simple loads from memory that don't modify
/// the loaded value in any way, but it can also be used for instructions
@@ -562,7 +548,7 @@ public:
// Side Effect Analysis
//===--------------------------------------------------------------------===//
- /// mayLoad - Return true if this instruction could possibly read memory.
+ /// Return true if this instruction could possibly read memory.
/// Instructions with this flag set are not necessarily simple load
/// instructions, they may load a value and modify it, for example.
bool mayLoad(QueryType Type = AnyInBundle) const {
@@ -575,7 +561,7 @@ public:
}
- /// mayStore - Return true if this instruction could possibly modify memory.
+ /// Return true if this instruction could possibly modify memory.
/// Instructions with this flag set are not necessarily simple store
/// instructions, they may store a modified value based on their operands, or
/// may not actually modify anything, for example.
@@ -592,7 +578,7 @@ public:
// Flags that indicate whether an instruction can be modified by a method.
//===--------------------------------------------------------------------===//
- /// isCommutable - Return true if this may be a 2- or 3-address
+ /// Return true if this may be a 2- or 3-address
/// instruction (of the form "X = op Y, Z, ..."), which produces the same
/// result if Y and Z are exchanged. If this flag is set, then the
/// TargetInstrInfo::commuteInstruction method may be used to hack on the
@@ -606,7 +592,7 @@ public:
return hasProperty(MCID::Commutable, Type);
}
- /// isConvertibleTo3Addr - Return true if this is a 2-address instruction
+ /// Return true if this is a 2-address instruction
/// which can be changed into a 3-address instruction if needed. Doing this
/// transformation can be profitable in the register allocator, because it
/// means that the instruction can use a 2-address form if possible, but
@@ -624,7 +610,7 @@ public:
return hasProperty(MCID::ConvertibleTo3Addr, Type);
}
- /// usesCustomInsertionHook - Return true if this instruction requires
+ /// Return true if this instruction requires
/// custom insertion support when the DAG scheduler is inserting it into a
/// machine basic block. If this is true for the instruction, it basically
/// means that it is a pseudo instruction used at SelectionDAG time that is
@@ -636,7 +622,7 @@ public:
return hasProperty(MCID::UsesCustomInserter, Type);
}
- /// hasPostISelHook - Return true if this instruction requires *adjustment*
+ /// Return true if this instruction requires *adjustment*
/// after instruction selection by calling a target hook. For example, this
/// can be used to fill in ARM 's' optional operand depending on whether
/// the conditional flag register is used.
@@ -644,8 +630,8 @@ public:
return hasProperty(MCID::HasPostISelHook, Type);
}
- /// isRematerializable - Returns true if this instruction is a candidate for
- /// remat. This flag is deprecated, please don't use it anymore. If this
+ /// Returns true if this instruction is a candidate for remat.
+ /// This flag is deprecated, please don't use it anymore. If this
/// flag is set, the isReallyTriviallyReMaterializable() method is called to
/// verify the instruction is really rematable.
bool isRematerializable(QueryType Type = AllInBundle) const {
@@ -654,9 +640,9 @@ public:
return hasProperty(MCID::Rematerializable, Type);
}
- /// isAsCheapAsAMove - Returns true if this instruction has the same cost (or
- /// less) than a move instruction. This is useful during certain types of
- /// optimizations (e.g., remat during two-address conversion or machine licm)
+ /// Returns true if this instruction has the same cost (or less) than a move
+ /// instruction. This is useful during certain types of optimizations
+ /// (e.g., remat during two-address conversion or machine licm)
/// where we would like to remat or hoist the instruction, but not if it costs
/// more than moving the instruction into the appropriate register. Note, we
/// are not marking copies from and to the same register class with this flag.
@@ -665,7 +651,7 @@ public:
return hasProperty(MCID::CheapAsAMove, Type);
}
- /// hasExtraSrcRegAllocReq - Returns true if this instruction source operands
+ /// Returns true if this instruction source operands
/// have special register allocation requirements that are not captured by the
/// operand register classes. e.g. ARM::STRD's two source registers must be an
/// even / odd pair, ARM::STM registers have to be in ascending order.
@@ -675,7 +661,7 @@ public:
return hasProperty(MCID::ExtraSrcRegAllocReq, Type);
}
- /// hasExtraDefRegAllocReq - Returns true if this instruction def operands
+ /// Returns true if this instruction def operands
/// have special register allocation requirements that are not captured by the
/// operand register classes. e.g. ARM::LDRD's two def registers must be an
/// even / odd pair, ARM::LDM registers have to be in ascending order.
@@ -693,7 +679,7 @@ public:
IgnoreVRegDefs // Ignore virtual register definitions
};
- /// isIdenticalTo - Return true if this instruction is identical to (same
+ /// Return true if this instruction is identical to (same
/// opcode and same operands as) the specified instruction.
bool isIdenticalTo(const MachineInstr *Other,
MICheckType Check = CheckDefs) const;
@@ -734,8 +720,7 @@ public:
bool isEHLabel() const { return getOpcode() == TargetOpcode::EH_LABEL; }
bool isGCLabel() const { return getOpcode() == TargetOpcode::GC_LABEL; }
- /// isLabel - Returns true if the MachineInstr represents a label.
- ///
+ /// Returns true if the MachineInstr represents a label.
bool isLabel() const { return isEHLabel() || isGCLabel(); }
bool isCFIInstruction() const {
return getOpcode() == TargetOpcode::CFI_INSTRUCTION;
@@ -784,19 +769,19 @@ public:
return getOpcode() == TargetOpcode::EXTRACT_SUBREG;
}
- /// isCopyLike - Return true if the instruction behaves like a copy.
+ /// Return true if the instruction behaves like a copy.
/// This does not include native copy instructions.
bool isCopyLike() const {
return isCopy() || isSubregToReg();
}
- /// isIdentityCopy - Return true is the instruction is an identity copy.
+ /// Return true is the instruction is an identity copy.
bool isIdentityCopy() const {
return isCopy() && getOperand(0).getReg() == getOperand(1).getReg() &&
getOperand(0).getSubReg() == getOperand(1).getSubReg();
}
- /// isTransient - Return true if this is a transient instruction that is
+ /// Return true if this is a transient instruction that is
/// either very likely to be eliminated during register allocation (such as
/// copy-like instructions), or if this instruction doesn't have an
/// execution-time cost.
@@ -827,8 +812,8 @@ public:
/// skips, 0 for unbundled instructions.
unsigned getBundleSize() const;
- /// readsRegister - Return true if the MachineInstr reads the specified
- /// register. If TargetRegisterInfo is passed, then it also checks if there
+ /// Return true if the MachineInstr reads the specified register.
+ /// If TargetRegisterInfo is passed, then it also checks if there
/// is a read of a super-register.
/// This does not count partial redefines of virtual registers as reads:
/// %reg1024:6 = OP.
@@ -837,30 +822,29 @@ public:
return findRegisterUseOperandIdx(Reg, false, TRI) != -1;
}
- /// readsVirtualRegister - Return true if the MachineInstr reads the specified
- /// virtual register. Take into account that a partial define is a
+ /// Return true if the MachineInstr reads the specified virtual register.
+ /// Take into account that a partial define is a
/// read-modify-write operation.
bool readsVirtualRegister(unsigned Reg) const {
return readsWritesVirtualRegister(Reg).first;
}
- /// readsWritesVirtualRegister - Return a pair of bools (reads, writes)
- /// indicating if this instruction reads or writes Reg. This also considers
- /// partial defines.
+ /// Return a pair of bools (reads, writes) indicating if this instruction
+ /// reads or writes Reg. This also considers partial defines.
/// If Ops is not null, all operand indices for Reg are added.
std::pair<bool,bool> readsWritesVirtualRegister(unsigned Reg,
SmallVectorImpl<unsigned> *Ops = nullptr) const;
- /// killsRegister - Return true if the MachineInstr kills the specified
- /// register. If TargetRegisterInfo is passed, then it also checks if there is
+ /// Return true if the MachineInstr kills the specified register.
+ /// If TargetRegisterInfo is passed, then it also checks if there is
/// a kill of a super-register.
bool killsRegister(unsigned Reg,
const TargetRegisterInfo *TRI = nullptr) const {
return findRegisterUseOperandIdx(Reg, true, TRI) != -1;
}
- /// definesRegister - Return true if the MachineInstr fully defines the
- /// specified register. If TargetRegisterInfo is passed, then it also checks
+ /// Return true if the MachineInstr fully defines the specified register.
+ /// If TargetRegisterInfo is passed, then it also checks
/// if there is a def of a super-register.
/// NOTE: It's ignoring subreg indices on virtual registers.
bool definesRegister(unsigned Reg,
@@ -868,28 +852,28 @@ public:
return findRegisterDefOperandIdx(Reg, false, false, TRI) != -1;
}
- /// modifiesRegister - Return true if the MachineInstr modifies (fully define
- /// or partially define) the specified register.
+ /// Return true if the MachineInstr modifies (fully define or partially
+ /// define) the specified register.
/// NOTE: It's ignoring subreg indices on virtual registers.
bool modifiesRegister(unsigned Reg, const TargetRegisterInfo *TRI) const {
return findRegisterDefOperandIdx(Reg, false, true, TRI) != -1;
}
- /// registerDefIsDead - Returns true if the register is dead in this machine
- /// instruction. If TargetRegisterInfo is passed, then it also checks
+ /// Returns true if the register is dead in this machine instruction.
+ /// If TargetRegisterInfo is passed, then it also checks
/// if there is a dead def of a super-register.
bool registerDefIsDead(unsigned Reg,
const TargetRegisterInfo *TRI = nullptr) const {
return findRegisterDefOperandIdx(Reg, true, false, TRI) != -1;
}
- /// findRegisterUseOperandIdx() - Returns the operand index that is a use of
- /// the specific register or -1 if it is not found. It further tightens
- /// the search criteria to a use that kills the register if isKill is true.
+ /// Returns the operand index that is a use of the specific register or -1
+ /// if it is not found. It further tightens the search criteria to a use
+ /// that kills the register if isKill is true.
int findRegisterUseOperandIdx(unsigned Reg, bool isKill = false,
const TargetRegisterInfo *TRI = nullptr) const;
- /// findRegisterUseOperand - Wrapper for findRegisterUseOperandIdx, it returns
+ /// Wrapper for findRegisterUseOperandIdx, it returns
/// a pointer to the MachineOperand rather than an index.
MachineOperand *findRegisterUseOperand(unsigned Reg, bool isKill = false,
const TargetRegisterInfo *TRI = nullptr) {
@@ -897,17 +881,17 @@ public:
return (Idx == -1) ? nullptr : &getOperand(Idx);
}
- /// findRegisterDefOperandIdx() - Returns the operand index that is a def of
- /// the specified register or -1 if it is not found. If isDead is true, defs
- /// that are not dead are skipped. If Overlap is true, then it also looks for
- /// defs that merely overlap the specified register. If TargetRegisterInfo is
- /// non-null, then it also checks if there is a def of a super-register.
+ /// Returns the operand index that is a def of the specified register or
+ /// -1 if it is not found. If isDead is true, defs that are not dead are
+ /// skipped. If Overlap is true, then it also looks for defs that merely
+ /// overlap the specified register. If TargetRegisterInfo is non-null,
+ /// then it also checks if there is a def of a super-register.
/// This may also return a register mask operand when Overlap is true.
int findRegisterDefOperandIdx(unsigned Reg,
bool isDead = false, bool Overlap = false,
const TargetRegisterInfo *TRI = nullptr) const;
- /// findRegisterDefOperand - Wrapper for findRegisterDefOperandIdx, it returns
+ /// Wrapper for findRegisterDefOperandIdx, it returns
/// a pointer to the MachineOperand rather than an index.
MachineOperand *findRegisterDefOperand(unsigned Reg, bool isDead = false,
const TargetRegisterInfo *TRI = nullptr) {
@@ -915,12 +899,12 @@ public:
return (Idx == -1) ? nullptr : &getOperand(Idx);
}
- /// findFirstPredOperandIdx() - Find the index of the first operand in the
+ /// Find the index of the first operand in the
/// operand list that is used to represent the predicate. It returns -1 if
/// none is found.
int findFirstPredOperandIdx() const;
- /// findInlineAsmFlagIdx() - Find the index of the flag word operand that
+ /// Find the index of the flag word operand that
/// corresponds to operand OpIdx on an inline asm instruction. Returns -1 if
/// getOperand(OpIdx) does not belong to an inline asm operand group.
///
@@ -932,9 +916,9 @@ public:
///
int findInlineAsmFlagIdx(unsigned OpIdx, unsigned *GroupNo = nullptr) const;
- /// getRegClassConstraint - Compute the static register class constraint for
- /// operand OpIdx. For normal instructions, this is derived from the
- /// MCInstrDesc. For inline assembly it is derived from the flag words.
+ /// Compute the static register class constraint for operand OpIdx.
+ /// For normal instructions, this is derived from the MCInstrDesc.
+ /// For inline assembly it is derived from the flag words.
///
/// Returns NULL if the static register classs constraint cannot be
/// determined.
@@ -975,20 +959,20 @@ public:
const TargetInstrInfo *TII,
const TargetRegisterInfo *TRI) const;
- /// tieOperands - Add a tie between the register operands at DefIdx and
- /// UseIdx. The tie will cause the register allocator to ensure that the two
+ /// Add a tie between the register operands at DefIdx and UseIdx.
+ /// The tie will cause the register allocator to ensure that the two
/// operands are assigned the same physical register.
///
/// Tied operands are managed automatically for explicit operands in the
/// MCInstrDesc. This method is for exceptional cases like inline asm.
void tieOperands(unsigned DefIdx, unsigned UseIdx);
- /// findTiedOperandIdx - Given the index of a tied register operand, find the
+ /// Given the index of a tied register operand, find the
/// operand it is tied to. Defs are tied to uses and vice versa. Returns the
/// index of the tied operand which must exist.
unsigned findTiedOperandIdx(unsigned OpIdx) const;
- /// isRegTiedToUseOperand - Given the index of a register def operand,
+ /// Given the index of a register def operand,
/// check if the register def is tied to a source operand, due to either
/// two-address elimination or inline assembly constraints. Returns the
/// first tied use operand index by reference if UseOpIdx is not null.
@@ -1002,9 +986,9 @@ public:
return true;
}
- /// isRegTiedToDefOperand - Return true if the use operand of the specified
- /// index is tied to a def operand. It also returns the def operand index by
- /// reference if DefOpIdx is not null.
+ /// Return true if the use operand of the specified index is tied to a def
+ /// operand. It also returns the def operand index by reference if DefOpIdx
+ /// is not null.
bool isRegTiedToDefOperand(unsigned UseOpIdx,
unsigned *DefOpIdx = nullptr) const {
const MachineOperand &MO = getOperand(UseOpIdx);
@@ -1015,16 +999,15 @@ public:
return true;
}
- /// clearKillInfo - Clears kill flags on all operands.
- ///
+ /// Clears kill flags on all operands.
void clearKillInfo();
- /// substituteRegister - Replace all occurrences of FromReg with ToReg:SubIdx,
+ /// Replace all occurrences of FromReg with ToReg:SubIdx,
/// properly composing subreg indices where necessary.
void substituteRegister(unsigned FromReg, unsigned ToReg, unsigned SubIdx,
const TargetRegisterInfo &RegInfo);
- /// addRegisterKilled - We have determined MI kills a register. Look for the
+ /// We have determined MI kills a register. Look for the
/// operand that uses it and mark it as IsKill. If AddIfNotFound is true,
/// add a implicit operand if it's not found. Returns true if the operand
/// exists / is added.
@@ -1032,11 +1015,11 @@ public:
const TargetRegisterInfo *RegInfo,
bool AddIfNotFound = false);
- /// clearRegisterKills - Clear all kill flags affecting Reg. If RegInfo is
+ /// Clear all kill flags affecting Reg. If RegInfo is
/// provided, this includes super-register kills.
void clearRegisterKills(unsigned Reg, const TargetRegisterInfo *RegInfo);
- /// addRegisterDead - We have determined MI defined a register without a use.
+ /// We have determined MI defined a register without a use.
/// Look for the operand that defines it and mark it as IsDead. If
/// AddIfNotFound is true, add a implicit operand if it's not found. Returns
/// true if the operand exists / is added.
@@ -1051,12 +1034,12 @@ public:
/// otherwise undefined super register.
void addRegisterDefReadUndef(unsigned Reg);
- /// addRegisterDefined - We have determined MI defines a register. Make sure
- /// there is an operand defining Reg.
+ /// We have determined MI defines a register. Make sure there is an operand
+ /// defining Reg.
void addRegisterDefined(unsigned Reg,
const TargetRegisterInfo *RegInfo = nullptr);
- /// setPhysRegsDeadExcept - Mark every physreg used by this instruction as
+ /// Mark every physreg used by this instruction as
/// dead except those in the UsedRegs list.
///
/// On instructions with register mask operands, also add implicit-def
@@ -1064,31 +1047,30 @@ public:
void setPhysRegsDeadExcept(ArrayRef<unsigned> UsedRegs,
const TargetRegisterInfo &TRI);
- /// isSafeToMove - Return true if it is safe to move this instruction. If
+ /// Return true if it is safe to move this instruction. If
/// SawStore is set to true, it means that there is a store (or call) between
/// the instruction's location and its intended destination.
bool isSafeToMove(AliasAnalysis *AA, bool &SawStore) const;
- /// hasOrderedMemoryRef - Return true if this instruction may have an ordered
+ /// Return true if this instruction may have an ordered
/// or volatile memory reference, or if the information describing the memory
/// reference is not available. Return false if it is known to have no
/// ordered or volatile memory references.
bool hasOrderedMemoryRef() const;
- /// isInvariantLoad - Return true if this instruction is loading from a
+ /// Return true if this instruction is loading from a
/// location whose value is invariant across the function. For example,
/// loading a value from the constant pool or from the argument area of
/// a function if it does not change. This should only return true of *all*
/// loads the instruction does are invariant (if it does multiple loads).
bool isInvariantLoad(AliasAnalysis *AA) const;
- /// isConstantValuePHI - If the specified instruction is a PHI that always
- /// merges together the same virtual register, return the register, otherwise
- /// return 0.
+ /// If the specified instruction is a PHI that always merges together the
+ /// same virtual register, return the register, otherwise return 0.
unsigned isConstantValuePHI() const;
- /// hasUnmodeledSideEffects - Return true if this instruction has side
- /// effects that are not modeled by mayLoad / mayStore, etc.
+ /// Return true if this instruction has side effects that are not modeled
+ /// by mayLoad / mayStore, etc.
/// For all instructions, the property is encoded in MCInstrDesc::Flags
/// (see MCInstrDesc::hasUnmodeledSideEffects(). The only exception is
/// INLINEASM instruction, in which case the side effect property is encoded
@@ -1096,11 +1078,10 @@ public:
///
bool hasUnmodeledSideEffects() const;
- /// allDefsAreDead - Return true if all the defs of this instruction are dead.
- ///
+ /// Return true if all the defs of this instruction are dead.
bool allDefsAreDead() const;
- /// copyImplicitOps - Copy implicit register operands from specified
+ /// Copy implicit register operands from specified
/// instruction to this instruction.
void copyImplicitOps(MachineFunction &MF, const MachineInstr *MI);
@@ -1132,44 +1113,41 @@ public:
/// preferred.
void addOperand(const MachineOperand &Op);
- /// setDesc - Replace the instruction descriptor (thus opcode) of
+ /// Replace the instruction descriptor (thus opcode) of
/// the current instruction with a new one.
- ///
void setDesc(const MCInstrDesc &tid) { MCID = &tid; }
- /// setDebugLoc - Replace current source information with new such.
+ /// Replace current source information with new such.
/// Avoid using this, the constructor argument is preferable.
- ///
void setDebugLoc(DebugLoc dl) {
debugLoc = std::move(dl);
assert(debugLoc.hasTrivialDestructor() && "Expected trivial destructor");
}
- /// RemoveOperand - Erase an operand from an instruction, leaving it with one
+ /// Erase an operand from an instruction, leaving it with one
/// fewer operand than it started with.
- ///
void RemoveOperand(unsigned i);
- /// addMemOperand - Add a MachineMemOperand to the machine instruction.
+ /// Add a MachineMemOperand to the machine instruction.
/// This function should be used only occasionally. The setMemRefs function
/// is the primary method for setting up a MachineInstr's MemRefs list.
void addMemOperand(MachineFunction &MF, MachineMemOperand *MO);
- /// setMemRefs - Assign this MachineInstr's memory reference descriptor
- /// list. This does not transfer ownership.
+ /// Assign this MachineInstr's memory reference descriptor list.
+ /// This does not transfer ownership.
void setMemRefs(mmo_iterator NewMemRefs, mmo_iterator NewMemRefsEnd) {
MemRefs = NewMemRefs;
NumMemRefs = uint8_t(NewMemRefsEnd - NewMemRefs);
assert(NumMemRefs == NewMemRefsEnd - NewMemRefs && "Too many memrefs");
}
- /// clearMemRefs - Clear this MachineInstr's memory reference descriptor list.
+ /// Clear this MachineInstr's memory reference descriptor list.
void clearMemRefs() {
MemRefs = nullptr;
NumMemRefs = 0;
}
- /// untieRegOperand - Break any tie involving OpIdx.
+ /// Break any tie involving OpIdx.
void untieRegOperand(unsigned OpIdx) {
MachineOperand &MO = getOperand(OpIdx);
if (MO.isReg() && MO.isTied()) {
@@ -1180,27 +1158,25 @@ public:
private:
- /// getRegInfo - If this instruction is embedded into a MachineFunction,
- /// return the MachineRegisterInfo object for the current function, otherwise
+ /// If this instruction is embedded into a MachineFunction, return the
+ /// MachineRegisterInfo object for the current function, otherwise
/// return null.
MachineRegisterInfo *getRegInfo();
- /// addImplicitDefUseOperands - Add all implicit def and use operands to
- /// this instruction.
+ /// Add all implicit def and use operands to this instruction.
void addImplicitDefUseOperands(MachineFunction &MF);
- /// RemoveRegOperandsFromUseLists - Unlink all of the register operands in
- /// this instruction from their respective use lists. This requires that the
- /// operands already be on their use lists.
+ /// Unlink all of the register operands in this instruction from their
+ /// respective use lists. This requires that the operands already be on their
+ /// use lists.
void RemoveRegOperandsFromUseLists(MachineRegisterInfo&);
- /// AddRegOperandsToUseLists - Add all of the register operands in
- /// this instruction from their respective use lists. This requires that the
- /// operands not be on their use lists yet.
+ /// Add all of the register operands in this instruction from their
+ /// respective use lists. This requires that the operands not be on their
+ /// use lists yet.
void AddRegOperandsToUseLists(MachineRegisterInfo&);
- /// hasPropertyInBundle - Slow path for hasProperty when we're dealing with a
- /// bundle.
+ /// Slow path for hasProperty when we're dealing with a bundle.
bool hasPropertyInBundle(unsigned Mask, QueryType Type) const;
/// \brief Implements the logic of getRegClassConstraintEffectForVReg for the
@@ -1211,8 +1187,8 @@ private:
const TargetInstrInfo *TII, const TargetRegisterInfo *TRI) const;
};
-/// MachineInstrExpressionTrait - Special DenseMapInfo traits to compare
-/// MachineInstr* by *value* of the instruction rather than by pointer value.
+/// Special DenseMapInfo traits to compare MachineInstr* by *value* of the
+/// instruction rather than by pointer value.
/// The hashing and equality testing functions ignore definitions so this is
/// useful for CSE, etc.
struct MachineInstrExpressionTrait : DenseMapInfo<MachineInstr*> {
More information about the llvm-commits
mailing list