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