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         Copyright (C) 2010-2013  Andrew Nayenko
   7
   8         This program is free software: you can redistribute it and/or modify
   9         it under the terms of the GNU General Public License as published by
  10         the Free Software Foundation, either version 3 of the License, or
  11         (at your option) any later version.
  12
  13         This program is distributed in the hope that it will be useful,
  14         but WITHOUT ANY WARRANTY; without even the implied warranty of
  15         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16         GNU General Public License for more details.
  17
  18         You should have received a copy of the GNU General Public License
  19         along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #ifndef EXFAT_H_INCLUDED
  23 #define EXFAT_H_INCLUDED
  24
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <time.h>
  28 #include <stdbool.h>
  29 #include <sys/stat.h>
  30 #include <sys/types.h>
  31 #include "exfatfs.h"
  32 #include "version.h"
  33
  34 #define EXFAT_NAME_MAX 256
  35 #define EXFAT_ATTRIB_CONTIGUOUS 0x10000
  36 #define EXFAT_ATTRIB_CACHED     0x20000
  37 #define EXFAT_ATTRIB_DIRTY      0x40000
  38 #define EXFAT_ATTRIB_UNLINKED   0x80000
  39 #define IS_CONTIGUOUS(node) (((node).flags & EXFAT_ATTRIB_CONTIGUOUS) != 0)
  40 #define SECTOR_SIZE(sb) (1 << (sb).sector_bits)
  41 #define CLUSTER_SIZE(sb) (SECTOR_SIZE(sb) << (sb).spc_bits)
  42 #define CLUSTER_INVALID(c) \
  43         ((c) < EXFAT_FIRST_DATA_CLUSTER || (c) > EXFAT_LAST_DATA_CLUSTER)
  44
  45 #define MIN(a, b) ((a) < (b) ? (a) : (b))
  46 #define MAX(a, b) ((a) > (b) ? (a) : (b))
  47 #define DIV_ROUND_UP(x, d) (((x) + (d) - 1) / (d))
  48 #define ROUND_UP(x, d) (DIV_ROUND_UP(x, d) * (d))
  49 #define UTF8_BYTES(c) ((c) * 6) /* UTF-8 character can occupy up to 6 bytes */
  50
  51 #define BMAP_GET(bitmap, index) \
  52         (((uint8_t*) bitmap)[(index) / 8] & (1u << ((index) % 8)))
  53 #define BMAP_SET(bitmap, index) \
  54         ((uint8_t*) bitmap)[(index) / 8] |= (1u << ((index) % 8))
  55 #define BMAP_CLR(bitmap, index) \
  56         ((uint8_t*) bitmap)[(index) / 8] &= ~(1u << ((index) % 8))
  57
  58 struct exfat_node
  59 {
  60         struct exfat_node* parent;
  61         struct exfat_node* child;
  62         struct exfat_node* next;
  63         struct exfat_node* prev;
  64
  65         int references;
  66         uint32_t fptr_index;
  67         cluster_t fptr_cluster;
  68         cluster_t entry_cluster;
  69         off_t entry_offset;
  70         cluster_t start_cluster;
  71         int flags;
  72         uint64_t size;
  73         time_t mtime, atime;
  74         le16_t name[EXFAT_NAME_MAX + 1];
  75 };
  76
  77 enum exfat_mode
  78 {
  79         EXFAT_MODE_RO,
  80         EXFAT_MODE_RW,
  81         EXFAT_MODE_ANY,
  82 };
  83
  84 struct exfat_dev;
  85
  86 struct exfat
  87 {
  88         struct exfat_dev* dev;
  89         struct exfat_super_block* sb;
  90         le16_t* upcase;
  91         size_t upcase_chars;
  92         struct exfat_node* root;
  93         struct
  94         {
  95                 cluster_t start_cluster;
  96                 uint32_t size;                          /* in bits */
  97                 uint8_t* chunk;
  98                 uint32_t chunk_size;            /* in bits */
  99                 bool dirty;
 100         }
 101         cmap;
 102         char label[UTF8_BYTES(EXFAT_ENAME_MAX) + 1];
 103         void* zero_cluster;
 104         int dmask, fmask;
 105         uid_t uid;
 106         gid_t gid;
 107         int ro;
 108         bool noatime;
 109 };
 110
 111 /* in-core nodes iterator */
 112 struct exfat_iterator
 113 {
 114         struct exfat_node* parent;
 115         struct exfat_node* current;
 116 };
 117
 118 struct exfat_human_bytes
 119 {
 120         uint64_t value;
 121         const char* unit;
 122 };
 123
 124 extern int exfat_errors;
 125
 126 void exfat_bug(const char* format, ...)
 127         __attribute__((format(printf, 1, 2), noreturn));
 128 void exfat_error(const char* format, ...)
 129         __attribute__((format(printf, 1, 2)));
 130 void exfat_warn(const char* format, ...)
 131         __attribute__((format(printf, 1, 2)));
 132 void exfat_debug(const char* format, ...)
 133         __attribute__((format(printf, 1, 2)));
 134
 135 struct exfat_dev* exfat_open(const char* spec, enum exfat_mode mode);
 136 int exfat_close(struct exfat_dev* dev);
 137 int exfat_fsync(struct exfat_dev* dev);
 138 enum exfat_mode exfat_get_mode(const struct exfat_dev* dev);
 139 off_t exfat_get_size(const struct exfat_dev* dev);
 140 off_t exfat_seek(struct exfat_dev* dev, off_t offset, int whence);
 141 ssize_t exfat_read(struct exfat_dev* dev, void* buffer, size_t size);
 142 ssize_t exfat_write(struct exfat_dev* dev, const void* buffer, size_t size);
 143 void exfat_pread(struct exfat_dev* dev, void* buffer, size_t size,
 144                 off_t offset);
 145 void exfat_pwrite(struct exfat_dev* dev, const void* buffer, size_t size,
 146                 off_t offset);
 147 ssize_t exfat_generic_pread(const struct exfat* ef, struct exfat_node* node,
 148                 void* buffer, size_t size, off_t offset);
 149 ssize_t exfat_generic_pwrite(struct exfat* ef, struct exfat_node* node,
 150                 const void* buffer, size_t size, off_t offset);
 151
 152 int exfat_opendir(struct exfat* ef, struct exfat_node* dir,
 153                 struct exfat_iterator* it);
 154 void exfat_closedir(struct exfat* ef, struct exfat_iterator* it);
 155 struct exfat_node* exfat_readdir(struct exfat* ef, struct exfat_iterator* it);
 156 int exfat_lookup(struct exfat* ef, struct exfat_node** node,
 157                 const char* path);
 158 int exfat_split(struct exfat* ef, struct exfat_node** parent,
 159                 struct exfat_node** node, le16_t* name, const char* path);
 160
 161 off_t exfat_c2o(const struct exfat* ef, cluster_t cluster);
 162 cluster_t exfat_next_cluster(const struct exfat* ef,
 163                 const struct exfat_node* node, cluster_t cluster);
 164 cluster_t exfat_advance_cluster(const struct exfat* ef,
 165                 struct exfat_node* node, uint32_t count);
 166 void exfat_flush_cmap(struct exfat* ef);
 167 int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size,
 168                 bool erase);
 169 uint32_t exfat_count_free_clusters(const struct exfat* ef);
 170 int exfat_find_used_sectors(const struct exfat* ef, off_t* a, off_t* b);
 171
 172 void exfat_stat(const struct exfat* ef, const struct exfat_node* node,
 173                 struct stat* stbuf);
 174 void exfat_get_name(const struct exfat_node* node, char* buffer, size_t n);
 175 uint16_t exfat_start_checksum(const struct exfat_entry_meta1* entry);
 176 uint16_t exfat_add_checksum(const void* entry, uint16_t sum);
 177 le16_t exfat_calc_checksum(const struct exfat_entry_meta1* meta1,
 178                 const struct exfat_entry_meta2* meta2, const le16_t* name);
 179 uint32_t exfat_vbr_start_checksum(const void* sector, size_t size);
 180 uint32_t exfat_vbr_add_checksum(const void* sector, size_t size, uint32_t sum);
 181 le16_t exfat_calc_name_hash(const struct exfat* ef, const le16_t* name);
 182 void exfat_humanize_bytes(uint64_t value, struct exfat_human_bytes* hb);
 183 void exfat_print_info(const struct exfat_super_block* sb,
 184                 uint32_t free_clusters);
 185
 186 int utf16_to_utf8(char* output, const le16_t* input, size_t outsize,
 187                 size_t insize);
 188 int utf8_to_utf16(le16_t* output, const char* input, size_t outsize,
 189                 size_t insize);
 190 size_t utf16_length(const le16_t* str);
 191
 192 struct exfat_node* exfat_get_node(struct exfat_node* node);
 193 void exfat_put_node(struct exfat* ef, struct exfat_node* node);
 194 int exfat_cache_directory(struct exfat* ef, struct exfat_node* dir);
 195 void exfat_reset_cache(struct exfat* ef);
 196 void exfat_flush_node(struct exfat* ef, struct exfat_node* node);
 197 int exfat_unlink(struct exfat* ef, struct exfat_node* node);
 198 int exfat_rmdir(struct exfat* ef, struct exfat_node* node);
 199 int exfat_mknod(struct exfat* ef, const char* path);
 200 int exfat_mkdir(struct exfat* ef, const char* path);
 201 int exfat_rename(struct exfat* ef, const char* old_path, const char* new_path);
 202 void exfat_utimes(struct exfat_node* node, const struct timespec tv[2]);
 203 void exfat_update_atime(struct exfat_node* node);
 204 void exfat_update_mtime(struct exfat_node* node);
 205 const char* exfat_get_label(struct exfat* ef);
 206 int exfat_set_label(struct exfat* ef, const char* label);
 207
 208 int exfat_mount(struct exfat* ef, const char* spec, const char* options);
 209 void exfat_unmount(struct exfat* ef);
 210
 211 time_t exfat_exfat2unix(le16_t date, le16_t time, uint8_t centisec);
 212 void exfat_unix2exfat(time_t unix_time, le16_t* date, le16_t* time,
 213                 uint8_t* centisec);
 214 void exfat_tzset(void);
 215
 216 #endif /* ifndef EXFAT_H_INCLUDED */