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
|
/*
* The handle functions
*
* Copyright (C) 2009-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( _LIBBFIO_INTERNAL_HANDLE_H )
#define _LIBBFIO_INTERNAL_HANDLE_H
#include <common.h>
#include <types.h>
#include "libbfio_extern.h"
#include "libbfio_libcdata.h"
#include "libbfio_libcerror.h"
#include "libbfio_libcthreads.h"
#include "libbfio_types.h"
#if defined( __cplusplus )
extern "C" {
#endif
typedef struct libbfio_internal_handle libbfio_internal_handle_t;
struct libbfio_internal_handle
{
/* The IO handle
*/
intptr_t *io_handle;
/* The flags
*/
uint8_t flags;
/* The access flags
*/
int access_flags;
/* The current offset
*/
off64_t current_offset;
/* The size
*/
size64_t size;
/* Value to indicate the size was set
*/
uint8_t size_set;
/* Value to indicate to open and close
* the systems file descriptor or handle on demand
*/
uint8_t open_on_demand;
/* Reference to the pool last used list element
*/
libcdata_list_element_t *pool_last_used_list_element;
/* Value to indicate to track offsets read
*/
uint8_t track_offsets_read;
/* The offset ranges that were read
*/
libcdata_range_list_t *offsets_read;
/* The narrow string codepage
*/
int narrow_string_codepage;
/* The free IO handle function
*/
int (*free_io_handle)(
intptr_t **io_handle,
libcerror_error_t **error );
/* The clone (duplicate) IO handle function
*/
int (*clone_io_handle)(
intptr_t **destination_io_handle,
intptr_t *source_io_handle,
libcerror_error_t **error );
/* The open function
*/
int (*open)(
intptr_t *io_handle,
int access_flags,
libcerror_error_t **error );
/* The close function
*/
int (*close)(
intptr_t *io_handle,
libcerror_error_t **error );
/* The read function
*/
ssize_t (*read)(
intptr_t *io_handle,
uint8_t *buffer,
size_t size,
libcerror_error_t **error );
/* The write function
*/
ssize_t (*write)(
intptr_t *io_handle,
const uint8_t *buffer,
size_t size,
libcerror_error_t **error );
/* The seek offset function
*/
off64_t (*seek_offset)(
intptr_t *io_handle,
off64_t offset,
int whence,
libcerror_error_t **error );
/* The exists function
*/
int (*exists)(
intptr_t *io_handle,
libcerror_error_t **error );
/* The is open function
*/
int (*is_open)(
intptr_t *io_handle,
libcerror_error_t **error );
/* The get size function
*/
int (*get_size)(
intptr_t *io_handle,
size64_t *size,
libcerror_error_t **error );
#if defined( HAVE_MULTI_THREAD_SUPPORT ) && !defined( HAVE_LOCAL_LIBBFIO )
/* The read/write lock
*/
libcthreads_read_write_lock_t *read_write_lock;
#endif
};
LIBBFIO_EXTERN \
int libbfio_handle_initialize(
libbfio_handle_t **handle,
intptr_t *io_handle,
int (*free_io_handle)(
intptr_t **io_handle,
libcerror_error_t **error ),
int (*clone_io_handle)(
intptr_t **destination_io_handle,
intptr_t *source_io_handle,
libcerror_error_t **error ),
int (*open)(
intptr_t *io_handle,
int access_flags,
libcerror_error_t **error ),
int (*close)(
intptr_t *io_handle,
libcerror_error_t **error ),
ssize_t (*read)(
intptr_t *io_handle,
uint8_t *buffer,
size_t size,
libcerror_error_t **error ),
ssize_t (*write)(
intptr_t *io_handle,
const uint8_t *buffer,
size_t size,
libcerror_error_t **error ),
off64_t (*seek_offset)(
intptr_t *io_handle,
off64_t offset,
int whence,
libcerror_error_t **error ),
int (*exists)(
intptr_t *io_handle,
libcerror_error_t **error ),
int (*is_open)(
intptr_t *io_handle,
libcerror_error_t **error ),
int (*get_size)(
intptr_t *io_handle,
size64_t *size,
libcerror_error_t **error ),
uint8_t flags,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_free(
libbfio_handle_t **handle,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_clone(
libbfio_handle_t **destination_handle,
libbfio_handle_t *source_handle,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_open(
libbfio_handle_t *handle,
int access_flags,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_reopen(
libbfio_handle_t *handle,
int access_flags,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_close(
libbfio_handle_t *handle,
libcerror_error_t **error );
LIBBFIO_EXTERN \
ssize_t libbfio_handle_read_buffer(
libbfio_handle_t *handle,
uint8_t *buffer,
size_t size,
libcerror_error_t **error );
LIBBFIO_EXTERN \
ssize_t libbfio_handle_write_buffer(
libbfio_handle_t *handle,
const uint8_t *buffer,
size_t size,
libcerror_error_t **error );
LIBBFIO_EXTERN \
off64_t libbfio_handle_seek_offset(
libbfio_handle_t *handle,
off64_t offset,
int whence,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_exists(
libbfio_handle_t *handle,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_is_open(
libbfio_handle_t *handle,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_get_io_handle(
libbfio_handle_t *handle,
intptr_t **io_handle,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_get_access_flags(
libbfio_handle_t *handle,
int *access_flags,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_set_access_flags(
libbfio_handle_t *handle,
int access_flags,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_get_size(
libbfio_handle_t *handle,
size64_t *size,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_get_offset(
libbfio_handle_t *handle,
off64_t *offset,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_set_open_on_demand(
libbfio_handle_t *handle,
uint8_t open_on_demand,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_set_track_offsets_read(
libbfio_handle_t *handle,
uint8_t track_offsets_read,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_get_number_of_offsets_read(
libbfio_handle_t *handle,
int *number_of_read_offsets,
libcerror_error_t **error );
LIBBFIO_EXTERN \
int libbfio_handle_get_offset_read(
libbfio_handle_t *handle,
int index,
off64_t *offset,
size64_t *size,
libcerror_error_t **error );
#if defined( __cplusplus )
}
#endif
#endif /* !defined( _LIBBFIO_INTERNAL_HANDLE_H ) */
|
