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 prealloc : 1; /* Preallocate space when file is growing. */
 104         unsigned nocase : 1; /* case insensitive. */
 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         ALLOCATE_ZERO = 2, // Zeroout new allocated clusters
 130 };
 131
 132 enum bitmap_mutex_classes {
 133         BITMAP_MUTEX_CLUSTERS = 0,
 134         BITMAP_MUTEX_MFT = 1,
 135 };
 136
 137 struct wnd_bitmap {
 138         struct super_block *sb;
 139         struct rw_semaphore rw_lock;
 140
 141         struct runs_tree run;
 142         size_t nbits;
 143
 144         size_t total_zeroes; // Total number of free bits.
 145         u16 *free_bits; // Free bits in each window.
 146         size_t nwnd;
 147         u32 bits_last; // Bits in last window.
 148
 149         struct rb_root start_tree; // Extents, sorted by 'start'.
 150         struct rb_root count_tree; // Extents, sorted by 'count + start'.
 151         size_t count; // Extents count.
 152
 153         /*
 154          * -1 Tree is activated but not updated (too many fragments).
 155          * 0 - Tree is not activated.
 156          * 1 - Tree is activated and updated.
 157          */
 158         int uptodated;
 159         size_t extent_min; // Minimal extent used while building.
 160         size_t extent_max; // Upper estimate of biggest free block.
 161
 162         /* Zone [bit, end) */
 163         size_t zone_bit;
 164         size_t zone_end;
 165
 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 /* Step to increase the MFT. */
 201 #define NTFS_MFT_INCREASE_STEP 1024
 202
 203 /* Ntfs file system in-core superblock data. */
 204 struct ntfs_sb_info {
 205         struct super_block *sb;
 206
 207         u32 discard_granularity;
 208         u64 discard_granularity_mask_inv; // ~(discard_granularity_mask_inv-1)
 209
 210         u32 cluster_size; // bytes per cluster
 211         u32 cluster_mask; // == cluster_size - 1
 212         u64 cluster_mask_inv; // ~(cluster_size - 1)
 213         u32 block_mask; // sb->s_blocksize - 1
 214         u32 blocks_per_cluster; // cluster_size / sb->s_blocksize
 215
 216         u32 record_size;
 217         u32 index_size;
 218
 219         u8 cluster_bits;
 220         u8 record_bits;
 221
 222         u64 maxbytes; // Maximum size for normal files.
 223         u64 maxbytes_sparse; // Maximum size for sparse file.
 224
 225         u32 flags; // See NTFS_FLAGS_XXX.
 226
 227         CLST zone_max; // Maximum MFT zone length in clusters
 228         CLST bad_clusters; // The count of marked bad clusters.
 229
 230         u16 max_bytes_per_attr; // Maximum attribute size in record.
 231         u16 attr_size_tr; // Attribute size threshold (320 bytes).
 232
 233         /* Records in $Extend. */
 234         CLST objid_no;
 235         CLST quota_no;
 236         CLST reparse_no;
 237         CLST usn_jrnl_no;
 238
 239         struct ATTR_DEF_ENTRY *def_table; // Attribute definition table.
 240         u32 def_entries;
 241         u32 ea_max_size;
 242
 243         struct MFT_REC *new_rec;
 244
 245         u16 *upcase;
 246
 247         struct {
 248                 u64 lbo, lbo2;
 249                 struct ntfs_inode *ni;
 250                 struct wnd_bitmap bitmap; // $MFT::Bitmap
 251                 /*
 252                  * MFT records [11-24) used to expand MFT itself.
 253                  * They always marked as used in $MFT::Bitmap
 254                  * 'reserved_bitmap' contains real bitmap of these records.
 255                  */
 256                 ulong reserved_bitmap; // Bitmap of used records [11 - 24)
 257                 size_t next_free; // The next record to allocate from
 258                 size_t used; // MFT valid size in records.
 259                 u32 recs_mirr; // Number of records in MFTMirr
 260                 u8 next_reserved;
 261                 u8 reserved_bitmap_inited;
 262         } mft;
 263
 264         struct {
 265                 struct wnd_bitmap bitmap; // $Bitmap::Data
 266                 CLST next_free_lcn;
 267         } used;
 268
 269         struct {
 270                 u64 size; // In bytes.
 271                 u64 blocks; // In blocks.
 272                 u64 ser_num;
 273                 struct ntfs_inode *ni;
 274                 __le16 flags; // Cached current VOLUME_INFO::flags, VOLUME_FLAG_DIRTY.
 275                 u8 major_ver;
 276                 u8 minor_ver;
 277                 char label[65];
 278                 bool real_dirty; // Real fs state.
 279         } volume;
 280
 281         struct {
 282                 struct ntfs_index index_sii;
 283                 struct ntfs_index index_sdh;
 284                 struct ntfs_inode *ni;
 285                 u32 next_id;
 286                 u64 next_off;
 287
 288                 __le32 def_security_id;
 289         } security;
 290
 291         struct {
 292                 struct ntfs_index index_r;
 293                 struct ntfs_inode *ni;
 294                 u64 max_size; // 16K
 295         } reparse;
 296
 297         struct {
 298                 struct ntfs_index index_o;
 299                 struct ntfs_inode *ni;
 300         } objid;
 301
 302         struct {
 303                 struct mutex mtx_lznt;
 304                 struct lznt *lznt;
 305 #ifdef CONFIG_NTFS3_LZX_XPRESS
 306                 struct mutex mtx_xpress;
 307                 struct xpress_decompressor *xpress;
 308                 struct mutex mtx_lzx;
 309                 struct lzx_decompressor *lzx;
 310 #endif
 311         } compress;
 312
 313         struct ntfs_mount_options *options;
 314         struct ratelimit_state msg_ratelimit;
 315 };
 316
 317 /* One MFT record(usually 1024 bytes), consists of attributes. */
 318 struct mft_inode {
 319         struct rb_node node;
 320         struct ntfs_sb_info *sbi;
 321
 322         struct MFT_REC *mrec;
 323         struct ntfs_buffers nb;
 324
 325         CLST rno;
 326         bool dirty;
 327 };
 328
 329 /* Nested class for ntfs_inode::ni_lock. */
 330 enum ntfs_inode_mutex_lock_class {
 331         NTFS_INODE_MUTEX_DIRTY,
 332         NTFS_INODE_MUTEX_SECURITY,
 333         NTFS_INODE_MUTEX_OBJID,
 334         NTFS_INODE_MUTEX_REPARSE,
 335         NTFS_INODE_MUTEX_NORMAL,
 336         NTFS_INODE_MUTEX_PARENT,
 337         NTFS_INODE_MUTEX_PARENT2,
 338 };
 339
 340 /*
 341  * struct ntfs_inode
 342  *
 343  * Ntfs inode - extends linux inode. consists of one or more MFT inodes.
 344  */
 345 struct ntfs_inode {
 346         struct mft_inode mi; // base record
 347
 348         /*
 349          * Valid size: [0 - i_valid) - these range in file contains valid data.
 350          * Range [i_valid - inode->i_size) - contains 0.
 351          * Usually i_valid <= inode->i_size.
 352          */
 353         u64 i_valid;
 354         struct timespec64 i_crtime;
 355
 356         struct mutex ni_lock;
 357
 358         /* File attributes from std. */
 359         enum FILE_ATTRIBUTE std_fa;
 360         __le32 std_security_id;
 361
 362         /*
 363          * Tree of mft_inode.
 364          * Not empty when primary MFT record (usually 1024 bytes) can't save all attributes
 365          * e.g. file becomes too fragmented or contains a lot of names.
 366          */
 367         struct rb_root mi_tree;
 368
 369         /*
 370          * This member is used in ntfs_readdir to ensure that all subrecords are loaded
 371          */
 372         u8 mi_loaded;
 373
 374         union {
 375                 struct ntfs_index dir;
 376                 struct {
 377                         struct rw_semaphore run_lock;
 378                         struct runs_tree run;
 379 #ifdef CONFIG_NTFS3_LZX_XPRESS
 380                         struct page *offs_page;
 381 #endif
 382                 } file;
 383         };
 384
 385         struct {
 386                 struct runs_tree run;
 387                 struct ATTR_LIST_ENTRY *le; // 1K aligned memory.
 388                 size_t size;
 389                 bool dirty;
 390         } attr_list;
 391
 392         size_t ni_flags; // NI_FLAG_XXX
 393
 394         struct inode vfs_inode;
 395 };
 396
 397 struct indx_node {
 398         struct ntfs_buffers nb;
 399         struct INDEX_BUFFER *index;
 400 };
 401
 402 struct ntfs_fnd {
 403         int level;
 404         struct indx_node *nodes[20];
 405         struct NTFS_DE *de[20];
 406         struct NTFS_DE *root_de;
 407 };
 408
 409 enum REPARSE_SIGN {
 410         REPARSE_NONE = 0,
 411         REPARSE_COMPRESSED = 1,
 412         REPARSE_DEDUPLICATED = 2,
 413         REPARSE_LINK = 3
 414 };
 415
 416 /* Functions from attrib.c */
 417 int attr_allocate_clusters(struct ntfs_sb_info *sbi, struct runs_tree *run,
 418                            CLST vcn, CLST lcn, CLST len, CLST *pre_alloc,
 419                            enum ALLOCATE_OPT opt, CLST *alen, const size_t fr,
 420                            CLST *new_lcn, CLST *new_len);
 421 int attr_make_nonresident(struct ntfs_inode *ni, struct ATTRIB *attr,
 422                           struct ATTR_LIST_ENTRY *le, struct mft_inode *mi,
 423                           u64 new_size, struct runs_tree *run,
 424                           struct ATTRIB **ins_attr, struct page *page);
 425 int attr_set_size(struct ntfs_inode *ni, enum ATTR_TYPE type,
 426                   const __le16 *name, u8 name_len, struct runs_tree *run,
 427                   u64 new_size, const u64 *new_valid, bool keep_prealloc,
 428                   struct ATTRIB **ret);
 429 int attr_data_get_block(struct ntfs_inode *ni, CLST vcn, CLST clen, CLST *lcn,
 430                         CLST *len, bool *new, bool zero);
 431 int attr_data_read_resident(struct ntfs_inode *ni, struct page *page);
 432 int attr_data_write_resident(struct ntfs_inode *ni, struct page *page);
 433 int attr_load_runs_vcn(struct ntfs_inode *ni, enum ATTR_TYPE type,
 434                        const __le16 *name, u8 name_len, struct runs_tree *run,
 435                        CLST vcn);
 436 int attr_load_runs_range(struct ntfs_inode *ni, enum ATTR_TYPE type,
 437                          const __le16 *name, u8 name_len, struct runs_tree *run,
 438                          u64 from, u64 to);
 439 int attr_wof_frame_info(struct ntfs_inode *ni, struct ATTRIB *attr,
 440                         struct runs_tree *run, u64 frame, u64 frames,
 441                         u8 frame_bits, u32 *ondisk_size, u64 *vbo_data);
 442 int attr_is_frame_compressed(struct ntfs_inode *ni, struct ATTRIB *attr,
 443                              CLST frame, CLST *clst_data);
 444 int attr_allocate_frame(struct ntfs_inode *ni, CLST frame, size_t compr_size,
 445                         u64 new_valid);
 446 int attr_collapse_range(struct ntfs_inode *ni, u64 vbo, u64 bytes);
 447 int attr_insert_range(struct ntfs_inode *ni, u64 vbo, u64 bytes);
 448 int attr_punch_hole(struct ntfs_inode *ni, u64 vbo, u64 bytes, u32 *frame_size);
 449
 450 /* Functions from attrlist.c */
 451 void al_destroy(struct ntfs_inode *ni);
 452 bool al_verify(struct ntfs_inode *ni);
 453 int ntfs_load_attr_list(struct ntfs_inode *ni, struct ATTRIB *attr);
 454 struct ATTR_LIST_ENTRY *al_enumerate(struct ntfs_inode *ni,
 455                                      struct ATTR_LIST_ENTRY *le);
 456 struct ATTR_LIST_ENTRY *al_find_le(struct ntfs_inode *ni,
 457                                    struct ATTR_LIST_ENTRY *le,
 458                                    const struct ATTRIB *attr);
 459 struct ATTR_LIST_ENTRY *al_find_ex(struct ntfs_inode *ni,
 460                                    struct ATTR_LIST_ENTRY *le,
 461                                    enum ATTR_TYPE type, const __le16 *name,
 462                                    u8 name_len, const CLST *vcn);
 463 int al_add_le(struct ntfs_inode *ni, enum ATTR_TYPE type, const __le16 *name,
 464               u8 name_len, CLST svcn, __le16 id, const struct MFT_REF *ref,
 465               struct ATTR_LIST_ENTRY **new_le);
 466 bool al_remove_le(struct ntfs_inode *ni, struct ATTR_LIST_ENTRY *le);
 467 bool al_delete_le(struct ntfs_inode *ni, enum ATTR_TYPE type, CLST vcn,
 468                   const __le16 *name, size_t name_len,
 469                   const struct MFT_REF *ref);
 470 int al_update(struct ntfs_inode *ni, int sync);
 471 static inline size_t al_aligned(size_t size)
 472 {
 473         return (size + 1023) & ~(size_t)1023;
 474 }
 475
 476 /* Globals from bitfunc.c */
 477 bool are_bits_clear(const void *map, size_t bit, size_t nbits);
 478 bool are_bits_set(const void *map, size_t bit, size_t nbits);
 479 size_t get_set_bits_ex(const void *map, size_t bit, size_t nbits);
 480
 481 /* Globals from dir.c */
 482 int ntfs_utf16_to_nls(struct ntfs_sb_info *sbi, const __le16 *name, u32 len,
 483                       u8 *buf, int buf_len);
 484 int ntfs_nls_to_utf16(struct ntfs_sb_info *sbi, const u8 *name, u32 name_len,
 485                       struct cpu_str *uni, u32 max_ulen,
 486                       enum utf16_endian endian);
 487 struct inode *dir_search_u(struct inode *dir, const struct cpu_str *uni,
 488                            struct ntfs_fnd *fnd);
 489 bool dir_is_empty(struct inode *dir);
 490 extern const struct file_operations ntfs_dir_operations;
 491
 492 /* Globals from file.c */
 493 int ntfs_getattr(struct mnt_idmap *idmap, const struct path *path,
 494                  struct kstat *stat, u32 request_mask, u32 flags);
 495 int ntfs3_setattr(struct mnt_idmap *idmap, struct dentry *dentry,
 496                   struct iattr *attr);
 497 void ntfs_sparse_cluster(struct inode *inode, struct page *page0, CLST vcn,
 498                          CLST len);
 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 bool check_index_header(const struct INDEX_HDR *hdr, size_t bytes);
 583 int log_replay(struct ntfs_inode *ni, bool *initialized);
 584
 585 /* Globals from fsntfs.c */
 586 bool ntfs_fix_pre_write(struct NTFS_RECORD_HEADER *rhdr, size_t bytes);
 587 int ntfs_fix_post_read(struct NTFS_RECORD_HEADER *rhdr, size_t bytes,
 588                        bool simple);
 589 int ntfs_extend_init(struct ntfs_sb_info *sbi);
 590 int ntfs_loadlog_and_replay(struct ntfs_inode *ni, struct ntfs_sb_info *sbi);
 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 bool ntfs_check_for_free_space(struct ntfs_sb_info *sbi, CLST clen, CLST mlen);
 595 int ntfs_look_free_mft(struct ntfs_sb_info *sbi, CLST *rno, bool mft,
 596                        struct ntfs_inode *ni, struct mft_inode **mi);
 597 void ntfs_mark_rec_free(struct ntfs_sb_info *sbi, CLST rno, bool is_mft);
 598 int ntfs_clear_mft_tail(struct ntfs_sb_info *sbi, size_t from, size_t to);
 599 int ntfs_refresh_zone(struct ntfs_sb_info *sbi);
 600 void ntfs_update_mftmirr(struct ntfs_sb_info *sbi, int wait);
 601 void ntfs_bad_inode(struct inode *inode, const char *hint);
 602 #define _ntfs_bad_inode(i) ntfs_bad_inode(i, __func__)
 603 enum NTFS_DIRTY_FLAGS {
 604         NTFS_DIRTY_CLEAR = 0,
 605         NTFS_DIRTY_DIRTY = 1,
 606         NTFS_DIRTY_ERROR = 2,
 607 };
 608 int ntfs_set_state(struct ntfs_sb_info *sbi, enum NTFS_DIRTY_FLAGS dirty);
 609 int ntfs_sb_read(struct super_block *sb, u64 lbo, size_t bytes, void *buffer);
 610 int ntfs_sb_write(struct super_block *sb, u64 lbo, size_t bytes,
 611                   const void *buffer, int wait);
 612 int ntfs_sb_write_run(struct ntfs_sb_info *sbi, const struct runs_tree *run,
 613                       u64 vbo, const void *buf, size_t bytes, int sync);
 614 struct buffer_head *ntfs_bread_run(struct ntfs_sb_info *sbi,
 615                                    const struct runs_tree *run, u64 vbo);
 616 int ntfs_read_run_nb(struct ntfs_sb_info *sbi, const struct runs_tree *run,
 617                      u64 vbo, void *buf, u32 bytes, struct ntfs_buffers *nb);
 618 int ntfs_read_bh(struct ntfs_sb_info *sbi, const struct runs_tree *run, u64 vbo,
 619                  struct NTFS_RECORD_HEADER *rhdr, u32 bytes,
 620                  struct ntfs_buffers *nb);
 621 int ntfs_get_bh(struct ntfs_sb_info *sbi, const struct runs_tree *run, u64 vbo,
 622                 u32 bytes, struct ntfs_buffers *nb);
 623 int ntfs_write_bh(struct ntfs_sb_info *sbi, struct NTFS_RECORD_HEADER *rhdr,
 624                   struct ntfs_buffers *nb, int sync);
 625 int ntfs_bio_pages(struct ntfs_sb_info *sbi, const struct runs_tree *run,
 626                    struct page **pages, u32 nr_pages, u64 vbo, u32 bytes,
 627                    enum req_op op);
 628 int ntfs_bio_fill_1(struct ntfs_sb_info *sbi, const struct runs_tree *run);
 629 int ntfs_vbo_to_lbo(struct ntfs_sb_info *sbi, const struct runs_tree *run,
 630                     u64 vbo, u64 *lbo, u64 *bytes);
 631 struct ntfs_inode *ntfs_new_inode(struct ntfs_sb_info *sbi, CLST nRec,
 632                                   bool dir);
 633 extern const u8 s_default_security[0x50];
 634 bool is_sd_valid(const struct SECURITY_DESCRIPTOR_RELATIVE *sd, u32 len);
 635 int ntfs_security_init(struct ntfs_sb_info *sbi);
 636 int ntfs_get_security_by_id(struct ntfs_sb_info *sbi, __le32 security_id,
 637                             struct SECURITY_DESCRIPTOR_RELATIVE **sd,
 638                             size_t *size);
 639 int ntfs_insert_security(struct ntfs_sb_info *sbi,
 640                          const struct SECURITY_DESCRIPTOR_RELATIVE *sd,
 641                          u32 size, __le32 *security_id, bool *inserted);
 642 int ntfs_reparse_init(struct ntfs_sb_info *sbi);
 643 int ntfs_objid_init(struct ntfs_sb_info *sbi);
 644 int ntfs_objid_remove(struct ntfs_sb_info *sbi, struct GUID *guid);
 645 int ntfs_insert_reparse(struct ntfs_sb_info *sbi, __le32 rtag,
 646                         const struct MFT_REF *ref);
 647 int ntfs_remove_reparse(struct ntfs_sb_info *sbi, __le32 rtag,
 648                         const struct MFT_REF *ref);
 649 void mark_as_free_ex(struct ntfs_sb_info *sbi, CLST lcn, CLST len, bool trim);
 650 int run_deallocate(struct ntfs_sb_info *sbi, struct runs_tree *run, bool trim);
 651 bool valid_windows_name(struct ntfs_sb_info *sbi, const struct le_str *name);
 652
 653 /* Globals from index.c */
 654 int indx_used_bit(struct ntfs_index *indx, struct ntfs_inode *ni, size_t *bit);
 655 void fnd_clear(struct ntfs_fnd *fnd);
 656 static inline struct ntfs_fnd *fnd_get(void)
 657 {
 658         return kzalloc(sizeof(struct ntfs_fnd), GFP_NOFS);
 659 }
 660 static inline void fnd_put(struct ntfs_fnd *fnd)
 661 {
 662         if (fnd) {
 663                 fnd_clear(fnd);
 664                 kfree(fnd);
 665         }
 666 }
 667 void indx_clear(struct ntfs_index *idx);
 668 int indx_init(struct ntfs_index *indx, struct ntfs_sb_info *sbi,
 669               const struct ATTRIB *attr, enum index_mutex_classed type);
 670 struct INDEX_ROOT *indx_get_root(struct ntfs_index *indx, struct ntfs_inode *ni,
 671                                  struct ATTRIB **attr, struct mft_inode **mi);
 672 int indx_read(struct ntfs_index *idx, struct ntfs_inode *ni, CLST vbn,
 673               struct indx_node **node);
 674 int indx_find(struct ntfs_index *indx, struct ntfs_inode *dir,
 675               const struct INDEX_ROOT *root, const void *Key, size_t KeyLen,
 676               const void *param, int *diff, struct NTFS_DE **entry,
 677               struct ntfs_fnd *fnd);
 678 int indx_find_sort(struct ntfs_index *indx, struct ntfs_inode *ni,
 679                    const struct INDEX_ROOT *root, struct NTFS_DE **entry,
 680                    struct ntfs_fnd *fnd);
 681 int indx_find_raw(struct ntfs_index *indx, struct ntfs_inode *ni,
 682                   const struct INDEX_ROOT *root, struct NTFS_DE **entry,
 683                   size_t *off, struct ntfs_fnd *fnd);
 684 int indx_insert_entry(struct ntfs_index *indx, struct ntfs_inode *ni,
 685                       const struct NTFS_DE *new_de, const void *param,
 686                       struct ntfs_fnd *fnd, bool undo);
 687 int indx_delete_entry(struct ntfs_index *indx, struct ntfs_inode *ni,
 688                       const void *key, u32 key_len, const void *param);
 689 int indx_update_dup(struct ntfs_inode *ni, struct ntfs_sb_info *sbi,
 690                     const struct ATTR_FILE_NAME *fname,
 691                     const struct NTFS_DUP_INFO *dup, int sync);
 692
 693 /* Globals from inode.c */
 694 struct inode *ntfs_iget5(struct super_block *sb, const struct MFT_REF *ref,
 695                          const struct cpu_str *name);
 696 int ntfs_set_size(struct inode *inode, u64 new_size);
 697 int reset_log_file(struct inode *inode);
 698 int ntfs_get_block(struct inode *inode, sector_t vbn,
 699                    struct buffer_head *bh_result, int create);
 700 int ntfs_write_begin(struct file *file, struct address_space *mapping,
 701                      loff_t pos, u32 len, struct page **pagep, void **fsdata);
 702 int ntfs_write_end(struct file *file, struct address_space *mapping, loff_t pos,
 703                    u32 len, u32 copied, struct page *page, 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 mnt_idmap *idmap,
 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 mnt_idmap *idmap,
 860                                struct dentry *dentry, int type);
 861 int ntfs_set_acl(struct mnt_idmap *idmap, struct dentry *dentry,
 862                  struct posix_acl *acl, int type);
 863 int ntfs_init_acl(struct mnt_idmap *idmap, struct inode *inode,
 864                  struct inode *dir);
 865 #else
 866 #define ntfs_get_acl NULL
 867 #define ntfs_set_acl NULL
 868 #endif
 869
 870 int ntfs_acl_chmod(struct mnt_idmap *idmap, struct dentry *dentry);
 871 ssize_t ntfs_listxattr(struct dentry *dentry, char *buffer, size_t size);
 872 extern const struct xattr_handler *ntfs_xattr_handlers[];
 873
 874 int ntfs_save_wsl_perm(struct inode *inode, __le16 *ea_size);
 875 void ntfs_get_wsl_perm(struct inode *inode);
 876
 877 /* globals from lznt.c */
 878 struct lznt *get_lznt_ctx(int level);
 879 size_t compress_lznt(const void *uncompressed, size_t uncompressed_size,
 880                      void *compressed, size_t compressed_size,
 881                      struct lznt *ctx);
 882 ssize_t decompress_lznt(const void *compressed, size_t compressed_size,
 883                         void *uncompressed, size_t uncompressed_size);
 884
 885 static inline bool is_ntfs3(struct ntfs_sb_info *sbi)
 886 {
 887         return sbi->volume.major_ver >= 3;
 888 }
 889
 890 /* (sb->s_flags & SB_ACTIVE) */
 891 static inline bool is_mounted(struct ntfs_sb_info *sbi)
 892 {
 893         return !!sbi->sb->s_root;
 894 }
 895
 896 static inline bool ntfs_is_meta_file(struct ntfs_sb_info *sbi, CLST rno)
 897 {
 898         return rno < MFT_REC_FREE || rno == sbi->objid_no ||
 899                rno == sbi->quota_no || rno == sbi->reparse_no ||
 900                rno == sbi->usn_jrnl_no;
 901 }
 902
 903 static inline void ntfs_unmap_page(struct page *page)
 904 {
 905         kunmap(page);
 906         put_page(page);
 907 }
 908
 909 static inline struct page *ntfs_map_page(struct address_space *mapping,
 910                                          unsigned long index)
 911 {
 912         struct page *page = read_mapping_page(mapping, index, NULL);
 913
 914         if (!IS_ERR(page))
 915                 kmap(page);
 916         return page;
 917 }
 918
 919 static inline size_t wnd_zone_bit(const struct wnd_bitmap *wnd)
 920 {
 921         return wnd->zone_bit;
 922 }
 923
 924 static inline size_t wnd_zone_len(const struct wnd_bitmap *wnd)
 925 {
 926         return wnd->zone_end - wnd->zone_bit;
 927 }
 928
 929 static inline void run_init(struct runs_tree *run)
 930 {
 931         run->runs = NULL;
 932         run->count = 0;
 933         run->allocated = 0;
 934 }
 935
 936 static inline struct runs_tree *run_alloc(void)
 937 {
 938         return kzalloc(sizeof(struct runs_tree), GFP_NOFS);
 939 }
 940
 941 static inline void run_close(struct runs_tree *run)
 942 {
 943         kvfree(run->runs);
 944         memset(run, 0, sizeof(*run));
 945 }
 946
 947 static inline void run_free(struct runs_tree *run)
 948 {
 949         if (run) {
 950                 kvfree(run->runs);
 951                 kfree(run);
 952         }
 953 }
 954
 955 static inline bool run_is_empty(struct runs_tree *run)
 956 {
 957         return !run->count;
 958 }
 959
 960 /* NTFS uses quad aligned bitmaps. */
 961 static inline size_t bitmap_size(size_t bits)
 962 {
 963         return ALIGN((bits + 7) >> 3, 8);
 964 }
 965
 966 #define _100ns2seconds 10000000
 967 #define SecondsToStartOf1970 0x00000002B6109100
 968
 969 #define NTFS_TIME_GRAN 100
 970
 971 /*
 972  * kernel2nt - Converts in-memory kernel timestamp into nt time.
 973  */
 974 static inline __le64 kernel2nt(const struct timespec64 *ts)
 975 {
 976         // 10^7 units of 100 nanoseconds one second
 977         return cpu_to_le64(_100ns2seconds *
 978                                    (ts->tv_sec + SecondsToStartOf1970) +
 979                            ts->tv_nsec / NTFS_TIME_GRAN);
 980 }
 981
 982 /*
 983  * nt2kernel - Converts on-disk nt time into kernel timestamp.
 984  */
 985 static inline void nt2kernel(const __le64 tm, struct timespec64 *ts)
 986 {
 987         u64 t = le64_to_cpu(tm) - _100ns2seconds * SecondsToStartOf1970;
 988
 989         // WARNING: do_div changes its first argument(!)
 990         ts->tv_nsec = do_div(t, _100ns2seconds) * 100;
 991         ts->tv_sec = t;
 992 }
 993
 994 static inline struct ntfs_sb_info *ntfs_sb(struct super_block *sb)
 995 {
 996         return sb->s_fs_info;
 997 }
 998
 999 /*
1000  * ntfs_up_cluster - Align up on cluster boundary.
1001  */
1002 static inline u64 ntfs_up_cluster(const struct ntfs_sb_info *sbi, u64 size)
1003 {
1004         return (size + sbi->cluster_mask) & sbi->cluster_mask_inv;
1005 }
1006
1007 /*
1008  * ntfs_up_block - Align up on cluster boundary.
1009  */
1010 static inline u64 ntfs_up_block(const struct super_block *sb, u64 size)
1011 {
1012         return (size + sb->s_blocksize - 1) & ~(u64)(sb->s_blocksize - 1);
1013 }
1014
1015 static inline CLST bytes_to_cluster(const struct ntfs_sb_info *sbi, u64 size)
1016 {
1017         return (size + sbi->cluster_mask) >> sbi->cluster_bits;
1018 }
1019
1020 static inline u64 bytes_to_block(const struct super_block *sb, u64 size)
1021 {
1022         return (size + sb->s_blocksize - 1) >> sb->s_blocksize_bits;
1023 }
1024
1025 static inline struct buffer_head *ntfs_bread(struct super_block *sb,
1026                                              sector_t block)
1027 {
1028         struct buffer_head *bh = sb_bread(sb, block);
1029
1030         if (bh)
1031                 return bh;
1032
1033         ntfs_err(sb, "failed to read volume at offset 0x%llx",
1034                  (u64)block << sb->s_blocksize_bits);
1035         return NULL;
1036 }
1037
1038 static inline struct ntfs_inode *ntfs_i(struct inode *inode)
1039 {
1040         return container_of(inode, struct ntfs_inode, vfs_inode);
1041 }
1042
1043 static inline bool is_compressed(const struct ntfs_inode *ni)
1044 {
1045         return (ni->std_fa & FILE_ATTRIBUTE_COMPRESSED) ||
1046                (ni->ni_flags & NI_FLAG_COMPRESSED_MASK);
1047 }
1048
1049 static inline int ni_ext_compress_bits(const struct ntfs_inode *ni)
1050 {
1051         return 0xb + (ni->ni_flags & NI_FLAG_COMPRESSED_MASK);
1052 }
1053
1054 /* Bits - 0xc, 0xd, 0xe, 0xf, 0x10 */
1055 static inline void ni_set_ext_compress_bits(struct ntfs_inode *ni, u8 bits)
1056 {
1057         ni->ni_flags |= (bits - 0xb) & NI_FLAG_COMPRESSED_MASK;
1058 }
1059
1060 static inline bool is_dedup(const struct ntfs_inode *ni)
1061 {
1062         return ni->ni_flags & NI_FLAG_DEDUPLICATED;
1063 }
1064
1065 static inline bool is_encrypted(const struct ntfs_inode *ni)
1066 {
1067         return ni->std_fa & FILE_ATTRIBUTE_ENCRYPTED;
1068 }
1069
1070 static inline bool is_sparsed(const struct ntfs_inode *ni)
1071 {
1072         return ni->std_fa & FILE_ATTRIBUTE_SPARSE_FILE;
1073 }
1074
1075 static inline int is_resident(struct ntfs_inode *ni)
1076 {
1077         return ni->ni_flags & NI_FLAG_RESIDENT;
1078 }
1079
1080 static inline void le16_sub_cpu(__le16 *var, u16 val)
1081 {
1082         *var = cpu_to_le16(le16_to_cpu(*var) - val);
1083 }
1084
1085 static inline void le32_sub_cpu(__le32 *var, u32 val)
1086 {
1087         *var = cpu_to_le32(le32_to_cpu(*var) - val);
1088 }
1089
1090 static inline void nb_put(struct ntfs_buffers *nb)
1091 {
1092         u32 i, nbufs = nb->nbufs;
1093
1094         if (!nbufs)
1095                 return;
1096
1097         for (i = 0; i < nbufs; i++)
1098                 put_bh(nb->bh[i]);
1099         nb->nbufs = 0;
1100 }
1101
1102 static inline void put_indx_node(struct indx_node *in)
1103 {
1104         if (!in)
1105                 return;
1106
1107         kfree(in->index);
1108         nb_put(&in->nb);
1109         kfree(in);
1110 }
1111
1112 static inline void mi_clear(struct mft_inode *mi)
1113 {
1114         nb_put(&mi->nb);
1115         kfree(mi->mrec);
1116         mi->mrec = NULL;
1117 }
1118
1119 static inline void ni_lock(struct ntfs_inode *ni)
1120 {
1121         mutex_lock_nested(&ni->ni_lock, NTFS_INODE_MUTEX_NORMAL);
1122 }
1123
1124 static inline void ni_lock_dir(struct ntfs_inode *ni)
1125 {
1126         mutex_lock_nested(&ni->ni_lock, NTFS_INODE_MUTEX_PARENT);
1127 }
1128
1129 static inline void ni_lock_dir2(struct ntfs_inode *ni)
1130 {
1131         mutex_lock_nested(&ni->ni_lock, NTFS_INODE_MUTEX_PARENT2);
1132 }
1133
1134 static inline void ni_unlock(struct ntfs_inode *ni)
1135 {
1136         mutex_unlock(&ni->ni_lock);
1137 }
1138
1139 static inline int ni_trylock(struct ntfs_inode *ni)
1140 {
1141         return mutex_trylock(&ni->ni_lock);
1142 }
1143
1144 static inline int attr_load_runs_attr(struct ntfs_inode *ni,
1145                                       struct ATTRIB *attr,
1146                                       struct runs_tree *run, CLST vcn)
1147 {
1148         return attr_load_runs_vcn(ni, attr->type, attr_name(attr),
1149                                   attr->name_len, run, vcn);
1150 }
1151
1152 static inline void le64_sub_cpu(__le64 *var, u64 val)
1153 {
1154         *var = cpu_to_le64(le64_to_cpu(*var) - val);
1155 }
1156
1157 #endif /* _LINUX_NTFS3_NTFS_FS_H */