/src/libfsapfs/libfsapfs/libfsapfs_volume_superblock.c

Source (jump to first uncovered line)
/*
 * The volume superblock functions
 *
 * Copyright (C) 2018-2024, Joachim Metz <joachim.metz@gmail.com>
 *
 * Refer to AUTHORS for acknowledgements.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#include <common.h>
#include <byte_stream.h>
#include <memory.h>
#include <types.h>

#include "libfsapfs_checksum.h"
#include "libfsapfs_debug.h"
#include "libfsapfs_io_handle.h"
#include "libfsapfs_libbfio.h"
#include "libfsapfs_libcerror.h"
#include "libfsapfs_libcnotify.h"
#include "libfsapfs_libfdatetime.h"
#include "libfsapfs_libfguid.h"
#include "libfsapfs_libuna.h"
#include "libfsapfs_volume_superblock.h"

#include "fsapfs_volume_superblock.h"

/* Creates a volume superblock
 * Make sure the value volume_superblock is referencing, is set to NULL
 * Returns 1 if successful or -1 on error
 */
int libfsapfs_volume_superblock_initialize(
     libfsapfs_volume_superblock_t **volume_superblock,
     libcerror_error_t **error )
{
  static char *function = "libfsapfs_volume_superblock_initialize";

  if( volume_superblock == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid volume superblock.",
     function );

    return( -1 );
  }
  if( *volume_superblock != NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,
     "%s: invalid volume superblock value already set.",
     function );

    return( -1 );
  }
  *volume_superblock = memory_allocate_structure(
                        libfsapfs_volume_superblock_t );

  if( *volume_superblock == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_MEMORY,
     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,
     "%s: unable to create volume superblock.",
     function );

    goto on_error;
  }
  if( memory_set(
       *volume_superblock,
       0,
       sizeof( libfsapfs_volume_superblock_t ) ) == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_MEMORY,
     LIBCERROR_MEMORY_ERROR_SET_FAILED,
     "%s: unable to clear volume superblock.",
     function );

    goto on_error;
  }
  return( 1 );

on_error:
  if( *volume_superblock != NULL )
  {
    memory_free(
     *volume_superblock );

    *volume_superblock = NULL;
  }
  return( -1 );
}

/* Frees a volume superblock
 * Returns 1 if successful or -1 on error
 */
int libfsapfs_volume_superblock_free(
     libfsapfs_volume_superblock_t **volume_superblock,
     libcerror_error_t **error )
{
  static char *function = "libfsapfs_volume_superblock_free";

  if( volume_superblock == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid volume superblock.",
     function );

    return( -1 );
  }
  if( *volume_superblock != NULL )
  {
    memory_free(
     *volume_superblock );

    *volume_superblock = NULL;
  }
  return( 1 );
}

/* Reads the volume superblock
 * Returns 1 if successful or -1 on error
 */
int libfsapfs_volume_superblock_read_file_io_handle(
     libfsapfs_volume_superblock_t *volume_superblock,
     libbfio_handle_t *file_io_handle,
     off64_t file_offset,
     int8_t is_snapshot,
     libcerror_error_t **error )
{
  uint8_t volume_superblock_data[ 4096 ];

  static char *function = "libfsapfs_volume_superblock_read_file_io_handle";
  ssize_t read_count    = 0;

  if( volume_superblock == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid volume superblock.",
     function );

    return( -1 );
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "%s: reading volume superblock at offset: %" PRIi64 " (0x%08" PRIx64 ")\n",
     function,
     file_offset,
     file_offset );
  }
#endif
  read_count = libbfio_handle_read_buffer_at_offset(
                file_io_handle,
                (uint8_t *) &volume_superblock_data,
                4096,
                file_offset,
                error );

  if( read_count != (ssize_t) 4096 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_READ_FAILED,
     "%s: unable to read volume superblock data at offset: %" PRIi64 " (0x%08" PRIx64 ").",
     function,
     file_offset,
     file_offset );

    return( -1 );
  }
  if( libfsapfs_volume_superblock_read_data(
       volume_superblock,
       (uint8_t *) &volume_superblock_data,
       4096,
       is_snapshot,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_READ_FAILED,
     "%s: unable to read volume superblock data.",
     function );

    return( -1 );
  }
  return( 1 );
}

