[Bug 1214643][2019.3.0f5] System.Runtime.CompilerServices.Unsafe clashes with imported dll

Unity Engine
,
1

MessagePack-CSharp requires System.Runtime.CompilerServices.Unsafe 4.5.1

Unity.Burst and Unity.Collections require 4.5.0

This causes Unity to go cause havoc:

  • Breaks all assembly definitions
  • Causes Unity to Crash
  • Unable to import the dlls anymore
  • Unable to show the inspector for any

Unity.2019.3.0f5
Having the following asmdef in my project

{
    "name": "Plugins",
    "references": [],
    "includePlatforms": [],
    "excludePlatforms": [],
    "allowUnsafeCode": true,
    "overrideReferences": true,
    "precompiledReferences": [
        "Zenject-usage.dll",
        "Sirenix.OdinInspector.Attributes.dll",
        "Sirenix.Utilities.dll",
        "Sirenix.Serialization.Config.dll",
        "Accord.dll",
        "Accord.Math.dll",
        "Accord.Math.Core.dll",
        "Sirenix.Serialization.dll",
        "System.Memory.dll",
        "System.Threading.Tasks.Extensions.dll",
        "System.Buffers.dll",
        "System.Runtime.CompilerServices.Unsafe.dll",
        "Ookii.Dialogs.dll",
        "System.Windows.Forms.dll"
    ],
    "autoReferenced": false,
    "defineConstraints": [],
    "versionDefines": [],
    "noEngineReferences": false
}

whcih references a “non auto reference” to System.Runtime.CompilerServices.Unsafe.dll and updating packages from

{
  "dependencies": {
    "com.unity.burst": "1.2.0",
    "com.unity.collections": "0.5.0-preview.9",
    "com.unity.entities": "0.5.0-preview.17",
    "com.unity.ext.nunit": "1.0.0",
    "com.unity.ide.rider": "1.1.4",
    "com.unity.inputsystem": "1.0.0-preview.3",
    "com.unity.jobs": "0.2.3-preview.9",
    "com.unity.mathematics": "1.1.0",
    "com.unity.memoryprofiler": "0.2.0-preview.1",
    "com.unity.performance.profile-analyzer": "0.5.0-preview.1",
    "com.unity.physics": "0.2.5-preview.1",
    "com.unity.quicksearch": "1.4.1",
    "com.unity.rendering.hybrid": "0.3.2-preview.17",
    "com.unity.searcher": "4.0.9",
    "com.unity.test-framework.performance": "1.3.2-preview",
    "com.unity.testtools.codecoverage": "0.2.2-preview",
    "com.unity.textmeshpro": "2.0.1",
    "nuget.mono-cecil": "0.1.6-preview",
    "com.unity.modules.animation": "1.0.0",
    "com.unity.modules.assetbundle": "1.0.0",
    "com.unity.modules.audio": "1.0.0",
    "com.unity.modules.imageconversion": "1.0.0",
    "com.unity.modules.imgui": "1.0.0",
    "com.unity.modules.jsonserialize": "1.0.0",
    "com.unity.modules.physics": "1.0.0",
    "com.unity.modules.physics2d": "1.0.0",
    "com.unity.modules.terrain": "1.0.0",
    "com.unity.modules.terrainphysics": "1.0.0",
    "com.unity.modules.ui": "1.0.0",
    "com.unity.modules.uielements": "1.0.0",
    "com.unity.modules.umbra": "1.0.0",
    "com.unity.modules.unitywebrequest": "1.0.0",
    "com.unity.modules.unitywebrequestassetbundle": "1.0.0",
    "com.unity.modules.unitywebrequestaudio": "1.0.0",
    "com.unity.modules.unitywebrequestwww": "1.0.0",
    "com.unity.modules.vr": "1.0.0",
    "com.unity.modules.xr": "1.0.0"
  },
  "testables": [
    "com.unity.test-framework.performance"
  ]
}

to

