blob: 11be06f7b844f0a1b248d02a4f60560e0ea334a6 [file] [log] [blame]
bigbiff bigbiff9c754052013-01-09 09:09:08 -05001/*
2 exfat.h (29.08.09)
3 Definitions of structures and constants used in exFAT file system
4 implementation.
5
bigbiff bigbiffca829c42013-01-28 08:14:25 -05006 Copyright (C) 2010-2013 Andrew Nayenko
bigbiff bigbiff9c754052013-01-09 09:09:08 -05007
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.
12
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.
17
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/>.
20*/
21
22#ifndef EXFAT_H_INCLUDED
23#define EXFAT_H_INCLUDED
24
25#include <stdio.h>
26#include <stdlib.h>
27#include <time.h>
28#include <stdbool.h>
29#include <sys/stat.h>
30#include <sys/types.h>
31#include "exfatfs.h"
32#include "version.h"
33
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)
44
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))
49
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))
56
57struct exfat_node
58{
59 struct exfat_node* parent;
60 struct exfat_node* child;
61 struct exfat_node* next;
62 struct exfat_node* prev;
63
64 int references;
65 uint32_t fptr_index;
66 cluster_t fptr_cluster;
67 cluster_t entry_cluster;
68 off64_t entry_offset;
69 cluster_t start_cluster;
70 int flags;
71 uint64_t size;
72 time_t mtime, atime;
73 le16_t name[EXFAT_NAME_MAX + 1];
74};
75
76enum exfat_mode
77{
78 EXFAT_MODE_RO,
79 EXFAT_MODE_RW,
80 EXFAT_MODE_ANY,
81};
82
83struct exfat_dev;
84
85struct exfat
86{
87 struct exfat_dev* dev;
88 struct exfat_super_block* sb;
89 le16_t* upcase;
90 size_t upcase_chars;
91 struct exfat_node* root;
92 struct
93 {
94 cluster_t start_cluster;
95 uint32_t size; /* in bits */
96 uint8_t* chunk;
97 uint32_t chunk_size; /* in bits */
98 bool dirty;
99 }
100 cmap;
101 char label[EXFAT_ENAME_MAX * 6 + 1]; /* a character can occupy up to
102 6 bytes in UTF-8 */
103 void* zero_cluster;
104 int dmask, fmask;
105 uid_t uid;
106 gid_t gid;
107 int ro;
108 bool noatime;
109};
110
111/* in-core nodes iterator */
112struct exfat_iterator
113{
114 struct exfat_node* parent;
115 struct exfat_node* current;
116};
117
118struct exfat_human_bytes
119{
120 uint64_t value;
121 const char* unit;
122};
123
124extern int exfat_errors;
125
126void exfat_bug(const char* format, ...)
127 __attribute__((format(printf, 1, 2), noreturn));
128void exfat_error(const char* format, ...)
129 __attribute__((format(printf, 1, 2)));
130void exfat_warn(const char* format, ...)
131 __attribute__((format(printf, 1, 2)));
132void exfat_debug(const char* format, ...)
133 __attribute__((format(printf, 1, 2)));
134
135struct exfat_dev* exfat_open(const char* spec, enum exfat_mode mode);
136int exfat_close(struct exfat_dev* dev);
137int exfat_fsync(struct exfat_dev* dev);
138enum exfat_mode exfat_get_mode(const struct exfat_dev* dev);
139off64_t exfat_get_size(const struct exfat_dev* dev);
140off64_t exfat_seek(struct exfat_dev* dev, off64_t offset, int whence);
141ssize_t exfat_read(struct exfat_dev* dev, void* buffer, size_t size);
142ssize_t exfat_write(struct exfat_dev* dev, const void* buffer, size_t size);
143void exfat_pread(struct exfat_dev* dev, void* buffer, size_t size,
144 off64_t offset);
145void exfat_pwrite(struct exfat_dev* dev, const void* buffer, size_t size,
146 off64_t offset);
147ssize_t exfat_generic_pread(const struct exfat* ef, struct exfat_node* node,
148 void* buffer, size_t size, off64_t offset);
149ssize_t exfat_generic_pwrite(struct exfat* ef, struct exfat_node* node,
150 const void* buffer, size_t size, off64_t offset);
151
152int exfat_opendir(struct exfat* ef, struct exfat_node* dir,
153 struct exfat_iterator* it);
154void exfat_closedir(struct exfat* ef, struct exfat_iterator* it);
155struct exfat_node* exfat_readdir(struct exfat* ef, struct exfat_iterator* it);
156int exfat_lookup(struct exfat* ef, struct exfat_node** node,
157 const char* path);
158int exfat_split(struct exfat* ef, struct exfat_node** parent,
159 struct exfat_node** node, le16_t* name, const char* path);
160
161off64_t exfat_c2o(const struct exfat* ef, cluster_t cluster);
162cluster_t exfat_next_cluster(const struct exfat* ef,
163 const struct exfat_node* node, cluster_t cluster);
164cluster_t exfat_advance_cluster(const struct exfat* ef,
165 struct exfat_node* node, uint32_t count);
166void exfat_flush_cmap(struct exfat* ef);
167int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size);
168uint32_t exfat_count_free_clusters(const struct exfat* ef);
169int exfat_find_used_sectors(const struct exfat* ef, off64_t* a, off64_t* b);
170
171void exfat_stat(const struct exfat* ef, const struct exfat_node* node,
172 struct stat* stbuf);
173void exfat_get_name(const struct exfat_node* node, char* buffer, size_t n);
174uint16_t exfat_start_checksum(const struct exfat_entry_meta1* entry);
175uint16_t exfat_add_checksum(const void* entry, uint16_t sum);
176le16_t exfat_calc_checksum(const struct exfat_entry_meta1* meta1,
177 const struct exfat_entry_meta2* meta2, const le16_t* name);
178uint32_t exfat_vbr_start_checksum(const void* sector, size_t size);
179uint32_t exfat_vbr_add_checksum(const void* sector, size_t size, uint32_t sum);
180le16_t exfat_calc_name_hash(const struct exfat* ef, const le16_t* name);
181void exfat_humanize_bytes(uint64_t value, struct exfat_human_bytes* hb);
182void exfat_print_info(const struct exfat_super_block* sb,
183 uint32_t free_clusters);
184
185int utf16_to_utf8(char* output, const le16_t* input, size_t outsize,
186 size_t insize);
187int utf8_to_utf16(le16_t* output, const char* input, size_t outsize,
188 size_t insize);
189size_t utf16_length(const le16_t* str);
190
191struct exfat_node* exfat_get_node(struct exfat_node* node);
192void exfat_put_node(struct exfat* ef, struct exfat_node* node);
193int exfat_cache_directory(struct exfat* ef, struct exfat_node* dir);
194void exfat_reset_cache(struct exfat* ef);
195void exfat_flush_node(struct exfat* ef, struct exfat_node* node);
196int exfat_unlink(struct exfat* ef, struct exfat_node* node);
197int exfat_rmdir(struct exfat* ef, struct exfat_node* node);
198int exfat_mknod(struct exfat* ef, const char* path);
199int exfat_mkdir(struct exfat* ef, const char* path);
200int exfat_rename(struct exfat* ef, const char* old_path, const char* new_path);
201void exfat_utimes(struct exfat_node* node, const struct timespec tv[2]);
202void exfat_update_atime(struct exfat_node* node);
203void exfat_update_mtime(struct exfat_node* node);
204const char* exfat_get_label(struct exfat* ef);
205int exfat_set_label(struct exfat* ef, const char* label);
206
207int exfat_mount(struct exfat* ef, const char* spec, const char* options);
208void exfat_unmount(struct exfat* ef);
209
210time_t exfat_exfat2unix(le16_t date, le16_t time, uint8_t centisec);
211void exfat_unix2exfat(time_t unix_time, le16_t* date, le16_t* time,
212 uint8_t* centisec);
213void exfat_tzset(void);
214
215#endif /* ifndef EXFAT_H_INCLUDED */