/src/libvmdk/libvmdk/libvmdk_extent_file.c

Source
/*
 * Extent file functions
 *
 * Copyright (C) 2009-2025, 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 "libvmdk_debug.h"
#include "libvmdk_definitions.h"
#include "libvmdk_extent_file.h"
#include "libvmdk_grain_data.h"
#include "libvmdk_grain_group.h"
#include "libvmdk_libbfio.h"
#include "libvmdk_libcerror.h"
#include "libvmdk_libcnotify.h"
#include "libvmdk_libfcache.h"
#include "libvmdk_libfdata.h"
#include "libvmdk_types.h"
#include "libvmdk_unused.h"

#include "cowd_sparse_file_header.h"
#include "vmdk_sparse_file_header.h"

const char *cowd_sparse_file_signature = "COWD";
const char *vmdk_sparse_file_signature = "KDMV";

/* Creates an extent file
 * Make sure the value extent_file is referencing, is set to NULL
 * Returns 1 if successful or -1 on error
 */
int libvmdk_extent_file_initialize(
     libvmdk_extent_file_t **extent_file,
     libvmdk_io_handle_t *io_handle,
     libcerror_error_t **error )
{
  static char *function = "libvmdk_extent_file_initialize";

  if( extent_file == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid extent file.",
     function );

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

    return( -1 );
  }
  if( io_handle == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid IO handle.",
     function );

    return( -1 );
  }
  *extent_file = memory_allocate_structure(
                  libvmdk_extent_file_t );

  if( *extent_file == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_MEMORY,
     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,
     "%s: unable to create extent file.",
     function );

    goto on_error;
  }
  if( memory_set(
       *extent_file,
       0,
       sizeof( libvmdk_extent_file_t ) ) == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_MEMORY,
     LIBCERROR_MEMORY_ERROR_SET_FAILED,
     "%s: unable to clear extent file.",
     function );

    memory_free(
     *extent_file );

    *extent_file = NULL;

    return( -1 );
  }
  if( libfdata_list_initialize(
       &( ( *extent_file )->grain_groups_list ),
       (intptr_t *) *extent_file,
       NULL,
       NULL,
       (int (*)(intptr_t *, intptr_t *, libfdata_list_element_t *, libfdata_cache_t *, int, off64_t, size64_t, uint32_t, uint8_t, libcerror_error_t **)) &libvmdk_extent_file_read_grain_group_element_data,
       NULL,
       LIBFDATA_DATA_HANDLE_FLAG_NON_MANAGED,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_INITIALIZE_FAILED,
     "%s: unable to create grain groups list.",
     function );

    goto on_error;
  }
/* TODO set mapped offset in grain_groups_list ? */
  if( libfcache_cache_initialize(
       &( ( *extent_file )->grain_groups_cache ),
       LIBVMDK_MAXIMUM_CACHE_ENTRIES_GRAIN_GROUPS,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_INITIALIZE_FAILED,
     "%s: unable to create grain groups cache.",
     function );

    goto on_error;
  }
  ( *extent_file )->io_handle = io_handle;

  return( 1 );

on_error:
  if( *extent_file != NULL )
  {
    if( ( *extent_file )->grain_groups_list != NULL )
    {
      libfdata_list_free(
       &( ( *extent_file )->grain_groups_list ),
       NULL );
    }
    memory_free(
     *extent_file );

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

/* Frees an extent file
 * Returns 1 if successful or -1 on error
 */
int libvmdk_extent_file_free(
     libvmdk_extent_file_t **extent_file,
     libcerror_error_t **error )
{
  static char *function = "libvmdk_extent_file_free";
  int result            = 1;

  if( extent_file == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid extent file.",
     function );

    return( -1 );
  }
  if( *extent_file != NULL )
  {
    if( libfdata_list_free(
         &( ( *extent_file )->grain_groups_list ),
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_FINALIZE_FAILED,
       "%s: unable to free grain groups list.",
       function );

      result = -1;
    }
    if( libfcache_cache_free(
         &( ( *extent_file )->grain_groups_cache ),
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_FINALIZE_FAILED,
       "%s: unable to free grain groups cache.",
       function );

      result = -1;
    }
    memory_free(
     *extent_file );

    *extent_file = NULL;
  }
  return( result );
}

/* Checks if a buffer containing the chunk data is filled with same value bytes (empty-block)
 * Returns 1 if a pattern was found, 0 if not or -1 on error
 */
int libvmdk_extent_file_check_for_empty_block(
     const uint8_t *data,
     size_t data_size,
     libcerror_error_t **error )
{
  libvmdk_aligned_t *aligned_data_index = NULL;
  libvmdk_aligned_t *aligned_data_start = NULL;
  uint8_t *data_index                   = NULL;
  uint8_t *data_start                   = NULL;
  static char *function                 = "libvmdk_extent_file_check_for_empty_block";

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

    return( -1 );
  }
  if( data_size > (size_t) SSIZE_MAX )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_VALUE_EXCEEDS_MAXIMUM,
     "%s: invalid data size value exceeds maximum.",
     function );

    return( -1 );
  }
  data_start = (uint8_t *) data;
  data_index = (uint8_t *) data + 1;
  data_size -= 1;

  /* Only optimize for data larger than the alignment
   */
  if( data_size > ( 2 * sizeof( libvmdk_aligned_t ) ) )
  {
    /* Align the data start
     */
    while( ( (intptr_t) data_start % sizeof( libvmdk_aligned_t ) ) != 0 )
    {
      if( *data_start != *data_index )
      {
        return( 0 );
      }
      data_start += 1;
      data_index += 1;
      data_size  -= 1;
    }
    /* Align the data index
     */
    while( ( (intptr_t) data_index % sizeof( libvmdk_aligned_t ) ) != 0 )
    {
      if( *data_start != *data_index )
      {
        return( 0 );
      }
      data_index += 1;
      data_size  -= 1;
    }
    aligned_data_start = (libvmdk_aligned_t *) data_start;
    aligned_data_index = (libvmdk_aligned_t *) data_index;

    while( data_size > sizeof( libvmdk_aligned_t ) )
    {
      if( *aligned_data_start != *aligned_data_index )
      {
        return( 0 );
      }
      aligned_data_index += 1;
      data_size          -= sizeof( libvmdk_aligned_t );
    }
    data_index = (uint8_t *) aligned_data_index;
  }
  while( data_size != 0 )
  {
    if( *data_start != *data_index )
    {
      return( 0 );
    }
    data_index += 1;
    data_size  -= 1;
  }
  return( 1 );
}

/* Reads the file header from the extent file using the file IO handle
 * Returns 1 if successful, or -1 on error
 */
int libvmdk_extent_file_read_file_header_file_io_handle(
     libvmdk_extent_file_t *extent_file,
     libbfio_handle_t *file_io_handle,
     off64_t file_offset,
     libcerror_error_t **error )
{
  uint8_t *file_header_data = NULL;
  static char *function     = "libvmdk_extent_file_read_file_header_file_io_handle";
  size_t read_size          = 0;
  ssize_t read_count        = 0;

  if( extent_file == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid extent file.",
     function );

    return( -1 );
  }
  file_header_data = (uint8_t *) memory_allocate(
                                  sizeof( uint8_t ) * 2048 );

  if( file_header_data == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_MEMORY,
     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,
     "%s: unable to create file header data.",
     function );

    goto on_error;
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "%s: reading file header at offset: %" PRIi64 " (0x%08" PRIx64 ")\n",
     function,
     file_offset,
     file_offset );
  }
