dacs_remote_mem_query

NAME

dacs_remote_mem_query - Query the attributes of a remote memory region.

SYNOPSIS

DACS_ERR_T dacs_remote_mem_query ( dacs_remote_mem_t mem, DACS_REMOTE_MEM_ATTR_T attr, uint64_t *value )

Call parameters  
mem The handle of the remote memory area to query.
attr The attribute to be queried. This may be one of:
  • DACS_REMOTE_MEM_SIZE,
  • DACS_REMOTE_MEM_ADDR, or
  • DACS_REMOTE_MEM_ACCESS_MODE.
Return parameter  
*value A pointer to the location where the attribute value is to be returned. The value returned in this location depends on the attr parameter passed as shown in the following table.
  attr Value returned
  DACS_REMOTE_MEM_ACCESS_MODE
  • DACS_READ_ONLY,
  • DACS_WRITE_ONLY, or
  • DACS_READ_WRITE.
  DACS_REMOTE_MEM_SIZE A uint64_t value indicating the size of the memory region in bytes.
  DACS_REMOTE_MEM_ADDR A uint64_t value indicating the starting virtual address within the creating process of the memory region.

DESCRIPTION

The dacs_remote_mem_query service queries the attributes of the specified remote memory region. The memory region being queried must have been created or accepted by the caller.

RETURN VALUE

The dacs_remote_mem_query service returns an error indicator defined as:
  • DACS_SUCCESS: normal return.
  • DACS_ERR_INVALID_ADDR: the pointer is invalid.
  • DACS_ERR_INVALID_ATTR: the flag or enumerated constant is invalid.
  • DACS_ERR_INVALID_HANDLE: the specified handle is invalid.

SEE ALSO

dacs_remote_mem_create(3), dacs_remote_mem_share(3), dacs_remote_mem_accept(3), dacs_remote_mem_release(3), dacs_remote_mem_destroy(3)
Parent topic: Remote Direct Memory Access (rDMA)