1 /* 2 * Copyright (c) 2021 Arm Limited. 3 * 4 * SPDX-License-Identifier: MIT 5 * 6 * Permission is hereby granted, free of charge, to any person obtaining a copy 7 * of this software and associated documentation files (the "Software"), to 8 * deal in the Software without restriction, including without limitation the 9 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 10 * sell copies of the Software, and to permit persons to whom the Software is 11 * furnished to do so, subject to the following conditions: 12 * 13 * The above copyright notice and this permission notice shall be included in all 14 * copies or substantial portions of the Software. 15 * 16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 22 * SOFTWARE. 23 */ 24 #ifndef ARM_COMPUTE_RUNTIME_CL_CL_GEMM_HEURISTICS_HANDLE_H 25 #define ARM_COMPUTE_RUNTIME_CL_CL_GEMM_HEURISTICS_HANDLE_H 26 27 #include <memory> 28 29 namespace arm_compute 30 { 31 namespace mlgo 32 { 33 /** Forward declaration for the underlying heuristics: MLGOHeuristics */ 34 class MLGOHeuristics; 35 } // namespace mlgo 36 37 /** Handle for loading and retrieving GEMM heuristics */ 38 class CLGEMMHeuristicsHandle 39 { 40 public: 41 /** Constructor */ 42 CLGEMMHeuristicsHandle(); 43 /** Destructor */ 44 ~CLGEMMHeuristicsHandle(); 45 /** Prevent Copy Construct */ 46 CLGEMMHeuristicsHandle(const CLGEMMHeuristicsHandle &) = delete; 47 /** Prevent Copy Assignment */ 48 CLGEMMHeuristicsHandle &operator=(const CLGEMMHeuristicsHandle &) = delete; 49 /** Default Move Constructor */ 50 CLGEMMHeuristicsHandle(CLGEMMHeuristicsHandle &&) = default; 51 /** Default Move Assignment */ 52 CLGEMMHeuristicsHandle &operator=(CLGEMMHeuristicsHandle &&) = default; 53 /** (Re)Load the heuristics from reading a dotmlgo file 54 * 55 * @param[in] filename Path to the dotmlgo file 56 * 57 * @return bool Signals if the reload succeeded or failed 58 */ 59 bool reload_from_file(const std::string &filename); 60 /** Return a pointer to underlying heuristics for querying purposes 61 * 62 * @return MLGOHeuristics* 63 */ 64 const mlgo::MLGOHeuristics *get() const; 65 66 private: 67 std::unique_ptr<mlgo::MLGOHeuristics> _heuristics; /**< Pointer to underlying heuristics */ 68 }; 69 70 } // namespace arm_compute 71 72 #endif // ARM_COMPUTE_RUNTIME_CL_CL_GEMM_HEURISTICS_HANDLE_H