Class for storing and accessing the IR2Vec vocabulary. More...

#include "llvm/Analysis/IR2Vec.h"

Public Types
enum class	CanonicalTypeID : unsigned { FloatTy , VoidTy , LabelTy , MetadataTy , VectorTy , TokenTy , IntegerTy , FunctionTy , PointerTy , StructTy , ArrayTy , UnknownTy , MaxCanonicalType }
	Canonical type IDs supported by IR2Vec Vocabulary. More...
enum class	OperandKind : unsigned { FunctionID , PointerID , ConstantID , VariableID , MaxOperandKind }
	Operand kinds supported by IR2Vec Vocabulary. More...
using	const_iterator = VocabVector::const_iterator
	Const Iterator type aliases.

Public Member Functions
	Vocabulary ()=default
LLVM_ABI	Vocabulary (VocabVector &&Vocab)
LLVM_ABI bool	isValid () const
LLVM_ABI unsigned	getDimension () const
LLVM_ABI const ir2vec::Embedding &	operator[] (unsigned Opcode) const
	Accessors to get the embedding for a given entity.
LLVM_ABI const ir2vec::Embedding &	operator[] (Type::TypeID TypeId) const
LLVM_ABI const ir2vec::Embedding &	operator[] (const Value &Arg) const
const_iterator	begin () const
const_iterator	cbegin () const
const_iterator	end () const
const_iterator	cend () const
LLVM_ABI bool	invalidate (Module &M, const PreservedAnalyses &PA, ModuleAnalysisManager::Invalidator &Inv) const

Static Public Member Functions
static constexpr size_t	getCanonicalSize ()
	Total number of entries (opcodes + canonicalized types + operand kinds)
static LLVM_ABI StringRef	getVocabKeyForOpcode (unsigned Opcode)
	Function to get vocabulary key for a given Opcode.
static LLVM_ABI StringRef	getVocabKeyForTypeID (Type::TypeID TypeID)
	Function to get vocabulary key for a given TypeID.
static LLVM_ABI StringRef	getVocabKeyForOperandKind (OperandKind Kind)
	Function to get vocabulary key for a given OperandKind.
static LLVM_ABI OperandKind	getOperandKind (const Value *Op)
	Function to classify an operand into OperandKind.
static LLVM_ABI unsigned	getSlotIndex (unsigned Opcode)
	Functions to return the slot index or position of a given Opcode, TypeID, or OperandKind in the vocabulary.
static LLVM_ABI unsigned	getSlotIndex (Type::TypeID TypeID)
static LLVM_ABI unsigned	getSlotIndex (const Value &Op)
static LLVM_ABI StringRef	getStringKey (unsigned Pos)
	Returns the string key for a given index position in the vocabulary.
static LLVM_ABI VocabVector	createDummyVocabForTest (unsigned Dim=1)
	Create a dummy vocabulary for testing purposes.

Static Public Attributes
static constexpr unsigned	MaxTypeIDs = Type::TypeID::TargetExtTyID + 1
static constexpr unsigned	MaxCanonicalTypeIDs
static constexpr unsigned	MaxOperandKinds

Friends
class	llvm::IR2VecVocabAnalysis

Detailed Description

Class for storing and accessing the IR2Vec vocabulary.

The Vocabulary class manages seed embeddings for LLVM IR entities. The seed embeddings are the initial learned representations of the entities of LLVM IR. The IR2Vec representation for a given IR is derived from these seed embeddings.

The vocabulary contains the seed embeddings for three types of entities: instruction opcodes, types, and operands. Types are grouped/canonicalized for better learning (e.g., all float variants map to FloatTy). The vocabulary abstracts away the canonicalization effectively, the exposed APIs handle all the known LLVM IR opcodes, types and operands.

This class helps populate the seed embeddings in an internal vector-based ADT. It provides logic to map every IR entity to a specific slot index or position in this vector, enabling O(1) embedding lookup while avoiding unnecessary computations involving string based lookups while generating the embeddings.

Definition at line 163 of file IR2Vec.h.

Member Typedef Documentation

◆ const_iterator

using llvm::ir2vec::Vocabulary::const_iterator = VocabVector::const_iterator

Const Iterator type aliases.

Definition at line 243 of file IR2Vec.h.

Member Enumeration Documentation

◆ CanonicalTypeID

enum class llvm::ir2vec::Vocabulary::CanonicalTypeID : unsigned

strong

Canonical type IDs supported by IR2Vec Vocabulary.

