Add BinaryFormatter to corefx #10088

stephentoub · 2016-07-15T15:05:03Z

This ports BinaryFormatter from desktop, along with all of the supporting types and general Formatter-related types. I've added a bunch of tests, bringing code coverage up to ~80%, though there's still more that can/should be done. I did not port remoting-specific functionality, though there are still some remnants I've left as they were enabled in the runtime even when remoting wasn't compiled in, as it wasn't clear if they were serving additional purposes. I did a bunch of cleanup, but there's still more that can be done in the fullness of time.

I already made several changes to CoreCLR to enable this:

Stop BclRewriter from trimming serializable metadata coreclr#6253 fixed the BclRewriter to stop removing the serialization metadata from types in coreclr. Without that, attempting to serialize even primitive types was failing.
Add #if FEATURE_SERIALIZATION around customized [Serializable]s coreclr#6263 then removed [Serializable] from types that performed custom serialization (e.g. ISerializable), because currently the ISerializable in CoreFx is a different runtime type from the one in coreclr, which meant that formatters trying to serialize such types would use default serialization rather than picking up the custom implementation. Once we move ISerializable and friends into System.Runtime as type forwards rather than redefinitions of the interfaces, we can re-enable the serialization of those types.

(This PR is currently going against master. If that turns out to be the wrong branch for it, I'll resubmit against the correct branch prior to merging.)

cc: @danmosemsft, @jkotas, @KrzysztofCwalina, @ianhays, @bartonjs
Fixes https://github.com/dotnet/corefx/issues/7938
Fixes https://github.com/dotnet/corefx/issues/9582

bartonjs · 2016-07-15T15:56:15Z

src/System.Runtime.Serialization.Formatters/ref/System.Runtime.Serialization.Formatters.cs

@@ -137,3 +143,199 @@ public sealed class SerializationInfoEnumerator : IEnumerator
        public void Reset() { throw null; }
    }
 }
