/*******************************************************************************
* Copyright 2022 Intel Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*******************************************************************************/

#ifndef KERNEL_CATALOG_HPP
#define KERNEL_CATALOG_HPP

#include <string>
#include <tuple>
#include <vector>

#include "gen_gemm_kernel_common.hpp"

namespace dnnl {
namespace impl {
namespace gpu {
namespace jit {

namespace kcatalog {

// There are two versions of the kernel catalog structures:
//   - a mutable version, used inside of ktool for easier modification
//   - an immutable vesion, which is an aggregate type and used when the catalog
//       is loaded.
using string = const char *;
#define DEFAULT(val)
#define DEFAULT3(v1, v2, v3)

struct Restrictions {
    int steppingMin DEFAULT(
            -1); // If >= 0, minimum supported stepping (inclusive)
    int steppingMax DEFAULT(
            -1); // If >= 0, maximum supported stepping (exclusive)
    int acceptSizesMin[3] DEFAULT3(
            -1, -1, -1); // m/n/k ranges where kernel always accepted.
    int acceptSizesMax[3] DEFAULT3(
            -1, -1, -1); //   (see kernel_evaluator.cpp for more details)
    int allowedSizesMin[3] DEFAULT3(-1, -1,
            -1); // m/n/k ranges outside of which kernel always rejected.
    int allowedSizesMax[3] DEFAULT3(-1, -1, -1);
    int alignment[3] DEFAULT3(1, 1, 1); // A/B/C alignment requirements.
    string tags; // see RestrictionTags for entries.
};

enum RestrictionTags : char {
    ReqBlock2DA = 'A',
    ReqNoBlock2DA = 'a',
    ReqBlock2DB = 'B',
    ReqNoBlock2DB = 'b',
    ReqBlock2DC = 'C',
    ReqNoBlock2DC = 'c',
    Req64BitA = 'X',
    ReqNo64BitA = 'x',
    Req64BitB = 'Y',
    ReqNo64BitB = 'y',
    Req64BitC = 'Z',
    ReqNo64BitC = 'z',
    ReqBatch = 'V',
    ReqNoBatch = 'v',
    ReqBatchMultiDim = 'W',
    ReqNoBatchMultiDim = 'w',
    ReqCustom1 = 'D',
    ReqNoCustom1 = 'd',
};

enum HWTags : char {
    HWTagGen9 = '9',
    HWTagGen11 = 'B',
    HWTagGen12LP = 'C',
    HWTagXeHP = 'D',
    HWTagXeHPG = 'E',
    HWTagXeHPC = 'F',
};

struct Selector {
    char hw; // see HWTags for entries
    string kernelType;
    string precisions[3];
    string layouts[3];

    friend bool operator<(const Selector &sel1, const Selector &sel2) {
        auto tupleize = [](const Selector &sel) {
            return std::tie(sel.hw, sel.precisions[0][0], sel.precisions[2][0],
                    sel.layouts[0][0], sel.layouts[1][0]);
        };
        return tupleize(sel1) < tupleize(sel2);
    };
    friend bool operator>(const Selector &sel1, const Selector &sel2) {
        return sel2 < sel1;
    }
    friend bool operator<=(const Selector &sel1, const Selector &sel2) {
        return !(sel2 < sel1);
    }
    friend bool operator>=(const Selector &sel1, const Selector &sel2) {
        return !(sel1 < sel2);
    }
};

enum : int {
    // Model 'W' parameters
    ParamWPriority = 0,
    ParamWCount,

    // Model 'S' parameters
    ParamS_Cm0 = 0, // Minimum constant overhead, beta = 0
    ParamS_Cm1, // Minimum constant overhead, beta = 1
    ParamS_C00, // Overhead per partial wave, constant coefficient, beta = 0
    ParamS_C01, // Overhead per partial wave, constant coefficient, beta = 1
    ParamS_C10, // Overhead per partial wave, linear coefficient, beta = 0
    ParamS_C11, // Overhead per partial wave, linear coefficient, beta = 1
    ParamS_Ma, // A per-element load cost
    ParamS_Mb, // B per-element load cost
    ParamS_Ef, // Peak efficiency, full waves
    ParamS_Ep0, // Peak efficiency, partial wave, constant coefficient
    ParamS_Ep1, // Peak efficiency, partial wave, linear coefficient
    ParamS_Em, // Load balancing weight factor (0 = ignore load balancing, 1 = full weight for load balancing term)
    ParamS_Fp, // Max sustained frequency ratio nominal freq/actual freq.
    ParamS_Fr0, // FMA count at which frequency starts dropping.
    ParamS_Fr1, // FMA count at which frequency stops dropping.
    ParamSCount,

    // Maximum possible parameter count
    MaxParamCount = ParamSCount,
};

struct Model {
    char id;
    int paramCount;
    double params[MaxParamCount];
};

struct Entry {
    Selector selector;
    Restrictions restrictions;
    string strategy;
    CommonDriverInfo driverInfo;
    Model model;

    friend bool operator<(const Entry &e1, const Entry &e2) {
        return e1.selector < e2.selector;
    }
    friend bool operator>(const Entry &e1, const Entry &e2) {
        return e1.selector > e2.selector;
    }
    friend bool operator<=(const Entry &e1, const Entry &e2) {
        return e1.selector <= e2.selector;
    }
    friend bool operator>=(const Entry &e1, const Entry &e2) {
        return e1.selector >= e2.selector;
    }
    friend bool operator<(const Entry &e, const Selector &s) {
        return e.selector < s;
    }
    friend bool operator>(const Entry &e, const Selector &s) {
        return e.selector > s;
    }
    friend bool operator<=(const Entry &e, const Selector &s) {
        return e.selector <= s;
    }
    friend bool operator>=(const Entry &e, const Selector &s) {
        return e.selector >= s;
    }
    friend bool operator<(const Selector &s, const Entry &e) {
        return s < e.selector;
    }
    friend bool operator>(const Selector &s, const Entry &e) {
        return s > e.selector;
    }
    friend bool operator<=(const Selector &s, const Entry &e) {
        return s <= e.selector;
    }
    friend bool operator>=(const Selector &s, const Entry &e) {
        return s >= e.selector;
    }
};

struct Catalog {
    static constexpr int currentVersion() { return 1; }

    int version DEFAULT(currentVersion());
    uint64_t revision DEFAULT(0);
    int entryCount DEFAULT(0);

    const Entry *entries;
};

template <size_t n>
struct FlatCatalog {
    int version;
    uint64_t revision;
    int entryCount;
    Entry entries[n];

    /* implicit */ operator Catalog() const {
        Catalog catalog = {version, revision, entryCount, &entries[0]};
        return catalog;
    }
};

} /* namespace kcatalog */

} // namespace jit
} // namespace gpu
} // namespace impl
} // namespace dnnl

#endif /* header guard */
