[llvm] 9c8b89f - llvm-reduce: Refine missing argument behavior
Matt Arsenault via llvm-commits
llvm-commits at lists.llvm.org
Tue Jan 3 13:04:12 PST 2023
Author: Matt Arsenault
Date: 2023-01-03T16:01:36-05:00
New Revision: 9c8b89f580d0a6ee43c9ac5a491ee1c56078a62f
URL: https://github.com/llvm/llvm-project/commit/9c8b89f580d0a6ee43c9ac5a491ee1c56078a62f
DIFF: https://github.com/llvm/llvm-project/commit/9c8b89f580d0a6ee43c9ac5a491ee1c56078a62f.diff
LOG: llvm-reduce: Refine missing argument behavior
We required the test and input arguments for --print-delta-passes
which is unhelpful. Also, start printing the help output if no
arguments were supplied.
It looks like there's more sophisticated ways to accomplish this with
the opt library, but it was less work to manually emit these errors.
Added:
llvm/test/tools/llvm-reduce/command-line-behavior.test
Modified:
llvm/tools/llvm-reduce/ReducerWorkItem.cpp
llvm/tools/llvm-reduce/ReducerWorkItem.h
llvm/tools/llvm-reduce/TestRunner.cpp
llvm/tools/llvm-reduce/TestRunner.h
llvm/tools/llvm-reduce/deltas/Delta.cpp
llvm/tools/llvm-reduce/llvm-reduce.cpp
Removed:
################################################################################
diff --git a/llvm/test/tools/llvm-reduce/command-line-behavior.test b/llvm/test/tools/llvm-reduce/command-line-behavior.test
new file mode 100644
index 000000000000..264b8263d53f
--- /dev/null
+++ b/llvm/test/tools/llvm-reduce/command-line-behavior.test
@@ -0,0 +1,12 @@
+# Print the help output if no arguments are specified
+# RUN: llvm-reduce --help | grep "LLVM automatic testcase reducer"
+# RUN: llvm-reduce | grep "LLVM automatic testcase reducer"
+
+# Don't require any other arguments for --print-delta-passes
+# RUN: llvm-reduce --print-delta-passes | grep "Delta passes (pass to \`--delta-passes=\` as a comma separated list)"
+
+# Missing test input
+# RUN: not llvm-reduce --test FileCheck 2>&1 | grep "error: reduction testcase positional argument must be specified"
+
+# Missing test script
+# RUN: not llvm-reduce some-input 2>&1 | grep "error: --test option must be specified"
diff --git a/llvm/tools/llvm-reduce/ReducerWorkItem.cpp b/llvm/tools/llvm-reduce/ReducerWorkItem.cpp
index 26087106fa74..e86c2ad7294c 100644
--- a/llvm/tools/llvm-reduce/ReducerWorkItem.cpp
+++ b/llvm/tools/llvm-reduce/ReducerWorkItem.cpp
@@ -39,7 +39,8 @@ static cl::opt<std::string> TargetTriple("mtriple",
cl::desc("Set the target triple"),
cl::cat(LLVMReduceOptions));
-void readBitcode(ReducerWorkItem &M, MemoryBufferRef Data, LLVMContext &Ctx, const char *ToolName);
+void readBitcode(ReducerWorkItem &M, MemoryBufferRef Data, LLVMContext &Ctx,
+ StringRef ToolName);
static void cloneFrameInfo(
MachineFrameInfo &DstMFI, const MachineFrameInfo &SrcMFI,
@@ -387,9 +388,8 @@ static void initializeTargetInfo() {
}
std::pair<std::unique_ptr<ReducerWorkItem>, bool>
-parseReducerWorkItem(const char *ToolName, StringRef Filename,
- LLVMContext &Ctxt, std::unique_ptr<TargetMachine> &TM,
- bool IsMIR) {
+parseReducerWorkItem(StringRef ToolName, StringRef Filename, LLVMContext &Ctxt,
+ std::unique_ptr<TargetMachine> &TM, bool IsMIR) {
bool IsBitcode = false;
Triple TheTriple;
@@ -456,7 +456,7 @@ parseReducerWorkItem(const char *ToolName, StringRef Filename,
(const unsigned char *)(*MB)->getBufferEnd())) {
std::unique_ptr<Module> Result = parseIRFile(Filename, Err, Ctxt);
if (!Result) {
- Err.print(ToolName, errs());
+ Err.print(ToolName.data(), errs());
return {nullptr, false};
}
MMM->M = std::move(Result);
diff --git a/llvm/tools/llvm-reduce/ReducerWorkItem.h b/llvm/tools/llvm-reduce/ReducerWorkItem.h
index e0e3d9fac920..ec19e3ab5b01 100644
--- a/llvm/tools/llvm-reduce/ReducerWorkItem.h
+++ b/llvm/tools/llvm-reduce/ReducerWorkItem.h
@@ -42,9 +42,8 @@ class ReducerWorkItem {
};
std::pair<std::unique_ptr<ReducerWorkItem>, bool>
-parseReducerWorkItem(const char *ToolName, StringRef Filename,
- LLVMContext &Ctxt, std::unique_ptr<TargetMachine> &TM,
- bool IsMIR);
+parseReducerWorkItem(StringRef ToolName, StringRef Filename, LLVMContext &Ctxt,
+ std::unique_ptr<TargetMachine> &TM, bool IsMIR);
std::unique_ptr<ReducerWorkItem>
cloneReducerWorkItem(const ReducerWorkItem &MMM, const TargetMachine *TM);
diff --git a/llvm/tools/llvm-reduce/TestRunner.cpp b/llvm/tools/llvm-reduce/TestRunner.cpp
index 3d486f87e1bd..3a5483cdae1c 100644
--- a/llvm/tools/llvm-reduce/TestRunner.cpp
+++ b/llvm/tools/llvm-reduce/TestRunner.cpp
@@ -21,7 +21,7 @@ using namespace llvm;
TestRunner::TestRunner(StringRef TestName,
const std::vector<std::string> &TestArgs,
std::unique_ptr<ReducerWorkItem> Program,
- std::unique_ptr<TargetMachine> TM, const char *ToolName,
+ std::unique_ptr<TargetMachine> TM, StringRef ToolName,
StringRef OutputName, bool InputIsBitcode,
bool OutputBitcode)
: TestName(TestName), ToolName(ToolName), TestArgs(TestArgs),
diff --git a/llvm/tools/llvm-reduce/TestRunner.h b/llvm/tools/llvm-reduce/TestRunner.h
index 5530cbbe41ab..128eede0feea 100644
--- a/llvm/tools/llvm-reduce/TestRunner.h
+++ b/llvm/tools/llvm-reduce/TestRunner.h
@@ -28,7 +28,7 @@ class TestRunner {
public:
TestRunner(StringRef TestName, const std::vector<std::string> &TestArgs,
std::unique_ptr<ReducerWorkItem> Program,
- std::unique_ptr<TargetMachine> TM, const char *ToolName,
+ std::unique_ptr<TargetMachine> TM, StringRef ToolName,
StringRef OutputFilename, bool InputIsBitcode, bool OutputBitcode);
/// Runs the interesting-ness test for the specified file
@@ -42,7 +42,7 @@ class TestRunner {
const TargetMachine *getTargetMachine() const { return TM.get(); }
- const char *getToolName() const { return ToolName; }
+ StringRef getToolName() const { return ToolName; }
void writeOutput(StringRef Message);
@@ -52,7 +52,7 @@ class TestRunner {
private:
StringRef TestName;
- const char *ToolName;
+ StringRef ToolName;
const std::vector<std::string> &TestArgs;
std::unique_ptr<ReducerWorkItem> Program;
std::unique_ptr<TargetMachine> TM;
diff --git a/llvm/tools/llvm-reduce/deltas/Delta.cpp b/llvm/tools/llvm-reduce/deltas/Delta.cpp
index da9278dcf86e..0def68c5f11c 100644
--- a/llvm/tools/llvm-reduce/deltas/Delta.cpp
+++ b/llvm/tools/llvm-reduce/deltas/Delta.cpp
@@ -63,7 +63,7 @@ unsigned NumJobs = 1;
void writeBitcode(ReducerWorkItem &M, raw_ostream &OutStream);
void readBitcode(ReducerWorkItem &M, MemoryBufferRef Data, LLVMContext &Ctx,
- const char *ToolName);
+ StringRef ToolName);
bool isReduced(ReducerWorkItem &M, const TestRunner &Test) {
const bool UseBitcode = Test.inputIsBitcode() || TmpFilesAsBitcode;
diff --git a/llvm/tools/llvm-reduce/llvm-reduce.cpp b/llvm/tools/llvm-reduce/llvm-reduce.cpp
index 3be603da3487..29c36fb2133d 100644
--- a/llvm/tools/llvm-reduce/llvm-reduce.cpp
+++ b/llvm/tools/llvm-reduce/llvm-reduce.cpp
@@ -45,18 +45,19 @@ static cl::opt<bool> PreserveDebugEnvironment(
"debugging (crash reports, llvm-symbolizer and core dumps)"),
cl::cat(LLVMReduceOptions));
+// FIXME: should be able to do this without other arguments, also add in help.
static cl::opt<bool>
PrintDeltaPasses("print-delta-passes",
cl::desc("Print list of delta passes, passable to "
"--delta-passes as a comma separated list"),
cl::cat(LLVMReduceOptions));
-static cl::opt<std::string> InputFilename(cl::Positional, cl::Required,
+static cl::opt<std::string> InputFilename(cl::Positional,
cl::desc("<input llvm ll/bc file>"),
cl::cat(LLVMReduceOptions));
static cl::opt<std::string>
- TestFilename("test", cl::Required,
+ TestFilename("test",
cl::desc("Name of the interesting-ness test to be run"),
cl::cat(LLVMReduceOptions));
@@ -137,7 +138,8 @@ static std::pair<StringRef, bool> determineOutputType(bool IsMIR,
return {OutputFilename, OutputBitcode};
}
-void readBitcode(ReducerWorkItem &M, MemoryBufferRef Data, LLVMContext &Ctx, const char *ToolName) {
+void readBitcode(ReducerWorkItem &M, MemoryBufferRef Data, LLVMContext &Ctx,
+ StringRef ToolName) {
Expected<BitcodeFileContents> IF = llvm::getBitcodeFileContents(Data);
if (!IF) {
WithColor::error(errs(), ToolName) << IF.takeError();
@@ -156,10 +158,21 @@ void readBitcode(ReducerWorkItem &M, MemoryBufferRef Data, LLVMContext &Ctx, con
int main(int Argc, char **Argv) {
InitLLVM X(Argc, Argv);
+ const StringRef ToolName(Argv[0]);
cl::HideUnrelatedOptions({&LLVMReduceOptions, &getColorCategory()});
cl::ParseCommandLineOptions(Argc, Argv, "LLVM automatic testcase reducer.\n");
+ if (Argc == 1) {
+ cl::PrintHelpMessage();
+ return 0;
+ }
+
+ if (PrintDeltaPasses) {
+ printDeltaPasses(outs());
+ return 0;
+ }
+
bool ReduceModeMIR = false;
if (InputLanguage != InputLanguages::None) {
if (InputLanguage == InputLanguages::MIR)
@@ -168,9 +181,15 @@ int main(int Argc, char **Argv) {
ReduceModeMIR = true;
}
- if (PrintDeltaPasses) {
- printDeltaPasses(errs());
- return 0;
+ if (InputFilename.empty()) {
+ WithColor::error(errs(), ToolName)
+ << "reduction testcase positional argument must be specified\n";
+ return 1;
+ }
+
+ if (TestFilename.empty()) {
+ WithColor::error(errs(), ToolName) << "--test option must be specified\n";
+ return 1;
}
if (!PreserveDebugEnvironment)
@@ -180,7 +199,7 @@ int main(int Argc, char **Argv) {
std::unique_ptr<TargetMachine> TM;
auto [OriginalProgram, InputIsBitcode] =
- parseReducerWorkItem(Argv[0], InputFilename, Context, TM, ReduceModeMIR);
+ parseReducerWorkItem(ToolName, InputFilename, Context, TM, ReduceModeMIR);
if (!OriginalProgram) {
return 1;
}
@@ -192,7 +211,7 @@ int main(int Argc, char **Argv) {
// Initialize test environment
TestRunner Tester(TestFilename, TestArguments, std::move(OriginalProgram),
- std::move(TM), Argv[0], OutputFilename, InputIsBitcode,
+ std::move(TM), ToolName, OutputFilename, InputIsBitcode,
OutputBitcode);
// This parses and writes out the testcase into a temporary file copy for the
More information about the llvm-commits
mailing list