/*

 * Input/Output (IO) handle functions

 *

 * Copyright (C) 2008-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 "libolecf_allocation_table.h"

#include "libolecf_codepage.h"

#include "libolecf_debug.h"

#include "libolecf_definitions.h"

#include "libolecf_directory_entry.h"

#include "libolecf_io_handle.h"

#include "libolecf_libbfio.h"

#include "libolecf_libcdata.h"

#include "libolecf_libcerror.h"

#include "libolecf_libcnotify.h"

#include "libolecf_libfguid.h"

#include "libolecf_libuna.h"

#include "libolecf_notify.h"

#include "olecf_directory.h"

#include "olecf_file_header.h"

const uint8_t olecf_file_signature[ 8 ]      = { 0xd0, 0xcf, 0x11, 0xe0, 0xa1, 0xb1, 0x1a, 0xe1 };

const uint8_t olecf_beta_file_signature[ 8 ] = { 0x0e, 0x11, 0xfc, 0x0d, 0xd0, 0xcf, 0x11, 0x0e };

/* Creates an IO handle

 * Make sure the value io_handle is referencing, is set to NULL

 * Returns 1 if successful or -1 on error

 */

int libolecf_io_handle_initialize(

     libolecf_io_handle_t **io_handle,

     libcerror_error_t **error )

{

  static char *function = "libolecf_io_handle_initialize";

  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( *io_handle != NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,

     "%s: invalid IO handle value already set.",

     function );

    return( -1 );

  }

  *io_handle = memory_allocate_structure(

                libolecf_io_handle_t );

  if( *io_handle == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,

     "%s: unable to create IO handle.",

     function );

    goto on_error;

  }

  if( memory_set(

       *io_handle,

       0,

       sizeof( libolecf_io_handle_t ) ) == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_SET_FAILED,

     "%s: unable to clear IO handle.",

     function );

    memory_free(

     *io_handle );

    *io_handle = NULL;

    return( -1 );

  }

  ( *io_handle )->ascii_codepage = LIBOLECF_CODEPAGE_WINDOWS_1252;

  return( 1 );

on_error:

  if( *io_handle != NULL )

  {

    memory_free(

     *io_handle );

    *io_handle = NULL;

  }

  return( -1 );

}

/* Frees an IO handle

 * Returns 1 if successful or -1 on error

 */

int libolecf_io_handle_free(

     libolecf_io_handle_t **io_handle,

     libcerror_error_t **error )

{

  static char *function = "libolecf_io_handle_free";

  int result            = 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 );

  }

  if( *io_handle != NULL )

  {

    memory_free(

     *io_handle );

    *io_handle = NULL;

  }

  return( result );

}

/* Clears an IO handle

 * Returns 1 if successful or -1 on error

 */

int libolecf_io_handle_clear(

     libolecf_io_handle_t *io_handle,

     libcerror_error_t **error )

{

  static char *function = "libolecf_io_handle_clear";

  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( memory_set(

       io_handle,

       0,

       sizeof( libolecf_io_handle_t ) ) == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_SET_FAILED,

     "%s: unable to clear IO handle.",

     function );

    return( -1 );

  }

  io_handle->ascii_codepage = LIBOLECF_CODEPAGE_WINDOWS_1252;

  return( 1 );

}

/* Reads the MSAT

 * This function assumes the first 109 MSAT sector identifiers in the file header are read into the MSAT

 * Returns 1 if successful or -1 on error

 */

int libolecf_io_handle_read_msat(

     libolecf_io_handle_t *io_handle,

     libbfio_handle_t *file_io_handle,

     libolecf_allocation_table_t *msat,

     uint32_t msat_sector_identifier,

     uint32_t number_of_msat_sectors,

     libcerror_error_t **error )

