log.h

Go to the documentation of this file.

#ifndef LOG_H
#define LOG_H

#include "bool.h"
#include "msgpack.h"
#include <stdio.h>

typedef enum {
    LOG_LEVEL_EXTRADEBUG,   
    LOG_LEVEL_DEBUG,        
    LOG_LEVEL_VERBOSE,      
    LOG_LEVEL_INFO,         
    LOG_LEVEL_WARNING,      
    LOG_LEVEL_ERROR,        
    LOG_LEVEL_FATAL,        
    LOG_LEVEL_ENTER,        
    LOG_LEVEL_LEAVE,        
    LOG_LEVEL_PAUSE,        
    LOG_LEVEL_RESUME,       
    LOG_LEVEL_SEPARATOR,    
    LOG_LEVEL_CLEAR,        
    LOG_LEVEL_CHECKPOINT,   
    LOG_LEVEL_SCRATCHPAD,   
} LOG_LEVEL;

typedef enum {
    LOG_NOTIFY_SETLEVEL,    
    LOG_NOTIFY_SHUTDOWN,    
} LOG_NOTIFY;

typedef void backend_callback_t(msgpack_sbuffer *logmsg, LOG_LEVEL level, void *userptr);
typedef void backend_command_t(LOG_NOTIFY reason, void *userptr);

typedef struct {
    backend_callback_t *callback; 
    backend_command_t *notify; 

    void *userptr;

    void *prev, *next;
} backend_list_t;

void log_register_backend(backend_callback_t *callback,
        backend_command_t *notify, void *userptr);
void log_unregister_backend(backend_callback_t *callback, void *userptr);

void log_shutdown(void);
void log_reset(bool with_checkpoints);

/* DEPRECATED
void log_init(const char* filename);
void log_close(void);
void log_level(LOG_LEVEL level, const char* module, const char* fmt, ...);
*/

const char *log_level_string(LOG_LEVEL level);

void attach_log_level(msgpack_object *attachment, LOG_LEVEL level,
        const char *origin, const char *msg, int len);
void attach_log_level_ap(msgpack_object *attachment, LOG_LEVEL level,
        const char *origin, const char *fmt, va_list ap);
void attach_log_level_fmt(msgpack_object *attachment, LOG_LEVEL level,
        const char *origin, const char *fmt, ...);

void log_scratch(const char *origin, const char *key, const char *value);
#define log_level(level, origin, msg) \
    attach_log_level(NULL, level, origin, msg, -1)
#define log_level_ap(level, origin, fmt, ap) \
    attach_log_level_ap(NULL, level, origin, fmt, ap)
#define log_level_fmt(level, origin, ...) \
    attach_log_level_fmt(NULL, level, origin, __VA_ARGS__)

#define attach_log_extra(attach, origin, ...) \
    attach_log_level_fmt(attach, LOG_LEVEL_EXTRADEBUG, origin, __VA_ARGS__)
#define attach_log_debug(attach, origin, ...) \
    attach_log_level_fmt(attach, LOG_LEVEL_DEBUG, origin, __VA_ARGS__)
#define attach_log_verbose(attach, origin, ...) \
    attach_log_level_fmt(attach, LOG_LEVEL_VERBOSE, origin, __VA_ARGS__)
#define attach_log_info(attach, origin, ...) \
    attach_log_level_fmt(attach, LOG_LEVEL_INFO, origin, __VA_ARGS__)
#define attach_log_warn(attach, origin, ...) \
    attach_log_level_fmt(attach, LOG_LEVEL_WARNING, origin, __VA_ARGS__)
#define attach_log_error(attach, origin, ...) \
    attach_log_level_fmt(attach, LOG_LEVEL_ERROR, origin, __VA_ARGS__)
#define attach_log_fatal(attach, origin, ...) \
    attach_log_level_fmt(attach, LOG_LEVEL_FATAL, origin, __VA_ARGS__)
#define attach_log_enter(attach, origin, ...) \
    attach_log_level_fmt(attach, LOG_LEVEL_ENTER, origin, __VA_ARGS__)
