[SYCL] Plugin Interface And Creation of OpenCL Plugin. #708
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,168 +14,176 @@ | |
| #include <CL/sycl/detail/os_util.hpp> | ||
| #include <CL/sycl/detail/pi.h> | ||
|
|
||
| #include <cassert> | ||
| #include <string> | ||
|
|
||
| // Function to load the shared library | ||
| // Implementation is OS dependent. | ||
| void *loadOsLibrary(const std::string &Library); | ||
|
|
||
| // Function to get Address of a symbol defined in the shared | ||
| // library, implementation is OS dependent. | ||
| void *getOsLibraryFuncAddress(void *Library, const std::string &FunctionName); | ||
|
There was a problem hiding this comment. Wondering if the LLVM Support class DynamicLibrary could be used here - though there might be unintended interaction with the libraries loaded and globally stored by a LLVM runtime compiler. There was a problem hiding this comment. May be worth a further investigation, but it seems to have its own semantics like unloading only at process end, or searching symbol by name in all loaded libraries, and not the specific one, which isn't suitable for our needs here. There was a problem hiding this comment. You are right, too much baggage and unwanted behavior. |
||
|
|
||
| namespace cl { | ||
| namespace sycl { | ||
| namespace detail { | ||
| namespace pi { | ||
| // For selection of SYCL RT back-end, now manually through the "SYCL_BE" | ||
| // environment variable. | ||
| // | ||
| enum Backend { SYCL_BE_PI_OPENCL, SYCL_BE_PI_OTHER }; | ||
|
|
||
| #ifdef SYCL_RT_OS_WINDOWS | ||
| #define PLUGIN_NAME "pi_opencl.dll" | ||
| #else | ||
| #define PLUGIN_NAME "libpi_opencl.so" | ||
| #endif | ||
|
|
||
| // Check for manually selected BE at run-time. | ||
| bool useBackend(Backend Backend); | ||
|
|
||
| using PiResult = ::pi_result; | ||
| using PiPlatform = ::pi_platform; | ||
| using PiDevice = ::pi_device; | ||
| using PiDeviceType = ::pi_device_type; | ||
| using PiDeviceInfo = ::pi_device_info; | ||
| using PiDeviceBinaryType = ::pi_device_binary_type; | ||
| using PiContext = ::pi_context; | ||
| using PiProgram = ::pi_program; | ||
| using PiKernel = ::pi_kernel; | ||
| using PiQueue = ::pi_queue; | ||
| using PiQueueProperties = ::pi_queue_properties; | ||
| using PiMem = ::pi_mem; | ||
| using PiMemFlags = ::pi_mem_flags; | ||
| using PiEvent = ::pi_event; | ||
| using PiSampler = ::pi_sampler; | ||
| using PiSamplerInfo = ::pi_sampler_info; | ||
| using PiSamplerProperties = ::pi_sampler_properties; | ||
| using PiSamplerAddressingMode = ::pi_sampler_addressing_mode; | ||
| using PiSamplerFilterMode = ::pi_sampler_filter_mode; | ||
| using PiMemImageFormat = ::pi_image_format; | ||
| using PiMemImageDesc = ::pi_image_desc; | ||
| using PiMemImageInfo = ::pi_image_info; | ||
| using PiMemObjectType = ::pi_mem_type; | ||
| using PiMemImageChannelOrder = ::pi_image_channel_order; | ||
| using PiMemImageChannelType = ::pi_image_channel_type; | ||
|
|
||
| // Get a string representing a _pi_platform_info enum | ||
| std::string platformInfoToString(pi_platform_info info); | ||
|
|
||
| // Report error and no return (keeps compiler happy about no return statements). | ||
| [[noreturn]] void die(const char *Message); | ||
| void assertion(bool Condition, const char *Message = nullptr); | ||
|
|
||
| // Want all the needed casts be explicit, do not define conversion operators. | ||
| template <class To, class From> To cast(From value); | ||
|
|
||
| // Forward declarations of the PI dispatch entries. | ||
| #define _PI_API(api) __SYCL_EXPORTED extern decltype(::api) *(api); | ||
| #include <CL/sycl/detail/pi.def> | ||
|
|
||
| // Performs PI one-time initialization. | ||
| void initialize(); | ||
|
|
||
| // The PiCall helper structure facilitates performing a call to PI. | ||
| // It holds utilities to do the tracing and to check the returned result. | ||
| // TODO: implement a more mature and controllable tracing of PI calls. | ||
| class PiCall { | ||
| PiResult m_Result; | ||
| static bool m_TraceEnabled; | ||
|
|
||
| public: | ||
| explicit PiCall(const char *Trace = nullptr); | ||
| ~PiCall(); | ||
| PiResult get(PiResult Result); | ||
| template <typename Exception> void check(PiResult Result); | ||
| }; | ||
|
|
||
| // The run-time tracing of PI calls. | ||
| // TODO: replace PiCall completely with this one (PiTrace) | ||
| // | ||
| template <typename T> inline void print(T val) { | ||
| std::cout << "<unknown> : " << val; | ||
| } | ||
|
|
||
| template <> inline void print<>(PiPlatform val) { | ||
| std::cout << "pi_platform : " << val; | ||
| } | ||
| template <> inline void print<>(PiResult val) { | ||
| std::cout << "pi_result : "; | ||
| if (val == PI_SUCCESS) | ||
| std::cout << "PI_SUCCESS"; | ||
| else | ||
| std::cout << val; | ||
| } | ||
|
|
||
| inline void printArgs(void) {} | ||
| template <typename Arg0, typename... Args> | ||
| void printArgs(Arg0 arg0, Args... args) { | ||
| std::cout << std::endl << " "; | ||
| print(arg0); | ||
| printArgs(std::forward<Args>(args)...); | ||
| } | ||
|
|
||
| template <typename FnType> class Trace { | ||
| private: | ||
| FnType m_FnPtr; | ||
| static bool m_TraceEnabled; | ||
|
|
||
| public: | ||
| Trace(FnType FnPtr, const std::string &FnName) : m_FnPtr(FnPtr) { | ||
| if (m_TraceEnabled) | ||
| std::cout << "---> " << FnName << "("; | ||
| } | ||
|
|
||
| template <typename... Args> | ||
| typename std::result_of<FnType(Args...)>::type operator()(Args... args) { | ||
| if (m_TraceEnabled) | ||
| printArgs(args...); | ||
|
|
||
| initialize(); | ||
| auto r = m_FnPtr(args...); | ||
|
|
||
| if (m_TraceEnabled) { | ||
| std::cout << ") ---> "; | ||
| std::cout << (print(r), "") << "\n"; | ||
| } | ||
| return r; | ||
| } | ||
| }; | ||
|
|
||
| template <typename FnType> | ||
| bool Trace<FnType>::m_TraceEnabled = (std::getenv("SYCL_PI_TRACE") != nullptr); | ||
|
|
||
| } // namespace pi | ||
|
|
||
| namespace RT = cl::sycl::detail::pi; | ||
|
|
||
| #define PI_ASSERT(cond, msg) RT::assertion((cond), "assert: " msg); | ||
|
|
||
| #define PI_TRACE(func) RT::Trace<decltype(func)>(func, #func) | ||
|
|
||
| // This does the call, the trace and the check for no errors. | ||
| #define PI_CALL(pi) \ | ||
| RT::initialize(), RT::PiCall(#pi).check<cl::sycl::runtime_error>( \ | ||
| RT::cast<detail::RT::PiResult>(pi)) | ||
|
|
||
| // This does the trace, the call, and returns the result | ||
| #define PI_CALL_RESULT(pi) \ | ||
| RT::PiCall(#pi).get(detail::RT::cast<detail::RT::PiResult>(pi)) | ||
|
|
||
| // This does the check for no errors and possibly throws | ||
| #define PI_CHECK(pi) \ | ||
| RT::PiCall().check<cl::sycl::runtime_error>( \ | ||
| RT::cast<detail::RT::PiResult>(pi)) | ||
|
|
||
| // This does the check for no errors and possibly throws x | ||
| #define PI_CHECK_THROW(pi, x) \ | ||
| RT::PiCall().check<x>(RT::cast<detail::RT::PiResult>(pi)) | ||
|
|
||
| // Want all the needed casts be explicit, do not define conversion operators. | ||
| template <class To, class From> To pi::cast(From value) { | ||
| // TODO: see if more sanity checks are possible. | ||
| PI_ASSERT(sizeof(From) == sizeof(To), "cast failed size check"); | ||
| return (To)(value); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| add_subdirectory(opencl) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please, add empty line before system headers.