[linux-2.6-block.git] / fs / jfs / jfs_filsys.h

/*
 *   Copyright (C) International Business Machines Corp., 2000-2003
 *
 *   This program 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 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;  if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */
#ifndef _H_JFS_FILSYS
#define _H_JFS_FILSYS

/*
 *	jfs_filsys.h
 *
 * file system (implementation-dependent) constants
 *
 * refer to <limits.h> for system wide implementation-dependent constants
 */

/*
 *	 file system option (superblock flag)
 */

/* directory option */
#define JFS_UNICODE	0x00000001	/* unicode name */

/* mount time flags for error handling */
#define JFS_ERR_REMOUNT_RO 0x00000002	/* remount read-only */
#define JFS_ERR_CONTINUE   0x00000004	/* continue */
#define JFS_ERR_PANIC      0x00000008	/* panic */

/* Quota support */
#define	JFS_USRQUOTA	0x00000010
#define	JFS_GRPQUOTA	0x00000020

/* mount time flag to disable journaling to disk */
#define JFS_NOINTEGRITY 0x00000040

/* mount time flag to enable TRIM to ssd disks */
#define JFS_DISCARD     0x00000080

/* commit option */
#define	JFS_COMMIT	0x00000f00	/* commit option mask */
#define	JFS_GROUPCOMMIT	0x00000100	/* group (of 1) commit */
#define	JFS_LAZYCOMMIT	0x00000200	/* lazy commit */
#define	JFS_TMPFS	0x00000400	/* temporary file system -
					 * do not log/commit:
					 * Never implemented
					 */

/* log logical volume option */
#define	JFS_INLINELOG	0x00000800	/* inline log within file system */
#define JFS_INLINEMOVE	0x00001000	/* inline log being moved */

/* Secondary aggregate inode table */
#define JFS_BAD_SAIT	0x00010000	/* current secondary ait is bad */

/* sparse regular file support */
#define JFS_SPARSE	0x00020000	/* sparse regular file */

/* DASD Limits		F226941 */
#define JFS_DASD_ENABLED 0x00040000	/* DASD limits enabled */
#define	JFS_DASD_PRIME	0x00080000	/* Prime DASD usage on boot */

/* big endian flag */
#define	JFS_SWAP_BYTES	0x00100000	/* running on big endian computer */

/* Directory index */
#define JFS_DIR_INDEX	0x00200000	/* Persistent index for */

/* platform options */
#define JFS_LINUX	0x10000000	/* Linux support */
#define JFS_DFS		0x20000000	/* DCE DFS LFS support */
/*	Never implemented */

#define JFS_OS2		0x40000000	/* OS/2 support */
/*	case-insensitive name/directory support */

#define JFS_AIX		0x80000000	/* AIX support */

/*
 *	buffer cache configuration
 */
/* page size */
#ifdef PSIZE
#undef PSIZE
#endif
#define	PSIZE		4096	/* page size (in byte) */
#define	L2PSIZE		12	/* log2(PSIZE) */
#define	POFFSET		4095	/* offset within page */

/* buffer page size */
#define BPSIZE	PSIZE

/*
 *	fs fundamental size
 *
 * PSIZE >= file system block size >= PBSIZE >= DISIZE
 */
#define	PBSIZE		512	/* physical block size (in byte) */
#define	L2PBSIZE	9	/* log2(PBSIZE) */

#define DISIZE		512	/* on-disk inode size (in byte) */
#define L2DISIZE	9	/* log2(DISIZE) */

#define IDATASIZE	256	/* inode inline data size */
#define	IXATTRSIZE	128	/* inode inline extended attribute size */

#define XTPAGE_SIZE	4096
#define log2_PAGESIZE	12

