Move parts of llvm-symbolizer tool into LLVMSymbolize library.

[samsonov]

Summary

See http://lists.llvm.org/pipermail/llvm-dev/2015-October/091624.html

[echristo]

Couple of inline comments otherwise it looks fine to me.

Rafael: You had objected originally about this, do you still mind?

-eric

lib/DebugInfo/Symbolize/Symbolize.cpp

14

Should be down with the other headers?

49

Please do :)

[samsonov]

Thanks!

lib/DebugInfo/Symbolize/Symbolize.cpp

14

http://llvm.org/docs/CodingStandards.html#main-module-header

49

I'll do it in a follow-up changes: for now LLVMSymbolizer doesn't know how to return errors to the user, and it would take some refactoring to achieve that - let's keep this change a relatively straightforward code move.

[aizatsky]

Thanks, Alexey. I'm definitely going to use it in the improved version of sanitizer coverage tool.

include/llvm/DebugInfo/Symbolize/Symbolize.h

-//===-- LLVMSymbolize.h ----------------------------------------- C++ -----===//
+//===-- Symbolize.h --------------------------------------------- C++ -----===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 // Header for LLVM symbolization library.
 //
 //===----------------------------------------------------------------------===//
-#ifndef LLVM_TOOLS_LLVM_SYMBOLIZER_LLVMSYMBOLIZE_H
-#define LLVM_TOOLS_LLVM_SYMBOLIZER_LLVMSYMBOLIZE_H
+#ifndef LLVM_DEBUGINFO_SYMBOLIZE_SYMBOLIZE_H
+#define LLVM_DEBUGINFO_SYMBOLIZE_SYMBOLIZE_H
 
 #include "llvm/ADT/SmallVector.h"
 #include "llvm/DebugInfo/DIContext.h"
 #include "llvm/Object/MachOUniversal.h"
 #include "llvm/Object/ObjectFile.h"
 #include "llvm/Support/DataExtractor.h"
 #include "llvm/Support/MemoryBuffer.h"
 #include <map>
 #include <memory>
 #include <string>
 
 namespace llvm {
-
-typedef DILineInfoSpecifier::FunctionNameKind FunctionNameKind;
-using namespace object;
-
 namespace symbolize {
 
+using namespace object;
+using FunctionNameKind = DILineInfoSpecifier::FunctionNameKind;
 class ModuleInfo;
 
 class LLVMSymbolizer {
 public:
   struct Options {
     FunctionNameKind PrintFunctions;
     bool UseSymbolTable : 1;
     bool PrintInlining : 1;

lib/DebugInfo/CMakeLists.txt

-
 add_subdirectory(DWARF)
 add_subdirectory(PDB)
-
+add_subdirectory(Symbolize)

lib/DebugInfo/LLVMBuild.txt

 ;
 ; For more information on the LLVMBuild system, please see:
 ;
 ;   http://llvm.org/docs/LLVMBuild.html
 ;
 ;===------------------------------------------------------------------------===;
 
 [common]
-subdirectories = DWARF PDB
+subdirectories = DWARF PDB Symbolize
 
 [component_0]
 type = Group
 name = DebugInfo
 parent = $ROOT

lib/DebugInfo/Makefile

 ##===- lib/DebugInfo/Makefile ------------------------------*- Makefile -*-===##
 #
 #                     The LLVM Compiler Infrastructure
 #
 # This file is distributed under the University of Illinois Open Source
 # License. See LICENSE.TXT for details.
 #
 ##===----------------------------------------------------------------------===##
 LEVEL = ../..
 
 include $(LEVEL)/Makefile.config
 
-PARALLEL_DIRS := DWARF PDB
+PARALLEL_DIRS := DWARF PDB Symbolize
 
-include $(LEVEL)/Makefile.common
+include $(LEVEL)/Makefile.common
 

lib/DebugInfo/Symbolize/CMakeLists.txt

+add_llvm_library(LLVMSymbolize
+  Symbolize.cpp
+
+  ADDITIONAL_HEADER_DIRS
+  ${LLVM_MAIN_INCLUDE_DIR}/llvm/DebugInfo/Symbolize
+  )

lib/DebugInfo/Symbolize/LLVMBuild.txt

-;===- ./lib/DebugInfo/LLVMBuild.txt ----------------------------*- Conf -*--===;
+;===- ./lib/DebugInfo/Symbolize/LLVMBuild.txt ------------------*- Conf -*--===;
 ;
 ;                     The LLVM Compiler Infrastructure
 ;
 ; This file is distributed under the University of Illinois Open Source
 ; License. See LICENSE.TXT for details.
 ;
 ;===------------------------------------------------------------------------===;
 ;
 ; This is an LLVMBuild description file for the components in this subdirectory.
 ;
 ; For more information on the LLVMBuild system, please see:
 ;
 ;   http://llvm.org/docs/LLVMBuild.html
 ;
 ;===------------------------------------------------------------------------===;
 
-[common]
-subdirectories = DWARF PDB
-
 [component_0]
-type = Group
-name = DebugInfo
-parent = $ROOT
+type = Library
+name = Symbolize
+parent = DebugInfo
+required_libraries = DebugInfoDWARF DebugInfoPDB Object Support

lib/DebugInfo/Symbolize/Makefile

-##===- lib/DebugInfo/Makefile ------------------------------*- Makefile -*-===##
+##===- lib/DebugInfo/Symbolize/Makefile --------------------*- Makefile -*-===##
 #
 #                     The LLVM Compiler Infrastructure
 #
 # This file is distributed under the University of Illinois Open Source
 # License. See LICENSE.TXT for details.
 #
 ##===----------------------------------------------------------------------===##
-LEVEL = ../..
 
-include $(LEVEL)/Makefile.config
+LEVEL = ../../..
+LIBRARYNAME = LLVMSymbolize
+BUILD_ARCHIVE := 1
 
-PARALLEL_DIRS := DWARF PDB
+include $(LEVEL)/Makefile.common
 
-include $(LEVEL)/Makefile.common
 

lib/DebugInfo/Symbolize/Symbolize.cpp

 //===-- LLVMSymbolize.cpp -------------------------------------------------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 //
 // Implementation for LLVM symbolization library.
 //
 //===----------------------------------------------------------------------===//
 
-#include "LLVMSymbolize.h"
+#include "llvm/DebugInfo/Symbolize/Symbolize.h"
+
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/Config/config.h"
 #include "llvm/DebugInfo/DWARF/DWARFContext.h"
 #include "llvm/DebugInfo/PDB/PDB.h"
 #include "llvm/DebugInfo/PDB/PDBContext.h"
 #include "llvm/Object/ELFObjectFile.h"
 #include "llvm/Object/MachO.h"
 #include "llvm/Object/SymbolSize.h"

 #ifdef IMAGE_FILE_MACHINE_I386
 #undef IMAGE_FILE_MACHINE_I386
 #endif
 #endif
 
 namespace llvm {
 namespace symbolize {
 
+// FIXME: Move this to llvm-symbolizer tool.
 static bool error(std::error_code ec) {
   if (!ec)
     return false;
   errs() << "LLVMSymbolizer: error reading file: " << ec.message() << ".\n";
   return true;
 }
 
 static DILineInfoSpecifier

tools/llvm-symbolizer/CMakeLists.txt

 # FIXME: As we plan to execute llvm-symbolizer binary from compiler-rt
 # libraries, it has to be compiled for all supported targets (x86_64, i386 etc).
 # This means that we need LLVM libraries to be compiled for these
 # targets as well. Currently, there is no support for such a build strategy.
 
 set(LLVM_LINK_COMPONENTS
   DebugInfoDWARF
   DebugInfoPDB
   Object
   Support
+  Symbolize
   )
 
 add_llvm_tool(llvm-symbolizer
-  LLVMSymbolize.cpp
   llvm-symbolizer.cpp
   )

tools/llvm-symbolizer/Makefile

 ##===- tools/llvm-symbolizer/Makefile ----------------------*- Makefile -*-===##
 # 
 #                     The LLVM Compiler Infrastructure
 #
 # This file is distributed under the University of Illinois Open Source
 # License. See LICENSE.TXT for details.
 # 
 ##===----------------------------------------------------------------------===##
 
 LEVEL := ../..
 TOOLNAME := llvm-symbolizer
-LINK_COMPONENTS := DebugInfoDWARF DebugInfoPDB Object
+LINK_COMPONENTS := DebugInfoDWARF DebugInfoPDB Object Support Symbolize
 
 # This tool has no plugins, optimize startup time.
 TOOL_NO_EXPORTS := 1
 
 include $(LEVEL)/Makefile.common

tools/llvm-symbolizer/llvm-symbolizer.cpp

 // This utility works much like "addr2line". It is able of transforming
 // tuples (module name, module offset) to code locations (function name,
 // file, line number, column number). It is targeted for compiler-rt tools
 // (especially AddressSanitizer and ThreadSanitizer) that can use it
 // to symbolize stack traces in their error reports.
 //
 //===----------------------------------------------------------------------===//
 
-#include "LLVMSymbolize.h"
 #include "llvm/ADT/StringRef.h"
+#include "llvm/DebugInfo/Symbolize/Symbolize.h"
 #include "llvm/Support/COM.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/Debug.h"
 #include "llvm/Support/FileSystem.h"
 #include "llvm/Support/ManagedStatic.h"
 #include "llvm/Support/Path.h"
 #include "llvm/Support/PrettyStackTrace.h"
 #include "llvm/Support/Signals.h"