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 | */ |
1fd7115e DC |
27 | struct xfs_dinode; |
28 | struct xfs_inode; | |
847fff5c BN |
29 | struct xfs_buf; |
30 | struct xfs_bmap_free; | |
31 | struct xfs_bmbt_irec; | |
847fff5c BN |
32 | struct xfs_inode_log_item; |
33 | struct xfs_mount; | |
34 | struct xfs_trans; | |
35 | struct xfs_dquot; | |
36 | ||
1da177e4 LT |
37 | typedef struct xfs_inode { |
38 | /* Inode linking and identification information. */ | |
1da177e4 | 39 | struct xfs_mount *i_mount; /* fs mount struct ptr */ |
1da177e4 LT |
40 | struct xfs_dquot *i_udquot; /* user dquot */ |
41 | struct xfs_dquot *i_gdquot; /* group dquot */ | |
92f8ff73 | 42 | struct xfs_dquot *i_pdquot; /* project dquot */ |
1da177e4 LT |
43 | |
44 | /* Inode location stuff */ | |
45 | xfs_ino_t i_ino; /* inode number (agno/agino)*/ | |
92bfc6e7 | 46 | struct xfs_imap i_imap; /* location for xfs_imap() */ |
1da177e4 LT |
47 | |
48 | /* Extent information. */ | |
49 | xfs_ifork_t *i_afp; /* attribute fork pointer */ | |
50 | xfs_ifork_t i_df; /* data fork */ | |
51 | ||
32c5483a DC |
52 | /* operations vectors */ |
53 | const struct xfs_dir_ops *d_ops; /* directory ops vector */ | |
54 | ||
1da177e4 | 55 | /* Transaction and locking information. */ |
1da177e4 LT |
56 | struct xfs_inode_log_item *i_itemp; /* logging information */ |
57 | mrlock_t i_lock; /* inode lock */ | |
58 | mrlock_t i_iolock; /* inode IO lock */ | |
1da177e4 | 59 | atomic_t i_pincount; /* inode pin count */ |
f273ab84 | 60 | spinlock_t i_flags_lock; /* inode i_flags lock */ |
1da177e4 | 61 | /* Miscellaneous state. */ |
49e4c70e | 62 | unsigned long i_flags; /* see defined flags below */ |
1da177e4 LT |
63 | unsigned int i_delayed_blks; /* count of delay alloc blks */ |
64 | ||
347d1c01 | 65 | xfs_icdinode_t i_d; /* most of ondisk inode */ |
1da177e4 | 66 | |
bf904248 DC |
67 | /* VFS inode */ |
68 | struct inode i_vnode; /* embedded VFS inode */ | |
1da177e4 LT |
69 | } xfs_inode_t; |
70 | ||
01651646 DC |
71 | /* Convert from vfs inode to xfs inode */ |
72 | static inline struct xfs_inode *XFS_I(struct inode *inode) | |
73 | { | |
bf904248 | 74 | return container_of(inode, struct xfs_inode, i_vnode); |
01651646 DC |
75 | } |
76 | ||
01651646 DC |
77 | /* convert from xfs inode to vfs inode */ |
78 | static inline struct inode *VFS_I(struct xfs_inode *ip) | |
79 | { | |
bf904248 | 80 | return &ip->i_vnode; |
01651646 | 81 | } |
01651646 | 82 | |
ce7ae151 CH |
83 | /* |
84 | * For regular files we only update the on-disk filesize when actually | |
85 | * writing data back to disk. Until then only the copy in the VFS inode | |
86 | * is uptodate. | |
87 | */ | |
88 | static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip) | |
89 | { | |
90 | if (S_ISREG(ip->i_d.di_mode)) | |
91 | return i_size_read(VFS_I(ip)); | |
92 | return ip->i_d.di_size; | |
93 | } | |
94 | ||
6923e686 CH |
95 | /* |
96 | * If this I/O goes past the on-disk inode size update it unless it would | |
97 | * be past the current in-core inode size. | |
98 | */ | |
99 | static inline xfs_fsize_t | |
100 | xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size) | |
101 | { | |
102 | xfs_fsize_t i_size = i_size_read(VFS_I(ip)); | |
103 | ||
ce57bcf6 | 104 | if (new_size > i_size || new_size < 0) |
6923e686 CH |
105 | new_size = i_size; |
106 | return new_size > ip->i_d.di_size ? new_size : 0; | |
107 | } | |
108 | ||
7a18c386 DC |
109 | /* |
110 | * i_flags helper functions | |
111 | */ | |
112 | static inline void | |
113 | __xfs_iflags_set(xfs_inode_t *ip, unsigned short flags) | |
114 | { | |
115 | ip->i_flags |= flags; | |
116 | } | |
117 | ||
118 | static inline void | |
119 | xfs_iflags_set(xfs_inode_t *ip, unsigned short flags) | |
120 | { | |
121 | spin_lock(&ip->i_flags_lock); | |
122 | __xfs_iflags_set(ip, flags); | |
123 | spin_unlock(&ip->i_flags_lock); | |
124 | } | |
125 | ||
126 | static inline void | |
127 | xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags) | |
128 | { | |
129 | spin_lock(&ip->i_flags_lock); | |
130 | ip->i_flags &= ~flags; | |
131 | spin_unlock(&ip->i_flags_lock); | |
132 | } | |
133 | ||
134 | static inline int | |
135 | __xfs_iflags_test(xfs_inode_t *ip, unsigned short flags) | |
136 | { | |
137 | return (ip->i_flags & flags); | |
138 | } | |
139 | ||
140 | static inline int | |
141 | xfs_iflags_test(xfs_inode_t *ip, unsigned short flags) | |
142 | { | |
143 | int ret; | |
144 | spin_lock(&ip->i_flags_lock); | |
145 | ret = __xfs_iflags_test(ip, flags); | |
146 | spin_unlock(&ip->i_flags_lock); | |
147 | return ret; | |
148 | } | |
09262b43 CH |
149 | |
150 | static inline int | |
151 | xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags) | |
152 | { | |
153 | int ret; | |
154 | ||
155 | spin_lock(&ip->i_flags_lock); | |
156 | ret = ip->i_flags & flags; | |
157 | if (ret) | |
158 | ip->i_flags &= ~flags; | |
159 | spin_unlock(&ip->i_flags_lock); | |
160 | return ret; | |
161 | } | |
1da177e4 | 162 | |
474fce06 CH |
163 | static inline int |
164 | xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags) | |
165 | { | |
166 | int ret; | |
167 | ||
168 | spin_lock(&ip->i_flags_lock); | |
169 | ret = ip->i_flags & flags; | |
170 | if (!ret) | |
171 | ip->i_flags |= flags; | |
172 | spin_unlock(&ip->i_flags_lock); | |
173 | return ret; | |
174 | } | |
175 | ||
6743099c AM |
176 | /* |
177 | * Project quota id helpers (previously projid was 16bit only | |
25985edc | 178 | * and using two 16bit values to hold new 32bit projid was chosen |
6743099c AM |
179 | * to retain compatibility with "old" filesystems). |
180 | */ | |
181 | static inline prid_t | |
182 | xfs_get_projid(struct xfs_inode *ip) | |
183 | { | |
184 | return (prid_t)ip->i_d.di_projid_hi << 16 | ip->i_d.di_projid_lo; | |
185 | } | |
186 | ||
187 | static inline void | |
188 | xfs_set_projid(struct xfs_inode *ip, | |
189 | prid_t projid) | |
190 | { | |
191 | ip->i_d.di_projid_hi = (__uint16_t) (projid >> 16); | |
192 | ip->i_d.di_projid_lo = (__uint16_t) (projid & 0xffff); | |
193 | } | |
194 | ||
163467d3 ZYW |
195 | static inline prid_t |
196 | xfs_get_initial_prid(struct xfs_inode *dp) | |
197 | { | |
198 | if (dp->i_d.di_flags & XFS_DIFLAG_PROJINHERIT) | |
199 | return xfs_get_projid(dp); | |
200 | ||
201 | return XFS_PROJID_DEFAULT; | |
202 | } | |
203 | ||
1da177e4 LT |
204 | /* |
205 | * In-core inode flags. | |
206 | */ | |
474fce06 CH |
207 | #define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */ |
208 | #define XFS_ISTALE (1 << 1) /* inode has been staled */ | |
209 | #define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */ | |
210 | #define XFS_INEW (1 << 3) /* inode has just been allocated */ | |
474fce06 CH |
211 | #define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */ |
212 | #define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */ | |
213 | #define __XFS_IFLOCK_BIT 7 /* inode is being flushed right now */ | |
214 | #define XFS_IFLOCK (1 << __XFS_IFLOCK_BIT) | |
f392e631 CH |
215 | #define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */ |
216 | #define XFS_IPINNED (1 << __XFS_IPINNED_BIT) | |
5132ba8f | 217 | #define XFS_IDONTCACHE (1 << 9) /* don't cache the inode long term */ |
1da177e4 | 218 | |
778e24bb DC |
219 | /* |
220 | * Per-lifetime flags need to be reset when re-using a reclaimable inode during | |
5132ba8f | 221 | * inode lookup. This prevents unintended behaviour on the new inode from |
778e24bb DC |
222 | * ocurring. |
223 | */ | |
224 | #define XFS_IRECLAIM_RESET_FLAGS \ | |
225 | (XFS_IRECLAIMABLE | XFS_IRECLAIM | \ | |
f37211c3 | 226 | XFS_IDIRTY_RELEASE | XFS_ITRUNCATED) |
778e24bb | 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 | |
c24b5dfa | 326 | int xfs_release(struct xfs_inode *ip); |
74564fb4 | 327 | void xfs_inactive(struct xfs_inode *ip); |
c24b5dfa DC |
328 | int xfs_lookup(struct xfs_inode *dp, struct xfs_name *name, |
329 | struct xfs_inode **ipp, struct xfs_name *ci_name); | |
330 | int xfs_create(struct xfs_inode *dp, struct xfs_name *name, | |
331 | umode_t mode, xfs_dev_t rdev, struct xfs_inode **ipp); | |
99b6436b | 332 | int xfs_create_tmpfile(struct xfs_inode *dp, struct dentry *dentry, |
330033d6 | 333 | umode_t mode, struct xfs_inode **ipp); |
c24b5dfa DC |
334 | int xfs_remove(struct xfs_inode *dp, struct xfs_name *name, |
335 | struct xfs_inode *ip); | |
336 | int xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip, | |
337 | struct xfs_name *target_name); | |
338 | int xfs_rename(struct xfs_inode *src_dp, struct xfs_name *src_name, | |
339 | struct xfs_inode *src_ip, struct xfs_inode *target_dp, | |
340 | struct xfs_name *target_name, | |
d31a1825 | 341 | struct xfs_inode *target_ip, unsigned int flags); |
c24b5dfa | 342 | |
1da177e4 LT |
343 | void xfs_ilock(xfs_inode_t *, uint); |
344 | int xfs_ilock_nowait(xfs_inode_t *, uint); | |
345 | void xfs_iunlock(xfs_inode_t *, uint); | |
346 | void xfs_ilock_demote(xfs_inode_t *, uint); | |
579aa9ca | 347 | int xfs_isilocked(xfs_inode_t *, uint); |
309ecac8 | 348 | uint xfs_ilock_data_map_shared(struct xfs_inode *); |
efa70be1 | 349 | uint xfs_ilock_attr_map_shared(struct xfs_inode *); |
576b1d67 | 350 | int xfs_ialloc(struct xfs_trans *, xfs_inode_t *, umode_t, |
6743099c | 351 | xfs_nlink_t, xfs_dev_t, prid_t, int, |
08358906 | 352 | struct xfs_buf **, xfs_inode_t **); |
347d1c01 | 353 | |
1da177e4 | 354 | uint xfs_ip2xflags(struct xfs_inode *); |
45ba598e | 355 | uint xfs_dic2xflags(struct xfs_dinode *); |
1da177e4 LT |
356 | int xfs_ifree(struct xfs_trans *, xfs_inode_t *, |
357 | struct xfs_bmap_free *); | |
8f04c47a CH |
358 | int xfs_itruncate_extents(struct xfs_trans **, struct xfs_inode *, |
359 | int, xfs_fsize_t); | |
1da177e4 | 360 | int xfs_iunlink(struct xfs_trans *, xfs_inode_t *); |
1da177e4 | 361 | |
1da177e4 | 362 | void xfs_iext_realloc(xfs_inode_t *, int, int); |
1fd7115e | 363 | |
777df5af | 364 | void xfs_iunpin_wait(xfs_inode_t *); |
1fd7115e DC |
365 | #define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount)) |
366 | ||
4c46819a | 367 | int xfs_iflush(struct xfs_inode *, struct xfs_buf **); |
cfa853e4 | 368 | void xfs_lock_inodes(xfs_inode_t **, int, uint); |
e1cccd91 | 369 | void xfs_lock_two_inodes(xfs_inode_t *, xfs_inode_t *, uint); |
1da177e4 | 370 | |
2a0ec1d9 DC |
371 | xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip); |
372 | ||
e546cb79 DC |
373 | int xfs_dir_ialloc(struct xfs_trans **, struct xfs_inode *, umode_t, |
374 | xfs_nlink_t, xfs_dev_t, prid_t, int, | |
375 | struct xfs_inode **, int *); | |
376 | int xfs_droplink(struct xfs_trans *, struct xfs_inode *); | |
377 | int xfs_bumplink(struct xfs_trans *, struct xfs_inode *); | |
e546cb79 | 378 | |
c24b5dfa | 379 | /* from xfs_file.c */ |
8add71ca CH |
380 | enum xfs_prealloc_flags { |
381 | XFS_PREALLOC_SET = (1 << 1), | |
382 | XFS_PREALLOC_CLEAR = (1 << 2), | |
383 | XFS_PREALLOC_SYNC = (1 << 3), | |
384 | XFS_PREALLOC_INVISIBLE = (1 << 4), | |
385 | }; | |
386 | ||
387 | int xfs_update_prealloc_flags(struct xfs_inode *, | |
388 | enum xfs_prealloc_flags); | |
c24b5dfa DC |
389 | int xfs_zero_eof(struct xfs_inode *, xfs_off_t, xfs_fsize_t); |
390 | int xfs_iozero(struct xfs_inode *, loff_t, size_t); | |
391 | ||
392 | ||
5a8d0f3c CH |
393 | #define IHOLD(ip) \ |
394 | do { \ | |
395 | ASSERT(atomic_read(&VFS_I(ip)->i_count) > 0) ; \ | |
7de9c6ee | 396 | ihold(VFS_I(ip)); \ |
0b1b213f | 397 | trace_xfs_ihold(ip, _THIS_IP_); \ |
5a8d0f3c CH |
398 | } while (0) |
399 | ||
400 | #define IRELE(ip) \ | |
401 | do { \ | |
0b1b213f | 402 | trace_xfs_irele(ip, _THIS_IP_); \ |
5a8d0f3c CH |
403 | iput(VFS_I(ip)); \ |
404 | } while (0) | |
405 | ||
1da177e4 | 406 | extern struct kmem_zone *xfs_inode_zone; |
1da177e4 | 407 | |
b92cc59f DC |
408 | /* |
409 | * Flags for read/write calls | |
410 | */ | |
411 | #define XFS_IO_ISDIRECT 0x00001 /* bypass page cache */ | |
412 | #define XFS_IO_INVIS 0x00002 /* don't update inode timestamps */ | |
413 | ||
414 | #define XFS_IO_FLAGS \ | |
415 | { XFS_IO_ISDIRECT, "DIRECT" }, \ | |
416 | { XFS_IO_INVIS, "INVIS"} | |
417 | ||
1da177e4 | 418 | #endif /* __XFS_INODE_H__ */ |