{
  "dependencies": {
    "com.unity.burst": "1.2.1",
    "com.unity.collections": "0.5.0-preview.9",
    "com.unity.entities": "0.5.0-preview.17",
    "com.unity.ext.nunit": "1.0.0",
    "com.unity.ide.rider": "1.1.4",
    "com.unity.inputsystem": "1.0.0-preview.4",
    "com.unity.jobs": "0.2.3-preview.9",
    "com.unity.mathematics": "1.1.0",
    "com.unity.memoryprofiler": "0.2.0-preview.1",
    "com.unity.performance.profile-analyzer": "0.5.0-preview.1",
    "com.unity.physics": "0.2.5-preview.1",
    "com.unity.rendering.hybrid": "0.3.2-preview.17",
    "com.unity.searcher": "4.0.9",
    "com.unity.test-framework.performance": "1.3.2-preview",
    "com.unity.testtools.codecoverage": "0.2.2-preview",
    "com.unity.textmeshpro": "2.0.1",
    "nuget.mono-cecil": "0.1.6-preview",
    "com.unity.modules.animation": "1.0.0",
    "com.unity.modules.assetbundle": "1.0.0",
    "com.unity.modules.audio": "1.0.0",
    "com.unity.modules.imageconversion": "1.0.0",
    "com.unity.modules.imgui": "1.0.0",
    "com.unity.modules.jsonserialize": "1.0.0",
    "com.unity.modules.physics": "1.0.0",
    "com.unity.modules.physics2d": "1.0.0",
    "com.unity.modules.terrain": "1.0.0",
    "com.unity.modules.terrainphysics": "1.0.0",
    "com.unity.modules.ui": "1.0.0",
    "com.unity.modules.uielements": "1.0.0",
    "com.unity.modules.umbra": "1.0.0",
    "com.unity.modules.unitywebrequest": "1.0.0",
    "com.unity.modules.unitywebrequestassetbundle": "1.0.0",
    "com.unity.modules.unitywebrequestaudio": "1.0.0",
    "com.unity.modules.unitywebrequestwww": "1.0.0",
    "com.unity.modules.vr": "1.0.0",
    "com.unity.modules.xr": "1.0.0"
  },
  "testables": [
    "com.unity.test-framework.performance"
  ]
}

breaks Unity completly and it does not recover. As there is no way to control the dlls added via packages I am not able to remove the namespace clash as Unity will add it’s own version via Burst and that causes Unity to break horribly. All that would be needed is to make sure packages use their own dll and don’t auto import them into any other asmdef in the whole unity project.

This currently means I am not able to add anything to a Unity project which requires a different version of a dll that is added via Unity packages.

Furthermore unity does do the following extremly nasty things:

  • Create new asmdef files, which removes ALL the dependencies you would require to compile the code within this asmdef, which causes the asmdef to not compile anyway

  • Fallback to Assembly-CSharp.csproj, … default projects although it is clear that those also can never compile as all the dependencies and folders are set up as defined in the asmdef files and therefore this breaks

  • Crashes regularly once this happens. The only way to get Unity into a non crashing state is to close unity, manually edit all asmdef, delete all the dlls involved from all package cache folders, then remove the dll you would need and import from your code and then once there is no such nameclash anymore then start Unity again and reimport everything.

  • Auto reference added dlls from within a package (Burst) to outside of that package (e.g. ANY other csproj)

Workaround

See also

5410266--549600--2020-01-26 20_15_40-bug.png

Unity.Collections exception
Problem: Package "Searcher" now depends on several included DLLs
2

Setup Collections as a development package. That seems to be the most correct approach to resolve this short of Collections doing the right thing, which you can’t exactly wait around for.

Howto:

  • Copy Collections from Library/PackageCache to %Project Folder%/Packages
  • Remove CompilerServices.Unsafe dll from said folder
  • Add the version of CompilerServices.Unsafe dll that you want to use in Assets folder.
3

Also just to be clear I don’t think the issue is burst, it’s the Unsafe dll in Collections that is the problem.

The dll’s in .Runtime are not loaded globally, quick peek it actually looks like burst creates it’s own appdomain. Which actually answers a question I posted yesterday about why burst fails loading our custom Unsafe dll (it already had it’s own version loaded).

1 Like
4

Ran into this same issue but even worse with the number of assembly definitions we have. The only way to resolve it was either reference exactly every single dll a file depended on, or rework the other dlls to use the one shipped with collections. The way dlls inside packages seem to disappear when compiling things in assembly definitions is super frustrating.

5

Yes, the issue is with the Collections package. The proper way to fix this would be that Unity is shipping an official package with this CompilerServices.Unsafe dll on its own, or it is shipping an internal version of it (as we do in Burst) to avoid clashing with end-user dll. I will ping back the team internally to make them aware of this issue.

5 Likes
6

Please do not loose sight on all the other bugs listed above. It is one thing to get a nameclash in the same domain. It is another to bring the project in a (without manually recreating everything) unrepairable state because Unity begins to overwrite asmdef files with empty reference sections and cascade into a crash to desktop.

7

@xoofx Any news on this?

8

cc: @bryanmcnett

9

Hopefully this might be useful to someone…

I was running into a similar issue with different libraries depending on different versions of System.Runtime.CompilerServices.Unsafe. I tried a variety of different approaches to include using bindingRedirects (which would have been fantastic if they worked with Unity) but most of them failed.

