[NFC][llvm-dwp] Switch from llvm::cl to OptTable

[avillega]

Summary

Switch the parse of command line options from llvm::cl to OptTable.

The motivation for this change is to continue adding llvm based tools
to the llvm driver multicall. For more information about the proposal
and motivation, please see https://discourse.llvm.org/t/rfc-llvm-busybox-proposal/58494

[avillega]

Rebase change.

[abrachet]

llvm/tools/llvm-dwp/Opts.td

14

Add newline

llvm/tools/llvm-dwp/llvm-dwp.cpp

80

Looks like this is never written to

[avillega]

Fix review comments.

[avillega]

llvm/tools/llvm-dwp/llvm-dwp.cpp

80

Thanks, nice catch.

llvm/test/tools/llvm-dwp/help.test

 # RUN: llvm-dwp --help | FileCheck %s --check-prefix HELP --implicit-check-not='{{[Oo]}}ptions:'
 
 # HELP: OVERVIEW
 # HELP: USAGE
-# HELP: Color Options
-# HELP: Generic Options
-# HELP: Specific Options
+# HELP: OPTIONS

llvm/tools/llvm-dwp/CMakeLists.txt

 set(LLVM_LINK_COMPONENTS
   AllTargetsCodeGens
   AllTargetsDescs
   AllTargetsInfos
   DebugInfoDWARF
   DWP
   MC
   Object
+  Option
   Support
   TargetParser
   )
 
+set(LLVM_TARGET_DEFINITIONS Opts.td)
+tablegen(LLVM Opts.inc -gen-opt-parser-defs)
+add_public_tablegen_target(DwpOptsTableGen)
+
 add_llvm_tool(llvm-dwp
   llvm-dwp.cpp
 
   DEPENDS
   intrinsics_gen
+  DwpOptsTableGen
   )
 
 if(LLVM_INSTALL_BINUTILS_SYMLINKS)
   add_llvm_tool_symlink(dwp llvm-dwp)
 endif()

llvm/tools/llvm-dwp/Opts.td

+include "llvm/Option/OptParser.td"
+
+class F<string name, string help> : Flag<["-", "--"], name>, HelpText<help>;
+class S<string name, string help> : Separate<["-", "--"], name>, HelpText<help>;
+
+def help : F<"help", "Display this help">;
+def : F<"h", "Alias for --help">, Alias<help>;
+def version : F<"version", "Display the version of this program">;
+
+def execFileNames : S<"e", "Specify the executable/library files to get the list of *.dwo from.">, MetaVarName<"<filename>">;
+def outputFileName : S<"o", "Specify the output file.">, MetaVarName<"<filename>">;
+def continueOnCuIndexOverflow: F<"continue-on-cu-index-overflow", "This turns an error when offset for .debug_*.dwo sections "
+                                         "overfolws into a warning.">, MetaVarName<"<filename>">;

llvm/tools/llvm-dwp/llvm-dwp.cpp

 #include "llvm/MC/MCCodeEmitter.h"
 #include "llvm/MC/MCContext.h"
 #include "llvm/MC/MCInstrInfo.h"
 #include "llvm/MC/MCObjectWriter.h"
 #include "llvm/MC/MCRegisterInfo.h"
 #include "llvm/MC/MCSubtargetInfo.h"
 #include "llvm/MC/MCTargetOptionsCommandFlags.h"
 #include "llvm/MC/TargetRegistry.h"
+#include "llvm/Option/ArgList.h"
+#include "llvm/Option/Option.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/InitLLVM.h"
 #include "llvm/Support/MemoryBuffer.h"
 #include "llvm/Support/TargetSelect.h"
 #include "llvm/Support/ToolOutputFile.h"
 #include <optional>
 
 using namespace llvm;
 using namespace llvm::object;
 
 static mc::RegisterMCTargetOptionsFlags MCTargetOptionsFlags;
 
