X-Git-Url: https://git.sven.stormbind.net/?p=sven%2Fexfat-utils.git;a=blobdiff_plain;f=libexfat%2Fexfat.h;h=2342be4f531a5b0c489e81ee0710186b6a00dab2;hp=bca0d240f5496ee6baffa13e9be1e13100909cbc;hb=b389db553b85947429af3c455bb324da02429abd;hpb=9799d681703e3a63dbbf876c16c9bb51b20c8fab diff --git a/libexfat/exfat.h b/libexfat/exfat.h index bca0d24..2342be4 100644 --- a/libexfat/exfat.h +++ b/libexfat/exfat.h @@ -3,11 +3,12 @@ Definitions of structures and constants used in exFAT file system implementation. - Copyright (C) 2009, 2010 Andrew Nayenko + Free exFAT implementation. + Copyright (C) 2010-2018 Andrew Nayenko - This program is free software: you can redistribute it and/or modify + This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or + the Free Software Foundation, either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, @@ -15,40 +16,60 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - You should have received a copy of the GNU General Public License - along with this program. If not, see . + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #ifndef EXFAT_H_INCLUDED #define EXFAT_H_INCLUDED +#ifndef ANDROID +/* Android.bp is used instead of autotools when targeting Android */ +#include "config.h" +#endif +#include "compiler.h" +#include "exfatfs.h" #include #include #include +#include #include #include -#include "exfatfs.h" -#include "version.h" - -#define EXFAT_NAME_MAX 256 -#define EXFAT_ATTRIB_CONTIGUOUS 0x10000 -#define EXFAT_ATTRIB_CACHED 0x20000 -#define EXFAT_ATTRIB_DIRTY 0x40000 -#define EXFAT_ATTRIB_UNLINKED 0x80000 -#define IS_CONTIGUOUS(node) (((node).flags & EXFAT_ATTRIB_CONTIGUOUS) != 0) + +#define EXFAT_NAME_MAX 255 +/* UTF-16 encodes code points up to U+FFFF as single 16-bit code units. + UTF-8 uses up to 3 bytes (i.e. 8-bit code units) to encode code points + up to U+FFFF. One additional character is for null terminator. */ +#define EXFAT_UTF8_NAME_BUFFER_MAX (EXFAT_NAME_MAX * 3 + 1) +#define EXFAT_UTF8_ENAME_BUFFER_MAX (EXFAT_ENAME_MAX * 3 + 1) + #define SECTOR_SIZE(sb) (1 << (sb).sector_bits) #define CLUSTER_SIZE(sb) (SECTOR_SIZE(sb) << (sb).spc_bits) -#define CLUSTER_INVALID(c) ((c) == EXFAT_CLUSTER_BAD || (c) == EXFAT_CLUSTER_END) +#define CLUSTER_INVALID(sb, c) ((c) < EXFAT_FIRST_DATA_CLUSTER || \ + (c) - EXFAT_FIRST_DATA_CLUSTER >= le32_to_cpu((sb).cluster_count)) #define MIN(a, b) ((a) < (b) ? (a) : (b)) +#define MAX(a, b) ((a) > (b) ? (a) : (b)) #define DIV_ROUND_UP(x, d) (((x) + (d) - 1) / (d)) +#define ROUND_UP(x, d) (DIV_ROUND_UP(x, d) * (d)) +#define BMAP_SIZE(count) (ROUND_UP(count, sizeof(bitmap_t) * 8) / 8) +#define BMAP_BLOCK(index) ((index) / sizeof(bitmap_t) / 8) +#define BMAP_MASK(index) ((bitmap_t) 1 << ((index) % (sizeof(bitmap_t) * 8))) #define BMAP_GET(bitmap, index) \ - (((uint8_t*) bitmap)[(index) / 8] & (1u << ((index) % 8))) + ((bitmap)[BMAP_BLOCK(index)] & BMAP_MASK(index)) #define BMAP_SET(bitmap, index) \ - ((uint8_t*) bitmap)[(index) / 8] |= (1u << ((index) % 8)) + ((bitmap)[BMAP_BLOCK(index)] |= BMAP_MASK(index)) #define BMAP_CLR(bitmap, index) \ - ((uint8_t*) bitmap)[(index) / 8] &= ~(1u << ((index) % 8)) + ((bitmap)[BMAP_BLOCK(index)] &= ~BMAP_MASK(index)) + +#define EXFAT_REPAIR(hook, ef, ...) \ + (exfat_ask_to_fix(ef) && exfat_fix_ ## hook(ef, __VA_ARGS__)) + +/* The size of off_t type must be 64 bits. File systems larger than 2 GB will + be corrupted with 32-bit off_t. */ +STATIC_ASSERT(sizeof(off_t) == 8); struct exfat_node { @@ -60,42 +81,51 @@ struct exfat_node int references; uint32_t fptr_index; cluster_t fptr_cluster; - cluster_t entry_cluster; off_t entry_offset; cluster_t start_cluster; - int flags; + uint16_t attrib; + uint8_t continuations; + bool is_contiguous : 1; + bool is_cached : 1; + bool is_dirty : 1; + bool is_unlinked : 1; uint64_t size; time_t mtime, atime; le16_t name[EXFAT_NAME_MAX + 1]; }; +enum exfat_mode +{ + EXFAT_MODE_RO, + EXFAT_MODE_RW, + EXFAT_MODE_ANY, +}; + struct exfat_dev; struct exfat { struct exfat_dev* dev; struct exfat_super_block* sb; - le16_t* upcase; - size_t upcase_chars; + uint16_t* upcase; struct exfat_node* root; struct { cluster_t start_cluster; uint32_t size; /* in bits */ - uint8_t* chunk; + bitmap_t* chunk; uint32_t chunk_size; /* in bits */ - int dirty; + bool dirty; } cmap; - char label[EXFAT_ENAME_MAX * 6 + 1]; /* a character can occupy up to - 6 bytes in UTF-8 */ + char label[EXFAT_UTF8_ENAME_BUFFER_MAX]; void* zero_cluster; int dmask, fmask; uid_t uid; gid_t gid; int ro; - int ro_fallback; - int noatime; + bool noatime; + enum { EXFAT_REPAIR_NO, EXFAT_REPAIR_ASK, EXFAT_REPAIR_YES } repair; }; /* in-core nodes iterator */ @@ -112,25 +142,24 @@ struct exfat_human_bytes }; extern int exfat_errors; +extern int exfat_errors_fixed; -void exfat_bug(const char* format, ...) - __attribute__((format(printf, 1, 2), noreturn)); -void exfat_error(const char* format, ...) - __attribute__((format(printf, 1, 2))); -void exfat_warn(const char* format, ...) - __attribute__((format(printf, 1, 2))); -void exfat_debug(const char* format, ...) - __attribute__((format(printf, 1, 2))); +void exfat_bug(const char* format, ...) PRINTF NORETURN; +void exfat_error(const char* format, ...) PRINTF; +void exfat_warn(const char* format, ...) PRINTF; +void exfat_debug(const char* format, ...) PRINTF; -struct exfat_dev* exfat_open(const char* spec, int ro); +struct exfat_dev* exfat_open(const char* spec, enum exfat_mode mode); int exfat_close(struct exfat_dev* dev); int exfat_fsync(struct exfat_dev* dev); +enum exfat_mode exfat_get_mode(const struct exfat_dev* dev); +off_t exfat_get_size(const struct exfat_dev* dev); off_t exfat_seek(struct exfat_dev* dev, off_t offset, int whence); ssize_t exfat_read(struct exfat_dev* dev, void* buffer, size_t size); ssize_t exfat_write(struct exfat_dev* dev, const void* buffer, size_t size); -void exfat_pread(struct exfat_dev* dev, void* buffer, size_t size, +ssize_t exfat_pread(struct exfat_dev* dev, void* buffer, size_t size, off_t offset); -void exfat_pwrite(struct exfat_dev* dev, const void* buffer, size_t size, +ssize_t exfat_pwrite(struct exfat_dev* dev, const void* buffer, size_t size, off_t offset); ssize_t exfat_generic_pread(const struct exfat* ef, struct exfat_node* node, void* buffer, size_t size, off_t offset); @@ -140,7 +169,7 @@ ssize_t exfat_generic_pwrite(struct exfat* ef, struct exfat_node* node, int exfat_opendir(struct exfat* ef, struct exfat_node* dir, struct exfat_iterator* it); void exfat_closedir(struct exfat* ef, struct exfat_iterator* it); -struct exfat_node* exfat_readdir(struct exfat* ef, struct exfat_iterator* it); +struct exfat_node* exfat_readdir(struct exfat_iterator* it); int exfat_lookup(struct exfat* ef, struct exfat_node** node, const char* path); int exfat_split(struct exfat* ef, struct exfat_node** parent, @@ -151,21 +180,24 @@ cluster_t exfat_next_cluster(const struct exfat* ef, const struct exfat_node* node, cluster_t cluster); cluster_t exfat_advance_cluster(const struct exfat* ef, struct exfat_node* node, uint32_t count); -void exfat_flush_cmap(struct exfat* ef); -int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size); +int exfat_flush_nodes(struct exfat* ef); +int exfat_flush(struct exfat* ef); +int exfat_truncate(struct exfat* ef, struct exfat_node* node, uint64_t size, + bool erase); uint32_t exfat_count_free_clusters(const struct exfat* ef); int exfat_find_used_sectors(const struct exfat* ef, off_t* a, off_t* b); void exfat_stat(const struct exfat* ef, const struct exfat_node* node, struct stat* stbuf); -void exfat_get_name(const struct exfat_node* node, char* buffer, size_t n); +void exfat_get_name(const struct exfat_node* node, + char buffer[EXFAT_UTF8_NAME_BUFFER_MAX]); uint16_t exfat_start_checksum(const struct exfat_entry_meta1* entry); uint16_t exfat_add_checksum(const void* entry, uint16_t sum); -le16_t exfat_calc_checksum(const struct exfat_entry_meta1* meta1, - const struct exfat_entry_meta2* meta2, const le16_t* name); +le16_t exfat_calc_checksum(const struct exfat_entry* entries, int n); uint32_t exfat_vbr_start_checksum(const void* sector, size_t size); uint32_t exfat_vbr_add_checksum(const void* sector, size_t size, uint32_t sum); -le16_t exfat_calc_name_hash(const struct exfat* ef, const le16_t* name); +le16_t exfat_calc_name_hash(const struct exfat* ef, const le16_t* name, + size_t length); void exfat_humanize_bytes(uint64_t value, struct exfat_human_bytes* hb); void exfat_print_info(const struct exfat_super_block* sb, uint32_t free_clusters); @@ -178,9 +210,10 @@ size_t utf16_length(const le16_t* str); struct exfat_node* exfat_get_node(struct exfat_node* node); void exfat_put_node(struct exfat* ef, struct exfat_node* node); +int exfat_cleanup_node(struct exfat* ef, struct exfat_node* node); int exfat_cache_directory(struct exfat* ef, struct exfat_node* dir); void exfat_reset_cache(struct exfat* ef); -void exfat_flush_node(struct exfat* ef, struct exfat_node* node); +int exfat_flush_node(struct exfat* ef, struct exfat_node* node); int exfat_unlink(struct exfat* ef, struct exfat_node* node); int exfat_rmdir(struct exfat* ef, struct exfat_node* node); int exfat_mknod(struct exfat* ef, const char* path); @@ -200,4 +233,12 @@ void exfat_unix2exfat(time_t unix_time, le16_t* date, le16_t* time, uint8_t* centisec); void exfat_tzset(void); +bool exfat_ask_to_fix(const struct exfat* ef); +bool exfat_fix_invalid_vbr_checksum(const struct exfat* ef, void* sector, + uint32_t vbr_checksum); +bool exfat_fix_invalid_node_checksum(const struct exfat* ef, + struct exfat_node* node); +bool exfat_fix_unknown_entry(struct exfat* ef, struct exfat_node* dir, + const struct exfat_entry* entry, off_t offset); + #endif /* ifndef EXFAT_H_INCLUDED */