Get XDP init and exit runs using a callback from XDP code

Signed-off-by: Rahul Bramandlapalli <[email protected]>

Author: rbramand-xilinx

src/runtime_src/core/common/api/hw_context_int.h

@@ -8,7 +8,6 @@
 // This file defines implementation extensions to the XRT XCLBIN APIs.
 #include "core/include/xrt/xrt_hw_context.h"
 #include "core/include/xrt/experimental/xrt_module.h"
-#include "core/include/xrt/xrt_kernel.h"
 
 #include <cstdint>
 
@@ -71,23 +70,6 @@ get_scratchpad_mem_buf(const xrt::hw_context& hwctx, size_t size_per_col);
 void
 dump_scratchpad_mem(const xrt::hw_context& hwctx);
 
-// APIs used by XDP to register init and exit runs
-// These runs will be used to initialize AI array and collect profile/trace data
-// These runs are added to runlist at the beginning and end respectively
-XRT_CORE_COMMON_EXPORT
-void
-register_xdp_init_run(const xrt::hw_context& ctx, const xrt::run& run);
-
-XRT_CORE_COMMON_EXPORT
-void
-register_xdp_exit_run(const xrt::hw_context& ctx, const xrt::run& run);
-
-const std::vector<xrt::run>&
-get_xdp_init_runs(const xrt::hw_context& ctx);
-
-const std::vector<xrt::run>&
-get_xdp_exit_runs(const xrt::hw_context& ctx);
-
 }} // hw_context_int, xrt_core
 
 #endif

src/runtime_src/core/common/api/xrt_hw_context.cpp

@@ -12,7 +12,6 @@
 #include "core/common/time.h"
 #include "core/common/utils.h"
 #include "core/include/xrt/xrt_hw_context.h"
-#include "core/include/xrt/xrt_kernel.h"
 #include "core/include/xrt/experimental/xrt_ext.h"
 #include "core/include/xrt/experimental/xrt_module.h"
 #include "bo_int.h"
@@ -153,11 +152,6 @@ class hw_context_impl : public std::enable_shared_from_this<hw_context_impl>
   // are saved to a scratchpad memory allocated specifically for that context.
   std::once_flag m_scratchpad_init_flag; // used for thread safe lazy init of scratchpad
   xrt::bo m_scratchpad_buf;
-  // Vector of XDP runs to be added at beginning and end of runlist
-  // These runs initializes/configures AI array and collects the profile/trace data
-  std::vector<xrt::run> m_xdp_init_runs;
-  std::vector<xrt::run> m_xdp_exit_runs;
-
   std::shared_ptr<xrt_core::usage_metrics::base_logger> m_usage_logger =
       xrt_core::usage_metrics::get_usage_metrics_logger();
   bool m_elf_flow = false;
@@ -471,33 +465,6 @@ class hw_context_impl : public std::enable_shared_from_this<hw_context_impl>
     msg.append(dump_file_name);
     xrt_core::message::send(xrt_core::message::severity_level::debug, "xrt_hw_context", msg);
   }
-
-  // Callback Functions for XDP to register init and exit runs
-  // that are added to xrt::runlist at start and end respectively
-  void
-  register_xdp_init_run(const xrt::run& run)
-  {
-    m_xdp_init_runs.push_back(run);
-  }
-
-  void
-  register_xdp_exit_run(const xrt::run& run)
-  {
-    m_xdp_exit_runs.push_back(run);
-  }
-
-  // Functions to get XDP init and exit run vectors
-  const std::vector<xrt::run>&
-  get_xdp_init_runs() const
-  {
-    return m_xdp_init_runs;
-  }
-
-  const std::vector<xrt::run>&
-  get_xdp_exit_runs() const
-  {
-    return m_xdp_exit_runs;
-  }
 };
 
 } // xrt
@@ -565,31 +532,6 @@ dump_scratchpad_mem(const xrt::hw_context& hwctx)
   return hwctx.get_handle()->dump_scratchpad_mem();
 }
 
-void
-register_xdp_init_run(const xrt::hw_context& ctx, const xrt::run& run)
-{
-  ctx.get_handle()->register_xdp_init_run(run);
-}
-
-XRT_CORE_COMMON_EXPORT
-void
-register_xdp_exit_run(const xrt::hw_context& ctx, const xrt::run& run)
-{
-  ctx.get_handle()->register_xdp_exit_run(run);
-}
-
-const std::vector<xrt::run>&
-get_xdp_init_runs(const xrt::hw_context& ctx)
-{
-  return ctx.get_handle()->get_xdp_init_runs();
-}
-
-const std::vector<xrt::run>&
-get_xdp_exit_runs(const xrt::hw_context& ctx)
-{
-  return ctx.get_handle()->get_xdp_exit_runs();
-}
-
 } // xrt_core::hw_context_int
 
 ////////////////////////////////////////////////////////////////

