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 void SaveModule (PortableExecutableKinds pekind, ImageFileMachine machine)
 224                 {
 225                         module.Builder.__Save (pekind, machine);
 226                 }
 227         }
 228
 229         class StaticLoader : AssemblyReferencesLoader<Assembly>, IDisposable
 230         {
 231                 readonly StaticImporter importer;
 232                 readonly Universe domain;
 233                 Assembly corlib;
 234                 readonly List<Tuple<AssemblyName, string, Assembly>> loaded_names;
 235                 static readonly Dictionary<string, string[]> sdk_directory;
 236
 237                 static StaticLoader ()
 238                 {
 239                         sdk_directory = new Dictionary<string, string[]> ();
 240                         sdk_directory.Add ("2", new string[] { "2.0", "net_2_0", "v2.0.50727" });
 241                         sdk_directory.Add ("4", new string[] { "4.0", "net_4_0", "v4.0.30319" });
 242                         sdk_directory.Add ("4.5", new string[] { "4.5", "net_4_5", "v4.0.30319" });
 243                 }
 244
 245                 public StaticLoader (StaticImporter importer, CompilerContext compiler)
 246                         : base (compiler)
 247                 {
 248                         this.importer = importer;
 249                         domain = new Universe (UniverseOptions.MetadataOnly | UniverseOptions.ResolveMissingMembers |
 250                                 UniverseOptions.DisableFusion | UniverseOptions.DecodeVersionInfoAttributeBlobs |
 251                                 UniverseOptions.DeterministicOutput);
 252
 253                         domain.AssemblyResolve += AssemblyReferenceResolver;
 254                         loaded_names = new List<Tuple<AssemblyName, string, Assembly>> ();
 255
 256                         if (compiler.Settings.StdLib) {
 257                                 var corlib_path = Path.GetDirectoryName (typeof (object).Assembly.Location);
 258                                 string fx_path = corlib_path.Substring (0, corlib_path.LastIndexOf (Path.DirectorySeparatorChar));
 259
 260                                 string sdk_path = null;
 261
 262                                 string sdk_version = compiler.Settings.SdkVersion ?? "4.5";
 263                                 string[] sdk_sub_dirs;
 264
 265                                 if (!sdk_directory.TryGetValue (sdk_version, out sdk_sub_dirs))
 266                                         sdk_sub_dirs = new string[] { sdk_version };
 267
 268                                 foreach (var dir in sdk_sub_dirs) {
 269                                         sdk_path = Path.Combine (fx_path, dir);
 270                                         if (File.Exists (Path.Combine (sdk_path, "mscorlib.dll")))
 271                                                 break;
 272
 273                                         sdk_path = null;
 274                                 }
 275
 276                                 if (sdk_path == null) {
 277                                         compiler.Report.Warning (-1, 1, "SDK path could not be resolved");
 278                                         sdk_path = corlib_path;
 279                                 }
 280
 281                                 paths.Add (sdk_path);
 282                         }
 283                 }
 284
 285                 #region Properties
 286
 287                 public Assembly Corlib {
 288                         get {
 289                                 return corlib;
 290                         }
 291                 }
 292
 293                 public AssemblyDefinitionStatic CompiledAssembly {  get; set; }
 294
 295                 public Universe Domain {
 296                         get {
 297                                 return domain;
 298                         }
 299                 }
 300
 301                 public StaticImporter MetadataImporter {
 302                         get {
 303                                 return importer;
 304                         }
 305                 }
 306
 307                 #endregion
 308
 309                 Assembly AssemblyReferenceResolver (object sender, IKVM.Reflection.ResolveEventArgs args)
 310                 {
 311                         var refname = args.Name;
 312                         if (refname == "mscorlib")
 313                                 return corlib;
 314
 315                         Assembly version_mismatch = null;
 316                         bool is_fx_assembly = false;
 317
 318                         foreach (var assembly in domain.GetAssemblies ()) {
 319                                 AssemblyComparisonResult result;
 320                                 if (!domain.CompareAssemblyIdentity (refname, false, assembly.FullName, false, out result)) {
 321                                         if ((result == AssemblyComparisonResult.NonEquivalentVersion || result == AssemblyComparisonResult.NonEquivalentPartialVersion) &&
 322                                                 (version_mismatch == null || version_mismatch.GetName ().Version < assembly.GetName ().Version) &&
 323                                                 !is_fx_assembly) {
 324                                                 version_mismatch = assembly;
 325                                         }
 326
 327                                         continue;
 328                                 }
 329
 330                                 if (result == AssemblyComparisonResult.EquivalentFullMatch ||
 331                                         result == AssemblyComparisonResult.EquivalentWeakNamed ||
 332                                         result == AssemblyComparisonResult.EquivalentPartialMatch) {
 333                                         return assembly;
 334                                 }
 335
 336                                 if (result == AssemblyComparisonResult.EquivalentFXUnified) {
 337                                         is_fx_assembly = true;
 338
 339                                         if (version_mismatch == null || version_mismatch.GetName ().Version < assembly.GetName ().Version)
 340                                                 version_mismatch = assembly;
 341
 342                                         continue;
 343                                 }
 344
 345                                 throw new NotImplementedException ("Assembly equality = " + result.ToString ());
 346                         }
 347
 348                         if (version_mismatch != null) {
 349                                 if (version_mismatch is AssemblyBuilder)
 350                                         return version_mismatch;
 351
 352                                 var v1 = new AssemblyName (refname).Version;
 353                                 var v2 = version_mismatch.GetName ().Version;
 354
 355                                 if (v1 > v2) {
 356 //                                      compiler.Report.SymbolRelatedToPreviousError (args.RequestingAssembly.Location);
 357                                         compiler.Report.Error (1705, "Assembly `{0}' references `{1}' which has a higher version number than imported assembly `{2}'",
 358                                                 args.RequestingAssembly.FullName, refname, version_mismatch.GetName ().FullName);
 359
 360                                         return domain.CreateMissingAssembly (args.Name);
 361                                 }
 362
 363                                 if (!is_fx_assembly) {
 364                                         if (v1.Major != v2.Major || v1.Minor != v2.Minor) {
 365                                                 compiler.Report.Warning (1701, 2,
 366                                                         "Assuming assembly reference `{0}' matches assembly `{1}'. You may need to supply runtime policy",
 367                                                         refname, version_mismatch.GetName ().FullName);
 368                                         } else {
 369                                                 compiler.Report.Warning (1702, 3,
 370                                                         "Assuming assembly reference `{0}' matches assembly `{1}'. You may need to supply runtime policy",
 371                                                         refname, version_mismatch.GetName ().FullName);
 372                                         }
 373                                 }
 374
 375                                 return version_mismatch;
 376                         }
 377
 378                         //
 379                         // Recursive reference to compiled assembly checks name only. Any other
 380                         // details (PublicKey, Version, etc) are not yet known hence cannot be checked
 381                         //
 382                         ParsedAssemblyName referenced_assembly;
 383                         if (Fusion.ParseAssemblyName (args.Name, out referenced_assembly) == ParseAssemblyResult.OK && CompiledAssembly.Name == referenced_assembly.Name)
 384                                 return CompiledAssembly.Builder;
 385
 386                         // AssemblyReference has not been found in the domain
 387                         // create missing reference and continue
 388                         return domain.CreateMissingAssembly (args.Name);
 389                 }
 390
 391                 public void Dispose ()
 392                 {
 393                         domain.Dispose ();
 394                 }
 395
 396                 protected override string[] GetDefaultReferences ()
 397                 {
 398                         //
 399                         // For now the "default config" is harcoded into the compiler
 400                         // we can move this outside later
 401                         //
 402                         var default_references = new List<string> (4);
 403
 404                         default_references.Add ("System.dll");
 405                         default_references.Add ("System.Xml.dll");
 406                         default_references.Add ("System.Core.dll");
 407
 408                         if (corlib != null && corlib.GetName ().Version.Major >= 4) {
 409                                 default_references.Add ("Microsoft.CSharp.dll");
 410                         }
 411
 412                         return default_references.ToArray ();
 413                 }
 414
 415                 public override bool HasObjectType (Assembly assembly)
 416                 {
 417                         return assembly.GetType (compiler.BuiltinTypes.Object.FullName) != null;
 418                 }
 419
 420                 public override Assembly LoadAssemblyFile (string fileName, bool isImplicitReference)
 421                 {
 422                         bool? has_extension = null;
 423                         foreach (var path in paths) {
 424                                 var file = Path.Combine (path, fileName);
 425                                 if (compiler.Settings.DebugFlags > 0)
 426                                         Console.WriteLine ("Probing assembly location `{0}'", file);
 427
 428                                 if (!File.Exists (file)) {
 429                                         if (!has_extension.HasValue)
 430                                                 has_extension = fileName.EndsWith (".dll", StringComparison.Ordinal) || fileName.EndsWith (".exe", StringComparison.Ordinal);
 431
 432                                         if (has_extension.Value)
 433                                                 continue;
 434
 435                                         file += ".dll";
 436                                         if (!File.Exists (file))
 437                                                 continue;
 438                                 }
 439
 440                                 try {
 441                                         using (var stream = new FileStream (file, FileMode.Open, FileAccess.Read, FileShare.Read)) {
 442                                                 using (RawModule module = domain.OpenRawModule (stream, file)) {
 443                                                         if (!module.IsManifestModule) {
 444                                                                 Error_AssemblyIsModule (fileName);
 445                                                                 return null;
 446                                                         }
 447
 448                                                         //
 449                                                         // check whether the assembly can be actually imported without
 450                                                         // collision
 451                                                         //
 452                                                         var an = module.GetAssemblyName ();
 453                                                         foreach (var entry in loaded_names) {
 454                                                                 var loaded_name = entry.Item1;
 455                                                                 if (an.Name != loaded_name.Name)
 456                                                                         continue;
 457
 458                                                                 if (module.ModuleVersionId == entry.Item3.ManifestModule.ModuleVersionId)
 459                                                                         return entry.Item3;
 460
 461                                                                 if (((an.Flags | loaded_name.Flags) & AssemblyNameFlags.PublicKey) == 0) {
 462                                                                         compiler.Report.SymbolRelatedToPreviousError (entry.Item2);
 463                                                                         compiler.Report.SymbolRelatedToPreviousError (fileName);
 464                                                                         compiler.Report.Error (1704,
 465                                                                                 "An assembly with the same name `{0}' has already been imported. Consider removing one of the references or sign the assembly",
 466                                                                                 an.Name);
 467                                                                         return null;
 468                                                                 }
 469
 470                                                                 if ((an.Flags & AssemblyNameFlags.PublicKey) == (loaded_name.Flags & AssemblyNameFlags.PublicKey)) {
 471                                                                         compiler.Report.SymbolRelatedToPreviousError (entry.Item2);
 472                                                                         compiler.Report.SymbolRelatedToPreviousError (fileName);
 473                                                                         compiler.Report.Error (1703,
 474                                                                                 "An assembly `{0}' with the same identity has already been imported. Consider removing one of the references",
 475                                                                                 an.Name);
 476                                                                         return null;
 477                                                                 }
 478                                                         }
 479
 480                                                         if (compiler.Settings.DebugFlags > 0)
 481                                                                 Console.WriteLine ("Loading assembly `{0}'", fileName);
 482
 483                                                         var assembly = domain.LoadAssembly (module);
 484                                                         if (assembly != null)
 485                                                                 loaded_names.Add (Tuple.Create (an, fileName, assembly));
 486
 487                                                         return assembly;
 488                                                 }
 489                                         }
 490                                 } catch (Exception e) {
 491                                         if (compiler.Settings.DebugFlags > 0)
 492                                                 Console.WriteLine ("Exception during loading: {0}'", e.ToString ());
 493
 494                                         if (!isImplicitReference)
 495                                                 Error_FileCorrupted (file);
 496
 497                                         return null;
 498                                 }
 499                         }
 500
 501                         if (!isImplicitReference)
 502                                 Error_FileNotFound (fileName);
 503
 504                         return null;
 505                 }
 506
 507                 public RawModule LoadModuleFile (string moduleName)
 508                 {
 509                         foreach (var path in paths) {
 510                                 var file = Path.Combine (path, moduleName);
 511                                 if (!File.Exists (file)) {
 512                                         if (moduleName.EndsWith (".netmodule", StringComparison.Ordinal))
 513                                                 continue;
 514
 515                                         file += ".netmodule";
 516                                         if (!File.Exists (file))
 517                                                 continue;
 518                                 }
 519
 520                                 try {
 521                                         return domain.OpenRawModule (file);
 522                                 } catch {
 523                                         Error_FileCorrupted (file);
 524                                         return null;
 525                                 }
 526                         }
 527
 528                         Error_FileNotFound (moduleName);
 529                         return null;
 530                 }
 531
 532                 public override void LoadReferences (ModuleContainer module)
 533                 {
 534                         List<Tuple<RootNamespace, Assembly>> loaded;
 535                         base.LoadReferencesCore (module, out corlib, out loaded);
 536
 537                         compiler.TimeReporter.Start (TimeReporter.TimerType.ReferencesImporting);
 538
 539                         if (corlib == null) {
 540                                 // System.Object was not found in any referenced assembly, use compiled assembly as corlib
 541                                 corlib = module.DeclaringAssembly.Builder;
 542                         } else {
 543                                 importer.InitializeBuiltinTypes (compiler.BuiltinTypes, corlib);
 544                                 importer.ImportAssembly (corlib, module.GlobalRootNamespace);
 545                         }
 546
 547                         foreach (var entry in loaded) {
 548                                 importer.ImportAssembly (entry.Item2, entry.Item1);
 549                         }
 550
 551                         compiler.TimeReporter.Stop (TimeReporter.TimerType.ReferencesImporting);
 552                 }
 553
 554                 public void LoadModules (AssemblyDefinitionStatic assembly, RootNamespace targetNamespace)
 555                 {
 556                         foreach (var moduleName in compiler.Settings.Modules) {
 557                                 var m = LoadModuleFile (moduleName);
 558                                 if (m == null)
 559                                         continue;
 560
 561                                 if (m.IsManifestModule) {
 562                                         Error_ModuleIsAssembly (moduleName);
 563                                         continue;
 564                                 }
 565
 566                                 var md = importer.ImportModule (assembly.IncludeModule (m), targetNamespace);
 567                                 assembly.AddModule (md);
 568                         }
 569                 }
 570         }
 571
 572         class AssemblyBuilderIKVM : AssemblyBuilderExtension
 573         {
 574                 readonly AssemblyBuilder builder;
 575
 576                 public AssemblyBuilderIKVM (AssemblyBuilder builder, CompilerContext ctx)
 577                         : base (ctx)
 578                 {
 579                         this.builder = builder;
 580                 }
 581
 582                 public override void AddTypeForwarder (TypeSpec type, Location loc)
 583                 {
 584                         builder.__AddTypeForwarder (type.GetMetaInfo ());
 585                 }
 586
 587                 public override void DefineWin32IconResource (string fileName)
 588                 {
 589                         builder.__DefineIconResource (File.ReadAllBytes (fileName));
 590                 }
 591
 592                 public override void SetAlgorithmId (uint value, Location loc)
 593                 {
 594                         builder.__SetAssemblyAlgorithmId ((AssemblyHashAlgorithm) value);
 595                 }
 596
 597                 public override void SetCulture (string culture, Location loc)
 598                 {
 599                         builder.__SetAssemblyCulture (culture);
 600                 }
 601
 602                 public override void SetFlags (uint flags, Location loc)
 603                 {
 604                         builder.__AssemblyFlags = (AssemblyNameFlags) flags;
 605                 }
 606
 607                 public override void SetVersion (Version version, Location loc)
 608                 {
 609                         builder.__SetAssemblyVersion (version);
 610                 }
 611         }
 612 }