{

  uint8_t *msat_sector                 = NULL;

  uint8_t *msat_entry                  = NULL;

  static char *function                = "libolecf_io_handle_read_msat";

  off64_t msat_sector_offset           = 0;

  size_t number_of_msat_sector_entries = 0;

  ssize_t read_count                   = 0;

  int number_of_msat_entries           = 0;

  int msat_index                       = 109;

  int msat_sector_index                = 0;

  int recursion_depth                  = 0;

  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( ( io_handle->sector_size == 0 )

   || ( io_handle->sector_size > (size_t) MEMORY_MAXIMUM_ALLOCATION_SIZE ) )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,

     "%s: invalid IO handle - sector size value out of bounds.",

     function );

    return( -1 );

  }

  if( msat == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid MSAT.",

     function );

    return( -1 );

  }

  if( msat->number_of_sector_identifiers < 109 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,

     "%s: invalid IO handle - invalid MSAT - number of sector identifiers too small.",

     function );

    return( -1 );

  }

  /* Check if the MSAT is already fully read

   */

  if( ( msat_sector_identifier == LIBOLECF_SECTOR_IDENTIFIER_END_OF_CHAIN )

   && ( number_of_msat_sectors == 0 ) )

  {

    return( 1 );

  }

  if( msat_sector_identifier == LIBOLECF_SECTOR_IDENTIFIER_END_OF_CHAIN )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_MISSING,

     "%s: invalid MSAT sector identifier.",

     function );

    return( -1 );

  }

  if( number_of_msat_sectors == 0 )

  {

#if defined( HAVE_VERBOSE_OUTPUT ) || defined( HAVE_DEBUG_OUTPUT )

    if( libcnotify_verbose != 0 )

    {

      libcnotify_printf(

       "%s: mismatch between number of MSAT sectors and MSAT sector identifier\n",

       function );

    }

#endif

    number_of_msat_sectors = 1;

  }

  number_of_msat_sector_entries = io_handle->sector_size / 4;

  if( number_of_msat_sector_entries == 0 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,

     "%s: invalid number of MSAT sector entries value out of bounds.",

     function );

    goto on_error;

  }

  /* The last MSAT entry is reserved for the next MSAT sector identifier.

   */

  number_of_msat_sector_entries -= 1;

  number_of_msat_entries = 109 + ( number_of_msat_sectors * number_of_msat_sector_entries );

  if( msat->number_of_sector_identifiers < number_of_msat_entries )

  {

    if( libolecf_allocation_table_resize(

         msat,

         number_of_msat_entries,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_RESIZE_FAILED,

       "%s: unable to resize MSAT.",

       function );

      goto on_error;

    }

  }

  msat_sector = (uint8_t *) memory_allocate(

                             sizeof( uint8_t ) * io_handle->sector_size );

  if( msat_sector == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,

     "%s: unable to create MSAT sector.",

     function );

    goto on_error;

  }

  while( msat_sector_identifier != LIBOLECF_SECTOR_IDENTIFIER_END_OF_CHAIN )

  {

    if( recursion_depth > LIBOLECF_MAXIMUM_ALLOCATION_TABLE_RECURSION_DEPTH )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,

       "%s: invalid recursion depth value out of bounds.",

       function );

      goto on_error;

    }

    recursion_depth++;

    if( msat_index >= msat->number_of_sector_identifiers )

    {

      break;

    }

    msat_sector_offset = ( msat_sector_identifier + 1 ) * io_handle->sector_size;

#if defined( HAVE_DEBUG_OUTPUT )

    if( libcnotify_verbose != 0 )

    {

      libcnotify_printf(

       "%s: MSAT sector offset\t\t\t: %" PRIi64 " (0x%08" PRIx64 ")\n",

       function,

       msat_sector_offset,

       msat_sector_offset );

    }

#endif

    read_count = libbfio_handle_read_buffer_at_offset(

            file_io_handle,

            msat_sector,

            io_handle->sector_size,

            msat_sector_offset,

            error );

    if( read_count != (ssize_t) io_handle->sector_size )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_IO,

       LIBCERROR_IO_ERROR_READ_FAILED,

       "%s: unable to read MSAT sector at offset: %" PRIi64 " (0x%08" PRIx64 ").",

       function,

       msat_sector_offset,

       msat_sector_offset );

      goto on_error;

    }

