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