LLVM: llvm::AAMDNodes Struct Reference

LLVM 14.0.0git

A collection of metadata nodes that might be associated with a memory access used by the alias-analysis infrastructure. More...

#include "llvm/IR/Metadata.h"

Collaboration diagram for llvm::AAMDNodes:

Collaboration graph

[legend]

Public Member Functions
	AAMDNodes ()=default

	AAMDNodes (MDNode T, MDNode TS, MDNode S, MDNode N)

bool	operator== (const AAMDNodes &A) const

bool	operator!= (const AAMDNodes &A) const

	operator bool () const

AAMDNodes	intersect (const AAMDNodes &Other) const
	Given two sets of AAMDNodes that apply to the same pointer, give the best AAMDNodes that are compatible with both (i.e. More...

AAMDNodes	shift (size_t Offset) const
	Create a new AAMDNode that describes this AAMDNode after applying a constant offset to the start of the pointer. More...

AAMDNodes	merge (const AAMDNodes &Other) const
	Given two sets of AAMDNodes applying to potentially different locations, determine the best AAMDNodes that apply to both. More...

AAMDNodes	concat (const AAMDNodes &Other) const
	Determine the best AAMDNodes after concatenating two different locations together. More...

Static Public Member Functions
static MDNode *	shiftTBAA (MDNode *M, size_t off)

static MDNode *	shiftTBAAStruct (MDNode *M, size_t off)

Public Attributes
MDNode *	TBAA = nullptr
	The tag for type-based alias analysis. More...

MDNode *	TBAAStruct = nullptr
	The tag for type-based alias analysis (tbaa struct). More...

MDNode *	Scope = nullptr
	The tag for alias scope specification (used with noalias). More...

MDNode *	NoAlias = nullptr
	The tag specifying the noalias scope. More...

Detailed Description

A collection of metadata nodes that might be associated with a memory access used by the alias-analysis infrastructure.

Definition at line 651 of file Metadata.h.

Constructor & Destructor Documentation

◆ AAMDNodes() [1/2]

llvm::AAMDNodes::AAMDNodes ( )

explicitdefault

◆ AAMDNodes() [2/2]

llvm::AAMDNodes::AAMDNodes	(	MDNode *	T,
		MDNode *	TS,
		MDNode *	S,
		MDNode *	N
	)

inlineexplicit

Definition at line 653 of file Metadata.h.

References T.

Member Function Documentation

◆ concat()

AAMDNodes AAMDNodes::concat ( const AAMDNodes & Other ) const

Determine the best AAMDNodes after concatenating two different locations together.

Different from merge, where different locations should overlap each other, concat puts non-overlapping locations together.

Definition at line 533 of file TypeBasedAliasAnalysis.cpp.

References llvm::MDNode::getMostGenericAliasScope(), llvm::MDNode::intersect(), NoAlias, Other, and Scope.

◆ intersect()

AAMDNodes llvm::AAMDNodes::intersect ( const AAMDNodes & Other ) const

inline

Given two sets of AAMDNodes that apply to the same pointer, give the best AAMDNodes that are compatible with both (i.e.

a set of nodes whose allowable aliasing conclusions are a subset of those allowable by both of the inputs). However, for efficiency reasons, do not create any new MDNodes.

Definition at line 690 of file Metadata.h.

References NoAlias, Other, Scope, TBAA, and TBAAStruct.

◆ merge()

AAMDNodes AAMDNodes::merge ( const AAMDNodes & Other ) const

Given two sets of AAMDNodes applying to potentially different locations, determine the best AAMDNodes that apply to both.

Definition at line 524 of file TypeBasedAliasAnalysis.cpp.

References llvm::MDNode::getMostGenericAliasScope(), llvm::MDNode::getMostGenericTBAA(), llvm::MDNode::intersect(), NoAlias, Other, Scope, and TBAA.

Referenced by mergeConditionalStoreToAddress(), llvm::InstCombinerImpl::mergeStoreIntoSuccessor(), and llvm::promoteLoopAccessesToScalars().

◆ operator bool()

llvm::AAMDNodes::operator bool ( ) const

inlineexplicit

Definition at line 663 of file Metadata.h.

References NoAlias, Scope, TBAA, and TBAAStruct.

◆ operator!=()

bool llvm::AAMDNodes::operator!= ( const AAMDNodes & A ) const

inline

Definition at line 661 of file Metadata.h.

◆ operator==()

bool llvm::AAMDNodes::operator== ( const AAMDNodes & A ) const

inline

Definition at line 656 of file Metadata.h.

References NoAlias, Scope, TBAA, and TBAAStruct.

◆ shift()

AAMDNodes llvm::AAMDNodes::shift ( size_t Offset ) const

inline

Create a new AAMDNode that describes this AAMDNode after applying a constant offset to the start of the pointer.

Definition at line 701 of file Metadata.h.

References NoAlias, Offset, Scope, shiftTBAA(), shiftTBAAStruct(), TBAA, and TBAAStruct.

◆ shiftTBAA()

MDNode * AAMDNodes::shiftTBAA	(	MDNode *	M,
		size_t	off
	)

static

Definition at line 741 of file TypeBasedAliasAnalysis.cpp.

References isStructPathTBAA(), and Offset.

Referenced by shift().

◆ shiftTBAAStruct()

MDNode * AAMDNodes::shiftTBAAStruct	(	MDNode *	M,
		size_t	off
	)

static

Definition at line 760 of file TypeBasedAliasAnalysis.cpp.

References llvm::ConstantInt::get(), llvm::ConstantAsMetadata::get(), llvm::MDNode::get(), llvm::MDNode::getContext(), llvm::MDNode::getNumOperands(), llvm::MDNode::getOperand(), llvm::ConstantInt::getType(), llvm::ConstantInt::getZExtValue(), i, Offset, and llvm::size().

Referenced by shift().

Member Data Documentation

◆ NoAlias

MDNode* llvm::AAMDNodes::NoAlias = nullptr

The tag specifying the noalias scope.

Definition at line 677 of file Metadata.h.

Referenced by llvm::ScopedNoAliasAAResult::alias(), concat(), llvm::DenseMapInfo< AAMDNodes >::getHashValue(), llvm::ScopedNoAliasAAResult::getModRefInfo(), intersect(), merge(), operator bool(), operator==(), llvm::MachineMemOperand::print(), and shift().

◆ Scope

MDNode* llvm::AAMDNodes::Scope = nullptr

The tag for alias scope specification (used with noalias).

Definition at line 674 of file Metadata.h.

Referenced by llvm::ScopedNoAliasAAResult::alias(), concat(), llvm::DenseMapInfo< AAMDNodes >::getHashValue(), llvm::ScopedNoAliasAAResult::getModRefInfo(), intersect(), merge(), operator bool(), operator==(), llvm::MachineMemOperand::print(), and shift().

◆ TBAA

MDNode* llvm::AAMDNodes::TBAA = nullptr

The tag for type-based alias analysis.

Definition at line 668 of file Metadata.h.

Referenced by llvm::TypeBasedAAResult::alias(), llvm::DenseMapInfo< AAMDNodes >::getHashValue(), getMemcpyLoadsAndStores(), getMemmoveLoadsAndStores(), getMemsetStores(), llvm::TypeBasedAAResult::getModRefInfo(), intersect(), merge(), operator bool(), operator==(), llvm::TypeBasedAAResult::pointsToConstantMemory(), llvm::MachineMemOperand::print(), and shift().

◆ TBAAStruct

MDNode* llvm::AAMDNodes::TBAAStruct = nullptr

The tag for type-based alias analysis (tbaa struct).

Definition at line 671 of file Metadata.h.

Referenced by llvm::DenseMapInfo< AAMDNodes >::getHashValue(), getMemcpyLoadsAndStores(), getMemmoveLoadsAndStores(), getMemsetStores(), intersect(), operator bool(), operator==(), and shift().

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

include/llvm/IR/Metadata.h
lib/Analysis/TypeBasedAliasAnalysis.cpp