Introduce CL kernel cache feature

This patch introduces CL kernel cache feature for
NN runtimes such as ARMNN or other in-house versions.

Originally, this feature came from utils/Utils.cpp and utils/Utils.h
files but was used just for testing.

Caching CL kernel binaries is mandatory and required for real product
because inference performance at first run is one of very important
factors. This patch exposes two API - save_program_cache_to_file
and restore_program_cache_from_file so that NN runtimes can use
these API to cache the compiled CL kernel binaries.

Changelog v1.
- Reordered including headers suggested by Manuel Bottini.
- Updated description.
Changelog v2.
- Drop function descriptions.
Changelog v3.
- Fix build error with opencl = 0. As for this, it moves two functions,
  save_program_cache_to_file and restore_program_cache_from_file,
  to src/runtime/CL/Utils.cpp and arm_compute/runtime/CL/Utils.h,
  and set ARM_COMPUTE_CL flag only when opencl = 1.
  This change makes CL kernel cache feature to depend on OpenCL support.
Changelog v4.
- Fix coding_standard_checks error.
Changelog v5.
- Add a new cpp file to Android.bp to fix coding_standard_checks error.
Changelog v6.
- rebased on top of master, and dropped _new_built_programs_map object
  so it adds compiled CL kerne binaries per model to a given file.
Changelog v7.
- Correct descriptions.
- Correct arm_compute/runtime/CL/Utils.h file description.
- Correct src/runtime/CL/Utils.cpp file description.
- Drop ARM_COMPUTE_CL ifdef ~ endif from examples/cl_cache.cpp
- Do not add 'ARM_COMPUTE_CL' flag at SConscript.

Change-Id: I8c640fb1809ca79191daf5b1ff72a50dd492c36d
Signed-off-by: Inki Dae <inki.dae@samsung.com>
Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/2914
Tested-by: Arm Jenkins <bsgcomp@arm.com>
Reviewed-by: Georgios Pinitas <georgios.pinitas@arm.com>
Comments-Addressed: Arm Jenkins <bsgcomp@arm.com>

8 files changed, 159 insertions, 94 deletions

