LLVM  6.0.0svn
Classes | Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
llvm::InlineAsm Class Referencefinal

#include "llvm/IR/InlineAsm.h"

Inheritance diagram for llvm::InlineAsm:
Inheritance graph
[legend]
Collaboration diagram for llvm::InlineAsm:
Collaboration graph
[legend]

Classes

struct  ConstraintInfo
 
struct  SubConstraintInfo
 

Public Types

enum  AsmDialect { AD_ATT, AD_Intel }
 
enum  ConstraintPrefix { isInput, isOutput, isClobber }
 
enum  : uint32_t {
  Op_InputChain = 0, Op_AsmString = 1, Op_MDNode = 2, Op_ExtraInfo = 3,
  Op_FirstOperand = 4, MIOp_AsmString = 0, MIOp_ExtraInfo = 1, MIOp_FirstOperand = 2,
  Extra_HasSideEffects = 1, Extra_IsAlignStack = 2, Extra_AsmDialect = 4, Extra_MayLoad = 8,
  Extra_MayStore = 16, Extra_IsConvergent = 32, Kind_RegUse = 1, Kind_RegDef = 2,
  Kind_RegDefEarlyClobber = 3, Kind_Clobber = 4, Kind_Imm = 5, Kind_Mem = 6,
  Constraint_Unknown = 0, Constraint_es, Constraint_i, Constraint_m,
  Constraint_o, Constraint_v, Constraint_Q, Constraint_R,
  Constraint_S, Constraint_T, Constraint_Um, Constraint_Un,
  Constraint_Uq, Constraint_Us, Constraint_Ut, Constraint_Uv,
  Constraint_Uy, Constraint_X, Constraint_Z, Constraint_ZC,
  Constraint_Zy, Constraints_Max = Constraint_Zy, Constraints_ShiftAmount = 16, Flag_MatchingOperand = 0x80000000
}
 
using ConstraintCodeVector = std::vector< std::string >
 
using SubConstraintInfoVector = std::vector< SubConstraintInfo >
 
using ConstraintInfoVector = std::vector< ConstraintInfo >
 
- Public Types inherited from llvm::Value
enum  ValueTy
 Concrete subclass of this. More...
 
using use_iterator = use_iterator_impl< Use >
 
using const_use_iterator = use_iterator_impl< const Use >
 
using user_iterator = user_iterator_impl< User >
 
using const_user_iterator = user_iterator_impl< const User >
 

Public Member Functions

 InlineAsm (const InlineAsm &)=delete
 
InlineAsmoperator= (const InlineAsm &)=delete
 
bool hasSideEffects () const
 
bool isAlignStack () const
 
AsmDialect getDialect () const
 
PointerTypegetType () const
 getType - InlineAsm's are always pointers. More...
 
FunctionTypegetFunctionType () const
 getFunctionType - InlineAsm's are always pointers to functions. More...
 
const std::string & getAsmString () const
 
const std::string & getConstraintString () const
 
ConstraintInfoVector ParseConstraints () const
 ParseConstraints - Parse the constraints of this inlineasm object, returning them the same way that ParseConstraints(str) does. More...
 
- Public Member Functions inherited from llvm::Value
 Value (const Value &)=delete
 
Valueoperator= (const Value &)=delete
 
void deleteValue ()
 Delete a pointer to a generic Value. More...
 
void dump () const
 Support for debugging, callable in GDB: V->dump() More...
 
TypegetType () const
 All values are typed, get the type of this value. More...
 
LLVMContextgetContext () const
 All values hold a context through their type. More...
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 Return a constant reference to the value's name. More...
 
void setName (const Twine &Name)
 Change the name of the value. More...
 
void takeName (Value *V)
 Transfer the name from V to this value. More...
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value. More...
 
void replaceNonMetadataUsesWith (Value *V)
 Change non-metadata uses of this to point to a new Value. More...
 
void replaceUsesOutsideBlock (Value *V, BasicBlock *BB)
 replaceUsesOutsideBlock - Go through the uses list for this definition and make each use point to "V" instead of "this" when the use is outside the block. More...
 
void assertModuleIsMaterializedImpl () const
 
void assertModuleIsMaterialized () const
 
bool use_empty () const
 
use_iterator materialized_use_begin ()
 
const_use_iterator materialized_use_begin () const
 
use_iterator use_begin ()
 
const_use_iterator use_begin () const
 
use_iterator use_end ()
 
const_use_iterator use_end () const
 
