/*

 * Volume group functions

 *

 * Copyright (C) 2011-2025, Omar Choudary <choudary.omar@gmail.com>,

 *                          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 <types.h>

#include "libfvde_encrypted_metadata.h"

#include "libfvde_encryption_context_plist.h"

#include "libfvde_io_handle.h"

#include "libfvde_libcerror.h"

#include "libfvde_libcthreads.h"

#include "libfvde_logical_volume.h"

#include "libfvde_metadata.h"

#include "libfvde_physical_volume.h"

#include "libfvde_physical_volume_descriptor.h"

#include "libfvde_types.h"

#include "libfvde_volume_group.h"

#include "libfvde_volume_header.h"

/* Creates a volume group

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

 * Returns 1 if successful or -1 on error

 */

int libfvde_volume_group_initialize(

     libfvde_volume_group_t **volume_group,

     libfvde_io_handle_t *io_handle,

     libbfio_pool_t *file_io_pool,

     libfvde_volume_header_t *volume_header,

     libfvde_metadata_t *metadata,

     libfvde_encrypted_metadata_t *encrypted_metadata,

     libfvde_encryption_context_plist_t *encrypted_root_plist,

     libcerror_error_t **error )

{

  libfvde_internal_volume_group_t *internal_volume_group = NULL;

  static char *function                                  = "libfvde_volume_group_initialize";

  if( volume_group == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume group.",

     function );

    return( -1 );

  }

  if( *volume_group != NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,

     "%s: invalid volume group 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 );

  }

  if( volume_header == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume header.",

     function );

    return( -1 );

  }

/* TODO check if metadata is set */

/* TODO check if encrypted_metadata is set */

/* TODO check if encrypted_root_plist is set */

  internal_volume_group = memory_allocate_structure(

                           libfvde_internal_volume_group_t );

  if( internal_volume_group == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,

     "%s: unable to create volume group.",

     function );

    goto on_error;

  }

  if( memory_set(

       internal_volume_group,

       0,

       sizeof( libfvde_internal_volume_group_t ) ) == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_SET_FAILED,

     "%s: unable to clear volume group.",

     function );

    memory_free(

     internal_volume_group );

    return( -1 );

  }

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_initialize(

       &( internal_volume_group->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

  internal_volume_group->io_handle            = io_handle;

  internal_volume_group->file_io_pool         = file_io_pool;

  internal_volume_group->volume_header        = volume_header;

  internal_volume_group->metadata             = metadata;

  internal_volume_group->encrypted_metadata   = encrypted_metadata;

  internal_volume_group->encrypted_root_plist = encrypted_root_plist;

  *volume_group = (libfvde_volume_group_t *) internal_volume_group;

  return( 1 );

on_error:

  if( internal_volume_group != NULL )

  {

    memory_free(

     internal_volume_group );

  }

  return( -1 );

}

/* Frees a volume group

 * Returns 1 if successful or -1 on error

 */

int libfvde_volume_group_free(

     libfvde_volume_group_t **volume_group,

     libcerror_error_t **error )

{

  libfvde_internal_volume_group_t *internal_volume_group = NULL;

  static char *function                                  = "libfvde_volume_group_free";

  int result                                             = 1;

  if( volume_group == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume group.",

     function );

    return( -1 );

  }

  if( *volume_group != NULL )

  {

    internal_volume_group = (libfvde_internal_volume_group_t *) *volume_group;

    *volume_group         = NULL;

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

    if( libcthreads_read_write_lock_free(

         &( internal_volume_group->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

    /* The volume_header and metadata references are freed elsewhere

     */

    memory_free(

     internal_volume_group );

  }

  return( result );

}

/* Retrieves the (logical) volume group identifier

 * The identifier is a UUID and is 16 bytes of size

 * Returns 1 if successful or -1 on error

 */

int libfvde_volume_group_get_identifier(

     libfvde_volume_group_t *volume_group,

     uint8_t *uuid_data,

     size_t uuid_data_size,

     libcerror_error_t **error )

{

  libfvde_internal_volume_group_t *internal_volume_group = NULL;

  static char *function                                  = "libfvde_volume_group_get_identifier";

  int result                                             = 1;

  if( volume_group == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume group.",

     function );

    return( -1 );

  }

  internal_volume_group = (libfvde_internal_volume_group_t *) volume_group;

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_grab_for_read(

       internal_volume_group->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 reading.",

     function );

    return( -1 );

  }

#endif

  if( libfvde_volume_header_get_volume_group_identifier(

       internal_volume_group->volume_header,

       uuid_data,

       uuid_data_size,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve volume group identifier from volume header.",

     function );

    result = -1;

  }

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_release_for_read(

       internal_volume_group->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 reading.",

     function );

    return( -1 );

  }

#endif

  return( result );

}

