TheRock/rocm-libraries/projects/hipblaslt/tensilelite/include/Tensile/SolutionLibrary.hpp

/*******************************************************************************
 *
 * MIT License
 *
 * Copyright (C) 2022-2026 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.
 *
 *******************************************************************************/

#pragma once

#include <memory>
#include <set>
#include <string>
#include <vector>

#include <Tensile/Tensile.hpp>
#include <Tensile/Task.hpp>

#include <tensilelitehost/export.h>

namespace TensileLite
{
    /**
 * \ingroup Tensile
 * \defgroup SolutionLibrary Solution Library Classes
 *
 * \copydoc TensileLite::SolutionLibrary
 */

    enum class SolutionLibrarySearchType
    {
        DEFAULT        = 1,
        GEMM_TYPE_ONLY = 2,
        HARDWARE_ONLY  = 3,
        COUNT          = 4
    };

    template <typename MySolution, typename MyProblem>
    inline bool isGemmTypeSame(const MySolution& solutions, const MyProblem& problem)
    {
        if(solutions.problemType.transA == problem.transA()
           && solutions.problemType.transB == problem.transB()
           && solutions.problemType.aType == problem.a().dataType()
           && solutions.problemType.bType == problem.b().dataType()
           && solutions.problemType.cType == problem.c().dataType()
           && solutions.problemType.dType == problem.d().dataType()
           && solutions.problemType.computeType == problem.computeType()
           && solutions.problemType.groupedGemm == problem.groupedGemm()
           && solutions.problemType.mxBlockA == problem.mxBlockA()
           && solutions.problemType.mxBlockB == problem.mxBlockB())
            return true;
        return false;
    }

    template <typename MySolution, typename MyProblem>
    inline bool softwarePredicate(const SolutionLibrarySearchType& searchType,
                                  Task&                            task,
                                  Hardware const&                  hardware,
                                  const MySolution&                solutions,
                                  const MyProblem&                 problem)
    {
        switch(searchType)
        {
        case SolutionLibrarySearchType::DEFAULT:
            // streamKDynamicQueueSupported() excludes StreamK dynamic-queue /
            // work-stealing solutions (SK4 and the dynamic sub-path of SK5) on
            // devices whose XCD count is not a power of two, warning the user
            // once. This is reject-and-continue: selection falls through to
            // another (SK3-static / non-StreamK) solution for the GEMM.
            return (*solutions.problemPredicate)(problem) && (*solutions.taskPredicate)(task)
                   && solutions.streamKDynamicQueueSupported(problem, hardware);
            break;
        case SolutionLibrarySearchType::GEMM_TYPE_ONLY:
            return isGemmTypeSame(solutions, problem);
            break;
        case SolutionLibrarySearchType::HARDWARE_ONLY:
            return true;
            break;
        default:
            break;
        }
        return false;
    }

    template <typename MySolution>
    using SolutionSet = std::set<std::shared_ptr<MySolution>>;
    template <typename MySolution>
    using SolutionVector = std::vector<std::shared_ptr<MySolution>>;

    /**
 * \ingroup SolutionLibrary
 *
 * @brief Abstract base class for Library objects that can provide a
 * mapping from `Problem` and `Hardware` objects to Solution objects.
 *
 * A complete SolutionLibrary is a tree of objects which each handles a
 * single aspect of selecting a solution for a given problem. Each node in
 * the tree will handle an aspect such as:
 * - Compatibility with a particular model of GPU
 * - Selecting kernels that solve a particular type of problem (transpose,
 *   data type, etc.)
 * - Selecting the fastest kernel based on benchmark results or other logic
 * - Ensuring that a problem is compatible with any assumptions made by a
 *   particular kernel (e.g. size or stride requirements)
 *
 * A particular complete library might look like:
 * - Master library which manages serialization
 *   - GPU selection
 *     - Problem type selection
 *        - Predicated logic for specific sizes
 *          - Matching library based on benchmarks
 *            - Individual kernels
 *
 */
    template <typename MyProblem, typename MySolution = typename MyProblem::Solution>
    struct TENSILELITEHOST_EXPORT SolutionLibrary
    {
        virtual ~SolutionLibrary() = default;

        /**
   * Returns the single `Solution` object that best solves this
   * particular `problem` on this particular piece of `hardware`.
   *
   * May return `nullptr` if no such object exists.
   */
        virtual std::shared_ptr<MySolution> getSolutionByIndex(MyProblem const& problem,
                                                               Hardware const&  hardware,
                                                               const int        index) const
            = 0;

        virtual std::shared_ptr<MySolution> getSolutionByIndex(const int index) const
        {
            throw std::runtime_error("[getSolutionByIndex] You should not reach here.");
            return std::shared_ptr<MySolution>();
        }

        virtual std::shared_ptr<MySolution> getSolutionByIndex(Hardware const&  hardware, const int index) const
        {
            throw std::runtime_error("[getSolutionByIndex] You should not reach here.");
            return std::shared_ptr<MySolution>();
        }

        virtual std::shared_ptr<MySolution> findBestSolution(MyProblem const& problem,
                                                             Hardware const&  hardware,
                                                             double* fitness = nullptr) const
            = 0;

        virtual std::shared_ptr<MySolution> findBestSolution(std::vector<MyProblem> const& problems,
                                                             Hardware const&               hardware,
                                                             double* fitness = nullptr) const
        {
            return std::shared_ptr<MySolution>();
        }

        /**
   * Returns all `Solution` objects that are capable of correctly solving this
   * `problem` on this `hardware`.
   *
   * May return an empty set if no such object exists.
   */
        virtual SolutionSet<MySolution> findAllSolutions(MyProblem const&          problem,
                                                         Hardware const&           hardware,
                                                         SolutionLibrarySearchType searchType
                                                         = SolutionLibrarySearchType::DEFAULT) const
            = 0;

        virtual SolutionSet<MySolution>
            findAllSolutionsGroupedGemm(std::vector<MyProblem> const& problems,
                                        Hardware const&               hardware,
                                        SolutionLibrarySearchType     searchType
                                        = SolutionLibrarySearchType::DEFAULT) const
            = 0;

        virtual std::string type() const        = 0;
        virtual std::string description() const = 0;

        /**
   * Returns the multiple `Solution` object that best solves this
   * particular `problem` on this particular piece of `hardware`.
   *
   * May return `nullptr` if no such object exists.
   */
        virtual SolutionVector<MySolution> findTopSolutions(MyProblem const& problem,
                                                            Hardware const&  hardware,
                                                            int              numSolutions) const
        {
            return SolutionVector<MySolution>();
        }

        virtual bool lastFindTopAlreadyRetAll() const
        {
            return true;
        }

        virtual SolutionVector<MySolution>
            findTopSolutionsGroupedGemm(std::vector<MyProblem> const& problems,
                                        Hardware const&               hardware,
                                        int                           numSolutions) const
        {
            return SolutionVector<MySolution>();
        }

        // Get the library filename for debug output (if available)
        virtual std::string getLibraryFileName() const
        {
            return "";
        }
    };

} // namespace TensileLite