iterator_range< use_iteratormaterialized_uses ()
 
iterator_range< const_use_iteratormaterialized_uses () const
 
iterator_range< use_iteratoruses ()
 
iterator_range< const_use_iteratoruses () const
 
bool user_empty () const
 
user_iterator materialized_user_begin ()
 
const_user_iterator materialized_user_begin () const
 
user_iterator user_begin ()
 
const_user_iterator user_begin () const
 
user_iterator user_end ()
 
const_user_iterator user_end () const
 
Useruser_back ()
 
const Useruser_back () const
 
iterator_range< user_iteratormaterialized_users ()
 
iterator_range< const_user_iteratormaterialized_users () const
 
iterator_range< user_iteratorusers ()
 
iterator_range< const_user_iteratorusers () const
 
bool hasOneUse () const
 Return true if there is exactly one user of this value. More...
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N users. More...
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N users or more. More...
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 Check if this value is used in the specified basic block. More...
 
unsigned getNumUses () const
 This method computes the number of uses of this Value. More...
 
void addUse (Use &U)
 This method should only be used by the Use class. More...
 
unsigned getValueID () const
 Return an ID for the concrete type of this object. More...
 
unsigned getRawSubclassOptionalData () const
 Return the raw optional flags value contained in this value. More...
 
void clearSubclassOptionalData ()
 Clear the optional flags contained in this value. More...
 
bool hasSameSubclassOptionalData (const Value *V) const
 Check the optional flags for equality. More...
 
bool hasValueHandle () const
 Return true if there is a value handle associated with this value. More...
 
bool isUsedByMetadata () const
 Return true if there is metadata referencing this value. More...
 
bool isSwiftError () const
 Return true if this value is a swifterror value. More...
 
const ValuestripPointerCasts () const
 Strip off pointer casts, all-zero GEPs, and aliases. More...
 
ValuestripPointerCasts ()
 
const ValuestripPointerCastsAndBarriers () const
 Strip off pointer casts, all-zero GEPs, aliases and barriers. More...
 
ValuestripPointerCastsAndBarriers ()
 
const ValuestripPointerCastsNoFollowAliases () const
 Strip off pointer casts and all-zero GEPs. More...
 
ValuestripPointerCastsNoFollowAliases ()
 
const ValuestripInBoundsConstantOffsets () const
 Strip off pointer casts and all-constant inbounds GEPs. More...
 
ValuestripInBoundsConstantOffsets ()
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 Accumulate offsets from stripInBoundsConstantOffsets(). More...
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 
const ValuestripInBoundsOffsets () const
 Strip off pointer casts and inbounds GEPs. More...
 
ValuestripInBoundsOffsets ()
 
unsigned getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull) const
 Returns the number of bytes known to be dereferenceable for the pointer value. More...
 
unsigned getPointerAlignment (const DataLayout &DL) const
 Returns an alignment of the pointer value. More...
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 Translate PHI node to its predecessor from the given basic block. More...
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 
void mutateType (Type *Ty)
 Mutate the type of this Value to be of the specified type. More...
 
template<class Compare >
void sortUseList (Compare Cmp)
 Sort the use-list. More...
 
void reverseUseList ()
 Reverse the use-list. More...
 
void print (raw_ostream &O, bool IsForDebug=false) const
 Implement operator<< on Value. More...
 
void print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) const
 
void printAsOperand (raw_ostream &O, bool PrintType=true, const Module *M=nullptr) const
 Print the name of this Value out to the specified raw_ostream. More...
 
void printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const
 

Static Public Member Functions

static InlineAsmget (FunctionType *Ty, StringRef AsmString, StringRef Constraints, bool hasSideEffects, bool isAlignStack=false, AsmDialect asmDialect=AD_ATT)
 InlineAsm::get - Return the specified uniqued inline asm string. More...
 
static bool Verify (FunctionType *Ty, StringRef Constraints)
 Verify - This static method can be used by the parser to check to see if the specified constraint string is legal for the type. More...
 
static ConstraintInfoVector ParseConstraints (StringRef ConstraintString)
 ParseConstraints - Split up the constraint string into the specific constraints and their prefixes. More...
 
static bool classof (const Value *V)
 
static unsigned getFlagWord (unsigned Kind, unsigned NumOps)
 
static bool isRegDefKind (unsigned Flag)
 
static bool isImmKind (unsigned Flag)
 
static bool isMemKind (unsigned Flag)
 
static bool isRegDefEarlyClobberKind (unsigned Flag)
 
