1 // SPDX-License-Identifier: GPL-2.0
4 * Copyright (C) 2019-2021 Paragon Software GmbH, All rights reserved.
14 static inline int compare_attr(const struct ATTRIB *left, enum ATTR_TYPE type,
15 const __le16 *name, u8 name_len,
18 /* First, compare the type codes. */
19 int diff = le32_to_cpu(left->type) - le32_to_cpu(type);
24 /* They have the same type code, so we have to compare the names. */
25 return ntfs_cmp_names(attr_name(left), left->name_len, name, name_len,
32 * Return: Unused attribute id that is less than mrec->next_attr_id.
34 static __le16 mi_new_attt_id(struct mft_inode *mi)
36 u16 free_id, max_id, t16;
37 struct MFT_REC *rec = mi->mrec;
41 id = rec->next_attr_id;
42 free_id = le16_to_cpu(id);
43 if (free_id < 0x7FFF) {
44 rec->next_attr_id = cpu_to_le16(free_id + 1);
48 /* One record can store up to 1024/24 ~= 42 attributes. */
55 attr = mi_enum_attr(mi, attr);
57 rec->next_attr_id = cpu_to_le16(max_id + 1);
59 return cpu_to_le16(free_id);
62 t16 = le16_to_cpu(attr->id);
66 } else if (max_id < t16)
71 int mi_get(struct ntfs_sb_info *sbi, CLST rno, struct mft_inode **mi)
74 struct mft_inode *m = kzalloc(sizeof(struct mft_inode), GFP_NOFS);
79 err = mi_init(m, sbi, rno);
85 err = mi_read(m, false);
95 void mi_put(struct mft_inode *mi)
101 int mi_init(struct mft_inode *mi, struct ntfs_sb_info *sbi, CLST rno)
105 mi->mrec = kmalloc(sbi->record_size, GFP_NOFS);
113 * mi_read - Read MFT data.
115 int mi_read(struct mft_inode *mi, bool is_mft)
118 struct MFT_REC *rec = mi->mrec;
119 struct ntfs_sb_info *sbi = mi->sbi;
120 u32 bpr = sbi->record_size;
121 u64 vbo = (u64)mi->rno << sbi->record_bits;
122 struct ntfs_inode *mft_ni = sbi->mft.ni;
123 struct runs_tree *run = mft_ni ? &mft_ni->file.run : NULL;
124 struct rw_semaphore *rw_lock = NULL;
126 if (is_mounted(sbi)) {
127 if (!is_mft && mft_ni) {
128 rw_lock = &mft_ni->file.run_lock;
133 err = ntfs_read_bh(sbi, run, vbo, &rec->rhdr, bpr, &mi->nb);
139 if (err == -E_NTFS_FIXUP) {
151 err = attr_load_runs_vcn(mft_ni, ATTR_DATA, NULL, 0, run,
152 vbo >> sbi->cluster_bits);
162 err = ntfs_read_bh(sbi, run, vbo, &rec->rhdr, bpr, &mi->nb);
166 if (err == -E_NTFS_FIXUP) {
174 /* Check field 'total' only here. */
175 if (le32_to_cpu(rec->total) != bpr) {
183 if (err == -E_NTFS_CORRUPT) {
184 ntfs_err(sbi->sb, "mft corrupted");
185 ntfs_set_state(sbi, NTFS_DIRTY_ERROR);
192 struct ATTRIB *mi_enum_attr(struct mft_inode *mi, struct ATTRIB *attr)
194 const struct MFT_REC *rec = mi->mrec;
195 u32 used = le32_to_cpu(rec->used);
200 u32 total = le32_to_cpu(rec->total);
202 off = le16_to_cpu(rec->attr_off);
207 if (off >= used || off < MFTRECORD_FIXUP_OFFSET_1 ||
208 !IS_ALIGNED(off, 4)) {
212 /* Skip non-resident records. */
213 if (!is_rec_inuse(rec))
216 attr = Add2Ptr(rec, off);
218 /* Check if input attr inside record. */
219 off = PtrOffset(rec, attr);
223 asize = le32_to_cpu(attr->size);
224 if (asize < SIZEOF_RESIDENT) {
225 /* Impossible 'cause we should not return such attribute. */
229 if (off + asize < off) {
230 /* Overflow check. */
234 attr = Add2Ptr(attr, asize);
238 asize = le32_to_cpu(attr->size);
240 /* Can we use the first field (attr->type). */
241 if (off + 8 > used) {
242 static_assert(ALIGN(sizeof(enum ATTR_TYPE), 8) == 8);
246 if (attr->type == ATTR_END) {
247 /* End of enumeration. */
251 /* 0x100 is last known attribute for now. */
252 t32 = le32_to_cpu(attr->type);
253 if ((t32 & 0xf) || (t32 > 0x100))
256 /* Check overflow and boundary. */
257 if (off + asize < off || off + asize > used)
260 /* Check size of attribute. */
261 if (!attr->non_res) {
262 if (asize < SIZEOF_RESIDENT)
265 t16 = le16_to_cpu(attr->res.data_off);
270 t32 = le32_to_cpu(attr->res.data_size);
271 if (t16 + t32 > asize)
274 t32 = sizeof(short) * attr->name_len;
275 if (t32 && le16_to_cpu(attr->name_off) + t32 > t16)
281 /* Check some nonresident fields. */
282 if (attr->name_len &&
283 le16_to_cpu(attr->name_off) + sizeof(short) * attr->name_len >
284 le16_to_cpu(attr->nres.run_off)) {
288 if (attr->nres.svcn || !is_attr_ext(attr)) {
289 if (asize + 8 < SIZEOF_NONRESIDENT)
292 if (attr->nres.c_unit)
294 } else if (asize + 8 < SIZEOF_NONRESIDENT_EX)
301 * mi_find_attr - Find the attribute by type and name and id.
303 struct ATTRIB *mi_find_attr(struct mft_inode *mi, struct ATTRIB *attr,
304 enum ATTR_TYPE type, const __le16 *name,
305 u8 name_len, const __le16 *id)
307 u32 type_in = le32_to_cpu(type);
311 attr = mi_enum_attr(mi, attr);
315 atype = le32_to_cpu(attr->type);
322 if (attr->name_len != name_len)
325 if (name_len && memcmp(attr_name(attr), name, name_len * sizeof(short)))
328 if (id && *id != attr->id)
334 int mi_write(struct mft_inode *mi, int wait)
338 struct ntfs_sb_info *sbi;
346 err = ntfs_write_bh(sbi, &rec->rhdr, &mi->nb, wait);
350 if (mi->rno < sbi->mft.recs_mirr)
351 sbi->flags |= NTFS_FLAGS_MFTMIRR;
358 int mi_format_new(struct mft_inode *mi, struct ntfs_sb_info *sbi, CLST rno,
359 __le16 flags, bool is_mft)
364 u64 vbo = (u64)rno << sbi->record_bits;
366 err = mi_init(mi, sbi, rno);
372 if (rno == MFT_REC_MFT) {
374 } else if (rno < MFT_REC_FREE) {
376 } else if (rno >= sbi->mft.used) {
378 } else if (mi_read(mi, is_mft)) {
380 } else if (rec->rhdr.sign == NTFS_FILE_SIGNATURE) {
381 /* Record is reused. Update its sequence number. */
382 seq = le16_to_cpu(rec->seq) + 1;
387 memcpy(rec, sbi->new_rec, sbi->record_size);
389 rec->seq = cpu_to_le16(seq);
390 rec->flags = RECORD_FLAG_IN_USE | flags;
391 if (MFTRECORD_FIXUP_OFFSET == MFTRECORD_FIXUP_OFFSET_3)
392 rec->mft_record = cpu_to_le32(rno);
397 struct ntfs_inode *ni = sbi->mft.ni;
400 if (is_mounted(sbi) && !is_mft) {
401 down_read(&ni->file.run_lock);
405 err = ntfs_get_bh(sbi, &ni->file.run, vbo, sbi->record_size,
408 up_read(&ni->file.run_lock);
415 * mi_insert_attr - Reserve space for new attribute.
417 * Return: Not full constructed attribute or NULL if not possible to create.
419 struct ATTRIB *mi_insert_attr(struct mft_inode *mi, enum ATTR_TYPE type,
420 const __le16 *name, u8 name_len, u32 asize,
426 struct MFT_REC *rec = mi->mrec;
427 struct ntfs_sb_info *sbi = mi->sbi;
428 u32 used = le32_to_cpu(rec->used);
429 const u16 *upcase = sbi->upcase;
431 /* Can we insert mi attribute? */
432 if (used + asize > sbi->record_size)
436 * Scan through the list of attributes to find the point
437 * at which we should insert it.
440 while ((attr = mi_enum_attr(mi, attr))) {
441 int diff = compare_attr(attr, type, name, name_len, upcase);
446 if (!diff && !is_attr_indexed(attr))
454 attr = Add2Ptr(rec, used - 8);
456 /* Insert before 'attr'. */
457 tail = used - PtrOffset(rec, attr);
460 id = mi_new_attt_id(mi);
462 memmove(Add2Ptr(attr, asize), attr, tail);
463 memset(attr, 0, asize);
466 attr->size = cpu_to_le32(asize);
467 attr->name_len = name_len;
468 attr->name_off = cpu_to_le16(name_off);
471 memmove(Add2Ptr(attr, name_off), name, name_len * sizeof(short));
472 rec->used = cpu_to_le32(used + asize);
480 * mi_remove_attr - Remove the attribute from record.
482 * NOTE: The source attr will point to next attribute.
484 bool mi_remove_attr(struct ntfs_inode *ni, struct mft_inode *mi,
487 struct MFT_REC *rec = mi->mrec;
488 u32 aoff = PtrOffset(rec, attr);
489 u32 used = le32_to_cpu(rec->used);
490 u32 asize = le32_to_cpu(attr->size);
492 if (aoff + asize > used)
495 if (ni && is_attr_indexed(attr)) {
496 le16_add_cpu(&ni->mi.mrec->hard_links, -1);
501 memmove(attr, Add2Ptr(attr, asize), used - aoff);
502 rec->used = cpu_to_le32(used);
508 /* bytes = "new attribute size" - "old attribute size" */
509 bool mi_resize_attr(struct mft_inode *mi, struct ATTRIB *attr, int bytes)
511 struct MFT_REC *rec = mi->mrec;
512 u32 aoff = PtrOffset(rec, attr);
513 u32 total, used = le32_to_cpu(rec->used);
514 u32 nsize, asize = le32_to_cpu(attr->size);
515 u32 rsize = le32_to_cpu(attr->res.data_size);
516 int tail = (int)(used - aoff - asize);
520 if (tail < 0 || aoff >= used)
526 total = le32_to_cpu(rec->total);
527 next = Add2Ptr(attr, asize);
530 dsize = ALIGN(bytes, 8);
531 if (used + dsize > total)
533 nsize = asize + dsize;
535 memmove(next + dsize, next, tail);
536 memset(next, 0, dsize);
540 dsize = ALIGN(-bytes, 8);
543 nsize = asize - dsize;
544 memmove(next - dsize, next, tail);
549 rec->used = cpu_to_le32(used);
550 attr->size = cpu_to_le32(nsize);
552 attr->res.data_size = cpu_to_le32(rsize);
559 * Pack runs in MFT record.
560 * If failed record is not changed.
562 int mi_pack_runs(struct mft_inode *mi, struct ATTRIB *attr,
563 struct runs_tree *run, CLST len)
566 struct ntfs_sb_info *sbi = mi->sbi;
569 struct MFT_REC *rec = mi->mrec;
570 CLST svcn = le64_to_cpu(attr->nres.svcn);
571 u32 used = le32_to_cpu(rec->used);
572 u32 aoff = PtrOffset(rec, attr);
573 u32 asize = le32_to_cpu(attr->size);
574 char *next = Add2Ptr(attr, asize);
575 u16 run_off = le16_to_cpu(attr->nres.run_off);
576 u32 run_size = asize - run_off;
577 u32 tail = used - aoff - asize;
578 u32 dsize = sbi->record_size - used;
580 /* Make a maximum gap in current record. */
581 memmove(next + dsize, next, tail);
583 /* Pack as much as possible. */
584 err = run_pack(run, svcn, len, Add2Ptr(attr, run_off), run_size + dsize,
587 memmove(next, next + dsize, tail);
591 new_run_size = ALIGN(err, 8);
593 memmove(next + new_run_size - run_size, next + dsize, tail);
595 attr->size = cpu_to_le32(asize + new_run_size - run_size);
596 attr->nres.evcn = cpu_to_le64(svcn + plen - 1);
597 rec->used = cpu_to_le32(used + new_run_size - run_size);