[Infra] Cleaned Up Header Files in Route Folder

Continued the header file cleanup effort in the route folder.

Some of these files may need to be revisited in more detail, but got
some of the major header include issues.

Found that some definitions were in the wrong place, so moved them to
the correct implementation file.

Author: AlexandreSinger

vpr/src/route/NestedNetlistRouter.h

@@ -2,6 +2,7 @@
 
 /** @file Nested parallel case for NetlistRouter */
 #include "netlist_routers.h"
+#include "partition_tree.h"
 #include "vtr_optional.h"
 #include "vtr_thread_pool.h"
 #include "serial_connection_router.h"

vpr/src/route/SerialNetlistRouter.tpp

@@ -3,7 +3,9 @@
 /** @file Templated implementations for SerialNetlistRouter */
 
 #include "SerialNetlistRouter.h"
+#include "partition_tree.h"
 #include "route_net.h"
+#include "route_utils.h"
 #include "vtr_time.h"
 
 template<typename HeapType>

vpr/src/route/annotate_routing.cpp

@@ -3,13 +3,12 @@
  * from VPR to OpenFPGA. (i.e. create a mapping from RRNodeIds to ClusterNetIds)
  *******************************************************************/
 
+#include "describe_rr_node.h"
 #include "vpr_error.h"
-#include "vtr_assert.h"
 #include "vtr_time.h"
 #include "vtr_log.h"
 
 #include "route_utils.h"
-#include "rr_graph.h"
 
 #include "annotate_routing.h"
 

vpr/src/route/annotate_routing.h

@@ -1,7 +1,13 @@
 #ifndef ANNOTATE_ROUTING_H
 #define ANNOTATE_ROUTING_H
 
-#include "vpr_context.h"
+#include "clustered_netlist_fwd.h"
+#include "rr_graph_fwd.h"
+#include "vtr_vector.h"
+
+struct AtomContext;
+struct ClusteringContext;
+struct DeviceContext;
 
 /********************************************************************
  * Create a mapping between each rr_node and its mapped nets

vpr/src/route/check_route.h

@@ -1,8 +1,8 @@
 #ifndef VPR_CHECK_ROUTE_H
 #define VPR_CHECK_ROUTE_H
-#include "physical_types.h"
+
+#include "netlist.h"
 #include "vpr_types.h"
-#include "route_common.h"
 
 void check_route(const Netlist<>& net_list,
                  enum e_route_type route_type,

vpr/src/route/connection_based_routing.h

@@ -1,10 +1,10 @@
 #pragma once
+
 #include <vector>
 #include <unordered_map>
-#include "route_tree_fwd.h"
-#include "vpr_types.h"
 #include "timing_info.h"
 #include "vpr_net_pins_matrix.h"
+#include "connection_based_routing_fwd.h"
 
 /***************** Connection based rerouting **********************/
 // encompasses both incremental rerouting through route tree pruning

vpr/src/route/connection_router.h

@@ -22,12 +22,12 @@
  */
 
 #include "connection_router_interface.h"
+#include "globals.h"
 #include "rr_graph_storage.h"
-#include "route_common.h"
 #include "router_lookahead.h"
 #include "route_tree.h"
-#include "rr_rc_data.h"
 #include "router_stats.h"
