compute-runtime/shared/source/command_stream/csr_definitions.h

/*
 * Copyright (C) 2018-2024 Intel Corporation
 *
 * SPDX-License-Identifier: MIT
 *
 */

#pragma once

#include "shared/source/command_stream/csr_deps.h"
#include "shared/source/command_stream/csr_properties_flags.h"
#include "shared/source/command_stream/memory_compression_state.h"
#include "shared/source/command_stream/preemption_mode.h"
#include "shared/source/command_stream/queue_throttle.h"
#include "shared/source/command_stream/thread_arbitration_policy.h"
#include "shared/source/helpers/pipeline_select_args.h"
#include "shared/source/kernel/grf_config.h"
#include "shared/source/kernel/kernel_execution_type.h"

#include <limits>

namespace NEO {
struct FlushStampTrackingObj;
struct StreamProperties;

namespace TimeoutControls {
inline constexpr int64_t maxTimeout = std::numeric_limits<int64_t>::max();
}

namespace QueueSliceCount {
inline constexpr uint64_t defaultSliceCount = 0;
}

namespace L3CachingSettings {
inline constexpr uint32_t l3CacheOn = 0u;
inline constexpr uint32_t l3CacheOff = 1u;
inline constexpr uint32_t l3AndL1On = 2u;
inline constexpr uint32_t notApplicable = 3u;
} // namespace L3CachingSettings

struct DispatchBcsFlags {
    DispatchBcsFlags() = delete;

    DispatchBcsFlags(bool flushTaskCount, bool hasStallingCmds, bool hasRelaxedOrderingDependencies)
        : flushTaskCount(flushTaskCount), hasStallingCmds(hasStallingCmds), hasRelaxedOrderingDependencies(hasRelaxedOrderingDependencies) {}

    bool flushTaskCount = false;
    bool hasStallingCmds = false;
    bool hasRelaxedOrderingDependencies = false;
};

struct DispatchFlags {
    DispatchFlags() = delete;
    DispatchFlags(TimestampPacketContainer *barrierTimestampPacketNodesP, PipelineSelectArgs pipelineSelectArgsP,
                  FlushStampTrackingObj *flushStampReferenceP, QueueThrottle throttleP, PreemptionMode preemptionModeP, uint32_t numGrfRequiredP,
                  uint32_t l3CacheSettingsP, int32_t threadArbitrationPolicyP, uint32_t additionalKernelExecInfoP,
                  KernelExecutionType kernelExecutionTypeP, MemoryCompressionState memoryCompressionStateP,
                  uint64_t sliceCountP, bool blockingP, bool dcFlushP, bool useSLMP, bool guardCommandBufferWithPipeControlP, bool gsba32BitRequiredP,
                  bool lowPriorityP, bool implicitFlushP, bool outOfOrderExecutionAllowedP, bool epilogueRequiredP,
                  bool usePerDSSbackedBufferP, bool areMultipleSubDevicesInContextP, bool memoryMigrationRequiredP, bool textureCacheFlush,
                  bool hasStallingCmds, bool hasRelaxedOrderingDependencies, bool stateCacheInvalidation, bool isStallingCommandsOnNextFlushRequired, bool isDcFlushRequiredOnStallingCommandsOnNextFlush) : barrierTimestampPacketNodes(barrierTimestampPacketNodesP),
                                                                                                                                                                                                             pipelineSelectArgs(pipelineSelectArgsP),
                                                                                                                                                                                                             flushStampReference(flushStampReferenceP),
                                                                                                                                                                                                             throttle(throttleP),
                                                                                                                                                                                                             preemptionMode(preemptionModeP),
                                                                                                                                                                                                             numGrfRequired(numGrfRequiredP),
                                                                                                                                                                                                             l3CacheSettings(l3CacheSettingsP),
                                                                                                                                                                                                             threadArbitrationPolicy(threadArbitrationPolicyP),
                                                                                                                                                                                                             additionalKernelExecInfo(additionalKernelExecInfoP),
                                                                                                                                                                                                             kernelExecutionType(kernelExecutionTypeP),
                                                                                                                                                                                                             memoryCompressionState(memoryCompressionStateP),
                                                                                                                                                                                                             sliceCount(sliceCountP),
                                                                                                                                                                                                             blocking(blockingP),
                                                                                                                                                                                                             dcFlush(dcFlushP),
                                                                                                                                                                                                             useSLM(useSLMP),
                                                                                                                                                                                                             guardCommandBufferWithPipeControl(guardCommandBufferWithPipeControlP),
                                                                                                                                                                                                             gsba32BitRequired(gsba32BitRequiredP),
                                                                                                                                                                                                             lowPriority(lowPriorityP),
                                                                                                                                                                                                             implicitFlush(implicitFlushP),
                                                                                                                                                                                                             outOfOrderExecutionAllowed(outOfOrderExecutionAllowedP),
                                                                                                                                                                                                             epilogueRequired(epilogueRequiredP),
                                                                                                                                                                                                             usePerDssBackedBuffer(usePerDSSbackedBufferP),
                                                                                                                                                                                                             areMultipleSubDevicesInContext(areMultipleSubDevicesInContextP),
                                                                                                                                                                                                             memoryMigrationRequired(memoryMigrationRequiredP),
                                                                                                                                                                                                             textureCacheFlush(textureCacheFlush),
                                                                                                                                                                                                             hasStallingCmds(hasStallingCmds),
                                                                                                                                                                                                             hasRelaxedOrderingDependencies(hasRelaxedOrderingDependencies),
                                                                                                                                                                                                             stateCacheInvalidation(stateCacheInvalidation),
                                                                                                                                                                                                             isStallingCommandsOnNextFlushRequired(isStallingCommandsOnNextFlushRequired),
                                                                                                                                                                                                             isDcFlushRequiredOnStallingCommandsOnNextFlush(isDcFlushRequiredOnStallingCommandsOnNextFlush){};

