[XDP] Updates to AIE Debug plugin across various devices by pgschuey · Pull Request #8817 · Xilinx/XRT

pgschuey · 2025-03-14T15:28:12Z

Problem solved by the commit

Only 32 bit registers were supported
Common register locations across tile types were getting mislabeled
Some files were too large and were slowing down compilation

How problem was solved, alternative solutions (if any) and why they were rejected

Added support for larger register sizes
Redefined and classified registers by tile/module types
Separated out generational info into separate files

Risks (if any) associated the changes in the commit

Lots of device types and generations supported

What has been tested and how, request additional testing if necessary

Tested on Edge, client, and VE2

Documentation impact (if any)

N/A

Signed-off-by: Snigdha Gupta <snigupta@xsjsnigupta40x.xlnx.xilinx.com>

Signed-off-by: Prerona Dutta <predutta@xcopredutta50x.xlnx.xilinx.com>

Signed-off-by: Paul Schumacher <schuey@xilinx.com>

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 25 out of 70. Check the log or trigger a new build to see more.

github-actions · 2025-03-14T15:32:01Z

src/runtime_src/xdp/profile/plugin/aie_debug/aie_debug_metadata.h

 #include "xdp/profile/plugin/vp_base/vp_base_plugin.h"
+#include "xdp/profile/plugin/aie_debug/used_registers.h"

 extern "C" {
 #include <xaiengine.h>


warning: 'xaiengine.h' file not found [clang-diagnostic-error]

#include <xaiengine.h> ^

github-actions · 2025-03-14T15:32:01Z

src/runtime_src/xdp/profile/plugin/aie_debug/aie_debug_metadata.h


 extern "C" {
 #include <xaiengine.h>
 #include <xaiengine/xaiegbl_params.h>
 }

+#define NUMBEROFMODULES 4


warning: macro 'NUMBEROFMODULES' used to declare a constant; consider using a 'constexpr' constant [cppcoreguidelines-macro-usage]

#define NUMBEROFMODULES 4 ^

src/runtime_src/xdp/profile/plugin/aie_debug/aie_debug_metadata.h

github-actions · 2025-03-14T15:32:01Z

src/runtime_src/xdp/profile/plugin/aie_debug/aie_debug_metadata.h

    }

    void printValues(uint32_t deviceID, VPDatabase* db) {
      int i = 0;
+      std::vector<uint64_t>* addrVectors[] = {&coreRelativeOffsets, &memoryRelativeOffsets, &shimRelativeOffsets, &memTileRelativeOffsets};


warning: do not declare C-style arrays, use std::array<> instead [cppcoreguidelines-avoid-c-arrays]

std::vector<uint64_t>* addrVectors[] = {&coreRelativeOffsets, &memoryRelativeOffsets, &shimRelativeOffsets, &memTileRelativeOffsets}; ^

github-actions · 2025-03-14T15:32:01Z

src/runtime_src/xdp/profile/plugin/aie_debug/aie_debug_metadata.h

    }

    void printValues(uint32_t deviceID, VPDatabase* db) {
      int i = 0;
+      std::vector<uint64_t>* addrVectors[] = {&coreRelativeOffsets, &memoryRelativeOffsets, &shimRelativeOffsets, &memTileRelativeOffsets};
+      std::vector<xdp::aie::AieDebugValue>* valueVectors[] = {&coreValues, &memoryValues, &shimValues, &memTileValues};


warning: do not declare C-style arrays, use std::array<> instead [cppcoreguidelines-avoid-c-arrays]

std::vector<xdp::aie::AieDebugValue>* valueVectors[] = {&coreValues, &memoryValues, &shimValues, &memTileValues}; ^

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h

…x.xilinx.com>\n I, Snigdha Gupta <snigupta@xsjsnigupta40x.xlnx.xilinx.com>, hereby add my Signed-off-by to this commit: d396431\n Signed-off-by: Snigdha Gupta <snigupta@xsjsnigupta40x.xlnx.xilinx.com> Signed-off-by: Snigdha Gupta <snigupta@xsjsnigupta50x.xlnx.xilinx.com>

github-actions

clang-tidy made some suggestions

There were too many comments to post at once. Showing the first 25 out of 45. Check the log or trigger a new build to see more.

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h

github-actions · 2025-03-14T20:31:38Z

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h

+/*************************************************************************************
+ AIE1 Registers
+ *************************************************************************************/
+class AIE1UsedRegisters : public UsedRegisters {


warning: class 'AIE1UsedRegisters' defines a non-default destructor but does not define a copy constructor, a copy assignment operator, a move constructor or a move assignment operator [cppcoreguidelines-special-member-functions]

class AIE1UsedRegisters : public UsedRegisters { ^

github-actions · 2025-03-14T20:31:38Z

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h

+class AIE1UsedRegisters : public UsedRegisters {
+public:
+  AIE1UsedRegisters() {
+    populateRegNameToValueMap();


warning: Call to virtual method 'AIE1UsedRegisters::populateRegNameToValueMap' during construction bypasses virtual dispatch [clang-analyzer-optin.cplusplus.VirtualCall]

populateRegNameToValueMap(); ^

Additional context

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h:172: Call to virtual method 'AIE1UsedRegisters::populateRegNameToValueMap' during construction bypasses virtual dispatch

populateRegNameToValueMap(); ^

github-actions · 2025-03-14T20:31:39Z

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h

+  }
+  virtual ~AIE2UsedRegisters() {}
+
+  void populateProfileRegisters();


warning: annotate this function with 'override' or (rarely) 'final' [cppcoreguidelines-explicit-virtual-functions]

Suggested change

void populateProfileRegisters();

void populateProfileRegisters() override;

github-actions · 2025-03-14T20:31:39Z

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h

+  virtual ~AIE2UsedRegisters() {}
+
+  void populateProfileRegisters();
+  void populateTraceRegisters();


warning: annotate this function with 'override' or (rarely) 'final' [cppcoreguidelines-explicit-virtual-functions]

Suggested change

void populateTraceRegisters();

void populateTraceRegisters() override;

github-actions · 2025-03-14T20:31:39Z

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h

+
+  void populateProfileRegisters();
+  void populateTraceRegisters();
+  void populateRegNameToValueMap();


warning: annotate this function with 'override' or (rarely) 'final' [cppcoreguidelines-explicit-virtual-functions]

Suggested change

void populateRegNameToValueMap();

void populateRegNameToValueMap() override;

github-actions · 2025-03-14T20:31:40Z

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h

+  void populateProfileRegisters();
+  void populateTraceRegisters();
+  void populateRegNameToValueMap();
+  void populateRegValueToNameMap();


warning: annotate this function with 'override' or (rarely) 'final' [cppcoreguidelines-explicit-virtual-functions]

Suggested change

void populateRegValueToNameMap();

void populateRegValueToNameMap() override;

github-actions · 2025-03-14T20:31:40Z

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h

+  void populateTraceRegisters();
+  void populateRegNameToValueMap();
+  void populateRegValueToNameMap();
+  void populateRegAddrToSizeMap();


warning: annotate this function with 'override' or (rarely) 'final' [cppcoreguidelines-explicit-virtual-functions]

Suggested change

void populateRegAddrToSizeMap();

void populateRegAddrToSizeMap() override;

…x.xilinx.com> I, Snigdha Gupta <snigupta@xsjsnigupta40x.xlnx.xilinx.com>, hereby add my Signed-off-by to this commit: d396431 Signed-off-by: Snigdha Gupta <snigupta@xsjsnigupta40x.xlnx.xilinx.com> Signed-off-by: Snigdha Gupta <snigupta@xsjsnigupta50x.xlnx.xilinx.com>

github-actions

clang-tidy made some suggestions

github-actions · 2025-03-14T22:59:34Z

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h

+/*************************************************************************************
+ AIE2ps Registers
+ *************************************************************************************/
+class AIE2psUsedRegisters : public UsedRegisters {


warning: class 'AIE2psUsedRegisters' defines a non-default destructor but does not define a copy constructor, a copy assignment operator, a move constructor or a move assignment operator [cppcoreguidelines-special-member-functions]

class AIE2psUsedRegisters : public UsedRegisters { ^

github-actions · 2025-03-14T22:59:34Z

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h

+class AIE2psUsedRegisters : public UsedRegisters {
+public:
+  AIE2psUsedRegisters() {
+    populateRegNameToValueMap();


warning: Call to virtual method 'AIE2psUsedRegisters::populateRegNameToValueMap' during construction bypasses virtual dispatch [clang-analyzer-optin.cplusplus.VirtualCall]

populateRegNameToValueMap(); ^

Additional context

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h:210: Call to virtual method 'AIE2psUsedRegisters::populateRegNameToValueMap' during construction bypasses virtual dispatch

populateRegNameToValueMap(); ^

github-actions · 2025-03-14T22:59:34Z

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h

+public:
+  AIE2psUsedRegisters() {
+    populateRegNameToValueMap();
+    populateRegValueToNameMap();


warning: Call to virtual method 'AIE2psUsedRegisters::populateRegValueToNameMap' during construction bypasses virtual dispatch [clang-analyzer-optin.cplusplus.VirtualCall]

populateRegValueToNameMap(); ^

Additional context

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h:211: Call to virtual method 'AIE2psUsedRegisters::populateRegValueToNameMap' during construction bypasses virtual dispatch

populateRegValueToNameMap(); ^

github-actions · 2025-03-14T22:59:34Z

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h

+  AIE2psUsedRegisters() {
+    populateRegNameToValueMap();
+    populateRegValueToNameMap();
+    populateRegAddrToSizeMap();


warning: Call to virtual method 'AIE2psUsedRegisters::populateRegAddrToSizeMap' during construction bypasses virtual dispatch [clang-analyzer-optin.cplusplus.VirtualCall]

populateRegAddrToSizeMap(); ^

Additional context

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h:212: Call to virtual method 'AIE2psUsedRegisters::populateRegAddrToSizeMap' during construction bypasses virtual dispatch

populateRegAddrToSizeMap(); ^

github-actions · 2025-03-14T22:59:35Z

src/runtime_src/xdp/profile/plugin/aie_debug/used_registers.h

+    populateRegValueToNameMap();
+    populateRegAddrToSizeMap();
+  }
+  virtual ~AIE2psUsedRegisters() {}


warning: prefer using 'override' or (rarely) 'final' instead of 'virtual' [hicpp-use-override]

Suggested change

virtual ~AIE2psUsedRegisters() {}

~AIE2psUsedRegisters() override {}

github-actions · 2025-03-14T22:59:36Z

src/runtime_src/xdp/profile/writer/aie_debug/register_interpreter.h

-    RegisterInterpreter(uint64_t deviceIndex, int aieGeneration);
-
-    ~RegisterInterpreter()=default;
+    RegisterInterpreter(int aieGeneration);


warning: single-argument constructors must be marked explicit to avoid unintentional implicit conversions [hicpp-explicit-conversions]

Suggested change

RegisterInterpreter(int aieGeneration);

explicit RegisterInterpreter(int aieGeneration);

github-actions · 2025-03-14T22:59:36Z

src/runtime_src/xdp/profile/writer/aie_debug/register_interpreter.h

-
-    ~RegisterInterpreter()=default;
+    RegisterInterpreter(int aieGeneration);
+    ~RegisterInterpreter() {};


warning: use '= default' to define a trivial destructor [hicpp-use-equals-default]

Suggested change

~RegisterInterpreter() {};

~RegisterInterpreter() = default;

github-actions · 2025-03-14T22:59:36Z

src/runtime_src/xdp/profile/writer/aie_debug/register_interpreter.h

+      std::vector<uint32_t> subval;

-      RegInfo(std::string f, std::string b, uint32_t s)
+      RegInfo(std::string f, std::string b, std::vector<uint32_t> s)


warning: constructor does not initialize these fields: subval [cppcoreguidelines-pro-type-member-init]

src/runtime_src/xdp/profile/writer/aie_debug/register_interpreter.h:36:

- std::vector<uint32_t> subval; + std::vector<uint32_t> subval{};

github-actions · 2025-03-14T22:59:36Z

src/runtime_src/xdp/profile/writer/aie_debug/register_interpreter.h

+      std::vector<uint32_t> subval;

-      RegInfo(std::string f, std::string b, uint32_t s)
+      RegInfo(std::string f, std::string b, std::vector<uint32_t> s)


warning: pass by value and use std::move [modernize-pass-by-value]

src/runtime_src/xdp/profile/writer/aie_debug/register_interpreter.h:23:

- #include <vector> + #include <utility> + #include <vector>

src/runtime_src/xdp/profile/writer/aie_debug/register_interpreter.h:39:

- : field_name(f), bit_range(b), subval(s) {} + : field_name(std::move(f)), bit_range(b), subval(s) {}

github-actions · 2025-03-14T22:59:36Z

src/runtime_src/xdp/profile/writer/aie_debug/register_interpreter.h

+      std::vector<uint32_t> subval;

-      RegInfo(std::string f, std::string b, uint32_t s)
+      RegInfo(std::string f, std::string b, std::vector<uint32_t> s)


warning: pass by value and use std::move [modernize-pass-by-value]

src/runtime_src/xdp/profile/writer/aie_debug/register_interpreter.h:39:

- : field_name(f), bit_range(b), subval(s) {} + : field_name(f), bit_range(std::move(b)), subval(s) {}

…luginV2

…x.xilinx.com> I, Snigdha Gupta <snigupta@xsjsnigupta40x.xlnx.xilinx.com>, hereby add my Signed-off-by to this commit: d396431 Signed-off-by: Snigdha Gupta <snigupta@xsjsnigupta40x.xlnx.xilinx.com> Signed-off-by: Snigdha Gupta <snigupta@xsjsnigupta50x.xlnx.xilinx.com>

Signed-off-by: Prerona Dutta <predutta@xcopredutta50x.xlnx.xilinx.com>

Snigdha Gupta and others added 8 commits February 11, 2025 15:55

Added support for registers outside of 32-it range

d396431

Added support for registers out for 32-bit range

cfd9999

Signed-off-by: Snigdha Gupta <snigupta@xsjsnigupta40x.xlnx.xilinx.com>

Fixing bug of inconsistent reg names across modules

773ce39

Signed-off-by: Prerona Dutta <predutta@xcopredutta50x.xlnx.xilinx.com>

Implementing recommended changes

4b740db

Signed-off-by: Prerona Dutta <predutta@xcopredutta50x.xlnx.xilinx.com>

Deleting old aie_debug_metadata_aie*.cpp files

1f6ab5f

Signed-off-by: Prerona Dutta <predutta@xcopredutta50x.xlnx.xilinx.com>

changing string to const string& to increase efficiency

830c9b4

Signed-off-by: Prerona Dutta <predutta@xcopredutta50x.xlnx.xilinx.com>

merge w/ master

bdb6c40

Signed-off-by: Paul Schumacher <schuey@xilinx.com>

cleanup after merge

e16af3c

Signed-off-by: Paul Schumacher <schuey@xilinx.com>

pgschuey requested review from predutta and snigdha-gupta March 14, 2025 15:28

pgschuey requested review from jvillarre, rozumx and stsoe as code owners March 14, 2025 15:28

pgschuey marked this pull request as draft March 14, 2025 15:28

github-actions bot reviewed Mar 14, 2025

View reviewed changes

Paul Schumacher and others added 4 commits March 21, 2025 11:02

Merge branch 'master' of https://github.com/Xilinx/XRT into aieDebugP…

6be4d7a

…luginV2

Merge branch 'master' of https://github.com/Xilinx/XRT into aieDebugP…

92dfd0b

…luginV2

Fixing merge issues

2ed26e2

Signed-off-by: Prerona Dutta <predutta@xcopredutta50x.xlnx.xilinx.com>

pgschuey closed this Apr 21, 2025

	void populateProfileRegisters();
	void populateProfileRegisters() override;

	void populateTraceRegisters();
	void populateTraceRegisters() override;

	void populateRegNameToValueMap();
	void populateRegNameToValueMap() override;

	void populateRegValueToNameMap();
	void populateRegValueToNameMap() override;

	void populateRegAddrToSizeMap();
	void populateRegAddrToSizeMap() override;

	virtual ~AIE2psUsedRegisters() {}
	~AIE2psUsedRegisters() override {}

	RegisterInterpreter(int aieGeneration);
	explicit RegisterInterpreter(int aieGeneration);

Conversation

pgschuey commented Mar 14, 2025

Problem solved by the commit

How problem was solved, alternative solutions (if any) and why they were rejected

Risks (if any) associated the changes in the commit

What has been tested and how, request additional testing if necessary

Documentation impact (if any)

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot Mar 14, 2025

Choose a reason for hiding this comment

Uh oh!