HcommMemExport

Applicability

Product	Supported
Atlas 350 Accelerator Card	√
Atlas A3 training product/Atlas A3 inference product	x
Atlas A2 training product/Atlas A2 inference product	x
Atlas 200I/500 A2 inference product	x
Atlas inference product	x
Atlas training product	x

Function

Exports the specified memory description for exchange after the memory is registered.

Prototype

HcommResult HcommMemExport(EndpointHandle endpointHandle, void* memHandle, void** memDesc, uint32_t* memDescLen)

Parameters

Parameter	Input/Output	Description
endpointHandle	Input	Endpoint handle. For details, see EndpointHandle.
memHandle	Input	Registered memory handle.
memDesc	Output	Pointer to the returned description.
memDescLen	Output	Length of the returned description.

Returns

HcommResult: 0 on success; else, failure.

Restrictions

None

Example

const EndpointDesc endpointDesc = {
    .protocol = COMM_PROTOCOL_ROCE,
    .commAddr = {
        .type = COMM_ADDR_TYPE_IP_V4,
        .addr = {{192, 168, 1, 100}}
    },
    .loc = {
        .locType = ENDPOINT_LOC_TYPE_DEVICE,
        .device = {
            .devPhyId = 0,
            .superDevId = 0,
            .serverIdx = 0,
            .superPodIdx = 0
        }
    },
    .raws = {0}
};
EndpointHandle endpointHandle = nullptr;
HcommResult result = HcommEndpointCreate(&endpointDesc, &endpointHandle);
const char *memTag = "HcclBuffer";
CommMem mem = {
    .type = COMM_MEM_TYPE_DEVICE,
    .addr = reinterpret_cast<void*>(0x1111),
    .size = 100
};
HcommMemHandle memHandle;
result = HcommMemReg(endpointHandle, memTag, &mem, &memHandle);

uint32_t* memDescLen;
void* memDesc = nullptr;
result = HcommMemExport(endpointHandle, memHandle, memDesc, memDescLen);

Parent topic: Basic Resource Management