Csrot

产品支持情况

产品 是否支持
Atlas 200I/500 A2 推理产品 ×
Atlas 推理系列产品 ×
Atlas 训练系列产品 ×
Atlas A3 训练系列产品/Atlas A3 推理系列产品
Atlas A2 训练系列产品/Atlas A2 推理系列产品
Ascend 950PR/Ascend 950DT ×

功能说明

  • 接口功能:
    asdBlasMakeRotPlan:初始化该句柄对应的Csrot算子配置。
    asdBlasCsrot:对输入复向量组(x,y)进行旋转。

  • 计算公式:

    [xy]=[cs−sc]∗[xy]\begin{bmatrix} x\\y\end{bmatrix}=\begin{bmatrix} c & s\\-s & c\end{bmatrix}*\begin{bmatrix} x\\y\end{bmatrix}

    其中,x[i]= c*x[i]+s*y[i],y[i]= -s*x[i]+c*y[i]
    c为旋转角度余弦值,s为旋转角度正弦值,x和y是复数向量。
    示例: 输入“x”为:
    [3.0 + 4.0j, 2.0 + 1.0j]
    输入“y”为:
    [1.0 + 1.0j, 3.0 + 3.0j]
    输入“c”为:
    32\frac{\sqrt{3}}{2}
    输入“s”为:
    0.5
    调用asdBlasCsrot算子后,输出“x”为:
    [3.098076+3.9641016j, 3.232051+2.3660254j]
    输出“y”为:
    [-0.6339746-1.1339746j, 1.5980761+2.098076j]

函数原型

AspbStatus asdBlasMakeRotPlan(
  asdBlasHandle handle)
AspbStatus asdBlasCsrot(
  asdBlasHandle     handle, 
  const int64_t     n, 
  aclTensor *       x, 
  const int64_t     incx, 
  aclTensor *       y,
  const int64_t     incy, 
  const float &     c, 
  const float &     s)

asdBlasMakeRotPlan

  • 参数说明:

    参数名 输入/输出 描述
    handle(asdBlasHandle) 输入 算子的句柄。
  • 返回值

    返回状态码,具体参见SiP返回码

asdBlasCsrot

  • 参数说明:

    参数名 输入/输出 描述
    handle(asdBlasHandle) 输入 算子的句柄。
    n(int64_t) 输入 表示向量中复数元素的个数。
    x(aclTensor *) 输入/输出
    • 对应公式中的'x'。
    • 数据类型支持COMPLEX64。
    • 数据格式支持ND。
    • shape为[n]
    incx(int64_t) 输入 x相邻元素间的内存地址偏移量(当前约束为1)。
    y(aclTensor *) 输入/输出
    • 对应公式中的'y'。
    • 数据类型支持COMPLEX64。
    • 数据格式支持ND。
  • shape为[n]
  • incy(int64_t) 输入 y相邻元素间的内存地址偏移量(当前约束为1)。
    c(float &) 输入 旋转矩阵的余弦值指针。
    s(float &) 输入 旋转矩阵的正弦值指针。
  • 返回值

    返回状态码,具体参见SiP返回码

约束说明

  • 输入的元素个数n当前覆盖支持[1,2.50e+06]。
  • 算子输入shape为[n],输出shape为[n]。
  • 算子实际计算时,不支持ND高维度运算(不支持维度≥3的运算)。

调用示例

示例代码如下,该样例旨在提供快速上手、开发和调试算子的最小化实现,其核心目标是使用最精简的代码展示算子的核心功能,而非提供生产级的安全保障。不推荐用户直接将示例代码作为业务代码,若用户将示例代码应用在自身的真实业务场景中且发生了安全问题,则需用户自行承担。

  • asdBlasCsrot
#include <iostream>
#include <vector>
#include <complex>
#include "asdsip.h"
#include "acl/acl.h"
#include "acl_meta.h"
#include "utils/mem_base.h"

using namespace AsdSip;

