Unit tests (test/test_enqueue_copy.py) for _enqueue_read_buffer_rect,...

Unit tests (test/test_enqueue_copy.py) for _enqueue_read_buffer_rect, _enqueue_write_buffer_rect and _enqueue_copy_buffer_rect.

test/test_enqueue_copy.py

+#! /usr/bin/env python
+from __future__ import division, with_statement, absolute_import, print_function
+
+__copyright__ = "Copyright (C) 2016 Shane J. Latham"
+
+__license__ = """
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+"""
+
+import numpy as np
+import numpy.random
+
+import unittest
+import pyopencl as cl
+
+def generate_slice(start, shape):
+    return tuple([slice(start[i], start[i]+shape[i]) for i in range(len(start))])
+
+class EnqueueCopyRectTest(unittest.TestCase):
+    """
+    Tests to/from device copy of sub-arrays.
+    """
+    
+    def setUp(self):
+        """
+        Initialise context and command-queue.
+        """
+        self.context = cl.create_some_context(interactive=False)
+        self.queue = cl.CommandQueue(self.context)
+        
+    def test2d(self):
+        """
+        Test 2D sub-array (slice) copy.
+        """
+        ary_in_shp = 256, 128  # Entire array shape from which sub-array copied to device
+        sub_ary_shp = 128, 96  # Sub-array shape to be copied to device
+        ary_in_origin = 20,13  # Sub-array origin
+        ary_in_slice = generate_slice(ary_in_origin, sub_ary_shp)
+        
+        ary_out_origin = 11,19 # Origin of sub-array copy from device to host-array
+        ary_out_shp = 512, 256 # Entire host-array shape copy sub-array from device to host
+        ary_out_slice = generate_slice(ary_out_origin, sub_ary_shp)
+        
+        buf_in_origin = 7,3 # Origin of sub-array in device buffer
+        buf_in_shp = 300, 200 # shape of device buffer
+
+        buf_out_origin = 31,17 # Origin of 2nd device buffer
+        buf_out_shp = 300, 400 # shape of 2nd device buffer
+
+        # Create host array of random values.
+        h_ary_in = \
+            np.array(
+                np.random.randint(
+                    0,
+                    256,
+                    np.product(ary_in_shp)
+                ),
+                dtype=np.uint8
+            ).reshape(ary_in_shp)
+        
+        # Create device buffers
+        d_in_buf = cl.Buffer(self.context, cl.mem_flags.READ_ONLY, size=np.product(buf_in_shp))
+        d_out_buf = cl.Buffer(self.context, cl.mem_flags.READ_ONLY, size=np.product(buf_out_shp))
+
+        # Copy sub-array (rectangular buffer) from host to device
+        cl.enqueue_copy(
+            self.queue,
+            d_in_buf,
+            h_ary_in,
+            buffer_origin=buf_in_origin[::-1],
+            host_origin=ary_in_origin[::-1],
+            region=sub_ary_shp[::-1],
+            buffer_pitches = (buf_in_shp[-1],),
+            host_pitches = (ary_in_shp[-1],)
+        )
+        # Copy sub-array (rectangular buffer) from device-buffer to device-buffer
+        cl.enqueue_copy(
+            self.queue,
+            d_out_buf,
+            d_in_buf,
+            src_origin=buf_in_origin[::-1],
+            dst_origin=buf_out_origin[::-1],
+            region=sub_ary_shp[::-1],
+            src_pitches = (buf_in_shp[-1],),
+            dst_pitches = (buf_out_shp[-1],)
+        )
+
+        # Create zero-initialised array to receive sub-array from device
+        h_ary_out = np.zeros(ary_out_shp, dtype=h_ary_in.dtype)
+
+        # Copy sub-array (rectangular buffer) from device to host-array. 
+        cl.enqueue_copy(
+            self.queue,
+            h_ary_out,
+            d_out_buf,
+            buffer_origin=buf_out_origin[::-1],
+            host_origin=ary_out_origin[::-1],
+            region=sub_ary_shp[::-1],
+            buffer_pitches = (buf_out_shp[-1],),
+            host_pitches = (ary_out_shp[-1],)
+        )
+        self.queue.finish()
+        
+        # Check that the sub-array copied to device is
+        # the same as the sub-array received from device.
+        self.assertTrue(
+            np.all(h_ary_in[ary_in_slice] == h_ary_out[ary_out_slice])
+        )
+
+    def test3d(self):
+        """
+        Test 3D sub-array (slice) copy.
+        """
+        ary_in_shp = 256, 128, 31  # Entire array shape from which sub-array copied to device
+        sub_ary_shp = 128, 96, 20  # Sub-array shape to be copied to device
+        ary_in_origin = 20,13, 7  # Sub-array origin
+        ary_in_slice = generate_slice(ary_in_origin, sub_ary_shp)
+        
+        ary_out_origin = 11,19, 14 # Origin of sub-array copy from device to host-array
+        ary_out_shp = 192, 256, 128 # Entire host-array shape copy sub-array from device to host
+        ary_out_slice = generate_slice(ary_out_origin, sub_ary_shp)
+        
+        buf_in_origin = 7, 3, 6 # Origin of sub-array in device buffer
+        buf_in_shp = 300, 200, 30 # shape of device buffer
+
+        buf_out_origin = 31,17,3 # Origin of 2nd device buffer
+        buf_out_shp = 300, 400, 40 # shape of 2nd device buffer
+
+        # Create host array of random values.
+        h_ary_in = \
+            np.array(
+                np.random.randint(
+                    0,
+                    256,
+                    np.product(ary_in_shp)
+                ),
+                dtype=np.uint8
+            ).reshape(ary_in_shp)
+        
+        # Create device buffers
+        d_in_buf = cl.Buffer(self.context, cl.mem_flags.READ_ONLY, size=np.product(buf_in_shp))
+        d_out_buf = cl.Buffer(self.context, cl.mem_flags.READ_ONLY, size=np.product(buf_out_shp))
+
+        # Copy sub-array (rectangular buffer) from host to device
+        cl.enqueue_copy(
+            self.queue,
+            d_in_buf,
+            h_ary_in,
+            buffer_origin=buf_in_origin[::-1],
+            host_origin=ary_in_origin[::-1],
+            region=sub_ary_shp[::-1],
+            buffer_pitches = (buf_in_shp[-1],buf_in_shp[-1]*buf_in_shp[-2]),
+            host_pitches = (ary_in_shp[-1],ary_in_shp[-1]*ary_in_shp[-2])
+        )
+        # Copy sub-array (rectangular buffer) from device-buffer to device-buffer
+        cl.enqueue_copy(
+            self.queue,
+            d_out_buf,
+            d_in_buf,
+            src_origin=buf_in_origin[::-1],
+            dst_origin=buf_out_origin[::-1],
+            region=sub_ary_shp[::-1],
+            src_pitches = (buf_in_shp[-1],buf_in_shp[-1]*buf_in_shp[-2]),
+            dst_pitches = (buf_out_shp[-1],buf_out_shp[-1]*buf_out_shp[-2])
+        )
+
+        # Create zero-initialised array to receive sub-array from device
+        h_ary_out = np.zeros(ary_out_shp, dtype=h_ary_in.dtype)
+
+        # Copy sub-array (rectangular buffer) from device to host-array. 
+        cl.enqueue_copy(
+            self.queue,
+            h_ary_out,
+            d_out_buf,
+            buffer_origin=buf_out_origin[::-1],
+            host_origin=ary_out_origin[::-1],
+            region=sub_ary_shp[::-1],
+            buffer_pitches = (buf_out_shp[-1],buf_out_shp[-1]*buf_out_shp[-2]),
+            host_pitches = (ary_out_shp[-1],ary_out_shp[-1]*ary_out_shp[-2])
+        )
+        self.queue.finish()
+        
+        # Check that the sub-array copied to device is
+        # the same as the sub-array received from device.
+        self.assertTrue(
+            np.all(h_ary_in[ary_in_slice] == h_ary_out[ary_out_slice])
+        )
+
+if __name__ == "__main__":
+    unittest.main()