[linux.git] / fs / fat / fat.h

#ifndef _FAT_H
#define _FAT_H

#include <linux/buffer_head.h>
#include <linux/string.h>
#include <linux/nls.h>
#include <linux/fs.h>
#include <linux/hash.h>
#include <linux/mutex.h>
#include <linux/ratelimit.h>
#include <linux/msdos_fs.h>

/*
 * vfat shortname flags
 */
#define VFAT_SFN_DISPLAY_LOWER	0x0001 /* convert to lowercase for display */
#define VFAT_SFN_DISPLAY_WIN95	0x0002 /* emulate win95 rule for display */
#define VFAT_SFN_DISPLAY_WINNT	0x0004 /* emulate winnt rule for display */
#define VFAT_SFN_CREATE_WIN95	0x0100 /* emulate win95 rule for create */
#define VFAT_SFN_CREATE_WINNT	0x0200 /* emulate winnt rule for create */

#define FAT_ERRORS_CONT		1      /* ignore error and continue */
#define FAT_ERRORS_PANIC	2      /* panic on error */
#define FAT_ERRORS_RO		3      /* remount r/o on error */

#define FAT_NFS_STALE_RW	1      /* NFS RW support, can cause ESTALE */
#define FAT_NFS_NOSTALE_RO	2      /* NFS RO support, no ESTALE issue */

struct fat_mount_options {
	kuid_t fs_uid;
	kgid_t fs_gid;
	unsigned short fs_fmask;
	unsigned short fs_dmask;
	unsigned short codepage;   /* Codepage for shortname conversions */
	int time_offset;	   /* Offset of timestamps from UTC (in minutes) */
	char *iocharset;           /* Charset used for filename input/display */
	unsigned short shortname;  /* flags for shortname display/create rule */
	unsigned char name_check;  /* r = relaxed, n = normal, s = strict */
	unsigned char errors;	   /* On error: continue, panic, remount-ro */
	unsigned char nfs;	  /* NFS support: nostale_ro, stale_rw */
	unsigned short allow_utime;/* permission for setting the [am]time */
	unsigned quiet:1,          /* set = fake successful chmods and chowns */
		 showexec:1,       /* set = only set x bit for com/exe/bat */
		 sys_immutable:1,  /* set = system files are immutable */
		 dotsOK:1,         /* set = hidden and system files are named '.filename' */
		 isvfat:1,         /* 0=no vfat long filename support, 1=vfat support */
		 utf8:1,	   /* Use of UTF-8 character set (Default) */
		 unicode_xlate:1,  /* create escape sequences for unhandled Unicode */
		 numtail:1,        /* Does first alias have a numeric '~1' type tail? */
		 flush:1,	   /* write things quickly */
		 nocase:1,	   /* Does this need case conversion? 0=need case conversion*/
		 usefree:1,	   /* Use free_clusters for FAT32 */
		 tz_set:1,	   /* Filesystem timestamps' offset set */
		 rodir:1,	   /* allow ATTR_RO for directory */
		 discard:1;	   /* Issue discard requests on deletions */
};

#define FAT_HASH_BITS	8
#define FAT_HASH_SIZE	(1UL << FAT_HASH_BITS)

/*
 * MS-DOS file system in-core superblock data
 */
struct msdos_sb_info {
	unsigned short sec_per_clus;  /* sectors/cluster */
	unsigned short cluster_bits;  /* log2(cluster_size) */
	unsigned int cluster_size;    /* cluster size */
	unsigned char fats, fat_bits; /* number of FATs, FAT bits (12 or 16) */
	unsigned short fat_start;
	unsigned long fat_length;     /* FAT start & length (sec.) */
	unsigned long dir_start;
	unsigned short dir_entries;   /* root dir start & entries */
	unsigned long data_start;     /* first data sector */
	unsigned long max_cluster;    /* maximum cluster number */
	unsigned long root_cluster;   /* first cluster of the root directory */
	unsigned long fsinfo_sector;  /* sector number of FAT32 fsinfo */
	struct mutex fat_lock;
	struct mutex s_lock;
	unsigned int prev_free;      /* previously allocated cluster number */
	unsigned int free_clusters;  /* -1 if undefined */
	unsigned int free_clus_valid; /* is free_clusters valid? */
	struct fat_mount_options options;
	struct nls_table *nls_disk;   /* Codepage used on disk */
	struct nls_table *nls_io;     /* Charset used for input and display */
	const void *dir_ops;	      /* Opaque; default directory operations */
	int dir_per_block;	      /* dir entries per block */
	int dir_per_block_bits;	      /* log2(dir_per_block) */

	int fatent_shift;
	struct fatent_operations *fatent_ops;
	struct inode *fat_inode;
	struct inode *fsinfo_inode;

	struct ratelimit_state ratelimit;

	spinlock_t inode_hash_lock;
	struct hlist_head inode_hashtable[FAT_HASH_SIZE];

