Skip to content

Commit a19d9fa

Browse files
lambdageeklambdageek
authored
[mono] Hot Reload: support for reloadable types (#66749)
Fully implement support for the `NewTypeDefinition` EnC capability: a hot reload edit can add a new type definition (class, struct, interface, enum) that contains new fields, methods, properties, events, and nested classes, and can have generic params. Also add reflection support for all of the above. This is sufficient to support hot reload of types tagged with [`CreateNewOnMetadataUpdateAttribute`](https://docs.microsoft.com/en-us/dotnet/api/system.runtime.compilerservices.createnewonmetadataupdateattribute?view=net-6.0). Contributes to #63643 and #57365 --- The implementation introduces `MonoAddedDefSkeleton` which is a bookkeeping structure that records the metadata indexes of where to find methods, fields, properties and events for a newly-added class. The issue is that normally `mono_class_create_from_typedef` expects to find all that stuff in a contiguous block starting at the row pointed by the `MONO_TYPEDEF_FIELD_LIST` or `MONO_TYPEDEF_METHOD_LIST` columns of the new typedef. But in EnC deltas, those columns are zeroed out, and instead the EnCLog functions like `ENC_FUNC_ADD_METHOD` and `ENC_FUNC_ADD_FIELD` explicitly record when a new row is added that is relevant to a particular type definition. So during the pass over the EnCLog, we start creating skeletons when we see a new row added to the typedef table. Then when we see the add functions, we record the row indices of the field, method, etc tables. As far as I can tell, the rows for a particular type definition are contiguous, so we just record the first index and the count. At the end of the pass, we save the skeletons on the metadata delta, and when code finally creates the `MonoClass` for a particular freshly-added type definition, we check the skeleton and use the recorded rows to populate the fields and methods. Event and property data is created on-demand (the demand being reflection) in basically the same way. One important note: we try very hard not to accidentally materialize a newly-added class as a `MonoClass` during the update itself - we need to at least get through the entire EnCLog - otherwise we might not see every field/method/etc and set up the class incorrectly. The upshot is that the newly-added `MonoClass` behaves like any other "normal" class - all its fields are laid out normally (they're stored in the object, not in a separate hash table). It can be generic. It can have base types, interfaces, etc. This is different from how added fields, props and events will be implemented on existing classes - we won't modify `MonoClass:fields` or the `MonoClassPropertyInfo:properties` arrays - once they have been allocated, we don't want to mess with them. Instead additions to existing classes with create `MonoClassMetadataUpdateField` (`MonoClassMetadataUpdateProperty` and `MonoClassMetadataUpdateEvent`) structs that are going to be stored on the `MonoClassMetadataUpdateInfo` that's associated with each `MonoClass`. The various iterators like `mono_class_get_fields` and `mono_class_get_props` will be modified to return the added fields/props/etc after the existing ones. This is already implemented for fields. Props and Events will be part of a separate effort to implement reflection support for them. --- * Checkpoint. Infrastructure for added types * register member->parent lookups for newly-added classes and members * fix off by one error creating class from skeleton * AddNestedClass test works with mono now; also make it generic * checkpoint: adding properties it "works" but only because we don't look very hard for the new properties anywhere. reflection is probably pretty broken. * Add a property to AddNestedClass test * remove allow class/field/method/property ifdefs keep the instance field ifdef for now * add event to AddNestedClass * add DISALLOW_BROKEN_PARENT ifdef allow CustomAttribute row modifications to change Parent, while dotnet/roslyn#60125 is being sorted out * checkpoint: adding events * Add new test ReflectionAddNewType * Add new types to the image name cache * Assembly.GetTypes and additional tests * Make nested types work * GetInterfaces on new types; also Activator.CreateInstance * Mark mono_class_get_nested_classes_property as a component API also mono_class_set_nested_classes_property * Add GetMethods, GetFields, GetMethod, GetField test * [class] Implement added method iteration Change the iterator from storing MonoMethod** values to storing an iteration count. For added methods, when the iteration count is more than mono_class_get_method_count, run through the hot reload added_members list and iterate over any relevant methods * Implement added field iteration * Add a GetField(BindingFlags.Static) test case * Add Enum.GetNames and GetProperties tests - not working yet * Mark mono_class_get_method_count as a component API also mono_class_get_field_count * Enum values work * Use GSList for added_fields (and props, events); add from_update bit Use GSList to simplify the concurrency story for accessing added_fields (and added_props and added_events, eventually): unlike a GPtrArray it won't resize, so we don't need to lock readers. Add a from_update bit to MonoProperty and MonoEvent - when props or events are added to existing classes, they will have the bit set. That means that pointer arithmetic to figure out the prop (or event) tokens won't be usable (since they're not allocated in one big block). * Reflection on props in new classes works * events on new classes work * Add CustomAttribute reflection test * remove test for props on existing type - it's not part of this PR * instance field additions to existing types aren't supported yet * rm TODO and FIXME * store prop and event from_update bit in attrs The upper 16 bits aren't used for ECMA flags, so grab a bit for metadata-update * remove instance fields from reflection test since Mono doesn't support them yet * make the Browser EAT lanes happy Add some fields to the baseline versions of some test assemblies to keep some types that are used in the deltas from getting trimmed away
1 parent 3b2808b commit a19d9fa

22 files changed

+1363
-253
lines changed

‎src/libraries/System.Runtime.Loader/tests/ApplyUpdate/System.Reflection.Metadata.ApplyUpdate.Test.AddNestedClass/AddNestedClass.cs

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ namespace System.Reflection.Metadata.ApplyUpdate.Test
77
{
88
public class AddNestedClass
99
{
10+
public static Action<string> X; // make the linker happy
11+
public static Delegate Y;
12+
public event Action<string> Evt;
13+
public void R () { Evt ("123"); }
1014
public AddNestedClass()
1115
{
1216
}

‎src/libraries/System.Runtime.Loader/tests/ApplyUpdate/System.Reflection.Metadata.ApplyUpdate.Test.AddNestedClass/AddNestedClass_v1.cs

+30-6
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,46 @@ namespace System.Reflection.Metadata.ApplyUpdate.Test
77
{
88
public class AddNestedClass
99
{
10+
public static Action<string> X; // make the linker happy
11+
public static Delegate Y;
12+
public event Action<string> Evt;
13+
public void R () { Evt ("123"); }
1014
public AddNestedClass()
1115
{
1216
}
1317

1418
public string TestMethod()
1519
{
16-
var n = new Nested();
17-
n.f = "123";
18-
return n.M();
20+
var n = new Nested<string, int>();
21+
n.Eff = "123";
22+
n.g = 456;
23+
n.Evt += new Action<string> (n.DefaultHandler);
24+
n.RaiseEvt();
25+
return n.M() + n.buf;
1926
}
2027

21-
private class Nested {
28+
private class Nested<T, U> {
2229
public Nested() { }
23-
internal string f;
30+
internal T f;
31+
internal U g;
32+
public T Eff {
33+
get => f;
34+
set { f = value; }
35+
}
2436
public string M () {
25-
return f + "456";
37+
return Eff.ToString() + g.ToString();
38+
}
39+
40+
public event Action<string> Evt;
41+
42+
public void RaiseEvt () {
43+
Evt ("789");
44+
}
45+
46+
public string buf;
47+
48+
public void DefaultHandler (string s) {
49+
this.buf = s;
2650
}
2751
}
2852
}

‎src/libraries/System.Runtime.Loader/tests/ApplyUpdate/System.Reflection.Metadata.ApplyUpdate.Test.ReflectionAddNewType/ReflectionAddNewType.cs

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
// Licensed to the .NET Foundation under one or more agreements.
2+
// The .NET Foundation licenses this file to you under the MIT license.
3+
using System;
4+
5+
6+
namespace System.Reflection.Metadata.ApplyUpdate.Test.ReflectionAddNewType;
7+
8+
public interface IExistingInterface {
9+
public string ItfMethod(int i);
10+
}
11+
12+
public struct QExistingStruct
13+
{
14+
}
15+
16+
public enum FExistingEnum {
17+
One, Two
18+
}
19+
20+
public class ZExistingClass
21+
{
22+
public class PreviousNestedClass {
23+
public static DateTime Now; // make the linker happy
24+
public static ICloneable C;
25+
public event EventHandler<string> E;
26+
public void R() { E(this,"123"); }
27+
}
28+
}
29+
30+
[AttributeUsage(AttributeTargets.All, AllowMultiple=true, Inherited=false)]
31+
public class CustomNoteAttribute : Attribute {
32+
public CustomNoteAttribute(string note) {Note = note;}
33+
34+
public string Note;
35+
}

‎src/libraries/System.Runtime.Loader/tests/ApplyUpdate/System.Reflection.Metadata.ApplyUpdate.Test.ReflectionAddNewType/ReflectionAddNewType_v1.cs

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
// Licensed to the .NET Foundation under one or more agreements.
2+
// The .NET Foundation licenses this file to you under the MIT license.
3+
using System;
4+
5+
6+
namespace System.Reflection.Metadata.ApplyUpdate.Test.ReflectionAddNewType;
7+
8+
public interface IExistingInterface {
9+
public string ItfMethod(int i);
10+
}
11+
12+
public struct QExistingStruct
13+
{
14+
}
15+
16+
public enum FExistingEnum {
17+
One, Two
18+
}
19+
20+
public class ZExistingClass
21+
{
22+
public class PreviousNestedClass {
23+
public static DateTime Now; // make the linker happy
24+
public static ICloneable C;
25+
public event EventHandler<string> E;
26+
public void R() { E(this,"123"); }
27+
}
28+
public class NewNestedClass {};
29+
30+
31+
public string NewMethod (string s, int i) => s + i.ToString();
32+
33+
// Mono doesn't support instance fields yet
34+
#if false
35+
public int NewField;
36+
#endif
37+
38+
public static DateTime NewStaticField;
39+
40+
public static double NewProp { get; set; }
41+
}
42+
43+
[AttributeUsage(AttributeTargets.All, AllowMultiple=true, Inherited=false)]
44+
public class CustomNoteAttribute : Attribute {
45+
public CustomNoteAttribute(string note) {Note = note;}
46+
47+
public string Note;
48+
}
49+
50+
[CustomNote("123")]
51+
public class NewToplevelClass : IExistingInterface, ICloneable {
52+
public string ItfMethod(int i) {
53+
return i.ToString();
54+
}
55+
56+
[CustomNote("abcd")]
57+
public void SomeMethod(int x) {}
58+
59+
public virtual object Clone() {
60+
return new NewToplevelClass();
61+
}
62+
63+
public class AlsoNested { }
64+
65+
[CustomNote("hijkl")]
66+
public float NewProp {get; set;}
67+
68+
public byte[] OtherNewProp {get; set;}
69+
70+
public event EventHandler<string> NewEvent;
71+
public event EventHandler<byte> OtherNewEvent;
72+
}
73+
74+
public class NewGenericClass<T> : NewToplevelClass {
75+
public override object Clone() {
76+
return new NewGenericClass<T>();
77+
}
78+
}
79+
80+
public struct NewToplevelStruct {
81+
}
82+
83+
public interface INewInterface : IExistingInterface {
84+
public int AddedItfMethod (string s);
85+
}
86+
87+
public enum NewEnum {
88+
Red, Yellow, Green
89+
}

‎src/libraries/System.Runtime.Loader/tests/ApplyUpdate/System.Reflection.Metadata.ApplyUpdate.Test.ReflectionAddNewType/System.Reflection.Metadata.ApplyUpdate.Test.ReflectionAddNewType.csproj

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
<PropertyGroup>
3+
<RootNamespace>System.Runtime.Loader.Tests</RootNamespace>
4+
<TargetFramework>$(NetCoreAppCurrent)</TargetFramework>
5+
<TestRuntime>true</TestRuntime>
6+
<DeltaScript>deltascript.json</DeltaScript>
7+
</PropertyGroup>
8+
<ItemGroup>
9+
<Compile Include="ReflectionAddNewType.cs" />
10+
</ItemGroup>
11+
</Project>

‎src/libraries/System.Runtime.Loader/tests/ApplyUpdate/System.Reflection.Metadata.ApplyUpdate.Test.ReflectionAddNewType/deltascript.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"changes": [
3+
{"document": "ReflectionAddNewType.cs", "update": "ReflectionAddNewType_v1.cs"},
4+
]
5+
}
6+

0 commit comments

Comments
 (0)