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