HixlCSClientRegMem

Function Description

Registers the local memory for the client.

Prototype

HixlStatus HixlCSClientRegMem(HixlClientHandle client_handle,
                              const char *mem_tag,
                              const CommMem *mem,
                              MemHandle *mem_handle);

Parameters

Parameter	Input/Output	Description
client_handle	Input	Client handle.
mem_tag	Input	Memory tag string.
mem	Input	CommMem description.
mem_handle	Output	Returned memory handle.

Returns

HIXL_SUCCESS: Success.
HIXL_PARAM_INVALID: Incorrect parameter.
Other values: Failure.

Constraints

Before calling HixlCSClientConnect to establish a link with the server, register all local memories.
If you use the host RoCE NIC, the memory allocated by aclrtMallocHost cannot be registered. Use the malloc method instead.
Allocate device memory using aclrtMalloc for registration.

Parent topic: API Description