pmem2 API version 1.0

The PMDK repository on GitHub is the ultimate source of information on PMDK from release 2.0! For all questions and to submit eventual issues please follow to that repository. The PMDK documentation collected here should be valid up to the 1.13.1 release but is maintained only on a best-effort basis and may not reflect the latest state of the art.

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
ERRORS
SEE ALSO

NAME

pmem2_map_delete() - deletes a mapping

SYNOPSIS

#include <libpmem2.h>

int pmem2_map_delete(struct pmem2_map **map_ptr);

DESCRIPTION

The pmem2_map_delete() function deletes the mapping described by the struct pmem2_map object.

If pmem2_map_delete() succeeds in deleting the mapping, it releases the struct pmem2_map object describing it and writes a NULL value to map_ptr. If the function fails, the map_ptr variable and the map object itself are left unmodified and appropriate error value is returned. For a list of possible return values please see RETURN VALUE.

The pmem2_map_delete() function will not unmap mapping provided by the user by pmem2_map_from_existing() function. In such case it will only free struct pmem2_map object.

RETURN VALUE

The pmem2_map_delete() function returns 0 on success or a negative error code on failure.

ERRORS

The pmem2_map_delete() can fail with the following errors:

  • PMEM2_E_MAPPING_NOT_FOUND - mapping was not found (it was already unmapped or pmem2_map state was corrupted)

  • -EINVAL - from the underlying munmap(2) function.

SEE ALSO

pmem2_map_new(3), libpmem2(7) and https://pmem.io

The contents of this web site and the associated GitHub repositories are BSD-licensed open source.