/* Reads the volume superblock
 * Returns 1 if successful or -1 on error
 */
int libfsapfs_volume_superblock_read_data(
     libfsapfs_volume_superblock_t *volume_superblock,
     const uint8_t *data,
     size_t data_size,
     int8_t is_snapshot,
     libcerror_error_t **error )
{
  static char *function         = "libfsapfs_volume_superblock_read_data";
  uint64_t calculated_checksum  = 0;
  uint64_t stored_checksum      = 0;
  uint32_t expected_object_type = 0;
  uint32_t object_subtype       = 0;
  uint32_t object_type          = 0;

#if defined( HAVE_DEBUG_OUTPUT )
  uint64_t value_64bit          = 0;
  uint32_t value_32bit          = 0;
#endif

  if( volume_superblock == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid volume superblock.",
     function );

    return( -1 );
  }
  if( data == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_MISSING,
     "%s: invalid data.",
     function );

    return( -1 );
  }
  if( ( data_size < sizeof( fsapfs_volume_superblock_t ) )
   || ( data_size > (size_t) SSIZE_MAX ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
     "%s: invalid data size value out of bounds.",
     function );

    return( -1 );
  }
  if( is_snapshot == 0 )
  {
    expected_object_type = 0x0000000dUL;
  }
  else
  {
    expected_object_type = 0x4000000dUL;
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "%s: volume superblock data:\n",
     function );
    libcnotify_print_data(
     data,
     sizeof( fsapfs_volume_superblock_t ),
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );
  }
#endif
  byte_stream_copy_to_uint64_little_endian(
   ( (fsapfs_volume_superblock_t *) data )->object_transaction_identifier,
   volume_superblock->transaction_identifier );

  byte_stream_copy_to_uint64_little_endian(
   ( (fsapfs_volume_superblock_t *) data )->object_checksum,
   stored_checksum );

  byte_stream_copy_to_uint32_little_endian(
   ( (fsapfs_volume_superblock_t *) data )->object_type,
   object_type );

  if( object_type != expected_object_type )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
     "%s: invalid object type: 0x%08" PRIx32 ".",
     function,
     object_type );

    return( -1 );
  }
  byte_stream_copy_to_uint32_little_endian(
   ( (fsapfs_volume_superblock_t *) data )->object_subtype,
   object_subtype );

  if( object_subtype != 0x00000000UL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
     "%s: invalid object subtype: 0x%08" PRIx32 ".",
     function,
     object_subtype );

    return( -1 );
  }
  if( memory_compare(
       ( (fsapfs_volume_superblock_t *) data )->signature,
       fsapfs_volume_signature,
       4 ) != 0 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
     "%s: invalid signature.",
     function );

    return( -1 );
  }
  byte_stream_copy_to_uint64_little_endian(
   ( (fsapfs_volume_superblock_t *) data )->compatible_features_flags,
   volume_superblock->compatible_features_flags );

  byte_stream_copy_to_uint64_little_endian(
   ( (fsapfs_volume_superblock_t *) data )->read_only_compatible_features_flags,
   volume_superblock->read_only_compatible_features_flags );

  byte_stream_copy_to_uint64_little_endian(
   ( (fsapfs_volume_superblock_t *) data )->incompatible_features_flags,
   volume_superblock->incompatible_features_flags );

  byte_stream_copy_to_uint64_little_endian(
   ( (fsapfs_volume_superblock_t *) data )->object_map_block_number,
   volume_superblock->object_map_block_number );

  byte_stream_copy_to_uint64_little_endian(
   ( (fsapfs_volume_superblock_t *) data )->file_system_root_object_identifier,
   volume_superblock->file_system_root_object_identifier );

  byte_stream_copy_to_uint64_little_endian(
   ( (fsapfs_volume_superblock_t *) data )->extent_reference_tree_block_number,
   volume_superblock->extent_reference_tree_block_number );

  byte_stream_copy_to_uint64_little_endian(
   ( (fsapfs_volume_superblock_t *) data )->snapshot_metadata_tree_block_number,
   volume_superblock->snapshot_metadata_tree_block_number );

  byte_stream_copy_to_uint64_little_endian(
   ( (fsapfs_volume_superblock_t *) data )->next_file_system_object_identifier,
   volume_superblock->next_file_system_object_identifier );

  if( memory_copy(
       volume_superblock->volume_identifier,
       ( (fsapfs_volume_superblock_t *) data )->volume_identifier,
       16 ) == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_MEMORY,
     LIBCERROR_MEMORY_ERROR_COPY_FAILED,
     "%s: unable to copy volume identifier.",
     function );

    return( -1 );
  }
