libbfio_file_range.c
No OneTemporary
Actions

Size

32 KB

Referenced Files

None

Subscribers

None

libbfio_file_range.c
View Options

	/*
	* File range functions
	*
	* Copyright (c) 2009-2012, Joachim Metz <jbmetz@users.sourceforge.net>
	*
	* Refer to AUTHORS for acknowledgements.
	*
	* This software 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 software 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 software. If not, see <http://www.gnu.org/licenses/>.
	*/

	#include <common.h>
	#include <memory.h>
	#include <types.h>

	#include <liberror.h>

	#include "libbfio_definitions.h"
	#include "libbfio_file.h"
	#include "libbfio_file_range.h"
	#include "libbfio_handle.h"
	#include "libbfio_types.h"

	/* Initializes the file range IO handle
	* Returns 1 if successful or -1 on error
	*/
	int libbfio_file_range_io_handle_initialize(
	libbfio_file_range_io_handle_t **file_range_io_handle,
	liberror_error_t **error )
	{
	static char *function = "libbfio_file_range_io_handle_initialize";

	if( file_range_io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid file range IO handle.",
	function );

	return( -1 );
	}
	if( *file_range_io_handle != NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,
	"%s: invalid file range IO handle value already set.",
	function );

	return( -1 );
	}
	*file_range_io_handle = memory_allocate_structure(
	libbfio_file_range_io_handle_t );

	if( *file_range_io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_MEMORY,
	LIBERROR_MEMORY_ERROR_INSUFFICIENT,
	"%s: unable to create file range IO handle.",
	function );

	goto on_error;
	}
	if( memory_set(
	*file_range_io_handle,
	0,
	sizeof( libbfio_file_range_io_handle_t ) ) == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_MEMORY,
	LIBERROR_MEMORY_ERROR_SET_FAILED,
	"%s: unable to clear file range IO handle.",
	function );

	goto on_error;
	}
	if( libbfio_file_io_handle_initialize(
	&( ( *file_range_io_handle )->file_io_handle ),
	error ) != 1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_INITIALIZE_FAILED,
	"%s: unable to initialize file IO handle.",
	function );

	goto on_error;
	}
	return( 1 );

	on_error:
	if( *file_range_io_handle != NULL )
	{
	memory_free(
	*file_range_io_handle );

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

	/* Initializes the file range handle
	* Returns 1 if successful or -1 on error
	*/
	int libbfio_file_range_initialize(
	libbfio_handle_t **handle,
	liberror_error_t **error )
	{
	libbfio_file_range_io_handle_t *file_range_io_handle = NULL;
	static char *function = "libbfio_range_file_initialize";

	if( handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid handle.",
	function );

	return( -1 );
	}
	if( *handle != NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,
	"%s: invalid handle value already set.",
	function );

	return( -1 );
	}
	if( libbfio_file_range_io_handle_initialize(
	&file_range_io_handle,
	error ) != 1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_INITIALIZE_FAILED,
	"%s: unable to create file range IO handle.",
	function );

	goto on_error;
	}
	if( libbfio_handle_initialize(
	handle,
	(intptr_t *) file_range_io_handle,
	(int ()(intptr_t , liberror_error_t *)) libbfio_file_range_io_handle_free,
	(int ()(intptr_t , intptr_t , liberror_error_t **)) libbfio_file_range_io_handle_clone,
	(int ()(intptr_t , int, liberror_error_t **)) libbfio_file_range_open,
	(int ()(intptr_t , liberror_error_t **)) libbfio_file_range_close,
	(ssize_t ()(intptr_t , uint8_t , size_t, liberror_error_t *)) libbfio_file_range_read,
	(ssize_t ()(intptr_t , const uint8_t , size_t, liberror_error_t *)) libbfio_file_range_write,
	(off64_t ()(intptr_t , off64_t, int, liberror_error_t **)) libbfio_file_range_seek_offset,
	(int ()(intptr_t , liberror_error_t **)) libbfio_file_range_exists,
	(int ()(intptr_t , liberror_error_t **)) libbfio_file_range_is_open,
	(int ()(intptr_t , size64_t , liberror_error_t *)) libbfio_file_range_get_size,
	LIBBFIO_FLAG_IO_HANDLE_MANAGED \| LIBBFIO_FLAG_IO_HANDLE_CLONE_BY_FUNCTION,
	error ) != 1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_INITIALIZE_FAILED,
	"%s: unable to create handle.",
	function );

	goto on_error;
	}
	return( 1 );

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

	/* Frees the file range IO handle and its attributes
	* Returns 1 if succesful or -1 on error
	*/
	int libbfio_file_range_io_handle_free(
	libbfio_file_range_io_handle_t **file_range_io_handle,
	liberror_error_t **error )
	{
	static char *function = "libbfio_file_range_io_handle_free";
	int result = 1;

	if( file_range_io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid file range IO handle.",
	function );

	return( -1 );
	}
	if( *file_range_io_handle != NULL )
	{
	if( libbfio_file_io_handle_free(
	&( ( *file_range_io_handle )->file_io_handle ),
	error ) != 1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_FINALIZE_FAILED,
	"%s: unable to free file IO handle.",
	function );

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

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

	/* Clones (duplicates) the file range IO handle and its attributes
	* Returns 1 if succesful or -1 on error
	*/
	int libbfio_file_range_io_handle_clone(
	libbfio_file_range_io_handle_t **destination_file_range_io_handle,
	libbfio_file_range_io_handle_t *source_file_range_io_handle,
	liberror_error_t **error )
	{
	static char *function = "libbfio_file_range_io_handle_clone";

	if( destination_file_range_io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid destination file range IO handle.",
	function );

	return( -1 );
	}
	if( *destination_file_range_io_handle != NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_VALUE_ALREADY_SET,
	"%s: destination file range IO handle already set.",
	function );

	return( -1 );
	}
	if( source_file_range_io_handle == NULL )
	{
	*destination_file_range_io_handle = NULL;

	return( 1 );
	}
	*destination_file_range_io_handle = memory_allocate_structure(
	libbfio_file_range_io_handle_t );

	if( *destination_file_range_io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_MEMORY,
	LIBERROR_MEMORY_ERROR_INSUFFICIENT,
	"%s: unable to create destination file range IO handle.",
	function );

	goto on_error;
	}
	if( memory_set(
	*destination_file_range_io_handle,
	0,
	sizeof( libbfio_file_range_io_handle_t ) ) == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_MEMORY,
	LIBERROR_MEMORY_ERROR_SET_FAILED,
	"%s: unable to clear destination file range IO handle.",
	function );

	memory_free(
	*destination_file_range_io_handle );

	*destination_file_range_io_handle = NULL;

	return( -1 );
	}
	if( libbfio_file_io_handle_clone(
	&( ( *destination_file_range_io_handle )->file_io_handle ),
	source_file_range_io_handle->file_io_handle,
	error ) != 1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_INITIALIZE_FAILED,
	"%s: unable to create file IO handle.",
	function );

	goto on_error;
	}
	( *destination_file_range_io_handle )->range_offset = source_file_range_io_handle->range_offset;
	( *destination_file_range_io_handle )->range_size = source_file_range_io_handle->range_size;

	return( 1 );

	on_error:
	if( *destination_file_range_io_handle != NULL )
	{
	libbfio_file_range_io_handle_free(
	destination_file_range_io_handle,
	NULL );
	}
	return( -1 );
	}

	/* Retrieves the name size of the file range handle
	* The name size includes the end of string character
	* Returns 1 if succesful or -1 on error
	*/
	int libbfio_file_range_get_name_size(
	libbfio_handle_t *handle,
	size_t *name_size,
	liberror_error_t **error )
	{
	libbfio_internal_handle_t *internal_handle = NULL;
	libbfio_file_range_io_handle_t *file_range_io_handle = NULL;
	static char *function = "libbfio_file_range_get_name_size";

	if( handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid handle.",
	function );

	return( -1 );
	}
	internal_handle = (libbfio_internal_handle_t *) handle;

	if( internal_handle->io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_VALUE_MISSING,
	"%s: invalid handle - missing IO handle.",
	function );

	return( -1 );
	}
	file_range_io_handle = (libbfio_file_range_io_handle_t *) internal_handle->io_handle;

	if( libbfio_file_io_handle_get_name_size(
	file_range_io_handle->file_io_handle,
	name_size,
	error ) != 1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_GET_FAILED,
	"%s: unable to retrieve name size from file IO handle.",
	function );

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

	/* Retrieves the name of the file range handle
	* The name size should include the end of string character
	* Returns 1 if succesful or -1 on error
	*/
	int libbfio_file_range_get_name(
	libbfio_handle_t *handle,
	char *name,
	size_t name_size,
	liberror_error_t **error )
	{
	libbfio_internal_handle_t *internal_handle = NULL;
	libbfio_file_range_io_handle_t *file_range_io_handle = NULL;
	static char *function = "libbfio_file_range_get_name";

	if( handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid handle.",
	function );

	return( -1 );
	}
	internal_handle = (libbfio_internal_handle_t *) handle;

	if( internal_handle->io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_VALUE_MISSING,
	"%s: invalid handle - missing IO handle.",
	function );

	return( -1 );
	}
	file_range_io_handle = (libbfio_file_range_io_handle_t *) internal_handle->io_handle;

	if( libbfio_file_io_handle_get_name(
	file_range_io_handle->file_io_handle,
	name,
	name_size,
	error ) != 1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_GET_FAILED,
	"%s: unable to retrieve name from file IO handle.",
	function );

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

	/* Sets the name for the file range handle
	* Returns 1 if succesful or -1 on error
	*/
	int libbfio_file_range_set_name(
	libbfio_handle_t *handle,
	const char *name,
	size_t name_length,
	liberror_error_t **error )
	{
	libbfio_internal_handle_t *internal_handle = NULL;
	libbfio_file_range_io_handle_t *file_range_io_handle = NULL;
	static char *function = "libbfio_file_range_set_name";

	if( handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid handle.",
	function );

	return( -1 );
	}
	internal_handle = (libbfio_internal_handle_t *) handle;

	if( internal_handle->io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_VALUE_MISSING,
	"%s: invalid handle - missing IO handle.",
	function );

	return( -1 );
	}
	file_range_io_handle = (libbfio_file_range_io_handle_t *) internal_handle->io_handle;

	if( libbfio_file_io_handle_set_name(
	file_range_io_handle->file_io_handle,
	name,
	name_length,
	error ) != 1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_SET_FAILED,
	"%s: unable to set name in file IO handle.",
	function );

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

	#if defined( HAVE_WIDE_CHARACTER_TYPE )

	/* Retrieves the name size of the file range handle
	* The name size includes the end of string character
	* Returns 1 if succesful or -1 on error
	*/
	int libbfio_file_range_get_name_size_wide(
	libbfio_handle_t *handle,
	size_t *name_size,
	liberror_error_t **error )
	{
	libbfio_internal_handle_t *internal_handle = NULL;
	libbfio_file_range_io_handle_t *file_range_io_handle = NULL;
	static char *function = "libbfio_file_range_get_name_size_wide";

	if( handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid handle.",
	function );

	return( -1 );
	}
	internal_handle = (libbfio_internal_handle_t *) handle;

	if( internal_handle->io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_VALUE_MISSING,
	"%s: invalid handle - missing IO handle.",
	function );

	return( -1 );
	}
	file_range_io_handle = (libbfio_file_range_io_handle_t *) internal_handle->io_handle;

	if( libbfio_file_io_handle_get_name_size_wide(
	file_range_io_handle->file_io_handle,
	name_size,
	error ) != 1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_GET_FAILED,
	"%s: unable to retrieve name size from file IO handle.",
	function );

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

	/* Retrieves the name of the file range handle
	* The name size should include the end of string character
	* Returns 1 if succesful or -1 on error
	*/
	int libbfio_file_range_get_name_wide(
	libbfio_handle_t *handle,
	wchar_t *name,
	size_t name_size,
	liberror_error_t **error )
	{
	libbfio_internal_handle_t *internal_handle = NULL;
	libbfio_file_range_io_handle_t *file_range_io_handle = NULL;
	static char *function = "libbfio_file_range_get_name_wide";

	if( handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid handle.",
	function );

	return( -1 );
	}
	internal_handle = (libbfio_internal_handle_t *) handle;

	if( internal_handle->io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_VALUE_MISSING,
	"%s: invalid handle - missing IO handle.",
	function );

	return( -1 );
	}
	file_range_io_handle = (libbfio_file_range_io_handle_t *) internal_handle->io_handle;

	if( libbfio_file_io_handle_get_name_wide(
	file_range_io_handle->file_io_handle,
	name,
	name_size,
	error ) != 1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_GET_FAILED,
	"%s: unable to retrieve name from file IO handle.",
	function );

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

	/* Sets the name for the file range handle
	* Returns 1 if succesful or -1 on error
	*/
	int libbfio_file_range_set_name_wide(
	libbfio_handle_t *handle,
	const wchar_t *name,
	size_t name_length,
	liberror_error_t **error )
	{
	libbfio_internal_handle_t *internal_handle = NULL;
	libbfio_file_range_io_handle_t *file_range_io_handle = NULL;
	static char *function = "libbfio_file_range_set_name_wide";

	if( handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid handle.",
	function );

	return( -1 );
	}
	internal_handle = (libbfio_internal_handle_t *) handle;

	if( internal_handle->io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_VALUE_MISSING,
	"%s: invalid handle - missing IO handle.",
	function );

	return( -1 );
	}
	file_range_io_handle = (libbfio_file_range_io_handle_t *) internal_handle->io_handle;

	if( libbfio_file_io_handle_set_name_wide(
	file_range_io_handle->file_io_handle,
	name,
	name_length,
	error ) != 1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_SET_FAILED,
	"%s: unable to set name in file IO handle.",
	function );

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

	#endif /* defined( HAVE_WIDE_CHARACTER_TYPE ) */

	/* Retrieves the range of the file range handle
	* Returns 1 if succesful or -1 on error
	*/
	int libbfio_file_range_get(
	libbfio_handle_t *handle,
	off64_t *range_offset,
	size64_t *range_size,
	liberror_error_t **error )
	{
	libbfio_internal_handle_t *internal_handle = NULL;
	libbfio_file_range_io_handle_t *file_range_io_handle = NULL;
	static char *function = "libbfio_file_range_get";

	if( handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid handle.",
	function );

	return( -1 );
	}
	internal_handle = (libbfio_internal_handle_t *) handle;

	if( internal_handle->io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_VALUE_MISSING,
	"%s: invalid handle - missing IO handle.",
	function );

	return( -1 );
	}
	file_range_io_handle = (libbfio_file_range_io_handle_t *) internal_handle->io_handle;

	if( range_offset == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid range offset.",
	function );

	return( -1 );
	}
	if( range_size == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid range size.",
	function );

	return( -1 );
	}
	*range_offset = file_range_io_handle->range_offset;
	*range_size = file_range_io_handle->range_size;

	return( 1 );
	}

	/* Sets the range of the file range handle
	* A range size of 0 represents that the range continues until the end of the file
	* Returns 1 if succesful or -1 on error
	*/
	int libbfio_file_range_set(
	libbfio_handle_t *handle,
	off64_t range_offset,
	size64_t range_size,
	liberror_error_t **error )
	{
	libbfio_internal_handle_t *internal_handle = NULL;
	libbfio_file_range_io_handle_t *file_range_io_handle = NULL;
	static char *function = "libbfio_file_range_set";

	if( handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid handle.",
	function );

	return( -1 );
	}
	internal_handle = (libbfio_internal_handle_t *) handle;

	if( internal_handle->io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_VALUE_MISSING,
	"%s: invalid handle - missing IO handle.",
	function );

	return( -1 );
	}
	file_range_io_handle = (libbfio_file_range_io_handle_t *) internal_handle->io_handle;

	if( range_offset < 0 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_VALUE_LESS_THAN_ZERO,
	"%s: invalid range offset value less than zero.",
	function );

	return( -1 );
	}
	if( range_size > (size64_t) INT64_MAX )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_VALUE_EXCEEDS_MAXIMUM,
	"%s: invalid range size value exceeds maximum.",
	function );

	return( -1 );
	}
	file_range_io_handle->range_offset = range_offset;
	file_range_io_handle->range_size = range_size;

	return( 1 );
	}

	/* Opens the file range handle
	* Returns 1 if successful or -1 on error
	*/
	int libbfio_file_range_open(
	libbfio_file_range_io_handle_t *file_range_io_handle,
	int access_flags,
	liberror_error_t **error )
	{
	static char *function = "libbfio_file_range_open";
	size64_t file_size = 0;

	if( file_range_io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid file range IO handle.",
	function );

	return( -1 );
	}
	if( libbfio_file_open(
	file_range_io_handle->file_io_handle,
	access_flags,
	error ) != 1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_IO,
	LIBERROR_IO_ERROR_OPEN_FAILED,
	"%s: unable to open file IO handle.",
	function );

	return( -1 );
	}
	if( libbfio_file_get_size(
	file_range_io_handle->file_io_handle,
	&file_size,
	error ) != 1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_GET_FAILED,
	"%s: unable to retrieve size from file IO handle.",
	function );

	return( -1 );
	}
	if( file_range_io_handle->range_offset >= (off64_t) file_size )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_VALUE_OUT_OF_BOUNDS,
	"%s: invalid range offset value exceeds file size.",
	function );

	return( -1 );
	}
	file_size -= file_range_io_handle->range_offset;

	if( file_range_io_handle->range_size > file_size )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_VALUE_OUT_OF_BOUNDS,
	"%s: invalid range size value exceeds file size.",
	function );

	return( -1 );
	}
	if( libbfio_file_seek_offset(
	file_range_io_handle->file_io_handle,
	file_range_io_handle->range_offset,
	SEEK_SET,
	error ) == -1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_IO,
	LIBERROR_IO_ERROR_SEEK_FAILED,
	"%s: unable to seek range offset in file IO handle.",
	function );

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

	/* Closes the file range handle
	* Returns 0 if successful or -1 on error
	*/
	int libbfio_file_range_close(
	libbfio_file_range_io_handle_t *file_range_io_handle,
	liberror_error_t **error )
	{
	static char *function = "libbfio_file_range_close";

	if( file_range_io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid file range IO handle.",
	function );

	return( -1 );
	}
	if( libbfio_file_close(
	file_range_io_handle->file_io_handle,
	error ) != 0 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_IO,
	LIBERROR_IO_ERROR_CLOSE_FAILED,
	"%s: unable to close file IO handle.",
	function );

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

	/* Reads a buffer from the file range handle
	* Returns the number of bytes read if successful, or -1 on error
	*/
	ssize_t libbfio_file_range_read(
	libbfio_file_range_io_handle_t *file_range_io_handle,
	uint8_t *buffer,
	size_t size,
	liberror_error_t **error )
	{
	static char *function = "libbfio_file_range_read";
	off64_t file_offset = 0;
	ssize_t read_count = 0;

	if( file_range_io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid file range IO handle.",
	function );

	return( -1 );
	}
	file_offset = libbfio_file_seek_offset(
	file_range_io_handle->file_io_handle,
	0,
	SEEK_CUR,
	error );

	if( file_offset == -1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_GET_FAILED,
	"%s: unable to retrieve current offset from file IO handle.",
	function );

	return( -1 );
	}
	if( file_offset < file_range_io_handle->range_offset )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
	"%s: invalid file offset value out of bounds.",
	function );

	return( -1 );
	}
	if( file_range_io_handle->range_size != 0 )
	{
	if( (size64_t) file_offset >= file_range_io_handle->range_size )
	{
	return( 0 );
	}
	if( (size64_t) ( file_offset + size ) >= file_range_io_handle->range_size )
	{
	size = (size_t) ( file_range_io_handle->range_offset - file_offset );
	}
	}
	read_count = libbfio_file_read(
	file_range_io_handle->file_io_handle,
	buffer,
	size,
	error );

	if( read_count == -1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_IO,
	LIBERROR_IO_ERROR_READ_FAILED,
	"%s: unable to read from file IO handle.",
	function );

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

	/* Writes a buffer to the file range handle
	* Returns the number of bytes written if successful, or -1 on error
	*/
	ssize_t libbfio_file_range_write(
	libbfio_file_range_io_handle_t *file_range_io_handle,
	const uint8_t *buffer,
	size_t size,
	liberror_error_t **error )
	{
	static char *function = "libbfio_file_range_write";
	off64_t file_offset = 0;
	ssize_t write_count = 0;

	if( file_range_io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid file range IO handle.",
	function );

	return( -1 );
	}
	file_offset = libbfio_file_seek_offset(
	file_range_io_handle->file_io_handle,
	0,
	SEEK_CUR,
	error );

	if( file_offset == -1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_GET_FAILED,
	"%s: unable to retrieve current offset from file IO handle.",
	function );

	return( -1 );
	}
	if( file_offset < file_range_io_handle->range_offset )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
	"%s: invalid file offset value out of bounds.",
	function );

	return( -1 );
	}
	if( file_range_io_handle->range_size != 0 )
	{
	if( (size64_t) file_offset >= file_range_io_handle->range_size )
	{
	return( 0 );
	}
	if( (size64_t) ( file_offset + size ) >= file_range_io_handle->range_size )
	{
	size = (size_t) ( file_range_io_handle->range_offset - file_offset );
	}
	}
	write_count = libbfio_file_write(
	file_range_io_handle->file_io_handle,
	buffer,
	size,
	error );

	if( write_count == -1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_IO,
	LIBERROR_IO_ERROR_READ_FAILED,
	"%s: unable to write to file IO handle.",
	function );

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

	/* Seeks a certain offset within the file range handle
	* Returns the offset if the seek is successful or -1 on error
	*/
	off64_t libbfio_file_range_seek_offset(
	libbfio_file_range_io_handle_t *file_range_io_handle,
	off64_t offset,
	int whence,
	liberror_error_t **error )
	{
	static char *function = "libbfio_file_range_seek_offset";
	off64_t file_offset = 0;

	if( file_range_io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid file range IO handle.",
	function );

	return( -1 );
	}
	if( ( whence != SEEK_CUR )
	&& ( whence != SEEK_END )
	&& ( whence != SEEK_SET ) )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_UNSUPPORTED_VALUE,
	"%s: unsupported whence.",
	function );

	return( -1 );
	}
	if( whence == SEEK_CUR )
	{
	file_offset = libbfio_file_seek_offset(
	file_range_io_handle->file_io_handle,
	0,
	SEEK_CUR,
	error );

	if( file_offset == -1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_GET_FAILED,
	"%s: unable to retrieve current offset from file IO handle.",
	function );

	return( -1 );
	}
	offset += file_offset;
	whence = SEEK_SET;
	}
	else if( whence == SEEK_END )
	{
	if( file_range_io_handle->range_size != 0 )
	{
	offset += file_range_io_handle->range_size;
	whence = SEEK_SET;
	}
	}
	else if( whence == SEEK_SET )
	{
	offset += file_range_io_handle->range_offset;
	}
	if( whence == SEEK_SET )
	{
	if( offset < file_range_io_handle->range_offset )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_VALUE_OUT_OF_BOUNDS,
	"%s: invalid offset value out of bounds.",
	function );

	return( -1 );
	}
	}
	offset = libbfio_file_seek_offset(
	file_range_io_handle->file_io_handle,
	offset,
	whence,
	error );

	if( offset == -1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_IO,
	LIBERROR_IO_ERROR_SEEK_FAILED,
	"%s: unable to seek offset in file IO handle.",
	function );

	return( -1 );
	}
	if( offset < file_range_io_handle->range_offset )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_VALUE_OUT_OF_BOUNDS,
	"%s: invalid offset value out of bounds.",
	function );

	return( -1 );
	}
	offset -= file_range_io_handle->range_offset;

	return( offset );
	}

	/* Function to determine if a file range exists
	* Returns 1 if file exists, 0 if not or -1 on error
	*/
	int libbfio_file_range_exists(
	libbfio_file_range_io_handle_t *file_range_io_handle,
	liberror_error_t **error )
	{
	static char *function = "libbfio_file_range_exists";
	int result = 0;

	if( file_range_io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid file range IO handle.",
	function );

	return( -1 );
	}
	result = libbfio_file_exists(
	file_range_io_handle->file_io_handle,
	error );

	if( result == -1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_IO,
	LIBERROR_IO_ERROR_GENERIC,
	"%s: unable to determine if file exists.",
	function );

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

	/* Check if the file range is open
	* Returns 1 if open, 0 if not or -1 on error
	*/
	int libbfio_file_range_is_open(
	libbfio_file_range_io_handle_t *file_range_io_handle,
	liberror_error_t **error )
	{
	static char *function = "libbfio_file_range_is_open";
	int result = 0;

	if( file_range_io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid file range IO handle.",
	function );

	return( -1 );
	}
	result = libbfio_file_is_open(
	file_range_io_handle->file_io_handle,
	error );

	if( result == -1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_IO,
	LIBERROR_IO_ERROR_GENERIC,
	"%s: unable to determine if file is open.",
	function );

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

	/* Retrieves the file range size
	* Returns 1 if successful or -1 on error
	*/
	int libbfio_file_range_get_size(
	libbfio_file_range_io_handle_t *file_range_io_handle,
	size64_t *size,
	liberror_error_t **error )
	{
	static char *function = "libbfio_file_range_get_size";

	if( file_range_io_handle == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid file range IO handle.",
	function );

	return( -1 );
	}
	if( size == NULL )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_ARGUMENTS,
	LIBERROR_ARGUMENT_ERROR_INVALID_VALUE,
	"%s: invalid size.",
	function );

	return( -1 );
	}
	if( file_range_io_handle->range_size == 0 )
	{
	if( libbfio_file_get_size(
	file_range_io_handle->file_io_handle,
	size,
	error ) != 1 )
	{
	liberror_error_set(
	error,
	LIBERROR_ERROR_DOMAIN_RUNTIME,
	LIBERROR_RUNTIME_ERROR_GET_FAILED,
	"%s: unable to determine size.",
	function );

	return( -1 );
	}
	*size -= file_range_io_handle->range_offset;
	}
	else
	{
	*size = file_range_io_handle->range_size;
	}
	return( 1 );
	}

File Metadata

Mime Type: text/x-c
Expires: Fri, Nov 21, 7:22 PM (1 d, 19 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1361410
Default Alt Text: libbfio_file_range.c (32 KB)

libbfio_file_range.cNo OneTemporaryActions

libbfio_file_range.cView Options

File Metadata

Event Timeline

libbfio_file_range.c
No OneTemporary
Actions

libbfio_file_range.c
View Options