/**
 * Copyright (c) Huawei Technologies Co., Ltd. 2024. All rights reserved.
 *
 * 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 OP_API_INC_CONVOLUTION_BACKWARD_H_
#define OP_API_INC_CONVOLUTION_BACKWARD_H_

#include "aclnn/aclnn_base.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief aclnnConvolutionBackward的第一段接口，计算并获取workspace大小
 * @domain aclnn_ops_train
 *
 * @param [in] gradOutput: npu，卷积输出梯度
 * device侧的aclTensor，数据类型浮点类型FLOAT16，FLOAT32，BFLOAT16
 * 支持非连续的Tensor，数据格式支持NCL、NCHW
 * @param [in] input: npu，卷积输入
 * device侧的aclTensor，数据类型浮点类型FLOAT16，FLOAT32，BFLOAT16
 * 支持非连续的Tensor，数据格式支持NCL、NCHW
 * @param [in] weight: npu, 卷积权重
 * device侧的aclTensor，数据类型与input一致
 * 支持非连续的Tensor，数据格式与input一致
 * @param [in] biasSizes: npu，偏置的shape
 * aclIntArray, shape为1
 * @param [in] stride: 步长
 * aclIntArray，数组长度可以为1或者input的维度-2（也等于kernel size -1），例：2D卷积的步长数组的有效长度是2位
 * @param [in] padding: 补边
 * aclIntArray，数组长度可以为1或者input的维度-2（也等于kernel size -1），在NCHW格式下可为4维。例：2D卷积的padding数组的有效长度是2位
 * @param [in] dilation: kernel中元素的间隔，>1代表空洞卷积
 * aclIntArray，数组长度可以为1或者input的维度-2（也等于kernel size -1），例：2D卷积的dilation数组的有效长度是2位
 * @param [in] transposed: 是否转置
 * bool，True代表转置卷积
 * @param [in] outputPadding：转置卷积时生效，对输出的补边
 * aclIntArray，数组长度可以为1或者input的维度-2，值必须分别小于stride或者dilation的最大值，例：2D转置卷积的dilation数组的有效长度是2位
 * @param [in] groups：分组数，表示从输入通道到输出通道的块链接个数
 * int64，大于0且能整除input和output的通道数， input通道数 = weight通道数*groups
 * @param [in] outputMask：输出掩码, 指定输出中是否包含输入、权重、偏差的梯度
 * aclBoolArray, 反向传播过程输出掩码参数为True对应位置的梯度
 * @param [in] cubeMathType：用于判断Cube单元应该使用哪种计算逻辑进行运算
 * int8_t, Cube单元计算逻辑判断参数
 * @param [out] grad_input: 卷积输入梯度在npu device侧的aclTensor
 * @param [out] grad_input: 卷积权重梯度在npu device侧的aclTensor
 * @param [out] grad_bias: 卷积偏置梯度在npu device侧的aclTensor
 * @param [out] workspace_size: 返回用户需要在npu device侧申请的workspace大小。
 * @param [out] executor: 返回op执行器，包含算子计算流程。
 * @return aclnnStatus: 返回状态码。
 */
aclnnStatus aclnnConvolutionBackwardGetWorkspaceSize(const aclTensor *gradOutput, const aclTensor *input,
                                                     const aclTensor *weight, const aclIntArray *biasSizes,
                                                     const aclIntArray *stride, const aclIntArray *padding,
                                                     const aclIntArray *dilation, const bool transposed,
                                                     const aclIntArray *outputPadding, const int groups,
                                                     const aclBoolArray *outputMask, const int8_t cubeMathType,
                                                     aclTensor *gradInput, aclTensor *gradWeight, aclTensor *gradBias,
                                                     uint64_t *workspaceSize, aclOpExecutor **executor);

/**
 * @brief aclnnConvTbcBackward的第一段接口，计算并获取workspace大小
 * @domain aclnn_ops_train
 *
 * @param [in] self: npu，卷积输出梯度
 * device侧的aclTensor，数据类型浮点类型FLOAT16，FLOAT32
 * 支持非连续的Tensor，数据格式支持ND、NCHW
 * @param [in] input: npu，卷积输入
 * device侧的aclTensor，数据类型浮点类型FLOAT16，FLOAT32
 * 支持非连续的Tensor，数据格式支持ND、NCHW
 * @param [in] weight: npu, 卷积权重
 * device侧的aclTensor，数据类型与input一致
 * 支持非连续的Tensor，数据格式与input一致
 * @param [in] bias: npu，卷积偏置
 * device侧的aclTensor，数据类型与input一致
 * @param [in] pad: 补边
 * int64_t,（也等于kernel size -1），例：2D卷积的padding数组的有效长度是2位
 * @param [in] dilation: kernel中元素的间隔，>1代表空洞卷积
 * aclIntArray，数组长度需等于input的维度-2（也等于kernel size -1），例：2D卷积的dilation数组的有效长度是2位
 * @param [out] grad_input: 卷积输入梯度在npu device侧的aclTensor
 * @param [out] grad_input: 卷积权重梯度在npu device侧的aclTensor
 * @param [out] grad_bias: 卷积偏置梯度在npu device侧的aclTensor
 * @param [out] workspace_size: 返回用户需要在npu device侧申请的workspace大小。
 * @param [out] executor: 返回op执行器，包含算子计算流程。
 * @return aclnnStatus: 返回状态码。
 */
aclnnStatus aclnnConvTbcBackwardGetWorkspaceSize(const aclTensor *self, const aclTensor *input,
                                                 const aclTensor *weight, const aclTensor *bias,
                                                 const int64_t pad, const int8_t cubeMathType,
                                                 aclTensor *gradInput, aclTensor *gradWeight,
                                                 aclTensor *gradBias, uint64_t *workspaceSize,
                                                 aclOpExecutor **executor);


/**
 * @brief aclnnConvolutionBackward的第二段接口，用于执行计算。
 *
 * 算子功能：完成卷积反向计算
 * @param [in] workspace: 在npu device侧申请的workspace内存起址。
 * @param [in] workspaceSize: 在npu device侧申请的workspace大小，由第一段接口aclnnConvTbcBackwardGetWorkspaceSize获取。
 * @param [in] executor: op执行器，包含了算子计算流程。
 * @param [in] stream: acl stream流。
 * @return aclnnStatus: 返回状态码。
 */
aclnnStatus aclnnConvolutionBackward(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor,
                                     const aclrtStream stream);

/**
 * @brief aclnnConvTbcBackward的第二段接口，用于执行计算。
 *
 * 算子功能：完成卷积反向计算
 * @param [in] workspace: 在npu device侧申请的workspace内存起址。
 * @param [in] workspaceSize: 在npu device侧申请的workspace大小，由第一段接口aclnnConvTbcbackwardGetWorkspaceSize获取。
 * @param [in] executor: op执行器，包含了算子计算流程。
 * @param [in] stream: acl stream流。
 * @return aclnnStatus: 返回状态码。
 */
aclnnStatus aclnnConvTbcBackward(void *workspace, uint64_t workspaceSize, aclOpExecutor *executor,
                                 const aclrtStream stream);

#ifdef __cplusplus
}
#endif

#endif  // OP_API_INC_CONVOLUTION_BACKWARD_H_