2 // codegen.cs: The code generator
5 // Miguel de Icaza (miguel@ximian.com)
7 // Copyright 2001, 2002, 2003 Ximian, Inc.
8 // Copyright 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;
42 public static AssemblyClass Assembly;
49 public static void Reset ()
51 Assembly = new AssemblyClass ();
54 public static string Basename (string name)
56 int pos = name.LastIndexOf ('/');
59 return name.Substring (pos + 1);
61 pos = name.LastIndexOf ('\\');
63 return name.Substring (pos + 1);
68 public static string Dirname (string name)
70 int pos = name.LastIndexOf ('/');
73 return name.Substring (0, pos);
75 pos = name.LastIndexOf ('\\');
77 return name.Substring (0, pos);
82 static public string FileName;
85 const AssemblyBuilderAccess COMPILER_ACCESS = 0;
87 /* Keep this in sync with System.Reflection.Emit.AssemblyBuilder */
88 const AssemblyBuilderAccess COMPILER_ACCESS = (AssemblyBuilderAccess) 0x800;
92 // Initializes the code generator variables for interactive use (repl)
94 static public void InitDynamic (string name)
96 current_domain = AppDomain.CurrentDomain;
97 AssemblyName an = Assembly.GetAssemblyName (name, name);
99 Assembly.Builder = current_domain.DefineDynamicAssembly (an, AssemblyBuilderAccess.Run | COMPILER_ACCESS);
100 RootContext.ToplevelTypes = new ModuleContainer (true);
101 RootContext.ToplevelTypes.Builder = Assembly.Builder.DefineDynamicModule (Basename (name), false);
102 Assembly.Name = Assembly.Builder.GetName ();
106 // Initializes the code generator variables
108 static public bool Init (string name, string output, bool want_debugging_support)
111 AssemblyName an = Assembly.GetAssemblyName (name, output);
115 if (an.KeyPair != null) {
116 // If we are going to strong name our assembly make
117 // sure all its refs are strong named
118 foreach (Assembly a in GlobalRootNamespace.Instance.Assemblies) {
119 AssemblyName ref_name = a.GetName ();
120 byte [] b = ref_name.GetPublicKeyToken ();
121 if (b == null || b.Length == 0) {
122 Report.Error (1577, "Assembly generation failed " +
123 "-- Referenced assembly '" +
125 "' does not have a strong name.");
126 //Environment.Exit (1);
131 current_domain = AppDomain.CurrentDomain;
134 Assembly.Builder = current_domain.DefineDynamicAssembly (an,
135 AssemblyBuilderAccess.RunAndSave | COMPILER_ACCESS, Dirname (name));
137 catch (ArgumentException) {
138 // specified key may not be exportable outside it's container
139 if (RootContext.StrongNameKeyContainer != null) {
140 Report.Error (1548, "Could not access the key inside the container `" +
141 RootContext.StrongNameKeyContainer + "'.");
142 Environment.Exit (1);
146 catch (CryptographicException) {
147 if ((RootContext.StrongNameKeyContainer != null) || (RootContext.StrongNameKeyFile != null)) {
148 Report.Error (1548, "Could not use the specified key to strongname the assembly.");
149 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 ();
159 // Pass a path-less name to DefineDynamicModule. Wonder how
160 // this copes with output in different directories then.
161 // FIXME: figure out how this copes with --output /tmp/blah
163 // If the third argument is true, the ModuleBuilder will dynamically
164 // load the default symbol writer.
167 RootContext.ToplevelTypes.Builder = Assembly.Builder.DefineDynamicModule (
168 Basename (name), Basename (output), want_debugging_support);
171 // TODO: We should use SymbolWriter from DefineDynamicModule
172 if (want_debugging_support && !SymbolWriter.Initialize (RootContext.ToplevelTypes.Builder, output)) {
173 Report.Error (40, "Unexpected debug information initialization error `{0}'",
174 "Could not find the symbol writer assembly (Mono.CompilerServices.SymbolWriter.dll)");
178 } catch (ExecutionEngineException e) {
179 Report.Error (40, "Unexpected debug information initialization error `{0}'",
187 static public void Save (string name, bool saveDebugInfo)
190 Assembly.Builder.Save (Basename (name));
192 catch (COMException) {
193 if ((RootContext.StrongNameKeyFile == null) || (!RootContext.StrongNameDelaySign))
196 // FIXME: it seems Microsoft AssemblyBuilder doesn't like to delay sign assemblies
197 Report.Error (1548, "Couldn't delay-sign the assembly with the '" +
198 RootContext.StrongNameKeyFile +
199 "', Use MCS with the Mono runtime or CSC to compile this assembly.");
201 catch (System.IO.IOException io) {
202 Report.Error (16, "Could not write to file `"+name+"', cause: " + io.Message);
205 catch (System.UnauthorizedAccessException ua) {
206 Report.Error (16, "Could not write to file `"+name+"', cause: " + ua.Message);
211 // Write debuger symbol file
214 SymbolWriter.WriteSymbolFile ();
220 /// An interface to hold all the information needed in the resolving phase.
222 public interface IResolveContext
224 DeclSpace DeclContainer { get; }
225 bool IsInObsoleteScope { get; }
226 bool IsInUnsafeScope { get; }
228 // the declcontainer to lookup for type-parameters. Should only use LookupGeneric on it.
230 // FIXME: This is somewhat of a hack. We don't need a full DeclSpace for this. We just need the
231 // current type parameters in scope. IUIC, that will require us to rewrite GenericMethod.
232 // Maybe we can replace this with a 'LookupGeneric (string)' instead, but we'll have to
233 // handle generic method overrides differently
234 DeclSpace GenericDeclContainer { get; }
238 /// An Emit Context is created for each body of code (from methods,
239 /// properties bodies, indexer bodies or constructor bodies)
241 public class EmitContext : IResolveContext {
244 // Holds a varible used during collection or object initialization.
246 public Expression CurrentInitializerVariable;
248 DeclSpace decl_space;
250 public DeclSpace TypeContainer;
251 public ILGenerator ig;
254 public enum Flags : int {
256 /// This flag tracks the `checked' state of the compilation,
257 /// it controls whether we should generate code that does overflow
258 /// checking, or if we generate code that ignores overflows.
260 /// The default setting comes from the command line option to generate
261 /// checked or unchecked code plus any source code changes using the
262 /// checked/unchecked statements or expressions. Contrast this with
263 /// the ConstantCheckState flag.
268 /// The constant check state is always set to `true' and cant be changed
269 /// from the command line. The source code can change this setting with
270 /// the `checked' and `unchecked' statements and expressions.
272 ConstantCheckState = 1 << 1,
274 AllCheckStateFlags = CheckState | ConstantCheckState,
277 /// Whether we are inside an unsafe block
285 /// Whether control flow analysis is enabled
287 DoFlowAnalysis = 1 << 5,
290 /// Whether control flow analysis is disabled on structs
291 /// (only meaningful when DoFlowAnalysis is set)
293 OmitStructFlowAnalysis = 1 << 6,
296 /// Indicates the current context is in probing mode, no errors are reported.
298 ProbingMode = 1 << 7,
301 // Inside field intializer expression
303 InFieldInitializer = 1 << 8,
305 InferReturnType = 1 << 9,
307 InCompoundAssignment = 1 << 10,
309 OmitDebuggingInfo = 1 << 11
315 /// Whether we are emitting code inside a static or instance method
317 public bool IsStatic;
320 /// Whether the actual created method is static or instance method.
321 /// Althoug the method might be declared as `static', if an anonymous
322 /// method is involved, we might turn this into an instance method.
324 /// So this reflects the low-level staticness of the method, while
325 /// IsStatic represents the semantic, high-level staticness.
327 //public bool MethodIsStatic;
330 /// The value that is allowed to be returned or NULL if there is no
336 /// Points to the Type (extracted from the TypeContainer) that
337 /// declares this body of code
339 public readonly Type ContainerType;
342 /// Whether this is generating code for a constructor
344 public bool IsConstructor;
347 /// Keeps track of the Type to LocalBuilder temporary storage created
348 /// to store structures (used to compute the address of the structure
349 /// value on structure method invocations)
351 public Hashtable temporary_storage;
353 public Block CurrentBlock;
355 public int CurrentFile;
358 /// The location where we store the return value.
360 LocalBuilder return_value;
363 /// The location where return has to jump to return the
366 public Label ReturnLabel;
369 /// If we already defined the ReturnLabel
371 public bool HasReturnLabel;
374 /// Whether we are in a `fixed' initialization
376 public bool InFixedInitializer;
379 /// Whether we are inside an anonymous method.
381 public AnonymousExpression CurrentAnonymousMethod;
384 /// Location for this EmitContext
389 /// Inside an enum definition, we do not resolve enumeration values
390 /// to their enumerations, but rather to the underlying type/value
391 /// This is so EnumVal + EnumValB can be evaluated.
393 /// There is no "E operator + (E x, E y)", so during an enum evaluation
394 /// we relax the rules
396 public bool InEnumContext;
398 public readonly IResolveContext ResolveContext;
401 /// The current iterator
403 public Iterator CurrentIterator {
404 get { return CurrentAnonymousMethod as Iterator; }
408 /// Whether we are in the resolving stage or not
416 bool isAnonymousMethodAllowed = true;
419 FlowBranching current_flow_branching;
421 static int next_id = 0;
424 public override string ToString ()
426 return String.Format ("EmitContext ({0}:{1})", id,
427 CurrentAnonymousMethod, loc);
430 public EmitContext (IResolveContext rc, DeclSpace parent, DeclSpace ds, Location l, ILGenerator ig,
431 Type return_type, int code_flags, bool is_constructor)
433 this.ResolveContext = rc;
436 TypeContainer = parent;
437 this.decl_space = ds;
438 if (RootContext.Checked)
439 flags |= Flags.CheckState;
440 flags |= Flags.ConstantCheckState;
442 if (return_type == null)
443 throw new ArgumentNullException ("return_type");
445 IsStatic = (code_flags & Modifiers.STATIC) != 0;
446 ReturnType = return_type;
447 IsConstructor = is_constructor;
450 current_phase = Phase.Created;
453 // Can only be null for the ResolveType contexts.
454 ContainerType = parent.TypeBuilder;
455 if (rc.IsInUnsafeScope)
456 flags |= Flags.InUnsafe;
461 public EmitContext (IResolveContext rc, DeclSpace ds, Location l, ILGenerator ig,
462 Type return_type, int code_flags, bool is_constructor)
463 : this (rc, ds, ds, l, ig, return_type, code_flags, is_constructor)
467 public EmitContext (IResolveContext rc, DeclSpace ds, Location l, ILGenerator ig,
468 Type return_type, int code_flags)
469 : this (rc, ds, ds, l, ig, return_type, code_flags, false)
473 // IResolveContext.DeclContainer
474 public DeclSpace DeclContainer {
475 get { return decl_space; }
476 set { decl_space = value; }
479 // IResolveContext.GenericDeclContainer
480 public DeclSpace GenericDeclContainer {
481 get { return DeclContainer; }
484 public bool CheckState {
485 get { return (flags & Flags.CheckState) != 0; }
488 public bool ConstantCheckState {
489 get { return (flags & Flags.ConstantCheckState) != 0; }
492 public bool InUnsafe {
493 get { return (flags & Flags.InUnsafe) != 0; }
496 public bool InCatch {
497 get { return (flags & Flags.InCatch) != 0; }
500 public bool InFinally {
501 get { return (flags & Flags.InFinally) != 0; }
504 public bool DoFlowAnalysis {
505 get { return (flags & Flags.DoFlowAnalysis) != 0; }
508 public bool OmitStructFlowAnalysis {
509 get { return (flags & Flags.OmitStructFlowAnalysis) != 0; }
512 // utility helper for CheckExpr, UnCheckExpr, Checked and Unchecked statements
513 // it's public so that we can use a struct at the callsite
514 public struct FlagsHandle : IDisposable
517 readonly Flags invmask, oldval;
519 public FlagsHandle (EmitContext ec, Flags flagsToSet)
520 : this (ec, flagsToSet, flagsToSet)
524 internal FlagsHandle (EmitContext ec, Flags mask, Flags val)
528 oldval = ec.flags & mask;
529 ec.flags = (ec.flags & invmask) | (val & mask);
531 if ((mask & Flags.ProbingMode) != 0)
532 Report.DisableReporting ();
535 public void Dispose ()
537 if ((invmask & Flags.ProbingMode) == 0)
538 Report.EnableReporting ();
540 ec.flags = (ec.flags & invmask) | oldval;
544 // Temporarily set all the given flags to the given value. Should be used in an 'using' statement
545 public FlagsHandle Set (Flags flagsToSet)
547 return new FlagsHandle (this, flagsToSet);
550 public FlagsHandle With (Flags bits, bool enable)
552 return new FlagsHandle (this, bits, enable ? bits : 0);
555 public FlagsHandle WithFlowAnalysis (bool do_flow_analysis, bool omit_struct_analysis)
558 (do_flow_analysis ? Flags.DoFlowAnalysis : 0) |
559 (omit_struct_analysis ? Flags.OmitStructFlowAnalysis : 0);
560 return new FlagsHandle (this, Flags.DoFlowAnalysis | Flags.OmitStructFlowAnalysis, newflags);
564 /// If this is true, then Return and ContextualReturn statements
565 /// will set the ReturnType value based on the expression types
566 /// of each return statement instead of the method return type
567 /// (which is initially null).
569 public bool InferReturnType {
570 get { return (flags & Flags.InferReturnType) != 0; }
573 // IResolveContext.IsInObsoleteScope
574 public bool IsInObsoleteScope {
576 // Disables obsolete checks when probing is on
577 return IsInProbingMode || ResolveContext.IsInObsoleteScope;
581 public bool IsInProbingMode {
582 get { return (flags & Flags.ProbingMode) != 0; }
585 // IResolveContext.IsInUnsafeScope
586 public bool IsInUnsafeScope {
587 get { return InUnsafe || ResolveContext.IsInUnsafeScope; }
590 public bool IsAnonymousMethodAllowed {
591 get { return isAnonymousMethodAllowed; }
592 set { isAnonymousMethodAllowed = value; }
595 public bool IsInFieldInitializer {
596 get { return (flags & Flags.InFieldInitializer) != 0; }
599 public bool IsInCompoundAssignment {
600 get { return (flags & Flags.InCompoundAssignment) != 0; }
603 public bool IsVariableCapturingRequired {
605 return !IsInProbingMode && (CurrentBranching == null || !CurrentBranching.CurrentUsageVector.IsUnreachable);
609 public FlowBranching CurrentBranching {
610 get { return current_flow_branching; }
613 public bool OmitDebuggingInfo {
614 get { return (flags & Flags.OmitDebuggingInfo) != 0; }
617 flags |= Flags.OmitDebuggingInfo;
619 flags &= ~Flags.OmitDebuggingInfo;
624 // Starts a new code branching. This inherits the state of all local
625 // variables and parameters from the current branching.
627 public FlowBranching StartFlowBranching (FlowBranching.BranchingType type, Location loc)
629 current_flow_branching = FlowBranching.CreateBranching (CurrentBranching, type, null, loc);
630 return current_flow_branching;
634 // Starts a new code branching for block `block'.
636 public FlowBranching StartFlowBranching (Block block)
638 flags |= Flags.DoFlowAnalysis;
640 current_flow_branching = FlowBranching.CreateBranching (
641 CurrentBranching, FlowBranching.BranchingType.Block, block, block.StartLocation);
642 return current_flow_branching;
645 public FlowBranchingTryCatch StartFlowBranching (TryCatch stmt)
647 FlowBranchingTryCatch branching = new FlowBranchingTryCatch (CurrentBranching, stmt);
648 current_flow_branching = branching;
652 public FlowBranchingException StartFlowBranching (ExceptionStatement stmt)
654 FlowBranchingException branching = new FlowBranchingException (CurrentBranching, stmt);
655 current_flow_branching = branching;
659 public FlowBranchingLabeled StartFlowBranching (LabeledStatement stmt)
661 FlowBranchingLabeled branching = new FlowBranchingLabeled (CurrentBranching, stmt);
662 current_flow_branching = branching;
666 public FlowBranchingIterator StartFlowBranching (Iterator iterator)
668 FlowBranchingIterator branching = new FlowBranchingIterator (CurrentBranching, iterator);
669 current_flow_branching = branching;
673 public FlowBranchingToplevel StartFlowBranching (ToplevelBlock stmt)
675 FlowBranchingToplevel branching = new FlowBranchingToplevel (CurrentBranching, stmt);
676 current_flow_branching = branching;
681 // Ends a code branching. Merges the state of locals and parameters
682 // from all the children of the ending branching.
684 public bool EndFlowBranching ()
686 FlowBranching old = current_flow_branching;
687 current_flow_branching = current_flow_branching.Parent;
689 FlowBranching.UsageVector vector = current_flow_branching.MergeChild (old);
690 return vector.IsUnreachable;
694 // Kills the current code branching. This throws away any changed state
695 // information and should only be used in case of an error.
697 // FIXME: this is evil
698 public void KillFlowBranching ()
700 current_flow_branching = current_flow_branching.Parent;
703 public bool MustCaptureVariable (LocalInfo local)
705 if (CurrentAnonymousMethod == null)
708 // FIXME: IsIterator is too aggressive, we should capture only if child
709 // block contains yield
710 if (CurrentAnonymousMethod.IsIterator)
713 return local.Block.Toplevel != CurrentBlock.Toplevel;
716 public void EmitMeta (ToplevelBlock b)
721 ReturnLabel = ig.DefineLabel ();
725 // Here until we can fix the problem with Mono.CSharp.Switch, which
726 // currently can not cope with ig == null during resolve (which must
727 // be fixed for switch statements to work on anonymous methods).
729 public void EmitTopBlock (IMethodData md, ToplevelBlock block)
736 if (ResolveTopBlock (null, block, md.ParameterInfo, md, out unreachable)){
737 if (Report.Errors > 0)
742 current_phase = Phase.Emitting;
746 EmitResolvedTopBlock (block, unreachable);
748 } catch (Exception e){
749 Console.WriteLine ("Exception caught by the compiler while emitting:");
750 Console.WriteLine (" Block that caused the problem begin at: " + block.loc);
752 Console.WriteLine (e.GetType ().FullName + ": " + e.Message);
762 public bool ResolveTopBlock (EmitContext anonymous_method_host, ToplevelBlock block,
763 ParametersCompiled ip, IMethodData md, out bool unreachable)
766 unreachable = this.unreachable;
770 current_phase = Phase.Resolving;
774 CurrentFile = loc.File;
779 if (!block.ResolveMeta (this, ip))
782 using (this.With (EmitContext.Flags.DoFlowAnalysis, true)) {
783 FlowBranchingToplevel top_level;
784 if (anonymous_method_host != null)
785 top_level = new FlowBranchingToplevel (anonymous_method_host.CurrentBranching, block);
787 top_level = block.TopLevelBranching;
789 current_flow_branching = top_level;
790 bool ok = block.Resolve (this);
791 current_flow_branching = null;
796 bool flow_unreachable = top_level.End ();
797 if (flow_unreachable)
798 this.unreachable = unreachable = true;
801 } catch (Exception e) {
802 Console.WriteLine ("Exception caught by the compiler while compiling:");
803 Console.WriteLine (" Block that caused the problem begin at: " + loc);
805 if (CurrentBlock != null){
806 Console.WriteLine (" Block being compiled: [{0},{1}]",
807 CurrentBlock.StartLocation, CurrentBlock.EndLocation);
809 Console.WriteLine (e.GetType ().FullName + ": " + e.Message);
814 if (return_type != TypeManager.void_type && !unreachable) {
815 if (CurrentAnonymousMethod == null) {
816 Report.Error (161, md.Location, "`{0}': not all code paths return a value", md.GetSignatureForError ());
818 } else if (!CurrentAnonymousMethod.IsIterator) {
819 Report.Error (1643, CurrentAnonymousMethod.Location, "Not all code paths return a value in anonymous method of type `{0}'",
820 CurrentAnonymousMethod.GetSignatureForError ());
829 public Type ReturnType {
838 public void EmitResolvedTopBlock (ToplevelBlock block, bool unreachable)
844 ig.MarkLabel (ReturnLabel);
846 if (return_value != null){
847 ig.Emit (OpCodes.Ldloc, return_value);
848 ig.Emit (OpCodes.Ret);
851 // If `HasReturnLabel' is set, then we already emitted a
852 // jump to the end of the method, so we must emit a `ret'
855 // Unfortunately, System.Reflection.Emit automatically emits
856 // a leave to the end of a finally block. This is a problem
857 // if no code is following the try/finally block since we may
858 // jump to a point after the end of the method.
859 // As a workaround, we're always creating a return label in
863 if (HasReturnLabel || !unreachable) {
864 if (return_type != TypeManager.void_type)
865 ig.Emit (OpCodes.Ldloc, TemporaryReturn ());
866 ig.Emit (OpCodes.Ret);
872 /// This is called immediately before emitting an IL opcode to tell the symbol
873 /// writer to which source line this opcode belongs.
875 public void Mark (Location loc)
877 if (!SymbolWriter.HasSymbolWriter || OmitDebuggingInfo || loc.IsNull)
880 SymbolWriter.MarkSequencePoint (ig, loc);
883 public void DefineLocalVariable (string name, LocalBuilder builder)
885 SymbolWriter.DefineLocalVariable (name, builder);
888 public void BeginScope ()
891 SymbolWriter.OpenScope(ig);
894 public void EndScope ()
897 SymbolWriter.CloseScope(ig);
901 /// Returns a temporary storage for a variable of type t as
902 /// a local variable in the current body.
904 public LocalBuilder GetTemporaryLocal (Type t)
906 if (temporary_storage != null) {
907 object o = temporary_storage [t];
911 o = s.Count == 0 ? null : s.Pop ();
913 temporary_storage.Remove (t);
917 return (LocalBuilder) o;
919 return ig.DeclareLocal (t);
922 public void FreeTemporaryLocal (LocalBuilder b, Type t)
924 if (temporary_storage == null) {
925 temporary_storage = new Hashtable ();
926 temporary_storage [t] = b;
929 object o = temporary_storage [t];
931 temporary_storage [t] = b;
934 Stack s = o as Stack;
938 temporary_storage [t] = s;
944 /// Current loop begin and end labels.
946 public Label LoopBegin, LoopEnd;
949 /// Default target in a switch statement. Only valid if
952 public Label DefaultTarget;
955 /// If this is non-null, points to the current switch statement
957 public Switch Switch;
960 /// ReturnValue creates on demand the LocalBuilder for the
961 /// return value from the function. By default this is not
962 /// used. This is only required when returns are found inside
963 /// Try or Catch statements.
965 /// This method is typically invoked from the Emit phase, so
966 /// we allow the creation of a return label if it was not
967 /// requested during the resolution phase. Could be cleaned
968 /// up, but it would replicate a lot of logic in the Emit phase
969 /// of the code that uses it.
971 public LocalBuilder TemporaryReturn ()
973 if (return_value == null){
974 return_value = ig.DeclareLocal (return_type);
975 if (!HasReturnLabel){
976 ReturnLabel = ig.DefineLabel ();
977 HasReturnLabel = true;
985 /// This method is used during the Resolution phase to flag the
986 /// need to define the ReturnLabel
988 public void NeedReturnLabel ()
990 if (current_phase != Phase.Resolving){
992 // The reason is that the `ReturnLabel' is declared between
993 // resolution and emission
995 throw new Exception ("NeedReturnLabel called from Emit phase, should only be called during Resolve");
999 HasReturnLabel = true;
1003 public Expression GetThis (Location loc)
1006 if (CurrentBlock != null)
1007 my_this = new This (CurrentBlock, loc);
1009 my_this = new This (loc);
1011 if (!my_this.ResolveBase (this))
1019 public abstract class CommonAssemblyModulClass : Attributable, IResolveContext {
1021 protected CommonAssemblyModulClass ():
1026 public void AddAttributes (ArrayList attrs)
1028 foreach (Attribute a in attrs)
1031 if (attributes == null) {
1032 attributes = new Attributes (attrs);
1035 attributes.AddAttributes (attrs);
1038 public virtual void Emit (TypeContainer tc)
1040 if (OptAttributes == null)
1043 OptAttributes.Emit ();
1046 protected Attribute ResolveAttribute (PredefinedAttribute a_type)
1048 Attribute a = OptAttributes.Search (a_type);
1055 public override IResolveContext ResolveContext {
1056 get { return this; }
1059 #region IResolveContext Members
1061 public DeclSpace DeclContainer {
1062 get { return RootContext.ToplevelTypes; }
1065 public DeclSpace GenericDeclContainer {
1066 get { return DeclContainer; }
1069 public bool IsInObsoleteScope {
1070 get { return false; }
1073 public bool IsInUnsafeScope {
1074 get { return false; }
1080 public class AssemblyClass : CommonAssemblyModulClass {
1081 // TODO: make it private and move all builder based methods here
1082 public AssemblyBuilder Builder;
1083 bool is_cls_compliant;
1084 bool wrap_non_exception_throws;
1086 public Attribute ClsCompliantAttribute;
1088 ListDictionary declarative_security;
1089 bool has_extension_method;
1090 public AssemblyName Name;
1091 MethodInfo add_type_forwarder;
1092 ListDictionary emitted_forwarders;
1094 // Module is here just because of error messages
1095 static string[] attribute_targets = new string [] { "assembly", "module" };
1097 public AssemblyClass (): base ()
1099 wrap_non_exception_throws = true;
1102 public bool HasExtensionMethods {
1104 has_extension_method = value;
1108 public bool IsClsCompliant {
1110 return is_cls_compliant;
1114 public bool WrapNonExceptionThrows {
1116 return wrap_non_exception_throws;
1120 public override AttributeTargets AttributeTargets {
1122 return AttributeTargets.Assembly;
1126 public override bool IsClsComplianceRequired ()
1128 return is_cls_compliant;
1131 public void Resolve ()
1133 if (RootContext.Unsafe) {
1135 // Emits [assembly: SecurityPermissionAttribute (SecurityAction.RequestMinimum, SkipVerification = true)]
1136 // when -unsafe option was specified
1139 Location loc = Location.Null;
1141 MemberAccess system_security_permissions = new MemberAccess (new MemberAccess (
1142 new QualifiedAliasMember (QualifiedAliasMember.GlobalAlias, "System", loc), "Security", loc), "Permissions", loc);
1144 ArrayList pos = new ArrayList (1);
1145 pos.Add (new Argument (new MemberAccess (new MemberAccess (system_security_permissions, "SecurityAction", loc), "RequestMinimum")));
1147 ArrayList named = new ArrayList (1);
1148 named.Add (new DictionaryEntry ("SkipVerification", new Argument (new BoolLiteral (true, loc))));
1150 GlobalAttribute g = new GlobalAttribute (new NamespaceEntry (null, null, null), "assembly", system_security_permissions,
1151 "SecurityPermissionAttribute", new object[] { pos, named }, loc, false);
1154 if (g.Resolve () != null) {
1155 declarative_security = new ListDictionary ();
1156 g.ExtractSecurityPermissionSet (declarative_security);
1160 if (OptAttributes == null)
1163 // Ensure that we only have GlobalAttributes, since the Search isn't safe with other types.
1164 if (!OptAttributes.CheckTargets())
1167 ClsCompliantAttribute = ResolveAttribute (PredefinedAttributes.Get.CLSCompliant);
1169 if (ClsCompliantAttribute != null) {
1170 is_cls_compliant = ClsCompliantAttribute.GetClsCompliantAttributeValue ();
1173 Attribute a = ResolveAttribute (PredefinedAttributes.Get.RuntimeCompatibility);
1175 object val = a.GetPropertyValue ("WrapNonExceptionThrows");
1177 wrap_non_exception_throws = (bool) val;
1182 private void SetPublicKey (AssemblyName an, byte[] strongNameBlob)
1185 // check for possible ECMA key
1186 if (strongNameBlob.Length == 16) {
1187 // will be rejected if not "the" ECMA key
1188 an.SetPublicKey (strongNameBlob);
1191 // take it, with or without, a private key
1192 RSA rsa = CryptoConvert.FromCapiKeyBlob (strongNameBlob);
1193 // and make sure we only feed the public part to Sys.Ref
1194 byte[] publickey = CryptoConvert.ToCapiPublicKeyBlob (rsa);
1196 // AssemblyName.SetPublicKey requires an additional header
1197 byte[] publicKeyHeader = new byte [12] { 0x00, 0x24, 0x00, 0x00, 0x04, 0x80, 0x00, 0x00, 0x94, 0x00, 0x00, 0x00 };
1199 byte[] encodedPublicKey = new byte [12 + publickey.Length];
1200 Buffer.BlockCopy (publicKeyHeader, 0, encodedPublicKey, 0, 12);
1201 Buffer.BlockCopy (publickey, 0, encodedPublicKey, 12, publickey.Length);
1202 an.SetPublicKey (encodedPublicKey);
1206 Error_AssemblySigning ("The specified file `" + RootContext.StrongNameKeyFile + "' is incorrectly encoded");
1207 Environment.Exit (1);
1211 // TODO: rewrite this code (to kill N bugs and make it faster) and use standard ApplyAttribute way.
1212 public AssemblyName GetAssemblyName (string name, string output)
1214 if (OptAttributes != null) {
1215 foreach (Attribute a in OptAttributes.Attrs) {
1216 // cannot rely on any resolve-based members before you call Resolve
1217 if (a.ExplicitTarget == null || a.ExplicitTarget != "assembly")
1220 // TODO: This code is buggy: comparing Attribute name without resolving is wrong.
1221 // However, this is invoked by CodeGen.Init, when none of the namespaces
1223 // TODO: Does not handle quoted attributes properly
1225 case "AssemblyKeyFile":
1226 case "AssemblyKeyFileAttribute":
1227 case "System.Reflection.AssemblyKeyFileAttribute":
1228 if (RootContext.StrongNameKeyFile != null) {
1229 Report.SymbolRelatedToPreviousError (a.Location, a.Name);
1230 Report.Warning (1616, 1, "Option `{0}' overrides attribute `{1}' given in a source file or added module",
1231 "keyfile", "System.Reflection.AssemblyKeyFileAttribute");
1233 string value = a.GetString ();
1234 if (value.Length != 0)
1235 RootContext.StrongNameKeyFile = value;
1238 case "AssemblyKeyName":
1239 case "AssemblyKeyNameAttribute":
1240 case "System.Reflection.AssemblyKeyNameAttribute":
1241 if (RootContext.StrongNameKeyContainer != null) {
1242 Report.SymbolRelatedToPreviousError (a.Location, a.Name);
1243 Report.Warning (1616, 1, "Option `{0}' overrides attribute `{1}' given in a source file or added module",
1244 "keycontainer", "System.Reflection.AssemblyKeyNameAttribute");
1246 string value = a.GetString ();
1247 if (value.Length != 0)
1248 RootContext.StrongNameKeyContainer = value;
1251 case "AssemblyDelaySign":
1252 case "AssemblyDelaySignAttribute":
1253 case "System.Reflection.AssemblyDelaySignAttribute":
1254 RootContext.StrongNameDelaySign = a.GetBoolean ();
1260 AssemblyName an = new AssemblyName ();
1261 an.Name = Path.GetFileNameWithoutExtension (name);
1263 // note: delay doesn't apply when using a key container
1264 if (RootContext.StrongNameKeyContainer != null) {
1265 an.KeyPair = new StrongNameKeyPair (RootContext.StrongNameKeyContainer);
1269 // strongname is optional
1270 if (RootContext.StrongNameKeyFile == null)
1273 string AssemblyDir = Path.GetDirectoryName (output);
1275 // the StrongName key file may be relative to (a) the compiled
1276 // file or (b) to the output assembly. See bugzilla #55320
1277 // http://bugzilla.ximian.com/show_bug.cgi?id=55320
1279 // (a) relative to the compiled file
1280 string filename = Path.GetFullPath (RootContext.StrongNameKeyFile);
1281 bool exist = File.Exists (filename);
1282 if ((!exist) && (AssemblyDir != null) && (AssemblyDir != String.Empty)) {
1283 // (b) relative to the outputed assembly
1284 filename = Path.GetFullPath (Path.Combine (AssemblyDir, RootContext.StrongNameKeyFile));
1285 exist = File.Exists (filename);
1289 using (FileStream fs = new FileStream (filename, FileMode.Open, FileAccess.Read)) {
1290 byte[] snkeypair = new byte [fs.Length];
1291 fs.Read (snkeypair, 0, snkeypair.Length);
1293 if (RootContext.StrongNameDelaySign) {
1294 // delayed signing - DO NOT include private key
1295 SetPublicKey (an, snkeypair);
1298 // no delay so we make sure we have the private key
1300 CryptoConvert.FromCapiPrivateKeyBlob (snkeypair);
1301 an.KeyPair = new StrongNameKeyPair (snkeypair);
1303 catch (CryptographicException) {
1304 if (snkeypair.Length == 16) {
1305 // error # is different for ECMA key
1306 Report.Error (1606, "Could not sign the assembly. " +
1307 "ECMA key can only be used to delay-sign assemblies");
1310 Error_AssemblySigning ("The specified file `" + RootContext.StrongNameKeyFile + "' does not have a private key");
1318 Error_AssemblySigning ("The specified file `" + RootContext.StrongNameKeyFile + "' does not exist");
1324 void Error_AssemblySigning (string text)
1326 Report.Error (1548, "Error during assembly signing. " + text);
1329 bool CheckInternalsVisibleAttribute (Attribute a)
1331 string assembly_name = a.GetString ();
1332 if (assembly_name.Length == 0)
1335 AssemblyName aname = null;
1338 aname = new AssemblyName (assembly_name);
1340 throw new NotSupportedException ();
1342 } catch (FileLoadException) {
1343 } catch (ArgumentException) {
1346 // Bad assembly name format
1348 Report.Warning (1700, 3, a.Location, "Assembly reference `" + assembly_name + "' is invalid and cannot be resolved");
1349 // Report error if we have defined Version or Culture
1350 else if (aname.Version != null || aname.CultureInfo != null)
1351 throw new Exception ("Friend assembly `" + a.GetString () +
1352 "' is invalid. InternalsVisibleTo cannot have version or culture specified.");
1353 else if (aname.GetPublicKey () == null && Name.GetPublicKey () != null && Name.GetPublicKey ().Length != 0) {
1354 Report.Error (1726, a.Location, "Friend assembly reference `" + aname.FullName + "' is invalid." +
1355 " Strong named assemblies must specify a public key in their InternalsVisibleTo declarations");
1362 static bool IsValidAssemblyVersion (string version)
1366 v = new Version (version);
1369 int major = int.Parse (version, CultureInfo.InvariantCulture);
1370 v = new Version (major, 0);
1376 foreach (int candidate in new int [] { v.Major, v.Minor, v.Build, v.Revision }) {
1377 if (candidate > ushort.MaxValue)
1384 public override void ApplyAttributeBuilder (Attribute a, CustomAttributeBuilder cb, PredefinedAttributes pa)
1386 if (a.IsValidSecurityAttribute ()) {
1387 if (declarative_security == null)
1388 declarative_security = new ListDictionary ();
1390 a.ExtractSecurityPermissionSet (declarative_security);
1394 if (a.Type == pa.AssemblyCulture) {
1395 string value = a.GetString ();
1396 if (value == null || value.Length == 0)
1399 if (RootContext.Target == Target.Exe) {
1400 a.Error_AttributeEmitError ("The executables cannot be satelite assemblies, remove the attribute or keep it empty");
1405 if (a.Type == pa.AssemblyVersion) {
1406 string value = a.GetString ();
1407 if (value == null || value.Length == 0)
1410 value = value.Replace ('*', '0');
1412 if (!IsValidAssemblyVersion (value)) {
1413 a.Error_AttributeEmitError (string.Format ("Specified version `{0}' is not valid", value));
1418 if (a.Type == pa.InternalsVisibleTo && !CheckInternalsVisibleAttribute (a))
1421 if (a.Type == pa.TypeForwarder) {
1422 Type t = a.GetArgumentType ();
1423 if (t == null || TypeManager.HasElementType (t)) {
1424 Report.Error (735, a.Location, "Invalid type specified as an argument for TypeForwardedTo attribute");
1428 if (emitted_forwarders == null) {
1429 emitted_forwarders = new ListDictionary();
1430 } else if (emitted_forwarders.Contains(t)) {
1431 Report.SymbolRelatedToPreviousError(((Attribute)emitted_forwarders[t]).Location, null);
1432 Report.Error(739, a.Location, "A duplicate type forward of type `{0}'",
1433 TypeManager.CSharpName(t));
1437 emitted_forwarders.Add(t, a);
1439 if (TypeManager.LookupDeclSpace (t) != null) {
1440 Report.SymbolRelatedToPreviousError (t);
1441 Report.Error (729, a.Location, "Cannot forward type `{0}' because it is defined in this assembly",
1442 TypeManager.CSharpName (t));
1446 if (t.DeclaringType != null) {
1447 Report.Error (730, a.Location, "Cannot forward type `{0}' because it is a nested type",
1448 TypeManager.CSharpName (t));
1452 if (TypeManager.IsGenericType (t)) {
1453 Report.Error (733, a.Location, "Cannot forward generic type `{0}'", TypeManager.CSharpName (t));
1457 if (add_type_forwarder == null) {
1458 add_type_forwarder = typeof (AssemblyBuilder).GetMethod ("AddTypeForwarder",
1459 BindingFlags.NonPublic | BindingFlags.Instance);
1461 if (add_type_forwarder == null) {
1462 Report.RuntimeMissingSupport (a.Location, "TypeForwardedTo attribute");
1467 add_type_forwarder.Invoke (Builder, new object[] { t });
1471 if (a.Type == pa.Extension) {
1472 a.Error_MisusedExtensionAttribute ();
1476 Builder.SetCustomAttribute (cb);
1479 public override void Emit (TypeContainer tc)
1483 if (has_extension_method)
1484 PredefinedAttributes.Get.Extension.EmitAttribute (Builder);
1486 // FIXME: Does this belong inside SRE.AssemblyBuilder instead?
1487 PredefinedAttribute pa = PredefinedAttributes.Get.RuntimeCompatibility;
1488 if (pa.IsDefined && (OptAttributes == null || !OptAttributes.Contains (pa))) {
1489 ConstructorInfo ci = TypeManager.GetPredefinedConstructor (
1490 pa.Type, Location.Null, Type.EmptyTypes);
1491 PropertyInfo [] pis = new PropertyInfo [1];
1492 pis [0] = TypeManager.GetPredefinedProperty (pa.Type,
1493 "WrapNonExceptionThrows", Location.Null, TypeManager.bool_type);
1494 object [] pargs = new object [1];
1496 Builder.SetCustomAttribute (new CustomAttributeBuilder (ci, new object [0], pis, pargs));
1499 if (declarative_security != null) {
1501 MethodInfo add_permission = typeof (AssemblyBuilder).GetMethod ("AddPermissionRequests", BindingFlags.Instance | BindingFlags.NonPublic);
1502 object builder_instance = Builder;
1505 // Microsoft runtime hacking
1506 if (add_permission == null) {
1507 Type assembly_builder = typeof (AssemblyBuilder).Assembly.GetType ("System.Reflection.Emit.AssemblyBuilderData");
1508 add_permission = assembly_builder.GetMethod ("AddPermissionRequests", BindingFlags.Instance | BindingFlags.NonPublic);
1510 FieldInfo fi = typeof (AssemblyBuilder).GetField ("m_assemblyData", BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.GetField);
1511 builder_instance = fi.GetValue (Builder);
1514 object[] args = new object [] { declarative_security [SecurityAction.RequestMinimum],
1515 declarative_security [SecurityAction.RequestOptional],
1516 declarative_security [SecurityAction.RequestRefuse] };
1517 add_permission.Invoke (builder_instance, args);
1520 Report.RuntimeMissingSupport (Location.Null, "assembly permission setting");
1525 public override string[] ValidAttributeTargets {
1527 return attribute_targets;
1531 // Wrapper for AssemblyBuilder.AddModule
1532 static MethodInfo adder_method;
1533 static public MethodInfo AddModule_Method {
1535 if (adder_method == null)
1536 adder_method = typeof (AssemblyBuilder).GetMethod ("AddModule", BindingFlags.Instance|BindingFlags.NonPublic);
1537 return adder_method;
1540 public Module AddModule (string module)
1542 MethodInfo m = AddModule_Method;
1544 Report.RuntimeMissingSupport (Location.Null, "/addmodule");
1545 Environment.Exit (1);
1549 return (Module) m.Invoke (Builder, new object [] { module });
1550 } catch (TargetInvocationException ex) {
1551 throw ex.InnerException;