xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/dynamic_fusion/runtime/gpu/cl/ClWorkloadRuntime.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 /*
2  * Copyright (c) 2022-2023 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_DYNAMIC_FUSION_RUNTIME_GPU_CL_CLWORKLOADRUNTIME
25 #define ARM_COMPUTE_DYNAMIC_FUSION_RUNTIME_GPU_CL_CLWORKLOADRUNTIME
26 
27 #include "arm_compute/core/TensorInfo.h"
28 #include "arm_compute/dynamic_fusion/sketch/MemoryDescriptor.h"
29 #include <map>
30 #include <memory>
31 
32 namespace arm_compute
33 {
34 /** Forward declaration */
35 class CLTensor;
36 namespace experimental
37 {
38 namespace dynamic_fusion
39 {
40 /** Forward declaration */
41 class GpuWorkloadSketch;
42 
43 /** OpenCL runtime to run a workload
44  */
45 class ClWorkloadRuntime
46 {
47 public:
48     ClWorkloadRuntime();
49     ~ClWorkloadRuntime();
50     /** Configure @ref ClWorkloadRuntime
51      * @note A runtime cannot be re-configured
52      *
53      * @param[in] sketch @ref GpuWorkloadSketch with which to configure
54      */
55     Status configure(const GpuWorkloadSketch &sketch);
56     /** Perform run workload
57      * @note If the runtime is not configured, this method will not perform any action
58      *
59      * @param[in,out] tensors Tensors required by the run workloads
60      *
61      * @return Status If the run is successful
62      */
63     Status run(const std::vector<CLTensor *> &tensors);
64     /** Get auxiliary tensors of the workload and their memory requirement
65      */
66     std::vector<std::tuple<CLTensor *, TensorInfo, AuxMemoryInfo>> get_auxiliary_tensors();
67 
68 private:
69     /** Enqueue prepare workload
70      * @note If the runtime is not configured, this method will not perform any action
71      */
72     void prepare();
73     struct Implementation;
74     std::unique_ptr<Implementation> _impl;
75 };
76 
77 } // namespace dynamic_fusion
78 } // namespace experimental
79 } // namespace arm_compute
80 #endif /* ARM_COMPUTE_DYNAMIC_FUSION_RUNTIME_GPU_CL_CLWORKLOADRUNTIME */
81