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