31424878304

Committed 10 Aug 2026 07:35PM UTC coverage: 74.161% (+0.1%) from 74.054%

Build # 31424878304

Build Type

Pull #2354

github

Committed by

web-flow

Commit Message

Merge d098035c4 into 6c5d2deda

Pull Request Pull Request #2354: Add `sycl::info::context` queries to `dpctl.SyclContext`

Coverage Stats

969 of 1372 branches covered (70.63%)

Branch coverage included in aggregate %.

49 of 56 new or added lines in 1 file covered. (87.5%)

108 existing lines in 1 file now uncovered.

3692 of 4913 relevant lines covered (75.15%)

288.56 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

77.19

/libsyclinterface/source/dpctl_sycl_device_interface.cpp

//===--- dpctl_sycl_device_interface.cpp - Implements C API for sycl::device =//
//
//                      Data Parallel Control (dpctl)
//
// Copyright 2020 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.
//
//===----------------------------------------------------------------------===//
///
/// \file
/// This file implements the data types and functions declared in
/// dpctl_sycl_device_interface.h.
///
//===----------------------------------------------------------------------===//

#include "dpctl_sycl_device_interface.h"
#include "Config/dpctl_config.h"
#include "dpctl_device_selection.hpp"
#include "dpctl_error_handlers.h"
#include "dpctl_string_utils.hpp"
#include "dpctl_sycl_device_manager.h"
#include "dpctl_sycl_type_casters.hpp"
#include "dpctl_utils_helper.h"
#include <algorithm>
#include <stddef.h>
#include <sycl/sycl.hpp> /* SYCL headers   */
#include <utility>
#include <vector>

using namespace sycl;

namespace
{

static_assert(__SYCL_COMPILER_VERSION >= __SYCL_COMPILER_VERSION_REQUIRED,
              "The compiler does not meet minimum version requirement");

using namespace dpctl::syclinterface;

device *new_device_from_selector(const dpctl_device_selector *sel)
{
    return new device(
        [=](const device &d) -> int { return sel->operator()(d); });
}

template <int dim>
__dpctl_give size_t *
DPCTLDevice__GetMaxWorkItemSizes(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    size_t *sizes = nullptr;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
#if __SYCL_COMPILER_VERSION >= __SYCL_COMPILER_MAX_WORK_ITEM_SIZE_THRESHOLD
            auto id_sizes =
                D->get_info<info::device::max_work_item_sizes<dim>>();
#else
            auto id_sizes = D->get_info<info::device::max_work_item_sizes>();
#endif
            sizes = new size_t[dim];
            for (auto i = 0ul; i < dim; ++i) {
                sizes[i] = id_sizes[i];
            }
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return sizes;
}

} /* end of anonymous namespace */

__dpctl_give DPCTLSyclDeviceRef
DPCTLDevice_Copy(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    auto Device = unwrap<device>(DRef);
    if (!Device) {
        error_handler("Cannot copy DPCTLSyclDeviceRef as input is a nullptr",
                      __FILE__, __func__, __LINE__);
        return nullptr;
    }
    try {
        auto CopiedDevice = new device(*Device);
        return wrap<device>(CopiedDevice);
    } catch (std::exception const &e) {
        error_handler(e, __FILE__, __func__, __LINE__);
        return nullptr;
    }
}

__dpctl_give DPCTLSyclDeviceRef DPCTLDevice_Create()
{
    try {
        auto Device = new device();
        return wrap<device>(Device);
    } catch (std::exception const &e) {
        error_handler(e, __FILE__, __func__, __LINE__);
        return nullptr;
    }
}

__dpctl_give DPCTLSyclDeviceRef DPCTLDevice_CreateFromSelector(
    __dpctl_keep const DPCTLSyclDeviceSelectorRef DSRef)
{
    auto Selector = unwrap<dpctl_device_selector>(DSRef);
    if (!Selector) {
        error_handler("Cannot define device selector for DPCTLSyclDeviceRef "
                      "as input is a nullptr.",
                      __FILE__, __func__, __LINE__);
        return nullptr;
    }
    try {
        auto Device = new_device_from_selector(Selector);
        return wrap<device>(Device);
    } catch (std::exception const &e) {
        error_handler(e, __FILE__, __func__, __LINE__);
        return nullptr;
    }
}

