[UR][layer] Add exception sanitizer layer

[hdelan]

Add basic exception sanitizer layer that will call std::abort if an exception is thrown. This layer can be used to make sure an adapter isn't throwing, which is prohibited for a C interface. The layer can be enabled by building with the option -DUR_ENABLE_EXCEPTION_SANITIZER=ON

[pbalcer]

I suspect this was never tested :D So might be good to enable this in CI for CTS.

[hdelan]

I suspect this was never tested :D So might be good to enable this in CI for CTS.

Thanks have done so. I'm not sure what the failures are related to.

[EwanC]

LGTM, thanks for improving our code quality

[kbenzie]

So the missing part here is actually enabling the layer in the CTS environment setup, something along the lines of this:

diff --git a/test/conformance/source/environment.cpp b/test/conformance/source/environment.cpp
index 006ea09b..737d26d2 100644
--- a/test/conformance/source/environment.cpp
+++ b/test/conformance/source/environment.cpp
@@ -90,6 +90,14 @@ uur::PlatformEnvironment::PlatformEnvironment(int argc, char **argv)
             error = "Failed to enable validation layer";
             return;
         }
+#ifdef UR_ENABLE_EXCEPTION_SANITIZER
+        if (urLoaderConfigEnableLayer(config, "UR_LAYER_EXCEPTION_SANITIZER") !=
+            UR_RESULT_SUCCESS) {
+            urLoaderConfigRelease(config);
+            error = "Failed to enable exception sanitizer layer";
+            return;
+        }
+#endif
     } else {
         error = "Failed to create loader config handle";
         return;

[kbenzie]

Not sure we need a separate option, we could always enable this as part of UR_DEVELOPER_MODE since that's enabled in CI.

[hdelan]

Thanks, have removed.

[hdelan]

So the missing part here is actually enabling the layer in the CTS environment setup, something along the lines of this:

diff --git a/test/conformance/source/environment.cpp b/test/conformance/source/environment.cpp
index 006ea09b..737d26d2 100644
--- a/test/conformance/source/environment.cpp
+++ b/test/conformance/source/environment.cpp
@@ -90,6 +90,14 @@ uur::PlatformEnvironment::PlatformEnvironment(int argc, char **argv)
             error = "Failed to enable validation layer";
             return;
         }
+#ifdef UR_ENABLE_EXCEPTION_SANITIZER
+        if (urLoaderConfigEnableLayer(config, "UR_LAYER_EXCEPTION_SANITIZER") !=
+            UR_RESULT_SUCCESS) {
+            urLoaderConfigRelease(config);
+            error = "Failed to enable exception sanitizer layer";
+            return;
+        }
+#endif
     } else {
         error = "Failed to create loader config handle";
         return;

Interesting, how was the layer working here without this call?

[pbalcer]

Interesting, how was the layer working here without this call?

The init function of all layers gets called unconditionally, and the layer themselves need to check whether they are on the enabled list.
This is so that a layer can force-enable itself if it's needed as a dependency of something else (e.g., validation layers).

[hdelan]

The init function of all layers gets called unconditionally, and the layer themselves need to check whether they are on the enabled list. This is so that a layer can force-enable itself if it's needed as a dependency of something else (e.g., validation layers).

Aha thanks @pbalcer that explains it

[hdelan]

Have updated. Should be good to go.