[linux-block.git] / fs / exfat / exfat_fs.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Copyright (C) 2012-2013 Samsung Electronics Co., Ltd.
 */

#ifndef _EXFAT_FS_H
#define _EXFAT_FS_H

#include <linux/fs.h>
#include <linux/ratelimit.h>
#include <linux/nls.h>

#define EXFAT_SUPER_MAGIC       0x2011BAB0UL
#define EXFAT_ROOT_INO		1

#define EXFAT_CLUSTERS_UNTRACKED (~0u)

/*
 * exfat error flags
 */
enum exfat_error_mode {
	EXFAT_ERRORS_CONT,	/* ignore error and continue */
	EXFAT_ERRORS_PANIC,	/* panic on error */
	EXFAT_ERRORS_RO,	/* remount r/o on error */
};

/*
 * exfat nls lossy flag
 */
enum {
	NLS_NAME_NO_LOSSY,	/* no lossy */
	NLS_NAME_LOSSY,		/* just detected incorrect filename(s) */
	NLS_NAME_OVERLEN,	/* the length is over than its limit */
};

#define EXFAT_HASH_BITS		8
#define EXFAT_HASH_SIZE		(1UL << EXFAT_HASH_BITS)

/*
 * Type Definitions
 */
#define ES_2_ENTRIES		2
#define ES_ALL_ENTRIES		0

#define DIR_DELETED		0xFFFF0321

/* type values */
#define TYPE_UNUSED		0x0000
#define TYPE_DELETED		0x0001
#define TYPE_INVALID		0x0002
#define TYPE_CRITICAL_PRI	0x0100
#define TYPE_BITMAP		0x0101
#define TYPE_UPCASE		0x0102
#define TYPE_VOLUME		0x0103
#define TYPE_DIR		0x0104
#define TYPE_FILE		0x011F
#define TYPE_CRITICAL_SEC	0x0200
#define TYPE_STREAM		0x0201
#define TYPE_EXTEND		0x0202
#define TYPE_ACL		0x0203
#define TYPE_BENIGN_PRI		0x0400
#define TYPE_GUID		0x0401
#define TYPE_PADDING		0x0402
#define TYPE_ACLTAB		0x0403
#define TYPE_BENIGN_SEC		0x0800
#define TYPE_ALL		0x0FFF

#define MAX_CHARSET_SIZE	6 /* max size of multi-byte character */
#define MAX_NAME_LENGTH		255 /* max len of file name excluding NULL */
#define MAX_VFSNAME_BUF_SIZE	((MAX_NAME_LENGTH + 1) * MAX_CHARSET_SIZE)

/* Enough size to hold 256 dentry (even 512 Byte sector) */
#define DIR_CACHE_SIZE		(256*sizeof(struct exfat_dentry)/512+1)

#define EXFAT_HINT_NONE		-1
#define EXFAT_MIN_SUBDIR	2

/*
 * helpers for cluster size to byte conversion.
 */
#define EXFAT_CLU_TO_B(b, sbi)		((b) << (sbi)->cluster_size_bits)
#define EXFAT_B_TO_CLU(b, sbi)		((b) >> (sbi)->cluster_size_bits)
#define EXFAT_B_TO_CLU_ROUND_UP(b, sbi)	\
	(((b - 1) >> (sbi)->cluster_size_bits) + 1)
#define EXFAT_CLU_OFFSET(off, sbi)	((off) & ((sbi)->cluster_size - 1))

/*
 * helpers for block size to byte conversion.
 */
#define EXFAT_BLK_TO_B(b, sb)		((b) << (sb)->s_blocksize_bits)
#define EXFAT_B_TO_BLK(b, sb)		((b) >> (sb)->s_blocksize_bits)
#define EXFAT_B_TO_BLK_ROUND_UP(b, sb)	\
	(((b - 1) >> (sb)->s_blocksize_bits) + 1)
#define EXFAT_BLK_OFFSET(off, sb)	((off) & ((sb)->s_blocksize - 1))

/*
 * helpers for block size to dentry size conversion.
 */
#define EXFAT_B_TO_DEN_IDX(b, sbi)	\
	((b) << ((sbi)->cluster_size_bits - DENTRY_SIZE_BITS))
#define EXFAT_B_TO_DEN(b)		((b) >> DENTRY_SIZE_BITS)
#define EXFAT_DEN_TO_B(b)		((b) << DENTRY_SIZE_BITS)

/*
 * helpers for fat entry.
 */
#define FAT_ENT_SIZE (4)
#define FAT_ENT_SIZE_BITS (2)
#define FAT_ENT_OFFSET_SECTOR(sb, loc) (EXFAT_SB(sb)->FAT1_start_sector + \
	(((u64)loc << FAT_ENT_SIZE_BITS) >> sb->s_blocksize_bits))
#define FAT_ENT_OFFSET_BYTE_IN_SECTOR(sb, loc)	\
	((loc << FAT_ENT_SIZE_BITS) & (sb->s_blocksize - 1))

/*
 * helpers for bitmap.
 */
#define CLUSTER_TO_BITMAP_ENT(clu) ((clu) - EXFAT_RESERVED_CLUSTERS)
#define BITMAP_ENT_TO_CLUSTER(ent) ((ent) + EXFAT_RESERVED_CLUSTERS)
#define BITS_PER_SECTOR(sb) ((sb)->s_blocksize * BITS_PER_BYTE)
#define BITS_PER_SECTOR_MASK(sb) (BITS_PER_SECTOR(sb) - 1)
#define BITMAP_OFFSET_SECTOR_INDEX(sb, ent) \
	((ent / BITS_PER_BYTE) >> (sb)->s_blocksize_bits)
#define BITMAP_OFFSET_BIT_IN_SECTOR(sb, ent) (ent & BITS_PER_SECTOR_MASK(sb))
#define BITMAP_OFFSET_BYTE_IN_SECTOR(sb, ent) \
	((ent / BITS_PER_BYTE) & ((sb)->s_blocksize - 1))
#define BITS_PER_BYTE_MASK	0x7
#define IGNORED_BITS_REMAINED(clu, clu_base) ((1 << ((clu) - (clu_base))) - 1)

