SystemBase ForEach System.IndexOutOfRangeException: Index {0} error

Unity Engine
,
1

Hi all, any help with the following would be appreciated. The code below runs fine to find the nearest target to assign to entities, but when the number of entities exceeds the number of targets I get the error

"
System.IndexOutOfRangeException: Index {0} is out of restricted IJobParallelFor range [{1}…{2}] in ReadWriteBuffer.
Thrown from job: FindNearestTargetSystem.<>c__DisplayClass_Compare_Agent_And_Target_Positions
"

From what I have googled it seems like

  • it may be fixed by making some element ReadOnly but I haven’t been able to figure it out
  • some misunderstanding about how ScheduleParallel works
  • some error in my logic
using Unity.Collections;
using Unity.Entities;
using Unity.Mathematics;
using Unity.Transforms;

public class FindNearestTargetSystem : SystemBase
{
    private EntityCommandBufferSystem _ecbSystem;

    private EntityQuery _targetsQuery;
    private EntityQuery _agentsQuery;

    protected override void OnCreate()
    {
        base.OnCreate();
        _ecbSystem = World.GetExistingSystem<EndSimulationEntityCommandBufferSystem>();
    }

    protected override void OnUpdate()
    {
        var buffer = _ecbSystem.CreateCommandBuffer().AsParallelWriter();

        // make a native array - its length is decided by how many agents we have in our entity query
        var agentsQueryCount = _agentsQuery.CalculateEntityCount();

        var targetEntities  = new NativeArray<Entity>(agentsQueryCount, Allocator.TempJob);
        var targetPositions = new NativeArray<float3>(agentsQueryCount, Allocator.TempJob);

        // used to temporarily store the distance between an agent and possible targets
        var distances = new NativeArray<float>(agentsQueryCount, Allocator.TempJob);
        var agentPositions = new NativeArray<float3>(agentsQueryCount, Allocator.TempJob);

        // get all AGENT positions
        // set a default high/infinity value for distance check
        Entities
            .WithName("Get_Agent_Positions")
            .WithStoreEntityQueryInField(ref _agentsQuery)
            .WithAll<TargetData>()
            .WithAll<NeedsTargetTag>()
            .ForEach((Entity e, int entityInQueryIndex, in Translation translation) =>
            {
                agentPositions[entityInQueryIndex] = translation.Value;
                distances[entityInQueryIndex] = float.PositiveInfinity;
            })
            .ScheduleParallel();

        // nested For loops to find the closest target
        // compare all target positions with all agent positions to find the shortest distances for each pair
        // TODO - Performance can be enhanced by use of grid check for large maps
        Entities
            .WithName("Compare_Agent_And_Target_Positions")
            .WithAll<TargetTag>()
            .WithStoreEntityQueryInField(ref _targetsQuery)
            .WithReadOnly(agentPositions)
            .ForEach((Entity targetEntity, int entityInQueryIndex, in Translation targetPos) =>
            {
                // compare all target pos to all agent pos
                for (var i = 0; i < agentPositions.Length; i++)
                {
                    // calculate the distance between target and agent
                    float distance = distances[i];
                    var newDistance = math.distance(targetPos.Value, agentPositions[i]);

                    // if the distance is smaller then store this and the associated target and target position
                    if (newDistance < distance)
                    {
                        distances[i] = newDistance;
                        targetEntities[i] = targetEntity;
                        targetPositions[i] = targetPos.Value;
                    }
                }
            })
            .WithDisposeOnCompletion(distances)
            .WithDisposeOnCompletion(agentPositions)
            .ScheduleParallel();

        // assign the data values obtained from the above For loops
        Entities
            .WithName("Assign_Closest_Target_Position")
            .ForEach((Entity e, int entityInQueryIndex, ref TargetData targetData, ref NeedsTargetTag needsTargetTag) =>
            {
                targetData.TargetPosition = targetPositions[entityInQueryIndex];
                targetData.Target = targetEntities[entityInQueryIndex];
                buffer.RemoveComponent<NeedsTargetTag>(entityInQueryIndex, e);
            })
            .WithDisposeOnCompletion(targetEntities)
            .WithDisposeOnCompletion(targetPositions)
            .ScheduleParallel();

        _ecbSystem.AddJobHandleForProducer(Dependency);

    }
}
2

