[SYCL] Enhance PI tracing with printing output (pointer) arguments

sycl/include/CL/sycl/detail/pi.hpp

@@ -169,82 +169,6 @@ uint64_t emitFunctionBeginTrace(const char *FName);
 /// \param FName The name of the PI API call
 void emitFunctionEndTrace(uint64_t CorrelationID, const char *FName);
 
-// Helper utilities for PI Tracing
-// The run-time tracing of PI calls.
-// Print functions used by Trace class.
-template <typename T> inline void print(T val) {
-  std::cout << "<unknown> : " << val << std::endl;
-}
-
-template <> inline void print<>(PiPlatform val) {
-  std::cout << "pi_platform : " << val << std::endl;
-}
-
-template <> inline void print<>(pi_buffer_region rgn) {
-  std::cout << "pi_buffer_region origin/size : " << rgn->origin << "/"
-            << rgn->size << std::endl;
-}
-
-template <> inline void print<>(pi_buff_rect_region rgn) {
-  std::cout << "pi_buff_rect_region width_bytes/height/depth : "
-            << rgn->width_bytes << "/" << rgn->height_scalar << "/"
-            << rgn->depth_scalar << std::endl;
-}
-
-template <> inline void print<>(pi_buff_rect_offset off) {
-  std::cout << "pi_buff_rect_offset x_bytes/y/z : " << off->x_bytes << "/"
-            << off->y_scalar << "/" << off->z_scalar << std::endl;
-}
-
-template <> inline void print<>(pi_image_region rgn) {
-  std::cout << "pi_image_region width/height/depth : " << rgn->width << "/"
-            << rgn->height << "/" << rgn->depth << std::endl;
-}
-
-template <> inline void print<>(pi_image_offset off) {
-  std::cout << "pi_image_offset x/y/z : " << off->x << "/" << off->y << "/"
-            << off->z << std::endl;
-}
-
-template <> inline void print<>(const pi_image_desc *desc) {
-  std::cout << "image_desc w/h/d : " << desc->image_width << " / "
-            << desc->image_height << " / " << desc->image_depth
-            << "  --  arrSz/row/slice : " << desc->image_array_size << " / "
-            << desc->image_row_pitch << " / " << desc->image_slice_pitch
-            << "  --  num_mip_lvls/num_smpls/image_type : "
-            << desc->num_mip_levels << " / " << desc->num_samples << " / "
-            << desc->image_type << std::endl;
-}
-
-template <> inline void print<>(PiResult val) {
-  std::cout << "pi_result : ";
-  if (val == PI_SUCCESS)
-    std::cout << "PI_SUCCESS" << std::endl;
-  else
-    std::cout << val << std::endl;
-}
-
-// cout does not resolve a nullptr.
-template <> inline void print<>(std::nullptr_t) {
-  std::cout << "<nullptr>" << std::endl;
-}
-
-template <> inline void print<>(char *val) {
-  std::cout << "<char * > : " << static_cast<void *>(val) << std::endl;
-}
-
-template <> inline void print<>(const char *val) {
-  std::cout << "<const char *>: " << val << std::endl;
-}
-
-inline void printArgs(void) {}
-template <typename Arg0, typename... Args>
-void printArgs(Arg0 arg0, Args... args) {
-  std::cout << "       ";
-  print(arg0);
-  pi::printArgs(std::forward<Args>(args)...);
-}
-
 // A wrapper for passing around byte array properties
 class ByteArray {
 public:

sycl/source/detail/plugin.hpp

@@ -11,6 +11,7 @@
 #include <CL/sycl/detail/common.hpp>
 #include <CL/sycl/detail/pi.hpp>
 #include <CL/sycl/stl.hpp>
+#include <detail/plugin_printers.hpp>
 
 #ifdef XPTI_ENABLE_INSTRUMENTATION
 // Include the headers necessary for emitting traces using the trace framework
@@ -81,6 +82,8 @@ class plugin {
     if (pi::trace(pi::TraceLevel::PI_TRACE_CALLS)) {
       std::cout << ") ---> ";
       RT::printArgs(R);
+      RT::printOuts(Args...);
+      std::cout << std::endl;
     }
 #ifdef XPTI_ENABLE_INSTRUMENTATION
     // Close the function begin with a call to function end

sycl/source/detail/plugin_printers.hpp

@@ -0,0 +1,171 @@
+//==--------- plugin_printers.hpp - Printers for the Plugin Interface ------==//
+//
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+//
+//===----------------------------------------------------------------------===//
+
+// Print functions used for the Plguin Interface tracing.
+
+#pragma once
+
+#include <CL/sycl/detail/pi.hpp>
+
+__SYCL_INLINE_NAMESPACE(cl) {
+namespace sycl {
+namespace detail {
+namespace pi {
+
+template <typename T> inline void print(T val) {
+  std::cout << "<unknown> : " << val << std::endl;
+}
+
+template <> inline void print<>(PiPlatform val) {
+  std::cout << "pi_platform : " << val << std::endl;
+}
+
+template <> inline void print<>(PiEvent val) {
+  std::cout << "pi_event : " << val << std::endl;
+}
+
+template <> inline void print<>(PiMem val) {
+  std::cout << "pi_mem : " << val << std::endl;
+}
+
+template <> inline void print<>(PiEvent *val) {
+  std::cout << "pi_event * : " << val;
+  if (val)
+    std::cout << "[ " << *val << " ... ]";
+  else
+    std::cout << "[ nullptr ]";
+  std::cout << std::endl;
+}
+
+template <> inline void print<>(const PiEvent *val) {
+  std::cout << "const pi_event * : " << val;
+  if (val)
+    std::cout << "[ " << *val << " ... ]";
+  else
+    std::cout << "[ nullptr ]";
+  std::cout << std::endl;
+}
+
+template <> inline void print<>(pi_buffer_region rgn) {
+  std::cout << "pi_buffer_region origin/size : " << rgn->origin << "/"
+            << rgn->size << std::endl;
+}
+
+template <> inline void print<>(pi_buff_rect_region rgn) {
+  std::cout << "pi_buff_rect_region width_bytes/height/depth : "
+            << rgn->width_bytes << "/" << rgn->height_scalar << "/"
+            << rgn->depth_scalar << std::endl;
+}
+
+template <> inline void print<>(pi_buff_rect_offset off) {
+  std::cout << "pi_buff_rect_offset x_bytes/y/z : " << off->x_bytes << "/"
+            << off->y_scalar << "/" << off->z_scalar << std::endl;
+}
+
+template <> inline void print<>(pi_image_region rgn) {
+  std::cout << "pi_image_region width/height/depth : " << rgn->width << "/"
+            << rgn->height << "/" << rgn->depth << std::endl;
+}
+
+template <> inline void print<>(pi_image_offset off) {
+  std::cout << "pi_image_offset x/y/z : " << off->x << "/" << off->y << "/"
+            << off->z << std::endl;
+}
+
+template <> inline void print<>(const pi_image_desc *desc) {
+  std::cout << "image_desc w/h/d : " << desc->image_width << " / "
+            << desc->image_height << " / " << desc->image_depth
+            << "  --  arrSz/row/slice : " << desc->image_array_size << " / "
+            << desc->image_row_pitch << " / " << desc->image_slice_pitch
+            << "  --  num_mip_lvls/num_smpls/image_type : "
+            << desc->num_mip_levels << " / " << desc->num_samples << " / "
+            << desc->image_type << std::endl;
+}
+
+template <> inline void print<>(PiResult val) {
+  std::cout << "pi_result : ";
+  if (val == PI_SUCCESS)
+    std::cout << "PI_SUCCESS" << std::endl;
+  else
+    std::cout << val << std::endl;
+}
+
+// cout does not resolve a nullptr.
+template <> inline void print<>(std::nullptr_t) {
+  std::cout << "<nullptr>" << std::endl;
+}
+
+template <> inline void print<>(char *val) {
+  std::cout << "<char * > : " << static_cast<void *>(val) << std::endl;
+}
+
+template <> inline void print<>(const char *val) {
+  std::cout << "<const char *>: " << val << std::endl;
+}
+
+inline void printArgs(void) {}
+template <typename Arg0, typename... Args>
+void printArgs(Arg0 arg0, Args... args) {
+  std::cout << "\t";
+  print(arg0);
+  pi::printArgs(std::forward<Args>(args)...);
+}
+
+template <typename T> struct printOut {
+  printOut(T val) {}
+}; // Do nothing
+
+template <> struct printOut<PiEvent *> {
+  printOut(PiEvent *val) {
+    std::cout << "\t[out]pi_event * : " << val;
+    if (val)
+      std::cout << "[ " << *val << " ... ]";
+    else
+      std::cout << "[ nullptr ]";
+    std::cout << std::endl;
+  }
+};
+
+template <> struct printOut<PiMem *> {
+  printOut(PiMem *val) {
+    std::cout << "\t[out]pi_mem * : " << val;
+    if (val)
+      std::cout << "[ " << *val << " ... ]";
+    else
+      std::cout << "[ nullptr ]";
+    std::cout << std::endl;
+  }
+};
+
+template <> struct printOut<void *> {
+  printOut(void *val) { std::cout << "\t[out]void * : " << val << std::endl; }
+};
+
+template <typename T> struct printOut<T **> {
+  printOut(T **val) {
+    std::cout << "\t[out]<unknown> ** : " << val;
+    if (val)
+      std::cout << "[ " << *val << " ... ]";
+    else
+      std::cout << "[ nullptr ]";
+    std::cout << std::endl;
+  }
+};
+
+inline void printOuts(void) {}
+template <typename Arg0, typename... Args>
+void printOuts(Arg0 arg0, Args... args) {
+  using T = decltype(arg0);
+  printOut<T> a(arg0);
+  printOuts(std::forward<Args>(args)...);
+}
+
+} // namespace pi
+} // namespace detail
+} // namespace sycl
+} // __SYCL_INLINE_NAMESPACE(cl)