diff --git a/tools/llvm-exegesis/lib/BenchmarkResult.cpp b/tools/llvm-exegesis/lib/BenchmarkResult.cpp index aac93abcbe8..9fe7a846353 100644 --- a/tools/llvm-exegesis/lib/BenchmarkResult.cpp +++ b/tools/llvm-exegesis/lib/BenchmarkResult.cpp @@ -210,27 +210,32 @@ unsigned BenchmarkResultContext::getInstrOpcode(llvm::StringRef Name) const { } template -static ObjectOrList readYamlOrDieCommon(const BenchmarkResultContext &Context, - llvm::StringRef Filename) { - std::unique_ptr MemBuffer = llvm::cantFail( - llvm::errorOrToExpected(llvm::MemoryBuffer::getFile(Filename))); - llvm::yaml::Input Yin(*MemBuffer, getUntypedContext(Context)); - ObjectOrList Benchmark; - Yin >> Benchmark; - return Benchmark; +static llvm::Expected +readYamlCommon(const BenchmarkResultContext &Context, + llvm::StringRef Filename) { + if (auto ExpectedMemoryBuffer = + llvm::errorOrToExpected(llvm::MemoryBuffer::getFile(Filename))) { + std::unique_ptr MemoryBuffer = + std::move(ExpectedMemoryBuffer.get()); + llvm::yaml::Input Yin(*MemoryBuffer, getUntypedContext(Context)); + ObjectOrList Benchmark; + Yin >> Benchmark; + return Benchmark; + } else { + return ExpectedMemoryBuffer.takeError(); + } } -InstructionBenchmark -InstructionBenchmark::readYamlOrDie(const BenchmarkResultContext &Context, - llvm::StringRef Filename) { - return readYamlOrDieCommon(Context, Filename); +llvm::Expected +InstructionBenchmark::readYaml(const BenchmarkResultContext &Context, + llvm::StringRef Filename) { + return readYamlCommon(Context, Filename); } -std::vector -InstructionBenchmark::readYamlsOrDie(const BenchmarkResultContext &Context, - llvm::StringRef Filename) { - return readYamlOrDieCommon>(Context, - Filename); +llvm::Expected> +InstructionBenchmark::readYamls(const BenchmarkResultContext &Context, + llvm::StringRef Filename) { + return readYamlCommon>(Context, Filename); } void InstructionBenchmark::writeYamlTo(const BenchmarkResultContext &Context, @@ -245,18 +250,21 @@ void InstructionBenchmark::readYamlFrom(const BenchmarkResultContext &Context, Yin >> *this; } -// FIXME: Change the API to let the caller handle errors. -void InstructionBenchmark::writeYamlOrDie(const BenchmarkResultContext &Context, - const llvm::StringRef Filename) { +llvm::Error +InstructionBenchmark::writeYaml(const BenchmarkResultContext &Context, + const llvm::StringRef Filename) { if (Filename == "-") { writeYamlTo(Context, llvm::outs()); } else { int ResultFD = 0; - llvm::cantFail(llvm::errorCodeToError( - openFileForWrite(Filename, ResultFD, llvm::sys::fs::F_Text))); + if (auto E = llvm::errorCodeToError( + openFileForWrite(Filename, ResultFD, llvm::sys::fs::F_Text))) { + return E; + } llvm::raw_fd_ostream Ostr(ResultFD, true /*shouldClose*/); writeYamlTo(Context, Ostr); } + return llvm::Error::success(); } void BenchmarkMeasureStats::push(const BenchmarkMeasure &BM) { diff --git a/tools/llvm-exegesis/lib/BenchmarkResult.h b/tools/llvm-exegesis/lib/BenchmarkResult.h index 421e210274f..5fa9af8e9d3 100644 --- a/tools/llvm-exegesis/lib/BenchmarkResult.h +++ b/tools/llvm-exegesis/lib/BenchmarkResult.h @@ -58,13 +58,11 @@ struct InstructionBenchmark { std::string Info; // Read functions. - static InstructionBenchmark - readYamlOrDie(const BenchmarkResultContext &Context, - llvm::StringRef Filename); + static llvm::Expected + readYaml(const BenchmarkResultContext &Context, llvm::StringRef Filename); - static std::vector - readYamlsOrDie(const BenchmarkResultContext &Context, - llvm::StringRef Filename); + static llvm::Expected> + readYamls(const BenchmarkResultContext &Context, llvm::StringRef Filename); void readYamlFrom(const BenchmarkResultContext &Context, llvm::StringRef InputContent); @@ -72,8 +70,8 @@ struct InstructionBenchmark { // Write functions, non-const because of YAML traits. void writeYamlTo(const BenchmarkResultContext &Context, llvm::raw_ostream &S); - void writeYamlOrDie(const BenchmarkResultContext &Context, - const llvm::StringRef Filename); + llvm::Error writeYaml(const BenchmarkResultContext &Context, + const llvm::StringRef Filename); }; //------------------------------------------------------------------------------ diff --git a/tools/llvm-exegesis/llvm-exegesis.cpp b/tools/llvm-exegesis/llvm-exegesis.cpp index a1848c3f14f..e59843b4aca 100644 --- a/tools/llvm-exegesis/llvm-exegesis.cpp +++ b/tools/llvm-exegesis/llvm-exegesis.cpp @@ -45,7 +45,7 @@ static llvm::cl::opt llvm::cl::init("")); static llvm::cl::opt - BenchmarkFile("benchmarks-file", llvm::cl::desc(""), llvm::cl::init("-")); + BenchmarkFile("benchmarks-file", llvm::cl::desc(""), llvm::cl::init("")); enum class BenchmarkModeE { Latency, Uops, Analysis }; static llvm::cl::opt BenchmarkMode( @@ -79,6 +79,8 @@ static llvm::cl::opt namespace exegesis { +static llvm::ExitOnError ExitOnErr; + static unsigned GetOpcodeOrDie(const llvm::MCInstrInfo &MCInstrInfo) { if (OpcodeName.empty() && (OpcodeIndex == 0)) llvm::report_fatal_error( @@ -138,8 +140,13 @@ void benchmarkMain() { if (NumRepetitions == 0) llvm::report_fatal_error("--num-repetitions must be greater than zero"); - Runner->run(GetOpcodeOrDie(State.getInstrInfo()), Filter, NumRepetitions) - .writeYamlOrDie(getBenchmarkResultContext(State), BenchmarkFile); + // Write to standard output if file is not set. + if (BenchmarkFile.empty()) + BenchmarkFile = "-"; + + ExitOnErr( + Runner->run(GetOpcodeOrDie(State.getInstrInfo()), Filter, NumRepetitions) + .writeYaml(getBenchmarkResultContext(State), BenchmarkFile)); exegesis::pfm::pfmTerminate(); } @@ -157,21 +164,21 @@ static void maybeRunAnalysis(const Analysis &Analyzer, const std::string &Name, std::error_code ErrorCode; llvm::raw_fd_ostream ClustersOS(OutputFilename, ErrorCode, llvm::sys::fs::F_RW); - if (ErrorCode) - llvm::report_fatal_error("cannot open out file: " + OutputFilename); - if (auto Err = Analyzer.run(ClustersOS)) - llvm::report_fatal_error(std::move(Err)); + ExitOnErr(llvm::errorCodeToError(ErrorCode)); + ExitOnErr(Analyzer.run(ClustersOS)); } static void analysisMain() { + if (BenchmarkFile.empty()) + llvm::report_fatal_error("--benchmarks-file must be set."); + llvm::InitializeNativeTarget(); llvm::InitializeNativeTargetAsmPrinter(); - // Read benchmarks. const LLVMState State; const std::vector Points = - InstructionBenchmark::readYamlsOrDie(getBenchmarkResultContext(State), - BenchmarkFile); + ExitOnErr(InstructionBenchmark::readYamls( + getBenchmarkResultContext(State), BenchmarkFile)); llvm::outs() << "Parsed " << Points.size() << " benchmark points\n"; if (Points.empty()) { llvm::errs() << "no benchmarks to analyze\n"; diff --git a/unittests/tools/llvm-exegesis/BenchmarkResultTest.cpp b/unittests/tools/llvm-exegesis/BenchmarkResultTest.cpp index 4428dcf0537..a35ea05cb60 100644 --- a/unittests/tools/llvm-exegesis/BenchmarkResultTest.cpp +++ b/unittests/tools/llvm-exegesis/BenchmarkResultTest.cpp @@ -55,6 +55,7 @@ static constexpr const unsigned kReg2Id = 2; static constexpr const char kReg2Name[] = "Reg2"; TEST(BenchmarkResultTest, WriteToAndReadFromDisk) { + llvm::ExitOnError ExitOnErr; BenchmarkResultContext Ctx; Ctx.addInstrEntry(kInstrId, kInstrName); Ctx.addRegEntry(kReg1Id, kReg1Name); @@ -83,11 +84,12 @@ TEST(BenchmarkResultTest, WriteToAndReadFromDisk) { EC = llvm::sys::fs::createUniqueDirectory("BenchmarkResultTestDir", Filename); ASSERT_FALSE(EC); llvm::sys::path::append(Filename, "data.yaml"); - ToDisk.writeYamlOrDie(Ctx, Filename); + ExitOnErr(ToDisk.writeYaml(Ctx, Filename)); { // One-element version. - const auto FromDisk = InstructionBenchmark::readYamlOrDie(Ctx, Filename); + const auto FromDisk = + ExitOnErr(InstructionBenchmark::readYaml(Ctx, Filename)); EXPECT_EQ(FromDisk.Key.OpcodeName, ToDisk.Key.OpcodeName); EXPECT_THAT(FromDisk.Key.Instructions, @@ -104,7 +106,7 @@ TEST(BenchmarkResultTest, WriteToAndReadFromDisk) { { // Vector version. const auto FromDiskVector = - InstructionBenchmark::readYamlsOrDie(Ctx, Filename); + ExitOnErr(InstructionBenchmark::readYamls(Ctx, Filename)); ASSERT_EQ(FromDiskVector.size(), size_t{1}); const auto FromDisk = FromDiskVector[0]; EXPECT_EQ(FromDisk.Key.OpcodeName, ToDisk.Key.OpcodeName);