2 // codegen.cs: The code generator
5 // Miguel de Icaza (miguel@ximian.com)
7 // (C) 2001, 2002, 2003 Ximian, Inc.
8 // (C) 2004 Novell, Inc.
12 // Please leave this defined on SVN: The idea is that when we ship the
13 // compiler to end users, if the compiler crashes, they have a chance
14 // to narrow down the problem.
16 // Only remove it if you need to debug locally on your tree.
22 using System.Collections;
23 using System.Collections.Specialized;
24 using System.Globalization;
25 using System.Reflection;
26 using System.Reflection.Emit;
27 using System.Runtime.InteropServices;
28 using System.Security;
29 using System.Security.Cryptography;
30 using System.Security.Permissions;
32 using Mono.Security.Cryptography;
34 namespace Mono.CSharp {
37 /// Code generator class.
39 public class CodeGen {
40 static AppDomain current_domain;
41 static public SymbolWriter SymbolWriter;
43 public static AssemblyClass Assembly;
44 public static ModuleClass Module;
51 public static void Reset ()
53 Assembly = new AssemblyClass ();
54 Module = new ModuleClass (RootContext.Unsafe);
57 public static string Basename (string name)
59 int pos = name.LastIndexOf ('/');
62 return name.Substring (pos + 1);
64 pos = name.LastIndexOf ('\\');
66 return name.Substring (pos + 1);
71 public static string Dirname (string name)
73 int pos = name.LastIndexOf ('/');
76 return name.Substring (0, pos);
78 pos = name.LastIndexOf ('\\');
80 return name.Substring (0, pos);
85 static public string FileName;
88 // Initializes the symbol writer
90 static void InitializeSymbolWriter (string filename)
92 SymbolWriter = SymbolWriter.GetSymbolWriter (Module.Builder, filename);
95 // If we got an ISymbolWriter instance, initialize it.
97 if (SymbolWriter == null) {
99 -18, 1, "Could not find the symbol writer assembly (Mono.CompilerServices.SymbolWriter.dll). This is normally an installation problem. Please make sure to compile and install the mcs/class/Mono.CompilerServices.SymbolWriter directory.");
105 // Initializes the code generator variables
107 static public bool Init (string name, string output, bool want_debugging_support)
110 AssemblyName an = Assembly.GetAssemblyName (name, output);
114 if (an.KeyPair != null) {
115 // If we are going to strong name our assembly make
116 // sure all its refs are strong named
117 foreach (Assembly a in RootNamespace.Global.Assemblies) {
118 AssemblyName ref_name = a.GetName ();
119 byte [] b = ref_name.GetPublicKeyToken ();
120 if (b == null || b.Length == 0) {
121 Report.Error (1577, "Assembly generation failed " +
122 "-- Referenced assembly '" +
124 "' does not have a strong name.");
125 //Environment.Exit (1);
130 current_domain = AppDomain.CurrentDomain;
133 Assembly.Builder = current_domain.DefineDynamicAssembly (an,
134 AssemblyBuilderAccess.Save, Dirname (name));
136 catch (ArgumentException) {
137 // specified key may not be exportable outside it's container
138 if (RootContext.StrongNameKeyContainer != null) {
139 Report.Error (1548, "Could not access the key inside the container `" +
140 RootContext.StrongNameKeyContainer + "'.");
141 Environment.Exit (1);
145 catch (CryptographicException) {
146 if ((RootContext.StrongNameKeyContainer != null) || (RootContext.StrongNameKeyFile != null)) {
147 Report.Error (1548, "Could not use the specified key to strongname the assembly.");
148 Environment.Exit (1);
154 // Get the complete AssemblyName from the builder
155 // (We need to get the public key and token)
156 Assembly.Name = Assembly.Builder.GetName ();
160 // Pass a path-less name to DefineDynamicModule. Wonder how
161 // this copes with output in different directories then.
162 // FIXME: figure out how this copes with --output /tmp/blah
164 // If the third argument is true, the ModuleBuilder will dynamically
165 // load the default symbol writer.
167 Module.Builder = Assembly.Builder.DefineDynamicModule (
168 Basename (name), Basename (output), false);
170 if (want_debugging_support)
171 InitializeSymbolWriter (output);
176 static public void Save (string name)
179 Assembly.Builder.Save (Basename (name));
181 if (SymbolWriter != null)
182 SymbolWriter.WriteSymbolFile ();
184 catch (COMException) {
185 if ((RootContext.StrongNameKeyFile == null) || (!RootContext.StrongNameDelaySign))
188 // FIXME: it seems Microsoft AssemblyBuilder doesn't like to delay sign assemblies
189 Report.Error (1548, "Couldn't delay-sign the assembly with the '" +
190 RootContext.StrongNameKeyFile +
191 "', Use MCS with the Mono runtime or CSC to compile this assembly.");
193 catch (System.IO.IOException io) {
194 Report.Error (16, "Could not write to file `"+name+"', cause: " + io.Message);
196 catch (System.UnauthorizedAccessException ua) {
197 Report.Error (16, "Could not write to file `"+name+"', cause: " + ua.Message);
203 public interface IResolveContext
205 DeclSpace DeclContainer { get; }
206 bool IsInObsoleteScope { get; }
207 bool IsInUnsafeScope { get; }
209 // the declcontainer to lookup for type-parameters. Should only use LookupGeneric on it.
211 // FIXME: This is somewhat of a hack. We don't need a full DeclSpace for this. We just need the
212 // current type parameters in scope. IUIC, that will require us to rewrite GenericMethod.
213 // Maybe we can replace this with a 'LookupGeneric (string)' instead, but we'll have to
214 // handle generic method overrides differently
215 DeclSpace GenericDeclContainer { get; }
219 /// An Emit Context is created for each body of code (from methods,
220 /// properties bodies, indexer bodies or constructor bodies)
222 public class EmitContext : IResolveContext {
225 // Holds a varible used during collection or object initialization.
227 public Expression CurrentInitializerVariable;
229 DeclSpace decl_space;
231 public DeclSpace TypeContainer;
232 public ILGenerator ig;
235 public enum Flags : int {
237 /// This flag tracks the `checked' state of the compilation,
238 /// it controls whether we should generate code that does overflow
239 /// checking, or if we generate code that ignores overflows.
241 /// The default setting comes from the command line option to generate
242 /// checked or unchecked code plus any source code changes using the
243 /// checked/unchecked statements or expressions. Contrast this with
244 /// the ConstantCheckState flag.
249 /// The constant check state is always set to `true' and cant be changed
250 /// from the command line. The source code can change this setting with
251 /// the `checked' and `unchecked' statements and expressions.
253 ConstantCheckState = 1 << 1,
255 AllCheckStateFlags = CheckState | ConstantCheckState,
258 /// Whether we are inside an unsafe block
266 /// Whether control flow analysis is enabled
268 DoFlowAnalysis = 1 << 5,
271 /// Whether control flow analysis is disabled on structs
272 /// (only meaningful when DoFlowAnalysis is set)
274 OmitStructFlowAnalysis = 1 << 6,
277 /// Indicates the current context is in probing mode, no errors are reported.
279 ProbingMode = 1 << 7,
282 // Inside field intializer expression
284 InFieldInitializer = 1 << 8,
286 InferReturnType = 1 << 9
292 /// Whether we are emitting code inside a static or instance method
294 public bool IsStatic;
297 /// Whether the actual created method is static or instance method.
298 /// Althoug the method might be declared as `static', if an anonymous
299 /// method is involved, we might turn this into an instance method.
301 /// So this reflects the low-level staticness of the method, while
302 /// IsStatic represents the semantic, high-level staticness.
304 public bool MethodIsStatic;
307 /// The value that is allowed to be returned or NULL if there is no
313 /// Points to the Type (extracted from the TypeContainer) that
314 /// declares this body of code
316 public readonly Type ContainerType;
319 /// Whether this is generating code for a constructor
321 public bool IsConstructor;
324 /// Keeps track of the Type to LocalBuilder temporary storage created
325 /// to store structures (used to compute the address of the structure
326 /// value on structure method invocations)
328 public Hashtable temporary_storage;
330 public Block CurrentBlock;
332 public int CurrentFile;
335 /// The location where we store the return value.
337 LocalBuilder return_value;
340 /// The location where return has to jump to return the
343 public Label ReturnLabel;
346 /// If we already defined the ReturnLabel
348 public bool HasReturnLabel;
351 /// Whether we are inside an iterator block.
353 public bool InIterator;
356 /// Whether we are in a `fixed' initialization
358 public bool InFixedInitializer;
361 /// Whether we are inside an anonymous method.
363 public AnonymousContainer CurrentAnonymousMethod;
366 /// Location for this EmitContext
371 /// Inside an enum definition, we do not resolve enumeration values
372 /// to their enumerations, but rather to the underlying type/value
373 /// This is so EnumVal + EnumValB can be evaluated.
375 /// There is no "E operator + (E x, E y)", so during an enum evaluation
376 /// we relax the rules
378 public bool InEnumContext;
380 public readonly IResolveContext ResolveContext;
383 /// The current iterator
385 public Iterator CurrentIterator {
386 get { return CurrentAnonymousMethod as Iterator; }
390 /// Whether we are in the resolving stage or not
398 public static EmitContext TempEc;
400 bool isAnonymousMethodAllowed = true;
403 FlowBranching current_flow_branching;
405 static int next_id = 0;
408 public override string ToString ()
410 return String.Format ("EmitContext ({0}:{1})", id,
411 CurrentAnonymousMethod, loc);
414 public EmitContext (IResolveContext rc, DeclSpace parent, DeclSpace ds, Location l, ILGenerator ig,
415 Type return_type, int code_flags, bool is_constructor)
417 this.ResolveContext = rc;
420 TypeContainer = parent;
421 this.decl_space = ds;
422 if (RootContext.Checked)
423 flags |= Flags.CheckState;
424 flags |= Flags.ConstantCheckState;
426 if (return_type == null)
427 throw new ArgumentNullException ("return_type");
429 if ((return_type is TypeBuilder) && return_type.IsGenericTypeDefinition)
430 throw new InternalErrorException ();
433 IsStatic = (code_flags & Modifiers.STATIC) != 0;
434 MethodIsStatic = IsStatic;
435 InIterator = (code_flags & Modifiers.METHOD_YIELDS) != 0;
436 ReturnType = return_type;
437 IsConstructor = is_constructor;
440 current_phase = Phase.Created;
443 // Can only be null for the ResolveType contexts.
444 ContainerType = parent.TypeBuilder;
445 if (rc.IsInUnsafeScope)
446 flags |= Flags.InUnsafe;
451 public EmitContext (IResolveContext rc, DeclSpace ds, Location l, ILGenerator ig,
452 Type return_type, int code_flags, bool is_constructor)
453 : this (rc, ds, ds, l, ig, return_type, code_flags, is_constructor)
457 public EmitContext (IResolveContext rc, DeclSpace ds, Location l, ILGenerator ig,
458 Type return_type, int code_flags)
459 : this (rc, ds, ds, l, ig, return_type, code_flags, false)
463 public DeclSpace DeclContainer {
464 get { return decl_space; }
465 set { decl_space = value; }
468 public DeclSpace GenericDeclContainer {
469 get { return DeclContainer; }
472 public bool CheckState {
473 get { return (flags & Flags.CheckState) != 0; }
476 public bool ConstantCheckState {
477 get { return (flags & Flags.ConstantCheckState) != 0; }
480 public bool InUnsafe {
481 get { return (flags & Flags.InUnsafe) != 0; }
484 public bool InCatch {
485 get { return (flags & Flags.InCatch) != 0; }
488 public bool InFinally {
489 get { return (flags & Flags.InFinally) != 0; }
492 public bool DoFlowAnalysis {
493 get { return (flags & Flags.DoFlowAnalysis) != 0; }
496 public bool OmitStructFlowAnalysis {
497 get { return (flags & Flags.OmitStructFlowAnalysis) != 0; }
500 // utility helper for CheckExpr, UnCheckExpr, Checked and Unchecked statements
501 // it's public so that we can use a struct at the callsite
502 public struct FlagsHandle : IDisposable
505 readonly Flags invmask, oldval;
507 public FlagsHandle (EmitContext ec, Flags flagsToSet)
508 : this (ec, flagsToSet, flagsToSet)
512 internal FlagsHandle (EmitContext ec, Flags mask, Flags val)
516 oldval = ec.flags & mask;
517 ec.flags = (ec.flags & invmask) | (val & mask);
519 if ((mask & Flags.ProbingMode) != 0)
520 Report.DisableReporting ();
523 public void Dispose ()
525 if ((invmask & Flags.ProbingMode) == 0)
526 Report.EnableReporting ();
528 ec.flags = (ec.flags & invmask) | oldval;
532 // Temporarily set all the given flags to the given value. Should be used in an 'using' statement
533 public FlagsHandle Set (Flags flagsToSet)
535 return new FlagsHandle (this, flagsToSet);
538 public FlagsHandle With (Flags bits, bool enable)
540 return new FlagsHandle (this, bits, enable ? bits : 0);
543 public FlagsHandle WithFlowAnalysis (bool do_flow_analysis, bool omit_struct_analysis)
546 (do_flow_analysis ? Flags.DoFlowAnalysis : 0) |
547 (omit_struct_analysis ? Flags.OmitStructFlowAnalysis : 0);
548 return new FlagsHandle (this, Flags.DoFlowAnalysis | Flags.OmitStructFlowAnalysis, newflags);
552 /// If this is true, then Return and ContextualReturn statements
553 /// will set the ReturnType value based on the expression types
554 /// of each return statement instead of the method return type
555 /// (which is initially null).
557 public bool InferReturnType {
558 get { return (flags & Flags.InferReturnType) != 0; }
561 public bool IsInObsoleteScope {
563 // Disables obsolete checks when probing is on
564 return IsInProbingMode || ResolveContext.IsInObsoleteScope;
568 public bool IsInProbingMode {
569 get { return (flags & Flags.ProbingMode) != 0; }
572 public bool IsInUnsafeScope {
573 get { return InUnsafe || ResolveContext.IsInUnsafeScope; }
576 public bool IsAnonymousMethodAllowed {
577 get { return isAnonymousMethodAllowed; }
578 set { isAnonymousMethodAllowed = value; }
581 public bool IsInFieldInitializer {
582 get { return (flags & Flags.InFieldInitializer) != 0; }
585 public FlowBranching CurrentBranching {
586 get { return current_flow_branching; }
590 // Starts a new code branching. This inherits the state of all local
591 // variables and parameters from the current branching.
593 public FlowBranching StartFlowBranching (FlowBranching.BranchingType type, Location loc)
595 current_flow_branching = FlowBranching.CreateBranching (CurrentBranching, type, null, loc);
596 return current_flow_branching;
600 // Starts a new code branching for block `block'.
602 public FlowBranching StartFlowBranching (Block block)
604 FlowBranching.BranchingType type;
606 if ((CurrentBranching != null) &&
607 (CurrentBranching.Type == FlowBranching.BranchingType.Switch))
608 type = FlowBranching.BranchingType.SwitchSection;
610 type = FlowBranching.BranchingType.Block;
612 flags |= Flags.DoFlowAnalysis;
614 current_flow_branching = FlowBranching.CreateBranching (
615 CurrentBranching, type, block, block.StartLocation);
616 return current_flow_branching;
619 public FlowBranchingException StartFlowBranching (ExceptionStatement stmt)
621 FlowBranchingException branching = new FlowBranchingException (CurrentBranching, stmt);
622 current_flow_branching = branching;
626 public FlowBranchingLabeled StartFlowBranching (LabeledStatement stmt)
628 FlowBranchingLabeled branching = new FlowBranchingLabeled (CurrentBranching, stmt);
629 current_flow_branching = branching;
633 public FlowBranchingToplevel StartFlowBranching (ToplevelBlock stmt)
635 FlowBranchingToplevel branching = new FlowBranchingToplevel (CurrentBranching, stmt);
636 current_flow_branching = branching;
641 // Ends a code branching. Merges the state of locals and parameters
642 // from all the children of the ending branching.
644 public FlowBranching.UsageVector DoEndFlowBranching ()
646 FlowBranching old = current_flow_branching;
647 current_flow_branching = current_flow_branching.Parent;
649 return current_flow_branching.MergeChild (old);
653 // Ends a code branching. Merges the state of locals and parameters
654 // from all the children of the ending branching.
656 public bool EndFlowBranching ()
658 FlowBranching.UsageVector vector = DoEndFlowBranching ();
660 return vector.IsUnreachable;
664 // Kills the current code branching. This throws away any changed state
665 // information and should only be used in case of an error.
667 public void KillFlowBranching ()
669 current_flow_branching = current_flow_branching.Parent;
672 public bool MustCaptureVariable (LocalInfo local)
674 if (CurrentAnonymousMethod == null)
676 if (CurrentAnonymousMethod.IsIterator)
678 return local.Block.Toplevel != CurrentBlock.Toplevel;
681 public void EmitMeta (ToplevelBlock b)
686 ReturnLabel = ig.DefineLabel ();
690 // Here until we can fix the problem with Mono.CSharp.Switch, which
691 // currently can not cope with ig == null during resolve (which must
692 // be fixed for switch statements to work on anonymous methods).
694 public void EmitTopBlock (IMethodData md, ToplevelBlock block)
701 if (ResolveTopBlock (null, block, md.ParameterInfo, md, out unreachable)){
702 if (Report.Errors > 0)
707 current_phase = Phase.Emitting;
708 EmitResolvedTopBlock (block, unreachable);
714 public bool ResolveTopBlock (EmitContext anonymous_method_host, ToplevelBlock block,
715 Parameters ip, IMethodData md, out bool unreachable)
717 current_phase = Phase.Resolving;
725 CurrentFile = loc.File;
730 if (!block.ResolveMeta (this, ip))
733 if ((md != null) && (md.Iterator != null)) {
734 if (!md.Iterator.Define (this))
738 using (this.With (EmitContext.Flags.DoFlowAnalysis, true)) {
739 FlowBranchingToplevel top_level;
740 if (anonymous_method_host != null)
741 top_level = new FlowBranchingToplevel (anonymous_method_host.CurrentBranching, block);
743 top_level = block.TopLevelBranching;
745 current_flow_branching = top_level;
746 bool ok = block.Resolve (this);
747 current_flow_branching = null;
752 bool flow_unreachable = top_level.End ();
753 if (flow_unreachable)
757 } catch (Exception e) {
758 Console.WriteLine ("Exception caught by the compiler while compiling:");
759 Console.WriteLine (" Block that caused the problem begin at: " + loc);
761 if (CurrentBlock != null){
762 Console.WriteLine (" Block being compiled: [{0},{1}]",
763 CurrentBlock.StartLocation, CurrentBlock.EndLocation);
765 Console.WriteLine (e.GetType ().FullName + ": " + e.Message);
770 if (return_type != TypeManager.void_type && !unreachable) {
771 if (CurrentAnonymousMethod == null) {
772 Report.Error (161, md.Location, "`{0}': not all code paths return a value", md.GetSignatureForError ());
774 } else if (!CurrentAnonymousMethod.IsIterator) {
775 Report.Error (1643, CurrentAnonymousMethod.Location, "Not all code paths return a value in anonymous method of type `{0}'",
776 CurrentAnonymousMethod.GetSignatureForError ());
781 if (!block.CompleteContexts (this))
788 public Type ReturnType {
797 public void EmitResolvedTopBlock (ToplevelBlock block, bool unreachable)
803 ig.MarkLabel (ReturnLabel);
805 if (return_value != null){
806 ig.Emit (OpCodes.Ldloc, return_value);
807 ig.Emit (OpCodes.Ret);
810 // If `HasReturnLabel' is set, then we already emitted a
811 // jump to the end of the method, so we must emit a `ret'
814 // Unfortunately, System.Reflection.Emit automatically emits
815 // a leave to the end of a finally block. This is a problem
816 // if no code is following the try/finally block since we may
817 // jump to a point after the end of the method.
818 // As a workaround, we're always creating a return label in
822 bool in_iterator = (CurrentAnonymousMethod != null) &&
823 CurrentAnonymousMethod.IsIterator && InIterator;
825 if ((block != null) && block.IsDestructor) {
826 // Nothing to do; S.R.E automatically emits a leave.
827 } else if (HasReturnLabel || (!unreachable && !in_iterator)) {
828 if (return_type != TypeManager.void_type)
829 ig.Emit (OpCodes.Ldloc, TemporaryReturn ());
830 ig.Emit (OpCodes.Ret);
836 /// This is called immediately before emitting an IL opcode to tell the symbol
837 /// writer to which source line this opcode belongs.
839 public void Mark (Location loc, bool check_file)
841 if ((CodeGen.SymbolWriter == null) || loc.IsNull)
844 if (check_file && (CurrentFile != loc.File))
847 CodeGen.SymbolWriter.MarkSequencePoint (ig, loc.Row, loc.Column);
850 public void DefineLocalVariable (string name, LocalBuilder builder)
852 if (CodeGen.SymbolWriter == null)
855 CodeGen.SymbolWriter.DefineLocalVariable (name, builder);
858 public void BeginScope ()
862 if (CodeGen.SymbolWriter != null)
863 CodeGen.SymbolWriter.OpenScope(ig);
866 public void EndScope ()
870 if (CodeGen.SymbolWriter != null)
871 CodeGen.SymbolWriter.CloseScope(ig);
875 /// Returns a temporary storage for a variable of type t as
876 /// a local variable in the current body.
878 public LocalBuilder GetTemporaryLocal (Type t)
880 if (temporary_storage != null) {
881 object o = temporary_storage [t];
885 o = s.Count == 0 ? null : s.Pop ();
887 temporary_storage.Remove (t);
891 return (LocalBuilder) o;
893 return ig.DeclareLocal (t);
896 public void FreeTemporaryLocal (LocalBuilder b, Type t)
900 if (temporary_storage == null) {
901 temporary_storage = new Hashtable ();
902 temporary_storage [t] = b;
905 object o = temporary_storage [t];
907 temporary_storage [t] = b;
915 temporary_storage [t] = s;
921 /// Current loop begin and end labels.
923 public Label LoopBegin, LoopEnd;
926 /// Default target in a switch statement. Only valid if
929 public Label DefaultTarget;
932 /// If this is non-null, points to the current switch statement
934 public Switch Switch;
937 /// ReturnValue creates on demand the LocalBuilder for the
938 /// return value from the function. By default this is not
939 /// used. This is only required when returns are found inside
940 /// Try or Catch statements.
942 /// This method is typically invoked from the Emit phase, so
943 /// we allow the creation of a return label if it was not
944 /// requested during the resolution phase. Could be cleaned
945 /// up, but it would replicate a lot of logic in the Emit phase
946 /// of the code that uses it.
948 public LocalBuilder TemporaryReturn ()
950 if (return_value == null){
951 return_value = ig.DeclareLocal (return_type);
952 if (!HasReturnLabel){
953 ReturnLabel = ig.DefineLabel ();
954 HasReturnLabel = true;
962 /// This method is used during the Resolution phase to flag the
963 /// need to define the ReturnLabel
965 public void NeedReturnLabel ()
967 if (current_phase != Phase.Resolving){
969 // The reason is that the `ReturnLabel' is declared between
970 // resolution and emission
972 throw new Exception ("NeedReturnLabel called from Emit phase, should only be called during Resolve");
975 if (!InIterator && !HasReturnLabel)
976 HasReturnLabel = true;
980 public Expression GetThis (Location loc)
983 if (CurrentBlock != null)
984 my_this = new This (CurrentBlock, loc);
986 my_this = new This (loc);
988 if (!my_this.ResolveBase (this))
996 public abstract class CommonAssemblyModulClass : Attributable, IResolveContext {
998 protected CommonAssemblyModulClass ():
1003 public void AddAttributes (ArrayList attrs)
1005 foreach (Attribute a in attrs)
1008 if (attributes == null) {
1009 attributes = new Attributes (attrs);
1012 attributes.AddAttributes (attrs);
1015 public virtual void Emit (TypeContainer tc)
1017 if (OptAttributes == null)
1020 OptAttributes.Emit ();
1023 protected Attribute ResolveAttribute (Type a_type)
1025 Attribute a = OptAttributes.Search (a_type);
1032 public override IResolveContext ResolveContext {
1033 get { return this; }
1036 #region IResolveContext Members
1038 public DeclSpace DeclContainer {
1039 get { return RootContext.ToplevelTypes; }
1042 public DeclSpace GenericDeclContainer {
1043 get { return DeclContainer; }
1046 public bool IsInObsoleteScope {
1047 get { return false; }
1050 public bool IsInUnsafeScope {
1051 get { return false; }
1057 public class AssemblyClass : CommonAssemblyModulClass {
1058 // TODO: make it private and move all builder based methods here
1059 public AssemblyBuilder Builder;
1060 bool is_cls_compliant;
1061 bool wrap_non_exception_throws;
1063 public Attribute ClsCompliantAttribute;
1065 ListDictionary declarative_security;
1067 bool has_extension_method;
1068 public AssemblyName Name;
1069 MethodInfo add_type_forwarder;
1070 ListDictionary emitted_forwarders;
1073 // Module is here just because of error messages
1074 static string[] attribute_targets = new string [] { "assembly", "module" };
1076 public AssemblyClass (): base ()
1079 wrap_non_exception_throws = true;
1083 public bool HasExtensionMethods {
1086 has_extension_method = value;
1091 public bool IsClsCompliant {
1093 return is_cls_compliant;
1097 public bool WrapNonExceptionThrows {
1099 return wrap_non_exception_throws;
1103 public override AttributeTargets AttributeTargets {
1105 return AttributeTargets.Assembly;
1109 public override bool IsClsComplianceRequired ()
1111 return is_cls_compliant;
1114 public void Resolve ()
1116 if (OptAttributes == null)
1119 // Ensure that we only have GlobalAttributes, since the Search isn't safe with other types.
1120 if (!OptAttributes.CheckTargets())
1123 ClsCompliantAttribute = ResolveAttribute (TypeManager.cls_compliant_attribute_type);
1124 if (ClsCompliantAttribute != null) {
1125 is_cls_compliant = ClsCompliantAttribute.GetClsCompliantAttributeValue ();
1129 Attribute a = ResolveAttribute (TypeManager.runtime_compatibility_attr_type);
1131 object val = a.GetPropertyValue ("WrapNonExceptionThrows");
1133 wrap_non_exception_throws = (bool)val;
1139 private void SetPublicKey (AssemblyName an, byte[] strongNameBlob)
1142 // check for possible ECMA key
1143 if (strongNameBlob.Length == 16) {
1144 // will be rejected if not "the" ECMA key
1145 an.SetPublicKey (strongNameBlob);
1148 // take it, with or without, a private key
1149 RSA rsa = CryptoConvert.FromCapiKeyBlob (strongNameBlob);
1150 // and make sure we only feed the public part to Sys.Ref
1151 byte[] publickey = CryptoConvert.ToCapiPublicKeyBlob (rsa);
1153 // AssemblyName.SetPublicKey requires an additional header
1154 byte[] publicKeyHeader = new byte [12] { 0x00, 0x24, 0x00, 0x00, 0x04, 0x80, 0x00, 0x00, 0x94, 0x00, 0x00, 0x00 };
1156 byte[] encodedPublicKey = new byte [12 + publickey.Length];
1157 Buffer.BlockCopy (publicKeyHeader, 0, encodedPublicKey, 0, 12);
1158 Buffer.BlockCopy (publickey, 0, encodedPublicKey, 12, publickey.Length);
1159 an.SetPublicKey (encodedPublicKey);
1163 Error_AssemblySigning ("The specified file `" + RootContext.StrongNameKeyFile + "' is incorrectly encoded");
1164 Environment.Exit (1);
1168 // TODO: rewrite this code (to kill N bugs and make it faster) and use standard ApplyAttribute way.
1169 public AssemblyName GetAssemblyName (string name, string output)
1171 if (OptAttributes != null) {
1172 foreach (Attribute a in OptAttributes.Attrs) {
1173 // cannot rely on any resolve-based members before you call Resolve
1174 if (a.ExplicitTarget == null || a.ExplicitTarget != "assembly")
1177 // TODO: This code is buggy: comparing Attribute name without resolving is wrong.
1178 // However, this is invoked by CodeGen.Init, when none of the namespaces
1180 // TODO: Does not handle quoted attributes properly
1182 case "AssemblyKeyFile":
1183 case "AssemblyKeyFileAttribute":
1184 case "System.Reflection.AssemblyKeyFileAttribute":
1185 if (RootContext.StrongNameKeyFile != null) {
1186 Report.SymbolRelatedToPreviousError (a.Location, a.Name);
1187 Report.Warning (1616, 1, "Option `{0}' overrides attribute `{1}' given in a source file or added module",
1188 "keyfile", "System.Reflection.AssemblyKeyFileAttribute");
1191 string value = a.GetString ();
1192 if (value.Length != 0)
1193 RootContext.StrongNameKeyFile = value;
1196 case "AssemblyKeyName":
1197 case "AssemblyKeyNameAttribute":
1198 case "System.Reflection.AssemblyKeyNameAttribute":
1199 if (RootContext.StrongNameKeyContainer != null) {
1200 Report.SymbolRelatedToPreviousError (a.Location, a.Name);
1201 Report.Warning (1616, 1, "Option `{0}' overrides attribute `{1}' given in a source file or added module",
1202 "keycontainer", "System.Reflection.AssemblyKeyNameAttribute");
1205 string value = a.GetString ();
1206 if (value.Length != 0)
1207 RootContext.StrongNameKeyContainer = value;
1210 case "AssemblyDelaySign":
1211 case "AssemblyDelaySignAttribute":
1212 case "System.Reflection.AssemblyDelaySignAttribute":
1213 RootContext.StrongNameDelaySign = a.GetBoolean ();
1219 AssemblyName an = new AssemblyName ();
1220 an.Name = Path.GetFileNameWithoutExtension (name);
1222 // note: delay doesn't apply when using a key container
1223 if (RootContext.StrongNameKeyContainer != null) {
1224 an.KeyPair = new StrongNameKeyPair (RootContext.StrongNameKeyContainer);
1228 // strongname is optional
1229 if (RootContext.StrongNameKeyFile == null)
1232 string AssemblyDir = Path.GetDirectoryName (output);
1234 // the StrongName key file may be relative to (a) the compiled
1235 // file or (b) to the output assembly. See bugzilla #55320
1236 // http://bugzilla.ximian.com/show_bug.cgi?id=55320
1238 // (a) relative to the compiled file
1239 string filename = Path.GetFullPath (RootContext.StrongNameKeyFile);
1240 bool exist = File.Exists (filename);
1241 if ((!exist) && (AssemblyDir != null) && (AssemblyDir != String.Empty)) {
1242 // (b) relative to the outputed assembly
1243 filename = Path.GetFullPath (Path.Combine (AssemblyDir, RootContext.StrongNameKeyFile));
1244 exist = File.Exists (filename);
1248 using (FileStream fs = new FileStream (filename, FileMode.Open, FileAccess.Read)) {
1249 byte[] snkeypair = new byte [fs.Length];
1250 fs.Read (snkeypair, 0, snkeypair.Length);
1252 if (RootContext.StrongNameDelaySign) {
1253 // delayed signing - DO NOT include private key
1254 SetPublicKey (an, snkeypair);
1257 // no delay so we make sure we have the private key
1259 CryptoConvert.FromCapiPrivateKeyBlob (snkeypair);
1260 an.KeyPair = new StrongNameKeyPair (snkeypair);
1262 catch (CryptographicException) {
1263 if (snkeypair.Length == 16) {
1264 // error # is different for ECMA key
1265 Report.Error (1606, "Could not sign the assembly. " +
1266 "ECMA key can only be used to delay-sign assemblies");
1269 Error_AssemblySigning ("The specified file `" + RootContext.StrongNameKeyFile + "' does not have a private key");
1277 Error_AssemblySigning ("The specified file `" + RootContext.StrongNameKeyFile + "' does not exist");
1283 void Error_AssemblySigning (string text)
1285 Report.Error (1548, "Error during assembly signing. " + text);
1289 bool CheckInternalsVisibleAttribute (Attribute a)
1291 string assembly_name = a.GetString ();
1292 if (assembly_name.Length == 0)
1295 AssemblyName aname = null;
1297 aname = new AssemblyName (assembly_name);
1298 } catch (FileLoadException) {
1299 } catch (ArgumentException) {
1302 // Bad assembly name format
1304 Report.Warning (1700, 3, a.Location, "Assembly reference `" + assembly_name + "' is invalid and cannot be resolved");
1305 // Report error if we have defined Version or Culture
1306 else if (aname.Version != null || aname.CultureInfo != null)
1307 throw new Exception ("Friend assembly `" + a.GetString () +
1308 "' is invalid. InternalsVisibleTo cannot have version or culture specified.");
1309 else if (aname.GetPublicKey () == null && Name.GetPublicKey () != null) {
1310 Report.Error (1726, a.Location, "Friend assembly reference `" + aname.FullName + "' is invalid." +
1311 " Strong named assemblies must specify a public key in their InternalsVisibleTo declarations");
1319 static bool IsValidAssemblyVersion (string version)
1323 v = new Version (version);
1326 int major = int.Parse (version, CultureInfo.InvariantCulture);
1327 v = new Version (major, 0);
1333 foreach (int candidate in new int [] { v.Major, v.Minor, v.Build, v.Revision }) {
1334 if (candidate > ushort.MaxValue)
1341 public override void ApplyAttributeBuilder (Attribute a, CustomAttributeBuilder customBuilder)
1343 if (a.Type.IsSubclassOf (TypeManager.security_attr_type) && a.CheckSecurityActionValidity (true)) {
1344 if (declarative_security == null)
1345 declarative_security = new ListDictionary ();
1347 a.ExtractSecurityPermissionSet (declarative_security);
1351 if (a.Type == TypeManager.assembly_culture_attribute_type) {
1352 string value = a.GetString ();
1353 if (value == null || value.Length == 0)
1356 if (RootContext.Target == Target.Exe) {
1357 a.Error_AttributeEmitError ("The executables cannot be satelite assemblies, remove the attribute or keep it empty");
1362 if (a.Type == TypeManager.assembly_version_attribute_type) {
1363 string value = a.GetString ();
1364 if (value == null || value.Length == 0)
1367 value = value.Replace ('*', '0');
1369 if (!IsValidAssemblyVersion (value)) {
1370 a.Error_AttributeEmitError (string.Format ("Specified version `{0}' is not valid", value));
1376 if (a.Type == TypeManager.internals_visible_attr_type && !CheckInternalsVisibleAttribute (a))
1379 if (a.Type == TypeManager.type_forwarder_attr_type) {
1380 Type t = a.GetArgumentType ();
1381 if (t == null || TypeManager.HasElementType (t)) {
1382 Report.Error (735, a.Location, "Invalid type specified as an argument for TypeForwardedTo attribute");
1386 if (emitted_forwarders == null) {
1387 emitted_forwarders = new ListDictionary();
1388 } else if (emitted_forwarders.Contains(t)) {
1389 Report.SymbolRelatedToPreviousError(((Attribute)emitted_forwarders[t]).Location, null);
1390 Report.Error(739, a.Location, "A duplicate type forward of type `{0}'",
1391 TypeManager.CSharpName(t));
1395 emitted_forwarders.Add(t, a);
1397 if (TypeManager.LookupDeclSpace (t) != null) {
1398 Report.SymbolRelatedToPreviousError (t);
1399 Report.Error (729, a.Location, "Cannot forward type `{0}' because it is defined in this assembly",
1400 TypeManager.CSharpName (t));
1405 Report.Error (730, a.Location, "Cannot forward type `{0}' because it is a nested type",
1406 TypeManager.CSharpName (t));
1410 if (t.IsGenericType) {
1411 Report.Error (733, a.Location, "Cannot forward generic type `{0}'", TypeManager.CSharpName (t));
1415 if (add_type_forwarder == null) {
1416 add_type_forwarder = typeof (AssemblyBuilder).GetMethod ("AddTypeForwarder",
1417 BindingFlags.NonPublic | BindingFlags.Instance);
1419 if (add_type_forwarder == null) {
1420 Report.RuntimeMissingSupport (a.Location, "TypeForwardedTo attribute");
1425 add_type_forwarder.Invoke (Builder, new object[] { t });
1429 if (a.Type == TypeManager.extension_attribute_type) {
1430 a.Error_MisusedExtensionAttribute ();
1434 Builder.SetCustomAttribute (customBuilder);
1437 public override void Emit (TypeContainer tc)
1442 if (has_extension_method)
1443 Builder.SetCustomAttribute (TypeManager.extension_attribute_attr);
1445 // FIXME: Does this belong inside SRE.AssemblyBuilder instead?
1446 if (OptAttributes == null || !OptAttributes.Contains (TypeManager.runtime_compatibility_attr_type)) {
1447 ConstructorInfo ci = TypeManager.GetConstructor (
1448 TypeManager.runtime_compatibility_attr_type, Type.EmptyTypes);
1449 PropertyInfo [] pis = new PropertyInfo [1];
1450 pis [0] = TypeManager.GetProperty (
1451 TypeManager.runtime_compatibility_attr_type, "WrapNonExceptionThrows");
1452 object [] pargs = new object [1];
1454 Builder.SetCustomAttribute (new CustomAttributeBuilder (ci, new object [0], pis, pargs));
1458 if (declarative_security != null) {
1460 MethodInfo add_permission = typeof (AssemblyBuilder).GetMethod ("AddPermissionRequests", BindingFlags.Instance | BindingFlags.NonPublic);
1461 object builder_instance = Builder;
1464 // Microsoft runtime hacking
1465 if (add_permission == null) {
1466 Type assembly_builder = typeof (AssemblyBuilder).Assembly.GetType ("System.Reflection.Emit.AssemblyBuilderData");
1467 add_permission = assembly_builder.GetMethod ("AddPermissionRequests", BindingFlags.Instance | BindingFlags.NonPublic);
1469 FieldInfo fi = typeof (AssemblyBuilder).GetField ("m_assemblyData", BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.GetField);
1470 builder_instance = fi.GetValue (Builder);
1473 object[] args = new object [] { declarative_security [SecurityAction.RequestMinimum],
1474 declarative_security [SecurityAction.RequestOptional],
1475 declarative_security [SecurityAction.RequestRefuse] };
1476 add_permission.Invoke (builder_instance, args);
1479 Report.RuntimeMissingSupport (Location.Null, "assembly permission setting");
1484 public override string[] ValidAttributeTargets {
1486 return attribute_targets;
1490 // Wrapper for AssemblyBuilder.AddModule
1491 static MethodInfo adder_method;
1492 static public MethodInfo AddModule_Method {
1494 if (adder_method == null)
1495 adder_method = typeof (AssemblyBuilder).GetMethod ("AddModule", BindingFlags.Instance|BindingFlags.NonPublic);
1496 return adder_method;
1499 public Module AddModule (string module)
1501 MethodInfo m = AddModule_Method;
1503 Report.RuntimeMissingSupport (Location.Null, "/addmodule");
1504 Environment.Exit (1);
1508 return (Module) m.Invoke (Builder, new object [] { module });
1509 } catch (TargetInvocationException ex) {
1510 throw ex.InnerException;
1515 public class ModuleClass : CommonAssemblyModulClass {
1516 // TODO: make it private and move all builder based methods here
1517 public ModuleBuilder Builder;
1518 bool m_module_is_unsafe;
1519 bool has_default_charset;
1521 public CharSet DefaultCharSet = CharSet.Ansi;
1522 public TypeAttributes DefaultCharSetType = TypeAttributes.AnsiClass;
1524 static string[] attribute_targets = new string [] { "module" };
1526 public ModuleClass (bool is_unsafe)
1528 m_module_is_unsafe = is_unsafe;
1531 public override AttributeTargets AttributeTargets {
1533 return AttributeTargets.Module;
1537 public override bool IsClsComplianceRequired ()
1539 return CodeGen.Assembly.IsClsCompliant;
1542 public override void Emit (TypeContainer tc)
1546 if (!m_module_is_unsafe)
1549 if (TypeManager.unverifiable_code_ctor == null) {
1550 Console.WriteLine ("Internal error ! Cannot set unverifiable code attribute.");
1554 Builder.SetCustomAttribute (new CustomAttributeBuilder (TypeManager.unverifiable_code_ctor, new object [0]));
1557 public override void ApplyAttributeBuilder (Attribute a, CustomAttributeBuilder customBuilder)
1559 if (a.Type == TypeManager.cls_compliant_attribute_type) {
1560 if (CodeGen.Assembly.ClsCompliantAttribute == null) {
1561 Report.Warning (3012, 1, a.Location, "You must specify the CLSCompliant attribute on the assembly, not the module, to enable CLS compliance checking");
1563 else if (CodeGen.Assembly.IsClsCompliant != a.GetBoolean ()) {
1564 Report.SymbolRelatedToPreviousError (CodeGen.Assembly.ClsCompliantAttribute.Location, CodeGen.Assembly.ClsCompliantAttribute.GetSignatureForError ());
1565 Report.Error (3017, a.Location, "You cannot specify the CLSCompliant attribute on a module that differs from the CLSCompliant attribute on the assembly");
1570 Builder.SetCustomAttribute (customBuilder);
1573 public bool HasDefaultCharSet {
1575 return has_default_charset;
1580 /// It is called very early therefore can resolve only predefined attributes
1582 public void Resolve ()
1585 if (OptAttributes == null)
1588 if (!OptAttributes.CheckTargets())
1591 Attribute a = ResolveAttribute (TypeManager.default_charset_type);
1593 has_default_charset = true;
1594 DefaultCharSet = a.GetCharSetValue ();
1595 switch (DefaultCharSet) {
1600 DefaultCharSetType = TypeAttributes.AutoClass;
1602 case CharSet.Unicode:
1603 DefaultCharSetType = TypeAttributes.UnicodeClass;
1606 Report.Error (1724, a.Location, "Value specified for the argument to 'System.Runtime.InteropServices.DefaultCharSetAttribute' is not valid");
1613 public override string[] ValidAttributeTargets {
1615 return attribute_targets;