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 */
27 struct 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 */
110 enum 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 */
123 enum 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 */
136 enum 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 */
151 struct 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
197 static inline struct jfs_inode_info *JFS_IP(struct inode *inode)
198 {
199 return container_of(inode, struct jfs_inode_info, vfs_inode);
200 }
201
202 static inline int jfs_dirtable_inline(struct inode *inode)
203 {
204 return (JFS_IP(inode)->next_index <= (MAX_INLINE_DIRTABLE_ENTRY + 1));
205 }
206
207 static inline struct jfs_sb_info *JFS_SBI(struct super_block *sb)
208 {
209 return sb->s_fs_info;
210 }
211
212 static 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 */