2 * yosys -- Yosys Open SYnthesis Suite
4 * Copyright (C) 2020 Miodrag Milanovic <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/register.h"
21 #include "kernel/log.h"
24 PRIVATE_NAMESPACE_BEGIN
26 struct LoggerPass
: public Pass
{
27 LoggerPass() : Pass("logger", "set logger properties") { }
28 void help() YS_OVERRIDE
30 // |---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|---v---|
32 log(" logger [options]\n");
34 log("This command sets global logger properties, also available using command line\n");
38 log(" enable/disable display of timestamp in log output.\n");
40 log(" -[no]stderr\n");
41 log(" enable/disable logging errors to stderr.\n");
43 log(" -warn regex\n");
44 log(" print a warning for all log messages matching the regex.\n");
46 log(" -nowarn regex\n");
47 log(" if a warning message matches the regex, it is printed as regular\n");
48 log(" message instead.\n");
50 log(" -werror regex\n");
51 log(" if a warning message matches the regex, it is printed as error\n");
52 log(" message instead and the tool terminates with a nonzero return code.\n");
55 log(" globally enable/disable debug log messages.\n");
57 log(" -experimental <feature>\n");
58 log(" do not print warnings for the specified experimental feature\n");
60 log(" -expect <type> <regex> <expected_count>\n");
61 log(" expect log,warning or error to appear. In case of error return code is 0.\n");
63 log(" -expect-no-warnings\n");
64 log(" gives error in case there is at least one warning.\n");
68 void execute(std::vector
<std::string
> args
, RTLIL::Design
* design
) YS_OVERRIDE
71 for (argidx
= 1; argidx
< args
.size(); argidx
++)
74 if (args
[argidx
] == "-time") {
76 log("Enabled timestamp in logs.");
79 if (args
[argidx
] == "-notime") {
81 log("Disabled timestamp in logs.");
84 if (args
[argidx
] == "-stderr") {
85 log_error_stderr
= true;
86 log("Enabled loggint errors to stderr.");
89 if (args
[argidx
] == "-nostderr") {
90 log_error_stderr
= false;
91 log("Disabled loggint errors to stderr.");
94 if (args
[argidx
] == "-warn" && argidx
+1 < args
.size()) {
95 std::string pattern
= args
[++argidx
];
96 if (pattern
.front() == '\"' && pattern
.back() == '\"') pattern
= pattern
.substr(1, pattern
.size() - 2);
97 log("Added regex '%s' for warnings to warn list.", pattern
.c_str());
98 log_warn_regexes
.push_back(std::regex(pattern
,
99 std::regex_constants::nosubs
|
100 std::regex_constants::optimize
|
101 std::regex_constants::egrep
));
104 if (args
[argidx
] == "-nowarn" && argidx
+1 < args
.size()) {
105 std::string pattern
= args
[++argidx
];
106 if (pattern
.front() == '\"' && pattern
.back() == '\"') pattern
= pattern
.substr(1, pattern
.size() - 2);
107 log("Added regex '%s' for warnings to nowarn list.", pattern
.c_str());
108 log_nowarn_regexes
.push_back(std::regex(pattern
,
109 std::regex_constants::nosubs
|
110 std::regex_constants::optimize
|
111 std::regex_constants::egrep
));
114 if (args
[argidx
] == "-werror" && argidx
+1 < args
.size()) {
115 std::string pattern
= args
[++argidx
];
116 if (pattern
.front() == '\"' && pattern
.back() == '\"') pattern
= pattern
.substr(1, pattern
.size() - 2);
117 log("Added regex '%s' for warnings to werror list.", pattern
.c_str());
118 log_werror_regexes
.push_back(std::regex(pattern
,
119 std::regex_constants::nosubs
|
120 std::regex_constants::optimize
|
121 std::regex_constants::egrep
));
124 if (args
[argidx
] == "-debug") {
126 log("Enabled debug log messages.");
129 if (args
[argidx
] == "-nodebug") {
131 log("Disabled debug log messages.");
134 if (args
[argidx
] == "-experimental" && argidx
+1 < args
.size()) {
135 std::string value
= args
[++argidx
];
136 log("Added '%s' experimental ignore list.", value
.c_str());
137 log_experimentals_ignored
.insert(value
);
140 if (args
[argidx
] == "-expect" && argidx
+3 < args
.size()) {
141 std::string type
= args
[++argidx
];
142 if (type
!="error" && type
!="warning" && type
!="log")
143 log_cmd_error("Expect command require type to be 'log', 'warning' or 'error' !\n");
144 if (type
=="error" && log_expect_error
.size()>0)
145 log_cmd_error("Only single error message can be expected !\n");
146 std::string pattern
= args
[++argidx
];
147 if (pattern
.front() == '\"' && pattern
.back() == '\"') pattern
= pattern
.substr(1, pattern
.size() - 2);
148 int count
= atoi(args
[++argidx
].c_str());
150 log_cmd_error("Number of expected messages must be higher then 0 !\n");
151 if (type
=="error" && count
!=1)
152 log_cmd_error("Expected error message occurrences must be 1 !\n");
153 log("Added regex '%s' for warnings to expected %s list.\n", pattern
.c_str(), type
.c_str());
155 log_expect_error
.push_back(std::make_pair(std::regex(pattern
,
156 std::regex_constants::nosubs
|
157 std::regex_constants::optimize
|
158 std::regex_constants::egrep
), LogExpectedItem(pattern
, count
)));
159 else if (type
=="warning")
160 log_expect_warning
.push_back(std::make_pair(std::regex(pattern
,
161 std::regex_constants::nosubs
|
162 std::regex_constants::optimize
|
163 std::regex_constants::egrep
), LogExpectedItem(pattern
, count
)));
165 log_expect_log
.push_back(std::make_pair(std::regex(pattern
,
166 std::regex_constants::nosubs
|
167 std::regex_constants::optimize
|
168 std::regex_constants::egrep
), LogExpectedItem(pattern
, count
)));
172 if (args
[argidx
] == "-expect-no-warnings") {
173 log_expect_no_warnings
= true;
178 extra_args(args
, argidx
, design
, false);
182 PRIVATE_NAMESPACE_END