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