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