使用set_handler过滤掉特定的SystemC Wraning &Error Message

SystemC 定义了一些 warning 和error的场景，这些场景在编译的时候是不会报错的，但在执行过程中会报出类似Error: (E554) sc_start called unexpectedly的错误，其中E表示Error，W表示warning，554为错误的编号，“sc_start called unexpectedly”为错误对应的message输出。
在源码中搜 SC_DEFINE_MESSAGE 就可以查到所有定义的message信息，以及对应的错误编号。主要的文件有以下几个，文件名都以 _ids 为结尾。
#include “sysc/utils/sc_utils_ids.h”
#include “sysc/kernel/sc_kernel_ids.h”
#include “sysc/communication/sc_communication_ids.h”
#include “sysc/datatypes/bit/sc_bit_ids.h”
#include “sysc/datatypes/fx/sc_fx_ids.h”
#include “sysc/datatypes/int/sc_int_ids.h”
#include “sysc/tracing/sc_tracing_ids.h”

对于E554，我们梳理下 其代码调用过程：
在 sc_simcontext.cpp 中，sc_start 被调用时，会check当前是否已经处于 running 状态，如果是，则会执行到SC_REPORT_ERROR这一行，也就是会调用 sc_core::sc_report_handler::report。这里可以看出 message tpe是
if( !(status == SC_PAUSED || status == SC_ELABORATION) )
{
SC_REPORT_ERROR(SC_ID_SIMULATION_START_UNEXPECTED_, “”);
return;
}
sc_report.h :
#define SC_REPORT_WARNING( msg_type, msg )
::sc_core::sc_report_handler::report(
::sc_core::SC_WARNING, msg_type, msg, FILE, LINE )

#define SC_REPORT_ERROR( msg_type, msg )
::sc_core::sc_report_handler::report(
::sc_core::SC_ERROR, msg_type, msg, FILE, LINE )

