[DebugInfo] Move the SymbolizableObjectFile header to include/llvm.

[snehasish]

Summary

This change moves the SymbolizableObjectFile header to
include/llvm/DebugInfo/Symbolize. Making this header available to other
llvm libraries simplifies use cases where implicit caching, multiple
platform support and other features of the Symbolizer class are not
required. This also makes the dependent libraries easier to unit test
by having mocks which derive from SymbolizableModule.

[tejohnson]

lgtm

llvm/include/llvm/DebugInfo/Symbolize/SymbolizableObjectFile.h

95

Suggest removing the formatting change so it is clear this is just a file move.

[snehasish]

Revert formatting change to the header.

[MaskRay]

@dblaikie

Moving classes from .cpp to .h usually requires some mechanism to prevent folks (who are making refactorings) from undoing the change.
This can sometimes by done by having a unit test.

[dblaikie]

In D116781#3228744, @MaskRay wrote:

@dblaikie

Moving classes from .cpp to .h usually requires some mechanism to prevent folks (who are making refactorings) from undoing the change.
This can sometimes by done by having a unit test.

If the new use is going to be out-of-tree, that's generally a good idea - but in this case the new use is in-tree in subsequent patches in this patch series I think, so I think it's OK as-is? (once the rest of the patch series is in, it'll be clear that folding this back into the .cpp won't be feasible since there'll be multiple callers.

[MaskRay]

Ah, I missed that this is for in-tree change. Then this is fine to me.

D116782 does not seem to be related to this patch, so the relation may need to be removed.

[snehasish]

Thanks for taking a look @MaskRay and @dblaikie. I've updated the child revision to point to the correct dependent patch.

llvm/include/llvm/DebugInfo/Symbolize/SymbolizableObjectFile.h

bool operator<(const SymbolDesc &RHS) const {
       return Addr != RHS.Addr ? Addr < RHS.Addr : Size < RHS.Size;
     }
   };
   std::vector<SymbolDesc> Symbols;
   // (index, filename) pairs of ELF STT_FILE symbols.
   std::vector<std::pair<uint32_t, StringRef>> FileSymbols;
 
   SymbolizableObjectFile(const object::ObjectFile *Obj,
-                         std::unique_ptr<DIContext> DICtx,
-                         bool UntagAddresses);
+                         std::unique_ptr<DIContext> DICtx, bool UntagAddresses);
 };
 
 } // end namespace symbolize
 
 } // end namespace llvm
 
 #endif // LLVM_LIB_DEBUGINFO_SYMBOLIZE_SYMBOLIZABLEOBJECTFILE_H

llvm/lib/DebugInfo/Symbolize/SymbolizableObjectFile.cpp

 //===- SymbolizableObjectFile.cpp -----------------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 //
 // Implementation of SymbolizableObjectFile class.
 //
 //===----------------------------------------------------------------------===//
 
-#include "SymbolizableObjectFile.h"
+#include "llvm/DebugInfo/Symbolize/SymbolizableObjectFile.h"
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/ADT/Triple.h"
 #include "llvm/BinaryFormat/COFF.h"
 #include "llvm/DebugInfo/DWARF/DWARFContext.h"
 #include "llvm/Object/COFF.h"
 #include "llvm/Object/ELFObjectFile.h"
 #include "llvm/Object/ObjectFile.h"
 #include "llvm/Object/SymbolSize.h"

llvm/lib/DebugInfo/Symbolize/Symbolize.cpp

 //===-- LLVMSymbolize.cpp -------------------------------------------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 //
 //===----------------------------------------------------------------------===//
 //
 // Implementation for LLVM symbolization library.
 //
 //===----------------------------------------------------------------------===//
 
 #include "llvm/DebugInfo/Symbolize/Symbolize.h"
 
-#include "SymbolizableObjectFile.h"
-
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/BinaryFormat/COFF.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/DebugInfo/Symbolize/SymbolizableObjectFile.h"
 #include "llvm/Debuginfod/Debuginfod.h"
 #include "llvm/Demangle/Demangle.h"
 #include "llvm/Object/COFF.h"
 #include "llvm/Object/MachO.h"
 #include "llvm/Object/MachOUniversal.h"
 #include "llvm/Support/CRC.h"
 #include "llvm/Support/Casting.h"
 #include "llvm/Support/Compression.h"