void DPCTLDevice_Delete(__dpctl_take DPCTLSyclDeviceRef DRef)
{
    delete unwrap<device>(DRef);
}

DPCTLSyclDeviceType
DPCTLDevice_GetDeviceType(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    DPCTLSyclDeviceType DTy = DPCTLSyclDeviceType::DPCTL_UNKNOWN_DEVICE;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            auto SyclDTy = D->get_info<info::device::device_type>();
            DTy = DPCTL_SyclDeviceTypeToDPCTLDeviceType(SyclDTy);
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return DTy;
}

bool DPCTLDevice_IsAccelerator(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    auto D = unwrap<device>(DRef);
    if (D) {
        return D->is_accelerator();
    }
    return false;
}

bool DPCTLDevice_IsCPU(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    auto D = unwrap<device>(DRef);
    if (D) {
        return D->is_cpu();
    }
    return false;
}

bool DPCTLDevice_IsGPU(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    auto D = unwrap<device>(DRef);
    if (D) {
        return D->is_gpu();
    }
    return false;
}

DPCTLSyclBackendType
DPCTLDevice_GetBackend(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    DPCTLSyclBackendType BTy = DPCTLSyclBackendType::DPCTL_UNKNOWN_BACKEND;
    auto D = unwrap<device>(DRef);
    if (D) {
        BTy = DPCTL_SyclBackendToDPCTLBackendType(D->get_backend());
    }
    return BTy;
}

uint32_t
DPCTLDevice_GetMaxComputeUnits(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    uint32_t nComputeUnits = 0;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            nComputeUnits = D->get_info<info::device::max_compute_units>();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return nComputeUnits;
}

uint64_t
DPCTLDevice_GetGlobalMemSize(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    uint64_t GlobalMemSize = 0;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            GlobalMemSize = D->get_info<info::device::global_mem_size>();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return GlobalMemSize;
}

uint64_t DPCTLDevice_GetLocalMemSize(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    uint64_t LocalMemSize = 0;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            LocalMemSize = D->get_info<info::device::local_mem_size>();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return LocalMemSize;
}

uint32_t
DPCTLDevice_GetMaxWorkItemDims(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    uint32_t maxWorkItemDims = 0;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            maxWorkItemDims =
                D->get_info<info::device::max_work_item_dimensions>();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return maxWorkItemDims;
}

__dpctl_give size_t *
DPCTLDevice_GetMaxWorkItemSizes1d(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return DPCTLDevice__GetMaxWorkItemSizes<1>(DRef);
}

__dpctl_give size_t *
DPCTLDevice_GetMaxWorkItemSizes2d(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return DPCTLDevice__GetMaxWorkItemSizes<2>(DRef);
}

__dpctl_give size_t *
DPCTLDevice_GetMaxWorkItemSizes3d(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return DPCTLDevice__GetMaxWorkItemSizes<3>(DRef);
}

size_t
DPCTLDevice_GetMaxWorkGroupSize(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    size_t max_wg_size = 0;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            max_wg_size = D->get_info<info::device::max_work_group_size>();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return max_wg_size;
}

uint32_t
DPCTLDevice_GetMaxNumSubGroups(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    size_t max_nsubgroups = 0;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            max_nsubgroups = D->get_info<info::device::max_num_sub_groups>();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return max_nsubgroups;
}

__dpctl_give DPCTLSyclPlatformRef
DPCTLDevice_GetPlatform(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    DPCTLSyclPlatformRef PRef = nullptr;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            PRef = wrap<platform>(new platform(D->get_platform()));
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return PRef;
}

__dpctl_give const char *
DPCTLDevice_GetName(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    const char *cstr_name = nullptr;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            auto name = D->get_info<info::device::name>();
            cstr_name = dpctl::helper::cstring_from_string(name);
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return cstr_name;
}

__dpctl_give const char *
DPCTLDevice_GetVendor(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    const char *cstr_vendor = nullptr;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            auto vendor = D->get_info<info::device::vendor>();
            cstr_vendor = dpctl::helper::cstring_from_string(vendor);
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return cstr_vendor;
}

__dpctl_give const char *
DPCTLDevice_GetDriverVersion(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    const char *cstr_driver = nullptr;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            auto driver = D->get_info<info::device::driver_version>();
            cstr_driver = dpctl::helper::cstring_from_string(driver);
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return cstr_driver;
}