#define ASD_STATUS_CHECK(err)                                                \
    do {                                                                     \
        AsdSip::AspbStatus err_ = (err);                                     \
        if (err_ != AsdSip::ErrorType::ACL_SUCCESS) {                                      \
            std::cout << "Execute failed." << std::endl; \
            exit(-1);                                                        \
        } else {                                                             \
            std::cout << "Execute successfully." << std::endl;               \
        }                                                                    \
    } while (0)

#define CHECK_RET(cond, return_expr) \
    do {                             \
        if (!(cond)) {               \
            return_expr;             \
        }                            \
    } while (0)

#define LOG_PRINT(message, ...)         \
    do {                                \
        printf(message, ##__VA_ARGS__); \
    } while (0)

int64_t GetShapeSize(const std::vector<int64_t> &shape)
{
    int64_t shapeSize = 1;
    for (auto i : shape) {
        shapeSize *= i;
    }
    return shapeSize;
}

int Init(int32_t deviceId, aclrtStream *stream)
{
    // 固定写法,acl初始化
    auto ret = aclInit(nullptr);
    CHECK_RET(ret == ::ACL_SUCCESS, LOG_PRINT("aclInit failed. ERROR: %d\n", ret); return ret);
    ret = aclrtSetDevice(deviceId);
    CHECK_RET(ret == ::ACL_SUCCESS, LOG_PRINT("aclrtSetDevice failed. ERROR: %d\n", ret); return ret);
    ret = aclrtCreateStream(stream);
    CHECK_RET(ret == ::ACL_SUCCESS, LOG_PRINT("aclrtCreateStream failed. ERROR: %d\n", ret); return ret);
    return 0;
}

template <typename T>
int CreateAclTensor(const std::vector<T> &hostData, const std::vector<int64_t> &shape, void **deviceAddr,
    aclDataType dataType, aclTensor **tensor)
{
    auto size = GetShapeSize(shape) * sizeof(T);
    // 调用aclrtMalloc申请device侧内存
    auto ret = aclrtMalloc(deviceAddr, size, ACL_MEM_MALLOC_HUGE_FIRST);
    CHECK_RET(ret == ::ACL_SUCCESS, LOG_PRINT("aclrtMalloc failed. ERROR: %d\n", ret); return ret);
    // 调用aclrtMemcpy将host侧数据复制到device侧内存上
    ret = aclrtMemcpy(*deviceAddr, size, hostData.data(), size, ACL_MEMCPY_HOST_TO_DEVICE);
    CHECK_RET(ret == ::ACL_SUCCESS, LOG_PRINT("aclrtMemcpy failed. ERROR: %d\n", ret); return ret);

    // 计算连续tensor的strides
    std::vector<int64_t> strides(shape.size(), 1);
    for (int64_t i = shape.size() - 2; i >= 0; i--) {
        strides[i] = shape[i + 1] * strides[i + 1];
    }

    // 调用aclCreateTensor接口创建aclTensor
    *tensor = aclCreateTensor(shape.data(),
        shape.size(),
        dataType,
        strides.data(),
        0,
        aclFormat::ACL_FORMAT_ND,
        shape.data(),
        shape.size(),
        *deviceAddr);
    return 0;
}

void printTensor(const std::complex<float> *tensorData, int64_t tensorSize)
{
    for (int64_t i = 0; i < tensorSize; i++) {
        std::cout << tensorData[i] << " ";
    }
    std::cout << std::endl;
}

int main(int argc, char **argv)
{
    int deviceId = 0;

    aclrtStream stream;
    auto ret = Init(deviceId, &stream);
    CHECK_RET(ret == ::ACL_SUCCESS, LOG_PRINT("Init acl failed. ERROR: %d\n", ret); return ret);

    int64_t n = 4;
    int incx = 1;
    int incy = 1;
    const float cosValue = sqrt(3) / 2;
    const float sinValue = 0.5;

    int64_t xSize = n;
    int64_t ySize = n;

    std::vector<std::complex<float>> tensorInXData;
    tensorInXData.reserve(xSize);
    for (int64_t i = 0; i < n; i++) {
        tensorInXData[i] = (std::complex<float>){2.0, 3.0};
    }

    std::vector<std::complex<float>> tensorInYData;
    tensorInYData.reserve(ySize);
    for (int64_t i = 0; i < n; i++) {
        tensorInYData[i] = (std::complex<float>){5.0, 6.0};
    }

    std::cout << "cosValue = " << cosValue << std::endl;
    std::cout << "sinValue = " << sinValue << std::endl;
    std::cout << "------- input TensorInX -------" << std::endl;
    printTensor(tensorInXData.data(), xSize);
    std::cout << "------- input TensorInY -------" << std::endl;
    printTensor(tensorInYData.data(), ySize);

    std::vector<int64_t> xShape = {xSize};
    std::vector<int64_t> yShape = {ySize};
    aclTensor *inputX = nullptr;
    aclTensor *inputY = nullptr;
    void *inputXDeviceAddr = nullptr;
    void *inputYDeviceAddr = nullptr;
    ret = CreateAclTensor(tensorInXData, xShape, &inputXDeviceAddr, aclDataType::ACL_COMPLEX64, &inputX);
    CHECK_RET(ret == ::ACL_SUCCESS, return ret);
    ret = CreateAclTensor(tensorInYData, yShape, &inputYDeviceAddr, aclDataType::ACL_COMPLEX64, &inputY);
    CHECK_RET(ret == ::ACL_SUCCESS, return ret);

    asdBlasHandle handle;
    asdBlasCreate(handle);

    size_t lwork = 0;
    void *buffer = nullptr;
    asdBlasMakeRotPlan(handle);
    asdBlasGetWorkspaceSize(handle, lwork);
    std::cout << "lwork = " << lwork << std::endl;
    if (lwork > 0) {
        ret = aclrtMalloc(&buffer, static_cast<int64_t>(lwork), ACL_MEM_MALLOC_HUGE_FIRST);
        CHECK_RET(ret == ::ACL_SUCCESS, LOG_PRINT("allocate workspace failed. ERROR: %d\n", ret); return ret);
    }
    asdBlasSetWorkspace(handle, buffer);
    asdBlasSetStream(handle, stream);

    ASD_STATUS_CHECK(asdBlasCsrot(handle, n, inputX, incx, inputY, incy, cosValue, sinValue));

    asdBlasSynchronize(handle);
    asdBlasDestroy(handle);

    ret = aclrtMemcpy(tensorInXData.data(),
        xSize * sizeof(std::complex<float>),
        inputXDeviceAddr,
        xSize * sizeof(std::complex<float>),
        ACL_MEMCPY_DEVICE_TO_HOST);
    CHECK_RET(ret == ::ACL_SUCCESS, LOG_PRINT("copy tensor x from device to host failed. ERROR: %d\n", ret); return ret);

    ret = aclrtMemcpy(tensorInYData.data(),
        ySize * sizeof(std::complex<float>),
        inputYDeviceAddr,
        ySize * sizeof(std::complex<float>),
        ACL_MEMCPY_DEVICE_TO_HOST);
    CHECK_RET(ret == ::ACL_SUCCESS, LOG_PRINT("copy tensor y from device to host failed. ERROR: %d\n", ret); return ret);

    std::cout << "------- output TensorInX -------" << std::endl;
    printTensor(tensorInXData.data(), xSize);
    std::cout << "------- output TensorInY -------" << std::endl;
    printTensor(tensorInYData.data(), ySize);

    aclDestroyTensor(inputX);
    aclDestroyTensor(inputY);
    aclrtFree(inputXDeviceAddr);
    aclrtFree(inputYDeviceAddr);

    aclrtDestroyStream(stream);
    aclrtResetDevice(deviceId);
    aclFinalize();
    return 0;
}