| /* |
| * Copyright (c) 2016-2023 Arm Limited. |
| * |
| * SPDX-License-Identifier: MIT |
| * |
| * Permission is hereby granted, free of charge, to any person obtaining a copy |
| * of this software and associated documentation files (the "Software"), to |
| * deal in the Software without restriction, including without limitation the |
| * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
| * sell copies of the Software, and to permit persons to whom the Software is |
| * furnished to do so, subject to the following conditions: |
| * |
| * The above copyright notice and this permission notice shall be included in all |
| * copies or substantial portions of the Software. |
| * |
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| * SOFTWARE. |
| */ |
| #ifndef ACL_ARM_COMPUTE_CORE_CL_OPENCL_H |
| #define ACL_ARM_COMPUTE_CORE_CL_OPENCL_H |
| |
| #include <string> |
| #include <utility> |
| |
| /* Configure the Khronos C++ wrapper to target OpenCL 1.2: */ |
| #ifndef ARM_COMPUTE_NO_EXCEPTIONS |
| #define CL_HPP_ENABLE_EXCEPTIONS |
| #endif // ARM_COMPUTE_NO_EXCEPTIONS |
| #define CL_TARGET_OPENCL_VERSION 300 |
| #define CL_HPP_TARGET_OPENCL_VERSION 110 |
| #define CL_HPP_MINIMUM_OPENCL_VERSION 110 |
| #pragma GCC diagnostic push |
| #pragma GCC diagnostic ignored "-Weffc++" |
| #pragma GCC diagnostic ignored "-Wignored-qualifiers" |
| #pragma GCC diagnostic ignored "-Wunused-parameter" |
| #if defined(__GNUG__) && __GNUG__ >= 8 |
| #pragma GCC diagnostic ignored "-Wcatch-value" |
| #endif // defined(__GNUG__) && __GNUG__ >= 8 |
| #include <CL/opencl.hpp> // include new hpp header instead of cl2.hpp |
| #pragma GCC diagnostic pop |
| |
| namespace cl |
| { |
| static const NDRange Range_128_1 = NDRange(128, 1); |
| } // namespace cl |
| |
| namespace arm_compute |
| { |
| /** Check if OpenCL is available. |
| * |
| * @return True if OpenCL is available. |
| */ |
| bool opencl_is_available(); |
| |
| /** Class for loading OpenCL symbols. */ |
| class CLSymbols final |
| { |
| public: |
| /** Default Constructor */ |
| CLSymbols() noexcept(false); |
| /** Load OpenCL symbols from handle |
| * |
| * @param[in] handle Handle to load symbols from |
| */ |
| void load_symbols(void *handle); |
| /** Get the static instance of CLSymbols. |
| * |
| * @return The static instance of CLSymbols. |
| */ |
| static CLSymbols &get(); |
| /** This method attempts to load the OpenCL symbols from the first available library from the provided OpenCL libraries. |
| * |
| * @param[in] libraries_filenames Vector containing the filenames of the libraries to be loaded. |
| * @param[in] use_loader Use symbol loader function loadOpenCLPointer. |
| * |
| * @return True if loading the library is successful. False if all the provided libraries could not be loaded. |
| */ |
| bool load(const std::vector<std::string> &libraries_filenames, bool use_loader = false); |
| /** Load symbols from any of the default OpenCL library names. |
| * If all the default libraries could not be loaded, this method will print a warning message and return false. |
| * |
| * @return True if loading any library is successful. |
| */ |
| bool load_default(); |
| |
| #define DECLARE_FUNCTION_PTR(func_name) std::function<decltype(func_name)> func_name##_ptr = nullptr |
| |
| DECLARE_FUNCTION_PTR(clCreateContext); |
| DECLARE_FUNCTION_PTR(clCreateContextFromType); |
| DECLARE_FUNCTION_PTR(clCreateCommandQueue); |
| DECLARE_FUNCTION_PTR(clCreateCommandQueueWithProperties); |
| DECLARE_FUNCTION_PTR(clGetContextInfo); |
| DECLARE_FUNCTION_PTR(clBuildProgram); |
| DECLARE_FUNCTION_PTR(clEnqueueNDRangeKernel); |
| DECLARE_FUNCTION_PTR(clSetKernelArg); |
| DECLARE_FUNCTION_PTR(clReleaseKernel); |
| DECLARE_FUNCTION_PTR(clCreateProgramWithSource); |
| DECLARE_FUNCTION_PTR(clCreateBuffer); |
| DECLARE_FUNCTION_PTR(clRetainKernel); |
| DECLARE_FUNCTION_PTR(clCreateKernel); |
| DECLARE_FUNCTION_PTR(clGetProgramInfo); |
| DECLARE_FUNCTION_PTR(clFlush); |
| DECLARE_FUNCTION_PTR(clFinish); |
| DECLARE_FUNCTION_PTR(clReleaseProgram); |
| DECLARE_FUNCTION_PTR(clRetainContext); |
| DECLARE_FUNCTION_PTR(clCreateProgramWithBinary); |
| DECLARE_FUNCTION_PTR(clReleaseCommandQueue); |
| DECLARE_FUNCTION_PTR(clEnqueueMapBuffer); |
| DECLARE_FUNCTION_PTR(clRetainProgram); |
| DECLARE_FUNCTION_PTR(clGetProgramBuildInfo); |
| DECLARE_FUNCTION_PTR(clEnqueueReadBuffer); |
| DECLARE_FUNCTION_PTR(clEnqueueWriteBuffer); |
| DECLARE_FUNCTION_PTR(clReleaseEvent); |
| DECLARE_FUNCTION_PTR(clReleaseContext); |
| DECLARE_FUNCTION_PTR(clRetainCommandQueue); |
| DECLARE_FUNCTION_PTR(clEnqueueUnmapMemObject); |
| DECLARE_FUNCTION_PTR(clRetainMemObject); |
| DECLARE_FUNCTION_PTR(clReleaseMemObject); |
| DECLARE_FUNCTION_PTR(clGetDeviceInfo); |
| DECLARE_FUNCTION_PTR(clGetDeviceIDs); |
| DECLARE_FUNCTION_PTR(clGetMemObjectInfo); |
| DECLARE_FUNCTION_PTR(clRetainEvent); |
| DECLARE_FUNCTION_PTR(clGetPlatformInfo); |
| DECLARE_FUNCTION_PTR(clGetPlatformIDs); |
| DECLARE_FUNCTION_PTR(clGetKernelWorkGroupInfo); |
| DECLARE_FUNCTION_PTR(clGetCommandQueueInfo); |
| DECLARE_FUNCTION_PTR(clGetKernelInfo); |
| DECLARE_FUNCTION_PTR(clGetEventProfilingInfo); |
| DECLARE_FUNCTION_PTR(clSVMAlloc); |
| DECLARE_FUNCTION_PTR(clSVMFree); |
| DECLARE_FUNCTION_PTR(clEnqueueSVMMap); |
| DECLARE_FUNCTION_PTR(clEnqueueSVMUnmap); |
| DECLARE_FUNCTION_PTR(clEnqueueMarker); |
| DECLARE_FUNCTION_PTR(clWaitForEvents); |
| DECLARE_FUNCTION_PTR(clCreateImage); |
| DECLARE_FUNCTION_PTR(clSetKernelExecInfo); |
| DECLARE_FUNCTION_PTR(clGetExtensionFunctionAddressForPlatform); |
| |
| // Command buffer and mutable dispatch command buffer extensions |
| DECLARE_FUNCTION_PTR(clCreateCommandBufferKHR); |
| DECLARE_FUNCTION_PTR(clRetainCommandBufferKHR); |
| DECLARE_FUNCTION_PTR(clReleaseCommandBufferKHR); |
| DECLARE_FUNCTION_PTR(clFinalizeCommandBufferKHR); |
| DECLARE_FUNCTION_PTR(clEnqueueCommandBufferKHR); |
| DECLARE_FUNCTION_PTR(clCommandNDRangeKernelKHR); |
| |
| DECLARE_FUNCTION_PTR(clUpdateMutableCommandsKHR); |
| |
| // Third-party extensions |
| DECLARE_FUNCTION_PTR(clImportMemoryARM); |
| |
| #undef DECLARE_FUNCTION_PTR |
| |
| private: |
| std::pair<bool, bool> _loaded; |
| }; |
| } // namespace arm_compute |
| #endif // ACL_ARM_COMPUTE_CORE_CL_OPENCL_H |