ModuleDefinition.cs 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755
  1. //
  2. // ModuleDefinition.cs
  3. //
  4. // Author:
  5. // Jb Evain (jbevain@gmail.com)
  6. //
  7. // Copyright (c) 2008 - 2011 Jb Evain
  8. //
  9. // Permission is hereby granted, free of charge, to any person obtaining
  10. // a copy of this software and associated documentation files (the
  11. // "Software"), to deal in the Software without restriction, including
  12. // without limitation the rights to use, copy, modify, merge, publish,
  13. // distribute, sublicense, and/or sell copies of the Software, and to
  14. // permit persons to whom the Software is furnished to do so, subject to
  15. // the following conditions:
  16. //
  17. // The above copyright notice and this permission notice shall be
  18. // included in all copies or substantial portions of the Software.
  19. //
  20. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21. // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22. // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23. // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  24. // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  25. // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  26. // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  27. //
  28. using System;
  29. using System.Collections.Generic;
  30. using System.IO;
  31. using System.Threading;
  32. using SR = System.Reflection;
  33. using Mono.Cecil.Cil;
  34. using Mono.Cecil.Metadata;
  35. using Mono.Cecil.PE;
  36. using Mono.Collections.Generic;
  37. namespace Mono.Cecil
  38. {
  39. public enum ReadingMode
  40. {
  41. Immediate = 1,
  42. Deferred = 2,
  43. }
  44. public sealed class ReaderParameters
  45. {
  46. ReadingMode reading_mode;
  47. IAssemblyResolver assembly_resolver;
  48. IMetadataResolver metadata_resolver;
  49. Stream symbol_stream;
  50. ISymbolReaderProvider symbol_reader_provider;
  51. bool read_symbols;
  52. public ReadingMode ReadingMode
  53. {
  54. get { return reading_mode; }
  55. set { reading_mode = value; }
  56. }
  57. public IAssemblyResolver AssemblyResolver
  58. {
  59. get { return assembly_resolver; }
  60. set { assembly_resolver = value; }
  61. }
  62. public IMetadataResolver MetadataResolver
  63. {
  64. get { return metadata_resolver; }
  65. set { metadata_resolver = value; }
  66. }
  67. public Stream SymbolStream
  68. {
  69. get { return symbol_stream; }
  70. set { symbol_stream = value; }
  71. }
  72. public ISymbolReaderProvider SymbolReaderProvider
  73. {
  74. get { return symbol_reader_provider; }
  75. set { symbol_reader_provider = value; }
  76. }
  77. public bool ReadSymbols
  78. {
  79. get { return read_symbols; }
  80. set { read_symbols = value; }
  81. }
  82. public ReaderParameters()
  83. : this(ReadingMode.Deferred)
  84. {
  85. }
  86. public ReaderParameters(ReadingMode readingMode)
  87. {
  88. this.reading_mode = readingMode;
  89. }
  90. }
  91. public sealed class ModuleDefinition : ModuleReference, ICustomAttributeProvider
  92. {
  93. internal Image Image;
  94. internal MetadataSystem MetadataSystem;
  95. internal ReadingMode ReadingMode;
  96. internal ISymbolReaderProvider SymbolReaderProvider;
  97. internal ISymbolReader symbol_reader;
  98. internal IAssemblyResolver assembly_resolver;
  99. internal IMetadataResolver metadata_resolver;
  100. internal TypeSystem type_system;
  101. readonly MetadataReader reader;
  102. readonly string fq_name;
  103. internal ModuleKind kind;
  104. TargetRuntime runtime;
  105. TargetArchitecture architecture;
  106. ModuleAttributes attributes;
  107. ModuleCharacteristics characteristics;
  108. Guid mvid;
  109. internal AssemblyDefinition assembly;
  110. MethodDefinition entry_point;
  111. Collection<CustomAttribute> custom_attributes;
  112. Collection<AssemblyNameReference> references;
  113. Collection<ModuleReference> modules;
  114. Collection<Resource> resources;
  115. Collection<ExportedType> exported_types;
  116. TypeDefinitionCollection types;
  117. public bool IsMain
  118. {
  119. get { return kind != ModuleKind.NetModule; }
  120. }
  121. public ModuleKind Kind
  122. {
  123. get { return kind; }
  124. set { kind = value; }
  125. }
  126. public TargetRuntime Runtime
  127. {
  128. get { return runtime; }
  129. set { runtime = value; }
  130. }
  131. public TargetArchitecture Architecture
  132. {
  133. get { return architecture; }
  134. set { architecture = value; }
  135. }
  136. public ModuleAttributes Attributes
  137. {
  138. get { return attributes; }
  139. set { attributes = value; }
  140. }
  141. public ModuleCharacteristics Characteristics
  142. {
  143. get { return characteristics; }
  144. set { characteristics = value; }
  145. }
  146. public string FullyQualifiedName
  147. {
  148. get { return fq_name; }
  149. }
  150. public Guid Mvid
  151. {
  152. get { return mvid; }
  153. set { mvid = value; }
  154. }
  155. internal bool HasImage
  156. {
  157. get { return Image != null; }
  158. }
  159. public bool HasSymbols
  160. {
  161. get { return symbol_reader != null; }
  162. }
  163. public ISymbolReader SymbolReader
  164. {
  165. get { return symbol_reader; }
  166. }
  167. public override MetadataScopeType MetadataScopeType
  168. {
  169. get { return MetadataScopeType.ModuleDefinition; }
  170. }
  171. public AssemblyDefinition Assembly
  172. {
  173. get { return assembly; }
  174. }
  175. public IAssemblyResolver AssemblyResolver
  176. {
  177. get { return assembly_resolver ?? (assembly_resolver = new DefaultAssemblyResolver()); }
  178. }
  179. public IMetadataResolver MetadataResolver
  180. {
  181. get
  182. {
  183. if (metadata_resolver == null)
  184. metadata_resolver=new MetadataResolver(this.AssemblyResolver);
  185. return metadata_resolver;
  186. }
  187. }
  188. public TypeSystem TypeSystem
  189. {
  190. get
  191. {
  192. if (type_system == null)
  193. type_system = TypeSystem.CreateTypeSystem(this);
  194. return type_system;
  195. }
  196. }
  197. public bool HasAssemblyReferences
  198. {
  199. get
  200. {
  201. if (references != null)
  202. return references.Count > 0;
  203. return HasImage && Image.HasTable(Table.AssemblyRef);
  204. }
  205. }
  206. public Collection<AssemblyNameReference> AssemblyReferences
  207. {
  208. get
  209. {
  210. if (references != null)
  211. return references;
  212. if (HasImage)
  213. return Read(ref references, this, (_, reader) => reader.ReadAssemblyReferences());
  214. return references = new Collection<AssemblyNameReference>();
  215. }
  216. }
  217. public bool HasModuleReferences
  218. {
  219. get
  220. {
  221. if (modules != null)
  222. return modules.Count > 0;
  223. return HasImage && Image.HasTable(Table.ModuleRef);
  224. }
  225. }
  226. public Collection<ModuleReference> ModuleReferences
  227. {
  228. get
  229. {
  230. if (modules != null)
  231. return modules;
  232. if (HasImage)
  233. return Read(ref modules, this, (_, reader) => reader.ReadModuleReferences());
  234. return modules = new Collection<ModuleReference>();
  235. }
  236. }
  237. public bool HasResources
  238. {
  239. get
  240. {
  241. if (resources != null)
  242. return resources.Count > 0;
  243. if (HasImage)
  244. return Image.HasTable(Table.ManifestResource) || Read(this, (_, reader) => reader.HasFileResource());
  245. return false;
  246. }
  247. }
  248. public Collection<Resource> Resources
  249. {
  250. get
  251. {
  252. if (resources != null)
  253. return resources;
  254. if (HasImage)
  255. return Read(ref resources, this, (_, reader) => reader.ReadResources());
  256. return resources = new Collection<Resource>();
  257. }
  258. }
  259. public bool HasCustomAttributes
  260. {
  261. get
  262. {
  263. if (custom_attributes != null)
  264. return custom_attributes.Count > 0;
  265. return Mixin.GetHasCustomAttributes(this, this);
  266. }
  267. }
  268. public Collection<CustomAttribute> CustomAttributes
  269. {
  270. get { return custom_attributes ?? (Mixin.GetCustomAttributes(this, ref custom_attributes, this)); }
  271. }
  272. public bool HasTypes
  273. {
  274. get
  275. {
  276. if (types != null)
  277. return types.Count > 0;
  278. return HasImage && Image.HasTable(Table.TypeDef);
  279. }
  280. }
  281. public Collection<TypeDefinition> Types
  282. {
  283. get
  284. {
  285. if (types != null)
  286. return types;
  287. if (HasImage)
  288. return Read(ref types, this, (_, reader) => reader.ReadTypes());
  289. return types = new TypeDefinitionCollection(this);
  290. }
  291. }
  292. public bool HasExportedTypes
  293. {
  294. get
  295. {
  296. if (exported_types != null)
  297. return exported_types.Count > 0;
  298. return HasImage && Image.HasTable(Table.ExportedType);
  299. }
  300. }
  301. public Collection<ExportedType> ExportedTypes
  302. {
  303. get
  304. {
  305. if (exported_types != null)
  306. return exported_types;
  307. if (HasImage)
  308. return Read(ref exported_types, this, (_, reader) => reader.ReadExportedTypes());
  309. return exported_types = new Collection<ExportedType>();
  310. }
  311. }
  312. public MethodDefinition EntryPoint
  313. {
  314. get
  315. {
  316. if (entry_point != null)
  317. return entry_point;
  318. if (HasImage)
  319. return Read(ref entry_point, this, (_, reader) => reader.ReadEntryPoint());
  320. return entry_point = null;
  321. }
  322. set { entry_point = value; }
  323. }
  324. internal ModuleDefinition()
  325. {
  326. this.MetadataSystem = new MetadataSystem();
  327. this.token = new MetadataToken(TokenType.Module, 1);
  328. }
  329. internal ModuleDefinition(Image image)
  330. : this()
  331. {
  332. this.Image = image;
  333. this.kind = image.Kind;
  334. this.runtime = image.Runtime;
  335. this.architecture = image.Architecture;
  336. this.attributes = image.Attributes;
  337. this.characteristics = image.Characteristics;
  338. this.fq_name = image.FileName;
  339. this.reader = new MetadataReader(this);
  340. }
  341. public bool HasTypeReference(string fullName)
  342. {
  343. return HasTypeReference(string.Empty, fullName);
  344. }
  345. public bool HasTypeReference(string scope, string fullName)
  346. {
  347. CheckFullName(fullName);
  348. if (!HasImage)
  349. return false;
  350. return GetTypeReference(scope, fullName) != null;
  351. }
  352. public bool TryGetTypeReference(string fullName, out TypeReference type)
  353. {
  354. return TryGetTypeReference(string.Empty, fullName, out type);
  355. }
  356. public bool TryGetTypeReference(string scope, string fullName, out TypeReference type)
  357. {
  358. CheckFullName(fullName);
  359. if (!HasImage)
  360. {
  361. type = null;
  362. return false;
  363. }
  364. return (type = GetTypeReference(scope, fullName)) != null;
  365. }
  366. TypeReference GetTypeReference(string scope, string fullname)
  367. {
  368. return Read(new Row<string, string>(scope, fullname), (row, reader) => reader.GetTypeReference(row.Col1, row.Col2));
  369. }
  370. public IEnumerable<TypeReference> GetTypeReferences()
  371. {
  372. if (!HasImage)
  373. return Empty<TypeReference>.Array;
  374. return Read(this, (_, reader) => reader.GetTypeReferences());
  375. }
  376. public IEnumerable<MemberReference> GetMemberReferences()
  377. {
  378. if (!HasImage)
  379. return Empty<MemberReference>.Array;
  380. return Read(this, (_, reader) => reader.GetMemberReferences());
  381. }
  382. public TypeReference GetType(string fullName, bool runtimeName)
  383. {
  384. return runtimeName
  385. ? TypeParser.ParseType(this, fullName)
  386. : GetType(fullName);
  387. }
  388. public TypeDefinition GetType(string fullName)
  389. {
  390. CheckFullName(fullName);
  391. var position = fullName.IndexOf('/');
  392. if (position > 0)
  393. return GetNestedType(fullName);
  394. return ((TypeDefinitionCollection)this.Types).GetType(fullName);
  395. }
  396. public TypeDefinition GetType(string @namespace, string name)
  397. {
  398. Mixin.CheckName(name);
  399. return ((TypeDefinitionCollection)this.Types).GetType(@namespace ?? string.Empty, name);
  400. }
  401. public IEnumerable<TypeDefinition> GetTypes()
  402. {
  403. return GetTypes(Types);
  404. }
  405. static IEnumerable<TypeDefinition> GetTypes(Collection<TypeDefinition> types)
  406. {
  407. for (int i = 0; i < types.Count; i++)
  408. {
  409. var type = types[i];
  410. yield return type;
  411. if (!type.HasNestedTypes)
  412. continue;
  413. foreach (var nested in GetTypes(type.NestedTypes))
  414. yield return nested;
  415. }
  416. }
  417. static void CheckFullName(string fullName)
  418. {
  419. if (fullName == null)
  420. throw new ArgumentNullException("fullName");
  421. if (fullName.Length == 0)
  422. throw new ArgumentException();
  423. }
  424. TypeDefinition GetNestedType(string fullname)
  425. {
  426. var names = fullname.Split('/');
  427. var type = GetType(names[0]);
  428. if (type == null)
  429. return null;
  430. for (int i = 1; i < names.Length; i++)
  431. {
  432. var nested_type = Mixin.GetNestedType(type, names[i]);
  433. if (nested_type == null)
  434. return null;
  435. type = nested_type;
  436. }
  437. return type;
  438. }
  439. internal FieldDefinition Resolve(FieldReference field)
  440. {
  441. return MetadataResolver.Resolve(field);
  442. }
  443. internal MethodDefinition Resolve(MethodReference method)
  444. {
  445. return MetadataResolver.Resolve(method);
  446. }
  447. internal TypeDefinition Resolve(TypeReference type)
  448. {
  449. return MetadataResolver.Resolve(type);
  450. }
  451. public IMetadataTokenProvider LookupToken(int token)
  452. {
  453. return LookupToken(new MetadataToken((uint)token));
  454. }
  455. public IMetadataTokenProvider LookupToken(MetadataToken token)
  456. {
  457. return Read(token, (t, reader) => reader.LookupToken(t));
  458. }
  459. readonly object module_lock = new object();
  460. internal object SyncRoot
  461. {
  462. get { return module_lock; }
  463. }
  464. internal TRet Read<TItem, TRet>(TItem item, Func<TItem, MetadataReader, TRet> read)
  465. {
  466. lock (module_lock)
  467. {
  468. var position = reader.position;
  469. var context = reader.context;
  470. var ret = read(item, reader);
  471. reader.position = position;
  472. reader.context = context;
  473. return ret;
  474. }
  475. }
  476. internal TRet Read<TItem, TRet>(ref TRet variable, TItem item, Func<TItem, MetadataReader, TRet> read) where TRet : class
  477. {
  478. lock (module_lock)
  479. {
  480. if (variable != null)
  481. return variable;
  482. var position = reader.position;
  483. var context = reader.context;
  484. var ret = read(item, reader);
  485. reader.position = position;
  486. reader.context = context;
  487. return variable = ret;
  488. }
  489. }
  490. public bool HasDebugHeader
  491. {
  492. get { return Image != null && !Image.Debug.IsZero; }
  493. }
  494. public ImageDebugDirectory GetDebugHeader(out byte[] header)
  495. {
  496. if (!HasDebugHeader)
  497. throw new InvalidOperationException();
  498. return Image.GetDebugHeader(out header);
  499. }
  500. void ProcessDebugHeader()
  501. {
  502. if (!HasDebugHeader)
  503. return;
  504. byte[] header;
  505. var directory = GetDebugHeader(out header);
  506. if (!symbol_reader.ProcessDebugHeader(directory, header))
  507. throw new InvalidOperationException();
  508. }
  509. public void ReadSymbols()
  510. {
  511. if (string.IsNullOrEmpty(fq_name))
  512. throw new InvalidOperationException();
  513. var provider = SymbolProvider.GetPlatformReaderProvider();
  514. if (provider == null)
  515. throw new InvalidOperationException();
  516. ReadSymbols(provider.GetSymbolReader(this, fq_name));
  517. }
  518. public void ReadSymbols(ISymbolReader reader)
  519. {
  520. if (reader == null)
  521. throw new ArgumentNullException("reader");
  522. symbol_reader = reader;
  523. ProcessDebugHeader();
  524. }
  525. public static ModuleDefinition ReadModule(string fileName)
  526. {
  527. return ReadModule(fileName, new ReaderParameters(ReadingMode.Deferred));
  528. }
  529. public static ModuleDefinition ReadModule(Stream stream)
  530. {
  531. return ReadModule(stream, new ReaderParameters(ReadingMode.Deferred));
  532. }
  533. public static ModuleDefinition ReadModule(string fileName, ReaderParameters parameters)
  534. {
  535. using (var stream = GetFileStream(fileName, FileMode.Open, FileAccess.Read, FileShare.Read))
  536. {
  537. return ReadModule(stream, parameters);
  538. }
  539. }
  540. static void CheckStream(object stream)
  541. {
  542. if (stream == null)
  543. throw new ArgumentNullException("stream");
  544. }
  545. public static ModuleDefinition ReadModule(Stream stream, ReaderParameters parameters)
  546. {
  547. CheckStream(stream);
  548. if (!stream.CanRead || !stream.CanSeek)
  549. throw new ArgumentException();
  550. Mixin.CheckParameters(parameters);
  551. return ModuleReader.CreateModuleFrom(
  552. ImageReader.ReadImageFrom(stream),
  553. parameters);
  554. }
  555. static Stream GetFileStream(string fileName, FileMode mode, FileAccess access, FileShare share)
  556. {
  557. if (fileName == null)
  558. throw new ArgumentNullException("fileName");
  559. if (fileName.Length == 0)
  560. throw new ArgumentException();
  561. return new FileStream(fileName, mode, access, share);
  562. }
  563. }
  564. static partial class Mixin
  565. {
  566. public static void CheckParameters(object parameters)
  567. {
  568. if (parameters == null)
  569. throw new ArgumentNullException("parameters");
  570. }
  571. public static bool HasImage(ModuleDefinition self)
  572. {
  573. return self != null && self.HasImage;
  574. }
  575. public static bool IsCorlib(ModuleDefinition module)
  576. {
  577. if (module.Assembly == null)
  578. return false;
  579. return module.Assembly.Name.Name == "mscorlib";
  580. }
  581. public static string GetFullyQualifiedName(Stream self)
  582. {
  583. return string.Empty;
  584. }
  585. public static TargetRuntime ParseRuntime(string self)
  586. {
  587. switch (self[1])
  588. {
  589. case '1':
  590. return self[3] == '0'
  591. ? TargetRuntime.Net_1_0
  592. : TargetRuntime.Net_1_1;
  593. case '2':
  594. return TargetRuntime.Net_2_0;
  595. case '4':
  596. default:
  597. return TargetRuntime.Net_4_0;
  598. }
  599. }
  600. }
  601. }