[Offload] Add type information to device info nodes (#144535)

Rather than being "stringly typed", store values as a std::variant that
can hold various types. This means that liboffload doesn't have to do
any string parsing for integer/bool device info keys.
This commit is contained in:
Ross Brunton
2025-06-20 15:05:05 +01:00
committed by GitHub
parent e0633d59b9
commit f242360e15
2 changed files with 38 additions and 21 deletions

View File

@@ -246,23 +246,23 @@ Error olGetDeviceInfoImplDetail(ol_device_handle_t Device,
ReturnHelper ReturnValue(PropSize, PropValue, PropSizeRet);
// Find the info if it exists under any of the given names
auto GetInfo = [&](std::vector<std::string> Names) {
auto GetInfoString = [&](std::vector<std::string> Names) {
if (Device == OffloadContext::get().HostDevice())
return std::string("Host");
return "Host";
if (!Device->Device)
return std::string("");
return "";
auto Info = Device->Device->obtainInfoImpl();
if (auto Err = Info.takeError())
return std::string("");
return "";
for (auto Name : Names) {
if (auto Entry = Info->get(Name))
return (*Entry)->Value;
return std::get<std::string>((*Entry)->Value).c_str();
}
return std::string("");
return "";
};
switch (PropName) {
@@ -273,12 +273,12 @@ Error olGetDeviceInfoImplDetail(ol_device_handle_t Device,
? ReturnValue(OL_DEVICE_TYPE_HOST)
: ReturnValue(OL_DEVICE_TYPE_GPU);
case OL_DEVICE_INFO_NAME:
return ReturnValue(GetInfo({"Device Name"}).c_str());
return ReturnValue(GetInfoString({"Device Name"}));
case OL_DEVICE_INFO_VENDOR:
return ReturnValue(GetInfo({"Vendor Name"}).c_str());
return ReturnValue(GetInfoString({"Vendor Name"}));
case OL_DEVICE_INFO_DRIVER_VERSION:
return ReturnValue(
GetInfo({"CUDA Driver Version", "HSA Runtime Version"}).c_str());
GetInfoString({"CUDA Driver Version", "HSA Runtime Version"}));
default:
return createOffloadError(ErrorCode::INVALID_ENUMERATION,
"getDeviceInfo enum '%i' is invalid", PropName);

View File

@@ -17,6 +17,7 @@
#include <list>
#include <map>
#include <shared_mutex>
#include <variant>
#include <vector>
#include "ExclusiveAccess.h"
@@ -122,7 +123,8 @@ struct InfoTreeNode {
static constexpr uint64_t IndentSize = 4;
std::string Key;
std::string Value;
using VariantType = std::variant<uint64_t, std::string, bool, std::monostate>;
VariantType Value;
std::string Units;
// Need to specify a default value number of elements here as `InfoTreeNode`'s
// size is unknown. This is a vector (rather than a Key->Value map) since:
@@ -131,15 +133,15 @@ struct InfoTreeNode {
// * The same key can appear multiple times
std::unique_ptr<llvm::SmallVector<InfoTreeNode, 8>> Children;
InfoTreeNode() : InfoTreeNode("", "", "") {}
InfoTreeNode(std::string Key, std::string Value, std::string Units)
InfoTreeNode() : InfoTreeNode("", std::monostate{}, "") {}
InfoTreeNode(std::string Key, VariantType Value, std::string Units)
: Key(Key), Value(Value), Units(Units) {}
/// Add a new info entry as a child of this node. The entry requires at least
/// a key string in \p Key. The value in \p Value is optional and can be any
/// type that is representable as a string. The units in \p Units is optional
/// and must be a string.
template <typename T = std::string>
template <typename T = std::monostate>
InfoTreeNode *add(std::string Key, T Value = T(),
const std::string &Units = std::string()) {
assert(!Key.empty() && "Invalid info key");
@@ -147,15 +149,15 @@ struct InfoTreeNode {
if (!Children)
Children = std::make_unique<llvm::SmallVector<InfoTreeNode, 8>>();
std::string ValueStr;
if constexpr (std::is_same_v<T, bool>)
ValueStr = Value ? "Yes" : "No";
VariantType ValueVariant;
if constexpr (std::is_same_v<T, bool> || std::is_same_v<T, std::monostate>)
ValueVariant = Value;
else if constexpr (std::is_arithmetic_v<T>)
ValueStr = std::to_string(Value);
ValueVariant = static_cast<uint64_t>(Value);
else
ValueStr = Value;
ValueVariant = std::string{Value};
return &Children->emplace_back(Key, ValueStr, Units);
return &Children->emplace_back(Key, ValueVariant, Units);
}
std::optional<InfoTreeNode *> get(StringRef Key) {
@@ -184,8 +186,23 @@ private:
MaxKeySize - (Key.size() + KeyIndentSize) + IndentSize;
llvm::outs() << std::string(KeyIndentSize, ' ') << Key
<< std::string(ValIndentSize, ' ') << Value
<< (Units.empty() ? "" : " ") << Units << "\n";
<< std::string(ValIndentSize, ' ');
std::visit(
[](auto &&V) {
using T = std::decay_t<decltype(V)>;
if constexpr (std::is_same_v<T, std::string>)
llvm::outs() << V;
else if constexpr (std::is_same_v<T, bool>)
llvm::outs() << (V ? "Yes" : "No");
else if constexpr (std::is_same_v<T, uint64_t>)
llvm::outs() << V;
else if constexpr (std::is_same_v<T, std::monostate>) {
// Do nothing
} else
static_assert(false, "doPrint visit not exhaustive");
},
Value);
llvm::outs() << (Units.empty() ? "" : " ") << Units << "\n";
}
// Print children