blob: e9cc3f0d58e28e54ec820d5116b0d5b154299b12 [file] [log] [blame]
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -08001#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>
Steven J. Magnani7669e8f2012-10-04 17:14:45 -07008#include <linux/hash.h>
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -08009#include <linux/mutex.h>
OGAWA Hirofumiaaa04b42010-05-24 14:33:12 -070010#include <linux/ratelimit.h>
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080011#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
Denis Karpov85c78592009-06-04 02:34:22 +090022#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
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080026struct fat_mount_options {
Eric W. Biederman170782e2012-02-07 16:25:39 -080027 kuid_t fs_uid;
28 kgid_t fs_gid;
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080029 unsigned short fs_fmask;
30 unsigned short fs_dmask;
Cruz Julian Bishop4a3aeb12012-10-04 17:14:52 -070031 unsigned short codepage; /* Codepage for shortname conversions */
Jan Kara58156c82012-12-17 16:02:58 -080032 int time_offset; /* Offset of timestamps from UTC (in minutes) */
Cruz Julian Bishop4a3aeb12012-10-04 17:14:52 -070033 char *iocharset; /* Charset used for filename input/display */
34 unsigned short shortname; /* flags for shortname display/create rule */
35 unsigned char name_check; /* r = relaxed, n = normal, s = strict */
36 unsigned char errors; /* On error: continue, panic, remount-ro */
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080037 unsigned short allow_utime;/* permission for setting the [am]time */
Cruz Julian Bishop4a3aeb12012-10-04 17:14:52 -070038 unsigned quiet:1, /* set = fake successful chmods and chowns */
39 showexec:1, /* set = only set x bit for com/exe/bat */
40 sys_immutable:1, /* set = system files are immutable */
41 dotsOK:1, /* set = hidden and system files are named '.filename' */
42 isvfat:1, /* 0=no vfat long filename support, 1=vfat support */
43 utf8:1, /* Use of UTF-8 character set (Default) */
44 unicode_xlate:1, /* create escape sequences for unhandled Unicode */
45 numtail:1, /* Does first alias have a numeric '~1' type tail? */
46 flush:1, /* write things quickly */
47 nocase:1, /* Does this need case conversion? 0=need case conversion*/
48 usefree:1, /* Use free_clusters for FAT32 */
Jan Kara58156c82012-12-17 16:02:58 -080049 tz_set:1, /* Filesystem timestamps' offset set */
Cruz Julian Bishop4a3aeb12012-10-04 17:14:52 -070050 rodir:1, /* allow ATTR_RO for directory */
51 discard:1, /* Issue discard requests on deletions */
52 nfs:1; /* Do extra work needed for NFS export */
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080053};
54
55#define FAT_HASH_BITS 8
56#define FAT_HASH_SIZE (1UL << FAT_HASH_BITS)
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080057
58/*
59 * MS-DOS file system in-core superblock data
60 */
61struct msdos_sb_info {
Cruz Julian Bishop4a3aeb12012-10-04 17:14:52 -070062 unsigned short sec_per_clus; /* sectors/cluster */
63 unsigned short cluster_bits; /* log2(cluster_size) */
64 unsigned int cluster_size; /* cluster size */
Cruz Julian Bishopd5a4a382012-10-04 17:14:49 -070065 unsigned char fats, fat_bits; /* number of FATs, FAT bits (12 or 16) */
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080066 unsigned short fat_start;
Cruz Julian Bishop4a3aeb12012-10-04 17:14:52 -070067 unsigned long fat_length; /* FAT start & length (sec.) */
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080068 unsigned long dir_start;
Cruz Julian Bishop4a3aeb12012-10-04 17:14:52 -070069 unsigned short dir_entries; /* root dir start & entries */
70 unsigned long data_start; /* first data sector */
71 unsigned long max_cluster; /* maximum cluster number */
72 unsigned long root_cluster; /* first cluster of the root directory */
73 unsigned long fsinfo_sector; /* sector number of FAT32 fsinfo */
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080074 struct mutex fat_lock;
Marco Stornellie40b34c2012-10-06 12:40:03 +020075 struct mutex s_lock;
76 unsigned int prev_free; /* previously allocated cluster number */
77 unsigned int free_clusters; /* -1 if undefined */
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080078 unsigned int free_clus_valid; /* is free_clusters valid? */
79 struct fat_mount_options options;
Cruz Julian Bishop4a3aeb12012-10-04 17:14:52 -070080 struct nls_table *nls_disk; /* Codepage used on disk */
81 struct nls_table *nls_io; /* Charset used for input and display */
82 const void *dir_ops; /* Opaque; default directory operations */
83 int dir_per_block; /* dir entries per block */
84 int dir_per_block_bits; /* log2(dir_per_block) */
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080085
86 int fatent_shift;
87 struct fatent_operations *fatent_ops;
Al Virob5224122009-06-07 13:44:36 -040088 struct inode *fat_inode;
Artem Bityutskiy020ac5b2012-05-31 16:26:12 -070089 struct inode *fsinfo_inode;
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080090
OGAWA Hirofumiaaa04b42010-05-24 14:33:12 -070091 struct ratelimit_state ratelimit;
92
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080093 spinlock_t inode_hash_lock;
94 struct hlist_head inode_hashtable[FAT_HASH_SIZE];
Steven J. Magnani7669e8f2012-10-04 17:14:45 -070095
96 spinlock_t dir_hash_lock;
97 struct hlist_head dir_hashtable[FAT_HASH_SIZE];
Oleksij Rempelb88a10582013-02-27 17:03:09 -080098
99 unsigned int dirty; /* fs state before mount */
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800100};
101
102#define FAT_CACHE_VALID 0 /* special case for valid cache */
103
104/*
105 * MS-DOS file system inode data in memory
106 */
107struct msdos_inode_info {
108 spinlock_t cache_lru_lock;
109 struct list_head cache_lru;
110 int nr_caches;
111 /* for avoiding the race between fat_free() and fat_get_cluster() */
112 unsigned int cache_valid_id;
113
OGAWA Hirofumi2bdf67e2008-11-06 12:53:57 -0800114 /* NOTE: mmu_private is 64bits, so must hold ->i_mutex to access */
115 loff_t mmu_private; /* physically allocated size */
116
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800117 int i_start; /* first cluster or 0 */
118 int i_logstart; /* logical first cluster */
119 int i_attrs; /* unused attribute bits */
120 loff_t i_pos; /* on-disk position of directory entry or 0 */
121 struct hlist_node i_fat_hash; /* hash by i_location */
Steven J. Magnani7669e8f2012-10-04 17:14:45 -0700122 struct hlist_node i_dir_hash; /* hash by i_logstart */
Christoph Hellwig58268692011-06-24 14:29:40 -0400123 struct rw_semaphore truncate_lock; /* protect bmap against truncate */
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800124 struct inode vfs_inode;
125};
126
127struct fat_slot_info {
128 loff_t i_pos; /* on-disk position of directory entry */
129 loff_t slot_off; /* offset for slot or de start */
130 int nr_slots; /* number of slots + 1(de) in filename */
131 struct msdos_dir_entry *de;
132 struct buffer_head *bh;
133};
134
135static inline struct msdos_sb_info *MSDOS_SB(struct super_block *sb)
136{
137 return sb->s_fs_info;
138}
139
140static inline struct msdos_inode_info *MSDOS_I(struct inode *inode)
141{
142 return container_of(inode, struct msdos_inode_info, vfs_inode);
143}
144
OGAWA Hirofumi91834822008-11-06 12:53:54 -0800145/*
146 * If ->i_mode can't hold S_IWUGO (i.e. ATTR_RO), we use ->i_attrs to
147 * save ATTR_RO instead of ->i_mode.
OGAWA Hirofumidfc209c2008-11-06 12:53:55 -0800148 *
149 * If it's directory and !sbi->options.rodir, ATTR_RO isn't read-only
150 * bit, it's just used as flag for app.
OGAWA Hirofumi91834822008-11-06 12:53:54 -0800151 */
152static inline int fat_mode_can_hold_ro(struct inode *inode)
153{
154 struct msdos_sb_info *sbi = MSDOS_SB(inode->i_sb);
Al Virodacd0e72011-07-26 03:21:30 -0400155 umode_t mask;
OGAWA Hirofumi91834822008-11-06 12:53:54 -0800156
OGAWA Hirofumidfc209c2008-11-06 12:53:55 -0800157 if (S_ISDIR(inode->i_mode)) {
158 if (!sbi->options.rodir)
159 return 0;
OGAWA Hirofumi91834822008-11-06 12:53:54 -0800160 mask = ~sbi->options.fs_dmask;
OGAWA Hirofumidfc209c2008-11-06 12:53:55 -0800161 } else
OGAWA Hirofumi91834822008-11-06 12:53:54 -0800162 mask = ~sbi->options.fs_fmask;
163
164 if (!(mask & S_IWUGO))
165 return 0;
166 return 1;
167}
168
OGAWA Hirofumi9c0aa1b2008-11-06 12:53:54 -0800169/* Convert attribute bits and a mask to the UNIX mode. */
Al Virodacd0e72011-07-26 03:21:30 -0400170static inline umode_t fat_make_mode(struct msdos_sb_info *sbi,
171 u8 attrs, umode_t mode)
OGAWA Hirofumi9c0aa1b2008-11-06 12:53:54 -0800172{
OGAWA Hirofumidfc209c2008-11-06 12:53:55 -0800173 if (attrs & ATTR_RO && !((attrs & ATTR_DIR) && !sbi->options.rodir))
OGAWA Hirofumi9c0aa1b2008-11-06 12:53:54 -0800174 mode &= ~S_IWUGO;
175
176 if (attrs & ATTR_DIR)
177 return (mode & ~sbi->options.fs_dmask) | S_IFDIR;
178 else
179 return (mode & ~sbi->options.fs_fmask) | S_IFREG;
180}
181
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800182/* Return the FAT attribute byte for this inode */
OGAWA Hirofumi9c0aa1b2008-11-06 12:53:54 -0800183static inline u8 fat_make_attrs(struct inode *inode)
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800184{
OGAWA Hirofumi91834822008-11-06 12:53:54 -0800185 u8 attrs = MSDOS_I(inode)->i_attrs;
186 if (S_ISDIR(inode->i_mode))
187 attrs |= ATTR_DIR;
188 if (fat_mode_can_hold_ro(inode) && !(inode->i_mode & S_IWUGO))
189 attrs |= ATTR_RO;
190 return attrs;
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800191}
192
OGAWA Hirofumi9c0aa1b2008-11-06 12:53:54 -0800193static inline void fat_save_attrs(struct inode *inode, u8 attrs)
194{
OGAWA Hirofumi91834822008-11-06 12:53:54 -0800195 if (fat_mode_can_hold_ro(inode))
196 MSDOS_I(inode)->i_attrs = attrs & ATTR_UNUSED;
197 else
198 MSDOS_I(inode)->i_attrs = attrs & (ATTR_UNUSED | ATTR_RO);
OGAWA Hirofumi9c0aa1b2008-11-06 12:53:54 -0800199}
200
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800201static inline unsigned char fat_checksum(const __u8 *name)
202{
203 unsigned char s = name[0];
204 s = (s<<7) + (s>>1) + name[1]; s = (s<<7) + (s>>1) + name[2];
205 s = (s<<7) + (s>>1) + name[3]; s = (s<<7) + (s>>1) + name[4];
206 s = (s<<7) + (s>>1) + name[5]; s = (s<<7) + (s>>1) + name[6];
207 s = (s<<7) + (s>>1) + name[7]; s = (s<<7) + (s>>1) + name[8];
208 s = (s<<7) + (s>>1) + name[9]; s = (s<<7) + (s>>1) + name[10];
209 return s;
210}
211
212static inline sector_t fat_clus_to_blknr(struct msdos_sb_info *sbi, int clus)
213{
214 return ((sector_t)clus - FAT_START_ENT) * sbi->sec_per_clus
215 + sbi->data_start;
216}
217
218static inline void fat16_towchar(wchar_t *dst, const __u8 *src, size_t len)
219{
220#ifdef __BIG_ENDIAN
221 while (len--) {
222 *dst++ = src[0] | (src[1] << 8);
223 src += 2;
224 }
225#else
226 memcpy(dst, src, len * 2);
227#endif
228}
229
Steven J. Magnania943ed72012-07-30 14:42:13 -0700230static inline int fat_get_start(const struct msdos_sb_info *sbi,
231 const struct msdos_dir_entry *de)
232{
233 int cluster = le16_to_cpu(de->start);
234 if (sbi->fat_bits == 32)
235 cluster |= (le16_to_cpu(de->starthi) << 16);
236 return cluster;
237}
238
239static inline void fat_set_start(struct msdos_dir_entry *de, int cluster)
240{
241 de->start = cpu_to_le16(cluster);
242 de->starthi = cpu_to_le16(cluster >> 16);
243}
244
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800245static inline void fatwchar_to16(__u8 *dst, const wchar_t *src, size_t len)
246{
247#ifdef __BIG_ENDIAN
248 while (len--) {
249 dst[0] = *src & 0x00FF;
250 dst[1] = (*src & 0xFF00) >> 8;
251 dst += 2;
252 src++;
253 }
254#else
255 memcpy(dst, src, len * 2);
256#endif
257}
258
259/* fat/cache.c */
260extern void fat_cache_inval_inode(struct inode *inode);
261extern int fat_get_cluster(struct inode *inode, int cluster,
262 int *fclus, int *dclus);
263extern int fat_bmap(struct inode *inode, sector_t sector, sector_t *phys,
OGAWA Hirofumi2bdf67e2008-11-06 12:53:57 -0800264 unsigned long *mapped_blocks, int create);
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800265
266/* fat/dir.c */
267extern const struct file_operations fat_dir_operations;
268extern int fat_search_long(struct inode *inode, const unsigned char *name,
269 int name_len, struct fat_slot_info *sinfo);
270extern int fat_dir_empty(struct inode *dir);
271extern int fat_subdirs(struct inode *dir);
272extern int fat_scan(struct inode *dir, const unsigned char *name,
273 struct fat_slot_info *sinfo);
274extern int fat_get_dotdot_entry(struct inode *dir, struct buffer_head **bh,
Steven J. Magnani7669e8f2012-10-04 17:14:45 -0700275 struct msdos_dir_entry **de);
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800276extern int fat_alloc_new_dir(struct inode *dir, struct timespec *ts);
277extern int fat_add_entries(struct inode *dir, void *slots, int nr_slots,
278 struct fat_slot_info *sinfo);
279extern int fat_remove_entries(struct inode *dir, struct fat_slot_info *sinfo);
280
281/* fat/fatent.c */
282struct fat_entry {
283 int entry;
284 union {
285 u8 *ent12_p[2];
286 __le16 *ent16_p;
287 __le32 *ent32_p;
288 } u;
289 int nr_bhs;
290 struct buffer_head *bhs[2];
Al Virob5224122009-06-07 13:44:36 -0400291 struct inode *fat_inode;
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800292};
293
294static inline void fatent_init(struct fat_entry *fatent)
295{
296 fatent->nr_bhs = 0;
297 fatent->entry = 0;
298 fatent->u.ent32_p = NULL;
299 fatent->bhs[0] = fatent->bhs[1] = NULL;
Al Virob5224122009-06-07 13:44:36 -0400300 fatent->fat_inode = NULL;
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800301}
302
303static inline void fatent_set_entry(struct fat_entry *fatent, int entry)
304{
305 fatent->entry = entry;
306 fatent->u.ent32_p = NULL;
307}
308
309static inline void fatent_brelse(struct fat_entry *fatent)
310{
311 int i;
312 fatent->u.ent32_p = NULL;
313 for (i = 0; i < fatent->nr_bhs; i++)
314 brelse(fatent->bhs[i]);
315 fatent->nr_bhs = 0;
316 fatent->bhs[0] = fatent->bhs[1] = NULL;
Al Virob5224122009-06-07 13:44:36 -0400317 fatent->fat_inode = NULL;
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800318}
319
320extern void fat_ent_access_init(struct super_block *sb);
321extern int fat_ent_read(struct inode *inode, struct fat_entry *fatent,
322 int entry);
323extern int fat_ent_write(struct inode *inode, struct fat_entry *fatent,
324 int new, int wait);
325extern int fat_alloc_clusters(struct inode *inode, int *cluster,
326 int nr_cluster);
327extern int fat_free_clusters(struct inode *inode, int cluster);
328extern int fat_count_free_clusters(struct super_block *sb);
329
330/* fat/file.c */
Arnd Bergmann7845bc3e2010-05-17 08:13:47 +0900331extern long fat_generic_ioctl(struct file *filp, unsigned int cmd,
332 unsigned long arg);
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800333extern const struct file_operations fat_file_operations;
334extern const struct inode_operations fat_file_inode_operations;
Cruz Julian Bishopd5a4a382012-10-04 17:14:49 -0700335extern int fat_setattr(struct dentry *dentry, struct iattr *attr);
npiggin@suse.de459f6ed2010-05-27 01:05:38 +1000336extern void fat_truncate_blocks(struct inode *inode, loff_t offset);
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800337extern int fat_getattr(struct vfsmount *mnt, struct dentry *dentry,
338 struct kstat *stat);
Josef Bacik02c24a82011-07-16 20:44:56 -0400339extern int fat_file_fsync(struct file *file, loff_t start, loff_t end,
340 int datasync);
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800341
342/* fat/inode.c */
343extern void fat_attach(struct inode *inode, loff_t i_pos);
344extern void fat_detach(struct inode *inode);
345extern struct inode *fat_iget(struct super_block *sb, loff_t i_pos);
346extern struct inode *fat_build_inode(struct super_block *sb,
347 struct msdos_dir_entry *de, loff_t i_pos);
348extern int fat_sync_inode(struct inode *inode);
349extern int fat_fill_super(struct super_block *sb, void *data, int silent,
OGAWA Hirofumi384f5c92011-04-12 21:08:37 +0900350 int isvfat, void (*setup)(struct super_block *));
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800351
352extern int fat_flush_inodes(struct super_block *sb, struct inode *i1,
Cruz Julian Bishopd5a4a382012-10-04 17:14:49 -0700353 struct inode *i2);
Steven J. Magnani7669e8f2012-10-04 17:14:45 -0700354static inline unsigned long fat_dir_hash(int logstart)
Steven J. Magnani21b6633d52012-10-04 17:14:44 -0700355{
Steven J. Magnani7669e8f2012-10-04 17:14:45 -0700356 return hash_32(logstart, FAT_HASH_BITS);
Steven J. Magnani21b6633d52012-10-04 17:14:44 -0700357}
358
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800359/* fat/misc.c */
Joe Perchesb9075fa2011-10-31 17:11:33 -0700360extern __printf(3, 4) __cold
361void __fat_fs_error(struct super_block *sb, int report, const char *fmt, ...);
Alexey Fisher2c8a5ff2011-04-12 21:08:38 +0900362#define fat_fs_error(sb, fmt, args...) \
363 __fat_fs_error(sb, 1, fmt , ## args)
364#define fat_fs_error_ratelimit(sb, fmt, args...) \
365 __fat_fs_error(sb, __ratelimit(&MSDOS_SB(sb)->ratelimit), fmt , ## args)
Joe Perchesb9075fa2011-10-31 17:11:33 -0700366__printf(3, 4) __cold
367void fat_msg(struct super_block *sb, const char *level, const char *fmt, ...);
Namjae Jeonb742c342012-05-31 16:26:13 -0700368#define fat_msg_ratelimit(sb, level, fmt, args...) \
369 do { \
370 if (__ratelimit(&MSDOS_SB(sb)->ratelimit)) \
371 fat_msg(sb, level, fmt, ## args); \
372 } while (0)
OGAWA Hirofumied248b22009-09-20 01:31:58 +0900373extern int fat_clusters_flush(struct super_block *sb);
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800374extern int fat_chain_add(struct inode *inode, int new_dclus, int nr_cluster);
OGAWA Hirofumi7decd1c2008-11-06 12:53:47 -0800375extern void fat_time_fat2unix(struct msdos_sb_info *sbi, struct timespec *ts,
376 __le16 __time, __le16 __date, u8 time_cs);
377extern void fat_time_unix2fat(struct msdos_sb_info *sbi, struct timespec *ts,
378 __le16 *time, __le16 *date, u8 *time_cs);
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800379extern int fat_sync_bhs(struct buffer_head **bhs, int nr_bhs);
380
381int fat_cache_init(void);
382void fat_cache_destroy(void);
383
Steven J. Magnani21b6633d52012-10-04 17:14:44 -0700384/* fat/nfs.c */
385struct fid;
Steven J. Magnani21b6633d52012-10-04 17:14:44 -0700386extern struct dentry *fat_fh_to_dentry(struct super_block *sb, struct fid *fid,
387 int fh_len, int fh_type);
Steven J. Magnani7669e8f2012-10-04 17:14:45 -0700388extern struct dentry *fat_fh_to_parent(struct super_block *sb, struct fid *fid,
389 int fh_len, int fh_type);
Steven J. Magnani21b6633d52012-10-04 17:14:44 -0700390extern struct dentry *fat_get_parent(struct dentry *child_dir);
391
OGAWA Hirofumic3302932008-11-06 12:53:58 -0800392/* helper for printk */
393typedef unsigned long long llu;
394
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800395#endif /* !_FAT_H */