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

#include "llvm/CodeGen/MIR2Vec.h"

Public Types
using	const_iterator = ir2vec::VocabStorage::const_iterator

Public Member Functions
unsigned	getCanonicalIndexForBaseName (StringRef BaseName) const
	Get indices from opcode or operand names.
unsigned	getCanonicalIndexForOperandName (StringRef OperandName) const
unsigned	getCanonicalIndexForRegisterClass (StringRef RegName, bool IsPhysical=true) const
std::string	getStringKey (unsigned Pos) const
	Get the string key for a vocabulary entry at the given position.
unsigned	getDimension () const
unsigned	getEntityIDForOpcode (unsigned Opcode) const
	Get entity ID (flat index) for an opcode This is used for triplet generation.
unsigned	getEntityIDForMachineOperand (const MachineOperand &MO) const
	Get entity ID (flat index) for a machine operand This is used for triplet generation.
const Embedding &	operator[] (unsigned Opcode) const
const Embedding &	operator[] (MachineOperand Operand) const
const_iterator	begin () const
const_iterator	end () const
	MIRVocabulary ()=delete
size_t	getCanonicalSize () const
	Total number of entries in the vocabulary.

Static Public Member Functions
static std::string	extractBaseOpcodeName (StringRef InstrName)
	Static method for extracting base opcode names (public for testing)
static Expected< MIRVocabulary >	create (VocabMap &&OpcMap, VocabMap &&CommonOperandsMap, VocabMap &&PhyRegMap, VocabMap &&VirtRegMap, const TargetInstrInfo &TII, const TargetRegisterInfo &TRI, const MachineRegisterInfo &MRI)
	Factory method to create MIRVocabulary from vocabulary map.
static Expected< MIRVocabulary >	createDummyVocabForTest (const TargetInstrInfo &TII, const TargetRegisterInfo &TRI, const MachineRegisterInfo &MRI, unsigned Dim=1)
	Create a dummy vocabulary for testing purposes.

Friends
class	llvm::MIR2VecVocabLegacyAnalysis

Detailed Description

Class for storing and accessing the MIR2Vec vocabulary.

The MIRVocabulary class manages seed embeddings for LLVM Machine IR

Definition at line 86 of file MIR2Vec.h.

Member Typedef Documentation

◆ const_iterator

using llvm::mir2vec::MIRVocabulary::const_iterator = ir2vec::VocabStorage::const_iterator

Definition at line 257 of file MIR2Vec.h.

Constructor & Destructor Documentation

◆ MIRVocabulary()

llvm::mir2vec::MIRVocabulary::MIRVocabulary ( )

delete

Referenced by create().

Member Function Documentation

◆ begin()

const_iterator llvm::mir2vec::MIRVocabulary::begin ( ) const

inline

Definition at line 258 of file MIR2Vec.h.

◆ create()

Expected< MIRVocabulary > MIRVocabulary::create	(	VocabMap &&	OpcMap,
		VocabMap &&	CommonOperandsMap,
		VocabMap &&	PhyRegMap,
		VocabMap &&	VirtRegMap,
		const TargetInstrInfo &	TII,
		const TargetRegisterInfo &	TRI,
		const MachineRegisterInfo &	MRI )

static

Factory method to create MIRVocabulary from vocabulary map.

Definition at line 93 of file MIR2Vec.cpp.

References llvm::createStringError(), llvm::ir2vec::VocabStorage::getDimension(), llvm::invalid_argument, llvm::ir2vec::VocabStorage::isValid(), and MIRVocabulary().

Referenced by createDummyVocabForTest(), and llvm::MIR2VecVocabProvider::getVocabulary().

◆ createDummyVocabForTest()

Expected< MIRVocabulary > MIRVocabulary::createDummyVocabForTest	(	const TargetInstrInfo &	TII,
		const TargetRegisterInfo &	TRI,
		const MachineRegisterInfo &	MRI,
		unsigned	Dim = 1 )

static

Create a dummy vocabulary for testing purposes.

Definition at line 377 of file MIR2Vec.cpp.

References assert(), create(), and extractBaseOpcodeName().

◆ end()

const_iterator llvm::mir2vec::MIRVocabulary::end ( ) const

inline

Definition at line 260 of file MIR2Vec.h.

◆ extractBaseOpcodeName()

std::string MIRVocabulary::extractBaseOpcodeName ( StringRef InstrName )

static

Static method for extracting base opcode names (public for testing)

Definition at line 114 of file MIR2Vec.cpp.

References assert(), llvm::StringRef::back(), llvm::StringRef::drop_back(), llvm::StringRef::empty(), llvm::Regex::match(), llvm::SmallVectorTemplateCommon< T, typename >::size(), and llvm::StringRef::str().

