LLVM 20.0.0git
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]

Classes

struct  ConstraintInfo
 
class  Flag
 
struct  SubConstraintInfo
 

Public Types

enum  AsmDialect { AD_ATT , AD_Intel }
 
enum  ConstraintPrefix { isInput , isOutput , isClobber , isLabel }
 
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
}
 
enum class  Kind : uint8_t {
  RegUse = 1 , RegDef = 2 , RegDefEarlyClobber = 3 , Clobber = 4 ,
  Imm = 5 , Mem = 6 , Func = 7
}
 
enum class  ConstraintCode : uint32_t {
  Unknown = 0 , es , i , k ,
  m , o , v , A ,
  Q , R , S , T ,
  Um , Un , Uq , Us ,
  Ut , Uv , Uy , X ,
  Z , ZB , ZC , Zy ,
  p , ZQ , ZR , ZS ,
  ZT , Max = ZT
}
 
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
 
bool canThrow () const
 
PointerTypegetType () const
 getType - InlineAsm's are always pointers.
 
FunctionTypegetFunctionType () const
 getFunctionType - InlineAsm's are always pointers to functions.
 
const std::string & getAsmString () const
 
const std::string & getConstraintString () const
 
void collectAsmStrs (SmallVectorImpl< StringRef > &AsmStrs) const
 
ConstraintInfoVector ParseConstraints () const
 ParseConstraints - Parse the constraints of this inlineasm object, returning them the same way that ParseConstraints(str) does.
 
- Public Member Functions inherited from llvm::Value
 Value (const Value &)=delete
 
Valueoperator= (const Value &)=delete
 
void deleteValue ()
 Delete a pointer to a generic Value.
 
void dump () const
 Support for debugging, callable in GDB: V->dump()
 
TypegetType () const
 All values are typed, get the type of this value.
 
LLVMContextgetContext () const
 All values hold a context through their type.
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 Return a constant reference to the value's name.
 
void setName (const Twine &Name)
 Change the name of the value.
 
void takeName (Value *V)
 Transfer the name from V to this value.
 
std::string getNameOrAsOperand () const
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value.
 
void replaceNonMetadataUsesWith (Value *V)
 Change non-metadata uses of this to point to a new Value.
 
void replaceUsesWithIf (Value *New, llvm::function_ref< bool(Use &U)> ShouldReplace)
 Go through the uses list for this definition and make each use point to "V" if the callback ShouldReplace returns true for the given Use.
 
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.
 
void assertModuleIsMaterializedImpl () const
 
void assertModuleIsMaterialized () const
 
bool use_empty () const
 
bool materialized_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 use of this value.
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N uses.
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N uses or more.
 
bool hasOneUser () const
 Return true if there is exactly one user of this value.
 
UsegetSingleUndroppableUse ()
 Return true if there is exactly one use of this value that cannot be dropped.
 
const UsegetSingleUndroppableUse () const
 
UsergetUniqueUndroppableUser ()
 Return true if there is exactly one unique user of this value that cannot be dropped (that user can have multiple uses of this value).
 
const UsergetUniqueUndroppableUser () const
 
bool hasNUndroppableUses (unsigned N) const
 Return true if there this value.
 
bool hasNUndroppableUsesOrMore (unsigned N) const
 Return true if this value has N uses or more.
 
void dropDroppableUses (llvm::function_ref< bool(const Use *)> ShouldDrop=[](const Use *) { return true;})
 Remove every uses that can safely be removed.
 
void dropDroppableUsesIn (User &Usr)
 Remove every use of this value in User that can safely be removed.
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 Check if this value is used in the specified basic block.
 
unsigned getNumUses () const
 This method computes the number of uses of this Value.
 
void addUse (Use &U)
 This method should only be used by the Use class.
 
unsigned getValueID () const
 Return an ID for the concrete type of this object.
 
unsigned getRawSubclassOptionalData () const
 Return the raw optional flags value contained in this value.
 
void clearSubclassOptionalData ()
 Clear the optional flags contained in this value.
 
bool hasSameSubclassOptionalData (const Value *V) const
 Check the optional flags for equality.
 
bool hasValueHandle () const
 Return true if there is a value handle associated with this value.
 
bool isUsedByMetadata () const
 Return true if there is metadata referencing this value.
 
bool isSwiftError () const
 Return true if this value is a swifterror value.
 
const ValuestripPointerCasts () const
 Strip off pointer casts, all-zero GEPs and address space casts.
 
ValuestripPointerCasts ()
 