+namespace System.Runtime.Serialization
+{
+    [System.CLSCompliantAttribute(false)]


Are we not scrubbing these out?

CLSCompliant? No. If something isn't compliant and isn't attributed to say so, it'll produce a build error.

danmoseley · 2016-07-15T16:24:21Z

how much should we be reviewing the binaryformatter itself - how much is essentially the desktoip code verbatim?

danmoseley · 2016-07-15T16:25:47Z

src/System.Runtime.Serialization.Formatters/src/System/Runtime/Serialization/ObjectManager.cs

+
+            //If the id that we need to place is greater than our current length, and less
+            //than the maximum allowable size of the array.  We need to double the size
+            //of the array.  If the array has already reached it's maximum allowable size,


If the array has already reached it's maximum allowable size, [](start = 28, length = 62)

is there a test for this?

is there a test for this?

You mean if we try to serialize two billion objects? No.

stephentoub · 2016-07-15T16:27:31Z

how much should we be reviewing the binaryformatter itself - how much is essentially the desktoip code verbatim?

From a logic perspective, it's the desktop code. I had to supply replacements where there were dependencies that aren't exposed, remove code that wasn't relevant, plus a lot of style stuff, but for the most part it's the same code and doesn't need to be reviewed in depth... honestly there are parts I'm not entirely sure what they're doing ;)

danmoseley · 2016-07-15T16:31:52Z

...alization.Formatters/src/System/Runtime/Serialization/Formatters/Binary/BinaryUtilClasses.cs

+    [Serializable]
+    internal sealed class IntSizedArray : ICloneable
+    {
+        internal int[] objects = new int[16];


objects [](start = 23, length = 7)

leading underscores?

Yup, somehow missed these two.

danmoseley · 2016-07-15T17:03:40Z

Thank you for doing this, great stuff.

danmoseley · 2016-07-15T17:03:43Z

bartonjs · 2016-07-15T17:13:54Z

...alization.Formatters/src/System/Runtime/Serialization/Formatters/Binary/BinaryUtilClasses.cs

+        internal FormatterTypeStyle _FEtypeFormat;
+        internal FormatterAssemblyStyle _FEassemblyFormat;
+        internal TypeFilterLevel _FEsecurityLevel;
+        internal InternalSerializerTypeE _FEserializerTypeEnum;


The casing on the names here (and in NameInfo) seems off. In Desktop they had no underscore, presenting as property names. Now they are underscore-pascal; which I don't think is any part of our style rules. Bad CodeFormatter edit?

This ports BinaryFormatter from desktop, along with all of the supporting types and general Formatter-related types. I've added a bunch of tests, bringing code coverage up to ~80%, though there's still more that can/should be done. I did not port remoting-specific functionality, though there are still some remnants I've left as they were enabled in the runtime even when remoting wasn't compiled in, and it wasn't clear if they were serving additional purposes.

stephentoub · 2016-07-17T14:02:14Z

Thanks for all the feedback. I believe I've addressed everything.

jkotas · 2016-07-17T16:48:42Z

👍

bartonjs · 2016-07-18T17:46:53Z

...lization.Formatters/src/System/Runtime/Serialization/Formatters/Binary/BinaryObjectReader.cs

+                {
+                    try
+                    {
+                        Assembly.Load(new AssemblyName(assemblyName));


Are you missing an assignment to assm here?

stephentoub · 2016-07-19T07:36:25Z

Replaced by #10144

stephentoub added the 3 - Ready For Review label Jul 15, 2016

dnfclas added the cla-already-signed label Jul 15, 2016

stephentoub force-pushed the binary_formatter branch from d06d207 to 5e0cfd8 Compare July 15, 2016 15:09

bartonjs reviewed Jul 15, 2016
View reviewed changes

danmoseley reviewed Jul 15, 2016
View reviewed changes

bartonjs reviewed Jul 15, 2016
View reviewed changes

stephentoub added 2 commits July 17, 2016 07:10

Address PR feedback

7896300

stephentoub force-pushed the binary_formatter branch from 5e0cfd8 to 7896300 Compare July 17, 2016 13:59

bartonjs reviewed Jul 18, 2016
View reviewed changes

stephentoub mentioned this pull request Jul 19, 2016

Add BinaryFormatter to corefx #10144

Merged

stephentoub closed this Jul 19, 2016

stephentoub removed the 3 - Ready For Review label Jul 19, 2016

jarroda mentioned this pull request Jul 21, 2016

Port to .NET Core jarroda/MassTransit#1

Open

4 tasks

stephentoub deleted the binary_formatter branch July 21, 2016 15:08

jarroda mentioned this pull request Jul 21, 2016

.NET Core 2.0 Release Master Issue MassTransit/MassTransit#527

Closed

karelz modified the milestone: 1.1.0 Dec 3, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add BinaryFormatter to corefx #10088

Add BinaryFormatter to corefx #10088

stephentoub commented Jul 15, 2016 •

edited

Loading

bartonjs Jul 15, 2016

stephentoub Jul 15, 2016

danmoseley commented Jul 15, 2016

danmoseley Jul 15, 2016

stephentoub Jul 15, 2016

stephentoub commented Jul 15, 2016

danmoseley Jul 15, 2016

stephentoub Jul 15, 2016

stephentoub Jul 17, 2016

danmoseley commented Jul 15, 2016

danmoseley commented Jul 15, 2016

bartonjs Jul 15, 2016

stephentoub Jul 15, 2016

stephentoub Jul 17, 2016

stephentoub commented Jul 17, 2016

jkotas commented Jul 17, 2016

bartonjs Jul 18, 2016

stephentoub Jul 18, 2016

stephentoub commented Jul 19, 2016

Add BinaryFormatter to corefx #10088

Add BinaryFormatter to corefx #10088

Conversation

stephentoub commented Jul 15, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danmoseley commented Jul 15, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stephentoub commented Jul 15, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

danmoseley commented Jul 15, 2016

danmoseley commented Jul 15, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stephentoub commented Jul 17, 2016

jkotas commented Jul 17, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stephentoub commented Jul 19, 2016

stephentoub commented Jul 15, 2016 •

edited

Loading