1214133091

Build Type

github

Committed by GitHub

Commit Message

Merge 1f50ed8a8 into 783ded995

Pull Request Pull Request #578: Add methods __bool__, __float__ and __int__ to usm_ndarray

Run Details

547 of 881 branches covered (62.09%)

Branch coverage included in aggregate %.

20 of 34 new or added lines in 3 files covered. (58.82%)

2 existing lines in 1 file now uncovered.

3813 of 5272 relevant lines covered (72.33%)

11.31 hits per line

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

90.16

/dpctl/memory/_sycl_usm_array_interface_utils.pxi



cdef bint _valid_usm_ptr_and_context(DPCTLSyclUSMRef ptr, SyclContext ctx):
    usm_type = _Memory.get_pointer_type(ptr, ctx)
    return usm_type in (b'shared', b'device', b'host')


cdef DPCTLSyclQueueRef _queue_ref_copy_from_SyclQueue(
    DPCTLSyclUSMRef ptr, SyclQueue q):
    """ Check that USM ptr is consistent with SYCL context in the queue,
    and return a copy of QueueRef if so, or NULL otherwise.
    """
    cdef SyclContext ctx = q.get_sycl_context()
    if (_valid_usm_ptr_and_context(ptr, ctx)):
        return DPCTLQueue_Copy(q.get_queue_ref())
    else:
        return NULL


cdef DPCTLSyclQueueRef _queue_ref_copy_from_USMRef_and_SyclContext(
    DPCTLSyclUSMRef ptr, SyclContext ctx):
    """ Obtain device from pointer and sycl context, use
        context and device to create a queue from which this memory
        can be accessible.
    """
    cdef SyclDevice dev = _Memory.get_pointer_device(ptr, ctx)
    cdef DPCTLSyclContextRef CRef = ctx.get_context_ref()
    cdef DPCTLSyclDeviceRef DRef = dev.get_device_ref()
    return DPCTLQueue_Create(CRef, DRef, NULL, 0)


cdef DPCTLSyclQueueRef get_queue_ref_from_ptr_and_syclobj(
    DPCTLSyclUSMRef ptr, object syclobj):
    """ Constructs queue from pointer and syclobject from
        __sycl_usm_array_interface__
    """
    cdef SyclContext ctx
    if type(syclobj) is SyclQueue:
        return _queue_ref_copy_from_SyclQueue(ptr, <SyclQueue> syclobj)
    elif type(syclobj) is SyclContext:
        ctx = <SyclContext>syclobj
        return _queue_ref_copy_from_USMRef_and_SyclContext(ptr, ctx)
    elif type(syclobj) is str:
        q = SyclQueue(syclobj)
        return _queue_ref_copy_from_SyclQueue(ptr, <SyclQueue> q)
    elif pycapsule.PyCapsule_IsValid(syclobj, "SyclQueueRef"):
        q = SyclQueue(syclobj)
        return _queue_ref_copy_from_SyclQueue(ptr, <SyclQueue> q)
    elif pycapsule.PyCapsule_IsValid(syclobj, "SyclContextRef"):
        ctx = <SyclContext>SyclContext(syclobj)
        return _queue_ref_copy_from_USMRef_and_SyclContext(ptr, ctx)
    elif hasattr(syclobj, '_get_capsule'):
        cap = syclobj._get_capsule()
        if pycapsule.PyCapsule_IsValid(cap, "SyclQueueRef"):
            q = SyclQueue(cap)
            return _queue_ref_copy_from_SyclQueue(ptr, <SyclQueue> q)
        elif pycapsule.PyCapsule_IsValid(cap, "SyclContextRef"):
            ctx = <SyclContext>SyclContext(cap)
            return _queue_ref_copy_from_USMRef_and_SyclContext(ptr, ctx)
        else:
            return NULL
    else:
        return NULL


