src/dawn/native/Limits.h

// Copyright 2021 The Dawn Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SRC_DAWN_NATIVE_LIMITS_H_
#define SRC_DAWN_NATIVE_LIMITS_H_

#include "dawn/native/Error.h"
#include "dawn/native/Features.h"
#include "dawn/native/VisitableMembers.h"
#include "dawn/native/dawn_platform.h"

namespace dawn::native {

struct CombinedLimits {
    Limits v1;
    DawnExperimentalSubgroupLimits experimentalSubgroupLimits;
};

// Populate |limits| with the default limits.
void GetDefaultLimits(Limits* limits, FeatureLevel featureLevel);

// Returns a copy of |limits| where all undefined values are replaced
// with their defaults. Also clamps to the defaults if the provided limits
// are worse.
Limits ReifyDefaultLimits(const Limits& limits, FeatureLevel featureLevel);

// Validate that |requiredLimits| are no better than |supportedLimits|.
MaybeError ValidateLimits(const Limits& supportedLimits, const Limits& requiredLimits);

// Returns a copy of |limits| where limit tiers are applied.
Limits ApplyLimitTiers(Limits limits);

// If there are new limit member needed at shader compilation time
// Simply append a new X(type, name) here.
#define LIMITS_FOR_COMPILATION_REQUEST_MEMBERS(X)  \
    X(uint32_t, maxComputeWorkgroupSizeX)          \
    X(uint32_t, maxComputeWorkgroupSizeY)          \
    X(uint32_t, maxComputeWorkgroupSizeZ)          \
    X(uint32_t, maxComputeInvocationsPerWorkgroup) \
    X(uint32_t, maxComputeWorkgroupStorageSize)

struct LimitsForCompilationRequest {
    static LimitsForCompilationRequest Create(const Limits& limits);
    DAWN_VISITABLE_MEMBERS(LIMITS_FOR_COMPILATION_REQUEST_MEMBERS)
};

// Enforce restriction for limit values, including:
//   1. Enforce internal Dawn constants for some limits to ensure they don't go over fixed-size
//      arrays in Dawn's internal code;
//   2. Additional enforcement for dependent limits, e.g. maxStorageBufferBindingSize and
//      maxUniformBufferBindingSize must not be larger than maxBufferSize.
void NormalizeLimits(Limits* limits);

}  // namespace dawn::native

#endif  // SRC_DAWN_NATIVE_LIMITS_H_