TheRock/rocm-libraries/dnn-providers/miopen-provider/MiopenConvDescriptor.cpp

// Copyright © Advanced Micro Devices, Inc., or its affiliates.
// SPDX-License-Identifier:  MIT

#include <algorithm>
#include <limits>
#include <vector>

#include <hipdnn_plugin_sdk/PluginException.hpp>

#include "MiopenConvDescriptor.hpp"
#include "MiopenUtils.hpp"

namespace miopen_plugin
{

namespace
{

void copyWithCheck(const flatbuffers::Vector<int64_t>* src,
                   std::vector<int>& dst,
                   size_t expectedSize,
                   const char* name,
                   const char* expectedSizeName)
{
    if(src->size() != expectedSize)
    {
        throw hipdnn_plugin_sdk::HipdnnPluginException(HIPDNN_PLUGIN_STATUS_BAD_PARAM,
                                                       "MiopenConvDescriptor: " + std::string(name)
                                                           + " size must be equal to "
                                                           + std::string(expectedSizeName));
    }
    if(!std::all_of(src->begin(), src->end(), [](int64_t v) {
           return v <= std::numeric_limits<int>::max();
       }))
    {
        throw hipdnn_plugin_sdk::HipdnnPluginException(HIPDNN_PLUGIN_STATUS_BAD_PARAM,
                                                       "MiopenConvDescriptor: " + std::string(name)
                                                           + " values must be less than INT_MAX");
    }
    std::copy(src->begin(), src->end(), dst.begin());
}

}

MiopenConvDescriptor::MiopenConvDescriptor(
    size_t spatialDimCount,
    const hipdnn_flatbuffers_sdk::data_objects::ConvolutionFwdAttributes& attributes,
    int groupCount,
    bool deterministicEnabled)
{
    createDescriptorInternal(spatialDimCount,
                             attributes.pre_padding(),
                             attributes.post_padding(),
                             attributes.stride(),
                             attributes.dilation(),
                             attributes.conv_mode(),
                             groupCount,
                             deterministicEnabled);
}

MiopenConvDescriptor::MiopenConvDescriptor(
    size_t spatialDimCount,
    const hipdnn_flatbuffers_sdk::data_objects::ConvolutionBwdAttributes& attributes,
    int groupCount,
    bool deterministicEnabled)
{
    createDescriptorInternal(spatialDimCount,
                             attributes.pre_padding(),
                             attributes.post_padding(),
                             attributes.stride(),
                             attributes.dilation(),
                             attributes.conv_mode(),
                             groupCount,
                             deterministicEnabled);
}

MiopenConvDescriptor::MiopenConvDescriptor(
    size_t spatialDimCount,
    const hipdnn_flatbuffers_sdk::data_objects::ConvolutionWrwAttributes& attributes,
    int groupCount,
    bool deterministicEnabled)
{
    createDescriptorInternal(spatialDimCount,
                             attributes.pre_padding(),
                             attributes.post_padding(),
                             attributes.stride(),
                             attributes.dilation(),
                             attributes.conv_mode(),
                             groupCount,
                             deterministicEnabled);
}

MiopenConvDescriptor::MiopenConvDescriptor(MiopenConvDescriptor&& other) noexcept
    : _descriptor(other._descriptor)
{
    other._descriptor = nullptr;
}

MiopenConvDescriptor& MiopenConvDescriptor::operator=(MiopenConvDescriptor&& other) noexcept
{
    if(this != &other)
    {
        if(_descriptor != nullptr)
        {
            LOG_ON_MIOPEN_FAILURE(miopenDestroyConvolutionDescriptor(_descriptor));
        }

        _descriptor = other._descriptor;
        other._descriptor = nullptr;
    }
    return *this;
}

MiopenConvDescriptor::~MiopenConvDescriptor()
{
    if(_descriptor != nullptr)
    {
        LOG_ON_MIOPEN_FAILURE(miopenDestroyConvolutionDescriptor(_descriptor));
    }
}

miopenConvolutionDescriptor_t MiopenConvDescriptor::convDescriptor() const
{
    return _descriptor;
}

void MiopenConvDescriptor::createDescriptorInternal(
    size_t spatialDimCount,
    const flatbuffers::Vector<int64_t>* attrPrePadding,
    const flatbuffers::Vector<int64_t>* attrPostPadding,
    const flatbuffers::Vector<int64_t>* attrStride,
    const flatbuffers::Vector<int64_t>* attrDilation,
    hipdnn_flatbuffers_sdk::data_objects::ConvMode convMode,
    int groupCount,
    bool deterministicEnabled)
{
    if(spatialDimCount > std::numeric_limits<int>::max())
    {
        throw hipdnn_plugin_sdk::HipdnnPluginException(
            HIPDNN_PLUGIN_STATUS_BAD_PARAM,
            "MiopenConvDescriptor: spatialDimCount must be not greater than INT_MAX");
    }

    if(convMode != hipdnn_flatbuffers_sdk::data_objects::ConvMode::CROSS_CORRELATION)
    {
        throw hipdnn_plugin_sdk::HipdnnPluginException(
            HIPDNN_PLUGIN_STATUS_BAD_PARAM,
            "MiopenConvDescriptor: only ConvMode::CROSS_CORRELATION is supported");
    }

    if(attrPrePadding == nullptr)
    {
        throw hipdnn_plugin_sdk::HipdnnPluginException(
            HIPDNN_PLUGIN_STATUS_BAD_PARAM, "MiopenConvDescriptor: pre_padding must be set");
    }

    if(attrPostPadding == nullptr)
    {
        throw hipdnn_plugin_sdk::HipdnnPluginException(
            HIPDNN_PLUGIN_STATUS_BAD_PARAM, "MiopenConvDescriptor: post_padding must be set");
    }

    if(attrStride == nullptr)
    {
        throw hipdnn_plugin_sdk::HipdnnPluginException(HIPDNN_PLUGIN_STATUS_BAD_PARAM,
                                                       "MiopenConvDescriptor: stride must be set");
    }

    if(attrDilation == nullptr)
    {
        throw hipdnn_plugin_sdk::HipdnnPluginException(
            HIPDNN_PLUGIN_STATUS_BAD_PARAM, "MiopenConvDescriptor: dilation must be set");
    }

    if(attrPrePadding->size() != attrPostPadding->size())
    {
        throw hipdnn_plugin_sdk::HipdnnPluginException(
            HIPDNN_PLUGIN_STATUS_BAD_PARAM,
            "MiopenConvDescriptor: pre_padding and post_padding sizes must be equal");
    }

    if(!std::equal(attrPrePadding->begin(), attrPrePadding->end(), attrPostPadding->begin()))
    {
        throw hipdnn_plugin_sdk::HipdnnPluginException(
            HIPDNN_PLUGIN_STATUS_BAD_PARAM,
            "MiopenConvDescriptor: asymmetric padding is not supported");
    }

    if(groupCount < 1)
    {
        throw hipdnn_plugin_sdk::HipdnnPluginException(
            HIPDNN_PLUGIN_STATUS_BAD_PARAM,
            "MiopenConvDescriptor: groupCount < 1 is not supported");
    }

    std::vector<int> padding(spatialDimCount);
    std::vector<int> stride(spatialDimCount);
    std::vector<int> dilation(spatialDimCount);

    copyWithCheck(attrPrePadding, padding, spatialDimCount, "attrPadding", "spatialDimCount");
    copyWithCheck(attrStride, stride, spatialDimCount, "attrStride", "spatialDimCount");
    copyWithCheck(attrDilation, dilation, spatialDimCount, "attrDilation", "spatialDimCount");

    if(!std::all_of(padding.begin(), padding.end(), [](int v) { return v >= 0; }))
    {
        throw hipdnn_plugin_sdk::HipdnnPluginException(
            HIPDNN_PLUGIN_STATUS_BAD_PARAM,
            "MiopenConvDescriptor: padding values must be non-negative");
    }

    if(!std::all_of(stride.begin(), stride.end(), [](int v) { return v > 0; }))
    {
        throw hipdnn_plugin_sdk::HipdnnPluginException(
            HIPDNN_PLUGIN_STATUS_BAD_PARAM, "MiopenConvDescriptor: stride values must be positive");
    }

    if(!std::all_of(dilation.begin(), dilation.end(), [](int v) { return v > 0; }))
    {
        throw hipdnn_plugin_sdk::HipdnnPluginException(
            HIPDNN_PLUGIN_STATUS_BAD_PARAM,
            "MiopenConvDescriptor: dilation values must be positive");
    }

    THROW_ON_MIOPEN_FAILURE(miopenCreateConvolutionDescriptor(&_descriptor));

    try
    {
        THROW_ON_MIOPEN_FAILURE(miopenInitConvolutionNdDescriptor(_descriptor,
                                                                  static_cast<int>(spatialDimCount),
                                                                  padding.data(),
                                                                  stride.data(),
                                                                  dilation.data(),
                                                                  miopenConvolution));
        THROW_ON_MIOPEN_FAILURE(miopenSetConvolutionGroupCount(_descriptor, groupCount));

        if(deterministicEnabled)
        {
            THROW_ON_MIOPEN_FAILURE(miopenSetConvolutionAttribute(
                _descriptor, MIOPEN_CONVOLUTION_ATTRIB_DETERMINISTIC, 1));
        }
    }
    catch(...)
    {
        LOG_ON_MIOPEN_FAILURE(miopenDestroyConvolutionDescriptor(_descriptor));
        _descriptor = nullptr;
        throw;
    }
}
}