Compute Library
 21.11
CLHelpers.h
Go to the documentation of this file.
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_CL_HELPERS_H
25 #define ARM_COMPUTE_CL_HELPERS_H
26 
30 
31 namespace arm_compute
32 {
33 // Forward declarations
34 class CLRuntimeContext;
35 class ICLKernel;
36 
37 /** This function creates an OpenCL context and a device.
38  *
39  * @note In debug builds, the function will automatically enable cl_arm_printf if the driver/device supports it.
40  *
41  * @param[in] cl_backend_type The OpenCL backend type to use.
42  *
43  * @return A std::tuple where the first element is the opencl context, the second element is the opencl device
44  * and the third one an error code. The error code will be CL_SUCCESS upon successful creation, otherwise
45  * a value telling why the function failed.
46  */
47 std::tuple<cl::Context, cl::Device, cl_int> create_opencl_context_and_device(CLBackendType cl_backend_type);
48 /** Schedules a kernel using the context if not nullptr else uses the legacy scheduling flow.
49  *
50  * @param[in] ctx Context to use.
51  * @param[in] kernel Kernel to schedule.
52  * @param[in] flush (Optional) Specifies if the command queue will be flushed after running the kernel.
53  */
54 void schedule_kernel_on_ctx(CLRuntimeContext *ctx, ICLKernel *kernel, bool flush = true);
55 
56 /** This function selects the OpenCL platform based on the backend type.
57  *
58  * @param[in] cl_backend_type The OpenCL backend type to use.
59  *
60  * @return A cl::Platform object.
61  */
62 cl::Platform select_preferable_platform(CLBackendType cl_backend_type);
63 } // namespace arm_compute
64 #endif /* ARM_COMPUTE_CL_HELPERS_H */
void schedule_kernel_on_ctx(CLRuntimeContext *ctx, ICLKernel *kernel, bool flush=true)
Schedules a kernel using the context if not nullptr else uses the legacy scheduling flow...
Definition: CLHelpers.cpp:143
std::tuple< cl::Context, cl::Device, cl_int > create_opencl_context_and_device(CLBackendType cl_backend_type)
This function creates an OpenCL context and a device.
Definition: CLHelpers.cpp:126
Copyright (c) 2017-2021 Arm Limited.
CLBackendType
List the possible OpenCL backends.
Definition: CLTypes.h:53
Wrapper to configure the Khronos OpenCL C++ header.
cl::Platform select_preferable_platform(CLBackendType cl_backend_type)
This function selects the OpenCL platform based on the backend type.
Definition: CLHelpers.cpp:88