/* Retrieves the size of the UTF-8 encoded name

 * The returned size includes the end of string character

 * Returns 1 if successful, 0 if not available or -1 on error

 */

int libfvde_volume_group_get_utf8_name_size(

     libfvde_volume_group_t *volume_group,

     size_t *utf8_string_size,

     libcerror_error_t **error )

{

  libfvde_internal_volume_group_t *internal_volume_group = NULL;

  static char *function                                  = "libfvde_volume_group_get_utf8_name_size";

  int result                                             = 0;

  if( volume_group == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume group.",

     function );

    return( -1 );

  }

  internal_volume_group = (libfvde_internal_volume_group_t *) volume_group;

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_grab_for_write(

       internal_volume_group->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

  result = libfvde_metadata_get_utf8_volume_group_name_size(

            internal_volume_group->metadata,

            utf8_string_size,

            error );

  if( result == -1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve size of UTF-8 volume group name from metadata.",

     function );

    result = -1;

  }

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_release_for_write(

       internal_volume_group->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 );

}

/* Retrieves the UTF-8 encoded name

 * The size should include the end of string character

 * Returns 1 if successful, 0 if not available or -1 on error

 */

int libfvde_volume_group_get_utf8_name(

     libfvde_volume_group_t *volume_group,

     uint8_t *utf8_string,

     size_t utf8_string_size,

     libcerror_error_t **error )

{

  libfvde_internal_volume_group_t *internal_volume_group = NULL;

  static char *function                                  = "libfvde_volume_group_get_utf8_name";

  int result                                             = 0;

  if( volume_group == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume group.",

     function );

    return( -1 );

  }

  internal_volume_group = (libfvde_internal_volume_group_t *) volume_group;

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_grab_for_write(

       internal_volume_group->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

  result = libfvde_metadata_get_utf8_volume_group_name(

            internal_volume_group->metadata,

            utf8_string,

            utf8_string_size,

            error );

  if( result == -1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve UTF-8 volume group name from metadata.",

     function );

    result = -1;

  }

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_release_for_write(

       internal_volume_group->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 );

}

/* Retrieves the size of the UTF-16 encoded name

 * The returned size includes the end of string character

 * Returns 1 if successful, 0 if not available or -1 on error

 */

int libfvde_volume_group_get_utf16_name_size(

     libfvde_volume_group_t *volume_group,

     size_t *utf16_string_size,

     libcerror_error_t **error )

{

  libfvde_internal_volume_group_t *internal_volume_group = NULL;

  static char *function                                  = "libfvde_volume_group_get_utf16_name_size";

  int result                                             = 0;

  if( volume_group == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume group.",

     function );

    return( -1 );

  }

  internal_volume_group = (libfvde_internal_volume_group_t *) volume_group;

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_grab_for_write(

       internal_volume_group->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

  result = libfvde_metadata_get_utf16_volume_group_name_size(

            internal_volume_group->metadata,

            utf16_string_size,

            error );

  if( result == -1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve size of UTF-16 volume group name from metadata.",

     function );

    result = -1;

  }

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_release_for_write(

       internal_volume_group->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 );

}

/* Retrieves the UTF-16 encoded name

 * The size should include the end of string character

 * Returns 1 if successful, 0 if not available or -1 on error

 */

int libfvde_volume_group_get_utf16_name(

     libfvde_volume_group_t *volume_group,

     uint16_t *utf16_string,

     size_t utf16_string_size,

     libcerror_error_t **error )

{

  libfvde_internal_volume_group_t *internal_volume_group = NULL;

  static char *function                                  = "libfvde_volume_group_get_utf16_name";

  int result                                             = 0;

  if( volume_group == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume group.",

     function );

    return( -1 );

  }

  internal_volume_group = (libfvde_internal_volume_group_t *) volume_group;

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_grab_for_write(

       internal_volume_group->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

  result = libfvde_metadata_get_utf16_volume_group_name(

            internal_volume_group->metadata,

            utf16_string,

            utf16_string_size,

            error );

  if( result == -1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve UTF-16 volume group name from metadata.",

     function );

    result = -1;

  }

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_release_for_write(

       internal_volume_group->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 );

}

/* Retrieves the number of physical volumes

 * Returns 1 if successful or -1 on error

 */

int libfvde_volume_group_get_number_of_physical_volumes(

     libfvde_volume_group_t *volume_group,

     int *number_of_physical_volumes,

     libcerror_error_t **error )

