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

 
  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	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			unchar _inline[128];	/* 128: inline symlink */
 91			/* _inline_ea may overlay the last part of
 92			 * file._xtroot if maxentry = XTROOTINITSLOT
 93			 */
 94			unchar _inline_ea[128];	/* 128: inline extended attr */
 95		} link;
 96	} u;
 
 
 
 97	u32 dev;	/* will die when we get wide dev_t */
 98	struct inode	vfs_inode;
 99};
100#define i_xtroot u.file._xtroot
101#define i_imap u.file._imap
102#define i_dirtable u.dir._table
103#define i_dtroot u.dir._dtroot
104#define i_inline u.link._inline
105#define i_inline_ea u.link._inline_ea
106
107#define IREAD_LOCK(ip, subclass) \
108	down_read_nested(&JFS_IP(ip)->rdwrlock, subclass)
109#define IREAD_UNLOCK(ip)	up_read(&JFS_IP(ip)->rdwrlock)
110#define IWRITE_LOCK(ip, subclass) \
111	down_write_nested(&JFS_IP(ip)->rdwrlock, subclass)
112#define IWRITE_UNLOCK(ip)	up_write(&JFS_IP(ip)->rdwrlock)
113
114/*
115 * cflag
116 */
117enum cflags {
118	COMMIT_Nolink,		/* inode committed with zero link count */
119	COMMIT_Inlineea,	/* commit inode inline EA */
120	COMMIT_Freewmap,	/* free WMAP at iClose() */
121	COMMIT_Dirty,		/* Inode is really dirty */
122	COMMIT_Dirtable,	/* commit changes to di_dirtable */
123	COMMIT_Stale,		/* data extent is no longer valid */
124	COMMIT_Synclist,	/* metadata pages on group commit synclist */
125};
126
127/*
128 * commit_mutex nesting subclasses:
129 */
130enum commit_mutex_class
131{
132	COMMIT_MUTEX_PARENT,
133	COMMIT_MUTEX_CHILD,
134	COMMIT_MUTEX_SECOND_PARENT,	/* Renaming */
135	COMMIT_MUTEX_VICTIM		/* Inode being unlinked due to rename */
136};
137
138/*
139 * rdwrlock subclasses:
140 * The dmap inode may be locked while a normal inode or the imap inode are
141 * locked.
142 */
143enum rdwrlock_class
144{
145	RDWRLOCK_NORMAL,
146	RDWRLOCK_IMAP,
147	RDWRLOCK_DMAP
148};
149
150#define set_cflag(flag, ip)	set_bit(flag, &(JFS_IP(ip)->cflag))
151#define clear_cflag(flag, ip)	clear_bit(flag, &(JFS_IP(ip)->cflag))
152#define test_cflag(flag, ip)	test_bit(flag, &(JFS_IP(ip)->cflag))
153#define test_and_clear_cflag(flag, ip) \
154	test_and_clear_bit(flag, &(JFS_IP(ip)->cflag))
155/*
156 * JFS-private superblock information.
157 */
158struct jfs_sb_info {
159	struct super_block *sb;		/* Point back to vfs super block */
160	unsigned long	mntflag;	/* aggregate attributes	*/
161	struct inode	*ipbmap;	/* block map inode		*/
162	struct inode	*ipaimap;	/* aggregate inode map inode	*/
163	struct inode	*ipaimap2;	/* secondary aimap inode	*/
164	struct inode	*ipimap;	/* aggregate inode map inode	*/
165	struct jfs_log	*log;		/* log			*/
166	struct list_head log_list;	/* volumes associated with a journal */
167	short		bsize;		/* logical block size	*/
168	short		l2bsize;	/* log2 logical block size	*/
169	short		nbperpage;	/* blocks per page		*/
170	short		l2nbperpage;	/* log2 blocks per page	*/
171	short		l2niperblk;	/* log2 inodes per page	*/
172	dev_t		logdev;		/* external log device	*/
173	uint		aggregate;	/* volume identifier in log record */
174	pxd_t		logpxd;		/* pxd describing log	*/
175	pxd_t		fsckpxd;	/* pxd describing fsck wkspc */
176	pxd_t		ait2;		/* pxd describing AIT copy	*/
177	char		uuid[16];	/* 128-bit uuid for volume	*/
178	char		loguuid[16];	/* 128-bit uuid for log	*/
179	/*
180	 * commit_state is used for synchronization of the jfs_commit
181	 * threads.  It is protected by LAZY_LOCK().
182	 */
183	int		commit_state;	/* commit state */
184	/* Formerly in ipimap */
185	uint		gengen;		/* inode generation generator*/
186	uint		inostamp;	/* shows inode belongs to fileset*/
187
188	/* Formerly in ipbmap */
189	struct bmap	*bmap;		/* incore bmap descriptor	*/
190	struct nls_table *nls_tab;	/* current codepage		*/
191	struct inode *direct_inode;	/* metadata inode */
192	uint		state;		/* mount/recovery state	*/
193	unsigned long	flag;		/* mount time flags */
194	uint		p_state;	/* state prior to going no integrity */
195	uint		uid;		/* uid to override on-disk uid */
196	uint		gid;		/* gid to override on-disk gid */
197	uint		umask;		/* umask to override on-disk umask */
 
198};
199
200/* jfs_sb_info commit_state */
201#define IN_LAZYCOMMIT 1
202
203static inline struct jfs_inode_info *JFS_IP(struct inode *inode)
204{
205	return list_entry(inode, struct jfs_inode_info, vfs_inode);
206}
207
208static inline int jfs_dirtable_inline(struct inode *inode)
209{
210	return (JFS_IP(inode)->next_index <= (MAX_INLINE_DIRTABLE_ENTRY + 1));
211}
212
213static inline struct jfs_sb_info *JFS_SBI(struct super_block *sb)
214{
215	return sb->s_fs_info;
216}
217
218static inline int isReadOnly(struct inode *inode)
219{
220	if (JFS_SBI(inode->i_sb)->log)
221		return 0;
222	return 1;
223}
224#endif /* _H_JFS_INCORE */