GraphHealthSignal.hpp

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) 2021 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_FRAMEWORK_GRAPH_HEALTH_SIGNAL_HPP_
#define DW_FRAMEWORK_GRAPH_HEALTH_SIGNAL_HPP_

#include <dw/core/base/Types.h>

#include <ostream>
#include <sstream>

namespace dw
{
namespace framework
{

typedef enum dwGraphState {
    DW_GRAPH_STATE_UNKNOWN = 0, //unable to determine health state
    DW_GRAPH_STATE_OK      = 3,
    DW_GRAPH_STATE_WARN    = 5,
    DW_GRAPH_STATE_ERROR   = 7
} dwGraphState;

typedef enum dwGraphStateLevel {
    DW_GRAPH_STATE_LEVEL_UNKNOWN  = 0, //unable to determine level
    DW_GRAPH_STATE_LEVEL_LOW      = 3,
    DW_GRAPH_STATE_LEVEL_MEDIUM   = 5,
    DW_GRAPH_STATE_LEVEL_HIGH     = 6,
    DW_GRAPH_STATE_LEVEL_CRITICAL = 9
} dwGraphStateLevel;

static const uint32_t DW_NODE_STATE_MAX_ERROR_STRING_LENGTH = 256;
static const uint32_t DW_NODE_STATE_MAX_KEY_VALUE_PAIR      = 16;
static const uint32_t DW_NODE_STATE_MAX_ERROR_COUNT         = 16;

struct dwKeyValuePair
{
    char key[DW_NODE_STATE_MAX_ERROR_STRING_LENGTH];
    char value[DW_NODE_STATE_MAX_ERROR_STRING_LENGTH];
};

struct dwGraphHealthSignal
{
    // Time that this signal was generated
    dwTime_t timestamp;

    // Graph State of this signal
    dwGraphState state;

    // Severity of this signal
    dwGraphStateLevel severity;

    // Source is a string with the processName.NodeName.PassName format
    // This is set at runtime by the process executing the node.
    char source[DW_NODE_STATE_MAX_ERROR_STRING_LENGTH];

    // Optional key value pair for additional debuggability
    uint32_t nValues;
    dwKeyValuePair values[DW_NODE_STATE_MAX_KEY_VALUE_PAIR];
};

struct dwGraphHealthSignalArray
{
    dwGraphHealthSignal signal[DW_NODE_STATE_MAX_ERROR_COUNT];
    uint32_t count;
};

// Helper functions for logging Graph Health Signals
std::ostream& operator<<(std::ostream& os, dwGraphState state);
std::ostream& operator<<(std::ostream& os, dwGraphStateLevel level);
std::ostream& operator<<(std::ostream& os, const dwGraphHealthSignal& signal);
}
}

#endif // DW_FRAMEWORK_GRAPH_HEALTH_SIGNAL_HPP_