xref: /openbmc/linux/fs/jfs/jfs_incore.h (revision 9be08a27)
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  */
38 struct jfs_inode_info {
39 	int	fileset;	/* fileset number (always 16)*/
40 	uint	mode2;		/* jfs-specific mode		*/
41 	kuid_t	saved_uid;	/* saved for uid mount option */
42 	kgid_t	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 	time64_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 	u64	agstart;	/* agstart of the containing IAG */
54 	u16	bxflag;		/* xflag of pseudo buffer?	*/
55 	unchar	pad;
56 	signed char active_ag;	/* ag currently allocating from	*/
57 	lid_t	blid;		/* lid of pseudo buffer?	*/
58 	lid_t	atlhead;	/* anonymous tlock list head	*/
59 	lid_t	atltail;	/* anonymous tlock list tail	*/
60 	spinlock_t ag_lock;	/* protects active_ag		*/
61 	struct list_head anon_inode_list; /* inodes having anonymous txns */
62 	/*
63 	 * rdwrlock serializes xtree between reads & writes and synchronizes
64 	 * changes to special inodes.  It's use would be redundant on
65 	 * directories since the i_mutex taken in the VFS is sufficient.
66 	 */
67 	struct rw_semaphore rdwrlock;
68 	/*
69 	 * commit_mutex serializes transaction processing on an inode.
70 	 * It must be taken after beginning a transaction (txBegin), since
71 	 * dirty inodes may be committed while a new transaction on the
72 	 * inode is blocked in txBegin or TxBeginAnon
73 	 */
74 	struct mutex commit_mutex;
75 	/* xattr_sem allows us to access the xattrs without taking i_mutex */
76 	struct rw_semaphore xattr_sem;
77 	lid_t	xtlid;		/* lid of xtree lock on directory */
78 	union {
79 		struct {
80 			xtpage_t _xtroot;	/* 288: xtree root */
81 			struct inomap *_imap;	/* 4: inode map header	*/
82 		} file;
83 		struct {
84 			struct dir_table_slot _table[12]; /* 96: dir index */
85 			dtroot_t _dtroot;	/* 288: dtree root */
86 		} dir;
87 		struct {
88 			unchar _unused[16];	/* 16: */
89 			dxd_t _dxd;		/* 16: */
90 			/* _inline may overflow into _inline_ea when needed */
91 			unchar _inline[128];	/* 128: inline symlink */
92 			/* _inline_ea may overlay the last part of
93 			 * file._xtroot if maxentry = XTROOTINITSLOT
94 			 */
95 			unchar _inline_ea[128];	/* 128: inline extended attr */
96 		} link;
97 	} u;
98 #ifdef CONFIG_QUOTA
99 	struct dquot *i_dquot[MAXQUOTAS];
100 #endif
101 	u32 dev;	/* will die when we get wide dev_t */
102 	struct inode	vfs_inode;
103 };
104 #define i_xtroot u.file._xtroot
105 #define i_imap u.file._imap
106 #define i_dirtable u.dir._table
107 #define i_dtroot u.dir._dtroot
108 #define i_inline u.link._inline
109 #define i_inline_ea u.link._inline_ea
110 
111 #define IREAD_LOCK(ip, subclass) \
112 	down_read_nested(&JFS_IP(ip)->rdwrlock, subclass)
113 #define IREAD_UNLOCK(ip)	up_read(&JFS_IP(ip)->rdwrlock)
114 #define IWRITE_LOCK(ip, subclass) \
115 	down_write_nested(&JFS_IP(ip)->rdwrlock, subclass)
116 #define IWRITE_UNLOCK(ip)	up_write(&JFS_IP(ip)->rdwrlock)
117 
118 /*
119  * cflag
120  */
121 enum cflags {
122 	COMMIT_Nolink,		/* inode committed with zero link count */
123 	COMMIT_Inlineea,	/* commit inode inline EA */
124 	COMMIT_Freewmap,	/* free WMAP at iClose() */
125 	COMMIT_Dirty,		/* Inode is really dirty */
126 	COMMIT_Dirtable,	/* commit changes to di_dirtable */
127 	COMMIT_Stale,		/* data extent is no longer valid */
128 	COMMIT_Synclist,	/* metadata pages on group commit synclist */
129 };
130 
131 /*
132  * commit_mutex nesting subclasses:
133  */
134 enum commit_mutex_class
135 {
136 	COMMIT_MUTEX_PARENT,
137 	COMMIT_MUTEX_CHILD,
138 	COMMIT_MUTEX_SECOND_PARENT,	/* Renaming */
139 	COMMIT_MUTEX_VICTIM		/* Inode being unlinked due to rename */
140 };
141 
142 /*
143  * rdwrlock subclasses:
144  * The dmap inode may be locked while a normal inode or the imap inode are
145  * locked.
146  */
147 enum rdwrlock_class
148 {
149 	RDWRLOCK_NORMAL,
150 	RDWRLOCK_IMAP,
151 	RDWRLOCK_DMAP
152 };
153 
154 #define set_cflag(flag, ip)	set_bit(flag, &(JFS_IP(ip)->cflag))
155 #define clear_cflag(flag, ip)	clear_bit(flag, &(JFS_IP(ip)->cflag))
156 #define test_cflag(flag, ip)	test_bit(flag, &(JFS_IP(ip)->cflag))
157 #define test_and_clear_cflag(flag, ip) \
158 	test_and_clear_bit(flag, &(JFS_IP(ip)->cflag))
159 /*
160  * JFS-private superblock information.
161  */
162 struct jfs_sb_info {
163 	struct super_block *sb;		/* Point back to vfs super block */
164 	unsigned long	mntflag;	/* aggregate attributes	*/
165 	struct inode	*ipbmap;	/* block map inode		*/
166 	struct inode	*ipaimap;	/* aggregate inode map inode	*/
167 	struct inode	*ipaimap2;	/* secondary aimap inode	*/
168 	struct inode	*ipimap;	/* aggregate inode map inode	*/
169 	struct jfs_log	*log;		/* log			*/
170 	struct list_head log_list;	/* volumes associated with a journal */
171 	short		bsize;		/* logical block size	*/
172 	short		l2bsize;	/* log2 logical block size	*/
173 	short		nbperpage;	/* blocks per page		*/
174 	short		l2nbperpage;	/* log2 blocks per page	*/
175 	short		l2niperblk;	/* log2 inodes per page	*/
176 	dev_t		logdev;		/* external log device	*/
177 	uint		aggregate;	/* volume identifier in log record */
178 	pxd_t		logpxd;		/* pxd describing log	*/
179 	pxd_t		fsckpxd;	/* pxd describing fsck wkspc */
180 	pxd_t		ait2;		/* pxd describing AIT copy	*/
181 	char		uuid[16];	/* 128-bit uuid for volume	*/
182 	char		loguuid[16];	/* 128-bit uuid for log	*/
183 	/*
184 	 * commit_state is used for synchronization of the jfs_commit
185 	 * threads.  It is protected by LAZY_LOCK().
186 	 */
187 	int		commit_state;	/* commit state */
188 	/* Formerly in ipimap */
189 	uint		gengen;		/* inode generation generator*/
190 	uint		inostamp;	/* shows inode belongs to fileset*/
191 
192 	/* Formerly in ipbmap */
193 	struct bmap	*bmap;		/* incore bmap descriptor	*/
194 	struct nls_table *nls_tab;	/* current codepage		*/
195 	struct inode *direct_inode;	/* metadata inode */
196 	uint		state;		/* mount/recovery state	*/
197 	unsigned long	flag;		/* mount time flags */
198 	uint		p_state;	/* state prior to going no integrity */
199 	kuid_t		uid;		/* uid to override on-disk uid */
200 	kgid_t		gid;		/* gid to override on-disk gid */
201 	uint		umask;		/* umask to override on-disk umask */
202 	uint		minblks_trim;	/* minimum blocks, for online trim */
203 };
204 
205 /* jfs_sb_info commit_state */
206 #define IN_LAZYCOMMIT 1
207 
208 static inline struct jfs_inode_info *JFS_IP(struct inode *inode)
209 {
210 	return container_of(inode, struct jfs_inode_info, vfs_inode);
211 }
212 
213 static inline int jfs_dirtable_inline(struct inode *inode)
214 {
215 	return (JFS_IP(inode)->next_index <= (MAX_INLINE_DIRTABLE_ENTRY + 1));
216 }
217 
218 static inline struct jfs_sb_info *JFS_SBI(struct super_block *sb)
219 {
220 	return sb->s_fs_info;
221 }
222 
223 static inline int isReadOnly(struct inode *inode)
224 {
225 	if (JFS_SBI(inode->i_sb)->log)
226 		return 0;
227 	return 1;
228 }
229 #endif /* _H_JFS_INCORE */
230