Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
7b718769 NS |
2 | * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc. |
3 | * All Rights Reserved. | |
1da177e4 | 4 | * |
7b718769 NS |
5 | * This program is free software; you can redistribute it and/or |
6 | * modify it under the terms of the GNU General Public License as | |
1da177e4 LT |
7 | * published by the Free Software Foundation. |
8 | * | |
7b718769 NS |
9 | * This program is distributed in the hope that it would be useful, |
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | * GNU General Public License for more details. | |
1da177e4 | 13 | * |
7b718769 NS |
14 | * You should have received a copy of the GNU General Public License |
15 | * along with this program; if not, write the Free Software Foundation, | |
16 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
1da177e4 LT |
17 | */ |
18 | #ifndef __XFS_INODE_H__ | |
19 | #define __XFS_INODE_H__ | |
20 | ||
1fd7115e | 21 | #include "xfs_inode_buf.h" |
5c4d97d0 | 22 | #include "xfs_inode_fork.h" |
1da177e4 | 23 | |
92bfc6e7 | 24 | /* |
1fd7115e | 25 | * Kernel only inode definitions |
92bfc6e7 | 26 | */ |
847fff5c | 27 | |
1fd7115e DC |
28 | struct xfs_dinode; |
29 | struct xfs_inode; | |
847fff5c BN |
30 | struct xfs_buf; |
31 | struct xfs_bmap_free; | |
32 | struct xfs_bmbt_irec; | |
847fff5c BN |
33 | struct xfs_inode_log_item; |
34 | struct xfs_mount; | |
35 | struct xfs_trans; | |
36 | struct xfs_dquot; | |
37 | ||
1da177e4 LT |
38 | typedef struct xfs_inode { |
39 | /* Inode linking and identification information. */ | |
1da177e4 | 40 | struct xfs_mount *i_mount; /* fs mount struct ptr */ |
1da177e4 LT |
41 | struct xfs_dquot *i_udquot; /* user dquot */ |
42 | struct xfs_dquot *i_gdquot; /* group dquot */ | |
92f8ff73 | 43 | struct xfs_dquot *i_pdquot; /* project dquot */ |
1da177e4 LT |
44 | |
45 | /* Inode location stuff */ | |
46 | xfs_ino_t i_ino; /* inode number (agno/agino)*/ | |
92bfc6e7 | 47 | struct xfs_imap i_imap; /* location for xfs_imap() */ |
1da177e4 LT |
48 | |
49 | /* Extent information. */ | |
50 | xfs_ifork_t *i_afp; /* attribute fork pointer */ | |
51 | xfs_ifork_t i_df; /* data fork */ | |
52 | ||
53 | /* Transaction and locking information. */ | |
1da177e4 LT |
54 | struct xfs_inode_log_item *i_itemp; /* logging information */ |
55 | mrlock_t i_lock; /* inode lock */ | |
56 | mrlock_t i_iolock; /* inode IO lock */ | |
1da177e4 | 57 | atomic_t i_pincount; /* inode pin count */ |
f273ab84 | 58 | spinlock_t i_flags_lock; /* inode i_flags lock */ |
1da177e4 | 59 | /* Miscellaneous state. */ |
49e4c70e | 60 | unsigned long i_flags; /* see defined flags below */ |
1da177e4 LT |
61 | unsigned int i_delayed_blks; /* count of delay alloc blks */ |
62 | ||
347d1c01 | 63 | xfs_icdinode_t i_d; /* most of ondisk inode */ |
1da177e4 | 64 | |
bf904248 DC |
65 | /* VFS inode */ |
66 | struct inode i_vnode; /* embedded VFS inode */ | |
1da177e4 LT |
67 | } xfs_inode_t; |
68 | ||
01651646 DC |
69 | /* Convert from vfs inode to xfs inode */ |
70 | static inline struct xfs_inode *XFS_I(struct inode *inode) | |
71 | { | |
bf904248 | 72 | return container_of(inode, struct xfs_inode, i_vnode); |
01651646 DC |
73 | } |
74 | ||
01651646 DC |
75 | /* convert from xfs inode to vfs inode */ |
76 | static inline struct inode *VFS_I(struct xfs_inode *ip) | |
77 | { | |
bf904248 | 78 | return &ip->i_vnode; |
01651646 | 79 | } |
01651646 | 80 | |
ce7ae151 CH |
81 | /* |
82 | * For regular files we only update the on-disk filesize when actually | |
83 | * writing data back to disk. Until then only the copy in the VFS inode | |
84 | * is uptodate. | |
85 | */ | |
86 | static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip) | |
87 | { | |
88 | if (S_ISREG(ip->i_d.di_mode)) | |
89 | return i_size_read(VFS_I(ip)); | |
90 | return ip->i_d.di_size; | |
91 | } | |
92 | ||
6923e686 CH |
93 | /* |
94 | * If this I/O goes past the on-disk inode size update it unless it would | |
95 | * be past the current in-core inode size. | |
96 | */ | |
97 | static inline xfs_fsize_t | |
98 | xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size) | |
99 | { | |
100 | xfs_fsize_t i_size = i_size_read(VFS_I(ip)); | |
101 | ||
102 | if (new_size > i_size) | |
103 | new_size = i_size; | |
104 | return new_size > ip->i_d.di_size ? new_size : 0; | |
105 | } | |
106 | ||
7a18c386 DC |
107 | /* |
108 | * i_flags helper functions | |
109 | */ | |
110 | static inline void | |
111 | __xfs_iflags_set(xfs_inode_t *ip, unsigned short flags) | |
112 | { | |
113 | ip->i_flags |= flags; | |
114 | } | |
115 | ||
116 | static inline void | |
117 | xfs_iflags_set(xfs_inode_t *ip, unsigned short flags) | |
118 | { | |
119 | spin_lock(&ip->i_flags_lock); | |
120 | __xfs_iflags_set(ip, flags); | |
121 | spin_unlock(&ip->i_flags_lock); | |
122 | } | |
123 | ||
124 | static inline void | |
125 | xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags) | |
126 | { | |
127 | spin_lock(&ip->i_flags_lock); | |
128 | ip->i_flags &= ~flags; | |
129 | spin_unlock(&ip->i_flags_lock); | |
130 | } | |
131 | ||
132 | static inline int | |
133 | __xfs_iflags_test(xfs_inode_t *ip, unsigned short flags) | |
134 | { | |
135 | return (ip->i_flags & flags); | |
136 | } | |
137 | ||
138 | static inline int | |
139 | xfs_iflags_test(xfs_inode_t *ip, unsigned short flags) | |
140 | { | |
141 | int ret; | |
142 | spin_lock(&ip->i_flags_lock); | |
143 | ret = __xfs_iflags_test(ip, flags); | |
144 | spin_unlock(&ip->i_flags_lock); | |
145 | return ret; | |
146 | } | |
09262b43 CH |
147 | |
148 | static inline int | |
149 | xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags) | |
150 | { | |
151 | int ret; | |
152 | ||
153 | spin_lock(&ip->i_flags_lock); | |
154 | ret = ip->i_flags & flags; | |
155 | if (ret) | |
156 | ip->i_flags &= ~flags; | |
157 | spin_unlock(&ip->i_flags_lock); | |
158 | return ret; | |
159 | } | |
1da177e4 | 160 | |
474fce06 CH |
161 | static inline int |
162 | xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags) | |
163 | { | |
164 | int ret; | |
165 | ||
166 | spin_lock(&ip->i_flags_lock); | |
167 | ret = ip->i_flags & flags; | |
168 | if (!ret) | |
169 | ip->i_flags |= flags; | |
170 | spin_unlock(&ip->i_flags_lock); | |
171 | return ret; | |
172 | } | |
173 | ||
6743099c AM |
174 | /* |
175 | * Project quota id helpers (previously projid was 16bit only | |
25985edc | 176 | * and using two 16bit values to hold new 32bit projid was chosen |
6743099c AM |
177 | * to retain compatibility with "old" filesystems). |
178 | */ | |
179 | static inline prid_t | |
180 | xfs_get_projid(struct xfs_inode *ip) | |
181 | { | |
182 | return (prid_t)ip->i_d.di_projid_hi << 16 | ip->i_d.di_projid_lo; | |
183 | } | |
184 | ||
185 | static inline void | |
186 | xfs_set_projid(struct xfs_inode *ip, | |
187 | prid_t projid) | |
188 | { | |
189 | ip->i_d.di_projid_hi = (__uint16_t) (projid >> 16); | |
190 | ip->i_d.di_projid_lo = (__uint16_t) (projid & 0xffff); | |
191 | } | |
192 | ||
1da177e4 LT |
193 | /* |
194 | * In-core inode flags. | |
195 | */ | |
474fce06 CH |
196 | #define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */ |
197 | #define XFS_ISTALE (1 << 1) /* inode has been staled */ | |
198 | #define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */ | |
199 | #define XFS_INEW (1 << 3) /* inode has just been allocated */ | |
200 | #define XFS_IFILESTREAM (1 << 4) /* inode is in a filestream dir. */ | |
201 | #define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */ | |
202 | #define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */ | |
203 | #define __XFS_IFLOCK_BIT 7 /* inode is being flushed right now */ | |
204 | #define XFS_IFLOCK (1 << __XFS_IFLOCK_BIT) | |
f392e631 CH |
205 | #define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */ |
206 | #define XFS_IPINNED (1 << __XFS_IPINNED_BIT) | |
5132ba8f | 207 | #define XFS_IDONTCACHE (1 << 9) /* don't cache the inode long term */ |
1da177e4 | 208 | |
778e24bb DC |
209 | /* |
210 | * Per-lifetime flags need to be reset when re-using a reclaimable inode during | |
5132ba8f | 211 | * inode lookup. This prevents unintended behaviour on the new inode from |
778e24bb DC |
212 | * ocurring. |
213 | */ | |
214 | #define XFS_IRECLAIM_RESET_FLAGS \ | |
215 | (XFS_IRECLAIMABLE | XFS_IRECLAIM | \ | |
216 | XFS_IDIRTY_RELEASE | XFS_ITRUNCATED | \ | |
217 | XFS_IFILESTREAM); | |
218 | ||
474fce06 CH |
219 | /* |
220 | * Synchronize processes attempting to flush the in-core inode back to disk. | |
221 | */ | |
222 | ||
223 | extern void __xfs_iflock(struct xfs_inode *ip); | |
224 | ||
225 | static inline int xfs_iflock_nowait(struct xfs_inode *ip) | |
226 | { | |
227 | return !xfs_iflags_test_and_set(ip, XFS_IFLOCK); | |
228 | } | |
229 | ||
230 | static inline void xfs_iflock(struct xfs_inode *ip) | |
231 | { | |
232 | if (!xfs_iflock_nowait(ip)) | |
233 | __xfs_iflock(ip); | |
234 | } | |
235 | ||
236 | static inline void xfs_ifunlock(struct xfs_inode *ip) | |
237 | { | |
238 | xfs_iflags_clear(ip, XFS_IFLOCK); | |
311f08ac | 239 | smp_mb(); |
474fce06 CH |
240 | wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT); |
241 | } | |
242 | ||
243 | static inline int xfs_isiflocked(struct xfs_inode *ip) | |
244 | { | |
245 | return xfs_iflags_test(ip, XFS_IFLOCK); | |
246 | } | |
247 | ||
1da177e4 LT |
248 | /* |
249 | * Flags for inode locking. | |
f7c66ce3 LM |
250 | * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield) |
251 | * 1<<16 - 1<<32-1 -- lockdep annotation (integers) | |
1da177e4 | 252 | */ |
f7c66ce3 LM |
253 | #define XFS_IOLOCK_EXCL (1<<0) |
254 | #define XFS_IOLOCK_SHARED (1<<1) | |
255 | #define XFS_ILOCK_EXCL (1<<2) | |
256 | #define XFS_ILOCK_SHARED (1<<3) | |
1da177e4 | 257 | |
f7c66ce3 | 258 | #define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \ |
579aa9ca | 259 | | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED) |
f7c66ce3 | 260 | |
0b1b213f CH |
261 | #define XFS_LOCK_FLAGS \ |
262 | { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \ | |
263 | { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \ | |
264 | { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \ | |
5b03ff1b | 265 | { XFS_ILOCK_SHARED, "ILOCK_SHARED" } |
0b1b213f CH |
266 | |
267 | ||
f7c66ce3 LM |
268 | /* |
269 | * Flags for lockdep annotations. | |
270 | * | |
9681153b CH |
271 | * XFS_LOCK_PARENT - for directory operations that require locking a |
272 | * parent directory inode and a child entry inode. The parent gets locked | |
273 | * with this flag so it gets a lockdep subclass of 1 and the child entry | |
274 | * lock will have a lockdep subclass of 0. | |
275 | * | |
276 | * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary | |
277 | * inodes do not participate in the normal lock order, and thus have their | |
278 | * own subclasses. | |
f7c66ce3 | 279 | * |
0f1145cc | 280 | * XFS_LOCK_INUMORDER - for locking several inodes at the some time |
f7c66ce3 LM |
281 | * with xfs_lock_inodes(). This flag is used as the starting subclass |
282 | * and each subsequent lock acquired will increment the subclass by one. | |
9681153b CH |
283 | * So the first lock acquired will have a lockdep subclass of 4, the |
284 | * second lock will have a lockdep subclass of 5, and so on. It is | |
0f1145cc DC |
285 | * the responsibility of the class builder to shift this to the correct |
286 | * portion of the lock_mode lockdep mask. | |
f7c66ce3 | 287 | */ |
0f1145cc | 288 | #define XFS_LOCK_PARENT 1 |
9681153b CH |
289 | #define XFS_LOCK_RTBITMAP 2 |
290 | #define XFS_LOCK_RTSUM 3 | |
291 | #define XFS_LOCK_INUMORDER 4 | |
0f1145cc | 292 | |
f7c66ce3 | 293 | #define XFS_IOLOCK_SHIFT 16 |
0f1145cc | 294 | #define XFS_IOLOCK_PARENT (XFS_LOCK_PARENT << XFS_IOLOCK_SHIFT) |
f7c66ce3 LM |
295 | |
296 | #define XFS_ILOCK_SHIFT 24 | |
0f1145cc | 297 | #define XFS_ILOCK_PARENT (XFS_LOCK_PARENT << XFS_ILOCK_SHIFT) |
9681153b CH |
298 | #define XFS_ILOCK_RTBITMAP (XFS_LOCK_RTBITMAP << XFS_ILOCK_SHIFT) |
299 | #define XFS_ILOCK_RTSUM (XFS_LOCK_RTSUM << XFS_ILOCK_SHIFT) | |
f7c66ce3 LM |
300 | |
301 | #define XFS_IOLOCK_DEP_MASK 0x00ff0000 | |
302 | #define XFS_ILOCK_DEP_MASK 0xff000000 | |
303 | #define XFS_LOCK_DEP_MASK (XFS_IOLOCK_DEP_MASK | XFS_ILOCK_DEP_MASK) | |
304 | ||
305 | #define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) >> XFS_IOLOCK_SHIFT) | |
306 | #define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) >> XFS_ILOCK_SHIFT) | |
1da177e4 | 307 | |
1da177e4 LT |
308 | /* |
309 | * For multiple groups support: if S_ISGID bit is set in the parent | |
310 | * directory, group of new file is set to that of the parent, and | |
311 | * new subdirectory gets S_ISGID bit from parent. | |
312 | */ | |
bd186aa9 CH |
313 | #define XFS_INHERIT_GID(pip) \ |
314 | (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \ | |
315 | ((pip)->i_d.di_mode & S_ISGID)) | |
1da177e4 | 316 | |
33479e05 | 317 | |
c24b5dfa DC |
318 | int xfs_release(struct xfs_inode *ip); |
319 | int xfs_inactive(struct xfs_inode *ip); | |
320 | int xfs_lookup(struct xfs_inode *dp, struct xfs_name *name, | |
321 | struct xfs_inode **ipp, struct xfs_name *ci_name); | |
322 | int xfs_create(struct xfs_inode *dp, struct xfs_name *name, | |
323 | umode_t mode, xfs_dev_t rdev, struct xfs_inode **ipp); | |
324 | int xfs_remove(struct xfs_inode *dp, struct xfs_name *name, | |
325 | struct xfs_inode *ip); | |
326 | int xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip, | |
327 | struct xfs_name *target_name); | |
328 | int xfs_rename(struct xfs_inode *src_dp, struct xfs_name *src_name, | |
329 | struct xfs_inode *src_ip, struct xfs_inode *target_dp, | |
330 | struct xfs_name *target_name, | |
331 | struct xfs_inode *target_ip); | |
332 | ||
1da177e4 LT |
333 | void xfs_ilock(xfs_inode_t *, uint); |
334 | int xfs_ilock_nowait(xfs_inode_t *, uint); | |
335 | void xfs_iunlock(xfs_inode_t *, uint); | |
336 | void xfs_ilock_demote(xfs_inode_t *, uint); | |
579aa9ca | 337 | int xfs_isilocked(xfs_inode_t *, uint); |
1da177e4 LT |
338 | uint xfs_ilock_map_shared(xfs_inode_t *); |
339 | void xfs_iunlock_map_shared(xfs_inode_t *, uint); | |
576b1d67 | 340 | int xfs_ialloc(struct xfs_trans *, xfs_inode_t *, umode_t, |
6743099c | 341 | xfs_nlink_t, xfs_dev_t, prid_t, int, |
08358906 | 342 | struct xfs_buf **, xfs_inode_t **); |
347d1c01 | 343 | |
1da177e4 | 344 | uint xfs_ip2xflags(struct xfs_inode *); |
45ba598e | 345 | uint xfs_dic2xflags(struct xfs_dinode *); |
1da177e4 LT |
346 | int xfs_ifree(struct xfs_trans *, xfs_inode_t *, |
347 | struct xfs_bmap_free *); | |
8f04c47a CH |
348 | int xfs_itruncate_extents(struct xfs_trans **, struct xfs_inode *, |
349 | int, xfs_fsize_t); | |
1da177e4 | 350 | int xfs_iunlink(struct xfs_trans *, xfs_inode_t *); |
1da177e4 | 351 | |
1da177e4 | 352 | void xfs_iext_realloc(xfs_inode_t *, int, int); |
1fd7115e | 353 | |
777df5af | 354 | void xfs_iunpin_wait(xfs_inode_t *); |
1fd7115e DC |
355 | #define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount)) |
356 | ||
4c46819a | 357 | int xfs_iflush(struct xfs_inode *, struct xfs_buf **); |
cfa853e4 | 358 | void xfs_lock_inodes(xfs_inode_t **, int, uint); |
e1cccd91 | 359 | void xfs_lock_two_inodes(xfs_inode_t *, xfs_inode_t *, uint); |
1da177e4 | 360 | |
2a0ec1d9 DC |
361 | xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip); |
362 | ||
c24b5dfa DC |
363 | /* from xfs_file.c */ |
364 | int xfs_zero_eof(struct xfs_inode *, xfs_off_t, xfs_fsize_t); | |
365 | int xfs_iozero(struct xfs_inode *, loff_t, size_t); | |
366 | ||
367 | ||
5a8d0f3c CH |
368 | #define IHOLD(ip) \ |
369 | do { \ | |
370 | ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \ | |
7de9c6ee | 371 | ihold(VFS_I(ip)); \ |
0b1b213f | 372 | trace_xfs_ihold(ip, _THIS_IP_); \ |
5a8d0f3c CH |
373 | } while (0) |
374 | ||
375 | #define IRELE(ip) \ | |
376 | do { \ | |
0b1b213f | 377 | trace_xfs_irele(ip, _THIS_IP_); \ |
5a8d0f3c CH |
378 | iput(VFS_I(ip)); \ |
379 | } while (0) | |
380 | ||
1da177e4 | 381 | extern struct kmem_zone *xfs_inode_zone; |
1da177e4 | 382 | |
1da177e4 | 383 | #endif /* __XFS_INODE_H__ */ |