For unity msgpack when can support IL2CPP

[yjb523]

For unity msgpack when can support IL2CPP

[yfakariya]

After 0.6.0.

[tattsun]

Does 0.6.0-beta5 support IL2CPP?

[yfakariya]

No, IL2CPP supporting status is not progressed at all. Sorry for incovinience and too short answer above.
I personally think that IL2CPP itself is far from stable yet... So, although it is welcome to report issues about IL2CPP and msgpack for cli should be worked on the IL2CPP
environments, I cannot promise supporting plan yet.

[yfakariya]

@yjb523 @tattsun
The Issue #101 which blocks IL2CPP usage has been fixed now. Could you try it? https://github.com/msgpack/msgpack-cli/releases/tag/0.6.1.1

[jackson-dunstan]

Environment:

• MsgPack-CLI 0.6.1.1
• Unity 5.1.3f1
• Xcode 6.4
• iPad 3 (32-bit CPU)
• iOS 8.4.1

Crash:

NotSupportedException: /Users/builduser/buildslave/unity/build/Tools/il2cpp/il2cpp/libil2cpp/icalls/mscorlib/System/MonoCustomAttrs.cpp(80) : Unsupported internal call for IL2CPP:MonoCustomAttrs::GetCustomAttributesDataInternal - "This icall is not supported by il2cpp."
  at System.MonoCustomAttrs.GetCustomAttributesData (ICustomAttributeProvider obj) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.SerializationTarget.GetTargetMembers (System.Type type) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.SerializationTarget.Prepare (MsgPack.Serialization.SerializationContext context, System.Type targetType) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.ReflectionSerializers.ReflectionObjectMessagePackSerializer`1[T]..ctor (MsgPack.Serialization.SerializationContext context) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.MessagePackSerializer.CreateReflectionInternal[T] (MsgPack.Serialization.SerializationContext context, System.Type concreteType, MsgPack.Serialization.PolymorphismSchema schema) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.SerializationContext.GetSerializer[T] (System.Object providerParameter) [0x00000] in <filename unknown>:0 

Code:

public class ChatMessage
{
    public uint Id;
    public long Timestamp;
    public long SenderId;
    public string Text;

    public ChatMessage()
    {
    }
}

var serializer = SerializationContext.Default.GetSerializer<ChatMessage>();
var message = new ChatMessage() { Id = 123, Timestamp = 456, SenderId = 789, Text = "hi" };
serializer.PackSingleObject(message);

[yfakariya]

@jacksondisney Thank you for reporting!
It looks like this problem http://issuetracker.unity3d.com/issues/unity-ios-player-will-crash-if-use-messagpack-serializer (did you submit it?). Would you try patch 5.1.3p1?

[jounisuominen]

MsgPack is awesome. Hopefully we get IL2CPP support sooner than later. I can get around that GetCustomAttributesDataInternal issue with latest IL2CPP backend (4.6.8f1 or p1), but then I get:

ExecutionEngineException: Attempting to call method 'MsgPack.Serialization.SerializationContext::GetSerializer' for which no ahead of time (AOT) code was generated.
  at System.Reflection.MonoMethod.InternalInvoke (System.Object obj, System.Object[] parameters, System.Exception& exc) [0x00000] in <filename unknown>:0 
  at System.Reflection.MonoMethod.Invoke (System.Object obj, BindingFlags invokeAttr, System.Reflection.Binder binder, System.Object[] parameters, System.Globalization.CultureInfo culture) [0x00000] in <filename unknown>:0 
  at System.Reflection.MethodBase.Invoke (System.Object obj, System.Object[] parameters) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.ReflectionExtensions.InvokePreservingExceptionType (System.Reflection.MethodInfo source, System.Object instance, System.Object[] parameters) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.SerializationContext+SerializerGetter.Get (MsgPack.Serialization.SerializationContext context, System.Type targetType, System.Object providerParameter) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.SerializationContext.GetSerializer (System.Type targetType, System.Object providerParameter) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.ReflectionSerializers.ReflectionSerializerHelper.GetMetadata (IList`1 members, MsgPack.Serialization.SerializationContext context, System.Func`2[]& getters, System.Action`2[]& setters, System.Reflection.MemberInfo[]& memberInfos, MsgPack.Serialization.DataMemberContract[]& contracts, MsgPack.Serialization.IMessagePackSerializer[]& serializers) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.ReflectionSerializers.ReflectionObjectMessagePackSerializer`1[T]..ctor (MsgPack.Serialization.SerializationContext context) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.MessagePackSerializer.CreateReflectionInternal[T] (MsgPack.Serialization.SerializationContext context, System.Type concreteType, MsgPack.Serialization.PolymorphismSchema schema) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.SerializationContext.GetSerializer[T] (System.Object providerParameter) [0x00000] in <filename unknown>:0 
  at System.Reflection.MonoMethod.InternalInvoke (System.Object obj, System.Object[] parameters, System.Exception& exc) [0x00000] in <filename unknown>:0 
  at System.Reflection.MonoMethod.Invoke (System.Object obj, BindingFlags invokeAttr, System.Reflection.Binder binder, System.Object[] parameters, System.Globalization.CultureInfo culture) [0x00000] in <filename unknown>:0 
  at System.Reflection.MethodBase.Invoke (System.Object obj, System.Object[] parameters) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.ReflectionExtensions.InvokePreservingExceptionType (System.Reflection.MethodInfo source, System.Object instance, System.Object[] parameters) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.SerializationContext+SerializerGetter.Get (MsgPack.Serialization.SerializationContext context, System.Type targetType, System.Object providerParameter) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.SerializationContext.GetSerializer (System.Type targetType, System.Object providerParameter) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.DefaultSerializers.System_Collections_Generic_List_1MessagePackSerializer..ctor (MsgPack.Serialization.SerializationContext ownerContext, System.Type targetType, MsgPack.Serialization.CollectionTraits traits, MsgPack.Serialization.PolymorphismSchema itemsSchema) [0x00000] in <filename unknown>:0 
...

[tattsun]

I tried both 0.6.1.1 and 0.6.3 in Unity 5.1.3f1, but they cause error below.
The errors occur when Unity was just importing msgpack dll for unity, not compiling(of course, I couldn't compile my project 😢).

Error:

Unhandled Exception: System.Reflection.ReflectionTypeLoadException: The classes in the module cannot be loaded.
  at (wrapper managed-to-native) System.Reflection.Assembly:GetTypes (bool)
  at System.Reflection.Assembly.GetTypes () [0x00000] in <filename unknown>:0 
  at Mono.CSharp.RootNamespace.ComputeNamespaces (System.Reflection.Assembly assembly, System.Type extensionType) [0x00000] in <filename unknown>:0 
  at Mono.CSharp.RootNamespace.ComputeNamespace (Mono.CSharp.CompilerContext ctx, System.Type extensionType) [0x00000] in <filename unknown>:0 
  at Mono.CSharp.GlobalRootNamespace.ComputeNamespaces (Mono.CSharp.CompilerContext ctx) [0x00000] in <filename unknown>:0 
  at Mono.CSharp.Driver.LoadReferences () [0x00000] in <filename unknown>:0 
  at Mono.CSharp.Driver.Compile () [0x00000] in <filename unknown>:0 
  at Mono.CSharp.Driver.Main (System.String[] args) [0x00000] in <filename unknown>:0 

Any idea to resolve it?

[yfakariya]

@jounisuominen Thank you for reporting. It looks another AOT issue from Mono AOT based one.

[yfakariya]

@tattsun I have not faced this issue, but I guess you specified wrong assembly (for example, specifying an assembly for CLR 4). Would you look that you specified the dll under Unity3D or Unity3D.Full directory of zip file? Note that dlls in nupkg file do NOT support Unity.

[tattsun]

@yfakariya No. I exactly uses dll in Unity3D.full. I repeatedly checked my project, but the error won't go away. Could you check my repo?

Environments

• Unity 5.1.3f1
• MsgPack.Cli.0.6.2
  • The imported dll is unity3d-full version.

https://github.com/tattsun/msgpack-unity-sample

[yfakariya]

@tattsun I saw your repository. You used ".NET 2.0 subset" in the Player settings, in spite of you used unity3d-full. You can avoid this error as follows:

1. Set ".NET 2.0" option in Player settings > Optimization > API Compatibility Level.
2. Or use the dll under "unity3d" instead of "unity3d-full".

[tattsun]

@yfakariya oh...it works fine. Thanks!

[tattsun]

Please see a sample class: https://github.com/tattsun/msgpack-unity-sample/blob/master/Assets/MsgPackTest.cs

It seems that SerializationContext.Default.GetSerializer fails when we try to get Serializer of a class that has two or more properties.
In that sample class, getting SampleClass doesn't fail, but getting FailClass throws an exception.

Exception is:

ExecutionEngineException: Attempting to call method 'MsgPack.Serialization.SerializationContext::GetSerializer' for which no ahead of time (AOT) code was generated.
  at System.Reflection.MonoMethod.InternalInvoke (System.Object obj, System.Object[] parameters, System.Exception& exc) [0x00000] in <filename unknown>:0 
  at System.Reflection.MonoMethod.Invoke (System.Object obj, BindingFlags invokeAttr, System.Reflection.Binder binder, System.Object[] parameters, System.Globalization.CultureInfo culture) [0x00000] in <filename unknown>:0 
  at System.Reflection.MethodBase.Invoke (System.Object obj, System.Object[] parameters) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.ReflectionExtensions.InvokePreservingExceptionType (System.Reflection.MethodInfo source, System.Object instance, System.Object[] parameters) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.SerializationContext+SerializerGetter.Get (MsgPack.Serialization.SerializationContext context, System.Type targetType, System.Object providerParameter) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.SerializationContext.GetSerializer (System.Type targetType, System.Object providerParameter) [0x00000] in <filename unknown>:0 
  at MsgPack.Serialization.ReflectionSerializers.ReflectionSerializerHelper.GetMetadata (IList`1 members, MsgPack.Serialization.SerializationContext context, System.Func`2[]& getters, System.Action`2[]& setters, 

Environment:

• Unity 5.1.3p1
• MsgPack.Cli.0.6.2(unity-full ver.)