TheRock/rocm-systems/projects/amdsmi/tests

API Summary Report

Overview

The API summary report is generated from reading the amdsmi.h header file and the output from the python and C++ tests. The python script, api_summary.py, will build a table from the available test log files.

Pre-Requisites Before Running Summary Report

Run the python and C++ tests prior to running api_summary.py script. The preferred way to run the tests is as follows:

The python scripts are in the directory /opt/rocm/share/amd_smi/tests/python_unittest

sudo unit_tests.py -v > _unit_test.log 2> _unit_test_err.log
sudo integration_test.py -v > _integration_test.log 2> _integration_test_err.log

The C++ test is in the directory /opt/rocm/share/amd_smi/tests

To run with ASIC-specific test exclusions (recommended):

cd /opt/rocm/share/amd_smi/tests
source amdsmitst.exclude
source detect_asic_filter.sh
sudo ./amdsmitst --gtest_filter="-${GTEST_EXCLUDE}" -v 1 > _amdsmitst.log 2> _amdsmitst_err.log

detect_asic_filter.sh reads the KFD topology to detect the installed ASIC (e.g. aldebaran, sienna_cichlid) or falls back to gfx_target_version for ip discovery nodes (e.g. 90400, 90402). It also detects SR-IOV virtualization. The script sets GTEST_EXCLUDE by combining the global blacklist (BLACKLIST_ALL_ASICS) with the device-specific filter from amdsmitst.exclude.

To run without ASIC-specific exclusions (uses only the global blacklist):

cd /opt/rocm/share/amd_smi/tests
source amdsmitst.exclude
sudo ./amdsmitst --gtest_filter="-${BLACKLIST_ALL_ASICS}" -v 1 > _amdsmitst.log 2> _amdsmitst_err.log

How to Run Summary Report

Command Line Options

Header File:
  --amdsmi AMDSMI
    Path to header file, default=include/amd_smi/amdsmi.h
Log Files:
  --log_dir LOG_DIR
    Path to where logs exist, default=build
  --c_unit_test C_UNIT_TEST
    Filename for C unit_test output, default=_c_unit_test.log
  --c_integration C_INTEGRATION
    Filename for C integration_test output, default=_c_integration.log
  --py_unit_test PY_UNIT_TEST
    Filename for Python unit_test output, default=_py_unit_test.log
  --py_integration PY_INTEGRATION
    Filename for Python integration_test output, default=_py_integration.log
Output File:
  --output_dir OUTPUT_DIR
    Path to output file, default=.

Command line examples:

Click for example: From amdsmi root directory with test output in build directory

api_summary.py

With specifying summary output

api_summary.py --output summary_dir

Click for example: From amdsmi root directory with test output in current directory

api_summary.py --log_dir .

Click for example: All input and output in current directory

api_summary.py --amdsmi ./amdsmi.h --log_dir . --output_dir .

Output Files:

  api_summary.csv
  api_summary_table.txt
  api_summary_support.txt

Click for example: api_summary.csv

API, Tested, c_unit_test, c_integration, py_unit_test, py_integration
amdsmi_init, 2, 0, 0, 1, 1
amdsmi_shut_down, 2, 0, 0, 1, 1
amdsmi_get_socket_handles, 2, 0, 0, 1, 1
amdsmi_get_cpu_handles, 1, 0, 0, 1, 0
amdsmi_get_socket_info, 1, 0, 0, 0, 1
amdsmi_get_processor_info, 1, 0, 0, 1, 0
amdsmi_get_processor_count_from_handles, 1, 0, 0, 1, 0
amdsmi_get_processor_handles_by_type, 1, 0, 0, 0, 1
amdsmi_get_processor_handles, 1, 0, 0, 1, 0
amdsmi_get_node_handle, 0, 0, 0, 0, 0
...

Click for example: api_summary_table.txt

 API    Test(%)     Unit(%)     Func(%)
  C     64(34.2)    0( 0.0)   64(34.2)
 Py    117(62.6)  101(54.0)   27(14.4)
Total  132(70.6)  101(54.0)   82(43.9)
Num APIs: 187

Click for example: api_summary_support.txt

API Not Supported: 3
	amdsmi_get_gpu_partition_metrics_info()
	amdsmi_set_gpu_accelerator_partition_profile()
	amdsmi_set_gpu_overdrive_level()
API Supported: 129
	amdsmi_clean_gpu_local_data()
	amdsmi_cpu_apb_disable()
	amdsmi_cpu_apb_enable()
	amdsmi_get_clk_freq()
	amdsmi_get_cpu_cclk_limit()
	amdsmi_get_cpu_core_boostlimit()
  ...