+#include "rr_graph_view.h"
 #include "spatial_route_tree_lookup.h"
 
 /**

vpr/src/route/connection_router.tpp

@@ -4,6 +4,7 @@
 
 #include <algorithm>
 #include "describe_rr_node.h"
+#include "route_common.h"
 #include "rr_graph_fwd.h"
 #include "vpr_utils.h"
 

vpr/src/route/connection_router_interface.h

@@ -1,9 +1,6 @@
 #ifndef _CONNECTION_ROUTER_INTERFACE_H
 #define _CONNECTION_ROUTER_INTERFACE_H
 
-#include <utility>
-
-#include "heap_type.h"
 #include "route_tree_fwd.h"
 #include "rr_graph_fwd.h"
 #include "vpr_types.h"

vpr/src/route/edge_groups.cpp

@@ -2,6 +2,7 @@
 
 #include <stack>
 #include "rr_graph_fwd.h"
+#include "vpr_context.h"
 
 // Adds non-configurable (undirected) edge to be grouped.
 //

vpr/src/route/edge_groups.h

@@ -7,7 +7,8 @@
 #include <cstddef>
 
 #include "vpr_types.h"
-#include "vpr_context.h"
+
+struct DeviceContext;
 
 // Class for identifying the components of a graph as sets of nodes.
 // Each node is reachable from any other node in the same set, and

vpr/src/route/heap_type.h

@@ -2,10 +2,7 @@
 #define _HEAP_TYPE_H
 
 #include <cstdint>
-#include "physical_types.h"
 #include "device_grid.h"
-#include "vtr_memory.h"
-#include "vtr_array_view.h"
 #include "rr_graph_fwd.h"
 #include "route_path_manager.h"
 

vpr/src/route/netlist_routers.h

@@ -19,13 +19,11 @@
 #include "NetPinTimingInvalidator.h"
 #include "clustered_netlist_utils.h"
 #include "connection_based_routing_fwd.h"
-#include "globals.h"
+#include "d_ary_heap.h"
 #include "heap_type.h"
 #include "netlist_fwd.h"
-#include "partition_tree.h"
 #include "routing_predictor.h"
 #include "route_budgets.h"
-#include "route_utils.h"
 #include "router_stats.h"
 #include "timing_info.h"
 #include "vpr_net_pins_matrix.h"

vpr/src/route/overuse_report.cpp

@@ -1,6 +1,7 @@
 #include "overuse_report.h"
 
 #include <fstream>
+#include "globals.h"
 #include "physical_types_util.h"
 #include "vpr_utils.h"
 #include "vtr_log.h"

vpr/src/route/overuse_report.h

@@ -1,8 +1,7 @@
 #pragma once
 
-#include "rr_graph_storage.h"
+#include "netlist.h"
 #include "rr_graph_view.h"
-#include "globals.h"
 #include <map>
 #include <set>
 

vpr/src/route/parallel_connection_router.cpp

@@ -1,6 +1,7 @@
 #include "parallel_connection_router.h"
 
 #include <algorithm>
+#include "d_ary_heap.h"
 #include "route_tree.h"
 #include "rr_graph_fwd.h"
 

vpr/src/route/parallel_connection_router.h

@@ -3,7 +3,6 @@
 
 #include "connection_router.h"
 
-#include "d_ary_heap.h"
 #include "multi_queue_d_ary_heap.h"
 
 #include <atomic>

vpr/src/route/partition_tree.cpp

@@ -1,7 +1,9 @@
 #include "partition_tree.h"
 #include <cmath>
 #include <memory>
+#include <stack>
 #include <unordered_set>
+#include "globals.h"
 
 /** Minimum number of nets inside a partition to continue further partitioning.
  * Mostly an arbitrary limit. At a certain point, the quality lost due to disturbed net ordering 

vpr/src/route/partition_tree.h

@@ -1,13 +1,10 @@
 #pragma once
 
-#include "serial_connection_router.h"
-#include "netlist_fwd.h"
-#include "router_stats.h"
+#include "netlist.h"
+#include "vpr_types.h"
 
 #include <cmath>
-#include <fstream>
 #include <memory>
-#include <thread>
 
 #ifdef VPR_USE_TBB
 #include <tbb/concurrent_vector.h>

vpr/src/route/route_budgets.cpp

@@ -22,33 +22,11 @@
 #include <fstream>
 #include "vpr_error.h"
 #include "globals.h"
-#include "tatum/util/tatum_assert.hpp"
-
-#include "tatum/timing_analyzers.hpp"
-#include "tatum/graph_walkers.hpp"
-#include "tatum/analyzer_factory.hpp"
-
-#include "tatum/TimingGraph.hpp"
-#include "tatum/TimingConstraints.hpp"
-#include "tatum/TimingReporter.hpp"
-#include "tatum/timing_paths.hpp"
-
-#include "tatum/delay_calc/FixedDelayCalculator.hpp"
-
-#include "tatum/report/graphviz_dot_writer.hpp"
-#include "tatum/base/sta_util.hpp"
-#include "tatum/echo_writer.hpp"
 #include "tatum/TimingGraphFwd.hpp"
-#include "slack_evaluation.h"
 #include "tatum/TimingGraphFwd.hpp"
 
 #include "vtr_assert.h"
-#include "vtr_log.h"
-#include "tatum/report/TimingPathFwd.hpp"
-#include "tatum/base/TimingType.hpp"
 #include "concrete_timing_info.h"
-#include "tatum/echo_writer.hpp"
-#include "net_delay.h"
 #include "route_budgets.h"
 #include "vtr_time.h"
 

vpr/src/route/route_budgets.h

@@ -4,10 +4,10 @@
 #ifndef ROUTE_BUDGETS_H
 #define ROUTE_BUDGETS_H
 
-#include <iostream>
 #include <vector>
 #include <queue>
 #include "RoutingDelayCalculator.h"
+#include "timing_info.h"
 
 enum analysis_type {
     SETUP,

vpr/src/route/route_common.cpp

@@ -7,6 +7,7 @@
 #include "logic_types.h"
 #include "physical_types_util.h"
 #include "route_export.h"
+#include "vpr_utils.h"
 
 #if defined(VPR_USE_TBB)
 #include <tbb/parallel_for_each.h>

vpr/src/route/route_common.h

@@ -4,8 +4,6 @@
  * router files and some used globally. */
 
 #include <vector>
-#include "clustered_netlist.h"
-#include "rr_node_fwd.h"
 #include "router_stats.h"
 #include "globals.h"
 

vpr/src/route/route_export.h

@@ -3,13 +3,13 @@
 /** @file Function prototypes for functions in route_common.cpp that
  * are used outside the router modules. */
 
-#include <memory>
-
-#include "route_common.h"
-#include "timing_info_fwd.h"
-#include "vpr_types.h"
-
-#include "RoutingDelayCalculator.h"
+#include <vector>
+#include "clustered_netlist_fwd.h"
+#include "netlist.h"
+#include "route_tree.h"
+#include "rr_graph_fwd.h"
+#include "vtr_optional.h"
+#include "vtr_vector.h"
 
 std::vector<RRNodeId> collect_congested_rr_nodes();