Enumerator
FloatTy
VoidTy
LabelTy
MetadataTy
VectorTy
TokenTy
IntegerTy
FunctionTy
PointerTy
StructTy
ArrayTy
UnknownTy
MaxCanonicalType

Definition at line 175 of file IR2Vec.h.

◆ OperandKind

enum class llvm::ir2vec::Vocabulary::OperandKind : unsigned

strong

Operand kinds supported by IR2Vec Vocabulary.

Enumerator
FunctionID
PointerID
ConstantID
VariableID
MaxOperandKind

Definition at line 192 of file IR2Vec.h.

Constructor & Destructor Documentation

◆ Vocabulary() [1/2]

llvm::ir2vec::Vocabulary::Vocabulary ( )

default

◆ Vocabulary() [2/2]

LLVM_ABI llvm::ir2vec::Vocabulary::Vocabulary ( VocabVector && Vocab )

inline

Definition at line 212 of file IR2Vec.h.

References LLVM_ABI, and llvm::move().

Member Function Documentation

◆ begin()

const_iterator llvm::ir2vec::Vocabulary::begin ( ) const

inline

Definition at line 244 of file IR2Vec.h.

References assert(), and isValid().

◆ cbegin()

const_iterator llvm::ir2vec::Vocabulary::cbegin ( ) const

inline

Definition at line 249 of file IR2Vec.h.

References assert(), and isValid().

◆ cend()

const_iterator llvm::ir2vec::Vocabulary::cend ( ) const

inline

Definition at line 259 of file IR2Vec.h.

References assert(), and isValid().

◆ createDummyVocabForTest()

Vocabulary::VocabVector Vocabulary::createDummyVocabForTest ( unsigned Dim = 1 )

static

Create a dummy vocabulary for testing purposes.

Definition at line 362 of file IR2Vec.cpp.

References _, MaxCanonicalTypeIDs, MaxOperandKinds, and llvm::seq().

◆ end()

const_iterator llvm::ir2vec::Vocabulary::end ( ) const

inline

Definition at line 254 of file IR2Vec.h.

References assert(), and isValid().

◆ getCanonicalSize()

constexpr size_t llvm::ir2vec::Vocabulary::getCanonicalSize ( )

inlinestaticconstexpr

Total number of entries (opcodes + canonicalized types + operand kinds)

Definition at line 217 of file IR2Vec.h.

◆ getDimension()

unsigned Vocabulary::getDimension ( ) const

Definition at line 263 of file IR2Vec.cpp.

References assert(), and isValid().

Referenced by llvm::FunctionPropertiesInfo::getFunctionPropertiesInfo().

◆ getOperandKind()

Vocabulary::OperandKind Vocabulary::getOperandKind ( const Value * Op )

static

Function to classify an operand into OperandKind.

Definition at line 331 of file IR2Vec.cpp.

References ConstantID, FunctionID, llvm::isa(), PointerID, and VariableID.

Referenced by getSlotIndex().

◆ getSlotIndex() [1/3]

unsigned Vocabulary::getSlotIndex ( const Value & Op )

static

Definition at line 278 of file IR2Vec.cpp.

References assert(), getOperandKind(), MaxCanonicalTypeIDs, and MaxOperandKinds.

◆ getSlotIndex() [2/3]

unsigned Vocabulary::getSlotIndex ( Type::TypeID TypeID )

static

Definition at line 273 of file IR2Vec.cpp.

References assert(), and MaxTypeIDs.

◆ getSlotIndex() [3/3]

unsigned Vocabulary::getSlotIndex ( unsigned Opcode )

static

Functions to return the slot index or position of a given Opcode, TypeID, or OperandKind in the vocabulary.

Definition at line 268 of file IR2Vec.cpp.

References assert().

Referenced by operator[](), operator[](), and operator[]().

◆ getStringKey()

StringRef Vocabulary::getStringKey ( unsigned Pos )

static

Returns the string key for a given index position in the vocabulary.

This is useful for debugging or printing the vocabulary. Do not use this for embedding generation as string based lookups are inefficient.

Definition at line 341 of file IR2Vec.cpp.

References assert(), getVocabKeyForOpcode(), getVocabKeyForOperandKind(), and MaxCanonicalTypeIDs.

◆ getVocabKeyForOpcode()

StringRef Vocabulary::getVocabKeyForOpcode ( unsigned Opcode )

static

Function to get vocabulary key for a given Opcode.

Definition at line 296 of file IR2Vec.cpp.

References assert().

Referenced by getStringKey().

◆ getVocabKeyForOperandKind()

StringRef Vocabulary::getVocabKeyForOperandKind ( Vocabulary::OperandKind Kind )

