xref: /linux/fs/exfat/super.c (revision bba2c3615bd6cfee7456d1130f2e6b01b3f4e9ba)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  Copyright (C) 2012-2013 Samsung Electronics Co., Ltd.
4  */
5 
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>
20 #include <linux/magic.h>
21 
22 #include "exfat_raw.h"
23 #include "exfat_fs.h"
24 
25 static char exfat_default_iocharset[] = CONFIG_EXFAT_DEFAULT_IOCHARSET;
26 static struct kmem_cache *exfat_inode_cachep;
27 
28 static void exfat_free_iocharset(struct exfat_sb_info *sbi)
29 {
30 	if (sbi->options.iocharset != exfat_default_iocharset)
31 		kfree(sbi->options.iocharset);
32 }
33 
34 static void exfat_set_iocharset(struct exfat_mount_options *opts,
35 				char *iocharset)
36 {
37 	opts->iocharset = iocharset;
38 	if (!strcmp(opts->iocharset, "utf8"))
39 		opts->utf8 = 1;
40 	else
41 		opts->utf8 = 0;
42 }
43 
44 static void exfat_put_super(struct super_block *sb)
45 {
46 	struct exfat_sb_info *sbi = EXFAT_SB(sb);
47 
48 	mutex_lock(&sbi->s_lock);
49 	exfat_clear_volume_dirty(sb);
50 	exfat_free_bitmap(sbi);
51 	brelse(sbi->boot_bh);
52 	mutex_unlock(&sbi->s_lock);
53 }
54 
55 static int exfat_statfs(struct dentry *dentry, struct kstatfs *buf)
56 {
57 	struct super_block *sb = dentry->d_sb;
58 	struct exfat_sb_info *sbi = EXFAT_SB(sb);
59 	unsigned long long id = huge_encode_dev(sb->s_bdev->bd_dev);
60 
61 	buf->f_type = sb->s_magic;
62 	buf->f_bsize = sbi->cluster_size;
63 	buf->f_blocks = sbi->num_clusters - 2; /* clu 0 & 1 */
64 	buf->f_bfree = buf->f_blocks - sbi->used_clusters;
65 	buf->f_bavail = buf->f_bfree;
66 	buf->f_fsid = u64_to_fsid(id);
67 	/* Unicode utf16 255 characters */
68 	buf->f_namelen = EXFAT_MAX_FILE_LEN * NLS_MAX_CHARSET_SIZE;
69 	return 0;
70 }
71 
72 static int exfat_set_vol_flags(struct super_block *sb, unsigned short new_flags)
73 {
74 	struct exfat_sb_info *sbi = EXFAT_SB(sb);
75 	struct boot_sector *p_boot = (struct boot_sector *)sbi->boot_bh->b_data;
76 
77 	/* retain persistent-flags */
78 	new_flags |= sbi->vol_flags_persistent;
79 
80 	/* flags are not changed */
81 	if (sbi->vol_flags == new_flags)
82 		return 0;
83 
84 	sbi->vol_flags = new_flags;
85 
86 	/* skip updating volume dirty flag,
87 	 * if this volume has been mounted with read-only
88 	 */
89 	if (sb_rdonly(sb))
90 		return 0;
91 
92 	p_boot->vol_flags = cpu_to_le16(new_flags);
93 
94 	set_buffer_uptodate(sbi->boot_bh);
95 	mark_buffer_dirty(sbi->boot_bh);
96 
97 	__sync_dirty_buffer(sbi->boot_bh, REQ_SYNC | REQ_FUA | REQ_PREFLUSH);
98 
99 	return 0;
100 }
101 
102 int exfat_set_volume_dirty(struct super_block *sb)
103 {
104 	struct exfat_sb_info *sbi = EXFAT_SB(sb);
105 
106 	return exfat_set_vol_flags(sb, sbi->vol_flags | VOLUME_DIRTY);
107 }
108 
109 int exfat_clear_volume_dirty(struct super_block *sb)
110 {
111 	struct exfat_sb_info *sbi = EXFAT_SB(sb);
112 
113 	return exfat_set_vol_flags(sb, sbi->vol_flags & ~VOLUME_DIRTY);
114 }
115 
116 static int exfat_show_options(struct seq_file *m, struct dentry *root)
117 {
118 	struct super_block *sb = root->d_sb;
119 	struct exfat_sb_info *sbi = EXFAT_SB(sb);
120 	struct exfat_mount_options *opts = &sbi->options;
121 
122 	/* Show partition info */
123 	if (!uid_eq(opts->fs_uid, GLOBAL_ROOT_UID))
124 		seq_printf(m, ",uid=%u",
125 				from_kuid_munged(&init_user_ns, opts->fs_uid));
126 	if (!gid_eq(opts->fs_gid, GLOBAL_ROOT_GID))
127 		seq_printf(m, ",gid=%u",
128 				from_kgid_munged(&init_user_ns, opts->fs_gid));
129 	seq_printf(m, ",fmask=%04o,dmask=%04o", opts->fs_fmask, opts->fs_dmask);
130 	if (opts->allow_utime)
131 		seq_printf(m, ",allow_utime=%04o", opts->allow_utime);
132 	if (opts->utf8)
133 		seq_puts(m, ",iocharset=utf8");
134 	else if (sbi->nls_io)
135 		seq_printf(m, ",iocharset=%s", sbi->nls_io->charset);
136 	if (opts->errors == EXFAT_ERRORS_CONT)
137 		seq_puts(m, ",errors=continue");
138 	else if (opts->errors == EXFAT_ERRORS_PANIC)
139 		seq_puts(m, ",errors=panic");
140 	else
141 		seq_puts(m, ",errors=remount-ro");
142 	if (opts->discard)
143 		seq_puts(m, ",discard");
144 	if (opts->keep_last_dots)
145 		seq_puts(m, ",keep_last_dots");
146 	if (opts->sys_tz)
147 		seq_puts(m, ",sys_tz");
148 	else if (opts->time_offset)
149 		seq_printf(m, ",time_offset=%d", opts->time_offset);
150 	if (opts->zero_size_dir)
151 		seq_puts(m, ",zero_size_dir");
152 	return 0;
153 }
154 
155 int exfat_force_shutdown(struct super_block *sb, u32 flags)
156 {
157 	int ret;
158 	struct exfat_sb_info *sbi = sb->s_fs_info;
159 	struct exfat_mount_options *opts = &sbi->options;
160 
161 	if (exfat_forced_shutdown(sb))
162 		return 0;
163 
164 	switch (flags) {
165 	case EXFAT_GOING_DOWN_DEFAULT:
166 	case EXFAT_GOING_DOWN_FULLSYNC:
167 		ret = bdev_freeze(sb->s_bdev);
168 		if (ret)
169 			return ret;
170 		bdev_thaw(sb->s_bdev);
171 		set_bit(EXFAT_FLAGS_SHUTDOWN, &sbi->s_exfat_flags);
172 		break;
173 	case EXFAT_GOING_DOWN_NOSYNC:
174 		set_bit(EXFAT_FLAGS_SHUTDOWN, &sbi->s_exfat_flags);
175 		break;
176 	default:
177 		return -EINVAL;
178 	}
179 
180 	if (opts->discard)
181 		opts->discard = 0;
182 	return 0;
183 }
184 
185 static void exfat_shutdown(struct super_block *sb)
186 {
187 	exfat_force_shutdown(sb, EXFAT_GOING_DOWN_NOSYNC);
188 }
189 
190 static struct inode *exfat_alloc_inode(struct super_block *sb)
191 {
192 	struct exfat_inode_info *ei;
193 
194 	ei = alloc_inode_sb(sb, exfat_inode_cachep, GFP_NOFS);
195 	if (!ei)
196 		return NULL;
197 
198 	init_rwsem(&ei->truncate_lock);
199 	return &ei->vfs_inode;
200 }
201 
202 static void exfat_free_inode(struct inode *inode)
203 {
204 	kmem_cache_free(exfat_inode_cachep, EXFAT_I(inode));
205 }
206 
207 static const struct super_operations exfat_sops = {
208 	.alloc_inode	= exfat_alloc_inode,
209 	.free_inode	= exfat_free_inode,
210 	.write_inode	= exfat_write_inode,
211 	.evict_inode	= exfat_evict_inode,
212 	.put_super	= exfat_put_super,
213 	.statfs		= exfat_statfs,
214 	.show_options	= exfat_show_options,
215 	.shutdown	= exfat_shutdown,
216 };
217 
218 enum {
219 	Opt_uid,
220 	Opt_gid,
221 	Opt_umask,
222 	Opt_dmask,
223 	Opt_fmask,
224 	Opt_allow_utime,
225 	Opt_charset,
226 	Opt_errors,
227 	Opt_discard,
228 	Opt_keep_last_dots,
229 	Opt_sys_tz,
230 	Opt_time_offset,
231 	Opt_zero_size_dir,
232 
233 	/* Deprecated options */
234 	Opt_utf8,
235 	Opt_debug,
236 	Opt_namecase,
237 	Opt_codepage,
238 };
239 
240 static const struct constant_table exfat_param_enums[] = {
241 	{ "continue",		EXFAT_ERRORS_CONT },
242 	{ "panic",		EXFAT_ERRORS_PANIC },
243 	{ "remount-ro",		EXFAT_ERRORS_RO },
244 	{}
245 };
246 
247 static const struct fs_parameter_spec exfat_parameters[] = {
248 	fsparam_uid("uid",			Opt_uid),
249 	fsparam_gid("gid",			Opt_gid),
250 	fsparam_u32oct("umask",			Opt_umask),
251 	fsparam_u32oct("dmask",			Opt_dmask),
252 	fsparam_u32oct("fmask",			Opt_fmask),
253 	fsparam_u32oct("allow_utime",		Opt_allow_utime),
254 	fsparam_string("iocharset",		Opt_charset),
255 	fsparam_enum("errors",			Opt_errors, exfat_param_enums),
256 	fsparam_flag_no("discard",		Opt_discard),
257 	fsparam_flag("keep_last_dots",		Opt_keep_last_dots),
258 	fsparam_flag("sys_tz",			Opt_sys_tz),
259 	fsparam_s32("time_offset",		Opt_time_offset),
260 	fsparam_flag_no("zero_size_dir",	Opt_zero_size_dir),
261 	__fsparam(NULL, "utf8",			Opt_utf8, fs_param_deprecated,
262 		  NULL),
263 	__fsparam(NULL, "debug",		Opt_debug, fs_param_deprecated,
264 		  NULL),
265 	__fsparam(fs_param_is_u32, "namecase",	Opt_namecase,
266 		  fs_param_deprecated, NULL),
267 	__fsparam(fs_param_is_u32, "codepage",	Opt_codepage,
268 		  fs_param_deprecated, NULL),
269 	{}
270 };
271 
272 static int exfat_parse_param(struct fs_context *fc, struct fs_parameter *param)
273 {
274 	struct exfat_sb_info *sbi = fc->s_fs_info;
275 	struct exfat_mount_options *opts = &sbi->options;
276 	struct fs_parse_result result;
277 	int opt;
278 
279 	opt = fs_parse(fc, exfat_parameters, param, &result);
280 	if (opt < 0)
281 		return opt;
282 
283 	switch (opt) {
284 	case Opt_uid:
285 		opts->fs_uid = result.uid;
286 		break;
287 	case Opt_gid:
288 		opts->fs_gid = result.gid;
289 		break;
290 	case Opt_umask:
291 		opts->fs_fmask = result.uint_32;
292 		opts->fs_dmask = result.uint_32;
293 		break;
294 	case Opt_dmask:
295 		opts->fs_dmask = result.uint_32;
296 		break;
297 	case Opt_fmask:
298 		opts->fs_fmask = result.uint_32;
299 		break;
300 	case Opt_allow_utime:
301 		opts->allow_utime = result.uint_32 & 0022;
302 		break;
303 	case Opt_charset:
304 		exfat_free_iocharset(sbi);
305 		exfat_set_iocharset(opts, param->string);
306 		param->string = NULL;
307 		break;
308 	case Opt_errors:
309 		opts->errors = result.uint_32;
310 		break;
311 	case Opt_discard:
312 		opts->discard = !result.negated;
313 		break;
314 	case Opt_keep_last_dots:
315 		opts->keep_last_dots = 1;
316 		break;
317 	case Opt_sys_tz:
318 		opts->sys_tz = 1;
319 		break;
320 	case Opt_time_offset:
321 		/*
322 		 * Make the limit 24 just in case someone invents something
323 		 * unusual.
324 		 */
325 		if (result.int_32 < -24 * 60 || result.int_32 > 24 * 60)
326 			return -EINVAL;
327 		opts->time_offset = result.int_32;
328 		break;
329 	case Opt_zero_size_dir:
330 		opts->zero_size_dir = !result.negated;
331 		break;
332 	case Opt_utf8:
333 	case Opt_debug:
334 	case Opt_namecase:
335 	case Opt_codepage:
336 		break;
337 	default:
338 		return -EINVAL;
339 	}
340 
341 	return 0;
342 }
343 
344 static void exfat_hash_init(struct super_block *sb)
345 {
346 	struct exfat_sb_info *sbi = EXFAT_SB(sb);
347 	int i;
348 
349 	spin_lock_init(&sbi->inode_hash_lock);
350 	for (i = 0; i < EXFAT_HASH_SIZE; i++)
351 		INIT_HLIST_HEAD(&sbi->inode_hashtable[i]);
352 }
353 
354 static int exfat_read_root(struct inode *inode, struct exfat_chain *root_clu)
355 {
356 	struct super_block *sb = inode->i_sb;
357 	struct exfat_sb_info *sbi = EXFAT_SB(sb);
358 	struct exfat_inode_info *ei = EXFAT_I(inode);
359 	int num_subdirs;
360 
361 	exfat_chain_set(&ei->dir, sbi->root_dir, 0, ALLOC_FAT_CHAIN);
362 	ei->entry = -1;
363 	ei->start_clu = sbi->root_dir;
364 	ei->flags = ALLOC_FAT_CHAIN;
365 	ei->type = TYPE_DIR;
366 	ei->version = 0;
367 	ei->hint_bmap.off = EXFAT_EOF_CLUSTER;
368 	ei->hint_stat.eidx = 0;
369 	ei->hint_stat.clu = sbi->root_dir;
370 	ei->hint_femp.eidx = EXFAT_HINT_NONE;
371 
372 	i_size_write(inode, exfat_cluster_to_bytes(sbi, root_clu->size));
373 
374 	num_subdirs = exfat_count_dir_entries(sb, root_clu);
375 	if (num_subdirs < 0)
376 		return -EIO;
377 	set_nlink(inode, num_subdirs + EXFAT_MIN_SUBDIR);
378 
379 	inode->i_uid = sbi->options.fs_uid;
380 	inode->i_gid = sbi->options.fs_gid;
381 	inode_inc_iversion(inode);
382 	inode->i_generation = 0;
383 	inode->i_mode = exfat_make_mode(sbi, EXFAT_ATTR_SUBDIR, 0777);
384 	inode->i_op = &exfat_dir_inode_operations;
385 	inode->i_fop = &exfat_dir_operations;
386 
387 	inode->i_blocks = round_up(i_size_read(inode), sbi->cluster_size) >> 9;
388 	ei->i_pos = ((loff_t)sbi->root_dir << 32) | 0xffffffff;
389 
390 	exfat_save_attr(inode, EXFAT_ATTR_SUBDIR);
391 	ei->i_crtime = simple_inode_init_ts(inode);
392 	exfat_truncate_inode_atime(inode);
393 	return 0;
394 }
395 
396 static int exfat_calibrate_blocksize(struct super_block *sb, int logical_sect)
397 {
398 	struct exfat_sb_info *sbi = EXFAT_SB(sb);
399 
400 	if (!is_power_of_2(logical_sect)) {
401 		exfat_err(sb, "bogus logical sector size %u", logical_sect);
402 		return -EIO;
403 	}
404 
405 	if (logical_sect < sb->s_blocksize) {
406 		exfat_err(sb, "logical sector size too small for device (logical sector size = %u)",
407 			  logical_sect);
408 		return -EIO;
409 	}
410 
411 	if (logical_sect > sb->s_blocksize) {
412 		brelse(sbi->boot_bh);
413 		sbi->boot_bh = NULL;
414 
415 		if (!sb_set_blocksize(sb, logical_sect)) {
416 			exfat_err(sb, "unable to set blocksize %u",
417 				  logical_sect);
418 			return -EIO;
419 		}
420 		sbi->boot_bh = sb_bread(sb, 0);
421 		if (!sbi->boot_bh) {
422 			exfat_err(sb, "unable to read boot sector (logical sector size = %lu)",
423 				  sb->s_blocksize);
424 			return -EIO;
425 		}
426 	}
427 	return 0;
428 }
429 
430 static int exfat_read_boot_sector(struct super_block *sb)
431 {
432 	struct boot_sector *p_boot;
433 	struct exfat_sb_info *sbi = EXFAT_SB(sb);
434 
435 	/* set block size to read super block */
436 	if (!sb_min_blocksize(sb, 512)) {
437 		exfat_err(sb, "unable to set blocksize");
438 		return -EINVAL;
439 	}
440 
441 	/* read boot sector */
442 	sbi->boot_bh = sb_bread(sb, 0);
443 	if (!sbi->boot_bh) {
444 		exfat_err(sb, "unable to read boot sector");
445 		return -EIO;
446 	}
447 	p_boot = (struct boot_sector *)sbi->boot_bh->b_data;
448 
449 	/* check the validity of BOOT */
450 	if (le16_to_cpu((p_boot->signature)) != BOOT_SIGNATURE) {
451 		exfat_err(sb, "invalid boot record signature");
452 		return -EINVAL;
453 	}
454 
455 	if (memcmp(p_boot->fs_name, STR_EXFAT, BOOTSEC_FS_NAME_LEN)) {
456 		exfat_err(sb, "invalid fs_name"); /* fs_name may unprintable */
457 		return -EINVAL;
458 	}
459 
460 	/*
461 	 * must_be_zero field must be filled with zero to prevent mounting
462 	 * from FAT volume.
463 	 */
464 	if (memchr_inv(p_boot->must_be_zero, 0, sizeof(p_boot->must_be_zero)))
465 		return -EINVAL;
466 
467 	if (p_boot->num_fats != 1 && p_boot->num_fats != 2) {
468 		exfat_err(sb, "bogus number of FAT structure");
469 		return -EINVAL;
470 	}
471 
472 	/*
473 	 * sect_size_bits could be at least 9 and at most 12.
474 	 */
475 	if (p_boot->sect_size_bits < EXFAT_MIN_SECT_SIZE_BITS ||
476 	    p_boot->sect_size_bits > EXFAT_MAX_SECT_SIZE_BITS) {
477 		exfat_err(sb, "bogus sector size bits : %u",
478 				p_boot->sect_size_bits);
479 		return -EINVAL;
480 	}
481 
482 	/*
483 	 * sect_per_clus_bits could be at least 0 and at most 25 - sect_size_bits.
484 	 */
485 	if (p_boot->sect_per_clus_bits > EXFAT_MAX_SECT_PER_CLUS_BITS(p_boot)) {
486 		exfat_err(sb, "bogus sectors bits per cluster : %u",
487 				p_boot->sect_per_clus_bits);
488 		return -EINVAL;
489 	}
490 
491 	sbi->sect_per_clus = 1 << p_boot->sect_per_clus_bits;
492 	sbi->sect_per_clus_bits = p_boot->sect_per_clus_bits;
493 	sbi->cluster_size_bits = p_boot->sect_per_clus_bits +
494 		p_boot->sect_size_bits;
495 	sbi->cluster_size = 1 << sbi->cluster_size_bits;
496 	sbi->num_FAT_sectors = le32_to_cpu(p_boot->fat_length);
497 	sbi->FAT1_start_sector = le32_to_cpu(p_boot->fat_offset);
498 	sbi->FAT2_start_sector = le32_to_cpu(p_boot->fat_offset);
499 	if (p_boot->num_fats == 2)
500 		sbi->FAT2_start_sector += sbi->num_FAT_sectors;
501 	sbi->data_start_sector = le32_to_cpu(p_boot->clu_offset);
502 	sbi->data_start_bytes = sbi->data_start_sector << p_boot->sect_size_bits;
503 	sbi->num_sectors = le64_to_cpu(p_boot->vol_length);
504 	/* because the cluster index starts with 2 */
505 	sbi->num_clusters = le32_to_cpu(p_boot->clu_count) +
506 		EXFAT_RESERVED_CLUSTERS;
507 
508 	sbi->root_dir = le32_to_cpu(p_boot->root_cluster);
509 	sbi->dentries_per_clu = 1 <<
510 		(sbi->cluster_size_bits - DENTRY_SIZE_BITS);
511 
512 	sbi->vol_flags = le16_to_cpu(p_boot->vol_flags);
513 	sbi->vol_flags_persistent = sbi->vol_flags & (VOLUME_DIRTY | MEDIA_FAILURE);
514 	sbi->clu_srch_ptr = EXFAT_FIRST_CLUSTER;
515 
516 	/* check consistencies */
517 	if ((u64)sbi->num_FAT_sectors << p_boot->sect_size_bits <
518 	    (u64)sbi->num_clusters * 4) {
519 		exfat_err(sb, "bogus fat length");
520 		return -EINVAL;
521 	}
522 
523 	if (sbi->data_start_sector <
524 	    (u64)sbi->FAT1_start_sector +
525 	    (u64)sbi->num_FAT_sectors * p_boot->num_fats) {
526 		exfat_err(sb, "bogus data start sector");
527 		return -EINVAL;
528 	}
529 
530 	if (sbi->vol_flags & VOLUME_DIRTY)
531 		exfat_warn(sb, "Volume was not properly unmounted. Some data may be corrupt. Please run fsck.");
532 	if (sbi->vol_flags & MEDIA_FAILURE)
533 		exfat_warn(sb, "Medium has reported failures. Some data may be lost.");
534 
535 	/*
536 	 * Set to the max possible volume size for this volume's cluster size so
537 	 * that any integer overflow from bytes to cluster size conversion is
538 	 * checked in inode_newsize_ok(). Clamped to MAX_LFS_FILESIZE for 32-bit
539 	 * machines.
540 	 */
541 	sb->s_maxbytes = min(MAX_LFS_FILESIZE,
542 			     exfat_cluster_to_bytes(sbi, (loff_t)EXFAT_MAX_NUM_CLUSTER));
543 
544 	/* check logical sector size */
545 	if (exfat_calibrate_blocksize(sb, 1 << p_boot->sect_size_bits))
546 		return -EIO;
547 
548 	return 0;
549 }
550 
551 static int exfat_verify_boot_region(struct super_block *sb)
552 {
553 	struct buffer_head *bh = NULL;
554 	u32 chksum = 0;
555 	__le32 *p_sig, *p_chksum;
556 	int sn, i;
557 
558 	/* read boot sector sub-regions */
559 	for (sn = 0; sn < 11; sn++) {
560 		bh = sb_bread(sb, sn);
561 		if (!bh)
562 			return -EIO;
563 
564 		if (sn != 0 && sn <= 8) {
565 			/* extended boot sector sub-regions */
566 			p_sig = (__le32 *)&bh->b_data[sb->s_blocksize - 4];
567 			if (le32_to_cpu(*p_sig) != EXBOOT_SIGNATURE)
568 				exfat_warn(sb, "Invalid exboot-signature(sector = %d): 0x%08x",
569 					   sn, le32_to_cpu(*p_sig));
570 		}
571 
572 		chksum = exfat_calc_chksum32(bh->b_data, sb->s_blocksize,
573 			chksum, sn ? CS_DEFAULT : CS_BOOT_SECTOR);
574 		brelse(bh);
575 	}
576 
577 	/* boot checksum sub-regions */
578 	bh = sb_bread(sb, sn);
579 	if (!bh)
580 		return -EIO;
581 
582 	for (i = 0; i < sb->s_blocksize; i += sizeof(u32)) {
583 		p_chksum = (__le32 *)&bh->b_data[i];
584 		if (le32_to_cpu(*p_chksum) != chksum) {
585 			exfat_err(sb, "Invalid boot checksum (boot checksum : 0x%08x, checksum : 0x%08x)",
586 				  le32_to_cpu(*p_chksum), chksum);
587 			brelse(bh);
588 			return -EINVAL;
589 		}
590 	}
591 	brelse(bh);
592 	return 0;
593 }
594 
595 /* mount the file system volume */
596 static int __exfat_fill_super(struct super_block *sb,
597 		struct exfat_chain *root_clu)
598 {
599 	int ret;
600 	struct exfat_sb_info *sbi = EXFAT_SB(sb);
601 
602 	ret = exfat_read_boot_sector(sb);
603 	if (ret) {
604 		exfat_err(sb, "failed to read boot sector");
605 		goto free_bh;
606 	}
607 
608 	ret = exfat_verify_boot_region(sb);
609 	if (ret) {
610 		exfat_err(sb, "invalid boot region");
611 		goto free_bh;
612 	}
613 
614 	/*
615 	 * Call exfat_count_num_cluster() before searching for up-case and
616 	 * bitmap directory entries to avoid infinite loop if they are missing
617 	 * and the cluster chain includes a loop.
618 	 */
619 	exfat_chain_set(root_clu, sbi->root_dir, 0, ALLOC_FAT_CHAIN);
620 	ret = exfat_count_num_clusters(sb, root_clu, &root_clu->size);
621 	if (ret) {
622 		exfat_err(sb, "failed to count the number of clusters in root");
623 		goto free_bh;
624 	}
625 
626 	ret = exfat_create_upcase_table(sb);
627 	if (ret) {
628 		exfat_err(sb, "failed to load upcase table");
629 		goto free_bh;
630 	}
631 
632 	ret = exfat_load_bitmap(sb);
633 	if (ret) {
634 		exfat_err(sb, "failed to load alloc-bitmap");
635 		goto free_bh;
636 	}
637 
638 	if (!exfat_test_bitmap(sb, sbi->root_dir)) {
639 		exfat_warn(sb, "failed to test first cluster bit of root dir(%u)",
640 			   sbi->root_dir);
641 		/*
642 		 * The first cluster bit of the root directory should never
643 		 * be unset except when storage is corrupted. This bit is
644 		 * set to allow operations after mount.
645 		 */
646 		exfat_set_bitmap(sb, sbi->root_dir, false);
647 	}
648 
649 	ret = exfat_count_used_clusters(sb, &sbi->used_clusters);
650 	if (ret) {
651 		exfat_err(sb, "failed to scan clusters");
652 		goto free_alloc_bitmap;
653 	}
654 
655 	return 0;
656 
657 free_alloc_bitmap:
658 	exfat_free_bitmap(sbi);
659 free_bh:
660 	brelse(sbi->boot_bh);
661 	return ret;
662 }
663 
664 static int exfat_fill_super(struct super_block *sb, struct fs_context *fc)
665 {
666 	struct exfat_sb_info *sbi = sb->s_fs_info;
667 	struct exfat_mount_options *opts = &sbi->options;
668 	struct inode *root_inode;
669 	struct exfat_chain root_clu;
670 	int err;
671 
672 	if (opts->allow_utime == (unsigned short)-1)
673 		opts->allow_utime = ~opts->fs_dmask & 0022;
674 
675 	if (opts->discard && !bdev_max_discard_sectors(sb->s_bdev)) {
676 		exfat_warn(sb, "mounting with \"discard\" option, but the device does not support discard");
677 		opts->discard = 0;
678 	}
679 
680 	sb->s_flags |= SB_NODIRATIME;
681 	sb->s_magic = EXFAT_SUPER_MAGIC;
682 	sb->s_op = &exfat_sops;
683 
684 	sb->s_time_gran = 10 * NSEC_PER_MSEC;
685 	sb->s_time_min = EXFAT_MIN_TIMESTAMP_SECS;
686 	sb->s_time_max = EXFAT_MAX_TIMESTAMP_SECS;
687 
688 	err = __exfat_fill_super(sb, &root_clu);
689 	if (err) {
690 		exfat_err(sb, "failed to recognize exfat type");
691 		goto check_nls_io;
692 	}
693 
694 	/* set up enough so that it can read an inode */
695 	exfat_hash_init(sb);
696 
697 	if (sbi->options.utf8)
698 		set_default_d_op(sb, &exfat_utf8_dentry_ops);
699 	else {
700 		sbi->nls_io = load_nls(sbi->options.iocharset);
701 		if (!sbi->nls_io) {
702 			exfat_err(sb, "IO charset %s not found",
703 				  sbi->options.iocharset);
704 			err = -EINVAL;
705 			goto free_table;
706 		}
707 		set_default_d_op(sb, &exfat_dentry_ops);
708 	}
709 
710 	root_inode = new_inode(sb);
711 	if (!root_inode) {
712 		exfat_err(sb, "failed to allocate root inode");
713 		err = -ENOMEM;
714 		goto free_table;
715 	}
716 
717 	root_inode->i_ino = EXFAT_ROOT_INO;
718 	inode_set_iversion(root_inode, 1);
719 	err = exfat_read_root(root_inode, &root_clu);
720 	if (err) {
721 		exfat_err(sb, "failed to initialize root inode");
722 		goto put_inode;
723 	}
724 
725 	exfat_hash_inode(root_inode, EXFAT_I(root_inode)->i_pos);
726 	insert_inode_hash(root_inode);
727 
728 	sb->s_root = d_make_root(root_inode);
729 	if (!sb->s_root) {
730 		exfat_err(sb, "failed to get the root dentry");
731 		err = -ENOMEM;
732 		goto free_table;
733 	}
734 
735 	return 0;
736 
737 put_inode:
738 	iput(root_inode);
739 	sb->s_root = NULL;
740 
741 free_table:
742 	exfat_free_bitmap(sbi);
743 	brelse(sbi->boot_bh);
744 
745 check_nls_io:
746 	return err;
747 }
748 
749 static int exfat_get_tree(struct fs_context *fc)
750 {
751 	return get_tree_bdev(fc, exfat_fill_super);
752 }
753 
754 static void exfat_free_sbi(struct exfat_sb_info *sbi)
755 {
756 	exfat_free_iocharset(sbi);
757 	kfree(sbi);
758 }
759 
760 static void exfat_free(struct fs_context *fc)
761 {
762 	struct exfat_sb_info *sbi = fc->s_fs_info;
763 
764 	if (sbi)
765 		exfat_free_sbi(sbi);
766 }
767 
768 static int exfat_reconfigure(struct fs_context *fc)
769 {
770 	struct super_block *sb = fc->root->d_sb;
771 	struct exfat_sb_info *remount_sbi = fc->s_fs_info;
772 	struct exfat_sb_info *sbi = EXFAT_SB(sb);
773 	struct exfat_mount_options *new_opts = &remount_sbi->options;
774 	struct exfat_mount_options *cur_opts = &sbi->options;
775 
776 	fc->sb_flags |= SB_NODIRATIME;
777 
778 	sync_filesystem(sb);
779 	mutex_lock(&sbi->s_lock);
780 	exfat_clear_volume_dirty(sb);
781 	mutex_unlock(&sbi->s_lock);
782 
783 	if (new_opts->allow_utime == (unsigned short)-1)
784 		new_opts->allow_utime = ~new_opts->fs_dmask & 0022;
785 
786 	/*
787 	 * Since the old settings of these mount options are cached in
788 	 * inodes or dentries, they cannot be modified dynamically.
789 	 */
790 	if (strcmp(new_opts->iocharset, cur_opts->iocharset) ||
791 	    new_opts->keep_last_dots != cur_opts->keep_last_dots ||
792 	    new_opts->sys_tz != cur_opts->sys_tz ||
793 	    new_opts->time_offset != cur_opts->time_offset ||
794 	    !uid_eq(new_opts->fs_uid, cur_opts->fs_uid) ||
795 	    !gid_eq(new_opts->fs_gid, cur_opts->fs_gid) ||
796 	    new_opts->fs_fmask != cur_opts->fs_fmask ||
797 	    new_opts->fs_dmask != cur_opts->fs_dmask ||
798 	    new_opts->allow_utime != cur_opts->allow_utime)
799 		return -EINVAL;
800 
801 	if (new_opts->discard != cur_opts->discard &&
802 	    new_opts->discard &&
803 	    !bdev_max_discard_sectors(sb->s_bdev)) {
804 		exfat_warn(sb, "remounting with \"discard\" option, but the device does not support discard");
805 		return -EINVAL;
806 	}
807 
808 	swap(*cur_opts, *new_opts);
809 
810 	return 0;
811 }
812 
813 static const struct fs_context_operations exfat_context_ops = {
814 	.parse_param	= exfat_parse_param,
815 	.get_tree	= exfat_get_tree,
816 	.free		= exfat_free,
817 	.reconfigure	= exfat_reconfigure,
818 };
819 
820 static int exfat_init_fs_context(struct fs_context *fc)
821 {
822 	struct exfat_sb_info *sbi;
823 
824 	sbi = kzalloc_obj(struct exfat_sb_info);
825 	if (!sbi)
826 		return -ENOMEM;
827 
828 	mutex_init(&sbi->s_lock);
829 	mutex_init(&sbi->bitmap_lock);
830 	ratelimit_state_init(&sbi->ratelimit, DEFAULT_RATELIMIT_INTERVAL,
831 			DEFAULT_RATELIMIT_BURST);
832 
833 	if (fc->purpose == FS_CONTEXT_FOR_RECONFIGURE && fc->root) {
834 		struct super_block *sb = fc->root->d_sb;
835 		struct exfat_mount_options *cur_opts = &EXFAT_SB(sb)->options;
836 
837 		sbi->options.fs_uid = cur_opts->fs_uid;
838 		sbi->options.fs_gid = cur_opts->fs_gid;
839 		sbi->options.fs_fmask = cur_opts->fs_fmask;
840 		sbi->options.fs_dmask = cur_opts->fs_dmask;
841 	} else {
842 		sbi->options.fs_uid = current_uid();
843 		sbi->options.fs_gid = current_gid();
844 		sbi->options.fs_fmask = current->fs->umask;
845 		sbi->options.fs_dmask = current->fs->umask;
846 	}
847 
848 	sbi->options.allow_utime = -1;
849 	sbi->options.errors = EXFAT_ERRORS_RO;
850 	exfat_set_iocharset(&sbi->options, exfat_default_iocharset);
851 
852 	fc->s_fs_info = sbi;
853 	fc->ops = &exfat_context_ops;
854 	return 0;
855 }
856 
857 static void delayed_free(struct rcu_head *p)
858 {
859 	struct exfat_sb_info *sbi = container_of(p, struct exfat_sb_info, rcu);
860 
861 	unload_nls(sbi->nls_io);
862 	exfat_free_upcase_table(sbi);
863 	exfat_free_sbi(sbi);
864 }
865 
866 static void exfat_kill_sb(struct super_block *sb)
867 {
868 	struct exfat_sb_info *sbi = sb->s_fs_info;
869 
870 	kill_block_super(sb);
871 	if (sbi)
872 		call_rcu(&sbi->rcu, delayed_free);
873 }
874 
875 static struct file_system_type exfat_fs_type = {
876 	.owner			= THIS_MODULE,
877 	.name			= "exfat",
878 	.init_fs_context	= exfat_init_fs_context,
879 	.parameters		= exfat_parameters,
880 	.kill_sb		= exfat_kill_sb,
881 	.fs_flags		= FS_REQUIRES_DEV | FS_ALLOW_IDMAP,
882 };
883 
884 static void exfat_inode_init_once(void *foo)
885 {
886 	struct exfat_inode_info *ei = (struct exfat_inode_info *)foo;
887 
888 	spin_lock_init(&ei->cache_lru_lock);
889 	ei->nr_caches = 0;
890 	ei->cache_valid_id = EXFAT_CACHE_VALID + 1;
891 	INIT_LIST_HEAD(&ei->cache_lru);
892 	INIT_HLIST_NODE(&ei->i_hash_fat);
893 	inode_init_once(&ei->vfs_inode);
894 }
895 
896 static int __init init_exfat_fs(void)
897 {
898 	int err;
899 
900 	err = exfat_cache_init();
901 	if (err)
902 		return err;
903 
904 	exfat_inode_cachep = kmem_cache_create("exfat_inode_cache",
905 			sizeof(struct exfat_inode_info),
906 			0, SLAB_RECLAIM_ACCOUNT,
907 			exfat_inode_init_once);
908 	if (!exfat_inode_cachep) {
909 		err = -ENOMEM;
910 		goto shutdown_cache;
911 	}
912 
913 	err = register_filesystem(&exfat_fs_type);
914 	if (err)
915 		goto destroy_cache;
916 
917 	return 0;
918 
919 destroy_cache:
920 	kmem_cache_destroy(exfat_inode_cachep);
921 shutdown_cache:
922 	exfat_cache_shutdown();
923 	return err;
924 }
925 
926 static void __exit exit_exfat_fs(void)
927 {
928 	/*
929 	 * Make sure all delayed rcu free inodes are flushed before we
930 	 * destroy cache.
931 	 */
932 	rcu_barrier();
933 	kmem_cache_destroy(exfat_inode_cachep);
934 	unregister_filesystem(&exfat_fs_type);
935 	exfat_cache_shutdown();
936 }
937 
938 module_init(init_exfat_fs);
939 module_exit(exit_exfat_fs);
940 
941 MODULE_ALIAS_FS("exfat");
942 MODULE_LICENSE("GPL");
943 MODULE_DESCRIPTION("exFAT filesystem support");
944 MODULE_AUTHOR("Samsung Electronics Co., Ltd.");
945