File: libfdata_definitions.h

package info (click to toggle)
libpff 20120802-5
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 13,524 kB
  • ctags: 6,784
  • sloc: ansic: 214,206; sh: 11,485; makefile: 1,229; python: 138; java: 137; sed: 16
file content (226 lines) | stat: -rw-r--r-- 5,761 bytes parent folder | download | duplicates (2)
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
/*
 * The internal definitions
 *
 * Copyright (c) 2010-2012, 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_DEFINITIONS_H )
#define _LIBFDATA_INTERNAL_DEFINITIONS_H

#include <common.h>

/* Define HAVE_LOCAL_LIBFDATA for local use of libfdata
 */
#if !defined( HAVE_LOCAL_LIBFDATA )
#include <libfdata/definitions.h>

/* The definitions in <libfdata/definitions.h> are copied here
 * for local use of libfdata
 */
#else
#define LIBFDATA_VERSION						20120519

/* The libfdata version string
 */
#define LIBFDATA_VERSION_STRING						"20120519"

/* The library flags definitions
 */
enum LIBFDATA_FLAGS
{
	/* The IO handle is not managed by the library
	 */
        LIBFDATA_FLAG_IO_HANDLE_NON_MANAGED				= 0x00,

	/* The IO handle is managed by the library
	 */
        LIBFDATA_FLAG_IO_HANDLE_MANAGED					= 0x01,
};

/* The buffer data flags definitions
 */
enum LIBFDATA_BUFFER_DATA_FLAGS
{
	LIBFDATA_BUFFER_DATA_FLAG_NON_MANAGED				= LIBFDATA_FLAG_IO_HANDLE_NON_MANAGED,
	LIBFDATA_BUFFER_DATA_FLAG_MANAGED				= LIBFDATA_FLAG_IO_HANDLE_MANAGED
};

/* The list flags definitions
 */
enum LIBFDATA_LIST_FLAGS
{
	/* The value offsets need to be calculated
	 */
        LIBFDATA_LIST_FLAG_CALCULATE_VALUE_OFFSETS			= 0x10,
};

/* The list element value flags definitions
 */
enum LIBFDATA_LIST_ELEMENT_VALUE_FLAGS
{
	LIBFDATA_LIST_ELEMENT_VALUE_FLAG_NON_MANAGED			= LIBFDATA_FLAG_IO_HANDLE_NON_MANAGED,
	LIBFDATA_LIST_ELEMENT_VALUE_FLAG_MANAGED			= LIBFDATA_FLAG_IO_HANDLE_MANAGED
};

/* The range flags definitions
 */
enum LIBFDATA_RANGE_FLAGS
{
	/* The range is sparse
	 */
        LIBFDATA_RANGE_FLAG_IS_SPARSE					= 0x00000001UL,

	/* The range is compressed
	 */
        LIBFDATA_RANGE_FLAG_IS_COMPRESSED				= 0x00000002UL,

	/* The range is tainted (possibly corrupted)
	 */
        LIBFDATA_RANGE_FLAG_IS_TAINTED					= 0x00000010UL,

	/* The range is corrupted
	 */
        LIBFDATA_RANGE_FLAG_IS_CORRUPTED				= 0x00000020UL,

	/* User defined flags
	 */
        LIBFDATA_RANGE_FLAG_USER_DEFINED_1				= 0x00000100UL,
        LIBFDATA_RANGE_FLAG_USER_DEFINED_2				= 0x00000200UL,
        LIBFDATA_RANGE_FLAG_USER_DEFINED_3				= 0x00000400UL,
        LIBFDATA_RANGE_FLAG_USER_DEFINED_4				= 0x00000800UL,
};

#define LIBFDATA_RANGE_FLAG_MAXIMUM \
	LIBFDATA_RANGE_FLAG_USER_DEFINED_4

/* The read flags definitions
 */
enum LIBFDATA_READ_FLAGS
{
	/* Ignore data cached by the library
	 */
        LIBFDATA_READ_FLAG_IGNORE_CACHE					= 0x01
};

/* The reference type definitions
 */
