/*

 * Volume functions

 *

 * Copyright (C) 2011-2023, 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 <memory.h>

#include <narrow_string.h>

#include <types.h>

#include <wide_string.h>

#include "libvshadow_debug.h"

#include "libvshadow_definitions.h"

#include "libvshadow_io_handle.h"

#include "libvshadow_libbfio.h"

#include "libvshadow_libcdata.h"

#include "libvshadow_libcerror.h"

#include "libvshadow_libcnotify.h"

#include "libvshadow_libcthreads.h"

#include "libvshadow_ntfs_volume_header.h"

#include "libvshadow_store.h"

#include "libvshadow_store_descriptor.h"

#include "libvshadow_volume.h"

/* Creates a volume

 * ake sure the value volume is referencing, is set to NULL

 * Returns 1 if successful or -1 on error

 */

int libvshadow_volume_initialize(

     libvshadow_volume_t **volume,

     libcerror_error_t **error )

{

  libvshadow_internal_volume_t *internal_volume = NULL;

  static char *function                         = "libvshadow_volume_initialize";

  if( volume == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume.",

     function );

    return( -1 );

  }

  if( *volume != NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,

     "%s: invalid volume value already set.",

     function );

    return( -1 );

  }

  internal_volume = memory_allocate_structure(

                     libvshadow_internal_volume_t );

  if( internal_volume == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,

     "%s: unable to create volume.",

     function );

    goto on_error;

  }

  if( memory_set(

       internal_volume,

       0,

       sizeof( libvshadow_internal_volume_t ) ) == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_SET_FAILED,

     "%s: unable to clear volume.",

     function );

    memory_free(

     internal_volume );

    return( -1 );

  }

  if( libcdata_array_initialize(

       &( internal_volume->store_descriptors_array ),

       0,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_INITIALIZE_FAILED,

     "%s: unable to create store descriptors array.",

     function );

    goto on_error;

  }

  if( libvshadow_io_handle_initialize(

       &( internal_volume->io_handle ),

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_INITIALIZE_FAILED,

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

     function );

    goto on_error;

  }

#if defined( HAVE_LIBVSHADOW_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_initialize(

       &( internal_volume->read_write_lock ),

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_INITIALIZE_FAILED,

     "%s: unable to initialize read/write lock.",

     function );

    goto on_error;

  }

#endif

  *volume = (libvshadow_volume_t *) internal_volume;

  return( 1 );

on_error:

  if( internal_volume != NULL )

  {

    if( internal_volume->store_descriptors_array != NULL )

    {

      libcdata_array_free(

       &( internal_volume->store_descriptors_array ),

       (int (*)(intptr_t **, libcerror_error_t **)) &libvshadow_store_descriptor_free,

       NULL );

    }

    memory_free(

     internal_volume );

  }

  return( -1 );

}

/* Frees a volume

 * Returns 1 if successful or -1 on error

 */

int libvshadow_volume_free(

     libvshadow_volume_t **volume,

     libcerror_error_t **error )

{

  libvshadow_internal_volume_t *internal_volume = NULL;

  static char *function                         = "libvshadow_volume_free";

  int result                                    = 1;

  if( volume == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume.",

     function );

    return( -1 );

  }

  if( *volume != NULL )

  {

    internal_volume = (libvshadow_internal_volume_t *) *volume;

    if( internal_volume->file_io_handle != NULL )

    {

      if( libvshadow_volume_close(

           *volume,

           error ) != 0 )

      {

        libcerror_error_set(

         error,

         LIBCERROR_ERROR_DOMAIN_IO,

         LIBCERROR_IO_ERROR_CLOSE_FAILED,

         "%s: unable to close volume.",

         function );

        result = -1;

      }

    }

    *volume = NULL;

#if defined( HAVE_LIBVSHADOW_MULTI_THREAD_SUPPORT )

    if( libcthreads_read_write_lock_free(

         &( internal_volume->read_write_lock ),

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_FINALIZE_FAILED,

       "%s: unable to free read/write lock.",

       function );

      result = -1;

    }

#endif

    if( libcdata_array_free(

         &( internal_volume->store_descriptors_array ),

         (int (*)(intptr_t **, libcerror_error_t **)) &libvshadow_store_descriptor_free,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_FINALIZE_FAILED,

       "%s: unable to free store descriptors array.",

       function );

      result = -1;

    }

    if( libvshadow_io_handle_free(

         &( internal_volume->io_handle ),

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_FINALIZE_FAILED,

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

       function );

      result = -1;

    }

    memory_free(

     internal_volume );

  }

  return( result );

}

/* Signals the volume to abort its current activity

 * Returns 1 if successful or -1 on error

 */

