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