[SYCL][E2E] Add helper functions to access environment variables (#15226)

The usage of `getenv` is deprecated on Windows in favor of `_dupenv_s`,
this change adds helper functions to use the appropriate function
depending on the OS.

Should resolve the non XPTI test failures from #15026

Author: ayylol

sycl/test-e2e/CompositeDevice/composite_device.cpp

@@ -3,6 +3,7 @@
 // RUN: env ZE_FLAT_DEVICE_HIERARCHY=COMPOSITE %{run} %t.out
 // RUN: env ZE_FLAT_DEVICE_HIERARCHY=FLAT %{run} %t.out
 
+#include "../helpers.hpp"
 #include <sycl/detail/core.hpp>
 #include <sycl/ext/oneapi/experimental/composite_device.hpp>
 
@@ -15,18 +16,7 @@ bool isL0Backend(sycl::backend backend) {
 }
 
 bool isCombinedMode() {
-  char *Mode = nullptr;
-  bool Res = false;
-#ifdef _WIN32
-  size_t Size = 0;
-  auto Err = _dupenv_s(&Mode, &Size, "ZE_FLAT_DEVICE_HIERARCHY");
-  Res = (Mode != nullptr) && (std::strcmp(Mode, "COMBINED") == 0);
-  free(Mode);
-#else
-  Mode = std::getenv("ZE_FLAT_DEVICE_HIERARCHY");
-  Res = (Mode != nullptr) && (std::strcmp(Mode, "COMBINED") == 0);
-#endif
-  return Res;
+  return env::getVal("ZE_FLAT_DEVICE_HIERARCHY") == "COMBINED";
 }
 
 int main() {

sycl/test-e2e/Config/allowlist.cpp

@@ -12,6 +12,7 @@
 // RUN: env TEST_DEVICE_IS_NOT_AVAILABLE=1 env SYCL_DEVICE_ALLOWLIST="PlatformName:{{SUCH NAME DOESN'T EXIST}}" ONEAPI_DEVICE_SELECTOR=opencl:cpu %{run-unfiltered-devices} %t.out
 // RUN: env TEST_INCORRECT_VALUE=1 env SYCL_DEVICE_ALLOWLIST="IncorrectKey:{{.*}}" ONEAPI_DEVICE_SELECTOR=opencl:cpu %{run-unfiltered-devices} %t.out
 
+#include "../helpers.hpp"
 #include <algorithm>
 #include <cstdlib>
 #include <exception>
@@ -33,7 +34,7 @@ static void replaceSpecialCharacters(std::string &Str) {
 int main() {
 
   // Expected that the allowlist filter is not set
-  if (getenv("PRINT_PLATFORM_INFO")) {
+  if (env::isDefined("PRINT_PLATFORM_INFO")) {
     for (const sycl::platform &Platform : sycl::platform::get_platforms()) {
       std::string Name = Platform.get_info<sycl::info::platform::name>();
       std::string Ver = Platform.get_info<sycl::info::platform::version>();
@@ -51,7 +52,7 @@ int main() {
   }
 
   // Expected that the allowlist filter is not set
-  if (getenv("PRINT_DEVICE_INFO")) {
+  if (env::isDefined("PRINT_DEVICE_INFO")) {
     for (const sycl::platform &Platform : sycl::platform::get_platforms()) {
       const sycl::device Dev = Platform.get_devices().at(0);
       std::string Name = Dev.get_info<sycl::info::device::name>();
@@ -71,7 +72,7 @@ int main() {
   }
 
   // Expected the allowlist to be set with the "PRINT_DEVICE_INFO" run result
-  if (getenv("TEST_DEVICE_AVAILABLE")) {
+  if (env::isDefined("TEST_DEVICE_AVAILABLE")) {
     for (const sycl::platform &Platform : sycl::platform::get_platforms()) {
       if (Platform.get_devices().size() != 1)
         throw std::runtime_error("Expected only one device.");
@@ -82,13 +83,13 @@ int main() {
   }
 
   // Expected the allowlist to be set but empty
-  if (getenv("TEST_DEVICE_IS_NOT_AVAILABLE")) {
+  if (env::isDefined("TEST_DEVICE_IS_NOT_AVAILABLE")) {
     if (!sycl::platform::get_platforms().empty())
       throw std::runtime_error("Expected no device is available");
     return 0;
   }
 
-  if (getenv("TEST_INCORRECT_VALUE")) {
+  if (env::isDefined("TEST_INCORRECT_VALUE")) {
     try {
       sycl::platform::get_platforms();
     } catch (sycl::exception &E) {

sycl/test-e2e/Config/env_vars.cpp

@@ -13,6 +13,7 @@
 // RUN: %if cpu %{ env SYCL_PROGRAM_COMPILE_OPTIONS="-enable-link-options -cl-denorms-are-zero" SHOULD_CRASH=1 %{run} %t.out %}
 // RUN: %if cpu %{ env SYCL_PROGRAM_APPEND_COMPILE_OPTIONS="-enable-link-options -cl-denorms-are-zero" SHOULD_CRASH=1 %{run} %t.out %}
 
+#include "../helpers.hpp"
 #include <cassert>
 #include <sycl/detail/core.hpp>
 
@@ -22,7 +23,7 @@ int main() {
   int data = 5;
   buffer<int, 1> buf(&data, range<1>(1));
   queue myQueue;
-  bool shouldCrash = getenv("SHOULD_CRASH");
+  bool shouldCrash = env::isDefined("SHOULD_CRASH");
   try {
     myQueue.submit([&](handler &cgh) {
       auto B = buf.get_access<access::mode::read_write>(cgh);

sycl/test-e2e/DeviceLib/assert-windows.cpp

@@ -22,6 +22,7 @@
 //
 // CHECK-FALLBACK: ---> urProgramLink
 
+#include "../helpers.hpp"
 #include <array>
 #include <assert.h>
 #include <iostream>
@@ -47,7 +48,7 @@ void simple_vadd(const std::array<T, N> &VA, const std::array<T, N> &VB,
     }
   });
 
-  int shouldCrash = getenv("SHOULD_CRASH") ? 1 : 0;
+  bool shouldCrash = env::isDefined("SHOULD_CRASH");
 
   sycl::range<1> numOfItems{N};
   sycl::buffer<T, 1> bufferA(VA.data(), numOfItems);

sycl/test-e2e/DeviceLib/assert.cpp

@@ -91,6 +91,7 @@
 // Note that the work-item that hits the assert first may vary, since the order
 // of execution is undefined. We catch only the first one (whatever id it is).
 
+#include "../helpers.hpp"
 #include "sycl/backend/opencl.hpp"
 #include <array>
 #include <assert.h>
@@ -128,7 +129,7 @@ void simple_vadd(const std::array<T, N> &VA, const std::array<T, N> &VB,
   if (sycl::opencl::has_extension(dev, "cl_intel_devicelib_assert")) {
     unsupported = false;
   }
-  if (unsupported && getenv("SKIP_IF_NO_EXT")) {
+  if (unsupported && env::isDefined("SKIP_IF_NO_EXT")) {
     fprintf(stderr, "Device has no support for cl_intel_devicelib_assert, "
                     "skipping the test\n");
     exit(EXIT_SKIP_TEST);
@@ -160,7 +161,7 @@ int main() {
     if (WIFEXITED(status) && WEXITSTATUS(status) == EXIT_SKIP_TEST) {
       return 0;
     }
-    if (getenv("SHOULD_CRASH")) {
+    if (env::isDefined("SHOULD_CRASH")) {
       if (!WIFSIGNALED(status)) {
         fprintf(stderr, "error: process did not terminate by a signal\n");
         return 1;
@@ -176,12 +177,13 @@ int main() {
     }
     int sig = WTERMSIG(status);
     int expected = 0;
-    if (const char *env = getenv("EXPECTED_SIGNAL")) {
-      if (0 == strcmp(env, "SIGABRT")) {
+    const std::string envVal = env::getVal("EXPECTED_SIGNAL");
+    if (!envVal.empty()) {
+      if (envVal == "SIGABRT") {
         expected = SIGABRT;
-      } else if (0 == strcmp(env, "SIGSEGV")) {
+      } else if (envVal == "SIGSEGV") {
         expected = SIGSEGV;
-      } else if (0 == strcmp(env, "SIGIOT")) {
+      } else if (envVal == "SIGIOT") {
         expected = SIGIOT;
       }
       if (!expected) {

sycl/test-e2e/FilterSelector/select_device.cpp

@@ -15,44 +15,45 @@
 
 #include <iostream>
 
+#include "../helpers.hpp"
 #include <sycl/detail/core.hpp>
 
 using namespace sycl;
 using namespace std;
 
 int main() {
-  const char *envVal = std::getenv("ONEAPI_DEVICE_SELECTOR");
+  std::string envVal = env::getVal("ONEAPI_DEVICE_SELECTOR");
   std::string forcedPIs;
-  if (envVal) {
+  if (envVal.empty()) {
     forcedPIs = envVal;
   }
-  if (!envVal || forcedPIs == "*" ||
+  if (!envVal.empty() || forcedPIs == "*" ||
       forcedPIs.find("level_zero:gpu") != std::string::npos) {
     default_selector ds;
     device d = ds.select_device();
     string name = d.get_platform().get_info<info::platform::name>();
     assert(name.find("Level-Zero") != string::npos);
   }
-  if (envVal && forcedPIs != "*" &&
+  if (envVal.empty() && forcedPIs != "*" &&
       forcedPIs.find("opencl:gpu") != std::string::npos) {
     gpu_selector gs;
     device d = gs.select_device();
     string name = d.get_platform().get_info<info::platform::name>();
     assert(name.find("OpenCL") != string::npos);
   }
-  if (!envVal || forcedPIs == "*" ||
+  if (!envVal.empty() || forcedPIs == "*" ||
       forcedPIs.find("cpu") != std::string::npos) {
     cpu_selector cs;
     device d = cs.select_device();
   }
-  if (!envVal || forcedPIs == "*" ||
+  if (!envVal.empty() || forcedPIs == "*" ||
       forcedPIs.find("fpga") != std::string::npos) {
     accelerator_selector as;
     device d = as.select_device();
   }
-  if (envVal && (forcedPIs.find("cpu") == std::string::npos &&
-                 forcedPIs.find("opencl") == std::string::npos &&
-                 forcedPIs.find("*") == std::string::npos)) {
+  if (envVal.empty() && (forcedPIs.find("cpu") == std::string::npos &&
+                         forcedPIs.find("opencl") == std::string::npos &&
+                         forcedPIs.find("*") == std::string::npos)) {
     try {
       cpu_selector cs;
       device d = cs.select_device();

sycl/test-e2e/FilterSelector/select_device_acc.cpp

@@ -10,15 +10,16 @@
 
 #include <iostream>
 
+#include "../helpers.hpp"
 #include <sycl/detail/core.hpp>
 
 using namespace sycl;
 using namespace std;
 
 int main() {
-  const char *envVal = std::getenv("ONEAPI_DEVICE_SELECTOR");
+  std::string envVal = env::getVal("ONEAPI_DEVICE_SELECTOR");
   std::string forcedPIs;
-  if (envVal) {
+  if (envVal.empty()) {
     forcedPIs = envVal;
   }
   {

sycl/test-e2e/FilterSelector/select_device_cpu.cpp

@@ -10,15 +10,16 @@
 
 #include <iostream>
 
+#include "../helpers.hpp"
 #include <sycl/ext/oneapi/filter_selector.hpp>
 
 using namespace sycl;
 using namespace std;
 
 int main() {
-  const char *envVal = std::getenv("ONEAPI_DEVICE_SELECTOR");
+  std::string envVal = env::getVal("ONEAPI_DEVICE_SELECTOR");
   std::string forcedPIs;
-  if (envVal) {
+  if (envVal.empty()) {
     forcedPIs = envVal;
   }
   {

sycl/test-e2e/FilterSelector/select_device_cuda.cpp

@@ -10,15 +10,16 @@
 
 #include <iostream>
 
+#include "../helpers.hpp"
 #include <sycl/detail/core.hpp>
 
 using namespace sycl;
 using namespace std;
 
 int main() {
-  const char *envVal = getenv("ONEAPI_DEVICE_SELECTOR");
+  std::string envVal = env::getVal("ONEAPI_DEVICE_SELECTOR");
   string forcedPIs;
-  if (envVal) {
+  if (envVal.empty()) {
     forcedPIs = envVal;
   }
 

sycl/test-e2e/FilterSelector/select_device_level_zero.cpp

@@ -8,16 +8,17 @@
 //
 // REQUIRES: level_zero,gpu
 
+#include "../helpers.hpp"
 #include <iostream>
 #include <sycl/detail/core.hpp>
 
 using namespace sycl;
 using namespace std;
 
 int main() {
-  const char *envVal = getenv("ONEAPI_DEVICE_SELECTOR");
+  std::string envVal = env::getVal("ONEAPI_DEVICE_SELECTOR");
   string forcedPIs;
-  if (envVal) {
+  if (envVal.empty()) {
     forcedPIs = envVal;
   }