Referenced by createDummyVocabForTest().

◆ getCanonicalIndexForBaseName()

unsigned MIRVocabulary::getCanonicalIndexForBaseName ( StringRef BaseName ) const

Get indices from opcode or operand names.

These are public for testing. String based lookups are inefficient and should be avoided in general.

Definition at line 144 of file MIR2Vec.cpp.

References assert(), and llvm::StringRef::str().

◆ getCanonicalIndexForOperandName()

unsigned MIRVocabulary::getCanonicalIndexForOperandName ( StringRef OperandName ) const

Definition at line 159 of file MIR2Vec.cpp.

References assert().

◆ getCanonicalIndexForRegisterClass()

unsigned MIRVocabulary::getCanonicalIndexForRegisterClass	(	StringRef	RegName,
		bool	IsPhysical = true ) const

Definition at line 169 of file MIR2Vec.cpp.

References assert(), and RegName.

◆ getCanonicalSize()

size_t llvm::mir2vec::MIRVocabulary::getCanonicalSize ( ) const

inline

Total number of entries in the vocabulary.

Definition at line 277 of file MIR2Vec.h.

◆ getDimension()

unsigned llvm::mir2vec::MIRVocabulary::getDimension ( ) const

inline

Definition at line 226 of file MIR2Vec.h.

◆ getEntityIDForMachineOperand()

unsigned llvm::mir2vec::MIRVocabulary::getEntityIDForMachineOperand ( const MachineOperand & MO ) const

inline

Get entity ID (flat index) for a machine operand This is used for triplet generation.

Definition at line 236 of file MIR2Vec.h.

References llvm::MachineOperand::getReg(), llvm::MachineOperand::getType(), and llvm::MachineOperand::MO_Register.

◆ getEntityIDForOpcode()

unsigned llvm::mir2vec::MIRVocabulary::getEntityIDForOpcode ( unsigned Opcode ) const

inline

Get entity ID (flat index) for an opcode This is used for triplet generation.

Definition at line 230 of file MIR2Vec.h.

◆ getStringKey()

std::string MIRVocabulary::getStringKey ( unsigned Pos ) const

Get the string key for a vocabulary entry at the given position.

Definition at line 179 of file MIR2Vec.cpp.

References assert().

◆ operator[]() [1/2]

const Embedding & llvm::mir2vec::MIRVocabulary::operator[] ( MachineOperand Operand ) const

inline

Definition at line 248 of file MIR2Vec.h.

References llvm::MachineOperand::getReg(), llvm::MachineOperand::getType(), and llvm::MachineOperand::MO_Register.

◆ operator[]() [2/2]

const Embedding & llvm::mir2vec::MIRVocabulary::operator[] ( unsigned Opcode ) const

inline

Definition at line 243 of file MIR2Vec.h.

◆ llvm::MIR2VecVocabLegacyAnalysis

friend class llvm::MIR2VecVocabLegacyAnalysis

friend

Definition at line 87 of file MIR2Vec.h.

Member Data Documentation

◆ CommonOperandBase

size_t llvm::mir2vec::MIRVocabulary::CommonOperandBase = 0

Definition at line 108 of file MIR2Vec.h.

◆ OpcodeBase

size_t llvm::mir2vec::MIRVocabulary::OpcodeBase = 0

Definition at line 107 of file MIR2Vec.h.

◆ PhyRegBase

size_t llvm::mir2vec::MIRVocabulary::PhyRegBase = 0

Definition at line 109 of file MIR2Vec.h.

◆ TotalEntries

size_t llvm::mir2vec::MIRVocabulary::TotalEntries = 0

Definition at line 111 of file MIR2Vec.h.

◆ VirtRegBase

size_t llvm::mir2vec::MIRVocabulary::VirtRegBase = 0

Definition at line 110 of file MIR2Vec.h.

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

include/llvm/CodeGen/MIR2Vec.h
lib/CodeGen/MIR2Vec.cpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ const_iterator

Constructor & Destructor Documentation

◆ MIRVocabulary()

Member Function Documentation

◆ begin()

◆ create()

◆ createDummyVocabForTest()

◆ end()

◆ extractBaseOpcodeName()

◆ getCanonicalIndexForBaseName()

◆ getCanonicalIndexForOperandName()

◆ getCanonicalIndexForRegisterClass()

◆ getCanonicalSize()

◆ getDimension()

◆ getEntityIDForMachineOperand()

◆ getEntityIDForOpcode()

◆ getStringKey()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

Friends And Related Symbol Documentation

◆ llvm::MIR2VecVocabLegacyAnalysis

Member Data Documentation

◆ CommonOperandBase

◆ OpcodeBase

◆ PhyRegBase

◆ TotalEntries

◆ VirtRegBase