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