/*

 * Extent functions

 *

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

#include <types.h>

#include "libfshfs_extent.h"

#include "libfshfs_io_handle.h"

#include "libfshfs_libcerror.h"

/* Creates an extent

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

 * Returns 1 if successful or -1 on error

 */

int libfshfs_extent_initialize(

     libfshfs_extent_t **extent,

     libcerror_error_t **error )

{

  static char *function = "libfshfs_extent_initialize";

  if( extent == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid extent.",

     function );

    return( -1 );

  }

  if( *extent != NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,

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

     function );

    return( -1 );

  }

  *extent = memory_allocate_structure(

             libfshfs_extent_t );

  if( *extent == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_INSUFFICIENT,

     "%s: unable to create extent.",

     function );

    goto on_error;

  }

  if( memory_set(

       *extent,

       0,

       sizeof( libfshfs_extent_t ) ) == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_MEMORY,

     LIBCERROR_MEMORY_ERROR_SET_FAILED,

     "%s: unable to clear extent.",

     function );

    goto on_error;

  }

  return( 1 );

on_error:

  if( *extent != NULL )

  {

    memory_free(

     *extent );

    *extent = NULL;

  }

  return( -1 );

}

/* Frees an extent

 * Returns 1 if successful or -1 on error

 */

int libfshfs_extent_free(

     libfshfs_extent_t **extent,

     libcerror_error_t **error )

{

  static char *function = "libfshfs_extent_free";

  if( extent == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid extent.",

     function );

    return( -1 );

  }

  if( *extent != NULL )

  {

    memory_free(

     *extent );

    *extent = NULL;

  }

  return( 1 );

}

/* Retrieves the extents values

 * Returns 1 if successful or -1 on error

 */

int libfshfs_extent_get_values(

     libfshfs_extent_t *extent,

     libfshfs_io_handle_t *io_handle,

     off64_t *extent_offset,

     size64_t *extent_size,

     uint32_t *extent_flags,

     libcerror_error_t **error )

{

  static char *function = "libfshfs_extent_get_values";

  if( extent == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid extent.",

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

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,

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

     function );

    return( -1 );

  }

  if( extent_offset == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid extent offset.",

     function );

    return( -1 );

  }

  if( extent_size == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid extent size.",

     function );

    return( -1 );

  }

  if( extent_flags == NULL )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_ARGUMENTS,

     LIBCERROR_ARGUMENT_ERROR_INVALID_VALUE,

     "%s: invalid extent flags.",

     function );

    return( -1 );

  }

  if( extent->block_number > ( (uint64_t) INT64_MAX / io_handle->block_size ) )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,

     "%s: invalid extent - invalid block number value out of bounds.",

     function );

    return( -1 );

  }

  if( extent->number_of_blocks > ( (uint64_t) UINT64_MAX / io_handle->block_size ) )

  {

    libcerror_error_set(

     error,

     LIBCERROR_ERROR_DOMAIN_RUNTIME,

     LIBCERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,

     "%s: invalid extent - invalid number of blocks value out of bounds.",

     function );

    return( -1 );

  }

  *extent_offset = (off64_t) extent->block_number * (off64_t) io_handle->block_size;

  *extent_size   = (size64_t) extent->number_of_blocks * (size64_t) io_handle->block_size;

  *extent_flags  = 0;

  return( 1 );

}