fs/ntfs3/file.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *
   4  * Copyright (C) 2019-2021 Paragon Software GmbH, All rights reserved.
   5  *
   6  *  Regular file handling primitives for NTFS-based filesystems.
   7  *
   8  */
   9
  10 #include <linux/backing-dev.h>
  11 #include <linux/buffer_head.h>
  12 #include <linux/compat.h>
  13 #include <linux/falloc.h>
  14 #include <linux/fiemap.h>
  15 #include <linux/nls.h>
  16
  17 #include "debug.h"
  18 #include "ntfs.h"
  19 #include "ntfs_fs.h"
  20
  21 static int ntfs_ioctl_fitrim(struct ntfs_sb_info *sbi, unsigned long arg)
  22 {
  23         struct fstrim_range __user *user_range;
  24         struct fstrim_range range;
  25         struct request_queue *q = bdev_get_queue(sbi->sb->s_bdev);
  26         int err;
  27
  28         if (!capable(CAP_SYS_ADMIN))
  29                 return -EPERM;
  30
  31         if (!blk_queue_discard(q))
  32                 return -EOPNOTSUPP;
  33
  34         user_range = (struct fstrim_range __user *)arg;
  35         if (copy_from_user(&range, user_range, sizeof(range)))
  36                 return -EFAULT;
  37
  38         range.minlen = max_t(u32, range.minlen, q->limits.discard_granularity);
  39
  40         err = ntfs_trim_fs(sbi, &range);
  41         if (err < 0)
  42                 return err;
  43
  44         if (copy_to_user(user_range, &range, sizeof(range)))
  45                 return -EFAULT;
  46
  47         return 0;
  48 }
  49
  50 static long ntfs_ioctl(struct file *filp, u32 cmd, unsigned long arg)
  51 {
  52         struct inode *inode = file_inode(filp);
  53         struct ntfs_sb_info *sbi = inode->i_sb->s_fs_info;
  54
  55         switch (cmd) {
  56         case FITRIM:
  57                 return ntfs_ioctl_fitrim(sbi, arg);
  58         }
  59         return -ENOTTY; /* Inappropriate ioctl for device. */
  60 }
  61
  62 #ifdef CONFIG_COMPAT
  63 static long ntfs_compat_ioctl(struct file *filp, u32 cmd, unsigned long arg)
  64
  65 {
  66         return ntfs_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));
  67 }
  68 #endif
  69
  70 /*
  71  * ntfs_getattr - inode_operations::getattr
  72  */
  73 int ntfs_getattr(struct user_namespace *mnt_userns, const struct path *path,
  74                  struct kstat *stat, u32 request_mask, u32 flags)
  75 {
  76         struct inode *inode = d_inode(path->dentry);
  77         struct ntfs_inode *ni = ntfs_i(inode);
  78
  79         if (is_compressed(ni))
  80                 stat->attributes |= STATX_ATTR_COMPRESSED;
  81
  82         if (is_encrypted(ni))
  83                 stat->attributes |= STATX_ATTR_ENCRYPTED;
  84
  85         stat->attributes_mask |= STATX_ATTR_COMPRESSED | STATX_ATTR_ENCRYPTED;
  86
  87         generic_fillattr(mnt_userns, inode, stat);
  88
  89         stat->result_mask |= STATX_BTIME;
  90         stat->btime = ni->i_crtime;
  91         stat->blksize = ni->mi.sbi->cluster_size; /* 512, 1K, ..., 2M */
  92
  93         return 0;
  94 }
  95
  96 static int ntfs_extend_initialized_size(struct file *file,
  97                                         struct ntfs_inode *ni,
  98                                         const loff_t valid,
  99                                         const loff_t new_valid)
 100 {
 101         struct inode *inode = &ni->vfs_inode;
 102         struct address_space *mapping = inode->i_mapping;
 103         struct ntfs_sb_info *sbi = inode->i_sb->s_fs_info;
 104         loff_t pos = valid;
 105         int err;
 106
 107         if (is_resident(ni)) {
 108                 ni->i_valid = new_valid;
 109                 return 0;
 110         }
 111
 112         WARN_ON(is_compressed(ni));
 113         WARN_ON(valid >= new_valid);
 114
 115         for (;;) {
 116                 u32 zerofrom, len;
 117                 struct page *page;
 118                 void *fsdata;
 119                 u8 bits;
 120                 CLST vcn, lcn, clen;
 121
 122                 if (is_sparsed(ni)) {
 123                         bits = sbi->cluster_bits;
 124                         vcn = pos >> bits;
 125
 126                         err = attr_data_get_block(ni, vcn, 0, &lcn, &clen,
 127                                                   NULL);
 128                         if (err)
 129                                 goto out;
 130
 131                         if (lcn == SPARSE_LCN) {
 132                                 loff_t vbo = (loff_t)vcn << bits;
 133                                 loff_t to = vbo + ((loff_t)clen << bits);
 134
 135                                 if (to <= new_valid) {
 136                                         ni->i_valid = to;
 137                                         pos = to;
 138                                         goto next;
 139                                 }
 140
 141                                 if (vbo < pos) {
 142                                         pos = vbo;
 143                                 } else {
 144                                         to = (new_valid >> bits) << bits;
 145                                         if (pos < to) {
 146                                                 ni->i_valid = to;
 147                                                 pos = to;
 148                                                 goto next;
 149                                         }
 150                                 }
 151                         }
 152                 }
 153
 154                 zerofrom = pos & (PAGE_SIZE - 1);
 155                 len = PAGE_SIZE - zerofrom;
 156
 157                 if (pos + len > new_valid)
 158                         len = new_valid - pos;
 159
 160                 err = pagecache_write_begin(file, mapping, pos, len, 0, &page,
 161                                             &fsdata);
 162                 if (err)
 163                         goto out;
 164
 165                 zero_user_segment(page, zerofrom, PAGE_SIZE);
 166
 167                 /* This function in any case puts page. */
 168                 err = pagecache_write_end(file, mapping, pos, len, len, page,
 169                                           fsdata);
 170                 if (err < 0)
 171                         goto out;
 172                 pos += len;
 173
 174 next:
 175                 if (pos >= new_valid)
 176                         break;
 177
 178                 balance_dirty_pages_ratelimited(mapping);
 179                 cond_resched();
 180         }
 181
 182         return 0;
 183
 184 out:
 185         ni->i_valid = valid;
 186         ntfs_inode_warn(inode, "failed to extend initialized size to %llx.",
 187                         new_valid);
 188         return err;
 189 }
 190
 191 /*
 192  * ntfs_zero_range - Helper function for punch_hole.
 193  * It zeroes a range [vbo, vbo_to)
 194  */
 195 static int ntfs_zero_range(struct inode *inode, u64 vbo, u64 vbo_to)
 196 {
 197         int err = 0;
 198         struct address_space *mapping = inode->i_mapping;
 199         u32 blocksize = 1 << inode->i_blkbits;
 200         pgoff_t idx = vbo >> PAGE_SHIFT;
 201         u32 z_start = vbo & (PAGE_SIZE - 1);
 202         pgoff_t idx_end = (vbo_to + PAGE_SIZE - 1) >> PAGE_SHIFT;
 203         loff_t page_off;
 204         struct buffer_head *head, *bh;
 205         u32 bh_next, bh_off, z_end;
 206         sector_t iblock;
 207         struct page *page;
 208
 209         for (; idx < idx_end; idx += 1, z_start = 0) {
 210                 page_off = (loff_t)idx << PAGE_SHIFT;
 211                 z_end = (page_off + PAGE_SIZE) > vbo_to ? (vbo_to - page_off)
 212                                                         : PAGE_SIZE;
 213                 iblock = page_off >> inode->i_blkbits;
 214
 215                 page = find_or_create_page(mapping, idx,
 216                                            mapping_gfp_constraint(mapping,
 217                                                                   ~__GFP_FS));
 218                 if (!page)
 219                         return -ENOMEM;
 220
 221                 if (!page_has_buffers(page))
 222                         create_empty_buffers(page, blocksize, 0);
 223
 224                 bh = head = page_buffers(page);
 225                 bh_off = 0;
 226                 do {
 227                         bh_next = bh_off + blocksize;
 228
 229                         if (bh_next <= z_start || bh_off >= z_end)
 230                                 continue;
 231
 232                         if (!buffer_mapped(bh)) {
 233                                 ntfs_get_block(inode, iblock, bh, 0);
 234                                 /* unmapped? It's a hole - nothing to do */
 235                                 if (!buffer_mapped(bh))
 236                                         continue;
 237                         }
 238
 239                         /* Ok, it's mapped. Make sure it's up-to-date */
 240                         if (PageUptodate(page))
 241                                 set_buffer_uptodate(bh);
 242
 243                         if (!buffer_uptodate(bh)) {
 244                                 lock_buffer(bh);
 245                                 bh->b_end_io = end_buffer_read_sync;
 246                                 get_bh(bh);
 247                                 submit_bh(REQ_OP_READ, 0, bh);
 248
 249                                 wait_on_buffer(bh);
 250                                 if (!buffer_uptodate(bh)) {
 251                                         unlock_page(page);
 252                                         put_page(page);
 253                                         err = -EIO;
 254                                         goto out;
 255                                 }
 256                         }
 257
 258                         mark_buffer_dirty(bh);
 259
 260                 } while (bh_off = bh_next, iblock += 1,
 261                          head != (bh = bh->b_this_page));
 262
 263                 zero_user_segment(page, z_start, z_end);
 264
 265                 unlock_page(page);
 266                 put_page(page);
 267                 cond_resched();
 268         }
 269 out:
 270         mark_inode_dirty(inode);
 271         return err;
 272 }
 273
 274 /*
 275  * ntfs_sparse_cluster
 276  *
 277  * Helper function to zero a new allocated clusters
 278  * NOTE: 512 <= cluster size <= 2M
 279  */
 280 void ntfs_sparse_cluster(struct inode *inode, struct page *page0, CLST vcn,
 281                          CLST len)
 282 {
 283         struct address_space *mapping = inode->i_mapping;
 284         struct ntfs_sb_info *sbi = inode->i_sb->s_fs_info;
 285         u64 vbo = (u64)vcn << sbi->cluster_bits;
 286         u64 bytes = (u64)len << sbi->cluster_bits;
 287         u32 blocksize = 1 << inode->i_blkbits;
 288         pgoff_t idx0 = page0 ? page0->index : -1;
 289         loff_t vbo_clst = vbo & sbi->cluster_mask_inv;
 290         loff_t end = ntfs_up_cluster(sbi, vbo + bytes);
 291         pgoff_t idx = vbo_clst >> PAGE_SHIFT;
 292         u32 from = vbo_clst & (PAGE_SIZE - 1);
 293         pgoff_t idx_end = (end + PAGE_SIZE - 1) >> PAGE_SHIFT;
 294         loff_t page_off;
 295         u32 to;
 296         bool partial;
 297         struct page *page;
 298
 299         for (; idx < idx_end; idx += 1, from = 0) {
 300                 page = idx == idx0 ? page0 : grab_cache_page(mapping, idx);
 301
 302                 if (!page)
 303                         continue;
 304
 305                 page_off = (loff_t)idx << PAGE_SHIFT;
 306                 to = (page_off + PAGE_SIZE) > end ? (end - page_off)
 307                                                   : PAGE_SIZE;
 308                 partial = false;
 309
 310                 if ((from || PAGE_SIZE != to) &&
 311                     likely(!page_has_buffers(page))) {
 312                         create_empty_buffers(page, blocksize, 0);
 313                 }
 314
 315                 if (page_has_buffers(page)) {
 316                         struct buffer_head *head, *bh;
 317                         u32 bh_off = 0;
 318
 319                         bh = head = page_buffers(page);
 320                         do {
 321                                 u32 bh_next = bh_off + blocksize;
 322
 323                                 if (from <= bh_off && bh_next <= to) {
 324                                         set_buffer_uptodate(bh);
 325                                         mark_buffer_dirty(bh);
 326                                 } else if (!buffer_uptodate(bh)) {
 327                                         partial = true;
 328                                 }
 329                                 bh_off = bh_next;
 330                         } while (head != (bh = bh->b_this_page));
 331                 }
 332
 333                 zero_user_segment(page, from, to);
 334
 335                 if (!partial) {
 336                         if (!PageUptodate(page))
 337                                 SetPageUptodate(page);
 338                         set_page_dirty(page);
 339                 }
 340
 341                 if (idx != idx0) {
 342                         unlock_page(page);
 343                         put_page(page);
 344                 }
 345                 cond_resched();
 346         }
 347         mark_inode_dirty(inode);
 348 }
 349
 350 /*
 351  * ntfs_file_mmap - file_operations::mmap
 352  */
 353 static int ntfs_file_mmap(struct file *file, struct vm_area_struct *vma)
 354 {
 355         struct address_space *mapping = file->f_mapping;
 356         struct inode *inode = mapping->host;
 357         struct ntfs_inode *ni = ntfs_i(inode);
 358         u64 from = ((u64)vma->vm_pgoff << PAGE_SHIFT);
 359         bool rw = vma->vm_flags & VM_WRITE;
 360         int err;
 361
 362         if (is_encrypted(ni)) {
 363                 ntfs_inode_warn(inode, "mmap encrypted not supported");
 364                 return -EOPNOTSUPP;
 365         }
 366
 367         if (is_dedup(ni)) {
 368                 ntfs_inode_warn(inode, "mmap deduplicated not supported");
 369                 return -EOPNOTSUPP;
 370         }
 371
 372         if (is_compressed(ni) && rw) {
 373                 ntfs_inode_warn(inode, "mmap(write) compressed not supported");
 374                 return -EOPNOTSUPP;
 375         }
 376
 377         if (rw) {
 378                 u64 to = min_t(loff_t, i_size_read(inode),
 379                                from + vma->vm_end - vma->vm_start);
 380
 381                 if (is_sparsed(ni)) {
 382                         /* Allocate clusters for rw map. */
 383                         struct ntfs_sb_info *sbi = inode->i_sb->s_fs_info;
 384                         CLST lcn, len;
 385                         CLST vcn = from >> sbi->cluster_bits;
 386                         CLST end = bytes_to_cluster(sbi, to);
 387                         bool new;
 388
 389                         for (; vcn < end; vcn += len) {
 390                                 err = attr_data_get_block(ni, vcn, 1, &lcn,
 391                                                           &len, &new);
 392                                 if (err)
 393                                         goto out;
 394
 395                                 if (!new)
 396                                         continue;
 397                                 ntfs_sparse_cluster(inode, NULL, vcn, 1);
 398                         }
 399                 }
 400
 401                 if (ni->i_valid < to) {
 402                         if (!inode_trylock(inode)) {
 403                                 err = -EAGAIN;
 404                                 goto out;
 405                         }
 406                         err = ntfs_extend_initialized_size(file, ni,
 407                                                            ni->i_valid, to);
 408                         inode_unlock(inode);
 409                         if (err)
 410                                 goto out;
 411                 }
 412         }
 413
 414         err = generic_file_mmap(file, vma);
 415 out:
 416         return err;
 417 }
 418
 419 static int ntfs_extend(struct inode *inode, loff_t pos, size_t count,
 420                        struct file *file)
 421 {
 422         struct ntfs_inode *ni = ntfs_i(inode);
 423         struct address_space *mapping = inode->i_mapping;
 424         loff_t end = pos + count;
 425         bool extend_init = file && pos > ni->i_valid;
 426         int err;
 427
 428         if (end <= inode->i_size && !extend_init)
 429                 return 0;
 430
 431         /* Mark rw ntfs as dirty. It will be cleared at umount. */
 432         ntfs_set_state(ni->mi.sbi, NTFS_DIRTY_DIRTY);
 433
 434         if (end > inode->i_size) {
 435                 err = ntfs_set_size(inode, end);
 436                 if (err)
 437                         goto out;
 438                 inode->i_size = end;
 439         }
 440
 441         if (extend_init && !is_compressed(ni)) {
 442                 err = ntfs_extend_initialized_size(file, ni, ni->i_valid, pos);
 443                 if (err)
 444                         goto out;
 445         } else {
 446                 err = 0;
 447         }
 448
 449         inode->i_ctime = inode->i_mtime = current_time(inode);
 450         mark_inode_dirty(inode);
 451
 452         if (IS_SYNC(inode)) {
 453                 int err2;
 454
 455                 err = filemap_fdatawrite_range(mapping, pos, end - 1);
 456                 err2 = sync_mapping_buffers(mapping);
 457                 if (!err)
 458                         err = err2;
 459                 err2 = write_inode_now(inode, 1);
 460                 if (!err)
 461                         err = err2;
 462                 if (!err)
 463                         err = filemap_fdatawait_range(mapping, pos, end - 1);
 464         }
 465
 466 out:
 467         return err;
 468 }
 469
 470 static int ntfs_truncate(struct inode *inode, loff_t new_size)
 471 {
 472         struct super_block *sb = inode->i_sb;
 473         struct ntfs_inode *ni = ntfs_i(inode);
 474         int err, dirty = 0;
 475         u64 new_valid;
 476
 477         if (!S_ISREG(inode->i_mode))
 478                 return 0;
 479
 480         if (is_compressed(ni)) {
 481                 if (ni->i_valid > new_size)
 482                         ni->i_valid = new_size;
 483         } else {
 484                 err = block_truncate_page(inode->i_mapping, new_size,
 485                                           ntfs_get_block);
 486                 if (err)
 487                         return err;
 488         }
 489
 490         new_valid = ntfs_up_block(sb, min_t(u64, ni->i_valid, new_size));
 491
 492         ni_lock(ni);
 493
 494         truncate_setsize(inode, new_size);
 495
 496         down_write(&ni->file.run_lock);
 497         err = attr_set_size(ni, ATTR_DATA, NULL, 0, &ni->file.run, new_size,
 498                             &new_valid, true, NULL);
 499         up_write(&ni->file.run_lock);
 500
 501         if (new_valid < ni->i_valid)
 502                 ni->i_valid = new_valid;
 503
 504         ni_unlock(ni);
 505
 506         ni->std_fa |= FILE_ATTRIBUTE_ARCHIVE;
 507         inode->i_ctime = inode->i_mtime = current_time(inode);
 508         if (!IS_DIRSYNC(inode)) {
 509                 dirty = 1;
 510         } else {
 511                 err = ntfs_sync_inode(inode);
 512                 if (err)
 513                         return err;
 514         }
 515
 516         if (dirty)
 517                 mark_inode_dirty(inode);
 518
 519         /*ntfs_flush_inodes(inode->i_sb, inode, NULL);*/
 520
 521         return 0;
 522 }
 523
 524 /*
 525  * ntfs_fallocate
 526  *
 527  * Preallocate space for a file. This implements ntfs's fallocate file
 528  * operation, which gets called from sys_fallocate system call. User
 529  * space requests 'len' bytes at 'vbo'. If FALLOC_FL_KEEP_SIZE is set
 530  * we just allocate clusters without zeroing them out. Otherwise we
 531  * allocate and zero out clusters via an expanding truncate.
 532  */
 533 static long ntfs_fallocate(struct file *file, int mode, loff_t vbo, loff_t len)
 534 {
 535         struct inode *inode = file->f_mapping->host;
 536         struct super_block *sb = inode->i_sb;
 537         struct ntfs_sb_info *sbi = sb->s_fs_info;
 538         struct ntfs_inode *ni = ntfs_i(inode);
 539         loff_t end = vbo + len;
 540         loff_t vbo_down = round_down(vbo, PAGE_SIZE);
 541         loff_t i_size;
 542         int err;
 543
 544         /* No support for dir. */
 545         if (!S_ISREG(inode->i_mode))
 546                 return -EOPNOTSUPP;
 547
 548         /* Return error if mode is not supported. */
 549         if (mode & ~(FALLOC_FL_KEEP_SIZE | FALLOC_FL_PUNCH_HOLE |
 550                      FALLOC_FL_COLLAPSE_RANGE)) {
 551                 ntfs_inode_warn(inode, "fallocate(0x%x) is not supported",
 552                                 mode);
 553                 return -EOPNOTSUPP;
 554         }
 555
 556         ntfs_set_state(sbi, NTFS_DIRTY_DIRTY);
 557
 558         inode_lock(inode);
 559         i_size = inode->i_size;
 560
 561         if (WARN_ON(ni->ni_flags & NI_FLAG_COMPRESSED_MASK)) {
 562                 /* Should never be here, see ntfs_file_open. */
 563                 err = -EOPNOTSUPP;
 564                 goto out;
 565         }
 566
 567         if (mode & FALLOC_FL_PUNCH_HOLE) {
 568                 u32 frame_size;
 569                 loff_t mask, vbo_a, end_a, tmp;
 570
 571                 if (!(mode & FALLOC_FL_KEEP_SIZE)) {
 572                         err = -EINVAL;
 573                         goto out;
 574                 }
 575
 576                 err = filemap_write_and_wait_range(inode->i_mapping, vbo,
 577                                                    end - 1);
 578                 if (err)
 579                         goto out;
 580
 581                 err = filemap_write_and_wait_range(inode->i_mapping, end,
 582                                                    LLONG_MAX);
 583                 if (err)
 584                         goto out;
 585
 586                 inode_dio_wait(inode);
 587
 588                 truncate_pagecache(inode, vbo_down);
 589
 590                 if (!is_sparsed(ni) && !is_compressed(ni)) {
 591                         /* normal file */
 592                         err = ntfs_zero_range(inode, vbo, end);
 593                         goto out;
 594                 }
 595
 596                 ni_lock(ni);
 597                 err = attr_punch_hole(ni, vbo, len, &frame_size);
 598                 ni_unlock(ni);
 599                 if (err != E_NTFS_NOTALIGNED)
 600                         goto out;
 601
 602                 /* process not aligned punch */
 603                 mask = frame_size - 1;
 604                 vbo_a = (vbo + mask) & ~mask;
 605                 end_a = end & ~mask;
 606
 607                 tmp = min(vbo_a, end);
 608                 if (tmp > vbo) {
 609                         err = ntfs_zero_range(inode, vbo, tmp);
 610                         if (err)
 611                                 goto out;
 612                 }
 613
 614                 if (vbo < end_a && end_a < end) {
 615                         err = ntfs_zero_range(inode, end_a, end);
 616                         if (err)
 617                                 goto out;
 618                 }
 619
 620                 /* Aligned punch_hole */
 621                 if (end_a > vbo_a) {
 622                         ni_lock(ni);
 623                         err = attr_punch_hole(ni, vbo_a, end_a - vbo_a, NULL);
 624                         ni_unlock(ni);
 625                 }
 626         } else if (mode & FALLOC_FL_COLLAPSE_RANGE) {
 627                 if (mode & ~FALLOC_FL_COLLAPSE_RANGE) {
 628                         err = -EINVAL;
 629                         goto out;
 630                 }
 631
 632                 /*
 633                  * Write tail of the last page before removed range since
 634                  * it will get removed from the page cache below.
 635                  */
 636                 err = filemap_write_and_wait_range(inode->i_mapping, vbo_down,
 637                                                    vbo);
 638                 if (err)
 639                         goto out;
 640
 641                 /*
 642                  * Write data that will be shifted to preserve them
 643                  * when discarding page cache below.
 644                  */
 645                 err = filemap_write_and_wait_range(inode->i_mapping, end,
 646                                                    LLONG_MAX);
 647                 if (err)
 648                         goto out;
 649
 650                 /* Wait for existing dio to complete */
 651                 inode_dio_wait(inode);
 652
 653                 truncate_pagecache(inode, vbo_down);
 654
 655                 ni_lock(ni);
 656                 err = attr_collapse_range(ni, vbo, len);
 657                 ni_unlock(ni);
 658         } else {
 659                 /*
 660                  * Normal file: Allocate clusters, do not change 'valid' size.
 661                  */
 662                 err = ntfs_set_size(inode, max(end, i_size));
 663                 if (err)
 664                         goto out;
 665
 666                 if (is_sparsed(ni) || is_compressed(ni)) {
 667                         CLST vcn_v = ni->i_valid >> sbi->cluster_bits;
 668                         CLST vcn = vbo >> sbi->cluster_bits;
 669                         CLST cend = bytes_to_cluster(sbi, end);
 670                         CLST lcn, clen;
 671                         bool new;
 672
 673                         /*
 674                          * Allocate but do not zero new clusters. (see below comments)
 675                          * This breaks security: One can read unused on-disk areas.
 676                          * Zeroing these clusters may be too long.
 677                          * Maybe we should check here for root rights?
 678                          */
 679                         for (; vcn < cend; vcn += clen) {
 680                                 err = attr_data_get_block(ni, vcn, cend - vcn,
 681                                                           &lcn, &clen, &new);
 682                                 if (err)
 683                                         goto out;
 684                                 if (!new || vcn >= vcn_v)
 685                                         continue;
 686
 687                                 /*
 688                                  * Unwritten area.
 689                                  * NTFS is not able to store several unwritten areas.
 690                                  * Activate 'ntfs_sparse_cluster' to zero new allocated clusters.
 691                                  *
 692                                  * Dangerous in case:
 693                                  * 1G of sparsed clusters + 1 cluster of data =>
 694                                  * valid_size == 1G + 1 cluster
 695                                  * fallocate(1G) will zero 1G and this can be very long
 696                                  * xfstest 016/086 will fail without 'ntfs_sparse_cluster'.
 697                                  */
 698                                 ntfs_sparse_cluster(inode, NULL, vcn,
 699                                                     min(vcn_v - vcn, clen));
 700                         }
 701                 }
 702
 703                 if (mode & FALLOC_FL_KEEP_SIZE) {
 704                         ni_lock(ni);
 705                         /* True - Keep preallocated. */
 706                         err = attr_set_size(ni, ATTR_DATA, NULL, 0,
 707                                             &ni->file.run, i_size, &ni->i_valid,
 708                                             true, NULL);
 709                         ni_unlock(ni);
 710                 }
 711         }
 712
 713 out:
 714         if (err == -EFBIG)
 715                 err = -ENOSPC;
 716
 717         if (!err) {
 718                 inode->i_ctime = inode->i_mtime = current_time(inode);
 719                 mark_inode_dirty(inode);
 720         }
 721
 722         inode_unlock(inode);
 723         return err;
 724 }
 725
 726 /*
 727  * ntfs3_setattr - inode_operations::setattr
 728  */
 729 int ntfs3_setattr(struct user_namespace *mnt_userns, struct dentry *dentry,
 730                   struct iattr *attr)
 731 {
 732         struct super_block *sb = dentry->d_sb;
 733         struct ntfs_sb_info *sbi = sb->s_fs_info;
 734         struct inode *inode = d_inode(dentry);
 735         struct ntfs_inode *ni = ntfs_i(inode);
 736         u32 ia_valid = attr->ia_valid;
 737         umode_t mode = inode->i_mode;
 738         int err;
 739
 740         if (sbi->options.no_acs_rules) {
 741                 /* "No access rules" - Force any changes of time etc. */
 742                 attr->ia_valid |= ATTR_FORCE;
 743                 /* and disable for editing some attributes. */
 744                 attr->ia_valid &= ~(ATTR_UID | ATTR_GID | ATTR_MODE);
 745                 ia_valid = attr->ia_valid;
 746         }
 747
 748         err = setattr_prepare(mnt_userns, dentry, attr);
 749         if (err)
 750                 goto out;
 751
 752         if (ia_valid & ATTR_SIZE) {
 753                 loff_t oldsize = inode->i_size;
 754
 755                 if (WARN_ON(ni->ni_flags & NI_FLAG_COMPRESSED_MASK)) {
 756                         /* Should never be here, see ntfs_file_open(). */
 757                         err = -EOPNOTSUPP;
 758                         goto out;
 759                 }
 760                 inode_dio_wait(inode);
 761
 762                 if (attr->ia_size < oldsize)
 763                         err = ntfs_truncate(inode, attr->ia_size);
 764                 else if (attr->ia_size > oldsize)
 765                         err = ntfs_extend(inode, attr->ia_size, 0, NULL);
 766
 767                 if (err)
 768                         goto out;
 769
 770                 ni->ni_flags |= NI_FLAG_UPDATE_PARENT;
 771         }
 772
 773         setattr_copy(mnt_userns, inode, attr);
 774
 775         if (mode != inode->i_mode) {
 776                 err = ntfs_acl_chmod(mnt_userns, inode);
 777                 if (err)
 778                         goto out;
 779
 780                 /* Linux 'w' -> Windows 'ro'. */
 781                 if (0222 & inode->i_mode)
 782                         ni->std_fa &= ~FILE_ATTRIBUTE_READONLY;
 783                 else
 784                         ni->std_fa |= FILE_ATTRIBUTE_READONLY;
 785         }
 786
 787         if (ia_valid & (ATTR_UID | ATTR_GID | ATTR_MODE))
 788                 ntfs_save_wsl_perm(inode);
 789         mark_inode_dirty(inode);
 790 out:
 791         return err;
 792 }
 793
 794 static ssize_t ntfs_file_read_iter(struct kiocb *iocb, struct iov_iter *iter)
 795 {
 796         ssize_t err;
 797         size_t count = iov_iter_count(iter);
 798         struct file *file = iocb->ki_filp;
 799         struct inode *inode = file->f_mapping->host;
 800         struct ntfs_inode *ni = ntfs_i(inode);
 801
 802         if (is_encrypted(ni)) {
 803                 ntfs_inode_warn(inode, "encrypted i/o not supported");
 804                 return -EOPNOTSUPP;
 805         }
 806
 807         if (is_compressed(ni) && (iocb->ki_flags & IOCB_DIRECT)) {
 808                 ntfs_inode_warn(inode, "direct i/o + compressed not supported");
 809                 return -EOPNOTSUPP;
 810         }
 811
 812 #ifndef CONFIG_NTFS3_LZX_XPRESS
 813         if (ni->ni_flags & NI_FLAG_COMPRESSED_MASK) {
 814                 ntfs_inode_warn(
 815                         inode,
 816                         "activate CONFIG_NTFS3_LZX_XPRESS to read external compressed files");
 817                 return -EOPNOTSUPP;
 818         }
 819 #endif
 820
 821         if (is_dedup(ni)) {
 822                 ntfs_inode_warn(inode, "read deduplicated not supported");
 823                 return -EOPNOTSUPP;
 824         }
 825
 826         err = count ? generic_file_read_iter(iocb, iter) : 0;
 827
 828         return err;
 829 }
 830
 831 /*
 832  * ntfs_get_frame_pages
 833  *
 834  * Return: Array of locked pages.
 835  */
 836 static int ntfs_get_frame_pages(struct address_space *mapping, pgoff_t index,
 837                                 struct page **pages, u32 pages_per_frame,
 838                                 bool *frame_uptodate)
 839 {
 840         gfp_t gfp_mask = mapping_gfp_mask(mapping);
 841         u32 npages;
 842
 843         *frame_uptodate = true;
 844
 845         for (npages = 0; npages < pages_per_frame; npages++, index++) {
 846                 struct page *page;
 847
 848                 page = find_or_create_page(mapping, index, gfp_mask);
 849                 if (!page) {
 850                         while (npages--) {
 851                                 page = pages[npages];
 852                                 unlock_page(page);
 853                                 put_page(page);
 854                         }
 855
 856                         return -ENOMEM;
 857                 }
 858
 859                 if (!PageUptodate(page))
 860                         *frame_uptodate = false;
 861
 862                 pages[npages] = page;
 863         }
 864
 865         return 0;
 866 }
 867
 868 /*
 869  * ntfs_compress_write - Helper for ntfs_file_write_iter() (compressed files).
 870  */
 871 static ssize_t ntfs_compress_write(struct kiocb *iocb, struct iov_iter *from)
 872 {
 873         int err;
 874         struct file *file = iocb->ki_filp;
 875         size_t count = iov_iter_count(from);
 876         loff_t pos = iocb->ki_pos;
 877         struct inode *inode = file_inode(file);
 878         loff_t i_size = inode->i_size;
 879         struct address_space *mapping = inode->i_mapping;
 880         struct ntfs_inode *ni = ntfs_i(inode);
 881         u64 valid = ni->i_valid;
 882         struct ntfs_sb_info *sbi = ni->mi.sbi;
 883         struct page *page, **pages = NULL;
 884         size_t written = 0;
 885         u8 frame_bits = NTFS_LZNT_CUNIT + sbi->cluster_bits;
 886         u32 frame_size = 1u << frame_bits;
 887         u32 pages_per_frame = frame_size >> PAGE_SHIFT;
 888         u32 ip, off;
 889         CLST frame;
 890         u64 frame_vbo;
 891         pgoff_t index;
 892         bool frame_uptodate;
 893
 894         if (frame_size < PAGE_SIZE) {
 895                 /*
 896                  * frame_size == 8K if cluster 512
 897                  * frame_size == 64K if cluster 4096
 898                  */
 899                 ntfs_inode_warn(inode, "page size is bigger than frame size");
 900                 return -EOPNOTSUPP;
 901         }
 902
 903         pages = kmalloc_array(pages_per_frame, sizeof(struct page *), GFP_NOFS);
 904         if (!pages)
 905                 return -ENOMEM;
 906
 907         current->backing_dev_info = inode_to_bdi(inode);
 908         err = file_remove_privs(file);
 909         if (err)
 910                 goto out;
 911
 912         err = file_update_time(file);
 913         if (err)
 914                 goto out;
 915
 916         /* Zero range [valid : pos). */
 917         while (valid < pos) {
 918                 CLST lcn, clen;
 919
 920                 frame = valid >> frame_bits;
 921                 frame_vbo = valid & ~(frame_size - 1);
 922                 off = valid & (frame_size - 1);
 923
 924                 err = attr_data_get_block(ni, frame << NTFS_LZNT_CUNIT, 0, &lcn,
 925                                           &clen, NULL);
 926                 if (err)
 927                         goto out;
 928
 929                 if (lcn == SPARSE_LCN) {
 930                         ni->i_valid = valid =
 931                                 frame_vbo + ((u64)clen << sbi->cluster_bits);
 932                         continue;
 933                 }
 934
 935                 /* Load full frame. */
 936                 err = ntfs_get_frame_pages(mapping, frame_vbo >> PAGE_SHIFT,
 937                                            pages, pages_per_frame,
 938                                            &frame_uptodate);
 939                 if (err)
 940                         goto out;
 941
 942                 if (!frame_uptodate && off) {
 943                         err = ni_read_frame(ni, frame_vbo, pages,
 944                                             pages_per_frame);
 945                         if (err) {
 946                                 for (ip = 0; ip < pages_per_frame; ip++) {
 947                                         page = pages[ip];
 948                                         unlock_page(page);
 949                                         put_page(page);
 950                                 }
 951                                 goto out;
 952                         }
 953                 }
 954
 955                 ip = off >> PAGE_SHIFT;
 956                 off = offset_in_page(valid);
 957                 for (; ip < pages_per_frame; ip++, off = 0) {
 958                         page = pages[ip];
 959                         zero_user_segment(page, off, PAGE_SIZE);
 960                         flush_dcache_page(page);
 961                         SetPageUptodate(page);
 962                 }
 963
 964                 ni_lock(ni);
 965                 err = ni_write_frame(ni, pages, pages_per_frame);
 966                 ni_unlock(ni);
 967
 968                 for (ip = 0; ip < pages_per_frame; ip++) {
 969                         page = pages[ip];
 970                         SetPageUptodate(page);
 971                         unlock_page(page);
 972                         put_page(page);
 973                 }
 974
 975                 if (err)
 976                         goto out;
 977
 978                 ni->i_valid = valid = frame_vbo + frame_size;
 979         }
 980
 981         /* Copy user data [pos : pos + count). */
 982         while (count) {
 983                 size_t copied, bytes;
 984
 985                 off = pos & (frame_size - 1);
 986                 bytes = frame_size - off;
 987                 if (bytes > count)
 988                         bytes = count;
 989
 990                 frame = pos >> frame_bits;
 991                 frame_vbo = pos & ~(frame_size - 1);
 992                 index = frame_vbo >> PAGE_SHIFT;
 993
 994                 if (unlikely(iov_iter_fault_in_readable(from, bytes))) {
 995                         err = -EFAULT;
 996                         goto out;
 997                 }
 998
 999                 /* Load full frame. */
1000                 err = ntfs_get_frame_pages(mapping, index, pages,
1001                                            pages_per_frame, &frame_uptodate);
1002                 if (err)
1003                         goto out;
1004
1005                 if (!frame_uptodate) {
1006                         loff_t to = pos + bytes;
1007
1008                         if (off || (to < i_size && (to & (frame_size - 1)))) {
1009                                 err = ni_read_frame(ni, frame_vbo, pages,
1010                                                     pages_per_frame);
1011                                 if (err) {
1012                                         for (ip = 0; ip < pages_per_frame;
1013                                              ip++) {
1014                                                 page = pages[ip];
1015                                                 unlock_page(page);
1016                                                 put_page(page);
1017                                         }
1018                                         goto out;
1019                                 }
1020                         }
1021                 }
1022
1023                 WARN_ON(!bytes);
1024                 copied = 0;
1025                 ip = off >> PAGE_SHIFT;
1026                 off = offset_in_page(pos);
1027
1028                 /* Copy user data to pages. */
1029                 for (;;) {
1030                         size_t cp, tail = PAGE_SIZE - off;
1031
1032                         page = pages[ip];
1033                         cp = copy_page_from_iter_atomic(page, off,
1034                                                         min(tail, bytes), from);
1035                         flush_dcache_page(page);
1036
1037                         copied += cp;
1038                         bytes -= cp;
1039                         if (!bytes || !cp)
1040                                 break;
1041
1042                         if (cp < tail) {
1043                                 off += cp;
1044                         } else {
1045                                 ip++;
1046                                 off = 0;
1047                         }
1048                 }
1049
1050                 ni_lock(ni);
1051                 err = ni_write_frame(ni, pages, pages_per_frame);
1052                 ni_unlock(ni);
1053
1054                 for (ip = 0; ip < pages_per_frame; ip++) {
1055                         page = pages[ip];
1056                         ClearPageDirty(page);
1057                         SetPageUptodate(page);
1058                         unlock_page(page);
1059                         put_page(page);
1060                 }
1061
1062                 if (err)
1063                         goto out;
1064
1065                 /*
1066                  * We can loop for a long time in here. Be nice and allow
1067                  * us to schedule out to avoid softlocking if preempt
1068                  * is disabled.
1069                  */
1070                 cond_resched();
1071
1072                 pos += copied;
1073                 written += copied;
1074
1075                 count = iov_iter_count(from);
1076         }
1077
1078 out:
1079         kfree(pages);
1080
1081         current->backing_dev_info = NULL;
1082
1083         if (err < 0)
1084                 return err;
1085
1086         iocb->ki_pos += written;
1087         if (iocb->ki_pos > ni->i_valid)
1088                 ni->i_valid = iocb->ki_pos;
1089
1090         return written;
1091 }
1092
1093 /*
1094  * ntfs_file_write_iter - file_operations::write_iter
1095  */
1096 static ssize_t ntfs_file_write_iter(struct kiocb *iocb, struct iov_iter *from)
1097 {
1098         struct file *file = iocb->ki_filp;
1099         struct address_space *mapping = file->f_mapping;
1100         struct inode *inode = mapping->host;
1101         ssize_t ret;
1102         struct ntfs_inode *ni = ntfs_i(inode);
1103
1104         if (is_encrypted(ni)) {
1105                 ntfs_inode_warn(inode, "encrypted i/o not supported");
1106                 return -EOPNOTSUPP;
1107         }
1108
1109         if (is_compressed(ni) && (iocb->ki_flags & IOCB_DIRECT)) {
1110                 ntfs_inode_warn(inode, "direct i/o + compressed not supported");
1111                 return -EOPNOTSUPP;
1112         }
1113
1114         if (is_dedup(ni)) {
1115                 ntfs_inode_warn(inode, "write into deduplicated not supported");
1116                 return -EOPNOTSUPP;
1117         }
1118
1119         if (!inode_trylock(inode)) {
1120                 if (iocb->ki_flags & IOCB_NOWAIT)
1121                         return -EAGAIN;
1122                 inode_lock(inode);
1123         }
1124
1125         ret = generic_write_checks(iocb, from);
1126         if (ret <= 0)
1127                 goto out;
1128
1129         if (WARN_ON(ni->ni_flags & NI_FLAG_COMPRESSED_MASK)) {
1130                 /* Should never be here, see ntfs_file_open() */
1131                 ret = -EOPNOTSUPP;
1132                 goto out;
1133         }
1134
1135         ret = ntfs_extend(inode, iocb->ki_pos, ret, file);
1136         if (ret)
1137                 goto out;
1138
1139         ret = is_compressed(ni) ? ntfs_compress_write(iocb, from)
1140                                 : __generic_file_write_iter(iocb, from);
1141
1142 out:
1143         inode_unlock(inode);
1144
1145         if (ret > 0)
1146                 ret = generic_write_sync(iocb, ret);
1147
1148         return ret;
1149 }
1150
1151 /*
1152  * ntfs_file_open - file_operations::open
1153  */
1154 int ntfs_file_open(struct inode *inode, struct file *file)
1155 {
1156         struct ntfs_inode *ni = ntfs_i(inode);
1157
1158         if (unlikely((is_compressed(ni) || is_encrypted(ni)) &&
1159                      (file->f_flags & O_DIRECT))) {
1160                 return -EOPNOTSUPP;
1161         }
1162
1163         /* Decompress "external compressed" file if opened for rw. */
1164         if ((ni->ni_flags & NI_FLAG_COMPRESSED_MASK) &&
1165             (file->f_flags & (O_WRONLY | O_RDWR | O_TRUNC))) {
1166 #ifdef CONFIG_NTFS3_LZX_XPRESS
1167                 int err = ni_decompress_file(ni);
1168
1169                 if (err)
1170                         return err;
1171 #else
1172                 ntfs_inode_warn(
1173                         inode,
1174                         "activate CONFIG_NTFS3_LZX_XPRESS to write external compressed files");
1175                 return -EOPNOTSUPP;
1176 #endif
1177         }
1178
1179         return generic_file_open(inode, file);
1180 }
1181
1182 /*
1183  * ntfs_file_release - file_operations::release
1184  */
1185 static int ntfs_file_release(struct inode *inode, struct file *file)
1186 {
1187         struct ntfs_inode *ni = ntfs_i(inode);
1188         struct ntfs_sb_info *sbi = ni->mi.sbi;
1189         int err = 0;
1190
1191         /* If we are last writer on the inode, drop the block reservation. */
1192         if (sbi->options.prealloc && ((file->f_mode & FMODE_WRITE) &&
1193                                       atomic_read(&inode->i_writecount) == 1)) {
1194                 ni_lock(ni);
1195                 down_write(&ni->file.run_lock);
1196
1197                 err = attr_set_size(ni, ATTR_DATA, NULL, 0, &ni->file.run,
1198                                     inode->i_size, &ni->i_valid, false, NULL);
1199
1200                 up_write(&ni->file.run_lock);
1201                 ni_unlock(ni);
1202         }
1203         return err;
1204 }
1205
1206 /*
1207  * ntfs_fiemap - file_operations::fiemap
1208  */
1209 int ntfs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
1210                 __u64 start, __u64 len)
1211 {
1212         int err;
1213         struct ntfs_inode *ni = ntfs_i(inode);
1214
1215         if (fieinfo->fi_flags & FIEMAP_FLAG_XATTR)
1216                 return -EOPNOTSUPP;
1217
1218         ni_lock(ni);
1219
1220         err = ni_fiemap(ni, fieinfo, start, len);
1221
1222         ni_unlock(ni);
1223
1224         return err;
1225 }
1226
1227 // clang-format off
1228 const struct inode_operations ntfs_file_inode_operations = {
1229         .getattr        = ntfs_getattr,
1230         .setattr        = ntfs3_setattr,
1231         .listxattr      = ntfs_listxattr,
1232         .permission     = ntfs_permission,
1233         .get_acl        = ntfs_get_acl,
1234         .set_acl        = ntfs_set_acl,
1235         .fiemap         = ntfs_fiemap,
1236 };
1237
1238 const struct file_operations ntfs_file_operations = {
1239         .llseek         = generic_file_llseek,
1240         .read_iter      = ntfs_file_read_iter,
1241         .write_iter     = ntfs_file_write_iter,
1242         .unlocked_ioctl = ntfs_ioctl,
1243 #ifdef CONFIG_COMPAT
1244         .compat_ioctl   = ntfs_compat_ioctl,
1245 #endif
1246         .splice_read    = generic_file_splice_read,
1247         .mmap           = ntfs_file_mmap,
1248         .open           = ntfs_file_open,
1249         .fsync          = generic_file_fsync,
1250         .splice_write   = iter_file_splice_write,
1251         .fallocate      = ntfs_fallocate,
1252         .release        = ntfs_file_release,
1253 };
1254 // clang-format on