1 /* SPDX-License-Identifier: GPL-2.0 */
4 * Copyright (C) 2019-2021 Paragon Software GmbH, All rights reserved.
9 #ifndef _LINUX_NTFS3_NTFS_FS_H
10 #define _LINUX_NTFS3_NTFS_FS_H
12 #include <linux/blkdev.h>
13 #include <linux/buffer_head.h>
14 #include <linux/cleancache.h>
16 #include <linux/highmem.h>
17 #include <linux/kernel.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>
36 struct fiemap_extent_info;
37 struct user_namespace;
39 struct writeback_control;
43 #define MINUS_ONE_T ((size_t)(-1))
44 /* Biggest MFT / smallest cluster */
45 #define MAXIMUM_BYTES_PER_MFT 4096
46 #define NTFS_BLOCKS_PER_MFT_RECORD (MAXIMUM_BYTES_PER_MFT / 512)
48 #define MAXIMUM_BYTES_PER_INDEX 4096
49 #define NTFS_BLOCKS_PER_INODE (MAXIMUM_BYTES_PER_INDEX / 512)
51 /* NTFS specific error code when fixup failed. */
52 #define E_NTFS_FIXUP 555
53 /* NTFS specific error code about resident->nonresident. */
54 #define E_NTFS_NONRESIDENT 556
55 /* NTFS specific error code about punch hole. */
56 #define E_NTFS_NOTALIGNED 557
57 /* NTFS specific error code when on-disk struct is corrupted. */
58 #define E_NTFS_CORRUPT 558
62 #define NTFS_FLAGS_NODISCARD 0x00000001
63 /* Set when LogFile is replaying. */
64 #define NTFS_FLAGS_LOG_REPLAYING 0x00000008
65 /* Set when we changed first MFT's which copy must be updated in $MftMirr. */
66 #define NTFS_FLAGS_MFTMIRR 0x00001000
67 #define NTFS_FLAGS_NEED_REPLAY 0x04000000
72 * Data attribute is external compressed (LZX/Xpress)
73 * 1 - WOF_COMPRESSION_XPRESS4K
74 * 2 - WOF_COMPRESSION_XPRESS8K
75 * 3 - WOF_COMPRESSION_XPRESS16K
76 * 4 - WOF_COMPRESSION_LZX32K
78 #define NI_FLAG_COMPRESSED_MASK 0x0000000f
79 /* Data attribute is deduplicated. */
80 #define NI_FLAG_DEDUPLICATED 0x00000010
81 #define NI_FLAG_EA 0x00000020
82 #define NI_FLAG_DIR 0x00000040
83 #define NI_FLAG_RESIDENT 0x00000080
84 #define NI_FLAG_UPDATE_PARENT 0x00000100
87 struct ntfs_mount_options {
89 struct nls_table *nls;
96 unsigned fmask : 1; /* fmask was set. */
97 unsigned dmask : 1; /*dmask was set. */
98 unsigned sys_immutable : 1; /* Immutable system files. */
99 unsigned discard : 1; /* Issue discard requests on deletions. */
100 unsigned sparse : 1; /* Create sparse files. */
101 unsigned showmeta : 1; /* Show meta files. */
102 unsigned nohidden : 1; /* Do not show hidden files. */
103 unsigned force : 1; /* RW mount dirty volume. */
104 unsigned noacsrules : 1; /* Exclude acs rules. */
105 unsigned prealloc : 1; /* Preallocate space when file is growing. */
108 /* Special value to unpack and deallocate. */
109 #define RUN_DEALLOCATE ((struct runs_tree *)(size_t)1)
111 /* TODO: Use rb tree instead of array. */
113 struct ntfs_run *runs;
114 size_t count; /* Currently used size a ntfs_run storage. */
115 size_t allocated; /* Currently allocated ntfs_run storage size. */
118 struct ntfs_buffers {
119 /* Biggest MFT / smallest cluster = 4096 / 512 = 8 */
120 /* Biggest index / smallest cluster = 4096 / 512 = 8 */
121 struct buffer_head *bh[PAGE_SIZE >> SECTOR_SHIFT];
128 ALLOCATE_DEF = 0, // Allocate all clusters.
129 ALLOCATE_MFT = 1, // Allocate for MFT.
132 enum bitmap_mutex_classes {
133 BITMAP_MUTEX_CLUSTERS = 0,
134 BITMAP_MUTEX_MFT = 1,
138 struct super_block *sb;
139 struct rw_semaphore rw_lock;
141 struct runs_tree run;
144 size_t total_zeroes; // Total number of free bits.
145 u16 *free_bits; // Free bits in each window.
147 u32 bits_last; // Bits in last window.
149 struct rb_root start_tree; // Extents, sorted by 'start'.
150 struct rb_root count_tree; // Extents, sorted by 'count + start'.
151 size_t count; // Extents count.
154 * -1 Tree is activated but not updated (too many fragments).
155 * 0 - Tree is not activated.
156 * 1 - Tree is activated and updated.
159 size_t extent_min; // Minimal extent used while building.
160 size_t extent_max; // Upper estimate of biggest free block.
162 /* Zone [bit, end) */
166 bool set_tail; // Not necessary in driver.
170 typedef int (*NTFS_CMP_FUNC)(const void *key1, size_t len1, const void *key2,
171 size_t len2, const void *param);
173 enum index_mutex_classed {
183 /* ntfs_index - Allocation unit inside directory. */
185 struct runs_tree bitmap_run;
186 struct runs_tree alloc_run;
187 /* read/write access to 'bitmap_run'/'alloc_run' while ntfs_readdir */
188 struct rw_semaphore run_lock;
190 /*TODO: Remove 'cmp'. */
193 u8 index_bits; // log2(root->index_block_size)
194 u8 idx2vbn_bits; // log2(root->index_block_clst)
195 u8 vbn2vbo_bits; // index_block_size < cluster? 9 : cluster_bits
196 u8 type; // index_mutex_classed
199 /* Minimum MFT zone. */
200 #define NTFS_MIN_MFT_ZONE 100
202 /* Ntfs file system in-core superblock data. */
203 struct ntfs_sb_info {
204 struct super_block *sb;
206 u32 discard_granularity;
207 u64 discard_granularity_mask_inv; // ~(discard_granularity_mask_inv-1)
209 u32 cluster_size; // bytes per cluster
210 u32 cluster_mask; // == cluster_size - 1
211 u64 cluster_mask_inv; // ~(cluster_size - 1)
212 u32 block_mask; // sb->s_blocksize - 1
213 u32 blocks_per_cluster; // cluster_size / sb->s_blocksize
221 u64 maxbytes; // Maximum size for normal files.
222 u64 maxbytes_sparse; // Maximum size for sparse file.
224 u32 flags; // See NTFS_FLAGS_XXX.
226 CLST bad_clusters; // The count of marked bad clusters.
228 u16 max_bytes_per_attr; // Maximum attribute size in record.
229 u16 attr_size_tr; // Attribute size threshold (320 bytes).
231 /* Records in $Extend. */
237 struct ATTR_DEF_ENTRY *def_table; // Attribute definition table.
241 struct MFT_REC *new_rec;
247 struct ntfs_inode *ni;
248 struct wnd_bitmap bitmap; // $MFT::Bitmap
250 * MFT records [11-24) used to expand MFT itself.
251 * They always marked as used in $MFT::Bitmap
252 * 'reserved_bitmap' contains real bitmap of these records.
254 ulong reserved_bitmap; // Bitmap of used records [11 - 24)
255 size_t next_free; // The next record to allocate from
256 size_t used; // MFT valid size in records.
257 u32 recs_mirr; // Number of records in MFTMirr
259 u8 reserved_bitmap_inited;
263 struct wnd_bitmap bitmap; // $Bitmap::Data
268 u64 size; // In bytes.
269 u64 blocks; // In blocks.
271 struct ntfs_inode *ni;
272 __le16 flags; // Cached current VOLUME_INFO::flags, VOLUME_FLAG_DIRTY.
276 bool real_dirty; // Real fs state.
280 struct ntfs_index index_sii;
281 struct ntfs_index index_sdh;
282 struct ntfs_inode *ni;
286 __le32 def_security_id;
290 struct ntfs_index index_r;
291 struct ntfs_inode *ni;
296 struct ntfs_index index_o;
297 struct ntfs_inode *ni;
301 struct mutex mtx_lznt;
303 #ifdef CONFIG_NTFS3_LZX_XPRESS
304 struct mutex mtx_xpress;
305 struct xpress_decompressor *xpress;
306 struct mutex mtx_lzx;
307 struct lzx_decompressor *lzx;
311 struct ntfs_mount_options *options;
312 struct ratelimit_state msg_ratelimit;
315 /* One MFT record(usually 1024 bytes), consists of attributes. */
318 struct ntfs_sb_info *sbi;
320 struct MFT_REC *mrec;
321 struct ntfs_buffers nb;
327 /* Nested class for ntfs_inode::ni_lock. */
328 enum ntfs_inode_mutex_lock_class {
329 NTFS_INODE_MUTEX_DIRTY,
330 NTFS_INODE_MUTEX_SECURITY,
331 NTFS_INODE_MUTEX_OBJID,
332 NTFS_INODE_MUTEX_REPARSE,
333 NTFS_INODE_MUTEX_NORMAL,
334 NTFS_INODE_MUTEX_PARENT,
340 * Ntfs inode - extends linux inode. consists of one or more MFT inodes.
343 struct mft_inode mi; // base record
346 * Valid size: [0 - i_valid) - these range in file contains valid data.
347 * Range [i_valid - inode->i_size) - contains 0.
348 * Usually i_valid <= inode->i_size.
351 struct timespec64 i_crtime;
353 struct mutex ni_lock;
355 /* File attributes from std. */
356 enum FILE_ATTRIBUTE std_fa;
357 __le32 std_security_id;
361 * Not empty when primary MFT record (usually 1024 bytes) can't save all attributes
362 * e.g. file becomes too fragmented or contains a lot of names.
364 struct rb_root mi_tree;
367 * This member is used in ntfs_readdir to ensure that all subrecords are loaded
372 struct ntfs_index dir;
374 struct rw_semaphore run_lock;
375 struct runs_tree run;
376 #ifdef CONFIG_NTFS3_LZX_XPRESS
377 struct page *offs_page;
383 struct runs_tree run;
384 struct ATTR_LIST_ENTRY *le; // 1K aligned memory.
389 size_t ni_flags; // NI_FLAG_XXX
391 struct inode vfs_inode;
395 struct ntfs_buffers nb;
396 struct INDEX_BUFFER *index;
401 struct indx_node *nodes[20];
402 struct NTFS_DE *de[20];
403 struct NTFS_DE *root_de;
408 REPARSE_COMPRESSED = 1,
409 REPARSE_DEDUPLICATED = 2,
413 /* Functions from attrib.c */
414 int attr_load_runs(struct ATTRIB *attr, struct ntfs_inode *ni,
415 struct runs_tree *run, const CLST *vcn);
416 int attr_allocate_clusters(struct ntfs_sb_info *sbi, struct runs_tree *run,
417 CLST vcn, CLST lcn, CLST len, CLST *pre_alloc,
418 enum ALLOCATE_OPT opt, CLST *alen, const size_t fr,
420 int attr_make_nonresident(struct ntfs_inode *ni, struct ATTRIB *attr,
421 struct ATTR_LIST_ENTRY *le, struct mft_inode *mi,
422 u64 new_size, struct runs_tree *run,
423 struct ATTRIB **ins_attr, struct page *page);
424 int attr_set_size(struct ntfs_inode *ni, enum ATTR_TYPE type,
425 const __le16 *name, u8 name_len, struct runs_tree *run,
426 u64 new_size, const u64 *new_valid, bool keep_prealloc,
427 struct ATTRIB **ret);
428 int attr_data_get_block(struct ntfs_inode *ni, CLST vcn, CLST clen, CLST *lcn,
429 CLST *len, bool *new);
430 int attr_data_read_resident(struct ntfs_inode *ni, struct page *page);
431 int attr_data_write_resident(struct ntfs_inode *ni, struct page *page);
432 int attr_load_runs_vcn(struct ntfs_inode *ni, enum ATTR_TYPE type,
433 const __le16 *name, u8 name_len, struct runs_tree *run,
435 int attr_load_runs_range(struct ntfs_inode *ni, enum ATTR_TYPE type,
436 const __le16 *name, u8 name_len, struct runs_tree *run,
438 int attr_wof_frame_info(struct ntfs_inode *ni, struct ATTRIB *attr,
439 struct runs_tree *run, u64 frame, u64 frames,
440 u8 frame_bits, u32 *ondisk_size, u64 *vbo_data);
441 int attr_is_frame_compressed(struct ntfs_inode *ni, struct ATTRIB *attr,
442 CLST frame, CLST *clst_data);
443 int attr_allocate_frame(struct ntfs_inode *ni, CLST frame, size_t compr_size,
445 int attr_collapse_range(struct ntfs_inode *ni, u64 vbo, u64 bytes);
446 int attr_punch_hole(struct ntfs_inode *ni, u64 vbo, u64 bytes, u32 *frame_size);
448 /* Functions from attrlist.c */
449 void al_destroy(struct ntfs_inode *ni);
450 bool al_verify(struct ntfs_inode *ni);
451 int ntfs_load_attr_list(struct ntfs_inode *ni, struct ATTRIB *attr);
452 struct ATTR_LIST_ENTRY *al_enumerate(struct ntfs_inode *ni,
453 struct ATTR_LIST_ENTRY *le);
454 struct ATTR_LIST_ENTRY *al_find_le(struct ntfs_inode *ni,
455 struct ATTR_LIST_ENTRY *le,
456 const struct ATTRIB *attr);
457 struct ATTR_LIST_ENTRY *al_find_ex(struct ntfs_inode *ni,
458 struct ATTR_LIST_ENTRY *le,
459 enum ATTR_TYPE type, const __le16 *name,
460 u8 name_len, const CLST *vcn);
461 int al_add_le(struct ntfs_inode *ni, enum ATTR_TYPE type, const __le16 *name,
462 u8 name_len, CLST svcn, __le16 id, const struct MFT_REF *ref,
463 struct ATTR_LIST_ENTRY **new_le);
464 bool al_remove_le(struct ntfs_inode *ni, struct ATTR_LIST_ENTRY *le);
465 bool al_delete_le(struct ntfs_inode *ni, enum ATTR_TYPE type, CLST vcn,
466 const __le16 *name, size_t name_len,
467 const struct MFT_REF *ref);
468 int al_update(struct ntfs_inode *ni, int sync);
469 static inline size_t al_aligned(size_t size)
471 return (size + 1023) & ~(size_t)1023;
474 /* Globals from bitfunc.c */
475 bool are_bits_clear(const ulong *map, size_t bit, size_t nbits);
476 bool are_bits_set(const ulong *map, size_t bit, size_t nbits);
477 size_t get_set_bits_ex(const ulong *map, size_t bit, size_t nbits);
479 /* Globals from dir.c */
480 int ntfs_utf16_to_nls(struct ntfs_sb_info *sbi, const __le16 *name, u32 len,
481 u8 *buf, int buf_len);
482 int ntfs_nls_to_utf16(struct ntfs_sb_info *sbi, const u8 *name, u32 name_len,
483 struct cpu_str *uni, u32 max_ulen,
484 enum utf16_endian endian);
485 struct inode *dir_search_u(struct inode *dir, const struct cpu_str *uni,
486 struct ntfs_fnd *fnd);
487 bool dir_is_empty(struct inode *dir);
488 extern const struct file_operations ntfs_dir_operations;
490 /* Globals from file.c */
491 int ntfs_getattr(struct user_namespace *mnt_userns, const struct path *path,
492 struct kstat *stat, u32 request_mask, u32 flags);
493 void ntfs_sparse_cluster(struct inode *inode, struct page *page0, CLST vcn,
495 int ntfs3_setattr(struct user_namespace *mnt_userns, struct dentry *dentry,
497 int ntfs_file_open(struct inode *inode, struct file *file);
498 int ntfs_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
499 __u64 start, __u64 len);
500 extern const struct inode_operations ntfs_special_inode_operations;
501 extern const struct inode_operations ntfs_file_inode_operations;
502 extern const struct file_operations ntfs_file_operations;
504 /* Globals from frecord.c */
505 void ni_remove_mi(struct ntfs_inode *ni, struct mft_inode *mi);
506 struct ATTR_STD_INFO *ni_std(struct ntfs_inode *ni);
507 struct ATTR_STD_INFO5 *ni_std5(struct ntfs_inode *ni);
508 void ni_clear(struct ntfs_inode *ni);
509 int ni_load_mi_ex(struct ntfs_inode *ni, CLST rno, struct mft_inode **mi);
510 int ni_load_mi(struct ntfs_inode *ni, const struct ATTR_LIST_ENTRY *le,
511 struct mft_inode **mi);
512 struct ATTRIB *ni_find_attr(struct ntfs_inode *ni, struct ATTRIB *attr,
513 struct ATTR_LIST_ENTRY **entry_o,
514 enum ATTR_TYPE type, const __le16 *name,
515 u8 name_len, const CLST *vcn,
516 struct mft_inode **mi);
517 struct ATTRIB *ni_enum_attr_ex(struct ntfs_inode *ni, struct ATTRIB *attr,
518 struct ATTR_LIST_ENTRY **le,
519 struct mft_inode **mi);
520 struct ATTRIB *ni_load_attr(struct ntfs_inode *ni, enum ATTR_TYPE type,
521 const __le16 *name, u8 name_len, CLST vcn,
522 struct mft_inode **pmi);
523 int ni_load_all_mi(struct ntfs_inode *ni);
524 bool ni_add_subrecord(struct ntfs_inode *ni, CLST rno, struct mft_inode **mi);
525 int ni_remove_attr(struct ntfs_inode *ni, enum ATTR_TYPE type,
526 const __le16 *name, size_t name_len, bool base_only,
528 int ni_create_attr_list(struct ntfs_inode *ni);
529 int ni_expand_list(struct ntfs_inode *ni);
530 int ni_insert_nonresident(struct ntfs_inode *ni, enum ATTR_TYPE type,
531 const __le16 *name, u8 name_len,
532 const struct runs_tree *run, CLST svcn, CLST len,
533 __le16 flags, struct ATTRIB **new_attr,
534 struct mft_inode **mi);
535 int ni_insert_resident(struct ntfs_inode *ni, u32 data_size,
536 enum ATTR_TYPE type, const __le16 *name, u8 name_len,
537 struct ATTRIB **new_attr, struct mft_inode **mi,
538 struct ATTR_LIST_ENTRY **le);
539 void ni_remove_attr_le(struct ntfs_inode *ni, struct ATTRIB *attr,
540 struct mft_inode *mi, struct ATTR_LIST_ENTRY *le);
541 int ni_delete_all(struct ntfs_inode *ni);
542 struct ATTR_FILE_NAME *ni_fname_name(struct ntfs_inode *ni,
543 const struct cpu_str *uni,
544 const struct MFT_REF *home,
545 struct mft_inode **mi,
546 struct ATTR_LIST_ENTRY **entry);
547 struct ATTR_FILE_NAME *ni_fname_type(struct ntfs_inode *ni, u8 name_type,
548 struct mft_inode **mi,
549 struct ATTR_LIST_ENTRY **entry);
550 int ni_new_attr_flags(struct ntfs_inode *ni, enum FILE_ATTRIBUTE new_fa);
551 enum REPARSE_SIGN ni_parse_reparse(struct ntfs_inode *ni, struct ATTRIB *attr,
552 struct REPARSE_DATA_BUFFER *buffer);
553 int ni_write_inode(struct inode *inode, int sync, const char *hint);
554 #define _ni_write_inode(i, w) ni_write_inode(i, w, __func__)
555 int ni_fiemap(struct ntfs_inode *ni, struct fiemap_extent_info *fieinfo,
556 __u64 vbo, __u64 len);
557 int ni_readpage_cmpr(struct ntfs_inode *ni, struct page *page);
558 int ni_decompress_file(struct ntfs_inode *ni);
559 int ni_read_frame(struct ntfs_inode *ni, u64 frame_vbo, struct page **pages,
560 u32 pages_per_frame);
561 int ni_write_frame(struct ntfs_inode *ni, struct page **pages,
562 u32 pages_per_frame);
563 int ni_remove_name(struct ntfs_inode *dir_ni, struct ntfs_inode *ni,
564 struct NTFS_DE *de, struct NTFS_DE **de2, int *undo_step);
566 bool ni_remove_name_undo(struct ntfs_inode *dir_ni, struct ntfs_inode *ni,
567 struct NTFS_DE *de, struct NTFS_DE *de2,
570 int ni_add_name(struct ntfs_inode *dir_ni, struct ntfs_inode *ni,
573 int ni_rename(struct ntfs_inode *dir_ni, struct ntfs_inode *new_dir_ni,
574 struct ntfs_inode *ni, struct NTFS_DE *de, struct NTFS_DE *new_de,
577 bool ni_is_dirty(struct inode *inode);
579 /* Globals from fslog.c */
580 bool check_index_header(const struct INDEX_HDR *hdr, size_t bytes);
581 int log_replay(struct ntfs_inode *ni, bool *initialized);
583 /* Globals from fsntfs.c */
584 bool ntfs_fix_pre_write(struct NTFS_RECORD_HEADER *rhdr, size_t bytes);
585 int ntfs_fix_post_read(struct NTFS_RECORD_HEADER *rhdr, size_t bytes,
587 int ntfs_extend_init(struct ntfs_sb_info *sbi);
588 int ntfs_loadlog_and_replay(struct ntfs_inode *ni, struct ntfs_sb_info *sbi);
589 const struct ATTR_DEF_ENTRY *ntfs_query_def(struct ntfs_sb_info *sbi,
590 enum ATTR_TYPE Type);
591 int ntfs_look_for_free_space(struct ntfs_sb_info *sbi, CLST lcn, CLST len,
592 CLST *new_lcn, CLST *new_len,
593 enum ALLOCATE_OPT opt);
594 int ntfs_look_free_mft(struct ntfs_sb_info *sbi, CLST *rno, bool mft,
595 struct ntfs_inode *ni, struct mft_inode **mi);
596 void ntfs_mark_rec_free(struct ntfs_sb_info *sbi, CLST rno);
597 int ntfs_clear_mft_tail(struct ntfs_sb_info *sbi, size_t from, size_t to);
598 int ntfs_refresh_zone(struct ntfs_sb_info *sbi);
599 int ntfs_update_mftmirr(struct ntfs_sb_info *sbi, int wait);
600 enum NTFS_DIRTY_FLAGS {
601 NTFS_DIRTY_CLEAR = 0,
602 NTFS_DIRTY_DIRTY = 1,
603 NTFS_DIRTY_ERROR = 2,
605 int ntfs_set_state(struct ntfs_sb_info *sbi, enum NTFS_DIRTY_FLAGS dirty);
606 int ntfs_sb_read(struct super_block *sb, u64 lbo, size_t bytes, void *buffer);
607 int ntfs_sb_write(struct super_block *sb, u64 lbo, size_t bytes,
608 const void *buffer, int wait);
609 int ntfs_sb_write_run(struct ntfs_sb_info *sbi, const struct runs_tree *run,
610 u64 vbo, const void *buf, size_t bytes, int sync);
611 struct buffer_head *ntfs_bread_run(struct ntfs_sb_info *sbi,
612 const struct runs_tree *run, u64 vbo);
613 int ntfs_read_run_nb(struct ntfs_sb_info *sbi, const struct runs_tree *run,
614 u64 vbo, void *buf, u32 bytes, struct ntfs_buffers *nb);
615 int ntfs_read_bh(struct ntfs_sb_info *sbi, const struct runs_tree *run, u64 vbo,
616 struct NTFS_RECORD_HEADER *rhdr, u32 bytes,
617 struct ntfs_buffers *nb);
618 int ntfs_get_bh(struct ntfs_sb_info *sbi, const struct runs_tree *run, u64 vbo,
619 u32 bytes, struct ntfs_buffers *nb);
620 int ntfs_write_bh(struct ntfs_sb_info *sbi, struct NTFS_RECORD_HEADER *rhdr,
621 struct ntfs_buffers *nb, int sync);
622 int ntfs_bio_pages(struct ntfs_sb_info *sbi, const struct runs_tree *run,
623 struct page **pages, u32 nr_pages, u64 vbo, u32 bytes,
625 int ntfs_bio_fill_1(struct ntfs_sb_info *sbi, const struct runs_tree *run);
626 int ntfs_vbo_to_lbo(struct ntfs_sb_info *sbi, const struct runs_tree *run,
627 u64 vbo, u64 *lbo, u64 *bytes);
628 struct ntfs_inode *ntfs_new_inode(struct ntfs_sb_info *sbi, CLST nRec,
630 extern const u8 s_default_security[0x50];
631 bool is_sd_valid(const struct SECURITY_DESCRIPTOR_RELATIVE *sd, u32 len);
632 int ntfs_security_init(struct ntfs_sb_info *sbi);
633 int ntfs_get_security_by_id(struct ntfs_sb_info *sbi, __le32 security_id,
634 struct SECURITY_DESCRIPTOR_RELATIVE **sd,
636 int ntfs_insert_security(struct ntfs_sb_info *sbi,
637 const struct SECURITY_DESCRIPTOR_RELATIVE *sd,
638 u32 size, __le32 *security_id, bool *inserted);
639 int ntfs_reparse_init(struct ntfs_sb_info *sbi);
640 int ntfs_objid_init(struct ntfs_sb_info *sbi);
641 int ntfs_objid_remove(struct ntfs_sb_info *sbi, struct GUID *guid);
642 int ntfs_insert_reparse(struct ntfs_sb_info *sbi, __le32 rtag,
643 const struct MFT_REF *ref);
644 int ntfs_remove_reparse(struct ntfs_sb_info *sbi, __le32 rtag,
645 const struct MFT_REF *ref);
646 void mark_as_free_ex(struct ntfs_sb_info *sbi, CLST lcn, CLST len, bool trim);
647 int run_deallocate(struct ntfs_sb_info *sbi, struct runs_tree *run, bool trim);
649 /* Globals from index.c */
650 int indx_used_bit(struct ntfs_index *indx, struct ntfs_inode *ni, size_t *bit);
651 void fnd_clear(struct ntfs_fnd *fnd);
652 static inline struct ntfs_fnd *fnd_get(void)
654 return kzalloc(sizeof(struct ntfs_fnd), GFP_NOFS);
656 static inline void fnd_put(struct ntfs_fnd *fnd)
663 void indx_clear(struct ntfs_index *idx);
664 int indx_init(struct ntfs_index *indx, struct ntfs_sb_info *sbi,
665 const struct ATTRIB *attr, enum index_mutex_classed type);
666 struct INDEX_ROOT *indx_get_root(struct ntfs_index *indx, struct ntfs_inode *ni,
667 struct ATTRIB **attr, struct mft_inode **mi);
668 int indx_read(struct ntfs_index *idx, struct ntfs_inode *ni, CLST vbn,
669 struct indx_node **node);
670 int indx_find(struct ntfs_index *indx, struct ntfs_inode *dir,
671 const struct INDEX_ROOT *root, const void *Key, size_t KeyLen,
672 const void *param, int *diff, struct NTFS_DE **entry,
673 struct ntfs_fnd *fnd);
674 int indx_find_sort(struct ntfs_index *indx, struct ntfs_inode *ni,
675 const struct INDEX_ROOT *root, struct NTFS_DE **entry,
676 struct ntfs_fnd *fnd);
677 int indx_find_raw(struct ntfs_index *indx, struct ntfs_inode *ni,
678 const struct INDEX_ROOT *root, struct NTFS_DE **entry,
679 size_t *off, struct ntfs_fnd *fnd);
680 int indx_insert_entry(struct ntfs_index *indx, struct ntfs_inode *ni,
681 const struct NTFS_DE *new_de, const void *param,
682 struct ntfs_fnd *fnd, bool undo);
683 int indx_delete_entry(struct ntfs_index *indx, struct ntfs_inode *ni,
684 const void *key, u32 key_len, const void *param);
685 int indx_update_dup(struct ntfs_inode *ni, struct ntfs_sb_info *sbi,
686 const struct ATTR_FILE_NAME *fname,
687 const struct NTFS_DUP_INFO *dup, int sync);
689 /* Globals from inode.c */
690 struct inode *ntfs_iget5(struct super_block *sb, const struct MFT_REF *ref,
691 const struct cpu_str *name);
692 int ntfs_set_size(struct inode *inode, u64 new_size);
693 int reset_log_file(struct inode *inode);
694 int ntfs_get_block(struct inode *inode, sector_t vbn,
695 struct buffer_head *bh_result, int create);
696 int ntfs3_write_inode(struct inode *inode, struct writeback_control *wbc);
697 int ntfs_sync_inode(struct inode *inode);
698 int ntfs_flush_inodes(struct super_block *sb, struct inode *i1,
700 int inode_write_data(struct inode *inode, const void *data, size_t bytes);
701 struct inode *ntfs_create_inode(struct user_namespace *mnt_userns,
702 struct inode *dir, struct dentry *dentry,
703 const struct cpu_str *uni, umode_t mode,
704 dev_t dev, const char *symname, u32 size,
705 struct ntfs_fnd *fnd);
706 int ntfs_link_inode(struct inode *inode, struct dentry *dentry);
707 int ntfs_unlink_inode(struct inode *dir, const struct dentry *dentry);
708 void ntfs_evict_inode(struct inode *inode);
709 extern const struct inode_operations ntfs_link_inode_operations;
710 extern const struct address_space_operations ntfs_aops;
711 extern const struct address_space_operations ntfs_aops_cmpr;
713 /* Globals from name_i.c */
714 int fill_name_de(struct ntfs_sb_info *sbi, void *buf, const struct qstr *name,
715 const struct cpu_str *uni);
716 struct dentry *ntfs3_get_parent(struct dentry *child);
718 extern const struct inode_operations ntfs_dir_inode_operations;
719 extern const struct inode_operations ntfs_special_inode_operations;
721 /* Globals from record.c */
722 int mi_get(struct ntfs_sb_info *sbi, CLST rno, struct mft_inode **mi);
723 void mi_put(struct mft_inode *mi);
724 int mi_init(struct mft_inode *mi, struct ntfs_sb_info *sbi, CLST rno);
725 int mi_read(struct mft_inode *mi, bool is_mft);
726 struct ATTRIB *mi_enum_attr(struct mft_inode *mi, struct ATTRIB *attr);
728 struct ATTRIB *mi_find_attr(struct mft_inode *mi, struct ATTRIB *attr,
729 enum ATTR_TYPE type, const __le16 *name,
730 size_t name_len, const __le16 *id);
731 static inline struct ATTRIB *rec_find_attr_le(struct mft_inode *rec,
732 struct ATTR_LIST_ENTRY *le)
734 return mi_find_attr(rec, NULL, le->type, le_name(le), le->name_len,
737 int mi_write(struct mft_inode *mi, int wait);
738 int mi_format_new(struct mft_inode *mi, struct ntfs_sb_info *sbi, CLST rno,
739 __le16 flags, bool is_mft);
740 void mi_mark_free(struct mft_inode *mi);
741 struct ATTRIB *mi_insert_attr(struct mft_inode *mi, enum ATTR_TYPE type,
742 const __le16 *name, u8 name_len, u32 asize,
745 bool mi_remove_attr(struct ntfs_inode *ni, struct mft_inode *mi,
746 struct ATTRIB *attr);
747 bool mi_resize_attr(struct mft_inode *mi, struct ATTRIB *attr, int bytes);
748 int mi_pack_runs(struct mft_inode *mi, struct ATTRIB *attr,
749 struct runs_tree *run, CLST len);
750 static inline bool mi_is_ref(const struct mft_inode *mi,
751 const struct MFT_REF *ref)
753 if (le32_to_cpu(ref->low) != mi->rno)
755 if (ref->seq != mi->mrec->seq)
758 #ifdef CONFIG_NTFS3_64BIT_CLUSTER
759 return le16_to_cpu(ref->high) == (mi->rno >> 32);
765 static inline void mi_get_ref(const struct mft_inode *mi, struct MFT_REF *ref)
767 ref->low = cpu_to_le32(mi->rno);
768 #ifdef CONFIG_NTFS3_64BIT_CLUSTER
769 ref->high = cpu_to_le16(mi->rno >> 32);
773 ref->seq = mi->mrec->seq;
776 /* Globals from run.c */
777 bool run_lookup_entry(const struct runs_tree *run, CLST vcn, CLST *lcn,
778 CLST *len, size_t *index);
779 void run_truncate(struct runs_tree *run, CLST vcn);
780 void run_truncate_head(struct runs_tree *run, CLST vcn);
781 void run_truncate_around(struct runs_tree *run, CLST vcn);
782 bool run_lookup(const struct runs_tree *run, CLST vcn, size_t *Index);
783 bool run_add_entry(struct runs_tree *run, CLST vcn, CLST lcn, CLST len,
785 bool run_collapse_range(struct runs_tree *run, CLST vcn, CLST len);
786 bool run_get_entry(const struct runs_tree *run, size_t index, CLST *vcn,
787 CLST *lcn, CLST *len);
788 bool run_is_mapped_full(const struct runs_tree *run, CLST svcn, CLST evcn);
790 int run_pack(const struct runs_tree *run, CLST svcn, CLST len, u8 *run_buf,
791 u32 run_buf_size, CLST *packed_vcns);
792 int run_unpack(struct runs_tree *run, struct ntfs_sb_info *sbi, CLST ino,
793 CLST svcn, CLST evcn, CLST vcn, const u8 *run_buf,
796 #ifdef NTFS3_CHECK_FREE_CLST
797 int run_unpack_ex(struct runs_tree *run, struct ntfs_sb_info *sbi, CLST ino,
798 CLST svcn, CLST evcn, CLST vcn, const u8 *run_buf,
801 #define run_unpack_ex run_unpack
803 int run_get_highest_vcn(CLST vcn, const u8 *run_buf, u64 *highest_vcn);
805 /* Globals from super.c */
806 void *ntfs_set_shared(void *ptr, u32 bytes);
807 void *ntfs_put_shared(void *ptr);
808 void ntfs_unmap_meta(struct super_block *sb, CLST lcn, CLST len);
809 int ntfs_discard(struct ntfs_sb_info *sbi, CLST Lcn, CLST Len);
811 /* Globals from bitmap.c*/
812 int __init ntfs3_init_bitmap(void);
813 void ntfs3_exit_bitmap(void);
814 void wnd_close(struct wnd_bitmap *wnd);
815 static inline size_t wnd_zeroes(const struct wnd_bitmap *wnd)
817 return wnd->total_zeroes;
819 int wnd_init(struct wnd_bitmap *wnd, struct super_block *sb, size_t nbits);
820 int wnd_set_free(struct wnd_bitmap *wnd, size_t bit, size_t bits);
821 int wnd_set_used(struct wnd_bitmap *wnd, size_t bit, size_t bits);
822 bool wnd_is_free(struct wnd_bitmap *wnd, size_t bit, size_t bits);
823 bool wnd_is_used(struct wnd_bitmap *wnd, size_t bit, size_t bits);
825 /* Possible values for 'flags' 'wnd_find'. */
826 #define BITMAP_FIND_MARK_AS_USED 0x01
827 #define BITMAP_FIND_FULL 0x02
828 size_t wnd_find(struct wnd_bitmap *wnd, size_t to_alloc, size_t hint,
829 size_t flags, size_t *allocated);
830 int wnd_extend(struct wnd_bitmap *wnd, size_t new_bits);
831 void wnd_zone_set(struct wnd_bitmap *wnd, size_t Lcn, size_t Len);
832 int ntfs_trim_fs(struct ntfs_sb_info *sbi, struct fstrim_range *range);
834 /* Globals from upcase.c */
835 int ntfs_cmp_names(const __le16 *s1, size_t l1, const __le16 *s2, size_t l2,
836 const u16 *upcase, bool bothcase);
837 int ntfs_cmp_names_cpu(const struct cpu_str *uni1, const struct le_str *uni2,
838 const u16 *upcase, bool bothcase);
840 /* globals from xattr.c */
841 #ifdef CONFIG_NTFS3_FS_POSIX_ACL
842 struct posix_acl *ntfs_get_acl(struct inode *inode, int type, bool rcu);
843 int ntfs_set_acl(struct user_namespace *mnt_userns, struct inode *inode,
844 struct posix_acl *acl, int type);
845 int ntfs_init_acl(struct user_namespace *mnt_userns, struct inode *inode,
848 #define ntfs_get_acl NULL
849 #define ntfs_set_acl NULL
852 int ntfs_acl_chmod(struct user_namespace *mnt_userns, struct inode *inode);
853 int ntfs_permission(struct user_namespace *mnt_userns, struct inode *inode,
855 ssize_t ntfs_listxattr(struct dentry *dentry, char *buffer, size_t size);
856 extern const struct xattr_handler *ntfs_xattr_handlers[];
858 int ntfs_save_wsl_perm(struct inode *inode);
859 void ntfs_get_wsl_perm(struct inode *inode);
861 /* globals from lznt.c */
862 struct lznt *get_lznt_ctx(int level);
863 size_t compress_lznt(const void *uncompressed, size_t uncompressed_size,
864 void *compressed, size_t compressed_size,
866 ssize_t decompress_lznt(const void *compressed, size_t compressed_size,
867 void *uncompressed, size_t uncompressed_size);
869 static inline bool is_ntfs3(struct ntfs_sb_info *sbi)
871 return sbi->volume.major_ver >= 3;
874 /* (sb->s_flags & SB_ACTIVE) */
875 static inline bool is_mounted(struct ntfs_sb_info *sbi)
877 return !!sbi->sb->s_root;
880 static inline bool ntfs_is_meta_file(struct ntfs_sb_info *sbi, CLST rno)
882 return rno < MFT_REC_FREE || rno == sbi->objid_no ||
883 rno == sbi->quota_no || rno == sbi->reparse_no ||
884 rno == sbi->usn_jrnl_no;
887 static inline void ntfs_unmap_page(struct page *page)
893 static inline struct page *ntfs_map_page(struct address_space *mapping,
896 struct page *page = read_mapping_page(mapping, index, NULL);
900 if (!PageError(page))
902 ntfs_unmap_page(page);
903 return ERR_PTR(-EIO);
908 static inline size_t wnd_zone_bit(const struct wnd_bitmap *wnd)
910 return wnd->zone_bit;
913 static inline size_t wnd_zone_len(const struct wnd_bitmap *wnd)
915 return wnd->zone_end - wnd->zone_bit;
918 static inline void run_init(struct runs_tree *run)
925 static inline struct runs_tree *run_alloc(void)
927 return kzalloc(sizeof(struct runs_tree), GFP_NOFS);
930 static inline void run_close(struct runs_tree *run)
933 memset(run, 0, sizeof(*run));
936 static inline void run_free(struct runs_tree *run)
944 static inline bool run_is_empty(struct runs_tree *run)
949 /* NTFS uses quad aligned bitmaps. */
950 static inline size_t bitmap_size(size_t bits)
952 return ALIGN((bits + 7) >> 3, 8);
955 #define _100ns2seconds 10000000
956 #define SecondsToStartOf1970 0x00000002B6109100
958 #define NTFS_TIME_GRAN 100
961 * kernel2nt - Converts in-memory kernel timestamp into nt time.
963 static inline __le64 kernel2nt(const struct timespec64 *ts)
965 // 10^7 units of 100 nanoseconds one second
966 return cpu_to_le64(_100ns2seconds *
967 (ts->tv_sec + SecondsToStartOf1970) +
968 ts->tv_nsec / NTFS_TIME_GRAN);
972 * nt2kernel - Converts on-disk nt time into kernel timestamp.
974 static inline void nt2kernel(const __le64 tm, struct timespec64 *ts)
976 u64 t = le64_to_cpu(tm) - _100ns2seconds * SecondsToStartOf1970;
978 // WARNING: do_div changes its first argument(!)
979 ts->tv_nsec = do_div(t, _100ns2seconds) * 100;
983 static inline struct ntfs_sb_info *ntfs_sb(struct super_block *sb)
985 return sb->s_fs_info;
989 * ntfs_up_cluster - Align up on cluster boundary.
991 static inline u64 ntfs_up_cluster(const struct ntfs_sb_info *sbi, u64 size)
993 return (size + sbi->cluster_mask) & sbi->cluster_mask_inv;
997 * ntfs_up_block - Align up on cluster boundary.
999 static inline u64 ntfs_up_block(const struct super_block *sb, u64 size)
1001 return (size + sb->s_blocksize - 1) & ~(u64)(sb->s_blocksize - 1);
1004 static inline CLST bytes_to_cluster(const struct ntfs_sb_info *sbi, u64 size)
1006 return (size + sbi->cluster_mask) >> sbi->cluster_bits;
1009 static inline u64 bytes_to_block(const struct super_block *sb, u64 size)
1011 return (size + sb->s_blocksize - 1) >> sb->s_blocksize_bits;
1014 static inline struct buffer_head *ntfs_bread(struct super_block *sb,
1017 struct buffer_head *bh = sb_bread(sb, block);
1022 ntfs_err(sb, "failed to read volume at offset 0x%llx",
1023 (u64)block << sb->s_blocksize_bits);
1027 static inline struct ntfs_inode *ntfs_i(struct inode *inode)
1029 return container_of(inode, struct ntfs_inode, vfs_inode);
1032 static inline bool is_compressed(const struct ntfs_inode *ni)
1034 return (ni->std_fa & FILE_ATTRIBUTE_COMPRESSED) ||
1035 (ni->ni_flags & NI_FLAG_COMPRESSED_MASK);
1038 static inline int ni_ext_compress_bits(const struct ntfs_inode *ni)
1040 return 0xb + (ni->ni_flags & NI_FLAG_COMPRESSED_MASK);
1043 /* Bits - 0xc, 0xd, 0xe, 0xf, 0x10 */
1044 static inline void ni_set_ext_compress_bits(struct ntfs_inode *ni, u8 bits)
1046 ni->ni_flags |= (bits - 0xb) & NI_FLAG_COMPRESSED_MASK;
1049 static inline bool is_dedup(const struct ntfs_inode *ni)
1051 return ni->ni_flags & NI_FLAG_DEDUPLICATED;
1054 static inline bool is_encrypted(const struct ntfs_inode *ni)
1056 return ni->std_fa & FILE_ATTRIBUTE_ENCRYPTED;
1059 static inline bool is_sparsed(const struct ntfs_inode *ni)
1061 return ni->std_fa & FILE_ATTRIBUTE_SPARSE_FILE;
1064 static inline int is_resident(struct ntfs_inode *ni)
1066 return ni->ni_flags & NI_FLAG_RESIDENT;
1069 static inline void le16_sub_cpu(__le16 *var, u16 val)
1071 *var = cpu_to_le16(le16_to_cpu(*var) - val);
1074 static inline void le32_sub_cpu(__le32 *var, u32 val)
1076 *var = cpu_to_le32(le32_to_cpu(*var) - val);
1079 static inline void nb_put(struct ntfs_buffers *nb)
1081 u32 i, nbufs = nb->nbufs;
1086 for (i = 0; i < nbufs; i++)
1091 static inline void put_indx_node(struct indx_node *in)
1101 static inline void mi_clear(struct mft_inode *mi)
1108 static inline void ni_lock(struct ntfs_inode *ni)
1110 mutex_lock_nested(&ni->ni_lock, NTFS_INODE_MUTEX_NORMAL);
1113 static inline void ni_lock_dir(struct ntfs_inode *ni)
1115 mutex_lock_nested(&ni->ni_lock, NTFS_INODE_MUTEX_PARENT);
1118 static inline void ni_unlock(struct ntfs_inode *ni)
1120 mutex_unlock(&ni->ni_lock);
1123 static inline int ni_trylock(struct ntfs_inode *ni)
1125 return mutex_trylock(&ni->ni_lock);
1128 static inline int attr_load_runs_attr(struct ntfs_inode *ni,
1129 struct ATTRIB *attr,
1130 struct runs_tree *run, CLST vcn)
1132 return attr_load_runs_vcn(ni, attr->type, attr_name(attr),
1133 attr->name_len, run, vcn);
1136 static inline void le64_sub_cpu(__le64 *var, u64 val)
1138 *var = cpu_to_le64(le64_to_cpu(*var) - val);
1141 #endif /* _LINUX_NTFS3_NTFS_FS_H */