COMPMID-971: Created validate_examples for MPG

They wanted some SGEMM test with validation and benchmarking capabilities which can be configured at runtime, so I created a mix of example + validation framework.
This is really hacky and therefore won't be released as part of the library, but it seems to work.

Change-Id: I7e7728e1f5c6619c0f0d7c83106c85676d2ffc62
Reviewed-on: https://eu-gerrit-1.euhpc.arm.com/123706
Reviewed-by: Gian Marco Iodice <gianmarco.iodice@arm.com>
Tested-by: Jenkins <bsgcomp@arm.com>

5 files changed, 489 insertions, 5 deletions

diff --git a/tests/SConscript b/tests/SConscript
index 9f6392653c..f6fe49ad1d 100644
--- a/tests/SConscript
+++ b/tests/SConscript
@@ -31,6 +31,7 @@ SConscript('./framework/SConscript', duplicate=0)
 variables = [
     #FIXME: Remove before release!
     BoolVariable("benchmark_examples", "Build benchmark examples programs", True),
+    BoolVariable("validate_examples", "Build benchmark examples programs", True),
     #FIXME Switch the following two options to False before releasing
     BoolVariable("validation_tests", "Build validation test programs", True),
     BoolVariable("benchmark_tests", "Build benchmark test programs", True),
@@ -79,13 +80,13 @@ common_files = Glob('*.cpp')
 common_objects = [test_env.StaticObject(f) for f in common_files]
 
 files_benchmark = Glob('benchmark/*.cpp')
-files_validation = Glob('validation/*.cpp')
+files_validation_framework = [test_env.Object(f) for f in Glob('validation/*.cpp')]
 
 # Always compile reference for validation
-files_validation += Glob('validation/reference/*.cpp')
+files_validation_framework += [ test_env.Object(f) for f in Glob('validation/reference/*.cpp')]
 
 # Add unit tests
-files_validation += Glob('validation/UNIT/*/*.cpp')
+files_validation = Glob('validation/UNIT/*/*.cpp')
 files_validation += Glob('validation/UNIT/*.cpp')
 
 # Add CPP tests
@@ -153,7 +154,7 @@ if test_env['benchmark_tests']:
     Export('arm_compute_benchmark')
 
 if test_env['validation_tests']:
-    arm_compute_validation = test_env.Program('arm_compute_validation', files_validation + common_objects)
+    arm_compute_validation = test_env.Program('arm_compute_validation', files_validation_framework + files_validation + common_objects)
     Depends(arm_compute_validation, arm_compute_test_framework)
     Depends(arm_compute_validation, arm_compute_lib)
 
@@ -166,6 +167,49 @@ if test_env['validation_tests']:
     Default(arm_compute_validation)
     Export('arm_compute_validation')
 
+    #FIXME: Remove before release!
+    if test_env['validate_examples']:
+        files_validate_examples = [ test_env.Object('validate_examples/RunExample.cpp') ] + files_validation_framework + [ x for x in common_objects if not "main.o" in str(x)]
+        arm_compute_validate_examples = []
+        if test_env['neon']:
+            for file in Glob("validate_examples/neon_*.cpp"):
+                example = "validate_" + os.path.basename(os.path.splitext(str(file))[0])
+                arm_compute_validate_examples += [ test_env.Program(example, [ test_env.Object(source=file, target=example) ] + files_validate_examples) ]
+        if test_env['opencl']:
+            cl_examples = []
+            files = Glob("validate_examples/cl_*.cpp")
+            if test_env['neon']:
+                files += Glob("validate_examples/neoncl_*.cpp")
+            for file in files:
+                example = "validate_" + os.path.basename(os.path.splitext(str(file))[0])
+                cl_examples += [ test_env.Program(example, [ test_env.Object(source=file, target=example) ] + files_validate_examples, CPPDEFINES=['ARM_COMPUTE_CL'], LIBS = test_env["LIBS"] + ["OpenCL"]) ]
+            Depends(cl_examples, opencl)
+            arm_compute_validate_examples += cl_examples
+            if test_env['opencl'] and test_env['neon']:
+                if env['os'] == 'android':
+                    Import('arm_compute_graph_a')
+                    graph_dependency = arm_compute_graph_a
+                else:
+                    Import('arm_compute_graph_so')
+                    graph_dependency = arm_compute_graph_so
+
+                graph_utils = test_env.Object(source="../utils/GraphUtils.cpp", target="GraphUtils")
+                for file in Glob("validate_examples/graph_*.cpp"):
+                    example = "validate_" + os.path.basename(os.path.splitext(str(file))[0])
+                    if env['os'] == 'android':
+                        prog = test_env.Program(example, [ test_env.Object(source=file, target=example), graph_utils]+ files_validate_examples, LIBS = test_env["LIBS"] + ["OpenCL"], LINKFLAGS=test_env["LINKFLAGS"]+['-Wl,--whole-archive',graph_dependency,'-Wl,--no-whole-archive'])
+                        Depends(prog, [graph_dependency, opencl])
+                        arm_compute_validate_examples += [ prog ]
+                    else:
+                        #-Wl,--allow-shlib-undefined: Ignore dependencies of dependencies
+                        prog = test_env.Program(example, [ test_env.Object(source=file, target=example), graph_utils]+ files_validate_examples, LIBS = test_env["LIBS"] + ["arm_compute_graph"], LINKFLAGS=test_env["LINKFLAGS"]+['-Wl,--allow-shlib-undefined'] )
+                        Depends(prog, graph_dependency)
+                        arm_compute_validate_examples += [ prog ]
+        Depends(arm_compute_validate_examples, arm_compute_test_framework)
+        Depends(arm_compute_validate_examples, arm_compute_lib)
+        Default(arm_compute_validate_examples)
+        Export('arm_compute_validate_examples')
+
 #FIXME: Remove before release!
 if test_env['benchmark_examples']:
     files_benchmark_examples = test_env.Object('benchmark_examples/RunExample.cpp')
diff --git a/tests/benchmark_examples/RunExample.cpp b/tests/benchmark_examples/RunExample.cpp
index f1dca819ab..d41f3d30e0 100644
--- a/tests/benchmark_examples/RunExample.cpp
+++ b/tests/benchmark_examples/RunExample.cpp
@@ -70,7 +70,7 @@ int run_example(int argc, char **argv, Example &example)
     framework::CommandLineParser parser;
     framework::CommonOptions     options(parser);
     auto                         example_args = parser.add_option<framework::ListOption<std::string>>("example_args");
-    example_args->set_help("Arguments to pass to the example");
+    example_args->set_help("Arguments to pass to the example separated by commas (e.g: arg0,arg1,arg2)");
     framework::Framework &framework = framework::Framework::get();
 
     parser.parse(argc, argv);
diff --git a/tests/validate_examples/RunExample.cpp b/tests/validate_examples/RunExample.cpp
new file mode 100644
index 0000000000..a7b18ce555
--- /dev/null
+++ b/tests/validate_examples/RunExample.cpp
@@ -0,0 +1,200 @@
+/*
+ * Copyright (c) 2018 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.
+ */
+#include "utils/Utils.h"
+//FIXME / INTERNAL_ONLY: This file should not be released!
+
+#define BENCHMARK_EXAMPLES
+#include "utils/Utils.cpp"
+
+#include "ValidateExample.h"
+#include "arm_compute/runtime/Scheduler.h"
+#include "tests/AssetsLibrary.h"
+#include "tests/Globals.h"
+#include "tests/framework/Framework.h"
+#include "tests/framework/Macros.h"
+#include "tests/framework/command_line/CommandLineParser.h"
+#include "tests/framework/command_line/CommonOptions.h"
+#include "tests/framework/instruments/Instruments.h"
+
+#ifdef ARM_COMPUTE_CL
+#include "arm_compute/runtime/CL/CLScheduler.h"
+#endif /* ARM_COMPUTE_CL */
+#ifdef ARM_COMPUTE_GC
+#include "arm_compute/runtime/GLES_COMPUTE/GCScheduler.h"
+#endif /* ARM_COMPUTE_GC */
+
+#include <libgen.h>
+
+using namespace arm_compute;
+using namespace arm_compute::test;
+
+namespace arm_compute
+{
+namespace test
+{
+std::unique_ptr<AssetsLibrary> library;
+} // namespace test
+namespace utils
+{
+static ValidateExample *g_example = nullptr;
+template <bool          validate>
+class ExampleTest : public arm_compute::test::framework::TestCase
+{
+public:
+    ExampleTest() = default;
+    void do_run() override
+    {
+        g_example->do_run();
+    }
+    void do_teardown() override
+    {
+        if(validate)
+        {
+            g_example->do_validate();
+        }
+        g_example->do_teardown();
+    }
+};
+
+int run_example(int argc, char **argv, ValidateExample &example)
+{
+    framework::CommandLineParser parser;
+    framework::CommonOptions     options(parser);
+    auto                         example_args = parser.add_option<framework::ListOption<std::string>>("example_args");
+    example_args->set_help("Arguments to pass to the example separated by commas (e.g: arg0,arg1,arg2)");
+    auto seed = parser.add_option<framework::SimpleOption<std::random_device::result_type>>("seed", std::random_device()());
+    seed->set_help("Global seed for random number generation");
+    auto validate = parser.add_option<framework::SimpleOption<int>>("validate", 1);
+    validate->set_help("Enable / disable output validation (0/1)");
+
+    framework::Framework &framework = framework::Framework::get();
+
+    parser.parse(argc, argv);
+
+    if(options.help->is_set() && options.help->value())
+    {
+        parser.print_help(argv[0]);
+        return 0;
+    }
+
+    std::vector<std::unique_ptr<framework::Printer>> printers = options.create_printers();
+    g_example                                                 = &example;
+    std::vector<char *> example_argv                          = {};
+    example_argv.clear();
+    example_argv.emplace_back(argv[0]);
+    for(auto &arg : example_args->value())
+    {
+        example_argv.emplace_back(const_cast<char *>(arg.c_str())); // NOLINT
+    }
+
+    // Set number of threads in Scheduler
+    Scheduler::get().set_num_threads(options.threads->value());
+    library = support::cpp14::make_unique<AssetsLibrary>("." /* Only using random values */, seed->value());
+
+    // We need to do the setup here because framework.init() will need CL / GLES to be initialised
+    try
+    {
+        example.do_setup(example_argv.size(), &example_argv[0]);
+    }
+#ifdef ARM_COMPUTE_CL
+    catch(cl::Error &err)
+    {
+        std::cerr << "!!!!!!!!!!!!!!!!!!!!!!!!!!!" << std::endl;
+        std::cerr << std::endl
+                  << "ERROR " << err.what() << "(" << err.err() << ")" << std::endl;
+        std::cerr << "!!!!!!!!!!!!!!!!!!!!!!!!!!!" << std::endl;
+        return 1;
+    }
+#endif /* ARM_COMPUTE_CL */
+    catch(std::runtime_error &err)
+    {
+        std::cerr << "!!!!!!!!!!!!!!!!!!!!!!!!!!!" << std::endl;
+        std::cerr << std::endl
+                  << "ERROR " << err.what() << " " << (errno ? strerror(errno) : "") << std::endl;
+        std::cerr << "!!!!!!!!!!!!!!!!!!!!!!!!!!!" << std::endl;
+        return 1;
+    }
+
+    if(options.log_level->value() > framework::LogLevel::NONE)
+    {
+        for(auto &p : printers)
+        {
+            p->print_global_header();
+        }
+    }
+
+    if(options.log_level->value() >= framework::LogLevel::CONFIG)
+    {
+        for(auto &p : printers)
+        {
+            p->print_entry("Version", build_information());
+            p->print_entry("Seed", support::cpp11::to_string(seed->value()));
+#ifdef ARM_COMPUTE_CL
+            if(opencl_is_available())
+            {
+                p->print_entry("CL_DEVICE_VERSION", CLKernelLibrary::get().get_device_version());
+            }
+            else
+            {
+                p->print_entry("CL_DEVICE_VERSION", "Unavailable");
+            }
+#endif /* ARM_COMPUTE_CL */
+            p->print_entry("Iterations", support::cpp11::to_string(options.iterations->value()));
+            p->print_entry("Threads", support::cpp11::to_string(options.threads->value()));
+            example.print_parameters(*p);
+        }
+    }
+
+    framework.init(options.instruments->value(), options.iterations->value(), framework::DatasetMode::ALL, "", "", options.log_level->value());
+    for(auto &p : printers)
+    {
+        framework.add_printer(p.get());
+    }
+
+    framework.set_throw_errors(options.throw_errors->value());
+    arm_compute::test::framework::detail::TestSuiteRegistrar suite{ "Examples" };
+    if(validate->value() != 0)
+    {
+        framework.add_test_case<ExampleTest<true>>(basename(argv[0]), framework::DatasetMode::ALL, arm_compute::test::framework::TestCaseFactory::Status::ACTIVE);
+    }
+    else
+    {
+        framework.add_test_case<ExampleTest<false>>(basename(argv[0]), framework::DatasetMode::ALL, arm_compute::test::framework::TestCaseFactory::Status::ACTIVE);
+    }
+
+    //func(argc, argv);
+    bool success = framework.run();
+    if(options.log_level->value() > framework::LogLevel::NONE)
+    {
+        for(auto &p : printers)
+        {
+            p->print_global_footer();
+        }
+    }
+
+    return (success ? 0 : 1);
+}
+
+} // namespace utils
+} // namespace arm_compute
diff --git a/tests/validate_examples/ValidateExample.h b/tests/validate_examples/ValidateExample.h
new file mode 100644
index 0000000000..cedbe3d0d9
--- /dev/null
+++ b/tests/validate_examples/ValidateExample.h
@@ -0,0 +1,72 @@
+/*
+ * Copyright (c) 2016-2018 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 __VALIDATE_EXAMPLE_H__
+#define __VALIDATE_EXAMPLE_H__
+
+#include "utils/Utils.h"
+namespace arm_compute
+{
+namespace test
+{
+namespace framework
+{
+class Printer;
+} // namespace framework
+} // namespace test
+namespace utils
+{
+/** Abstract ValidateExample class.
+ *
+ * All examples with a validation stage have to inherit from this class.
+ */
+class ValidateExample : public Example
+{
+public:
+    /** Run reference implementation and validate against the target output
+     */
+    virtual void do_validate()
+    {
+    }
+    /** Print the example parameters
+     *
+     * @param[in,out] printer Printer to use to print the parameters
+     */
+    virtual void print_parameters(test::framework::Printer &printer)
+    {
+    }
+
+    /** Default destructor */
+    virtual ~ValidateExample() = default;
+};
+/** Run an example and handle the potential exceptions it throws
+ *
+ * @param[in] argc    Number of command line arguments
+ * @param[in] argv    Command line arguments
+ * @param[in] example Example to run
+ */
+int run_example(int argc, char **argv, ValidateExample &example);
+
+} // namespace utils
+} // namespace arm_compute
+#endif /* __VALIDATE_EXAMPLE_H__ */
diff --git a/tests/validate_examples/cl_sgemm.cpp b/tests/validate_examples/cl_sgemm.cpp
new file mode 100644
index 0000000000..8b4b98af53
--- /dev/null
+++ b/tests/validate_examples/cl_sgemm.cpp
@@ -0,0 +1,168 @@
+/*
+ * Copyright (c) 2017-2018 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 ARM_COMPUTE_CL /* Needed by Utils.cpp to handle OpenCL exceptions properly */
+#error "This example needs to be built with -DARM_COMPUTE_CL"
+#endif /* ARM_COMPUTE_CL */
+
+#include "arm_compute/core/Types.h"
+#include "arm_compute/runtime/CL/CLFunctions.h"
+#include "arm_compute/runtime/CL/CLScheduler.h"
+#include "arm_compute/runtime/CL/CLTuner.h"
+
+#include "tests/AssetsLibrary.h"
+#include "tests/CL/CLAccessor.h"
+#include "tests/Globals.h"
+#include "tests/IAccessor.h"
+#include "tests/SimpleTensor.h"
+#include "tests/validation/Validation.h"
+#include "tests/validation/reference/GEMM.h"
+
+#include "ValidateExample.h"
+
+#include "utils/Utils.h"
+
+#include <cstdlib>
+
+using namespace arm_compute;
+using namespace utils;
+using namespace arm_compute::test;
+using namespace arm_compute::test::validation;
+
+RelativeTolerance<float> tolerance_f32(0.001f); /**< Tolerance value for comparing reference's output against implementation's output for floating point data types */
+constexpr float          tolerance_num = 0.02f; /**< Tolerance number */
+
+class CLSGEMMValidateExample : public ValidateExample
+{
+public:
+    void do_setup(int argc, char **argv) override
+    {
+        alpha = 1.0f;
+        beta  = 0.0f;
+
+        CLScheduler::get().default_init(&tuner);
+        if(argc < 3)
+        {
+            // Print help
+            std::cout << "Usage: " << argv[0] << " M N K [alpha = 1.0f] [beta = 0.0f]\n\n";
+            std::cout << "Too few or no input_matrices provided. Using M=7, N=3, K=5, alpha=1.0f and beta=0.0f\n\n";
+        }
+        else
+        {
+            M = strtol(argv[1], nullptr, 10);
+            N = strtol(argv[2], nullptr, 10);
+            K = strtol(argv[3], nullptr, 10);
+        }
+
+        src0.allocator()->init(TensorInfo(TensorShape(K, M), 1, DataType::F32));
+        src1.allocator()->init(TensorInfo(TensorShape(N, K), 1, DataType::F32));
+        src2.allocator()->init(TensorInfo(TensorShape(N, M), 1, DataType::F32));
+
+        if(argc > 4)
+        {
+            alpha = strtof(argv[4], nullptr);
+
+            if(argc > 5)
+            {
+                beta = strtof(argv[5], nullptr);
+            }
+        }
+
+        init_sgemm_output(dst, src0, src1, DataType::F32);
+
+        // Configure function
+        sgemm.configure(&src0, &src1, (src2.info()->total_size() > 0) ? &src2 : nullptr, &dst, alpha, beta);
+
+        // Allocate all the images
+        src0.allocator()->allocate();
+        src1.allocator()->allocate();
+        dst.allocator()->allocate();
+
+        // Fill the input images with either the data provided or random data
+        src2.allocator()->allocate();
+
+        fill(CLAccessor(src0), 0);
+        fill(CLAccessor(src1), 1);
+        fill(CLAccessor(src2), 2);
+    }
+    void print_parameters(framework::Printer &printer) override
+    {
+        printer.print_entry("M", support::cpp11::to_string(M));
+        printer.print_entry("N", support::cpp11::to_string(N));
+        printer.print_entry("K", support::cpp11::to_string(K));
+    }
+    void do_validate() override
+    {
+        SimpleTensor<float> ref_src0 = { TensorShape(K, M), DataType::F32, 1 };
+        SimpleTensor<float> ref_src1 = { TensorShape(N, K), DataType::F32, 1 };
+        SimpleTensor<float> ref_src2 = { TensorShape(N, M), DataType::F32, 1 };
+
+        fill(ref_src0, 0);
+        fill(ref_src1, 1);
+        fill(ref_src2, 2);
+
+        SimpleTensor<float> ref_dst = reference::gemm<float>(ref_src0, ref_src1, ref_src2, alpha, beta);
+        validate(CLAccessor(dst), ref_dst, tolerance_f32, tolerance_num);
+    }
+    void do_run() override
+    {
+        // Execute the function
+        sgemm.run();
+
+        // Make sure all the OpenCL jobs are done executing:
+        CLScheduler::get().sync();
+    }
+
+private:
+    template <typename U>
+    void fill(U &&tensor, int i)
+    {
+        switch(tensor.data_type())
+        {
+            case DataType::F16:
+            case DataType::F32:
+            {
+                std::uniform_real_distribution<> distribution(-1.0f, 1.0f);
+                library->fill(tensor, distribution, i);
+                break;
+            }
+            default:
+                library->fill_tensor_uniform(tensor, i);
+        }
+    }
+    size_t   M{ 7 }, N{ 3 }, K{ 5 };
+    CLTensor src0{}, src1{}, src2{}, dst{};
+    CLGEMM   sgemm{};
+    CLTuner  tuner{};
+    float    alpha{}, beta{};
+};
+
+/** Main program for sgemm test
+ *
+ * @param[in] argc Number of arguments
+ * @param[in] argv Arguments ( [optional] Matrix A, [optional] Matrix B, [optional] Matrix C, [optional] alpha, [optional] beta )
+ */
+int main(int argc, char **argv)
+{
+    return utils::run_example<CLSGEMMValidateExample>(argc, argv);
+}