log.c File Reference

#include <rz_core.h>
#include <stdarg.h>

Go to the source code of this file.

Macros
#define	LOG_CONFIGSTR_SIZE   512
#define	LOG_OUTPUTBUF_SIZE   512

Functions
RZ_API void	rz_log_set_level (RzLogLevel level)
RZ_API void	rz_log_set_traplevel (RzLogLevel level)
RZ_API void	rz_log_set_file (const char *filename)
RZ_API void	rz_log_set_srcinfo (bool show_info)
RZ_API void	rz_log_set_colors (bool show_info)
RZ_API void	rz_log_add_callback (RzLogCallback cbfunc)
	Add a logging callback. More...
RZ_API void	rz_log_del_callback (RzLogCallback cbfunc)
	Remove a logging callback. More...
RZ_API void	rz_vlog (const char *funcname, const char *filename, ut32 lineno, RzLogLevel level, const char *tag, const char *fmtstr, va_list args)
RZ_API void	rz_log (const char *funcname, const char *filename, ut32 lineno, RzLogLevel level, const char *tag, const char *fmtstr,...)
	Internal logging function used by preprocessor macros. More...

Variables
static RzList *	log_cbs = NULL
static int	cfg_loglvl = RZ_LOGLVL_WARN
static int	cfg_logtraplvl = RZ_LOGLVL_FATAL
static bool	cfg_logsrcinfo = false
static bool	cfg_logcolors = false
static char	cfg_logfile [LOG_CONFIGSTR_SIZE] = ""
static const char *	level_tags []

Macro Definition Documentation

LOG_CONFIGSTR_SIZE

#define LOG_CONFIGSTR_SIZE   512

Definition at line 5 of file log.c.

LOG_OUTPUTBUF_SIZE

#define LOG_OUTPUTBUF_SIZE   512

Definition at line 6 of file log.c.

Function Documentation

rz_log()

RZ_API void rz_log	(	const char *	funcname,
		const char *	filename,
		ut32	lineno,
		RzLogLevel	level,
		const char *	tag,
		const char *	fmtstr,
			...
	)

Internal logging function used by preprocessor macros.

Parameters

funcname	Contains the function name of the calling function
filename	Contains the filename that funcname is defined in
lineno	The line number that this log call is being made from in filename
lvl	Logging level for output
fmtstr	A printf like string

This function is used by the RZ_LOG_* preprocessor macros for logging

Definition at line 143 of file log.c.

                                                                             {
    va_list args;
 
    va_start(args, fmtstr);
    rz_vlog(funcname, filename, lineno, level, tag, fmtstr, args);
    va_end(args);
}

References args, level, rz_vlog(), and test-lz4-versions::tag.

rz_log_add_callback()

RZ_API void rz_log_add_callback

(

RzLogCallback

cbfunc

)

Add a logging callback.

Parameters

cbfunc

RzLogCallback style function to be called

Definition at line 54 of file log.c.

                                                      {
    if (!log_cbs) {
        log_cbs = rz_list_new();
    }
    if (!rz_list_contains(log_cbs, cbfunc)) {
        rz_list_append(log_cbs, cbfunc);
    }
}

References log_cbs, rz_list_append(), rz_list_contains(), and rz_list_new().

rz_log_del_callback()

RZ_API void rz_log_del_callback

(

RzLogCallback

cbfunc

)

Remove a logging callback.

Parameters

cbfunc

RzLogCallback style function to be called

Definition at line 67 of file log.c.

                                                      {
    if (log_cbs) {
        rz_list_delete_data(log_cbs, cbfunc);
    }
}

References log_cbs, and rz_list_delete_data().

rz_log_set_colors()

RZ_API void rz_log_set_colors

(

bool

show_info

)

Definition at line 46 of file log.c.

                                              {
    cfg_logcolors = show_info;
}

References cfg_logcolors.

Referenced by cb_log_config_colors().

rz_log_set_file()

RZ_API void rz_log_set_file

(

const char *

filename

)

Definition at line 37 of file log.c.

                                                  {
    int value_len = rz_str_nlen(filename, LOG_CONFIGSTR_SIZE) + 1;
    strncpy(cfg_logfile, filename, value_len);
}

References cfg_logfile, LOG_CONFIGSTR_SIZE, and rz_str_nlen().

Referenced by cb_log_config_file().

rz_log_set_level()

RZ_API void rz_log_set_level

(

RzLogLevel

level

)

Definition at line 29 of file log.c.

                                               {
    cfg_loglvl = level;
}

References cfg_loglvl, and level.

Referenced by cb_log_config_level().

rz_log_set_srcinfo()

RZ_API void rz_log_set_srcinfo

(

bool

show_info

)

Definition at line 42 of file log.c.

                                               {
    cfg_logsrcinfo = show_info;
}

References cfg_logsrcinfo.

Referenced by cb_log_config_srcinfo().

rz_log_set_traplevel()

RZ_API void rz_log_set_traplevel

(

RzLogLevel

level

)

Definition at line 33 of file log.c.

                                                   {
    cfg_logtraplvl = level;
}

