2 // ikvm.cs: IKVM.Reflection and IKVM.Reflection.Emit specific implementations
4 // Author: Marek Safar (marek.safar@gmail.com)
6 // Dual licensed under the terms of the MIT X11 or GNU GPL
8 // Copyright 2009-2010 Novell, Inc.
9 // Copyright 2011 Xamarin Inc
14 using System.Collections.Generic;
15 using MetaType = IKVM.Reflection.Type;
16 using IKVM.Reflection;
17 using IKVM.Reflection.Emit;
19 using System.Configuration.Assemblies;
24 public class StaticImporter
26 public StaticImporter (BuiltinTypes builtin)
28 throw new NotSupportedException ();
31 public void ImportAssembly (Assembly assembly, RootNamespace targetNamespace)
33 throw new NotSupportedException ();
36 public void ImportModule (Module module, RootNamespace targetNamespace)
38 throw new NotSupportedException ();
41 public TypeSpec ImportType (System.Type type)
43 throw new NotSupportedException ();
49 sealed class StaticImporter : MetadataImporter
51 public StaticImporter (ModuleContainer module)
56 public void AddCompiledAssembly (AssemblyDefinitionStatic assembly)
58 assembly_2_definition.Add (assembly.Builder, assembly);
61 public override void AddCompiledType (TypeBuilder type, TypeSpec spec)
63 compiled_types.Add (type, spec);
66 protected override MemberKind DetermineKindFromBaseType (MetaType baseType)
68 string name = baseType.Name;
70 if (name == "ValueType" && baseType.Namespace == "System")
71 return MemberKind.Struct;
73 if (name == "Enum" && baseType.Namespace == "System")
74 return MemberKind.Enum;
76 if (name == "MulticastDelegate" && baseType.Namespace == "System")
77 return MemberKind.Delegate;
79 return MemberKind.Class;
82 protected override bool HasVolatileModifier (MetaType[] modifiers)
84 foreach (var t in modifiers) {
85 if (t.Name == "IsVolatile" && t.Namespace == CompilerServicesNamespace)
92 public void ImportAssembly (Assembly assembly, RootNamespace targetNamespace)
95 // It can be used more than once when importing same assembly
96 // into 2 or more global aliases
97 // TODO: Should be just Add
98 GetAssemblyDefinition (assembly);
100 var all_types = assembly.GetTypes ();
101 ImportTypes (all_types, targetNamespace, true);
103 all_types = assembly.ManifestModule.__GetExportedTypes ();
104 if (all_types.Length != 0)
105 ImportForwardedTypes (all_types, targetNamespace);
106 } catch (Exception e) {
107 throw new InternalErrorException (e, "Failed to import assembly `{0}'", assembly.FullName);
111 public ImportedModuleDefinition ImportModule (Module module, RootNamespace targetNamespace)
113 var module_definition = new ImportedModuleDefinition (module);
114 module_definition.ReadAttributes ();
116 var all_types = module.GetTypes ();
117 ImportTypes (all_types, targetNamespace, false);
119 return module_definition;
122 void ImportForwardedTypes (MetaType[] types, Namespace targetNamespace)
124 Namespace ns = targetNamespace;
125 string prev_namespace = null;
126 foreach (var t in types) {
127 if (!t.__IsTypeForwarder)
130 // IsMissing tells us the type has been forwarded and target assembly is missing
134 if (t.Name[0] == '<')
137 var it = CreateType (t, null, new AttributesTypeInfoReader (t), true);
141 if (prev_namespace != t.Namespace) {
142 ns = t.Namespace == null ? targetNamespace : targetNamespace.GetNamespace (t.Namespace, true);
143 prev_namespace = t.Namespace;
146 ns.AddType (module, it);
150 public void InitializeBuiltinTypes (BuiltinTypes builtin, Assembly corlib)
153 // Setup mapping for build-in types to avoid duplication of their definition
155 foreach (var type in builtin.AllTypes) {
156 compiled_types.Add (corlib.GetType (type.FullName), type);
162 class AssemblyDefinitionStatic : AssemblyDefinition
164 readonly StaticLoader loader;
167 // Assembly container with file output
169 public AssemblyDefinitionStatic (ModuleContainer module, StaticLoader loader, string name, string fileName)
170 : base (module, name, fileName)
172 this.loader = loader;
173 Importer = loader.MetadataImporter;
177 // Initializes the assembly SRE domain
179 public void Create (Universe domain)
181 ResolveAssemblySecurityAttributes ();
182 var an = CreateAssemblyName ();
184 Builder = domain.DefineDynamicAssembly (an, AssemblyBuilderAccess.Save, Path.GetDirectoryName (file_name));
185 module.Create (this, CreateModuleBuilder ());
188 public override void Emit ()
190 if (loader.Corlib != null && !(loader.Corlib is AssemblyBuilder)) {
191 Builder.__SetImageRuntimeVersion (loader.Corlib.ImageRuntimeVersion, 0x20000);
192 } else if (module.Compiler.Settings.RuntimeMetadataVersion != null) {
193 Builder.__SetImageRuntimeVersion (module.Compiler.Settings.RuntimeMetadataVersion, 0x20000);
195 // Sets output file metadata version when there is no mscorlib
196 switch (module.Compiler.Settings.StdLibRuntimeVersion) {
197 case RuntimeVersion.v4:
198 Builder.__SetImageRuntimeVersion ("v4.0.30319", 0x20000);
200 case RuntimeVersion.v2:
201 Builder.__SetImageRuntimeVersion ("v2.0.50727", 0x20000);
203 case RuntimeVersion.v1:
204 // Compiler does not do any checks whether the produced metadata
205 // are valid in the context of 1.0 stream version
206 Builder.__SetImageRuntimeVersion ("v1.1.4322", 0x10000);
209 throw new NotImplementedException ();
213 builder_extra = new AssemblyBuilderIKVM (Builder, Compiler);
218 public Module IncludeModule (RawModule moduleFile)
220 return Builder.__AddModule (moduleFile);
223 protected override List<AssemblyReferenceMessageInfo> GetNotUnifiedReferences (AssemblyName assemblyName)
225 return loader.GetNotUnifiedReferences (assemblyName);
228 protected override void SaveModule (PortableExecutableKinds pekind, ImageFileMachine machine)
230 module.Builder.__Save (pekind, machine);
234 class StaticLoader : AssemblyReferencesLoader<Assembly>, IDisposable
236 readonly StaticImporter importer;
237 readonly Universe domain;
239 readonly List<Tuple<AssemblyName, string, Assembly>> loaded_names;
240 static readonly Dictionary<string, string[]> sdk_directory;
241 Dictionary<AssemblyName, List<AssemblyReferenceMessageInfo>> resolved_version_mismatches;
242 static readonly TypeName objectTypeName = new TypeName ("System", "Object");
244 static StaticLoader ()
246 sdk_directory = new Dictionary<string, string[]> ();
247 sdk_directory.Add ("2", new string[] { "2.0-api", "v2.0.50727" });
248 sdk_directory.Add ("2.0", new string[] { "2.0-api", "v2.0.50727" });
249 sdk_directory.Add ("4", new string[] { "4.0-api", "v4.0.30319" });
250 sdk_directory.Add ("4.0", new string[] { "4.0-api", "v4.0.30319" });
251 sdk_directory.Add ("4.5", new string[] { "4.5-api", "v4.0.30319" });
252 sdk_directory.Add ("4.5.1", new string[] { "4.5.1-api", "v4.0.30319" });
253 sdk_directory.Add ("4.5.2", new string[] { "4.5.2-api", "v4.0.30319" });
254 sdk_directory.Add ("4.6", new string[] { "4.6-api", "v4.0.30319" });
255 sdk_directory.Add ("4.6.1", new string[] { "4.6.1-api", "v4.0.30319" });
256 sdk_directory.Add ("4.6.2", new string [] { "4.6.2-api", "v4.0.30319" });
257 sdk_directory.Add ("4.7", new string [] { "4.7-api", "v4.0.30319" });
258 sdk_directory.Add ("4.x", new string [] { "4.5", "net_4_x", "v4.0.30319" });
261 public StaticLoader (StaticImporter importer, CompilerContext compiler)
264 this.importer = importer;
265 domain = new Universe (UniverseOptions.MetadataOnly | UniverseOptions.ResolveMissingMembers |
266 UniverseOptions.DisableFusion | UniverseOptions.DecodeVersionInfoAttributeBlobs |
267 UniverseOptions.DeterministicOutput | UniverseOptions.DisableDefaultAssembliesLookup);
269 domain.AssemblyResolve += AssemblyReferenceResolver;
270 loaded_names = new List<Tuple<AssemblyName, string, Assembly>> ();
272 if (compiler.Settings.StdLib) {
273 var corlib_path = Path.GetDirectoryName (typeof (object).Assembly.Location);
274 string fx_path = corlib_path.Substring (0, corlib_path.LastIndexOf (Path.DirectorySeparatorChar));
276 string sdk_path = null;
278 string sdk_version = compiler.Settings.SdkVersion ?? "4.x";
279 string[] sdk_sub_dirs;
281 if (!sdk_directory.TryGetValue (sdk_version, out sdk_sub_dirs))
282 sdk_sub_dirs = new string[] { sdk_version };
284 foreach (var dir in sdk_sub_dirs) {
285 sdk_path = Path.Combine (fx_path, dir);
286 if (File.Exists (Path.Combine (sdk_path, "mscorlib.dll")))
292 if (sdk_path == null) {
293 compiler.Report.Warning (-1, 1, "SDK path could not be resolved");
294 sdk_path = corlib_path;
297 paths.Add (sdk_path);
303 public Assembly Corlib {
309 public AssemblyDefinitionStatic CompiledAssembly { get; set; }
311 public Universe Domain {
317 public StaticImporter MetadataImporter {
325 Assembly AssemblyReferenceResolver (object sender, IKVM.Reflection.ResolveEventArgs args)
327 var refname = args.Name;
328 if (refname == "mscorlib")
331 Assembly version_mismatch = null;
332 bool is_fx_assembly = false;
334 foreach (var assembly in domain.GetAssemblies ()) {
335 AssemblyComparisonResult result;
336 if (!domain.CompareAssemblyIdentity (refname, false, assembly.FullName, false, out result)) {
337 if ((result == AssemblyComparisonResult.NonEquivalentVersion || result == AssemblyComparisonResult.NonEquivalentPartialVersion) &&
338 (version_mismatch == null || version_mismatch.GetName ().Version < assembly.GetName ().Version) &&
340 version_mismatch = assembly;
346 if (result == AssemblyComparisonResult.EquivalentFullMatch ||
347 result == AssemblyComparisonResult.EquivalentWeakNamed ||
348 result == AssemblyComparisonResult.EquivalentPartialMatch) {
352 if (result == AssemblyComparisonResult.EquivalentFXUnified) {
353 is_fx_assembly = true;
355 if (version_mismatch == null || version_mismatch.GetName ().Version < assembly.GetName ().Version)
356 version_mismatch = assembly;
361 throw new NotImplementedException ("Assembly equality = " + result.ToString ());
364 if (version_mismatch != null) {
365 if (is_fx_assembly || version_mismatch is AssemblyBuilder)
366 return version_mismatch;
368 var ref_an = new AssemblyName (refname);
369 var v1 = ref_an.Version;
370 var v2 = version_mismatch.GetName ().Version;
371 AssemblyReferenceMessageInfo messageInfo;
374 messageInfo = new AssemblyReferenceMessageInfo (ref_an, report => {
375 report.SymbolRelatedToPreviousError (args.RequestingAssembly.Location);
376 report.Error (1705, string.Format ("Assembly `{0}' depends on `{1}' which has a higher version number than referenced assembly `{2}'",
377 args.RequestingAssembly.FullName, refname, version_mismatch.GetName ().FullName));
381 messageInfo = new AssemblyReferenceMessageInfo (ref_an, report => {
382 if (v1.Major != v2.Major || v1.Minor != v2.Minor) {
383 report.Warning (1701, 2,
384 "Assuming assembly reference `{0}' matches assembly `{1}'. You may need to supply runtime policy",
385 refname, version_mismatch.GetName ().FullName);
387 report.Warning (1702, 3,
388 "Assuming assembly reference `{0}' matches assembly `{1}'. You may need to supply runtime policy",
389 refname, version_mismatch.GetName ().FullName);
394 AddReferenceVersionMismatch (args.RequestingAssembly.GetName (), messageInfo);
396 return version_mismatch;
400 // Recursive reference to compiled assembly checks name only. Any other
401 // details (PublicKey, Version, etc) are not yet known hence cannot be checked
403 ParsedAssemblyName referenced_assembly;
404 if (Fusion.ParseAssemblyName (args.Name, out referenced_assembly) == ParseAssemblyResult.OK && CompiledAssembly.Name == referenced_assembly.Name)
405 return CompiledAssembly.Builder;
407 // AssemblyReference has not been found in the domain
408 // create missing reference and continue
409 return domain.CreateMissingAssembly (args.Name);
412 void AddReferenceVersionMismatch (AssemblyName an, AssemblyReferenceMessageInfo errorInfo)
414 if (resolved_version_mismatches == null)
415 resolved_version_mismatches = new Dictionary<AssemblyName, List<AssemblyReferenceMessageInfo>> ();
417 List<AssemblyReferenceMessageInfo> names;
418 if (!resolved_version_mismatches.TryGetValue (an, out names)) {
419 names = new List<AssemblyReferenceMessageInfo> ();
420 resolved_version_mismatches.Add (an, names);
423 names.Add (errorInfo);
426 public void Dispose ()
431 protected override string[] GetDefaultReferences ()
434 // For now the "default config" is harcoded into the compiler
435 // we can move this outside later
437 var default_references = new List<string> (4);
439 default_references.Add ("System.dll");
440 default_references.Add ("System.Xml.dll");
441 default_references.Add ("System.Core.dll");
443 if (corlib != null && corlib.GetName ().Version.Major >= 4) {
444 default_references.Add ("Microsoft.CSharp.dll");
447 return default_references.ToArray ();
450 public List<AssemblyReferenceMessageInfo> GetNotUnifiedReferences (AssemblyName assemblyName)
452 List<AssemblyReferenceMessageInfo> list = null;
453 if (resolved_version_mismatches != null)
454 resolved_version_mismatches.TryGetValue (assemblyName, out list);
459 public override Assembly HasObjectType (Assembly assembly)
462 // System.Object can be forwarded and ikvm
463 // transparently finds it in target assembly therefore
464 // need to return actual obj assembly becauase in such
465 // case it's different to assembly parameter
466 var obj = assembly.FindType (objectTypeName);
467 return obj == null ? null : obj.Assembly;
468 } catch (Exception e) {
469 throw new InternalErrorException (e, "Failed to load assembly `{0}'", assembly.FullName);
473 public override Assembly LoadAssemblyFile (string fileName, bool isImplicitReference)
475 bool? has_extension = null;
476 foreach (var path in paths) {
477 var file = Path.Combine (path, fileName);
478 if (compiler.Settings.DebugFlags > 0)
479 Console.WriteLine ("Probing assembly location `{0}'", file);
481 if (!File.Exists (file)) {
482 if (!has_extension.HasValue)
483 has_extension = fileName.EndsWith (".dll", StringComparison.Ordinal) || fileName.EndsWith (".exe", StringComparison.Ordinal);
485 if (has_extension.Value)
489 if (!File.Exists (file))
494 using (var stream = new FileStream (file, FileMode.Open, FileAccess.Read, FileShare.Read)) {
495 using (RawModule module = domain.OpenRawModule (stream, file)) {
496 if (!module.IsManifestModule) {
497 Error_AssemblyIsModule (fileName);
502 // check whether the assembly can be actually imported without
505 var an = module.GetAssemblyName ();
506 foreach (var entry in loaded_names) {
507 var loaded_name = entry.Item1;
508 if (an.Name != loaded_name.Name)
511 if (module.ModuleVersionId == entry.Item3.ManifestModule.ModuleVersionId)
514 if (((an.Flags | loaded_name.Flags) & AssemblyNameFlags.PublicKey) == 0) {
515 compiler.Report.SymbolRelatedToPreviousError (entry.Item2);
516 compiler.Report.SymbolRelatedToPreviousError (fileName);
517 compiler.Report.Error (1704,
518 "An assembly with the same name `{0}' has already been imported. Consider removing one of the references or sign the assembly",
523 AssemblyComparisonResult result;
524 if ((an.Flags & AssemblyNameFlags.PublicKey) == (loaded_name.Flags & AssemblyNameFlags.PublicKey) &&
525 (domain.CompareAssemblyIdentity (an.FullName, false, loaded_name.FullName, false, out result))) {
528 // Roslyn is much more lenient than native compiler here
531 case AssemblyComparisonResult.EquivalentFXUnified:
532 case AssemblyComparisonResult.EquivalentUnified:
533 compiler.Report.SymbolRelatedToPreviousError (entry.Item2);
534 compiler.Report.SymbolRelatedToPreviousError (fileName);
535 compiler.Report.Error (1703,
536 "An assembly `{0}' with the same identity has already been imported. Consider removing one of the references",
543 if (compiler.Settings.DebugFlags > 0)
544 Console.WriteLine ("Loading assembly `{0}'", fileName);
546 var assembly = domain.LoadAssembly (module);
547 if (assembly != null)
548 loaded_names.Add (Tuple.Create (an, fileName, assembly));
553 } catch (Exception e) {
554 if (compiler.Settings.DebugFlags > 0)
555 Console.WriteLine ("Exception during loading: {0}'", e.ToString ());
557 if (!isImplicitReference)
558 Error_FileCorrupted (file);
564 if (!isImplicitReference)
565 Error_FileNotFound (fileName);
570 public RawModule LoadModuleFile (string moduleName)
572 foreach (var path in paths) {
573 var file = Path.Combine (path, moduleName);
574 if (!File.Exists (file)) {
575 if (moduleName.EndsWith (".netmodule", StringComparison.Ordinal))
578 file += ".netmodule";
579 if (!File.Exists (file))
584 return domain.OpenRawModule (file);
586 Error_FileCorrupted (file);
591 Error_FileNotFound (moduleName);
595 public override void LoadReferences (ModuleContainer module)
597 List<Tuple<RootNamespace, Assembly>> loaded;
598 base.LoadReferencesCore (module, out corlib, out loaded);
600 compiler.TimeReporter.Start (TimeReporter.TimerType.ReferencesImporting);
602 if (corlib == null || corlib.__IsMissing) {
603 // System.Object was not found in any referenced assembly, use compiled assembly as corlib
604 corlib = module.DeclaringAssembly.Builder;
606 importer.InitializeBuiltinTypes (compiler.BuiltinTypes, corlib);
607 importer.ImportAssembly (corlib, module.GlobalRootNamespace);
610 foreach (var entry in loaded) {
611 importer.ImportAssembly (entry.Item2, entry.Item1);
614 compiler.TimeReporter.Stop (TimeReporter.TimerType.ReferencesImporting);
617 public void LoadModules (AssemblyDefinitionStatic assembly, RootNamespace targetNamespace)
619 foreach (var moduleName in compiler.Settings.Modules) {
620 var m = LoadModuleFile (moduleName);
624 if (m.IsManifestModule) {
625 Error_ModuleIsAssembly (moduleName);
629 var md = importer.ImportModule (assembly.IncludeModule (m), targetNamespace);
630 assembly.AddModule (md);
635 class AssemblyBuilderIKVM : AssemblyBuilderExtension
637 readonly AssemblyBuilder builder;
639 public AssemblyBuilderIKVM (AssemblyBuilder builder, CompilerContext ctx)
642 this.builder = builder;
645 public override void AddTypeForwarder (TypeSpec type, Location loc)
647 builder.__AddTypeForwarder (type.GetMetaInfo (), false);
650 public override void DefineWin32IconResource (string fileName)
654 bytes = File.ReadAllBytes (fileName);
655 } catch (Exception e) {
656 ctx.Report.Error (7064, Location.Null, "Error opening icon file `{0}'. {1}", fileName, e.Message);
660 builder.__DefineIconResource (bytes);
663 public override AssemblyName[] GetReferencedAssemblies ()
665 foreach (var m in builder.Modules) {
666 if (m is ModuleBuilder)
667 return m.__GetReferencedAssemblies ();
670 return new AssemblyName [0];
673 public override void SetAlgorithmId (uint value, Location loc)
675 builder.__SetAssemblyAlgorithmId ((AssemblyHashAlgorithm) value);
678 public override void SetCulture (string culture, Location loc)
680 builder.__SetAssemblyCulture (culture);
683 public override void SetFlags (uint flags, Location loc)
685 builder.__AssemblyFlags = (AssemblyNameFlags) flags;
688 public override void SetVersion (Version version, Location loc)
690 builder.__SetAssemblyVersion (version);