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_LAST_DATA_CLUSTER)
43 #define MIN(a, b) ((a) < (b) ? (a) : (b))
44 #define MAX(a, b) ((a) > (b) ? (a) : (b))
45 #define DIV_ROUND_UP(x, d) (((x) + (d) - 1) / (d))
47 #define BMAP_GET(bitmap, index) \
48 (((uint8_t*) bitmap)[(index) / 8] & (1u << ((index) % 8)))
49 #define BMAP_SET(bitmap, index) \
50 ((uint8_t*) bitmap)[(index) / 8] |= (1u << ((index) % 8))
51 #define BMAP_CLR(bitmap, index) \
52 ((uint8_t*) bitmap)[(index) / 8] &= ~(1u << ((index) % 8))
56 struct exfat_node* parent;
57 struct exfat_node* child;
58 struct exfat_node* next;
59 struct exfat_node* prev;
63 cluster_t fptr_cluster;
64 cluster_t entry_cluster;
66 cluster_t start_cluster;
70 le16_t name[EXFAT_NAME_MAX + 1];
77 struct exfat_dev* dev;
78 struct exfat_super_block* sb;
81 struct exfat_node* root;
84 cluster_t start_cluster;
85 uint32_t size; /* in bits */
87 uint32_t chunk_size; /* in bits */
91 char label[EXFAT_ENAME_MAX * 6 + 1]; /* a character can occupy up to
102 /* in-core nodes iterator */
103 struct exfat_iterator
105 struct exfat_node* parent;
106 struct exfat_node* current;
109 struct exfat_human_bytes
115 extern int exfat_errors;
117 void exfat_bug(const char* format, ...)
118 __attribute__((format(printf, 1, 2), noreturn));
119 void exfat_error(const char* format, ...)
120 __attribute__((format(printf, 1, 2)));
121 void exfat_warn(const char* format, ...)
122 __attribute__((format(printf, 1, 2)));
123 void exfat_debug(const char* format, ...)
124 __attribute__((format(printf, 1, 2)));
126 struct exfat_dev* exfat_open(const char* spec, int ro);
127 int exfat_close(struct exfat_dev* dev);
128 int exfat_fsync(struct exfat_dev* dev);
129 off_t exfat_seek(struct exfat_dev* dev, off_t offset, int whence);
130 ssize_t exfat_read(struct exfat_dev* dev, void* buffer, size_t size);
131 ssize_t exfat_write(struct exfat_dev* dev, const void* buffer, size_t size);
132 void exfat_pread(struct exfat_dev* dev, void* buffer, size_t size,
134 void exfat_pwrite(struct exfat_dev* dev, const void* buffer, size_t size,
136 ssize_t exfat_generic_pread(const struct exfat* ef, struct exfat_node* node,
137 void* buffer, size_t size, off_t offset);
138 ssize_t exfat_generic_pwrite(struct exfat* ef, struct exfat_node* node,
139 const void* buffer, size_t size, off_t offset);
141 int exfat_opendir(struct exfat* ef, struct exfat_node* dir,
142 struct exfat_iterator* it);
143 void exfat_closedir(struct exfat* ef, struct exfat_iterator* it);
144 struct exfat_node* exfat_readdir(struct exfat* ef, struct exfat_iterator* it);
145 int exfat_lookup(struct exfat* ef, struct exfat_node** node,
147 int exfat_split(struct exfat* ef, struct exfat_node** parent,
148 struct exfat_node** node, le16_t* name, const char* path);
150 off_t exfat_c2o(const struct exfat* ef, cluster_t cluster);
151 cluster_t exfat_next_cluster(const struct exfat* ef,
152 const struct exfat_node* node, cluster_t cluster);
153 cluster_t exfat_advance_cluster(const struct exfat* ef,
154 struct exfat_node* node, uint32_t count);
155 void exfat_flush_cmap(struct exfat* ef);
156 int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size);
157 uint32_t exfat_count_free_clusters(const struct exfat* ef);
158 int exfat_find_used_sectors(const struct exfat* ef, off_t* a, off_t* b);
160 void exfat_stat(const struct exfat* ef, const struct exfat_node* node,
162 void exfat_get_name(const struct exfat_node* node, char* buffer, size_t n);
163 uint16_t exfat_start_checksum(const struct exfat_entry_meta1* entry);
164 uint16_t exfat_add_checksum(const void* entry, uint16_t sum);
165 le16_t exfat_calc_checksum(const struct exfat_entry_meta1* meta1,
166 const struct exfat_entry_meta2* meta2, const le16_t* name);
167 uint32_t exfat_vbr_start_checksum(const void* sector, size_t size);
168 uint32_t exfat_vbr_add_checksum(const void* sector, size_t size, uint32_t sum);
169 le16_t exfat_calc_name_hash(const struct exfat* ef, const le16_t* name);
170 void exfat_humanize_bytes(uint64_t value, struct exfat_human_bytes* hb);
171 void exfat_print_info(const struct exfat_super_block* sb,
172 uint32_t free_clusters);
174 int utf16_to_utf8(char* output, const le16_t* input, size_t outsize,
176 int utf8_to_utf16(le16_t* output, const char* input, size_t outsize,
178 size_t utf16_length(const le16_t* str);
180 struct exfat_node* exfat_get_node(struct exfat_node* node);
181 void exfat_put_node(struct exfat* ef, struct exfat_node* node);
182 int exfat_cache_directory(struct exfat* ef, struct exfat_node* dir);
183 void exfat_reset_cache(struct exfat* ef);
184 void exfat_flush_node(struct exfat* ef, struct exfat_node* node);
185 int exfat_unlink(struct exfat* ef, struct exfat_node* node);
186 int exfat_rmdir(struct exfat* ef, struct exfat_node* node);
187 int exfat_mknod(struct exfat* ef, const char* path);
188 int exfat_mkdir(struct exfat* ef, const char* path);
189 int exfat_rename(struct exfat* ef, const char* old_path, const char* new_path);
190 void exfat_utimes(struct exfat_node* node, const struct timespec tv[2]);
191 void exfat_update_atime(struct exfat_node* node);
192 void exfat_update_mtime(struct exfat_node* node);
193 const char* exfat_get_label(struct exfat* ef);
194 int exfat_set_label(struct exfat* ef, const char* label);
196 int exfat_mount(struct exfat* ef, const char* spec, const char* options);
197 void exfat_unmount(struct exfat* ef);
199 time_t exfat_exfat2unix(le16_t date, le16_t time, uint8_t centisec);
200 void exfat_unix2exfat(time_t unix_time, le16_t* date, le16_t* time,
202 void exfat_tzset(void);
204 #endif /* ifndef EXFAT_H_INCLUDED */