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