//
// Copyright 2021 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// CLExtensions.h: Defines the rx::CLExtensions struct.

#ifndef LIBANGLE_RENDERER_CLEXTENSIONS_H_
#define LIBANGLE_RENDERER_CLEXTENSIONS_H_

#include "libANGLE/renderer/cl_types.h"

namespace rx
{

struct CLExtensions
{
    CLExtensions();
    ~CLExtensions();

    CLExtensions(const CLExtensions &)            = delete;
    CLExtensions &operator=(const CLExtensions &) = delete;

    CLExtensions(CLExtensions &&);
    CLExtensions &operator=(CLExtensions &&);

    void initializeExtensions(std::string &&extensionStr);
    void initializeVersionedExtensions(const NameVersionVector &versionedExtList);

    using ExternalMemoryHandleType   = cl_external_memory_handle_type_khr;
    using ExternalMemoryHandleBitset = angle::PackedEnumBitSet<cl::ExternalMemoryHandle>;
    using ExternalMemoryHandleFixedVector =
        angle::FixedVector<ExternalMemoryHandleType,
                           static_cast<int>(cl::ExternalMemoryHandle::EnumCount)>;
    using SupportedDepthOrderTypes = angle::PackedEnumBitSet<cl::ImageChannelType>;

    bool populateSupportedExternalMemoryHandleTypes(ExternalMemoryHandleBitset supportedHandles);

    std::string versionStr;
    cl_version version = 0u;

    std::string extensions;
    NameVersionVector extensionsWithVersion;

    cl_device_integer_dot_product_capabilities_khr integerDotProductCapabilities;
    cl_device_integer_dot_product_acceleration_properties_khr
        integerDotProductAccelerationProperties8Bit;
    cl_device_integer_dot_product_acceleration_properties_khr
        integerDotProductAccelerationProperties4x8BitPacked;
    ExternalMemoryHandleBitset externalMemoryHandleSupport;
    // keep an "OpenCL list" version of supported external memory types
    ExternalMemoryHandleFixedVector externalMemoryHandleSupportList;
    SupportedDepthOrderTypes supportedDepthOrderTypes;

    // These Khronos extension names must be returned by all devices that support OpenCL 1.1.
    bool khrByteAddressableStore       = false;  // cl_khr_byte_addressable_store
    bool khrGlobalInt32BaseAtomics     = false;  // cl_khr_global_int32_base_atomics
    bool khrGlobalInt32ExtendedAtomics = false;  // cl_khr_global_int32_extended_atomics
    bool khrLocalInt32BaseAtomics      = false;  // cl_khr_local_int32_base_atomics
    bool khrLocalInt32ExtendedAtomics  = false;  // cl_khr_local_int32_extended_atomics

    // These Khronos extension names must be returned by all devices that support
    // OpenCL 2.0, OpenCL 2.1, or OpenCL 2.2. For devices that support OpenCL 3.0, these
    // extension names must be returned when and only when the optional feature is supported.
    bool khr3D_ImageWrites     = false;  // cl_khr_3d_image_writes
    bool khrDepthImages        = false;  // cl_khr_depth_images
    bool khrImage2D_FromBuffer = false;  // cl_khr_image2d_from_buffer

    // Optional extensions
    bool khrExtendedVersioning   = false;  // cl_khr_extended_versioning
    bool khrFP64                 = false;  // cl_khr_fp64
    bool khrICD                  = false;  // cl_khr_icd
    bool khrInt64BaseAtomics     = false;  // cl_khr_int64_base_atomics
    bool khrInt64ExtendedAtomics = false;  // cl_khr_int64_extended_atomics
    bool khrIntegerDotProduct    = false;  // cl_khr_integer_dot_product
    bool khrExternalMemory       = false;  // cl_khr_external_memory
    bool khrPriorityHints        = false;  // cl_khr_priority_hints
    bool khrSubgroups            = false;  // cl_khr_subgroups

    bool armNonUniformWorkGroupSize = false;  // cl_arm_non_uniform_work_group_size
    bool armImportMemory            = false;  // cl_arm_import_memory
    bool armImportMemoryDMABuf      = false;  // cl_arm_import_memory_dma_buf
};

}  // namespace rx

#endif  // LIBANGLE_RENDERER_CLEXTENSIONS_H_