-cl::OptionCategory DwpCategory("Specific Options");
-static cl::list<std::string>
-    InputFiles(cl::Positional, cl::desc("<input files>"), cl::cat(DwpCategory));
-
-static cl::list<std::string> ExecFilenames(
-    "e",
-    cl::desc(
-        "Specify the executable/library files to get the list of *.dwo from"),
-    cl::value_desc("filename"), cl::cat(DwpCategory));
-
-static cl::opt<std::string> OutputFilename(cl::Required, "o",
-                                           cl::desc("Specify the output file."),
-                                           cl::value_desc("filename"),
-                                           cl::cat(DwpCategory));
-
-static cl::opt<bool> ContinueOnCuIndexOverflow(
-    "continue-on-cu-index-overflow",
-    cl::desc("This turns an error when offset for .debug_*.dwo sections "
-             "overfolws into a warning."),
-    cl::cat(DwpCategory));
+// Command-line option boilerplate.
+namespace {
+enum ID {
+  OPT_INVALID = 0, // This is not an option ID.
+#define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM,  \
+               HELPTEXT, METAVAR, VALUES)                                      \
+  OPT_##ID,
+#include "Opts.inc"
+#undef OPTION
+};
+
+#define PREFIX(NAME, VALUE)                                                    \
+  static constexpr StringLiteral NAME##_init[] = VALUE;                        \
+  static constexpr ArrayRef<StringLiteral> NAME(NAME##_init,                   \
+                                                std::size(NAME##_init) - 1);
+#include "Opts.inc"
+#undef PREFIX
+
+static constexpr opt::OptTable::Info InfoTable[] = {
+#define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM,  \
+               HELPTEXT, METAVAR, VALUES)                                      \
+  {                                                                            \
+      PREFIX,      NAME,      HELPTEXT,                                        \
+      METAVAR,     OPT_##ID,  opt::Option::KIND##Class,                        \
+      PARAM,       FLAGS,     OPT_##GROUP,                                     \
+      OPT_##ALIAS, ALIASARGS, VALUES},
+#include "Opts.inc"
+#undef OPTION
+};
+
+class DwpOptTable : public opt::GenericOptTable {
+public:
+  DwpOptTable() : GenericOptTable(InfoTable) {}
+};
+} // end anonymous namespace
+
+// Options
+static std::vector<std::string> ExecFilenames;
+static std::string OutputFilename;
+static bool ContinueOnCuIndexOverflow;
 
 static Expected<SmallVector<std::string, 16>>
 getDWOFilenames(StringRef ExecFilename) {
   auto ErrOrObj = object::ObjectFile::createObjectFile(ExecFilename);
   if (!ErrOrObj)
     return ErrOrObj.takeError();
 
   const ObjectFile &Obj = *ErrOrObj.get().getBinary();
if (!ErrOrObj)
     return ErrOrObj.takeError();
 
   return ErrOrObj->getBinary()->makeTriple();
 }
 
 int main(int argc, char **argv) {
   InitLLVM X(argc, argv);
 
-  cl::HideUnrelatedOptions({&DwpCategory, &getColorCategory()});
-  cl::ParseCommandLineOptions(argc, argv, "merge split dwarf (.dwo) files\n");
+  DwpOptTable Tbl;
+  llvm::BumpPtrAllocator A;
+  llvm::StringSaver Saver{A};
+  opt::InputArgList Args =
+      Tbl.parseArgs(argc, argv, OPT_UNKNOWN, Saver, [&](StringRef Msg) {
+        llvm::errs() << Msg << '\n';
+        std::exit(1);
+      });
+
+  if (Args.hasArg(OPT_help)) {
+    Tbl.printHelp(llvm::outs(), "llvm-dwp [options] <input files>",
+                  "merge split dwarf (.dwo) files");
+    std::exit(0);
+  }
+
+  if (Args.hasArg(OPT_version)) {
+    llvm::cl::PrintVersionMessage();
+    std::exit(0);
+  }
+
+  OutputFilename = Args.getLastArgValue(OPT_outputFileName, "");
+  ContinueOnCuIndexOverflow = Args.hasArg(OPT_continueOnCuIndexOverflow);
+
+  for (const llvm::opt::Arg *A : Args.filtered(OPT_execFileNames))
+    ExecFilenames.emplace_back(A->getValue());
+
+  std::vector<std::string> DWOFilenames;
+  for (const llvm::opt::Arg *A : Args.filtered(OPT_INPUT))
+    DWOFilenames.emplace_back(A->getValue());
 
   llvm::InitializeAllTargetInfos();
   llvm::InitializeAllTargetMCs();
   llvm::InitializeAllTargets();
   llvm::InitializeAllAsmPrinters();
 
-  std::vector<std::string> DWOFilenames = InputFiles;
   for (const auto &ExecFilename : ExecFilenames) {
     auto DWOs = getDWOFilenames(ExecFilename);
     if (!DWOs) {
       logAllUnhandledErrors(
           handleErrors(DWOs.takeError(),
                        [&](std::unique_ptr<ECError> EC) -> Error {
                          return createFileError(ExecFilename,
                                                 Error(std::move(EC)));

llvm/utils/gn/secondary/llvm/tools/llvm-dwp/BUILD.gn

 import("//llvm/tools/binutils_symlinks.gni")
 import("//llvm/utils/gn/build/symlink_or_copy.gni")
+import("//llvm/utils/TableGen/tablegen.gni")
+
+tablegen("Opts") {
+  visibility = [ ":llvm-dwp" ]
+  args = [ "-gen-opt-parser-defs" ]
+}
 
 if (llvm_install_binutils_symlinks) {
   symlink_or_copy("dwp") {
     deps = [ ":llvm-dwp" ]
     source = "llvm-dwp"
     output = "$root_out_dir/bin/dwp"
   }
 }
 
 # //:llvm-dwp depends on this symlink target, see comment in //BUILD.gn.
 group("symlinks") {
   deps = [ ":llvm-dwp" ]
   if (llvm_install_binutils_symlinks) {
     deps += [ ":dwp" ]
   }
 }
 
 executable("llvm-dwp") {
   deps = [
+    ":Opts",
     "//llvm/lib/DWP",
     "//llvm/lib/DebugInfo/DWARF",
     "//llvm/lib/MC",
     "//llvm/lib/Object",
+    "//llvm/lib/Option",
     "//llvm/lib/Support",
     "//llvm/lib/Target:TargetsToBuild",
     "//llvm/lib/TargetParser",
   ]
   sources = [ "llvm-dwp.cpp" ]
 }

utils/bazel/llvm-project-overlay/llvm/BUILD.bazel

deps = [
         ":Object",
         ":Option",
         ":Support",
         ":Target",
         ":TargetParser",
     ],
 )
 
+gentbl(
+    name = "DwpOptionsTableGen",
+    strip_include_prefix = "tools/llvm-dwp",
+    tbl_outs = [(
+        "-gen-opt-parser-defs",
+        "tools/llvm-dwp/Opts.inc",
+    )],
+    tblgen = ":llvm-tblgen",
+    td_file = "tools/llvm-dwp/Opts.td",
+    td_srcs = ["include/llvm/Option/OptParser.td"],
+)
+
 cc_binary(
     name = "llvm-dwp",
     srcs = glob([
         "tools/llvm-dwp/*.cpp",
         "tools/llvm-dwp/*.h",
     ]),
     copts = llvm_copts,
     stamp = 0,
     deps = [
         ":AllTargetsCodeGens",
         ":DWP",
+        ":DwpOptionsTableGen",
         ":MC",
+        ":Option",
         ":Support",
     ],
 )
 
 cc_binary(
     name = "llvm-exegesis",
     srcs = [
         "tools/llvm-exegesis/llvm-exegesis.cpp",