Reworked builder.Debug semantics. (#1103)

* Introduced DebugConfig to configure debugging in ILGPU land. * Adjusted context properties accordingly. * Adjusted Inliner to obsolete inlining flags. * Adapted TestContext instances in ILGPU tests. * Disabled IO operations in VelocityBackend. * Adapted ILGPU tests contexts to turn on assertion checks in all configurations. * Adapted ILGPU.Algorithms tests contexts to turn off assertion checks in O1 and O2 builds on Cuda and OpenCL platforms. * Adapted Samples.
m4rs-mt · Oct 23, 2023 · 9c2518f · 9c2518f
1 parent 32c6e13
commit 9c2518f
Show file tree

Hide file tree

Showing 19 changed files with 213 additions and 99 deletions.
diff --git a/Samples/SimpleDebugAssert/Program.cs b/Samples/SimpleDebugAssert/Program.cs
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------------------------
 //                                    ILGPU Samples
-//                           Copyright (c) 2021 ILGPU Project
+//                        Copyright (c) 2021-2023 ILGPU Project
 //                                    www.ilgpu.net
 //
 // File: Program.cs
@@ -43,7 +43,7 @@ static void Main()
             // Create main context
             using var context = Context.Create(builder =>
             {
-                builder.Cuda().OpenCL().AutoAssertions();
+                builder.Cuda().OpenCL().DebugConfig(enableAssertions: true);
                 // Alternatives to explore:
                 //   builder.Default();
                 //   builder.AllAccelerators().Debug();

diff --git a/Src/ILGPU.Algorithms.Tests.CPU/Configurations.tt b/Src/ILGPU.Algorithms.Tests.CPU/Configurations.tt
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------------------------
 //                                   ILGPU Algorithms
-//                           Copyright (c) 2021 ILGPU Project
+//                        Copyright (c) 2021-2023 ILGPU Project
 //                                    www.ilgpu.net
 //
 // File: Configurations.tt/Configurations.cs
@@ -44,6 +44,8 @@ namespace ILGPU.Algorithms.Tests.CPU
         public CPUTestContext<#= config #>()
             : base(
                 OptimizationLevel.<#= level #>,
+                enableAssertions: true,
+                forceDebugConfig: true,
                 builder => builder.EnableAlgorithms())
         { }
     }

diff --git a/Src/ILGPU.Algorithms.Tests.Cuda/Configurations.tt b/Src/ILGPU.Algorithms.Tests.Cuda/Configurations.tt
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------------------------
 //                                   ILGPU Algorithms
-//                           Copyright (c) 2021 ILGPU Project
+//                        Copyright (c) 2021-2023 ILGPU Project
 //                                    www.ilgpu.net
 //
 // File: Configurations.tt/Configurations.cs
@@ -44,6 +44,8 @@ namespace ILGPU.Algorithms.Tests.Cuda
         public CudaTestContext<#= config #>()
             : base(
                 OptimizationLevel.<#= level #>,
+                enableAssertions: false,
+                forceDebugConfig: false,
                 builder => builder.EnableAlgorithms())
         { }
     }

diff --git a/Src/ILGPU.Algorithms.Tests.OpenCL/Configurations.tt b/Src/ILGPU.Algorithms.Tests.OpenCL/Configurations.tt
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------------------------
 //                                   ILGPU Algorithms
-//                           Copyright (c) 2021 ILGPU Project
+//                        Copyright (c) 2021-2023 ILGPU Project
 //                                    www.ilgpu.net
 //
 // File: Configurations.tt/Configurations.cs
@@ -44,6 +44,8 @@ namespace ILGPU.Algorithms.Tests.OpenCL
         public CLTestContext<#= config #>()
             : base(
                 OptimizationLevel.<#= level #>,
+                enableAssertions: false,
+                forceDebugConfig: false,
                 builder => builder.EnableAlgorithms())
         { }
     }

diff --git a/Src/ILGPU.Tests.CPU/Configurations.tt b/Src/ILGPU.Tests.CPU/Configurations.tt
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------------------------
 //                                        ILGPU
