1/*
2 *   Copyright (C) International Business Machines Corp., 2000-2004
3 *   Portions Copyright (C) Christoph Hellwig, 2001-2002
4 *
5 *   This program is free software;  you can redistribute it and/or modify
6 *   it under the terms of the GNU General Public License as published by
7 *   the Free Software Foundation; either version 2 of the License, or
8 *   (at your option) any later version.
9 *
10 *   This program is distributed in the hope that it will be useful,
11 *   but WITHOUT ANY WARRANTY;  without even the implied warranty of
12 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
13 *   the GNU General Public License for more details.
14 *
15 *   You should have received a copy of the GNU General Public License
16 *   along with this program;  if not, write to the Free Software
17 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 */
19#ifndef _H_JFS_INCORE
20#define _H_JFS_INCORE
21
22#include <linux/mutex.h>
23#include <linux/rwsem.h>
24#include <linux/slab.h>
25#include <linux/bitops.h>
26#include "jfs_types.h"
27#include "jfs_xtree.h"
28#include "jfs_dtree.h"
29
30/*
31 * JFS magic number
32 */
33#define JFS_SUPER_MAGIC 0x3153464a /* "JFS1" */
34
35/*
36 * JFS-private inode information
37 */
38struct jfs_inode_info {
39	int	fileset;	/* fileset number (always 16)*/
40	uint	mode2;		/* jfs-specific mode		*/
41	uint	saved_uid;	/* saved for uid mount option */
42	uint	saved_gid;	/* saved for gid mount option */
43	pxd_t	ixpxd;		/* inode extent descriptor	*/
44	dxd_t	acl;		/* dxd describing acl	*/
45	dxd_t	ea;		/* dxd describing ea	*/
46	time_t	otime;		/* time created	*/
47	uint	next_index;	/* next available directory entry index */
48	int	acltype;	/* Type of ACL	*/
49	short	btorder;	/* access order	*/
50	short	btindex;	/* btpage entry index*/
51	struct inode *ipimap;	/* inode map			*/
52	unsigned long cflag;	/* commit flags		*/
53	u16	bxflag;		/* xflag of pseudo buffer?	*/
54	unchar	agno;		/* ag number			*/
55	signed char active_ag;	/* ag currently allocating from	*/
56	lid_t	blid;		/* lid of pseudo buffer?	*/
57	lid_t	atlhead;	/* anonymous tlock list head	*/
58	lid_t	atltail;	/* anonymous tlock list tail	*/
59	spinlock_t ag_lock;	/* protects active_ag		*/
60	struct list_head anon_inode_list; /* inodes having anonymous txns */
61	/*
62	 * rdwrlock serializes xtree between reads & writes and synchronizes
63	 * changes to special inodes.  It's use would be redundant on
64	 * directories since the i_mutex taken in the VFS is sufficient.
65	 */
66	struct rw_semaphore rdwrlock;
67	/*
68	 * commit_mutex serializes transaction processing on an inode.
69	 * It must be taken after beginning a transaction (txBegin), since
70	 * dirty inodes may be committed while a new transaction on the
71	 * inode is blocked in txBegin or TxBeginAnon
72	 */
73	struct mutex commit_mutex;
74	/* xattr_sem allows us to access the xattrs without taking i_mutex */
75	struct rw_semaphore xattr_sem;
76	lid_t	xtlid;		/* lid of xtree lock on directory */
77	union {
78		struct {
79			xtpage_t _xtroot;	/* 288: xtree root */
80			struct inomap *_imap;	/* 4: inode map header	*/
81		} file;
82		struct {
83			struct dir_table_slot _table[12]; /* 96: dir index */
84			dtroot_t _dtroot;	/* 288: dtree root */
85		} dir;
86		struct {
87			unchar _unused[16];	/* 16: */
88			dxd_t _dxd;		/* 16: */
89			unchar _inline[128];	/* 128: inline symlink */
90			/* _inline_ea may overlay the last part of
91			 * file._xtroot if maxentry = XTROOTINITSLOT
92			 */
93			unchar _inline_ea[128];	/* 128: inline extended attr */
94		} link;
95	} u;
96	u32 dev;	/* will die when we get wide dev_t */
97	struct inode	vfs_inode;
98};
99#define i_xtroot u.file._xtroot
100#define i_imap u.file._imap
101#define i_dirtable u.dir._table
102#define i_dtroot u.dir._dtroot
103#define i_inline u.link._inline
104#define i_inline_ea u.link._inline_ea
105
106#define IREAD_LOCK(ip, subclass) \
107	down_read_nested(&JFS_IP(ip)->rdwrlock, subclass)
108#define IREAD_UNLOCK(ip)	up_read(&JFS_IP(ip)->rdwrlock)
109#define IWRITE_LOCK(ip, subclass) \
110	down_write_nested(&JFS_IP(ip)->rdwrlock, subclass)
111#define IWRITE_UNLOCK(ip)	up_write(&JFS_IP(ip)->rdwrlock)
112
113/*
114 * cflag
115 */
116enum cflags {
117	COMMIT_Nolink,		/* inode committed with zero link count */
118	COMMIT_Inlineea,	/* commit inode inline EA */
119	COMMIT_Freewmap,	/* free WMAP at iClose() */
120	COMMIT_Dirty,		/* Inode is really dirty */
121	COMMIT_Dirtable,	/* commit changes to di_dirtable */
122	COMMIT_Stale,		/* data extent is no longer valid */
123	COMMIT_Synclist,	/* metadata pages on group commit synclist */
124};
125
126/*
127 * commit_mutex nesting subclasses:
128 */
129enum commit_mutex_class
130{
131	COMMIT_MUTEX_PARENT,
132	COMMIT_MUTEX_CHILD,
133	COMMIT_MUTEX_SECOND_PARENT,	/* Renaming */
134	COMMIT_MUTEX_VICTIM		/* Inode being unlinked due to rename */
135};
136
137/*
138 * rdwrlock subclasses:
139 * The dmap inode may be locked while a normal inode or the imap inode are
140 * locked.
141 */
142enum rdwrlock_class
143{
144	RDWRLOCK_NORMAL,
145	RDWRLOCK_IMAP,
146	RDWRLOCK_DMAP
147};
148
149#define set_cflag(flag, ip)	set_bit(flag, &(JFS_IP(ip)->cflag))
150#define clear_cflag(flag, ip)	clear_bit(flag, &(JFS_IP(ip)->cflag))
151#define test_cflag(flag, ip)	test_bit(flag, &(JFS_IP(ip)->cflag))
152#define test_and_clear_cflag(flag, ip) \
153	test_and_clear_bit(flag, &(JFS_IP(ip)->cflag))
154/*
155 * JFS-private superblock information.
156 */
157struct jfs_sb_info {
158	struct super_block *sb;		/* Point back to vfs super block */
159	unsigned long	mntflag;	/* aggregate attributes	*/
160	struct inode	*ipbmap;	/* block map inode		*/
161	struct inode	*ipaimap;	/* aggregate inode map inode	*/
162	struct inode	*ipaimap2;	/* secondary aimap inode	*/
163	struct inode	*ipimap;	/* aggregate inode map inode	*/
164	struct jfs_log	*log;		/* log			*/
165	struct list_head log_list;	/* volumes associated with a journal */
166	short		bsize;		/* logical block size	*/
167	short		l2bsize;	/* log2 logical block size	*/
168	short		nbperpage;	/* blocks per page		*/
169	short		l2nbperpage;	/* log2 blocks per page	*/
170	short		l2niperblk;	/* log2 inodes per page	*/
171	dev_t		logdev;		/* external log device	*/
172	uint		aggregate;	/* volume identifier in log record */
173	pxd_t		logpxd;		/* pxd describing log	*/
174	pxd_t		fsckpxd;	/* pxd describing fsck wkspc */
175	pxd_t		ait2;		/* pxd describing AIT copy	*/
176	char		uuid[16];	/* 128-bit uuid for volume	*/
177	char		loguuid[16];	/* 128-bit uuid for log	*/
178	/*
179	 * commit_state is used for synchronization of the jfs_commit
180	 * threads.  It is protected by LAZY_LOCK().
181	 */
182	int		commit_state;	/* commit state */
183	/* Formerly in ipimap */
184	uint		gengen;		/* inode generation generator*/
185	uint		inostamp;	/* shows inode belongs to fileset*/
186
187	/* Formerly in ipbmap */
188	struct bmap	*bmap;		/* incore bmap descriptor	*/
189	struct nls_table *nls_tab;	/* current codepage		*/
190	struct inode *direct_inode;	/* metadata inode */
191	uint		state;		/* mount/recovery state	*/
192	unsigned long	flag;		/* mount time flags */
193	uint		p_state;	/* state prior to going no integrity */
194	uint		uid;		/* uid to override on-disk uid */
195	uint		gid;		/* gid to override on-disk gid */
196	uint		umask;		/* umask to override on-disk umask */
197};
198
199/* jfs_sb_info commit_state */
200#define IN_LAZYCOMMIT 1
201
202static inline struct jfs_inode_info *JFS_IP(struct inode *inode)
203{
204	return list_entry(inode, struct jfs_inode_info, vfs_inode);
205}
206
207static inline int jfs_dirtable_inline(struct inode *inode)
208{
209	return (JFS_IP(inode)->next_index <= (MAX_INLINE_DIRTABLE_ENTRY + 1));
210}
211
212static inline struct jfs_sb_info *JFS_SBI(struct super_block *sb)
213{
214	return sb->s_fs_info;
215}
216
217static inline int isReadOnly(struct inode *inode)
218{
219	if (JFS_SBI(inode->i_sb)->log)
220		return 0;
221	return 1;
222}
223#endif /* _H_JFS_INCORE */
224