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