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