/* * The list functions * * Copyright (C) 2010-2023, Joachim Metz * * 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 . */ #if !defined( _LIBFDATA_INTERNAL_LIST_H ) #define _LIBFDATA_INTERNAL_LIST_H #include #include #include "libfdata_extern.h" #include "libfdata_libcdata.h" #include "libfdata_libcerror.h" #include "libfdata_libfcache.h" #include "libfdata_types.h" #if defined( __cplusplus ) extern "C" { #endif typedef struct libfdata_internal_list libfdata_internal_list_t; struct libfdata_internal_list { /* The current (most recently used) element index */ int current_element_index; /* The mapped offset */ off64_t mapped_offset; /* The (list) size */ size64_t size; /* The (list) elements array */ libcdata_array_t *elements_array; /* The mapped ranges array */ libcdata_array_t *mapped_ranges_array; /* The flags */ uint8_t flags; /* The data handle */ intptr_t *data_handle; /* The free data handle function */ int (*free_data_handle)( intptr_t **data_handle, libcerror_error_t **error ); /* The clone (duplicate) data handle function */ int (*clone_data_handle)( intptr_t **destination_data_handle, intptr_t *source_data_handle, libcerror_error_t **error ); /* The read element data function */ int (*read_element_data)( intptr_t *data_handle, intptr_t *file_io_handle, libfdata_list_element_t *list_element, libfdata_cache_t *cache, int element_data_file_index, off64_t element_data_offset, size64_t element_data_size, uint32_t element_data_flags, uint8_t read_flags, libcerror_error_t **error ); /* The write element data function */ int (*write_element_data)( intptr_t *data_handle, intptr_t *file_io_handle, libfdata_list_element_t *list_element, libfdata_cache_t *cache, int element_data_file_index, off64_t element_data_offset, size64_t element_data_size, uint32_t element_data_flags, uint8_t write_flags, libcerror_error_t **error ); }; LIBFDATA_EXTERN \ int libfdata_list_initialize( libfdata_list_t **list, intptr_t *data_handle, int (*free_data_handle)( intptr_t **data_handle, libcerror_error_t **error ), int (*clone_data_handle)( intptr_t **destination_data_handle, intptr_t *source_data_handle, libcerror_error_t **error ), int (*read_element_data)( intptr_t *data_handle, intptr_t *file_io_handle, libfdata_list_element_t *list_element, libfdata_cache_t *cache, int element_data_file_index, off64_t element_data_offset, size64_t element_data_size, uint32_t element_data_flags, uint8_t read_flags, libcerror_error_t **error ), int (*write_element_data)( intptr_t *data_handle, intptr_t *file_io_handle, libfdata_list_element_t *list_element, libfdata_cache_t *cache, int element_data_file_index, off64_t element_data_offset, size64_t element_data_size, uint32_t element_data_flags, uint8_t write_flags, libcerror_error_t **error ), uint8_t flags, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_free( libfdata_list_t **list, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_clone( libfdata_list_t **destination_list, libfdata_list_t *source_list, libcerror_error_t **error ); int libfdata_list_set_calculate_mapped_ranges_flag( libfdata_list_t *list, libcerror_error_t **error ); /* List elements functions */ LIBFDATA_EXTERN \ int libfdata_list_empty( libfdata_list_t *list, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_resize( libfdata_list_t *list, int number_of_elements, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_reverse( libfdata_list_t *list, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_get_number_of_elements( libfdata_list_t *list, int *number_of_elements, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_get_list_element_by_index( libfdata_list_t *list, int element_index, libfdata_list_element_t **element, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_get_element_by_index( libfdata_list_t *list, int element_index, int *element_file_index, off64_t *element_offset, size64_t *element_size, uint32_t *element_flags, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_set_element_by_index( libfdata_list_t *list, int element_index, int element_file_index, off64_t element_offset, size64_t element_size, uint32_t element_flags, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_prepend_element( libfdata_list_t *list, int element_file_index, off64_t element_offset, size64_t element_size, uint32_t element_flags, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_append_element( libfdata_list_t *list, int *element_index, int element_file_index, off64_t element_offset, size64_t element_size, uint32_t element_flags, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_append_list( libfdata_list_t *list, libfdata_list_t *source_list, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_is_element_set( libfdata_list_t *list, int element_index, libcerror_error_t **error ); /* Mapped range functions */ LIBFDATA_EXTERN \ int libfdata_list_get_element_mapped_range( libfdata_list_t *list, int element_index, off64_t *mapped_range_offset, size64_t *mapped_range_size, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_get_mapped_offset( libfdata_list_t *list, off64_t *mapped_offset, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_set_mapped_offset( libfdata_list_t *list, off64_t mapped_offset, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_get_mapped_size_by_index( libfdata_list_t *list, int element_index, size64_t *mapped_size, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_set_mapped_size_by_index( libfdata_list_t *list, int element_index, size64_t mapped_size, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_get_element_by_index_with_mapped_size( libfdata_list_t *list, int element_index, int *element_file_index, off64_t *element_offset, size64_t *element_size, uint32_t *element_flags, size64_t *mapped_size, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_set_element_by_index_with_mapped_size( libfdata_list_t *list, int element_index, int element_file_index, off64_t element_offset, size64_t element_size, uint32_t element_flags, size64_t mapped_size, libcerror_error_t **error ); /* TODO libfdata_list_prepend_element_with_mapped_size */ LIBFDATA_EXTERN \ int libfdata_list_append_element_with_mapped_size( libfdata_list_t *list, int *element_index, int element_file_index, off64_t element_offset, size64_t element_size, uint32_t element_flags, size64_t mapped_size, libcerror_error_t **error ); int libfdata_list_calculate_mapped_ranges( libfdata_internal_list_t *internal_list, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_get_element_index_at_offset( libfdata_list_t *list, off64_t offset, int *element_index, off64_t *element_data_offset, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_get_list_element_at_offset( libfdata_list_t *list, off64_t offset, int *element_index, off64_t *element_data_offset, libfdata_list_element_t **element, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_get_element_at_offset( libfdata_list_t *list, off64_t offset, int *element_index, off64_t *element_data_offset, int *element_file_index, off64_t *element_offset, size64_t *element_size, uint32_t *element_flags, libcerror_error_t **error ); /* TODO add libfdata_list_set_element_at_offset */ /* List element value functions */ LIBFDATA_EXTERN \ int libfdata_list_cache_element_value( libfdata_list_t *list, libfdata_cache_t *cache, int element_index, int element_file_index, off64_t element_data_offset, size64_t element_data_size, uint32_t element_data_flags, int64_t element_timestamp, intptr_t *element_value, int (*free_element_value)( intptr_t **element_value, libcerror_error_t **error ), uint8_t write_flags, libcerror_error_t **error ); int libfdata_list_get_element_value( libfdata_list_t *list, intptr_t *file_io_handle, libfdata_cache_t *cache, libfdata_list_element_t *element, intptr_t **element_value, uint8_t read_flags, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_get_element_value_by_index( libfdata_list_t *list, intptr_t *file_io_handle, libfdata_cache_t *cache, int element_index, intptr_t **element_value, uint8_t read_flags, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_get_element_value_at_offset( libfdata_list_t *list, intptr_t *file_io_handle, libfdata_cache_t *cache, off64_t offset, int *element_index, off64_t *element_data_offset, intptr_t **element_value, uint8_t read_flags, libcerror_error_t **error ); int libfdata_list_set_element_value( libfdata_list_t *list, intptr_t *file_io_handle, libfdata_cache_t *cache, libfdata_list_element_t *element, intptr_t *element_value, int (*free_element_value)( intptr_t **element_value, libcerror_error_t **error ), uint8_t write_flags, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_set_element_value_by_index( libfdata_list_t *list, intptr_t *file_io_handle, libfdata_cache_t *cache, int element_index, intptr_t *element_value, int (*free_element_value)( intptr_t **element_value, libcerror_error_t **error ), uint8_t write_flags, libcerror_error_t **error ); LIBFDATA_EXTERN \ int libfdata_list_set_element_value_at_offset( libfdata_list_t *list, intptr_t *file_io_handle, libfdata_cache_t *cache, off64_t offset, intptr_t *element_value, int (*free_element_value)( intptr_t **element_value, libcerror_error_t **error ), uint8_t write_flags, libcerror_error_t **error ); /* IO functions */ LIBFDATA_EXTERN \ int libfdata_list_get_size( libfdata_list_t *list, size64_t *size, libcerror_error_t **error ); #if defined( __cplusplus ) } #endif #endif /* !defined( _LIBFDATA_INTERNAL_LIST_H ) */