kernel/log.cc

   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 #include "libs/sha1/sha1.h"
  22 #include "backends/ilang/ilang_backend.h"
  23
  24 #if !defined(_WIN32) || defined(__MINGW32__)
  25 #  include <sys/time.h>
  26 #endif
  27
  28 #ifdef __linux__
  29 #  include <dlfcn.h>
  30 #endif
  31
  32 #include <stdlib.h>
  33 #include <stdio.h>
  34 #include <string.h>
  35 #include <stdarg.h>
  36 #include <vector>
  37 #include <list>
  38
  39 YOSYS_NAMESPACE_BEGIN
  40
  41 std::vector<FILE*> log_files;
  42 std::vector<std::ostream*> log_streams;
  43 std::map<std::string, std::set<std::string>> log_hdump;
  44 std::vector<std::regex> log_warn_regexes;
  45 bool log_hdump_all = false;
  46 FILE *log_errfile = NULL;
  47 SHA1 *log_hasher = NULL;
  48
  49 bool log_time = false;
  50 bool log_error_stderr = false;
  51 bool log_cmd_error_throw = false;
  52 bool log_quiet_warnings = false;
  53 int log_verbose_level;
  54 string log_last_error;
  55
  56 vector<int> header_count;
  57 pool<RTLIL::IdString> log_id_cache;
  58 vector<shared_str> string_buf;
  59 int string_buf_index = -1;
  60
  61 static struct timeval initial_tv = { 0, 0 };
  62 static bool next_print_log = false;
  63 static int log_newline_count = 0;
  64
  65 #if defined(_WIN32) && !defined(__MINGW32__)
  66 // this will get time information and return it in timeval, simulating gettimeofday()
  67 int gettimeofday(struct timeval *tv, struct timezone *tz)
  68 {
  69         LARGE_INTEGER counter;
  70         LARGE_INTEGER freq;
  71
  72         QueryPerformanceFrequency(&freq);
  73         QueryPerformanceCounter(&counter);
  74
  75         counter.QuadPart *= 1000000;
  76         counter.QuadPart /= freq.QuadPart;
  77
  78         tv->tv_sec = long(counter.QuadPart / 1000000);
  79         tv->tv_usec = counter.QuadPart % 1000000;
  80
  81         return 0;
  82 }
  83 #endif
  84
  85 void logv(const char *format, va_list ap)
  86 {
  87         while (format[0] == '\n' && format[1] != 0) {
  88                 log("\n");
  89                 format++;
  90         }
  91
  92         std::string str = vstringf(format, ap);
  93
  94         if (str.empty())
  95                 return;
  96
  97         size_t nnl_pos = str.find_last_not_of('\n');
  98         if (nnl_pos == std::string::npos)
  99                 log_newline_count += GetSize(str);
 100         else
 101                 log_newline_count = GetSize(str) - nnl_pos - 1;
 102
 103         if (log_hasher)
 104                 log_hasher->update(str);
 105
 106         if (log_time)
 107         {
 108                 std::string time_str;
 109
 110                 if (next_print_log || initial_tv.tv_sec == 0) {
 111                         next_print_log = false;
 112                         struct timeval tv;
 113                         gettimeofday(&tv, NULL);
 114                         if (initial_tv.tv_sec == 0)
 115                                 initial_tv = tv;
 116                         if (tv.tv_usec < initial_tv.tv_usec) {
 117                                 tv.tv_sec--;
 118                                 tv.tv_usec += 1000000;
 119                         }
 120                         tv.tv_sec -= initial_tv.tv_sec;
 121                         tv.tv_usec -= initial_tv.tv_usec;
 122                         time_str += stringf("[%05d.%06d] ", int(tv.tv_sec), int(tv.tv_usec));
 123                 }
 124
 125                 if (format[0] && format[strlen(format)-1] == '\n')
 126                         next_print_log = true;
 127
 128                 for (auto f : log_files)
 129                         fputs(time_str.c_str(), f);
 130
 131                 for (auto f : log_streams)
 132                         *f << time_str;
 133         }
 134
 135         for (auto f : log_files)
 136                 fputs(str.c_str(), f);
 137
 138         for (auto f : log_streams)
 139                 *f << str;
 140
 141         static std::string linebuffer;
 142         static bool log_warn_regex_recusion_guard = false;
 143
 144         if (!log_warn_regex_recusion_guard)
 145         {
 146                 log_warn_regex_recusion_guard = true;
 147
 148                 if (log_warn_regexes.empty())
 149                 {
 150                         linebuffer.clear();
 151                 }
 152                 else
 153                 {
 154                         linebuffer += str;
 155
 156                         if (!linebuffer.empty() && linebuffer.back() == '\n') {
 157                                 for (auto &re : log_warn_regexes)
 158                                         if (std::regex_search(linebuffer, re))
 159                                                 log_warning("Found log message matching -W regex:\n%s", str.c_str());
 160                                 linebuffer.clear();
 161                         }
 162                 }
 163
 164                 log_warn_regex_recusion_guard = false;
 165         }
 166 }
 167
 168 void logv_header(RTLIL::Design *design, const char *format, va_list ap)
 169 {
 170         bool pop_errfile = false;
 171
 172         log_spacer();
 173         if (header_count.size() > 0)
 174                 header_count.back()++;
 175
 176         if (int(header_count.size()) <= log_verbose_level && log_errfile != NULL) {
 177                 log_files.push_back(log_errfile);
 178                 pop_errfile = true;
 179         }
 180
 181         std::string header_id;
 182
 183         for (int c : header_count)
 184                 header_id += stringf("%s%d", header_id.empty() ? "" : ".", c);
 185
 186         log("%s. ", header_id.c_str());
 187         logv(format, ap);
 188         log_flush();
 189
 190         if (log_hdump_all)
 191                 log_hdump[header_id].insert("yosys_dump_" + header_id + ".il");
 192
 193         if (log_hdump.count(header_id) && design != nullptr)
 194                 for (auto &filename : log_hdump.at(header_id)) {
 195                         log("Dumping current design to '%s'.\n", filename.c_str());
 196                         Pass::call(design, {"dump", "-o", filename});
 197                 }
 198
 199         if (pop_errfile)
 200                 log_files.pop_back();
 201 }
 202
 203 void logv_warning(const char *format, va_list ap)
 204 {
 205         if (log_errfile != NULL && !log_quiet_warnings)
 206                 log_files.push_back(log_errfile);
 207
 208         log("Warning: ");
 209         logv(format, ap);
 210         log_flush();
 211
 212         if (log_errfile != NULL && !log_quiet_warnings)
 213                 log_files.pop_back();
 214 }
 215
 216 void logv_error(const char *format, va_list ap)
 217 {
 218 #ifdef EMSCRIPTEN
 219         auto backup_log_files = log_files;
 220 #endif
 221
 222         if (log_errfile != NULL)
 223                 log_files.push_back(log_errfile);
 224
 225         if (log_error_stderr)
 226                 for (auto &f : log_files)
 227                         if (f == stdout)
 228                                 f = stderr;
 229
 230         log_last_error = vstringf(format, ap);
 231         log("ERROR: %s", log_last_error.c_str());
 232         log_flush();
 233
 234 #ifdef EMSCRIPTEN
 235         log_files = backup_log_files;
 236         throw 0;
 237 #elif defined(_MSC_VER)
 238         _exit(1);
 239 #else
 240         _Exit(1);
 241 #endif
 242 }
 243
 244 void log(const char *format, ...)
 245 {
 246         va_list ap;
 247         va_start(ap, format);
 248         logv(format, ap);
 249         va_end(ap);
 250 }
 251
 252 void log_header(RTLIL::Design *design, const char *format, ...)
 253 {
 254         va_list ap;
 255         va_start(ap, format);
 256         logv_header(design, format, ap);
 257         va_end(ap);
 258 }
 259
 260 void log_warning(const char *format, ...)
 261 {
 262         va_list ap;
 263         va_start(ap, format);
 264         logv_warning(format, ap);
 265         va_end(ap);
 266 }
 267
 268 void log_error(const char *format, ...)
 269 {
 270         va_list ap;
 271         va_start(ap, format);
 272         logv_error(format, ap);
 273 }
 274
 275 void log_cmd_error(const char *format, ...)
 276 {
 277         va_list ap;
 278         va_start(ap, format);
 279
 280         if (log_cmd_error_throw) {
 281                 log_last_error = vstringf(format, ap);
 282                 log("ERROR: %s", log_last_error.c_str());
 283                 log_flush();
 284                 throw log_cmd_error_exception();
 285         }
 286
 287         logv_error(format, ap);
 288 }
 289
 290 void log_spacer()
 291 {
 292         while (log_newline_count < 2) {
 293                 int old_log_newline_count = log_newline_count;
 294                 log("\n");
 295                 if (old_log_newline_count >= log_newline_count)
 296                         break;
 297         }
 298 }
 299
 300 void log_push()
 301 {
 302         header_count.push_back(0);
 303 }
 304
 305 void log_pop()
 306 {
 307         header_count.pop_back();
 308         log_id_cache.clear();
 309         string_buf.clear();
 310         string_buf_index = -1;
 311         log_flush();
 312 }
 313
 314 #if defined(__linux__) && defined(YOSYS_ENABLE_PLUGINS)
 315 void log_backtrace(const char *prefix, int levels)
 316 {
 317         if (levels <= 0) return;
 318
 319         Dl_info dli;
 320         void *p;
 321
 322         if ((p = __builtin_extract_return_addr(__builtin_return_address(0))) && dladdr(p, &dli)) {
 323                 log("%sframe #1: %p %s(%p) %s(%p)\n", prefix, p, dli.dli_fname, dli.dli_fbase, dli.dli_sname, dli.dli_saddr);
 324         } else {
 325                 log("%sframe #1: ---\n", prefix);
 326                 return;
 327         }
 328
 329         if (levels <= 1) return;
 330
 331         if ((p = __builtin_extract_return_addr(__builtin_return_address(1))) && dladdr(p, &dli)) {
 332                 log("%sframe #2: %p %s(%p) %s(%p)\n", prefix, p, dli.dli_fname, dli.dli_fbase, dli.dli_sname, dli.dli_saddr);
 333         } else {
 334                 log("%sframe #2: ---\n", prefix);
 335                 return;
 336         }
 337
 338         if (levels <= 2) return;
 339
 340         if ((p = __builtin_extract_return_addr(__builtin_return_address(2))) && dladdr(p, &dli)) {
 341                 log("%sframe #3: %p %s(%p) %s(%p)\n", prefix, p, dli.dli_fname, dli.dli_fbase, dli.dli_sname, dli.dli_saddr);
 342         } else {
 343                 log("%sframe #3: ---\n", prefix);
 344                 return;
 345         }
 346
 347         if (levels <= 3) return;
 348
 349         if ((p = __builtin_extract_return_addr(__builtin_return_address(3))) && dladdr(p, &dli)) {
 350                 log("%sframe #4: %p %s(%p) %s(%p)\n", prefix, p, dli.dli_fname, dli.dli_fbase, dli.dli_sname, dli.dli_saddr);
 351         } else {
 352                 log("%sframe #4: ---\n", prefix);
 353                 return;
 354         }
 355
 356         if (levels <= 4) return;
 357
 358         if ((p = __builtin_extract_return_addr(__builtin_return_address(4))) && dladdr(p, &dli)) {
 359                 log("%sframe #5: %p %s(%p) %s(%p)\n", prefix, p, dli.dli_fname, dli.dli_fbase, dli.dli_sname, dli.dli_saddr);
 360         } else {
 361                 log("%sframe #5: ---\n", prefix);
 362                 return;
 363         }
 364
 365         if (levels <= 5) return;
 366
 367         if ((p = __builtin_extract_return_addr(__builtin_return_address(5))) && dladdr(p, &dli)) {
 368                 log("%sframe #6: %p %s(%p) %s(%p)\n", prefix, p, dli.dli_fname, dli.dli_fbase, dli.dli_sname, dli.dli_saddr);
 369         } else {
 370                 log("%sframe #6: ---\n", prefix);
 371                 return;
 372         }
 373
 374         if (levels <= 6) return;
 375
 376         if ((p = __builtin_extract_return_addr(__builtin_return_address(6))) && dladdr(p, &dli)) {
 377                 log("%sframe #7: %p %s(%p) %s(%p)\n", prefix, p, dli.dli_fname, dli.dli_fbase, dli.dli_sname, dli.dli_saddr);
 378         } else {
 379                 log("%sframe #7: ---\n", prefix);
 380                 return;
 381         }
 382
 383         if (levels <= 7) return;
 384
 385         if ((p = __builtin_extract_return_addr(__builtin_return_address(7))) && dladdr(p, &dli)) {
 386                 log("%sframe #8: %p %s(%p) %s(%p)\n", prefix, p, dli.dli_fname, dli.dli_fbase, dli.dli_sname, dli.dli_saddr);
 387         } else {
 388                 log("%sframe #8: ---\n", prefix);
 389                 return;
 390         }
 391
 392         if (levels <= 8) return;
 393
 394         if ((p = __builtin_extract_return_addr(__builtin_return_address(8))) && dladdr(p, &dli)) {
 395                 log("%sframe #9: %p %s(%p) %s(%p)\n", prefix, p, dli.dli_fname, dli.dli_fbase, dli.dli_sname, dli.dli_saddr);
 396         } else {
 397                 log("%sframe #9: ---\n", prefix);
 398                 return;
 399         }
 400
 401         if (levels <= 9) return;
 402 }
 403 #else
 404 void log_backtrace(const char*, int) { }
 405 #endif
 406
 407 void log_reset_stack()
 408 {
 409         while (header_count.size() > 1)
 410                 header_count.pop_back();
 411         log_id_cache.clear();
 412         string_buf.clear();
 413         string_buf_index = -1;
 414         log_flush();
 415 }
 416
 417 void log_flush()
 418 {
 419         for (auto f : log_files)
 420                 fflush(f);
 421
 422         for (auto f : log_streams)
 423                 f->flush();
 424 }
 425
 426 void log_dump_val_worker(RTLIL::IdString v) {
 427         log("%s", log_id(v));
 428 }
 429
 430 void log_dump_val_worker(RTLIL::SigSpec v) {
 431         log("%s", log_signal(v));
 432 }
 433
 434 const char *log_signal(const RTLIL::SigSpec &sig, bool autoint)
 435 {
 436         std::stringstream buf;
 437         ILANG_BACKEND::dump_sigspec(buf, sig, autoint);
 438
 439         if (string_buf.size() < 100) {
 440                 string_buf.push_back(buf.str());
 441                 return string_buf.back().c_str();
 442         } else {
 443                 if (++string_buf_index == 100)
 444                         string_buf_index = 0;
 445                 string_buf[string_buf_index] = buf.str();
 446                 return string_buf[string_buf_index].c_str();
 447         }
 448 }
 449
 450 const char *log_const(const RTLIL::Const &value, bool autoint)
 451 {
 452         if ((value.flags & RTLIL::CONST_FLAG_STRING) == 0)
 453                 return log_signal(value, autoint);
 454
 455         std::string str = "\"" + value.decode_string() + "\"";
 456
 457         if (string_buf.size() < 100) {
 458                 string_buf.push_back(str);
 459                 return string_buf.back().c_str();
 460         } else {
 461                 if (++string_buf_index == 100)
 462                         string_buf_index = 0;
 463                 string_buf[string_buf_index] = str;
 464                 return string_buf[string_buf_index].c_str();
 465         }
 466 }
 467
 468 const char *log_id(RTLIL::IdString str)
 469 {
 470         log_id_cache.insert(str);
 471         const char *p = str.c_str();
 472         if (p[0] != '\\')
 473                 return p;
 474         if (p[1] == '$' || p[1] == '\\' || p[1] == 0)
 475                 return p;
 476         if (p[1] >= '0' && p[1] <= '9')
 477                 return p;
 478         return p+1;
 479 }
 480
 481 void log_module(RTLIL::Module *module, std::string indent)
 482 {
 483         std::stringstream buf;
 484         ILANG_BACKEND::dump_module(buf, indent, module, module->design, false);
 485         log("%s", buf.str().c_str());
 486 }
 487
 488 void log_cell(RTLIL::Cell *cell, std::string indent)
 489 {
 490         std::stringstream buf;
 491         ILANG_BACKEND::dump_cell(buf, indent, cell);
 492         log("%s", buf.str().c_str());
 493 }
 494
 495 // ---------------------------------------------------
 496 // This is the magic behind the code coverage counters
 497 // ---------------------------------------------------
 498 #if defined(YOSYS_ENABLE_COVER) && defined(__linux__)
 499
 500 dict<std::string, std::pair<std::string, int>> extra_coverage_data;
 501
 502 void cover_extra(std::string parent, std::string id, bool increment) {
 503         if (extra_coverage_data.count(id) == 0) {
 504                 for (CoverData *p = __start_yosys_cover_list; p != __stop_yosys_cover_list; p++)
 505                         if (p->id == parent)
 506                                 extra_coverage_data[id].first = stringf("%s:%d:%s", p->file, p->line, p->func);
 507                 log_assert(extra_coverage_data.count(id));
 508         }
 509         if (increment)
 510                 extra_coverage_data[id].second++;
 511 }
 512
 513 dict<std::string, std::pair<std::string, int>> get_coverage_data()
 514 {
 515         dict<std::string, std::pair<std::string, int>> coverage_data;
 516
 517         for (auto &it : pass_register) {
 518                 std::string key = stringf("passes.%s", it.first.c_str());
 519                 coverage_data[key].first = stringf("%s:%d:%s", __FILE__, __LINE__, __FUNCTION__);
 520                 coverage_data[key].second += it.second->call_counter;
 521         }
 522
 523         for (auto &it : extra_coverage_data) {
 524                 if (coverage_data.count(it.first))
 525                         log_warning("found duplicate coverage id \"%s\".\n", it.first.c_str());
 526                 coverage_data[it.first].first = it.second.first;
 527                 coverage_data[it.first].second += it.second.second;
 528         }
 529
 530         for (CoverData *p = __start_yosys_cover_list; p != __stop_yosys_cover_list; p++) {
 531                 if (coverage_data.count(p->id))
 532                         log_warning("found duplicate coverage id \"%s\".\n", p->id);
 533                 coverage_data[p->id].first = stringf("%s:%d:%s", p->file, p->line, p->func);
 534                 coverage_data[p->id].second += p->counter;
 535         }
 536
 537         for (auto &it : coverage_data)
 538                 if (!it.second.first.compare(0, strlen(YOSYS_SRC "/"), YOSYS_SRC "/"))
 539                         it.second.first = it.second.first.substr(strlen(YOSYS_SRC "/"));
 540
 541         return coverage_data;
 542 }
 543
 544 #endif
 545
 546 YOSYS_NAMESPACE_END
 547