static bool isClobberKind (unsigned Flag)
 
static unsigned getFlagWordForMatchingOp (unsigned InputFlag, unsigned MatchedOperandNo)
 getFlagWordForMatchingOp - Augment an existing flag word returned by getFlagWord with information indicating that this input operand is tied to a previous output operand. More...
 
static unsigned getFlagWordForRegClass (unsigned InputFlag, unsigned RC)
 getFlagWordForRegClass - Augment an existing flag word returned by getFlagWord with the required register class for the following register operands. More...
 
static unsigned getFlagWordForMem (unsigned InputFlag, unsigned Constraint)
 Augment an existing flag word returned by getFlagWord with the constraint code for a memory constraint. More...
 
static unsigned convertMemFlagWordToMatchingFlagWord (unsigned InputFlag)
 
static unsigned getKind (unsigned Flags)
 
static unsigned getMemoryConstraintID (unsigned Flag)
 
static unsigned getNumOperandRegisters (unsigned Flag)
 getNumOperandRegisters - Extract the number of registers field from the inline asm operand flag. More...
 
static bool isUseOperandTiedToDef (unsigned Flag, unsigned &Idx)
 isUseOperandTiedToDef - Return true if the flag of the inline asm operand indicates it is an use operand that's matched to a def operand. More...
 
static bool hasRegClassConstraint (unsigned Flag, unsigned &RC)
 hasRegClassConstraint - Returns true if the flag contains a register class constraint. More...
 

Friends

struct InlineAsmKeyType
 
class ConstantUniqueMap< InlineAsm >
 

Additional Inherited Members

- Static Public Attributes inherited from llvm::Value
static const unsigned MaxAlignmentExponent = 29
 The maximum alignment for instructions. More...
 
static const unsigned MaximumAlignment = 1u << MaxAlignmentExponent
 
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 28 }
 The number of operands in the subclass. More...
 
- Protected Member Functions inherited from llvm::Value
 Value (Type *Ty, unsigned scid)
 
 ~Value ()
 Value's destructor should be virtual by design, but that would require that Value and all of its subclasses have a vtable that effectively duplicates the information in the value ID. More...
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
- Protected Attributes inherited from llvm::Value
unsigned char SubclassOptionalData: 7
 Hold subclass data that can be dropped. More...
 
unsigned NumUserOperands: NumUserOperandsBits
 
unsigned IsUsedByMD: 1
 
unsigned HasName: 1
 
unsigned HasHungOffUses: 1
 
unsigned HasDescriptor: 1
 

Detailed Description

Definition at line 31 of file InlineAsm.h.

Member Typedef Documentation

◆ ConstraintCodeVector

using llvm::InlineAsm::ConstraintCodeVector = std::vector<std::string>

Definition at line 97 of file InlineAsm.h.

◆ ConstraintInfoVector

Definition at line 116 of file InlineAsm.h.

◆ SubConstraintInfoVector

Definition at line 114 of file InlineAsm.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : uint32_t
Enumerator
Op_InputChain 
Op_AsmString 
Op_MDNode 
Op_ExtraInfo 
Op_FirstOperand 
MIOp_AsmString 
MIOp_ExtraInfo 
MIOp_FirstOperand 
Extra_HasSideEffects 
Extra_IsAlignStack 
Extra_AsmDialect 
Extra_MayLoad 
Extra_MayStore 
Extra_IsConvergent 
Kind_RegUse 
Kind_RegDef 
Kind_RegDefEarlyClobber 
Kind_Clobber 
Kind_Imm 
Kind_Mem 
Constraint_Unknown 
Constraint_es 
Constraint_i 
Constraint_m 
Constraint_o 
Constraint_v 
Constraint_Q 
Constraint_R 
Constraint_S 
Constraint_T 
Constraint_Um 
Constraint_Un 
Constraint_Uq 
Constraint_Us 
Constraint_Ut 
Constraint_Uv 
Constraint_Uy 
Constraint_X 
Constraint_Z 
Constraint_ZC 
Constraint_Zy 
Constraints_Max 
Constraints_ShiftAmount 
Flag_MatchingOperand 

Definition at line 207 of file InlineAsm.h.

◆ AsmDialect

Enumerator
AD_ATT 
AD_Intel 

Definition at line 33 of file InlineAsm.h.

◆ ConstraintPrefix

Enumerator
isInput 
isOutput 
isClobber 

Definition at line 91 of file InlineAsm.h.

