Sin descripción
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

AssemblyResolver.cs 10KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318
  1. using System;
  2. using System.IO;
  3. using System.Linq;
  4. using Mono.Cecil;
  5. using Mono.Cecil.Cil;
  6. using Mono.Cecil.Pdb;
  7. namespace zzzUnity.Burst.CodeGen
  8. {
  9. /// <summary>
  10. /// Provides an assembly resolver with deferred loading and a custom metadata resolver.
  11. /// </summary>
  12. /// <remarks>
  13. /// This class is not thread safe. It needs to be protected outside.
  14. /// </remarks>
  15. #if BURST_COMPILER_SHARED
  16. public
  17. #else
  18. internal
  19. #endif
  20. class AssemblyResolver : BaseAssemblyResolver
  21. {
  22. private readonly ReadingMode _readingMode;
  23. public AssemblyResolver(ReadingMode readingMode = ReadingMode.Deferred)
  24. {
  25. _readingMode = readingMode;
  26. // We remove all setup by Cecil by default (it adds '.' and 'bin')
  27. ClearSearchDirectories();
  28. LoadDebugSymbols = false; // We don't bother loading the symbols by default now, since we use SRM to handle symbols in a more thread safe manner
  29. // this is to maintain compatibility with the patch-assemblies path (see BclApp.cs), used by dots runtime
  30. }
  31. public bool LoadDebugSymbols { get; set; }
  32. protected void ClearSearchDirectories()
  33. {
  34. foreach (var dir in GetSearchDirectories())
  35. {
  36. RemoveSearchDirectory(dir);
  37. }
  38. }
  39. public AssemblyDefinition LoadFromFile(string path)
  40. {
  41. return AssemblyDefinition.ReadAssembly(path, CreateReaderParameters());
  42. }
  43. public AssemblyDefinition LoadFromStream(Stream peStream, Stream pdbStream = null, ISymbolReaderProvider customSymbolReader=null)
  44. {
  45. peStream.Position = 0;
  46. if (pdbStream != null)
  47. {
  48. pdbStream.Position = 0;
  49. }
  50. var readerParameters = CreateReaderParameters();
  51. if (customSymbolReader != null)
  52. {
  53. readerParameters.ReadSymbols = true;
  54. readerParameters.SymbolReaderProvider = customSymbolReader;
  55. }
  56. try
  57. {
  58. readerParameters.SymbolStream = pdbStream;
  59. return AssemblyDefinition.ReadAssembly(peStream, readerParameters);
  60. }
  61. catch
  62. {
  63. readerParameters.ReadSymbols = false;
  64. readerParameters.SymbolStream = null;
  65. peStream.Position = 0;
  66. if (pdbStream != null)
  67. {
  68. pdbStream.Position = 0;
  69. }
  70. return AssemblyDefinition.ReadAssembly(peStream, readerParameters);
  71. }
  72. }
  73. public override AssemblyDefinition Resolve(AssemblyNameReference name)
  74. {
  75. var readerParameters = CreateReaderParameters();
  76. AssemblyDefinition assemblyDefinition;
  77. try
  78. {
  79. assemblyDefinition = Resolve(name, readerParameters);
  80. }
  81. catch (Exception ex)
  82. {
  83. if (readerParameters.ReadSymbols == true)
  84. {
  85. // Attempt to load without symbols
  86. readerParameters.ReadSymbols = false;
  87. assemblyDefinition = Resolve(name, readerParameters);
  88. }
  89. else
  90. {
  91. throw new AssemblyResolutionException(
  92. name,
  93. new Exception($"Failed to resolve assembly '{name}' in directories: {string.Join(Environment.NewLine, GetSearchDirectories())}", ex));
  94. }
  95. }
  96. return assemblyDefinition;
  97. }
  98. public bool TryResolve(AssemblyNameReference name, out AssemblyDefinition assembly)
  99. {
  100. try
  101. {
  102. assembly = Resolve(name);
  103. return true;
  104. }
  105. catch (AssemblyResolutionException)
  106. {
  107. assembly = null;
  108. return false;
  109. }
  110. }
  111. public new void AddSearchDirectory(string directory)
  112. {
  113. if (!GetSearchDirectories().Contains(directory))
  114. {
  115. base.AddSearchDirectory(directory);
  116. }
  117. }
  118. private ReaderParameters CreateReaderParameters()
  119. {
  120. var readerParams = new ReaderParameters
  121. {
  122. InMemory = true,
  123. AssemblyResolver = this,
  124. MetadataResolver = new CustomMetadataResolver(this),
  125. ReadSymbols = LoadDebugSymbols // We no longer use cecil to read symbol information, prefering SRM thread safe methods, so I`m being explicit here in case the default changes
  126. };
  127. if (LoadDebugSymbols)
  128. {
  129. readerParams.SymbolReaderProvider = new CustomSymbolReaderProvider(null);
  130. }
  131. readerParams.ReadingMode = _readingMode;
  132. return readerParams;
  133. }
  134. internal static string NormalizeFilePath(string path)
  135. {
  136. try
  137. {
  138. return Path.GetFullPath(new Uri(path).LocalPath).TrimEnd(Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar);
  139. }
  140. catch (Exception ex)
  141. {
  142. throw new Exception($"Could not normalize file path: {path}", ex);
  143. }
  144. }
  145. private class CustomMetadataResolver : MetadataResolver
  146. {
  147. public CustomMetadataResolver(IAssemblyResolver assemblyResolver) : base(assemblyResolver)
  148. {
  149. }
  150. public override MethodDefinition Resolve(MethodReference method)
  151. {
  152. if (method is MethodDefinition methodDef)
  153. {
  154. return methodDef;
  155. }
  156. if (method.GetElementMethod() is MethodDefinition methodDef2)
  157. {
  158. return methodDef2;
  159. }
  160. return base.Resolve(method);
  161. }
  162. }
  163. /// <summary>
  164. /// Custom implementation of <see cref="ISymbolReaderProvider"/> to:
  165. /// - to load pdb/mdb through a MemoryStream to avoid locking the file on the disk
  166. /// - catch any exceptions while loading the symbols and report them back
  167. /// </summary>
  168. private class CustomSymbolReaderProvider : ISymbolReaderProvider
  169. {
  170. private readonly Action<string, Exception> _logException;
  171. public CustomSymbolReaderProvider(Action<string, Exception> logException)
  172. {
  173. _logException = logException;
  174. }
  175. public ISymbolReader GetSymbolReader(ModuleDefinition module, string fileName)
  176. {
  177. if (string.IsNullOrWhiteSpace(fileName)) return null;
  178. string pdbFileName = fileName;
  179. try
  180. {
  181. fileName = NormalizeFilePath(fileName);
  182. pdbFileName = GetPdbFileName(fileName);
  183. if (File.Exists(pdbFileName))
  184. {
  185. var pdbStream = ReadToMemoryStream(pdbFileName);
  186. if (IsPortablePdb(pdbStream))
  187. return new SafeDebugReaderProvider(new PortablePdbReaderProvider().GetSymbolReader(module, pdbStream));
  188. return new SafeDebugReaderProvider(new NativePdbReaderProvider().GetSymbolReader(module, pdbStream));
  189. }
  190. }
  191. catch (Exception ex) when (_logException != null)
  192. {
  193. _logException?.Invoke($"Unable to load symbol `{pdbFileName}`", ex);
  194. return null;
  195. }
  196. return null;
  197. }
  198. private static MemoryStream ReadToMemoryStream(string filename)
  199. {
  200. return new MemoryStream(File.ReadAllBytes(filename));
  201. }
  202. public ISymbolReader GetSymbolReader(ModuleDefinition module, Stream symbolStream)
  203. {
  204. throw new NotSupportedException();
  205. }
  206. private static string GetPdbFileName(string assemblyFileName)
  207. {
  208. return Path.ChangeExtension(assemblyFileName, ".pdb");
  209. }
  210. private static bool IsPortablePdb(Stream stream)
  211. {
  212. if (stream.Length < 4L)
  213. return false;
  214. long position = stream.Position;
  215. try
  216. {
  217. return (int)new BinaryReader(stream).ReadUInt32() == 1112167234;
  218. }
  219. finally
  220. {
  221. stream.Position = position;
  222. }
  223. }
  224. /// <summary>
  225. /// This class is a wrapper around <see cref="ISymbolReader"/> to protect
  226. /// against failure while trying to read debug information in Mono.Cecil
  227. /// </summary>
  228. private class SafeDebugReaderProvider : ISymbolReader
  229. {
  230. private readonly ISymbolReader _reader;
  231. public SafeDebugReaderProvider(ISymbolReader reader)
  232. {
  233. _reader = reader;
  234. }
  235. public void Dispose()
  236. {
  237. try
  238. {
  239. _reader.Dispose();
  240. }
  241. catch
  242. {
  243. // ignored
  244. }
  245. }
  246. public ISymbolWriterProvider GetWriterProvider()
  247. {
  248. // We are not protecting here as we are not suppose to write to PDBs
  249. return _reader.GetWriterProvider();
  250. }
  251. public bool ProcessDebugHeader(ImageDebugHeader header)
  252. {
  253. try
  254. {
  255. return _reader.ProcessDebugHeader(header);
  256. }
  257. catch
  258. {
  259. // ignored
  260. }
  261. return false;
  262. }
  263. public MethodDebugInformation Read(MethodDefinition method)
  264. {
  265. try
  266. {
  267. return _reader.Read(method);
  268. }
  269. catch
  270. {
  271. // ignored
  272. }
  273. return null;
  274. }
  275. }
  276. }
  277. }
  278. }