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>
15 #include <linux/highmem.h>
16 #include <linux/kernel.h>
18 #include <linux/mutex.h>
19 #include <linux/page-flags.h>
20 #include <linux/pagemap.h>
21 #include <linux/rbtree.h>
22 #include <linux/rwsem.h>
23 #include <linux/slab.h>
24 #include <linux/string.h>
25 #include <linux/time64.h>
26 #include <linux/types.h>
27 #include <linux/uidgid.h>
28 #include <asm/div64.h>
35 struct fiemap_extent_info
;
36 struct user_namespace
;
38 struct writeback_control
;
42 #define MINUS_ONE_T ((size_t)(-1))
43 /* Biggest MFT / smallest cluster */
44 #define MAXIMUM_BYTES_PER_MFT 4096
45 #define NTFS_BLOCKS_PER_MFT_RECORD (MAXIMUM_BYTES_PER_MFT / 512)
47 #define MAXIMUM_BYTES_PER_INDEX 4096
48 #define NTFS_BLOCKS_PER_INODE (MAXIMUM_BYTES_PER_INDEX / 512)
50 /* NTFS specific error code when fixup failed. */
51 #define E_NTFS_FIXUP 555
52 /* NTFS specific error code about resident->nonresident. */
53 #define E_NTFS_NONRESIDENT 556
54 /* NTFS specific error code about punch hole. */
55 #define E_NTFS_NOTALIGNED 557
59 #define NTFS_FLAGS_NODISCARD 0x00000001
60 /* Set when LogFile is replaying. */
61 #define NTFS_FLAGS_LOG_REPLAYING 0x00000008
62 /* Set when we changed first MFT's which copy must be updated in $MftMirr. */
63 #define NTFS_FLAGS_MFTMIRR 0x00001000
64 #define NTFS_FLAGS_NEED_REPLAY 0x04000000
69 * Data attribute is external compressed (LZX/Xpress)
70 * 1 - WOF_COMPRESSION_XPRESS4K
71 * 2 - WOF_COMPRESSION_XPRESS8K
72 * 3 - WOF_COMPRESSION_XPRESS16K
73 * 4 - WOF_COMPRESSION_LZX32K
75 #define NI_FLAG_COMPRESSED_MASK 0x0000000f
76 /* Data attribute is deduplicated. */
77 #define NI_FLAG_DEDUPLICATED 0x00000010
78 #define NI_FLAG_EA 0x00000020
79 #define NI_FLAG_DIR 0x00000040
80 #define NI_FLAG_RESIDENT 0x00000080
81 #define NI_FLAG_UPDATE_PARENT 0x00000100
84 struct ntfs_mount_options
{
86 struct nls_table
*nls
;
93 unsigned fmask
: 1; /* fmask was set. */
94 unsigned dmask
: 1; /*dmask was set. */
95 unsigned sys_immutable
: 1; /* Immutable system files. */
96 unsigned discard
: 1; /* Issue discard requests on deletions. */
97 unsigned sparse
: 1; /* Create sparse files. */
98 unsigned showmeta
: 1; /* Show meta files. */
99 unsigned nohidden
: 1; /* Do not show hidden files. */
100 unsigned force
: 1; /* RW mount dirty volume. */
101 unsigned noacsrules
: 1; /* Exclude acs rules. */
102 unsigned prealloc
: 1; /* Preallocate space when file is growing. */
105 /* Special value to unpack and deallocate. */
106 #define RUN_DEALLOCATE ((struct runs_tree *)(size_t)1)
108 /* TODO: Use rb tree instead of array. */
110 struct ntfs_run
*runs
;
111 size_t count
; /* Currently used size a ntfs_run storage. */
112 size_t allocated
; /* Currently allocated ntfs_run storage size. */
115 struct ntfs_buffers
{
116 /* Biggest MFT / smallest cluster = 4096 / 512 = 8 */
117 /* Biggest index / smallest cluster = 4096 / 512 = 8 */
118 struct buffer_head
*bh
[PAGE_SIZE
>> SECTOR_SHIFT
];
125 ALLOCATE_DEF
= 0, // Allocate all clusters.
126 ALLOCATE_MFT
= 1, // Allocate for MFT.
129 enum bitmap_mutex_classes
{
130 BITMAP_MUTEX_CLUSTERS
= 0,
131 BITMAP_MUTEX_MFT
= 1,
135 struct super_block
*sb
;
136 struct rw_semaphore rw_lock
;
138 struct runs_tree run
;
141 size_t total_zeroes
; // Total number of free bits.
142 u16
*free_bits
; // Free bits in each window.
144 u32 bits_last
; // Bits in last window.
146 struct rb_root start_tree
; // Extents, sorted by 'start'.
147 struct rb_root count_tree
; // Extents, sorted by 'count + start'.
148 size_t count
; // Extents count.
151 * -1 Tree is activated but not updated (too many fragments).
152 * 0 - Tree is not activated.
153 * 1 - Tree is activated and updated.
156 size_t extent_min
; // Minimal extent used while building.
157 size_t extent_max
; // Upper estimate of biggest free block.
159 /* Zone [bit, end) */
163 bool set_tail
; // Not necessary in driver.
167 typedef int (*NTFS_CMP_FUNC
)(const void *key1
, size_t len1
, const void *key2
,
168 size_t len2
, const void *param
);
170 enum index_mutex_classed
{
180 /* ntfs_index - Allocation unit inside directory. */
182 struct runs_tree bitmap_run
;
183 struct runs_tree alloc_run
;
184 /* read/write access to 'bitmap_run'/'alloc_run' while ntfs_readdir */
185 struct rw_semaphore run_lock
;
187 /*TODO: Remove 'cmp'. */
190 u8 index_bits
; // log2(root->index_block_size)
191 u8 idx2vbn_bits
; // log2(root->index_block_clst)
192 u8 vbn2vbo_bits
; // index_block_size < cluster? 9 : cluster_bits
193 u8 type
; // index_mutex_classed
196 /* Minimum MFT zone. */
197 #define NTFS_MIN_MFT_ZONE 100
199 /* Ntfs file system in-core superblock data. */
200 struct ntfs_sb_info
{
201 struct super_block
*sb
;
203 u32 discard_granularity
;
204 u64 discard_granularity_mask_inv
; // ~(discard_granularity_mask_inv-1)
206 u32 cluster_size
; // bytes per cluster
207 u32 cluster_mask
; // == cluster_size - 1
208 u64 cluster_mask_inv
; // ~(cluster_size - 1)
209 u32 block_mask
; // sb->s_blocksize - 1
210 u32 blocks_per_cluster
; // cluster_size / sb->s_blocksize
218 u64 maxbytes
; // Maximum size for normal files.
219 u64 maxbytes_sparse
; // Maximum size for sparse file.
221 u32 flags
; // See NTFS_FLAGS_XXX.
223 CLST zone_max
; // Maximum MFT zone length in clusters
224 CLST bad_clusters
; // The count of marked bad clusters.
226 u16 max_bytes_per_attr
; // Maximum attribute size in record.
227 u16 attr_size_tr
; // Attribute size threshold (320 bytes).
229 /* Records in $Extend. */
235 struct ATTR_DEF_ENTRY
*def_table
; // Attribute definition table.
239 struct MFT_REC
*new_rec
;
245 struct ntfs_inode
*ni
;
246 struct wnd_bitmap bitmap
; // $MFT::Bitmap
248 * MFT records [11-24) used to expand MFT itself.
249 * They always marked as used in $MFT::Bitmap
250 * 'reserved_bitmap' contains real bitmap of these records.
252 ulong reserved_bitmap
; // Bitmap of used records [11 - 24)
253 size_t next_free
; // The next record to allocate from
254 size_t used
; // MFT valid size in records.
255 u32 recs_mirr
; // Number of records in MFTMirr
257 u8 reserved_bitmap_inited
;
261 struct wnd_bitmap bitmap
; // $Bitmap::Data
266 u64 size
; // In bytes.
267 u64 blocks
; // In blocks.
269 struct ntfs_inode
*ni
;
270 __le16 flags
; // Cached current VOLUME_INFO::flags, VOLUME_FLAG_DIRTY.
274 bool real_dirty
; // Real fs state.
278 struct ntfs_index index_sii
;
279 struct ntfs_index index_sdh
;
280 struct ntfs_inode
*ni
;
284 __le32 def_security_id
;
288 struct ntfs_index index_r
;
289 struct ntfs_inode
*ni
;
294 struct ntfs_index index_o
;
295 struct ntfs_inode
*ni
;
299 struct mutex mtx_lznt
;
301 #ifdef CONFIG_NTFS3_LZX_XPRESS
302 struct mutex mtx_xpress
;
303 struct xpress_decompressor
*xpress
;
304 struct mutex mtx_lzx
;
305 struct lzx_decompressor
*lzx
;
309 struct ntfs_mount_options
*options
;
310 struct ratelimit_state msg_ratelimit
;
313 /* One MFT record(usually 1024 bytes), consists of attributes. */
316 struct ntfs_sb_info
*sbi
;
318 struct MFT_REC
*mrec
;
319 struct ntfs_buffers nb
;
325 /* Nested class for ntfs_inode::ni_lock. */
326 enum ntfs_inode_mutex_lock_class
{
327 NTFS_INODE_MUTEX_DIRTY
,
328 NTFS_INODE_MUTEX_SECURITY
,
329 NTFS_INODE_MUTEX_OBJID
,
330 NTFS_INODE_MUTEX_REPARSE
,
331 NTFS_INODE_MUTEX_NORMAL
,
332 NTFS_INODE_MUTEX_PARENT
,
338 * Ntfs inode - extends linux inode. consists of one or more MFT inodes.
341 struct mft_inode mi
; // base record
344 * Valid size: [0 - i_valid) - these range in file contains valid data.
345 * Range [i_valid - inode->i_size) - contains 0.
346 * Usually i_valid <= inode->i_size.
349 struct timespec64 i_crtime
;
351 struct mutex ni_lock
;
353 /* File attributes from std. */
354 enum FILE_ATTRIBUTE std_fa
;
355 __le32 std_security_id
;
359 * Not empty when primary MFT record (usually 1024 bytes) can't save all attributes
360 * e.g. file becomes too fragmented or contains a lot of names.
362 struct rb_root mi_tree
;
365 * This member is used in ntfs_readdir to ensure that all subrecords are loaded
370 struct ntfs_index dir
;
372 struct rw_semaphore run_lock
;
373 struct runs_tree run
;
374 #ifdef CONFIG_NTFS3_LZX_XPRESS
375 struct page
*offs_page
;
381 struct runs_tree run
;
382 struct ATTR_LIST_ENTRY
*le
; // 1K aligned memory.
387 size_t ni_flags
; // NI_FLAG_XXX
389 struct inode vfs_inode
;
393 struct ntfs_buffers nb
;
394 struct INDEX_BUFFER
*index
;
399 struct indx_node
*nodes
[20];
400 struct NTFS_DE
*de
[20];
401 struct NTFS_DE
*root_de
;
406 REPARSE_COMPRESSED
= 1,
407 REPARSE_DEDUPLICATED
= 2,
411 /* Functions from attrib.c */
412 int attr_allocate_clusters(struct ntfs_sb_info
*sbi
, struct runs_tree
*run
,
413 CLST vcn
, CLST lcn
, CLST len
, CLST
*pre_alloc
,
414 enum ALLOCATE_OPT opt
, CLST
*alen
, const size_t fr
,
416 int attr_make_nonresident(struct ntfs_inode
*ni
, struct ATTRIB
*attr
,
417 struct ATTR_LIST_ENTRY
*le
, struct mft_inode
*mi
,
418 u64 new_size
, struct runs_tree
*run
,
419 struct ATTRIB
**ins_attr
, struct page
*page
);
420 int attr_set_size(struct ntfs_inode
*ni
, enum ATTR_TYPE type
,
421 const __le16
*name
, u8 name_len
, struct runs_tree
*run
,
422 u64 new_size
, const u64
*new_valid
, bool keep_prealloc
,
423 struct ATTRIB
**ret
);
424 int attr_data_get_block(struct ntfs_inode
*ni
, CLST vcn
, CLST clen
, CLST
*lcn
,
425 CLST
*len
, bool *new);
426 int attr_data_read_resident(struct ntfs_inode
*ni
, struct page
*page
);
427 int attr_data_write_resident(struct ntfs_inode
*ni
, struct page
*page
);
428 int attr_load_runs_vcn(struct ntfs_inode
*ni
, enum ATTR_TYPE type
,
429 const __le16
*name
, u8 name_len
, struct runs_tree
*run
,
431 int attr_load_runs_range(struct ntfs_inode
*ni
, enum ATTR_TYPE type
,
432 const __le16
*name
, u8 name_len
, struct runs_tree
*run
,
434 int attr_wof_frame_info(struct ntfs_inode
*ni
, struct ATTRIB
*attr
,
435 struct runs_tree
*run
, u64 frame
, u64 frames
,
436 u8 frame_bits
, u32
*ondisk_size
, u64
*vbo_data
);
437 int attr_is_frame_compressed(struct ntfs_inode
*ni
, struct ATTRIB
*attr
,
438 CLST frame
, CLST
*clst_data
);
439 int attr_allocate_frame(struct ntfs_inode
*ni
, CLST frame
, size_t compr_size
,
441 int attr_collapse_range(struct ntfs_inode
*ni
, u64 vbo
, u64 bytes
);
442 int attr_insert_range(struct ntfs_inode
*ni
, u64 vbo
, u64 bytes
);
443 int attr_punch_hole(struct ntfs_inode
*ni
, u64 vbo
, u64 bytes
, u32
*frame_size
);
445 /* Functions from attrlist.c */
446 void al_destroy(struct ntfs_inode
*ni
);
447 bool al_verify(struct ntfs_inode
*ni
);
448 int ntfs_load_attr_list(struct ntfs_inode
*ni
, struct ATTRIB
*attr
);
449 struct ATTR_LIST_ENTRY
*al_enumerate(struct ntfs_inode
*ni
,
450 struct ATTR_LIST_ENTRY
*le
);
451 struct ATTR_LIST_ENTRY
*al_find_le(struct ntfs_inode
*ni
,
452 struct ATTR_LIST_ENTRY
*le
,
453 const struct ATTRIB
*attr
);
454 struct ATTR_LIST_ENTRY
*al_find_ex(struct ntfs_inode
*ni
,
455 struct ATTR_LIST_ENTRY
*le
,
456 enum ATTR_TYPE type
, const __le16
*name
,
457 u8 name_len
, const CLST
*vcn
);
458 int al_add_le(struct ntfs_inode
*ni
, enum ATTR_TYPE type
, const __le16
*name
,
459 u8 name_len
, CLST svcn
, __le16 id
, const struct MFT_REF
*ref
,
460 struct ATTR_LIST_ENTRY
**new_le
);
461 bool al_remove_le(struct ntfs_inode
*ni
, struct ATTR_LIST_ENTRY
*le
);
462 bool al_delete_le(struct ntfs_inode
*ni
, enum ATTR_TYPE type
, CLST vcn
,
463 const __le16
*name
, size_t name_len
,
464 const struct MFT_REF
*ref
);
465 int al_update(struct ntfs_inode
*ni
, int sync
);
466 static inline size_t al_aligned(size_t size
)
468 return (size
+ 1023) & ~(size_t)1023;
471 /* Globals from bitfunc.c */
472 bool are_bits_clear(const ulong
*map
, size_t bit
, size_t nbits
);
473 bool are_bits_set(const ulong
*map
, size_t bit
, size_t nbits
);
474 size_t get_set_bits_ex(const ulong
*map
, size_t bit
, size_t nbits
);
476 /* Globals from dir.c */
477 int ntfs_utf16_to_nls(struct ntfs_sb_info
*sbi
, const __le16
*name
, u32 len
,
478 u8
*buf
, int buf_len
);
479 int ntfs_nls_to_utf16(struct ntfs_sb_info
*sbi
, const u8
*name
, u32 name_len
,
480 struct cpu_str
*uni
, u32 max_ulen
,
481 enum utf16_endian endian
);
482 struct inode
*dir_search_u(struct inode
*dir
, const struct cpu_str
*uni
,
483 struct ntfs_fnd
*fnd
);
484 bool dir_is_empty(struct inode
*dir
);
485 extern const struct file_operations ntfs_dir_operations
;
487 /* Globals from file.c */
488 int ntfs_getattr(struct user_namespace
*mnt_userns
, const struct path
*path
,
489 struct kstat
*stat
, u32 request_mask
, u32 flags
);
490 void ntfs_sparse_cluster(struct inode
*inode
, struct page
*page0
, CLST vcn
,
492 int ntfs3_setattr(struct user_namespace
*mnt_userns
, struct dentry
*dentry
,
494 int ntfs_file_open(struct inode
*inode
, struct file
*file
);
495 int ntfs_fiemap(struct inode
*inode
, struct fiemap_extent_info
*fieinfo
,
496 __u64 start
, __u64 len
);
497 extern const struct inode_operations ntfs_special_inode_operations
;
498 extern const struct inode_operations ntfs_file_inode_operations
;
499 extern const struct file_operations ntfs_file_operations
;
501 /* Globals from frecord.c */
502 void ni_remove_mi(struct ntfs_inode
*ni
, struct mft_inode
*mi
);
503 struct ATTR_STD_INFO
*ni_std(struct ntfs_inode
*ni
);
504 struct ATTR_STD_INFO5
*ni_std5(struct ntfs_inode
*ni
);
505 void ni_clear(struct ntfs_inode
*ni
);
506 int ni_load_mi_ex(struct ntfs_inode
*ni
, CLST rno
, struct mft_inode
**mi
);
507 int ni_load_mi(struct ntfs_inode
*ni
, const struct ATTR_LIST_ENTRY
*le
,
508 struct mft_inode
**mi
);
509 struct ATTRIB
*ni_find_attr(struct ntfs_inode
*ni
, struct ATTRIB
*attr
,
510 struct ATTR_LIST_ENTRY
**entry_o
,
511 enum ATTR_TYPE type
, const __le16
*name
,
512 u8 name_len
, const CLST
*vcn
,
513 struct mft_inode
**mi
);
514 struct ATTRIB
*ni_enum_attr_ex(struct ntfs_inode
*ni
, struct ATTRIB
*attr
,
515 struct ATTR_LIST_ENTRY
**le
,
516 struct mft_inode
**mi
);
517 struct ATTRIB
*ni_load_attr(struct ntfs_inode
*ni
, enum ATTR_TYPE type
,
518 const __le16
*name
, u8 name_len
, CLST vcn
,
519 struct mft_inode
**pmi
);
520 int ni_load_all_mi(struct ntfs_inode
*ni
);
521 bool ni_add_subrecord(struct ntfs_inode
*ni
, CLST rno
, struct mft_inode
**mi
);
522 int ni_remove_attr(struct ntfs_inode
*ni
, enum ATTR_TYPE type
,
523 const __le16
*name
, size_t name_len
, bool base_only
,
525 int ni_create_attr_list(struct ntfs_inode
*ni
);
526 int ni_expand_list(struct ntfs_inode
*ni
);
527 int ni_insert_nonresident(struct ntfs_inode
*ni
, enum ATTR_TYPE type
,
528 const __le16
*name
, u8 name_len
,
529 const struct runs_tree
*run
, CLST svcn
, CLST len
,
530 __le16 flags
, struct ATTRIB
**new_attr
,
531 struct mft_inode
**mi
, struct ATTR_LIST_ENTRY
**le
);
532 int ni_insert_resident(struct ntfs_inode
*ni
, u32 data_size
,
533 enum ATTR_TYPE type
, const __le16
*name
, u8 name_len
,
534 struct ATTRIB
**new_attr
, struct mft_inode
**mi
,
535 struct ATTR_LIST_ENTRY
**le
);
536 void ni_remove_attr_le(struct ntfs_inode
*ni
, struct ATTRIB
*attr
,
537 struct mft_inode
*mi
, struct ATTR_LIST_ENTRY
*le
);
538 int ni_delete_all(struct ntfs_inode
*ni
);
539 struct ATTR_FILE_NAME
*ni_fname_name(struct ntfs_inode
*ni
,
540 const struct cpu_str
*uni
,
541 const struct MFT_REF
*home
,
542 struct mft_inode
**mi
,
543 struct ATTR_LIST_ENTRY
**entry
);
544 struct ATTR_FILE_NAME
*ni_fname_type(struct ntfs_inode
*ni
, u8 name_type
,
545 struct mft_inode
**mi
,
546 struct ATTR_LIST_ENTRY
**entry
);
547 int ni_new_attr_flags(struct ntfs_inode
*ni
, enum FILE_ATTRIBUTE new_fa
);
548 enum REPARSE_SIGN
ni_parse_reparse(struct ntfs_inode
*ni
, struct ATTRIB
*attr
,
549 struct REPARSE_DATA_BUFFER
*buffer
);
550 int ni_write_inode(struct inode
*inode
, int sync
, const char *hint
);
551 #define _ni_write_inode(i, w) ni_write_inode(i, w, __func__)
552 int ni_fiemap(struct ntfs_inode
*ni
, struct fiemap_extent_info
*fieinfo
,
553 __u64 vbo
, __u64 len
);
554 int ni_readpage_cmpr(struct ntfs_inode
*ni
, struct page
*page
);
555 int ni_decompress_file(struct ntfs_inode
*ni
);
556 int ni_read_frame(struct ntfs_inode
*ni
, u64 frame_vbo
, struct page
**pages
,
557 u32 pages_per_frame
);
558 int ni_write_frame(struct ntfs_inode
*ni
, struct page
**pages
,
559 u32 pages_per_frame
);
560 int ni_remove_name(struct ntfs_inode
*dir_ni
, struct ntfs_inode
*ni
,
561 struct NTFS_DE
*de
, struct NTFS_DE
**de2
, int *undo_step
);
563 bool ni_remove_name_undo(struct ntfs_inode
*dir_ni
, struct ntfs_inode
*ni
,
564 struct NTFS_DE
*de
, struct NTFS_DE
*de2
,
567 int ni_add_name(struct ntfs_inode
*dir_ni
, struct ntfs_inode
*ni
,
570 int ni_rename(struct ntfs_inode
*dir_ni
, struct ntfs_inode
*new_dir_ni
,
571 struct ntfs_inode
*ni
, struct NTFS_DE
*de
, struct NTFS_DE
*new_de
,
574 bool ni_is_dirty(struct inode
*inode
);
576 /* Globals from fslog.c */
577 int log_replay(struct ntfs_inode
*ni
, bool *initialized
);
579 /* Globals from fsntfs.c */
580 bool ntfs_fix_pre_write(struct NTFS_RECORD_HEADER
*rhdr
, size_t bytes
);
581 int ntfs_fix_post_read(struct NTFS_RECORD_HEADER
*rhdr
, size_t bytes
,
583 int ntfs_extend_init(struct ntfs_sb_info
*sbi
);
584 int ntfs_loadlog_and_replay(struct ntfs_inode
*ni
, struct ntfs_sb_info
*sbi
);
585 const struct ATTR_DEF_ENTRY
*ntfs_query_def(struct ntfs_sb_info
*sbi
,
586 enum ATTR_TYPE Type
);
587 int ntfs_look_for_free_space(struct ntfs_sb_info
*sbi
, CLST lcn
, CLST len
,
588 CLST
*new_lcn
, CLST
*new_len
,
589 enum ALLOCATE_OPT opt
);
590 int ntfs_look_free_mft(struct ntfs_sb_info
*sbi
, CLST
*rno
, bool mft
,
591 struct ntfs_inode
*ni
, struct mft_inode
**mi
);
592 void ntfs_mark_rec_free(struct ntfs_sb_info
*sbi
, CLST rno
, bool is_mft
);
593 int ntfs_clear_mft_tail(struct ntfs_sb_info
*sbi
, size_t from
, size_t to
);
594 int ntfs_refresh_zone(struct ntfs_sb_info
*sbi
);
595 void ntfs_update_mftmirr(struct ntfs_sb_info
*sbi
, int wait
);
596 void ntfs_bad_inode(struct inode
*inode
, const char *hint
);
597 #define _ntfs_bad_inode(i) ntfs_bad_inode(i, __func__)
598 enum NTFS_DIRTY_FLAGS
{
599 NTFS_DIRTY_CLEAR
= 0,
600 NTFS_DIRTY_DIRTY
= 1,
601 NTFS_DIRTY_ERROR
= 2,
603 int ntfs_set_state(struct ntfs_sb_info
*sbi
, enum NTFS_DIRTY_FLAGS dirty
);
604 int ntfs_sb_read(struct super_block
*sb
, u64 lbo
, size_t bytes
, void *buffer
);
605 int ntfs_sb_write(struct super_block
*sb
, u64 lbo
, size_t bytes
,
606 const void *buffer
, int wait
);
607 int ntfs_sb_write_run(struct ntfs_sb_info
*sbi
, const struct runs_tree
*run
,
608 u64 vbo
, const void *buf
, size_t bytes
, int sync
);
609 struct buffer_head
*ntfs_bread_run(struct ntfs_sb_info
*sbi
,
610 const struct runs_tree
*run
, u64 vbo
);
611 int ntfs_read_run_nb(struct ntfs_sb_info
*sbi
, const struct runs_tree
*run
,
612 u64 vbo
, void *buf
, u32 bytes
, struct ntfs_buffers
*nb
);
613 int ntfs_read_bh(struct ntfs_sb_info
*sbi
, const struct runs_tree
*run
, u64 vbo
,
614 struct NTFS_RECORD_HEADER
*rhdr
, u32 bytes
,
615 struct ntfs_buffers
*nb
);
616 int ntfs_get_bh(struct ntfs_sb_info
*sbi
, const struct runs_tree
*run
, u64 vbo
,
617 u32 bytes
, struct ntfs_buffers
*nb
);
618 int ntfs_write_bh(struct ntfs_sb_info
*sbi
, struct NTFS_RECORD_HEADER
*rhdr
,
619 struct ntfs_buffers
*nb
, int sync
);
620 int ntfs_bio_pages(struct ntfs_sb_info
*sbi
, const struct runs_tree
*run
,
621 struct page
**pages
, u32 nr_pages
, u64 vbo
, u32 bytes
,
623 int ntfs_bio_fill_1(struct ntfs_sb_info
*sbi
, const struct runs_tree
*run
);
624 int ntfs_vbo_to_lbo(struct ntfs_sb_info
*sbi
, const struct runs_tree
*run
,
625 u64 vbo
, u64
*lbo
, u64
*bytes
);
626 struct ntfs_inode
*ntfs_new_inode(struct ntfs_sb_info
*sbi
, CLST nRec
,
628 extern const u8 s_default_security
[0x50];
629 bool is_sd_valid(const struct SECURITY_DESCRIPTOR_RELATIVE
*sd
, u32 len
);
630 int ntfs_security_init(struct ntfs_sb_info
*sbi
);
631 int ntfs_get_security_by_id(struct ntfs_sb_info
*sbi
, __le32 security_id
,
632 struct SECURITY_DESCRIPTOR_RELATIVE
**sd
,
634 int ntfs_insert_security(struct ntfs_sb_info
*sbi
,
635 const struct SECURITY_DESCRIPTOR_RELATIVE
*sd
,
636 u32 size
, __le32
*security_id
, bool *inserted
);
637 int ntfs_reparse_init(struct ntfs_sb_info
*sbi
);
638 int ntfs_objid_init(struct ntfs_sb_info
*sbi
);
639 int ntfs_objid_remove(struct ntfs_sb_info
*sbi
, struct GUID
*guid
);
640 int ntfs_insert_reparse(struct ntfs_sb_info
*sbi
, __le32 rtag
,
641 const struct MFT_REF
*ref
);
642 int ntfs_remove_reparse(struct ntfs_sb_info
*sbi
, __le32 rtag
,
643 const struct MFT_REF
*ref
);
644 void mark_as_free_ex(struct ntfs_sb_info
*sbi
, CLST lcn
, CLST len
, bool trim
);
645 int run_deallocate(struct ntfs_sb_info
*sbi
, struct runs_tree
*run
, bool trim
);
647 /* Globals from index.c */
648 int indx_used_bit(struct ntfs_index
*indx
, struct ntfs_inode
*ni
, size_t *bit
);
649 void fnd_clear(struct ntfs_fnd
*fnd
);
650 static inline struct ntfs_fnd
*fnd_get(void)
652 return kzalloc(sizeof(struct ntfs_fnd
), GFP_NOFS
);
654 static inline void fnd_put(struct ntfs_fnd
*fnd
)
661 void indx_clear(struct ntfs_index
*idx
);
662 int indx_init(struct ntfs_index
*indx
, struct ntfs_sb_info
*sbi
,
663 const struct ATTRIB
*attr
, enum index_mutex_classed type
);
664 struct INDEX_ROOT
*indx_get_root(struct ntfs_index
*indx
, struct ntfs_inode
*ni
,
665 struct ATTRIB
**attr
, struct mft_inode
**mi
);
666 int indx_read(struct ntfs_index
*idx
, struct ntfs_inode
*ni
, CLST vbn
,
667 struct indx_node
**node
);
668 int indx_find(struct ntfs_index
*indx
, struct ntfs_inode
*dir
,
669 const struct INDEX_ROOT
*root
, const void *Key
, size_t KeyLen
,
670 const void *param
, int *diff
, struct NTFS_DE
**entry
,
671 struct ntfs_fnd
*fnd
);
672 int indx_find_sort(struct ntfs_index
*indx
, struct ntfs_inode
*ni
,
673 const struct INDEX_ROOT
*root
, struct NTFS_DE
**entry
,
674 struct ntfs_fnd
*fnd
);
675 int indx_find_raw(struct ntfs_index
*indx
, struct ntfs_inode
*ni
,
676 const struct INDEX_ROOT
*root
, struct NTFS_DE
**entry
,
677 size_t *off
, struct ntfs_fnd
*fnd
);
678 int indx_insert_entry(struct ntfs_index
*indx
, struct ntfs_inode
*ni
,
679 const struct NTFS_DE
*new_de
, const void *param
,
680 struct ntfs_fnd
*fnd
, bool undo
);
681 int indx_delete_entry(struct ntfs_index
*indx
, struct ntfs_inode
*ni
,
682 const void *key
, u32 key_len
, const void *param
);
683 int indx_update_dup(struct ntfs_inode
*ni
, struct ntfs_sb_info
*sbi
,
684 const struct ATTR_FILE_NAME
*fname
,
685 const struct NTFS_DUP_INFO
*dup
, int sync
);
687 /* Globals from inode.c */
688 struct inode
*ntfs_iget5(struct super_block
*sb
, const struct MFT_REF
*ref
,
689 const struct cpu_str
*name
);
690 int ntfs_set_size(struct inode
*inode
, u64 new_size
);
691 int reset_log_file(struct inode
*inode
);
692 int ntfs_get_block(struct inode
*inode
, sector_t vbn
,
693 struct buffer_head
*bh_result
, int create
);
694 int ntfs_write_begin(struct file
*file
, struct address_space
*mapping
,
695 loff_t pos
, u32 len
, struct page
**pagep
, void **fsdata
);
696 int ntfs_write_end(struct file
*file
, struct address_space
*mapping
,
697 loff_t pos
, u32 len
, u32 copied
, struct page
*page
,
699 int ntfs3_write_inode(struct inode
*inode
, struct writeback_control
*wbc
);
700 int ntfs_sync_inode(struct inode
*inode
);
701 int ntfs_flush_inodes(struct super_block
*sb
, struct inode
*i1
,
703 int inode_write_data(struct inode
*inode
, const void *data
, size_t bytes
);
704 struct inode
*ntfs_create_inode(struct user_namespace
*mnt_userns
,
705 struct inode
*dir
, struct dentry
*dentry
,
706 const struct cpu_str
*uni
, umode_t mode
,
707 dev_t dev
, const char *symname
, u32 size
,
708 struct ntfs_fnd
*fnd
);
709 int ntfs_link_inode(struct inode
*inode
, struct dentry
*dentry
);
710 int ntfs_unlink_inode(struct inode
*dir
, const struct dentry
*dentry
);
711 void ntfs_evict_inode(struct inode
*inode
);
712 extern const struct inode_operations ntfs_link_inode_operations
;
713 extern const struct address_space_operations ntfs_aops
;
714 extern const struct address_space_operations ntfs_aops_cmpr
;
716 /* Globals from name_i.c */
717 int fill_name_de(struct ntfs_sb_info
*sbi
, void *buf
, const struct qstr
*name
,
718 const struct cpu_str
*uni
);
719 struct dentry
*ntfs3_get_parent(struct dentry
*child
);
721 extern const struct inode_operations ntfs_dir_inode_operations
;
722 extern const struct inode_operations ntfs_special_inode_operations
;
724 /* Globals from record.c */
725 int mi_get(struct ntfs_sb_info
*sbi
, CLST rno
, struct mft_inode
**mi
);
726 void mi_put(struct mft_inode
*mi
);
727 int mi_init(struct mft_inode
*mi
, struct ntfs_sb_info
*sbi
, CLST rno
);
728 int mi_read(struct mft_inode
*mi
, bool is_mft
);
729 struct ATTRIB
*mi_enum_attr(struct mft_inode
*mi
, struct ATTRIB
*attr
);
731 struct ATTRIB
*mi_find_attr(struct mft_inode
*mi
, struct ATTRIB
*attr
,
732 enum ATTR_TYPE type
, const __le16
*name
,
733 size_t name_len
, const __le16
*id
);
734 static inline struct ATTRIB
*rec_find_attr_le(struct mft_inode
*rec
,
735 struct ATTR_LIST_ENTRY
*le
)
737 return mi_find_attr(rec
, NULL
, le
->type
, le_name(le
), le
->name_len
,
740 int mi_write(struct mft_inode
*mi
, int wait
);
741 int mi_format_new(struct mft_inode
*mi
, struct ntfs_sb_info
*sbi
, CLST rno
,
742 __le16 flags
, bool is_mft
);
743 struct ATTRIB
*mi_insert_attr(struct mft_inode
*mi
, enum ATTR_TYPE type
,
744 const __le16
*name
, u8 name_len
, u32 asize
,
747 bool mi_remove_attr(struct ntfs_inode
*ni
, struct mft_inode
*mi
,
748 struct ATTRIB
*attr
);
749 bool mi_resize_attr(struct mft_inode
*mi
, struct ATTRIB
*attr
, int bytes
);
750 int mi_pack_runs(struct mft_inode
*mi
, struct ATTRIB
*attr
,
751 struct runs_tree
*run
, CLST len
);
752 static inline bool mi_is_ref(const struct mft_inode
*mi
,
753 const struct MFT_REF
*ref
)
755 if (le32_to_cpu(ref
->low
) != mi
->rno
)
757 if (ref
->seq
!= mi
->mrec
->seq
)
760 #ifdef CONFIG_NTFS3_64BIT_CLUSTER
761 return le16_to_cpu(ref
->high
) == (mi
->rno
>> 32);
767 static inline void mi_get_ref(const struct mft_inode
*mi
, struct MFT_REF
*ref
)
769 ref
->low
= cpu_to_le32(mi
->rno
);
770 #ifdef CONFIG_NTFS3_64BIT_CLUSTER
771 ref
->high
= cpu_to_le16(mi
->rno
>> 32);
775 ref
->seq
= mi
->mrec
->seq
;
778 /* Globals from run.c */
779 bool run_lookup_entry(const struct runs_tree
*run
, CLST vcn
, CLST
*lcn
,
780 CLST
*len
, size_t *index
);
781 void run_truncate(struct runs_tree
*run
, CLST vcn
);
782 void run_truncate_head(struct runs_tree
*run
, CLST vcn
);
783 void run_truncate_around(struct runs_tree
*run
, CLST vcn
);
784 bool run_add_entry(struct runs_tree
*run
, CLST vcn
, CLST lcn
, CLST len
,
786 bool run_collapse_range(struct runs_tree
*run
, CLST vcn
, CLST len
);
787 bool run_insert_range(struct runs_tree
*run
, CLST vcn
, CLST len
);
788 bool run_get_entry(const struct runs_tree
*run
, size_t index
, CLST
*vcn
,
789 CLST
*lcn
, CLST
*len
);
790 bool run_is_mapped_full(const struct runs_tree
*run
, CLST svcn
, CLST evcn
);
792 int run_pack(const struct runs_tree
*run
, CLST svcn
, CLST len
, u8
*run_buf
,
793 u32 run_buf_size
, CLST
*packed_vcns
);
794 int run_unpack(struct runs_tree
*run
, struct ntfs_sb_info
*sbi
, CLST ino
,
795 CLST svcn
, CLST evcn
, CLST vcn
, const u8
*run_buf
,
798 #ifdef NTFS3_CHECK_FREE_CLST
799 int run_unpack_ex(struct runs_tree
*run
, struct ntfs_sb_info
*sbi
, CLST ino
,
800 CLST svcn
, CLST evcn
, CLST vcn
, const u8
*run_buf
,
803 #define run_unpack_ex run_unpack
805 int run_get_highest_vcn(CLST vcn
, const u8
*run_buf
, u64
*highest_vcn
);
806 int run_clone(const struct runs_tree
*run
, struct runs_tree
*new_run
);
808 /* Globals from super.c */
809 void *ntfs_set_shared(void *ptr
, u32 bytes
);
810 void *ntfs_put_shared(void *ptr
);
811 void ntfs_unmap_meta(struct super_block
*sb
, CLST lcn
, CLST len
);
812 int ntfs_discard(struct ntfs_sb_info
*sbi
, CLST Lcn
, CLST Len
);
814 /* Globals from bitmap.c*/
815 int __init
ntfs3_init_bitmap(void);
816 void ntfs3_exit_bitmap(void);
817 void wnd_close(struct wnd_bitmap
*wnd
);
818 static inline size_t wnd_zeroes(const struct wnd_bitmap
*wnd
)
820 return wnd
->total_zeroes
;
822 int wnd_init(struct wnd_bitmap
*wnd
, struct super_block
*sb
, size_t nbits
);
823 int wnd_set_free(struct wnd_bitmap
*wnd
, size_t bit
, size_t bits
);
824 int wnd_set_used(struct wnd_bitmap
*wnd
, size_t bit
, size_t bits
);
825 bool wnd_is_free(struct wnd_bitmap
*wnd
, size_t bit
, size_t bits
);
826 bool wnd_is_used(struct wnd_bitmap
*wnd
, size_t bit
, size_t bits
);
828 /* Possible values for 'flags' 'wnd_find'. */
829 #define BITMAP_FIND_MARK_AS_USED 0x01
830 #define BITMAP_FIND_FULL 0x02
831 size_t wnd_find(struct wnd_bitmap
*wnd
, size_t to_alloc
, size_t hint
,
832 size_t flags
, size_t *allocated
);
833 int wnd_extend(struct wnd_bitmap
*wnd
, size_t new_bits
);
834 void wnd_zone_set(struct wnd_bitmap
*wnd
, size_t Lcn
, size_t Len
);
835 int ntfs_trim_fs(struct ntfs_sb_info
*sbi
, struct fstrim_range
*range
);
837 /* Globals from upcase.c */
838 int ntfs_cmp_names(const __le16
*s1
, size_t l1
, const __le16
*s2
, size_t l2
,
839 const u16
*upcase
, bool bothcase
);
840 int ntfs_cmp_names_cpu(const struct cpu_str
*uni1
, const struct le_str
*uni2
,
841 const u16
*upcase
, bool bothcase
);
843 /* globals from xattr.c */
844 #ifdef CONFIG_NTFS3_FS_POSIX_ACL
845 struct posix_acl
*ntfs_get_acl(struct inode
*inode
, int type
, bool rcu
);
846 int ntfs_set_acl(struct user_namespace
*mnt_userns
, struct inode
*inode
,
847 struct posix_acl
*acl
, int type
);
848 int ntfs_init_acl(struct user_namespace
*mnt_userns
, struct inode
*inode
,
851 #define ntfs_get_acl NULL
852 #define ntfs_set_acl NULL
855 int ntfs_acl_chmod(struct user_namespace
*mnt_userns
, struct inode
*inode
);
856 int ntfs_permission(struct user_namespace
*mnt_userns
, struct inode
*inode
,
858 ssize_t
ntfs_listxattr(struct dentry
*dentry
, char *buffer
, size_t size
);
859 extern const struct xattr_handler
*ntfs_xattr_handlers
[];
861 int ntfs_save_wsl_perm(struct inode
*inode
);
862 void ntfs_get_wsl_perm(struct inode
*inode
);
864 /* globals from lznt.c */
865 struct lznt
*get_lznt_ctx(int level
);
866 size_t compress_lznt(const void *uncompressed
, size_t uncompressed_size
,
867 void *compressed
, size_t compressed_size
,
869 ssize_t
decompress_lznt(const void *compressed
, size_t compressed_size
,
870 void *uncompressed
, size_t uncompressed_size
);
872 static inline bool is_ntfs3(struct ntfs_sb_info
*sbi
)
874 return sbi
->volume
.major_ver
>= 3;
877 /* (sb->s_flags & SB_ACTIVE) */
878 static inline bool is_mounted(struct ntfs_sb_info
*sbi
)
880 return !!sbi
->sb
->s_root
;
883 static inline bool ntfs_is_meta_file(struct ntfs_sb_info
*sbi
, CLST rno
)
885 return rno
< MFT_REC_FREE
|| rno
== sbi
->objid_no
||
886 rno
== sbi
->quota_no
|| rno
== sbi
->reparse_no
||
887 rno
== sbi
->usn_jrnl_no
;
890 static inline void ntfs_unmap_page(struct page
*page
)
896 static inline struct page
*ntfs_map_page(struct address_space
*mapping
,
899 struct page
*page
= read_mapping_page(mapping
, index
, NULL
);
906 static inline size_t wnd_zone_bit(const struct wnd_bitmap
*wnd
)
908 return wnd
->zone_bit
;
911 static inline size_t wnd_zone_len(const struct wnd_bitmap
*wnd
)
913 return wnd
->zone_end
- wnd
->zone_bit
;
916 static inline void run_init(struct runs_tree
*run
)
923 static inline struct runs_tree
*run_alloc(void)
925 return kzalloc(sizeof(struct runs_tree
), GFP_NOFS
);
928 static inline void run_close(struct runs_tree
*run
)
931 memset(run
, 0, sizeof(*run
));
934 static inline void run_free(struct runs_tree
*run
)
942 static inline bool run_is_empty(struct runs_tree
*run
)
947 /* NTFS uses quad aligned bitmaps. */
948 static inline size_t bitmap_size(size_t bits
)
950 return ALIGN((bits
+ 7) >> 3, 8);
953 #define _100ns2seconds 10000000
954 #define SecondsToStartOf1970 0x00000002B6109100
956 #define NTFS_TIME_GRAN 100
959 * kernel2nt - Converts in-memory kernel timestamp into nt time.
961 static inline __le64
kernel2nt(const struct timespec64
*ts
)
963 // 10^7 units of 100 nanoseconds one second
964 return cpu_to_le64(_100ns2seconds
*
965 (ts
->tv_sec
+ SecondsToStartOf1970
) +
966 ts
->tv_nsec
/ NTFS_TIME_GRAN
);
970 * nt2kernel - Converts on-disk nt time into kernel timestamp.
972 static inline void nt2kernel(const __le64 tm
, struct timespec64
*ts
)
974 u64 t
= le64_to_cpu(tm
) - _100ns2seconds
* SecondsToStartOf1970
;
976 // WARNING: do_div changes its first argument(!)
977 ts
->tv_nsec
= do_div(t
, _100ns2seconds
) * 100;
981 static inline struct ntfs_sb_info
*ntfs_sb(struct super_block
*sb
)
983 return sb
->s_fs_info
;
987 * ntfs_up_cluster - Align up on cluster boundary.
989 static inline u64
ntfs_up_cluster(const struct ntfs_sb_info
*sbi
, u64 size
)
991 return (size
+ sbi
->cluster_mask
) & sbi
->cluster_mask_inv
;
995 * ntfs_up_block - Align up on cluster boundary.
997 static inline u64
ntfs_up_block(const struct super_block
*sb
, u64 size
)
999 return (size
+ sb
->s_blocksize
- 1) & ~(u64
)(sb
->s_blocksize
- 1);
1002 static inline CLST
bytes_to_cluster(const struct ntfs_sb_info
*sbi
, u64 size
)
1004 return (size
+ sbi
->cluster_mask
) >> sbi
->cluster_bits
;
1007 static inline u64
bytes_to_block(const struct super_block
*sb
, u64 size
)
1009 return (size
+ sb
->s_blocksize
- 1) >> sb
->s_blocksize_bits
;
1012 static inline struct buffer_head
*ntfs_bread(struct super_block
*sb
,
1015 struct buffer_head
*bh
= sb_bread(sb
, block
);
1020 ntfs_err(sb
, "failed to read volume at offset 0x%llx",
1021 (u64
)block
<< sb
->s_blocksize_bits
);
1025 static inline struct ntfs_inode
*ntfs_i(struct inode
*inode
)
1027 return container_of(inode
, struct ntfs_inode
, vfs_inode
);
1030 static inline bool is_compressed(const struct ntfs_inode
*ni
)
1032 return (ni
->std_fa
& FILE_ATTRIBUTE_COMPRESSED
) ||
1033 (ni
->ni_flags
& NI_FLAG_COMPRESSED_MASK
);
1036 static inline int ni_ext_compress_bits(const struct ntfs_inode
*ni
)
1038 return 0xb + (ni
->ni_flags
& NI_FLAG_COMPRESSED_MASK
);
1041 /* Bits - 0xc, 0xd, 0xe, 0xf, 0x10 */
1042 static inline void ni_set_ext_compress_bits(struct ntfs_inode
*ni
, u8 bits
)
1044 ni
->ni_flags
|= (bits
- 0xb) & NI_FLAG_COMPRESSED_MASK
;
1047 static inline bool is_dedup(const struct ntfs_inode
*ni
)
1049 return ni
->ni_flags
& NI_FLAG_DEDUPLICATED
;
1052 static inline bool is_encrypted(const struct ntfs_inode
*ni
)
1054 return ni
->std_fa
& FILE_ATTRIBUTE_ENCRYPTED
;
1057 static inline bool is_sparsed(const struct ntfs_inode
*ni
)
1059 return ni
->std_fa
& FILE_ATTRIBUTE_SPARSE_FILE
;
1062 static inline int is_resident(struct ntfs_inode
*ni
)
1064 return ni
->ni_flags
& NI_FLAG_RESIDENT
;
1067 static inline void le16_sub_cpu(__le16
*var
, u16 val
)
1069 *var
= cpu_to_le16(le16_to_cpu(*var
) - val
);
1072 static inline void le32_sub_cpu(__le32
*var
, u32 val
)
1074 *var
= cpu_to_le32(le32_to_cpu(*var
) - val
);
1077 static inline void nb_put(struct ntfs_buffers
*nb
)
1079 u32 i
, nbufs
= nb
->nbufs
;
1084 for (i
= 0; i
< nbufs
; i
++)
1089 static inline void put_indx_node(struct indx_node
*in
)
1099 static inline void mi_clear(struct mft_inode
*mi
)
1106 static inline void ni_lock(struct ntfs_inode
*ni
)
1108 mutex_lock_nested(&ni
->ni_lock
, NTFS_INODE_MUTEX_NORMAL
);
1111 static inline void ni_lock_dir(struct ntfs_inode
*ni
)
1113 mutex_lock_nested(&ni
->ni_lock
, NTFS_INODE_MUTEX_PARENT
);
1116 static inline void ni_unlock(struct ntfs_inode
*ni
)
1118 mutex_unlock(&ni
->ni_lock
);
1121 static inline int ni_trylock(struct ntfs_inode
*ni
)
1123 return mutex_trylock(&ni
->ni_lock
);
1126 static inline int attr_load_runs_attr(struct ntfs_inode
*ni
,
1127 struct ATTRIB
*attr
,
1128 struct runs_tree
*run
, CLST vcn
)
1130 return attr_load_runs_vcn(ni
, attr
->type
, attr_name(attr
),
1131 attr
->name_len
, run
, vcn
);
1134 static inline void le64_sub_cpu(__le64
*var
, u64 val
)
1136 *var
= cpu_to_le64(le64_to_cpu(*var
) - val
);
1139 #endif /* _LINUX_NTFS3_NTFS_FS_H */