IChannelPacket.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) 2020-2024 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_ICHANNEL_PACKET_HPP_
#define DW_FRAMEWORK_ICHANNEL_PACKET_HPP_
 
#include <typeinfo>
#include <cstddef>
#include <dwcgf/channel/ChannelPacketTypes.hpp>
#include <dwcgf/channel/ChannelParameters.hpp>
#include <nvscibuf.h>
#include <nvscisync.h>
#include <dwshared/dwfoundation/dw/core/language/Function.hpp>
 
namespace dw
{
namespace framework
{
 
class IChannelPacket
{
public:
    // Enable ownership via this interface
    virtual ~IChannelPacket() = default;
 
    virtual GenericData getGenericData() = 0;
 
    class SocketCallbacks
    {
    public:
        virtual uint8_t* getBuffer() = 0;
        virtual size_t getBufferSize() = 0;
        // coverity[autosar_cpp14_a2_10_5_violation]
        virtual size_t serialize() = 0;
        virtual void deserialize(size_t) = 0;
    };
 
    class RemoteShmemCallbacks
    {
    public:
        virtual size_t getBufferSize() = 0;
        virtual size_t getPoolIndex() = 0;
        virtual void initializeFromMemory(void* ptr, size_t index) = 0;
        virtual void pack() = 0;
        virtual void unpack() = 0;
    };
 
    class NvSciCallbacks
    {
    public:
        virtual uint32_t getNumBuffers() const = 0;
        virtual void fillNvSciBufAttributes(uint32_t bufferIndex, NvSciBufAttrList& attrList) const = 0;
        virtual void initializeFromNvSciBufObjs(dw::core::span<NvSciBufObj> bufs) = 0;
 
        virtual void pack() = 0;
        virtual void unpack() = 0;
    };
 
    SocketCallbacks& getSocketCallbacks();
    RemoteShmemCallbacks& getRemoteShmemCallbacks();
    NvSciCallbacks& getNvSciCallbacks();
};
 
// TODO(chale): this should be made private to the framework once external entities no longer create
// Channel packets
class ChannelPacketDefaultBase : public IChannelPacket
{
public:
    explicit ChannelPacketDefaultBase(size_t typeSize);
 
    GenericData getGenericData() final;
 
protected:
    size_t m_typeSize;
    std::unique_ptr<uint8_t[]> m_buffer;
    GenericData m_data;
};
 
// coverity[autosar_cpp14_a0_1_6_violation]
class ChannelPacketDefault : public ChannelPacketDefaultBase, public IChannelPacket::SocketCallbacks
{
public:
    explicit ChannelPacketDefault(size_t typeSize);
 
    uint8_t* getBuffer() final;
 
    size_t getBufferSize() final;
 
    // coverity[autosar_cpp14_a2_10_5_violation]
    size_t serialize() final;
 
    void deserialize(size_t) final;
};
 
// coverity[autosar_cpp14_a0_1_6_violation]
class ChannelRemoteShmemPacketDefault : public IChannelPacket, public IChannelPacket::RemoteShmemCallbacks
{
    // coverity[autosar_cpp14_a0_1_1_violation]
    // coverity[autosar_cpp14_a2_10_5_violation]
    static constexpr char LOG_TAG[]{"ChannelRemoteShmemPacketDefault"};
 
public:
    ChannelRemoteShmemPacketDefault(size_t typeSize);
 
    size_t getBufferSize() final;
 
    size_t getPoolIndex() final;
 
    void initializeFromMemory(void* ptr, size_t index) final;
 
    void pack() final;
 
    void unpack() final;
 
    GenericData getGenericData() final;
 
private:
    size_t m_typeSize;
    void* m_data;
    size_t m_poolIndex;
};
 
// coverity[autosar_cpp14_a0_1_6_violation]
class ChannelNvSciPacketDefault : public IChannelPacket, public IChannelPacket::NvSciCallbacks
{
    // coverity[autosar_cpp14_a0_1_1_violation]
    // coverity[autosar_cpp14_a2_10_5_violation]
    static constexpr char LOG_TAG[]{"ChannelNvSciPacketDefault"};
 
public:
    explicit ChannelNvSciPacketDefault(size_t typeSize);
 
    uint32_t getNumBuffers() const final;
    void fillNvSciBufAttributes(uint32_t bufferIndex, NvSciBufAttrList& attrList) const final;
 
    void initializeFromNvSciBufObjs(dw::core::span<NvSciBufObj> bufs);
 
    void pack() final;
 
    void unpack() final;
 
    GenericData getGenericData() final;
 
private:
    void fillCpuPacketDataAttributes(NvSciBufAttrList& output) const;
 
    size_t m_typeSize;
    void* m_data;
};
 
class IChannelPacketFactory
{
public:
    virtual ~IChannelPacketFactory() = default;
 
    // coverity[autosar_cpp14_a2_10_5_violation]
    virtual std::unique_ptr<IChannelPacket> makePacket(const GenericDataReference& ref, ChannelType channelType) = 0;
};
// coverity[autosar_cpp14_a0_1_6_violation]
using ChannelPacketFactoryPtr = std::shared_ptr<IChannelPacketFactory>;
 
} // namespace framework
} // namespace dw
 
#endif // DW_FRAMEWORK_ICHANNEL_PACKET_HPP_