/* 
 * Copyright (c) [2010-2019] zhenfei.mzf@gmail.com rights reserved.
 * 
 * AntiSpy is licensed under the Mulan PSL v1.
 * You can use this software according to the terms and conditions of the Mulan PSL v1.
 * You may obtain a copy of Mulan PSL v1 at:
 *
 *     http://license.coscl.org.cn/MulanPSL
 *
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR
 * FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v1 for more details.
*/
/*
 * inode.h - Defines for NTFS inode handling. Originated from the Linux-NTFS project.
 */

#ifndef _NTFS_INODE_H
#define _NTFS_INODE_H

/* Forward declaration */
typedef struct _ntfs_inode ntfs_inode;

#include <time.h>

#include "types.h"
#include "layout.h"
#include "support.h"
#include "volume.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. */
} 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)

BOOL NInoFileNameTestAndClearDirty_func( ntfs_inode *ni );
BOOL NInoAttrListTestAndClearDirty_func( ntfs_inode *ni );
BOOL NInoTestAndClearDirty_func( ntfs_inode *ni );


/**
 * 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; // 指向该文件的MFT
	/* 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. */
	};

	/* Temp: for directory handling */
	void *private_data;	/* ntfs_dt containing this inode */
	int ref_count;

	/* Below fields are valid only for base inode. */
	s64 data_size;		/* Data size stored in the filename index. */
	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.) */

	time_t creation_time;
	time_t last_data_change_time;
	time_t last_mft_change_time;
	time_t last_access_time;
};

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 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_atime(ntfs_inode *ni);
extern void ntfs_inode_update_time(ntfs_inode *ni);

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);

#endif /* defined _NTFS_INODE_H */
