From b56c1758dfc233452ff73149fabe30e1c460e9d3 Mon Sep 17 00:00:00 2001 From: Manuel Bottini Date: Wed, 18 Nov 2020 17:56:30 +0000 Subject: Generalization of CLTuner Rename lws to tuning parameters in functions used externally Add new generalized objects for the OpenCL Tuner to accommodate further possible tuning parameters Resolves: COMPMID-3935 Change-Id: I0f2a0f89bca5dae4a4e4adce2f7c7cae32ecb84a Signed-off-by: Manuel Bottini Reviewed-on: https://review.mlplatform.org/c/ml/ComputeLibrary/+/4584 Comments-Addressed: Arm Jenkins Tested-by: Arm Jenkins Reviewed-by: Georgios Pinitas --- arm_compute/runtime/CL/CLTuner.h | 85 ++++++-- arm_compute/runtime/CL/CLTunerTypes.h | 8 +- arm_compute/runtime/CL/CLTuningParams.h | 59 ++++++ arm_compute/runtime/CL/tuners/CLLWSList.h | 214 --------------------- .../runtime/CL/tuners/CLTuningParametersList.h | 86 +++++++++ 5 files changed, 217 insertions(+), 235 deletions(-) create mode 100644 arm_compute/runtime/CL/CLTuningParams.h delete mode 100644 arm_compute/runtime/CL/tuners/CLLWSList.h create mode 100644 arm_compute/runtime/CL/tuners/CLTuningParametersList.h (limited to 'arm_compute') diff --git a/arm_compute/runtime/CL/CLTuner.h b/arm_compute/runtime/CL/CLTuner.h index 3b45a2177e..9814867142 100644 --- a/arm_compute/runtime/CL/CLTuner.h +++ b/arm_compute/runtime/CL/CLTuner.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2017-2020 Arm Limited. + * Copyright (c) 2017-2021 Arm Limited. * * SPDX-License-Identifier: MIT * @@ -25,7 +25,9 @@ #define ARM_COMPUTE_CLTUNER_H #include "arm_compute/core/CL/OpenCL.h" +#include "arm_compute/core/utils/misc/Macros.h" #include "arm_compute/runtime/CL/CLTunerTypes.h" +#include "arm_compute/runtime/CL/CLTuningParams.h" #include "arm_compute/runtime/CL/ICLTuner.h" #include @@ -41,9 +43,10 @@ public: /** Constructor * * @param[in] tune_new_kernels Find the optimal local workgroup size for kernels which are not present in the table ? + * @param[in] tuning_info (Optional) opencl parameters to tune * */ - CLTuner(bool tune_new_kernels = true); + CLTuner(bool tune_new_kernels = true, CLTuningInfo tuning_info = CLTuningInfo()); /** Destructor */ ~CLTuner() = default; @@ -53,21 +56,30 @@ public: * @param[in] tune_new_kernels Find the optimal local workgroup size for kernels which are not present in the table ? */ void set_tune_new_kernels(bool tune_new_kernels); - /** Tune kernels that are not in the LWS table + + /** Tune kernels that are not in the tuning parameters table * * @return True if tuning of new kernels is enabled. */ bool tune_new_kernels() const; + /** Setter for tune parameters option + * + * @param[in] tuning_info opencl parameters to tune + */ + void set_tuning_parameters(CLTuningInfo tuning_info); + /** Set OpenCL tuner mode * - * @param[in] mode Indicates how exhaustive the search for the optimal LWS should be while tuning. Default is Exhaustive mode + * @param[in] mode Indicates how exhaustive the search for the optimal tuning parameters should be while tuning. Default is Exhaustive mode */ void set_tuner_mode(CLTunerMode mode); /** Get the current OpenCL tuner mode * - * @return tuner_mode Indicates how exhaustive the search for the optimal LWS should be while tuning + * @return tuner_mode Indicates how exhaustive the search for the optimal tuning parameters should be while tuning + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release */ CLTunerMode get_tuner_mode() const; @@ -75,20 +87,48 @@ public: * * @param[in] kernel_id Unique identifiant of the kernel * @param[in] optimal_lws Optimal local workgroup size to use for the given kernel + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release */ + ARM_COMPUTE_DEPRECATED_REL_REPLACE(21.02, add_tuning_params) void add_lws_to_table(const std::string &kernel_id, cl::NDRange optimal_lws); + /** Manually add tuning parameters for a kernel + * + * @param[in] kernel_id Unique identifiant of the kernel + * @param[in] optimal_tuning_params Optimal tuning parameters to use for the given kernel + */ + void add_tuning_params(const std::string &kernel_id, CLTuningParams optimal_tuning_params); + /** Import LWS table * * @param[in] lws_table The unordered_map container to import + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release */ + ARM_COMPUTE_DEPRECATED_REL_REPLACE(21.02, import_tuning_params) void import_lws_table(const std::unordered_map &lws_table); + /** Import tuning parameters table + * + * @param[in] tuning_params_table The unordered_map container to import + */ + void import_tuning_params(const std::unordered_map &tuning_params_table); + /** Give read access to the LWS table * * @return The lws table as unordered_map container + * + * @deprecated This function is deprecated and is intended to be removed in 21.05 release + */ + ARM_COMPUTE_DEPRECATED_REL_REPLACE(21.02, tuning_params_table) + const std::unordered_map &lws_table(); + + /** Give read access to the tuning params table + * + * @return The tuning params table as unordered_map container */ - const std::unordered_map &lws_table() const; + const std::unordered_map &tuning_params_table() const; /** Set the OpenCL kernel event * @@ -101,17 +141,20 @@ public: /** clEnqueueNDRangeKernel symbol */ std::function real_clEnqueueNDRangeKernel; - /** Load the LWS table from file + /** Load the tuning parameters table from file. It also sets up the tuning read from the file + * + * @param[in] filename Load the tuning parameters table from this file.(Must exist) * - * @param[in] filename Load the LWS table from this file.(Must exist) */ void load_from_file(const std::string &filename); - /** Save the content of the LWS table to file + /** Save the content of the tuning parameters table to file * - * @param[in] filename Save the LWS table to this file. (Content will be overwritten) + * @param[in] filename Save the tuning parameters table to this file. (Content will be overwritten) + * + * @return true if the file was created */ - void save_to_file(const std::string &filename) const; + bool save_to_file(const std::string &filename) const; // Inherited methods overridden: void tune_kernel_static(ICLKernel &kernel) override; @@ -125,19 +168,21 @@ public: bool kernel_event_is_set() const; private: - /** Find optimal LWS using brute-force approach + /** Find optimal tuning parameters using brute-force approach * - * @param[in] kernel OpenCL kernel to be tuned with LWS + * @param[in] kernel OpenCL kernel to be tuned with tuning parameters * @param[in,out] tensors Tensors for the kernel to operate on * - * @return The optimal LWS to use + * @return The optimal tuning parameters to use */ - cl::NDRange find_optimal_lws(ICLKernel &kernel, ITensorPack &tensors); - - std::unordered_map _lws_table; - cl::Event _kernel_event; - bool _tune_new_kernels; - CLTunerMode _tuner_mode; + CLTuningParams find_optimal_tuning_params(ICLKernel &kernel, ITensorPack &tensors); + + std::unordered_map _tuning_params_table; + std::unordered_map _lws_table; + cl::Event _kernel_event; + bool _tune_new_kernels; + CLTuningInfo _tuning_info; + CLTunerMode _tuner_mode; }; } // namespace arm_compute #endif /*ARM_COMPUTE_CLTUNER_H */ diff --git a/arm_compute/runtime/CL/CLTunerTypes.h b/arm_compute/runtime/CL/CLTunerTypes.h index e3180f2165..49e2d615ea 100644 --- a/arm_compute/runtime/CL/CLTunerTypes.h +++ b/arm_compute/runtime/CL/CLTunerTypes.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019 Arm Limited. + * Copyright (c) 2019-2021 Arm Limited. * * SPDX-License-Identifier: MIT * @@ -39,6 +39,12 @@ enum class CLTunerMode RAPID /**< Searches a minimal subset of LWS configurations while tuning */ }; +/**< OpenCL tuner tuning information */ +struct CLTuningInfo +{ + bool tune_lws = true; +}; + /** Converts a string to a strong types enumeration @ref CLTunerMode * * @param[in] name String to convert diff --git a/arm_compute/runtime/CL/CLTuningParams.h b/arm_compute/runtime/CL/CLTuningParams.h new file mode 100644 index 0000000000..99a386638d --- /dev/null +++ b/arm_compute/runtime/CL/CLTuningParams.h @@ -0,0 +1,59 @@ +/* + * Copyright (c) 2020-2021 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_CLTUNING_PARAMS_H +#define ARM_COMPUTE_CLTUNING_PARAMS_H + +#include "arm_compute/core/CL/OpenCL.h" + +namespace arm_compute +{ +/**< OpenCL tuner parameters */ +class CLTuningParams +{ +public: + CLTuningParams(const CLTuningParams &) = default; + + CLTuningParams(unsigned int lws_x = 0, unsigned int lws_y = 0, unsigned int lws_z = 0) + : _lws(lws_x, lws_y, lws_z) + { + } + CLTuningParams(cl::NDRange lws) + : _lws(lws) + { + } + void set_lws(cl::NDRange &lws) + { + _lws = lws; + } + + cl::NDRange get_lws() + { + return _lws; + } + +private: + cl::NDRange _lws; +}; +} // namespace arm_compute +#endif /*ARM_COMPUTE_CLTUNING_PARAMS_H */ diff --git a/arm_compute/runtime/CL/tuners/CLLWSList.h b/arm_compute/runtime/CL/tuners/CLLWSList.h deleted file mode 100644 index fe63754dd0..0000000000 --- a/arm_compute/runtime/CL/tuners/CLLWSList.h +++ /dev/null @@ -1,214 +0,0 @@ -/* - * Copyright (c) 2019-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_CL_LWS_LIST_H -#define ARM_COMPUTE_CL_LWS_LIST_H - -#include "arm_compute/core/CL/OpenCL.h" -#include "arm_compute/core/Error.h" -#include "arm_compute/core/Helpers.h" -#include "arm_compute/runtime/CL/CLTunerTypes.h" -#include "support/ToolchainSupport.h" - -#include - -namespace arm_compute -{ -namespace cl_tuner -{ -constexpr unsigned int max_lws_supported_x{ 64u }; -constexpr unsigned int max_lws_supported_y{ 32u }; -constexpr unsigned int max_lws_supported_z{ 32u }; - -/** Interface for LWS lists */ -class ICLLWSList -{ -public: - /** Constructor */ - ICLLWSList() = default; - /** Copy Constructor */ - ICLLWSList(const ICLLWSList &) = default; - /** Move Constructor */ - ICLLWSList(ICLLWSList &&) noexcept(true) = default; - /** Assignment */ - ICLLWSList &operator=(const ICLLWSList &) = default; - /** Move Assignment */ - ICLLWSList &operator=(ICLLWSList &&) noexcept(true) = default; - /** Destructor */ - virtual ~ICLLWSList() = default; - - /** Return the LWS value at the given index. - * - * @return LWS value at the given index - */ - virtual cl::NDRange operator[](size_t) = 0; - - /** LWS list size. - * - * @return LWS list size - */ - virtual size_t size() = 0; -}; - -/** Non instantiable base class for LWS combinations that use Index2Cooard mapping */ -class CLLWSList : public ICLLWSList -{ -protected: - /* Shape of 3-D search space */ - TensorShape search_space_shape{ 0, 0, 0 }; - - /** Constructor */ - CLLWSList() = default; - /** Copy Constructor */ - CLLWSList(const CLLWSList &) = default; - /** Move Constructor */ - CLLWSList(CLLWSList &&) noexcept(true) = default; - /** Assignment */ - CLLWSList &operator=(const CLLWSList &) = default; - /** Move Assignment */ - CLLWSList &operator=(CLLWSList &&) noexcept(true) = default; - /** Destructor */ - virtual ~CLLWSList() = default; - - // Inherited methods overridden: - virtual size_t size() override; -}; - -/** Exhaustive list of all possible LWS values */ -class CLLWSListExhaustive : public CLLWSList -{ -public: - /** Prevent default constructor calls */ - CLLWSListExhaustive() = delete; - /** Constructor */ - CLLWSListExhaustive(const cl::NDRange &gws); - /** Copy Constructor */ - CLLWSListExhaustive(const CLLWSListExhaustive &) = default; - /** Move Constructor */ - CLLWSListExhaustive(CLLWSListExhaustive &&) noexcept(true) = default; - /** Assignment */ - CLLWSListExhaustive &operator=(const CLLWSListExhaustive &) = default; - /** Move Assignment */ - CLLWSListExhaustive &operator=(CLLWSListExhaustive &&) noexcept(true) = default; - /** Destructor */ - ~CLLWSListExhaustive() = default; - - // Inherited methods overridden: - cl::NDRange operator[](size_t) override; -}; - -/** A subset of LWS values that are either factors of gws when gws[2] < 16 or power of 2 */ -class CLLWSListNormal : public CLLWSList -{ -public: - /** Constructor */ - CLLWSListNormal(const cl::NDRange &gws); - /** Copy Constructor */ - CLLWSListNormal(const CLLWSListNormal &) = default; - /** Move Constructor */ - CLLWSListNormal(CLLWSListNormal &&) noexcept(true) = default; - /** Assignment */ - CLLWSListNormal &operator=(const CLLWSListNormal &) = default; - /** Move Assignment */ - CLLWSListNormal &operator=(CLLWSListNormal &&) noexcept(true) = default; - /** Destructor */ - ~CLLWSListNormal() = default; - - // Inherited methods overridden: - cl::NDRange operator[](size_t) override; - -protected: - std::vector _lws_x{}; - std::vector _lws_y{}; - std::vector _lws_z{}; - - /** Prevent default constructor calls */ - CLLWSListNormal() = default; - -private: - /** Utility function used to initialize the LWS values to test. - * Only the LWS values which are power of 2 or satisfy the modulo conditions with GWS are taken into account by the CLTuner - * - * @param[in, out] lws Vector of LWS to test - * @param[in] gws Size of the specific GWS - * @param[in] lws_max Max LWS value allowed to be tested - * @param[in] mod_let_one True if the results of the modulo operation between gws and the lws can be less than one. - */ - void initialize_lws_values(std::vector &lws, unsigned int gws, unsigned int lws_max, bool mod_let_one); -}; - -/** A minimal subset of LWS values that only have 1,2 and 4/8 */ -class CLLWSListRapid : public CLLWSListNormal -{ -public: - /** Prevent default constructor calls */ - CLLWSListRapid() = delete; - /** Constructor */ - CLLWSListRapid(const cl::NDRange &gws); - /** Copy Constructor */ - CLLWSListRapid(const CLLWSListRapid &) = default; - /** Move Constructor */ - CLLWSListRapid(CLLWSListRapid &&) noexcept(true) = default; - /** Assignment */ - CLLWSListRapid &operator=(const CLLWSListRapid &) = default; - /** Move Assignment */ - CLLWSListRapid &operator=(CLLWSListRapid &&) noexcept(true) = default; - /** Destructor */ - virtual ~CLLWSListRapid() = default; - -private: - /** Utility function used to initialize the LWS values to test. - * Only the LWS values that have 1,2 and 4/8 for each dimension are taken into account by the CLTuner - * - * @param[in, out] lws Vector of LWS to test - * @param[in] lws_max Max LWS value allowed to be tested - */ - void initialize_lws_values(std::vector &lws, unsigned int lws_max); -}; - -/** Factory to construct an ICLLWSList object based on the CL tuner mode */ -class CLLWSListFactory final -{ -public: - /** Construct an ICLLWSList object for the given tuner mode and gws configuration. - * - * @return unique_ptr to the requested ICLLWSList implementation. - */ - static std::unique_ptr get_lws_list(CLTunerMode mode, const cl::NDRange &gws) - { - switch(mode) - { - case CLTunerMode::EXHAUSTIVE: - return std::make_unique(gws); - case CLTunerMode::NORMAL: - return std::make_unique(gws); - case CLTunerMode::RAPID: - return std::make_unique(gws); - default: - return nullptr; - } - } -}; -} // namespace cl_tuner -} // namespace arm_compute -#endif /*ARM_COMPUTE_CL_LWS_LIST_H */ diff --git a/arm_compute/runtime/CL/tuners/CLTuningParametersList.h b/arm_compute/runtime/CL/tuners/CLTuningParametersList.h new file mode 100644 index 0000000000..c51b9901ef --- /dev/null +++ b/arm_compute/runtime/CL/tuners/CLTuningParametersList.h @@ -0,0 +1,86 @@ +/* + * Copyright (c) 2020-2021 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_TUNINGPARAMETERS_LIST_H +#define ARM_COMPUTE_CL_TUNINGPARAMETERS_LIST_H + +#include "arm_compute/core/CL/OpenCL.h" +#include "arm_compute/core/Error.h" +#include "arm_compute/core/Helpers.h" +#include "arm_compute/runtime/CL/CLTunerTypes.h" +#include "arm_compute/runtime/CL/CLTuningParams.h" +#include "support/ToolchainSupport.h" + +#include + +namespace arm_compute +{ +namespace cl_tuner +{ +/** Interface for Tuning Parameters lists + * + * The tuning parameter lists contain a set of tuning parameters to estimate. + * There are 3 tuner modes, each using its specific list: + * - Exhaustive tuner mode is the slowest during the tuning but will find faster tuning parameters + * - Normal tuner mode is the average modality in terms of tuning time and tuning parameters found + * - Rapid tuner mode is the fastest but the tuning parameters might not be the fastest + * + */ +class ICLTuningParametersList +{ +public: + /** Constructor */ + ICLTuningParametersList() = default; + /** Copy Constructor */ + ICLTuningParametersList(const ICLTuningParametersList &) = default; + /** Move Constructor */ + ICLTuningParametersList(ICLTuningParametersList &&) noexcept(true) = default; + /** Assignment */ + ICLTuningParametersList &operator=(const ICLTuningParametersList &) = default; + /** Move Assignment */ + ICLTuningParametersList &operator=(ICLTuningParametersList &&) noexcept(true) = default; + /** Destructor */ + virtual ~ICLTuningParametersList() = default; + + /** Return the tuning parameter values at the given index. + * + * @return tuning parameter values at the given index + */ + virtual CLTuningParams operator[](size_t) = 0; + + /** Tuning parameters list size. + * + * @return Tuning parameters list size + */ + virtual size_t size() = 0; +}; + +/** Construct an ICLTuningParametersList object for the given tuner mode and gws configuration. + * + * @return unique_ptr to the requested ICLTuningParametersList implementation. + */ +std::unique_ptr get_tuning_parameters_list(CLTunerMode mode, const cl::NDRange &gws); + +} // namespace cl_tuner +} // namespace arm_compute +#endif /*ARM_COMPUTE_CL_TUNINGPARAMETERS_LIST_H */ -- cgit v1.2.1