[BOLT][NFC] Move BinaryDominatorTree out of BinaryLoop header

[Amir]

Summary

Split up the BinaryLoop header and move BinaryDominatorTree into its own header,
preparing it for a standalone use.

[rafauler]

LGTM

bolt/include/bolt/Core/BinaryDomTree.h

-//===- bolt/Core/BinaryLoop.h - Loop info at low-level IR -------*- C++ -*-===//
+//==- bolt/Core/BinaryDomTree.h - Dominator Tree at low-level IR -*- C++ -*-==//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 //
-// This file defines the BinaryLoop class, which represents a loop in the
-// CFG of a binary function, and the BinaryLoopInfo class, which stores
-// information about all the loops of a binary function.
+// This file defines the BinaryDomTree class, which represents a dominator tree
+// in the CFG of a binary function.
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef BOLT_CORE_BINARY_LOOP_H
-#define BOLT_CORE_BINARY_LOOP_H
+#ifndef BOLT_CORE_BINARY_DOMTREE_H
+#define BOLT_CORE_BINARY_DOMTREE_H
 
-#include "llvm/ADT/DepthFirstIterator.h"
-#include "llvm/Analysis/LoopInfoImpl.h"
 #include "llvm/Support/GenericDomTreeConstruction.h"
 
 namespace llvm {
 namespace bolt {
 
 class BinaryBasicBlock;
-
 using BinaryDomTreeNode = DomTreeNodeBase<BinaryBasicBlock>;
 using BinaryDominatorTree = DomTreeBase<BinaryBasicBlock>;
 
-class BinaryLoop : public LoopBase<BinaryBasicBlock, BinaryLoop> {
-public:
-  BinaryLoop() : LoopBase<BinaryBasicBlock, BinaryLoop>() {}
-
-  // The total count of all the back edges of this loop.
-  uint64_t TotalBackEdgeCount{0};
-
-  // The times the loop is entered from outside.
-  uint64_t EntryCount{0};
-
-  // The times the loop is exited.
-  uint64_t ExitCount{0};
-
-  // Most of the public interface is provided by LoopBase.
-
-protected:
-  friend class LoopInfoBase<BinaryBasicBlock, BinaryLoop>;
-  explicit BinaryLoop(BinaryBasicBlock *BB)
-      : LoopBase<BinaryBasicBlock, BinaryLoop>(BB) {}
-};
-
-class BinaryLoopInfo : public LoopInfoBase<BinaryBasicBlock, BinaryLoop> {
-public:
-  BinaryLoopInfo() {}
-
-  unsigned OuterLoops{0};
-  unsigned TotalLoops{0};
-  unsigned MaximumDepth{0};
-
-  // Most of the public interface is provided by LoopInfoBase.
-};
-
 } // namespace bolt
-} // namespace llvm
-
-namespace llvm {
 
 // BinaryDominatorTree GraphTraits specializations.
 template <>
 struct GraphTraits<bolt::BinaryDomTreeNode *>
     : public DomTreeGraphTraitsBase<bolt::BinaryDomTreeNode,
                                     bolt::BinaryDomTreeNode::iterator> {};
 
 template <>

bolt/include/bolt/Core/BinaryLoop.h

 //===- bolt/Core/BinaryLoop.h - Loop info at low-level IR -------*- C++ -*-===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 //
 // This file defines the BinaryLoop class, which represents a loop in the
 // CFG of a binary function, and the BinaryLoopInfo class, which stores
 // information about all the loops of a binary function.
 //
 //===----------------------------------------------------------------------===//
 
 #ifndef BOLT_CORE_BINARY_LOOP_H
 #define BOLT_CORE_BINARY_LOOP_H
 
-#include "llvm/ADT/DepthFirstIterator.h"
 #include "llvm/Analysis/LoopInfoImpl.h"
-#include "llvm/Support/GenericDomTreeConstruction.h"
 
 namespace llvm {
 namespace bolt {
 
 class BinaryBasicBlock;
 
-using BinaryDomTreeNode = DomTreeNodeBase<BinaryBasicBlock>;
-using BinaryDominatorTree = DomTreeBase<BinaryBasicBlock>;
-
 class BinaryLoop : public LoopBase<BinaryBasicBlock, BinaryLoop> {
 public:
   BinaryLoop() : LoopBase<BinaryBasicBlock, BinaryLoop>() {}
 
   // The total count of all the back edges of this loop.
   uint64_t TotalBackEdgeCount{0};
 
   // The times the loop is entered from outside.
public:
   unsigned MaximumDepth{0};
 
   // Most of the public interface is provided by LoopInfoBase.
 };
 
 } // namespace bolt
 } // namespace llvm
 
-namespace llvm {
-
-// BinaryDominatorTree GraphTraits specializations.
-template <>
-struct GraphTraits<bolt::BinaryDomTreeNode *>
-    : public DomTreeGraphTraitsBase<bolt::BinaryDomTreeNode,
-                                    bolt::BinaryDomTreeNode::iterator> {};
-
-template <>
-struct GraphTraits<const bolt::BinaryDomTreeNode *>
-    : public DomTreeGraphTraitsBase<const bolt::BinaryDomTreeNode,
-                                    bolt::BinaryDomTreeNode::const_iterator> {};
-
-template <>
-struct GraphTraits<bolt::BinaryDominatorTree *>
-    : public GraphTraits<bolt::BinaryDomTreeNode *> {
-  static NodeRef getEntryNode(bolt::BinaryDominatorTree *DT) {
-    return DT->getRootNode();
-  }
-
-  static nodes_iterator nodes_begin(bolt::BinaryDominatorTree *N) {
-    return df_begin(getEntryNode(N));
-  }
-
-  static nodes_iterator nodes_end(bolt::BinaryDominatorTree *N) {
-    return df_end(getEntryNode(N));
-  }
-};
-
-} // namespace llvm
-
 #endif

bolt/lib/Core/BinaryFunction.cpp

 //===- bolt/Core/BinaryFunction.cpp - Low-level function ------------------===//
 //
 // 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
 //
 //===----------------------------------------------------------------------===//
 //
 // This file implements the BinaryFunction class.
 //
 //===----------------------------------------------------------------------===//
 
 #include "bolt/Core/BinaryFunction.h"
 #include "bolt/Core/BinaryBasicBlock.h"
+#include "bolt/Core/BinaryDomTree.h"
 #include "bolt/Core/DynoStats.h"
 #include "bolt/Core/MCPlusBuilder.h"
 #include "bolt/Utils/NameResolver.h"
 #include "bolt/Utils/NameShortener.h"
 #include "bolt/Utils/Utils.h"
 #include "llvm/ADT/SmallSet.h"
 #include "llvm/ADT/StringRef.h"
 #include "llvm/ADT/edit_distance.h"