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