/* TODO preserve modification time */

  byte_stream_copy_to_uint64_little_endian(
   ( (fsapfs_volume_superblock_t *) data )->volume_flags,
   volume_superblock->volume_flags );

  if( memory_copy(
       volume_superblock->volume_name,
       ( (fsapfs_volume_superblock_t *) data )->volume_name,
       256 ) == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_MEMORY,
     LIBCERROR_MEMORY_ERROR_COPY_FAILED,
     "%s: unable to copy volume name.",
     function );

    return( -1 );
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "%s: object checksum\t\t\t\t: 0x%08" PRIx64 "\n",
     function,
     stored_checksum );

    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->object_identifier,
     value_64bit );
    libcnotify_printf(
     "%s: object identifier\t\t\t: %" PRIu64 "\n",
     function,
     value_64bit );

    libcnotify_printf(
     "%s: object transaction identifier\t\t: %" PRIu64 "\n",
     function,
     volume_superblock->transaction_identifier );

    libcnotify_printf(
     "%s: object type\t\t\t\t: 0x%08" PRIx32 "\n",
     function,
     object_type );

    libcnotify_printf(
     "%s: object subtype\t\t\t\t: 0x%08" PRIx32 "\n",
     function,
     object_subtype );

    libcnotify_printf(
     "%s: signature\t\t\t\t: %c%c%c%c\n",
     function,
     ( (fsapfs_volume_superblock_t *) data )->signature[ 0 ],
     ( (fsapfs_volume_superblock_t *) data )->signature[ 1 ],
     ( (fsapfs_volume_superblock_t *) data )->signature[ 2 ],
     ( (fsapfs_volume_superblock_t *) data )->signature[ 3 ] );

    byte_stream_copy_to_uint32_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown1,
     value_32bit );
    libcnotify_printf(
     "%s: unknown1\t\t\t\t\t: 0x%08" PRIx32 "\n",
     function,
     value_32bit );

    libcnotify_printf(
     "%s: compatible features flags\t\t: 0x%08" PRIx64 "\n",
     function,
     volume_superblock->compatible_features_flags );
    libfsapfs_debug_print_volume_compatible_features_flags(
     volume_superblock->compatible_features_flags );
    libcnotify_printf(
     "\n" );

    libcnotify_printf(
     "%s: read-only compatible features flags\t: 0x%08" PRIx64 "\n",
     function,
     volume_superblock->read_only_compatible_features_flags );
    libfsapfs_debug_print_volume_read_only_compatible_features_flags(
     volume_superblock->read_only_compatible_features_flags );
    libcnotify_printf(
     "\n" );

    libcnotify_printf(
     "%s: incompatible features flags\t\t: 0x%08" PRIx64 "\n",
     function,
     volume_superblock->incompatible_features_flags );
    libfsapfs_debug_print_volume_incompatible_features_flags(
     volume_superblock->incompatible_features_flags );
    libcnotify_printf(
     "\n" );

    if( libfsapfs_debug_print_posix_time_value(
         function,
         "unknown5\t\t\t\t\t",
         ( (fsapfs_volume_superblock_t *) data )->unknown5,
         8,
         LIBFDATETIME_ENDIAN_LITTLE,
         LIBFDATETIME_POSIX_TIME_VALUE_TYPE_NANO_SECONDS_64BIT_SIGNED,
         LIBFDATETIME_STRING_FORMAT_TYPE_ISO8601 | LIBFDATETIME_STRING_FORMAT_FLAG_DATE_TIME_NANO_SECONDS,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_PRINT_FAILED,
       "%s: unable to print POSIX time value.",
       function );

      return( -1 );
    }
    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->number_of_reserved_blocks,
     value_64bit );
    libcnotify_printf(
     "%s: number of reserved blocks\t\t: %" PRIu64 "\n",
     function,
     value_64bit );

    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->number_of_quota_blocks,
     value_64bit );
    libcnotify_printf(
     "%s: number of quota blocks\t\t\t: %" PRIu64 "\n",
     function,
     value_64bit );

    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown8,
     value_64bit );
    libcnotify_printf(
     "%s: unknown8\t\t\t\t\t: 0x%08" PRIx64 "\n",
     function,
     value_64bit );

    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown9,
     value_64bit );
    libcnotify_printf(
     "%s: unknown9\t\t\t\t\t: 0x%08" PRIx64 "\n",
     function,
     value_64bit );

    byte_stream_copy_to_uint32_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown10,
     value_32bit );
    libcnotify_printf(
     "%s: unknown10\t\t\t\t: 0x%08" PRIx32 "\n",
     function,
     value_32bit );

    byte_stream_copy_to_uint32_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown11,
     value_32bit );
    libcnotify_printf(
     "%s: unknown11\t\t\t\t: 0x%08" PRIx32 "\n",
     function,
     value_32bit );

    byte_stream_copy_to_uint32_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown12,
     value_32bit );
    libcnotify_printf(
     "%s: unknown12\t\t\t\t: 0x%08" PRIx32 "\n",
     function,
     value_32bit );

    byte_stream_copy_to_uint32_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->file_system_root_tree_object_type,
     value_32bit );
    libcnotify_printf(
     "%s: file system root tree object type\t: 0x%08" PRIx32 "\n",
     function,
     value_32bit );

    byte_stream_copy_to_uint32_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->extent_reference_tree_object_type,
     value_32bit );
    libcnotify_printf(
     "%s: extent-reference tree object type\t: 0x%08" PRIx32 "\n",
     function,
     value_32bit );

    byte_stream_copy_to_uint32_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->snapshot_metadata_tree_object_type,
     value_32bit );
    libcnotify_printf(
     "%s: snapshot metadata tree object type\t: 0x%08" PRIx32 "\n",
     function,
     value_32bit );

    libcnotify_printf(
     "%s: object map block number\t\t\t: %" PRIu64 "\n",
     function,
     volume_superblock->object_map_block_number );

    libcnotify_printf(
     "%s: file system root object identifier\t: %" PRIu64 "\n",
     function,
     volume_superblock->file_system_root_object_identifier );

    libcnotify_printf(
     "%s: extent-reference tree block number\t: %" PRIu64 "\n",
     function,
     volume_superblock->extent_reference_tree_block_number );

    libcnotify_printf(
     "%s: snapshot metadata tree block number\t: %" PRIu64 "\n",
     function,
     volume_superblock->snapshot_metadata_tree_block_number );

    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown20,
     value_64bit );
    libcnotify_printf(
     "%s: unknown20\t\t\t\t: 0x%08" PRIx64 "\n",
     function,
     value_64bit );

    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown21,
     value_64bit );
    libcnotify_printf(
     "%s: unknown21\t\t\t\t: 0x%08" PRIx64 "\n",
     function,
     value_64bit );

    libcnotify_printf(
     "%s: next file system object identifier\t: %" PRIu64 "\n",
     function,
     volume_superblock->next_file_system_object_identifier );

    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown23,
     value_64bit );
    libcnotify_printf(
     "%s: unknown23\t\t\t\t: 0x%08" PRIx64 "\n",
     function,
     value_64bit );

    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown24,
     value_64bit );
    libcnotify_printf(
     "%s: unknown24\t\t\t\t: 0x%08" PRIx64 "\n",
     function,
     value_64bit );

    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown25,
     value_64bit );
    libcnotify_printf(
     "%s: unknown25\t\t\t\t: 0x%08" PRIx64 "\n",
     function,
     value_64bit );

    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown26,
     value_64bit );
    libcnotify_printf(
     "%s: unknown26\t\t\t\t: 0x%08" PRIx64 "\n",
     function,
     value_64bit );

    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown27,
     value_64bit );
    libcnotify_printf(
     "%s: unknown27\t\t\t\t: 0x%08" PRIx64 "\n",
     function,
     value_64bit );

    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown28,
     value_64bit );
    libcnotify_printf(
     "%s: unknown28\t\t\t\t: 0x%08" PRIx64 "\n",
     function,
     value_64bit );

    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown29,
     value_64bit );
    libcnotify_printf(
     "%s: unknown29\t\t\t\t: 0x%08" PRIx64 "\n",
     function,
     value_64bit );

    if( libfsapfs_debug_print_guid_value(
         function,
         "volume identifier\t\t\t",
         ( (fsapfs_volume_superblock_t *) data )->volume_identifier,
         16,
         LIBFGUID_ENDIAN_BIG,
         LIBFGUID_STRING_FORMAT_FLAG_USE_LOWER_CASE,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_PRINT_FAILED,
       "%s: unable to print UUID value.",
       function );

      return( -1 );
    }
    if( libfsapfs_debug_print_posix_time_value(
         function,
         "modification time\t\t\t",
         ( (fsapfs_volume_superblock_t *) data )->modification_time,
         8,
         LIBFDATETIME_ENDIAN_LITTLE,
         LIBFDATETIME_POSIX_TIME_VALUE_TYPE_NANO_SECONDS_64BIT_SIGNED,
         LIBFDATETIME_STRING_FORMAT_TYPE_ISO8601 | LIBFDATETIME_STRING_FORMAT_FLAG_DATE_TIME_NANO_SECONDS,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_PRINT_FAILED,
       "%s: unable to print POSIX time value.",
       function );

      return( -1 );
    }
    libcnotify_printf(
     "%s: volume flags\t\t\t\t: 0x%08" PRIx64 "\n",
     function,
     volume_superblock->volume_flags );
    libfsapfs_debug_print_volume_flags(
     volume_superblock->volume_flags );
    libcnotify_printf(
     "\n" );

    libcnotify_printf(
     "%s: unknown32:\n",
     function );
    libcnotify_print_data(
     ( (fsapfs_volume_superblock_t *) data )->unknown32,
     32,
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );

    if( libfsapfs_debug_print_posix_time_value(
         function,
         "unknown33\t\t\t\t",
         ( (fsapfs_volume_superblock_t *) data )->unknown33,
         8,
         LIBFDATETIME_ENDIAN_LITTLE,
         LIBFDATETIME_POSIX_TIME_VALUE_TYPE_NANO_SECONDS_64BIT_SIGNED,
         LIBFDATETIME_STRING_FORMAT_TYPE_ISO8601 | LIBFDATETIME_STRING_FORMAT_FLAG_DATE_TIME_NANO_SECONDS,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_PRINT_FAILED,
       "%s: unable to print POSIX time value.",
       function );

      return( -1 );
    }
    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown34,
     value_64bit );
    libcnotify_printf(
     "%s: unknown34\t\t\t\t: %" PRIu64 "\n",
     function,
     value_64bit );

    libcnotify_printf(
     "%s: unknown35:\n",
     function );
    libcnotify_print_data(
     ( (fsapfs_volume_superblock_t *) data )->unknown35,
     32,
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );

    if( libfsapfs_debug_print_posix_time_value(
         function,
         "unknown36\t\t\t\t",
         ( (fsapfs_volume_superblock_t *) data )->unknown36,
         8,
         LIBFDATETIME_ENDIAN_LITTLE,
         LIBFDATETIME_POSIX_TIME_VALUE_TYPE_NANO_SECONDS_64BIT_SIGNED,
         LIBFDATETIME_STRING_FORMAT_TYPE_ISO8601 | LIBFDATETIME_STRING_FORMAT_FLAG_DATE_TIME_NANO_SECONDS,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_PRINT_FAILED,
       "%s: unable to print POSIX time value.",
       function );

      return( -1 );
    }
    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown37,
     value_64bit );
    libcnotify_printf(
     "%s: unknown37\t\t\t\t: %" PRIu64 "\n",
     function,
     value_64bit );

    libcnotify_printf(
     "%s: unknown38:\n",
     function );
    libcnotify_print_data(
     ( (fsapfs_volume_superblock_t *) data )->unknown38,
     32,
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );

    if( libfsapfs_debug_print_posix_time_value(
         function,
         "unknown39\t\t\t\t",
         ( (fsapfs_volume_superblock_t *) data )->unknown39,
         8,
         LIBFDATETIME_ENDIAN_LITTLE,
         LIBFDATETIME_POSIX_TIME_VALUE_TYPE_NANO_SECONDS_64BIT_SIGNED,
         LIBFDATETIME_STRING_FORMAT_TYPE_ISO8601 | LIBFDATETIME_STRING_FORMAT_FLAG_DATE_TIME_NANO_SECONDS,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_PRINT_FAILED,
       "%s: unable to print POSIX time value.",
       function );

      return( -1 );
    }
    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown40,
     value_64bit );
    libcnotify_printf(
     "%s: unknown40\t\t\t\t: %" PRIu64 "\n",
     function,
     value_64bit );

    libcnotify_printf(
     "%s: unknown41:\n",
     function );
    libcnotify_print_data(
     ( (fsapfs_volume_superblock_t *) data )->unknown41,
     32,
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );

    if( libfsapfs_debug_print_posix_time_value(
         function,
         "unknown42\t\t\t\t",
         ( (fsapfs_volume_superblock_t *) data )->unknown42,
         8,
         LIBFDATETIME_ENDIAN_LITTLE,
         LIBFDATETIME_POSIX_TIME_VALUE_TYPE_NANO_SECONDS_64BIT_SIGNED,
         LIBFDATETIME_STRING_FORMAT_TYPE_ISO8601 | LIBFDATETIME_STRING_FORMAT_FLAG_DATE_TIME_NANO_SECONDS,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_PRINT_FAILED,
       "%s: unable to print POSIX time value.",
       function );

      return( -1 );
    }
    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown43,
     value_64bit );
    libcnotify_printf(
     "%s: unknown43\t\t\t\t: %" PRIu64 "\n",
     function,
     value_64bit );

    libcnotify_printf(
     "%s: unknown44:\n",
     function );
    libcnotify_print_data(
     ( (fsapfs_volume_superblock_t *) data )->unknown44,
     32,
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );

    if( libfsapfs_debug_print_posix_time_value(
         function,
         "unknown45\t\t\t\t",
         ( (fsapfs_volume_superblock_t *) data )->unknown45,
         8,
         LIBFDATETIME_ENDIAN_LITTLE,
         LIBFDATETIME_POSIX_TIME_VALUE_TYPE_NANO_SECONDS_64BIT_SIGNED,
         LIBFDATETIME_STRING_FORMAT_TYPE_ISO8601 | LIBFDATETIME_STRING_FORMAT_FLAG_DATE_TIME_NANO_SECONDS,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_PRINT_FAILED,
       "%s: unable to print POSIX time value.",
       function );

      return( -1 );
    }
    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown46,
     value_64bit );
    libcnotify_printf(
     "%s: unknown46\t\t\t\t: %" PRIu64 "\n",
     function,
     value_64bit );

    libcnotify_printf(
     "%s: unknown47:\n",
     function );
    libcnotify_print_data(
     ( (fsapfs_volume_superblock_t *) data )->unknown47,
     32,
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );

    if( libfsapfs_debug_print_posix_time_value(
         function,
         "unknown48\t\t\t\t",
         ( (fsapfs_volume_superblock_t *) data )->unknown48,
         8,
         LIBFDATETIME_ENDIAN_LITTLE,
         LIBFDATETIME_POSIX_TIME_VALUE_TYPE_NANO_SECONDS_64BIT_SIGNED,
         LIBFDATETIME_STRING_FORMAT_TYPE_ISO8601 | LIBFDATETIME_STRING_FORMAT_FLAG_DATE_TIME_NANO_SECONDS,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_PRINT_FAILED,
       "%s: unable to print POSIX time value.",
       function );

      return( -1 );
    }
    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown49,
     value_64bit );
    libcnotify_printf(
     "%s: unknown49\t\t\t\t: %" PRIu64 "\n",
     function,
     value_64bit );

    libcnotify_printf(
     "%s: unknown50:\n",
     function );
    libcnotify_print_data(
     ( (fsapfs_volume_superblock_t *) data )->unknown50,
     32,
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );

    if( libfsapfs_debug_print_posix_time_value(
         function,
         "unknown51\t\t\t\t",
         ( (fsapfs_volume_superblock_t *) data )->unknown51,
         8,
         LIBFDATETIME_ENDIAN_LITTLE,
         LIBFDATETIME_POSIX_TIME_VALUE_TYPE_NANO_SECONDS_64BIT_SIGNED,
         LIBFDATETIME_STRING_FORMAT_TYPE_ISO8601 | LIBFDATETIME_STRING_FORMAT_FLAG_DATE_TIME_NANO_SECONDS,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_PRINT_FAILED,
       "%s: unable to print POSIX time value.",
       function );

      return( -1 );
    }
    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown52,
     value_64bit );
    libcnotify_printf(
     "%s: unknown52\t\t\t\t: %" PRIu64 "\n",
     function,
     value_64bit );

    libcnotify_printf(
     "%s: unknown53:\n",
     function );
    libcnotify_print_data(
     ( (fsapfs_volume_superblock_t *) data )->unknown53,
     32,
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );

    if( libfsapfs_debug_print_posix_time_value(
         function,
         "unknown54\t\t\t\t",
         ( (fsapfs_volume_superblock_t *) data )->unknown54,
         8,
         LIBFDATETIME_ENDIAN_LITTLE,
         LIBFDATETIME_POSIX_TIME_VALUE_TYPE_NANO_SECONDS_64BIT_SIGNED,
         LIBFDATETIME_STRING_FORMAT_TYPE_ISO8601 | LIBFDATETIME_STRING_FORMAT_FLAG_DATE_TIME_NANO_SECONDS,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_PRINT_FAILED,
       "%s: unable to print POSIX time value.",
       function );

      return( -1 );
    }
    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown55,
     value_64bit );
    libcnotify_printf(
     "%s: unknown55\t\t\t\t: %" PRIu64 "\n",
     function,
     value_64bit );

    libcnotify_printf(
     "%s: unknown56:\n",
     function );
    libcnotify_print_data(
     ( (fsapfs_volume_superblock_t *) data )->unknown56,
     32,
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );

    if( libfsapfs_debug_print_posix_time_value(
         function,
         "unknown57\t\t\t\t",
         ( (fsapfs_volume_superblock_t *) data )->unknown57,
         8,
         LIBFDATETIME_ENDIAN_LITTLE,
         LIBFDATETIME_POSIX_TIME_VALUE_TYPE_NANO_SECONDS_64BIT_SIGNED,
         LIBFDATETIME_STRING_FORMAT_TYPE_ISO8601 | LIBFDATETIME_STRING_FORMAT_FLAG_DATE_TIME_NANO_SECONDS,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_PRINT_FAILED,
       "%s: unable to print POSIX time value.",
       function );

      return( -1 );
    }
    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown58,
     value_64bit );
    libcnotify_printf(
     "%s: unknown58\t\t\t\t: %" PRIu64 "\n",
     function,
     value_64bit );

    libcnotify_printf(
     "%s: volume name:\n",
     function );
    libcnotify_print_data(
     ( (fsapfs_volume_superblock_t *) data )->volume_name,
     256,
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );

    byte_stream_copy_to_uint32_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->next_document_identifier,
     value_32bit );
    libcnotify_printf(
     "%s: next document identifier\t\t\t: %" PRIu32 "\n",
     function,
     value_32bit );

    byte_stream_copy_to_uint32_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown60,
     value_32bit );
    libcnotify_printf(
     "%s: unknown60\t\t\t\t: 0x%08" PRIx32 "\n",
     function,
     value_32bit );

    byte_stream_copy_to_uint64_little_endian(
     ( (fsapfs_volume_superblock_t *) data )->unknown61,
     value_64bit );
    libcnotify_printf(
     "%s: unknown61\t\t\t\t: 0x%08" PRIx64 "\n",
     function,
     value_64bit );

    libcnotify_printf(
     "%s: unknown62:\n",
     function );
    libcnotify_print_data(
     ( (fsapfs_volume_superblock_t *) data )->unknown62,
     32,
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );
  }
