1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * Copyright (c) 2000-2003,2005 Silicon Graphics, Inc.
4 * All Rights Reserved.
5 */
6 #ifndef __XFS_INODE_H__
7 #define __XFS_INODE_H__
8
9 #include "xfs_inode_buf.h"
10 #include "xfs_inode_fork.h"
11
12 /*
13 * Kernel only inode definitions
14 */
15 struct xfs_dinode;
16 struct xfs_inode;
17 struct xfs_buf;
18 struct xfs_bmbt_irec;
19 struct xfs_inode_log_item;
20 struct xfs_mount;
21 struct xfs_trans;
22 struct xfs_dquot;
23
24 typedef struct xfs_inode {
25 /* Inode linking and identification information. */
26 struct xfs_mount *i_mount; /* fs mount struct ptr */
27 struct xfs_dquot *i_udquot; /* user dquot */
28 struct xfs_dquot *i_gdquot; /* group dquot */
29 struct xfs_dquot *i_pdquot; /* project dquot */
30
31 /* Inode location stuff */
32 xfs_ino_t i_ino; /* inode number (agno/agino)*/
33 struct xfs_imap i_imap; /* location for xfs_imap() */
34
35 /* Extent information. */
36 struct xfs_ifork *i_afp; /* attribute fork pointer */
37 struct xfs_ifork *i_cowfp; /* copy on write extents */
38 struct xfs_ifork i_df; /* data fork */
39
40 /* operations vectors */
41 const struct xfs_dir_ops *d_ops; /* directory ops vector */
42
43 /* Transaction and locking information. */
44 struct xfs_inode_log_item *i_itemp; /* logging information */
45 mrlock_t i_lock; /* inode lock */
46 mrlock_t i_mmaplock; /* inode mmap IO lock */
47 atomic_t i_pincount; /* inode pin count */
48 spinlock_t i_flags_lock; /* inode i_flags lock */
49 /* Miscellaneous state. */
50 unsigned long i_flags; /* see defined flags below */
51 unsigned int i_delayed_blks; /* count of delay alloc blks */
52
53 struct xfs_icdinode i_d; /* most of ondisk inode */
54
55 xfs_extnum_t i_cnextents; /* # of extents in cow fork */
56 unsigned int i_cformat; /* format of cow fork */
57
58 /* VFS inode */
59 struct inode i_vnode; /* embedded VFS inode */
60 } xfs_inode_t;
61
62 /* Convert from vfs inode to xfs inode */
XFS_I(struct inode * inode)63 static inline struct xfs_inode *XFS_I(struct inode *inode)
64 {
65 return container_of(inode, struct xfs_inode, i_vnode);
66 }
67
68 /* convert from xfs inode to vfs inode */
VFS_I(struct xfs_inode * ip)69 static inline struct inode *VFS_I(struct xfs_inode *ip)
70 {
71 return &ip->i_vnode;
72 }
73
74 /*
75 * For regular files we only update the on-disk filesize when actually
76 * writing data back to disk. Until then only the copy in the VFS inode
77 * is uptodate.
78 */
XFS_ISIZE(struct xfs_inode * ip)79 static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip)
80 {
81 if (S_ISREG(VFS_I(ip)->i_mode))
82 return i_size_read(VFS_I(ip));
83 return ip->i_d.di_size;
84 }
85
86 /*
87 * If this I/O goes past the on-disk inode size update it unless it would
88 * be past the current in-core inode size.
89 */
90 static inline xfs_fsize_t
xfs_new_eof(struct xfs_inode * ip,xfs_fsize_t new_size)91 xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size)
92 {
93 xfs_fsize_t i_size = i_size_read(VFS_I(ip));
94
95 if (new_size > i_size || new_size < 0)
96 new_size = i_size;
97 return new_size > ip->i_d.di_size ? new_size : 0;
98 }
99
100 /*
101 * i_flags helper functions
102 */
103 static inline void
__xfs_iflags_set(xfs_inode_t * ip,unsigned short flags)104 __xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
105 {
106 ip->i_flags |= flags;
107 }
108
109 static inline void
xfs_iflags_set(xfs_inode_t * ip,unsigned short flags)110 xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
111 {
112 spin_lock(&ip->i_flags_lock);
113 __xfs_iflags_set(ip, flags);
114 spin_unlock(&ip->i_flags_lock);
115 }
116
117 static inline void
xfs_iflags_clear(xfs_inode_t * ip,unsigned short flags)118 xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags)
119 {
120 spin_lock(&ip->i_flags_lock);
121 ip->i_flags &= ~flags;
122 spin_unlock(&ip->i_flags_lock);
123 }
124
125 static inline int
__xfs_iflags_test(xfs_inode_t * ip,unsigned short flags)126 __xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
127 {
128 return (ip->i_flags & flags);
129 }
130
131 static inline int
xfs_iflags_test(xfs_inode_t * ip,unsigned short flags)132 xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
133 {
134 int ret;
135 spin_lock(&ip->i_flags_lock);
136 ret = __xfs_iflags_test(ip, flags);
137 spin_unlock(&ip->i_flags_lock);
138 return ret;
139 }
140
141 static inline int
xfs_iflags_test_and_clear(xfs_inode_t * ip,unsigned short flags)142 xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags)
143 {
144 int ret;
145
146 spin_lock(&ip->i_flags_lock);
147 ret = ip->i_flags & flags;
148 if (ret)
149 ip->i_flags &= ~flags;
150 spin_unlock(&ip->i_flags_lock);
151 return ret;
152 }
153
154 static inline int
xfs_iflags_test_and_set(xfs_inode_t * ip,unsigned short flags)155 xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags)
156 {
157 int ret;
158
159 spin_lock(&ip->i_flags_lock);
160 ret = ip->i_flags & flags;
161 if (!ret)
162 ip->i_flags |= flags;
163 spin_unlock(&ip->i_flags_lock);
164 return ret;
165 }
166
167 /*
168 * Project quota id helpers (previously projid was 16bit only
169 * and using two 16bit values to hold new 32bit projid was chosen
170 * to retain compatibility with "old" filesystems).
171 */
172 static inline prid_t
xfs_get_projid(struct xfs_inode * ip)173 xfs_get_projid(struct xfs_inode *ip)
174 {
175 return (prid_t)ip->i_d.di_projid_hi << 16 | ip->i_d.di_projid_lo;
176 }
177
178 static inline void
xfs_set_projid(struct xfs_inode * ip,prid_t projid)179 xfs_set_projid(struct xfs_inode *ip,
180 prid_t projid)
181 {
182 ip->i_d.di_projid_hi = (uint16_t) (projid >> 16);
183 ip->i_d.di_projid_lo = (uint16_t) (projid & 0xffff);
184 }
185
186 static inline prid_t
xfs_get_initial_prid(struct xfs_inode * dp)187 xfs_get_initial_prid(struct xfs_inode *dp)
188 {
189 if (dp->i_d.di_flags & XFS_DIFLAG_PROJINHERIT)
190 return xfs_get_projid(dp);
191
192 return XFS_PROJID_DEFAULT;
193 }
194
xfs_is_reflink_inode(struct xfs_inode * ip)195 static inline bool xfs_is_reflink_inode(struct xfs_inode *ip)
196 {
197 return ip->i_d.di_flags2 & XFS_DIFLAG2_REFLINK;
198 }
199
200 /*
201 * Check if an inode has any data in the COW fork. This might be often false
202 * even for inodes with the reflink flag when there is no pending COW operation.
203 */
xfs_inode_has_cow_data(struct xfs_inode * ip)204 static inline bool xfs_inode_has_cow_data(struct xfs_inode *ip)
205 {
206 return ip->i_cowfp && ip->i_cowfp->if_bytes;
207 }
208
209 /*
210 * In-core inode flags.
211 */
212 #define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */
213 #define XFS_ISTALE (1 << 1) /* inode has been staled */
214 #define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */
215 #define __XFS_INEW_BIT 3 /* inode has just been allocated */
216 #define XFS_INEW (1 << __XFS_INEW_BIT)
217 #define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */
218 #define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */
219 #define __XFS_IFLOCK_BIT 7 /* inode is being flushed right now */
220 #define XFS_IFLOCK (1 << __XFS_IFLOCK_BIT)
221 #define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */
222 #define XFS_IPINNED (1 << __XFS_IPINNED_BIT)
223 #define XFS_IDONTCACHE (1 << 9) /* don't cache the inode long term */
224 #define XFS_IEOFBLOCKS (1 << 10)/* has the preallocblocks tag set */
225 /*
226 * If this unlinked inode is in the middle of recovery, don't let drop_inode
227 * truncate and free the inode. This can happen if we iget the inode during
228 * log recovery to replay a bmap operation on the inode.
229 */
230 #define XFS_IRECOVERY (1 << 11)
231 #define XFS_ICOWBLOCKS (1 << 12)/* has the cowblocks tag set */
232
233 /*
234 * Per-lifetime flags need to be reset when re-using a reclaimable inode during
235 * inode lookup. This prevents unintended behaviour on the new inode from
236 * ocurring.
237 */
238 #define XFS_IRECLAIM_RESET_FLAGS \
239 (XFS_IRECLAIMABLE | XFS_IRECLAIM | \
240 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED)
241
242 /*
243 * Synchronize processes attempting to flush the in-core inode back to disk.
244 */
245
xfs_isiflocked(struct xfs_inode * ip)246 static inline int xfs_isiflocked(struct xfs_inode *ip)
247 {
248 return xfs_iflags_test(ip, XFS_IFLOCK);
249 }
250
251 extern void __xfs_iflock(struct xfs_inode *ip);
252
xfs_iflock_nowait(struct xfs_inode * ip)253 static inline int xfs_iflock_nowait(struct xfs_inode *ip)
254 {
255 return !xfs_iflags_test_and_set(ip, XFS_IFLOCK);
256 }
257
xfs_iflock(struct xfs_inode * ip)258 static inline void xfs_iflock(struct xfs_inode *ip)
259 {
260 if (!xfs_iflock_nowait(ip))
261 __xfs_iflock(ip);
262 }
263
xfs_ifunlock(struct xfs_inode * ip)264 static inline void xfs_ifunlock(struct xfs_inode *ip)
265 {
266 ASSERT(xfs_isiflocked(ip));
267 xfs_iflags_clear(ip, XFS_IFLOCK);
268 smp_mb();
269 wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT);
270 }
271
272 /*
273 * Flags for inode locking.
274 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
275 * 1<<16 - 1<<32-1 -- lockdep annotation (integers)
276 */
277 #define XFS_IOLOCK_EXCL (1<<0)
278 #define XFS_IOLOCK_SHARED (1<<1)
279 #define XFS_ILOCK_EXCL (1<<2)
280 #define XFS_ILOCK_SHARED (1<<3)
281 #define XFS_MMAPLOCK_EXCL (1<<4)
282 #define XFS_MMAPLOCK_SHARED (1<<5)
283
284 #define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
285 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \
286 | XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED)
287
288 #define XFS_LOCK_FLAGS \
289 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
290 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
291 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
292 { XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \
293 { XFS_MMAPLOCK_EXCL, "MMAPLOCK_EXCL" }, \
294 { XFS_MMAPLOCK_SHARED, "MMAPLOCK_SHARED" }
295
296
297 /*
298 * Flags for lockdep annotations.
299 *
300 * XFS_LOCK_PARENT - for directory operations that require locking a
301 * parent directory inode and a child entry inode. IOLOCK requires nesting,
302 * MMAPLOCK does not support this class, ILOCK requires a single subclass
303 * to differentiate parent from child.
304 *
305 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
306 * inodes do not participate in the normal lock order, and thus have their
307 * own subclasses.
308 *
309 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
310 * with xfs_lock_inodes(). This flag is used as the starting subclass
311 * and each subsequent lock acquired will increment the subclass by one.
312 * However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
313 * limited to the subclasses we can represent via nesting. We need at least
314 * 5 inodes nest depth for the ILOCK through rename, and we also have to support
315 * XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
316 * and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
317 * 8 subclasses supported by lockdep.
318 *
319 * This also means we have to number the sub-classes in the lowest bits of
320 * the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
321 * mask and we can't use bit-masking to build the subclasses. What a mess.
322 *
323 * Bit layout:
324 *
325 * Bit Lock Region
326 * 16-19 XFS_IOLOCK_SHIFT dependencies
327 * 20-23 XFS_MMAPLOCK_SHIFT dependencies
328 * 24-31 XFS_ILOCK_SHIFT dependencies
329 *
330 * IOLOCK values
331 *
332 * 0-3 subclass value
333 * 4-7 unused
334 *
335 * MMAPLOCK values
336 *
337 * 0-3 subclass value
338 * 4-7 unused
339 *
340 * ILOCK values
341 * 0-4 subclass values
342 * 5 PARENT subclass (not nestable)
343 * 6 RTBITMAP subclass (not nestable)
344 * 7 RTSUM subclass (not nestable)
345 *
346 */
347 #define XFS_IOLOCK_SHIFT 16
348 #define XFS_IOLOCK_MAX_SUBCLASS 3
349 #define XFS_IOLOCK_DEP_MASK 0x000f0000
350
351 #define XFS_MMAPLOCK_SHIFT 20
352 #define XFS_MMAPLOCK_NUMORDER 0
353 #define XFS_MMAPLOCK_MAX_SUBCLASS 3
354 #define XFS_MMAPLOCK_DEP_MASK 0x00f00000
355
356 #define XFS_ILOCK_SHIFT 24
357 #define XFS_ILOCK_PARENT_VAL 5
358 #define XFS_ILOCK_MAX_SUBCLASS (XFS_ILOCK_PARENT_VAL - 1)
359 #define XFS_ILOCK_RTBITMAP_VAL 6
360 #define XFS_ILOCK_RTSUM_VAL 7
361 #define XFS_ILOCK_DEP_MASK 0xff000000
362 #define XFS_ILOCK_PARENT (XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT)
363 #define XFS_ILOCK_RTBITMAP (XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT)
364 #define XFS_ILOCK_RTSUM (XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT)
365
366 #define XFS_LOCK_SUBCLASS_MASK (XFS_IOLOCK_DEP_MASK | \
367 XFS_MMAPLOCK_DEP_MASK | \
368 XFS_ILOCK_DEP_MASK)
369
370 #define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) \
371 >> XFS_IOLOCK_SHIFT)
372 #define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \
373 >> XFS_MMAPLOCK_SHIFT)
374 #define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) \
375 >> XFS_ILOCK_SHIFT)
376
377 /*
378 * Layouts are broken in the BREAK_WRITE case to ensure that
379 * layout-holders do not collide with local writes. Additionally,
380 * layouts are broken in the BREAK_UNMAP case to make sure the
381 * layout-holder has a consistent view of the file's extent map. While
382 * BREAK_WRITE breaks can be satisfied by recalling FL_LAYOUT leases,
383 * BREAK_UNMAP breaks additionally require waiting for busy dax-pages to
384 * go idle.
385 */
386 enum layout_break_reason {
387 BREAK_WRITE,
388 BREAK_UNMAP,
389 };
390
391 /*
392 * For multiple groups support: if S_ISGID bit is set in the parent
393 * directory, group of new file is set to that of the parent, and
394 * new subdirectory gets S_ISGID bit from parent.
395 */
396 #define XFS_INHERIT_GID(pip) \
397 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
398 (VFS_I(pip)->i_mode & S_ISGID))
399
400 int xfs_release(struct xfs_inode *ip);
401 void xfs_inactive(struct xfs_inode *ip);
402 int xfs_lookup(struct xfs_inode *dp, struct xfs_name *name,
403 struct xfs_inode **ipp, struct xfs_name *ci_name);
404 int xfs_create(struct xfs_inode *dp, struct xfs_name *name,
405 umode_t mode, dev_t rdev, struct xfs_inode **ipp);
406 int xfs_create_tmpfile(struct xfs_inode *dp, umode_t mode,
407 struct xfs_inode **ipp);
408 int xfs_remove(struct xfs_inode *dp, struct xfs_name *name,
409 struct xfs_inode *ip);
410 int xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip,
411 struct xfs_name *target_name);
412 int xfs_rename(struct xfs_inode *src_dp, struct xfs_name *src_name,
413 struct xfs_inode *src_ip, struct xfs_inode *target_dp,
414 struct xfs_name *target_name,
415 struct xfs_inode *target_ip, unsigned int flags);
416
417 void xfs_ilock(xfs_inode_t *, uint);
418 int xfs_ilock_nowait(xfs_inode_t *, uint);
419 void xfs_iunlock(xfs_inode_t *, uint);
420 void xfs_ilock_demote(xfs_inode_t *, uint);
421 int xfs_isilocked(xfs_inode_t *, uint);
422 uint xfs_ilock_data_map_shared(struct xfs_inode *);
423 uint xfs_ilock_attr_map_shared(struct xfs_inode *);
424
425 uint xfs_ip2xflags(struct xfs_inode *);
426 int xfs_ifree(struct xfs_trans *, struct xfs_inode *);
427 int xfs_itruncate_extents_flags(struct xfs_trans **,
428 struct xfs_inode *, int, xfs_fsize_t, int);
429 void xfs_iext_realloc(xfs_inode_t *, int, int);
430
431 void xfs_iunpin_wait(xfs_inode_t *);
432 #define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
433
434 int xfs_iflush(struct xfs_inode *, struct xfs_buf **);
435 void xfs_lock_two_inodes(struct xfs_inode *ip0, uint ip0_mode,
436 struct xfs_inode *ip1, uint ip1_mode);
437
438 xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip);
439 xfs_extlen_t xfs_get_cowextsz_hint(struct xfs_inode *ip);
440
441 int xfs_dir_ialloc(struct xfs_trans **, struct xfs_inode *, umode_t,
442 xfs_nlink_t, dev_t, prid_t,
443 struct xfs_inode **);
444
445 static inline int
xfs_itruncate_extents(struct xfs_trans ** tpp,struct xfs_inode * ip,int whichfork,xfs_fsize_t new_size)446 xfs_itruncate_extents(
447 struct xfs_trans **tpp,
448 struct xfs_inode *ip,
449 int whichfork,
450 xfs_fsize_t new_size)
451 {
452 return xfs_itruncate_extents_flags(tpp, ip, whichfork, new_size, 0);
453 }
454
455 /* from xfs_file.c */
456 enum xfs_prealloc_flags {
457 XFS_PREALLOC_SET = (1 << 1),
458 XFS_PREALLOC_CLEAR = (1 << 2),
459 XFS_PREALLOC_SYNC = (1 << 3),
460 XFS_PREALLOC_INVISIBLE = (1 << 4),
461 };
462
463 int xfs_update_prealloc_flags(struct xfs_inode *ip,
464 enum xfs_prealloc_flags flags);
465 int xfs_break_layouts(struct inode *inode, uint *iolock,
466 enum layout_break_reason reason);
467
468 /* from xfs_iops.c */
469 extern void xfs_setup_inode(struct xfs_inode *ip);
470 extern void xfs_setup_iops(struct xfs_inode *ip);
471
472 /*
473 * When setting up a newly allocated inode, we need to call
474 * xfs_finish_inode_setup() once the inode is fully instantiated at
475 * the VFS level to prevent the rest of the world seeing the inode
476 * before we've completed instantiation. Otherwise we can do it
477 * the moment the inode lookup is complete.
478 */
xfs_finish_inode_setup(struct xfs_inode * ip)479 static inline void xfs_finish_inode_setup(struct xfs_inode *ip)
480 {
481 xfs_iflags_clear(ip, XFS_INEW);
482 barrier();
483 unlock_new_inode(VFS_I(ip));
484 wake_up_bit(&ip->i_flags, __XFS_INEW_BIT);
485 }
486
xfs_setup_existing_inode(struct xfs_inode * ip)487 static inline void xfs_setup_existing_inode(struct xfs_inode *ip)
488 {
489 xfs_setup_inode(ip);
490 xfs_setup_iops(ip);
491 xfs_finish_inode_setup(ip);
492 }
493
494 void xfs_irele(struct xfs_inode *ip);
495
496 extern struct kmem_zone *xfs_inode_zone;
497
498 /* The default CoW extent size hint. */
499 #define XFS_DEFAULT_COWEXTSZ_HINT 32
500
501 bool xfs_inode_verify_forks(struct xfs_inode *ip);
502
503 #endif /* __XFS_INODE_H__ */
504