Feature/memory zero copy #152

oleksandr-pavlyk · 2020-10-21T21:13:10Z

Closes #43, closes #76, closes #45, closes #120.

Work on Memory class and its derivatives.

Classes MemoryUSMShared, MemoryUSMDevice, and MemoryUSMHost constructors allow to specify the number of bytes to allocate, and optionally the queue, or give a Python object expected to implement __sycl_usm_array_interface__ attribute to create the USM memory object pointing the same USM memory with zero copy.

Classes also implement several new features.

Method copy_from_host(pyobj) to copy content of Python object buffer to USM memory
Method copy_to_hist(pyobj=None) to copy content of USM memory to pre-allocated Python object buffer. If object does not implement the buffer protocol, bytearray of the appropriate size is allocated and populated. The method returns the populated object.
Method copy_from_device(sycl_usm_obj) to copy content of USM memory behind Python object that is expected to implement __sycl_usm_array_interface__ to the USM memory of the instance.

Classes are now pickleable, with it being implemented via copying to host and picking that.

@Alexander-Makaryev

oleksandr-pavlyk · 2020-10-22T16:55:59Z

By the way, reconstruction of queue from a pointer and context could proceed as follows:

   if isinstance(syclobj, SyclContext):
        ctx = <SyclContext> syclobj
        dev = DPPLget_pointer_device(data_ptr, ctx)
        new_queue = DPPLqueue_from_device_and_conext(dev, ctx)

oleksandr-pavlyk · 2020-10-22T21:05:36Z

Implement support for aligned memory allocation, exposing DPPL_aligned_alloc_shared and friends.

Changed constructor of MemoryUSMShared to require and new keyword alignment and old one queue be keyword arguments only.

Non-positive alignment values are ignored and malloc_* is silently used instead.

1. Memory class exposes the interface 2. Memory variants constructors can consum objects exposing the said interface, and take over memory zero copy. 3. Class implements memInst.copy_to_host(pyobj=None) If `pyobj` supports Python's buffer protocol, content of USM memory in the instance is copied to the host buffer. Otherwise, bytearray is allocated, populated and returned memInst.copy_from_host(pyobj) Copies buffer of `pyobj` into USM memory of the instance. Raises exception if pyobj is not a byte array memInst.copy_from_device(sycl_usm_obj) Copies USM memory of sycl_usm_obj exposing __sycl_usm_array_interface__ into USM memory of the instance 4. Class is pickleable 5. Class implements tobytes method that produces bytes object populated by the content of USM memory. Methods are currently not releasing GIL, but I think they should.

modularized test, + changes per black

Previously it would always produced shared memory on unpickling.

queue can no longer be specified via positional argument, only through a keyword to allow a user to specify alignment but not queue. SYCL spec says that aligned allocation may return null pointer when the requested alignment is not supported by the device. Non-positive alignments silently go unused (i.e. DPPLmalloc_* is instead of DPPL_aligned_alloc_*)

Added DPPLDevice_AreEq to check if two devices are pointer equal. Used in the test.

…-copy

1. In that case we can avoid making change of reference objects very long. ``` In [1]: import dpctl, dpctl.memory as dpmem In [2]: m = dpmem.MemoryUSMShared(256) In [3]: m2 = dpmem.MemoryUSMShared(m) In [4]: m3 = dpmem.MemoryUSMShared(m2) In [5]: m3.reference_obj is m Out[5]: True In [6]: m2.reference_obj is m Out[6]: True In [7]: m2._pointer Out[7]: 94798596370432 In [8]: m3._pointer Out[8]: 94798596370432 In [9]: m._pointer Out[9]: 94798596370432 ```

1. Removed dpctl.memory 2. Exposed MemoryUSMShared, MemoryUSMDevice, MemoryUSMHost to dpctl 3. When dpctl is cimported MemoryUSMShared, MemoryUSMHost, MemoryUSMDevice and Memory classes are exposed.

Also simplified queue construction from context and device per PR feedback

…r user consumption

Now to access memory objects one does import dpctl import dpctl.memory

oleksandr-pavlyk · 2020-10-27T19:28:04Z

@diptorupd The refactoring is complete. Lapse in logic on L109 of _memory.pyx fixed, Memory help class renamed _Memory, and dpctl._memory moved to dpctl.memory._memory with user-facing dpctl.memory module introduced.

+ formatting changes, + EXPECT_NO_FATAL_FAILURE on prefetch call.

diptorupd

Please take care of the minor formatting stuff and then merge.

backends/include/dppl_sycl_usm_interface.h

backends/source/dppl_sycl_platform_interface.cpp

backends/source/dppl_sycl_queue_interface.cpp

backends/source/dppl_sycl_queue_manager.cpp

oleksandr-pavlyk · 2020-10-27T23:34:43Z

Windows build failure in CI is not related to changes in this PR at all - test environment fails to activate.

I was able to build the package on Windows manually, and test suite run was clean.

…terType

oleksandr-pavlyk requested review from PokhodenkoSA and diptorupd October 21, 2020 21:13

oleksandr-pavlyk force-pushed the feature/memory-zero-copy branch 2 times, most recently from 9eaf8a5 to d6e6483 Compare October 21, 2020 21:47

diptorupd mentioned this pull request Oct 22, 2020

Memory manager features #129

Closed

4 tasks

oleksandr-pavlyk mentioned this pull request Oct 22, 2020

Change funcs to cpdef #150

Merged

oleksandr-pavlyk force-pushed the feature/memory-zero-copy branch from c261e9a to bd9f1f1 Compare October 22, 2020 14:42

