226 lines
8.2 KiB
C
226 lines
8.2 KiB
C
/*
|
|
* inode.h - Defines for NTFS inode handling. Originated from the Linux-NTFS project.
|
|
*
|
|
* Copyright (c) 2001-2004 Anton Altaparmakov
|
|
* Copyright (c) 2004-2007 Yura Pakhuchiy
|
|
* Copyright (c) 2004-2005 Richard Russon
|
|
* Copyright (c) 2006-2008 Szabolcs Szakacsits
|
|
*
|
|
* This program/include file is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License as published
|
|
* by the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program/include file is distributed in the hope that it will be
|
|
* useful, but WITHOUT ANY WARRANTY; without even the implied warranty
|
|
* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program (in the main directory of the NTFS-3G
|
|
* distribution in the file COPYING); if not, write to the Free Software
|
|
* Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
*/
|
|
|
|
#ifndef _NTFS_INODE_H
|
|
#define _NTFS_INODE_H
|
|
|
|
/* Forward declaration */
|
|
typedef struct _ntfs_inode ntfs_inode;
|
|
|
|
#include "types.h"
|
|
#include "layout.h"
|
|
#include "support.h"
|
|
#include "volume.h"
|
|
#include "ntfstime.h"
|
|
|
|
/**
|
|
* enum ntfs_inode_state_bits -
|
|
*
|
|
* Defined bits for the state field in the ntfs_inode structure.
|
|
* (f) = files only, (d) = directories only
|
|
*/
|
|
typedef enum {
|
|
NI_Dirty, /* 1: Mft record needs to be written to disk. */
|
|
|
|
/* The NI_AttrList* tests only make sense for base inodes. */
|
|
NI_AttrList, /* 1: Mft record contains an attribute list. */
|
|
NI_AttrListDirty, /* 1: Attribute list needs to be written to the
|
|
mft record and then to disk. */
|
|
NI_FileNameDirty, /* 1: FILE_NAME attributes need to be updated
|
|
in the index. */
|
|
NI_v3_Extensions, /* 1: JPA v3.x extensions present. */
|
|
NI_TimesSet, /* 1: Use times which were set */
|
|
NI_KnownSize, /* 1: Set if sizes are meaningful */
|
|
} ntfs_inode_state_bits;
|
|
|
|
#define test_nino_flag(ni, flag) test_bit(NI_##flag, (ni)->state)
|
|
#define set_nino_flag(ni, flag) set_bit(NI_##flag, (ni)->state)
|
|
#define clear_nino_flag(ni, flag) clear_bit(NI_##flag, (ni)->state)
|
|
|
|
#define test_and_set_nino_flag(ni, flag) \
|
|
test_and_set_bit(NI_##flag, (ni)->state)
|
|
#define test_and_clear_nino_flag(ni, flag) \
|
|
test_and_clear_bit(NI_##flag, (ni)->state)
|
|
|
|
#define NInoDirty(ni) test_nino_flag(ni, Dirty)
|
|
#define NInoSetDirty(ni) set_nino_flag(ni, Dirty)
|
|
#define NInoClearDirty(ni) clear_nino_flag(ni, Dirty)
|
|
#define NInoTestAndSetDirty(ni) test_and_set_nino_flag(ni, Dirty)
|
|
#define NInoTestAndClearDirty(ni) test_and_clear_nino_flag(ni, Dirty)
|
|
|
|
#define NInoAttrList(ni) test_nino_flag(ni, AttrList)
|
|
#define NInoSetAttrList(ni) set_nino_flag(ni, AttrList)
|
|
#define NInoClearAttrList(ni) clear_nino_flag(ni, AttrList)
|
|
|
|
|
|
#define test_nino_al_flag(ni, flag) test_nino_flag(ni, AttrList##flag)
|
|
#define set_nino_al_flag(ni, flag) set_nino_flag(ni, AttrList##flag)
|
|
#define clear_nino_al_flag(ni, flag) clear_nino_flag(ni, AttrList##flag)
|
|
|
|
#define test_and_set_nino_al_flag(ni, flag) \
|
|
test_and_set_nino_flag(ni, AttrList##flag)
|
|
#define test_and_clear_nino_al_flag(ni, flag) \
|
|
test_and_clear_nino_flag(ni, AttrList##flag)
|
|
|
|
#define NInoAttrListDirty(ni) test_nino_al_flag(ni, Dirty)
|
|
#define NInoAttrListSetDirty(ni) set_nino_al_flag(ni, Dirty)
|
|
#define NInoAttrListClearDirty(ni) clear_nino_al_flag(ni, Dirty)
|
|
#define NInoAttrListTestAndSetDirty(ni) test_and_set_nino_al_flag(ni, Dirty)
|
|
#define NInoAttrListTestAndClearDirty(ni) test_and_clear_nino_al_flag(ni, Dirty)
|
|
|
|
#define NInoFileNameDirty(ni) test_nino_flag(ni, FileNameDirty)
|
|
#define NInoFileNameSetDirty(ni) set_nino_flag(ni, FileNameDirty)
|
|
#define NInoFileNameClearDirty(ni) clear_nino_flag(ni, FileNameDirty)
|
|
#define NInoFileNameTestAndSetDirty(ni) \
|
|
test_and_set_nino_flag(ni, FileNameDirty)
|
|
#define NInoFileNameTestAndClearDirty(ni) \
|
|
test_and_clear_nino_flag(ni, FileNameDirty)
|
|
|
|
/**
|
|
* struct _ntfs_inode - The NTFS in-memory inode structure.
|
|
*
|
|
* It is just used as an extension to the fields already provided in the VFS
|
|
* inode.
|
|
*/
|
|
struct _ntfs_inode {
|
|
u64 mft_no; /* Inode / mft record number. */
|
|
MFT_RECORD *mrec; /* The actual mft record of the inode. */
|
|
ntfs_volume *vol; /* Pointer to the ntfs volume of this inode. */
|
|
unsigned long state; /* NTFS specific flags describing this inode.
|
|
See ntfs_inode_state_bits above. */
|
|
FILE_ATTR_FLAGS flags; /* Flags describing the file.
|
|
(Copy from STANDARD_INFORMATION) */
|
|
/*
|
|
* Attribute list support (for use by the attribute lookup functions).
|
|
* Setup during ntfs_open_inode() for all inodes with attribute lists.
|
|
* Only valid if NI_AttrList is set in state.
|
|
*/
|
|
u32 attr_list_size; /* Length of attribute list value in bytes. */
|
|
u8 *attr_list; /* Attribute list value itself. */
|
|
/* Below fields are always valid. */
|
|
s32 nr_extents; /* For a base mft record, the number of
|
|
attached extent inodes (0 if none), for
|
|
extent records this is -1. */
|
|
union { /* This union is only used if nr_extents != 0. */
|
|
ntfs_inode **extent_nis;/* For nr_extents > 0, array of the
|
|
ntfs inodes of the extent mft
|
|
records belonging to this base
|
|
inode which have been loaded. */
|
|
ntfs_inode *base_ni; /* For nr_extents == -1, the ntfs
|
|
inode of the base mft record. */
|
|
};
|
|
|
|
/* Below fields are valid only for base inode. */
|
|
|
|
/*
|
|
* These two fields are used to sync filename index and guaranteed to be
|
|
* correct, however value in index itself maybe wrong (windows itself
|
|
* do not update them properly).
|
|
* For directories, they hold the index size, provided the
|
|
* flag KnownSize is set.
|
|
*/
|
|
s64 data_size; /* Data size of unnamed DATA attribute
|
|
(or INDEX_ROOT for directories) */
|
|
s64 allocated_size; /* Allocated size stored in the filename
|
|
index. (NOTE: Equal to allocated size of
|
|
the unnamed data attribute for normal or
|
|
encrypted files and to compressed size
|
|
of the unnamed data attribute for sparse or
|
|
compressed files.) */
|
|
|
|
/*
|
|
* These four fields are copy of relevant fields from
|
|
* STANDARD_INFORMATION attribute and used to sync it and FILE_NAME
|
|
* attribute in the index.
|
|
*/
|
|
ntfs_time creation_time;
|
|
ntfs_time last_data_change_time;
|
|
ntfs_time last_mft_change_time;
|
|
ntfs_time last_access_time;
|
|
/* NTFS 3.x extensions added by JPA */
|
|
/* only if NI_v3_Extensions is set in state */
|
|
le32 owner_id;
|
|
le32 security_id;
|
|
le64 quota_charged;
|
|
le64 usn;
|
|
};
|
|
|
|
typedef enum {
|
|
NTFS_UPDATE_ATIME = 1 << 0,
|
|
NTFS_UPDATE_MTIME = 1 << 1,
|
|
NTFS_UPDATE_CTIME = 1 << 2,
|
|
} ntfs_time_update_flags;
|
|
|
|
#define NTFS_UPDATE_MCTIME (NTFS_UPDATE_MTIME | NTFS_UPDATE_CTIME)
|
|
#define NTFS_UPDATE_AMCTIME (NTFS_UPDATE_ATIME | NTFS_UPDATE_MCTIME)
|
|
|
|
extern ntfs_inode *ntfs_inode_base(ntfs_inode *ni);
|
|
|
|
extern ntfs_inode *ntfs_inode_allocate(ntfs_volume *vol);
|
|
|
|
extern ntfs_inode *ntfs_inode_open(ntfs_volume *vol, const MFT_REF mref);
|
|
|
|
extern int ntfs_inode_close(ntfs_inode *ni);
|
|
extern int ntfs_inode_close_in_dir(ntfs_inode *ni, ntfs_inode *dir_ni);
|
|
|
|
#if CACHE_NIDATA_SIZE
|
|
|
|
struct CACHED_GENERIC;
|
|
|
|
extern int ntfs_inode_real_close(ntfs_inode *ni);
|
|
extern void ntfs_inode_invalidate(ntfs_volume *vol, const MFT_REF mref);
|
|
extern void ntfs_inode_nidata_free(const struct CACHED_GENERIC *cached);
|
|
extern int ntfs_inode_nidata_hash(const struct CACHED_GENERIC *item);
|
|
|
|
#endif
|
|
|
|
|
|
extern ntfs_inode *ntfs_extent_inode_open(ntfs_inode *base_ni,
|
|
const MFT_REF mref);
|
|
|
|
extern int ntfs_inode_attach_all_extents(ntfs_inode *ni);
|
|
|
|
extern void ntfs_inode_mark_dirty(ntfs_inode *ni);
|
|
|
|
extern void ntfs_inode_update_times(ntfs_inode *ni, ntfs_time_update_flags mask);
|
|
|
|
extern int ntfs_inode_sync(ntfs_inode *ni);
|
|
|
|
extern int ntfs_inode_add_attrlist(ntfs_inode *ni);
|
|
|
|
extern int ntfs_inode_free_space(ntfs_inode *ni, int size);
|
|
|
|
extern int ntfs_inode_badclus_bad(u64 mft_no, ATTR_RECORD *a);
|
|
|
|
extern int ntfs_inode_get_times(ntfs_inode *ni, char *value, size_t size);
|
|
|
|
extern int ntfs_inode_set_times(ntfs_inode *ni, const char *value,
|
|
size_t size, int flags);
|
|
|
|
/* debugging */
|
|
#define debug_double_inode(num, type)
|
|
#define debug_cached_inode(ni)
|
|
|
|
#endif /* defined _NTFS_INODE_H */
|