{

  libfvde_internal_volume_group_t *internal_volume_group = NULL;

  static char *function                                  = "libfvde_volume_group_get_number_of_physical_volumes";

  int result                                             = 1;

  if( volume_group == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume group.",

     function );

    return( -1 );

  }

  internal_volume_group = (libfvde_internal_volume_group_t *) volume_group;

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_grab_for_read(

       internal_volume_group->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 reading.",

     function );

    return( -1 );

  }

#endif

  if( libfvde_metadata_get_number_of_physical_volume_descriptors(

       internal_volume_group->metadata,

       number_of_physical_volumes,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve number of physical volume descriptors from metadata.",

     function );

    result = -1;

  }

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_release_for_read(

       internal_volume_group->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 reading.",

     function );

    return( -1 );

  }

#endif

  return( result );

}

/* Retrieves a specific physical volume

 * Returns 1 if successful or -1 on error

 */

int libfvde_volume_group_get_physical_volume_by_index(

     libfvde_volume_group_t *volume_group,

     int volume_index,

     libfvde_physical_volume_t **physical_volume,

     libcerror_error_t **error )

{

  libfvde_internal_volume_group_t *internal_volume_group           = NULL;

  libfvde_physical_volume_descriptor_t *physical_volume_descriptor = NULL;

  static char *function                                            = "libfvde_volume_group_get_physical_volume_by_index";

  int result                                                       = 1;

  if( volume_group == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume group.",

     function );

    return( -1 );

  }

  internal_volume_group = (libfvde_internal_volume_group_t *) volume_group;

  if( physical_volume == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid physical volume.",

     function );

    return( -1 );

  }

  if( *physical_volume != NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,

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

     function );

    return( -1 );

  }

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_grab_for_read(

       internal_volume_group->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 reading.",

     function );

    return( -1 );

  }

#endif

  if( libfvde_metadata_get_physical_volume_descriptor_by_index(

       internal_volume_group->metadata,

       volume_index,

       &physical_volume_descriptor,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve physical volume descriptor: %d from metadata.",

     function,

     volume_index );

    result = -1;

  }

  else

  {

    if( libfvde_physical_volume_initialize(

          physical_volume,

          internal_volume_group->volume_header,

          physical_volume_descriptor,

          error ) != 1 )

    {

      libcerror_error_set(

       error,

       LIBCERROR_ERROR_DOMAIN_RUNTIME,

       LIBCERROR_RUNTIME_ERROR_INITIALIZE_FAILED,

       "%s: unable to create physical volume.",

       function );

      result = -1;

    }

  }

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_release_for_read(

       internal_volume_group->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 reading.",

     function );

    return( -1 );

  }

#endif

  return( result );

}

/* Retrieves the number of logical volumes

 * Returns 1 if successful or -1 on error

 */

int libfvde_volume_group_get_number_of_logical_volumes(

     libfvde_volume_group_t *volume_group,

     int *number_of_logical_volumes,

     libcerror_error_t **error )

{

  libfvde_internal_volume_group_t *internal_volume_group = NULL;

  static char *function                                  = "libfvde_volume_group_get_number_of_logical_volumes";

  int result                                             = 1;

  if( volume_group == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume group.",

     function );

    return( -1 );

  }

  internal_volume_group = (libfvde_internal_volume_group_t *) volume_group;

  if( number_of_logical_volumes == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid number of logical_volumes.",

     function );

    return( -1 );

  }

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_grab_for_read(

       internal_volume_group->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 reading.",

     function );

    return( -1 );

  }

#endif

  if( libfvde_encrypted_metadata_get_number_of_logical_volume_descriptors(

       internal_volume_group->encrypted_metadata,

       number_of_logical_volumes,

       error ) != 1 )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_GET_FAILED,

     "%s: unable to retrieve number of logical volume descriptors from encrypted metadata.",

     function );

    result = -1;

  }

#if defined( HAVE_LIBFVDE_MULTI_THREAD_SUPPORT )

  if( libcthreads_read_write_lock_release_for_read(

       internal_volume_group->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 reading.",

     function );

    return( -1 );

  }

#endif

  return( result );

}

/* Retrieves a specific logical volume

 * Returns 1 if successful or -1 on error

 */

int libfvde_volume_group_get_logical_volume_by_index(

     libfvde_volume_group_t *volume_group,

     int volume_index,

     libfvde_logical_volume_t **logical_volume,

     libcerror_error_t **error )

{

  libfvde_internal_volume_group_t *internal_volume_group         = NULL;

  libfvde_logical_volume_descriptor_t *logical_volume_descriptor = NULL;

  static char *function                                          = "libfvde_volume_group_get_logical_volume_by_index";

  int result                                                     = 1;

  if( volume_group == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid volume group.",

     function );

    return( -1 );

  }

  internal_volume_group = (libfvde_internal_volume_group_t *) volume_group;

  if( logical_volume == NULL )

  {

    libcerror_error_set(

     error,