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