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 vector
<int> header_count
;
60 pool
<RTLIL::IdString
> log_id_cache
;
61 vector
<shared_str
> string_buf
;
62 int string_buf_index
= -1;
64 static struct timeval initial_tv
= { 0, 0 };
65 static bool next_print_log
= false;
66 static int log_newline_count
= 0;
68 #if defined(_WIN32) && !defined(__MINGW32__)
69 // this will get time information and return it in timeval, simulating gettimeofday()
70 int gettimeofday(struct timeval
*tv
, struct timezone
*tz
)
72 LARGE_INTEGER counter
;
75 QueryPerformanceFrequency(&freq
);
76 QueryPerformanceCounter(&counter
);
78 counter
.QuadPart
*= 1000000;
79 counter
.QuadPart
/= freq
.QuadPart
;
81 tv
->tv_sec
= long(counter
.QuadPart
/ 1000000);
82 tv
->tv_usec
= counter
.QuadPart
% 1000000;
88 void logv(const char *format
, va_list ap
)
90 while (format
[0] == '\n' && format
[1] != 0) {
95 std::string str
= vstringf(format
, ap
);
100 size_t nnl_pos
= str
.find_last_not_of('\n');
101 if (nnl_pos
== std::string::npos
)
102 log_newline_count
+= GetSize(str
);
104 log_newline_count
= GetSize(str
) - nnl_pos
- 1;
107 log_hasher
->update(str
);
111 std::string time_str
;
113 if (next_print_log
|| initial_tv
.tv_sec
== 0) {
114 next_print_log
= false;
116 gettimeofday(&tv
, NULL
);
117 if (initial_tv
.tv_sec
== 0)
119 if (tv
.tv_usec
< initial_tv
.tv_usec
) {
121 tv
.tv_usec
+= 1000000;
123 tv
.tv_sec
-= initial_tv
.tv_sec
;
124 tv
.tv_usec
-= initial_tv
.tv_usec
;
125 time_str
+= stringf("[%05d.%06d] ", int(tv
.tv_sec
), int(tv
.tv_usec
));
128 if (format
[0] && format
[strlen(format
)-1] == '\n')
129 next_print_log
= true;
131 for (auto f
: log_files
)
132 fputs(time_str
.c_str(), f
);
134 for (auto f
: log_streams
)
138 for (auto f
: log_files
)
139 fputs(str
.c_str(), f
);
141 for (auto f
: log_streams
)
144 static std::string linebuffer
;
145 static bool log_warn_regex_recusion_guard
= false;
147 if (!log_warn_regex_recusion_guard
)
149 log_warn_regex_recusion_guard
= true;
151 if (log_warn_regexes
.empty())
159 if (!linebuffer
.empty() && linebuffer
.back() == '\n') {
160 for (auto &re
: log_warn_regexes
)
161 if (std::regex_search(linebuffer
, re
))
162 log_warning("Found log message matching -W regex:\n%s", str
.c_str());
167 log_warn_regex_recusion_guard
= false;
171 void logv_header(RTLIL::Design
*design
, const char *format
, va_list ap
)
173 bool pop_errfile
= false;
176 if (header_count
.size() > 0)
177 header_count
.back()++;
179 if (int(header_count
.size()) <= log_verbose_level
&& log_errfile
!= NULL
) {
180 log_files
.push_back(log_errfile
);
184 std::string header_id
;
186 for (int c
: header_count
)
187 header_id
+= stringf("%s%d", header_id
.empty() ? "" : ".", c
);
189 log("%s. ", header_id
.c_str());
194 log_hdump
[header_id
].insert("yosys_dump_" + header_id
+ ".il");
196 if (log_hdump
.count(header_id
) && design
!= nullptr)
197 for (auto &filename
: log_hdump
.at(header_id
)) {
198 log("Dumping current design to '%s'.\n", filename
.c_str());
199 Pass::call(design
, {"dump", "-o", filename
});
203 log_files
.pop_back();
206 static void logv_warning_with_prefix(const char *prefix
,
207 const char *format
, va_list ap
)
209 std::string message
= vstringf(format
, ap
);
210 bool suppressed
= false;
212 for (auto &re
: log_nowarn_regexes
)
213 if (std::regex_search(message
, re
))
218 log("Suppressed %s%s", prefix
, message
.c_str());
222 for (auto &re
: log_werror_regexes
)
223 if (std::regex_search(message
, re
))
224 log_error("%s", message
.c_str());
226 if (log_warnings
.count(message
))
228 log("%s%s", prefix
, message
.c_str());
233 if (log_errfile
!= NULL
&& !log_quiet_warnings
)
234 log_files
.push_back(log_errfile
);
236 log("%s%s", prefix
, message
.c_str());
239 if (log_errfile
!= NULL
&& !log_quiet_warnings
)
240 log_files
.pop_back();
242 log_warnings
.insert(message
);
245 log_warnings_count
++;
249 void logv_warning(const char *format
, va_list ap
)
251 logv_warning_with_prefix("Warning: ", format
, ap
);
254 void logv_warning_noprefix(const char *format
, va_list ap
)
256 logv_warning_with_prefix("", format
, ap
);
259 void log_file_warning(const std::string
&filename
, int lineno
,
260 const char *format
, ...)
263 va_start(ap
, format
);
264 std::string prefix
= stringf("%s:%d: Warning: ",
265 filename
.c_str(), lineno
);
266 logv_warning_with_prefix(prefix
.c_str(), format
, ap
);
270 YS_ATTRIBUTE(noreturn
)
271 static void logv_error_with_prefix(const char *prefix
,
272 const char *format
, va_list ap
)
275 auto backup_log_files
= log_files
;
278 if (log_errfile
!= NULL
)
279 log_files
.push_back(log_errfile
);
281 if (log_error_stderr
)
282 for (auto &f
: log_files
)
286 log_last_error
= vstringf(format
, ap
);
287 log("%s%s", prefix
, log_last_error
.c_str());
290 if (log_error_atexit
)
294 log_files
= backup_log_files
;
296 #elif defined(_MSC_VER)
303 void logv_error(const char *format
, va_list ap
)
305 logv_error_with_prefix("ERROR: ", format
, ap
);
308 void log_file_error(const string
&filename
, int lineno
,
309 const char *format
, ...)
312 va_start(ap
, format
);
313 std::string prefix
= stringf("%s:%d: ERROR: ",
314 filename
.c_str(), lineno
);
315 logv_error_with_prefix(prefix
.c_str(), format
, ap
);
318 void log(const char *format
, ...)
321 va_start(ap
, format
);
326 void log_header(RTLIL::Design
*design
, const char *format
, ...)
329 va_start(ap
, format
);
330 logv_header(design
, format
, ap
);
334 void log_warning(const char *format
, ...)
337 va_start(ap
, format
);
338 logv_warning(format
, ap
);
342 void log_warning_noprefix(const char *format
, ...)
345 va_start(ap
, format
);
346 logv_warning_noprefix(format
, ap
);
350 void log_error(const char *format
, ...)
353 va_start(ap
, format
);
354 logv_error(format
, ap
);
357 void log_cmd_error(const char *format
, ...)
360 va_start(ap
, format
);
362 if (log_cmd_error_throw
) {
363 log_last_error
= vstringf(format
, ap
);
364 log("ERROR: %s", log_last_error
.c_str());
366 throw log_cmd_error_exception();
369 logv_error(format
, ap
);
374 if (log_newline_count
< 2) log("\n");
375 if (log_newline_count
< 2) log("\n");
380 header_count
.push_back(0);
385 header_count
.pop_back();
386 log_id_cache
.clear();
388 string_buf_index
= -1;
392 #if (defined(__linux__) || defined(__FreeBSD__)) && defined(YOSYS_ENABLE_PLUGINS)
393 void log_backtrace(const char *prefix
, int levels
)
395 if (levels
<= 0) return;
400 if ((p
= __builtin_extract_return_addr(__builtin_return_address(0))) && dladdr(p
, &dli
)) {
401 log("%sframe #1: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
403 log("%sframe #1: ---\n", prefix
);
407 if (levels
<= 1) return;
410 log("%sframe #2: [build Yosys with ENABLE_DEBUG for deeper backtraces]\n", prefix
);
412 if ((p
= __builtin_extract_return_addr(__builtin_return_address(1))) && dladdr(p
, &dli
)) {
413 log("%sframe #2: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
415 log("%sframe #2: ---\n", prefix
);
419 if (levels
<= 2) return;
421 if ((p
= __builtin_extract_return_addr(__builtin_return_address(2))) && dladdr(p
, &dli
)) {
422 log("%sframe #3: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
424 log("%sframe #3: ---\n", prefix
);
428 if (levels
<= 3) return;
430 if ((p
= __builtin_extract_return_addr(__builtin_return_address(3))) && dladdr(p
, &dli
)) {
431 log("%sframe #4: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
433 log("%sframe #4: ---\n", prefix
);
437 if (levels
<= 4) return;
439 if ((p
= __builtin_extract_return_addr(__builtin_return_address(4))) && dladdr(p
, &dli
)) {
440 log("%sframe #5: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
442 log("%sframe #5: ---\n", prefix
);
446 if (levels
<= 5) return;
448 if ((p
= __builtin_extract_return_addr(__builtin_return_address(5))) && dladdr(p
, &dli
)) {
449 log("%sframe #6: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
451 log("%sframe #6: ---\n", prefix
);
455 if (levels
<= 6) return;
457 if ((p
= __builtin_extract_return_addr(__builtin_return_address(6))) && dladdr(p
, &dli
)) {
458 log("%sframe #7: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
460 log("%sframe #7: ---\n", prefix
);
464 if (levels
<= 7) return;
466 if ((p
= __builtin_extract_return_addr(__builtin_return_address(7))) && dladdr(p
, &dli
)) {
467 log("%sframe #8: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
469 log("%sframe #8: ---\n", prefix
);
473 if (levels
<= 8) return;
475 if ((p
= __builtin_extract_return_addr(__builtin_return_address(8))) && dladdr(p
, &dli
)) {
476 log("%sframe #9: %p %s(%p) %s(%p)\n", prefix
, p
, dli
.dli_fname
, dli
.dli_fbase
, dli
.dli_sname
, dli
.dli_saddr
);
478 log("%sframe #9: ---\n", prefix
);
482 if (levels
<= 9) return;
486 void log_backtrace(const char*, int) { }
489 void log_reset_stack()
491 while (header_count
.size() > 1)
492 header_count
.pop_back();
493 log_id_cache
.clear();
495 string_buf_index
= -1;
501 for (auto f
: log_files
)
504 for (auto f
: log_streams
)
508 void log_dump_val_worker(RTLIL::IdString v
) {
509 log("%s", log_id(v
));
512 void log_dump_val_worker(RTLIL::SigSpec v
) {
513 log("%s", log_signal(v
));
516 const char *log_signal(const RTLIL::SigSpec
&sig
, bool autoint
)
518 std::stringstream buf
;
519 ILANG_BACKEND::dump_sigspec(buf
, sig
, autoint
);
521 if (string_buf
.size() < 100) {
522 string_buf
.push_back(buf
.str());
523 return string_buf
.back().c_str();
525 if (++string_buf_index
== 100)
526 string_buf_index
= 0;
527 string_buf
[string_buf_index
] = buf
.str();
528 return string_buf
[string_buf_index
].c_str();
532 const char *log_const(const RTLIL::Const
&value
, bool autoint
)
534 if ((value
.flags
& RTLIL::CONST_FLAG_STRING
) == 0)
535 return log_signal(value
, autoint
);
537 std::string str
= "\"" + value
.decode_string() + "\"";
539 if (string_buf
.size() < 100) {
540 string_buf
.push_back(str
);
541 return string_buf
.back().c_str();
543 if (++string_buf_index
== 100)
544 string_buf_index
= 0;
545 string_buf
[string_buf_index
] = str
;
546 return string_buf
[string_buf_index
].c_str();
550 const char *log_id(RTLIL::IdString str
)
552 log_id_cache
.insert(str
);
553 const char *p
= str
.c_str();
556 if (p
[1] == '$' || p
[1] == '\\' || p
[1] == 0)
558 if (p
[1] >= '0' && p
[1] <= '9')
563 void log_module(RTLIL::Module
*module
, std::string indent
)
565 std::stringstream buf
;
566 ILANG_BACKEND::dump_module(buf
, indent
, module
, module
->design
, false);
567 log("%s", buf
.str().c_str());
570 void log_cell(RTLIL::Cell
*cell
, std::string indent
)
572 std::stringstream buf
;
573 ILANG_BACKEND::dump_cell(buf
, indent
, cell
);
574 log("%s", buf
.str().c_str());
577 void log_wire(RTLIL::Wire
*wire
, std::string indent
)
579 std::stringstream buf
;
580 ILANG_BACKEND::dump_wire(buf
, indent
, wire
);
581 log("%s", buf
.str().c_str());
584 // ---------------------------------------------------
585 // This is the magic behind the code coverage counters
586 // ---------------------------------------------------
587 #if defined(YOSYS_ENABLE_COVER) && (defined(__linux__) || defined(__FreeBSD__))
589 dict
<std::string
, std::pair
<std::string
, int>> extra_coverage_data
;
591 void cover_extra(std::string parent
, std::string id
, bool increment
) {
592 if (extra_coverage_data
.count(id
) == 0) {
593 for (CoverData
*p
= __start_yosys_cover_list
; p
!= __stop_yosys_cover_list
; p
++)
595 extra_coverage_data
[id
].first
= stringf("%s:%d:%s", p
->file
, p
->line
, p
->func
);
596 log_assert(extra_coverage_data
.count(id
));
599 extra_coverage_data
[id
].second
++;
602 dict
<std::string
, std::pair
<std::string
, int>> get_coverage_data()
604 dict
<std::string
, std::pair
<std::string
, int>> coverage_data
;
606 for (auto &it
: pass_register
) {
607 std::string key
= stringf("passes.%s", it
.first
.c_str());
608 coverage_data
[key
].first
= stringf("%s:%d:%s", __FILE__
, __LINE__
, __FUNCTION__
);
609 coverage_data
[key
].second
+= it
.second
->call_counter
;
612 for (auto &it
: extra_coverage_data
) {
613 if (coverage_data
.count(it
.first
))
614 log_warning("found duplicate coverage id \"%s\".\n", it
.first
.c_str());
615 coverage_data
[it
.first
].first
= it
.second
.first
;
616 coverage_data
[it
.first
].second
+= it
.second
.second
;
619 for (CoverData
*p
= __start_yosys_cover_list
; p
!= __stop_yosys_cover_list
; p
++) {
620 if (coverage_data
.count(p
->id
))
621 log_warning("found duplicate coverage id \"%s\".\n", p
->id
);
622 coverage_data
[p
->id
].first
= stringf("%s:%d:%s", p
->file
, p
->line
, p
->func
);
623 coverage_data
[p
->id
].second
+= p
->counter
;
626 for (auto &it
: coverage_data
)
627 if (!it
.second
.first
.compare(0, strlen(YOSYS_SRC
"/"), YOSYS_SRC
"/"))
628 it
.second
.first
= it
.second
.first
.substr(strlen(YOSYS_SRC
"/"));
630 return coverage_data
;