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 PortableExecutableKinds pekind;
191 ImageFileMachine machine;
193 switch (RootContext.Platform) {
195 pekind = PortableExecutableKinds.Required32Bit;
196 machine = ImageFileMachine.I386;
199 pekind = PortableExecutableKinds.PE32Plus;
200 machine = ImageFileMachine.AMD64;
203 pekind = PortableExecutableKinds.PE32Plus;
204 machine = ImageFileMachine.IA64;
206 case Platform.AnyCPU:
208 pekind = PortableExecutableKinds.ILOnly;
209 machine = ImageFileMachine.I386;
215 Assembly.Builder.Save (Basename (name), pekind, machine);
217 Assembly.Builder.Save (Basename (name));
220 catch (COMException) {
221 if ((RootContext.StrongNameKeyFile == null) || (!RootContext.StrongNameDelaySign))
224 // FIXME: it seems Microsoft AssemblyBuilder doesn't like to delay sign assemblies
225 Report.Error (1548, "Couldn't delay-sign the assembly with the '" +
226 RootContext.StrongNameKeyFile +
227 "', Use MCS with the Mono runtime or CSC to compile this assembly.");
229 catch (System.IO.IOException io) {
230 Report.Error (16, "Could not write to file `"+name+"', cause: " + io.Message);
233 catch (System.UnauthorizedAccessException ua) {
234 Report.Error (16, "Could not write to file `"+name+"', cause: " + ua.Message);
237 catch (System.NotImplementedException nie) {
238 Report.RuntimeMissingSupport (Location.Null, nie.Message);
243 // Write debuger symbol file
246 SymbolWriter.WriteSymbolFile ();
252 /// An interface to hold all the information needed in the resolving phase.
254 public interface IResolveContext
256 DeclSpace DeclContainer { get; }
257 bool IsInObsoleteScope { get; }
258 bool IsInUnsafeScope { get; }
260 ExtensionMethodGroupExpr LookupExtensionMethod (Type extensionType, string name, Location loc);
261 FullNamedExpression LookupNamespaceOrType (string name, Location loc, bool ignore_cs0104);
262 Type LookupTypeParameter (string name);
264 // the declcontainer to lookup for type-parameters. Should only use LookupGeneric on it.
266 // FIXME: This is somewhat of a hack. We don't need a full DeclSpace for this. We just need the
267 // current type parameters in scope. IUIC, that will require us to rewrite GenericMethod.
268 // Maybe we can replace this with a 'LookupGeneric (string)' instead, but we'll have to
269 // handle generic method overrides differently
270 DeclSpace GenericDeclContainer { get; }
274 /// An Emit Context is created for each body of code (from methods,
275 /// properties bodies, indexer bodies or constructor bodies)
277 public class EmitContext : IResolveContext {
280 // Holds a varible used during collection or object initialization.
282 public Expression CurrentInitializerVariable;
284 DeclSpace decl_space;
286 public DeclSpace TypeContainer;
287 public ILGenerator ig;
290 public enum Flags : int {
292 /// This flag tracks the `checked' state of the compilation,
293 /// it controls whether we should generate code that does overflow
294 /// checking, or if we generate code that ignores overflows.
296 /// The default setting comes from the command line option to generate
297 /// checked or unchecked code plus any source code changes using the
298 /// checked/unchecked statements or expressions. Contrast this with
299 /// the ConstantCheckState flag.
304 /// The constant check state is always set to `true' and cant be changed
305 /// from the command line. The source code can change this setting with
306 /// the `checked' and `unchecked' statements and expressions.
308 ConstantCheckState = 1 << 1,
310 AllCheckStateFlags = CheckState | ConstantCheckState,
313 /// Whether we are inside an unsafe block
321 /// Whether control flow analysis is enabled
323 DoFlowAnalysis = 1 << 5,
326 /// Whether control flow analysis is disabled on structs
327 /// (only meaningful when DoFlowAnalysis is set)
329 OmitStructFlowAnalysis = 1 << 6,
332 /// Indicates the current context is in probing mode, no errors are reported.
334 ProbingMode = 1 << 7,
337 // Inside field intializer expression
339 InFieldInitializer = 1 << 8,
341 InferReturnType = 1 << 9,
343 InCompoundAssignment = 1 << 10,
345 OmitDebuggingInfo = 1 << 11
351 /// Whether we are emitting code inside a static or instance method
353 public bool IsStatic;
356 /// Whether the actual created method is static or instance method.
357 /// Althoug the method might be declared as `static', if an anonymous
358 /// method is involved, we might turn this into an instance method.
360 /// So this reflects the low-level staticness of the method, while
361 /// IsStatic represents the semantic, high-level staticness.
363 //public bool MethodIsStatic;
366 /// The value that is allowed to be returned or NULL if there is no
372 /// Points to the Type (extracted from the TypeContainer) that
373 /// declares this body of code
375 public readonly Type ContainerType;
378 /// Whether this is generating code for a constructor
380 public bool IsConstructor;
383 /// Keeps track of the Type to LocalBuilder temporary storage created
384 /// to store structures (used to compute the address of the structure
385 /// value on structure method invocations)
387 public Hashtable temporary_storage;
389 public Block CurrentBlock;
391 public int CurrentFile;
394 /// The location where we store the return value.
396 LocalBuilder return_value;
399 /// The location where return has to jump to return the
402 public Label ReturnLabel;
405 /// If we already defined the ReturnLabel
407 public bool HasReturnLabel;
410 /// Whether we are in a `fixed' initialization
412 public bool InFixedInitializer;
415 /// Whether we are inside an anonymous method.
417 public AnonymousExpression CurrentAnonymousMethod;
420 /// Location for this EmitContext
425 /// Inside an enum definition, we do not resolve enumeration values
426 /// to their enumerations, but rather to the underlying type/value
427 /// This is so EnumVal + EnumValB can be evaluated.
429 /// There is no "E operator + (E x, E y)", so during an enum evaluation
430 /// we relax the rules
432 public bool InEnumContext;
434 public readonly IResolveContext ResolveContext;
437 /// The current iterator
439 public Iterator CurrentIterator {
440 get { return CurrentAnonymousMethod as Iterator; }
444 /// Whether we are in the resolving stage or not
452 bool isAnonymousMethodAllowed = true;
455 FlowBranching current_flow_branching;
457 static int next_id = 0;
460 public override string ToString ()
462 return String.Format ("EmitContext ({0}:{1})", id,
463 CurrentAnonymousMethod, loc);
466 public EmitContext (IResolveContext rc, DeclSpace parent, DeclSpace ds, Location l, ILGenerator ig,
467 Type return_type, int code_flags, bool is_constructor)
469 this.ResolveContext = rc;
472 TypeContainer = parent;
473 this.decl_space = ds;
474 if (RootContext.Checked)
475 flags |= Flags.CheckState;
476 flags |= Flags.ConstantCheckState;
478 if (return_type == null)
479 throw new ArgumentNullException ("return_type");
481 IsStatic = (code_flags & Modifiers.STATIC) != 0;
482 ReturnType = return_type;
483 IsConstructor = is_constructor;
486 current_phase = Phase.Created;
489 // Can only be null for the ResolveType contexts.
490 ContainerType = parent.TypeBuilder;
491 if (rc.IsInUnsafeScope)
492 flags |= Flags.InUnsafe;
497 public EmitContext (IResolveContext rc, DeclSpace ds, Location l, ILGenerator ig,
498 Type return_type, int code_flags, bool is_constructor)
499 : this (rc, ds, ds, l, ig, return_type, code_flags, is_constructor)
503 public EmitContext (IResolveContext rc, DeclSpace ds, Location l, ILGenerator ig,
504 Type return_type, int code_flags)
505 : this (rc, ds, ds, l, ig, return_type, code_flags, false)
509 // IResolveContext.DeclContainer
510 public DeclSpace DeclContainer {
511 get { return decl_space; }
512 set { decl_space = value; }
515 // IResolveContext.GenericDeclContainer
516 public DeclSpace GenericDeclContainer {
517 get { return DeclContainer; }
520 public bool CheckState {
521 get { return (flags & Flags.CheckState) != 0; }
524 public bool ConstantCheckState {
525 get { return (flags & Flags.ConstantCheckState) != 0; }
528 public bool InUnsafe {
529 get { return (flags & Flags.InUnsafe) != 0; }
532 public bool InCatch {
533 get { return (flags & Flags.InCatch) != 0; }
536 public bool InFinally {
537 get { return (flags & Flags.InFinally) != 0; }
540 public bool DoFlowAnalysis {
541 get { return (flags & Flags.DoFlowAnalysis) != 0; }
544 public bool OmitStructFlowAnalysis {
545 get { return (flags & Flags.OmitStructFlowAnalysis) != 0; }
548 // utility helper for CheckExpr, UnCheckExpr, Checked and Unchecked statements
549 // it's public so that we can use a struct at the callsite
550 public struct FlagsHandle : IDisposable
553 readonly Flags invmask, oldval;
555 public FlagsHandle (EmitContext ec, Flags flagsToSet)
556 : this (ec, flagsToSet, flagsToSet)
560 internal FlagsHandle (EmitContext ec, Flags mask, Flags val)
564 oldval = ec.flags & mask;
565 ec.flags = (ec.flags & invmask) | (val & mask);
567 if ((mask & Flags.ProbingMode) != 0)
568 Report.DisableReporting ();
571 public void Dispose ()
573 if ((invmask & Flags.ProbingMode) == 0)
574 Report.EnableReporting ();
576 ec.flags = (ec.flags & invmask) | oldval;
580 // Temporarily set all the given flags to the given value. Should be used in an 'using' statement
581 public FlagsHandle Set (Flags flagsToSet)
583 return new FlagsHandle (this, flagsToSet);
586 public FlagsHandle With (Flags bits, bool enable)
588 return new FlagsHandle (this, bits, enable ? bits : 0);
591 public FlagsHandle WithFlowAnalysis (bool do_flow_analysis, bool omit_struct_analysis)
594 (do_flow_analysis ? Flags.DoFlowAnalysis : 0) |
595 (omit_struct_analysis ? Flags.OmitStructFlowAnalysis : 0);
596 return new FlagsHandle (this, Flags.DoFlowAnalysis | Flags.OmitStructFlowAnalysis, newflags);
600 /// If this is true, then Return and ContextualReturn statements
601 /// will set the ReturnType value based on the expression types
602 /// of each return statement instead of the method return type
603 /// (which is initially null).
605 public bool InferReturnType {
606 get { return (flags & Flags.InferReturnType) != 0; }
609 public TypeInferenceContext ReturnTypeInference;
611 // IResolveContext.IsInObsoleteScope
612 public bool IsInObsoleteScope {
614 // Disables obsolete checks when probing is on
615 return IsInProbingMode || ResolveContext.IsInObsoleteScope;
619 public bool IsInProbingMode {
620 get { return (flags & Flags.ProbingMode) != 0; }
623 // IResolveContext.IsInUnsafeScope
624 public bool IsInUnsafeScope {
625 get { return InUnsafe || ResolveContext.IsInUnsafeScope; }
628 public bool IsAnonymousMethodAllowed {
629 get { return isAnonymousMethodAllowed; }
630 set { isAnonymousMethodAllowed = value; }
633 public bool IsInFieldInitializer {
634 get { return (flags & Flags.InFieldInitializer) != 0; }
637 public bool IsInCompoundAssignment {
638 get { return (flags & Flags.InCompoundAssignment) != 0; }
641 public bool IsVariableCapturingRequired {
643 return !IsInProbingMode && (CurrentBranching == null || !CurrentBranching.CurrentUsageVector.IsUnreachable);
647 public FlowBranching CurrentBranching {
648 get { return current_flow_branching; }
651 public bool OmitDebuggingInfo {
652 get { return (flags & Flags.OmitDebuggingInfo) != 0; }
655 flags |= Flags.OmitDebuggingInfo;
657 flags &= ~Flags.OmitDebuggingInfo;
662 // Starts a new code branching. This inherits the state of all local
663 // variables and parameters from the current branching.
665 public FlowBranching StartFlowBranching (FlowBranching.BranchingType type, Location loc)
667 current_flow_branching = FlowBranching.CreateBranching (CurrentBranching, type, null, loc);
668 return current_flow_branching;
672 // Starts a new code branching for block `block'.
674 public FlowBranching StartFlowBranching (Block block)
676 flags |= Flags.DoFlowAnalysis;
678 current_flow_branching = FlowBranching.CreateBranching (
679 CurrentBranching, FlowBranching.BranchingType.Block, block, block.StartLocation);
680 return current_flow_branching;
683 public FlowBranchingTryCatch StartFlowBranching (TryCatch stmt)
685 FlowBranchingTryCatch branching = new FlowBranchingTryCatch (CurrentBranching, stmt);
686 current_flow_branching = branching;
690 public FlowBranchingException StartFlowBranching (ExceptionStatement stmt)
692 FlowBranchingException branching = new FlowBranchingException (CurrentBranching, stmt);
693 current_flow_branching = branching;
697 public FlowBranchingLabeled StartFlowBranching (LabeledStatement stmt)
699 FlowBranchingLabeled branching = new FlowBranchingLabeled (CurrentBranching, stmt);
700 current_flow_branching = branching;
704 public FlowBranchingIterator StartFlowBranching (Iterator iterator)
706 FlowBranchingIterator branching = new FlowBranchingIterator (CurrentBranching, iterator);
707 current_flow_branching = branching;
711 public FlowBranchingToplevel StartFlowBranching (ToplevelBlock stmt)
713 FlowBranchingToplevel branching = new FlowBranchingToplevel (CurrentBranching, stmt);
714 current_flow_branching = branching;
719 // Ends a code branching. Merges the state of locals and parameters
720 // from all the children of the ending branching.
722 public bool EndFlowBranching ()
724 FlowBranching old = current_flow_branching;
725 current_flow_branching = current_flow_branching.Parent;
727 FlowBranching.UsageVector vector = current_flow_branching.MergeChild (old);
728 return vector.IsUnreachable;
732 // Kills the current code branching. This throws away any changed state
733 // information and should only be used in case of an error.
735 // FIXME: this is evil
736 public void KillFlowBranching ()
738 current_flow_branching = current_flow_branching.Parent;
741 public bool MustCaptureVariable (LocalInfo local)
743 if (CurrentAnonymousMethod == null)
746 // FIXME: IsIterator is too aggressive, we should capture only if child
747 // block contains yield
748 if (CurrentAnonymousMethod.IsIterator)
751 return local.Block.Toplevel != CurrentBlock.Toplevel;
754 public void EmitMeta (ToplevelBlock b)
759 ReturnLabel = ig.DefineLabel ();
763 // Here until we can fix the problem with Mono.CSharp.Switch, which
764 // currently can not cope with ig == null during resolve (which must
765 // be fixed for switch statements to work on anonymous methods).
767 public void EmitTopBlock (IMethodData md, ToplevelBlock block)
774 if (ResolveTopBlock (null, block, md.ParameterInfo, md, out unreachable)){
775 if (Report.Errors > 0)
780 current_phase = Phase.Emitting;
784 EmitResolvedTopBlock (block, unreachable);
786 } catch (Exception e){
787 Console.WriteLine ("Exception caught by the compiler while emitting:");
788 Console.WriteLine (" Block that caused the problem begin at: " + block.loc);
790 Console.WriteLine (e.GetType ().FullName + ": " + e.Message);
800 public bool ResolveTopBlock (EmitContext anonymous_method_host, ToplevelBlock block,
801 ParametersCompiled ip, IMethodData md, out bool unreachable)
804 unreachable = this.unreachable;
808 current_phase = Phase.Resolving;
812 CurrentFile = loc.File;
817 if (!block.ResolveMeta (this, ip))
820 using (this.With (EmitContext.Flags.DoFlowAnalysis, true)) {
821 FlowBranchingToplevel top_level;
822 if (anonymous_method_host != null)
823 top_level = new FlowBranchingToplevel (anonymous_method_host.CurrentBranching, block);
825 top_level = block.TopLevelBranching;
827 current_flow_branching = top_level;
828 bool ok = block.Resolve (this);
829 current_flow_branching = null;
834 bool flow_unreachable = top_level.End ();
835 if (flow_unreachable)
836 this.unreachable = unreachable = true;
839 } catch (Exception e) {
840 Console.WriteLine ("Exception caught by the compiler while compiling:");
841 Console.WriteLine (" Block that caused the problem begin at: " + loc);
843 if (CurrentBlock != null){
844 Console.WriteLine (" Block being compiled: [{0},{1}]",
845 CurrentBlock.StartLocation, CurrentBlock.EndLocation);
847 Console.WriteLine (e.GetType ().FullName + ": " + e.Message);
852 if (return_type != TypeManager.void_type && !unreachable) {
853 if (CurrentAnonymousMethod == null) {
854 Report.Error (161, md.Location, "`{0}': not all code paths return a value", md.GetSignatureForError ());
856 } else if (!CurrentAnonymousMethod.IsIterator) {
857 Report.Error (1643, CurrentAnonymousMethod.Location, "Not all code paths return a value in anonymous method of type `{0}'",
858 CurrentAnonymousMethod.GetSignatureForError ());
867 public Type ReturnType {
876 public void EmitResolvedTopBlock (ToplevelBlock block, bool unreachable)
882 ig.MarkLabel (ReturnLabel);
884 if (return_value != null){
885 ig.Emit (OpCodes.Ldloc, return_value);
886 ig.Emit (OpCodes.Ret);
889 // If `HasReturnLabel' is set, then we already emitted a
890 // jump to the end of the method, so we must emit a `ret'
893 // Unfortunately, System.Reflection.Emit automatically emits
894 // a leave to the end of a finally block. This is a problem
895 // if no code is following the try/finally block since we may
896 // jump to a point after the end of the method.
897 // As a workaround, we're always creating a return label in
901 if (HasReturnLabel || !unreachable) {
902 if (return_type != TypeManager.void_type)
903 ig.Emit (OpCodes.Ldloc, TemporaryReturn ());
904 ig.Emit (OpCodes.Ret);
910 /// This is called immediately before emitting an IL opcode to tell the symbol
911 /// writer to which source line this opcode belongs.
913 public void Mark (Location loc)
915 if (!SymbolWriter.HasSymbolWriter || OmitDebuggingInfo || loc.IsNull)
918 SymbolWriter.MarkSequencePoint (ig, loc);
921 public void DefineLocalVariable (string name, LocalBuilder builder)
923 SymbolWriter.DefineLocalVariable (name, builder);
926 public void BeginScope ()
929 SymbolWriter.OpenScope(ig);
932 public void EndScope ()
935 SymbolWriter.CloseScope(ig);
939 /// Returns a temporary storage for a variable of type t as
940 /// a local variable in the current body.
942 public LocalBuilder GetTemporaryLocal (Type t)
944 if (temporary_storage != null) {
945 object o = temporary_storage [t];
949 o = s.Count == 0 ? null : s.Pop ();
951 temporary_storage.Remove (t);
955 return (LocalBuilder) o;
957 return ig.DeclareLocal (t);
960 public void FreeTemporaryLocal (LocalBuilder b, Type t)
962 if (temporary_storage == null) {
963 temporary_storage = new Hashtable ();
964 temporary_storage [t] = b;
967 object o = temporary_storage [t];
969 temporary_storage [t] = b;
972 Stack s = o as Stack;
976 temporary_storage [t] = s;
982 /// Current loop begin and end labels.
984 public Label LoopBegin, LoopEnd;
987 /// Default target in a switch statement. Only valid if
990 public Label DefaultTarget;
993 /// If this is non-null, points to the current switch statement
995 public Switch Switch;
998 /// ReturnValue creates on demand the LocalBuilder for the
999 /// return value from the function. By default this is not
1000 /// used. This is only required when returns are found inside
1001 /// Try or Catch statements.
1003 /// This method is typically invoked from the Emit phase, so
1004 /// we allow the creation of a return label if it was not
1005 /// requested during the resolution phase. Could be cleaned
1006 /// up, but it would replicate a lot of logic in the Emit phase
1007 /// of the code that uses it.
1009 public LocalBuilder TemporaryReturn ()
1011 if (return_value == null){
1012 return_value = ig.DeclareLocal (return_type);
1013 if (!HasReturnLabel){
1014 ReturnLabel = ig.DefineLabel ();
1015 HasReturnLabel = true;
1019 return return_value;
1023 /// This method is used during the Resolution phase to flag the
1024 /// need to define the ReturnLabel
1026 public void NeedReturnLabel ()
1028 if (current_phase != Phase.Resolving){
1030 // The reason is that the `ReturnLabel' is declared between
1031 // resolution and emission
1033 throw new Exception ("NeedReturnLabel called from Emit phase, should only be called during Resolve");
1036 if (!HasReturnLabel)
1037 HasReturnLabel = true;
1041 public Expression GetThis (Location loc)
1044 if (CurrentBlock != null)
1045 my_this = new This (CurrentBlock, loc);
1047 my_this = new This (loc);
1049 if (!my_this.ResolveBase (this))
1055 #region IResolveContext Members
1057 public ExtensionMethodGroupExpr LookupExtensionMethod (Type extensionType, string name, Location loc)
1059 return ResolveContext.LookupExtensionMethod (extensionType, name, loc);
1062 public FullNamedExpression LookupNamespaceOrType (string name, Location loc, bool ignore_cs0104)
1064 return ResolveContext.LookupNamespaceOrType (name, loc, ignore_cs0104);
1067 public Type LookupTypeParameter (string name)
1069 return ResolveContext.LookupTypeParameter (name);
1076 public abstract class CommonAssemblyModulClass : Attributable, IResolveContext
1078 public void AddAttributes (ArrayList attrs)
1080 foreach (Attribute a in attrs)
1081 a.AttachTo (this, this);
1083 if (attributes == null) {
1084 attributes = new Attributes (attrs);
1087 attributes.AddAttributes (attrs);
1090 public virtual void Emit (TypeContainer tc)
1092 if (OptAttributes == null)
1095 OptAttributes.Emit ();
1098 protected Attribute ResolveAttribute (PredefinedAttribute a_type)
1100 Attribute a = OptAttributes.Search (a_type);
1107 #region IResolveContext Members
1109 public DeclSpace DeclContainer {
1110 get { return RootContext.ToplevelTypes; }
1113 public DeclSpace GenericDeclContainer {
1114 get { return DeclContainer; }
1117 public bool IsInObsoleteScope {
1118 get { return false; }
1121 public bool IsInUnsafeScope {
1122 get { return false; }
1125 public ExtensionMethodGroupExpr LookupExtensionMethod (Type extensionType, string name, Location loc)
1127 throw new NotImplementedException ();
1130 public FullNamedExpression LookupNamespaceOrType (string name, Location loc, bool ignore_cs0104)
1132 return RootContext.ToplevelTypes.LookupNamespaceOrType (name, loc, ignore_cs0104);
1135 public Type LookupTypeParameter (string name)
1143 public class AssemblyClass : CommonAssemblyModulClass {
1144 // TODO: make it private and move all builder based methods here
1145 public AssemblyBuilder Builder;
1146 bool is_cls_compliant;
1147 bool wrap_non_exception_throws;
1149 public Attribute ClsCompliantAttribute;
1151 ListDictionary declarative_security;
1152 bool has_extension_method;
1153 public AssemblyName Name;
1154 MethodInfo add_type_forwarder;
1155 ListDictionary emitted_forwarders;
1157 // Module is here just because of error messages
1158 static string[] attribute_targets = new string [] { "assembly", "module" };
1160 public AssemblyClass (): base ()
1162 wrap_non_exception_throws = true;
1165 public bool HasExtensionMethods {
1167 has_extension_method = value;
1171 public bool IsClsCompliant {
1173 return is_cls_compliant;
1177 public bool WrapNonExceptionThrows {
1179 return wrap_non_exception_throws;
1183 public override AttributeTargets AttributeTargets {
1185 return AttributeTargets.Assembly;
1189 public override bool IsClsComplianceRequired ()
1191 return is_cls_compliant;
1194 public void Resolve ()
1196 if (RootContext.Unsafe) {
1198 // Emits [assembly: SecurityPermissionAttribute (SecurityAction.RequestMinimum, SkipVerification = true)]
1199 // when -unsafe option was specified
1202 Location loc = Location.Null;
1204 MemberAccess system_security_permissions = new MemberAccess (new MemberAccess (
1205 new QualifiedAliasMember (QualifiedAliasMember.GlobalAlias, "System", loc), "Security", loc), "Permissions", loc);
1207 Arguments pos = new Arguments (1);
1208 pos.Add (new Argument (new MemberAccess (new MemberAccess (system_security_permissions, "SecurityAction", loc), "RequestMinimum")));
1210 Arguments named = new Arguments (1);
1211 named.Add (new NamedArgument (new LocatedToken (loc, "SkipVerification"), (new BoolLiteral (true, loc))));
1213 GlobalAttribute g = new GlobalAttribute (new NamespaceEntry (null, null, null), "assembly", system_security_permissions,
1214 "SecurityPermissionAttribute", new Arguments[] { pos, named }, loc, false);
1215 g.AttachTo (this, this);
1217 if (g.Resolve () != null) {
1218 declarative_security = new ListDictionary ();
1219 g.ExtractSecurityPermissionSet (declarative_security);
1223 if (OptAttributes == null)
1226 // Ensure that we only have GlobalAttributes, since the Search isn't safe with other types.
1227 if (!OptAttributes.CheckTargets())
1230 ClsCompliantAttribute = ResolveAttribute (PredefinedAttributes.Get.CLSCompliant);
1232 if (ClsCompliantAttribute != null) {
1233 is_cls_compliant = ClsCompliantAttribute.GetClsCompliantAttributeValue ();
1236 Attribute a = ResolveAttribute (PredefinedAttributes.Get.RuntimeCompatibility);
1238 object val = a.GetPropertyValue ("WrapNonExceptionThrows");
1240 wrap_non_exception_throws = (bool) val;
1245 private void SetPublicKey (AssemblyName an, byte[] strongNameBlob)
1248 // check for possible ECMA key
1249 if (strongNameBlob.Length == 16) {
1250 // will be rejected if not "the" ECMA key
1251 an.SetPublicKey (strongNameBlob);
1254 // take it, with or without, a private key
1255 RSA rsa = CryptoConvert.FromCapiKeyBlob (strongNameBlob);
1256 // and make sure we only feed the public part to Sys.Ref
1257 byte[] publickey = CryptoConvert.ToCapiPublicKeyBlob (rsa);
1259 // AssemblyName.SetPublicKey requires an additional header
1260 byte[] publicKeyHeader = new byte [12] { 0x00, 0x24, 0x00, 0x00, 0x04, 0x80, 0x00, 0x00, 0x94, 0x00, 0x00, 0x00 };
1262 byte[] encodedPublicKey = new byte [12 + publickey.Length];
1263 Buffer.BlockCopy (publicKeyHeader, 0, encodedPublicKey, 0, 12);
1264 Buffer.BlockCopy (publickey, 0, encodedPublicKey, 12, publickey.Length);
1265 an.SetPublicKey (encodedPublicKey);
1269 Error_AssemblySigning ("The specified file `" + RootContext.StrongNameKeyFile + "' is incorrectly encoded");
1270 Environment.Exit (1);
1274 // TODO: rewrite this code (to kill N bugs and make it faster) and use standard ApplyAttribute way.
1275 public AssemblyName GetAssemblyName (string name, string output)
1277 if (OptAttributes != null) {
1278 foreach (Attribute a in OptAttributes.Attrs) {
1279 // cannot rely on any resolve-based members before you call Resolve
1280 if (a.ExplicitTarget == null || a.ExplicitTarget != "assembly")
1283 // TODO: This code is buggy: comparing Attribute name without resolving is wrong.
1284 // However, this is invoked by CodeGen.Init, when none of the namespaces
1286 // TODO: Does not handle quoted attributes properly
1288 case "AssemblyKeyFile":
1289 case "AssemblyKeyFileAttribute":
1290 case "System.Reflection.AssemblyKeyFileAttribute":
1291 if (RootContext.StrongNameKeyFile != null) {
1292 Report.SymbolRelatedToPreviousError (a.Location, a.Name);
1293 Report.Warning (1616, 1, "Option `{0}' overrides attribute `{1}' given in a source file or added module",
1294 "keyfile", "System.Reflection.AssemblyKeyFileAttribute");
1296 string value = a.GetString ();
1297 if (value != null && value.Length != 0)
1298 RootContext.StrongNameKeyFile = value;
1301 case "AssemblyKeyName":
1302 case "AssemblyKeyNameAttribute":
1303 case "System.Reflection.AssemblyKeyNameAttribute":
1304 if (RootContext.StrongNameKeyContainer != null) {
1305 Report.SymbolRelatedToPreviousError (a.Location, a.Name);
1306 Report.Warning (1616, 1, "Option `{0}' overrides attribute `{1}' given in a source file or added module",
1307 "keycontainer", "System.Reflection.AssemblyKeyNameAttribute");
1309 string value = a.GetString ();
1310 if (value != null && value.Length != 0)
1311 RootContext.StrongNameKeyContainer = value;
1314 case "AssemblyDelaySign":
1315 case "AssemblyDelaySignAttribute":
1316 case "System.Reflection.AssemblyDelaySignAttribute":
1317 RootContext.StrongNameDelaySign = a.GetBoolean ();
1323 AssemblyName an = new AssemblyName ();
1324 an.Name = Path.GetFileNameWithoutExtension (name);
1326 // note: delay doesn't apply when using a key container
1327 if (RootContext.StrongNameKeyContainer != null) {
1328 an.KeyPair = new StrongNameKeyPair (RootContext.StrongNameKeyContainer);
1332 // strongname is optional
1333 if (RootContext.StrongNameKeyFile == null)
1336 string AssemblyDir = Path.GetDirectoryName (output);
1338 // the StrongName key file may be relative to (a) the compiled
1339 // file or (b) to the output assembly. See bugzilla #55320
1340 // http://bugzilla.ximian.com/show_bug.cgi?id=55320
1342 // (a) relative to the compiled file
1343 string filename = Path.GetFullPath (RootContext.StrongNameKeyFile);
1344 bool exist = File.Exists (filename);
1345 if ((!exist) && (AssemblyDir != null) && (AssemblyDir != String.Empty)) {
1346 // (b) relative to the outputed assembly
1347 filename = Path.GetFullPath (Path.Combine (AssemblyDir, RootContext.StrongNameKeyFile));
1348 exist = File.Exists (filename);
1352 using (FileStream fs = new FileStream (filename, FileMode.Open, FileAccess.Read)) {
1353 byte[] snkeypair = new byte [fs.Length];
1354 fs.Read (snkeypair, 0, snkeypair.Length);
1356 if (RootContext.StrongNameDelaySign) {
1357 // delayed signing - DO NOT include private key
1358 SetPublicKey (an, snkeypair);
1361 // no delay so we make sure we have the private key
1363 CryptoConvert.FromCapiPrivateKeyBlob (snkeypair);
1364 an.KeyPair = new StrongNameKeyPair (snkeypair);
1366 catch (CryptographicException) {
1367 if (snkeypair.Length == 16) {
1368 // error # is different for ECMA key
1369 Report.Error (1606, "Could not sign the assembly. " +
1370 "ECMA key can only be used to delay-sign assemblies");
1373 Error_AssemblySigning ("The specified file `" + RootContext.StrongNameKeyFile + "' does not have a private key");
1381 Error_AssemblySigning ("The specified file `" + RootContext.StrongNameKeyFile + "' does not exist");
1387 void Error_AssemblySigning (string text)
1389 Report.Error (1548, "Error during assembly signing. " + text);
1392 bool CheckInternalsVisibleAttribute (Attribute a)
1394 string assembly_name = a.GetString ();
1395 if (assembly_name.Length == 0)
1398 AssemblyName aname = null;
1401 aname = new AssemblyName (assembly_name);
1403 throw new NotSupportedException ();
1405 } catch (FileLoadException) {
1406 } catch (ArgumentException) {
1409 // Bad assembly name format
1411 Report.Warning (1700, 3, a.Location, "Assembly reference `" + assembly_name + "' is invalid and cannot be resolved");
1412 // Report error if we have defined Version or Culture
1413 else if (aname.Version != null || aname.CultureInfo != null)
1414 throw new Exception ("Friend assembly `" + a.GetString () +
1415 "' is invalid. InternalsVisibleTo cannot have version or culture specified.");
1416 else if (aname.GetPublicKey () == null && Name.GetPublicKey () != null && Name.GetPublicKey ().Length != 0) {
1417 Report.Error (1726, a.Location, "Friend assembly reference `" + aname.FullName + "' is invalid." +
1418 " Strong named assemblies must specify a public key in their InternalsVisibleTo declarations");
1425 static bool IsValidAssemblyVersion (string version)
1429 v = new Version (version);
1432 int major = int.Parse (version, CultureInfo.InvariantCulture);
1433 v = new Version (major, 0);
1439 foreach (int candidate in new int [] { v.Major, v.Minor, v.Build, v.Revision }) {
1440 if (candidate > ushort.MaxValue)
1447 public override void ApplyAttributeBuilder (Attribute a, CustomAttributeBuilder cb, PredefinedAttributes pa)
1449 if (a.IsValidSecurityAttribute ()) {
1450 if (declarative_security == null)
1451 declarative_security = new ListDictionary ();
1453 a.ExtractSecurityPermissionSet (declarative_security);
1457 if (a.Type == pa.AssemblyCulture) {
1458 string value = a.GetString ();
1459 if (value == null || value.Length == 0)
1462 if (RootContext.Target == Target.Exe) {
1463 a.Error_AttributeEmitError ("The executables cannot be satelite assemblies, remove the attribute or keep it empty");
1468 if (a.Type == pa.AssemblyVersion) {
1469 string value = a.GetString ();
1470 if (value == null || value.Length == 0)
1473 value = value.Replace ('*', '0');
1475 if (!IsValidAssemblyVersion (value)) {
1476 a.Error_AttributeEmitError (string.Format ("Specified version `{0}' is not valid", value));
1481 if (a.Type == pa.InternalsVisibleTo && !CheckInternalsVisibleAttribute (a))
1484 if (a.Type == pa.TypeForwarder) {
1485 Type t = a.GetArgumentType ();
1486 if (t == null || TypeManager.HasElementType (t)) {
1487 Report.Error (735, a.Location, "Invalid type specified as an argument for TypeForwardedTo attribute");
1491 t = TypeManager.DropGenericTypeArguments (t);
1492 if (emitted_forwarders == null) {
1493 emitted_forwarders = new ListDictionary();
1494 } else if (emitted_forwarders.Contains(t)) {
1495 Report.SymbolRelatedToPreviousError(((Attribute)emitted_forwarders[t]).Location, null);
1496 Report.Error(739, a.Location, "A duplicate type forward of type `{0}'",
1497 TypeManager.CSharpName(t));
1501 emitted_forwarders.Add(t, a);
1503 if (TypeManager.LookupDeclSpace (t) != null) {
1504 Report.SymbolRelatedToPreviousError (t);
1505 Report.Error (729, a.Location, "Cannot forward type `{0}' because it is defined in this assembly",
1506 TypeManager.CSharpName (t));
1510 if (t.DeclaringType != null) {
1511 Report.Error (730, a.Location, "Cannot forward type `{0}' because it is a nested type",
1512 TypeManager.CSharpName (t));
1516 if (add_type_forwarder == null) {
1517 add_type_forwarder = typeof (AssemblyBuilder).GetMethod ("AddTypeForwarder",
1518 BindingFlags.NonPublic | BindingFlags.Instance);
1520 if (add_type_forwarder == null) {
1521 Report.RuntimeMissingSupport (a.Location, "TypeForwardedTo attribute");
1526 add_type_forwarder.Invoke (Builder, new object[] { t });
1530 if (a.Type == pa.Extension) {
1531 a.Error_MisusedExtensionAttribute ();
1535 Builder.SetCustomAttribute (cb);
1538 public override void Emit (TypeContainer tc)
1542 if (has_extension_method)
1543 PredefinedAttributes.Get.Extension.EmitAttribute (Builder);
1545 // FIXME: Does this belong inside SRE.AssemblyBuilder instead?
1546 PredefinedAttribute pa = PredefinedAttributes.Get.RuntimeCompatibility;
1547 if (pa.IsDefined && (OptAttributes == null || !OptAttributes.Contains (pa))) {
1548 ConstructorInfo ci = TypeManager.GetPredefinedConstructor (
1549 pa.Type, Location.Null, Type.EmptyTypes);
1550 PropertyInfo [] pis = new PropertyInfo [1];
1551 pis [0] = TypeManager.GetPredefinedProperty (pa.Type,
1552 "WrapNonExceptionThrows", Location.Null, TypeManager.bool_type);
1553 object [] pargs = new object [1];
1555 Builder.SetCustomAttribute (new CustomAttributeBuilder (ci, new object [0], pis, pargs));
1558 if (declarative_security != null) {
1560 MethodInfo add_permission = typeof (AssemblyBuilder).GetMethod ("AddPermissionRequests", BindingFlags.Instance | BindingFlags.NonPublic);
1561 object builder_instance = Builder;
1564 // Microsoft runtime hacking
1565 if (add_permission == null) {
1566 Type assembly_builder = typeof (AssemblyBuilder).Assembly.GetType ("System.Reflection.Emit.AssemblyBuilderData");
1567 add_permission = assembly_builder.GetMethod ("AddPermissionRequests", BindingFlags.Instance | BindingFlags.NonPublic);
1569 FieldInfo fi = typeof (AssemblyBuilder).GetField ("m_assemblyData", BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.GetField);
1570 builder_instance = fi.GetValue (Builder);
1573 object[] args = new object [] { declarative_security [SecurityAction.RequestMinimum],
1574 declarative_security [SecurityAction.RequestOptional],
1575 declarative_security [SecurityAction.RequestRefuse] };
1576 add_permission.Invoke (builder_instance, args);
1579 Report.RuntimeMissingSupport (Location.Null, "assembly permission setting");
1584 public override string[] ValidAttributeTargets {
1586 return attribute_targets;
1590 // Wrapper for AssemblyBuilder.AddModule
1591 static MethodInfo adder_method;
1592 static public MethodInfo AddModule_Method {
1594 if (adder_method == null)
1595 adder_method = typeof (AssemblyBuilder).GetMethod ("AddModule", BindingFlags.Instance|BindingFlags.NonPublic);
1596 return adder_method;
1599 public Module AddModule (string module)
1601 MethodInfo m = AddModule_Method;
1603 Report.RuntimeMissingSupport (Location.Null, "/addmodule");
1604 Environment.Exit (1);
1608 return (Module) m.Invoke (Builder, new object [] { module });
1609 } catch (TargetInvocationException ex) {
1610 throw ex.InnerException;