123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303 |
- using System;
- using System.Collections.Generic;
- using System.Diagnostics;
- using System.IO;
- using System.Linq;
- using System.Reflection;
- using BepInEx.Bootstrap;
- using BepInEx.Configuration;
- using BepInEx.Logging;
- using BepInEx.Preloader.RuntimeFixes;
- using Mono.Cecil;
- namespace BepInEx.Preloader.Patching
- {
- /// <summary>
- /// Delegate used in patching assemblies.
- /// </summary>
- /// <param name="assembly">The assembly that is being patched.</param>
- internal delegate void AssemblyPatcherDelegate(ref AssemblyDefinition assembly);
- /// <summary>
- /// Worker class which is used for loading and patching entire folders of assemblies, or alternatively patching and
- /// loading assemblies one at a time.
- /// </summary>
- internal static class AssemblyPatcher
- {
- private const BindingFlags ALL = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static | BindingFlags.IgnoreCase;
- public static List<PatcherPlugin> PatcherPlugins { get; } = new List<PatcherPlugin>();
- private static readonly string DumpedAssembliesPath = Path.Combine(Paths.BepInExRootPath, "DumpedAssemblies");
- /// <summary>
- /// Adds a single assembly patcher to the pool of applicable patches.
- /// </summary>
- /// <param name="patcher">Patcher to apply.</param>
- public static void AddPatcher(PatcherPlugin patcher)
- {
- PatcherPlugins.Add(patcher);
- }
- private static T CreateDelegate<T>(MethodInfo method) where T : class => method != null ? Delegate.CreateDelegate(typeof(T), method) as T : null;
- private static PatcherPlugin ToPatcherPlugin(TypeDefinition type)
- {
- if (type.IsInterface || type.IsAbstract && !type.IsSealed)
- return null;
- var targetDlls = type.Methods.FirstOrDefault(m => m.Name.Equals("get_TargetDLLs", StringComparison.InvariantCultureIgnoreCase) &&
- m.IsPublic &&
- m.IsStatic);
- if (targetDlls == null ||
- targetDlls.ReturnType.FullName != "System.Collections.Generic.IEnumerable`1<System.String>")
- return null;
- var patch = type.Methods.FirstOrDefault(m => m.Name.Equals("Patch") &&
- m.IsPublic &&
- m.IsStatic &&
- m.ReturnType.FullName == "System.Void" &&
- m.Parameters.Count == 1 &&
- (m.Parameters[0].ParameterType.FullName == "Mono.Cecil.AssemblyDefinition&" ||
- m.Parameters[0].ParameterType.FullName == "Mono.Cecil.AssemblyDefinition"));
- if (patch == null)
- return null;
- return new PatcherPlugin
- {
- TypeName = type.FullName
- };
- }
- /// <summary>
- /// Adds all patchers from all managed assemblies specified in a directory.
- /// </summary>
- /// <param name="directory">Directory to search patcher DLLs from.</param>
- /// <param name="patcherLocator">A function that locates assembly patchers in a given managed assembly.</param>
- public static void AddPatchersFromDirectory(string directory)
- {
- if (!Directory.Exists(directory))
- return;
- var sortedPatchers = new SortedDictionary<string, PatcherPlugin>();
- var patchers = TypeLoader.FindPluginTypes(directory, ToPatcherPlugin);
- foreach (var keyValuePair in patchers)
- {
- var assemblyPath = keyValuePair.Key;
- var patcherCollection = keyValuePair.Value;
- if(patcherCollection.Count == 0)
- continue;
- var ass = Assembly.LoadFile(assemblyPath);
- foreach (var patcherPlugin in patcherCollection)
- {
- try
- {
- var type = ass.GetType(patcherPlugin.TypeName);
- var methods = type.GetMethods(ALL);
- patcherPlugin.Initializer = CreateDelegate<Action>(methods.FirstOrDefault(m => m.Name.Equals("Initialize", StringComparison.InvariantCultureIgnoreCase) &&
- m.GetParameters().Length == 0 &&
- m.ReturnType == typeof(void)));
- patcherPlugin.Finalizer = CreateDelegate<Action>(methods.FirstOrDefault(m => m.Name.Equals("Finish", StringComparison.InvariantCultureIgnoreCase) &&
- m.GetParameters().Length == 0 &&
- m.ReturnType == typeof(void)));
- patcherPlugin.TargetDLLs = CreateDelegate<Func<IEnumerable<string>>>(type.GetProperty("TargetDLLs", ALL).GetGetMethod());
- var patcher = methods.FirstOrDefault(m => m.Name.Equals("Patch", StringComparison.CurrentCultureIgnoreCase) &&
- m.ReturnType == typeof(void) &&
- m.GetParameters().Length == 1 &&
- (m.GetParameters()[0].ParameterType == typeof(AssemblyDefinition) ||
- m.GetParameters()[0].ParameterType == typeof(AssemblyDefinition).MakeByRefType()));
- patcherPlugin.Patcher = (ref AssemblyDefinition pAss) =>
- {
- //we do the array fuckery here to get the ref result out
- object[] args = { pAss };
- patcher.Invoke(null, args);
- pAss = (AssemblyDefinition)args[0];
- };
- sortedPatchers.Add($"{ass.GetName().Name}/{type.FullName}", patcherPlugin);
- }
- catch (Exception e)
- {
- Logger.LogError($"Failed to load patcher [{patcherPlugin.TypeName}]: {e.Message}");
- if (e is ReflectionTypeLoadException re)
- Logger.LogDebug(TypeLoader.TypeLoadExceptionToString(re));
- else
- Logger.LogDebug(e.ToString());
- }
- }
- Logger.Log(patcherCollection.Any() ? LogLevel.Info : LogLevel.Debug,
- $"Loaded {patcherCollection.Count} patcher methods from {ass.GetName().FullName}");
- }
- foreach (KeyValuePair<string, PatcherPlugin> patcher in sortedPatchers)
- AddPatcher(patcher.Value);
- }
- private static void InitializePatchers()
- {
- foreach (var assemblyPatcher in PatcherPlugins)
- assemblyPatcher.Initializer?.Invoke();
- }
- private static void FinalizePatching()
- {
- foreach (var assemblyPatcher in PatcherPlugins)
- assemblyPatcher.Finalizer?.Invoke();
- }
- /// <summary>
- /// Releases all patchers to let them be collected by GC.
- /// </summary>
- public static void DisposePatchers()
- {
- PatcherPlugins.Clear();
- }
- /// <summary>
- /// Applies patchers to all assemblies in the given directory and loads patched assemblies into memory.
- /// </summary>
- /// <param name="directory">Directory to load CLR assemblies from.</param>
- public static void PatchAndLoad(string directory)
- {
- // First, load patchable assemblies into Cecil
- var assemblies = new Dictionary<string, AssemblyDefinition>();
- foreach (string assemblyPath in Directory.GetFiles(directory, "*.dll"))
- {
- var assembly = AssemblyDefinition.ReadAssembly(assemblyPath);
- //NOTE: this is special cased here because the dependency handling for System.dll is a bit wonky
- //System has an assembly reference to itself, and it also has a reference to Mono.Security causing a circular dependency
- //It's also generally dangerous to change system.dll since so many things rely on it,
- // and it's already loaded into the appdomain since this loader references it, so we might as well skip it
- if (assembly.Name.Name == "System" || assembly.Name.Name == "mscorlib") //mscorlib is already loaded into the appdomain so it can't be patched
- {
- assembly.Dispose();
- continue;
- }
- if (UnityPatches.AssemblyLocations.ContainsKey(assembly.FullName))
- {
- Logger.LogWarning($"Tried to load duplicate assembly {Path.GetFileName(assemblyPath)} from Managed folder! Skipping...");
- continue;
- }
- assemblies.Add(Path.GetFileName(assemblyPath), assembly);
- UnityPatches.AssemblyLocations.Add(assembly.FullName, Path.GetFullPath(assemblyPath));
- }
- // Next, initialize all the patchers
- InitializePatchers();
- // Then, perform the actual patching
- var patchedAssemblies = new HashSet<string>();
- foreach (var assemblyPatcher in PatcherPlugins)
- foreach (string targetDll in assemblyPatcher.TargetDLLs())
- if (assemblies.TryGetValue(targetDll, out var assembly))
- {
- if (AppDomain.CurrentDomain.GetAssemblies().Any(x => x.GetName().Name == assembly.Name.Name))
- Logger.LogWarning($"Trying to patch an already loaded assembly [{assembly.Name.Name}] with [{assemblyPatcher.TypeName}]");
- Logger.LogInfo($"Patching [{assembly.Name.Name}] with [{assemblyPatcher.TypeName}]");
- assemblyPatcher.Patcher?.Invoke(ref assembly);
- assemblies[targetDll] = assembly;
- patchedAssemblies.Add(targetDll);
- }
- // Finally, load patched assemblies into memory
- if (ConfigDumpAssemblies.Value || ConfigLoadDumpedAssemblies.Value)
- {
- if (!Directory.Exists(DumpedAssembliesPath))
- Directory.CreateDirectory(DumpedAssembliesPath);
- foreach (KeyValuePair<string, AssemblyDefinition> kv in assemblies)
- {
- string filename = kv.Key;
- var assembly = kv.Value;
- if (patchedAssemblies.Contains(filename))
- assembly.Write(Path.Combine(DumpedAssembliesPath, filename));
- }
- }
- if (ConfigBreakBeforeLoadAssemblies.Value)
- {
- Logger.LogInfo($"BepInEx is about load the following assemblies:\n{String.Join("\n", patchedAssemblies.ToArray())}");
- Logger.LogInfo($"The assemblies were dumped into {DumpedAssembliesPath}");
- Logger.LogInfo("Load any assemblies into the debugger, set breakpoints and continue execution.");
- Debugger.Break();
- }
- foreach (var kv in assemblies)
- {
- string filename = kv.Key;
- var assembly = kv.Value;
- // Note that since we only *load* assemblies, they shouldn't trigger dependency loading
- // Not loading all assemblies is very important not only because of memory reasons,
- // but because some games *rely* on that because of messed up internal dependencies.
- if (patchedAssemblies.Contains(filename))
- Load(assembly, filename);
- // Though we have to dispose of all assemblies regardless of them being patched or not
- assembly.Dispose();
- }
- //run all finalizers
- FinalizePatching();
- }
- /// <summary>
- /// Loads an individual assembly definition into the CLR.
- /// </summary>
- /// <param name="assembly">The assembly to load.</param>
- public static void Load(AssemblyDefinition assembly, string filename)
- {
- if (ConfigLoadDumpedAssemblies.Value)
- Assembly.LoadFile(Path.Combine(DumpedAssembliesPath, filename));
- else
- using (var assemblyStream = new MemoryStream())
- {
- assembly.Write(assemblyStream);
- Assembly.Load(assemblyStream.ToArray());
- }
- }
- #region Config
- private static readonly ConfigEntry<bool> ConfigDumpAssemblies = ConfigFile.CoreConfig.Bind(
- "Preloader", "DumpAssemblies",
- false,
- "If enabled, BepInEx will save patched assemblies into BepInEx/DumpedAssemblies.\nThis can be used by developers to inspect and debug preloader patchers.");
- private static readonly ConfigEntry<bool> ConfigLoadDumpedAssemblies = ConfigFile.CoreConfig.Bind(
- "Preloader", "LoadDumpedAssemblies",
- false,
- "If enabled, BepInEx will load patched assemblies from BepInEx/DumpedAssemblies instead of memory.\nThis can be used to be able to load patched assemblies into debuggers like dnSpy.\nIf set to true, will override DumpAssemblies.");
- private static readonly ConfigEntry<bool> ConfigBreakBeforeLoadAssemblies = ConfigFile.CoreConfig.Bind(
- "Preloader", "BreakBeforeLoadAssemblies",
- false,
- "If enabled, BepInEx will call Debugger.Break() once before loading patched assemblies.\nThis can be used with debuggers like dnSpy to install breakpoints into patched assemblies before they are loaded.");
- #endregion
- }
- }
|