1 /* SPDX-License-Identifier: GPL-2.0 */
4 * Copyright (C) 2019-2021 Paragon Software GmbH, All rights reserved.
12 * - Check 4K mft record and 512 bytes cluster
16 * Activate this define to use binary search in indexes
18 #define NTFS3_INDEX_BINARY_SEARCH
21 * Check each run for marked clusters
23 #define NTFS3_CHECK_FREE_CLST
25 #define NTFS_NAME_LEN 255
28 * ntfs.sys used 500 maximum links
29 * on-disk struct allows up to 0xffff
31 #define NTFS_LINK_MAX 0x400
32 //#define NTFS_LINK_MAX 0xffff
35 * Activate to use 64 bit clusters instead of 32 bits in ntfs.sys
36 * Logical and virtual cluster number
37 * If needed, may be redefined to use 64 bit value
39 //#define CONFIG_NTFS3_64BIT_CLUSTER
41 #define NTFS_LZNT_MAX_CLUSTER 4096
42 #define NTFS_LZNT_CUNIT 4
43 #define NTFS_LZNT_CLUSTERS (1u<<NTFS_LZNT_CUNIT)
53 * this struct repeats layout of ATTR_FILE_NAME
55 * it used to store global constants NAME_MFT/NAME_MIRROR...
56 * most constant names are shorter than 10
70 static_assert(SECTOR_SHIFT
== 9);
72 #ifdef CONFIG_NTFS3_64BIT_CLUSTER
74 static_assert(sizeof(size_t) == 8);
79 #define SPARSE_LCN64 ((u64)-1)
80 #define SPARSE_LCN ((CLST)-1)
81 #define RESIDENT_LCN ((CLST)-2)
82 #define COMPRESSED_LCN ((CLST)-3)
84 #define COMPRESSION_UNIT 4
85 #define COMPRESS_MAX_CLUSTER 0x1000
86 #define MFT_INCREASE_CHUNK 1024
99 MFT_REC_SECURE
= 9, // NTFS 3.0
101 MFT_REC_EXTEND
= 11, // NTFS 3.0
102 MFT_REC_RESERVED
= 11,
108 ATTR_ZERO
= cpu_to_le32(0x00),
109 ATTR_STD
= cpu_to_le32(0x10),
110 ATTR_LIST
= cpu_to_le32(0x20),
111 ATTR_NAME
= cpu_to_le32(0x30),
112 // ATTR_VOLUME_VERSION on Nt4
113 ATTR_ID
= cpu_to_le32(0x40),
114 ATTR_SECURE
= cpu_to_le32(0x50),
115 ATTR_LABEL
= cpu_to_le32(0x60),
116 ATTR_VOL_INFO
= cpu_to_le32(0x70),
117 ATTR_DATA
= cpu_to_le32(0x80),
118 ATTR_ROOT
= cpu_to_le32(0x90),
119 ATTR_ALLOC
= cpu_to_le32(0xA0),
120 ATTR_BITMAP
= cpu_to_le32(0xB0),
121 // ATTR_SYMLINK on Nt4
122 ATTR_REPARSE
= cpu_to_le32(0xC0),
123 ATTR_EA_INFO
= cpu_to_le32(0xD0),
124 ATTR_EA
= cpu_to_le32(0xE0),
125 ATTR_PROPERTYSET
= cpu_to_le32(0xF0),
126 ATTR_LOGGED_UTILITY_STREAM
= cpu_to_le32(0x100),
127 ATTR_END
= cpu_to_le32(0xFFFFFFFF)
130 static_assert(sizeof(enum ATTR_TYPE
) == 4);
132 enum FILE_ATTRIBUTE
{
133 FILE_ATTRIBUTE_READONLY
= cpu_to_le32(0x00000001),
134 FILE_ATTRIBUTE_HIDDEN
= cpu_to_le32(0x00000002),
135 FILE_ATTRIBUTE_SYSTEM
= cpu_to_le32(0x00000004),
136 FILE_ATTRIBUTE_ARCHIVE
= cpu_to_le32(0x00000020),
137 FILE_ATTRIBUTE_DEVICE
= cpu_to_le32(0x00000040),
138 FILE_ATTRIBUTE_TEMPORARY
= cpu_to_le32(0x00000100),
139 FILE_ATTRIBUTE_SPARSE_FILE
= cpu_to_le32(0x00000200),
140 FILE_ATTRIBUTE_REPARSE_POINT
= cpu_to_le32(0x00000400),
141 FILE_ATTRIBUTE_COMPRESSED
= cpu_to_le32(0x00000800),
142 FILE_ATTRIBUTE_OFFLINE
= cpu_to_le32(0x00001000),
143 FILE_ATTRIBUTE_NOT_CONTENT_INDEXED
= cpu_to_le32(0x00002000),
144 FILE_ATTRIBUTE_ENCRYPTED
= cpu_to_le32(0x00004000),
145 FILE_ATTRIBUTE_VALID_FLAGS
= cpu_to_le32(0x00007fb7),
146 FILE_ATTRIBUTE_DIRECTORY
= cpu_to_le32(0x10000000),
149 static_assert(sizeof(enum FILE_ATTRIBUTE
) == 4);
151 extern const struct cpu_str NAME_MFT
;
152 extern const struct cpu_str NAME_MIRROR
;
153 extern const struct cpu_str NAME_LOGFILE
;
154 extern const struct cpu_str NAME_VOLUME
;
155 extern const struct cpu_str NAME_ATTRDEF
;
156 extern const struct cpu_str NAME_ROOT
;
157 extern const struct cpu_str NAME_BITMAP
;
158 extern const struct cpu_str NAME_BOOT
;
159 extern const struct cpu_str NAME_BADCLUS
;
160 extern const struct cpu_str NAME_QUOTA
;
161 extern const struct cpu_str NAME_SECURE
;
162 extern const struct cpu_str NAME_UPCASE
;
163 extern const struct cpu_str NAME_EXTEND
;
164 extern const struct cpu_str NAME_OBJID
;
165 extern const struct cpu_str NAME_REPARSE
;
166 extern const struct cpu_str NAME_USNJRNL
;
168 extern const __le16 I30_NAME
[4];
169 extern const __le16 SII_NAME
[4];
170 extern const __le16 SDH_NAME
[4];
171 extern const __le16 SO_NAME
[2];
172 extern const __le16 SQ_NAME
[2];
173 extern const __le16 SR_NAME
[2];
175 extern const __le16 BAD_NAME
[4];
176 extern const __le16 SDS_NAME
[4];
177 extern const __le16 WOF_NAME
[17]; /* WofCompressedData */
179 /* MFT record number structure */
181 __le32 low
; // The low part of the number
182 __le16 high
; // The high part of the number
183 __le16 seq
; // The sequence number of MFT record
186 static_assert(sizeof(__le64
) == sizeof(struct MFT_REF
));
188 static inline CLST
ino_get(const struct MFT_REF
*ref
)
190 #ifdef CONFIG_NTFS3_64BIT_CLUSTER
191 return le32_to_cpu(ref
->low
) | ((u64
)le16_to_cpu(ref
->high
) << 32);
193 return le32_to_cpu(ref
->low
);
198 u8 jump_code
[3]; // 0x00: Jump to boot code
199 u8 system_id
[8]; // 0x03: System ID, equals "NTFS "
201 // NOTE: this member is not aligned(!)
202 // bytes_per_sector[0] must be 0
203 // bytes_per_sector[1] must be multiplied by 256
204 u8 bytes_per_sector
[2]; // 0x0B: Bytes per sector
206 u8 sectors_per_clusters
;// 0x0D: Sectors per cluster
208 u8 media_type
; // 0x15: Media type (0xF8 - harddisk)
210 __le16 sct_per_track
; // 0x18: number of sectors per track
211 __le16 heads
; // 0x1A: number of heads per cylinder
212 __le32 hidden_sectors
; // 0x1C: number of 'hidden' sectors
214 u8 bios_drive_num
; // 0x24: BIOS drive number =0x80
216 u8 signature_ex
; // 0x26: Extended BOOT signature =0x80
218 __le64 sectors_per_volume
;// 0x28: size of volume in sectors
219 __le64 mft_clst
; // 0x30: first cluster of $MFT
220 __le64 mft2_clst
; // 0x38: first cluster of $MFTMirr
221 s8 record_size
; // 0x40: size of MFT record in clusters(sectors)
223 s8 index_size
; // 0x44: size of INDX record in clusters(sectors)
225 __le64 serial_num
; // 0x48: Volume serial number
226 __le32 check_sum
; // 0x50: Simple additive checksum of all
227 // of the u32's which precede the 'check_sum'
229 u8 boot_code
[0x200 - 0x50 - 2 - 4]; // 0x54:
230 u8 boot_magic
[2]; // 0x1FE: Boot signature =0x55 + 0xAA
233 static_assert(sizeof(struct NTFS_BOOT
) == 0x200);
235 enum NTFS_SIGNATURE
{
236 NTFS_FILE_SIGNATURE
= cpu_to_le32(0x454C4946), // 'FILE'
237 NTFS_INDX_SIGNATURE
= cpu_to_le32(0x58444E49), // 'INDX'
238 NTFS_CHKD_SIGNATURE
= cpu_to_le32(0x444B4843), // 'CHKD'
239 NTFS_RSTR_SIGNATURE
= cpu_to_le32(0x52545352), // 'RSTR'
240 NTFS_RCRD_SIGNATURE
= cpu_to_le32(0x44524352), // 'RCRD'
241 NTFS_BAAD_SIGNATURE
= cpu_to_le32(0x44414142), // 'BAAD'
242 NTFS_HOLE_SIGNATURE
= cpu_to_le32(0x454C4F48), // 'HOLE'
243 NTFS_FFFF_SIGNATURE
= cpu_to_le32(0xffffffff),
246 static_assert(sizeof(enum NTFS_SIGNATURE
) == 4);
248 /* MFT Record header structure */
249 struct NTFS_RECORD_HEADER
{
250 /* Record magic number, equals 'FILE'/'INDX'/'RSTR'/'RCRD' */
251 enum NTFS_SIGNATURE sign
; // 0x00:
252 __le16 fix_off
; // 0x04:
253 __le16 fix_num
; // 0x06:
254 __le64 lsn
; // 0x08: Log file sequence number
257 static_assert(sizeof(struct NTFS_RECORD_HEADER
) == 0x10);
259 static inline int is_baad(const struct NTFS_RECORD_HEADER
*hdr
)
261 return hdr
->sign
== NTFS_BAAD_SIGNATURE
;
264 /* Possible bits in struct MFT_REC.flags */
266 RECORD_FLAG_IN_USE
= cpu_to_le16(0x0001),
267 RECORD_FLAG_DIR
= cpu_to_le16(0x0002),
268 RECORD_FLAG_SYSTEM
= cpu_to_le16(0x0004),
269 RECORD_FLAG_UNKNOWN
= cpu_to_le16(0x0008),
272 /* MFT Record structure */
274 struct NTFS_RECORD_HEADER rhdr
; // 'FILE'
276 __le16 seq
; // 0x10: Sequence number for this record
277 __le16 hard_links
; // 0x12: The number of hard links to record
278 __le16 attr_off
; // 0x14: Offset to attributes
279 __le16 flags
; // 0x16: See RECORD_FLAG
280 __le32 used
; // 0x18: The size of used part
281 __le32 total
; // 0x1C: Total record size
283 struct MFT_REF parent_ref
; // 0x20: Parent MFT record
284 __le16 next_attr_id
; // 0x28: The next attribute Id
286 __le16 res
; // 0x2A: High part of mft record?
287 __le32 mft_record
; // 0x2C: Current mft record number
288 __le16 fixups
[]; // 0x30:
291 #define MFTRECORD_FIXUP_OFFSET_1 offsetof(struct MFT_REC, res)
292 #define MFTRECORD_FIXUP_OFFSET_3 offsetof(struct MFT_REC, fixups)
294 static_assert(MFTRECORD_FIXUP_OFFSET_1
== 0x2A);
295 static_assert(MFTRECORD_FIXUP_OFFSET_3
== 0x30);
297 static inline bool is_rec_base(const struct MFT_REC
*rec
)
299 const struct MFT_REF
*r
= &rec
->parent_ref
;
301 return !r
->low
&& !r
->high
&& !r
->seq
;
304 static inline bool is_mft_rec5(const struct MFT_REC
*rec
)
306 return le16_to_cpu(rec
->rhdr
.fix_off
) >=
307 offsetof(struct MFT_REC
, fixups
);
310 static inline bool is_rec_inuse(const struct MFT_REC
*rec
)
312 return rec
->flags
& RECORD_FLAG_IN_USE
;
315 static inline bool clear_rec_inuse(struct MFT_REC
*rec
)
317 return rec
->flags
&= ~RECORD_FLAG_IN_USE
;
320 /* Possible values of ATTR_RESIDENT.flags */
321 #define RESIDENT_FLAG_INDEXED 0x01
323 struct ATTR_RESIDENT
{
324 __le32 data_size
; // 0x10: The size of data
325 __le16 data_off
; // 0x14: Offset to data
326 u8 flags
; // 0x16: resident flags ( 1 - indexed )
328 }; // sizeof() = 0x18
330 struct ATTR_NONRESIDENT
{
331 __le64 svcn
; // 0x10: Starting VCN of this segment
332 __le64 evcn
; // 0x18: End VCN of this segment
333 __le16 run_off
; // 0x20: Offset to packed runs
334 // Unit of Compression size for this stream, expressed
335 // as a log of the cluster size.
337 // 0 means file is not compressed
338 // 1, 2, 3, and 4 are potentially legal values if the
339 // stream is compressed, however the implementation
340 // may only choose to use 4, or possibly 3. Note
341 // that 4 means cluster size time 16. If convenient
342 // the implementation may wish to accept a
343 // reasonable range of legal values here (1-5?),
344 // even if the implementation only generates
345 // a smaller set of values itself.
348 __le64 alloc_size
; // 0x28: The allocated size of attribute in bytes
349 // (multiple of cluster size)
350 __le64 data_size
; // 0x30: The size of attribute in bytes <= alloc_size
351 __le64 valid_size
; // 0x38: The size of valid part in bytes <= data_size
352 __le64 total_size
; // 0x40: The sum of the allocated clusters for a file
353 // (present only for the first segment (0 == vcn)
354 // of compressed attribute)
356 }; // sizeof()=0x40 or 0x48 (if compressed)
358 /* Possible values of ATTRIB.flags: */
359 #define ATTR_FLAG_COMPRESSED cpu_to_le16(0x0001)
360 #define ATTR_FLAG_COMPRESSED_MASK cpu_to_le16(0x00FF)
361 #define ATTR_FLAG_ENCRYPTED cpu_to_le16(0x4000)
362 #define ATTR_FLAG_SPARSED cpu_to_le16(0x8000)
365 enum ATTR_TYPE type
; // 0x00: The type of this attribute
366 __le32 size
; // 0x04: The size of this attribute
367 u8 non_res
; // 0x08: Is this attribute non-resident ?
368 u8 name_len
; // 0x09: This attribute name length
369 __le16 name_off
; // 0x0A: Offset to the attribute name
370 __le16 flags
; // 0x0C: See ATTR_FLAG_XXX
371 __le16 id
; // 0x0E: unique id (per record)
374 struct ATTR_RESIDENT res
; // 0x10
375 struct ATTR_NONRESIDENT nres
; // 0x10
379 /* Define attribute sizes */
380 #define SIZEOF_RESIDENT 0x18
381 #define SIZEOF_NONRESIDENT_EX 0x48
382 #define SIZEOF_NONRESIDENT 0x40
384 #define SIZEOF_RESIDENT_LE cpu_to_le16(0x18)
385 #define SIZEOF_NONRESIDENT_EX_LE cpu_to_le16(0x48)
386 #define SIZEOF_NONRESIDENT_LE cpu_to_le16(0x40)
388 static inline u64
attr_ondisk_size(const struct ATTRIB
*attr
)
390 return attr
->non_res
? ((attr
->flags
&
391 (ATTR_FLAG_COMPRESSED
| ATTR_FLAG_SPARSED
)) ?
392 le64_to_cpu(attr
->nres
.total_size
) :
393 le64_to_cpu(attr
->nres
.alloc_size
)) :
394 QuadAlign(le32_to_cpu(attr
->res
.data_size
));
397 static inline u64
attr_size(const struct ATTRIB
*attr
)
399 return attr
->non_res
? le64_to_cpu(attr
->nres
.data_size
) :
400 le32_to_cpu(attr
->res
.data_size
);
403 static inline bool is_attr_encrypted(const struct ATTRIB
*attr
)
405 return attr
->flags
& ATTR_FLAG_ENCRYPTED
;
408 static inline bool is_attr_sparsed(const struct ATTRIB
*attr
)
410 return attr
->flags
& ATTR_FLAG_SPARSED
;
413 static inline bool is_attr_compressed(const struct ATTRIB
*attr
)
415 return attr
->flags
& ATTR_FLAG_COMPRESSED
;
418 static inline bool is_attr_ext(const struct ATTRIB
*attr
)
420 return attr
->flags
& (ATTR_FLAG_SPARSED
| ATTR_FLAG_COMPRESSED
);
423 static inline bool is_attr_indexed(const struct ATTRIB
*attr
)
425 return !attr
->non_res
&& (attr
->res
.flags
& RESIDENT_FLAG_INDEXED
);
428 static inline __le16
const *attr_name(const struct ATTRIB
*attr
)
430 return Add2Ptr(attr
, le16_to_cpu(attr
->name_off
));
433 static inline u64
attr_svcn(const struct ATTRIB
*attr
)
435 return attr
->non_res
? le64_to_cpu(attr
->nres
.svcn
) : 0;
438 /* the size of resident attribute by its resident size */
439 #define BYTES_PER_RESIDENT(b) (0x18 + (b))
441 static_assert(sizeof(struct ATTRIB
) == 0x48);
442 static_assert(sizeof(((struct ATTRIB
*)NULL
)->res
) == 0x08);
443 static_assert(sizeof(((struct ATTRIB
*)NULL
)->nres
) == 0x38);
445 static inline void *resident_data_ex(const struct ATTRIB
*attr
, u32 datasize
)
453 asize
= le32_to_cpu(attr
->size
);
454 off
= le16_to_cpu(attr
->res
.data_off
);
456 if (asize
< datasize
+ off
)
459 rsize
= le32_to_cpu(attr
->res
.data_size
);
460 if (rsize
< datasize
)
463 return Add2Ptr(attr
, off
);
466 static inline void *resident_data(const struct ATTRIB
*attr
)
468 return Add2Ptr(attr
, le16_to_cpu(attr
->res
.data_off
));
471 static inline void *attr_run(const struct ATTRIB
*attr
)
473 return Add2Ptr(attr
, le16_to_cpu(attr
->nres
.run_off
));
476 /* Standard information attribute (0x10) */
477 struct ATTR_STD_INFO
{
478 __le64 cr_time
; // 0x00: File creation file
479 __le64 m_time
; // 0x08: File modification time
480 __le64 c_time
; // 0x10: Last time any attribute was modified
481 __le64 a_time
; // 0x18: File last access time
482 enum FILE_ATTRIBUTE fa
; // 0x20: Standard DOS attributes & more
483 __le32 max_ver_num
; // 0x24: Maximum Number of Versions
484 __le32 ver_num
; // 0x28: Version Number
485 __le32 class_id
; // 0x2C: Class Id from bidirectional Class Id index
488 static_assert(sizeof(struct ATTR_STD_INFO
) == 0x30);
490 #define SECURITY_ID_INVALID 0x00000000
491 #define SECURITY_ID_FIRST 0x00000100
493 struct ATTR_STD_INFO5
{
494 __le64 cr_time
; // 0x00: File creation file
495 __le64 m_time
; // 0x08: File modification time
496 __le64 c_time
; // 0x10: Last time any attribute was modified
497 __le64 a_time
; // 0x18: File last access time
498 enum FILE_ATTRIBUTE fa
; // 0x20: Standard DOS attributes & more
499 __le32 max_ver_num
; // 0x24: Maximum Number of Versions
500 __le32 ver_num
; // 0x28: Version Number
501 __le32 class_id
; // 0x2C: Class Id from bidirectional Class Id index
503 __le32 owner_id
; // 0x30: Owner Id of the user owning the file.
504 __le32 security_id
; // 0x34: The Security Id is a key in the $SII Index and $SDS
505 __le64 quota_charge
; // 0x38:
506 __le64 usn
; // 0x40: Last Update Sequence Number of the file. This is a direct
507 // index into the file $UsnJrnl. If zero, the USN Journal is
511 static_assert(sizeof(struct ATTR_STD_INFO5
) == 0x48);
513 /* attribute list entry structure (0x20) */
514 struct ATTR_LIST_ENTRY
{
515 enum ATTR_TYPE type
; // 0x00: The type of attribute
516 __le16 size
; // 0x04: The size of this record
517 u8 name_len
; // 0x06: The length of attribute name
518 u8 name_off
; // 0x07: The offset to attribute name
519 __le64 vcn
; // 0x08: Starting VCN of this attribute
520 struct MFT_REF ref
; // 0x10: MFT record number with attribute
521 __le16 id
; // 0x18: struct ATTRIB ID
522 __le16 name
[3]; // 0x1A: Just to align. To get real name can use bNameOffset
526 static_assert(sizeof(struct ATTR_LIST_ENTRY
) == 0x20);
528 static inline u32
le_size(u8 name_len
)
530 return QuadAlign(offsetof(struct ATTR_LIST_ENTRY
, name
) +
531 name_len
* sizeof(short));
534 /* returns 0 if 'attr' has the same type and name */
535 static inline int le_cmp(const struct ATTR_LIST_ENTRY
*le
,
536 const struct ATTRIB
*attr
)
538 return le
->type
!= attr
->type
|| le
->name_len
!= attr
->name_len
||
540 memcmp(Add2Ptr(le
, le
->name_off
),
541 Add2Ptr(attr
, le16_to_cpu(attr
->name_off
)),
542 le
->name_len
* sizeof(short)));
545 static inline __le16
const *le_name(const struct ATTR_LIST_ENTRY
*le
)
547 return Add2Ptr(le
, le
->name_off
);
550 /* File name types (the field type in struct ATTR_FILE_NAME ) */
551 #define FILE_NAME_POSIX 0
552 #define FILE_NAME_UNICODE 1
553 #define FILE_NAME_DOS 2
554 #define FILE_NAME_UNICODE_AND_DOS (FILE_NAME_DOS | FILE_NAME_UNICODE)
556 /* Filename attribute structure (0x30) */
557 struct NTFS_DUP_INFO
{
558 __le64 cr_time
; // 0x00: File creation file
559 __le64 m_time
; // 0x08: File modification time
560 __le64 c_time
; // 0x10: Last time any attribute was modified
561 __le64 a_time
; // 0x18: File last access time
562 __le64 alloc_size
; // 0x20: Data attribute allocated size, multiple of cluster size
563 __le64 data_size
; // 0x28: Data attribute size <= Dataalloc_size
564 enum FILE_ATTRIBUTE fa
; // 0x30: Standard DOS attributes & more
565 __le16 ea_size
; // 0x34: Packed EAs
566 __le16 reparse
; // 0x36: Used by Reparse
570 struct ATTR_FILE_NAME
{
571 struct MFT_REF home
; // 0x00: MFT record for directory
572 struct NTFS_DUP_INFO dup
;// 0x08
573 u8 name_len
; // 0x40: File name length in words
574 u8 type
; // 0x41: File name type
575 __le16 name
[]; // 0x42: File name
578 static_assert(sizeof(((struct ATTR_FILE_NAME
*)NULL
)->dup
) == 0x38);
579 static_assert(offsetof(struct ATTR_FILE_NAME
, name
) == 0x42);
580 #define SIZEOF_ATTRIBUTE_FILENAME 0x44
581 #define SIZEOF_ATTRIBUTE_FILENAME_MAX (0x42 + 255 * 2)
583 static inline struct ATTRIB
*attr_from_name(struct ATTR_FILE_NAME
*fname
)
585 return (struct ATTRIB
*)((char *)fname
- SIZEOF_RESIDENT
);
588 static inline u16
fname_full_size(const struct ATTR_FILE_NAME
*fname
)
590 // don't return struct_size(fname, name, fname->name_len);
591 return offsetof(struct ATTR_FILE_NAME
, name
) +
592 fname
->name_len
* sizeof(short);
595 static inline u8
paired_name(u8 type
)
597 if (type
== FILE_NAME_UNICODE
)
598 return FILE_NAME_DOS
;
599 if (type
== FILE_NAME_DOS
)
600 return FILE_NAME_UNICODE
;
601 return FILE_NAME_POSIX
;
604 /* Index entry defines ( the field flags in NtfsDirEntry ) */
605 #define NTFS_IE_HAS_SUBNODES cpu_to_le16(1)
606 #define NTFS_IE_LAST cpu_to_le16(2)
608 /* Directory entry structure */
611 struct MFT_REF ref
; // 0x00: MFT record number with this file
613 __le16 data_off
; // 0x00:
614 __le16 data_size
; // 0x02:
615 __le32 res
; // 0x04: must be 0
618 __le16 size
; // 0x08: The size of this entry
619 __le16 key_size
; // 0x0A: The size of File name length in bytes + 0x42
620 __le16 flags
; // 0x0C: Entry flags: NTFS_IE_XXX
623 // Here any indexed attribute can be placed
625 // struct ATTR_FILE_NAME AttrFileName;
628 // The last 8 bytes of this structure contains
629 // the VBN of subnode
631 // This field is presented only if (flags & NTFS_IE_HAS_SUBNODES)
635 static_assert(sizeof(struct NTFS_DE
) == 0x10);
637 static inline void de_set_vbn_le(struct NTFS_DE
*e
, __le64 vcn
)
639 __le64
*v
= Add2Ptr(e
, le16_to_cpu(e
->size
) - sizeof(__le64
));
644 static inline void de_set_vbn(struct NTFS_DE
*e
, CLST vcn
)
646 __le64
*v
= Add2Ptr(e
, le16_to_cpu(e
->size
) - sizeof(__le64
));
648 *v
= cpu_to_le64(vcn
);
651 static inline __le64
de_get_vbn_le(const struct NTFS_DE
*e
)
653 return *(__le64
*)Add2Ptr(e
, le16_to_cpu(e
->size
) - sizeof(__le64
));
656 static inline CLST
de_get_vbn(const struct NTFS_DE
*e
)
658 __le64
*v
= Add2Ptr(e
, le16_to_cpu(e
->size
) - sizeof(__le64
));
660 return le64_to_cpu(*v
);
663 static inline struct NTFS_DE
*de_get_next(const struct NTFS_DE
*e
)
665 return Add2Ptr(e
, le16_to_cpu(e
->size
));
668 static inline struct ATTR_FILE_NAME
*de_get_fname(const struct NTFS_DE
*e
)
670 return le16_to_cpu(e
->key_size
) >= SIZEOF_ATTRIBUTE_FILENAME
?
671 Add2Ptr(e
, sizeof(struct NTFS_DE
)) :
675 static inline bool de_is_last(const struct NTFS_DE
*e
)
677 return e
->flags
& NTFS_IE_LAST
;
680 static inline bool de_has_vcn(const struct NTFS_DE
*e
)
682 return e
->flags
& NTFS_IE_HAS_SUBNODES
;
685 static inline bool de_has_vcn_ex(const struct NTFS_DE
*e
)
687 return (e
->flags
& NTFS_IE_HAS_SUBNODES
) &&
688 (u64
)(-1) != *((u64
*)Add2Ptr(e
, le16_to_cpu(e
->size
) -
692 #define MAX_BYTES_PER_NAME_ENTRY \
693 QuadAlign(sizeof(struct NTFS_DE) + \
694 offsetof(struct ATTR_FILE_NAME, name) + \
695 NTFS_NAME_LEN * sizeof(short))
698 __le32 de_off
; // 0x00: The offset from the start of this structure
699 // to the first NTFS_DE
700 __le32 used
; // 0x04: The size of this structure plus all
701 // entries (quad-word aligned)
702 __le32 total
; // 0x08: The allocated size of for this structure plus all entries
703 u8 flags
; // 0x0C: 0x00 = Small directory, 0x01 = Large directory
707 // de_off + used <= total
711 static_assert(sizeof(struct INDEX_HDR
) == 0x10);
713 static inline struct NTFS_DE
*hdr_first_de(const struct INDEX_HDR
*hdr
)
715 u32 de_off
= le32_to_cpu(hdr
->de_off
);
716 u32 used
= le32_to_cpu(hdr
->used
);
717 struct NTFS_DE
*e
= Add2Ptr(hdr
, de_off
);
720 if (de_off
>= used
|| de_off
>= le32_to_cpu(hdr
->total
))
723 esize
= le16_to_cpu(e
->size
);
724 if (esize
< sizeof(struct NTFS_DE
) || de_off
+ esize
> used
)
730 static inline struct NTFS_DE
*hdr_next_de(const struct INDEX_HDR
*hdr
,
731 const struct NTFS_DE
*e
)
733 size_t off
= PtrOffset(hdr
, e
);
734 u32 used
= le32_to_cpu(hdr
->used
);
740 esize
= le16_to_cpu(e
->size
);
742 if (esize
< sizeof(struct NTFS_DE
) ||
743 off
+ esize
+ sizeof(struct NTFS_DE
) > used
)
746 return Add2Ptr(e
, esize
);
749 static inline bool hdr_has_subnode(const struct INDEX_HDR
*hdr
)
751 return hdr
->flags
& 1;
754 struct INDEX_BUFFER
{
755 struct NTFS_RECORD_HEADER rhdr
; // 'INDX'
756 __le64 vbn
; // 0x10: vcn if index >= cluster or vsn id index < cluster
757 struct INDEX_HDR ihdr
; // 0x18:
760 static_assert(sizeof(struct INDEX_BUFFER
) == 0x28);
762 static inline bool ib_is_empty(const struct INDEX_BUFFER
*ib
)
764 const struct NTFS_DE
*first
= hdr_first_de(&ib
->ihdr
);
766 return !first
|| de_is_last(first
);
769 static inline bool ib_is_leaf(const struct INDEX_BUFFER
*ib
)
771 return !(ib
->ihdr
.flags
& 1);
774 /* Index root structure ( 0x90 ) */
775 enum COLLATION_RULE
{
776 NTFS_COLLATION_TYPE_BINARY
= cpu_to_le32(0),
778 NTFS_COLLATION_TYPE_FILENAME
= cpu_to_le32(0x01),
779 // $SII of $Secure and $Q of Quota
780 NTFS_COLLATION_TYPE_UINT
= cpu_to_le32(0x10),
782 NTFS_COLLATION_TYPE_SID
= cpu_to_le32(0x11),
784 NTFS_COLLATION_TYPE_SECURITY_HASH
= cpu_to_le32(0x12),
785 // $O of ObjId and "$R" for Reparse
786 NTFS_COLLATION_TYPE_UINTS
= cpu_to_le32(0x13)
789 static_assert(sizeof(enum COLLATION_RULE
) == 4);
793 enum ATTR_TYPE type
; // 0x00: The type of attribute to index on
794 enum COLLATION_RULE rule
; // 0x04: The rule
795 __le32 index_block_size
;// 0x08: The size of index record
796 u8 index_block_clst
; // 0x0C: The number of clusters or sectors per index
798 struct INDEX_HDR ihdr
; // 0x10:
801 static_assert(sizeof(struct INDEX_ROOT
) == 0x20);
802 static_assert(offsetof(struct INDEX_ROOT
, ihdr
) == 0x10);
804 #define VOLUME_FLAG_DIRTY cpu_to_le16(0x0001)
805 #define VOLUME_FLAG_RESIZE_LOG_FILE cpu_to_le16(0x0002)
809 u8 major_ver
; // 0x08: NTFS major version number (before .)
810 u8 minor_ver
; // 0x09: NTFS minor version number (after .)
811 __le16 flags
; // 0x0A: Volume flags, see VOLUME_FLAG_XXX
815 #define SIZEOF_ATTRIBUTE_VOLUME_INFO 0xc
817 #define NTFS_LABEL_MAX_LENGTH (0x100 / sizeof(short))
818 #define NTFS_ATTR_INDEXABLE cpu_to_le32(0x00000002)
819 #define NTFS_ATTR_DUPALLOWED cpu_to_le32(0x00000004)
820 #define NTFS_ATTR_MUST_BE_INDEXED cpu_to_le32(0x00000010)
821 #define NTFS_ATTR_MUST_BE_NAMED cpu_to_le32(0x00000020)
822 #define NTFS_ATTR_MUST_BE_RESIDENT cpu_to_le32(0x00000040)
823 #define NTFS_ATTR_LOG_ALWAYS cpu_to_le32(0x00000080)
825 /* $AttrDef file entry */
826 struct ATTR_DEF_ENTRY
{
827 __le16 name
[0x40]; // 0x00: Attr name
828 enum ATTR_TYPE type
; // 0x80: struct ATTRIB type
830 enum COLLATION_RULE rule
; // 0x88:
831 __le32 flags
; // 0x8C: NTFS_ATTR_XXX (see above)
832 __le64 min_sz
; // 0x90: Minimum attribute data size
833 __le64 max_sz
; // 0x98: Maximum attribute data size
836 static_assert(sizeof(struct ATTR_DEF_ENTRY
) == 0xa0);
838 /* Object ID (0x40) */
840 struct GUID ObjId
; // 0x00: Unique Id assigned to file
841 struct GUID BirthVolumeId
;// 0x10: Birth Volume Id is the Object Id of the Volume on
842 // which the Object Id was allocated. It never changes
843 struct GUID BirthObjectId
; // 0x20: Birth Object Id is the first Object Id that was
844 // ever assigned to this MFT Record. I.e. If the Object Id
845 // is changed for some reason, this field will reflect the
846 // original value of the Object Id.
847 struct GUID DomainId
; // 0x30: Domain Id is currently unused but it is intended to be
848 // used in a network environment where the local machine is
849 // part of a Windows 2000 Domain. This may be used in a Windows
850 // 2000 Advanced Server managed domain.
853 static_assert(sizeof(struct OBJECT_ID
) == 0x40);
855 /* O Directory entry structure ( rule = 0x13 ) */
858 struct GUID ObjId
; // 0x10: Unique Id assigned to file
859 struct MFT_REF ref
; // 0x20: MFT record number with this file
860 struct GUID BirthVolumeId
; // 0x28: Birth Volume Id is the Object Id of the Volume on
861 // which the Object Id was allocated. It never changes
862 struct GUID BirthObjectId
; // 0x38: Birth Object Id is the first Object Id that was
863 // ever assigned to this MFT Record. I.e. If the Object Id
864 // is changed for some reason, this field will reflect the
865 // original value of the Object Id.
866 // This field is valid if data_size == 0x48
867 struct GUID BirthDomainId
; // 0x48: Domain Id is currently unused but it is intended
868 // to be used in a network environment where the local
869 // machine is part of a Windows 2000 Domain. This may be
870 // used in a Windows 2000 Advanced Server managed domain.
873 static_assert(sizeof(struct NTFS_DE_O
) == 0x58);
875 #define NTFS_OBJECT_ENTRY_DATA_SIZE1 \
876 0x38 // struct NTFS_DE_O.BirthDomainId is not used
877 #define NTFS_OBJECT_ENTRY_DATA_SIZE2 \
878 0x48 // struct NTFS_DE_O.BirthDomainId is used
880 /* Q Directory entry structure ( rule = 0x11 ) */
883 __le32 owner_id
; // 0x10: Unique Id assigned to file
884 __le32 Version
; // 0x14: 0x02
885 __le32 flags2
; // 0x18: Quota flags, see above
886 __le64 BytesUsed
; // 0x1C:
887 __le64 ChangeTime
; // 0x24:
888 __le64 WarningLimit
; // 0x28:
889 __le64 HardLimit
; // 0x34:
890 __le64 ExceededTime
; // 0x3C:
892 // SID is placed here
893 }; // sizeof() = 0x44
895 #define SIZEOF_NTFS_DE_Q 0x44
897 #define SecurityDescriptorsBlockSize 0x40000 // 256K
898 #define SecurityDescriptorMaxSize 0x20000 // 128K
899 #define Log2OfSecurityDescriptorsBlockSize 18
901 struct SECURITY_KEY
{
902 __le32 hash
; // Hash value for descriptor
903 __le32 sec_id
; // Security Id (guaranteed unique)
906 /* Security descriptors (the content of $Secure::SDS data stream) */
907 struct SECURITY_HDR
{
908 struct SECURITY_KEY key
; // 0x00: Security Key
909 __le64 off
; // 0x08: Offset of this entry in the file
910 __le32 size
; // 0x10: Size of this entry, 8 byte aligned
912 // Security descriptor itself is placed here
913 // Total size is 16 byte aligned
917 #define SIZEOF_SECURITY_HDR 0x14
919 /* SII Directory entry structure */
922 __le32 sec_id
; // 0x10: Key: sizeof(security_id) = wKeySize
923 struct SECURITY_HDR sec_hdr
; // 0x14:
926 #define SIZEOF_SII_DIRENTRY 0x28
928 /* SDH Directory entry structure */
931 struct SECURITY_KEY key
; // 0x10: Key
932 struct SECURITY_HDR sec_hdr
; // 0x18: Data
933 __le16 magic
[2]; // 0x2C: 0x00490049 "I I"
936 #define SIZEOF_SDH_DIRENTRY 0x30
939 __le32 ReparseTag
; // 0x00: Reparse Tag
940 struct MFT_REF ref
; // 0x04: MFT record number with this file
941 }; // sizeof() = 0x0C
943 static_assert(offsetof(struct REPARSE_KEY
, ref
) == 0x04);
944 #define SIZEOF_REPARSE_KEY 0x0C
946 /* Reparse Directory entry structure */
949 struct REPARSE_KEY key
; // 0x10: Reparse Key
951 }; // sizeof() = 0x20
953 static_assert(sizeof(struct NTFS_DE_R
) == 0x20);
955 /* CompressReparseBuffer.WofVersion */
956 #define WOF_CURRENT_VERSION cpu_to_le32(1)
957 /* CompressReparseBuffer.WofProvider */
958 #define WOF_PROVIDER_WIM cpu_to_le32(1)
959 /* CompressReparseBuffer.WofProvider */
960 #define WOF_PROVIDER_SYSTEM cpu_to_le32(2)
961 /* CompressReparseBuffer.ProviderVer */
962 #define WOF_PROVIDER_CURRENT_VERSION cpu_to_le32(1)
964 #define WOF_COMPRESSION_XPRESS4K cpu_to_le32(0) // 4k
965 #define WOF_COMPRESSION_LZX32K cpu_to_le32(1) // 32k
966 #define WOF_COMPRESSION_XPRESS8K cpu_to_le32(2) // 8k
967 #define WOF_COMPRESSION_XPRESS16K cpu_to_le32(3) // 16k
970 * ATTR_REPARSE (0xC0)
972 * The reparse struct GUID structure is used by all 3rd party layered drivers to
973 * store data in a reparse point. For non-Microsoft tags, The struct GUID field
974 * cannot be GUID_NULL.
975 * The constraints on reparse tags are defined below.
976 * Microsoft tags can also be used with this format of the reparse point buffer.
978 struct REPARSE_POINT
{
979 __le32 ReparseTag
; // 0x00:
980 __le16 ReparseDataLength
;// 0x04:
983 struct GUID Guid
; // 0x08:
986 // Here GenericReparseBuffer is placed
990 static_assert(sizeof(struct REPARSE_POINT
) == 0x18);
993 // Maximum allowed size of the reparse data.
995 #define MAXIMUM_REPARSE_DATA_BUFFER_SIZE (16 * 1024)
998 // The value of the following constant needs to satisfy the following
1000 // (1) Be at least as large as the largest of the reserved tags.
1001 // (2) Be strictly smaller than all the tags in use.
1003 #define IO_REPARSE_TAG_RESERVED_RANGE 1
1006 // The reparse tags are a ULONG. The 32 bits are laid out as follows:
1008 // 3 3 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 1 1 1
1009 // 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 2 1 0
1010 // +-+-+-+-+-----------------------+-------------------------------+
1011 // |M|R|N|R| Reserved bits | Reparse Tag Value |
1012 // +-+-+-+-+-----------------------+-------------------------------+
1014 // M is the Microsoft bit. When set to 1, it denotes a tag owned by Microsoft.
1015 // All ISVs must use a tag with a 0 in this position.
1016 // Note: If a Microsoft tag is used by non-Microsoft software, the
1017 // behavior is not defined.
1019 // R is reserved. Must be zero for non-Microsoft tags.
1021 // N is name surrogate. When set to 1, the file represents another named
1022 // entity in the system.
1024 // The M and N bits are OR-able.
1025 // The following macros check for the M and N bit values:
1029 // Macro to determine whether a reparse point tag corresponds to a tag
1030 // owned by Microsoft.
1032 #define IsReparseTagMicrosoft(_tag) (((_tag)&IO_REPARSE_TAG_MICROSOFT))
1035 // Macro to determine whether a reparse point tag is a name surrogate
1037 #define IsReparseTagNameSurrogate(_tag) (((_tag)&IO_REPARSE_TAG_NAME_SURROGATE))
1040 // The following constant represents the bits that are valid to use in
1043 #define IO_REPARSE_TAG_VALID_VALUES 0xF000FFFF
1046 // Macro to determine whether a reparse tag is a valid tag.
1048 #define IsReparseTagValid(_tag) \
1049 (!((_tag) & ~IO_REPARSE_TAG_VALID_VALUES) && \
1050 ((_tag) > IO_REPARSE_TAG_RESERVED_RANGE))
1053 // Microsoft tags for reparse points.
1056 enum IO_REPARSE_TAG
{
1057 IO_REPARSE_TAG_SYMBOLIC_LINK
= cpu_to_le32(0),
1058 IO_REPARSE_TAG_NAME_SURROGATE
= cpu_to_le32(0x20000000),
1059 IO_REPARSE_TAG_MICROSOFT
= cpu_to_le32(0x80000000),
1060 IO_REPARSE_TAG_MOUNT_POINT
= cpu_to_le32(0xA0000003),
1061 IO_REPARSE_TAG_SYMLINK
= cpu_to_le32(0xA000000C),
1062 IO_REPARSE_TAG_HSM
= cpu_to_le32(0xC0000004),
1063 IO_REPARSE_TAG_SIS
= cpu_to_le32(0x80000007),
1064 IO_REPARSE_TAG_DEDUP
= cpu_to_le32(0x80000013),
1065 IO_REPARSE_TAG_COMPRESS
= cpu_to_le32(0x80000017),
1068 // The reparse tag 0x80000008 is reserved for Microsoft internal use
1069 // (may be published in the future)
1073 // Microsoft reparse tag reserved for DFS
1075 IO_REPARSE_TAG_DFS
= cpu_to_le32(0x8000000A),
1078 // Microsoft reparse tag reserved for the file system filter manager
1080 IO_REPARSE_TAG_FILTER_MANAGER
= cpu_to_le32(0x8000000B),
1083 // Non-Microsoft tags for reparse points
1087 // Tag allocated to CONGRUENT, May 2000. Used by IFSTEST
1089 IO_REPARSE_TAG_IFSTEST_CONGRUENT
= cpu_to_le32(0x00000009),
1092 // Tag allocated to ARKIVIO
1094 IO_REPARSE_TAG_ARKIVIO
= cpu_to_le32(0x0000000C),
1097 // Tag allocated to SOLUTIONSOFT
1099 IO_REPARSE_TAG_SOLUTIONSOFT
= cpu_to_le32(0x2000000D),
1102 // Tag allocated to COMMVAULT
1104 IO_REPARSE_TAG_COMMVAULT
= cpu_to_le32(0x0000000E),
1107 IO_REPARSE_TAG_CLOUD
= cpu_to_le32(0x9000001A),
1108 IO_REPARSE_TAG_CLOUD_1
= cpu_to_le32(0x9000101A),
1109 IO_REPARSE_TAG_CLOUD_2
= cpu_to_le32(0x9000201A),
1110 IO_REPARSE_TAG_CLOUD_3
= cpu_to_le32(0x9000301A),
1111 IO_REPARSE_TAG_CLOUD_4
= cpu_to_le32(0x9000401A),
1112 IO_REPARSE_TAG_CLOUD_5
= cpu_to_le32(0x9000501A),
1113 IO_REPARSE_TAG_CLOUD_6
= cpu_to_le32(0x9000601A),
1114 IO_REPARSE_TAG_CLOUD_7
= cpu_to_le32(0x9000701A),
1115 IO_REPARSE_TAG_CLOUD_8
= cpu_to_le32(0x9000801A),
1116 IO_REPARSE_TAG_CLOUD_9
= cpu_to_le32(0x9000901A),
1117 IO_REPARSE_TAG_CLOUD_A
= cpu_to_le32(0x9000A01A),
1118 IO_REPARSE_TAG_CLOUD_B
= cpu_to_le32(0x9000B01A),
1119 IO_REPARSE_TAG_CLOUD_C
= cpu_to_le32(0x9000C01A),
1120 IO_REPARSE_TAG_CLOUD_D
= cpu_to_le32(0x9000D01A),
1121 IO_REPARSE_TAG_CLOUD_E
= cpu_to_le32(0x9000E01A),
1122 IO_REPARSE_TAG_CLOUD_F
= cpu_to_le32(0x9000F01A),
1126 #define SYMLINK_FLAG_RELATIVE 1
1128 /* Microsoft reparse buffer. (see DDK for details) */
1129 struct REPARSE_DATA_BUFFER
{
1130 __le32 ReparseTag
; // 0x00:
1131 __le16 ReparseDataLength
; // 0x04:
1135 // If ReparseTag == 0xA0000003 (IO_REPARSE_TAG_MOUNT_POINT)
1137 __le16 SubstituteNameOffset
; // 0x08
1138 __le16 SubstituteNameLength
; // 0x0A
1139 __le16 PrintNameOffset
; // 0x0C
1140 __le16 PrintNameLength
; // 0x0E
1141 __le16 PathBuffer
[]; // 0x10
1142 } MountPointReparseBuffer
;
1144 // If ReparseTag == 0xA000000C (IO_REPARSE_TAG_SYMLINK)
1145 // https://msdn.microsoft.com/en-us/library/cc232006.aspx
1147 __le16 SubstituteNameOffset
; // 0x08
1148 __le16 SubstituteNameLength
; // 0x0A
1149 __le16 PrintNameOffset
; // 0x0C
1150 __le16 PrintNameLength
; // 0x0E
1151 // 0-absolute path 1- relative path, SYMLINK_FLAG_RELATIVE
1152 __le32 Flags
; // 0x10
1153 __le16 PathBuffer
[]; // 0x14
1154 } SymbolicLinkReparseBuffer
;
1156 // If ReparseTag == 0x80000017U
1158 __le32 WofVersion
; // 0x08 == 1
1159 /* 1 - WIM backing provider ("WIMBoot"),
1160 * 2 - System compressed file provider
1162 __le32 WofProvider
; // 0x0C
1163 __le32 ProviderVer
; // 0x10: == 1 WOF_FILE_PROVIDER_CURRENT_VERSION == 1
1164 __le32 CompressionFormat
; // 0x14: 0, 1, 2, 3. See WOF_COMPRESSION_XXX
1165 } CompressReparseBuffer
;
1168 u8 DataBuffer
[1]; // 0x08
1169 } GenericReparseBuffer
;
1173 /* ATTR_EA_INFO (0xD0) */
1175 #define FILE_NEED_EA 0x80 // See ntifs.h
1176 /* FILE_NEED_EA, indicates that the file to which the EA belongs cannot be
1177 * interpreted without understanding the associated extended attributes.
1180 __le16 size_pack
; // 0x00: Size of buffer to hold in packed form
1181 __le16 count
; // 0x02: Count of EA's with FILE_NEED_EA bit set
1182 __le32 size
; // 0x04: Size of buffer to hold in unpacked form
1185 static_assert(sizeof(struct EA_INFO
) == 8);
1187 /* ATTR_EA (0xE0) */
1189 __le32 size
; // 0x00: (not in packed)
1191 u8 name_len
; // 0x05
1192 __le16 elength
; // 0x06
1196 static_assert(offsetof(struct EA_FULL
, name
) == 8);
1198 #define ACL_REVISION 2
1199 #define ACL_REVISION_DS 4
1201 #define SE_SELF_RELATIVE cpu_to_le16(0x8000)
1203 struct SECURITY_DESCRIPTOR_RELATIVE
{
1212 static_assert(sizeof(struct SECURITY_DESCRIPTOR_RELATIVE
) == 0x14);
1219 static_assert(sizeof(struct ACE_HEADER
) == 4);
1228 static_assert(sizeof(struct ACL
) == 8);
1232 u8 SubAuthorityCount
;
1233 u8 IdentifierAuthority
[6];
1234 __le32 SubAuthority
[];
1236 static_assert(offsetof(struct SID
, SubAuthority
) == 8);