Finish (mostly) erradicating StringBuilder marshaling from corefx #33780
Conversation
This should finish my quest of removing StringBuilder marshaling from coreclr and corefx, which I've strived to do because it often adds unnecessary overhead and often is done incorrectly because of intricacies in how the marshaling works; while not using it often leads to `unsafe` code at call sites, there's much less magic, and it affords the ability to optimize more if desired. There are still three remaining [Out] StringBuilder's in Interop.Odbc.cs, which I've not removed because tests are limited and the call graph to these is non-trivial with StringBuilders passed through. There may also be a few straggling DllImports I missed while scouring interop that's not following our guidelines of being in src\Common\. Other than those, the remaining StringBuilder usage I found in DllImports was for [In] only, and in those cases it's reasonable, as the call sites are building up StringBuilders and then passing them off to the call sites; converting those to use `char*` or similar could actually make them more expensive. I did, however, ensure they were properly annotated as [In], in order to make the intent clear and avoid potential marshaling costs for the unnecessary [Out] direction. Where I was touching a function in one of these stray interop files that was duplicated elsewhere, I also consolidated it to a centralized location, but I've not in this PR done the cleanup work for the rest of the files.
src/System.Diagnostics.EventLog/src/System/Diagnostics/EventLogEntry.cs
Outdated
Show resolved
Hide resolved
src/System.Security.Cryptography.Encoding/src/Internal/Cryptography/CngAsnFormatter.cs
Outdated
Show resolved
Hide resolved
src/System.Security.Cryptography.Encoding/src/Internal/Cryptography/CngAsnFormatter.cs
Show resolved
Hide resolved
src/System.DirectoryServices/src/System/DirectoryServices/SearchResultCollection.cs
Show resolved
Hide resolved
...irectoryServices.AccountManagement/src/System/DirectoryServices/AccountManagement/NetCred.cs
Outdated
Show resolved
Hide resolved
src/System.Runtime.WindowsRuntime/src/System/Resources/WindowsRuntimeResourceManager.cs
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
src/Common/src/Interop/Unix/System.Native/Interop.GetUnixVersion.cs
Outdated
Show resolved
Hide resolved
GetUnixVersion asserted on macOS:
|
Probably not a coincidence. I'll take a look tomorrow. Thanks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
@bartonjs, the issue was the assert itself. I had code something like: byte[] arr = new byte[1] { 0 };
Debug.Assert(Array.IndexOf(arr, 0) != -1); which you'd expect to always succeed, except it always fails, because overload resolution ends up mapping to the non-generic Array.IndexOf, with the 0 getting boxed as an Int32, and thus comparing each element of the byte[] doesn't match. The fix is either to do |
Yep, consts and overload resolution make for things that look funny sometimes. I'm also self-satisfied that I diagnosed that as the problem based on the diff 😄 |
@dotnet-bot test this please |
…tnet#33780) * Finish (mostly) erradicating StringBuilder marshaling from corefx This should finish my quest of removing StringBuilder marshaling from coreclr and corefx, which I've strived to do because it often adds unnecessary overhead and often is done incorrectly because of intricacies in how the marshaling works; while not using it often leads to `unsafe` code at call sites, there's much less magic, and it affords the ability to optimize more if desired. There are still three remaining [Out] StringBuilder's in Interop.Odbc.cs, which I've not removed because tests are limited and the call graph to these is non-trivial with StringBuilders passed through. There may also be a few straggling DllImports I missed while scouring interop that's not following our guidelines of being in src\Common\. Other than those, the remaining StringBuilder usage I found in DllImports was for [In] only, and in those cases it's reasonable, as the call sites are building up StringBuilders and then passing them off to the call sites; converting those to use `char*` or similar could actually make them more expensive. I did, however, ensure they were properly annotated as [In], in order to make the intent clear and avoid potential marshaling costs for the unnecessary [Out] direction. Where I was touching a function in one of these stray interop files that was duplicated elsewhere, I also consolidated it to a centralized location, but I've not in this PR done the cleanup work for the rest of the files. * Address PR feedback * Address further feedback
…tnet/corefx#33780) * Finish (mostly) erradicating StringBuilder marshaling from corefx This should finish my quest of removing StringBuilder marshaling from coreclr and corefx, which I've strived to do because it often adds unnecessary overhead and often is done incorrectly because of intricacies in how the marshaling works; while not using it often leads to `unsafe` code at call sites, there's much less magic, and it affords the ability to optimize more if desired. There are still three remaining [Out] StringBuilder's in Interop.Odbc.cs, which I've not removed because tests are limited and the call graph to these is non-trivial with StringBuilders passed through. There may also be a few straggling DllImports I missed while scouring interop that's not following our guidelines of being in src\Common\. Other than those, the remaining StringBuilder usage I found in DllImports was for [In] only, and in those cases it's reasonable, as the call sites are building up StringBuilders and then passing them off to the call sites; converting those to use `char*` or similar could actually make them more expensive. I did, however, ensure they were properly annotated as [In], in order to make the intent clear and avoid potential marshaling costs for the unnecessary [Out] direction. Where I was touching a function in one of these stray interop files that was duplicated elsewhere, I also consolidated it to a centralized location, but I've not in this PR done the cleanup work for the rest of the files. * Address PR feedback * Address further feedback Commit migrated from dotnet/corefx@c77984d
This should finish my quest of removing StringBuilder marshaling from coreclr and corefx, which I've strived to do because it often adds unnecessary overhead and often is done incorrectly because of intricacies in how the marshaling works; while not using it often leads to
unsafe
code at call sites, there's much less magic, and it affords the ability to optimize more if desired.There are still three remaining [Out] StringBuilder's in Interop.Odbc.cs, which I've not removed because tests are limited and the call graph to these is non-trivial with StringBuilders passed through. There may also be a few straggling DllImports I missed while scouring interop that's not following our guidelines of being in src\Common.
Other than those, the remaining StringBuilder usage I found in DllImports was for [In] only, and in those cases it's reasonable, as the code is building up StringBuilders and then passing them off to the call sites; converting those to use
char*
or similar could actually make them more expensive. I did, however, ensure they were properly annotated as [In], in order to make the intent clear and avoid potential marshaling costs for the unnecessary [Out] direction.Where I was touching a function in one of these stray interop files that was duplicated elsewhere, I also consolidated it to a centralized location, but I've not in this PR done the cleanup work for the rest of the files.
cc: @jkotas, @bartonjs, @JeremyKuhne, @tarekgh