sc_report_handler.hh revision 12911 
1/*
2 * Copyright 2018 Google, Inc.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met: redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer;
8 * redistributions in binary form must reproduce the above copyright
9 * notice, this list of conditions and the following disclaimer in the
10 * documentation and/or other materials provided with the distribution;
11 * neither the name of the copyright holders nor the names of its
12 * contributors may be used to endorse or promote products derived from
13 * this software without specific prior written permission.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 * Authors: Gabe Black
28 */
29
30#ifndef __SYSTEMC_EXT_UTIL_SC_REPORT_HANDLER_HH__
31#define __SYSTEMC_EXT_UTIL_SC_REPORT_HANDLER_HH__
32
33#include "sc_report.hh" // for sc_severity
34
35namespace sc_core
36{
37
38typedef unsigned sc_actions;
39
40enum
41{
42    SC_UNSPECIFIED = 0x0000,
43    SC_DO_NOTHING = 0x0001,
44    SC_THROW = 0x0002,
45    SC_LOG = 0x0004,
46    SC_DISPLAY = 0x0008,
47    SC_CACHE_REPORT = 0x0010,
48    SC_INTERRUPT = 0x0020,
49    SC_STOP = 0x0040,
50    SC_ABORT = 0x0080,
51
52    // The spec says these should be macros, but that breaks the build for the
53    // regression tests since they refer to, for instance,
54    // sc_core::SC_DEFAULT_INFO_ACTIONS.
55    SC_DEFAULT_INFO_ACTIONS = SC_LOG | SC_DISPLAY,
56    SC_DEFAULT_WARNING_ACTIONS = SC_LOG | SC_DISPLAY,
57    SC_DEFAULT_ERROR_ACTIONS = SC_LOG | SC_CACHE_REPORT | SC_THROW,
58    SC_DEFAULT_FATAL_ACTIONS = SC_LOG | SC_DISPLAY | SC_CACHE_REPORT | SC_ABORT
59};
60
61typedef void (*sc_report_handler_proc)(const sc_report &, const sc_actions &);
62
63class sc_report_handler
64{
65  public:
66    static void report(sc_severity, const char *msg_type, const char *msg,
67                       const char *file, int line);
68    static void report(sc_severity, const char *msg_type, const char *msg,
69                       int verbosity, const char *file, int line);
70
71    // Deprecated
72    static void report(sc_severity, int id, const char *msg, const char *file,
73                       int line);
74
75    static sc_actions set_actions(sc_severity, sc_actions=SC_UNSPECIFIED);
76    static sc_actions set_actions(const char *msg_type,
77                                  sc_actions=SC_UNSPECIFIED);
78    static sc_actions set_actions(const char *msg_type, sc_severity,
79                                  sc_actions=SC_UNSPECIFIED);
80
81    static int stop_after(sc_severity, int limit=-1);
82    static int stop_after(const char *msg_type, int limit=-1);
83    static int stop_after(const char *msg_type, sc_severity,
84                          sc_actions=SC_UNSPECIFIED);
85
86    static int get_count(sc_severity);
87    static int get_count(const char *msg_type);
88    static int get_count(const char *msg_type, sc_severity);
89
90    int set_verbosity_level(int);
91    int get_verbosity_level();
92
93    static sc_actions suppress(sc_actions);
94    static sc_actions suppress();
95    static sc_actions force(sc_actions);
96    static sc_actions force();
97
98    static sc_actions set_catch_actions(sc_actions);
99    static sc_actions get_catch_actions();
100
101    static void set_handler(sc_report_handler_proc);
102    static void default_handler(const sc_report &, const sc_actions &);
103    static sc_actions get_new_action_id();
104
105    static sc_report *get_cached_report();
106    static void clear_cached_report();
107
108    static bool set_log_file_name(const char *);
109    static const char *get_log_file_name();
110};
111
112#define SC_REPORT_INFO_VERB(msg_type, msg, verbosity) \
113        ::sc_core::sc_report_handler::report( \
114            ::sc_core::SC_INFO, msg_type, msg, verbosity, __FILE__, __LINE__)
115
116#define SC_REPORT_INFO(msg_type, msg) \
117        ::sc_core::sc_report_handler::report( \
118            ::sc_core::SC_INFO, msg_type, msg, __FILE__, __LINE__)
119
120#define SC_REPORT_WARNING(msg_type, msg) \
121        ::sc_core::sc_report_handler::report( \
122            ::sc_core::SC_WARNING, msg_type, msg, __FILE__, __LINE__)
123
124#define SC_REPORT_ERROR(msg_type, msg) \
125        ::sc_core::sc_report_handler::report( \
126            ::sc_core::SC_ERROR, msg_type, msg, __FILE__, __LINE__)
127
128#define SC_REPORT_FATAL(msg_type, msg) \
129        ::sc_core::sc_report_handler::report( \
130            ::sc_core::SC_FATAL, msg_type, msg, __FILE__, __LINE__)
131
132#define sc_assert(expr) \
133        ((void)((expr) ? 0 : (SC_REPORT_FATAL("assertion failed", #expr), 0)))
134
135void sc_interrupt_here(const char *msg_type, sc_severity);
136void sc_stop_here(const char *msg_type, sc_severity);
137
138} // namespace sc_core
139
140#endif  //__SYSTEMC_EXT_UTIL_SC_REPORT_HANDLER_HH__
141