int libvshadow_volume_signal_abort(

     libvshadow_volume_t *volume,

     libcerror_error_t **error )

{

  libvshadow_internal_volume_t *internal_volume = NULL;

  static char *function                         = "libvshadow_volume_signal_abort";

  if( volume == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume.",

     function );

    return( -1 );

  }

  internal_volume = (libvshadow_internal_volume_t *) volume;

  if( internal_volume->io_handle == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_MISSING,

     "%s: invalid volume - missing IO handle.",

     function );

    return( -1 );

  }

/* TODO multi-threading ? */

  internal_volume->io_handle->abort = 1;

  return( 1 );

}

/* Opens a volume

 * Returns 1 if successful or -1 on error

 */

int libvshadow_volume_open(

     libvshadow_volume_t *volume,

     const char *filename,

     int access_flags,

     libcerror_error_t **error )

{

  libbfio_handle_t *file_io_handle              = NULL;

  libvshadow_internal_volume_t *internal_volume = NULL;

  static char *function                         = "libvshadow_volume_open";

  if( volume == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume.",

     function );

    return( -1 );

  }

  internal_volume = (libvshadow_internal_volume_t *) volume;

  if( filename == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid filename.",

     function );

    return( -1 );

  }

  if( ( ( access_flags & LIBVSHADOW_ACCESS_FLAG_READ ) == 0 )

   && ( ( access_flags & LIBVSHADOW_ACCESS_FLAG_WRITE ) == 0 ) )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_UNSUPPORTED_VALUE,

     "%s: unsupported access flags.",

     function );

    return( -1 );

  }

  if( ( access_flags & LIBVSHADOW_ACCESS_FLAG_WRITE ) != 0 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_UNSUPPORTED_VALUE,

     "%s: write access currently not supported.",

     function );

    return( -1 );

  }

  if( libbfio_file_initialize(

       &file_io_handle,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_INITIALIZE_FAILED,

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

     function );

    goto on_error;

  }

#if defined( HAVE_DEBUG_OUTPUT )

  if( libbfio_handle_set_track_offsets_read(

       file_io_handle,

       1,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_SET_FAILED,

     "%s: unable to set track offsets read in file IO handle.",

     function );

    goto on_error;

  }

#endif

  if( libbfio_file_set_name(

       file_io_handle,

       filename,

       narrow_string_length(

        filename ) + 1,

       error ) != 1 )

  {

     libcerror_error_set(

      error,

      LIBCERROR_ERROR_DOMAIN_RUNTIME,

      LIBCERROR_RUNTIME_ERROR_SET_FAILED,

      "%s: unable to set filename in file IO handle.",

      function );

    goto on_error;

  }

  if( libvshadow_volume_open_file_io_handle(

       volume,

       file_io_handle,

       access_flags,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_IO,

     LIBCERROR_IO_ERROR_OPEN_FAILED,

     "%s: unable to open volume: %s.",

     function,

     filename );

    goto on_error;

  }

#if defined( HAVE_LIBVSHADOW_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_grab_for_write(

       internal_volume->read_write_lock,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_SET_FAILED,

     "%s: unable to grab read/write lock for writing.",

     function );

    return( -1 );

  }

#endif

  internal_volume->file_io_handle_created_in_library = 1;

#if defined( HAVE_LIBVSHADOW_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_release_for_write(

       internal_volume->read_write_lock,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_SET_FAILED,

     "%s: unable to release read/write lock for writing.",

     function );

    return( -1 );

  }

#endif

  return( 1 );

on_error:

  if( file_io_handle != NULL )

  {

    libbfio_handle_free(

     &file_io_handle,

     NULL );

  }

  return( -1 );

}

#if defined( HAVE_WIDE_CHARACTER_TYPE )

/* Opens a volume

 * Returns 1 if successful or -1 on error

 */

int libvshadow_volume_open_wide(

     libvshadow_volume_t *volume,

     const wchar_t *filename,

     int access_flags,

     libcerror_error_t **error )

{

  libbfio_handle_t *file_io_handle              = NULL;

  libvshadow_internal_volume_t *internal_volume = NULL;

  static char *function                         = "libvshadow_volume_open_wide";

  if( volume == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume.",

     function );

    return( -1 );

  }

  internal_volume = (libvshadow_internal_volume_t *) volume;

  if( filename == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid filename.",

     function );

    return( -1 );

  }

  if( ( ( access_flags & LIBVSHADOW_ACCESS_FLAG_READ ) == 0 )

   && ( ( access_flags & LIBVSHADOW_ACCESS_FLAG_WRITE ) == 0 ) )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_UNSUPPORTED_VALUE,

     "%s: unsupported access flags.",

     function );

    return( -1 );

  }

  if( ( access_flags & LIBVSHADOW_ACCESS_FLAG_WRITE ) != 0 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_UNSUPPORTED_VALUE,

     "%s: write access currently not supported.",

     function );

    return( -1 );

  }

  if( libbfio_file_initialize(

       &file_io_handle,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_INITIALIZE_FAILED,

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

     function );

    goto on_error;

  }

