Rename "llvm-gsym" and "llvm-gsymutil" to "gsymutil".

[clayborg]

Summary

This patch renames the llvm-gsymutil tool to "gsymutil" along with all directories and build files. Also removed the unneeded deps from the "gsymutil" tool to allow gsymutil to link against less things.

[aprantl]

llvm/tools/gsymutil/gsymutil.cpp

432

This is not a rename?

[MaskRay]

llvm/tools/gsymutil/gsymutil.cpp

430–431

Can you recheck whether the remaining are all needed?

[clayborg]

llvm/tools/gsymutil/gsymutil.cpp

430–431

If I removed all InitializeAllTargetInfos and InitializeAllTargetMCs I got errors when trying to load object files. I didn't try them individually though, so I will try that.

432

Yeah, I modified the description after submitting to say "Also removed the AsmPrinter from the dependencies.".

[clayborg]

Removed more dependencies from the "gsymutil" tool and removed uneeded function calls.

[clayborg]

llvm/tools/gsymutil/gsymutil.cpp

431

I was able to remove more.

[echristo]

Most of the other tools are llvm- any reason for the change?

[aprantl]

In D75291#1896992, @echristo wrote:

Most of the other tools are llvm- any reason for the change?

I was the one to suggest this name, since I found it inconsistent to have dsymutil but llvm-gsymutil. The others are mostly called llvm- to differentiate them from preexisting tools with the same name. I don't think it's necessary for a new tool; unless we want the prefix there it for marketing reasons?

[clayborg]

Renamed back to llvm-gsymutil for everything. So this patch now is renaming from llvm-gsym to llvm-gsymutil for the tool directory.

[clayborg]

Remove an extra fix for triples that I will commit with a new patch.

[clayborg]

Is everyone ok with this naming?

[fpetrogalli]

Hello @clayborg ,

this patch is breaking shared libs builds (cmake path/to/llvm -DBUILD_SHARED_LIBS=ON).

Could you please fix it?

Regards,

Francesco

[MaskRay]

In D75291#1904393, @fpetrogalli wrote:

Hello @clayborg ,

this patch is breaking shared libs builds (cmake path/to/llvm -DBUILD_SHARED_LIBS=ON).

Could you please fix it?

Regards,

Francesco

-DBUILD_SHARED_LIBS=ON build is good.

[fpetrogalli]

In D75291#1906405, @MaskRay wrote:

In D75291#1904393, @fpetrogalli wrote:

Hello @clayborg ,

this patch is breaking shared libs builds (cmake path/to/llvm -DBUILD_SHARED_LIBS=ON).

Could you please fix it?

Regards,

Francesco

-DBUILD_SHARED_LIBS=ON build is good.

Reverting this patch locally worked for me yesterday, so I assumed it was this patch causing the problem. When I pulled upstream today everything was working, so I must have done something wrong. In any case, thank you for double checking.

Francesco

