[IR2Vec][NFC] Add helper methods for numeric ID mapping in Vocabulary #149212
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jul 16, 2025
This was referenced Jul 16, 2025
svkeerthy
changed the title
svkeerthy
changed the title
llvmbot
added
mlgo
llvm:analysis
|
@llvm/pr-subscribers-llvm-analysis @llvm/pr-subscribers-mlgo Author: S. VenkataKeerthy (svkeerthy) ChangesAdd helper methods to IR2Vec's Vocabulary class for numeric ID mapping and vocabulary size calculation. These APIs will be useful in triplet generation for (Tracking issue - #141817) Full diff: https://github.com/llvm/llvm-project/pull/149212.diff 3 Files Affected:
diff --git a/llvm/include/llvm/Analysis/IR2Vec.h b/llvm/include/llvm/Analysis/IR2Vec.h
index 3d7edf08c8807..d87457cac7642 100644
--- a/llvm/include/llvm/Analysis/IR2Vec.h
+++ b/llvm/include/llvm/Analysis/IR2Vec.h
@@ -170,6 +170,10 @@ class Vocabulary {
unsigned getDimension() const;
size_t size() const;
+ static size_t expectedSize() {
+ return MaxOpcodes + MaxTypeIDs + MaxOperandKinds;
+ }
+
/// Helper function to get vocabulary key for a given Opcode
static StringRef getVocabKeyForOpcode(unsigned Opcode);
@@ -182,6 +186,11 @@ class Vocabulary {
/// Helper function to classify an operand into OperandKind
static OperandKind getOperandKind(const Value *Op);
+ /// Helpers to return the IDs of a given Opcode, TypeID, or OperandKind
+ static unsigned getNumericID(unsigned Opcode);
+ static unsigned getNumericID(Type::TypeID TypeID);
+ static unsigned getNumericID(const Value *Op);
+
/// Accessors to get the embedding for a given entity.
const ir2vec::Embedding &operator[](unsigned Opcode) const;
const ir2vec::Embedding &operator[](Type::TypeID TypeId) const;
diff --git a/llvm/lib/Analysis/IR2Vec.cpp b/llvm/lib/Analysis/IR2Vec.cpp
index 898bf5b202feb..95f30fd3f4275 100644
--- a/llvm/lib/Analysis/IR2Vec.cpp
+++ b/llvm/lib/Analysis/IR2Vec.cpp
@@ -215,7 +215,7 @@ Vocabulary::Vocabulary(VocabVector &&Vocab)
: Vocab(std::move(Vocab)), Valid(true) {}
bool Vocabulary::isValid() const {
- return Vocab.size() == (MaxOpcodes + MaxTypeIDs + MaxOperandKinds) && Valid;
+ return Vocab.size() == Vocabulary::expectedSize() && Valid;
}
size_t Vocabulary::size() const {
@@ -324,8 +324,24 @@ Vocabulary::OperandKind Vocabulary::getOperandKind(const Value *Op) {
return OperandKind::VariableID;
}
+unsigned Vocabulary::getNumericID(unsigned Opcode) {
+ assert(Opcode >= 1 && Opcode <= MaxOpcodes && "Invalid opcode");
+ return Opcode - 1; // Convert to zero-based index
+}
+
+unsigned Vocabulary::getNumericID(Type::TypeID TypeID) {
+ assert(static_cast<unsigned>(TypeID) < MaxTypeIDs && "Invalid type ID");
+ return MaxOpcodes + static_cast<unsigned>(TypeID);
+}
+
+unsigned Vocabulary::getNumericID(const Value *Op) {
+ unsigned Index = static_cast<unsigned>(getOperandKind(Op));
+ assert(Index < MaxOperandKinds && "Invalid OperandKind");
+ return MaxOpcodes + MaxTypeIDs + Index;
+}
+
StringRef Vocabulary::getStringKey(unsigned Pos) {
- assert(Pos < MaxOpcodes + MaxTypeIDs + MaxOperandKinds &&
+ assert(Pos < Vocabulary::expectedSize() &&
"Position out of bounds in vocabulary");
// Opcode
if (Pos < MaxOpcodes)
diff --git a/llvm/unittests/Analysis/IR2VecTest.cpp b/llvm/unittests/Analysis/IR2VecTest.cpp
index cb6d633306a81..7c9a5464bfe1d 100644
--- a/llvm/unittests/Analysis/IR2VecTest.cpp
+++ b/llvm/unittests/Analysis/IR2VecTest.cpp
@@ -396,6 +396,69 @@ TEST(IR2VecVocabularyTest, DummyVocabTest) {
}
}
+TEST(IR2VecVocabularyTest, NumericIDMap) {
+ // Test getNumericID for opcodes
+ EXPECT_EQ(Vocabulary::getNumericID(1u), 0u);
+ EXPECT_EQ(Vocabulary::getNumericID(13u), 12u);
+ EXPECT_EQ(Vocabulary::getNumericID(MaxOpcodes), MaxOpcodes - 1);
+
+ // Test getNumericID for Type IDs
+ EXPECT_EQ(Vocabulary::getNumericID(Type::VoidTyID),
+ MaxOpcodes + static_cast<unsigned>(Type::VoidTyID));
+ EXPECT_EQ(Vocabulary::getNumericID(Type::HalfTyID),
+ MaxOpcodes + static_cast<unsigned>(Type::HalfTyID));
+ EXPECT_EQ(Vocabulary::getNumericID(Type::FloatTyID),
+ MaxOpcodes + static_cast<unsigned>(Type::FloatTyID));
+ EXPECT_EQ(Vocabulary::getNumericID(Type::IntegerTyID),
+ MaxOpcodes + static_cast<unsigned>(Type::IntegerTyID));
+ EXPECT_EQ(Vocabulary::getNumericID(Type::PointerTyID),
+ MaxOpcodes + static_cast<unsigned>(Type::PointerTyID));
+
+ // Test getNumericID for Value operands
+ LLVMContext Ctx;
+ Module M("TestM", Ctx);
+ FunctionType *FTy =
+ FunctionType::get(Type::getVoidTy(Ctx), {Type::getInt32Ty(Ctx)}, false);
+ Function *F = Function::Create(FTy, Function::ExternalLinkage, "testFunc", M);
+
+ // Test Function operand
+ EXPECT_EQ(Vocabulary::getNumericID(F),
+ MaxOpcodes + MaxTypeIDs + 0u); // Function = 0
+
+ // Test Constant operand
+ Constant *C = ConstantInt::get(Type::getInt32Ty(Ctx), 42);
+ EXPECT_EQ(Vocabulary::getNumericID(C),
+ MaxOpcodes + MaxTypeIDs + 2u); // Constant = 2
+
+ // Test Pointer operand
+ BasicBlock *BB = BasicBlock::Create(Ctx, "entry", F);
+ AllocaInst *PtrVal = new AllocaInst(Type::getInt32Ty(Ctx), 0, "ptr", BB);
+ EXPECT_EQ(Vocabulary::getNumericID(PtrVal),
+ MaxOpcodes + MaxTypeIDs + 1u); // Pointer = 1
+
+ // Test Variable operand (function argument)
+ Argument *Arg = F->getArg(0);
+ EXPECT_EQ(Vocabulary::getNumericID(Arg),
+ MaxOpcodes + MaxTypeIDs + 3u); // Variable = 3
+}
+
+#if GTEST_HAS_DEATH_TEST
+#ifndef NDEBUG
+TEST(IR2VecVocabularyTest, NumericIDMapInvalidInputs) {
+ // Test invalid opcode IDs
+ EXPECT_DEATH(Vocabulary::getNumericID(0u), "Invalid opcode");
+ EXPECT_DEATH(Vocabulary::getNumericID(MaxOpcodes + 1), "Invalid opcode");
+
+ // Test invalid type IDs
+ EXPECT_DEATH(Vocabulary::getNumericID(static_cast<Type::TypeID>(MaxTypeIDs)),
+ "Invalid type ID");
+ EXPECT_DEATH(
+ Vocabulary::getNumericID(static_cast<Type::TypeID>(MaxTypeIDs + 10)),
+ "Invalid type ID");
+}
+#endif // NDEBUG
+#endif // GTEST_HAS_DEATH_TEST
+
TEST(IR2VecVocabularyTest, StringKeyGeneration) {
EXPECT_EQ(Vocabulary::getStringKey(0), "Ret");
EXPECT_EQ(Vocabulary::getStringKey(12), "Add");
|
svkeerthy
force-pushed
the
users/svkeerthy/07-14-_ir2vec_adding_documentation_for_llvm-ir2vec_tool
branch
from
6ae5021 to
3ad45e3
Compare
svkeerthy
force-pushed
the
users/svkeerthy/07-16-exposing-new-methods
branch
2 times, most recently
from
bc03736 to
68ae9f5
Compare
svkeerthy
force-pushed
the
users/svkeerthy/07-14-_ir2vec_adding_documentation_for_llvm-ir2vec_tool
branch
2 times, most recently
from
42671b8 to
a395af5
Compare
svkeerthy
force-pushed
the
users/svkeerthy/07-16-exposing-new-methods
branch
from
68ae9f5 to
1d7ca80
Compare
svkeerthy
force-pushed
the
users/svkeerthy/07-14-_ir2vec_adding_documentation_for_llvm-ir2vec_tool
branch
from
a395af5 to
586947a
Compare
Base automatically changed from
users/svkeerthy/07-14-_ir2vec_adding_documentation_for_llvm-ir2vec_tool
to
main
July 17, 2025 19:09
svkeerthy
force-pushed
the
users/svkeerthy/07-16-exposing-new-methods
branch
2 times, most recently
from
01c6091 to
f24c6f1
Compare
Merge activity
|
svkeerthy
force-pushed
the
users/svkeerthy/07-16-exposing-new-methods
branch
from
f24c6f1 to
faf9baa
Compare
|
@svkeerthy This didn't get reviewed at all? |
|
Right. Pushed it as it was a minor refactoring. Feel free to add any comments. Will fix it. |
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/162/builds/27073 Here is the relevant piece of the build log for the reference |
This was referenced Jul 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add helper methods to IR2Vec's Vocabulary class for numeric ID mapping and vocabulary size calculation. These APIs will be useful in triplet generation for
llvm-ir2vectool (See #149214).(Tracking issue - #141817)