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;
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;
318 is_unreachable = new_isunr;
320 is_unreachable |= new_isunr;
325 public void MergeOrigins (UsageVector o_vectors)
327 Report.Debug (1, " MERGING BREAK ORIGINS", this);
329 if (o_vectors == null)
332 if (IsUnreachable && locals != null)
333 locals.SetAll (true);
335 for (UsageVector vector = o_vectors; vector != null; vector = vector.Next) {
336 Report.Debug (1, " MERGING BREAK ORIGIN", vector);
337 if (vector.IsUnreachable)
339 locals &= vector.locals;
340 is_unreachable &= vector.is_unreachable;
343 Report.Debug (1, " MERGING BREAK ORIGINS DONE", this);
350 public override string ToString ()
352 return String.Format ("Vector ({0},{1},{2}-{3})", Type, id, is_unreachable, locals);
357 // Creates a new flow branching which is contained in `parent'.
358 // You should only pass non-null for the `block' argument if this block
359 // introduces any new variables - in this case, we need to create a new
360 // usage vector with a different size than our parent's one.
362 protected FlowBranching (FlowBranching parent, BranchingType type, SiblingType stype,
363 Block block, Location loc)
373 UsageVector parent_vector = parent != null ? parent.CurrentUsageVector : null;
374 vector = new UsageVector (stype, parent_vector, Block, loc, Block.AssignableSlots);
376 vector = new UsageVector (stype, Parent.CurrentUsageVector, null, loc);
382 public abstract UsageVector CurrentUsageVector {
387 // Creates a sibling of the current usage vector.
389 public virtual void CreateSibling (Block block, SiblingType type)
391 UsageVector vector = new UsageVector (
392 type, Parent.CurrentUsageVector, block, Location);
395 Report.Debug (1, " CREATED SIBLING", CurrentUsageVector);
398 public void CreateSibling ()
400 CreateSibling (null, SiblingType.Conditional);
403 protected abstract void AddSibling (UsageVector uv);
405 protected abstract UsageVector Merge ();
407 public UsageVector MergeChild (FlowBranching child)
409 return CurrentUsageVector.MergeChild (child.Merge (), true);
412 public virtual bool CheckRethrow (Location loc)
414 return Parent.CheckRethrow (loc);
417 public virtual bool AddResumePoint (ResumableStatement stmt, Location loc, out int pc)
419 return Parent.AddResumePoint (stmt, loc, out pc);
422 // returns true if we crossed an unwind-protected region (try/catch/finally, lock, using, ...)
423 public virtual bool AddBreakOrigin (UsageVector vector, Location loc)
425 return Parent.AddBreakOrigin (vector, loc);
428 // returns true if we crossed an unwind-protected region (try/catch/finally, lock, using, ...)
429 public virtual bool AddContinueOrigin (UsageVector vector, Location loc)
431 return Parent.AddContinueOrigin (vector, loc);
434 // returns true if we crossed an unwind-protected region (try/catch/finally, lock, using, ...)
435 public virtual bool AddReturnOrigin (UsageVector vector, ExitStatement stmt)
437 return Parent.AddReturnOrigin (vector, stmt);
440 // returns true if we crossed an unwind-protected region (try/catch/finally, lock, using, ...)
441 public virtual bool AddGotoOrigin (UsageVector vector, Goto goto_stmt)
443 return Parent.AddGotoOrigin (vector, goto_stmt);
446 public bool IsAssigned (VariableInfo vi)
448 return CurrentUsageVector.IsAssigned (vi, false);
451 public bool IsFieldAssigned (VariableInfo vi, string field_name)
453 return CurrentUsageVector.IsAssigned (vi, false) || CurrentUsageVector.IsFieldAssigned (vi, field_name);
456 public void SetAssigned (VariableInfo vi)
458 CurrentUsageVector.SetAssigned (vi);
461 public void SetFieldAssigned (VariableInfo vi, string name)
463 CurrentUsageVector.SetFieldAssigned (vi, name);
466 public override string ToString ()
468 StringBuilder sb = new StringBuilder ();
469 sb.Append (GetType ());
477 sb.Append (Block.ID);
479 sb.Append (Block.StartLocation);
482 // sb.Append (Siblings.Length);
483 // sb.Append (" - ");
484 sb.Append (CurrentUsageVector);
486 return sb.ToString ();
490 get { return String.Format ("{0} ({1}:{2}:{3})", GetType (), id, Type, Location); }
494 public class FlowBranchingBlock : FlowBranching
496 UsageVector sibling_list = null;
498 public FlowBranchingBlock (FlowBranching parent, BranchingType type,
499 SiblingType stype, Block block, Location loc)
500 : base (parent, type, stype, block, loc)
503 public override UsageVector CurrentUsageVector {
504 get { return sibling_list; }
507 protected override void AddSibling (UsageVector sibling)
509 if (sibling_list != null && sibling_list.Type == SiblingType.Block)
510 throw new InternalErrorException ("Blocks don't have sibling flow paths");
511 sibling.Next = sibling_list;
512 sibling_list = sibling;
515 public override bool AddGotoOrigin (UsageVector vector, Goto goto_stmt)
517 LabeledStatement stmt = Block == null ? null : Block.LookupLabel (goto_stmt.Target);
519 return Parent.AddGotoOrigin (vector, goto_stmt);
522 goto_stmt.SetResolvedTarget (stmt);
523 stmt.AddUsageVector (vector);
527 public static void Error_UnknownLabel (Location loc, string label)
529 Report.Error(159, loc, "The label `{0}:' could not be found within the scope of the goto statement",
533 protected override UsageVector Merge ()
535 Report.Debug (2, " MERGING SIBLINGS", Name);
536 UsageVector vector = UsageVector.MergeSiblings (sibling_list, Location);
537 Report.Debug (2, " MERGING SIBLINGS DONE", Name, vector);
542 public class FlowBranchingBreakable : FlowBranchingBlock
544 UsageVector break_origins;
546 public FlowBranchingBreakable (FlowBranching parent, BranchingType type, SiblingType stype, Block block, Location loc)
547 : base (parent, type, stype, block, loc)
550 public override bool AddBreakOrigin (UsageVector vector, Location loc)
552 vector = vector.Clone ();
553 vector.Next = break_origins;
554 break_origins = vector;
558 protected override UsageVector Merge ()
560 UsageVector vector = base.Merge ();
561 vector.MergeOrigins (break_origins);
566 public class FlowBranchingContinuable : FlowBranchingBlock
568 UsageVector continue_origins;
570 public FlowBranchingContinuable (FlowBranching parent, BranchingType type, SiblingType stype, Block block, Location loc)
571 : base (parent, type, stype, block, loc)
574 public override bool AddContinueOrigin (UsageVector vector, Location loc)
576 vector = vector.Clone ();
577 vector.Next = continue_origins;
578 continue_origins = vector;
582 protected override UsageVector Merge ()
584 UsageVector vector = base.Merge ();
585 vector.MergeOrigins (continue_origins);
590 public class FlowBranchingLabeled : FlowBranchingBlock
592 LabeledStatement stmt;
595 public FlowBranchingLabeled (FlowBranching parent, LabeledStatement stmt)
596 : base (parent, BranchingType.Labeled, SiblingType.Conditional, null, stmt.loc)
599 CurrentUsageVector.MergeOrigins (stmt.JumpOrigins);
600 actual = CurrentUsageVector.Clone ();
602 // stand-in for backward jumps
603 CurrentUsageVector.ResetBarrier ();
606 public override bool AddGotoOrigin (UsageVector vector, Goto goto_stmt)
608 if (goto_stmt.Target != stmt.Name)
609 return Parent.AddGotoOrigin (vector, goto_stmt);
612 goto_stmt.SetResolvedTarget (stmt);
613 actual.MergeOrigins (vector.Clone ());
618 protected override UsageVector Merge ()
620 UsageVector vector = base.Merge ();
622 if (actual.IsUnreachable)
623 Report.Warning (162, 2, stmt.loc, "Unreachable code detected");
625 actual.MergeChild (vector, false);
630 public class FlowBranchingIterator : FlowBranchingBlock
633 public FlowBranchingIterator (FlowBranching parent, Iterator iterator)
634 : base (parent, BranchingType.Iterator, SiblingType.Block, null, iterator.Location)
636 this.iterator = iterator;
639 public override bool AddResumePoint (ResumableStatement stmt, Location loc, out int pc)
641 pc = iterator.AddResumePoint (stmt);
646 public class FlowBranchingToplevel : FlowBranchingBlock
648 UsageVector return_origins;
650 public FlowBranchingToplevel (FlowBranching parent, ToplevelBlock stmt)
651 : base (parent, BranchingType.Toplevel, SiblingType.Conditional, stmt, stmt.loc)
655 public override bool CheckRethrow (Location loc)
657 Report.Error (156, loc, "A throw statement with no arguments is not allowed outside of a catch clause");
661 public override bool AddResumePoint (ResumableStatement stmt, Location loc, out int pc)
664 Report.Error (-6, loc, "Internal Error: A yield in a non-iterator");
668 public override bool AddBreakOrigin (UsageVector vector, Location loc)
670 Report.Error (139, loc, "No enclosing loop out of which to break or continue");
674 public override bool AddContinueOrigin (UsageVector vector, Location loc)
676 Report.Error (139, loc, "No enclosing loop out of which to break or continue");
680 public override bool AddReturnOrigin (UsageVector vector, ExitStatement stmt)
682 vector = vector.Clone ();
683 vector.Location = stmt.loc;
684 vector.Next = return_origins;
685 return_origins = vector;
689 public override bool AddGotoOrigin (UsageVector vector, Goto goto_stmt)
691 string name = goto_stmt.Target;
692 LabeledStatement s = Block.LookupLabel (name);
694 throw new InternalErrorException ("Shouldn't get here");
696 if (Parent == null) {
697 Error_UnknownLabel (goto_stmt.loc, name);
701 int errors = Report.Errors;
702 Parent.AddGotoOrigin (vector, goto_stmt);
703 if (errors == Report.Errors)
704 Report.Error (1632, goto_stmt.loc, "Control cannot leave the body of an anonymous method");
708 protected override UsageVector Merge ()
710 for (UsageVector origin = return_origins; origin != null; origin = origin.Next)
711 Block.Toplevel.CheckOutParameters (origin, origin.Location);
713 UsageVector vector = base.Merge ();
714 Block.Toplevel.CheckOutParameters (vector, Block.loc);
715 // Note: we _do_not_ merge in the return origins
721 return Merge ().IsUnreachable;
725 public class FlowBranchingTryCatch : FlowBranchingBlock
728 public FlowBranchingTryCatch (FlowBranching parent, TryCatch stmt)
729 : base (parent, BranchingType.Block, SiblingType.Try, null, stmt.loc)
734 public override bool CheckRethrow (Location loc)
736 return CurrentUsageVector.Next != null || Parent.CheckRethrow (loc);
739 public override bool AddResumePoint (ResumableStatement stmt, Location loc, out int pc)
741 int errors = Report.Errors;
742 Parent.AddResumePoint (stmt, loc, out pc);
743 if (errors == Report.Errors) {
744 if (CurrentUsageVector.Next == null)
745 Report.Error (1626, loc, "Cannot yield a value in the body of a try block with a catch clause");
747 Report.Error (1631, loc, "Cannot yield a value in the body of a catch clause");
752 public override bool AddBreakOrigin (UsageVector vector, Location loc)
754 Parent.AddBreakOrigin (vector, loc);
755 stmt.SomeCodeFollows ();
759 public override bool AddContinueOrigin (UsageVector vector, Location loc)
761 Parent.AddContinueOrigin (vector, loc);
762 stmt.SomeCodeFollows ();
766 public override bool AddReturnOrigin (UsageVector vector, ExitStatement exit_stmt)
768 Parent.AddReturnOrigin (vector, exit_stmt);
769 stmt.SomeCodeFollows ();
773 public override bool AddGotoOrigin (UsageVector vector, Goto goto_stmt)
775 Parent.AddGotoOrigin (vector, goto_stmt);
780 public class FlowBranchingException : FlowBranching
782 ExceptionStatement stmt;
783 UsageVector current_vector;
784 UsageVector try_vector;
785 UsageVector finally_vector;
787 abstract class SavedOrigin {
788 public readonly SavedOrigin Next;
789 public readonly UsageVector Vector;
791 protected SavedOrigin (SavedOrigin next, UsageVector vector)
794 Vector = vector.Clone ();
797 protected abstract void DoPropagateFinally (FlowBranching parent);
798 public void PropagateFinally (UsageVector finally_vector, FlowBranching parent)
800 if (finally_vector != null)
801 Vector.MergeChild (finally_vector, false);
802 DoPropagateFinally (parent);
806 class BreakOrigin : SavedOrigin {
808 public BreakOrigin (SavedOrigin next, UsageVector vector, Location loc)
809 : base (next, vector)
814 protected override void DoPropagateFinally (FlowBranching parent)
816 parent.AddBreakOrigin (Vector, Loc);
820 class ContinueOrigin : SavedOrigin {
822 public ContinueOrigin (SavedOrigin next, UsageVector vector, Location loc)
823 : base (next, vector)
828 protected override void DoPropagateFinally (FlowBranching parent)
830 parent.AddContinueOrigin (Vector, Loc);
834 class ReturnOrigin : SavedOrigin {
835 public ExitStatement Stmt;
837 public ReturnOrigin (SavedOrigin next, UsageVector vector, ExitStatement stmt)
838 : base (next, vector)
843 protected override void DoPropagateFinally (FlowBranching parent)
845 parent.AddReturnOrigin (Vector, Stmt);
849 class GotoOrigin : SavedOrigin {
852 public GotoOrigin (SavedOrigin next, UsageVector vector, Goto stmt)
853 : base (next, vector)
858 protected override void DoPropagateFinally (FlowBranching parent)
860 parent.AddGotoOrigin (Vector, Stmt);
864 SavedOrigin saved_origins;
866 public FlowBranchingException (FlowBranching parent,
867 ExceptionStatement stmt)
868 : base (parent, BranchingType.Exception, SiblingType.Try,
874 protected override void AddSibling (UsageVector sibling)
876 switch (sibling.Type) {
877 case SiblingType.Try:
878 try_vector = sibling;
880 case SiblingType.Finally:
881 finally_vector = sibling;
884 throw new InvalidOperationException ();
886 current_vector = sibling;
889 public override UsageVector CurrentUsageVector {
890 get { return current_vector; }
893 public override bool CheckRethrow (Location loc)
895 if (!Parent.CheckRethrow (loc))
897 if (finally_vector == null)
899 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");
903 public override bool AddResumePoint (ResumableStatement stmt, Location loc, out int pc)
905 int errors = Report.Errors;
906 Parent.AddResumePoint (this.stmt, loc, out pc);
907 if (errors == Report.Errors) {
908 if (finally_vector == null)
909 this.stmt.AddResumePoint (stmt, pc);
911 Report.Error (1625, loc, "Cannot yield in the body of a finally clause");
916 public override bool AddBreakOrigin (UsageVector vector, Location loc)
918 if (finally_vector != null) {
919 int errors = Report.Errors;
920 Parent.AddBreakOrigin (vector, loc);
921 if (errors == Report.Errors)
922 Report.Error (157, loc, "Control cannot leave the body of a finally clause");
924 saved_origins = new BreakOrigin (saved_origins, vector, loc);
927 // either the loop test or a back jump will follow code
928 stmt.SomeCodeFollows ();
932 public override bool AddContinueOrigin (UsageVector vector, Location loc)
934 if (finally_vector != null) {
935 int errors = Report.Errors;
936 Parent.AddContinueOrigin (vector, loc);
937 if (errors == Report.Errors)
938 Report.Error (157, loc, "Control cannot leave the body of a finally clause");
940 saved_origins = new ContinueOrigin (saved_origins, vector, loc);
943 // either the loop test or a back jump will follow code
944 stmt.SomeCodeFollows ();
948 public override bool AddReturnOrigin (UsageVector vector, ExitStatement exit_stmt)
950 if (finally_vector != null) {
951 int errors = Report.Errors;
952 Parent.AddReturnOrigin (vector, exit_stmt);
953 if (errors == Report.Errors)
954 exit_stmt.Error_FinallyClause ();
956 saved_origins = new ReturnOrigin (saved_origins, vector, exit_stmt);
959 // sets ec.NeedReturnLabel()
960 stmt.SomeCodeFollows ();
964 public override bool AddGotoOrigin (UsageVector vector, Goto goto_stmt)
966 LabeledStatement s = current_vector.Block == null ? null : current_vector.Block.LookupLabel (goto_stmt.Target);
968 throw new InternalErrorException ("Shouldn't get here");
970 if (finally_vector != null) {
971 int errors = Report.Errors;
972 Parent.AddGotoOrigin (vector, goto_stmt);
973 if (errors == Report.Errors)
974 Report.Error (157, goto_stmt.loc, "Control cannot leave the body of a finally clause");
976 saved_origins = new GotoOrigin (saved_origins, vector, goto_stmt);
981 protected override UsageVector Merge ()
983 UsageVector vector = try_vector.Clone ();
985 if (finally_vector != null)
986 vector.MergeChild (finally_vector, false);
988 for (SavedOrigin origin = saved_origins; origin != null; origin = origin.Next)
989 origin.PropagateFinally (finally_vector, Parent);
996 // This is used by the flow analysis code to keep track of the type of local variables
999 // The flow code uses a BitVector to keep track of whether a variable has been assigned
1000 // or not. This is easy for fundamental types (int, char etc.) or reference types since
1001 // you can only assign the whole variable as such.
1003 // For structs, we also need to keep track of all its fields. To do this, we allocate one
1004 // bit for the struct itself (it's used if you assign/access the whole struct) followed by
1005 // one bit for each of its fields.
1007 // This class computes this `layout' for each type.
1009 public class TypeInfo
1011 public readonly Type Type;
1014 // Total number of bits a variable of this type consumes in the flow vector.
1016 public readonly int TotalLength;
1019 // Number of bits the simple fields of a variable of this type consume
1020 // in the flow vector.
1022 public readonly int Length;
1025 // This is only used by sub-structs.
1027 public readonly int Offset;
1030 // If this is a struct.
1032 public readonly bool IsStruct;
1035 // If this is a struct, all fields which are structs theirselves.
1037 public TypeInfo[] SubStructInfo;
1039 protected readonly StructInfo struct_info;
1040 private static Hashtable type_hash = new Hashtable ();
1042 public static TypeInfo GetTypeInfo (Type type)
1044 TypeInfo info = (TypeInfo) type_hash [type];
1048 info = new TypeInfo (type);
1049 type_hash.Add (type, info);
1053 public static TypeInfo GetTypeInfo (TypeContainer tc)
1055 TypeInfo info = (TypeInfo) type_hash [tc.TypeBuilder];
1059 info = new TypeInfo (tc);
1060 type_hash.Add (tc.TypeBuilder, info);
1064 private TypeInfo (Type type)
1068 struct_info = StructInfo.GetStructInfo (type);
1069 if (struct_info != null) {
1070 Length = struct_info.Length;
1071 TotalLength = struct_info.TotalLength;
1072 SubStructInfo = struct_info.StructFields;
1081 private TypeInfo (TypeContainer tc)
1083 this.Type = tc.TypeBuilder;
1085 struct_info = StructInfo.GetStructInfo (tc);
1086 if (struct_info != null) {
1087 Length = struct_info.Length;
1088 TotalLength = struct_info.TotalLength;
1089 SubStructInfo = struct_info.StructFields;
1098 protected TypeInfo (StructInfo struct_info, int offset)
1100 this.struct_info = struct_info;
1101 this.Offset = offset;
1102 this.Length = struct_info.Length;
1103 this.TotalLength = struct_info.TotalLength;
1104 this.SubStructInfo = struct_info.StructFields;
1105 this.Type = struct_info.Type;
1106 this.IsStruct = true;
1109 public int GetFieldIndex (string name)
1111 if (struct_info == null)
1114 return struct_info [name];
1117 public TypeInfo GetSubStruct (string name)
1119 if (struct_info == null)
1122 return struct_info.GetStructField (name);
1126 // A struct's constructor must always assign all fields.
1127 // This method checks whether it actually does so.
1129 public bool IsFullyInitialized (FlowBranching branching, VariableInfo vi, Location loc)
1131 if (struct_info == null)
1135 for (int i = 0; i < struct_info.Count; i++) {
1136 FieldInfo field = struct_info.Fields [i];
1138 if (!branching.IsFieldAssigned (vi, field.Name)) {
1139 FieldBase fb = TypeManager.GetField (field);
1140 if (fb != null && (fb.ModFlags & Modifiers.BACKING_FIELD) != 0) {
1141 Report.Error (843, loc,
1142 "An automatically implemented property `{0}' must be fully assigned before control leaves the constructor. Consider calling default contructor",
1143 fb.GetSignatureForError ());
1145 Report.Error (171, loc,
1146 "Field `{0}' must be fully assigned before control leaves the constructor",
1147 TypeManager.GetFullNameSignature (field));
1156 public override string ToString ()
1158 return String.Format ("TypeInfo ({0}:{1}:{2}:{3})",
1159 Type, Offset, Length, TotalLength);
1162 protected class StructInfo {
1163 public readonly Type Type;
1164 public readonly FieldInfo[] Fields;
1165 public readonly TypeInfo[] StructFields;
1166 public readonly int Count;
1167 public readonly int CountPublic;
1168 public readonly int CountNonPublic;
1169 public readonly int Length;
1170 public readonly int TotalLength;
1171 public readonly bool HasStructFields;
1173 private static Hashtable field_type_hash = new Hashtable ();
1174 private Hashtable struct_field_hash;
1175 private Hashtable field_hash;
1177 protected bool InTransit = false;
1179 // Private constructor. To save memory usage, we only need to create one instance
1180 // of this class per struct type.
1181 private StructInfo (Type type)
1185 field_type_hash.Add (type, this);
1187 if (type is TypeBuilder) {
1188 TypeContainer tc = TypeManager.LookupTypeContainer (type);
1190 ArrayList fields = null;
1194 ArrayList public_fields = new ArrayList ();
1195 ArrayList non_public_fields = new ArrayList ();
1197 if (fields != null) {
1198 foreach (FieldBase field in fields) {
1199 if ((field.ModFlags & Modifiers.STATIC) != 0)
1201 if ((field.ModFlags & Modifiers.PUBLIC) != 0)
1202 public_fields.Add (field.FieldBuilder);
1204 non_public_fields.Add (field.FieldBuilder);
1208 CountPublic = public_fields.Count;
1209 CountNonPublic = non_public_fields.Count;
1210 Count = CountPublic + CountNonPublic;
1212 Fields = new FieldInfo [Count];
1213 public_fields.CopyTo (Fields, 0);
1214 non_public_fields.CopyTo (Fields, CountPublic);
1216 } else if (type is GenericTypeParameterBuilder) {
1217 CountPublic = CountNonPublic = Count = 0;
1219 Fields = new FieldInfo [0];
1222 FieldInfo[] public_fields = type.GetFields (
1223 BindingFlags.Instance|BindingFlags.Public);
1224 FieldInfo[] non_public_fields = type.GetFields (
1225 BindingFlags.Instance|BindingFlags.NonPublic);
1227 CountPublic = public_fields.Length;
1228 CountNonPublic = non_public_fields.Length;
1229 Count = CountPublic + CountNonPublic;
1231 Fields = new FieldInfo [Count];
1232 public_fields.CopyTo (Fields, 0);
1233 non_public_fields.CopyTo (Fields, CountPublic);
1236 struct_field_hash = new Hashtable ();
1237 field_hash = new Hashtable ();
1240 StructFields = new TypeInfo [Count];
1241 StructInfo[] sinfo = new StructInfo [Count];
1245 for (int i = 0; i < Count; i++) {
1246 FieldInfo field = (FieldInfo) Fields [i];
1248 sinfo [i] = GetStructInfo (field.FieldType);
1249 if (sinfo [i] == null)
1250 field_hash.Add (field.Name, ++Length);
1251 else if (sinfo [i].InTransit) {
1252 Report.Error (523, String.Format (
1253 "Struct member `{0}.{1}' of type `{2}' causes " +
1254 "a cycle in the structure layout",
1255 type, field.Name, sinfo [i].Type));
1263 TotalLength = Length + 1;
1264 for (int i = 0; i < Count; i++) {
1265 FieldInfo field = (FieldInfo) Fields [i];
1267 if (sinfo [i] == null)
1270 field_hash.Add (field.Name, TotalLength);
1272 HasStructFields = true;
1273 StructFields [i] = new TypeInfo (sinfo [i], TotalLength);
1274 struct_field_hash.Add (field.Name, StructFields [i]);
1275 TotalLength += sinfo [i].TotalLength;
1279 public int this [string name] {
1281 if (field_hash.Contains (name))
1282 return (int) field_hash [name];
1288 public TypeInfo GetStructField (string name)
1290 return (TypeInfo) struct_field_hash [name];
1293 public static StructInfo GetStructInfo (Type type)
1295 if (!TypeManager.IsValueType (type) || TypeManager.IsEnumType (type) ||
1296 TypeManager.IsBuiltinType (type))
1299 StructInfo info = (StructInfo) field_type_hash [type];
1303 return new StructInfo (type);
1306 public static StructInfo GetStructInfo (TypeContainer tc)
1308 StructInfo info = (StructInfo) field_type_hash [tc.TypeBuilder];
1312 return new StructInfo (tc.TypeBuilder);
1318 // This is used by the flow analysis code to store information about a single local variable
1319 // or parameter. Depending on the variable's type, we need to allocate one or more elements
1320 // in the BitVector - if it's a fundamental or reference type, we just need to know whether
1321 // it has been assigned or not, but for structs, we need this information for each of its fields.
1323 public class VariableInfo {
1324 public readonly string Name;
1325 public readonly TypeInfo TypeInfo;
1328 // The bit offset of this variable in the flow vector.
1330 public readonly int Offset;
1333 // The number of bits this variable needs in the flow vector.
1334 // The first bit always specifies whether the variable as such has been assigned while
1335 // the remaining bits contain this information for each of a struct's fields.
1337 public readonly int Length;
1340 // If this is a parameter of local variable.
1342 public readonly bool IsParameter;
1344 public readonly LocalInfo LocalInfo;
1346 readonly VariableInfo Parent;
1347 VariableInfo[] sub_info;
1349 bool is_ever_assigned;
1350 public bool IsEverAssigned {
1351 get { return is_ever_assigned; }
1354 protected VariableInfo (string name, Type type, int offset)
1357 this.Offset = offset;
1358 this.TypeInfo = TypeInfo.GetTypeInfo (type);
1360 Length = TypeInfo.TotalLength;
1365 protected VariableInfo (VariableInfo parent, TypeInfo type)
1367 this.Name = parent.Name;
1368 this.TypeInfo = type;
1369 this.Offset = parent.Offset + type.Offset;
1370 this.Parent = parent;
1371 this.Length = type.TotalLength;
1373 this.IsParameter = parent.IsParameter;
1374 this.LocalInfo = parent.LocalInfo;
1379 protected void Initialize ()
1381 TypeInfo[] sub_fields = TypeInfo.SubStructInfo;
1382 if (sub_fields != null) {
1383 sub_info = new VariableInfo [sub_fields.Length];
1384 for (int i = 0; i < sub_fields.Length; i++) {
1385 if (sub_fields [i] != null)
1386 sub_info [i] = new VariableInfo (this, sub_fields [i]);
1389 sub_info = new VariableInfo [0];
1392 public VariableInfo (LocalInfo local_info, int offset)
1393 : this (local_info.Name, local_info.VariableType, offset)
1395 this.LocalInfo = local_info;
1396 this.IsParameter = false;
1399 public VariableInfo (Parameters ip, int i, int offset)
1400 : this (ip.ParameterName (i), TypeManager.GetElementType (ip.ParameterType (i)), offset)
1402 this.IsParameter = true;
1405 public bool IsAssigned (EmitContext ec)
1407 return !ec.DoFlowAnalysis ||
1408 ec.OmitStructFlowAnalysis && TypeInfo.IsStruct ||
1409 ec.CurrentBranching.IsAssigned (this);
1412 public bool IsAssigned (EmitContext ec, Location loc)
1414 if (IsAssigned (ec))
1417 Report.Error (165, loc,
1418 "Use of unassigned local variable `" + Name + "'");
1419 ec.CurrentBranching.SetAssigned (this);
1423 public bool IsAssigned (MyBitVector vector)
1428 if (vector [Offset])
1431 // FIXME: Fix SetFieldAssigned to set the whole range like SetAssigned below. Then, get rid of this stanza
1432 for (VariableInfo parent = Parent; parent != null; parent = parent.Parent) {
1433 if (vector [parent.Offset]) {
1434 // 'parent' is assigned, but someone forgot to note that all its components are assigned too
1435 parent.SetAssigned (vector);
1440 // Return unless this is a struct.
1441 if (!TypeInfo.IsStruct)
1444 // Ok, so each field must be assigned.
1445 for (int i = 0; i < TypeInfo.Length; i++) {
1446 if (!vector [Offset + i + 1])
1450 // Ok, now check all fields which are structs.
1451 for (int i = 0; i < sub_info.Length; i++) {
1452 VariableInfo sinfo = sub_info [i];
1456 if (!sinfo.IsAssigned (vector))
1460 vector [Offset] = true;
1461 is_ever_assigned = true;
1465 public void SetAssigned (EmitContext ec)
1467 if (ec.DoFlowAnalysis)
1468 ec.CurrentBranching.SetAssigned (this);
1471 public void SetAssigned (MyBitVector vector)
1474 vector [Offset] = true;
1476 vector.SetRange (Offset, Length);
1477 is_ever_assigned = true;
1480 public bool IsFieldAssigned (EmitContext ec, string name, Location loc)
1482 if (!ec.DoFlowAnalysis ||
1483 ec.OmitStructFlowAnalysis && TypeInfo.IsStruct ||
1484 ec.CurrentBranching.IsFieldAssigned (this, name))
1487 Report.Error (170, loc,
1488 "Use of possibly unassigned field `" + name + "'");
1489 ec.CurrentBranching.SetFieldAssigned (this, name);
1493 public bool IsFieldAssigned (MyBitVector vector, string field_name)
1495 int field_idx = TypeInfo.GetFieldIndex (field_name);
1500 return vector [Offset + field_idx];
1503 public void SetFieldAssigned (EmitContext ec, string name)
1505 if (ec.DoFlowAnalysis)
1506 ec.CurrentBranching.SetFieldAssigned (this, name);
1509 public void SetFieldAssigned (MyBitVector vector, string field_name)
1511 int field_idx = TypeInfo.GetFieldIndex (field_name);
1516 vector [Offset + field_idx] = true;
1517 is_ever_assigned = true;
1520 public VariableInfo GetSubStruct (string name)
1522 TypeInfo type = TypeInfo.GetSubStruct (name);
1527 return new VariableInfo (this, type);
1530 public override string ToString ()
1532 return String.Format ("VariableInfo ({0}:{1}:{2}:{3}:{4})",
1533 Name, TypeInfo, Offset, Length, IsParameter);
1538 // This is a special bit vector which can inherit from another bit vector doing a
1539 // copy-on-write strategy. The inherited vector may have a smaller size than the
1542 public class MyBitVector {
1543 public readonly int Count;
1544 public static readonly MyBitVector Empty = new MyBitVector ();
1546 // Invariant: vector != null => vector.Count == Count
1547 // Invariant: vector == null || shared == null
1548 // i.e., at most one of 'vector' and 'shared' can be non-null. They can both be null -- that means all-ones
1549 // The object in 'shared' cannot be modified, while 'vector' can be freely modified
1550 BitArray vector, shared;
1554 shared = new BitArray (0, false);
1557 public MyBitVector (MyBitVector InheritsFrom, int Count)
1559 if (InheritsFrom != null)
1560 shared = InheritsFrom.Shared;
1565 // Use this accessor to get a shareable copy of the underlying BitArray representation
1568 // Post-condition: vector == null
1569 if (shared == null) {
1578 // Get/set bit `index' in the bit vector.
1580 public bool this [int index] {
1583 throw new ArgumentOutOfRangeException ();
1586 return vector [index];
1589 if (index < shared.Count)
1590 return shared [index];
1595 // Only copy the vector if we're actually modifying it.
1596 if (this [index] != value) {
1598 initialize_vector ();
1599 vector [index] = value;
1605 // Performs an `or' operation on the bit vector. The `new_vector' may have a
1606 // different size than the current one.
1608 private MyBitVector Or (MyBitVector new_vector)
1610 if (Count == 0 || new_vector.Count == 0)
1613 BitArray o = new_vector.vector != null ? new_vector.vector : new_vector.shared;
1616 int n = new_vector.Count;
1618 for (int i = 0; i < n; ++i)
1626 if (Count == o.Count) {
1627 if (vector == null) {
1630 initialize_vector ();
1640 for (int i = 0; i < min; i++) {
1649 // Performs an `and' operation on the bit vector. The `new_vector' may have
1650 // a different size than the current one.
1652 private MyBitVector And (MyBitVector new_vector)
1657 BitArray o = new_vector.vector != null ? new_vector.vector : new_vector.shared;
1660 for (int i = new_vector.Count; i < Count; ++i)
1670 if (Count == o.Count) {
1671 if (vector == null) {
1672 if (shared == null) {
1673 shared = new_vector.Shared;
1676 initialize_vector ();
1686 for (int i = 0; i < min; i++) {
1691 for (int i = min; i < Count; i++)
1697 public static MyBitVector operator & (MyBitVector a, MyBitVector b)
1705 if (a.Count > b.Count)
1706 return a.Clone ().And (b);
1708 return b.Clone ().And (a);
1711 public static MyBitVector operator | (MyBitVector a, MyBitVector b)
1716 return new MyBitVector (null, b.Count);
1718 return new MyBitVector (null, a.Count);
1719 if (a.Count > b.Count)
1720 return a.Clone ().Or (b);
1722 return b.Clone ().Or (a);
1725 public MyBitVector Clone ()
1727 return Count == 0 ? Empty : new MyBitVector (this, Count);
1730 public void SetRange (int offset, int length)
1732 if (offset > Count || offset + length > Count)
1733 throw new ArgumentOutOfRangeException ();
1735 if (shared == null && vector == null)
1739 if (shared != null) {
1740 if (offset + length <= shared.Count) {
1741 for (; i < length; ++i)
1742 if (!shared [i+offset])
1747 initialize_vector ();
1749 for (; i < length; ++i)
1750 vector [i+offset] = true;
1754 public void SetAll (bool value)
1756 // Don't clobber Empty
1759 shared = value ? null : Empty.Shared;
1763 void initialize_vector ()
1765 // Post-condition: vector != null
1766 if (shared == null) {
1767 vector = new BitArray (Count, true);
1771 vector = new BitArray (shared);
1772 if (Count != vector.Count)
1773 vector.Length = Count;
1777 StringBuilder Dump (StringBuilder sb)
1779 BitArray dump = vector == null ? shared : vector;
1781 return sb.Append ("/");
1784 for (int i = 0; i < dump.Count; i++)
1785 sb.Append (dump [i] ? "1" : "0");
1789 public override string ToString ()
1791 return Dump (new StringBuilder ("{")).Append ("}").ToString ();