#endif
  read_count = libbfio_handle_read_buffer_at_offset(
                file_io_handle,
                file_header_data,
                4,
                file_offset,
                error );

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

    goto on_error;
  }
  if( memory_compare(
       file_header_data,
       cowd_sparse_file_signature,
       4 ) == 0 )
  {
    read_size = sizeof( cowd_sparse_file_header_t );
  }
  else if( memory_compare(
            file_header_data,
            vmdk_sparse_file_signature,
            4 ) == 0 )
  {
    read_size = sizeof( vmdk_sparse_file_header_t );
  }
  else
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
     "%s: unsupported file signature.",
     function );

    goto on_error;
  }
  read_count = libbfio_handle_read_buffer(
                file_io_handle,
                &( file_header_data[ 4 ] ),
                read_size - 4,
                error );

  if( read_count != (ssize_t) ( read_size - 4 ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_READ_FAILED,
     "%s: unable to read file header data.",
     function );

    goto on_error;
  }
  if( libvmdk_extent_file_read_file_header_data(
       extent_file,
       file_header_data,
       read_size,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_READ_FAILED,
     "%s: unable to read file header data.",
     function );

    goto on_error;
  }
  memory_free(
   file_header_data );

  file_header_data = NULL;

  return( 1 );

on_error:
  if( file_header_data != NULL )
  {
    memory_free(
     file_header_data );
  }
  return( -1 );
}

/* Reads the file header from the extent file using the file IO pool entry
 * Returns 1 if successful, or -1 on error
 */
int libvmdk_extent_file_read_file_header(
     libvmdk_extent_file_t *extent_file,
     libbfio_pool_t *file_io_pool,
     int file_io_pool_entry,
     off64_t file_offset,
     libcerror_error_t **error )
{
  uint8_t *file_header_data = NULL;
  static char *function     = "libvmdk_extent_file_read_file_header";
  size_t read_size          = 0;
  ssize_t read_count        = 0;

  if( extent_file == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid extent file.",
     function );

    return( -1 );
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "%s: reading file header at offset: %" PRIi64 " (0x%08" PRIx64 ")\n",
     function,
     file_offset,
     file_offset );
  }
#endif
  if( libbfio_pool_seek_offset(
       file_io_pool,
       file_io_pool_entry,
       file_offset,
       SEEK_SET,
       error ) == -1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_SEEK_FAILED,
     "%s: unable to seek file header offset: %" PRIi64 " (0x%08" PRIx64 ").",
     function,
     file_offset,
     file_offset );

    goto on_error;
  }
  file_header_data = (uint8_t *) memory_allocate(
                                  sizeof( uint8_t ) * 2048 );

  if( file_header_data == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_MEMORY,
     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,
     "%s: unable to create file header data.",
     function );

    goto on_error;
  }
  read_count = libbfio_pool_read_buffer(
                file_io_pool,
                file_io_pool_entry,
                file_header_data,
                4,
                error );

  if( read_count != (ssize_t) 4 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_READ_FAILED,
     "%s: unable to read file header data.",
     function );

    goto on_error;
  }
  if( memory_compare(
       file_header_data,
       cowd_sparse_file_signature,
       4 ) == 0 )
  {
    read_size = sizeof( cowd_sparse_file_header_t );
  }
  else if( memory_compare(
            file_header_data,
            vmdk_sparse_file_signature,
            4 ) == 0 )
  {
    read_size = sizeof( vmdk_sparse_file_header_t );
  }
  else
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
     "%s: unsupported file signature.",
     function );

    goto on_error;
  }
  read_count = libbfio_pool_read_buffer(
                file_io_pool,
                file_io_pool_entry,
                &( file_header_data[ 4 ] ),
                read_size - 4,
                error );

  if( read_count != (ssize_t) ( read_size - 4 ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_READ_FAILED,
     "%s: unable to read file header data.",
     function );

    goto on_error;
  }
  if( libvmdk_extent_file_read_file_header_data(
       extent_file,
       file_header_data,
       read_size,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_READ_FAILED,
     "%s: unable to read file header data.",
     function );

    goto on_error;
  }
  memory_free(
   file_header_data );

  file_header_data = NULL;

  return( 1 );

on_error:
  if( file_header_data != NULL )
  {
    memory_free(
     file_header_data );
  }
  return( -1 );
}

/* Reads the file header from the extent file
 * Returns 1 if successful, or -1 on error
 */
int libvmdk_extent_file_read_file_header_data(
     libvmdk_extent_file_t *extent_file,
     const uint8_t *file_header_data,
     size_t file_header_data_size,
     libcerror_error_t **error )
{
  static char *function                          = "libvmdk_extent_file_read_file_header_data";
  size64_t grain_table_size                      = 0;
  uint64_t safe_descriptor_offset                = 0;
  uint64_t safe_primary_grain_directory_offset   = 0;
  uint64_t safe_secondary_grain_directory_offset = 0;

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

  if( extent_file == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid extent file.",
     function );

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

    return( -1 );
  }
  if( file_header_data_size > (size_t) SSIZE_MAX )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_VALUE_EXCEEDS_MAXIMUM,
     "%s: invalid file header data size value exceeds maximum.",
     function );

    return( -1 );
  }
  if( memory_compare(
       file_header_data,
       cowd_sparse_file_signature,
       4 ) == 0 )
  {
    if( file_header_data_size < sizeof( cowd_sparse_file_header_t ) )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
       LIBCERROR_ARGUMENT_ERROR_VALUE_TOO_SMALL,
       "%s: invalid file header data value too small.",
       function );

      return( -1 );
    }
    extent_file->file_type = LIBVMDK_FILE_TYPE_COWD_SPARSE_DATA;
  }
  else if( memory_compare(
            file_header_data,
            vmdk_sparse_file_signature,
            4 ) == 0 )
  {
    if( file_header_data_size < sizeof( vmdk_sparse_file_header_t ) )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
       LIBCERROR_ARGUMENT_ERROR_VALUE_TOO_SMALL,
       "%s: invalid file header data value too small.",
       function );

      return( -1 );
    }
    extent_file->file_type = LIBVMDK_FILE_TYPE_VMDK_SPARSE_DATA;
  }
  else
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
     "%s: unsupported file signature.",
     function );

    return( -1 );
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "%s: file header:\n",
     function );
    libcnotify_print_data(
     file_header_data,
     file_header_data_size,
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );
  }
