NAME¶

libfsxfs.h — Library to access the X File System (XFS) format

SYNOPSIS¶

#include <libfsxfs.h>

Support functions

const char *


libfsxfs_get_version(
void);

int


libfsxfs_get_access_flags_read(
void);

int


libfsxfs_get_codepage(
int *codepage,
libfsxfs_error_t **error);

int


libfsxfs_set_codepage(
int codepage,
libfsxfs_error_t **error);

int


libfsxfs_check_volume_signature(
const char *filename,
libfsxfs_error_t **error);

Available when compiled with wide character string support:

int


libfsxfs_check_volume_signature_wide(
const wchar_t *filename,
libfsxfs_error_t **error);

Available when compiled with libbfio support:

int


libfsxfs_check_volume_signature_file_io_handle(
libbfio_handle_t *file_io_handle,
libfsxfs_error_t **error);

Notify functions

void


libfsxfs_notify_set_verbose(
int verbose);

int


libfsxfs_notify_set_stream(
FILE *stream,
libfsxfs_error_t **error);

int


libfsxfs_notify_stream_open(
const char *filename,
libfsxfs_error_t **error);

int


libfsxfs_notify_stream_close(
libfsxfs_error_t **error);

Error functions

void


libfsxfs_error_free(
libfsxfs_error_t **error);

int


libfsxfs_error_fprint(
libfsxfs_error_t *error,
FILE *stream);

int


libfsxfs_error_sprint(
libfsxfs_error_t *error,
char *string,
size_t size);

int


libfsxfs_error_backtrace_fprint(
libfsxfs_error_t *error,
FILE *stream);

int


libfsxfs_error_backtrace_sprint(
libfsxfs_error_t *error,
char *string,
size_t size);

Volume functions

int


libfsxfs_volume_initialize(
libfsxfs_volume_t **volume,
libfsxfs_error_t **error);

int


libfsxfs_volume_free(
libfsxfs_volume_t **volume,
libfsxfs_error_t **error);

int


libfsxfs_volume_signal_abort(
libfsxfs_volume_t *volume,
libfsxfs_error_t **error);

int


libfsxfs_volume_open(
libfsxfs_volume_t *volume,
const char *filename,
int access_flags,
libfsxfs_error_t **error);

int


libfsxfs_volume_close(
libfsxfs_volume_t *volume,
libfsxfs_error_t **error);

int


libfsxfs_volume_get_format_version(
libfsxfs_volume_t *volume,
uint8_t *format_version,
libfsxfs_error_t **error);

int


libfsxfs_volume_get_features_flags(
libfsxfs_volume_t *volume,
uint32_t *compatible_features_flags,
uint32_t *read_only_compatible_features_flags,
uint32_t *incompatible_features_flags,
uint32_t *journal_incompatible_features_flags,
libfsxfs_error_t **error);

int


libfsxfs_volume_get_utf8_label_size(
libfsxfs_volume_t *volume,
size_t *utf8_string_size,
libfsxfs_error_t **error);

int


libfsxfs_volume_get_utf8_label(
libfsxfs_volume_t *volume,
uint8_t *utf8_string,
size_t utf8_string_size,
libfsxfs_error_t **error);

int


libfsxfs_volume_get_utf16_label_size(
libfsxfs_volume_t *volume,
size_t *utf16_string_size,
libfsxfs_error_t **error);

int


libfsxfs_volume_get_utf16_label(
libfsxfs_volume_t *volume,
uint16_t *utf16_string,
size_t utf16_string_size,
libfsxfs_error_t **error);

int


libfsxfs_volume_get_root_directory(
libfsxfs_volume_t *volume,
libfsxfs_file_entry_t **file_entry,
libfsxfs_error_t **error);

int


libfsxfs_volume_get_file_entry_by_inode(
libfsxfs_volume_t *volume,
uint64_t inode_number,
libfsxfs_file_entry_t **file_entry,
libfsxfs_error_t **error);

int


libfsxfs_volume_get_file_entry_by_utf8_path(
libfsxfs_volume_t *volume,
const uint8_t *utf8_string,
size_t utf8_string_length,
libfsxfs_file_entry_t **file_entry,
libfsxfs_error_t **error);

int


libfsxfs_volume_get_file_entry_by_utf16_path(
libfsxfs_volume_t *volume,
const uint16_t *utf16_string,
size_t utf16_string_length,
libfsxfs_file_entry_t **file_entry,
libfsxfs_error_t **error);

Available when compiled with wide character string support:

int


