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