ChannelTrace.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.
//

#include <dw/core/base/Status.h>
#include <dw/core/language/Function.hpp>
#include <dw/core/container/Span.hpp>

#ifndef CHANNEL_TRACE_HPP
#define CHANNEL_TRACE_HPP

namespace dw
{
namespace framework
{

enum class ChannelTraceEventType
{
    WAIT,    // Consumer::wait called by client
    RECV,    // Consumer::recv called by client
    RELEASE, // Consumer::release called by client
    DROP,    // Consumer drops a packet due to mailbox mode
    GET,     // Producer::get called by client
    SEND,    // Producer::send called by client
    RETURN   // Producer receives a packet returned by consumers
};

struct ChannelPacketFingerprint
{
    /*
     * The hash of the id of the channel involved with this packet
     */
    uint32_t channelID;
    /*
     * Incremented by the producer every time get is called.
     */
    uint32_t getID;
    /*
     * The ID of the data buffers used to send this info.
     * This id indexes the packets in the order they were created and
     * added to the producer's packet pool
     */
    uint32_t bufferID;
};

struct ChannelTracePoint
{
    ChannelTraceEventType eventType;
    dwStatus status;
    ChannelPacketFingerprint packetFingerprint;
};

enum class ChannelTraceMode
{
    DISABLED,
    RECORD,
    REPLAY
};

using ChannelTraceWriteCallback = dw::core::Function<void(ChannelTracePoint)>;

using ChannelTraceReadCallback = dw::core::Function<bool(ChannelTracePoint&)>;

using ChannelOnRegisterTraceWriter = dw::core::Function<ChannelTraceWriteCallback(const char* channelID)>;

using ChannelOnRegisterTraceReader = dw::core::Function<ChannelTraceReadCallback(const char* channelID)>;

struct ChannelTraceProcessParam
{
    uint32_t channelID;
    ChannelTraceReadCallback input;
    ChannelTraceWriteCallback output;
};

uint32_t ChannelTraceHashId(const char* id);

void ChannelTraceProcess(dw::core::span<ChannelTraceProcessParam> traces);

} // framework
} // dw

#endif // CHANNEL_TRACE_HPP