CR 1217061 : xrt-smi advanced --help prints Alveo help #8545

aktondak · 2024-10-17T22:32:53Z

Problem solved by the commit

xrt-smi advanced --help prints Alveo help which is incorrect

Bug / issue (if any) fixed, which PR introduced the bug, how it was discovered

https://jira.xilinx.com/browse/CR-1217061
Discovered through internal testing

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

The problem was solved by setting m_device member and using to print specific help.
--report had multiple other bugs which are resolved with this :

mode was used as an option which showed --mode as a user configurable option in help. This was incorrect.
"--report clocks" was not being passed to sub-option making the parser show undefined behavior.
There were no prints of what reports can be generated. Added "clocks" and "preemption" as valid reports.

Risks (if any) associated the changes in the commit

None

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

Tested on kracken board :
Before fix

Y:\Repos\XRT-MCDM-FORK\XRT-MCDM\build\WRelease\xilinx\xrt>xrt-smi advanced --help

COMMAND: advanced

DESCRIPTION: Low level command operations.

USAGE: xrt-smi advanced [ --read-mem | --write-mem | --report ] [--help]

OPTIONS:
 Common:
  --help             - Help to use this sub-command
 AIE:
  --report           - Hidden reports
 Alveo:
  --read-mem         - Read from the given memory address
  --write-mem        - Write to a given memory address


GLOBAL OPTIONS:
  --verbose          - Turn on verbosity
  --batch            - Enable batch mode (disables escape characters)
  --force            - When possible, force an operation

After fix

Y:\Repos\XRT-MCDM-FORK\XRT-MCDM\build\WRelease\xilinx\xrt>xrt-smi advanced --help

COMMAND: advanced

DESCRIPTION: Low level command operations.

USAGE: xrt-smi advanced [ --report ] [--help] [-d arg]

OPTIONS:
  -d, --device       - The Bus:Device.Function (e.g., 0000:d8:00.0) device of interest
  --help             - Help to use this sub-command
  --report           - Hidden reports


GLOBAL OPTIONS:
  --verbose          - Turn on verbosity
  --batch            - Enable batch mode (disables escape characters)
  --force            - When possible, force an operation

Documentation impact (if any)

None

Signed-off-by: Akshay Tondak <[email protected]>

gbuildx · 2024-10-17T22:34:02Z

Can one of the admins verify this patch?

Signed-off-by: Akshay Tondak <[email protected]>

AShivangi

You tried out all possible combinations for this? Passing in invalid values as well?

Signed-off-by: Akshay Tondak <[email protected]>

aktondak · 2024-10-21T20:37:56Z

You tried out all possible combinations for this? Passing in invalid values as well?

Passing an invalid value yields unrecognized arguments error :

Z:\Repos\XRT-MCDM-FORK\XRT-MCDM\build\WRelease\xilinx\xrt>xrt-smi advanced --report clock
ERROR: Unrecognized arguments:
  clock


COMMAND: advanced

DESCRIPTION: Low level command operations.

USAGE: xrt-smi advanced [ --read-mem | --write-mem | --report ] [--help] [-d arg]

OPTIONS:
 Common:
  -d, --device       - The Bus:Device.Function (e.g., 0000:d8:00.0) device of interest
  --help             - Help to use this sub-command
 AIE:
  --report           - Reports to generate: clocks, preemption
 Alveo:
  --read-mem         - Read from the given memory address
  --write-mem        - Write to a given memory address


GLOBAL OPTIONS:
  --verbose          - Turn on verbosity
  --batch            - Enable batch mode (disables escape characters)
  --force            - When possible, force an operation
ERROR: operation canceled

AShivangi · 2024-10-21T20:39:35Z

src/runtime_src/core/tools/xbutil2/SubCmdAdvanced.cpp

