Add CKW flow control writing methods

* Structures: if/else/else if, for, return.
* Add corresponding tests.

Partially resolves: COMPMID-6387
Signed-off-by: Viet-Hoa Do <viet-hoa.do@arm.com>
Change-Id: I2912ccaf46f836907f21bb53fa82bcc1f48dd224
Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/10199
Tested-by: Arm Jenkins <bsgcomp@arm.com>
Reviewed-by: SiCong Li <sicong.li@arm.com>
Reviewed-by: Gunes Bayir <gunes.bayir@arm.com>
Comments-Addressed: Arm Jenkins <bsgcomp@arm.com>
Benchmark: Arm Jenkins <bsgcomp@arm.com>

4 files changed, 336 insertions, 0 deletions

diff --git a/compute_kernel_writer/validation/Validation.cpp b/compute_kernel_writer/validation/Validation.cpp
index 3d73900c90..6425d25f2b 100644
--- a/compute_kernel_writer/validation/Validation.cpp
+++ b/compute_kernel_writer/validation/Validation.cpp
@@ -30,7 +30,10 @@
 #include "validation/tests/CLKernelWriterDeclareConstantTileTest.h"
 #include "validation/tests/CLKernelWriterDeclareTensorTest.h"
 #include "validation/tests/CLKernelWriterDeclareTileTest.h"
+#include "validation/tests/CLKernelWriterForTest.h"
+#include "validation/tests/CLKernelWriterIfTest.h"
 #include "validation/tests/CLKernelWriterOpLoadStoreTest.h"
+#include "validation/tests/CLKernelWriterReturnTest.h"
 #include "validation/tests/CLKernelWriterTernaryOpTest.h"
 #include "validation/tests/CLKernelWriterUnaryExpressionTest.h"
 #include "validation/tests/CLTensorArgumentTest.h"
@@ -89,6 +92,9 @@ int32_t main()
     const auto test29 = std::make_unique<CLKernelWriterBinaryOpTest>();
     const auto test30 = std::make_unique<CLKernelWriterTernaryOpTest>();
     const auto test31 = std::make_unique<CLKernelWriterDeclareConstantTileTest>();
+    const auto test32 = std::make_unique<CLKernelWriterIfTest>();
+    const auto test33 = std::make_unique<CLKernelWriterForTest>();
+    const auto test34 = std::make_unique<CLKernelWriterReturnTest>();
 
     tests.push_back(test3.get());
     tests.push_back(test4.get());
@@ -121,6 +127,9 @@ int32_t main()
     tests.push_back(test29.get());
     tests.push_back(test30.get());
     tests.push_back(test31.get());
+    tests.push_back(test32.get());
+    tests.push_back(test33.get());
+    tests.push_back(test34.get());
 #endif /* COMPUTE_KERNEL_WRITER_OPENCL_ENABLED */
 
     bool all_test_passed = true;
