Rebase: [NFC] Refactor sources to be buildable in shared mode

Summary:
Moves source files into separate components, and make explicit
component dependency on each other, so LLVM build system knows how to
build BOLT in BUILD_SHARED_LIBS=ON.

Please use the -c merge.renamelimit=230 git option when rebasing your
work on top of this change.

To achieve this, we create a new library to hold core IR files (most
classes beginning with Binary in their names), a new library to hold
Utils, some command line options shared across both RewriteInstance
and core IR files, a new library called Rewrite to hold most classes
concerned with running top-level functions coordinating the binary
rewriting process, and a new library called Profile to hold classes
dealing with profile reading and writing.

To remove the dependency from BinaryContext into X86-specific classes,
we do some refactoring on the BinaryContext constructor to receive a
reference to the specific backend directly from RewriteInstance. Then,
the dependency on X86 or AArch64-specific classes is transfered to the
Rewrite library. We can't have the Core library depend on targets
because targets depend on Core (which would create a cycle).

Files implementing the entry point of a tool are transferred to the
tools/ folder. All header files are transferred to the include/
folder. The src/ folder was renamed to lib/.

(cherry picked from FBD32746834)

Author: rafaelauler

bolt/CMakeLists.txt

@@ -18,12 +18,15 @@ ExternalProject_Add(bolt_rt
   BUILD_ALWAYS True
   )
 
+include_directories( ${BOLT_SOURCE_DIR}/include )
+
 install(CODE "execute_process\(COMMAND \${CMAKE_COMMAND} -DCMAKE_INSTALL_PREFIX=\${CMAKE_INSTALL_PREFIX} -P ${CMAKE_CURRENT_BINARY_DIR}/bolt_rt-bins/cmake_install.cmake \)"
   COMPONENT bolt_rt)
 
 add_llvm_install_targets(install-bolt_rt
   DEPENDS bolt_rt
   COMPONENT bolt_rt)
 
-add_subdirectory(src)
+add_subdirectory(lib)
 add_subdirectory(test)
+add_subdirectory(tools)

bolt/src/BinaryBasicBlock.h bolt/include/bolt/Core/BinaryBasicBlock.h

@@ -13,12 +13,12 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_BINARY_CONTEXT_H
 #define LLVM_TOOLS_LLVM_BOLT_BINARY_CONTEXT_H
 
-#include "BinaryData.h"
-#include "BinarySection.h"
-#include "DebugData.h"
-#include "JumpTable.h"
-#include "MCPlusBuilder.h"
-#include "RuntimeLibs/RuntimeLibrary.h"
+#include "bolt/Core/BinaryData.h"
+#include "bolt/Core/BinarySection.h"
+#include "bolt/Core/DebugData.h"
+#include "bolt/Core/JumpTable.h"
+#include "bolt/Core/MCPlusBuilder.h"
+#include "bolt/RuntimeLibs/RuntimeLibrary.h"
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/StringMap.h"
 #include "llvm/ADT/Triple.h"
@@ -36,8 +36,8 @@
 #include "llvm/MC/MCSectionELF.h"
 #include "llvm/MC/MCSectionMachO.h"
 #include "llvm/MC/MCSymbol.h"
+#include "llvm/MC/TargetRegistry.h"
 #include "llvm/Support/ErrorOr.h"
-#include "llvm/Support/TargetRegistry.h"
 #include "llvm/Support/raw_ostream.h"
 #include <functional>
 #include <map>
