rz_log.h File Reference

#include <rz_types.h>
#include <rz_userconf.h>

Go to the source code of this file.

Macros
#define	MACRO_LOG_FUNC   __func__
#define	RZ_DEFAULT_LOGLVL   RZ_LOGLVL_ERROR
#define	RZ_VLOG(lvl, tag, fmtstr, args)
#define	RZ_LOG(lvl, tag, fmtstr, ...)
#define	RZ_LOG_SILLY(fmtstr, ...)
#define	RZ_LOG_DEBUG(fmtstr, ...)
#define	RZ_LOG_VERBOSE(fmtstr, ...)
#define	RZ_LOG_INFO(fmtstr, ...)
#define	RZ_LOG_WARN(fmtstr, ...)
#define	RZ_LOG_ERROR(fmtstr, ...)
#define	RZ_LOG_FATAL(fmtstr, ...)

Typedefs
typedef enum rz_log_level	RzLogLevel
typedef void(*	RzLogCallback) (const char *output, const char *funcname, const char *filename, ut32 lineno, RzLogLevel level, const char *tag, const char *fmtstr,...) RZ_PRINTF_CHECK(7

Enumerations
enum	rz_log_level {   RZ_LOGLVL_SILLY = 0 , RZ_LOGLVL_DEBUG = 1 , RZ_LOGLVL_VERBOSE = 2 , RZ_LOGLVL_INFO = 3 ,   RZ_LOGLVL_WARN = 4 , RZ_LOGLVL_ERROR = 5 , RZ_LOGLVL_FATAL = 6 , RZ_LOGLVL_NONE = 0xFF }

Functions
RZ_API void	rz_log_set_level (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_colors)
RZ_API void	rz_log_set_traplevel (RzLogLevel level)
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_log (const char *funcname, const char *filename, ut32 lineno, RzLogLevel level, const char *tag, const char *fmtstr,...) RZ_PRINTF_CHECK(6
RZ_API void RZ_API void	rz_vlog (const char *funcname, const char *filename, ut32 lineno, RzLogLevel level, const char *tag, const char *fmtstr, va_list args)

Macro Definition Documentation

MACRO_LOG_FUNC

#define MACRO_LOG_FUNC   __func__

Definition at line 13 of file rz_log.h.

RZ_DEFAULT_LOGLVL

#define RZ_DEFAULT_LOGLVL   RZ_LOGLVL_ERROR

Definition at line 30 of file rz_log.h.

RZ_LOG

#define RZ_LOG	(		lvl,
			tag,
			fmtstr,
			...
	)

Value:

    rz_log(MACRO_LOG_FUNC, __FILE__, \
    __LINE__, lvl, tag, fmtstr, ##__VA_ARGS__);

Definition at line 39 of file rz_log.h.

RZ_LOG_DEBUG

#define RZ_LOG_DEBUG	(		fmtstr,
			...
	)

Definition at line 49 of file rz_log.h.

RZ_LOG_ERROR

#define RZ_LOG_ERROR	(		fmtstr,
			...
	)

Value:

    rz_log(MACRO_LOG_FUNC, __FILE__, \
    __LINE__, RZ_LOGLVL_ERROR, NULL, fmtstr, ##__VA_ARGS__);

Definition at line 58 of file rz_log.h.

RZ_LOG_FATAL

#define RZ_LOG_FATAL	(		fmtstr,
			...
	)

Value:

    rz_log(MACRO_LOG_FUNC, __FILE__, \
    __LINE__, RZ_LOGLVL_FATAL, NULL, fmtstr, ##__VA_ARGS__);

Definition at line 60 of file rz_log.h.

RZ_LOG_INFO

#define RZ_LOG_INFO	(		fmtstr,
			...
	)

Value:

    rz_log(MACRO_LOG_FUNC, __FILE__, \
    __LINE__, RZ_LOGLVL_INFO, NULL, fmtstr, ##__VA_ARGS__);

Definition at line 54 of file rz_log.h.

RZ_LOG_SILLY

#define RZ_LOG_SILLY	(		fmtstr,
			...
	)

Definition at line 48 of file rz_log.h.

RZ_LOG_VERBOSE

#define RZ_LOG_VERBOSE	(		fmtstr,
			...
	)

Value:

    rz_log(MACRO_LOG_FUNC, __FILE__, \
    __LINE__, RZ_LOGLVL_VERBOSE, NULL, fmtstr, ##__VA_ARGS__);

Definition at line 52 of file rz_log.h.

RZ_LOG_WARN

#define RZ_LOG_WARN	(		fmtstr,
			...
	)

Value:

    rz_log(MACRO_LOG_FUNC, __FILE__, \
    __LINE__, RZ_LOGLVL_WARN, NULL, fmtstr, ##__VA_ARGS__);

Definition at line 56 of file rz_log.h.

RZ_VLOG

#define RZ_VLOG	(		lvl,
			tag,
			fmtstr,
			args
	)

Value:

    rz_vlog(MACRO_LOG_FUNC, __FILE__, \
    __LINE__, lvl, tag, fmtstr, args);

Definition at line 36 of file rz_log.h.

Typedef Documentation

RzLogCallback

typedef void(* RzLogCallback) (const char *output, const char *funcname, const char *filename, ut32 lineno, RzLogLevel level, const char *tag, const char *fmtstr,...) RZ_PRINTF_CHECK(7

Definition at line 33 of file rz_log.h.

RzLogLevel

typedef enum rz_log_level RzLogLevel

Enumeration Type Documentation

rz_log_level

enum rz_log_level

Enumerator
RZ_LOGLVL_SILLY
RZ_LOGLVL_DEBUG
RZ_LOGLVL_VERBOSE
RZ_LOGLVL_INFO
RZ_LOGLVL_WARN
RZ_LOGLVL_ERROR
RZ_LOGLVL_FATAL
RZ_LOGLVL_NONE

Definition at line 16 of file rz_log.h.

                          {
    RZ_LOGLVL_SILLY = 0,
    RZ_LOGLVL_DEBUG = 1,
    RZ_LOGLVL_VERBOSE = 2,
    RZ_LOGLVL_INFO = 3,
    RZ_LOGLVL_WARN = 4,
    RZ_LOGLVL_ERROR = 5,
    RZ_LOGLVL_FATAL = 6, // This will call rz_sys_breakpoint() and trap the process for debugging!
    RZ_LOGLVL_NONE = 0xFF
} RzLogLevel;

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,
			...
	)

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_colors

)

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_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().