sc_report_handler_proc sc_report_handler::handler =
&sc_report_handler::default_handler;
void sc_report_handler::default_handler(const sc_report& rep,
                    const sc_actions& actions)
{
    if ( actions & SC_DISPLAY )
    ::std::cout << ::std::endl << sc_report_compose_message(rep) << 
        ::std::endl;

    if ( (actions & SC_LOG) && get_log_file_name() )
    {
        log_stream.update_file_name(get_log_file_name());

    *log_stream << rep.get_time() << ": "
        << sc_report_compose_message(rep) << ::std::endl;
    }
    if ( actions & SC_STOP )
    {
    sc_stop_here(rep.get_msg_type(), rep.get_severity());
    sc_stop();
    }
    if ( actions & SC_INTERRUPT )
    sc_interrupt_here(rep.get_msg_type(), rep.get_severity());

    if ( actions & SC_ABORT )
        sc_abort();

    if ( actions & SC_THROW ) {
        sc_process_b* proc_p = sc_get_current_process_b();
        if( proc_p && proc_p->is_unwinding() )
            proc_p->clear_unwinding();
        throw rep; 
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

比如，在https://blog.csdn.net/zgcjaxj/article/details/116210266 中的 代码中 void TestPlatform::PrintMessage() 中 增加一行 sc_start(1,SC_NS)，就会报 Error: (E554) sc_start called unexpectedly In file: …/…/…/src/sysc/kernel/sc_simcontext.cpp:1708的错误。

有些时候，我们可能希望忽略掉一些SystemC定义的Error 或者warning，比如上述E554，那么此时可以使用 sc_report_handler::set_handler(user_handler); 来替代 default_handler，其中user_handler为自定义的handler函数，可以对特定的Warning或Error 进行过滤。
由于sc_stop_here / get_log_file_name 等函数为 cpp内定义或 protect类型，自定义函数中不能使用，故一旦选择自定义handler函数，log信息不能被打印到 set_log_file_name()对应的 文件中了。

#include <iostream>
#include <fstream>
#include "systemc.h"

using namespace std;
using namespace sc_core;

void user_handler(const sc_report &rep,
                  const sc_actions &actions)
{
  if (std::string(rep.get_msg_type()) == "sc_start called unexpectedly")
  {
    std::cout << " here just bypass the E554" << std::endl;
  }
  else
  {
    if (actions & SC_DISPLAY)
      ::std::cout << ::std::endl
                  << sc_report_compose_message(rep) << ::std::endl;

    // if ((actions & SC_LOG) && get_log_file_name())
    // {
    //   log_stream.update_file_name(get_log_file_name());

    //   *log_stream << rep.get_time() << ": "
    //               << sc_report_compose_message(rep) << ::std::endl;
    // }
    // if (actions & SC_STOP)
    // {
    //    sc_stop_here(rep.get_msg_type(), rep.get_severity());
    //   sc_stop();
    // }
    // if (actions & SC_INTERRUPT)
    //   sc_interrupt_here(rep.get_msg_type(), rep.get_severity());

    if (actions & SC_ABORT)
      sc_abort();

    // if (actions & SC_THROW)
    // {
    //   sc_process_b *proc_p = sc_get_current_process_b();
    //   if (proc_p && proc_p->is_unwinding())
    //     proc_p->clear_unwinding();
    //   throw rep;
    // }
  }
}

class TestPlatform
    : public sc_module
{
public:
  SC_HAS_PROCESS(TestPlatform);

  TestPlatform(const sc_module_name &name)
      : sc_module(name), m_period(sc_time(1000, SC_PS))
  {
    SC_THREAD(PrintMessage);
  };

public:
  void PrintMessage();

  ~TestPlatform()
  {
    ;
  }

public:
  sc_time m_period;
};

void TestPlatform::PrintMessage()
{
  while (1)
  {
    sc_start(1, SC_NS);
    wait(m_period);
    SC_REPORT_INFO_VERB(name(), "this is a SC_LOW info message ", SC_LOW);
    SC_REPORT_INFO_VERB(name(), "this is a SC_MEDIUM info message ", SC_MEDIUM);
    SC_REPORT_INFO_VERB(name(), "this is a SC_HIGH info message ", SC_HIGH);
    SC_REPORT_INFO_VERB(name(), "this is a SC_FULL info message ", SC_FULL);
    SC_REPORT_INFO_VERB(name(), "this is a SC_DEBUG info message ", SC_DEBUG);

    SC_REPORT_WARNING(name(), "this is a SC_WARNING message "); // SC_WARNING
    SC_REPORT_WARNING(name(), "this is a SC_ERROR message ");
    SC_REPORT_WARNING(name(), "this is a SC_FATAL message ");

    cout << "SC_INFO counter " << sc_report_handler::get_count(SC_INFO) << endl;       // 得到的是SC_INFO打印的行数(SC_LOW + SC_MEDIUM + ....)
    cout << "SC_WARNING counter " << sc_report_handler::get_count(SC_WARNING) << endl; // 得到的是SC_WARNINNG打印的行数(SC_WARNING * 3 )a

    sc_report_handler::stop_after(SC_INFO, 500); // 当SC_INFO打印的行数达到500行 时 就调用st_stop（）
  }
}

int sc_main(int argc, char **argv)
{
  TestPlatform *m_platform;
  m_platform = new TestPlatform("TestPlatform");
  sc_report_handler::set_handler(user_handler);

  const char *filename = "./log_file";
  sc_report_handler::set_log_file_name(filename);
  sc_report_handler::set_actions(SC_INFO, SC_DISPLAY | SC_LOG);
  sc_report_handler::suppress(SC_LOG); // 抑制 SC_LOG，也就是不打印到log file
  // sc_report_handler::suppress();       // 不加任何参数，用于清除之前的suppress
  sc_report_handler::force(SC_LOG); // 强制打开SC_LOG，也就是此行代码之前 对于SC_LOG的suppress都失效
  // sc_report_handler::suppress(SC_DISPLAY);
  sc_report_handler::set_verbosity_level(sc_core::SC_MEDIUM); // 设置全局的 verbosity level，只针对SC_INFO

  sc_start(500, SC_NS);
  return 0;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114