* Copyright (c) 2026 Huawei Technologies Co., Ltd.
* This program is free software, you can redistribute it and/or modify it under the terms and conditions of
* CANN Open Software License Agreement Version 2.0 (the "License").
* Please refer to the License for details. You may not use this file except in compliance with the License.
* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED,
* INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
* See LICENSE in the root of the software repository for the full text of the License.
*/
* \file mask_checker.cpp
* \brief Checker for mask_mode, attn_mask, win_left, win_right parameters (文档约束: Mask参数组)
*/
#include <map>
#include <numeric>
#include <vector>
#include <graph/utils/type_utils.h>
#include "log/log.h"
#include "log/error_code.h"
#include "register/op_def_registry.h"
#include "../fa_tiling_info.h"
#include "mask_checker.h"
namespace optiling {
namespace flash_attn {
using std::map;
using std::pair;
using std::string;
using namespace ge;
using namespace AscendC;
using namespace arch35FA;
ge::graphStatus MaskChecker::CheckSingleParaMaskMode(const FaTilingInfo &faInfo)
{
const std::vector<int64_t> maskModeList = {static_cast<int64_t>(MaskMode::NO_MASK),
static_cast<int64_t>(MaskMode::CAUSAL)};
OP_CHECK_IF(ge::GRAPH_SUCCESS != CheckValueSupport(static_cast<int64_t>(faInfo.maskMode), maskModeList),
OP_LOGE(faInfo.opName, "mask_mode only supports 0/3, but got %ld", faInfo.maskMode),
return ge::GRAPH_FAILED);
return ge::GRAPH_SUCCESS;
}
ge::graphStatus MaskChecker::CheckSingleParaAttnMask(const FaTilingInfo &faInfo)
{
auto &attnMaskTensor = faInfo.opParamInfo.attnMask.tensor;
if (attnMaskTensor == nullptr) {
return ge::GRAPH_SUCCESS;
}
const gert::CompileTimeTensorDesc *attnMaskDesc = faInfo.opParamInfo.attnMask.desc;
OP_CHECK_IF(attnMaskDesc == nullptr, OP_LOGE(faInfo.opName, "attn_mask desc is null pointer!"),
return ge::GRAPH_FAILED);
OP_CHECK_IF(attnMaskDesc->GetDataType() != ge::DT_INT8,
OP_LOGE(faInfo.opName, "attn_mask dtype must be INT8, but got %s",
DataTypeToSerialString(attnMaskDesc->GetDataType()).c_str()),
return ge::GRAPH_FAILED);
if (ge::GRAPH_SUCCESS != CheckFormatSupport(attnMaskDesc, ATTN_MASK_NAME)) {
return ge::GRAPH_FAILED;
}
uint32_t dimNum = attnMaskTensor->GetStorageShape().GetDimNum();
OP_CHECK_IF(dimNum != 2, OP_LOGE(faInfo.opName, "attn_mask dim num must be 2, but got %u", dimNum),
return ge::GRAPH_FAILED);
int64_t dim0 = attnMaskTensor->GetStorageShape().GetDim(0);
int64_t dim1 = attnMaskTensor->GetStorageShape().GetDim(1);
OP_CHECK_IF(dim0 != SPARSE_OPTIMIZE_ATTENTION_SIZE || dim1 != SPARSE_OPTIMIZE_ATTENTION_SIZE,
OP_LOGE(faInfo.opName, "attn_mask shape must be (%u, %u), but got (%d, %d)",
SPARSE_OPTIMIZE_ATTENTION_SIZE, SPARSE_OPTIMIZE_ATTENTION_SIZE, dim0, dim1),
return ge::GRAPH_FAILED);
return ge::GRAPH_SUCCESS;
}
ge::graphStatus MaskChecker::CheckSingleParaWindowParams(const FaTilingInfo &faInfo)
{
OP_CHECK_IF(faInfo.winLeft < -1, OP_LOGE(faInfo.opName, "win_left(%ld) must be >= -1.", faInfo.winLeft),
return ge::GRAPH_FAILED);
OP_CHECK_IF(faInfo.winRight < -1, OP_LOGE(faInfo.opName, "win_right(%ld) must be >= -1.", faInfo.winRight),
return ge::GRAPH_FAILED);
return ge::GRAPH_SUCCESS;
}
ge::graphStatus MaskChecker::CheckSinglePara(const FaTilingInfo &faInfo)
{
if (CheckSingleParaMaskMode(faInfo) != ge::GRAPH_SUCCESS || CheckSingleParaAttnMask(faInfo) != ge::GRAPH_SUCCESS ||
CheckSingleParaWindowParams(faInfo) != ge::GRAPH_SUCCESS) {
return ge::GRAPH_FAILED;
}
return ge::GRAPH_SUCCESS;
}
ge::graphStatus MaskChecker::CheckParaExistence(const FaTilingInfo &faInfo)
{
auto &attnMaskTensor = faInfo.opParamInfo.attnMask.tensor;
if (faInfo.maskMode == static_cast<int64_t>(MaskMode::NO_MASK)) {
OP_CHECK_IF(attnMaskTensor != nullptr,
OP_LOGE(faInfo.opName, "attn_mask is not supported when mask_mode=0 (no mask mode)."),
return ge::GRAPH_FAILED);
OP_CHECK_IF(
faInfo.winLeft != -1,
OP_LOGE(faInfo.opName, "win_left must be -1 when mask_mode=0 (no mask mode), but got %ld.", faInfo.winLeft),
return ge::GRAPH_FAILED);
OP_CHECK_IF(faInfo.winRight != -1,
OP_LOGE(faInfo.opName, "win_right must be -1 when mask_mode=0 (no mask mode), but got %ld.",
faInfo.winRight),
return ge::GRAPH_FAILED);
}
if (faInfo.maskMode == static_cast<int64_t>(MaskMode::CAUSAL)) {
OP_CHECK_IF(attnMaskTensor == nullptr,
OP_LOGE(faInfo.opName, "attn_mask must be provided when mask_mode=3 (causal mode)."),
return ge::GRAPH_FAILED);
OP_CHECK_IF(
faInfo.winLeft != -1,
OP_LOGE(faInfo.opName, "win_left must be -1 when mask_mode=3 (causal mode), but got %ld.", faInfo.winLeft),
return ge::GRAPH_FAILED);
OP_CHECK_IF(faInfo.winRight != -1,
OP_LOGE(faInfo.opName, "win_right must be -1 when mask_mode=3 (causal mode), but got %ld.",
faInfo.winRight),
return ge::GRAPH_FAILED);
}
return ge::GRAPH_SUCCESS;
}
}
}