	spinlock_t dir_hash_lock;
	struct hlist_head dir_hashtable[FAT_HASH_SIZE];

	unsigned int dirty;           /* fs state before mount */
};

#define FAT_CACHE_VALID	0	/* special case for valid cache */

/*
 * MS-DOS file system inode data in memory
 */
struct msdos_inode_info {
	spinlock_t cache_lru_lock;
	struct list_head cache_lru;
	int nr_caches;
	/* for avoiding the race between fat_free() and fat_get_cluster() */
	unsigned int cache_valid_id;

	/* NOTE: mmu_private is 64bits, so must hold ->i_mutex to access */
	loff_t mmu_private;	/* physically allocated size */

	int i_start;		/* first cluster or 0 */
	int i_logstart;		/* logical first cluster */
	int i_attrs;		/* unused attribute bits */
	loff_t i_pos;		/* on-disk position of directory entry or 0 */
	struct hlist_node i_fat_hash;	/* hash by i_location */
	struct hlist_node i_dir_hash;	/* hash by i_logstart */
	struct rw_semaphore truncate_lock; /* protect bmap against truncate */
	struct inode vfs_inode;
};

struct fat_slot_info {
	loff_t i_pos;		/* on-disk position of directory entry */
	loff_t slot_off;	/* offset for slot or de start */
	int nr_slots;		/* number of slots + 1(de) in filename */
	struct msdos_dir_entry *de;
	struct buffer_head *bh;
};

static inline struct msdos_sb_info *MSDOS_SB(struct super_block *sb)
{
	return sb->s_fs_info;
}

static inline struct msdos_inode_info *MSDOS_I(struct inode *inode)
{
	return container_of(inode, struct msdos_inode_info, vfs_inode);
}

/*
 * If ->i_mode can't hold S_IWUGO (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 fat_mode_can_hold_ro(struct inode *inode)
{
	struct msdos_sb_info *sbi = MSDOS_SB(inode->i_sb);
	umode_t mask;

	if (S_ISDIR(inode->i_mode)) {
		if (!sbi->options.rodir)
			return 0;
		mask = ~sbi->options.fs_dmask;
	} else
		mask = ~sbi->options.fs_fmask;

	if (!(mask & S_IWUGO))
		return 0;
	return 1;
}

/* Convert attribute bits and a mask to the UNIX mode. */
static inline umode_t fat_make_mode(struct msdos_sb_info *sbi,
				   u8 attrs, umode_t mode)
{
	if (attrs & ATTR_RO && !((attrs & ATTR_DIR) && !sbi->options.rodir))
		mode &= ~S_IWUGO;

	if (attrs & ATTR_DIR)
		return (mode & ~sbi->options.fs_dmask) | S_IFDIR;
	else
		return (mode & ~sbi->options.fs_fmask) | S_IFREG;
}

/* Return the FAT attribute byte for this inode */
static inline u8 fat_make_attrs(struct inode *inode)
{
	u8 attrs = MSDOS_I(inode)->i_attrs;
	if (S_ISDIR(inode->i_mode))
		attrs |= ATTR_DIR;
	if (fat_mode_can_hold_ro(inode) && !(inode->i_mode & S_IWUGO))
		attrs |= ATTR_RO;
	return attrs;
}

static inline void fat_save_attrs(struct inode *inode, u8 attrs)
{
	if (fat_mode_can_hold_ro(inode))
		MSDOS_I(inode)->i_attrs = attrs & ATTR_UNUSED;
	else
		MSDOS_I(inode)->i_attrs = attrs & (ATTR_UNUSED | ATTR_RO);
}

static inline unsigned char fat_checksum(const __u8 *name)
{
	unsigned char s = name[0];
	s = (s<<7) + (s>>1) + name[1];	s = (s<<7) + (s>>1) + name[2];
	s = (s<<7) + (s>>1) + name[3];	s = (s<<7) + (s>>1) + name[4];
	s = (s<<7) + (s>>1) + name[5];	s = (s<<7) + (s>>1) + name[6];
	s = (s<<7) + (s>>1) + name[7];	s = (s<<7) + (s>>1) + name[8];
	s = (s<<7) + (s>>1) + name[9];	s = (s<<7) + (s>>1) + name[10];
	return s;
}

static inline sector_t fat_clus_to_blknr(struct msdos_sb_info *sbi, int clus)
{
	return ((sector_t)clus - FAT_START_ENT) * sbi->sec_per_clus
		+ sbi->data_start;
}

static inline loff_t fat_i_pos_read(struct msdos_sb_info *sbi,
					struct inode *inode)
{
	loff_t i_pos;
#if BITS_PER_LONG == 32
	spin_lock(&sbi->inode_hash_lock);
#endif
	i_pos = MSDOS_I(inode)->i_pos;
#if BITS_PER_LONG == 32
	spin_unlock(&sbi->inode_hash_lock);
#endif
	return i_pos;
}