-//                           Copyright (c) 2021 ILGPU Project
+//                        Copyright (c) 2021-2023 ILGPU Project
 //                                    www.ilgpu.net
 //
 // File: Configurations.tt/Configurations.cs
@@ -40,7 +40,11 @@ namespace ILGPU.Tests.CPU
     public class CPUTestContext<#= config #> : CPUTestContext
     {
         public CPUTestContext<#= config #>()
-            : base(OptimizationLevel.<#= level #>)
+            : base(
+                OptimizationLevel.<#= level #>,
+                enableAssertions: true,
+                forceDebugConfig: true,
+                _ => { })
         { }
     }
 

diff --git a/Src/ILGPU.Tests.CPU/RuntimeTests.cs b/Src/ILGPU.Tests.CPU/RuntimeTests.cs
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------------------------
 //                                        ILGPU
-//                           Copyright (c) 2021 ILGPU Project
+//                        Copyright (c) 2021-2023 ILGPU Project
 //                                    www.ilgpu.net
 //
 // File: RuntimeTests.cs
@@ -69,8 +69,9 @@ public void TestCustomDeviceSetup(
                 Skip.If(customDevice.NumThreads > maxNumThreads);
             }
 
-            using var context = Context.Create(builder =>
-                builder.Assertions().CPU(customDevice));
+            using var context = Context.Create(builder => builder
+                .DebugConfig(enableAssertions: true)
+                .CPU(customDevice));
 
             // Spawn a new accelerator and invoke a simple sequence kernel to check
             // whether all threads are actually executed

diff --git a/Src/ILGPU.Tests.CPU/TestContext.cs b/Src/ILGPU.Tests.CPU/TestContext.cs
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------------------------
 //                                        ILGPU
-//                           Copyright (c) 2021 ILGPU Project
+//                        Copyright (c) 2021-2023 ILGPU Project
 //                                    www.ilgpu.net
 //
 // File: TestContext.cs
@@ -52,22 +52,24 @@ private static CPUDeviceKind GetCPUDeviceKind()
         /// Creates a new test context instance.
         /// </summary>
         /// <param name="optimizationLevel">The optimization level to use.</param>
+        /// <param name="enableAssertions">
+        /// Enables use of assertions.
+        /// </param>
+        /// <param name="forceDebugConfig">
+        /// Forces use of debug configuration in O1 and O2 builds.
+        /// </param>
         /// <param name="prepareContext">The context preparation handler.</param>
         protected CPUTestContext(
             OptimizationLevel optimizationLevel,
+            bool enableAssertions,
+            bool forceDebugConfig,
             Action<Context.Builder> prepareContext)
             : base(
                   optimizationLevel,
+                  enableAssertions,
+                  forceDebugConfig,
                   builder => prepareContext(builder.CPU(GetCPUDeviceKind())),
                   context => context.CreateCPUAccelerator(0))
         { }
-
-        /// <summary>
-        /// Creates a new test context instance.
-        /// </summary>
-        /// <param name="optimizationLevel">The optimization level to use.</param>
-        protected CPUTestContext(OptimizationLevel optimizationLevel)
-            : this(optimizationLevel, _ => { })
-        { }
     }
 }
diff --git a/Src/ILGPU.Tests.Cuda/Configurations.tt b/Src/ILGPU.Tests.Cuda/Configurations.tt
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------------------------
 //                                        ILGPU
-//                           Copyright (c) 2021 ILGPU Project
+//                        Copyright (c) 2021-2023 ILGPU Project
 //                                    www.ilgpu.net
 //
 // File: Configurations.tt/Configurations.cs
