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