Skip to content

fix: remove runtime references from codegen [MTT-4088] #2192

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

Closed
ShadauxCat wants to merge 6 commits into from
Closed

fix: remove runtime references from codegen [MTT-4088] #2192

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dd17c04
chore: removed dependency on codegen -> runtime
ShadauxCat Sep 9, 2022
c70b5dc
standards
ShadauxCat Sep 9, 2022
8521467
Rename some classes that conflict with Unity classes
ShadauxCat Sep 9, 2022
dec9707
Apparently I missed a file in my last checkin.
ShadauxCat Sep 12, 2022
b918bf1
Missed this one too.
ShadauxCat Sep 12, 2022
2d13f45
Merge branch 'develop' into chore/remove_runtime_references_from_codegen
jeffreyrainy Sep 13, 2022
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
450 changes: 278 additions & 172 deletions com.unity.netcode.gameobjects/Editor/CodeGen/CodeGenHelpers.cs
View file
Open in desktop

Large diffs are not rendered by default.

58 changes: 33 additions & 25 deletions com.unity.netcode.gameobjects/Editor/CodeGen/INetworkMessageILPP.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
using System.IO;
using System.Linq;
using System.Collections.Generic;
using System.Reflection;
using Mono.Cecil;
using Mono.Cecil.Cil;
using Mono.Cecil.Rocks;
using Unity.CompilationPipeline.Common.Diagnostics;
using Unity.CompilationPipeline.Common.ILPostProcessing;
using Unity.Netcode.Editor.CodeGen.Import;
using ILPPInterface = Unity.CompilationPipeline.Common.ILPostProcessing.ILPostProcessor;
using MethodAttributes = Mono.Cecil.MethodAttributes;

Expand All @@ -22,6 +22,8 @@ public override bool WillProcess(ICompiledAssembly compiledAssembly) =>

private readonly List<DiagnosticMessage> m_Diagnostics = new List<DiagnosticMessage>();

private PostProcessorAssemblyResolver m_AssemblyResolver;