@@ -46,6 +46,7 @@ SubCmdAdvanced::SubCmdAdvanced(bool _isHidden, bool _isDepricated, bool _isPreli
  setIsPreliminary(_isPreliminary);

  m_commonOptions.add_options()
+    ("device,d", boost::program_options::value<decltype(m_device)>(&m_device), "The Bus:Device.Function (e.g., 0000:d8:00.0) device of interest")


Do we need this device. "xrt-smi advanced --device <>" Is not a valid command. We have devices inside the suboptions

We can print device specific help only when m_device is populated.
SubCmdProgram class also has a m_device which works on the OptionOption mechanism, similar to advanced.

Ok, please make sure that all possible option combos work after this change!

Only clocks and preemption are used as valida reports right now. Generating preemption exits silently and clocks works fine :

Z:\Repos\XRT-MCDM-FORK\XRT-MCDM\build\WRelease\xilinx\xrt>xrt-smi advanced --report preemption Z:\Repos\XRT-MCDM-FORK\XRT-MCDM\build\WRelease\xilinx\xrt>xrt-smi advanced --report clocks Clocks H Clock : 800 MHz MP-NPU Clock : 400 MHz

AShivangi · 2024-10-22T16:23:55Z

You tried out all possible combinations for this? Passing in invalid values as well?

Passing an invalid value yields unrecognized arguments error :

Z:\Repos\XRT-MCDM-FORK\XRT-MCDM\build\WRelease\xilinx\xrt>xrt-smi advanced --report clock
ERROR: Unrecognized arguments:
  clock


COMMAND: advanced

DESCRIPTION: Low level command operations.

USAGE: xrt-smi advanced [ --read-mem | --write-mem | --report ] [--help] [-d arg]

OPTIONS:
 Common:
  -d, --device       - The Bus:Device.Function (e.g., 0000:d8:00.0) device of interest
  --help             - Help to use this sub-command
 AIE:
  --report           - Reports to generate: clocks, preemption
 Alveo:
  --read-mem         - Read from the given memory address
  --write-mem        - Write to a given memory address


GLOBAL OPTIONS:
  --verbose          - Turn on verbosity
  --batch            - Enable batch mode (disables escape characters)
  --force            - When possible, force an operation
ERROR: operation canceled

Why is unrecognized option showing both aie and alveo?

aktondak · 2024-10-22T18:09:10Z

You tried out all possible combinations for this? Passing in invalid values as well?

Passing an invalid value yields unrecognized arguments error :

Z:\Repos\XRT-MCDM-FORK\XRT-MCDM\build\WRelease\xilinx\xrt>xrt-smi advanced --report clock
ERROR: Unrecognized arguments:
  clock


COMMAND: advanced

DESCRIPTION: Low level command operations.

USAGE: xrt-smi advanced [ --read-mem | --write-mem | --report ] [--help] [-d arg]

OPTIONS:
 Common:
  -d, --device       - The Bus:Device.Function (e.g., 0000:d8:00.0) device of interest
  --help             - Help to use this sub-command
 AIE:
  --report           - Reports to generate: clocks, preemption
 Alveo:
  --read-mem         - Read from the given memory address
  --write-mem        - Write to a given memory address


GLOBAL OPTIONS:
  --verbose          - Turn on verbosity
  --batch            - Enable batch mode (disables escape characters)
  --force            - When possible, force an operation
ERROR: operation canceled

Why is unrecognized option showing both aie and alveo?

Apologies, this is outdated.
The updated behavior prints Ryzen help only :

Z:\Repos\XRT-MCDM-FORK\XRT-MCDM\build\WRelease\xilinx\xrt>xrt-smi advanced --report clock

ERROR: Invalid report value: 'clock'
: invalid argument

COMMAND: advanced

DESCRIPTION: Reports to generate: clocks, preemption

USAGE:  advanced --report [--help] [-d arg]

OPTIONS:
  --report           - Reports to generate: clocks, preemption
  -d, --device       - The Bus:Device.Function (e.g., 0000:d8:00.0) device of interest
  --help             - Help to use this sub-command


GLOBAL OPTIONS:
  --verbose          - Turn on verbosity
  --batch            - Enable batch mode (disables escape characters)
  --force            - When possible, force an operation

rchane

Output seems good after changes!

Signed-off-by: Akshay Tondak <[email protected]>

* CR-1217061 revert Signed-off-by: Akshay Tondak <[email protected]> * CR-1217061 fix Signed-off-by: Akshay Tondak <[email protected]> * Adding missing line Signed-off-by: Akshay Tondak <[email protected]> * Adding missing code Signed-off-by: Akshay Tondak <[email protected]> * Taking care of empty error handling Signed-off-by: Akshay Tondak <[email protected]> --------- Signed-off-by: Akshay Tondak <[email protected]> Co-authored-by: Akshay Tondak <[email protected]>

Akshay Tondak added 2 commits October 16, 2024 19:05

CR-1217061 revert

4a62a9e

Signed-off-by: Akshay Tondak <[email protected]>

CR-1217061 fix

f7529f7

Signed-off-by: Akshay Tondak <[email protected]>

aktondak requested review from rozumx, chvamshi-xilinx and AShivangi as code owners October 17, 2024 22:32

aktondak and others added 2 commits October 17, 2024 15:36

Merge branch 'Xilinx:master' into CR-1217061

9ab8eda

Adding missing line

5844760

Signed-off-by: Akshay Tondak <[email protected]>

AShivangi reviewed Oct 21, 2024

View reviewed changes

Adding missing code

931ba99

Signed-off-by: Akshay Tondak <[email protected]>

AShivangi reviewed Oct 21, 2024

View reviewed changes

aktondak requested a review from rchane October 22, 2024 18:09

rchane approved these changes Oct 22, 2024

View reviewed changes

aktondak requested a review from AShivangi October 22, 2024 20:58

AShivangi approved these changes Oct 22, 2024

View reviewed changes

Taking care of empty error handling

7cbf5b5

Signed-off-by: Akshay Tondak <[email protected]>

stsoe merged commit 4bc431f into Xilinx:master Oct 23, 2024
18 checks passed

aktondak deleted the CR-1217061 branch October 23, 2024 06:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CR 1217061 : xrt-smi advanced --help prints Alveo help #8545

CR 1217061 : xrt-smi advanced --help prints Alveo help #8545

aktondak commented Oct 17, 2024 •

edited

Loading

gbuildx commented Oct 17, 2024

AShivangi left a comment

aktondak commented Oct 21, 2024

AShivangi Oct 21, 2024

aktondak Oct 21, 2024

AShivangi Oct 21, 2024

aktondak Oct 21, 2024

AShivangi commented Oct 22, 2024

aktondak commented Oct 22, 2024

rchane left a comment

CR 1217061 : xrt-smi advanced --help prints Alveo help #8545

CR 1217061 : xrt-smi advanced --help prints Alveo help #8545

Conversation

aktondak commented Oct 17, 2024 • edited Loading

Problem solved by the commit

Bug / issue (if any) fixed, which PR introduced the bug, how it was discovered

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)

gbuildx commented Oct 17, 2024

AShivangi left a comment

Choose a reason for hiding this comment

aktondak commented Oct 21, 2024

AShivangi Oct 21, 2024

Choose a reason for hiding this comment

aktondak Oct 21, 2024

Choose a reason for hiding this comment

AShivangi Oct 21, 2024

Choose a reason for hiding this comment

aktondak Oct 21, 2024

Choose a reason for hiding this comment

AShivangi commented Oct 22, 2024

aktondak commented Oct 22, 2024

rchane left a comment

Choose a reason for hiding this comment

aktondak commented Oct 17, 2024 •

edited

Loading