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