3 Definitions of structures and constants used in exFAT file system
6 Free exFAT implementation.
7 Copyright (C) 2010-2015 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
35 #include <sys/types.h>
37 #define EXFAT_NAME_MAX 256
38 #define EXFAT_ATTRIB_CONTIGUOUS 0x10000
39 #define EXFAT_ATTRIB_CACHED 0x20000
40 #define EXFAT_ATTRIB_DIRTY 0x40000
41 #define EXFAT_ATTRIB_UNLINKED 0x80000
42 #define IS_CONTIGUOUS(node) (((node).flags & EXFAT_ATTRIB_CONTIGUOUS) != 0)
43 #define SECTOR_SIZE(sb) (1 << (sb).sector_bits)
44 #define CLUSTER_SIZE(sb) (SECTOR_SIZE(sb) << (sb).spc_bits)
45 #define CLUSTER_INVALID(c) \
46 ((c) < EXFAT_FIRST_DATA_CLUSTER || (c) > EXFAT_LAST_DATA_CLUSTER)
48 #define MIN(a, b) ((a) < (b) ? (a) : (b))
49 #define MAX(a, b) ((a) > (b) ? (a) : (b))
50 #define DIV_ROUND_UP(x, d) (((x) + (d) - 1) / (d))
51 #define ROUND_UP(x, d) (DIV_ROUND_UP(x, d) * (d))
52 #define UTF8_BYTES(c) ((c) * 6) /* UTF-8 character can occupy up to 6 bytes */
54 #define BMAP_SIZE(count) (ROUND_UP(count, sizeof(bitmap_t) * 8) / 8)
55 #define BMAP_BLOCK(index) ((index) / sizeof(bitmap_t) / 8)
56 #define BMAP_MASK(index) ((bitmap_t) 1 << ((index) % (sizeof(bitmap_t) * 8)))
57 #define BMAP_GET(bitmap, index) \
58 ((bitmap)[BMAP_BLOCK(index)] & BMAP_MASK(index))
59 #define BMAP_SET(bitmap, index) \
60 ((bitmap)[BMAP_BLOCK(index)] |= BMAP_MASK(index))
61 #define BMAP_CLR(bitmap, index) \
62 ((bitmap)[BMAP_BLOCK(index)] &= ~BMAP_MASK(index))
64 /* The size of off_t type must be 64 bits. File systems larger than 2 GB will
65 be corrupted with 32-bit off_t. */
66 STATIC_ASSERT(sizeof(off_t) == 8);
70 struct exfat_node* parent;
71 struct exfat_node* child;
72 struct exfat_node* next;
73 struct exfat_node* prev;
77 cluster_t fptr_cluster;
78 cluster_t entry_cluster;
80 cluster_t start_cluster;
84 le16_t name[EXFAT_NAME_MAX + 1];
98 struct exfat_dev* dev;
99 struct exfat_super_block* sb;
102 struct exfat_node* root;
105 cluster_t start_cluster;
106 uint32_t size; /* in bits */
108 uint32_t chunk_size; /* in bits */
112 char label[UTF8_BYTES(EXFAT_ENAME_MAX) + 1];
121 /* in-core nodes iterator */
122 struct exfat_iterator
124 struct exfat_node* parent;
125 struct exfat_node* current;
128 struct exfat_human_bytes
134 extern int exfat_errors;
136 void exfat_bug(const char* format, ...) PRINTF NORETURN;
137 void exfat_error(const char* format, ...) PRINTF;
138 void exfat_warn(const char* format, ...) PRINTF;
139 void exfat_debug(const char* format, ...) PRINTF;
141 struct exfat_dev* exfat_open(const char* spec, enum exfat_mode mode);
142 int exfat_close(struct exfat_dev* dev);
143 int exfat_fsync(struct exfat_dev* dev);
144 enum exfat_mode exfat_get_mode(const struct exfat_dev* dev);
145 off_t exfat_get_size(const struct exfat_dev* dev);
146 off_t exfat_seek(struct exfat_dev* dev, off_t offset, int whence);
147 ssize_t exfat_read(struct exfat_dev* dev, void* buffer, size_t size);
148 ssize_t exfat_write(struct exfat_dev* dev, const void* buffer, size_t size);
149 ssize_t exfat_pread(struct exfat_dev* dev, void* buffer, size_t size,
151 ssize_t exfat_pwrite(struct exfat_dev* dev, const void* buffer, size_t size,
153 ssize_t exfat_generic_pread(const struct exfat* ef, struct exfat_node* node,
154 void* buffer, size_t size, off_t offset);
155 ssize_t exfat_generic_pwrite(struct exfat* ef, struct exfat_node* node,
156 const void* buffer, size_t size, off_t offset);
158 int exfat_opendir(struct exfat* ef, struct exfat_node* dir,
159 struct exfat_iterator* it);
160 void exfat_closedir(struct exfat* ef, struct exfat_iterator* it);
161 struct exfat_node* exfat_readdir(struct exfat* ef, struct exfat_iterator* it);
162 int exfat_lookup(struct exfat* ef, struct exfat_node** node,
164 int exfat_split(struct exfat* ef, struct exfat_node** parent,
165 struct exfat_node** node, le16_t* name, const char* path);
167 off_t exfat_c2o(const struct exfat* ef, cluster_t cluster);
168 cluster_t exfat_next_cluster(const struct exfat* ef,
169 const struct exfat_node* node, cluster_t cluster);
170 cluster_t exfat_advance_cluster(const struct exfat* ef,
171 struct exfat_node* node, uint32_t count);
172 int exfat_flush_nodes(struct exfat* ef);
173 int exfat_flush(struct exfat* ef);
174 int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size,
176 uint32_t exfat_count_free_clusters(const struct exfat* ef);
177 int exfat_find_used_sectors(const struct exfat* ef, off_t* a, off_t* b);
179 void exfat_stat(const struct exfat* ef, const struct exfat_node* node,
181 void exfat_get_name(const struct exfat_node* node, char* buffer, size_t n);
182 uint16_t exfat_start_checksum(const struct exfat_entry_meta1* entry);
183 uint16_t exfat_add_checksum(const void* entry, uint16_t sum);
184 le16_t exfat_calc_checksum(const struct exfat_entry_meta1* meta1,
185 const struct exfat_entry_meta2* meta2, const le16_t* name);
186 uint32_t exfat_vbr_start_checksum(const void* sector, size_t size);
187 uint32_t exfat_vbr_add_checksum(const void* sector, size_t size, uint32_t sum);
188 le16_t exfat_calc_name_hash(const struct exfat* ef, const le16_t* name);
189 void exfat_humanize_bytes(uint64_t value, struct exfat_human_bytes* hb);
190 void exfat_print_info(const struct exfat_super_block* sb,
191 uint32_t free_clusters);
193 int utf16_to_utf8(char* output, const le16_t* input, size_t outsize,
195 int utf8_to_utf16(le16_t* output, const char* input, size_t outsize,
197 size_t utf16_length(const le16_t* str);
199 struct exfat_node* exfat_get_node(struct exfat_node* node);
200 void exfat_put_node(struct exfat* ef, struct exfat_node* node);
201 int exfat_cleanup_node(struct exfat* ef, struct exfat_node* node);
202 int exfat_cache_directory(struct exfat* ef, struct exfat_node* dir);
203 void exfat_reset_cache(struct exfat* ef);
204 int exfat_flush_node(struct exfat* ef, struct exfat_node* node);
205 int exfat_unlink(struct exfat* ef, struct exfat_node* node);
206 int exfat_rmdir(struct exfat* ef, struct exfat_node* node);
207 int exfat_mknod(struct exfat* ef, const char* path);
208 int exfat_mkdir(struct exfat* ef, const char* path);
209 int exfat_rename(struct exfat* ef, const char* old_path, const char* new_path);
210 void exfat_utimes(struct exfat_node* node, const struct timespec tv[2]);
211 void exfat_update_atime(struct exfat_node* node);
212 void exfat_update_mtime(struct exfat_node* node);
213 const char* exfat_get_label(struct exfat* ef);
214 int exfat_set_label(struct exfat* ef, const char* label);
216 int exfat_mount(struct exfat* ef, const char* spec, const char* options);
217 void exfat_unmount(struct exfat* ef);
219 time_t exfat_exfat2unix(le16_t date, le16_t time, uint8_t centisec);
220 void exfat_unix2exfat(time_t unix_time, le16_t* date, le16_t* time,
222 void exfat_tzset(void);
224 #endif /* ifndef EXFAT_H_INCLUDED */