Man page - pmem2_source_size(3)

Packages contains this manual

Package:  libpmem2-dev
apt-get install libpmem2-dev

Manuals in package:
• 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)
Documentations in package:
• libpmem2-dev

Manual

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
ERRORS
SEE ALSO

---

NAME

pmem2_source_size () - returns the size of the data source

SYNOPSIS

#include <libpmem2.h>


struct pmem2_source;
int pmem2_source_size(const struct pmem2_source *source, size_t *size);

DESCRIPTION

The pmem2_source_size () function retrieves the size of the file in bytes pointed by file descriptor or handle stored in the source and puts it in *size .

This function is a portable replacement for OS-specific APIs. On Linux, it hides the quirkiness of Device DAX size detection.

RETURN VALUE

The pmem2_source_size () function returns 0 on success. If the function fails, the *size variable is left unmodified and a negative error code is returned.

ERRORS

The pmem2_source_size () can fail with the following errors:

On all systems:

•

PMEM2_E_INVALID_FILE_HANDLE - source contains an invalid file handle.

On Windows:

•

PMEM2_E_INVALID_FILE_TYPE - handle points to a resource that is not a regular file.

On Linux:

	•		PMEM2_E_INVALID_FILE_TYPE - file descriptor points to a directory, block device, pipe, or socket.
	•		PMEM2_E_INVALID_FILE_TYPE - file descriptor points to a character device other than Device DAX.
	•		PMEM2_E_INVALID_SIZE_FORMAT - kernel query for Device DAX size returned data in invalid format.
	•		- errno set by failing fstat (2), while trying to validate the file descriptor.
	•		- errno set by failing realpath (3), while trying to determine whether fd points to a Device DAX.
	•		- errno set by failing open (2), while trying to determine Device DAX’s size.
	•		- errno set by failing read (2), while trying to determine Device DAX’s size.
	•		- errno set by failing strtoull (3), while trying to determine Device DAX’s size.

On FreeBSD:

	•		PMEM2_E_INVALID_FILE_TYPE - file descriptor points to a directory, block device, pipe, socket, or character device.
	•		- errno set by failing fstat (2), while trying to validate the file descriptor.

SEE ALSO

errno (3), fstat (2), realpath (3), open (2), read (2), strtoull (3), pmem2_config_new (3), libpmem2 (7) and <https://pmem.io>

---