static inline void fat16_towchar(wchar_t *dst, const __u8 *src, size_t len)
{
#ifdef __BIG_ENDIAN
	while (len--) {
		*dst++ = src[0] | (src[1] << 8);
		src += 2;
	}
#else
	memcpy(dst, src, len * 2);
#endif
}

static inline int fat_get_start(const struct msdos_sb_info *sbi,
				const struct msdos_dir_entry *de)
{
	int cluster = le16_to_cpu(de->start);
	if (sbi->fat_bits == 32)
		cluster |= (le16_to_cpu(de->starthi) << 16);
	return cluster;
}

static inline void fat_set_start(struct msdos_dir_entry *de, int cluster)
{
	de->start   = cpu_to_le16(cluster);
	de->starthi = cpu_to_le16(cluster >> 16);
}

static inline void fatwchar_to16(__u8 *dst, const wchar_t *src, size_t len)
{
#ifdef __BIG_ENDIAN
	while (len--) {
		dst[0] = *src & 0x00FF;
		dst[1] = (*src & 0xFF00) >> 8;
		dst += 2;
		src++;
	}
#else
	memcpy(dst, src, len * 2);
#endif
}

/* fat/cache.c */
extern void fat_cache_inval_inode(struct inode *inode);
extern int fat_get_cluster(struct inode *inode, int cluster,
			   int *fclus, int *dclus);
extern int fat_bmap(struct inode *inode, sector_t sector, sector_t *phys,
		    unsigned long *mapped_blocks, int create);

/* fat/dir.c */
extern const struct file_operations fat_dir_operations;
extern int fat_search_long(struct inode *inode, const unsigned char *name,
			   int name_len, struct fat_slot_info *sinfo);
extern int fat_dir_empty(struct inode *dir);
extern int fat_subdirs(struct inode *dir);
extern int fat_scan(struct inode *dir, const unsigned char *name,
		    struct fat_slot_info *sinfo);
extern int fat_get_dotdot_entry(struct inode *dir, struct buffer_head **bh,
				struct msdos_dir_entry **de);
extern int fat_alloc_new_dir(struct inode *dir, struct timespec *ts);
extern int fat_add_entries(struct inode *dir, void *slots, int nr_slots,
			   struct fat_slot_info *sinfo);
extern int fat_remove_entries(struct inode *dir, struct fat_slot_info *sinfo);

/* fat/fatent.c */
struct fat_entry {
	int entry;
	union {
		u8 *ent12_p[2];
		__le16 *ent16_p;
		__le32 *ent32_p;
	} u;
	int nr_bhs;
	struct buffer_head *bhs[2];
	struct inode *fat_inode;
};

static inline void fatent_init(struct fat_entry *fatent)
{
	fatent->nr_bhs = 0;
	fatent->entry = 0;
	fatent->u.ent32_p = NULL;
	fatent->bhs[0] = fatent->bhs[1] = NULL;
	fatent->fat_inode = NULL;
}

static inline void fatent_set_entry(struct fat_entry *fatent, int entry)
{
	fatent->entry = entry;
	fatent->u.ent32_p = NULL;
}

static inline void fatent_brelse(struct fat_entry *fatent)
{
	int i;
	fatent->u.ent32_p = NULL;
	for (i = 0; i < fatent->nr_bhs; i++)
		brelse(fatent->bhs[i]);
	fatent->nr_bhs = 0;
	fatent->bhs[0] = fatent->bhs[1] = NULL;
	fatent->fat_inode = NULL;
}

extern void fat_ent_access_init(struct super_block *sb);
extern int fat_ent_read(struct inode *inode, struct fat_entry *fatent,
			int entry);
extern int fat_ent_write(struct inode *inode, struct fat_entry *fatent,
			 int new, int wait);
extern int fat_alloc_clusters(struct inode *inode, int *cluster,
			      int nr_cluster);
extern int fat_free_clusters(struct inode *inode, int cluster);
extern int fat_count_free_clusters(struct super_block *sb);

/* fat/file.c */
extern long fat_generic_ioctl(struct file *filp, unsigned int cmd,
			      unsigned long arg);
extern const struct file_operations fat_file_operations;
extern const struct inode_operations fat_file_inode_operations;
extern int fat_setattr(struct dentry *dentry, struct iattr *attr);
extern void fat_truncate_blocks(struct inode *inode, loff_t offset);
extern int fat_getattr(struct vfsmount *mnt, struct dentry *dentry,
		       struct kstat *stat);
extern int fat_file_fsync(struct file *file, loff_t start, loff_t end,
			  int datasync);

/* fat/inode.c */
extern void fat_attach(struct inode *inode, loff_t i_pos);
extern void fat_detach(struct inode *inode);
extern struct inode *fat_iget(struct super_block *sb, loff_t i_pos);
extern struct inode *fat_build_inode(struct super_block *sb,
			struct msdos_dir_entry *de, loff_t i_pos);
