blob: f50408901f7ea55eb3c2dfa54ae936051ad9c5fc [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>
8#include <linux/mutex.h>
OGAWA Hirofumiaaa04b42010-05-24 14:33:12 -07009#include <linux/ratelimit.h>
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080010#include <linux/msdos_fs.h>
11
12/*
13 * vfat shortname flags
14 */
15#define VFAT_SFN_DISPLAY_LOWER 0x0001 /* convert to lowercase for display */
16#define VFAT_SFN_DISPLAY_WIN95 0x0002 /* emulate win95 rule for display */
17#define VFAT_SFN_DISPLAY_WINNT 0x0004 /* emulate winnt rule for display */
18#define VFAT_SFN_CREATE_WIN95 0x0100 /* emulate win95 rule for create */
19#define VFAT_SFN_CREATE_WINNT 0x0200 /* emulate winnt rule for create */
20
Denis Karpov85c78592009-06-04 02:34:22 +090021#define FAT_ERRORS_CONT 1 /* ignore error and continue */
22#define FAT_ERRORS_PANIC 2 /* panic on error */
23#define FAT_ERRORS_RO 3 /* remount r/o on error */
24
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080025struct fat_mount_options {
26 uid_t fs_uid;
27 gid_t fs_gid;
28 unsigned short fs_fmask;
29 unsigned short fs_dmask;
30 unsigned short codepage; /* Codepage for shortname conversions */
31 char *iocharset; /* Charset used for filename input/display */
32 unsigned short shortname; /* flags for shortname display/create rule */
33 unsigned char name_check; /* r = relaxed, n = normal, s = strict */
Denis Karpov85c78592009-06-04 02:34:22 +090034 unsigned char errors; /* On error: continue, panic, remount-ro */
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080035 unsigned short allow_utime;/* permission for setting the [am]time */
36 unsigned quiet:1, /* set = fake successful chmods and chowns */
37 showexec:1, /* set = only set x bit for com/exe/bat */
38 sys_immutable:1, /* set = system files are immutable */
39 dotsOK:1, /* set = hidden and system files are named '.filename' */
40 isvfat:1, /* 0=no vfat long filename support, 1=vfat support */
41 utf8:1, /* Use of UTF-8 character set (Default) */
42 unicode_xlate:1, /* create escape sequences for unhandled Unicode */
43 numtail:1, /* Does first alias have a numeric '~1' type tail? */
44 flush:1, /* write things quickly */
45 nocase:1, /* Does this need case conversion? 0=need case conversion*/
46 usefree:1, /* Use free_clusters for FAT32 */
OGAWA Hirofumidfc209c2008-11-06 12:53:55 -080047 tz_utc:1, /* Filesystem timestamps are in UTC */
Christoph Hellwig681142f2009-11-21 20:28:52 +090048 rodir:1, /* allow ATTR_RO for directory */
49 discard:1; /* Issue discard requests on deletions */
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080050};
51
52#define FAT_HASH_BITS 8
53#define FAT_HASH_SIZE (1UL << FAT_HASH_BITS)
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080054
55/*
56 * MS-DOS file system in-core superblock data
57 */
58struct msdos_sb_info {
59 unsigned short sec_per_clus; /* sectors/cluster */
60 unsigned short cluster_bits; /* log2(cluster_size) */
61 unsigned int cluster_size; /* cluster size */
62 unsigned char fats,fat_bits; /* number of FATs, FAT bits (12 or 16) */
63 unsigned short fat_start;
64 unsigned long fat_length; /* FAT start & length (sec.) */
65 unsigned long dir_start;
66 unsigned short dir_entries; /* root dir start & entries */
67 unsigned long data_start; /* first data sector */
68 unsigned long max_cluster; /* maximum cluster number */
69 unsigned long root_cluster; /* first cluster of the root directory */
70 unsigned long fsinfo_sector; /* sector number of FAT32 fsinfo */
71 struct mutex fat_lock;
72 unsigned int prev_free; /* previously allocated cluster number */
73 unsigned int free_clusters; /* -1 if undefined */
74 unsigned int free_clus_valid; /* is free_clusters valid? */
75 struct fat_mount_options options;
76 struct nls_table *nls_disk; /* Codepage used on disk */
77 struct nls_table *nls_io; /* Charset used for input and display */
78 const void *dir_ops; /* Opaque; default directory operations */
79 int dir_per_block; /* dir entries per block */
80 int dir_per_block_bits; /* log2(dir_per_block) */
81
82 int fatent_shift;
83 struct fatent_operations *fatent_ops;
Al Virob5224122009-06-07 13:44:36 -040084 struct inode *fat_inode;
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080085
OGAWA Hirofumiaaa04b42010-05-24 14:33:12 -070086 struct ratelimit_state ratelimit;
87
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -080088 spinlock_t inode_hash_lock;
89 struct hlist_head inode_hashtable[FAT_HASH_SIZE];
90};
91
92#define FAT_CACHE_VALID 0 /* special case for valid cache */
93
94/*
95 * MS-DOS file system inode data in memory
96 */
97struct msdos_inode_info {
98 spinlock_t cache_lru_lock;
99 struct list_head cache_lru;
100 int nr_caches;
101 /* for avoiding the race between fat_free() and fat_get_cluster() */
102 unsigned int cache_valid_id;
103
OGAWA Hirofumi2bdf67e2008-11-06 12:53:57 -0800104 /* NOTE: mmu_private is 64bits, so must hold ->i_mutex to access */
105 loff_t mmu_private; /* physically allocated size */
106
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800107 int i_start; /* first cluster or 0 */
108 int i_logstart; /* logical first cluster */
109 int i_attrs; /* unused attribute bits */
110 loff_t i_pos; /* on-disk position of directory entry or 0 */
111 struct hlist_node i_fat_hash; /* hash by i_location */
112 struct inode vfs_inode;
113};
114
115struct fat_slot_info {
116 loff_t i_pos; /* on-disk position of directory entry */
117 loff_t slot_off; /* offset for slot or de start */
118 int nr_slots; /* number of slots + 1(de) in filename */
119 struct msdos_dir_entry *de;
120 struct buffer_head *bh;
121};
122
123static inline struct msdos_sb_info *MSDOS_SB(struct super_block *sb)
124{
125 return sb->s_fs_info;
126}
127
128static inline struct msdos_inode_info *MSDOS_I(struct inode *inode)
129{
130 return container_of(inode, struct msdos_inode_info, vfs_inode);
131}
132
OGAWA Hirofumi91834822008-11-06 12:53:54 -0800133/*
134 * If ->i_mode can't hold S_IWUGO (i.e. ATTR_RO), we use ->i_attrs to
135 * save ATTR_RO instead of ->i_mode.
OGAWA Hirofumidfc209c2008-11-06 12:53:55 -0800136 *
137 * If it's directory and !sbi->options.rodir, ATTR_RO isn't read-only
138 * bit, it's just used as flag for app.
OGAWA Hirofumi91834822008-11-06 12:53:54 -0800139 */
140static inline int fat_mode_can_hold_ro(struct inode *inode)
141{
142 struct msdos_sb_info *sbi = MSDOS_SB(inode->i_sb);
143 mode_t mask;
144
OGAWA Hirofumidfc209c2008-11-06 12:53:55 -0800145 if (S_ISDIR(inode->i_mode)) {
146 if (!sbi->options.rodir)
147 return 0;
OGAWA Hirofumi91834822008-11-06 12:53:54 -0800148 mask = ~sbi->options.fs_dmask;
OGAWA Hirofumidfc209c2008-11-06 12:53:55 -0800149 } else
OGAWA Hirofumi91834822008-11-06 12:53:54 -0800150 mask = ~sbi->options.fs_fmask;
151
152 if (!(mask & S_IWUGO))
153 return 0;
154 return 1;
155}
156
OGAWA Hirofumi9c0aa1b2008-11-06 12:53:54 -0800157/* Convert attribute bits and a mask to the UNIX mode. */
158static inline mode_t fat_make_mode(struct msdos_sb_info *sbi,
159 u8 attrs, mode_t mode)
160{
OGAWA Hirofumidfc209c2008-11-06 12:53:55 -0800161 if (attrs & ATTR_RO && !((attrs & ATTR_DIR) && !sbi->options.rodir))
OGAWA Hirofumi9c0aa1b2008-11-06 12:53:54 -0800162 mode &= ~S_IWUGO;
163
164 if (attrs & ATTR_DIR)
165 return (mode & ~sbi->options.fs_dmask) | S_IFDIR;
166 else
167 return (mode & ~sbi->options.fs_fmask) | S_IFREG;
168}
169
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800170/* Return the FAT attribute byte for this inode */
OGAWA Hirofumi9c0aa1b2008-11-06 12:53:54 -0800171static inline u8 fat_make_attrs(struct inode *inode)
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800172{
OGAWA Hirofumi91834822008-11-06 12:53:54 -0800173 u8 attrs = MSDOS_I(inode)->i_attrs;
174 if (S_ISDIR(inode->i_mode))
175 attrs |= ATTR_DIR;
176 if (fat_mode_can_hold_ro(inode) && !(inode->i_mode & S_IWUGO))
177 attrs |= ATTR_RO;
178 return attrs;
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800179}
180
OGAWA Hirofumi9c0aa1b2008-11-06 12:53:54 -0800181static inline void fat_save_attrs(struct inode *inode, u8 attrs)
182{
OGAWA Hirofumi91834822008-11-06 12:53:54 -0800183 if (fat_mode_can_hold_ro(inode))
184 MSDOS_I(inode)->i_attrs = attrs & ATTR_UNUSED;
185 else
186 MSDOS_I(inode)->i_attrs = attrs & (ATTR_UNUSED | ATTR_RO);
OGAWA Hirofumi9c0aa1b2008-11-06 12:53:54 -0800187}
188
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800189static inline unsigned char fat_checksum(const __u8 *name)
190{
191 unsigned char s = name[0];
192 s = (s<<7) + (s>>1) + name[1]; s = (s<<7) + (s>>1) + name[2];
193 s = (s<<7) + (s>>1) + name[3]; s = (s<<7) + (s>>1) + name[4];
194 s = (s<<7) + (s>>1) + name[5]; s = (s<<7) + (s>>1) + name[6];
195 s = (s<<7) + (s>>1) + name[7]; s = (s<<7) + (s>>1) + name[8];
196 s = (s<<7) + (s>>1) + name[9]; s = (s<<7) + (s>>1) + name[10];
197 return s;
198}
199
200static inline sector_t fat_clus_to_blknr(struct msdos_sb_info *sbi, int clus)
201{
202 return ((sector_t)clus - FAT_START_ENT) * sbi->sec_per_clus
203 + sbi->data_start;
204}
205
206static inline void fat16_towchar(wchar_t *dst, const __u8 *src, size_t len)
207{
208#ifdef __BIG_ENDIAN
209 while (len--) {
210 *dst++ = src[0] | (src[1] << 8);
211 src += 2;
212 }
213#else
214 memcpy(dst, src, len * 2);
215#endif
216}
217
218static inline void fatwchar_to16(__u8 *dst, const wchar_t *src, size_t len)
219{
220#ifdef __BIG_ENDIAN
221 while (len--) {
222 dst[0] = *src & 0x00FF;
223 dst[1] = (*src & 0xFF00) >> 8;
224 dst += 2;
225 src++;
226 }
227#else
228 memcpy(dst, src, len * 2);
229#endif
230}
231
232/* fat/cache.c */
233extern void fat_cache_inval_inode(struct inode *inode);
234extern int fat_get_cluster(struct inode *inode, int cluster,
235 int *fclus, int *dclus);
236extern int fat_bmap(struct inode *inode, sector_t sector, sector_t *phys,
OGAWA Hirofumi2bdf67e2008-11-06 12:53:57 -0800237 unsigned long *mapped_blocks, int create);
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800238
239/* fat/dir.c */
240extern const struct file_operations fat_dir_operations;
241extern int fat_search_long(struct inode *inode, const unsigned char *name,
242 int name_len, struct fat_slot_info *sinfo);
243extern int fat_dir_empty(struct inode *dir);
244extern int fat_subdirs(struct inode *dir);
245extern int fat_scan(struct inode *dir, const unsigned char *name,
246 struct fat_slot_info *sinfo);
247extern int fat_get_dotdot_entry(struct inode *dir, struct buffer_head **bh,
248 struct msdos_dir_entry **de, loff_t *i_pos);
249extern int fat_alloc_new_dir(struct inode *dir, struct timespec *ts);
250extern int fat_add_entries(struct inode *dir, void *slots, int nr_slots,
251 struct fat_slot_info *sinfo);
252extern int fat_remove_entries(struct inode *dir, struct fat_slot_info *sinfo);
253
254/* fat/fatent.c */
255struct fat_entry {
256 int entry;
257 union {
258 u8 *ent12_p[2];
259 __le16 *ent16_p;
260 __le32 *ent32_p;
261 } u;
262 int nr_bhs;
263 struct buffer_head *bhs[2];
Al Virob5224122009-06-07 13:44:36 -0400264 struct inode *fat_inode;
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800265};
266
267static inline void fatent_init(struct fat_entry *fatent)
268{
269 fatent->nr_bhs = 0;
270 fatent->entry = 0;
271 fatent->u.ent32_p = NULL;
272 fatent->bhs[0] = fatent->bhs[1] = NULL;
Al Virob5224122009-06-07 13:44:36 -0400273 fatent->fat_inode = NULL;
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800274}
275
276static inline void fatent_set_entry(struct fat_entry *fatent, int entry)
277{
278 fatent->entry = entry;
279 fatent->u.ent32_p = NULL;
280}
281
282static inline void fatent_brelse(struct fat_entry *fatent)
283{
284 int i;
285 fatent->u.ent32_p = NULL;
286 for (i = 0; i < fatent->nr_bhs; i++)
287 brelse(fatent->bhs[i]);
288 fatent->nr_bhs = 0;
289 fatent->bhs[0] = fatent->bhs[1] = NULL;
Al Virob5224122009-06-07 13:44:36 -0400290 fatent->fat_inode = NULL;
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800291}
292
293extern void fat_ent_access_init(struct super_block *sb);
294extern int fat_ent_read(struct inode *inode, struct fat_entry *fatent,
295 int entry);
296extern int fat_ent_write(struct inode *inode, struct fat_entry *fatent,
297 int new, int wait);
298extern int fat_alloc_clusters(struct inode *inode, int *cluster,
299 int nr_cluster);
300extern int fat_free_clusters(struct inode *inode, int cluster);
301extern int fat_count_free_clusters(struct super_block *sb);
302
303/* fat/file.c */
Arnd Bergmann7845bc3e2010-05-17 08:13:47 +0900304extern long fat_generic_ioctl(struct file *filp, unsigned int cmd,
305 unsigned long arg);
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800306extern const struct file_operations fat_file_operations;
307extern const struct inode_operations fat_file_inode_operations;
308extern int fat_setattr(struct dentry * dentry, struct iattr * attr);
npiggin@suse.de459f6ed2010-05-27 01:05:38 +1000309extern void fat_truncate_blocks(struct inode *inode, loff_t offset);
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800310extern int fat_getattr(struct vfsmount *mnt, struct dentry *dentry,
311 struct kstat *stat);
Christoph Hellwig7ea80852010-05-26 17:53:25 +0200312extern int fat_file_fsync(struct file *file, int datasync);
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800313
314/* fat/inode.c */
315extern void fat_attach(struct inode *inode, loff_t i_pos);
316extern void fat_detach(struct inode *inode);
317extern struct inode *fat_iget(struct super_block *sb, loff_t i_pos);
318extern struct inode *fat_build_inode(struct super_block *sb,
319 struct msdos_dir_entry *de, loff_t i_pos);
320extern int fat_sync_inode(struct inode *inode);
321extern int fat_fill_super(struct super_block *sb, void *data, int silent,
Al Viro3d239852010-12-18 10:44:00 -0500322 const struct inode_operations *fs_dir_inode_ops,
323 int isvfat, void (*setup)(struct super_block *));
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800324
325extern int fat_flush_inodes(struct super_block *sb, struct inode *i1,
326 struct inode *i2);
327/* fat/misc.c */
OGAWA Hirofumiaaa04b42010-05-24 14:33:12 -0700328extern void
329__fat_fs_error(struct super_block *s, int report, const char *fmt, ...)
330 __attribute__ ((format (printf, 3, 4))) __cold;
331#define fat_fs_error(s, fmt, args...) \
332 __fat_fs_error(s, 1, fmt , ## args)
333#define fat_fs_error_ratelimit(s, fmt, args...) \
334 __fat_fs_error(s, __ratelimit(&MSDOS_SB(s)->ratelimit), fmt , ## args)
OGAWA Hirofumied248b22009-09-20 01:31:58 +0900335extern int fat_clusters_flush(struct super_block *sb);
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800336extern int fat_chain_add(struct inode *inode, int new_dclus, int nr_cluster);
OGAWA Hirofumi7decd1c2008-11-06 12:53:47 -0800337extern void fat_time_fat2unix(struct msdos_sb_info *sbi, struct timespec *ts,
338 __le16 __time, __le16 __date, u8 time_cs);
339extern void fat_time_unix2fat(struct msdos_sb_info *sbi, struct timespec *ts,
340 __le16 *time, __le16 *date, u8 *time_cs);
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800341extern int fat_sync_bhs(struct buffer_head **bhs, int nr_bhs);
342
343int fat_cache_init(void);
344void fat_cache_destroy(void);
345
OGAWA Hirofumic3302932008-11-06 12:53:58 -0800346/* helper for printk */
347typedef unsigned long long llu;
348
OGAWA Hirofumi9e975da2008-11-06 12:53:46 -0800349#endif /* !_FAT_H */