#ifndef LOG_H
#define LOG_H
/** @file log.h
*
* Local logging functions
*/
#include "error.h"
#include <stdarg.h>
/**
* Log level definitions
*
* XXX: these names conflict with <syslog.h>
*/
enum log_level {
LOG_DEBUG,
LOG_INFO,
LOG_WARN,
LOG_ERROR,
LOG_FATAL,
};
/**
* List of log_level values as strings, NULL-terminated
*/
extern const char *log_level_names[];
/**
* The default log level
*/
#define LOG_LEVEL_DEFAULT LOG_INFO
/**
* Maximum length of a log message, including terminating NUL
*/
#define LOG_MSG_MAX 1024
/**
* Log output function, for displaying a line of text, without any trailing newline.
*/
typedef void (*log_output_func) (const char *line, void *arg);
/**
* Set the current log level to filter out messages below the given level
*/
void set_log_level (enum log_level level);
/**
* Set the current log output function, replacing any default or previous value.
*
* Pass in func as NULL to revert to the default handler.
*/
void log_set_func (log_output_func func, void *arg);
/**
* Internal logging func, meant for using custom level tags. This performs the filtering of log levels.
*
* Format the full output line, and pass it to the log_output_func. The line will be of the form:
* "[<tag>] <func> : <user_fmt> [ <log_fmt> ]"
*/
void log_output_tag (enum log_level level, const char *tag, const char *func, const char *user_fmt, va_list user_fmtargs, const char *log_fmt, ...)
__attribute__ ((format (printf, 6, 7)));
/**
* Log a message with the given level
*/
#define log_msg(level, ...) _log_msg(level, __func__, __VA_ARGS__)
void _log_msg (enum log_level level, const char *func, const char *format, ...)
__attribute__ ((format (printf, 3, 4)));
/**
* Shorthand for log_msg
*/
#define log_debug(...) log_msg(LOG_DEBUG, __VA_ARGS__)
#define log_info(...) log_msg(LOG_INFO, __VA_ARGS__)
#define log_warn(...) log_msg(LOG_WARN, __VA_ARGS__)
/* #define log_error(...) log_msg(LOG_ERROR, __func__, __VA_ARGS__) */
#define log_fatal(...) log_msg(LOG_FATAL, __VA_ARGS__)
/**
* Log a message with the given level, appending the formatted error code name
*/
#define log_err(err_code, ...) _log_err(LOG_ERROR, err_code, __func__, __VA_ARGS__)
#define log_warn_err(err_code, ...) _log_err(LOG_WARN, err_code, __func__, __VA_ARGS__)
void _log_err (enum log_level level, err_t err, const char *func, const char *format, ...)
__attribute__ ((format (printf, 4, 5)));
/**
* Log a message with the given level, appending the formatted error message
*/
#define log_error(err_info, ...) _log_error(LOG_ERROR, err_info, __func__, __VA_ARGS__)
#define log_warn_error(err_info, ...) _log_error(LOG_WARN, err_info, __func__, __VA_ARGS__)
void _log_error (enum log_level level, const error_t *err, const char *func, const char *format, ...)
__attribute__ ((format (printf, 4, 5)));
/**
* Log using errno.
*/
#define log_perr(...) _log_perr(LOG_ERROR, __func__, __VA_ARGS__)
void _log_perr (enum log_level level, const char *func, const char *format, ...)
__attribute__ ((format (printf, 3, 4)));
/**
* Log with an [EXIT] tag at given level, and then exit with given exit code
*/
#define log_exit(level, exit_code, ...) _log_exit(level, exit_code, __func__, __VA_ARGS__)
void _log_exit (enum log_level level, int exit_code, const char *func, const char *format, ...)
__attribute__ ((format (printf, 4, 5)))
__attribute__ ((noreturn));
/**
* log_fatal + exit failure
*/
#define FATAL(...) do { log_fatal(__VA_ARGS__); abort(); } while (0)
/**
* log_err + exit failure
*/
#define FATAL_ERR(err_code, ...) do { _log_err(LOG_FATAL, err_code, __func__, __VA_ARGS__); abort(); } while (0)
/**
* log_err_info + exit failure
*/
#define FATAL_ERROR(err_info, ...) do { _log_error(LOG_FATAL, err_info, __func__, __VA_ARGS__); abort(); } while (0)
/**
* log_perr + exit failure
*/
#define FATAL_PERROR(...) do { _log_perr(LOG_FATAL, __func__, __VA_ARGS__); abort(); } while (0)
/**
* Exit with given code, also logging a message at LOG_INFO with anĀ [EXIT] tag
*/
#define EXIT_INFO(exit_code, ...) log_exit(LOG_INFO, exit_code, __VA_ARGS__)
#define EXIT_WARN(exit_code, ...) log_exit(LOG_WARN, exit_code, __VA_ARGS__)
#define EXIT_ERROR(exit_code, ...) log_exit(LOG_ERROR, exit_code, __VA_ARGS__)
#define EXIT_FATAL(exit_code, ...) log_exit(LOG_FATAL, exit_code, __VA_ARGS__)
#endif /* LOG_H */