OpenFAM Reference Implementation

openfam::fam::fam_deallocate

Deallocate space being used by a data item in a region of FAM.

Synopsis

void fam_deallocate(Fam_Descriptor *descriptor);

Description

This method triggers a deallocation of previously allocated space for a data item in some region of FAM.

Input Arguments

NameDescription
DescriptorDescriptor associated with the space to deallocate.

 

Return Values

None. Throws an exception on error.

Exceptions

ExceptionDescription
FAM_ERR_NOPERMCaller does not have access rights
FAM_ERR_ALREADYEXISTthe data item name is already present in FAM
FAM_ERR_GRPCthere is a communication error with memory server
FAM_ERR_RPC_CLIENT_NOTFOUNDMemory server initialization failure

Notes

Note that if a descriptor is used to access deallocated space, behaviour of the library is implementation dependent. The implementation may reclaim space some indeterminate amount of time after the method is called, to permit other PEs currently using the data item to finish.

Example

See fam_allocate