bool DPCTLDevice_AreEq(__dpctl_keep const DPCTLSyclDeviceRef DRef1,
                       __dpctl_keep const DPCTLSyclDeviceRef DRef2)
{
    auto D1 = unwrap<device>(DRef1);
    auto D2 = unwrap<device>(DRef2);
    if (D1 && D2)
        return *D1 == *D2;
    else
        return false;
}

bool DPCTLDevice_HasAspect(__dpctl_keep const DPCTLSyclDeviceRef DRef,
                           DPCTLSyclAspectType AT)
{
    bool hasAspect = false;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            hasAspect = D->has(DPCTL_DPCTLAspectTypeToSyclAspect(AT));
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return hasAspect;
}

#define declmethod(FUNC, NAME, TYPE)                                           \
    TYPE DPCTLDevice_##FUNC(__dpctl_keep const DPCTLSyclDeviceRef DRef)        \
    {                                                                          \
        TYPE result = 0;                                                       \
        auto D = unwrap<device>(DRef);                                         \
        if (D) {                                                               \
            try {                                                              \
                result = D->get_info<info::device::NAME>();                    \
            } catch (std::exception const &e) {                                \
                error_handler(e, __FILE__, __func__, __LINE__);                \
            }                                                                  \
        }                                                                      \
        return result;                                                         \
    }
declmethod(GetMaxReadImageArgs, max_read_image_args, uint32_t);
declmethod(GetMaxWriteImageArgs, max_write_image_args, uint32_t);
declmethod(GetImage2dMaxWidth, image2d_max_width, size_t);
declmethod(GetImage2dMaxHeight, image2d_max_height, size_t);
declmethod(GetImage3dMaxWidth, image3d_max_width, size_t);
declmethod(GetImage3dMaxHeight, image3d_max_height, size_t);
declmethod(GetImage3dMaxDepth, image3d_max_depth, size_t);
#undef declmethod

namespace
{

template <typename descriptorT>
uint32_t get_uint32_descriptor(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    uint32_t descr_val = 0;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            descr_val = D->get_info<descriptorT>();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return descr_val;
}

} // end of anonymous namespace

uint32_t DPCTLDevice_GetPreferredVectorWidthChar(
    __dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return get_uint32_descriptor<info::device::preferred_vector_width_char>(
        DRef);
}

uint32_t DPCTLDevice_GetPreferredVectorWidthShort(
    __dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return get_uint32_descriptor<info::device::preferred_vector_width_short>(
        DRef);
}

uint32_t DPCTLDevice_GetPreferredVectorWidthInt(
    __dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return get_uint32_descriptor<info::device::preferred_vector_width_int>(
        DRef);
}

uint32_t DPCTLDevice_GetPreferredVectorWidthLong(
    __dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return get_uint32_descriptor<info::device::preferred_vector_width_long>(
        DRef);
}

uint32_t DPCTLDevice_GetPreferredVectorWidthFloat(
    __dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return get_uint32_descriptor<info::device::preferred_vector_width_float>(
        DRef);
}

uint32_t DPCTLDevice_GetPreferredVectorWidthDouble(
    __dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return get_uint32_descriptor<info::device::preferred_vector_width_double>(
        DRef);
}

uint32_t DPCTLDevice_GetPreferredVectorWidthHalf(
    __dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return get_uint32_descriptor<info::device::preferred_vector_width_half>(
        DRef);
}

//
uint32_t
DPCTLDevice_GetNativeVectorWidthChar(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return get_uint32_descriptor<info::device::native_vector_width_char>(DRef);
}

uint32_t DPCTLDevice_GetNativeVectorWidthShort(
    __dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return get_uint32_descriptor<info::device::native_vector_width_short>(DRef);
}

uint32_t
DPCTLDevice_GetNativeVectorWidthInt(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return get_uint32_descriptor<info::device::native_vector_width_int>(DRef);
}

uint32_t
DPCTLDevice_GetNativeVectorWidthLong(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return get_uint32_descriptor<info::device::native_vector_width_long>(DRef);
}

uint32_t DPCTLDevice_GetNativeVectorWidthFloat(
    __dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return get_uint32_descriptor<info::device::native_vector_width_float>(DRef);
}