llvm/test/CMakeLists.txt

 # NOTE: Sync the substitutions in test/lit.cfg when adding to this list.
 set(LLVM_TEST_DEPENDS
           BugpointPasses
           FileCheck
           LLVMHello
           UnitTests
           bugpoint
           count
+          gsymutil
           llc
           lli
           lli-child-target
           llvm-addr2line
           llvm-ar
           llvm-as
           llvm-bcanalyzer
           llvm-c-test
set(LLVM_TEST_DEPENDS
           llvm-dis
           llvm-dlltool
           dsymutil
           llvm-dwarfdump
           llvm-dwp
           llvm-elfabi
           llvm-exegesis
           llvm-extract
-          llvm-gsymutil
           llvm-isel-fuzzer
           llvm-ifs
           llvm-install-name-tool
           llvm-jitlink
           llvm-lib
           llvm-link
           llvm-lipo
           llvm-locstats

llvm/test/tools/gsymutil/cmdline.test

-RUN: llvm-gsymutil -h 2>&1 | FileCheck --check-prefix=HELP %s
-RUN: llvm-gsymutil --help 2>&1 | FileCheck --check-prefix=HELP %s
+RUN: gsymutil -h 2>&1 | FileCheck --check-prefix=HELP %s
+RUN: gsymutil --help 2>&1 | FileCheck --check-prefix=HELP %s
 HELP: OVERVIEW: A tool for dumping, searching and creating GSYM files.
-HELP: USAGE: llvm-gsymutil{{[^ ]*}} [options] <input GSYM files>
+HELP: USAGE: gsymutil{{[^ ]*}} [options] <input GSYM files>
 HELP: OPTIONS:
 HELP: Conversion Options:
 HELP: --arch=<arch>
 HELP: --convert=<path>
 HELP: --num-threads=<n>
 HELP: --out-file=<path>
 HELP: --verify
 HELP: Generic Options:
 HELP: --help
 HELP: --version
 HELP: Lookup Options:
 HELP: --address=<addr>
 HELP: Options:
 HELP: --verbose
 
-RUN: llvm-gsymutil --version 2>&1 | FileCheck --check-prefix=VERSION %s
+RUN: gsymutil --version 2>&1 | FileCheck --check-prefix=VERSION %s
 VERSION: {{ version }}

llvm/test/tools/gsymutil/elf-dwarf.yaml

 ## Test loading an ELF file with DWARF. First we make the ELF file from yaml,
 ## then we convert the ELF file to GSYM, then we do lookups on the newly
 ## created GSYM, and finally we dump the entire GSYM.
 
 # RUN: yaml2obj %s -o %t
-# RUN: llvm-gsymutil --convert %t -o %t.gsym 2>&1 | FileCheck %s --check-prefix=CONVERT
-# RUN: llvm-gsymutil --address=0x400391 --address=0x4004cd %t.gsym 2>&1 | FileCheck %s --check-prefix=ADDR
-# RUN: llvm-gsymutil --address=0x400391 --address=0x4004cd --verbose %t.gsym 2>&1 | FileCheck %s --check-prefix=ADDRV --dump-input=always
-# RUN: llvm-gsymutil %t.gsym 2>&1 | FileCheck %s --check-prefix=DUMP
+# RUN: gsymutil --convert %t -o %t.gsym 2>&1 | FileCheck %s --check-prefix=CONVERT
+# RUN: gsymutil --address=0x400391 --address=0x4004cd %t.gsym 2>&1 | FileCheck %s --check-prefix=ADDR
+# RUN: gsymutil --address=0x400391 --address=0x4004cd --verbose %t.gsym 2>&1 | FileCheck %s --check-prefix=ADDRV --dump-input=always
+# RUN: gsymutil %t.gsym 2>&1 | FileCheck %s --check-prefix=DUMP
 
 # ADDR: Looking up addresses in "{{.*\.yaml\.tmp\.gsym}}":
 # ADDR: 0x0000000000400391: _init
 # ADDR: 0x00000000004004cd: main @ /tmp/main.cpp:1
 
 # ADDRV: Looking up addresses in "{{.*\.yaml\.tmp\.gsym}}":
 # ADDRV: FunctionInfo for 0x0000000000400391:
 # ADDRV: [0x0000000000400390 - 0x0000000000400390) "_init"

llvm/test/tools/gsymutil/fat-macho-dwarf.yaml

 ## For mach-o files we might have a universal (fat) mach-o file which
 ## complicates the GSYM creation process as we need to be prepared to parse
 ## more than one architecture. If no architectures are specified or more than
 ## one architectures are specified on the command line, then all architectures
 ## will be parsed and each GSYM file will have the architecture name appended
 ## as an extension (.armv7 or .arm64). If a single architecture is specified,
 ## then the GSYM file will be created in the normal location.
 
 # RUN: yaml2obj %s -o %t
-# RUN: llvm-gsymutil --convert %t --arch armv7 -o %t.armv7.gsym 2>&1 | FileCheck %s --check-prefix=ARMV7
-# RUN: llvm-gsymutil --convert %t --arch arm64 -o %t.arm64.gsym 2>&1 | FileCheck %s --check-prefix=ARM64
-# RUN: llvm-gsymutil --convert %t -o %t.gsym 2>&1 | FileCheck %s --check-prefix=FAT
+# RUN: gsymutil --convert %t --arch armv7 -o %t.armv7.gsym 2>&1 | FileCheck %s --check-prefix=ARMV7
+# RUN: gsymutil --convert %t --arch arm64 -o %t.arm64.gsym 2>&1 | FileCheck %s --check-prefix=ARM64
+# RUN: gsymutil --convert %t -o %t.gsym 2>&1 | FileCheck %s --check-prefix=FAT
 
 # ARMV7:      Input file: {{.*\.yaml\.tmp}}
 # ARMV7-NEXT: Output file (armv7): {{.*\.yaml\.tmp\.armv7\.gsym}}
 # ARMV7-NEXT: Loaded 1 functions from DWARF.
 # ARMV7-NEXT: Loaded 0 functions from symbol table.
 # ARMV7-NEXT: Pruned 0 functions, ended with 1 total
 
 # ARM64:      Input file: {{.*\.yaml\.tmp}}

llvm/test/tools/gsymutil/lit.local.cfg

+config.suffixes = ['.test', '.yaml']

llvm/test/tools/gsymutil/mach-dwarf.yaml

 ## Test loading a skinny mach-o file with DWARF. First we make the mach-o file,
 ## from yaml, then we convert the object file to a GSYM file, then we do
 ## lookups on the newly created GSYM, and finally we dump the entire GSYM.
 
 # RUN: yaml2obj %s -o %t
-# RUN: llvm-gsymutil --convert %t -o %t.gsym 2>&1 | FileCheck %s --check-prefix=CONVERT
-# RUN: llvm-gsymutil --address=0 --address=0x100000000 --address=0x100000f90 --address=0x100000faa --address=0x200000000 %t.gsym 2>&1 | FileCheck %s --check-prefix=ADDR
-# RUN: llvm-gsymutil --verbose --address=0x100000000 --address=0x100000f90 --address=0x100000faa %t.gsym 2>&1 | FileCheck %s --check-prefix=ADDRV
-# RUN: llvm-gsymutil %t.gsym 2>&1 | FileCheck %s --check-prefix=DUMP
+# RUN: gsymutil --convert %t -o %t.gsym 2>&1 | FileCheck %s --check-prefix=CONVERT
+# RUN: gsymutil --address=0 --address=0x100000000 --address=0x100000f90 --address=0x100000faa --address=0x200000000 %t.gsym 2>&1 | FileCheck %s --check-prefix=ADDR
+# RUN: gsymutil --verbose --address=0x100000000 --address=0x100000f90 --address=0x100000faa %t.gsym 2>&1 | FileCheck %s --check-prefix=ADDRV
+# RUN: gsymutil %t.gsym 2>&1 | FileCheck %s --check-prefix=DUMP
 
 # CONVERT: Input file: {{.*\.yaml\.tmp}}
 # CONVERT: Output file (x86_64): {{.*\.yaml\.tmp\.gsym}}
 # CONVERT: Loaded 2 functions from DWARF.
 # CONVERT: Loaded 0 functions from symbol table.
 # CONVERT: Pruned 0 functions, ended with 2 total
 
 # ADDR:      Looking up addresses in "{{.*\.yaml\.tmp\.gsym}}":

llvm/tools/gsymutil/CMakeLists.txt

+set(LLVM_LINK_COMPONENTS
+  ${LLVM_TARGETS_TO_BUILD}
+  DebugInfoDWARF
+  DebugInfoGSYM
+  Object
+  Support
+  Target
+  )
+
+add_llvm_tool(gsymutil
+  gsymutil.cpp
+
+  )

llvm/tools/gsymutil/gsymutil.cpp

-//===-- llvm-gsymutil.cpp - GSYM dumping and creation utility for llvm ----===//
+//===-- gsymutil.cpp - GSYM dumping and creation utility for llvm ---------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
static llvm::Error convertFileToGSYM(raw_ostream &OS) {
   return Error::success();
 }
 
 int main(int argc, char const *argv[]) {
   // Print a stack trace if we signal out.
   sys::PrintStackTraceOnErrorSignal(argv[0]);
   PrettyStackTraceProgram X(argc, argv);
   llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
 
-  llvm::InitializeAllTargetInfos();
-  llvm::InitializeAllTargetMCs();
   llvm::InitializeAllTargets();
-  llvm::InitializeAllAsmPrinters();
 
   const char *Overview =
       "A tool for dumping, searching and creating GSYM files.\n\n"
       "Specify one or more GSYM paths as arguments to dump all of the "
       "information in each GSYM file.\n"
       "Specify a single GSYM file along with one or more --lookup options to "
       "lookup addresses within that GSYM file.\n"
       "Use the --convert option to specify a file with option --out-file "
       "option to convert to GSYM format.\n";

llvm/tools/llvm-gsym/CMakeLists.txt

-set(LLVM_LINK_COMPONENTS
-  ${LLVM_TARGETS_TO_BUILD}
-  DebugInfoDWARF
-  DebugInfoGSYM
-  AsmPrinter
-  AllTargetsDescs
-  AllTargetsInfos
-  MC
-  Object
-  Support
-  Target
-  )
-
-add_llvm_tool(llvm-gsymutil
-  llvm-gsymutil.cpp
-
-  DEPENDS
-  intrinsics_gen
-  )

llvm/utils/gn/secondary/llvm/test/BUILD.gn

deps = [
     "//llvm/tools/llvm-cxxmap",
     "//llvm/tools/llvm-diff",
     "//llvm/tools/llvm-dis",
     "//llvm/tools/llvm-dwarfdump",
     "//llvm/tools/llvm-dwp",
     "//llvm/tools/llvm-elfabi",
     "//llvm/tools/llvm-exegesis",
     "//llvm/tools/llvm-extract",
-    "//llvm/tools/llvm-gsym:llvm-gsymutil",
+    "//llvm/tools/gsymutil:gsymutil",
     "//llvm/tools/llvm-ifs",
     "//llvm/tools/llvm-isel-fuzzer",
     "//llvm/tools/llvm-jitlink",
     "//llvm/tools/llvm-link",
     "//llvm/tools/llvm-lipo",
     "//llvm/tools/llvm-lto",
     "//llvm/tools/llvm-lto2",
     "//llvm/tools/llvm-mc",

llvm/utils/gn/secondary/llvm/tools/gsymutil/BUILD.gn

-executable("llvm-gsymutil") {
+executable("gsymutil") {
   deps = [
     "//llvm/lib/CodeGen/AsmPrinter",
     "//llvm/lib/DebugInfo/DWARF",
     "//llvm/lib/DebugInfo/GSYM",
     "//llvm/lib/MC",
     "//llvm/lib/Object",
     "//llvm/lib/Support",
     "//llvm/lib/Target",
     "//llvm/lib/Target:TargetsToBuild",
   ]
   sources = [
     # Make `gn format` not collapse this, for sync_source_lists_from_cmake.py.
-    "llvm-gsymutil.cpp",
+    "gsymutil.cpp",
   ]
 }