@@ -39,7 +39,11 @@ namespace ILGPU.Tests.Cuda
     public class CudaTestContext<#= config #> : CudaTestContext
     {
         public CudaTestContext<#= config #>()
-            : base(OptimizationLevel.<#= level #>)
+            : base(
+                OptimizationLevel.<#= level #>,
+                enableAssertions: true,
+                forceDebugConfig: true,
+                _ => { })
         { }
     }
 

diff --git a/Src/ILGPU.Tests.Cuda/TestContext.cs b/Src/ILGPU.Tests.Cuda/TestContext.cs
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------------------------
 //                                        ILGPU
-//                           Copyright (c) 2021 ILGPU Project
+//                        Copyright (c) 2021-2023 ILGPU Project
 //                                    www.ilgpu.net
 //
 // File: TestContext.cs
@@ -23,22 +23,24 @@ public abstract class CudaTestContext : TestContext
         /// Creates a new test context instance.
         /// </summary>
         /// <param name="optimizationLevel">The optimization level to use.</param>
+        /// <param name="enableAssertions">
+        /// Enables use of assertions.
+        /// </param>
+        /// <param name="forceDebugConfig">
+        /// Forces use of debug configuration in O1 and O2 builds.
+        /// </param>
         /// <param name="prepareContext">The context preparation handler.</param>
         protected CudaTestContext(
             OptimizationLevel optimizationLevel,
+            bool enableAssertions,
+            bool forceDebugConfig,
             Action<Context.Builder> prepareContext)
             : base(
                   optimizationLevel,
+                  enableAssertions,
+                  forceDebugConfig,
                   builder => prepareContext(builder.Cuda()),
                   context => context.CreateCudaAccelerator(0))
         { }
-
-        /// <summary>
-        /// Creates a new test context instance.
-        /// </summary>
-        /// <param name="optimizationLevel">The optimization level to use.</param>
-        protected CudaTestContext(OptimizationLevel optimizationLevel)
-            : this(optimizationLevel, _ => { })
-        { }
     }
 }
diff --git a/Src/ILGPU.Tests.OpenCL/Configurations.tt b/Src/ILGPU.Tests.OpenCL/Configurations.tt
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------------------------
 //                                        ILGPU
-//                           Copyright (c) 2021 ILGPU Project
+//                        Copyright (c) 2021-2023 ILGPU Project
 //                                    www.ilgpu.net
 //
 // File: Configurations.tt/Configurations.cs
@@ -39,7 +39,11 @@ namespace ILGPU.Tests.OpenCL
     public class CLTestContext<#= config #> : CLTestContext
     {
         public CLTestContext<#= config #>()
-            : base(OptimizationLevel.<#= level #>)
+            : base(
+                OptimizationLevel.<#= level #>,
+                enableAssertions: true,
+                forceDebugConfig: true,
+                _ => { })
         { }
     }
 

diff --git a/Src/ILGPU.Tests.OpenCL/TestContext.cs b/Src/ILGPU.Tests.OpenCL/TestContext.cs
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------------------------
 //                                        ILGPU
-//                           Copyright (c) 2021 ILGPU Project
+//                        Copyright (c) 2021-2023 ILGPU Project
 //                                    www.ilgpu.net
 //
 // File: TestContext.cs
@@ -23,22 +23,24 @@ public abstract class CLTestContext : TestContext
         /// Creates a new test context instance.
         /// </summary>
         /// <param name="optimizationLevel">The optimization level to use.</param>
+        /// <param name="enableAssertions">
+        /// Enables use of assertions.
+        /// </param>
+        /// <param name="forceDebugConfig">
+        /// Forces use of debug configuration in O1 and O2 builds.
+        /// </param>
         /// <param name="prepareContext">The context preparation handler.</param>
         protected CLTestContext(
             OptimizationLevel optimizationLevel,
+            bool enableAssertions,
+            bool forceDebugConfig,
             Action<Context.Builder> prepareContext)
             : base(
                   optimizationLevel,
+                  enableAssertions,
+                  forceDebugConfig,
                   builder => prepareContext(builder.OpenCL()),
                   context => context.CreateCLAccelerator(0))
         { }
-
-        /// <summary>
-        /// Creates a new test context instance.
-        /// </summary>
-        /// <param name="optimizationLevel">The optimization level to use.</param>
-        protected CLTestContext(OptimizationLevel optimizationLevel)
-            : this(optimizationLevel, _ => { })
-        { }
     }
 }
