/*******************************************************************************
* Copyright 2016-2018 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 TYPE_HELPERS_HPP
#define TYPE_HELPERS_HPP

#include <assert.h>
#include <math.h>

#include "mkldnn.h"

#include "c_types_map.hpp"
#include "mkldnn_traits.hpp"
#include "nstl.hpp"
#include "utils.hpp"
#include "math_utils.hpp"

namespace mkldnn {
namespace impl {

template <typename T>
status_t safe_ptr_assign(T * &lhs, T* rhs) {
    if (rhs == nullptr) return status::out_of_memory;
    lhs = rhs;
    return status::success;
}

template <typename T, typename U> struct is_subset
{ static constexpr bool value = false; };
template <typename T> struct is_subset<T, T>
{ static constexpr bool value = true; };
template <typename T> struct is_subset<T,
         typename utils::enable_if<nstl::is_integral<T>::value, float>::type>
{ static constexpr bool value = true; };
#define ISSPEC(t1, t2) template <> \
    struct is_subset<t1, t2> { static constexpr bool value = true; }
ISSPEC(int16_t, int32_t);
ISSPEC(int8_t, int32_t);
ISSPEC(uint8_t, int32_t);
ISSPEC(int8_t, int16_t);
ISSPEC(uint8_t, int16_t);
#undef ISSPEC

namespace types {

inline size_t data_type_size(data_type_t data_type) {
    using namespace data_type;
    switch (data_type) {
    case f32: return sizeof(prec_traits<f32>::type);
    case s32: return sizeof(prec_traits<s32>::type);
    case s16: return sizeof(prec_traits<s16>::type);
    case s8: return sizeof(prec_traits<s8>::type);
    case u8: return sizeof(prec_traits<u8>::type);
    case bf16: return sizeof(prec_traits<bf16>::type);
    case bin: return sizeof(prec_traits<u8>::type);
    case data_type::undef:
    default: assert(!"unknown data_type");
    }
    return 0; /* not supposed to be reachable */
}

inline memory_format_t flat_memory_format(int ndims) {
    switch (ndims) {
    case 1: return memory_format::x;
    case 2: return memory_format::nc;
    case 3: return memory_format::ncw;
    case 4: return memory_format::nchw;
    case 5: return memory_format::ncdhw;
    default: return memory_format::undef;
    }
    return memory_format::undef;
}

inline memory_format_t format_normalize(const memory_format_t fmt) {
    using namespace memory_format;
    /* FIXME: double blocked formats are special cases -- the blocking
     *        structure doesn't correctly describe memory layout (wrt
     *        the strides within blocks). Though as long as the code
     *        uses memory_desc_wrapper::off() or explicit offset
     *        calculations everything should be fine. */
    const bool is_blocked = utils::one_of(fmt, blocked,
            x,
            nc,
            ncw,
            nwc,
            nCw4c,
            nCw8c,
            nCw16c,
            nchw,
            nhwc,
            chwn,
            nChw4c,
            nChw8c,
            nChw16c,
            ncdhw,
            ndhwc,
            nCdhw4c,
            nCdhw8c,
            nCdhw16c,
            oi,
            io,
            oiw,
            wio,
            owi,
            Owi4o,
            OIw4i4o,
            Owi8o,
            OIw8i8o,
            OIw8o8i,
            OIw16i16o,
            OIw16o16i,
            Oiw4o,
            Oiw16o,
            Owi16o,
            OIw8i16o2i,
            OIw8o16i2o,
            IOw8o16i2o,
            IOw16o16i,
            oihw,
            ihwo,
            hwio,
            ohwi,
            iohw,
            hwio_s8s8,
            dhwio,
            odhwi,
            oidhw,
            OIdhw4i4o,
            Odhwi4o,
            OIdhw8i8o,
            OIdhw8o8i,
            Odhwi8o,
            OIdhw16i16o,
            OIdhw16o16i,
            Oidhw4o,
            Oidhw16o,
            Odhwi16o,
            oIhw8i,
            oIhw16i,
            oIdhw8i,
            oIdhw16i,
            OIhw4i4o,
            OIhw8i8o,
            OIhw16i16o,
            OIw4i16o4i,
            OIw4i16o4i_s8s8,
            OIhw4i16o4i,
            OIhw4i16o4i_s8s8,
            OIdhw4i16o4i,
            OIdhw4i16o4i_s8s8,
            OIhw8i16o2i,
            IOhw8i16o2i,
            OIhw8o16i2o,
            IOhw8o16i2o,
            OIdhw8i16o2i,
            OIdhw8o16i2o,
            IOdhw8o16i2o,
            OIhw8o8i,
            OhIw8o4i,
            OhIw8o32i,
            OhIw16o32i,
            OhIw8o4i_s8s8,
            OIhw16o16i,
            IOhw16o16i,
            Oihw4o,
            Oihw16o,
            Ohwi8o,
            Ohwi4o,
            Ohwi16o,
            OdhIw8o4i,
            OdhIw8o4i_s8s8,
            goiw,
            gOwi4o,
            gOIw4i4o,
            gOwi8o,
            gOIw8i8o,
            gOIw8o8i,
            gOIw16i16o,
            gOIw16o16i,
            gOiw4o,
            gOiw16o,
            gOwi16o,
            gOIw8i16o2i,
            gOIw8o16i2o,
            gIOw8o16i2o,
            gIOw16o16i,
            goihw,
            hwigo,
            giohw,
            hwigo_s8s8,
            dhwigo_s8s8,
            dhwigo,
            dhwio_s8s8,
            gOIhw4i4o,
            gOIhw8i8o,
            gOIhw16i16o,
            gOIw4i16o4i,
            gOIw4i16o4i_s8s8,
            gOIhw4i16o4i,
            gOIhw4i16o4i_s8s8,
            gOIdhw4i16o4i,
            gOIdhw4i16o4i_s8s8,
            gOIhw2i8o4i,
            gOIhw2i8o4i_s8s8,
            gOIhw8i16o2i,
            gIOhw8i16o2i,
            gOIhw8o16i2o,
            gIOhw8o16i2o,
            gOIhw4o4i,
            gOIhw4o4i_s8s8,
            gOIhw8o8i,
            gOhIw8o4i,
            gOhIw8o4i_s8s8,
            gOIhw16o16i,
            gIOhw16o16i,
            gOihw4o,
            gOihw16o,
            gOhwi8o,
            gOhwi4o,
            gOhwi16o,
            Goihw8g,
            Goihw8g_s8s8,
            Goiw16g,
            Goiw16g_s8s8,
            Goihw16g,
            Goihw16g_s8s8,
            goidhw,
            gOIdhw4i4o,
            gOdhwi4o,
            gOIdhw8i8o,
            gOIdhw8o8i,
            gOdhwi8o,
            gOIdhw16i16o,
            gOIdhw16o16i,
            gOIdhw8i16o2i,
            gOIdhw8o16i2o,
            gIOdhw8o16i2o,
            gOidhw16o,
            gOidhw4o,
            gOdhwi16o,
            gOdhIw8o4i,
            gOdhIw8o4i_s8s8,
            Goidhw8g,
            Goidhw8g_s8s8,
            Goidhw16g,
            Goidhw16g_s8s8,
            ntc,
            tnc,
            ldsnc,
            ldigo,
            ldgoi,
            ldgo);
    return is_blocked ? blocked : fmt;
}

