* Copyright (c) 2026 Huawei Technologies Co., Ltd.
* This program is free software, you can redistribute it and/or modify it under the terms and conditions of
* CANN Open Software License Agreement Version 2.0 (the "License").
* Please refer to the License for details. You may not use this file except in compliance with the License.
* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED,
* INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
* See LICENSE in the root of the software repository for the full text of the License.
*/
#ifndef HCOMM_PRIMITIVES_DL_H
#define HCOMM_PRIMITIVES_DL_H
#include "dlsym_common.h"
#include "hcomm_primitives.h"
#include "hccl_types.h"
#if CANN_VERSION_NUM < CANN_VERSION(9, 0, 0)
typedef void *HcclCommSymWindow;
#endif
* 避免在旧 HCOMM 头文件未声明新类型时编译失败。
*/
typedef enum {
HCCL_HCOMM_TRANSFER_TYPE_INVALID = -1,
HCCL_HCOMM_TRANSFER_TYPE_WRITE = 0,
HCCL_HCOMM_TRANSFER_TYPE_WRITE_REDUCE = 1,
HCCL_HCOMM_TRANSFER_TYPE_WRITE_WITH_NOTIFY = 2,
HCCL_HCOMM_TRANSFER_TYPE_WRITE_REDUCE_WITH_NOTIFY = 3,
HCCL_HCOMM_TRANSFER_TYPE_READ = 4,
HCCL_HCOMM_TRANSFER_TYPE_READ_REDUCE = 5,
HCCL_HCOMM_TRANSFER_TYPE_NOTIFY_RECORD = 6,
HCCL_HCOMM_TRANSFER_TYPE_NOTIFY_WAIT = 7,
HCCL_HCOMM_TRANSFER_TYPE_NOTIFY_WAIT_WITH_DEFAULT_TIMEOUT = 8
} HcclHcommTransferType;
typedef struct {
HcclHcommTransferType transType;
uint8_t reserved[4];
union {
uint8_t raws[56];
struct {
uint64_t len;
void *dst;
void *src;
} write;
struct {
uint64_t len;
void *dst;
void *src;
} read;
struct {
uint64_t count;
void *dst;
void *src;
HcommReduceOp reduceOp;
HcommDataType dataType;
} reduce;
struct {
uint32_t notifyIdx;
} notifyRecord;
struct {
uint64_t len;
void *dst;
void *src;
uint32_t notifyIdx;
} writeWithNotify;
struct {
uint64_t count;
void *dst;
void *src;
HcommReduceOp reduceOp;
HcommDataType dataType;
uint32_t notifyIdx;
} writeReduceWithNotify;
} transferInfo;
} HcclHcommBatchTransferDesc;
#ifdef __cplusplus
extern "C" {
#endif
DECL_WEAK_FUNC(int32_t, HcommThreadSynchronize, ThreadHandle thread);
DECL_WEAK_FUNC(int32_t, HcommSendRequest, uint64_t handle, const char* msgTag, const void* src, size_t sizeByte, uint32_t* msgId);
DECL_WEAK_FUNC(int32_t, HcommWaitResponse, uint64_t handle, void* dst, size_t sizeByte, uint32_t* msgId);
DECL_WEAK_FUNC(HcclResult, HcommThreadJoin, ThreadHandle thread, uint32_t timeout);
DECL_WEAK_FUNC(HcclResult, HcclSymWinGetPeerPointer, HcclCommSymWindow winHandle,
size_t offset, uint32_t peerRank, void** ptr);
DECL_WEAK_FUNC(HcclResult, HcclCommSymWinGet, HcclComm comm, void *ptr, size_t size,
HcclCommSymWindow *winHandle, size_t *offset);
DECL_WEAK_FUNC(int32_t, HcommThreadResAcquireTimeOut, uint32_t timeOut);
DECL_WEAK_FUNC(int32_t, HcommSetNotifyWaitTimeOut, uint32_t timeOut);
DECL_WEAK_FUNC(int32_t, HcommThreadNotifyWaitOnThreadWithDefaultTimeout, ThreadHandle thread, uint32_t notifyIdx);
DECL_WEAK_FUNC(int32_t, HcommChannelNotifyWaitOnThreadWithDefaultTimeout, ThreadHandle thread,
ChannelHandle channel, uint32_t localNotifyIdx);
DECL_WEAK_FUNC(int32_t, HcommChannelNotifyWaitWithDefaultTimeout, ChannelHandle channel, uint32_t localNotifyIdx);
DECL_WEAK_FUNC(int32_t, HcommWriteWithNotifyNbiOnThread, ThreadHandle thread, ChannelHandle channel,
void* dst, const void* src, uint64_t len, uint32_t remoteNotifyIdx);
DECL_WEAK_FUNC(int32_t, HcommChannelFenceOnThread, ThreadHandle thread, ChannelHandle channel);
DECL_SUPPORT_FLAG(HcommBatchTransferOnThread);
DECL_SUPPORT_FLAG(HcommThreadResAcquireTimeOut);
DECL_SUPPORT_FLAG(HcommSetNotifyWaitTimeOut);
DECL_SUPPORT_FLAG(HcommThreadNotifyWaitOnThreadWithDefaultTimeout);
DECL_SUPPORT_FLAG(HcommChannelNotifyWaitOnThreadWithDefaultTimeout);
DECL_SUPPORT_FLAG(HcommChannelNotifyWaitWithDefaultTimeout);
int32_t HcclHcommBatchTransferOnThread(ThreadHandle thread, ChannelHandle channel,
const HcclHcommBatchTransferDesc *transferDescs, uint32_t transferDescNum);
bool IsHcommDefaultTimeoutSupported();
HcclResult HcclSetNotifyWaitTimeOut(uint32_t timeout);
HcclResult HcclThreadResAcquireTimeOut(uint32_t timeout);
HcclResult HcclThreadNotifyWaitOnThreadDefault(ThreadHandle thread, uint32_t notifyIdx, uint32_t fallbackTimeout);
HcclResult HcclChannelNotifyWaitOnThreadDefault(ThreadHandle thread, ChannelHandle channel,
uint32_t localNotifyIdx, uint32_t fallbackTimeout);
HcclResult HcclChannelNotifyWaitDefault(ChannelHandle channel, uint32_t localNotifyIdx, uint32_t fallbackTimeout);
void HcommPrimitivesDlInit(void* libHcommHandle);
#ifdef __cplusplus
}
#endif
#endif