#if defined( HAVE_DEBUG_OUTPUT )

  if( libbfio_handle_set_track_offsets_read(

       file_io_handle,

       1,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_SET_FAILED,

     "%s: unable to set track offsets read in file IO handle.",

     function );

    goto on_error;

  }

#endif

  if( libbfio_file_set_name_wide(

       file_io_handle,

       filename,

       wide_string_length(

        filename ) + 1,

       error ) != 1 )

  {

     libcerror_error_set(

      error,

      LIBCERROR_ERROR_DOMAIN_RUNTIME,

      LIBCERROR_RUNTIME_ERROR_SET_FAILED,

      "%s: unable to set filename in file IO handle.",

      function );

    goto on_error;

  }

  if( libvshadow_volume_open_file_io_handle(

       volume,

       file_io_handle,

       access_flags,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_IO,

     LIBCERROR_IO_ERROR_OPEN_FAILED,

     "%s: unable to open volume: %ls.",

     function,

     filename );

    goto on_error;

  }

#if defined( HAVE_LIBVSHADOW_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_grab_for_write(

       internal_volume->read_write_lock,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_SET_FAILED,

     "%s: unable to grab read/write lock for writing.",

     function );

    return( -1 );

  }

#endif

  internal_volume->file_io_handle_created_in_library = 1;

#if defined( HAVE_LIBVSHADOW_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_release_for_write(

       internal_volume->read_write_lock,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_SET_FAILED,

     "%s: unable to release read/write lock for writing.",

     function );

    return( -1 );

  }

#endif

  return( 1 );

on_error:

  if( file_io_handle != NULL )

  {

    libbfio_handle_free(

     &file_io_handle,

     NULL );

  }

  return( -1 );

}

#endif /* defined( HAVE_WIDE_CHARACTER_TYPE ) */

/* Opens a volume using a Basic File IO (bfio) handle

 * Returns 1 if successful or -1 on error

 */

int libvshadow_volume_open_file_io_handle(

     libvshadow_volume_t *volume,

     libbfio_handle_t *file_io_handle,

     int access_flags,

     libcerror_error_t **error )

{

  libvshadow_internal_volume_t *internal_volume = NULL;

  static char *function                         = "libvshadow_volume_open_file_io_handle";

  uint8_t file_io_handle_opened_in_library      = 0;

  int bfio_access_flags                         = 0;

  int file_io_handle_is_open                    = 0;

  if( volume == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume.",

     function );

    return( -1 );

  }

  internal_volume = (libvshadow_internal_volume_t *) volume;

  if( file_io_handle == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid file IO handle.",

     function );

    return( -1 );

  }

  if( ( ( access_flags & LIBVSHADOW_ACCESS_FLAG_READ ) == 0 )

   && ( ( access_flags & LIBVSHADOW_ACCESS_FLAG_WRITE ) == 0 ) )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_UNSUPPORTED_VALUE,

     "%s: unsupported access flags.",

     function );

    return( -1 );

  }

  if( ( access_flags & LIBVSHADOW_ACCESS_FLAG_WRITE ) != 0 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_UNSUPPORTED_VALUE,

     "%s: write access currently not supported.",

     function );

    return( -1 );

  }

  if( ( access_flags & LIBVSHADOW_ACCESS_FLAG_READ ) != 0 )

  {

    bfio_access_flags = LIBBFIO_ACCESS_FLAG_READ;

  }

  file_io_handle_is_open = libbfio_handle_is_open(

                            file_io_handle,

                            error );

  if( file_io_handle_is_open == -1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_IO,

     LIBCERROR_IO_ERROR_OPEN_FAILED,

     "%s: unable to determine if file IO handle is open.",

     function );

    goto on_error;

  }

  else if( file_io_handle_is_open == 0 )

  {

    if( libbfio_handle_open(

         file_io_handle,

         bfio_access_flags,

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_IO,

       LIBCERROR_IO_ERROR_OPEN_FAILED,

       "%s: unable to open file IO handle.",

       function );

      goto on_error;

    }

    file_io_handle_opened_in_library = 1;

  }

  if( libvshadow_volume_open_read(

       internal_volume,

       file_io_handle,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_IO,

     LIBCERROR_IO_ERROR_READ_FAILED,

     "%s: unable to read from file IO handle.",

     function );

    goto on_error;

  }

