---
title: HcclBroadcast
description: "| 产品 | 是否支持 |"
url: https://www.hiascend.com/document/detail/zh/canncommercial/latest/API/hcclug/hcclcpp_07_0022.html
sourcePath: /source/zh/canncommercial/900/API/hcclug/hcclcpp_07_0022.html
indexId: ce6f52c7e9fc1b8e290bb2f49e57581a525552e313850bdf46bd4105fece020061
---
# HcclBroadcast

#### 产品支持情况

| 产品 | 是否支持 |
| --- | --- |
| Atlas 350 加速卡 | √ |
| Atlas A3 训练系列产品 / Atlas A3 推理系列产品 | √ |
| Atlas A2 训练系列产品 / Atlas A2 推理系列产品 | √ |
| Atlas 200I/500 A2 推理产品 | ☓ |
| Atlas 推理系列产品 | ☓ |
| Atlas 训练系列产品 | √ |


针对 Atlas A2 训练系列产品 / Atlas A2 推理系列产品 ，仅支持Atlas 800T A2 训练服务器、Atlas 900 A2 PoD 集群基础单元、Atlas 200T A2 Box16 异构子框。


#### 功能说明

集合通信算子Broadcast的操作接口，将通信域内root节点的数据广播到其他rank。


#### 函数原型

```
HcclResult HcclBroadcast(void *buf, uint64_t count, HcclDataType dataType, uint32_t root, HcclComm comm, aclrtStream stream)
```


#### 参数说明

| 参数名 | 输入/输出 | 描述 |
| --- | --- | --- |
| buf | 输入/输出 | 数据buffer地址，对于root节点，是源数据buffer地址；对于非root节点，是数据接收buffer地址。 |
| count | 输入 | 参与broadcast操作的数据个数，比如只有一个int32数据参与，则count=1。 |
| dataType | 输入 | Broadcast操作的数据类型，HcclDataType类型。 针对Atlas 350 加速卡，支持数据类型：int8、uint8、int16、uint16、int32、uint32、int64、uint64、float8\-e5m2、float8\-e4m3、float8\-e8m0、hifloat8、float16、float32、float64、bfp16。 针对 Atlas A3 训练系列产品 / Atlas A3 推理系列产品 ，支持数据类型：int8、uint8、int16、uint16、int32、uint32、int64、uint64、float16、float32、float64、bfp16。 针对 Atlas A2 训练系列产品 / Atlas A2 推理系列产品 ，支持数据类型：int8、uint8、int16、uint16、int32、uint32、int64、uint64、float16、float32、float64、bfp16。 针对 Atlas 训练系列产品 ，支持数据类型：int8、uint8、int16、uint16、int32、uint32、int64、uint64、float16、float32、float64。 |
| root | 输入 | 作为broadcast root的rank id。 |
| comm | 输入 | 集合通信操作所在的通信域。 |
| stream | 输入 | 本rank所使用的stream。 |


#### 返回值

HcclResult：接口成功返回HCCL_SUCCESS，其他失败。


#### 约束说明

- 所有rank的count、dataType、root均应相同。
- 全局只能有1个root节点。


#### 调用示例

```
// 申请集合通信操作的 Device 内存
void *buf = nullptr;    // 对于root节点，是数据源；对于非root节点，是数据接收buffer
uint64_t count = 8;     // 参与broadcast操作的数据个数
size_t mallocSize = count * sizeof(float);
aclrtMalloc(&buf, mallocSize, ACL_MEM_MALLOC_HUGE_ONLY);

// 在 root 节点构造输入数据
if (deviceId == rootRank) {    
    aclrtMemcpy(buf, mallocSize, hostBuf, mallocSize, ACL_MEMCPY_HOST_TO_DEVICE);
}

// 初始化通信域
uint32_t rankSize = 8;
HcclComm hcclComm;
HcclCommInitRootInfo(rankSize, &rootInfo, deviceId, &hcclComm);

// 创建任务流
aclrtStream stream;
aclrtCreateStream(&stream);

// 执行广播操作，将通信域内 root 节点的数据广播至其他 rank
HcclBroadcast(buf, count, HCCL_DATA_TYPE_FP32, rootRank, hcclComm, stream);
// 阻塞等待任务流中的集合通信任务执行完成
aclrtSynchronizeStream(stream);

// 释放资源
aclrtFree(sendBuf);          // 释放 Device 侧内存
aclrtFree(recvBuf);          // 释放 Device 侧内存
aclrtDestroyStream(stream);  // 销毁任务流
HcclCommDestroy(hcclComm);   // 销毁通信域
```