uint32_t DPCTLDevice_GetNativeVectorWidthDouble(
    __dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return get_uint32_descriptor<info::device::native_vector_width_double>(
        DRef);
}

uint32_t
DPCTLDevice_GetNativeVectorWidthHalf(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    return get_uint32_descriptor<info::device::native_vector_width_half>(DRef);
}

__dpctl_give DPCTLSyclDeviceRef
DPCTLDevice_GetParentDevice(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    auto D = unwrap<device>(DRef);
    if (D) {
        bool is_unpartitioned = false;
        try {
            auto pp =
                D->get_info<sycl::info::device::partition_type_property>();
            is_unpartitioned =
                (pp == sycl::info::partition_property::no_partition);
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
            return nullptr;
        }
        if (is_unpartitioned)
            return nullptr;
        try {
            const auto &parent_D = D->get_info<info::device::parent_device>();
            return wrap<device>(new device(parent_D));
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
            return nullptr;
        }
    }
    else
        return nullptr;
}

uint32_t DPCTLDevice_GetPartitionMaxSubDevices(
    __dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            uint32_t part_max_sub_devs =
                D->get_info<info::device::partition_max_sub_devices>();
            return part_max_sub_devs;
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
            return 0;
        }
    }
    else
        return 0;
}

__dpctl_give DPCTLDeviceVectorRef
DPCTLDevice_CreateSubDevicesEqually(__dpctl_keep const DPCTLSyclDeviceRef DRef,
                                    size_t count)
{
    using vecTy = std::vector<DPCTLSyclDeviceRef>;
    vecTy *Devices = nullptr;
    if (DRef) {
        if (count == 0) {
            error_handler("Cannot create sub-devices with zero compute units",
                          __FILE__, __func__, __LINE__);
            return nullptr;
        }
        auto D = unwrap<device>(DRef);
        const auto &supported_properties =
            D->get_info<info::device::partition_properties>();
        const auto &beg_it = supported_properties.begin();
        const auto &end_it = supported_properties.end();
        if (std::find(beg_it, end_it,
                      info::partition_property::partition_equally) == end_it)
        {
            // device does not support partition equally
            return nullptr;
        }
        try {
            auto subDevices = D->create_sub_devices<
                info::partition_property::partition_equally>(count);
            Devices = new vecTy();
            for (const auto &sd : subDevices) {
                Devices->emplace_back(wrap<device>(new device(sd)));
            }
        } catch (std::exception const &e) {
            delete Devices;
            error_handler(e, __FILE__, __func__, __LINE__);
            return nullptr;
        }
    }
    return wrap<vecTy>(Devices);
}

__dpctl_give DPCTLDeviceVectorRef
DPCTLDevice_CreateSubDevicesByCounts(__dpctl_keep const DPCTLSyclDeviceRef DRef,
                                     __dpctl_keep size_t *counts,
                                     size_t ncounts)
{
    using vecTy = std::vector<DPCTLSyclDeviceRef>;
    vecTy *Devices = nullptr;
    std::vector<size_t> vcounts(ncounts);
    vcounts.assign(counts, counts + ncounts);
    size_t min_elem = *std::min_element(vcounts.begin(), vcounts.end());
    if (min_elem == 0) {
        error_handler("Cannot create sub-devices with zero compute units",
                      __FILE__, __func__, __LINE__);
        return nullptr;
    }
    if (DRef) {
        auto D = unwrap<device>(DRef);
        const auto &supported_properties =
            D->get_info<info::device::partition_properties>();
        const auto &beg_it = supported_properties.begin();
        const auto &end_it = supported_properties.end();
        if (std::find(beg_it, end_it,
                      info::partition_property::partition_by_counts) == end_it)
        {
            // device does not support partition by counts
            return nullptr;
        }
        std::vector<std::remove_pointer<decltype(D)>::type> subDevices;
        try {
            subDevices = D->create_sub_devices<
                info::partition_property::partition_by_counts>(vcounts);
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
            return nullptr;
        }
        try {
            Devices = new vecTy();
            for (const auto &sd : subDevices) {
                Devices->emplace_back(wrap<device>(new device(sd)));
            }
        } catch (std::exception const &e) {
            delete Devices;
            error_handler(e, __FILE__, __func__, __LINE__);
            return nullptr;
        }
    }
    return wrap<vecTy>(Devices);
}

