3 Definitions of structures and constants used in exFAT file system
6 Free exFAT implementation.
7 Copyright (C) 2010-2016 Andrew Nayenko
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.
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.
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.
24 #ifndef EXFAT_H_INCLUDED
25 #define EXFAT_H_INCLUDED
27 #if defined(__ANDROID__)
28 #include "android_config.h"
39 #include <sys/types.h>
41 #define EXFAT_NAME_MAX 256
42 #define EXFAT_ATTRIB_CONTIGUOUS 0x10000
43 #define EXFAT_ATTRIB_CACHED 0x20000
44 #define EXFAT_ATTRIB_DIRTY 0x40000
45 #define EXFAT_ATTRIB_UNLINKED 0x80000
46 #define IS_CONTIGUOUS(node) (((node).flags & EXFAT_ATTRIB_CONTIGUOUS) != 0)
47 #define SECTOR_SIZE(sb) (1 << (sb).sector_bits)
48 #define CLUSTER_SIZE(sb) (SECTOR_SIZE(sb) << (sb).spc_bits)
49 #define CLUSTER_INVALID(c) \
50 ((c) < EXFAT_FIRST_DATA_CLUSTER || (c) > EXFAT_LAST_DATA_CLUSTER)
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 #define UTF8_BYTES(c) ((c) * 6) /* UTF-8 character can occupy up to 6 bytes */
58 #define BMAP_SIZE(count) (ROUND_UP(count, sizeof(bitmap_t) * 8) / 8)
59 #define BMAP_BLOCK(index) ((index) / sizeof(bitmap_t) / 8)
60 #define BMAP_MASK(index) ((bitmap_t) 1 << ((index) % (sizeof(bitmap_t) * 8)))
61 #define BMAP_GET(bitmap, index) \
62 ((bitmap)[BMAP_BLOCK(index)] & BMAP_MASK(index))
63 #define BMAP_SET(bitmap, index) \
64 ((bitmap)[BMAP_BLOCK(index)] |= BMAP_MASK(index))
65 #define BMAP_CLR(bitmap, index) \
66 ((bitmap)[BMAP_BLOCK(index)] &= ~BMAP_MASK(index))
68 /* The size of off_t type must be 64 bits. File systems larger than 2 GB will
69 be corrupted with 32-bit off_t. */
70 STATIC_ASSERT(sizeof(off_t) == 8);
74 struct exfat_node* parent;
75 struct exfat_node* child;
76 struct exfat_node* next;
77 struct exfat_node* prev;
81 cluster_t fptr_cluster;
82 cluster_t entry_cluster;
84 cluster_t start_cluster;
88 le16_t name[EXFAT_NAME_MAX + 1];
102 struct exfat_dev* dev;
103 struct exfat_super_block* sb;
105 struct exfat_node* root;
108 cluster_t start_cluster;
109 uint32_t size; /* in bits */
111 uint32_t chunk_size; /* in bits */
115 char label[UTF8_BYTES(EXFAT_ENAME_MAX) + 1];
124 /* in-core nodes iterator */
125 struct exfat_iterator
127 struct exfat_node* parent;
128 struct exfat_node* current;
131 struct exfat_human_bytes
137 extern int exfat_errors;
139 void exfat_bug(const char* format, ...) PRINTF NORETURN;
140 void exfat_error(const char* format, ...) PRINTF;
141 void exfat_warn(const char* format, ...) PRINTF;
142 void exfat_debug(const char* format, ...) PRINTF;
144 struct exfat_dev* exfat_open(const char* spec, enum exfat_mode mode);
145 int exfat_close(struct exfat_dev* dev);
146 int exfat_fsync(struct exfat_dev* dev);
147 enum exfat_mode exfat_get_mode(const struct exfat_dev* dev);
148 off_t exfat_get_size(const struct exfat_dev* dev);
149 off_t exfat_seek(struct exfat_dev* dev, off_t offset, int whence);
150 ssize_t exfat_read(struct exfat_dev* dev, void* buffer, size_t size);
151 ssize_t exfat_write(struct exfat_dev* dev, const void* buffer, size_t size);
152 ssize_t exfat_pread(struct exfat_dev* dev, void* buffer, size_t size,
154 ssize_t exfat_pwrite(struct exfat_dev* dev, const void* buffer, size_t size,
156 ssize_t exfat_generic_pread(const struct exfat* ef, struct exfat_node* node,
157 void* buffer, size_t size, off_t offset);
158 ssize_t exfat_generic_pwrite(struct exfat* ef, struct exfat_node* node,
159 const void* buffer, size_t size, off_t offset);
161 int exfat_opendir(struct exfat* ef, struct exfat_node* dir,
162 struct exfat_iterator* it);
163 void exfat_closedir(struct exfat* ef, struct exfat_iterator* it);
164 struct exfat_node* exfat_readdir(struct exfat* ef, struct exfat_iterator* it);
165 int exfat_lookup(struct exfat* ef, struct exfat_node** node,
167 int exfat_split(struct exfat* ef, struct exfat_node** parent,
168 struct exfat_node** node, le16_t* name, const char* path);
170 off_t exfat_c2o(const struct exfat* ef, cluster_t cluster);
171 cluster_t exfat_next_cluster(const struct exfat* ef,
172 const struct exfat_node* node, cluster_t cluster);
173 cluster_t exfat_advance_cluster(const struct exfat* ef,
174 struct exfat_node* node, uint32_t count);
175 int exfat_flush_nodes(struct exfat* ef);
176 int exfat_flush(struct exfat* ef);
177 int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size,
179 uint32_t exfat_count_free_clusters(const struct exfat* ef);
180 int exfat_find_used_sectors(const struct exfat* ef, off_t* a, off_t* b);
182 void exfat_stat(const struct exfat* ef, const struct exfat_node* node,
184 void exfat_get_name(const struct exfat_node* node, char* buffer, size_t n);
185 uint16_t exfat_start_checksum(const struct exfat_entry_meta1* entry);
186 uint16_t exfat_add_checksum(const void* entry, uint16_t sum);
187 le16_t exfat_calc_checksum(const struct exfat_entry_meta1* meta1,
188 const struct exfat_entry_meta2* meta2, const le16_t* name);
189 uint32_t exfat_vbr_start_checksum(const void* sector, size_t size);
190 uint32_t exfat_vbr_add_checksum(const void* sector, size_t size, uint32_t sum);
191 le16_t exfat_calc_name_hash(const struct exfat* ef, const le16_t* name);
192 void exfat_humanize_bytes(uint64_t value, struct exfat_human_bytes* hb);
193 void exfat_print_info(const struct exfat_super_block* sb,
194 uint32_t free_clusters);
196 struct exfat_node* exfat_get_node(struct exfat_node* node);
197 void exfat_put_node(struct exfat* ef, struct exfat_node* node);
198 int exfat_cleanup_node(struct exfat* ef, struct exfat_node* node);
199 int exfat_cache_directory(struct exfat* ef, struct exfat_node* dir);
200 void exfat_reset_cache(struct exfat* ef);
201 int exfat_flush_node(struct exfat* ef, struct exfat_node* node);
202 int exfat_unlink(struct exfat* ef, struct exfat_node* node);
203 int exfat_rmdir(struct exfat* ef, struct exfat_node* node);
204 int exfat_mknod(struct exfat* ef, const char* path);
205 int exfat_mkdir(struct exfat* ef, const char* path);
206 int exfat_rename(struct exfat* ef, const char* old_path, const char* new_path);
207 void exfat_utimes(struct exfat_node* node, const struct timespec tv[2]);
208 void exfat_update_atime(struct exfat_node* node);
209 void exfat_update_mtime(struct exfat_node* node);
210 const char* exfat_get_label(struct exfat* ef);
211 int exfat_set_label(struct exfat* ef, const char* label);
213 int exfat_mount(struct exfat* ef, const char* spec, const char* options);
214 void exfat_unmount(struct exfat* ef);
216 time_t exfat_exfat2unix(le16_t date, le16_t time, uint8_t centisec);
217 void exfat_unix2exfat(time_t unix_time, le16_t* date, le16_t* time,
219 void exfat_tzset(void);
221 #endif /* ifndef EXFAT_H_INCLUDED */