logger.h

Go to the documentation of this file.

//  Copyright (C) 2015-2020 Virgil Security, Inc.
//
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions are
//  met:
//
//      (1) Redistributions of source code must retain the above copyright
//      notice, this list of conditions and the following disclaimer.
//
//      (2) Redistributions in binary form must reproduce the above copyright
//      notice, this list of conditions and the following disclaimer in
//      the documentation and/or other materials provided with the
//      distribution.
//
//      (3) Neither the name of the copyright holder nor the names of its
//      contributors may be used to endorse or promote products derived from
//      this software without specific prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR
//  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//  DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
//  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
//  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
//  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
//  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
//  IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//  POSSIBILITY OF SUCH DAMAGE.
//
//  Lead Maintainer: Virgil Security Inc. <support@virgilsecurity.com>
 
#ifndef AP_SECURITY_SDK_LOGGER_H
#define AP_SECURITY_SDK_LOGGER_H
 
#include <logger-config.h>
#include <stdarg.h>
#include <string.h>
 
#ifdef __cplusplus
namespace VirgilIoTKit {
extern "C" {
#endif
 
typedef enum {
    VS_LOGLEV_UNKNOWN = 0xFF,   
    VS_LOGLEV_NO_LOGGER = 0xFE, 
    VS_LOGLEV_INFO = 0x00,     
    VS_LOGLEV_FATAL = 0x10,    
    VS_LOGLEV_ALERT = 0x20,    
    VS_LOGLEV_CRITICAL = 0x30, 
    VS_LOGLEV_ERROR = 0x40,    
    VS_LOGLEV_WARNING = 0x50,  
    VS_LOGLEV_NOTICE = 0x60,   
    VS_LOGLEV_TRACE = 0x70,    
    VS_LOGLEV_DEBUG = 0xFD, 
} vs_log_level_t;
 
#define __FILENAME__ (strrchr(__FILE__, '/') ? strrchr(__FILE__, '/') + 1 : __FILE__)
 
#define VS_LOG_GET_LOGLEVEL(LOGLEV_VARIABLE) (LOGLEV_VARIABLE) = vs_logger_get_loglev()
 
#define VS_LOG_IS_LOGLEVEL(LOGLEV_VALUE) vs_logger_is_loglev(LOGLEV_VALUE)
 
#define VS_LOG_SET_LOGLEVEL(LOGLEV_VALUE) vs_logger_set_loglev(LOGLEV_VALUE)
 
 
#if VS_IOT_LOGGER_USE_LIBRARY
 
#include <stdbool.h>
#include <stdint.h>
#include <stdlib-config.h>
 
 
#define VS_LOG(LGLVL, FRMT, ...) vs_logger_message((LGLVL), __FILENAME__, __LINE__, (FRMT), ##__VA_ARGS__)
 
#define VS_LOG_HEX(LGLVL, PREFIX, BUF, SIZE)                                                                           \
    vs_logger_message_hex((LGLVL), __FILENAME__, __LINE__, (PREFIX), (BUF), (SIZE))
 
bool
vs_log_thread_descriptor(const char *description);
 
#ifdef __cplusplus
#define VS_LOG_MAKE_LEVEL(LEVEL) VirgilIoTKit::LEVEL
#else
#define VS_LOG_MAKE_LEVEL(LEVEL) LEVEL
#endif
 
#define VS_LOG_INFO(FRMT, ...)                                                                                         \
    vs_logger_message(VS_LOG_MAKE_LEVEL(VS_LOGLEV_INFO), __FILENAME__, __LINE__, (FRMT), ##__VA_ARGS__)
 
#define VS_LOG_FATAL(FRMT, ...)                                                                                        \
    vs_logger_message(VS_LOG_MAKE_LEVEL(VS_LOGLEV_FATAL), __FILENAME__, __LINE__, (FRMT), ##__VA_ARGS__)
 
#define VS_LOG_ALERT(FRMT, ...)                                                                                        \
    vs_logger_message(VS_LOG_MAKE_LEVEL(VS_LOGLEV_ALERT), __FILENAME__, __LINE__, (FRMT), ##__VA_ARGS__)
 
#define VS_LOG_CRITICAL(FRMT, ...)                                                                                     \
    vs_logger_message(VS_LOG_MAKE_LEVEL(VS_LOGLEV_CRITICAL), __FILENAME__, __LINE__, (FRMT), ##__VA_ARGS__)
 
#define VS_LOG_ERROR(FRMT, ...)                                                                                        \
    vs_logger_message(VS_LOG_MAKE_LEVEL(VS_LOGLEV_ERROR), __FILENAME__, __LINE__, (FRMT), ##__VA_ARGS__)
 
#define VS_LOG_WARNING(FRMT, ...)                                                                                      \
    vs_logger_message(VS_LOG_MAKE_LEVEL(VS_LOGLEV_WARNING), __FILENAME__, __LINE__, (FRMT), ##__VA_ARGS__)
 
#define VS_LOG_NOTICE(FRMT, ...)                                                                                       \
    vs_logger_message(VS_LOG_MAKE_LEVEL(VS_LOGLEV_NOTICE), __FILENAME__, __LINE__, (FRMT), ##__VA_ARGS__)
 
#define VS_LOG_TRACE(FRMT, ...)                                                                                        \
    vs_logger_message(VS_LOG_MAKE_LEVEL(VS_LOGLEV_TRACE), __FILENAME__, __LINE__, (FRMT), ##__VA_ARGS__)
 
#define VS_LOG_DEBUG(FRMT, ...)                                                                                        \
    vs_logger_message(VS_LOG_MAKE_LEVEL(VS_LOGLEV_DEBUG), __FILENAME__, __LINE__, (FRMT), ##__VA_ARGS__)
 
// Functions
 
bool
vs_logger_last_result(void);
 
void
vs_logger_message(vs_log_level_t level, const char *cur_filename, uint32_t line_num, const char *log_format, ...);
 
void
vs_logger_init(vs_log_level_t log_level);
 
vs_log_level_t
vs_logger_set_loglev(vs_log_level_t new_level);
 
vs_log_level_t
vs_logger_get_loglev(void);
 
bool
vs_logger_is_loglev(vs_log_level_t level);
 
void
vs_logger_message_hex(vs_log_level_t level,
                      const char *cur_filename,
                      uint32_t line_num,
                      const char *prefix,
                      const void *data_buf,
                      const uint16_t data_size);
 
#elif VS_IOT_LOGGER_USE_LIBRARY != 1 && defined(VS_IOT_LOGGER_FUNCTION)
 
#define vs_logger_last_result() true
#define vs_logger_init(log_level) (void)log_level;
#define vs_logger_set_loglev(log_level) (void)log_level;
#define vs_logger_get_loglev() VS_LOGLEV_NO_LOGGER
#define vs_logger_is_loglev(level) ((level) == VS_LOGLEV_NO_LOGGER)
 
#define vs_logger_message_hex(level, cur_filename, line_num, prefix, data_buf, data_size)                              \
    do {                                                                                                               \
        (void)level;                                                                                                   \
        (void)cur_filename;                                                                                            \
        (void)line_num;                                                                                                \
        (void)prefix;                                                                                                  \
        (void)data_buf;                                                                                                \
        (void)data_size;                                                                                               \
    } while (0)
 
#define vs_logger_message(level, cur_filename, line_num, log_format, ...)                                              \
    do {                                                                                                               \
        (void)level;                                                                                                   \
        (void)cur_filename;                                                                                            \
        (void)line_num;                                                                                                \
        VS_IOT_LOGGER_FUNCTION((log_format), ##__VA_ARGS__);                                                           \
        VS_IOT_LOGGER_FUNCTION(VS_IOT_LOGGER_EOL);                                                                     \
    } while (0)
 
#else // VS_IOT_LOGGER_USE_LIBRARY != 1 && !defined(VS_IOT_LOGGER_FUNCTION)
 
#include "macro_va_args.h"
 
#define vs_logger_last_result() true
#define vs_logger_init(log_level) (void)log_level;
#define vs_logger_set_loglev(log_level) (void)log_level;
#define vs_logger_get_loglev() VS_LOGLEV_NO_LOGGER
#define vs_logger_is_loglev(level) ((level) == VS_LOGLEV_NO_LOGGER)
#define vs_log_thread_descriptor() (true)
 
#define VS_IOT_LOGGER_VOID(a) (void)a;
 
#define VS_LOG(LGLVL, FRMT, ...) VS_IOT_MAP(VS_IOT_LOGGER_VOID, FRMT, ##__VA_ARGS__)
#define VS_LOG_HEX(LGLVL, PREFIX, BUF, SIZE) VS_IOT_MAP(VS_IOT_LOGGER_VOID, PREFIX, BUF, SIZE)
#define VS_LOG_INFO(FRMT, ...) VS_IOT_MAP(VS_IOT_LOGGER_VOID, FRMT, ##__VA_ARGS__)
#define VS_LOG_FATAL(FRMT, ...) VS_IOT_MAP(VS_IOT_LOGGER_VOID, FRMT, ##__VA_ARGS__)
#define VS_LOG_ALERT(FRMT, ...) VS_IOT_MAP(VS_IOT_LOGGER_VOID, FRMT, ##__VA_ARGS__)
#define VS_LOG_CRITICAL(FRMT, ...) VS_IOT_MAP(VS_IOT_LOGGER_VOID, FRMT, ##__VA_ARGS__)
#define VS_LOG_ERROR(FRMT, ...) VS_IOT_MAP(VS_IOT_LOGGER_VOID, FRMT, ##__VA_ARGS__)
#define VS_LOG_WARNING(FRMT, ...) VS_IOT_MAP(VS_IOT_LOGGER_VOID, FRMT, ##__VA_ARGS__)
#define VS_LOG_NOTICE(FRMT, ...) VS_IOT_MAP(VS_IOT_LOGGER_VOID, FRMT, ##__VA_ARGS__)
#define VS_LOG_TRACE(FRMT, ...) VS_IOT_MAP(VS_IOT_LOGGER_VOID, FRMT, ##__VA_ARGS__)
#define VS_LOG_DEBUG(FRMT, ...) VS_IOT_MAP(VS_IOT_LOGGER_VOID, FRMT, ##__VA_ARGS__)
 
#endif // VS_IOT_LOGGER_USE_LIBRARY
 
#ifdef __cplusplus
} // extern "C"
} // namespace VirgilIoTKit
#endif
 
#endif // AP_SECURITY_SDK_LOGGER_H