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 BLOCK_SIZE(sb) (1 << (sb).block_bits)
  40 #define CLUSTER_SIZE(sb) (BLOCK_SIZE(sb) << (sb).bpc_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 struct exfat_node
  47 {
  48         struct exfat_node* parent;
  49         struct exfat_node* child;
  50         struct exfat_node* next;
  51         struct exfat_node* prev;
  52
  53         int references;
  54         uint32_t fptr_index;
  55         cluster_t fptr_cluster;
  56         cluster_t entry_cluster;
  57         off_t entry_offset;
  58         cluster_t start_cluster;
  59         int flags;
  60         uint64_t size;
  61         time_t mtime, atime;
  62         le16_t name[EXFAT_NAME_MAX + 1];
  63 };
  64
  65 struct exfat
  66 {
  67         struct exfat_super_block* sb;
  68         int fd;
  69         le16_t* upcase;
  70         size_t upcase_chars;
  71         struct exfat_node* root;
  72         struct
  73         {
  74                 cluster_t start_cluster;
  75                 uint32_t size;                          /* in bits */
  76                 uint8_t* chunk;
  77                 uint32_t chunk_size;            /* in bits */
  78                 int dirty;
  79         }
  80         cmap;
  81         void* zero_block;
  82         int dmask, fmask;
  83         uid_t uid;
  84         gid_t gid;
  85         int ro;
  86         int noatime;
  87 };
  88
  89 /* in-core nodes iterator */
  90 struct exfat_iterator
  91 {
  92         struct exfat_node* parent;
  93         struct exfat_node* current;
  94 };
  95
  96 extern int exfat_errors;
  97
  98 void exfat_bug(const char* format, ...)
  99         __attribute__((format(printf, 1, 2), noreturn));
 100 void exfat_error(const char* format, ...)
 101         __attribute__((format(printf, 1, 2)));
 102 void exfat_warn(const char* format, ...)
 103         __attribute__((format(printf, 1, 2)));
 104 void exfat_debug(const char* format, ...)
 105         __attribute__((format(printf, 1, 2)));
 106
 107 void exfat_read_raw(void* buffer, size_t size, off_t offset, int fd);
 108 void exfat_write_raw(const void* buffer, size_t size, off_t offset, int fd);
 109 ssize_t exfat_read(const struct exfat* ef, struct exfat_node* node,
 110                 void* buffer, size_t size, off_t offset);
 111 ssize_t exfat_write(struct exfat* ef, struct exfat_node* node,
 112                 const void* buffer, size_t size, off_t offset);
 113
 114 int exfat_opendir(struct exfat* ef, struct exfat_node* dir,
 115                 struct exfat_iterator* it);
 116 void exfat_closedir(struct exfat* ef, struct exfat_iterator* it);
 117 struct exfat_node* exfat_readdir(struct exfat* ef, struct exfat_iterator* it);
 118 int exfat_lookup(struct exfat* ef, struct exfat_node** node,
 119                 const char* path);
 120 int exfat_split(struct exfat* ef, struct exfat_node** parent,
 121                 struct exfat_node** node, le16_t* name, const char* path);
 122
 123 off_t exfat_c2o(const struct exfat* ef, cluster_t cluster);
 124 cluster_t exfat_next_cluster(const struct exfat* ef,
 125                 const struct exfat_node* node, cluster_t cluster);
 126 cluster_t exfat_advance_cluster(const struct exfat* ef,
 127                 struct exfat_node* node, uint32_t count);
 128 void exfat_flush_cmap(struct exfat* ef);
 129 int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size);
 130 uint32_t exfat_count_free_clusters(struct exfat* ef);
 131
 132 void exfat_stat(const struct exfat* ef, const struct exfat_node* node,
 133                 struct stat* stbuf);
 134 time_t exfat_exfat2unix(le16_t date, le16_t time, uint8_t centisec);
 135 void exfat_unix2exfat(time_t unix_time, le16_t* date, le16_t* time,
 136                 uint8_t* centisec);
 137 void exfat_get_name(const struct exfat_node* node, char* buffer, size_t n);
 138 uint16_t exfat_start_checksum(const struct exfat_entry_meta1* entry);
 139 uint16_t exfat_add_checksum(const void* entry, uint16_t sum);
 140 le16_t exfat_calc_checksum(const struct exfat_entry_meta1* meta1,
 141                 const struct exfat_entry_meta2* meta2, const le16_t* name);
 142 le16_t exfat_calc_name_hash(const struct exfat* ef, const le16_t* name);
 143
 144 int utf16_to_utf8(char* output, const le16_t* input, size_t outsize,
 145                 size_t insize);
 146 int utf8_to_utf16(le16_t* output, const char* input, size_t outsize,
 147                 size_t insize);
 148 size_t utf16_length(const le16_t* str);
 149
 150 struct exfat_node* exfat_get_node(struct exfat_node* node);
 151 void exfat_put_node(struct exfat* ef, struct exfat_node* node);
 152 int exfat_cache_directory(struct exfat* ef, struct exfat_node* dir);
 153 void exfat_reset_cache(struct exfat* ef);
 154 void exfat_flush_node(struct exfat* ef, struct exfat_node* node);
 155 int exfat_unlink(struct exfat* ef, struct exfat_node* node);
 156 int exfat_rmdir(struct exfat* ef, struct exfat_node* node);
 157 int exfat_mknod(struct exfat* ef, const char* path);
 158 int exfat_mkdir(struct exfat* ef, const char* path);
 159 int exfat_rename(struct exfat* ef, const char* old_path, const char* new_path);
 160 void exfat_utimes(struct exfat_node* node, const struct timespec tv[2]);
 161 void exfat_update_atime(struct exfat_node* node);
 162 void exfat_update_mtime(struct exfat_node* node);
 163
 164 int exfat_mount(struct exfat* ef, const char* spec, const char* options);
 165 void exfat_unmount(struct exfat* ef);
 166
 167 #endif /* ifndef EXFAT_H_INCLUDED */