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