After scouring the internet for clues (I don’t remember the exact source that helped), the only approach that sort of worked was to tie into AppDomain.AssemblyResolve. That way, when an attempt is made to resolve to a specific version on the assembly, you can redirect it to the version that is forcibly embedded in the Collections package. Below are the scripts I used to try to work around the issue (not sure if this is a good approach or not…).

The Editor portion doesn’t actually appear to work as I intended. I had to give up on some of my attempts when dealing with assemblies not loading in the Editor because AssemblyResolve was not getting consistently called for some reason.

ResolveAssemblies:

using System;
using System.Globalization;
using System.Reflection;
using UnityEngine;

/// <summary>
/// Resolves required assemblies. Somewhat mimics the typical app.config/bindingRedirect configurations which
/// don't appear to work with Unity.
/// </summary>
public class ResolveAssemblies
{
    private static Assembly cachedAssembly = null;

    static ResolveAssemblies()
    {
        RedirectAssemblies();
    }

    /// <summary>
    /// Method that forces a call to the static constructor.
    /// </summary>
    [RuntimeInitializeOnLoadMethod]
    public static void StaticInitialize()
    {
        // force call to static constructor
    }

    private static void RedirectAssemblies()
    {
        //// The Unity Collections packages currently embeds a specific version of the
        //// "System.Runtime.CompilerServices.Unsafe" library. Because of this, you are unable to include other
        //// versions of the same library resulting in version conflicts. For now, redirect to the version in
        //// the Unity Collections package.

        AppDomain.CurrentDomain.AssemblyResolve += AssemblyResolve;
        AppDomain.CurrentDomain.DomainUnload += DomainUnload;
    }

    private static Assembly AssemblyResolve(object sender, ResolveEventArgs args)
    {
        var requestedAssembly = new AssemblyName(args.Name);
        if (requestedAssembly.Name != "System.Runtime.CompilerServices.Unsafe")
        {
            return null;
        }

        // Cache the assembly in case multiple attempts are made for different versions
        if (cachedAssembly != null)
        {
            return cachedAssembly;
        }

        // Redirect to a specific version of the assembly
        var targetPublicKeyToken = new AssemblyName("x, PublicKeyToken=b03f5f7f11d50a3a").GetPublicKeyToken();
        requestedAssembly.SetPublicKeyToken(targetPublicKeyToken);
        requestedAssembly.Version = new Version("4.0.4.0");
        requestedAssembly.CultureInfo = CultureInfo.InvariantCulture;
        cachedAssembly = Assembly.Load(requestedAssembly);
        return cachedAssembly;
    }

    private static void DomainUnload(object sender, EventArgs e)
    {
        AppDomain.CurrentDomain.AssemblyResolve -= AssemblyResolve;
        AppDomain.CurrentDomain.DomainUnload -= DomainUnload;
    }
}

ResolveAssembliesEditor:

using UnityEditor;
    using UnityEngine;

    /// <summary>
    /// Resolves required assemblies in the Unity Editor. See <see cref="ResolveAssemblies"/>.
    /// </summary>
    [InitializeOnLoad]
    public class ResolveAssembliesEditor : MonoBehaviour
    {
        static ResolveAssembliesEditor()
        {
            ResolveAssemblies.StaticInitialize();
        }
    }
2 Likes
10

@bryanmcnett , @xoofx nothing yet?

11

ending up using a simple workaround for now
move packages from packagecache to the packages folder (unity auto finds ones in there as ones your editing)
then delete the dll from inside it (we needed both collections and newtonsoft packages)
then in your project use the versions you need for other things (like our signalr client)

when you update packages, make sure you delete those old ones and get the latest and redelete the dll’s till you can get your hard referenced versions to go away.

12

Install the package development package and it makes this easy. Single click to add/remove from development.

2 Likes
13

In case the clash is on second level dependencies (A=>C.v1,B =>C.v2) the above deletion and copy workaround does not work out that easy, as B might not be shipped by unity but the dependency C clashes.

You can recompile the library with a proper reference. That works for dlls like System.Threading.Tasks.Extensions:

  • Decompile
  • Change reference
  • Recompile

In cases where this is not so straight forward (actually compiling System.Threading.Tasks.Extensions from the dotnet core library is not as easy as opening the csproj file in there and simply updating the version - but that obviously is one way to do it!) you can simply disassemble the dll and re-assemble it with a diferent reference version as long as the called code is compatible (obviously a nasty hack, but that hack takes a few seconds of your time and might unblock you). This is in particular helpful where decompiling and recompiling is not as straight forward as well (if anyone has tried that with Jetbrains DotPeek on System.Buffer.dll and System.Memory.dll s/he will know what I mean)

This essentially is close to a proper binding redirect which is not available in the dotnet core way in Unity.

1 Like
14

Still no update in the Collections package. Come on Unity. Remove the DLL from the package so we can get our project to work!

15

See here

2 Likes