extern int fat_sync_inode(struct inode *inode);
extern int fat_fill_super(struct super_block *sb, void *data, int silent,
			  int isvfat, void (*setup)(struct super_block *));

extern int fat_flush_inodes(struct super_block *sb, struct inode *i1,
			    struct inode *i2);
static inline unsigned long fat_dir_hash(int logstart)
{
	return hash_32(logstart, FAT_HASH_BITS);
}

/* fat/misc.c */
extern __printf(3, 4) __cold
void __fat_fs_error(struct super_block *sb, int report, const char *fmt, ...);
#define fat_fs_error(sb, fmt, args...)		\
	__fat_fs_error(sb, 1, fmt , ## args)
#define fat_fs_error_ratelimit(sb, fmt, args...) \
	__fat_fs_error(sb, __ratelimit(&MSDOS_SB(sb)->ratelimit), fmt , ## args)
__printf(3, 4) __cold
void fat_msg(struct super_block *sb, const char *level, const char *fmt, ...);
#define fat_msg_ratelimit(sb, level, fmt, args...)	\
	do {	\
			if (__ratelimit(&MSDOS_SB(sb)->ratelimit))	\
				fat_msg(sb, level, fmt, ## args);	\
	 } while (0)
extern int fat_clusters_flush(struct super_block *sb);
extern int fat_chain_add(struct inode *inode, int new_dclus, int nr_cluster);
extern void fat_time_fat2unix(struct msdos_sb_info *sbi, struct timespec *ts,
			      __le16 __time, __le16 __date, u8 time_cs);
extern void fat_time_unix2fat(struct msdos_sb_info *sbi, struct timespec *ts,
			      __le16 *time, __le16 *date, u8 *time_cs);
extern int fat_sync_bhs(struct buffer_head **bhs, int nr_bhs);

int fat_cache_init(void);
void fat_cache_destroy(void);

/* fat/nfs.c */
struct fid;
extern struct dentry *fat_fh_to_dentry(struct super_block *sb, struct fid *fid,
				       int fh_len, int fh_type);
extern struct dentry *fat_fh_to_parent(struct super_block *sb, struct fid *fid,
				       int fh_len, int fh_type);
extern struct dentry *fat_get_parent(struct dentry *child_dir);

/* helper for printk */
typedef unsigned long long	llu;

#endif /* !_FAT_H */
Commit	Line	Data
9e975dae OH	1	#ifndef _FAT_H
	2	#define _FAT_H
	3
	4	#include <linux/buffer_head.h>
	5	#include <linux/string.h>
	6	#include <linux/nls.h>
	7	#include <linux/fs.h>
7669e8fb	8	#include <linux/hash.h>
9e975dae	9	#include <linux/mutex.h>
aaa04b48	10	#include <linux/ratelimit.h>
9e975dae OH	11	#include <linux/msdos_fs.h>
	12
	13	/*
	14	* vfat shortname flags
	15	*/
	16	#define VFAT_SFN_DISPLAY_LOWER 0x0001 /* convert to lowercase for display */
	17	#define VFAT_SFN_DISPLAY_WIN95 0x0002 /* emulate win95 rule for display */
	18	#define VFAT_SFN_DISPLAY_WINNT 0x0004 /* emulate winnt rule for display */
	19	#define VFAT_SFN_CREATE_WIN95 0x0100 /* emulate win95 rule for create */
	20	#define VFAT_SFN_CREATE_WINNT 0x0200 /* emulate winnt rule for create */
	21
85c78591 DK	22	#define FAT_ERRORS_CONT 1 /* ignore error and continue */
	23	#define FAT_ERRORS_PANIC 2 /* panic on error */
	24	#define FAT_ERRORS_RO 3 /* remount r/o on error */
	25
2628b7a6 NJ	26	#define FAT_NFS_STALE_RW 1 /* NFS RW support, can cause ESTALE */
	27	#define FAT_NFS_NOSTALE_RO 2 /* NFS RO support, no ESTALE issue */
	28
9e975dae	29	struct fat_mount_options {
170782eb EB	30	kuid_t fs_uid;
170782eb EB	31	kgid_t fs_gid;
9e975dae OH	32	unsigned short fs_fmask;
9e975dae OH	33	unsigned short fs_dmask;
4a3aeb13	34	unsigned short codepage; /* Codepage for shortname conversions */
58156c8f	35	int time_offset; /* Offset of timestamps from UTC (in minutes) */
4a3aeb13 CJB	36	char iocharset; / Charset used for filename input/display */
	37	unsigned short shortname; /* flags for shortname display/create rule */
	38	unsigned char name_check; /* r = relaxed, n = normal, s = strict */
	39	unsigned char errors; /* On error: continue, panic, remount-ro */
2628b7a6	40	unsigned char nfs; /* NFS support: nostale_ro, stale_rw */
9e975dae	41	unsigned short allow_utime;/* permission for setting the [am]time */
4a3aeb13 CJB	42	unsigned quiet:1, /* set = fake successful chmods and chowns */
	43	showexec:1, /* set = only set x bit for com/exe/bat */
	44	sys_immutable:1, /* set = system files are immutable */
	45	dotsOK:1, /* set = hidden and system files are named '.filename' */
	46	isvfat:1, /* 0=no vfat long filename support, 1=vfat support */
	47	utf8:1, /* Use of UTF-8 character set (Default) */
	48	unicode_xlate:1, /* create escape sequences for unhandled Unicode */
	49	numtail:1, /* Does first alias have a numeric '~1' type tail? */
	50	flush:1, /* write things quickly */
	51	nocase:1, /* Does this need case conversion? 0=need case conversion*/
	52	usefree:1, /* Use free_clusters for FAT32 */
58156c8f	53	tz_set:1, /* Filesystem timestamps' offset set */
4a3aeb13	54	rodir:1, /* allow ATTR_RO for directory */
2628b7a6	55	discard:1; /* Issue discard requests on deletions */
9e975dae OH	56	};
	57
	58	#define FAT_HASH_BITS 8
	59	#define FAT_HASH_SIZE (1UL << FAT_HASH_BITS)
9e975dae OH	60
	61	/*
	62	* MS-DOS file system in-core superblock data
	63	*/
	64	struct msdos_sb_info {
4a3aeb13 CJB	65	unsigned short sec_per_clus; /* sectors/cluster */
	66	unsigned short cluster_bits; /* log2(cluster_size) */
	67	unsigned int cluster_size; /* cluster size */
d5a4a386	68	unsigned char fats, fat_bits; /* number of FATs, FAT bits (12 or 16) */
9e975dae	69	unsigned short fat_start;
4a3aeb13	70	unsigned long fat_length; /* FAT start & length (sec.) */
9e975dae	71	unsigned long dir_start;
4a3aeb13 CJB	72	unsigned short dir_entries; /* root dir start & entries */
	73	unsigned long data_start; /* first data sector */
	74	unsigned long max_cluster; /* maximum cluster number */
	75	unsigned long root_cluster; /* first cluster of the root directory */
	76	unsigned long fsinfo_sector; /* sector number of FAT32 fsinfo */
9e975dae	77	struct mutex fat_lock;
e40b34c7 MS	78	struct mutex s_lock;
	79	unsigned int prev_free; /* previously allocated cluster number */
	80	unsigned int free_clusters; /* -1 if undefined */
9e975dae OH	81	unsigned int free_clus_valid; /* is free_clusters valid? */
9e975dae OH	82	struct fat_mount_options options;
4a3aeb13 CJB	83	struct nls_table nls_disk; / Codepage used on disk */
	84	struct nls_table nls_io; / Charset used for input and display */
	85	const void dir_ops; / Opaque; default directory operations */
	86	int dir_per_block; /* dir entries per block */
	87	int dir_per_block_bits; /* log2(dir_per_block) */
9e975dae OH	88
	89	int fatent_shift;
	90	struct fatent_operations *fatent_ops;
b522412a	91	struct inode *fat_inode;
020ac5b6	92	struct inode *fsinfo_inode;
9e975dae	93
aaa04b48 OH	94	struct ratelimit_state ratelimit;
aaa04b48 OH	95
9e975dae OH	96	spinlock_t inode_hash_lock;
9e975dae OH	97	struct hlist_head inode_hashtable[FAT_HASH_SIZE];
7669e8fb SM	98
	99	spinlock_t dir_hash_lock;
	100	struct hlist_head dir_hashtable[FAT_HASH_SIZE];
b88a1058 OR	101
b88a1058 OR	102	unsigned int dirty; /* fs state before mount */
9e975dae OH	103	};
	104
	105	#define FAT_CACHE_VALID 0 /* special case for valid cache */
	106
	107	/*
	108	* MS-DOS file system inode data in memory
	109	*/
	110	struct msdos_inode_info {
	111	spinlock_t cache_lru_lock;
	112	struct list_head cache_lru;
	113	int nr_caches;
	114	/* for avoiding the race between fat_free() and fat_get_cluster() */
	115	unsigned int cache_valid_id;
	116
2bdf67eb OH	117	/* NOTE: mmu_private is 64bits, so must hold ->i_mutex to access */
	118	loff_t mmu_private; /* physically allocated size */
	119
9e975dae OH	120	int i_start; /* first cluster or 0 */
	121	int i_logstart; /* logical first cluster */
	122	int i_attrs; /* unused attribute bits */
	123	loff_t i_pos; /* on-disk position of directory entry or 0 */
	124	struct hlist_node i_fat_hash; /* hash by i_location */
7669e8fb	125	struct hlist_node i_dir_hash; /* hash by i_logstart */
58268691	126	struct rw_semaphore truncate_lock; /* protect bmap against truncate */
9e975dae OH	127	struct inode vfs_inode;
	128	};
	129
	130	struct fat_slot_info {
	131	loff_t i_pos; /* on-disk position of directory entry */
	132	loff_t slot_off; /* offset for slot or de start */
	133	int nr_slots; /* number of slots + 1(de) in filename */
	134	struct msdos_dir_entry *de;
	135	struct buffer_head *bh;
	136	};
	137
	138	static inline struct msdos_sb_info MSDOS_SB(struct super_block sb)
	139	{
	140	return sb->s_fs_info;
	141	}
	142
	143	static inline struct msdos_inode_info MSDOS_I(struct inode inode)
	144	{
	145	return container_of(inode, struct msdos_inode_info, vfs_inode);
	146	}
	147
9183482f OH	148	/*
	149	* If ->i_mode can't hold S_IWUGO (i.e. ATTR_RO), we use ->i_attrs to
	150	* save ATTR_RO instead of ->i_mode.
dfc209c0 OH	151	*
	152	* If it's directory and !sbi->options.rodir, ATTR_RO isn't read-only
	153	* bit, it's just used as flag for app.
9183482f OH	154	*/
	155	static inline int fat_mode_can_hold_ro(struct inode *inode)
	156	{
	157	struct msdos_sb_info *sbi = MSDOS_SB(inode->i_sb);
dacd0e7b	158	umode_t mask;
9183482f	159
dfc209c0 OH	160	if (S_ISDIR(inode->i_mode)) {
	161	if (!sbi->options.rodir)
	162	return 0;
9183482f	163	mask = ~sbi->options.fs_dmask;
dfc209c0	164	} else
9183482f OH	165	mask = ~sbi->options.fs_fmask;
	166
	167	if (!(mask & S_IWUGO))
	168	return 0;
	169	return 1;
	170	}
	171
9c0aa1b8	172	/* Convert attribute bits and a mask to the UNIX mode. */
dacd0e7b AV	173	static inline umode_t fat_make_mode(struct msdos_sb_info *sbi,
dacd0e7b AV	174	u8 attrs, umode_t mode)
9c0aa1b8	175	{
dfc209c0	176	if (attrs & ATTR_RO && !((attrs & ATTR_DIR) && !sbi->options.rodir))
9c0aa1b8 OH	177	mode &= ~S_IWUGO;
	178
	179	if (attrs & ATTR_DIR)
	180	return (mode & ~sbi->options.fs_dmask) \| S_IFDIR;
	181	else
	182	return (mode & ~sbi->options.fs_fmask) \| S_IFREG;
	183	}
	184
9e975dae	185	/* Return the FAT attribute byte for this inode */
9c0aa1b8	186	static inline u8 fat_make_attrs(struct inode *inode)
9e975dae	187	{
9183482f OH	188	u8 attrs = MSDOS_I(inode)->i_attrs;
	189	if (S_ISDIR(inode->i_mode))
	190	attrs \|= ATTR_DIR;
	191	if (fat_mode_can_hold_ro(inode) && !(inode->i_mode & S_IWUGO))
	192	attrs \|= ATTR_RO;
	193	return attrs;
9e975dae OH	194	}
9e975dae OH	195
9c0aa1b8 OH	196	static inline void fat_save_attrs(struct inode *inode, u8 attrs)
9c0aa1b8 OH	197	{
9183482f OH	198	if (fat_mode_can_hold_ro(inode))
	199	MSDOS_I(inode)->i_attrs = attrs & ATTR_UNUSED;
	200	else
	201	MSDOS_I(inode)->i_attrs = attrs & (ATTR_UNUSED \| ATTR_RO);
9c0aa1b8 OH	202	}
9c0aa1b8 OH	203
9e975dae OH	204	static inline unsigned char fat_checksum(const __u8 *name)
	205	{
	206	unsigned char s = name[0];
	207	s = (s<<7) + (s>>1) + name[1]; s = (s<<7) + (s>>1) + name[2];
	208	s = (s<<7) + (s>>1) + name[3]; s = (s<<7) + (s>>1) + name[4];
	209	s = (s<<7) + (s>>1) + name[5]; s = (s<<7) + (s>>1) + name[6];
	210	s = (s<<7) + (s>>1) + name[7]; s = (s<<7) + (s>>1) + name[8];
	211	s = (s<<7) + (s>>1) + name[9]; s = (s<<7) + (s>>1) + name[10];
	212	return s;
	213	}
	214
	215	static inline sector_t fat_clus_to_blknr(struct msdos_sb_info *sbi, int clus)
	216	{
	217	return ((sector_t)clus - FAT_START_ENT) * sbi->sec_per_clus
	218	+ sbi->data_start;
	219	}
	220
f21735d5 NJ	221	static inline loff_t fat_i_pos_read(struct msdos_sb_info *sbi,
	222	struct inode *inode)
	223	{
	224	loff_t i_pos;
	225	#if BITS_PER_LONG == 32
	226	spin_lock(&sbi->inode_hash_lock);
	227	#endif
	228	i_pos = MSDOS_I(inode)->i_pos;
	229	#if BITS_PER_LONG == 32
	230	spin_unlock(&sbi->inode_hash_lock);
	231	#endif
	232	return i_pos;
	233	}
	234
9e975dae OH	235	static inline void fat16_towchar(wchar_t dst, const __u8 src, size_t len)
	236	{
	237	#ifdef __BIG_ENDIAN
	238	while (len--) {
	239	*dst++ = src[0] \| (src[1] << 8);
	240	src += 2;
	241	}
	242	#else
	243	memcpy(dst, src, len * 2);
	244	#endif
	245	}
	246
a943ed71 SM	247	static inline int fat_get_start(const struct msdos_sb_info *sbi,
	248	const struct msdos_dir_entry *de)
	249	{
	250	int cluster = le16_to_cpu(de->start);
	251	if (sbi->fat_bits == 32)
	252	cluster \|= (le16_to_cpu(de->starthi) << 16);
	253	return cluster;
	254	}
	255
	256	static inline void fat_set_start(struct msdos_dir_entry *de, int cluster)
	257	{
	258	de->start = cpu_to_le16(cluster);
	259	de->starthi = cpu_to_le16(cluster >> 16);
	260	}
	261
9e975dae OH	262	static inline void fatwchar_to16(__u8 dst, const wchar_t src, size_t len)
	263	{
	264	#ifdef __BIG_ENDIAN
	265	while (len--) {
	266	dst[0] = *src & 0x00FF;
	267	dst[1] = (*src & 0xFF00) >> 8;
	268	dst += 2;
	269	src++;
	270	}
	271	#else
	272	memcpy(dst, src, len * 2);
	273	#endif
	274	}
	275
	276	/* fat/cache.c */
	277	extern void fat_cache_inval_inode(struct inode *inode);
	278	extern int fat_get_cluster(struct inode *inode, int cluster,
	279	int fclus, int dclus);
	280	extern int fat_bmap(struct inode inode, sector_t sector, sector_t phys,
2bdf67eb	281	unsigned long *mapped_blocks, int create);
9e975dae OH	282
	283	/* fat/dir.c */
	284	extern const struct file_operations fat_dir_operations;
	285	extern int fat_search_long(struct inode inode, const unsigned char name,
	286	int name_len, struct fat_slot_info *sinfo);
	287	extern int fat_dir_empty(struct inode *dir);
	288	extern int fat_subdirs(struct inode *dir);
	289	extern int fat_scan(struct inode dir, const unsigned char name,
	290	struct fat_slot_info *sinfo);
	291	extern int fat_get_dotdot_entry(struct inode dir, struct buffer_head *bh,
7669e8fb	292	struct msdos_dir_entry **de);
9e975dae OH	293	extern int fat_alloc_new_dir(struct inode dir, struct timespec ts);
	294	extern int fat_add_entries(struct inode dir, void slots, int nr_slots,
	295	struct fat_slot_info *sinfo);
	296	extern int fat_remove_entries(struct inode dir, struct fat_slot_info sinfo);
	297
	298	/* fat/fatent.c */
	299	struct fat_entry {
	300	int entry;
	301	union {
	302	u8 *ent12_p[2];
	303	__le16 *ent16_p;
	304	__le32 *ent32_p;
	305	} u;
	306	int nr_bhs;
	307	struct buffer_head *bhs[2];
b522412a	308	struct inode *fat_inode;
9e975dae OH	309	};
	310
	311	static inline void fatent_init(struct fat_entry *fatent)
	312	{
	313	fatent->nr_bhs = 0;
	314	fatent->entry = 0;
	315	fatent->u.ent32_p = NULL;
	316	fatent->bhs[0] = fatent->bhs[1] = NULL;
b522412a	317	fatent->fat_inode = NULL;
9e975dae OH	318	}
	319
	320	static inline void fatent_set_entry(struct fat_entry *fatent, int entry)
	321	{
	322	fatent->entry = entry;
	323	fatent->u.ent32_p = NULL;
	324	}
	325
	326	static inline void fatent_brelse(struct fat_entry *fatent)
	327	{
	328	int i;
	329	fatent->u.ent32_p = NULL;
	330	for (i = 0; i < fatent->nr_bhs; i++)
	331	brelse(fatent->bhs[i]);
	332	fatent->nr_bhs = 0;
	333	fatent->bhs[0] = fatent->bhs[1] = NULL;
b522412a	334	fatent->fat_inode = NULL;
9e975dae OH	335	}
	336
	337	extern void fat_ent_access_init(struct super_block *sb);
	338	extern int fat_ent_read(struct inode inode, struct fat_entry fatent,
	339	int entry);
	340	extern int fat_ent_write(struct inode inode, struct fat_entry fatent,
	341	int new, int wait);
	342	extern int fat_alloc_clusters(struct inode inode, int cluster,
	343	int nr_cluster);
	344	extern int fat_free_clusters(struct inode *inode, int cluster);
	345	extern int fat_count_free_clusters(struct super_block *sb);
	346
	347	/* fat/file.c */
7845bc3e AB	348	extern long fat_generic_ioctl(struct file *filp, unsigned int cmd,
7845bc3e AB	349	unsigned long arg);
9e975dae OH	350	extern const struct file_operations fat_file_operations;
9e975dae OH	351	extern const struct inode_operations fat_file_inode_operations;
d5a4a386	352	extern int fat_setattr(struct dentry dentry, struct iattr attr);
459f6ed3	353	extern void fat_truncate_blocks(struct inode *inode, loff_t offset);
9e975dae OH	354	extern int fat_getattr(struct vfsmount mnt, struct dentry dentry,
9e975dae OH	355	struct kstat *stat);
02c24a82 JB	356	extern int fat_file_fsync(struct file *file, loff_t start, loff_t end,
02c24a82 JB	357	int datasync);
9e975dae OH	358
	359	/* fat/inode.c */
	360	extern void fat_attach(struct inode *inode, loff_t i_pos);
	361	extern void fat_detach(struct inode *inode);
	362	extern struct inode fat_iget(struct super_block sb, loff_t i_pos);
	363	extern struct inode fat_build_inode(struct super_block sb,
	364	struct msdos_dir_entry *de, loff_t i_pos);
	365	extern int fat_sync_inode(struct inode *inode);
	366	extern int fat_fill_super(struct super_block sb, void data, int silent,
384f5c96	367	int isvfat, void (setup)(struct super_block ));
9e975dae OH	368
9e975dae OH	369	extern int fat_flush_inodes(struct super_block sb, struct inode i1,
d5a4a386	370	struct inode *i2);
7669e8fb	371	static inline unsigned long fat_dir_hash(int logstart)
21b6633d	372	{
7669e8fb	373	return hash_32(logstart, FAT_HASH_BITS);
21b6633d SM	374	}
21b6633d SM	375
9e975dae	376	/* fat/misc.c */
b9075fa9 JP	377	extern __printf(3, 4) __cold
b9075fa9 JP	378	void __fat_fs_error(struct super_block sb, int report, const char fmt, ...);
2c8a5ffb OR	379	#define fat_fs_error(sb, fmt, args...) \
	380	__fat_fs_error(sb, 1, fmt , ## args)
	381	#define fat_fs_error_ratelimit(sb, fmt, args...) \
	382	__fat_fs_error(sb, __ratelimit(&MSDOS_SB(sb)->ratelimit), fmt , ## args)
b9075fa9 JP	383	__printf(3, 4) __cold
b9075fa9 JP	384	void fat_msg(struct super_block sb, const char level, const char *fmt, ...);
b742c341 NJ	385	#define fat_msg_ratelimit(sb, level, fmt, args...) \
	386	do { \
	387	if (__ratelimit(&MSDOS_SB(sb)->ratelimit)) \
	388	fat_msg(sb, level, fmt, ## args); \
	389	} while (0)
ed248b29	390	extern int fat_clusters_flush(struct super_block *sb);
9e975dae	391	extern int fat_chain_add(struct inode *inode, int new_dclus, int nr_cluster);
7decd1cb OH	392	extern void fat_time_fat2unix(struct msdos_sb_info sbi, struct timespec ts,
	393	__le16 __time, __le16 __date, u8 time_cs);
	394	extern void fat_time_unix2fat(struct msdos_sb_info sbi, struct timespec ts,
	395	__le16 time, __le16 date, u8 *time_cs);
9e975dae OH	396	extern int fat_sync_bhs(struct buffer_head **bhs, int nr_bhs);
	397
	398	int fat_cache_init(void);
	399	void fat_cache_destroy(void);
	400
21b6633d SM	401	/* fat/nfs.c */
21b6633d SM	402	struct fid;
21b6633d SM	403	extern struct dentry fat_fh_to_dentry(struct super_block sb, struct fid *fid,
21b6633d SM	404	int fh_len, int fh_type);
7669e8fb SM	405	extern struct dentry fat_fh_to_parent(struct super_block sb, struct fid *fid,
7669e8fb SM	406	int fh_len, int fh_type);
21b6633d SM	407	extern struct dentry fat_get_parent(struct dentry child_dir);
21b6633d SM	408
c3302931 OH	409	/* helper for printk */
	410	typedef unsigned long long llu;
	411
9e975dae	412	#endif /* !_FAT_H */