libexfat/exfat.h

   1 /*
   2         exfat.h (29.08.09)
   3         Definitions of structures and constants used in exFAT file system
   4         implementation.
   5
   6         Free exFAT implementation.
   7         Copyright (C) 2010-2023  Andrew Nayenko
   8
   9         This program is free software; you can redistribute it and/or modify
  10         it under the terms of the GNU General Public License as published by
  11         the Free Software Foundation, either version 2 of the License, or
  12         (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
  19         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.
  22 */
  23
  24 #ifndef EXFAT_H_INCLUDED
  25 #define EXFAT_H_INCLUDED
  26
  27 #ifndef ANDROID
  28 /* Android.bp is used instead of autotools when targeting Android */
  29 #include "config.h"
  30 #endif
  31 #include "compiler.h"
  32 #include "exfatfs.h"
  33 #include <stdio.h>
  34 #include <stdlib.h>
  35 #include <time.h>
  36 #include <stdbool.h>
  37 #include <sys/stat.h>
  38 #include <sys/types.h>
  39
  40 #define EXFAT_NAME_MAX 255
  41 /* UTF-16 encodes code points up to U+FFFF as single 16-bit code units.
  42    UTF-8 uses up to 3 bytes (i.e. 8-bit code units) to encode code points
  43    up to U+FFFF. One additional character is for null terminator. */
  44 #define EXFAT_UTF8_NAME_BUFFER_MAX (EXFAT_NAME_MAX * 3 + 1)
  45 #define EXFAT_UTF8_ENAME_BUFFER_MAX (EXFAT_ENAME_MAX * 3 + 1)
  46
  47 #define SECTOR_SIZE(sb) (1 << (sb).sector_bits)
  48 #define CLUSTER_SIZE(sb) (SECTOR_SIZE(sb) << (sb).spc_bits)
  49 #define CLUSTER_INVALID(sb, c) ((c) < EXFAT_FIRST_DATA_CLUSTER || \
  50         (c) - EXFAT_FIRST_DATA_CLUSTER >= le32_to_cpu((sb).cluster_count))
  51
  52 #define MIN(a, b) ((a) < (b) ? (a) : (b))
  53 #define MAX(a, b) ((a) > (b) ? (a) : (b))
  54 #define DIV_ROUND_UP(x, d) (((x) + (d) - 1) / (d))
  55 #define ROUND_UP(x, d) (DIV_ROUND_UP(x, d) * (d))
  56
  57 #define BMAP_SIZE(count) (ROUND_UP(count, sizeof(bitmap_t) * 8) / 8)
  58 #define BMAP_BLOCK(index) ((index) / sizeof(bitmap_t) / 8)
  59 #define BMAP_MASK(index) ((bitmap_t) 1 << ((index) % (sizeof(bitmap_t) * 8)))
  60 #define BMAP_GET(bitmap, index) \
  61         ((bitmap)[BMAP_BLOCK(index)] & BMAP_MASK(index))
  62 #define BMAP_SET(bitmap, index) \
  63         ((bitmap)[BMAP_BLOCK(index)] |= BMAP_MASK(index))
  64 #define BMAP_CLR(bitmap, index) \
  65         ((bitmap)[BMAP_BLOCK(index)] &= ~BMAP_MASK(index))
  66
  67 #define EXFAT_REPAIR(hook, ef, ...) \
  68         (exfat_ask_to_fix(ef) && exfat_fix_ ## hook(ef, __VA_ARGS__))
  69
  70 /* The size of off_t type must be 64 bits. File systems larger than 2 GB will
  71    be corrupted with 32-bit off_t. */
  72 STATIC_ASSERT(sizeof(off_t) == 8);
  73
  74 struct exfat_node
  75 {
  76         struct exfat_node* parent;
  77         struct exfat_node* child;
  78         struct exfat_node* next;
  79         struct exfat_node* prev;
  80
  81         int references;
  82         uint32_t fptr_index;
  83         cluster_t fptr_cluster;
  84         off_t entry_offset;
  85         cluster_t start_cluster;
  86         uint16_t attrib;
  87         uint8_t continuations;
  88         bool is_contiguous : 1;
  89         bool is_cached : 1;
  90         bool is_dirty : 1;
  91         bool is_unlinked : 1;
  92         uint64_t valid_size;
  93         uint64_t size;
  94         time_t mtime, atime;
  95         le16_t name[EXFAT_NAME_MAX + 1];
  96 };
  97
  98 enum exfat_mode
  99 {
 100         EXFAT_MODE_RO,
 101         EXFAT_MODE_RW,
 102         EXFAT_MODE_ANY,
 103 };
 104
 105 struct exfat_dev;
 106
 107 struct exfat
 108 {
 109         struct exfat_dev* dev;
 110         struct exfat_super_block* sb;
 111         uint16_t* upcase;
 112         struct exfat_node* root;
 113         struct
 114         {
 115                 cluster_t start_cluster;
 116                 uint32_t size;                          /* in bits */
 117                 bitmap_t* chunk;
 118                 uint32_t chunk_size;            /* in bits */
 119                 bool dirty;
 120         }
 121         cmap;
 122         char label[EXFAT_UTF8_ENAME_BUFFER_MAX];
 123         void* zero_cluster;
 124         int dmask, fmask;
 125         uid_t uid;
 126         gid_t gid;
 127         int ro;
 128         bool noatime;
 129         enum { EXFAT_REPAIR_NO, EXFAT_REPAIR_ASK, EXFAT_REPAIR_YES } repair;
 130 };
 131
 132 /* in-core nodes iterator */
 133 struct exfat_iterator
 134 {
 135         struct exfat_node* parent;
 136         struct exfat_node* current;
 137 };
 138
 139 struct exfat_human_bytes
 140 {
 141         uint64_t value;
 142         const char* unit;
 143 };
 144
 145 extern int exfat_errors;
 146 extern int exfat_errors_fixed;
 147
 148 void exfat_bug(const char* format, ...) PRINTF NORETURN;
 149 void exfat_error(const char* format, ...) PRINTF;
 150 void exfat_warn(const char* format, ...) PRINTF;
 151 void exfat_debug(const char* format, ...) PRINTF;
 152
 153 struct exfat_dev* exfat_open(const char* spec, enum exfat_mode mode);
 154 int exfat_close(struct exfat_dev* dev);
 155 int exfat_fsync(struct exfat_dev* dev);
 156 enum exfat_mode exfat_get_mode(const struct exfat_dev* dev);
 157 off_t exfat_get_size(const struct exfat_dev* dev);
 158 off_t exfat_seek(struct exfat_dev* dev, off_t offset, int whence);
 159 ssize_t exfat_read(struct exfat_dev* dev, void* buffer, size_t size);
 160 ssize_t exfat_write(struct exfat_dev* dev, const void* buffer, size_t size);
 161 ssize_t exfat_pread(struct exfat_dev* dev, void* buffer, size_t size,
 162                 off_t offset);
 163 ssize_t exfat_pwrite(struct exfat_dev* dev, const void* buffer, size_t size,
 164                 off_t offset);
 165 ssize_t exfat_generic_pread(const struct exfat* ef, struct exfat_node* node,
 166                 void* buffer, size_t size, off_t offset);
 167 ssize_t exfat_generic_pwrite(struct exfat* ef, struct exfat_node* node,
 168                 const void* buffer, size_t size, off_t offset);
 169
 170 int exfat_opendir(struct exfat* ef, struct exfat_node* dir,
 171                 struct exfat_iterator* it);
 172 void exfat_closedir(struct exfat* ef, struct exfat_iterator* it);
 173 struct exfat_node* exfat_readdir(struct exfat_iterator* it);
 174 int exfat_lookup(struct exfat* ef, struct exfat_node** node,
 175                 const char* path);
 176 int exfat_split(struct exfat* ef, struct exfat_node** parent,
 177                 struct exfat_node** node, le16_t* name, const char* path);
 178
 179 off_t exfat_c2o(const struct exfat* ef, cluster_t cluster);
 180 cluster_t exfat_next_cluster(const struct exfat* ef,
 181                 const struct exfat_node* node, cluster_t cluster);
 182 cluster_t exfat_advance_cluster(const struct exfat* ef,
 183                 struct exfat_node* node, uint32_t count);
 184 int exfat_flush_nodes(struct exfat* ef);
 185 int exfat_flush(struct exfat* ef);
 186 int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size,
 187                 bool erase);
 188 uint32_t exfat_count_free_clusters(const struct exfat* ef);
 189 int exfat_find_used_sectors(const struct exfat* ef, off_t* a, off_t* b);
 190
 191 void exfat_stat(const struct exfat* ef, const struct exfat_node* node,
 192                 struct stat* stbuf);
 193 void exfat_get_name(const struct exfat_node* node,
 194                 char buffer[EXFAT_UTF8_NAME_BUFFER_MAX]);
 195 uint16_t exfat_start_checksum(const struct exfat_entry_meta1* entry);
 196 uint16_t exfat_add_checksum(const void* entry, uint16_t sum);
 197 le16_t exfat_calc_checksum(const struct exfat_entry* entries, int n);
 198 uint32_t exfat_vbr_start_checksum(const void* sector, size_t size);
 199 uint32_t exfat_vbr_add_checksum(const void* sector, size_t size, uint32_t sum);
 200 le16_t exfat_calc_name_hash(const struct exfat* ef, const le16_t* name,
 201                 size_t length);
 202 void exfat_humanize_bytes(uint64_t value, struct exfat_human_bytes* hb);
 203 void exfat_print_info(const struct exfat_super_block* sb,
 204                 uint32_t free_clusters);
 205 bool exfat_match_option(const char* options, const char* option_name);
 206
 207 int exfat_utf16_to_utf8(char* output, const le16_t* input, size_t outsize,
 208                 size_t insize);
 209 int exfat_utf8_to_utf16(le16_t* output, const char* input, size_t outsize,
 210                 size_t insize);
 211 size_t exfat_utf16_length(const le16_t* str);
 212
 213 struct exfat_node* exfat_get_node(struct exfat_node* node);
 214 void exfat_put_node(struct exfat* ef, struct exfat_node* node);
 215 int exfat_cleanup_node(struct exfat* ef, struct exfat_node* node);
 216 int exfat_cache_directory(struct exfat* ef, struct exfat_node* dir);
 217 void exfat_reset_cache(struct exfat* ef);
 218 int exfat_flush_node(struct exfat* ef, struct exfat_node* node);
 219 int exfat_unlink(struct exfat* ef, struct exfat_node* node);
 220 int exfat_rmdir(struct exfat* ef, struct exfat_node* node);
 221 int exfat_mknod(struct exfat* ef, const char* path);
 222 int exfat_mkdir(struct exfat* ef, const char* path);
 223 int exfat_rename(struct exfat* ef, const char* old_path, const char* new_path);
 224 void exfat_utimes(struct exfat_node* node, const struct timespec tv[2]);
 225 void exfat_update_atime(struct exfat_node* node);
 226 void exfat_update_mtime(struct exfat_node* node);
 227 const char* exfat_get_label(struct exfat* ef);
 228 int exfat_set_label(struct exfat* ef, const char* label);
 229
 230 int exfat_soil_super_block(const struct exfat* ef);
 231 int exfat_mount(struct exfat* ef, const char* spec, const char* options);
 232 void exfat_unmount(struct exfat* ef);
 233
 234 time_t exfat_exfat2unix(le16_t date, le16_t time, uint8_t centisec,
 235                 uint8_t tzoffset);
 236 void exfat_unix2exfat(time_t unix_time, le16_t* date, le16_t* time,
 237                 uint8_t* centisec, uint8_t* tzoffset);
 238 void exfat_tzset(void);
 239
 240 bool exfat_ask_to_fix(const struct exfat* ef);
 241 bool exfat_fix_invalid_vbr_checksum(const struct exfat* ef, void* sector,
 242                 uint32_t vbr_checksum);
 243 bool exfat_fix_invalid_node_checksum(const struct exfat* ef,
 244                 struct exfat_node* node);
 245 bool exfat_fix_unknown_entry(struct exfat* ef, struct exfat_node* dir,
 246                 const struct exfat_entry* entry, off_t offset);
 247
 248 #endif /* ifndef EXFAT_H_INCLUDED */