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
|
/*
* The stream functions
*
* Copyright (C) 2010-2024, Joachim Metz <joachim.metz@gmail.com>
*
* 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 <https://www.gnu.org/licenses/>.
*/
#if !defined( _LIBFDATA_INTERNAL_STREAM_H )
#define _LIBFDATA_INTERNAL_STREAM_H
#include <common.h>
#include <types.h>
#include "libfdata_extern.h"
#include "libfdata_libcdata.h"
#include "libfdata_libcerror.h"
#include "libfdata_mapped_range.h"
#include "libfdata_range.h"
#include "libfdata_types.h"
#if defined( __cplusplus )
extern "C" {
#endif
typedef struct libfdata_internal_stream libfdata_internal_stream_t;
struct libfdata_internal_stream
{
/* The current segment index
*/
int current_segment_index;
/* The current segment data range
*/
libfdata_range_t *current_segment_data_range;
/* The current offset
*/
off64_t current_offset;
/* The (current) segment offset
*/
off64_t segment_offset;
/* The (current) segment data offset
*/
off64_t segment_data_offset;
/* The (stream) size
*/
size64_t size;
/* The mapped (stream) size
*/
size64_t mapped_size;
/* The segments array
*/
libcdata_array_t *segments_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 create segment function
*/
int (*create_segment)(
intptr_t *data_handle,
intptr_t *file_io_handle,
int segment_index,
int *segment_file_index,
off64_t *segment_offset,
size64_t *segment_size,
uint32_t *segment_flags,
libcerror_error_t **error );
/* The read segment data function
*/
ssize_t (*read_segment_data)(
intptr_t *data_handle,
intptr_t *file_io_handle,
int segment_index,
int segment_file_index,
uint8_t *segment_data,
size_t segment_data_size,
uint32_t segment_flags,
uint8_t read_flags,
libcerror_error_t **error );
/* The write segment data function
*/
ssize_t (*write_segment_data)(
intptr_t *data_handle,
intptr_t *file_io_handle,
int segment_index,
int segment_file_index,
const uint8_t *segment_data,
size_t segment_data_size,
uint32_t segment_flags,
uint8_t write_flags,
libcerror_error_t **error );
/* The seek segment offset function
*/
off64_t (*seek_segment_offset)(
intptr_t *data_handle,
intptr_t *file_io_handle,
int segment_index,
int segment_file_index,
off64_t segment_offset,
libcerror_error_t **error );
};
LIBFDATA_EXTERN \
int libfdata_stream_initialize(
libfdata_stream_t **stream,
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 (*create_segment)(
intptr_t *data_handle,
intptr_t *file_io_handle,
int segment_index,
int *segment_file_index,
off64_t *segment_offset,
size64_t *segment_size,
uint32_t *segment_flags,
libcerror_error_t **error ),
ssize_t (*read_segment_data)(
intptr_t *data_handle,
intptr_t *file_io_handle,
int segment_index,
int segment_file_index,
uint8_t *segment_data,
size_t segment_data_size,
uint32_t segment_flags,
uint8_t read_flags,
libcerror_error_t **error ),
ssize_t (*write_segment_data)(
intptr_t *data_handle,
intptr_t *file_io_handle,
int segment_index,
int segment_file_index,
const uint8_t *segment_data,
size_t segment_data_size,
uint32_t segment_flags,
uint8_t write_flags,
libcerror_error_t **error ),
off64_t (*seek_segment_offset)(
intptr_t *data_handle,
intptr_t *file_io_handle,
int segment_index,
int segment_file_index,
off64_t segment_offset,
libcerror_error_t **error ),
uint8_t flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_stream_free(
libfdata_stream_t **stream,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_stream_clone(
libfdata_stream_t **destination_stream,
libfdata_stream_t *source_stream,
libcerror_error_t **error );
/* Segment functions
*/
LIBFDATA_EXTERN \
int libfdata_stream_empty(
libfdata_stream_t *stream,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_stream_resize(
libfdata_stream_t *stream,
int number_of_segments,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_stream_reverse(
libfdata_stream_t *stream,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_stream_get_number_of_segments(
libfdata_stream_t *stream,
int *number_of_segments,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_stream_get_segment_by_index(
libfdata_stream_t *stream,
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_stream_set_segment_by_index(
libfdata_stream_t *stream,
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_stream_prepend_segment(
libfdata_stream_t *stream,
int segment_file_index,
off64_t segment_offset,
size64_t segment_size,
uint32_t segment_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_stream_append_segment(
libfdata_stream_t *stream,
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_stream_set_mapped_size(
libfdata_stream_t *stream,
size64_t mapped_size,
libcerror_error_t **error );
/* Mapped range functions
*/
LIBFDATA_EXTERN \
int libfdata_stream_get_segment_mapped_range(
libfdata_stream_t *stream,
int segment_index,
off64_t *mapped_range_offset,
size64_t *mapped_range_size,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_stream_get_segment_index_at_offset(
libfdata_stream_t *stream,
off64_t offset,
int *segment_index,
off64_t *segment_data_offset,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_stream_get_segment_at_offset(
libfdata_stream_t *stream,
off64_t offset,
int *segment_index,
off64_t *segment_data_offset,
int *segment_file_index,
off64_t *segment_offset,
size64_t *segment_size,
uint32_t *segment_flags,
libcerror_error_t **error );
/* IO functions
*/
LIBFDATA_EXTERN \
ssize_t libfdata_stream_read_buffer(
libfdata_stream_t *stream,
intptr_t *file_io_handle,
uint8_t *buffer,
size_t buffer_size,
uint8_t read_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
ssize_t libfdata_stream_read_buffer_at_offset(
libfdata_stream_t *stream,
intptr_t *file_io_handle,
uint8_t *buffer,
size_t buffer_size,
off64_t offset,
uint8_t read_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
ssize_t libfdata_stream_write_buffer(
libfdata_stream_t *stream,
intptr_t *file_io_handle,
const uint8_t *buffer,
size_t buffer_size,
uint8_t write_flags,
libcerror_error_t **error );
LIBFDATA_EXTERN \
off64_t libfdata_stream_seek_offset(
libfdata_stream_t *stream,
off64_t offset,
int whence,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_stream_get_offset(
libfdata_stream_t *stream,
off64_t *offset,
libcerror_error_t **error );
LIBFDATA_EXTERN \
int libfdata_stream_get_size(
libfdata_stream_t *stream,
size64_t *size,
libcerror_error_t **error );
#if defined( __cplusplus )
}
#endif
#endif /* !defined( _LIBFDATA_INTERNAL_STREAM_H ) */
|
