Add kernel and kernel writer skeletons

* Add the skeleton for kernel, kernel writer and their respective
  OpenCL implementation.
* Add method to write code comment and its test.

Resolves: COMPMID-6343
Signed-off-by: Viet-Hoa Do <viet-hoa.do@arm.com>
Change-Id: Ib986228154f7a00da7a5fd3b7105941325fe13b1
Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/9889
Tested-by: Arm Jenkins <bsgcomp@arm.com>
Reviewed-by: Gunes Bayir <gunes.bayir@arm.com>
Comments-Addressed: Arm Jenkins <bsgcomp@arm.com>
Benchmark: Arm Jenkins <bsgcomp@arm.com>

3 files changed, 163 insertions, 0 deletions

diff --git a/compute_kernel_writer/validation/Validation.cpp b/compute_kernel_writer/validation/Validation.cpp
index 16c0d7696d..c0bdaaa0dc 100644
--- a/compute_kernel_writer/validation/Validation.cpp
+++ b/compute_kernel_writer/validation/Validation.cpp
@@ -26,6 +26,7 @@
 #include "tests/CLTileTest.hpp"
 #include "tests/TensorBitMaskTest.hpp"
 #include "tests/UtilsTest.hpp"
+#include "tests/CLKernelWriterTest.h"
 
 #include <memory>
 #include <vector>
@@ -59,6 +60,7 @@ int32_t main()
     const auto test12 = std::make_unique<CLConstantTileAccessScalarVariableBroadcastYTest>();
     const auto test13 = std::make_unique<CLConstantTileAccessVectorVariablesTest>();
     const auto test14 = std::make_unique<CLConstantTileAccessSubVectorVariablesTest>();
+    const auto test15 = std::make_unique<CLKernelWriterCommentTest>();
 
     tests.push_back(test3.get());
     tests.push_back(test4.get());
@@ -72,6 +74,7 @@ int32_t main()
     tests.push_back(test12.get());
     tests.push_back(test13.get());
     tests.push_back(test14.get());
+    tests.push_back(test15.get());
 #endif /* COMPUTE_KERNEL_WRITER_OPENCL_ENABLED */
 
     bool all_test_passed = true;
diff --git a/compute_kernel_writer/validation/tests/CLKernelWriterTest.h b/compute_kernel_writer/validation/tests/CLKernelWriterTest.h
new file mode 100644
index 0000000000..ff09ea8073
--- /dev/null
+++ b/compute_kernel_writer/validation/tests/CLKernelWriterTest.h
@@ -0,0 +1,70 @@
+/*
+ * 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_CLKERNELTEST_H
+#define CKW_VALIDATION_TESTS_CLKERNELTEST_H
+
+#include "src/cl/CLKernelWriter.h"
+#include "validation/tests/common/Common.h"
+#include "validation/tests/common/KernelWriterInterceptor.h"
+
+namespace ckw
+{
+
+class CLKernelWriterCommentTest : public ITest
+{
+public:
+    CLKernelWriterCommentTest()
+    {
+    }
+
+    bool run() override
+    {
+        bool all_tests_passed = true;
+
+        KernelWriterInterceptor<CLKernelWriter> writer;
+
+        writer.comment("previous code");
+
+        writer.start_capture_code();
+
+        writer.comment("code under test 0");
+        writer.comment("code under test 1");
+
+        constexpr auto expected_code = "// code under test 0\n// code under test 1\n";
+
+        VALIDATE_TEST(writer.check_added_code(expected_code), all_tests_passed, 0);
+
+        return all_tests_passed;
+    }
+
+    std::string name() override
+    {
+        return "CLKernelWriterCommentTest";
+    }
+};
+
+} // namespace ckw
+
+#endif // CKW_VALIDATION_TESTS_CLKERNELTEST_H
diff --git a/compute_kernel_writer/validation/tests/common/KernelWriterInterceptor.h b/compute_kernel_writer/validation/tests/common/KernelWriterInterceptor.h
new file mode 100644
index 0000000000..89bb76e37f
--- /dev/null
+++ b/compute_kernel_writer/validation/tests/common/KernelWriterInterceptor.h
@@ -0,0 +1,90 @@
+/*
+ * 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_COMMON_KERNELWRITERINTERCEPTOR_H
+#define CKW_VALIDATION_TESTS_COMMON_KERNELWRITERINTERCEPTOR_H
+
+#include <string>
+#include <utility>
+
+namespace ckw
+{
+
+/** This class provides the ability to capture only the code changed after a point
+ * and compares that part of code with the expected value.
+ *
+ * It is useful for testing purpose when a particular sequence of instructions is interested
+ * while the rest of the initialization code is out of scope.
+ */
+template <typename T>
+class KernelWriterInterceptor : public T
+{
+public:
+    template <typename... TArgs>
+    KernelWriterInterceptor(const TArgs &&...args)
+        : T(std::forward<TArgs>(args)...)
+    {
+    }
+
+    /** Mark this point in the source code as the start position to capture.
+     * Only source code added after this function is considered when check_add_code is called.
+     */
+    void start_capture_code()
+    {
+        _start_code = this->body_source_code();
+    }
+
+    /** Compare the source code added after start_capture_code is called the the specified expected code. */
+    bool check_added_code(const std::string &expected_added_code)
+    {
+        const auto &end_code = this->body_source_code();
+
+        // Code can only grow over time.
+        if(end_code.length() < _start_code.length())
+        {
+            return false;
+        }
+
+        // New code must be added to the source code without changing the already existed code.
+        if(end_code.substr(0, _start_code.length()) != _start_code)
+        {
+            return false;
+        }
+
+        // The newly added code must match the expected value.
+        if(end_code.substr(_start_code.length(), end_code.length() - _start_code.length()) != expected_added_code)
+        {
+            return false;
+        }
+
+        return true;
+    }
+
+private:
+    std::string _start_code{};
+};
+
+} // namespace ckw
+
+#endif // CKW_VALIDATION_TESTS_COMMON_KERNELWRITERINTERCEPTOR_H