#define IAG_SIZE	4096
#define IAG_EXTENT_SIZE 4096
#define	INOSPERIAG	4096	/* number of disk inodes per iag */
#define	L2INOSPERIAG	12	/* l2 number of disk inodes per iag */
#define INOSPEREXT	32	/* number of disk inode per extent */
#define L2INOSPEREXT	5	/* l2 number of disk inode per extent */
#define	IXSIZE		(DISIZE * INOSPEREXT)	/* inode extent size */
#define	INOSPERPAGE	8	/* number of disk inodes per 4K page */
#define	L2INOSPERPAGE	3	/* log2(INOSPERPAGE) */

#define	IAGFREELIST_LWM	64

#define INODE_EXTENT_SIZE	IXSIZE	/* inode extent size */
#define NUM_INODE_PER_EXTENT	INOSPEREXT
#define NUM_INODE_PER_IAG	INOSPERIAG

#define MINBLOCKSIZE		512
#define MAXBLOCKSIZE		4096
#define	MAXFILESIZE		((s64)1 << 52)

#define JFS_LINK_MAX		0xffffffff

/* Minimum number of bytes supported for a JFS partition */
#define MINJFS			(0x1000000)
#define MINJFSTEXT		"16"

/*
 * file system block size -> physical block size
 */
#define LBOFFSET(x)	((x) & (PBSIZE - 1))
#define LBNUMBER(x)	((x) >> L2PBSIZE)
#define	LBLK2PBLK(sb,b)	((b) << (sb->s_blocksize_bits - L2PBSIZE))
#define	PBLK2LBLK(sb,b)	((b) >> (sb->s_blocksize_bits - L2PBSIZE))
/* size in byte -> last page number */
#define	SIZE2PN(size)	( ((s64)((size) - 1)) >> (L2PSIZE) )
/* size in byte -> last file system block number */
#define	SIZE2BN(size, l2bsize) ( ((s64)((size) - 1)) >> (l2bsize) )

/*
 * fixed physical block address (physical block size = 512 byte)
 *
 * NOTE: since we can't guarantee a physical block size of 512 bytes the use of
 *	 these macros should be removed and the byte offset macros used instead.
 */
#define SUPER1_B	64	/* primary superblock */
#define	AIMAP_B		(SUPER1_B + 8)	/* 1st extent of aggregate inode map */
#define	AITBL_B		(AIMAP_B + 16)	/*
					 * 1st extent of aggregate inode table
					 */
#define	SUPER2_B	(AITBL_B + 32)	/* 2ndary superblock pbn */
#define	BMAP_B		(SUPER2_B + 8)	/* block allocation map */

/*
 * SIZE_OF_SUPER defines the total amount of space reserved on disk for the
 * superblock.  This is not the same as the superblock structure, since all of
 * this space is not currently being used.
 */
#define SIZE_OF_SUPER	PSIZE

/*
 * SIZE_OF_AG_TABLE defines the amount of space reserved to hold the AG table
 */
#define SIZE_OF_AG_TABLE	PSIZE

/*
 * SIZE_OF_MAP_PAGE defines the amount of disk space reserved for each page of
 * the inode allocation map (to hold iag)
 */
#define SIZE_OF_MAP_PAGE	PSIZE

/*
 * fixed byte offset address
 */
#define SUPER1_OFF	0x8000	/* primary superblock */
#define AIMAP_OFF	(SUPER1_OFF + SIZE_OF_SUPER)
					/*
					 * Control page of aggregate inode map
					 * followed by 1st extent of map
					 */
#define AITBL_OFF	(AIMAP_OFF + (SIZE_OF_MAP_PAGE << 1))
					/*
					 * 1st extent of aggregate inode table
					 */
#define SUPER2_OFF	(AITBL_OFF + INODE_EXTENT_SIZE)
					/*
					 * secondary superblock
					 */
#define BMAP_OFF	(SUPER2_OFF + SIZE_OF_SUPER)
					/*
					 * block allocation map
					 */

/*
 * The following macro is used to indicate the number of reserved disk blocks at
 * the front of an aggregate, in terms of physical blocks.  This value is
 * currently defined to be 32K.  This turns out to be the same as the primary
 * superblock's address, since it directly follows the reserved blocks.
 */
