// -*- C++ -*-
//===-- execution_sycl_defs.h ---------------------------------------------===//
//
// Copyright (C) Intel Corporation
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
// This file incorporates work covered by the following copyright and permission
// notice:
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
//
//===----------------------------------------------------------------------===//

#ifndef _ONEDPL_EXECUTION_SYCL_DEFS_H
#define _ONEDPL_EXECUTION_SYCL_DEFS_H

#include "../../onedpl_config.h"
#include "../../execution_defs.h"
#include "../../iterator_defs.h"

#include "sycl_defs.h"

#include <type_traits>
#include <utility> // std::pair
#include <cstdint> // std::uintptr_t
#include <atomic>  // atomic_signal_fence
#include <cassert>

namespace oneapi
{
namespace dpl
{
namespace execution
{
inline namespace __dpl
{

namespace __internal
{

#if _ONEDPL_PREDEFINED_POLICIES
struct __global_instance_tag {};
#endif
using __queue_factory = sycl::queue (*)();

class alignas(sycl::queue) __queue_holder
{
    static_assert(sizeof(sycl::queue) >= sizeof(std::pair<std::uintptr_t, __queue_factory>));
    static_assert(alignof(sycl::queue) >= alignof(std::uintptr_t));

    union
    {
        sycl::queue __q;
        std::pair<std::uintptr_t, __queue_factory> __flag_and_factory;
    };

    bool
    __has_queue() const
    {
        bool res = true;
#if _ONEDPL_PREDEFINED_POLICIES
        // If the first size-of-pointer bytes are zeros, we consider there is no valid queue.
        res = (__flag_and_factory.first != 0);
        std::atomic_signal_fence(std::memory_order_acq_rel); // to prevent possible reordering due to type punning
#endif
        return res;
    }

  public:
    template <typename T, std::enable_if_t<std::is_constructible_v<sycl::queue, T&&>, int> = 0>
    __queue_holder(T&& __qarg) : __q(std::forward<T>(__qarg)) {}

#if _ONEDPL_PREDEFINED_POLICIES
    // The ctor for predefined policy instances does not create a queue but stores a queue factory.
    // The first size-of-pointer bytes - the "flag" - are nullified to indicate that there is no valid queue.
    // Then a pointer to a factory function is stored.
    __queue_holder(__global_instance_tag, __queue_factory __f) : __flag_and_factory(0, __f) {}
#endif

    ~__queue_holder()
    {
        if (__has_queue())
            __q.~queue();
        else
            __flag_and_factory.second = nullptr;
    }

    // Copy operations must be provided explicitly
    __queue_holder(const __queue_holder& __h) : __q(__h.__get_queue()) {}

    __queue_holder&
    operator=(const __queue_holder& __h)
    {
        if (this != &__h)
            __q = __h.__get_queue();
        return *this;
    }

    // Move operations must be provided explicitly
    // Predefined policies should never be moved, so the move-from object must have a valid queue
    __queue_holder(__queue_holder&& __h) : __q(std::move(__h.__q)) {}

    __queue_holder&
    operator=(__queue_holder&& __h)
    {
        if (this != &__h)
            __q = std::move(__h.__q);
        return *this;
    }

    sycl::queue
    __get_queue() const
    {
        if (__has_queue())
            return __q;
        return (__flag_and_factory.second)();
    }
};

// Queue factory functions to use with the queue holder
inline sycl::queue
__get_default_queue()
{
    static sycl::queue __q;
    return __q;
}

#if _ONEDPL_FPGA_DEVICE
inline sycl::queue
__get_fpga_default_queue()
{
    static sycl::queue __q(
#if _ONEDPL_FPGA_EMU
        __dpl_sycl::__fpga_emulator_selector()
#else
        __dpl_sycl::__fpga_selector()
#endif
    );
    return __q;
}
#endif // _ONEDPL_FPGA_DEVICE

} // namespace __internal

struct DefaultKernelName;

//We can create device_policy object:
// 1. from sycl::queue
// 2. from sycl::device_selector (implicitly through sycl::queue)
// 3. from sycl::device
// 4. from other device_policy encapsulating the same queue type
template <typename KernelName = DefaultKernelName>
class device_policy
{
  public:
    using kernel_name = KernelName;

    device_policy() : device_policy(__internal::__get_default_queue()) {}
    template <typename OtherName>
    device_policy(const device_policy<OtherName>& other) : __qh(other.queue()) {}
    explicit device_policy(sycl::queue q) : __qh(std::move(q)) {}
    explicit device_policy(sycl::device d) : __qh(std::move(d)) {}

    operator sycl::queue() const { return queue(); }
    sycl::queue
    queue() const
    {
        return __qh.__get_queue();
    }

#if _ONEDPL_PREDEFINED_POLICIES
    explicit device_policy(__internal::__global_instance_tag __t)
        : __qh(__t, /*factory*/__internal::__get_default_queue) {}

  protected:
    device_policy(__internal::__global_instance_tag __t, __internal::__queue_factory __f) : __qh(__t, __f) {}
#endif

  private:
    static_assert(sizeof(__internal::__queue_holder) == sizeof(sycl::queue));
    static_assert(alignof(__internal::__queue_holder) == alignof(sycl::queue));
    __internal::__queue_holder __qh;
};

#if _ONEDPL_FPGA_DEVICE
struct DefaultKernelNameFPGA;

template <unsigned int factor = 1, typename KernelName = DefaultKernelNameFPGA>
class [[deprecated("oneDPL execution policies for FPGA are deprecated and will be removed in a future release.")]]
fpga_policy : public device_policy<KernelName>
{
    using base = device_policy<KernelName>;

  public:
    static constexpr unsigned int unroll_factor = factor;

    fpga_policy() : base(__internal::__get_fpga_default_queue()) {}

    template <unsigned int other_factor, typename OtherName>
    fpga_policy(const fpga_policy<other_factor, OtherName>& other) : base(other.queue()) {}
    explicit fpga_policy(sycl::queue q) : base(q) {}
    explicit fpga_policy(sycl::device d) : base(d) {}
#if _ONEDPL_PREDEFINED_POLICIES
    explicit fpga_policy(__internal::__global_instance_tag __t)
        : base(__t, /*factory*/__internal::__get_fpga_default_queue) {}
#endif
};
#endif // _ONEDPL_FPGA_DEVICE

// 2.8, Execution policy objects
#if _ONEDPL_PREDEFINED_POLICIES

// In order to be useful oneapi::dpl::execution::dpcpp_default.queue() from one translation unit should be equal to
// oneapi::dpl::execution::dpcpp_default.queue() from another TU.
// Starting with c++17 we can simply define sycl as inline variable.
#    if _ONEDPL___cplusplus >= 201703L

inline const device_policy<> dpcpp_default{__internal::__global_instance_tag{}};
#        if _ONEDPL_FPGA_DEVICE
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
inline const fpga_policy<> dpcpp_fpga
    [[deprecated("oneDPL execution policies for FPGA are deprecated and will be removed in a future release.")]]
    {__internal::__global_instance_tag{}};
#pragma GCC diagnostic pop
#        endif // _ONEDPL_FPGA_DEVICE

#    endif // _ONEDPL___cplusplus >= 201703L

#endif // _ONEDPL_PREDEFINED_POLICIES

// make_policy functions
template <typename KernelName = DefaultKernelName>
device_policy<KernelName>
make_device_policy(sycl::queue q)
{
    return device_policy<KernelName>(q);
}

template <typename KernelName = DefaultKernelName>
device_policy<KernelName>
make_device_policy(sycl::device d)
{
    return device_policy<KernelName>(d);
}

template <typename NewKernelName, typename OldKernelName = DefaultKernelName>
device_policy<NewKernelName>
make_device_policy(const device_policy<OldKernelName>& policy
#if _ONEDPL_PREDEFINED_POLICIES
                   = dpcpp_default
#endif // _ONEDPL_PREDEFINED_POLICIES
)
{
    return device_policy<NewKernelName>(policy);
}

template <typename NewKernelName, typename OldKernelName = DefaultKernelName>
device_policy<NewKernelName>
make_hetero_policy(const device_policy<OldKernelName>& policy)
{
    return device_policy<NewKernelName>(policy);
}

#if _ONEDPL_FPGA_DEVICE
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
template <unsigned int unroll_factor = 1, typename KernelName = DefaultKernelNameFPGA>
[[deprecated("oneDPL execution policies for FPGA are deprecated and will be removed in a future release.")]]
fpga_policy<unroll_factor, KernelName>
make_fpga_policy(sycl::queue q)
{
    return fpga_policy<unroll_factor, KernelName>(q);
}

template <unsigned int unroll_factor = 1, typename KernelName = DefaultKernelNameFPGA>
[[deprecated("oneDPL execution policies for FPGA are deprecated and will be removed in a future release.")]]
fpga_policy<unroll_factor, KernelName>
make_fpga_policy(sycl::device d)
{
    return fpga_policy<unroll_factor, KernelName>(d);
}

template <unsigned int new_unroll_factor, typename NewKernelName, unsigned int old_unroll_factor = 1,
          typename OldKernelName = DefaultKernelNameFPGA>
[[deprecated("oneDPL execution policies for FPGA are deprecated and will be removed in a future release.")]]
fpga_policy<new_unroll_factor, NewKernelName>
make_fpga_policy(const fpga_policy<old_unroll_factor, OldKernelName>& policy
#    if _ONEDPL_PREDEFINED_POLICIES
                 = dpcpp_fpga
#    endif // _ONEDPL_PREDEFINED_POLICIES
)
{
    return fpga_policy<new_unroll_factor, NewKernelName>(policy);
}

template <unsigned int new_unroll_factor, typename NewKernelName, unsigned int old_unroll_factor = 1,
          typename OldKernelName = DefaultKernelNameFPGA>
[[deprecated("oneDPL execution policies for FPGA are deprecated and will be removed in a future release.")]]
fpga_policy<new_unroll_factor, NewKernelName>
make_hetero_policy(const fpga_policy<old_unroll_factor, OldKernelName>& policy)
{
    return fpga_policy<new_unroll_factor, NewKernelName>(policy);
}
#pragma GCC diagnostic pop
#endif // _ONEDPL_FPGA_DEVICE

} // namespace __dpl

inline namespace v1
{

// 2.3, Execution policy type trait
template <typename... PolicyParams>
struct is_execution_policy<device_policy<PolicyParams...>> : ::std::true_type
{
};

#if _ONEDPL_FPGA_DEVICE
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
template <unsigned int unroll_factor, typename... PolicyParams>
struct is_execution_policy<fpga_policy<unroll_factor, PolicyParams...>> : ::std::true_type
{
};
#pragma GCC diagnostic pop
#endif

} // namespace v1
} // namespace execution

namespace __internal
{
template <typename Policy>
using __policy_kernel_name = typename ::std::decay_t<Policy>::kernel_name;

template <typename Policy>
inline constexpr unsigned int __policy_unroll_factor = ::std::decay_t<Policy>::unroll_factor;

template <typename _T>
struct __is_device_execution_policy : ::std::false_type
{
};

template <typename... PolicyParams>
struct __is_device_execution_policy<execution::device_policy<PolicyParams...>> : ::std::true_type
{
};

template <typename _T>
inline constexpr bool __is_device_execution_policy_v = __is_device_execution_policy<_T>::value;

template <typename _T>
struct __is_fpga_execution_policy : ::std::false_type
{
};

#if _ONEDPL_FPGA_DEVICE
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
template <unsigned int unroll_factor, typename... PolicyParams>
struct __is_fpga_execution_policy<execution::fpga_policy<unroll_factor, PolicyParams...>> : ::std::true_type
{
};

template <typename _T, unsigned int unroll_factor, typename... PolicyParams>
struct __ref_or_copy_impl<execution::fpga_policy<unroll_factor, PolicyParams...>, _T>
{
    using type = _T;
};
#pragma GCC diagnostic pop
#endif

template <typename _T, typename... PolicyParams>
struct __ref_or_copy_impl<execution::device_policy<PolicyParams...>, _T>
{
    using type = _T;
};

// Extension: hetero execution policy type trait
template <typename _T>
using __is_hetero_execution_policy =
    ::std::disjunction<__is_device_execution_policy<_T>, __is_fpga_execution_policy<_T>>;

template <typename _T>
inline constexpr bool __is_hetero_execution_policy_v = __is_hetero_execution_policy<_T>::value;

// Extension: check if parameter pack is convertible to events
template <class... _Ts>
inline constexpr bool __is_convertible_to_event = (::std::is_convertible_v<::std::decay_t<_Ts>, sycl::event> && ...);

template <typename _T, typename... _Ts>
using __enable_if_convertible_to_events = ::std::enable_if_t<__is_convertible_to_event<_Ts...>, _T>;

// Extension: execution policies type traits
template <typename _ExecPolicy, typename _T, typename... _Events>
using __enable_if_device_execution_policy = ::std::enable_if_t<
    __is_device_execution_policy_v<::std::decay_t<_ExecPolicy>> && __is_convertible_to_event<_Events...>, _T>;

template <typename _ExecPolicy, typename _T = void>
using __enable_if_hetero_execution_policy =
    ::std::enable_if_t<__is_hetero_execution_policy_v<::std::decay_t<_ExecPolicy>>, _T>;

template <typename _ExecPolicy, typename _T = void>
using __enable_if_fpga_execution_policy =
    ::std::enable_if_t<__is_fpga_execution_policy<::std::decay_t<_ExecPolicy>>::value, _T>;

template <typename _ExecPolicy, typename _T, typename _Op1, typename... _Events>
using __enable_if_device_execution_policy_single_no_default =
    ::std::enable_if_t<__is_device_execution_policy_v<::std::decay_t<_ExecPolicy>> &&
                           !::std::is_convertible_v<_Op1, sycl::event> && __is_convertible_to_event<_Events...>,
                       _T>;

template <typename _ExecPolicy, typename _T, typename _Op1, typename _Op2, typename... _Events>
using __enable_if_device_execution_policy_double_no_default =
    ::std::enable_if_t<__is_device_execution_policy_v<::std::decay_t<_ExecPolicy>> &&
                           !::std::is_convertible_v<_Op1, sycl::event> && !::std::is_convertible_v<_Op2, sycl::event> &&
                           __is_convertible_to_event<_Events...>,
                       _T>;

template <typename _BackendTag>
struct __hetero_tag
{
    using __backend_tag = _BackendTag;
};

struct __device_backend_tag
{
};

//----------------------------------------------------------
// __select_backend (for the hetero policies)
//----------------------------------------------------------

template <class... _IteratorTypes, typename _KernelName>
__hetero_tag<__device_backend_tag>
__select_backend(const execution::device_policy<_KernelName>&, _IteratorTypes&&...)
{
    static_assert(__is_random_access_iterator_v<_IteratorTypes...>);
    return {};
}

#if _ONEDPL_FPGA_DEVICE
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
struct __fpga_backend_tag : __device_backend_tag
{
};

template <class... _IteratorTypes, unsigned int _Factor, typename _KernelName>
__hetero_tag<__fpga_backend_tag>
__select_backend(const execution::fpga_policy<_Factor, _KernelName>&, _IteratorTypes&&...)
{
    static_assert(__is_random_access_iterator_v<_IteratorTypes...>);
    return {};
}
#pragma GCC diagnostic pop
#endif

//----------------------------------------------------------
// __is_hetero_backend_tag, __is_hetero_backend_tag_v
//----------------------------------------------------------

template <typename _BackendTag>
struct __is_hetero_backend_tag : ::std::false_type
{
};

template <>
struct __is_hetero_backend_tag<__device_backend_tag> : ::std::true_type
{
};

#if _ONEDPL_FPGA_DEVICE
template <>
struct __is_hetero_backend_tag<__fpga_backend_tag> : ::std::true_type
{
};
#endif

template <typename _BackendTag>
inline constexpr bool __is_hetero_backend_tag_v = __is_hetero_backend_tag<_BackendTag>::value;

} // namespace __internal

} // namespace dpl
} // namespace oneapi

#endif // _ONEDPL_EXECUTION_SYCL_DEFS_H
