TensorDescriptor.hpp

// Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
// SPDX-License-Identifier: BSD-3-Clause-Clear

#ifndef QC_TENSOR_DESCRIPTOR_HPP
#define QC_TENSOR_DESCRIPTOR_HPP

#include "QC/Infras/Memory/BufferDescriptor.hpp"

#include <string>
#include <vector>

namespace QC
{
namespace Memory
{

/**
 * @brief QCNode Tensor Buffer Properties.
 *
 * Inherited Members from BufferProps:
 * @param size The total required buffer size.
 * @param alignment The alignment requirement of the buffer.
 * @param attr The attributes of the buffer.
 * @param usage The intended usage of the buffer.
 *
 * New Members:
 * @param type The tensor type.
 * @param dims The tensor dimensions.
 * @param numDims The number of dimensions.
 *
 * @note When using this struct to request tensor buffer allocation, the member "size" will not be
 * used. The size is determined by the other new members.
 */
typedef struct TensorProps : public BufferProps
{
public:
    /**
     * @brief Constructor for TensorProps.
     * @return None.
     */
    TensorProps() : BufferProps() {}

    /**
     * @brief Constructor for TensorProps.
     * @param tensorType The tensor type.
     * @param dims The tensor dimensions.
     * @param allocatorType The allocator type of the buffer, default is
     * QC_MEMORY_ALLOCATOR_DMA_HTP.
     * @param cache The cache attributes of the buffer, default is QC_CACHEABLE.
     * @return None.
     * @note This constructor sets up the properties of the tensor with the given parameters, while
     * most other properties are set to their default suggested values.
     * @note The user must ensure the sizes of the vector dims is less than or equal to
     * QC_NUM_TENSOR_DIMS.
     */
    TensorProps( QCTensorType_e tensorType, std::vector<uint32_t> dims,
                 QCMemoryAllocator_e allocatorType = QC_MEMORY_ALLOCATOR_DMA_HTP,
                 QCAllocationCache_e cache = QC_CACHEABLE )
        : BufferProps( 0, allocatorType, cache ),
          tensorType( tensorType )
    {
        numDims = static_cast<uint32_t>( dims.size() );
        std::copy( dims.begin(), dims.end(), this->dims );
    }
    QCTensorType_e tensorType;
    uint32_t dims[QC_NUM_TENSOR_DIMS];
    uint32_t numDims;
} TensorProps_t;

/**
 * @brief Descriptor for QCNode Shared Tensor Buffer.
 * This structure represents the shared tensor buffer for QCNode. It extends the BufferDescriptor
 * and includes additional members specific to tensor properties.
 *
 * Inherited Members from BufferDescriptor:
 * @param name The name of the buffer.
 * @param pBuf The virtual address of the dma buffer.
 * @param size The dma size of the buffer.
 * @param type The type of the buffer.
 * @param alignment The alignment of the buffer.
 * @param cache The cache type of the buffer.
 * @param allocatorType The allocaor type used for allocation the buffer.
 * @param dmaHandle The dmaHandle of the buffer.
 * @param pid The process ID of the buffer.
 * @param validSize The size of valid data currently stored in the buffer.
 * @param offset The offset of the valid buffer within the shared buffer.
 * @param id A identifier assigned by the user application to distinguish the buffer.
 *
 * New Members:
 * @param tensorType The tensor type.
 * @param dims The tensor dimensions.
 * @param numDims The number of dimensions.
 */
typedef struct TensorDescriptor : public BufferDescriptor
{
public:
    TensorDescriptor() : BufferDescriptor() {}
    /**
     * @brief Sets up the tensor descriptor from another buffer descriptor object.
     * @param[in] other The buffer descriptor object from which buffer members are copied.
     * @return The updated tensor descriptor object.
     */
    TensorDescriptor &operator=( const BufferDescriptor &other );
    TensorDescriptor &operator=( const TensorDescriptor &other );
    TensorDescriptor &operator=( const QCBufferDescriptorBase_t &other );

    QCTensorType_e tensorType;
    uint32_t dims[QC_NUM_TENSOR_DIMS];
    uint32_t numDims;
} TensorDescriptor_t;

}   // namespace Memory
}   // namespace QC

#endif   // QC_TENSOR_DESCRIPTOR_HPP