OpenFAM Reference Implementation

openfam::fam::fam_unmap

Unmap a data item in FAM from the process virtual address space.

Synopsis

void fam_unmap(void *local, Fam_Descriptor *descriptor);

Description

This method unmaps a data item in FAM from the process virtual address space.

Input Arguments

NameDescription
local Local pointer to be unmapped.
descriptor Descriptor associated with the data item in FAM to be unmapped.

Return Values

None. Throws Fam_Exception on error.

Fam Error Numbers

ErrorDescription
FAM_ERR_INVALIDAPI called with incorrect parameters.
FAM_ERR_UNIMPLCalling unimplemented functions/APIs.
FAM_ERR_NOPERMCaller does not have access rights
FAM_ERR_LIBFABRICLibfabric error occurred.
FAM_ERR_NOTFOUNDItem not found in the region.
FAM_ERR_RPC_CLIENT_NOTFOUNDRPC service not available.
FAM_ERR_METADATAMetadata service error.
FAM_ERR_MEMORYMemory service error.
FAM_ERR_RESOURCEResource not available.

Notes

fam_map() and fam_unmap()are currently only supported in the scale-up (shared memory) configuration of the OpenFAM reference implementation.

Example

See example under fam_map