Logging

Write text to console or file. More...

Modules
	File logger
	A logger that writes messages to a file.

Data Structures
struct	bio_logger_t
	Handle to a logger. More...
struct	bio_log_options_t
	Logging options. More...
struct	bio_log_ctx_t
	Context for a log function. More...

Macros
#define	BIO_LOG(LEVEL, ...)    (BIO_FORMAT_CHECK(__VA_ARGS__), bio_log(LEVEL, __FILE__, __LINE__, __VA_ARGS__))
	Log a message at a given log level.
#define	BIO_TRACE(...)   BIO_LOG(BIO_LOG_LEVEL_TRACE, __VA_ARGS__)
	Log a message at BIO_LOG_LEVEL_TRACE level.
#define	BIO_DEBUG(...)   BIO_LOG(BIO_LOG_LEVEL_DEBUG, __VA_ARGS__)
	Log a message at BIO_LOG_LEVEL_DEBUG level.
#define	BIO_INFO(...)   BIO_LOG(BIO_LOG_LEVEL_INFO , __VA_ARGS__)
	Log a message at BIO_LOG_LEVEL_DEBUG level.
#define	BIO_WARN(...)   BIO_LOG(BIO_LOG_LEVEL_WARN , __VA_ARGS__)
	Log a message at BIO_LOG_LEVEL_WARN level.
#define	BIO_ERROR(...)   BIO_LOG(BIO_LOG_LEVEL_ERROR, __VA_ARGS__)
	Log a message at BIO_LOG_LEVEL_ERROR level.
#define	BIO_FATAL(...)   BIO_LOG(BIO_LOG_LEVEL_FATAL, __VA_ARGS__)
	Log a message at BIO_LOG_LEVEL_FATAL level.
#define	BIO_ERROR_FMT   "%s (%s[%d]) (from %s:%d)"
	Helper for logging a bio_error_t.
#define	BIO_ERROR_FMT_ARGS(error)
	Helper for logging a bio_error_t.

Typedefs
typedef void(*	bio_log_fn_t) (void *userdata, const bio_log_ctx_t *ctx, const char *msg)
	A log callback.

Enumerations
enum	bio_log_level_t {   BIO_LOG_LEVEL_TRACE , BIO_LOG_LEVEL_DEBUG , BIO_LOG_LEVEL_INFO , BIO_LOG_LEVEL_WARN ,   BIO_LOG_LEVEL_ERROR , BIO_LOG_LEVEL_FATAL }
	Log levels. More...

Functions
void	bio_log (bio_log_level_t level, const char *file, int line, const char *fmt,...)
	Raw logging function.
bio_logger_t	bio_add_logger (bio_log_level_t min_level, bio_log_fn_t log_fn, void *userdata)
	Add a new logger.
void	bio_remove_logger (bio_logger_t logger)
	Remove a previously configured logger.
void	bio_set_min_log_level (bio_logger_t logger, bio_log_level_t level)
	Change the minimum log level for a given logger.

Detailed Description

Write text to console or file.

There are several logging macros that should be used instead of the raw bio_log function.

Remarks

By default, there is no logger configured. See File logger.

See also

bio_options_t::log_options

Macro Definition Documentation

BIO_DEBUG

#define BIO_DEBUG

(

...

)

BIO_LOG(BIO_LOG_LEVEL_DEBUG, __VA_ARGS__)

Log a message at BIO_LOG_LEVEL_DEBUG level.

BIO_ERROR

#define BIO_ERROR

(

...

)

BIO_LOG(BIO_LOG_LEVEL_ERROR, __VA_ARGS__)

Log a message at BIO_LOG_LEVEL_ERROR level.

BIO_ERROR_FMT

#define BIO_ERROR_FMT   "%s (%s[%d]) (from %s:%d)"

Helper for logging a bio_error_t.

Example:

bio_error_t error = { 0 };
if (!bio_fstat(file, &stat, &error)) {
    BIO_ERROR("Error while stat-ing: " BIO_ERROR_FMT, BIO_ERROR_FMT_ARGS(&error));
}

