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