struct exfat_dentry_namebuf {
	char *lfn;
	int lfnbuf_len; /* usally MAX_UNINAME_BUF_SIZE */
};

/* unicode name structure */
struct exfat_uni_name {
	/* +3 for null and for converting */
	unsigned short name[MAX_NAME_LENGTH + 3];
	u16 name_hash;
	unsigned char name_len;
};

/* directory structure */
struct exfat_chain {
	unsigned int dir;
	unsigned int size;
	unsigned char flags;
};

/* first empty entry hint information */
struct exfat_hint_femp {
	/* entry index of a directory */
	int eidx;
	/* count of continuous empty entry */
	int count;
	/* the cluster that first empty slot exists in */
	struct exfat_chain cur;
};

/* hint structure */
struct exfat_hint {
	unsigned int clu;
	union {
		unsigned int off; /* cluster offset */
		int eidx; /* entry index */
	};
};

struct exfat_entry_set_cache {
	struct super_block *sb;
	bool modified;
	unsigned int start_off;
	int num_bh;
	struct buffer_head *bh[DIR_CACHE_SIZE];
	unsigned int num_entries;
};

struct exfat_dir_entry {
	struct exfat_chain dir;
	int entry;
	unsigned int type;
	unsigned int start_clu;
	unsigned char flags;
	unsigned short attr;
	loff_t size;
	unsigned int num_subdirs;
	struct timespec64 atime;
	struct timespec64 mtime;
	struct timespec64 crtime;
	struct exfat_dentry_namebuf namebuf;
};

/*
 * exfat mount in-memory data
 */
struct exfat_mount_options {
	kuid_t fs_uid;
	kgid_t fs_gid;
	unsigned short fs_fmask;
	unsigned short fs_dmask;
	/* permission for setting the [am]time */
	unsigned short allow_utime;
	/* charset for filename input/display */
	char *iocharset;
	/* on error: continue, panic, remount-ro */
	enum exfat_error_mode errors;
	unsigned utf8:1, /* Use of UTF-8 character set */
		 discard:1; /* Issue discard requests on deletions */
	int time_offset; /* Offset of timestamps from UTC (in minutes) */
};

/*
 * EXFAT file system superblock in-memory data
 */
struct exfat_sb_info {
	unsigned long long num_sectors; /* num of sectors in volume */
	unsigned int num_clusters; /* num of clusters in volume */
	unsigned int cluster_size; /* cluster size in bytes */
	unsigned int cluster_size_bits;
	unsigned int sect_per_clus; /* cluster size in sectors */
	unsigned int sect_per_clus_bits;
	unsigned long long FAT1_start_sector; /* FAT1 start sector */
	unsigned long long FAT2_start_sector; /* FAT2 start sector */
	unsigned long long data_start_sector; /* data area start sector */
	unsigned int num_FAT_sectors; /* num of FAT sectors */
	unsigned int root_dir; /* root dir cluster */
	unsigned int dentries_per_clu; /* num of dentries per cluster */
	unsigned int vol_flags; /* volume flags */
	unsigned int vol_flags_persistent; /* volume flags to retain */
	struct buffer_head *boot_bh; /* buffer_head of BOOT sector */

	unsigned int map_clu; /* allocation bitmap start cluster */
	unsigned int map_sectors; /* num of allocation bitmap sectors */
	struct buffer_head **vol_amap; /* allocation bitmap */

	unsigned short *vol_utbl; /* upcase table */

	unsigned int clu_srch_ptr; /* cluster search pointer */
	unsigned int used_clusters; /* number of used clusters */

	struct mutex s_lock; /* superblock lock */
	struct exfat_mount_options options;
	struct nls_table *nls_io; /* Charset used for input and display */
	struct ratelimit_state ratelimit;

	spinlock_t inode_hash_lock;
	struct hlist_head inode_hashtable[EXFAT_HASH_SIZE];

	struct rcu_head rcu;
};

#define EXFAT_CACHE_VALID	0

/*
 * EXFAT file system inode in-memory data
 */
struct exfat_inode_info {
	struct exfat_chain dir;
	int entry;
	unsigned int type;
	unsigned short attr;
	unsigned int start_clu;
	unsigned char flags;
	/*
	 * the copy of low 32bit of i_version to check
	 * the validation of hint_stat.
	 */
	unsigned int version;
	/* file offset or dentry index for readdir */
	loff_t rwoffset;

	/* hint for cluster last accessed */
	struct exfat_hint hint_bmap;
	/* hint for entry index we try to lookup next time */
	struct exfat_hint hint_stat;
	/* hint for first empty entry */
	struct exfat_hint_femp hint_femp;

	spinlock_t cache_lru_lock;
	struct list_head cache_lru;
	int nr_caches;
	/* for avoiding the race between alloc and free */
	unsigned int cache_valid_id;

	/*
	 * NOTE: i_size_ondisk is 64bits, so must hold ->inode_lock to access.
	 * physically allocated size.
	 */
	loff_t i_size_ondisk;
	/* block-aligned i_size (used in cont_write_begin) */
	loff_t i_size_aligned;
	/* on-disk position of directory entry or 0 */
	loff_t i_pos;
	/* hash by i_location */
	struct hlist_node i_hash_fat;
	/* protect bmap against truncate */
	struct rw_semaphore truncate_lock;
	struct inode vfs_inode;
	/* File creation time */
	struct timespec64 i_crtime;
};

static inline struct exfat_sb_info *EXFAT_SB(struct super_block *sb)
{
	return sb->s_fs_info;
}

static inline struct exfat_inode_info *EXFAT_I(struct inode *inode)
{
	return container_of(inode, struct exfat_inode_info, vfs_inode);
}

/*
 * If ->i_mode can't hold 0222 (i.e. ATTR_RO), we use ->i_attrs to
 * save ATTR_RO instead of ->i_mode.
 *
 * If it's directory and !sbi->options.rodir, ATTR_RO isn't read-only
 * bit, it's just used as flag for app.
 */
