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