#endif
  if( extent_file->file_type == LIBVMDK_FILE_TYPE_COWD_SPARSE_DATA )
  {
    byte_stream_copy_to_uint32_little_endian(
     ( (cowd_sparse_file_header_t *) file_header_data )->version,
     extent_file->format_version );

    byte_stream_copy_to_uint32_little_endian(
     ( (cowd_sparse_file_header_t *) file_header_data )->flags,
     extent_file->flags );

    byte_stream_copy_to_uint32_little_endian(
     ( (cowd_sparse_file_header_t *) file_header_data )->maximum_data_number_of_sectors,
     extent_file->maximum_data_size );

    byte_stream_copy_to_uint32_little_endian(
     ( (cowd_sparse_file_header_t *) file_header_data )->grain_number_of_sectors,
     extent_file->grain_size );

    byte_stream_copy_to_uint32_little_endian(
     ( (cowd_sparse_file_header_t *) file_header_data )->primary_grain_directory_sector_number,
     safe_primary_grain_directory_offset );

    byte_stream_copy_to_uint32_little_endian(
     ( (cowd_sparse_file_header_t *) file_header_data )->number_of_grain_directory_entries,
     extent_file->number_of_grain_directory_entries );
  }
  else if( extent_file->file_type == LIBVMDK_FILE_TYPE_VMDK_SPARSE_DATA )
  {
    byte_stream_copy_to_uint32_little_endian(
     ( (vmdk_sparse_file_header_t *) file_header_data )->version,
     extent_file->format_version );

    byte_stream_copy_to_uint32_little_endian(
     ( (vmdk_sparse_file_header_t *) file_header_data )->flags,
     extent_file->flags );

    byte_stream_copy_to_uint64_little_endian(
     ( (vmdk_sparse_file_header_t *) file_header_data )->maximum_data_number_of_sectors,
     extent_file->maximum_data_size );

    byte_stream_copy_to_uint64_little_endian(
     ( (vmdk_sparse_file_header_t *) file_header_data )->grain_number_of_sectors,
     extent_file->grain_size );

    byte_stream_copy_to_uint64_little_endian(
     ( (vmdk_sparse_file_header_t *) file_header_data )->descriptor_sector_number,
     safe_descriptor_offset );

    byte_stream_copy_to_uint64_little_endian(
     ( (vmdk_sparse_file_header_t *) file_header_data )->descriptor_number_of_sectors,
     extent_file->descriptor_size );

    byte_stream_copy_to_uint32_little_endian(
     ( (vmdk_sparse_file_header_t *) file_header_data )->number_of_grain_table_entries,
     extent_file->number_of_grain_table_entries );

    byte_stream_copy_to_uint64_little_endian(
     ( (vmdk_sparse_file_header_t *) file_header_data )->secondary_grain_directory_sector_number,
     safe_secondary_grain_directory_offset );

    byte_stream_copy_to_uint64_little_endian(
     ( (vmdk_sparse_file_header_t *) file_header_data )->primary_grain_directory_sector_number,
     safe_primary_grain_directory_offset );

    extent_file->is_dirty = ( (vmdk_sparse_file_header_t *) file_header_data )->is_dirty;

    byte_stream_copy_to_uint16_little_endian(
     ( (vmdk_sparse_file_header_t *) file_header_data )->compression_method,
     extent_file->compression_method );
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "%s: signature\t\t\t\t\t: %c%c%c%c\n",
     function,
     (char) file_header_data[ 0 ],
     (char) file_header_data[ 1 ],
     (char) file_header_data[ 2 ],
     (char) file_header_data[ 3 ] );

    libcnotify_printf(
     "%s: format version\t\t\t\t: %" PRIu32 "\n",
     function,
     extent_file->format_version );

    libcnotify_printf(
     "%s: flags\t\t\t\t\t: 0x%08" PRIx32 "\n",
     function,
     extent_file->flags );

    if( extent_file->file_type == LIBVMDK_FILE_TYPE_VMDK_SPARSE_DATA )
    {
      libvmdk_debug_print_vmdk_flags(
       extent_file->flags );
    }
    libcnotify_printf(
     "%s: maximum data number of sectors\t\t: %" PRIu64 "\n",
     function,
     extent_file->maximum_data_size );

    libcnotify_printf(
     "%s: grain number of sectors\t\t\t: %" PRIu64 "\n",
     function,
     extent_file->grain_size );

    if( extent_file->file_type == LIBVMDK_FILE_TYPE_VMDK_SPARSE_DATA )
    {
      libcnotify_printf(
       "%s: descriptor sector number\t\t\t: %" PRIu64 "\n",
       function,
       safe_descriptor_offset );

      libcnotify_printf(
       "%s: descriptor number of sectors\t\t\t: %" PRIu64 "\n",
       function,
       extent_file->descriptor_size );

      libcnotify_printf(
       "%s: number of grain table entries\t\t: %" PRIu32 "\n",
       function,
       extent_file->number_of_grain_table_entries );

      if( safe_secondary_grain_directory_offset <= ( (uint64_t) INT64_MAX / 512 ) )
      {
        libcnotify_printf(
         "%s: secondary grain directory sector number\t: %" PRIu64 "\n",
         function,
         safe_secondary_grain_directory_offset );
      }
      else
      {
        libcnotify_printf(
         "%s: secondary grain directory sector number\t: 0x%08" PRIx64 "\n",
         function,
         safe_secondary_grain_directory_offset );
      }
    }
    if( safe_primary_grain_directory_offset <= ( (uint64_t) INT64_MAX / 512 ) )
    {
      libcnotify_printf(
       "%s: primary grain directory sector number\t: %" PRIu64 "\n",
       function,
       safe_primary_grain_directory_offset );
    }
    else
    {
      libcnotify_printf(
       "%s: primary grain directory sector number\t: 0x%08" PRIx64 "\n",
       function,
       safe_primary_grain_directory_offset );
    }
    if( extent_file->file_type == LIBVMDK_FILE_TYPE_COWD_SPARSE_DATA )
    {
      libcnotify_printf(
       "%s: padding:\n",
       function );
      libcnotify_print_data(
       (uint8_t *) ( (vmdk_sparse_file_header_t *) file_header_data )->padding,
       433,
       LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );
    }
    else if( extent_file->file_type == LIBVMDK_FILE_TYPE_VMDK_SPARSE_DATA )
    {
      byte_stream_copy_to_uint64_little_endian(
       ( (vmdk_sparse_file_header_t *) file_header_data )->metadata_number_of_sectors,
       value_64bit );
      libcnotify_printf(
       "%s: metadata number of sectors\t\t\t: %" PRIu64 "\n",
       function,
       value_64bit );

      libcnotify_printf(
       "%s: is dirty\t\t\t\t\t: 0x%02" PRIx8 "\n",
       function,
       extent_file->is_dirty );

      libcnotify_printf(
       "%s: single end of line character\t\t\t: 0x%02" PRIx8 "\n",
       function,
       ( (vmdk_sparse_file_header_t *) file_header_data )->single_end_of_line_character );

      libcnotify_printf(
       "%s: non end of line character\t\t\t: 0x%02" PRIx8 "\n",
       function,
       ( (vmdk_sparse_file_header_t *) file_header_data )->non_end_of_line_character );

      libcnotify_printf(
       "%s: first double end of line character\t\t: 0x%02" PRIx8 "\n",
       function,
       ( (vmdk_sparse_file_header_t *) file_header_data )->first_double_end_of_line_character );

      libcnotify_printf(
       "%s: second double end of line character\t\t: 0x%02" PRIx8 "\n",
       function,
       ( (vmdk_sparse_file_header_t *) file_header_data )->second_double_end_of_line_character );

      libcnotify_printf(
       "%s: compression method\t\t\t\t: %" PRIu16 " (%s)\n",
       function,
       extent_file->compression_method,
       libvmdk_debug_get_compression_method_description(
        extent_file->compression_method ) );

      libcnotify_printf(
       "%s: padding:\n",
       function );
      libcnotify_print_data(
       ( (vmdk_sparse_file_header_t *) file_header_data )->padding,
       433,
       LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );
    }
  }
#endif /* defined( HAVE_DEBUG_OUTPUT ) */

  if( ( extent_file->grain_size == 0 )
   || ( extent_file->grain_size > ( (uint64_t) INT64_MAX / 512 ) ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
     "%s: invalid grain number of sectors value out of bounds.",
     function );

    return( -1 );
  }
  if( safe_descriptor_offset > (uint64_t) INT64_MAX )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
     "%s: invalid descriptor offset value out of bounds.",
     function );

    return( -1 );
  }
  extent_file->descriptor_offset = (off64_t) safe_descriptor_offset;

  /* Note that the primary grain directory offsets can be -1
   */
  extent_file->primary_grain_directory_offset = (off64_t) safe_primary_grain_directory_offset;

  if( extent_file->file_type == LIBVMDK_FILE_TYPE_VMDK_SPARSE_DATA )
  {
    if( safe_secondary_grain_directory_offset > ( (uint64_t) INT64_MAX / 512 ) )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
       "%s: invalid secondary grain directory offset value out of bounds.",
       function );

      return( -1 );
    }
    extent_file->secondary_grain_directory_offset = (off64_t) safe_secondary_grain_directory_offset;

    if( extent_file->grain_size <= 8 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
       "%s: unsupported grain number of sectors value is less than or equal to 8.",
       function );

      return( -1 );
    }
    /* grain size & (grain size - 1) is 0 when grain size is a power of 2 */
    if( ( extent_file->grain_size & ( extent_file->grain_size - 1 ) ) != 0 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
       "%s: unsupported grain number of sectors value is not a power of 2.",
       function );

      return( -1 );
    }
    if( extent_file->number_of_grain_table_entries == 0 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
       "%s: unsupported number of grain table entries value is 0.",
       function );

      return( -1 );
    }
    if( (size_t) extent_file->number_of_grain_table_entries > (size_t) INT_MAX )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_VALUE_EXCEEDS_MAXIMUM,
       "%s: invalid number of grain table entries value exceeds maximum.",
       function );

      return( -1 );
    }
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    if( ( extent_file->maximum_data_size % extent_file->grain_size ) != 0 )
    {
      libcnotify_printf(
       "%s: unsupported maximum data number of sectors not a multide of the grain number of sectors.\n",
       function );
    }
  }