I would assume that is not the full error message. Usually it tells you to disable Burst and enable Full Stack Traces to get the full error stack. it will be much easier to tell what’s going on then.

Im not sure i understand why you write every AgentPosition into a nativeArray before comparing them to TargetPositions. Couldn’t you do it all in one job? I handle those situations by iterating over the AgentChunks with an IJobChunk and then passing the TargetChunks into this job. In the Job i then manually iterate over the TargetChunks for each entity in the AgentChunks. No idea if that is the most optimal way but i like to get everything off the mainthread.

The easiest solution that is a bit worse because of random memory access would be to just use GetComponent(targetentity). It’s still fast since it’s essentially just a hashmap lookup and should be totally fine if you don’t have to check thousands of potential targets. Then again you wouldn’t need to allocate and free memory.

3

My guess is that it is complaining about line 68, and rightly so. That’s a real race condition. If you want to write your logic that way, you should use Schedule instead of ScheduleParallel. Otherwise you need to rewrite that logic to ensure that multiple entities don’t reach that conditional logic and try writing to that array index at the same time.

1 Like
4

Hey thanks for the considered reply, you might be right about using the chunk way. I will try the GetComponent way as well and benchmark them all. My goal was just to do it a “dumb dumb” way to start, like 1+1=2 level.

The full error code without Burst enabled is
"
IndexOutOfRangeException: Index 1 is out of restricted IJobParallelFor range [0…0] in ReadWriteBuffer.
ReadWriteBuffers are restricted to only read & write the element at the job index. You can use double buffering strategies to avoid race conditions due to reading & writing in parallel to the same elements from a job.
Unity.Collections.NativeArray1[T].FailOutOfRangeError (System.Int32 index) (at <88f69663e9a64d00b2091dd8dfd4d38f>:0) Unity.Collections.NativeArray1[T].CheckElementReadAccess (System.Int32 index) (at <88f69663e9a64d00b2091dd8dfd4d38f>:0)
Unity.Collections.NativeArray1[T].get_Item (System.Int32 index) (at <88f69663e9a64d00b2091dd8dfd4d38f>:0) FindNearestTargetSystem+<>c__DisplayClass_Compare_Agent_And_Target_Positions.IterateEntities (Unity.Entities.ArchetypeChunk& chunk, FindNearestTargetSystem+<>c__DisplayClass_Compare_Agent_And_Target_Positions+LambdaParameterValueProviders+Runtimes& runtimes) (at <e5e2430c5c3c4ac5b3502cb2ca670e60>:0) FindNearestTargetSystem+<>c__DisplayClass_Compare_Agent_And_Target_Positions.Execute (Unity.Entities.ArchetypeChunk chunk, System.Int32 chunkIndex, System.Int32 firstEntityIndex) (at <e5e2430c5c3c4ac5b3502cb2ca670e60>:0) Unity.Entities.JobChunkExtensions+JobChunkProducer1[T].ExecuteInternal (Unity.Entities.JobChunkExtensions+JobChunkWrapper1[T]& jobWrapper, System.IntPtr bufferRangePatchData, Unity.Jobs.LowLevel.Unsafe.JobRanges& ranges, System.Int32 jobIndex) (at Library/PackageCache/com.unity.entities@0.17.0-preview.42/Unity.Entities/IJobChunk.cs:386) Unity.Entities.JobChunkExtensions+JobChunkProducer1[T].Execute (Unity.Entities.JobChunkExtensions+JobChunkWrapper`1[T]& jobWrapper, System.IntPtr additionalPtr, System.IntPtr bufferRangePatchData, Unity.Jobs.LowLevel.Unsafe.JobRanges& ranges, System.Int32 jobIndex) (at Library/PackageCache/com.unity.entities@0.17.0-preview.42/Unity.Entities/IJobChunk.cs:353)
"

5

Thanks for looking at the code.

So the problem is that two or more threads are trying to read and write to the distances NativeArray?

6

Yes. Multiple threads try to set the same Index in the distance NativeArray in parrallel because you allocate it on the main thread just once for all your entities. To get around it without rewriting your logic you can either give every targetEntity its own DynamicBuffer which could store all it’s own distances to every Agent or use .Schedule() as @DreamingImLatios suggested.

1 Like