1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (C) 2012-2013 Samsung Electronics Co., Ltd.
6 #include <linux/fs_context.h>
7 #include <linux/fs_parser.h>
8 #include <linux/module.h>
9 #include <linux/init.h>
10 #include <linux/time.h>
11 #include <linux/mount.h>
12 #include <linux/cred.h>
13 #include <linux/statfs.h>
14 #include <linux/seq_file.h>
15 #include <linux/blkdev.h>
16 #include <linux/fs_struct.h>
17 #include <linux/iversion.h>
18 #include <linux/nls.h>
19 #include <linux/buffer_head.h>
21 #include "exfat_raw.h"
24 static char exfat_default_iocharset[] = CONFIG_EXFAT_DEFAULT_IOCHARSET;
25 static struct kmem_cache *exfat_inode_cachep;
27 static void exfat_free_iocharset(struct exfat_sb_info *sbi)
29 if (sbi->options.iocharset != exfat_default_iocharset)
30 kfree(sbi->options.iocharset);
33 static void exfat_delayed_free(struct rcu_head *p)
35 struct exfat_sb_info *sbi = container_of(p, struct exfat_sb_info, rcu);
37 unload_nls(sbi->nls_io);
38 exfat_free_iocharset(sbi);
39 exfat_free_upcase_table(sbi);
43 static void exfat_put_super(struct super_block *sb)
45 struct exfat_sb_info *sbi = EXFAT_SB(sb);
47 mutex_lock(&sbi->s_lock);
48 if (test_and_clear_bit(EXFAT_SB_DIRTY, &sbi->s_state))
49 sync_blockdev(sb->s_bdev);
50 exfat_set_vol_flags(sb, VOL_CLEAN);
51 exfat_free_bitmap(sbi);
53 mutex_unlock(&sbi->s_lock);
55 call_rcu(&sbi->rcu, exfat_delayed_free);
58 static int exfat_sync_fs(struct super_block *sb, int wait)
60 struct exfat_sb_info *sbi = EXFAT_SB(sb);
63 /* If there are some dirty buffers in the bdev inode */
64 mutex_lock(&sbi->s_lock);
65 if (test_and_clear_bit(EXFAT_SB_DIRTY, &sbi->s_state)) {
66 sync_blockdev(sb->s_bdev);
67 if (exfat_set_vol_flags(sb, VOL_CLEAN))
70 mutex_unlock(&sbi->s_lock);
74 static int exfat_statfs(struct dentry *dentry, struct kstatfs *buf)
76 struct super_block *sb = dentry->d_sb;
77 struct exfat_sb_info *sbi = EXFAT_SB(sb);
78 unsigned long long id = huge_encode_dev(sb->s_bdev->bd_dev);
80 if (sbi->used_clusters == EXFAT_CLUSTERS_UNTRACKED) {
81 mutex_lock(&sbi->s_lock);
82 if (exfat_count_used_clusters(sb, &sbi->used_clusters)) {
83 mutex_unlock(&sbi->s_lock);
86 mutex_unlock(&sbi->s_lock);
89 buf->f_type = sb->s_magic;
90 buf->f_bsize = sbi->cluster_size;
91 buf->f_blocks = sbi->num_clusters - 2; /* clu 0 & 1 */
92 buf->f_bfree = buf->f_blocks - sbi->used_clusters;
93 buf->f_bavail = buf->f_bfree;
94 buf->f_fsid.val[0] = (unsigned int)id;
95 buf->f_fsid.val[1] = (unsigned int)(id >> 32);
96 /* Unicode utf16 255 characters */
97 buf->f_namelen = EXFAT_MAX_FILE_LEN * NLS_MAX_CHARSET_SIZE;
101 int exfat_set_vol_flags(struct super_block *sb, unsigned short new_flag)
103 struct exfat_sb_info *sbi = EXFAT_SB(sb);
104 struct boot_sector *p_boot = (struct boot_sector *)sbi->boot_bh->b_data;
107 /* flags are not changed */
108 if (sbi->vol_flag == new_flag)
111 sbi->vol_flag = new_flag;
113 /* skip updating volume dirty flag,
114 * if this volume has been mounted with read-only
119 p_boot->vol_flags = cpu_to_le16(new_flag);
121 if (new_flag == VOL_DIRTY && !buffer_dirty(sbi->boot_bh))
126 set_buffer_uptodate(sbi->boot_bh);
127 mark_buffer_dirty(sbi->boot_bh);
130 sync_dirty_buffer(sbi->boot_bh);
134 static int exfat_show_options(struct seq_file *m, struct dentry *root)
136 struct super_block *sb = root->d_sb;
137 struct exfat_sb_info *sbi = EXFAT_SB(sb);
138 struct exfat_mount_options *opts = &sbi->options;
140 /* Show partition info */
141 if (!uid_eq(opts->fs_uid, GLOBAL_ROOT_UID))
142 seq_printf(m, ",uid=%u",
143 from_kuid_munged(&init_user_ns, opts->fs_uid));
144 if (!gid_eq(opts->fs_gid, GLOBAL_ROOT_GID))
145 seq_printf(m, ",gid=%u",
146 from_kgid_munged(&init_user_ns, opts->fs_gid));
147 seq_printf(m, ",fmask=%04o,dmask=%04o", opts->fs_fmask, opts->fs_dmask);
148 if (opts->allow_utime)
149 seq_printf(m, ",allow_utime=%04o", opts->allow_utime);
151 seq_puts(m, ",iocharset=utf8");
152 else if (sbi->nls_io)
153 seq_printf(m, ",iocharset=%s", sbi->nls_io->charset);
154 if (opts->errors == EXFAT_ERRORS_CONT)
155 seq_puts(m, ",errors=continue");
156 else if (opts->errors == EXFAT_ERRORS_PANIC)
157 seq_puts(m, ",errors=panic");
159 seq_puts(m, ",errors=remount-ro");
161 seq_puts(m, ",discard");
162 if (opts->time_offset)
163 seq_printf(m, ",time_offset=%d", opts->time_offset);
167 static struct inode *exfat_alloc_inode(struct super_block *sb)
169 struct exfat_inode_info *ei;
171 ei = kmem_cache_alloc(exfat_inode_cachep, GFP_NOFS);
175 init_rwsem(&ei->truncate_lock);
176 return &ei->vfs_inode;
179 static void exfat_free_inode(struct inode *inode)
181 kmem_cache_free(exfat_inode_cachep, EXFAT_I(inode));
184 static const struct super_operations exfat_sops = {
185 .alloc_inode = exfat_alloc_inode,
186 .free_inode = exfat_free_inode,
187 .write_inode = exfat_write_inode,
188 .evict_inode = exfat_evict_inode,
189 .put_super = exfat_put_super,
190 .sync_fs = exfat_sync_fs,
191 .statfs = exfat_statfs,
192 .show_options = exfat_show_options,
207 /* Deprecated options */
214 static const struct constant_table exfat_param_enums[] = {
215 { "continue", EXFAT_ERRORS_CONT },
216 { "panic", EXFAT_ERRORS_PANIC },
217 { "remount-ro", EXFAT_ERRORS_RO },
221 static const struct fs_parameter_spec exfat_parameters[] = {
222 fsparam_u32("uid", Opt_uid),
223 fsparam_u32("gid", Opt_gid),
224 fsparam_u32oct("umask", Opt_umask),
225 fsparam_u32oct("dmask", Opt_dmask),
226 fsparam_u32oct("fmask", Opt_fmask),
227 fsparam_u32oct("allow_utime", Opt_allow_utime),
228 fsparam_string("iocharset", Opt_charset),
229 fsparam_enum("errors", Opt_errors, exfat_param_enums),
230 fsparam_flag("discard", Opt_discard),
231 fsparam_s32("time_offset", Opt_time_offset),
232 __fsparam(NULL, "utf8", Opt_utf8, fs_param_deprecated,
234 __fsparam(NULL, "debug", Opt_debug, fs_param_deprecated,
236 __fsparam(fs_param_is_u32, "namecase", Opt_namecase,
237 fs_param_deprecated, NULL),
238 __fsparam(fs_param_is_u32, "codepage", Opt_codepage,
239 fs_param_deprecated, NULL),
243 static int exfat_parse_param(struct fs_context *fc, struct fs_parameter *param)
245 struct exfat_sb_info *sbi = fc->s_fs_info;
246 struct exfat_mount_options *opts = &sbi->options;
247 struct fs_parse_result result;
250 opt = fs_parse(fc, exfat_parameters, param, &result);
256 opts->fs_uid = make_kuid(current_user_ns(), result.uint_32);
259 opts->fs_gid = make_kgid(current_user_ns(), result.uint_32);
262 opts->fs_fmask = result.uint_32;
263 opts->fs_dmask = result.uint_32;
266 opts->fs_dmask = result.uint_32;
269 opts->fs_fmask = result.uint_32;
271 case Opt_allow_utime:
272 opts->allow_utime = result.uint_32 & 0022;
275 exfat_free_iocharset(sbi);
276 opts->iocharset = param->string;
277 param->string = NULL;
280 opts->errors = result.uint_32;
285 case Opt_time_offset:
287 * Make the limit 24 just in case someone invents something
290 if (result.int_32 < -24 * 60 || result.int_32 > 24 * 60)
292 opts->time_offset = result.int_32;
306 static void exfat_hash_init(struct super_block *sb)
308 struct exfat_sb_info *sbi = EXFAT_SB(sb);
311 spin_lock_init(&sbi->inode_hash_lock);
312 for (i = 0; i < EXFAT_HASH_SIZE; i++)
313 INIT_HLIST_HEAD(&sbi->inode_hashtable[i]);
316 static int exfat_read_root(struct inode *inode)
318 struct super_block *sb = inode->i_sb;
319 struct exfat_sb_info *sbi = EXFAT_SB(sb);
320 struct exfat_inode_info *ei = EXFAT_I(inode);
321 struct exfat_chain cdir;
322 int num_subdirs, num_clu = 0;
324 exfat_chain_set(&ei->dir, sbi->root_dir, 0, ALLOC_FAT_CHAIN);
326 ei->start_clu = sbi->root_dir;
327 ei->flags = ALLOC_FAT_CHAIN;
331 ei->hint_bmap.off = EXFAT_EOF_CLUSTER;
332 ei->hint_stat.eidx = 0;
333 ei->hint_stat.clu = sbi->root_dir;
334 ei->hint_femp.eidx = EXFAT_HINT_NONE;
336 exfat_chain_set(&cdir, sbi->root_dir, 0, ALLOC_FAT_CHAIN);
337 if (exfat_count_num_clusters(sb, &cdir, &num_clu))
339 i_size_write(inode, num_clu << sbi->cluster_size_bits);
341 num_subdirs = exfat_count_dir_entries(sb, &cdir);
344 set_nlink(inode, num_subdirs + EXFAT_MIN_SUBDIR);
346 inode->i_uid = sbi->options.fs_uid;
347 inode->i_gid = sbi->options.fs_gid;
348 inode_inc_iversion(inode);
349 inode->i_generation = 0;
350 inode->i_mode = exfat_make_mode(sbi, ATTR_SUBDIR, 0777);
351 inode->i_op = &exfat_dir_inode_operations;
352 inode->i_fop = &exfat_dir_operations;
354 inode->i_blocks = ((i_size_read(inode) + (sbi->cluster_size - 1))
355 & ~(sbi->cluster_size - 1)) >> inode->i_blkbits;
356 EXFAT_I(inode)->i_pos = ((loff_t)sbi->root_dir << 32) | 0xffffffff;
357 EXFAT_I(inode)->i_size_aligned = i_size_read(inode);
358 EXFAT_I(inode)->i_size_ondisk = i_size_read(inode);
360 exfat_save_attr(inode, ATTR_SUBDIR);
361 inode->i_mtime = inode->i_atime = inode->i_ctime = ei->i_crtime =
363 exfat_truncate_atime(&inode->i_atime);
364 exfat_cache_init_inode(inode);
368 static int exfat_calibrate_blocksize(struct super_block *sb, int logical_sect)
370 struct exfat_sb_info *sbi = EXFAT_SB(sb);
372 if (!is_power_of_2(logical_sect) ||
373 logical_sect < 512 || logical_sect > 4096) {
374 exfat_err(sb, "bogus logical sector size %u", logical_sect);
378 if (logical_sect < sb->s_blocksize) {
379 exfat_err(sb, "logical sector size too small for device (logical sector size = %u)",
384 if (logical_sect > sb->s_blocksize) {
385 brelse(sbi->boot_bh);
388 if (!sb_set_blocksize(sb, logical_sect)) {
389 exfat_err(sb, "unable to set blocksize %u",
393 sbi->boot_bh = sb_bread(sb, 0);
395 exfat_err(sb, "unable to read boot sector (logical sector size = %lu)",
403 static int exfat_read_boot_sector(struct super_block *sb)
405 struct boot_sector *p_boot;
406 struct exfat_sb_info *sbi = EXFAT_SB(sb);
408 /* set block size to read super block */
409 sb_min_blocksize(sb, 512);
411 /* read boot sector */
412 sbi->boot_bh = sb_bread(sb, 0);
414 exfat_err(sb, "unable to read boot sector");
417 p_boot = (struct boot_sector *)sbi->boot_bh->b_data;
419 /* check the validity of BOOT */
420 if (le16_to_cpu((p_boot->signature)) != BOOT_SIGNATURE) {
421 exfat_err(sb, "invalid boot record signature");
425 if (memcmp(p_boot->fs_name, STR_EXFAT, BOOTSEC_FS_NAME_LEN)) {
426 exfat_err(sb, "invalid fs_name"); /* fs_name may unprintable */
431 * must_be_zero field must be filled with zero to prevent mounting
434 if (memchr_inv(p_boot->must_be_zero, 0, sizeof(p_boot->must_be_zero)))
437 if (p_boot->num_fats != 1 && p_boot->num_fats != 2) {
438 exfat_err(sb, "bogus number of FAT structure");
442 sbi->sect_per_clus = 1 << p_boot->sect_per_clus_bits;
443 sbi->sect_per_clus_bits = p_boot->sect_per_clus_bits;
444 sbi->cluster_size_bits = p_boot->sect_per_clus_bits +
445 p_boot->sect_size_bits;
446 sbi->cluster_size = 1 << sbi->cluster_size_bits;
447 sbi->num_FAT_sectors = le32_to_cpu(p_boot->fat_length);
448 sbi->FAT1_start_sector = le32_to_cpu(p_boot->fat_offset);
449 sbi->FAT2_start_sector = le32_to_cpu(p_boot->fat_offset);
450 if (p_boot->num_fats == 2)
451 sbi->FAT2_start_sector += sbi->num_FAT_sectors;
452 sbi->data_start_sector = le32_to_cpu(p_boot->clu_offset);
453 sbi->num_sectors = le64_to_cpu(p_boot->vol_length);
454 /* because the cluster index starts with 2 */
455 sbi->num_clusters = le32_to_cpu(p_boot->clu_count) +
456 EXFAT_RESERVED_CLUSTERS;
458 sbi->root_dir = le32_to_cpu(p_boot->root_cluster);
459 sbi->dentries_per_clu = 1 <<
460 (sbi->cluster_size_bits - DENTRY_SIZE_BITS);
462 sbi->vol_flag = le16_to_cpu(p_boot->vol_flags);
463 sbi->clu_srch_ptr = EXFAT_FIRST_CLUSTER;
464 sbi->used_clusters = EXFAT_CLUSTERS_UNTRACKED;
466 /* check consistencies */
467 if (sbi->num_FAT_sectors << p_boot->sect_size_bits <
468 sbi->num_clusters * 4) {
469 exfat_err(sb, "bogus fat length");
472 if (sbi->data_start_sector <
473 sbi->FAT1_start_sector + sbi->num_FAT_sectors * p_boot->num_fats) {
474 exfat_err(sb, "bogus data start sector");
477 if (sbi->vol_flag & VOL_DIRTY)
478 exfat_warn(sb, "Volume was not properly unmounted. Some data may be corrupt. Please run fsck.");
479 if (sbi->vol_flag & ERR_MEDIUM)
480 exfat_warn(sb, "Medium has reported failures. Some data may be lost.");
482 /* exFAT file size is limited by a disk volume size */
483 sb->s_maxbytes = (u64)(sbi->num_clusters - EXFAT_RESERVED_CLUSTERS) <<
484 sbi->cluster_size_bits;
486 /* check logical sector size */
487 if (exfat_calibrate_blocksize(sb, 1 << p_boot->sect_size_bits))
493 static int exfat_verify_boot_region(struct super_block *sb)
495 struct buffer_head *bh = NULL;
497 __le32 *p_sig, *p_chksum;
500 /* read boot sector sub-regions */
501 for (sn = 0; sn < 11; sn++) {
502 bh = sb_bread(sb, sn);
506 if (sn != 0 && sn <= 8) {
507 /* extended boot sector sub-regions */
508 p_sig = (__le32 *)&bh->b_data[sb->s_blocksize - 4];
509 if (le32_to_cpu(*p_sig) != EXBOOT_SIGNATURE)
510 exfat_warn(sb, "Invalid exboot-signature(sector = %d): 0x%08x",
511 sn, le32_to_cpu(*p_sig));
514 chksum = exfat_calc_chksum32(bh->b_data, sb->s_blocksize,
515 chksum, sn ? CS_DEFAULT : CS_BOOT_SECTOR);
519 /* boot checksum sub-regions */
520 bh = sb_bread(sb, sn);
524 for (i = 0; i < sb->s_blocksize; i += sizeof(u32)) {
525 p_chksum = (__le32 *)&bh->b_data[i];
526 if (le32_to_cpu(*p_chksum) != chksum) {
527 exfat_err(sb, "Invalid boot checksum (boot checksum : 0x%08x, checksum : 0x%08x)",
528 le32_to_cpu(*p_chksum), chksum);
537 /* mount the file system volume */
538 static int __exfat_fill_super(struct super_block *sb)
541 struct exfat_sb_info *sbi = EXFAT_SB(sb);
543 ret = exfat_read_boot_sector(sb);
545 exfat_err(sb, "failed to read boot sector");
549 ret = exfat_verify_boot_region(sb);
551 exfat_err(sb, "invalid boot region");
555 ret = exfat_create_upcase_table(sb);
557 exfat_err(sb, "failed to load upcase table");
561 ret = exfat_load_bitmap(sb);
563 exfat_err(sb, "failed to load alloc-bitmap");
564 goto free_upcase_table;
567 ret = exfat_count_used_clusters(sb, &sbi->used_clusters);
569 exfat_err(sb, "failed to scan clusters");
570 goto free_alloc_bitmap;
576 exfat_free_bitmap(sbi);
578 exfat_free_upcase_table(sbi);
580 brelse(sbi->boot_bh);
584 static int exfat_fill_super(struct super_block *sb, struct fs_context *fc)
586 struct exfat_sb_info *sbi = sb->s_fs_info;
587 struct exfat_mount_options *opts = &sbi->options;
588 struct inode *root_inode;
591 if (opts->allow_utime == (unsigned short)-1)
592 opts->allow_utime = ~opts->fs_dmask & 0022;
595 struct request_queue *q = bdev_get_queue(sb->s_bdev);
597 if (!blk_queue_discard(q)) {
598 exfat_warn(sb, "mounting with \"discard\" option, but the device does not support discard");
603 sb->s_flags |= SB_NODIRATIME;
604 sb->s_magic = EXFAT_SUPER_MAGIC;
605 sb->s_op = &exfat_sops;
607 sb->s_time_gran = 10 * NSEC_PER_MSEC;
608 sb->s_time_min = EXFAT_MIN_TIMESTAMP_SECS;
609 sb->s_time_max = EXFAT_MAX_TIMESTAMP_SECS;
611 err = __exfat_fill_super(sb);
613 exfat_err(sb, "failed to recognize exfat type");
617 /* set up enough so that it can read an inode */
620 if (!strcmp(sbi->options.iocharset, "utf8"))
623 sbi->nls_io = load_nls(sbi->options.iocharset);
625 exfat_err(sb, "IO charset %s not found",
626 sbi->options.iocharset);
632 if (sbi->options.utf8)
633 sb->s_d_op = &exfat_utf8_dentry_ops;
635 sb->s_d_op = &exfat_dentry_ops;
637 root_inode = new_inode(sb);
639 exfat_err(sb, "failed to allocate root inode");
644 root_inode->i_ino = EXFAT_ROOT_INO;
645 inode_set_iversion(root_inode, 1);
646 err = exfat_read_root(root_inode);
648 exfat_err(sb, "failed to initialize root inode");
652 exfat_hash_inode(root_inode, EXFAT_I(root_inode)->i_pos);
653 insert_inode_hash(root_inode);
655 sb->s_root = d_make_root(root_inode);
657 exfat_err(sb, "failed to get the root dentry");
669 exfat_free_upcase_table(sbi);
670 exfat_free_bitmap(sbi);
671 brelse(sbi->boot_bh);
674 unload_nls(sbi->nls_io);
675 exfat_free_iocharset(sbi);
676 sb->s_fs_info = NULL;
681 static int exfat_get_tree(struct fs_context *fc)
683 return get_tree_bdev(fc, exfat_fill_super);
686 static void exfat_free(struct fs_context *fc)
688 struct exfat_sb_info *sbi = fc->s_fs_info;
691 exfat_free_iocharset(sbi);
696 static int exfat_reconfigure(struct fs_context *fc)
698 fc->sb_flags |= SB_NODIRATIME;
700 /* volume flag will be updated in exfat_sync_fs */
701 sync_filesystem(fc->root->d_sb);
705 static const struct fs_context_operations exfat_context_ops = {
706 .parse_param = exfat_parse_param,
707 .get_tree = exfat_get_tree,
709 .reconfigure = exfat_reconfigure,
712 static int exfat_init_fs_context(struct fs_context *fc)
714 struct exfat_sb_info *sbi;
716 sbi = kzalloc(sizeof(struct exfat_sb_info), GFP_KERNEL);
720 mutex_init(&sbi->s_lock);
721 ratelimit_state_init(&sbi->ratelimit, DEFAULT_RATELIMIT_INTERVAL,
722 DEFAULT_RATELIMIT_BURST);
724 sbi->options.fs_uid = current_uid();
725 sbi->options.fs_gid = current_gid();
726 sbi->options.fs_fmask = current->fs->umask;
727 sbi->options.fs_dmask = current->fs->umask;
728 sbi->options.allow_utime = -1;
729 sbi->options.iocharset = exfat_default_iocharset;
730 sbi->options.errors = EXFAT_ERRORS_RO;
733 fc->ops = &exfat_context_ops;
737 static struct file_system_type exfat_fs_type = {
738 .owner = THIS_MODULE,
740 .init_fs_context = exfat_init_fs_context,
741 .parameters = exfat_parameters,
742 .kill_sb = kill_block_super,
743 .fs_flags = FS_REQUIRES_DEV,
746 static void exfat_inode_init_once(void *foo)
748 struct exfat_inode_info *ei = (struct exfat_inode_info *)foo;
750 INIT_HLIST_NODE(&ei->i_hash_fat);
751 inode_init_once(&ei->vfs_inode);
754 static int __init init_exfat_fs(void)
758 err = exfat_cache_init();
762 exfat_inode_cachep = kmem_cache_create("exfat_inode_cache",
763 sizeof(struct exfat_inode_info),
764 0, SLAB_RECLAIM_ACCOUNT | SLAB_MEM_SPREAD,
765 exfat_inode_init_once);
766 if (!exfat_inode_cachep) {
771 err = register_filesystem(&exfat_fs_type);
778 kmem_cache_destroy(exfat_inode_cachep);
780 exfat_cache_shutdown();
784 static void __exit exit_exfat_fs(void)
787 * Make sure all delayed rcu free inodes are flushed before we
791 kmem_cache_destroy(exfat_inode_cachep);
792 unregister_filesystem(&exfat_fs_type);
793 exfat_cache_shutdown();
796 module_init(init_exfat_fs);
797 module_exit(exit_exfat_fs);
799 MODULE_ALIAS_FS("exfat");
800 MODULE_LICENSE("GPL");
801 MODULE_DESCRIPTION("exFAT filesystem support");
802 MODULE_AUTHOR("Samsung Electronics Co., Ltd.");