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 DynamicTypeReader (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.x", new string [] { "4.5", "net_4_x", "v4.0.30319" });
260 public StaticLoader (StaticImporter importer, CompilerContext compiler)
263 this.importer = importer;
264 domain = new Universe (UniverseOptions.MetadataOnly | UniverseOptions.ResolveMissingMembers |
265 UniverseOptions.DisableFusion | UniverseOptions.DecodeVersionInfoAttributeBlobs |
266 UniverseOptions.DeterministicOutput | UniverseOptions.DisableDefaultAssembliesLookup);
268 domain.AssemblyResolve += AssemblyReferenceResolver;
269 loaded_names = new List<Tuple<AssemblyName, string, Assembly>> ();
271 if (compiler.Settings.StdLib) {
272 var corlib_path = Path.GetDirectoryName (typeof (object).Assembly.Location);
273 string fx_path = corlib_path.Substring (0, corlib_path.LastIndexOf (Path.DirectorySeparatorChar));
275 string sdk_path = null;
277 string sdk_version = compiler.Settings.SdkVersion ?? "4.x";
278 string[] sdk_sub_dirs;
280 if (!sdk_directory.TryGetValue (sdk_version, out sdk_sub_dirs))
281 sdk_sub_dirs = new string[] { sdk_version };
283 foreach (var dir in sdk_sub_dirs) {
284 sdk_path = Path.Combine (fx_path, dir);
285 if (File.Exists (Path.Combine (sdk_path, "mscorlib.dll")))
291 if (sdk_path == null) {
292 compiler.Report.Warning (-1, 1, "SDK path could not be resolved");
293 sdk_path = corlib_path;
296 paths.Add (sdk_path);
302 public Assembly Corlib {
308 public AssemblyDefinitionStatic CompiledAssembly { get; set; }
310 public Universe Domain {
316 public StaticImporter MetadataImporter {
324 Assembly AssemblyReferenceResolver (object sender, IKVM.Reflection.ResolveEventArgs args)
326 var refname = args.Name;
327 if (refname == "mscorlib")
330 Assembly version_mismatch = null;
331 bool is_fx_assembly = false;
333 foreach (var assembly in domain.GetAssemblies ()) {
334 AssemblyComparisonResult result;
335 if (!domain.CompareAssemblyIdentity (refname, false, assembly.FullName, false, out result)) {
336 if ((result == AssemblyComparisonResult.NonEquivalentVersion || result == AssemblyComparisonResult.NonEquivalentPartialVersion) &&
337 (version_mismatch == null || version_mismatch.GetName ().Version < assembly.GetName ().Version) &&
339 version_mismatch = assembly;
345 if (result == AssemblyComparisonResult.EquivalentFullMatch ||
346 result == AssemblyComparisonResult.EquivalentWeakNamed ||
347 result == AssemblyComparisonResult.EquivalentPartialMatch) {
351 if (result == AssemblyComparisonResult.EquivalentFXUnified) {
352 is_fx_assembly = true;
354 if (version_mismatch == null || version_mismatch.GetName ().Version < assembly.GetName ().Version)
355 version_mismatch = assembly;
360 throw new NotImplementedException ("Assembly equality = " + result.ToString ());
363 if (version_mismatch != null) {
364 if (is_fx_assembly || version_mismatch is AssemblyBuilder)
365 return version_mismatch;
367 var ref_an = new AssemblyName (refname);
368 var v1 = ref_an.Version;
369 var v2 = version_mismatch.GetName ().Version;
370 AssemblyReferenceMessageInfo messageInfo;
373 messageInfo = new AssemblyReferenceMessageInfo (ref_an, report => {
374 report.SymbolRelatedToPreviousError (args.RequestingAssembly.Location);
375 report.Error (1705, string.Format ("Assembly `{0}' depends on `{1}' which has a higher version number than referenced assembly `{2}'",
376 args.RequestingAssembly.FullName, refname, version_mismatch.GetName ().FullName));
380 messageInfo = new AssemblyReferenceMessageInfo (ref_an, report => {
381 if (v1.Major != v2.Major || v1.Minor != v2.Minor) {
382 report.Warning (1701, 2,
383 "Assuming assembly reference `{0}' matches assembly `{1}'. You may need to supply runtime policy",
384 refname, version_mismatch.GetName ().FullName);
386 report.Warning (1702, 3,
387 "Assuming assembly reference `{0}' matches assembly `{1}'. You may need to supply runtime policy",
388 refname, version_mismatch.GetName ().FullName);
393 AddReferenceVersionMismatch (args.RequestingAssembly.GetName (), messageInfo);
395 return version_mismatch;
399 // Recursive reference to compiled assembly checks name only. Any other
400 // details (PublicKey, Version, etc) are not yet known hence cannot be checked
402 ParsedAssemblyName referenced_assembly;
403 if (Fusion.ParseAssemblyName (args.Name, out referenced_assembly) == ParseAssemblyResult.OK && CompiledAssembly.Name == referenced_assembly.Name)
404 return CompiledAssembly.Builder;
406 // AssemblyReference has not been found in the domain
407 // create missing reference and continue
408 return domain.CreateMissingAssembly (args.Name);
411 void AddReferenceVersionMismatch (AssemblyName an, AssemblyReferenceMessageInfo errorInfo)
413 if (resolved_version_mismatches == null)
414 resolved_version_mismatches = new Dictionary<AssemblyName, List<AssemblyReferenceMessageInfo>> ();
416 List<AssemblyReferenceMessageInfo> names;
417 if (!resolved_version_mismatches.TryGetValue (an, out names)) {
418 names = new List<AssemblyReferenceMessageInfo> ();
419 resolved_version_mismatches.Add (an, names);
422 names.Add (errorInfo);
425 public void Dispose ()
430 protected override string[] GetDefaultReferences ()
433 // For now the "default config" is harcoded into the compiler
434 // we can move this outside later
436 var default_references = new List<string> (4);
438 default_references.Add ("System.dll");
439 default_references.Add ("System.Xml.dll");
440 default_references.Add ("System.Core.dll");
442 if (corlib != null && corlib.GetName ().Version.Major >= 4) {
443 default_references.Add ("Microsoft.CSharp.dll");
446 return default_references.ToArray ();
449 public List<AssemblyReferenceMessageInfo> GetNotUnifiedReferences (AssemblyName assemblyName)
451 List<AssemblyReferenceMessageInfo> list = null;
452 if (resolved_version_mismatches != null)
453 resolved_version_mismatches.TryGetValue (assemblyName, out list);
458 public override Assembly HasObjectType (Assembly assembly)
461 // System.Object can be forwarded and ikvm
462 // transparently finds it in target assembly therefore
463 // need to return actual obj assembly becauase in such
464 // case it's different to assembly parameter
465 var obj = assembly.FindType (objectTypeName);
466 return obj == null ? null : obj.Assembly;
467 } catch (Exception e) {
468 throw new InternalErrorException (e, "Failed to load assembly `{0}'", assembly.FullName);
472 public override Assembly LoadAssemblyFile (string fileName, bool isImplicitReference)
474 bool? has_extension = null;
475 foreach (var path in paths) {
476 var file = Path.Combine (path, fileName);
477 if (compiler.Settings.DebugFlags > 0)
478 Console.WriteLine ("Probing assembly location `{0}'", file);
480 if (!File.Exists (file)) {
481 if (!has_extension.HasValue)
482 has_extension = fileName.EndsWith (".dll", StringComparison.Ordinal) || fileName.EndsWith (".exe", StringComparison.Ordinal);
484 if (has_extension.Value)
488 if (!File.Exists (file))
493 using (var stream = new FileStream (file, FileMode.Open, FileAccess.Read, FileShare.Read)) {
494 using (RawModule module = domain.OpenRawModule (stream, file)) {
495 if (!module.IsManifestModule) {
496 Error_AssemblyIsModule (fileName);
501 // check whether the assembly can be actually imported without
504 var an = module.GetAssemblyName ();
505 foreach (var entry in loaded_names) {
506 var loaded_name = entry.Item1;
507 if (an.Name != loaded_name.Name)
510 if (module.ModuleVersionId == entry.Item3.ManifestModule.ModuleVersionId)
513 if (((an.Flags | loaded_name.Flags) & AssemblyNameFlags.PublicKey) == 0) {
514 compiler.Report.SymbolRelatedToPreviousError (entry.Item2);
515 compiler.Report.SymbolRelatedToPreviousError (fileName);
516 compiler.Report.Error (1704,
517 "An assembly with the same name `{0}' has already been imported. Consider removing one of the references or sign the assembly",
522 if ((an.Flags & AssemblyNameFlags.PublicKey) == (loaded_name.Flags & AssemblyNameFlags.PublicKey)) {
523 compiler.Report.SymbolRelatedToPreviousError (entry.Item2);
524 compiler.Report.SymbolRelatedToPreviousError (fileName);
525 compiler.Report.Error (1703,
526 "An assembly `{0}' with the same identity has already been imported. Consider removing one of the references",
532 if (compiler.Settings.DebugFlags > 0)
533 Console.WriteLine ("Loading assembly `{0}'", fileName);
535 var assembly = domain.LoadAssembly (module);
536 if (assembly != null)
537 loaded_names.Add (Tuple.Create (an, fileName, assembly));
542 } catch (Exception e) {
543 if (compiler.Settings.DebugFlags > 0)
544 Console.WriteLine ("Exception during loading: {0}'", e.ToString ());
546 if (!isImplicitReference)
547 Error_FileCorrupted (file);
553 if (!isImplicitReference)
554 Error_FileNotFound (fileName);
559 public RawModule LoadModuleFile (string moduleName)
561 foreach (var path in paths) {
562 var file = Path.Combine (path, moduleName);
563 if (!File.Exists (file)) {
564 if (moduleName.EndsWith (".netmodule", StringComparison.Ordinal))
567 file += ".netmodule";
568 if (!File.Exists (file))
573 return domain.OpenRawModule (file);
575 Error_FileCorrupted (file);
580 Error_FileNotFound (moduleName);
584 public override void LoadReferences (ModuleContainer module)
586 List<Tuple<RootNamespace, Assembly>> loaded;
587 base.LoadReferencesCore (module, out corlib, out loaded);
589 compiler.TimeReporter.Start (TimeReporter.TimerType.ReferencesImporting);
591 if (corlib == null || corlib.__IsMissing) {
592 // System.Object was not found in any referenced assembly, use compiled assembly as corlib
593 corlib = module.DeclaringAssembly.Builder;
595 importer.InitializeBuiltinTypes (compiler.BuiltinTypes, corlib);
596 importer.ImportAssembly (corlib, module.GlobalRootNamespace);
599 foreach (var entry in loaded) {
600 importer.ImportAssembly (entry.Item2, entry.Item1);
603 compiler.TimeReporter.Stop (TimeReporter.TimerType.ReferencesImporting);
606 public void LoadModules (AssemblyDefinitionStatic assembly, RootNamespace targetNamespace)
608 foreach (var moduleName in compiler.Settings.Modules) {
609 var m = LoadModuleFile (moduleName);
613 if (m.IsManifestModule) {
614 Error_ModuleIsAssembly (moduleName);
618 var md = importer.ImportModule (assembly.IncludeModule (m), targetNamespace);
619 assembly.AddModule (md);
624 class AssemblyBuilderIKVM : AssemblyBuilderExtension
626 readonly AssemblyBuilder builder;
628 public AssemblyBuilderIKVM (AssemblyBuilder builder, CompilerContext ctx)
631 this.builder = builder;
634 public override void AddTypeForwarder (TypeSpec type, Location loc)
636 builder.__AddTypeForwarder (type.GetMetaInfo (), false);
639 public override void DefineWin32IconResource (string fileName)
643 bytes = File.ReadAllBytes (fileName);
644 } catch (Exception e) {
645 ctx.Report.Error (7064, Location.Null, "Error opening icon file `{0}'. {1}", fileName, e.Message);
649 builder.__DefineIconResource (bytes);
652 public override AssemblyName[] GetReferencedAssemblies ()
654 foreach (var m in builder.Modules) {
655 if (m is ModuleBuilder)
656 return m.__GetReferencedAssemblies ();
659 return new AssemblyName [0];
662 public override void SetAlgorithmId (uint value, Location loc)
664 builder.__SetAssemblyAlgorithmId ((AssemblyHashAlgorithm) value);
667 public override void SetCulture (string culture, Location loc)
669 builder.__SetAssemblyCulture (culture);
672 public override void SetFlags (uint flags, Location loc)
674 builder.__AssemblyFlags = (AssemblyNameFlags) flags;
677 public override void SetVersion (Version version, Location loc)
679 builder.__SetAssemblyVersion (version);