1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Copyright (C) 2012-2013 Samsung Electronics Co., Ltd.
10 #include <linux/ratelimit.h>
11 #include <linux/nls.h>
12 #include <linux/blkdev.h>
14 #define EXFAT_ROOT_INO 1
16 #define EXFAT_CLUSTERS_UNTRACKED (~0u)
21 enum exfat_error_mode {
22 EXFAT_ERRORS_CONT, /* ignore error and continue */
23 EXFAT_ERRORS_PANIC, /* panic on error */
24 EXFAT_ERRORS_RO, /* remount r/o on error */
28 * exfat nls lossy flag
31 NLS_NAME_NO_LOSSY = 0, /* no lossy */
32 NLS_NAME_LOSSY = 1 << 0, /* just detected incorrect filename(s) */
33 NLS_NAME_OVERLEN = 1 << 1, /* the length is over than its limit */
36 #define EXFAT_HASH_BITS 8
37 #define EXFAT_HASH_SIZE (1UL << EXFAT_HASH_BITS)
42 #define ES_2_ENTRIES 2
43 #define ES_ALL_ENTRIES 0
46 #define ES_IDX_STREAM 1
47 #define ES_IDX_FIRST_FILENAME 2
48 #define EXFAT_FILENAME_ENTRY_NUM(name_len) \
49 DIV_ROUND_UP(name_len, EXFAT_FILE_NAME_LEN)
50 #define ES_IDX_LAST_FILENAME(name_len) \
51 (ES_IDX_FIRST_FILENAME + EXFAT_FILENAME_ENTRY_NUM(name_len) - 1)
53 #define DIR_DELETED 0xFFFFFFF7
56 #define TYPE_UNUSED 0x0000
57 #define TYPE_DELETED 0x0001
58 #define TYPE_INVALID 0x0002
59 #define TYPE_CRITICAL_PRI 0x0100
60 #define TYPE_BITMAP 0x0101
61 #define TYPE_UPCASE 0x0102
62 #define TYPE_VOLUME 0x0103
63 #define TYPE_DIR 0x0104
64 #define TYPE_FILE 0x011F
65 #define TYPE_CRITICAL_SEC 0x0200
66 #define TYPE_STREAM 0x0201
67 #define TYPE_EXTEND 0x0202
68 #define TYPE_ACL 0x0203
69 #define TYPE_BENIGN_PRI 0x0400
70 #define TYPE_GUID 0x0401
71 #define TYPE_PADDING 0x0402
72 #define TYPE_ACLTAB 0x0403
73 #define TYPE_BENIGN_SEC 0x0800
74 #define TYPE_VENDOR_EXT 0x0801
75 #define TYPE_VENDOR_ALLOC 0x0802
77 #define MAX_CHARSET_SIZE 6 /* max size of multi-byte character */
78 #define MAX_NAME_LENGTH 255 /* max len of file name excluding NULL */
79 #define MAX_VFSNAME_BUF_SIZE ((MAX_NAME_LENGTH + 1) * MAX_CHARSET_SIZE)
81 #define EXFAT_HINT_NONE -1
82 #define EXFAT_MIN_SUBDIR 2
85 * helpers for cluster size to byte conversion.
87 #define EXFAT_CLU_TO_B(b, sbi) ((b) << (sbi)->cluster_size_bits)
88 #define EXFAT_B_TO_CLU(b, sbi) ((b) >> (sbi)->cluster_size_bits)
89 #define EXFAT_B_TO_CLU_ROUND_UP(b, sbi) \
90 (((b - 1) >> (sbi)->cluster_size_bits) + 1)
91 #define EXFAT_CLU_OFFSET(off, sbi) ((off) & ((sbi)->cluster_size - 1))
94 * helpers for block size to byte conversion.
96 #define EXFAT_BLK_TO_B(b, sb) ((b) << (sb)->s_blocksize_bits)
97 #define EXFAT_B_TO_BLK(b, sb) ((b) >> (sb)->s_blocksize_bits)
98 #define EXFAT_B_TO_BLK_ROUND_UP(b, sb) \
99 (((b - 1) >> (sb)->s_blocksize_bits) + 1)
100 #define EXFAT_BLK_OFFSET(off, sb) ((off) & ((sb)->s_blocksize - 1))
103 * helpers for block size to dentry size conversion.
105 #define EXFAT_B_TO_DEN(b) ((b) >> DENTRY_SIZE_BITS)
106 #define EXFAT_DEN_TO_B(b) ((b) << DENTRY_SIZE_BITS)
109 * helpers for cluster size to dentry size conversion.
111 #define EXFAT_CLU_TO_DEN(clu, sbi) \
112 ((clu) << ((sbi)->cluster_size_bits - DENTRY_SIZE_BITS))
113 #define EXFAT_DEN_TO_CLU(dentry, sbi) \
114 ((dentry) >> ((sbi)->cluster_size_bits - DENTRY_SIZE_BITS))
117 * helpers for fat entry.
119 #define FAT_ENT_SIZE (4)
120 #define FAT_ENT_SIZE_BITS (2)
121 #define FAT_ENT_OFFSET_SECTOR(sb, loc) (EXFAT_SB(sb)->FAT1_start_sector + \
122 (((u64)loc << FAT_ENT_SIZE_BITS) >> sb->s_blocksize_bits))
123 #define FAT_ENT_OFFSET_BYTE_IN_SECTOR(sb, loc) \
124 ((loc << FAT_ENT_SIZE_BITS) & (sb->s_blocksize - 1))
127 * helpers for bitmap.
129 #define CLUSTER_TO_BITMAP_ENT(clu) ((clu) - EXFAT_RESERVED_CLUSTERS)
130 #define BITMAP_ENT_TO_CLUSTER(ent) ((ent) + EXFAT_RESERVED_CLUSTERS)
131 #define BITS_PER_SECTOR(sb) ((sb)->s_blocksize * BITS_PER_BYTE)
132 #define BITS_PER_SECTOR_MASK(sb) (BITS_PER_SECTOR(sb) - 1)
133 #define BITMAP_OFFSET_SECTOR_INDEX(sb, ent) \
134 ((ent / BITS_PER_BYTE) >> (sb)->s_blocksize_bits)
135 #define BITMAP_OFFSET_BIT_IN_SECTOR(sb, ent) (ent & BITS_PER_SECTOR_MASK(sb))
136 #define BITMAP_OFFSET_BYTE_IN_SECTOR(sb, ent) \
137 ((ent / BITS_PER_BYTE) & ((sb)->s_blocksize - 1))
138 #define BITS_PER_BYTE_MASK 0x7
139 #define IGNORED_BITS_REMAINED(clu, clu_base) ((1 << ((clu) - (clu_base))) - 1)
141 #define ES_ENTRY_NUM(name_len) (ES_IDX_LAST_FILENAME(name_len) + 1)
142 /* 19 entries = 1 file entry + 1 stream entry + 17 filename entries */
143 #define ES_MAX_ENTRY_NUM ES_ENTRY_NUM(MAX_NAME_LENGTH)
146 * 19 entries x 32 bytes/entry = 608 bytes.
147 * The 608 bytes are in 3 sectors at most (even 512 Byte sector).
149 #define DIR_CACHE_SIZE \
150 (DIV_ROUND_UP(EXFAT_DEN_TO_B(ES_MAX_ENTRY_NUM), SECTOR_SIZE) + 1)
152 struct exfat_dentry_namebuf {
154 int lfnbuf_len; /* usually MAX_UNINAME_BUF_SIZE */
157 /* unicode name structure */
158 struct exfat_uni_name {
159 /* +3 for null and for converting */
160 unsigned short name[MAX_NAME_LENGTH + 3];
162 unsigned char name_len;
165 /* directory structure */
172 /* first empty entry hint information */
173 struct exfat_hint_femp {
174 /* entry index of a directory */
176 /* count of continuous empty entry */
178 /* the cluster that first empty slot exists in */
179 struct exfat_chain cur;
186 unsigned int off; /* cluster offset */
187 int eidx; /* entry index */
191 struct exfat_entry_set_cache {
192 struct super_block *sb;
193 unsigned int start_off;
195 struct buffer_head *__bh[DIR_CACHE_SIZE];
196 struct buffer_head **bh;
197 unsigned int num_entries;
201 #define IS_DYNAMIC_ES(es) ((es)->__bh != (es)->bh)
203 struct exfat_dir_entry {
204 struct exfat_chain dir;
207 unsigned int start_clu;
211 unsigned int num_subdirs;
212 struct timespec64 atime;
213 struct timespec64 mtime;
214 struct timespec64 crtime;
215 struct exfat_dentry_namebuf namebuf;
219 * exfat mount in-memory data
221 struct exfat_mount_options {
224 unsigned short fs_fmask;
225 unsigned short fs_dmask;
226 /* permission for setting the [am]time */
227 unsigned short allow_utime;
228 /* charset for filename input/display */
230 /* on error: continue, panic, remount-ro */
231 enum exfat_error_mode errors;
232 unsigned utf8:1, /* Use of UTF-8 character set */
233 sys_tz:1, /* Use local timezone */
234 discard:1, /* Issue discard requests on deletions */
235 keep_last_dots:1; /* Keep trailing periods in paths */
236 int time_offset; /* Offset of timestamps from UTC (in minutes) */
240 * EXFAT file system superblock in-memory data
242 struct exfat_sb_info {
243 unsigned long long num_sectors; /* num of sectors in volume */
244 unsigned int num_clusters; /* num of clusters in volume */
245 unsigned int cluster_size; /* cluster size in bytes */
246 unsigned int cluster_size_bits;
247 unsigned int sect_per_clus; /* cluster size in sectors */
248 unsigned int sect_per_clus_bits;
249 unsigned long long FAT1_start_sector; /* FAT1 start sector */
250 unsigned long long FAT2_start_sector; /* FAT2 start sector */
251 unsigned long long data_start_sector; /* data area start sector */
252 unsigned int num_FAT_sectors; /* num of FAT sectors */
253 unsigned int root_dir; /* root dir cluster */
254 unsigned int dentries_per_clu; /* num of dentries per cluster */
255 unsigned int vol_flags; /* volume flags */
256 unsigned int vol_flags_persistent; /* volume flags to retain */
257 struct buffer_head *boot_bh; /* buffer_head of BOOT sector */
259 unsigned int map_clu; /* allocation bitmap start cluster */
260 unsigned int map_sectors; /* num of allocation bitmap sectors */
261 struct buffer_head **vol_amap; /* allocation bitmap */
263 unsigned short *vol_utbl; /* upcase table */
265 unsigned int clu_srch_ptr; /* cluster search pointer */
266 unsigned int used_clusters; /* number of used clusters */
268 struct mutex s_lock; /* superblock lock */
269 struct mutex bitmap_lock; /* bitmap lock */
270 struct exfat_mount_options options;
271 struct nls_table *nls_io; /* Charset used for input and display */
272 struct ratelimit_state ratelimit;
274 spinlock_t inode_hash_lock;
275 struct hlist_head inode_hashtable[EXFAT_HASH_SIZE];
280 #define EXFAT_CACHE_VALID 0
283 * EXFAT file system inode in-memory data
285 struct exfat_inode_info {
286 struct exfat_chain dir;
290 unsigned int start_clu;
293 * the copy of low 32bit of i_version to check
294 * the validation of hint_stat.
296 unsigned int version;
298 /* hint for cluster last accessed */
299 struct exfat_hint hint_bmap;
300 /* hint for entry index we try to lookup next time */
301 struct exfat_hint hint_stat;
302 /* hint for first empty entry */
303 struct exfat_hint_femp hint_femp;
305 spinlock_t cache_lru_lock;
306 struct list_head cache_lru;
308 /* for avoiding the race between alloc and free */
309 unsigned int cache_valid_id;
312 * NOTE: i_size_ondisk is 64bits, so must hold ->inode_lock to access.
313 * physically allocated size.
315 loff_t i_size_ondisk;
316 /* block-aligned i_size (used in cont_write_begin) */
317 loff_t i_size_aligned;
318 /* on-disk position of directory entry or 0 */
320 /* hash by i_location */
321 struct hlist_node i_hash_fat;
322 /* protect bmap against truncate */
323 struct rw_semaphore truncate_lock;
324 struct inode vfs_inode;
325 /* File creation time */
326 struct timespec64 i_crtime;
329 static inline struct exfat_sb_info *EXFAT_SB(struct super_block *sb)
331 return sb->s_fs_info;
334 static inline struct exfat_inode_info *EXFAT_I(struct inode *inode)
336 return container_of(inode, struct exfat_inode_info, vfs_inode);
340 * If ->i_mode can't hold 0222 (i.e. ATTR_RO), we use ->i_attrs to
341 * save ATTR_RO instead of ->i_mode.
343 * If it's directory and !sbi->options.rodir, ATTR_RO isn't read-only
344 * bit, it's just used as flag for app.
346 static inline int exfat_mode_can_hold_ro(struct inode *inode)
348 struct exfat_sb_info *sbi = EXFAT_SB(inode->i_sb);
350 if (S_ISDIR(inode->i_mode))
353 if ((~sbi->options.fs_fmask) & 0222)
358 /* Convert attribute bits and a mask to the UNIX mode. */
359 static inline mode_t exfat_make_mode(struct exfat_sb_info *sbi,
360 unsigned short attr, mode_t mode)
362 if ((attr & ATTR_READONLY) && !(attr & ATTR_SUBDIR))
365 if (attr & ATTR_SUBDIR)
366 return (mode & ~sbi->options.fs_dmask) | S_IFDIR;
368 return (mode & ~sbi->options.fs_fmask) | S_IFREG;
371 /* Return the FAT attribute byte for this inode */
372 static inline unsigned short exfat_make_attr(struct inode *inode)
374 unsigned short attr = EXFAT_I(inode)->attr;
376 if (S_ISDIR(inode->i_mode))
378 if (exfat_mode_can_hold_ro(inode) && !(inode->i_mode & 0222))
379 attr |= ATTR_READONLY;
383 static inline void exfat_save_attr(struct inode *inode, unsigned short attr)
385 if (exfat_mode_can_hold_ro(inode))
386 EXFAT_I(inode)->attr = attr & (ATTR_RWMASK | ATTR_READONLY);
388 EXFAT_I(inode)->attr = attr & ATTR_RWMASK;
391 static inline bool exfat_is_last_sector_in_cluster(struct exfat_sb_info *sbi,
394 return ((sec - sbi->data_start_sector + 1) &
395 ((1 << sbi->sect_per_clus_bits) - 1)) == 0;
398 static inline sector_t exfat_cluster_to_sector(struct exfat_sb_info *sbi,
401 return ((sector_t)(clus - EXFAT_RESERVED_CLUSTERS) << sbi->sect_per_clus_bits) +
402 sbi->data_start_sector;
405 static inline unsigned int exfat_sector_to_cluster(struct exfat_sb_info *sbi,
408 return ((sec - sbi->data_start_sector) >> sbi->sect_per_clus_bits) +
409 EXFAT_RESERVED_CLUSTERS;
412 static inline bool is_valid_cluster(struct exfat_sb_info *sbi,
415 return clus >= EXFAT_FIRST_CLUSTER && clus < sbi->num_clusters;
419 int exfat_set_volume_dirty(struct super_block *sb);
420 int exfat_clear_volume_dirty(struct super_block *sb);
423 #define exfat_get_next_cluster(sb, pclu) exfat_ent_get(sb, *(pclu), pclu)
425 int exfat_alloc_cluster(struct inode *inode, unsigned int num_alloc,
426 struct exfat_chain *p_chain, bool sync_bmap);
427 int exfat_free_cluster(struct inode *inode, struct exfat_chain *p_chain);
428 int exfat_ent_get(struct super_block *sb, unsigned int loc,
429 unsigned int *content);
430 int exfat_ent_set(struct super_block *sb, unsigned int loc,
431 unsigned int content);
432 int exfat_count_ext_entries(struct super_block *sb, struct exfat_chain *p_dir,
433 int entry, struct exfat_dentry *p_entry);
434 int exfat_chain_cont_cluster(struct super_block *sb, unsigned int chain,
436 int exfat_zeroed_cluster(struct inode *dir, unsigned int clu);
437 int exfat_find_last_cluster(struct super_block *sb, struct exfat_chain *p_chain,
438 unsigned int *ret_clu);
439 int exfat_count_num_clusters(struct super_block *sb,
440 struct exfat_chain *p_chain, unsigned int *ret_count);
443 int exfat_load_bitmap(struct super_block *sb);
444 void exfat_free_bitmap(struct exfat_sb_info *sbi);
445 int exfat_set_bitmap(struct inode *inode, unsigned int clu, bool sync);
446 void exfat_clear_bitmap(struct inode *inode, unsigned int clu, bool sync);
447 unsigned int exfat_find_free_bitmap(struct super_block *sb, unsigned int clu);
448 int exfat_count_used_clusters(struct super_block *sb, unsigned int *ret_count);
449 int exfat_trim_fs(struct inode *inode, struct fstrim_range *range);
452 extern const struct file_operations exfat_file_operations;
453 int __exfat_truncate(struct inode *inode);
454 void exfat_truncate(struct inode *inode);
455 int exfat_setattr(struct mnt_idmap *idmap, struct dentry *dentry,
457 int exfat_getattr(struct mnt_idmap *idmap, const struct path *path,
458 struct kstat *stat, unsigned int request_mask,
459 unsigned int query_flags);
460 int exfat_file_fsync(struct file *file, loff_t start, loff_t end, int datasync);
461 long exfat_ioctl(struct file *filp, unsigned int cmd, unsigned long arg);
462 long exfat_compat_ioctl(struct file *filp, unsigned int cmd,
466 extern const struct dentry_operations exfat_dentry_ops;
467 extern const struct dentry_operations exfat_utf8_dentry_ops;
470 int exfat_cache_init(void);
471 void exfat_cache_shutdown(void);
472 void exfat_cache_inval_inode(struct inode *inode);
473 int exfat_get_cluster(struct inode *inode, unsigned int cluster,
474 unsigned int *fclus, unsigned int *dclus,
475 unsigned int *last_dclus, int allow_eof);
478 extern const struct inode_operations exfat_dir_inode_operations;
479 extern const struct file_operations exfat_dir_operations;
480 unsigned int exfat_get_entry_type(struct exfat_dentry *p_entry);
481 int exfat_init_dir_entry(struct inode *inode, struct exfat_chain *p_dir,
482 int entry, unsigned int type, unsigned int start_clu,
483 unsigned long long size);
484 int exfat_init_ext_entry(struct inode *inode, struct exfat_chain *p_dir,
485 int entry, int num_entries, struct exfat_uni_name *p_uniname);
486 int exfat_remove_entries(struct inode *inode, struct exfat_chain *p_dir,
487 int entry, int order, int num_entries);
488 int exfat_update_dir_chksum(struct inode *inode, struct exfat_chain *p_dir,
490 void exfat_update_dir_chksum_with_entry_set(struct exfat_entry_set_cache *es);
491 int exfat_calc_num_entries(struct exfat_uni_name *p_uniname);
492 int exfat_find_dir_entry(struct super_block *sb, struct exfat_inode_info *ei,
493 struct exfat_chain *p_dir, struct exfat_uni_name *p_uniname,
494 struct exfat_hint *hint_opt);
495 int exfat_alloc_new_dir(struct inode *inode, struct exfat_chain *clu);
496 struct exfat_dentry *exfat_get_dentry(struct super_block *sb,
497 struct exfat_chain *p_dir, int entry, struct buffer_head **bh);
498 struct exfat_dentry *exfat_get_dentry_cached(struct exfat_entry_set_cache *es,
500 int exfat_get_dentry_set(struct exfat_entry_set_cache *es,
501 struct super_block *sb, struct exfat_chain *p_dir, int entry,
503 int exfat_put_dentry_set(struct exfat_entry_set_cache *es, int sync);
504 int exfat_count_dir_entries(struct super_block *sb, struct exfat_chain *p_dir);
507 extern const struct inode_operations exfat_file_inode_operations;
508 void exfat_sync_inode(struct inode *inode);
509 struct inode *exfat_build_inode(struct super_block *sb,
510 struct exfat_dir_entry *info, loff_t i_pos);
511 void exfat_hash_inode(struct inode *inode, loff_t i_pos);
512 void exfat_unhash_inode(struct inode *inode);
513 struct inode *exfat_iget(struct super_block *sb, loff_t i_pos);
514 int __exfat_write_inode(struct inode *inode, int sync);
515 int exfat_write_inode(struct inode *inode, struct writeback_control *wbc);
516 void exfat_evict_inode(struct inode *inode);
517 int exfat_block_truncate_page(struct inode *inode, loff_t from);
520 unsigned short exfat_toupper(struct super_block *sb, unsigned short a);
521 int exfat_uniname_ncmp(struct super_block *sb, unsigned short *a,
522 unsigned short *b, unsigned int len);
523 int exfat_utf16_to_nls(struct super_block *sb,
524 struct exfat_uni_name *uniname, unsigned char *p_cstring,
526 int exfat_nls_to_utf16(struct super_block *sb,
527 const unsigned char *p_cstring, const int len,
528 struct exfat_uni_name *uniname, int *p_lossy);
529 int exfat_create_upcase_table(struct super_block *sb);
530 void exfat_free_upcase_table(struct exfat_sb_info *sbi);
533 void __exfat_fs_error(struct super_block *sb, int report, const char *fmt, ...)
534 __printf(3, 4) __cold;
535 #define exfat_fs_error(sb, fmt, args...) \
536 __exfat_fs_error(sb, 1, fmt, ## args)
537 #define exfat_fs_error_ratelimit(sb, fmt, args...) \
538 __exfat_fs_error(sb, __ratelimit(&EXFAT_SB(sb)->ratelimit), \
541 /* expand to pr_*() with prefix */
542 #define exfat_err(sb, fmt, ...) \
543 pr_err("exFAT-fs (%s): " fmt "\n", (sb)->s_id, ##__VA_ARGS__)
544 #define exfat_warn(sb, fmt, ...) \
545 pr_warn("exFAT-fs (%s): " fmt "\n", (sb)->s_id, ##__VA_ARGS__)
546 #define exfat_info(sb, fmt, ...) \
547 pr_info("exFAT-fs (%s): " fmt "\n", (sb)->s_id, ##__VA_ARGS__)
548 #define exfat_debug(sb, fmt, ...) \
549 pr_debug("exFAT-fs (%s): " fmt "\n", (sb)->s_id, ##__VA_ARGS__)
551 void exfat_get_entry_time(struct exfat_sb_info *sbi, struct timespec64 *ts,
552 u8 tz, __le16 time, __le16 date, u8 time_cs);
553 void exfat_truncate_atime(struct timespec64 *ts);
554 void exfat_set_entry_time(struct exfat_sb_info *sbi, struct timespec64 *ts,
555 u8 *tz, __le16 *time, __le16 *date, u8 *time_cs);
556 u16 exfat_calc_chksum16(void *data, int len, u16 chksum, int type);
557 u32 exfat_calc_chksum32(void *data, int len, u32 chksum, int type);
558 void exfat_update_bh(struct buffer_head *bh, int sync);
559 int exfat_update_bhs(struct buffer_head **bhs, int nr_bhs, int sync);
560 void exfat_chain_set(struct exfat_chain *ec, unsigned int dir,
561 unsigned int size, unsigned char flags);
562 void exfat_chain_dup(struct exfat_chain *dup, struct exfat_chain *ec);
564 #endif /* !_EXFAT_FS_H */