diff --git a/compute_kernel_writer/validation/tests/CLKernelWriterForTest.h b/compute_kernel_writer/validation/tests/CLKernelWriterForTest.h
new file mode 100644
index 0000000000..beb39966b2
--- /dev/null
+++ b/compute_kernel_writer/validation/tests/CLKernelWriterForTest.h
@@ -0,0 +1,85 @@
+/*
+ * Copyright (c) 2023 Arm Limited.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * 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.
+ */
+
+#ifndef CKW_VALIDATION_TESTS_CLKERNELWRITERFORTEST_H
+#define CKW_VALIDATION_TESTS_CLKERNELWRITERFORTEST_H
+
+#include "ckw/Error.h"
+#include "ckw/TileInfo.h"
+#include "ckw/types/Operators.h"
+#include "src/cl/CLKernelWriter.h"
+#include "validation/tests/common/Common.h"
+#include "validation/tests/common/KernelWriterInterceptor.h"
+
+namespace ckw
+{
+
+class CLKernelWriterForTest : public ITest
+{
+public:
+    CLKernelWriterForTest()
+    {
+    }
+
+    bool run() override
+    {
+        bool all_tests_passed = true;
+
+        KernelWriterInterceptor<CLKernelWriter> writer;
+
+        auto idx   = writer.declare_tile("idx", TileInfo(DataType::Int32, 1, 1));
+        auto len   = writer.declare_tile("len", TileInfo(DataType::Int32, 1, 1));
+        auto addr  = writer.declare_tile("addr", TileInfo(DataType::Int32, 1, 1));
+        auto esize = writer.declare_tile("esize", TileInfo(DataType::Int32, 1, 1));
+
+        writer.start_capture_code();
+
+        writer.op_for_loop(
+            idx, BinaryOp::Less, len, addr, AssignmentOp::Increment, esize,
+            [&]()
+            {
+                auto tile = writer.declare_tile("tile", TileInfo(DataType::Fp32, 1, 3));
+                CKW_UNUSED(tile);
+            });
+
+        constexpr auto expected_code =
+            "for (; G0__idx < G0__len; G0__addr += G0__esize)\n"
+            "{\n"
+            "float3 G1__tile;\n"
+            "}\n";
+
+        VALIDATE_TEST(writer.check_added_code(expected_code), all_tests_passed, 0);
+
+        return all_tests_passed;
+    }
+
+    std::string name() override
+    {
+        return "CLKernelWriterForTest";
+    }
+};
+
+} // namespace ckw
+
+#endif // CKW_VALIDATION_TESTS_CLKERNELWRITERFORTEST_H
diff --git a/compute_kernel_writer/validation/tests/CLKernelWriterIfTest.h b/compute_kernel_writer/validation/tests/CLKernelWriterIfTest.h
new file mode 100644
index 0000000000..3964bd76d4
--- /dev/null
+++ b/compute_kernel_writer/validation/tests/CLKernelWriterIfTest.h
@@ -0,0 +1,175 @@
+/*
+ * Copyright (c) 2023 Arm Limited.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * 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.
+ */
+
+#ifndef CKW_VALIDATION_TESTS_CLKERNELWRITERIFTEST_H
+#define CKW_VALIDATION_TESTS_CLKERNELWRITERIFTEST_H
+
+#include "ckw/Error.h"
+#include "ckw/TileInfo.h"
+#include "src/cl/CLKernelWriter.h"
+#include "validation/tests/common/Common.h"
+#include "validation/tests/common/KernelWriterInterceptor.h"
+
+#include <cstdint>
+
+namespace ckw
+{
+
+class CLKernelWriterIfTest : public ITest
+{
+public:
+    CLKernelWriterIfTest()
+    {
+    }
+
+    bool run() override
+    {
+        int32_t test_no          = 0;
+        bool    all_tests_passed = true;
+
+        KernelWriterInterceptor<CLKernelWriter> writer;
+
+        auto lhs = writer.declare_tile("lhs", TileInfo(DataType::Fp32, 1, 1));
+        auto rhs = writer.declare_tile("rhs", TileInfo(DataType::Fp32, 1, 1));
+
+        // The first if block.
+        {
+            writer.start_capture_code();
+
+            writer.op_if(
+                lhs, BinaryOp::Equal, rhs,
+                [&]()
+                {
+                    auto tile = writer.declare_tile("tile", TileInfo(DataType::Fp16, 2, 3));
+                    CKW_UNUSED(tile);
+                });
+
+            constexpr auto expected_code =
+                "if (G0__lhs == G0__rhs)\n"
+                "{\n"
+                "half3 G1__tile__0;\n"
+                "half3 G1__tile__1;\n"
+                "}\n";
+
+            VALIDATE_TEST(writer.check_added_code(expected_code), all_tests_passed, test_no++);
+        }
+
+        // The second if block - The ID space inside the if block should change.
+        {
+            writer.start_capture_code();
+
+            writer.op_if(
+                lhs, BinaryOp::Equal, rhs,
+                [&]()
+                {
+                    auto tile = writer.declare_tile("tile", TileInfo(DataType::Fp16, 2, 3));
+                    CKW_UNUSED(tile);
+                });
+
+            constexpr auto expected_code =
+                "if (G0__lhs == G0__rhs)\n"
+                "{\n"
+                "half3 G2__tile__0;\n"
+                "half3 G2__tile__1;\n"
+                "}\n";
+
+            VALIDATE_TEST(writer.check_added_code(expected_code), all_tests_passed, test_no++);
+        }
+
+        // The if-else block - The ID space in each block should change.
+        {
+            writer.start_capture_code();
+
+            writer.op_if(
+                lhs, BinaryOp::Equal, rhs,
+                [&]()
+                {
+                    auto tile = writer.declare_tile("tile", TileInfo(DataType::Fp16, 2, 3));
+                    CKW_UNUSED(tile);
+                });
+            writer.op_else(
+                [&]()
+                {
+                    auto tile = writer.declare_tile("tile", TileInfo(DataType::Uint8, 1, 4));
+                    CKW_UNUSED(tile);
+                });
+
+            constexpr auto expected_code =
+                "if (G0__lhs == G0__rhs)\n"
+                "{\n"
+                "half3 G3__tile__0;\n"
+                "half3 G3__tile__1;\n"
+                "}\n"
+                "else\n"
+                "{\n"
+                "uchar4 G4__tile;\n"
+                "}\n";
+
+            VALIDATE_TEST(writer.check_added_code(expected_code), all_tests_passed, test_no++);
+        }
+
+        // If-else if block.
+        {
+            writer.start_capture_code();
+
+            writer.op_if(
+                lhs, BinaryOp::Equal, rhs,
+                [&]()
+                {
+                    auto tile = writer.declare_tile("tile", TileInfo(DataType::Fp32, 1, 3));
+                    CKW_UNUSED(tile);
+                });
+            writer.op_else_if(
+                lhs, BinaryOp::Less, rhs,
+                [&]()
+                {
+                    auto tile = writer.declare_tile("tile", TileInfo(DataType::Int8, 1, 4));
+                    CKW_UNUSED(tile);
+                });
+
+            constexpr auto expected_code =
+                "if (G0__lhs == G0__rhs)\n"
+                "{\n"
+                "float3 G5__tile;\n"
+                "}\n"
+                "else if (G0__lhs < G0__rhs)\n"
+                "{\n"
+                "char4 G6__tile;\n"
+                "}\n";
+
+            VALIDATE_TEST(writer.check_added_code(expected_code), all_tests_passed, test_no++);
+        }
+
+        return all_tests_passed;
+    }
+
+    std::string name() override
+    {
+        return "CLKernelWriterIfTest";
+    }
+};
+
+} // namespace ckw
+
+#endif // CKW_VALIDATION_TESTS_CLKERNELWRITERIFTEST_H
diff --git a/compute_kernel_writer/validation/tests/CLKernelWriterReturnTest.h b/compute_kernel_writer/validation/tests/CLKernelWriterReturnTest.h
new file mode 100644
index 0000000000..fc3f2a639b
--- /dev/null
+++ b/compute_kernel_writer/validation/tests/CLKernelWriterReturnTest.h
@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) 2023 Arm Limited.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * 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.
+ */
+
+#ifndef CKW_VALIDATION_TESTS_CLKERNELWRITERRETURNTEST_H
+#define CKW_VALIDATION_TESTS_CLKERNELWRITERRETURNTEST_H
+
+#include "src/cl/CLKernelWriter.h"
+#include "validation/tests/common/Common.h"
+#include "validation/tests/common/KernelWriterInterceptor.h"
+
+namespace ckw
+{
+
+class CLKernelWriterReturnTest : public ITest
+{
+public:
+    CLKernelWriterReturnTest()
+    {
+    }
+
+    bool run() override
+    {
+        bool all_tests_passed = true;
+
+        KernelWriterInterceptor<CLKernelWriter> writer;
+
+        writer.start_capture_code();
+
+        writer.op_return();
+
+        constexpr auto expected_code = "return;\n";
+
+        VALIDATE_TEST(writer.check_added_code(expected_code), all_tests_passed, 0);
+
+        return all_tests_passed;
+    }
+
+    std::string name() override
+    {
+        return "CLKernelWriterReturnTest";
+    }
+};
+
+} // namespace ckw
+
+#endif // CKW_VALIDATION_TESTS_CLKERNELWRITERRETURNTEST_H