#endif
  if( extent_file->number_of_grain_table_entries > extent_file->maximum_data_size )
  {
    extent_file->number_of_grain_table_entries = (uint32_t) ( extent_file->maximum_data_size / extent_file->grain_size );

    if( ( extent_file->maximum_data_size % extent_file->grain_size ) != 0 )
    {
      extent_file->number_of_grain_table_entries += 1;
    }
#if defined( HAVE_DEBUG_OUTPUT )
    if( libcnotify_verbose != 0 )
    {
      libcnotify_printf(
       "%s: number of grain table entries exceeds maximum data number of sectors changing to: %" PRIu32 ".\n",
       function,
       extent_file->number_of_grain_table_entries );
    }
#endif
  }
  if( extent_file->file_type == LIBVMDK_FILE_TYPE_VMDK_SPARSE_DATA )
  {
    if( ( (vmdk_sparse_file_header_t *) file_header_data )->single_end_of_line_character != (uint8_t) '\n' )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
       "%s: unsupported single end of line character.",
       function );

      return( -1 );
    }
    if( ( (vmdk_sparse_file_header_t *) file_header_data )->non_end_of_line_character != (uint8_t) ' ' )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
       "%s: unsupported non end of line character.",
       function );

      return( -1 );
    }
    if( ( (vmdk_sparse_file_header_t *) file_header_data )->first_double_end_of_line_character != (uint8_t) '\r' )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
       "%s: unsupported first double end of line character.",
       function );

      return( -1 );
    }
    if( ( (vmdk_sparse_file_header_t *) file_header_data )->second_double_end_of_line_character != (uint8_t) '\n' )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
       "%s: unsupported second double end of line character.",
       function );

      return( -1 );
    }
  }
  if( ( extent_file->compression_method != LIBVMDK_COMPRESSION_METHOD_NONE )
   && ( extent_file->compression_method != LIBVMDK_COMPRESSION_METHOD_DEFLATE ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
     "%s: unsupported compression method: %" PRIu16 ".",
     function,
     extent_file->compression_method );

    return( -1 );
  }
  /* Change all sector values to byte values
   */
  extent_file->maximum_data_size *= 512;
  extent_file->grain_size        *= 512;

  if( ( extent_file->primary_grain_directory_offset >= 0 )
   && ( extent_file->primary_grain_directory_offset <= (off64_t) ( INT64_MAX / 512 ) ) )
  {
    extent_file->primary_grain_directory_offset *= 512;
  }
  /* In a compressed VMDK sparse data file a primary grain directory sector of -1
   * seems to indicate that there is a copy of the file header at the end of the file.
   */
  else if( ( extent_file->file_type != LIBVMDK_FILE_TYPE_VMDK_SPARSE_DATA )
        || ( extent_file->primary_grain_directory_offset != (off64_t) -1 )
        || ( extent_file->compression_method != LIBVMDK_COMPRESSION_METHOD_DEFLATE ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
     "%s: invalid primary grain directory offset value out of bounds.",
     function );

    return( -1 );
  }
  if( extent_file->file_type == LIBVMDK_FILE_TYPE_COWD_SPARSE_DATA )
  {
    extent_file->number_of_grain_table_entries = 4096;
  }
  else if( extent_file->file_type == LIBVMDK_FILE_TYPE_VMDK_SPARSE_DATA )
  {
    grain_table_size = (size64_t) extent_file->number_of_grain_table_entries * extent_file->grain_size;

    if( grain_table_size == 0 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
       "%s: invalid grain table size value out of bounds.",
       function );

      return( -1 );
    }
    extent_file->number_of_grain_directory_entries = (uint32_t) ( extent_file->maximum_data_size / grain_table_size );

    if( ( extent_file->maximum_data_size % grain_table_size ) != 0 )
    {
      extent_file->number_of_grain_directory_entries += 1;
    }
    if( extent_file->descriptor_offset > (off64_t) ( INT64_MAX / 512 ) )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
       "%s: invalid descriptor offset value out of bounds.",
       function );

      return( -1 );
    }
    extent_file->descriptor_offset *= 512;
    extent_file->descriptor_size   *= 512;

    extent_file->secondary_grain_directory_offset *= 512;
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "%s: number of grain directory entries\t\t: %" PRIu32 "\n",
     function,
     extent_file->number_of_grain_directory_entries );
  }
#endif
  if( extent_file->descriptor_size > (size_t) SSIZE_MAX )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_VALUE_EXCEEDS_MAXIMUM,
     "%s: invalid descriptor size value exceeds maximum.",
     function );

    return( -1 );
  }
  if( (size_t) extent_file->number_of_grain_directory_entries > (size_t) INT_MAX )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_EXCEEDS_MAXIMUM,
     "%s: invalid number of grain directory entries value exceeds maximum.",
     function );

    return( -1 );
  }
#if SIZEOF_SIZE_T <= 4
  if( (size_t) extent_file->number_of_grain_table_entries > (size_t) ( SSIZE_MAX / 4 ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_EXCEEDS_MAXIMUM,
     "%s: invalid grain table size value exceeds maximum.",
     function );

    return( -1 );
  }
  if( (size_t) extent_file->number_of_grain_directory_entries > (size_t) ( SSIZE_MAX / 4 ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_EXCEEDS_MAXIMUM,
     "%s: invalid grain directory size value exceeds maximum.",
     function );

    return( -1 );
  }
#endif
  extent_file->grain_table_size = (size_t) extent_file->number_of_grain_table_entries * 4;

  /* The grain table data is sector aligned
   */
  if( ( extent_file->grain_table_size % 512 ) != 0 )
  {
    extent_file->grain_table_size /= 512;
    extent_file->grain_table_size += 1;
    extent_file->grain_table_size *= 512;
  }
  extent_file->grain_directory_size = (size_t) extent_file->number_of_grain_directory_entries * 4;

  /* The grain directory data is sector aligned
   */
  if( ( extent_file->grain_directory_size % 512 ) != 0 )
  {
    extent_file->grain_directory_size /= 512;
    extent_file->grain_directory_size += 1;
    extent_file->grain_directory_size *= 512;
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "\n" );
  }
#endif
  return( 1 );
}

/* Reads the descriptor data from the extent file
 * Returns 1 if successful, 0 if no descriptor data, or -1 on error
 */
int libvmdk_extent_file_read_descriptor_data_file_io_handle(
     libvmdk_extent_file_t *extent_file,
     libbfio_handle_t *file_io_handle,
     uint8_t *descriptor_data,
     size_t descriptor_data_size,
     libcerror_error_t **error )
{
  static char *function = "libvmdk_extent_file_read_descriptor_data_file_io_handle";
  ssize_t read_count    = 0;

  if( extent_file == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid extent file.",
     function );

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

    return( -1 );
  }
  if( descriptor_data_size > (size_t) SSIZE_MAX )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_VALUE_EXCEEDS_MAXIMUM,
     "%s: invalid descriptor data size value exceeds maximum.",
     function );

    return( -1 );
  }
  if( descriptor_data_size < extent_file->descriptor_size )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_VALUE_TOO_SMALL,
     "%s: invalid descriptor data value too small.",
     function );

    return( -1 );
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "%s: reading descriptor at offset: %" PRIi64 " (0x%08" PRIx64 ")\n",
     function,
     extent_file->descriptor_offset,
     extent_file->descriptor_offset );
  }
#endif
  read_count = libbfio_handle_read_buffer_at_offset(
                file_io_handle,
                descriptor_data,
                (size_t) extent_file->descriptor_size,
                extent_file->descriptor_offset,
                error );

  if( read_count != (ssize_t) extent_file->descriptor_size )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_READ_FAILED,
     "%s: unable to read descriptor data at offset: %" PRIi64 " (0x%08" PRIx64 ").",
     function,
     extent_file->descriptor_offset,
     extent_file->descriptor_offset );

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

/* Reads the grain directories
 * Returns 1 if successful or -1 on error
 */
