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