inline bool is_format_double_blocked(memory_format_t fmt) {
    using namespace memory_format;
    return utils::one_of(fmt, OIw8i16o2i, OIw8o16i2o, IOw8o16i2o, OIw4i16o4i,
                         OIhw8i16o2i, OIhw8o16i2o, IOhw8o16i2o,
                         IOhw8i16o2i, gIOhw8i16o2i,
                         OIdhw8i16o2i, OIdhw8o16i2o, IOdhw8o16i2o,
                         OIhw4i16o4i, OIhw4i16o4i_s8s8,
                         gOIw4i16o4i, gOIw8i16o2i, gOIw8o16i2o, gIOw8o16i2o,
                         gOIhw8i16o2i, gOIhw8o16i2o, gIOhw8o16i2o,
                         gOIdhw8i16o2i, gOIdhw8o16i2o, gIOdhw8o16i2o,
                         gOIhw4i16o4i, gOIhw4i16o4i_s8s8,
                         gOIhw2i8o4i, gOIhw2i8o4i_s8s8,
                         gOIdhw4i16o4i, gOIdhw4i16o4i_s8s8,
                         OIdhw4i16o4i, OIdhw4i16o4i_s8s8);
}

inline bool blocking_desc_is_equal(const blocking_desc_t &lhs,
        const blocking_desc_t &rhs, int ndims = TENSOR_MAX_DIMS) {
    using mkldnn::impl::utils::array_cmp;
    return lhs.offset_padding == rhs.offset_padding
        && array_cmp(lhs.block_dims, rhs.block_dims, ndims)
        && array_cmp(lhs.strides[0], rhs.strides[0], ndims)
        && array_cmp(lhs.strides[1], rhs.strides[1], ndims)
        && array_cmp(lhs.padding_dims, rhs.padding_dims, ndims)
        && array_cmp(lhs.offset_padding_to_data, rhs.offset_padding_to_data,
                ndims);
}

inline bool wino_desc_is_equal(const wino_data_t &lhs,
    const wino_data_t &rhs) {
    return lhs.wino_format == rhs.wino_format
        && lhs.alpha == rhs.alpha
        && lhs.ic == rhs.ic
        && lhs.oc == rhs.oc
        && lhs.ic_block == rhs.ic_block
        && lhs.oc_block == rhs.oc_block
        && lhs.ic2_block == rhs.ic2_block
        && lhs.oc2_block == rhs.oc2_block
        && lhs.r == rhs.r;
}