int libvmdk_extent_file_read_grain_directories(
     libvmdk_extent_file_t *extent_file,
     libbfio_pool_t *file_io_pool,
     int file_io_pool_entry,
     libcerror_error_t **error )
{
  static char *function = "libvmdk_extent_file_read_grain_directories";

  if( extent_file == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid extent file.",
     function );

    return( -1 );
  }
  if( ( extent_file->file_type == LIBVMDK_FILE_TYPE_VMDK_SPARSE_DATA )
   && ( ( extent_file->flags & LIBVMDK_FLAG_USE_SECONDARY_GRAIN_DIRECTORY ) != 0 ) )
  {
    if( extent_file->secondary_grain_directory_offset < 0 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
       "%s: invalid secondary grain directory offset value out of bounds.",
       function );

      return( -1 );
    }
    if( extent_file->secondary_grain_directory_offset == 0 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_VALUE_MISSING,
       "%s: missing secondary grain directory offset.",
       function );

      return( -1 );
    }
#if defined( HAVE_DEBUG_OUTPUT )
    if( libcnotify_verbose != 0 )
    {
      libcnotify_printf(
       "%s: reading secondary grain directory at offset: %" PRIi64 " (0x%08" PRIx64 ")\n",
       function,
       extent_file->secondary_grain_directory_offset,
       extent_file->secondary_grain_directory_offset );
    }
#endif
    if( libvmdk_extent_file_read_grain_directory(
         extent_file,
         file_io_pool,
         file_io_pool_entry,
         extent_file->secondary_grain_directory_offset,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_IO,
       LIBCERROR_IO_ERROR_READ_FAILED,
       "%s: unable to read secondary grain directory.",
       function );

      return( -1 );
    }
    if( extent_file->primary_grain_directory_offset > 0 )
    {
#if defined( HAVE_DEBUG_OUTPUT )
      if( libcnotify_verbose != 0 )
      {
        libcnotify_printf(
         "%s: reading primary grain directory at offset: %" PRIi64 " (0x%08" PRIx64 ")\n",
         function,
         extent_file->primary_grain_directory_offset,
         extent_file->primary_grain_directory_offset );
      }
#endif
      if( libvmdk_extent_file_read_backup_grain_directory(
           extent_file,
           file_io_pool,
           file_io_pool_entry,
           extent_file->primary_grain_directory_offset,
           error ) != 1 )
      {
        libcerror_error_set(
         error,
         LIBCERROR_ERROR_DOMAIN_IO,
         LIBCERROR_IO_ERROR_READ_FAILED,
         "%s: unable to read primary backup grain directory.",
         function );

        return( -1 );
      }
    }
  }
  else
  {
    if( extent_file->primary_grain_directory_offset < 0 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
       "%s: invalid primary grain directory offset value out of bounds.",
       function );

      return( -1 );
    }
    if( extent_file->primary_grain_directory_offset == 0 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_VALUE_MISSING,
       "%s: missing primary grain directory offset.",
       function );

      return( -1 );
    }
#if defined( HAVE_DEBUG_OUTPUT )
    if( libcnotify_verbose != 0 )
    {
      libcnotify_printf(
       "%s: reading primary grain directory at offset: %" PRIi64 " (0x%08" PRIx64 ")\n",
       function,
       extent_file->primary_grain_directory_offset,
       extent_file->primary_grain_directory_offset );
    }
#endif
    if( libvmdk_extent_file_read_grain_directory(
         extent_file,
         file_io_pool,
         file_io_pool_entry,
         extent_file->primary_grain_directory_offset,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_IO,
       LIBCERROR_IO_ERROR_READ_FAILED,
       "%s: unable to read primary grain directory.",
       function );

      return( -1 );
    }
    if( extent_file->secondary_grain_directory_offset > 0 )
    {
#if defined( HAVE_DEBUG_OUTPUT )
      if( libcnotify_verbose != 0 )
      {
        libcnotify_printf(
         "%s: reading secondary grain directory at offset: %" PRIi64 " (0x%08" PRIx64 ")\n",
         function,
         extent_file->secondary_grain_directory_offset,
         extent_file->secondary_grain_directory_offset );
      }
#endif
      if( libvmdk_extent_file_read_backup_grain_directory(
           extent_file,
           file_io_pool,
           file_io_pool_entry,
           extent_file->secondary_grain_directory_offset,
           error ) != 1 )
      {
        libcerror_error_set(
         error,
         LIBCERROR_ERROR_DOMAIN_IO,
         LIBCERROR_IO_ERROR_READ_FAILED,
         "%s: unable to read secondary backup grain directory.",
         function );

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

/* Reads the grain directory
 * Returns 1 if successful or -1 on error
 */
int libvmdk_extent_file_read_grain_directory(
     libvmdk_extent_file_t *extent_file,
     libbfio_pool_t *file_io_pool,
     int file_io_pool_entry,
     off64_t file_offset,
     libcerror_error_t **error )
{
  uint8_t *grain_directory_data        = NULL;
  uint8_t *grain_directory_entry       = NULL;
  static char *function                = "libvmdk_extent_file_read_grain_directory";
  off64_t grain_table_offset           = 0;
  size64_t grain_data_size             = 0;
  size64_t storage_media_size          = 0;
  size64_t total_grain_data_size       = 0;
  ssize_t read_count                   = 0;
  uint32_t grain_directory_entry_index = 0;
  uint32_t range_flags                 = 0;
  int element_index                    = 0;
  int number_of_grain_table_entries    = 0;

#if defined( HAVE_DEBUG_OUTPUT )
  int result                           = 0;
#endif

  if( extent_file == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid extent file.",
     function );

    return( -1 );
  }
  if( ( extent_file->grain_directory_size == 0 )
   || ( extent_file->grain_directory_size > (size_t) MEMORY_MAXIMUM_ALLOCATION_SIZE ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
     "%s: invalid extent file - grain directory size value out of bounds.",
     function );

    goto on_error;
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "%s: reading grain directory at offset: %" PRIi64 " (0x%08" PRIx64 ")\n",
     function,
     file_offset,
     file_offset );
  }
#endif
  if( libbfio_pool_seek_offset(
       file_io_pool,
       file_io_pool_entry,
       file_offset,
       SEEK_SET,
       error ) == -1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_SEEK_FAILED,
     "%s: unable to seek grain directory offset: %" PRIi64 ".",
     function,
     file_offset );

    goto on_error;
  }
  grain_directory_data = (uint8_t *) memory_allocate(
                                      sizeof( uint8_t ) * extent_file->grain_directory_size );

  if( grain_directory_data == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_MEMORY,
     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,
     "%s: unable to create grain directory data.",
     function );

    goto on_error;
  }
  read_count = libbfio_pool_read_buffer(
                file_io_pool,
                file_io_pool_entry,
                grain_directory_data,
                extent_file->grain_directory_size,
                error );

  if( read_count != (ssize_t) extent_file->grain_directory_size )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_READ_FAILED,
     "%s: unable to read grain directory data.",
     function );

    goto on_error;
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "%s: grain directory data:\n",
     function );
    libcnotify_print_data(
     grain_directory_data,
     extent_file->grain_directory_size,
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );
  }
