mirrors/yosys
3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-08-04 02:10:24 +00:00
Code Activity

Make log() use the FmtString infrastructure.

Browse source 
Now `log()` supports `std::string`.

We have to fix a few places where the format parameter was not a compile time constant.
This is mostly trivial.
This commit is contained in:
Robert O'Callahan 2025-07-10 05:24:59 +00:00
parent 422ec05322
commit 2e28feed94
9 changed files with 67 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

1
kernel/io.h
View file

@ -423,6 +423,7 @@ public:
{
return format_emit_toplevel(fmt, has_escapes, specs, args...);
}
std::string_view format_string() const { return fmt; }
private:
std::string_view fmt;
bool has_escapes = false;

45
kernel/log.cc
View file

@ -101,17 +101,16 @@ int gettimeofday(struct timeval *tv, struct timezone *tz)
}
#endif
static void logv(const char *format, va_list ap)
{
while (format[0] == '\n' && format[1] != 0) {
log("\n");
format++;
static void logv_string(std::string_view format, std::string str) {
size_t remove_leading = 0;
while (format.size() > 1 && format[0] == '\n') {
logv_string("\n", "\n");
format = format.substr(1);
++remove_leading;
}
if (remove_leading > 0) {
str = str.substr(remove_leading);
}
if (log_make_debug && !ys_debug(1))
return;
std::string str = vstringf(format, ap);
if (str.empty())
return;
@ -144,13 +143,13 @@ static void logv(const char *format, va_list ap)
time_str += stringf("[%05d.%06d] ", int(tv.tv_sec), int(tv.tv_usec));
}
if (format[0] && format[strlen(format)-1] == '\n')
if (!format.empty() && format[format.size() - 1] == '\n')
next_print_log = true;
// Special case to detect newlines in Python log output, since
// the binding always calls `log("%s", payload)` and the newline
// is then in the first formatted argument
if (!strcmp(format, "%s") && str.back() == '\n')
if (format == "%s" && str.back() == '\n')
next_print_log = true;
for (auto f : log_files)
@ -203,6 +202,20 @@ static void logv(const char *format, va_list ap)
}
}
static void logv(const char *format, va_list ap)
{
if (log_make_debug && !ys_debug(1))
return;
logv_string(format, vstringf(format, ap));
}
void log_formatted_string(std::string_view format, std::string str)
{
if (log_make_debug && !ys_debug(1))
return;
logv_string(format, std::move(str));
}
static void logv_header(RTLIL::Design *design, const char *format, va_list ap)
{
bool pop_errfile = false;
@ -401,14 +414,6 @@ void log_file_error(const string &filename, int lineno,
logv_file_error(filename, lineno, format, ap);
}
void log(const char *format, ...)
{
va_list ap;
va_start(ap, format);
logv(format, ap);
va_end(ap);
}
void log_header(RTLIL::Design *design, const char *format, ...)
{
va_list ap;

35
kernel/log.h
View file

@ -121,7 +121,7 @@ extern int log_debug_suppressed;
[[noreturn]] void logv_file_error(const string &filename, int lineno, const char *format, va_list ap);
void log(const char *format, ...) YS_ATTRIBUTE(format(printf, 1, 2));
void log_header(RTLIL::Design *design, const char *format, ...) YS_ATTRIBUTE(format(printf, 2, 3));
void log_warning(const char *format, ...) YS_ATTRIBUTE(format(printf, 1, 2));
void log_experimental(const char *format, ...) YS_ATTRIBUTE(format(printf, 1, 2));
@ -145,6 +145,15 @@ static inline bool ys_debug(int = 0) { return false; }
#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);
template <typename... Args>
inline void log(FmtString<TypeIdentity<Args>...> fmt, Args... args)
{
if (log_make_debug && !ys_debug(1))
return;
log_formatted_string(fmt.format_string(), fmt.format(args...));
}
static inline void log_suppressed() {
if (log_debug_suppressed && !log_make_debug) {
log("<suppressed ~%d debug messages>\n", log_debug_suppressed);
@ -345,8 +354,22 @@ static inline void log_dump_val_worker(unsigned long int v) { log("%lu", v); }
static inline void log_dump_val_worker(long long int v) { log("%lld", v); }
static inline void log_dump_val_worker(unsigned long long int v) { log("%lld", v); }
#endif
static inline void log_dump_val_worker(char c) { log(c >= 32 && c < 127 ? "'%c'" : "'\\x%02x'", c); }
static inline void log_dump_val_worker(unsigned char c) { log(c >= 32 && c < 127 ? "'%c'" : "'\\x%02x'", c); }
static inline void log_dump_val_worker(char c)
{
if (c >= 32 && c < 127) {
log("'%c'", c);
} else {
log("'\\x%02x'", c);
}
}
static inline void log_dump_val_worker(unsigned char c)
{
if (c >= 32 && c < 127) {
log("'%c'", c);
} else {
log("'\\x%02x'", c);
}
}
static inline void log_dump_val_worker(bool v) { log("%s", v ? "true" : "false"); }
static inline void log_dump_val_worker(double v) { log("%f", v); }
static inline void log_dump_val_worker(char *v) { log("%s", v); }
@ -368,7 +391,7 @@ static inline void log_dump_val_worker(dict<K, T> &v) {
log("{");
bool first = true;
for (auto &it : v) {
log(first ? " " : ", ");
log("%s ", first ? "" : ",");
log_dump_val_worker(it.first);
log(": ");
log_dump_val_worker(it.second);
@ -382,7 +405,7 @@ static inline void log_dump_val_worker(pool<K> &v) {
log("{");
bool first = true;
for (auto &it : v) {
log(first ? " " : ", ");
log("%s ", first ? "" : ",");
log_dump_val_worker(it);
first = false;
}
@ -394,7 +417,7 @@ static inline void log_dump_val_worker(std::vector<K> &v) {
log("{");
bool first = true;
for (auto &it : v) {
log(first ? " " : ", ");
log("%s ", first ? "" : ",");
log_dump_val_worker(it);
first = false;
}