[llvm-profdata] Rename show flag to --show-format

[ellis]

Summary

In https://reviews.llvm.org/D135127 we created the show flag
--output-format which was confusing because it behaved differently
than the same flag in the merge command. So, rename the flag to
--show-format. This also allows us to add the text option to mean
"normal text output" rather than "text-encoded profiles" like it does
for the merge command.

[wenlei]

lgtm, thanks.

llvm/tools/llvm-profdata/llvm-profdata.cpp

2703–2704

nit: OFormat was short for OutputFormat?

[ellis]

Rename OFormat to SFormat.

compiler-rt/test/profile/Linux/instrprof-show-debug-info-correlation.c

 // RUN: %clang_pgogen -o %t -g -mllvm --debug-info-correlate -mllvm --disable-vp=true %s
 // RUN: llvm-profdata show --debug-info=%t --detailed-summary --show-prof-sym-list | FileCheck %s
-// RUN: llvm-profdata show --debug-info=%t --output-format=yaml | FileCheck %s --match-full-lines --check-prefix YAML
+// RUN: llvm-profdata show --debug-info=%t --show-format=yaml | FileCheck %s --match-full-lines --check-prefix YAML
 
 // RUN: %clang_pgogen -o %t.no.dbg -mllvm --debug-info-correlate -mllvm --disable-vp=true %s
 // RUN: not llvm-profdata show --debug-info=%t.no.dbg 2>&1 | FileCheck %s --check-prefix NO-DBG
 // NO-DBG: unable to correlate profile: could not find any profile metadata in debug info
 
 // CHECK: a
 // YAML: Probes:
 // YAML:   - Function Name:   a

llvm/docs/CommandGuide/llvm-profdata.rst

 .. option:: --binary-ids
 
  Print embedded binary ids in a profile.
 
 .. option:: --counts
 
  Print the counter values for the displayed functions.
 
-.. option:: --output-format=<json|yaml>
+.. option:: --show-format=<text|json|yaml>
 
  Emit output in the selected format if supported by the provided profile type.
 
 .. option:: --function=<string>
 
  Print details for a function if the function's name contains the given string.
 
 .. option:: --help

llvm/test/tools/llvm-profdata/sample-profile-json.test

 RUN: llvm-profdata show --sample --json %p/Inputs/sample-profile.proftext | FileCheck %s --check-prefix=JSON
