2 // codegen.cs: The code generator
5 // Miguel de Icaza (miguel@ximian.com)
6 // Marek Safar (marek.safar@gmail.com)
8 // Copyright 2001, 2002, 2003 Ximian, Inc.
9 // Copyright 2004 Novell, Inc.
10 // Copyright 2011 Xamarin Inc
14 using System.Collections.Generic;
15 using Mono.CompilerServices.SymbolWriter;
18 using MetaType = IKVM.Reflection.Type;
19 using IKVM.Reflection;
20 using IKVM.Reflection.Emit;
22 using MetaType = System.Type;
23 using System.Reflection;
24 using System.Reflection.Emit;
30 /// An Emit Context is created for each body of code (from methods,
31 /// properties bodies, indexer bodies or constructor bodies)
33 public class EmitContext : BuilderContext
35 // TODO: Has to be private
36 public readonly ILGenerator ig;
39 /// The value that is allowed to be returned or NULL if there is no
42 readonly TypeSpec return_type;
45 /// Keeps track of the Type to LocalBuilder temporary storage created
46 /// to store structures (used to compute the address of the structure
47 /// value on structure method invocations)
49 Dictionary<TypeSpec, object> temporary_storage;
52 /// The location where we store the return value.
54 public LocalBuilder return_value;
58 /// Current loop begin and end labels.
60 public Label LoopBegin, LoopEnd;
63 /// Default target in a switch statement. Only valid if
66 public Label DefaultTarget;
69 /// If this is non-null, points to the current switch statement
74 /// Whether we are inside an anonymous method.
76 public AnonymousExpression CurrentAnonymousMethod;
78 readonly IMemberContext member_context;
80 readonly SourceMethodBuilder methodSymbols;
82 DynamicSiteClass dynamic_site_container;
86 List<IExpressionCleanup> epilogue_expressions;
88 public EmitContext (IMemberContext rc, ILGenerator ig, TypeSpec return_type, SourceMethodBuilder methodSymbols)
90 this.member_context = rc;
92 this.return_type = return_type;
94 if (rc.Module.Compiler.Settings.Checked)
95 flags |= Options.CheckedScope;
97 if (methodSymbols != null) {
98 this.methodSymbols = methodSymbols;
99 if (!rc.Module.Compiler.Settings.Optimize)
100 flags |= Options.AccurateDebugInfo;
102 flags |= Options.OmitDebugInfo;
106 ig.__CleverExceptionBlockAssistance ();
112 internal AsyncTaskStorey AsyncTaskStorey {
114 return CurrentAnonymousMethod.Storey as AsyncTaskStorey;
118 public BuiltinTypes BuiltinTypes {
120 return MemberContext.Module.Compiler.BuiltinTypes;
124 public ConditionalAccessContext ConditionalAccess { get; set; }
126 public TypeSpec CurrentType {
127 get { return member_context.CurrentType; }
130 public TypeParameters CurrentTypeParameters {
131 get { return member_context.CurrentTypeParameters; }
134 public MemberCore CurrentTypeDefinition {
135 get { return member_context.CurrentMemberDefinition; }
138 public bool EmitAccurateDebugInfo {
140 return (flags & Options.AccurateDebugInfo) != 0;
144 public bool HasMethodSymbolBuilder {
146 return methodSymbols != null;
150 public bool HasReturnLabel {
152 return return_label.HasValue;
156 public bool IsStatic {
157 get { return member_context.IsStatic; }
160 public bool IsStaticConstructor {
162 return member_context.IsStatic && (flags & Options.ConstructorScope) != 0;
166 public bool IsAnonymousStoreyMutateRequired {
168 return CurrentAnonymousMethod != null &&
169 CurrentAnonymousMethod.Storey != null &&
170 CurrentAnonymousMethod.Storey.Mutator != null;
174 public IMemberContext MemberContext {
176 return member_context;
180 public ModuleContainer Module {
182 return member_context.Module;
186 public bool NotifyEvaluatorOnStore {
188 return Module.Evaluator != null && Module.Evaluator.ModificationListener != null;
192 // Has to be used for specific emitter errors only any
193 // possible resolver errors have to be reported during Resolve
194 public Report Report {
196 return member_context.Module.Compiler.Report;
200 public TypeSpec ReturnType {
207 // The label where we have to jump before leaving the context
209 public Label ReturnLabel {
211 return return_label.Value;
215 public List<IExpressionCleanup> StatementEpilogue {
217 return epilogue_expressions;
221 public LocalVariable AsyncThrowVariable { get; set; }
223 public List<TryFinally> TryFinallyUnwind { get; set; }
225 public Label RecursivePatternLabel { get; set; }
229 public void AddStatementEpilog (IExpressionCleanup cleanupExpression)
231 if (epilogue_expressions == null) {
232 epilogue_expressions = new List<IExpressionCleanup> ();
233 } else if (epilogue_expressions.Contains (cleanupExpression)) {
237 epilogue_expressions.Add (cleanupExpression);
240 public void AssertEmptyStack ()
243 if (ig.__StackHeight != 0)
244 throw new InternalErrorException ("Await yields with non-empty stack in `{0}",
245 member_context.GetSignatureForError ());
250 /// This is called immediately before emitting an IL opcode to tell the symbol
251 /// writer to which source line this opcode belongs.
253 public bool Mark (Location loc)
255 if ((flags & Options.OmitDebugInfo) != 0)
258 if (loc.IsNull || methodSymbols == null)
261 var sf = loc.SourceFile;
262 if (sf.IsHiddenLocation (loc))
266 methodSymbols.MarkSequencePoint (ig.ILOffset, sf.SourceFileEntry, loc.Row, loc.Column, false);
271 public void MarkCallEntry (Location loc)
273 if (!EmitAccurateDebugInfo)
277 // TODO: This should emit different kind of sequence point to make
278 // step-over work for statement over multiple lines
280 // Debugging experience for Foo (A () + B ()) where A and B are
281 // on separate lines is not great
286 public void DefineLocalVariable (string name, LocalBuilder builder)
288 if ((flags & Options.OmitDebugInfo) != 0)
291 methodSymbols.AddLocal (builder.LocalIndex, name);
294 public void BeginCatchBlock (TypeSpec type)
296 if (IsAnonymousStoreyMutateRequired)
297 type = CurrentAnonymousMethod.Storey.Mutator.Mutate (type);
299 ig.BeginCatchBlock (type.GetMetaInfo ());
302 public void BeginFilterHandler ()
304 ig.BeginCatchBlock (null);
307 public void BeginExceptionBlock ()
309 ig.BeginExceptionBlock ();
312 public void BeginExceptionFilterBlock ()
314 ig.BeginExceptFilterBlock ();
317 public void BeginFinallyBlock ()
319 ig.BeginFinallyBlock ();
322 public void BeginScope ()
324 if ((flags & Options.OmitDebugInfo) != 0)
328 methodSymbols.StartBlock (CodeBlockEntry.Type.Lexical, ig.ILOffset);
332 public void BeginCompilerScope ()
334 if ((flags & Options.OmitDebugInfo) != 0)
338 methodSymbols.StartBlock (CodeBlockEntry.Type.CompilerGenerated, ig.ILOffset);
342 public void EndExceptionBlock ()
344 ig.EndExceptionBlock ();
347 public void EndScope ()
349 if ((flags & Options.OmitDebugInfo) != 0)
353 methodSymbols.EndBlock (ig.ILOffset);
357 public void CloseConditionalAccess (TypeSpec type)
360 Emit (OpCodes.Newobj, Nullable.NullableInfo.GetConstructor (type));
362 MarkLabel (ConditionalAccess.EndLabel);
363 ConditionalAccess = null;
367 // Creates a nested container in this context for all dynamic compiler generated stuff
369 internal DynamicSiteClass CreateDynamicSite ()
371 if (dynamic_site_container == null) {
372 var mc = member_context.CurrentMemberDefinition as MemberBase;
373 dynamic_site_container = new DynamicSiteClass (CurrentTypeDefinition.Parent.PartialContainer, mc, member_context.CurrentTypeParameters);
375 CurrentTypeDefinition.Module.AddCompilerGeneratedClass (dynamic_site_container);
376 dynamic_site_container.CreateContainer ();
377 dynamic_site_container.DefineContainer ();
378 dynamic_site_container.Define ();
380 var inflator = new TypeParameterInflator (Module, CurrentType, TypeParameterSpec.EmptyTypes, TypeSpec.EmptyTypes);
381 var inflated = dynamic_site_container.CurrentType.InflateMember (inflator);
382 CurrentType.MemberCache.AddMember (inflated);
385 return dynamic_site_container;
388 public Label CreateReturnLabel ()
390 if (!return_label.HasValue)
391 return_label = DefineLabel ();
393 return return_label.Value;
396 public LocalBuilder DeclareLocal (TypeSpec type, bool pinned)
398 if (IsAnonymousStoreyMutateRequired)
399 type = CurrentAnonymousMethod.Storey.Mutator.Mutate (type);
401 return ig.DeclareLocal (type.GetMetaInfo (), pinned);
404 public Label DefineLabel ()
406 return ig.DefineLabel ();
410 // Creates temporary field in current async storey
412 public StackFieldExpr GetTemporaryField (TypeSpec type, bool initializedFieldRequired = false)
414 var f = AsyncTaskStorey.AddCapturedLocalVariable (type, initializedFieldRequired);
415 var fexpr = new StackFieldExpr (f);
416 fexpr.InstanceExpression = new CompilerGeneratedThis (CurrentType, Location.Null);
420 public void MarkLabel (Label label)
422 ig.MarkLabel (label);
425 public void Emit (OpCode opcode)
430 public void Emit (OpCode opcode, LocalBuilder local)
432 ig.Emit (opcode, local);
435 public void Emit (OpCode opcode, string arg)
437 ig.Emit (opcode, arg);
440 public void Emit (OpCode opcode, double arg)
442 ig.Emit (opcode, arg);
445 public void Emit (OpCode opcode, float arg)
447 ig.Emit (opcode, arg);
450 public void Emit (OpCode opcode, Label label)
452 ig.Emit (opcode, label);
455 public void Emit (OpCode opcode, Label[] labels)
457 ig.Emit (opcode, labels);
460 public void Emit (OpCode opcode, TypeSpec type)
462 if (IsAnonymousStoreyMutateRequired)
463 type = CurrentAnonymousMethod.Storey.Mutator.Mutate (type);
465 ig.Emit (opcode, type.GetMetaInfo ());
468 public void Emit (OpCode opcode, FieldSpec field)
470 if (IsAnonymousStoreyMutateRequired)
471 field = field.Mutate (CurrentAnonymousMethod.Storey.Mutator);
473 ig.Emit (opcode, field.GetMetaInfo ());
476 public void Emit (OpCode opcode, MethodSpec method)
478 if (IsAnonymousStoreyMutateRequired)
479 method = method.Mutate (CurrentAnonymousMethod.Storey.Mutator);
481 if (method.IsConstructor)
482 ig.Emit (opcode, (ConstructorInfo) method.GetMetaInfo ());
484 ig.Emit (opcode, (MethodInfo) method.GetMetaInfo ());
487 // TODO: REMOVE breaks mutator
488 public void Emit (OpCode opcode, MethodInfo method)
490 ig.Emit (opcode, method);
493 public void Emit (OpCode opcode, MethodSpec method, MetaType[] vargs)
495 // TODO MemberCache: This should mutate too
496 ig.EmitCall (opcode, (MethodInfo) method.GetMetaInfo (), vargs);
499 public void EmitArrayNew (ArrayContainer ac)
502 var type = IsAnonymousStoreyMutateRequired ?
503 CurrentAnonymousMethod.Storey.Mutator.Mutate (ac.Element) :
506 ig.Emit (OpCodes.Newarr, type.GetMetaInfo ());
508 if (IsAnonymousStoreyMutateRequired)
509 ac = (ArrayContainer) ac.Mutate (CurrentAnonymousMethod.Storey.Mutator);
511 ig.Emit (OpCodes.Newobj, ac.GetConstructor ());
515 public void EmitArrayAddress (ArrayContainer ac)
518 if (IsAnonymousStoreyMutateRequired)
519 ac = (ArrayContainer) ac.Mutate (CurrentAnonymousMethod.Storey.Mutator);
521 ig.Emit (OpCodes.Call, ac.GetAddressMethod ());
523 var type = IsAnonymousStoreyMutateRequired ?
524 CurrentAnonymousMethod.Storey.Mutator.Mutate (ac.Element) :
527 ig.Emit (OpCodes.Ldelema, type.GetMetaInfo ());
532 // Emits the right opcode to load from an array
534 public void EmitArrayLoad (ArrayContainer ac)
537 if (IsAnonymousStoreyMutateRequired)
538 ac = (ArrayContainer) ac.Mutate (CurrentAnonymousMethod.Storey.Mutator);
540 ig.Emit (OpCodes.Call, ac.GetGetMethod ());
545 var type = ac.Element;
546 if (type.Kind == MemberKind.Enum)
547 type = EnumSpec.GetUnderlyingType (type);
549 switch (type.BuiltinType) {
550 case BuiltinTypeSpec.Type.Bool:
552 // Workaround MSIL limitation. Load bool element as single bit,
553 // bool array can actually store any byte value
555 ig.Emit (OpCodes.Ldelem_U1);
556 ig.Emit (OpCodes.Ldc_I4_0);
557 ig.Emit (OpCodes.Cgt_Un);
559 case BuiltinTypeSpec.Type.Byte:
560 ig.Emit (OpCodes.Ldelem_U1);
562 case BuiltinTypeSpec.Type.SByte:
563 ig.Emit (OpCodes.Ldelem_I1);
565 case BuiltinTypeSpec.Type.Short:
566 ig.Emit (OpCodes.Ldelem_I2);
568 case BuiltinTypeSpec.Type.UShort:
569 case BuiltinTypeSpec.Type.Char:
570 ig.Emit (OpCodes.Ldelem_U2);
572 case BuiltinTypeSpec.Type.Int:
573 ig.Emit (OpCodes.Ldelem_I4);
575 case BuiltinTypeSpec.Type.UInt:
576 ig.Emit (OpCodes.Ldelem_U4);
578 case BuiltinTypeSpec.Type.ULong:
579 case BuiltinTypeSpec.Type.Long:
580 ig.Emit (OpCodes.Ldelem_I8);
582 case BuiltinTypeSpec.Type.Float:
583 ig.Emit (OpCodes.Ldelem_R4);
585 case BuiltinTypeSpec.Type.Double:
586 ig.Emit (OpCodes.Ldelem_R8);
588 case BuiltinTypeSpec.Type.IntPtr:
589 ig.Emit (OpCodes.Ldelem_I);
593 case MemberKind.Struct:
594 if (IsAnonymousStoreyMutateRequired)
595 type = CurrentAnonymousMethod.Storey.Mutator.Mutate (type);
597 ig.Emit (OpCodes.Ldelema, type.GetMetaInfo ());
598 ig.Emit (OpCodes.Ldobj, type.GetMetaInfo ());
600 case MemberKind.TypeParameter:
601 if (IsAnonymousStoreyMutateRequired)
602 type = CurrentAnonymousMethod.Storey.Mutator.Mutate (type);
604 ig.Emit (OpCodes.Ldelem, type.GetMetaInfo ());
606 case MemberKind.PointerType:
607 ig.Emit (OpCodes.Ldelem_I);
610 ig.Emit (OpCodes.Ldelem_Ref);
618 // Emits the right opcode to store to an array
620 public void EmitArrayStore (ArrayContainer ac)
623 if (IsAnonymousStoreyMutateRequired)
624 ac = (ArrayContainer) ac.Mutate (CurrentAnonymousMethod.Storey.Mutator);
626 ig.Emit (OpCodes.Call, ac.GetSetMethod ());
630 var type = ac.Element;
632 if (type.Kind == MemberKind.Enum)
633 type = EnumSpec.GetUnderlyingType (type);
635 switch (type.BuiltinType) {
636 case BuiltinTypeSpec.Type.Byte:
637 case BuiltinTypeSpec.Type.SByte:
638 case BuiltinTypeSpec.Type.Bool:
639 Emit (OpCodes.Stelem_I1);
641 case BuiltinTypeSpec.Type.Short:
642 case BuiltinTypeSpec.Type.UShort:
643 case BuiltinTypeSpec.Type.Char:
644 Emit (OpCodes.Stelem_I2);
646 case BuiltinTypeSpec.Type.Int:
647 case BuiltinTypeSpec.Type.UInt:
648 Emit (OpCodes.Stelem_I4);
650 case BuiltinTypeSpec.Type.Long:
651 case BuiltinTypeSpec.Type.ULong:
652 Emit (OpCodes.Stelem_I8);
654 case BuiltinTypeSpec.Type.Float:
655 Emit (OpCodes.Stelem_R4);
657 case BuiltinTypeSpec.Type.Double:
658 Emit (OpCodes.Stelem_R8);
663 case MemberKind.Struct:
664 Emit (OpCodes.Stobj, type);
666 case MemberKind.TypeParameter:
667 Emit (OpCodes.Stelem, type);
669 case MemberKind.PointerType:
670 Emit (OpCodes.Stelem_I);
673 Emit (OpCodes.Stelem_Ref);
678 public void EmitInt (int i)
683 void EmitIntConstant (int i)
687 ig.Emit (OpCodes.Ldc_I4_M1);
691 ig.Emit (OpCodes.Ldc_I4_0);
695 ig.Emit (OpCodes.Ldc_I4_1);
699 ig.Emit (OpCodes.Ldc_I4_2);
703 ig.Emit (OpCodes.Ldc_I4_3);
707 ig.Emit (OpCodes.Ldc_I4_4);
711 ig.Emit (OpCodes.Ldc_I4_5);
715 ig.Emit (OpCodes.Ldc_I4_6);
719 ig.Emit (OpCodes.Ldc_I4_7);
723 ig.Emit (OpCodes.Ldc_I4_8);
727 if (i >= -128 && i <= 127) {
728 ig.Emit (OpCodes.Ldc_I4_S, (sbyte) i);
730 ig.Emit (OpCodes.Ldc_I4, i);
735 public void EmitLong (long l)
737 if (l >= int.MinValue && l <= int.MaxValue) {
738 EmitIntConstant (unchecked ((int) l));
739 ig.Emit (OpCodes.Conv_I8);
740 } else if (l >= 0 && l <= uint.MaxValue) {
741 EmitIntConstant (unchecked ((int) l));
742 ig.Emit (OpCodes.Conv_U8);
744 ig.Emit (OpCodes.Ldc_I8, l);
749 // Load the object from the pointer.
751 public void EmitLoadFromPtr (TypeSpec type)
753 if (type.Kind == MemberKind.Enum)
754 type = EnumSpec.GetUnderlyingType (type);
756 switch (type.BuiltinType) {
757 case BuiltinTypeSpec.Type.Int:
758 ig.Emit (OpCodes.Ldind_I4);
760 case BuiltinTypeSpec.Type.UInt:
761 ig.Emit (OpCodes.Ldind_U4);
763 case BuiltinTypeSpec.Type.Short:
764 ig.Emit (OpCodes.Ldind_I2);
766 case BuiltinTypeSpec.Type.UShort:
767 case BuiltinTypeSpec.Type.Char:
768 ig.Emit (OpCodes.Ldind_U2);
770 case BuiltinTypeSpec.Type.Byte:
771 ig.Emit (OpCodes.Ldind_U1);
773 case BuiltinTypeSpec.Type.SByte:
774 ig.Emit (OpCodes.Ldind_I1);
776 case BuiltinTypeSpec.Type.Bool:
777 ig.Emit (OpCodes.Ldind_I1);
778 ig.Emit (OpCodes.Ldc_I4_0);
779 ig.Emit (OpCodes.Cgt_Un);
781 case BuiltinTypeSpec.Type.ULong:
782 case BuiltinTypeSpec.Type.Long:
783 ig.Emit (OpCodes.Ldind_I8);
785 case BuiltinTypeSpec.Type.Float:
786 ig.Emit (OpCodes.Ldind_R4);
788 case BuiltinTypeSpec.Type.Double:
789 ig.Emit (OpCodes.Ldind_R8);
791 case BuiltinTypeSpec.Type.IntPtr:
792 ig.Emit (OpCodes.Ldind_I);
796 case MemberKind.Struct:
797 case MemberKind.TypeParameter:
798 if (IsAnonymousStoreyMutateRequired)
799 type = CurrentAnonymousMethod.Storey.Mutator.Mutate (type);
801 ig.Emit (OpCodes.Ldobj, type.GetMetaInfo ());
803 case MemberKind.PointerType:
804 ig.Emit (OpCodes.Ldind_I);
807 ig.Emit (OpCodes.Ldind_Ref);
814 public void EmitNull ()
816 ig.Emit (OpCodes.Ldnull);
819 public void EmitArgumentAddress (int pos)
824 if (pos > byte.MaxValue)
825 ig.Emit (OpCodes.Ldarga, pos);
827 ig.Emit (OpCodes.Ldarga_S, (byte) pos);
830 public void EmitArgumentLoad (int pos)
836 case 0: ig.Emit (OpCodes.Ldarg_0); break;
837 case 1: ig.Emit (OpCodes.Ldarg_1); break;
838 case 2: ig.Emit (OpCodes.Ldarg_2); break;
839 case 3: ig.Emit (OpCodes.Ldarg_3); break;
841 if (pos > byte.MaxValue)
842 ig.Emit (OpCodes.Ldarg, pos);
844 ig.Emit (OpCodes.Ldarg_S, (byte) pos);
849 public void EmitArgumentStore (int pos)
854 if (pos > byte.MaxValue)
855 ig.Emit (OpCodes.Starg, pos);
857 ig.Emit (OpCodes.Starg_S, (byte) pos);
861 // The stack contains the pointer and the value of type `type'
863 public void EmitStoreFromPtr (TypeSpec type)
866 type = EnumSpec.GetUnderlyingType (type);
868 switch (type.BuiltinType) {
869 case BuiltinTypeSpec.Type.Int:
870 case BuiltinTypeSpec.Type.UInt:
871 ig.Emit (OpCodes.Stind_I4);
873 case BuiltinTypeSpec.Type.Long:
874 case BuiltinTypeSpec.Type.ULong:
875 ig.Emit (OpCodes.Stind_I8);
877 case BuiltinTypeSpec.Type.Char:
878 case BuiltinTypeSpec.Type.Short:
879 case BuiltinTypeSpec.Type.UShort:
880 ig.Emit (OpCodes.Stind_I2);
882 case BuiltinTypeSpec.Type.Float:
883 ig.Emit (OpCodes.Stind_R4);
885 case BuiltinTypeSpec.Type.Double:
886 ig.Emit (OpCodes.Stind_R8);
888 case BuiltinTypeSpec.Type.Byte:
889 case BuiltinTypeSpec.Type.SByte:
890 case BuiltinTypeSpec.Type.Bool:
891 ig.Emit (OpCodes.Stind_I1);
893 case BuiltinTypeSpec.Type.IntPtr:
894 ig.Emit (OpCodes.Stind_I);
899 case MemberKind.Struct:
900 case MemberKind.TypeParameter:
901 if (IsAnonymousStoreyMutateRequired)
902 type = CurrentAnonymousMethod.Storey.Mutator.Mutate (type);
904 ig.Emit (OpCodes.Stobj, type.GetMetaInfo ());
907 ig.Emit (OpCodes.Stind_Ref);
912 public void EmitThis ()
914 ig.Emit (OpCodes.Ldarg_0);
917 public void EmitEpilogue ()
919 if (epilogue_expressions == null)
922 foreach (var e in epilogue_expressions)
923 e.EmitCleanup (this);
925 epilogue_expressions = null;
929 /// Returns a temporary storage for a variable of type t as
930 /// a local variable in the current body.
932 public LocalBuilder GetTemporaryLocal (TypeSpec t)
934 if (temporary_storage != null) {
936 if (temporary_storage.TryGetValue (t, out o)) {
937 if (o is Stack<LocalBuilder>) {
938 var s = (Stack<LocalBuilder>) o;
939 o = s.Count == 0 ? null : s.Pop ();
941 temporary_storage.Remove (t);
945 return (LocalBuilder) o;
947 return DeclareLocal (t, false);
950 public void FreeTemporaryLocal (LocalBuilder b, TypeSpec t)
952 if (temporary_storage == null) {
953 temporary_storage = new Dictionary<TypeSpec, object> (ReferenceEquality<TypeSpec>.Default);
954 temporary_storage.Add (t, b);
959 if (!temporary_storage.TryGetValue (t, out o)) {
960 temporary_storage.Add (t, b);
963 var s = o as Stack<LocalBuilder>;
965 s = new Stack<LocalBuilder> ();
966 s.Push ((LocalBuilder)o);
967 temporary_storage [t] = s;
973 /// ReturnValue creates on demand the LocalBuilder for the
974 /// return value from the function. By default this is not
975 /// used. This is only required when returns are found inside
976 /// Try or Catch statements.
978 /// This method is typically invoked from the Emit phase, so
979 /// we allow the creation of a return label if it was not
980 /// requested during the resolution phase. Could be cleaned
981 /// up, but it would replicate a lot of logic in the Emit phase
982 /// of the code that uses it.
984 public LocalBuilder TemporaryReturn ()
986 if (return_value == null){
987 return_value = DeclareLocal (return_type, false);
994 public class ConditionalAccessContext
996 public ConditionalAccessContext (TypeSpec type, Label endLabel)
1002 public bool Statement { get; set; }
1003 public Label EndLabel { get; private set; }
1004 public TypeSpec Type { get; private set; }
1009 public Expression InstanceExpression;
1012 // When call has to leave an extra copy of all arguments on the stack
1014 public bool DuplicateArguments;
1017 // Does not emit InstanceExpression load when InstanceExpressionOnStack
1018 // is set. Used by compound assignments.
1020 public bool InstanceExpressionOnStack;
1023 // Any of arguments contains await expression
1025 public bool HasAwaitArguments;
1027 public bool ConditionalAccess;
1030 // When dealing with await arguments the original arguments are converted
1031 // into a new set with hoisted stack results
1033 public Arguments EmittedArguments;
1035 public void Emit (EmitContext ec, MethodSpec method, Arguments Arguments, Location loc)
1037 EmitPredefined (ec, method, Arguments, false, loc);
1040 public void EmitStatement (EmitContext ec, MethodSpec method, Arguments Arguments, Location loc)
1042 EmitPredefined (ec, method, Arguments, true, loc);
1045 public void EmitPredefined (EmitContext ec, MethodSpec method, Arguments Arguments, bool statement = false, Location? loc = null)
1047 Expression instance_copy = null;
1049 if (!HasAwaitArguments && ec.HasSet (BuilderContext.Options.AsyncBody)) {
1050 HasAwaitArguments = Arguments != null && Arguments.ContainsEmitWithAwait ();
1051 if (HasAwaitArguments && InstanceExpressionOnStack) {
1052 throw new NotSupportedException ();
1057 LocalTemporary lt = null;
1059 if (method.IsStatic) {
1060 call_op = OpCodes.Call;
1062 call_op = IsVirtualCallRequired (InstanceExpression, method) ? OpCodes.Callvirt : OpCodes.Call;
1064 if (HasAwaitArguments) {
1065 instance_copy = InstanceExpression.EmitToField (ec);
1066 var ie = new InstanceEmitter (instance_copy, IsAddressCall (instance_copy, call_op, method.DeclaringType));
1068 if (Arguments == null) {
1071 } else if (!InstanceExpressionOnStack) {
1072 var ie = new InstanceEmitter (InstanceExpression, IsAddressCall (InstanceExpression, call_op, method.DeclaringType));
1073 ie.Emit (ec, ConditionalAccess);
1075 if (DuplicateArguments) {
1076 ec.Emit (OpCodes.Dup);
1077 if (Arguments != null && Arguments.Count != 0) {
1078 lt = new LocalTemporary (ie.GetStackType (ec));
1086 if (Arguments != null && !InstanceExpressionOnStack) {
1087 EmittedArguments = Arguments.Emit (ec, DuplicateArguments, HasAwaitArguments);
1088 if (EmittedArguments != null) {
1089 if (instance_copy != null) {
1090 var ie = new InstanceEmitter (instance_copy, IsAddressCall (instance_copy, call_op, method.DeclaringType));
1091 ie.Emit (ec, ConditionalAccess);
1097 EmittedArguments.Emit (ec);
1101 if (call_op == OpCodes.Callvirt && (InstanceExpression.Type.IsGenericParameter || InstanceExpression.Type.IsStructOrEnum)) {
1102 ec.Emit (OpCodes.Constrained, InstanceExpression.Type);
1107 // Emit explicit sequence point for expressions like Foo.Bar () to help debugger to
1108 // break at right place when LHS expression can be stepped-into
1110 ec.MarkCallEntry (loc.Value);
1114 // Set instance expression to actual result expression. When it contains await it can be
1115 // picked up by caller
1117 InstanceExpression = instance_copy;
1119 if (method.Parameters.HasArglist) {
1120 var varargs_types = GetVarargsTypes (method, Arguments);
1121 ec.Emit (call_op, method, varargs_types);
1126 // and DoFoo is not virtual, you can omit the callvirt,
1127 // because you don't need the null checking behavior.
1129 ec.Emit (call_op, method);
1133 // Pop the return value if there is one and stack should be empty
1135 if (statement && method.ReturnType.Kind != MemberKind.Void)
1136 ec.Emit (OpCodes.Pop);
1139 static MetaType[] GetVarargsTypes (MethodSpec method, Arguments arguments)
1141 AParametersCollection pd = method.Parameters;
1143 Argument a = arguments[pd.Count - 1];
1144 Arglist list = (Arglist) a.Expr;
1146 return list.ArgumentTypes;
1150 // Used to decide whether call or callvirt is needed
1152 static bool IsVirtualCallRequired (Expression instance, MethodSpec method)
1155 // There are 2 scenarious where we emit callvirt
1157 // Case 1: A method is virtual and it's not used to call base
1158 // Case 2: A method instance expression can be null. In this casen callvirt ensures
1159 // correct NRE exception when the method is called
1161 var decl_type = method.DeclaringType;
1162 if (decl_type.IsStruct || decl_type.IsEnum)
1165 if (instance is BaseThis)
1169 // It's non-virtual and will never be null and it can be determined
1170 // whether it's known value or reference type by verifier
1172 if (!method.IsVirtual && Expression.IsNeverNull (instance) && !instance.Type.IsGenericParameter)
1178 static bool IsAddressCall (Expression instance, OpCode callOpcode, TypeSpec declaringType)
1180 var instance_type = instance.Type;
1181 return (instance_type.IsStructOrEnum && (callOpcode == OpCodes.Callvirt || (callOpcode == OpCodes.Call && declaringType.IsStruct))) ||
1182 instance_type.IsGenericParameter || declaringType.IsNullableType;
1186 public struct InstanceEmitter
1188 readonly Expression instance;
1189 readonly bool addressRequired;
1191 public InstanceEmitter (Expression instance, bool addressLoad)
1193 this.instance = instance;
1194 this.addressRequired = addressLoad;
1197 public void Emit (EmitContext ec, bool conditionalAccess)
1199 Label NullOperatorLabel;
1200 Nullable.Unwrap unwrap;
1202 if (conditionalAccess && Expression.IsNeverNull (instance))
1203 conditionalAccess = false;
1205 if (conditionalAccess) {
1206 NullOperatorLabel = ec.DefineLabel ();
1207 unwrap = instance as Nullable.Unwrap;
1209 NullOperatorLabel = new Label ();
1213 IMemoryLocation instance_address = null;
1214 bool conditional_access_dup = false;
1216 if (unwrap != null) {
1218 unwrap.EmitCheck (ec);
1219 ec.Emit (OpCodes.Brtrue_S, NullOperatorLabel);
1221 if (conditionalAccess && addressRequired) {
1223 // Don't allocate temp variable when instance load is cheap and load and load-address
1224 // operate on same memory
1226 instance_address = instance as VariableReference;
1227 if (instance_address == null)
1228 instance_address = instance as LocalTemporary;
1230 if (instance_address == null) {
1232 ec.Emit (OpCodes.Dup);
1233 ec.EmitLoadFromPtr (instance.Type);
1235 conditional_access_dup = true;
1240 if (instance.Type.Kind == MemberKind.TypeParameter)
1241 ec.Emit (OpCodes.Box, instance.Type);
1245 if (conditionalAccess) {
1246 conditional_access_dup = !IsInexpensiveLoad ();
1247 if (conditional_access_dup)
1248 ec.Emit (OpCodes.Dup);
1252 if (conditionalAccess) {
1253 ec.Emit (OpCodes.Brtrue_S, NullOperatorLabel);
1255 if (conditional_access_dup)
1256 ec.Emit (OpCodes.Pop);
1260 if (conditionalAccess) {
1261 if (!ec.ConditionalAccess.Statement) {
1262 if (ec.ConditionalAccess.Type.IsNullableType)
1263 Nullable.LiftedNull.Create (ec.ConditionalAccess.Type, Location.Null).Emit (ec);
1268 ec.Emit (OpCodes.Br, ec.ConditionalAccess.EndLabel);
1269 ec.MarkLabel (NullOperatorLabel);
1271 if (instance_address != null) {
1272 instance_address.AddressOf (ec, AddressOp.Load);
1273 } else if (unwrap != null) {
1275 var tmp = ec.GetTemporaryLocal (unwrap.Type);
1276 ec.Emit (OpCodes.Stloc, tmp);
1277 ec.Emit (OpCodes.Ldloca, tmp);
1278 ec.FreeTemporaryLocal (tmp, unwrap.Type);
1279 } else if (!conditional_access_dup) {
1285 public void EmitLoad (EmitContext ec)
1287 var instance_type = instance.Type;
1290 // Push the instance expression
1292 if (addressRequired) {
1294 // If the expression implements IMemoryLocation, then
1295 // we can optimize and use AddressOf on the
1298 // If not we have to use some temporary storage for
1300 var iml = instance as IMemoryLocation;
1302 iml.AddressOf (ec, AddressOp.Load);
1304 LocalTemporary temp = new LocalTemporary (instance_type);
1307 temp.AddressOf (ec, AddressOp.Load);
1315 // Only to make verifier happy
1316 if (RequiresBoxing ())
1317 ec.Emit (OpCodes.Box, instance_type);
1320 public TypeSpec GetStackType (EmitContext ec)
1322 var instance_type = instance.Type;
1324 if (addressRequired)
1325 return ReferenceContainer.MakeType (ec.Module, instance_type);
1327 if (instance_type.IsStructOrEnum)
1328 return ec.Module.Compiler.BuiltinTypes.Object;
1330 return instance_type;
1333 bool RequiresBoxing ()
1335 var instance_type = instance.Type;
1336 if (instance_type.IsGenericParameter && !(instance is This) && TypeSpec.IsReferenceType (instance_type))
1339 if (instance_type.IsStructOrEnum)
1345 bool IsInexpensiveLoad ()
1347 if (instance is Constant)
1348 return instance.IsSideEffectFree;
1350 if (RequiresBoxing ())
1353 var vr = instance as VariableReference;
1357 if (instance is LocalTemporary)
1360 var fe = instance as FieldExpr;
1362 return fe.IsStatic || fe.InstanceExpression is This;