Constructor & Destructor Documentation

◆ InlineAsm()

llvm::InlineAsm::InlineAsm ( const InlineAsm )
delete

Member Function Documentation

◆ classof()

static bool llvm::InlineAsm::classof ( const Value V)
inlinestatic

Definition at line 186 of file InlineAsm.h.

References llvm::Value::getValueID().

◆ convertMemFlagWordToMatchingFlagWord()

static unsigned llvm::InlineAsm::convertMemFlagWordToMatchingFlagWord ( unsigned  InputFlag)
inlinestatic

Definition at line 320 of file InlineAsm.h.

References assert(), Constraints_ShiftAmount, and isMemKind().

Referenced by createVirtualRegs().

◆ get()

InlineAsm * InlineAsm::get ( FunctionType Ty,
StringRef  AsmString,
StringRef  Constraints,
bool  hasSideEffects,
bool  isAlignStack = false,
AsmDialect  asmDialect = AD_ATT 
)
static

◆ getAsmString()

const std::string& llvm::InlineAsm::getAsmString ( ) const
inline

◆ getConstraintString()

const std::string& llvm::InlineAsm::getConstraintString ( ) const
inline

◆ getDialect()

AsmDialect llvm::InlineAsm::getDialect ( ) const
inline

◆ getFlagWord()

static unsigned llvm::InlineAsm::getFlagWord ( unsigned  Kind,
unsigned  NumOps 
)
inlinestatic

◆ getFlagWordForMatchingOp()

static unsigned llvm::InlineAsm::getFlagWordForMatchingOp ( unsigned  InputFlag,
unsigned  MatchedOperandNo 
)
inlinestatic

getFlagWordForMatchingOp - Augment an existing flag word returned by getFlagWord with information indicating that this input operand is tied to a previous output operand.

Definition at line 288 of file InlineAsm.h.

References assert(), and Flag_MatchingOperand.

Referenced by llvm::RegsForValue::AddInlineAsmOperands(), createVirtualRegs(), and getARClassRegisterMask().

◆ getFlagWordForMem()

static unsigned llvm::InlineAsm::getFlagWordForMem ( unsigned  InputFlag,
unsigned  Constraint 
)
inlinestatic

Augment an existing flag word returned by getFlagWord with the constraint code for a memory constraint.

Definition at line 312 of file InlineAsm.h.

References assert(), Constraints_Max, Constraints_ShiftAmount, and isMemKind().

Referenced by createVirtualRegs(), and llvm::SelectionDAGISel::SelectInlineAsmMemoryOperands().

◆ getFlagWordForRegClass()

static unsigned llvm::InlineAsm::getFlagWordForRegClass ( unsigned  InputFlag,
unsigned  RC 
)
inlinestatic

getFlagWordForRegClass - Augment an existing flag word returned by getFlagWord with the required register class for the following register operands.

A tied use operand cannot have a register class, use the register class from the def operand instead.

Definition at line 300 of file InlineAsm.h.

References assert(), isImmKind(), and isMemKind().

Referenced by llvm::RegsForValue::AddInlineAsmOperands(), and getARClassRegisterMask().

◆ getFunctionType()

FunctionType * InlineAsm::getFunctionType ( ) const

getFunctionType - InlineAsm's are always pointers to functions.

Definition at line 57 of file InlineAsm.cpp.

Referenced by llvm::FunctionComparator::cmpOperations(), getType(), and llvm::InlineAsmKeyType::operator==().

◆ getKind()

static unsigned llvm::InlineAsm::getKind ( unsigned  Flags)
inlinestatic

◆ getMemoryConstraintID()

static unsigned llvm::InlineAsm::getMemoryConstraintID ( unsigned  Flag)
inlinestatic

◆ getNumOperandRegisters()

static unsigned llvm::InlineAsm::getNumOperandRegisters ( unsigned  Flag)
inlinestatic

◆ getType()

PointerType* llvm::InlineAsm::getType ( ) const
inline

getType - InlineAsm's are always pointers.

Definition at line 73 of file InlineAsm.h.

References getFunctionType(), and llvm::Value::getType().

◆ hasRegClassConstraint()

static bool llvm::InlineAsm::hasRegClassConstraint ( unsigned  Flag,
unsigned RC 
)
inlinestatic

hasRegClassConstraint - Returns true if the flag contains a register class constraint.

Sets RC to the register class ID.

Definition at line 351 of file InlineAsm.h.

References Flag_MatchingOperand, and High.