#endif /* defined( HAVE_DEBUG_OUTPUT ) */

  if( libfsapfs_checksum_calculate_fletcher64(
       &calculated_checksum,
       &( data[ 8 ] ),
       data_size - 8,
       0,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_SET_FAILED,
     "%s: unable to calculate Fletcher-64 checksum.",
     function );

    return( -1 );
  }
  if( stored_checksum != calculated_checksum )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_INPUT,
     LIBCERROR_INPUT_ERROR_CHECKSUM_MISMATCH,
     "%s: mismatch in checksum ( 0x%08" PRIx64 " != 0x%08" PRIx64 " ).\n",
     function,
     stored_checksum,
     calculated_checksum );

    return( -1 );
  }
  return( 1 );
}

/* Retrieves the volume identifier
 * The identifier is an UUID stored in big-endian and is 16 bytes of size
 * Returns 1 if successful or -1 on error
 */
int libfsapfs_volume_superblock_get_volume_identifier(
     libfsapfs_volume_superblock_t *volume_superblock,
     uint8_t *uuid_data,
     size_t uuid_data_size,
     libcerror_error_t **error )
{
  static char *function = "libfsapfs_volume_superblock_get_volume_identifier";

  if( volume_superblock == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid volume superblock.",
     function );

    return( -1 );
  }
  if( uuid_data == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid UUID data.",
     function );

    return( -1 );
  }
  if( ( uuid_data_size < 16 )
   || ( uuid_data_size > (size_t) SSIZE_MAX ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
     "%s: invalid UUID data size value out of bounds.",
     function );

    return( -1 );
  }
  if( memory_copy(
       uuid_data,
       volume_superblock->volume_identifier,
       16 ) == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_MEMORY,
     LIBCERROR_MEMORY_ERROR_COPY_FAILED,
     "%s: unable to copy volume identifier.",
     function );

    return( -1 );
  }
  return( 1 );
}

