c# - Strange "Collection was modified after the enumerator was instantiated" exception

Question

Perhaps someone can point me in the correct direction, because I'm completely stumped on this.

I have a function that simply prints out a LinkedList of classes:

    LinkedList<Component> components = new LinkedList<Component>();
    ...
    private void PrintComponentList()
    {
        Console.WriteLine("---Component List: " + components.Count + " entries---");
        foreach (Component c in components)
        {
            Console.WriteLine(c);
        }
        Console.WriteLine("------");
    }

The Component object actually has a custom ToString() call as such:

    int Id;
    ...
    public override String ToString()
    {
        return GetType() + ": " + Id;
    }

This function typically works fine - however I've run into the issue that when it builds to about 30 or so entries in the list, the PrintcomplentList foreach statement comes back with an InvalidOperationException: Collection was modified after the enumerator was instantiated.

Now as you can see I'm not modifying the code within the for loop, and I haven't explicitly created any threads, although this is within an XNA environment (if it matters). It should be noted that the printout is frequent enough that the Console output is slowing down the program as a whole.

I'm completely stumped, has anyone else out there run into this?

Answer 1

I suspect the place to start looking will be at any places where you manipulate the list - i.e. insert/remove/re-assign items. My suspicion is that there will be a callback/even-handler somewhere that is getting fired asynchronously (perhaps as part of the XNA paint etc loops), and which is editing the list - essentially causing this problem as a race condition.

To check if this is the case, put some debug/trace output around the places that manipulate the list, and see if it ever (and in particular, just before the exception) runs the manipulation code at the same time as your console output:

private void SomeCallback()
{
   Console.WriteLine("---Adding foo"); // temp investigation code; remove
   components.AddLast(foo);
   Console.WriteLine("---Added foo"); // temp investigation code; remove
}

Unfortunately, such things are often a pain to debug, as changing the code to investigate it often changes the problem (a Heisenbug).

One answer would be to synchronize access; i.e. in all the places that edit the list, use a lock around the complete operation:

LinkedList<Component> components = new LinkedList<Component>();
readonly object syncLock = new object();
...
private void PrintComponentList()
{
    lock(syncLock)
    { // take lock before first use (.Count), covering the foreach
        Console.WriteLine("---Component List: " + components.Count
              + " entries---");
        foreach (Component c in components)
        {
           Console.WriteLine(c);
        }
        Console.WriteLine("------");
    } // release lock
}

and in your callback (or whatever)

private void SomeCallback()
{
   lock(syncLock)
   {
       components.AddLast(foo);
   }
}

In particular, a "complete operation" might include:

• check the count and foreach/for
• check for existance and insert/remove
• etc

(i.e. not the individual/discrete operations - but units of work)