[net-next-2.6.git] / fs / ntfs / volume.h

/*
 * volume.h - Defines for volume structures in NTFS Linux kernel driver. Part
 *	      of the Linux-NTFS project.
 *
 * Copyright (c) 2001-2006 Anton Altaparmakov
 * Copyright (c) 2002 Richard Russon
 *
 * 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 Linux-NTFS
 * 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 _LINUX_NTFS_VOLUME_H
#define _LINUX_NTFS_VOLUME_H

#include <linux/rwsem.h>

#include "types.h"
#include "layout.h"

/*
 * The NTFS in memory super block structure.
 */
typedef struct {
	/*
	 * FIXME: Reorder to have commonly used together element within the
	 * same cache line, aiming at a cache line size of 32 bytes. Aim for
	 * 64 bytes for less commonly used together elements. Put most commonly
	 * used elements to front of structure. Obviously do this only when the
	 * structure has stabilized... (AIA)
	 */
	/* Device specifics. */
	struct super_block *sb;		/* Pointer back to the super_block. */
	LCN nr_blocks;			/* Number of sb->s_blocksize bytes
					   sized blocks on the device. */
	/* Configuration provided by user at mount time. */
	unsigned long flags;		/* Miscellaneous flags, see below. */
	uid_t uid;			/* uid that files will be mounted as. */
	gid_t gid;			/* gid that files will be mounted as. */
	mode_t fmask;			/* The mask for file permissions. */
	mode_t dmask;			/* The mask for directory
					   permissions. */
	u8 mft_zone_multiplier;		/* Initial mft zone multiplier. */
	u8 on_errors;			/* What to do on filesystem errors. */
	/* NTFS bootsector provided information. */
	u16 sector_size;		/* in bytes */
	u8 sector_size_bits;		/* log2(sector_size) */
	u32 cluster_size;		/* in bytes */
	u32 cluster_size_mask;		/* cluster_size - 1 */
	u8 cluster_size_bits;		/* log2(cluster_size) */
	u32 mft_record_size;		/* in bytes */
	u32 mft_record_size_mask;	/* mft_record_size - 1 */
	u8 mft_record_size_bits;	/* log2(mft_record_size) */
	u32 index_record_size;		/* in bytes */
	u32 index_record_size_mask;	/* index_record_size - 1 */
	u8 index_record_size_bits;	/* log2(index_record_size) */
	LCN nr_clusters;		/* Volume size in clusters == number of
					   bits in lcn bitmap. */
	LCN mft_lcn;			/* Cluster location of mft data. */
	LCN mftmirr_lcn;		/* Cluster location of copy of mft. */
	u64 serial_no;			/* The volume serial number. */
	/* Mount specific NTFS information. */
	u32 upcase_len;			/* Number of entries in upcase[]. */
	ntfschar *upcase;		/* The upcase table. */

	s32 attrdef_size;		/* Size of the attribute definition
					   table in bytes. */
	ATTR_DEF *attrdef;		/* Table of attribute definitions.
					   Obtained from FILE_AttrDef. */

#ifdef NTFS_RW
	/* Variables used by the cluster and mft allocators. */
	s64 mft_data_pos;		/* Mft record number at which to
					   allocate the next mft record. */
	LCN mft_zone_start;		/* First cluster of the mft zone. */
	LCN mft_zone_end;		/* First cluster beyond the mft zone. */
	LCN mft_zone_pos;		/* Current position in the mft zone. */
	LCN data1_zone_pos;		/* Current position in the first data
					   zone. */
	LCN data2_zone_pos;		/* Current position in the second data
					   zone. */
#endif /* NTFS_RW */

	struct inode *mft_ino;		/* The VFS inode of $MFT. */

	struct inode *mftbmp_ino;	/* Attribute inode for $MFT/$BITMAP. */
	struct rw_semaphore mftbmp_lock; /* Lock for serializing accesses to the
					    mft record bitmap ($MFT/$BITMAP). */
#ifdef NTFS_RW
	struct inode *mftmirr_ino;	/* The VFS inode of $MFTMirr. */
	int mftmirr_size;		/* Size of mft mirror in mft records. */

	struct inode *logfile_ino;	/* The VFS inode of $LogFile. */
#endif /* NTFS_RW */

	struct inode *lcnbmp_ino;	/* The VFS inode of $Bitmap. */
	struct rw_semaphore lcnbmp_lock; /* Lock for serializing accesses to the
					    cluster bitmap ($Bitmap/$DATA). */

	struct inode *vol_ino;		/* The VFS inode of $Volume. */
	VOLUME_FLAGS vol_flags;		/* Volume flags. */
	u8 major_ver;			/* Ntfs major version of volume. */
	u8 minor_ver;			/* Ntfs minor version of volume. */

	struct inode *root_ino;		/* The VFS inode of the root
					   directory. */
	struct inode *secure_ino;	/* The VFS inode of $Secure (NTFS3.0+
					   only, otherwise NULL). */
	struct inode *extend_ino;	/* The VFS inode of $Extend (NTFS3.0+
					   only, otherwise NULL). */
#ifdef NTFS_RW
	/* $Quota stuff is NTFS3.0+ specific.  Unused/NULL otherwise. */
	struct inode *quota_ino;	/* The VFS inode of $Quota. */
	struct inode *quota_q_ino;	/* Attribute inode for $Quota/$Q. */
	/* $UsnJrnl stuff is NTFS3.0+ specific.  Unused/NULL otherwise. */
	struct inode *usnjrnl_ino;	/* The VFS inode of $UsnJrnl. */
	struct inode *usnjrnl_max_ino;	/* Attribute inode for $UsnJrnl/$Max. */
	struct inode *usnjrnl_j_ino;	/* Attribute inode for $UsnJrnl/$J. */
#endif /* NTFS_RW */
	struct nls_table *nls_map;
} ntfs_volume;

