1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
|
/*
* The area functions
*
* Copyright (C) 2010-2018, Joachim Metz <joachim.metz@gmail.com>
*
* 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/>.
*/
#if !defined( _LIBFDATA_INTERNAL_AREA_H )
#define _LIBFDATA_INTERNAL_AREA_H
#include <common.h>
#include <types.h>
#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_area libfdata_internal_area_t;
struct libfdata_internal_area
{
/* The element data size
*/
size64_t element_data_size;
/* The (area) size
*/
size64_t size;
/* The segments array
*/
libcdata_array_t *segments_array;
/* The mapped ranges array
*/
libcdata_array_t *mapped_ranges_array;
/* The timestamp
*/
int64_t timestamp;
/* The flags
*/
uint8_t flags;
/* The calculate cache entry index value
*/
int (*calculate_cache_entry_index)(
int element_index,
int element_data_file_index,
off64_t element_data_offset,
size64_t element_data_size,
uint32_t element_data_flags,
int number_of_cache_entries );
/* 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_area_t *area,
libfdata_cache_t *cache,
off64_t element_value_offset,
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_area_t *area,
libfdata_cache_t *cache,
off64_t element_value_offset,
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_area_initialize(
libfdata_area_t **area,
size64_t element_data_size,
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_area_t *area,
libfdata_cache_t *cache,
off64_t element_value_offset,
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_area_t *area,
libfdata_cache_t *cache,
off64_t element_value_offset,
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_area_free(
libfdata_area_t **area,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_area_clone(
libfdata_area_t **destination_area,
libfdata_area_t *source_area,
libcerror_error_t **error );
/* Segment functions
*/
LIBFDATA_EXTERN \
int libfdata_area_empty(
libfdata_area_t *area,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_area_resize(
libfdata_area_t *area,
int number_of_segments,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_area_get_number_of_segments(
libfdata_area_t *area,
int *number_of_segments,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_area_get_segment_by_index(
libfdata_area_t *area,
int segment_index,
int *segment_file_index,
off64_t *segment_offset,
size64_t *segment_size,
uint32_t *segment_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_area_set_segment_by_index(
libfdata_area_t *area,
int segment_index,
int segment_file_index,
off64_t segment_offset,
size64_t segment_size,
uint32_t segment_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_area_prepend_segment(
libfdata_area_t *area,
int segment_file_index,
off64_t segment_offset,
size64_t segment_size,
uint32_t segment_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_area_append_segment(
libfdata_area_t *area,
int *segment_index,
int segment_file_index,
off64_t segment_offset,
size64_t segment_size,
uint32_t segment_flags,
libcerror_error_t **error );
/* Area element functions
*/
LIBFDATA_EXTERN \
int libfdata_area_get_element_data_size(
libfdata_area_t *area,
size64_t *element_data_size,
libcerror_error_t **error );
/* Area element value functions
*/
LIBFDATA_EXTERN \
int libfdata_area_get_element_value_at_offset(
libfdata_area_t *area,
intptr_t *file_io_handle,
libfdata_cache_t *cache,
off64_t element_value_offset,
intptr_t **element_value,
uint8_t read_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_area_set_element_value_at_offset(
libfdata_area_t *area,
intptr_t *file_io_handle,
libfdata_cache_t *cache,
off64_t element_value_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_area_get_size(
libfdata_area_t *area,
size64_t *size,
libcerror_error_t **error );
#if defined( __cplusplus )
}
#endif
#endif /* !defined( _LIBFDATA_INTERNAL_AREA_H ) */
|