NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
NOTES
SEE ALSO
pmempool_syncU()/pmempool_syncW(), pmempool_transformU()/pmempool_transformW() - pool set synchronization and transformation
#include <libpmempool.h>
int pmempool_syncU(const char *poolset_file,
unsigned flags); (EXPERIMENTAL)
int pmempool_syncW(const wchar_t *poolset_file,
unsigned flags); (EXPERIMENTAL)
int pmempool_transformU(const char *poolset_file_src,
const char *poolset_file_dst, unsigned flags); (EXPERIMENTAL)
int pmempool_transformW(const wchar_t *poolset_file_src,
const wchar_t *poolset_file_dst, unsigned flags); (EXPERIMENTAL)
NOTE: The PMDK API supports UNICODE. If the PMDK_UTF8_API macro is defined, basic API functions are expanded to the UTF-8 API with postfix U. Otherwise they are expanded to the UNICODE API with postfix W.
The pmempool_syncU()/pmempool_syncW() function synchronizes data between replicas within a pool set.
pmempool_syncU()/pmempool_syncW() accepts two arguments:
poolset_file - a path to a pool set file,
flags - a combination of flags (ORed) which modify how synchronization is performed.
NOTE: Only the pool set file used to create the pool should be used for syncing the pool.
The following flags are available:
pmempool_syncU()/pmempool_syncW() checks that the metadata of all replicas in a pool set is consistent, i.e. all parts are healthy, and if any of them is not, the corrupted or missing parts are recreated and filled with data from one of the healthy replicas.
pmempool_transformU()/pmempool_transformW() modifies the internal structure of a pool set. It supports the following operations:
adding one or more replicas,
removing one or more replicas_WINUX(.,,
adding or removing pool set options.)
Only one of the above operations can be performed at a time.
pmempool_transformU()/pmempool_transformW() accepts three arguments:
poolset_file_src - pathname of the pool set file for the source pool set to be changed,
poolset_file_dst - pathname of the pool set file that defines the new structure of the pool set,
flags - a combination of flags (ORed) which modify how synchronization is performed.
The following flags are available:
When adding or deleting replicas, the two pool set files can differ only in the definitions of replicas which are to be added or deleted. One cannot add and remove replicas in the same step. Only one of these operations can be performed at a time. Reordering replicas is not supported. Also, to add a replica it is necessary for its effective size to match or exceed the pool size. Otherwise the whole operation fails and no changes are applied. The effective size of a replica is the sum of sizes of all its part files decreased by 4096 bytes per each part file. The 4096 bytes of each part file is utilized for storing internal metadata of the pool part files.
pmempool_syncU()/pmempool_syncW() and pmempool_transformU()/pmempool_transformW() return 0 on success. Otherwise, they return -1 and set errno appropriately.
The pmempool_syncU()/pmempool_syncW() API is experimental and it may change in future versions of the library.
The pmempool_transformU()/pmempool_transformW() API is experimental and it may change in future versions of the library.
libpmemlog(7), libpmemobj(7) and http://pmem.io