#endif
  grain_directory_entry = grain_directory_data;

  for( grain_directory_entry_index = 0;
       grain_directory_entry_index < extent_file->number_of_grain_directory_entries;
       grain_directory_entry_index++ )
  {
    byte_stream_copy_to_uint32_little_endian(
     grain_directory_entry,
     grain_table_offset );

#if defined( HAVE_DEBUG_OUTPUT )
    if( libcnotify_verbose != 0 )
    {
      libcnotify_printf(
       "%s: grain directory entry: %05" PRIu32 " sector number\t\t: %" PRIi64 "\n",
       function,
       grain_directory_entry_index,
       grain_table_offset );
    }
#endif
    if( grain_table_offset != 0 )
    {
      range_flags         = 0;
      grain_table_offset *= 512;
    }
    else
    {
      range_flags = LIBVMDK_RANGE_FLAG_IS_SPARSE;
    }
    number_of_grain_table_entries = (int) extent_file->number_of_grain_table_entries;
    grain_data_size               = number_of_grain_table_entries * extent_file->grain_size;

    if( ( total_grain_data_size + grain_data_size ) > extent_file->maximum_data_size )
    {
      grain_data_size = extent_file->maximum_data_size - total_grain_data_size;

      number_of_grain_table_entries = (int)( grain_data_size / extent_file->grain_size );

      if( ( grain_data_size % extent_file->grain_size ) != 0 )
      {
        number_of_grain_table_entries += 1;
      }
    }
#if defined( HAVE_DEBUG_OUTPUT )
    if( libcnotify_verbose != 0 )
    {
      libcnotify_printf(
       "%s: grain directory entry: %05" PRIu32 " offset\t\t\t: %" PRIi64 " (0x%08" PRIx64 ")\n",
       function,
       grain_directory_entry_index,
       grain_table_offset * 512,
       grain_table_offset * 512 );

      libcnotify_printf(
       "%s: grain directory entry: %05" PRIu32 " size\t\t\t: %" PRIu64 " (%d)\n",
       function,
       grain_directory_entry_index,
       grain_data_size,
       number_of_grain_table_entries );

      libcnotify_printf(
       "%s: grain directory entry: %05" PRIu32 " file IO pool entry\t: %d\n",
       function,
       grain_directory_entry_index,
       file_io_pool_entry );

      libcnotify_printf(
       "%s: grain directory entry: %05" PRIu32 " range flags\t\t: 0x%08" PRIx64 "\n",
       function,
       grain_directory_entry_index,
       range_flags );

      if( ( range_flags & LIBVMDK_RANGE_FLAG_IS_SPARSE ) != 0 )
      {
        libcnotify_printf(
         "\tIs sparse.\n" );
      }
      libcnotify_printf(
       "\n" );
    }
#endif /* defined( HAVE_DEBUG_OUTPUT ) */

    storage_media_size = (size64_t) extent_file->grain_size * number_of_grain_table_entries;

    if( libfdata_list_append_element_with_mapped_size(
         extent_file->grain_groups_list,
         &element_index,
         file_io_pool_entry,
         grain_table_offset,
         (size64_t) extent_file->grain_table_size,
         range_flags,
         storage_media_size,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_APPEND_FAILED,
       "%s: unable to append element with mapped size to grain groups list.",
       function );

      goto on_error;
    }
    total_grain_data_size           += grain_data_size;
    grain_directory_entry           += sizeof( uint32_t );
    extent_file->storage_media_size += storage_media_size;
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    if( total_grain_data_size < extent_file->grain_directory_size )
    {
      result = libvmdk_extent_file_check_for_empty_block(
          grain_directory_entry,
          extent_file->grain_directory_size - total_grain_data_size,
                error );

      if( result == -1 )
      {
        libcerror_error_set(
         error,
         LIBCERROR_ERROR_DOMAIN_RUNTIME,
         LIBCERROR_RUNTIME_ERROR_GET_FAILED,
         "%s: unable to determine if remainder of grain directory is empty.",
         function );

        goto on_error;
      }
      else if( result == 0 )
      {
        libcnotify_printf(
         "%s: remainder of grain directory not empty.",
         function );
      }
    }
  }
#endif /* defined( HAVE_DEBUG_OUTPUT ) */

  memory_free(
   grain_directory_data );

  grain_directory_data = NULL;

  return( 1 );

on_error:
  if( grain_directory_data != NULL )
  {
    memory_free(
     grain_directory_data );
  }
  return( -1 );
}

/* Reads the backup grain directory
 * Returns 1 if successful or -1 on error
 */
int libvmdk_extent_file_read_backup_grain_directory(
     libvmdk_extent_file_t *extent_file,
     libbfio_pool_t *file_io_pool,
     int file_io_pool_entry,
     off64_t file_offset,
     libcerror_error_t **error )
{
  uint8_t *grain_directory_data        = NULL;
  uint8_t *grain_directory_entry       = NULL;
  static char *function                = "libvmdk_extent_file_read_backup_grain_directory";
  off64_t grain_group_offset           = 0;
  size64_t grain_data_size             = 0;
  size64_t grain_group_size            = 0;
  size64_t total_grain_data_size       = 0;
  ssize_t read_count                   = 0;
  uint32_t grain_directory_entry_index = 0;
  uint32_t grain_group_range_flags     = 0;
  int grain_group_file_io_pool_entry   = 0;
  int number_of_grain_table_entries    = 0;

#if defined( HAVE_DEBUG_OUTPUT )
  off64_t grain_table_offset           = 0;
  uint32_t range_flags                 = 0;
  int result                           = 0;
#endif

  if( extent_file == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid extent file.",
     function );

    return( -1 );
  }
  if( ( extent_file->grain_directory_size == 0 )
   || ( extent_file->grain_directory_size > (size_t) MEMORY_MAXIMUM_ALLOCATION_SIZE ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
     "%s: invalid extent file - grain directory size value out of bounds.",
     function );

    goto on_error;
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "%s: reading backup grain directory at offset: %" PRIi64 " (0x%08" PRIx64 ")\n",
     function,
     file_offset,
     file_offset );
  }
#endif
  if( libbfio_pool_seek_offset(
       file_io_pool,
       file_io_pool_entry,
       file_offset,
       SEEK_SET,
       error ) == -1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_SEEK_FAILED,
     "%s: unable to seek backup grain directory offset: %" PRIi64 ".",
     function,
     file_offset );

    goto on_error;
  }
  grain_directory_data = (uint8_t *) memory_allocate(
                                      sizeof( uint8_t ) * extent_file->grain_directory_size );

  if( grain_directory_data == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_MEMORY,
     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,
     "%s: unable to create grain directory data.",
     function );

    goto on_error;
  }
  read_count = libbfio_pool_read_buffer(
                file_io_pool,
                file_io_pool_entry,
                grain_directory_data,
                extent_file->grain_directory_size,
                error );

  if( read_count != (ssize_t) extent_file->grain_directory_size )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_READ_FAILED,
     "%s: unable to read grain directory data.",
     function );

    goto on_error;
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "%s: grain directory data:\n",
     function );
    libcnotify_print_data(
     grain_directory_data,
     extent_file->grain_directory_size,
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );
  }