Referenced by getARClassRegisterMask(), llvm::MachineInstr::getRegClassConstraint(), llvm::MachineInstr::print(), and llvm::ARMAsmPrinter::PrintAsmOperand().

◆ hasSideEffects()

bool llvm::InlineAsm::hasSideEffects ( ) const
inline

◆ isAlignStack()

bool llvm::InlineAsm::isAlignStack ( ) const
inline

◆ isClobberKind()

static bool llvm::InlineAsm::isClobberKind ( unsigned  Flag)
inlinestatic

Definition at line 281 of file InlineAsm.h.

References getKind(), and Kind_Clobber.

Referenced by CheckForLiveRegDef(), and getNodeRegMask().

◆ isImmKind()

static bool llvm::InlineAsm::isImmKind ( unsigned  Flag)
inlinestatic

Definition at line 276 of file InlineAsm.h.

References getKind(), and Kind_Imm.

Referenced by getFlagWordForRegClass(), and llvm::MachineInstr::print().

◆ isMemKind()

static bool llvm::InlineAsm::isMemKind ( unsigned  Flag)
inlinestatic

◆ isRegDefEarlyClobberKind()

static bool llvm::InlineAsm::isRegDefEarlyClobberKind ( unsigned  Flag)
inlinestatic

◆ isRegDefKind()

static bool llvm::InlineAsm::isRegDefKind ( unsigned  Flag)
inlinestatic

◆ isUseOperandTiedToDef()

static bool llvm::InlineAsm::isUseOperandTiedToDef ( unsigned  Flag,
unsigned Idx 
)
inlinestatic

isUseOperandTiedToDef - Return true if the flag of the inline asm operand indicates it is an use operand that's matched to a def operand.

Definition at line 342 of file InlineAsm.h.

References Flag_MatchingOperand.

Referenced by llvm::InstrEmitter::EmitDbgValue(), llvm::MachineInstr::findTiedOperandIdx(), getARClassRegisterMask(), llvm::MachineInstr::print(), llvm::ARMAsmPrinter::PrintAsmOperand(), and llvm::SelectionDAGISel::SelectInlineAsmMemoryOperands().

◆ operator=()

InlineAsm& llvm::InlineAsm::operator= ( const InlineAsm )
delete

◆ ParseConstraints() [1/2]

InlineAsm::ConstraintInfoVector InlineAsm::ParseConstraints ( StringRef  ConstraintString)
static

ParseConstraints - Split up the constraint string into the specific constraints and their prefixes.

If this returns an empty vector, and if the constraint string itself isn't empty, there was an error parsing.

Definition at line 206 of file InlineAsm.cpp.

References llvm::StringRef::begin(), E, llvm::StringRef::end(), llvm::find(), I, and llvm::InlineAsm::ConstraintInfo::Parse().

Referenced by asmClobbersCTR(), llvm::X86TargetLowering::ExpandInlineAsm(), and llvm::TargetLowering::ParseConstraints().

◆ ParseConstraints() [2/2]

ConstraintInfoVector llvm::InlineAsm::ParseConstraints ( ) const
inline

ParseConstraints - Parse the constraints of this inlineasm object, returning them the same way that ParseConstraints(str) does.

Definition at line 181 of file InlineAsm.h.

◆ Verify()

bool InlineAsm::Verify ( FunctionType Ty,
StringRef  ConstStr 
)
static

Verify - This static method can be used by the parser to check to see if the specified constraint string is legal for the type.

Verify - Verify that the specified constraint string is reasonable for the specified function type, and otherwise validate the constraint string.

This returns true if legal, false if not.

Definition at line 242 of file InlineAsm.cpp.

References llvm::dyn_cast(), llvm::StringRef::empty(), llvm::StructType::getNumElements(), llvm::FunctionType::getNumParams(), llvm::FunctionType::getReturnType(), isClobber, isInput, isOutput, llvm::Type::isStructTy(), llvm::FunctionType::isVarArg(), llvm::Type::isVoidTy(), and LLVM_FALLTHROUGH.

Referenced by FunctionNumber(), and getConstraintString().

Friends And Related Function Documentation

◆ ConstantUniqueMap< InlineAsm >

friend class ConstantUniqueMap< InlineAsm >
friend

Definition at line 40 of file InlineAsm.h.

◆ InlineAsmKeyType

friend struct InlineAsmKeyType
friend

Definition at line 39 of file InlineAsm.h.


The documentation for this class was generated from the following files: