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"
28 # include <sys/time.h>
29 # include <sys/resource.h>
32 // from libs/sha1/sha1.h
37 #define S__LINE__sub2(x) #x
38 #define S__LINE__sub1(x) S__LINE__sub2(x)
39 #define S__LINE__ S__LINE__sub1(__LINE__)
41 struct log_cmd_error_exception
{ };
43 extern std::vector
<FILE*> log_files
;
44 extern std::vector
<std::ostream
*> log_streams
;
45 extern FILE *log_errfile
;
46 extern SHA1
*log_hasher
;
49 extern bool log_cmd_error_throw
;
50 extern bool log_quiet_warnings
;
51 extern int log_verbose_level
;
53 void logv(const char *format
, va_list ap
);
54 void logv_header(const char *format
, va_list ap
);
55 void logv_warning(const char *format
, va_list ap
);
56 YS_NORETURN
void logv_error(const char *format
, va_list ap
) YS_ATTRIBUTE(noreturn
);
58 void log(const char *format
, ...) YS_ATTRIBUTE(format(printf
, 1, 2));
59 void log_header(const char *format
, ...) YS_ATTRIBUTE(format(printf
, 1, 2));
60 void log_warning(const char *format
, ...) YS_ATTRIBUTE(format(printf
, 1, 2));
61 YS_NORETURN
void log_error(const char *format
, ...) YS_ATTRIBUTE(format(printf
, 1, 2), noreturn
);
62 YS_NORETURN
void log_cmd_error(const char *format
, ...) YS_ATTRIBUTE(format(printf
, 1, 2), noreturn
);
68 void log_backtrace(const char *prefix
, int levels
);
69 void log_reset_stack();
72 const char *log_signal(const RTLIL::SigSpec
&sig
, bool autoint
= true);
73 const char *log_id(RTLIL::IdString id
);
75 template<typename T
> static inline const char *log_id(T
*obj
) {
76 return log_id(obj
->name
);
79 void log_cell(RTLIL::Cell
*cell
, std::string indent
= "");
81 static inline void log_assert_worker(bool cond
, const char *expr
, const char *file
, int line
) {
82 if (!cond
) log_error("Assert `%s' failed in %s:%d.\n", expr
, file
, line
);
85 #define log_abort() YOSYS_NAMESPACE_PREFIX log_error("Abort in %s:%d.\n", __FILE__, __LINE__)
86 #define log_assert(_assert_expr_) YOSYS_NAMESPACE_PREFIX log_assert_worker(_assert_expr_, #_assert_expr_, __FILE__, __LINE__)
87 #define log_ping() YOSYS_NAMESPACE_PREFIX log("-- %s:%d %s --\n", __FILE__, __LINE__, __PRETTY_FUNCTION__)
90 // ---------------------------------------------------
91 // This is the magic behind the code coverage counters
92 // ---------------------------------------------------
94 #ifdef YOSYS_ENABLE_COVER
96 #define cover(_id) do { \
97 static CoverData __d YS_ATTRIBUTE(section("yosys_cover_list"), aligned(1), used) = { __FILE__, __FUNCTION__, _id, __LINE__, 0 }; \
102 const char *file
, *func
, *id
;
104 } YS_ATTRIBUTE(packed
);
106 // this two symbols are created by the linker for the "yosys_cover_list" ELF section
107 extern "C" struct CoverData __start_yosys_cover_list
[];
108 extern "C" struct CoverData __stop_yosys_cover_list
[];
110 extern dict
<std::string
, std::pair
<std::string
, int>> extra_coverage_data
;
112 void cover_extra(std::string parent
, std::string id
, bool increment
= true);
113 dict
<std::string
, std::pair
<std::string
, int>> get_coverage_data();
115 #define cover_list(_id, ...) do { cover(_id); \
116 std::string r = cover_list_worker(_id, __VA_ARGS__); \
117 log_assert(r.empty()); \
120 static inline std::string
cover_list_worker(std::string
, std::string last
) {
124 template<typename
... T
>
125 std::string
cover_list_worker(std::string prefix
, std::string first
, T
... rest
) {
126 std::string selected
= cover_list_worker(prefix
, rest
...);
127 cover_extra(prefix
, prefix
+ "." + first
, first
== selected
);
128 return first
== selected
? "" : selected
;
132 # define cover(...) do { } while (0)
133 # define cover_list(...) do { } while (0)
137 // ------------------------------------------------------------
138 // everything below this line are utilities for troubleshooting
139 // ------------------------------------------------------------
141 // simple timer for performance measurements
142 // toggle the '#if 1' to get a baseline for the perormance penalty added by the measurement
143 struct PerformanceTimer
152 static int64_t query() {
153 #if defined(_POSIX_TIMERS) && (_POSIX_TIMERS > 0)
155 clock_gettime(CLOCK_PROCESS_CPUTIME_ID
, &ts
);
156 return int64_t(ts
.tv_sec
)*1000000000 + ts
.tv_nsec
;
157 #elif defined(RUSAGE_SELF)
158 struct rusage rusage
;
160 if (getrusage(RUSAGE_SELF
, &rusage
) == -1) {
161 log_cmd_error("getrusage failed!\n");
164 t
= 1000000000ULL * (int64_t) rusage
.ru_utime
.tv_sec
+ (int64_t) rusage
.ru_utime
.tv_usec
* 1000ULL;
165 t
+= 1000000000ULL * (int64_t) rusage
.ru_stime
.tv_sec
+ (int64_t) rusage
.ru_stime
.tv_usec
* 1000ULL;
170 #error Dont know how to measure per-process CPU time. Need alternative method (times()/clocks()/gettimeofday()?).
187 return total_ns
* 1e-9f
;
190 static int64_t query() { return 0; }
194 float sec() const { return 0; }
198 // simple API for quickly dumping values when debugging
200 static inline void log_dump_val_worker(short v
) { log("%d", v
); }
201 static inline void log_dump_val_worker(unsigned short v
) { log("%u", v
); }
202 static inline void log_dump_val_worker(int v
) { log("%d", v
); }
203 static inline void log_dump_val_worker(unsigned int v
) { log("%u", v
); }
204 static inline void log_dump_val_worker(long int v
) { log("%ld", v
); }
205 static inline void log_dump_val_worker(unsigned long int v
) { log("%lu", v
); }
207 static inline void log_dump_val_worker(long long int v
) { log("%lld", v
); }
208 static inline void log_dump_val_worker(unsigned long long int v
) { log("%lld", v
); }
210 static inline void log_dump_val_worker(char c
) { log(c
>= 32 && c
< 127 ? "'%c'" : "'\\x%02x'", c
); }
211 static inline void log_dump_val_worker(unsigned char c
) { log(c
>= 32 && c
< 127 ? "'%c'" : "'\\x%02x'", c
); }
212 static inline void log_dump_val_worker(bool v
) { log("%s", v
? "true" : "false"); }
213 static inline void log_dump_val_worker(double v
) { log("%f", v
); }
214 static inline void log_dump_val_worker(char *v
) { log("%s", v
); }
215 static inline void log_dump_val_worker(const char *v
) { log("%s", v
); }
216 static inline void log_dump_val_worker(std::string v
) { log("%s", v
.c_str()); }
217 static inline void log_dump_val_worker(PerformanceTimer p
) { log("%f seconds", p
.sec()); }
218 static inline void log_dump_args_worker(const char *p
) { log_assert(*p
== 0); }
219 void log_dump_val_worker(RTLIL::SigSpec v
);
222 static inline void log_dump_val_worker(T
*ptr
) { log("%p", ptr
); }
224 template<typename T
, typename
... Args
>
225 void log_dump_args_worker(const char *p
, T first
, Args
... args
)
227 int next_p_state
= 0;
228 const char *next_p
= p
;
229 while (*next_p
&& (next_p_state
!= 0 || *next_p
!= ',')) {
233 while (*next_p
== '\\' && *(next_p
+ 1))
235 } while (*next_p
&& *next_p
!= '"');
236 if (*next_p
== '\'') {
243 if (*next_p
== '(' || *next_p
== '[' || *next_p
== '{')
245 if ((*next_p
== ')' || *next_p
== ']' || *next_p
== '}') && next_p_state
> 0)
249 log("\n\t%.*s => ", int(next_p
- p
), p
);
252 while (*next_p
== ' ' || *next_p
== '\t' || *next_p
== '\r' || *next_p
== '\n')
254 log_dump_val_worker(first
);
255 log_dump_args_worker(next_p
, args
...);
258 #define log_dump(...) do { \
259 log("DEBUG DUMP IN %s AT %s:%d:", __PRETTY_FUNCTION__, __FILE__, __LINE__); \
260 log_dump_args_worker(#__VA_ARGS__, __VA_ARGS__); \