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"
29 # include <sys/time.h>
30 # include <sys/resource.h>
34 // At least this is not in MSVC++ 2013.
35 # define __PRETTY_FUNCTION__ __FUNCTION__
38 // from libs/sha1/sha1.h
43 #define S__LINE__sub2(x) #x
44 #define S__LINE__sub1(x) S__LINE__sub2(x)
45 #define S__LINE__ S__LINE__sub1(__LINE__)
47 struct log_cmd_error_exception
{ };
49 extern std::vector
<FILE*> log_files
;
50 extern std::vector
<std::ostream
*> log_streams
;
51 extern std::map
<std::string
, std::set
<std::string
>> log_hdump
;
52 extern std::vector
<std::regex
> log_warn_regexes
, log_nowarn_regexes
, log_werror_regexes
;
53 extern std::set
<std::string
> log_warnings
;
54 extern int log_warnings_count
;
55 extern bool log_hdump_all
;
56 extern FILE *log_errfile
;
57 extern SHA1
*log_hasher
;
60 extern bool log_error_stderr
;
61 extern bool log_cmd_error_throw
;
62 extern bool log_quiet_warnings
;
63 extern int log_verbose_level
;
64 extern string log_last_error
;
65 extern void (*log_error_atexit
)();
67 extern int log_make_debug
;
68 extern int log_force_debug
;
69 extern int log_debug_suppressed
;
71 void logv(const char *format
, va_list ap
);
72 void logv_header(RTLIL::Design
*design
, const char *format
, va_list ap
);
73 void logv_warning(const char *format
, va_list ap
);
74 void logv_warning_noprefix(const char *format
, va_list ap
);
75 YS_NORETURN
void logv_error(const char *format
, va_list ap
) YS_ATTRIBUTE(noreturn
);
77 void log(const char *format
, ...) YS_ATTRIBUTE(format(printf
, 1, 2));
78 void log_header(RTLIL::Design
*design
, const char *format
, ...) YS_ATTRIBUTE(format(printf
, 2, 3));
79 void log_warning(const char *format
, ...) YS_ATTRIBUTE(format(printf
, 1, 2));
81 // Log with filename to report a problem in a source file.
82 void log_file_warning(const std::string
&filename
, int lineno
, const char *format
, ...) YS_ATTRIBUTE(format(printf
, 3, 4));
83 void log_file_info(const std::string
&filename
, int lineno
, const char *format
, ...) YS_ATTRIBUTE(format(printf
, 3, 4));
85 void log_warning_noprefix(const char *format
, ...) YS_ATTRIBUTE(format(printf
, 1, 2));
86 YS_NORETURN
void log_error(const char *format
, ...) YS_ATTRIBUTE(format(printf
, 1, 2), noreturn
);
87 void log_file_error(const string
&filename
, int lineno
, const char *format
, ...) YS_ATTRIBUTE(format(printf
, 3, 4), noreturn
);
88 YS_NORETURN
void log_cmd_error(const char *format
, ...) YS_ATTRIBUTE(format(printf
, 1, 2), noreturn
);
91 static inline bool ys_debug(int n
= 0) { if (log_force_debug
) return true; log_debug_suppressed
+= n
; return false; }
92 # define log_debug(...) do { if (ys_debug(1)) log(__VA_ARGS__); } while (0)
94 static inline bool ys_debug(int = 0) { return false; }
95 # define log_debug(_fmt, ...) do { } while (0)
98 static inline void log_suppressed() {
99 if (log_debug_suppressed
&& !log_make_debug
) {
100 log("<suppressed ~%d debug messages>\n", log_debug_suppressed
);
101 log_debug_suppressed
= 0;
105 struct LogMakeDebugHdl
{
107 LogMakeDebugHdl(bool start_on
= false) {
133 void log_backtrace(const char *prefix
, int levels
);
134 void log_reset_stack();
137 const char *log_signal(const RTLIL::SigSpec
&sig
, bool autoint
= true);
138 const char *log_const(const RTLIL::Const
&value
, bool autoint
= true);
139 const char *log_id(RTLIL::IdString id
);
141 template<typename T
> static inline const char *log_id(T
*obj
, const char *nullstr
= nullptr) {
142 if (nullstr
&& obj
== nullptr)
144 return log_id(obj
->name
);
147 void log_module(RTLIL::Module
*module
, std::string indent
= "");
148 void log_cell(RTLIL::Cell
*cell
, std::string indent
= "");
149 void log_wire(RTLIL::Wire
*wire
, std::string indent
= "");
152 static inline void log_assert_worker(bool cond
, const char *expr
, const char *file
, int line
) {
153 if (!cond
) log_error("Assert `%s' failed in %s:%d.\n", expr
, file
, line
);
155 # define log_assert(_assert_expr_) YOSYS_NAMESPACE_PREFIX log_assert_worker(_assert_expr_, #_assert_expr_, __FILE__, __LINE__)
157 # define log_assert(_assert_expr_)
160 #define log_abort() YOSYS_NAMESPACE_PREFIX log_error("Abort in %s:%d.\n", __FILE__, __LINE__)
161 #define log_ping() YOSYS_NAMESPACE_PREFIX log("-- %s:%d %s --\n", __FILE__, __LINE__, __PRETTY_FUNCTION__)
164 // ---------------------------------------------------
165 // This is the magic behind the code coverage counters
166 // ---------------------------------------------------
168 #if defined(YOSYS_ENABLE_COVER) && (defined(__linux__) || defined(__FreeBSD__))
170 #define cover(_id) do { \
171 static CoverData __d __attribute__((section("yosys_cover_list"), aligned(1), used)) = { __FILE__, __FUNCTION__, _id, __LINE__, 0 }; \
176 const char *file
, *func
, *id
;
178 } YS_ATTRIBUTE(packed
);
180 // this two symbols are created by the linker for the "yosys_cover_list" ELF section
181 extern "C" struct CoverData __start_yosys_cover_list
[];
182 extern "C" struct CoverData __stop_yosys_cover_list
[];
184 extern dict
<std::string
, std::pair
<std::string
, int>> extra_coverage_data
;
186 void cover_extra(std::string parent
, std::string id
, bool increment
= true);
187 dict
<std::string
, std::pair
<std::string
, int>> get_coverage_data();
189 #define cover_list(_id, ...) do { cover(_id); \
190 std::string r = cover_list_worker(_id, __VA_ARGS__); \
191 log_assert(r.empty()); \
194 static inline std::string
cover_list_worker(std::string
, std::string last
) {
198 template<typename
... T
>
199 std::string
cover_list_worker(std::string prefix
, std::string first
, T
... rest
) {
200 std::string selected
= cover_list_worker(prefix
, rest
...);
201 cover_extra(prefix
, prefix
+ "." + first
, first
== selected
);
202 return first
== selected
? "" : selected
;
206 # define cover(...) do { } while (0)
207 # define cover_list(...) do { } while (0)
211 // ------------------------------------------------------------
212 // everything below this line are utilities for troubleshooting
213 // ------------------------------------------------------------
215 // simple timer for performance measurements
216 // toggle the '#if 1' to get a baseline for the performance penalty added by the measurement
217 struct PerformanceTimer
226 static int64_t query() {
229 # elif defined(_POSIX_TIMERS) && (_POSIX_TIMERS > 0)
231 clock_gettime(CLOCK_PROCESS_CPUTIME_ID
, &ts
);
232 return int64_t(ts
.tv_sec
)*1000000000 + ts
.tv_nsec
;
233 # elif defined(RUSAGE_SELF)
234 struct rusage rusage
;
236 if (getrusage(RUSAGE_SELF
, &rusage
) == -1) {
237 log_cmd_error("getrusage failed!\n");
240 t
= 1000000000ULL * (int64_t) rusage
.ru_utime
.tv_sec
+ (int64_t) rusage
.ru_utime
.tv_usec
* 1000ULL;
241 t
+= 1000000000ULL * (int64_t) rusage
.ru_stime
.tv_sec
+ (int64_t) rusage
.ru_stime
.tv_usec
* 1000ULL;
244 # error "Don't know how to measure per-process CPU time. Need alternative method (times()/clocks()/gettimeofday()?)."
261 return total_ns
* 1e-9f
;
264 static int64_t query() { return 0; }
268 float sec() const { return 0; }
272 // simple API for quickly dumping values when debugging
274 static inline void log_dump_val_worker(short v
) { log("%d", v
); }
275 static inline void log_dump_val_worker(unsigned short v
) { log("%u", v
); }
276 static inline void log_dump_val_worker(int v
) { log("%d", v
); }
277 static inline void log_dump_val_worker(unsigned int v
) { log("%u", v
); }
278 static inline void log_dump_val_worker(long int v
) { log("%ld", v
); }
279 static inline void log_dump_val_worker(unsigned long int v
) { log("%lu", v
); }
281 static inline void log_dump_val_worker(long long int v
) { log("%lld", v
); }
282 static inline void log_dump_val_worker(unsigned long long int v
) { log("%lld", v
); }
284 static inline void log_dump_val_worker(char c
) { log(c
>= 32 && c
< 127 ? "'%c'" : "'\\x%02x'", c
); }
285 static inline void log_dump_val_worker(unsigned char c
) { log(c
>= 32 && c
< 127 ? "'%c'" : "'\\x%02x'", c
); }
286 static inline void log_dump_val_worker(bool v
) { log("%s", v
? "true" : "false"); }
287 static inline void log_dump_val_worker(double v
) { log("%f", v
); }
288 static inline void log_dump_val_worker(char *v
) { log("%s", v
); }
289 static inline void log_dump_val_worker(const char *v
) { log("%s", v
); }
290 static inline void log_dump_val_worker(std::string v
) { log("%s", v
.c_str()); }
291 static inline void log_dump_val_worker(PerformanceTimer p
) { log("%f seconds", p
.sec()); }
292 static inline void log_dump_args_worker(const char *p
YS_ATTRIBUTE(unused
)) { log_assert(*p
== 0); }
293 void log_dump_val_worker(RTLIL::IdString v
);
294 void log_dump_val_worker(RTLIL::SigSpec v
);
295 void log_dump_val_worker(RTLIL::State v
);
297 template<typename K
, typename T
, typename OPS
>
298 static inline void log_dump_val_worker(dict
<K
, T
, OPS
> &v
) {
302 log(first
? " " : ", ");
303 log_dump_val_worker(it
.first
);
305 log_dump_val_worker(it
.second
);
311 template<typename K
, typename OPS
>
312 static inline void log_dump_val_worker(pool
<K
, OPS
> &v
) {
316 log(first
? " " : ", ");
317 log_dump_val_worker(it
);
324 static inline void log_dump_val_worker(T
*ptr
) { log("%p", ptr
); }
326 template<typename T
, typename
... Args
>
327 void log_dump_args_worker(const char *p
, T first
, Args
... args
)
329 int next_p_state
= 0;
330 const char *next_p
= p
;
331 while (*next_p
&& (next_p_state
!= 0 || *next_p
!= ',')) {
335 while (*next_p
== '\\' && *(next_p
+ 1))
337 } while (*next_p
&& *next_p
!= '"');
338 if (*next_p
== '\'') {
345 if (*next_p
== '(' || *next_p
== '[' || *next_p
== '{')
347 if ((*next_p
== ')' || *next_p
== ']' || *next_p
== '}') && next_p_state
> 0)
351 log("\n\t%.*s => ", int(next_p
- p
), p
);
354 while (*next_p
== ' ' || *next_p
== '\t' || *next_p
== '\r' || *next_p
== '\n')
356 log_dump_val_worker(first
);
357 log_dump_args_worker(next_p
, args
...);
360 #define log_dump(...) do { \
361 log("DEBUG DUMP IN %s AT %s:%d:", __PRETTY_FUNCTION__, __FILE__, __LINE__); \
362 log_dump_args_worker(#__VA_ARGS__, __VA_ARGS__); \