Merge branch 'master' into temp_annealer_class

Author: soheilshahrouz

.github/workflows/nightly_test.yml

@@ -4,20 +4,23 @@ on:
   # We want to run the CI when anything is pushed to master.
   # Since master is a protected branch this only happens when a PR is merged.
   # This is a double check in case the PR was stale and had some issues.
-  push:
-    branches:
-      - master
-    paths-ignore: # Prevents from running if only docs are updated
-      - 'doc/**'
-      - '**/*README*'
-      - '**.md'
-      - '**.rst'
-  pull_request:
-    paths-ignore: # Prevents from running if only docs are updated
-      - 'doc/**'
-      - '**/*README*'
-      - '**.md'
-      - '**.rst'
+  # NOTE: This was turned off in late October 2024 since the Nightly Tests were
+  #       no longer working on the self-hosted runners. Will turn this back on
+  #       once the issue is resolved.
+  # push:
+  #   branches:
+  #     - master
+  #   paths-ignore: # Prevents from running if only docs are updated
+  #     - 'doc/**'
+  #     - '**/*README*'
+  #     - '**.md'
+  #     - '**.rst'
+  # pull_request:
+  #   paths-ignore: # Prevents from running if only docs are updated
+  #     - 'doc/**'
+  #     - '**/*README*'
+  #     - '**.md'
+  #     - '**.rst'
   workflow_dispatch:
   schedule:
   - cron: '0 0 * * *' # daily

doc/src/vpr/command_line_usage.rst

@@ -1074,12 +1074,16 @@ The following options are only used when FPGA device and netlist contain a NoC r
 
     .. note:: noc_flows_file are required to specify if NoC optimization is turned on (--noc on).
 
-.. option:: --noc_routing_algorithm {xy_routing | bfs_routing}
+.. option:: --noc_routing_algorithm {xy_routing | bfs_routing | west_first_routing | north_last_routing | negative_first_routing | odd_even_routing}
 
     Controls the algorithm used by the NoC to route packets.
 
     * ``xy_routing`` Uses the direction oriented routing algorithm. This is recommended to be used with mesh NoC topologies.
-    * ``bfs_routing`` Uses the breadth first search algorithm. The objective is to find a route that uses a minimum number of links. This can be used with any NoC topology.
+    * ``bfs_routing`` Uses the breadth first search algorithm. The objective is to find a route that uses a minimum number of links. This algorithm is not guaranteed to generate deadlock-free traffic flow routes, but can be used with any NoC topology.
+    * ``west_first_routing`` Uses the west-first routing algorithm. This is recommended to be used with mesh NoC topologies.
+    * ``north_last_routing`` Uses the north-last routing algorithm. This is recommended to be used with mesh NoC topologies.
+    * ``negative_first_routing`` Uses the negative-first routing algorithm. This is recommended to be used with mesh NoC topologies.
+    * ``odd_even_routing`` Uses the odd-even routing algorithm. This is recommended to be used with mesh NoC topologies.
 
     **Default:** ``bfs_routing``
 
@@ -1091,28 +1095,45 @@ The following options are only used when FPGA device and netlist contain a NoC r
     * ``noc_placement_weighting = 1`` means noc placement is considered equal to timing and wirelength.
     * ``noc_placement_weighting > 1`` means the placement is increasingly dominated by NoC parameters.
 
-    **Default:** ``0.6``
+    **Default:** ``5.0``
+
+.. option:: --noc_aggregate_bandwidth_weighting <float>
+
+    Controls the importance of minimizing the NoC aggregate bandwidth. This value can be >=0, where 0 would mean the aggregate bandwidth has no relevance to placement.
+    Other positive numbers specify the importance of minimizing the NoC aggregate bandwidth compared to other NoC-related cost terms.
+    Weighting factors for NoC-related cost terms are normalized internally. Therefore, their absolute values are not important, and
+    only their relative ratios determine the importance of each cost term.
+
+    **Default:** ``0.38``
 
 .. option:: --noc_latency_constraints_weighting <float>
 
-    Controls the importance of meeting all the NoC traffic flow latency constraints.
+    Controls the importance of meeting all the NoC traffic flow latency constraints. This value can be >=0, where 0 would mean latency constraints have no relevance to placement.
+    Other positive numbers specify the importance of meeting latency constraints compared to other NoC-related cost terms.
+    Weighting factors for NoC-related cost terms are normalized internally. Therefore, their absolute values are not important, and
+    only their relative ratios determine the importance of each cost term.
 
