fs/ntfs3/super.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *
   4  * Copyright (C) 2019-2021 Paragon Software GmbH, All rights reserved.
   5  *
   6  *
   7  *                 terminology
   8  *
   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.
  19  *
  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
  23  *
  24  * ntfs allows up to 2^64 clusters per volume.
  25  * It means you should use 64 bits lcn to operate with ntfs.
  26  * Implementation of ntfs.sys uses only 32 bits lcn.
  27  * Default ntfs3 uses 32 bits lcn too.
  28  * ntfs3 built with CONFIG_NTFS3_64BIT_CLUSTER (ntfs3_64) uses 64 bits per lcn.
  29  *
  30  *
  31  *     ntfs limits, cluster size is 4K (2^12)
  32  * -----------------------------------------------------------------------------
  33  * | Volume size   | Clusters | ntfs.sys | ntfs3  | ntfs3_64 | mkntfs | chkdsk |
  34  * -----------------------------------------------------------------------------
  35  * | < 16T, 2^44   |  < 2^32  |  yes     |  yes   |   yes    |  yes   |  yes   |
  36  * | > 16T, 2^44   |  > 2^32  |  no      |  no    |   yes    |  yes   |  yes   |
  37  * ----------------------------------------------------------|------------------
  38  *
  39  * To mount large volumes as ntfs one should use large cluster size (up to 2M)
  40  * The maximum volume size in this case is 2^32 * 2^21 = 2^53 = 8P
  41  *
  42  *     ntfs limits, cluster size is 2M (2^21)
  43  * -----------------------------------------------------------------------------
  44  * | < 8P, 2^53    |  < 2^32  |  yes     |  yes   |   yes    |  yes   |  yes   |
  45  * | > 8P, 2^53    |  > 2^32  |  no      |  no    |   yes    |  yes   |  yes   |
  46  * ----------------------------------------------------------|------------------
  47  *
  48  */
  49
  50 #include <linux/blkdev.h>
  51 #include <linux/buffer_head.h>
  52 #include <linux/exportfs.h>
  53 #include <linux/fs.h>
  54 #include <linux/fs_context.h>
  55 #include <linux/fs_parser.h>
  56 #include <linux/log2.h>
  57 #include <linux/minmax.h>
  58 #include <linux/module.h>
  59 #include <linux/nls.h>
  60 #include <linux/proc_fs.h>
  61 #include <linux/seq_file.h>
  62 #include <linux/statfs.h>
  63
  64 #include "debug.h"
  65 #include "ntfs.h"
  66 #include "ntfs_fs.h"
  67 #ifdef CONFIG_NTFS3_LZX_XPRESS
  68 #include "lib/lib.h"
  69 #endif
  70
  71 #ifdef CONFIG_PRINTK
  72 /*
  73  * ntfs_printk - Trace warnings/notices/errors.
  74  *
  75  * Thanks Joe Perches <joe@perches.com> for implementation
  76  */
  77 void ntfs_printk(const struct super_block *sb, const char *fmt, ...)
  78 {
  79         struct va_format vaf;
  80         va_list args;
  81         int level;
  82         struct ntfs_sb_info *sbi = sb->s_fs_info;
  83
  84         /* Should we use different ratelimits for warnings/notices/errors? */
  85         if (!___ratelimit(&sbi->msg_ratelimit, "ntfs3"))
  86                 return;
  87
  88         va_start(args, fmt);
  89
  90         level = printk_get_level(fmt);
  91         vaf.fmt = printk_skip_level(fmt);
  92         vaf.va = &args;
  93         printk("%c%cntfs3: %s: %pV\n", KERN_SOH_ASCII, level, sb->s_id, &vaf);
  94
  95         va_end(args);
  96 }
  97
  98 static char s_name_buf[512];
  99 static atomic_t s_name_buf_cnt = ATOMIC_INIT(1); // 1 means 'free s_name_buf'.
 100
 101 /*
 102  * ntfs_inode_printk
 103  *
 104  * Print warnings/notices/errors about inode using name or inode number.
 105  */
 106 void ntfs_inode_printk(struct inode *inode, const char *fmt, ...)
 107 {
 108         struct super_block *sb = inode->i_sb;
 109         struct ntfs_sb_info *sbi = sb->s_fs_info;
 110         char *name;
 111         va_list args;
 112         struct va_format vaf;
 113         int level;
 114
 115         if (!___ratelimit(&sbi->msg_ratelimit, "ntfs3"))
 116                 return;
 117
 118         /* Use static allocated buffer, if possible. */
 119         name = atomic_dec_and_test(&s_name_buf_cnt) ?
 120                        s_name_buf :
 121                        kmalloc(sizeof(s_name_buf), GFP_NOFS);
 122
 123         if (name) {
 124                 struct dentry *de = d_find_alias(inode);
 125                 const u32 name_len = ARRAY_SIZE(s_name_buf) - 1;
 126
 127                 if (de) {
 128                         spin_lock(&de->d_lock);
 129                         snprintf(name, name_len, " \"%s\"", de->d_name.name);
 130                         spin_unlock(&de->d_lock);
 131                         name[name_len] = 0; /* To be sure. */
 132                 } else {
 133                         name[0] = 0;
 134                 }
 135                 dput(de); /* Cocci warns if placed in branch "if (de)" */
 136         }
 137
 138         va_start(args, fmt);
 139
 140         level = printk_get_level(fmt);
 141         vaf.fmt = printk_skip_level(fmt);
 142         vaf.va = &args;
 143
 144         printk("%c%cntfs3: %s: ino=%lx,%s %pV\n", KERN_SOH_ASCII, level,
 145                sb->s_id, inode->i_ino, name ? name : "", &vaf);
 146
 147         va_end(args);
 148
 149         atomic_inc(&s_name_buf_cnt);
 150         if (name != s_name_buf)
 151                 kfree(name);
 152 }
 153 #endif
 154
 155 /*
 156  * Shared memory struct.
 157  *
 158  * On-disk ntfs's upcase table is created by ntfs formatter.
 159  * 'upcase' table is 128K bytes of memory.
 160  * We should read it into memory when mounting.
 161  * Several ntfs volumes likely use the same 'upcase' table.
 162  * It is good idea to share in-memory 'upcase' table between different volumes.
 163  * Unfortunately winxp/vista/win7 use different upcase tables.
 164  */
 165 static DEFINE_SPINLOCK(s_shared_lock);
 166
 167 static struct {
 168         void *ptr;
 169         u32 len;
 170         int cnt;
 171 } s_shared[8];
 172
 173 /*
 174  * ntfs_set_shared
 175  *
 176  * Return:
 177  * * @ptr - If pointer was saved in shared memory.
 178  * * NULL - If pointer was not shared.
 179  */
 180 void *ntfs_set_shared(void *ptr, u32 bytes)
 181 {
 182         void *ret = NULL;
 183         int i, j = -1;
 184
 185         spin_lock(&s_shared_lock);
 186         for (i = 0; i < ARRAY_SIZE(s_shared); i++) {
 187                 if (!s_shared[i].cnt) {
 188                         j = i;
 189                 } else if (bytes == s_shared[i].len &&
 190                            !memcmp(s_shared[i].ptr, ptr, bytes)) {
 191                         s_shared[i].cnt += 1;
 192                         ret = s_shared[i].ptr;
 193                         break;
 194                 }
 195         }
 196
 197         if (!ret && j != -1) {
 198                 s_shared[j].ptr = ptr;
 199                 s_shared[j].len = bytes;
 200                 s_shared[j].cnt = 1;
 201                 ret = ptr;
 202         }
 203         spin_unlock(&s_shared_lock);
 204
 205         return ret;
 206 }
 207
 208 /*
 209  * ntfs_put_shared
 210  *
 211  * Return:
 212  * * @ptr - If pointer is not shared anymore.
 213  * * NULL - If pointer is still shared.
 214  */
 215 void *ntfs_put_shared(void *ptr)
 216 {
 217         void *ret = ptr;
 218         int i;
 219
 220         spin_lock(&s_shared_lock);
 221         for (i = 0; i < ARRAY_SIZE(s_shared); i++) {
 222                 if (s_shared[i].cnt && s_shared[i].ptr == ptr) {
 223                         if (--s_shared[i].cnt)
 224                                 ret = NULL;
 225                         break;
 226                 }
 227         }
 228         spin_unlock(&s_shared_lock);
 229
 230         return ret;
 231 }
 232
 233 static inline void put_mount_options(struct ntfs_mount_options *options)
 234 {
 235         kfree(options->nls_name);
 236         unload_nls(options->nls);
 237         kfree(options);
 238 }
 239
 240 enum Opt {
 241         Opt_uid,
 242         Opt_gid,
 243         Opt_umask,
 244         Opt_dmask,
 245         Opt_fmask,
 246         Opt_immutable,
 247         Opt_discard,
 248         Opt_force,
 249         Opt_sparse,
 250         Opt_nohidden,
 251         Opt_hide_dot_files,
 252         Opt_windows_names,
 253         Opt_showmeta,
 254         Opt_acl,
 255         Opt_iocharset,
 256         Opt_prealloc,
 257         Opt_nocase,
 258         Opt_err,
 259 };
 260
 261 // clang-format off
 262 static const struct fs_parameter_spec ntfs_fs_parameters[] = {
 263         fsparam_u32("uid",                      Opt_uid),
 264         fsparam_u32("gid",                      Opt_gid),
 265         fsparam_u32oct("umask",                 Opt_umask),
 266         fsparam_u32oct("dmask",                 Opt_dmask),
 267         fsparam_u32oct("fmask",                 Opt_fmask),
 268         fsparam_flag_no("sys_immutable",        Opt_immutable),
 269         fsparam_flag_no("discard",              Opt_discard),
 270         fsparam_flag_no("force",                Opt_force),
 271         fsparam_flag_no("sparse",               Opt_sparse),
 272         fsparam_flag_no("hidden",               Opt_nohidden),
 273         fsparam_flag_no("hide_dot_files",       Opt_hide_dot_files),
 274         fsparam_flag_no("windows_names",        Opt_windows_names),
 275         fsparam_flag_no("showmeta",             Opt_showmeta),
 276         fsparam_flag_no("acl",                  Opt_acl),
 277         fsparam_string("iocharset",             Opt_iocharset),
 278         fsparam_flag_no("prealloc",             Opt_prealloc),
 279         fsparam_flag_no("nocase",               Opt_nocase),
 280         {}
 281 };
 282 // clang-format on
 283
 284 /*
 285  * Load nls table or if @nls is utf8 then return NULL.
 286  *
 287  * It is good idea to use here "const char *nls".
 288  * But load_nls accepts "char*".
 289  */
 290 static struct nls_table *ntfs_load_nls(char *nls)
 291 {
 292         struct nls_table *ret;
 293
 294         if (!nls)
 295                 nls = CONFIG_NLS_DEFAULT;
 296
 297         if (strcmp(nls, "utf8") == 0)
 298                 return NULL;
 299
 300         if (strcmp(nls, CONFIG_NLS_DEFAULT) == 0)
 301                 return load_nls_default();
 302
 303         ret = load_nls(nls);
 304         if (ret)
 305                 return ret;
 306
 307         return ERR_PTR(-EINVAL);
 308 }
 309
 310 static int ntfs_fs_parse_param(struct fs_context *fc,
 311                                struct fs_parameter *param)
 312 {
 313         struct ntfs_mount_options *opts = fc->fs_private;
 314         struct fs_parse_result result;
 315         int opt;
 316
 317         opt = fs_parse(fc, ntfs_fs_parameters, param, &result);
 318         if (opt < 0)
 319                 return opt;
 320
 321         switch (opt) {
 322         case Opt_uid:
 323                 opts->fs_uid = make_kuid(current_user_ns(), result.uint_32);
 324                 if (!uid_valid(opts->fs_uid))
 325                         return invalf(fc, "ntfs3: Invalid value for uid.");
 326                 break;
 327         case Opt_gid:
 328                 opts->fs_gid = make_kgid(current_user_ns(), result.uint_32);
 329                 if (!gid_valid(opts->fs_gid))
 330                         return invalf(fc, "ntfs3: Invalid value for gid.");
 331                 break;
 332         case Opt_umask:
 333                 if (result.uint_32 & ~07777)
 334                         return invalf(fc, "ntfs3: Invalid value for umask.");
 335                 opts->fs_fmask_inv = ~result.uint_32;
 336                 opts->fs_dmask_inv = ~result.uint_32;
 337                 opts->fmask = 1;
 338                 opts->dmask = 1;
 339                 break;
 340         case Opt_dmask:
 341                 if (result.uint_32 & ~07777)
 342                         return invalf(fc, "ntfs3: Invalid value for dmask.");
 343                 opts->fs_dmask_inv = ~result.uint_32;
 344                 opts->dmask = 1;
 345                 break;
 346         case Opt_fmask:
 347                 if (result.uint_32 & ~07777)
 348                         return invalf(fc, "ntfs3: Invalid value for fmask.");
 349                 opts->fs_fmask_inv = ~result.uint_32;
 350                 opts->fmask = 1;
 351                 break;
 352         case Opt_immutable:
 353                 opts->sys_immutable = result.negated ? 0 : 1;
 354                 break;
 355         case Opt_discard:
 356                 opts->discard = result.negated ? 0 : 1;
 357                 break;
 358         case Opt_force:
 359                 opts->force = result.negated ? 0 : 1;
 360                 break;
 361         case Opt_sparse:
 362                 opts->sparse = result.negated ? 0 : 1;
 363                 break;
 364         case Opt_nohidden:
 365                 opts->nohidden = result.negated ? 1 : 0;
 366                 break;
 367         case Opt_hide_dot_files:
 368                 opts->hide_dot_files = result.negated ? 0 : 1;
 369                 break;
 370         case Opt_windows_names:
 371                 opts->windows_names = result.negated ? 0 : 1;
 372                 break;
 373         case Opt_showmeta:
 374                 opts->showmeta = result.negated ? 0 : 1;
 375                 break;
 376         case Opt_acl:
 377                 if (!result.negated)
 378 #ifdef CONFIG_NTFS3_FS_POSIX_ACL
 379                         fc->sb_flags |= SB_POSIXACL;
 380 #else
 381                         return invalf(
 382                                 fc, "ntfs3: Support for ACL not compiled in!");
 383 #endif
 384                 else
 385                         fc->sb_flags &= ~SB_POSIXACL;
 386                 break;
 387         case Opt_iocharset:
 388                 kfree(opts->nls_name);
 389                 opts->nls_name = param->string;
 390                 param->string = NULL;
 391                 break;
 392         case Opt_prealloc:
 393                 opts->prealloc = result.negated ? 0 : 1;
 394                 break;
 395         case Opt_nocase:
 396                 opts->nocase = result.negated ? 1 : 0;
 397                 break;
 398         default:
 399                 /* Should not be here unless we forget add case. */
 400                 return -EINVAL;
 401         }
 402         return 0;
 403 }
 404
 405 static int ntfs_fs_reconfigure(struct fs_context *fc)
 406 {
 407         struct super_block *sb = fc->root->d_sb;
 408         struct ntfs_sb_info *sbi = sb->s_fs_info;
 409         struct ntfs_mount_options *new_opts = fc->fs_private;
 410         int ro_rw;
 411
 412         ro_rw = sb_rdonly(sb) && !(fc->sb_flags & SB_RDONLY);
 413         if (ro_rw && (sbi->flags & NTFS_FLAGS_NEED_REPLAY)) {
 414                 errorf(fc,
 415                        "ntfs3: Couldn't remount rw because journal is not replayed. Please umount/remount instead\n");
 416                 return -EINVAL;
 417         }
 418
 419         new_opts->nls = ntfs_load_nls(new_opts->nls_name);
 420         if (IS_ERR(new_opts->nls)) {
 421                 new_opts->nls = NULL;
 422                 errorf(fc, "ntfs3: Cannot load iocharset %s",
 423                        new_opts->nls_name);
 424                 return -EINVAL;
 425         }
 426         if (new_opts->nls != sbi->options->nls)
 427                 return invalf(
 428                         fc,
 429                         "ntfs3: Cannot use different iocharset when remounting!");
 430
 431         sync_filesystem(sb);
 432
 433         if (ro_rw && (sbi->volume.flags & VOLUME_FLAG_DIRTY) &&
 434             !new_opts->force) {
 435                 errorf(fc,
 436                        "ntfs3: Volume is dirty and \"force\" flag is not set!");
 437                 return -EINVAL;
 438         }
 439
 440         swap(sbi->options, fc->fs_private);
 441
 442         return 0;
 443 }
 444
 445 #ifdef CONFIG_PROC_FS
 446 static struct proc_dir_entry *proc_info_root;
 447
 448 /*
 449  * ntfs3_volinfo:
 450  *
 451  * The content of /proc/fs/ntfs3/<dev>/volinfo
 452  *
 453  * ntfs3.1
 454  * cluster size
 455  * number of clusters
 456 */
 457 static int ntfs3_volinfo(struct seq_file *m, void *o)
 458 {
 459         struct super_block *sb = m->private;
 460         struct ntfs_sb_info *sbi = sb->s_fs_info;
 461
 462         seq_printf(m, "ntfs%d.%d\n%u\n%zu\n", sbi->volume.major_ver,
 463                    sbi->volume.minor_ver, sbi->cluster_size,
 464                    sbi->used.bitmap.nbits);
 465
 466         return 0;
 467 }
 468
 469 static int ntfs3_volinfo_open(struct inode *inode, struct file *file)
 470 {
 471         return single_open(file, ntfs3_volinfo, pde_data(inode));
 472 }
 473
 474 /* read /proc/fs/ntfs3/<dev>/label */
 475 static int ntfs3_label_show(struct seq_file *m, void *o)
 476 {
 477         struct super_block *sb = m->private;
 478         struct ntfs_sb_info *sbi = sb->s_fs_info;
 479
 480         seq_printf(m, "%s\n", sbi->volume.label);
 481
 482         return 0;
 483 }
 484
 485 /* write /proc/fs/ntfs3/<dev>/label */
 486 static ssize_t ntfs3_label_write(struct file *file, const char __user *buffer,
 487                                  size_t count, loff_t *ppos)
 488 {
 489         int err;
 490         struct super_block *sb = pde_data(file_inode(file));
 491         struct ntfs_sb_info *sbi = sb->s_fs_info;
 492         ssize_t ret = count;
 493         u8 *label = kmalloc(count, GFP_NOFS);
 494
 495         if (!label)
 496                 return -ENOMEM;
 497
 498         if (copy_from_user(label, buffer, ret)) {
 499                 ret = -EFAULT;
 500                 goto out;
 501         }
 502         while (ret > 0 && label[ret - 1] == '\n')
 503                 ret -= 1;
 504
 505         err = ntfs_set_label(sbi, label, ret);
 506
 507         if (err < 0) {
 508                 ntfs_err(sb, "failed (%d) to write label", err);
 509                 ret = err;
 510                 goto out;
 511         }
 512
 513         *ppos += count;
 514         ret = count;
 515 out:
 516         kfree(label);
 517         return ret;
 518 }
 519
 520 static int ntfs3_label_open(struct inode *inode, struct file *file)
 521 {
 522         return single_open(file, ntfs3_label_show, pde_data(inode));
 523 }
 524
 525 static const struct proc_ops ntfs3_volinfo_fops = {
 526         .proc_read = seq_read,
 527         .proc_lseek = seq_lseek,
 528         .proc_release = single_release,
 529         .proc_open = ntfs3_volinfo_open,
 530 };
 531
 532 static const struct proc_ops ntfs3_label_fops = {
 533         .proc_read = seq_read,
 534         .proc_lseek = seq_lseek,
 535         .proc_release = single_release,
 536         .proc_open = ntfs3_label_open,
 537         .proc_write = ntfs3_label_write,
 538 };
 539
 540 #endif
 541
 542 static struct kmem_cache *ntfs_inode_cachep;
 543
 544 static struct inode *ntfs_alloc_inode(struct super_block *sb)
 545 {
 546         struct ntfs_inode *ni = alloc_inode_sb(sb, ntfs_inode_cachep, GFP_NOFS);
 547
 548         if (!ni)
 549                 return NULL;
 550
 551         memset(ni, 0, offsetof(struct ntfs_inode, vfs_inode));
 552         mutex_init(&ni->ni_lock);
 553         return &ni->vfs_inode;
 554 }
 555
 556 static void ntfs_free_inode(struct inode *inode)
 557 {
 558         struct ntfs_inode *ni = ntfs_i(inode);
 559
 560         mutex_destroy(&ni->ni_lock);
 561         kmem_cache_free(ntfs_inode_cachep, ni);
 562 }
 563
 564 static void init_once(void *foo)
 565 {
 566         struct ntfs_inode *ni = foo;
 567
 568         inode_init_once(&ni->vfs_inode);
 569 }
 570
 571 /*
 572  * Noinline to reduce binary size.
 573  */
 574 static noinline void ntfs3_put_sbi(struct ntfs_sb_info *sbi)
 575 {
 576         wnd_close(&sbi->mft.bitmap);
 577         wnd_close(&sbi->used.bitmap);
 578
 579         if (sbi->mft.ni)
 580                 iput(&sbi->mft.ni->vfs_inode);
 581
 582         if (sbi->security.ni)
 583                 iput(&sbi->security.ni->vfs_inode);
 584
 585         if (sbi->reparse.ni)
 586                 iput(&sbi->reparse.ni->vfs_inode);
 587
 588         if (sbi->objid.ni)
 589                 iput(&sbi->objid.ni->vfs_inode);
 590
 591         if (sbi->volume.ni)
 592                 iput(&sbi->volume.ni->vfs_inode);
 593
 594         ntfs_update_mftmirr(sbi, 0);
 595
 596         indx_clear(&sbi->security.index_sii);
 597         indx_clear(&sbi->security.index_sdh);
 598         indx_clear(&sbi->reparse.index_r);
 599         indx_clear(&sbi->objid.index_o);
 600 }
 601
 602 static void ntfs3_free_sbi(struct ntfs_sb_info *sbi)
 603 {
 604         kfree(sbi->new_rec);
 605         kvfree(ntfs_put_shared(sbi->upcase));
 606         kfree(sbi->def_table);
 607         kfree(sbi->compress.lznt);
 608 #ifdef CONFIG_NTFS3_LZX_XPRESS
 609         xpress_free_decompressor(sbi->compress.xpress);
 610         lzx_free_decompressor(sbi->compress.lzx);
 611 #endif
 612         kfree(sbi);
 613 }
 614
 615 static void ntfs_put_super(struct super_block *sb)
 616 {
 617         struct ntfs_sb_info *sbi = sb->s_fs_info;
 618
 619 #ifdef CONFIG_PROC_FS
 620         // Remove /proc/fs/ntfs3/..
 621         if (sbi->procdir) {
 622                 remove_proc_entry("label", sbi->procdir);
 623                 remove_proc_entry("volinfo", sbi->procdir);
 624                 remove_proc_entry(sb->s_id, proc_info_root);
 625                 sbi->procdir = NULL;
 626         }
 627 #endif
 628
 629         /* Mark rw ntfs as clear, if possible. */
 630         ntfs_set_state(sbi, NTFS_DIRTY_CLEAR);
 631         ntfs3_put_sbi(sbi);
 632 }
 633
 634 static int ntfs_statfs(struct dentry *dentry, struct kstatfs *buf)
 635 {
 636         struct super_block *sb = dentry->d_sb;
 637         struct ntfs_sb_info *sbi = sb->s_fs_info;
 638         struct wnd_bitmap *wnd = &sbi->used.bitmap;
 639
 640         buf->f_type = sb->s_magic;
 641         buf->f_bsize = sbi->cluster_size;
 642         buf->f_blocks = wnd->nbits;
 643
 644         buf->f_bfree = buf->f_bavail = wnd_zeroes(wnd);
 645         buf->f_fsid.val[0] = sbi->volume.ser_num;
 646         buf->f_fsid.val[1] = (sbi->volume.ser_num >> 32);
 647         buf->f_namelen = NTFS_NAME_LEN;
 648
 649         return 0;
 650 }
 651
 652 static int ntfs_show_options(struct seq_file *m, struct dentry *root)
 653 {
 654         struct super_block *sb = root->d_sb;
 655         struct ntfs_sb_info *sbi = sb->s_fs_info;
 656         struct ntfs_mount_options *opts = sbi->options;
 657         struct user_namespace *user_ns = seq_user_ns(m);
 658
 659         seq_printf(m, ",uid=%u", from_kuid_munged(user_ns, opts->fs_uid));
 660         seq_printf(m, ",gid=%u", from_kgid_munged(user_ns, opts->fs_gid));
 661         if (opts->dmask)
 662                 seq_printf(m, ",dmask=%04o", opts->fs_dmask_inv ^ 0xffff);
 663         if (opts->fmask)
 664                 seq_printf(m, ",fmask=%04o", opts->fs_fmask_inv ^ 0xffff);
 665         if (opts->sys_immutable)
 666                 seq_puts(m, ",sys_immutable");
 667         if (opts->discard)
 668                 seq_puts(m, ",discard");
 669         if (opts->force)
 670                 seq_puts(m, ",force");
 671         if (opts->sparse)
 672                 seq_puts(m, ",sparse");
 673         if (opts->nohidden)
 674                 seq_puts(m, ",nohidden");
 675         if (opts->hide_dot_files)
 676                 seq_puts(m, ",hide_dot_files");
 677         if (opts->windows_names)
 678                 seq_puts(m, ",windows_names");
 679         if (opts->showmeta)
 680                 seq_puts(m, ",showmeta");
 681         if (sb->s_flags & SB_POSIXACL)
 682                 seq_puts(m, ",acl");
 683         if (opts->nls)
 684                 seq_printf(m, ",iocharset=%s", opts->nls->charset);
 685         else
 686                 seq_puts(m, ",iocharset=utf8");
 687         if (opts->prealloc)
 688                 seq_puts(m, ",prealloc");
 689         if (opts->nocase)
 690                 seq_puts(m, ",nocase");
 691
 692         return 0;
 693 }
 694
 695 /*
 696  * ntfs_sync_fs - super_operations::sync_fs
 697  */
 698 static int ntfs_sync_fs(struct super_block *sb, int wait)
 699 {
 700         int err = 0, err2;
 701         struct ntfs_sb_info *sbi = sb->s_fs_info;
 702         struct ntfs_inode *ni;
 703         struct inode *inode;
 704
 705         ni = sbi->security.ni;
 706         if (ni) {
 707                 inode = &ni->vfs_inode;
 708                 err2 = _ni_write_inode(inode, wait);
 709                 if (err2 && !err)
 710                         err = err2;
 711         }
 712
 713         ni = sbi->objid.ni;
 714         if (ni) {
 715                 inode = &ni->vfs_inode;
 716                 err2 = _ni_write_inode(inode, wait);
 717                 if (err2 && !err)
 718                         err = err2;
 719         }
 720
 721         ni = sbi->reparse.ni;
 722         if (ni) {
 723                 inode = &ni->vfs_inode;
 724                 err2 = _ni_write_inode(inode, wait);
 725                 if (err2 && !err)
 726                         err = err2;
 727         }
 728
 729         if (!err)
 730                 ntfs_set_state(sbi, NTFS_DIRTY_CLEAR);
 731
 732         ntfs_update_mftmirr(sbi, wait);
 733
 734         return err;
 735 }
 736
 737 static const struct super_operations ntfs_sops = {
 738         .alloc_inode = ntfs_alloc_inode,
 739         .free_inode = ntfs_free_inode,
 740         .evict_inode = ntfs_evict_inode,
 741         .put_super = ntfs_put_super,
 742         .statfs = ntfs_statfs,
 743         .show_options = ntfs_show_options,
 744         .sync_fs = ntfs_sync_fs,
 745         .write_inode = ntfs3_write_inode,
 746 };
 747
 748 static struct inode *ntfs_export_get_inode(struct super_block *sb, u64 ino,
 749                                            u32 generation)
 750 {
 751         struct MFT_REF ref;
 752         struct inode *inode;
 753
 754         ref.low = cpu_to_le32(ino);
 755 #ifdef CONFIG_NTFS3_64BIT_CLUSTER
 756         ref.high = cpu_to_le16(ino >> 32);
 757 #else
 758         ref.high = 0;
 759 #endif
 760         ref.seq = cpu_to_le16(generation);
 761
 762         inode = ntfs_iget5(sb, &ref, NULL);
 763         if (!IS_ERR(inode) && is_bad_inode(inode)) {
 764                 iput(inode);
 765                 inode = ERR_PTR(-ESTALE);
 766         }
 767
 768         return inode;
 769 }
 770
 771 static struct dentry *ntfs_fh_to_dentry(struct super_block *sb, struct fid *fid,
 772                                         int fh_len, int fh_type)
 773 {
 774         return generic_fh_to_dentry(sb, fid, fh_len, fh_type,
 775                                     ntfs_export_get_inode);
 776 }
 777
 778 static struct dentry *ntfs_fh_to_parent(struct super_block *sb, struct fid *fid,
 779                                         int fh_len, int fh_type)
 780 {
 781         return generic_fh_to_parent(sb, fid, fh_len, fh_type,
 782                                     ntfs_export_get_inode);
 783 }
 784
 785 /* TODO: == ntfs_sync_inode */
 786 static int ntfs_nfs_commit_metadata(struct inode *inode)
 787 {
 788         return _ni_write_inode(inode, 1);
 789 }
 790
 791 static const struct export_operations ntfs_export_ops = {
 792         .fh_to_dentry = ntfs_fh_to_dentry,
 793         .fh_to_parent = ntfs_fh_to_parent,
 794         .get_parent = ntfs3_get_parent,
 795         .commit_metadata = ntfs_nfs_commit_metadata,
 796 };
 797
 798 /*
 799  * format_size_gb - Return Gb,Mb to print with "%u.%02u Gb".
 800  */
 801 static u32 format_size_gb(const u64 bytes, u32 *mb)
 802 {
 803         /* Do simple right 30 bit shift of 64 bit value. */
 804         u64 kbytes = bytes >> 10;
 805         u32 kbytes32 = kbytes;
 806
 807         *mb = (100 * (kbytes32 & 0xfffff) + 0x7ffff) >> 20;
 808         if (*mb >= 100)
 809                 *mb = 99;
 810
 811         return (kbytes32 >> 20) | (((u32)(kbytes >> 32)) << 12);
 812 }
 813
 814 static u32 true_sectors_per_clst(const struct NTFS_BOOT *boot)
 815 {
 816         if (boot->sectors_per_clusters <= 0x80)
 817                 return boot->sectors_per_clusters;
 818         if (boot->sectors_per_clusters >= 0xf4) /* limit shift to 2MB max */
 819                 return 1U << (-(s8)boot->sectors_per_clusters);
 820         return -EINVAL;
 821 }
 822
 823 /*
 824  * ntfs_init_from_boot - Init internal info from on-disk boot sector.
 825  *
 826  * NTFS mount begins from boot - special formatted 512 bytes.
 827  * There are two boots: the first and the last 512 bytes of volume.
 828  * The content of boot is not changed during ntfs life.
 829  *
 830  * NOTE: ntfs.sys checks only first (primary) boot.
 831  * chkdsk checks both boots.
 832  */
 833 static int ntfs_init_from_boot(struct super_block *sb, u32 sector_size,
 834                                u64 dev_size, struct NTFS_BOOT **boot2)
 835 {
 836         struct ntfs_sb_info *sbi = sb->s_fs_info;
 837         int err;
 838         u32 mb, gb, boot_sector_size, sct_per_clst, record_size;
 839         u64 sectors, clusters, mlcn, mlcn2;
 840         struct NTFS_BOOT *boot;
 841         struct buffer_head *bh;
 842         struct MFT_REC *rec;
 843         u16 fn, ao;
 844         u8 cluster_bits;
 845         u32 boot_off = 0;
 846         const char *hint = "Primary boot";
 847
 848         sbi->volume.blocks = dev_size >> PAGE_SHIFT;
 849
 850         bh = ntfs_bread(sb, 0);
 851         if (!bh)
 852                 return -EIO;
 853
 854 check_boot:
 855         err = -EINVAL;
 856         boot = (struct NTFS_BOOT *)Add2Ptr(bh->b_data, boot_off);
 857
 858         if (memcmp(boot->system_id, "NTFS    ", sizeof("NTFS    ") - 1)) {
 859                 ntfs_err(sb, "%s signature is not NTFS.", hint);
 860                 goto out;
 861         }
 862
 863         /* 0x55AA is not mandaroty. Thanks Maxim Suhanov*/
 864         /*if (0x55 != boot->boot_magic[0] || 0xAA != boot->boot_magic[1])
 865          *      goto out;
 866          */
 867
 868         boot_sector_size = ((u32)boot->bytes_per_sector[1] << 8) |
 869                            boot->bytes_per_sector[0];
 870         if (boot_sector_size < SECTOR_SIZE ||
 871             !is_power_of_2(boot_sector_size)) {
 872                 ntfs_err(sb, "%s: invalid bytes per sector %u.", hint,
 873                          boot_sector_size);
 874                 goto out;
 875         }
 876
 877         /* cluster size: 512, 1K, 2K, 4K, ... 2M */
 878         sct_per_clst = true_sectors_per_clst(boot);
 879         if ((int)sct_per_clst < 0 || !is_power_of_2(sct_per_clst)) {
 880                 ntfs_err(sb, "%s: invalid sectors per cluster %u.", hint,
 881                          sct_per_clst);
 882                 goto out;
 883         }
 884
 885         sbi->cluster_size = boot_sector_size * sct_per_clst;
 886         sbi->cluster_bits = cluster_bits = blksize_bits(sbi->cluster_size);
 887         sbi->cluster_mask = sbi->cluster_size - 1;
 888         sbi->cluster_mask_inv = ~(u64)sbi->cluster_mask;
 889
 890         mlcn = le64_to_cpu(boot->mft_clst);
 891         mlcn2 = le64_to_cpu(boot->mft2_clst);
 892         sectors = le64_to_cpu(boot->sectors_per_volume);
 893
 894         if (mlcn * sct_per_clst >= sectors || mlcn2 * sct_per_clst >= sectors) {
 895                 ntfs_err(
 896                         sb,
 897                         "%s: start of MFT 0x%llx (0x%llx) is out of volume 0x%llx.",
 898                         hint, mlcn, mlcn2, sectors);
 899                 goto out;
 900         }
 901
 902         sbi->record_size = record_size =
 903                 boot->record_size < 0 ? 1 << (-boot->record_size) :
 904                                         (u32)boot->record_size << cluster_bits;
 905         sbi->record_bits = blksize_bits(record_size);
 906         sbi->attr_size_tr = (5 * record_size >> 4); // ~320 bytes
 907
 908         /* Check MFT record size. */
 909         if (record_size < SECTOR_SIZE || !is_power_of_2(record_size)) {
 910                 ntfs_err(sb, "%s: invalid bytes per MFT record %u (%d).", hint,
 911                          record_size, boot->record_size);
 912                 goto out;
 913         }
 914
 915         if (record_size > MAXIMUM_BYTES_PER_MFT) {
 916                 ntfs_err(sb, "Unsupported bytes per MFT record %u.",
 917                          record_size);
 918                 goto out;
 919         }
 920
 921         sbi->index_size = boot->index_size < 0 ?
 922                                   1u << (-boot->index_size) :
 923                                   (u32)boot->index_size << cluster_bits;
 924
 925         /* Check index record size. */
 926         if (sbi->index_size < SECTOR_SIZE || !is_power_of_2(sbi->index_size)) {
 927                 ntfs_err(sb, "%s: invalid bytes per index %u(%d).", hint,
 928                          sbi->index_size, boot->index_size);
 929                 goto out;
 930         }
 931
 932         if (sbi->index_size > MAXIMUM_BYTES_PER_INDEX) {
 933                 ntfs_err(sb, "%s: unsupported bytes per index %u.", hint,
 934                          sbi->index_size);
 935                 goto out;
 936         }
 937
 938         sbi->volume.size = sectors * boot_sector_size;
 939
 940         gb = format_size_gb(sbi->volume.size + boot_sector_size, &mb);
 941
 942         /*
 943          * - Volume formatted and mounted with the same sector size.
 944          * - Volume formatted 4K and mounted as 512.
 945          * - Volume formatted 512 and mounted as 4K.
 946          */
 947         if (boot_sector_size != sector_size) {
 948                 ntfs_warn(
 949                         sb,
 950                         "Different NTFS sector size (%u) and media sector size (%u).",
 951                         boot_sector_size, sector_size);
 952                 dev_size += sector_size - 1;
 953         }
 954
 955         sbi->mft.lbo = mlcn << cluster_bits;
 956         sbi->mft.lbo2 = mlcn2 << cluster_bits;
 957
 958         /* Compare boot's cluster and sector. */
 959         if (sbi->cluster_size < boot_sector_size) {
 960                 ntfs_err(sb, "%s: invalid bytes per cluster (%u).", hint,
 961                          sbi->cluster_size);
 962                 goto out;
 963         }
 964
 965         /* Compare boot's cluster and media sector. */
 966         if (sbi->cluster_size < sector_size) {
 967                 /* No way to use ntfs_get_block in this case. */
 968                 ntfs_err(
 969                         sb,
 970                         "Failed to mount 'cause NTFS's cluster size (%u) is less than media sector size (%u).",
 971                         sbi->cluster_size, sector_size);
 972                 goto out;
 973         }
 974
 975         sbi->max_bytes_per_attr =
 976                 record_size - ALIGN(MFTRECORD_FIXUP_OFFSET, 8) -
 977                 ALIGN(((record_size >> SECTOR_SHIFT) * sizeof(short)), 8) -
 978                 ALIGN(sizeof(enum ATTR_TYPE), 8);
 979
 980         sbi->volume.ser_num = le64_to_cpu(boot->serial_num);
 981
 982         /* Warning if RAW volume. */
 983         if (dev_size < sbi->volume.size + boot_sector_size) {
 984                 u32 mb0, gb0;
 985
 986                 gb0 = format_size_gb(dev_size, &mb0);
 987                 ntfs_warn(
 988                         sb,
 989                         "RAW NTFS volume: Filesystem size %u.%02u Gb > volume size %u.%02u Gb. Mount in read-only.",
 990                         gb, mb, gb0, mb0);
 991                 sb->s_flags |= SB_RDONLY;
 992         }
 993
 994         clusters = sbi->volume.size >> cluster_bits;
 995 #ifndef CONFIG_NTFS3_64BIT_CLUSTER
 996         /* 32 bits per cluster. */
 997         if (clusters >> 32) {
 998                 ntfs_notice(
 999                         sb,
1000                         "NTFS %u.%02u Gb is too big to use 32 bits per cluster.",
1001                         gb, mb);
1002                 goto out;
1003         }
1004 #elif BITS_PER_LONG < 64
1005 #error "CONFIG_NTFS3_64BIT_CLUSTER incompatible in 32 bit OS"
1006 #endif
1007
1008         sbi->used.bitmap.nbits = clusters;
1009
1010         rec = kzalloc(record_size, GFP_NOFS);
1011         if (!rec) {
1012                 err = -ENOMEM;
1013                 goto out;
1014         }
1015
1016         sbi->new_rec = rec;
1017         rec->rhdr.sign = NTFS_FILE_SIGNATURE;
1018         rec->rhdr.fix_off = cpu_to_le16(MFTRECORD_FIXUP_OFFSET);
1019         fn = (sbi->record_size >> SECTOR_SHIFT) + 1;
1020         rec->rhdr.fix_num = cpu_to_le16(fn);
1021         ao = ALIGN(MFTRECORD_FIXUP_OFFSET + sizeof(short) * fn, 8);
1022         rec->attr_off = cpu_to_le16(ao);
1023         rec->used = cpu_to_le32(ao + ALIGN(sizeof(enum ATTR_TYPE), 8));
1024         rec->total = cpu_to_le32(sbi->record_size);
1025         ((struct ATTRIB *)Add2Ptr(rec, ao))->type = ATTR_END;
1026
1027         sb_set_blocksize(sb, min_t(u32, sbi->cluster_size, PAGE_SIZE));
1028
1029         sbi->block_mask = sb->s_blocksize - 1;
1030         sbi->blocks_per_cluster = sbi->cluster_size >> sb->s_blocksize_bits;
1031         sbi->volume.blocks = sbi->volume.size >> sb->s_blocksize_bits;
1032
1033         /* Maximum size for normal files. */
1034         sbi->maxbytes = (clusters << cluster_bits) - 1;
1035
1036 #ifdef CONFIG_NTFS3_64BIT_CLUSTER
1037         if (clusters >= (1ull << (64 - cluster_bits)))
1038                 sbi->maxbytes = -1;
1039         sbi->maxbytes_sparse = -1;
1040         sb->s_maxbytes = MAX_LFS_FILESIZE;
1041 #else
1042         /* Maximum size for sparse file. */
1043         sbi->maxbytes_sparse = (1ull << (cluster_bits + 32)) - 1;
1044         sb->s_maxbytes = 0xFFFFFFFFull << cluster_bits;
1045 #endif
1046
1047         /*
1048          * Compute the MFT zone at two steps.
1049          * It would be nice if we are able to allocate 1/8 of
1050          * total clusters for MFT but not more then 512 MB.
1051          */
1052         sbi->zone_max = min_t(CLST, 0x20000000 >> cluster_bits, clusters >> 3);
1053
1054         err = 0;
1055
1056         if (bh->b_blocknr && !sb_rdonly(sb)) {
1057                 /*
1058              * Alternative boot is ok but primary is not ok.
1059              * Do not update primary boot here 'cause it may be faked boot.
1060              * Let ntfs to be mounted and update boot later.
1061              */
1062                 *boot2 = kmemdup(boot, sizeof(*boot), GFP_NOFS | __GFP_NOWARN);
1063         }
1064
1065 out:
1066         if (err == -EINVAL && !bh->b_blocknr && dev_size > PAGE_SHIFT) {
1067                 u32 block_size = min_t(u32, sector_size, PAGE_SIZE);
1068                 u64 lbo = dev_size - sizeof(*boot);
1069
1070                 /*
1071                  * Try alternative boot (last sector)
1072                  */
1073                 brelse(bh);
1074
1075                 sb_set_blocksize(sb, block_size);
1076                 bh = ntfs_bread(sb, lbo >> blksize_bits(block_size));
1077                 if (!bh)
1078                         return -EINVAL;
1079
1080                 boot_off = lbo & (block_size - 1);
1081                 hint = "Alternative boot";
1082                 goto check_boot;
1083         }
1084         brelse(bh);
1085
1086         return err;
1087 }
1088
1089 /*
1090  * ntfs_fill_super - Try to mount.
1091  */
1092 static int ntfs_fill_super(struct super_block *sb, struct fs_context *fc)
1093 {
1094         int err;
1095         struct ntfs_sb_info *sbi = sb->s_fs_info;
1096         struct block_device *bdev = sb->s_bdev;
1097         struct ntfs_mount_options *options;
1098         struct inode *inode;
1099         struct ntfs_inode *ni;
1100         size_t i, tt, bad_len, bad_frags;
1101         CLST vcn, lcn, len;
1102         struct ATTRIB *attr;
1103         const struct VOLUME_INFO *info;
1104         u32 idx, done, bytes;
1105         struct ATTR_DEF_ENTRY *t;
1106         u16 *shared;
1107         struct MFT_REF ref;
1108         bool ro = sb_rdonly(sb);
1109         struct NTFS_BOOT *boot2 = NULL;
1110
1111         ref.high = 0;
1112
1113         sbi->sb = sb;
1114         sbi->options = options = fc->fs_private;
1115         fc->fs_private = NULL;
1116         sb->s_flags |= SB_NODIRATIME;
1117         sb->s_magic = 0x7366746e; // "ntfs"
1118         sb->s_op = &ntfs_sops;
1119         sb->s_export_op = &ntfs_export_ops;
1120         sb->s_time_gran = NTFS_TIME_GRAN; // 100 nsec
1121         sb->s_xattr = ntfs_xattr_handlers;
1122         sb->s_d_op = options->nocase ? &ntfs_dentry_ops : NULL;
1123
1124         options->nls = ntfs_load_nls(options->nls_name);
1125         if (IS_ERR(options->nls)) {
1126                 options->nls = NULL;
1127                 errorf(fc, "Cannot load nls %s", options->nls_name);
1128                 err = -EINVAL;
1129                 goto out;
1130         }
1131
1132         if (bdev_max_discard_sectors(bdev) && bdev_discard_granularity(bdev)) {
1133                 sbi->discard_granularity = bdev_discard_granularity(bdev);
1134                 sbi->discard_granularity_mask_inv =
1135                         ~(u64)(sbi->discard_granularity - 1);
1136         }
1137
1138         /* Parse boot. */
1139         err = ntfs_init_from_boot(sb, bdev_logical_block_size(bdev),
1140                                   bdev_nr_bytes(bdev), &boot2);
1141         if (err)
1142                 goto out;
1143
1144         /*
1145          * Load $Volume. This should be done before $LogFile
1146          * 'cause 'sbi->volume.ni' is used 'ntfs_set_state'.
1147          */
1148         ref.low = cpu_to_le32(MFT_REC_VOL);
1149         ref.seq = cpu_to_le16(MFT_REC_VOL);
1150         inode = ntfs_iget5(sb, &ref, &NAME_VOLUME);
1151         if (IS_ERR(inode)) {
1152                 err = PTR_ERR(inode);
1153                 ntfs_err(sb, "Failed to load $Volume (%d).", err);
1154                 goto out;
1155         }
1156
1157         ni = ntfs_i(inode);
1158
1159         /* Load and save label (not necessary). */
1160         attr = ni_find_attr(ni, NULL, NULL, ATTR_LABEL, NULL, 0, NULL, NULL);
1161
1162         if (!attr) {
1163                 /* It is ok if no ATTR_LABEL */
1164         } else if (!attr->non_res && !is_attr_ext(attr)) {
1165                 /* $AttrDef allows labels to be up to 128 symbols. */
1166                 err = utf16s_to_utf8s(resident_data(attr),
1167                                       le32_to_cpu(attr->res.data_size) >> 1,
1168                                       UTF16_LITTLE_ENDIAN, sbi->volume.label,
1169                                       sizeof(sbi->volume.label));
1170                 if (err < 0)
1171                         sbi->volume.label[0] = 0;
1172         } else {
1173                 /* Should we break mounting here? */
1174                 //err = -EINVAL;
1175                 //goto put_inode_out;
1176         }
1177
1178         attr = ni_find_attr(ni, attr, NULL, ATTR_VOL_INFO, NULL, 0, NULL, NULL);
1179         if (!attr || is_attr_ext(attr) ||
1180             !(info = resident_data_ex(attr, SIZEOF_ATTRIBUTE_VOLUME_INFO))) {
1181                 ntfs_err(sb, "$Volume is corrupted.");
1182                 err = -EINVAL;
1183                 goto put_inode_out;
1184         }
1185
1186         sbi->volume.major_ver = info->major_ver;
1187         sbi->volume.minor_ver = info->minor_ver;
1188         sbi->volume.flags = info->flags;
1189         sbi->volume.ni = ni;
1190         if (info->flags & VOLUME_FLAG_DIRTY) {
1191                 sbi->volume.real_dirty = true;
1192                 ntfs_info(sb, "It is recommened to use chkdsk.");
1193         }
1194
1195         /* Load $MFTMirr to estimate recs_mirr. */
1196         ref.low = cpu_to_le32(MFT_REC_MIRR);
1197         ref.seq = cpu_to_le16(MFT_REC_MIRR);
1198         inode = ntfs_iget5(sb, &ref, &NAME_MIRROR);
1199         if (IS_ERR(inode)) {
1200                 err = PTR_ERR(inode);
1201                 ntfs_err(sb, "Failed to load $MFTMirr (%d).", err);
1202                 goto out;
1203         }
1204
1205         sbi->mft.recs_mirr = ntfs_up_cluster(sbi, inode->i_size) >>
1206                              sbi->record_bits;
1207
1208         iput(inode);
1209
1210         /* Load LogFile to replay. */
1211         ref.low = cpu_to_le32(MFT_REC_LOG);
1212         ref.seq = cpu_to_le16(MFT_REC_LOG);
1213         inode = ntfs_iget5(sb, &ref, &NAME_LOGFILE);
1214         if (IS_ERR(inode)) {
1215                 err = PTR_ERR(inode);
1216                 ntfs_err(sb, "Failed to load \x24LogFile (%d).", err);
1217                 goto out;
1218         }
1219
1220         ni = ntfs_i(inode);
1221
1222         err = ntfs_loadlog_and_replay(ni, sbi);
1223         if (err)
1224                 goto put_inode_out;
1225
1226         iput(inode);
1227
1228         if ((sbi->flags & NTFS_FLAGS_NEED_REPLAY) && !ro) {
1229                 ntfs_warn(sb, "failed to replay log file. Can't mount rw!");
1230                 err = -EINVAL;
1231                 goto out;
1232         }
1233
1234         if ((sbi->volume.flags & VOLUME_FLAG_DIRTY) && !ro && !options->force) {
1235                 ntfs_warn(sb, "volume is dirty and \"force\" flag is not set!");
1236                 err = -EINVAL;
1237                 goto out;
1238         }
1239
1240         /* Load $MFT. */
1241         ref.low = cpu_to_le32(MFT_REC_MFT);
1242         ref.seq = cpu_to_le16(1);
1243
1244         inode = ntfs_iget5(sb, &ref, &NAME_MFT);
1245         if (IS_ERR(inode)) {
1246                 err = PTR_ERR(inode);
1247                 ntfs_err(sb, "Failed to load $MFT (%d).", err);
1248                 goto out;
1249         }
1250
1251         ni = ntfs_i(inode);
1252
1253         sbi->mft.used = ni->i_valid >> sbi->record_bits;
1254         tt = inode->i_size >> sbi->record_bits;
1255         sbi->mft.next_free = MFT_REC_USER;
1256
1257         err = wnd_init(&sbi->mft.bitmap, sb, tt);
1258         if (err)
1259                 goto put_inode_out;
1260
1261         err = ni_load_all_mi(ni);
1262         if (err) {
1263                 ntfs_err(sb, "Failed to load $MFT's subrecords (%d).", err);
1264                 goto put_inode_out;
1265         }
1266
1267         sbi->mft.ni = ni;
1268
1269         /* Load $Bitmap. */
1270         ref.low = cpu_to_le32(MFT_REC_BITMAP);
1271         ref.seq = cpu_to_le16(MFT_REC_BITMAP);
1272         inode = ntfs_iget5(sb, &ref, &NAME_BITMAP);
1273         if (IS_ERR(inode)) {
1274                 err = PTR_ERR(inode);
1275                 ntfs_err(sb, "Failed to load $Bitmap (%d).", err);
1276                 goto out;
1277         }
1278
1279 #ifndef CONFIG_NTFS3_64BIT_CLUSTER
1280         if (inode->i_size >> 32) {
1281                 err = -EINVAL;
1282                 goto put_inode_out;
1283         }
1284 #endif
1285
1286         /* Check bitmap boundary. */
1287         tt = sbi->used.bitmap.nbits;
1288         if (inode->i_size < bitmap_size(tt)) {
1289                 ntfs_err(sb, "$Bitmap is corrupted.");
1290                 err = -EINVAL;
1291                 goto put_inode_out;
1292         }
1293
1294         err = wnd_init(&sbi->used.bitmap, sb, tt);
1295         if (err) {
1296                 ntfs_err(sb, "Failed to initialize $Bitmap (%d).", err);
1297                 goto put_inode_out;
1298         }
1299
1300         iput(inode);
1301
1302         /* Compute the MFT zone. */
1303         err = ntfs_refresh_zone(sbi);
1304         if (err) {
1305                 ntfs_err(sb, "Failed to initialize MFT zone (%d).", err);
1306                 goto out;
1307         }
1308
1309         /* Load $BadClus. */
1310         ref.low = cpu_to_le32(MFT_REC_BADCLUST);
1311         ref.seq = cpu_to_le16(MFT_REC_BADCLUST);
1312         inode = ntfs_iget5(sb, &ref, &NAME_BADCLUS);
1313         if (IS_ERR(inode)) {
1314                 err = PTR_ERR(inode);
1315                 ntfs_err(sb, "Failed to load $BadClus (%d).", err);
1316                 goto out;
1317         }
1318
1319         ni = ntfs_i(inode);
1320         bad_len = bad_frags = 0;
1321         for (i = 0; run_get_entry(&ni->file.run, i, &vcn, &lcn, &len); i++) {
1322                 if (lcn == SPARSE_LCN)
1323                         continue;
1324
1325                 bad_len += len;
1326                 bad_frags += 1;
1327                 if (ro)
1328                         continue;
1329
1330                 if (wnd_set_used_safe(&sbi->used.bitmap, lcn, len, &tt) || tt) {
1331                         /* Bad blocks marked as free in bitmap. */
1332                         ntfs_set_state(sbi, NTFS_DIRTY_ERROR);
1333                 }
1334         }
1335         if (bad_len) {
1336                 /*
1337                  * Notice about bad blocks.
1338                  * In normal cases these blocks are marked as used in bitmap.
1339                  * And we never allocate space in it.
1340                  */
1341                 ntfs_notice(sb,
1342                             "Volume contains %zu bad blocks in %zu fragments.",
1343                             bad_len, bad_frags);
1344         }
1345         iput(inode);
1346
1347         /* Load $AttrDef. */
1348         ref.low = cpu_to_le32(MFT_REC_ATTR);
1349         ref.seq = cpu_to_le16(MFT_REC_ATTR);
1350         inode = ntfs_iget5(sb, &ref, &NAME_ATTRDEF);
1351         if (IS_ERR(inode)) {
1352                 err = PTR_ERR(inode);
1353                 ntfs_err(sb, "Failed to load $AttrDef (%d)", err);
1354                 goto out;
1355         }
1356
1357         /*
1358          * Typical $AttrDef contains up to 20 entries.
1359          * Check for extremely large/small size.
1360          */
1361         if (inode->i_size < sizeof(struct ATTR_DEF_ENTRY) ||
1362             inode->i_size > 100 * sizeof(struct ATTR_DEF_ENTRY)) {
1363                 ntfs_err(sb, "Looks like $AttrDef is corrupted (size=%llu).",
1364                          inode->i_size);
1365                 err = -EINVAL;
1366                 goto put_inode_out;
1367         }
1368
1369         bytes = inode->i_size;
1370         sbi->def_table = t = kmalloc(bytes, GFP_NOFS | __GFP_NOWARN);
1371         if (!t) {
1372                 err = -ENOMEM;
1373                 goto put_inode_out;
1374         }
1375
1376         for (done = idx = 0; done < bytes; done += PAGE_SIZE, idx++) {
1377                 unsigned long tail = bytes - done;
1378                 struct page *page = ntfs_map_page(inode->i_mapping, idx);
1379
1380                 if (IS_ERR(page)) {
1381                         err = PTR_ERR(page);
1382                         ntfs_err(sb, "Failed to read $AttrDef (%d).", err);
1383                         goto put_inode_out;
1384                 }
1385                 memcpy(Add2Ptr(t, done), page_address(page),
1386                        min(PAGE_SIZE, tail));
1387                 ntfs_unmap_page(page);
1388
1389                 if (!idx && ATTR_STD != t->type) {
1390                         ntfs_err(sb, "$AttrDef is corrupted.");
1391                         err = -EINVAL;
1392                         goto put_inode_out;
1393                 }
1394         }
1395
1396         t += 1;
1397         sbi->def_entries = 1;
1398         done = sizeof(struct ATTR_DEF_ENTRY);
1399         sbi->reparse.max_size = MAXIMUM_REPARSE_DATA_BUFFER_SIZE;
1400         sbi->ea_max_size = 0x10000; /* default formatter value */
1401
1402         while (done + sizeof(struct ATTR_DEF_ENTRY) <= bytes) {
1403                 u32 t32 = le32_to_cpu(t->type);
1404                 u64 sz = le64_to_cpu(t->max_sz);
1405
1406                 if ((t32 & 0xF) || le32_to_cpu(t[-1].type) >= t32)
1407                         break;
1408
1409                 if (t->type == ATTR_REPARSE)
1410                         sbi->reparse.max_size = sz;
1411                 else if (t->type == ATTR_EA)
1412                         sbi->ea_max_size = sz;
1413
1414                 done += sizeof(struct ATTR_DEF_ENTRY);
1415                 t += 1;
1416                 sbi->def_entries += 1;
1417         }
1418         iput(inode);
1419
1420         /* Load $UpCase. */
1421         ref.low = cpu_to_le32(MFT_REC_UPCASE);
1422         ref.seq = cpu_to_le16(MFT_REC_UPCASE);
1423         inode = ntfs_iget5(sb, &ref, &NAME_UPCASE);
1424         if (IS_ERR(inode)) {
1425                 err = PTR_ERR(inode);
1426                 ntfs_err(sb, "Failed to load $UpCase (%d).", err);
1427                 goto out;
1428         }
1429
1430         if (inode->i_size != 0x10000 * sizeof(short)) {
1431                 err = -EINVAL;
1432                 ntfs_err(sb, "$UpCase is corrupted.");
1433                 goto put_inode_out;
1434         }
1435
1436         for (idx = 0; idx < (0x10000 * sizeof(short) >> PAGE_SHIFT); idx++) {
1437                 const __le16 *src;
1438                 u16 *dst = Add2Ptr(sbi->upcase, idx << PAGE_SHIFT);
1439                 struct page *page = ntfs_map_page(inode->i_mapping, idx);
1440
1441                 if (IS_ERR(page)) {
1442                         err = PTR_ERR(page);
1443                         ntfs_err(sb, "Failed to read $UpCase (%d).", err);
1444                         goto put_inode_out;
1445                 }
1446
1447                 src = page_address(page);
1448
1449 #ifdef __BIG_ENDIAN
1450                 for (i = 0; i < PAGE_SIZE / sizeof(u16); i++)
1451                         *dst++ = le16_to_cpu(*src++);
1452 #else
1453                 memcpy(dst, src, PAGE_SIZE);
1454 #endif
1455                 ntfs_unmap_page(page);
1456         }
1457
1458         shared = ntfs_set_shared(sbi->upcase, 0x10000 * sizeof(short));
1459         if (shared && sbi->upcase != shared) {
1460                 kvfree(sbi->upcase);
1461                 sbi->upcase = shared;
1462         }
1463
1464         iput(inode);
1465
1466         if (is_ntfs3(sbi)) {
1467                 /* Load $Secure. */
1468                 err = ntfs_security_init(sbi);
1469                 if (err) {
1470                         ntfs_err(sb, "Failed to initialize $Secure (%d).", err);
1471                         goto out;
1472                 }
1473
1474                 /* Load $Extend. */
1475                 err = ntfs_extend_init(sbi);
1476                 if (err) {
1477                         ntfs_warn(sb, "Failed to initialize $Extend.");
1478                         goto load_root;
1479                 }
1480
1481                 /* Load $Extend/$Reparse. */
1482                 err = ntfs_reparse_init(sbi);
1483                 if (err) {
1484                         ntfs_warn(sb, "Failed to initialize $Extend/$Reparse.");
1485                         goto load_root;
1486                 }
1487
1488                 /* Load $Extend/$ObjId. */
1489                 err = ntfs_objid_init(sbi);
1490                 if (err) {
1491                         ntfs_warn(sb, "Failed to initialize $Extend/$ObjId.");
1492                         goto load_root;
1493                 }
1494         }
1495
1496 load_root:
1497         /* Load root. */
1498         ref.low = cpu_to_le32(MFT_REC_ROOT);
1499         ref.seq = cpu_to_le16(MFT_REC_ROOT);
1500         inode = ntfs_iget5(sb, &ref, &NAME_ROOT);
1501         if (IS_ERR(inode)) {
1502                 err = PTR_ERR(inode);
1503                 ntfs_err(sb, "Failed to load root (%d).", err);
1504                 goto out;
1505         }
1506
1507         /*
1508          * Final check. Looks like this case should never occurs.
1509          */
1510         if (!inode->i_op) {
1511                 err = -EINVAL;
1512                 ntfs_err(sb, "Failed to load root (%d).", err);
1513                 goto put_inode_out;
1514         }
1515
1516         sb->s_root = d_make_root(inode);
1517         if (!sb->s_root) {
1518                 err = -ENOMEM;
1519                 goto put_inode_out;
1520         }
1521
1522         if (boot2) {
1523                 /*
1524              * Alternative boot is ok but primary is not ok.
1525              * Volume is recognized as NTFS. Update primary boot.
1526              */
1527                 struct buffer_head *bh0 = sb_getblk(sb, 0);
1528                 if (bh0) {
1529                         if (buffer_locked(bh0))
1530                                 __wait_on_buffer(bh0);
1531
1532                         lock_buffer(bh0);
1533                         memcpy(bh0->b_data, boot2, sizeof(*boot2));
1534                         set_buffer_uptodate(bh0);
1535                         mark_buffer_dirty(bh0);
1536                         unlock_buffer(bh0);
1537                         if (!sync_dirty_buffer(bh0))
1538                                 ntfs_warn(sb, "primary boot is updated");
1539                         put_bh(bh0);
1540                 }
1541
1542                 kfree(boot2);
1543         }
1544
1545 #ifdef CONFIG_PROC_FS
1546         /* Create /proc/fs/ntfs3/.. */
1547         if (proc_info_root) {
1548                 struct proc_dir_entry *e = proc_mkdir(sb->s_id, proc_info_root);
1549                 static_assert((S_IRUGO | S_IWUSR) == 0644);
1550                 if (e) {
1551                         proc_create_data("volinfo", S_IRUGO, e,
1552                                          &ntfs3_volinfo_fops, sb);
1553                         proc_create_data("label", S_IRUGO | S_IWUSR, e,
1554                                          &ntfs3_label_fops, sb);
1555                         sbi->procdir = e;
1556                 }
1557         }
1558 #endif
1559
1560         return 0;
1561
1562 put_inode_out:
1563         iput(inode);
1564 out:
1565         kfree(boot2);
1566         return err;
1567 }
1568
1569 void ntfs_unmap_meta(struct super_block *sb, CLST lcn, CLST len)
1570 {
1571         struct ntfs_sb_info *sbi = sb->s_fs_info;
1572         struct block_device *bdev = sb->s_bdev;
1573         sector_t devblock = (u64)lcn * sbi->blocks_per_cluster;
1574         unsigned long blocks = (u64)len * sbi->blocks_per_cluster;
1575         unsigned long cnt = 0;
1576         unsigned long limit = global_zone_page_state(NR_FREE_PAGES)
1577                               << (PAGE_SHIFT - sb->s_blocksize_bits);
1578
1579         if (limit >= 0x2000)
1580                 limit -= 0x1000;
1581         else if (limit < 32)
1582                 limit = 32;
1583         else
1584                 limit >>= 1;
1585
1586         while (blocks--) {
1587                 clean_bdev_aliases(bdev, devblock++, 1);
1588                 if (cnt++ >= limit) {
1589                         sync_blockdev(bdev);
1590                         cnt = 0;
1591                 }
1592         }
1593 }
1594
1595 /*
1596  * ntfs_discard - Issue a discard request (trim for SSD).
1597  */
1598 int ntfs_discard(struct ntfs_sb_info *sbi, CLST lcn, CLST len)
1599 {
1600         int err;
1601         u64 lbo, bytes, start, end;
1602         struct super_block *sb;
1603
1604         if (sbi->used.next_free_lcn == lcn + len)
1605                 sbi->used.next_free_lcn = lcn;
1606
1607         if (sbi->flags & NTFS_FLAGS_NODISCARD)
1608                 return -EOPNOTSUPP;
1609
1610         if (!sbi->options->discard)
1611                 return -EOPNOTSUPP;
1612
1613         lbo = (u64)lcn << sbi->cluster_bits;
1614         bytes = (u64)len << sbi->cluster_bits;
1615
1616         /* Align up 'start' on discard_granularity. */
1617         start = (lbo + sbi->discard_granularity - 1) &
1618                 sbi->discard_granularity_mask_inv;
1619         /* Align down 'end' on discard_granularity. */
1620         end = (lbo + bytes) & sbi->discard_granularity_mask_inv;
1621
1622         sb = sbi->sb;
1623         if (start >= end)
1624                 return 0;
1625
1626         err = blkdev_issue_discard(sb->s_bdev, start >> 9, (end - start) >> 9,
1627                                    GFP_NOFS);
1628
1629         if (err == -EOPNOTSUPP)
1630                 sbi->flags |= NTFS_FLAGS_NODISCARD;
1631
1632         return err;
1633 }
1634
1635 static int ntfs_fs_get_tree(struct fs_context *fc)
1636 {
1637         return get_tree_bdev(fc, ntfs_fill_super);
1638 }
1639
1640 /*
1641  * ntfs_fs_free - Free fs_context.
1642  *
1643  * Note that this will be called after fill_super and reconfigure
1644  * even when they pass. So they have to take pointers if they pass.
1645  */
1646 static void ntfs_fs_free(struct fs_context *fc)
1647 {
1648         struct ntfs_mount_options *opts = fc->fs_private;
1649         struct ntfs_sb_info *sbi = fc->s_fs_info;
1650
1651         if (sbi) {
1652                 ntfs3_put_sbi(sbi);
1653                 ntfs3_free_sbi(sbi);
1654         }
1655
1656         if (opts)
1657                 put_mount_options(opts);
1658 }
1659
1660 // clang-format off
1661 static const struct fs_context_operations ntfs_context_ops = {
1662         .parse_param    = ntfs_fs_parse_param,
1663         .get_tree       = ntfs_fs_get_tree,
1664         .reconfigure    = ntfs_fs_reconfigure,
1665         .free           = ntfs_fs_free,
1666 };
1667 // clang-format on
1668
1669 /*
1670  * ntfs_init_fs_context - Initialize sbi and opts
1671  *
1672  * This will called when mount/remount. We will first initialize
1673  * options so that if remount we can use just that.
1674  */
1675 static int ntfs_init_fs_context(struct fs_context *fc)
1676 {
1677         struct ntfs_mount_options *opts;
1678         struct ntfs_sb_info *sbi;
1679
1680         opts = kzalloc(sizeof(struct ntfs_mount_options), GFP_NOFS);
1681         if (!opts)
1682                 return -ENOMEM;
1683
1684         /* Default options. */
1685         opts->fs_uid = current_uid();
1686         opts->fs_gid = current_gid();
1687         opts->fs_fmask_inv = ~current_umask();
1688         opts->fs_dmask_inv = ~current_umask();
1689
1690         if (fc->purpose == FS_CONTEXT_FOR_RECONFIGURE)
1691                 goto ok;
1692
1693         sbi = kzalloc(sizeof(struct ntfs_sb_info), GFP_NOFS);
1694         if (!sbi)
1695                 goto free_opts;
1696
1697         sbi->upcase = kvmalloc(0x10000 * sizeof(short), GFP_KERNEL);
1698         if (!sbi->upcase)
1699                 goto free_sbi;
1700
1701         ratelimit_state_init(&sbi->msg_ratelimit, DEFAULT_RATELIMIT_INTERVAL,
1702                              DEFAULT_RATELIMIT_BURST);
1703
1704         mutex_init(&sbi->compress.mtx_lznt);
1705 #ifdef CONFIG_NTFS3_LZX_XPRESS
1706         mutex_init(&sbi->compress.mtx_xpress);
1707         mutex_init(&sbi->compress.mtx_lzx);
1708 #endif
1709
1710         fc->s_fs_info = sbi;
1711 ok:
1712         fc->fs_private = opts;
1713         fc->ops = &ntfs_context_ops;
1714
1715         return 0;
1716 free_sbi:
1717         kfree(sbi);
1718 free_opts:
1719         kfree(opts);
1720         return -ENOMEM;
1721 }
1722
1723 static void ntfs3_kill_sb(struct super_block *sb)
1724 {
1725         struct ntfs_sb_info *sbi = sb->s_fs_info;
1726
1727         kill_block_super(sb);
1728
1729         if (sbi->options)
1730                 put_mount_options(sbi->options);
1731         ntfs3_free_sbi(sbi);
1732 }
1733
1734 // clang-format off
1735 static struct file_system_type ntfs_fs_type = {
1736         .owner                  = THIS_MODULE,
1737         .name                   = "ntfs3",
1738         .init_fs_context        = ntfs_init_fs_context,
1739         .parameters             = ntfs_fs_parameters,
1740         .kill_sb                = ntfs3_kill_sb,
1741         .fs_flags               = FS_REQUIRES_DEV | FS_ALLOW_IDMAP,
1742 };
1743 // clang-format on
1744
1745 static int __init init_ntfs_fs(void)
1746 {
1747         int err;
1748
1749         pr_info("ntfs3: Max link count %u\n", NTFS_LINK_MAX);
1750
1751         if (IS_ENABLED(CONFIG_NTFS3_FS_POSIX_ACL))
1752                 pr_info("ntfs3: Enabled Linux POSIX ACLs support\n");
1753         if (IS_ENABLED(CONFIG_NTFS3_64BIT_CLUSTER))
1754                 pr_notice(
1755                         "ntfs3: Warning: Activated 64 bits per cluster. Windows does not support this\n");
1756         if (IS_ENABLED(CONFIG_NTFS3_LZX_XPRESS))
1757                 pr_info("ntfs3: Read-only LZX/Xpress compression included\n");
1758
1759
1760 #ifdef CONFIG_PROC_FS
1761         /* Create "/proc/fs/ntfs3" */
1762         proc_info_root = proc_mkdir("fs/ntfs3", NULL);
1763 #endif
1764
1765         err = ntfs3_init_bitmap();
1766         if (err)
1767                 return err;
1768
1769         ntfs_inode_cachep = kmem_cache_create(
1770                 "ntfs_inode_cache", sizeof(struct ntfs_inode), 0,
1771                 (SLAB_RECLAIM_ACCOUNT | SLAB_MEM_SPREAD | SLAB_ACCOUNT),
1772                 init_once);
1773         if (!ntfs_inode_cachep) {
1774                 err = -ENOMEM;
1775                 goto out1;
1776         }
1777
1778         err = register_filesystem(&ntfs_fs_type);
1779         if (err)
1780                 goto out;
1781
1782         return 0;
1783 out:
1784         kmem_cache_destroy(ntfs_inode_cachep);
1785 out1:
1786         ntfs3_exit_bitmap();
1787         return err;
1788 }
1789
1790 static void __exit exit_ntfs_fs(void)
1791 {
1792         rcu_barrier();
1793         kmem_cache_destroy(ntfs_inode_cachep);
1794         unregister_filesystem(&ntfs_fs_type);
1795         ntfs3_exit_bitmap();
1796
1797 #ifdef CONFIG_PROC_FS
1798         if (proc_info_root)
1799                 remove_proc_entry("fs/ntfs3", NULL);
1800 #endif
1801
1802 }
1803
1804 MODULE_LICENSE("GPL");
1805 MODULE_DESCRIPTION("ntfs3 read/write filesystem");
1806 #ifdef CONFIG_NTFS3_FS_POSIX_ACL
1807 MODULE_INFO(behaviour, "Enabled Linux POSIX ACLs support");
1808 #endif
1809 #ifdef CONFIG_NTFS3_64BIT_CLUSTER
1810 MODULE_INFO(
1811         cluster,
1812         "Warning: Activated 64 bits per cluster. Windows does not support this");
1813 #endif
1814 #ifdef CONFIG_NTFS3_LZX_XPRESS
1815 MODULE_INFO(compression, "Read-only lzx/xpress compression included");
1816 #endif
1817
1818 MODULE_AUTHOR("Konstantin Komarov");
1819 MODULE_ALIAS_FS("ntfs3");
1820
1821 module_init(init_ntfs_fs);
1822 module_exit(exit_ntfs_fs);