2N/A/*
2N/A * mft.h - Exports for MFT record handling. Part of the Linux-NTFS project.
2N/A *
2N/A * Copyright (c) 2000-2002 Anton Altaparmakov
2N/A * Copyright (c) 2004-2005 Richard Russon
2N/A *
2N/A * This program/include file is free software; you can redistribute it and/or
2N/A * modify it under the terms of the GNU General Public License as published
2N/A * by the Free Software Foundation; either version 2 of the License, or
2N/A * (at your option) any later version.
2N/A *
2N/A * This program/include file is distributed in the hope that it will be
2N/A * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
2N/A * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
2N/A * GNU General Public License for more details.
2N/A *
2N/A * You should have received a copy of the GNU General Public License
2N/A * along with this program (in the main directory of the Linux-NTFS
2N/A * distribution in the file COPYING); if not, write to the Free Software
2N/A * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
2N/A */
2N/A
2N/A#ifndef _NTFS_MFT_H
2N/A#define _NTFS_MFT_H
2N/A
2N/A#include "volume.h"
2N/A#include "inode.h"
2N/A#include "layout.h"
2N/A
2N/Aextern int ntfs_mft_records_read(const ntfs_volume *vol, const MFT_REF mref,
2N/A const s64 count, MFT_RECORD *b);
2N/A
2N/A/**
2N/A * ntfs_mft_record_read - read a record from the mft
2N/A * @vol: volume to read from
2N/A * @mref: mft record number to read
2N/A * @b: output data buffer
2N/A *
2N/A * Read the mft record specified by @mref from volume @vol into buffer @b.
2N/A * Return 0 on success or -1 on error, with errno set to the error code.
2N/A *
2N/A * The read mft record is mst deprotected and is hence ready to use. The caller
2N/A * should check the record with is_baad_record() in case mst deprotection
2N/A * failed.
2N/A *
2N/A * NOTE: @b has to be at least of size vol->mft_record_size.
2N/A */
2N/Astatic __inline__ int ntfs_mft_record_read(const ntfs_volume *vol,
2N/A const MFT_REF mref, MFT_RECORD *b)
2N/A{
2N/A return ntfs_mft_records_read(vol, mref, 1, b);
2N/A}
2N/A
2N/Aextern int ntfs_file_record_read(const ntfs_volume *vol, const MFT_REF mref,
2N/A MFT_RECORD **mrec, ATTR_RECORD **attr);
2N/A
2N/Aextern int ntfs_mft_records_write(const ntfs_volume *vol, const MFT_REF mref,
2N/A const s64 count, MFT_RECORD *b);
2N/A
2N/A/**
2N/A * ntfs_mft_record_write - write an mft record to disk
2N/A * @vol: volume to write to
2N/A * @mref: mft record number to write
2N/A * @b: data buffer containing the mft record to write
2N/A *
2N/A * Write the mft record specified by @mref from buffer @b to volume @vol.
2N/A * Return 0 on success or -1 on error, with errno set to the error code.
2N/A *
2N/A * Before the mft record is written, it is mst protected. After the write, it
2N/A * is deprotected again, thus resulting in an increase in the update sequence
2N/A * number inside the buffer @b.
2N/A *
2N/A * NOTE: @b has to be at least of size vol->mft_record_size.
2N/A */
2N/Astatic __inline__ int ntfs_mft_record_write(const ntfs_volume *vol,
2N/A const MFT_REF mref, MFT_RECORD *b)
2N/A{
2N/A return ntfs_mft_records_write(vol, mref, 1, b);
2N/A}
2N/A
2N/A/**
2N/A * ntfs_mft_record_get_data_size - return number of bytes used in mft record @b
2N/A * @m: mft record to get the data size of
2N/A *
2N/A * Takes the mft record @m and returns the number of bytes used in the record
2N/A * or 0 on error (i.e. @m is not a valid mft record). Zero is not a valid size
2N/A * for an mft record as it at least has to have the MFT_RECORD itself and a
2N/A * zero length attribute of type AT_END, thus making the minimum size 56 bytes.
2N/A *
2N/A * Aside: The size is independent of NTFS versions 1.x/3.x because the 8-byte
2N/A * alignment of the first attribute mask the difference in MFT_RECORD size
2N/A * between NTFS 1.x and 3.x. Also, you would expect every mft record to
2N/A * contain an update sequence array as well but that could in theory be
2N/A * non-existent (don't know if Windows' NTFS driver/chkdsk wouldn't view this
2N/A * as corruption in itself though).
2N/A */
2N/Astatic __inline__ u32 ntfs_mft_record_get_data_size(const MFT_RECORD *m)
2N/A{
2N/A if (!m || !ntfs_is_mft_record(m->magic))
2N/A return 0;
2N/A /* Get the number of used bytes and return it. */
2N/A return le32_to_cpu(m->bytes_in_use);
2N/A}
2N/A
2N/Aextern int ntfs_mft_record_layout(const ntfs_volume *vol, const MFT_REF mref,
2N/A MFT_RECORD *mrec);
2N/A
2N/Aextern int ntfs_mft_record_format(const ntfs_volume *vol, const MFT_REF mref);
2N/A
2N/Aextern ntfs_inode *ntfs_mft_record_alloc(ntfs_volume *vol, ntfs_inode *base_ni);
2N/A
2N/Aextern int ntfs_mft_record_free(ntfs_volume *vol, ntfs_inode *ni);
2N/A
2N/Aextern int ntfs_mft_usn_dec(MFT_RECORD *mrec);
2N/A
2N/A#endif /* defined _NTFS_MFT_H */
2N/A