[llvm-pdbutil] Fix broken '-modi' option after change D122226.

[CarlosAlbertoEnciso]

Summary

The change described by:

https://reviews.llvm.org/D122226

Moved some llvm-pdbutil functionality to the debug PDB library.

This patch addresses a broken '-modi' argument handling, which causes an assertion if its value is other than '0' or '1', as described in https://reviews.llvm.org/D122226#3417917

In addition, moves the assertion for that argument from the PDB library into the llvm-pdbutil driver.

[CarlosAlbertoEnciso]

@zequanwu, thanks for detecting this issue as mentioned in https://reviews.llvm.org/D122226#3417917

[zequanwu]

Thanks for the fix.

[CarlosAlbertoEnciso]

In D123483#3443464, @zequanwu wrote:

Thanks for the fix.

@zequanwu Thanks for your review.

llvm/include/llvm/DebugInfo/PDB/Native/InputFile.h

 }
 
 template <typename CallbackT>
 Error iterateSymbolGroups(InputFile &Input, const PrintScope &HeaderScope,
                           CallbackT Callback) {
   AutoIndent Indent(HeaderScope);
 
   FilterOptions Filters = HeaderScope.P.getFilters();
+  if (Filters.NumOccurrences) {
     uint32_t Modi = Filters.DumpModi;
-
-  if (Modi > 0) {
-    assert(Modi == 1);
     SymbolGroup SG(&Input, Modi);
     return iterateOneModule(Input, withLabelWidth(HeaderScope, NumDigits(Modi)),
                             SG, Modi, Callback);
   }
 
   uint32_t I = 0;
 
   for (const auto &SG : Input.symbol_groups()) {

llvm/include/llvm/DebugInfo/PDB/Native/LinePrinter.h

struct FilterOptions {
   std::list<std::string> ExcludeSymbols;
   std::list<std::string> ExcludeCompilands;
   std::list<std::string> IncludeTypes;
   std::list<std::string> IncludeSymbols;
   std::list<std::string> IncludeCompilands;
   uint32_t PaddingThreshold;
   uint32_t SizeThreshold;
   uint32_t DumpModi;
+  uint32_t NumOccurrences;
   bool JustMyCode;
 };
 
 namespace llvm {
 namespace msf {
 class MSFStreamLayout;
 } // namespace msf
 namespace pdb {

llvm/lib/DebugInfo/PDB/Native/InputFile.cpp

 }
 
 bool llvm::pdb::shouldDumpSymbolGroup(uint32_t Idx, const SymbolGroup &Group,
                                       const FilterOptions &Filters) {
   if (Filters.JustMyCode && !isMyCode(Group))
     return false;
 
   // If the arg was not specified on the command line, always dump all modules.
-  if (Filters.DumpModi == 0)
+  if (Filters.NumOccurrences == 0)
     return true;
 
   // Otherwise, only dump if this is the same module specified.
   return (Filters.DumpModi == Idx);
 }

llvm/test/tools/llvm-pdbutil/modi.test

+; Using the existing PDB file (Stripped.pdb).
+;
+; -modi is specified more than once: command line error
+; RUN: not llvm-pdbutil dump --symbols -modi=1 -modi=1 %p/Inputs/Stripped.pdb > %t 2>&1
+; RUN: FileCheck -input-file=%t %s -check-prefix=TWICE
+; TWICE: argument '-modi' specified more than once.
+
+; -modi is not specified: process all modules
+; RUN: llvm-pdbutil dump --symbols %p/Inputs/Stripped.pdb > %t
+; RUN: FileCheck -input-file=%t %s -check-prefix=NONE
+
+; NONE: Symbols
+; NONE-CHECK: Mod 0000
+; NONE-CHECK: Mod 0001
+; NONE-CHECK: Mod 0002
+
+; -modi=0: process module with id=0
+; RUN: llvm-pdbutil dump --symbols -modi=0 %p/Inputs/Stripped.pdb > %t
+; RUN: FileCheck -input-file=%t %s -check-prefix=ZERO
+
+; ZERO: Symbols
+; ZERO-CHECK: Mod 0000
+
+; -modi=1: process module with id=1
+; RUN: llvm-pdbutil dump --symbols -modi=1 %p/Inputs/Stripped.pdb > %t
+; RUN: FileCheck -input-file=%t %s -check-prefix=ONE
+
+; ONE: Symbols
+; ONE-CHECK: Mod 0001
+
+; -modi=2: process module with id=2
+; RUN: llvm-pdbutil dump --symbols -modi=2 %p/Inputs/Stripped.pdb > %t
+; RUN: FileCheck -input-file=%t %s -check-prefix=TWO
+
+; TWO: Symbols
+; TWO-CHECK: Mod 0002

llvm/tools/llvm-pdbutil/llvm-pdbutil.cpp

int main(int Argc, const char **Argv) {
   propagate(opts::Filters.ExcludeSymbols, opts::pretty::ExcludeSymbols);
   propagate(opts::Filters.ExcludeCompilands, opts::pretty::ExcludeCompilands);
   propagate(opts::Filters.IncludeTypes, opts::pretty::IncludeTypes);
   propagate(opts::Filters.IncludeSymbols, opts::pretty::IncludeSymbols);
   propagate(opts::Filters.IncludeCompilands, opts::pretty::IncludeCompilands);
   opts::Filters.PaddingThreshold = opts::pretty::PaddingThreshold;
   opts::Filters.SizeThreshold = opts::pretty::SizeThreshold;
   opts::Filters.JustMyCode = opts::dump::JustMyCode;
-  if (opts::dump::DumpModi.getNumOccurrences())
+  if (opts::dump::DumpModi.getNumOccurrences() > 0) {
+    if (opts::dump::DumpModi.getNumOccurrences() != 1) {
+      errs() << "argument '-modi' specified more than once.\n";
+      errs().flush();
+      exit(1);
+    }
+    opts::Filters.NumOccurrences = opts::dump::DumpModi.getNumOccurrences();
     opts::Filters.DumpModi = opts::dump::DumpModi;
+  }
 
   if (opts::PdbToYamlSubcommand) {
     pdb2Yaml(opts::pdb2yaml::InputFilename.front());
   } else if (opts::YamlToPdbSubcommand) {
     if (opts::yaml2pdb::YamlPdbOutputFile.empty()) {
       SmallString<16> OutputFilename(opts::yaml2pdb::InputFilename.getValue());
       sys::path::replace_extension(OutputFilename, ".pdb");
       opts::yaml2pdb::YamlPdbOutputFile = std::string(OutputFilename.str());