3 Definitions of structures and constants used in exFAT file system
6 Copyright (C) 2010-2012 Andrew Nayenko
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.
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.
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/>.
22 #ifndef EXFAT_H_INCLUDED
23 #define EXFAT_H_INCLUDED
30 #include <sys/types.h>
34 #define EXFAT_NAME_MAX 256
35 #define EXFAT_ATTRIB_CONTIGUOUS 0x10000
36 #define EXFAT_ATTRIB_CACHED 0x20000
37 #define EXFAT_ATTRIB_DIRTY 0x40000
38 #define EXFAT_ATTRIB_UNLINKED 0x80000
39 #define IS_CONTIGUOUS(node) (((node).flags & EXFAT_ATTRIB_CONTIGUOUS) != 0)
40 #define SECTOR_SIZE(sb) (1 << (sb).sector_bits)
41 #define CLUSTER_SIZE(sb) (SECTOR_SIZE(sb) << (sb).spc_bits)
42 #define CLUSTER_INVALID(c) \
43 ((c) < EXFAT_FIRST_DATA_CLUSTER || (c) > EXFAT_LAST_DATA_CLUSTER)
45 #define MIN(a, b) ((a) < (b) ? (a) : (b))
46 #define MAX(a, b) ((a) > (b) ? (a) : (b))
47 #define DIV_ROUND_UP(x, d) (((x) + (d) - 1) / (d))
48 #define ROUND_UP(x, d) (DIV_ROUND_UP(x, d) * (d))
50 #define BMAP_GET(bitmap, index) \
51 (((uint8_t*) bitmap)[(index) / 8] & (1u << ((index) % 8)))
52 #define BMAP_SET(bitmap, index) \
53 ((uint8_t*) bitmap)[(index) / 8] |= (1u << ((index) % 8))
54 #define BMAP_CLR(bitmap, index) \
55 ((uint8_t*) bitmap)[(index) / 8] &= ~(1u << ((index) % 8))
59 struct exfat_node* parent;
60 struct exfat_node* child;
61 struct exfat_node* next;
62 struct exfat_node* prev;
66 cluster_t fptr_cluster;
67 cluster_t entry_cluster;
69 cluster_t start_cluster;
73 le16_t name[EXFAT_NAME_MAX + 1];
87 struct exfat_dev* dev;
88 struct exfat_super_block* sb;
91 struct exfat_node* root;
94 cluster_t start_cluster;
95 uint32_t size; /* in bits */
97 uint32_t chunk_size; /* in bits */
101 char label[EXFAT_ENAME_MAX * 6 + 1]; /* a character can occupy up to
111 /* in-core nodes iterator */
112 struct exfat_iterator
114 struct exfat_node* parent;
115 struct exfat_node* current;
118 struct exfat_human_bytes
124 extern int exfat_errors;
126 void exfat_bug(const char* format, ...)
127 __attribute__((format(printf, 1, 2), noreturn));
128 void exfat_error(const char* format, ...)
129 __attribute__((format(printf, 1, 2)));
130 void exfat_warn(const char* format, ...)
131 __attribute__((format(printf, 1, 2)));
132 void exfat_debug(const char* format, ...)
133 __attribute__((format(printf, 1, 2)));
135 struct exfat_dev* exfat_open(const char* spec, enum exfat_mode mode);
136 int exfat_close(struct exfat_dev* dev);
137 int exfat_fsync(struct exfat_dev* dev);
138 enum exfat_mode exfat_mode(const struct exfat_dev* dev);
139 off_t exfat_seek(struct exfat_dev* dev, off_t offset, int whence);
140 ssize_t exfat_read(struct exfat_dev* dev, void* buffer, size_t size);
141 ssize_t exfat_write(struct exfat_dev* dev, const void* buffer, size_t size);
142 void exfat_pread(struct exfat_dev* dev, void* buffer, size_t size,
144 void exfat_pwrite(struct exfat_dev* dev, const void* buffer, size_t size,
146 ssize_t exfat_generic_pread(const struct exfat* ef, struct exfat_node* node,
147 void* buffer, size_t size, off_t offset);
148 ssize_t exfat_generic_pwrite(struct exfat* ef, struct exfat_node* node,
149 const void* buffer, size_t size, off_t offset);
151 int exfat_opendir(struct exfat* ef, struct exfat_node* dir,
152 struct exfat_iterator* it);
153 void exfat_closedir(struct exfat* ef, struct exfat_iterator* it);
154 struct exfat_node* exfat_readdir(struct exfat* ef, struct exfat_iterator* it);
155 int exfat_lookup(struct exfat* ef, struct exfat_node** node,
157 int exfat_split(struct exfat* ef, struct exfat_node** parent,
158 struct exfat_node** node, le16_t* name, const char* path);
160 off_t exfat_c2o(const struct exfat* ef, cluster_t cluster);
161 cluster_t exfat_next_cluster(const struct exfat* ef,
162 const struct exfat_node* node, cluster_t cluster);
163 cluster_t exfat_advance_cluster(const struct exfat* ef,
164 struct exfat_node* node, uint32_t count);
165 void exfat_flush_cmap(struct exfat* ef);
166 int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size);
167 uint32_t exfat_count_free_clusters(const struct exfat* ef);
168 int exfat_find_used_sectors(const struct exfat* ef, off_t* a, off_t* b);
170 void exfat_stat(const struct exfat* ef, const struct exfat_node* node,
172 void exfat_get_name(const struct exfat_node* node, char* buffer, size_t n);
173 uint16_t exfat_start_checksum(const struct exfat_entry_meta1* entry);
174 uint16_t exfat_add_checksum(const void* entry, uint16_t sum);
175 le16_t exfat_calc_checksum(const struct exfat_entry_meta1* meta1,
176 const struct exfat_entry_meta2* meta2, const le16_t* name);
177 uint32_t exfat_vbr_start_checksum(const void* sector, size_t size);
178 uint32_t exfat_vbr_add_checksum(const void* sector, size_t size, uint32_t sum);
179 le16_t exfat_calc_name_hash(const struct exfat* ef, const le16_t* name);
180 void exfat_humanize_bytes(uint64_t value, struct exfat_human_bytes* hb);
181 void exfat_print_info(const struct exfat_super_block* sb,
182 uint32_t free_clusters);
184 int utf16_to_utf8(char* output, const le16_t* input, size_t outsize,
186 int utf8_to_utf16(le16_t* output, const char* input, size_t outsize,
188 size_t utf16_length(const le16_t* str);
190 struct exfat_node* exfat_get_node(struct exfat_node* node);
191 void exfat_put_node(struct exfat* ef, struct exfat_node* node);
192 int exfat_cache_directory(struct exfat* ef, struct exfat_node* dir);
193 void exfat_reset_cache(struct exfat* ef);
194 void exfat_flush_node(struct exfat* ef, struct exfat_node* node);
195 int exfat_unlink(struct exfat* ef, struct exfat_node* node);
196 int exfat_rmdir(struct exfat* ef, struct exfat_node* node);
197 int exfat_mknod(struct exfat* ef, const char* path);
198 int exfat_mkdir(struct exfat* ef, const char* path);
199 int exfat_rename(struct exfat* ef, const char* old_path, const char* new_path);
200 void exfat_utimes(struct exfat_node* node, const struct timespec tv[2]);
201 void exfat_update_atime(struct exfat_node* node);
202 void exfat_update_mtime(struct exfat_node* node);
203 const char* exfat_get_label(struct exfat* ef);
204 int exfat_set_label(struct exfat* ef, const char* label);
206 int exfat_mount(struct exfat* ef, const char* spec, const char* options);
207 void exfat_unmount(struct exfat* ef);
209 time_t exfat_exfat2unix(le16_t date, le16_t time, uint8_t centisec);
210 void exfat_unix2exfat(time_t unix_time, le16_t* date, le16_t* time,
212 void exfat_tzset(void);
214 #endif /* ifndef EXFAT_H_INCLUDED */