    CsrDependencies csrDependencies{};
    TimestampPacketContainer *barrierTimestampPacketNodes = nullptr;
    PipelineSelectArgs pipelineSelectArgs;
    FlushStampTrackingObj *flushStampReference = nullptr;
    QueueThrottle throttle = QueueThrottle::MEDIUM;
    PreemptionMode preemptionMode = PreemptionMode::Disabled;
    uint32_t numGrfRequired = GrfConfig::defaultGrfNumber;
    uint32_t l3CacheSettings = L3CachingSettings::l3CacheOn;
    int32_t threadArbitrationPolicy = ThreadArbitrationPolicy::NotPresent;
    uint32_t additionalKernelExecInfo = AdditionalKernelExecInfo::notApplicable;
    KernelExecutionType kernelExecutionType = KernelExecutionType::notApplicable;
    MemoryCompressionState memoryCompressionState = MemoryCompressionState::notApplicable;
    uint64_t sliceCount = QueueSliceCount::defaultSliceCount;
    uint64_t engineHints = 0;
    bool blocking = false;
    bool dcFlush = false;
    bool useSLM = false;
    bool guardCommandBufferWithPipeControl = false;
    bool gsba32BitRequired = false;
    bool lowPriority = false;
    bool implicitFlush = false;
    bool outOfOrderExecutionAllowed = false;
    bool epilogueRequired = false;
    bool usePerDssBackedBuffer = false;
    bool areMultipleSubDevicesInContext = false;
    bool memoryMigrationRequired = false;
    bool textureCacheFlush = false;
    bool hasStallingCmds = false;
    bool hasRelaxedOrderingDependencies = false;
    bool disableEUFusion = false;
    bool stateCacheInvalidation = false;
    bool isStallingCommandsOnNextFlushRequired = false;
    bool isDcFlushRequiredOnStallingCommandsOnNextFlush = false;
};

struct CsrSizeRequestFlags {
    bool l3ConfigChanged = false;
    bool preemptionRequestChanged = false;
    bool mediaSamplerConfigChanged = false;
    bool hasSharedHandles = false;
    bool systolicPipelineSelectMode = false;
    bool activePartitionsChanged = false;
};

struct ImmediateDispatchFlags {
    StreamProperties *requiredState = nullptr;
    void *sshCpuBase = nullptr;
    bool blockingAppend = false;
    bool requireTaskCountUpdate = false;
    bool hasRelaxedOrderingDependencies = false;
    bool hasStallingCmds = false;
};

} // namespace NEO