compute-runtime/shared/test/unit_test/fixtures/command_container_fixture.h

/*
 * Copyright (C) 2020-2025 Intel Corporation
 *
 * SPDX-License-Identifier: MIT
 *
 */

#pragma once
#include "shared/source/command_container/command_encoder.h"
#include "shared/source/helpers/cache_policy.h"
#include "shared/source/kernel/kernel_descriptor.h"
#include "shared/source/program/kernel_info.h"
#include "shared/test/common/fixtures/device_fixture.h"
#include "shared/test/common/test_macros/test.h"

namespace NEO {

class CommandEncodeStatesFixture : public DeviceFixture {
  public:
    class MyMockCommandContainer : public CommandContainer {
      public:
        using CommandContainer::allocationIndirectHeaps;
        using CommandContainer::dirtyHeaps;
        using CommandContainer::indirectHeaps;

        IndirectHeap *getHeapWithRequiredSizeAndAlignment(HeapType heapType, size_t sizeRequired, size_t alignment) override {
            getHeapWithRequiredSizeAndAlignmentCalled++;
            return CommandContainer::getHeapWithRequiredSizeAndAlignment(heapType, sizeRequired, alignment);
        }
        uint32_t getHeapWithRequiredSizeAndAlignmentCalled = 0u;
    };

    void setUp();
    void tearDown();

    static EncodeDispatchKernelArgs createDefaultDispatchKernelArgs(Device *device, DispatchKernelEncoderI *dispatchInterface, const void *threadGroupDimensions, bool requiresUncachedMocs) {
        EncodeDispatchKernelArgs args{
            .device = device,
            .dispatchInterface = dispatchInterface,
            .surfaceStateHeap = nullptr,
            .dynamicStateHeap = nullptr,
            .threadGroupDimensions = threadGroupDimensions,
            .outWalkerPtr = nullptr,
            .outWalkerGpuVa = 0,
            .cpuWalkerBuffer = nullptr,
            .cpuPayloadBuffer = nullptr,
            .outImplicitArgsPtr = nullptr,
            .outImplicitArgsGpuVa = 0,
            .additionalCommands = nullptr,
            .extendedArgs = nullptr,
            .postSyncArgs = {
                .eventAddress = 0,
                .postSyncImmValue = 0,
                .inOrderCounterValue = 0,
                .inOrderIncrementGpuAddress = 0,
                .inOrderIncrementValue = 0,
                .device = device,
                .inOrderExecInfo = nullptr,
                .isCounterBasedEvent = false,
                .isTimestampEvent = false,
                .isHostScopeSignalEvent = false,
                .isUsingSystemAllocation = false,
                .dcFlushEnable = false,
                .interruptEvent = false,
                .isFlushL3ForExternalAllocationRequired = false,
                .isFlushL3ForHostUsmRequired = false,
            },
            .preemptionMode = PreemptionMode::Disabled,
            .requiredPartitionDim = NEO::RequiredPartitionDim::none,
            .requiredDispatchWalkOrder = NEO::RequiredDispatchWalkOrder::none,
            .localRegionSize = NEO::localRegionSizeParamNotSet,
            .partitionCount = 1,
            .reserveExtraPayloadSpace = 0,
            .maxWgCountPerTile = 1,
            .defaultPipelinedThreadArbitrationPolicy = NEO::ThreadArbitrationPolicy::NotPresent,
            .isIndirect = false,
            .isPredicate = false,
            .requiresUncachedMocs = requiresUncachedMocs,
            .isInternal = false,
            .isCooperative = false,
            .isKernelDispatchedFromImmediateCmdList = false,
            .isRcs = false,
            .isHeaplessModeEnabled = false,
            .isHeaplessStateInitEnabled = false,
            .immediateScratchAddressPatching = false,
            .makeCommandView = false,
        };

        return args;
    }

    static EncodeWalkerArgs createDefaultEncodeWalkerArgs(const KernelDescriptor &kernelDescriptor);

    template <typename FamilyType>
    EncodeStateBaseAddressArgs<FamilyType> createDefaultEncodeStateBaseAddressArgs(
        CommandContainer *container,
        typename FamilyType::STATE_BASE_ADDRESS &sbaCmd,
        uint32_t statelessMocs) {

        EncodeStateBaseAddressArgs<FamilyType> args = {
            container,                                // container
            sbaCmd,                                   // sbaCmd
            nullptr,                                  // sbaProperties
            statelessMocs,                            // statelessMocsIndex
            l1CachePolicyData.getL1CacheValue(false), // l1CachePolicy
            l1CachePolicyData.getL1CacheValue(true),  // l1CachePolicyDebuggerActive
            false,                                    // multiOsContextCapable
            false,                                    // isRcs
            container->doubleSbaWaRef(),              // doubleSbaWa
            false                                     // heaplessModeEnabled
        };
        return args;
    }

    KernelDescriptor descriptor;
    KernelInfo kernelInfo;
    std::unique_ptr<MyMockCommandContainer> cmdContainer;
    NEO::L1CachePolicy l1CachePolicyData;
};

struct ScratchProgrammingFixture : public NEO::DeviceFixture {
    void setUp();
    void tearDown();

    IndirectHeap *ssh = nullptr;
    void *sshBuffer = nullptr;
};

} // namespace NEO

struct WalkerThreadFixture {
    void setUp();
    void tearDown() {}

    uint32_t startWorkGroup[3];
    uint32_t numWorkGroups[3];
    uint32_t workGroupSizes[3];
    uint32_t simd;
    uint32_t localIdDimensions;
    uint32_t requiredWorkGroupOrder;
};

using WalkerThreadTest = Test<WalkerThreadFixture>;