bounce_buffer_free

python/kvikio/kvikio/_lib/buffer.pyx

@@ -31,5 +31,5 @@ cdef extern from "<kvikio/bounce_buffer.hpp>" nogil:
     size_t cpp_alloc_retain_clear "kvikio::AllocRetain::instance().clear"() except +
 
 
-def bounce_buffer_clear() -> int:
+def bounce_buffer_free() -> int:
     return cpp_alloc_retain_clear()

python/kvikio/kvikio/buffer.py

@@ -31,5 +31,11 @@ def memory_deregister(buf) -> None:
     buffer.memory_deregister(buf)
 
 
-def bounce_buffer_clear() -> int:
-    return buffer.bounce_buffer_clear()
+def bounce_buffer_free() -> int:
+    """Free the host allocations used as bounce buffers.
+
+    Returns
+    -------
+    Number of bytes freed.
+    """
+    return buffer.bounce_buffer_free()

python/kvikio/tests/test_basic_io.py

@@ -276,20 +276,20 @@ def test_different_bounce_buffer_sizes(tmp_path, size, tasksize, buffer_size):
                     cupy.testing.assert_array_equal(a, b)
 
 
-def test_bounce_buffer_clear(tmp_path):
-    """Test clearing the bounce buffer"""
+def test_bounce_buffer_free(tmp_path):
+    """Test freeing the bounce buffer allocations"""
     filename = tmp_path / "test-file"
-    kvikio.buffer.bounce_buffer_clear()
+    kvikio.buffer.bounce_buffer_free()
     with kvikio.defaults.set_compat_mode(True), kvikio.defaults.set_num_threads(1):
         with kvikio.CuFile(filename, "w") as f:
             with kvikio.defaults.set_bounce_buffer_size(1024):
                 # Notice, since the bounce buffer size is only checked when the buffer
                 # is used, we populate the bounce buffer in between we clear it.
                 f.write(cupy.arange(10))
-                assert kvikio.buffer.bounce_buffer_clear() == 1024
-                assert kvikio.buffer.bounce_buffer_clear() == 0
+                assert kvikio.buffer.bounce_buffer_free() == 1024
+                assert kvikio.buffer.bounce_buffer_free() == 0
                 f.write(cupy.arange(10))
             with kvikio.defaults.set_bounce_buffer_size(2048):
                 f.write(cupy.arange(10))
-                assert kvikio.buffer.bounce_buffer_clear() == 2048
-                assert kvikio.buffer.bounce_buffer_clear() == 0
+                assert kvikio.buffer.bounce_buffer_free() == 2048
+                assert kvikio.buffer.bounce_buffer_free() == 0