Merge pull request #2543 from ermshiperete/Xamarin-31021
[mono.git] / mcs / mcs / ikvm.cs
1 //
2 // ikvm.cs: IKVM.Reflection and IKVM.Reflection.Emit specific implementations
3 //
4 // Author: Marek Safar (marek.safar@gmail.com)
5 //
6 // Dual licensed under the terms of the MIT X11 or GNU GPL
7 //
8 // Copyright 2009-2010 Novell, Inc. 
9 // Copyright 2011 Xamarin Inc
10 //
11 //
12
13 using System;
14 using System.Collections.Generic;
15 using MetaType = IKVM.Reflection.Type;
16 using IKVM.Reflection;
17 using IKVM.Reflection.Emit;
18 using System.IO;
19 using System.Configuration.Assemblies;
20
21 namespace Mono.CSharp
22 {
23 #if !STATIC
24         public class StaticImporter
25         {
26                 public StaticImporter (BuiltinTypes builtin)
27                 {
28                         throw new NotSupportedException ();
29                 }
30
31                 public void ImportAssembly (Assembly assembly, RootNamespace targetNamespace)
32                 {
33                         throw new NotSupportedException ();
34                 }
35
36                 public void ImportModule (Module module, RootNamespace targetNamespace)
37                 {
38                         throw new NotSupportedException ();
39                 }
40
41                 public TypeSpec ImportType (System.Type type)
42                 {
43                         throw new NotSupportedException ();
44                 }
45         }
46
47 #else
48
49         sealed class StaticImporter : MetadataImporter
50         {
51                 public StaticImporter (ModuleContainer module)
52                         : base (module)
53                 {
54                 }
55
56                 public void AddCompiledAssembly (AssemblyDefinitionStatic assembly)
57                 {
58                         assembly_2_definition.Add (assembly.Builder, assembly);
59                 }
60
61                 public override void AddCompiledType (TypeBuilder type, TypeSpec spec)
62                 {
63                         compiled_types.Add (type, spec);
64                 }
65
66                 protected override MemberKind DetermineKindFromBaseType (MetaType baseType)
67                 {
68                         string name = baseType.Name;
69
70                         if (name == "ValueType" && baseType.Namespace == "System")
71                                 return MemberKind.Struct;
72
73                         if (name == "Enum" && baseType.Namespace == "System")
74                                 return MemberKind.Enum;
75
76                         if (name == "MulticastDelegate" && baseType.Namespace == "System")
77                                 return MemberKind.Delegate;
78
79                         return MemberKind.Class;
80                 }
81
82                 protected override bool HasVolatileModifier (MetaType[] modifiers)
83                 {
84                         foreach (var t in modifiers) {
85                                 if (t.Name == "IsVolatile" && t.Namespace == CompilerServicesNamespace)
86                                         return true;
87                         }
88
89                         return false;
90                 }
91
92                 public void ImportAssembly (Assembly assembly, RootNamespace targetNamespace)
93                 {
94                         try {
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);
99
100                                 var all_types = assembly.GetTypes ();
101                                 ImportTypes (all_types, targetNamespace, true);
102
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);
108                         }
109                 }
110
111                 public ImportedModuleDefinition ImportModule (Module module, RootNamespace targetNamespace)
112                 {
113                         var module_definition = new ImportedModuleDefinition (module);
114                         module_definition.ReadAttributes ();
115
116                         var all_types = module.GetTypes ();
117                         ImportTypes (all_types, targetNamespace, false);
118
119                         return module_definition;
120                 }
121
122                 void ImportForwardedTypes (MetaType[] types, Namespace targetNamespace)
123                 {
124                         Namespace ns = targetNamespace;
125                         string prev_namespace = null;
126                         foreach (var t in types) {
127                                 if (!t.__IsTypeForwarder)
128                                         continue;
129
130                                 // IsMissing tells us the type has been forwarded and target assembly is missing 
131                                 if (!t.__IsMissing)
132                                         continue;
133
134                                 if (t.Name[0] == '<')
135                                         continue;
136
137                                 var it = CreateType (t, null, new DynamicTypeReader (t), true);
138                                 if (it == null)
139                                         continue;
140
141                                 if (prev_namespace != t.Namespace) {
142                                         ns = t.Namespace == null ? targetNamespace : targetNamespace.GetNamespace (t.Namespace, true);
143                                         prev_namespace = t.Namespace;
144                                 }
145
146                                 ns.AddType (module, it);
147                         }
148                 }
149
150                 public void InitializeBuiltinTypes (BuiltinTypes builtin, Assembly corlib)
151                 {
152                         //
153                         // Setup mapping for build-in types to avoid duplication of their definition
154                         //
155                         foreach (var type in builtin.AllTypes) {
156                                 compiled_types.Add (corlib.GetType (type.FullName), type);
157                         }
158                 }
159         }
160 #endif
161
162         class AssemblyDefinitionStatic : AssemblyDefinition
163         {
164                 readonly StaticLoader loader;
165
166                 //
167                 // Assembly container with file output
168                 //
169                 public AssemblyDefinitionStatic (ModuleContainer module, StaticLoader loader, string name, string fileName)
170                         : base (module, name, fileName)
171                 {
172                         this.loader = loader;
173                         Importer = loader.MetadataImporter;
174                 }
175
176                 //
177                 // Initializes the assembly SRE domain
178                 //
179                 public void Create (Universe domain)
180                 {
181                         ResolveAssemblySecurityAttributes ();
182                         var an = CreateAssemblyName ();
183
184                         Builder = domain.DefineDynamicAssembly (an, AssemblyBuilderAccess.Save, Path.GetDirectoryName (file_name));
185                         module.Create (this, CreateModuleBuilder ());
186                 }
187
188                 public override void Emit ()
189                 {
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);
194                         } else {
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);
199                                         break;
200                                 case RuntimeVersion.v2:
201                                         Builder.__SetImageRuntimeVersion ("v2.0.50727", 0x20000);
202                                         break;
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);
207                                         break;
208                                 default:
209                                         throw new NotImplementedException ();
210                                 }
211                         }
212
213                         builder_extra = new AssemblyBuilderIKVM (Builder, Compiler);
214
215                         base.Emit ();
216                 }
217
218                 public Module IncludeModule (RawModule moduleFile)
219                 {
220                         return Builder.__AddModule (moduleFile);
221                 }
222
223                 protected override List<string[]> GetNotUnifiedReferences (AssemblyName assemblyName)
224                 {
225                         return loader.GetNotUnifiedReferences (assemblyName);
226                 }
227
228                 protected override void SaveModule (PortableExecutableKinds pekind, ImageFileMachine machine)
229                 {
230                         module.Builder.__Save (pekind, machine);
231                 }
232         }
233
234         class StaticLoader : AssemblyReferencesLoader<Assembly>, IDisposable
235         {
236                 readonly StaticImporter importer;
237                 readonly Universe domain;
238                 Assembly corlib;
239                 readonly List<Tuple<AssemblyName, string, Assembly>> loaded_names;
240                 static readonly Dictionary<string, string[]> sdk_directory;
241                 Dictionary<AssemblyName, List<string[]>> resolved_version_mismatches;
242
243                 static StaticLoader ()
244                 {
245                         sdk_directory = new Dictionary<string, string[]> ();
246                         sdk_directory.Add ("2", new string[] { "2.0-api", "v2.0.50727" });
247                         sdk_directory.Add ("2.0", new string[] { "2.0-api", "v2.0.50727" });
248                         sdk_directory.Add ("4", new string[] { "4.0-api", "v4.0.30319" });
249                         sdk_directory.Add ("4.0", new string[] { "4.0-api", "v4.0.30319" });
250                         sdk_directory.Add ("4.5", new string[] { "4.5-api", "v4.0.30319" });
251                         sdk_directory.Add ("4.6", new string [] { "4.5", "net_4_x", "v4.0.30319" });
252                 }
253
254                 public StaticLoader (StaticImporter importer, CompilerContext compiler)
255                         : base (compiler)
256                 {
257                         this.importer = importer;
258                         domain = new Universe (UniverseOptions.MetadataOnly | UniverseOptions.ResolveMissingMembers | 
259                                 UniverseOptions.DisableFusion | UniverseOptions.DecodeVersionInfoAttributeBlobs |
260                                 UniverseOptions.DeterministicOutput);
261                         
262                         domain.AssemblyResolve += AssemblyReferenceResolver;
263                         loaded_names = new List<Tuple<AssemblyName, string, Assembly>> ();
264
265                         if (compiler.Settings.StdLib) {
266                                 var corlib_path = Path.GetDirectoryName (typeof (object).Assembly.Location);
267                                 string fx_path = corlib_path.Substring (0, corlib_path.LastIndexOf (Path.DirectorySeparatorChar));
268
269                                 string sdk_path = null;
270
271                                 string sdk_version = compiler.Settings.SdkVersion ?? "4.6";
272                                 string[] sdk_sub_dirs;
273
274                                 if (!sdk_directory.TryGetValue (sdk_version, out sdk_sub_dirs))
275                                         sdk_sub_dirs = new string[] { sdk_version };
276
277                                 foreach (var dir in sdk_sub_dirs) {
278                                         sdk_path = Path.Combine (fx_path, dir);
279                                         if (File.Exists (Path.Combine (sdk_path, "mscorlib.dll")))
280                                                 break;
281
282                                         sdk_path = null;
283                                 }
284
285                                 if (sdk_path == null) {
286                                         compiler.Report.Warning (-1, 1, "SDK path could not be resolved");
287                                         sdk_path = corlib_path;
288                                 }
289
290                                 paths.Add (sdk_path);
291                         }
292                 }
293
294                 #region Properties
295
296                 public Assembly Corlib {
297                         get {
298                                 return corlib;
299                         }
300                 }
301
302                 public AssemblyDefinitionStatic CompiledAssembly {  get; set; }
303
304                 public Universe Domain {
305                         get {
306                                 return domain;
307                         }
308                 }
309
310                 public StaticImporter MetadataImporter {
311                         get {
312                                 return importer;
313                         }
314                 }
315
316                 #endregion
317
318                 Assembly AssemblyReferenceResolver (object sender, IKVM.Reflection.ResolveEventArgs args)
319                 {
320                         var refname = args.Name;
321                         if (refname == "mscorlib")
322                                 return corlib;
323
324                         Assembly version_mismatch = null;
325                         bool is_fx_assembly = false;
326
327                         foreach (var assembly in domain.GetAssemblies ()) {
328                                 AssemblyComparisonResult result;
329                                 if (!domain.CompareAssemblyIdentity (refname, false, assembly.FullName, false, out result)) {
330                                         if ((result == AssemblyComparisonResult.NonEquivalentVersion || result == AssemblyComparisonResult.NonEquivalentPartialVersion) &&
331                                                 (version_mismatch == null || version_mismatch.GetName ().Version < assembly.GetName ().Version) &&
332                                                 !is_fx_assembly) {
333                                                 version_mismatch = assembly;
334                                         }
335
336                                         continue;
337                                 }
338
339                                 if (result == AssemblyComparisonResult.EquivalentFullMatch ||
340                                         result == AssemblyComparisonResult.EquivalentWeakNamed ||
341                                         result == AssemblyComparisonResult.EquivalentPartialMatch) {
342                                         return assembly;
343                                 }
344
345                                 if (result == AssemblyComparisonResult.EquivalentFXUnified) {
346                                         is_fx_assembly = true;
347
348                                         if (version_mismatch == null || version_mismatch.GetName ().Version < assembly.GetName ().Version)
349                                                 version_mismatch = assembly;
350
351                                         continue;
352                                 }
353
354                                 throw new NotImplementedException ("Assembly equality = " + result.ToString ());
355                         }
356
357                         if (version_mismatch != null) {
358                                 if (version_mismatch is AssemblyBuilder)
359                                         return version_mismatch;
360
361                                 var v1 = new AssemblyName (refname).Version;
362                                 var v2 = version_mismatch.GetName ().Version;
363
364                                 if (v1 > v2) {
365                                         if (resolved_version_mismatches == null)
366                                                 resolved_version_mismatches = new Dictionary<AssemblyName, List<string[]>> ();
367
368                                         var an = args.RequestingAssembly.GetName ();
369                                         List<string[]> names;
370                                         if (!resolved_version_mismatches.TryGetValue (an, out names)) {
371                                                 names = new List<string[]> ();
372                                                 resolved_version_mismatches.Add (an, names);
373                                         }
374
375                                         names.Add (new[] {
376                                                 args.RequestingAssembly.Location,
377                                                 string.Format ("Assembly `{0}' depends on `{1}' which has a higher version number than referenced assembly `{2}'",
378                                                         args.RequestingAssembly.FullName, refname, version_mismatch.GetName ().FullName)
379                                         });
380
381                                         return version_mismatch;
382                                 }
383
384                                 if (!is_fx_assembly) {
385                                         if (v1.Major != v2.Major || v1.Minor != v2.Minor) {
386                                                 compiler.Report.Warning (1701, 2,
387                                                         "Assuming assembly reference `{0}' matches assembly `{1}'. You may need to supply runtime policy",
388                                                         refname, version_mismatch.GetName ().FullName);
389                                         } else {
390                                                 compiler.Report.Warning (1702, 3,
391                                                         "Assuming assembly reference `{0}' matches assembly `{1}'. You may need to supply runtime policy",
392                                                         refname, version_mismatch.GetName ().FullName);
393                                         }
394                                 }
395
396                                 return version_mismatch;
397                         }
398
399                         //
400                         // Recursive reference to compiled assembly checks name only. Any other
401                         // details (PublicKey, Version, etc) are not yet known hence cannot be checked
402                         //
403                         ParsedAssemblyName referenced_assembly;
404                         if (Fusion.ParseAssemblyName (args.Name, out referenced_assembly) == ParseAssemblyResult.OK && CompiledAssembly.Name == referenced_assembly.Name)
405                                 return CompiledAssembly.Builder;
406
407                         // AssemblyReference has not been found in the domain
408                         // create missing reference and continue
409                         return domain.CreateMissingAssembly (args.Name);
410                 }
411
412                 public void Dispose ()
413                 {
414                         domain.Dispose ();
415                 }
416
417                 protected override string[] GetDefaultReferences ()
418                 {
419                         //
420                         // For now the "default config" is harcoded into the compiler
421                         // we can move this outside later
422                         //
423                         var default_references = new List<string> (4);
424
425                         default_references.Add ("System.dll");
426                         default_references.Add ("System.Xml.dll");
427                         default_references.Add ("System.Core.dll");
428
429                         if (corlib != null && corlib.GetName ().Version.Major >= 4) {
430                                 default_references.Add ("Microsoft.CSharp.dll");
431                         }
432
433                         return default_references.ToArray ();
434                 }
435
436                 public List<string[]> GetNotUnifiedReferences (AssemblyName assemblyName)
437                 {
438                         List<string[]> list = null;
439                         if (resolved_version_mismatches != null)
440                                 resolved_version_mismatches.TryGetValue (assemblyName, out list);
441
442                         return list;
443                 }
444
445                 public override bool HasObjectType (Assembly assembly)
446                 {
447                         try {
448                                 return assembly.GetType (compiler.BuiltinTypes.Object.FullName) != null;
449                         } catch (Exception e) {
450                                 throw new InternalErrorException (e, "Failed to load assembly `{0}'", assembly.FullName);
451                         }
452                 }
453
454                 public override Assembly LoadAssemblyFile (string fileName, bool isImplicitReference)
455                 {
456                         bool? has_extension = null;
457                         foreach (var path in paths) {
458                                 var file = Path.Combine (path, fileName);
459                                 if (compiler.Settings.DebugFlags > 0)
460                                         Console.WriteLine ("Probing assembly location `{0}'", file);
461
462                                 if (!File.Exists (file)) {
463                                         if (!has_extension.HasValue)
464                                                 has_extension = fileName.EndsWith (".dll", StringComparison.Ordinal) || fileName.EndsWith (".exe", StringComparison.Ordinal);
465
466                                         if (has_extension.Value)
467                                                 continue;
468
469                                         file += ".dll";
470                                         if (!File.Exists (file))
471                                                 continue;
472                                 }
473
474                                 try {
475                                         using (var stream = new FileStream (file, FileMode.Open, FileAccess.Read, FileShare.Read)) {
476                                                 using (RawModule module = domain.OpenRawModule (stream, file)) {
477                                                         if (!module.IsManifestModule) {
478                                                                 Error_AssemblyIsModule (fileName);
479                                                                 return null;
480                                                         }
481
482                                                         //
483                                                         // check whether the assembly can be actually imported without
484                                                         // collision
485                                                         //
486                                                         var an = module.GetAssemblyName ();
487                                                         foreach (var entry in loaded_names) {
488                                                                 var loaded_name = entry.Item1;
489                                                                 if (an.Name != loaded_name.Name)
490                                                                         continue;
491
492                                                                 if (module.ModuleVersionId == entry.Item3.ManifestModule.ModuleVersionId)
493                                                                         return entry.Item3;
494                                                         
495                                                                 if (((an.Flags | loaded_name.Flags) & AssemblyNameFlags.PublicKey) == 0) {
496                                                                         compiler.Report.SymbolRelatedToPreviousError (entry.Item2);
497                                                                         compiler.Report.SymbolRelatedToPreviousError (fileName);
498                                                                         compiler.Report.Error (1704,
499                                                                                 "An assembly with the same name `{0}' has already been imported. Consider removing one of the references or sign the assembly",
500                                                                                 an.Name);
501                                                                         return null;
502                                                                 }
503
504                                                                 if ((an.Flags & AssemblyNameFlags.PublicKey) == (loaded_name.Flags & AssemblyNameFlags.PublicKey)) {
505                                                                         compiler.Report.SymbolRelatedToPreviousError (entry.Item2);
506                                                                         compiler.Report.SymbolRelatedToPreviousError (fileName);
507                                                                         compiler.Report.Error (1703,
508                                                                                 "An assembly `{0}' with the same identity has already been imported. Consider removing one of the references",
509                                                                                 an.Name);
510                                                                         return null;
511                                                                 }
512                                                         }
513
514                                                         if (compiler.Settings.DebugFlags > 0)
515                                                                 Console.WriteLine ("Loading assembly `{0}'", fileName);
516
517                                                         var assembly = domain.LoadAssembly (module);
518                                                         if (assembly != null)
519                                                                 loaded_names.Add (Tuple.Create (an, fileName, assembly));
520
521                                                         return assembly;
522                                                 }
523                                         }
524                                 } catch (Exception e) {
525                                         if (compiler.Settings.DebugFlags > 0)
526                                                 Console.WriteLine ("Exception during loading: {0}'", e.ToString ());
527
528                                         if (!isImplicitReference)
529                                                 Error_FileCorrupted (file);
530
531                                         return null;
532                                 }
533                         }
534
535                         if (!isImplicitReference)
536                                 Error_FileNotFound (fileName);
537
538                         return null;
539                 }
540
541                 public RawModule LoadModuleFile (string moduleName)
542                 {
543                         foreach (var path in paths) {
544                                 var file = Path.Combine (path, moduleName);
545                                 if (!File.Exists (file)) {
546                                         if (moduleName.EndsWith (".netmodule", StringComparison.Ordinal))
547                                                 continue;
548
549                                         file += ".netmodule";
550                                         if (!File.Exists (file))
551                                                 continue;
552                                 }
553
554                                 try {
555                                         return domain.OpenRawModule (file);
556                                 } catch {
557                                         Error_FileCorrupted (file);
558                                         return null;
559                                 }
560                         }
561
562                         Error_FileNotFound (moduleName);
563                         return null;                            
564                 }
565
566                 public override void LoadReferences (ModuleContainer module)
567                 {
568                         List<Tuple<RootNamespace, Assembly>> loaded;
569                         base.LoadReferencesCore (module, out corlib, out loaded);
570
571                         compiler.TimeReporter.Start (TimeReporter.TimerType.ReferencesImporting);
572
573                         if (corlib == null) {
574                                 // System.Object was not found in any referenced assembly, use compiled assembly as corlib
575                                 corlib = module.DeclaringAssembly.Builder;
576                         } else {
577                                 importer.InitializeBuiltinTypes (compiler.BuiltinTypes, corlib);
578                                 importer.ImportAssembly (corlib, module.GlobalRootNamespace);
579                         }
580
581                         foreach (var entry in loaded) {
582                                 importer.ImportAssembly (entry.Item2, entry.Item1);
583                         }
584
585                         compiler.TimeReporter.Stop (TimeReporter.TimerType.ReferencesImporting);
586                 }
587
588                 public void LoadModules (AssemblyDefinitionStatic assembly, RootNamespace targetNamespace)
589                 {
590                         foreach (var moduleName in compiler.Settings.Modules) {
591                                 var m = LoadModuleFile (moduleName);
592                                 if (m == null)
593                                         continue;
594
595                                 if (m.IsManifestModule) {
596                                         Error_ModuleIsAssembly (moduleName);
597                                         continue;
598                                 }
599
600                                 var md = importer.ImportModule (assembly.IncludeModule (m), targetNamespace);
601                                 assembly.AddModule (md);
602                         }
603                 }
604         }
605
606         class AssemblyBuilderIKVM : AssemblyBuilderExtension
607         {
608                 readonly AssemblyBuilder builder;
609
610                 public AssemblyBuilderIKVM (AssemblyBuilder builder, CompilerContext ctx)
611                         : base (ctx)
612                 {
613                         this.builder = builder;
614                 }
615
616                 public override void AddTypeForwarder (TypeSpec type, Location loc)
617                 {
618                         builder.__AddTypeForwarder (type.GetMetaInfo (), false);
619                 }
620
621                 public override void DefineWin32IconResource (string fileName)
622                 {
623                         byte[] bytes;
624                         try {
625                                 bytes = File.ReadAllBytes (fileName);
626                         } catch (Exception e) {
627                                 ctx.Report.Error (7064, Location.Null, "Error opening icon file `{0}'. {1}", fileName, e.Message);
628                                 return;
629                         }
630
631                         builder.__DefineIconResource (bytes);
632                 }
633
634                 public override AssemblyName[] GetReferencedAssemblies ()
635                 {
636                         foreach (var m in builder.Modules) {
637                                 if (m is ModuleBuilder)
638                                         return m.__GetReferencedAssemblies ();
639                         }
640
641                         return new AssemblyName [0];
642                 }
643
644                 public override void SetAlgorithmId (uint value, Location loc)
645                 {
646                         builder.__SetAssemblyAlgorithmId ((AssemblyHashAlgorithm) value);
647                 }
648
649                 public override void SetCulture (string culture, Location loc)
650                 {
651                         builder.__SetAssemblyCulture (culture);
652                 }
653
654                 public override void SetFlags (uint flags, Location loc)
655                 {
656                         builder.__AssemblyFlags = (AssemblyNameFlags) flags;
657                 }
658
659                 public override void SetVersion (Version version, Location loc)
660                 {
661                         builder.__SetAssemblyVersion (version);
662                 }
663         }
664 }