import PULS_20160108
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / fs / fat / fat.h
CommitLineData
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 29struct fat_mount_options {
170782eb
EB
30 kuid_t fs_uid;
31 kgid_t fs_gid;
9e975dae
OH
32 unsigned short fs_fmask;
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 */
64struct 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;
8fceb4e0 78 struct mutex nfs_build_inode_lock;
e40b34c7
MS
79 struct mutex s_lock;
80 unsigned int prev_free; /* previously allocated cluster number */
81 unsigned int free_clusters; /* -1 if undefined */
9e975dae
OH
82 unsigned int free_clus_valid; /* is free_clusters valid? */
83 struct fat_mount_options options;
4a3aeb13
CJB
84 struct nls_table *nls_disk; /* Codepage used on disk */
85 struct nls_table *nls_io; /* Charset used for input and display */
86 const void *dir_ops; /* Opaque; default directory operations */
87 int dir_per_block; /* dir entries per block */
88 int dir_per_block_bits; /* log2(dir_per_block) */
6fa3eb70 89 unsigned long vol_id; /* volume ID */
9e975dae
OH
90
91 int fatent_shift;
92 struct fatent_operations *fatent_ops;
b522412a 93 struct inode *fat_inode;
020ac5b6 94 struct inode *fsinfo_inode;
9e975dae 95
aaa04b48
OH
96 struct ratelimit_state ratelimit;
97
9e975dae
OH
98 spinlock_t inode_hash_lock;
99 struct hlist_head inode_hashtable[FAT_HASH_SIZE];
7669e8fb
SM
100
101 spinlock_t dir_hash_lock;
102 struct hlist_head dir_hashtable[FAT_HASH_SIZE];
b88a1058
OR
103
104 unsigned int dirty; /* fs state before mount */
9e975dae
OH
105};
106
107#define FAT_CACHE_VALID 0 /* special case for valid cache */
108
109/*
110 * MS-DOS file system inode data in memory
111 */
112struct msdos_inode_info {
113 spinlock_t cache_lru_lock;
114 struct list_head cache_lru;
115 int nr_caches;
116 /* for avoiding the race between fat_free() and fat_get_cluster() */
117 unsigned int cache_valid_id;
118
2bdf67eb
OH
119 /* NOTE: mmu_private is 64bits, so must hold ->i_mutex to access */
120 loff_t mmu_private; /* physically allocated size */
121
9e975dae
OH
122 int i_start; /* first cluster or 0 */
123 int i_logstart; /* logical first cluster */
124 int i_attrs; /* unused attribute bits */
125 loff_t i_pos; /* on-disk position of directory entry or 0 */
126 struct hlist_node i_fat_hash; /* hash by i_location */
7669e8fb 127 struct hlist_node i_dir_hash; /* hash by i_logstart */
58268691 128 struct rw_semaphore truncate_lock; /* protect bmap against truncate */
9e975dae
OH
129 struct inode vfs_inode;
130};
131
132struct fat_slot_info {
133 loff_t i_pos; /* on-disk position of directory entry */
134 loff_t slot_off; /* offset for slot or de start */
135 int nr_slots; /* number of slots + 1(de) in filename */
136 struct msdos_dir_entry *de;
137 struct buffer_head *bh;
138};
139
140static inline struct msdos_sb_info *MSDOS_SB(struct super_block *sb)
141{
142 return sb->s_fs_info;
143}
144
145static inline struct msdos_inode_info *MSDOS_I(struct inode *inode)
146{
147 return container_of(inode, struct msdos_inode_info, vfs_inode);
148}
149
9183482f
OH
150/*
151 * If ->i_mode can't hold S_IWUGO (i.e. ATTR_RO), we use ->i_attrs to
152 * save ATTR_RO instead of ->i_mode.
dfc209c0
OH
153 *
154 * If it's directory and !sbi->options.rodir, ATTR_RO isn't read-only
155 * bit, it's just used as flag for app.
9183482f
OH
156 */
157static inline int fat_mode_can_hold_ro(struct inode *inode)
158{
159 struct msdos_sb_info *sbi = MSDOS_SB(inode->i_sb);
dacd0e7b 160 umode_t mask;
9183482f 161
dfc209c0
OH
162 if (S_ISDIR(inode->i_mode)) {
163 if (!sbi->options.rodir)
164 return 0;
9183482f 165 mask = ~sbi->options.fs_dmask;
dfc209c0 166 } else
9183482f
OH
167 mask = ~sbi->options.fs_fmask;
168
169 if (!(mask & S_IWUGO))
170 return 0;
171 return 1;
172}
173
9c0aa1b8 174/* Convert attribute bits and a mask to the UNIX mode. */
dacd0e7b
AV
175static inline umode_t fat_make_mode(struct msdos_sb_info *sbi,
176 u8 attrs, umode_t mode)
9c0aa1b8 177{
dfc209c0 178 if (attrs & ATTR_RO && !((attrs & ATTR_DIR) && !sbi->options.rodir))
9c0aa1b8
OH
179 mode &= ~S_IWUGO;
180
181 if (attrs & ATTR_DIR)
182 return (mode & ~sbi->options.fs_dmask) | S_IFDIR;
183 else
184 return (mode & ~sbi->options.fs_fmask) | S_IFREG;
185}
186
9e975dae 187/* Return the FAT attribute byte for this inode */
9c0aa1b8 188static inline u8 fat_make_attrs(struct inode *inode)
9e975dae 189{
9183482f
OH
190 u8 attrs = MSDOS_I(inode)->i_attrs;
191 if (S_ISDIR(inode->i_mode))
192 attrs |= ATTR_DIR;
193 if (fat_mode_can_hold_ro(inode) && !(inode->i_mode & S_IWUGO))
194 attrs |= ATTR_RO;
195 return attrs;
9e975dae
OH
196}
197
9c0aa1b8
OH
198static inline void fat_save_attrs(struct inode *inode, u8 attrs)
199{
9183482f
OH
200 if (fat_mode_can_hold_ro(inode))
201 MSDOS_I(inode)->i_attrs = attrs & ATTR_UNUSED;
202 else
203 MSDOS_I(inode)->i_attrs = attrs & (ATTR_UNUSED | ATTR_RO);
9c0aa1b8
OH
204}
205
9e975dae
OH
206static inline unsigned char fat_checksum(const __u8 *name)
207{
208 unsigned char s = name[0];
209 s = (s<<7) + (s>>1) + name[1]; s = (s<<7) + (s>>1) + name[2];
210 s = (s<<7) + (s>>1) + name[3]; s = (s<<7) + (s>>1) + name[4];
211 s = (s<<7) + (s>>1) + name[5]; s = (s<<7) + (s>>1) + name[6];
212 s = (s<<7) + (s>>1) + name[7]; s = (s<<7) + (s>>1) + name[8];
213 s = (s<<7) + (s>>1) + name[9]; s = (s<<7) + (s>>1) + name[10];
214 return s;
215}
216
217static inline sector_t fat_clus_to_blknr(struct msdos_sb_info *sbi, int clus)
218{
219 return ((sector_t)clus - FAT_START_ENT) * sbi->sec_per_clus
220 + sbi->data_start;
221}
222
e22a4442
NJ
223static inline void fat_get_blknr_offset(struct msdos_sb_info *sbi,
224 loff_t i_pos, sector_t *blknr, int *offset)
225{
226 *blknr = i_pos >> sbi->dir_per_block_bits;
227 *offset = i_pos & (sbi->dir_per_block - 1);
228}
229
f21735d5
NJ
230static inline loff_t fat_i_pos_read(struct msdos_sb_info *sbi,
231 struct inode *inode)
232{
233 loff_t i_pos;
234#if BITS_PER_LONG == 32
235 spin_lock(&sbi->inode_hash_lock);
236#endif
237 i_pos = MSDOS_I(inode)->i_pos;
238#if BITS_PER_LONG == 32
239 spin_unlock(&sbi->inode_hash_lock);
240#endif
241 return i_pos;
242}
243
9e975dae
OH
244static inline void fat16_towchar(wchar_t *dst, const __u8 *src, size_t len)
245{
246#ifdef __BIG_ENDIAN
247 while (len--) {
248 *dst++ = src[0] | (src[1] << 8);
249 src += 2;
250 }
251#else
252 memcpy(dst, src, len * 2);
253#endif
254}
255
a943ed71
SM
256static inline int fat_get_start(const struct msdos_sb_info *sbi,
257 const struct msdos_dir_entry *de)
258{
259 int cluster = le16_to_cpu(de->start);
260 if (sbi->fat_bits == 32)
261 cluster |= (le16_to_cpu(de->starthi) << 16);
262 return cluster;
263}
264
265static inline void fat_set_start(struct msdos_dir_entry *de, int cluster)
266{
267 de->start = cpu_to_le16(cluster);
268 de->starthi = cpu_to_le16(cluster >> 16);
269}
270
9e975dae
OH
271static inline void fatwchar_to16(__u8 *dst, const wchar_t *src, size_t len)
272{
273#ifdef __BIG_ENDIAN
274 while (len--) {
275 dst[0] = *src & 0x00FF;
276 dst[1] = (*src & 0xFF00) >> 8;
277 dst += 2;
278 src++;
279 }
280#else
281 memcpy(dst, src, len * 2);
282#endif
283}
284
285/* fat/cache.c */
286extern void fat_cache_inval_inode(struct inode *inode);
287extern int fat_get_cluster(struct inode *inode, int cluster,
288 int *fclus, int *dclus);
289extern int fat_bmap(struct inode *inode, sector_t sector, sector_t *phys,
2bdf67eb 290 unsigned long *mapped_blocks, int create);
9e975dae
OH
291
292/* fat/dir.c */
293extern const struct file_operations fat_dir_operations;
294extern int fat_search_long(struct inode *inode, const unsigned char *name,
295 int name_len, struct fat_slot_info *sinfo);
296extern int fat_dir_empty(struct inode *dir);
297extern int fat_subdirs(struct inode *dir);
298extern int fat_scan(struct inode *dir, const unsigned char *name,
299 struct fat_slot_info *sinfo);
f1e6fb0a
NJ
300extern int fat_scan_logstart(struct inode *dir, int i_logstart,
301 struct fat_slot_info *sinfo);
9e975dae 302extern int fat_get_dotdot_entry(struct inode *dir, struct buffer_head **bh,
7669e8fb 303 struct msdos_dir_entry **de);
9e975dae
OH
304extern int fat_alloc_new_dir(struct inode *dir, struct timespec *ts);
305extern int fat_add_entries(struct inode *dir, void *slots, int nr_slots,
306 struct fat_slot_info *sinfo);
307extern int fat_remove_entries(struct inode *dir, struct fat_slot_info *sinfo);
308
309/* fat/fatent.c */
310struct fat_entry {
311 int entry;
312 union {
313 u8 *ent12_p[2];
314 __le16 *ent16_p;
315 __le32 *ent32_p;
316 } u;
317 int nr_bhs;
318 struct buffer_head *bhs[2];
b522412a 319 struct inode *fat_inode;
9e975dae
OH
320};
321
322static inline void fatent_init(struct fat_entry *fatent)
323{
324 fatent->nr_bhs = 0;
325 fatent->entry = 0;
326 fatent->u.ent32_p = NULL;
327 fatent->bhs[0] = fatent->bhs[1] = NULL;
b522412a 328 fatent->fat_inode = NULL;
9e975dae
OH
329}
330
331static inline void fatent_set_entry(struct fat_entry *fatent, int entry)
332{
333 fatent->entry = entry;
334 fatent->u.ent32_p = NULL;
335}
336
337static inline void fatent_brelse(struct fat_entry *fatent)
338{
339 int i;
340 fatent->u.ent32_p = NULL;
341 for (i = 0; i < fatent->nr_bhs; i++)
342 brelse(fatent->bhs[i]);
343 fatent->nr_bhs = 0;
344 fatent->bhs[0] = fatent->bhs[1] = NULL;
b522412a 345 fatent->fat_inode = NULL;
9e975dae
OH
346}
347
348extern void fat_ent_access_init(struct super_block *sb);
349extern int fat_ent_read(struct inode *inode, struct fat_entry *fatent,
350 int entry);
351extern int fat_ent_write(struct inode *inode, struct fat_entry *fatent,
352 int new, int wait);
353extern int fat_alloc_clusters(struct inode *inode, int *cluster,
354 int nr_cluster);
355extern int fat_free_clusters(struct inode *inode, int cluster);
356extern int fat_count_free_clusters(struct super_block *sb);
357
358/* fat/file.c */
7845bc3e
AB
359extern long fat_generic_ioctl(struct file *filp, unsigned int cmd,
360 unsigned long arg);
9e975dae
OH
361extern const struct file_operations fat_file_operations;
362extern const struct inode_operations fat_file_inode_operations;
d5a4a386 363extern int fat_setattr(struct dentry *dentry, struct iattr *attr);
459f6ed3 364extern void fat_truncate_blocks(struct inode *inode, loff_t offset);
9e975dae
OH
365extern int fat_getattr(struct vfsmount *mnt, struct dentry *dentry,
366 struct kstat *stat);
02c24a82
JB
367extern int fat_file_fsync(struct file *file, loff_t start, loff_t end,
368 int datasync);
9e975dae
OH
369
370/* fat/inode.c */
371extern void fat_attach(struct inode *inode, loff_t i_pos);
372extern void fat_detach(struct inode *inode);
373extern struct inode *fat_iget(struct super_block *sb, loff_t i_pos);
374extern struct inode *fat_build_inode(struct super_block *sb,
375 struct msdos_dir_entry *de, loff_t i_pos);
376extern int fat_sync_inode(struct inode *inode);
377extern int fat_fill_super(struct super_block *sb, void *data, int silent,
384f5c96 378 int isvfat, void (*setup)(struct super_block *));
f1e6fb0a 379extern int fat_fill_inode(struct inode *inode, struct msdos_dir_entry *de);
9e975dae
OH
380
381extern int fat_flush_inodes(struct super_block *sb, struct inode *i1,
d5a4a386 382 struct inode *i2);
7669e8fb 383static inline unsigned long fat_dir_hash(int logstart)
21b6633d 384{
7669e8fb 385 return hash_32(logstart, FAT_HASH_BITS);
21b6633d
SM
386}
387
9e975dae 388/* fat/misc.c */
b9075fa9
JP
389extern __printf(3, 4) __cold
390void __fat_fs_error(struct super_block *sb, int report, const char *fmt, ...);
2c8a5ffb
AF
391#define fat_fs_error(sb, fmt, args...) \
392 __fat_fs_error(sb, 1, fmt , ## args)
393#define fat_fs_error_ratelimit(sb, fmt, args...) \
394 __fat_fs_error(sb, __ratelimit(&MSDOS_SB(sb)->ratelimit), fmt , ## args)
b9075fa9
JP
395__printf(3, 4) __cold
396void fat_msg(struct super_block *sb, const char *level, const char *fmt, ...);
b742c341
NJ
397#define fat_msg_ratelimit(sb, level, fmt, args...) \
398 do { \
399 if (__ratelimit(&MSDOS_SB(sb)->ratelimit)) \
400 fat_msg(sb, level, fmt, ## args); \
401 } while (0)
ed248b29 402extern int fat_clusters_flush(struct super_block *sb);
9e975dae 403extern int fat_chain_add(struct inode *inode, int new_dclus, int nr_cluster);
7decd1cb
OH
404extern void fat_time_fat2unix(struct msdos_sb_info *sbi, struct timespec *ts,
405 __le16 __time, __le16 __date, u8 time_cs);
406extern void fat_time_unix2fat(struct msdos_sb_info *sbi, struct timespec *ts,
407 __le16 *time, __le16 *date, u8 *time_cs);
9e975dae
OH
408extern int fat_sync_bhs(struct buffer_head **bhs, int nr_bhs);
409
410int fat_cache_init(void);
411void fat_cache_destroy(void);
412
21b6633d 413/* fat/nfs.c */
ea3983ac
NJ
414extern const struct export_operations fat_export_ops;
415extern const struct export_operations fat_export_ops_nostale;
21b6633d 416
c3302931
OH
417/* helper for printk */
418typedef unsigned long long llu;
419
9e975dae 420#endif /* !_FAT_H */