Skip to content

[SYCL] Add deprecation warnings for unstable keys of SYCL_DEVICE_ALLOWLIST #4455

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

Merged
merged 2 commits into from
Sep 7, 2021
Merged

[SYCL] Add deprecation warnings for unstable keys of SYCL_DEVICE_ALLOWLIST #4455

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
958be5b
[SYCL] Add deprecation warnings for unstable keys of SYCL_DEVICE_ALLO…
dm-vodopyanov Sep 1, 2021
d56f0fc
Change std::cerr to std::cout
dm-vodopyanov Sep 3, 2021
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
34 changes: 34 additions & 0 deletions sycl/source/detail/allowlist.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,12 @@ AllowListParsedT parseAllowList(const std::string &AllowListRaw) {
"doc/EnvironmentVariables.md",
PI_INVALID_VALUE);

const std::string &DeprecatedKeyNameDeviceName = DeviceNameKeyName;
const std::string &DeprecatedKeyNamePlatformName = PlatformNameKeyName;

bool IsDeprecatedKeyNameDeviceNameWasUsed = false;
bool IsDeprecatedKeyNamePlatformNameWasUsed = false;

while ((KeyEnd = AllowListRaw.find(DelimiterBtwKeyAndValue, KeyStart)) !=
std::string::npos) {
if ((ValueStart = AllowListRaw.find_first_not_of(
Expand All @@ -96,6 +102,13 @@ AllowListParsedT parseAllowList(const std::string &AllowListRaw) {
PI_INVALID_VALUE);
}

if (Key == DeprecatedKeyNameDeviceName) {
IsDeprecatedKeyNameDeviceNameWasUsed = true;
}
if (Key == DeprecatedKeyNamePlatformName) {
IsDeprecatedKeyNamePlatformNameWasUsed = true;
}

bool ShouldAllocateNewDeviceDescMap = false;

std::string Value;
Expand Down Expand Up @@ -241,6 +254,27 @@ AllowListParsedT parseAllowList(const std::string &AllowListRaw) {
}
}

if (IsDeprecatedKeyNameDeviceNameWasUsed &&
IsDeprecatedKeyNamePlatformNameWasUsed) {
std::cout << "\nWARNING: " << DeprecatedKeyNameDeviceName << " and "
<< DeprecatedKeyNamePlatformName
<< " in SYCL_DEVICE_ALLOWLIST are deprecated. ";
} else if (IsDeprecatedKeyNameDeviceNameWasUsed) {
std::cout << "\nWARNING: " << DeprecatedKeyNameDeviceName
<< " in SYCL_DEVICE_ALLOWLIST is deprecated. ";
} else if (IsDeprecatedKeyNamePlatformNameWasUsed) {
std::cout << "\nWARNING: " << DeprecatedKeyNamePlatformName
<< " in SYCL_DEVICE_ALLOWLIST is deprecated. ";
}
if (IsDeprecatedKeyNameDeviceNameWasUsed ||
IsDeprecatedKeyNamePlatformNameWasUsed) {
std::cout << "Please use " << BackendNameKeyName << ", "
<< DeviceTypeKeyName << " and " << DeviceVendorIdKeyName
<< " instead. For details, please refer to "
"https://github.com/intel/llvm/blob/sycl/sycl/doc/"
"EnvironmentVariables.md\n\n";
}

return AllowListParsed;
}

Expand Down
45 changes: 45 additions & 0 deletions sycl/unittests/allowlist/ParseAllowList.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,3 +267,48 @@ TEST(ParseAllowListTests, CheckExceptionIsThrownForValueWOColonDelim) {
FAIL() << "Expected sycl::runtime_error";
}
}

TEST(ParseAllowListTests, CheckDeviceNameDeprecationWarning) {
testing::internal::CaptureStdout();
sycl::detail::parseAllowList("DeviceName:{{regex}}");
std::string ActualOutput = testing::internal::GetCapturedStdout();
EXPECT_EQ("\nWARNING: DeviceName in SYCL_DEVICE_ALLOWLIST is deprecated. "
"Please use BackendName, DeviceType and DeviceVendorId instead. "
"For details, please refer to "
"https://github.com/intel/llvm/blob/sycl/sycl/doc/"
"EnvironmentVariables.md\n\n",
ActualOutput);
}

TEST(ParseAllowListTests, CheckPlatformNameDeprecationWarning) {
testing::internal::CaptureStdout();
sycl::detail::parseAllowList("PlatformName:{{regex}}");
std::string ActualOutput = testing::internal::GetCapturedStdout();
EXPECT_EQ("\nWARNING: PlatformName in SYCL_DEVICE_ALLOWLIST is deprecated. "
"Please use BackendName, DeviceType and DeviceVendorId instead. "
"For details, please refer to "
"https://github.com/intel/llvm/blob/sycl/sycl/doc/"
"EnvironmentVariables.md\n\n",
ActualOutput);
}

TEST(ParseAllowListTests, CheckDeviceNameAndPlatformNameDeprecationWarning) {
testing::internal::CaptureStdout();
sycl::detail::parseAllowList("DeviceName:{{regex}},PlatformName:{{regex}}");
std::string ActualOutput = testing::internal::GetCapturedStdout();
EXPECT_EQ("\nWARNING: DeviceName and PlatformName in SYCL_DEVICE_ALLOWLIST "
"are deprecated. Please use BackendName, DeviceType and "
"DeviceVendorId instead. For details, please refer to "
"https://github.com/intel/llvm/blob/sycl/sycl/doc/"
"EnvironmentVariables.md\n\n",
ActualOutput);
}

TEST(ParseAllowListTests, CheckNoDeprecationWarningForNotDeprecatedKeys) {
testing::internal::CaptureStdout();
sycl::detail::parseAllowList(
"BackendName:level_zero,DeviceType:gpu,DeviceVendorId:0x0000,"
"DriverVersion:{{regex1}},PlatformVersion:{{regex2}}");
std::string ActualOutput = testing::internal::GetCapturedStdout();
EXPECT_EQ("", ActualOutput);
}