#define attach_log_leave(attach, origin, ...) \
    attach_log_level_fmt(attach, LOG_LEVEL_LEAVE, origin, __VA_ARGS__)

#define log_extra(origin, ...)  log_level_fmt(LOG_LEVEL_EXTRADEBUG, origin, __VA_ARGS__)
#define log_debug(origin, ...)  log_level_fmt(LOG_LEVEL_DEBUG, origin, __VA_ARGS__)
#define log_verbose(origin, ...) log_level_fmt(LOG_LEVEL_VERBOSE, origin, __VA_ARGS__)
#define log_info(origin, ...)   log_level_fmt(LOG_LEVEL_INFO, origin, __VA_ARGS__)
#define log_warn(origin, ...)   log_level_fmt(LOG_LEVEL_WARNING, origin, __VA_ARGS__)
#define log_error(origin, ...)  log_level_fmt(LOG_LEVEL_ERROR, origin, __VA_ARGS__)
#define log_fatal(origin, ...)  log_level_fmt(LOG_LEVEL_FATAL, origin, __VA_ARGS__)
#define log_enter(origin, ...)  log_level_fmt(LOG_LEVEL_ENTER, origin, __VA_ARGS__)
#define log_leave(origin, ...)  log_level_fmt(LOG_LEVEL_LEAVE, origin, __VA_ARGS__)
#define log_separator(origin)   log_level(LOG_LEVEL_SEPARATOR, origin, NULL)
#define log_check(origin, id)   log_level(LOG_LEVEL_CHECKPOINT, origin, id)

#ifndef LOG_ORIGIN
# define LOG_ORIGIN     __FILE__
#endif

#define attach_extra(attach, ...) \
    attach_log_extra(attach, LOG_ORIGIN, __VA_ARGS__)
#define attach_debug(attach, ...) \
    attach_log_debug(attach, LOG_ORIGIN, __VA_ARGS__)
#define attach_verbose(attach, ...) \
    attach_log_verbose(attach, LOG_ORIGIN, __VA_ARGS__)
#define attach_info(attach, ...) \
    attach_log_info(attach, LOG_ORIGIN, __VA_ARGS__)
#define attach_warn(attach, ...) \
    attach_log_warn(attach, LOG_ORIGIN, __VA_ARGS__)
#define attach_error(attach, ...) \
    attach_log_error(attach, LOG_ORIGIN, __VA_ARGS__)
#define attach_fatal(attach, ...) \
    attach_log_fatal(attach, LOG_ORIGIN, __VA_ARGS__)
#define attach_enter(attach, ...) \
    attach_log_enter(attach, LOG_ORIGIN, __VA_ARGS__)
#define attach_leave(attach, ...) \
    attach_log_leave(attach, LOG_ORIGIN, __VA_ARGS__)
#define attach_check(attach, id) \
    attach_log_check(attach, LOG_ORIGIN, id)

// (You can define LOG_NOSTUBS to avoid having these stubs/shortcuts.
// This might be useful in case of ambiguities or name collisions.)
#ifndef LOG_NOSTUBS
    #define extra(...)      log_extra(LOG_ORIGIN, __VA_ARGS__)
    #define debug(...)      log_debug(LOG_ORIGIN, __VA_ARGS__)
    #define verbose(...)    log_verbose(LOG_ORIGIN, __VA_ARGS__)
    #define info(...)       log_info(LOG_ORIGIN, __VA_ARGS__)
    #define warn(...)       log_warn(LOG_ORIGIN, __VA_ARGS__)
    #define error(...)      log_error(LOG_ORIGIN, __VA_ARGS__)
    #define fatal(...)      log_fatal(LOG_ORIGIN, __VA_ARGS__)
    #define enter(...)      log_enter(LOG_ORIGIN, __VA_ARGS__)
    #define leave(...)      log_leave(LOG_ORIGIN, __VA_ARGS__)
    #define separator()     log_separator(LOG_ORIGIN)
    #define check(id)       log_check(LOG_ORIGIN, id)
    #define scratch(key, value) log_scratch(LOG_ORIGIN, key, value)
#endif

#endif // LOG_H