public override ILPostProcessResult Process(ICompiledAssembly compiledAssembly)
{
if (!WillProcess(compiledAssembly))
Expand All @@ -32,7 +34,7 @@ public override ILPostProcessResult Process(ICompiledAssembly compiledAssembly)
m_Diagnostics.Clear();

// read
var assemblyDefinition = CodeGenHelpers.AssemblyDefinitionFor(compiledAssembly, out var resolver);
var assemblyDefinition = CodeGenHelpers.AssemblyDefinitionFor(compiledAssembly, out m_AssemblyResolver);
if (assemblyDefinition == null)
{
m_Diagnostics.AddError($"Cannot read assembly definition: {compiledAssembly.Name}");
Expand All @@ -46,7 +48,7 @@ public override ILPostProcessResult Process(ICompiledAssembly compiledAssembly)
if (ImportReferences(mainModule))
{
var types = mainModule.GetTypes()
.Where(t => t.Resolve().HasInterface(CodeGenHelpers.INetworkMessage_FullName) && !t.Resolve().IsAbstract)
.Where(t => t.Resolve().HasInterface(TypeNames.INetworkMessage) && !t.Resolve().IsAbstract)
.ToList();
// process `INetworkMessage` types
if (types.Count == 0)
Expand Down Expand Up @@ -101,66 +103,72 @@ public override ILPostProcessResult Process(ICompiledAssembly compiledAssembly)
private MethodReference m_Type_GetTypeFromHandle_MethodRef;
private MethodReference m_List_Add_MethodRef;

private const string k_ReceiveMessageName = nameof(MessagingSystem.ReceiveMessage);

private bool ImportReferences(ModuleDefinition moduleDefinition)
{
m_MessagingSystem_MessageHandler_Constructor_TypeRef = moduleDefinition.ImportReference(typeof(MessagingSystem.MessageHandler).GetConstructors()[0]);
var netcodeModule = moduleDefinition.Assembly.FindReferencedModule(m_AssemblyResolver, ModuleNames.NetcodeRuntime);
var netStandardModule = moduleDefinition.Assembly.FindReferencedModule(m_AssemblyResolver, ModuleNames.NetStandard);

var messageWithHandlerType = typeof(MessagingSystem.MessageWithHandler);
var definition = netcodeModule.FindType(TypeNames.MessagingSystem_MessageHandler);
m_MessagingSystem_MessageHandler_Constructor_TypeRef = moduleDefinition.ImportReference(definition.GetConstructors().First());

var messageWithHandlerType = netcodeModule.FindType(TypeNames.MessagingSystem_MessageWithHandler);
m_MessagingSystem_MessageWithHandler_TypeRef = moduleDefinition.ImportReference(messageWithHandlerType);
foreach (var fieldInfo in messageWithHandlerType.GetFields())
foreach (var fieldInfo in messageWithHandlerType.Fields)
{
switch (fieldInfo.Name)
{
case nameof(MessagingSystem.MessageWithHandler.MessageType):
case FieldNames.MessagingSystem_MessageType:
m_MessagingSystem_MessageWithHandler_MessageType_FieldRef = moduleDefinition.ImportReference(fieldInfo);
break;
case nameof(MessagingSystem.MessageWithHandler.Handler):
case FieldNames.MessagingSystem_Handler:
m_MessagingSystem_MessageWithHandler_Handler_FieldRef = moduleDefinition.ImportReference(fieldInfo);
break;
}
}

var typeType = typeof(Type);
foreach (var methodInfo in typeType.GetMethods())
var typeType = netStandardModule.FindType(TypeNames.Type);
foreach (var methodInfo in typeType.Methods)
{
switch (methodInfo.Name)
{
case nameof(Type.GetTypeFromHandle):
case MethodNames.Type_GetTypeFromHandle:
m_Type_GetTypeFromHandle_MethodRef = moduleDefinition.ImportReference(methodInfo);
break;
}
}

var ilppMessageProviderType = typeof(ILPPMessageProvider);
foreach (var fieldInfo in ilppMessageProviderType.GetFields(BindingFlags.Static | BindingFlags.NonPublic))
var ilppMessageProviderType = netcodeModule.FindType(TypeNames.ILPPMessageProvider);//typeof(ILPPMessageProvider);
foreach (var fieldInfo in ilppMessageProviderType.Fields)
{
switch (fieldInfo.Name)
{
case nameof(ILPPMessageProvider.__network_message_types):
case FieldNames.ILPPMessageProvider___network_message_types:
m_ILPPMessageProvider___network_message_types_FieldRef = moduleDefinition.ImportReference(fieldInfo);
break;
}
}

var listType = typeof(List<MessagingSystem.MessageWithHandler>);
foreach (var methodInfo in listType.GetMethods())
var genericListType = netStandardModule.FindType(TypeNames.List);
var listType = genericListType.MakeGenericInstanceType(messageWithHandlerType);

foreach (var methodInfo in genericListType.Methods)
{
switch (methodInfo.Name)
{
case nameof(List<MessagingSystem.MessageWithHandler>.Add):
m_List_Add_MethodRef = moduleDefinition.ImportReference(methodInfo);
case MethodNames.List_Add:
m_List_Add_MethodRef = methodInfo;
m_List_Add_MethodRef.DeclaringType = listType;
m_List_Add_MethodRef = moduleDefinition.ImportReference(m_List_Add_MethodRef);
break;
}
}

var messagingSystemType = typeof(MessagingSystem);
foreach (var methodInfo in messagingSystemType.GetMethods(BindingFlags.Static | BindingFlags.NonPublic | BindingFlags.Public))
var messagingSystemType = netcodeModule.FindType(TypeNames.MessagingSystem);
foreach (var methodInfo in messagingSystemType.Methods)
{
switch (methodInfo.Name)
{
case k_ReceiveMessageName:
case MethodNames.MessagingSystem_ReceiveMessage:
m_MessagingSystem_ReceiveMessage_MethodRef = moduleDefinition.ImportReference(methodInfo);
break;
}
Expand All @@ -175,7 +183,7 @@ private MethodDefinition GetOrCreateStaticConstructor(TypeDefinition typeDefinit
if (staticCtorMethodDef == null)
{
staticCtorMethodDef = new MethodDefinition(
".cctor", // Static Constructor (constant-constructor)
MethodNames.Module_StaticConstructor,
MethodAttributes.HideBySig |
MethodAttributes.SpecialName |
MethodAttributes.RTSpecialName |
Expand Down Expand Up @@ -227,7 +235,7 @@ private void CreateModuleInitializer(AssemblyDefinition assembly, List<TypeDefin
{
foreach (var typeDefinition in assembly.MainModule.Types)
{
if (typeDefinition.FullName == "<Module>")
if (typeDefinition.FullName == TypeNames.Module)
{
var staticCtorMethodDef = GetOrCreateStaticConstructor(typeDefinition);

Expand Down
11 changes: 6 additions & 5 deletions com.unity.netcode.gameobjects/Editor/CodeGen/INetworkSerializableILPP.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
using Mono.Cecil.Cil;
using Unity.CompilationPipeline.Common.Diagnostics;
using Unity.CompilationPipeline.Common.ILPostProcessing;
using Unity.Netcode.Editor.CodeGen.Import;
using ILPPInterface = Unity.CompilationPipeline.Common.ILPostProcessing.ILPostProcessor;

namespace Unity.Netcode.Editor.CodeGen
Expand Down Expand Up @@ -69,23 +70,23 @@ public override ILPostProcessResult Process(ICompiledAssembly compiledAssembly)
try
{
var structTypes = mainModule.GetTypes()
.Where(t => t.Resolve().HasInterface(CodeGenHelpers.INetworkSerializeByMemcpy_FullName) && !t.Resolve().IsAbstract && !t.Resolve().HasGenericParameters && t.Resolve().IsValueType)
.Where(t => t.Resolve().HasInterface(TypeNames.INetworkSerializeByMemcpy) && !t.Resolve().IsAbstract && !t.Resolve().HasGenericParameters && t.Resolve().IsValueType)
.ToList();

foreach (var type in structTypes)
{
// We'll avoid some confusion by ensuring users only choose one of the two
// serialization schemes - by method OR by memcpy, not both. We'll also do a cursory
// check that INetworkSerializeByMemcpy types are unmanaged.
if (type.HasInterface(CodeGenHelpers.INetworkSerializeByMemcpy_FullName))
if (type.HasInterface(TypeNames.INetworkSerializeByMemcpy))
{
if (type.HasInterface(CodeGenHelpers.INetworkSerializable_FullName))
if (type.HasInterface(TypeNames.INetworkSerializable))
{
m_Diagnostics.AddError($"{nameof(INetworkSerializeByMemcpy)} types may not implement {nameof(INetworkSerializable)} - choose one or the other.");
m_Diagnostics.AddError($"{TypeNames.INetworkSerializeByMemcpy} types may not implement {TypeNames.INetworkSerializable} - choose one or the other.");
}
if (!type.IsValueType)
{
m_Diagnostics.AddError($"{nameof(INetworkSerializeByMemcpy)} types must be unmanaged types.");
m_Diagnostics.AddError($"{TypeNames.INetworkSerializeByMemcpy} types must be unmanaged types.");
}
}
}
Expand Down
Loading