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