#endif
  grain_directory_entry = grain_directory_data;

  for( grain_directory_entry_index = 0;
       grain_directory_entry_index < extent_file->number_of_grain_directory_entries;
       grain_directory_entry_index++ )
  {
#if defined( HAVE_DEBUG_OUTPUT )
    byte_stream_copy_to_uint32_little_endian(
     grain_directory_entry,
     grain_table_offset );

    if( libcnotify_verbose != 0 )
    {
      libcnotify_printf(
       "%s: grain directory entry: %05" PRIu32 " sector number\t\t: %" PRIi64 "\n",
       function,
       grain_directory_entry_index,
       grain_table_offset );
    }
    if( grain_table_offset != 0 )
    {
      range_flags         = 0;
      grain_table_offset *= 512;
    }
    else
    {
      range_flags = LIBVMDK_RANGE_FLAG_IS_SPARSE;
    }
#endif
    number_of_grain_table_entries = (int) extent_file->number_of_grain_table_entries;
    grain_data_size               = number_of_grain_table_entries * extent_file->grain_size;

    if( ( total_grain_data_size + grain_data_size ) > extent_file->maximum_data_size )
    {
      grain_data_size = extent_file->maximum_data_size - total_grain_data_size;

#if defined( HAVE_DEBUG_OUTPUT )
      number_of_grain_table_entries = (int) ( grain_data_size / extent_file->grain_size );

      if( ( grain_data_size % extent_file->grain_size ) != 0 )
      {
        number_of_grain_table_entries += 1;
      }
#endif
    }
#if defined( HAVE_DEBUG_OUTPUT )
    if( libcnotify_verbose != 0 )
    {
      libcnotify_printf(
       "%s: grain directory entry: %05" PRIu32 " offset\t\t\t: %" PRIi64 " (0x%08" PRIx64 ")\n",
       function,
       grain_directory_entry_index,
       grain_table_offset * 512,
       grain_table_offset * 512 );

      libcnotify_printf(
       "%s: grain directory entry: %05" PRIu32 " size\t\t\t: %" PRIu64 " (%d)\n",
       function,
       grain_directory_entry_index,
       grain_data_size,
       number_of_grain_table_entries );

      libcnotify_printf(
       "%s: grain directory entry: %05" PRIu32 " file IO pool entry\t: %d\n",
       function,
       grain_directory_entry_index,
       file_io_pool_entry );

      libcnotify_printf(
       "%s: grain directory entry: %05" PRIu32 " range flags\t\t: 0x%08" PRIx64 "\n",
       function,
       grain_directory_entry_index,
       range_flags );

      if( ( range_flags & LIBVMDK_RANGE_FLAG_IS_SPARSE ) != 0 )
      {
        libcnotify_printf(
         "\tIs sparse.\n" );
      }
      libcnotify_printf(
       "\n" );
    }
#endif /* defined( HAVE_DEBUG_OUTPUT ) */

    if( libfdata_list_get_element_by_index(
         extent_file->grain_groups_list,
         grain_directory_entry_index,
         &grain_group_file_io_pool_entry,
         &grain_group_offset,
         &grain_group_size,
         &grain_group_range_flags,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_RUNTIME,
       LIBCERROR_RUNTIME_ERROR_GET_FAILED,
       "%s: unable to retrieve element: %d from chunk groups list.",
       function,
       grain_directory_entry_index );

      goto on_error;
    }
/* TODO compare grain directory entry with back up ? */

    total_grain_data_size += grain_data_size;
    grain_directory_entry += sizeof( uint32_t );
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    if( total_grain_data_size < extent_file->grain_directory_size )
    {
      result = libvmdk_extent_file_check_for_empty_block(
          grain_directory_entry,
          extent_file->grain_directory_size - total_grain_data_size,
                error );

      if( result == -1 )
      {
        libcerror_error_set(
         error,
         LIBCERROR_ERROR_DOMAIN_RUNTIME,
         LIBCERROR_RUNTIME_ERROR_GET_FAILED,
         "%s: unable to determine if remainder of grain directory is empty.",
         function );

        goto on_error;
      }
      else if( result == 0 )
      {
        libcnotify_printf(
         "%s: remainder of grain directory not empty.",
         function );
      }
    }
  }
#endif /* defined( HAVE_DEBUG_OUTPUT ) */

  memory_free(
   grain_directory_data );

  grain_directory_data = NULL;

  return( 1 );

on_error:
  if( grain_directory_data != NULL )
  {
    memory_free(
     grain_directory_data );
  }
  return( -1 );
}

/* Reads the extent file
 * Callback function for the extent files list
 * Returns 1 if successful or -1 on error
 */
int libvmdk_extent_file_read_element_data(
     libvmdk_io_handle_t *io_handle,
     libbfio_pool_t *file_io_pool,
     libfdata_list_element_t *element,
     libfdata_cache_t *cache,
     int file_io_pool_entry,
     off64_t element_offset LIBVMDK_ATTRIBUTE_UNUSED,
     size64_t extent_file_size,
     uint32_t element_flags LIBVMDK_ATTRIBUTE_UNUSED,
     uint8_t read_flags LIBVMDK_ATTRIBUTE_UNUSED,
     libcerror_error_t **error )
{
  libvmdk_extent_file_t *extent_file = NULL;
  static char *function              = "libvmdk_extent_file_read_element_data";

  LIBVMDK_UNREFERENCED_PARAMETER( element_offset )
  LIBVMDK_UNREFERENCED_PARAMETER( element_flags )
  LIBVMDK_UNREFERENCED_PARAMETER( read_flags )

  if( io_handle == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid IO handle.",
     function );

    return( -1 );
  }
  if( libvmdk_extent_file_initialize(
       &extent_file,
       io_handle,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_INITIALIZE_FAILED,
     "%s: unable to create extent file.",
     function );

    goto on_error;
  }
  if( libvmdk_extent_file_read_file_header(
       extent_file,
       file_io_pool,
       file_io_pool_entry,
       0,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_READ_FAILED,
     "%s: unable to read extent file header from file IO pool entry: %d.",
     function,
     file_io_pool_entry );

    goto on_error;
  }
  if( ( extent_file->file_type == LIBVMDK_FILE_TYPE_VMDK_SPARSE_DATA )
   && ( extent_file->primary_grain_directory_offset == (off64_t) -1 )
   && ( extent_file->compression_method == LIBVMDK_COMPRESSION_METHOD_DEFLATE ) )
  {
    if( libvmdk_extent_file_read_file_header(
         extent_file,
         file_io_pool,
         file_io_pool_entry,
         extent_file_size - 1024,
         error ) != 1 )
    {
      libcerror_error_set(
       error,
       LIBCERROR_ERROR_DOMAIN_IO,
       LIBCERROR_IO_ERROR_READ_FAILED,
       "%s: unable to read secondary extent file header from file IO pool entry: %d.",
       function,
       file_io_pool_entry );

      goto on_error;
    }
  }
  if( libvmdk_extent_file_read_grain_directory(
       extent_file,
       file_io_pool,
       file_io_pool_entry,
       extent_file->primary_grain_directory_offset,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_READ_FAILED,
     "%s: unable to read primary grain directory.",
     function );

    goto on_error;
  }
  if( libfdata_list_element_set_element_value(
       element,
       (intptr_t *) file_io_pool,
       cache,
       (intptr_t *) extent_file,
       (int (*)(intptr_t **, libcerror_error_t **)) &libvmdk_extent_file_free,
       LIBFDATA_LIST_ELEMENT_VALUE_FLAG_MANAGED,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_SET_FAILED,
     "%s: unable to set extent file as element value.",
     function );

    goto on_error;
  }
  return( 1 );

on_error:
  if( extent_file != NULL )
  {
    libvmdk_extent_file_free(
     &extent_file,
     NULL );
  }
  return( -1 );
}

/* Reads a grain group
 * Callback function for the grain groups list
 * Returns 1 if successful or -1 on error
 */
int libvmdk_extent_file_read_grain_group_element_data(
     libvmdk_extent_file_t *extent_file,
     libbfio_pool_t *file_io_pool,
     libfdata_list_element_t *element,
     libfdata_cache_t *cache,
     int file_io_pool_entry,
     off64_t grain_group_data_offset,
     size64_t grain_group_data_size,
     uint32_t grain_group_data_flags,
     uint8_t read_flags LIBVMDK_ATTRIBUTE_UNUSED,
     libcerror_error_t **error )
{
  libfdata_list_t *grains_list = NULL;
  uint8_t *grain_table_data    = NULL;
  static char *function        = "libvmdk_extent_file_read_grain_group_element_data";
  ssize_t read_count           = 0;
  int grain_index              = 0;
  int number_of_entries        = 0;

  LIBVMDK_UNREFERENCED_PARAMETER( read_flags )

  if( extent_file == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid extent file.",
     function );

    return( -1 );
  }
  if( extent_file->grain_groups_list == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_MISSING,
     "%s: invalid extent file - missing grain groups list.",
     function );

    return( -1 );
  }
  if( extent_file->io_handle == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_MISSING,
     "%s: invalid extent file - missing IO handle.",
     function );

    return( -1 );
  }
  if( ( grain_group_data_size == 0 )
   || ( grain_group_data_size > (size64_t) MEMORY_MAXIMUM_ALLOCATION_SIZE ) )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
     "%s: invalid grain group data size value out of bounds.",
     function );

    goto on_error;
  }
  grain_table_data = (uint8_t *) memory_allocate(
                                  sizeof( uint8_t ) * (size_t) grain_group_data_size );

  if( grain_table_data == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_MEMORY,
     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,
     "%s: unable to create grain table data.",
     function );

    goto on_error;
  }
  if( ( grain_group_data_flags & LIBVMDK_RANGE_FLAG_IS_SPARSE ) != 0 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_UNSUPPORTED_VALUE,
     "%s: sparse grain table not supported.",
     function );

    goto on_error;
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "%s: reading grain table at offset: %" PRIi64 " (0x%08" PRIx64 ")\n",
     function,
     grain_group_data_offset,
     grain_group_data_offset );
  }