static inline int exfat_mode_can_hold_ro(struct inode *inode)
{
	struct exfat_sb_info *sbi = EXFAT_SB(inode->i_sb);

	if (S_ISDIR(inode->i_mode))
		return 0;

	if ((~sbi->options.fs_fmask) & 0222)
		return 1;
	return 0;
}

/* Convert attribute bits and a mask to the UNIX mode. */
static inline mode_t exfat_make_mode(struct exfat_sb_info *sbi,
		unsigned short attr, mode_t mode)
{
	if ((attr & ATTR_READONLY) && !(attr & ATTR_SUBDIR))
		mode &= ~0222;

	if (attr & ATTR_SUBDIR)
		return (mode & ~sbi->options.fs_dmask) | S_IFDIR;

	return (mode & ~sbi->options.fs_fmask) | S_IFREG;
}

/* Return the FAT attribute byte for this inode */
static inline unsigned short exfat_make_attr(struct inode *inode)
{
	unsigned short attr = EXFAT_I(inode)->attr;

	if (S_ISDIR(inode->i_mode))
		attr |= ATTR_SUBDIR;
	if (exfat_mode_can_hold_ro(inode) && !(inode->i_mode & 0222))
		attr |= ATTR_READONLY;
	return attr;
}

static inline void exfat_save_attr(struct inode *inode, unsigned short attr)
{
	if (exfat_mode_can_hold_ro(inode))
		EXFAT_I(inode)->attr = attr & (ATTR_RWMASK | ATTR_READONLY);
	else
		EXFAT_I(inode)->attr = attr & ATTR_RWMASK;
}

static inline bool exfat_is_last_sector_in_cluster(struct exfat_sb_info *sbi,
		sector_t sec)
{
	return ((sec - sbi->data_start_sector + 1) &
		((1 << sbi->sect_per_clus_bits) - 1)) == 0;
}

static inline sector_t exfat_cluster_to_sector(struct exfat_sb_info *sbi,
		unsigned int clus)
{
	return ((sector_t)(clus - EXFAT_RESERVED_CLUSTERS) << sbi->sect_per_clus_bits) +
		sbi->data_start_sector;
}

static inline int exfat_sector_to_cluster(struct exfat_sb_info *sbi,
		sector_t sec)
{
	return ((sec - sbi->data_start_sector) >> sbi->sect_per_clus_bits) +
		EXFAT_RESERVED_CLUSTERS;
}

/* super.c */
int exfat_set_volume_dirty(struct super_block *sb);
int exfat_clear_volume_dirty(struct super_block *sb);

/* fatent.c */
#define exfat_get_next_cluster(sb, pclu) exfat_ent_get(sb, *(pclu), pclu)

int exfat_alloc_cluster(struct inode *inode, unsigned int num_alloc,
		struct exfat_chain *p_chain);
int exfat_free_cluster(struct inode *inode, struct exfat_chain *p_chain);
int exfat_ent_get(struct super_block *sb, unsigned int loc,
		unsigned int *content);
int exfat_ent_set(struct super_block *sb, unsigned int loc,
		unsigned int content);
int exfat_count_ext_entries(struct super_block *sb, struct exfat_chain *p_dir,
		int entry, struct exfat_dentry *p_entry);
int exfat_chain_cont_cluster(struct super_block *sb, unsigned int chain,
		unsigned int len);
int exfat_zeroed_cluster(struct inode *dir, unsigned int clu);
int exfat_find_last_cluster(struct super_block *sb, struct exfat_chain *p_chain,
		unsigned int *ret_clu);
int exfat_count_num_clusters(struct super_block *sb,
		struct exfat_chain *p_chain, unsigned int *ret_count);

/* balloc.c */
int exfat_load_bitmap(struct super_block *sb);
void exfat_free_bitmap(struct exfat_sb_info *sbi);
int exfat_set_bitmap(struct inode *inode, unsigned int clu);
void exfat_clear_bitmap(struct inode *inode, unsigned int clu);
unsigned int exfat_find_free_bitmap(struct super_block *sb, unsigned int clu);
int exfat_count_used_clusters(struct super_block *sb, unsigned int *ret_count);

/* file.c */
extern const struct file_operations exfat_file_operations;
int __exfat_truncate(struct inode *inode, loff_t new_size);
void exfat_truncate(struct inode *inode, loff_t size);
int exfat_setattr(struct dentry *dentry, struct iattr *attr);
int exfat_getattr(const struct path *path, struct kstat *stat,
		unsigned int request_mask, unsigned int query_flags);
int exfat_file_fsync(struct file *file, loff_t start, loff_t end, int datasync);

/* namei.c */
extern const struct dentry_operations exfat_dentry_ops;
extern const struct dentry_operations exfat_utf8_dentry_ops;

/* cache.c */
int exfat_cache_init(void);
void exfat_cache_shutdown(void);
void exfat_cache_inval_inode(struct inode *inode);
int exfat_get_cluster(struct inode *inode, unsigned int cluster,
		unsigned int *fclus, unsigned int *dclus,
		unsigned int *last_dclus, int allow_eof);

/* dir.c */
extern const struct inode_operations exfat_dir_inode_operations;
extern const struct file_operations exfat_dir_operations;
unsigned int exfat_get_entry_type(struct exfat_dentry *p_entry);
int exfat_init_dir_entry(struct inode *inode, struct exfat_chain *p_dir,
		int entry, unsigned int type, unsigned int start_clu,
		unsigned long long size);
int exfat_init_ext_entry(struct inode *inode, struct exfat_chain *p_dir,
		int entry, int num_entries, struct exfat_uni_name *p_uniname);
int exfat_remove_entries(struct inode *inode, struct exfat_chain *p_dir,
		int entry, int order, int num_entries);
int exfat_update_dir_chksum(struct inode *inode, struct exfat_chain *p_dir,
		int entry);
void exfat_update_dir_chksum_with_entry_set(struct exfat_entry_set_cache *es);
int exfat_calc_num_entries(struct exfat_uni_name *p_uniname);
int exfat_find_dir_entry(struct super_block *sb, struct exfat_inode_info *ei,
		struct exfat_chain *p_dir, struct exfat_uni_name *p_uniname,
		int num_entries, unsigned int type);
