* Copyright (c) 2025 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.
*/
#include "aclnn_tanh.h"
#include "aclnn_kernels/contiguous.h"
#include "tanh.h"
#include "aclnn_kernels/cast.h"
#include "aclnn/aclnn_base.h"
#include "opdev/common_types.h"
#include "opdev/data_type_utils.h"
#include "opdev/format_utils.h"
#include "opdev/op_dfx.h"
#include "opdev/op_executor.h"
#include "opdev/op_log.h"
#include "opdev/shape_utils.h"
#include "opdev/tensor_view_utils.h"
#include "opdev/platform.h"
#include "aclnn_kernels/common/op_error_check.h"
#include "op_api/op_api_def.h"
#include "op_api/aclnn_check.h"
using namespace op;
#ifdef __cplusplus
extern "C" {
#endif
static const std::initializer_list<op::DataType> ASCEND910_DTYPE_SUPPORT_LIST = {
op::DataType::DT_FLOAT, op::DataType::DT_FLOAT16, op::DataType::DT_BOOL,
op::DataType::DT_UINT8, op::DataType::DT_INT8, op::DataType::DT_INT16,
op::DataType::DT_INT32, op::DataType::DT_INT64
};
static const std::initializer_list<op::DataType> ASCEND910B_DTYPE_SUPPORT_LIST = {
op::DataType::DT_FLOAT, op::DataType::DT_FLOAT16, op::DataType::DT_BOOL,
op::DataType::DT_UINT8, op::DataType::DT_INT8, op::DataType::DT_INT16,
op::DataType::DT_INT32, op::DataType::DT_INT64, op::DataType::DT_BF16
};
static const std::initializer_list<op::DataType> ASCEND910_DTYPE_OUT_LIST = {
op::DataType::DT_FLOAT, op::DataType::DT_FLOAT16};
static const std::initializer_list<op::DataType> ASCEND910B_DTYPE_OUT_LIST = {
op::DataType::DT_FLOAT, op::DataType::DT_FLOAT16, op::DataType::DT_BF16};
static const std::initializer_list<op::DataType> DTYPE_CAST_LIST = {
op::DataType::DT_BOOL, op::DataType::DT_UINT8, op::DataType::DT_INT8,
op::DataType::DT_INT16, op::DataType::DT_INT32, op::DataType::DT_INT64
};
static const std::initializer_list<DataType>& GetOutDtypeSupportList() {
if (GetCurrentPlatformInfo().GetSocVersion() == SocVersion::ASCEND910B ||
GetCurrentPlatformInfo().GetSocVersion() == SocVersion::ASCEND910_93 ||
IsRegBase()) {
return ASCEND910B_DTYPE_OUT_LIST;
} else {
return ASCEND910_DTYPE_OUT_LIST;
}
}
static bool CheckNotNull(const aclTensor *self, const aclTensor *out) {
OP_CHECK_NULL(self, return false);
OP_CHECK_NULL(out, return false);
return true;
}
static bool CheckDtypeValid(const aclTensor *self, const aclTensor *out) {
bool isAscend910BSocVersion = (GetCurrentPlatformInfo().GetSocVersion() >= SocVersion::ASCEND910B &&
GetCurrentPlatformInfo().GetSocVersion() <= SocVersion::ASCEND910E);
const std::initializer_list<op::DataType> CURRENT_DTYPE_SUPPORT_LIST =
isAscend910BSocVersion ? ASCEND910B_DTYPE_SUPPORT_LIST : ASCEND910_DTYPE_SUPPORT_LIST;
OP_CHECK_DTYPE_NOT_SUPPORT(self, CURRENT_DTYPE_SUPPORT_LIST, return false);
OP_CHECK_DTYPE_NOT_SUPPORT(out, CURRENT_DTYPE_SUPPORT_LIST, return false);
auto castType = (IsIntegralType(self->GetDataType(), true)) ?
op::DataType::DT_FLOAT : self->GetDataType();
OP_CHECK_RESULT_DTYPE_CAST_FAILED(castType, out->GetDataType(), return false);
return true;
}
static bool CheckFormat(const aclTensor *self, const aclTensor *out) {
if (self->GetViewFormat() != out->GetViewFormat()) {
OP_LOGE(ACLNN_ERR_PARAM_INVALID, "Format of input and output should be equal, self [%s], out [%s].",
op::ToString(self->GetViewFormat()).GetString(), op::ToString(out->GetViewFormat()).GetString());
return false;
}
if (op::IsPrivateFormat(self->GetViewFormat())) {
OP_LOGE(ACLNN_ERR_PARAM_INVALID, "Format only support ND、NCHW、NHWC、HWCN、NDHWC、NCDHW, not support [%s].",
ToString(self->GetViewFormat()).GetString());
return false;
}
if (self->GetStorageFormat() != Format::FORMAT_ND) {
OP_LOGW("Only support ND format for tanh/inplaceTanh operator.");
}
return true;
}
static bool CheckShape(const aclTensor *self, const aclTensor *out) {
OP_CHECK_MAX_DIM(self, MAX_SUPPORT_DIMS_NUMS, return false);
OP_CHECK_SHAPE_NOT_EQUAL(self, out, return false);
return true;
}
static aclnnStatus CheckParams(const aclTensor *self, const aclTensor *out) {
CHECK_RET(CheckNotNull(self, out), ACLNN_ERR_PARAM_NULLPTR);
CHECK_RET(CheckDtypeValid(self, out), ACLNN_ERR_PARAM_INVALID);
CHECK_RET(CheckFormat(self, out), ACLNN_ERR_PARAM_INVALID);
CHECK_RET(CheckShape(self, out), ACLNN_ERR_PARAM_INVALID);
return ACLNN_SUCCESS;
}
static bool CheckInplaceDtypeValid(aclTensor *selfRef) {
auto inplaceSupportList = GetOutDtypeSupportList();
OP_CHECK_DTYPE_NOT_SUPPORT(selfRef, inplaceSupportList, return false);
return true;
}
static aclnnStatus CheckInplaceParams(aclTensor *selfRef) {
OP_CHECK_NULL(selfRef, return ACLNN_ERR_PARAM_NULLPTR);
CHECK_RET(CheckInplaceDtypeValid(selfRef), ACLNN_ERR_PARAM_INVALID);
return ACLNN_SUCCESS;
}
aclnnStatus ExecTanhGetWorkspaceSize(const aclTensor *self, aclTensor *out,
uint64_t *workspaceSize, aclOpExecutor **executor) {
auto uniqueExecutor = CREATE_EXECUTOR();
CHECK_RET(uniqueExecutor.get() != nullptr, ACLNN_ERR_INNER_CREATE_EXECUTOR);
auto ret = CheckParams(self, out);
CHECK_RET(ret == ACLNN_SUCCESS, ret);
if (self->IsEmpty() || out->IsEmpty()) {
*workspaceSize = 0;
uniqueExecutor.ReleaseTo(executor);
return ACLNN_SUCCESS;
}
auto selfContiguous = l0op::Contiguous(self, uniqueExecutor.get());
if (CheckType(self->GetDataType(), DTYPE_CAST_LIST)) {
selfContiguous = l0op::Cast(selfContiguous, op::DataType::DT_FLOAT, uniqueExecutor.get());
}
CHECK_RET(selfContiguous != nullptr, ACLNN_ERR_INNER_NULLPTR);
auto tanhOut = l0op::Tanh(selfContiguous, uniqueExecutor.get());
CHECK_RET(tanhOut != nullptr, ACLNN_ERR_INNER_NULLPTR);
auto castOut = l0op::Cast(tanhOut, out->GetDataType(), uniqueExecutor.get());
CHECK_RET(castOut != nullptr, ACLNN_ERR_PARAM_NULLPTR);
auto viewCopyResult = l0op::ViewCopy(castOut, out, uniqueExecutor.get());
CHECK_RET(viewCopyResult != nullptr, ACLNN_ERR_INNER_NULLPTR);
*workspaceSize = uniqueExecutor->GetWorkspaceSize();
uniqueExecutor.ReleaseTo(executor);
return ACLNN_SUCCESS;
}
aclnnStatus aclnnTanhGetWorkspaceSize(const aclTensor *self,
aclTensor *out,
uint64_t *workspaceSize,
aclOpExecutor **executor) {
L2_DFX_PHASE_1(aclnnTanh, DFX_IN(self), DFX_OUT(out));
return ExecTanhGetWorkspaceSize(self, out, workspaceSize, executor);
}
aclnnStatus aclnnTanh(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor, const aclrtStream stream) {
L2_DFX_PHASE_2(aclnnTanh);
return CommonOpExecutorRun(workspace, workspaceSize, executor, stream);
}
aclnnStatus aclnnInplaceTanhGetWorkspaceSize(aclTensor *selfRef,
uint64_t *workspaceSize,
aclOpExecutor **executor) {
L2_DFX_PHASE_1(aclnnInplaceTanh, DFX_IN(selfRef), DFX_OUT(selfRef));
auto ret = CheckInplaceParams(selfRef);
CHECK_RET(ret == ACLNN_SUCCESS, ret);
auto out = const_cast<aclTensor*>(selfRef);
return ExecTanhGetWorkspaceSize(selfRef, out, workspaceSize, executor);
}
aclnnStatus aclnnInplaceTanh(void *workspace, uint64_t workspaceSize,
aclOpExecutor *executor, const aclrtStream stream) {
L2_DFX_PHASE_2(aclnnInplaceTanh);
return CommonOpExecutorRun(workspace, workspaceSize, executor, stream);
}
#ifdef __cplusplus
}
#endif