MNN/source/backend/vulkan/image/execution/VulkanSoftmax.cpp

//
//  VulkanSoftmax.cpp
//  MNN
//
//  Created by MNN on 2019/01/31.
//  Copyright © 2018, Alibaba Group Holding Limited
//

#include "VulkanSoftmax.hpp"
#include "core/Macro.h"
#include "core/TensorUtils.hpp"

namespace MNN {

struct SoftmaxConstBuffer {
    uint N;
    uint H;
    uint W;
    uint C4;
    uint CLeft;
};

VulkanSoftmax::VulkanSoftmax(const Op* op, Backend* bn, const uint axisIndex) : VulkanBasicExecution(bn) {
    mAxisIndex = axisIndex;
    auto vkBn = (VulkanBackend*)backend();
    std::string shaderName = "glsl_softmaxImage_";
    std::string macro = "";
    std::string suffix = "comp";
    switch (axisIndex) {
        case 0:
            macro = "AXIS_N_"; break;
        case 1:
            macro = "AXIS_H_"; break;
        case 2:
            macro = "AXIS_W_"; break;
        case 3:
            macro = "AXIS_C_"; break;
    }

    std::vector<VkDescriptorType> types {VK_DESCRIPTOR_TYPE_STORAGE_IMAGE,
                                            VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER,
                                            VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER};

    mSoftmaxPipeline = vkBn->getPipeline(shaderName + macro + suffix, types);
    mDescriptorSet.reset(mSoftmaxPipeline->createSet());
    mSoftmaxConstBuffer = std::make_shared<VulkanBuffer>(vkBn->getMemoryPool(), false, sizeof(SoftmaxConstBuffer), nullptr, VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT);
}

VulkanSoftmax::~VulkanSoftmax() {
}

ErrorCode VulkanSoftmax::onEncode(const std::vector<Tensor*>& inputs, const std::vector<Tensor*>& outputs,
                                  const VulkanCommandPool::Buffer* cmdBuffer) {
    auto vkBn = static_cast<VulkanBackend *>(backend());
    auto input  = inputs[0];
    auto output = outputs[0];
    auto inputShapeNHWC = VulkanTensor::tensorShapeFormat(input);
    std::vector<uint> cpuSoftmaxConstBuffer = {(uint)inputShapeNHWC[0], (uint)inputShapeNHWC[1], (uint)inputShapeNHWC[2], (uint)UP_DIV(inputShapeNHWC[3], 4), (uint)ROUND_UP(inputShapeNHWC[3], 4) - inputShapeNHWC[3]};

    {
        auto softmaxConst = reinterpret_cast<SoftmaxConstBuffer*>(mSoftmaxConstBuffer->map());
        ::memset(softmaxConst, 0, sizeof(SoftmaxConstBuffer));
        softmaxConst->N = cpuSoftmaxConstBuffer[0];
        softmaxConst->H = cpuSoftmaxConstBuffer[1];
        softmaxConst->W = cpuSoftmaxConstBuffer[2];
        softmaxConst->C4 = cpuSoftmaxConstBuffer[3];
        softmaxConst->CLeft = cpuSoftmaxConstBuffer[4];
        mSoftmaxConstBuffer->unmap();
    }

    // N * H * W * C4
    uint numTotal = cpuSoftmaxConstBuffer[0] * cpuSoftmaxConstBuffer[1] * cpuSoftmaxConstBuffer[2] * cpuSoftmaxConstBuffer[3];
    uint numY = numTotal / cpuSoftmaxConstBuffer[mAxisIndex];

    auto vkOutput  = (VulkanTensor*)output->deviceId();
    auto vkInput   = (VulkanTensor*)input->deviceId();

    mDescriptorSet.reset(mSoftmaxPipeline->createSet());
    mDescriptorSet->writeImage(vkOutput->image()->view(), vkBn->getCommonSampler()->get(),
                            VK_IMAGE_LAYOUT_GENERAL, 0);
    mDescriptorSet->writeImage(vkInput->image()->view(), vkBn->getCommonSampler()->get(),
                            VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, 1);
    mDescriptorSet->writeBuffer(mSoftmaxConstBuffer->buffer(), 2, mSoftmaxConstBuffer->size());

    vkOutput->image()->barrierWrite(cmdBuffer->get());
    vkInput->image()->barrierRead(cmdBuffer->get());

    mSoftmaxPipeline->bind(cmdBuffer->get(), mDescriptorSet->get());

    vkCmdDispatch(cmdBuffer->get(), 1, numY, 1);

    return NO_ERROR;
}

class VulkanSoftmaxCreator : public VulkanBackend::Creator {
public:
    virtual VulkanBasicExecution* onCreate(const std::vector<Tensor*>& inputs, const std::vector<Tensor*>& outputs, const MNN::Op* op,
                                Backend* backend) const override {
        auto input = inputs[0];

        uint dimension = input->dimensions();
        if (dimension > 4) {
            return nullptr;
        }

        // Work out the reduce axis, taking various formats and dimensions into account.
        MNN_DATA_FORMAT format = VulkanImageConverter::getTensorLinearFormat(input);
        int axis = op->main_as_Axis()->axis();
        if (axis < 0) {
            axis = input->dimensions() + axis;
        }
        std::vector<uint> axisMap;

        if (dimension == 4) {
            if (format == MNN_DATA_FORMAT_NCHW) {
                axisMap.assign({0, 3, 1, 2});
            } else {
                axisMap.assign({0, 1, 2, 3});
            }
        } else if (dimension == 3) {
            if (format == MNN_DATA_FORMAT_NCHW) {
                axisMap.assign({0, 3, 1});
            } else {
                axisMap.assign({0, 1, 3});
            }
        } else if (dimension == 2) {
            axisMap.assign({0, 3});
        } else if (dimension == 1) {
            axisMap.assign({3});
        } else {
            return nullptr;
        }
        uint axisIndex = axisMap[axis];

        return new VulkanSoftmax(op, backend, axisIndex);
    }
};

static bool gResistor = []() {
    VulkanBackend::addCreator(OpType_Softmax, new VulkanSoftmaxCreator);
    return true;
}();

} // namespace MNN