okftype: reference.api description: "按掩码对压缩索引做解压缩:目的寄存器第 0 个元素为 0,第 i 个元素等于掩码第 0 至 i-1 位中 1 的数量,掩码最高位不参与统计。" tag:
- roles: [compute]
- operations: [conversion]
- traits: [count_limited] dependencies:
- path: docs/zh/api/SIMD-API/c_api/defs/type/data_type_definition.md kind: requires condition: "矢量数据寄存器与掩码寄存器的类型定义"
- path: docs/zh/api/SIMD-API/c_api/reg_compute/overview.md kind: constrained_by condition: "Reg 矢量计算 C API 通用约束" version: ">=9.0.0" version_changes:
- since: "9.2.0" kind: overload_added scope: "section:函数原型" scope_basis: resolved note: "9.2.0 新增按函数名后缀区分数据类型的返回值形式 asc_unsqueeze_u8/s8/u16/s16/u32/s32(simd_callee inline vector_T asc_unsqueeze_
(vector_bool mask)),9.0.0/9.1.0 只有引用输出形式;Release Notes CANN_9_2_0 明确记录这六个接口支持通过函数返回值获取掩码前缀计数结果。" - since: "9.2.0" kind: header_reorganized scope: "page" scope_basis: kind_default note: "声明位置由 include/c_api/reg_compute/reg_vector.h(9.1.0 及更早)统一到 include/c_api/reg_compute/compute/reg_permute_sel.h(9.2.0 起)。"
asc_unsqueeze
产品支持情况
- Ascend 950PR&950DT系列产品:支持
- Atlas A3系列产品:不支持
- Atlas A2系列产品:不支持
- Atlas 200I/500 A2推理产品:不支持
- Atlas推理系列产品AI Core:不支持
- Atlas推理系列产品Vector Core:不支持
- Atlas训练系列产品:不支持
功能说明
头文件路径为:"c_api/reg_compute/compute/reg_permute_sel.h"。
将dst中数据根据mask进行解压缩,或将解压缩结果通过函数返回值返回。解压缩方式:dst中第0个元素置为0,dst中的第i个元素等于mask中从第0个到第(i-1)个元素中1的数量。mask最高位被忽略,不参与统计。
具体算法如图1所示,dst的首位为0。对于后续元素,与dst[i-1]对应的有效mask位为1时,dst[i]的值为dst[i-1] + 1;对应的有效mask位为0时,dst[i]的值为dst[i-1]。
图1 unsqueeze流程

