[VFATLIB] Make Chkdsk handle volume opening locking failures.
[reactos.git] / sdk / lib / fslib / vfatlib / check / fsck.fat.h
1 /* fsck.fat.h - Common data structures and global variables
2
3 Copyright (C) 1993 Werner Almesberger <werner.almesberger@lrc.di.epfl.ch>
4 Copyright (C) 1998 Roman Hodek <Roman.Hodek@informatik.uni-erlangen.de>
5 Copyright (C) 2008-2014 Daniel Baumann <mail@daniel-baumann.ch>
6 Copyright (C) 2015 Andreas Bombe <aeb@debian.org>
7
8 This program is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
12
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
17
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
20
21 The complete text of the GNU General Public License
22 can be found in /usr/share/common-licenses/GPL-3 file.
23 */
24
25 /* FAT32, VFAT, Atari format support, and various fixes additions May 1998
26 * by Roman Hodek <Roman.Hodek@informatik.uni-erlangen.de> */
27
28 #ifndef _DOSFSCK_H
29 #define _DOSFSCK_H
30
31 //#include "types.h"
32
33 #include <stdint.h>
34
35 #ifdef _WIN32
36
37 typedef unsigned int __u32;
38 typedef unsigned __int64 __u64;
39
40 #define le16toh(v) (v)
41 #define le32toh(v) (v)
42 #define htole16(v) (v)
43 #define htole32(v) (v)
44
45 #endif
46
47 #ifdef _M_IX86
48 #include "byteorder.h"
49 #endif
50
51 #if 0
52 #undef le16toh
53 #undef le32toh
54 #undef htole16
55 #undef htole32
56 #endif
57
58 #if __BYTE_ORDER == __BIG_ENDIAN
59 #include "byteswap.h"
60
61 #if 0
62 #define le16toh(v) bswap_16(v)
63 #define le32toh(v) bswap_32(v)
64 #define htole16(v) le16toh(v)
65 #define htole32(v) le32toh(v)
66 #endif
67 #if 0
68 #define le16toh(v) le16_to_cpu(v)
69 #define le32toh(v) le32_to_cpu(v)
70 #define htole16(v) cpu_to_le16(v)
71 #define htole32(v) cpu_to_le32(v)
72 #endif
73
74 #else
75 #define le16toh(v) (v)
76 #define le32toh(v) (v)
77 #define htole16(v) (v)
78 #define htole32(v) (v)
79 #endif /* __BIG_ENDIAN */
80
81 // #include "endian_compat.h"
82
83 #ifndef offsetof
84 #define offsetof(t,e) ((int)&(((t *)0)->e))
85 #endif
86
87
88 // extern int interactive, rw, list, verbose, test, write_immed;
89 // extern int atari_format;
90 // extern unsigned n_files;
91 // extern void *mem_queue;
92
93 #include "rosglue.h"
94
95 #include "msdos_fs.h"
96
97 #define VFAT_LN_ATTR (ATTR_RO | ATTR_HIDDEN | ATTR_SYS | ATTR_VOLUME)
98
99 #define FAT_STATE_DIRTY 0x01
100
101 #include <pshpack1.h>
102
103 /* ++roman: Use own definition of boot sector structure -- the kernel headers'
104 * name for it is msdos_boot_sector in 2.0 and fat_boot_sector in 2.1 ... */
105 struct boot_sector {
106 uint8_t ignored[3]; /* Boot strap short or near jump */
107 uint8_t system_id[8]; /* Name - can be used to special case
108 partition manager volumes */
109 uint8_t sector_size[2]; /* bytes per logical sector */
110 uint8_t cluster_size; /* sectors/cluster */
111 uint16_t reserved; /* reserved sectors */
112 uint8_t fats; /* number of FATs */
113 uint8_t dir_entries[2]; /* root directory entries */
114 uint8_t sectors[2]; /* number of sectors */
115 uint8_t media; /* media code (unused) */
116 uint16_t fat_length; /* sectors/FAT */
117 uint16_t secs_track; /* sectors per track */
118 uint16_t heads; /* number of heads */
119 uint32_t hidden; /* hidden sectors (unused) */
120 uint32_t total_sect; /* number of sectors (if sectors == 0) */
121
122 /* The following fields are only used by FAT32 */
123 uint32_t fat32_length; /* sectors/FAT */
124 uint16_t flags; /* bit 8: fat mirroring, low 4: active fat */
125 uint8_t version[2]; /* major, minor filesystem version */
126 uint32_t root_cluster; /* first cluster in root directory */
127 uint16_t info_sector; /* filesystem info sector */
128 uint16_t backup_boot; /* backup boot sector */
129 uint8_t reserved2[12]; /* Unused */
130
131 uint8_t drive_number; /* Logical Drive Number */
132 uint8_t reserved3; /* Unused */
133
134 uint8_t extended_sig; /* Extended Signature (0x29) */
135 uint32_t serial; /* Serial number */
136 uint8_t label[11]; /* FS label */
137 uint8_t fs_type[8]; /* FS Type */
138
139 /* fill up to 512 bytes */
140 uint8_t junk[422];
141 } __attribute__ ((packed));
142
143 struct boot_sector_16 {
144 uint8_t ignored[3]; /* Boot strap short or near jump */
145 uint8_t system_id[8]; /* Name - can be used to special case
146 partition manager volumes */
147 uint8_t sector_size[2]; /* bytes per logical sector */
148 uint8_t cluster_size; /* sectors/cluster */
149 uint16_t reserved; /* reserved sectors */
150 uint8_t fats; /* number of FATs */
151 uint8_t dir_entries[2]; /* root directory entries */
152 uint8_t sectors[2]; /* number of sectors */
153 uint8_t media; /* media code (unused) */
154 uint16_t fat_length; /* sectors/FAT */
155 uint16_t secs_track; /* sectors per track */
156 uint16_t heads; /* number of heads */
157 uint32_t hidden; /* hidden sectors (unused) */
158 uint32_t total_sect; /* number of sectors (if sectors == 0) */
159
160 uint8_t drive_number; /* Logical Drive Number */
161 uint8_t reserved2; /* Unused */
162
163 uint8_t extended_sig; /* Extended Signature (0x29) */
164 uint32_t serial; /* Serial number */
165 uint8_t label[11]; /* FS label */
166 uint8_t fs_type[8]; /* FS Type */
167
168 /* fill up to 512 bytes */
169 uint8_t junk[450];
170 } __attribute__ ((packed));
171
172 struct info_sector {
173 uint32_t magic; /* Magic for info sector ('RRaA') */
174 uint8_t junk[0x1dc];
175 uint32_t reserved1; /* Nothing as far as I can tell */
176 uint32_t signature; /* 0x61417272 ('rrAa') */
177 uint32_t free_clusters; /* Free cluster count. -1 if unknown */
178 uint32_t next_cluster; /* Most recently allocated cluster. */
179 uint32_t reserved2[3];
180 uint16_t reserved3;
181 uint16_t boot_sign;
182 };
183
184 typedef struct {
185 uint8_t name[MSDOS_NAME]; /* name including extension */
186 uint8_t attr; /* attribute bits */
187 uint8_t lcase; /* Case for base and extension */
188 uint8_t ctime_ms; /* Creation time, milliseconds */
189 uint16_t ctime; /* Creation time */
190 uint16_t cdate; /* Creation date */
191 uint16_t adate; /* Last access date */
192 uint16_t starthi; /* High 16 bits of cluster in FAT32 */
193 uint16_t time, date, start; /* time, date and first cluster */
194 uint32_t size; /* file size (in bytes) */
195 } __attribute__ ((packed)) DIR_ENT;
196
197 #include <poppack.h>
198
199 typedef struct _dos_file {
200 DIR_ENT dir_ent;
201 char *lfn;
202 off_t offset;
203 off_t lfn_offset;
204 struct _dos_file *parent; /* parent directory */
205 struct _dos_file *next; /* next entry */
206 struct _dos_file *first; /* first entry (directory only) */
207 } DOS_FILE;
208
209 typedef struct {
210 uint32_t value;
211 uint32_t reserved;
212 } FAT_ENTRY;
213
214 typedef struct {
215 int nfats;
216 off_t fat_start;
217 unsigned int fat_size; /* unit is bytes */
218 unsigned int fat_bits; /* size of a FAT entry */
219 unsigned int eff_fat_bits; /* # of used bits in a FAT entry */
220 uint32_t root_cluster; /* 0 for old-style root dir */
221 off_t root_start;
222 unsigned int root_entries;
223 off_t data_start;
224 unsigned int cluster_size;
225 uint32_t data_clusters; /* not including two reserved cluster numbers */
226 off_t fsinfo_start; /* 0 if not present */
227 long free_clusters;
228 off_t backupboot_start; /* 0 if not present */
229 unsigned char *fat;
230 DOS_FILE **cluster_owner;
231 char *label;
232 } DOS_FS;
233
234
235 /* value to use as end-of-file marker */
236 #define FAT_EOF(fs) ((atari_format ? 0xfff : 0xff8) | FAT_EXTD(fs))
237 #define FAT_IS_EOF(fs,v) ((uint32_t)(v) >= (0xff8|FAT_EXTD(fs)))
238 /* value to mark bad clusters */
239 #define FAT_BAD(fs) (0xff7 | FAT_EXTD(fs))
240 /* range of values used for bad clusters */
241 #define FAT_MIN_BAD(fs) ((atari_format ? 0xff0 : 0xff7) | FAT_EXTD(fs))
242 #define FAT_MAX_BAD(fs) ((atari_format ? 0xff7 : 0xff7) | FAT_EXTD(fs))
243 #define FAT_IS_BAD(fs,v) ((v) >= FAT_MIN_BAD(fs) && (v) <= FAT_MAX_BAD(fs))
244
245 /* return -16 as a number with fs->fat_bits bits */
246 #define FAT_EXTD(fs) (((1 << fs->eff_fat_bits)-1) & ~0xf)
247
248 /* marker for files with no 8.3 name */
249 #define FAT_NO_83NAME 32
250
251 #endif