2 * yosys -- Yosys Open SYnthesis Suite
4 * Copyright (C) 2012 Clifford Wolf <clifford@clifford.at>
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.
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.
20 #include "kernel/yosys.h"
21 #include "libs/sha1/sha1.h"
22 #include "backends/ilang/ilang_backend.h"
24 #if !defined(_WIN32) || defined(__MINGW32__)
25 # include <sys/time.h>
28 #if defined(__linux__) || defined(__FreeBSD__)
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
, log_experimentals
, log_experimentals_ignored
;
46 int log_warnings_count
= 0;
47 bool log_hdump_all
= false;
48 FILE *log_errfile
= NULL
;
49 SHA1
*log_hasher
= NULL
;
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
;
59 int log_make_debug
= 0;
60 int log_force_debug
= 0;
61 int log_debug_suppressed
= 0;
63 vector
<int> header_count
;
64 vector
<char*> log_id_cache
;
65 vector
<shared_str
> string_buf
;
66 int string_buf_index
= -1;
68 static struct timeval initial_tv
= { 0, 0 };
69 static bool next_print_log
= false;
70 static int log_newline_count
= 0;
72 static void log_id_cache_clear()
74 for (auto p
: log_id_cache
)
79 #if defined(_WIN32) && !defined(__MINGW32__)
80 // this will get time information and return it in timeval, simulating gettimeofday()
81 int gettimeofday(struct timeval
*tv
, struct timezone
*tz
)
83 LARGE_INTEGER counter
;
86 QueryPerformanceFrequency(&freq
);
87 QueryPerformanceCounter(&counter
);
89 counter
.QuadPart
*= 1000000;
90 counter
.QuadPart
/= freq
.QuadPart
;
92 tv
->tv_sec
= long(counter
.QuadPart
/ 1000000);
93 tv
->tv_usec
= counter
.QuadPart
% 1000000;
99 void logv(const char *format
, va_list ap
)
101 while (format
[0] == '\n' && format
[1] != 0) {
106 if (log_make_debug
&& !ys_debug(1))
109 std::string str
= vstringf(format
, ap
);
114 size_t nnl_pos
= str
.find_last_not_of('\n');
115 if (nnl_pos
== std::string::npos
)
116 log_newline_count
+= GetSize(str
);
118 log_newline_count
= GetSize(str
) - nnl_pos
- 1;
121 log_hasher
->update(str
);
125 std::string time_str
;
127 if (next_print_log
|| initial_tv
.tv_sec
== 0) {
128 next_print_log
= false;
130 gettimeofday(&tv
, NULL
);
131 if (initial_tv
.tv_sec
== 0)
133 if (tv
.tv_usec
< initial_tv
.tv_usec
) {
135 tv
.tv_usec
+= 1000000;
137 tv
.tv_sec
-= initial_tv
.tv_sec
;
138 tv
.tv_usec
-= initial_tv
.tv_usec
;
139 time_str
+= stringf("[%05d.%06d] ", int(tv
.tv_sec
), int(tv
.tv_usec
));
142 if (format
[0] && format
[strlen(format
)-1] == '\n')
143 next_print_log
= true;
145 for (auto f
: log_files
)
146 fputs(time_str
.c_str(), f
);
148 for (auto f
: log_streams
)
152 for (auto f
: log_files
)
153 fputs(str
.c_str(), f
);
155 for (auto f
: log_streams
)
158 static std::string linebuffer
;
159 static bool log_warn_regex_recusion_guard
= false;
161 if (!log_warn_regex_recusion_guard
)
163 log_warn_regex_recusion_guard
= true;
165 if (log_warn_regexes
.empty())
173 if (!linebuffer
.empty() && linebuffer
.back() == '\n') {
174 for (auto &re
: log_warn_regexes
)
175 if (std::regex_search(linebuffer
, re
))
176 log_warning("Found log message matching -W regex:\n%s", str
.c_str());
181 log_warn_regex_recusion_guard
= false;
185 void logv_header(RTLIL::Design
*design
, const char *format
, va_list ap
)
187 bool pop_errfile
= false;
190 if (header_count
.size() > 0)
191 header_count
.back()++;
193 if (int(header_count
.size()) <= log_verbose_level
&& log_errfile
!= NULL
) {
194 log_files
.push_back(log_errfile
);
198 std::string header_id
;
200 for (int c
: header_count
)
201 header_id
+= stringf("%s%d", header_id
.empty() ? "" : ".", c
);
203 log("%s. ", header_id
.c_str());
208 log_hdump
[header_id
].insert("yosys_dump_" + header_id
+ ".il");
210 if (log_hdump
.count(header_id
) && design
!= nullptr)
211 for (auto &filename
: log_hdump
.at(header_id
)) {
212 log("Dumping current design to '%s'.\n", filename
.c_str());
214 IdString::xtrace_db_dump();
215 Pass::call(design
, {"dump", "-o", filename
});
217 log("#X# -- end of dump --\n");
221 log_files
.pop_back();
224 static void logv_warning_with_prefix(const char *prefix
,
225 const char *format
, va_list ap
)
227 std::string message
= vstringf(format
, ap
);
228 bool suppressed
= false;
230 for (auto &re
: log_nowarn_regexes
)
231 if (std::regex_search(message
, re
))
236 log("Suppressed %s%s", prefix
, message
.c_str());
240 int bak_log_make_debug
= log_make_debug
;
243 for (auto &re
: log_werror_regexes
)
244 if (std::regex_search(message
, re
))
245 log_error("%s", message
.c_str());
247 if (log_warnings
.count(message
))
249 log("%s%s", prefix
, message
.c_str());
254 if (log_errfile
!= NULL
&& !log_quiet_warnings
)
255 log_files
.push_back(log_errfile
);
257 log("%s%s", prefix
, message
.c_str());
260 if (log_errfile
!= NULL
&& !log_quiet_warnings
)
261 log_files
.pop_back();
263 log_warnings
.insert(message
);
266 log_warnings_count
++;
267 log_make_debug
= bak_log_make_debug
;
271 void logv_warning(const char *format
, va_list ap
)
273 logv_warning_with_prefix("Warning: ", format
, ap
);
276 void logv_warning_noprefix(const char *format
, va_list ap
)
278 logv_warning_with_prefix("", format
, ap
);
281 void log_file_warning(const std::string
&filename
, int lineno
,
282 const char *format
, ...)
285 va_start(ap
, format
);
286 std::string prefix
= stringf("%s:%d: Warning: ",
287 filename
.c_str(), lineno
);
288 logv_warning_with_prefix(prefix
.c_str(), format
, ap
);
292 void log_file_info(const std::string
&filename
, int lineno
,
293 const char *format
, ...)
296 va_start(ap
, format
);
297 std::string fmt
= stringf("%s:%d: Info: %s",
298 filename
.c_str(), lineno
, format
);
299 logv(fmt
.c_str(), ap
);
303 YS_ATTRIBUTE(noreturn
)
304 static void logv_error_with_prefix(const char *prefix
,
305 const char *format
, va_list ap
)
308 auto backup_log_files
= log_files
;
310 int bak_log_make_debug
= log_make_debug
;
314 if (log_errfile
!= NULL
)
315 log_files
.push_back(log_errfile
);
317 if (log_error_stderr
)
318 for (auto &f
: log_files
)
322 log_last_error
= vstringf(format
, ap
);
323 log("%s%s", prefix
, log_last_error
.c_str());
326 log_make_debug
= bak_log_make_debug
;
328 if (log_error_atexit
)
332 log_files
= backup_log_files
;
334 #elif defined(_MSC_VER)
341 void logv_error(const char *format
, va_list ap
)
343 logv_error_with_prefix("ERROR: ", format
, ap
);
346 void log_file_error(const string
&filename
, int lineno
,
347 const char *format
, ...)
350 va_start(ap
, format
);
351 std::string prefix
= stringf("%s:%d: ERROR: ",
352 filename
.c_str(), lineno
);
353 logv_error_with_prefix(prefix
.c_str(), format
, ap
);
356 void log(const char *format
, ...)
359 va_start(ap
, format
);
364 void log_header(RTLIL::Design
*design
, const char *format
, ...)
367 va_start(ap
, format
);
368 logv_header(design
, format
, ap
);
372 void log_warning(const char *format
, ...)
375 va_start(ap
, format
);
376 logv_warning(format
, ap
);
380 void log_experimental(const char *format
, ...)
383 va_start(ap
, format
);
384 string s
= vstringf(format
, ap
);
387 if (log_experimentals_ignored
.count(s
) == 0 && log_experimentals
.count(s
) == 0) {
388 log_warning("Feature '%s' is experimental.\n", s
.c_str());
389 log_experimentals
.insert(s
);
393 void log_warning_noprefix(const char *format
, ...)
396 va_start(ap
, format
);
397 logv_warning_noprefix(format
, ap
);
401 void log_error(const char *format
, ...)
404 va_start(ap
, format
);
405 logv_error(format
, ap
);
408 void log_cmd_error(const char *format
, ...)
411 va_start(ap
, format
);
413 if (log_cmd_error_throw
) {
414 log_last_error
= vstringf(format
, ap
);
415 log("ERROR: %s", log_last_error
.c_str());
417 throw log_cmd_error_exception();
420 logv_error(format
, ap
);
425 if (log_newline_count
< 2) log("\n");
426 if (log_newline_count
< 2) log("\n");
431 header_count
.push_back(0);
436 header_count
.pop_back();
437 log_id_cache_clear();
439 string_buf_index
= -1;
443 #if (defined(__linux__) || defined(__FreeBSD__)) && defined(YOSYS_ENABLE_PLUGINS)
444 void log_backtrace(const char *prefix
, int levels
)
446 if (levels
<= 0) return;
451 if ((p
= __builtin_extract_return_addr(__builtin_return_address(0))) && dladdr(p
, &dli
)) {
452 log("%sframe #1: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
454 log("%sframe #1: ---\n", prefix
);
458 if (levels
<= 1) return;
461 log("%sframe #2: [build Yosys with ENABLE_DEBUG for deeper backtraces]\n", prefix
);
463 if ((p
= __builtin_extract_return_addr(__builtin_return_address(1))) && dladdr(p
, &dli
)) {
464 log("%sframe #2: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
466 log("%sframe #2: ---\n", prefix
);
470 if (levels
<= 2) return;
472 if ((p
= __builtin_extract_return_addr(__builtin_return_address(2))) && dladdr(p
, &dli
)) {
473 log("%sframe #3: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
475 log("%sframe #3: ---\n", prefix
);
479 if (levels
<= 3) return;
481 if ((p
= __builtin_extract_return_addr(__builtin_return_address(3))) && dladdr(p
, &dli
)) {
482 log("%sframe #4: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
484 log("%sframe #4: ---\n", prefix
);
488 if (levels
<= 4) return;
490 if ((p
= __builtin_extract_return_addr(__builtin_return_address(4))) && dladdr(p
, &dli
)) {
491 log("%sframe #5: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
493 log("%sframe #5: ---\n", prefix
);
497 if (levels
<= 5) return;
499 if ((p
= __builtin_extract_return_addr(__builtin_return_address(5))) && dladdr(p
, &dli
)) {
500 log("%sframe #6: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
502 log("%sframe #6: ---\n", prefix
);
506 if (levels
<= 6) return;
508 if ((p
= __builtin_extract_return_addr(__builtin_return_address(6))) && dladdr(p
, &dli
)) {
509 log("%sframe #7: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
511 log("%sframe #7: ---\n", prefix
);
515 if (levels
<= 7) return;
517 if ((p
= __builtin_extract_return_addr(__builtin_return_address(7))) && dladdr(p
, &dli
)) {
518 log("%sframe #8: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
520 log("%sframe #8: ---\n", prefix
);
524 if (levels
<= 8) return;
526 if ((p
= __builtin_extract_return_addr(__builtin_return_address(8))) && dladdr(p
, &dli
)) {
527 log("%sframe #9: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
529 log("%sframe #9: ---\n", prefix
);
533 if (levels
<= 9) return;
537 void log_backtrace(const char*, int) { }
540 void log_reset_stack()
542 while (header_count
.size() > 1)
543 header_count
.pop_back();
544 log_id_cache_clear();
546 string_buf_index
= -1;
552 for (auto f
: log_files
)
555 for (auto f
: log_streams
)
559 void log_dump_val_worker(RTLIL::IdString v
) {
560 log("%s", log_id(v
));
563 void log_dump_val_worker(RTLIL::SigSpec v
) {
564 log("%s", log_signal(v
));
567 void log_dump_val_worker(RTLIL::State v
) {
568 log("%s", log_signal(v
));
571 const char *log_signal(const RTLIL::SigSpec
&sig
, bool autoint
)
573 std::stringstream buf
;
574 ILANG_BACKEND::dump_sigspec(buf
, sig
, autoint
);
576 if (string_buf
.size() < 100) {
577 string_buf
.push_back(buf
.str());
578 return string_buf
.back().c_str();
580 if (++string_buf_index
== 100)
581 string_buf_index
= 0;
582 string_buf
[string_buf_index
] = buf
.str();
583 return string_buf
[string_buf_index
].c_str();
587 const char *log_const(const RTLIL::Const
&value
, bool autoint
)
589 if ((value
.flags
& RTLIL::CONST_FLAG_STRING
) == 0)
590 return log_signal(value
, autoint
);
592 std::string str
= "\"" + value
.decode_string() + "\"";
594 if (string_buf
.size() < 100) {
595 string_buf
.push_back(str
);
596 return string_buf
.back().c_str();
598 if (++string_buf_index
== 100)
599 string_buf_index
= 0;
600 string_buf
[string_buf_index
] = str
;
601 return string_buf
[string_buf_index
].c_str();
605 const char *log_id(RTLIL::IdString str
)
607 log_id_cache
.push_back(strdup(str
.c_str()));
608 const char *p
= log_id_cache
.back();
611 if (p
[1] == '$' || p
[1] == '\\' || p
[1] == 0)
613 if (p
[1] >= '0' && p
[1] <= '9')
618 void log_module(RTLIL::Module
*module
, std::string indent
)
620 std::stringstream buf
;
621 ILANG_BACKEND::dump_module(buf
, indent
, module
, module
->design
, false);
622 log("%s", buf
.str().c_str());
625 void log_cell(RTLIL::Cell
*cell
, std::string indent
)
627 std::stringstream buf
;
628 ILANG_BACKEND::dump_cell(buf
, indent
, cell
);
629 log("%s", buf
.str().c_str());
632 void log_wire(RTLIL::Wire
*wire
, std::string indent
)
634 std::stringstream buf
;
635 ILANG_BACKEND::dump_wire(buf
, indent
, wire
);
636 log("%s", buf
.str().c_str());
639 // ---------------------------------------------------
640 // This is the magic behind the code coverage counters
641 // ---------------------------------------------------
642 #if defined(YOSYS_ENABLE_COVER) && (defined(__linux__) || defined(__FreeBSD__))
644 dict
<std::string
, std::pair
<std::string
, int>> extra_coverage_data
;
646 void cover_extra(std::string parent
, std::string id
, bool increment
) {
647 if (extra_coverage_data
.count(id
) == 0) {
648 for (CoverData
*p
= __start_yosys_cover_list
; p
!= __stop_yosys_cover_list
; p
++)
650 extra_coverage_data
[id
].first
= stringf("%s:%d:%s", p
->file
, p
->line
, p
->func
);
651 log_assert(extra_coverage_data
.count(id
));
654 extra_coverage_data
[id
].second
++;
657 dict
<std::string
, std::pair
<std::string
, int>> get_coverage_data()
659 dict
<std::string
, std::pair
<std::string
, int>> coverage_data
;
661 for (auto &it
: pass_register
) {
662 std::string key
= stringf("passes.%s", it
.first
.c_str());
663 coverage_data
[key
].first
= stringf("%s:%d:%s", __FILE__
, __LINE__
, __FUNCTION__
);
664 coverage_data
[key
].second
+= it
.second
->call_counter
;
667 for (auto &it
: extra_coverage_data
) {
668 if (coverage_data
.count(it
.first
))
669 log_warning("found duplicate coverage id \"%s\".\n", it
.first
.c_str());
670 coverage_data
[it
.first
].first
= it
.second
.first
;
671 coverage_data
[it
.first
].second
+= it
.second
.second
;
674 for (CoverData
*p
= __start_yosys_cover_list
; p
!= __stop_yosys_cover_list
; p
++) {
675 if (coverage_data
.count(p
->id
))
676 log_warning("found duplicate coverage id \"%s\".\n", p
->id
);
677 coverage_data
[p
->id
].first
= stringf("%s:%d:%s", p
->file
, p
->line
, p
->func
);
678 coverage_data
[p
->id
].second
+= p
->counter
;
681 for (auto &it
: coverage_data
)
682 if (!it
.second
.first
.compare(0, strlen(YOSYS_SRC
"/"), YOSYS_SRC
"/"))
683 it
.second
.first
= it
.second
.first
.substr(strlen(YOSYS_SRC
"/"));
685 return coverage_data
;