Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move the working BinaryFormatter implementation to a NuGet package #103255

Merged
merged 12 commits into from
Jun 17, 2024
Merged

Move the working BinaryFormatter implementation to a NuGet package #103255

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
c508a3c
Move the working BinaryFormatter implementation to a NuGet package
bartonjs May 7, 2024
f3b7ba8
Respond to feedback
bartonjs Jun 12, 2024
3dd94ff
Apply suggestions from code review
bartonjs Jun 12, 2024
ad7974f
Make the ILLink substitution conditional
bartonjs Jun 12, 2024
d69488f
Teach PlatformDetection.IsBinaryFormatterSupported about asmver 8.1
bartonjs Jun 13, 2024
eaaa177
Disable System.Resources.Extensions.BinaryFormat.Tests
bartonjs Jun 13, 2024
72c9197
Move StartDeserialization wrapper to SerializationGuard.cs
bartonjs Jun 13, 2024
9c68be5
Fix more tests that used BinaryFormatter without checking support
bartonjs Jun 14, 2024
a5c760d
Fix nuspec generation
bartonjs Jun 14, 2024
be4a980
Update src/libraries/Common/tests/TestUtilities/System/PlatformDetect…
bartonjs Jun 17, 2024
abdae6f
Remove call to SerializationGuard
bartonjs Jun 17, 2024
5bb3345
Merge branch 'bf_package' of github.com:/bartonjs/runtime into bf_pac…
bartonjs Jun 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/libraries/System.Runtime.Serialization.Formatters/Directory.Build.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<Project>
<Import Project="..\Directory.Build.targets" />
<PropertyGroup>

<!--
The real implementation of this library is built for NetCoreAppMinimum,
the NetCoreAppCurrent build has a non-functional copy of BinaryFormatter.
The NetCoreAppCurrent build is only included in the shared runtime,
and should always lose to the package for unification; so it is pinned
at an assembly version that will always lose.
-->
<AssemblyVersion Condition="'$(TargetFramework)' == '$(NetCoreAppCurrent)'">8.1.0.0</AssemblyVersion>
</PropertyGroup>
</Project>
13 changes: 0 additions & 13 deletions ...ystem.Runtime.Serialization.Formatters/ref/System.Runtime.Serialization.Formatters.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,6 @@
<PropertyGroup>
<TargetFrameworks>$(NetCoreAppMinimum);$(NetCoreAppCurrent)</TargetFrameworks>
</PropertyGroup>
<PropertyGroup>
<!--
The real implementation of this library is built for NetCoreAppMinimum,
the NetCoreAppCurrent build has a non-functional copy of BinaryFormatter.

The NetCoreAppCurrent build is only included in the shared runtime,
and should always lose to the package for unification; so it is pinned
at an assembly version that will always lose.
-->
<AssemblyVersion Condition="'$(TargetFramework)' == '$(NetCoreAppCurrent)'">8.1.0.0</AssemblyVersion>
<IncludeBuildOutput Condition="'$(TargetFramework)' == '$(NetCoreAppCurrent)'">false</IncludeBuildOutput>
<SuppressDependenciesWhenPacking Condition="'$(TargetFramework)' == '$(NetCoreAppCurrent)'">true</SuppressDependenciesWhenPacking>
</PropertyGroup>
<ItemGroup>
<Compile Include="System.Runtime.Serialization.Formatters.cs" />
<Compile Include="System.Runtime.Serialization.Formatters.Forwards.cs" />
Expand Down
0 ...ILLink/ILLink.Substitutions.NonMobile.xml → ...tters/src/ILLink/ILLink.Substitutions.xml
View file
Open in desktop
File renamed without changes.
17 changes: 17 additions & 0 deletions src/libraries/System.Runtime.Serialization.Formatters/src/PACKAGE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## About

Provides the legacy BinaryFormatter class for workloads which still require it.

## Main Types

The main types provided by this library are:

* `System.Runtime.Serialization.Formatters.Binary.BinaryFormatter`

## Additional Documentation

