Minor refactoring

Author: mcpiroman

scripts/DllManipulator.ReflectionCache.cs scripts/DllManipulator.ReflectionData.csscripts/DllManipulator.ReflectionCache.cs renamed to scripts/DllManipulator.ReflectionData.cs

@@ -4,7 +4,6 @@
 using System.Reflection;
 using System.Reflection.Emit;
 using System.Runtime.InteropServices;
-using System.Runtime.CompilerServices;
 using System.Threading;
 using System.IO;
 using UnityEngine;
@@ -22,7 +21,7 @@ public partial class DllManipulator
         public static DllManipulatorOptions Options { get; set; }
         private static int _unityMainThreadId;
         private static string _assetsPath;
-        private static LinkedList<object> _antiGcRefHolder = new LinkedList<object>();
+        private static readonly LinkedList<object> _antiGcRefHolder = new LinkedList<object>();
         private static readonly ReaderWriterLockSlim _nativeFunctionLoadLock = new ReaderWriterLockSlim();
         private static ModuleBuilder _customDelegateTypesModule = null;
         private static readonly Dictionary<string, NativeDll> _dlls = new Dictionary<string, NativeDll>();
@@ -32,10 +31,59 @@ public partial class DllManipulator
         private static int _createdDelegateTypes = 0;
         private static int _lastNativeCallIndex = 0; //Use with synchronization
 
-        internal static void SetUnityContext(int unityMainThreadId, string assetsPath)
+        /// <summary>
+        /// Initialization.
+        /// Finds and mocks relevant native function declarations.
+        /// If <see cref="DllLoadingMode.Preload"/> option is specified, loads all DLLs specified by these functions.
+        /// Options have to be configured before calling this method.
+        /// </summary>
+        internal static void Initialize(int unityMainThreadId, string assetsPath)
         {
-            DllManipulator._unityMainThreadId = unityMainThreadId;
-            DllManipulator._assetsPath = assetsPath;
+            _unityMainThreadId = unityMainThreadId;
+            _assetsPath = assetsPath;
+
+            LowLevelPluginManager.ResetStubPlugin();
+
+            Assembly[] assemblies;
+            if (Options.assemblyPaths.Length == 0)
+            {
+                assemblies = new[] { Assembly.GetExecutingAssembly() };
+            }
+            else
+            {
+                var allAssemblies = AppDomain.CurrentDomain.GetAssemblies();
+                assemblies = allAssemblies.Where(a => !a.IsDynamic && Options.assemblyPaths.Any(p => p == PathUtils.NormallizeSystemAssemblyPath(a.Location))).ToArray();
+                var missingAssemblies = Options.assemblyPaths.Except(assemblies.Select(a => PathUtils.NormallizeSystemAssemblyPath(a.Location)));
+                foreach (var assemblyPath in missingAssemblies)
+                {
+                    Debug.LogError($"Could not find assembly at path {assemblyPath}");
+                }
+            }
+
+            foreach (var assembly in assemblies)
+            {
+                var allTypes = assembly.GetTypes();
+                foreach (var type in allTypes)
+                {
+                    foreach (var method in type.GetMethods(BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic))
+                    {
+                        if (method.IsDefined(typeof(DllImportAttribute)))
+                        {
+                            if (method.IsDefined(typeof(DisableMockingAttribute)))
+                                continue;
+
+                            if (method.DeclaringType.IsDefined(typeof(DisableMockingAttribute)))
+                                continue;
+
+                            if (Options.mockAllNativeFunctions || method.IsDefined(typeof(MockNativeDeclarationAttribute)) || method.DeclaringType.IsDefined(typeof(MockNativeDeclarationsAttribute)))
+                                MockNativeFunction(method);
+                        }
+                    }
+                }
+            }
+
+            if (Options.loadingMode == DllLoadingMode.Preload)
+                LoadAll();
         }
 
         /// <summary>
@@ -129,36 +177,14 @@ public static IList<NativeDllInfo> GetUsedDllsInfos()
             return dllInfos;
         }
 
-        internal static IEnumerable<MethodInfo> FindNativeFunctionsToMock(Assembly assembly)
-        {
-            var allTypes = assembly.GetTypes();
-            foreach (var type in allTypes)
-            {
-                foreach (var method in type.GetMethods(BindingFlags.Static | BindingFlags.Public | BindingFlags.NonPublic))
-                {
-                    if (method.IsDefined(typeof(DllImportAttribute)))
-                    {
-                        if (method.IsDefined(typeof(DisableMockingAttribute)))
-                            continue;
-
-                        if (method.DeclaringType.IsDefined(typeof(DisableMockingAttribute)))
-                            continue;
-
-                        if (Options.mockAllNativeFunctions || method.IsDefined(typeof(MockNativeDeclarationAttribute)) || method.DeclaringType.IsDefined(typeof(MockNativeDeclarationsAttribute)))
-                            yield return method;
-                    }
-                }
-            }
-        }
-
         private static string ApplyDirectoryPathMacros(string path)
         {
             return path
                 .Replace(DLL_PATH_PATTERN_ASSETS_MACRO, _assetsPath)
                 .Replace(DLL_PATH_PATTERN_PROJECT_MACRO, _assetsPath + "/../");
         }
 
