[llvm-readobj] set --elf-cg-profile as alias of --cg-profile

[zequanwu]

Summary

Rename --elf-cg-profile to --cg-profile and keep --elf-cg-profile as an alias of --cg-profile.

[MaskRay]

You can click Edit Related Revisions and assign a parent revision for a child revision.

Since --cg-profile is going to be the canonical option name, please rename --elf-cg-profile in tests. Keep one to demonstrate that it is an alias for --cg-profile.

[zequanwu]

This comment was removed by zequanwu.

[zequanwu]

Rename --elf-cg-profile to --cg-profile in tests and docs.
Keep --elf-cg-profile in test/tools/llvm-readobj/ELF/call-graph-profile.test for demonstration purpose.

[zequanwu]

fix typo

[jhenderson]

In D81855#2093336, @MaskRay wrote:

You can click Edit Related Revisions and assign a parent revision for a child revision.

Also, if you mention in the patch description (possibly also comments) "Depends on DXXXXX" it will automatically create the link.

Since --cg-profile is going to be the canonical option name, please rename --elf-cg-profile in tests. Keep one to demonstrate that it is an alias for --cg-profile.

I'd expect to see test\tools\llvm-readobj\ELF\call-graph-profile.test to be updated to use the new option, with two additional invocations using the old option (one each for llvm-readobj and llvm-readelf). Looks good apart from that.

[zequanwu]

Address comment.

[MaskRay]

LGTM. Please wait for @jhenderson's approval.

[jhenderson]

LGTM too. Thanks!

llvm/docs/CommandGuide/llvm-readelf.rst

 .. option:: --dyn-symbols, --dyn-syms
 
  Display the dynamic symbol table.
 
 .. option:: --dynamic-table, --dynamic, -d
 
  Display the dynamic table.
 
-.. option:: --elf-cg-profile
+.. option:: --cg-profile
 
  Display the callgraph profile section.
 
 .. option:: --elf-hash-histogram, --histogram, -I
 
  Display a bucket list histogram for dynamic symbol hash tables.
 
 .. option:: --elf-linker-options

llvm/docs/CommandGuide/llvm-readobj.rst

 .. option:: --dyn-symbols, --dyn-syms, --dt
 
  Display the dynamic symbol table.
 
 .. option:: --dynamic-table, --dynamic, -d
 
  Display the dynamic table.
 
-.. option:: --elf-cg-profile
+.. option:: --cg-profile
 
  Display the callgraph profile section.
 
 .. option:: --elf-hash-histogram, --histogram, -I
 
  Display a bucket list histogram for dynamic symbol hash tables.
 
 .. option:: --elf-linker-options

llvm/test/MC/ELF/cgprofile.ll

 ; RUN: llc -filetype=asm %s -o - -mtriple x86_64-pc-linux-gnu | FileCheck %s
 ; RUN: llc -filetype=obj %s -o %t -mtriple x86_64-pc-linux-gnu
-; RUN: llvm-readobj --elf-cg-profile %t | FileCheck %s --check-prefix=OBJ
+; RUN: llvm-readobj --cg-profile %t | FileCheck %s --check-prefix=OBJ
 
 declare void @b()
 
 define void @a() {
   call void @b()
   ret void
 }
 

llvm/test/MC/ELF/cgprofile.s

-# RUN: llvm-mc -filetype=obj -triple x86_64-pc-linux-gnu %s -o - | llvm-readobj -S --symbols --sd --elf-cg-profile | FileCheck %s
+# RUN: llvm-mc -filetype=obj -triple x86_64-pc-linux-gnu %s -o - | llvm-readobj -S --symbols --sd --cg-profile | FileCheck %s
 
   .section .test,"aw",@progbits
 a: .word b
 
   .cg_profile a, b, 32
   .cg_profile freq, a, 11
   .cg_profile late, late2, 20
   .cg_profile .L.local, b, 42

 # CHECK-NEXT:     Weight: 20
 # CHECK-NEXT:   }
 # CHECK-NEXT:   CGProfileEntry {
 # CHECK-NEXT:     From:
 # CHECK-NEXT:     To: b
 # CHECK-NEXT:     Weight: 42
 # CHECK-NEXT:   }
 # CHECK-NEXT: ]
 No newline at end of file