int exfat_alloc_new_dir(struct inode *inode, struct exfat_chain *clu);
int exfat_find_location(struct super_block *sb, struct exfat_chain *p_dir,
		int entry, sector_t *sector, int *offset);
struct exfat_dentry *exfat_get_dentry(struct super_block *sb,
		struct exfat_chain *p_dir, int entry, struct buffer_head **bh,
		sector_t *sector);
struct exfat_dentry *exfat_get_dentry_cached(struct exfat_entry_set_cache *es,
		int num);
struct exfat_entry_set_cache *exfat_get_dentry_set(struct super_block *sb,
		struct exfat_chain *p_dir, int entry, unsigned int type);
int exfat_free_dentry_set(struct exfat_entry_set_cache *es, int sync);
int exfat_count_dir_entries(struct super_block *sb, struct exfat_chain *p_dir);

/* inode.c */
extern const struct inode_operations exfat_file_inode_operations;
void exfat_sync_inode(struct inode *inode);
struct inode *exfat_build_inode(struct super_block *sb,
		struct exfat_dir_entry *info, loff_t i_pos);
void exfat_hash_inode(struct inode *inode, loff_t i_pos);
void exfat_unhash_inode(struct inode *inode);
struct inode *exfat_iget(struct super_block *sb, loff_t i_pos);
int exfat_write_inode(struct inode *inode, struct writeback_control *wbc);
void exfat_evict_inode(struct inode *inode);
int exfat_block_truncate_page(struct inode *inode, loff_t from);

/* exfat/nls.c */
unsigned short exfat_toupper(struct super_block *sb, unsigned short a);
int exfat_uniname_ncmp(struct super_block *sb, unsigned short *a,
		unsigned short *b, unsigned int len);
int exfat_utf16_to_nls(struct super_block *sb,
		struct exfat_uni_name *uniname, unsigned char *p_cstring,
		int len);
int exfat_nls_to_utf16(struct super_block *sb,
		const unsigned char *p_cstring, const int len,
		struct exfat_uni_name *uniname, int *p_lossy);
int exfat_create_upcase_table(struct super_block *sb);
void exfat_free_upcase_table(struct exfat_sb_info *sbi);

/* exfat/misc.c */
void __exfat_fs_error(struct super_block *sb, int report, const char *fmt, ...)
		__printf(3, 4) __cold;