#endif
  if( libbfio_pool_seek_offset(
       file_io_pool,
       file_io_pool_entry,
       grain_group_data_offset,
       SEEK_SET,
       error ) == -1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_SEEK_FAILED,
     "%s: unable to seek grain table offset: %" PRIi64 ".",
     function,
     grain_group_data_offset );

    goto on_error;
  }
  read_count = libbfio_pool_read_buffer(
                file_io_pool,
                file_io_pool_entry,
                grain_table_data,
                (size_t) grain_group_data_size,
                error );

  if( read_count != (ssize_t) grain_group_data_size )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_READ_FAILED,
     "%s: unable to read grain table data.",
     function );

    goto on_error;
  }
#if defined( HAVE_DEBUG_OUTPUT )
  if( libcnotify_verbose != 0 )
  {
    libcnotify_printf(
     "%s: grain table data:\n",
     function );
    libcnotify_print_data(
     grain_table_data,
     (size_t) grain_group_data_size,
     LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );
  }
#endif
  if( libfdata_list_initialize(
       &grains_list,
       (intptr_t *) extent_file->io_handle,
       NULL,
       NULL,
       (int (*)(intptr_t *, intptr_t *, libfdata_list_element_t *, libfdata_cache_t *, int, off64_t, size64_t, uint32_t, uint8_t, libcerror_error_t **)) &libvmdk_grain_data_read_element_data,
       NULL,
       LIBFDATA_DATA_HANDLE_FLAG_NON_MANAGED,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_INITIALIZE_FAILED,
     "%s: unable to create grains list.",
     function );

    goto on_error;
  }
/* TODO makes sure to compensate for the last grain table */
  number_of_entries = extent_file->number_of_grain_table_entries;

  if( libvmdk_grain_group_fill(
       grains_list,
       grain_index,
       extent_file->io_handle->grain_size,
       file_io_pool,
       file_io_pool_entry,
       grain_table_data,
       (size_t) grain_group_data_size,
       number_of_entries,
       extent_file->flags,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_SET_FAILED,
     "%s: unable to fill grain table.",
     function );

    goto on_error;
  }
/* TODO what about backup range */
/* TODO check if remainder of sector block is empty */

  memory_free(
   grain_table_data );

  grain_table_data = NULL;

  if( libfdata_list_element_set_element_value(
       element,
       (intptr_t *) file_io_pool,
       cache,
       (intptr_t *) grains_list,
       (int (*)(intptr_t **, libcerror_error_t **)) &libfdata_list_free,
       LIBFDATA_LIST_ELEMENT_VALUE_FLAG_MANAGED,
       error ) != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_SET_FAILED,
     "%s: unable to set grains list as element value.",
     function );

    goto on_error;
  }
  return( 1 );

on_error:
  if( grains_list != NULL )
  {
    libfdata_list_free(
     &grains_list,
     NULL );
  }
  if( grain_table_data != NULL )
  {
    memory_free(
     grain_table_data );
  }
  return( -1 );
}

/* Determines if the grain group at a specific offset is sparse
 * Returns 1 if the grain is sparse, 0 if not or -1 on error
 */
int libvmdk_extent_file_grain_group_is_sparse_at_offset(
     libvmdk_extent_file_t *extent_file,
     off64_t offset,
     int *grain_group_index,
     off64_t *grain_group_data_offset,
     libcerror_error_t **error )
{
  static char *function      = "libvmdk_extent_file_grain_group_is_sparse_at_offset";
  off64_t grain_group_offset = 0;
  size64_t grain_group_size  = 0;
  uint32_t grain_group_flags = 0;
  int grain_group_file_index = 0;
  int result                 = 0;

  if( extent_file == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid extent file.",
     function );

    return( -1 );
  }
  result = libfdata_list_get_element_at_offset(
      extent_file->grain_groups_list,
      offset,
      grain_group_index,
      grain_group_data_offset,
      &grain_group_file_index,
      &grain_group_offset,
      &grain_group_size,
      &grain_group_flags,
      error );

  if( result != 1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_GET_FAILED,
     "%s: unable to retrieve grains group element at offset: %" PRIi64 ".",
     function,
     offset );

    return( -1 );
  }
  if( ( grain_group_flags & LIBVMDK_RANGE_FLAG_IS_SPARSE ) != 0 )
  {
    return( 1 );
  }
  return( 0 );
}

/* Retrieves the grain group at a specific offset
 * Returns 1 if successful, 0 if not or -1 on error
 */
int libvmdk_extent_file_get_grain_group_at_offset(
     libvmdk_extent_file_t *extent_file,
     libbfio_pool_t *file_io_pool,
     off64_t offset,
     int *grain_group_index,
     off64_t *grain_group_data_offset,
     libfdata_list_t **grains_list,
     libcerror_error_t **error )
{
  static char *function = "libvmdk_extent_file_get_grain_group_at_offset";
  int result            = 0;

  if( extent_file == NULL )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,
     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,
     "%s: invalid extent file.",
     function );

    return( -1 );
  }
  result = libfdata_list_get_element_value_at_offset(
      extent_file->grain_groups_list,
      (intptr_t *) file_io_pool,
      (libfdata_cache_t *) extent_file->grain_groups_cache,
      offset,
      grain_group_index,
      grain_group_data_offset,
      (intptr_t **) grains_list,
      0,
      error );

  if( result == -1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_RUNTIME,
     LIBCERROR_RUNTIME_ERROR_GET_FAILED,
     "%s: unable to retrieve grains list at offset: %" PRIi64 ".",
     function,
     offset );

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

/* Reads segment data into a buffer
 * Callback function for the segments stream
 * Returns the number of bytes read or -1 on error
 */
ssize_t libvmdk_extent_file_read_segment_data(
         intptr_t *data_handle LIBVMDK_ATTRIBUTE_UNUSED,
         libbfio_pool_t *file_io_pool,
         int segment_index LIBVMDK_ATTRIBUTE_UNUSED,
         int segment_file_index,
         uint8_t *segment_data,
         size_t segment_data_size,
         uint32_t segment_flags LIBVMDK_ATTRIBUTE_UNUSED,
         uint8_t read_flags LIBVMDK_ATTRIBUTE_UNUSED,
         libcerror_error_t **error )
{
  static char *function = "libvmdk_extent_file_read_segment_data";
  ssize_t read_count    = 0;

  LIBVMDK_UNREFERENCED_PARAMETER( data_handle )
  LIBVMDK_UNREFERENCED_PARAMETER( segment_index )
  LIBVMDK_UNREFERENCED_PARAMETER( segment_flags )
  LIBVMDK_UNREFERENCED_PARAMETER( read_flags )

  read_count = libbfio_pool_read_buffer(
                file_io_pool,
                segment_file_index,
                segment_data,
                segment_data_size,
                error );

  if( read_count == -1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_READ_FAILED,
     "%s: unable to read segment data.",
     function );

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

/* Seeks a certain segment offset
 * Callback function for the segments stream
 * Returns the offset or -1 on error
 */
off64_t libvmdk_extent_file_seek_segment_offset(
         intptr_t *data_handle LIBVMDK_ATTRIBUTE_UNUSED,
         libbfio_pool_t *file_io_pool,
         int segment_index LIBVMDK_ATTRIBUTE_UNUSED,
         int segment_file_index,
         off64_t segment_offset,
         libcerror_error_t **error )
{
  static char *function = "libvmdk_extent_file_seek_segment_offset";

  LIBVMDK_UNREFERENCED_PARAMETER( data_handle )
  LIBVMDK_UNREFERENCED_PARAMETER( segment_index )

  segment_offset = libbfio_pool_seek_offset(
                    file_io_pool,
                    segment_file_index,
                    segment_offset,
                    SEEK_SET,
                    error );

  if( segment_offset == -1 )
  {
    libcerror_error_set(
     error,
     LIBCERROR_ERROR_DOMAIN_IO,
     LIBCERROR_IO_ERROR_READ_FAILED,
     "%s: unable to seek segment offset.",
     function );

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


Coverage Report

Created: 2026-03-05 07:45