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
|
/*
File: photorec.h
Copyright (C) 1998-2008 Christophe GRENIER <grenier@cgsecurity.org>
This software is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 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 General Public License along
with this program; if not, write the Free Software Foundation, Inc., 51
Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef _TESTDISK_PHOTOREC_H
#define _TESTDISK_PHOTOREC_H
#define MAX_FILES_PER_DIR 500
#define DEFAULT_RECUP_DIR "recup_dir"
#ifdef __cplusplus
extern "C" {
#endif
enum photorec_status { STATUS_FIND_OFFSET, STATUS_UNFORMAT, STATUS_EXT2_ON, STATUS_EXT2_ON_BF, STATUS_EXT2_OFF, STATUS_EXT2_OFF_BF, STATUS_EXT2_ON_SAVE_EVERYTHING, STATUS_EXT2_OFF_SAVE_EVERYTHING, STATUS_QUIT };
typedef enum photorec_status photorec_status_t;
typedef enum { PSTATUS_OK=0, PSTATUS_STOP=1, PSTATUS_EACCES=2, PSTATUS_ENOSPC=3} pstatus_t;
typedef enum { PFSTATUS_BAD=0, PFSTATUS_OK=1, PFSTATUS_OK_TRUNCATED=2} pfstatus_t;
struct ph_options
{
int paranoid;
int keep_corrupted_file;
unsigned int mode_ext2;
unsigned int expert;
unsigned int lowmem;
int verbose;
file_enable_t *list_file_format;
};
struct ph_param
{
char *cmd_device;
char *cmd_run;
disk_t *disk;
partition_t *partition;
unsigned int carve_free_space_only;
unsigned int blocksize;
unsigned int pass;
photorec_status_t status;
time_t real_start_time;
char *recup_dir;
/* */
unsigned int dir_num;
unsigned int file_nbr;
file_stat_t *file_stats;
uint64_t offset;
};
/*@
predicate valid_ph_param(struct ph_param *p) = (\valid_read(p) &&
(p->recup_dir == \null || valid_read_string(p->recup_dir)) &&
(p->disk == \null || valid_disk(p->disk)) &&
(p->cmd_run == \null || valid_read_string(p->cmd_run))
);
@*/
#define PH_INVALID_OFFSET 0xffffffffffffffff
/*@
@ requires valid_list_search_space(list_search_space);
@ requires \separated(list_search_space, current_search_space, offset);
@ requires current_search_space==\null || (\valid(*current_search_space) && valid_list_search_space(*current_search_space));
@ ensures \result==0 ==> (*current_search_space!=list_search_space && *offset == (*current_search_space)->start);
@*/
// ensures current_search_space==\null || (\valid(*current_search_space) && valid_list_search_space(*current_search_space));
int get_prev_file_header(const alloc_data_t *list_search_space, alloc_data_t **current_search_space, uint64_t *offset);
/*@
@ requires valid_file_recovery(file_recovery);
@ requires \valid(params);
@ requires valid_ph_param(params);
@ requires valid_list_search_space(list_search_space);
@ requires \separated(file_recovery, params, list_search_space);
@ requires valid_disk(params->disk);
@*/
int file_finish_bf(file_recovery_t *file_recovery, struct ph_param *params,
alloc_data_t *list_search_space);
/*@
@ requires \valid(file_recovery);
@ requires valid_file_recovery(file_recovery);
@ requires valid_list_search_space(list_search_space);
@ requires \valid(params);
@ requires valid_ph_param(params);
@ requires \separated(file_recovery, params, list_search_space, &errno);
@*/
void file_recovery_aborted(file_recovery_t *file_recovery, struct ph_param *params, alloc_data_t *list_search_space);
/*@
@ requires \valid(file_recovery);
@ requires valid_file_recovery(file_recovery);
@ requires \valid(params);
@ requires valid_ph_param(params);
@ requires valid_list_search_space(list_search_space);
@ requires \separated(file_recovery, params, list_search_space);
@ requires valid_disk(params->disk);
@ ensures \result == PFSTATUS_BAD || \result == PFSTATUS_OK || \result == PFSTATUS_OK_TRUNCATED;
@*/
// ensures valid_file_recovery(file_recovery);
pfstatus_t file_finish2(file_recovery_t *file_recovery, struct ph_param *params, const int paranoid, alloc_data_t *list_search_space);
/*@
@ requires \valid_read(file_stats);
@*/
void write_stats_log(const file_stat_t *file_stats);
/*@
@ requires \valid(file_stats);
@ requires valid_list_search_space(list_search_space);
@ requires \separated(file_stats, list_search_space);
@*/
//ensures valid_list_search_space(list_search_space);
void update_stats(file_stat_t *file_stats, alloc_data_t *list_search_space);
/*@
@ requires \valid_read(disk_car);
@ requires valid_disk(disk_car);
@*/
// ensures valid_partition(\result);
partition_t *new_whole_disk(const disk_t *disk_car);
/*@
@ requires valid_list_search_space(list_file);
@ requires \valid(offset);
@ requires \separated(list_file, offset);
@ requires default_blocksize > 0;
@*/
// ensures \result > 0;
unsigned int find_blocksize(const alloc_data_t *list_file, const unsigned int default_blocksize, uint64_t *offset);
/*@
@ requires blocksize > 0;
@ requires valid_list_search_space(list_search_space);
@*/
void update_blocksize(const unsigned int blocksize, alloc_data_t *list_search_space, const uint64_t offset);
/*@
@ requires valid_list_search_space(list_search_space);
@ requires current_search_space==\null || valid_list_search_space(current_search_space);
@*/
// ensures current_search_space==\null || valid_list_search_space(current_search_space);
void forget(const alloc_data_t *list_search_space, alloc_data_t *current_search_space);
/*@
@ requires valid_list_search_space(list_search_space);
@ requires \valid_read(disk_car);
@ requires valid_disk(disk_car);
@ requires disk_car->disk_size > 0;
@ requires disk_car->disk_real_size > 0;
@ requires \valid_read(partition);
@ requires separation: \separated(list_search_space, disk_car, partition);
@*/
void init_search_space(alloc_data_t *list_search_space, const disk_t *disk_car, const partition_t *partition);
/*@
@ requires valid_disk(disk_car);
@ requires valid_list_search_space(list_search_space);
@ requires \separated(disk_car, partition, list_search_space);
@ ensures valid_list_search_space(list_search_space);
@ ensures valid_disk(disk_car);
@ ensures valid_list_search_space(list_search_space);
@*/
unsigned int remove_used_space(disk_t *disk_car, const partition_t *partition, alloc_data_t *list_search_space);
/*@
@ requires valid_list_search_space(list_search_space);
@*/
void free_list_search_space(alloc_data_t *list_search_space);
/*@
@ requires \valid_read((const file_stat_t *)p1);
@ requires \valid_read((const file_stat_t *)p2);
@ terminates \true;
@ assigns \nothing;
@*/
int sorfile_stat_ts(const void *p1, const void *p2);
/*@
@ requires valid_read_string(recup_dir);
@ requires \separated(recup_dir, &errno);
@*/
unsigned int photorec_mkdir(const char *recup_dir, const unsigned int initial_dir_num);
/*@
@ requires valid_list_search_space(list_search_space);
@ requires \separated(list_search_space, current_search_space);
@ ensures valid_list_search_space(list_search_space);
@*/
void info_list_search_space(const alloc_data_t *list_search_space, const alloc_data_t *current_search_space, const unsigned int sector_size, const int keep_corrupted_file, const int verbose);
/*@
@ requires valid_list_search_space(list_search_space);
@*/
void free_search_space(alloc_data_t *list_search_space);
/*@
@ requires \valid(file_recovery);
@ requires valid_file_recovery(file_recovery);
@ requires \valid(params);
@ requires valid_ph_param(params);
@ requires \separated(file_recovery, params);
@ requires valid_disk(params->disk);
@*/
// ensures valid_file_recovery(file_recovery);
void set_filename(file_recovery_t *file_recovery, struct ph_param *params);
/*@
@ requires \valid(params);
@ requires valid_ph_param(params);
@ requires valid_disk(params->disk);
@ requires valid_list_search_space(list_search_space);
@ requires \separated(params, new_current_search_space, list_search_space);
@ requires \valid(*new_current_search_space);
@ requires valid_list_search_space(*new_current_search_space);
@*/
// ensures \valid(*new_current_search_space) && valid_list_search_space(*new_current_search_space);
// ensures valid_list_search_space(list_search_space);
uint64_t set_search_start(struct ph_param *params, alloc_data_t **new_current_search_space, alloc_data_t *list_search_space);
/*@
@ requires \valid(params);
@ requires valid_ph_param(params);
@ requires \valid_read(options);
@ requires \separated(params, options);
@ requires params->disk->sector_size > 0;
@ requires valid_read_string(params->recup_dir);
@ requires valid_file_enable_node(options->list_file_format);
@ ensures valid_ph_param(params);
@ ensures params->file_nbr == 0;
@ ensures params->status == STATUS_FIND_OFFSET;
@ ensures params->dir_num == 1;
@ ensures params->offset == PH_INVALID_OFFSET;
@ ensures params->blocksize > 0;
@ ensures valid_read_string(params->recup_dir);
@*/
void params_reset(struct ph_param *params, const struct ph_options *options);
/*@
@ assigns \nothing;
@*/
const char *status_to_name(const photorec_status_t status);
/*@
@ requires \valid(params);
@ requires valid_ph_param(params);
@ requires \valid_read(options);
@ requires \separated(params, options);
@ ensures valid_ph_param(params);
@ assigns params->offset, params->status, params->file_nbr;
@*/
void status_inc(struct ph_param *params, const struct ph_options *options);
/*@
@ requires \valid(disk);
@ requires valid_disk(disk);
@ requires \valid_read(&disk->arch);
@ requires \valid_function(disk->arch->read_part);
@ requires \valid_read(options);
@ requires \separated(disk, options);
@ decreases 0;
@ ensures valid_disk(disk);
@*/
// ensures valid_list_part(\result);
list_part_t *init_list_part(disk_t *disk, const struct ph_options *options);
/*@
@ requires valid_file_recovery(file_recovery);
@*/
// ensures valid_file_recovery(file_recovery);
void file_block_log(const file_recovery_t *file_recovery, const unsigned int sector_size);
/*@
@ requires valid_file_recovery(file_recovery);
@ requires valid_list_search_space(list_search_space);
@ requires \separated(file_recovery, list_search_space, new_current_search_space, offset);
@ requires new_current_search_space==\null || (\valid(*new_current_search_space) && valid_list_search_space(*new_current_search_space));
@*/
// ensures new_current_search_space==\null || (\valid(*new_current_search_space) && valid_list_search_space(*new_current_search_space));
// ensures valid_file_recovery(file_recovery);
// ensures valid_list_search_space(list_search_space);
void file_block_append(file_recovery_t *file_recovery, alloc_data_t *list_search_space, alloc_data_t **new_current_search_space, uint64_t *offset, const unsigned int blocksize, const unsigned int data);
/*@
@ requires valid_file_recovery(file_recovery);
@ requires valid_list_search_space(list_search_space);
@ requires \separated(file_recovery, list_search_space, new_current_search_space, offset, buffer + (..));
@ requires new_current_search_space==\null || (\valid(*new_current_search_space) && valid_list_search_space(*new_current_search_space));
@ decreases 0;
@*/
// ensures new_current_search_space==\null || (\valid(*new_current_search_space) && valid_list_search_space(*new_current_search_space));
// ensures valid_file_recovery(file_recovery);
// ensures valid_list_search_space(list_search_space);
void file_block_truncate_and_move(file_recovery_t *file_recovery, alloc_data_t *list_search_space, const unsigned int blocksize, alloc_data_t **new_current_search_space, uint64_t *offset, unsigned char *buffer);
/*@
@ requires \valid(list_search_space);
@ requires valid_list_search_space(list_search_space);
@*/
void del_search_space(alloc_data_t *list_search_space, const uint64_t start, const uint64_t end);
#ifdef __cplusplus
} /* closing brace for extern "C" */
#endif
#endif
|
