Loading...
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 */
15struct xfs_dinode;
16struct xfs_inode;
17struct xfs_buf;
18struct xfs_bmbt_irec;
19struct xfs_inode_log_item;
20struct xfs_mount;
21struct xfs_trans;
22struct xfs_dquot;
23
24typedef 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 /* Transaction and locking information. */
41 struct xfs_inode_log_item *i_itemp; /* logging information */
42 mrlock_t i_lock; /* inode lock */
43 mrlock_t i_mmaplock; /* inode mmap IO lock */
44 atomic_t i_pincount; /* inode pin count */
45
46 /*
47 * Bitsets of inode metadata that have been checked and/or are sick.
48 * Callers must hold i_flags_lock before accessing this field.
49 */
50 uint16_t i_checked;
51 uint16_t i_sick;
52
53 spinlock_t i_flags_lock; /* inode i_flags lock */
54 /* Miscellaneous state. */
55 unsigned long i_flags; /* see defined flags below */
56 uint64_t i_delayed_blks; /* count of delay alloc blks */
57
58 struct xfs_icdinode i_d; /* most of ondisk inode */
59
60 /* VFS inode */
61 struct inode i_vnode; /* embedded VFS inode */
62
63 /* pending io completions */
64 spinlock_t i_ioend_lock;
65 struct work_struct i_ioend_work;
66 struct list_head i_ioend_list;
67} xfs_inode_t;
68
69/* Convert from vfs inode to xfs inode */
70static inline struct xfs_inode *XFS_I(struct inode *inode)
71{
72 return container_of(inode, struct xfs_inode, i_vnode);
73}
74
75/* convert from xfs inode to vfs inode */
76static inline struct inode *VFS_I(struct xfs_inode *ip)
77{
78 return &ip->i_vnode;
79}
80
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 */
86static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip)
87{
88 if (S_ISREG(VFS_I(ip)->i_mode))
89 return i_size_read(VFS_I(ip));
90 return ip->i_d.di_size;
91}
92
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 */
97static inline xfs_fsize_t
98xfs_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 || new_size < 0)
103 new_size = i_size;
104 return new_size > ip->i_d.di_size ? new_size : 0;
105}
106
107/*
108 * i_flags helper functions
109 */
110static inline void
111__xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
112{
113 ip->i_flags |= flags;
114}
115
116static inline void
117xfs_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
124static inline void
125xfs_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
132static inline int
133__xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
134{
135 return (ip->i_flags & flags);
136}
137
138static inline int
139xfs_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}
147
148static inline int
149xfs_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}
160
161static inline int
162xfs_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
174static inline prid_t
175xfs_get_initial_prid(struct xfs_inode *dp)
176{
177 if (dp->i_d.di_flags & XFS_DIFLAG_PROJINHERIT)
178 return dp->i_d.di_projid;
179
180 return XFS_PROJID_DEFAULT;
181}
182
183static inline bool xfs_is_reflink_inode(struct xfs_inode *ip)
184{
185 return ip->i_d.di_flags2 & XFS_DIFLAG2_REFLINK;
186}
187
188/*
189 * Check if an inode has any data in the COW fork. This might be often false
190 * even for inodes with the reflink flag when there is no pending COW operation.
191 */
192static inline bool xfs_inode_has_cow_data(struct xfs_inode *ip)
193{
194 return ip->i_cowfp && ip->i_cowfp->if_bytes;
195}
196
197/*
198 * Return the buftarg used for data allocations on a given inode.
199 */
200#define xfs_inode_buftarg(ip) \
201 (XFS_IS_REALTIME_INODE(ip) ? \
202 (ip)->i_mount->m_rtdev_targp : (ip)->i_mount->m_ddev_targp)
203
204/*
205 * In-core inode flags.
206 */
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_BIT 3 /* inode has just been allocated */
211#define XFS_INEW (1 << __XFS_INEW_BIT)
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_IEOFBLOCKS (1 << 9) /* has the preallocblocks tag set */
219/*
220 * If this unlinked inode is in the middle of recovery, don't let drop_inode
221 * truncate and free the inode. This can happen if we iget the inode during
222 * log recovery to replay a bmap operation on the inode.
223 */
224#define XFS_IRECOVERY (1 << 11)
225#define XFS_ICOWBLOCKS (1 << 12)/* has the cowblocks tag set */
226
227/*
228 * Per-lifetime flags need to be reset when re-using a reclaimable inode during
229 * inode lookup. This prevents unintended behaviour on the new inode from
230 * ocurring.
231 */
232#define XFS_IRECLAIM_RESET_FLAGS \
233 (XFS_IRECLAIMABLE | XFS_IRECLAIM | \
234 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED)
235
236/*
237 * Synchronize processes attempting to flush the in-core inode back to disk.
238 */
239
240static inline int xfs_isiflocked(struct xfs_inode *ip)
241{
242 return xfs_iflags_test(ip, XFS_IFLOCK);
243}
244
245extern void __xfs_iflock(struct xfs_inode *ip);
246
247static inline int xfs_iflock_nowait(struct xfs_inode *ip)
248{
249 return !xfs_iflags_test_and_set(ip, XFS_IFLOCK);
250}
251
252static inline void xfs_iflock(struct xfs_inode *ip)
253{
254 if (!xfs_iflock_nowait(ip))
255 __xfs_iflock(ip);
256}
257
258static inline void xfs_ifunlock(struct xfs_inode *ip)
259{
260 ASSERT(xfs_isiflocked(ip));
261 xfs_iflags_clear(ip, XFS_IFLOCK);
262 smp_mb();
263 wake_up_bit(&ip->i_flags, __XFS_IFLOCK_BIT);
264}
265
266/*
267 * Flags for inode locking.
268 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
269 * 1<<16 - 1<<32-1 -- lockdep annotation (integers)
270 */
271#define XFS_IOLOCK_EXCL (1<<0)
272#define XFS_IOLOCK_SHARED (1<<1)
273#define XFS_ILOCK_EXCL (1<<2)
274#define XFS_ILOCK_SHARED (1<<3)
275#define XFS_MMAPLOCK_EXCL (1<<4)
276#define XFS_MMAPLOCK_SHARED (1<<5)
277
278#define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
279 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \
280 | XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED)
281
282#define XFS_LOCK_FLAGS \
283 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
284 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
285 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
286 { XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \
287 { XFS_MMAPLOCK_EXCL, "MMAPLOCK_EXCL" }, \
288 { XFS_MMAPLOCK_SHARED, "MMAPLOCK_SHARED" }
289
290
291/*
292 * Flags for lockdep annotations.
293 *
294 * XFS_LOCK_PARENT - for directory operations that require locking a
295 * parent directory inode and a child entry inode. IOLOCK requires nesting,
296 * MMAPLOCK does not support this class, ILOCK requires a single subclass
297 * to differentiate parent from child.
298 *
299 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
300 * inodes do not participate in the normal lock order, and thus have their
301 * own subclasses.
302 *
303 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
304 * with xfs_lock_inodes(). This flag is used as the starting subclass
305 * and each subsequent lock acquired will increment the subclass by one.
306 * However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
307 * limited to the subclasses we can represent via nesting. We need at least
308 * 5 inodes nest depth for the ILOCK through rename, and we also have to support
309 * XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
310 * and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
311 * 8 subclasses supported by lockdep.
312 *
313 * This also means we have to number the sub-classes in the lowest bits of
314 * the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
315 * mask and we can't use bit-masking to build the subclasses. What a mess.
316 *
317 * Bit layout:
318 *
319 * Bit Lock Region
320 * 16-19 XFS_IOLOCK_SHIFT dependencies
321 * 20-23 XFS_MMAPLOCK_SHIFT dependencies
322 * 24-31 XFS_ILOCK_SHIFT dependencies
323 *
324 * IOLOCK values
325 *
326 * 0-3 subclass value
327 * 4-7 unused
328 *
329 * MMAPLOCK values
330 *
331 * 0-3 subclass value
332 * 4-7 unused
333 *
334 * ILOCK values
335 * 0-4 subclass values
336 * 5 PARENT subclass (not nestable)
337 * 6 RTBITMAP subclass (not nestable)
338 * 7 RTSUM subclass (not nestable)
339 *
340 */
341#define XFS_IOLOCK_SHIFT 16
342#define XFS_IOLOCK_MAX_SUBCLASS 3
343#define XFS_IOLOCK_DEP_MASK 0x000f0000
344
345#define XFS_MMAPLOCK_SHIFT 20
346#define XFS_MMAPLOCK_NUMORDER 0
347#define XFS_MMAPLOCK_MAX_SUBCLASS 3
348#define XFS_MMAPLOCK_DEP_MASK 0x00f00000
349
350#define XFS_ILOCK_SHIFT 24
351#define XFS_ILOCK_PARENT_VAL 5
352#define XFS_ILOCK_MAX_SUBCLASS (XFS_ILOCK_PARENT_VAL - 1)
353#define XFS_ILOCK_RTBITMAP_VAL 6
354#define XFS_ILOCK_RTSUM_VAL 7
355#define XFS_ILOCK_DEP_MASK 0xff000000
356#define XFS_ILOCK_PARENT (XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT)
357#define XFS_ILOCK_RTBITMAP (XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT)
358#define XFS_ILOCK_RTSUM (XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT)
359
360#define XFS_LOCK_SUBCLASS_MASK (XFS_IOLOCK_DEP_MASK | \
361 XFS_MMAPLOCK_DEP_MASK | \
362 XFS_ILOCK_DEP_MASK)
363
364#define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) \
365 >> XFS_IOLOCK_SHIFT)
366#define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \
367 >> XFS_MMAPLOCK_SHIFT)
368#define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) \
369 >> XFS_ILOCK_SHIFT)
370
371/*
372 * Layouts are broken in the BREAK_WRITE case to ensure that
373 * layout-holders do not collide with local writes. Additionally,
374 * layouts are broken in the BREAK_UNMAP case to make sure the
375 * layout-holder has a consistent view of the file's extent map. While
376 * BREAK_WRITE breaks can be satisfied by recalling FL_LAYOUT leases,
377 * BREAK_UNMAP breaks additionally require waiting for busy dax-pages to
378 * go idle.
379 */
380enum layout_break_reason {
381 BREAK_WRITE,
382 BREAK_UNMAP,
383};
384
385/*
386 * For multiple groups support: if S_ISGID bit is set in the parent
387 * directory, group of new file is set to that of the parent, and
388 * new subdirectory gets S_ISGID bit from parent.
389 */
390#define XFS_INHERIT_GID(pip) \
391 (((pip)->i_mount->m_flags & XFS_MOUNT_GRPID) || \
392 (VFS_I(pip)->i_mode & S_ISGID))
393
394int xfs_release(struct xfs_inode *ip);
395void xfs_inactive(struct xfs_inode *ip);
396int xfs_lookup(struct xfs_inode *dp, struct xfs_name *name,
397 struct xfs_inode **ipp, struct xfs_name *ci_name);
398int xfs_create(struct xfs_inode *dp, struct xfs_name *name,
399 umode_t mode, dev_t rdev, struct xfs_inode **ipp);
400int xfs_create_tmpfile(struct xfs_inode *dp, umode_t mode,
401 struct xfs_inode **ipp);
402int xfs_remove(struct xfs_inode *dp, struct xfs_name *name,
403 struct xfs_inode *ip);
404int xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip,
405 struct xfs_name *target_name);
406int xfs_rename(struct xfs_inode *src_dp, struct xfs_name *src_name,
407 struct xfs_inode *src_ip, struct xfs_inode *target_dp,
408 struct xfs_name *target_name,
409 struct xfs_inode *target_ip, unsigned int flags);
410
411void xfs_ilock(xfs_inode_t *, uint);
412int xfs_ilock_nowait(xfs_inode_t *, uint);
413void xfs_iunlock(xfs_inode_t *, uint);
414void xfs_ilock_demote(xfs_inode_t *, uint);
415int xfs_isilocked(xfs_inode_t *, uint);
416uint xfs_ilock_data_map_shared(struct xfs_inode *);
417uint xfs_ilock_attr_map_shared(struct xfs_inode *);
418
419uint xfs_ip2xflags(struct xfs_inode *);
420int xfs_ifree(struct xfs_trans *, struct xfs_inode *);
421int xfs_itruncate_extents_flags(struct xfs_trans **,
422 struct xfs_inode *, int, xfs_fsize_t, int);
423void xfs_iext_realloc(xfs_inode_t *, int, int);
424
425int xfs_log_force_inode(struct xfs_inode *ip);
426void xfs_iunpin_wait(xfs_inode_t *);
427#define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
428
429int xfs_iflush_cluster(struct xfs_buf *);
430void xfs_lock_two_inodes(struct xfs_inode *ip0, uint ip0_mode,
431 struct xfs_inode *ip1, uint ip1_mode);
432
433xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip);
434xfs_extlen_t xfs_get_cowextsz_hint(struct xfs_inode *ip);
435
436int xfs_dir_ialloc(struct xfs_trans **, struct xfs_inode *, umode_t,
437 xfs_nlink_t, dev_t, prid_t,
438 struct xfs_inode **);
439
440static inline int
441xfs_itruncate_extents(
442 struct xfs_trans **tpp,
443 struct xfs_inode *ip,
444 int whichfork,
445 xfs_fsize_t new_size)
446{
447 return xfs_itruncate_extents_flags(tpp, ip, whichfork, new_size, 0);
448}
449
450/* from xfs_file.c */
451enum xfs_prealloc_flags {
452 XFS_PREALLOC_SET = (1 << 1),
453 XFS_PREALLOC_CLEAR = (1 << 2),
454 XFS_PREALLOC_SYNC = (1 << 3),
455 XFS_PREALLOC_INVISIBLE = (1 << 4),
456};
457
458int xfs_update_prealloc_flags(struct xfs_inode *ip,
459 enum xfs_prealloc_flags flags);
460int xfs_break_layouts(struct inode *inode, uint *iolock,
461 enum layout_break_reason reason);
462
463/* from xfs_iops.c */
464extern void xfs_setup_inode(struct xfs_inode *ip);
465extern void xfs_setup_iops(struct xfs_inode *ip);
466extern void xfs_diflags_to_iflags(struct xfs_inode *ip, bool init);
467
468/*
469 * When setting up a newly allocated inode, we need to call
470 * xfs_finish_inode_setup() once the inode is fully instantiated at
471 * the VFS level to prevent the rest of the world seeing the inode
472 * before we've completed instantiation. Otherwise we can do it
473 * the moment the inode lookup is complete.
474 */
475static inline void xfs_finish_inode_setup(struct xfs_inode *ip)
476{
477 xfs_iflags_clear(ip, XFS_INEW);
478 barrier();
479 unlock_new_inode(VFS_I(ip));
480 wake_up_bit(&ip->i_flags, __XFS_INEW_BIT);
481}
482
483static inline void xfs_setup_existing_inode(struct xfs_inode *ip)
484{
485 xfs_setup_inode(ip);
486 xfs_setup_iops(ip);
487 xfs_finish_inode_setup(ip);
488}
489
490void xfs_irele(struct xfs_inode *ip);
491
492extern struct kmem_zone *xfs_inode_zone;
493
494/* The default CoW extent size hint. */
495#define XFS_DEFAULT_COWEXTSZ_HINT 32
496
497int xfs_iunlink_init(struct xfs_perag *pag);
498void xfs_iunlink_destroy(struct xfs_perag *pag);
499
500void xfs_end_io(struct work_struct *work);
501
502int xfs_ilock2_io_mmap(struct xfs_inode *ip1, struct xfs_inode *ip2);
503void xfs_iunlock2_io_mmap(struct xfs_inode *ip1, struct xfs_inode *ip2);
504
505#endif /* __XFS_INODE_H__ */
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 */
15struct xfs_dinode;
16struct xfs_inode;
17struct xfs_buf;
18struct xfs_bmbt_irec;
19struct xfs_inode_log_item;
20struct xfs_mount;
21struct xfs_trans;
22struct xfs_dquot;
23
24typedef 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_cowfp; /* copy on write extents */
37 struct xfs_ifork i_df; /* data fork */
38 struct xfs_ifork i_af; /* attribute fork */
39
40 /* Transaction and locking information. */
41 struct xfs_inode_log_item *i_itemp; /* logging information */
42 mrlock_t i_lock; /* inode lock */
43 atomic_t i_pincount; /* inode pin count */
44 struct llist_node i_gclist; /* deferred inactivation list */
45
46 /*
47 * Bitsets of inode metadata that have been checked and/or are sick.
48 * Callers must hold i_flags_lock before accessing this field.
49 */
50 uint16_t i_checked;
51 uint16_t i_sick;
52
53 spinlock_t i_flags_lock; /* inode i_flags lock */
54 /* Miscellaneous state. */
55 unsigned long i_flags; /* see defined flags below */
56 uint64_t i_delayed_blks; /* count of delay alloc blks */
57 xfs_fsize_t i_disk_size; /* number of bytes in file */
58 xfs_rfsblock_t i_nblocks; /* # of direct & btree blocks */
59 prid_t i_projid; /* owner's project id */
60 xfs_extlen_t i_extsize; /* basic/minimum extent size */
61 /* cowextsize is only used for v3 inodes, flushiter for v1/2 */
62 union {
63 xfs_extlen_t i_cowextsize; /* basic cow extent size */
64 uint16_t i_flushiter; /* incremented on flush */
65 };
66 uint8_t i_forkoff; /* attr fork offset >> 3 */
67 uint16_t i_diflags; /* XFS_DIFLAG_... */
68 uint64_t i_diflags2; /* XFS_DIFLAG2_... */
69 struct timespec64 i_crtime; /* time created */
70
71 /* unlinked list pointers */
72 xfs_agino_t i_next_unlinked;
73 xfs_agino_t i_prev_unlinked;
74
75 /* VFS inode */
76 struct inode i_vnode; /* embedded VFS inode */
77
78 /* pending io completions */
79 spinlock_t i_ioend_lock;
80 struct work_struct i_ioend_work;
81 struct list_head i_ioend_list;
82} xfs_inode_t;
83
84static inline bool xfs_inode_has_attr_fork(struct xfs_inode *ip)
85{
86 return ip->i_forkoff > 0;
87}
88
89static inline struct xfs_ifork *
90xfs_ifork_ptr(
91 struct xfs_inode *ip,
92 int whichfork)
93{
94 switch (whichfork) {
95 case XFS_DATA_FORK:
96 return &ip->i_df;
97 case XFS_ATTR_FORK:
98 if (!xfs_inode_has_attr_fork(ip))
99 return NULL;
100 return &ip->i_af;
101 case XFS_COW_FORK:
102 return ip->i_cowfp;
103 default:
104 ASSERT(0);
105 return NULL;
106 }
107}
108
109static inline unsigned int xfs_inode_fork_boff(struct xfs_inode *ip)
110{
111 return ip->i_forkoff << 3;
112}
113
114static inline unsigned int xfs_inode_data_fork_size(struct xfs_inode *ip)
115{
116 if (xfs_inode_has_attr_fork(ip))
117 return xfs_inode_fork_boff(ip);
118
119 return XFS_LITINO(ip->i_mount);
120}
121
122static inline unsigned int xfs_inode_attr_fork_size(struct xfs_inode *ip)
123{
124 if (xfs_inode_has_attr_fork(ip))
125 return XFS_LITINO(ip->i_mount) - xfs_inode_fork_boff(ip);
126 return 0;
127}
128
129static inline unsigned int
130xfs_inode_fork_size(
131 struct xfs_inode *ip,
132 int whichfork)
133{
134 switch (whichfork) {
135 case XFS_DATA_FORK:
136 return xfs_inode_data_fork_size(ip);
137 case XFS_ATTR_FORK:
138 return xfs_inode_attr_fork_size(ip);
139 default:
140 return 0;
141 }
142}
143
144/* Convert from vfs inode to xfs inode */
145static inline struct xfs_inode *XFS_I(struct inode *inode)
146{
147 return container_of(inode, struct xfs_inode, i_vnode);
148}
149
150/* convert from xfs inode to vfs inode */
151static inline struct inode *VFS_I(struct xfs_inode *ip)
152{
153 return &ip->i_vnode;
154}
155
156/*
157 * For regular files we only update the on-disk filesize when actually
158 * writing data back to disk. Until then only the copy in the VFS inode
159 * is uptodate.
160 */
161static inline xfs_fsize_t XFS_ISIZE(struct xfs_inode *ip)
162{
163 if (S_ISREG(VFS_I(ip)->i_mode))
164 return i_size_read(VFS_I(ip));
165 return ip->i_disk_size;
166}
167
168/*
169 * If this I/O goes past the on-disk inode size update it unless it would
170 * be past the current in-core inode size.
171 */
172static inline xfs_fsize_t
173xfs_new_eof(struct xfs_inode *ip, xfs_fsize_t new_size)
174{
175 xfs_fsize_t i_size = i_size_read(VFS_I(ip));
176
177 if (new_size > i_size || new_size < 0)
178 new_size = i_size;
179 return new_size > ip->i_disk_size ? new_size : 0;
180}
181
182/*
183 * i_flags helper functions
184 */
185static inline void
186__xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
187{
188 ip->i_flags |= flags;
189}
190
191static inline void
192xfs_iflags_set(xfs_inode_t *ip, unsigned short flags)
193{
194 spin_lock(&ip->i_flags_lock);
195 __xfs_iflags_set(ip, flags);
196 spin_unlock(&ip->i_flags_lock);
197}
198
199static inline void
200xfs_iflags_clear(xfs_inode_t *ip, unsigned short flags)
201{
202 spin_lock(&ip->i_flags_lock);
203 ip->i_flags &= ~flags;
204 spin_unlock(&ip->i_flags_lock);
205}
206
207static inline int
208__xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
209{
210 return (ip->i_flags & flags);
211}
212
213static inline int
214xfs_iflags_test(xfs_inode_t *ip, unsigned short flags)
215{
216 int ret;
217 spin_lock(&ip->i_flags_lock);
218 ret = __xfs_iflags_test(ip, flags);
219 spin_unlock(&ip->i_flags_lock);
220 return ret;
221}
222
223static inline int
224xfs_iflags_test_and_clear(xfs_inode_t *ip, unsigned short flags)
225{
226 int ret;
227
228 spin_lock(&ip->i_flags_lock);
229 ret = ip->i_flags & flags;
230 if (ret)
231 ip->i_flags &= ~flags;
232 spin_unlock(&ip->i_flags_lock);
233 return ret;
234}
235
236static inline int
237xfs_iflags_test_and_set(xfs_inode_t *ip, unsigned short flags)
238{
239 int ret;
240
241 spin_lock(&ip->i_flags_lock);
242 ret = ip->i_flags & flags;
243 if (!ret)
244 ip->i_flags |= flags;
245 spin_unlock(&ip->i_flags_lock);
246 return ret;
247}
248
249static inline prid_t
250xfs_get_initial_prid(struct xfs_inode *dp)
251{
252 if (dp->i_diflags & XFS_DIFLAG_PROJINHERIT)
253 return dp->i_projid;
254
255 return XFS_PROJID_DEFAULT;
256}
257
258static inline bool xfs_is_reflink_inode(struct xfs_inode *ip)
259{
260 return ip->i_diflags2 & XFS_DIFLAG2_REFLINK;
261}
262
263static inline bool xfs_is_metadata_inode(struct xfs_inode *ip)
264{
265 struct xfs_mount *mp = ip->i_mount;
266
267 return ip == mp->m_rbmip || ip == mp->m_rsumip ||
268 xfs_is_quota_inode(&mp->m_sb, ip->i_ino);
269}
270
271/*
272 * Check if an inode has any data in the COW fork. This might be often false
273 * even for inodes with the reflink flag when there is no pending COW operation.
274 */
275static inline bool xfs_inode_has_cow_data(struct xfs_inode *ip)
276{
277 return ip->i_cowfp && ip->i_cowfp->if_bytes;
278}
279
280static inline bool xfs_inode_has_bigtime(struct xfs_inode *ip)
281{
282 return ip->i_diflags2 & XFS_DIFLAG2_BIGTIME;
283}
284
285static inline bool xfs_inode_has_large_extent_counts(struct xfs_inode *ip)
286{
287 return ip->i_diflags2 & XFS_DIFLAG2_NREXT64;
288}
289
290/*
291 * Return the buftarg used for data allocations on a given inode.
292 */
293#define xfs_inode_buftarg(ip) \
294 (XFS_IS_REALTIME_INODE(ip) ? \
295 (ip)->i_mount->m_rtdev_targp : (ip)->i_mount->m_ddev_targp)
296
297/*
298 * In-core inode flags.
299 */
300#define XFS_IRECLAIM (1 << 0) /* started reclaiming this inode */
301#define XFS_ISTALE (1 << 1) /* inode has been staled */
302#define XFS_IRECLAIMABLE (1 << 2) /* inode can be reclaimed */
303#define XFS_INEW (1 << 3) /* inode has just been allocated */
304#define XFS_IPRESERVE_DM_FIELDS (1 << 4) /* has legacy DMAPI fields set */
305#define XFS_ITRUNCATED (1 << 5) /* truncated down so flush-on-close */
306#define XFS_IDIRTY_RELEASE (1 << 6) /* dirty release already seen */
307#define XFS_IFLUSHING (1 << 7) /* inode is being flushed */
308#define __XFS_IPINNED_BIT 8 /* wakeup key for zero pin count */
309#define XFS_IPINNED (1 << __XFS_IPINNED_BIT)
310#define XFS_IEOFBLOCKS (1 << 9) /* has the preallocblocks tag set */
311#define XFS_NEED_INACTIVE (1 << 10) /* see XFS_INACTIVATING below */
312/*
313 * If this unlinked inode is in the middle of recovery, don't let drop_inode
314 * truncate and free the inode. This can happen if we iget the inode during
315 * log recovery to replay a bmap operation on the inode.
316 */
317#define XFS_IRECOVERY (1 << 11)
318#define XFS_ICOWBLOCKS (1 << 12)/* has the cowblocks tag set */
319
320/*
321 * If we need to update on-disk metadata before this IRECLAIMABLE inode can be
322 * freed, then NEED_INACTIVE will be set. Once we start the updates, the
323 * INACTIVATING bit will be set to keep iget away from this inode. After the
324 * inactivation completes, both flags will be cleared and the inode is a
325 * plain old IRECLAIMABLE inode.
326 */
327#define XFS_INACTIVATING (1 << 13)
328
329/* All inode state flags related to inode reclaim. */
330#define XFS_ALL_IRECLAIM_FLAGS (XFS_IRECLAIMABLE | \
331 XFS_IRECLAIM | \
332 XFS_NEED_INACTIVE | \
333 XFS_INACTIVATING)
334
335/*
336 * Per-lifetime flags need to be reset when re-using a reclaimable inode during
337 * inode lookup. This prevents unintended behaviour on the new inode from
338 * ocurring.
339 */
340#define XFS_IRECLAIM_RESET_FLAGS \
341 (XFS_IRECLAIMABLE | XFS_IRECLAIM | \
342 XFS_IDIRTY_RELEASE | XFS_ITRUNCATED | XFS_NEED_INACTIVE | \
343 XFS_INACTIVATING)
344
345/*
346 * Flags for inode locking.
347 * Bit ranges: 1<<1 - 1<<16-1 -- iolock/ilock modes (bitfield)
348 * 1<<16 - 1<<32-1 -- lockdep annotation (integers)
349 */
350#define XFS_IOLOCK_EXCL (1u << 0)
351#define XFS_IOLOCK_SHARED (1u << 1)
352#define XFS_ILOCK_EXCL (1u << 2)
353#define XFS_ILOCK_SHARED (1u << 3)
354#define XFS_MMAPLOCK_EXCL (1u << 4)
355#define XFS_MMAPLOCK_SHARED (1u << 5)
356
357#define XFS_LOCK_MASK (XFS_IOLOCK_EXCL | XFS_IOLOCK_SHARED \
358 | XFS_ILOCK_EXCL | XFS_ILOCK_SHARED \
359 | XFS_MMAPLOCK_EXCL | XFS_MMAPLOCK_SHARED)
360
361#define XFS_LOCK_FLAGS \
362 { XFS_IOLOCK_EXCL, "IOLOCK_EXCL" }, \
363 { XFS_IOLOCK_SHARED, "IOLOCK_SHARED" }, \
364 { XFS_ILOCK_EXCL, "ILOCK_EXCL" }, \
365 { XFS_ILOCK_SHARED, "ILOCK_SHARED" }, \
366 { XFS_MMAPLOCK_EXCL, "MMAPLOCK_EXCL" }, \
367 { XFS_MMAPLOCK_SHARED, "MMAPLOCK_SHARED" }
368
369
370/*
371 * Flags for lockdep annotations.
372 *
373 * XFS_LOCK_PARENT - for directory operations that require locking a
374 * parent directory inode and a child entry inode. IOLOCK requires nesting,
375 * MMAPLOCK does not support this class, ILOCK requires a single subclass
376 * to differentiate parent from child.
377 *
378 * XFS_LOCK_RTBITMAP/XFS_LOCK_RTSUM - the realtime device bitmap and summary
379 * inodes do not participate in the normal lock order, and thus have their
380 * own subclasses.
381 *
382 * XFS_LOCK_INUMORDER - for locking several inodes at the some time
383 * with xfs_lock_inodes(). This flag is used as the starting subclass
384 * and each subsequent lock acquired will increment the subclass by one.
385 * However, MAX_LOCKDEP_SUBCLASSES == 8, which means we are greatly
386 * limited to the subclasses we can represent via nesting. We need at least
387 * 5 inodes nest depth for the ILOCK through rename, and we also have to support
388 * XFS_ILOCK_PARENT, which gives 6 subclasses. Then we have XFS_ILOCK_RTBITMAP
389 * and XFS_ILOCK_RTSUM, which are another 2 unique subclasses, so that's all
390 * 8 subclasses supported by lockdep.
391 *
392 * This also means we have to number the sub-classes in the lowest bits of
393 * the mask we keep, and we have to ensure we never exceed 3 bits of lockdep
394 * mask and we can't use bit-masking to build the subclasses. What a mess.
395 *
396 * Bit layout:
397 *
398 * Bit Lock Region
399 * 16-19 XFS_IOLOCK_SHIFT dependencies
400 * 20-23 XFS_MMAPLOCK_SHIFT dependencies
401 * 24-31 XFS_ILOCK_SHIFT dependencies
402 *
403 * IOLOCK values
404 *
405 * 0-3 subclass value
406 * 4-7 unused
407 *
408 * MMAPLOCK values
409 *
410 * 0-3 subclass value
411 * 4-7 unused
412 *
413 * ILOCK values
414 * 0-4 subclass values
415 * 5 PARENT subclass (not nestable)
416 * 6 RTBITMAP subclass (not nestable)
417 * 7 RTSUM subclass (not nestable)
418 *
419 */
420#define XFS_IOLOCK_SHIFT 16
421#define XFS_IOLOCK_MAX_SUBCLASS 3
422#define XFS_IOLOCK_DEP_MASK 0x000f0000u
423
424#define XFS_MMAPLOCK_SHIFT 20
425#define XFS_MMAPLOCK_NUMORDER 0
426#define XFS_MMAPLOCK_MAX_SUBCLASS 3
427#define XFS_MMAPLOCK_DEP_MASK 0x00f00000u
428
429#define XFS_ILOCK_SHIFT 24
430#define XFS_ILOCK_PARENT_VAL 5u
431#define XFS_ILOCK_MAX_SUBCLASS (XFS_ILOCK_PARENT_VAL - 1)
432#define XFS_ILOCK_RTBITMAP_VAL 6u
433#define XFS_ILOCK_RTSUM_VAL 7u
434#define XFS_ILOCK_DEP_MASK 0xff000000u
435#define XFS_ILOCK_PARENT (XFS_ILOCK_PARENT_VAL << XFS_ILOCK_SHIFT)
436#define XFS_ILOCK_RTBITMAP (XFS_ILOCK_RTBITMAP_VAL << XFS_ILOCK_SHIFT)
437#define XFS_ILOCK_RTSUM (XFS_ILOCK_RTSUM_VAL << XFS_ILOCK_SHIFT)
438
439#define XFS_LOCK_SUBCLASS_MASK (XFS_IOLOCK_DEP_MASK | \
440 XFS_MMAPLOCK_DEP_MASK | \
441 XFS_ILOCK_DEP_MASK)
442
443#define XFS_IOLOCK_DEP(flags) (((flags) & XFS_IOLOCK_DEP_MASK) \
444 >> XFS_IOLOCK_SHIFT)
445#define XFS_MMAPLOCK_DEP(flags) (((flags) & XFS_MMAPLOCK_DEP_MASK) \
446 >> XFS_MMAPLOCK_SHIFT)
447#define XFS_ILOCK_DEP(flags) (((flags) & XFS_ILOCK_DEP_MASK) \
448 >> XFS_ILOCK_SHIFT)
449
450/*
451 * Layouts are broken in the BREAK_WRITE case to ensure that
452 * layout-holders do not collide with local writes. Additionally,
453 * layouts are broken in the BREAK_UNMAP case to make sure the
454 * layout-holder has a consistent view of the file's extent map. While
455 * BREAK_WRITE breaks can be satisfied by recalling FL_LAYOUT leases,
456 * BREAK_UNMAP breaks additionally require waiting for busy dax-pages to
457 * go idle.
458 */
459enum layout_break_reason {
460 BREAK_WRITE,
461 BREAK_UNMAP,
462};
463
464/*
465 * For multiple groups support: if S_ISGID bit is set in the parent
466 * directory, group of new file is set to that of the parent, and
467 * new subdirectory gets S_ISGID bit from parent.
468 */
469#define XFS_INHERIT_GID(pip) \
470 (xfs_has_grpid((pip)->i_mount) || (VFS_I(pip)->i_mode & S_ISGID))
471
472int xfs_release(struct xfs_inode *ip);
473void xfs_inactive(struct xfs_inode *ip);
474int xfs_lookup(struct xfs_inode *dp, const struct xfs_name *name,
475 struct xfs_inode **ipp, struct xfs_name *ci_name);
476int xfs_create(struct user_namespace *mnt_userns,
477 struct xfs_inode *dp, struct xfs_name *name,
478 umode_t mode, dev_t rdev, bool need_xattr,
479 struct xfs_inode **ipp);
480int xfs_create_tmpfile(struct user_namespace *mnt_userns,
481 struct xfs_inode *dp, umode_t mode,
482 struct xfs_inode **ipp);
483int xfs_remove(struct xfs_inode *dp, struct xfs_name *name,
484 struct xfs_inode *ip);
485int xfs_link(struct xfs_inode *tdp, struct xfs_inode *sip,
486 struct xfs_name *target_name);
487int xfs_rename(struct user_namespace *mnt_userns,
488 struct xfs_inode *src_dp, struct xfs_name *src_name,
489 struct xfs_inode *src_ip, struct xfs_inode *target_dp,
490 struct xfs_name *target_name,
491 struct xfs_inode *target_ip, unsigned int flags);
492
493void xfs_ilock(xfs_inode_t *, uint);
494int xfs_ilock_nowait(xfs_inode_t *, uint);
495void xfs_iunlock(xfs_inode_t *, uint);
496void xfs_ilock_demote(xfs_inode_t *, uint);
497bool xfs_isilocked(struct xfs_inode *, uint);
498uint xfs_ilock_data_map_shared(struct xfs_inode *);
499uint xfs_ilock_attr_map_shared(struct xfs_inode *);
500
501uint xfs_ip2xflags(struct xfs_inode *);
502int xfs_ifree(struct xfs_trans *, struct xfs_inode *);
503int xfs_itruncate_extents_flags(struct xfs_trans **,
504 struct xfs_inode *, int, xfs_fsize_t, int);
505void xfs_iext_realloc(xfs_inode_t *, int, int);
506
507int xfs_log_force_inode(struct xfs_inode *ip);
508void xfs_iunpin_wait(xfs_inode_t *);
509#define xfs_ipincount(ip) ((unsigned int) atomic_read(&ip->i_pincount))
510
511int xfs_iflush_cluster(struct xfs_buf *);
512void xfs_lock_two_inodes(struct xfs_inode *ip0, uint ip0_mode,
513 struct xfs_inode *ip1, uint ip1_mode);
514
515xfs_extlen_t xfs_get_extsz_hint(struct xfs_inode *ip);
516xfs_extlen_t xfs_get_cowextsz_hint(struct xfs_inode *ip);
517
518int xfs_init_new_inode(struct user_namespace *mnt_userns, struct xfs_trans *tp,
519 struct xfs_inode *pip, xfs_ino_t ino, umode_t mode,
520 xfs_nlink_t nlink, dev_t rdev, prid_t prid, bool init_xattrs,
521 struct xfs_inode **ipp);
522
523static inline int
524xfs_itruncate_extents(
525 struct xfs_trans **tpp,
526 struct xfs_inode *ip,
527 int whichfork,
528 xfs_fsize_t new_size)
529{
530 return xfs_itruncate_extents_flags(tpp, ip, whichfork, new_size, 0);
531}
532
533/* from xfs_file.c */
534int xfs_break_dax_layouts(struct inode *inode, bool *retry);
535int xfs_break_layouts(struct inode *inode, uint *iolock,
536 enum layout_break_reason reason);
537
538/* from xfs_iops.c */
539extern void xfs_setup_inode(struct xfs_inode *ip);
540extern void xfs_setup_iops(struct xfs_inode *ip);
541extern void xfs_diflags_to_iflags(struct xfs_inode *ip, bool init);
542
543/*
544 * When setting up a newly allocated inode, we need to call
545 * xfs_finish_inode_setup() once the inode is fully instantiated at
546 * the VFS level to prevent the rest of the world seeing the inode
547 * before we've completed instantiation. Otherwise we can do it
548 * the moment the inode lookup is complete.
549 */
550static inline void xfs_finish_inode_setup(struct xfs_inode *ip)
551{
552 xfs_iflags_clear(ip, XFS_INEW);
553 barrier();
554 unlock_new_inode(VFS_I(ip));
555}
556
557static inline void xfs_setup_existing_inode(struct xfs_inode *ip)
558{
559 xfs_setup_inode(ip);
560 xfs_setup_iops(ip);
561 xfs_finish_inode_setup(ip);
562}
563
564void xfs_irele(struct xfs_inode *ip);
565
566extern struct kmem_cache *xfs_inode_cache;
567
568/* The default CoW extent size hint. */
569#define XFS_DEFAULT_COWEXTSZ_HINT 32
570
571bool xfs_inode_needs_inactive(struct xfs_inode *ip);
572
573void xfs_end_io(struct work_struct *work);
574
575int xfs_ilock2_io_mmap(struct xfs_inode *ip1, struct xfs_inode *ip2);
576void xfs_iunlock2_io_mmap(struct xfs_inode *ip1, struct xfs_inode *ip2);
577
578#endif /* __XFS_INODE_H__ */