systemc: Switch to using predefined messages for datatypes.

Create and use predefined messages for datatypes which match the ones
Accellera uses.

Change-Id: I92dd52f62462b864264217bb81f3ff1dcec020bf
Reviewed-on: https://gem5-review.googlesource.com/c/13331
Reviewed-by: Gabe Black <gabeblack@google.com>
Maintainer: Gabe Black <gabeblack@google.com>

4 files changed, 75 insertions, 3 deletions

diff --git a/src/systemc/dt/fx/SConscript b/src/systemc/dt/fx/SConscript
index 698496cf4..824e47d6f 100644
--- a/src/systemc/dt/fx/SConscript
+++ b/src/systemc/dt/fx/SConscript
@@ -28,6 +28,7 @@
 Import('*')
 
 if env['USE_SYSTEMC']:
+    Source('messages.cc')
     Source('sc_fxcast_switch.cc')
     Source('sc_fxdefs.cc')
     Source('scfx_mant.cc')
diff --git a/src/systemc/dt/fx/messages.cc b/src/systemc/dt/fx/messages.cc
new file mode 100644
index 000000000..f1034db13
--- /dev/null
+++ b/src/systemc/dt/fx/messages.cc
@@ -0,0 +1,69 @@
+/*
+ * Copyright 2018 Google, Inc.
+ *
+ * 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: Gabe Black
+ */
+
+#include "systemc/ext/dt/fx/messages.hh"
+#include "systemc/utils/report.hh"
+
+namespace sc_core
+{
+
+const char SC_ID_INVALID_WL_[] = "total wordlength <= 0 is not valid";
+const char SC_ID_INVALID_N_BITS_[] = "number of bits < 0 is not valid";
+const char SC_ID_INVALID_DIV_WL_[] = "division wordlength <= 0 is not valid";
+const char SC_ID_INVALID_CTE_WL_[] = "constant wordlength <= 0 is not valid";
+const char SC_ID_INVALID_MAX_WL_[] =
+    "maximum wordlength <= 0 and != -1 is not valid";
+const char SC_ID_INVALID_FX_VALUE_[] = "invalid fixed-point value";
+const char SC_ID_INVALID_O_MODE_[] = "invalid overflow mode";
+const char SC_ID_OUT_OF_RANGE_[] = "index out of range";
+const char SC_ID_CONTEXT_BEGIN_FAILED_[] = "context begin failed";
+const char SC_ID_CONTEXT_END_FAILED_[] = "context end failed";
+const char SC_ID_WRAP_SM_NOT_DEFINED_[] =
+    "SC_WRAP_SM not defined for unsigned numbers";
+
+namespace
+{
+
+sc_gem5::DefaultReportMessages predefinedMessages{
+    {300, SC_ID_INVALID_WL_},
+    {301, SC_ID_INVALID_N_BITS_},
+    {302, SC_ID_INVALID_DIV_WL_},
+    {303, SC_ID_INVALID_CTE_WL_},
+    {304, SC_ID_INVALID_MAX_WL_},
+    {305, SC_ID_INVALID_FX_VALUE_},
+    {306, SC_ID_INVALID_O_MODE_},
+    {307, SC_ID_OUT_OF_RANGE_},
+    {308, SC_ID_CONTEXT_BEGIN_FAILED_},
+    {309, SC_ID_CONTEXT_END_FAILED_},
+    {310, SC_ID_WRAP_SM_NOT_DEFINED_}
+};
+
+} // anonymous namespace
+
+} // namespace sc_core
diff --git a/src/systemc/dt/fx/sc_fxnum.cc b/src/systemc/dt/fx/sc_fxnum.cc
index f47b4d342..d11a28774 100644
--- a/src/systemc/dt/fx/sc_fxnum.cc
+++ b/src/systemc/dt/fx/sc_fxnum.cc
@@ -53,6 +53,7 @@
 
 #include <cmath>
 
+#include "systemc/ext/dt/fx/messages.hh"
 #include "systemc/ext/dt/fx/sc_fxnum.hh"
 
 namespace sc_dt
@@ -503,7 +504,7 @@ overflow(double &c, const scfx_params &params, bool &o_flag)
           case SC_WRAP_SM: // sign magnitude wrap-around
             {
                 SC_ERROR_IF_(params.enc() == SC_US_,
-                             "SC_WRAP_SM not defined for unsigned numbers");
+                             sc_core::SC_ID_WRAP_SM_NOT_DEFINED_);
 
                 int n_bits = params.n_bits();
 
@@ -564,7 +565,7 @@ void
 sc_fxnum_fast::cast()
 {
     scfx_ieee_double id(m_val);
-    SC_ERROR_IF_(id.is_nan() || id.is_inf(), "invalid fixed-point value");
+    SC_ERROR_IF_(id.is_nan() || id.is_inf(), sc_core::SC_ID_INVALID_FX_VALUE_);
 
     if (m_params.cast_switch() == SC_ON) {
         m_q_flag = false;
diff --git a/src/systemc/dt/fx/scfx_rep.cc b/src/systemc/dt/fx/scfx_rep.cc
index f94c5eae0..3666e6a0f 100644
--- a/src/systemc/dt/fx/scfx_rep.cc
+++ b/src/systemc/dt/fx/scfx_rep.cc
@@ -66,6 +66,7 @@
 #include "base/compiler.hh"
 #include "systemc/ext/dt/bit/sc_bv_base.hh"
 #include "systemc/ext/dt/bit/sc_lv_base.hh"
+#include "systemc/ext/dt/fx/messages.hh"
 #include "systemc/ext/dt/fx/scfx_ieee.hh"
 #include "systemc/ext/dt/fx/scfx_pow10.hh"
 #include "systemc/ext/dt/fx/scfx_rep.hh"
@@ -1963,7 +1964,7 @@ scfx_rep::overflow(const scfx_params &params, bool &o_flag)
           case SC_WRAP_SM: // sign magnitude wrap-around
             {
                 SC_ERROR_IF_(enc == SC_US_,
-                             "SC_WRAP_SM not defined for unsigned numbers");
+                             sc_core::SC_ID_WRAP_SM_NOT_DEFINED_);
 
                 int n_bits = params.n_bits();