base: Move SatCounter to base directory
authorDaniel <odanrc@yahoo.com.br>
Wed, 10 Apr 2019 21:11:46 +0000 (23:11 +0200)
committerDaniel Carvalho <odanrc@yahoo.com.br>
Tue, 14 May 2019 07:55:06 +0000 (07:55 +0000)
Saturating counters are used by many objects, not only
the cpu predictors. Therefore, move the class to the
base folder so that it can be more easily used.

Change-Id: I26f799324bdd8720ab8834c72a2002149cee777c
Signed-off-by: Daniel <odanrc@yahoo.com.br>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/17993
Maintainer: Jason Lowe-Power <jason@lowepower.com>
Tested-by: kokoro <noreply+kokoro@google.com>
Reviewed-by: Jason Lowe-Power <jason@lowepower.com>
src/base/sat_counter.hh [new file with mode: 0644]
src/cpu/pred/2bit_local.hh
src/cpu/pred/bi_mode.hh
src/cpu/pred/sat_counter.hh [deleted file]
src/cpu/pred/tournament.hh

diff --git a/src/base/sat_counter.hh b/src/base/sat_counter.hh
new file mode 100644 (file)
index 0000000..342a338
--- /dev/null
@@ -0,0 +1,130 @@
+/*
+ * Copyright (c) 2019 Inria
+ * All rights reserved.
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be construed as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder.  You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
+ *
+ * Copyright (c) 2005-2006 The Regents of The University of Michigan
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Kevin Lim
+ *          Daniel Carvalho
+ */
+
+#ifndef __BASE_SAT_COUNTER_HH__
+#define __BASE_SAT_COUNTER_HH__
+
+#include <cstdint>
+
+#include "base/logging.hh"
+#include "base/types.hh"
+
+/**
+ * Implements an n bit saturating counter and provides methods to
+ * increment, decrement, and read it.
+ */
+class SatCounter
+{
+  public:
+    /**
+     * Constructor for the counter. The explicit keyword is used to make
+     * sure the user does not assign a number to the counter thinking it
+     * will be used as a counter value when it is in fact used as the number
+     * of bits.
+     *
+     * @param bits How many bits the counter will have.
+     * @param initial_val Starting value for the counter.
+     */
+    explicit SatCounter(unsigned bits, uint8_t initial_val = 0)
+        : initialVal(initial_val), maxVal((1 << bits) - 1),
+          counter(initial_val)
+    {
+        fatal_if(bits > 8*sizeof(uint8_t),
+                 "Number of bits exceeds counter size");
+        fatal_if(initial_val > maxVal,
+                 "Saturating counter's Initial value exceeds max value.");
+    }
+
+    /** Pre-increment operator. */
+    SatCounter&
+    operator++()
+    {
+        if (counter < maxVal) {
+            ++counter;
+        }
+        return *this;
+    }
+
+    /** Post-increment operator. */
+    SatCounter
+    operator++(int)
+    {
+        SatCounter old_counter = *this;
+        ++*this;
+        return old_counter;
+    }
+
+    /** Pre-decrement operator. */
+    SatCounter&
+    operator--()
+    {
+        if (counter > 0) {
+            --counter;
+        }
+        return *this;
+    }
+
+    /** Post-decrement operator. */
+    SatCounter
+    operator--(int)
+    {
+        SatCounter old_counter = *this;
+        --*this;
+        return old_counter;
+    }
+
+    /**
+     * Read the counter's value.
+     */
+    operator uint8_t() const { return counter; }
+
+    /** Reset the counter to its initial value. */
+    void reset() { counter = initialVal; }
+
+  private:
+    uint8_t initialVal;
+    uint8_t maxVal;
+    uint8_t counter;
+};
+
+#endif // __BASE_SAT_COUNTER_HH__
index ef52974b75bd5c79fb07556b2e729075e533b410..636620a34fee2d71801c2059914e64b49422ae2b 100644 (file)
@@ -46,9 +46,9 @@
 
 #include <vector>
 
+#include "base/sat_counter.hh"
 #include "base/types.hh"
 #include "cpu/pred/bpred_unit.hh"