#define exfat_fs_error(sb, fmt, args...)          \
		__exfat_fs_error(sb, 1, fmt, ## args)
#define exfat_fs_error_ratelimit(sb, fmt, args...) \
		__exfat_fs_error(sb, __ratelimit(&EXFAT_SB(sb)->ratelimit), \
		fmt, ## args)
void exfat_msg(struct super_block *sb, const char *lv, const char *fmt, ...)
		__printf(3, 4) __cold;
#define exfat_err(sb, fmt, ...)						\
	exfat_msg(sb, KERN_ERR, fmt, ##__VA_ARGS__)
#define exfat_warn(sb, fmt, ...)					\
	exfat_msg(sb, KERN_WARNING, fmt, ##__VA_ARGS__)
#define exfat_info(sb, fmt, ...)					\
	exfat_msg(sb, KERN_INFO, fmt, ##__VA_ARGS__)

void exfat_get_entry_time(struct exfat_sb_info *sbi, struct timespec64 *ts,
		u8 tz, __le16 time, __le16 date, u8 time_cs);
void exfat_truncate_atime(struct timespec64 *ts);
void exfat_set_entry_time(struct exfat_sb_info *sbi, struct timespec64 *ts,
		u8 *tz, __le16 *time, __le16 *date, u8 *time_cs);
u16 exfat_calc_chksum16(void *data, int len, u16 chksum, int type);
u32 exfat_calc_chksum32(void *data, int len, u32 chksum, int type);
void exfat_update_bh(struct buffer_head *bh, int sync);
int exfat_update_bhs(struct buffer_head **bhs, int nr_bhs, int sync);
void exfat_chain_set(struct exfat_chain *ec, unsigned int dir,
		unsigned int size, unsigned char flags);
void exfat_chain_dup(struct exfat_chain *dup, struct exfat_chain *ec);

#endif /* !_EXFAT_FS_H */
Commit	Line	Data
1acf1a56 NJ	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
	2	/*
	3	* Copyright (C) 2012-2013 Samsung Electronics Co., Ltd.
	4	*/
	5
	6	#ifndef _EXFAT_FS_H
	7	#define _EXFAT_FS_H
	8
	9	#include <linux/fs.h>
	10	#include <linux/ratelimit.h>
	11	#include <linux/nls.h>
	12
	13	#define EXFAT_SUPER_MAGIC 0x2011BAB0UL
	14	#define EXFAT_ROOT_INO 1
	15
1acf1a56 NJ	16	#define EXFAT_CLUSTERS_UNTRACKED (~0u)
	17
	18	/*
	19	* exfat error flags
	20	*/
	21	enum exfat_error_mode {
	22	EXFAT_ERRORS_CONT, /* ignore error and continue */
	23	EXFAT_ERRORS_PANIC, /* panic on error */
	24	EXFAT_ERRORS_RO, /* remount r/o on error */
	25	};
	26
	27	/*
	28	* exfat nls lossy flag
	29	*/
	30	enum {
	31	NLS_NAME_NO_LOSSY, /* no lossy */
	32	NLS_NAME_LOSSY, /* just detected incorrect filename(s) */
	33	NLS_NAME_OVERLEN, /* the length is over than its limit */
	34	};
	35
	36	#define EXFAT_HASH_BITS 8
	37	#define EXFAT_HASH_SIZE (1UL << EXFAT_HASH_BITS)
	38
	39	/*
	40	* Type Definitions
	41	*/
	42	#define ES_2_ENTRIES 2
	43	#define ES_ALL_ENTRIES 0
	44
	45	#define DIR_DELETED 0xFFFF0321
	46
	47	/* type values */
	48	#define TYPE_UNUSED 0x0000
	49	#define TYPE_DELETED 0x0001
	50	#define TYPE_INVALID 0x0002
	51	#define TYPE_CRITICAL_PRI 0x0100
	52	#define TYPE_BITMAP 0x0101
	53	#define TYPE_UPCASE 0x0102
	54	#define TYPE_VOLUME 0x0103
	55	#define TYPE_DIR 0x0104
	56	#define TYPE_FILE 0x011F
	57	#define TYPE_CRITICAL_SEC 0x0200
	58	#define TYPE_STREAM 0x0201
	59	#define TYPE_EXTEND 0x0202
	60	#define TYPE_ACL 0x0203
	61	#define TYPE_BENIGN_PRI 0x0400
	62	#define TYPE_GUID 0x0401
	63	#define TYPE_PADDING 0x0402
	64	#define TYPE_ACLTAB 0x0403
	65	#define TYPE_BENIGN_SEC 0x0800
	66	#define TYPE_ALL 0x0FFF
	67
	68	#define MAX_CHARSET_SIZE 6 /* max size of multi-byte character */
	69	#define MAX_NAME_LENGTH 255 /* max len of file name excluding NULL */
	70	#define MAX_VFSNAME_BUF_SIZE ((MAX_NAME_LENGTH + 1) * MAX_CHARSET_SIZE)
	71
943af1fd TK	72	/* Enough size to hold 256 dentry (even 512 Byte sector) */
943af1fd TK	73	#define DIR_CACHE_SIZE (256*sizeof(struct exfat_dentry)/512+1)
1acf1a56 NJ	74
	75	#define EXFAT_HINT_NONE -1
	76	#define EXFAT_MIN_SUBDIR 2
	77
	78	/*
	79	* helpers for cluster size to byte conversion.
	80	*/
	81	#define EXFAT_CLU_TO_B(b, sbi) ((b) << (sbi)->cluster_size_bits)
	82	#define EXFAT_B_TO_CLU(b, sbi) ((b) >> (sbi)->cluster_size_bits)
	83	#define EXFAT_B_TO_CLU_ROUND_UP(b, sbi) \
	84	(((b - 1) >> (sbi)->cluster_size_bits) + 1)
	85	#define EXFAT_CLU_OFFSET(off, sbi) ((off) & ((sbi)->cluster_size - 1))
	86
	87	/*
	88	* helpers for block size to byte conversion.
	89	*/
	90	#define EXFAT_BLK_TO_B(b, sb) ((b) << (sb)->s_blocksize_bits)
	91	#define EXFAT_B_TO_BLK(b, sb) ((b) >> (sb)->s_blocksize_bits)
	92	#define EXFAT_B_TO_BLK_ROUND_UP(b, sb) \
	93	(((b - 1) >> (sb)->s_blocksize_bits) + 1)
	94	#define EXFAT_BLK_OFFSET(off, sb) ((off) & ((sb)->s_blocksize - 1))
	95
	96	/*
	97	* helpers for block size to dentry size conversion.
	98	*/
	99	#define EXFAT_B_TO_DEN_IDX(b, sbi) \
	100	((b) << ((sbi)->cluster_size_bits - DENTRY_SIZE_BITS))
	101	#define EXFAT_B_TO_DEN(b) ((b) >> DENTRY_SIZE_BITS)
	102	#define EXFAT_DEN_TO_B(b) ((b) << DENTRY_SIZE_BITS)
	103
	104	/*
	105	* helpers for fat entry.
	106	*/
	107	#define FAT_ENT_SIZE (4)
	108	#define FAT_ENT_SIZE_BITS (2)
	109	#define FAT_ENT_OFFSET_SECTOR(sb, loc) (EXFAT_SB(sb)->FAT1_start_sector + \
	110	(((u64)loc << FAT_ENT_SIZE_BITS) >> sb->s_blocksize_bits))
	111	#define FAT_ENT_OFFSET_BYTE_IN_SECTOR(sb, loc) \
	112	((loc << FAT_ENT_SIZE_BITS) & (sb->s_blocksize - 1))
	113
	114	/*
	115	* helpers for bitmap.
	116	*/
	117	#define CLUSTER_TO_BITMAP_ENT(clu) ((clu) - EXFAT_RESERVED_CLUSTERS)
	118	#define BITMAP_ENT_TO_CLUSTER(ent) ((ent) + EXFAT_RESERVED_CLUSTERS)
	119	#define BITS_PER_SECTOR(sb) ((sb)->s_blocksize * BITS_PER_BYTE)
	120	#define BITS_PER_SECTOR_MASK(sb) (BITS_PER_SECTOR(sb) - 1)
	121	#define BITMAP_OFFSET_SECTOR_INDEX(sb, ent) \
	122	((ent / BITS_PER_BYTE) >> (sb)->s_blocksize_bits)
	123	#define BITMAP_OFFSET_BIT_IN_SECTOR(sb, ent) (ent & BITS_PER_SECTOR_MASK(sb))
	124	#define BITMAP_OFFSET_BYTE_IN_SECTOR(sb, ent) \
	125	((ent / BITS_PER_BYTE) & ((sb)->s_blocksize - 1))
	126	#define BITS_PER_BYTE_MASK 0x7
	127	#define IGNORED_BITS_REMAINED(clu, clu_base) ((1 << ((clu) - (clu_base))) - 1)
	128
	129	struct exfat_dentry_namebuf {
	130	char *lfn;
	131	int lfnbuf_len; /* usally MAX_UNINAME_BUF_SIZE */
	132	};
	133
	134	/* unicode name structure */
	135	struct exfat_uni_name {
	136	/* +3 for null and for converting */
	137	unsigned short name[MAX_NAME_LENGTH + 3];
5875bf28	138	u16 name_hash;
1acf1a56 NJ	139	unsigned char name_len;
	140	};
	141
	142	/* directory structure */
	143	struct exfat_chain {
	144	unsigned int dir;
	145	unsigned int size;
	146	unsigned char flags;
	147	};
	148
	149	/* first empty entry hint information */
	150	struct exfat_hint_femp {
	151	/* entry index of a directory */
	152	int eidx;
	153	/* count of continuous empty entry */
	154	int count;
	155	/* the cluster that first empty slot exists in */
	156	struct exfat_chain cur;
	157	};
	158
	159	/* hint structure */
	160	struct exfat_hint {
	161	unsigned int clu;
	162	union {
	163	unsigned int off; /* cluster offset */
	164	int eidx; /* entry index */
	165	};
	166	};
	167
	168	struct exfat_entry_set_cache {
943af1fd TK	169	struct super_block *sb;
	170	bool modified;
	171	unsigned int start_off;
	172	int num_bh;
	173	struct buffer_head *bh[DIR_CACHE_SIZE];
1acf1a56	174	unsigned int num_entries;
1acf1a56 NJ	175	};
	176
	177	struct exfat_dir_entry {
	178	struct exfat_chain dir;
	179	int entry;
	180	unsigned int type;
	181	unsigned int start_clu;
	182	unsigned char flags;
	183	unsigned short attr;
	184	loff_t size;
	185	unsigned int num_subdirs;
	186	struct timespec64 atime;
	187	struct timespec64 mtime;
	188	struct timespec64 crtime;
	189	struct exfat_dentry_namebuf namebuf;
	190	};
	191
	192	/*
	193	* exfat mount in-memory data
	194	*/
	195	struct exfat_mount_options {
	196	kuid_t fs_uid;
	197	kgid_t fs_gid;
	198	unsigned short fs_fmask;
	199	unsigned short fs_dmask;
	200	/* permission for setting the [am]time */
	201	unsigned short allow_utime;
	202	/* charset for filename input/display */
	203	char *iocharset;
	204	/* on error: continue, panic, remount-ro */
	205	enum exfat_error_mode errors;
	206	unsigned utf8:1, /* Use of UTF-8 character set */
	207	discard:1; /* Issue discard requests on deletions */
	208	int time_offset; /* Offset of timestamps from UTC (in minutes) */
	209	};
	210
	211	/*
	212	* EXFAT file system superblock in-memory data
	213	*/
	214	struct exfat_sb_info {
	215	unsigned long long num_sectors; /* num of sectors in volume */
	216	unsigned int num_clusters; /* num of clusters in volume */
	217	unsigned int cluster_size; /* cluster size in bytes */
	218	unsigned int cluster_size_bits;
	219	unsigned int sect_per_clus; /* cluster size in sectors */
	220	unsigned int sect_per_clus_bits;
	221	unsigned long long FAT1_start_sector; /* FAT1 start sector */
	222	unsigned long long FAT2_start_sector; /* FAT2 start sector */
	223	unsigned long long data_start_sector; /* data area start sector */
	224	unsigned int num_FAT_sectors; /* num of FAT sectors */
	225	unsigned int root_dir; /* root dir cluster */
	226	unsigned int dentries_per_clu; /* num of dentries per cluster */
7018ec68 TK	227	unsigned int vol_flags; /* volume flags */
7018ec68 TK	228	unsigned int vol_flags_persistent; /* volume flags to retain */
181a9e80	229	struct buffer_head boot_bh; / buffer_head of BOOT sector */
1acf1a56 NJ	230
	231	unsigned int map_clu; /* allocation bitmap start cluster */
	232	unsigned int map_sectors; /* num of allocation bitmap sectors */
	233	struct buffer_head *vol_amap; / allocation bitmap */
	234
	235	unsigned short vol_utbl; / upcase table */
	236
	237	unsigned int clu_srch_ptr; /* cluster search pointer */
	238	unsigned int used_clusters; /* number of used clusters */
	239
1acf1a56 NJ	240	struct mutex s_lock; /* superblock lock */
	241	struct exfat_mount_options options;
	242	struct nls_table nls_io; / Charset used for input and display */
	243	struct ratelimit_state ratelimit;
	244
	245	spinlock_t inode_hash_lock;
	246	struct hlist_head inode_hashtable[EXFAT_HASH_SIZE];
	247
	248	struct rcu_head rcu;
	249	};
	250
8ff006e5 NJ	251	#define EXFAT_CACHE_VALID 0
8ff006e5 NJ	252
1acf1a56 NJ	253	/*
	254	* EXFAT file system inode in-memory data
	255	*/
	256	struct exfat_inode_info {
	257	struct exfat_chain dir;
	258	int entry;
	259	unsigned int type;
	260	unsigned short attr;
	261	unsigned int start_clu;
	262	unsigned char flags;
	263	/*
	264	* the copy of low 32bit of i_version to check
	265	* the validation of hint_stat.
	266	*/
	267	unsigned int version;
	268	/* file offset or dentry index for readdir */
	269	loff_t rwoffset;
	270
	271	/* hint for cluster last accessed */
	272	struct exfat_hint hint_bmap;
	273	/* hint for entry index we try to lookup next time */
	274	struct exfat_hint hint_stat;
	275	/* hint for first empty entry */
	276	struct exfat_hint_femp hint_femp;
	277
	278	spinlock_t cache_lru_lock;
	279	struct list_head cache_lru;
	280	int nr_caches;
	281	/* for avoiding the race between alloc and free */
	282	unsigned int cache_valid_id;
	283
	284	/*
	285	* NOTE: i_size_ondisk is 64bits, so must hold ->inode_lock to access.
	286	* physically allocated size.
	287	*/
	288	loff_t i_size_ondisk;
	289	/* block-aligned i_size (used in cont_write_begin) */
	290	loff_t i_size_aligned;
	291	/* on-disk position of directory entry or 0 */
	292	loff_t i_pos;
	293	/* hash by i_location */
	294	struct hlist_node i_hash_fat;
	295	/* protect bmap against truncate */
	296	struct rw_semaphore truncate_lock;
	297	struct inode vfs_inode;
	298	/* File creation time */
	299	struct timespec64 i_crtime;
	300	};
	301
	302	static inline struct exfat_sb_info EXFAT_SB(struct super_block sb)
	303	{
	304	return sb->s_fs_info;
	305	}
	306
	307	static inline struct exfat_inode_info EXFAT_I(struct inode inode)
	308	{
	309	return container_of(inode, struct exfat_inode_info, vfs_inode);
	310	}
	311
	312	/*
	313	* If ->i_mode can't hold 0222 (i.e. ATTR_RO), we use ->i_attrs to
	314	* save ATTR_RO instead of ->i_mode.
	315	*
	316	* If it's directory and !sbi->options.rodir, ATTR_RO isn't read-only
317	* bit, it's just used as flag for app.
318	*/
319	static inline int exfat_mode_can_hold_ro(struct inode *inode)
320	{
321	struct exfat_sb_info *sbi = EXFAT_SB(inode->i_sb);
322
323	if (S_ISDIR(inode->i_mode))
324	return 0;
325
326	if ((~sbi->options.fs_fmask) & 0222)
327	return 1;
328	return 0;
329	}
330
331	/* Convert attribute bits and a mask to the UNIX mode. */
332	static inline mode_t exfat_make_mode(struct exfat_sb_info *sbi,
333	unsigned short attr, mode_t mode)
334	{
335	if ((attr & ATTR_READONLY) && !(attr & ATTR_SUBDIR))
336	mode &= ~0222;
337
338	if (attr & ATTR_SUBDIR)
339	return (mode & ~sbi->options.fs_dmask) \| S_IFDIR;
340
341	return (mode & ~sbi->options.fs_fmask) \| S_IFREG;
342	}
343
344	/* Return the FAT attribute byte for this inode */
345	static inline unsigned short exfat_make_attr(struct inode *inode)
346	{
347	unsigned short attr = EXFAT_I(inode)->attr;
348
349	if (S_ISDIR(inode->i_mode))
350	attr \|= ATTR_SUBDIR;
351	if (exfat_mode_can_hold_ro(inode) && !(inode->i_mode & 0222))
352	attr \|= ATTR_READONLY;
353	return attr;
354	}
355
356	static inline void exfat_save_attr(struct inode *inode, unsigned short attr)
357	{
358	if (exfat_mode_can_hold_ro(inode))
359	EXFAT_I(inode)->attr = attr & (ATTR_RWMASK \| ATTR_READONLY);
360	else
361	EXFAT_I(inode)->attr = attr & ATTR_RWMASK;
362	}
363
364	static inline bool exfat_is_last_sector_in_cluster(struct exfat_sb_info *sbi,
365	sector_t sec)
366	{
367	return ((sec - sbi->data_start_sector + 1) &
368	((1 << sbi->sect_per_clus_bits) - 1)) == 0;
369	}
370
371	static inline sector_t exfat_cluster_to_sector(struct exfat_sb_info *sbi,
372	unsigned int clus)
373	{
43946b70	374	return ((sector_t)(clus - EXFAT_RESERVED_CLUSTERS) << sbi->sect_per_clus_bits) +
1acf1a56 NJ	375	sbi->data_start_sector;
	376	}
	377
	378	static inline int exfat_sector_to_cluster(struct exfat_sb_info *sbi,
	379	sector_t sec)
	380	{
	381	return ((sec - sbi->data_start_sector) >> sbi->sect_per_clus_bits) +
	382	EXFAT_RESERVED_CLUSTERS;
	383	}
	384
	385	/* super.c */
7018ec68 TK	386	int exfat_set_volume_dirty(struct super_block *sb);
7018ec68 TK	387	int exfat_clear_volume_dirty(struct super_block *sb);
1acf1a56 NJ	388
	389	/* fatent.c */
	390	#define exfat_get_next_cluster(sb, pclu) exfat_ent_get(sb, *(pclu), pclu)
	391
	392	int exfat_alloc_cluster(struct inode *inode, unsigned int num_alloc,
	393	struct exfat_chain *p_chain);
	394	int exfat_free_cluster(struct inode inode, struct exfat_chain p_chain);
	395	int exfat_ent_get(struct super_block *sb, unsigned int loc,
	396	unsigned int *content);
	397	int exfat_ent_set(struct super_block *sb, unsigned int loc,
	398	unsigned int content);
	399	int exfat_count_ext_entries(struct super_block sb, struct exfat_chain p_dir,
	400	int entry, struct exfat_dentry *p_entry);
	401	int exfat_chain_cont_cluster(struct super_block *sb, unsigned int chain,
	402	unsigned int len);
	403	int exfat_zeroed_cluster(struct inode *dir, unsigned int clu);
	404	int exfat_find_last_cluster(struct super_block sb, struct exfat_chain p_chain,
	405	unsigned int *ret_clu);
	406	int exfat_count_num_clusters(struct super_block *sb,
	407	struct exfat_chain p_chain, unsigned int ret_count);
	408
	409	/* balloc.c */
	410	int exfat_load_bitmap(struct super_block *sb);
	411	void exfat_free_bitmap(struct exfat_sb_info *sbi);
	412	int exfat_set_bitmap(struct inode *inode, unsigned int clu);
	413	void exfat_clear_bitmap(struct inode *inode, unsigned int clu);
	414	unsigned int exfat_find_free_bitmap(struct super_block *sb, unsigned int clu);
	415	int exfat_count_used_clusters(struct super_block sb, unsigned int ret_count);
	416
	417	/* file.c */
	418	extern const struct file_operations exfat_file_operations;
	419	int __exfat_truncate(struct inode *inode, loff_t new_size);
	420	void exfat_truncate(struct inode *inode, loff_t size);
	421	int exfat_setattr(struct dentry dentry, struct iattr attr);
	422	int exfat_getattr(const struct path path, struct kstat stat,
	423	unsigned int request_mask, unsigned int query_flags);
5267456e	424	int exfat_file_fsync(struct file *file, loff_t start, loff_t end, int datasync);
1acf1a56 NJ	425
	426	/* namei.c */
	427	extern const struct dentry_operations exfat_dentry_ops;
	428	extern const struct dentry_operations exfat_utf8_dentry_ops;
	429
	430	/* cache.c */
	431	int exfat_cache_init(void);
	432	void exfat_cache_shutdown(void);
1acf1a56 NJ	433	void exfat_cache_inval_inode(struct inode *inode);
	434	int exfat_get_cluster(struct inode *inode, unsigned int cluster,
	435	unsigned int fclus, unsigned int dclus,
	436	unsigned int *last_dclus, int allow_eof);
	437
	438	/* dir.c */
	439	extern const struct inode_operations exfat_dir_inode_operations;
	440	extern const struct file_operations exfat_dir_operations;
	441	unsigned int exfat_get_entry_type(struct exfat_dentry *p_entry);
	442	int exfat_init_dir_entry(struct inode inode, struct exfat_chain p_dir,
	443	int entry, unsigned int type, unsigned int start_clu,
	444	unsigned long long size);
	445	int exfat_init_ext_entry(struct inode inode, struct exfat_chain p_dir,
	446	int entry, int num_entries, struct exfat_uni_name *p_uniname);
	447	int exfat_remove_entries(struct inode inode, struct exfat_chain p_dir,
	448	int entry, int order, int num_entries);
	449	int exfat_update_dir_chksum(struct inode inode, struct exfat_chain p_dir,
	450	int entry);
943af1fd	451	void exfat_update_dir_chksum_with_entry_set(struct exfat_entry_set_cache *es);
1acf1a56 NJ	452	int exfat_calc_num_entries(struct exfat_uni_name *p_uniname);
	453	int exfat_find_dir_entry(struct super_block sb, struct exfat_inode_info ei,
	454	struct exfat_chain p_dir, struct exfat_uni_name p_uniname,
	455	int num_entries, unsigned int type);
	456	int exfat_alloc_new_dir(struct inode inode, struct exfat_chain clu);
	457	int exfat_find_location(struct super_block sb, struct exfat_chain p_dir,
	458	int entry, sector_t sector, int offset);
	459	struct exfat_dentry exfat_get_dentry(struct super_block sb,
	460	struct exfat_chain p_dir, int entry, struct buffer_head *bh,
	461	sector_t *sector);
943af1fd TK	462	struct exfat_dentry exfat_get_dentry_cached(struct exfat_entry_set_cache es,
943af1fd TK	463	int num);
1acf1a56	464	struct exfat_entry_set_cache exfat_get_dentry_set(struct super_block sb,
943af1fd	465	struct exfat_chain *p_dir, int entry, unsigned int type);
8b0c4717	466	int exfat_free_dentry_set(struct exfat_entry_set_cache *es, int sync);
1acf1a56 NJ	467	int exfat_count_dir_entries(struct super_block sb, struct exfat_chain p_dir);
	468
	469	/* inode.c */
	470	extern const struct inode_operations exfat_file_inode_operations;
	471	void exfat_sync_inode(struct inode *inode);
	472	struct inode exfat_build_inode(struct super_block sb,
	473	struct exfat_dir_entry *info, loff_t i_pos);
	474	void exfat_hash_inode(struct inode *inode, loff_t i_pos);
	475	void exfat_unhash_inode(struct inode *inode);
	476	struct inode exfat_iget(struct super_block sb, loff_t i_pos);
	477	int exfat_write_inode(struct inode inode, struct writeback_control wbc);
	478	void exfat_evict_inode(struct inode *inode);
	479	int exfat_block_truncate_page(struct inode *inode, loff_t from);
	480
	481	/* exfat/nls.c */
	482	unsigned short exfat_toupper(struct super_block *sb, unsigned short a);
	483	int exfat_uniname_ncmp(struct super_block sb, unsigned short a,
	484	unsigned short *b, unsigned int len);
	485	int exfat_utf16_to_nls(struct super_block *sb,
	486	struct exfat_uni_name uniname, unsigned char p_cstring,
	487	int len);
	488	int exfat_nls_to_utf16(struct super_block *sb,
	489	const unsigned char *p_cstring, const int len,
	490	struct exfat_uni_name uniname, int p_lossy);
	491	int exfat_create_upcase_table(struct super_block *sb);
	492	void exfat_free_upcase_table(struct exfat_sb_info *sbi);
1acf1a56 NJ	493
	494	/* exfat/misc.c */
	495	void __exfat_fs_error(struct super_block sb, int report, const char fmt, ...)
	496	__printf(3, 4) __cold;
	497	#define exfat_fs_error(sb, fmt, args...) \
	498	__exfat_fs_error(sb, 1, fmt, ## args)
	499	#define exfat_fs_error_ratelimit(sb, fmt, args...) \
	500	__exfat_fs_error(sb, __ratelimit(&EXFAT_SB(sb)->ratelimit), \
	501	fmt, ## args)
	502	void exfat_msg(struct super_block sb, const char lv, const char *fmt, ...)
	503	__printf(3, 4) __cold;
d1727d55 JP	504	#define exfat_err(sb, fmt, ...) \
	505	exfat_msg(sb, KERN_ERR, fmt, ##__VA_ARGS__)
	506	#define exfat_warn(sb, fmt, ...) \
	507	exfat_msg(sb, KERN_WARNING, fmt, ##__VA_ARGS__)
	508	#define exfat_info(sb, fmt, ...) \
	509	exfat_msg(sb, KERN_INFO, fmt, ##__VA_ARGS__)
	510
1acf1a56	511	void exfat_get_entry_time(struct exfat_sb_info sbi, struct timespec64 ts,
ed0f84d3	512	u8 tz, __le16 time, __le16 date, u8 time_cs);
81df1ad4	513	void exfat_truncate_atime(struct timespec64 *ts);
1acf1a56	514	void exfat_set_entry_time(struct exfat_sb_info sbi, struct timespec64 ts,
ed0f84d3	515	u8 tz, __le16 time, __le16 date, u8 time_cs);
5875bf28	516	u16 exfat_calc_chksum16(void *data, int len, u16 chksum, int type);
476189c0	517	u32 exfat_calc_chksum32(void *data, int len, u32 chksum, int type);
2c7f8937	518	void exfat_update_bh(struct buffer_head *bh, int sync);
3db3c3fb	519	int exfat_update_bhs(struct buffer_head **bhs, int nr_bhs, int sync);
1acf1a56 NJ	520	void exfat_chain_set(struct exfat_chain *ec, unsigned int dir,
	521	unsigned int size, unsigned char flags);
	522	void exfat_chain_dup(struct exfat_chain dup, struct exfat_chain ec);
	523
	524	#endif /* !_EXFAT_FS_H */