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