HWInstanceGraph.h

Go to the documentation of this file.

//===- InstanceGraph.h - Instance graph -------------------------*- 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 HW InstanceGraph, which is similar to a CallGraph.
//
//===----------------------------------------------------------------------===//
 
#ifndef CIRCT_DIALECT_HW_HWINSTANCEGRAPH_H
#define CIRCT_DIALECT_HW_HWINSTANCEGRAPH_H
 
#include "circt/Dialect/HW/HWOpInterfaces.h"
#include "circt/Support/InstanceGraph.h"
 
namespace circt {
namespace hw {
 
/// HW-specific instance graph with a virtual entry node linking to
/// all publicly visible modules.
class InstanceGraph : public igraph::InstanceGraph {
public:
  InstanceGraph(Operation *operation);
 
  /// Return the entry node linking to all public modules.
  igraph::InstanceGraphNode *getTopLevelNode() override { return &entry; }
 
  /// Adds a module, updating links to entry.
  igraph::InstanceGraphNode *addHWModule(HWModuleLike module);
 
  /// Erases a module, updating links to entry.
  void erase(igraph::InstanceGraphNode *node) override;
 
private:
  using igraph::InstanceGraph::addModule;
  igraph::InstanceGraphNode entry;
};
 
} // namespace hw
} // namespace circt
 
// Specialisation for the HW instance graph.
template <>
struct llvm::GraphTraits<circt::hw::InstanceGraph *>
    : public llvm::GraphTraits<circt::igraph::InstanceGraph *> {};
 
template <>
struct llvm::DOTGraphTraits<circt::hw::InstanceGraph *>
    : public llvm::DOTGraphTraits<circt::igraph::InstanceGraph *> {
  using llvm::DOTGraphTraits<circt::igraph::InstanceGraph *>::DOTGraphTraits;
};
 
#endif // CIRCT_DIALECT_HW_HWINSTANCEGRAPH_H