log.h File Reference

#include "kernel/yosys.h"
#include <time.h>
#include <sys/time.h>
#include <sys/resource.h>

Include dependency graph for log.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	log_cmd_error_exception
struct	PerformanceTimer

Macros
#define	S__LINE__sub2(x)   #x
#define	S__LINE__sub1(x)   S__LINE__sub2(x)
#define	S__LINE__   S__LINE__sub1(__LINE__)
#define	log_abort()   YOSYS_NAMESPACE_PREFIX log_error("Abort in %s:%d.\n", __FILE__, __LINE__)
#define	log_assert(_assert_expr_)   YOSYS_NAMESPACE_PREFIX log_assert_worker(_assert_expr_, #_assert_expr_, __FILE__, __LINE__)
#define	log_ping()   YOSYS_NAMESPACE_PREFIX log("-- %s:%d %s --\n", __FILE__, __LINE__, __PRETTY_FUNCTION__)
#define	cover(...)   do { } while (0)
#define	cover_list(...)   do { } while (0)
#define	log_dump(...)

Functions
void	logv (const char *format, va_list ap)
void	logv_header (const char *format, va_list ap)
void	logv_warning (const char *format, va_list ap)
YS_NORETURN void	logv_error (const char *format, va_list ap) YS_ATTRIBUTE(noreturn)
void	log (const char *format,...) YS_ATTRIBUTE(format(printf
void void	log_header (const char *format,...) YS_ATTRIBUTE(format(printf
void void void	log_warning (const char *format,...) YS_ATTRIBUTE(format(printf
void void void YS_NORETURN void	log_error (const char *format,...) YS_ATTRIBUTE(format(printf
YS_NORETURN void	log_cmd_error (const char *format,...) YS_ATTRIBUTE(format(printf
void	log_spacer ()
void	log_push ()
void	log_pop ()
void	log_reset_stack ()
void	log_flush ()
const char *	log_signal (const RTLIL::SigSpec &sig, bool autoint=true)
const char *	log_id (RTLIL::IdString id)
template<typename T >
static const char *	log_id (T *obj)
void	log_cell (RTLIL::Cell *cell, std::string indent="")
static void	log_assert_worker (bool cond, const char *expr, const char *file, int line)
static void	log_dump_val_worker (short v)
static void	log_dump_val_worker (unsigned short v)
static void	log_dump_val_worker (int v)
static void	log_dump_val_worker (unsigned int v)
static void	log_dump_val_worker (long int v)
static void	log_dump_val_worker (unsigned long int v)
static void	log_dump_val_worker (long long int v)
static void	log_dump_val_worker (unsigned long long int v)
static void	log_dump_val_worker (char c)
static void	log_dump_val_worker (unsigned char c)
static void	log_dump_val_worker (bool v)
static void	log_dump_val_worker (double v)
static void	log_dump_val_worker (char *v)
static void	log_dump_val_worker (const char *v)
static void	log_dump_val_worker (std::string v)
static void	log_dump_val_worker (PerformanceTimer p)
static void	log_dump_args_worker (const char *p)
void	log_dump_val_worker (RTLIL::SigSpec v)
template<typename T >
static void	log_dump_val_worker (T *ptr)
template<typename T , typename... Args>
void	log_dump_args_worker (const char *p, T first, Args...args)

Variables
std::vector< FILE * >	log_files
std::vector< std::ostream * >	log_streams
FILE *	log_errfile
SHA1 *	log_hasher
bool	log_time
bool	log_cmd_error_throw
bool	log_quiet_warnings
int	log_verbose_level
void void void YS_NORETURN void	noreturn

Macro Definition Documentation

#define cover

(

...

)

do { } while (0)

Definition at line 131 of file log.h.

#define cover_list

(

...

)

do { } while (0)

Definition at line 132 of file log.h.

#define log_abort

(

)

YOSYS_NAMESPACE_PREFIX log_error("Abort in %s:%d.\n", __FILE__, __LINE__)

Definition at line 84 of file log.h.

#define log_assert

(

_assert_expr_

)

YOSYS_NAMESPACE_PREFIX log_assert_worker(_assert_expr_, #_assert_expr_, __FILE__, __LINE__)

Definition at line 85 of file log.h.

#define log_dump

(

...

)

Value:

do { \
	log("DEBUG DUMP IN %s AT %s:%d:", __PRETTY_FUNCTION__, __FILE__, __LINE__); \
	log_dump_args_worker(#__VA_ARGS__, __VA_ARGS__); \
	log("\n"); \
} while (0)

Definition at line 257 of file log.h.

#define log_ping

(

)

YOSYS_NAMESPACE_PREFIX log("-- %s:%d %s --\n", __FILE__, __LINE__, __PRETTY_FUNCTION__)

Definition at line 86 of file log.h.

#define S__LINE__   S__LINE__sub1(__LINE__)

Definition at line 39 of file log.h.

#define S__LINE__sub1

(

x

)

S__LINE__sub2(x)

Definition at line 38 of file log.h.

#define S__LINE__sub2

(

x

)

#x

Definition at line 37 of file log.h.

Function Documentation

void log	(	const char *	format,
			...
	)

Here is the caller graph for this function:

static void log_assert_worker ( bool  cond, const char *  expr, const char *  file, int  line  )

inlinestatic

Definition at line 80 of file log.h.

                                                                                              {
    if (!cond) log_error("Assert `%s' failed in %s:%d.\n", expr, file, line);
}

Here is the call graph for this function:

void log_cell	(	RTLIL::Cell *	cell,
		std::string	indent = ""
	)

Definition at line 292 of file log.cc.

{
    std::stringstream buf;
    ILANG_BACKEND::dump_cell(buf, indent, cell);
    log("%s", buf.str().c_str());
}

Here is the call graph for this function:

YS_NORETURN void log_cmd_error	(	const char *	format,
			...
	)

Here is the caller graph for this function:

static void log_dump_args_worker ( const char *  p )

inlinestatic

Definition at line 217 of file log.h.

{ log_assert(*p == 0); }

Here is the caller graph for this function:

template<typename T , typename... Args>

void log_dump_args_worker	(	const char *	p,
		T	first,
		Args...	args
	)

Definition at line 224 of file log.h.

{
    int next_p_state = 0;
    const char *next_p = p;
    while (*next_p && (next_p_state != 0 || *next_p != ',')) {
        if (*next_p == '"')
            do {
                next_p++;
                while (*next_p == '\\' && *(next_p + 1))
                    next_p += 2;
            } while (*next_p && *next_p != '"');
        if (*next_p == '\'') {
            next_p++;
            if (*next_p == '\\')
                next_p++;
            if (*next_p)
                next_p++;
        }
        if (*next_p == '(' || *next_p == '[' || *next_p == '{')
            next_p_state++;
        if ((*next_p == ')' || *next_p == ']' || *next_p == '}') && next_p_state > 0)
            next_p_state--;
        next_p++;
    }
    log("\n\t%.*s => ", int(next_p - p), p);
    if (*next_p == ',')
        next_p++;
    while (*next_p == ' ' || *next_p == '\t' || *next_p == '\r' || *next_p == '\n')
        next_p++;
    log_dump_val_worker(first);
    log_dump_args_worker(next_p, args ...);
}

Here is the call graph for this function:

static void log_dump_val_worker ( short  v )

inlinestatic

Definition at line 199 of file log.h.

{ log("%d", v); }

Here is the call graph for this function:

Here is the caller graph for this function:

static void log_dump_val_worker ( unsigned short  v )

inlinestatic

Definition at line 200 of file log.h.

{ log("%u", v); }

Here is the call graph for this function:

static void log_dump_val_worker ( int  v )

inlinestatic

Definition at line 201 of file log.h.

{ log("%d", v); }

Here is the call graph for this function:

static void log_dump_val_worker ( unsigned int  v )

inlinestatic

Definition at line 202 of file log.h.

{ log("%u", v); }

Here is the call graph for this function:

static void log_dump_val_worker ( long int  v )

inlinestatic

Definition at line 203 of file log.h.

{ log("%ld", v); }

Here is the call graph for this function:

static void log_dump_val_worker ( unsigned long int  v )

inlinestatic

Definition at line 204 of file log.h.

{ log("%lu", v); }

Here is the call graph for this function:

static void log_dump_val_worker ( long long int  v )

inlinestatic

Definition at line 206 of file log.h.

{ log("%lld", v); }

Here is the call graph for this function:

static void log_dump_val_worker ( unsigned long long int  v )

inlinestatic

Definition at line 207 of file log.h.

{ log("%lld", v); }

Here is the call graph for this function:

static void log_dump_val_worker ( char  c )

inlinestatic

Definition at line 209 of file log.h.

{ log(c >= 32 && c < 127 ? "'%c'" : "'\\x%02x'", c); }

Here is the call graph for this function:

static void log_dump_val_worker ( unsigned char  c )

inlinestatic

Definition at line 210 of file log.h.

{ log(c >= 32 && c < 127 ? "'%c'" : "'\\x%02x'", c); }

Here is the call graph for this function:

static void log_dump_val_worker ( bool  v )

inlinestatic

Definition at line 211 of file log.h.

{ log("%s", v ? "true" : "false"); }

Here is the call graph for this function:

static void log_dump_val_worker ( double  v )

inlinestatic

Definition at line 212 of file log.h.

{ log("%f", v); }

Here is the call graph for this function:

static void log_dump_val_worker ( char *  v )

inlinestatic

Definition at line 213 of file log.h.

{ log("%s", v); }

Here is the call graph for this function:

static void log_dump_val_worker ( const char *  v )

inlinestatic

Definition at line 214 of file log.h.

{ log("%s", v); }

Here is the call graph for this function:

static void log_dump_val_worker ( std::string  v )

inlinestatic

Definition at line 215 of file log.h.

{ log("%s", v.c_str()); }

Here is the call graph for this function:

static void log_dump_val_worker ( PerformanceTimer  p )

inlinestatic

Definition at line 216 of file log.h.

{ log("%f seconds", p.sec()); }

Here is the call graph for this function:

void log_dump_val_worker

(

RTLIL::SigSpec

v

)

Definition at line 265 of file log.cc.

                                         {
    log("%s", log_signal(v));
}

Here is the call graph for this function:

template<typename T >

static void log_dump_val_worker ( T *  ptr )

inlinestatic

Definition at line 221 of file log.h.

{ log("%p", ptr); }

Here is the call graph for this function:

void void void YS_NORETURN void log_error	(	const char *	format,
			...
	)

Here is the caller graph for this function:

void log_flush

(

)

Definition at line 256 of file log.cc.

{
    for (auto f : log_files)
        fflush(f);

    for (auto f : log_streams)
        f->flush();
}

Here is the caller graph for this function:

void void log_header	(	const char *	format,
			...
	)

const char* log_id

(

RTLIL::IdString

id

)

Definition at line 283 of file log.cc.

{
    log_id_cache.insert(str);
    const char *p = str.c_str();
    if (p[0] == '\\' && p[1] != '$' && p[1] != 0)
        return p+1;
    return p;
}

Here is the call graph for this function:

template<typename T >

static const char* log_id ( T *  obj )

inlinestatic

Definition at line 74 of file log.h.

                                                              {
    return log_id(obj->name);
}

Here is the call graph for this function:

void log_pop

(

)

Definition at line 237 of file log.cc.

{
    header_count.pop_back();
    log_id_cache.clear();
    string_buf.clear();
    string_buf_size = 0;
    log_flush();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void log_push

(

)

Definition at line 232 of file log.cc.

{
    header_count.push_back(0);
}

Here is the caller graph for this function:

void log_reset_stack

(

)

Definition at line 246 of file log.cc.

{
    while (header_count.size() > 1)
        header_count.pop_back();
    log_id_cache.clear();
    string_buf.clear();
    string_buf_size = 0;
    log_flush();
}

Here is the call graph for this function:

Here is the caller graph for this function:

const char* log_signal	(	const RTLIL::SigSpec &	sig,
		bool	autoint = true
	)

Definition at line 269 of file log.cc.

{
    std::stringstream buf;
    ILANG_BACKEND::dump_sigspec(buf, sig, autoint);

    if (string_buf_size < 100)
        string_buf_size++;
    else
        string_buf.pop_front();
    string_buf.push_back(buf.str());

    return string_buf.back().c_str();
}

Here is the call graph for this function:

void log_spacer

(

)

Definition at line 226 of file log.cc.

{
    while (log_newline_count < 2)
        log("\n");
}

Here is the call graph for this function:

Here is the caller graph for this function:

void void void log_warning	(	const char *	format,
			...
	)

void logv	(	const char *	format,
		va_list	ap
	)

Definition at line 76 of file log.cc.

{
    while (format[0] == '\n' && format[1] != 0) {
        log("\n");
        format++;
    }

    std::string str = vstringf(format, ap);

    if (str.empty())
        return;

    size_t nnl_pos = str.find_last_not_of('\n');
    if (nnl_pos == std::string::npos)
        log_newline_count += GetSize(str);
    else
        log_newline_count = GetSize(str) - nnl_pos - 1;

    if (log_hasher)
        log_hasher->update(str);

    if (log_time)
    {
        std::string time_str;

        if (next_print_log || initial_tv.tv_sec == 0) {
            next_print_log = false;
            struct timeval tv;
            gettimeofday(&tv, NULL);
            if (initial_tv.tv_sec == 0)
                initial_tv = tv;
            if (tv.tv_usec < initial_tv.tv_usec) {
                tv.tv_sec--;
                tv.tv_usec += 1000000;
            }
            tv.tv_sec -= initial_tv.tv_sec;
            tv.tv_usec -= initial_tv.tv_usec;
            time_str += stringf("[%05d.%06d] ", int(tv.tv_sec), int(tv.tv_usec));
        }

        if (format[0] && format[strlen(format)-1] == '\n')
            next_print_log = true;

        for (auto f : log_files)
            fputs(time_str.c_str(), f);

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

    for (auto f : log_files)
        fputs(str.c_str(), f);

    for (auto f : log_streams)
        *f << str;
}

Here is the call graph for this function:

Here is the caller graph for this function:

YS_NORETURN void logv_error	(	const char *	format,
		va_list	ap
	)

Definition at line 169 of file log.cc.

{
    if (log_errfile != NULL)
        log_files.push_back(log_errfile);

    log("ERROR: ");
    logv(format, ap);
    log_flush();
    exit(1);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void logv_header	(	const char *	format,
		va_list	ap
	)

Definition at line 133 of file log.cc.

{
    bool pop_errfile = false;

    log_spacer();
    if (header_count.size() > 0)
        header_count.back()++;

    if (int(header_count.size()) <= log_verbose_level && log_errfile != NULL) {
        log_files.push_back(log_errfile);
        pop_errfile = true;
    }

    for (int c : header_count)
        log("%d.", c);
    log(" ");
    logv(format, ap);
    log_flush();

    if (pop_errfile)
        log_files.pop_back();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void logv_warning	(	const char *	format,
		va_list	ap
	)

Definition at line 156 of file log.cc.

{
    if (log_errfile != NULL && !log_quiet_warnings)
        log_files.push_back(log_errfile);

    log("Warning: ");
    logv(format, ap);
    log_flush();

    if (log_errfile != NULL && !log_quiet_warnings)
        log_files.pop_back();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

bool log_cmd_error_throw

Definition at line 43 of file log.cc.

FILE* log_errfile

Definition at line 39 of file log.cc.

std::vector<FILE*> log_files

Definition at line 37 of file log.cc.

SHA1* log_hasher

Definition at line 40 of file log.cc.

bool log_quiet_warnings

Definition at line 44 of file log.cc.

std::vector<std::ostream*> log_streams

Definition at line 38 of file log.cc.

bool log_time

Definition at line 42 of file log.cc.

int log_verbose_level

Definition at line 45 of file log.cc.

YS_NORETURN void noreturn

Definition at line 61 of file log.h.