/* Retrieves the size of the UTF-8 encoded volume name
 * The returned size includes the end of string character
 * Returns 1 if successful or -1 on error
 */
int libfsapfs_volume_superblock_get_utf8_volume_name_size(
     libfsapfs_volume_superblock_t *volume_superblock,
     size_t *utf8_string_size,
     libcerror_error_t **error )
{
  static char *function = "libfsapfs_volume_superblock_get_utf8_volume_name_size";

  if( volume_superblock == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid volume superblock.",
     function );

    return( -1 );
  }
  if( libuna_utf8_string_size_from_utf8_stream(
       volume_superblock->volume_name,
       256,
       utf8_string_size,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_GET_FAILED,
     "%s: unable to retrieve UTF-8 string size.",
     function );

    return( -1 );
  }
  return( 1 );
}

/* Retrieves the UTF-8 encoded volume name
 * The size should include the end of string character
 * Returns 1 if successful or -1 on error
 */
int libfsapfs_volume_superblock_get_utf8_volume_name(
     libfsapfs_volume_superblock_t *volume_superblock,
     uint8_t *utf8_string,
     size_t utf8_string_size,
     libcerror_error_t **error )
{
  static char *function = "libfsapfs_volume_superblock_get_utf8_volume_name";

  if( volume_superblock == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid volume superblock.",
     function );

    return( -1 );
  }
  if( libuna_utf8_string_copy_from_utf8_stream(
       utf8_string,
       utf8_string_size,
       volume_superblock->volume_name,
       256,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_GET_FAILED,
     "%s: unable to retrieve UTF-8 string.",
     function );

    return( -1 );
  }
  return( 1 );
}