本接口为Reg矢量计算接口,仅在AIV上生效。
函数原型
// 通过函数返回值返回结果。
__simd_callee__ inline vector_uint8_t asc_unsqueeze_u8(vector_bool mask)
__simd_callee__ inline vector_int8_t asc_unsqueeze_s8(vector_bool mask)
__simd_callee__ inline vector_uint16_t asc_unsqueeze_u16(vector_bool mask)
__simd_callee__ inline vector_int16_t asc_unsqueeze_s16(vector_bool mask)
__simd_callee__ inline vector_uint32_t asc_unsqueeze_u32(vector_bool mask)
__simd_callee__ inline vector_int32_t asc_unsqueeze_s32(vector_bool mask)
// 通过引用参数输出结果。
__simd_callee__ inline void asc_unsqueeze(vector_<dtype>& dst,
vector_bool mask)
dtype支持数据类型
dtype取值为:int8_t、uint8_t、int16_t、uint16_t、int32_t、uint32_t。返回值类型接口通过函数名后缀区分数据类型,对应关系如下:
| 函数名后缀 | 数据类型 |
|---|---|
| u8 | uint8_t |
| s8 | int8_t |
| u16 | uint16_t |
| s16 | int16_t |
| u32 | uint32_t |
| s32 | int32_t |
函数原型典型示例
// 示例:对int8_t矢量数据寄存器执行解压缩,通过函数返回值返回结果。
__simd_callee__ inline vector_int8_t asc_unsqueeze_s8(vector_bool mask)
// 示例:对int8_t矢量数据寄存器执行解压缩。
__simd_callee__ inline void asc_unsqueeze(vector_int8_t& dst,
vector_bool mask)
参数说明
表1 参数说明
| 参数名 | 输入/输出 | 描述 |
|---|---|---|
| dst | 输入/输出 | 源和目的矢量数据寄存器,仅无返回值类型接口包含该参数,接口在掩码前缀计数过程中写入计数结果。 |
| mask | 输入 | 源掩码寄存器,用于提供dst解压缩信息。 |
矢量数据寄存器和掩码寄存器的详细说明请参见reg数据类型定义。
返回值说明
对于返回值类型接口,返回保存解压缩结果的矢量数据寄存器,数据类型由函数名后缀决定(参见函数原型中的对应关系表)。
约束说明
- Reg矢量计算C API通用约束请参见通用约束。
- dst与mask为矢量数据寄存器/掩码寄存器。
调用示例
将代码保存为example.asc后,可通过bisheng命令编译运行,其中--npu-arch参数需根据实际产品型号指定对应的NPU架构,具体产品与NPU架构的映射关系请参考__NPU_ARCH__。
以Ascend 950PR&950DT系列产品(对应NPU架构为dav-3510)为例,编译运行命令如下:
bisheng example.asc -o main --npu-arch=dav-3510&& ./main
#include <cstdint>
#include <iostream>
#include <vector>
#include "c_api/asc_simd.h"
#include "utils/std/cmath.h"
#include "acl/acl.h"
namespace {
constexpr uint8_t MUTEX_ID = 0;
template <typename T>
void print_data(const char* label, const std::vector<T>& values)
{
std::cout << label << ":";
const size_t count = values.size() < 8 ? values.size() : 8;
for (size_t i = 0; i < count; ++i) std::cout << ' ' << +values[i];
if (values.size() > count) std::cout << " ...";
std::cout << std::endl;
}
template <typename T>
bool compare_data(const std::vector<T>& actual, const std::vector<T>& expected, double tolerance = 0.0)
{
if (actual.size() != expected.size()) return false;
for (size_t i = 0; i < actual.size(); ++i) {
if (actual[i] == expected[i]) continue;
const double diff = static_cast<double>(actual[i]) - static_cast<double>(expected[i]);
if (diff > tolerance || diff < -tolerance) return false;
}
return true;
}
template <typename T>
bool compare_range_data(const std::vector<T>& actual, const std::vector<T>& expected,
size_t begin, size_t remaining_length, double tolerance = 0.0)
{
if (begin + remaining_length > actual.size() || begin + remaining_length > expected.size()) return false;
for (size_t i = begin; i < begin + remaining_length; ++i) {
if (actual[i] == expected[i]) continue;
const double diff = static_cast<double>(actual[i]) - static_cast<double>(expected[i]);
if (diff > tolerance || diff < -tolerance) return false;
}
return true;
}
constexpr uint32_t ELEMENTS_PER_REGISTER = 64;
constexpr uint32_t DATA_BYTES = 137 * sizeof(uint32_t);
// 统一记录实际处理长度,用于计算迭代次数并限制尾轮的有效范围。
constexpr uint32_t TOTAL_LENGTH = DATA_BYTES / sizeof(uint32_t);
// 按单轮处理能力向上取整,确保非整寄存器长度的尾块也被处理。
constexpr uint32_t REPEAT_COUNT =
(TOTAL_LENGTH + ELEMENTS_PER_REGISTER - 1) / ELEMENTS_PER_REGISTER;
// 按完整寄存器块扩展UB容量,避免尾轮整寄存器访问越界;有效范围仍由掩码控制。
constexpr uint32_t PADDED_ELEMENT_COUNT = REPEAT_COUNT * ELEMENTS_PER_REGISTER;
__simd_vf__ inline void unsqueeze(__ubuf__ uint32_t* dst, uint32_t one_repeat_size, uint16_t repeat_time)
{
// 保留剩余有效元素数,供更新掩码处理尾块。
uint32_t remaining_length = TOTAL_LENGTH;
for (uint16_t i = 0; i < repeat_time; ++i) {
const uint32_t offset = i * one_repeat_size;
vector_uint32_t dst_reg;
vector_bool mask = asc_update_mask_b32(remaining_length);
asc_unsqueeze(dst_reg, mask);
asc_storealign(dst + offset, dst_reg, mask);
}
}
__global__ __vector__ void asc_unsqueeze_kernel(__gm__ uint32_t* dst)
{
asc_init();
__ubuf__ uint32_t dst_local[TOTAL_LENGTH];
uint32_t one_repeat_size = static_cast<uint32_t>(asc_get_vf_len() / sizeof(uint32_t));
uint16_t repeat_time = static_cast<uint16_t>(AscendC::Std::ceil_div(TOTAL_LENGTH, one_repeat_size));
asc_lock(PIPE_V, MUTEX_ID);
asc_vf_call<unsqueeze>(dst_local, one_repeat_size, repeat_time);
asc_unlock(PIPE_V, MUTEX_ID);
asc_lock(PIPE_MTE3, MUTEX_ID);
asc_copy_ub2gm_align(dst, dst_local, TOTAL_LENGTH * sizeof(uint32_t));
asc_unlock(PIPE_MTE3, MUTEX_ID);
asc_sync();
}
} // namespace
int main()
{
std::vector<uint32_t> input = {TOTAL_LENGTH};
std::vector<uint32_t> output(TOTAL_LENGTH, 0), golden(TOTAL_LENGTH);
for (uint32_t i = 0; i < TOTAL_LENGTH; ++i) golden[i] = i % ELEMENTS_PER_REGISTER;
aclInit(nullptr);
aclrtSetDevice(0);
uint32_t* dst_device = nullptr;
aclrtMalloc(reinterpret_cast<void**>(&dst_device), (TOTAL_LENGTH) * sizeof(uint32_t),
ACL_MEM_MALLOC_HUGE_FIRST);
asc_unsqueeze_kernel<<<1, 0>>>(dst_device);
aclrtSynchronizeDevice();
aclrtMemcpy(output.data(), output.size() * sizeof(uint32_t), dst_device, output.size() * sizeof(uint32_t),
ACL_MEMCPY_DEVICE_TO_HOST);
print_data("Input mask remaining_length", input);
print_data("Output", output);
print_data("Golden", golden);
const bool passed = compare_data(output, golden);
std::cout << (passed ? "[Success] asc_unsqueeze passed." : "[Failed] asc_unsqueeze failed.") << std::endl;
aclrtFree(dst_device);
aclrtResetDevice(0);
aclFinalize();
return passed ? 0 : 1;
}