Skip to content

[Offload] Add MAX_WORK_GROUP_SIZE device info query #143718

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.

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

Merged
merged 2 commits into from
Jul 2, 2025
Merged
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion offload/liboffload/API/Device.td
Original file line number Diff line number Diff line change
@@ -31,7 +31,8 @@ def : Enum {
TaggedEtor<"PLATFORM", "ol_platform_handle_t", "the platform associated with the device">,
TaggedEtor<"NAME", "char[]", "Device name">,
TaggedEtor<"VENDOR", "char[]", "Device vendor">,
TaggedEtor<"DRIVER_VERSION", "char[]", "Driver version">
TaggedEtor<"DRIVER_VERSION", "char[]", "Driver version">,
TaggedEtor<"MAX_WORK_GROUP_SIZE", "ol_dimensions_t", "Maximum work group size in each dimension">,
];
}

40 changes: 40 additions & 0 deletions offload/liboffload/src/OffloadImpl.cpp
Original file line number Diff line number Diff line change
@@ -302,6 +302,41 @@ Error olGetDeviceInfoImplDetail(ol_device_handle_t Device,
"plugin did not provide a response for this information");
};

auto getInfoXyz =
[&](std::vector<std::string> Names) -> llvm::Expected<ol_dimensions_t> {
for (auto &Name : Names) {
if (auto Entry = Device->Info.get(Name)) {
auto Node = *Entry;
ol_dimensions_t Out{0, 0, 0};

auto getField = [&](StringRef Name, uint32_t &Dest) {
if (auto F = Node->get(Name)) {
if (!std::holds_alternative<size_t>((*F)->Value))
return makeError(
ErrorCode::BACKEND_FAILURE,
"plugin returned incorrect type for dimensions element");
Dest = std::get<size_t>((*F)->Value);
} else
return makeError(ErrorCode::BACKEND_FAILURE,
"plugin didn't provide all values for dimensions");
return Plugin::success();
};

if (auto Res = getField("x", Out.x))
return Res;
if (auto Res = getField("y", Out.y))
return Res;
if (auto Res = getField("z", Out.z))
return Res;

return Out;
}
}

return makeError(ErrorCode::UNIMPLEMENTED,
"plugin did not provide a response for this information");
};

switch (PropName) {
case OL_DEVICE_INFO_PLATFORM:
return Info.write<void *>(Device->Platform);
@@ -314,6 +349,9 @@ Error olGetDeviceInfoImplDetail(ol_device_handle_t Device,
case OL_DEVICE_INFO_DRIVER_VERSION:
return Info.writeString(
getInfoString({"CUDA Driver Version", "HSA Runtime Version"}));
case OL_DEVICE_INFO_MAX_WORK_GROUP_SIZE:
return Info.write(getInfoXyz({"Workgroup Max Size per Dimension" /*AMD*/,
"Maximum Block Dimensions" /*CUDA*/}));
default:
return createOffloadError(ErrorCode::INVALID_ENUMERATION,
"getDeviceInfo enum '%i' is invalid", PropName);
@@ -339,6 +377,8 @@ Error olGetDeviceInfoImplDetailHost(ol_device_handle_t Device,
return Info.writeString("Liboffload");
case OL_DEVICE_INFO_DRIVER_VERSION:
return Info.writeString(LLVM_VERSION_STRING);
case OL_DEVICE_INFO_MAX_WORK_GROUP_SIZE:
return Info.write<ol_dimensions_t>(ol_dimensions_t{1, 1, 1});
default:
return createOffloadError(ErrorCode::INVALID_ENUMERATION,
"getDeviceInfo enum '%i' is invalid", PropName);
5 changes: 5 additions & 0 deletions offload/tools/offload-tblgen/PrintGen.cpp
Original file line number Diff line number Diff line change
@@ -213,6 +213,11 @@ template <typename T> inline void printTagged(llvm::raw_ostream &os, const void
"enum {0} value);\n",
EnumRec{R}.getName());
}
for (auto *R : Records.getAllDerivedDefinitions("Struct")) {
OS << formatv("inline llvm::raw_ostream &operator<<(llvm::raw_ostream &os, "
"const struct {0} param);\n",
StructRec{R}.getName());
}
OS << "\n";

// Create definitions
9 changes: 9 additions & 0 deletions offload/unittests/OffloadAPI/device/olGetDeviceInfo.cpp
Original file line number Diff line number Diff line change
@@ -77,6 +77,15 @@ TEST_P(olGetDeviceInfoTest, SuccessDriverVersion) {
ASSERT_EQ(std::strlen(DriverVersion.data()), Size - 1);
}

TEST_P(olGetDeviceInfoTest, SuccessMaxWorkGroupSize) {
ol_dimensions_t Value{0, 0, 0};
ASSERT_SUCCESS(olGetDeviceInfo(Device, OL_DEVICE_INFO_MAX_WORK_GROUP_SIZE,
sizeof(Value), &Value));
ASSERT_GT(Value.x, 0u);
ASSERT_GT(Value.y, 0u);
ASSERT_GT(Value.z, 0u);
}

TEST_P(olGetDeviceInfoTest, InvalidNullHandleDevice) {
ol_device_type_t DeviceType;
ASSERT_ERROR(OL_ERRC_INVALID_NULL_HANDLE,
8 changes: 8 additions & 0 deletions offload/unittests/OffloadAPI/device/olGetDeviceInfoSize.cpp
Original file line number Diff line number Diff line change
@@ -44,6 +44,14 @@ TEST_P(olGetDeviceInfoSizeTest, SuccessDriverVersion) {
ASSERT_NE(Size, 0ul);
}

TEST_P(olGetDeviceInfoSizeTest, SuccessMaxWorkGroupSize) {
size_t Size = 0;
ASSERT_SUCCESS(
olGetDeviceInfoSize(Device, OL_DEVICE_INFO_MAX_WORK_GROUP_SIZE, &Size));
ASSERT_EQ(Size, sizeof(ol_dimensions_t));
ASSERT_EQ(Size, sizeof(uint32_t) * 3);
}

TEST_P(olGetDeviceInfoSizeTest, InvalidNullHandle) {
size_t Size = 0;
ASSERT_ERROR(OL_ERRC_INVALID_NULL_HANDLE,