VITIS-15769 Deprecate legacy image management APIs in favor of xrt::… by karthdmg-xilinx · Pull Request #9651 · Xilinx/XRT

karthdmg-xilinx · 2026-03-07T05:42:41Z

Problem solved by the commit
Added warning for this release to deprecate any XRT requirements associated with v++ --package.generateAiePdi=1 that are not supported through xrt::hw_context.

Bug / issue (if any) fixed, which PR introduced the bug, how it was discovered
Added warning for this release to deprecate any XRT requirements associated with v++ --package.generateAiePdi=1 that are not supported through xrt::hw_context.

How problem was solved, alternative solutions (if any) and why they were rejected
Added warning for this release to deprecate any XRT requirements associated with v++ --package.generateAiePdi=1 that are not supported through xrt::hw_context.

Risks (if any) associated the changes in the commit
None

What has been tested and how, request additional testing if necessary
Ran XRT validate test suite to verify warning logged while load xclbins.
Ran application that call create kernels, create ext. BOs, graph creation APIs
Documentation impact (if any)
Attached .xls sheet in jira that has a list of APIs that log deprication warning

…hw_context-based APIs Signed-off-by: karthik dmg <karthdmg@xcokarthdmg50x.amd.com>

github-actions · 2026-03-07T05:49:21Z

clang-tidy review says "All clean, LGTM! 👍"

stsoe

Can our internal code and tests be fixed? If not, then I don't think the APIs can be deprecated.

stsoe · 2026-03-08T22:33:49Z

src/runtime_src/core/include/xrt/xrt_aie.h

   *
   * This constructor initializes a buffer object with the specified device, xclbin UUID, and string identifier. This throws an exception if no GMIO/External buffer exists with given name
   */
+  [[deprecated("deprecated, please use corresponding hw_context function instead")]]


In my experience, you need to provide the API to use and not leave the user guessing.

stsoe · 2026-03-08T22:36:19Z

src/runtime_src/core/tools/common/tests/TestAiePl.cpp

+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
  auto sender_receiver_k1 =
      xrt::kernel(device, uuid, "sender_receiver:{sender_receiver_1}");
  auto controller_k1 =
      xrt::kernel(device, uuid, "pl_controller_kernel:{controller_1}");
+#pragma GCC diagnostic pop


What deprecated functions does this hide? Is it not possible to fix test tests?

stsoe · 2026-03-08T22:37:14Z

src/runtime_src/core/tools/common/tests/TestHostMemBandwidthKernel.cpp

+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
  if (retVal == EOPNOTSUPP) {
    krnl_name = "slavebridge";
    xclbin_uuid = device.load_xclbin(old_binary_file.string());
  } else {
    xclbin_uuid = device.load_xclbin(b_file);
  }
+#pragma GCC diagnostic pop


If this cannot be fixed, then the APIs cannot be deprecated.

stsoe · 2026-03-08T22:38:48Z

src/runtime_src/xrt/device/hal2.cpp

+#if defined(__GNUC__)
+# pragma GCC diagnostic ignored "-Wdeprecated-declarations"
+#endif


What APIs are used here that are deprecated. If the code cannot be fixed, then APIs cannot be deprecated.

Signed-off-by: Karthik Dmg <karthdmg@xcokarthdmg50x.amd.com>

github-actions · 2026-03-09T03:31:23Z

clang-tidy review says "All clean, LGTM! 👍"

Signed-off-by: karthik dmg <karthdmg@xcokarthdmg50x.amd.com>

github-actions

clang-tidy made some suggestions

github-actions · 2026-03-09T04:20:59Z

src/runtime_src/core/tools/common/tests/TestBandwidthKernel.cpp

+  xrt::hw_context hw_ctx(device, uuid);

-  std::vector<xrt::kernel> krnls = create_kernel_objects(device, xclbin_uuid, num_kernel);
+  std::vector<xrt::kernel> krnls = create_kernel_objects(hw_ctx, num_kernel);


warning: narrowing conversion from 'unsigned int' to signed type 'int' is implementation-defined [bugprone-narrowing-conversions]

std::vector<xrt::kernel> krnls = create_kernel_objects(hw_ctx, num_kernel); ^

github-actions · 2026-03-09T04:20:59Z