See also

BIO_ERROR_FMT_ARGS

BIO_ERROR_FMT_ARGS

#define BIO_ERROR_FMT_ARGS

(

error

)

Value:

    (bio_has_error((error)) ? bio_strerror((error)) : "No error"), \
    (bio_has_error((error)) ? (error)->tag->name : "bio.error.core"), \
    ((error)->code), \
    ((error)->file ? (error)->file : "<no source info>"), \
    ((error)->line)

Helper for logging a bio_error_t.

See also

BIO_ERROR_FMT

BIO_FATAL

#define BIO_FATAL

(

...

)

BIO_LOG(BIO_LOG_LEVEL_FATAL, __VA_ARGS__)

Log a message at BIO_LOG_LEVEL_FATAL level.

BIO_INFO

#define BIO_INFO

(

...

)

BIO_LOG(BIO_LOG_LEVEL_INFO , __VA_ARGS__)

Log a message at BIO_LOG_LEVEL_DEBUG level.

BIO_LOG

#define BIO_LOG	(		LEVEL,
			...
	)		(BIO_FORMAT_CHECK(__VA_ARGS__), bio_log(LEVEL, __FILE__, __LINE__, __VA_ARGS__))

Log a message at a given log level.

BIO_LOG(BIO_LOG_LEVEL_INFO, "Hello %s", "world");

Parameters

LEVEL	a bio_log_level_t
...	The log message. This can use a printf-like format string

BIO_TRACE

#define BIO_TRACE

(

...

)

BIO_LOG(BIO_LOG_LEVEL_TRACE, __VA_ARGS__)

Log a message at BIO_LOG_LEVEL_TRACE level.

BIO_WARN

#define BIO_WARN

(

...

)

BIO_LOG(BIO_LOG_LEVEL_WARN , __VA_ARGS__)

Log a message at BIO_LOG_LEVEL_WARN level.

Typedef Documentation

bio_log_fn_t

typedef void(* bio_log_fn_t) (void *userdata, const bio_log_ctx_t *ctx, const char *msg)

A log callback.

This will be called for every message passed to bio_log.

Remarks

When bio_remove_logger is called, this will be invoked with ctx and msg set to NULL instead. The callback should perform cleanup or "flush" buffered messages.

Parameters

userdata	Arbitrary user data
ctx	Log context
msg	Log message

See also

bio_add_logger

Enumeration Type Documentation

bio_log_level_t

enum bio_log_level_t

Log levels.

Enumerator
BIO_LOG_LEVEL_TRACE	Tracing message, for debugging.
BIO_LOG_LEVEL_DEBUG	Debug message.
BIO_LOG_LEVEL_INFO	Info message.
BIO_LOG_LEVEL_WARN	Warning.
BIO_LOG_LEVEL_ERROR	Error but usually recoverable.
BIO_LOG_LEVEL_FATAL	Fatal, the program usually terminates after this.

Function Documentation

bio_add_logger()

bio_logger_t bio_add_logger	(	bio_log_level_t	min_level,
		bio_log_fn_t	log_fn,
		void *	userdata
	)

Add a new logger.

The logger will run in its own daemon coroutine.

bio will automatically call bio_remove_logger on all loggers when bio_terminate is called. This will terminate the daemon coroutine.

Parameters

min_level	Minimum log level for this logger
log_fn	The log function
userdata	Arbitrary data passed to the log function for every message

Returns

A logger handle

bio_log()

void bio_log	(	bio_log_level_t	level,
		const char *	file,
		int	line,
		const char *	fmt,
			...
	)

Raw logging function.

Use the logging macros instead.

bio_remove_logger()

void bio_remove_logger

(

bio_logger_t

logger

)

Remove a previously configured logger.

The log function will be called with NULL arguments, except for userdata. This allows it to have a final chance to "flush" all buffered messages.

bio_set_min_log_level()

void bio_set_min_log_level	(	bio_logger_t	logger,
		bio_log_level_t	level
	)

Change the minimum log level for a given logger.