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