systemc: Switch to using predefined messages for utils.

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

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

src/systemc/utils/SConscript

@@ -29,6 +29,7 @@ Import('*')
 
 if env['USE_SYSTEMC']:
     Source('functions.cc')
+    Source('messages.cc')
     Source('report.cc')
     Source('sc_report.cc')
     Source('sc_report_handler.cc')

src/systemc/utils/messages.cc

@@ -0,0 +1,85 @@
+/*
+ * 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/utils/messages.hh"
+#include "systemc/utils/report.hh"
+
+namespace sc_core
+{
+
+const char SC_ID_REGISTER_ID_FAILED_[] = "register_id failed";
+const char SC_ID_UNKNOWN_ERROR_[] = "unknown error";
+const char SC_ID_WITHOUT_MESSAGE_[] = "";
+const char SC_ID_NOT_IMPLEMENTED_[] = "not implemented";
+const char SC_ID_INTERNAL_ERROR_[] = "internal error";
+const char SC_ID_ASSERTION_FAILED_[] = "assertion failed";
+const char SC_ID_OUT_OF_BOUNDS_[] = "out of bounds";
+const char SC_ID_ABORT_[] = "simulation aborted";
+
+const char SC_ID_STRING_TOO_LONG_[] = "string is too long";
+const char SC_ID_FRONT_ON_EMPTY_LIST_[] =
+    "attempt to take front() on an empty list";
+const char SC_ID_BACK_ON_EMPTY_LIST_[] =
+    "attempt to take back() on an empty list";
+const char SC_ID_IEEE_1666_DEPRECATION_[] =
+    "/IEEE_Std_1666/deprecated";
+const char SC_ID_VECTOR_INIT_CALLED_TWICE_[] =
+    "sc_vector::init has already been called";
+const char SC_ID_VECTOR_BIND_EMPTY_[] =
+    "sc_vector::bind called with empty range";
+const char SC_ID_VECTOR_NONOBJECT_ELEMENTS_[] =
+    "sc_vector::get_elements called for element type "
+    "not derived from sc_object";
+
+namespace
+{
+
+sc_gem5::DefaultReportMessages predefinedMessages{
+    {800, SC_ID_REGISTER_ID_FAILED_},
+    {0, SC_ID_UNKNOWN_ERROR_},
+    {1, SC_ID_WITHOUT_MESSAGE_},
+    {2, SC_ID_NOT_IMPLEMENTED_},
+    {3, SC_ID_INTERNAL_ERROR_},
+    {4, SC_ID_ASSERTION_FAILED_},
+    {5, SC_ID_OUT_OF_BOUNDS_},
+
+    {99, SC_ID_ABORT_},
+
+    {801, SC_ID_STRING_TOO_LONG_},
+    {802, SC_ID_FRONT_ON_EMPTY_LIST_},
+    {803, SC_ID_BACK_ON_EMPTY_LIST_},
+    {804, SC_ID_IEEE_1666_DEPRECATION_},
+    {805, SC_ID_VECTOR_INIT_CALLED_TWICE_},
+    {807, SC_ID_VECTOR_BIND_EMPTY_},
+    {808, SC_ID_VECTOR_NONOBJECT_ELEMENTS_}
+};
+
+} // anonymous namespace
+
+} // namespace sc_core

src/systemc/utils/sc_report.cc

@@ -30,6 +30,7 @@
 #include <cstring>
 
 #include "base/logging.hh"
+#include "systemc/ext/utils/messages.hh"
 #include "systemc/ext/utils/sc_report.hh"
 #include "systemc/ext/utils/sc_report_handler.hh"
 #include "systemc/utils/report.hh"
@@ -119,18 +120,17 @@ void
 sc_report::register_id(int id, const char *msg)
 {
     if (id < 0) {
-        SC_REPORT_ERROR("(E800) register_id failed", "invalid report id");
+        SC_REPORT_ERROR(SC_ID_REGISTER_ID_FAILED_, "invalid report id");
         return;
     }
     if (!msg) {
-        SC_REPORT_ERROR("(E800) register_id failed", "invalid report message");
+        SC_REPORT_ERROR(SC_ID_REGISTER_ID_FAILED_, "invalid report message");
         return;
     }
     auto p = sc_gem5::reportIdToMsgMap.insert(
             std::pair<int, std::string>(id, msg));
     if (!p.second) {
-        SC_REPORT_ERROR("(E800) register_id failed",
-                "report id already exists");
+        SC_REPORT_ERROR(SC_ID_REGISTER_ID_FAILED_, "report id already exists");
     } else {
         sc_gem5::reportMsgInfoMap[msg].id = id;
     }

src/systemc/utils/sc_report_handler.cc

@@ -108,8 +108,6 @@ sc_report_handler::report(sc_severity severity, int id, const char *msg,
                           const char *file, int line)
 {
     std::string &msg_type = sc_gem5::reportIdToMsgMap[id];
-    if (msg_type == "")
-        msg_type = "unknown id";
 
     if (sc_gem5::reportWarningsAsErrors && severity == SC_WARNING)
         severity = SC_ERROR;

src/systemc/utils/sc_vector.cc

@@ -50,6 +50,7 @@
 
 #include "base/cprintf.hh"
 #include "systemc/core/object.hh"
+#include "systemc/ext/utils/messages.hh"
 #include "systemc/ext/utils/sc_report_handler.hh"
 #include "systemc/ext/utils/sc_vector.hh"
 
@@ -76,7 +77,7 @@ sc_vector_base::checkIndex(size_type index) const
     if (index >= size()) {
         std::ostringstream ss;
         ccprintf(ss, "%s[%d] >= size() = %d", name(), index, size());
-        SC_REPORT_ERROR("(E5) out of bounds", ss.str().c_str());
+        SC_REPORT_ERROR(sc_core::SC_ID_OUT_OF_BOUNDS_, ss.str().c_str());
         sc_abort();
     }
 }
@@ -107,8 +108,7 @@ sc_vector_base::reportEmpty(const char *kind_, bool empty_dest) const
     else
         ss << "empty destination range given";
 
-    SC_REPORT_WARNING("(W807) sc_vector::bind called with empty range",
-            ss.str().c_str());
+    SC_REPORT_WARNING(SC_ID_VECTOR_BIND_EMPTY_, ss.str().c_str());
 }
 
 } // namespace sc_core