llvm/test/Object/multiple-sections.yaml

 # RUN: yaml2obj %s -o %t.o
-# RUN: llvm-readobj -a --elf-cg-profile --addrsig %t.o | FileCheck %s
+# RUN: llvm-readobj -a --cg-profile --addrsig %t.o | FileCheck %s
 
 # Test that multiple sections with the same type does not trigger an error.
 
 # CHECK: ElfHeader {
 # CHECK: VersionSymbols [
 # CHECK: VersionDefinitions [
 # CHECK: VersionRequirements [
 # CHECK: CGProfile [

llvm/test/tools/llvm-readobj/ELF/call-graph-profile.test

 ## This test checks how we handle the --elf-cg-profile option.
 
 # RUN: yaml2obj %s -o %t.o
+# RUN: llvm-readobj %t.o --cg-profile | FileCheck %s --check-prefix=LLVM
+# RUN: llvm-readelf %t.o --cg-profile | FileCheck %s --check-prefix=GNU
 # RUN: llvm-readobj %t.o --elf-cg-profile | FileCheck %s --check-prefix=LLVM
 # RUN: llvm-readelf %t.o --elf-cg-profile | FileCheck %s --check-prefix=GNU
 
 # LLVM:      CGProfile [
 # LLVM-NEXT:  CGProfileEntry {
 # LLVM-NEXT:    From: foo (1)
 # LLVM-NEXT:    To: bar (2)
 # LLVM-NEXT:    Weight: 89

llvm/test/tools/llvm-readobj/ELF/demangle.test

 ## Show that llvm-readelf + llvm-readobj demangle symbol names in symbol tables
 ## (including dynamic symbols), relocations (including dynamic relocations), and groups.
 
 # RUN: yaml2obj %s -o %t.so
 
 ## Check LLVM output style.
 # RUN: llvm-readobj --symbols --relocations --dyn-symbols --dyn-relocations \
-# RUN:              --elf-section-groups --elf-cg-profile --addrsig         \
+# RUN:              --elf-section-groups --cg-profile --addrsig         \
 # RUN:              --demangle %t.so > %t.llvm.long
 # RUN: llvm-readobj --symbols --relocations --dyn-symbols --dyn-relocations \
-# RUN:              --elf-section-groups --elf-cg-profile --addrsig         \
+# RUN:              --elf-section-groups --cg-profile --addrsig         \
 # RUN:              -C %t.so > %t.llvm.short
 # RUN: FileCheck %s --input-file %t.llvm.long --check-prefixes=LLVM-COMMON,LLVM-DEMANGLE
 # RUN: diff %t.llvm.long %t.llvm.short
 
 ## Check that default is no demangling.
 # RUN: llvm-readobj --symbols --relocations --dyn-symbols --dyn-relocations \
-# RUN:              --elf-section-groups --elf-cg-profile --addrsig         \
+# RUN:              --elf-section-groups --cg-profile --addrsig         \
 # RUN:              %t.so > %t.llvm.default
 # RUN: llvm-readobj --symbols --relocations --dyn-symbols --dyn-relocations \
-# RUN:              --elf-section-groups --elf-cg-profile --addrsig         \
+# RUN:              --elf-section-groups --cg-profile --addrsig         \
 # RUN:              --demangle=false %t.so > %t.llvm.nodemangle
 # RUN: FileCheck %s --input-file %t.llvm.default --check-prefixes=LLVM-COMMON,LLVM-MANGLED
 # RUN: diff %t.llvm.default %t.llvm.nodemangle
 
 # LLVM-COMMON:        Relocations [
 # LLVM-COMMON:          Section {{.*}} .rela.text.foo {
 # LLVM-DEMANGLE-NEXT:     {{ }}foo(char){{ }}
 # LLVM-MANGLED-NEXT:      {{ }}_Z3fooc{{ }}

llvm/test/tools/yaml2obj/ELF/call-graph-profile-section.yaml

 ## Test how we create SHT_LLVM_CALL_GRAPH_PROFILE sections.
 
 ## Test that the content of SHT_LLVM_CALL_GRAPH_PROFILE sections
 ## for 32/64-bit little/big endian targets is correct.
 # RUN: yaml2obj --docnum=1 -D BITS=64 -D ENCODE=LSB %s -o %t.le64
