plucky (3) pmem2_config_set_sharing.3.gz

NAME

       pmem2_config_set_sharing() - set sharing in the pmem2_config structure

SYNOPSIS

              #include <libpmem2.h>

              struct pmem2_config;
              enum pmem2_sharing_type {
                  PMEM2_SHARED,
                  PMEM2_PRIVATE,
              };
              int pmem2_config_set_sharing(struct pmem2_config *config, enum pmem2_sharing_type sharing);

DESCRIPTION

       The pmem2_config_set_sharing() function configures the behavior and visibility of writes to the mapping’s
       pages.  The possible values are listed below:

       • PMEM2_SHARED - Writes are made directly to the underlying memory, making them visible to other mappings
         of the same memory region.  (default)

       • PMEM2_PRIVATE - Writes do not affect the underlying memory and are not visible to other mappings of the
         same memory region.

RETURN VALUE

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

ERRORRS

       The pmem2_config_set_sharing() can fail with the following errors:

       • PMEM2_E_INVALID_SHARING_VALUE - sharing value is invalid.

SEE ALSO

       libpmem2(7), pmem2_config_new(3), pmem2_map_new(3), sysconf(3) and <https://pmem.io>