#if defined( HAVE_DEBUG_OUTPUT )

    if( libcnotify_verbose != 0 )

    {

      libcnotify_printf(

       "%s: MSAT sector:\n",

       function );

      libcnotify_print_data(

       msat_sector,

       io_handle->sector_size,

       LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );

    }

#endif

    msat_entry = msat_sector;

    for( msat_sector_index = 0;

         (size_t) msat_sector_index < number_of_msat_sector_entries;

         msat_sector_index++ )

    {

      if( ( msat_index < 0 )

       || ( msat_index >= msat->number_of_sector_identifiers ) )

      {

        libcerror_error_set(

         error,

         LIBCERROR_ERROR_DOMAIN_RUNTIME,

         LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,

         "%s: invalid MSAT entry: %04d value out of bounds.",

         function,

         msat_index );

        goto on_error;

      }

      if( io_handle->byte_order == LIBOLECF_ENDIAN_LITTLE )

      {

        byte_stream_copy_to_uint32_little_endian(

         msat_entry,

         msat->sector_identifiers[ msat_index ] );

      }

      else if( io_handle->byte_order == LIBOLECF_ENDIAN_BIG )

      {

        byte_stream_copy_to_uint32_big_endian(

         msat_entry,

         msat->sector_identifiers[ msat_index ] );

      }

#if defined( HAVE_DEBUG_OUTPUT )

      if( libcnotify_verbose != 0 )

      {

        libcnotify_printf(

         "%s: MSAT entry: %03d sector identifier\t: 0x%08" PRIx32 "\n",

         function,

         msat_index,

         msat->sector_identifiers[ msat_index ] );

      }

#endif

      msat_entry += 4;

      msat_index++;

    }

    if( io_handle->byte_order == LIBOLECF_ENDIAN_LITTLE )

    {

      byte_stream_copy_to_uint32_little_endian(

       msat_entry,

       msat_sector_identifier );

    }

    else if( io_handle->byte_order == LIBOLECF_ENDIAN_BIG )

    {

      byte_stream_copy_to_uint32_big_endian(

       msat_entry,

       msat_sector_identifier );

    }

#if defined( HAVE_DEBUG_OUTPUT )

    if( libcnotify_verbose != 0 )

    {

      libcnotify_printf(

       "%s: MSAT sector identifier\t\t: 0x%08" PRIx32 "\n",

       function,

       msat_sector_identifier );

      libcnotify_printf(

       "\n" );

    }

#endif

  }

  memory_free(

   msat_sector );

  return( 1 );

on_error:

  if( msat_sector != NULL )

  {

    memory_free(

     msat_sector );

  }

  return( -1 );

}

/* Reads the SAT

 * This function requires that the MSAT was read

 * Returns 1 if successful or -1 on error

 */

int libolecf_io_handle_read_sat(

     libolecf_io_handle_t *io_handle,

     libbfio_handle_t *file_io_handle,

     libolecf_allocation_table_t *msat,

     libolecf_allocation_table_t *sat,

     uint32_t number_of_sat_sectors,

     libcerror_error_t **error )