-# RUN: llvm-readobj --elf-cg-profile --sections --section-data %t.le64 | FileCheck %s --check-prefixes=BASIC,BASIC-LE
+# RUN: llvm-readobj --cg-profile --sections --section-data %t.le64 | FileCheck %s --check-prefixes=BASIC,BASIC-LE
 # RUN: yaml2obj --docnum=1 -D BITS=64 -D ENCODE=MSB %s -o %t.be64                      
-# RUN: llvm-readobj --elf-cg-profile --sections --section-data %t.be64 | FileCheck %s --check-prefixes=BASIC,BASIC-BE
+# RUN: llvm-readobj --cg-profile --sections --section-data %t.be64 | FileCheck %s --check-prefixes=BASIC,BASIC-BE
 # RUN: yaml2obj --docnum=1 -D BITS=32 -D ENCODE=LSB %s -o %t.le32                      
-# RUN: llvm-readobj --elf-cg-profile --sections --section-data %t.le32 | FileCheck %s --check-prefixes=BASIC,BASIC-LE
+# RUN: llvm-readobj --cg-profile --sections --section-data %t.le32 | FileCheck %s --check-prefixes=BASIC,BASIC-LE
 # RUN: yaml2obj --docnum=1 -D BITS=32 -D ENCODE=MSB %s -o %t.be32                      
-# RUN: llvm-readobj --elf-cg-profile --sections --section-data %t.be32 | FileCheck %s --check-prefixes=BASIC,BASIC-BE
+# RUN: llvm-readobj --cg-profile --sections --section-data %t.be32 | FileCheck %s --check-prefixes=BASIC,BASIC-BE
 
 # BASIC:        Name: .llvm.call-graph-profile
 # BASIC-NEXT:   Type: SHT_LLVM_CALL_GRAPH_PROFILE
 # BASIC-NEXT:   Flags [
 # BASIC-NEXT:   ]
 # BASIC-NEXT:   Address: 0x0
 # BASIC-NEXT:   Offset:
 # BASIC-NEXT:   Size: 32

 Sections:
   - Name:    .llvm.foo
     Type:    SHT_LLVM_CALL_GRAPH_PROFILE
     Content: ""
     Entries: []
 
 ## Check we can refer to symbols by name.
 # RUN: yaml2obj --docnum=4 %s -o %t.sym
-# RUN: llvm-readobj --elf-cg-profile %t.sym | FileCheck %s --check-prefix=SYMBOL-NAMES
+# RUN: llvm-readobj --cg-profile %t.sym | FileCheck %s --check-prefix=SYMBOL-NAMES
 
 # SYMBOL-NAMES:      CGProfile [
 # SYMBOL-NAMES-NEXT:   CGProfileEntry {
 # SYMBOL-NAMES-NEXT:     From: foo (1)
 # SYMBOL-NAMES-NEXT:     To: bar (2)
 # SYMBOL-NAMES-NEXT:     Weight: 10
 # SYMBOL-NAMES-NEXT:   }
 # SYMBOL-NAMES-NEXT:   CGProfileEntry {

llvm/tools/llvm-readobj/llvm-readobj.cpp

cl::opt<bool> HashHistogram(
       "elf-hash-histogram",
       cl::desc("Display bucket list histogram for hash sections"));
   cl::alias HashHistogramShort("I", cl::desc("Alias for -elf-hash-histogram"),
                                cl::aliasopt(HashHistogram));
   cl::alias HistogramAlias("histogram",
                            cl::desc("Alias for --elf-hash-histogram"),
                            cl::aliasopt(HashHistogram));
 
-  // --elf-cg-profile
-  cl::opt<bool> CGProfile("elf-cg-profile", cl::desc("Display callgraph profile section"));
+  // --cg-profile
+  cl::opt<bool> CGProfile("cg-profile",
+                          cl::desc("Display callgraph profile section"));
+  cl::alias ELFCGProfile("elf-cg-profile", cl::desc("Alias for --cg-profile"),
+                         cl::aliasopt(CGProfile));
 
   // -addrsig
   cl::opt<bool> Addrsig("addrsig",
                         cl::desc("Display address-significance table"));
 
   // -elf-output-style
   cl::opt<OutputStyleTy>
       Output("elf-output-style", cl::desc("Specify ELF dump style"),