-    * ``latency_constraints = 0`` means the latency constraints have no relevance to placement.
-    * ``0 < latency_constraints < 1`` means the latency constraints are weighted equally to the sum of other placement cost components. 
-    * ``latency_constraints > 1`` means the placement is increasingly dominated by reducing the latency constraints of the traffic flows.
-    
-    **Default:** ``1``
+    **Default:** ``0.6``
 
 .. option:: --noc_latency_weighting <float>
 
     Controls the importance of reducing the latencies of the NoC traffic flows.
-    This value can be >=0, 
+    This value can be >=0, where 0 would mean the latencies have no relevance to placement
+    Other positive numbers specify the importance of minimizing aggregate latency compared to other NoC-related cost terms.
+    Weighting factors for NoC-related cost terms are normalized internally. Therefore, their absolute values are not important, and
+    only their relative ratios determine the importance of each cost term.
 
-    * ``latency = 0`` means the latencies have no relevance to placement.
-    * ``0 < latency < 1`` means the latencies are weighted equally to the sum of other placement cost components. 
-    * ``latency > 1`` means the placement is increasingly dominated by reducing the latencies of the traffic flows.
-    
-    **Default:** ``0.05``
+    **Default:** ``0.02``
+
+.. option:: --noc_congestion_weighting <float>
+
+    Controls the importance of reducing the congestion of the NoC links.
+    This value can be >=0, where 0 would mean the congestion has no relevance to placement.
+    Other positive numbers specify the importance of minimizing congestion compared to other NoC-related cost terms.
+    Weighting factors for NoC-related cost terms are normalized internally. Therefore, their absolute values are not important, and
+    only their relative ratios determine the importance of each cost term.
+
+    **Default:** ``0.25``
 
 .. option:: --noc_swap_percentage <float>
 
@@ -1122,7 +1143,7 @@ The following options are only used when FPGA device and netlist contain a NoC r
     * ``0`` means NoC blocks will be moved at the same rate as other blocks. 
     * ``100`` means all swaps attempted by the placer are NoC router blocks.
 
-    **Default:** ``40``    
+    **Default:** ``0``
 
 .. option:: --noc_placement_file_name <file>
 

libs/libvtrutil/src/specrand.cpp

@@ -52,32 +52,15 @@
 
 #include "specrand.h"
 
