1 /* 2 * Copyright (c) 2019-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_EXAMPLES_GEMM_TUNER_COMMON_GEMM_EXAMPLE_OPTIONS 25 #define ARM_COMPUTE_EXAMPLES_GEMM_TUNER_COMMON_GEMM_EXAMPLE_OPTIONS 26 27 #include "arm_compute/core/Types.h" 28 #include "arm_compute/core/Utils.h" 29 #include "arm_compute/runtime/CL/CLTuner.h" 30 #include "utils/TypePrinter.h" 31 #include "utils/command_line/CommandLineOptions.h" 32 #include "utils/command_line/CommandLineParser.h" 33 34 namespace gemm_tuner 35 { 36 /** Structure holding all the common gemm example parameters */ 37 struct CommonGemmExampleParams 38 { 39 size_t M{ 100 }; /**< Number of lhs matrix rows */ 40 size_t N{ 100 }; /**< Number of rhs matrix columns */ 41 size_t K{ 50 }; /**< Number of lhs matrix columns/rhs matrix rows */ 42 size_t B{ 1 }; /**< Batch size */ 43 arm_compute::DataType data_type{ arm_compute::DataType::F32 }; /**< Data type */ 44 arm_compute::CLTunerMode tuner_mode{ arm_compute::CLTunerMode::RAPID }; /**< OpenCL tuner mode */ 45 }; 46 47 /** Formatted output of the CommonGemmExampleParams type 48 * 49 * @param[out] os Output stream. 50 * @param[in] common_params Common parameters to output 51 * 52 * @return Modified output stream. 53 */ 54 ::std::ostream &operator<<(::std::ostream &os, const CommonGemmExampleParams &common_params); 55 56 /** Common command line options used to configure the gemm examples 57 * 58 * The options in this object get populated when "parse()" is called on the parser used to construct it. 59 * The expected workflow is: 60 * 61 * CommandLineParser parser; 62 * CommonOptions options( parser ); 63 * parser.parse(argc, argv); 64 */ 65 class CommonGemmExampleOptions 66 { 67 public: 68 /** Constructor 69 * 70 * @param[in,out] parser A parser on which "parse()" hasn't been called yet. 71 * @param[in] default_data_type Default data type if unspecified. 72 */ 73 CommonGemmExampleOptions(arm_compute::utils::CommandLineParser &parser, arm_compute::DataType default_data_type = arm_compute::DataType::F32); 74 /** Prevent instances of this class from being copied (As this class contains pointers) */ 75 CommonGemmExampleOptions(const CommonGemmExampleOptions &) = delete; 76 /** Prevent instances of this class from being copied (As this class contains pointers) */ 77 CommonGemmExampleOptions &operator=(const CommonGemmExampleOptions &) = delete; 78 /** Allow instances of this class to be moved */ 79 CommonGemmExampleOptions(CommonGemmExampleOptions &&) = default; 80 /** Allow instances of this class to be moved */ 81 CommonGemmExampleOptions &operator=(CommonGemmExampleOptions &&) = default; 82 /** Default destructor */ 83 ~CommonGemmExampleOptions() = default; 84 85 arm_compute::utils::ToggleOption *help; /**< Show help option */ 86 arm_compute::utils::SimpleOption<size_t> *M; /**< Number of lhs matrix rows option */ 87 arm_compute::utils::SimpleOption<size_t> *N; /**< Number of rhs matrix columns option */ 88 arm_compute::utils::SimpleOption<size_t> *K; /**< Number of lhs matrix columns/rhs matrix rows option */ 89 arm_compute::utils::SimpleOption<size_t> *B; /**< Batch size option */ 90 arm_compute::utils::EnumOption<arm_compute::DataType> *data_type; /**< Data type */ 91 arm_compute::utils::EnumOption<arm_compute::CLTunerMode> *tuner_mode; /**< OpenCL tuner mode */ 92 }; 93 94 /** Consumes the common gemm example options and creates a structure containing all information 95 * 96 * @param[in] options Options to consume 97 * 98 * @return Structure containing the common gemm example parameters 99 */ 100 CommonGemmExampleParams consume_common_gemm_example_parameters(const CommonGemmExampleOptions &options); 101 } // namespace gemm_tuner 102 #endif /* ARM_COMPUTE_EXAMPLES_GEMM_TUNER_COMMON_GEMM_EXAMPLE_OPTIONS */ 103