src/runtime_src/core/common/api/xrt_kernel.cpp

@@ -45,6 +45,7 @@
 #include "core/common/trace.h"
 #include "core/common/usage_metrics.h"
 #include "core/common/xclbin_parser.h"
+#include "core/common/xdp/profile.h"
 
 #include <boost/format.hpp>
 
@@ -3499,8 +3500,7 @@ class runlist_impl
     // These runs initializes AI array for profile/trace data
     // The list can be empty if profile/trace is not enabled
     if (m_runlist.empty()) {
-      const auto& xdp_init_runs = xrt_core::hw_context_int::get_xdp_init_runs(m_hwctx);
-      for (const auto& init_run : xdp_init_runs) {
+      for (const auto& init_run : xrt_core::xdp::get_init_runs(m_hwctx.get_handle().get())) {
         add_run_helper(init_run);
       }
     }
@@ -3521,8 +3521,7 @@ class runlist_impl
     // Add XDP exit runs if any at the end of runlist before submitting
     // These runs collect profile/trace data
     // The list can be empty if profile/trace is not enabled
-    const auto& xdp_exit_runs = xrt_core::hw_context_int::get_xdp_exit_runs(m_hwctx);
-    for (const auto& exit_run : xdp_exit_runs) {
+    for (const auto& exit_run : xrt_core::xdp::get_exit_runs(m_hwctx.get_handle().get())) {
       add_run_helper(exit_run);
     }
 
@@ -3569,7 +3568,7 @@ class runlist_impl
     // Remove any XDP exit runs added during execute
     // This is done because runlist can be reused
     // and XDP exit runs should be added at end
-    const auto& xdp_exit_runs = xrt_core::hw_context_int::get_xdp_exit_runs(m_hwctx);
+    const auto& xdp_exit_runs = xrt_core::xdp::get_exit_runs(m_hwctx.get_handle().get());
     if (xdp_exit_runs.size() > 0) {
       // remove the exit runs from the runlist
       m_runlist.erase(m_runlist.end() - xdp_exit_runs.size(), m_runlist.end());

src/runtime_src/core/common/xdp/profile.cpp

@@ -736,4 +736,20 @@ finish_flush_device(void* handle)
 #endif
 }
 
+const std::vector<xrt::run>&
+get_init_runs(void* /*hwctx_impl*/)
+{
+  // placeholder, TODO : XDP to add implementation
+  static std::vector<xrt::run> init_runs;
+  return init_runs;
+}
+
+const std::vector<xrt::run>&
+get_exit_runs(void* /*hwctx_impl*/)
+{
+  // placeholder, TODO : XDP to add implementation
+  static std::vector<xrt::run> exit_runs;
+  return exit_runs;
+}
+
 } // end namespace xrt_core::xdp

src/runtime_src/core/common/xdp/profile.h

@@ -3,6 +3,8 @@
 #ifndef CORE_COMMON_PROFILE_DOT_H
 #define CORE_COMMON_PROFILE_DOT_H
 
+#include "core/include/xrt/xrt_kernel.h"
+
 // The functions here are the general interfaces for the XDP hooks that are
 // called from the common coreutil library and not the specific shims.
 namespace xrt_core::xdp {
@@ -22,6 +24,20 @@ update_device(void* handle, bool hw_context_flow);
 void 
 finish_flush_device(void* handle);
 
+// get_init_runs returns vector of init runs to be prepended to a runlist.
+// These runs initialize the AI array for profile/trace data collection.
+// handle passed is the hw_context_impl pointer that is used to create runlist
+// This call returns empty vector if no profile/trace options are enabled
+const std::vector<xrt::run>&
+get_init_runs(void* hwctx_impl);
+
+// get_exit_runs returns vector of exit runs to be appended to a runlist.
+// These runs are used to flush out the AI array profile/trace data
+// handle passed is the hw_context_impl pointer that is used to create runlist.
+// This call returns empty vector if no profile/trace options are enabled
+const std::vector<xrt::run>&
+get_exit_runs(void* hwctx_impl);
+
 } // end namespace xrt_core::xdp
 
 #endif