2 * Copyright (c) 2014 ARM Limited
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
14 * Copyright (c) 2002-2005 The Regents of The University of Michigan
15 * All rights reserved.
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 * Authors: Nathan Binkert
44 #ifndef __BASE_MISC_HH__
45 #define __BASE_MISC_HH__
47 #include "base/compiler.hh"
48 #include "base/cprintf.hh"
49 #include "base/varargs.hh"
51 #if defined(__SUNPRO_CC)
52 #define __FUNCTION__ "how to fix me?"
55 // General exit message, these functions will never return and will
56 // either abort() if code is < 0 or exit with the code if >= 0
57 void __exit_message(const char *prefix, int code,
58 const char *func, const char *file, int line,
59 const char *format, CPRINTF_DECLARATION) M5_ATTR_NORETURN;
61 void __exit_message(const char *prefix, int code,
62 const char *func, const char *file, int line,
63 const std::string &format, CPRINTF_DECLARATION) M5_ATTR_NORETURN;
66 __exit_message(const char *prefix, int code,
67 const char *func, const char *file, int line,
68 const std::string& format, CPRINTF_DEFINITION)
70 __exit_message(prefix, code, func, file, line, format.c_str(),
74 #define exit_message(prefix, code, ...) \
75 __exit_message(prefix, code, __FUNCTION__, __FILE__, __LINE__, \
79 // This implements a cprintf based panic() function. panic() should
80 // be called when something happens that should never ever happen
81 // regardless of what the user does (i.e., an acutal m5 bug). panic()
82 // calls abort which can dump core or enter the debugger.
85 #define panic(...) exit_message("panic", -1, __VA_ARGS__)
88 // This implements a cprintf based fatal() function. fatal() should
89 // be called when the simulation cannot continue due to some condition
90 // that is the user's fault (bad configuration, invalid arguments,
91 // etc.) and not a simulator bug. fatal() calls abort() like
94 #define fatal(...) exit_message("fatal", -1, __VA_ARGS__)
97 * Conditional panic macro that checks the supplied condition and only panics
98 * if the condition is true and allows the programmer to specify diagnostic
99 * printout. Useful to replace if + panic, or if + print + assert, etc.
101 * @param cond Condition that is checked; if true -> panic
102 * @param ... Printf-based format string with arguments, extends printout.
104 #define panic_if(cond, ...) \
107 exit_message("panic condition "#cond" occurred", -1, __VA_ARGS__); \
112 * Conditional fatal macro that checks the supplied condition and only causes a
113 * fatal error if the condition is true and allows the programmer to specify
114 * diagnostic printout. Useful to replace if + fatal, or if + print + assert,
117 * @param cond Condition that is checked; if true -> fatal
118 * @param ... Printf-based format string with arguments, extends printout.
120 #define fatal_if(cond, ...) \
123 exit_message("fatal condition "#cond" occurred", 1, __VA_ARGS__); \
128 __base_message(std::ostream &stream, const char *prefix, bool verbose,
129 const char *func, const char *file, int line,
130 const char *format, CPRINTF_DECLARATION);
133 __base_message(std::ostream &stream, const char *prefix, bool verbose,
134 const char *func, const char *file, int line,
135 const std::string &format, CPRINTF_DECLARATION)
137 __base_message(stream, prefix, verbose, func, file, line, format.c_str(),
141 #define base_message(stream, prefix, verbose, ...) \
142 __base_message(stream, prefix, verbose, __FUNCTION__, __FILE__, __LINE__, \
145 // Only print the message the first time this expression is
146 // encountered. i.e. This doesn't check the string itself and
147 // prevent duplicate strings, this prevents the statement from
148 // happening more than once. So, even if the arguments change and that
149 // would have resulted in a different message thoes messages would be
151 #define base_message_once(...) do { \
152 static bool once = false; \
154 base_message(__VA_ARGS__); \
159 #define cond_message(cond, ...) do { \
161 base_message(__VA_ARGS__); \
164 #define cond_message_once(cond, ...) do { \
165 static bool once = false; \
166 if (!once && cond) { \
167 base_message(__VA_ARGS__); \
173 extern bool want_warn, warn_verbose;
174 extern bool want_info, info_verbose;
175 extern bool want_hack, hack_verbose;
178 cond_message(want_warn, std::cerr, "warn", warn_verbose, __VA_ARGS__)
179 #define inform(...) \
180 cond_message(want_info, std::cout, "info", info_verbose, __VA_ARGS__)
182 cond_message(want_hack, std::cerr, "hack", hack_verbose, __VA_ARGS__)
184 #define warn_once(...) \
185 cond_message_once(want_warn, std::cerr, "warn", warn_verbose, __VA_ARGS__)
186 #define inform_once(...) \
187 cond_message_once(want_info, std::cout, "info", info_verbose, __VA_ARGS__)
188 #define hack_once(...) \
189 cond_message_once(want_hack, std::cerr, "hack", hack_verbose, __VA_ARGS__)
192 * The chatty assert macro will function like a normal assert, but will allow the
193 * specification of additional, helpful material to aid debugging why the
194 * assertion actually failed. Like the normal assertion, the chatty_assert
195 * will not be active in fast builds.
197 * @param cond Condition that is checked; if false -> assert
198 * @param ... Printf-based format string with arguments, extends printout.
201 #define chatty_assert(cond, ...)
203 #define chatty_assert(cond, ...) \
206 base_message(std::cerr, "assert("#cond") failing", 1, __VA_ARGS__); \
211 #endif // __BASE_MISC_HH__