convolution.cpp

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2015-2022 Advanced Micro Devices, Inc. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#include <migraphx/gpu/convolution.hpp>
#include <migraphx/gpu/context.hpp>
#include <migraphx/generate.hpp>
#include <miopen/miopen.h>

namespace migraphx {
inline namespace MIGRAPHX_INLINE_NS {
namespace gpu {

shape miopen_convolution::compute_shape(const std::vector<shape>& inputs) const
{
    check_shapes{inputs, *this}.has(4);
    std::vector<shape> conv_inputs(inputs.begin(), inputs.begin() + 2);
    check_shapes{conv_inputs, *this}.max_ndims(5).packed_layouts(
        {{0, 1, 2}, {0, 1, 2, 3}, {0, 2, 3, 1}, {0, 1, 2, 3, 4}});
    return op.normalize_compute_shape(conv_inputs);
}

inline shape reshape_if_1d(const shape& input)
{
    shape new_shape{input};
    auto dims = new_shape.lens();

    if(dims.size() == 3)
    {
        std::vector<size_t> new_dims = dims;
        new_dims.insert(new_dims.begin() + 2, 1);
        new_shape = shape{input.type(), new_dims};
    }
    return new_shape;
}

argument miopen_convolution::compute(context& ctx,
                                     const shape& output_shape,
                                     const std::vector<argument>& args) const
{
    auto x_desc                = make_tensor(reshape_if_1d(args[0].get_shape()));
    auto w_desc                = make_tensor(reshape_if_1d(args[1].get_shape()));
    auto y_desc                = make_tensor(reshape_if_1d(output_shape));
    auto* miopen_stream_handle = ctx.get_stream().get_miopen();
    auto workspace_size        = args[2].get_shape().bytes();

#ifdef MIGRAPHX_HAS_FIND_2_API
    {
        const miopenTensorArgument_t tensor_args[3] = {
            {miopenTensorConvolutionX, nullptr, args[0].implicit()},
            {miopenTensorConvolutionW, nullptr, args[1].implicit()},
            {miopenTensorConvolutionY, nullptr, args[3].implicit()},
        };

        if(solution_ptr.get() == nullptr)
            MIGRAPHX_THROW("MIOpen Convolution : Load MIOpen Solution before running it");

        auto status = miopenRunSolution(miopen_stream_handle,
                                        solution_ptr.get(),
                                        3,
                                        tensor_args,
                                        args[2].implicit(),
                                        workspace_size);
        if(status != miopenStatusSuccess)
            MIGRAPHX_THROW("MIOpen Convolution: running convolution using find_2.0 failed");

        return args[3];
    }
#else
    // else use immediate mode
    if(solution_id == 0)
        MIGRAPHX_THROW("MIOpen Convolution: invalid solution ID");

    auto status = miopenConvolutionForwardImmediate(miopen_stream_handle,
                                                    w_desc.get(),
                                                    args[1].implicit(),
                                                    x_desc.get(),
                                                    args[0].implicit(),
                                                    cd.get(),
                                                    y_desc.get(),
                                                    args[3].implicit(),
                                                    args[2].implicit(),
                                                    workspace_size,
                                                    solution_id);

    if(status != miopenStatusSuccess)
        MIGRAPHX_THROW("MIOpen Convolution: running convolution failed");
    return args[3];
#endif
}

shape miopen_convolution::find(context& ctx, const shape& output_shape, std::vector<shape> inputs)
{
    shape workspace_shape{};
    auto x_desc                = make_tensor(reshape_if_1d(inputs[0]));
    auto w_desc                = make_tensor(reshape_if_1d(inputs[1]));
    auto y_desc                = make_tensor(reshape_if_1d(output_shape));
    std::size_t workspace_size = 0;

#ifdef MIGRAPHX_HAS_FIND_2_API
    {
        auto conv_problem = make_obj<miopen_problem>(
            &miopenCreateConvProblem, cd.get(), miopenProblemDirectionForward);

        set_tensor_descriptor(miopenTensorConvolutionX, x_desc, conv_problem);
        set_tensor_descriptor(miopenTensorConvolutionW, w_desc, conv_problem);
        set_tensor_descriptor(miopenTensorConvolutionY, y_desc, conv_problem);

        auto* miopen_stream_handle = ctx.get_stream().get_miopen();

        solution_ptr = find_solution(miopen_stream_handle, conv_problem.get());

        auto status = miopenGetSolutionWorkspaceSize(solution_ptr.get(), &workspace_size);
        if(status != miopenStatusSuccess)
            MIGRAPHX_THROW("MIOpen Convolution : failed to get solution's workspace size");

        std::size_t solution_size;
        status = miopenGetSolutionSize(solution_ptr.get(), &solution_size);
        if(status != miopenStatusSuccess)
            MIGRAPHX_THROW("MIOpen Convolution: Failed to fetch solution size");

        auto solution_binary = std::vector<char>{};
        solution_binary.resize(solution_size);

        status = miopenSaveSolution(solution_ptr.get(), solution_binary.data());
        if(status != miopenStatusSuccess)
            MIGRAPHX_THROW("MIOpen Convolution: Saving solution failed");
        solution_object = value::binary{solution_binary.data(), solution_size};

        return shape{shape::int8_type, {workspace_size}};
    }
#else
    // else use immediate find mode
    auto status = miopenConvolutionForwardGetWorkSpaceSize(ctx.get_stream().get_miopen(),
                                                           w_desc.get(),
                                                           x_desc.get(),
                                                           cd.get(),
                                                           y_desc.get(),
                                                           &workspace_size);
    if(status != miopenStatusSuccess)
        MIGRAPHX_THROW("MIOpen Convolution: Failed to get forward workspace size");

    workspace_shape = shape{shape::int8_type, {workspace_size}};

    auto x         = to_gpu(generate_argument(inputs[0]));
    auto w         = to_gpu(generate_argument(inputs[1]));
    auto y         = allocate_gpu(output_shape);
    auto workspace = allocate_gpu(workspace_shape);

    int algo_count = 1;
    miopenConvAlgoPerf_t perf;
    status = miopenFindConvolutionForwardAlgorithm(ctx.get_stream().get_miopen(),
                                                   x_desc.get(),
                                                   x.implicit(),
                                                   w_desc.get(),
                                                   w.implicit(),
                                                   cd.get(),
                                                   y_desc.get(),
                                                   y.implicit(),
                                                   1,
                                                   &algo_count,
                                                   &perf,
                                                   workspace.implicit(),
                                                   workspace_size,
                                                   false);
    if(status != miopenStatusSuccess)
        MIGRAPHX_THROW("MIOpen Convolution: find convolution failed");
    algo = perf.fwd_algo;

    size_t solution_count;

    status = miopenConvolutionForwardGetSolutionCount(ctx.get_stream().get_miopen(),
                                                      w_desc.get(),
                                                      x_desc.get(),
                                                      cd.get(),
                                                      y_desc.get(),
                                                      &solution_count);
    if(status != miopenStatusSuccess)
        MIGRAPHX_THROW("MIOpen Convolution: get solution count failed");

    std::vector<miopenConvSolution_t> solutions(solution_count);

    status = miopenConvolutionForwardGetSolution(ctx.get_stream().get_miopen(),
                                                 w_desc.get(),
                                                 x_desc.get(),
                                                 cd.get(),
                                                 y_desc.get(),
                                                 solution_count,
                                                 &solution_count,
                                                 solutions.data());
    if(status != miopenStatusSuccess)
        MIGRAPHX_THROW("MIOpen Convolution: get solution failed");

    solution_id = solutions.front().solution_id;

    return shape{shape::int8_type, {perf.memory}};
#endif
}

value miopen_convolution::compile(context& ctx, const shape& output, const std::vector<shape>& input)
{
    if(cd == nullptr)
        cd = make_conv(op);
    auto ws = find(ctx, output, input);
    return {{"workspace", ws.bytes()}};
}

void miopen_convolution::finalize(context& ctx,
                                  const shape& output_shape,
                                  const std::vector<shape>& inputs)
{
#ifdef MIGRAPHX_HAS_FIND_2_API
    {
        (void)(ctx); // avoid warnings
        (void)(output_shape);
        (void)(inputs);
        // load solution
        if(solution_ptr == nullptr)
        {
            miopenSolution_t ptr;
            auto status  = miopenLoadSolution(&ptr,
                                             reinterpret_cast<const char*>(solution_object.data()),
                                             solution_object.size());
            solution_ptr = miopen_solution{ptr};
            if(status != miopenStatusSuccess)
                MIGRAPHX_THROW("MIOpen Convolution: loading convolution solution failed");
        }
    }
#else
    // Use immediate mode API
    {
        if(cd == nullptr)
            cd = make_conv(op);
        if(solution_id == 0)
        {
            // Check that workspace hasn't changed
            auto size = inputs.at(2).bytes();
            auto ws   = find(ctx, output_shape, inputs);
            if(ws.bytes() > size)
                MIGRAPHX_THROW("MIOpen Convolution: workspace has changed during finalization.");
        }

        auto x_desc = make_tensor(reshape_if_1d(inputs[0]));
        auto w_desc = make_tensor(reshape_if_1d(inputs[1]));
        auto y_desc = make_tensor(reshape_if_1d(output_shape));

        auto status = miopenConvolutionForwardCompileSolution(ctx.get_stream().get_miopen(),
                                                              w_desc.get(),
                                                              x_desc.get(),
                                                              cd.get(),
                                                              y_desc.get(),
                                                              solution_id);
        if(status != miopenStatusSuccess)
            MIGRAPHX_THROW("MIOpen Convolution: compile solution failed");
    }
#endif
}

} // namespace gpu
} // namespace MIGRAPHX_INLINE_NS
} // namespace migraphx