#define AGGR_RSVD_BLOCKS	SUPER1_B

/*
 * The following macro is used to indicate the number of reserved bytes at the
 * front of an aggregate.  This value is currently defined to be 32K.  This
 * turns out to be the same as the primary superblock's byte offset, since it
 * directly follows the reserved blocks.
 */
#define AGGR_RSVD_BYTES	SUPER1_OFF

/*
 * The following macro defines the byte offset for the first inode extent in
 * the aggregate inode table.  This allows us to find the self inode to find the
 * rest of the table.  Currently this value is 44K.
 */
#define AGGR_INODE_TABLE_START	AITBL_OFF

/*
 *	fixed reserved inode number
 */
/* aggregate inode */
#define AGGR_RESERVED_I	0	/* aggregate inode (reserved) */
#define	AGGREGATE_I	1	/* aggregate inode map inode */
#define	BMAP_I		2	/* aggregate block allocation map inode */
#define	LOG_I		3	/* aggregate inline log inode */
#define BADBLOCK_I	4	/* aggregate bad block inode */
#define	FILESYSTEM_I	16	/* 1st/only fileset inode in ait:
				 * fileset inode map inode
				 */

/* per fileset inode */
#define FILESET_RSVD_I	0	/* fileset inode (reserved) */
#define FILESET_EXT_I	1	/* fileset inode extension */
#define	ROOT_I		2	/* fileset root inode */
#define ACL_I		3	/* fileset ACL inode */

#define FILESET_OBJECT_I 4	/* the first fileset inode available for a file
				 * or directory or link...
				 */
#define FIRST_FILESET_INO 16	/* the first aggregate inode which describes
				 * an inode.  (To fsck this is also the first
				 * inode in part 2 of the agg inode table.)
				 */

/*
 *	directory configuration
 */
#define JFS_NAME_MAX	255
#define JFS_PATH_MAX	BPSIZE


/*
 *	file system state (superblock state)
 */
#define FM_CLEAN 0x00000000	/* file system is unmounted and clean */
#define FM_MOUNT 0x00000001	/* file system is mounted cleanly */
#define FM_DIRTY 0x00000002	/* file system was not unmounted and clean
				 * when mounted or
				 * commit failure occurred while being mounted:
				 * fsck() must be run to repair
				 */
#define	FM_LOGREDO 0x00000004	/* log based recovery (logredo()) failed:
				 * fsck() must be run to repair
				 */
#define	FM_EXTENDFS 0x00000008	/* file system extendfs() in progress */

#endif				/* _H_JFS_FILSYS */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Copyright (C) International Business Machines Corp., 2000-2003
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License as published by
63f83c9f	6	* the Free Software Foundation; either version 2 of the License, or
1da177e4	7	* (at your option) any later version.
63f83c9f	8	*
1da177e4 LT	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
	12	* the GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
63f83c9f	15	* along with this program; if not, write to the Free Software
1da177e4 LT	16	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	17	*/
	18	#ifndef _H_JFS_FILSYS
	19	#define _H_JFS_FILSYS
	20
	21	/*
	22	* jfs_filsys.h
	23	*
63f83c9f	24	* file system (implementation-dependent) constants
1da177e4	25	*
63f83c9f	26	* refer to <limits.h> for system wide implementation-dependent constants
1da177e4 LT	27	*/
	28
	29	/*
	30	* file system option (superblock flag)
	31	*/
36b12fb7 DK	32
	33	/* directory option */
	34	#define JFS_UNICODE 0x00000001 /* unicode name */
1da177e4 LT	35
1da177e4 LT	36	/* mount time flags for error handling */
f720e3ba DK	37	#define JFS_ERR_REMOUNT_RO 0x00000002 /* remount read-only */
	38	#define JFS_ERR_CONTINUE 0x00000004 /* continue */
	39	#define JFS_ERR_PANIC 0x00000008 /* panic */
