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 IS_CONTIGUOUS(node) (((node).flags & EXFAT_ATTRIB_CONTIGUOUS) != 0)
  28 #define BLOCK_SIZE(sb) (1 << (sb).block_bits)
  29 #define CLUSTER_SIZE(sb) (BLOCK_SIZE(sb) << (sb).bpc_bits)
  30 #define CLUSTER_INVALID(c) ((c) == EXFAT_CLUSTER_BAD || (c) == EXFAT_CLUSTER_END)
  31
  32 #define MIN(a, b) ((a) < (b) ? (a) : (b))
  33
  34 struct exfat_node
  35 {
  36         struct exfat_node* child;
  37         struct exfat_node* next;
  38         struct exfat_node* prev;
  39
  40         int references;
  41         cluster_t start_cluster;
  42         int flags;
  43         uint64_t size;
  44         time_t mtime, atime;
  45         le16_t name[EXFAT_NAME_MAX + 1];
  46 };
  47
  48 struct exfat
  49 {
  50         struct exfat_super_block* sb;
  51         int fd;
  52         le16_t* upcase;
  53         size_t upcase_chars;
  54         struct exfat_node* root;
  55 };
  56
  57 /* in-core nodes iterator */
  58 struct exfat_iterator
  59 {
  60         struct exfat_node* parent;
  61         struct exfat_node* current;
  62 };
  63
  64 extern int exfat_errors;
  65
  66 void exfat_bug(const char* format, ...);
  67 void exfat_error(const char* format, ...);
  68 void exfat_warn(const char* format, ...);
  69 void exfat_debug(const char* format, ...);
  70
  71 void exfat_read_raw(void* buffer, size_t size, off_t offset, int fd);
  72 ssize_t exfat_read(const struct exfat* ef, const struct exfat_node* node,
  73                 void* buffer, size_t size, off_t offset);
  74
  75 int exfat_opendir(struct exfat* ef, struct exfat_node* dir,
  76                 struct exfat_iterator* it);
  77 void exfat_closedir(struct exfat_iterator* it);
  78 struct exfat_node* exfat_readdir(struct exfat* ef, struct exfat_iterator* it);
  79 int exfat_lookup(struct exfat* ef, struct exfat_node** node,
  80                 const char* path);
  81
  82 off_t exfat_c2o(const struct exfat* ef, cluster_t cluster);
  83 cluster_t exfat_next_cluster(const struct exfat* ef,
  84                 const struct exfat_node* node, cluster_t cluster);
  85 cluster_t exfat_advance_cluster(const struct exfat* ef,
  86                 const struct exfat_node* node, cluster_t cluster, uint32_t count);
  87
  88 void exfat_stat(const struct exfat_node* node, struct stat *stbuf);
  89 time_t exfat_exfat2unix(le16_t date, le16_t time);
  90 void exfat_unix2exfat(time_t unix_time, le16_t* date, le16_t* time);
  91 void exfat_get_name(const struct exfat_node* node, char* buffer, size_t n);
  92 uint16_t exfat_start_checksum(const struct exfat_file* entry);
  93 uint16_t exfat_add_checksum(const void* entry, uint16_t sum);
  94
  95 int utf16_to_utf8(char* output, const le16_t* input, size_t outsize,
  96                 size_t insize);
  97 int utf8_to_utf16(le16_t* output, const char* input, size_t outsize,
  98                 size_t insize);
  99
 100 struct exfat_node* exfat_get_node(struct exfat_node* node);
 101 void exfat_put_node(struct exfat_node* node);
 102 int exfat_cache_directory(struct exfat* ef, struct exfat_node* dir);
 103 void exfat_reset_cache(struct exfat* ef);
 104
 105 int exfat_mount(struct exfat* ef, const char* spec);
 106 void exfat_unmount(struct exfat* ef);
 107
 108 #endif /* ifndef EXFAT_H_INCLUDED */