__dpctl_give DPCTLDeviceVectorRef DPCTLDevice_CreateSubDevicesByAffinity(
    __dpctl_keep const DPCTLSyclDeviceRef DRef,
    DPCTLPartitionAffinityDomainType PartitionAffinityDomainTy)
{
    using vecTy = std::vector<DPCTLSyclDeviceRef>;
    vecTy *Devices = nullptr;
    auto D = unwrap<device>(DRef);
    if (D) {
        const auto &supported_properties =
            D->get_info<info::device::partition_properties>();
        const auto &beg_it = supported_properties.begin();
        const auto &end_it = supported_properties.end();
        if (std::find(beg_it, end_it,
                      info::partition_property::partition_by_affinity_domain) ==
            end_it)
        {
            // device does not support partition by affinity domain
            return nullptr;
        }
        try {
            auto domain = DPCTL_DPCTLPartitionAffinityDomainTypeToSycl(
                PartitionAffinityDomainTy);
            const auto &supported_affinity_domains =
                D->get_info<info::device::partition_affinity_domains>();
            const auto &beg_it = supported_affinity_domains.begin();
            const auto &end_it = supported_affinity_domains.end();
            if (std::find(beg_it, end_it, domain) == end_it) {
                // device does not support partitioning by this particular
                // affinity domain
                return nullptr;
            }
            auto subDevices = D->create_sub_devices<
                info::partition_property::partition_by_affinity_domain>(domain);
            Devices = new vecTy();
            for (const auto &sd : subDevices) {
                Devices->emplace_back(wrap<device>(new device(sd)));
            }
        } catch (std::exception const &e) {
            delete Devices;
            error_handler(e, __FILE__, __func__, __LINE__);
            return nullptr;
        }
    }
    return wrap<vecTy>(Devices);
}

size_t DPCTLDevice_Hash(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    if (DRef) {
        auto D = unwrap<device>(DRef);
        std::hash<device> hash_fn;
        return hash_fn(*D);
    }
    else {
        error_handler("Argument DRef is null", __FILE__, __func__, __LINE__);
        return 0;
    }
}

size_t DPCTLDevice_GetProfilingTimerResolution(
    __dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    if (DRef) {
        auto D = unwrap<device>(DRef);
        return D->get_info<info::device::profiling_timer_resolution>();
    }
    else {
        error_handler("Argument DRef is null", __FILE__, __func__, __LINE__);
        return 0;
    }
}

uint32_t DPCTLDevice_GetGlobalMemCacheLineSize(
    __dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    if (DRef) {
        auto D = unwrap<device>(DRef);
        return D->get_info<info::device::global_mem_cache_line_size>();
    }
    else {
        error_handler("Argument DRef is null", __FILE__, __func__, __LINE__);
        return 0;
    }
}

uint32_t
DPCTLDevice_GetMaxClockFrequency(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    if (DRef) {
        auto D = unwrap<device>(DRef);
        return D->get_info<info::device::max_clock_frequency>();
    }
    else {
        error_handler("Argument DRef is null", __FILE__, __func__, __LINE__);
        return 0;
    }
}

uint64_t
DPCTLDevice_GetMaxMemAllocSize(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    if (DRef) {
        auto D = unwrap<device>(DRef);
        return D->get_info<info::device::max_mem_alloc_size>();
    }
    else {
        error_handler("Argument DRef is null", __FILE__, __func__, __LINE__);
        return 0;
    }
}

uint64_t
DPCTLDevice_GetGlobalMemCacheSize(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    if (DRef) {
        auto D = unwrap<device>(DRef);
        return D->get_info<info::device::global_mem_cache_size>();
    }
    else {
        error_handler("Argument DRef is null", __FILE__, __func__, __LINE__);
        return 0;
    }
}