cdef object _pointers_from_shape_and_stride(
    int nd, object ary_shape, Py_ssize_t itemsize, Py_ssize_t ary_offset,
    object ary_strides):
    """
    Internal utility: for given array data about shape/layout/element
    compute left-most displacement when enumerating all elements of the array
    and the number of bytes of memory between the left-most and right-most
    displacements.

    Returns: tuple(min_disp, nbytes)
    """
    if (nd > 0):
        if (ary_strides is None):
            nelems = 1
            for si in ary_shape:
                sh_i = int(si)
                if (sh_i <= 0):
                    raise ValueError("Array shape elements need to be positive")
                nelems = nelems * sh_i
            return (ary_offset, nelems * itemsize)
        else:
            min_disp = ary_offset
            max_disp = ary_offset
            for i in range(nd):
                str_i = int(ary_strides[i])
                sh_i = int(ary_shape[i])
                if (sh_i <= 0):
                    raise ValueError("Array shape elements need to be positive")
                if (str_i > 0):
                    max_disp += str_i * (sh_i - 1)
                else:
                    min_disp += str_i * (sh_i - 1);
            return (min_disp, (max_disp - min_disp + 1) * itemsize)
    elif (nd == 0):
        return (ary_offset, itemsize)
    else:
        raise ValueError("Array dimensions can not be negative")


cdef class _USMBufferData:
    """
    Internal data struct populated from parsing
    `__sycl_usm_array_interface__` dictionary
    """
    cdef DPCTLSyclUSMRef p
    cdef int writeable
    cdef object dt
    cdef Py_ssize_t itemsize
    cdef Py_ssize_t nbytes
    cdef SyclQueue queue

    @staticmethod
    cdef _USMBufferData from_sycl_usm_ary_iface(dict ary_iface):
        cdef object ary_data_tuple = ary_iface.get('data', None)
        cdef object ary_typestr = ary_iface.get('typestr', None)
        cdef object ary_shape = ary_iface.get('shape', None)
        cdef object ary_strides = ary_iface.get('strides', None)
        cdef object ary_syclobj = ary_iface.get('syclobj', None)
        cdef Py_ssize_t ary_offset = ary_iface.get('offset', 0)
        cdef int ary_version = ary_iface.get('version', 0)
        cdef size_t arr_data_ptr = 0
        cdef DPCTLSyclUSMRef memRef = NULL
        cdef Py_ssize_t itemsize = -1
        cdef int writeable = -1
        cdef int nd = -1
        cdef DPCTLSyclQueueRef QRef = NULL
        cdef object dt
        cdef _USMBufferData buf
        cdef SyclDevice dev
        cdef SyclContext ctx

        if ary_version != 1:
            raise ValueError(("__sycl_usm_array_interface__ is malformed:"
                              " dict('version': {}) is unexpected."
                              " The only recognized version is 1.").format(
                                  ary_version))
        if not ary_data_tuple or len(ary_data_tuple) != 2:
            raise ValueError("__sycl_usm_array_interface__ is malformed:"
                             " 'data' field is required, and must be a tuple"
                             " (usm_pointer, is_writeable_boolean).")
        arr_data_ptr = <size_t>ary_data_tuple[0]
        writeable = 1 if ary_data_tuple[1] else 0
        # Check that memory and syclobj are consistent:
        # (USM pointer is bound to this sycl context)
        memRef = <DPCTLSyclUSMRef>arr_data_ptr
        QRef = get_queue_ref_from_ptr_and_syclobj(memRef, ary_syclobj)
        if (QRef is NULL):
            raise ValueError("__sycl_usm_array_interface__ is malformed:"
                             " 'data' field is not consistent with 'syclobj'"
                             " field, the pointer {} is not bound to"
                             " SyclContext derived from"
                             " dict('syclobj': {}).".format(
                                 hex(arr_data_ptr), ary_syclobj))
        # shape must be present
        if ary_shape is None or not (
                isinstance(ary_shape, collections.abc.Sized) and
                isinstance(ary_shape, collections.abc.Iterable)):
            DPCTLQueue_Delete(QRef)
            raise ValueError("Shape entry is a required element of "
                             "`__sycl_usm_array_interface__` dictionary")
        nd = len(ary_shape)
        try:
            dt = np.dtype(ary_typestr)
            if (dt.hasobject or not (np.issubdtype(dt.type, np.integer) or
                                     np.issubdtype(dt.type, np.inexact))):
                DPCTLQueue_Delete(QRef)
                raise TypeError("Only integer types, floating and complex "
                                "floating types are supported.")
            itemsize = <Py_ssize_t> (dt.itemsize)
        except TypeError as e:
            raise ValueError(
                "__sycl_usm_array_interface__ is malformed:"
                " dict('typestr': {}) is unexpected. ".format(ary_typestr)
            ) from e

        if (ary_strides is None or (
                isinstance(ary_strides, collections.abc.Sized) and
                isinstance(ary_strides, collections.abc.Iterable) and
                len(ary_strides) == nd)):
            min_disp, nbytes = _pointers_from_shape_and_stride(
                nd, ary_shape, itemsize, ary_offset, ary_strides)
        else:
            DPCTLQueue_Delete(QRef)
            raise ValueError("__sycl_usm_array_interface__ is malformed: "
                             "'strides' must be a tuple or "
                             "list of the same length as shape")

        buf = _USMBufferData.__new__(_USMBufferData)
        buf.p = <DPCTLSyclUSMRef>(
            arr_data_ptr + (<Py_ssize_t>min_disp) * itemsize)
        buf.writeable = writeable
        buf.itemsize = itemsize
        buf.nbytes = <Py_ssize_t> nbytes

        buf.queue = SyclQueue._create(QRef)

        return buf

