asc_atomic_sub

产品支持情况

Ascend 950PR/Ascend 950DT：支持

Atlas A3 训练系列产品/Atlas A3 推理系列产品：不支持

Atlas A2 训练系列产品/Atlas A2 推理系列产品：不支持

Atlas 200I/500 A2 推理产品：不支持

Atlas 推理系列产品AI Core：不支持
Atlas 推理系列产品Vector Core：不支持

Atlas 训练系列产品：不支持

功能说明

对Unified Buffer或Global Memory上的数据与指定数据执行原子减操作，即在这些内存区域的数据中减去指定数据。

函数原型

inline int32_t asc_atomic_sub(int32_t *address, int32_t val)

inline uint32_t asc_atomic_sub(uint32_t *address, uint32_t val)

inline float asc_atomic_sub(float *address, float val)

inline int64_t asc_atomic_sub(int64_t *address, int64_t val)

inline uint64_t asc_atomic_sub(uint64_t *address, uint64_t val)

inline half2 asc_atomic_sub(half2 *address, half2 val)

inline bfloat16x2_t asc_atomic_sub(bfloat16x2_t *address, bfloat16x2_t val)

参数说明

表1 参数说明

参数名	输入/输出	描述
address	输出	Unified Buffer或Global Memory的地址。
val	输入	源操作数。

不同数据类型支持的内存范围说明如下：

表2 不同数据类型支持的内存范围

参数数据类型	支持的内存空间
int32_t、uint32_t、float、half2、bfloat16x2_t	Unified Buffer、Global Memory
int64_t、uint64_t	Global Memory

返回值说明

Unified Buffer或Global Memory上的初始数据。

约束说明

原子操作保证对同一地址的读改写过程具有原子性，但不保证多个线程之间的执行顺序。对于浮点累减或依赖返回值顺序敏感的场景，结果可能随线程调度变化而不同。
本接口的性能受以下因素影响，相关原理请参见原子操作机制。
- 内存空间：Unified Buffer的访问路径比Global Memory短，通常具有更低的访问开销。当使用的数据类型支持Unified Buffer（即int32_t、uint32_t、float、half2、bfloat16x2_t）时，建议优先在Unified Buffer中完成原子操作。
- 返回值：该接口无对应的性能优化指令，对于所有数据类型，程序中是否使用该接口返回值，接口性能基本一致。
- 地址分布：Global Memory原子操作经过L2 Cache处理，L2 Cache以512B Cache Line为缓存管理单位，每条Cache Line包含4个128B扇区（Sector），Global Memory原子操作以128B Sector为处理粒度。目标地址集中在同一个Sector内时，处理效率较低；目标地址分布在更多Sector内时，处理效率较高。因此，业务允许时，建议将原子操作的目标地址分散到更多Sector中。

需要包含的头文件

使用除half2、bfloat16x2_t类型之外的接口需要包含"simt_api/device_atomic_functions.h"头文件，使用half2类型接口需要包含"simt_api/asc_fp16.h"头文件，使用bfloat16x2_t类型接口需要包含"simt_api/asc_bf16.h"头文件。

#include "simt_api/device_atomic_functions.h"

#include "simt_api/asc_fp16.h"

#include "simt_api/asc_bf16.h"

调用示例

示例场景为：多个线程处理资源申请量，使用asc_atomic_sub接口从共享剩余配额中扣减已消费数量。该用例假设申请总量不超过初始配额，避免无符号下溢。输入输出参数说明如下：

名称	说明
`requests`	每个元素表示一条资源申请需要扣减的配额。
`remaining`	Global Memory中的剩余配额，kernel启动前初始化。
`n`	申请条数。

核心代码实现如下：

SIMT编程场景：

__global__ __launch_bounds__(256) void consume_quota(uint32_t *remaining,
                                                     uint32_t *requests,
                                                     uint32_t n)
{
    uint32_t idx = blockIdx.x * blockDim.x + threadIdx.x;
    if (idx >= n) {
        return;
    }

    asc_atomic_sub(remaining, requests[idx]);
}

SIMD与SIMT混合编程场景：

SIMD与SIMT混合编程场景，需要显式使用地址空间限定符表示地址空间：__gm__表示Global Memory内存空间，__ubuf__表示Unified Buffer内存空间。

__simt_vf__ __launch_bounds__(1024) inline void consume_quota(__gm__ uint32_t *remaining,
                                                              __gm__ uint32_t *requests,
                                                              uint32_t n)
{
    uint32_t idx = blockIdx.x * blockDim.x + threadIdx.x;
    if (idx >= n) {
        return;
    }

    asc_atomic_sub(remaining, requests[idx]);
}

输出结果示例如下：

remaining before: 100
requests: 4, 8, 3
remaining after: 85 // 表明共享配额被3个线程原子扣减了15