librpmem

NAME
SYNOPSIS
DESCRIPTION
MOST COMMONLY USED FUNCTIONS
LIBRARY API VERSIONING
DEBUGGING AND ERROR HANDLING
ENVIRONMENT VARIABLES
EXAMPLES
ACKNOWLEDGEMENTS
SEE ALSO

NAME

librpmem − remote persistent memory library

SYNOPSIS

#include <librpmem.h>

cc ... -lrpmem

Most commonly used functions:

RPMEMpool *rpmem_create(const char *target, const char *pool_set_name,

void *pool_addr, size_t pool_size, unsigned *nlanes,

const struct rpmem_pool_attr *create_attr);

RPMEMpool *rpmem_open(const char *target, const char *pool_set_name,

void *pool_addr, size_t pool_size, unsigned *nlanes,

struct rpmem_pool_attr *create_attr);

int rpmem_remove(const char *target, const char *pool_set_name);
int rpmem_close(RPMEMpool *
rpp);
int rpmem_persist(RPMEMpool *
rpp, size_t offset, size_t length, unsigned lane);
int rpmem_read(RPMEMpool *
rpp, void *buff, size_t offset, size_t length);

Library API versioning:

const char *rpmem_check_version(
unsigned
major_required,
unsigned
minor_required);

Error handling:

const char *rpmem_errormsg(void);

DESCRIPTION

XXX

MOST COMMONLY USED FUNCTIONS

XXX

LIBRARY API VERSIONING

XXX

DEBUGGING AND ERROR HANDLING

XXX

ENVIRONMENT VARIABLES

XXX

EXAMPLES

XXX

ACKNOWLEDGEMENTS

librpmem builds on the persistent memory programming model recommended by the SNIA NVM Programming Technical Work Group:

http://snia.org/nvmp

SEE ALSO

libpmem(3), libpmemobj(3), libpmemblk(3), libpmemlog(3), and http://pmem.io.