releasing package exfat-utils version 1.3.0-2
[sven/exfat-utils.git] / libexfat / exfat.h
1 /*
2         exfat.h (29.08.09)
3         Definitions of structures and constants used in exFAT file system
4         implementation.
5
6         Free exFAT implementation.
7         Copyright (C) 2010-2018  Andrew Nayenko
8
9         This program is free software; you can redistribute it and/or modify
10         it under the terms of the GNU General Public License as published by
11         the Free Software Foundation, either version 2 of the License, or
12         (at your option) any later version.
13
14         This program is distributed in the hope that it will be useful,
15         but WITHOUT ANY WARRANTY; without even the implied warranty of
16         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17         GNU General Public License for more details.
18
19         You should have received a copy of the GNU General Public License along
20         with this program; if not, write to the Free Software Foundation, Inc.,
21         51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 */
23
24 #ifndef EXFAT_H_INCLUDED
25 #define EXFAT_H_INCLUDED
26
27 #ifndef ANDROID
28 /* Android.bp is used instead of autotools when targeting Android */
29 #include "config.h"
30 #endif
31 #include "compiler.h"
32 #include "exfatfs.h"
33 #include <stdio.h>
34 #include <stdlib.h>
35 #include <time.h>
36 #include <stdbool.h>
37 #include <sys/stat.h>
38 #include <sys/types.h>
39
40 #define EXFAT_NAME_MAX 255
41 /* UTF-16 encodes code points up to U+FFFF as single 16-bit code units.
42    UTF-8 uses up to 3 bytes (i.e. 8-bit code units) to encode code points
43    up to U+FFFF. One additional character is for null terminator. */
44 #define EXFAT_UTF8_NAME_BUFFER_MAX (EXFAT_NAME_MAX * 3 + 1)
45 #define EXFAT_UTF8_ENAME_BUFFER_MAX (EXFAT_ENAME_MAX * 3 + 1)
46
47 #define SECTOR_SIZE(sb) (1 << (sb).sector_bits)
48 #define CLUSTER_SIZE(sb) (SECTOR_SIZE(sb) << (sb).spc_bits)
49 #define CLUSTER_INVALID(sb, c) ((c) < EXFAT_FIRST_DATA_CLUSTER || \
50         (c) - EXFAT_FIRST_DATA_CLUSTER >= le32_to_cpu((sb).cluster_count))
51
52 #define MIN(a, b) ((a) < (b) ? (a) : (b))
53 #define MAX(a, b) ((a) > (b) ? (a) : (b))
54 #define DIV_ROUND_UP(x, d) (((x) + (d) - 1) / (d))
55 #define ROUND_UP(x, d) (DIV_ROUND_UP(x, d) * (d))
56
57 #define BMAP_SIZE(count) (ROUND_UP(count, sizeof(bitmap_t) * 8) / 8)
58 #define BMAP_BLOCK(index) ((index) / sizeof(bitmap_t) / 8)
59 #define BMAP_MASK(index) ((bitmap_t) 1 << ((index) % (sizeof(bitmap_t) * 8)))
60 #define BMAP_GET(bitmap, index) \
61         ((bitmap)[BMAP_BLOCK(index)] & BMAP_MASK(index))
62 #define BMAP_SET(bitmap, index) \
63         ((bitmap)[BMAP_BLOCK(index)] |= BMAP_MASK(index))
64 #define BMAP_CLR(bitmap, index) \
65         ((bitmap)[BMAP_BLOCK(index)] &= ~BMAP_MASK(index))
66
67 #define EXFAT_REPAIR(hook, ef, ...) \
68         (exfat_ask_to_fix(ef) && exfat_fix_ ## hook(ef, __VA_ARGS__))
69
70 /* The size of off_t type must be 64 bits. File systems larger than 2 GB will
71    be corrupted with 32-bit off_t. */
72 STATIC_ASSERT(sizeof(off_t) == 8);
73
74 struct exfat_node
75 {
76         struct exfat_node* parent;
77         struct exfat_node* child;
78         struct exfat_node* next;
79         struct exfat_node* prev;
80
81         int references;
82         uint32_t fptr_index;
83         cluster_t fptr_cluster;
84         off_t entry_offset;
85         cluster_t start_cluster;
86         uint16_t attrib;
87         uint8_t continuations;
88         bool is_contiguous : 1;
89         bool is_cached : 1;
90         bool is_dirty : 1;
91         bool is_unlinked : 1;
92         uint64_t size;
93         time_t mtime, atime;
94         le16_t name[EXFAT_NAME_MAX + 1];
95 };
96
97 enum exfat_mode
98 {
99         EXFAT_MODE_RO,
100         EXFAT_MODE_RW,
101         EXFAT_MODE_ANY,
102 };
103
104 struct exfat_dev;
105
106 struct exfat
107 {
108         struct exfat_dev* dev;
109         struct exfat_super_block* sb;
110         uint16_t* upcase;
111         struct exfat_node* root;
112         struct
113         {
114                 cluster_t start_cluster;
115                 uint32_t size;                          /* in bits */
116                 bitmap_t* chunk;
117                 uint32_t chunk_size;            /* in bits */
118                 bool dirty;
119         }
120         cmap;
121         char label[EXFAT_UTF8_ENAME_BUFFER_MAX];
122         void* zero_cluster;
123         int dmask, fmask;
124         uid_t uid;
125         gid_t gid;
126         int ro;
127         bool noatime;
128         enum { EXFAT_REPAIR_NO, EXFAT_REPAIR_ASK, EXFAT_REPAIR_YES } repair;
129 };
130
131 /* in-core nodes iterator */
132 struct exfat_iterator
133 {
134         struct exfat_node* parent;
135         struct exfat_node* current;
136 };
137
138 struct exfat_human_bytes
139 {
140         uint64_t value;
141         const char* unit;
142 };
143
144 extern int exfat_errors;
145 extern int exfat_errors_fixed;
146
147 void exfat_bug(const char* format, ...) PRINTF NORETURN;
148 void exfat_error(const char* format, ...) PRINTF;
149 void exfat_warn(const char* format, ...) PRINTF;
150 void exfat_debug(const char* format, ...) PRINTF;
151
152 struct exfat_dev* exfat_open(const char* spec, enum exfat_mode mode);
153 int exfat_close(struct exfat_dev* dev);
154 int exfat_fsync(struct exfat_dev* dev);
155 enum exfat_mode exfat_get_mode(const struct exfat_dev* dev);
156 off_t exfat_get_size(const struct exfat_dev* dev);
157 off_t exfat_seek(struct exfat_dev* dev, off_t offset, int whence);
158 ssize_t exfat_read(struct exfat_dev* dev, void* buffer, size_t size);
159 ssize_t exfat_write(struct exfat_dev* dev, const void* buffer, size_t size);
160 ssize_t exfat_pread(struct exfat_dev* dev, void* buffer, size_t size,
161                 off_t offset);
162 ssize_t exfat_pwrite(struct exfat_dev* dev, const void* buffer, size_t size,
163                 off_t offset);
164 ssize_t exfat_generic_pread(const struct exfat* ef, struct exfat_node* node,
165                 void* buffer, size_t size, off_t offset);
166 ssize_t exfat_generic_pwrite(struct exfat* ef, struct exfat_node* node,
167                 const void* buffer, size_t size, off_t offset);
168
169 int exfat_opendir(struct exfat* ef, struct exfat_node* dir,
170                 struct exfat_iterator* it);
171 void exfat_closedir(struct exfat* ef, struct exfat_iterator* it);
172 struct exfat_node* exfat_readdir(struct exfat_iterator* it);
173 int exfat_lookup(struct exfat* ef, struct exfat_node** node,
174                 const char* path);
175 int exfat_split(struct exfat* ef, struct exfat_node** parent,
176                 struct exfat_node** node, le16_t* name, const char* path);
177
178 off_t exfat_c2o(const struct exfat* ef, cluster_t cluster);
179 cluster_t exfat_next_cluster(const struct exfat* ef,
180                 const struct exfat_node* node, cluster_t cluster);
181 cluster_t exfat_advance_cluster(const struct exfat* ef,
182                 struct exfat_node* node, uint32_t count);
183 int exfat_flush_nodes(struct exfat* ef);
184 int exfat_flush(struct exfat* ef);
185 int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size,
186                 bool erase);
187 uint32_t exfat_count_free_clusters(const struct exfat* ef);
188 int exfat_find_used_sectors(const struct exfat* ef, off_t* a, off_t* b);
189
190 void exfat_stat(const struct exfat* ef, const struct exfat_node* node,
191                 struct stat* stbuf);
192 void exfat_get_name(const struct exfat_node* node,
193                 char buffer[EXFAT_UTF8_NAME_BUFFER_MAX]);
194 uint16_t exfat_start_checksum(const struct exfat_entry_meta1* entry);
195 uint16_t exfat_add_checksum(const void* entry, uint16_t sum);
196 le16_t exfat_calc_checksum(const struct exfat_entry* entries, int n);
197 uint32_t exfat_vbr_start_checksum(const void* sector, size_t size);
198 uint32_t exfat_vbr_add_checksum(const void* sector, size_t size, uint32_t sum);
199 le16_t exfat_calc_name_hash(const struct exfat* ef, const le16_t* name,
200                 size_t length);
201 void exfat_humanize_bytes(uint64_t value, struct exfat_human_bytes* hb);
202 void exfat_print_info(const struct exfat_super_block* sb,
203                 uint32_t free_clusters);
204
205 int utf16_to_utf8(char* output, const le16_t* input, size_t outsize,
206                 size_t insize);
207 int utf8_to_utf16(le16_t* output, const char* input, size_t outsize,
208                 size_t insize);
209 size_t utf16_length(const le16_t* str);
210
211 struct exfat_node* exfat_get_node(struct exfat_node* node);
212 void exfat_put_node(struct exfat* ef, struct exfat_node* node);
213 int exfat_cleanup_node(struct exfat* ef, struct exfat_node* node);
214 int exfat_cache_directory(struct exfat* ef, struct exfat_node* dir);
215 void exfat_reset_cache(struct exfat* ef);
216 int exfat_flush_node(struct exfat* ef, struct exfat_node* node);
217 int exfat_unlink(struct exfat* ef, struct exfat_node* node);
218 int exfat_rmdir(struct exfat* ef, struct exfat_node* node);
219 int exfat_mknod(struct exfat* ef, const char* path);
220 int exfat_mkdir(struct exfat* ef, const char* path);
221 int exfat_rename(struct exfat* ef, const char* old_path, const char* new_path);
222 void exfat_utimes(struct exfat_node* node, const struct timespec tv[2]);
223 void exfat_update_atime(struct exfat_node* node);
224 void exfat_update_mtime(struct exfat_node* node);
225 const char* exfat_get_label(struct exfat* ef);
226 int exfat_set_label(struct exfat* ef, const char* label);
227
228 int exfat_mount(struct exfat* ef, const char* spec, const char* options);
229 void exfat_unmount(struct exfat* ef);
230
231 time_t exfat_exfat2unix(le16_t date, le16_t time, uint8_t centisec);
232 void exfat_unix2exfat(time_t unix_time, le16_t* date, le16_t* time,
233                 uint8_t* centisec);
234 void exfat_tzset(void);
235
236 bool exfat_ask_to_fix(const struct exfat* ef);
237 bool exfat_fix_invalid_vbr_checksum(const struct exfat* ef, void* sector,
238                 uint32_t vbr_checksum);
239 bool exfat_fix_invalid_node_checksum(const struct exfat* ef,
240                 struct exfat_node* node);
241 bool exfat_fix_unknown_entry(struct exfat* ef, struct exfat_node* dir,
242                 const struct exfat_entry* entry, off_t offset);
243
244 #endif /* ifndef EXFAT_H_INCLUDED */