[Infra] The Big VPR Pragma Commit

VPR is moving to a style that uses "#pragma once" instead of header
gaurds. These are less error prone and may be slightly more performant.

Converted all of the header gaurds in VPR into pragma once's.

Also moved all pragma onces to the top of all header files to maintain a
consistent style. It is a good idea to have them as the very first line
in all header files.

While going through all header files, cleaned up any extra header
includes which were including things they did not need.

Author: AlexandreSinger

vpr/src/analytical_place/analytical_placement_flow.h

@@ -1,12 +1,11 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer
  * @date    September 2024
  * @brief   Methods for running the Analytical Placement flow.
  */
 
-#pragma once
-
 // Forward declarations
 struct t_vpr_setup;
 

vpr/src/analytical_place/analytical_solver.h

@@ -1,3 +1,4 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer and Robert Luo
@@ -6,8 +7,6 @@
  *          to define the functionality of all solvers used in the AP flow.
  */
 
-#pragma once
-
 #include <memory>
 #include "ap_flow_enums.h"
 #include "ap_netlist.h"

vpr/src/analytical_place/ap_flow_enums.h

@@ -1,12 +1,11 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer
  * @date    February 2025
  * @brief   Enumerations used by the Analytical Placement Flow.
  */
 
-#pragma once
-
 /**
  * @brief The type of an Analytical Solver.
  *

vpr/src/analytical_place/ap_netlist.h

@@ -1,3 +1,4 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer
@@ -18,8 +19,6 @@
  * unused by Analytical Placement are ignored.
  */
 
-#pragma once
-
 #include <string>
 #include "netlist.h"
 #include "ap_netlist_fwd.h"

vpr/src/analytical_place/ap_netlist_fwd.h

@@ -1,3 +1,4 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer
@@ -7,8 +8,6 @@
  * Forward declares the APNetlist class, and defines common types used by it.
  */
 
-#pragma once
-
 #include "netlist_fwd.h"
 #include "vtr_strong_id.h"
 

vpr/src/analytical_place/detailed_placer.h

@@ -1,3 +1,4 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer
@@ -6,8 +7,6 @@
  *          and placement and optimizes them while remaining legal.
  */
 
-#pragma once
-
 #include <memory>
 #include "ap_flow_enums.h"
 #include "clustered_netlist_utils.h"

vpr/src/analytical_place/flat_placement_bins.h

@@ -1,3 +1,4 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer
@@ -8,8 +9,6 @@
  * FPGA.
  */
 
-#pragma once
-
 #include <unordered_set>
 #include "ap_netlist.h"
 #include "vtr_assert.h"

vpr/src/analytical_place/flat_placement_density_manager.h

@@ -1,3 +1,4 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer
@@ -8,8 +9,6 @@
  * defines a bin that is "overfilled".
  */
 
-#pragma once
-
 #include <tuple>
 #include <unordered_set>
 #include <vector>

vpr/src/analytical_place/flat_placement_mass_calculator.h

@@ -1,12 +1,11 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer
  * @date    February 2024
  * @brief   Mass calculation for AP blocks and logical/physical block/tile types
  */
 
-#pragma once
-
 #include <vector>
 #include "ap_netlist_fwd.h"
 #include "primitive_vector.h"

vpr/src/analytical_place/full_legalizer.h

@@ -1,3 +1,4 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer
@@ -7,8 +8,6 @@
  *          routed by VTR.
  */
 
-#pragma once
-
 #include <memory>
 #include "ap_flow_enums.h"
 

vpr/src/analytical_place/gen_ap_netlist_from_atoms.h

@@ -1,3 +1,4 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer
@@ -6,8 +7,6 @@
  *          results of the prepacker to generate an APNetlist.
  */
 
-#pragma once
-
 // Forward declarations
 class APNetlist;
 class AtomNetlist;

vpr/src/analytical_place/global_placer.h

@@ -1,3 +1,4 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer
@@ -12,8 +13,6 @@
  * architecture.
  */
 
-#pragma once
-
 #include <memory>
 #include "ap_flow_enums.h"
 #include "flat_placement_density_manager.h"

vpr/src/analytical_place/model_grouper.h

@@ -1,3 +1,4 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer
@@ -6,8 +7,6 @@
  *          that must be legalized together in a flat placement.
  */
 
-#pragma once
-
 #include <vector>
 #include "logic_types.h"
 #include "vtr_assert.h"

vpr/src/analytical_place/partial_legalizer.h

@@ -1,3 +1,4 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer and Robert Luo
@@ -11,8 +12,6 @@
  * constraints of the architecture).
  */
 
-#pragma once
-
 #include <functional>
 #include <memory>
 #include <vector>

vpr/src/analytical_place/partial_placement.h

@@ -1,3 +1,4 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer
@@ -10,8 +11,6 @@
  * will always be on the device and will respect fixed block locations.
  */
 
-#pragma once
-
 #include <cmath>
 #include "ap_netlist.h"
 #include "physical_types.h"

vpr/src/analytical_place/primitive_vector.h

@@ -1,3 +1,4 @@
+#pragma once
 /**
  * @file
  * @author  Alex Singer
@@ -8,8 +9,6 @@
  * efficiently operated upon.
  */
 
-#pragma once
-
 #include <cmath>
 #include <cstdlib>
 #include <unordered_map>

vpr/src/base/CheckArch.h

@@ -1,8 +1,5 @@
-#ifndef CHECKARCH_H
-#define CHECKARCH_H
+#pragma once
 
 #include "physical_types.h"
 
 void CheckArch(const t_arch& Arch);
-
-#endif

vpr/src/base/CheckSetup.h

