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
;
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 pool
<RTLIL::IdString
> 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 #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
)
76 LARGE_INTEGER counter
;
79 QueryPerformanceFrequency(&freq
);
80 QueryPerformanceCounter(&counter
);
82 counter
.QuadPart
*= 1000000;
83 counter
.QuadPart
/= freq
.QuadPart
;
85 tv
->tv_sec
= long(counter
.QuadPart
/ 1000000);
86 tv
->tv_usec
= counter
.QuadPart
% 1000000;
92 void logv(const char *format
, va_list ap
)
94 while (format
[0] == '\n' && format
[1] != 0) {
99 if (log_make_debug
&& !ys_debug(1))
102 std::string str
= vstringf(format
, ap
);
107 size_t nnl_pos
= str
.find_last_not_of('\n');
108 if (nnl_pos
== std::string::npos
)
109 log_newline_count
+= GetSize(str
);
111 log_newline_count
= GetSize(str
) - nnl_pos
- 1;
114 log_hasher
->update(str
);
118 std::string time_str
;
120 if (next_print_log
|| initial_tv
.tv_sec
== 0) {
121 next_print_log
= false;
123 gettimeofday(&tv
, NULL
);
124 if (initial_tv
.tv_sec
== 0)
126 if (tv
.tv_usec
< initial_tv
.tv_usec
) {
128 tv
.tv_usec
+= 1000000;
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
));
135 if (format
[0] && format
[strlen(format
)-1] == '\n')
136 next_print_log
= true;
138 for (auto f
: log_files
)
139 fputs(time_str
.c_str(), f
);
141 for (auto f
: log_streams
)
145 for (auto f
: log_files
)
146 fputs(str
.c_str(), f
);
148 for (auto f
: log_streams
)
151 static std::string linebuffer
;
152 static bool log_warn_regex_recusion_guard
= false;
154 if (!log_warn_regex_recusion_guard
)
156 log_warn_regex_recusion_guard
= true;
158 if (log_warn_regexes
.empty())
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());
174 log_warn_regex_recusion_guard
= false;
178 void logv_header(RTLIL::Design
*design
, const char *format
, va_list ap
)
180 bool pop_errfile
= false;
183 if (header_count
.size() > 0)
184 header_count
.back()++;
186 if (int(header_count
.size()) <= log_verbose_level
&& log_errfile
!= NULL
) {
187 log_files
.push_back(log_errfile
);
191 std::string header_id
;
193 for (int c
: header_count
)
194 header_id
+= stringf("%s%d", header_id
.empty() ? "" : ".", c
);
196 log("%s. ", header_id
.c_str());
201 log_hdump
[header_id
].insert("yosys_dump_" + header_id
+ ".il");
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());
207 IdString::xtrace_db_dump();
208 Pass::call(design
, {"dump", "-o", filename
});
210 log("#X# -- end of dump --\n");
214 log_files
.pop_back();
217 static void logv_warning_with_prefix(const char *prefix
,
218 const char *format
, va_list ap
)
220 std::string message
= vstringf(format
, ap
);
221 bool suppressed
= false;
223 for (auto &re
: log_nowarn_regexes
)
224 if (std::regex_search(message
, re
))
229 log("Suppressed %s%s", prefix
, message
.c_str());
233 for (auto &re
: log_werror_regexes
)
234 if (std::regex_search(message
, re
))
235 log_error("%s", message
.c_str());
237 if (log_warnings
.count(message
))
239 log("%s%s", prefix
, message
.c_str());
244 if (log_errfile
!= NULL
&& !log_quiet_warnings
)
245 log_files
.push_back(log_errfile
);
247 log("%s%s", prefix
, message
.c_str());
250 if (log_errfile
!= NULL
&& !log_quiet_warnings
)
251 log_files
.pop_back();
253 log_warnings
.insert(message
);
256 log_warnings_count
++;
260 void logv_warning(const char *format
, va_list ap
)
262 logv_warning_with_prefix("Warning: ", format
, ap
);
265 void logv_warning_noprefix(const char *format
, va_list ap
)
267 logv_warning_with_prefix("", format
, ap
);
270 void log_file_warning(const std::string
&filename
, int lineno
,
271 const char *format
, ...)
274 va_start(ap
, format
);
275 std::string prefix
= stringf("%s:%d: Warning: ",
276 filename
.c_str(), lineno
);
277 logv_warning_with_prefix(prefix
.c_str(), format
, ap
);
281 YS_ATTRIBUTE(noreturn
)
282 static void logv_error_with_prefix(const char *prefix
,
283 const char *format
, va_list ap
)
286 auto backup_log_files
= log_files
;
289 if (log_errfile
!= NULL
)
290 log_files
.push_back(log_errfile
);
292 if (log_error_stderr
)
293 for (auto &f
: log_files
)
297 log_last_error
= vstringf(format
, ap
);
298 log("%s%s", prefix
, log_last_error
.c_str());
301 if (log_error_atexit
)
305 log_files
= backup_log_files
;
307 #elif defined(_MSC_VER)
314 void logv_error(const char *format
, va_list ap
)
316 logv_error_with_prefix("ERROR: ", format
, ap
);
319 void log_file_error(const string
&filename
, int lineno
,
320 const char *format
, ...)
323 va_start(ap
, format
);
324 std::string prefix
= stringf("%s:%d: ERROR: ",
325 filename
.c_str(), lineno
);
326 logv_error_with_prefix(prefix
.c_str(), format
, ap
);
329 void log(const char *format
, ...)
332 va_start(ap
, format
);
337 void log_header(RTLIL::Design
*design
, const char *format
, ...)
340 va_start(ap
, format
);
341 logv_header(design
, format
, ap
);
345 void log_warning(const char *format
, ...)
348 va_start(ap
, format
);
349 logv_warning(format
, ap
);
353 void log_warning_noprefix(const char *format
, ...)
356 va_start(ap
, format
);
357 logv_warning_noprefix(format
, ap
);
361 void log_error(const char *format
, ...)
364 va_start(ap
, format
);
365 logv_error(format
, ap
);
368 void log_cmd_error(const char *format
, ...)
371 va_start(ap
, format
);
373 if (log_cmd_error_throw
) {
374 log_last_error
= vstringf(format
, ap
);
375 log("ERROR: %s", log_last_error
.c_str());
377 throw log_cmd_error_exception();
380 logv_error(format
, ap
);
385 if (log_newline_count
< 2) log("\n");
386 if (log_newline_count
< 2) log("\n");
391 header_count
.push_back(0);
396 header_count
.pop_back();
397 log_id_cache
.clear();
399 string_buf_index
= -1;
403 #if (defined(__linux__) || defined(__FreeBSD__)) && defined(YOSYS_ENABLE_PLUGINS)
404 void log_backtrace(const char *prefix
, int levels
)
406 if (levels
<= 0) return;
411 if ((p
= __builtin_extract_return_addr(__builtin_return_address(0))) && dladdr(p
, &dli
)) {
412 log("%sframe #1: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
414 log("%sframe #1: ---\n", prefix
);
418 if (levels
<= 1) return;
421 log("%sframe #2: [build Yosys with ENABLE_DEBUG for deeper backtraces]\n", prefix
);
423 if ((p
= __builtin_extract_return_addr(__builtin_return_address(1))) && dladdr(p
, &dli
)) {
424 log("%sframe #2: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
426 log("%sframe #2: ---\n", prefix
);
430 if (levels
<= 2) return;
432 if ((p
= __builtin_extract_return_addr(__builtin_return_address(2))) && dladdr(p
, &dli
)) {
433 log("%sframe #3: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
435 log("%sframe #3: ---\n", prefix
);
439 if (levels
<= 3) return;
441 if ((p
= __builtin_extract_return_addr(__builtin_return_address(3))) && dladdr(p
, &dli
)) {
442 log("%sframe #4: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
444 log("%sframe #4: ---\n", prefix
);
448 if (levels
<= 4) return;
450 if ((p
= __builtin_extract_return_addr(__builtin_return_address(4))) && dladdr(p
, &dli
)) {
451 log("%sframe #5: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
453 log("%sframe #5: ---\n", prefix
);
457 if (levels
<= 5) return;
459 if ((p
= __builtin_extract_return_addr(__builtin_return_address(5))) && dladdr(p
, &dli
)) {
460 log("%sframe #6: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
462 log("%sframe #6: ---\n", prefix
);
466 if (levels
<= 6) return;
468 if ((p
= __builtin_extract_return_addr(__builtin_return_address(6))) && dladdr(p
, &dli
)) {
469 log("%sframe #7: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
471 log("%sframe #7: ---\n", prefix
);
475 if (levels
<= 7) return;
477 if ((p
= __builtin_extract_return_addr(__builtin_return_address(7))) && dladdr(p
, &dli
)) {
478 log("%sframe #8: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
480 log("%sframe #8: ---\n", prefix
);
484 if (levels
<= 8) return;
486 if ((p
= __builtin_extract_return_addr(__builtin_return_address(8))) && dladdr(p
, &dli
)) {
487 log("%sframe #9: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
489 log("%sframe #9: ---\n", prefix
);
493 if (levels
<= 9) return;
497 void log_backtrace(const char*, int) { }
500 void log_reset_stack()
502 while (header_count
.size() > 1)
503 header_count
.pop_back();
504 log_id_cache
.clear();
506 string_buf_index
= -1;
512 for (auto f
: log_files
)
515 for (auto f
: log_streams
)
519 void log_dump_val_worker(RTLIL::IdString v
) {
520 log("%s", log_id(v
));
523 void log_dump_val_worker(RTLIL::SigSpec v
) {
524 log("%s", log_signal(v
));
527 const char *log_signal(const RTLIL::SigSpec
&sig
, bool autoint
)
529 std::stringstream buf
;
530 ILANG_BACKEND::dump_sigspec(buf
, sig
, autoint
);
532 if (string_buf
.size() < 100) {
533 string_buf
.push_back(buf
.str());
534 return string_buf
.back().c_str();
536 if (++string_buf_index
== 100)
537 string_buf_index
= 0;
538 string_buf
[string_buf_index
] = buf
.str();
539 return string_buf
[string_buf_index
].c_str();
543 const char *log_const(const RTLIL::Const
&value
, bool autoint
)
545 if ((value
.flags
& RTLIL::CONST_FLAG_STRING
) == 0)
546 return log_signal(value
, autoint
);
548 std::string str
= "\"" + value
.decode_string() + "\"";
550 if (string_buf
.size() < 100) {
551 string_buf
.push_back(str
);
552 return string_buf
.back().c_str();
554 if (++string_buf_index
== 100)
555 string_buf_index
= 0;
556 string_buf
[string_buf_index
] = str
;
557 return string_buf
[string_buf_index
].c_str();
561 const char *log_id(RTLIL::IdString str
)
563 log_id_cache
.insert(str
);
564 const char *p
= str
.c_str();
567 if (p
[1] == '$' || p
[1] == '\\' || p
[1] == 0)
569 if (p
[1] >= '0' && p
[1] <= '9')
574 void log_module(RTLIL::Module
*module
, std::string indent
)
576 std::stringstream buf
;
577 ILANG_BACKEND::dump_module(buf
, indent
, module
, module
->design
, false);
578 log("%s", buf
.str().c_str());
581 void log_cell(RTLIL::Cell
*cell
, std::string indent
)
583 std::stringstream buf
;
584 ILANG_BACKEND::dump_cell(buf
, indent
, cell
);
585 log("%s", buf
.str().c_str());
588 void log_wire(RTLIL::Wire
*wire
, std::string indent
)
590 std::stringstream buf
;
591 ILANG_BACKEND::dump_wire(buf
, indent
, wire
);
592 log("%s", buf
.str().c_str());
595 // ---------------------------------------------------
596 // This is the magic behind the code coverage counters
597 // ---------------------------------------------------
598 #if defined(YOSYS_ENABLE_COVER) && (defined(__linux__) || defined(__FreeBSD__))
600 dict
<std::string
, std::pair
<std::string
, int>> extra_coverage_data
;
602 void cover_extra(std::string parent
, std::string id
, bool increment
) {
603 if (extra_coverage_data
.count(id
) == 0) {
604 for (CoverData
*p
= __start_yosys_cover_list
; p
!= __stop_yosys_cover_list
; p
++)
606 extra_coverage_data
[id
].first
= stringf("%s:%d:%s", p
->file
, p
->line
, p
->func
);
607 log_assert(extra_coverage_data
.count(id
));
610 extra_coverage_data
[id
].second
++;
613 dict
<std::string
, std::pair
<std::string
, int>> get_coverage_data()
615 dict
<std::string
, std::pair
<std::string
, int>> coverage_data
;
617 for (auto &it
: pass_register
) {
618 std::string key
= stringf("passes.%s", it
.first
.c_str());
619 coverage_data
[key
].first
= stringf("%s:%d:%s", __FILE__
, __LINE__
, __FUNCTION__
);
620 coverage_data
[key
].second
+= it
.second
->call_counter
;
623 for (auto &it
: extra_coverage_data
) {
624 if (coverage_data
.count(it
.first
))
625 log_warning("found duplicate coverage id \"%s\".\n", it
.first
.c_str());
626 coverage_data
[it
.first
].first
= it
.second
.first
;
627 coverage_data
[it
.first
].second
+= it
.second
.second
;
630 for (CoverData
*p
= __start_yosys_cover_list
; p
!= __stop_yosys_cover_list
; p
++) {
631 if (coverage_data
.count(p
->id
))
632 log_warning("found duplicate coverage id \"%s\".\n", p
->id
);
633 coverage_data
[p
->id
].first
= stringf("%s:%d:%s", p
->file
, p
->line
, p
->func
);
634 coverage_data
[p
->id
].second
+= p
->counter
;
637 for (auto &it
: coverage_data
)
638 if (!it
.second
.first
.compare(0, strlen(YOSYS_SRC
"/"), YOSYS_SRC
"/"))
639 it
.second
.first
= it
.second
.first
.substr(strlen(YOSYS_SRC
"/"));
641 return coverage_data
;