Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Dana Zlotnik | 4cdd6b8 | 2021-10-07 15:31:54 +0300 | [diff] [blame] | 2 | * Copyright (c) 2016-2021 Arm Limited. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 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 | */ |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 24 | #ifndef ARM_COMPUTE_ICPPKERNEL_H |
| 25 | #define ARM_COMPUTE_ICPPKERNEL_H |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 26 | |
Moritz Pflanzer | d929b9c | 2017-06-28 10:15:48 +0100 | [diff] [blame] | 27 | #include "arm_compute/core/CPP/CPPTypes.h" |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 28 | #include "arm_compute/core/IKernel.h" |
Michalis Spyrou | bcd2352 | 2020-05-21 15:02:36 +0100 | [diff] [blame] | 29 | #include "arm_compute/core/Types.h" |
| 30 | #include "arm_compute/core/experimental/Types.h" |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 31 | |
| 32 | namespace arm_compute |
| 33 | { |
| 34 | class Window; |
Michalis Spyrou | bcd2352 | 2020-05-21 15:02:36 +0100 | [diff] [blame] | 35 | class ITensor; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 36 | |
| 37 | /** Common interface for all kernels implemented in C++ */ |
| 38 | class ICPPKernel : public IKernel |
| 39 | { |
| 40 | public: |
Dana Zlotnik | 4cdd6b8 | 2021-10-07 15:31:54 +0300 | [diff] [blame] | 41 | static constexpr size_t default_mws = 128; /* Default minimum workload size value */ |
| 42 | static constexpr size_t small_network_mws = 256; /* Default Minimum workload size value for small networks */ |
| 43 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 44 | /** Default destructor */ |
| 45 | virtual ~ICPPKernel() = default; |
| 46 | |
| 47 | /** Execute the kernel on the passed window |
| 48 | * |
| 49 | * @warning If is_parallelisable() returns false then the passed window must be equal to window() |
| 50 | * |
| 51 | * @note The window has to be a region within the window returned by the window() method |
| 52 | * |
| 53 | * @note The width of the window has to be a multiple of num_elems_processed_per_iteration(). |
| 54 | * |
| 55 | * @param[in] window Region on which to execute the kernel. (Must be a region of the window returned by window()) |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 56 | * @param[in] info Info about executing thread and CPU. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 57 | */ |
Joseph Dobson | 6f8b17d | 2020-02-11 19:32:11 +0000 | [diff] [blame] | 58 | virtual void run(const Window &window, const ThreadInfo &info) |
| 59 | { |
Michalis Spyrou | bcd2352 | 2020-05-21 15:02:36 +0100 | [diff] [blame] | 60 | ARM_COMPUTE_UNUSED(window, info); |
Joseph Dobson | 6f8b17d | 2020-02-11 19:32:11 +0000 | [diff] [blame] | 61 | ARM_COMPUTE_ERROR("default implementation of legacy run() virtual member function invoked"); |
| 62 | } |
| 63 | |
| 64 | /** legacy compatibility layer for implemantions which do not support thread_locator |
| 65 | * In these cases we simply narrow the interface down the legacy version |
| 66 | * |
| 67 | * @param[in] window Region on which to execute the kernel. (Must be a region of the window returned by window()) |
| 68 | * @param[in] info Info about executing thread and CPU. |
| 69 | * @param[in] thread_locator Specifies "where" the current thread is in the multi-dimensional space |
| 70 | */ |
| 71 | virtual void run_nd(const Window &window, const ThreadInfo &info, const Window &thread_locator) |
| 72 | { |
| 73 | ARM_COMPUTE_UNUSED(thread_locator); |
| 74 | run(window, info); |
| 75 | } |
Anthony Barbier | e8a4983 | 2018-01-18 10:04:05 +0000 | [diff] [blame] | 76 | |
Michalis Spyrou | bcd2352 | 2020-05-21 15:02:36 +0100 | [diff] [blame] | 77 | /** Execute the kernel on the passed window |
| 78 | * |
| 79 | * @warning If is_parallelisable() returns false then the passed window must be equal to window() |
| 80 | * |
| 81 | * @note The window has to be a region within the window returned by the window() method |
| 82 | * |
| 83 | * @note The width of the window has to be a multiple of num_elems_processed_per_iteration(). |
| 84 | * |
Georgios Pinitas | 0499dff | 2020-07-31 22:21:38 +0100 | [diff] [blame] | 85 | * @param[in] tensors A vector containing the tensors to operate on. |
Michalis Spyrou | bcd2352 | 2020-05-21 15:02:36 +0100 | [diff] [blame] | 86 | * @param[in] window Region on which to execute the kernel. (Must be a region of the window returned by window()) |
| 87 | * @param[in] info Info about executing thread and CPU. |
| 88 | */ |
Georgios Pinitas | 0499dff | 2020-07-31 22:21:38 +0100 | [diff] [blame] | 89 | virtual void run_op(ITensorPack &tensors, const Window &window, const ThreadInfo &info) |
Michalis Spyrou | bcd2352 | 2020-05-21 15:02:36 +0100 | [diff] [blame] | 90 | { |
Georgios Pinitas | 0499dff | 2020-07-31 22:21:38 +0100 | [diff] [blame] | 91 | ARM_COMPUTE_UNUSED(tensors, window, info); |
Michalis Spyrou | bcd2352 | 2020-05-21 15:02:36 +0100 | [diff] [blame] | 92 | } |
| 93 | |
Dana Zlotnik | 4cdd6b8 | 2021-10-07 15:31:54 +0300 | [diff] [blame] | 94 | /** Return minimum workload size of the relevant kernel |
| 95 | * |
| 96 | * @param[in] platform The CPU platform used to create the context. |
| 97 | * @param[in] thread_count Number of threads in the execution. |
| 98 | * |
| 99 | * @return[out] mws Minimum workload size for requsted configuration. |
| 100 | */ |
| 101 | virtual size_t get_mws(const CPUInfo &platform, size_t thread_count) const |
| 102 | { |
| 103 | ARM_COMPUTE_UNUSED(platform, thread_count); |
| 104 | |
| 105 | return default_mws; |
| 106 | } |
| 107 | |
Anthony Barbier | e8a4983 | 2018-01-18 10:04:05 +0000 | [diff] [blame] | 108 | /** Name of the kernel |
| 109 | * |
| 110 | * @return Kernel name |
| 111 | */ |
| 112 | virtual const char *name() const = 0; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 113 | }; |
Gian Marco Iodice | 356f643 | 2017-09-22 11:32:21 +0100 | [diff] [blame] | 114 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 115 | #endif /*ARM_COMPUTE_ICPPKERNEL_H */ |