src/runtime_src/core/tools/common/tests/TestBandwidthKernel.cpp

  try {
    if (num_kernel_ddr) {
-      auto  throughputs = test_bandwidth_ddr(device, krnls, num_kernel_ddr);
+      auto  throughputs = test_bandwidth_ddr(hw_ctx, krnls, num_kernel_ddr);


warning: narrowing conversion from 'unsigned int' to signed type 'int' is implementation-defined [bugprone-narrowing-conversions]

auto throughputs = test_bandwidth_ddr(hw_ctx, krnls, num_kernel_ddr); ^

github-actions · 2026-03-09T04:20:59Z

src/runtime_src/core/tools/common/tests/TestBandwidthKernel.cpp

    }
    if (chk_hbm_mem) {
-      double max_throughput = test_bandwidth_hbm(device, krnls, num_kernel);
+      double max_throughput = test_bandwidth_hbm(hw_ctx, krnls, num_kernel);


warning: narrowing conversion from 'unsigned int' to signed type 'int' is implementation-defined [bugprone-narrowing-conversions]

double max_throughput = test_bandwidth_hbm(hw_ctx, krnls, num_kernel); ^

github-actions · 2026-03-09T04:20:59Z

src/runtime_src/core/tools/common/tests/TestPsPlVerify.cpp

+  auto bandwidth_kernel = xrt::kernel(hw_ctx, "bandwidth_kernel");

-  auto max_throughput_bo = xrt::bo(device, 4096, bandwidth_kernel.group_id(1));
+  auto max_throughput_bo = xrt::bo(hw_ctx, 4096, bandwidth_kernel.group_id(1));


warning: 4096 is a magic number; consider replacing it with a named constant [cppcoreguidelines-avoid-magic-numbers]

auto max_throughput_bo = xrt::bo(hw_ctx, 4096, bandwidth_kernel.group_id(1)); ^

Signed-off-by: karthik dmg <karthdmg@xcokarthdmg50x.amd.com>

stsoe

Thank you. Good to see that we at least can fix our own code to not use the deprecated APIs. One small suggestion about header include.

stsoe · 2026-03-09T15:06:45Z

src/runtime_src/xrt/device/hal2.h

 #include "xrt/xrt_device.h"
 #include "xrt/xrt_bo.h"
+#include "xrt/xrt_hw_context.h"
+#include "xrt/experimental/xrt_xclbin.h"


It doesn't look like this header file requires xrt_xclbin.h, include-what-you-use, probably move to .cpp?

This PR address changes to the OpenCL XRT flow. In hwctx flow, we create hw contexts from xclbins on demand instead of explicitly loading the xclbins. The created hwctxs are cached in hal device and accessors are provided so that xclbin references can be converted into the hwctx that has loaded the xclbin. Signed-off-by: Soren Soe <2106410+stsoe@users.noreply.github.com>

Signed-off-by: karthik dmg <karthdmg@xcokarthdmg50x.amd.com>

stsoe

Looks good. Thank you!

VITIS-15769 Deprecate legacy image management APIs in favor of xrt::…

1b6570d

…hw_context-based APIs Signed-off-by: karthik dmg <karthdmg@xcokarthdmg50x.amd.com>

karthdmg-xilinx requested review from AShivangi, chvamshi-xilinx, rozumx, stsoe and uday610 as code owners March 7, 2026 05:42

chvamshi-xilinx approved these changes Mar 8, 2026

View reviewed changes

stsoe requested changes Mar 8, 2026

View reviewed changes

karthdmg-xilinx requested a review from stsoe March 9, 2026 03:07

deprecation warnings are suppressed on Windows aswell

8c3497d

Signed-off-by: Karthik Dmg <karthdmg@xcokarthdmg50x.amd.com>

fix changes in tests, added APIs in messages

c129545

Signed-off-by: karthik dmg <karthdmg@xcokarthdmg50x.amd.com>

github-actions bot reviewed Mar 9, 2026

View reviewed changes

karthik dmg added 2 commits March 8, 2026 22:56

addressed changes in hal2.cpp aswell

5c83d5f

Signed-off-by: karthik dmg <karthdmg@xcokarthdmg50x.amd.com>

made changes to fix windows build failures in pipeline

bb2e932

Signed-off-by: karthik dmg <karthdmg@xcokarthdmg50x.amd.com>

stsoe reviewed Mar 9, 2026

View reviewed changes

removed calls to acquire and release cu context

7931d40

Signed-off-by: karthik dmg <karthdmg@xcokarthdmg50x.amd.com>

chvamshi-xilinx approved these changes Mar 12, 2026

View reviewed changes

stsoe approved these changes Mar 12, 2026

View reviewed changes

chvamshi-xilinx merged commit 8349360 into Xilinx:master Mar 12, 2026
21 checks passed

Conversation

karthdmg-xilinx commented Mar 7, 2026

Uh oh!

github-actions bot commented Mar 7, 2026

Uh oh!

stsoe left a comment

Choose a reason for hiding this comment

Uh oh!

stsoe Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

stsoe Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

stsoe Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

stsoe Mar 8, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 9, 2026

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

stsoe left a comment

Choose a reason for hiding this comment

Uh oh!

stsoe Mar 9, 2026

Choose a reason for hiding this comment

Uh oh!

stsoe left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants