Skip to content

[NFC][llvm-ir2vec] Standardize error message format using WithColor #164032

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: users/svkeerthy/10-17-_llvm-ir2vec_mir2vec_support
Choose a base branch
from
+36 −27
Open

[NFC][llvm-ir2vec] Standardize error message format using WithColor #164032

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion llvm/test/tools/llvm-ir2vec/embeddings-flowaware.ll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ entry:
; CHECK-FUNC-LEVEL-ABC: Function: abc
; CHECK-FUNC-LEVEL-NEXT-ABC: [ 3630.00 3672.00 3714.00 ]

; CHECK-FUNC-DEF: Error: Function 'def' not found
; CHECK-FUNC-DEF: error: Function 'def' not found

; CHECK-BB-LEVEL: Function: abc
; CHECK-BB-LEVEL-NEXT: entry: [ 3630.00 3672.00 3714.00 ]
Expand Down
2 changes: 1 addition & 1 deletion llvm/test/tools/llvm-ir2vec/embeddings-symbolic.ll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ entry:
; CHECK-FUNC-LEVEL-ABC: Function: abc
; CHECK-FUNC-LEVEL-NEXT-ABC: [ 878.00 889.00 900.00 ]

; CHECK-FUNC-DEF: Error: Function 'def' not found
; CHECK-FUNC-DEF: error: Function 'def' not found

; CHECK-BB-LEVEL: Function: abc
; CHECK-BB-LEVEL-NEXT: entry: [ 878.00 889.00 900.00 ]
Expand Down
2 changes: 1 addition & 1 deletion llvm/test/tools/llvm-ir2vec/embeddings-symbolic.mir
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ body: |
# CHECK-FUNC-LEVEL-ADD-NEXT: Function vector: [ 26.50 27.10 27.70 ]
# CHECK-FUNC-LEVEL-ADD-NOT: simple_function

# CHECK-FUNC-MISSING: Error: Function 'missing_function' not found
# CHECK-FUNC-MISSING: error: Function 'missing_function' not found

# CHECK-BB-LEVEL: MIR2Vec embeddings for machine function add_function:
# CHECK-BB-LEVEL-NEXT: Basic block vectors:
Expand Down
2 changes: 1 addition & 1 deletion llvm/test/tools/llvm-ir2vec/error-handling.ll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ entry:
}

; CHECK-NO-VOCAB: error: IR2Vec vocabulary file path not specified; You may need to set it using --ir2vec-vocab-path
; CHECK-FUNC-NOT-FOUND: Error: Function 'nonexistent' not found
; CHECK-FUNC-NOT-FOUND: error: Function 'nonexistent' not found
8 changes: 4 additions & 4 deletions llvm/test/tools/llvm-ir2vec/error-handling.mir
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ body: |
$eax = COPY %0
RET 0, $eax

# CHECK-NO-VOCAB: Error: Failed to load MIR2Vec vocabulary - MIR2Vec vocabulary file path not specified; set it using --mir2vec-vocab-path
# CHECK-NO-VOCAB: error: Failed to load MIR2Vec vocabulary - MIR2Vec vocabulary file path not specified; set it using --mir2vec-vocab-path

# CHECK-VOCAB-NOT-FOUND: Error: Failed to load MIR2Vec vocabulary
# CHECK-VOCAB-NOT-FOUND: error: Failed to load MIR2Vec vocabulary
# CHECK-VOCAB-NOT-FOUND: No such file or directory

# CHECK-INVALID-VOCAB: Error: Failed to load MIR2Vec vocabulary - Missing 'Opcodes' section in vocabulary file
# CHECK-INVALID-VOCAB: error: Failed to load MIR2Vec vocabulary - Missing 'Opcodes' section in vocabulary file

# CHECK-FUNC-NOT-FOUND: Error: Function 'nonexistent_function' not found
# CHECK-FUNC-NOT-FOUND: error: Function 'nonexistent_function' not found
47 changes: 28 additions & 19 deletions llvm/tools/llvm-ir2vec/llvm-ir2vec.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@

