summaryrefslogtreecommitdiffstats
path: root/src/fnctdsk.h
blob: 5393baa1e1bf222d13dc0290f5a0aadb147336cd (plain)
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
/*

    File: fnctdsk.h

    Copyright (C) 1998-2007 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 _FNCTDSK_H
#define _FNCTDSK_H
#ifdef __cplusplus
extern "C" {
#endif

/*@
  @ requires \valid_read(disk_car);
  @ requires valid_disk(disk_car);
  @ assigns \nothing;
  @*/
unsigned long int C_H_S2LBA(const disk_t *disk_car,const unsigned int C, const unsigned int H, const unsigned int S);

/*@
  @ requires \valid_read(disk_car);
  @ requires valid_disk(disk_car);
  @ requires \valid_read(CHS);
  @ assigns \nothing;
  @*/
uint64_t CHS2offset(const disk_t *disk_car, const CHS_t*CHS);

/*@
  @ requires \valid_read(disk_car);
  @ requires valid_disk(disk_car);
  @ requires disk_car->sector_size > 0;
  @ requires disk_car->geom.sectors_per_head > 0;
  @ assigns \nothing;
  @ ensures 0 < \result <= disk_car->geom.sectors_per_head;
  @*/
unsigned int offset2sector(const disk_t *disk_car, const uint64_t offset);

/*@
  @ requires \valid_read(disk_car);
  @ requires valid_disk(disk_car);
  @ requires disk_car->sector_size > 0;
  @ requires disk_car->geom.sectors_per_head > 0;
  @ requires disk_car->geom.heads_per_cylinder > 0;
  @ assigns \nothing;
  @ ensures \result <= disk_car->geom.heads_per_cylinder;
  @*/
unsigned int offset2head(const disk_t *disk_car, const uint64_t offset);

/*@
  @ requires \valid_read(disk_car);
  @ requires valid_disk(disk_car);
  @ requires disk_car->sector_size > 0;
  @ requires disk_car->geom.sectors_per_head > 0;
  @ requires disk_car->geom.heads_per_cylinder > 0;
  @ assigns \nothing;
  @*/
unsigned int offset2cylinder(const disk_t *disk_car, const uint64_t offset);

/*@
  @ requires \valid_read(disk_car);
  @ requires valid_disk(disk_car);
  @ requires \valid(CHS);
  @ requires disk_car->sector_size > 0;
  @ requires disk_car->geom.sectors_per_head > 0;
  @ requires disk_car->geom.heads_per_cylinder > 0;
  @ requires \separated(disk_car, CHS);
  @ assigns CHS->cylinder,CHS->head,CHS->sector;
  @*/
void offset2CHS(const disk_t *disk_car,const uint64_t offset, CHS_t*CHS);

/*@
  @ requires valid_list_disk(list_disk);
  @ requires \valid(disk);
  @ requires valid_disk(disk);
  @ requires disk==\null || \separated(disk, \union(list_disk, the_disk));
  @ requires the_disk==\null || (\valid(the_disk) && valid_disk(*the_disk) && \separated(the_disk, \union(list_disk, disk)));
  @ decreases 0;
  @*/
// ensures \result==\null || (\valid(\result) && valid_disk(\result->disk));
// ensures valid_list_disk(\result);
// ensures disk==\null ==> \result == list_disk;
// ensures the_disk==\null || (\valid_read(the_disk) && valid_disk(*the_disk));
list_disk_t *insert_new_disk_aux(list_disk_t *list_disk, disk_t *disk, disk_t **the_disk);

/*@
  @ requires list_disk==\null || valid_disk(list_disk->disk);
  @ requires \valid(disk_car);
  @ requires valid_disk(disk_car);
  @ requires valid_list_disk(list_disk);
  @ requires (list_disk==\null && disk_car==\null) || \separated(list_disk, disk_car);
  @*/
// ensures \result==\null || (\valid(\result) && valid_disk(\result->disk));
// ensures disk_car==\null ==> \result == list_disk;
// ensures valid_list_disk(\result);
list_disk_t *insert_new_disk(list_disk_t *list_disk, disk_t *disk_car);

/*@
  @ requires list_part == \null || \valid(list_part);
  @ requires valid_list_part(list_part);
  @ requires valid_partition(part);
  @ requires \valid(insert_error);
  @ requires (list_part==\null && part==\null) || \separated(list_part, part, insert_error);
  @ ensures  valid_list_part(\result);
  @*/
list_part_t *insert_new_partition(list_part_t *list_part, partition_t *part, const int force_insert, int *insert_error);

/*@
  @ requires \valid(list_part);
  @ requires valid_list_part(list_part);
  @ ensures  valid_list_part(\result);
  @*/
list_part_t *sort_partition_list(list_part_t *list_part);