#if defined( HAVE_LIBVSHADOW_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_grab_for_write(

       internal_volume->read_write_lock,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_SET_FAILED,

     "%s: unable to grab read/write lock for writing.",

     function );

    return( -1 );

  }

#endif

  internal_volume->file_io_handle                   = file_io_handle;

  internal_volume->file_io_handle_opened_in_library = file_io_handle_opened_in_library;

#if defined( HAVE_LIBVSHADOW_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_release_for_write(

       internal_volume->read_write_lock,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_SET_FAILED,

     "%s: unable to release read/write lock for writing.",

     function );

    return( -1 );

  }

#endif

  return( 1 );

on_error:

  if( file_io_handle_opened_in_library != 0 )

  {

    libbfio_handle_close(

     file_io_handle,

     NULL );

  }

  return( -1 );

}

/* Closes a volume

 * Returns 0 if successful or -1 on error

 */

int libvshadow_volume_close(

     libvshadow_volume_t *volume,

     libcerror_error_t **error )

{

  libvshadow_internal_volume_t *internal_volume = NULL;

  static char *function                         = "libvshadow_volume_close";

  int result                                    = 0;

  if( volume == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume.",

     function );

    return( -1 );

  }

  internal_volume = (libvshadow_internal_volume_t *) volume;

  if( internal_volume->file_io_handle == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_MISSING,

     "%s: invalid volume - missing file IO handle.",

     function );

    return( -1 );

  }

#if defined( HAVE_LIBVSHADOW_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_grab_for_write(

       internal_volume->read_write_lock,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_SET_FAILED,

     "%s: unable to grab read/write lock for writing.",

     function );

    return( -1 );

  }

#endif

#if defined( HAVE_DEBUG_OUTPUT )

  if( libcnotify_verbose != 0 )

  {

    if( internal_volume->file_io_handle_created_in_library != 0 )

    {

      if( libvshadow_debug_print_read_offsets(

           internal_volume->file_io_handle,

           error ) != 1 )

      {

        libcerror_error_set(

         error,

         LIBCERROR_ERROR_DOMAIN_RUNTIME,

         LIBCERROR_RUNTIME_ERROR_PRINT_FAILED,

         "%s: unable to print the read offsets.",

         function );

      }

    }

  }

#endif

  if( internal_volume->file_io_handle_opened_in_library != 0 )

  {

    if( libbfio_handle_close(

         internal_volume->file_io_handle,

         error ) != 0 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_IO,

       LIBCERROR_IO_ERROR_CLOSE_FAILED,

       "%s: unable to close file IO handle.",

       function );

      result = -1;

    }

    internal_volume->file_io_handle_opened_in_library = 0;

  }

  if( internal_volume->file_io_handle_created_in_library != 0 )

  {

    if( libbfio_handle_free(

         &( internal_volume->file_io_handle ),

         error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_FINALIZE_FAILED,

       "%s: unable to free file IO handle.",

       function );

      result = -1;

    }

    internal_volume->file_io_handle_created_in_library = 0;

  }

  internal_volume->file_io_handle = NULL;

  internal_volume->size           = 0;

  if( libvshadow_io_handle_clear(

       internal_volume->io_handle,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_FINALIZE_FAILED,

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

     function );

    result = -1;

  }

  if( libcdata_array_empty(

       internal_volume->store_descriptors_array,

       (int (*)(intptr_t **, libcerror_error_t **)) &libvshadow_store_descriptor_free,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_FINALIZE_FAILED,

     "%s: unable to empty store descriptors array.",

     function );

    result = -1;

  }

#if defined( HAVE_LIBVSHADOW_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_release_for_write(

       internal_volume->read_write_lock,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_SET_FAILED,

     "%s: unable to release read/write lock for writing.",

     function );

    return( -1 );

  }

#endif

  return( result );

}

/* Opens a volume for reading

 * Returns 1 if successful or -1 on error

 */

int libvshadow_volume_open_read(

     libvshadow_internal_volume_t *internal_volume,

     libbfio_handle_t *file_io_handle,

     libcerror_error_t **error )

{

  libvshadow_store_descriptor_t *last_store_descriptor = NULL;

  libvshadow_store_descriptor_t *store_descriptor      = NULL;

  static char *function                                = "libvshadow_volume_open_read";

  off64_t catalog_offset                               = 0;

  int number_of_store_descriptors                      = 0;

  int store_descriptor_index                           = 0;

  if( internal_volume == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume.",

     function );

    return( -1 );

  }

  if( internal_volume->io_handle == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_MISSING,