oleksandr-pavlyk force-pushed the feature/memory-zero-copy branch 2 times, most recently from 75690ba to bc861ab Compare October 22, 2020 21:02

oleksandr-pavlyk force-pushed the feature/memory-zero-copy branch 2 times, most recently from 2c07fab to 0a8da06 Compare October 23, 2020 18:37

oleksandr-pavlyk added 11 commits October 23, 2020 13:55

added memory.py to expose dpclt.memory module

906d77b

modularized test, + changes per black

Pickling should preserve type of Python object

dfc0ac8

Previously it would always produced shared memory on unpickling.

Added comment, fixed black madness

eaf8574

Added DPPLaligned_alloc_* functions to backend

63b9b07

Added DPPLQueue_Prefetch and DPPLQueue_MemAdvise

5df0bf6

Implemented SyclQueue.prefetch, SyclQueue.mem_advise

e46f6ff

use numpy buffer as intermediary in copy_via_host routine

5a2bcf4

added DPPLUSM_GetPointerDevice

242eb3a

Introduced tests/test_sycl_usm_interface.cpp

cebc064

Added DPPLDevice_AreEq to check if two devices are pointer equal. Used in the test.

oleksandr-pavlyk force-pushed the feature/memory-zero-copy branch from 0a8da06 to cebc064 Compare October 23, 2020 18:57

oleksandr-pavlyk added 5 commits October 23, 2020 14:35

implemented cdef Memory.get_pointer_device

2f6a01c

Merge remote-tracking branch 'origin/master' into feature/memory-zero…

9dbe493

…-copy

Implements #120

f3d1899

1. Removed dpctl.memory 2. Exposed MemoryUSMShared, MemoryUSMDevice, MemoryUSMHost to dpctl 3. When dpctl is cimported MemoryUSMShared, MemoryUSMHost, MemoryUSMDevice and Memory classes are exposed.

corrected __dppl_take -> __dppl_keep in Memcpy

f977746

oleksandr-pavlyk added 7 commits October 26, 2020 17:40

deleted obsolete FIXME comment, added explanation for what the code does

e73c817

formatting change

7b41388

Fixed syntax error in test_sycl_usm_interface.h

efe65c4

Also simplified queue construction from context and device per PR feedback

fixed reference to filename in comment headers

1b3c7e4

Fixed a lapse in validation logic of __sycl_usm_array_interface__`.

50e8503

Renamed Memory class to _Memor yto reflect that it is not intended fo…

3b06ba8

…r user consumption

Moved _memory.pyx, _memory.pxd to dpctl.memory submodule

9cd6bd8

Now to access memory objects one does import dpctl import dpctl.memory

oleksandr-pavlyk added 2 commits October 27, 2020 15:08

formatting changes per review

1da34fc

Delete context in common_test_body

8f634ec

+ formatting changes, + EXPECT_NO_FATAL_FAILURE on prefetch call.

diptorupd approved these changes Oct 27, 2020

View reviewed changes

oleksandr-pavlyk added 3 commits October 27, 2020 15:28

formating: func (args) -> func(args)

ca6dcfb

added MemoryUSM* work to changelog

62dcdd2

changes for CI's black to lighten up

692cb41

oleksandr-pavlyk mentioned this pull request Oct 27, 2020

Move _memory submodule directly under dpctl #120

Closed

oleksandr-pavlyk added 4 commits October 28, 2020 06:53

skip test_sycl_usm_array_interface for Host memory on windows

a7d6356

with black around, forecast is overcast

a7ba748

Adjusted path in bld.bat

c5a31f5

filled in description for @param CRef in doxygen comments for GetPoin…

948a67b

…terType

oleksandr-pavlyk force-pushed the feature/memory-zero-copy branch from 0a66066 to 948a67b Compare October 28, 2020 11:54

oleksandr-pavlyk added 4 commits October 28, 2020 12:24

Work on build_for_develop.bat to bring it on par with Linux shell script

e654c1f

fixed type in GTEST_INCLUDE

b7fdc53

further changes to build_for_devel.bat - fixed typo

a05327d

fixed dpcpp compilation warning on Windows

6d7375e

oleksandr-pavlyk force-pushed the feature/memory-zero-copy branch from 431dc12 to 6d7375e Compare October 28, 2020 20:18

oleksandr-pavlyk merged commit 94268cb into master Oct 28, 2020

diptorupd mentioned this pull request Oct 29, 2020

Windows CI is broken #157

Closed

oleksandr-pavlyk mentioned this pull request Oct 29, 2020

MemoryUSMxxx classes should provide a factory function to copy data between incompatible device #54

Closed

oleksandr-pavlyk deleted the feature/memory-zero-copy branch October 30, 2020 17:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Feature/memory zero copy #152

Feature/memory zero copy #152

Uh oh!

oleksandr-pavlyk commented Oct 21, 2020 •

edited

Loading

Uh oh!

oleksandr-pavlyk commented Oct 22, 2020

Uh oh!

oleksandr-pavlyk commented Oct 22, 2020

Uh oh!

oleksandr-pavlyk commented Oct 27, 2020

Uh oh!

diptorupd left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oleksandr-pavlyk commented Oct 27, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Feature/memory zero copy #152

Feature/memory zero copy #152

Uh oh!

Conversation

oleksandr-pavlyk commented Oct 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

oleksandr-pavlyk commented Oct 22, 2020

Uh oh!

oleksandr-pavlyk commented Oct 22, 2020

Uh oh!

oleksandr-pavlyk commented Oct 27, 2020

Uh oh!

diptorupd left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oleksandr-pavlyk commented Oct 27, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

oleksandr-pavlyk commented Oct 21, 2020 •

edited

Loading