/*
 * Defined bits for the flags field in the ntfs_volume structure.
 */
typedef enum {
	NV_Errors,		/* 1: Volume has errors, prevent remount rw. */
	NV_ShowSystemFiles,	/* 1: Return system files in ntfs_readdir(). */
	NV_CaseSensitive,	/* 1: Treat file names as case sensitive and
				      create filenames in the POSIX namespace.
				      Otherwise be case insensitive but still
				      create file names in POSIX namespace. */
	NV_LogFileEmpty,	/* 1: $LogFile journal is empty. */
	NV_QuotaOutOfDate,	/* 1: $Quota is out of date. */
	NV_UsnJrnlStamped,	/* 1: $UsnJrnl has been stamped. */
	NV_SparseEnabled,	/* 1: May create sparse files. */
} ntfs_volume_flags;

/*
 * Macro tricks to expand the NVolFoo(), NVolSetFoo(), and NVolClearFoo()
 * functions.
 */
#define DEFINE_NVOL_BIT_OPS(flag)					\
static inline int NVol##flag(ntfs_volume *vol)		\
{							\
	return test_bit(NV_##flag, &(vol)->flags);	\
}							\
static inline void NVolSet##flag(ntfs_volume *vol)	\
{							\
	set_bit(NV_##flag, &(vol)->flags);		\
}							\
static inline void NVolClear##flag(ntfs_volume *vol)	\
{							\
	clear_bit(NV_##flag, &(vol)->flags);		\
}

/* Emit the ntfs volume bitops functions. */
DEFINE_NVOL_BIT_OPS(Errors)
DEFINE_NVOL_BIT_OPS(ShowSystemFiles)
DEFINE_NVOL_BIT_OPS(CaseSensitive)
DEFINE_NVOL_BIT_OPS(LogFileEmpty)
DEFINE_NVOL_BIT_OPS(QuotaOutOfDate)
DEFINE_NVOL_BIT_OPS(UsnJrnlStamped)
DEFINE_NVOL_BIT_OPS(SparseEnabled)

#endif /* _LINUX_NTFS_VOLUME_H */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* volume.h - Defines for volume structures in NTFS Linux kernel driver. Part
	3	* of the Linux-NTFS project.
	4	*
1cf3109f	5	* Copyright (c) 2001-2006 Anton Altaparmakov
1da177e4 LT	6	* Copyright (c) 2002 Richard Russon
	7	*
	8	* This program/include file is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public License as published
	10	* by the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program/include file is distributed in the hope that it will be
	14	* useful, but WITHOUT ANY WARRANTY; without even the implied warranty
	15	* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program (in the main directory of the Linux-NTFS
	20	* distribution in the file COPYING); if not, write to the Free Software
	21	* Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	22	*/
	23
	24	#ifndef _LINUX_NTFS_VOLUME_H
	25	#define _LINUX_NTFS_VOLUME_H
	26
	27	#include <linux/rwsem.h>
	28
	29	#include "types.h"
	30	#include "layout.h"
	31
	32	/*
	33	* The NTFS in memory super block structure.
	34	*/
	35	typedef struct {
	36	/*
	37	* FIXME: Reorder to have commonly used together element within the
	38	* same cache line, aiming at a cache line size of 32 bytes. Aim for
	39	* 64 bytes for less commonly used together elements. Put most commonly
	40	* used elements to front of structure. Obviously do this only when the
	41	* structure has stabilized... (AIA)
	42	*/
	43	/* Device specifics. */
1cf3109f AA	44	struct super_block sb; / Pointer back to the super_block. */
1cf3109f AA	45	LCN nr_blocks; /* Number of sb->s_blocksize bytes
1da177e4 LT	46	sized blocks on the device. */
	47	/* Configuration provided by user at mount time. */
	48	unsigned long flags; /* Miscellaneous flags, see below. */
	49	uid_t uid; /* uid that files will be mounted as. */
	50	gid_t gid; /* gid that files will be mounted as. */
	51	mode_t fmask; /* The mask for file permissions. */
	52	mode_t dmask; /* The mask for directory
	53	permissions. */
	54	u8 mft_zone_multiplier; /* Initial mft zone multiplier. */
c002f425	55	u8 on_errors; /* What to do on filesystem errors. */
1da177e4 LT	56	/* NTFS bootsector provided information. */
	57	u16 sector_size; /* in bytes */
	58	u8 sector_size_bits; /* log2(sector_size) */
	59	u32 cluster_size; /* in bytes */
	60	u32 cluster_size_mask; /* cluster_size - 1 */
	61	u8 cluster_size_bits; /* log2(cluster_size) */
	62	u32 mft_record_size; /* in bytes */
	63	u32 mft_record_size_mask; /* mft_record_size - 1 */
	64	u8 mft_record_size_bits; /* log2(mft_record_size) */
	65	u32 index_record_size; /* in bytes */
	66	u32 index_record_size_mask; /* index_record_size - 1 */
	67	u8 index_record_size_bits; /* log2(index_record_size) */
	68	LCN nr_clusters; /* Volume size in clusters == number of
	69	bits in lcn bitmap. */
	70	LCN mft_lcn; /* Cluster location of mft data. */
	71	LCN mftmirr_lcn; /* Cluster location of copy of mft. */
	72	u64 serial_no; /* The volume serial number. */
	73	/* Mount specific NTFS information. */
	74	u32 upcase_len; /* Number of entries in upcase[]. */
	75	ntfschar upcase; / The upcase table. */
	76
	77	s32 attrdef_size; /* Size of the attribute definition
	78	table in bytes. */
	79	ATTR_DEF attrdef; / Table of attribute definitions.
	80	Obtained from FILE_AttrDef. */
	81
	82	#ifdef NTFS_RW
	83	/* Variables used by the cluster and mft allocators. */
	84	s64 mft_data_pos; /* Mft record number at which to
	85	allocate the next mft record. */
	86	LCN mft_zone_start; /* First cluster of the mft zone. */
	87	LCN mft_zone_end; /* First cluster beyond the mft zone. */
	88	LCN mft_zone_pos; /* Current position in the mft zone. */
	89	LCN data1_zone_pos; /* Current position in the first data
	90	zone. */
	91	LCN data2_zone_pos; /* Current position in the second data
	92	zone. */
	93	#endif /* NTFS_RW */
	94
	95	struct inode mft_ino; / The VFS inode of $MFT. */
	96
	97	struct inode mftbmp_ino; / Attribute inode for $MFT/$BITMAP. */
	98	struct rw_semaphore mftbmp_lock; /* Lock for serializing accesses to the
	99	mft record bitmap ($MFT/$BITMAP). */
	100	#ifdef NTFS_RW
	101	struct inode mftmirr_ino; / The VFS inode of $MFTMirr. */
	102	int mftmirr_size; /* Size of mft mirror in mft records. */
	103
	104	struct inode logfile_ino; / The VFS inode of $LogFile. */
	105	#endif /* NTFS_RW */
	106
	107	struct inode lcnbmp_ino; / The VFS inode of $Bitmap. */
	108	struct rw_semaphore lcnbmp_lock; /* Lock for serializing accesses to the
	109	cluster bitmap ($Bitmap/$DATA). */
	110
	111	struct inode vol_ino; / The VFS inode of $Volume. */
	112	VOLUME_FLAGS vol_flags; /* Volume flags. */
	113	u8 major_ver; /* Ntfs major version of volume. */
	114	u8 minor_ver; /* Ntfs minor version of volume. */
	115
	116	struct inode root_ino; / The VFS inode of the root
	117	directory. */
	118	struct inode secure_ino; / The VFS inode of $Secure (NTFS3.0+
	119	only, otherwise NULL). */
120	struct inode extend_ino; / The VFS inode of $Extend (NTFS3.0+
121	only, otherwise NULL). */
122	#ifdef NTFS_RW
123	/* $Quota stuff is NTFS3.0+ specific. Unused/NULL otherwise. */
124	struct inode quota_ino; / The VFS inode of $Quota. */
125	struct inode quota_q_ino; / Attribute inode for $Quota/$Q. */
3f2faef0 AA	126	/* $UsnJrnl stuff is NTFS3.0+ specific. Unused/NULL otherwise. */
	127	struct inode usnjrnl_ino; / The VFS inode of $UsnJrnl. */
	128	struct inode usnjrnl_max_ino; / Attribute inode for $UsnJrnl/$Max. */
	129	struct inode usnjrnl_j_ino; / Attribute inode for $UsnJrnl/$J. */
1da177e4 LT	130	#endif /* NTFS_RW */
	131	struct nls_table *nls_map;
	132	} ntfs_volume;
	133
	134	/*
	135	* Defined bits for the flags field in the ntfs_volume structure.
	136	*/
	137	typedef enum {
	138	NV_Errors, /* 1: Volume has errors, prevent remount rw. */
	139	NV_ShowSystemFiles, /* 1: Return system files in ntfs_readdir(). */
	140	NV_CaseSensitive, /* 1: Treat file names as case sensitive and
	141	create filenames in the POSIX namespace.
1cf3109f AA	142	Otherwise be case insensitive but still
1cf3109f AA	143	create file names in POSIX namespace. */
1da177e4 LT	144	NV_LogFileEmpty, /* 1: $LogFile journal is empty. */
1da177e4 LT	145	NV_QuotaOutOfDate, /* 1: $Quota is out of date. */
3f2faef0	146	NV_UsnJrnlStamped, /* 1: $UsnJrnl has been stamped. */
c002f425	147	NV_SparseEnabled, /* 1: May create sparse files. */
1da177e4 LT	148	} ntfs_volume_flags;
	149
	150	/*
	151	* Macro tricks to expand the NVolFoo(), NVolSetFoo(), and NVolClearFoo()
	152	* functions.
	153	*/
1cf3109f	154	#define DEFINE_NVOL_BIT_OPS(flag) \
1da177e4 LT	155	static inline int NVol##flag(ntfs_volume *vol) \
	156	{ \
	157	return test_bit(NV_##flag, &(vol)->flags); \
	158	} \
	159	static inline void NVolSet##flag(ntfs_volume *vol) \
	160	{ \
	161	set_bit(NV_##flag, &(vol)->flags); \
	162	} \
	163	static inline void NVolClear##flag(ntfs_volume *vol) \
	164	{ \
	165	clear_bit(NV_##flag, &(vol)->flags); \
	166	}
	167
	168	/* Emit the ntfs volume bitops functions. */
1cf3109f AA	169	DEFINE_NVOL_BIT_OPS(Errors)
	170	DEFINE_NVOL_BIT_OPS(ShowSystemFiles)
	171	DEFINE_NVOL_BIT_OPS(CaseSensitive)
	172	DEFINE_NVOL_BIT_OPS(LogFileEmpty)
	173	DEFINE_NVOL_BIT_OPS(QuotaOutOfDate)
	174	DEFINE_NVOL_BIT_OPS(UsnJrnlStamped)
	175	DEFINE_NVOL_BIT_OPS(SparseEnabled)
1da177e4 LT	176
1da177e4 LT	177	#endif /* _LINUX_NTFS_VOLUME_H */