DPCTLGlobalMemCacheType
DPCTLDevice_GetGlobalMemCacheType(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    if (DRef) {
        auto D = unwrap<device>(DRef);
        try {
            auto mem_type = D->get_info<info::device::global_mem_cache_type>();
            switch (mem_type) {
            case info::global_mem_cache_type::none:
                return DPCTL_MEM_CACHE_TYPE_NONE;
            case info::global_mem_cache_type::read_only:
                return DPCTL_MEM_CACHE_TYPE_READ_ONLY;
            case info::global_mem_cache_type::read_write:
                return DPCTL_MEM_CACHE_TYPE_READ_WRITE;
            }
            // If execution reaches here unrecognized mem_type was returned.
            // Check values in the enumeration `info::global_mem_cache_type` in
            // SYCL specs
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return DPCTL_MEM_CACHE_TYPE_INDETERMINATE;
}

__dpctl_give size_t *
DPCTLDevice_GetSubGroupSizes(__dpctl_keep const DPCTLSyclDeviceRef DRef,
                             size_t *res_len)
{
    size_t *sizes = nullptr;
    std::vector<size_t> sg_sizes;
    *res_len = 0;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            sg_sizes = D->get_info<info::device::sub_group_sizes>();
            *res_len = sg_sizes.size();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
        try {
            sizes = new size_t[sg_sizes.size()];
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
        for (auto i = 0ul; (sizes != nullptr) && i < sg_sizes.size(); ++i) {
            sizes[i] = sg_sizes[i];
        }
    }
    return sizes;
}

__dpctl_give DPCTLDeviceVectorRef
DPCTLDevice_GetComponentDevices(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    using vecTy = std::vector<DPCTLSyclDeviceRef>;
    vecTy *ComponentDevicesVectorPtr = nullptr;
    if (DRef) {
        auto D = unwrap<device>(DRef);
        try {
            auto componentDevices =
                D->get_info<sycl::ext::oneapi::experimental::info::device::
                                component_devices>();
            ComponentDevicesVectorPtr = new vecTy();
            ComponentDevicesVectorPtr->reserve(componentDevices.size());
            for (const auto &cd : componentDevices) {
                ComponentDevicesVectorPtr->emplace_back(
                    wrap<device>(new device(cd)));
            }
        } catch (std::exception const &e) {
            delete ComponentDevicesVectorPtr;
            error_handler(e, __FILE__, __func__, __LINE__);
            return nullptr;
        }
    }
    return wrap<vecTy>(ComponentDevicesVectorPtr);
}

__dpctl_give DPCTLSyclDeviceRef
DPCTLDevice_GetCompositeDevice(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    auto D = unwrap<device>(DRef);
    if (D) {
        bool is_component = false;
        try {
            is_component = D->has(sycl::aspect::ext_oneapi_is_component);
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
            return nullptr;
        }
        if (!is_component)
            return nullptr;
        try {
            const auto &compositeDevice =
                D->get_info<sycl::ext::oneapi::experimental::info::device::
                                composite_device>();
            return wrap<device>(new device(compositeDevice));
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
            return nullptr;
        }
    }
    else
        return nullptr;
}

static inline bool _CallPeerAccess(device dev, device peer)
{
    auto BE1 = dev.get_backend();
    auto BE2 = peer.get_backend();

    if ((BE1 == BE2) &&
        (BE1 == sycl::backend::ext_oneapi_level_zero ||
         BE1 == sycl::backend::ext_oneapi_cuda ||
         BE1 == sycl::backend::ext_oneapi_hip) &&
        (BE2 == sycl::backend::ext_oneapi_level_zero ||
         BE2 == sycl::backend::ext_oneapi_cuda ||
         BE2 == sycl::backend::ext_oneapi_hip) &&
        (dev != peer))
    {
        return true;
    }
    return false;
}

bool DPCTLDevice_CanAccessPeer(__dpctl_keep const DPCTLSyclDeviceRef DRef,
                               __dpctl_keep const DPCTLSyclDeviceRef PDRef,
                               DPCTLPeerAccessType PT)
{
    bool canAccess = false;
    auto D = unwrap<device>(DRef);
    auto PD = unwrap<device>(PDRef);
    if (D && PD) {
        if (_CallPeerAccess(*D, *PD)) {
            try {
                canAccess = D->ext_oneapi_can_access_peer(
                    *PD, DPCTL_DPCTLPeerAccessTypeToSycl(PT));
            } catch (std::exception const &e) {
                error_handler(e, __FILE__, __func__, __LINE__);
            }
        }
    }
    return canAccess;
}

void DPCTLDevice_EnablePeerAccess(__dpctl_keep const DPCTLSyclDeviceRef DRef,
                                  __dpctl_keep const DPCTLSyclDeviceRef PDRef)
{
    auto D = unwrap<device>(DRef);
    auto PD = unwrap<device>(PDRef);
    if (D && PD) {
        if (_CallPeerAccess(*D, *PD)) {
            try {
                D->ext_oneapi_enable_peer_access(*PD);
            } catch (std::exception const &e) {
                error_handler(e, __FILE__, __func__, __LINE__);
            }
        }
        else {
            error_handler("Devices do not support peer access", __FILE__,
                          __func__, __LINE__);
        }
    }
    return;
}

void DPCTLDevice_DisablePeerAccess(__dpctl_keep const DPCTLSyclDeviceRef DRef,
                                   __dpctl_keep const DPCTLSyclDeviceRef PDRef)
{
    auto D = unwrap<device>(DRef);
    auto PD = unwrap<device>(PDRef);
    if (D && PD) {
        if (_CallPeerAccess(*D, *PD)) {
            try {
                D->ext_oneapi_disable_peer_access(*PD);
            } catch (std::exception const &e) {
                error_handler(e, __FILE__, __func__, __LINE__);
            }
        }
        else {
            error_handler("Devices do not support peer access", __FILE__,
                          __func__, __LINE__);
        }
    }
    return;
}

uint32_t DPCTLDevice_GetVendorId(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    uint32_t vendorId = 0;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            vendorId = D->get_info<info::device::vendor_id>();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return vendorId;
}

uint32_t DPCTLDevice_GetAddressBits(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    uint32_t addressBits = 0;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            addressBits = D->get_info<info::device::address_bits>();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return addressBits;
}

size_t
DPCTLDevice_GetImageMaxBufferSize(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    size_t result = 0;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            result = D->get_info<info::device::image_max_buffer_size>();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return result;
}

uint32_t DPCTLDevice_GetMaxSamplers(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    uint32_t result = 0;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            result = D->get_info<info::device::max_samplers>();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return result;
}

size_t
DPCTLDevice_GetMaxParameterSize(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    size_t result = 0;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            result = D->get_info<info::device::max_parameter_size>();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return result;
}

uint32_t
DPCTLDevice_GetMemBaseAddrAlign(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    uint32_t result = 0;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            result = D->get_info<info::device::mem_base_addr_align>();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return result;
}

bool DPCTLDevice_GetErrorCorrectionSupport(
    __dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    bool result = false;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            result = D->get_info<info::device::error_correction_support>();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return result;
}

bool DPCTLDevice_IsAvailable(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    bool result = false;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            result = D->get_info<info::device::is_available>();
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return result;
}

__dpctl_give const char *
DPCTLDevice_GetVersion(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    const char *cstr_version = nullptr;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            auto version = D->get_info<info::device::version>();
            cstr_version = dpctl::helper::cstring_from_string(version);
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return cstr_version;
}

__dpctl_give const char *
DPCTLDevice_GetBackendVersion(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    const char *cstr_version = nullptr;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            auto version = D->get_info<info::device::backend_version>();
            cstr_version = dpctl::helper::cstring_from_string(version);
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return cstr_version;
}

DPCTLLocalMemType
DPCTLDevice_GetLocalMemType(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    if (DRef) {
        auto D = unwrap<device>(DRef);
        try {
            auto mem_type = D->get_info<info::device::local_mem_type>();
            return DPCTL_SyclLocalMemTypeToDPCTLType(mem_type);
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return DPCTL_LOCAL_MEM_TYPE_UNKNOWN;
}

DPCTLPartitionPropertyType
DPCTLDevice_GetPartitionTypeProperty(__dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    if (DRef) {
        auto D = unwrap<device>(DRef);
        try {
            auto pp = D->get_info<info::device::partition_type_property>();
            return DPCTL_SyclPartitionPropertyToDPCTLType(pp);
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return DPCTL_PARTITION_UNKNOWN;
}

DPCTLPartitionAffinityDomainType DPCTLDevice_GetPartitionTypeAffinityDomain(
    __dpctl_keep const DPCTLSyclDeviceRef DRef)
{
    if (DRef) {
        auto D = unwrap<device>(DRef);
        try {
            auto domain =
                D->get_info<info::device::partition_type_affinity_domain>();
            return DPCTL_SyclPartitionAffinityDomainToDPCTLType(domain);
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
        }
    }
    return DPCTLPartitionAffinityDomainType::
        DPCTL_PARTITION_AFFINITY_DOMAIN_UNKNOWN;
}

namespace
{

template <typename InfoDescT, typename ConvertFn>
int *get_info_enum_array(__dpctl_keep const DPCTLSyclDeviceRef DRef,
                         size_t *res_len,
                         ConvertFn convert)
{
    int *arr = nullptr;
    *res_len = 0;
    auto D = unwrap<device>(DRef);
    if (D) {
        try {
            auto values = D->get_info<InfoDescT>();
            *res_len = values.size();
            if (*res_len > 0) {
                arr = new int[*res_len];
                for (size_t i = 0; i < *res_len; ++i) {
                    arr[i] = convert(values[i]);
                }
            }
        } catch (std::exception const &e) {
            error_handler(e, __FILE__, __func__, __LINE__);
            delete[] arr;
            arr = nullptr;
            *res_len = 0;
        }
    }
    return arr;
}

} // end of anonymous namespace

__dpctl_give int *
DPCTLDevice_GetHalfFPConfig(__dpctl_keep const DPCTLSyclDeviceRef DRef,
                            size_t *res_len)
{
    return get_info_enum_array<info::device::half_fp_config>(
        DRef, res_len, DPCTL_SyclFPConfigToDPCTLType);
}

__dpctl_give int *
DPCTLDevice_GetSingleFPConfig(__dpctl_keep const DPCTLSyclDeviceRef DRef,
                              size_t *res_len)
{
    return get_info_enum_array<info::device::single_fp_config>(
        DRef, res_len, DPCTL_SyclFPConfigToDPCTLType);
}

__dpctl_give int *
DPCTLDevice_GetDoubleFPConfig(__dpctl_keep const DPCTLSyclDeviceRef DRef,
                              size_t *res_len)
{
    return get_info_enum_array<info::device::double_fp_config>(
        DRef, res_len, DPCTL_SyclFPConfigToDPCTLType);
}

__dpctl_give int *DPCTLDevice_GetAtomicMemoryOrderCapabilities(
    __dpctl_keep const DPCTLSyclDeviceRef DRef,
    size_t *res_len)
{
    return get_info_enum_array<info::device::atomic_memory_order_capabilities>(
        DRef, res_len, DPCTL_SyclMemoryOrderToDPCTLType);
}

__dpctl_give int *DPCTLDevice_GetAtomicFenceOrderCapabilities(
    __dpctl_keep const DPCTLSyclDeviceRef DRef,
    size_t *res_len)
{
    return get_info_enum_array<info::device::atomic_fence_order_capabilities>(
        DRef, res_len, DPCTL_SyclMemoryOrderToDPCTLType);
}

__dpctl_give int *DPCTLDevice_GetAtomicMemoryScopeCapabilities(
    __dpctl_keep const DPCTLSyclDeviceRef DRef,
    size_t *res_len)
{
    return get_info_enum_array<info::device::atomic_memory_scope_capabilities>(
        DRef, res_len, DPCTL_SyclMemoryScopeToDPCTLType);
}

__dpctl_give int *DPCTLDevice_GetAtomicFenceScopeCapabilities(
    __dpctl_keep const DPCTLSyclDeviceRef DRef,
    size_t *res_len)
{
    return get_info_enum_array<info::device::atomic_fence_scope_capabilities>(
        DRef, res_len, DPCTL_SyclMemoryScopeToDPCTLType);
}

__dpctl_give int *
DPCTLDevice_GetPartitionProperties(__dpctl_keep const DPCTLSyclDeviceRef DRef,
                                   size_t *res_len)
{
    return get_info_enum_array<info::device::partition_properties>(
        DRef, res_len, DPCTL_SyclPartitionPropertyToDPCTLType);
}

__dpctl_give int *DPCTLDevice_GetPartitionAffinityDomains(
    __dpctl_keep const DPCTLSyclDeviceRef DRef,
    size_t *res_len)
{
    return get_info_enum_array<info::device::partition_affinity_domains>(
        DRef, res_len, DPCTL_SyclPartitionAffinityDomainToDPCTLType);
}

IntelPython / dpctl / 31424878304

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous