2 // flowanalyis.cs: The control flow analysis code
5 // Martin Baulig (martin@ximian.com)
6 // Raja R Harinath (rharinath@novell.com)
8 // Copyright 2001, 2002, 2003 Ximian, Inc.
9 // Copyright 2003-2008 Novell, Inc.
14 using System
.Collections
.Generic
;
15 using System
.Reflection
;
16 using System
.Reflection
.Emit
;
17 using System
.Diagnostics
;
22 // A new instance of this class is created every time a new block is resolved
23 // and if there's branching in the block's control flow.
25 public abstract class FlowBranching
28 // The type of a FlowBranching.
30 public enum BranchingType
: byte {
31 // Normal (conditional or toplevel) block.
40 // The statement embedded inside a loop
43 // part of a block headed by a jump target
49 // TryFinally, Using, Lock, CollectionForeach
55 // The toplevel block of a function
63 // The type of one sibling of a branching.
65 public enum SiblingType
: byte {
74 public static FlowBranching
CreateBranching (FlowBranching parent
, BranchingType type
, Block block
, Location loc
)
77 case BranchingType
.Exception
:
78 case BranchingType
.Labeled
:
79 case BranchingType
.Toplevel
:
80 case BranchingType
.TryCatch
:
81 throw new InvalidOperationException ();
83 case BranchingType
.Switch
:
84 return new FlowBranchingBreakable (parent
, type
, SiblingType
.SwitchSection
, block
, loc
);
86 case BranchingType
.Block
:
87 return new FlowBranchingBlock (parent
, type
, SiblingType
.Block
, block
, loc
);
89 case BranchingType
.Loop
:
90 return new FlowBranchingBreakable (parent
, type
, SiblingType
.Conditional
, block
, loc
);
92 case BranchingType
.Embedded
:
93 return new FlowBranchingContinuable (parent
, type
, SiblingType
.Conditional
, block
, loc
);
96 return new FlowBranchingBlock (parent
, type
, SiblingType
.Conditional
, block
, loc
);
101 // The type of this flow branching.
103 public readonly BranchingType Type
;
106 // The block this branching is contained in. This may be null if it's not
107 // a top-level block and it doesn't declare any local variables.
109 public readonly Block Block
;
112 // The parent of this branching or null if this is the top-block.
114 public readonly FlowBranching Parent
;
117 // Start-Location of this flow branching.
119 public readonly Location Location
;
121 static int next_id
= 0;
125 // The vector contains a BitArray with information about which local variables
126 // and parameters are already initialized at the current code position.
128 public class UsageVector
{
130 // The type of this branching.
132 public readonly SiblingType Type
;
135 // Start location of this branching.
137 public Location Location
;
140 // This is only valid for SwitchSection, Try, Catch and Finally.
142 public readonly Block Block
;
145 // The number of locals in this block.
147 public readonly int CountLocals
;
150 // If not null, then we inherit our state from this vector and do a
151 // copy-on-write. If null, then we're the first sibling in a top-level
152 // block and inherit from the empty vector.
154 public readonly UsageVector InheritsFrom
;
157 // This is used to construct a list of UsageVector's.
159 public UsageVector Next
;
167 static int next_id
= 0;
171 // Normally, you should not use any of these constructors.
173 public UsageVector (SiblingType type
, UsageVector parent
, Block block
, Location loc
, int num_locals
)
178 this.InheritsFrom
= parent
;
179 this.CountLocals
= num_locals
;
181 locals
= num_locals
== 0
183 : new MyBitVector (parent
== null ? MyBitVector
.Empty
: parent
.locals
, num_locals
);
186 is_unreachable
= parent
.is_unreachable
;
192 public UsageVector (SiblingType type
, UsageVector parent
, Block block
, Location loc
)
193 : this (type
, parent
, block
, loc
, parent
.CountLocals
)
196 private UsageVector (MyBitVector locals
, bool is_unreachable
, Block block
, Location loc
)
198 this.Type
= SiblingType
.Block
;
202 this.is_unreachable
= is_unreachable
;
204 this.locals
= locals
;
211 // This does a deep copy of the usage vector.
213 public UsageVector
Clone ()
215 UsageVector retval
= new UsageVector (Type
, null, Block
, Location
, CountLocals
);
217 retval
.locals
= locals
.Clone ();
218 retval
.is_unreachable
= is_unreachable
;
223 public bool IsAssigned (VariableInfo
var, bool ignoreReachability
)
225 if (!ignoreReachability
&& !var.IsParameter
&& IsUnreachable
)
228 return var.IsAssigned (locals
);
231 public void SetAssigned (VariableInfo
var)
233 if (!var.IsParameter
&& IsUnreachable
)
236 var.SetAssigned (locals
);
239 public bool IsFieldAssigned (VariableInfo
var, string name
)
241 if (!var.IsParameter
&& IsUnreachable
)
244 return var.IsFieldAssigned (locals
, name
);
247 public void SetFieldAssigned (VariableInfo
var, string name
)
249 if (!var.IsParameter
&& IsUnreachable
)
252 var.SetFieldAssigned (locals
, name
);
255 public bool IsUnreachable
{
256 get { return is_unreachable; }
259 public void ResetBarrier ()
261 is_unreachable
= false;
266 is_unreachable
= true;
269 public static UsageVector
MergeSiblings (UsageVector sibling_list
, Location loc
)
271 if (sibling_list
.Next
== null)
274 MyBitVector locals
= null;
275 bool is_unreachable
= sibling_list
.is_unreachable
;
277 if (!sibling_list
.IsUnreachable
)
278 locals
&= sibling_list
.locals
;
280 for (UsageVector child
= sibling_list
.Next
; child
!= null; child
= child
.Next
) {
281 is_unreachable
&= child
.is_unreachable
;
283 if (!child
.IsUnreachable
)
284 locals
&= child
.locals
;
287 return new UsageVector (locals
, is_unreachable
, null, loc
);
291 // Merges a child branching.
293 public UsageVector
MergeChild (UsageVector child
, bool overwrite
)
295 Report
.Debug (2, " MERGING CHILD EFFECTS", this, child
, Type
);
297 bool new_isunr
= child
.is_unreachable
;
300 // We've now either reached the point after the branching or we will
301 // never get there since we always return or always throw an exception.
303 // If we can reach the point after the branching, mark all locals and
304 // parameters as initialized which have been initialized in all branches
305 // we need to look at (see above).
308 if ((Type
== SiblingType
.SwitchSection
) && !new_isunr
) {
309 Report
.Error (163, Location
,
310 "Control cannot fall through from one " +
311 "case label to another");
315 locals
|= child
.locals
;
317 // throw away un-necessary information about variables in child blocks
318 if (locals
.Count
!= CountLocals
)
319 locals
= new MyBitVector (locals
, CountLocals
);
322 is_unreachable
= new_isunr
;
324 is_unreachable
|= new_isunr
;
329 public void MergeOrigins (UsageVector o_vectors
)
331 Report
.Debug (1, " MERGING BREAK ORIGINS", this);
333 if (o_vectors
== null)
336 if (IsUnreachable
&& locals
!= null)
337 locals
.SetAll (true);
339 for (UsageVector vector
= o_vectors
; vector
!= null; vector
= vector
.Next
) {
340 Report
.Debug (1, " MERGING BREAK ORIGIN", vector
);
341 if (vector
.IsUnreachable
)
343 locals
&= vector
.locals
;
344 is_unreachable
&= vector
.is_unreachable
;
347 Report
.Debug (1, " MERGING BREAK ORIGINS DONE", this);
354 public override string ToString ()
356 return String
.Format ("Vector ({0},{1},{2}-{3})", Type
, id
, is_unreachable
, locals
);
361 // Creates a new flow branching which is contained in `parent'.
362 // You should only pass non-null for the `block' argument if this block
363 // introduces any new variables - in this case, we need to create a new
364 // usage vector with a different size than our parent's one.
366 protected FlowBranching (FlowBranching parent
, BranchingType type
, SiblingType stype
,
367 Block block
, Location loc
)
377 UsageVector parent_vector
= parent
!= null ? parent
.CurrentUsageVector
: null;
378 vector
= new UsageVector (stype
, parent_vector
, Block
, loc
, Block
.AssignableSlots
);
380 vector
= new UsageVector (stype
, Parent
.CurrentUsageVector
, null, loc
);
386 public abstract UsageVector CurrentUsageVector
{
391 // Creates a sibling of the current usage vector.
393 public virtual void CreateSibling (Block block
, SiblingType type
)
395 UsageVector vector
= new UsageVector (
396 type
, Parent
.CurrentUsageVector
, block
, Location
);
399 Report
.Debug (1, " CREATED SIBLING", CurrentUsageVector
);
402 public void CreateSibling ()
404 CreateSibling (null, SiblingType
.Conditional
);
407 protected abstract void AddSibling (UsageVector uv
);
409 protected abstract UsageVector
Merge ();
411 public UsageVector
MergeChild (FlowBranching child
)
413 return CurrentUsageVector
.MergeChild (child
.Merge (), true);
416 public virtual bool CheckRethrow (Location loc
)
418 return Parent
.CheckRethrow (loc
);
421 public virtual bool AddResumePoint (ResumableStatement stmt
, Location loc
, out int pc
)
423 return Parent
.AddResumePoint (stmt
, loc
, out pc
);
426 // returns true if we crossed an unwind-protected region (try/catch/finally, lock, using, ...)
427 public virtual bool AddBreakOrigin (UsageVector vector
, Location loc
)
429 return Parent
.AddBreakOrigin (vector
, loc
);
432 // returns true if we crossed an unwind-protected region (try/catch/finally, lock, using, ...)
433 public virtual bool AddContinueOrigin (UsageVector vector
, Location loc
)
435 return Parent
.AddContinueOrigin (vector
, loc
);
438 // returns true if we crossed an unwind-protected region (try/catch/finally, lock, using, ...)
439 public virtual bool AddReturnOrigin (UsageVector vector
, ExitStatement stmt
)
441 return Parent
.AddReturnOrigin (vector
, stmt
);
444 // returns true if we crossed an unwind-protected region (try/catch/finally, lock, using, ...)
445 public virtual bool AddGotoOrigin (UsageVector vector
, Goto goto_stmt
)
447 return Parent
.AddGotoOrigin (vector
, goto_stmt
);
450 public bool IsAssigned (VariableInfo vi
)
452 return CurrentUsageVector
.IsAssigned (vi
, false);
455 public bool IsFieldAssigned (VariableInfo vi
, string field_name
)
457 return CurrentUsageVector
.IsAssigned (vi
, false) || CurrentUsageVector
.IsFieldAssigned (vi
, field_name
);
460 protected static Report Report
{
461 get { return RootContext.ToplevelTypes.Compiler.Report; }
464 public void SetAssigned (VariableInfo vi
)
466 CurrentUsageVector
.SetAssigned (vi
);
469 public void SetFieldAssigned (VariableInfo vi
, string name
)
471 CurrentUsageVector
.SetFieldAssigned (vi
, name
);
474 public override string ToString ()
476 StringBuilder sb
= new StringBuilder ();
477 sb
.Append (GetType ());
485 sb
.Append (Block
.ID
);
487 sb
.Append (Block
.StartLocation
);
490 // sb.Append (Siblings.Length);
491 // sb.Append (" - ");
492 sb
.Append (CurrentUsageVector
);
494 return sb
.ToString ();
498 get { return String.Format ("{0}
({1}
:{2}
:{3}
)", GetType (), id, Type, Location); }
502 public class FlowBranchingBlock : FlowBranching
504 UsageVector sibling_list = null;
506 public FlowBranchingBlock (FlowBranching parent, BranchingType type,
507 SiblingType stype, Block block, Location loc)
508 : base (parent, type, stype, block, loc)
511 public override UsageVector CurrentUsageVector {
512 get { return sibling_list; }
515 protected override void AddSibling (UsageVector sibling)
517 if (sibling_list != null && sibling_list.Type == SiblingType.Block)
518 throw new InternalErrorException ("Blocks don
't have sibling flow paths");
519 sibling.Next = sibling_list;
520 sibling_list = sibling;
523 public override bool AddGotoOrigin (UsageVector vector, Goto goto_stmt)
525 LabeledStatement stmt = Block == null ? null : Block.LookupLabel (goto_stmt.Target);
527 return Parent.AddGotoOrigin (vector, goto_stmt);
530 goto_stmt.SetResolvedTarget (stmt);
531 stmt.AddUsageVector (vector);
535 public static void Error_UnknownLabel (Location loc, string label, Report Report)
537 Report.Error(159, loc, "The label `{0}:' could not be found within the scope of the
goto statement
",
541 protected override UsageVector Merge ()
543 Report.Debug (2, " MERGING SIBLINGS
", Name);
544 UsageVector vector = UsageVector.MergeSiblings (sibling_list, Location);
545 Report.Debug (2, " MERGING SIBLINGS DONE
", Name, vector);
550 public class FlowBranchingBreakable : FlowBranchingBlock
552 UsageVector break_origins;
554 public FlowBranchingBreakable (FlowBranching parent, BranchingType type, SiblingType stype, Block block, Location loc)
555 : base (parent, type, stype, block, loc)
558 public override bool AddBreakOrigin (UsageVector vector, Location loc)
560 vector = vector.Clone ();
561 vector.Next = break_origins;
562 break_origins = vector;
566 protected override UsageVector Merge ()
568 UsageVector vector = base.Merge ();
569 vector.MergeOrigins (break_origins);
574 public class FlowBranchingContinuable : FlowBranchingBlock
576 UsageVector continue_origins;
578 public FlowBranchingContinuable (FlowBranching parent, BranchingType type, SiblingType stype, Block block, Location loc)
579 : base (parent, type, stype, block, loc)
582 public override bool AddContinueOrigin (UsageVector vector, Location loc)
584 vector = vector.Clone ();
585 vector.Next = continue_origins;
586 continue_origins = vector;
590 protected override UsageVector Merge ()
592 UsageVector vector = base.Merge ();
593 vector.MergeOrigins (continue_origins);
598 public class FlowBranchingLabeled : FlowBranchingBlock
600 LabeledStatement stmt;
603 public FlowBranchingLabeled (FlowBranching parent, LabeledStatement stmt)
604 : base (parent, BranchingType.Labeled, SiblingType.Conditional, null, stmt.loc)
607 CurrentUsageVector.MergeOrigins (stmt.JumpOrigins);
608 actual = CurrentUsageVector.Clone ();
610 // stand-in for backward jumps
611 CurrentUsageVector.ResetBarrier ();
614 public override bool AddGotoOrigin (UsageVector vector, Goto goto_stmt)
616 if (goto_stmt.Target != stmt.Name)
617 return Parent.AddGotoOrigin (vector, goto_stmt);
620 goto_stmt.SetResolvedTarget (stmt);
621 actual.MergeOrigins (vector.Clone ());
626 protected override UsageVector Merge ()
628 UsageVector vector = base.Merge ();
630 if (actual.IsUnreachable)
631 Report.Warning (162, 2, stmt.loc, "Unreachable code detected
");
633 actual.MergeChild (vector, false);
638 public class FlowBranchingIterator : FlowBranchingBlock
641 public FlowBranchingIterator (FlowBranching parent, Iterator iterator)
642 : base (parent, BranchingType.Iterator, SiblingType.Block, null, iterator.Location)
644 this.iterator = iterator;
647 public override bool AddResumePoint (ResumableStatement stmt, Location loc, out int pc)
649 pc = iterator.AddResumePoint (stmt);
654 public class FlowBranchingToplevel : FlowBranchingBlock
656 UsageVector return_origins;
658 public FlowBranchingToplevel (FlowBranching parent, ToplevelBlock stmt)
659 : base (parent, BranchingType.Toplevel, SiblingType.Conditional, stmt, stmt.loc)
663 public override bool CheckRethrow (Location loc)
665 Report.Error (156, loc, "A
throw statement with no arguments
is not allowed outside of a
catch clause
");
669 public override bool AddResumePoint (ResumableStatement stmt, Location loc, out int pc)
671 throw new InternalErrorException ("A
yield in a non
-iterator block
");
674 public override bool AddBreakOrigin (UsageVector vector, Location loc)
676 Report.Error (139, loc, "No enclosing loop
out of which to
break or
continue");
680 public override bool AddContinueOrigin (UsageVector vector, Location loc)
682 Report.Error (139, loc, "No enclosing loop
out of which to
break or
continue");
686 public override bool AddReturnOrigin (UsageVector vector, ExitStatement stmt)
688 vector = vector.Clone ();
689 vector.Location = stmt.loc;
690 vector.Next = return_origins;
691 return_origins = vector;
695 public override bool AddGotoOrigin (UsageVector vector, Goto goto_stmt)
697 string name = goto_stmt.Target;
698 LabeledStatement s = Block.LookupLabel (name);
700 throw new InternalErrorException ("Shouldn
't get here");
702 if (Parent == null) {
703 Error_UnknownLabel (goto_stmt.loc, name, Report);
707 int errors = Report.Errors;
708 Parent.AddGotoOrigin (vector, goto_stmt);
709 if (errors == Report.Errors)
710 Report.Error (1632, goto_stmt.loc, "Control cannot leave the body of an anonymous method");
714 protected override UsageVector Merge ()
716 for (UsageVector origin = return_origins; origin != null; origin = origin.Next)
717 Block.Toplevel.CheckOutParameters (origin, origin.Location);
719 UsageVector vector = base.Merge ();
720 Block.Toplevel.CheckOutParameters (vector, Block.loc);
721 // Note: we _do_not_ merge in the return origins
727 return Merge ().IsUnreachable;
731 public class FlowBranchingTryCatch : FlowBranchingBlock
734 public FlowBranchingTryCatch (FlowBranching parent, TryCatch stmt)
735 : base (parent, BranchingType.Block, SiblingType.Try, null, stmt.loc)
740 public override bool CheckRethrow (Location loc)
742 return CurrentUsageVector.Next != null || Parent.CheckRethrow (loc);
745 public override bool AddResumePoint (ResumableStatement stmt, Location loc, out int pc)
747 int errors = Report.Errors;
748 Parent.AddResumePoint (stmt, loc, out pc);
749 if (errors == Report.Errors) {
750 if (CurrentUsageVector.Next == null)
751 Report.Error (1626, loc, "Cannot yield a value in the body of a try block with a catch clause");
753 Report.Error (1631, loc, "Cannot yield a value in the body of a catch clause");
758 public override bool AddBreakOrigin (UsageVector vector, Location loc)
760 Parent.AddBreakOrigin (vector, loc);
761 stmt.SomeCodeFollows ();
765 public override bool AddContinueOrigin (UsageVector vector, Location loc)
767 Parent.AddContinueOrigin (vector, loc);
768 stmt.SomeCodeFollows ();
772 public override bool AddReturnOrigin (UsageVector vector, ExitStatement exit_stmt)
774 Parent.AddReturnOrigin (vector, exit_stmt);
775 stmt.SomeCodeFollows ();
779 public override bool AddGotoOrigin (UsageVector vector, Goto goto_stmt)
781 Parent.AddGotoOrigin (vector, goto_stmt);
786 public class FlowBranchingException : FlowBranching
788 ExceptionStatement stmt;
789 UsageVector current_vector;
790 UsageVector try_vector;
791 UsageVector finally_vector;
793 abstract class SavedOrigin {
794 public readonly SavedOrigin Next;
795 public readonly UsageVector Vector;
797 protected SavedOrigin (SavedOrigin next, UsageVector vector)
800 Vector = vector.Clone ();
803 protected abstract void DoPropagateFinally (FlowBranching parent);
804 public void PropagateFinally (UsageVector finally_vector, FlowBranching parent)
806 if (finally_vector != null)
807 Vector.MergeChild (finally_vector, false);
808 DoPropagateFinally (parent);
812 class BreakOrigin : SavedOrigin {
814 public BreakOrigin (SavedOrigin next, UsageVector vector, Location loc)
815 : base (next, vector)
820 protected override void DoPropagateFinally (FlowBranching parent)
822 parent.AddBreakOrigin (Vector, Loc);
826 class ContinueOrigin : SavedOrigin {
828 public ContinueOrigin (SavedOrigin next, UsageVector vector, Location loc)
829 : base (next, vector)
834 protected override void DoPropagateFinally (FlowBranching parent)
836 parent.AddContinueOrigin (Vector, Loc);
840 class ReturnOrigin : SavedOrigin {
841 public ExitStatement Stmt;
843 public ReturnOrigin (SavedOrigin next, UsageVector vector, ExitStatement stmt)
844 : base (next, vector)
849 protected override void DoPropagateFinally (FlowBranching parent)
851 parent.AddReturnOrigin (Vector, Stmt);
855 class GotoOrigin : SavedOrigin {
858 public GotoOrigin (SavedOrigin next, UsageVector vector, Goto stmt)
859 : base (next, vector)
864 protected override void DoPropagateFinally (FlowBranching parent)
866 parent.AddGotoOrigin (Vector, Stmt);
870 SavedOrigin saved_origins;
872 public FlowBranchingException (FlowBranching parent,
873 ExceptionStatement stmt)
874 : base (parent, BranchingType.Exception, SiblingType.Try,
880 protected override void AddSibling (UsageVector sibling)
882 switch (sibling.Type) {
883 case SiblingType.Try:
884 try_vector = sibling;
886 case SiblingType.Finally:
887 finally_vector = sibling;
890 throw new InvalidOperationException ();
892 current_vector = sibling;
895 public override UsageVector CurrentUsageVector {
896 get { return current_vector; }
899 public override bool CheckRethrow (Location loc)
901 if (!Parent.CheckRethrow (loc))
903 if (finally_vector == null)
905 Report.Error (724, loc, "A throw statement with no arguments is not allowed inside of a finally clause nested inside of the innermost catch clause");
909 public override bool AddResumePoint (ResumableStatement stmt, Location loc, out int pc)
911 int errors = Report.Errors;
912 Parent.AddResumePoint (this.stmt, loc, out pc);
913 if (errors == Report.Errors) {
914 if (finally_vector == null)
915 this.stmt.AddResumePoint (stmt, pc);
917 Report.Error (1625, loc, "Cannot yield in the body of a finally clause");
922 public override bool AddBreakOrigin (UsageVector vector, Location loc)
924 if (finally_vector != null) {
925 int errors = Report.Errors;
926 Parent.AddBreakOrigin (vector, loc);
927 if (errors == Report.Errors)
928 Report.Error (157, loc, "Control cannot leave the body of a finally clause");
930 saved_origins = new BreakOrigin (saved_origins, vector, loc);
933 // either the loop test or a back jump will follow code
934 stmt.SomeCodeFollows ();
938 public override bool AddContinueOrigin (UsageVector vector, Location loc)
940 if (finally_vector != null) {
941 int errors = Report.Errors;
942 Parent.AddContinueOrigin (vector, loc);
943 if (errors == Report.Errors)
944 Report.Error (157, loc, "Control cannot leave the body of a finally clause");
946 saved_origins = new ContinueOrigin (saved_origins, vector, loc);
949 // either the loop test or a back jump will follow code
950 stmt.SomeCodeFollows ();
954 public override bool AddReturnOrigin (UsageVector vector, ExitStatement exit_stmt)
956 if (finally_vector != null) {
957 int errors = Report.Errors;
958 Parent.AddReturnOrigin (vector, exit_stmt);
959 if (errors == Report.Errors)
960 exit_stmt.Error_FinallyClause (Report);
962 saved_origins = new ReturnOrigin (saved_origins, vector, exit_stmt);
965 // sets ec.NeedReturnLabel()
966 stmt.SomeCodeFollows ();
970 public override bool AddGotoOrigin (UsageVector vector, Goto goto_stmt)
972 LabeledStatement s = current_vector.Block == null ? null : current_vector.Block.LookupLabel (goto_stmt.Target);
974 throw new InternalErrorException ("Shouldn't
get here
");
976 if (finally_vector != null) {
977 int errors = Report.Errors;
978 Parent.AddGotoOrigin (vector, goto_stmt);
979 if (errors == Report.Errors)
980 Report.Error (157, goto_stmt.loc, "Control cannot leave the body of a
finally clause
");
982 saved_origins = new GotoOrigin (saved_origins, vector, goto_stmt);
987 protected override UsageVector Merge ()
989 UsageVector vector = try_vector.Clone ();
991 if (finally_vector != null)
992 vector.MergeChild (finally_vector, false);
994 for (SavedOrigin origin = saved_origins; origin != null; origin = origin.Next)
995 origin.PropagateFinally (finally_vector, Parent);
1002 // This is used by the flow analysis code to keep track of the type of local variables
1005 // The flow code uses a BitVector to keep track of whether a variable has been assigned
1006 // or not. This is easy for fundamental types (int, char etc.) or reference types since
1007 // you can only assign the whole variable as such.
1009 // For structs, we also need to keep track of all its fields. To do this, we allocate one
1010 // bit for the struct itself (it's used if you assign/access the whole struct) followed by
1011 // one bit for each of its fields.
1013 // This class computes this `layout' for each type.
1015 public class TypeInfo
1017 public readonly Type Type;
1020 // Total number of bits a variable of this type consumes in the flow vector.
1022 public readonly int TotalLength;
1025 // Number of bits the simple fields of a variable of this type consume
1026 // in the flow vector.
1028 public readonly int Length;
1031 // This is only used by sub-structs.
1033 public readonly int Offset;
1036 // If this is a struct.
1038 public readonly bool IsStruct;
1041 // If this is a struct, all fields which are structs theirselves.
1043 public TypeInfo[] SubStructInfo;
1045 readonly StructInfo struct_info;
1046 private static Dictionary<Type, TypeInfo> type_hash;
1053 public static void Reset ()
1055 type_hash = new Dictionary<Type, TypeInfo> ();
1056 StructInfo.field_type_hash = new Dictionary<Type, StructInfo> ();
1059 public static TypeInfo GetTypeInfo (Type type)
1062 if (type_hash.TryGetValue (type, out info))
1065 info = new TypeInfo (type);
1066 type_hash.Add (type, info);
1070 public static TypeInfo GetTypeInfo (TypeContainer tc)
1073 if (type_hash.TryGetValue (tc.TypeBuilder, out info))
1076 info = new TypeInfo (tc);
1077 type_hash.Add (tc.TypeBuilder, info);
1081 private TypeInfo (Type type)
1085 struct_info = StructInfo.GetStructInfo (type);
1086 if (struct_info != null) {
1087 Length = struct_info.Length;
1088 TotalLength = struct_info.TotalLength;
1089 SubStructInfo = struct_info.StructFields;
1098 private TypeInfo (TypeContainer tc)
1100 this.Type = tc.TypeBuilder;
1102 struct_info = StructInfo.GetStructInfo (tc);
1103 if (struct_info != null) {
1104 Length = struct_info.Length;
1105 TotalLength = struct_info.TotalLength;
1106 SubStructInfo = struct_info.StructFields;
1115 TypeInfo (StructInfo struct_info, int offset)
1117 this.struct_info = struct_info;
1118 this.Offset = offset;
1119 this.Length = struct_info.Length;
1120 this.TotalLength = struct_info.TotalLength;
1121 this.SubStructInfo = struct_info.StructFields;
1122 this.Type = struct_info.Type;
1123 this.IsStruct = true;
1126 public int GetFieldIndex (string name)
1128 if (struct_info == null)
1131 return struct_info [name];
1134 public TypeInfo GetSubStruct (string name)
1136 if (struct_info == null)
1139 return struct_info.GetStructField (name);
1143 // A struct's constructor must always assign all fields.
1144 // This method checks whether it actually does so.
1146 public bool IsFullyInitialized (BlockContext ec, VariableInfo vi, Location loc)
1148 if (struct_info == null)
1152 FlowBranching branching = ec.CurrentBranching;
1153 for (int i = 0; i < struct_info.Count; i++) {
1154 var field = struct_info.Fields [i];
1156 if (!branching.IsFieldAssigned (vi, field.Name)) {
1157 FieldBase fb = TypeManager.GetField (field.MetaInfo);
1158 if (fb is Property.BackingField) {
1159 ec.Report.Error (843, loc,
1160 "An automatically implemented property `{0}
' must be fully assigned before control leaves the constructor. Consider calling default contructor",
1161 fb.GetSignatureForError ());
1163 ec.Report.Error (171, loc,
1164 "Field `{0}' must be fully assigned before control leaves the constructor
",
1165 TypeManager.GetFullNameSignature (field.MetaInfo));
1174 public override string ToString ()
1176 return String.Format ("TypeInfo ({0}
:{1}
:{2}
:{3}
)",
1177 Type, Offset, Length, TotalLength);
1181 public readonly Type Type;
1182 public readonly FieldSpec[] Fields;
1183 public readonly TypeInfo[] StructFields;
1184 public readonly int Count;
1185 public readonly int CountPublic;
1186 public readonly int CountNonPublic;
1187 public readonly int Length;
1188 public readonly int TotalLength;
1189 public readonly bool HasStructFields;
1191 public static Dictionary<Type, StructInfo> field_type_hash;
1192 private Dictionary<string, TypeInfo> struct_field_hash;
1193 private Dictionary<string, int> field_hash;
1195 protected bool InTransit = false;
1197 // Private constructor. To save memory usage, we only need to create one instance
1198 // of this class per struct type.
1199 private StructInfo (Type type)
1203 field_type_hash.Add (type, this);
1205 if (TypeManager.IsBeingCompiled (type)) {
1206 TypeContainer tc = TypeManager.LookupTypeContainer (TypeManager.DropGenericTypeArguments (type));
1208 var public_fields = new List<FieldSpec> ();
1209 var non_public_fields = new List<FieldSpec> ();
1212 // TODO: tc != null is needed because FixedBuffers are not cached
1215 var fields = tc.Fields;
1217 if (fields != null) {
1218 foreach (FieldBase field in fields) {
1219 if ((field.ModFlags & Modifiers.STATIC) != 0)
1221 if ((field.ModFlags & Modifiers.PUBLIC) != 0)
1222 public_fields.Add (field.Spec);
1224 non_public_fields.Add (field.Spec);
1229 CountPublic = public_fields.Count;
1230 CountNonPublic = non_public_fields.Count;
1231 Count = CountPublic + CountNonPublic;
1233 Fields = new FieldSpec [Count];
1234 public_fields.CopyTo (Fields, 0);
1235 non_public_fields.CopyTo (Fields, CountPublic);
1236 } else if (type is GenericTypeParameterBuilder) {
1237 CountPublic = CountNonPublic = Count = 0;
1239 Fields = new FieldSpec [0];
1241 FieldInfo[] public_fields = type.GetFields (
1242 BindingFlags.Instance|BindingFlags.Public);
1243 FieldInfo[] non_public_fields = type.GetFields (
1244 BindingFlags.Instance|BindingFlags.NonPublic);
1246 CountPublic = public_fields.Length;
1247 CountNonPublic = non_public_fields.Length;
1248 Count = CountPublic + CountNonPublic;
1250 Fields = new FieldSpec [Count];
1251 for (int i = 0; i < CountPublic; ++i)
1252 Fields [i] = Import.CreateField (public_fields[i]);
1254 for (int i = 0; i < CountNonPublic; ++i)
1255 Fields [i + CountPublic] = Import.CreateField (non_public_fields[i]);
1258 struct_field_hash = new Dictionary<string, TypeInfo> ();
1259 field_hash = new Dictionary<string, int> ();
1262 StructFields = new TypeInfo [Count];
1263 StructInfo[] sinfo = new StructInfo [Count];
1267 for (int i = 0; i < Count; i++) {
1268 var field = Fields [i];
1270 sinfo [i] = GetStructInfo (field.FieldType);
1271 if (sinfo [i] == null)
1272 field_hash.Add (field.Name, ++Length);
1273 else if (sinfo [i].InTransit) {
1274 RootContext.ToplevelTypes.Compiler.Report.Error (523, String.Format (
1275 "Struct member `{0}
.{1}
' of type `{2}' causes
" +
1276 "a cycle
in the structure layout
",
1277 type, field.Name, sinfo [i].Type));
1285 TotalLength = Length + 1;
1286 for (int i = 0; i < Count; i++) {
1287 var field = Fields [i];
1289 if (sinfo [i] == null)
1292 field_hash.Add (field.Name, TotalLength);
1294 HasStructFields = true;
1295 StructFields [i] = new TypeInfo (sinfo [i], TotalLength);
1296 struct_field_hash.Add (field.Name, StructFields [i]);
1297 TotalLength += sinfo [i].TotalLength;
1301 public int this [string name] {
1304 if (!field_hash.TryGetValue (name, out val))
1311 public TypeInfo GetStructField (string name)
1314 if (struct_field_hash.TryGetValue (name, out ti))
1320 public static StructInfo GetStructInfo (Type type)
1322 if (!TypeManager.IsValueType (type) || TypeManager.IsEnumType (type) ||
1323 TypeManager.IsBuiltinType (type))
1326 if (TypeManager.IsGenericParameter (type))
1330 if (field_type_hash.TryGetValue (type, out info))
1333 return new StructInfo (type);
1336 public static StructInfo GetStructInfo (TypeContainer tc)
1339 if (field_type_hash.TryGetValue (tc.TypeBuilder, out info))
1342 return new StructInfo (tc.TypeBuilder);
1348 // This is used by the flow analysis code to store information about a single local variable
1349 // or parameter. Depending on the variable's type, we need to allocate one or more elements
1350 // in the BitVector - if it's a fundamental or reference type, we just need to know whether
1351 // it has been assigned or not, but for structs, we need this information for each of its fields.
1353 public class VariableInfo {
1354 public readonly string Name;
1355 public readonly TypeInfo TypeInfo;
1358 // The bit offset of this variable in the flow vector.
1360 public readonly int Offset;
1363 // The number of bits this variable needs in the flow vector.
1364 // The first bit always specifies whether the variable as such has been assigned while
1365 // the remaining bits contain this information for each of a struct's fields.
1367 public readonly int Length;
1370 // If this is a parameter of local variable.
1372 public readonly bool IsParameter;
1374 public readonly LocalInfo LocalInfo;
1376 readonly VariableInfo Parent;
1377 VariableInfo[] sub_info;
1379 bool is_ever_assigned;
1380 public bool IsEverAssigned {
1381 get { return is_ever_assigned; }
1384 protected VariableInfo (string name, Type type, int offset)
1387 this.Offset = offset;
1388 this.TypeInfo = TypeInfo.GetTypeInfo (type);
1390 Length = TypeInfo.TotalLength;
1395 protected VariableInfo (VariableInfo parent, TypeInfo type)
1397 this.Name = parent.Name;
1398 this.TypeInfo = type;
1399 this.Offset = parent.Offset + type.Offset;
1400 this.Parent = parent;
1401 this.Length = type.TotalLength;
1403 this.IsParameter = parent.IsParameter;
1404 this.LocalInfo = parent.LocalInfo;
1409 protected void Initialize ()
1411 TypeInfo[] sub_fields = TypeInfo.SubStructInfo;
1412 if (sub_fields != null) {
1413 sub_info = new VariableInfo [sub_fields.Length];
1414 for (int i = 0; i < sub_fields.Length; i++) {
1415 if (sub_fields [i] != null)
1416 sub_info [i] = new VariableInfo (this, sub_fields [i]);
1419 sub_info = new VariableInfo [0];
1422 public VariableInfo (LocalInfo local_info, int offset)
1423 : this (local_info.Name, local_info.VariableType, offset)
1425 this.LocalInfo = local_info;
1426 this.IsParameter = false;
1429 public VariableInfo (ParametersCompiled ip, int i, int offset)
1430 : this (ip.FixedParameters [i].Name, ip.Types [i], offset)
1432 this.IsParameter = true;
1435 public bool IsAssigned (ResolveContext ec)
1437 return !ec.DoFlowAnalysis ||
1438 ec.OmitStructFlowAnalysis && TypeInfo.IsStruct ||
1439 ec.CurrentBranching.IsAssigned (this);
1442 public bool IsAssigned (ResolveContext ec, Location loc)
1444 if (IsAssigned (ec))
1447 ec.Report.Error (165, loc,
1448 "Use of unassigned local variable `
" + Name + "'");
1449 ec.CurrentBranching.SetAssigned (this);
1453 public bool IsAssigned (MyBitVector vector)
1458 if (vector [Offset])
1461 // FIXME: Fix SetFieldAssigned to set the whole range like SetAssigned below. Then, get rid of this stanza
1462 for (VariableInfo parent = Parent; parent != null; parent = parent.Parent) {
1463 if (vector [parent.Offset]) {
1464 // 'parent
' is assigned, but someone forgot to note that all its components are assigned too
1465 parent.SetAssigned (vector);
1470 // Return unless this is a struct.
1471 if (!TypeInfo.IsStruct)
1474 // Ok, so each field must be assigned.
1475 for (int i = 0; i < TypeInfo.Length; i++) {
1476 if (!vector [Offset + i + 1])
1480 // Ok, now check all fields which are structs.
1481 for (int i = 0; i < sub_info.Length; i++) {
1482 VariableInfo sinfo = sub_info [i];
1486 if (!sinfo.IsAssigned (vector))
1490 vector [Offset] = true;
1491 is_ever_assigned = true;
1495 public void SetAssigned (ResolveContext ec)
1497 if (ec.DoFlowAnalysis)
1498 ec.CurrentBranching.SetAssigned (this);
1501 public void SetAssigned (MyBitVector vector)
1504 vector [Offset] = true;
1506 vector.SetRange (Offset, Length);
1507 is_ever_assigned = true;
1510 public bool IsFieldAssigned (ResolveContext ec, string name, Location loc)
1512 if (!ec.DoFlowAnalysis ||
1513 ec.OmitStructFlowAnalysis && TypeInfo.IsStruct ||
1514 ec.CurrentBranching.IsFieldAssigned (this, name))
1517 ec.Report.Error (170, loc,
1518 "Use of possibly unassigned field `" + name + "'");
1519 ec.CurrentBranching.SetFieldAssigned (this, name);
1523 public bool IsFieldAssigned (MyBitVector vector, string field_name)
1525 int field_idx = TypeInfo.GetFieldIndex (field_name);
1530 return vector [Offset + field_idx];
1533 public void SetFieldAssigned (ResolveContext ec, string name)
1535 if (ec.DoFlowAnalysis)
1536 ec.CurrentBranching.SetFieldAssigned (this, name);
1539 public void SetFieldAssigned (MyBitVector vector, string field_name)
1541 int field_idx = TypeInfo.GetFieldIndex (field_name);
1546 vector [Offset + field_idx] = true;
1547 is_ever_assigned = true;
1550 public VariableInfo GetSubStruct (string name)
1552 TypeInfo type = TypeInfo.GetSubStruct (name);
1557 return new VariableInfo (this, type);
1560 public override string ToString ()
1562 return String.Format ("VariableInfo ({0}
:{1}
:{2}
:{3}
:{4}
)",
1563 Name, TypeInfo, Offset, Length, IsParameter);
1568 // This is a special bit vector which can inherit from another bit vector doing a
1569 // copy-on-write strategy. The inherited vector may have a smaller size than the
1572 public class MyBitVector {
1573 public readonly int Count;
1574 public static readonly MyBitVector Empty = new MyBitVector ();
1576 // Invariant: vector != null => vector.Count == Count
1577 // Invariant: vector == null || shared == null
1578 // i.e., at most one of 'vector' and 'shared' can be non-null. They can both be null -- that means all-ones
1579 // The object in 'shared' cannot be modified, while 'vector' can be freely modified
1580 System.Collections.BitArray vector, shared;
1584 shared = new System.Collections.BitArray (0, false);
1587 public MyBitVector (MyBitVector InheritsFrom, int Count)
1589 if (InheritsFrom != null)
1590 shared = InheritsFrom.MakeShared (Count);
1595 System.Collections.BitArray MakeShared (int new_count)
1597 // Post-condition: vector == null
1599 // ensure we don't leak out dirty bits from the BitVector we inherited from
1600 if (new_count > Count &&
1601 ((shared != null && shared.Count > Count) ||
1602 (shared == null && vector == null)))
1603 initialize_vector ();
1605 if (vector != null) {
1614 // Get/set bit `index' in the bit vector.
1616 public bool this [int index] {
1619 // FIXME: Disabled due to missing anonymous method flow analysis
1620 // throw new ArgumentOutOfRangeException ();
1624 return vector [index];
1627 if (index < shared.Count)
1628 return shared [index];
1633 // Only copy the vector if we're actually modifying it.
1634 if (this [index] != value) {
1636 initialize_vector ();
1637 vector [index] = value;
1643 // Performs an `or' operation on the bit vector. The `new_vector' may have a
1644 // different size than the current one.
1646 private MyBitVector Or (MyBitVector new_vector)
1648 if (Count == 0 || new_vector.Count == 0)
1651 var o = new_vector.vector != null ? new_vector.vector : new_vector.shared;
1654 int n = new_vector.Count;
1656 for (int i = 0; i < n; ++i)
1664 if (Count == o.Count) {
1665 if (vector == null) {
1668 initialize_vector ();
1678 for (int i = 0; i < min; i++) {
1687 // Performs an `and' operation on the bit vector. The `new_vector' may have
1688 // a different size than the current one.
1690 private MyBitVector And (MyBitVector new_vector)
1695 var o = new_vector.vector != null ? new_vector.vector : new_vector.shared;
1698 for (int i = new_vector.Count; i < Count; ++i)
1708 if (Count == o.Count) {
1709 if (vector == null) {
1710 if (shared == null) {
1711 shared = new_vector.MakeShared (Count);
1714 initialize_vector ();
1724 for (int i = 0; i < min; i++) {
1729 for (int i = min; i < Count; i++)
1735 public static MyBitVector operator & (MyBitVector a, MyBitVector b)
1743 if (a.Count > b.Count)
1744 return a.Clone ().And (b);
1746 return b.Clone ().And (a);
1749 public static MyBitVector operator | (MyBitVector a, MyBitVector b)
1754 return new MyBitVector (null, b.Count);
1756 return new MyBitVector (null, a.Count);
1757 if (a.Count > b.Count)
1758 return a.Clone ().Or (b);
1760 return b.Clone ().Or (a);
1763 public MyBitVector Clone ()
1765 return Count == 0 ? Empty : new MyBitVector (this, Count);
1768 public void SetRange (int offset, int length)
1770 if (offset > Count || offset + length > Count)
1771 throw new ArgumentOutOfRangeException ();
1773 if (shared == null && vector == null)
1777 if (shared != null) {
1778 if (offset + length <= shared.Count) {
1779 for (; i < length; ++i)
1780 if (!shared [i+offset])
1785 initialize_vector ();
1787 for (; i < length; ++i)
1788 vector [i+offset] = true;
1792 public void SetAll (bool value)
1794 // Don't clobber Empty
1797 shared = value ? null : Empty.MakeShared (Count);
1801 void initialize_vector ()
1803 // Post-condition: vector != null
1804 if (shared == null) {
1805 vector = new System.Collections.BitArray (Count, true);
1809 vector = new System.Collections.BitArray (shared);
1810 if (Count != vector.Count)
1811 vector.Length = Count;
1815 StringBuilder Dump (StringBuilder sb)
1817 var dump = vector == null ? shared : vector;
1819 return sb.Append ("/");
1822 for (int i = 0; i < dump.Count; i++)
1823 sb.Append (dump [i] ? "1" : "0");
1827 public override string ToString ()
1829 return Dump (new StringBuilder ("{")).Append ("}
").ToString ();