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
|
/*
* The tree node 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_TREE_NODE_H )
#define _LIBFDATA_INTERNAL_TREE_NODE_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_range.h"
#include "libfdata_tree.h"
#include "libfdata_types.h"
#if defined( __cplusplus )
extern "C" {
#endif
#define libfdata_tree_node_calculate_branch_node_cache_entry_index( node_offset, number_of_cache_entries ) \
( number_of_cache_entries > 4 ) ? ( node_offset % ( number_of_cache_entries / 4 ) ) : ( node_offset % number_of_cache_entries )
#define libfdata_tree_node_calculate_leaf_node_cache_entry_index( node_offset, number_of_cache_entries ) \
( number_of_cache_entries > 4 ) ? ( number_of_cache_entries / 4 ) + ( node_offset % ( ( number_of_cache_entries * 3 ) / 4 ) ) : ( node_offset % number_of_cache_entries )
typedef struct libfdata_internal_tree_node libfdata_internal_tree_node_t;
struct libfdata_internal_tree_node
{
/* The tree reference
*/
libfdata_tree_t *tree;
/* The parent (tree) node reference
*/
libfdata_tree_node_t *parent_node;
/* The node data range
*/
libfdata_range_t *node_data_range;
/* The sub nodes data range
*/
libfdata_range_t *sub_nodes_data_range;
/* The timestamp
*/
int64_t timestamp;
/* The flags
*/
uint8_t flags;
/* The sub nodes (array)
*/
libcdata_array_t *sub_nodes;
/* The number of leaf nodes
*/
int number_of_leaf_nodes;
/* The number of deleted leaf nodes
*/
int number_of_deleted_leaf_nodes;
/* The relative first leaf node index
*/
int first_leaf_node_index;
/* The relative first deleted leaf node index
*/
int first_deleted_leaf_node_index;
};
int libfdata_tree_node_initialize(
libfdata_tree_node_t **node,
libfdata_tree_t *tree,
libfdata_tree_node_t *parent_node,
libcerror_error_t **error );
int libfdata_tree_node_free(
libfdata_tree_node_t **node,
libcerror_error_t **error );
int libfdata_tree_node_free_single(
libfdata_tree_node_t **node,
libcerror_error_t **error );
int libfdata_tree_node_set_parent_node(
libfdata_tree_node_t *node,
libfdata_tree_node_t *parent_node,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_is_root(
libfdata_tree_node_t *node,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_get_data_range(
libfdata_tree_node_t *node,
int *node_file_index,
off64_t *node_offset,
size64_t *node_size,
uint32_t *node_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_set_data_range(
libfdata_tree_node_t *node,
int node_file_index,
off64_t node_offset,
size64_t node_size,
uint32_t node_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_sub_nodes_data_range_is_set(
libfdata_tree_node_t *node,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_get_sub_nodes_data_range(
libfdata_tree_node_t *node,
int *sub_nodes_file_index,
off64_t *sub_nodes_offset,
size64_t *sub_nodes_size,
uint32_t *sub_nodes_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_set_sub_nodes_data_range(
libfdata_tree_node_t *node,
int sub_nodes_file_index,
off64_t sub_nodes_offset,
size64_t sub_nodes_size,
uint32_t sub_nodes_flags,
libcerror_error_t **error );
int libfdata_tree_node_get_timestamp(
libfdata_tree_node_t *node,
int64_t *timestamp,
libcerror_error_t **error );
int libfdata_tree_node_get_first_leaf_node_index(
libfdata_tree_node_t *node,
int *first_leaf_node_index,
int *deleted_first_leaf_node_index,
libcerror_error_t **error );
int libfdata_tree_node_set_first_leaf_node_index(
libfdata_tree_node_t *node,
int first_leaf_node_index,
int deleted_first_leaf_node_index,
libcerror_error_t **error );
/* Node value functions
*/
LIBFDATA_EXTERN \
int libfdata_tree_node_get_node_value(
libfdata_tree_node_t *node,
intptr_t *file_io_handle,
libfdata_cache_t *cache,
intptr_t **node_value,
uint8_t read_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_set_node_value(
libfdata_tree_node_t *node,
libfdata_cache_t *cache,
intptr_t *node_value,
int (*free_node_value)(
intptr_t **node_value,
libcerror_error_t **error ),
uint8_t flags,
libcerror_error_t **error );
/* Sub node functions
*/
LIBFDATA_EXTERN \
int libfdata_tree_node_resize_sub_nodes(
libfdata_tree_node_t *node,
int number_of_sub_nodes,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_get_number_of_sub_nodes(
libfdata_tree_node_t *node,
intptr_t *file_io_handle,
libfdata_cache_t *cache,
int *number_of_sub_nodes,
uint8_t read_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_get_sub_node_by_index(
libfdata_tree_node_t *node,
intptr_t *file_io_handle,
libfdata_cache_t *cache,
int sub_node_index,
libfdata_tree_node_t **sub_node,
uint8_t read_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_set_sub_node_by_index(
libfdata_tree_node_t *node,
int sub_node_index,
int node_file_index,
off64_t node_offset,
size64_t node_size,
uint32_t node_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_append_sub_node(
libfdata_tree_node_t *node,
int *sub_node_index,
int node_file_index,
off64_t node_offset,
size64_t node_size,
uint32_t node_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_insert_sub_node(
libfdata_tree_node_t *node,
intptr_t *file_io_handle,
libfdata_cache_t *cache,
int *sub_node_index,
int node_file_index,
off64_t node_offset,
size64_t node_size,
uint32_t node_flags,
int (*node_value_compare_function)(
intptr_t *first_node_value,
intptr_t *second_node_value,
libcerror_error_t **error ),
uint8_t insert_flags,
uint8_t read_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_split_sub_nodes(
libfdata_tree_node_t *node,
int number_of_splits,
libcerror_error_t **error );
/* Deleted node functions
*/
LIBFDATA_EXTERN \
int libfdata_tree_node_is_deleted(
libfdata_tree_node_t *node,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_set_deleted(
libfdata_tree_node_t *node,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_set_deleted_sub_node(
libfdata_tree_node_t *node,
int sub_node_index,
libcerror_error_t **error );
/* Leaf node functions
*/
int libfdata_tree_node_set_calculate_leaf_node_values(
libfdata_tree_node_t *node,
libcerror_error_t **error );
int libfdata_tree_node_read_leaf_node_values(
libfdata_tree_node_t *node,
intptr_t *file_io_handle,
libfdata_cache_t *cache,
uint8_t read_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_is_leaf(
libfdata_tree_node_t *node,
intptr_t *file_io_handle,
libfdata_cache_t *cache,
uint8_t read_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_set_leaf(
libfdata_tree_node_t *node,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_tree_node_set_leaf_sub_node(
libfdata_tree_node_t *node,
int sub_node_index,
libcerror_error_t **error );
int libfdata_tree_node_get_number_of_leaf_nodes(
libfdata_tree_node_t *node,
intptr_t *file_io_handle,
libfdata_cache_t *cache,
int *number_of_leaf_nodes,
uint8_t read_flags,
libcerror_error_t **error );
int libfdata_tree_node_get_leaf_node_by_index(
libfdata_tree_node_t *node,
intptr_t *file_io_handle,
libfdata_cache_t *cache,
int leaf_node_index,
libfdata_tree_node_t **leaf_node,
uint8_t read_flags,
libcerror_error_t **error );
int libfdata_tree_node_get_number_of_deleted_leaf_nodes(
libfdata_tree_node_t *node,
intptr_t *file_io_handle,
libfdata_cache_t *cache,
int *number_of_deleted_leaf_nodes,
uint8_t read_flags,
libcerror_error_t **error );
int libfdata_tree_node_get_deleted_leaf_node_by_index(
libfdata_tree_node_t *node,
intptr_t *file_io_handle,
libfdata_cache_t *cache,
int deleted_leaf_node_index,
libfdata_tree_node_t **deleted_leaf_node,
uint8_t read_flags,
libcerror_error_t **error );
#if defined( __cplusplus )
}
#endif
#endif /* !defined( _LIBFDATA_INTERNAL_TREE_NODE_H ) */
|