Man page - pmem2_source_device_id(3)
Packages contains this manual
- pmem2_get_memset_fn(3)
- pmem2_map_delete(3)
- pmem2_source_get_fd(3)
- pmem2_vm_reservation_map_find_prev(3)
- pmem2_source_from_handle(3)
- pmem2_vm_reservation_get_address(3)
- pmem2_config_set_vm_reservation(3)
- pmem2_source_device_id(3)
- pmem2_badblock_clear(3)
- pmem2_async(3)
- pmem2_vm_reservation_map_find_first(3)
- pmem2_vm_reservation_map_find_last(3)
- pmem2_map_from_existing(3)
- pmem2_config_new(3)
- pmem2_badblock_context_new(3)
- pmem2_deep_flush(3)
- pmem2_memcpy_async(3)
- pmem2_source_delete(3)
- pmem2_source_pread_mcsafe(3)
- pmem2_vm_reservation_extend(3)
- pmem2_source_alignment(3)
- pmem2_config_set_sharing(3)
- pmem2_badblock_next(3)
- pmem2_badblock_context_delete(3)
- pmem2_source_numa_node(3)
- pmem2_vm_reservation_shrink(3)
- pmem2_config_set_length(3)
- pmem2_source_size(3)
- pmem2_vm_reservation_map_find_next(3)
- pmem2_vm_reservation_new(3)
- pmem2_map_get_size(3)
- pmem2_config_set_required_store_granularity(3)
- pmem2_source_from_fd(3)
- pmem2_get_memmove_fn(3)
- pmem2_get_flush_fn(3)
- pmem2_vm_reservation_get_size(3)
- pmem2_memset_async(3)
- pmem2_map_get_address(3)
- pmem2_get_drain_fn(3)
- pmem2_memmove_async(3)
- pmem2_perror(3)
- pmem2_errormsg(3)
- pmem2_config_set_protection(3)
- pmem2_source_device_usc(3)
- pmem2_config_delete(3)
- pmem2_config_set_vdm(3)
- pmem2_get_persist_fn(3)
- pmem2_vm_reservation_delete(3)
- pmem2_map_new(3)
- pmem2_source_from_anon(3)
- libpmem2_unsafe_shutdown(7)
- pmem2_source_get_handle(3)
- pmem2_vm_reservation_map_find(3)
- pmem2_get_memcpy_fn(3)
- libpmem2(7)
- pmem2_config_set_offset(3)
- pmem2_source_pwrite_mcsafe(3)
- pmem2_map_get_store_granularity(3)
apt-get install libpmem2-dev
Manual
NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
ERRORS
SEE ALSO
NAME
pmem2_source_device_id () - returns the unique identifier of a device
SYNOPSIS
#include <libpmem2.h> struct pmem2_source; int pmem2_source_device_id(const struct pmem2_source *source, char *id, size_t *len);
DESCRIPTION
The pmem2_source_device_id () function retrieves a unique identifier of all NVDIMMs backing the data source. This function has two operating modes:
|
• |
if *id is NULL the function calculates a buffer length required for storing the identifier of the *source device and puts this length in *len The more hardware devices back the data source, the longer the length is. |
||
|
• |
if *id is not NULL it must point to a buffer of length *len provided by the previous call to this function. On success, pmem2_source_device_id () will store a unique identifier of all hardware devices backing the data source. |
For details on how to use the unique identifier for detecting the unsafe shutdown please refer to libpmem2_unsafe_shutdown (7) manual page.
RETURN VALUE
The pmem2_source_device_id () function returns 0 on success. If the function fails, the *id and *len variables contents are left unmodified and a negative error code is returned.
ERRORS
The pmem2_source_device_id () can fail with the following errors:
On all systems:
|
• |
PMEM2_E_BUFFER_TOO_SMALL - the provided buffer of length *len is too small to store the full identifier of the backing devices. |
||
|
• |
PMEM2_E_NOSUPP - the underlying platform does not expose hardware identification. |
On Windows:
|
• |
- errno equivalent of return code set by failing GetFinalPathNameByHandleW (), while trying to resolve the volume path from the file handle. |
||
|
• |
- errno set by failing malloc (3), while trying to allocate a buffer for storing volume path. |
||
|
• |
- errno equivalent of return code set by failing CreateFileW (), while trying to obtain a handle to the volume. |
||
|
• |
- errno equivalent of return code set by failing DeviceIoControl (), while trying to obtain volume USC value. |
On Linux:
|
• |
- errno set by failing fstat (2), while trying to validate the file descriptor. |
||
|
• |
- errno set by failing ndctl_new (), while trying to initiate a new NDCTL library context. |
SEE ALSO
fstat (2), errno (3), malloc (3), libpmem2_unsafe_shutdown (7), and <https://pmem.io>