blob: ff58e8414b933253f118ebdc5d9f832c00e0dc86 [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 bigbiff61cdc022013-08-08 08:35:06 -04006 Free exFAT implementation.
bigbiff bigbiffca829c42013-01-28 08:14:25 -05007 Copyright (C) 2010-2013 Andrew Nayenko
bigbiff bigbiff9c754052013-01-09 09:09:08 -05008
bigbiff bigbiff61cdc022013-08-08 08:35:06 -04009 This program is free software; you can redistribute it and/or modify
bigbiff bigbiff9c754052013-01-09 09:09:08 -050010 it under the terms of the GNU General Public License as published by
bigbiff bigbiff61cdc022013-08-08 08:35:06 -040011 the Free Software Foundation, either version 2 of the License, or
bigbiff bigbiff9c754052013-01-09 09:09:08 -050012 (at your option) any later version.
13
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.
18
bigbiff bigbiff61cdc022013-08-08 08:35:06 -040019 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.
bigbiff bigbiff9c754052013-01-09 09:09:08 -050022*/
23
24#ifndef EXFAT_H_INCLUDED
25#define EXFAT_H_INCLUDED
26
27#include <stdio.h>
28#include <stdlib.h>
29#include <time.h>
30#include <stdbool.h>
31#include <sys/stat.h>
32#include <sys/types.h>
bigbiff bigbiff61cdc022013-08-08 08:35:06 -040033#include "compiler.h"
bigbiff bigbiff9c754052013-01-09 09:09:08 -050034#include "exfatfs.h"
35#include "version.h"
36
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)
47
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))
bigbiff bigbiff004e2df2013-07-03 14:52:12 -040052#define UTF8_BYTES(c) ((c) * 6) /* UTF-8 character can occupy up to 6 bytes */
bigbiff bigbiff9c754052013-01-09 09:09:08 -050053
bigbiff bigbiff61cdc022013-08-08 08:35:06 -040054typedef size_t bitmap_t;
55#define BMAP_SIZE(count) (ROUND_UP(count, sizeof(bitmap_t) * 8) / 8)
56#define BMAP_BLOCK(index) ((index) / sizeof(bitmap_t) / 8)
57#define BMAP_MASK(index) ((bitmap_t) 1 << ((index) % (sizeof(bitmap_t) * 8)))
bigbiff bigbiff9c754052013-01-09 09:09:08 -050058#define BMAP_GET(bitmap, index) \
bigbiff bigbiff61cdc022013-08-08 08:35:06 -040059 ((bitmap)[BMAP_BLOCK(index)] & BMAP_MASK(index))
bigbiff bigbiff9c754052013-01-09 09:09:08 -050060#define BMAP_SET(bitmap, index) \
bigbiff bigbiff61cdc022013-08-08 08:35:06 -040061 ((bitmap)[BMAP_BLOCK(index)] |= BMAP_MASK(index))
bigbiff bigbiff9c754052013-01-09 09:09:08 -050062#define BMAP_CLR(bitmap, index) \
bigbiff bigbiff61cdc022013-08-08 08:35:06 -040063 ((bitmap)[BMAP_BLOCK(index)] &= ~BMAP_MASK(index))
bigbiff bigbiff9c754052013-01-09 09:09:08 -050064
65struct exfat_node
66{
67 struct exfat_node* parent;
68 struct exfat_node* child;
69 struct exfat_node* next;
70 struct exfat_node* prev;
71
72 int references;
73 uint32_t fptr_index;
74 cluster_t fptr_cluster;
75 cluster_t entry_cluster;
76 off64_t entry_offset;
77 cluster_t start_cluster;
78 int flags;
79 uint64_t size;
80 time_t mtime, atime;
81 le16_t name[EXFAT_NAME_MAX + 1];
82};
83
84enum exfat_mode
85{
86 EXFAT_MODE_RO,
87 EXFAT_MODE_RW,
88 EXFAT_MODE_ANY,
89};
90
91struct exfat_dev;
92
93struct exfat
94{
95 struct exfat_dev* dev;
96 struct exfat_super_block* sb;
97 le16_t* upcase;
98 size_t upcase_chars;
99 struct exfat_node* root;
100 struct
101 {
102 cluster_t start_cluster;
103 uint32_t size; /* in bits */
bigbiff bigbiff61cdc022013-08-08 08:35:06 -0400104 bitmap_t* chunk;
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500105 uint32_t chunk_size; /* in bits */
106 bool dirty;
107 }
108 cmap;
bigbiff bigbiff004e2df2013-07-03 14:52:12 -0400109 char label[UTF8_BYTES(EXFAT_ENAME_MAX) + 1];
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500110 void* zero_cluster;
111 int dmask, fmask;
112 uid_t uid;
113 gid_t gid;
114 int ro;
115 bool noatime;
116};
117
118/* in-core nodes iterator */
119struct exfat_iterator
120{
121 struct exfat_node* parent;
122 struct exfat_node* current;
123};
124
125struct exfat_human_bytes
126{
127 uint64_t value;
128 const char* unit;
129};
130
131extern int exfat_errors;
132
bigbiff bigbiff61cdc022013-08-08 08:35:06 -0400133void exfat_bug(const char* format, ...) PRINTF NORETURN;
134void exfat_error(const char* format, ...) PRINTF;
135void exfat_warn(const char* format, ...) PRINTF;
136void exfat_debug(const char* format, ...) PRINTF;
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500137
138struct exfat_dev* exfat_open(const char* spec, enum exfat_mode mode);
139int exfat_close(struct exfat_dev* dev);
140int exfat_fsync(struct exfat_dev* dev);
141enum exfat_mode exfat_get_mode(const struct exfat_dev* dev);
142off64_t exfat_get_size(const struct exfat_dev* dev);
143off64_t exfat_seek(struct exfat_dev* dev, off64_t offset, int whence);
144ssize_t exfat_read(struct exfat_dev* dev, void* buffer, size_t size);
145ssize_t exfat_write(struct exfat_dev* dev, const void* buffer, size_t size);
bigbiff bigbiff61cdc022013-08-08 08:35:06 -0400146ssize_t exfat_pread(struct exfat_dev* dev, void* buffer, size_t size,
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500147 off64_t offset);
bigbiff bigbiff61cdc022013-08-08 08:35:06 -0400148ssize_t exfat_pwrite(struct exfat_dev* dev, const void* buffer, size_t size,
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500149 off64_t offset);
150ssize_t exfat_generic_pread(const struct exfat* ef, struct exfat_node* node,
151 void* buffer, size_t size, off64_t offset);
152ssize_t exfat_generic_pwrite(struct exfat* ef, struct exfat_node* node,
153 const void* buffer, size_t size, off64_t offset);
154
155int exfat_opendir(struct exfat* ef, struct exfat_node* dir,
156 struct exfat_iterator* it);
157void exfat_closedir(struct exfat* ef, struct exfat_iterator* it);
158struct exfat_node* exfat_readdir(struct exfat* ef, struct exfat_iterator* it);
159int exfat_lookup(struct exfat* ef, struct exfat_node** node,
160 const char* path);
161int exfat_split(struct exfat* ef, struct exfat_node** parent,
162 struct exfat_node** node, le16_t* name, const char* path);
163
164off64_t exfat_c2o(const struct exfat* ef, cluster_t cluster);
165cluster_t exfat_next_cluster(const struct exfat* ef,
166 const struct exfat_node* node, cluster_t cluster);
167cluster_t exfat_advance_cluster(const struct exfat* ef,
168 struct exfat_node* node, uint32_t count);
bigbiff bigbiff61cdc022013-08-08 08:35:06 -0400169int exfat_flush(struct exfat* ef);
bigbiff bigbiff998716f2013-03-07 09:59:37 -0500170int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size,
171 bool erase);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500172uint32_t exfat_count_free_clusters(const struct exfat* ef);
173int exfat_find_used_sectors(const struct exfat* ef, off64_t* a, off64_t* b);
174
175void exfat_stat(const struct exfat* ef, const struct exfat_node* node,
176 struct stat* stbuf);
177void exfat_get_name(const struct exfat_node* node, char* buffer, size_t n);
178uint16_t exfat_start_checksum(const struct exfat_entry_meta1* entry);
179uint16_t exfat_add_checksum(const void* entry, uint16_t sum);
180le16_t exfat_calc_checksum(const struct exfat_entry_meta1* meta1,
181 const struct exfat_entry_meta2* meta2, const le16_t* name);
182uint32_t exfat_vbr_start_checksum(const void* sector, size_t size);
183uint32_t exfat_vbr_add_checksum(const void* sector, size_t size, uint32_t sum);
184le16_t exfat_calc_name_hash(const struct exfat* ef, const le16_t* name);
185void exfat_humanize_bytes(uint64_t value, struct exfat_human_bytes* hb);
186void exfat_print_info(const struct exfat_super_block* sb,
187 uint32_t free_clusters);
188
189int utf16_to_utf8(char* output, const le16_t* input, size_t outsize,
190 size_t insize);
191int utf8_to_utf16(le16_t* output, const char* input, size_t outsize,
192 size_t insize);
193size_t utf16_length(const le16_t* str);
194
195struct exfat_node* exfat_get_node(struct exfat_node* node);
196void exfat_put_node(struct exfat* ef, struct exfat_node* node);
197int exfat_cache_directory(struct exfat* ef, struct exfat_node* dir);
198void exfat_reset_cache(struct exfat* ef);
bigbiff bigbiff61cdc022013-08-08 08:35:06 -0400199int exfat_flush_node(struct exfat* ef, struct exfat_node* node);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500200int exfat_unlink(struct exfat* ef, struct exfat_node* node);
201int exfat_rmdir(struct exfat* ef, struct exfat_node* node);
202int exfat_mknod(struct exfat* ef, const char* path);
203int exfat_mkdir(struct exfat* ef, const char* path);
204int exfat_rename(struct exfat* ef, const char* old_path, const char* new_path);
205void exfat_utimes(struct exfat_node* node, const struct timespec tv[2]);
206void exfat_update_atime(struct exfat_node* node);
207void exfat_update_mtime(struct exfat_node* node);
208const char* exfat_get_label(struct exfat* ef);
209int exfat_set_label(struct exfat* ef, const char* label);
210
211int exfat_mount(struct exfat* ef, const char* spec, const char* options);
212void exfat_unmount(struct exfat* ef);
213
214time_t exfat_exfat2unix(le16_t date, le16_t time, uint8_t centisec);
215void exfat_unix2exfat(time_t unix_time, le16_t* date, le16_t* time,
216 uint8_t* centisec);
217void exfat_tzset(void);
218
219#endif /* ifndef EXFAT_H_INCLUDED */