References cfg_logtraplvl, and level.

Referenced by cb_log_config_traplevel().

rz_vlog()

RZ_API void rz_vlog	(	const char *	funcname,
		const char *	filename,
		ut32	lineno,
		RzLogLevel	level,
		const char *	tag,
		const char *	fmtstr,
		va_list	args
	)

Definition at line 73 of file log.c.

                                                                                      {
    va_list args_copy;
    va_copy(args_copy, args);
 
    if (level < cfg_loglvl && level < cfg_logtraplvl) {
        // Don't print if output level is lower than current level
        // Don't ignore fatal/trap errors
        va_end(args_copy);
        return;
    }
 
    // TODO: Colors
 
    // Build output string with src info, and formatted output
    char output_buf[LOG_OUTPUTBUF_SIZE] = ""; // Big buffer for building the output string
    if (!tag) {
        tag = RZ_BETWEEN(0, level, RZ_ARRAY_SIZE(level_tags) - 1) ? level_tags[level] : "";
    }
    int offset = snprintf(output_buf, LOG_OUTPUTBUF_SIZE, "%s: ", tag);
    if (cfg_logsrcinfo) {
        offset += snprintf(output_buf + offset, LOG_OUTPUTBUF_SIZE - offset, "%s in %s:%i: ", funcname, filename, lineno);
    }
    vsnprintf(output_buf + offset, LOG_OUTPUTBUF_SIZE - offset, fmtstr, args);
 
    // Actually print out the string with our callbacks
    if (log_cbs && rz_list_length(log_cbs) > 0) {
        RzListIter *it;
        RzLogCallback cb;
 
        rz_list_foreach (log_cbs, it, cb) {
            cb(output_buf, funcname, filename, lineno, level, NULL, fmtstr, args_copy);
        }
    } else {
        fprintf(stderr, "%s", output_buf);
    }
    va_end(args_copy);
 
    // Log to file if enabled
    if (cfg_logfile[0] != 0x00) {
        FILE *file = rz_sys_fopen(cfg_logfile, "a+"); // TODO: Optimize (static? Needs to remake on cfg change though)
        if (!file) {
            file = rz_sys_fopen(cfg_logfile, "w+");
        }
        if (file) {
            fprintf(file, "%s", output_buf);
            fclose(file);
        } else {
            eprintf("%s failed to write to file: %s\n", MACRO_LOG_FUNC, cfg_logfile);
        }
    }
 
    if (level >= cfg_logtraplvl && level != RZ_LOGLVL_NONE) {
        fflush(stdout); // We're about to exit HARD, flush buffers before dying
        fflush(stderr);
        // TODO: call rz_cons_flush if librz_cons is being used
        rz_sys_breakpoint(); // *oof*
    }
}

References args, cb, cfg_logfile, cfg_loglvl, cfg_logsrcinfo, cfg_logtraplvl, eprintf, benchmark::FILE, level, level_tags, log_cbs, LOG_OUTPUTBUF_SIZE, MACRO_LOG_FUNC, NULL, RZ_ARRAY_SIZE, RZ_BETWEEN, rz_list_length(), RZ_LOGLVL_NONE, rz_sys_breakpoint, rz_sys_fopen(), snprintf, test-lz4-versions::tag, and vsnprintf.

Referenced by rz_log().

Variable Documentation

cfg_logcolors

bool cfg_logcolors = false

static

Definition at line 16 of file log.c.

Referenced by rz_log_set_colors().

cfg_logfile

char cfg_logfile[LOG_CONFIGSTR_SIZE] = ""

static

Definition at line 17 of file log.c.

Referenced by rz_log_set_file(), and rz_vlog().

cfg_loglvl

int cfg_loglvl = RZ_LOGLVL_WARN

static

Definition at line 13 of file log.c.

Referenced by rz_log_set_level(), and rz_vlog().

cfg_logsrcinfo

bool cfg_logsrcinfo = false

static

Definition at line 15 of file log.c.

Referenced by rz_log_set_srcinfo(), and rz_vlog().

cfg_logtraplvl

int cfg_logtraplvl = RZ_LOGLVL_FATAL

static

Definition at line 14 of file log.c.

Referenced by rz_log_set_traplevel(), and rz_vlog().

level_tags

const char* level_tags[]

static

Initial value:

= { 
    [RZ_LOGLVL_SILLY] = "SILLY",
    [RZ_LOGLVL_VERBOSE] = "VERBOSE",
    [RZ_LOGLVL_DEBUG] = "DEBUG",
    [RZ_LOGLVL_INFO] = "INFO",
    [RZ_LOGLVL_WARN] = "WARNING",
    [RZ_LOGLVL_ERROR] = "ERROR",
    [RZ_LOGLVL_FATAL] = "FATAL"
}

Definition at line 18 of file log.c.

Referenced by rz_vlog().

log_cbs

RzList* log_cbs = NULL

static

Definition at line 12 of file log.c.

Referenced by rz_log_add_callback(), rz_log_del_callback(), and rz_vlog().