/*@
  @ requires \valid_read(list_part);
  @ requires valid_list_part(list_part);
  @ ensures  valid_list_part(\result);
  @*/
list_part_t *gen_sorted_partition_list(const list_part_t *list_part);

/*@
  @ requires \valid(list_part);
  @ requires valid_list_part(list_part);
  @*/
void part_free_list(list_part_t *list_part);

/*@
  @ requires \valid(list_part);
  @ requires valid_list_part(list_part);
  @*/
void part_free_list_only(list_part_t *list_part);

/*@
  @ requires \valid(partition);
  @ requires valid_partition(partition);
  @ requires \valid_read(arch);
  @ requires \separated(partition, arch);
  @ ensures partition->part_size == 0;
  @ ensures partition->sborg_offset == 0;
  @ ensures partition->sb_offset == 0;
  @ ensures partition->sb_size == 0;
  @ ensures partition->blocksize == 0;
  @ ensures partition->part_type_i386 == P_NO_OS;
  @ ensures partition->part_type_sun == PSUN_UNK;
  @ ensures partition->part_type_mac == PMAC_UNK;
  @ ensures partition->part_type_xbox == PXBOX_UNK;
  @ ensures partition->upart_type == UP_UNK;
  @ ensures partition->status == STATUS_DELETED;
  @ ensures partition->order == NO_ORDER;
  @ ensures partition->errcode == BAD_NOERR;
  @ ensures partition->fsname[0] == '\0';
  @ ensures partition->partname[0] == '\0';
  @ ensures partition->info[0] == '\0';
  @ ensures partition->arch == arch;
  @*/
  // assigns partition->part_size;
  // assigns partition->sborg_offset;
  // assigns partition->sb_offset;
  // assigns partition->sb_size;
  // assigns partition->blocksize;
  // assigns partition->part_type_i386;
  // assigns partition->part_type_sun;
  // assigns partition->part_type_mac;
  // assigns partition->part_type_xbox;
  // assigns partition->part_type_gpt;
  // assigns partition->part_uuid;
  // assigns partition->upart_type;
  // assigns partition->status;
  // assigns partition->order;
  // assigns partition->errcode;
  // assigns partition->fsname[0];
  // assigns partition->partname[0];
  // assigns partition->info[0];
void  partition_reset(partition_t *partition, const arch_fnct_t *arch);

/*@
  @ requires \valid_read(arch);
  @*/
// ensures valid_partition(\result);
// ensures \result->arch == arch;
partition_t *partition_new(const arch_fnct_t *arch);

/*@
  @ requires \valid_read(disk_car);
  @ requires valid_disk(disk_car);
  @ requires \valid_read(list_part);
  @ requires valid_list_part(list_part);
  @*/
// assigns \nothing;
unsigned int get_geometry_from_list_part(const disk_t *disk_car, const list_part_t *list_part, const int verbose);

/*@
  @ requires valid_list_disk(list_disk);
  @ requires list_disk==\null || \freeable(list_disk);
  @ requires list_disk==\null || \freeable(list_disk->disk);
  @ requires list_disk==\null || (list_disk->disk->device == \null || \freeable(list_disk->disk->device));
  @ requires list_disk==\null || (list_disk->disk->model == \null || \freeable(list_disk->disk->model));
  @ requires list_disk==\null || (list_disk->disk->serial_no == \null || \freeable(list_disk->disk->serial_no));
  @ requires list_disk==\null || (list_disk->disk->fw_rev == \null || \freeable(list_disk->disk->fw_rev));
  @ requires list_disk==\null || (list_disk->disk->data == \null || \freeable(list_disk->disk->data));
  @ requires list_disk==\null || (list_disk->disk->rbuffer == \null || \freeable(list_disk->disk->rbuffer));
  @ requires list_disk==\null || (list_disk->disk->wbuffer == \null || \freeable(list_disk->disk->wbuffer));
  @ decreases 0;
  @*/
int delete_list_disk(list_disk_t *list_disk);

/*@
  @ requires \valid(buffer + (0..99));
  @ ensures valid_string(buffer);
  @ assigns buffer[0 .. 99];
  @*/
void size_to_unit(const uint64_t disk_size, char *buffer);

/*@
  @ requires \valid_read(list_part);
  @ requires valid_list_part(list_part);
  @ assigns \nothing;
  @*/
int is_part_overlapping(const list_part_t *list_part);

/*@
  @ requires \valid(dest);
  @ requires \valid_read(src);
  @ requires \separated(src, dest);
  @ requires valid_partition(src);
  @ ensures  valid_partition(dest);
  @*/
void dup_partition_t(partition_t *dest, const partition_t *src);

/*@
  @ requires valid_list_disk(list_disk);
  @ assigns \nothing;
  @*/
void log_disk_list(list_disk_t *list_disk);
#ifdef __cplusplus
} /* closing brace for extern "C" */
#endif
#endif