@@ -1,5 +1,4 @@
-#ifndef CHECKSETUP_H
-#define CHECKSETUP_H
+#pragma once
 
 #include "vpr_types.h"
 
@@ -12,5 +11,3 @@ void CheckSetup(const t_packer_opts& packer_opts,
                 const std::vector<t_segment_inf>& segments,
                 const t_timing_inf& timing,
                 const t_chan_width_dist& chans);
-
-#endif

vpr/src/base/SetupGrid.h

@@ -1,6 +1,4 @@
-#ifndef SETUPGRID_H
-#define SETUPGRID_H
-
+#pragma once
 /**
  * @file
  * @author  Jason Luu
@@ -32,5 +30,3 @@ DeviceGrid create_device_grid(const std::string& layout_name,
  *        (size of the bounding box of non-empty grid tiles)
  */
 size_t count_grid_tiles(const DeviceGrid& grid);
-
-#endif

vpr/src/base/SetupVPR.h

@@ -1,5 +1,5 @@
-#ifndef SETUPVPR_H
-#define SETUPVPR_H
+#pragma once
+
 #include <vector>
 #include "read_options.h"
 #include "physical_types.h"
@@ -28,4 +28,3 @@ void SetupVPR(const t_options* Options,
               std::string* GraphicsCommands,
               t_power_opts* PowerOpts,
               t_vpr_setup* vpr_setup);
-#endif

vpr/src/base/ShowSetup.h

@@ -1,5 +1,4 @@
-#ifndef SHOWSETUP_H
-#define SHOWSETUP_H
+#pragma once
 
 #include <ostream>
 #include <string>
@@ -35,5 +34,3 @@ struct ClusteredNetlistStats {
 
 void ShowSetup(const t_vpr_setup& vpr_setup);
 void writeClusteredNetlistStats(const std::string& block_usage_filename);
-
-#endif

vpr/src/base/atom_lookup.h

@@ -1,5 +1,5 @@
-#ifndef ATOM_LOOKUP_H
-#define ATOM_LOOKUP_H
+#pragma once
+
 #include "atom_lookup_fwd.h"
 
 #include "vtr_vector_map.h"
@@ -149,5 +149,3 @@ class AtomLookup {
     vtr::linear_map<AtomPinId, tatum::NodeId> atom_pin_tnode_internal_;
     vtr::linear_map<tatum::NodeId, AtomPinId> tnode_atom_pin_;
 };
-
-#endif

vpr/src/base/atom_lookup_fwd.h

@@ -1,11 +1,8 @@
-#ifndef VPR_ATOM_LOOKUP_FWD_H
-#define VPR_ATOM_LOOKUP_FWD_H
+#pragma once
 
 class AtomLookup;
 
 enum class BlockTnode {
     INTERNAL, ///<tnodes corresponding to internal paths withing atom blocks
     EXTERNAL  ///<tnodes corresponding to external interface of atom blocks
 };
-
-#endif

vpr/src/base/atom_netlist.h

@@ -1,5 +1,4 @@
-#ifndef ATOM_NETLIST_H
-#define ATOM_NETLIST_H
+#pragma once
 
 /**
  * @file
@@ -65,6 +64,7 @@
  * Refer to netlist.h for more information.
  *
  */
+
 #include <vector>
 #include <unordered_map>
 
@@ -280,5 +280,3 @@ class AtomNetlist : public Netlist<AtomBlockId, AtomPortId, AtomPinId, AtomNetId
 };
 
 #include "atom_lookup.h"
-
-#endif

vpr/src/base/atom_netlist_fwd.h

@@ -1,5 +1,5 @@
-#ifndef ATOM_NETLIST_FWD_H
-#define ATOM_NETLIST_FWD_H
+#pragma once
+
 #include "vtr_strong_id.h"
 #include "netlist_fwd.h"
 /*
@@ -100,5 +100,3 @@ struct hash<AtomPinId> {
     }
 };
 } // namespace std
-
-#endif

vpr/src/base/atom_netlist_utils.h

@@ -1,5 +1,5 @@
-#ifndef ATOM_NETLIST_UTILS_H
-#define ATOM_NETLIST_UTILS_H
+#pragma once
+
 #include <cstdio>
 #include <set>
 #include "atom_netlist.h"
@@ -122,4 +122,3 @@ std::set<AtomPinId> find_netlist_logical_clock_drivers(const AtomNetlist& netlis
 
 ///@brief Prints out information about netlist clocks
 void print_netlist_clock_info(const AtomNetlist& netlist, const LogicalModels& models);
-#endif

vpr/src/base/check_netlist.h

@@ -1,6 +1,3 @@
-#ifndef CHECK_NETLIST_H
-#define CHECK_NETLIST_H
+#pragma once
 
 void check_netlist(int verbosity);
-
-#endif

vpr/src/base/clock_modeling.h

@@ -1,5 +1,4 @@
-#ifndef CLOCK_MODELING_H
-#define CLOCK_MODELING_H
+#pragma once
 
 enum e_clock_modeling {
     IDEAL_CLOCK,      ///<Treat the clock pins as ideal (i.e. not routed)
@@ -16,5 +15,3 @@ namespace ClockModeling {
  */
 void treat_clock_pins_as_non_globals();
 } // namespace ClockModeling
-
-#endif

vpr/src/base/clustered_netlist.h

@@ -1,5 +1,4 @@
-#ifndef CLUSTERED_NETLIST_H
-#define CLUSTERED_NETLIST_H
+#pragma once
 /**
  * @file
  * @brief This file defines the ClusteredNetlist class in the ClusteredContext
@@ -340,5 +339,3 @@ class ClusteredNetlist : public Netlist<ClusterBlockId, ClusterPortId, ClusterPi
 
     //Nets
 };
-
-#endif