Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

xrt-smi rearchitecture patch 3 #8705

Merged
merged 4 commits into from
Jan 21, 2025
Merged

xrt-smi rearchitecture patch 3 #8705

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
98cfeec
xrt-smi rearchitecture patch 3
aktondak Jan 20, 2025
a66766e
Fix for unit test failure
aktondak Jan 20, 2025
9780eb2
alveo unit test build fix
aktondak Jan 20, 2025
b2a2730
Some dead code removal
aktondak Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
155 changes: 125 additions & 30 deletions src/runtime_src/core/pcie/linux/smi.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,65 +53,73 @@ static constexpr std::string_view xrt_smi_config =
{
"name" : "run",
"alias" : "r",
"description" : "Run a subset of the test suite",
"description" : ["Run a subset of the test suite. Valid options are:",
"\n\taie - Run AIE PL test",
"\n\taux-connection - Check if auxiliary power is connected",
"\n\tdma - Run dma test",
"\n\thostmem-bw - Run 'bandwidth kernel' when host memory is",
"\n\t enabled",
"\n\tm2m - Run M2M test",
"\n\tmem-bw - Run 'bandwidth kernel' and check the",
"\n\t throughput",
"\n\tp2p - Run P2P test",
"\n\tpcie-link - Check if PCIE link is active",
"\n\tsc-version - Check if SC firmware is up-to-date",
"\n\tverify - Run 'Hello World' kernel test"
],
"tag" : "basic",
"option_type": "common",
"value_type" : "array",
"options" : [
{
"name" : "latency",
"name" : "aie",
"tag" : "basic",
"description" : "Run end-to-end latency test"
"description" : "Run AIE PL test"
},
{
"name" : "throughput",
"name" : "aux-connection",
"tag" : "basic",
"description" : "Run end-to-end throughput test"
"description" : "Check if auxiliary power is connected"
},
{
"name" : "cmd-chain-latency",
"name" : "dma",
"tag" : "basic",
"description" : "Run command chain latency test"
"description" : "Run dma test"
},
{
"name" : "cmd-chain-throughput",
"name" : "hostmem-bw",
"tag" : "basic",
"description" : "Run end-to-end throughput test using command chaining"
"description" : "Run 'bandwidth kernel' when host memory is enabled"
},
{
"name" : "df-bw",
"name" : "m2m",
"tag" : "basic",
"description" : "Run dataflow bandwidth test"
"description" : "Run M2M test"
},
{
"name" : "tct-one-col",
"name" : "mem-bw",
"tag" : "basic",
"description" : "Run TCT test with one column"
"description" : "Run 'bandwidth kernel' and check the throughput"
},
{
"name" : "tct-all-col",
"name" : "p2p",
"tag" : "basic",
"description" : "Run TCT test with all columns"
"description" : "Run P2P test"
},
{
"name" : "gemm",
"name" : "pcie-link",
"tag" : "basic",
"description" : "Run GEMM test"
"description" : "Check if PCIE link is active"
},
{
"name" : "aie-reconfig-overhead",
"name" : "tsc-version",
"tag" : "advanced",
"description" : "Run AIE reconfiguration overhead test"
"description" : "Check if SC firmware is up-to-date"
},
{
"name" : "spatial-sharing-overhead",
"name" : "verify",
"tag" : "advanced",
"description" : "Run spatial sharing overhead test"
},
{
"name" : "temporal-sharing-overhead",
"tag" : "advanced",
"description" : "Run temporal sharing overhead test"
"description" : "Run 'Hello World' kernel test"
}
]
},
Expand Down Expand Up @@ -300,15 +308,102 @@ static constexpr std::string_view xrt_smi_config =
[
{
"name": "device",
"alias": "d",
"description": "The Bus:Device.Function (e.g., 0000:d8:00.0) device of interest",
"tag": "devl",
"value_type" : "string"
"tag": "basic",
"default_value": "",
"option_type": "common",
"value_type": "string"
},
{
"name": "help",
"alias": "h",
"description" : "Help to use this sub-command",
"tag": "basic",
"default_value": "",
"option_type": "common",
"value_type" : "none"
},
{
"name": "pmode",
"description": "Modes: default, powersaver, balanced, performance, turbo",
"name": "daemon",
"alias": "",
"description" : "Update the device daemon configuration",
"tag": "basic",
"default_value": "",
"option_type": "hidden",
"value_type" : "none"
},
{
"name": "purge",
"alias": "",
"description": "Remove the daemon configuration file",
"tag": "basic",
"default_value": "",
"option_type": "hidden",
"value_type": "string"
},
{
"name": "host",
"alias": "",
"description" : "IP or hostname for device peer",
"tag": "basic",
"default_value": "",
"option_type": "hidden",
"value_type" : "string"
},
{
"name": "security",
"alias": "",
"description" : "Update the security level for the device",
"tag": "basic",
"default_value": "",
"option_type": "hidden",
"value_type" : "string"
},
{
"name": "clk_throttle",
"alias": "",
"description" : "Enable/disable the device clock throttling",
"tag": "basic",
"default_value": "",
"option_type": "hidden",
"value_type" : "string"
},
{
"name": "ct_threshold_power_override",
"alias": "",
"description" : "Update the power threshold in watts",
"tag": "basic",
"default_value": "",
"option_type": "hidden",
"value_type" : "string"
},
{
"name": "ct_threshold_temp_override",
"alias": "",
"description" : "Update the temperature threshold in celsius",
"tag": "basic",
"default_value": "",
"option_type": "hidden",
"value_type" : "string"
},
{
"name": "ct_reset",
"alias": "",
"description" : "Reset all throttling options",
"tag": "basic",
"default_value": "",
"option_type": "hidden",
"value_type" : "string"
},
{
"name": "showx",
"alias": "",
"description" : "Display the device configuration settings",
"tag": "basic",
"default_value": "",
"option_type": "hidden",
"value_type" : "string"
}
]
}]
Expand Down
96 changes: 41 additions & 55 deletions src/runtime_src/core/tools/common/SubCmdConfigureInternal.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,18 +93,7 @@ static boost::property_tree::ptree m_configurations;
SubCmdConfigureInternal::SubCmdConfigureInternal(bool _isHidden, bool _isDepricated, bool _isPreliminary, bool _isUserDomain, const boost::property_tree::ptree& configurations)
: SubCmd("configure",
_isUserDomain ? "Device and host configuration" : "Advanced options for configuring a device")
, m_device("")
, m_help(false)
, m_isUserDomain(_isUserDomain)
, m_daemon(false)
, m_purge(false)
, m_host("")
, m_security("")
, m_clk_throttle("")
, m_power_override("")
, m_temp_override("")
, m_ct_reset("")
, m_showx(false)
{
const std::string longDescription = _isUserDomain ? "Device and host configuration." : "Advanced options for configuring a device";
setLongDescription(longDescription);
Expand All @@ -113,28 +102,6 @@ SubCmdConfigureInternal::SubCmdConfigureInternal(bool _isHidden, bool _isDeprica
setIsDeprecated(_isDepricated);
setIsPreliminary(_isPreliminary);

if (!m_isUserDomain) {
// Options previously hidden under the config command
configHiddenOptions.add_options()
("daemon", boost::program_options::bool_switch(&m_daemon), "Update the device daemon configuration")
("purge", boost::program_options::bool_switch(&m_purge), "Remove the daemon configuration file")
("host", boost::program_options::value<decltype(m_host)>(&m_host), "IP or hostname for device peer")
("security", boost::program_options::value<decltype(m_security)>(&m_security), "Update the security level for the device")
("clk_throttle", boost::program_options::value<decltype(m_clk_throttle)>(&m_clk_throttle), "Enable/disable the device clock throttling")
("ct_threshold_power_override", boost::program_options::value<decltype(m_power_override)>(&m_power_override), "Update the power threshold in watts")
("ct_threshold_temp_override", boost::program_options::value<decltype(m_temp_override)>(&m_temp_override), "Update the temperature threshold in celsius")
("ct_reset", boost::program_options::value<decltype(m_ct_reset)>(&m_ct_reset), "Reset all throttling options")
("showx", boost::program_options::bool_switch(&m_showx), "Display the device configuration settings")
;

m_hiddenOptions.add(configHiddenOptions);
}

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")
("help", boost::program_options::bool_switch(&m_help), "Help to use this sub-command")
;

for (const auto& option : optionOptionsCollection)
addSubOption(option);

Expand Down Expand Up @@ -321,15 +288,17 @@ SubCmdConfigureInternal::execute(const SubCmdOptions& _options) const
{
XBU::verbose("SubCommand: configure");
po::variables_map vm;
SubCmdConfigureOptions options;
// Used for the suboption arguments.
const auto unrecognized_options = process_arguments(vm, _options, false);
fill_option_values(vm, options);
// Find the subOption
auto optionOption = checkForSubOption(vm, XBU::get_device_class(m_device, m_isUserDomain));
auto optionOption = checkForSubOption(vm, XBU::get_device_class(options.m_device, m_isUserDomain));

if (!optionOption && m_isUserDomain) {
// No suboption print help
if (m_help) {
printHelp(false, "", XBU::get_device_class(m_device, m_isUserDomain));
if (options.m_help) {
printHelp(false, "", XBU::get_device_class(options.m_device, m_isUserDomain));
return;
}
// If help was not requested and additional options dont match we must throw to prevent
Expand All @@ -344,7 +313,7 @@ SubCmdConfigureInternal::execute(const SubCmdOptions& _options) const
else {
std::cerr << "ERROR: Suboption missing" << std::endl;
}
printHelp(false, "", XBU::get_device_class(m_device, m_isUserDomain));
printHelp(false, "", XBU::get_device_class(options.m_device, m_isUserDomain));
throw xrt_core::error(std::errc::operation_canceled);
}

Expand All @@ -361,31 +330,31 @@ SubCmdConfigureInternal::execute(const SubCmdOptions& _options) const
// Take care of executing hidden options for xbmgmt.
if (!m_isUserDomain) {
// -- process "help" option -----------------------------------------------
if (m_help) {
if (options.m_help) {
printHelp();
return;
}

// Non-device options
// Remove the daemon config file
if (m_purge) {
if (options.m_purge) {
XBU::verbose("Sub command: --purge");
remove_daemon_config();
return;
}

// Update daemon
if (m_daemon) {
if (options.m_daemon) {
XBU::verbose("Sub command: --daemon");
update_daemon_config(m_host);
update_daemon_config(options.m_host);
return;
}

// Find device of interest
std::shared_ptr<xrt_core::device> device;

try {
device = XBU::get_device(boost::algorithm::to_lower_copy(m_device), false /*inUserDomain*/);
device = XBU::get_device(boost::algorithm::to_lower_copy(options.m_device), false /*inUserDomain*/);
} catch (const std::runtime_error& e) {
// Catch only the exceptions that we have generated earlier
std::cerr << boost::format("ERROR: %s\n") % e.what();
Expand All @@ -400,9 +369,9 @@ SubCmdConfigureInternal::execute(const SubCmdOptions& _options) const

// Config commands
// Option:m_showx
if (m_showx) {
if (options.m_showx) {
XBU::verbose("Sub command: --showx");
if(m_daemon)
if(options.m_daemon)
show_daemon_conf();

show_device_conf(device.get());
Expand All @@ -413,29 +382,46 @@ SubCmdConfigureInternal::execute(const SubCmdOptions& _options) const
bool is_something_updated = false;

// Update security
if (!m_security.empty())
is_something_updated = update_device_conf(device.get(), m_security, config_type::security);
if (!options.m_security.empty())
is_something_updated = update_device_conf(device.get(), options.m_security, config_type::security);

// Clock throttling
if (!m_clk_throttle.empty())
is_something_updated = update_device_conf(device.get(), m_clk_throttle, config_type::clk_throttling);
if (!options.m_clk_throttle.empty())
is_something_updated = update_device_conf(device.get(), options.m_clk_throttle, config_type::clk_throttling);

// Update threshold power override
if (!m_power_override.empty())
is_something_updated = update_device_conf(device.get(), m_power_override, config_type::threshold_power_override);
if (!options.m_power_override.empty())
is_something_updated = update_device_conf(device.get(), options.m_power_override, config_type::threshold_power_override);

// Update threshold temp override
if (!m_temp_override.empty())
is_something_updated = update_device_conf(device.get(), m_temp_override, config_type::threshold_temp_override);
if (!options.m_temp_override.empty())
is_something_updated = update_device_conf(device.get(), options.m_temp_override, config_type::threshold_temp_override);

// m_ct_reset?? TODO needs better comment
if (!m_ct_reset.empty())
is_something_updated = update_device_conf(device.get(), m_ct_reset, config_type::reset);
if (!options.m_ct_reset.empty())
is_something_updated = update_device_conf(device.get(), options.m_ct_reset, config_type::reset);

if (!is_something_updated) {
std::cerr << "ERROR: Please specify a valid option to configure the device" << "\n\n";
printHelp(false, "", XBU::get_device_class(m_device, m_isUserDomain));
printHelp(false, "", XBU::get_device_class(options.m_device, m_isUserDomain));
throw xrt_core::error(std::errc::operation_canceled);
}
}
}

void
SubCmdConfigureInternal::fill_option_values(const boost::program_options::variables_map& vm, SubCmdConfigureOptions& options) const
{
options.m_device = vm.count("device") ? vm["device"].as<std::string>() : "";
options.m_help = vm.count("help") ? vm["help"].as<bool>() : false;
options.m_daemon = vm.count("daemon") ? vm["daemon"].as<bool>() : false;
options.m_purge = vm.count("purge") ? vm["purge"].as<bool>() : false;
options.m_host = vm.count("host") ? vm["host"].as<std::string>() : "";
options.m_security = vm.count("security") ? vm["security"].as<std::string>() : "";
options.m_clk_throttle = vm.count("clk_throttle") ? vm["clk_throttle"].as<std::string>() : "";
options.m_power_override = vm.count("ct_threshold_power_override") ? vm["ct_threshold_power_override"].as<std::string>() : "";
options.m_temp_override = vm.count("ct_threshold_temp_override") ? vm["ct_threshold_temp_override"].as<std::string>() : "";
options.m_ct_reset = vm.count("ct_reset") ? vm["ct_reset"].as<std::string>() : "";
options.m_showx = vm.count("showx") ? vm["showx"].as<bool>() : false;
}

Loading
Loading