/* Retrieves the size of the UTF-16 encoded volume name
 * The returned size includes the end of string character
 * Returns 1 if successful or -1 on error
 */
int libfsapfs_volume_superblock_get_utf16_volume_name_size(
     libfsapfs_volume_superblock_t *volume_superblock,
     size_t *utf16_string_size,
     libcerror_error_t **error )
{
  static char *function = "libfsapfs_volume_superblock_get_utf16_volume_name_size";

  if( volume_superblock == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid volume superblock.",
     function );

    return( -1 );
  }
  if( libuna_utf16_string_size_from_utf8_stream(
       volume_superblock->volume_name,
       256,
       utf16_string_size,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_GET_FAILED,
     "%s: unable to retrieve UTF-16 string size.",
     function );

    return( -1 );
  }
  return( 1 );
}

/* Retrieves the UTF-16 encoded volume name
 * The size should include the end of string character
 * Returns 1 if successful or -1 on error
 */
int libfsapfs_volume_superblock_get_utf16_volume_name(
     libfsapfs_volume_superblock_t *volume_superblock,
     uint16_t *utf16_string,
     size_t utf16_string_size,
     libcerror_error_t **error )
{
  static char *function = "libfsapfs_volume_superblock_get_utf16_volume_name";

  if( volume_superblock == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid volume superblock.",
     function );

    return( -1 );
  }
  if( libuna_utf16_string_copy_from_utf8_stream(
       utf16_string,
       utf16_string_size,
       volume_superblock->volume_name,
       256,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_GET_FAILED,
     "%s: unable to retrieve UTF-16 string.",
     function );

    return( -1 );
  }
  return( 1 );
}


Coverage Report

Created: 2025-08-28 07:10