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 #include <sys/time.h>
  27 #include <sys/resource.h>
  28
  29 YOSYS_NAMESPACE_BEGIN
  30
  31 #define S__LINE__sub2(x) #x
  32 #define S__LINE__sub1(x) S__LINE__sub2(x)
  33 #define S__LINE__ S__LINE__sub1(__LINE__)
  34
  35 struct log_cmd_error_expection { };
  36
  37 extern std::vector<FILE*> log_files;
  38 extern FILE *log_errfile;
  39 extern class SHA1 *log_hasher;
  40
  41 extern bool log_time;
  42 extern bool log_cmd_error_throw;
  43 extern int log_verbose_level;
  44
  45 void logv(const char *format, va_list ap);
  46 void logv_header(const char *format, va_list ap);
  47 void logv_error(const char *format, va_list ap) __attribute__ ((noreturn));
  48
  49 void log(const char *format, ...)  __attribute__ ((format (printf, 1, 2)));
  50 void log_header(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
  51 void log_error(const char *format, ...) __attribute__ ((format (printf, 1, 2))) __attribute__ ((noreturn));
  52 void log_cmd_error(const char *format, ...) __attribute__ ((format (printf, 1, 2))) __attribute__ ((noreturn));
  53
  54 void log_push();
  55 void log_pop();
  56
  57 void log_reset_stack();
  58 void log_flush();
  59
  60 const char *log_signal(const RTLIL::SigSpec &sig, bool autoint = true);
  61 const char *log_id(RTLIL::IdString id);
  62
  63 template<typename T> static inline const char *log_id(T *obj) {
  64         return log_id(obj->name);
  65 }
  66
  67 void log_cell(RTLIL::Cell *cell, std::string indent = "");
  68
  69 #define log_abort() log_error("Abort in %s:%d.\n", __FILE__, __LINE__)
  70 #define log_assert(_assert_expr_) do { if (_assert_expr_) break; log_error("Assert `%s' failed in %s:%d.\n", #_assert_expr_, __FILE__, __LINE__); } while (0)
  71 #define log_ping() log("-- %s:%d %s --\n", __FILE__, __LINE__, __PRETTY_FUNCTION__)
  72
  73
  74 // ---------------------------------------------------
  75 // This is the magic behind the code coverage counters
  76 // ---------------------------------------------------
  77
  78 #if defined(__linux__) && !defined(NDEBUG)
  79 #define COVER_ACTIVE
  80
  81 #define cover(_id) do { \
  82     static CoverData __d __attribute__((section("yosys_cover_list"), aligned(1))) = { __FILE__, __FUNCTION__, _id, __LINE__, 0 }; \
  83     __d.counter++; \
  84 } while (0)
  85
  86 struct CoverData {
  87         const char *file, *func, *id;
  88         int line, counter;
  89 } __attribute__ ((packed));
  90
  91 // this two symbols are created by the linker for the "yosys_cover_list" ELF section
  92 extern "C" struct CoverData __start_yosys_cover_list[];
  93 extern "C" struct CoverData __stop_yosys_cover_list[];
  94
  95 extern std::map<std::string, std::pair<std::string, int>> extra_coverage_data;
  96
  97 void cover_extra(std::string parent, std::string id, bool increment = true);
  98 std::map<std::string, std::pair<std::string, int>> get_coverage_data();
  99
 100 #define cover_list(_id, ...) do { cover(_id); \
 101         std::string r = cover_list_worker(_id, __VA_ARGS__); \
 102         log_assert(r.empty()); \
 103 } while (0)
 104
 105 static inline std::string cover_list_worker(std::string, std::string last) {
 106         return last;
 107 }
 108
 109 template<typename... T>
 110 std::string cover_list_worker(std::string prefix, std::string first, T... rest) {
 111         std::string selected = cover_list_worker(prefix, rest...);
 112         cover_extra(prefix, prefix + "." + first, first == selected);
 113         return first == selected ? "" : selected;
 114 }
 115
 116 #else
 117 #  define cover(...) do { } while (0)
 118 #  define cover_list(...) do { } while (0)
 119 #endif
 120
 121
 122 // ------------------------------------------------------------
 123 // everything below this line are utilities for troubleshooting
 124 // ------------------------------------------------------------
 125
 126 // simple timer for performance measurements
 127 // toggle the '#if 1' to get a baseline for the perormance penalty added by the measurement
 128 struct PerformanceTimer
 129 {
 130 #if 1
 131         int64_t total_ns;
 132
 133         PerformanceTimer() {
 134                 total_ns = 0;
 135         }
 136
 137         static int64_t query() {
 138 #if defined(_POSIX_TIMERS) && (_POSIX_TIMERS > 0)
 139                 struct timespec ts;
 140                 clock_gettime(CLOCK_PROCESS_CPUTIME_ID, &ts);
 141                 return int64_t(ts.tv_sec)*1000000000 + ts.tv_nsec;
 142 #elif defined(RUSAGE_SELF)
 143                 struct rusage rusage;
 144                 int64_t t;
 145                 if (getrusage(RUSAGE_SELF, &rusage) == -1) {
 146                         log_cmd_error("getrusage failed!\n");
 147                         log_abort();
 148                 }
 149                 t = 1000000000ULL * (int64_t) rusage.ru_utime.tv_sec + (int64_t) rusage.ru_utime.tv_usec * 1000ULL;
 150                 t += 1000000000ULL * (int64_t) rusage.ru_stime.tv_sec + (int64_t) rusage.ru_stime.tv_usec * 1000ULL;
 151                 return t;
 152 #else
 153         #error Dont know how to measure per-process CPU time. Need alternative method (times()/clocks()/gettimeofday()?).
 154 #endif
 155         }
 156
 157         void reset() {
 158                 total_ns = 0;
 159         }
 160
 161         void begin() {
 162                 total_ns -= query();
 163         }
 164
 165         void end() {
 166                 total_ns += query();
 167         }
 168
 169         float sec() const {
 170                 return total_ns * 1e-9;
 171         }
 172 #else
 173         static int64_t query() { return 0; }
 174         void reset() { }
 175         void begin() { }
 176         void end() { }
 177         float sec() const { return 0; }
 178 #endif
 179 };
 180
 181 // simple API for quickly dumping values when debugging
 182
 183 static inline void log_dump_val_worker(short v) { log("%d", v); }
 184 static inline void log_dump_val_worker(unsigned short v) { log("%u", v); }
 185 static inline void log_dump_val_worker(int v) { log("%d", v); }
 186 static inline void log_dump_val_worker(unsigned int v) { log("%u", v); }
 187 static inline void log_dump_val_worker(long int v) { log("%ld", v); }
 188 static inline void log_dump_val_worker(unsigned long int v) { log("%lu", v); }
 189 static inline void log_dump_val_worker(long long int v) { log("%lld", v); }
 190 static inline void log_dump_val_worker(unsigned long long int v) { log("%lld", v); }
 191 static inline void log_dump_val_worker(char c) { log(c >= 32 && c < 127 ? "'%c'" : "'\\x%02x'", c); }
 192 static inline void log_dump_val_worker(unsigned char c) { log(c >= 32 && c < 127 ? "'%c'" : "'\\x%02x'", c); }
 193 static inline void log_dump_val_worker(bool v) { log("%s", v ? "true" : "false"); }
 194 static inline void log_dump_val_worker(double v) { log("%f", v); }
 195 static inline void log_dump_val_worker(char *v) { log("%s", v); }
 196 static inline void log_dump_val_worker(const char *v) { log("%s", v); }
 197 static inline void log_dump_val_worker(std::string v) { log("%s", v.c_str()); }
 198 static inline void log_dump_val_worker(PerformanceTimer p) { log("%f seconds", p.sec()); }
 199 static inline void log_dump_args_worker(const char *p) { log_assert(*p == 0); }
 200 void log_dump_val_worker(RTLIL::SigSpec v);
 201
 202 template<typename T>
 203 static inline void log_dump_val_worker(T *ptr) { log("%p", ptr); }
 204
 205 template<typename T, typename ... Args>
 206 void log_dump_args_worker(const char *p, T first, Args ... args)
 207 {
 208         int next_p_state = 0;
 209         const char *next_p = p;
 210         while (*next_p && (next_p_state != 0 || *next_p != ',')) {
 211                 if (*next_p == '"')
 212                         do {
 213                                 next_p++;
 214                                 while (*next_p == '\\' && *(next_p + 1))
 215                                         next_p += 2;
 216                         } while (*next_p && *next_p != '"');
 217                 if (*next_p == '\'') {
 218                         next_p++;
 219                         if (*next_p == '\\')
 220                                 next_p++;
 221                         if (*next_p)
 222                                 next_p++;
 223                 }
 224                 if (*next_p == '(' || *next_p == '[' || *next_p == '{')
 225                         next_p_state++;
 226                 if ((*next_p == ')' || *next_p == ']' || *next_p == '}') && next_p_state > 0)
 227                         next_p_state--;
 228                 next_p++;
 229         }
 230         log("\n\t%.*s => ", int(next_p - p), p);
 231         if (*next_p == ',')
 232                 next_p++;
 233         while (*next_p == ' ' || *next_p == '\t' || *next_p == '\r' || *next_p == '\n')
 234                 next_p++;
 235         log_dump_val_worker(first);
 236         log_dump_args_worker(next_p, args ...);
 237 }
 238
 239 #define log_dump(...) do { \
 240         log("DEBUG DUMP IN %s AT %s:%d:", __PRETTY_FUNCTION__, __FILE__, __LINE__); \
 241         log_dump_args_worker(#__VA_ARGS__, __VA_ARGS__); \
 242         log("\n"); \
 243 } while (0)
 244
 245 YOSYS_NAMESPACE_END
 246
 247 #endif