From c7417b29fcff405d85bf8b16d15f5fe720177603 Mon Sep 17 00:00:00 2001
From: Adam Rutkowski <adam.j.rutkowski@intel.com>
Date: Tue, 29 Sep 2020 16:50:42 +0200
Subject: [PATCH] pyocf: test for io flags propagation to bottom volumes

Signed-off-by: Adam Rutkowski <adam.j.rutkowski@intel.com>
---
 .../functional/tests/engine/test_io_flags.py  | 126 ++++++++++++++++++
 1 file changed, 126 insertions(+)
 create mode 100644 tests/functional/tests/engine/test_io_flags.py

diff --git a/tests/functional/tests/engine/test_io_flags.py b/tests/functional/tests/engine/test_io_flags.py
new file mode 100644
index 0000000..aa19240
--- /dev/null
+++ b/tests/functional/tests/engine/test_io_flags.py
@@ -0,0 +1,126 @@
+#
+# Copyright(c) 2020 Intel Corporation
+# SPDX-License-Identifier: BSD-3-Clause-Clear
+#
+
+from ctypes import c_int, memmove, cast, c_void_p
+from enum import IntEnum
+from itertools import product
+import random
+
+import pytest
+
+from pyocf.types.cache import Cache, CacheMode
+from pyocf.types.core import Core
+from pyocf.types.volume import Volume
+from pyocf.types.data import Data
+from pyocf.types.io import IoDir
+from pyocf.utils import Size
+from pyocf.types.shared import OcfCompletion
+
+
+def __io(io, queue, address, size, data, direction):
+    io.set_data(data, 0)
+    completion = OcfCompletion([("err", c_int)])
+    io.callback = completion.callback
+    io.submit()
+    completion.wait()
+    return int(completion.results["err"])
+
+
+def _io(new_io, queue, address, size, data, offset, direction, flags):
+    io = new_io(queue, address, size, direction, 0, flags)
+    if direction == IoDir.READ:
+        _data = Data.from_bytes(bytes(size))
+    else:
+        _data = Data.from_bytes(data, offset, size)
+    ret = __io(io, queue, address, size, _data, direction)
+    if not ret and direction == IoDir.READ:
+        memmove(cast(data, c_void_p).value + offset, _data.handle, size)
+    return ret
+
+
+def io_to_exp_obj(core, address, size, data, offset, direction, flags):
+    return _io(
+        core.new_io,
+        core.cache.get_default_queue(),
+        address,
+        size,
+        data,
+        offset,
+        direction,
+        flags,
+    )
+
+
+class FlagsValVolume(Volume):
+    def __init__(self, size, flags):
+        self.flags = flags
+        self.check = False
+        self.fail = False
+        super().__init__(size)
+
+    def set_check(self, check):
+        self.check = check
+
+    def submit_io(self, io):
+        if self.check:
+            flags = io.contents._flags
+            if flags != self.flags:
+                self.fail = True
+        super().submit_io(io)
+
+
+@pytest.mark.parametrize("cache_mode", CacheMode)
+def test_io_flags(pyocf_ctx, cache_mode):
+    """
+    Verify that I/O flags provided at the top volume interface
+    are propagated down to bottom volumes for all associated
+    I/Os (including metadata writes to cache volume).
+    """
+
+    flags = 0x239482
+    block_size = 4096
+
+    data = bytes(block_size)
+
+    cache_device = FlagsValVolume(Size.from_MiB(30), flags)
+    core_device = FlagsValVolume(Size.from_MiB(30), flags)
+
+    cache = Cache.start_on_device(cache_device, cache_mode=cache_mode)
+    core = Core.using_device(core_device)
+
+    cache.add_core(core)
+
+    cache_device.set_check(True)
+    core_device.set_check(True)
+
+    # write miss
+    io_to_exp_obj(core, block_size * 0, block_size, data, 0, IoDir.WRITE, flags)
+    assert not cache_device.fail
+    assert not core_device.fail
+
+    # read miss
+    io_to_exp_obj(core, block_size * 1, block_size, data, 0, IoDir.READ, flags)
+    assert not cache_device.fail
+    assert not core_device.fail
+
+    # "dirty" read hit
+    io_to_exp_obj(core, block_size * 0, block_size, data, 0, IoDir.READ, flags)
+    assert not cache_device.fail
+    assert not core_device.fail
+
+    # "clean" read hit
+    io_to_exp_obj(core, block_size * 1, block_size, data, 0, IoDir.READ, flags)
+    assert not cache_device.fail
+    assert not core_device.fail
+
+    # "dirty" write hit
+    io_to_exp_obj(core, block_size * 0, block_size, data, 0, IoDir.WRITE, flags)
+    assert not cache_device.fail
+    assert not core_device.fail
+
+    # "clean" write hit
+    io_to_exp_obj(core, block_size * 1, block_size, data, 0, IoDir.WRITE, flags)
+    assert not cache_device.fail
+    assert not core_device.fail