diff --git a/Src/ILGPU.Tests.Velocity/Configurations.tt b/Src/ILGPU.Tests.Velocity/Configurations.tt
@@ -39,7 +39,11 @@ namespace ILGPU.Tests.Velocity
     public class VelocityTestContext<#= config #> : VelocityTestContext
     {
         public VelocityTestContext<#= config #>()
-            : base(OptimizationLevel.<#= level #>)
+            : base(
+                OptimizationLevel.<#= level #>,
+                enableAssertions: true,
+                forceDebugConfig: true,
+                _ => { })
         { }
     }
 

diff --git a/Src/ILGPU.Tests.Velocity/TestContext.cs b/Src/ILGPU.Tests.Velocity/TestContext.cs
@@ -23,23 +23,25 @@ public abstract class VelocityTestContext : TestContext
         /// Creates a new test context instance.
         /// </summary>
         /// <param name="optimizationLevel">The optimization level to use.</param>
+        /// <param name="enableAssertions">
+        /// Enables use of assertions.
+        /// </param>
+        /// <param name="forceDebugConfig">
+        /// Forces use of debug configuration in O1 and O2 builds.
+        /// </param>
         /// <param name="prepareContext">The context preparation handler.</param>
         protected VelocityTestContext(
             OptimizationLevel optimizationLevel,
+            bool enableAssertions,
+            bool forceDebugConfig,
             Action<Context.Builder> prepareContext)
             : base(
                   optimizationLevel,
+                  enableAssertions,
+                  forceDebugConfig,
                   builder => prepareContext(
                       builder.Velocity(VelocityDeviceType.Scalar2)),
                   context => context.CreateVelocityAccelerator())
         { }
-
-        /// <summary>
-        /// Creates a new test context instance.
-        /// </summary>
-        /// <param name="optimizationLevel">The optimization level to use.</param>
-        protected VelocityTestContext(OptimizationLevel optimizationLevel)
-            : this(optimizationLevel, _ => { })
-        { }
     }
 }
diff --git a/Src/ILGPU.Tests/Generic/TestContext.cs b/Src/ILGPU.Tests/Generic/TestContext.cs
@@ -1,6 +1,6 @@
 // ---------------------------------------------------------------------------------------
 //                                        ILGPU
-//                        Copyright (c) 2021-2022 ILGPU Project
+//                        Copyright (c) 2021-2023 ILGPU Project
 //                                    www.ilgpu.net
 //
 // File: TestContext.cs
@@ -24,22 +24,34 @@ public abstract class TestContext : DisposeBase
         /// Constructs a new context provider.
         /// </summary>
         /// <param name="level">The optimization level.</param>
+        /// <param name="enableAssertions">
+        /// Enables use of assertions.
+        /// </param>
+        /// <param name="forceDebugConfig">
+        /// Forces use of debug configuration in O1 and O2 builds.
+        /// </param>
         /// <param name="prepareContext">
         /// Prepares the context by setting additional field/initializing specific
         /// items before the accelerator is created.
         /// </param>
         /// <param name="createAccelerator">Creates a new accelerator.</param>
         protected TestContext(
             OptimizationLevel level,
+            bool enableAssertions,
+            bool forceDebugConfig,
             Action<Context.Builder> prepareContext,
             Func<Context, Accelerator> createAccelerator)
         {
             Context = Context.Create(builder =>
                 prepareContext(
                     builder
-                    .Assertions()
+                    .DebugConfig(
+                        enableAssertions: enableAssertions,
+                        enableIOOperations: true,
+                        debugSymbolsMode: DebugSymbolsMode.Auto,
+                        forceDebuggingOfOptimizedKernels: forceDebugConfig,
+                        enableIRVerifier: true)
                     .Arrays(ArrayMode.InlineMutableStaticArrays)
-                    .Verify()
                     .Optimize(level)
                     .Profiling()));
             Accelerator = createAccelerator(Context);

diff --git a/Src/ILGPU/Backends/Velocity/VelocityBackend.cs b/Src/ILGPU/Backends/Velocity/VelocityBackend.cs
@@ -89,7 +89,7 @@ public VelocityBackend(
                         PointerType,
                         warpSize,
                         Context.Properties.EnableAssertions,
-                        Context.Properties.EnableIOOperations),
+                        enableIOOperations: false),
                     context.Properties.InliningMode,
                     context.Properties.OptimizationLevel);