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
| Name | Description |
| descriptor | Descriptor associated with the space to deallocate. |
Return Values
None. Throws Fam_Exception on error.
Fam Error Numbers
| Error | Description |
|---|---|
| FAM_ERR_NOPERM | Caller does not have access rights |
| FAM_ERR_NOTFOUND | Data item name is not present in FAM |
| FAM_ERR_RPC | Communication error from grpc layer. |
| FAM_ERR_RPC_CLIENT_NOTFOUND | RPC service not available. |
| FAM_ERR_METADATA | Metadata service error. |
| FAM_ERR_MEMORY | Memory service error. |
| FAM_ERR_RESOURCE | Resource not available. |
Notes
Note that if a descriptor is used to access deallocated space, behavior of the library is implementation dependent. The implementation may reclaim space some indeterminate amount of time after the method is called, to perform a memset operation to zero deallocated memory space.
Example
See fam_allocate