{

  uint8_t *sat_sector                 = NULL;

  uint8_t *sat_entry                  = NULL;

  static char *function               = "libolecf_io_handle_read_sat";

  off64_t sat_sector_offset           = 0;

  size_t number_of_sat_sector_entries = 0;

  ssize_t read_count                  = 0;

  int number_of_sat_entries           = 0;

  int msat_index                      = 0;

  int sat_index                       = 0;

  int sat_sector_index                = 0;

  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( ( io_handle->sector_size == 0 )

   || ( io_handle->sector_size > (size_t) MEMORY_MAXIMUM_ALLOCATION_SIZE ) )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,

     "%s: invalid IO handle - sector size value out of bounds.",

     function );

    return( -1 );

  }

  if( msat == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid MSAT.",

     function );

    return( -1 );

  }

  if( sat == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid SAT.",

     function );

    return( -1 );

  }

  number_of_sat_sector_entries = io_handle->sector_size / 4;

  number_of_sat_entries        = number_of_sat_sectors * number_of_sat_sector_entries;

  if( sat->number_of_sector_identifiers < number_of_sat_entries )

  {

    if( libolecf_allocation_table_resize(

         sat,

         number_of_sat_entries,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_RESIZE_FAILED,

       "%s: unable to resize SAT.",

       function );

      goto on_error;

    }

  }

  sat_sector = (uint8_t *) memory_allocate(

                            sizeof( uint8_t ) * io_handle->sector_size );

  if( sat_sector == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,

     "%s: unable to create SAT sector.",

     function );

    goto on_error;

  }

  for( msat_index = 0;

       msat_index < msat->number_of_sector_identifiers;

       msat_index++ )

  {

#if defined( HAVE_DEBUG_OUTPUT )

    if( libcnotify_verbose != 0 )

    {

      libcnotify_printf(

       "%s: MSAT entry: %03d sector identifier\t\t: 0x%08" PRIx32 "\n",

       function,

       msat_index,

       msat->sector_identifiers[ msat_index ] );

    }

#endif

    /* Skip empty sector identifiers

     */

    if( msat->sector_identifiers[ msat_index ] == LIBOLECF_SECTOR_IDENTIFIER_UNUSED )

    {

#if defined( HAVE_DEBUG_OUTPUT )

      if( libcnotify_verbose != 0 )

      {

        libcnotify_printf(

         "\n" );

      }

#endif

      continue;

    }

    if( sat_index >= sat->number_of_sector_identifiers )

    {

      break;

    }

    sat_sector_offset = ( msat->sector_identifiers[ msat_index ] + 1 ) * io_handle->sector_size;

#if defined( HAVE_DEBUG_OUTPUT )

    if( libcnotify_verbose != 0 )

    {

      libcnotify_printf(

       "%s: SAT sector offset\t\t\t\t: %" PRIi64 " (0x%08" PRIx64 ")\n",

       function,

       sat_sector_offset,

       sat_sector_offset );

    }

#endif

    read_count = libbfio_handle_read_buffer_at_offset(

            file_io_handle,

            sat_sector,

            io_handle->sector_size,

            sat_sector_offset,

            error );

    if( read_count != (ssize_t) io_handle->sector_size )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_IO,

       LIBCERROR_IO_ERROR_READ_FAILED,

       "%s: unable to read SAT sector at offset: %" PRIi64 " (0x%08" PRIx64 ").",

       function,

       sat_sector_offset,

       sat_sector_offset );

      goto on_error;

    }

#if defined( HAVE_DEBUG_OUTPUT )

    if( libcnotify_verbose != 0 )

    {

      libcnotify_printf(

       "%s: SAT sector:\n",

       function );

      libcnotify_print_data(

       sat_sector,

       io_handle->sector_size,

       LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );

    }

#endif

    sat_entry = sat_sector;

    for( sat_sector_index = 0;

         (size_t) sat_sector_index < number_of_sat_sector_entries;

         sat_sector_index++ )

    {

      if( io_handle->byte_order == LIBOLECF_ENDIAN_LITTLE )

      {

        byte_stream_copy_to_uint32_little_endian(

         sat_entry,

         sat->sector_identifiers[ sat_index ] );

      }

      else if( io_handle->byte_order == LIBOLECF_ENDIAN_BIG )

      {

        byte_stream_copy_to_uint32_big_endian(

         sat_entry,

         sat->sector_identifiers[ sat_index ] );

      }

#if defined( HAVE_DEBUG_OUTPUT )

      if( libcnotify_verbose != 0 )

      {

        libcnotify_printf(

         "%s: SAT entry: %04d sector identifier\t\t: 0x%08" PRIx32 "\n",

         function,

         sat_index,

         sat->sector_identifiers[ sat_index ] );

      }

#endif

      sat_entry += 4;

      sat_index++;

    }

