📦 pmdk-devel-doc

348 pages · page 1 of 2

D

d_ro(3)libpmemobj type safety mechanism✨
d_rw(3)libpmemobj type safety mechanism✨
direct_ro(3)libpmemobj type safety mechanism✨
direct_rw(3)libpmemobj type safety mechanism✨

L

libpmem(7)persistent memory support library✨
libpmem2(7)persistent memory support library✨
libpmem2_unsafe_shutdown(7)libpmem2 unsafe shutdown✨
libpmemblk(7)persistent memory resident array of blocks (DEPRECATED) NOTE: Support for Windows and FreeBSD deprecated since PMDK 1.13.0 release and will be removed in the PMDK 1.14.0 release.✨
libpmemlog(7)persistent memory resident log file (DEPRECATED) NOTE: Support for Windows and FreeBSD deprecated since PMDK 1.13.0 release and will be removed in the PMDK 1.14.0 release.✨
libpmemobj(7)persistent memory transactional object store✨
libpmempool(7)persistent memory pool management library✨
librpmem(7)remote persistent memory support library (EXPERIMENTAL)✨

O

oid_equals(3)functions that allow mapping operations between object addresses, object handles, oids or type numbers✨
oid_instanceof(3)libpmemobj type safety mechanism✨
oid_is_null(3)functions that allow mapping operations between object addresses, object handles, oids or type numbers✨

P

