Logger.h

Go to the documentation of this file.

 
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
// expressly authorized by NVIDIA. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA CORPORATION & AFFILIATES.
//
// SPDX-FileCopyrightText: Copyright (c) 2016-2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.
//
 
#ifndef DW_CORE_LOGGER_H_
#define DW_CORE_LOGGER_H_
 
#include <dw/core/base/Config.h>
#include <dw/core/base/Exports.h>
#include <dw/core/base/Types.h>
#include <dw/core/base/Status.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
// Forward declaration of dwContextHandle_t to avoid circular dependency.
// @note: The API using the dwContextHandle_t is deprecated
// coverity[misra_c_2012_rule_1_1_violation]
typedef struct dwContextObject* dwContextHandle_t;
// coverity[misra_c_2012_rule_1_1_violation]
typedef struct dwContextObject const* dwConstContextHandle_t;
 
typedef enum dwLoggerVerbosity {
    DW_LOG_VERBOSE = 0x0000, 
    DW_LOG_DEBUG   = 0x1000, 
    DW_LOG_INFO    = 0x2000, 
    DW_LOG_WARN    = 0x3000, 
    DW_LOG_ERROR   = 0x4000, 
    DW_LOG_SILENT  = 0x7000  
} dwLoggerVerbosity;
 
typedef struct dwLoggerMessage
{
    char8_t const* msg;          
    dwLoggerVerbosity verbosity; 
    char8_t const* tag;          
    char8_t const* fileName;     
    int32_t lineNum;             
    char8_t const* threadId;     
} dwLoggerMessage;
 
typedef void (*dwLogCallback)(dwContextHandle_t context, dwLoggerVerbosity type, char8_t const* msg);
 
typedef void (*dwLoggerCallback)(dwLoggerMessage const* msg);
 
DW_API_PUBLIC dwStatus dwLogger_initialize(dwLogCallback msgCallback);
 
DW_API_PUBLIC dwStatus dwLogger_initializeExtended(dwLoggerCallback msgCallback);
 
DW_API_PUBLIC dwStatus dwLogger_setLogLevel(dwLoggerVerbosity const verbosity);
 
DW_API_PUBLIC dwStatus dwLogger_enableTimestamps(bool const enabled);
 
DW_API_PUBLIC dwStatus dwLogger_log(dwConstContextHandle_t const context, dwLoggerVerbosity const verbosity, char8_t const* const msg);
 
DW_API_PUBLIC dwStatus dwLogger_logExtended(const dwLoggerMessage* msg);
 
DW_API_PUBLIC dwStatus dwLogger_release(void);
 
DW_API_PUBLIC dwStatus dwLogger_setThreadId(char8_t const* threadId);
 
#ifdef __cplusplus
}
#endif
#endif // DW_CORE_LOGGER_H_