diff --git a/Android.bp b/Android.bp
index 6c37de3c7b..59fb270d0d 100644
--- a/Android.bp
+++ b/Android.bp
@@ -443,6 +443,7 @@ cc_library_static {
         "src/runtime/CL/CLTensorAllocator.cpp",
         "src/runtime/CL/CLTuner.cpp",
         "src/runtime/CL/ICLSimpleFunction.cpp",
+        "src/runtime/CL/Utils.cpp",
         "src/runtime/CL/functions/CLAbsoluteDifference.cpp",
         "src/runtime/CL/functions/CLAccumulate.cpp",
         "src/runtime/CL/functions/CLActivationLayer.cpp",
diff --git a/arm_compute/runtime/CL/Utils.h b/arm_compute/runtime/CL/Utils.h
new file mode 100644
index 0000000000..e317569ebe
--- /dev/null
+++ b/arm_compute/runtime/CL/Utils.h
@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2020 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_RUNTIME_CL_UTILS_H
+#define ARM_COMPUTE_RUNTIME_CL_UTILS_H
+
+#include <string>
+
+namespace arm_compute
+{
+/** This function saves opencl kernels library to a file
+ *
+ * @param[in] filename Name of the file to be used to save the library
+ */
+void save_program_cache_to_file(const std::string &filename = "cache.bin");
+
+/** This function loads prebuilt opencl kernels from a file
+ *
+ * @param[in] filename Name of the file to be used to load the kernels
+ */
+void restore_program_cache_from_file(const std::string &filename = "cache.bin");
+} // namespace arm_compute
+#endif /* ARM_COMPUTE_RUNTIME_CL_UTILS_H */
diff --git a/examples/cl_cache.cpp b/examples/cl_cache.cpp
index 7d8a515424..a1a2d2548a 100644
--- a/examples/cl_cache.cpp
+++ b/examples/cl_cache.cpp
@@ -26,6 +26,7 @@
 #include "arm_compute/core/Types.h"
 #include "arm_compute/runtime/CL/CLHelpers.h"
 #include "arm_compute/runtime/CL/CLScheduler.h"
+#include "arm_compute/runtime/CL/Utils.h"
 #include "utils/Utils.h"
 
 using namespace arm_compute;
diff --git a/examples/graph_alexnet.cpp b/examples/graph_alexnet.cpp
index 0adc6a8e93..25ede6dca2 100644
--- a/examples/graph_alexnet.cpp
+++ b/examples/graph_alexnet.cpp
@@ -22,11 +22,15 @@
  * SOFTWARE.
  */
 #include "arm_compute/graph.h"
+#ifdef ARM_COMPUTE_CL
+#include "arm_compute/runtime/CL/Utils.h"
+#endif /* ARM_COMPUTE_CL */
 #include "support/ToolchainSupport.h"
 #include "utils/CommonGraphOptions.h"
 #include "utils/GraphUtils.h"
 #include "utils/Utils.h"
 
+using namespace arm_compute;
 using namespace arm_compute::utils;
 using namespace arm_compute::graph::frontend;
 using namespace arm_compute::graph_utils;
@@ -160,7 +164,9 @@ public:
         // compilation won't be required.
         if(common_params.enable_cl_cache)
         {
+#ifdef ARM_COMPUTE_CL
             restore_program_cache_from_file();
+#endif /* ARM_COMPUTE_CL */
         }
 
         graph.finalize(common_params.target, config);
@@ -168,7 +174,9 @@ public:
         // Save the opencl kernels to a file
         if(common_opts.enable_cl_cache)
         {
+#ifdef ARM_COMPUTE_CL
             save_program_cache_to_file();
+#endif /* ARM_COMPUTE_CL */
         }
 
         return true;
diff --git a/examples/graph_inception_v4.cpp b/examples/graph_inception_v4.cpp
index 7893930993..c78bbb285a 100644
--- a/examples/graph_inception_v4.cpp
+++ b/examples/graph_inception_v4.cpp
@@ -22,11 +22,15 @@
  * SOFTWARE.
  */
 #include "arm_compute/graph.h"
+#ifdef ARM_COMPUTE_CL
+#include "arm_compute/runtime/CL/Utils.h"
+#endif /* ARM_COMPUTE_CL */
 #include "support/ToolchainSupport.h"
 #include "utils/CommonGraphOptions.h"
 #include "utils/GraphUtils.h"
 #include "utils/Utils.h"
 
+using namespace arm_compute;
 using namespace arm_compute::utils;
 using namespace arm_compute::graph::frontend;
 using namespace arm_compute::graph_utils;
@@ -158,7 +162,9 @@ public:
         // compilation won't be required.
         if(common_params.enable_cl_cache)
         {
+#ifdef ARM_COMPUTE_CL
             restore_program_cache_from_file();
+#endif /* ARM_COMPUTE_CL */
         }
 
         graph.finalize(common_params.target, config);
@@ -166,7 +172,9 @@ public:
         // Save the opencl kernels to a file
         if(common_opts.enable_cl_cache)
         {
+#ifdef ARM_COMPUTE_CL
             save_program_cache_to_file();
+#endif /* ARM_COMPUTE_CL */
         }
 
         return true;
diff --git a/src/runtime/CL/Utils.cpp b/src/runtime/CL/Utils.cpp
new file mode 100644
index 0000000000..5e22dfd4eb
--- /dev/null
+++ b/src/runtime/CL/Utils.cpp
@@ -0,0 +1,98 @@
+/*
+ * Copyright (c) 2020 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 "arm_compute/core/CL/CLKernelLibrary.h"
+#include "arm_compute/runtime/CL/CLScheduler.h"
+
+#include <fstream>
+#include <map>
+#include <string>
+
+namespace arm_compute
+{
+void restore_program_cache_from_file(const std::string &filename)
+{
+    std::ifstream cache_file(filename, std::ios::binary);
+    if(cache_file.is_open())
+    {
+        if(!CLScheduler::get().is_initialised())
+        {
+            arm_compute::CLScheduler::get().default_init();
+        }
+
+        while(!cache_file.eof())
+        {
+            size_t name_len   = 0;
+            size_t binary_len = 0;
+            cache_file.read(reinterpret_cast<char *>(&name_len), sizeof(size_t));
+            cache_file.read(reinterpret_cast<char *>(&binary_len), sizeof(size_t));
+            if(name_len == 0 || binary_len == 0)
+            {
+                break;
+            }
+            std::vector<char>          tmp(name_len);
+            std::vector<unsigned char> binary(binary_len);
+            std::string                name;
+            cache_file.read(tmp.data(), name_len);
+            name.assign(tmp.data(), name_len);
+            tmp.resize(binary_len);
+            cache_file.read(reinterpret_cast<char *>(binary.data()), binary_len);
+            cl::Context             context = arm_compute::CLScheduler::get().context();
+            cl::Program::Binaries   binaries{ binary };
+            std::vector<cl::Device> devices = context.getInfo<CL_CONTEXT_DEVICES>();
+            cl::Program             program(context, devices, binaries);
+            program.build();
+            CLKernelLibrary::get().add_built_program(name, program);
+        }
+        cache_file.close();
+    }
+}
+
+void save_program_cache_to_file(const std::string &filename)
+{
+    if(CLScheduler::get().is_initialised())
+    {
+        std::ofstream cache_file(filename, std::ios::binary);
+        if(cache_file.is_open())
+        {
+            for(const auto &it : CLKernelLibrary::get().get_built_programs())
+            {
+                std::vector<std::vector<unsigned char>> binaries = it.second.getInfo<CL_PROGRAM_BINARIES>();
+                ARM_COMPUTE_ERROR_ON(binaries.size() != 1);
+                const std::string kernel_name      = it.first;
+                size_t            kernel_name_size = kernel_name.length();
+                size_t            binary_size      = binaries[0].size();
+                cache_file.write(reinterpret_cast<char *>(&kernel_name_size), sizeof(size_t));
+                cache_file.write(reinterpret_cast<char *>(&binary_size), sizeof(size_t));
+                cache_file.write(kernel_name.c_str(), kernel_name_size);
+                cache_file.write(reinterpret_cast<const char *>(binaries[0].data()), binaries[0].size());
+            }
+            cache_file.close();
+        }
+        else
+        {
+            ARM_COMPUTE_ERROR("Cannot open cache file");
+        }
+    }
+}
+} // namespace arm_compute
diff --git a/utils/Utils.cpp b/utils/Utils.cpp
index 80b47d7675..70c2004d7a 100644
--- a/utils/Utils.cpp
+++ b/utils/Utils.cpp
@@ -274,87 +274,5 @@ uint64_t get_mem_free_from_meminfo()
     // Nothing found or an error during opening the file
     return 0;
 }
-
-/** This function loads prebuilt opencl kernels from a file
- *
- * @param[in] filename Name of the file to be used to load the kernels
- */
-void restore_program_cache_from_file(const std::string &filename)
-{
-#ifdef ARM_COMPUTE_CL
-    std::ifstream cache_file(filename, std::ios::binary);
-    if(cache_file.is_open())
-    {
-        if(!CLScheduler::get().is_initialised())
-        {
-            arm_compute::CLScheduler::get().default_init();
-        }
-
-        while(!cache_file.eof())
-        {
-            size_t name_len   = 0;
-            size_t binary_len = 0;
-            cache_file.read(reinterpret_cast<char *>(&name_len), sizeof(size_t));
-            cache_file.read(reinterpret_cast<char *>(&binary_len), sizeof(size_t));
-            if(name_len == 0 || binary_len == 0)
-            {
-                break;
-            }
-            std::vector<char>          tmp(name_len);
-            std::vector<unsigned char> binary(binary_len);
-            std::string                name;
-            cache_file.read(tmp.data(), name_len);
-            name.assign(tmp.data(), name_len);
-            tmp.resize(binary_len);
-            cache_file.read(reinterpret_cast<char *>(binary.data()), binary_len);
-            cl::Context             context = arm_compute::CLScheduler::get().context();
-            cl::Program::Binaries   binaries{ binary };
-            std::vector<cl::Device> devices = context.getInfo<CL_CONTEXT_DEVICES>();
-            cl::Program             program(context, devices, binaries);
-            program.build();
-            CLKernelLibrary::get().add_built_program(name, program);
-        }
-        cache_file.close();
-    }
-#else  /* ARM_COMPUTE_CL */
-    ARM_COMPUTE_UNUSED(filename);
-#endif /* ARM_COMPUTE_CL */
-}
-
-/** This function saves opencl kernels library to a file
- *
- * @param[in] filename Name of the file to be used to save the library
- */
-void save_program_cache_to_file(const std::string &filename)
-{
-#ifdef ARM_COMPUTE_CL
-    if(CLScheduler::get().is_initialised())
-    {
-        std::ofstream cache_file(filename, std::ios::binary);
-        if(cache_file.is_open())
-        {
-            for(const auto &it : CLKernelLibrary::get().get_built_programs())
-            {
-                std::vector<std::vector<unsigned char>> binaries = it.second.getInfo<CL_PROGRAM_BINARIES>();
-                ARM_COMPUTE_ERROR_ON(binaries.size() != 1);
-                const std::string kernel_name      = it.first;
-                size_t            kernel_name_size = kernel_name.length();
-                size_t            binary_size      = binaries[0].size();
-                cache_file.write(reinterpret_cast<char *>(&kernel_name_size), sizeof(size_t));
-                cache_file.write(reinterpret_cast<char *>(&binary_size), sizeof(size_t));
-                cache_file.write(kernel_name.c_str(), kernel_name_size);
-                cache_file.write(reinterpret_cast<const char *>(binaries[0].data()), binaries[0].size());
-            }
-            cache_file.close();
-        }
-        else
-        {
-            ARM_COMPUTE_ERROR("Cannot open cache file");
-        }
-    }
-#else  /* ARM_COMPUTE_CL */
-    ARM_COMPUTE_UNUSED(filename);
-#endif /* ARM_COMPUTE_CL */
-}
 } // namespace utils
 } // namespace arm_compute
diff --git a/utils/Utils.h b/utils/Utils.h
index 1c577d9eea..23846cfc53 100644
--- a/utils/Utils.h
+++ b/utils/Utils.h
@@ -822,18 +822,6 @@ int compare_tensor(ITensor &tensor1, ITensor &tensor2, T tolerance)
 
     return num_mismatches;
 }
-
-/** This function saves opencl kernels library to a file
- *
- * @param[in] filename Name of the file to be used to save the library
- */
-void save_program_cache_to_file(const std::string &filename = "cache.bin");
-
-/** This function loads prebuilt opencl kernels from a file
- *
- * @param[in] filename Name of the file to be used to load the kernels
- */
-void restore_program_cache_from_file(const std::string &filename = "cache.bin");
 } // namespace utils
 } // namespace arm_compute
 #endif /* __UTILS_UTILS_H__*/