-RUN: llvm-profdata show --sample --output-format=json %p/Inputs/sample-profile.proftext | FileCheck %s --check-prefix=JSON
+RUN: llvm-profdata show --sample --show-format=json %p/Inputs/sample-profile.proftext | FileCheck %s --check-prefix=JSON
 JSON:      [
 JSON-NEXT:   {
 JSON-NEXT:     "name": "main",
 JSON-NEXT:     "total": 184019,
 JSON-NEXT:     "head": 0,
 JSON-NEXT:     "body": [
 JSON-NEXT:       {
 JSON-NEXT:         "line": 4,

llvm/tools/llvm-profdata/llvm-profdata.cpp

enum ProfileFormat {
   PF_None = 0,
   PF_Text,
   PF_Compact_Binary,
   PF_Ext_Binary,
   PF_GCC,
   PF_Binary
 };
 
-enum class OutputFormat { None, Json, Yaml };
+enum class ShowFormat { Text, Json, Yaml };
 
 static void warn(Twine Message, std::string Whence = "",
                  std::string Hint = "") {
   WithColor::warning();
   if (!Whence.empty())
     errs() << Whence << ": ";
   errs() << Message << "\n";
   if (!Hint.empty())

 static int showInstrProfile(const std::string &Filename, bool ShowCounts,
                             uint32_t TopN, bool ShowIndirectCallTargets,
                             bool ShowMemOPSizes, bool ShowDetailedSummary,
                             std::vector<uint32_t> DetailedSummaryCutoffs,
                             bool ShowAllFunctions, bool ShowCS,
                             uint64_t ValueCutoff, bool OnlyListBelow,
                             const std::string &ShowFunction, bool TextFormat,
                             bool ShowBinaryIds, bool ShowCovered,
-                            bool ShowProfileVersion, OutputFormat OFormat,
+                            bool ShowProfileVersion, ShowFormat SFormat,
                             raw_fd_ostream &OS) {
-  if (OFormat == OutputFormat::Json)
+  if (SFormat == ShowFormat::Json)
     exitWithError("JSON output is not supported for instr profiles");
-  if (OFormat == OutputFormat::Yaml)
+  if (SFormat == ShowFormat::Yaml)
     exitWithError("YAML output is not supported for instr profiles");
   auto ReaderOrErr = InstrProfReader::create(Filename);
   std::vector<uint32_t> Cutoffs = std::move(DetailedSummaryCutoffs);
   if (ShowDetailedSummary && Cutoffs.empty()) {
     Cutoffs = ProfileSummaryBuilder::DefaultCutoffs;
   }
   InstrProfSummaryBuilder Builder(std::move(Cutoffs));
   if (Error E = ReaderOrErr.takeError())

 }
 
 static int showSampleProfile(const std::string &Filename, bool ShowCounts,
                              uint32_t TopN, bool ShowAllFunctions,
                              bool ShowDetailedSummary,
                              const std::string &ShowFunction,
                              bool ShowProfileSymbolList,
                              bool ShowSectionInfoOnly, bool ShowHotFuncList,
-                             OutputFormat OFormat, raw_fd_ostream &OS) {
-  if (OFormat == OutputFormat::Yaml)
+                             ShowFormat SFormat, raw_fd_ostream &OS) {
+  if (SFormat == ShowFormat::Yaml)
     exitWithError("YAML output is not supported for sample profiles");
   using namespace sampleprof;
   LLVMContext Context;
   auto ReaderOrErr =
       SampleProfileReader::create(Filename, Context, FSDiscriminatorPassOption);
   if (std::error_code EC = ReaderOrErr.getError())
     exitWithErrorCode(EC, Filename);
 
   auto Reader = std::move(ReaderOrErr.get());
   if (ShowSectionInfoOnly) {
     showSectionInfo(Reader.get(), OS);
     return 0;
   }
 
   if (std::error_code EC = Reader->read())
     exitWithErrorCode(EC, Filename);
 
   if (ShowAllFunctions || ShowFunction.empty()) {
-    if (OFormat == OutputFormat::Json)
+    if (SFormat == ShowFormat::Json)
       Reader->dumpJson(OS);
     else
       Reader->dump(OS);
   } else {
-    if (OFormat == OutputFormat::Json)
+    if (SFormat == ShowFormat::Json)
       exitWithError(
           "the JSON format is supported only when all functions are to "
           "be printed");
 
     // TODO: parse context string to support filtering by contexts.
     Reader->dumpFunctionProfile(StringRef(ShowFunction), OS);
   }
 
static int showSampleProfile(const std::string &Filename, bool ShowCounts,
   if (ShowHotFuncList || TopN)
     showHotFunctionList(Reader->getProfiles(), Reader->getSummary(), TopN, OS);
 
   return 0;
 }
 
 static int showMemProfProfile(const std::string &Filename,
                               const std::string &ProfiledBinary,
-                              OutputFormat OFormat, raw_fd_ostream &OS) {
-  if (OFormat == OutputFormat::Json)
+                              ShowFormat SFormat, raw_fd_ostream &OS) {
+  if (SFormat == ShowFormat::Json)
     exitWithError("JSON output is not supported for MemProf");
   auto ReaderOr = llvm::memprof::RawMemProfReader::create(
       Filename, ProfiledBinary, /*KeepNames=*/true);
   if (Error E = ReaderOr.takeError())
     // Since the error can be related to the profile or the binary we do not
     // pass whence. Instead additional context is provided where necessary in
     // the error message.
     exitWithError(std::move(E), /*Whence*/ "");
 
   std::unique_ptr<llvm::memprof::RawMemProfReader> Reader(
       ReaderOr.get().release());
 
   Reader->printYAML(OS);
   return 0;
 }
 
 static int showDebugInfoCorrelation(const std::string &Filename,
                                     bool ShowDetailedSummary,
                                     bool ShowProfileSymbolList,
-                                    OutputFormat OFormat, raw_fd_ostream &OS) {
-  if (OFormat == OutputFormat::Json)
+                                    ShowFormat SFormat, raw_fd_ostream &OS) {
+  if (SFormat == ShowFormat::Json)
     exitWithError("JSON output is not supported for debug info correlation");
   std::unique_ptr<InstrProfCorrelator> Correlator;
   if (auto Err = InstrProfCorrelator::get(Filename).moveInto(Correlator))
     exitWithError(std::move(Err), Filename);
-  if (OFormat == OutputFormat::Yaml) {
+  if (SFormat == ShowFormat::Yaml) {
     if (auto Err = Correlator->dumpYaml(OS))
       exitWithError(std::move(Err), Filename);
     return 0;
   }
 
   if (auto Err = Correlator->correlateProfileData())
     exitWithError(std::move(Err), Filename);
 
static int showDebugInfoCorrelation(const std::string &Filename,
   return 0;
 }
 
 static int show_main(int argc, const char *argv[]) {
   cl::opt<std::string> Filename(cl::Positional, cl::desc("<profdata-file>"));
 
   cl::opt<bool> ShowCounts("counts", cl::init(false),
                            cl::desc("Show counter values for shown functions"));
-  cl::opt<OutputFormat> OFormat(
-      "output-format", cl::init(OutputFormat::None),
+  cl::opt<ShowFormat> SFormat(
+      "show-format", cl::init(ShowFormat::Text),
       cl::desc("Emit output in the selected format if supported"),
-      cl::values(clEnumValN(OutputFormat::Json, "json", "emit JSON"),
-                 clEnumValN(OutputFormat::Yaml, "yaml", "emit YAML")));
+      cl::values(clEnumValN(ShowFormat::Text, "text",
+                            "emit normal text output (default)"),
+                 clEnumValN(ShowFormat::Json, "json", "emit JSON"),
+                 clEnumValN(ShowFormat::Yaml, "yaml", "emit YAML")));
+  // TODO: Consider replacing this with `--show-format=text-encoding`.
   cl::opt<bool> TextFormat(
       "text", cl::init(false),
       cl::desc("Show instr profile data in text dump format"));
   cl::opt<bool> JsonFormat(
       "json", cl::desc("Show sample profile data in the JSON format "
-                       "(deprecated, please use --output-format=json)"));
+                       "(deprecated, please use --show-format=json)"));
   cl::opt<bool> ShowIndirectCallTargets(
       "ic-targets", cl::init(false),
       cl::desc("Show indirect call site target values for shown functions"));
   cl::opt<bool> ShowMemOPSizes(
       "memop-sizes", cl::init(false),
       cl::desc("Show the profiled sizes of the memory intrinsic calls "
                "for shown functions"));
   cl::opt<bool> ShowDetailedSummary("detailed-summary", cl::init(false),
exitWithError(
         DebugInfoFilename.ArgStr + "' is provided");
 
   if (Filename == OutputFilename) {
     errs() << sys::path::filename(argv[0])
            << ": Input file name cannot be the same as the output file name!\n";
     return 1;
   }
   if (JsonFormat)
-    OFormat = OutputFormat::Json;
+    SFormat = ShowFormat::Json;
 
   std::error_code EC;
   raw_fd_ostream OS(OutputFilename.data(), EC, sys::fs::OF_TextWithCRLF);
   if (EC)
     exitWithErrorCode(EC, OutputFilename);
 
   if (ShowAllFunctions && !ShowFunction.empty())
     WithColor::warning() << "-function argument ignored: showing all functions\n";
 
   if (!DebugInfoFilename.empty())
     return showDebugInfoCorrelation(DebugInfoFilename, ShowDetailedSummary,
-                                    ShowProfileSymbolList, OFormat, OS);
+                                    ShowProfileSymbolList, SFormat, OS);
 
   if (ProfileKind == instr)
     return showInstrProfile(
         Filename, ShowCounts, TopNFunctions, ShowIndirectCallTargets,
         ShowMemOPSizes, ShowDetailedSummary, DetailedSummaryCutoffs,
         ShowAllFunctions, ShowCS, ValueCutoff, OnlyListBelow, ShowFunction,
-        TextFormat, ShowBinaryIds, ShowCovered, ShowProfileVersion, OFormat,
+        TextFormat, ShowBinaryIds, ShowCovered, ShowProfileVersion, SFormat,
         OS);
   if (ProfileKind == sample)
     return showSampleProfile(Filename, ShowCounts, TopNFunctions,
                              ShowAllFunctions, ShowDetailedSummary,
                              ShowFunction, ShowProfileSymbolList,
-                             ShowSectionInfoOnly, ShowHotFuncList, OFormat, OS);
-  return showMemProfProfile(Filename, ProfiledBinary, OFormat, OS);
+                             ShowSectionInfoOnly, ShowHotFuncList, SFormat, OS);
+  return showMemProfProfile(Filename, ProfiledBinary, SFormat, OS);
 }
 
 int llvm_profdata_main(int argc, char **argvNonConst) {
   const char **argv = const_cast<const char **>(argvNonConst);
   InitLLVM X(argc, argv);
 
   StringRef ProgName(sys::path::filename(argv[0]));
   if (argc > 1) {