* [Obsoletion Notice](https://aka.ms/binaryformatter)

## Feedback & Contributing

System.Runtime.Serialization.Formatters is released as open source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports are welcome at [the GitHub repository](https://github.com/dotnet/runtime). This package is considered legacy, and we only consider low-risk, high-impact fixes that are necessary to maintain functionality.
25 changes: 6 additions & 19 deletions ...ystem.Runtime.Serialization.Formatters/src/System.Runtime.Serialization.Formatters.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,24 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFrameworks>$(NetCoreAppCurrent);$(NetCoreAppMinimum);$(NetCoreAppMinimum)-browser;$(NetCoreAppMinimum)-ios;$(NetCoreAppMinimum)-tvos;$(NetCoreAppMinimum)-android</TargetFrameworks>
<TargetFrameworks>$(NetCoreAppCurrent);$(NetCoreAppMinimum)</TargetFrameworks>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need to build this for .NET 8?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the best/only way I could find for having two builds for the DLL, one where BF works (net8/NuGet) and one where it doesn't (net9/shared runtime).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where are the problems with building the non-working inbox version via independent project?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm. The original plan was to typeforward BinaryFormatter out into a new library and do the package trick there (which would still have required making two copies), but it turns out that System.Runtime.Serialization.Formatters.dll is itself basically the minimum closure of BinaryFormatter.

It sounds like your suggestion is to sort of do that again, making something like

src/libraries/System.Runtime.Serialization.Formatters/src/  :  IsPackable, net9
src/libraries/System.Runtime.Serialization.Formatters.Inbox/src/ : !IsPackable, net9, also claim to be System.Runtime.Serialization.Formatters.dll, <Compile Include=../../System.Runtime.Serialization.Formatters/src/AllTheThingsThatArentBinaryFormatter />

I don't know how well our build system would like that. And since the preview snap date is Tuesday, I don't know that I have the time to find out before then. We could explore it after.

Copy link
Member

@jkotas jkotas Jun 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, something like that. The current scheme where the build for NetCoreAppMinimum is meant for NetCoreAppCurrent is not easy to understand. It is fine to explore something better later. It is possible that what you have put together is the best out of all bad solutions.

Copy link
Member

@ViktorHofer ViktorHofer Jun 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NuGet limits us here. It doesn't support specifying multiple TFMs that map to the same TargetFrameworkMoniker+TargetPlatformMoniker tuple in a project. There's a proposal up to fix that eventually but until then, separate projects need to be used in such scenarios.

We have multiple source generator project files per rdifferent roslyn targeting pack version because of the exact same reason.

I would agree with Jan that the current solution might be good enough for what's proposed.

<UseCompilerGeneratedDocXmlFile>false</UseCompilerGeneratedDocXmlFile>
<IsPackable>true</IsPackable>
<!-- TODO: Enable validation after the .NET 9 package release -->
<EnablePackageValidation>false</EnablePackageValidation>
bartonjs marked this conversation as resolved.
Show resolved Hide resolved
</PropertyGroup>

<!-- DesignTimeBuild requires all the TargetFramework Derived Properties to not be present in the first property group. -->
<PropertyGroup>
<TargetPlatformIdentifier Condition="$(TargetFramework.Contains('-'))">$(TargetFramework.SubString($([MSBuild]::Add($(TargetFramework.IndexOf('-')), 1))))</TargetPlatformIdentifier>
<NoWarn>$(NoWarn);CA1822;IDE0060</NoWarn>

<!--
The real implementation of this library is built for NetCoreAppMinimum,
the NetCoreAppCurrent build has a non-functional copy of BinaryFormatter.

The NetCoreAppCurrent build is only included in the shared runtime,
and should always lose to the package for unification; so it is pinned
at an assembly version that will always lose.
-->
<AssemblyVersion Condition="'$(TargetFramework)' == '$(NetCoreAppCurrent)'">8.1.0.0</AssemblyVersion>
<IncludeBuildOutput Condition="'$(TargetFramework)' == '$(NetCoreAppCurrent)'">false</IncludeBuildOutput>
<SuppressDependenciesWhenPacking Condition="'$(TargetFramework)' == '$(NetCoreAppCurrent)'">true</SuppressDependenciesWhenPacking>
<FunctioningBinaryFormatter Condition="'$(TargetFramework)' == '$(NetCoreAppMinimum)'">true</FunctioningBinaryFormatter>
bartonjs marked this conversation as resolved.
Show resolved Hide resolved
<IncludeBuildOutput Condition="'$(FunctioningBinaryFormatter)' != 'true'">false</IncludeBuildOutput>
<SuppressDependenciesWhenPacking Condition="'$(FunctioningBinaryFormatter)' != 'true'">true</SuppressDependenciesWhenPacking>
</PropertyGroup>

<ItemGroup>
<ILLinkSubstitutionsXmls Condition="'$(TargetPlatformIdentifier)' == ''" Include="$(ILLinkDirectory)ILLink.Substitutions.NonMobile.xml" />
<ILLinkSubstitutionsXmls Include="$(ILLinkDirectory)ILLink.Substitutions.xml" />
</ItemGroup>

<ItemGroup>
Expand Down Expand Up @@ -94,14 +85,10 @@
</Compile>
</ItemGroup>

<ItemGroup Condition="'$(TargetFramework)' == '$(NetCoreAppCurrent)'">
<ItemGroup Condition="'$(FunctioningBinaryFormatter)' != 'true'">
<Compile Include="System\Runtime\Serialization\Formatters\Binary\BinaryFormatter.Removed.cs" />
</ItemGroup>

<ItemGroup Condition="'$(TargetPlatformIdentifier)' != ''">
<Compile Include="System\Runtime\Serialization\Formatters\Binary\BinaryFormatter.PlatformNotSupported.cs" />
</ItemGroup>

<ItemGroup Condition="'$(TargetFramework)' == '$(NetCoreAppCurrent)'">
<ProjectReference Include="$(CoreLibProject)" />
<ProjectReference Include="$(LibrariesProjectRoot)System.Runtime\src\System.Runtime.csproj" />
Expand Down
12 changes: 12 additions & 0 deletions ...ion.Formatters/src/System/Runtime/Serialization/Formatters/Binary/BinaryFormatter.Core.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,24 @@ public sealed partial class BinaryFormatter : IFormatter
{
private static readonly ConcurrentDictionary<Type, TypeInformation> s_typeNameCache = new ConcurrentDictionary<Type, TypeInformation>();
bartonjs marked this conversation as resolved.
Show resolved Hide resolved

private static readonly bool s_disallowedByPlatform =
OperatingSystem.IsAndroid() ||
OperatingSystem.IsBrowser() ||
OperatingSystem.IsIOS() ||
OperatingSystem.IsMacCatalyst() ||
OperatingSystem.IsTvOS();

bartonjs marked this conversation as resolved.
Show resolved Hide resolved
internal object[]? _crossAppDomainArray;

[RequiresDynamicCode(IFormatter.RequiresDynamicCodeMessage)]
[RequiresUnreferencedCode(IFormatter.RequiresUnreferencedCodeMessage)]
public object Deserialize(Stream serializationStream)
{
if (s_disallowedByPlatform)
{
throw new PlatformNotSupportedException(SR.BinaryFormatter_SerializationNotSupportedOnThisPlatform);
}

bartonjs marked this conversation as resolved.
Show resolved Hide resolved
// don't refactor the 'throw' into a helper method; trimming tools will have difficulty trimming
if (!LocalAppContextSwitches.BinaryFormatterEnabled)
{
Expand Down
20 changes: 0 additions & 20 deletions ...rc/System/Runtime/Serialization/Formatters/Binary/BinaryFormatter.PlatformNotSupported.cs
View file
Open in desktop

This file was deleted.

3 changes: 0 additions & 3 deletions ...ation.Formatters/src/System/Runtime/Serialization/Formatters/Binary/BinaryObjectReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,16 +75,13 @@ internal ObjectReader(Stream stream, ISurrogateSelector? selector, StreamingCont
_formatterEnums = formatterEnums;
}

[RequiresDynamicCode(ObjectReaderUnreferencedCodeMessage)]
[RequiresUnreferencedCode("Types might be removed")]
private static IDisposable? StartDeserialization()
{
MethodInfo? targetMethod = typeof(SerializationInfo).GetMethod(
"StartDeserialization",
BindingFlags.Public | BindingFlags.Static,
Type.EmptyTypes);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth caching (or caching a delegate created to it)?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be even better to use UnsafeAccessor - no reflection, no delegates, no caching. UnsafeAccessor
shipped in 8.0 that is the current NetCoreAppMinimum.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

StartDeserialization returns a public type that isn't in the reference assembly; it looks like UnsafeAccessor requires an exact signature match. So, unless there's an unsafe typeref I don't think we can use it here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CreateDelegate is similarly not an option, it refuses to loose-bind the return type (struct).

Slow invoke works, or we can add another method in corelib that does the boxing to IDisposable there so it can be bound with UnsafeAccessor. I'm guessing we don't like that option, so I'm guessing we're sticking with slow-invoke. But either way I've moved this to a different type, and am at least saving the MethodInfo.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we rather get rid of this (it would be my preference), or turn it into a public API?

The non-public dependencies of OOB nuget packages like this one are always factory for problems.


// It might have been removed in AoT.
if (targetMethod is null)
{
throw new InvalidOperationException();
Expand Down
Loading