BufferedLogger.h

Go to the documentation of this file.

/*
* SPDX-FileCopyrightText: Copyright (c) 2020-2021 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
* SPDX-License-Identifier: MIT
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
 
 
#ifndef NVNEURAL_BUFFEREDLOGGER_H
#define NVNEURAL_BUFFEREDLOGGER_H
 
#include <nvneural/CoreHelpers.h>
#include <atomic>
#include <cstdarg>
#include <mutex>
#include <string>
#include <vector>
 
namespace nvneural {
 
class IBufferedLogger : public IRefObject
{
public:
    static const IRefObject::TypeId typeID = 0xb19309bc19e64b5dul;
 
    virtual NeuralResult forwardBufferedLogs(ILogger* pDestinationLogger) noexcept = 0;
};
 
class BufferedLogger : public IBufferedLogger, public ILogger
{
    enum class Severity
    {
        Normal,
        Warning,
        Error,
    };
 
    struct LogEntry
    {
        ILogger::VerbosityLevel verbosity;
        Severity severity;
        std::string message;
    };
 
public:
    // IRefObject members
    IRefObject::RefCount addRef() const noexcept override;
    IRefObject::RefCount release() const noexcept override;
    void* queryInterface(IRefObject::TypeId interface) noexcept override;
    const void* queryInterface(IRefObject::TypeId interface) const noexcept override;
 
    // ILogger members
    ILogger::VerbosityLevel verbosity() const noexcept override;
    NeuralResult log(VerbosityLevel verbosity, const char* format, ...) noexcept override;
    NeuralResult logWarning(VerbosityLevel verbosity, const char* format, ...) noexcept override;
    NeuralResult logError(VerbosityLevel verbosity, const char* format, ...) noexcept override;
 
    // IBufferedLogger members
    NeuralResult forwardBufferedLogs(ILogger* pDestinationLogger) noexcept override;
 
private:
    NeuralResult bufferLogEntry(VerbosityLevel verbosity, Severity severity, const char* format, va_list args) noexcept;
    NeuralResult forwardLogEntryUnderLock(const LogEntry& logEntry) noexcept;
 
    RefPtr<ILogger> m_pForwarder;
    std::mutex m_logMutex;
    std::vector<LogEntry> m_logBuffer;
    mutable std::atomic<IRefObject::RefCount> m_refCount{1u};
};
 
} // namespace nvneural
 
#endif // NVNEURAL_BUFFEREDLOGGER_H