const ValuestripPointerCastsAndAliases () const
 Strip off pointer casts, all-zero GEPs, address space casts, and aliases.
 
ValuestripPointerCastsAndAliases ()
 
const ValuestripPointerCastsSameRepresentation () const
 Strip off pointer casts, all-zero GEPs and address space casts but ensures the representation of the result stays the same.
 
ValuestripPointerCastsSameRepresentation ()
 
const ValuestripPointerCastsForAliasAnalysis () const
 Strip off pointer casts, all-zero GEPs, single-argument phi nodes and invariant group info.
 
ValuestripPointerCastsForAliasAnalysis ()
 
const ValuestripInBoundsConstantOffsets () const
 Strip off pointer casts and all-constant inbounds GEPs.
 
ValuestripInBoundsConstantOffsets ()
 
const ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false, function_ref< bool(Value &Value, APInt &Offset)> ExternalAnalysis=nullptr) const
 Accumulate the constant offset this value has compared to a base pointer.
 
ValuestripAndAccumulateConstantOffsets (const DataLayout &DL, APInt &Offset, bool AllowNonInbounds, bool AllowInvariantGroup=false)
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 This is a wrapper around stripAndAccumulateConstantOffsets with the in-bounds requirement set to false.
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 
const ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {}) const
 Strip off pointer casts and inbounds GEPs.
 
ValuestripInBoundsOffsets (function_ref< void(const Value *)> Func=[](const Value *) {})
 
std::optional< int64_t > getPointerOffsetFrom (const Value *Other, const DataLayout &DL) const
 If this ptr is provably equal to Other plus a constant offset, return that offset in bytes.
 
bool canBeFreed () const
 Return true if the memory object referred to by V can by freed in the scope for which the SSA value defining the allocation is statically defined.
 
uint64_t getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull, bool &CanBeFreed) const
 Returns the number of bytes known to be dereferenceable for the pointer value.
 
Align getPointerAlignment (const DataLayout &DL) const
 Returns an alignment of the pointer value.
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 Translate PHI node to its predecessor from the given basic block.
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 
void mutateType (Type *Ty)
 Mutate the type of this Value to be of the specified type.
 
template<class Compare >
void sortUseList (Compare Cmp)
 Sort the use-list.
 
void reverseUseList ()
 Reverse the use-list.
 
void print (raw_ostream &O, bool IsForDebug=false) const
 Implement operator<< on Value.
 
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.
 
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, bool canThrow=false)
 InlineAsm::get - Return the specified uniqued inline asm string.
 
static Error verify (FunctionType *Ty, StringRef Constraints)
 This static method can be used by the parser to check to see if the specified constraint string is legal for the type.
 
static ConstraintInfoVector ParseConstraints (StringRef ConstraintString)
 ParseConstraints - Split up the constraint string into the specific constraints and their prefixes.
 
static bool classof (const Value *V)
 
static std::vector< StringRefgetExtraInfoNames (unsigned ExtraInfo)
 
static StringRef getMemConstraintName (ConstraintCode C)
 
- Static Public Member Functions inherited from llvm::Value
static void dropDroppableUse (Use &U)
 Remove the droppable use U.
 

Friends

struct InlineAsmKeyType
 
class ConstantUniqueMap< InlineAsm >
 

Additional Inherited Members

- Static Public Attributes inherited from llvm::Value
static constexpr unsigned MaxAlignmentExponent = 32
 The maximum alignment for instructions.
 
static constexpr uint64_t MaximumAlignment = 1ULL << MaxAlignmentExponent
 
- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 27 }
 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.
 
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const
 Appends all metadata attached to this value to MDs, sorting by KindID.
 
bool hasMetadata () const
 Return true if this value has any metadata attached to it.
 
bool eraseMetadata (unsigned KindID)
 Erase all metadata attachments with the given kind.
 
void eraseMetadataIf (function_ref< bool(unsigned, MDNode *)> Pred)
 Erase all metadata attachments matching the given predicate.
 
void clearMetadata ()
 Erase all metadata attached to this Value.
 
MDNodegetMetadataImpl (unsigned KindID) const
 Get metadata for the given kind, if any.
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
MDNodegetMetadata (unsigned KindID) const
 Get the current metadata attachments for the given kind, if any.
 
MDNodegetMetadata (StringRef Kind) const
 
void getMetadata (unsigned KindID, SmallVectorImpl< MDNode * > &MDs) const
 Appends all attachments with the given ID to MDs in insertion order.
 
void getMetadata (StringRef Kind, SmallVectorImpl< MDNode * > &MDs) const
 
