src/base/misc.hh

   1 /*
   2  * Copyright (c) 2014 ARM Limited
   3  * All rights reserved
   4  *
   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.
  13  *
  14  * Copyright (c) 2002-2005 The Regents of The University of Michigan
  15  * All rights reserved.
  16  *
  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.
  27  *
  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.
  39  *
  40  * Authors: Nathan Binkert
  41  *          Dave Greene
  42  *          Andreas Sandberg
  43  */
  44
  45 #ifndef __BASE_MISC_HH__
  46 #define __BASE_MISC_HH__
  47
  48 #include <iostream>
  49
  50 #include "base/compiler.hh"
  51 #include "base/cprintf.hh"
  52
  53 #if defined(__SUNPRO_CC)
  54 #define __FUNCTION__ "how to fix me?"
  55 #endif
  56
  57 void __exit_epilogue(int code,
  58                      const char *func, const char *file, int line,
  59                      const char *format) M5_ATTR_NORETURN;
  60
  61 // General exit message, these functions will never return and will
  62 // either abort() if code is < 0 or exit with the code if >= 0
  63 template<typename ...Args> void
  64 __exit_message(const char *prefix, int code,
  65                const char *func, const char *file, int line,
  66                const char *format, const Args &...args) M5_ATTR_NORETURN;
  67 template<typename ...Args> void
  68 __exit_message(const char *prefix, int code,
  69                const char *func, const char *file, int line,
  70                const std::string &format, const Args &...args) M5_ATTR_NORETURN;
  71
  72 template<typename ...Args> void
  73 __exit_message(const char *prefix, int code,
  74                const char *func, const char *file, int line,
  75                const char *format, const Args &...args)
  76 {
  77     std::cerr << prefix << ": ";
  78     ccprintf(std::cerr, format, args...);
  79
  80     __exit_epilogue(code, func, file, line, format);
  81 }
  82
  83 template<typename ...Args> void
  84 __exit_message(const char *prefix, int code,
  85                const char *func, const char *file, int line,
  86                const std::string &format, const Args &...args)
  87 {
  88     __exit_message(prefix, code, func, file, line, format.c_str(),
  89                    args...);
  90 }
  91
  92 #define exit_message(prefix, code, ...)                                 \
  93     __exit_message(prefix, code, __FUNCTION__, __FILE__, __LINE__,      \
  94                    __VA_ARGS__)
  95
  96 //
  97 // This implements a cprintf based panic() function.  panic() should
  98 // be called when something happens that should never ever happen
  99 // regardless of what the user does (i.e., an acutal m5 bug).  panic()
 100 // calls abort which can dump core or enter the debugger.
 101 //
 102 //
 103 #define panic(...) exit_message("panic", -1, __VA_ARGS__)
 104
 105 //
 106 // This implements a cprintf based fatal() function.  fatal() should
 107 // be called when the simulation cannot continue due to some condition
 108 // that is the user's fault (bad configuration, invalid arguments,
 109 // etc.) and not a simulator bug.  fatal() calls  abort() like
 110 // panic() does.
 111 //
 112 #define fatal(...) exit_message("fatal", -1, __VA_ARGS__)
 113
 114 /**
 115  * Conditional panic macro that checks the supplied condition and only panics
 116  * if the condition is true and allows the programmer to specify diagnostic
 117  * printout.  Useful to replace if + panic, or if + print + assert, etc.
 118  *
 119  * @param cond Condition that is checked; if true -> panic
 120  * @param ...  Printf-based format string with arguments, extends printout.
 121  */
 122 #define panic_if(cond, ...) \
 123     do { \
 124         if ((cond)) \
 125             exit_message("panic condition "#cond" occurred", -1, __VA_ARGS__); \
 126     } while (0)
 127
 128
 129 /**
 130  * Conditional fatal macro that checks the supplied condition and only causes a
 131  * fatal error if the condition is true and allows the programmer to specify
 132  * diagnostic printout.  Useful to replace if + fatal, or if + print + assert,
 133  * etc.
 134  *
 135  * @param cond Condition that is checked; if true -> fatal
 136  * @param ...  Printf-based format string with arguments, extends printout.
 137  */
 138 #define fatal_if(cond, ...) \
 139     do { \
 140         if ((cond)) \
 141             exit_message("fatal condition "#cond" occurred", 1, __VA_ARGS__); \
 142     } while (0)
 143
 144
 145 void
 146 __base_message_epilogue(std::ostream &stream, bool verbose,
 147                         const char *func, const char *file, int line,
 148                         const char *format);
 149
 150 template<typename ...Args> void
 151 __base_message(std::ostream &stream, const char *prefix, bool verbose,
 152                const char *func, const char *file, int line,
 153                const char *format, const Args &...args)
 154 {
 155     stream << prefix << ": ";
 156     ccprintf(stream, format, args...);
 157
 158     __base_message_epilogue(stream, verbose, func, file, line, format);
 159 }
 160
 161 template<typename ...Args> void
 162 __base_message(std::ostream &stream, const char *prefix, bool verbose,
 163                const char *func, const char *file, int line,
 164                const std::string &format, const Args &...args)
 165 {
 166     __base_message(stream, prefix, verbose, func, file, line, format.c_str(),
 167                    args...);
 168 }
 169
 170 #define base_message(stream, prefix, verbose, ...)                      \
 171     __base_message(stream, prefix, verbose, __FUNCTION__, __FILE__, __LINE__, \
 172                    __VA_ARGS__)
 173
 174 // Only print the message the first time this expression is
 175 // encountered.  i.e.  This doesn't check the string itself and
 176 // prevent duplicate strings, this prevents the statement from
 177 // happening more than once. So, even if the arguments change and that
 178 // would have resulted in a different message thoes messages would be
 179 // supressed.
 180 #define base_message_once(...) do {                     \
 181         static bool once = false;                       \
 182         if (!once) {                                    \
 183             base_message(__VA_ARGS__);                  \
 184             once = true;                                \
 185         }                                               \
 186     } while (0)
 187
 188 #define cond_message(cond, ...) do {            \
 189         if (cond)                               \
 190             base_message(__VA_ARGS__);          \
 191     } while (0)
 192
 193 #define cond_message_once(cond, ...) do {               \
 194         static bool once = false;                       \
 195         if (!once && cond) {                            \
 196             base_message(__VA_ARGS__);                  \
 197             once = true;                                \
 198         }                                               \
 199     } while (0)
 200
 201
 202 extern bool want_warn, warn_verbose;
 203 extern bool want_info, info_verbose;
 204 extern bool want_hack, hack_verbose;
 205
 206 #define warn(...) \
 207     cond_message(want_warn, std::cerr, "warn", warn_verbose, __VA_ARGS__)
 208 #define inform(...) \
 209     cond_message(want_info, std::cout, "info", info_verbose, __VA_ARGS__)
 210 #define hack(...) \
 211     cond_message(want_hack, std::cerr, "hack", hack_verbose, __VA_ARGS__)
 212
 213 #define warn_once(...) \
 214     cond_message_once(want_warn, std::cerr, "warn", warn_verbose, __VA_ARGS__)
 215 #define inform_once(...) \
 216     cond_message_once(want_info, std::cout, "info", info_verbose, __VA_ARGS__)
 217 #define hack_once(...) \
 218     cond_message_once(want_hack, std::cerr, "hack", hack_verbose, __VA_ARGS__)
 219
 220 /**
 221  * The chatty assert macro will function like a normal assert, but will allow the
 222  * specification of additional, helpful material to aid debugging why the
 223  * assertion actually failed.  Like the normal assertion, the chatty_assert
 224  * will not be active in fast builds.
 225  *
 226  * @param cond Condition that is checked; if false -> assert
 227  * @param ...  Printf-based format string with arguments, extends printout.
 228  */
 229 #ifdef NDEBUG
 230 #define chatty_assert(cond, ...)
 231 #else //!NDEBUG
 232 #define chatty_assert(cond, ...)                                                \
 233     do {                                                                        \
 234         if (!(cond)) {                                                          \
 235             base_message(std::cerr, "assert("#cond") failing", 1, __VA_ARGS__); \
 236             assert(cond);                                                       \
 237         }                                                                       \
 238     } while (0)
 239 #endif // NDEBUG
 240 #endif // __BASE_MISC_HH__