enum LIBFDATA_REFERENCE_TYPES
{
	LIBFDATA_REFERENCE_TYPE_BUFFER					= 1,
	LIBFDATA_REFERENCE_TYPE_BLOCK					= 2
};

/* The reference flags definitions
 */
enum LIBFDATA_REFERENCE_FLAGS
{
	LIBFDATA_REFERENCE_FLAG_NON_MANAGED				= LIBFDATA_FLAG_IO_HANDLE_NON_MANAGED,
	LIBFDATA_REFERENCE_FLAG_MANAGED					= LIBFDATA_FLAG_IO_HANDLE_MANAGED
};

/* The segment data flags definitions
 */
enum LIBFDATA_SEGMENT_DATA_FLAGS
{
	LIBFDATA_SEGMENT_DATA_FLAG_NON_MANAGED				= LIBFDATA_FLAG_IO_HANDLE_NON_MANAGED,
	LIBFDATA_SEGMENT_DATA_FLAG_MANAGED				= LIBFDATA_FLAG_IO_HANDLE_MANAGED
};

/* The tree node comparison definitions
 */
enum LIBFDATA_TREE_NODE_COMPARE_DEFINITIONS
{
	/* The first node value is less than the second node value
	 */
        LIBFDATA_TREE_NODE_COMPARE_LESS,

	/* The first and second node values are equal
	 */
        LIBFDATA_TREE_NODE_COMPARE_EQUAL,

	/* The first node value is greater than the second node value
	 */
        LIBFDATA_TREE_NODE_COMPARE_GREATER
};

/* The tree node flags definitions
 */
enum LIBFDATA_TREE_NODE_FLAGS
{
	/* The node is virtual
	 */
	LIBFDATA_TREE_NODE_FLAG_IS_VIRTUAL				= 0x02,

	/* The node is deleted
	 */
	LIBFDATA_TREE_NODE_FLAG_IS_DELETED				= 0x04,

	/* The node is a leaf
	 */
	LIBFDATA_TREE_NODE_FLAG_IS_LEAF					= 0x08,

	/* The sub nodes range was set
	 */
	LIBFDATA_TREE_NODE_FLAG_SUB_NODES_RANGE_SET			= 0x10,

	/* The sub nodes have been read
	 */
	LIBFDATA_TREE_NODE_FLAG_SUB_NODES_READ				= 0x20,

	/* The node data has been read (at least once)
	 */
	LIBFDATA_TREE_NODE_FLAG_NOTE_DATA_READ				= 0x40,

	/* The leaf nodes values need to be calculated
	 */
	LIBFDATA_TREE_NODE_FLAG_CALCULATE_LEAF_NODE_VALUES		= 0x80
};

/* The tree node insert flag definitions
 */
enum LIBFDATA_TREE_NODE_INSERT_FLAGS
{
	/* Allow duplicate sub node values
	 */
	LIBFDATA_TREE_NODE_INSERT_FLAG_NON_UNIQUE_SUB_NODE_VALUES	= 0x00,

	/* Only allow unique sub node values, no duplicates
	 */
	LIBFDATA_TREE_NODE_INSERT_FLAG_UNIQUE_SUB_NODE_VALUES		= 0x01,
};

/* The tree node value flags definitions
 */
enum LIBFDATA_TREE_NODE_VALUE_FLAGS
{
	LIBFDATA_TREE_NODE_VALUE_FLAG_NON_MANAGED			= LIBFDATA_FLAG_IO_HANDLE_NON_MANAGED,
	LIBFDATA_TREE_NODE_VALUE_FLAG_MANAGED				= LIBFDATA_FLAG_IO_HANDLE_MANAGED
};

/* The vector element value flags definitions
 */
enum LIBFDATA_VECTOR_ELEMENT_VALUE_FLAGS
{
	LIBFDATA_VECTOR_ELEMENT_VALUE_FLAG_NON_MANAGED			= LIBFDATA_FLAG_IO_HANDLE_NON_MANAGED,
	LIBFDATA_VECTOR_ELEMENT_VALUE_FLAG_MANAGED			= LIBFDATA_FLAG_IO_HANDLE_MANAGED
};

#endif

#endif