fs/ntfs3/ntfs_fs.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  *
   4  * Copyright (C) 2019-2021 Paragon Software GmbH, All rights reserved.
   5  *
   6  */
   7
   8 // clang-format off
   9 #ifndef _LINUX_NTFS3_NTFS_FS_H
  10 #define _LINUX_NTFS3_NTFS_FS_H
  11
  12 #include <linux/blkdev.h>
  13 #include <linux/buffer_head.h>
  14 #include <linux/fs.h>
  15 #include <linux/highmem.h>
  16 #include <linux/kernel.h>
  17 #include <linux/mm.h>
  18 #include <linux/mutex.h>
  19 #include <linux/page-flags.h>
  20 #include <linux/pagemap.h>
  21 #include <linux/rbtree.h>
  22 #include <linux/rwsem.h>
  23 #include <linux/slab.h>
  24 #include <linux/string.h>
  25 #include <linux/time64.h>
  26 #include <linux/types.h>
  27 #include <linux/uidgid.h>
  28 #include <asm/div64.h>
  29 #include <asm/page.h>
  30
  31 #include "debug.h"
  32 #include "ntfs.h"
  33
  34 struct dentry;
  35 struct fiemap_extent_info;
  36 struct user_namespace;
  37 struct page;
  38 struct writeback_control;
  39 enum utf16_endian;
  40
  41
  42 #define MINUS_ONE_T                     ((size_t)(-1))
  43 /* Biggest MFT / smallest cluster */
  44 #define MAXIMUM_BYTES_PER_MFT           4096
  45 #define NTFS_BLOCKS_PER_MFT_RECORD      (MAXIMUM_BYTES_PER_MFT / 512)
  46
  47 #define MAXIMUM_BYTES_PER_INDEX         4096
  48 #define NTFS_BLOCKS_PER_INODE           (MAXIMUM_BYTES_PER_INDEX / 512)
  49
  50 /* NTFS specific error code when fixup failed. */
  51 #define E_NTFS_FIXUP                    555
  52 /* NTFS specific error code about resident->nonresident. */
  53 #define E_NTFS_NONRESIDENT              556
  54 /* NTFS specific error code about punch hole. */
  55 #define E_NTFS_NOTALIGNED               557
  56 /* NTFS specific error code when on-disk struct is corrupted. */
  57 #define E_NTFS_CORRUPT                  558
  58
  59
  60 /* sbi->flags */
  61 #define NTFS_FLAGS_NODISCARD            0x00000001
  62 /* Set when LogFile is replaying. */
  63 #define NTFS_FLAGS_LOG_REPLAYING        0x00000008
  64 /* Set when we changed first MFT's which copy must be updated in $MftMirr. */
  65 #define NTFS_FLAGS_MFTMIRR              0x00001000
  66 #define NTFS_FLAGS_NEED_REPLAY          0x04000000
  67
  68
  69 /* ni->ni_flags */
  70 /*
  71  * Data attribute is external compressed (LZX/Xpress)
  72  * 1 - WOF_COMPRESSION_XPRESS4K
  73  * 2 - WOF_COMPRESSION_XPRESS8K
  74  * 3 - WOF_COMPRESSION_XPRESS16K
  75  * 4 - WOF_COMPRESSION_LZX32K
  76  */
  77 #define NI_FLAG_COMPRESSED_MASK         0x0000000f
  78 /* Data attribute is deduplicated. */
  79 #define NI_FLAG_DEDUPLICATED            0x00000010
  80 #define NI_FLAG_EA                      0x00000020
  81 #define NI_FLAG_DIR                     0x00000040
  82 #define NI_FLAG_RESIDENT                0x00000080
  83 #define NI_FLAG_UPDATE_PARENT           0x00000100
  84 // clang-format on
  85
  86 struct ntfs_mount_options {
  87         char *nls_name;
  88         struct nls_table *nls;
  89
  90         kuid_t fs_uid;
  91         kgid_t fs_gid;
  92         u16 fs_fmask_inv;
  93         u16 fs_dmask_inv;
  94
  95         unsigned fmask : 1; /* fmask was set. */
  96         unsigned dmask : 1; /*dmask was set. */
  97         unsigned sys_immutable : 1; /* Immutable system files. */
  98         unsigned discard : 1; /* Issue discard requests on deletions. */
  99         unsigned sparse : 1; /* Create sparse files. */
 100         unsigned showmeta : 1; /* Show meta files. */
 101         unsigned nohidden : 1; /* Do not show hidden files. */
 102         unsigned force : 1; /* RW mount dirty volume. */
 103         unsigned noacsrules : 1; /* Exclude acs rules. */
 104         unsigned prealloc : 1; /* Preallocate space when file is growing. */
 105 };
 106
 107 /* Special value to unpack and deallocate. */
 108 #define RUN_DEALLOCATE ((struct runs_tree *)(size_t)1)
 109
 110 /* TODO: Use rb tree instead of array. */
 111 struct runs_tree {
 112         struct ntfs_run *runs;
 113         size_t count; /* Currently used size a ntfs_run storage. */
 114         size_t allocated; /* Currently allocated ntfs_run storage size. */
 115 };
 116
 117 struct ntfs_buffers {
 118         /* Biggest MFT / smallest cluster = 4096 / 512 = 8 */
 119         /* Biggest index / smallest cluster = 4096 / 512 = 8 */
 120         struct buffer_head *bh[PAGE_SIZE >> SECTOR_SHIFT];
 121         u32 bytes;
 122         u32 nbufs;
 123         u32 off;
 124 };
 125
 126 enum ALLOCATE_OPT {
 127         ALLOCATE_DEF = 0, // Allocate all clusters.
 128         ALLOCATE_MFT = 1, // Allocate for MFT.
 129 };
 130
 131 enum bitmap_mutex_classes {
 132         BITMAP_MUTEX_CLUSTERS = 0,
 133         BITMAP_MUTEX_MFT = 1,
 134 };
 135
 136 struct wnd_bitmap {
 137         struct super_block *sb;
 138         struct rw_semaphore rw_lock;
 139
 140         struct runs_tree run;
 141         size_t nbits;
 142
 143         size_t total_zeroes; // Total number of free bits.
 144         u16 *free_bits; // Free bits in each window.
 145         size_t nwnd;
 146         u32 bits_last; // Bits in last window.
 147
 148         struct rb_root start_tree; // Extents, sorted by 'start'.
 149         struct rb_root count_tree; // Extents, sorted by 'count + start'.
 150         size_t count; // Extents count.
 151
 152         /*
 153          * -1 Tree is activated but not updated (too many fragments).
 154          * 0 - Tree is not activated.
 155          * 1 - Tree is activated and updated.
 156          */
 157         int uptodated;
 158         size_t extent_min; // Minimal extent used while building.
 159         size_t extent_max; // Upper estimate of biggest free block.
 160
 161         /* Zone [bit, end) */
 162         size_t zone_bit;
 163         size_t zone_end;
 164
 165         bool set_tail; // Not necessary in driver.
 166         bool inited;
 167 };
 168
 169 typedef int (*NTFS_CMP_FUNC)(const void *key1, size_t len1, const void *key2,
 170                              size_t len2, const void *param);
 171
 172 enum index_mutex_classed {
 173         INDEX_MUTEX_I30 = 0,
 174         INDEX_MUTEX_SII = 1,
 175         INDEX_MUTEX_SDH = 2,
 176         INDEX_MUTEX_SO = 3,
 177         INDEX_MUTEX_SQ = 4,
 178         INDEX_MUTEX_SR = 5,
 179         INDEX_MUTEX_TOTAL
 180 };
 181
 182 /* ntfs_index - Allocation unit inside directory. */
 183 struct ntfs_index {
 184         struct runs_tree bitmap_run;
 185         struct runs_tree alloc_run;
 186         /* read/write access to 'bitmap_run'/'alloc_run' while ntfs_readdir */
 187         struct rw_semaphore run_lock;
 188
 189         /*TODO: Remove 'cmp'. */
 190         NTFS_CMP_FUNC cmp;
 191
 192         u8 index_bits; // log2(root->index_block_size)
 193         u8 idx2vbn_bits; // log2(root->index_block_clst)
 194         u8 vbn2vbo_bits; // index_block_size < cluster? 9 : cluster_bits
 195         u8 type; // index_mutex_classed
 196 };
 197
 198 /* Minimum MFT zone. */
 199 #define NTFS_MIN_MFT_ZONE 100
 200
 201 /* Ntfs file system in-core superblock data. */
 202 struct ntfs_sb_info {
 203         struct super_block *sb;
 204
 205         u32 discard_granularity;
 206         u64 discard_granularity_mask_inv; // ~(discard_granularity_mask_inv-1)
 207
 208         u32 cluster_size; // bytes per cluster
 209         u32 cluster_mask; // == cluster_size - 1
 210         u64 cluster_mask_inv; // ~(cluster_size - 1)
 211         u32 block_mask; // sb->s_blocksize - 1
 212         u32 blocks_per_cluster; // cluster_size / sb->s_blocksize
 213
 214         u32 record_size;
 215         u32 index_size;
 216
 217         u8 cluster_bits;
 218         u8 record_bits;
 219
 220         u64 maxbytes; // Maximum size for normal files.
 221         u64 maxbytes_sparse; // Maximum size for sparse file.
 222
 223         u32 flags; // See NTFS_FLAGS_XXX.
 224
 225         CLST zone_max; // Maximum MFT zone length in clusters
 226         CLST bad_clusters; // The count of marked bad clusters.
 227
 228         u16 max_bytes_per_attr; // Maximum attribute size in record.
 229         u16 attr_size_tr; // Attribute size threshold (320 bytes).
 230
 231         /* Records in $Extend. */
 232         CLST objid_no;
 233         CLST quota_no;
 234         CLST reparse_no;
 235         CLST usn_jrnl_no;
 236
 237         struct ATTR_DEF_ENTRY *def_table; // Attribute definition table.
 238         u32 def_entries;
 239         u32 ea_max_size;
 240
 241         struct MFT_REC *new_rec;
 242
 243         u16 *upcase;
 244
 245         struct {
 246                 u64 lbo, lbo2;
 247                 struct ntfs_inode *ni;
 248                 struct wnd_bitmap bitmap; // $MFT::Bitmap
 249                 /*
 250                  * MFT records [11-24) used to expand MFT itself.
 251                  * They always marked as used in $MFT::Bitmap
 252                  * 'reserved_bitmap' contains real bitmap of these records.
 253                  */
 254                 ulong reserved_bitmap; // Bitmap of used records [11 - 24)
 255                 size_t next_free; // The next record to allocate from
 256                 size_t used; // MFT valid size in records.
 257                 u32 recs_mirr; // Number of records in MFTMirr
 258                 u8 next_reserved;
 259                 u8 reserved_bitmap_inited;
 260         } mft;
 261
 262         struct {
 263                 struct wnd_bitmap bitmap; // $Bitmap::Data
 264                 CLST next_free_lcn;
 265         } used;
 266
 267         struct {
 268                 u64 size; // In bytes.
 269                 u64 blocks; // In blocks.
 270                 u64 ser_num;
 271                 struct ntfs_inode *ni;
 272                 __le16 flags; // Cached current VOLUME_INFO::flags, VOLUME_FLAG_DIRTY.
 273                 u8 major_ver;
 274                 u8 minor_ver;
 275                 char label[65];
 276                 bool real_dirty; // Real fs state.
 277         } volume;
 278
 279         struct {
 280                 struct ntfs_index index_sii;
 281                 struct ntfs_index index_sdh;
 282                 struct ntfs_inode *ni;
 283                 u32 next_id;
 284                 u64 next_off;
 285
 286                 __le32 def_security_id;
 287         } security;
 288
 289         struct {
 290                 struct ntfs_index index_r;
 291                 struct ntfs_inode *ni;
 292                 u64 max_size; // 16K
 293         } reparse;
 294
 295         struct {
 296                 struct ntfs_index index_o;
 297                 struct ntfs_inode *ni;
 298         } objid;
 299
 300         struct {
 301                 struct mutex mtx_lznt;
 302                 struct lznt *lznt;
 303 #ifdef CONFIG_NTFS3_LZX_XPRESS
 304                 struct mutex mtx_xpress;
 305                 struct xpress_decompressor *xpress;
 306                 struct mutex mtx_lzx;
 307                 struct lzx_decompressor *lzx;
 308 #endif
 309         } compress;
 310
 311         struct ntfs_mount_options *options;
 312         struct ratelimit_state msg_ratelimit;
 313 };
 314
 315 /* One MFT record(usually 1024 bytes), consists of attributes. */
 316 struct mft_inode {
 317         struct rb_node node;
 318         struct ntfs_sb_info *sbi;
 319
 320         struct MFT_REC *mrec;
 321         struct ntfs_buffers nb;
 322
 323         CLST rno;
 324         bool dirty;
 325 };
 326
 327 /* Nested class for ntfs_inode::ni_lock. */
 328 enum ntfs_inode_mutex_lock_class {
 329         NTFS_INODE_MUTEX_DIRTY,
 330         NTFS_INODE_MUTEX_SECURITY,
 331         NTFS_INODE_MUTEX_OBJID,
 332         NTFS_INODE_MUTEX_REPARSE,
 333         NTFS_INODE_MUTEX_NORMAL,
 334         NTFS_INODE_MUTEX_PARENT,
 335 };
 336
 337 /*
 338  * sturct ntfs_inode
 339  *
 340  * Ntfs inode - extends linux inode. consists of one or more MFT inodes.
 341  */
 342 struct ntfs_inode {
 343         struct mft_inode mi; // base record
 344
 345         /*
 346          * Valid size: [0 - i_valid) - these range in file contains valid data.
 347          * Range [i_valid - inode->i_size) - contains 0.
 348          * Usually i_valid <= inode->i_size.
 349          */
 350         u64 i_valid;
 351         struct timespec64 i_crtime;
 352
 353         struct mutex ni_lock;
 354
 355         /* File attributes from std. */
 356         enum FILE_ATTRIBUTE std_fa;
 357         __le32 std_security_id;
 358
 359         /*
 360          * Tree of mft_inode.
 361          * Not empty when primary MFT record (usually 1024 bytes) can't save all attributes
 362          * e.g. file becomes too fragmented or contains a lot of names.
 363          */
 364         struct rb_root mi_tree;
 365
 366         /*
 367          * This member is used in ntfs_readdir to ensure that all subrecords are loaded
 368          */
 369         u8 mi_loaded;
 370
 371         union {
 372                 struct ntfs_index dir;
 373                 struct {
 374                         struct rw_semaphore run_lock;
 375                         struct runs_tree run;
 376 #ifdef CONFIG_NTFS3_LZX_XPRESS
 377                         struct page *offs_page;
 378 #endif
 379                 } file;
 380         };
 381
 382         struct {
 383                 struct runs_tree run;
 384                 struct ATTR_LIST_ENTRY *le; // 1K aligned memory.
 385                 size_t size;
 386                 bool dirty;
 387         } attr_list;
 388
 389         size_t ni_flags; // NI_FLAG_XXX
 390
 391         struct inode vfs_inode;
 392 };
 393
 394 struct indx_node {
 395         struct ntfs_buffers nb;
 396         struct INDEX_BUFFER *index;
 397 };
 398
 399 struct ntfs_fnd {
 400         int level;
 401         struct indx_node *nodes[20];
 402         struct NTFS_DE *de[20];
 403         struct NTFS_DE *root_de;
 404 };
 405
 406 enum REPARSE_SIGN {
 407         REPARSE_NONE = 0,
 408         REPARSE_COMPRESSED = 1,
 409         REPARSE_DEDUPLICATED = 2,
 410         REPARSE_LINK = 3
 411 };
 412
 413 /* Functions from attrib.c */
 414 int attr_allocate_clusters(struct ntfs_sb_info *sbi, struct runs_tree *run,
 415                            CLST vcn, CLST lcn, CLST len, CLST *pre_alloc,
 416                            enum ALLOCATE_OPT opt, CLST *alen, const size_t fr,
 417                            CLST *new_lcn);
 418 int attr_make_nonresident(struct ntfs_inode *ni, struct ATTRIB *attr,
 419                           struct ATTR_LIST_ENTRY *le, struct mft_inode *mi,
 420                           u64 new_size, struct runs_tree *run,
 421                           struct ATTRIB **ins_attr, struct page *page);
 422 int attr_set_size(struct ntfs_inode *ni, enum ATTR_TYPE type,
 423                   const __le16 *name, u8 name_len, struct runs_tree *run,
 424                   u64 new_size, const u64 *new_valid, bool keep_prealloc,
 425                   struct ATTRIB **ret);
 426 int attr_data_get_block(struct ntfs_inode *ni, CLST vcn, CLST clen, CLST *lcn,
 427                         CLST *len, bool *new);
 428 int attr_data_read_resident(struct ntfs_inode *ni, struct page *page);
 429 int attr_data_write_resident(struct ntfs_inode *ni, struct page *page);
 430 int attr_load_runs_vcn(struct ntfs_inode *ni, enum ATTR_TYPE type,
 431                        const __le16 *name, u8 name_len, struct runs_tree *run,
 432                        CLST vcn);
 433 int attr_load_runs_range(struct ntfs_inode *ni, enum ATTR_TYPE type,
 434                          const __le16 *name, u8 name_len, struct runs_tree *run,
 435                          u64 from, u64 to);
 436 int attr_wof_frame_info(struct ntfs_inode *ni, struct ATTRIB *attr,
 437                         struct runs_tree *run, u64 frame, u64 frames,
 438                         u8 frame_bits, u32 *ondisk_size, u64 *vbo_data);
 439 int attr_is_frame_compressed(struct ntfs_inode *ni, struct ATTRIB *attr,
 440                              CLST frame, CLST *clst_data);
 441 int attr_allocate_frame(struct ntfs_inode *ni, CLST frame, size_t compr_size,
 442                         u64 new_valid);
 443 int attr_collapse_range(struct ntfs_inode *ni, u64 vbo, u64 bytes);
 444 int attr_insert_range(struct ntfs_inode *ni, u64 vbo, u64 bytes);
 445 int attr_punch_hole(struct ntfs_inode *ni, u64 vbo, u64 bytes, u32 *frame_size);
 446
 447 /* Functions from attrlist.c */
 448 void al_destroy(struct ntfs_inode *ni);
 449 bool al_verify(struct ntfs_inode *ni);
 450 int ntfs_load_attr_list(struct ntfs_inode *ni, struct ATTRIB *attr);
 451 struct ATTR_LIST_ENTRY *al_enumerate(struct ntfs_inode *ni,
 452                                      struct ATTR_LIST_ENTRY *le);
 453 struct ATTR_LIST_ENTRY *al_find_le(struct ntfs_inode *ni,
 454                                    struct ATTR_LIST_ENTRY *le,
 455                                    const struct ATTRIB *attr);
 456 struct ATTR_LIST_ENTRY *al_find_ex(struct ntfs_inode *ni,
 457                                    struct ATTR_LIST_ENTRY *le,
 458                                    enum ATTR_TYPE type, const __le16 *name,
 459                                    u8 name_len, const CLST *vcn);
 460 int al_add_le(struct ntfs_inode *ni, enum ATTR_TYPE type, const __le16 *name,
 461               u8 name_len, CLST svcn, __le16 id, const struct MFT_REF *ref,
 462               struct ATTR_LIST_ENTRY **new_le);
 463 bool al_remove_le(struct ntfs_inode *ni, struct ATTR_LIST_ENTRY *le);
 464 bool al_delete_le(struct ntfs_inode *ni, enum ATTR_TYPE type, CLST vcn,
 465                   const __le16 *name, size_t name_len,
 466                   const struct MFT_REF *ref);
 467 int al_update(struct ntfs_inode *ni, int sync);
 468 static inline size_t al_aligned(size_t size)
 469 {
 470         return size_add(size, 1023) & ~(size_t)1023;
 471 }
 472
 473 /* Globals from bitfunc.c */
 474 bool are_bits_clear(const ulong *map, size_t bit, size_t nbits);
 475 bool are_bits_set(const ulong *map, size_t bit, size_t nbits);
 476 size_t get_set_bits_ex(const ulong *map, size_t bit, size_t nbits);
 477
 478 /* Globals from dir.c */
 479 int ntfs_utf16_to_nls(struct ntfs_sb_info *sbi, const __le16 *name, u32 len,
 480                       u8 *buf, int buf_len);
 481 int ntfs_nls_to_utf16(struct ntfs_sb_info *sbi, const u8 *name, u32 name_len,
 482                       struct cpu_str *uni, u32 max_ulen,
 483                       enum utf16_endian endian);
 484 struct inode *dir_search_u(struct inode *dir, const struct cpu_str *uni,
 485                            struct ntfs_fnd *fnd);
 486 bool dir_is_empty(struct inode *dir);
 487 extern const struct file_operations ntfs_dir_operations;
 488
 489 /* Globals from file.c */
 490 int ntfs_getattr(struct user_namespace *mnt_userns, const struct path *path,
 491                  struct kstat *stat, u32 request_mask, u32 flags);
 492 void ntfs_sparse_cluster(struct inode *inode, struct page *page0, CLST vcn,
 493                          CLST len);
 494 int ntfs3_setattr(struct user_namespace *mnt_userns, struct dentry *dentry,
 495                   struct iattr *attr);
 496 int ntfs_file_open(struct inode *inode, struct file *file);
 497 int ntfs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
 498                 __u64 start, __u64 len);
 499 extern const struct inode_operations ntfs_special_inode_operations;
 500 extern const struct inode_operations ntfs_file_inode_operations;
 501 extern const struct file_operations ntfs_file_operations;
 502
 503 /* Globals from frecord.c */
 504 void ni_remove_mi(struct ntfs_inode *ni, struct mft_inode *mi);
 505 struct ATTR_STD_INFO *ni_std(struct ntfs_inode *ni);
 506 struct ATTR_STD_INFO5 *ni_std5(struct ntfs_inode *ni);
 507 void ni_clear(struct ntfs_inode *ni);
 508 int ni_load_mi_ex(struct ntfs_inode *ni, CLST rno, struct mft_inode **mi);
 509 int ni_load_mi(struct ntfs_inode *ni, const struct ATTR_LIST_ENTRY *le,
 510                struct mft_inode **mi);
 511 struct ATTRIB *ni_find_attr(struct ntfs_inode *ni, struct ATTRIB *attr,
 512                             struct ATTR_LIST_ENTRY **entry_o,
 513                             enum ATTR_TYPE type, const __le16 *name,
 514                             u8 name_len, const CLST *vcn,
 515                             struct mft_inode **mi);
 516 struct ATTRIB *ni_enum_attr_ex(struct ntfs_inode *ni, struct ATTRIB *attr,
 517                                struct ATTR_LIST_ENTRY **le,
 518                                struct mft_inode **mi);
 519 struct ATTRIB *ni_load_attr(struct ntfs_inode *ni, enum ATTR_TYPE type,
 520                             const __le16 *name, u8 name_len, CLST vcn,
 521                             struct mft_inode **pmi);
 522 int ni_load_all_mi(struct ntfs_inode *ni);
 523 bool ni_add_subrecord(struct ntfs_inode *ni, CLST rno, struct mft_inode **mi);
 524 int ni_remove_attr(struct ntfs_inode *ni, enum ATTR_TYPE type,
 525                    const __le16 *name, size_t name_len, bool base_only,
 526                    const __le16 *id);
 527 int ni_create_attr_list(struct ntfs_inode *ni);
 528 int ni_expand_list(struct ntfs_inode *ni);
 529 int ni_insert_nonresident(struct ntfs_inode *ni, enum ATTR_TYPE type,
 530                           const __le16 *name, u8 name_len,
 531                           const struct runs_tree *run, CLST svcn, CLST len,
 532                           __le16 flags, struct ATTRIB **new_attr,
 533                           struct mft_inode **mi, struct ATTR_LIST_ENTRY **le);
 534 int ni_insert_resident(struct ntfs_inode *ni, u32 data_size,
 535                        enum ATTR_TYPE type, const __le16 *name, u8 name_len,
 536                        struct ATTRIB **new_attr, struct mft_inode **mi,
 537                        struct ATTR_LIST_ENTRY **le);
 538 void ni_remove_attr_le(struct ntfs_inode *ni, struct ATTRIB *attr,
 539                        struct mft_inode *mi, struct ATTR_LIST_ENTRY *le);
 540 int ni_delete_all(struct ntfs_inode *ni);
 541 struct ATTR_FILE_NAME *ni_fname_name(struct ntfs_inode *ni,
 542                                      const struct cpu_str *uni,
 543                                      const struct MFT_REF *home,
 544                                      struct mft_inode **mi,
 545                                      struct ATTR_LIST_ENTRY **entry);
 546 struct ATTR_FILE_NAME *ni_fname_type(struct ntfs_inode *ni, u8 name_type,
 547                                      struct mft_inode **mi,
 548                                      struct ATTR_LIST_ENTRY **entry);
 549 int ni_new_attr_flags(struct ntfs_inode *ni, enum FILE_ATTRIBUTE new_fa);
 550 enum REPARSE_SIGN ni_parse_reparse(struct ntfs_inode *ni, struct ATTRIB *attr,
 551                                    struct REPARSE_DATA_BUFFER *buffer);
 552 int ni_write_inode(struct inode *inode, int sync, const char *hint);
 553 #define _ni_write_inode(i, w) ni_write_inode(i, w, __func__)
 554 int ni_fiemap(struct ntfs_inode *ni, struct fiemap_extent_info *fieinfo,
 555               __u64 vbo, __u64 len);
 556 int ni_readpage_cmpr(struct ntfs_inode *ni, struct page *page);
 557 int ni_decompress_file(struct ntfs_inode *ni);
 558 int ni_read_frame(struct ntfs_inode *ni, u64 frame_vbo, struct page **pages,
 559                   u32 pages_per_frame);
 560 int ni_write_frame(struct ntfs_inode *ni, struct page **pages,
 561                    u32 pages_per_frame);
 562 int ni_remove_name(struct ntfs_inode *dir_ni, struct ntfs_inode *ni,
 563                    struct NTFS_DE *de, struct NTFS_DE **de2, int *undo_step);
 564
 565 bool ni_remove_name_undo(struct ntfs_inode *dir_ni, struct ntfs_inode *ni,
 566                          struct NTFS_DE *de, struct NTFS_DE *de2,
 567                          int undo_step);
 568
 569 int ni_add_name(struct ntfs_inode *dir_ni, struct ntfs_inode *ni,
 570                 struct NTFS_DE *de);
 571
 572 int ni_rename(struct ntfs_inode *dir_ni, struct ntfs_inode *new_dir_ni,
 573               struct ntfs_inode *ni, struct NTFS_DE *de, struct NTFS_DE *new_de,
 574               bool *is_bad);
 575
 576 bool ni_is_dirty(struct inode *inode);
 577
 578 /* Globals from fslog.c */
 579 bool check_index_header(const struct INDEX_HDR *hdr, size_t bytes);
 580 int log_replay(struct ntfs_inode *ni, bool *initialized);
 581
 582 /* Globals from fsntfs.c */
 583 struct buffer_head *ntfs_bread(struct super_block *sb, sector_t block);
 584 bool ntfs_fix_pre_write(struct NTFS_RECORD_HEADER *rhdr, size_t bytes);
 585 int ntfs_fix_post_read(struct NTFS_RECORD_HEADER *rhdr, size_t bytes,
 586                        bool simple);
 587 int ntfs_extend_init(struct ntfs_sb_info *sbi);
 588 int ntfs_loadlog_and_replay(struct ntfs_inode *ni, struct ntfs_sb_info *sbi);
 589 const struct ATTR_DEF_ENTRY *ntfs_query_def(struct ntfs_sb_info *sbi,
 590                                             enum ATTR_TYPE Type);
 591 int ntfs_look_for_free_space(struct ntfs_sb_info *sbi, CLST lcn, CLST len,
 592                              CLST *new_lcn, CLST *new_len,
 593                              enum ALLOCATE_OPT opt);
 594 int ntfs_look_free_mft(struct ntfs_sb_info *sbi, CLST *rno, bool mft,
 595                        struct ntfs_inode *ni, struct mft_inode **mi);
 596 void ntfs_mark_rec_free(struct ntfs_sb_info *sbi, CLST rno, bool is_mft);
 597 int ntfs_clear_mft_tail(struct ntfs_sb_info *sbi, size_t from, size_t to);
 598 int ntfs_refresh_zone(struct ntfs_sb_info *sbi);
 599 void ntfs_update_mftmirr(struct ntfs_sb_info *sbi, int wait);
 600 void ntfs_bad_inode(struct inode *inode, const char *hint);
 601 #define _ntfs_bad_inode(i) ntfs_bad_inode(i, __func__)
 602 enum NTFS_DIRTY_FLAGS {
 603         NTFS_DIRTY_CLEAR = 0,
 604         NTFS_DIRTY_DIRTY = 1,
 605         NTFS_DIRTY_ERROR = 2,
 606 };
 607 int ntfs_set_state(struct ntfs_sb_info *sbi, enum NTFS_DIRTY_FLAGS dirty);
 608 int ntfs_sb_read(struct super_block *sb, u64 lbo, size_t bytes, void *buffer);
 609 int ntfs_sb_write(struct super_block *sb, u64 lbo, size_t bytes,
 610                   const void *buffer, int wait);
 611 int ntfs_sb_write_run(struct ntfs_sb_info *sbi, const struct runs_tree *run,
 612                       u64 vbo, const void *buf, size_t bytes, int sync);
 613 struct buffer_head *ntfs_bread_run(struct ntfs_sb_info *sbi,
 614                                    const struct runs_tree *run, u64 vbo);
 615 int ntfs_read_run_nb(struct ntfs_sb_info *sbi, const struct runs_tree *run,
 616                      u64 vbo, void *buf, u32 bytes, struct ntfs_buffers *nb);
 617 int ntfs_read_bh(struct ntfs_sb_info *sbi, const struct runs_tree *run, u64 vbo,
 618                  struct NTFS_RECORD_HEADER *rhdr, u32 bytes,
 619                  struct ntfs_buffers *nb);
 620 int ntfs_get_bh(struct ntfs_sb_info *sbi, const struct runs_tree *run, u64 vbo,
 621                 u32 bytes, struct ntfs_buffers *nb);
 622 int ntfs_write_bh(struct ntfs_sb_info *sbi, struct NTFS_RECORD_HEADER *rhdr,
 623                   struct ntfs_buffers *nb, int sync);
 624 int ntfs_bio_pages(struct ntfs_sb_info *sbi, const struct runs_tree *run,
 625                    struct page **pages, u32 nr_pages, u64 vbo, u32 bytes,
 626                    enum req_op op);
 627 int ntfs_bio_fill_1(struct ntfs_sb_info *sbi, const struct runs_tree *run);
 628 int ntfs_vbo_to_lbo(struct ntfs_sb_info *sbi, const struct runs_tree *run,
 629                     u64 vbo, u64 *lbo, u64 *bytes);
 630 struct ntfs_inode *ntfs_new_inode(struct ntfs_sb_info *sbi, CLST nRec,
 631                                   bool dir);
 632 extern const u8 s_default_security[0x50];
 633 bool is_sd_valid(const struct SECURITY_DESCRIPTOR_RELATIVE *sd, u32 len);
 634 int ntfs_security_init(struct ntfs_sb_info *sbi);
 635 int ntfs_get_security_by_id(struct ntfs_sb_info *sbi, __le32 security_id,
 636                             struct SECURITY_DESCRIPTOR_RELATIVE **sd,
 637                             size_t *size);
 638 int ntfs_insert_security(struct ntfs_sb_info *sbi,
 639                          const struct SECURITY_DESCRIPTOR_RELATIVE *sd,
 640                          u32 size, __le32 *security_id, bool *inserted);
 641 int ntfs_reparse_init(struct ntfs_sb_info *sbi);
 642 int ntfs_objid_init(struct ntfs_sb_info *sbi);
 643 int ntfs_objid_remove(struct ntfs_sb_info *sbi, struct GUID *guid);
 644 int ntfs_insert_reparse(struct ntfs_sb_info *sbi, __le32 rtag,
 645                         const struct MFT_REF *ref);
 646 int ntfs_remove_reparse(struct ntfs_sb_info *sbi, __le32 rtag,
 647                         const struct MFT_REF *ref);
 648 void mark_as_free_ex(struct ntfs_sb_info *sbi, CLST lcn, CLST len, bool trim);
 649 int run_deallocate(struct ntfs_sb_info *sbi, struct runs_tree *run, bool trim);
 650
 651 /* Globals from index.c */
 652 int indx_used_bit(struct ntfs_index *indx, struct ntfs_inode *ni, size_t *bit);
 653 void fnd_clear(struct ntfs_fnd *fnd);
 654 static inline struct ntfs_fnd *fnd_get(void)
 655 {
 656         return kzalloc(sizeof(struct ntfs_fnd), GFP_NOFS);
 657 }
 658 static inline void fnd_put(struct ntfs_fnd *fnd)
 659 {
 660         if (fnd) {
 661                 fnd_clear(fnd);
 662                 kfree(fnd);
 663         }
 664 }
 665 void indx_clear(struct ntfs_index *idx);
 666 int indx_init(struct ntfs_index *indx, struct ntfs_sb_info *sbi,
 667               const struct ATTRIB *attr, enum index_mutex_classed type);
 668 struct INDEX_ROOT *indx_get_root(struct ntfs_index *indx, struct ntfs_inode *ni,
 669                                  struct ATTRIB **attr, struct mft_inode **mi);
 670 int indx_read(struct ntfs_index *idx, struct ntfs_inode *ni, CLST vbn,
 671               struct indx_node **node);
 672 int indx_find(struct ntfs_index *indx, struct ntfs_inode *dir,
 673               const struct INDEX_ROOT *root, const void *Key, size_t KeyLen,
 674               const void *param, int *diff, struct NTFS_DE **entry,
 675               struct ntfs_fnd *fnd);
 676 int indx_find_sort(struct ntfs_index *indx, struct ntfs_inode *ni,
 677                    const struct INDEX_ROOT *root, struct NTFS_DE **entry,
 678                    struct ntfs_fnd *fnd);
 679 int indx_find_raw(struct ntfs_index *indx, struct ntfs_inode *ni,
 680                   const struct INDEX_ROOT *root, struct NTFS_DE **entry,
 681                   size_t *off, struct ntfs_fnd *fnd);
 682 int indx_insert_entry(struct ntfs_index *indx, struct ntfs_inode *ni,
 683                       const struct NTFS_DE *new_de, const void *param,
 684                       struct ntfs_fnd *fnd, bool undo);
 685 int indx_delete_entry(struct ntfs_index *indx, struct ntfs_inode *ni,
 686                       const void *key, u32 key_len, const void *param);
 687 int indx_update_dup(struct ntfs_inode *ni, struct ntfs_sb_info *sbi,
 688                     const struct ATTR_FILE_NAME *fname,
 689                     const struct NTFS_DUP_INFO *dup, int sync);
 690
 691 /* Globals from inode.c */
 692 struct inode *ntfs_iget5(struct super_block *sb, const struct MFT_REF *ref,
 693                          const struct cpu_str *name);
 694 int ntfs_set_size(struct inode *inode, u64 new_size);
 695 int reset_log_file(struct inode *inode);
 696 int ntfs_get_block(struct inode *inode, sector_t vbn,
 697                    struct buffer_head *bh_result, int create);
 698 int ntfs_write_begin(struct file *file, struct address_space *mapping,
 699                      loff_t pos, u32 len, struct page **pagep, void **fsdata);
 700 int ntfs_write_end(struct file *file, struct address_space *mapping,
 701                    loff_t pos, u32 len, u32 copied, struct page *page,
 702                    void *fsdata);
 703 int ntfs3_write_inode(struct inode *inode, struct writeback_control *wbc);
 704 int ntfs_sync_inode(struct inode *inode);
 705 int ntfs_flush_inodes(struct super_block *sb, struct inode *i1,
 706                       struct inode *i2);
 707 int inode_write_data(struct inode *inode, const void *data, size_t bytes);
 708 struct inode *ntfs_create_inode(struct user_namespace *mnt_userns,
 709                                 struct inode *dir, struct dentry *dentry,
 710                                 const struct cpu_str *uni, umode_t mode,
 711                                 dev_t dev, const char *symname, u32 size,
 712                                 struct ntfs_fnd *fnd);
 713 int ntfs_link_inode(struct inode *inode, struct dentry *dentry);
 714 int ntfs_unlink_inode(struct inode *dir, const struct dentry *dentry);
 715 void ntfs_evict_inode(struct inode *inode);
 716 extern const struct inode_operations ntfs_link_inode_operations;
 717 extern const struct address_space_operations ntfs_aops;
 718 extern const struct address_space_operations ntfs_aops_cmpr;
 719
 720 /* Globals from name_i.c */
 721 int fill_name_de(struct ntfs_sb_info *sbi, void *buf, const struct qstr *name,
 722                  const struct cpu_str *uni);
 723 struct dentry *ntfs3_get_parent(struct dentry *child);
 724
 725 extern const struct inode_operations ntfs_dir_inode_operations;
 726 extern const struct inode_operations ntfs_special_inode_operations;
 727
 728 /* Globals from record.c */
 729 int mi_get(struct ntfs_sb_info *sbi, CLST rno, struct mft_inode **mi);
 730 void mi_put(struct mft_inode *mi);
 731 int mi_init(struct mft_inode *mi, struct ntfs_sb_info *sbi, CLST rno);
 732 int mi_read(struct mft_inode *mi, bool is_mft);
 733 struct ATTRIB *mi_enum_attr(struct mft_inode *mi, struct ATTRIB *attr);
 734 // TODO: id?
 735 struct ATTRIB *mi_find_attr(struct mft_inode *mi, struct ATTRIB *attr,
 736                             enum ATTR_TYPE type, const __le16 *name,
 737                             size_t name_len, const __le16 *id);
 738 static inline struct ATTRIB *rec_find_attr_le(struct mft_inode *rec,
 739                                               struct ATTR_LIST_ENTRY *le)
 740 {
 741         return mi_find_attr(rec, NULL, le->type, le_name(le), le->name_len,
 742                             &le->id);
 743 }
 744 int mi_write(struct mft_inode *mi, int wait);
 745 int mi_format_new(struct mft_inode *mi, struct ntfs_sb_info *sbi, CLST rno,
 746                   __le16 flags, bool is_mft);
 747 struct ATTRIB *mi_insert_attr(struct mft_inode *mi, enum ATTR_TYPE type,
 748                               const __le16 *name, u8 name_len, u32 asize,
 749                               u16 name_off);
 750
 751 bool mi_remove_attr(struct ntfs_inode *ni, struct mft_inode *mi,
 752                     struct ATTRIB *attr);
 753 bool mi_resize_attr(struct mft_inode *mi, struct ATTRIB *attr, int bytes);
 754 int mi_pack_runs(struct mft_inode *mi, struct ATTRIB *attr,
 755                  struct runs_tree *run, CLST len);
 756 static inline bool mi_is_ref(const struct mft_inode *mi,
 757                              const struct MFT_REF *ref)
 758 {
 759         if (le32_to_cpu(ref->low) != mi->rno)
 760                 return false;
 761         if (ref->seq != mi->mrec->seq)
 762                 return false;
 763
 764 #ifdef CONFIG_NTFS3_64BIT_CLUSTER
 765         return le16_to_cpu(ref->high) == (mi->rno >> 32);
 766 #else
 767         return !ref->high;
 768 #endif
 769 }
 770
 771 static inline void mi_get_ref(const struct mft_inode *mi, struct MFT_REF *ref)
 772 {
 773         ref->low = cpu_to_le32(mi->rno);
 774 #ifdef CONFIG_NTFS3_64BIT_CLUSTER
 775         ref->high = cpu_to_le16(mi->rno >> 32);
 776 #else
 777         ref->high = 0;
 778 #endif
 779         ref->seq = mi->mrec->seq;
 780 }
 781
 782 /* Globals from run.c */
 783 bool run_lookup_entry(const struct runs_tree *run, CLST vcn, CLST *lcn,
 784                       CLST *len, size_t *index);
 785 void run_truncate(struct runs_tree *run, CLST vcn);
 786 void run_truncate_head(struct runs_tree *run, CLST vcn);
 787 void run_truncate_around(struct runs_tree *run, CLST vcn);
 788 bool run_add_entry(struct runs_tree *run, CLST vcn, CLST lcn, CLST len,
 789                    bool is_mft);
 790 bool run_collapse_range(struct runs_tree *run, CLST vcn, CLST len);
 791 bool run_insert_range(struct runs_tree *run, CLST vcn, CLST len);
 792 bool run_get_entry(const struct runs_tree *run, size_t index, CLST *vcn,
 793                    CLST *lcn, CLST *len);
 794 bool run_is_mapped_full(const struct runs_tree *run, CLST svcn, CLST evcn);
 795
 796 int run_pack(const struct runs_tree *run, CLST svcn, CLST len, u8 *run_buf,
 797              u32 run_buf_size, CLST *packed_vcns);
 798 int run_unpack(struct runs_tree *run, struct ntfs_sb_info *sbi, CLST ino,
 799                CLST svcn, CLST evcn, CLST vcn, const u8 *run_buf,
 800                int run_buf_size);
 801
 802 #ifdef NTFS3_CHECK_FREE_CLST
 803 int run_unpack_ex(struct runs_tree *run, struct ntfs_sb_info *sbi, CLST ino,
 804                   CLST svcn, CLST evcn, CLST vcn, const u8 *run_buf,
 805                   int run_buf_size);
 806 #else
 807 #define run_unpack_ex run_unpack
 808 #endif
 809 int run_get_highest_vcn(CLST vcn, const u8 *run_buf, u64 *highest_vcn);
 810 int run_clone(const struct runs_tree *run, struct runs_tree *new_run);
 811
 812 /* Globals from super.c */
 813 void *ntfs_set_shared(void *ptr, u32 bytes);
 814 void *ntfs_put_shared(void *ptr);
 815 void ntfs_unmap_meta(struct super_block *sb, CLST lcn, CLST len);
 816 int ntfs_discard(struct ntfs_sb_info *sbi, CLST Lcn, CLST Len);
 817
 818 /* Globals from bitmap.c*/
 819 int __init ntfs3_init_bitmap(void);
 820 void ntfs3_exit_bitmap(void);
 821 void wnd_close(struct wnd_bitmap *wnd);
 822 static inline size_t wnd_zeroes(const struct wnd_bitmap *wnd)
 823 {
 824         return wnd->total_zeroes;
 825 }
 826 int wnd_init(struct wnd_bitmap *wnd, struct super_block *sb, size_t nbits);
 827 int wnd_set_free(struct wnd_bitmap *wnd, size_t bit, size_t bits);
 828 int wnd_set_used(struct wnd_bitmap *wnd, size_t bit, size_t bits);
 829 bool wnd_is_free(struct wnd_bitmap *wnd, size_t bit, size_t bits);
 830 bool wnd_is_used(struct wnd_bitmap *wnd, size_t bit, size_t bits);
 831
 832 /* Possible values for 'flags' 'wnd_find'. */
 833 #define BITMAP_FIND_MARK_AS_USED 0x01
 834 #define BITMAP_FIND_FULL 0x02
 835 size_t wnd_find(struct wnd_bitmap *wnd, size_t to_alloc, size_t hint,
 836                 size_t flags, size_t *allocated);
 837 int wnd_extend(struct wnd_bitmap *wnd, size_t new_bits);
 838 void wnd_zone_set(struct wnd_bitmap *wnd, size_t Lcn, size_t Len);
 839 int ntfs_trim_fs(struct ntfs_sb_info *sbi, struct fstrim_range *range);
 840
 841 /* Globals from upcase.c */
 842 int ntfs_cmp_names(const __le16 *s1, size_t l1, const __le16 *s2, size_t l2,
 843                    const u16 *upcase, bool bothcase);
 844 int ntfs_cmp_names_cpu(const struct cpu_str *uni1, const struct le_str *uni2,
 845                        const u16 *upcase, bool bothcase);
 846
 847 /* globals from xattr.c */
 848 #ifdef CONFIG_NTFS3_FS_POSIX_ACL
 849 struct posix_acl *ntfs_get_acl(struct inode *inode, int type, bool rcu);
 850 int ntfs_set_acl(struct user_namespace *mnt_userns, struct inode *inode,
 851                  struct posix_acl *acl, int type);
 852 int ntfs_init_acl(struct user_namespace *mnt_userns, struct inode *inode,
 853                   struct inode *dir);
 854 #else
 855 #define ntfs_get_acl NULL
 856 #define ntfs_set_acl NULL
 857 #endif
 858
 859 int ntfs_acl_chmod(struct user_namespace *mnt_userns, struct inode *inode);
 860 int ntfs_permission(struct user_namespace *mnt_userns, struct inode *inode,
 861                     int mask);
 862 ssize_t ntfs_listxattr(struct dentry *dentry, char *buffer, size_t size);
 863 extern const struct xattr_handler *ntfs_xattr_handlers[];
 864
 865 int ntfs_save_wsl_perm(struct inode *inode);
 866 void ntfs_get_wsl_perm(struct inode *inode);
 867
 868 /* globals from lznt.c */
 869 struct lznt *get_lznt_ctx(int level);
 870 size_t compress_lznt(const void *uncompressed, size_t uncompressed_size,
 871                      void *compressed, size_t compressed_size,
 872                      struct lznt *ctx);
 873 ssize_t decompress_lznt(const void *compressed, size_t compressed_size,
 874                         void *uncompressed, size_t uncompressed_size);
 875
 876 static inline bool is_ntfs3(struct ntfs_sb_info *sbi)
 877 {
 878         return sbi->volume.major_ver >= 3;
 879 }
 880
 881 /* (sb->s_flags & SB_ACTIVE) */
 882 static inline bool is_mounted(struct ntfs_sb_info *sbi)
 883 {
 884         return !!sbi->sb->s_root;
 885 }
 886
 887 static inline bool ntfs_is_meta_file(struct ntfs_sb_info *sbi, CLST rno)
 888 {
 889         return rno < MFT_REC_FREE || rno == sbi->objid_no ||
 890                rno == sbi->quota_no || rno == sbi->reparse_no ||
 891                rno == sbi->usn_jrnl_no;
 892 }
 893
 894 static inline void ntfs_unmap_page(struct page *page)
 895 {
 896         kunmap(page);
 897         put_page(page);
 898 }
 899
 900 static inline struct page *ntfs_map_page(struct address_space *mapping,
 901                                          unsigned long index)
 902 {
 903         struct page *page = read_mapping_page(mapping, index, NULL);
 904
 905         if (!IS_ERR(page))
 906                 kmap(page);
 907         return page;
 908 }
 909
 910 static inline size_t wnd_zone_bit(const struct wnd_bitmap *wnd)
 911 {
 912         return wnd->zone_bit;
 913 }
 914
 915 static inline size_t wnd_zone_len(const struct wnd_bitmap *wnd)
 916 {
 917         return wnd->zone_end - wnd->zone_bit;
 918 }
 919
 920 static inline void run_init(struct runs_tree *run)
 921 {
 922         run->runs = NULL;
 923         run->count = 0;
 924         run->allocated = 0;
 925 }
 926
 927 static inline struct runs_tree *run_alloc(void)
 928 {
 929         return kzalloc(sizeof(struct runs_tree), GFP_NOFS);
 930 }
 931
 932 static inline void run_close(struct runs_tree *run)
 933 {
 934         kvfree(run->runs);
 935         memset(run, 0, sizeof(*run));
 936 }
 937
 938 static inline void run_free(struct runs_tree *run)
 939 {
 940         if (run) {
 941                 kvfree(run->runs);
 942                 kfree(run);
 943         }
 944 }
 945
 946 static inline bool run_is_empty(struct runs_tree *run)
 947 {
 948         return !run->count;
 949 }
 950
 951 /* NTFS uses quad aligned bitmaps. */
 952 static inline size_t bitmap_size(size_t bits)
 953 {
 954         return ALIGN((bits + 7) >> 3, 8);
 955 }
 956
 957 #define _100ns2seconds 10000000
 958 #define SecondsToStartOf1970 0x00000002B6109100
 959
 960 #define NTFS_TIME_GRAN 100
 961
 962 /*
 963  * kernel2nt - Converts in-memory kernel timestamp into nt time.
 964  */
 965 static inline __le64 kernel2nt(const struct timespec64 *ts)
 966 {
 967         // 10^7 units of 100 nanoseconds one second
 968         return cpu_to_le64(_100ns2seconds *
 969                                    (ts->tv_sec + SecondsToStartOf1970) +
 970                            ts->tv_nsec / NTFS_TIME_GRAN);
 971 }
 972
 973 /*
 974  * nt2kernel - Converts on-disk nt time into kernel timestamp.
 975  */
 976 static inline void nt2kernel(const __le64 tm, struct timespec64 *ts)
 977 {
 978         u64 t = le64_to_cpu(tm) - _100ns2seconds * SecondsToStartOf1970;
 979
 980         // WARNING: do_div changes its first argument(!)
 981         ts->tv_nsec = do_div(t, _100ns2seconds) * 100;
 982         ts->tv_sec = t;
 983 }
 984
 985 static inline struct ntfs_sb_info *ntfs_sb(struct super_block *sb)
 986 {
 987         return sb->s_fs_info;
 988 }
 989
 990 /*
 991  * ntfs_up_cluster - Align up on cluster boundary.
 992  */
 993 static inline u64 ntfs_up_cluster(const struct ntfs_sb_info *sbi, u64 size)
 994 {
 995         return (size + sbi->cluster_mask) & sbi->cluster_mask_inv;
 996 }
 997
 998 /*
 999  * ntfs_up_block - Align up on cluster boundary.
1000  */
1001 static inline u64 ntfs_up_block(const struct super_block *sb, u64 size)
1002 {
1003         return (size + sb->s_blocksize - 1) & ~(u64)(sb->s_blocksize - 1);
1004 }
1005
1006 static inline CLST bytes_to_cluster(const struct ntfs_sb_info *sbi, u64 size)
1007 {
1008         return (size + sbi->cluster_mask) >> sbi->cluster_bits;
1009 }
1010
1011 static inline u64 bytes_to_block(const struct super_block *sb, u64 size)
1012 {
1013         return (size + sb->s_blocksize - 1) >> sb->s_blocksize_bits;
1014 }
1015
1016 static inline struct ntfs_inode *ntfs_i(struct inode *inode)
1017 {
1018         return container_of(inode, struct ntfs_inode, vfs_inode);
1019 }
1020
1021 static inline bool is_compressed(const struct ntfs_inode *ni)
1022 {
1023         return (ni->std_fa & FILE_ATTRIBUTE_COMPRESSED) ||
1024                (ni->ni_flags & NI_FLAG_COMPRESSED_MASK);
1025 }
1026
1027 static inline int ni_ext_compress_bits(const struct ntfs_inode *ni)
1028 {
1029         return 0xb + (ni->ni_flags & NI_FLAG_COMPRESSED_MASK);
1030 }
1031
1032 /* Bits - 0xc, 0xd, 0xe, 0xf, 0x10 */
1033 static inline void ni_set_ext_compress_bits(struct ntfs_inode *ni, u8 bits)
1034 {
1035         ni->ni_flags |= (bits - 0xb) & NI_FLAG_COMPRESSED_MASK;
1036 }
1037
1038 static inline bool is_dedup(const struct ntfs_inode *ni)
1039 {
1040         return ni->ni_flags & NI_FLAG_DEDUPLICATED;
1041 }
1042
1043 static inline bool is_encrypted(const struct ntfs_inode *ni)
1044 {
1045         return ni->std_fa & FILE_ATTRIBUTE_ENCRYPTED;
1046 }
1047
1048 static inline bool is_sparsed(const struct ntfs_inode *ni)
1049 {
1050         return ni->std_fa & FILE_ATTRIBUTE_SPARSE_FILE;
1051 }
1052
1053 static inline int is_resident(struct ntfs_inode *ni)
1054 {
1055         return ni->ni_flags & NI_FLAG_RESIDENT;
1056 }
1057
1058 static inline void le16_sub_cpu(__le16 *var, u16 val)
1059 {
1060         *var = cpu_to_le16(le16_to_cpu(*var) - val);
1061 }
1062
1063 static inline void le32_sub_cpu(__le32 *var, u32 val)
1064 {
1065         *var = cpu_to_le32(le32_to_cpu(*var) - val);
1066 }
1067
1068 static inline void nb_put(struct ntfs_buffers *nb)
1069 {
1070         u32 i, nbufs = nb->nbufs;
1071
1072         if (!nbufs)
1073                 return;
1074
1075         for (i = 0; i < nbufs; i++)
1076                 put_bh(nb->bh[i]);
1077         nb->nbufs = 0;
1078 }
1079
1080 static inline void put_indx_node(struct indx_node *in)
1081 {
1082         if (!in)
1083                 return;
1084
1085         kfree(in->index);
1086         nb_put(&in->nb);
1087         kfree(in);
1088 }
1089
1090 static inline void mi_clear(struct mft_inode *mi)
1091 {
1092         nb_put(&mi->nb);
1093         kfree(mi->mrec);
1094         mi->mrec = NULL;
1095 }
1096
1097 static inline void ni_lock(struct ntfs_inode *ni)
1098 {
1099         mutex_lock_nested(&ni->ni_lock, NTFS_INODE_MUTEX_NORMAL);
1100 }
1101
1102 static inline void ni_lock_dir(struct ntfs_inode *ni)
1103 {
1104         mutex_lock_nested(&ni->ni_lock, NTFS_INODE_MUTEX_PARENT);
1105 }
1106
1107 static inline void ni_unlock(struct ntfs_inode *ni)
1108 {
1109         mutex_unlock(&ni->ni_lock);
1110 }
1111
1112 static inline int ni_trylock(struct ntfs_inode *ni)
1113 {
1114         return mutex_trylock(&ni->ni_lock);
1115 }
1116
1117 static inline int attr_load_runs_attr(struct ntfs_inode *ni,
1118                                       struct ATTRIB *attr,
1119                                       struct runs_tree *run, CLST vcn)
1120 {
1121         return attr_load_runs_vcn(ni, attr->type, attr_name(attr),
1122                                   attr->name_len, run, vcn);
1123 }
1124
1125 static inline void le64_sub_cpu(__le64 *var, u64 val)
1126 {
1127         *var = cpu_to_le64(le64_to_cpu(*var) - val);
1128 }
1129
1130 #endif /* _LINUX_NTFS3_NTFS_FS_H */