libexfat/exfat.h

   1 /*
   2  *  exfat.h
   3  *  Definitions of structures and constants used in exFAT file system
   4  *  implementation.
   5  *
   6  *  Created by Andrew Nayenko on 29.08.09.
   7  *  This software is distributed under the GNU General Public License
   8  *  version 3 or any later.
   9  */
  10
  11 #ifndef EXFAT_H_INCLUDED
  12 #define EXFAT_H_INCLUDED
  13
  14 #include <stdio.h>
  15 #include <stdlib.h>
  16 #include <time.h>
  17 #include <sys/stat.h>
  18 #include <sys/types.h>
  19 #include "exfatfs.h"
  20
  21 #define EXFAT_VERSION_MAJOR 0
  22 #define EXFAT_VERSION_MINOR 5
  23
  24 #define EXFAT_NAME_MAX 256
  25 #define EXFAT_ATTRIB_CONTIGUOUS 0x10000
  26 #define EXFAT_ATTRIB_CACHED     0x20000
  27 #define EXFAT_ATTRIB_DIRTY      0x40000
  28 #define EXFAT_ATTRIB_UNLINKED   0x80000
  29 #define IS_CONTIGUOUS(node) (((node).flags & EXFAT_ATTRIB_CONTIGUOUS) != 0)
  30 #define BLOCK_SIZE(sb) (1 << (sb).block_bits)
  31 #define CLUSTER_SIZE(sb) (BLOCK_SIZE(sb) << (sb).bpc_bits)
  32 #define CLUSTER_INVALID(c) ((c) == EXFAT_CLUSTER_BAD || (c) == EXFAT_CLUSTER_END)
  33
  34 #define MIN(a, b) ((a) < (b) ? (a) : (b))
  35
  36 struct exfat_node
  37 {
  38         struct exfat_node* parent;
  39         struct exfat_node* child;
  40         struct exfat_node* next;
  41         struct exfat_node* prev;
  42
  43         int references;
  44         uint32_t fptr_index;
  45         cluster_t fptr_cluster;
  46         cluster_t entry_cluster;
  47         off_t entry_offset;
  48         cluster_t start_cluster;
  49         int flags;
  50         uint64_t size;
  51         time_t mtime, atime;
  52         le16_t name[EXFAT_NAME_MAX + 1];
  53 };
  54
  55 struct exfat
  56 {
  57         struct exfat_super_block* sb;
  58         int fd;
  59         le16_t* upcase;
  60         size_t upcase_chars;
  61         struct exfat_node* root;
  62         struct
  63         {
  64                 cluster_t start_cluster;
  65                 uint32_t size;                          /* in bits */
  66                 uint8_t* chunk;
  67                 uint32_t chunk_size;            /* in bits */
  68                 int dirty;
  69         }
  70         cmap;
  71         void* zero_block;
  72 };
  73
  74 /* in-core nodes iterator */
  75 struct exfat_iterator
  76 {
  77         struct exfat_node* parent;
  78         struct exfat_node* current;
  79 };
  80
  81 extern int exfat_errors;
  82
  83 void exfat_bug(const char* format, ...);
  84 void exfat_error(const char* format, ...);
  85 void exfat_warn(const char* format, ...);
  86 void exfat_debug(const char* format, ...);
  87
  88 void exfat_read_raw(void* buffer, size_t size, off_t offset, int fd);
  89 void exfat_write_raw(const void* buffer, size_t size, off_t offset, int fd);
  90 ssize_t exfat_read(const struct exfat* ef, struct exfat_node* node,
  91                 void* buffer, size_t size, off_t offset);
  92 ssize_t exfat_write(struct exfat* ef, struct exfat_node* node,
  93                 const void* buffer, size_t size, off_t offset);
  94
  95 int exfat_opendir(struct exfat* ef, struct exfat_node* dir,
  96                 struct exfat_iterator* it);
  97 void exfat_closedir(struct exfat* ef, struct exfat_iterator* it);
  98 struct exfat_node* exfat_readdir(struct exfat* ef, struct exfat_iterator* it);
  99 int exfat_lookup(struct exfat* ef, struct exfat_node** node,
 100                 const char* path);
 101
 102 off_t exfat_c2o(const struct exfat* ef, cluster_t cluster);
 103 cluster_t exfat_next_cluster(const struct exfat* ef,
 104                 const struct exfat_node* node, cluster_t cluster);
 105 cluster_t exfat_advance_cluster(const struct exfat* ef,
 106                 struct exfat_node* node, uint32_t count);
 107 void exfat_flush_cmap(struct exfat* ef);
 108 int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size);
 109
 110 void exfat_stat(const struct exfat_node* node, struct stat *stbuf);
 111 time_t exfat_exfat2unix(le16_t date, le16_t time);
 112 void exfat_unix2exfat(time_t unix_time, le16_t* date, le16_t* time);
 113 void exfat_get_name(const struct exfat_node* node, char* buffer, size_t n);
 114 uint16_t exfat_start_checksum(const struct exfat_file* entry);
 115 uint16_t exfat_add_checksum(const void* entry, uint16_t sum);
 116
 117 int utf16_to_utf8(char* output, const le16_t* input, size_t outsize,
 118                 size_t insize);
 119 int utf8_to_utf16(le16_t* output, const char* input, size_t outsize,
 120                 size_t insize);
 121 size_t utf16_length(const le16_t* str);
 122
 123 struct exfat_node* exfat_get_node(struct exfat_node* node);
 124 void exfat_put_node(struct exfat* ef, struct exfat_node* node);
 125 int exfat_cache_directory(struct exfat* ef, struct exfat_node* dir);
 126 void exfat_reset_cache(struct exfat* ef);
 127 void exfat_flush_node(struct exfat* ef, struct exfat_node* node);
 128 int exfat_unlink(struct exfat* ef, struct exfat_node* node);
 129 int exfat_rmdir(struct exfat* ef, struct exfat_node* node);
 130
 131 int exfat_mount(struct exfat* ef, const char* spec);
 132 void exfat_unmount(struct exfat* ef);
 133
 134 #endif /* ifndef EXFAT_H_INCLUDED */