-/* Period parameters */
-#define N 624
-#define M 397
-#define MATRIX_A 0x9908b0dfUL   /* constant vector a */
-#define UPPER_MASK 0x80000000UL /* most significant w-r bits */
-#define LOWER_MASK 0x7fffffffUL /* least significant r bits */
-
-static unsigned long mt[N]; /* the array for the state vector  */
-static int mti = N + 1;     /* mti==N+1 means mt[N] is not initialized */
-
-void spec_srand(int seed) {
-    spec_init_genrand((unsigned long)seed);
+double SpecRandomNumberGenerator::spec_rand_() {
+    return spec_genrand_int32_() * (1.0 / 4294967296.0);
 }
 
-/* Just a copy of spec_genrand_real2() */
-double spec_rand() {
-    return spec_genrand_int32() * (1.0 / 4294967296.0);
+long SpecRandomNumberGenerator::spec_lrand48_() {
+    return (long)(spec_genrand_int32_() >> 1);
 }
 
-/* Just a copy of spec_genrand_int31() */
-long spec_lrand48() {
-    return (long)(spec_genrand_int32() >> 1);
-}
-
-/* initializes mt[N] with a seed */
-void spec_init_genrand(unsigned long s) {
+void SpecRandomNumberGenerator::spec_init_genrand_(unsigned long s) {
     mt[0] = s & 0xffffffffUL;
     for (mti = 1; mti < N; mti++) {
         mt[mti] = (1812433253UL * (mt[mti - 1] ^ (mt[mti - 1] >> 30)) + mti);
@@ -90,16 +73,11 @@ void spec_init_genrand(unsigned long s) {
     }
 }
 
-/* initialize by an array with array-length */
-/* init_key is the array for initializing keys */
-/* key_length is its length */
-/* slight change for C++, 2004/2/26 */
-void spec_init_by_array(unsigned long init_key[], int key_length) {
-    int i, j, k;
-    spec_init_genrand(19650218UL);
-    i = 1;
-    j = 0;
-    k = (N > key_length ? N : key_length);
+void SpecRandomNumberGenerator::spec_init_by_array_(const unsigned long init_key[], size_t key_length) {
+    spec_init_genrand_(19650218UL);
+    size_t i = 1;
+    size_t j = 0;
+    size_t k = (N > key_length ? N : key_length);
     for (; k; k--) {
         mt[i] = (mt[i] ^ ((mt[i - 1] ^ (mt[i - 1] >> 30)) * 1664525UL))
                 + init_key[j] + j; /* non linear */
@@ -127,22 +105,21 @@ void spec_init_by_array(unsigned long init_key[], int key_length) {
 }
 
 /* generates a random number on [0,0xffffffff]-interval */
-unsigned long spec_genrand_int32() {
+unsigned long SpecRandomNumberGenerator::spec_genrand_int32_() {
     unsigned long y;
     static unsigned long mag01[2] = {0x0UL, MATRIX_A};
     /* mag01[x] = x * MATRIX_A  for x=0,1 */
 
     if (mti >= N) { /* generate N words at one time */
-        int kk;
 
         if (mti == N + 1)              /* if init_genrand() has not been called, */
-            spec_init_genrand(5489UL); /* a default initial seed is used */
+            spec_init_genrand_(5489UL); /* a default initial seed is used */
 
-        for (kk = 0; kk < N - M; kk++) {
+        for (size_t kk = 0; kk < N - M; kk++) {
             y = (mt[kk] & UPPER_MASK) | (mt[kk + 1] & LOWER_MASK);
             mt[kk] = mt[kk + M] ^ (y >> 1) ^ mag01[y & 0x1UL];
         }
-        for (; kk < N - 1; kk++) {
+        for (size_t kk; kk < N - 1; kk++) {
             y = (mt[kk] & UPPER_MASK) | (mt[kk + 1] & LOWER_MASK);
             mt[kk] = mt[kk + (M - N)] ^ (y >> 1) ^ mag01[y & 0x1UL];
         }
@@ -163,32 +140,45 @@ unsigned long spec_genrand_int32() {
     return y;
 }
 
-/* generates a random number on [0,0x7fffffff]-interval */
-long spec_genrand_int31() {
-    return (long)(spec_genrand_int32() >> 1);
+long SpecRandomNumberGenerator::spec_genrand_int31_() {
+    return (long)(spec_genrand_int32_() >> 1);
 }
 
-/* generates a random number on [0,1]-real-interval */
-double spec_genrand_real1() {
-    return spec_genrand_int32() * (1.0 / 4294967295.0);
+double SpecRandomNumberGenerator::spec_genrand_real1_() {
+    return spec_genrand_int32_() * (1.0 / 4294967295.0);
     /* divided by 2^32-1 */
 }
 
-/* generates a random number on [0,1)-real-interval */
-double spec_genrand_real2() {
-    return spec_genrand_int32() * (1.0 / 4294967296.0);
+double SpecRandomNumberGenerator::spec_genrand_real2_() {
+    return spec_genrand_int32_() * (1.0 / 4294967296.0);
     /* divided by 2^32 */
 }
 
-/* generates a random number on (0,1)-real-interval */
-double spec_genrand_real3() {
-    return (((double)spec_genrand_int32()) + 0.5) * (1.0 / 4294967296.0);
+double SpecRandomNumberGenerator::spec_genrand_real3_() {
+    return (((double)spec_genrand_int32_()) + 0.5) * (1.0 / 4294967296.0);
     /* divided by 2^32 */
 }
 
-/* generates a random number on [0,1) with 53-bit resolution*/
-double spec_genrand_res53() {
-    unsigned long a = spec_genrand_int32() >> 5, b = spec_genrand_int32() >> 6;
+double SpecRandomNumberGenerator::spec_genrand_res53_() {
+    unsigned long a = spec_genrand_int32_() >> 5, b = spec_genrand_int32_() >> 6;
     return (a * 67108864.0 + b) * (1.0 / 9007199254740992.0);
 }
-/* These real versions are due to Isaku Wada, 2002/01/09 added */
+
+void SpecRandomNumberGenerator::srandom(int seed) {
+    spec_init_genrand_((unsigned long)seed);
+}
+
+int SpecRandomNumberGenerator::irand(int imax) {
+    return (int)(spec_genrand_int31_() % (imax + 1));
+}
+
+float SpecRandomNumberGenerator::frand() {
+    return (float)spec_genrand_real2_();
+}
+
+SpecRandomNumberGenerator::SpecRandomNumberGenerator(int seed) {
+    spec_init_genrand_((unsigned long)seed);
+}
+
+SpecRandomNumberGenerator::SpecRandomNumberGenerator()
+    : SpecRandomNumberGenerator(0) {}

libs/libvtrutil/src/specrand.h

@@ -52,35 +52,69 @@
 /* Slightly modified for use in SPEC CPU by Cloyce D. Spradling (5 Nov 2009)
  */
 
-void spec_srand(int seed);
-double spec_rand();
-long spec_lrand48();
+#include "vtr_random.h"
 
-/* initializes mt[N] with a seed */
-void spec_init_genrand(unsigned long s);
+class SpecRandomNumberGenerator : public vtr::RandomNumberGeneratorInterface {
+  public:
+    SpecRandomNumberGenerator(const SpecRandomNumberGenerator&) = delete;
+    SpecRandomNumberGenerator& operator=(SpecRandomNumberGenerator& other) = delete;
 
-/* initialize by an array with array-length */
-/* init_key is the array for initializing keys */
-/* key_length is its length */
-/* slight change for C++, 2004/2/26 */
-void spec_init_by_array(unsigned long init_key[], int key_length);
+    SpecRandomNumberGenerator();
+    explicit SpecRandomNumberGenerator(int seed);
 
-/* generates a random number on [0,0xffffffff]-interval */
-unsigned long spec_genrand_int32();
+    virtual void srandom(int seed) override;
+    virtual int irand(int imax) override;
+    virtual float frand() override;
 
-/* generates a random number on [0,0x7fffffff]-interval */
-long spec_genrand_int31();
+  private:
+    /// @brief initializes mt[N] with a seed
+    void spec_init_genrand_(unsigned long s);
 
-/* generates a random number on [0,1]-real-interval */
-double spec_genrand_real1();
+    /**
+     * @brief initialize by an array with array-length
+     * @param init_key the array for initializing keys
+     * @param key_length the length of array
+     */
+    void spec_init_by_array_(const unsigned long init_key[], size_t key_length);
 
-/* generates a random number on [0,1)-real-interval */
-double spec_genrand_real2();
+    /// @brief generates a random number on [0,0xffffffff]-interval
+    unsigned long spec_genrand_int32_();
 
-/* generates a random number on (0,1)-real-interval */
-double spec_genrand_real3();
+    /// @brief Just a copy of spec_genrand_real2()
+    double spec_rand_();
+    /// @brief Just a copy of spec_genrand_int31()
+    long spec_lrand48_();
 
-/* generates a random number on [0,1) with 53-bit resolution*/
-double spec_genrand_res53();
+    /// @brief generates a random number on [0,0x7fffffff]-interval */
+    long spec_genrand_int31_();
+
+    /// @brief generates a random number on [0,1]-real-interval
+    double spec_genrand_real1_();
+
+    /// @brief generates a random number on [0,1)-real-interval
+    double spec_genrand_real2_();
+
+    /// @brief generates a random number on (0,1)-real-interval
+    double spec_genrand_real3_();
+
+    /// @brief generates a random number on [0,1) with 53-bit resolution
+    double spec_genrand_res53_();
+
+  private:
+    /// Period parameters
+    static constexpr size_t M = 397;
+    static constexpr size_t N = 624;
+    /// constant vector a
+    static constexpr unsigned long MATRIX_A = 0x9908b0dfUL;
+    /// most significant w-r bits
+    static constexpr unsigned long UPPER_MASK = 0x80000000UL;
+    /// least significant r bits
+    static constexpr unsigned long LOWER_MASK = 0x7fffffffUL;
+    /// mti==N+1 means mt[N] is not initialized
+    size_t mti = N + 1;
+    /// the array for the state vector
+    unsigned long mt[N];
+
+};
 
 #endif