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