bool hasMetadata (unsigned KindID) const
 Return true if this value has the given type of metadata attached.
 
bool hasMetadata (StringRef Kind) const
 
void setMetadata (unsigned KindID, MDNode *Node)
 Set a particular kind of metadata attachment.
 
void setMetadata (StringRef Kind, MDNode *Node)
 
void addMetadata (unsigned KindID, MDNode &MD)
 Add a metadata attachment.
 
void addMetadata (StringRef Kind, MDNode &MD)
 
- Protected Attributes inherited from llvm::Value
unsigned char SubclassOptionalData: 7
 Hold subclass data that can be dropped.
 
unsigned NumUserOperands: NumUserOperandsBits
 
unsigned IsUsedByMD: 1
 
unsigned HasName: 1
 
unsigned HasMetadata: 1
 
unsigned HasHungOffUses: 1
 
unsigned HasDescriptor: 1
 

Detailed Description

Definition at line 34 of file InlineAsm.h.

Member Typedef Documentation

◆ ConstraintCodeVector

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

Definition at line 102 of file InlineAsm.h.

◆ ConstraintInfoVector

Definition at line 121 of file InlineAsm.h.

◆ SubConstraintInfoVector

Definition at line 119 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 

Definition at line 200 of file InlineAsm.h.

◆ AsmDialect

Enumerator
AD_ATT 
AD_Intel 

Definition at line 36 of file InlineAsm.h.

◆ ConstraintCode

Enumerator
Unknown 
es 
Um 
Un 
Uq 
Us 
Ut 
Uv 
Uy 
ZB 
ZC 
Zy 
ZQ 
ZR 
ZS 
ZT 
Max 

Definition at line 239 of file InlineAsm.h.

◆ ConstraintPrefix

Enumerator
isInput 
isOutput 
isClobber 
isLabel 

Definition at line 95 of file InlineAsm.h.

◆ Kind

enum class llvm::InlineAsm::Kind : uint8_t
strong
Enumerator
RegUse 
RegDef 
RegDefEarlyClobber 
Clobber 
Imm 
Mem 
Func 

Definition at line 225 of file InlineAsm.h.

Constructor & Destructor Documentation

◆ InlineAsm()

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

Member Function Documentation

◆ canThrow()

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

Definition at line 74 of file InlineAsm.h.

Referenced by get().

◆ classof()

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

Definition at line 196 of file InlineAsm.h.

◆ collectAsmStrs()

void InlineAsm::collectAsmStrs ( SmallVectorImpl< StringRef > &  AsmStrs) const

◆ get()

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

◆ getAsmString()

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

Definition at line 86 of file InlineAsm.h.

◆ getConstraintString()

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

Definition at line 87 of file InlineAsm.h.

◆ getDialect()

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

Definition at line 73 of file InlineAsm.h.

◆ getExtraInfoNames()

static std::vector< StringRef > llvm::InlineAsm::getExtraInfoNames ( unsigned  ExtraInfo)
inlinestatic

◆ getFunctionType()

FunctionType * InlineAsm::getFunctionType ( ) const

getFunctionType - InlineAsm's are always pointers to functions.

Definition at line 58 of file InlineAsm.cpp.

◆ getMemConstraintName()

static StringRef llvm::InlineAsm::getMemConstraintName ( ConstraintCode  C)
inlinestatic

◆ getType()

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

getType - InlineAsm's are always pointers.

Definition at line 78 of file InlineAsm.h.

References llvm::Value::getType().

◆ hasSideEffects()

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

Definition at line 71 of file InlineAsm.h.

Referenced by get().

◆ isAlignStack()

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

Definition at line 72 of file InlineAsm.h.

Referenced by get().

◆ operator=()

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

◆ ParseConstraints() [1/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 191 of file InlineAsm.h.

References ParseConstraints().

Referenced by ParseConstraints(), and verify().

◆ ParseConstraints() [2/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 235 of file InlineAsm.cpp.

References llvm::StringRef::begin(), llvm::StringRef::end(), I, and Info.

◆ verify()

Error InlineAsm::verify ( FunctionType Ty,
StringRef  Constraints 
)
static

Friends And Related Function Documentation

◆ ConstantUniqueMap< InlineAsm >

friend class ConstantUniqueMap< InlineAsm >
friend

Definition at line 42 of file InlineAsm.h.

◆ InlineAsmKeyType

friend struct InlineAsmKeyType
friend

Definition at line 42 of file InlineAsm.h.


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