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