@@ -221,6 +221,11 @@ class BinaryContext {
   /// overwritten, but it is okay to re-generate debug info for them.
   std::set<const DWARFUnit *> ProcessedCUs;
 
+  // Setup MCPlus target builder
+  void initializeTarget(std::unique_ptr<MCPlusBuilder> TargetBuilder) {
+    MIB = std::move(TargetBuilder);
+  }
+
   /// Given DWOId returns CU if it exists in DWOCUs.
   Optional<DWARFUnit *> getDWOCU(uint64_t DWOId);
 

bolt/src/BinaryContext.h bolt/include/bolt/Core/BinaryContext.h

@@ -14,14 +14,14 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_BINARY_FUNCTION_H
 #define LLVM_TOOLS_LLVM_BOLT_BINARY_FUNCTION_H
 
-#include "BinaryBasicBlock.h"
-#include "BinaryContext.h"
-#include "BinaryLoop.h"
-#include "BinarySection.h"
-#include "DebugData.h"
-#include "JumpTable.h"
-#include "MCPlus.h"
-#include "NameResolver.h"
+#include "bolt/Core/BinaryBasicBlock.h"
+#include "bolt/Core/BinaryContext.h"
+#include "bolt/Core/BinaryLoop.h"
+#include "bolt/Core/BinarySection.h"
+#include "bolt/Core/DebugData.h"
+#include "bolt/Core/JumpTable.h"
+#include "bolt/Core/MCPlus.h"
+#include "bolt/Utils/NameResolver.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/ADT/iterator.h"
 #include "llvm/BinaryFormat/Dwarf.h"

bolt/src/BinaryData.h bolt/include/bolt/Core/BinaryData.h

@@ -11,8 +11,8 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_BINARY_SECTION_H
 #define LLVM_TOOLS_LLVM_BOLT_BINARY_SECTION_H
 
-#include "DebugData.h"
-#include "Relocation.h"
+#include "bolt/Core/DebugData.h"
+#include "bolt/Core/Relocation.h"
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/STLExtras.h"
 #include "llvm/BinaryFormat/ELF.h"

bolt/src/BinaryEmitter.h bolt/include/bolt/Core/BinaryEmitter.h

@@ -11,7 +11,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_JUMP_TABLE_H
 #define LLVM_TOOLS_LLVM_BOLT_JUMP_TABLE_H
 
-#include "BinaryData.h"
+#include "bolt/Core/BinaryData.h"
 #include <map>
 #include <vector>
 

bolt/src/BinaryFunction.h bolt/include/bolt/Core/BinaryFunction.h

@@ -13,8 +13,8 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_MCPLUSBUILDER_H
 #define LLVM_TOOLS_LLVM_BOLT_MCPLUSBUILDER_H
 
-#include "MCPlus.h"
-#include "Relocation.h"
+#include "bolt/Core/MCPlus.h"
+#include "bolt/Core/Relocation.h"
 #include "llvm/ADT/ArrayRef.h"
 #include "llvm/ADT/BitVector.h"
 #include "llvm/ADT/Optional.h"

bolt/src/BinaryLoop.h bolt/include/bolt/Core/BinaryLoop.h

@@ -1,4 +1,4 @@
-//===-- ParallelUtilities.h - ----------------------------------*- C++ -*-===//
+//===-- ParallelUtilities.h - -----------------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -15,7 +15,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PARALLEL_UTILITIES_H
 #define LLVM_TOOLS_LLVM_BOLT_PARALLEL_UTILITIES_H
 
-#include "MCPlusBuilder.h"
+#include "bolt/Core/MCPlusBuilder.h"
 #include "llvm/Support/CommandLine.h"
 
 using namespace llvm;

bolt/src/BinarySection.h bolt/include/bolt/Core/BinarySection.h

@@ -12,7 +12,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_ADRRELAXATIONPASS_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_ADRRELAXATIONPASS_H
 
-#include "BinaryPasses.h"
+#include "bolt/Passes/BinaryPasses.h"
 
 // This pass replaces AArch64 non-local ADR instructions
 // with ADRP + ADD due to small offset range of ADR instruction

bolt/src/DebugData.h bolt/include/bolt/Core/DebugData.h

@@ -11,7 +11,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_ALIGNER_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_ALIGNER_H
 
-#include "BinaryPasses.h"
+#include "bolt/Passes/BinaryPasses.h"
 
 namespace llvm {
 namespace bolt {

bolt/src/DynoStats.h bolt/include/bolt/Core/DynoStats.h

@@ -11,7 +11,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_FRAMEDEFRAG_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_FRAMEDEFRAG_H
 
-#include "BinaryPasses.h"
+#include "bolt/Passes/BinaryPasses.h"
 
 namespace llvm {
 namespace bolt {

bolt/src/Exceptions.h bolt/include/bolt/Core/Exceptions.h

@@ -11,11 +11,10 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_BINARY_FUNCTION_CALLGRAPH_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_BINARY_FUNCTION_CALLGRAPH_H
 
-#include "CallGraph.h"
-
-#include <unordered_map>
-#include <functional>
+#include "bolt/Passes/CallGraph.h"
 #include <deque>
+#include <functional>
+#include <unordered_map>
 
 namespace llvm {
 namespace bolt {

bolt/src/JumpTable.h bolt/include/bolt/Core/JumpTable.h

@@ -13,9 +13,9 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_BINARY_PASSES_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_BINARY_PASSES_H
 
-#include "BinaryContext.h"
-#include "BinaryFunction.h"
-#include "DynoStats.h"
+#include "bolt/Core/BinaryContext.h"
+#include "bolt/Core/BinaryFunction.h"
+#include "bolt/Core/DynoStats.h"
 #include "llvm/Support/CommandLine.h"
 #include <atomic>
 #include <map>

bolt/src/MCPlus.h bolt/include/bolt/Core/MCPlus.h

@@ -11,8 +11,8 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_DATAFLOWANALYSIS_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_DATAFLOWANALYSIS_H
 
-#include "BinaryContext.h"
-#include "BinaryFunction.h"
+#include "bolt/Core/BinaryContext.h"
+#include "bolt/Core/BinaryFunction.h"
 #include "llvm/Support/Errc.h"
 #include <queue>
 

bolt/src/MCPlusBuilder.h bolt/include/bolt/Core/MCPlusBuilder.h

@@ -11,13 +11,13 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_DATAFLOWINFOMANAGER_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_DATAFLOWINFOMANAGER_H
 
-#include "DominatorAnalysis.h"
-#include "LivenessAnalysis.h"
-#include "ReachingDefOrUse.h"
-#include "ReachingInsns.h"
-#include "StackAllocationAnalysis.h"
-#include "StackPointerTracking.h"
-#include "StackReachingUses.h"
+#include "bolt/Passes/DominatorAnalysis.h"
+#include "bolt/Passes/LivenessAnalysis.h"
+#include "bolt/Passes/ReachingDefOrUse.h"
+#include "bolt/Passes/ReachingInsns.h"
+#include "bolt/Passes/StackAllocationAnalysis.h"
+#include "bolt/Passes/StackPointerTracking.h"
+#include "bolt/Passes/StackReachingUses.h"
 
 namespace llvm {
 namespace bolt {

bolt/src/ParallelUtilities.h bolt/include/bolt/Core/ParallelUtilities.h

@@ -11,7 +11,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_DOMINATORANALYSIS_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_DOMINATORANALYSIS_H
 
-#include "DataflowAnalysis.h"
+#include "bolt/Passes/DataflowAnalysis.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/Timer.h"
 

bolt/src/Relocation.h bolt/include/bolt/Core/Relocation.h

@@ -11,7 +11,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_FRAMEANALYSIS_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_FRAMEANALYSIS_H
 
-#include "StackPointerTracking.h"
+#include "bolt/Passes/StackPointerTracking.h"
 
 namespace llvm {
 namespace bolt {

bolt/src/Passes/ADRRelaxationPass.h bolt/include/bolt/Passes/ADRRelaxationPass.h

@@ -11,7 +11,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_FRAMEOPTIMIZER_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_FRAMEOPTIMIZER_H
 
-#include "BinaryPasses.h"
+#include "bolt/Passes/BinaryPasses.h"
 
 namespace llvm {
 namespace bolt {

bolt/src/Passes/Aligner.h bolt/include/bolt/Passes/Aligner.h

@@ -36,7 +36,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_HFSORT_H
 #define LLVM_TOOLS_LLVM_BOLT_HFSORT_H
 
-#include "CallGraph.h"
+#include "bolt/Passes/CallGraph.h"
 
 #include <string>
 #include <vector>

bolt/src/Passes/AllocCombiner.h bolt/include/bolt/Passes/AllocCombiner.h

@@ -11,8 +11,8 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_IDENTICAL_CODE_FOLDING_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_IDENTICAL_CODE_FOLDING_H
 
-#include "BinaryFunction.h"
-#include "Passes/BinaryPasses.h"
+#include "bolt/Core/BinaryFunction.h"
+#include "bolt/Passes/BinaryPasses.h"
 
 namespace llvm {
 namespace bolt {

bolt/src/Passes/BinaryFunctionCallGraph.h bolt/include/bolt/Passes/BinaryFunctionCallGraph.h

@@ -13,7 +13,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_INDIRECT_CALL_PROMOTION_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_INDIRECT_CALL_PROMOTION_H
 
-#include "BinaryPasses.h"
+#include "bolt/Passes/BinaryPasses.h"
 
 namespace llvm {
 namespace bolt {

bolt/src/Passes/BinaryPasses.h bolt/include/bolt/Passes/BinaryPasses.h

@@ -13,7 +13,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_INLINER_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_INLINER_H
 
-#include "BinaryPasses.h"
+#include "bolt/Passes/BinaryPasses.h"
 
 namespace llvm {
 namespace bolt {

bolt/src/CacheMetrics.h bolt/include/bolt/Passes/CacheMetrics.h

@@ -16,8 +16,8 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_INSTRUMENTATION_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_INSTRUMENTATION_H
 
-#include "BinaryPasses.h"
-#include "Passes/InstrumentationSummary.h"
+#include "bolt/Passes/BinaryPasses.h"
+#include "bolt/Passes/InstrumentationSummary.h"
 
 namespace llvm {
 namespace bolt {

bolt/src/Passes/CallGraph.h bolt/include/bolt/Passes/CallGraph.h

@@ -13,7 +13,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_JT_FOOTPRINT_REDUCTION_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_JT_FOOTPRINT_REDUCTION_H
 
-#include "BinaryPasses.h"
+#include "bolt/Passes/BinaryPasses.h"
 
 namespace llvm {
 namespace bolt {

bolt/src/Passes/CallGraphWalker.h bolt/include/bolt/Passes/CallGraphWalker.h

@@ -11,8 +11,8 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_LIVENESSANALYSIS_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_LIVENESSANALYSIS_H
 
-#include "DataflowAnalysis.h"
-#include "RegAnalysis.h"
+#include "bolt/Passes/DataflowAnalysis.h"
+#include "bolt/Passes/RegAnalysis.h"
 #include "llvm/Support/CommandLine.h"
 
 namespace opts {

bolt/src/Passes/DataflowAnalysis.h bolt/include/bolt/Passes/DataflowAnalysis.h

@@ -10,7 +10,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_LONGJMP_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_LONGJMP_H
 
-#include "BinaryPasses.h"
+#include "bolt/Passes/BinaryPasses.h"
 
 namespace llvm {
 namespace bolt {

bolt/src/Passes/DataflowInfoManager.h bolt/include/bolt/Passes/DataflowInfoManager.h

@@ -11,7 +11,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_LOOPINVERSION_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_LOOPINVERSION_H
 
-#include "BinaryPasses.h"
+#include "bolt/Passes/BinaryPasses.h"
 
 // This pass founds cases when BBs have layout:
 // #BB0:

bolt/src/Passes/DominatorAnalysis.h bolt/include/bolt/Passes/DominatorAnalysis.h

@@ -11,7 +11,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_PLTCALL_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_PLTCALL_H
 
-#include "BinaryPasses.h"
+#include "bolt/Passes/BinaryPasses.h"
 
 namespace llvm {
 namespace bolt {

bolt/src/Passes/FrameAnalysis.h bolt/include/bolt/Passes/FrameAnalysis.h

@@ -1,4 +1,4 @@
-//===--- Passes/PatchEntries.h - pass for patching function entries -------===//
+//===--- PatchEntries.h - pass for patching function entries --------------===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -13,7 +13,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_PATCH_ENTRIES_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_PATCH_ENTRIES_H
 
-#include "Passes/BinaryPasses.h"
+#include "bolt/Passes/BinaryPasses.h"
 
 namespace llvm {
 namespace bolt {

bolt/src/Passes/FrameOptimizer.h bolt/include/bolt/Passes/FrameOptimizer.h

@@ -11,8 +11,8 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_REACHINGDEFORUSE_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_REACHINGDEFORUSE_H
 
-#include "DataflowAnalysis.h"
-#include "RegAnalysis.h"
+#include "bolt/Passes/DataflowAnalysis.h"
+#include "bolt/Passes/RegAnalysis.h"
 #include "llvm/ADT/Optional.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/Timer.h"

bolt/src/Passes/HFSort.h bolt/include/bolt/Passes/HFSort.h

@@ -11,7 +11,7 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_REACHINGINSNS_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_REACHINGINSNS_H
 
-#include "DataflowAnalysis.h"
+#include "bolt/Passes/DataflowAnalysis.h"
 #include "llvm/Support/CommandLine.h"
 #include "llvm/Support/Timer.h"
 

bolt/src/Passes/IdenticalCodeFolding.h bolt/include/bolt/Passes/IdenticalCodeFolding.h

@@ -10,8 +10,8 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_REGREASSIGN_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_REGREASSIGN_H
 
-#include "BinaryPasses.h"
-#include "RegAnalysis.h"
+#include "bolt/Passes/BinaryPasses.h"
+#include "bolt/Passes/RegAnalysis.h"
 
 namespace llvm {
 namespace bolt {

bolt/src/Passes/IndirectCallPromotion.h bolt/include/bolt/Passes/IndirectCallPromotion.h

@@ -13,9 +13,9 @@
 #ifndef LLVM_TOOLS_LLVM_BOLT_PASSES_REORDER_ALGORITHM_H
 #define LLVM_TOOLS_LLVM_BOLT_PASSES_REORDER_ALGORITHM_H
 
-#include "BinaryFunction.h"
-#include <unordered_map>
+#include "bolt/Core/BinaryFunction.h"
 #include <memory>
+#include <unordered_map>
 #include <vector>