-#include "cpu/pred/sat_counter.hh"
 #include "params/LocalBP.hh"
 
 /**
index f28fdc926207e7e6fcf9dd52ae6c2d6dba9c9264..40909554b7cc494c15b24b6dc61c8d080a833f0c 100644 (file)
@@ -35,8 +35,8 @@
 #ifndef __CPU_PRED_BI_MODE_PRED_HH__
 #define __CPU_PRED_BI_MODE_PRED_HH__
 
+#include "base/sat_counter.hh"
 #include "cpu/pred/bpred_unit.hh"
-#include "cpu/pred/sat_counter.hh"
 #include "params/BiModeBP.hh"
 
 /**
diff --git a/src/cpu/pred/sat_counter.hh b/src/cpu/pred/sat_counter.hh
deleted file mode 100644 (file)
index 513419a..0000000
+++ /dev/null
@@ -1,130 +0,0 @@
-/*
- * Copyright (c) 2019 Inria
- * All rights reserved.
- *
- * The license below extends only to copyright in the software and shall
- * not be construed as granting a license to any other intellectual
- * property including but not limited to intellectual property relating
- * to a hardware implementation of the functionality of the software
- * licensed hereunder.  You may use the software subject to the license
- * terms below provided that you ensure that this notice is replicated
- * unmodified and in its entirety in all distributions of the software,
- * modified or unmodified, in source code or in binary form.
- *
- * Copyright (c) 2005-2006 The Regents of The University of Michigan
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are
- * met: redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer;
- * redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in the
- * documentation and/or other materials provided with the distribution;
- * neither the name of the copyright holders nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * Authors: Kevin Lim
- *          Daniel Carvalho
- */
-
-#ifndef __CPU_PRED_SAT_COUNTER_HH__
-#define __CPU_PRED_SAT_COUNTER_HH__
-
-#include <cstdint>
-
-#include "base/logging.hh"
-#include "base/types.hh"
-
-/**
- * Implements an n bit saturating counter and provides methods to
- * increment, decrement, and read it.
- */
-class SatCounter
-{
-  public:
-    /**
-     * Constructor for the counter. The explicit keyword is used to make
-     * sure the user does not assign a number to the counter thinking it
-     * will be used as a counter value when it is in fact used as the number
-     * of bits.
-     *
-     * @param bits How many bits the counter will have.
-     * @param initial_val Starting value for the counter.
-     */
-    explicit SatCounter(unsigned bits, uint8_t initial_val = 0)
-        : initialVal(initial_val), maxVal((1 << bits) - 1),
-          counter(initial_val)
-    {
-        fatal_if(bits > 8*sizeof(uint8_t),
-                 "Number of bits exceeds counter size");
-        fatal_if(initial_val > maxVal,
-                 "Saturating counter's Initial value exceeds max value.");
-    }
-
-    /** Pre-increment operator. */
-    SatCounter&
-    operator++()
-    {
-        if (counter < maxVal) {
-            ++counter;
-        }
-        return *this;
-    }
-
-    /** Post-increment operator. */
-    SatCounter
-    operator++(int)
-    {
-        SatCounter old_counter = *this;
-        ++*this;
-        return old_counter;
-    }
-
-    /** Pre-decrement operator. */
-    SatCounter&
-    operator--()
-    {
-        if (counter > 0) {
-            --counter;
-        }
-        return *this;
-    }
-
-    /** Post-decrement operator. */
-    SatCounter
-    operator--(int)
-    {
-        SatCounter old_counter = *this;
-        --*this;
-        return old_counter;
-    }
-
-    /**
-     * Read the counter's value.
-     */
-    operator uint8_t() const { return counter; }
-
-    /** Reset the counter to its initial value. */
-    void reset() { counter = initialVal; }
-
-  private:
-    uint8_t initialVal;
-    uint8_t maxVal;
-    uint8_t counter;
-};
-
-#endif // __CPU_PRED_SAT_COUNTER_HH__
index 7b16e72242183b81db0e4e04a48c42893866fdf8..76de16d7e8bd1869d538123e6e3494e74b849ab6 100644 (file)
@@ -47,9 +47,9 @@
 
 #include <vector>
 
+#include "base/sat_counter.hh"
 #include "base/types.hh"
 #include "cpu/pred/bpred_unit.hh"
-#include "cpu/pred/sat_counter.hh"
 #include "params/TournamentBP.hh"
 
 /**