HcommMemImport

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

Imports the memory description exported by the remote end to obtain the corresponding memory description information on the local end.

Prototype

HcommResult HcommMemImport(EndpointHandle endpointHandle, const void *memDesc, uint32_t descLen, CommMem *outMem)

Parameters

Parameter	Input/Output	Description
endpointHandle	Input	Endpoint handle. For details, see EndpointHandle.
memDesc	Input	Pointer to the description.
memDescLen	Input	Length of the description.
outMem	Output	Metadata descriptor of the memory segment. For details, see CommMem.

Returns

HcommResult: 0 on success; else, failure.

Restrictions

None

Example

// Operations on the export end.
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);

// Operations on the import end.
CommMem mem;
result = HcommMemImport(endpointHandle, memDesc, memDescLen, &mem);

Parent topic: Basic Resource Management