namespace llvm {

static const char *ToolName = "llvm-ir2vec";

// Common option category for options shared between IR2Vec and MIR2Vec
static cl::OptionCategory CommonCategory("Common Options",
"Options applicable to both IR2Vec "
Expand Down Expand Up @@ -258,7 +260,8 @@ class IR2VecTool {
/// Generate embeddings for the entire module
void generateEmbeddings(raw_ostream &OS) const {
if (!Vocab->isValid()) {
OS << "Error: Vocabulary is not valid. IR2VecTool not initialized.\n";
WithColor::error(errs(), ToolName)
<< "Vocabulary is not valid. IR2VecTool not initialized.\n";
return;
}

Expand All @@ -277,8 +280,8 @@ class IR2VecTool {
assert(Vocab->isValid() && "Vocabulary is not valid");
auto Emb = Embedder::create(IR2VecEmbeddingKind, F, *Vocab);
if (!Emb) {
OS << "Error: Failed to create embedder for function " << F.getName()
<< "\n";
WithColor::error(errs(), ToolName)
<< "Failed to create embedder for function " << F.getName() << "\n";
return;
}

Expand Down Expand Up @@ -351,13 +354,14 @@ class MIR2VecTool {
public:
explicit MIR2VecTool(MachineModuleInfo &MMI) : MMI(MMI) {}

/// Initialize the MIR2Vec vocabulary
/// Initialize MIR2Vec vocabulary
bool initializeVocabulary(const Module &M) {
MIR2VecVocabProvider Provider(MMI);
auto VocabOrErr = Provider.getVocabulary(M);
if (!VocabOrErr) {
errs() << "Error: Failed to load MIR2Vec vocabulary - "
<< toString(VocabOrErr.takeError()) << "\n";
WithColor::error(errs(), ToolName)
<< "Failed to load MIR2Vec vocabulary - "
<< toString(VocabOrErr.takeError()) << "\n";
return false;
}
Vocab = std::make_unique<MIRVocabulary>(std::move(*VocabOrErr));
Expand All @@ -367,7 +371,7 @@ class MIR2VecTool {
/// Generate embeddings for all machine functions in the module
void generateEmbeddings(const Module &M, raw_ostream &OS) const {
if (!Vocab) {
OS << "Error: Vocabulary not initialized.\n";
WithColor::error(errs(), ToolName) << "Vocabulary not initialized.\n";
return;
}

Expand All @@ -377,7 +381,8 @@ class MIR2VecTool {

MachineFunction *MF = MMI.getMachineFunction(F);
if (!MF) {
errs() << "Warning: No MachineFunction for " << F.getName() << "\n";
WithColor::warning(errs(), ToolName)
<< "No MachineFunction for " << F.getName() << "\n";
continue;
}

Expand All @@ -388,13 +393,14 @@ class MIR2VecTool {
/// Generate embeddings for a specific machine function
void generateEmbeddings(MachineFunction &MF, raw_ostream &OS) const {
if (!Vocab) {
OS << "Error: Vocabulary not initialized.\n";
WithColor::error(errs(), ToolName) << "Vocabulary not initialized.\n";
return;
}

auto Emb = MIREmbedder::create(MIR2VecKind::Symbolic, MF, *Vocab);
if (!Emb) {
errs() << "Error: Failed to create embedder for " << MF.getName() << "\n";
WithColor::error(errs(), ToolName)
<< "Failed to create embedder for " << MF.getName() << "\n";
return;
}

Expand Down Expand Up @@ -456,7 +462,8 @@ int main(int argc, char **argv) {
std::error_code EC;
raw_fd_ostream OS(OutputFilename, EC);
if (EC) {
errs() << "Error opening output file: " << EC.message() << "\n";
WithColor::error(errs(), ToolName)
<< "opening output file: " << EC.message() << "\n";
return 1;
}

Expand All @@ -472,13 +479,13 @@ int main(int argc, char **argv) {
LLVMContext Context;
std::unique_ptr<Module> M = parseIRFile(InputFilename, Err, Context);
if (!M) {
Err.print(argv[0], errs());
Err.print(ToolName, errs());
return 1;
}

if (Error Err = processModule(*M, OS)) {
handleAllErrors(std::move(Err), [&](const ErrorInfoBase &EIB) {
errs() << "Error: " << EIB.message() << "\n";
WithColor::error(errs(), ToolName) << EIB.message() << "\n";
});
return 1;
}
Expand All @@ -499,7 +506,7 @@ int main(int argc, char **argv) {

auto MIR = createMIRParserFromFile(InputFilename, Err, Context);
if (!MIR) {
Err.print(argv[0], WithColor::error(errs(), argv[0]));
Err.print(ToolName, errs());
return 1;
}

Expand All @@ -511,7 +518,7 @@ int main(int argc, char **argv) {
TheTriple.setTriple(sys::getDefaultTargetTriple());
auto TMOrErr = codegen::createTargetMachineForTriple(TheTriple.str());
if (!TMOrErr) {
Err.print(argv[0], WithColor::error(errs(), argv[0]));
Err.print(ToolName, errs());
exit(1);
}
TM = std::move(*TMOrErr);
Expand All @@ -520,14 +527,14 @@ int main(int argc, char **argv) {

std::unique_ptr<Module> M = MIR->parseIRModule(SetDataLayout);
if (!M) {
Err.print(argv[0], WithColor::error(errs(), argv[0]));
Err.print(ToolName, errs());
return 1;
}

// Parse machine functions
auto MMI = std::make_unique<MachineModuleInfo>(TM.get());
if (!MMI || MIR->parseMachineFunctions(*M, *MMI)) {
Err.print(argv[0], WithColor::error(errs(), argv[0]));
Err.print(ToolName, errs());
return 1;
}

Expand All @@ -547,13 +554,15 @@ int main(int argc, char **argv) {
// Process single function
Function *F = M->getFunction(FunctionName);
if (!F) {
errs() << "Error: Function '" << FunctionName << "' not found\n";
WithColor::error(errs(), ToolName)
<< "Function '" << FunctionName << "' not found\n";
return 1;
}

MachineFunction *MF = MMI->getMachineFunction(*F);
if (!MF) {
errs() << "Error: No MachineFunction for " << FunctionName << "\n";
WithColor::error(errs(), ToolName)
<< "No MachineFunction for " << FunctionName << "\n";
return 1;
}

Expand Down