Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Viet-Hoa Do | f8bb092 | 2022-05-30 15:15:15 +0100 | [diff] [blame] | 2 | * Copyright (c) 2016-2022 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_OPENCL_H |
| 25 | #define ARM_COMPUTE_OPENCL_H |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 26 | |
Moritz Pflanzer | 725788e | 2017-07-07 15:35:56 +0100 | [diff] [blame] | 27 | #include <string> |
| 28 | #include <utility> |
| 29 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 30 | /* Configure the Khronos C++ wrapper to target OpenCL 1.2: */ |
Anthony Barbier | 340a272 | 2018-01-03 16:21:54 +0000 | [diff] [blame] | 31 | #ifndef ARM_COMPUTE_NO_EXCEPTIONS |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 32 | #define CL_HPP_ENABLE_EXCEPTIONS |
Anthony Barbier | 340a272 | 2018-01-03 16:21:54 +0000 | [diff] [blame] | 33 | #endif // ARM_COMPUTE_NO_EXCEPTIONS |
Viet-Hoa Do | f8bb092 | 2022-05-30 15:15:15 +0100 | [diff] [blame] | 34 | #define CL_TARGET_OPENCL_VERSION 300 |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 35 | #define CL_HPP_TARGET_OPENCL_VERSION 110 |
| 36 | #define CL_HPP_MINIMUM_OPENCL_VERSION 110 |
Anthony Barbier | 8b2fdc9 | 2018-08-09 11:42:38 +0100 | [diff] [blame] | 37 | #pragma GCC diagnostic push |
| 38 | #pragma GCC diagnostic ignored "-Weffc++" |
| 39 | #pragma GCC diagnostic ignored "-Wignored-qualifiers" |
Michalis Spyrou | 6bff195 | 2019-10-02 17:22:11 +0100 | [diff] [blame] | 40 | #pragma GCC diagnostic ignored "-Wunused-parameter" |
Georgios Pinitas | 67d94d2 | 2018-10-09 18:48:37 +0100 | [diff] [blame] | 41 | #if defined(__GNUG__) && __GNUG__ >= 8 |
| 42 | #pragma GCC diagnostic ignored "-Wcatch-value" |
| 43 | #endif // defined(__GNUG__) && __GNUG__ >= 8 |
Pablo Marquez Tello | dc2282f | 2021-11-23 15:16:00 +0000 | [diff] [blame] | 44 | #include <CL/opencl.hpp> // include new hpp header instead of cl2.hpp |
Anthony Barbier | 8b2fdc9 | 2018-08-09 11:42:38 +0100 | [diff] [blame] | 45 | #pragma GCC diagnostic pop |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 46 | |
| 47 | namespace cl |
| 48 | { |
| 49 | static const NDRange Range_128_1 = NDRange(128, 1); |
Moritz Pflanzer | 725788e | 2017-07-07 15:35:56 +0100 | [diff] [blame] | 50 | } // namespace cl |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 51 | |
| 52 | namespace arm_compute |
| 53 | { |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 54 | /** Check if OpenCL is available. |
| 55 | * |
| 56 | * @return True if OpenCL is available. |
| 57 | */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 58 | bool opencl_is_available(); |
Moritz Pflanzer | 725788e | 2017-07-07 15:35:56 +0100 | [diff] [blame] | 59 | |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 60 | /** Class for loading OpenCL symbols. */ |
Moritz Pflanzer | 725788e | 2017-07-07 15:35:56 +0100 | [diff] [blame] | 61 | class CLSymbols final |
| 62 | { |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 63 | public: |
Georgios Pinitas | 7ae80a9 | 2019-10-25 18:25:17 +0100 | [diff] [blame] | 64 | /** Default Constructor */ |
Georgios Pinitas | 0b192e8 | 2020-02-20 17:09:28 +0000 | [diff] [blame] | 65 | CLSymbols() noexcept(false); |
Georgios Pinitas | 7ae80a9 | 2019-10-25 18:25:17 +0100 | [diff] [blame] | 66 | /** Load OpenCL symbols from handle |
| 67 | * |
| 68 | * @param[in] handle Handle to load symbols from |
| 69 | */ |
Moritz Pflanzer | 725788e | 2017-07-07 15:35:56 +0100 | [diff] [blame] | 70 | void load_symbols(void *handle); |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 71 | /** Get the static instance of CLSymbols. |
| 72 | * |
| 73 | * @return The static instance of CLSymbols. |
| 74 | */ |
Moritz Pflanzer | 725788e | 2017-07-07 15:35:56 +0100 | [diff] [blame] | 75 | static CLSymbols &get(); |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 76 | /** Load symbols from the given OpenCL library path. |
| 77 | * |
ohadagoogle | 3efdfb3 | 2022-06-20 16:16:13 +0000 | [diff] [blame] | 78 | * @param[in] library Path to the OpenCL library. |
| 79 | * @param[in] use_loader Use symbol loader function loadOpenCLPointer. |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 80 | * |
| 81 | * @return True if loading the library is successful. |
| 82 | */ |
ohadagoogle | 3efdfb3 | 2022-06-20 16:16:13 +0000 | [diff] [blame] | 83 | bool load(const std::string &library, bool use_loader = false); |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 84 | /** Load symbols from any of the default OpenCL library names. |
| 85 | * |
| 86 | * @return True if loading any library is successful. |
| 87 | */ |
Moritz Pflanzer | 725788e | 2017-07-07 15:35:56 +0100 | [diff] [blame] | 88 | bool load_default(); |
| 89 | |
Anthony Barbier | 58c4ff1 | 2017-11-09 09:15:32 +0000 | [diff] [blame] | 90 | #define DECLARE_FUNCTION_PTR(func_name) \ |
| 91 | std::function<decltype(func_name)> func_name##_ptr = nullptr |
Moritz Pflanzer | 725788e | 2017-07-07 15:35:56 +0100 | [diff] [blame] | 92 | |
Anthony Barbier | b6eb353 | 2018-08-08 13:20:04 +0100 | [diff] [blame] | 93 | DECLARE_FUNCTION_PTR(clCreateContext); |
Anthony Barbier | a9e1533 | 2017-12-22 16:37:30 +0000 | [diff] [blame] | 94 | DECLARE_FUNCTION_PTR(clCreateContextFromType); |
| 95 | DECLARE_FUNCTION_PTR(clCreateCommandQueue); |
Georgios Pinitas | c3c352e | 2021-03-18 10:59:40 +0000 | [diff] [blame] | 96 | DECLARE_FUNCTION_PTR(clCreateCommandQueueWithProperties); |
Anthony Barbier | a9e1533 | 2017-12-22 16:37:30 +0000 | [diff] [blame] | 97 | DECLARE_FUNCTION_PTR(clGetContextInfo); |
Anthony Barbier | 58c4ff1 | 2017-11-09 09:15:32 +0000 | [diff] [blame] | 98 | DECLARE_FUNCTION_PTR(clBuildProgram); |
| 99 | DECLARE_FUNCTION_PTR(clEnqueueNDRangeKernel); |
| 100 | DECLARE_FUNCTION_PTR(clSetKernelArg); |
| 101 | DECLARE_FUNCTION_PTR(clReleaseKernel); |
| 102 | DECLARE_FUNCTION_PTR(clCreateProgramWithSource); |
| 103 | DECLARE_FUNCTION_PTR(clCreateBuffer); |
| 104 | DECLARE_FUNCTION_PTR(clRetainKernel); |
| 105 | DECLARE_FUNCTION_PTR(clCreateKernel); |
| 106 | DECLARE_FUNCTION_PTR(clGetProgramInfo); |
| 107 | DECLARE_FUNCTION_PTR(clFlush); |
| 108 | DECLARE_FUNCTION_PTR(clFinish); |
| 109 | DECLARE_FUNCTION_PTR(clReleaseProgram); |
| 110 | DECLARE_FUNCTION_PTR(clRetainContext); |
| 111 | DECLARE_FUNCTION_PTR(clCreateProgramWithBinary); |
| 112 | DECLARE_FUNCTION_PTR(clReleaseCommandQueue); |
| 113 | DECLARE_FUNCTION_PTR(clEnqueueMapBuffer); |
| 114 | DECLARE_FUNCTION_PTR(clRetainProgram); |
| 115 | DECLARE_FUNCTION_PTR(clGetProgramBuildInfo); |
| 116 | DECLARE_FUNCTION_PTR(clEnqueueReadBuffer); |
| 117 | DECLARE_FUNCTION_PTR(clEnqueueWriteBuffer); |
| 118 | DECLARE_FUNCTION_PTR(clReleaseEvent); |
| 119 | DECLARE_FUNCTION_PTR(clReleaseContext); |
| 120 | DECLARE_FUNCTION_PTR(clRetainCommandQueue); |
| 121 | DECLARE_FUNCTION_PTR(clEnqueueUnmapMemObject); |
| 122 | DECLARE_FUNCTION_PTR(clRetainMemObject); |
| 123 | DECLARE_FUNCTION_PTR(clReleaseMemObject); |
| 124 | DECLARE_FUNCTION_PTR(clGetDeviceInfo); |
| 125 | DECLARE_FUNCTION_PTR(clGetDeviceIDs); |
Georgios Pinitas | df31036 | 2018-11-14 13:16:56 +0000 | [diff] [blame] | 126 | DECLARE_FUNCTION_PTR(clGetMemObjectInfo); |
Anthony Barbier | 58c4ff1 | 2017-11-09 09:15:32 +0000 | [diff] [blame] | 127 | DECLARE_FUNCTION_PTR(clRetainEvent); |
Michalis Spyrou | 402740d | 2021-04-20 11:26:21 +0100 | [diff] [blame] | 128 | DECLARE_FUNCTION_PTR(clGetPlatformInfo); |
Anthony Barbier | 58c4ff1 | 2017-11-09 09:15:32 +0000 | [diff] [blame] | 129 | DECLARE_FUNCTION_PTR(clGetPlatformIDs); |
| 130 | DECLARE_FUNCTION_PTR(clGetKernelWorkGroupInfo); |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 131 | DECLARE_FUNCTION_PTR(clGetCommandQueueInfo); |
| 132 | DECLARE_FUNCTION_PTR(clGetKernelInfo); |
| 133 | DECLARE_FUNCTION_PTR(clGetEventProfilingInfo); |
Pablo Tello | e86a09f | 2018-01-11 15:44:48 +0000 | [diff] [blame] | 134 | DECLARE_FUNCTION_PTR(clSVMAlloc); |
| 135 | DECLARE_FUNCTION_PTR(clSVMFree); |
| 136 | DECLARE_FUNCTION_PTR(clEnqueueSVMMap); |
| 137 | DECLARE_FUNCTION_PTR(clEnqueueSVMUnmap); |
Georgios Pinitas | d9eb275 | 2018-04-03 13:44:29 +0100 | [diff] [blame] | 138 | DECLARE_FUNCTION_PTR(clEnqueueMarker); |
| 139 | DECLARE_FUNCTION_PTR(clWaitForEvents); |
Gian Marco Iodice | a98dee2 | 2020-06-02 12:12:35 +0100 | [diff] [blame] | 140 | DECLARE_FUNCTION_PTR(clCreateImage); |
Manuel Bottini | be9f9f9 | 2021-01-25 15:07:17 +0000 | [diff] [blame] | 141 | DECLARE_FUNCTION_PTR(clSetKernelExecInfo); |
Anthony Barbier | 58c4ff1 | 2017-11-09 09:15:32 +0000 | [diff] [blame] | 142 | |
Georgios Pinitas | 4d0351c | 2019-04-03 15:11:16 +0100 | [diff] [blame] | 143 | // Third-party extensions |
| 144 | DECLARE_FUNCTION_PTR(clImportMemoryARM); |
| 145 | |
Anthony Barbier | 58c4ff1 | 2017-11-09 09:15:32 +0000 | [diff] [blame] | 146 | #undef DECLARE_FUNCTION_PTR |
Moritz Pflanzer | 725788e | 2017-07-07 15:35:56 +0100 | [diff] [blame] | 147 | |
| 148 | private: |
Georgios Pinitas | 0b192e8 | 2020-02-20 17:09:28 +0000 | [diff] [blame] | 149 | std::pair<bool, bool> _loaded; |
Moritz Pflanzer | 725788e | 2017-07-07 15:35:56 +0100 | [diff] [blame] | 150 | }; |
| 151 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 152 | #endif /* ARM_COMPUTE_OPENCL_H */ |