#if defined( HAVE_DEBUG_OUTPUT )

    if( libcnotify_verbose != 0 )

    {

      libcnotify_printf(

       "\n" );

    }

#endif

  }

  memory_free(

   sat_sector );

  return( 1 );

on_error:

  if( sat_sector != NULL )

  {

    memory_free(

     sat_sector );

  }

  return( 1 );

}

/* Reads the SSAT

 * This function requires that the SAT was read

 * Returns 1 if successful or -1 on error

 */

int libolecf_io_handle_read_ssat(

     libolecf_io_handle_t *io_handle,

     libbfio_handle_t *file_io_handle,

     libolecf_allocation_table_t *sat,

     libolecf_allocation_table_t *ssat,

     uint32_t ssat_sector_identifier,

     uint32_t number_of_ssat_sectors,

     libcerror_error_t **error )

{

  uint8_t *ssat_sector                 = NULL;

  uint8_t *ssat_entry                  = NULL;

  static char *function                = "libolecf_io_handle_read_ssat";

  off64_t ssat_sector_offset           = 0;

  size_t number_of_ssat_sector_entries = 0;

  ssize_t read_count                   = 0;

  uint32_t ssat_sector_index           = 0;

  int number_of_ssat_entries           = 0;

  int recursion_depth                  = 0;

  int ssat_index                       = 0;

  int ssat_sector_entry_index          = 0;

  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( ( io_handle->sector_size == 0 )

   || ( io_handle->sector_size > (size_t) MEMORY_MAXIMUM_ALLOCATION_SIZE ) )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,

     "%s: invalid IO handle - sector size value out of bounds.",

     function );

    return( -1 );

  }

  if( sat == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid SAT.",

     function );

    return( -1 );

  }

  if( ssat == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid SSAT.",

     function );

    return( -1 );

  }

  number_of_ssat_sector_entries = io_handle->sector_size / 4;

  number_of_ssat_entries        = number_of_ssat_sectors * number_of_ssat_sector_entries;

  if( ssat->number_of_sector_identifiers < number_of_ssat_entries )

  {

    if( libolecf_allocation_table_resize(

         ssat,

         number_of_ssat_entries,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_RESIZE_FAILED,

       "%s: unable to resize SSAT.",

       function );

      goto on_error;

    }

  }

  ssat_sector = (uint8_t *) memory_allocate(

                             sizeof( uint8_t ) * io_handle->sector_size );

  if( ssat_sector == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,

     "%s: unable to create SSAT sector.",

     function );

    goto on_error;

  }

  while( ssat_sector_identifier != LIBOLECF_SECTOR_IDENTIFIER_END_OF_CHAIN )

  {

    if( recursion_depth > LIBOLECF_MAXIMUM_ALLOCATION_TABLE_RECURSION_DEPTH )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,

       "%s: invalid recursion depth value out of bounds.",

       function );

      goto on_error;

    }

    recursion_depth++;

#if defined( HAVE_DEBUG_OUTPUT )

    if( libcnotify_verbose != 0 )

    {

      libcnotify_printf(

       "%s: SSAT sector identifier\t\t\t: 0x%08" PRIx32 "\n",

       function,

       ssat_sector_identifier );

    }

#endif

    if( ssat_sector_index >= number_of_ssat_sectors )

    {

      break;

    }

    /* Skip empty sector identifiers

     */

    if( ssat_sector_identifier == LIBOLECF_SECTOR_IDENTIFIER_UNUSED )

    {

#if defined( HAVE_DEBUG_OUTPUT )

      if( libcnotify_verbose != 0 )

      {

        libcnotify_printf(

         "\n" );

      }

#endif

      ssat_sector_index++;

      continue;

    }

    ssat_sector_offset = ( ssat_sector_identifier + 1 ) * io_handle->sector_size;