-        internal static void MockNativeFunction(MethodInfo function)
+        private static void MockNativeFunction(MethodInfo function)
         {
             var methodMock = GetNativeFunctionMockMethod(function);
             Detour.MarkForNoInlining(function);
@@ -343,7 +369,7 @@ private static Type CreateDelegateTypeForNativeFunctionSignature(NativeFunctionS
             var invokeReturnParam = invokeBuilder.DefineParameter(0, functionSignature.returnParameter.parameterAttributes, null);
             foreach (var attr in functionSignature.returnParameter.customAttributes)
             {
-                var attrBuilder = CreateMarshalingAttributeBuilderFromAttributeInstance(attr, functionName);
+                var attrBuilder = CreateAttributeBuilderFromAttributeInstance(attr, functionName);
                 if(attrBuilder != null)
                     invokeReturnParam.SetCustomAttribute(attrBuilder);
             }
@@ -353,7 +379,7 @@ private static Type CreateDelegateTypeForNativeFunctionSignature(NativeFunctionS
                 var paramBuilder = invokeBuilder.DefineParameter(i + 1, param.parameterAttributes, null);
                 foreach(var attr in param.customAttributes)
                 {
-                    var attrBuilder = CreateMarshalingAttributeBuilderFromAttributeInstance(attr, functionName);
+                    var attrBuilder = CreateAttributeBuilderFromAttributeInstance(attr, functionName);
                     if (attrBuilder != null)
                         paramBuilder.SetCustomAttribute(attrBuilder);
                 }
@@ -363,15 +389,15 @@ private static Type CreateDelegateTypeForNativeFunctionSignature(NativeFunctionS
             return delBuilder.CreateType();
         }
 
-        private static CustomAttributeBuilder CreateMarshalingAttributeBuilderFromAttributeInstance(Attribute attribute, string nativeFunctionName)
+        private static CustomAttributeBuilder CreateAttributeBuilderFromAttributeInstance(Attribute attribute, string nativeFunctionName)
         {
             var attrType = attribute.GetType();
             switch (attribute)
             {
                 case MarshalAsAttribute marshalAsAttribute:
                 {
                     if(marshalAsAttribute.Value == UnmanagedType.LPArray) // Used to bypass Mono bug, see https://github.com/mono/mono/issues/16570
-                        throw new Exception("UnmanagedType.LPArray in [MarshalAs] attribute is not supported. See Limitations section");
+                        throw new Exception("UnmanagedType.LPArray in [MarshalAs] attribute is not supported. See Limitations section.");
 
                     object[] ctorArgs = { marshalAsAttribute.Value };
 
@@ -392,7 +418,7 @@ private static CustomAttributeBuilder CreateMarshalingAttributeBuilderFromAttrib
                 }
                 default:
                 {
-                    Debug.LogWarning($"Skipping attribute [{attrType.Name}] in function {nativeFunctionName} as it is not supported. However, adding the support should be ease.");
+                    Debug.LogWarning($"Skipping copy of attribute [{attrType.Name}] in function {nativeFunctionName} as it is not supported. However, if it is desirable to include it, adding such support should be easy. See the method that throws this exception.");
                     return null;
                 }
             }
@@ -538,9 +564,9 @@ private static IntPtr SysLoadDll(string filepath)
 #if UNITY_STANDALONE_WIN
             return PInvokes_Windows.LoadLibrary(filepath);
 #elif UNITY_STANDALONE_LINUX
-            return PInvokes_Linux.dlopen(filepath, (int)Options.unixDlopenFlags);
+            return PInvokes_Linux.dlopen(filepath, (int)Options.posixDlopenFlags);
 #elif UNITY_STANDALONE_OSX
-            return PInvokes_Osx.dlopen(filepath, (int)Options.unixDlopenFlags);
+            return PInvokes_Osx.dlopen(filepath, (int)Options.posixDlopenFlags);
 #endif
         }
 
@@ -573,7 +599,7 @@ public class DllManipulatorOptions
         public string dllPathPattern;
         public string[] assemblyPaths; //empty means only executing assembly
         public DllLoadingMode loadingMode;
-        public Unix_DlopenFlags unixDlopenFlags;
+        public PosixDlopenFlags posixDlopenFlags;
         public bool threadSafe;
         public bool enableCrashLogs;
         public string crashLogsDir;

scripts/DllManipulator.cs

@@ -23,7 +23,7 @@ public class DllManipulatorScript : MonoBehaviour
 #endif
             assemblyPaths = new string[0],
             loadingMode = DllLoadingMode.Lazy,
-            unixDlopenFlags = Unix_DlopenFlags.Lazy,
+            posixDlopenFlags = PosixDlopenFlags.Lazy,
             threadSafe = false,
             enableCrashLogs = false,
             crashLogsDir = "{assets}/",
@@ -47,42 +47,13 @@ private void OnEnable()
             _singletonInstance = this;
             DontDestroyOnLoad(gameObject);
 
-            var timer = System.Diagnostics.Stopwatch.StartNew();
+            var initTimer = System.Diagnostics.Stopwatch.StartNew();
 
-            LowLevelPluginManager.ResetStubPlugin();
-
-            DllManipulator.SetUnityContext(Thread.CurrentThread.ManagedThreadId, Application.dataPath);
             DllManipulator.Options = Options;
+            DllManipulator.Initialize(Thread.CurrentThread.ManagedThreadId, Application.dataPath);
 
-            Assembly[] assemblies;
-            if (Options.assemblyPaths.Length == 0)
-            {
-                assemblies = new[] { Assembly.GetExecutingAssembly() };
-            }
-            else
-            {
-                var allAssemblies = AppDomain.CurrentDomain.GetAssemblies();
-                assemblies = allAssemblies.Where(a => !a.IsDynamic && Options.assemblyPaths.Any(p => p == PathUtils.NormallizeSystemAssemblyPath(a.Location))).ToArray();
-                var missingAssemblies = Options.assemblyPaths.Except(assemblies.Select(a => PathUtils.NormallizeSystemAssemblyPath(a.Location)));
-                foreach(var assemblyPath in missingAssemblies)
-                {
-                    Debug.LogError($"Could not find assembly at path {assemblyPath}");
-                }
-            }
-
-            foreach (var assembly in assemblies)
-            {
-                foreach (var function in DllManipulator.FindNativeFunctionsToMock(assembly))
-                {
-                    DllManipulator.MockNativeFunction(function);
-                }
-            }
-
-            if (DllManipulator.Options.loadingMode == DllLoadingMode.Preload)
-                DllManipulator.LoadAll();
-
-            timer.Stop();
-            InitializationTime = timer.Elapsed;
+            initTimer.Stop();
+            InitializationTime = initTimer.Elapsed;
         }
 
         private void OnDestroy()

scripts/DllManipulatorScript.cs

@@ -32,7 +32,7 @@ public class DllManipulatorEditor : Editor
             "Specifies how DLLs and functions will be loaded.\n\n" +
             "Lazy - All DLLs and functions are loaded each time they are called, if not loaded yet. This allows them to be easily unloaded and loaded within game execution.\n\n" +
             "Preloaded - Slight performance benefit over Lazy mode. All declared DLLs and functions are loaded at startup (OnEnable()) and not reloaded later. Mid-execution it's not safe to unload them unless game is paused.");
-        private static readonly GUIContent UNIX_DLOPEN_FLAGS_GUI_CONTENT = new GUIContent("dlopen flags",
+        private static readonly GUIContent POSIX_DLOPEN_FLAGS_GUI_CONTENT = new GUIContent("dlopen flags",
             "Flags used in dlopen() P/Invoke on Linux and OSX systems. Has minor meaning unless library is large.");
         private static readonly GUIContent THREAD_SAFE_GUI_CONTENT = new GUIContent("Thread safe",
             "Ensures synchronization required for native calls from any other than Unity main thread. Overhead might be few times higher, with uncontended locks.\n\n" +
@@ -252,7 +252,7 @@ private void DrawOptions(DllManipulatorOptions options)
             options.loadingMode = (DllLoadingMode)EditorGUILayout.EnumPopup(DLL_LOADING_MODE_GUI_CONTENT, options.loadingMode);
 
 #if UNITY_STANDALONE_LINUX || UNITY_STANDALONE_OSX
-            options.unixDlopenFlags = (Unix_DlopenFlags)EditorGUILayout.EnumPopup(UNIX_DLOPEN_FLAGS_GUI_CONTENT, options.unixDlopenFlags);
+            options.posixDlopenFlags = (PosixDlopenFlags)EditorGUILayout.EnumPopup(POSIX_DLOPEN_FLAGS_GUI_CONTENT, options.posixDlopenFlags);
 #endif
 
             guiEnabledStack.Push(GUI.enabled);

scripts/Editor/DllManipulatorEditor.cs

@@ -40,7 +40,7 @@ public static void OnDllLoaded(NativeDll dll)
                 }
                 catch (DllNotFoundException)
                 {
-                    Debug.LogWarning("StubLluiPlugin not found. UnityPluginLoad and UnityPluginUnload callbacks won't fire. If you didn't install UnityNativeTool from .unitypackage or it didn't contain the compiled plugin, you'll need to compile it manually. Alternatively, you may comment out this warning if you don't care about these callbacks.");
+                    Debug.LogWarning("StubLluiPlugin not found. UnityPluginLoad and UnityPluginUnload callbacks won't fire. If you didn't install UnityNativeTool from .unitypackage or it didn't contain the compiled plugin, you'll need to compile it manually. You may also comment out this warning if you don't care about these callbacks.");
                 }
                 finally
                 {

scripts/LowLevelPluginManager.cs

@@ -111,7 +111,7 @@ internal static class PInvokes_Osx
         public static extern int dlclose(IntPtr handle);
     }
 
-    public enum Unix_DlopenFlags : int
+    public enum PosixDlopenFlags : int
     {
         Lazy = 0x00001,
         Now = 0x00002,