Skip to content

Used functools.cache to cache filter_string property #1127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 21, 2023
Merged

Used functools.cache to cache filter_string property #1127

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
76637ae
Used functools.cache to cache filter_string property
oleksandr-pavlyk Mar 16, 2023
586a2ab
Use lru_cache, to support Python 3.8
oleksandr-pavlyk Mar 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 36 additions & 11 deletions dpctl/_sycl_device.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,7 @@ from libc.stdlib cimport free, malloc
from ._sycl_platform cimport SyclPlatform

import collections
import functools
import warnings

__all__ = [
Expand Down Expand Up @@ -198,6 +199,37 @@ cdef void _init_helper(_SyclDevice device, DPCTLSyclDeviceRef DRef):
device._max_work_item_sizes = DPCTLDevice_GetMaxWorkItemSizes3d(DRef)


@functools.lru_cache(maxsize=None)
def _cached_filter_string(d : SyclDevice):
"""
Internal utility to compute filter_string of input SyclDevice
and cached with `functools.cache`.

Args:
d (dpctl.SyclDevice):
A device for which to compute the filter string.
Returns:
out(str):
Filter string that can be used to create input device,
if the device is a root (unpartitioned) device.

Raises:
ValueError: if the input device is a sub-device.
"""
cdef _backend_type BTy
cdef _device_type DTy
cdef int64_t relId = -1
cdef SyclDevice cd = <SyclDevice> d
relId = DPCTLDeviceMgr_GetRelativeId(cd._device_ref)
if (relId == -1):
raise ValueError("This SyclDevice is not a root device")
BTy = DPCTLDevice_GetBackend(cd._device_ref)
br_str = _backend_type_to_filter_string_part(BTy)
DTy = DPCTLDevice_GetDeviceType(cd._device_ref)
dt_str = _device_type_to_filter_string_part(DTy)
return ":".join((br_str, dt_str, str(relId)))


cdef class SyclDevice(_SyclDevice):
""" SyclDevice(arg=None)
A Python wrapper for the :sycl_device:`sycl::device <>` C++ class.
Expand Down Expand Up @@ -1360,14 +1392,14 @@ cdef class SyclDevice(_SyclDevice):

@property
def filter_string(self):
""" For a parent device, returns a fully specified filter selector
string``backend:device_type:relative_id`` selecting the device.
""" For a root device, returns a fully specified filter selector
string ``"backend:device_type:relative_id"`` selecting the device.

Returns:
str: A Python string representing a filter selector string.

Raises:
TypeError: If the device is a sub-devices.
TypeError: If the device is a sub-device.

:Example:
.. code-block:: python
Expand All @@ -1387,14 +1419,7 @@ cdef class SyclDevice(_SyclDevice):
cdef int64_t relId = -1
pDRef = DPCTLDevice_GetParentDevice(self._device_ref)
if (pDRef is NULL):
BTy = DPCTLDevice_GetBackend(self._device_ref)
DTy = DPCTLDevice_GetDeviceType(self._device_ref)
relId = DPCTLDeviceMgr_GetRelativeId(self._device_ref)
if (relId == -1):
raise TypeError("This SyclDevice is not a root device")
br_str = _backend_type_to_filter_string_part(BTy)
dt_str = _device_type_to_filter_string_part(DTy)
return ":".join((br_str, dt_str, str(relId)))
return _cached_filter_string(self)
else:
# this a sub-device, free it, and raise an exception
DPCTLDevice_Delete(pDRef)
Expand Down