1da177e4	40
36b12fb7	41	/* Quota support */
8fc2751b MB	42	#define JFS_USRQUOTA 0x00000010
	43	#define JFS_GRPQUOTA 0x00000020
	44
36b12fb7 DK	45	/* mount time flag to disable journaling to disk */
36b12fb7 DK	46	#define JFS_NOINTEGRITY 0x00000040
1da177e4	47
b40c2e66 TR	48	/* mount time flag to enable TRIM to ssd disks */
	49	#define JFS_DISCARD 0x00000080
	50
1da177e4 LT	51	/* commit option */
	52	#define JFS_COMMIT 0x00000f00 /* commit option mask */
	53	#define JFS_GROUPCOMMIT 0x00000100 /* group (of 1) commit */
	54	#define JFS_LAZYCOMMIT 0x00000200 /* lazy commit */
63f83c9f	55	#define JFS_TMPFS 0x00000400 /* temporary file system -
1da177e4	56	* do not log/commit:
36b12fb7	57	* Never implemented
1da177e4 LT	58	*/
	59
	60	/* log logical volume option */
	61	#define JFS_INLINELOG 0x00000800 /* inline log within file system */
	62	#define JFS_INLINEMOVE 0x00001000 /* inline log being moved */
	63
	64	/* Secondary aggregate inode table */
	65	#define JFS_BAD_SAIT 0x00010000 /* current secondary ait is bad */
	66
	67	/* sparse regular file support */
	68	#define JFS_SPARSE 0x00020000 /* sparse regular file */
	69
	70	/* DASD Limits F226941 */
36b12fb7 DK	71	#define JFS_DASD_ENABLED 0x00040000 /* DASD limits enabled */
36b12fb7 DK	72	#define JFS_DASD_PRIME 0x00080000 /* Prime DASD usage on boot */
1da177e4 LT	73
1da177e4 LT	74	/* big endian flag */
36b12fb7	75	#define JFS_SWAP_BYTES 0x00100000 /* running on big endian computer */
1da177e4 LT	76
1da177e4 LT	77	/* Directory index */
36b12fb7	78	#define JFS_DIR_INDEX 0x00200000 /* Persistent index for */
1da177e4	79
36b12fb7 DK	80	/* platform options */
	81	#define JFS_LINUX 0x10000000 /* Linux support */
	82	#define JFS_DFS 0x20000000 /* DCE DFS LFS support */
	83	/* Never implemented */
	84
	85	#define JFS_OS2 0x40000000 /* OS/2 support */
	86	/* case-insensitive name/directory support */
	87
	88	#define JFS_AIX 0x80000000 /* AIX support */
1da177e4 LT	89
	90	/*
	91	* buffer cache configuration
	92	*/
	93	/* page size */
	94	#ifdef PSIZE
	95	#undef PSIZE
	96	#endif
	97	#define PSIZE 4096 /* page size (in byte) */
	98	#define L2PSIZE 12 /* log2(PSIZE) */
	99	#define POFFSET 4095 /* offset within page */
	100
	101	/* buffer page size */
	102	#define BPSIZE PSIZE
	103
	104	/*
	105	* fs fundamental size
	106	*
	107	* PSIZE >= file system block size >= PBSIZE >= DISIZE
	108	*/
	109	#define PBSIZE 512 /* physical block size (in byte) */
	110	#define L2PBSIZE 9 /* log2(PBSIZE) */
	111
	112	#define DISIZE 512 /* on-disk inode size (in byte) */
	113	#define L2DISIZE 9 /* log2(DISIZE) */
	114
	115	#define IDATASIZE 256 /* inode inline data size */
	116	#define IXATTRSIZE 128 /* inode inline extended attribute size */
	117