1
2
3	cdef bint _valid_usm_ptr_and_context(DPCTLSyclUSMRef ptr, SyclContext ctx):	×
4	usm_type = _Memory.get_pointer_type(ptr, ctx)	1✔
5	return usm_type in (b'shared', b'device', b'host')	1✔
6
7
8	cdef DPCTLSyclQueueRef _queue_ref_copy_from_SyclQueue(	×
9	DPCTLSyclUSMRef ptr, SyclQueue q):
10	""" Check that USM ptr is consistent with SYCL context in the queue,
11	and return a copy of QueueRef if so, or NULL otherwise.
12	"""
13	cdef SyclContext ctx = q.get_sycl_context()	1✔
14	if (_valid_usm_ptr_and_context(ptr, ctx)):	1✔
15	return DPCTLQueue_Copy(q.get_queue_ref())	1✔
16	else:
17	return NULL	×
18
19
20	cdef DPCTLSyclQueueRef _queue_ref_copy_from_USMRef_and_SyclContext(	×
21	DPCTLSyclUSMRef ptr, SyclContext ctx):
22	""" Obtain device from pointer and sycl context, use
23	context and device to create a queue from which this memory
24	can be accessible.
25	"""
26	cdef SyclDevice dev = _Memory.get_pointer_device(ptr, ctx)	1✔
27	cdef DPCTLSyclContextRef CRef = ctx.get_context_ref()	1✔
28	cdef DPCTLSyclDeviceRef DRef = dev.get_device_ref()	1✔
29	return DPCTLQueue_Create(CRef, DRef, NULL, 0)	1✔
30
31
32	cdef DPCTLSyclQueueRef get_queue_ref_from_ptr_and_syclobj(	×
33	DPCTLSyclUSMRef ptr, object syclobj):
34	""" Constructs queue from pointer and syclobject from
35	__sycl_usm_array_interface__
36	"""
37	cdef SyclContext ctx
38	if type(syclobj) is SyclQueue:	1✔
39	return _queue_ref_copy_from_SyclQueue(ptr, <SyclQueue> syclobj)	1✔
40	elif type(syclobj) is SyclContext:	1✔
41	ctx = <SyclContext>syclobj	1✔
42	return _queue_ref_copy_from_USMRef_and_SyclContext(ptr, ctx)	1✔
43	elif type(syclobj) is str:	1✔
44	q = SyclQueue(syclobj)	1✔
45	return _queue_ref_copy_from_SyclQueue(ptr, <SyclQueue> q)	1✔
46	elif pycapsule.PyCapsule_IsValid(syclobj, "SyclQueueRef"):	1✔
47	q = SyclQueue(syclobj)	1✔
48	return _queue_ref_copy_from_SyclQueue(ptr, <SyclQueue> q)	1✔
49	elif pycapsule.PyCapsule_IsValid(syclobj, "SyclContextRef"):	1✔
50	ctx = <SyclContext>SyclContext(syclobj)	1✔
51	return _queue_ref_copy_from_USMRef_and_SyclContext(ptr, ctx)	1✔
52	elif hasattr(syclobj, '_get_capsule'):	1✔
53	cap = syclobj._get_capsule()	1✔
54	if pycapsule.PyCapsule_IsValid(cap, "SyclQueueRef"):	1✔
55	q = SyclQueue(cap)	1✔
56	return _queue_ref_copy_from_SyclQueue(ptr, <SyclQueue> q)	1✔
57	elif pycapsule.PyCapsule_IsValid(cap, "SyclContextRef"):	1✔
58	ctx = <SyclContext>SyclContext(cap)	1✔
59	return _queue_ref_copy_from_USMRef_and_SyclContext(ptr, ctx)	1✔
60	else:
61	return NULL	×
62	else:
63	return NULL	1✔
64
65
66	cdef object _pointers_from_shape_and_stride(	×
67	int nd, object ary_shape, Py_ssize_t itemsize, Py_ssize_t ary_offset,
68	object ary_strides):
69	"""
70	Internal utility: for given array data about shape/layout/element
71	compute left-most displacement when enumerating all elements of the array
72	and the number of bytes of memory between the left-most and right-most
73	displacements.
74
75	Returns: tuple(min_disp, nbytes)
76	"""
77	if (nd > 0):	1✔
78	if (ary_strides is None):	1✔
79	nelems = 1	1✔
80	for si in ary_shape:	1✔
81	sh_i = int(si)	1✔
82	if (sh_i <= 0):	1✔
83	raise ValueError("Array shape elements need to be positive")	1✔
84	nelems = nelems * sh_i	1✔
85	return (ary_offset, nelems * itemsize)	1✔
86	else:
87	min_disp = ary_offset	1✔
88	max_disp = ary_offset	1✔
89	for i in range(nd):	1✔
90	str_i = int(ary_strides[i])	1✔
91	sh_i = int(ary_shape[i])	1✔
92	if (sh_i <= 0):	1✔
93	raise ValueError("Array shape elements need to be positive")	1✔
94	if (str_i > 0):	1✔
95	max_disp += str_i * (sh_i - 1)	1✔
96	else:
97	min_disp += str_i * (sh_i - 1);	1✔
98	return (min_disp, (max_disp - min_disp + 1) * itemsize)	1✔
99	elif (nd == 0):	×
100	return (ary_offset, itemsize)	×
101	else:
102	raise ValueError("Array dimensions can not be negative")	×
103
104
105	cdef class _USMBufferData:
106	"""
107	Internal data struct populated from parsing
108	`__sycl_usm_array_interface__` dictionary
109	"""
110	cdef DPCTLSyclUSMRef p
111	cdef int writeable
112	cdef object dt
113	cdef Py_ssize_t itemsize
114	cdef Py_ssize_t nbytes
115	cdef SyclQueue queue
116
117	@staticmethod
118	cdef _USMBufferData from_sycl_usm_ary_iface(dict ary_iface):	×
119	cdef object ary_data_tuple = ary_iface.get('data', None)	1✔
120	cdef object ary_typestr = ary_iface.get('typestr', None)	1✔
121	cdef object ary_shape = ary_iface.get('shape', None)	1✔
122	cdef object ary_strides = ary_iface.get('strides', None)	1✔
123	cdef object ary_syclobj = ary_iface.get('syclobj', None)	1✔
124	cdef Py_ssize_t ary_offset = ary_iface.get('offset', 0)	1✔
125	cdef int ary_version = ary_iface.get('version', 0)	1✔
126	cdef size_t arr_data_ptr = 0	1✔
127	cdef DPCTLSyclUSMRef memRef = NULL	1✔
128	cdef Py_ssize_t itemsize = -1	1✔
129	cdef int writeable = -1	1✔
130	cdef int nd = -1	1✔
131	cdef DPCTLSyclQueueRef QRef = NULL	1✔
132	cdef object dt
133	cdef _USMBufferData buf
134	cdef SyclDevice dev
135	cdef SyclContext ctx
136
137	if ary_version != 1:	1✔
138	raise ValueError(("__sycl_usm_array_interface__ is malformed:"	1✔
139	" dict('version': {}) is unexpected."
140	" The only recognized version is 1.").format(	1✔
141	ary_version))	1✔
142	if not ary_data_tuple or len(ary_data_tuple) != 2:	1✔
143	raise ValueError("__sycl_usm_array_interface__ is malformed:"	1✔
144	" 'data' field is required, and must be a tuple"
145	" (usm_pointer, is_writeable_boolean).")
146	arr_data_ptr = <size_t>ary_data_tuple[0]	1✔
147	writeable = 1 if ary_data_tuple[1] else 0	1✔
148	# Check that memory and syclobj are consistent:
149	# (USM pointer is bound to this sycl context)
150	memRef = <DPCTLSyclUSMRef>arr_data_ptr	1✔
151	QRef = get_queue_ref_from_ptr_and_syclobj(memRef, ary_syclobj)	1✔
152	if (QRef is NULL):	1✔
153	raise ValueError("__sycl_usm_array_interface__ is malformed:"	1✔
154	" 'data' field is not consistent with 'syclobj'"
155	" field, the pointer {} is not bound to"
156	" SyclContext derived from"
157	" dict('syclobj': {}).".format(	1✔
158	hex(arr_data_ptr), ary_syclobj))	1✔
159	# shape must be present
160	if ary_shape is None or not (	1✔
161	isinstance(ary_shape, collections.abc.Sized) and	1✔
162	isinstance(ary_shape, collections.abc.Iterable)):	1✔
163	DPCTLQueue_Delete(QRef)	1✔
164	raise ValueError("Shape entry is a required element of "	1✔
165	"`__sycl_usm_array_interface__` dictionary")
166	nd = len(ary_shape)	1✔
167	try:	1✔
168	dt = np.dtype(ary_typestr)	1✔
169	if (dt.hasobject or not (np.issubdtype(dt.type, np.integer) or	1✔
NEW 170	np.issubdtype(dt.type, np.inexact))):	×
171	DPCTLQueue_Delete(QRef)	1✔
172	raise TypeError("Only integer types, floating and complex "	1✔
173	"floating types are supported.")
174	itemsize = <Py_ssize_t> (dt.itemsize)	1✔
175	except TypeError as e:	1✔
176	raise ValueError(	1✔
177	"__sycl_usm_array_interface__ is malformed:"
178	" dict('typestr': {}) is unexpected. ".format(ary_typestr)	1✔
179	) from e	1✔
180
181	if (ary_strides is None or (	1✔
182	isinstance(ary_strides, collections.abc.Sized) and	1✔
183	isinstance(ary_strides, collections.abc.Iterable) and	1✔
184	len(ary_strides) == nd)):	1✔
185	min_disp, nbytes = _pointers_from_shape_and_stride(	1✔
186	nd, ary_shape, itemsize, ary_offset, ary_strides)
187	else:
188	DPCTLQueue_Delete(QRef)	1✔
189	raise ValueError("__sycl_usm_array_interface__ is malformed: "	1✔
190	"'strides' must be a tuple or "
191	"list of the same length as shape")
192
193	buf = _USMBufferData.__new__(_USMBufferData)	1✔
194	buf.p = <DPCTLSyclUSMRef>(	1✔
195	arr_data_ptr + (<Py_ssize_t>min_disp) * itemsize)	1✔
196	buf.writeable = writeable	1✔
197	buf.itemsize = itemsize	1✔
198	buf.nbytes = <Py_ssize_t> nbytes	1✔
199
200	buf.queue = SyclQueue._create(QRef)	1✔
201
202	return buf	1✔

IntelPython / dpctl / 1214133091

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