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 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
|
/*
* The list functions
*
* Copyright (C) 2010-2017, 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_LIST_H )
#define _LIBFDATA_INTERNAL_LIST_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_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 calculate cache entry index value
*/
int (*calculate_cache_entry_index)(
int element_index,
int element_file_index,
off64_t element_offset,
size64_t element_size,
uint32_t element_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_list_element_t *list_element,
libfcache_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,
libfcache_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,
libfcache_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,
libfcache_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_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,
libfcache_cache_t *cache,
int element_index,
int element_file_index,
off64_t element_offset,
size64_t element_size,
uint32_t element_flags,
time_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,
libfcache_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,
libfcache_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,
libfcache_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,
libfcache_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,
libfcache_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,
libfcache_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 ) */
|