f720e3ba DK	118	#define XTPAGE_SIZE 4096
f720e3ba DK	119	#define log2_PAGESIZE 12
1da177e4	120
f720e3ba	121	#define IAG_SIZE 4096
1da177e4 LT	122	#define IAG_EXTENT_SIZE 4096
	123	#define INOSPERIAG 4096 /* number of disk inodes per iag */
	124	#define L2INOSPERIAG 12 /* l2 number of disk inodes per iag */
	125	#define INOSPEREXT 32 /* number of disk inode per extent */
	126	#define L2INOSPEREXT 5 /* l2 number of disk inode per extent */
	127	#define IXSIZE (DISIZE * INOSPEREXT) /* inode extent size */
	128	#define INOSPERPAGE 8 /* number of disk inodes per 4K page */
	129	#define L2INOSPERPAGE 3 /* log2(INOSPERPAGE) */
	130
	131	#define IAGFREELIST_LWM 64
	132
	133	#define INODE_EXTENT_SIZE IXSIZE /* inode extent size */
	134	#define NUM_INODE_PER_EXTENT INOSPEREXT
	135	#define NUM_INODE_PER_IAG INOSPERIAG
	136
	137	#define MINBLOCKSIZE 512
	138	#define MAXBLOCKSIZE 4096
	139	#define MAXFILESIZE ((s64)1 << 52)
	140
	141	#define JFS_LINK_MAX 0xffffffff
	142
	143	/* Minimum number of bytes supported for a JFS partition */
	144	#define MINJFS (0x1000000)
	145	#define MINJFSTEXT "16"
	146
	147	/*
	148	* file system block size -> physical block size
	149	*/
	150	#define LBOFFSET(x) ((x) & (PBSIZE - 1))
	151	#define LBNUMBER(x) ((x) >> L2PBSIZE)
	152	#define LBLK2PBLK(sb,b) ((b) << (sb->s_blocksize_bits - L2PBSIZE))
	153	#define PBLK2LBLK(sb,b) ((b) >> (sb->s_blocksize_bits - L2PBSIZE))
	154	/* size in byte -> last page number */
	155	#define SIZE2PN(size) ( ((s64)((size) - 1)) >> (L2PSIZE) )
	156	/* size in byte -> last file system block number */
	157	#define SIZE2BN(size, l2bsize) ( ((s64)((size) - 1)) >> (l2bsize) )
	158
	159	/*
	160	* fixed physical block address (physical block size = 512 byte)
	161	*
	162	* NOTE: since we can't guarantee a physical block size of 512 bytes the use of
	163	* these macros should be removed and the byte offset macros used instead.
	164	*/
	165	#define SUPER1_B 64 /* primary superblock */
	166	#define AIMAP_B (SUPER1_B + 8) /* 1st extent of aggregate inode map */
	167	#define AITBL_B (AIMAP_B + 16) /*
	168	* 1st extent of aggregate inode table
	169	*/
	170	#define SUPER2_B (AITBL_B + 32) /* 2ndary superblock pbn */
	171	#define BMAP_B (SUPER2_B + 8) /* block allocation map */
	172
	173	/*
	174	* SIZE_OF_SUPER defines the total amount of space reserved on disk for the
	175	* superblock. This is not the same as the superblock structure, since all of
	176	* this space is not currently being used.
	177	*/
	178	#define SIZE_OF_SUPER PSIZE
	179
	180	/*
	181	* SIZE_OF_AG_TABLE defines the amount of space reserved to hold the AG table
	182	*/
	183	#define SIZE_OF_AG_TABLE PSIZE
	184
	185	/*
186	* SIZE_OF_MAP_PAGE defines the amount of disk space reserved for each page of
187	* the inode allocation map (to hold iag)
188	*/
189	#define SIZE_OF_MAP_PAGE PSIZE
190
191	/*
192	* fixed byte offset address
193	*/
194	#define SUPER1_OFF 0x8000 /* primary superblock */
195	#define AIMAP_OFF (SUPER1_OFF + SIZE_OF_SUPER)
196	/*
197	* Control page of aggregate inode map
198	* followed by 1st extent of map
199	*/
200	#define AITBL_OFF (AIMAP_OFF + (SIZE_OF_MAP_PAGE << 1))
63f83c9f	201	/*
1da177e4 LT	202	* 1st extent of aggregate inode table
	203	*/
	204	#define SUPER2_OFF (AITBL_OFF + INODE_EXTENT_SIZE)
	205	/*
	206	* secondary superblock
	207	*/
	208	#define BMAP_OFF (SUPER2_OFF + SIZE_OF_SUPER)
	209	/*
	210	* block allocation map
	211	*/
	212
	213	/*
	214	* The following macro is used to indicate the number of reserved disk blocks at
	215	* the front of an aggregate, in terms of physical blocks. This value is
	216	* currently defined to be 32K. This turns out to be the same as the primary
	217	* superblock's address, since it directly follows the reserved blocks.
	218	*/
	219	#define AGGR_RSVD_BLOCKS SUPER1_B
	220
	221	/*
	222	* The following macro is used to indicate the number of reserved bytes at the
	223	* front of an aggregate. This value is currently defined to be 32K. This
	224	* turns out to be the same as the primary superblock's byte offset, since it
	225	* directly follows the reserved blocks.
	226	*/
	227	#define AGGR_RSVD_BYTES SUPER1_OFF
	228
	229	/*
	230	* The following macro defines the byte offset for the first inode extent in
	231	* the aggregate inode table. This allows us to find the self inode to find the
	232	* rest of the table. Currently this value is 44K.
	233	*/
	234	#define AGGR_INODE_TABLE_START AITBL_OFF
	235
	236	/*
	237	* fixed reserved inode number
	238	*/
	239	/* aggregate inode */
	240	#define AGGR_RESERVED_I 0 /* aggregate inode (reserved) */
	241	#define AGGREGATE_I 1 /* aggregate inode map inode */
	242	#define BMAP_I 2 /* aggregate block allocation map inode */
	243	#define LOG_I 3 /* aggregate inline log inode */
	244	#define BADBLOCK_I 4 /* aggregate bad block inode */
	245	#define FILESYSTEM_I 16 /* 1st/only fileset inode in ait:
	246	* fileset inode map inode
	247	*/
	248
	249	/* per fileset inode */
	250	#define FILESET_RSVD_I 0 /* fileset inode (reserved) */
	251	#define FILESET_EXT_I 1 /* fileset inode extension */
	252	#define ROOT_I 2 /* fileset root inode */
	253	#define ACL_I 3 /* fileset ACL inode */
	254
	255	#define FILESET_OBJECT_I 4 /* the first fileset inode available for a file
	256	* or directory or link...
	257	*/
	258	#define FIRST_FILESET_INO 16 /* the first aggregate inode which describes
	259	* an inode. (To fsck this is also the first
	260	* inode in part 2 of the agg inode table.)
	261	*/
	262
	263	/*
	264	* directory configuration
	265	*/
266	#define JFS_NAME_MAX 255
267	#define JFS_PATH_MAX BPSIZE
268
269
270	/*
271	* file system state (superblock state)
272	*/
273	#define FM_CLEAN 0x00000000 /* file system is unmounted and clean */
274	#define FM_MOUNT 0x00000001 /* file system is mounted cleanly */
63f83c9f DK	275	#define FM_DIRTY 0x00000002 /* file system was not unmounted and clean
63f83c9f DK	276	* when mounted or
1da177e4	277	* commit failure occurred while being mounted:
63f83c9f	278	* fsck() must be run to repair
1da177e4 LT	279	*/
1da177e4 LT	280	#define FM_LOGREDO 0x00000004 /* log based recovery (logredo()) failed:
63f83c9f	281	* fsck() must be run to repair
1da177e4 LT	282	*/
	283	#define FM_EXTENDFS 0x00000008 /* file system extendfs() in progress */
	284
	285	#endif /* _H_JFS_FILSYS */