static

Function to get vocabulary key for a given OperandKind.

Definition at line 324 of file IR2Vec.cpp.

References assert(), and MaxOperandKinds.

Referenced by getStringKey().

◆ getVocabKeyForTypeID()

StringRef Vocabulary::getVocabKeyForTypeID ( Type::TypeID TypeID )

static

Function to get vocabulary key for a given TypeID.

Definition at line 320 of file IR2Vec.cpp.

◆ invalidate()

bool Vocabulary::invalidate	(	Module &	M,
		const PreservedAnalyses &	PA,
		ModuleAnalysisManager::Invalidator &	Inv ) const

Definition at line 356 of file IR2Vec.cpp.

References llvm::PreservedAnalyses::getChecker(), and llvm::IR2VecVocabAnalysis.

◆ isValid()

LLVM_ABI bool llvm::ir2vec::Vocabulary::isValid ( ) const

inline

Definition at line 214 of file IR2Vec.h.

References LLVM_ABI.

Referenced by begin(), cbegin(), cend(), end(), getDimension(), llvm::FunctionPropertiesInfo::getFunctionPropertiesInfo(), and llvm::IR2VecPrinterPass::run().

◆ operator[]() [1/3]

const ir2vec::Embedding & Vocabulary::operator[] ( const Value & Arg ) const

Definition at line 292 of file IR2Vec.cpp.

References getSlotIndex().

◆ operator[]() [2/3]

const Embedding & Vocabulary::operator[] ( Type::TypeID TypeId ) const

Definition at line 288 of file IR2Vec.cpp.

References getSlotIndex().

◆ operator[]() [3/3]

const Embedding & Vocabulary::operator[] ( unsigned Opcode ) const

Accessors to get the embedding for a given entity.

Definition at line 284 of file IR2Vec.cpp.

References getSlotIndex().

◆ llvm::IR2VecVocabAnalysis

friend class llvm::IR2VecVocabAnalysis

friend

Definition at line 164 of file IR2Vec.h.

Referenced by invalidate().

Member Data Documentation

◆ MaxCanonicalTypeIDs

unsigned llvm::ir2vec::Vocabulary::MaxCanonicalTypeIDs

staticconstexpr

Initial value:

=

static_cast<unsigned>(CanonicalTypeID::MaxCanonicalType)

llvm::ir2vec::Vocabulary::CanonicalTypeID::MaxCanonicalType

@ MaxCanonicalType

Definition IR2Vec.h:188

Definition at line 206 of file IR2Vec.h.

Referenced by createDummyVocabForTest(), getSlotIndex(), and getStringKey().

◆ MaxOperandKinds

unsigned llvm::ir2vec::Vocabulary::MaxOperandKinds

staticconstexpr

Initial value:

=

static_cast<unsigned>(OperandKind::MaxOperandKind)

llvm::ir2vec::Vocabulary::OperandKind::MaxOperandKind

@ MaxOperandKind

Definition IR2Vec.h:197

Definition at line 208 of file IR2Vec.h.

Referenced by createDummyVocabForTest(), getSlotIndex(), and getVocabKeyForOperandKind().

◆ MaxTypeIDs

unsigned llvm::ir2vec::Vocabulary::MaxTypeIDs = Type::TypeID::TargetExtTyID + 1

staticconstexpr

Definition at line 205 of file IR2Vec.h.

Referenced by getSlotIndex().

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

include/llvm/Analysis/IR2Vec.h
lib/Analysis/IR2Vec.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ const_iterator

Member Enumeration Documentation

◆ CanonicalTypeID

◆ OperandKind

Constructor & Destructor Documentation

◆ Vocabulary() [1/2]

◆ Vocabulary() [2/2]

Member Function Documentation

◆ begin()

◆ cbegin()

◆ cend()

◆ createDummyVocabForTest()

◆ end()

◆ getCanonicalSize()

◆ getDimension()

◆ getOperandKind()

◆ getSlotIndex() [1/3]

◆ getSlotIndex() [2/3]

◆ getSlotIndex() [3/3]

◆ getStringKey()

◆ getVocabKeyForOpcode()

◆ getVocabKeyForOperandKind()

◆ getVocabKeyForTypeID()

◆ invalidate()

◆ isValid()

◆ operator[]() [1/3]

◆ operator[]() [2/3]

◆ operator[]() [3/3]

Friends And Related Symbol Documentation

◆ llvm::IR2VecVocabAnalysis

Member Data Documentation

◆ MaxCanonicalTypeIDs

◆ MaxOperandKinds

◆ MaxTypeIDs