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