#if defined( HAVE_DEBUG_OUTPUT )

    if( libcnotify_verbose != 0 )

    {

      libcnotify_printf(

       "%s: SSAT sector offset\t\t\t: %" PRIi64 " (0x%08" PRIx64 ")\n",

       function,

       ssat_sector_offset,

       ssat_sector_offset );

    }

#endif

    read_count = libbfio_handle_read_buffer_at_offset(

            file_io_handle,

            ssat_sector,

            io_handle->sector_size,

            ssat_sector_offset,

            error );

    if( read_count != (ssize_t) io_handle->sector_size )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_IO,

       LIBCERROR_IO_ERROR_READ_FAILED,

       "%s: unable to read SSAT sector at offset: %" PRIi64 " (0x%08" PRIx64 ").",

       function,

       ssat_sector_offset,

       ssat_sector_offset );

      goto on_error;

    }

#if defined( HAVE_DEBUG_OUTPUT )

    if( libcnotify_verbose != 0 )

    {

      libcnotify_printf(

       "%s: SSAT sector:\n",

       function );

      libcnotify_print_data(

       ssat_sector,

       io_handle->sector_size,

       LIBCNOTIFY_PRINT_DATA_FLAG_GROUP_DATA );

    }

#endif

    ssat_entry = ssat_sector;

    for( ssat_sector_entry_index = 0;

         (size_t) ssat_sector_entry_index < number_of_ssat_sector_entries;

         ssat_sector_entry_index++ )

    {

      if( ( ssat_index < 0 )

       || ( ssat_index >= ssat->number_of_sector_identifiers ) )

      {

        libcerror_error_set(

         error,

         LIBCERROR_ERROR_DOMAIN_RUNTIME,

         LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,

         "%s: invalid SSAT entry: %04d value out of bounds.",

         function,

         ssat_index );

        goto on_error;

      }

      if( io_handle->byte_order == LIBOLECF_ENDIAN_LITTLE )

      {

        byte_stream_copy_to_uint32_little_endian(

         ssat_entry,

         ssat->sector_identifiers[ ssat_index ] );

      }

      else if( io_handle->byte_order == LIBOLECF_ENDIAN_BIG )

      {

        byte_stream_copy_to_uint32_big_endian(

         ssat_entry,

         ssat->sector_identifiers[ ssat_index ] );

      }

#if defined( HAVE_DEBUG_OUTPUT )

      if( libcnotify_verbose != 0 )

      {

        libcnotify_printf(

         "%s: SSAT entry: %04d sector identifier\t: 0x%08" PRIx32 "\n",

         function,

         ssat_index,

         ssat->sector_identifiers[ ssat_index ] );

      }

#endif

      ssat_entry += 4;

      ssat_index++;

    }

#if defined( HAVE_DEBUG_OUTPUT )

    if( libcnotify_verbose != 0 )

    {

      libcnotify_printf(

       "\n" );

    }

#endif

#if SIZE_OF_INT <= 4

    if( ssat_sector_identifier > (uint32_t) INT_MAX )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,

       "%s: invalid SSAT sector identifier: 0x%08" PRIx32 " value out of bounds.",

       function,

       ssat_sector_identifier );

      goto on_error;

    }

#endif

    if( libolecf_allocation_table_get_sector_identifier_by_index(

         sat,

         (int) ssat_sector_identifier,

         &ssat_sector_identifier,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_GET_FAILED,

       "%s: unable to retrieve sector identifier: %" PRIu32 " from SAT.",

       function,

       ssat_sector_identifier );

      goto on_error;

    }

    ssat_sector_index++;

  }

  memory_free(

   ssat_sector );

  return( 1 );

on_error:

  if( ssat_sector != NULL )

  {

    memory_free(

     ssat_sector );

  }

  return( 1 );

}