Skip to content

Logging: Add log stream that only get sent warning+ logs. #5311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Logging: Add log stream that only get sent warning+ logs. #5311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
abde11e
Logging: Add log stream that only get sent warning+ logs.
Logikable Sep 15, 2025
45f6c62
Fix tests/various/logger_cmd_error.sh.
Logikable Sep 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 17 additions & 7 deletions kernel/log.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
YOSYS_NAMESPACE_BEGIN

std::vector<FILE*> log_files;
std::vector<std::ostream*> log_streams;
std::vector<std::ostream*> log_streams, log_warning_streams;
std::vector<std::string> log_scratchpads;
std::map<std::string, std::set<std::string>> log_hdump;
std::vector<std::regex> log_warn_regexes, log_nowarn_regexes, log_werror_regexes;
Expand Down Expand Up @@ -102,7 +102,7 @@ int gettimeofday(struct timeval *tv, struct timezone *tz)
}
#endif

static void logv_string(std::string_view format, std::string str) {
static void logv_string(std::string_view format, std::string str, LogSeverity severity = LogSeverity::LOG_INFO) {
size_t remove_leading = 0;
while (format.size() > 1 && format[0] == '\n') {
logv_string("\n", "\n");
Expand Down Expand Up @@ -158,6 +158,10 @@ static void logv_string(std::string_view format, std::string str) {

for (auto f : log_streams)
*f << time_str;

if (severity >= LogSeverity::LOG_WARNING)
for (auto f : log_warning_streams)
*f << time_str;
}

for (auto f : log_files)
Expand All @@ -166,6 +170,12 @@ static void logv_string(std::string_view format, std::string str) {
for (auto f : log_streams)
*f << str;

if (severity >= LogSeverity::LOG_WARNING)
for (auto f : log_warning_streams) {
*f << str;
f->flush();
}

RTLIL::Design *design = yosys_get_design();
if (design != nullptr)
for (auto &scratchpad : log_scratchpads)
Expand Down Expand Up @@ -203,11 +213,11 @@ static void logv_string(std::string_view format, std::string str) {
}
}

void log_formatted_string(std::string_view format, std::string str)
void log_formatted_string(std::string_view format, std::string str, LogSeverity severity)
{
if (log_make_debug && !ys_debug(1))
return;
logv_string(format, std::move(str));
logv_string(format, std::move(str), severity);
}

void log_formatted_header(RTLIL::Design *design, std::string_view format, std::string str)
Expand Down Expand Up @@ -293,7 +303,7 @@ void log_formatted_warning(std::string_view prefix, std::string message)
if (log_errfile != NULL && !log_quiet_warnings)
log_files.push_back(log_errfile);

log("%s%s", prefix, message);
log_formatted_string("%s", stringf("%s%s", prefix, message), LogSeverity::LOG_WARNING);
log_flush();

if (log_errfile != NULL && !log_quiet_warnings)
Expand Down Expand Up @@ -339,7 +349,7 @@ static void log_error_with_prefix(std::string_view prefix, std::string str)
f = stderr;

log_last_error = std::move(str);
log("%s%s", prefix, log_last_error);
log_formatted_string("%s", stringf("%s%s", prefix, log_last_error), LogSeverity::LOG_ERROR);
log_flush();

log_make_debug = bak_log_make_debug;
Expand Down Expand Up @@ -420,7 +430,7 @@ void log_formatted_cmd_error(std::string str)
pop_errfile = true;
}

log("ERROR: %s", log_last_error);
log_formatted_string("%s", stringf("ERROR: %s", log_last_error), LogSeverity::LOG_ERROR);
log_flush();

if (pop_errfile)
Expand Down
11 changes: 8 additions & 3 deletions kernel/log.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,15 @@

struct log_cmd_error_exception { };

enum LogSeverity {
LOG_INFO,
LOG_WARNING,
LOG_ERROR
};

extern std::vector<FILE*> log_files;
extern std::vector<std::ostream*> log_streams;
extern std::vector<std::ostream*> log_warning_streams;
extern std::vector<std::string> log_scratchpads;
extern std::map<std::string, std::set<std::string>> log_hdump;
extern std::vector<std::regex> log_warn_regexes, log_nowarn_regexes, log_werror_regexes;
Expand Down Expand Up @@ -131,12 +138,10 @@
#endif
# define log_debug(...) do { if (ys_debug(1)) log(__VA_ARGS__); } while (0)

void log_formatted_string(std::string_view format, std::string str);
void log_formatted_string(std::string_view format, std::string str, LogSeverity severity = LogSeverity::LOG_INFO);
template <typename... Args>
inline void log(FmtString<TypeIdentity<Args>...> fmt, const Args &... args)
{
if (log_make_debug && !ys_debug(1))
return;
log_formatted_string(fmt.format_string(), fmt.format(args...));
}

Expand Down Expand Up @@ -273,7 +278,7 @@
static inline void log_assert_worker(bool cond, const char *expr, const char *file, int line) {
if (!cond) log_assert_failure(expr, file, line);
}
# define log_assert(_assert_expr_) YOSYS_NAMESPACE_PREFIX log_assert_worker(_assert_expr_, #_assert_expr_, __FILE__, __LINE__)

Check warning on line 281 in kernel/log.h

View workflow job for this annotation

GitHub Actions / test-compile (ubuntu-latest, gcc-13) 

this statement may fall through [-Wimplicit-fallthrough=]

Check warning on line 281 in kernel/log.h

View workflow job for this annotation

GitHub Actions / test-compile (ubuntu-latest, gcc-13) 

this statement may fall through [-Wimplicit-fallthrough=]
#else
# define log_assert(_assert_expr_) do { if (0) { (void)(_assert_expr_); } } while(0)
#endif
Expand Down
Loading