kernel/log.h

   1 /*
   2  *  yosys -- Yosys Open SYnthesis Suite
   3  *
   4  *  Copyright (C) 2012  Clifford Wolf <clifford@clifford.at>
   5  *
   6  *  Permission to use, copy, modify, and/or distribute this software for any
   7  *  purpose with or without fee is hereby granted, provided that the above
   8  *  copyright notice and this permission notice appear in all copies.
   9  *
  10  *  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  11  *  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12  *  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  13  *  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  14  *  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  15  *  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  16  *  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  17  *
  18  */
  19
  20 #include "kernel/yosys.h"
  21
  22 #ifndef LOG_H
  23 #define LOG_H
  24
  25 #include <time.h>
  26
  27 #ifndef _WIN32
  28 #  include <sys/time.h>
  29 #  include <sys/resource.h>
  30 #endif
  31
  32 // from libs/sha1/sha1.h
  33 class SHA1;
  34
  35 YOSYS_NAMESPACE_BEGIN
  36
  37 #define S__LINE__sub2(x) #x
  38 #define S__LINE__sub1(x) S__LINE__sub2(x)
  39 #define S__LINE__ S__LINE__sub1(__LINE__)
  40
  41 struct log_cmd_error_exception { };
  42
  43 extern std::vector<FILE*> log_files;
  44 extern std::vector<std::ostream*> log_streams;
  45 extern FILE *log_errfile;
  46 extern SHA1 *log_hasher;
  47
  48 extern bool log_time;
  49 extern bool log_cmd_error_throw;
  50 extern int log_verbose_level;
  51
  52 void logv(const char *format, va_list ap);
  53 void logv_header(const char *format, va_list ap);
  54 void logv_warning(const char *format, va_list ap);
  55 YS_NORETURN void logv_error(const char *format, va_list ap) YS_ATTRIBUTE(noreturn);
  56
  57 void log(const char *format, ...)  YS_ATTRIBUTE(format(printf, 1, 2));
  58 void log_header(const char *format, ...) YS_ATTRIBUTE(format(printf, 1, 2));
  59 void log_warning(const char *format, ...) YS_ATTRIBUTE(format(printf, 1, 2));
  60 YS_NORETURN void log_error(const char *format, ...) YS_ATTRIBUTE(format(printf, 1, 2), noreturn);
  61 YS_NORETURN void log_cmd_error(const char *format, ...) YS_ATTRIBUTE(format(printf, 1, 2), noreturn);
  62
  63 void log_spacer();
  64 void log_push();
  65 void log_pop();
  66
  67 void log_reset_stack();
  68 void log_flush();
  69
  70 const char *log_signal(const RTLIL::SigSpec &sig, bool autoint = true);
  71 const char *log_id(RTLIL::IdString id);
  72
  73 template<typename T> static inline const char *log_id(T *obj) {
  74         return log_id(obj->name);
  75 }
  76
  77 void log_cell(RTLIL::Cell *cell, std::string indent = "");
  78
  79 static inline void log_assert_worker(bool cond, const char *expr, const char *file, int line) {
  80         if (!cond) log_error("Assert `%s' failed in %s:%d.\n", expr, file, line);
  81 }
  82
  83 #define log_abort() YOSYS_NAMESPACE_PREFIX log_error("Abort in %s:%d.\n", __FILE__, __LINE__)
  84 #define log_assert(_assert_expr_) YOSYS_NAMESPACE_PREFIX log_assert_worker(_assert_expr_, #_assert_expr_, __FILE__, __LINE__)
  85 #define log_ping() YOSYS_NAMESPACE_PREFIX log("-- %s:%d %s --\n", __FILE__, __LINE__, __PRETTY_FUNCTION__)
  86
  87
  88 // ---------------------------------------------------
  89 // This is the magic behind the code coverage counters
  90 // ---------------------------------------------------
  91
  92 #ifdef YOSYS_ENABLE_COVER
  93
  94 #define cover(_id) do { \
  95     static CoverData __d YS_ATTRIBUTE(section("yosys_cover_list"), aligned(1), used) = { __FILE__, __FUNCTION__, _id, __LINE__, 0 }; \
  96     __d.counter++; \
  97 } while (0)
  98
  99 struct CoverData {
 100         const char *file, *func, *id;
 101         int line, counter;
 102 } YS_ATTRIBUTE(packed);
 103
 104 // this two symbols are created by the linker for the "yosys_cover_list" ELF section
 105 extern "C" struct CoverData __start_yosys_cover_list[];
 106 extern "C" struct CoverData __stop_yosys_cover_list[];
 107
 108 extern std::map<std::string, std::pair<std::string, int>> extra_coverage_data;
 109
 110 void cover_extra(std::string parent, std::string id, bool increment = true);
 111 std::map<std::string, std::pair<std::string, int>> get_coverage_data();
 112
 113 #define cover_list(_id, ...) do { cover(_id); \
 114         std::string r = cover_list_worker(_id, __VA_ARGS__); \
 115         log_assert(r.empty()); \
 116 } while (0)
 117
 118 static inline std::string cover_list_worker(std::string, std::string last) {
 119         return last;
 120 }
 121
 122 template<typename... T>
 123 std::string cover_list_worker(std::string prefix, std::string first, T... rest) {
 124         std::string selected = cover_list_worker(prefix, rest...);
 125         cover_extra(prefix, prefix + "." + first, first == selected);
 126         return first == selected ? "" : selected;
 127 }
 128
 129 #else
 130 #  define cover(...) do { } while (0)
 131 #  define cover_list(...) do { } while (0)
 132 #endif
 133
 134
 135 // ------------------------------------------------------------
 136 // everything below this line are utilities for troubleshooting
 137 // ------------------------------------------------------------
 138
 139 // simple timer for performance measurements
 140 // toggle the '#if 1' to get a baseline for the perormance penalty added by the measurement
 141 struct PerformanceTimer
 142 {
 143 #if 1
 144         int64_t total_ns;
 145
 146         PerformanceTimer() {
 147                 total_ns = 0;
 148         }
 149
 150         static int64_t query() {
 151 #if defined(_POSIX_TIMERS) && (_POSIX_TIMERS > 0)
 152                 struct timespec ts;
 153                 clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &ts);
 154                 return int64_t(ts.tv_sec)*1000000000 + ts.tv_nsec;
 155 #elif defined(RUSAGE_SELF)
 156                 struct rusage rusage;
 157                 int64_t t;
 158                 if (getrusage(RUSAGE_SELF, &rusage) == -1) {
 159                         log_cmd_error("getrusage failed!\n");
 160                         log_abort();
 161                 }
 162                 t = 1000000000ULL * (int64_t) rusage.ru_utime.tv_sec + (int64_t) rusage.ru_utime.tv_usec * 1000ULL;
 163                 t += 1000000000ULL * (int64_t) rusage.ru_stime.tv_sec + (int64_t) rusage.ru_stime.tv_usec * 1000ULL;
 164                 return t;
 165 #elif _WIN32
 166                 return 0;
 167 #else
 168         #error Dont know how to measure per-process CPU time. Need alternative method (times()/clocks()/gettimeofday()?).
 169 #endif
 170         }
 171
 172         void reset() {
 173                 total_ns = 0;
 174         }
 175
 176         void begin() {
 177                 total_ns -= query();
 178         }
 179
 180         void end() {
 181                 total_ns += query();
 182         }
 183
 184         float sec() const {
 185                 return total_ns * 1e-9f;
 186         }
 187 #else
 188         static int64_t query() { return 0; }
 189         void reset() { }
 190         void begin() { }
 191         void end() { }
 192         float sec() const { return 0; }
 193 #endif
 194 };
 195
 196 // simple API for quickly dumping values when debugging
 197
 198 static inline void log_dump_val_worker(short v) { log("%d", v); }
 199 static inline void log_dump_val_worker(unsigned short v) { log("%u", v); }
 200 static inline void log_dump_val_worker(int v) { log("%d", v); }
 201 static inline void log_dump_val_worker(unsigned int v) { log("%u", v); }
 202 static inline void log_dump_val_worker(long int v) { log("%ld", v); }
 203 static inline void log_dump_val_worker(unsigned long int v) { log("%lu", v); }
 204 #ifndef _WIN32
 205 static inline void log_dump_val_worker(long long int v) { log("%lld", v); }
 206 static inline void log_dump_val_worker(unsigned long long int v) { log("%lld", v); }
 207 #endif
 208 static inline void log_dump_val_worker(char c) { log(c >= 32 && c < 127 ? "'%c'" : "'\\x%02x'", c); }
 209 static inline void log_dump_val_worker(unsigned char c) { log(c >= 32 && c < 127 ? "'%c'" : "'\\x%02x'", c); }
 210 static inline void log_dump_val_worker(bool v) { log("%s", v ? "true" : "false"); }
 211 static inline void log_dump_val_worker(double v) { log("%f", v); }
 212 static inline void log_dump_val_worker(char *v) { log("%s", v); }
 213 static inline void log_dump_val_worker(const char *v) { log("%s", v); }
 214 static inline void log_dump_val_worker(std::string v) { log("%s", v.c_str()); }
 215 static inline void log_dump_val_worker(PerformanceTimer p) { log("%f seconds", p.sec()); }
 216 static inline void log_dump_args_worker(const char *p) { log_assert(*p == 0); }
 217 void log_dump_val_worker(RTLIL::SigSpec v);
 218
 219 template<typename T>
 220 static inline void log_dump_val_worker(T *ptr) { log("%p", ptr); }
 221
 222 template<typename T, typename ... Args>
 223 void log_dump_args_worker(const char *p, T first, Args ... args)
 224 {
 225         int next_p_state = 0;
 226         const char *next_p = p;
 227         while (*next_p && (next_p_state != 0 || *next_p != ',')) {
 228                 if (*next_p == '"')
 229                         do {
 230                                 next_p++;
 231                                 while (*next_p == '\\' && *(next_p + 1))
 232                                         next_p += 2;
 233                         } while (*next_p && *next_p != '"');
 234                 if (*next_p == '\'') {
 235                         next_p++;
 236                         if (*next_p == '\\')
 237                                 next_p++;
 238                         if (*next_p)
 239                                 next_p++;
 240                 }
 241                 if (*next_p == '(' || *next_p == '[' || *next_p == '{')
 242                         next_p_state++;
 243                 if ((*next_p == ')' || *next_p == ']' || *next_p == '}') && next_p_state > 0)
 244                         next_p_state--;
 245                 next_p++;
 246         }
 247         log("\n\t%.*s => ", int(next_p - p), p);
 248         if (*next_p == ',')
 249                 next_p++;
 250         while (*next_p == ' ' || *next_p == '\t' || *next_p == '\r' || *next_p == '\n')
 251                 next_p++;
 252         log_dump_val_worker(first);
 253         log_dump_args_worker(next_p, args ...);
 254 }
 255
 256 #define log_dump(...) do { \
 257         log("DEBUG DUMP IN %s AT %s:%d:", __PRETTY_FUNCTION__, __FILE__, __LINE__); \
 258         log_dump_args_worker(#__VA_ARGS__, __VA_ARGS__); \
 259         log("\n"); \
 260 } while (0)
 261
 262 YOSYS_NAMESPACE_END
 263
 264 #endif