1 // SPDX-License-Identifier: GPL-2.0
4 * Copyright (C) 2019-2021 Paragon Software GmbH, All rights reserved.
9 * cluster - allocation unit - 512,1K,2K,4K,...,2M
10 * vcn - virtual cluster number - Offset inside the file in clusters.
11 * vbo - virtual byte offset - Offset inside the file in bytes.
12 * lcn - logical cluster number - 0 based cluster in clusters heap.
13 * lbo - logical byte offset - Absolute position inside volume.
14 * run - maps VCN to LCN - Stored in attributes in packed form.
15 * attr - attribute segment - std/name/data etc records inside MFT.
16 * mi - MFT inode - One MFT record(usually 1024 bytes or 4K), consists of attributes.
17 * ni - NTFS inode - Extends linux inode. consists of one or more mft inodes.
18 * index - unit inside directory - 2K, 4K, <=page size, does not depend on cluster size.
20 * WSL - Windows Subsystem for Linux
21 * https://docs.microsoft.com/en-us/windows/wsl/file-permissions
22 * It stores uid/gid/mode/dev in xattr
26 #include <linux/blkdev.h>
27 #include <linux/buffer_head.h>
28 #include <linux/exportfs.h>
30 #include <linux/fs_context.h>
31 #include <linux/fs_parser.h>
32 #include <linux/log2.h>
33 #include <linux/module.h>
34 #include <linux/nls.h>
35 #include <linux/seq_file.h>
36 #include <linux/statfs.h>
41 #ifdef CONFIG_NTFS3_LZX_XPRESS
47 * ntfs_printk - Trace warnings/notices/errors.
51 void ntfs_printk(const struct super_block *sb, const char *fmt, ...)
56 struct ntfs_sb_info *sbi = sb->s_fs_info;
58 /* Should we use different ratelimits for warnings/notices/errors? */
59 if (!___ratelimit(&sbi->msg_ratelimit, "ntfs3"))
64 level = printk_get_level(fmt);
65 vaf.fmt = printk_skip_level(fmt);
67 printk("%c%cntfs3: %s: %pV\n", KERN_SOH_ASCII, level, sb->s_id, &vaf);
72 static char s_name_buf[512];
73 static atomic_t s_name_buf_cnt = ATOMIC_INIT(1); // 1 means 'free s_name_buf'.
78 * Print warnings/notices/errors about inode using name or inode number.
80 void ntfs_inode_printk(struct inode *inode, const char *fmt, ...)
82 struct super_block *sb = inode->i_sb;
83 struct ntfs_sb_info *sbi = sb->s_fs_info;
89 if (!___ratelimit(&sbi->msg_ratelimit, "ntfs3"))
92 /* Use static allocated buffer, if possible. */
93 name = atomic_dec_and_test(&s_name_buf_cnt)
95 : kmalloc(sizeof(s_name_buf), GFP_NOFS);
98 struct dentry *de = d_find_alias(inode);
99 const u32 name_len = ARRAY_SIZE(s_name_buf) - 1;
102 spin_lock(&de->d_lock);
103 snprintf(name, name_len, " \"%s\"", de->d_name.name);
104 spin_unlock(&de->d_lock);
105 name[name_len] = 0; /* To be sure. */
109 dput(de); /* Cocci warns if placed in branch "if (de)" */
114 level = printk_get_level(fmt);
115 vaf.fmt = printk_skip_level(fmt);
118 printk("%c%cntfs3: %s: ino=%lx,%s %pV\n", KERN_SOH_ASCII, level,
119 sb->s_id, inode->i_ino, name ? name : "", &vaf);
123 atomic_inc(&s_name_buf_cnt);
124 if (name != s_name_buf)
130 * Shared memory struct.
132 * On-disk ntfs's upcase table is created by ntfs formatter.
133 * 'upcase' table is 128K bytes of memory.
134 * We should read it into memory when mounting.
135 * Several ntfs volumes likely use the same 'upcase' table.
136 * It is good idea to share in-memory 'upcase' table between different volumes.
137 * Unfortunately winxp/vista/win7 use different upcase tables.
139 static DEFINE_SPINLOCK(s_shared_lock);
151 * * @ptr - If pointer was saved in shared memory.
152 * * NULL - If pointer was not shared.
154 void *ntfs_set_shared(void *ptr, u32 bytes)
159 spin_lock(&s_shared_lock);
160 for (i = 0; i < ARRAY_SIZE(s_shared); i++) {
161 if (!s_shared[i].cnt) {
163 } else if (bytes == s_shared[i].len &&
164 !memcmp(s_shared[i].ptr, ptr, bytes)) {
165 s_shared[i].cnt += 1;
166 ret = s_shared[i].ptr;
171 if (!ret && j != -1) {
172 s_shared[j].ptr = ptr;
173 s_shared[j].len = bytes;
177 spin_unlock(&s_shared_lock);
186 * * @ptr - If pointer is not shared anymore.
187 * * NULL - If pointer is still shared.
189 void *ntfs_put_shared(void *ptr)
194 spin_lock(&s_shared_lock);
195 for (i = 0; i < ARRAY_SIZE(s_shared); i++) {
196 if (s_shared[i].cnt && s_shared[i].ptr == ptr) {
197 if (--s_shared[i].cnt)
202 spin_unlock(&s_shared_lock);
207 static inline void put_mount_options(struct ntfs_mount_options *options)
209 kfree(options->nls_name);
210 unload_nls(options->nls);
233 static const struct fs_parameter_spec ntfs_fs_parameters[] = {
234 fsparam_u32("uid", Opt_uid),
235 fsparam_u32("gid", Opt_gid),
236 fsparam_u32oct("umask", Opt_umask),
237 fsparam_u32oct("dmask", Opt_dmask),
238 fsparam_u32oct("fmask", Opt_fmask),
239 fsparam_flag_no("sys_immutable", Opt_immutable),
240 fsparam_flag_no("discard", Opt_discard),
241 fsparam_flag_no("force", Opt_force),
242 fsparam_flag_no("sparse", Opt_sparse),
243 fsparam_flag_no("hidden", Opt_nohidden),
244 fsparam_flag_no("acl", Opt_acl),
245 fsparam_flag_no("showmeta", Opt_showmeta),
246 fsparam_flag_no("prealloc", Opt_prealloc),
247 fsparam_flag_no("acsrules", Opt_noacsrules),
248 fsparam_string("iocharset", Opt_iocharset),
253 * Load nls table or if @nls is utf8 then return NULL.
255 static struct nls_table *ntfs_load_nls(char *nls)
257 struct nls_table *ret;
260 nls = CONFIG_NLS_DEFAULT;
262 if (strcmp(nls, "utf8") == 0)
265 if (strcmp(nls, CONFIG_NLS_DEFAULT) == 0)
266 return load_nls_default();
272 return ERR_PTR(-EINVAL);
275 static int ntfs_fs_parse_param(struct fs_context *fc,
276 struct fs_parameter *param)
278 struct ntfs_mount_options *opts = fc->fs_private;
279 struct fs_parse_result result;
282 opt = fs_parse(fc, ntfs_fs_parameters, param, &result);
288 opts->fs_uid = make_kuid(current_user_ns(), result.uint_32);
289 if (!uid_valid(opts->fs_uid))
290 return invalf(fc, "ntfs3: Invalid value for uid.");
293 opts->fs_gid = make_kgid(current_user_ns(), result.uint_32);
294 if (!gid_valid(opts->fs_gid))
295 return invalf(fc, "ntfs3: Invalid value for gid.");
298 if (result.uint_32 & ~07777)
299 return invalf(fc, "ntfs3: Invalid value for umask.");
300 opts->fs_fmask_inv = ~result.uint_32;
301 opts->fs_dmask_inv = ~result.uint_32;
306 if (result.uint_32 & ~07777)
307 return invalf(fc, "ntfs3: Invalid value for dmask.");
308 opts->fs_dmask_inv = ~result.uint_32;
312 if (result.uint_32 & ~07777)
313 return invalf(fc, "ntfs3: Invalid value for fmask.");
314 opts->fs_fmask_inv = ~result.uint_32;
318 opts->sys_immutable = result.negated ? 0 : 1;
321 opts->discard = result.negated ? 0 : 1;
324 opts->force = result.negated ? 0 : 1;
327 opts->sparse = result.negated ? 0 : 1;
330 opts->nohidden = result.negated ? 1 : 0;
334 #ifdef CONFIG_NTFS3_FS_POSIX_ACL
335 fc->sb_flags |= SB_POSIXACL;
337 return invalf(fc, "ntfs3: Support for ACL not compiled in!");
340 fc->sb_flags &= ~SB_POSIXACL;
343 opts->showmeta = result.negated ? 0 : 1;
346 kfree(opts->nls_name);
347 opts->nls_name = param->string;
348 param->string = NULL;
351 opts->prealloc = result.negated ? 0 : 1;
354 opts->noacsrules = result.negated ? 1 : 0;
357 /* Should not be here unless we forget add case. */
363 static int ntfs_fs_reconfigure(struct fs_context *fc)
365 struct super_block *sb = fc->root->d_sb;
366 struct ntfs_sb_info *sbi = sb->s_fs_info;
367 struct ntfs_mount_options *new_opts = fc->fs_private;
370 ro_rw = sb_rdonly(sb) && !(fc->sb_flags & SB_RDONLY);
371 if (ro_rw && (sbi->flags & NTFS_FLAGS_NEED_REPLAY)) {
372 errorf(fc, "ntfs3: Couldn't remount rw because journal is not replayed. Please umount/remount instead\n");
376 new_opts->nls = ntfs_load_nls(new_opts->nls_name);
377 if (IS_ERR(new_opts->nls)) {
378 new_opts->nls = NULL;
379 errorf(fc, "ntfs3: Cannot load iocharset %s", new_opts->nls_name);
382 if (new_opts->nls != sbi->options->nls)
383 return invalf(fc, "ntfs3: Cannot use different iocharset when remounting!");
387 if (ro_rw && (sbi->volume.flags & VOLUME_FLAG_DIRTY) &&
389 errorf(fc, "ntfs3: Volume is dirty and \"force\" flag is not set!");
393 memcpy(sbi->options, new_opts, sizeof(*new_opts));
398 static struct kmem_cache *ntfs_inode_cachep;
400 static struct inode *ntfs_alloc_inode(struct super_block *sb)
402 struct ntfs_inode *ni = alloc_inode_sb(sb, ntfs_inode_cachep, GFP_NOFS);
407 memset(ni, 0, offsetof(struct ntfs_inode, vfs_inode));
409 mutex_init(&ni->ni_lock);
411 return &ni->vfs_inode;
414 static void ntfs_i_callback(struct rcu_head *head)
416 struct inode *inode = container_of(head, struct inode, i_rcu);
417 struct ntfs_inode *ni = ntfs_i(inode);
419 mutex_destroy(&ni->ni_lock);
421 kmem_cache_free(ntfs_inode_cachep, ni);
424 static void ntfs_destroy_inode(struct inode *inode)
426 call_rcu(&inode->i_rcu, ntfs_i_callback);
429 static void init_once(void *foo)
431 struct ntfs_inode *ni = foo;
433 inode_init_once(&ni->vfs_inode);
437 * put_ntfs - Noinline to reduce binary size.
439 static noinline void put_ntfs(struct ntfs_sb_info *sbi)
442 kvfree(ntfs_put_shared(sbi->upcase));
443 kfree(sbi->def_table);
445 wnd_close(&sbi->mft.bitmap);
446 wnd_close(&sbi->used.bitmap);
449 iput(&sbi->mft.ni->vfs_inode);
451 if (sbi->security.ni)
452 iput(&sbi->security.ni->vfs_inode);
455 iput(&sbi->reparse.ni->vfs_inode);
458 iput(&sbi->objid.ni->vfs_inode);
461 iput(&sbi->volume.ni->vfs_inode);
463 ntfs_update_mftmirr(sbi, 0);
465 indx_clear(&sbi->security.index_sii);
466 indx_clear(&sbi->security.index_sdh);
467 indx_clear(&sbi->reparse.index_r);
468 indx_clear(&sbi->objid.index_o);
469 kfree(sbi->compress.lznt);
470 #ifdef CONFIG_NTFS3_LZX_XPRESS
471 xpress_free_decompressor(sbi->compress.xpress);
472 lzx_free_decompressor(sbi->compress.lzx);
477 static void ntfs_put_super(struct super_block *sb)
479 struct ntfs_sb_info *sbi = sb->s_fs_info;
481 /* Mark rw ntfs as clear, if possible. */
482 ntfs_set_state(sbi, NTFS_DIRTY_CLEAR);
484 put_mount_options(sbi->options);
486 sb->s_fs_info = NULL;
488 sync_blockdev(sb->s_bdev);
491 static int ntfs_statfs(struct dentry *dentry, struct kstatfs *buf)
493 struct super_block *sb = dentry->d_sb;
494 struct ntfs_sb_info *sbi = sb->s_fs_info;
495 struct wnd_bitmap *wnd = &sbi->used.bitmap;
497 buf->f_type = sb->s_magic;
498 buf->f_bsize = sbi->cluster_size;
499 buf->f_blocks = wnd->nbits;
501 buf->f_bfree = buf->f_bavail = wnd_zeroes(wnd);
502 buf->f_fsid.val[0] = sbi->volume.ser_num;
503 buf->f_fsid.val[1] = (sbi->volume.ser_num >> 32);
504 buf->f_namelen = NTFS_NAME_LEN;
509 static int ntfs_show_options(struct seq_file *m, struct dentry *root)
511 struct super_block *sb = root->d_sb;
512 struct ntfs_sb_info *sbi = sb->s_fs_info;
513 struct ntfs_mount_options *opts = sbi->options;
514 struct user_namespace *user_ns = seq_user_ns(m);
516 seq_printf(m, ",uid=%u",
517 from_kuid_munged(user_ns, opts->fs_uid));
518 seq_printf(m, ",gid=%u",
519 from_kgid_munged(user_ns, opts->fs_gid));
521 seq_printf(m, ",fmask=%04o", ~opts->fs_fmask_inv);
523 seq_printf(m, ",dmask=%04o", ~opts->fs_dmask_inv);
525 seq_printf(m, ",iocharset=%s", opts->nls->charset);
527 seq_puts(m, ",iocharset=utf8");
528 if (opts->sys_immutable)
529 seq_puts(m, ",sys_immutable");
531 seq_puts(m, ",discard");
533 seq_puts(m, ",sparse");
535 seq_puts(m, ",showmeta");
537 seq_puts(m, ",nohidden");
539 seq_puts(m, ",force");
540 if (opts->noacsrules)
541 seq_puts(m, ",noacsrules");
543 seq_puts(m, ",prealloc");
544 if (sb->s_flags & SB_POSIXACL)
551 * ntfs_sync_fs - super_operations::sync_fs
553 static int ntfs_sync_fs(struct super_block *sb, int wait)
556 struct ntfs_sb_info *sbi = sb->s_fs_info;
557 struct ntfs_inode *ni;
560 ni = sbi->security.ni;
562 inode = &ni->vfs_inode;
563 err2 = _ni_write_inode(inode, wait);
570 inode = &ni->vfs_inode;
571 err2 = _ni_write_inode(inode, wait);
576 ni = sbi->reparse.ni;
578 inode = &ni->vfs_inode;
579 err2 = _ni_write_inode(inode, wait);
585 ntfs_set_state(sbi, NTFS_DIRTY_CLEAR);
587 ntfs_update_mftmirr(sbi, wait);
592 static const struct super_operations ntfs_sops = {
593 .alloc_inode = ntfs_alloc_inode,
594 .destroy_inode = ntfs_destroy_inode,
595 .evict_inode = ntfs_evict_inode,
596 .put_super = ntfs_put_super,
597 .statfs = ntfs_statfs,
598 .show_options = ntfs_show_options,
599 .sync_fs = ntfs_sync_fs,
600 .write_inode = ntfs3_write_inode,
603 static struct inode *ntfs_export_get_inode(struct super_block *sb, u64 ino,
609 ref.low = cpu_to_le32(ino);
610 #ifdef CONFIG_NTFS3_64BIT_CLUSTER
611 ref.high = cpu_to_le16(ino >> 32);
615 ref.seq = cpu_to_le16(generation);
617 inode = ntfs_iget5(sb, &ref, NULL);
618 if (!IS_ERR(inode) && is_bad_inode(inode)) {
620 inode = ERR_PTR(-ESTALE);
626 static struct dentry *ntfs_fh_to_dentry(struct super_block *sb, struct fid *fid,
627 int fh_len, int fh_type)
629 return generic_fh_to_dentry(sb, fid, fh_len, fh_type,
630 ntfs_export_get_inode);
633 static struct dentry *ntfs_fh_to_parent(struct super_block *sb, struct fid *fid,
634 int fh_len, int fh_type)
636 return generic_fh_to_parent(sb, fid, fh_len, fh_type,
637 ntfs_export_get_inode);
640 /* TODO: == ntfs_sync_inode */
641 static int ntfs_nfs_commit_metadata(struct inode *inode)
643 return _ni_write_inode(inode, 1);
646 static const struct export_operations ntfs_export_ops = {
647 .fh_to_dentry = ntfs_fh_to_dentry,
648 .fh_to_parent = ntfs_fh_to_parent,
649 .get_parent = ntfs3_get_parent,
650 .commit_metadata = ntfs_nfs_commit_metadata,
654 * format_size_gb - Return Gb,Mb to print with "%u.%02u Gb".
656 static u32 format_size_gb(const u64 bytes, u32 *mb)
658 /* Do simple right 30 bit shift of 64 bit value. */
659 u64 kbytes = bytes >> 10;
660 u32 kbytes32 = kbytes;
662 *mb = (100 * (kbytes32 & 0xfffff) + 0x7ffff) >> 20;
666 return (kbytes32 >> 20) | (((u32)(kbytes >> 32)) << 12);
669 static u32 true_sectors_per_clst(const struct NTFS_BOOT *boot)
671 return boot->sectors_per_clusters <= 0x80
672 ? boot->sectors_per_clusters
673 : (1u << (0 - boot->sectors_per_clusters));
677 * ntfs_init_from_boot - Init internal info from on-disk boot sector.
679 static int ntfs_init_from_boot(struct super_block *sb, u32 sector_size,
682 struct ntfs_sb_info *sbi = sb->s_fs_info;
684 u32 mb, gb, boot_sector_size, sct_per_clst, record_size;
685 u64 sectors, clusters, mlcn, mlcn2;
686 struct NTFS_BOOT *boot;
687 struct buffer_head *bh;
691 sbi->volume.blocks = dev_size >> PAGE_SHIFT;
693 bh = ntfs_bread(sb, 0);
698 boot = (struct NTFS_BOOT *)bh->b_data;
700 if (memcmp(boot->system_id, "NTFS ", sizeof("NTFS ") - 1))
703 /* 0x55AA is not mandaroty. Thanks Maxim Suhanov*/
704 /*if (0x55 != boot->boot_magic[0] || 0xAA != boot->boot_magic[1])
708 boot_sector_size = (u32)boot->bytes_per_sector[1] << 8;
709 if (boot->bytes_per_sector[0] || boot_sector_size < SECTOR_SIZE ||
710 !is_power_of_2(boot_sector_size)) {
714 /* cluster size: 512, 1K, 2K, 4K, ... 2M */
715 sct_per_clst = true_sectors_per_clst(boot);
716 if (!is_power_of_2(sct_per_clst))
719 mlcn = le64_to_cpu(boot->mft_clst);
720 mlcn2 = le64_to_cpu(boot->mft2_clst);
721 sectors = le64_to_cpu(boot->sectors_per_volume);
723 if (mlcn * sct_per_clst >= sectors)
726 if (mlcn2 * sct_per_clst >= sectors)
729 /* Check MFT record size. */
730 if ((boot->record_size < 0 &&
731 SECTOR_SIZE > (2U << (-boot->record_size))) ||
732 (boot->record_size >= 0 && !is_power_of_2(boot->record_size))) {
736 /* Check index record size. */
737 if ((boot->index_size < 0 &&
738 SECTOR_SIZE > (2U << (-boot->index_size))) ||
739 (boot->index_size >= 0 && !is_power_of_2(boot->index_size))) {
743 sbi->volume.size = sectors * boot_sector_size;
745 gb = format_size_gb(sbi->volume.size + boot_sector_size, &mb);
748 * - Volume formatted and mounted with the same sector size.
749 * - Volume formatted 4K and mounted as 512.
750 * - Volume formatted 512 and mounted as 4K.
752 if (boot_sector_size != sector_size) {
755 "Different NTFS' sector size (%u) and media sector size (%u)",
756 boot_sector_size, sector_size);
757 dev_size += sector_size - 1;
760 sbi->cluster_size = boot_sector_size * sct_per_clst;
761 sbi->cluster_bits = blksize_bits(sbi->cluster_size);
763 sbi->mft.lbo = mlcn << sbi->cluster_bits;
764 sbi->mft.lbo2 = mlcn2 << sbi->cluster_bits;
766 /* Compare boot's cluster and sector. */
767 if (sbi->cluster_size < boot_sector_size)
770 /* Compare boot's cluster and media sector. */
771 if (sbi->cluster_size < sector_size) {
772 /* No way to use ntfs_get_block in this case. */
775 "Failed to mount 'cause NTFS's cluster size (%u) is less than media sector size (%u)",
776 sbi->cluster_size, sector_size);
780 sbi->cluster_mask = sbi->cluster_size - 1;
781 sbi->cluster_mask_inv = ~(u64)sbi->cluster_mask;
782 sbi->record_size = record_size = boot->record_size < 0
783 ? 1 << (-boot->record_size)
784 : (u32)boot->record_size
785 << sbi->cluster_bits;
787 if (record_size > MAXIMUM_BYTES_PER_MFT)
790 sbi->record_bits = blksize_bits(record_size);
791 sbi->attr_size_tr = (5 * record_size >> 4); // ~320 bytes
793 sbi->max_bytes_per_attr =
794 record_size - ALIGN(MFTRECORD_FIXUP_OFFSET_1, 8) -
795 ALIGN(((record_size >> SECTOR_SHIFT) * sizeof(short)), 8) -
796 ALIGN(sizeof(enum ATTR_TYPE), 8);
798 sbi->index_size = boot->index_size < 0
799 ? 1u << (-boot->index_size)
800 : (u32)boot->index_size << sbi->cluster_bits;
802 sbi->volume.ser_num = le64_to_cpu(boot->serial_num);
804 /* Warning if RAW volume. */
805 if (dev_size < sbi->volume.size + boot_sector_size) {
808 gb0 = format_size_gb(dev_size, &mb0);
811 "RAW NTFS volume: Filesystem size %u.%02u Gb > volume size %u.%02u Gb. Mount in read-only",
813 sb->s_flags |= SB_RDONLY;
816 clusters = sbi->volume.size >> sbi->cluster_bits;
817 #ifndef CONFIG_NTFS3_64BIT_CLUSTER
818 /* 32 bits per cluster. */
819 if (clusters >> 32) {
822 "NTFS %u.%02u Gb is too big to use 32 bits per cluster",
826 #elif BITS_PER_LONG < 64
827 #error "CONFIG_NTFS3_64BIT_CLUSTER incompatible in 32 bit OS"
830 sbi->used.bitmap.nbits = clusters;
832 rec = kzalloc(record_size, GFP_NOFS);
839 rec->rhdr.sign = NTFS_FILE_SIGNATURE;
840 rec->rhdr.fix_off = cpu_to_le16(MFTRECORD_FIXUP_OFFSET_1);
841 fn = (sbi->record_size >> SECTOR_SHIFT) + 1;
842 rec->rhdr.fix_num = cpu_to_le16(fn);
843 ao = ALIGN(MFTRECORD_FIXUP_OFFSET_1 + sizeof(short) * fn, 8);
844 rec->attr_off = cpu_to_le16(ao);
845 rec->used = cpu_to_le32(ao + ALIGN(sizeof(enum ATTR_TYPE), 8));
846 rec->total = cpu_to_le32(sbi->record_size);
847 ((struct ATTRIB *)Add2Ptr(rec, ao))->type = ATTR_END;
849 sb_set_blocksize(sb, min_t(u32, sbi->cluster_size, PAGE_SIZE));
851 sbi->block_mask = sb->s_blocksize - 1;
852 sbi->blocks_per_cluster = sbi->cluster_size >> sb->s_blocksize_bits;
853 sbi->volume.blocks = sbi->volume.size >> sb->s_blocksize_bits;
855 /* Maximum size for normal files. */
856 sbi->maxbytes = (clusters << sbi->cluster_bits) - 1;
858 #ifdef CONFIG_NTFS3_64BIT_CLUSTER
859 if (clusters >= (1ull << (64 - sbi->cluster_bits)))
861 sbi->maxbytes_sparse = -1;
862 sb->s_maxbytes = MAX_LFS_FILESIZE;
864 /* Maximum size for sparse file. */
865 sbi->maxbytes_sparse = (1ull << (sbi->cluster_bits + 32)) - 1;
866 sb->s_maxbytes = 0xFFFFFFFFull << sbi->cluster_bits;
878 * ntfs_fill_super - Try to mount.
880 static int ntfs_fill_super(struct super_block *sb, struct fs_context *fc)
883 struct ntfs_sb_info *sbi = sb->s_fs_info;
884 struct block_device *bdev = sb->s_bdev;
885 struct request_queue *rq;
887 struct ntfs_inode *ni;
891 const struct VOLUME_INFO *info;
892 u32 idx, done, bytes;
893 struct ATTR_DEF_ENTRY *t;
900 sb->s_flags |= SB_NODIRATIME;
901 sb->s_magic = 0x7366746e; // "ntfs"
902 sb->s_op = &ntfs_sops;
903 sb->s_export_op = &ntfs_export_ops;
904 sb->s_time_gran = NTFS_TIME_GRAN; // 100 nsec
905 sb->s_xattr = ntfs_xattr_handlers;
907 sbi->options->nls = ntfs_load_nls(sbi->options->nls_name);
908 if (IS_ERR(sbi->options->nls)) {
909 sbi->options->nls = NULL;
910 errorf(fc, "Cannot load nls %s", sbi->options->nls_name);
915 rq = bdev_get_queue(bdev);
916 if (blk_queue_discard(rq) && rq->limits.discard_granularity) {
917 sbi->discard_granularity = rq->limits.discard_granularity;
918 sbi->discard_granularity_mask_inv =
919 ~(u64)(sbi->discard_granularity - 1);
923 err = ntfs_init_from_boot(sb, rq ? queue_logical_block_size(rq) : 512,
924 bdev_nr_bytes(bdev));
929 * Load $Volume. This should be done before $LogFile
930 * 'cause 'sbi->volume.ni' is used 'ntfs_set_state'.
932 ref.low = cpu_to_le32(MFT_REC_VOL);
933 ref.seq = cpu_to_le16(MFT_REC_VOL);
934 inode = ntfs_iget5(sb, &ref, &NAME_VOLUME);
936 ntfs_err(sb, "Failed to load $Volume.");
937 err = PTR_ERR(inode);
943 /* Load and save label (not necessary). */
944 attr = ni_find_attr(ni, NULL, NULL, ATTR_LABEL, NULL, 0, NULL, NULL);
947 /* It is ok if no ATTR_LABEL */
948 } else if (!attr->non_res && !is_attr_ext(attr)) {
949 /* $AttrDef allows labels to be up to 128 symbols. */
950 err = utf16s_to_utf8s(resident_data(attr),
951 le32_to_cpu(attr->res.data_size) >> 1,
952 UTF16_LITTLE_ENDIAN, sbi->volume.label,
953 sizeof(sbi->volume.label));
955 sbi->volume.label[0] = 0;
957 /* Should we break mounting here? */
959 //goto put_inode_out;
962 attr = ni_find_attr(ni, attr, NULL, ATTR_VOL_INFO, NULL, 0, NULL, NULL);
963 if (!attr || is_attr_ext(attr)) {
968 info = resident_data_ex(attr, SIZEOF_ATTRIBUTE_VOLUME_INFO);
974 sbi->volume.major_ver = info->major_ver;
975 sbi->volume.minor_ver = info->minor_ver;
976 sbi->volume.flags = info->flags;
979 /* Load $MFTMirr to estimate recs_mirr. */
980 ref.low = cpu_to_le32(MFT_REC_MIRR);
981 ref.seq = cpu_to_le16(MFT_REC_MIRR);
982 inode = ntfs_iget5(sb, &ref, &NAME_MIRROR);
984 ntfs_err(sb, "Failed to load $MFTMirr.");
985 err = PTR_ERR(inode);
990 ntfs_up_cluster(sbi, inode->i_size) >> sbi->record_bits;
994 /* Load LogFile to replay. */
995 ref.low = cpu_to_le32(MFT_REC_LOG);
996 ref.seq = cpu_to_le16(MFT_REC_LOG);
997 inode = ntfs_iget5(sb, &ref, &NAME_LOGFILE);
999 ntfs_err(sb, "Failed to load \x24LogFile.");
1000 err = PTR_ERR(inode);
1006 err = ntfs_loadlog_and_replay(ni, sbi);
1012 if (sbi->flags & NTFS_FLAGS_NEED_REPLAY) {
1013 if (!sb_rdonly(sb)) {
1015 "failed to replay log file. Can't mount rw!");
1019 } else if (sbi->volume.flags & VOLUME_FLAG_DIRTY) {
1020 if (!sb_rdonly(sb) && !sbi->options->force) {
1023 "volume is dirty and \"force\" flag is not set!");
1030 ref.low = cpu_to_le32(MFT_REC_MFT);
1031 ref.seq = cpu_to_le16(1);
1033 inode = ntfs_iget5(sb, &ref, &NAME_MFT);
1034 if (IS_ERR(inode)) {
1035 ntfs_err(sb, "Failed to load $MFT.");
1036 err = PTR_ERR(inode);
1042 sbi->mft.used = ni->i_valid >> sbi->record_bits;
1043 tt = inode->i_size >> sbi->record_bits;
1044 sbi->mft.next_free = MFT_REC_USER;
1046 err = wnd_init(&sbi->mft.bitmap, sb, tt);
1050 err = ni_load_all_mi(ni);
1056 /* Load $BadClus. */
1057 ref.low = cpu_to_le32(MFT_REC_BADCLUST);
1058 ref.seq = cpu_to_le16(MFT_REC_BADCLUST);
1059 inode = ntfs_iget5(sb, &ref, &NAME_BADCLUS);
1060 if (IS_ERR(inode)) {
1061 ntfs_err(sb, "Failed to load $BadClus.");
1062 err = PTR_ERR(inode);
1068 for (i = 0; run_get_entry(&ni->file.run, i, &vcn, &lcn, &len); i++) {
1069 if (lcn == SPARSE_LCN)
1072 if (!sbi->bad_clusters)
1073 ntfs_notice(sb, "Volume contains bad blocks");
1075 sbi->bad_clusters += len;
1081 ref.low = cpu_to_le32(MFT_REC_BITMAP);
1082 ref.seq = cpu_to_le16(MFT_REC_BITMAP);
1083 inode = ntfs_iget5(sb, &ref, &NAME_BITMAP);
1084 if (IS_ERR(inode)) {
1085 ntfs_err(sb, "Failed to load $Bitmap.");
1086 err = PTR_ERR(inode);
1090 #ifndef CONFIG_NTFS3_64BIT_CLUSTER
1091 if (inode->i_size >> 32) {
1097 /* Check bitmap boundary. */
1098 tt = sbi->used.bitmap.nbits;
1099 if (inode->i_size < bitmap_size(tt)) {
1104 /* Not necessary. */
1105 sbi->used.bitmap.set_tail = true;
1106 err = wnd_init(&sbi->used.bitmap, sb, tt);
1112 /* Compute the MFT zone. */
1113 err = ntfs_refresh_zone(sbi);
1117 /* Load $AttrDef. */
1118 ref.low = cpu_to_le32(MFT_REC_ATTR);
1119 ref.seq = cpu_to_le16(MFT_REC_ATTR);
1120 inode = ntfs_iget5(sb, &ref, &NAME_ATTRDEF);
1121 if (IS_ERR(inode)) {
1122 ntfs_err(sb, "Failed to load $AttrDef -> %d", err);
1123 err = PTR_ERR(inode);
1127 if (inode->i_size < sizeof(struct ATTR_DEF_ENTRY)) {
1131 bytes = inode->i_size;
1132 sbi->def_table = t = kmalloc(bytes, GFP_NOFS);
1138 for (done = idx = 0; done < bytes; done += PAGE_SIZE, idx++) {
1139 unsigned long tail = bytes - done;
1140 struct page *page = ntfs_map_page(inode->i_mapping, idx);
1143 err = PTR_ERR(page);
1146 memcpy(Add2Ptr(t, done), page_address(page),
1147 min(PAGE_SIZE, tail));
1148 ntfs_unmap_page(page);
1150 if (!idx && ATTR_STD != t->type) {
1157 sbi->def_entries = 1;
1158 done = sizeof(struct ATTR_DEF_ENTRY);
1159 sbi->reparse.max_size = MAXIMUM_REPARSE_DATA_BUFFER_SIZE;
1160 sbi->ea_max_size = 0x10000; /* default formatter value */
1162 while (done + sizeof(struct ATTR_DEF_ENTRY) <= bytes) {
1163 u32 t32 = le32_to_cpu(t->type);
1164 u64 sz = le64_to_cpu(t->max_sz);
1166 if ((t32 & 0xF) || le32_to_cpu(t[-1].type) >= t32)
1169 if (t->type == ATTR_REPARSE)
1170 sbi->reparse.max_size = sz;
1171 else if (t->type == ATTR_EA)
1172 sbi->ea_max_size = sz;
1174 done += sizeof(struct ATTR_DEF_ENTRY);
1176 sbi->def_entries += 1;
1181 ref.low = cpu_to_le32(MFT_REC_UPCASE);
1182 ref.seq = cpu_to_le16(MFT_REC_UPCASE);
1183 inode = ntfs_iget5(sb, &ref, &NAME_UPCASE);
1184 if (IS_ERR(inode)) {
1185 ntfs_err(sb, "Failed to load $UpCase.");
1186 err = PTR_ERR(inode);
1190 if (inode->i_size != 0x10000 * sizeof(short)) {
1195 for (idx = 0; idx < (0x10000 * sizeof(short) >> PAGE_SHIFT); idx++) {
1197 u16 *dst = Add2Ptr(sbi->upcase, idx << PAGE_SHIFT);
1198 struct page *page = ntfs_map_page(inode->i_mapping, idx);
1201 err = PTR_ERR(page);
1205 src = page_address(page);
1208 for (i = 0; i < PAGE_SIZE / sizeof(u16); i++)
1209 *dst++ = le16_to_cpu(*src++);
1211 memcpy(dst, src, PAGE_SIZE);
1213 ntfs_unmap_page(page);
1216 shared = ntfs_set_shared(sbi->upcase, 0x10000 * sizeof(short));
1217 if (shared && sbi->upcase != shared) {
1218 kvfree(sbi->upcase);
1219 sbi->upcase = shared;
1224 if (is_ntfs3(sbi)) {
1226 err = ntfs_security_init(sbi);
1231 err = ntfs_extend_init(sbi);
1235 /* Load $Extend\$Reparse. */
1236 err = ntfs_reparse_init(sbi);
1240 /* Load $Extend\$ObjId. */
1241 err = ntfs_objid_init(sbi);
1248 ref.low = cpu_to_le32(MFT_REC_ROOT);
1249 ref.seq = cpu_to_le16(MFT_REC_ROOT);
1250 inode = ntfs_iget5(sb, &ref, &NAME_ROOT);
1251 if (IS_ERR(inode)) {
1252 ntfs_err(sb, "Failed to load root.");
1253 err = PTR_ERR(inode);
1257 sb->s_root = d_make_root(inode);
1263 fc->fs_private = NULL;
1271 * Free resources here.
1272 * ntfs_fs_free will be called with fc->s_fs_info = NULL
1275 sb->s_fs_info = NULL;
1280 void ntfs_unmap_meta(struct super_block *sb, CLST lcn, CLST len)
1282 struct ntfs_sb_info *sbi = sb->s_fs_info;
1283 struct block_device *bdev = sb->s_bdev;
1284 sector_t devblock = (u64)lcn * sbi->blocks_per_cluster;
1285 unsigned long blocks = (u64)len * sbi->blocks_per_cluster;
1286 unsigned long cnt = 0;
1287 unsigned long limit = global_zone_page_state(NR_FREE_PAGES)
1288 << (PAGE_SHIFT - sb->s_blocksize_bits);
1290 if (limit >= 0x2000)
1292 else if (limit < 32)
1298 clean_bdev_aliases(bdev, devblock++, 1);
1299 if (cnt++ >= limit) {
1300 sync_blockdev(bdev);
1307 * ntfs_discard - Issue a discard request (trim for SSD).
1309 int ntfs_discard(struct ntfs_sb_info *sbi, CLST lcn, CLST len)
1312 u64 lbo, bytes, start, end;
1313 struct super_block *sb;
1315 if (sbi->used.next_free_lcn == lcn + len)
1316 sbi->used.next_free_lcn = lcn;
1318 if (sbi->flags & NTFS_FLAGS_NODISCARD)
1321 if (!sbi->options->discard)
1324 lbo = (u64)lcn << sbi->cluster_bits;
1325 bytes = (u64)len << sbi->cluster_bits;
1327 /* Align up 'start' on discard_granularity. */
1328 start = (lbo + sbi->discard_granularity - 1) &
1329 sbi->discard_granularity_mask_inv;
1330 /* Align down 'end' on discard_granularity. */
1331 end = (lbo + bytes) & sbi->discard_granularity_mask_inv;
1337 err = blkdev_issue_discard(sb->s_bdev, start >> 9, (end - start) >> 9,
1340 if (err == -EOPNOTSUPP)
1341 sbi->flags |= NTFS_FLAGS_NODISCARD;
1346 static int ntfs_fs_get_tree(struct fs_context *fc)
1348 return get_tree_bdev(fc, ntfs_fill_super);
1352 * ntfs_fs_free - Free fs_context.
1354 * Note that this will be called after fill_super and reconfigure
1355 * even when they pass. So they have to take pointers if they pass.
1357 static void ntfs_fs_free(struct fs_context *fc)
1359 struct ntfs_mount_options *opts = fc->fs_private;
1360 struct ntfs_sb_info *sbi = fc->s_fs_info;
1366 put_mount_options(opts);
1369 static const struct fs_context_operations ntfs_context_ops = {
1370 .parse_param = ntfs_fs_parse_param,
1371 .get_tree = ntfs_fs_get_tree,
1372 .reconfigure = ntfs_fs_reconfigure,
1373 .free = ntfs_fs_free,
1377 * ntfs_init_fs_context - Initialize spi and opts
1379 * This will called when mount/remount. We will first initiliaze
1380 * options so that if remount we can use just that.
1382 static int ntfs_init_fs_context(struct fs_context *fc)
1384 struct ntfs_mount_options *opts;
1385 struct ntfs_sb_info *sbi;
1387 opts = kzalloc(sizeof(struct ntfs_mount_options), GFP_NOFS);
1391 /* Default options. */
1392 opts->fs_uid = current_uid();
1393 opts->fs_gid = current_gid();
1394 opts->fs_fmask_inv = ~current_umask();
1395 opts->fs_dmask_inv = ~current_umask();
1397 if (fc->purpose == FS_CONTEXT_FOR_RECONFIGURE)
1400 sbi = kzalloc(sizeof(struct ntfs_sb_info), GFP_NOFS);
1404 sbi->upcase = kvmalloc(0x10000 * sizeof(short), GFP_KERNEL);
1408 ratelimit_state_init(&sbi->msg_ratelimit, DEFAULT_RATELIMIT_INTERVAL,
1409 DEFAULT_RATELIMIT_BURST);
1411 mutex_init(&sbi->compress.mtx_lznt);
1412 #ifdef CONFIG_NTFS3_LZX_XPRESS
1413 mutex_init(&sbi->compress.mtx_xpress);
1414 mutex_init(&sbi->compress.mtx_lzx);
1417 sbi->options = opts;
1418 fc->s_fs_info = sbi;
1420 fc->fs_private = opts;
1421 fc->ops = &ntfs_context_ops;
1432 static struct file_system_type ntfs_fs_type = {
1433 .owner = THIS_MODULE,
1435 .init_fs_context = ntfs_init_fs_context,
1436 .parameters = ntfs_fs_parameters,
1437 .kill_sb = kill_block_super,
1438 .fs_flags = FS_REQUIRES_DEV | FS_ALLOW_IDMAP,
1442 static int __init init_ntfs_fs(void)
1446 pr_info("ntfs3: Max link count %u\n", NTFS_LINK_MAX);
1448 if (IS_ENABLED(CONFIG_NTFS3_FS_POSIX_ACL))
1449 pr_info("ntfs3: Enabled Linux POSIX ACLs support\n");
1450 if (IS_ENABLED(CONFIG_NTFS3_64BIT_CLUSTER))
1451 pr_notice("ntfs3: Warning: Activated 64 bits per cluster. Windows does not support this\n");
1452 if (IS_ENABLED(CONFIG_NTFS3_LZX_XPRESS))
1453 pr_info("ntfs3: Read-only LZX/Xpress compression included\n");
1455 err = ntfs3_init_bitmap();
1459 ntfs_inode_cachep = kmem_cache_create(
1460 "ntfs_inode_cache", sizeof(struct ntfs_inode), 0,
1461 (SLAB_RECLAIM_ACCOUNT | SLAB_MEM_SPREAD | SLAB_ACCOUNT),
1463 if (!ntfs_inode_cachep) {
1468 err = register_filesystem(&ntfs_fs_type);
1474 kmem_cache_destroy(ntfs_inode_cachep);
1476 ntfs3_exit_bitmap();
1480 static void __exit exit_ntfs_fs(void)
1482 if (ntfs_inode_cachep) {
1484 kmem_cache_destroy(ntfs_inode_cachep);
1487 unregister_filesystem(&ntfs_fs_type);
1488 ntfs3_exit_bitmap();
1491 MODULE_LICENSE("GPL");
1492 MODULE_DESCRIPTION("ntfs3 read/write filesystem");
1493 #ifdef CONFIG_NTFS3_FS_POSIX_ACL
1494 MODULE_INFO(behaviour, "Enabled Linux POSIX ACLs support");
1496 #ifdef CONFIG_NTFS3_64BIT_CLUSTER
1497 MODULE_INFO(cluster, "Warning: Activated 64 bits per cluster. Windows does not support this");
1499 #ifdef CONFIG_NTFS3_LZX_XPRESS
1500 MODULE_INFO(compression, "Read-only lzx/xpress compression included");
1503 MODULE_AUTHOR("Konstantin Komarov");
1504 MODULE_ALIAS_FS("ntfs3");
1506 module_init(init_ntfs_fs);
1507 module_exit(exit_ntfs_fs);