libfsxfs_volume_open_wide(
libfsxfs_volume_t *volume,
const wchar_t *filename,
int access_flags,
libfsxfs_error_t **error);

Available when compiled with libbfio support:

int


libfsxfs_volume_open_file_io_handle(
libfsxfs_volume_t *volume,
libbfio_handle_t *file_io_handle,
int access_flags,
libfsxfs_error_t **error);

File entry functions

int


libfsxfs_file_entry_free(
libfsxfs_file_entry_t **file_entry,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_inode_number(
libfsxfs_file_entry_t *file_entry,
uint64_t *inode_number,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_creation_time(
libfsxfs_file_entry_t *file_entry,
int64_t *posix_time,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_modification_time(
libfsxfs_file_entry_t *file_entry,
int64_t *posix_time,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_access_time(
libfsxfs_file_entry_t *file_entry,
int64_t *posix_time,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_inode_change_time(
libfsxfs_file_entry_t *file_entry,
int64_t *posix_time,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_file_mode(
libfsxfs_file_entry_t *file_entry,
uint16_t *file_mode,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_number_of_links(
libfsxfs_file_entry_t *file_entry,
uint32_t *number_of_links,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_owner_identifier(
libfsxfs_file_entry_t *file_entry,
uint32_t *owner_identifier,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_group_identifier(
libfsxfs_file_entry_t *file_entry,
uint32_t *group_identifier,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_device_identifier(
libfsxfs_file_entry_t *file_entry,
uint32_t *device_identifier,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_device_number(
libfsxfs_file_entry_t *file_entry,
uint32_t *major_device_number,
uint32_t *minor_device_number,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_utf8_name_size(
libfsxfs_file_entry_t *file_entry,
size_t *utf8_string_size,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_utf8_name(
libfsxfs_file_entry_t *file_entry,
uint8_t *utf8_string,
size_t utf8_string_size,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_utf16_name_size(
libfsxfs_file_entry_t *file_entry,
size_t *utf16_string_size,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_utf16_name(
libfsxfs_file_entry_t *file_entry,
uint16_t *utf16_string,
size_t utf16_string_size,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_utf8_symbolic_link_target_size(
libfsxfs_file_entry_t *file_entry,
size_t *utf8_string_size,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_utf8_symbolic_link_target(
libfsxfs_file_entry_t *file_entry,
uint8_t *utf8_string,
size_t utf8_string_size,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_utf16_symbolic_link_target_size(
libfsxfs_file_entry_t *file_entry,
size_t *utf16_string_size,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_utf16_symbolic_link_target(
libfsxfs_file_entry_t *file_entry,
uint16_t *utf16_string,
size_t utf16_string_size,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_number_of_extended_attributes(
libfsxfs_file_entry_t *file_entry,
int *number_of_extended_attributes,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_extended_attribute_by_index(
libfsxfs_file_entry_t *file_entry,
int extended_attribute_index,
libfsxfs_extended_attribute_t **extended_attribute,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_has_extended_attribute_by_utf8_name(
libfsxfs_file_entry_t *file_entry,
const uint8_t *utf8_string,
size_t utf8_string_length,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_has_extended_attribute_by_utf16_name(
libfsxfs_file_entry_t *file_entry,
const uint16_t *utf16_string,
size_t utf16_string_length,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_extended_attribute_by_utf8_name(
libfsxfs_file_entry_t *file_entry,
const uint8_t *utf8_string,
size_t utf8_string_length,
libfsxfs_extended_attribute_t **extended_attribute,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_extended_attribute_by_utf16_name(
libfsxfs_file_entry_t *file_entry,
const uint16_t *utf16_string,
size_t utf16_string_length,
libfsxfs_extended_attribute_t **extended_attribute,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_number_of_sub_file_entries(
libfsxfs_file_entry_t *file_entry,
int *number_of_sub_entries,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_sub_file_entry_by_index(
libfsxfs_file_entry_t *file_entry,
int sub_file_entry_index,
libfsxfs_file_entry_t **sub_file_entry,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_sub_file_entry_by_utf8_name(
libfsxfs_file_entry_t *file_entry,
const uint8_t *utf8_string,
size_t utf8_string_length,
libfsxfs_file_entry_t **sub_file_entry,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_sub_file_entry_by_utf16_name(
libfsxfs_file_entry_t *file_entry,
const uint16_t *utf16_string,
size_t utf16_string_length,
libfsxfs_file_entry_t **sub_file_entry,
libfsxfs_error_t **error);

ssize_t


libfsxfs_file_entry_read_buffer(
libfsxfs_file_entry_t *file_entry,
void *buffer,
size_t buffer_size,
libfsxfs_error_t **error);

ssize_t


libfsxfs_file_entry_read_buffer_at_offset(
libfsxfs_file_entry_t *file_entry,
void *buffer,
size_t buffer_size,
off64_t offset,
libfsxfs_error_t **error);

off64_t


libfsxfs_file_entry_seek_offset(
libfsxfs_file_entry_t *file_entry,
off64_t offset,
int whence,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_offset(
libfsxfs_file_entry_t *file_entry,
off64_t *offset,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_size(
libfsxfs_file_entry_t *file_entry,
size64_t *size,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_number_of_extents(
libfsxfs_file_entry_t *file_entry,
int *number_of_extents,
libfsxfs_error_t **error);

int


libfsxfs_file_entry_get_extent_by_index(
libfsxfs_file_entry_t *file_entry,
int extent_index,
off64_t *extent_offset,
size64_t *extent_size,
uint32_t *extent_flags,
libfsxfs_error_t **error);

Extended attribute functions

int


libfsxfs_extended_attribute_free(
libfsxfs_extended_attribute_t **extended_attribute,
libfsxfs_error_t **error);

int


libfsxfs_extended_attribute_get_utf8_name_size(
libfsxfs_extended_attribute_t *extended_attribute,
size_t *utf8_string_size,
libfsxfs_error_t **error);

int


libfsxfs_extended_attribute_get_utf8_name(
libfsxfs_extended_attribute_t *extended_attribute,
uint8_t *utf8_string,
size_t utf8_string_size,
libfsxfs_error_t **error);

int


libfsxfs_extended_attribute_get_utf16_name_size(
libfsxfs_extended_attribute_t *extended_attribute,
size_t *utf16_string_size,
libfsxfs_error_t **error);

int


libfsxfs_extended_attribute_get_utf16_name(
libfsxfs_extended_attribute_t *extended_attribute,
uint16_t *utf16_string,
size_t utf16_string_size,
libfsxfs_error_t **error);

ssize_t


libfsxfs_extended_attribute_read_buffer(
libfsxfs_extended_attribute_t *extended_attribute,
void *buffer,
size_t buffer_size,
libfsxfs_error_t **error);

ssize_t


libfsxfs_extended_attribute_read_buffer_at_offset(
libfsxfs_extended_attribute_t *extended_attribute,
void *buffer,
size_t buffer_size,
off64_t offset,
libfsxfs_error_t **error);

off64_t


libfsxfs_extended_attribute_seek_offset(
libfsxfs_extended_attribute_t *extended_attribute,
off64_t offset,
int whence,
libfsxfs_error_t **error);

int


libfsxfs_extended_attribute_get_offset(
libfsxfs_extended_attribute_t *extended_attribute,
off64_t *offset,
libfsxfs_error_t **error);

int


libfsxfs_extended_attribute_get_size(
libfsxfs_extended_attribute_t *extended_attribute,
size64_t *size,
libfsxfs_error_t **error);

int


libfsxfs_extended_attribute_get_number_of_extents(
libfsxfs_extended_attribute_t *extended_attribute,
int *number_of_extents,
libfsxfs_error_t **error);

int


libfsxfs_extended_attribute_get_extent_by_index(
libfsxfs_extended_attribute_t *extended_attribute,
int extent_index,
off64_t *extent_offset,
size64_t *extent_size,
uint32_t *extent_flags,
libfsxfs_error_t **error);

DESCRIPTION¶

The libfsxfs_get_version() function is used to retrieve the library version.

RETURN VALUES¶

Most of the functions return NULL or -1 on error, dependent on the return type. For the actual return values see <libfsxfs.h>.

ENVIRONMENT¶

None

FILES¶

None

NOTES¶

libfsxfs can be compiled with wide character support (wchar_t).

To compile libfsxfs with wide character support use: ./configure --enable-wide-character-type
or define: _UNICODE
or UNICODE
during compilation.

LIBFSXFS_WIDE_CHARACTER_TYPE
in libfsxfs/features.h can be used to determine if libfsxfs was compiled with wide character support.

SEE ALSO¶

<libfsxfs.h>

AUTHORS¶

Joachim Metz <joachim.metz@gmail.com>

BUGS¶

Please report bugs of any kind on the project issue tracker: https://github.com/libyal/libfsxfs/issues

COPYRIGHT¶

Copyright (C) 2020-2026, Joachim Metz <joachim.metz@gmail.com>.

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.