3 Definitions of structures and constants used in exFAT file system
6 Copyright (C) 2009, 2010 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
29 #include <sys/types.h>
33 #define EXFAT_NAME_MAX 256
34 #define EXFAT_ATTRIB_CONTIGUOUS 0x10000
35 #define EXFAT_ATTRIB_CACHED 0x20000
36 #define EXFAT_ATTRIB_DIRTY 0x40000
37 #define EXFAT_ATTRIB_UNLINKED 0x80000
38 #define IS_CONTIGUOUS(node) (((node).flags & EXFAT_ATTRIB_CONTIGUOUS) != 0)
39 #define SECTOR_SIZE(sb) (1 << (sb).sector_bits)
40 #define CLUSTER_SIZE(sb) (SECTOR_SIZE(sb) << (sb).spc_bits)
41 #define CLUSTER_INVALID(c) ((c) == EXFAT_CLUSTER_BAD || (c) == EXFAT_CLUSTER_END)
43 #define MIN(a, b) ((a) < (b) ? (a) : (b))
44 #define DIV_ROUND_UP(x, d) (((x) + (d) - 1) / (d))
46 #define BMAP_GET(bitmap, index) \
47 (((uint8_t*) bitmap)[(index) / 8] & (1u << ((index) % 8)))
48 #define BMAP_SET(bitmap, index) \
49 ((uint8_t*) bitmap)[(index) / 8] |= (1u << ((index) % 8))
50 #define BMAP_CLR(bitmap, index) \
51 ((uint8_t*) bitmap)[(index) / 8] &= ~(1u << ((index) % 8))
55 struct exfat_node* parent;
56 struct exfat_node* child;
57 struct exfat_node* next;
58 struct exfat_node* prev;
62 cluster_t fptr_cluster;
63 cluster_t entry_cluster;
65 cluster_t start_cluster;
69 le16_t name[EXFAT_NAME_MAX + 1];
76 struct exfat_dev* dev;
77 struct exfat_super_block* sb;
80 struct exfat_node* root;
83 cluster_t start_cluster;
84 uint32_t size; /* in bits */
86 uint32_t chunk_size; /* in bits */
90 char label[EXFAT_ENAME_MAX * 6 + 1]; /* a character can occupy up to
101 /* in-core nodes iterator */
102 struct exfat_iterator
104 struct exfat_node* parent;
105 struct exfat_node* current;
108 struct exfat_human_bytes
114 extern int exfat_errors;
116 void exfat_bug(const char* format, ...)
117 __attribute__((format(printf, 1, 2), noreturn));
118 void exfat_error(const char* format, ...)
119 __attribute__((format(printf, 1, 2)));
120 void exfat_warn(const char* format, ...)
121 __attribute__((format(printf, 1, 2)));
122 void exfat_debug(const char* format, ...)
123 __attribute__((format(printf, 1, 2)));
125 struct exfat_dev* exfat_open(const char* spec, int ro);
126 int exfat_close(struct exfat_dev* dev);
127 int exfat_fsync(struct exfat_dev* dev);
128 off_t exfat_seek(struct exfat_dev* dev, off_t offset, int whence);
129 ssize_t exfat_read(struct exfat_dev* dev, void* buffer, size_t size);
130 ssize_t exfat_write(struct exfat_dev* dev, const void* buffer, size_t size);
131 void exfat_pread(struct exfat_dev* dev, void* buffer, size_t size,
133 void exfat_pwrite(struct exfat_dev* dev, const void* buffer, size_t size,
135 ssize_t exfat_generic_pread(const struct exfat* ef, struct exfat_node* node,
136 void* buffer, size_t size, off_t offset);
137 ssize_t exfat_generic_pwrite(struct exfat* ef, struct exfat_node* node,
138 const void* buffer, size_t size, off_t offset);
140 int exfat_opendir(struct exfat* ef, struct exfat_node* dir,
141 struct exfat_iterator* it);
142 void exfat_closedir(struct exfat* ef, struct exfat_iterator* it);
143 struct exfat_node* exfat_readdir(struct exfat* ef, struct exfat_iterator* it);
144 int exfat_lookup(struct exfat* ef, struct exfat_node** node,
146 int exfat_split(struct exfat* ef, struct exfat_node** parent,
147 struct exfat_node** node, le16_t* name, const char* path);
149 off_t exfat_c2o(const struct exfat* ef, cluster_t cluster);
150 cluster_t exfat_next_cluster(const struct exfat* ef,
151 const struct exfat_node* node, cluster_t cluster);
152 cluster_t exfat_advance_cluster(const struct exfat* ef,
153 struct exfat_node* node, uint32_t count);
154 void exfat_flush_cmap(struct exfat* ef);
155 int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size);
156 uint32_t exfat_count_free_clusters(const struct exfat* ef);
157 int exfat_find_used_sectors(const struct exfat* ef, off_t* a, off_t* b);
159 void exfat_stat(const struct exfat* ef, const struct exfat_node* node,
161 void exfat_get_name(const struct exfat_node* node, char* buffer, size_t n);
162 uint16_t exfat_start_checksum(const struct exfat_entry_meta1* entry);
163 uint16_t exfat_add_checksum(const void* entry, uint16_t sum);
164 le16_t exfat_calc_checksum(const struct exfat_entry_meta1* meta1,
165 const struct exfat_entry_meta2* meta2, const le16_t* name);
166 uint32_t exfat_vbr_start_checksum(const void* sector, size_t size);
167 uint32_t exfat_vbr_add_checksum(const void* sector, size_t size, uint32_t sum);
168 le16_t exfat_calc_name_hash(const struct exfat* ef, const le16_t* name);
169 void exfat_humanize_bytes(uint64_t value, struct exfat_human_bytes* hb);
170 void exfat_print_info(const struct exfat_super_block* sb,
171 uint32_t free_clusters);
173 int utf16_to_utf8(char* output, const le16_t* input, size_t outsize,
175 int utf8_to_utf16(le16_t* output, const char* input, size_t outsize,
177 size_t utf16_length(const le16_t* str);
179 struct exfat_node* exfat_get_node(struct exfat_node* node);
180 void exfat_put_node(struct exfat* ef, struct exfat_node* node);
181 int exfat_cache_directory(struct exfat* ef, struct exfat_node* dir);
182 void exfat_reset_cache(struct exfat* ef);
183 void exfat_flush_node(struct exfat* ef, struct exfat_node* node);
184 int exfat_unlink(struct exfat* ef, struct exfat_node* node);
185 int exfat_rmdir(struct exfat* ef, struct exfat_node* node);
186 int exfat_mknod(struct exfat* ef, const char* path);
187 int exfat_mkdir(struct exfat* ef, const char* path);
188 int exfat_rename(struct exfat* ef, const char* old_path, const char* new_path);
189 void exfat_utimes(struct exfat_node* node, const struct timespec tv[2]);
190 void exfat_update_atime(struct exfat_node* node);
191 void exfat_update_mtime(struct exfat_node* node);
192 const char* exfat_get_label(struct exfat* ef);
193 int exfat_set_label(struct exfat* ef, const char* label);
195 int exfat_mount(struct exfat* ef, const char* spec, const char* options);
196 void exfat_unmount(struct exfat* ef);
198 time_t exfat_exfat2unix(le16_t date, le16_t time, uint8_t centisec);
199 void exfat_unix2exfat(time_t unix_time, le16_t* date, le16_t* time,
201 void exfat_tzset(void);
203 #endif /* ifndef EXFAT_H_INCLUDED */