Skip to content

[SYCL][PI] Make the Plugin Interface tracing thread-safe #2948

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 25, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions sycl/source/detail/plugin.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
#include <CL/sycl/detail/pi.hpp>
#include <CL/sycl/stl.hpp>
#include <detail/plugin_printers.hpp>
#include <memory>
#include <mutex>

#ifdef XPTI_ENABLE_INSTRUMENTATION
// Include the headers necessary for emitting traces using the trace framework
Expand All @@ -33,7 +35,8 @@ class plugin {
plugin() = delete;

plugin(RT::PiPlugin Plugin, backend UseBackend)
: MPlugin(Plugin), MBackend(UseBackend) {}
: MPlugin(Plugin), MBackend(UseBackend),
TracingMutex(std::make_shared<std::mutex>()) {}

plugin &operator=(const plugin &) = default;
plugin(const plugin &) = default;
Expand Down Expand Up @@ -73,13 +76,12 @@ class plugin {
std::string PIFnName = PiCallInfo.getFuncName();
uint64_t CorrelationID = pi::emitFunctionBeginTrace(PIFnName.c_str());
#endif
RT::PiResult R = PiCallInfo.getFuncPtr(MPlugin)(Args...);
if (pi::trace(pi::TraceLevel::PI_TRACE_CALLS)) {
std::lock_guard<std::mutex> Guard(*TracingMutex);
std::string FnName = PiCallInfo.getFuncName();
std::cout << "---> " << FnName << "(" << std::endl;
RT::printArgs(Args...);
}
RT::PiResult R = PiCallInfo.getFuncPtr(MPlugin)(Args...);
if (pi::trace(pi::TraceLevel::PI_TRACE_CALLS)) {
std::cout << ") ---> ";
RT::printArgs(R);
RT::printOuts(Args...);
Expand All @@ -106,6 +108,7 @@ class plugin {
private:
RT::PiPlugin MPlugin;
backend MBackend;
std::shared_ptr<std::mutex> TracingMutex;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be

Suggested change
std::shared_ptr<std::mutex> TracingMutex;
std::shared_ptr<std::mutex> MTracingMutex;

?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please clarify why std::mutex is wrapped with std::shared_ptr?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because mutex object cannot be copied.

}; // class plugin
} // namespace detail
} // namespace sycl
Expand Down