cdi_logger_api.h

Go to the documentation of this file.

// -------------------------------------------------------------------------------------------
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// This file is part of the AWS CDI-SDK, licensed under the BSD 2-Clause "Simplified" License.
// License details at: https://github.com/aws/aws-cdi-sdk/blob/mainline/LICENSE
// -------------------------------------------------------------------------------------------
 
#ifndef CDI_LOGGER_API_API_H__
#define CDI_LOGGER_API_API_H__
 
#include <stdbool.h>
 
#include "cdi_utility_api.h"
#include "cdi_log_api.h"
#include "cdi_os_api.h"
 
//*********************************************************************************************************************
//***************************************** START OF DEFINITIONS AND TYPES ********************************************
//*********************************************************************************************************************
 
#define CDI_MAX_LOG_STRING_LENGTH               (1024)
 
#define CDI_MAX_LOG_FUNCTION_NAME_STRING_LENGTH (128)
 
typedef struct CdiLoggerState* CdiLoggerHandle;
 
typedef struct CdiLogState* CdiLogHandle;
 
typedef struct CdiMultilineLogBufferState CdiMultilineLogBufferState;
 
typedef struct {
    bool logging_enabled; 
    CdiLogHandle log_handle; 
 
    CdiLogComponent component; 
    CdiLogLevel log_level; 
 
    char function_name_str[CDI_MAX_LOG_FUNCTION_NAME_STRING_LENGTH]; 
    int line_number; 
 
    int line_count;                            
    CdiMultilineLogBufferState* buffer_state_ptr; 
 
    bool buffer_used; 
} CdiLogMultilineState;
 
#define CDI_LOG_THREAD(log_level, ...) \
    CdiLogger(CdiLoggerThreadLogGet(), kLogComponentGeneric, log_level, __FUNCTION__, __LINE__, __VA_ARGS__)
 
#define CDI_LOG_THREAD_COMPONENT(log_level, component, ...) \
    CdiLogger(CdiLoggerThreadLogGet(), component, log_level, __FUNCTION__, __LINE__, __VA_ARGS__)
 
#define CDI_LOG_HANDLE(log_handle, log_level, ...) \
    CdiLogger(log_handle, kLogComponentGeneric, log_level, __FUNCTION__, __LINE__, __VA_ARGS__)
 
#define CDI_LOG_THREAD_MULTILINE_BEGIN(log_level, multiline_state_ptr) \
    CdiLoggerMultilineBegin(CdiLoggerThreadLogGet(), kLogComponentGeneric, log_level, __FUNCTION__, __LINE__, \
    multiline_state_ptr)
 
#define CDI_LOG_MULTILINE(multiline_state_ptr, ...) \
    CdiLoggerMultiline(multiline_state_ptr, __VA_ARGS__)
 
#define CDI_LOG_MULTILINE_END(multiline_handle) CdiLoggerMultilineEnd(multiline_handle)
 
#define CDI_LOG_WHEN(log_level, condition, number, ...) \
    do { \
        static uint64_t log_event_count = 0; \
        if (condition) { \
            CdiOsAtomicInc64(&log_event_count); \
            if ((number) > 0 && (1 == log_event_count % (number) || 1 == (number))) { \
                if (1 < (number)) { \
                    CDI_LOG_HANDLE(CdiLogGlobalGet(), kLogInfo, "The following message has " \
                                   "occurred [%llu] times.", log_event_count); \
                } \
                CdiLogger(CdiLogGlobalGet(), kLogComponentGeneric, log_level, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
            } \
        } \
    } while (0)
 
#define CDI_LOG_THREAD_WHEN(log_level, condition, number, ...) \
    do { \
        static uint64_t log_event_count = 0; \
        if (condition) { \
            CdiOsAtomicInc64(&log_event_count); \
            if ((number) > 0 && (1 == log_event_count % (number) || 1 == (number))) { \
                if (1 < (number)) { \
                    CDI_LOG_HANDLE(CdiLoggerThreadLogGet(), kLogInfo, "The following message has " \
                                   "occurred [%llu] times.", log_event_count); \
                } \
                CdiLogger(CdiLoggerThreadLogGet(), kLogComponentGeneric, log_level, \
                          __FUNCTION__, __LINE__, ##__VA_ARGS__); \
            } \
        } \
    } while (0)
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
CDI_INTERFACE bool CdiLoggerInitialize(void);
 
CDI_INTERFACE bool CdiLoggerCreate(CdiLogLevel default_log_level, CdiLoggerHandle* ret_logger_handle_ptr);
 
CDI_INTERFACE bool CdiLoggerCreateLog(CdiLoggerHandle logger_handle, CdiConnectionHandle con_handle,
                                      const CdiLogMethodData* log_method_data_ptr, CdiLogHandle* ret_log_handle_ptr);
 
CDI_INTERFACE bool CdiLoggerCreateFileLog(CdiLoggerHandle logger_handle, const char* filename_str,
                                          CdiLogHandle* ret_log_handle_ptr);
 
CDI_INTERFACE void CdiLogger(CdiLogHandle handle, CdiLogComponent component, CdiLogLevel log_level,
                             const char* function_name_str, int line_number, const char* format_str, ...);
 
CDI_INTERFACE void CdiLoggerLogFromCallback(CdiLogHandle handle, const CdiLogMessageCbData* cb_data_ptr);
 
CDI_INTERFACE bool CdiLoggerThreadLogSet(CdiLogHandle handle);
 
CDI_INTERFACE void CdiLoggerThreadLogUnset(void);
 
CDI_INTERFACE CdiLogHandle CdiLoggerThreadLogGet(void);
 
CDI_INTERFACE void CdiLoggerMultilineBegin(CdiLogHandle handle, CdiLogComponent component, CdiLogLevel log_level,
                                           const char* function_name_str, int line_number,
                                           CdiLogMultilineState* state_ptr);
 
CDI_INTERFACE void CdiLoggerMultiline(CdiLogMultilineState* state_ptr, const char* format_str, ...);
 
CDI_INTERFACE char* CdiLoggerMultilineGetBuffer(CdiLogMultilineState* state_ptr);
 
CDI_INTERFACE void CdiLoggerMultilineEnd(CdiLogMultilineState* state_ptr);
 
CDI_INTERFACE void CdiLoggerFlushAllFileLogs(void);
 
CDI_INTERFACE bool CdiLoggerIsEnabled(CdiLogHandle handle, CdiLogComponent component, CdiLogLevel log_level);
 
CDI_INTERFACE CdiReturnStatus CdiLoggerComponentEnable(CdiLogHandle handle, CdiLogComponent component, bool enable);
 
CDI_INTERFACE CdiReturnStatus CdiLoggerComponentEnableGlobal(CdiLogComponent component, bool enable);
 
CDI_INTERFACE bool CdiLoggerComponentIsEnabled(CdiLogHandle handle, CdiLogComponent component);
 
CDI_INTERFACE CdiReturnStatus CdiLoggerLevelSet(CdiLogHandle handle, CdiLogComponent component, CdiLogLevel level);
 
CDI_INTERFACE CdiReturnStatus CdiLoggerLevelSetGlobal(CdiLogComponent component, CdiLogLevel level);
 
CDI_INTERFACE CdiReturnStatus CdiLoggerStderrEnable(bool enable, CdiLogLevel level);
 
CDI_INTERFACE void CdiLoggerDestroyLog(CdiLogHandle handle);
 
CDI_INTERFACE void CdiLoggerDestroyLogger(CdiLoggerHandle logger_handle);
 
CDI_INTERFACE void CdiLoggerShutdown(bool force);
 
#endif // CDI_LOGGER_API_API_H__