inline bool rnn_packed_desc_is_equal(
        const rnn_packed_data_t &lhs, const rnn_packed_data_t &rhs) {
    bool ok = lhs.format == rhs.format && lhs.n_parts == rhs.n_parts
            && lhs.offset_compensation == rhs.offset_compensation
            && lhs.size == rhs.size
            && lhs.n == rhs.n;
    if (!ok)
        return false;

    for (int i = 0; i < rhs.n_parts; i++)
        ok = ok && lhs.parts[i] == rhs.parts[i];
    for (int i = 0; i < rhs.n_parts; i++)
        ok = ok && lhs.part_pack_size[i] == rhs.part_pack_size[i];
    return ok;
}

inline bool operator==(const memory_desc_t &lhs, const memory_desc_t &rhs) {
    assert(lhs.primitive_kind == mkldnn::impl::primitive_kind::memory);
    assert(rhs.primitive_kind == mkldnn::impl::primitive_kind::memory);
    bool base_equal = true
        && lhs.ndims == rhs.ndims
        && mkldnn::impl::utils::array_cmp(lhs.dims, rhs.dims, lhs.ndims)
        && lhs.data_type == rhs.data_type
        && lhs.format == rhs.format; /* FIXME: normalize format? */
    if (!base_equal) return false;
    if (lhs.format == memory_format::blocked)
        return blocking_desc_is_equal(lhs.layout_desc.blocking,
                rhs.layout_desc.blocking, lhs.ndims);
    else if (lhs.format == memory_format::wino_fmt)
        return wino_desc_is_equal(lhs.layout_desc.wino_desc,
            rhs.layout_desc.wino_desc);
    else if (lhs.format == memory_format::rnn_packed)
        return rnn_packed_desc_is_equal(lhs.layout_desc.rnn_packed_desc,
                rhs.layout_desc.rnn_packed_desc);
    return true;
}

inline bool operator!=(const memory_desc_t &lhs, const memory_desc_t &rhs) {
    return !operator==(lhs, rhs);
}

inline memory_desc_t zero_md() {
    auto zero = memory_desc_t();
    zero.primitive_kind = primitive_kind::memory;
    return zero;
}

inline bool is_zero_md(const memory_desc_t *md) {
    return md == nullptr || *md == zero_md();
}

inline status_t set_default_format(memory_desc_t &md, memory_format_t fmt) {
    return mkldnn_memory_desc_init(&md, md.ndims, md.dims, md.data_type, fmt);
}

inline data_type_t default_accum_data_type(data_type_t src_dt,
        data_type_t dst_dt) {
    using namespace utils;
    using namespace data_type;

    if (one_of(f32, src_dt, dst_dt)) return f32;
    if (one_of(s32, src_dt, dst_dt)) return s32;
    if (one_of(s16, src_dt, dst_dt)) return s32;
    if (one_of(bin, src_dt, dst_dt)) return s32;

    if (one_of(s8, src_dt, dst_dt) || one_of(u8, src_dt, dst_dt)) return s32;

    if (one_of(bf16, src_dt, dst_dt)) return f32;

    assert(!"unimplemented use-case: no default parameters available");
    return dst_dt;
}

inline data_type_t default_accum_data_type(data_type_t src_dt,
        data_type_t wei_dt, data_type_t dst_dt, prop_kind_t prop_kind) {
    using namespace utils;
    using namespace data_type;
    using namespace prop_kind;

    /* prop_kind doesn't matter */
    if (everyone_is(f32, src_dt, wei_dt, dst_dt)) return f32;

    if (one_of(prop_kind, forward_training, forward_inference)) {
        if (src_dt == s16 && wei_dt == s16 && dst_dt == s32)
            return s32;
        if ((src_dt == u8 || src_dt == s8)
            && wei_dt == s8 && one_of(dst_dt, f32, s32, s8, u8))
            return s32;
        if ((src_dt == bf16) && (wei_dt == bf16) && one_of(dst_dt, f32, bf16))
            return f32;
        if (src_dt == bin && wei_dt == bin && (dst_dt == f32 || dst_dt == bin))
            return s32;
    } else if (prop_kind == backward_data) {
        if (src_dt == s32 && wei_dt == s16 && dst_dt == s16)
            return s32;
        if (one_of(src_dt, f32, s32, s8, u8) && wei_dt == s8 &&
                one_of(dst_dt, s8, u8))
            return s32;
        if (one_of(src_dt, f32, bf16) && (dst_dt == bf16) && (wei_dt == bf16))
            return f32;
    } else if (prop_kind == backward_weights) {
        if (src_dt == s16 && wei_dt == s32 && dst_dt == s16)
            return s32;
        if (src_dt == bf16 && one_of(wei_dt, f32, bf16) && dst_dt == bf16)
            return f32;
    }

    assert(!"unimplemented use-case: no default parameters available");
    return dst_dt;
}

}
}
}

#include "memory_desc_wrapper.hpp"

#endif

// vim: et ts=4 sw=4 cindent cino^=l0,\:0,N-s