pmem2_badblock_clear(3)clear the given bad block✨
pmem2_badblock_context_delete(3)allocate and free a context for pmem2_badblock_next() and pmem2_badblock_clear() operations✨
pmem2_badblock_context_new(3)allocate and free a context for pmem2_badblock_next() and pmem2_badblock_clear() operations✨
pmem2_badblock_next(3)read the next bad block for the given bad block context *bbctx.✨
pmem2_config_delete(3)allocate and free a configuration structure for a libpmem2 mapping✨
pmem2_config_new(3)allocate and free a configuration structure for a libpmem2 mapping✨
pmem2_config_set_length(3)set length in the pmem2_config structure✨
pmem2_config_set_offset(3)set offset in the pmem2_config structure✨
pmem2_config_set_protection(3)set a protection flags in pmem2_config structure.✨
pmem2_config_set_required_store_granularity(3)set a granularity in pmem2_config structure.✨
pmem2_config_set_sharing(3)set sharing in the pmem2_config structure✨
pmem2_config_set_vm_reservation(3)sets the pmem2_vm_reservation structure basing on the values in the pmem2_config structure✨
pmem2_deep_flush(3)highly reliable persistent memory synchronization✨
pmem2_errormsg(3)returns last error message✨
pmem2_get_drain_fn(3)get a drain function✨
pmem2_get_flush_fn(3)get a flush function✨
pmem2_get_memcpy_fn(3)get a function that provides optimized copying to persistent memory✨
pmem2_get_memmove_fn(3)get a function that provides optimized copying to persistent memory✨
pmem2_get_memset_fn(3)get a function that provides optimized copying to persistent memory✨
pmem2_get_persist_fn(3)get a persist function✨
pmem2_map_delete(3)deletes a mapping✨
pmem2_map_from_existing(3)creates a pmem2_map object from an existing mapping✨
pmem2_map_get_address(3)reads mapping address✨
pmem2_map_get_size(3)reads mapping size✨
pmem2_map_get_store_granularity(3)reads effective mapping granularity✨
pmem2_map_new(3)creates a mapping✨
pmem2_perror(3)prints a descriptive error message to stderr✨
pmem2_source_alignment(3)returns data source alignment✨
pmem2_source_delete(3)creates or deletes an instance of persistent memory data source✨
pmem2_source_device_id(3)returns the unique identifier of a device✨
pmem2_source_device_usc(3)returns the unsafe shutdown counter value of a device✨
pmem2_source_from_anon(3)creates data source backed by anonymous memory pages✨
pmem2_source_from_fd(3)creates or deletes an instance of persistent memory data source✨
pmem2_source_from_handle(3)creates or deletes an instance of persistent memory data source✨
pmem2_source_get_fd(3)reads file descriptor of the data source✨
pmem2_source_get_handle(3)reads file handler of the data source✨
pmem2_source_numa_node(3)returns data source numa node✨
pmem2_source_size(3)returns the size of the data source✨
pmem2_vm_reservation_delete(3)creates or deletes an instance of virtual memory reservation✨
pmem2_vm_reservation_extend(3)extends and shrinks existing virtual memory reservation✨
pmem2_vm_reservation_get_address(3)reads address of the virtual memory reservation✨
pmem2_vm_reservation_get_size(3)reads virtual memory reservation size✨
pmem2_vm_reservation_map_find(3)search for the mapping located at the desirable location✨
pmem2_vm_reservation_map_find_first(3)search for the mapping located at the desirable location✨
pmem2_vm_reservation_map_find_last(3)search for the mapping located at the desirable location✨
pmem2_vm_reservation_map_find_next(3)search for the mapping located at the desirable location✨
pmem2_vm_reservation_map_find_prev(3)search for the mapping located at the desirable location✨
pmem2_vm_reservation_new(3)creates or deletes an instance of virtual memory reservation✨
pmem2_vm_reservation_shrink(3)extends and shrinks existing virtual memory reservation✨
pmem_check_version(3)persistent memory support library✨
pmem_deep_drain(3)check persistency, store persistent data and delete mappings✨
pmem_deep_flush(3)check persistency, store persistent data and delete mappings✨
pmem_deep_persist(3)check persistency, store persistent data and delete mappings✨
pmem_drain(3)check persistency, store persistent data and delete mappings✨
pmem_errormsg(3)persistent memory support library✨
pmem_flush(3)check persistency, store persistent data and delete mappings✨
pmem_has_auto_flush(3)check persistency, store persistent data and delete mappings✨
pmem_has_hw_drain(3)check persistency, store persistent data and delete mappings✨
pmem_is_pmem(3)check persistency, create and delete mappings✨
pmem_map_file(3)check persistency, create and delete mappings✨
pmem_memcpy(3)functions that provide optimized copying to persistent memory✨
pmem_memcpy_nodrain(3)functions that provide optimized copying to persistent memory✨
pmem_memcpy_persist(3)functions that provide optimized copying to persistent memory✨
pmem_memmove(3)functions that provide optimized copying to persistent memory✨
pmem_memmove_nodrain(3)functions that provide optimized copying to persistent memory✨
pmem_memmove_persist(3)functions that provide optimized copying to persistent memory✨
pmem_memset(3)functions that provide optimized copying to persistent memory✨
pmem_memset_nodrain(3)functions that provide optimized copying to persistent memory✨
pmem_memset_persist(3)functions that provide optimized copying to persistent memory✨
pmem_msync(3)check persistency, store persistent data and delete mappings✨
pmem_persist(3)check persistency, store persistent data and delete mappings✨
pmem_unmap(3)check persistency, create and delete mappings✨
pmemblk_bsize(3)check number of available blocks or usable space in block memory pool✨
pmemblk_check(3)create, open, close and validate block pool✨
pmemblk_check_version(3)persistent memory resident array of blocks (DEPRECATED) NOTE: Support for Windows and FreeBSD deprecated since PMDK 1.13.0 release and will be removed in the PMDK 1.14.0 release.✨
pmemblk_close(3)create, open, close and validate block pool✨
pmemblk_create(3)create, open, close and validate block pool✨
pmemblk_ctl_exec(3)Query and modify libpmemblk internal behav‐ ior (EXPERIMENTAL)✨
pmemblk_ctl_get(3)Query and modify libpmemblk internal behav‐ ior (EXPERIMENTAL)✨
pmemblk_ctl_set(3)Query and modify libpmemblk internal behav‐ ior (EXPERIMENTAL)✨
pmemblk_errormsg(3)persistent memory resident array of blocks (DEPRECATED) NOTE: Support for Windows and FreeBSD deprecated since PMDK 1.13.0 release and will be removed in the PMDK 1.14.0 release.✨
pmemblk_nblock(3)check number of available blocks or usable space in block memory pool✨
pmemblk_open(3)create, open, close and validate block pool✨
pmemblk_read(3)read or write a block from a block memory pool✨
pmemblk_set_error(3)block management functions✨
pmemblk_set_funcs(3)persistent memory resident array of blocks (DEPRECATED) NOTE: Support for Windows and FreeBSD deprecated since PMDK 1.13.0 release and will be removed in the PMDK 1.14.0 release.✨
pmemblk_set_zero(3)block management functions✨
pmemblk_write(3)read or write a block from a block memory pool✨
pmemlog_append(3)append bytes to the persistent memory resident log file✨
pmemlog_appendv(3)append bytes to the persistent memory resident log file✨
pmemlog_check(3)create, open, close and validate persistent memory resident log file✨
pmemlog_check_version(3)persistent memory resident log file (DEPRECATED) NOTE: Support for Windows and FreeBSD deprecated since PMDK 1.13.0 release and will be removed in the PMDK 1.14.0 release.✨
pmemlog_close(3)create, open, close and validate persistent memory resident log file✨
pmemlog_create(3)create, open, close and validate persistent memory resident log file✨
pmemlog_ctl_exec(3)Query and modify libpmemlog internal behav‐ ior (DEPRECATED)✨
pmemlog_ctl_get(3)Query and modify libpmemlog internal behav‐ ior (DEPRECATED)✨
pmemlog_ctl_set(3)Query and modify libpmemlog internal behav‐ ior (DEPRECATED)✨
pmemlog_errormsg(3)persistent memory resident log file (DEPRECATED) NOTE: Support for Windows and FreeBSD deprecated since PMDK 1.13.0 release and will be removed in the PMDK 1.14.0 release.✨
pmemlog_nbyte(3)checks the amount of usable space in the log pool.✨
pmemlog_open(3)create, open, close and validate persistent memory resident log file✨
pmemlog_rewind(3)checks current write point for the log or walks through the log✨
pmemlog_set_funcs(3)persistent memory resident log file (DEPRECATED) NOTE: Support for Windows and FreeBSD deprecated since PMDK 1.13.0 release and will be removed in the PMDK 1.14.0 release.✨
pmemlog_tell(3)checks current write point for the log or walks through the log✨
pmemlog_walk(3)checks current write point for the log or walks through the log✨
pmemobj_action(3)Delayed atomicity actions (EXPERIMENTAL)✨
pmemobj_alloc(3)non-transactional atomic allocations✨
pmemobj_alloc_usable_size(3)non-transactional atomic allocations✨
pmemobj_cancel(3)Delayed atomicity actions (EXPERIMENTAL)✨
pmemobj_check(3)create, open, close and validate persistent memory transactional object store✨
pmemobj_check_version(3)persistent memory transactional object store✨
pmemobj_close(3)create, open, close and validate persistent memory transactional object store✨
pmemobj_cond_broadcast(3)pmemobj synchronization primitives✨
pmemobj_cond_signal(3)pmemobj synchronization primitives✨
pmemobj_cond_timedwait(3)pmemobj synchronization primitives✨
pmemobj_cond_wait(3)pmemobj synchronization primitives✨
pmemobj_cond_zero(3)pmemobj synchronization primitives✨
pmemobj_create(3)create, open, close and validate persistent memory transactional object store✨
pmemobj_ctl_exec(3)Query and modify libpmemobj internal behavior (EXPERIMENTAL)✨
pmemobj_ctl_get(3)Query and modify libpmemobj internal behavior (EXPERIMENTAL)✨
pmemobj_ctl_set(3)Query and modify libpmemobj internal behavior (EXPERIMENTAL)✨
pmemobj_defer_free(3)Delayed atomicity actions (EXPERIMENTAL)✨
pmemobj_defrag(3)non-transactional atomic allocations✨
pmemobj_direct(3)functions that allow mapping operations between object addresses, object handles, oids or type numbers✨
pmemobj_drain(3)low-level memory manipulation functions✨
pmemobj_errormsg(3)persistent memory transactional object store✨
pmemobj_f_mem_nodrain(3)low-level memory manipulation functions✨
pmemobj_f_mem_noflush(3)low-level memory manipulation functions✨
pmemobj_f_mem_nontemporal(3)low-level memory manipulation functions✨
pmemobj_f_mem_temporal(3)low-level memory manipulation functions✨
pmemobj_f_mem_wb(3)low-level memory manipulation functions✨
pmemobj_f_mem_wc(3)low-level memory manipulation functions✨
pmemobj_f_relaxed(3)low-level memory manipulation functions✨
pmemobj_first(3)pmemobj container operations✨
pmemobj_flush(3)low-level memory manipulation functions✨
pmemobj_free(3)non-transactional atomic allocations✨
pmemobj_get_user_data(3)create, open, close and validate persistent memory transactional object store✨
pmemobj_list_insert(3)non-transactional persistent atomic lists functions✨
pmemobj_list_insert_new(3)non-transactional persistent atomic lists functions✨
pmemobj_list_move(3)non-transactional persistent atomic lists functions✨
pmemobj_list_remove(3)non-transactional persistent atomic lists functions✨
pmemobj_memcpy(3)low-level memory manipulation functions✨
pmemobj_memcpy_persist(3)low-level memory manipulation functions✨
pmemobj_memmove(3)low-level memory manipulation functions✨
pmemobj_memset(3)low-level memory manipulation functions✨
pmemobj_memset_persist(3)low-level memory manipulation functions✨
pmemobj_mutex_lock(3)pmemobj synchronization primitives✨
pmemobj_mutex_timedlock(3)pmemobj synchronization primitives✨
pmemobj_mutex_trylock(3)pmemobj synchronization primitives✨
pmemobj_mutex_unlock(3)pmemobj synchronization primitives✨
pmemobj_mutex_zero(3)pmemobj synchronization primitives✨
pmemobj_next(3)pmemobj container operations✨
pmemobj_oid(3)functions that allow mapping operations between object addresses, object handles, oids or type numbers✨
pmemobj_open(3)create, open, close and validate persistent memory transactional object store✨
pmemobj_persist(3)low-level memory manipulation functions✨
pmemobj_pool_by_oid(3)functions that allow mapping operations between object addresses, object handles, oids or type numbers✨
pmemobj_pool_by_ptr(3)functions that allow mapping operations between object addresses, object handles, oids or type numbers✨
pmemobj_publish(3)Delayed atomicity actions (EXPERIMENTAL)✨
pmemobj_realloc(3)non-transactional atomic allocations✨
pmemobj_reserve(3)Delayed atomicity actions (EXPERIMENTAL)✨
pmemobj_root(3)root object management✨
pmemobj_root_construct(3)root object management✨
pmemobj_root_size(3)root object management✨
pmemobj_rwlock_rdlock(3)pmemobj synchronization primitives✨
pmemobj_rwlock_timedrdlock(3)pmemobj synchronization primitives✨
pmemobj_rwlock_timedwrlock(3)pmemobj synchronization primitives✨
pmemobj_rwlock_tryrdlock(3)pmemobj synchronization primitives✨
pmemobj_rwlock_trywrlock(3)pmemobj synchronization primitives✨
pmemobj_rwlock_unlock(3)pmemobj synchronization primitives✨
pmemobj_rwlock_wrlock(3)pmemobj synchronization primitives✨
pmemobj_rwlock_zero(3)pmemobj synchronization primitives✨
pmemobj_set_funcs(3)persistent memory transactional object store✨
pmemobj_set_user_data(3)create, open, close and validate persistent memory transactional object store✨
pmemobj_set_value(3)Delayed atomicity actions (EXPERIMENTAL)✨
pmemobj_strdup(3)non-transactional atomic allocations✨
pmemobj_tx_abort(3)transactional object manipulation✨
pmemobj_tx_add_range(3)transactional object manipulation✨
pmemobj_tx_add_range_direct(3)transactional object manipulation✨
pmemobj_tx_alloc(3)transactional object manipulation✨
pmemobj_tx_begin(3)transactional object manipulation✨
pmemobj_tx_commit(3)transactional object manipulation✨
pmemobj_tx_end(3)transactional object manipulation✨
pmemobj_tx_errno(3)transactional object manipulation✨
pmemobj_tx_free(3)transactional object manipulation✨
pmemobj_tx_get_failure_behavior(3)transactional object manipulation✨
pmemobj_tx_get_user_data(3)transactional object manipulation✨