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