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::vector
<std::pair
<std::regex
,LogExpectedItem
>> log_expect_log
, log_expect_warning
, log_expect_error
;
46 std::set
<std::string
> log_warnings
, log_experimentals
, log_experimentals_ignored
;
47 int log_warnings_count
= 0;
48 int log_warnings_count_noexpect
= 0;
49 bool log_expect_no_warnings
= false;
50 bool log_hdump_all
= false;
51 FILE *log_errfile
= NULL
;
52 SHA1
*log_hasher
= NULL
;
54 bool log_time
= false;
55 bool log_error_stderr
= false;
56 bool log_cmd_error_throw
= false;
57 bool log_quiet_warnings
= false;
58 int log_verbose_level
;
59 string log_last_error
;
60 void (*log_error_atexit
)() = NULL
;
62 int log_make_debug
= 0;
63 int log_force_debug
= 0;
64 int log_debug_suppressed
= 0;
66 vector
<int> header_count
;
67 vector
<char*> log_id_cache
;
68 vector
<shared_str
> string_buf
;
69 int string_buf_index
= -1;
71 static struct timeval initial_tv
= { 0, 0 };
72 static bool next_print_log
= false;
73 static int log_newline_count
= 0;
74 static bool check_expected_logs
= true;
75 static bool display_error_log_msg
= true;
77 static void log_id_cache_clear()
79 for (auto p
: log_id_cache
)
84 #if defined(_WIN32) && !defined(__MINGW32__)
85 // this will get time information and return it in timeval, simulating gettimeofday()
86 int gettimeofday(struct timeval
*tv
, struct timezone
*tz
)
88 LARGE_INTEGER counter
;
91 QueryPerformanceFrequency(&freq
);
92 QueryPerformanceCounter(&counter
);
94 counter
.QuadPart
*= 1000000;
95 counter
.QuadPart
/= freq
.QuadPart
;
97 tv
->tv_sec
= long(counter
.QuadPart
/ 1000000);
98 tv
->tv_usec
= counter
.QuadPart
% 1000000;
104 void logv(const char *format
, va_list ap
)
106 while (format
[0] == '\n' && format
[1] != 0) {
111 if (log_make_debug
&& !ys_debug(1))
114 std::string str
= vstringf(format
, ap
);
119 size_t nnl_pos
= str
.find_last_not_of('\n');
120 if (nnl_pos
== std::string::npos
)
121 log_newline_count
+= GetSize(str
);
123 log_newline_count
= GetSize(str
) - nnl_pos
- 1;
126 log_hasher
->update(str
);
130 std::string time_str
;
132 if (next_print_log
|| initial_tv
.tv_sec
== 0) {
133 next_print_log
= false;
135 gettimeofday(&tv
, NULL
);
136 if (initial_tv
.tv_sec
== 0)
138 if (tv
.tv_usec
< initial_tv
.tv_usec
) {
140 tv
.tv_usec
+= 1000000;
142 tv
.tv_sec
-= initial_tv
.tv_sec
;
143 tv
.tv_usec
-= initial_tv
.tv_usec
;
144 time_str
+= stringf("[%05d.%06d] ", int(tv
.tv_sec
), int(tv
.tv_usec
));
147 if (format
[0] && format
[strlen(format
)-1] == '\n')
148 next_print_log
= true;
150 for (auto f
: log_files
)
151 fputs(time_str
.c_str(), f
);
153 for (auto f
: log_streams
)
157 for (auto f
: log_files
)
158 fputs(str
.c_str(), f
);
160 for (auto f
: log_streams
)
163 static std::string linebuffer
;
164 static bool log_warn_regex_recusion_guard
= false;
166 if (!log_warn_regex_recusion_guard
)
168 log_warn_regex_recusion_guard
= true;
170 if (log_warn_regexes
.empty() && log_expect_log
.empty())
178 if (!linebuffer
.empty() && linebuffer
.back() == '\n') {
179 for (auto &re
: log_warn_regexes
)
180 if (std::regex_search(linebuffer
, re
))
181 log_warning("Found log message matching -W regex:\n%s", str
.c_str());
183 for (auto &item
: log_expect_log
)
184 if (std::regex_search(linebuffer
, item
.first
))
185 item
.second
.current_count
++;
191 log_warn_regex_recusion_guard
= false;
195 void logv_header(RTLIL::Design
*design
, const char *format
, va_list ap
)
197 bool pop_errfile
= false;
200 if (header_count
.size() > 0)
201 header_count
.back()++;
203 if (int(header_count
.size()) <= log_verbose_level
&& log_errfile
!= NULL
) {
204 log_files
.push_back(log_errfile
);
208 std::string header_id
;
210 for (int c
: header_count
)
211 header_id
+= stringf("%s%d", header_id
.empty() ? "" : ".", c
);
213 log("%s. ", header_id
.c_str());
218 log_hdump
[header_id
].insert("yosys_dump_" + header_id
+ ".il");
220 if (log_hdump
.count(header_id
) && design
!= nullptr)
221 for (auto &filename
: log_hdump
.at(header_id
)) {
222 log("Dumping current design to '%s'.\n", filename
.c_str());
224 IdString::xtrace_db_dump();
225 Pass::call(design
, {"dump", "-o", filename
});
227 log("#X# -- end of dump --\n");
231 log_files
.pop_back();
234 static void logv_warning_with_prefix(const char *prefix
,
235 const char *format
, va_list ap
)
237 std::string message
= vstringf(format
, ap
);
238 bool suppressed
= false;
240 for (auto &re
: log_nowarn_regexes
)
241 if (std::regex_search(message
, re
))
246 log("Suppressed %s%s", prefix
, message
.c_str());
250 int bak_log_make_debug
= log_make_debug
;
253 for (auto &re
: log_werror_regexes
)
254 if (std::regex_search(message
, re
))
255 log_error("%s", message
.c_str());
257 bool warning_match
= false;
258 for (auto &item
: log_expect_warning
)
259 if (std::regex_search(message
, item
.first
)) {
260 item
.second
.current_count
++;
261 warning_match
= true;
264 if (log_warnings
.count(message
))
266 log("%s%s", prefix
, message
.c_str());
271 if (log_errfile
!= NULL
&& !log_quiet_warnings
)
272 log_files
.push_back(log_errfile
);
274 log("%s%s", prefix
, message
.c_str());
277 if (log_errfile
!= NULL
&& !log_quiet_warnings
)
278 log_files
.pop_back();
280 log_warnings
.insert(message
);
284 log_warnings_count_noexpect
++;
285 log_warnings_count
++;
286 log_make_debug
= bak_log_make_debug
;
290 void logv_warning(const char *format
, va_list ap
)
292 logv_warning_with_prefix("Warning: ", format
, ap
);
295 void logv_warning_noprefix(const char *format
, va_list ap
)
297 logv_warning_with_prefix("", format
, ap
);
300 void log_file_warning(const std::string
&filename
, int lineno
,
301 const char *format
, ...)
304 va_start(ap
, format
);
305 std::string prefix
= stringf("%s:%d: Warning: ",
306 filename
.c_str(), lineno
);
307 logv_warning_with_prefix(prefix
.c_str(), format
, ap
);
311 void log_file_info(const std::string
&filename
, int lineno
,
312 const char *format
, ...)
315 va_start(ap
, format
);
316 std::string fmt
= stringf("%s:%d: Info: %s",
317 filename
.c_str(), lineno
, format
);
318 logv(fmt
.c_str(), ap
);
322 YS_ATTRIBUTE(noreturn
)
323 static void logv_error_with_prefix(const char *prefix
,
324 const char *format
, va_list ap
)
327 auto backup_log_files
= log_files
;
329 int bak_log_make_debug
= log_make_debug
;
333 if (log_errfile
!= NULL
)
334 log_files
.push_back(log_errfile
);
336 if (log_error_stderr
)
337 for (auto &f
: log_files
)
341 log_last_error
= vstringf(format
, ap
);
342 if (display_error_log_msg
)
343 log("%s%s", prefix
, log_last_error
.c_str());
346 log_make_debug
= bak_log_make_debug
;
348 if (log_error_atexit
)
351 for (auto &item
: log_expect_error
)
352 if (std::regex_search(log_last_error
, item
.first
))
353 item
.second
.current_count
++;
355 if (check_expected_logs
)
356 log_check_expected();
358 log_files
= backup_log_files
;
360 #elif defined(_MSC_VER)
367 void logv_error(const char *format
, va_list ap
)
369 logv_error_with_prefix("ERROR: ", format
, ap
);
372 void log_file_error(const string
&filename
, int lineno
,
373 const char *format
, ...)
376 va_start(ap
, format
);
377 std::string prefix
= stringf("%s:%d: ERROR: ",
378 filename
.c_str(), lineno
);
379 logv_error_with_prefix(prefix
.c_str(), format
, ap
);
382 void log(const char *format
, ...)
385 va_start(ap
, format
);
390 void log_header(RTLIL::Design
*design
, const char *format
, ...)
393 va_start(ap
, format
);
394 logv_header(design
, format
, ap
);
398 void log_warning(const char *format
, ...)
401 va_start(ap
, format
);
402 logv_warning(format
, ap
);
406 void log_experimental(const char *format
, ...)
409 va_start(ap
, format
);
410 string s
= vstringf(format
, ap
);
413 if (log_experimentals_ignored
.count(s
) == 0 && log_experimentals
.count(s
) == 0) {
414 log_warning("Feature '%s' is experimental.\n", s
.c_str());
415 log_experimentals
.insert(s
);
419 void log_warning_noprefix(const char *format
, ...)
422 va_start(ap
, format
);
423 logv_warning_noprefix(format
, ap
);
427 void log_error(const char *format
, ...)
430 va_start(ap
, format
);
431 logv_error(format
, ap
);
434 void log_cmd_error(const char *format
, ...)
437 va_start(ap
, format
);
439 if (log_cmd_error_throw
) {
440 log_last_error
= vstringf(format
, ap
);
441 log("ERROR: %s", log_last_error
.c_str());
443 throw log_cmd_error_exception();
446 logv_error(format
, ap
);
451 if (log_newline_count
< 2) log("\n");
452 if (log_newline_count
< 2) log("\n");
457 header_count
.push_back(0);
462 header_count
.pop_back();
463 log_id_cache_clear();
465 string_buf_index
= -1;
469 #if (defined(__linux__) || defined(__FreeBSD__)) && defined(YOSYS_ENABLE_PLUGINS)
470 void log_backtrace(const char *prefix
, int levels
)
472 if (levels
<= 0) return;
477 if ((p
= __builtin_extract_return_addr(__builtin_return_address(0))) && dladdr(p
, &dli
)) {
478 log("%sframe #1: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
480 log("%sframe #1: ---\n", prefix
);
484 if (levels
<= 1) return;
487 log("%sframe #2: [build Yosys with ENABLE_DEBUG for deeper backtraces]\n", prefix
);
489 if ((p
= __builtin_extract_return_addr(__builtin_return_address(1))) && dladdr(p
, &dli
)) {
490 log("%sframe #2: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
492 log("%sframe #2: ---\n", prefix
);
496 if (levels
<= 2) return;
498 if ((p
= __builtin_extract_return_addr(__builtin_return_address(2))) && dladdr(p
, &dli
)) {
499 log("%sframe #3: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
501 log("%sframe #3: ---\n", prefix
);
505 if (levels
<= 3) return;
507 if ((p
= __builtin_extract_return_addr(__builtin_return_address(3))) && dladdr(p
, &dli
)) {
508 log("%sframe #4: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
510 log("%sframe #4: ---\n", prefix
);
514 if (levels
<= 4) return;
516 if ((p
= __builtin_extract_return_addr(__builtin_return_address(4))) && dladdr(p
, &dli
)) {
517 log("%sframe #5: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
519 log("%sframe #5: ---\n", prefix
);
523 if (levels
<= 5) return;
525 if ((p
= __builtin_extract_return_addr(__builtin_return_address(5))) && dladdr(p
, &dli
)) {
526 log("%sframe #6: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
528 log("%sframe #6: ---\n", prefix
);
532 if (levels
<= 6) return;
534 if ((p
= __builtin_extract_return_addr(__builtin_return_address(6))) && dladdr(p
, &dli
)) {
535 log("%sframe #7: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
537 log("%sframe #7: ---\n", prefix
);
541 if (levels
<= 7) return;
543 if ((p
= __builtin_extract_return_addr(__builtin_return_address(7))) && dladdr(p
, &dli
)) {
544 log("%sframe #8: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
546 log("%sframe #8: ---\n", prefix
);
550 if (levels
<= 8) return;
552 if ((p
= __builtin_extract_return_addr(__builtin_return_address(8))) && dladdr(p
, &dli
)) {
553 log("%sframe #9: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
555 log("%sframe #9: ---\n", prefix
);
559 if (levels
<= 9) return;
563 void log_backtrace(const char*, int) { }
566 void log_reset_stack()
568 while (header_count
.size() > 1)
569 header_count
.pop_back();
570 log_id_cache_clear();
572 string_buf_index
= -1;
578 for (auto f
: log_files
)
581 for (auto f
: log_streams
)
585 void log_dump_val_worker(RTLIL::IdString v
) {
586 log("%s", log_id(v
));
589 void log_dump_val_worker(RTLIL::SigSpec v
) {
590 log("%s", log_signal(v
));
593 void log_dump_val_worker(RTLIL::State v
) {
594 log("%s", log_signal(v
));
597 const char *log_signal(const RTLIL::SigSpec
&sig
, bool autoint
)
599 std::stringstream buf
;
600 ILANG_BACKEND::dump_sigspec(buf
, sig
, autoint
);
602 if (string_buf
.size() < 100) {
603 string_buf
.push_back(buf
.str());
604 return string_buf
.back().c_str();
606 if (++string_buf_index
== 100)
607 string_buf_index
= 0;
608 string_buf
[string_buf_index
] = buf
.str();
609 return string_buf
[string_buf_index
].c_str();
613 const char *log_const(const RTLIL::Const
&value
, bool autoint
)
615 if ((value
.flags
& RTLIL::CONST_FLAG_STRING
) == 0)
616 return log_signal(value
, autoint
);
618 std::string str
= "\"" + value
.decode_string() + "\"";
620 if (string_buf
.size() < 100) {
621 string_buf
.push_back(str
);
622 return string_buf
.back().c_str();
624 if (++string_buf_index
== 100)
625 string_buf_index
= 0;
626 string_buf
[string_buf_index
] = str
;
627 return string_buf
[string_buf_index
].c_str();
631 const char *log_id(RTLIL::IdString str
)
633 log_id_cache
.push_back(strdup(str
.c_str()));
634 const char *p
= log_id_cache
.back();
637 if (p
[1] == '$' || p
[1] == '\\' || p
[1] == 0)
639 if (p
[1] >= '0' && p
[1] <= '9')
644 void log_module(RTLIL::Module
*module
, std::string indent
)
646 std::stringstream buf
;
647 ILANG_BACKEND::dump_module(buf
, indent
, module
, module
->design
, false);
648 log("%s", buf
.str().c_str());
651 void log_cell(RTLIL::Cell
*cell
, std::string indent
)
653 std::stringstream buf
;
654 ILANG_BACKEND::dump_cell(buf
, indent
, cell
);
655 log("%s", buf
.str().c_str());
658 void log_wire(RTLIL::Wire
*wire
, std::string indent
)
660 std::stringstream buf
;
661 ILANG_BACKEND::dump_wire(buf
, indent
, wire
);
662 log("%s", buf
.str().c_str());
665 void log_check_expected()
667 check_expected_logs
= false;
669 for (auto &item
: log_expect_warning
) {
670 if (item
.second
.current_count
== 0) {
671 log_error("Expected warning pattern '%s' not found !\n", item
.second
.pattern
.c_str());
673 if (item
.second
.current_count
!= item
.second
.expected_count
) {
674 log_error("Expected warning pattern '%s' found %d time(s), instead of %d time(s) !\n",
675 item
.second
.pattern
.c_str(), item
.second
.current_count
, item
.second
.expected_count
);
679 for (auto &item
: log_expect_log
) {
680 if (item
.second
.current_count
== 0) {
681 log_error("Expected log pattern '%s' not found !\n", item
.second
.pattern
.c_str());
683 if (item
.second
.current_count
!= item
.second
.expected_count
) {
684 log_error("Expected log pattern '%s' found %d time(s), instead of %d time(s) !\n",
685 item
.second
.pattern
.c_str(), item
.second
.current_count
, item
.second
.expected_count
);
689 for (auto &item
: log_expect_error
)
690 if (item
.second
.current_count
== item
.second
.expected_count
) {
691 log("Expected error pattern '%s' found !!!\n", item
.second
.pattern
.c_str());
693 log_files
= backup_log_files
;
695 #elif defined(_MSC_VER)
701 display_error_log_msg
= false;
702 log_error("Expected error pattern '%s' not found !\n", item
.second
.pattern
.c_str());
706 // ---------------------------------------------------
707 // This is the magic behind the code coverage counters
708 // ---------------------------------------------------
709 #if defined(YOSYS_ENABLE_COVER) && (defined(__linux__) || defined(__FreeBSD__))
711 dict
<std::string
, std::pair
<std::string
, int>> extra_coverage_data
;
713 void cover_extra(std::string parent
, std::string id
, bool increment
) {
714 if (extra_coverage_data
.count(id
) == 0) {
715 for (CoverData
*p
= __start_yosys_cover_list
; p
!= __stop_yosys_cover_list
; p
++)
717 extra_coverage_data
[id
].first
= stringf("%s:%d:%s", p
->file
, p
->line
, p
->func
);
718 log_assert(extra_coverage_data
.count(id
));
721 extra_coverage_data
[id
].second
++;
724 dict
<std::string
, std::pair
<std::string
, int>> get_coverage_data()
726 dict
<std::string
, std::pair
<std::string
, int>> coverage_data
;
728 for (auto &it
: pass_register
) {
729 std::string key
= stringf("passes.%s", it
.first
.c_str());
730 coverage_data
[key
].first
= stringf("%s:%d:%s", __FILE__
, __LINE__
, __FUNCTION__
);
731 coverage_data
[key
].second
+= it
.second
->call_counter
;
734 for (auto &it
: extra_coverage_data
) {
735 if (coverage_data
.count(it
.first
))
736 log_warning("found duplicate coverage id \"%s\".\n", it
.first
.c_str());
737 coverage_data
[it
.first
].first
= it
.second
.first
;
738 coverage_data
[it
.first
].second
+= it
.second
.second
;
741 for (CoverData
*p
= __start_yosys_cover_list
; p
!= __stop_yosys_cover_list
; p
++) {
742 if (coverage_data
.count(p
->id
))
743 log_warning("found duplicate coverage id \"%s\".\n", p
->id
);
744 coverage_data
[p
->id
].first
= stringf("%s:%d:%s", p
->file
, p
->line
, p
->func
);
745 coverage_data
[p
->id
].second
+= p
->counter
;
748 for (auto &it
: coverage_data
)
749 if (!it
.second
.first
.compare(0, strlen(YOSYS_SRC
"/"), YOSYS_SRC
"/"))
750 it
.second
.first
= it
.second
.first
.substr(strlen(YOSYS_SRC
"/"));
752 return coverage_data
;