Simplified namespaces in HighPerformance package (#3687)

msftbot[bot] · web-flow · commit 1ba232185bdc · 2021-02-05T09:18:20.000Z
## Related to #3422   ## PR Type What kind of change does this PR introduce?  - Refactoring - Improvements         ## Overview Following the suggestion from @mrlacey for non-breaking changes, this PR moves the new `Span2D<T>` and `Memory2D<T>` types introduced in version 7.0 to the root `Microsoft.Toolkit.HighPerformance` namespace (instead of `.Memory`). This is simpler to use for consumers, it makes sense given that the root namespace already contains some other "primitive" types, and it's also more consistent to how the `Span<T>` and `Memory<T>` types are included in the `System.Memory` package, but are still located in the root `System` namespace. This PR also includes some minor codegen improvements to some other extensions, while I was at it 😄 ## PR Checklist Please check if your PR fulfills the following requirements: - [X] Tested code with current [supported SDKs](../readme.md#supported) - [ ] ~~Pull Request has been submitted to the documentation repository [instructions](..\contributing.md#docs). Link: ~~ - [ ] ~~Sample in sample app has been added / updated (for bug fixes / features)~~ - [ ] ~~Icon has been created (if new sample) following the [Thumbnail Style Guide and templates](https://github.com/windows-toolkit/WindowsCommunityToolkit-design-assets)~~ - [X] New major technical changes in the toolkit have or will be added to the [Wiki](https://github.com/windows-toolkit/WindowsCommunityToolkit/wiki) e.g. build changes, source generators, testing infrastructure, sample creation changes, etc... - [X] Tests for the changes have been added (for bug fixes / features) (if applicable) - [X] Header has been added to all new source files (run *build/UpdateHeaders.bat*) - [X] Contains **NO** breaking changes
diff --git a/Microsoft.Toolkit.HighPerformance/Extensions/ArrayExtensions.2D.cs b/Microsoft.Toolkit.HighPerformance/Extensions/ArrayExtensions.2D.cs
@@ -11,7 +11,6 @@
 #endif
 using Microsoft.Toolkit.HighPerformance.Enumerables;
 using Microsoft.Toolkit.HighPerformance.Helpers.Internals;
-using Microsoft.Toolkit.HighPerformance.Memory;
 using RuntimeHelpers = Microsoft.Toolkit.HighPerformance.Helpers.Internals.RuntimeHelpers;
 
 namespace Microsoft.Toolkit.HighPerformance.Extensions
diff --git a/Microsoft.Toolkit.HighPerformance/Extensions/ArrayExtensions.3D.cs b/Microsoft.Toolkit.HighPerformance/Extensions/ArrayExtensions.3D.cs
@@ -10,7 +10,6 @@
 using Microsoft.Toolkit.HighPerformance.Buffers.Internals;
 #endif
 using Microsoft.Toolkit.HighPerformance.Helpers.Internals;
-using Microsoft.Toolkit.HighPerformance.Memory;
 using RuntimeHelpers = Microsoft.Toolkit.HighPerformance.Helpers.Internals.RuntimeHelpers;
 
 namespace Microsoft.Toolkit.HighPerformance.Extensions
diff --git a/Microsoft.Toolkit.HighPerformance/Extensions/BoolExtensions.cs b/Microsoft.Toolkit.HighPerformance/Extensions/BoolExtensions.cs
@@ -23,7 +23,14 @@ public static class BoolExtensions
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public static unsafe byte ToByte(this bool flag)
         {
-            return *(byte*)&flag;
+            // Whenever we need to take the address of an argument, we make a local copy first.
+            // This will be removed by the JIT anyway, but it can help produce better codegen and
+            // remove unwanted stack spills if the caller is using constant arguments. This is
+            // because taking the address of an argument can interfere with some of the flow
+            // analysis executed by the JIT, which can in some cases block constant propagation.
+            bool copy = flag;
+
+            return *(byte*)&copy;
         }
 
         /// <summary>
@@ -58,7 +65,8 @@ public static unsafe int ToInt(this bool flag)
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public static unsafe int ToBitwiseMask32(this bool flag)
         {
-            byte rangeFlag = *(byte*)&flag;
+            bool copy = flag;
+            byte rangeFlag = *(byte*)&copy;
             int
                 negativeFlag = rangeFlag - 1,
                 mask = ~negativeFlag;
@@ -77,7 +85,8 @@ public static unsafe int ToBitwiseMask32(this bool flag)
         [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public static unsafe long ToBitwiseMask64(this bool flag)
         {
-            byte rangeFlag = *(byte*)&flag;
+            bool copy = flag;
+            byte rangeFlag = *(byte*)&copy;
             long
                 negativeFlag = (long)rangeFlag - 1,
                 mask = ~negativeFlag;
diff --git a/Microsoft.Toolkit.HighPerformance/Extensions/MemoryExtensions.cs b/Microsoft.Toolkit.HighPerformance/Extensions/MemoryExtensions.cs
@@ -7,9 +7,6 @@
 using System.IO;
 using System.Runtime.CompilerServices;
 using System.Runtime.InteropServices;
-#if SPAN_RUNTIME_SUPPORT
-using Microsoft.Toolkit.HighPerformance.Memory;
-#endif
 using MemoryStream = Microsoft.Toolkit.HighPerformance.Streams.MemoryStream;
 
 namespace Microsoft.Toolkit.HighPerformance.Extensions
diff --git a/Microsoft.Toolkit.HighPerformance/Extensions/ReadOnlyMemoryExtensions.cs b/Microsoft.Toolkit.HighPerformance/Extensions/ReadOnlyMemoryExtensions.cs
@@ -10,9 +10,6 @@
 using System.Runtime.InteropServices;
 using Microsoft.Toolkit.HighPerformance.Buffers.Internals;
 using Microsoft.Toolkit.HighPerformance.Buffers.Internals.Interfaces;
-#if SPAN_RUNTIME_SUPPORT
-using Microsoft.Toolkit.HighPerformance.Memory;
-#endif
 using MemoryStream = Microsoft.Toolkit.HighPerformance.Streams.MemoryStream;
 
 namespace Microsoft.Toolkit.HighPerformance.Extensions
diff --git a/Microsoft.Toolkit.HighPerformance/Extensions/ReadOnlySpanExtensions.cs b/Microsoft.Toolkit.HighPerformance/Extensions/ReadOnlySpanExtensions.cs
@@ -8,9 +8,6 @@
 using System.Runtime.InteropServices;
 using Microsoft.Toolkit.HighPerformance.Enumerables;
 using Microsoft.Toolkit.HighPerformance.Helpers.Internals;
-#if SPAN_RUNTIME_SUPPORT
-using Microsoft.Toolkit.HighPerformance.Memory;
-#endif
 
 namespace Microsoft.Toolkit.HighPerformance.Extensions
 {
diff --git a/Microsoft.Toolkit.HighPerformance/Extensions/SpanExtensions.cs b/Microsoft.Toolkit.HighPerformance/Extensions/SpanExtensions.cs
@@ -8,9 +8,6 @@
 using System.Runtime.InteropServices;
 using Microsoft.Toolkit.HighPerformance.Enumerables;
 using Microsoft.Toolkit.HighPerformance.Helpers.Internals;
-#if SPAN_RUNTIME_SUPPORT
-using Microsoft.Toolkit.HighPerformance.Memory;
-#endif
 
 namespace Microsoft.Toolkit.HighPerformance.Extensions
 {
diff --git a/Microsoft.Toolkit.HighPerformance/Helpers/BitHelper.cs b/Microsoft.Toolkit.HighPerformance/Helpers/BitHelper.cs
@@ -209,8 +209,9 @@ public static unsafe uint SetFlag(uint value, int n, bool flag)
             // and perform an OR with the resulting value of the previous
             // operation. This will always guaranteed to work, thanks to the
             // initial code clearing that bit before setting it again.
+            bool copy = flag;
             uint
-                flag32 = *(byte*)&flag,
+                flag32 = *(byte*)&copy,
                 shift = flag32 << n,
                 or = and | shift;
 
@@ -378,8 +379,9 @@ public static unsafe ulong SetFlag(ulong value, int n, bool flag)
             ulong
                 bit = 1ul << n,
                 not = ~bit,
-                and = value & not,
-                flag64 = *(byte*)&flag,
+                and = value & not;
+            bool copy = flag;
+            ulong flag64 = *(byte*)&copy,
                 shift = flag64 << n,
                 or = and | shift;
 
diff --git a/Microsoft.Toolkit.HighPerformance/Helpers/ParallelHelper.ForEach.IInAction2D.cs b/Microsoft.Toolkit.HighPerformance/Helpers/ParallelHelper.ForEach.IInAction2D.cs
@@ -5,7 +5,6 @@
 using System;
 using System.Runtime.CompilerServices;
 using System.Threading.Tasks;
-using Microsoft.Toolkit.HighPerformance.Memory;
 
 namespace Microsoft.Toolkit.HighPerformance.Helpers
 {
diff --git a/Microsoft.Toolkit.HighPerformance/Helpers/ParallelHelper.ForEach.IRefAction2D.cs b/Microsoft.Toolkit.HighPerformance/Helpers/ParallelHelper.ForEach.IRefAction2D.cs
@@ -5,7 +5,6 @@
 using System;
 using System.Runtime.CompilerServices;
 using System.Threading.Tasks;
-using Microsoft.Toolkit.HighPerformance.Memory;
 
 namespace Microsoft.Toolkit.HighPerformance.Helpers
 {
diff --git a/Microsoft.Toolkit.HighPerformance/Memory/Memory2D{T}.cs b/Microsoft.Toolkit.HighPerformance/Memory/Memory2D{T}.cs
@@ -19,7 +19,7 @@
 
 #pragma warning disable CA2231
 
-namespace Microsoft.Toolkit.HighPerformance.Memory
+namespace Microsoft.Toolkit.HighPerformance
 {
     /// <summary>
     /// <see cref="Memory2D{T}"/> represents a 2D region of arbitrary memory. It is to <see cref="Span2D{T}"/>
@@ -894,7 +894,7 @@ public override int GetHashCode()
         /// <inheritdoc/>
         public override string ToString()
         {
-            return $"Microsoft.Toolkit.HighPerformance.Memory.Memory2D<{typeof(T)}>[{this.height}, {this.width}]";
+            return $"Microsoft.Toolkit.HighPerformance.Memory2D<{typeof(T)}>[{this.height}, {this.width}]";
         }
 
         /// <summary>
diff --git a/Microsoft.Toolkit.HighPerformance/Memory/ReadOnlyMemory2D{T}.cs b/Microsoft.Toolkit.HighPerformance/Memory/ReadOnlyMemory2D{T}.cs
@@ -19,7 +19,7 @@
 
 #pragma warning disable CA2231
 
-namespace Microsoft.Toolkit.HighPerformance.Memory
+namespace Microsoft.Toolkit.HighPerformance
 {
     /// <summary>
     /// A readonly version of <see cref="Memory2D{T}"/>.
@@ -907,7 +907,7 @@ public override int GetHashCode()
         /// <inheritdoc/>
         public override string ToString()
         {
-            return $"Microsoft.Toolkit.HighPerformance.Memory.ReadOnlyMemory2D<{typeof(T)}>[{this.height}, {this.width}]";
+            return $"Microsoft.Toolkit.HighPerformance.ReadOnlyMemory2D<{typeof(T)}>[{this.height}, {this.width}]";
         }
 
         /// <summary>
diff --git a/Microsoft.Toolkit.HighPerformance/Memory/ReadOnlySpan2D{T}.Enumerator.cs b/Microsoft.Toolkit.HighPerformance/Memory/ReadOnlySpan2D{T}.Enumerator.cs
@@ -13,7 +13,7 @@
 using RuntimeHelpers = Microsoft.Toolkit.HighPerformance.Helpers.Internals.RuntimeHelpers;
 #endif
 
-namespace Microsoft.Toolkit.HighPerformance.Memory
+namespace Microsoft.Toolkit.HighPerformance
 {
     /// <inheritdoc cref="ReadOnlySpan2D{T}"/>
     public readonly ref partial struct ReadOnlySpan2D<T>
diff --git a/Microsoft.Toolkit.HighPerformance/Memory/ReadOnlySpan2D{T}.cs b/Microsoft.Toolkit.HighPerformance/Memory/ReadOnlySpan2D{T}.cs
@@ -17,7 +17,7 @@
 
 #pragma warning disable CS0809, CA1065
 
-namespace Microsoft.Toolkit.HighPerformance.Memory
+namespace Microsoft.Toolkit.HighPerformance
 {
     /// <summary>
     /// A readonly version of <see cref="Span2D{T}"/>.
@@ -974,7 +974,7 @@ public override int GetHashCode()
         /// <inheritdoc/>
         public override string ToString()
         {
-            return $"Microsoft.Toolkit.HighPerformance.Memory.ReadOnlySpan2D<{typeof(T)}>[{Height}, {this.width}]";
+            return $"Microsoft.Toolkit.HighPerformance.ReadOnlySpan2D<{typeof(T)}>[{Height}, {this.width}]";
         }
 
         /// <summary>
diff --git a/Microsoft.Toolkit.HighPerformance/Memory/Span2D{T}.Enumerator.cs b/Microsoft.Toolkit.HighPerformance/Memory/Span2D{T}.Enumerator.cs
@@ -13,7 +13,7 @@
 using RuntimeHelpers = Microsoft.Toolkit.HighPerformance.Helpers.Internals.RuntimeHelpers;
 #endif
 
-namespace Microsoft.Toolkit.HighPerformance.Memory
+namespace Microsoft.Toolkit.HighPerformance
 {
     /// <inheritdoc cref="Span2D{T}"/>
     public readonly ref partial struct Span2D<T>
diff --git a/Microsoft.Toolkit.HighPerformance/Memory/Span2D{T}.cs b/Microsoft.Toolkit.HighPerformance/Memory/Span2D{T}.cs
@@ -17,7 +17,7 @@
 
 #pragma warning disable CS0809, CA1065
 
-namespace Microsoft.Toolkit.HighPerformance.Memory
+namespace Microsoft.Toolkit.HighPerformance
 {
     /// <summary>
     /// <see cref="Span2D{T}"/> represents a 2D region of arbitrary memory. Like the <see cref="Span{T}"/> type,
@@ -1130,7 +1130,7 @@ public override int GetHashCode()
         /// <inheritdoc/>
         public override string ToString()
         {
-            return $"Microsoft.Toolkit.HighPerformance.Memory.Span2D<{typeof(T)}>[{Height}, {this.width}]";
+            return $"Microsoft.Toolkit.HighPerformance.Span2D<{typeof(T)}>[{Height}, {this.width}]";
         }
 
         /// <summary>
diff --git a/UnitTests/UnitTests.HighPerformance.Shared/Extensions/Test_ArrayExtensions.2D.cs b/UnitTests/UnitTests.HighPerformance.Shared/Extensions/Test_ArrayExtensions.2D.cs
@@ -4,9 +4,9 @@
 
 using System;
 using System.Runtime.CompilerServices;
+using Microsoft.Toolkit.HighPerformance;
 using Microsoft.Toolkit.HighPerformance.Enumerables;
 using Microsoft.Toolkit.HighPerformance.Extensions;
-using Microsoft.Toolkit.HighPerformance.Memory;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 
 namespace UnitTests.HighPerformance.Extensions
diff --git a/UnitTests/UnitTests.HighPerformance.Shared/Helpers/Test_ParallelHelper.ForEach.In2D.cs b/UnitTests/UnitTests.HighPerformance.Shared/Helpers/Test_ParallelHelper.ForEach.In2D.cs
@@ -4,11 +4,9 @@
 
 using System;
 using System.Diagnostics.Contracts;
-using System.Runtime.CompilerServices;
-using System.Threading;
+using Microsoft.Toolkit.HighPerformance;
 using Microsoft.Toolkit.HighPerformance.Extensions;
 using Microsoft.Toolkit.HighPerformance.Helpers;
-using Microsoft.Toolkit.HighPerformance.Memory;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 
 namespace UnitTests.HighPerformance.Helpers
diff --git a/UnitTests/UnitTests.HighPerformance.Shared/Helpers/Test_ParallelHelper.ForEach.Ref2D.cs b/UnitTests/UnitTests.HighPerformance.Shared/Helpers/Test_ParallelHelper.ForEach.Ref2D.cs
@@ -2,9 +2,9 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using Microsoft.Toolkit.HighPerformance;
 using Microsoft.Toolkit.HighPerformance.Extensions;
 using Microsoft.Toolkit.HighPerformance.Helpers;
-using Microsoft.Toolkit.HighPerformance.Memory;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 
 namespace UnitTests.HighPerformance.Helpers
diff --git a/UnitTests/UnitTests.HighPerformance.Shared/Memory/Test_Memory2D{T}.cs b/UnitTests/UnitTests.HighPerformance.Shared/Memory/Test_Memory2D{T}.cs
@@ -8,10 +8,10 @@
 using System.Runtime.CompilerServices;
 using Microsoft.Toolkit.HighPerformance.Extensions;
 #endif
-using Microsoft.Toolkit.HighPerformance.Memory;
+using Microsoft.Toolkit.HighPerformance;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 
-namespace UnitTests.HighPerformance.Memory
+namespace UnitTests.HighPerformance
 {
     [TestClass]
     [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1649", Justification = "Test class for generic type")]
@@ -536,7 +536,7 @@ public void Test_Memory2DT_ToString()
             // Here we just want to verify that the type is nicely printed as expected, along with the size
             string text = memory2d.ToString();
 
-            const string expected = "Microsoft.Toolkit.HighPerformance.Memory.Memory2D<System.Int32>[2, 3]";
+            const string expected = "Microsoft.Toolkit.HighPerformance.Memory2D<System.Int32>[2, 3]";
 
             Assert.AreEqual(text, expected);
         }
diff --git a/UnitTests/UnitTests.HighPerformance.Shared/Memory/Test_ReadOnlyMemory2D{T}.cs b/UnitTests/UnitTests.HighPerformance.Shared/Memory/Test_ReadOnlyMemory2D{T}.cs
@@ -8,10 +8,10 @@
 using System.Runtime.CompilerServices;
 using Microsoft.Toolkit.HighPerformance.Extensions;
 #endif
-using Microsoft.Toolkit.HighPerformance.Memory;
+using Microsoft.Toolkit.HighPerformance;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 
-namespace UnitTests.HighPerformance.Memory
+namespace UnitTests.HighPerformance
 {
     /* ====================================================================
     *                                 NOTE
@@ -484,7 +484,7 @@ public void Test_ReadOnlyMemory2DT_ToString()
 
             string text = memory2d.ToString();
 
-            const string expected = "Microsoft.Toolkit.HighPerformance.Memory.ReadOnlyMemory2D<System.Int32>[2, 3]";
+            const string expected = "Microsoft.Toolkit.HighPerformance.ReadOnlyMemory2D<System.Int32>[2, 3]";
 
             Assert.AreEqual(text, expected);
         }
diff --git a/UnitTests/UnitTests.HighPerformance.Shared/Memory/Test_ReadOnlySpan2D{T}.cs b/UnitTests/UnitTests.HighPerformance.Shared/Memory/Test_ReadOnlySpan2D{T}.cs
@@ -5,12 +5,12 @@
 using System;
 using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
+using Microsoft.Toolkit.HighPerformance;
 using Microsoft.Toolkit.HighPerformance.Enumerables;
 using Microsoft.Toolkit.HighPerformance.Extensions;
-using Microsoft.Toolkit.HighPerformance.Memory;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 
-namespace UnitTests.HighPerformance.Memory
+namespace UnitTests.HighPerformance
 {
     /* ====================================================================
     *                                 NOTE
@@ -636,7 +636,7 @@ public void Test_ReadOnlySpan2DT_ToString()
 
             string text = span2d.ToString();
 
-            const string expected = "Microsoft.Toolkit.HighPerformance.Memory.ReadOnlySpan2D<System.Int32>[2, 3]";
+            const string expected = "Microsoft.Toolkit.HighPerformance.ReadOnlySpan2D<System.Int32>[2, 3]";
 
             Assert.AreEqual(text, expected);
         }
diff --git a/UnitTests/UnitTests.HighPerformance.Shared/Memory/Test_Span2D{T}.cs b/UnitTests/UnitTests.HighPerformance.Shared/Memory/Test_Span2D{T}.cs
@@ -6,11 +6,11 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Linq;
 using System.Runtime.CompilerServices;
+using Microsoft.Toolkit.HighPerformance;
 using Microsoft.Toolkit.HighPerformance.Enumerables;
-using Microsoft.Toolkit.HighPerformance.Memory;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 
-namespace UnitTests.HighPerformance.Memory
+namespace UnitTests.HighPerformance
 {
     [TestClass]
     [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1649", Justification = "Test class for generic type")]
@@ -823,7 +823,7 @@ public void Test_Span2DT_ToString()
             // Verify that we get the nicely formatted string
             string text = span2d.ToString();
 
-            const string expected = "Microsoft.Toolkit.HighPerformance.Memory.Span2D<System.Int32>[2, 3]";
+            const string expected = "Microsoft.Toolkit.HighPerformance.Span2D<System.Int32>[2, 3]";
 
             Assert.AreEqual(text, expected);
         }

Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,6 @@`
`8`	`8`	`using System.Runtime.InteropServices;`
`9`	`9`	`using Microsoft.Toolkit.HighPerformance.Enumerables;`
`10`	`10`	`using Microsoft.Toolkit.HighPerformance.Helpers.Internals;`
`11`		`-#if SPAN_RUNTIME_SUPPORT`
`12`		`-using Microsoft.Toolkit.HighPerformance.Memory;`
`13`		`-#endif`
`14`	`11`
`15`	`12`	`namespace Microsoft.Toolkit.HighPerformance.Extensions`
`16`	`13`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,6 @@`
`5`	`5`	`using System;`
`6`	`6`	`using System.Runtime.CompilerServices;`
`7`	`7`	`using System.Threading.Tasks;`
`8`		`-using Microsoft.Toolkit.HighPerformance.Memory;`
`9`	`8`
`10`	`9`	`namespace Microsoft.Toolkit.HighPerformance.Helpers`
`11`	`10`	`{`