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